blob: 86dc9956af32cc7c58a7fef7ca31b6fb316610b7 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/fs/file.c
4 *
5 * Copyright (C) 1998-1999, Stephen Tweedie and Bill Hawes
6 *
7 * Manage the dynamic fd arrays in the process files_struct.
8 */
9
Al Virofe17f222012-08-21 11:48:11 -040010#include <linux/syscalls.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050011#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/fs.h>
Christian Brauner278a5fb2019-05-24 11:30:34 +020013#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/mm.h>
Ingo Molnar3f07c012017-02-08 18:51:30 +010015#include <linux/sched/signal.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/file.h>
Al Viro9f3acc32008-04-24 07:44:08 -040018#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/bitops.h>
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070020#include <linux/spinlock.h>
21#include <linux/rcupdate.h>
Christian Brauner60997c32020-06-03 21:48:55 +020022#include <linux/close_range.h>
Kees Cook66590612020-06-10 08:20:05 -070023#include <net/sock.h>
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070024
Jens Axboe53dec2e2021-01-19 15:41:52 -070025#include "internal.h"
26
Alexey Dobriyan9b80a182016-09-02 00:38:52 +030027unsigned int sysctl_nr_open __read_mostly = 1024*1024;
28unsigned int sysctl_nr_open_min = BITS_PER_LONG;
Rasmus Villemoes752343b2015-10-29 12:01:41 +010029/* our min() is unusable in constant expressions ;-/ */
30#define __const_min(x, y) ((x) < (y) ? (x) : (y))
Alexey Dobriyan9b80a182016-09-02 00:38:52 +030031unsigned int sysctl_nr_open_max =
32 __const_min(INT_MAX, ~(size_t)0/sizeof(void *)) & -BITS_PER_LONG;
Eric Dumazet9cfe0152008-02-06 01:37:16 -080033
Changli Gaoa892e2d2010-08-10 18:01:35 -070034static void __free_fdtable(struct fdtable *fdt)
Vadim Lobanov5466b452006-12-10 02:21:22 -080035{
Al Virof6c0a192014-04-23 10:18:46 -040036 kvfree(fdt->fd);
37 kvfree(fdt->open_fds);
Changli Gaoa892e2d2010-08-10 18:01:35 -070038 kfree(fdt);
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070039}
40
Al Viro7cf4dc32012-08-15 19:56:12 -040041static void free_fdtable_rcu(struct rcu_head *rcu)
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070042{
Al Viroac3e3c52013-04-28 21:42:33 -040043 __free_fdtable(container_of(rcu, struct fdtable, rcu));
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070044}
45
Linus Torvaldsf3f86e32015-10-30 16:53:57 -070046#define BITBIT_NR(nr) BITS_TO_LONGS(BITS_TO_LONGS(nr))
47#define BITBIT_SIZE(nr) (BITBIT_NR(nr) * sizeof(long))
48
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070049/*
Eric Biggersea5c58e2015-11-06 00:32:04 -060050 * Copy 'count' fd bits from the old table to the new table and clear the extra
51 * space if any. This does not copy the file pointers. Called with the files
52 * spinlock held for write.
53 */
54static void copy_fd_bitmaps(struct fdtable *nfdt, struct fdtable *ofdt,
55 unsigned int count)
56{
57 unsigned int cpy, set;
58
59 cpy = count / BITS_PER_BYTE;
60 set = (nfdt->max_fds - count) / BITS_PER_BYTE;
61 memcpy(nfdt->open_fds, ofdt->open_fds, cpy);
62 memset((char *)nfdt->open_fds + cpy, 0, set);
63 memcpy(nfdt->close_on_exec, ofdt->close_on_exec, cpy);
64 memset((char *)nfdt->close_on_exec + cpy, 0, set);
65
66 cpy = BITBIT_SIZE(count);
67 set = BITBIT_SIZE(nfdt->max_fds) - cpy;
68 memcpy(nfdt->full_fds_bits, ofdt->full_fds_bits, cpy);
69 memset((char *)nfdt->full_fds_bits + cpy, 0, set);
70}
71
72/*
73 * Copy all file descriptors from the old table to the new, expanded table and
74 * clear the extra space. Called with the files spinlock held for write.
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070075 */
Vadim Lobanov5466b452006-12-10 02:21:22 -080076static void copy_fdtable(struct fdtable *nfdt, struct fdtable *ofdt)
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070077{
Al Viro4e89b722020-05-19 17:48:52 -040078 size_t cpy, set;
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070079
Vadim Lobanov5466b452006-12-10 02:21:22 -080080 BUG_ON(nfdt->max_fds < ofdt->max_fds);
Vadim Lobanov5466b452006-12-10 02:21:22 -080081
82 cpy = ofdt->max_fds * sizeof(struct file *);
83 set = (nfdt->max_fds - ofdt->max_fds) * sizeof(struct file *);
84 memcpy(nfdt->fd, ofdt->fd, cpy);
Eric Biggersea5c58e2015-11-06 00:32:04 -060085 memset((char *)nfdt->fd + cpy, 0, set);
Vadim Lobanov5466b452006-12-10 02:21:22 -080086
Eric Biggersea5c58e2015-11-06 00:32:04 -060087 copy_fd_bitmaps(nfdt, ofdt, ofdt->max_fds);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088}
89
Vadim Lobanov5466b452006-12-10 02:21:22 -080090static struct fdtable * alloc_fdtable(unsigned int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091{
Vadim Lobanov5466b452006-12-10 02:21:22 -080092 struct fdtable *fdt;
David Howells1fd36ad2012-02-16 17:49:54 +000093 void *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070095 /*
Vadim Lobanov5466b452006-12-10 02:21:22 -080096 * Figure out how many fds we actually want to support in this fdtable.
97 * Allocation steps are keyed to the size of the fdarray, since it
98 * grows far faster than any of the other dynamic data. We try to fit
99 * the fdarray into comfortable page-tuned chunks: starting at 1024B
100 * and growing in powers of two from there on.
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -0700101 */
Vadim Lobanov5466b452006-12-10 02:21:22 -0800102 nr /= (1024 / sizeof(struct file *));
103 nr = roundup_pow_of_two(nr + 1);
104 nr *= (1024 / sizeof(struct file *));
Al Viro5c598b32008-04-27 20:04:15 -0400105 /*
106 * Note that this can drive nr *below* what we had passed if sysctl_nr_open
107 * had been set lower between the check in expand_files() and here. Deal
108 * with that in caller, it's cheaper that way.
109 *
110 * We make sure that nr remains a multiple of BITS_PER_LONG - otherwise
111 * bitmaps handling below becomes unpleasant, to put it mildly...
112 */
113 if (unlikely(nr > sysctl_nr_open))
114 nr = ((sysctl_nr_open - 1) | (BITS_PER_LONG - 1)) + 1;
Vadim Lobanovbbea9f62006-12-10 02:21:12 -0800115
Vladimir Davydov5d097052016-01-14 15:18:21 -0800116 fdt = kmalloc(sizeof(struct fdtable), GFP_KERNEL_ACCOUNT);
Vadim Lobanov5466b452006-12-10 02:21:22 -0800117 if (!fdt)
Vadim Lobanovbbea9f62006-12-10 02:21:12 -0800118 goto out;
Vadim Lobanov5466b452006-12-10 02:21:22 -0800119 fdt->max_fds = nr;
Michal Hockoc823bd92017-07-06 15:36:19 -0700120 data = kvmalloc_array(nr, sizeof(struct file *), GFP_KERNEL_ACCOUNT);
Vadim Lobanov5466b452006-12-10 02:21:22 -0800121 if (!data)
122 goto out_fdt;
David Howells1fd36ad2012-02-16 17:49:54 +0000123 fdt->fd = data;
124
Michal Hockoc823bd92017-07-06 15:36:19 -0700125 data = kvmalloc(max_t(size_t,
126 2 * nr / BITS_PER_BYTE + BITBIT_SIZE(nr), L1_CACHE_BYTES),
127 GFP_KERNEL_ACCOUNT);
Vadim Lobanov5466b452006-12-10 02:21:22 -0800128 if (!data)
129 goto out_arr;
David Howells1fd36ad2012-02-16 17:49:54 +0000130 fdt->open_fds = data;
Vadim Lobanov5466b452006-12-10 02:21:22 -0800131 data += nr / BITS_PER_BYTE;
David Howells1fd36ad2012-02-16 17:49:54 +0000132 fdt->close_on_exec = data;
Linus Torvaldsf3f86e32015-10-30 16:53:57 -0700133 data += nr / BITS_PER_BYTE;
134 fdt->full_fds_bits = data;
Vadim Lobanov5466b452006-12-10 02:21:22 -0800135
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -0700136 return fdt;
Vadim Lobanov5466b452006-12-10 02:21:22 -0800137
138out_arr:
Al Virof6c0a192014-04-23 10:18:46 -0400139 kvfree(fdt->fd);
Vadim Lobanov5466b452006-12-10 02:21:22 -0800140out_fdt:
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -0700141 kfree(fdt);
Vadim Lobanov5466b452006-12-10 02:21:22 -0800142out:
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -0700143 return NULL;
144}
145
146/*
Vadim Lobanov74d392a2006-09-29 02:01:43 -0700147 * Expand the file descriptor table.
148 * This function will allocate a new fdtable and both fd array and fdset, of
149 * the given size.
150 * Return <0 error code on error; 1 on successful completion.
151 * The files->file_lock should be held on entry, and will be held on exit.
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -0700152 */
Alexey Dobriyan9b80a182016-09-02 00:38:52 +0300153static int expand_fdtable(struct files_struct *files, unsigned int nr)
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -0700154 __releases(files->file_lock)
155 __acquires(files->file_lock)
156{
Vadim Lobanov74d392a2006-09-29 02:01:43 -0700157 struct fdtable *new_fdt, *cur_fdt;
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -0700158
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 spin_unlock(&files->file_lock);
Vadim Lobanov74d392a2006-09-29 02:01:43 -0700160 new_fdt = alloc_fdtable(nr);
Eric Dumazet8a812522015-06-30 15:54:08 +0200161
Eric W. Biedermand74ba042020-11-20 17:14:35 -0600162 /* make sure all fd_install() have seen resize_in_progress
Eric Dumazet8a812522015-06-30 15:54:08 +0200163 * or have finished their rcu_read_lock_sched() section.
164 */
165 if (atomic_read(&files->count) > 1)
Paul E. McKenneyc93ffc12018-11-05 17:31:31 -0800166 synchronize_rcu();
Eric Dumazet8a812522015-06-30 15:54:08 +0200167
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 spin_lock(&files->file_lock);
Vadim Lobanov74d392a2006-09-29 02:01:43 -0700169 if (!new_fdt)
170 return -ENOMEM;
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -0700171 /*
Al Viro5c598b32008-04-27 20:04:15 -0400172 * extremely unlikely race - sysctl_nr_open decreased between the check in
173 * caller and alloc_fdtable(). Cheaper to catch it here...
174 */
175 if (unlikely(new_fdt->max_fds <= nr)) {
Changli Gaoa892e2d2010-08-10 18:01:35 -0700176 __free_fdtable(new_fdt);
Al Viro5c598b32008-04-27 20:04:15 -0400177 return -EMFILE;
178 }
Vadim Lobanov74d392a2006-09-29 02:01:43 -0700179 cur_fdt = files_fdtable(files);
Eric Dumazet8a812522015-06-30 15:54:08 +0200180 BUG_ON(nr < cur_fdt->max_fds);
181 copy_fdtable(new_fdt, cur_fdt);
182 rcu_assign_pointer(files->fdt, new_fdt);
183 if (cur_fdt != &files->fdtab)
184 call_rcu(&cur_fdt->rcu, free_fdtable_rcu);
Eric W. Biedermand74ba042020-11-20 17:14:35 -0600185 /* coupled with smp_rmb() in fd_install() */
Eric Dumazet8a812522015-06-30 15:54:08 +0200186 smp_wmb();
Vadim Lobanov74d392a2006-09-29 02:01:43 -0700187 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188}
189
190/*
191 * Expand files.
Vadim Lobanov74d392a2006-09-29 02:01:43 -0700192 * This function will expand the file structures, if the requested size exceeds
193 * the current capacity and there is room for expansion.
194 * Return <0 error code on error; 0 when nothing done; 1 when files were
195 * expanded and execution may have blocked.
196 * The files->file_lock should be held on entry, and will be held on exit.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 */
Alexey Dobriyan9b80a182016-09-02 00:38:52 +0300198static int expand_files(struct files_struct *files, unsigned int nr)
Eric Dumazet8a812522015-06-30 15:54:08 +0200199 __releases(files->file_lock)
200 __acquires(files->file_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201{
Dipankar Sarmabadf1662005-09-09 13:04:10 -0700202 struct fdtable *fdt;
Eric Dumazet8a812522015-06-30 15:54:08 +0200203 int expanded = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Eric Dumazet8a812522015-06-30 15:54:08 +0200205repeat:
Dipankar Sarmabadf1662005-09-09 13:04:10 -0700206 fdt = files_fdtable(files);
Al Viro4e1e0182008-07-26 16:01:20 -0400207
Vadim Lobanov74d392a2006-09-29 02:01:43 -0700208 /* Do we need to expand? */
Vadim Lobanovbbea9f62006-12-10 02:21:12 -0800209 if (nr < fdt->max_fds)
Eric Dumazet8a812522015-06-30 15:54:08 +0200210 return expanded;
Al Viro4e1e0182008-07-26 16:01:20 -0400211
Vadim Lobanov74d392a2006-09-29 02:01:43 -0700212 /* Can we expand? */
Eric Dumazet9cfe0152008-02-06 01:37:16 -0800213 if (nr >= sysctl_nr_open)
Vadim Lobanov74d392a2006-09-29 02:01:43 -0700214 return -EMFILE;
215
Eric Dumazet8a812522015-06-30 15:54:08 +0200216 if (unlikely(files->resize_in_progress)) {
217 spin_unlock(&files->file_lock);
218 expanded = 1;
219 wait_event(files->resize_wait, !files->resize_in_progress);
220 spin_lock(&files->file_lock);
221 goto repeat;
222 }
223
Vadim Lobanov74d392a2006-09-29 02:01:43 -0700224 /* All good, so we try */
Eric Dumazet8a812522015-06-30 15:54:08 +0200225 files->resize_in_progress = true;
226 expanded = expand_fdtable(files, nr);
227 files->resize_in_progress = false;
228
229 wake_up_all(&files->resize_wait);
230 return expanded;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231}
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -0700232
Alexey Dobriyan9b80a182016-09-02 00:38:52 +0300233static inline void __set_close_on_exec(unsigned int fd, struct fdtable *fdt)
Al Virob8318b02012-08-21 20:09:42 -0400234{
235 __set_bit(fd, fdt->close_on_exec);
236}
237
Alexey Dobriyan9b80a182016-09-02 00:38:52 +0300238static inline void __clear_close_on_exec(unsigned int fd, struct fdtable *fdt)
Al Virob8318b02012-08-21 20:09:42 -0400239{
Linus Torvaldsfc908882015-10-31 16:06:40 -0700240 if (test_bit(fd, fdt->close_on_exec))
241 __clear_bit(fd, fdt->close_on_exec);
Al Virob8318b02012-08-21 20:09:42 -0400242}
243
Linus Torvaldsf3f86e32015-10-30 16:53:57 -0700244static inline void __set_open_fd(unsigned int fd, struct fdtable *fdt)
Al Virob8318b02012-08-21 20:09:42 -0400245{
246 __set_bit(fd, fdt->open_fds);
Linus Torvaldsf3f86e32015-10-30 16:53:57 -0700247 fd /= BITS_PER_LONG;
248 if (!~fdt->open_fds[fd])
249 __set_bit(fd, fdt->full_fds_bits);
Al Virob8318b02012-08-21 20:09:42 -0400250}
251
Linus Torvaldsf3f86e32015-10-30 16:53:57 -0700252static inline void __clear_open_fd(unsigned int fd, struct fdtable *fdt)
Al Virob8318b02012-08-21 20:09:42 -0400253{
254 __clear_bit(fd, fdt->open_fds);
Linus Torvaldsf3f86e32015-10-30 16:53:57 -0700255 __clear_bit(fd / BITS_PER_LONG, fdt->full_fds_bits);
Al Virob8318b02012-08-21 20:09:42 -0400256}
257
Alexey Dobriyan9b80a182016-09-02 00:38:52 +0300258static unsigned int count_open_files(struct fdtable *fdt)
Al Viro02afc6262008-05-08 19:42:56 -0400259{
Alexey Dobriyan9b80a182016-09-02 00:38:52 +0300260 unsigned int size = fdt->max_fds;
261 unsigned int i;
Al Viro02afc6262008-05-08 19:42:56 -0400262
263 /* Find the last open fd */
David Howells1fd36ad2012-02-16 17:49:54 +0000264 for (i = size / BITS_PER_LONG; i > 0; ) {
265 if (fdt->open_fds[--i])
Al Viro02afc6262008-05-08 19:42:56 -0400266 break;
267 }
David Howells1fd36ad2012-02-16 17:49:54 +0000268 i = (i + 1) * BITS_PER_LONG;
Al Viro02afc6262008-05-08 19:42:56 -0400269 return i;
270}
271
Christian Brauner60997c32020-06-03 21:48:55 +0200272static unsigned int sane_fdtable_size(struct fdtable *fdt, unsigned int max_fds)
273{
274 unsigned int count;
275
276 count = count_open_files(fdt);
277 if (max_fds < NR_OPEN_DEFAULT)
278 max_fds = NR_OPEN_DEFAULT;
279 return min(count, max_fds);
280}
281
Al Viro02afc6262008-05-08 19:42:56 -0400282/*
283 * Allocate a new files structure and copy contents from the
284 * passed in files structure.
285 * errorp will be valid only when the returned files_struct is NULL.
286 */
Christian Brauner60997c32020-06-03 21:48:55 +0200287struct files_struct *dup_fd(struct files_struct *oldf, unsigned int max_fds, int *errorp)
Al Viro02afc6262008-05-08 19:42:56 -0400288{
289 struct files_struct *newf;
290 struct file **old_fds, **new_fds;
Alexey Dobriyan9b80a182016-09-02 00:38:52 +0300291 unsigned int open_files, i;
Al Viro02afc6262008-05-08 19:42:56 -0400292 struct fdtable *old_fdt, *new_fdt;
293
294 *errorp = -ENOMEM;
Al Viroafbec7f2008-05-08 21:11:17 -0400295 newf = kmem_cache_alloc(files_cachep, GFP_KERNEL);
Al Viro02afc6262008-05-08 19:42:56 -0400296 if (!newf)
297 goto out;
298
Al Viroafbec7f2008-05-08 21:11:17 -0400299 atomic_set(&newf->count, 1);
300
301 spin_lock_init(&newf->file_lock);
Eric Dumazet8a812522015-06-30 15:54:08 +0200302 newf->resize_in_progress = false;
303 init_waitqueue_head(&newf->resize_wait);
Al Viroafbec7f2008-05-08 21:11:17 -0400304 newf->next_fd = 0;
305 new_fdt = &newf->fdtab;
306 new_fdt->max_fds = NR_OPEN_DEFAULT;
David Howells1fd36ad2012-02-16 17:49:54 +0000307 new_fdt->close_on_exec = newf->close_on_exec_init;
308 new_fdt->open_fds = newf->open_fds_init;
Linus Torvaldsf3f86e32015-10-30 16:53:57 -0700309 new_fdt->full_fds_bits = newf->full_fds_bits_init;
Al Viroafbec7f2008-05-08 21:11:17 -0400310 new_fdt->fd = &newf->fd_array[0];
Al Viroafbec7f2008-05-08 21:11:17 -0400311
Al Viro02afc6262008-05-08 19:42:56 -0400312 spin_lock(&oldf->file_lock);
313 old_fdt = files_fdtable(oldf);
Christian Brauner60997c32020-06-03 21:48:55 +0200314 open_files = sane_fdtable_size(old_fdt, max_fds);
Al Viro02afc6262008-05-08 19:42:56 -0400315
316 /*
317 * Check whether we need to allocate a larger fd array and fd set.
Al Viro02afc6262008-05-08 19:42:56 -0400318 */
Al Viroadbecb12008-05-08 21:19:42 -0400319 while (unlikely(open_files > new_fdt->max_fds)) {
Al Viro02afc6262008-05-08 19:42:56 -0400320 spin_unlock(&oldf->file_lock);
Al Viro9dec3c42008-05-08 21:02:45 -0400321
Changli Gaoa892e2d2010-08-10 18:01:35 -0700322 if (new_fdt != &newf->fdtab)
323 __free_fdtable(new_fdt);
Al Viroadbecb12008-05-08 21:19:42 -0400324
Al Viro9dec3c42008-05-08 21:02:45 -0400325 new_fdt = alloc_fdtable(open_files - 1);
326 if (!new_fdt) {
327 *errorp = -ENOMEM;
Al Viro02afc6262008-05-08 19:42:56 -0400328 goto out_release;
Al Viro9dec3c42008-05-08 21:02:45 -0400329 }
330
331 /* beyond sysctl_nr_open; nothing to do */
332 if (unlikely(new_fdt->max_fds < open_files)) {
Changli Gaoa892e2d2010-08-10 18:01:35 -0700333 __free_fdtable(new_fdt);
Al Viro9dec3c42008-05-08 21:02:45 -0400334 *errorp = -EMFILE;
335 goto out_release;
336 }
Al Viro9dec3c42008-05-08 21:02:45 -0400337
Al Viro02afc6262008-05-08 19:42:56 -0400338 /*
339 * Reacquire the oldf lock and a pointer to its fd table
340 * who knows it may have a new bigger fd table. We need
341 * the latest pointer.
342 */
343 spin_lock(&oldf->file_lock);
344 old_fdt = files_fdtable(oldf);
Christian Brauner60997c32020-06-03 21:48:55 +0200345 open_files = sane_fdtable_size(old_fdt, max_fds);
Al Viro02afc6262008-05-08 19:42:56 -0400346 }
347
Eric Biggersea5c58e2015-11-06 00:32:04 -0600348 copy_fd_bitmaps(new_fdt, old_fdt, open_files);
349
Al Viro02afc6262008-05-08 19:42:56 -0400350 old_fds = old_fdt->fd;
351 new_fds = new_fdt->fd;
352
Al Viro02afc6262008-05-08 19:42:56 -0400353 for (i = open_files; i != 0; i--) {
354 struct file *f = *old_fds++;
355 if (f) {
356 get_file(f);
357 } else {
358 /*
359 * The fd may be claimed in the fd bitmap but not yet
360 * instantiated in the files array if a sibling thread
361 * is partway through open(). So make sure that this
362 * fd is available to the new process.
363 */
David Howells1dce27c2012-02-16 17:49:42 +0000364 __clear_open_fd(open_files - i, new_fdt);
Al Viro02afc6262008-05-08 19:42:56 -0400365 }
366 rcu_assign_pointer(*new_fds++, f);
367 }
368 spin_unlock(&oldf->file_lock);
369
Eric Biggersea5c58e2015-11-06 00:32:04 -0600370 /* clear the remainder */
371 memset(new_fds, 0, (new_fdt->max_fds - open_files) * sizeof(struct file *));
Al Viro02afc6262008-05-08 19:42:56 -0400372
Al Viroafbec7f2008-05-08 21:11:17 -0400373 rcu_assign_pointer(newf->fdt, new_fdt);
374
Al Viro02afc6262008-05-08 19:42:56 -0400375 return newf;
376
377out_release:
378 kmem_cache_free(files_cachep, newf);
379out:
380 return NULL;
381}
382
Oleg Nesterovce08b622014-01-11 19:19:53 +0100383static struct fdtable *close_files(struct files_struct * files)
Al Viro7cf4dc32012-08-15 19:56:12 -0400384{
Al Viro7cf4dc32012-08-15 19:56:12 -0400385 /*
386 * It is safe to dereference the fd table without RCU or
387 * ->file_lock because this is the last reference to the
Oleg Nesterovce08b622014-01-11 19:19:53 +0100388 * files structure.
Al Viro7cf4dc32012-08-15 19:56:12 -0400389 */
Oleg Nesterovce08b622014-01-11 19:19:53 +0100390 struct fdtable *fdt = rcu_dereference_raw(files->fdt);
Alexey Dobriyan9b80a182016-09-02 00:38:52 +0300391 unsigned int i, j = 0;
Oleg Nesterovce08b622014-01-11 19:19:53 +0100392
Al Viro7cf4dc32012-08-15 19:56:12 -0400393 for (;;) {
394 unsigned long set;
395 i = j * BITS_PER_LONG;
396 if (i >= fdt->max_fds)
397 break;
398 set = fdt->open_fds[j++];
399 while (set) {
400 if (set & 1) {
401 struct file * file = xchg(&fdt->fd[i], NULL);
402 if (file) {
403 filp_close(file, files);
Paul E. McKenney388a4c82017-10-24 08:39:34 -0700404 cond_resched();
Al Viro7cf4dc32012-08-15 19:56:12 -0400405 }
406 }
407 i++;
408 set >>= 1;
409 }
410 }
Oleg Nesterovce08b622014-01-11 19:19:53 +0100411
412 return fdt;
Al Viro7cf4dc32012-08-15 19:56:12 -0400413}
414
Al Viro7cf4dc32012-08-15 19:56:12 -0400415void put_files_struct(struct files_struct *files)
416{
Al Viro7cf4dc32012-08-15 19:56:12 -0400417 if (atomic_dec_and_test(&files->count)) {
Oleg Nesterovce08b622014-01-11 19:19:53 +0100418 struct fdtable *fdt = close_files(files);
419
Al Virob9e02af2012-08-15 20:00:58 -0400420 /* free the arrays if they are not embedded */
421 if (fdt != &files->fdtab)
422 __free_fdtable(fdt);
423 kmem_cache_free(files_cachep, files);
Al Viro7cf4dc32012-08-15 19:56:12 -0400424 }
425}
426
Al Viro7cf4dc32012-08-15 19:56:12 -0400427void exit_files(struct task_struct *tsk)
428{
429 struct files_struct * files = tsk->files;
430
431 if (files) {
432 task_lock(tsk);
433 tsk->files = NULL;
434 task_unlock(tsk);
435 put_files_struct(files);
436 }
437}
438
Al Virof52111b2008-05-08 18:19:16 -0400439struct files_struct init_files = {
440 .count = ATOMIC_INIT(1),
441 .fdt = &init_files.fdtab,
442 .fdtab = {
443 .max_fds = NR_OPEN_DEFAULT,
444 .fd = &init_files.fd_array[0],
David Howells1fd36ad2012-02-16 17:49:54 +0000445 .close_on_exec = init_files.close_on_exec_init,
446 .open_fds = init_files.open_fds_init,
Linus Torvaldsf3f86e32015-10-30 16:53:57 -0700447 .full_fds_bits = init_files.full_fds_bits_init,
Al Virof52111b2008-05-08 18:19:16 -0400448 },
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200449 .file_lock = __SPIN_LOCK_UNLOCKED(init_files.file_lock),
Shuriyc Chu5704a062019-03-05 15:41:56 -0800450 .resize_wait = __WAIT_QUEUE_HEAD_INITIALIZER(init_files.resize_wait),
Al Virof52111b2008-05-08 18:19:16 -0400451};
Al Viro1027abe2008-07-30 04:13:04 -0400452
Alexey Dobriyan9b80a182016-09-02 00:38:52 +0300453static unsigned int find_next_fd(struct fdtable *fdt, unsigned int start)
Linus Torvaldsf3f86e32015-10-30 16:53:57 -0700454{
Alexey Dobriyan9b80a182016-09-02 00:38:52 +0300455 unsigned int maxfd = fdt->max_fds;
456 unsigned int maxbit = maxfd / BITS_PER_LONG;
457 unsigned int bitbit = start / BITS_PER_LONG;
Linus Torvaldsf3f86e32015-10-30 16:53:57 -0700458
459 bitbit = find_next_zero_bit(fdt->full_fds_bits, maxbit, bitbit) * BITS_PER_LONG;
460 if (bitbit > maxfd)
461 return maxfd;
462 if (bitbit > start)
463 start = bitbit;
464 return find_next_zero_bit(fdt->open_fds, maxfd, start);
465}
466
Al Viro1027abe2008-07-30 04:13:04 -0400467/*
468 * allocate a file descriptor, mark it busy.
469 */
Eric W. Biedermanaa384d12020-11-20 17:14:37 -0600470static int alloc_fd(unsigned start, unsigned end, unsigned flags)
Al Viro1027abe2008-07-30 04:13:04 -0400471{
Eric W. Biedermanaa384d12020-11-20 17:14:37 -0600472 struct files_struct *files = current->files;
Al Viro1027abe2008-07-30 04:13:04 -0400473 unsigned int fd;
474 int error;
475 struct fdtable *fdt;
476
477 spin_lock(&files->file_lock);
478repeat:
479 fdt = files_fdtable(files);
480 fd = start;
481 if (fd < files->next_fd)
482 fd = files->next_fd;
483
484 if (fd < fdt->max_fds)
Linus Torvaldsf3f86e32015-10-30 16:53:57 -0700485 fd = find_next_fd(fdt, fd);
Al Viro1027abe2008-07-30 04:13:04 -0400486
Al Virof33ff992012-08-12 16:17:59 -0400487 /*
488 * N.B. For clone tasks sharing a files structure, this test
489 * will limit the total number of files that can be opened.
490 */
491 error = -EMFILE;
492 if (fd >= end)
493 goto out;
494
Al Viro1027abe2008-07-30 04:13:04 -0400495 error = expand_files(files, fd);
496 if (error < 0)
497 goto out;
498
499 /*
500 * If we needed to expand the fs array we
501 * might have blocked - try again.
502 */
503 if (error)
504 goto repeat;
505
506 if (start <= files->next_fd)
507 files->next_fd = fd + 1;
508
David Howells1dce27c2012-02-16 17:49:42 +0000509 __set_open_fd(fd, fdt);
Al Viro1027abe2008-07-30 04:13:04 -0400510 if (flags & O_CLOEXEC)
David Howells1dce27c2012-02-16 17:49:42 +0000511 __set_close_on_exec(fd, fdt);
Al Viro1027abe2008-07-30 04:13:04 -0400512 else
David Howells1dce27c2012-02-16 17:49:42 +0000513 __clear_close_on_exec(fd, fdt);
Al Viro1027abe2008-07-30 04:13:04 -0400514 error = fd;
515#if 1
516 /* Sanity check */
Paul E. McKenneyadd1f092014-02-12 12:51:09 -0800517 if (rcu_access_pointer(fdt->fd[fd]) != NULL) {
Al Viro1027abe2008-07-30 04:13:04 -0400518 printk(KERN_WARNING "alloc_fd: slot %d not NULL!\n", fd);
519 rcu_assign_pointer(fdt->fd[fd], NULL);
520 }
521#endif
522
523out:
524 spin_unlock(&files->file_lock);
525 return error;
526}
527
Jens Axboe4022e7a2020-03-19 19:23:18 -0600528int __get_unused_fd_flags(unsigned flags, unsigned long nofile)
529{
Eric W. Biedermanaa384d12020-11-20 17:14:37 -0600530 return alloc_fd(0, nofile, flags);
Jens Axboe4022e7a2020-03-19 19:23:18 -0600531}
532
Al Viro1a7bd222012-08-12 17:18:05 -0400533int get_unused_fd_flags(unsigned flags)
Al Viro1027abe2008-07-30 04:13:04 -0400534{
Jens Axboe4022e7a2020-03-19 19:23:18 -0600535 return __get_unused_fd_flags(flags, rlimit(RLIMIT_NOFILE));
Al Viro1027abe2008-07-30 04:13:04 -0400536}
Al Viro1a7bd222012-08-12 17:18:05 -0400537EXPORT_SYMBOL(get_unused_fd_flags);
Al Viro56007ca2012-08-15 21:03:26 -0400538
539static void __put_unused_fd(struct files_struct *files, unsigned int fd)
540{
541 struct fdtable *fdt = files_fdtable(files);
542 __clear_open_fd(fd, fdt);
543 if (fd < files->next_fd)
544 files->next_fd = fd;
545}
546
547void put_unused_fd(unsigned int fd)
548{
549 struct files_struct *files = current->files;
550 spin_lock(&files->file_lock);
551 __put_unused_fd(files, fd);
552 spin_unlock(&files->file_lock);
553}
554
555EXPORT_SYMBOL(put_unused_fd);
556
557/*
558 * Install a file pointer in the fd array.
559 *
560 * The VFS is full of places where we drop the files lock between
561 * setting the open_fds bitmap and installing the file in the file
562 * array. At any such point, we are vulnerable to a dup2() race
563 * installing a file in the array before us. We need to detect this and
564 * fput() the struct file we are about to overwrite in this case.
565 *
566 * It should never happen - if we allow dup2() do it, _really_ bad things
567 * will follow.
Al Virof869e8a2012-08-15 21:06:33 -0400568 *
Eric W. Biedermand74ba042020-11-20 17:14:35 -0600569 * This consumes the "file" refcount, so callers should treat it
570 * as if they had called fput(file).
Al Viro56007ca2012-08-15 21:03:26 -0400571 */
572
Eric W. Biedermand74ba042020-11-20 17:14:35 -0600573void fd_install(unsigned int fd, struct file *file)
Al Viro56007ca2012-08-15 21:03:26 -0400574{
Eric W. Biedermand74ba042020-11-20 17:14:35 -0600575 struct files_struct *files = current->files;
Al Viro56007ca2012-08-15 21:03:26 -0400576 struct fdtable *fdt;
Eric Dumazet8a812522015-06-30 15:54:08 +0200577
Eric Dumazet8a812522015-06-30 15:54:08 +0200578 rcu_read_lock_sched();
579
Mateusz Guzikc02b1a92017-10-03 12:58:15 +0200580 if (unlikely(files->resize_in_progress)) {
Eric Dumazet8a812522015-06-30 15:54:08 +0200581 rcu_read_unlock_sched();
Mateusz Guzikc02b1a92017-10-03 12:58:15 +0200582 spin_lock(&files->file_lock);
583 fdt = files_fdtable(files);
584 BUG_ON(fdt->fd[fd] != NULL);
585 rcu_assign_pointer(fdt->fd[fd], file);
586 spin_unlock(&files->file_lock);
587 return;
Eric Dumazet8a812522015-06-30 15:54:08 +0200588 }
589 /* coupled with smp_wmb() in expand_fdtable() */
590 smp_rmb();
591 fdt = rcu_dereference_sched(files->fdt);
Al Viro56007ca2012-08-15 21:03:26 -0400592 BUG_ON(fdt->fd[fd] != NULL);
593 rcu_assign_pointer(fdt->fd[fd], file);
Eric Dumazet8a812522015-06-30 15:54:08 +0200594 rcu_read_unlock_sched();
Al Viro56007ca2012-08-15 21:03:26 -0400595}
596
597EXPORT_SYMBOL(fd_install);
Al Viro0ee8cdf2012-08-15 21:12:10 -0400598
Christian Brauner278a5fb2019-05-24 11:30:34 +0200599static struct file *pick_file(struct files_struct *files, unsigned fd)
Al Viro483ce1d2012-08-19 12:04:24 -0400600{
Christian Brauner278a5fb2019-05-24 11:30:34 +0200601 struct file *file = NULL;
Al Viro483ce1d2012-08-19 12:04:24 -0400602 struct fdtable *fdt;
603
604 spin_lock(&files->file_lock);
605 fdt = files_fdtable(files);
606 if (fd >= fdt->max_fds)
607 goto out_unlock;
608 file = fdt->fd[fd];
609 if (!file)
610 goto out_unlock;
611 rcu_assign_pointer(fdt->fd[fd], NULL);
Al Viro483ce1d2012-08-19 12:04:24 -0400612 __put_unused_fd(files, fd);
Al Viro483ce1d2012-08-19 12:04:24 -0400613
614out_unlock:
615 spin_unlock(&files->file_lock);
Christian Brauner278a5fb2019-05-24 11:30:34 +0200616 return file;
617}
618
Eric W. Biederman8760c902020-11-20 17:14:38 -0600619int close_fd(unsigned fd)
Christian Brauner278a5fb2019-05-24 11:30:34 +0200620{
Eric W. Biederman8760c902020-11-20 17:14:38 -0600621 struct files_struct *files = current->files;
Christian Brauner278a5fb2019-05-24 11:30:34 +0200622 struct file *file;
623
624 file = pick_file(files, fd);
625 if (!file)
626 return -EBADF;
627
628 return filp_close(file, files);
Al Viro483ce1d2012-08-19 12:04:24 -0400629}
Eric W. Biederman8760c902020-11-20 17:14:38 -0600630EXPORT_SYMBOL(close_fd); /* for ksys_close() */
Al Viro483ce1d2012-08-19 12:04:24 -0400631
Christian Brauner9b5b87222021-04-02 10:29:36 +0200632/**
633 * last_fd - return last valid index into fd table
634 * @cur_fds: files struct
635 *
636 * Context: Either rcu read lock or files_lock must be held.
637 *
638 * Returns: Last valid index into fdtable.
639 */
640static inline unsigned last_fd(struct fdtable *fdt)
641{
642 return fdt->max_fds - 1;
643}
644
Giuseppe Scrivano582f1fb2020-11-18 11:47:45 +0100645static inline void __range_cloexec(struct files_struct *cur_fds,
646 unsigned int fd, unsigned int max_fd)
647{
648 struct fdtable *fdt;
649
Christian Brauner9b5b87222021-04-02 10:29:36 +0200650 /* make sure we're using the correct maximum value */
Giuseppe Scrivano582f1fb2020-11-18 11:47:45 +0100651 spin_lock(&cur_fds->file_lock);
652 fdt = files_fdtable(cur_fds);
Christian Brauner9b5b87222021-04-02 10:29:36 +0200653 max_fd = min(last_fd(fdt), max_fd);
654 if (fd <= max_fd)
655 bitmap_set(fdt->close_on_exec, fd, max_fd - fd + 1);
Giuseppe Scrivano582f1fb2020-11-18 11:47:45 +0100656 spin_unlock(&cur_fds->file_lock);
657}
658
659static inline void __range_close(struct files_struct *cur_fds, unsigned int fd,
660 unsigned int max_fd)
661{
662 while (fd <= max_fd) {
663 struct file *file;
664
665 file = pick_file(cur_fds, fd++);
666 if (!file)
667 continue;
668
669 filp_close(file, cur_fds);
670 cond_resched();
671 }
672}
673
Christian Brauner278a5fb2019-05-24 11:30:34 +0200674/**
675 * __close_range() - Close all file descriptors in a given range.
676 *
677 * @fd: starting file descriptor to close
678 * @max_fd: last file descriptor to close
679 *
680 * This closes a range of file descriptors. All file descriptors
681 * from @fd up to and including @max_fd are closed.
682 */
Christian Brauner60997c32020-06-03 21:48:55 +0200683int __close_range(unsigned fd, unsigned max_fd, unsigned int flags)
Christian Brauner278a5fb2019-05-24 11:30:34 +0200684{
685 unsigned int cur_max;
Christian Brauner60997c32020-06-03 21:48:55 +0200686 struct task_struct *me = current;
687 struct files_struct *cur_fds = me->files, *fds = NULL;
688
Giuseppe Scrivano582f1fb2020-11-18 11:47:45 +0100689 if (flags & ~(CLOSE_RANGE_UNSHARE | CLOSE_RANGE_CLOEXEC))
Christian Brauner60997c32020-06-03 21:48:55 +0200690 return -EINVAL;
Christian Brauner278a5fb2019-05-24 11:30:34 +0200691
692 if (fd > max_fd)
693 return -EINVAL;
694
695 rcu_read_lock();
Christian Brauner60997c32020-06-03 21:48:55 +0200696 cur_max = files_fdtable(cur_fds)->max_fds;
Christian Brauner278a5fb2019-05-24 11:30:34 +0200697 rcu_read_unlock();
698
699 /* cap to last valid index into fdtable */
700 cur_max--;
701
Christian Brauner60997c32020-06-03 21:48:55 +0200702 if (flags & CLOSE_RANGE_UNSHARE) {
703 int ret;
704 unsigned int max_unshare_fds = NR_OPEN_MAX;
705
706 /*
707 * If the requested range is greater than the current maximum,
708 * we're closing everything so only copy all file descriptors
709 * beneath the lowest file descriptor.
Christian Braunerfec8a6a2020-12-17 22:33:03 +0100710 * If the caller requested all fds to be made cloexec copy all
711 * of the file descriptors since they still want to use them.
Christian Brauner60997c32020-06-03 21:48:55 +0200712 */
Christian Braunerfec8a6a2020-12-17 22:33:03 +0100713 if (!(flags & CLOSE_RANGE_CLOEXEC) && (max_fd >= cur_max))
Christian Brauner60997c32020-06-03 21:48:55 +0200714 max_unshare_fds = fd;
715
716 ret = unshare_fd(CLONE_FILES, max_unshare_fds, &fds);
717 if (ret)
718 return ret;
719
720 /*
721 * We used to share our file descriptor table, and have now
722 * created a private one, make sure we're using it below.
723 */
724 if (fds)
725 swap(cur_fds, fds);
726 }
727
Christian Brauner278a5fb2019-05-24 11:30:34 +0200728 max_fd = min(max_fd, cur_max);
Christian Brauner278a5fb2019-05-24 11:30:34 +0200729
Giuseppe Scrivano582f1fb2020-11-18 11:47:45 +0100730 if (flags & CLOSE_RANGE_CLOEXEC)
731 __range_cloexec(cur_fds, fd, max_fd);
732 else
733 __range_close(cur_fds, fd, max_fd);
Christian Brauner278a5fb2019-05-24 11:30:34 +0200734
Christian Brauner60997c32020-06-03 21:48:55 +0200735 if (fds) {
736 /*
737 * We're done closing the files we were supposed to. Time to install
738 * the new file descriptor table and drop the old one.
739 */
740 task_lock(me);
741 me->files = cur_fds;
742 task_unlock(me);
743 put_files_struct(fds);
744 }
745
Christian Brauner278a5fb2019-05-24 11:30:34 +0200746 return 0;
747}
748
Todd Kjos80cd7952018-12-14 15:58:21 -0800749/*
Jens Axboe53dec2e2021-01-19 15:41:52 -0700750 * See close_fd_get_file() below, this variant assumes current->files->file_lock
751 * is held.
752 */
753int __close_fd_get_file(unsigned int fd, struct file **res)
754{
755 struct files_struct *files = current->files;
756 struct file *file;
757 struct fdtable *fdt;
758
759 fdt = files_fdtable(files);
760 if (fd >= fdt->max_fds)
761 goto out_err;
762 file = fdt->fd[fd];
763 if (!file)
764 goto out_err;
765 rcu_assign_pointer(fdt->fd[fd], NULL);
766 __put_unused_fd(files, fd);
767 get_file(file);
768 *res = file;
769 return 0;
770out_err:
771 *res = NULL;
772 return -ENOENT;
773}
774
775/*
Eric W. Biederman9fe83c42020-11-20 17:14:40 -0600776 * variant of close_fd that gets a ref on the file for later fput.
Jens Axboe6e802a42019-12-11 14:10:35 -0700777 * The caller must ensure that filp_close() called on the file, and then
778 * an fput().
Todd Kjos80cd7952018-12-14 15:58:21 -0800779 */
Eric W. Biederman9fe83c42020-11-20 17:14:40 -0600780int close_fd_get_file(unsigned int fd, struct file **res)
Todd Kjos80cd7952018-12-14 15:58:21 -0800781{
782 struct files_struct *files = current->files;
Jens Axboe53dec2e2021-01-19 15:41:52 -0700783 int ret;
Todd Kjos80cd7952018-12-14 15:58:21 -0800784
785 spin_lock(&files->file_lock);
Jens Axboe53dec2e2021-01-19 15:41:52 -0700786 ret = __close_fd_get_file(fd, res);
Todd Kjos80cd7952018-12-14 15:58:21 -0800787 spin_unlock(&files->file_lock);
Todd Kjos80cd7952018-12-14 15:58:21 -0800788
Jens Axboe53dec2e2021-01-19 15:41:52 -0700789 return ret;
Todd Kjos80cd7952018-12-14 15:58:21 -0800790}
791
Al Viro6a6d27d2012-08-21 09:56:33 -0400792void do_close_on_exec(struct files_struct *files)
793{
794 unsigned i;
795 struct fdtable *fdt;
796
797 /* exec unshares first */
Al Viro6a6d27d2012-08-21 09:56:33 -0400798 spin_lock(&files->file_lock);
799 for (i = 0; ; i++) {
800 unsigned long set;
801 unsigned fd = i * BITS_PER_LONG;
802 fdt = files_fdtable(files);
803 if (fd >= fdt->max_fds)
804 break;
805 set = fdt->close_on_exec[i];
806 if (!set)
807 continue;
808 fdt->close_on_exec[i] = 0;
809 for ( ; set ; fd++, set >>= 1) {
810 struct file *file;
811 if (!(set & 1))
812 continue;
813 file = fdt->fd[fd];
814 if (!file)
815 continue;
816 rcu_assign_pointer(fdt->fd[fd], NULL);
817 __put_unused_fd(files, fd);
818 spin_unlock(&files->file_lock);
819 filp_close(file, files);
820 cond_resched();
821 spin_lock(&files->file_lock);
822 }
823
824 }
825 spin_unlock(&files->file_lock);
826}
827
Sargun Dhillon5e876fb2020-01-07 09:59:24 -0800828static struct file *__fget_files(struct files_struct *files, unsigned int fd,
829 fmode_t mask, unsigned int refs)
Al Viro0ee8cdf2012-08-15 21:12:10 -0400830{
Oleg Nesterov1deb46e2014-01-13 16:48:19 +0100831 struct file *file;
Al Viro0ee8cdf2012-08-15 21:12:10 -0400832
833 rcu_read_lock();
Eric Dumazet5ba97d22015-06-29 17:10:30 +0200834loop:
Eric W. Biedermanf36c2942020-11-20 17:14:26 -0600835 file = files_lookup_fd_rcu(files, fd);
Al Viro0ee8cdf2012-08-15 21:12:10 -0400836 if (file) {
Eric Dumazet5ba97d22015-06-29 17:10:30 +0200837 /* File object ref couldn't be taken.
838 * dup2() atomicity guarantee is the reason
839 * we loop to catch the new file (or NULL pointer)
840 */
841 if (file->f_mode & mask)
Al Viro0ee8cdf2012-08-15 21:12:10 -0400842 file = NULL;
Jens Axboe091141a2018-11-21 10:32:39 -0700843 else if (!get_file_rcu_many(file, refs))
Eric Dumazet5ba97d22015-06-29 17:10:30 +0200844 goto loop;
Al Viro0ee8cdf2012-08-15 21:12:10 -0400845 }
846 rcu_read_unlock();
847
848 return file;
849}
850
Sargun Dhillon5e876fb2020-01-07 09:59:24 -0800851static inline struct file *__fget(unsigned int fd, fmode_t mask,
852 unsigned int refs)
853{
854 return __fget_files(current->files, fd, mask, refs);
855}
856
Jens Axboe091141a2018-11-21 10:32:39 -0700857struct file *fget_many(unsigned int fd, unsigned int refs)
858{
859 return __fget(fd, FMODE_PATH, refs);
860}
861
Oleg Nesterov1deb46e2014-01-13 16:48:19 +0100862struct file *fget(unsigned int fd)
863{
Jens Axboe091141a2018-11-21 10:32:39 -0700864 return __fget(fd, FMODE_PATH, 1);
Oleg Nesterov1deb46e2014-01-13 16:48:19 +0100865}
Al Viro0ee8cdf2012-08-15 21:12:10 -0400866EXPORT_SYMBOL(fget);
867
868struct file *fget_raw(unsigned int fd)
869{
Jens Axboe091141a2018-11-21 10:32:39 -0700870 return __fget(fd, 0, 1);
Al Viro0ee8cdf2012-08-15 21:12:10 -0400871}
Al Viro0ee8cdf2012-08-15 21:12:10 -0400872EXPORT_SYMBOL(fget_raw);
873
Sargun Dhillon5e876fb2020-01-07 09:59:24 -0800874struct file *fget_task(struct task_struct *task, unsigned int fd)
875{
876 struct file *file = NULL;
877
878 task_lock(task);
879 if (task->files)
880 file = __fget_files(task->files, fd, 0, 1);
881 task_unlock(task);
882
883 return file;
884}
885
Eric W. Biederman3a879fb2020-11-20 17:14:28 -0600886struct file *task_lookup_fd_rcu(struct task_struct *task, unsigned int fd)
887{
888 /* Must be called with rcu_read_lock held */
889 struct files_struct *files;
890 struct file *file = NULL;
891
892 task_lock(task);
893 files = task->files;
894 if (files)
895 file = files_lookup_fd_rcu(files, fd);
896 task_unlock(task);
897
898 return file;
899}
900
Eric W. Biedermane9a53ae2020-11-20 17:14:31 -0600901struct file *task_lookup_next_fd_rcu(struct task_struct *task, unsigned int *ret_fd)
902{
903 /* Must be called with rcu_read_lock held */
904 struct files_struct *files;
905 unsigned int fd = *ret_fd;
906 struct file *file = NULL;
907
908 task_lock(task);
909 files = task->files;
910 if (files) {
911 for (; fd < files_fdtable(files)->max_fds; fd++) {
912 file = files_lookup_fd_rcu(files, fd);
913 if (file)
914 break;
915 }
916 }
917 task_unlock(task);
918 *ret_fd = fd;
919 return file;
920}
921
Al Viro0ee8cdf2012-08-15 21:12:10 -0400922/*
923 * Lightweight file lookup - no refcnt increment if fd table isn't shared.
924 *
925 * You can use this instead of fget if you satisfy all of the following
926 * conditions:
927 * 1) You must call fput_light before exiting the syscall and returning control
928 * to userspace (i.e. you cannot remember the returned struct file * after
929 * returning to userspace).
930 * 2) You must not call filp_close on the returned struct file * in between
931 * calls to fget_light and fput_light.
932 * 3) You must not clone the current task in between the calls to fget_light
933 * and fput_light.
934 *
935 * The fput_needed flag returned by fget_light should be passed to the
936 * corresponding fput_light.
937 */
Al Virobd2a31d2014-03-04 14:54:22 -0500938static unsigned long __fget_light(unsigned int fd, fmode_t mask)
Al Viro0ee8cdf2012-08-15 21:12:10 -0400939{
Al Viro0ee8cdf2012-08-15 21:12:10 -0400940 struct files_struct *files = current->files;
Oleg Nesterovad461832014-01-13 16:48:40 +0100941 struct file *file;
Al Viro0ee8cdf2012-08-15 21:12:10 -0400942
Al Viro0ee8cdf2012-08-15 21:12:10 -0400943 if (atomic_read(&files->count) == 1) {
Eric W. Biedermanbebf6842020-11-20 17:14:24 -0600944 file = files_lookup_fd_raw(files, fd);
Al Virobd2a31d2014-03-04 14:54:22 -0500945 if (!file || unlikely(file->f_mode & mask))
946 return 0;
947 return (unsigned long)file;
Al Viro0ee8cdf2012-08-15 21:12:10 -0400948 } else {
Jens Axboe091141a2018-11-21 10:32:39 -0700949 file = __fget(fd, mask, 1);
Al Virobd2a31d2014-03-04 14:54:22 -0500950 if (!file)
951 return 0;
952 return FDPUT_FPUT | (unsigned long)file;
Al Viro0ee8cdf2012-08-15 21:12:10 -0400953 }
Al Viro0ee8cdf2012-08-15 21:12:10 -0400954}
Al Virobd2a31d2014-03-04 14:54:22 -0500955unsigned long __fdget(unsigned int fd)
Oleg Nesterovad461832014-01-13 16:48:40 +0100956{
Al Virobd2a31d2014-03-04 14:54:22 -0500957 return __fget_light(fd, FMODE_PATH);
Oleg Nesterovad461832014-01-13 16:48:40 +0100958}
Al Virobd2a31d2014-03-04 14:54:22 -0500959EXPORT_SYMBOL(__fdget);
Al Viro0ee8cdf2012-08-15 21:12:10 -0400960
Al Virobd2a31d2014-03-04 14:54:22 -0500961unsigned long __fdget_raw(unsigned int fd)
Al Viro0ee8cdf2012-08-15 21:12:10 -0400962{
Al Virobd2a31d2014-03-04 14:54:22 -0500963 return __fget_light(fd, 0);
Al Viro0ee8cdf2012-08-15 21:12:10 -0400964}
Al Virofe17f222012-08-21 11:48:11 -0400965
Al Virobd2a31d2014-03-04 14:54:22 -0500966unsigned long __fdget_pos(unsigned int fd)
967{
Eric Biggers99aea682014-03-16 15:47:48 -0500968 unsigned long v = __fdget(fd);
969 struct file *file = (struct file *)(v & ~3);
Al Virobd2a31d2014-03-04 14:54:22 -0500970
Linus Torvalds2be7d342019-11-26 11:34:06 -0800971 if (file && (file->f_mode & FMODE_ATOMIC_POS)) {
Al Virobd2a31d2014-03-04 14:54:22 -0500972 if (file_count(file) > 1) {
973 v |= FDPUT_POS_UNLOCK;
974 mutex_lock(&file->f_pos_lock);
975 }
976 }
Eric Biggers99aea682014-03-16 15:47:48 -0500977 return v;
Al Virobd2a31d2014-03-04 14:54:22 -0500978}
979
Al Viro63b6df12016-04-20 17:08:21 -0400980void __f_unlock_pos(struct file *f)
981{
982 mutex_unlock(&f->f_pos_lock);
983}
984
Al Virobd2a31d2014-03-04 14:54:22 -0500985/*
986 * We only lock f_pos if we have threads or if the file might be
987 * shared with another process. In both cases we'll have an elevated
988 * file count (done either by fdget() or by fork()).
989 */
990
Al Virofe17f222012-08-21 11:48:11 -0400991void set_close_on_exec(unsigned int fd, int flag)
992{
993 struct files_struct *files = current->files;
994 struct fdtable *fdt;
995 spin_lock(&files->file_lock);
996 fdt = files_fdtable(files);
997 if (flag)
998 __set_close_on_exec(fd, fdt);
999 else
1000 __clear_close_on_exec(fd, fdt);
1001 spin_unlock(&files->file_lock);
1002}
1003
1004bool get_close_on_exec(unsigned int fd)
1005{
1006 struct files_struct *files = current->files;
1007 struct fdtable *fdt;
1008 bool res;
1009 rcu_read_lock();
1010 fdt = files_fdtable(files);
1011 res = close_on_exec(fd, fdt);
1012 rcu_read_unlock();
1013 return res;
1014}
1015
Al Viro8280d162012-08-21 12:11:46 -04001016static int do_dup2(struct files_struct *files,
1017 struct file *file, unsigned fd, unsigned flags)
Al Viroe9830942014-08-31 14:12:09 -04001018__releases(&files->file_lock)
Al Viro8280d162012-08-21 12:11:46 -04001019{
1020 struct file *tofree;
1021 struct fdtable *fdt;
1022
1023 /*
1024 * We need to detect attempts to do dup2() over allocated but still
1025 * not finished descriptor. NB: OpenBSD avoids that at the price of
1026 * extra work in their equivalent of fget() - they insert struct
1027 * file immediately after grabbing descriptor, mark it larval if
1028 * more work (e.g. actual opening) is needed and make sure that
1029 * fget() treats larval files as absent. Potentially interesting,
1030 * but while extra work in fget() is trivial, locking implications
1031 * and amount of surgery on open()-related paths in VFS are not.
1032 * FreeBSD fails with -EBADF in the same situation, NetBSD "solution"
1033 * deadlocks in rather amusing ways, AFAICS. All of that is out of
1034 * scope of POSIX or SUS, since neither considers shared descriptor
1035 * tables and this condition does not arise without those.
1036 */
1037 fdt = files_fdtable(files);
1038 tofree = fdt->fd[fd];
1039 if (!tofree && fd_is_open(fd, fdt))
1040 goto Ebusy;
1041 get_file(file);
1042 rcu_assign_pointer(fdt->fd[fd], file);
1043 __set_open_fd(fd, fdt);
1044 if (flags & O_CLOEXEC)
1045 __set_close_on_exec(fd, fdt);
1046 else
1047 __clear_close_on_exec(fd, fdt);
1048 spin_unlock(&files->file_lock);
1049
1050 if (tofree)
1051 filp_close(tofree, files);
1052
1053 return fd;
1054
1055Ebusy:
1056 spin_unlock(&files->file_lock);
1057 return -EBUSY;
1058}
1059
1060int replace_fd(unsigned fd, struct file *file, unsigned flags)
1061{
1062 int err;
1063 struct files_struct *files = current->files;
1064
1065 if (!file)
Eric W. Biederman8760c902020-11-20 17:14:38 -06001066 return close_fd(fd);
Al Viro8280d162012-08-21 12:11:46 -04001067
1068 if (fd >= rlimit(RLIMIT_NOFILE))
Al Viro08f05c42012-10-31 03:37:48 +00001069 return -EBADF;
Al Viro8280d162012-08-21 12:11:46 -04001070
1071 spin_lock(&files->file_lock);
1072 err = expand_files(files, fd);
1073 if (unlikely(err < 0))
1074 goto out_unlock;
1075 return do_dup2(files, file, fd, flags);
1076
1077out_unlock:
1078 spin_unlock(&files->file_lock);
1079 return err;
1080}
1081
Kees Cook66590612020-06-10 08:20:05 -07001082/**
1083 * __receive_fd() - Install received file into file descriptor table
Kees Cook66590612020-06-10 08:20:05 -07001084 * @file: struct file that was received from another process
1085 * @ufd: __user pointer to write new fd number to
1086 * @o_flags: the O_* flags to apply to the new fd entry
1087 *
1088 * Installs a received file into the file descriptor table, with appropriate
Kees Cookdeefa7f2020-06-10 20:47:45 -07001089 * checks and count updates. Optionally writes the fd number to userspace, if
1090 * @ufd is non-NULL.
Kees Cook66590612020-06-10 08:20:05 -07001091 *
1092 * This helper handles its own reference counting of the incoming
1093 * struct file.
1094 *
Kees Cookdeefa7f2020-06-10 20:47:45 -07001095 * Returns newly install fd or -ve on error.
Kees Cook66590612020-06-10 08:20:05 -07001096 */
Christoph Hellwig42eb0d52021-03-25 09:22:09 +01001097int __receive_fd(struct file *file, int __user *ufd, unsigned int o_flags)
Kees Cook66590612020-06-10 08:20:05 -07001098{
1099 int new_fd;
1100 int error;
1101
1102 error = security_file_receive(file);
1103 if (error)
1104 return error;
1105
Christoph Hellwig42eb0d52021-03-25 09:22:09 +01001106 new_fd = get_unused_fd_flags(o_flags);
1107 if (new_fd < 0)
1108 return new_fd;
Kees Cook66590612020-06-10 08:20:05 -07001109
Kees Cookdeefa7f2020-06-10 20:47:45 -07001110 if (ufd) {
1111 error = put_user(new_fd, ufd);
1112 if (error) {
Christoph Hellwig42eb0d52021-03-25 09:22:09 +01001113 put_unused_fd(new_fd);
Kees Cookdeefa7f2020-06-10 20:47:45 -07001114 return error;
1115 }
Kees Cook66590612020-06-10 08:20:05 -07001116 }
1117
Christoph Hellwig42eb0d52021-03-25 09:22:09 +01001118 fd_install(new_fd, get_file(file));
1119 __receive_sock(file);
1120 return new_fd;
1121}
Kees Cook173817152020-06-10 08:46:58 -07001122
Christoph Hellwig42eb0d52021-03-25 09:22:09 +01001123int receive_fd_replace(int new_fd, struct file *file, unsigned int o_flags)
1124{
1125 int error;
1126
1127 error = security_file_receive(file);
1128 if (error)
1129 return error;
1130 error = replace_fd(new_fd, file, o_flags);
1131 if (error)
1132 return error;
Kees Cook66590612020-06-10 08:20:05 -07001133 __receive_sock(file);
Kees Cookdeefa7f2020-06-10 20:47:45 -07001134 return new_fd;
Kees Cook66590612020-06-10 08:20:05 -07001135}
1136
Dominik Brodowskic7248322018-03-11 11:34:40 +01001137static int ksys_dup3(unsigned int oldfd, unsigned int newfd, int flags)
Al Virofe17f222012-08-21 11:48:11 -04001138{
1139 int err = -EBADF;
Al Viro8280d162012-08-21 12:11:46 -04001140 struct file *file;
1141 struct files_struct *files = current->files;
Al Virofe17f222012-08-21 11:48:11 -04001142
1143 if ((flags & ~O_CLOEXEC) != 0)
1144 return -EINVAL;
1145
Richard W.M. Jonesaed97642012-10-09 15:27:43 +01001146 if (unlikely(oldfd == newfd))
1147 return -EINVAL;
1148
Al Virofe17f222012-08-21 11:48:11 -04001149 if (newfd >= rlimit(RLIMIT_NOFILE))
Al Viro08f05c42012-10-31 03:37:48 +00001150 return -EBADF;
Al Virofe17f222012-08-21 11:48:11 -04001151
1152 spin_lock(&files->file_lock);
1153 err = expand_files(files, newfd);
Eric W. Biederman120ce2b2020-11-20 17:14:25 -06001154 file = files_lookup_fd_locked(files, oldfd);
Al Virofe17f222012-08-21 11:48:11 -04001155 if (unlikely(!file))
1156 goto Ebadf;
1157 if (unlikely(err < 0)) {
1158 if (err == -EMFILE)
1159 goto Ebadf;
1160 goto out_unlock;
1161 }
Al Viro8280d162012-08-21 12:11:46 -04001162 return do_dup2(files, file, newfd, flags);
Al Virofe17f222012-08-21 11:48:11 -04001163
1164Ebadf:
1165 err = -EBADF;
1166out_unlock:
1167 spin_unlock(&files->file_lock);
1168 return err;
1169}
1170
Dominik Brodowskic7248322018-03-11 11:34:40 +01001171SYSCALL_DEFINE3(dup3, unsigned int, oldfd, unsigned int, newfd, int, flags)
1172{
1173 return ksys_dup3(oldfd, newfd, flags);
1174}
1175
Al Virofe17f222012-08-21 11:48:11 -04001176SYSCALL_DEFINE2(dup2, unsigned int, oldfd, unsigned int, newfd)
1177{
1178 if (unlikely(newfd == oldfd)) { /* corner case */
1179 struct files_struct *files = current->files;
1180 int retval = oldfd;
1181
1182 rcu_read_lock();
Eric W. Biedermanf36c2942020-11-20 17:14:26 -06001183 if (!files_lookup_fd_rcu(files, oldfd))
Al Virofe17f222012-08-21 11:48:11 -04001184 retval = -EBADF;
1185 rcu_read_unlock();
1186 return retval;
1187 }
Dominik Brodowskic7248322018-03-11 11:34:40 +01001188 return ksys_dup3(oldfd, newfd, 0);
Al Virofe17f222012-08-21 11:48:11 -04001189}
1190
Christoph Hellwigbc1cd992020-07-14 08:58:49 +02001191SYSCALL_DEFINE1(dup, unsigned int, fildes)
Al Virofe17f222012-08-21 11:48:11 -04001192{
1193 int ret = -EBADF;
1194 struct file *file = fget_raw(fildes);
1195
1196 if (file) {
Yann Droneaud8d10a032014-12-10 15:45:44 -08001197 ret = get_unused_fd_flags(0);
Al Virofe17f222012-08-21 11:48:11 -04001198 if (ret >= 0)
1199 fd_install(ret, file);
1200 else
1201 fput(file);
1202 }
1203 return ret;
1204}
1205
1206int f_dupfd(unsigned int from, struct file *file, unsigned flags)
1207{
Eric W. Biedermane06b53c2020-11-20 17:14:36 -06001208 unsigned long nofile = rlimit(RLIMIT_NOFILE);
Al Virofe17f222012-08-21 11:48:11 -04001209 int err;
Eric W. Biedermane06b53c2020-11-20 17:14:36 -06001210 if (from >= nofile)
Al Virofe17f222012-08-21 11:48:11 -04001211 return -EINVAL;
Eric W. Biedermane06b53c2020-11-20 17:14:36 -06001212 err = alloc_fd(from, nofile, flags);
Al Virofe17f222012-08-21 11:48:11 -04001213 if (err >= 0) {
1214 get_file(file);
1215 fd_install(err, file);
1216 }
1217 return err;
1218}
Al Viroc3c073f2012-08-21 22:32:06 -04001219
1220int iterate_fd(struct files_struct *files, unsigned n,
1221 int (*f)(const void *, struct file *, unsigned),
1222 const void *p)
1223{
1224 struct fdtable *fdt;
Al Viroc3c073f2012-08-21 22:32:06 -04001225 int res = 0;
1226 if (!files)
1227 return 0;
1228 spin_lock(&files->file_lock);
Al Viroa77cfcb2012-11-29 22:57:33 -05001229 for (fdt = files_fdtable(files); n < fdt->max_fds; n++) {
1230 struct file *file;
1231 file = rcu_dereference_check_fdtable(files, fdt->fd[n]);
1232 if (!file)
1233 continue;
1234 res = f(p, file, n);
1235 if (res)
1236 break;
Al Viroc3c073f2012-08-21 22:32:06 -04001237 }
1238 spin_unlock(&files->file_lock);
1239 return res;
1240}
1241EXPORT_SYMBOL(iterate_fd);