fs: add fget_many() and fput_many()

axboe · axboe · commit 091141a42e15 · 2019-02-28T08:24:23.000-07:00
Some uses cases repeatedly get and put references to the same file, but
the only exposed interface is doing these one at the time. As each of
these entail an atomic inc or dec on a shared structure, that cost can
add up.

Add fget_many(), which works just like fget(), except it takes an
argument for how many references to get on the file. Ditto fput_many(),
which can drop an arbitrary number of references to a file.

Reviewed-by: Hannes Reinecke &lt;hare@suse.com&gt;
Reviewed-by: Christoph Hellwig &lt;hch@lst.de&gt;
Signed-off-by: Jens Axboe &lt;axboe@kernel.dk&gt;
diff --git a/fs/file.c b/fs/file.c
@@ -705,7 +705,7 @@ void do_close_on_exec(struct files_struct *files)
 	spin_unlock(&files->file_lock);
 }
 
-static struct file *__fget(unsigned int fd, fmode_t mask)
+static struct file *__fget(unsigned int fd, fmode_t mask, unsigned int refs)
 {
 	struct files_struct *files = current->files;
 	struct file *file;
@@ -720,23 +720,28 @@ static struct file *__fget(unsigned int fd, fmode_t mask)
 		 */
 		if (file->f_mode & mask)
 			file = NULL;
-		else if (!get_file_rcu(file))
+		else if (!get_file_rcu_many(file, refs))
 			goto loop;
 	}
 	rcu_read_unlock();
 
 	return file;
 }
 
+struct file *fget_many(unsigned int fd, unsigned int refs)
+{
+	return __fget(fd, FMODE_PATH, refs);
+}
+
 struct file *fget(unsigned int fd)
 {
-	return __fget(fd, FMODE_PATH);
+	return __fget(fd, FMODE_PATH, 1);
 }
 EXPORT_SYMBOL(fget);
 
 struct file *fget_raw(unsigned int fd)
 {
-	return __fget(fd, 0);
+	return __fget(fd, 0, 1);
 }
 EXPORT_SYMBOL(fget_raw);
 
@@ -767,7 +772,7 @@ static unsigned long __fget_light(unsigned int fd, fmode_t mask)
 			return 0;
 		return (unsigned long)file;
 	} else {
-		file = __fget(fd, mask);
+		file = __fget(fd, mask, 1);
 		if (!file)
 			return 0;
 		return FDPUT_FPUT | (unsigned long)file;
diff --git a/fs/file_table.c b/fs/file_table.c
@@ -326,9 +326,9 @@ void flush_delayed_fput(void)
 
 static DECLARE_DELAYED_WORK(delayed_fput_work, delayed_fput);
 
-void fput(struct file *file)
+void fput_many(struct file *file, unsigned int refs)
 {
-	if (atomic_long_dec_and_test(&file->f_count)) {
+	if (atomic_long_sub_and_test(refs, &file->f_count)) {
 		struct task_struct *task = current;
 
 		if (likely(!in_interrupt() && !(task->flags & PF_KTHREAD))) {
@@ -347,6 +347,11 @@ void fput(struct file *file)
 	}
 }
 
+void fput(struct file *file)
+{
+	fput_many(file, 1);
+}
+
 /*
  * synchronous analog of fput(); for kernel threads that might be needed
  * in some umount() (and thus can't use flush_delayed_fput() without
diff --git a/include/linux/file.h b/include/linux/file.h
@@ -13,6 +13,7 @@
 struct file;
 
 extern void fput(struct file *);
+extern void fput_many(struct file *, unsigned int);
 
 struct file_operations;
 struct vfsmount;
@@ -44,6 +45,7 @@ static inline void fdput(struct fd fd)
 }
 
 extern struct file *fget(unsigned int fd);
+extern struct file *fget_many(unsigned int fd, unsigned int refs);
 extern struct file *fget_raw(unsigned int fd);
 extern unsigned long __fdget(unsigned int fd);
 extern unsigned long __fdget_raw(unsigned int fd);
diff --git a/include/linux/fs.h b/include/linux/fs.h
@@ -952,7 +952,9 @@ static inline struct file *get_file(struct file *f)
 	atomic_long_inc(&f->f_count);
 	return f;
 }
-#define get_file_rcu(x) atomic_long_inc_not_zero(&(x)->f_count)
+#define get_file_rcu_many(x, cnt)	\
+	atomic_long_add_unless(&(x)->f_count, (cnt), 0)
+#define get_file_rcu(x) get_file_rcu_many((x), 1)
 #define fput_atomic(x)	atomic_long_add_unless(&(x)->f_count, -1, 1)
 #define file_count(x)	atomic_long_read(&(x)->f_count)
 

Original file line number	Diff line number	Diff line change
`@@ -705,7 +705,7 @@ void do_close_on_exec(struct files_struct *files)`
`705`	`705`	`spin_unlock(&files->file_lock);`
`706`	`706`	`}`
`707`	`707`
`708`		`-static struct file *__fget(unsigned int fd, fmode_t mask)`
	`708`	`+static struct file *__fget(unsigned int fd, fmode_t mask, unsigned int refs)`
`709`	`709`	`{`
`710`	`710`	`struct files_struct *files = current->files;`
`711`	`711`	`struct file *file;`
`@@ -720,23 +720,28 @@ static struct file *__fget(unsigned int fd, fmode_t mask)`
`720`	`720`	`*/`
`721`	`721`	`if (file->f_mode & mask)`
`722`	`722`	`file = NULL;`
`723`		`- else if (!get_file_rcu(file))`
	`723`	`+ else if (!get_file_rcu_many(file, refs))`
`724`	`724`	`goto loop;`
`725`	`725`	`}`
`726`	`726`	`rcu_read_unlock();`
`727`	`727`
`728`	`728`	`return file;`
`729`	`729`	`}`
`730`	`730`
	`731`	`+struct file *fget_many(unsigned int fd, unsigned int refs)`
	`732`	`+{`
	`733`	`+ return __fget(fd, FMODE_PATH, refs);`
	`734`	`+}`
	`735`	`+`
`731`	`736`	`struct file *fget(unsigned int fd)`
`732`	`737`	`{`
`733`		`- return __fget(fd, FMODE_PATH);`
	`738`	`+ return __fget(fd, FMODE_PATH, 1);`
`734`	`739`	`}`
`735`	`740`	`EXPORT_SYMBOL(fget);`
`736`	`741`
`737`	`742`	`struct file *fget_raw(unsigned int fd)`
`738`	`743`	`{`
`739`		`- return __fget(fd, 0);`
	`744`	`+ return __fget(fd, 0, 1);`
`740`	`745`	`}`
`741`	`746`	`EXPORT_SYMBOL(fget_raw);`
`742`	`747`
`@@ -767,7 +772,7 @@ static unsigned long __fget_light(unsigned int fd, fmode_t mask)`
`767`	`772`	`return 0;`
`768`	`773`	`return (unsigned long)file;`
`769`	`774`	`} else {`
`770`		`- file = __fget(fd, mask);`
	`775`	`+ file = __fget(fd, mask, 1);`
`771`	`776`	`if (!file)`
`772`	`777`	`return 0;`
`773`	`778`	`return FDPUT_FPUT \| (unsigned long)file;`
Original file line number	Diff line number	Diff line change
`@@ -326,9 +326,9 @@ void flush_delayed_fput(void)`
`326`	`326`
`327`	`327`	`static DECLARE_DELAYED_WORK(delayed_fput_work, delayed_fput);`
`328`	`328`
`329`		`-void fput(struct file *file)`
	`329`	`+void fput_many(struct file *file, unsigned int refs)`
`330`	`330`	`{`
`331`		`- if (atomic_long_dec_and_test(&file->f_count)) {`
	`331`	`+ if (atomic_long_sub_and_test(refs, &file->f_count)) {`
`332`	`332`	`struct task_struct *task = current;`
`333`	`333`
`334`	`334`	`if (likely(!in_interrupt() && !(task->flags & PF_KTHREAD))) {`
`@@ -347,6 +347,11 @@ void fput(struct file *file)`
`347`	`347`	`}`
`348`	`348`	`}`
`349`	`349`
	`350`	`+void fput(struct file *file)`
	`351`	`+{`
	`352`	`+ fput_many(file, 1);`
	`353`	`+}`
	`354`	`+`
`350`	`355`	`/*`
`351`	`356`	`* synchronous analog of fput(); for kernel threads that might be needed`
`352`	`357`	`* in some umount() (and thus can't use flush_delayed_fput() without`