public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH] improve comment describing fget_light
@ 2009-02-23 22:02 Tony Battersby
  0 siblings, 0 replies; only message in thread
From: Tony Battersby @ 2009-02-23 22:02 UTC (permalink / raw)
  To: linux-kernel, linux-fsdevel, Andrew Morton

Improve the description of fget_light, which is currently incorrect
about needing a prior refcnt (judging by the way it is actually used).

Signed-off-by: Tony Battersby <tonyb@cybernetics.com>
---
diff -urpN a/fs/file_table.c b/fs/file_table.c
--- a/fs/file_table.c	2009-02-23 12:38:10.000000000 -0500
+++ b/fs/file_table.c	2009-02-23 16:45:51.000000000 -0500
@@ -315,11 +315,20 @@ struct file *fget(unsigned int fd)
 EXPORT_SYMBOL(fget);
 
 /*
- * Lightweight file lookup - no refcnt increment if fd table isn't shared. 
- * You can use this only if it is guranteed that the current task already 
- * holds a refcnt to that file. That check has to be done at fget() only
- * and a flag is returned to be passed to the corresponding fput_light().
- * There must not be a cloning between an fget_light/fput_light pair.
+ * Lightweight file lookup - no refcnt increment if fd table isn't shared.
+ *
+ * You can use this instead of fget if you satisfy all of the following
+ * conditions:
+ * 1) You must call fput_light before exiting the syscall and returning control
+ *    to userspace (i.e. you cannot remember the returned struct file * after
+ *    returning to userspace).
+ * 2) You must not call filp_close on the returned struct file * in between
+ *    calls to fget_light and fput_light.
+ * 3) You must not clone the current task in between the calls to fget_light
+ *    and fput_light.
+ *
+ * The fput_needed flag returned by fget_light should be passed to the
+ * corresponding fput_light.
  */
 struct file *fget_light(unsigned int fd, int *fput_needed)
 {



^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2009-02-23 22:02 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-02-23 22:02 [PATCH] improve comment describing fget_light Tony Battersby

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox