linux-fsdevel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] fs: xattr: rewrite simple_xattr_set()
@ 2012-10-25 15:26 Aristeu Rozanski
  2012-10-25 17:33 ` Tejun Heo
  0 siblings, 1 reply; 7+ messages in thread
From: Aristeu Rozanski @ 2012-10-25 15:26 UTC (permalink / raw)
  To: linux-kernel; +Cc: Tejun Heo, Li Zefan, Al Viro, linux-fsdevel

The way this function was written is confusing and already caused problems.
Rewriting it to be easier to understand and maintain.

Cc: Tejun Heo <tj@kernel.org>
Cc: Li Zefan <lizefan@huawei.com>
Cc: Al Viro <viro@ZenIV.linux.org.uk>
Signed-off-by: Aristeu Rozanski <aris@redhat.com>

---
 fs/xattr.c |  124 +++++++++++++++++++++++++++++++++++++------------------------
 1 file changed, 76 insertions(+), 48 deletions(-)

Index: github/fs/xattr.c
===================================================================
--- github.orig/fs/xattr.c	2012-10-23 16:02:41.155857391 -0400
+++ github/fs/xattr.c	2012-10-25 11:17:15.118197552 -0400
@@ -842,55 +842,46 @@
 	return ret;
 }
 
-static int __simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
-			      const void *value, size_t size, int flags)
+static struct simple_xattr *__find_xattr(struct simple_xattrs *xattrs,
+					 const char *name)
 {
 	struct simple_xattr *xattr;
-	struct simple_xattr *new_xattr = NULL;
-	int err = 0;
-
-	/* value == NULL means remove */
-	if (value) {
-		new_xattr = simple_xattr_alloc(value, size);
-		if (!new_xattr)
-			return -ENOMEM;
-
-		new_xattr->name = kstrdup(name, GFP_KERNEL);
-		if (!new_xattr->name) {
-			kfree(new_xattr);
-			return -ENOMEM;
-		}
-	}
 
-	spin_lock(&xattrs->lock);
 	list_for_each_entry(xattr, &xattrs->head, list) {
-		if (!strcmp(name, xattr->name)) {
-			if (flags & XATTR_CREATE) {
-				xattr = new_xattr;
-				err = -EEXIST;
-			} else if (new_xattr) {
-				list_replace(&xattr->list, &new_xattr->list);
-			} else {
-				list_del(&xattr->list);
-			}
-			goto out;
-		}
+		if (!strcmp(name, xattr->name))
+			return xattr;
 	}
-	if (flags & XATTR_REPLACE) {
-		xattr = new_xattr;
-		err = -ENODATA;
-	} else {
-		list_add(&new_xattr->list, &xattrs->head);
-		xattr = NULL;
-	}
-out:
-	spin_unlock(&xattrs->lock);
+	return NULL;
+}
+
+static int __simple_xattr_remove(struct simple_xattrs *xattrs,
+				 const char *name)
+{
+	struct simple_xattr *xattr;
+
+	xattr = __find_xattr(xattrs, name);
 	if (xattr) {
+		list_del(&xattr->list);
 		kfree(xattr->name);
 		kfree(xattr);
+		return 0;
 	}
-	return err;
 
+	return 1;
+}
+
+/*
+ * xattr REMOVE operation for in-memory/pseudo filesystems
+ */
+int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name)
+{
+	int rc;
+
+	spin_lock(&xattrs->lock);
+	rc = __simple_xattr_remove(xattrs, name);
+	spin_unlock(&xattrs->lock);
+
+	return rc;
 }
 
 /**
@@ -910,17 +901,54 @@
 int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
 		     const void *value, size_t size, int flags)
 {
+	struct simple_xattr *found, *new_xattr;
+	int err = 0;
+
 	if (size == 0)
-		value = ""; /* empty EA, do not remove */
-	return __simple_xattr_set(xattrs, name, value, size, flags);
-}
+		value = ""; /* empty EA */
 
-/*
- * xattr REMOVE operation for in-memory/pseudo filesystems
- */
-int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name)
-{
-	return __simple_xattr_set(xattrs, name, NULL, 0, XATTR_REPLACE);
+	/* if value == NULL is specified, remove the item */
+	if (value == NULL)
+		return simple_xattr_remove(xattrs, name);
+
+	new_xattr = simple_xattr_alloc(value, size);
+	if (!new_xattr)
+		return -ENOMEM;
+
+	new_xattr->name = kstrdup(name, GFP_KERNEL);
+	if (!new_xattr->name) {
+		kfree(new_xattr);
+		return -ENOMEM;
+	}
+
+	spin_lock(&xattrs->lock);
+
+	found = __find_xattr(xattrs, name);
+	if (found) {
+		if (flags & XATTR_CREATE) {
+			err = -EEXIST;
+			goto free_new;
+		}
+
+		list_replace(&found->list, &new_xattr->list);
+		kfree(found->name);
+		kfree(found);
+	} else {
+		if (flags & XATTR_REPLACE) {
+			err = -ENODATA;
+			goto free_new;
+		}
+
+		list_add_tail(&new_xattr->list, &xattrs->head);
+	}
+
+out:
+	spin_unlock(&xattrs->lock);
+	return err;
+free_new:
+	kfree(new_xattr->name);
+	kfree(new_xattr);
+	goto out;
 }
 
 static bool xattr_is_trusted(const char *name)

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH] fs: xattr: rewrite simple_xattr_set()
  2012-10-25 15:26 [PATCH] fs: xattr: rewrite simple_xattr_set() Aristeu Rozanski
@ 2012-10-25 17:33 ` Tejun Heo
  2012-10-25 17:54   ` Aristeu Rozanski
  0 siblings, 1 reply; 7+ messages in thread
From: Tejun Heo @ 2012-10-25 17:33 UTC (permalink / raw)
  To: Aristeu Rozanski
  Cc: linux-kernel, Li Zefan, Al Viro, linux-fsdevel, Hugh Dickins

(cc'ing Hugh and keeping the whole body)

Hello,

On Thu, Oct 25, 2012 at 11:26:14AM -0400, Aristeu Rozanski wrote:
> The way this function was written is confusing and already caused problems.
> Rewriting it to be easier to understand and maintain.
> 
> Cc: Tejun Heo <tj@kernel.org>
> Cc: Li Zefan <lizefan@huawei.com>
> Cc: Al Viro <viro@ZenIV.linux.org.uk>
> Signed-off-by: Aristeu Rozanski <aris@redhat.com>

Generally looks okay to me but I think the return value from removal
path is wrong.  More below.

> ---
>  fs/xattr.c |  124 +++++++++++++++++++++++++++++++++++++------------------------
>  1 file changed, 76 insertions(+), 48 deletions(-)
> 
> Index: github/fs/xattr.c
> ===================================================================
> --- github.orig/fs/xattr.c	2012-10-23 16:02:41.155857391 -0400
> +++ github/fs/xattr.c	2012-10-25 11:17:15.118197552 -0400
> @@ -842,55 +842,46 @@
>  	return ret;
>  }
>  
> -static int __simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
> -			      const void *value, size_t size, int flags)
> +static struct simple_xattr *__find_xattr(struct simple_xattrs *xattrs,
> +					 const char *name)
>  {
>  	struct simple_xattr *xattr;
> -	struct simple_xattr *new_xattr = NULL;
> -	int err = 0;
> -
> -	/* value == NULL means remove */
> -	if (value) {
> -		new_xattr = simple_xattr_alloc(value, size);
> -		if (!new_xattr)
> -			return -ENOMEM;
> -
> -		new_xattr->name = kstrdup(name, GFP_KERNEL);
> -		if (!new_xattr->name) {
> -			kfree(new_xattr);
> -			return -ENOMEM;
> -		}
> -	}
>  
> -	spin_lock(&xattrs->lock);
>  	list_for_each_entry(xattr, &xattrs->head, list) {
> -		if (!strcmp(name, xattr->name)) {
> -			if (flags & XATTR_CREATE) {
> -				xattr = new_xattr;
> -				err = -EEXIST;
> -			} else if (new_xattr) {
> -				list_replace(&xattr->list, &new_xattr->list);
> -			} else {
> -				list_del(&xattr->list);
> -			}
> -			goto out;
> -		}
> +		if (!strcmp(name, xattr->name))
> +			return xattr;
>  	}
> -	if (flags & XATTR_REPLACE) {
> -		xattr = new_xattr;
> -		err = -ENODATA;
> -	} else {
> -		list_add(&new_xattr->list, &xattrs->head);
> -		xattr = NULL;
> -	}
> -out:
> -	spin_unlock(&xattrs->lock);
> +	return NULL;
> +}
> +
> +static int __simple_xattr_remove(struct simple_xattrs *xattrs,
> +				 const char *name)
> +{
> +	struct simple_xattr *xattr;
> +
> +	xattr = __find_xattr(xattrs, name);
>  	if (xattr) {
> +		list_del(&xattr->list);
>  		kfree(xattr->name);
>  		kfree(xattr);
> +		return 0;
>  	}
> -	return err;
>  
> +	return 1;
> +}

So, it returns 0 on success and 1 on failure, which in itself isn't a
particularly good idea.

> +
> +/*
> + * xattr REMOVE operation for in-memory/pseudo filesystems
> + */
> +int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name)
> +{
> +	int rc;
> +
> +	spin_lock(&xattrs->lock);
> +	rc = __simple_xattr_remove(xattrs, name);
> +	spin_unlock(&xattrs->lock);
> +
> +	return rc;
>  }
>  
>  /**
> @@ -910,17 +901,54 @@
>  int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
>  		     const void *value, size_t size, int flags)
>  {
> +	struct simple_xattr *found, *new_xattr;
> +	int err = 0;
> +
>  	if (size == 0)
> -		value = ""; /* empty EA, do not remove */
> -	return __simple_xattr_set(xattrs, name, value, size, flags);
> -}
> +		value = ""; /* empty EA */
>  
> -/*
> - * xattr REMOVE operation for in-memory/pseudo filesystems
> - */
> -int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name)
> -{
> -	return __simple_xattr_set(xattrs, name, NULL, 0, XATTR_REPLACE);
> +	/* if value == NULL is specified, remove the item */
> +	if (value == NULL)
> +		return simple_xattr_remove(xattrs, name);

And gets relayed to the caller.

> +
> +	new_xattr = simple_xattr_alloc(value, size);
> +	if (!new_xattr)
> +		return -ENOMEM;
> +
> +	new_xattr->name = kstrdup(name, GFP_KERNEL);
> +	if (!new_xattr->name) {
> +		kfree(new_xattr);
> +		return -ENOMEM;
> +	}
> +
> +	spin_lock(&xattrs->lock);
> +
> +	found = __find_xattr(xattrs, name);
> +	if (found) {
> +		if (flags & XATTR_CREATE) {
> +			err = -EEXIST;
> +			goto free_new;
> +		}
> +
> +		list_replace(&found->list, &new_xattr->list);
> +		kfree(found->name);
> +		kfree(found);
> +	} else {
> +		if (flags & XATTR_REPLACE) {
> +			err = -ENODATA;
> +			goto free_new;
> +		}
> +
> +		list_add_tail(&new_xattr->list, &xattrs->head);
> +	}
> +
> +out:
> +	spin_unlock(&xattrs->lock);
> +	return err;
> +free_new:
> +	kfree(new_xattr->name);
> +	kfree(new_xattr);
> +	goto out;
>  }
>  
>  static bool xattr_is_trusted(const char *name)

-- 
tejun

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH] fs: xattr: rewrite simple_xattr_set()
  2012-10-25 17:33 ` Tejun Heo
@ 2012-10-25 17:54   ` Aristeu Rozanski
  2012-10-25 17:59     ` Tejun Heo
  0 siblings, 1 reply; 7+ messages in thread
From: Aristeu Rozanski @ 2012-10-25 17:54 UTC (permalink / raw)
  To: Tejun Heo; +Cc: linux-kernel, Li Zefan, Al Viro, linux-fsdevel, Hugh Dickins

On Thu, Oct 25, 2012 at 10:33:26AM -0700, Tejun Heo wrote:
> On Thu, Oct 25, 2012 at 11:26:14AM -0400, Aristeu Rozanski wrote:
> > -	return err;
> >  
> > +	return 1;
> > +}
> 
> So, it returns 0 on success and 1 on failure, which in itself isn't a
> particularly good idea.

you mean it should return -ENODATA instead?

-- 
Aristeu

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH] fs: xattr: rewrite simple_xattr_set()
  2012-10-25 17:54   ` Aristeu Rozanski
@ 2012-10-25 17:59     ` Tejun Heo
  2012-10-25 18:12       ` Aristeu Rozanski
  2012-10-25 18:30       ` [PATCH v2] " Aristeu Rozanski
  0 siblings, 2 replies; 7+ messages in thread
From: Tejun Heo @ 2012-10-25 17:59 UTC (permalink / raw)
  To: Aristeu Rozanski
  Cc: linux-kernel, Li Zefan, Al Viro, linux-fsdevel, Hugh Dickins

Hello,

On Thu, Oct 25, 2012 at 10:54 AM, Aristeu Rozanski <aris@redhat.com> wrote:
>> So, it returns 0 on success and 1 on failure, which in itself isn't a
>> particularly good idea.
>
> you mean it should return -ENODATA instead?

Yeap, this is a bug, right?  We end up passing that 1 to the set_xattr caller.

-- 
tejun

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH] fs: xattr: rewrite simple_xattr_set()
  2012-10-25 17:59     ` Tejun Heo
@ 2012-10-25 18:12       ` Aristeu Rozanski
  2012-10-25 18:30       ` [PATCH v2] " Aristeu Rozanski
  1 sibling, 0 replies; 7+ messages in thread
From: Aristeu Rozanski @ 2012-10-25 18:12 UTC (permalink / raw)
  To: Tejun Heo; +Cc: linux-kernel, Li Zefan, Al Viro, linux-fsdevel, Hugh Dickins

On Thu, Oct 25, 2012 at 10:59:35AM -0700, Tejun Heo wrote:
> On Thu, Oct 25, 2012 at 10:54 AM, Aristeu Rozanski <aris@redhat.com> wrote:
> >> So, it returns 0 on success and 1 on failure, which in itself isn't a
> >> particularly good idea.
> >
> > you mean it should return -ENODATA instead?
> 
> Yeap, this is a bug, right?  We end up passing that 1 to the set_xattr caller.

yes, will resubmit

Thanks!

-- 
Aristeu

^ permalink raw reply	[flat|nested] 7+ messages in thread

* [PATCH v2] fs: xattr: rewrite simple_xattr_set()
  2012-10-25 17:59     ` Tejun Heo
  2012-10-25 18:12       ` Aristeu Rozanski
@ 2012-10-25 18:30       ` Aristeu Rozanski
  2012-10-31 21:11         ` Tejun Heo
  1 sibling, 1 reply; 7+ messages in thread
From: Aristeu Rozanski @ 2012-10-25 18:30 UTC (permalink / raw)
  To: Tejun Heo; +Cc: linux-kernel, Li Zefan, Al Viro, linux-fsdevel, Hugh Dickins

The way this function was written is confusing and already caused problems.
Rewriting it to be easier to understand and maintain.

v2:
- fix error return value in __simple_xattr_remove() (pointed by Tejun Heo)

Cc: Hugh Dickins <hughd@google.com>
Cc: Tejun Heo <tj@kernel.org>
Cc: Li Zefan <lizefan@huawei.com>
Cc: Al Viro <viro@ZenIV.linux.org.uk>
Signed-off-by: Aristeu Rozanski <aris@redhat.com>

---
 fs/xattr.c |  124 +++++++++++++++++++++++++++++++++++++------------------------
 1 file changed, 76 insertions(+), 48 deletions(-)

Index: github/fs/xattr.c
===================================================================
--- github.orig/fs/xattr.c	2012-10-23 16:02:41.155857391 -0400
+++ github/fs/xattr.c	2012-10-25 11:17:15.118197552 -0400
@@ -842,55 +842,46 @@
 	return ret;
 }
 
-static int __simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
-			      const void *value, size_t size, int flags)
+static struct simple_xattr *__find_xattr(struct simple_xattrs *xattrs,
+					 const char *name)
 {
 	struct simple_xattr *xattr;
-	struct simple_xattr *new_xattr = NULL;
-	int err = 0;
-
-	/* value == NULL means remove */
-	if (value) {
-		new_xattr = simple_xattr_alloc(value, size);
-		if (!new_xattr)
-			return -ENOMEM;
-
-		new_xattr->name = kstrdup(name, GFP_KERNEL);
-		if (!new_xattr->name) {
-			kfree(new_xattr);
-			return -ENOMEM;
-		}
-	}
 
-	spin_lock(&xattrs->lock);
 	list_for_each_entry(xattr, &xattrs->head, list) {
-		if (!strcmp(name, xattr->name)) {
-			if (flags & XATTR_CREATE) {
-				xattr = new_xattr;
-				err = -EEXIST;
-			} else if (new_xattr) {
-				list_replace(&xattr->list, &new_xattr->list);
-			} else {
-				list_del(&xattr->list);
-			}
-			goto out;
-		}
+		if (!strcmp(name, xattr->name))
+			return xattr;
 	}
-	if (flags & XATTR_REPLACE) {
-		xattr = new_xattr;
-		err = -ENODATA;
-	} else {
-		list_add(&new_xattr->list, &xattrs->head);
-		xattr = NULL;
-	}
-out:
-	spin_unlock(&xattrs->lock);
+	return NULL;
+}
+
+static int __simple_xattr_remove(struct simple_xattrs *xattrs,
+				 const char *name)
+{
+	struct simple_xattr *xattr;
+
+	xattr = __find_xattr(xattrs, name);
 	if (xattr) {
+		list_del(&xattr->list);
 		kfree(xattr->name);
 		kfree(xattr);
+		return 0;
 	}
-	return err;
 
+	return -ENODATA;
+}
+
+/*
+ * xattr REMOVE operation for in-memory/pseudo filesystems
+ */
+int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name)
+{
+	int rc;
+
+	spin_lock(&xattrs->lock);
+	rc = __simple_xattr_remove(xattrs, name);
+	spin_unlock(&xattrs->lock);
+
+	return rc;
 }
 
 /**
@@ -910,17 +901,54 @@
 int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
 		     const void *value, size_t size, int flags)
 {
+	struct simple_xattr *found, *new_xattr;
+	int err = 0;
+
 	if (size == 0)
-		value = ""; /* empty EA, do not remove */
-	return __simple_xattr_set(xattrs, name, value, size, flags);
-}
+		value = ""; /* empty EA */
 
-/*
- * xattr REMOVE operation for in-memory/pseudo filesystems
- */
-int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name)
-{
-	return __simple_xattr_set(xattrs, name, NULL, 0, XATTR_REPLACE);
+	/* if value == NULL is specified, remove the item */
+	if (value == NULL)
+		return simple_xattr_remove(xattrs, name);
+
+	new_xattr = simple_xattr_alloc(value, size);
+	if (!new_xattr)
+		return -ENOMEM;
+
+	new_xattr->name = kstrdup(name, GFP_KERNEL);
+	if (!new_xattr->name) {
+		kfree(new_xattr);
+		return -ENOMEM;
+	}
+
+	spin_lock(&xattrs->lock);
+
+	found = __find_xattr(xattrs, name);
+	if (found) {
+		if (flags & XATTR_CREATE) {
+			err = -EEXIST;
+			goto free_new;
+		}
+
+		list_replace(&found->list, &new_xattr->list);
+		kfree(found->name);
+		kfree(found);
+	} else {
+		if (flags & XATTR_REPLACE) {
+			err = -ENODATA;
+			goto free_new;
+		}
+
+		list_add_tail(&new_xattr->list, &xattrs->head);
+	}
+
+out:
+	spin_unlock(&xattrs->lock);
+	return err;
+free_new:
+	kfree(new_xattr->name);
+	kfree(new_xattr);
+	goto out;
 }
 
 static bool xattr_is_trusted(const char *name)

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH v2] fs: xattr: rewrite simple_xattr_set()
  2012-10-25 18:30       ` [PATCH v2] " Aristeu Rozanski
@ 2012-10-31 21:11         ` Tejun Heo
  0 siblings, 0 replies; 7+ messages in thread
From: Tejun Heo @ 2012-10-31 21:11 UTC (permalink / raw)
  To: Aristeu Rozanski
  Cc: linux-kernel, Li Zefan, Al Viro, linux-fsdevel, Hugh Dickins

Hello, sorry about the delay.

Just one nitpick.

On Thu, Oct 25, 2012 at 02:30:18PM -0400, Aristeu Rozanski wrote:
> +static int __simple_xattr_remove(struct simple_xattrs *xattrs,
> +				 const char *name)
> +{
> +	struct simple_xattr *xattr;
> +
> +	xattr = __find_xattr(xattrs, name);
>  	if (xattr) {
> +		list_del(&xattr->list);
>  		kfree(xattr->name);
>  		kfree(xattr);
> +		return 0;
>  	}
> -	return err;
>  
> +	return -ENODATA;
> +}
> +
> +/*
> + * xattr REMOVE operation for in-memory/pseudo filesystems
> + */
> +int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name)
> +{
> +	int rc;
> +
> +	spin_lock(&xattrs->lock);
> +	rc = __simple_xattr_remove(xattrs, name);
> +	spin_unlock(&xattrs->lock);
> +
> +	return rc;

Do we need these two functions?  Can't you either collapse
__simple_xttar_remove() into simple_xattr_remove() or just call
__simple_xattr_remove() directly from simple_xattr_set() with locking
handled there?  Also, why doesn't simple_xattr_remove() have static?

Thanks.

-- 
tejun

^ permalink raw reply	[flat|nested] 7+ messages in thread

end of thread, other threads:[~2012-10-31 21:11 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-10-25 15:26 [PATCH] fs: xattr: rewrite simple_xattr_set() Aristeu Rozanski
2012-10-25 17:33 ` Tejun Heo
2012-10-25 17:54   ` Aristeu Rozanski
2012-10-25 17:59     ` Tejun Heo
2012-10-25 18:12       ` Aristeu Rozanski
2012-10-25 18:30       ` [PATCH v2] " Aristeu Rozanski
2012-10-31 21:11         ` Tejun Heo

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).