linux/fs/xattr.c

3   File: fs/xattr.c
15 #include <linux/xattr.h>
42  * In order to implement different sets of xattr operations for each xattr
85  * may_write_xattr - check whether inode allows writing xattr
87  * @inode: the inode on which to set an xattr
212  *  @name: xattr name to set
268  *  @name: xattr name to set
370  * before retrieving the extended attribute.  The xattr value buffer should
462  * vfs_listxattr - retrieve \0 separated list of xattr names
463  * @dentry: the dentry from whose inode the xattr names are retrieved
464  * @list: buffer to store xattr names into
530  *  @name: name of xattr to remove
994  * generic_listxattr - run through a dentry's xattr list() operations
1029  * The get and set xattr handler operations are called with the remainder of
1034  * Note: the list xattr handler operation when called from the vfs is passed a
1048  * simple_xattr_space - estimate the memory used by a simple xattr
1049  * @name: the full name of the xattr
1056  * Return: The approximate number of bytes of memory used by such an xattr.
1068  * simple_xattr_free - free an xattr object
1069  * @xattr: the xattr object
1071  * Free the xattr object. Can handle @xattr being NULL.
1073 void simple_xattr_free(struct simple_xattr *xattr)
1075 	if (xattr)
1076 		kfree(xattr->name);
1077 	kvfree(xattr);
1081  * simple_xattr_alloc - allocate new xattr object
1082  * @value: value of the xattr object
1085  * Allocate a new xattr object and initialize respective members. The caller is
1086  * responsible for handling the name of the xattr.
1088  * Return: On success a new xattr object is returned. On failure NULL is
1111  * rbtree_simple_xattr_cmp - compare xattr name with current rbtree xattr entry
1112  * @key: xattr name
1115  * Compare the xattr name with the xattr name attached to @node in the rbtree.
1118  * if the xattr attached to @node matches @key.
1123 	const struct simple_xattr *xattr;
1125 	xattr = rb_entry(node, struct simple_xattr, rb_node);
1126 	return strcmp(xattr->name, xattr_name);
1130  * rbtree_simple_xattr_node_cmp - compare two xattr rbtree nodes
1134  * Compare the xattr attached to @new_node with the xattr attached to @node.
1137  * if the xattr attached to @new_node matches the xattr attached to @node.
1142 	struct simple_xattr *xattr;
1143 	xattr = rb_entry(new_node, struct simple_xattr, rb_node);
1144 	return rbtree_simple_xattr_cmp(xattr->name, node);
1148  * simple_xattr_get - get an xattr object
1149  * @xattrs: the header of the xattr object
1150  * @name: the name of the xattr to retrieve
1154  * Try to find and retrieve the xattr object associated with @name.
1155  * If @buffer is provided store the value of @xattr in @buffer
1159  * Return: On success the length of the xattr value is returned. On error a
1165 	struct simple_xattr *xattr = NULL;
1172 		xattr = rb_entry(rbp, struct simple_xattr, rb_node);
1173 		ret = xattr->size;
1175 			if (size < xattr->size)
1178 				memcpy(buffer, xattr->value, xattr->size);
1186  * simple_xattr_set - set an xattr object
1187  * @xattrs: the header of the xattr object
1188  * @name: the name of the xattr to retrieve
1189  * @value: the value to store along the xattr
1191  * @flags: the flags determining how to set the xattr
1193  * Set a new xattr object.
1194  * If @value is passed a new xattr object will be allocated. If XATTR_REPLACE
1195  * is specified in @flags a matching xattr object for @name must already exist.
1196  * If it does it will be replaced with the new xattr object. If it doesn't we
1197  * fail. If XATTR_CREATE is specified and a matching xattr does already exist
1198  * we fail. If it doesn't we create a new xattr. If @flags is zero we simply
1199  * insert the new xattr replacing any existing one.
1201  * If @value is empty and a matching xattr object is found we delete it if
1204  * If @value is empty and no matching xattr object for @name is found we do
1208  * Return: On success, the removed or replaced xattr is returned, to be freed
1248 		/* Fail if XATTR_CREATE is requested and the xattr exists. */
1260 		/* Fail if XATTR_REPLACE is requested but no xattr is found. */
1277 		 * old or new xattr exist then we don't need to do anything.
1295  * simple_xattr_list - list all xattr objects
1297  * @xattrs: the header of the xattr object
1305  * Note, the number of xattr names that can be listed with listxattr(2) is
1307  * then vfs_listxattr() caps it to XATTR_LIST_MAX and if more xattr names
1317 	struct simple_xattr *xattr;
1328 		xattr = rb_entry(rbp, struct simple_xattr, rb_node);
1331 		if (!trusted && xattr_is_trusted(xattr->name))
1334 		err = xattr_list_one(&buffer, &remaining_size, xattr->name);
1344  * rbtree_simple_xattr_less - compare two xattr rbtree nodes
1348  * Compare the xattr attached to @new_node with the xattr attached to @node.
1360  * simple_xattr_add - add xattr objects
1361  * @xattrs: the header of the xattr object
1362  * @new_xattr: the xattr object to add
1364  * Add an xattr object to @xattrs. This assumes no replacement or removal
1377  * simple_xattrs_init - initialize new xattr header
1380  * Initialize relevant fields of a an xattr header.
1390  * @xattrs: xattr header whose xattrs to destroy
1393  * Destroy all xattrs in @xattr. When this is called no one can hold a
1404 		struct simple_xattr *xattr;
1408 		xattr = rb_entry(rbp, struct simple_xattr, rb_node);
1409 		rb_erase(&xattr->rb_node, &xattrs->rb_root);
1411 			*freed_space += simple_xattr_space(xattr->name,
1412 							   xattr->size);
1413 		simple_xattr_free(xattr);