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

// SPDX-License-Identifier: GPL-2.0
/*
 * (C) 2001 Clemson University and The University of Chicago
 * Copyright 2018 Omnibond Systems, L.L.C.
 *
 * 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>
#include <linux/hashtable.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;
}

static unsigned int xattr_key(const char *key)
{
	unsigned int i = 0;
	while (key)
		i += *key++;
	return i % 16;
}

static struct orangefs_cached_xattr *find_cached_xattr(struct inode *inode,
    const char *key)
{
	struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
	struct orangefs_cached_xattr *cx;
	struct hlist_head *h;
	struct hlist_node *tmp;
	h = &orangefs_inode->xattr_cache[xattr_key(key)];
	if (hlist_empty(h))
		return NULL;
	hlist_for_each_entry_safe(cx, tmp, h, node) {
/*		if (!time_before(jiffies, cx->timeout)) {
			hlist_del(&cx->node);
			kfree(cx);
			continue;
		}*/
		if (!strcmp(cx->key, key))
			return cx;
	}
	return NULL;
}

/*
 * 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 *name,
				void *buffer, size_t size)
{
	struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
	struct orangefs_kernel_op_s *new_op = NULL;
	struct orangefs_cached_xattr *cx;
	ssize_t ret = -ENOMEM;
	ssize_t length = 0;
	int fsuid;
	int fsgid;

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

	if (S_ISLNK(inode->i_mode))
		return -EOPNOTSUPP;

	if (strlen(name) >= ORANGEFS_MAX_XATTR_NAMELEN)
		return -EINVAL;

	fsuid = from_kuid(&init_user_ns, current_fsuid());
	fsgid = from_kgid(&init_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);

	cx = find_cached_xattr(inode, name);
	if (cx && time_before(jiffies, cx->timeout)) {
		if (cx->length == -1) {
			ret = -ENODATA;
			goto out_unlock;
		} else {
			if (size == 0) {
				ret = cx->length;
				goto out_unlock;
			}
			if (cx->length > size) {
				ret = -ERANGE;
				goto out_unlock;
			}
			memcpy(buffer, cx->val, cx->length);
			memset(buffer + cx->length, 0, size - cx->length);
			ret = cx->length;
			goto out_unlock;
		}
	}

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

	new_op->upcall.req.getxattr.refn = orangefs_inode->refn;
	strcpy(new_op->upcall.req.getxattr.key, 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 = strlen(name) + 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);
			cx = kmalloc(sizeof *cx, GFP_KERNEL);
			if (cx) {
				strcpy(cx->key, name);
				cx->length = -1;
				cx->timeout = jiffies +
				    orangefs_getattr_timeout_msecs*HZ/1000;
				hash_add(orangefs_inode->xattr_cache, &cx->node,
				    xattr_key(cx->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;
	}

	memcpy(buffer, new_op->downcall.resp.getxattr.val, length);
	memset(buffer + length, 0, size - 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;

	if (cx) {
		strcpy(cx->key, name);
		memcpy(cx->val, buffer, length);
		cx->length = length;
		cx->timeout = jiffies + HZ;
	} else {
		cx = kmalloc(sizeof *cx, GFP_KERNEL);
		if (cx) {
			strcpy(cx->key, name);
			memcpy(cx->val, buffer, length);
			cx->length = length;
			cx->timeout = jiffies + HZ;
			hash_add(orangefs_inode->xattr_cache, &cx->node,
			    xattr_key(cx->key));
		}
	}

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 *name,
				      int flags)
{
	struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
	struct orangefs_kernel_op_s *new_op = NULL;
	struct orangefs_cached_xattr *cx;
	struct hlist_head *h;
	struct hlist_node *tmp;
	int ret = -ENOMEM;

	if (strlen(name) >= ORANGEFS_MAX_XATTR_NAMELEN)
		return -EINVAL;

	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...
	 */
	strcpy(new_op->upcall.req.removexattr.key, name);
	new_op->upcall.req.removexattr.key_sz = strlen(name) + 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);

	h = &orangefs_inode->xattr_cache[xattr_key(name)];
	hlist_for_each_entry_safe(cx, tmp, h, node) {
		if (!strcmp(cx->key, name)) {
			hlist_del(&cx->node);
			kfree(cx);
			break;
		}
	}

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 *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;
	struct orangefs_cached_xattr *cx;
	struct hlist_head *h;
	struct hlist_node *tmp;
	int ret = -ENOMEM;

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

	if (size > ORANGEFS_MAX_XATTR_VALUELEN)
		return -EINVAL;
	if (strlen(name) >= ORANGEFS_MAX_XATTR_NAMELEN)
		return -EINVAL;

	internal_flag = convert_to_internal_xattr_flags(flags);

	/* This is equivalent to a removexattr */
	if (size == 0 && !value) {
		gossip_debug(GOSSIP_XATTR_DEBUG,
			     "removing xattr (%s)\n",
			     name);
		return orangefs_inode_removexattr(inode, 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...
	 */
	strcpy(new_op->upcall.req.setxattr.keyval.key, name);
	new_op->upcall.req.setxattr.keyval.key_sz = strlen(name) + 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);

	h = &orangefs_inode->xattr_cache[xattr_key(name)];
	hlist_for_each_entry_safe(cx, tmp, h, node) {
		if (!strcmp(cx->key, name)) {
			hlist_del(&cx->node);
			kfree(cx);
			break;
		}
	}

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;
	int count_keys = 0;
	int key_size;
	int i = 0;
	int returned_count = 0;

	if (size > 0 && !buffer) {
		gossip_err("%s: bogus NULL pointers\n", __func__);
		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;
	}

	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);
		ret = -EIO;
		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 (new_op->downcall.resp.listxattr.lengths[i] < 0 ||
		    new_op->downcall.resp.listxattr.lengths[i] >
		    ORANGEFS_MAX_XATTR_NAMELEN) {
			gossip_err("%s: impossible value for lengths[%d]\n",
			    __func__,
			    new_op->downcall.resp.listxattr.lengths[i]);
			ret = -EIO;
			goto done;
		}
		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 *unused,
				      struct inode *inode,
				      const char *name,
				      const void *buffer,
				      size_t size,
				      int flags)
{
	return orangefs_inode_setxattr(inode, name, buffer, size, flags);
}

static int orangefs_xattr_get_default(const struct xattr_handler *handler,
				      struct dentry *unused,
				      struct inode *inode,
				      const char *name,
				      void *buffer,
				      size_t size)
{
	return orangefs_inode_getxattr(inode, name, buffer, size);

}

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