[linux-block.git] / fs / orangefs / xattr.c

/*
 * (C) 2001 Clemson University and The University of Chicago
 *
 * See COPYING in top-level directory.
 */

/*
 *  Linux VFS extended attribute operations.
 */

#include "protocol.h"
#include "orangefs-kernel.h"
#include "orangefs-bufmap.h"
#include <linux/posix_acl_xattr.h>
#include <linux/xattr.h>


#define SYSTEM_ORANGEFS_KEY "system.pvfs2."
#define SYSTEM_ORANGEFS_KEY_LEN 13

/*
 * this function returns
 *   0 if the key corresponding to name is not meant to be printed as part
 *     of a listxattr.
 *   1 if the key corresponding to name is meant to be returned as part of
 *     a listxattr.
 * The ones that start SYSTEM_ORANGEFS_KEY are the ones to avoid printing.
 */
static int is_reserved_key(const char *key, size_t size)
{

	if (size < SYSTEM_ORANGEFS_KEY_LEN)
		return 1;

	return strncmp(key, SYSTEM_ORANGEFS_KEY, SYSTEM_ORANGEFS_KEY_LEN) ?  1 : 0;
}

static inline int convert_to_internal_xattr_flags(int setxattr_flags)
{
	int internal_flag = 0;

	if (setxattr_flags & XATTR_REPLACE) {
		/* Attribute must exist! */
		internal_flag = ORANGEFS_XATTR_REPLACE;
	} else if (setxattr_flags & XATTR_CREATE) {
		/* Attribute must not exist */
		internal_flag = ORANGEFS_XATTR_CREATE;
	}
	return internal_flag;
}


/*
 * Tries to get a specified key's attributes of a given
 * file into a user-specified buffer. Note that the getxattr
 * interface allows for the users to probe the size of an
 * extended attribute by passing in a value of 0 to size.
 * Thus our return value is always the size of the attribute
 * unless the key does not exist for the file and/or if
 * there were errors in fetching the attribute value.
 */
ssize_t orangefs_inode_getxattr(struct inode *inode, const char *prefix,
		const char *name, void *buffer, size_t size)
{
	struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
	struct orangefs_kernel_op_s *new_op = NULL;
	ssize_t ret = -ENOMEM;
	ssize_t length = 0;
	int fsuid;
	int fsgid;

	gossip_debug(GOSSIP_XATTR_DEBUG,
		     "%s: prefix %s name %s, buffer_size %zd\n",
		     __func__, prefix, name, size);

	if (name == NULL || (size > 0 && buffer == NULL)) {
		gossip_err("orangefs_inode_getxattr: bogus NULL pointers\n");
		return -EINVAL;
	}
	if ((strlen(name) + strlen(prefix)) >= ORANGEFS_MAX_XATTR_NAMELEN) {
		gossip_err("Invalid key length (%d)\n",
			   (int)(strlen(name) + strlen(prefix)));
		return -EINVAL;
	}

	fsuid = from_kuid(current_user_ns(), current_fsuid());
	fsgid = from_kgid(current_user_ns(), current_fsgid());

	gossip_debug(GOSSIP_XATTR_DEBUG,
		     "getxattr on inode %pU, name %s "
		     "(uid %o, gid %o)\n",
		     get_khandle_from_ino(inode),
		     name,
		     fsuid,
		     fsgid);

	down_read(&orangefs_inode->xattr_sem);

	new_op = op_alloc(ORANGEFS_VFS_OP_GETXATTR);
	if (!new_op)
		goto out_unlock;

	new_op->upcall.req.getxattr.refn = orangefs_inode->refn;
	ret = snprintf((char *)new_op->upcall.req.getxattr.key,
		       ORANGEFS_MAX_XATTR_NAMELEN, "%s%s", prefix, name);

	/*
	 * NOTE: Although keys are meant to be NULL terminated textual
	 * strings, I am going to explicitly pass the length just in case
	 * we change this later on...
	 */
	new_op->upcall.req.getxattr.key_sz = ret + 1;

	ret = service_operation(new_op, "orangefs_inode_getxattr",
				get_interruptible_flag(inode));
	if (ret != 0) {
		if (ret == -ENOENT) {
			ret = -ENODATA;
			gossip_debug(GOSSIP_XATTR_DEBUG,
				     "orangefs_inode_getxattr: inode %pU key %s"
				     " does not exist!\n",
				     get_khandle_from_ino(inode),
				     (char *)new_op->upcall.req.getxattr.key);
		}
		goto out_release_op;
	}

	/*
	 * Length returned includes null terminator.
	 */
	length = new_op->downcall.resp.getxattr.val_sz;

	/*
	 * Just return the length of the queried attribute.
	 */
	if (size == 0) {
		ret = length;
		goto out_release_op;
	}

	/*
	 * Check to see if key length is > provided buffer size.
	 */
	if (length > size) {
		ret = -ERANGE;
		goto out_release_op;
	}

	memset(buffer, 0, size);
	memcpy(buffer, new_op->downcall.resp.getxattr.val, length);
	gossip_debug(GOSSIP_XATTR_DEBUG,
	     "orangefs_inode_getxattr: inode %pU "
	     "key %s key_sz %d, val_len %d\n",
	     get_khandle_from_ino(inode),
	     (char *)new_op->
		upcall.req.getxattr.key,
		     (int)new_op->
		upcall.req.getxattr.key_sz,
	     (int)ret);

	ret = length;

out_release_op:
	op_release(new_op);
out_unlock:
	up_read(&orangefs_inode->xattr_sem);
	return ret;
}

static int orangefs_inode_removexattr(struct inode *inode,
			    const char *prefix,
			    const char *name,
			    int flags)
{
	struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
	struct orangefs_kernel_op_s *new_op = NULL;
	int ret = -ENOMEM;

	down_write(&orangefs_inode->xattr_sem);
	new_op = op_alloc(ORANGEFS_VFS_OP_REMOVEXATTR);
	if (!new_op)
		goto out_unlock;

	new_op->upcall.req.removexattr.refn = orangefs_inode->refn;
	/*
	 * NOTE: Although keys are meant to be NULL terminated
	 * textual strings, I am going to explicitly pass the
	 * length just in case we change this later on...
	 */
	ret = snprintf((char *)new_op->upcall.req.removexattr.key,
		       ORANGEFS_MAX_XATTR_NAMELEN,
		       "%s%s",
		       (prefix ? prefix : ""),
		       name);
	new_op->upcall.req.removexattr.key_sz = ret + 1;

	gossip_debug(GOSSIP_XATTR_DEBUG,
		     "orangefs_inode_removexattr: key %s, key_sz %d\n",
		     (char *)new_op->upcall.req.removexattr.key,
		     (int)new_op->upcall.req.removexattr.key_sz);

	ret = service_operation(new_op,
				"orangefs_inode_removexattr",
				get_interruptible_flag(inode));
	if (ret == -ENOENT) {
		/*
		 * Request to replace a non-existent attribute is an error.
		 */
		if (flags & XATTR_REPLACE)
			ret = -ENODATA;
		else
			ret = 0;
	}

	gossip_debug(GOSSIP_XATTR_DEBUG,
		     "orangefs_inode_removexattr: returning %d\n", ret);

	op_release(new_op);
out_unlock:
	up_write(&orangefs_inode->xattr_sem);
	return ret;
}

/*
 * Tries to set an attribute for a given key on a file.
 *
 * Returns a -ve number on error and 0 on success.  Key is text, but value
 * can be binary!
 */
int orangefs_inode_setxattr(struct inode *inode, const char *prefix,
		const char *name, const void *value, size_t size, int flags)
{
	struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
	struct orangefs_kernel_op_s *new_op;
	int internal_flag = 0;
	int ret = -ENOMEM;

	gossip_debug(GOSSIP_XATTR_DEBUG,
		     "%s: prefix %s, name %s, buffer_size %zd\n",
		     __func__, prefix, name, size);

	if (size < 0 ||
	    size >= ORANGEFS_MAX_XATTR_VALUELEN ||
	    flags < 0) {
		gossip_err("orangefs_inode_setxattr: bogus values of size(%d), flags(%d)\n",
			   (int)size,
			   flags);
		return -EINVAL;
	}

	if (name == NULL ||
	    (size > 0 && value == NULL)) {
		gossip_err("orangefs_inode_setxattr: bogus NULL pointers!\n");
		return -EINVAL;
	}

	internal_flag = convert_to_internal_xattr_flags(flags);

	if (prefix) {
		if (strlen(name) + strlen(prefix) >= ORANGEFS_MAX_XATTR_NAMELEN) {
			gossip_err
			    ("orangefs_inode_setxattr: bogus key size (%d)\n",
			     (int)(strlen(name) + strlen(prefix)));
			return -EINVAL;
		}
	} else {
		if (strlen(name) >= ORANGEFS_MAX_XATTR_NAMELEN) {
			gossip_err
			    ("orangefs_inode_setxattr: bogus key size (%d)\n",
			     (int)(strlen(name)));
			return -EINVAL;
		}
	}

	/* This is equivalent to a removexattr */
	if (size == 0 && value == NULL) {
		gossip_debug(GOSSIP_XATTR_DEBUG,
			     "removing xattr (%s%s)\n",
			     prefix,
			     name);
		return orangefs_inode_removexattr(inode, prefix, name, flags);
	}

	gossip_debug(GOSSIP_XATTR_DEBUG,
		     "setxattr on inode %pU, name %s\n",
		     get_khandle_from_ino(inode),
		     name);

	down_write(&orangefs_inode->xattr_sem);
	new_op = op_alloc(ORANGEFS_VFS_OP_SETXATTR);
	if (!new_op)
		goto out_unlock;


	new_op->upcall.req.setxattr.refn = orangefs_inode->refn;
	new_op->upcall.req.setxattr.flags = internal_flag;
	/*
	 * NOTE: Although keys are meant to be NULL terminated textual
	 * strings, I am going to explicitly pass the length just in
	 * case we change this later on...
	 */
	ret = snprintf((char *)new_op->upcall.req.setxattr.keyval.key,
		       ORANGEFS_MAX_XATTR_NAMELEN,
		       "%s%s",
		       prefix, name);
	new_op->upcall.req.setxattr.keyval.key_sz = ret + 1;
	memcpy(new_op->upcall.req.setxattr.keyval.val, value, size);
	new_op->upcall.req.setxattr.keyval.val_sz = size;

	gossip_debug(GOSSIP_XATTR_DEBUG,
		     "orangefs_inode_setxattr: key %s, key_sz %d "
		     " value size %zd\n",
		     (char *)new_op->upcall.req.setxattr.keyval.key,
		     (int)new_op->upcall.req.setxattr.keyval.key_sz,
		     size);

	ret = service_operation(new_op,
				"orangefs_inode_setxattr",
				get_interruptible_flag(inode));

	gossip_debug(GOSSIP_XATTR_DEBUG,
		     "orangefs_inode_setxattr: returning %d\n",
		     ret);

	/* when request is serviced properly, free req op struct */
	op_release(new_op);
out_unlock:
	up_write(&orangefs_inode->xattr_sem);
	return ret;
}

/*
 * Tries to get a specified object's keys into a user-specified buffer of a
 * given size.  Note that like the previous instances of xattr routines, this
 * also allows you to pass in a NULL pointer and 0 size to probe the size for
 * subsequent memory allocations. Thus our return value is always the size of
 * all the keys unless there were errors in fetching the keys!
 */
ssize_t orangefs_listxattr(struct dentry *dentry, char *buffer, size_t size)
{
	struct inode *inode = dentry->d_inode;
	struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
	struct orangefs_kernel_op_s *new_op;
	__u64 token = ORANGEFS_ITERATE_START;
	ssize_t ret = -ENOMEM;
	ssize_t total = 0;
	ssize_t length = 0;
	int count_keys = 0;
	int key_size;
	int i = 0;
	int returned_count = 0;

	if (size > 0 && buffer == NULL) {
		gossip_err("%s: bogus NULL pointers\n", __func__);
		return -EINVAL;
	}
	if (size < 0) {
		gossip_err("Invalid size (%d)\n", (int)size);
		return -EINVAL;
	}

	down_read(&orangefs_inode->xattr_sem);
	new_op = op_alloc(ORANGEFS_VFS_OP_LISTXATTR);
	if (!new_op)
		goto out_unlock;

	if (buffer && size > 0)
		memset(buffer, 0, size);

try_again:
	key_size = 0;
	new_op->upcall.req.listxattr.refn = orangefs_inode->refn;
	new_op->upcall.req.listxattr.token = token;
	new_op->upcall.req.listxattr.requested_count =
	    (size == 0) ? 0 : ORANGEFS_MAX_XATTR_LISTLEN;
	ret = service_operation(new_op, __func__,
				get_interruptible_flag(inode));
	if (ret != 0)
		goto done;

	if (size == 0) {
		/*
		 * This is a bit of a big upper limit, but I did not want to
		 * spend too much time getting this correct, since users end
		 * up allocating memory rather than us...
		 */
		total = new_op->downcall.resp.listxattr.returned_count *
			ORANGEFS_MAX_XATTR_NAMELEN;
		goto done;
	}

	length = new_op->downcall.resp.listxattr.keylen;
	if (length == 0)
		goto done;

	returned_count = new_op->downcall.resp.listxattr.returned_count;
	if (returned_count < 0 ||
	    returned_count >= ORANGEFS_MAX_XATTR_LISTLEN) {
		gossip_err("%s: impossible value for returned_count:%d:\n",
		__func__,
		returned_count);
		goto done;
	}

	/*
	 * Check to see how much can be fit in the buffer. Fit only whole keys.
	 */
	for (i = 0; i < returned_count; i++) {
		if (total + new_op->downcall.resp.listxattr.lengths[i] > size)
			goto done;

		/*
		 * Since many dumb programs try to setxattr() on our reserved
		 * xattrs this is a feeble attempt at defeating those by not
		 * listing them in the output of listxattr.. sigh
		 */
		if (is_reserved_key(new_op->downcall.resp.listxattr.key +
				    key_size,
				    new_op->downcall.resp.
					listxattr.lengths[i])) {
			gossip_debug(GOSSIP_XATTR_DEBUG, "Copying key %d -> %s\n",
					i, new_op->downcall.resp.listxattr.key +
						key_size);
			memcpy(buffer + total,
				new_op->downcall.resp.listxattr.key + key_size,
				new_op->downcall.resp.listxattr.lengths[i]);
			total += new_op->downcall.resp.listxattr.lengths[i];
			count_keys++;
		} else {
			gossip_debug(GOSSIP_XATTR_DEBUG, "[RESERVED] key %d -> %s\n",
					i, new_op->downcall.resp.listxattr.key +
						key_size);
		}
		key_size += new_op->downcall.resp.listxattr.lengths[i];
	}

	/*
	 * Since the buffer was large enough, we might have to continue
	 * fetching more keys!
	 */
	token = new_op->downcall.resp.listxattr.token;
	if (token != ORANGEFS_ITERATE_END)
		goto try_again;

done:
	gossip_debug(GOSSIP_XATTR_DEBUG, "%s: returning %d"
		     " [size of buffer %ld] (filled in %d keys)\n",
		     __func__,
		     ret ? (int)ret : (int)total,
		     (long)size,
		     count_keys);
	op_release(new_op);
	if (ret == 0)
		ret = total;
out_unlock:
	up_read(&orangefs_inode->xattr_sem);
	return ret;
}

static int orangefs_xattr_set_default(const struct xattr_handler *handler,
				      struct dentry *dentry,
				      const char *name,
				      const void *buffer,
				      size_t size,
				      int flags)
{
	return orangefs_inode_setxattr(dentry->d_inode,
				    ORANGEFS_XATTR_NAME_DEFAULT_PREFIX,
				    name,
				    buffer,
				    size,
				    flags);
}

static int orangefs_xattr_get_default(const struct xattr_handler *handler,
				      struct dentry *dentry,
				      const char *name,
				      void *buffer,
				      size_t size)
{
	return orangefs_inode_getxattr(dentry->d_inode,
				    ORANGEFS_XATTR_NAME_DEFAULT_PREFIX,
				    name,
				    buffer,
				    size);

}

static int orangefs_xattr_set_trusted(const struct xattr_handler *handler,
				     struct dentry *dentry,
				     const char *name,
				     const void *buffer,
				     size_t size,
				     int flags)
{
	return orangefs_inode_setxattr(dentry->d_inode,
				    ORANGEFS_XATTR_NAME_TRUSTED_PREFIX,
				    name,
				    buffer,
				    size,
				    flags);
}

static int orangefs_xattr_get_trusted(const struct xattr_handler *handler,
				      struct dentry *dentry,
				      const char *name,
				      void *buffer,
				      size_t size)
{
	return orangefs_inode_getxattr(dentry->d_inode,
				    ORANGEFS_XATTR_NAME_TRUSTED_PREFIX,
				    name,
				    buffer,
				    size);
}

static struct xattr_handler orangefs_xattr_trusted_handler = {
	.prefix = ORANGEFS_XATTR_NAME_TRUSTED_PREFIX,
	.get = orangefs_xattr_get_trusted,
	.set = orangefs_xattr_set_trusted,
};

static struct xattr_handler orangefs_xattr_default_handler = {
	/*
	 * NOTE: this is set to be the empty string.
	 * so that all un-prefixed xattrs keys get caught
	 * here!
	 */
	.prefix = ORANGEFS_XATTR_NAME_DEFAULT_PREFIX,
	.get = orangefs_xattr_get_default,
	.set = orangefs_xattr_set_default,
};

const struct xattr_handler *orangefs_xattr_handlers[] = {
	&posix_acl_access_xattr_handler,
	&posix_acl_default_xattr_handler,
	&orangefs_xattr_trusted_handler,
	&orangefs_xattr_default_handler,
	NULL
};
Commit	Line	Data
1182fca3 MM	1	/*
	2	* (C) 2001 Clemson University and The University of Chicago
	3	*
	4	* See COPYING in top-level directory.
	5	*/
	6
	7	/*
	8	* Linux VFS extended attribute operations.
	9	*/
	10
	11	#include "protocol.h"
575e9461 MM	12	#include "orangefs-kernel.h"
575e9461 MM	13	#include "orangefs-bufmap.h"
1182fca3 MM	14	#include <linux/posix_acl_xattr.h>
	15	#include <linux/xattr.h>
	16
	17
8bb8aefd YL	18	#define SYSTEM_ORANGEFS_KEY "system.pvfs2."
8bb8aefd YL	19	#define SYSTEM_ORANGEFS_KEY_LEN 13
1182fca3 MM	20
	21	/*
	22	* this function returns
	23	* 0 if the key corresponding to name is not meant to be printed as part
	24	* of a listxattr.
	25	* 1 if the key corresponding to name is meant to be returned as part of
	26	* a listxattr.
8bb8aefd	27	* The ones that start SYSTEM_ORANGEFS_KEY are the ones to avoid printing.
1182fca3 MM	28	*/
	29	static int is_reserved_key(const char *key, size_t size)
	30	{
	31
8bb8aefd	32	if (size < SYSTEM_ORANGEFS_KEY_LEN)
1182fca3 MM	33	return 1;
1182fca3 MM	34
8bb8aefd	35	return strncmp(key, SYSTEM_ORANGEFS_KEY, SYSTEM_ORANGEFS_KEY_LEN) ? 1 : 0;
1182fca3 MM	36	}
	37
	38	static inline int convert_to_internal_xattr_flags(int setxattr_flags)
	39	{
	40	int internal_flag = 0;
	41
	42	if (setxattr_flags & XATTR_REPLACE) {
	43	/* Attribute must exist! */
8bb8aefd	44	internal_flag = ORANGEFS_XATTR_REPLACE;
1182fca3 MM	45	} else if (setxattr_flags & XATTR_CREATE) {
1182fca3 MM	46	/* Attribute must not exist */
8bb8aefd	47	internal_flag = ORANGEFS_XATTR_CREATE;
1182fca3 MM	48	}
	49	return internal_flag;
	50	}
	51
	52
	53	/*
	54	* Tries to get a specified key's attributes of a given
	55	* file into a user-specified buffer. Note that the getxattr
	56	* interface allows for the users to probe the size of an
	57	* extended attribute by passing in a value of 0 to size.
	58	* Thus our return value is always the size of the attribute
	59	* unless the key does not exist for the file and/or if
	60	* there were errors in fetching the attribute value.
	61	*/
8bb8aefd	62	ssize_t orangefs_inode_getxattr(struct inode inode, const char prefix,
1182fca3 MM	63	const char name, void buffer, size_t size)
1182fca3 MM	64	{
8bb8aefd YL	65	struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
8bb8aefd YL	66	struct orangefs_kernel_op_s *new_op = NULL;
1182fca3 MM	67	ssize_t ret = -ENOMEM;
	68	ssize_t length = 0;
	69	int fsuid;
	70	int fsgid;
	71
	72	gossip_debug(GOSSIP_XATTR_DEBUG,
	73	"%s: prefix %s name %s, buffer_size %zd\n",
	74	__func__, prefix, name, size);
	75
	76	if (name == NULL \|\| (size > 0 && buffer == NULL)) {
8bb8aefd	77	gossip_err("orangefs_inode_getxattr: bogus NULL pointers\n");
1182fca3 MM	78	return -EINVAL;
1182fca3 MM	79	}
8bb8aefd	80	if ((strlen(name) + strlen(prefix)) >= ORANGEFS_MAX_XATTR_NAMELEN) {
eeaa3d44	81	gossip_err("Invalid key length (%d)\n",
1182fca3 MM	82	(int)(strlen(name) + strlen(prefix)));
	83	return -EINVAL;
	84	}
	85
	86	fsuid = from_kuid(current_user_ns(), current_fsuid());
	87	fsgid = from_kgid(current_user_ns(), current_fsgid());
	88
	89	gossip_debug(GOSSIP_XATTR_DEBUG,
	90	"getxattr on inode %pU, name %s "
	91	"(uid %o, gid %o)\n",
	92	get_khandle_from_ino(inode),
	93	name,
	94	fsuid,
	95	fsgid);
	96
8bb8aefd	97	down_read(&orangefs_inode->xattr_sem);
1182fca3	98
8bb8aefd	99	new_op = op_alloc(ORANGEFS_VFS_OP_GETXATTR);
1182fca3 MM	100	if (!new_op)
	101	goto out_unlock;
	102
8bb8aefd	103	new_op->upcall.req.getxattr.refn = orangefs_inode->refn;
1182fca3	104	ret = snprintf((char *)new_op->upcall.req.getxattr.key,
8bb8aefd	105	ORANGEFS_MAX_XATTR_NAMELEN, "%s%s", prefix, name);
1182fca3 MM	106
	107	/*
	108	* NOTE: Although keys are meant to be NULL terminated textual
	109	* strings, I am going to explicitly pass the length just in case
	110	* we change this later on...
	111	*/
	112	new_op->upcall.req.getxattr.key_sz = ret + 1;
	113
8bb8aefd	114	ret = service_operation(new_op, "orangefs_inode_getxattr",
1182fca3 MM	115	get_interruptible_flag(inode));
	116	if (ret != 0) {
	117	if (ret == -ENOENT) {
	118	ret = -ENODATA;
	119	gossip_debug(GOSSIP_XATTR_DEBUG,
8bb8aefd	120	"orangefs_inode_getxattr: inode %pU key %s"
1182fca3 MM	121	" does not exist!\n",
	122	get_khandle_from_ino(inode),
	123	(char *)new_op->upcall.req.getxattr.key);
	124	}
	125	goto out_release_op;
	126	}
	127
	128	/*
	129	* Length returned includes null terminator.
	130	*/
	131	length = new_op->downcall.resp.getxattr.val_sz;
	132
	133	/*
	134	* Just return the length of the queried attribute.
	135	*/
	136	if (size == 0) {
	137	ret = length;
	138	goto out_release_op;
	139	}
	140
	141	/*
	142	* Check to see if key length is > provided buffer size.
	143	*/
	144	if (length > size) {
	145	ret = -ERANGE;
	146	goto out_release_op;
	147	}
	148
	149	memset(buffer, 0, size);
	150	memcpy(buffer, new_op->downcall.resp.getxattr.val, length);
	151	gossip_debug(GOSSIP_XATTR_DEBUG,
8bb8aefd	152	"orangefs_inode_getxattr: inode %pU "
1182fca3 MM	153	"key %s key_sz %d, val_len %d\n",
	154	get_khandle_from_ino(inode),
	155	(char *)new_op->
	156	upcall.req.getxattr.key,
	157	(int)new_op->
	158	upcall.req.getxattr.key_sz,
	159	(int)ret);
	160
	161	ret = length;
	162
	163	out_release_op:
	164	op_release(new_op);
	165	out_unlock:
8bb8aefd	166	up_read(&orangefs_inode->xattr_sem);
1182fca3 MM	167	return ret;
	168	}
	169
8bb8aefd	170	static int orangefs_inode_removexattr(struct inode *inode,
1182fca3 MM	171	const char *prefix,
	172	const char *name,
	173	int flags)
	174	{
8bb8aefd YL	175	struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
8bb8aefd YL	176	struct orangefs_kernel_op_s *new_op = NULL;
1182fca3 MM	177	int ret = -ENOMEM;
1182fca3 MM	178
8bb8aefd YL	179	down_write(&orangefs_inode->xattr_sem);
8bb8aefd YL	180	new_op = op_alloc(ORANGEFS_VFS_OP_REMOVEXATTR);
1182fca3 MM	181	if (!new_op)
	182	goto out_unlock;
	183
8bb8aefd	184	new_op->upcall.req.removexattr.refn = orangefs_inode->refn;
1182fca3 MM	185	/*
	186	* NOTE: Although keys are meant to be NULL terminated
	187	* textual strings, I am going to explicitly pass the
	188	* length just in case we change this later on...
	189	*/
	190	ret = snprintf((char *)new_op->upcall.req.removexattr.key,
8bb8aefd	191	ORANGEFS_MAX_XATTR_NAMELEN,
1182fca3 MM	192	"%s%s",
	193	(prefix ? prefix : ""),
	194	name);
	195	new_op->upcall.req.removexattr.key_sz = ret + 1;
	196
	197	gossip_debug(GOSSIP_XATTR_DEBUG,
8bb8aefd	198	"orangefs_inode_removexattr: key %s, key_sz %d\n",
1182fca3 MM	199	(char *)new_op->upcall.req.removexattr.key,
	200	(int)new_op->upcall.req.removexattr.key_sz);
	201
	202	ret = service_operation(new_op,
8bb8aefd	203	"orangefs_inode_removexattr",
1182fca3 MM	204	get_interruptible_flag(inode));
	205	if (ret == -ENOENT) {
	206	/*
	207	* Request to replace a non-existent attribute is an error.
	208	*/
	209	if (flags & XATTR_REPLACE)
	210	ret = -ENODATA;
	211	else
	212	ret = 0;
	213	}
	214
	215	gossip_debug(GOSSIP_XATTR_DEBUG,
8bb8aefd	216	"orangefs_inode_removexattr: returning %d\n", ret);
1182fca3 MM	217
	218	op_release(new_op);
	219	out_unlock:
8bb8aefd	220	up_write(&orangefs_inode->xattr_sem);
1182fca3 MM	221	return ret;
	222	}
	223
	224	/*
	225	* Tries to set an attribute for a given key on a file.
	226	*
	227	* Returns a -ve number on error and 0 on success. Key is text, but value
	228	* can be binary!
	229	*/
8bb8aefd	230	int orangefs_inode_setxattr(struct inode inode, const char prefix,
1182fca3 MM	231	const char name, const void value, size_t size, int flags)
1182fca3 MM	232	{
8bb8aefd YL	233	struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
8bb8aefd YL	234	struct orangefs_kernel_op_s *new_op;
1182fca3 MM	235	int internal_flag = 0;
	236	int ret = -ENOMEM;
	237
	238	gossip_debug(GOSSIP_XATTR_DEBUG,
	239	"%s: prefix %s, name %s, buffer_size %zd\n",
	240	__func__, prefix, name, size);
	241
	242	if (size < 0 \|\|
8bb8aefd	243	size >= ORANGEFS_MAX_XATTR_VALUELEN \|\|
1182fca3	244	flags < 0) {
8bb8aefd	245	gossip_err("orangefs_inode_setxattr: bogus values of size(%d), flags(%d)\n",
1182fca3 MM	246	(int)size,
	247	flags);
	248	return -EINVAL;
	249	}
	250
	251	if (name == NULL \|\|
	252	(size > 0 && value == NULL)) {
8bb8aefd	253	gossip_err("orangefs_inode_setxattr: bogus NULL pointers!\n");
1182fca3 MM	254	return -EINVAL;
	255	}
	256
	257	internal_flag = convert_to_internal_xattr_flags(flags);
	258
	259	if (prefix) {
8bb8aefd	260	if (strlen(name) + strlen(prefix) >= ORANGEFS_MAX_XATTR_NAMELEN) {
1182fca3	261	gossip_err
8bb8aefd	262	("orangefs_inode_setxattr: bogus key size (%d)\n",
1182fca3 MM	263	(int)(strlen(name) + strlen(prefix)));
	264	return -EINVAL;
	265	}
	266	} else {
8bb8aefd	267	if (strlen(name) >= ORANGEFS_MAX_XATTR_NAMELEN) {
1182fca3	268	gossip_err
8bb8aefd	269	("orangefs_inode_setxattr: bogus key size (%d)\n",
1182fca3 MM	270	(int)(strlen(name)));
	271	return -EINVAL;
	272	}
	273	}
	274
	275	/* This is equivalent to a removexattr */
	276	if (size == 0 && value == NULL) {
	277	gossip_debug(GOSSIP_XATTR_DEBUG,
	278	"removing xattr (%s%s)\n",
	279	prefix,
	280	name);
8bb8aefd	281	return orangefs_inode_removexattr(inode, prefix, name, flags);
1182fca3 MM	282	}
	283
	284	gossip_debug(GOSSIP_XATTR_DEBUG,
	285	"setxattr on inode %pU, name %s\n",
	286	get_khandle_from_ino(inode),
	287	name);
	288
8bb8aefd YL	289	down_write(&orangefs_inode->xattr_sem);
8bb8aefd YL	290	new_op = op_alloc(ORANGEFS_VFS_OP_SETXATTR);
1182fca3 MM	291	if (!new_op)
	292	goto out_unlock;
	293
	294
8bb8aefd	295	new_op->upcall.req.setxattr.refn = orangefs_inode->refn;
1182fca3 MM	296	new_op->upcall.req.setxattr.flags = internal_flag;
	297	/*
	298	* NOTE: Although keys are meant to be NULL terminated textual
	299	* strings, I am going to explicitly pass the length just in
	300	* case we change this later on...
	301	*/
	302	ret = snprintf((char *)new_op->upcall.req.setxattr.keyval.key,
8bb8aefd	303	ORANGEFS_MAX_XATTR_NAMELEN,
1182fca3 MM	304	"%s%s",
	305	prefix, name);
	306	new_op->upcall.req.setxattr.keyval.key_sz = ret + 1;
	307	memcpy(new_op->upcall.req.setxattr.keyval.val, value, size);
	308	new_op->upcall.req.setxattr.keyval.val_sz = size;
	309
	310	gossip_debug(GOSSIP_XATTR_DEBUG,
8bb8aefd	311	"orangefs_inode_setxattr: key %s, key_sz %d "
1182fca3 MM	312	" value size %zd\n",
	313	(char *)new_op->upcall.req.setxattr.keyval.key,
	314	(int)new_op->upcall.req.setxattr.keyval.key_sz,
	315	size);
	316
	317	ret = service_operation(new_op,
8bb8aefd	318	"orangefs_inode_setxattr",
1182fca3 MM	319	get_interruptible_flag(inode));
	320
	321	gossip_debug(GOSSIP_XATTR_DEBUG,
8bb8aefd	322	"orangefs_inode_setxattr: returning %d\n",
1182fca3 MM	323	ret);
	324
	325	/* when request is serviced properly, free req op struct */
	326	op_release(new_op);
	327	out_unlock:
8bb8aefd	328	up_write(&orangefs_inode->xattr_sem);
1182fca3 MM	329	return ret;
	330	}
	331
	332	/*
	333	* Tries to get a specified object's keys into a user-specified buffer of a
	334	* given size. Note that like the previous instances of xattr routines, this
	335	* also allows you to pass in a NULL pointer and 0 size to probe the size for
	336	* subsequent memory allocations. Thus our return value is always the size of
	337	* all the keys unless there were errors in fetching the keys!
	338	*/
8bb8aefd	339	ssize_t orangefs_listxattr(struct dentry dentry, char buffer, size_t size)
1182fca3 MM	340	{
1182fca3 MM	341	struct inode *inode = dentry->d_inode;
8bb8aefd YL	342	struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
	343	struct orangefs_kernel_op_s *new_op;
	344	__u64 token = ORANGEFS_ITERATE_START;
1182fca3 MM	345	ssize_t ret = -ENOMEM;
	346	ssize_t total = 0;
	347	ssize_t length = 0;
	348	int count_keys = 0;
	349	int key_size;
	350	int i = 0;
62441fa5	351	int returned_count = 0;
1182fca3 MM	352
	353	if (size > 0 && buffer == NULL) {
	354	gossip_err("%s: bogus NULL pointers\n", __func__);
	355	return -EINVAL;
	356	}
	357	if (size < 0) {
	358	gossip_err("Invalid size (%d)\n", (int)size);
	359	return -EINVAL;
	360	}
	361
8bb8aefd YL	362	down_read(&orangefs_inode->xattr_sem);
8bb8aefd YL	363	new_op = op_alloc(ORANGEFS_VFS_OP_LISTXATTR);
1182fca3 MM	364	if (!new_op)
	365	goto out_unlock;
	366
	367	if (buffer && size > 0)
	368	memset(buffer, 0, size);
	369
	370	try_again:
	371	key_size = 0;
8bb8aefd	372	new_op->upcall.req.listxattr.refn = orangefs_inode->refn;
1182fca3 MM	373	new_op->upcall.req.listxattr.token = token;
1182fca3 MM	374	new_op->upcall.req.listxattr.requested_count =
8bb8aefd	375	(size == 0) ? 0 : ORANGEFS_MAX_XATTR_LISTLEN;
1182fca3 MM	376	ret = service_operation(new_op, __func__,
	377	get_interruptible_flag(inode));
	378	if (ret != 0)
	379	goto done;
	380
	381	if (size == 0) {
	382	/*
	383	* This is a bit of a big upper limit, but I did not want to
	384	* spend too much time getting this correct, since users end
	385	* up allocating memory rather than us...
	386	*/
	387	total = new_op->downcall.resp.listxattr.returned_count *
8bb8aefd	388	ORANGEFS_MAX_XATTR_NAMELEN;
1182fca3 MM	389	goto done;
	390	}
	391
	392	length = new_op->downcall.resp.listxattr.keylen;
	393	if (length == 0)
	394	goto done;
	395
62441fa5 MM	396	returned_count = new_op->downcall.resp.listxattr.returned_count;
	397	if (returned_count < 0 \|\|
	398	returned_count >= ORANGEFS_MAX_XATTR_LISTLEN) {
	399	gossip_err("%s: impossible value for returned_count:%d:\n",
	400	__func__,
	401	returned_count);
	402	goto done;
	403	}
	404
1182fca3 MM	405	/*
	406	* Check to see how much can be fit in the buffer. Fit only whole keys.
	407	*/
62441fa5	408	for (i = 0; i < returned_count; i++) {
1182fca3 MM	409	if (total + new_op->downcall.resp.listxattr.lengths[i] > size)
	410	goto done;
	411
	412	/*
	413	* Since many dumb programs try to setxattr() on our reserved
	414	* xattrs this is a feeble attempt at defeating those by not
	415	* listing them in the output of listxattr.. sigh
	416	*/
	417	if (is_reserved_key(new_op->downcall.resp.listxattr.key +
	418	key_size,
	419	new_op->downcall.resp.
	420	listxattr.lengths[i])) {
	421	gossip_debug(GOSSIP_XATTR_DEBUG, "Copying key %d -> %s\n",
	422	i, new_op->downcall.resp.listxattr.key +
	423	key_size);
	424	memcpy(buffer + total,
	425	new_op->downcall.resp.listxattr.key + key_size,
	426	new_op->downcall.resp.listxattr.lengths[i]);
	427	total += new_op->downcall.resp.listxattr.lengths[i];
	428	count_keys++;
	429	} else {
	430	gossip_debug(GOSSIP_XATTR_DEBUG, "[RESERVED] key %d -> %s\n",
	431	i, new_op->downcall.resp.listxattr.key +
	432	key_size);
	433	}
	434	key_size += new_op->downcall.resp.listxattr.lengths[i];
	435	}
	436
	437	/*
	438	* Since the buffer was large enough, we might have to continue
	439	* fetching more keys!
	440	*/
	441	token = new_op->downcall.resp.listxattr.token;
8bb8aefd	442	if (token != ORANGEFS_ITERATE_END)
1182fca3 MM	443	goto try_again;
	444
	445	done:
	446	gossip_debug(GOSSIP_XATTR_DEBUG, "%s: returning %d"
	447	" [size of buffer %ld] (filled in %d keys)\n",
	448	__func__,
	449	ret ? (int)ret : (int)total,
	450	(long)size,
	451	count_keys);
	452	op_release(new_op);
	453	if (ret == 0)
	454	ret = total;
	455	out_unlock:
8bb8aefd	456	up_read(&orangefs_inode->xattr_sem);
1182fca3 MM	457	return ret;
	458	}
	459
8bb8aefd YL	460	static int orangefs_xattr_set_default(const struct xattr_handler *handler,
	461	struct dentry *dentry,
	462	const char *name,
	463	const void *buffer,
	464	size_t size,
	465	int flags)
1182fca3	466	{
8bb8aefd YL	467	return orangefs_inode_setxattr(dentry->d_inode,
8bb8aefd YL	468	ORANGEFS_XATTR_NAME_DEFAULT_PREFIX,
1182fca3 MM	469	name,
	470	buffer,
	471	size,
	472	flags);
	473	}
	474
8bb8aefd YL	475	static int orangefs_xattr_get_default(const struct xattr_handler *handler,
	476	struct dentry *dentry,
	477	const char *name,
	478	void *buffer,
	479	size_t size)
1182fca3	480	{
8bb8aefd YL	481	return orangefs_inode_getxattr(dentry->d_inode,
8bb8aefd YL	482	ORANGEFS_XATTR_NAME_DEFAULT_PREFIX,
1182fca3 MM	483	name,
	484	buffer,
	485	size);
	486
	487	}
	488
8bb8aefd YL	489	static int orangefs_xattr_set_trusted(const struct xattr_handler *handler,
	490	struct dentry *dentry,
	491	const char *name,
	492	const void *buffer,
	493	size_t size,
	494	int flags)
1182fca3	495	{
8bb8aefd YL	496	return orangefs_inode_setxattr(dentry->d_inode,
8bb8aefd YL	497	ORANGEFS_XATTR_NAME_TRUSTED_PREFIX,
1182fca3 MM	498	name,
	499	buffer,
	500	size,
	501	flags);
	502	}
	503
8bb8aefd YL	504	static int orangefs_xattr_get_trusted(const struct xattr_handler *handler,
	505	struct dentry *dentry,
	506	const char *name,
	507	void *buffer,
	508	size_t size)
1182fca3	509	{
8bb8aefd YL	510	return orangefs_inode_getxattr(dentry->d_inode,
8bb8aefd YL	511	ORANGEFS_XATTR_NAME_TRUSTED_PREFIX,
1182fca3 MM	512	name,
	513	buffer,
	514	size);
	515	}
	516
8bb8aefd YL	517	static struct xattr_handler orangefs_xattr_trusted_handler = {
	518	.prefix = ORANGEFS_XATTR_NAME_TRUSTED_PREFIX,
	519	.get = orangefs_xattr_get_trusted,
	520	.set = orangefs_xattr_set_trusted,
1182fca3 MM	521	};
1182fca3 MM	522
8bb8aefd	523	static struct xattr_handler orangefs_xattr_default_handler = {
1182fca3 MM	524	/*
	525	* NOTE: this is set to be the empty string.
	526	* so that all un-prefixed xattrs keys get caught
	527	* here!
	528	*/
8bb8aefd YL	529	.prefix = ORANGEFS_XATTR_NAME_DEFAULT_PREFIX,
	530	.get = orangefs_xattr_get_default,
	531	.set = orangefs_xattr_set_default,
1182fca3 MM	532	};
1182fca3 MM	533
8bb8aefd	534	const struct xattr_handler *orangefs_xattr_handlers[] = {
1182fca3 MM	535	&posix_acl_access_xattr_handler,
1182fca3 MM	536	&posix_acl_default_xattr_handler,
8bb8aefd YL	537	&orangefs_xattr_trusted_handler,
8bb8aefd YL	538	&orangefs_xattr_default_handler,
1182fca3 MM	539	NULL
1182fca3 MM	540	};