Linux 5.16-rc5
[linux-2.6-block.git] / fs / file.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
1da177e4
LT
2/*
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
fe17f22d 10#include <linux/syscalls.h>
630d9c47 11#include <linux/export.h>
1da177e4 12#include <linux/fs.h>
278a5fba 13#include <linux/kernel.h>
1da177e4 14#include <linux/mm.h>
3f07c014 15#include <linux/sched/signal.h>
1da177e4 16#include <linux/slab.h>
1da177e4 17#include <linux/file.h>
9f3acc31 18#include <linux/fdtable.h>
1da177e4 19#include <linux/bitops.h>
ab2af1f5
DS
20#include <linux/spinlock.h>
21#include <linux/rcupdate.h>
60997c3d 22#include <linux/close_range.h>
66590610 23#include <net/sock.h>
ab2af1f5 24
53dec2ea
JA
25#include "internal.h"
26
9b80a184
AD
27unsigned int sysctl_nr_open __read_mostly = 1024*1024;
28unsigned int sysctl_nr_open_min = BITS_PER_LONG;
752343be
RV
29/* our min() is unusable in constant expressions ;-/ */
30#define __const_min(x, y) ((x) < (y) ? (x) : (y))
9b80a184
AD
31unsigned int sysctl_nr_open_max =
32 __const_min(INT_MAX, ~(size_t)0/sizeof(void *)) & -BITS_PER_LONG;
9cfe015a 33
a892e2d7 34static void __free_fdtable(struct fdtable *fdt)
1da177e4 35{
f6c0a192
AV
36 kvfree(fdt->fd);
37 kvfree(fdt->open_fds);
a892e2d7 38 kfree(fdt);
ab2af1f5 39}
1da177e4 40
7cf4dc3c 41static void free_fdtable_rcu(struct rcu_head *rcu)
ab2af1f5 42{
ac3e3c5b 43 __free_fdtable(container_of(rcu, struct fdtable, rcu));
ab2af1f5
DS
44}
45
f3f86e33
LT
46#define BITBIT_NR(nr) BITS_TO_LONGS(BITS_TO_LONGS(nr))
47#define BITBIT_SIZE(nr) (BITBIT_NR(nr) * sizeof(long))
48
ab2af1f5 49/*
ea5c58e7
EB
50 * 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.
ab2af1f5 75 */
5466b456 76static void copy_fdtable(struct fdtable *nfdt, struct fdtable *ofdt)
ab2af1f5 77{
4e89b721 78 size_t cpy, set;
ab2af1f5 79
5466b456 80 BUG_ON(nfdt->max_fds < ofdt->max_fds);
5466b456
VL
81
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);
ea5c58e7 85 memset((char *)nfdt->fd + cpy, 0, set);
5466b456 86
ea5c58e7 87 copy_fd_bitmaps(nfdt, ofdt, ofdt->max_fds);
1da177e4
LT
88}
89
5466b456 90static struct fdtable * alloc_fdtable(unsigned int nr)
1da177e4 91{
5466b456 92 struct fdtable *fdt;
1fd36adc 93 void *data;
1da177e4 94
ab2af1f5 95 /*
5466b456
VL
96 * 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.
ab2af1f5 101 */
5466b456
VL
102 nr /= (1024 / sizeof(struct file *));
103 nr = roundup_pow_of_two(nr + 1);
104 nr *= (1024 / sizeof(struct file *));
5c598b34
AV
105 /*
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;
bbea9f69 115
5d097056 116 fdt = kmalloc(sizeof(struct fdtable), GFP_KERNEL_ACCOUNT);
5466b456 117 if (!fdt)
bbea9f69 118 goto out;
5466b456 119 fdt->max_fds = nr;
c823bd92 120 data = kvmalloc_array(nr, sizeof(struct file *), GFP_KERNEL_ACCOUNT);
5466b456
VL
121 if (!data)
122 goto out_fdt;
1fd36adc
DH
123 fdt->fd = data;
124
c823bd92
MH
125 data = kvmalloc(max_t(size_t,
126 2 * nr / BITS_PER_BYTE + BITBIT_SIZE(nr), L1_CACHE_BYTES),
127 GFP_KERNEL_ACCOUNT);
5466b456
VL
128 if (!data)
129 goto out_arr;
1fd36adc 130 fdt->open_fds = data;
5466b456 131 data += nr / BITS_PER_BYTE;
1fd36adc 132 fdt->close_on_exec = data;
f3f86e33
LT
133 data += nr / BITS_PER_BYTE;
134 fdt->full_fds_bits = data;
5466b456 135
ab2af1f5 136 return fdt;
5466b456
VL
137
138out_arr:
f6c0a192 139 kvfree(fdt->fd);
5466b456 140out_fdt:
ab2af1f5 141 kfree(fdt);
5466b456 142out:
ab2af1f5
DS
143 return NULL;
144}
1da177e4 145
ab2af1f5 146/*
74d392aa
VL
147 * 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.
ab2af1f5 152 */
9b80a184 153static int expand_fdtable(struct files_struct *files, unsigned int nr)
ab2af1f5
DS
154 __releases(files->file_lock)
155 __acquires(files->file_lock)
156{
74d392aa 157 struct fdtable *new_fdt, *cur_fdt;
ab2af1f5
DS
158
159 spin_unlock(&files->file_lock);
74d392aa 160 new_fdt = alloc_fdtable(nr);
8a81252b 161
d74ba04d 162 /* make sure all fd_install() have seen resize_in_progress
8a81252b
ED
163 * or have finished their rcu_read_lock_sched() section.
164 */
165 if (atomic_read(&files->count) > 1)
c93ffc15 166 synchronize_rcu();
8a81252b 167
ab2af1f5 168 spin_lock(&files->file_lock);
74d392aa
VL
169 if (!new_fdt)
170 return -ENOMEM;
5c598b34
AV
171 /*
172 * 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)) {
a892e2d7 176 __free_fdtable(new_fdt);
5c598b34
AV
177 return -EMFILE;
178 }
74d392aa 179 cur_fdt = files_fdtable(files);
8a81252b
ED
180 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);
d74ba04d 185 /* coupled with smp_rmb() in fd_install() */
8a81252b 186 smp_wmb();
74d392aa 187 return 1;
1da177e4
LT
188}
189
190/*
191 * Expand files.
74d392aa
VL
192 * 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.
1da177e4 197 */
9b80a184 198static int expand_files(struct files_struct *files, unsigned int nr)
8a81252b
ED
199 __releases(files->file_lock)
200 __acquires(files->file_lock)
1da177e4 201{
badf1662 202 struct fdtable *fdt;
8a81252b 203 int expanded = 0;
1da177e4 204
8a81252b 205repeat:
badf1662 206 fdt = files_fdtable(files);
4e1e018e 207
74d392aa 208 /* Do we need to expand? */
bbea9f69 209 if (nr < fdt->max_fds)
8a81252b 210 return expanded;
4e1e018e 211
74d392aa 212 /* Can we expand? */
9cfe015a 213 if (nr >= sysctl_nr_open)
74d392aa
VL
214 return -EMFILE;
215
8a81252b
ED
216 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
74d392aa 224 /* All good, so we try */
8a81252b
ED
225 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;
1da177e4 231}
ab2af1f5 232
9b80a184 233static inline void __set_close_on_exec(unsigned int fd, struct fdtable *fdt)
b8318b01
AV
234{
235 __set_bit(fd, fdt->close_on_exec);
236}
237
9b80a184 238static inline void __clear_close_on_exec(unsigned int fd, struct fdtable *fdt)
b8318b01 239{
fc90888d
LT
240 if (test_bit(fd, fdt->close_on_exec))
241 __clear_bit(fd, fdt->close_on_exec);
b8318b01
AV
242}
243
f3f86e33 244static inline void __set_open_fd(unsigned int fd, struct fdtable *fdt)
b8318b01
AV
245{
246 __set_bit(fd, fdt->open_fds);
f3f86e33
LT
247 fd /= BITS_PER_LONG;
248 if (!~fdt->open_fds[fd])
249 __set_bit(fd, fdt->full_fds_bits);
b8318b01
AV
250}
251
f3f86e33 252static inline void __clear_open_fd(unsigned int fd, struct fdtable *fdt)
b8318b01
AV
253{
254 __clear_bit(fd, fdt->open_fds);
f3f86e33 255 __clear_bit(fd / BITS_PER_LONG, fdt->full_fds_bits);
b8318b01
AV
256}
257
9b80a184 258static unsigned int count_open_files(struct fdtable *fdt)
02afc626 259{
9b80a184
AD
260 unsigned int size = fdt->max_fds;
261 unsigned int i;
02afc626
AV
262
263 /* Find the last open fd */
1fd36adc
DH
264 for (i = size / BITS_PER_LONG; i > 0; ) {
265 if (fdt->open_fds[--i])
02afc626
AV
266 break;
267 }
1fd36adc 268 i = (i + 1) * BITS_PER_LONG;
02afc626
AV
269 return i;
270}
271
60997c3d
CB
272static 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
02afc626
AV
282/*
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 */
60997c3d 287struct files_struct *dup_fd(struct files_struct *oldf, unsigned int max_fds, int *errorp)
02afc626
AV
288{
289 struct files_struct *newf;
290 struct file **old_fds, **new_fds;
9b80a184 291 unsigned int open_files, i;
02afc626
AV
292 struct fdtable *old_fdt, *new_fdt;
293
294 *errorp = -ENOMEM;
afbec7ff 295 newf = kmem_cache_alloc(files_cachep, GFP_KERNEL);
02afc626
AV
296 if (!newf)
297 goto out;
298
afbec7ff
AV
299 atomic_set(&newf->count, 1);
300
301 spin_lock_init(&newf->file_lock);
8a81252b
ED
302 newf->resize_in_progress = false;
303 init_waitqueue_head(&newf->resize_wait);
afbec7ff
AV
304 newf->next_fd = 0;
305 new_fdt = &newf->fdtab;
306 new_fdt->max_fds = NR_OPEN_DEFAULT;
1fd36adc
DH
307 new_fdt->close_on_exec = newf->close_on_exec_init;
308 new_fdt->open_fds = newf->open_fds_init;
f3f86e33 309 new_fdt->full_fds_bits = newf->full_fds_bits_init;
afbec7ff 310 new_fdt->fd = &newf->fd_array[0];
afbec7ff 311
02afc626
AV
312 spin_lock(&oldf->file_lock);
313 old_fdt = files_fdtable(oldf);
60997c3d 314 open_files = sane_fdtable_size(old_fdt, max_fds);
02afc626
AV
315
316 /*
317 * Check whether we need to allocate a larger fd array and fd set.
02afc626 318 */
adbecb12 319 while (unlikely(open_files > new_fdt->max_fds)) {
02afc626 320 spin_unlock(&oldf->file_lock);
9dec3c4d 321
a892e2d7
CG
322 if (new_fdt != &newf->fdtab)
323 __free_fdtable(new_fdt);
adbecb12 324
9dec3c4d
AV
325 new_fdt = alloc_fdtable(open_files - 1);
326 if (!new_fdt) {
327 *errorp = -ENOMEM;
328 goto out_release;
329 }
330
331 /* beyond sysctl_nr_open; nothing to do */
332 if (unlikely(new_fdt->max_fds < open_files)) {
a892e2d7 333 __free_fdtable(new_fdt);
9dec3c4d 334 *errorp = -EMFILE;
02afc626 335 goto out_release;
9dec3c4d 336 }
9dec3c4d 337
02afc626
AV
338 /*
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);
60997c3d 345 open_files = sane_fdtable_size(old_fdt, max_fds);
02afc626
AV
346 }
347
ea5c58e7
EB
348 copy_fd_bitmaps(new_fdt, old_fdt, open_files);
349
02afc626
AV
350 old_fds = old_fdt->fd;
351 new_fds = new_fdt->fd;
352
02afc626
AV
353 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 */
1dce27c5 364 __clear_open_fd(open_files - i, new_fdt);
02afc626
AV
365 }
366 rcu_assign_pointer(*new_fds++, f);
367 }
368 spin_unlock(&oldf->file_lock);
369
ea5c58e7
EB
370 /* clear the remainder */
371 memset(new_fds, 0, (new_fdt->max_fds - open_files) * sizeof(struct file *));
02afc626 372
afbec7ff
AV
373 rcu_assign_pointer(newf->fdt, new_fdt);
374
02afc626
AV
375 return newf;
376
377out_release:
378 kmem_cache_free(files_cachep, newf);
379out:
380 return NULL;
381}
382
ce08b62d 383static struct fdtable *close_files(struct files_struct * files)
7cf4dc3c 384{
7cf4dc3c
AV
385 /*
386 * It is safe to dereference the fd table without RCU or
387 * ->file_lock because this is the last reference to the
ce08b62d 388 * files structure.
7cf4dc3c 389 */
ce08b62d 390 struct fdtable *fdt = rcu_dereference_raw(files->fdt);
9b80a184 391 unsigned int i, j = 0;
ce08b62d 392
7cf4dc3c
AV
393 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);
388a4c88 404 cond_resched();
7cf4dc3c
AV
405 }
406 }
407 i++;
408 set >>= 1;
409 }
410 }
ce08b62d
ON
411
412 return fdt;
7cf4dc3c
AV
413}
414
7cf4dc3c
AV
415void put_files_struct(struct files_struct *files)
416{
7cf4dc3c 417 if (atomic_dec_and_test(&files->count)) {
ce08b62d
ON
418 struct fdtable *fdt = close_files(files);
419
b9e02af0
AV
420 /* free the arrays if they are not embedded */
421 if (fdt != &files->fdtab)
422 __free_fdtable(fdt);
423 kmem_cache_free(files_cachep, files);
7cf4dc3c
AV
424 }
425}
426
7cf4dc3c
AV
427void 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
f52111b1
AV
439struct 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],
1fd36adc
DH
445 .close_on_exec = init_files.close_on_exec_init,
446 .open_fds = init_files.open_fds_init,
f3f86e33 447 .full_fds_bits = init_files.full_fds_bits_init,
f52111b1 448 },
eece09ec 449 .file_lock = __SPIN_LOCK_UNLOCKED(init_files.file_lock),
5704a068 450 .resize_wait = __WAIT_QUEUE_HEAD_INITIALIZER(init_files.resize_wait),
f52111b1 451};
1027abe8 452
9b80a184 453static unsigned int find_next_fd(struct fdtable *fdt, unsigned int start)
f3f86e33 454{
9b80a184
AD
455 unsigned int maxfd = fdt->max_fds;
456 unsigned int maxbit = maxfd / BITS_PER_LONG;
457 unsigned int bitbit = start / BITS_PER_LONG;
f3f86e33
LT
458
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
1027abe8
AV
467/*
468 * allocate a file descriptor, mark it busy.
469 */
aa384d10 470static int alloc_fd(unsigned start, unsigned end, unsigned flags)
1027abe8 471{
aa384d10 472 struct files_struct *files = current->files;
1027abe8
AV
473 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)
f3f86e33 485 fd = find_next_fd(fdt, fd);
1027abe8 486
f33ff992
AV
487 /*
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
1027abe8
AV
495 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
1dce27c5 509 __set_open_fd(fd, fdt);
1027abe8 510 if (flags & O_CLOEXEC)
1dce27c5 511 __set_close_on_exec(fd, fdt);
1027abe8 512 else
1dce27c5 513 __clear_close_on_exec(fd, fdt);
1027abe8
AV
514 error = fd;
515#if 1
516 /* Sanity check */
add1f099 517 if (rcu_access_pointer(fdt->fd[fd]) != NULL) {
1027abe8
AV
518 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
4022e7af
JA
528int __get_unused_fd_flags(unsigned flags, unsigned long nofile)
529{
aa384d10 530 return alloc_fd(0, nofile, flags);
4022e7af
JA
531}
532
1a7bd226 533int get_unused_fd_flags(unsigned flags)
1027abe8 534{
4022e7af 535 return __get_unused_fd_flags(flags, rlimit(RLIMIT_NOFILE));
1027abe8 536}
1a7bd226 537EXPORT_SYMBOL(get_unused_fd_flags);
56007cae
AV
538
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.
f869e8a7 568 *
d74ba04d
EB
569 * This consumes the "file" refcount, so callers should treat it
570 * as if they had called fput(file).
56007cae
AV
571 */
572
d74ba04d 573void fd_install(unsigned int fd, struct file *file)
56007cae 574{
d74ba04d 575 struct files_struct *files = current->files;
56007cae 576 struct fdtable *fdt;
8a81252b 577
8a81252b
ED
578 rcu_read_lock_sched();
579
c02b1a9b 580 if (unlikely(files->resize_in_progress)) {
8a81252b 581 rcu_read_unlock_sched();
c02b1a9b
MG
582 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;
8a81252b
ED
588 }
589 /* coupled with smp_wmb() in expand_fdtable() */
590 smp_rmb();
591 fdt = rcu_dereference_sched(files->fdt);
56007cae
AV
592 BUG_ON(fdt->fd[fd] != NULL);
593 rcu_assign_pointer(fdt->fd[fd], file);
8a81252b 594 rcu_read_unlock_sched();
56007cae
AV
595}
596
597EXPORT_SYMBOL(fd_install);
0ee8cdfe 598
f49fd6d3
CB
599/**
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 */
278a5fba 609static struct file *pick_file(struct files_struct *files, unsigned fd)
483ce1d4 610{
f49fd6d3 611 struct file *file;
483ce1d4
AV
612 struct fdtable *fdt;
613
614 spin_lock(&files->file_lock);
615 fdt = files_fdtable(files);
f49fd6d3
CB
616 if (fd >= fdt->max_fds) {
617 file = ERR_PTR(-EINVAL);
483ce1d4 618 goto out_unlock;
f49fd6d3 619 }
483ce1d4 620 file = fdt->fd[fd];
f49fd6d3
CB
621 if (!file) {
622 file = ERR_PTR(-EBADF);
483ce1d4 623 goto out_unlock;
f49fd6d3 624 }
483ce1d4 625 rcu_assign_pointer(fdt->fd[fd], NULL);
483ce1d4 626 __put_unused_fd(files, fd);
483ce1d4
AV
627
628out_unlock:
629 spin_unlock(&files->file_lock);
278a5fba
CB
630 return file;
631}
632
8760c909 633int close_fd(unsigned fd)
278a5fba 634{
8760c909 635 struct files_struct *files = current->files;
278a5fba
CB
636 struct file *file;
637
638 file = pick_file(files, fd);
f49fd6d3 639 if (IS_ERR(file))
278a5fba
CB
640 return -EBADF;
641
642 return filp_close(file, files);
483ce1d4 643}
8760c909 644EXPORT_SYMBOL(close_fd); /* for ksys_close() */
483ce1d4 645
9b5b8722
CB
646/**
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
582f1fb6
GS
659static inline void __range_cloexec(struct files_struct *cur_fds,
660 unsigned int fd, unsigned int max_fd)
661{
662 struct fdtable *fdt;
663
9b5b8722 664 /* make sure we're using the correct maximum value */
582f1fb6
GS
665 spin_lock(&cur_fds->file_lock);
666 fdt = files_fdtable(cur_fds);
9b5b8722
CB
667 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);
582f1fb6
GS
670 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++);
f49fd6d3
CB
680 if (!IS_ERR(file)) {
681 /* found a valid file to close */
682 filp_close(file, cur_fds);
683 cond_resched();
582f1fb6 684 continue;
f49fd6d3 685 }
582f1fb6 686
f49fd6d3
CB
687 /* beyond the last fd in that table */
688 if (PTR_ERR(file) == -EINVAL)
689 return;
582f1fb6
GS
690 }
691}
692
278a5fba
CB
693/**
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 */
60997c3d 702int __close_range(unsigned fd, unsigned max_fd, unsigned int flags)
278a5fba 703{
60997c3d
CB
704 struct task_struct *me = current;
705 struct files_struct *cur_fds = me->files, *fds = NULL;
706
582f1fb6 707 if (flags & ~(CLOSE_RANGE_UNSHARE | CLOSE_RANGE_CLOEXEC))
60997c3d 708 return -EINVAL;
278a5fba
CB
709
710 if (fd > max_fd)
711 return -EINVAL;
712
60997c3d
CB
713 if (flags & CLOSE_RANGE_UNSHARE) {
714 int ret;
715 unsigned int max_unshare_fds = NR_OPEN_MAX;
716
717 /*
03ba0fe4
CB
718 * 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.
60997c3d 721 */
03ba0fe4
CB
722 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 }
60997c3d
CB
733
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
582f1fb6
GS
746 if (flags & CLOSE_RANGE_CLOEXEC)
747 __range_cloexec(cur_fds, fd, max_fd);
748 else
749 __range_close(cur_fds, fd, max_fd);
278a5fba 750
60997c3d
CB
751 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
278a5fba
CB
762 return 0;
763}
764
80cd7956 765/*
53dec2ea
JA
766 * See close_fd_get_file() below, this variant assumes current->files->file_lock
767 * is held.
80cd7956 768 */
53dec2ea 769int __close_fd_get_file(unsigned int fd, struct file **res)
80cd7956
TK
770{
771 struct files_struct *files = current->files;
772 struct file *file;
773 struct fdtable *fdt;
774
80cd7956
TK
775 fdt = files_fdtable(files);
776 if (fd >= fdt->max_fds)
53dec2ea 777 goto out_err;
80cd7956
TK
778 file = fdt->fd[fd];
779 if (!file)
53dec2ea 780 goto out_err;
80cd7956
TK
781 rcu_assign_pointer(fdt->fd[fd], NULL);
782 __put_unused_fd(files, fd);
80cd7956
TK
783 get_file(file);
784 *res = file;
6e802a4b 785 return 0;
53dec2ea 786out_err:
80cd7956
TK
787 *res = NULL;
788 return -ENOENT;
789}
790
53dec2ea
JA
791/*
792 * variant of close_fd that gets a ref on the file for later fput.
793 * The caller must ensure that filp_close() called on the file, and then
794 * an fput().
795 */
796int close_fd_get_file(unsigned int fd, struct file **res)
797{
798 struct files_struct *files = current->files;
799 int ret;
800
801 spin_lock(&files->file_lock);
802 ret = __close_fd_get_file(fd, res);
803 spin_unlock(&files->file_lock);
804
805 return ret;
806}
807
6a6d27de
AV
808void do_close_on_exec(struct files_struct *files)
809{
810 unsigned i;
811 struct fdtable *fdt;
812
813 /* exec unshares first */
6a6d27de
AV
814 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
5e876fb4
SD
844static struct file *__fget_files(struct files_struct *files, unsigned int fd,
845 fmode_t mask, unsigned int refs)
0ee8cdfe 846{
1deb46e2 847 struct file *file;
0ee8cdfe
AV
848
849 rcu_read_lock();
5ba97d28 850loop:
f36c2943 851 file = files_lookup_fd_rcu(files, fd);
0ee8cdfe 852 if (file) {
5ba97d28
ED
853 /* 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)
0ee8cdfe 858 file = NULL;
091141a4 859 else if (!get_file_rcu_many(file, refs))
5ba97d28 860 goto loop;
054aa8d4
LT
861 else if (files_lookup_fd_raw(files, fd) != file) {
862 fput_many(file, refs);
863 goto loop;
864 }
0ee8cdfe
AV
865 }
866 rcu_read_unlock();
867
868 return file;
869}
870
5e876fb4
SD
871static inline struct file *__fget(unsigned int fd, fmode_t mask,
872 unsigned int refs)
873{
874 return __fget_files(current->files, fd, mask, refs);
875}
876
091141a4
JA
877struct file *fget_many(unsigned int fd, unsigned int refs)
878{
879 return __fget(fd, FMODE_PATH, refs);
880}
881
1deb46e2
ON
882struct file *fget(unsigned int fd)
883{
091141a4 884 return __fget(fd, FMODE_PATH, 1);
1deb46e2 885}
0ee8cdfe
AV
886EXPORT_SYMBOL(fget);
887
888struct file *fget_raw(unsigned int fd)
889{
091141a4 890 return __fget(fd, 0, 1);
0ee8cdfe 891}
0ee8cdfe
AV
892EXPORT_SYMBOL(fget_raw);
893
5e876fb4
SD
894struct file *fget_task(struct task_struct *task, unsigned int fd)
895{
896 struct file *file = NULL;
897
898 task_lock(task);
899 if (task->files)
900 file = __fget_files(task->files, fd, 0, 1);
901 task_unlock(task);
902
903 return file;
904}
905
3a879fb3
EB
906struct file *task_lookup_fd_rcu(struct task_struct *task, unsigned int fd)
907{
908 /* Must be called with rcu_read_lock held */
909 struct files_struct *files;
910 struct file *file = NULL;
911
912 task_lock(task);
913 files = task->files;
914 if (files)
915 file = files_lookup_fd_rcu(files, fd);
916 task_unlock(task);
917
918 return file;
919}
920
e9a53aeb
EB
921struct file *task_lookup_next_fd_rcu(struct task_struct *task, unsigned int *ret_fd)
922{
923 /* Must be called with rcu_read_lock held */
924 struct files_struct *files;
925 unsigned int fd = *ret_fd;
926 struct file *file = NULL;
927
928 task_lock(task);
929 files = task->files;
930 if (files) {
931 for (; fd < files_fdtable(files)->max_fds; fd++) {
932 file = files_lookup_fd_rcu(files, fd);
933 if (file)
934 break;
935 }
936 }
937 task_unlock(task);
938 *ret_fd = fd;
939 return file;
940}
941
0ee8cdfe
AV
942/*
943 * Lightweight file lookup - no refcnt increment if fd table isn't shared.
944 *
945 * You can use this instead of fget if you satisfy all of the following
946 * conditions:
947 * 1) You must call fput_light before exiting the syscall and returning control
948 * to userspace (i.e. you cannot remember the returned struct file * after
949 * returning to userspace).
950 * 2) You must not call filp_close on the returned struct file * in between
951 * calls to fget_light and fput_light.
952 * 3) You must not clone the current task in between the calls to fget_light
953 * and fput_light.
954 *
955 * The fput_needed flag returned by fget_light should be passed to the
956 * corresponding fput_light.
957 */
bd2a31d5 958static unsigned long __fget_light(unsigned int fd, fmode_t mask)
0ee8cdfe 959{
0ee8cdfe 960 struct files_struct *files = current->files;
ad461834 961 struct file *file;
0ee8cdfe 962
0ee8cdfe 963 if (atomic_read(&files->count) == 1) {
bebf684b 964 file = files_lookup_fd_raw(files, fd);
bd2a31d5
AV
965 if (!file || unlikely(file->f_mode & mask))
966 return 0;
967 return (unsigned long)file;
0ee8cdfe 968 } else {
091141a4 969 file = __fget(fd, mask, 1);
bd2a31d5
AV
970 if (!file)
971 return 0;
972 return FDPUT_FPUT | (unsigned long)file;
0ee8cdfe 973 }
0ee8cdfe 974}
bd2a31d5 975unsigned long __fdget(unsigned int fd)
ad461834 976{
bd2a31d5 977 return __fget_light(fd, FMODE_PATH);
ad461834 978}
bd2a31d5 979EXPORT_SYMBOL(__fdget);
0ee8cdfe 980
bd2a31d5 981unsigned long __fdget_raw(unsigned int fd)
0ee8cdfe 982{
bd2a31d5 983 return __fget_light(fd, 0);
0ee8cdfe 984}
fe17f22d 985
bd2a31d5
AV
986unsigned long __fdget_pos(unsigned int fd)
987{
99aea681
EB
988 unsigned long v = __fdget(fd);
989 struct file *file = (struct file *)(v & ~3);
bd2a31d5 990
2be7d348 991 if (file && (file->f_mode & FMODE_ATOMIC_POS)) {
bd2a31d5
AV
992 if (file_count(file) > 1) {
993 v |= FDPUT_POS_UNLOCK;
994 mutex_lock(&file->f_pos_lock);
995 }
996 }
99aea681 997 return v;
bd2a31d5
AV
998}
999
63b6df14
AV
1000void __f_unlock_pos(struct file *f)
1001{
1002 mutex_unlock(&f->f_pos_lock);
1003}
1004
bd2a31d5
AV
1005/*
1006 * We only lock f_pos if we have threads or if the file might be
1007 * shared with another process. In both cases we'll have an elevated
1008 * file count (done either by fdget() or by fork()).
1009 */
1010
fe17f22d
AV
1011void set_close_on_exec(unsigned int fd, int flag)
1012{
1013 struct files_struct *files = current->files;
1014 struct fdtable *fdt;
1015 spin_lock(&files->file_lock);
1016 fdt = files_fdtable(files);
1017 if (flag)
1018 __set_close_on_exec(fd, fdt);
1019 else
1020 __clear_close_on_exec(fd, fdt);
1021 spin_unlock(&files->file_lock);
1022}
1023
1024bool get_close_on_exec(unsigned int fd)
1025{
1026 struct files_struct *files = current->files;
1027 struct fdtable *fdt;
1028 bool res;
1029 rcu_read_lock();
1030 fdt = files_fdtable(files);
1031 res = close_on_exec(fd, fdt);
1032 rcu_read_unlock();
1033 return res;
1034}
1035
8280d161
AV
1036static int do_dup2(struct files_struct *files,
1037 struct file *file, unsigned fd, unsigned flags)
e983094d 1038__releases(&files->file_lock)
fe17f22d 1039{
8280d161 1040 struct file *tofree;
fe17f22d
AV
1041 struct fdtable *fdt;
1042
fe17f22d
AV
1043 /*
1044 * We need to detect attempts to do dup2() over allocated but still
1045 * not finished descriptor. NB: OpenBSD avoids that at the price of
1046 * extra work in their equivalent of fget() - they insert struct
1047 * file immediately after grabbing descriptor, mark it larval if
1048 * more work (e.g. actual opening) is needed and make sure that
1049 * fget() treats larval files as absent. Potentially interesting,
1050 * but while extra work in fget() is trivial, locking implications
1051 * and amount of surgery on open()-related paths in VFS are not.
1052 * FreeBSD fails with -EBADF in the same situation, NetBSD "solution"
1053 * deadlocks in rather amusing ways, AFAICS. All of that is out of
1054 * scope of POSIX or SUS, since neither considers shared descriptor
1055 * tables and this condition does not arise without those.
1056 */
fe17f22d 1057 fdt = files_fdtable(files);
8280d161
AV
1058 tofree = fdt->fd[fd];
1059 if (!tofree && fd_is_open(fd, fdt))
1060 goto Ebusy;
fe17f22d 1061 get_file(file);
8280d161
AV
1062 rcu_assign_pointer(fdt->fd[fd], file);
1063 __set_open_fd(fd, fdt);
fe17f22d 1064 if (flags & O_CLOEXEC)
8280d161 1065 __set_close_on_exec(fd, fdt);
fe17f22d 1066 else
8280d161 1067 __clear_close_on_exec(fd, fdt);
fe17f22d
AV
1068 spin_unlock(&files->file_lock);
1069
1070 if (tofree)
1071 filp_close(tofree, files);
1072
8280d161
AV
1073 return fd;
1074
1075Ebusy:
1076 spin_unlock(&files->file_lock);
1077 return -EBUSY;
1078}
1079
1080int replace_fd(unsigned fd, struct file *file, unsigned flags)
1081{
1082 int err;
1083 struct files_struct *files = current->files;
1084
1085 if (!file)
8760c909 1086 return close_fd(fd);
8280d161
AV
1087
1088 if (fd >= rlimit(RLIMIT_NOFILE))
08f05c49 1089 return -EBADF;
8280d161
AV
1090
1091 spin_lock(&files->file_lock);
1092 err = expand_files(files, fd);
1093 if (unlikely(err < 0))
1094 goto out_unlock;
1095 return do_dup2(files, file, fd, flags);
1096
1097out_unlock:
1098 spin_unlock(&files->file_lock);
1099 return err;
1100}
1101
66590610
KC
1102/**
1103 * __receive_fd() - Install received file into file descriptor table
66590610
KC
1104 * @file: struct file that was received from another process
1105 * @ufd: __user pointer to write new fd number to
1106 * @o_flags: the O_* flags to apply to the new fd entry
1107 *
1108 * Installs a received file into the file descriptor table, with appropriate
deefa7f3
KC
1109 * checks and count updates. Optionally writes the fd number to userspace, if
1110 * @ufd is non-NULL.
66590610
KC
1111 *
1112 * This helper handles its own reference counting of the incoming
1113 * struct file.
1114 *
deefa7f3 1115 * Returns newly install fd or -ve on error.
66590610 1116 */
42eb0d54 1117int __receive_fd(struct file *file, int __user *ufd, unsigned int o_flags)
66590610
KC
1118{
1119 int new_fd;
1120 int error;
1121
1122 error = security_file_receive(file);
1123 if (error)
1124 return error;
1125
42eb0d54
CH
1126 new_fd = get_unused_fd_flags(o_flags);
1127 if (new_fd < 0)
1128 return new_fd;
66590610 1129
deefa7f3
KC
1130 if (ufd) {
1131 error = put_user(new_fd, ufd);
1132 if (error) {
42eb0d54 1133 put_unused_fd(new_fd);
deefa7f3
KC
1134 return error;
1135 }
66590610
KC
1136 }
1137
42eb0d54
CH
1138 fd_install(new_fd, get_file(file));
1139 __receive_sock(file);
1140 return new_fd;
1141}
17381715 1142
42eb0d54
CH
1143int receive_fd_replace(int new_fd, struct file *file, unsigned int o_flags)
1144{
1145 int error;
1146
1147 error = security_file_receive(file);
1148 if (error)
1149 return error;
1150 error = replace_fd(new_fd, file, o_flags);
1151 if (error)
1152 return error;
66590610 1153 __receive_sock(file);
deefa7f3 1154 return new_fd;
66590610
KC
1155}
1156
9c930054
XY
1157int receive_fd(struct file *file, unsigned int o_flags)
1158{
1159 return __receive_fd(file, NULL, o_flags);
1160}
1161EXPORT_SYMBOL_GPL(receive_fd);
1162
c7248321 1163static int ksys_dup3(unsigned int oldfd, unsigned int newfd, int flags)
8280d161
AV
1164{
1165 int err = -EBADF;
1166 struct file *file;
1167 struct files_struct *files = current->files;
1168
1169 if ((flags & ~O_CLOEXEC) != 0)
1170 return -EINVAL;
1171
aed97647
RJ
1172 if (unlikely(oldfd == newfd))
1173 return -EINVAL;
1174
8280d161 1175 if (newfd >= rlimit(RLIMIT_NOFILE))
08f05c49 1176 return -EBADF;
8280d161
AV
1177
1178 spin_lock(&files->file_lock);
1179 err = expand_files(files, newfd);
120ce2b0 1180 file = files_lookup_fd_locked(files, oldfd);
8280d161
AV
1181 if (unlikely(!file))
1182 goto Ebadf;
1183 if (unlikely(err < 0)) {
1184 if (err == -EMFILE)
1185 goto Ebadf;
1186 goto out_unlock;
1187 }
1188 return do_dup2(files, file, newfd, flags);
fe17f22d
AV
1189
1190Ebadf:
1191 err = -EBADF;
1192out_unlock:
1193 spin_unlock(&files->file_lock);
1194 return err;
1195}
1196
c7248321
DB
1197SYSCALL_DEFINE3(dup3, unsigned int, oldfd, unsigned int, newfd, int, flags)
1198{
1199 return ksys_dup3(oldfd, newfd, flags);
1200}
1201
fe17f22d
AV
1202SYSCALL_DEFINE2(dup2, unsigned int, oldfd, unsigned int, newfd)
1203{
1204 if (unlikely(newfd == oldfd)) { /* corner case */
1205 struct files_struct *files = current->files;
1206 int retval = oldfd;
1207
1208 rcu_read_lock();
f36c2943 1209 if (!files_lookup_fd_rcu(files, oldfd))
fe17f22d
AV
1210 retval = -EBADF;
1211 rcu_read_unlock();
1212 return retval;
1213 }
c7248321 1214 return ksys_dup3(oldfd, newfd, 0);
fe17f22d
AV
1215}
1216
bc1cd99a 1217SYSCALL_DEFINE1(dup, unsigned int, fildes)
fe17f22d
AV
1218{
1219 int ret = -EBADF;
1220 struct file *file = fget_raw(fildes);
1221
1222 if (file) {
8d10a035 1223 ret = get_unused_fd_flags(0);
fe17f22d
AV
1224 if (ret >= 0)
1225 fd_install(ret, file);
1226 else
1227 fput(file);
1228 }
1229 return ret;
1230}
1231
1232int f_dupfd(unsigned int from, struct file *file, unsigned flags)
1233{
e06b53c2 1234 unsigned long nofile = rlimit(RLIMIT_NOFILE);
fe17f22d 1235 int err;
e06b53c2 1236 if (from >= nofile)
fe17f22d 1237 return -EINVAL;
e06b53c2 1238 err = alloc_fd(from, nofile, flags);
fe17f22d
AV
1239 if (err >= 0) {
1240 get_file(file);
1241 fd_install(err, file);
1242 }
1243 return err;
1244}
c3c073f8
AV
1245
1246int iterate_fd(struct files_struct *files, unsigned n,
1247 int (*f)(const void *, struct file *, unsigned),
1248 const void *p)
1249{
1250 struct fdtable *fdt;
c3c073f8
AV
1251 int res = 0;
1252 if (!files)
1253 return 0;
1254 spin_lock(&files->file_lock);
a77cfcb4
AV
1255 for (fdt = files_fdtable(files); n < fdt->max_fds; n++) {
1256 struct file *file;
1257 file = rcu_dereference_check_fdtable(files, fdt->fd[n]);
1258 if (!file)
1259 continue;
1260 res = f(p, file, n);
1261 if (res)
1262 break;
c3c073f8
AV
1263 }
1264 spin_unlock(&files->file_lock);
1265 return res;
1266}
1267EXPORT_SYMBOL(iterate_fd);