blob: 8627dacfc4246fb975ed38f2b2dc8090f7c7202c [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 Braunerf49fd6d2021-04-02 10:32:21 +0200599/**
600 * pick_file - return file associatd with fd
601 * @files: file struct to retrieve file from
602 * @fd: file descriptor to retrieve file for
603 *
604 * If this functions returns an EINVAL error pointer the fd was beyond the
605 * current maximum number of file descriptors for that fdtable.
606 *
607 * Returns: The file associated with @fd, on error returns an error pointer.
608 */
Christian Brauner278a5fb2019-05-24 11:30:34 +0200609static struct file *pick_file(struct files_struct *files, unsigned fd)
Al Viro483ce1d2012-08-19 12:04:24 -0400610{
Christian Braunerf49fd6d2021-04-02 10:32:21 +0200611 struct file *file;
Al Viro483ce1d2012-08-19 12:04:24 -0400612 struct fdtable *fdt;
613
614 spin_lock(&files->file_lock);
615 fdt = files_fdtable(files);
Christian Braunerf49fd6d2021-04-02 10:32:21 +0200616 if (fd >= fdt->max_fds) {
617 file = ERR_PTR(-EINVAL);
Al Viro483ce1d2012-08-19 12:04:24 -0400618 goto out_unlock;
Christian Braunerf49fd6d2021-04-02 10:32:21 +0200619 }
Al Viro483ce1d2012-08-19 12:04:24 -0400620 file = fdt->fd[fd];
Christian Braunerf49fd6d2021-04-02 10:32:21 +0200621 if (!file) {
622 file = ERR_PTR(-EBADF);
Al Viro483ce1d2012-08-19 12:04:24 -0400623 goto out_unlock;
Christian Braunerf49fd6d2021-04-02 10:32:21 +0200624 }
Al Viro483ce1d2012-08-19 12:04:24 -0400625 rcu_assign_pointer(fdt->fd[fd], NULL);
Al Viro483ce1d2012-08-19 12:04:24 -0400626 __put_unused_fd(files, fd);
Al Viro483ce1d2012-08-19 12:04:24 -0400627
628out_unlock:
629 spin_unlock(&files->file_lock);
Christian Brauner278a5fb2019-05-24 11:30:34 +0200630 return file;
631}
632
Eric W. Biederman8760c902020-11-20 17:14:38 -0600633int close_fd(unsigned fd)
Christian Brauner278a5fb2019-05-24 11:30:34 +0200634{
Eric W. Biederman8760c902020-11-20 17:14:38 -0600635 struct files_struct *files = current->files;
Christian Brauner278a5fb2019-05-24 11:30:34 +0200636 struct file *file;
637
638 file = pick_file(files, fd);
Christian Braunerf49fd6d2021-04-02 10:32:21 +0200639 if (IS_ERR(file))
Christian Brauner278a5fb2019-05-24 11:30:34 +0200640 return -EBADF;
641
642 return filp_close(file, files);
Al Viro483ce1d2012-08-19 12:04:24 -0400643}
Eric W. Biederman8760c902020-11-20 17:14:38 -0600644EXPORT_SYMBOL(close_fd); /* for ksys_close() */
Al Viro483ce1d2012-08-19 12:04:24 -0400645
Christian Brauner9b5b87222021-04-02 10:29:36 +0200646/**
647 * last_fd - return last valid index into fd table
648 * @cur_fds: files struct
649 *
650 * Context: Either rcu read lock or files_lock must be held.
651 *
652 * Returns: Last valid index into fdtable.
653 */
654static inline unsigned last_fd(struct fdtable *fdt)
655{
656 return fdt->max_fds - 1;
657}
658
Giuseppe Scrivano582f1fb2020-11-18 11:47:45 +0100659static inline void __range_cloexec(struct files_struct *cur_fds,
660 unsigned int fd, unsigned int max_fd)
661{
662 struct fdtable *fdt;
663
Christian Brauner9b5b87222021-04-02 10:29:36 +0200664 /* make sure we're using the correct maximum value */
Giuseppe Scrivano582f1fb2020-11-18 11:47:45 +0100665 spin_lock(&cur_fds->file_lock);
666 fdt = files_fdtable(cur_fds);
Christian Brauner9b5b87222021-04-02 10:29:36 +0200667 max_fd = min(last_fd(fdt), max_fd);
668 if (fd <= max_fd)
669 bitmap_set(fdt->close_on_exec, fd, max_fd - fd + 1);
Giuseppe Scrivano582f1fb2020-11-18 11:47:45 +0100670 spin_unlock(&cur_fds->file_lock);
671}
672
673static inline void __range_close(struct files_struct *cur_fds, unsigned int fd,
674 unsigned int max_fd)
675{
676 while (fd <= max_fd) {
677 struct file *file;
678
679 file = pick_file(cur_fds, fd++);
Christian Braunerf49fd6d2021-04-02 10:32:21 +0200680 if (!IS_ERR(file)) {
681 /* found a valid file to close */
682 filp_close(file, cur_fds);
683 cond_resched();
Giuseppe Scrivano582f1fb2020-11-18 11:47:45 +0100684 continue;
Christian Braunerf49fd6d2021-04-02 10:32:21 +0200685 }
Giuseppe Scrivano582f1fb2020-11-18 11:47:45 +0100686
Christian Braunerf49fd6d2021-04-02 10:32:21 +0200687 /* beyond the last fd in that table */
688 if (PTR_ERR(file) == -EINVAL)
689 return;
Giuseppe Scrivano582f1fb2020-11-18 11:47:45 +0100690 }
691}
692
Christian Brauner278a5fb2019-05-24 11:30:34 +0200693/**
694 * __close_range() - Close all file descriptors in a given range.
695 *
696 * @fd: starting file descriptor to close
697 * @max_fd: last file descriptor to close
698 *
699 * This closes a range of file descriptors. All file descriptors
700 * from @fd up to and including @max_fd are closed.
701 */
Christian Brauner60997c32020-06-03 21:48:55 +0200702int __close_range(unsigned fd, unsigned max_fd, unsigned int flags)
Christian Brauner278a5fb2019-05-24 11:30:34 +0200703{
Christian Brauner60997c32020-06-03 21:48:55 +0200704 struct task_struct *me = current;
705 struct files_struct *cur_fds = me->files, *fds = NULL;
706
Giuseppe Scrivano582f1fb2020-11-18 11:47:45 +0100707 if (flags & ~(CLOSE_RANGE_UNSHARE | CLOSE_RANGE_CLOEXEC))
Christian Brauner60997c32020-06-03 21:48:55 +0200708 return -EINVAL;
Christian Brauner278a5fb2019-05-24 11:30:34 +0200709
710 if (fd > max_fd)
711 return -EINVAL;
712
Christian Brauner60997c32020-06-03 21:48:55 +0200713 if (flags & CLOSE_RANGE_UNSHARE) {
714 int ret;
715 unsigned int max_unshare_fds = NR_OPEN_MAX;
716
717 /*
Christian Brauner03ba0fe2021-04-02 10:38:09 +0200718 * If the caller requested all fds to be made cloexec we always
719 * copy all of the file descriptors since they still want to
720 * use them.
Christian Brauner60997c32020-06-03 21:48:55 +0200721 */
Christian Brauner03ba0fe2021-04-02 10:38:09 +0200722 if (!(flags & CLOSE_RANGE_CLOEXEC)) {
723 /*
724 * If the requested range is greater than the current
725 * maximum, we're closing everything so only copy all
726 * file descriptors beneath the lowest file descriptor.
727 */
728 rcu_read_lock();
729 if (max_fd >= last_fd(files_fdtable(cur_fds)))
730 max_unshare_fds = fd;
731 rcu_read_unlock();
732 }
Christian Brauner60997c32020-06-03 21:48:55 +0200733
734 ret = unshare_fd(CLONE_FILES, max_unshare_fds, &fds);
735 if (ret)
736 return ret;
737
738 /*
739 * We used to share our file descriptor table, and have now
740 * created a private one, make sure we're using it below.
741 */
742 if (fds)
743 swap(cur_fds, fds);
744 }
745
Giuseppe Scrivano582f1fb2020-11-18 11:47:45 +0100746 if (flags & CLOSE_RANGE_CLOEXEC)
747 __range_cloexec(cur_fds, fd, max_fd);
748 else
749 __range_close(cur_fds, fd, max_fd);
Christian Brauner278a5fb2019-05-24 11:30:34 +0200750
Christian Brauner60997c32020-06-03 21:48:55 +0200751 if (fds) {
752 /*
753 * We're done closing the files we were supposed to. Time to install
754 * the new file descriptor table and drop the old one.
755 */
756 task_lock(me);
757 me->files = cur_fds;
758 task_unlock(me);
759 put_files_struct(fds);
760 }
761
Christian Brauner278a5fb2019-05-24 11:30:34 +0200762 return 0;
763}
764
Todd Kjos80cd7952018-12-14 15:58:21 -0800765/*
Jens Axboe53dec2e2021-01-19 15:41:52 -0700766 * See close_fd_get_file() below, this variant assumes current->files->file_lock
767 * is held.
768 */
769int __close_fd_get_file(unsigned int fd, struct file **res)
770{
771 struct files_struct *files = current->files;
772 struct file *file;
773 struct fdtable *fdt;
774
775 fdt = files_fdtable(files);
776 if (fd >= fdt->max_fds)
777 goto out_err;
778 file = fdt->fd[fd];
779 if (!file)
780 goto out_err;
781 rcu_assign_pointer(fdt->fd[fd], NULL);
782 __put_unused_fd(files, fd);
783 get_file(file);
784 *res = file;
785 return 0;
786out_err:
787 *res = NULL;
788 return -ENOENT;
789}
790
791/*
Eric W. Biederman9fe83c42020-11-20 17:14:40 -0600792 * variant of close_fd that gets a ref on the file for later fput.
Jens Axboe6e802a42019-12-11 14:10:35 -0700793 * The caller must ensure that filp_close() called on the file, and then
794 * an fput().
Todd Kjos80cd7952018-12-14 15:58:21 -0800795 */
Eric W. Biederman9fe83c42020-11-20 17:14:40 -0600796int close_fd_get_file(unsigned int fd, struct file **res)
Todd Kjos80cd7952018-12-14 15:58:21 -0800797{
798 struct files_struct *files = current->files;
Jens Axboe53dec2e2021-01-19 15:41:52 -0700799 int ret;
Todd Kjos80cd7952018-12-14 15:58:21 -0800800
801 spin_lock(&files->file_lock);
Jens Axboe53dec2e2021-01-19 15:41:52 -0700802 ret = __close_fd_get_file(fd, res);
Todd Kjos80cd7952018-12-14 15:58:21 -0800803 spin_unlock(&files->file_lock);
Todd Kjos80cd7952018-12-14 15:58:21 -0800804
Jens Axboe53dec2e2021-01-19 15:41:52 -0700805 return ret;
Todd Kjos80cd7952018-12-14 15:58:21 -0800806}
807
Al Viro6a6d27d2012-08-21 09:56:33 -0400808void do_close_on_exec(struct files_struct *files)
809{
810 unsigned i;
811 struct fdtable *fdt;
812
813 /* exec unshares first */
Al Viro6a6d27d2012-08-21 09:56:33 -0400814 spin_lock(&files->file_lock);
815 for (i = 0; ; i++) {
816 unsigned long set;
817 unsigned fd = i * BITS_PER_LONG;
818 fdt = files_fdtable(files);
819 if (fd >= fdt->max_fds)
820 break;
821 set = fdt->close_on_exec[i];
822 if (!set)
823 continue;
824 fdt->close_on_exec[i] = 0;
825 for ( ; set ; fd++, set >>= 1) {
826 struct file *file;
827 if (!(set & 1))
828 continue;
829 file = fdt->fd[fd];
830 if (!file)
831 continue;
832 rcu_assign_pointer(fdt->fd[fd], NULL);
833 __put_unused_fd(files, fd);
834 spin_unlock(&files->file_lock);
835 filp_close(file, files);
836 cond_resched();
837 spin_lock(&files->file_lock);
838 }
839
840 }
841 spin_unlock(&files->file_lock);
842}
843
Sargun Dhillon5e876fb2020-01-07 09:59:24 -0800844static struct file *__fget_files(struct files_struct *files, unsigned int fd,
845 fmode_t mask, unsigned int refs)
Al Viro0ee8cdf2012-08-15 21:12:10 -0400846{
Oleg Nesterov1deb46e2014-01-13 16:48:19 +0100847 struct file *file;
Al Viro0ee8cdf2012-08-15 21:12:10 -0400848
849 rcu_read_lock();
Eric Dumazet5ba97d22015-06-29 17:10:30 +0200850loop:
Eric W. Biedermanf36c2942020-11-20 17:14:26 -0600851 file = files_lookup_fd_rcu(files, fd);
Al Viro0ee8cdf2012-08-15 21:12:10 -0400852 if (file) {
Eric Dumazet5ba97d22015-06-29 17:10:30 +0200853 /* File object ref couldn't be taken.
854 * dup2() atomicity guarantee is the reason
855 * we loop to catch the new file (or NULL pointer)
856 */
857 if (file->f_mode & mask)
Al Viro0ee8cdf2012-08-15 21:12:10 -0400858 file = NULL;
Jens Axboe091141a2018-11-21 10:32:39 -0700859 else if (!get_file_rcu_many(file, refs))
Eric Dumazet5ba97d22015-06-29 17:10:30 +0200860 goto loop;
Al Viro0ee8cdf2012-08-15 21:12:10 -0400861 }
862 rcu_read_unlock();
863
864 return file;
865}
866
Sargun Dhillon5e876fb2020-01-07 09:59:24 -0800867static inline struct file *__fget(unsigned int fd, fmode_t mask,
868 unsigned int refs)
869{
870 return __fget_files(current->files, fd, mask, refs);
871}
872
Jens Axboe091141a2018-11-21 10:32:39 -0700873struct file *fget_many(unsigned int fd, unsigned int refs)
874{
875 return __fget(fd, FMODE_PATH, refs);
876}
877
Oleg Nesterov1deb46e2014-01-13 16:48:19 +0100878struct file *fget(unsigned int fd)
879{
Jens Axboe091141a2018-11-21 10:32:39 -0700880 return __fget(fd, FMODE_PATH, 1);
Oleg Nesterov1deb46e2014-01-13 16:48:19 +0100881}
Al Viro0ee8cdf2012-08-15 21:12:10 -0400882EXPORT_SYMBOL(fget);
883
884struct file *fget_raw(unsigned int fd)
885{
Jens Axboe091141a2018-11-21 10:32:39 -0700886 return __fget(fd, 0, 1);
Al Viro0ee8cdf2012-08-15 21:12:10 -0400887}
Al Viro0ee8cdf2012-08-15 21:12:10 -0400888EXPORT_SYMBOL(fget_raw);
889
Sargun Dhillon5e876fb2020-01-07 09:59:24 -0800890struct file *fget_task(struct task_struct *task, unsigned int fd)
891{
892 struct file *file = NULL;
893
894 task_lock(task);
895 if (task->files)
896 file = __fget_files(task->files, fd, 0, 1);
897 task_unlock(task);
898
899 return file;
900}
901
Eric W. Biederman3a879fb2020-11-20 17:14:28 -0600902struct file *task_lookup_fd_rcu(struct task_struct *task, unsigned int fd)
903{
904 /* Must be called with rcu_read_lock held */
905 struct files_struct *files;
906 struct file *file = NULL;
907
908 task_lock(task);
909 files = task->files;
910 if (files)
911 file = files_lookup_fd_rcu(files, fd);
912 task_unlock(task);
913
914 return file;
915}
916
Eric W. Biedermane9a53ae2020-11-20 17:14:31 -0600917struct file *task_lookup_next_fd_rcu(struct task_struct *task, unsigned int *ret_fd)
918{
919 /* Must be called with rcu_read_lock held */
920 struct files_struct *files;
921 unsigned int fd = *ret_fd;
922 struct file *file = NULL;
923
924 task_lock(task);
925 files = task->files;
926 if (files) {
927 for (; fd < files_fdtable(files)->max_fds; fd++) {
928 file = files_lookup_fd_rcu(files, fd);
929 if (file)
930 break;
931 }
932 }
933 task_unlock(task);
934 *ret_fd = fd;
935 return file;
936}
937
Al Viro0ee8cdf2012-08-15 21:12:10 -0400938/*
939 * Lightweight file lookup - no refcnt increment if fd table isn't shared.
940 *
941 * You can use this instead of fget if you satisfy all of the following
942 * conditions:
943 * 1) You must call fput_light before exiting the syscall and returning control
944 * to userspace (i.e. you cannot remember the returned struct file * after
945 * returning to userspace).
946 * 2) You must not call filp_close on the returned struct file * in between
947 * calls to fget_light and fput_light.
948 * 3) You must not clone the current task in between the calls to fget_light
949 * and fput_light.
950 *
951 * The fput_needed flag returned by fget_light should be passed to the
952 * corresponding fput_light.
953 */
Al Virobd2a31d2014-03-04 14:54:22 -0500954static unsigned long __fget_light(unsigned int fd, fmode_t mask)
Al Viro0ee8cdf2012-08-15 21:12:10 -0400955{
Al Viro0ee8cdf2012-08-15 21:12:10 -0400956 struct files_struct *files = current->files;
Oleg Nesterovad461832014-01-13 16:48:40 +0100957 struct file *file;
Al Viro0ee8cdf2012-08-15 21:12:10 -0400958
Al Viro0ee8cdf2012-08-15 21:12:10 -0400959 if (atomic_read(&files->count) == 1) {
Eric W. Biedermanbebf6842020-11-20 17:14:24 -0600960 file = files_lookup_fd_raw(files, fd);
Al Virobd2a31d2014-03-04 14:54:22 -0500961 if (!file || unlikely(file->f_mode & mask))
962 return 0;
963 return (unsigned long)file;
Al Viro0ee8cdf2012-08-15 21:12:10 -0400964 } else {
Jens Axboe091141a2018-11-21 10:32:39 -0700965 file = __fget(fd, mask, 1);
Al Virobd2a31d2014-03-04 14:54:22 -0500966 if (!file)
967 return 0;
968 return FDPUT_FPUT | (unsigned long)file;
Al Viro0ee8cdf2012-08-15 21:12:10 -0400969 }
Al Viro0ee8cdf2012-08-15 21:12:10 -0400970}
Al Virobd2a31d2014-03-04 14:54:22 -0500971unsigned long __fdget(unsigned int fd)
Oleg Nesterovad461832014-01-13 16:48:40 +0100972{
Al Virobd2a31d2014-03-04 14:54:22 -0500973 return __fget_light(fd, FMODE_PATH);
Oleg Nesterovad461832014-01-13 16:48:40 +0100974}
Al Virobd2a31d2014-03-04 14:54:22 -0500975EXPORT_SYMBOL(__fdget);
Al Viro0ee8cdf2012-08-15 21:12:10 -0400976
Al Virobd2a31d2014-03-04 14:54:22 -0500977unsigned long __fdget_raw(unsigned int fd)
Al Viro0ee8cdf2012-08-15 21:12:10 -0400978{
Al Virobd2a31d2014-03-04 14:54:22 -0500979 return __fget_light(fd, 0);
Al Viro0ee8cdf2012-08-15 21:12:10 -0400980}
Al Virofe17f222012-08-21 11:48:11 -0400981
Al Virobd2a31d2014-03-04 14:54:22 -0500982unsigned long __fdget_pos(unsigned int fd)
983{
Eric Biggers99aea682014-03-16 15:47:48 -0500984 unsigned long v = __fdget(fd);
985 struct file *file = (struct file *)(v & ~3);
Al Virobd2a31d2014-03-04 14:54:22 -0500986
Linus Torvalds2be7d342019-11-26 11:34:06 -0800987 if (file && (file->f_mode & FMODE_ATOMIC_POS)) {
Al Virobd2a31d2014-03-04 14:54:22 -0500988 if (file_count(file) > 1) {
989 v |= FDPUT_POS_UNLOCK;
990 mutex_lock(&file->f_pos_lock);
991 }
992 }
Eric Biggers99aea682014-03-16 15:47:48 -0500993 return v;
Al Virobd2a31d2014-03-04 14:54:22 -0500994}
995
Al Viro63b6df12016-04-20 17:08:21 -0400996void __f_unlock_pos(struct file *f)
997{
998 mutex_unlock(&f->f_pos_lock);
999}
1000
Al Virobd2a31d2014-03-04 14:54:22 -05001001/*
1002 * We only lock f_pos if we have threads or if the file might be
1003 * shared with another process. In both cases we'll have an elevated
1004 * file count (done either by fdget() or by fork()).
1005 */
1006
Al Virofe17f222012-08-21 11:48:11 -04001007void set_close_on_exec(unsigned int fd, int flag)
1008{
1009 struct files_struct *files = current->files;
1010 struct fdtable *fdt;
1011 spin_lock(&files->file_lock);
1012 fdt = files_fdtable(files);
1013 if (flag)
1014 __set_close_on_exec(fd, fdt);
1015 else
1016 __clear_close_on_exec(fd, fdt);
1017 spin_unlock(&files->file_lock);
1018}
1019
1020bool get_close_on_exec(unsigned int fd)
1021{
1022 struct files_struct *files = current->files;
1023 struct fdtable *fdt;
1024 bool res;
1025 rcu_read_lock();
1026 fdt = files_fdtable(files);
1027 res = close_on_exec(fd, fdt);
1028 rcu_read_unlock();
1029 return res;
1030}
1031
Al Viro8280d162012-08-21 12:11:46 -04001032static int do_dup2(struct files_struct *files,
1033 struct file *file, unsigned fd, unsigned flags)
Al Viroe9830942014-08-31 14:12:09 -04001034__releases(&files->file_lock)
Al Viro8280d162012-08-21 12:11:46 -04001035{
1036 struct file *tofree;
1037 struct fdtable *fdt;
1038
1039 /*
1040 * We need to detect attempts to do dup2() over allocated but still
1041 * not finished descriptor. NB: OpenBSD avoids that at the price of
1042 * extra work in their equivalent of fget() - they insert struct
1043 * file immediately after grabbing descriptor, mark it larval if
1044 * more work (e.g. actual opening) is needed and make sure that
1045 * fget() treats larval files as absent. Potentially interesting,
1046 * but while extra work in fget() is trivial, locking implications
1047 * and amount of surgery on open()-related paths in VFS are not.
1048 * FreeBSD fails with -EBADF in the same situation, NetBSD "solution"
1049 * deadlocks in rather amusing ways, AFAICS. All of that is out of
1050 * scope of POSIX or SUS, since neither considers shared descriptor
1051 * tables and this condition does not arise without those.
1052 */
1053 fdt = files_fdtable(files);
1054 tofree = fdt->fd[fd];
1055 if (!tofree && fd_is_open(fd, fdt))
1056 goto Ebusy;
1057 get_file(file);
1058 rcu_assign_pointer(fdt->fd[fd], file);
1059 __set_open_fd(fd, fdt);
1060 if (flags & O_CLOEXEC)
1061 __set_close_on_exec(fd, fdt);
1062 else
1063 __clear_close_on_exec(fd, fdt);
1064 spin_unlock(&files->file_lock);
1065
1066 if (tofree)
1067 filp_close(tofree, files);
1068
1069 return fd;
1070
1071Ebusy:
1072 spin_unlock(&files->file_lock);
1073 return -EBUSY;
1074}
1075
1076int replace_fd(unsigned fd, struct file *file, unsigned flags)
1077{
1078 int err;
1079 struct files_struct *files = current->files;
1080
1081 if (!file)
Eric W. Biederman8760c902020-11-20 17:14:38 -06001082 return close_fd(fd);
Al Viro8280d162012-08-21 12:11:46 -04001083
1084 if (fd >= rlimit(RLIMIT_NOFILE))
Al Viro08f05c42012-10-31 03:37:48 +00001085 return -EBADF;
Al Viro8280d162012-08-21 12:11:46 -04001086
1087 spin_lock(&files->file_lock);
1088 err = expand_files(files, fd);
1089 if (unlikely(err < 0))
1090 goto out_unlock;
1091 return do_dup2(files, file, fd, flags);
1092
1093out_unlock:
1094 spin_unlock(&files->file_lock);
1095 return err;
1096}
1097
Kees Cook66590612020-06-10 08:20:05 -07001098/**
1099 * __receive_fd() - Install received file into file descriptor table
Kees Cook66590612020-06-10 08:20:05 -07001100 * @file: struct file that was received from another process
1101 * @ufd: __user pointer to write new fd number to
1102 * @o_flags: the O_* flags to apply to the new fd entry
1103 *
1104 * Installs a received file into the file descriptor table, with appropriate
Kees Cookdeefa7f2020-06-10 20:47:45 -07001105 * checks and count updates. Optionally writes the fd number to userspace, if
1106 * @ufd is non-NULL.
Kees Cook66590612020-06-10 08:20:05 -07001107 *
1108 * This helper handles its own reference counting of the incoming
1109 * struct file.
1110 *
Kees Cookdeefa7f2020-06-10 20:47:45 -07001111 * Returns newly install fd or -ve on error.
Kees Cook66590612020-06-10 08:20:05 -07001112 */
Christoph Hellwig42eb0d52021-03-25 09:22:09 +01001113int __receive_fd(struct file *file, int __user *ufd, unsigned int o_flags)
Kees Cook66590612020-06-10 08:20:05 -07001114{
1115 int new_fd;
1116 int error;
1117
1118 error = security_file_receive(file);
1119 if (error)
1120 return error;
1121
Christoph Hellwig42eb0d52021-03-25 09:22:09 +01001122 new_fd = get_unused_fd_flags(o_flags);
1123 if (new_fd < 0)
1124 return new_fd;
Kees Cook66590612020-06-10 08:20:05 -07001125
Kees Cookdeefa7f2020-06-10 20:47:45 -07001126 if (ufd) {
1127 error = put_user(new_fd, ufd);
1128 if (error) {
Christoph Hellwig42eb0d52021-03-25 09:22:09 +01001129 put_unused_fd(new_fd);
Kees Cookdeefa7f2020-06-10 20:47:45 -07001130 return error;
1131 }
Kees Cook66590612020-06-10 08:20:05 -07001132 }
1133
Christoph Hellwig42eb0d52021-03-25 09:22:09 +01001134 fd_install(new_fd, get_file(file));
1135 __receive_sock(file);
1136 return new_fd;
1137}
Kees Cook173817152020-06-10 08:46:58 -07001138
Christoph Hellwig42eb0d52021-03-25 09:22:09 +01001139int receive_fd_replace(int new_fd, struct file *file, unsigned int o_flags)
1140{
1141 int error;
1142
1143 error = security_file_receive(file);
1144 if (error)
1145 return error;
1146 error = replace_fd(new_fd, file, o_flags);
1147 if (error)
1148 return error;
Kees Cook66590612020-06-10 08:20:05 -07001149 __receive_sock(file);
Kees Cookdeefa7f2020-06-10 20:47:45 -07001150 return new_fd;
Kees Cook66590612020-06-10 08:20:05 -07001151}
1152
Xie Yongji9c930052021-08-31 18:36:24 +08001153int receive_fd(struct file *file, unsigned int o_flags)
1154{
1155 return __receive_fd(file, NULL, o_flags);
1156}
1157EXPORT_SYMBOL_GPL(receive_fd);
1158
Dominik Brodowskic7248322018-03-11 11:34:40 +01001159static int ksys_dup3(unsigned int oldfd, unsigned int newfd, int flags)
Al Virofe17f222012-08-21 11:48:11 -04001160{
1161 int err = -EBADF;
Al Viro8280d162012-08-21 12:11:46 -04001162 struct file *file;
1163 struct files_struct *files = current->files;
Al Virofe17f222012-08-21 11:48:11 -04001164
1165 if ((flags & ~O_CLOEXEC) != 0)
1166 return -EINVAL;
1167
Richard W.M. Jonesaed97642012-10-09 15:27:43 +01001168 if (unlikely(oldfd == newfd))
1169 return -EINVAL;
1170
Al Virofe17f222012-08-21 11:48:11 -04001171 if (newfd >= rlimit(RLIMIT_NOFILE))
Al Viro08f05c42012-10-31 03:37:48 +00001172 return -EBADF;
Al Virofe17f222012-08-21 11:48:11 -04001173
1174 spin_lock(&files->file_lock);
1175 err = expand_files(files, newfd);
Eric W. Biederman120ce2b2020-11-20 17:14:25 -06001176 file = files_lookup_fd_locked(files, oldfd);
Al Virofe17f222012-08-21 11:48:11 -04001177 if (unlikely(!file))
1178 goto Ebadf;
1179 if (unlikely(err < 0)) {
1180 if (err == -EMFILE)
1181 goto Ebadf;
1182 goto out_unlock;
1183 }
Al Viro8280d162012-08-21 12:11:46 -04001184 return do_dup2(files, file, newfd, flags);
Al Virofe17f222012-08-21 11:48:11 -04001185
1186Ebadf:
1187 err = -EBADF;
1188out_unlock:
1189 spin_unlock(&files->file_lock);
1190 return err;
1191}
1192
Dominik Brodowskic7248322018-03-11 11:34:40 +01001193SYSCALL_DEFINE3(dup3, unsigned int, oldfd, unsigned int, newfd, int, flags)
1194{
1195 return ksys_dup3(oldfd, newfd, flags);
1196}
1197
Al Virofe17f222012-08-21 11:48:11 -04001198SYSCALL_DEFINE2(dup2, unsigned int, oldfd, unsigned int, newfd)
1199{
1200 if (unlikely(newfd == oldfd)) { /* corner case */
1201 struct files_struct *files = current->files;
1202 int retval = oldfd;
1203
1204 rcu_read_lock();
Eric W. Biedermanf36c2942020-11-20 17:14:26 -06001205 if (!files_lookup_fd_rcu(files, oldfd))
Al Virofe17f222012-08-21 11:48:11 -04001206 retval = -EBADF;
1207 rcu_read_unlock();
1208 return retval;
1209 }
Dominik Brodowskic7248322018-03-11 11:34:40 +01001210 return ksys_dup3(oldfd, newfd, 0);
Al Virofe17f222012-08-21 11:48:11 -04001211}
1212
Christoph Hellwigbc1cd992020-07-14 08:58:49 +02001213SYSCALL_DEFINE1(dup, unsigned int, fildes)
Al Virofe17f222012-08-21 11:48:11 -04001214{
1215 int ret = -EBADF;
1216 struct file *file = fget_raw(fildes);
1217
1218 if (file) {
Yann Droneaud8d10a032014-12-10 15:45:44 -08001219 ret = get_unused_fd_flags(0);
Al Virofe17f222012-08-21 11:48:11 -04001220 if (ret >= 0)
1221 fd_install(ret, file);
1222 else
1223 fput(file);
1224 }
1225 return ret;
1226}
1227
1228int f_dupfd(unsigned int from, struct file *file, unsigned flags)
1229{
Eric W. Biedermane06b53c2020-11-20 17:14:36 -06001230 unsigned long nofile = rlimit(RLIMIT_NOFILE);
Al Virofe17f222012-08-21 11:48:11 -04001231 int err;
Eric W. Biedermane06b53c2020-11-20 17:14:36 -06001232 if (from >= nofile)
Al Virofe17f222012-08-21 11:48:11 -04001233 return -EINVAL;
Eric W. Biedermane06b53c2020-11-20 17:14:36 -06001234 err = alloc_fd(from, nofile, flags);
Al Virofe17f222012-08-21 11:48:11 -04001235 if (err >= 0) {
1236 get_file(file);
1237 fd_install(err, file);
1238 }
1239 return err;
1240}
Al Viroc3c073f2012-08-21 22:32:06 -04001241
1242int iterate_fd(struct files_struct *files, unsigned n,
1243 int (*f)(const void *, struct file *, unsigned),
1244 const void *p)
1245{
1246 struct fdtable *fdt;
Al Viroc3c073f2012-08-21 22:32:06 -04001247 int res = 0;
1248 if (!files)
1249 return 0;
1250 spin_lock(&files->file_lock);
Al Viroa77cfcb2012-11-29 22:57:33 -05001251 for (fdt = files_fdtable(files); n < fdt->max_fds; n++) {
1252 struct file *file;
1253 file = rcu_dereference_check_fdtable(files, fdt->fd[n]);
1254 if (!file)
1255 continue;
1256 res = f(p, file, n);
1257 if (res)
1258 break;
Al Viroc3c073f2012-08-21 22:32:06 -04001259 }
1260 spin_unlock(&files->file_lock);
1261 return res;
1262}
1263EXPORT_SYMBOL(iterate_fd);