1 // SPDX-License-Identifier: GPL-2.0
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
10 #include <linux/syscalls.h>
11 #include <linux/export.h>
12 #include <linux/fs.h>
13 #include <linux/kernel.h>
14 #include <linux/mm.h>
15 #include <linux/sched/signal.h>
16 #include <linux/slab.h>
17 #include <linux/file.h>
18 #include <linux/fdtable.h>
19 #include <linux/bitops.h>
20 #include <linux/spinlock.h>
21 #include <linux/rcupdate.h>
22 #include <linux/close_range.h>
23 #include <net/sock.h>
24
25 unsigned int sysctl_nr_open __read_mostly = 1024*1024;
26 unsigned int sysctl_nr_open_min = BITS_PER_LONG;
27 /* our min() is unusable in constant expressions ;-/ */
28 #define __const_min(x, y) ((x) < (y) ? (x) : (y))
29 unsigned int sysctl_nr_open_max =
30 __const_min(INT_MAX, ~(size_t)0/sizeof(void *)) & -BITS_PER_LONG;
31
__free_fdtable(struct fdtable * fdt)32 static void __free_fdtable(struct fdtable *fdt)
33 {
34 kvfree(fdt->fd);
35 kvfree(fdt->open_fds);
36 kfree(fdt);
37 }
38
free_fdtable_rcu(struct rcu_head * rcu)39 static void free_fdtable_rcu(struct rcu_head *rcu)
40 {
41 __free_fdtable(container_of(rcu, struct fdtable, rcu));
42 }
43
44 #define BITBIT_NR(nr) BITS_TO_LONGS(BITS_TO_LONGS(nr))
45 #define BITBIT_SIZE(nr) (BITBIT_NR(nr) * sizeof(long))
46
47 /*
48 * Copy 'count' fd bits from the old table to the new table and clear the extra
49 * space if any. This does not copy the file pointers. Called with the files
50 * spinlock held for write.
51 */
copy_fd_bitmaps(struct fdtable * nfdt,struct fdtable * ofdt,unsigned int count)52 static void copy_fd_bitmaps(struct fdtable *nfdt, struct fdtable *ofdt,
53 unsigned int count)
54 {
55 unsigned int cpy, set;
56
57 cpy = count / BITS_PER_BYTE;
58 set = (nfdt->max_fds - count) / BITS_PER_BYTE;
59 memcpy(nfdt->open_fds, ofdt->open_fds, cpy);
60 memset((char *)nfdt->open_fds + cpy, 0, set);
61 memcpy(nfdt->close_on_exec, ofdt->close_on_exec, cpy);
62 memset((char *)nfdt->close_on_exec + cpy, 0, set);
63
64 cpy = BITBIT_SIZE(count);
65 set = BITBIT_SIZE(nfdt->max_fds) - cpy;
66 memcpy(nfdt->full_fds_bits, ofdt->full_fds_bits, cpy);
67 memset((char *)nfdt->full_fds_bits + cpy, 0, set);
68 }
69
70 /*
71 * Copy all file descriptors from the old table to the new, expanded table and
72 * clear the extra space. Called with the files spinlock held for write.
73 */
copy_fdtable(struct fdtable * nfdt,struct fdtable * ofdt)74 static void copy_fdtable(struct fdtable *nfdt, struct fdtable *ofdt)
75 {
76 size_t cpy, set;
77
78 BUG_ON(nfdt->max_fds < ofdt->max_fds);
79
80 cpy = ofdt->max_fds * sizeof(struct file *);
81 set = (nfdt->max_fds - ofdt->max_fds) * sizeof(struct file *);
82 memcpy(nfdt->fd, ofdt->fd, cpy);
83 memset((char *)nfdt->fd + cpy, 0, set);
84
85 copy_fd_bitmaps(nfdt, ofdt, ofdt->max_fds);
86 }
87
alloc_fdtable(unsigned int nr)88 static struct fdtable * alloc_fdtable(unsigned int nr)
89 {
90 struct fdtable *fdt;
91 void *data;
92
93 /*
94 * Figure out how many fds we actually want to support in this fdtable.
95 * Allocation steps are keyed to the size of the fdarray, since it
96 * grows far faster than any of the other dynamic data. We try to fit
97 * the fdarray into comfortable page-tuned chunks: starting at 1024B
98 * and growing in powers of two from there on.
99 */
100 nr /= (1024 / sizeof(struct file *));
101 nr = roundup_pow_of_two(nr + 1);
102 nr *= (1024 / sizeof(struct file *));
103 /*
104 * Note that this can drive nr *below* what we had passed if sysctl_nr_open
105 * had been set lower between the check in expand_files() and here. Deal
106 * with that in caller, it's cheaper that way.
107 *
108 * We make sure that nr remains a multiple of BITS_PER_LONG - otherwise
109 * bitmaps handling below becomes unpleasant, to put it mildly...
110 */
111 if (unlikely(nr > sysctl_nr_open))
112 nr = ((sysctl_nr_open - 1) | (BITS_PER_LONG - 1)) + 1;
113
114 fdt = kmalloc(sizeof(struct fdtable), GFP_KERNEL_ACCOUNT);
115 if (!fdt)
116 goto out;
117 fdt->max_fds = nr;
118 data = kvmalloc_array(nr, sizeof(struct file *), GFP_KERNEL_ACCOUNT);
119 if (!data)
120 goto out_fdt;
121 fdt->fd = data;
122
123 data = kvmalloc(max_t(size_t,
124 2 * nr / BITS_PER_BYTE + BITBIT_SIZE(nr), L1_CACHE_BYTES),
125 GFP_KERNEL_ACCOUNT);
126 if (!data)
127 goto out_arr;
128 fdt->open_fds = data;
129 data += nr / BITS_PER_BYTE;
130 fdt->close_on_exec = data;
131 data += nr / BITS_PER_BYTE;
132 fdt->full_fds_bits = data;
133
134 return fdt;
135
136 out_arr:
137 kvfree(fdt->fd);
138 out_fdt:
139 kfree(fdt);
140 out:
141 return NULL;
142 }
143
144 /*
145 * Expand the file descriptor table.
146 * This function will allocate a new fdtable and both fd array and fdset, of
147 * the given size.
148 * Return <0 error code on error; 1 on successful completion.
149 * The files->file_lock should be held on entry, and will be held on exit.
150 */
expand_fdtable(struct files_struct * files,unsigned int nr)151 static int expand_fdtable(struct files_struct *files, unsigned int nr)
152 __releases(files->file_lock)
153 __acquires(files->file_lock)
154 {
155 struct fdtable *new_fdt, *cur_fdt;
156
157 spin_unlock(&files->file_lock);
158 new_fdt = alloc_fdtable(nr);
159
160 /* make sure all __fd_install() have seen resize_in_progress
161 * or have finished their rcu_read_lock_sched() section.
162 */
163 if (atomic_read(&files->count) > 1)
164 synchronize_rcu();
165
166 spin_lock(&files->file_lock);
167 if (!new_fdt)
168 return -ENOMEM;
169 /*
170 * extremely unlikely race - sysctl_nr_open decreased between the check in
171 * caller and alloc_fdtable(). Cheaper to catch it here...
172 */
173 if (unlikely(new_fdt->max_fds <= nr)) {
174 __free_fdtable(new_fdt);
175 return -EMFILE;
176 }
177 cur_fdt = files_fdtable(files);
178 BUG_ON(nr < cur_fdt->max_fds);
179 copy_fdtable(new_fdt, cur_fdt);
180 rcu_assign_pointer(files->fdt, new_fdt);
181 if (cur_fdt != &files->fdtab)
182 call_rcu(&cur_fdt->rcu, free_fdtable_rcu);
183 /* coupled with smp_rmb() in __fd_install() */
184 smp_wmb();
185 return 1;
186 }
187
188 /*
189 * Expand files.
190 * This function will expand the file structures, if the requested size exceeds
191 * the current capacity and there is room for expansion.
192 * Return <0 error code on error; 0 when nothing done; 1 when files were
193 * expanded and execution may have blocked.
194 * The files->file_lock should be held on entry, and will be held on exit.
195 */
expand_files(struct files_struct * files,unsigned int nr)196 static int expand_files(struct files_struct *files, unsigned int nr)
197 __releases(files->file_lock)
198 __acquires(files->file_lock)
199 {
200 struct fdtable *fdt;
201 int expanded = 0;
202
203 repeat:
204 fdt = files_fdtable(files);
205
206 /* Do we need to expand? */
207 if (nr < fdt->max_fds)
208 return expanded;
209
210 /* Can we expand? */
211 if (nr >= sysctl_nr_open)
212 return -EMFILE;
213
214 if (unlikely(files->resize_in_progress)) {
215 spin_unlock(&files->file_lock);
216 expanded = 1;
217 wait_event(files->resize_wait, !files->resize_in_progress);
218 spin_lock(&files->file_lock);
219 goto repeat;
220 }
221
222 /* All good, so we try */
223 files->resize_in_progress = true;
224 expanded = expand_fdtable(files, nr);
225 files->resize_in_progress = false;
226
227 wake_up_all(&files->resize_wait);
228 return expanded;
229 }
230
__set_close_on_exec(unsigned int fd,struct fdtable * fdt)231 static inline void __set_close_on_exec(unsigned int fd, struct fdtable *fdt)
232 {
233 __set_bit(fd, fdt->close_on_exec);
234 }
235
__clear_close_on_exec(unsigned int fd,struct fdtable * fdt)236 static inline void __clear_close_on_exec(unsigned int fd, struct fdtable *fdt)
237 {
238 if (test_bit(fd, fdt->close_on_exec))
239 __clear_bit(fd, fdt->close_on_exec);
240 }
241
__set_open_fd(unsigned int fd,struct fdtable * fdt)242 static inline void __set_open_fd(unsigned int fd, struct fdtable *fdt)
243 {
244 __set_bit(fd, fdt->open_fds);
245 fd /= BITS_PER_LONG;
246 if (!~fdt->open_fds[fd])
247 __set_bit(fd, fdt->full_fds_bits);
248 }
249
__clear_open_fd(unsigned int fd,struct fdtable * fdt)250 static inline void __clear_open_fd(unsigned int fd, struct fdtable *fdt)
251 {
252 __clear_bit(fd, fdt->open_fds);
253 __clear_bit(fd / BITS_PER_LONG, fdt->full_fds_bits);
254 }
255
count_open_files(struct fdtable * fdt)256 static unsigned int count_open_files(struct fdtable *fdt)
257 {
258 unsigned int size = fdt->max_fds;
259 unsigned int i;
260
261 /* Find the last open fd */
262 for (i = size / BITS_PER_LONG; i > 0; ) {
263 if (fdt->open_fds[--i])
264 break;
265 }
266 i = (i + 1) * BITS_PER_LONG;
267 return i;
268 }
269
sane_fdtable_size(struct fdtable * fdt,unsigned int max_fds)270 static unsigned int sane_fdtable_size(struct fdtable *fdt, unsigned int max_fds)
271 {
272 unsigned int count;
273
274 count = count_open_files(fdt);
275 if (max_fds < NR_OPEN_DEFAULT)
276 max_fds = NR_OPEN_DEFAULT;
277 return min(count, max_fds);
278 }
279
280 /*
281 * Allocate a new files structure and copy contents from the
282 * passed in files structure.
283 * errorp will be valid only when the returned files_struct is NULL.
284 */
dup_fd(struct files_struct * oldf,unsigned int max_fds,int * errorp)285 struct files_struct *dup_fd(struct files_struct *oldf, unsigned int max_fds, int *errorp)
286 {
287 struct files_struct *newf;
288 struct file **old_fds, **new_fds;
289 unsigned int open_files, i;
290 struct fdtable *old_fdt, *new_fdt;
291
292 *errorp = -ENOMEM;
293 newf = kmem_cache_alloc(files_cachep, GFP_KERNEL);
294 if (!newf)
295 goto out;
296
297 atomic_set(&newf->count, 1);
298
299 spin_lock_init(&newf->file_lock);
300 newf->resize_in_progress = false;
301 init_waitqueue_head(&newf->resize_wait);
302 newf->next_fd = 0;
303 new_fdt = &newf->fdtab;
304 new_fdt->max_fds = NR_OPEN_DEFAULT;
305 new_fdt->close_on_exec = newf->close_on_exec_init;
306 new_fdt->open_fds = newf->open_fds_init;
307 new_fdt->full_fds_bits = newf->full_fds_bits_init;
308 new_fdt->fd = &newf->fd_array[0];
309
310 spin_lock(&oldf->file_lock);
311 old_fdt = files_fdtable(oldf);
312 open_files = sane_fdtable_size(old_fdt, max_fds);
313
314 /*
315 * Check whether we need to allocate a larger fd array and fd set.
316 */
317 while (unlikely(open_files > new_fdt->max_fds)) {
318 spin_unlock(&oldf->file_lock);
319
320 if (new_fdt != &newf->fdtab)
321 __free_fdtable(new_fdt);
322
323 new_fdt = alloc_fdtable(open_files - 1);
324 if (!new_fdt) {
325 *errorp = -ENOMEM;
326 goto out_release;
327 }
328
329 /* beyond sysctl_nr_open; nothing to do */
330 if (unlikely(new_fdt->max_fds < open_files)) {
331 __free_fdtable(new_fdt);
332 *errorp = -EMFILE;
333 goto out_release;
334 }
335
336 /*
337 * Reacquire the oldf lock and a pointer to its fd table
338 * who knows it may have a new bigger fd table. We need
339 * the latest pointer.
340 */
341 spin_lock(&oldf->file_lock);
342 old_fdt = files_fdtable(oldf);
343 open_files = sane_fdtable_size(old_fdt, max_fds);
344 }
345
346 copy_fd_bitmaps(new_fdt, old_fdt, open_files);
347
348 old_fds = old_fdt->fd;
349 new_fds = new_fdt->fd;
350
351 for (i = open_files; i != 0; i--) {
352 struct file *f = *old_fds++;
353 if (f) {
354 get_file(f);
355 } else {
356 /*
357 * The fd may be claimed in the fd bitmap but not yet
358 * instantiated in the files array if a sibling thread
359 * is partway through open(). So make sure that this
360 * fd is available to the new process.
361 */
362 __clear_open_fd(open_files - i, new_fdt);
363 }
364 rcu_assign_pointer(*new_fds++, f);
365 }
366 spin_unlock(&oldf->file_lock);
367
368 /* clear the remainder */
369 memset(new_fds, 0, (new_fdt->max_fds - open_files) * sizeof(struct file *));
370
371 rcu_assign_pointer(newf->fdt, new_fdt);
372
373 return newf;
374
375 out_release:
376 kmem_cache_free(files_cachep, newf);
377 out:
378 return NULL;
379 }
380
close_files(struct files_struct * files)381 static struct fdtable *close_files(struct files_struct * files)
382 {
383 /*
384 * It is safe to dereference the fd table without RCU or
385 * ->file_lock because this is the last reference to the
386 * files structure.
387 */
388 struct fdtable *fdt = rcu_dereference_raw(files->fdt);
389 unsigned int i, j = 0;
390
391 for (;;) {
392 unsigned long set;
393 i = j * BITS_PER_LONG;
394 if (i >= fdt->max_fds)
395 break;
396 set = fdt->open_fds[j++];
397 while (set) {
398 if (set & 1) {
399 struct file * file = xchg(&fdt->fd[i], NULL);
400 if (file) {
401 filp_close(file, files);
402 cond_resched();
403 }
404 }
405 i++;
406 set >>= 1;
407 }
408 }
409
410 return fdt;
411 }
412
get_files_struct(struct task_struct * task)413 struct files_struct *get_files_struct(struct task_struct *task)
414 {
415 struct files_struct *files;
416
417 task_lock(task);
418 files = task->files;
419 if (files)
420 atomic_inc(&files->count);
421 task_unlock(task);
422
423 return files;
424 }
425
put_files_struct(struct files_struct * files)426 void put_files_struct(struct files_struct *files)
427 {
428 if (atomic_dec_and_test(&files->count)) {
429 struct fdtable *fdt = close_files(files);
430
431 /* free the arrays if they are not embedded */
432 if (fdt != &files->fdtab)
433 __free_fdtable(fdt);
434 kmem_cache_free(files_cachep, files);
435 }
436 }
437
reset_files_struct(struct files_struct * files)438 void reset_files_struct(struct files_struct *files)
439 {
440 struct task_struct *tsk = current;
441 struct files_struct *old;
442
443 old = tsk->files;
444 task_lock(tsk);
445 tsk->files = files;
446 task_unlock(tsk);
447 put_files_struct(old);
448 }
449
exit_files(struct task_struct * tsk)450 void exit_files(struct task_struct *tsk)
451 {
452 struct files_struct * files = tsk->files;
453
454 if (files) {
455 task_lock(tsk);
456 tsk->files = NULL;
457 task_unlock(tsk);
458 put_files_struct(files);
459 }
460 }
461
462 struct files_struct init_files = {
463 .count = ATOMIC_INIT(1),
464 .fdt = &init_files.fdtab,
465 .fdtab = {
466 .max_fds = NR_OPEN_DEFAULT,
467 .fd = &init_files.fd_array[0],
468 .close_on_exec = init_files.close_on_exec_init,
469 .open_fds = init_files.open_fds_init,
470 .full_fds_bits = init_files.full_fds_bits_init,
471 },
472 .file_lock = __SPIN_LOCK_UNLOCKED(init_files.file_lock),
473 .resize_wait = __WAIT_QUEUE_HEAD_INITIALIZER(init_files.resize_wait),
474 };
475
find_next_fd(struct fdtable * fdt,unsigned int start)476 static unsigned int find_next_fd(struct fdtable *fdt, unsigned int start)
477 {
478 unsigned int maxfd = fdt->max_fds;
479 unsigned int maxbit = maxfd / BITS_PER_LONG;
480 unsigned int bitbit = start / BITS_PER_LONG;
481
482 bitbit = find_next_zero_bit(fdt->full_fds_bits, maxbit, bitbit) * BITS_PER_LONG;
483 if (bitbit > maxfd)
484 return maxfd;
485 if (bitbit > start)
486 start = bitbit;
487 return find_next_zero_bit(fdt->open_fds, maxfd, start);
488 }
489
490 /*
491 * allocate a file descriptor, mark it busy.
492 */
__alloc_fd(struct files_struct * files,unsigned start,unsigned end,unsigned flags)493 int __alloc_fd(struct files_struct *files,
494 unsigned start, unsigned end, unsigned flags)
495 {
496 unsigned int fd;
497 int error;
498 struct fdtable *fdt;
499
500 spin_lock(&files->file_lock);
501 repeat:
502 fdt = files_fdtable(files);
503 fd = start;
504 if (fd < files->next_fd)
505 fd = files->next_fd;
506
507 if (fd < fdt->max_fds)
508 fd = find_next_fd(fdt, fd);
509
510 /*
511 * N.B. For clone tasks sharing a files structure, this test
512 * will limit the total number of files that can be opened.
513 */
514 error = -EMFILE;
515 if (fd >= end)
516 goto out;
517
518 error = expand_files(files, fd);
519 if (error < 0)
520 goto out;
521
522 /*
523 * If we needed to expand the fs array we
524 * might have blocked - try again.
525 */
526 if (error)
527 goto repeat;
528
529 if (start <= files->next_fd)
530 files->next_fd = fd + 1;
531
532 __set_open_fd(fd, fdt);
533 if (flags & O_CLOEXEC)
534 __set_close_on_exec(fd, fdt);
535 else
536 __clear_close_on_exec(fd, fdt);
537 error = fd;
538 #if 1
539 /* Sanity check */
540 if (rcu_access_pointer(fdt->fd[fd]) != NULL) {
541 printk(KERN_WARNING "alloc_fd: slot %d not NULL!\n", fd);
542 rcu_assign_pointer(fdt->fd[fd], NULL);
543 }
544 #endif
545
546 out:
547 spin_unlock(&files->file_lock);
548 return error;
549 }
550
alloc_fd(unsigned start,unsigned flags)551 static int alloc_fd(unsigned start, unsigned flags)
552 {
553 return __alloc_fd(current->files, start, rlimit(RLIMIT_NOFILE), flags);
554 }
555
__get_unused_fd_flags(unsigned flags,unsigned long nofile)556 int __get_unused_fd_flags(unsigned flags, unsigned long nofile)
557 {
558 return __alloc_fd(current->files, 0, nofile, flags);
559 }
560
get_unused_fd_flags(unsigned flags)561 int get_unused_fd_flags(unsigned flags)
562 {
563 return __get_unused_fd_flags(flags, rlimit(RLIMIT_NOFILE));
564 }
565 EXPORT_SYMBOL(get_unused_fd_flags);
566
__put_unused_fd(struct files_struct * files,unsigned int fd)567 static void __put_unused_fd(struct files_struct *files, unsigned int fd)
568 {
569 struct fdtable *fdt = files_fdtable(files);
570 __clear_open_fd(fd, fdt);
571 if (fd < files->next_fd)
572 files->next_fd = fd;
573 }
574
put_unused_fd(unsigned int fd)575 void put_unused_fd(unsigned int fd)
576 {
577 struct files_struct *files = current->files;
578 spin_lock(&files->file_lock);
579 __put_unused_fd(files, fd);
580 spin_unlock(&files->file_lock);
581 }
582
583 EXPORT_SYMBOL(put_unused_fd);
584
585 /*
586 * Install a file pointer in the fd array.
587 *
588 * The VFS is full of places where we drop the files lock between
589 * setting the open_fds bitmap and installing the file in the file
590 * array. At any such point, we are vulnerable to a dup2() race
591 * installing a file in the array before us. We need to detect this and
592 * fput() the struct file we are about to overwrite in this case.
593 *
594 * It should never happen - if we allow dup2() do it, _really_ bad things
595 * will follow.
596 *
597 * NOTE: __fd_install() variant is really, really low-level; don't
598 * use it unless you are forced to by truly lousy API shoved down
599 * your throat. 'files' *MUST* be either current->files or obtained
600 * by get_files_struct(current) done by whoever had given it to you,
601 * or really bad things will happen. Normally you want to use
602 * fd_install() instead.
603 */
604
__fd_install(struct files_struct * files,unsigned int fd,struct file * file)605 void __fd_install(struct files_struct *files, unsigned int fd,
606 struct file *file)
607 {
608 struct fdtable *fdt;
609
610 rcu_read_lock_sched();
611
612 if (unlikely(files->resize_in_progress)) {
613 rcu_read_unlock_sched();
614 spin_lock(&files->file_lock);
615 fdt = files_fdtable(files);
616 BUG_ON(fdt->fd[fd] != NULL);
617 rcu_assign_pointer(fdt->fd[fd], file);
618 spin_unlock(&files->file_lock);
619 return;
620 }
621 /* coupled with smp_wmb() in expand_fdtable() */
622 smp_rmb();
623 fdt = rcu_dereference_sched(files->fdt);
624 BUG_ON(fdt->fd[fd] != NULL);
625 rcu_assign_pointer(fdt->fd[fd], file);
626 rcu_read_unlock_sched();
627 }
628
629 /*
630 * This consumes the "file" refcount, so callers should treat it
631 * as if they had called fput(file).
632 */
fd_install(unsigned int fd,struct file * file)633 void fd_install(unsigned int fd, struct file *file)
634 {
635 __fd_install(current->files, fd, file);
636 }
637
638 EXPORT_SYMBOL(fd_install);
639
pick_file(struct files_struct * files,unsigned fd)640 static struct file *pick_file(struct files_struct *files, unsigned fd)
641 {
642 struct file *file = NULL;
643 struct fdtable *fdt;
644
645 spin_lock(&files->file_lock);
646 fdt = files_fdtable(files);
647 if (fd >= fdt->max_fds)
648 goto out_unlock;
649 file = fdt->fd[fd];
650 if (!file)
651 goto out_unlock;
652 rcu_assign_pointer(fdt->fd[fd], NULL);
653 __put_unused_fd(files, fd);
654
655 out_unlock:
656 spin_unlock(&files->file_lock);
657 return file;
658 }
659
660 /*
661 * The same warnings as for __alloc_fd()/__fd_install() apply here...
662 */
__close_fd(struct files_struct * files,unsigned fd)663 int __close_fd(struct files_struct *files, unsigned fd)
664 {
665 struct file *file;
666
667 file = pick_file(files, fd);
668 if (!file)
669 return -EBADF;
670
671 return filp_close(file, files);
672 }
673 EXPORT_SYMBOL(__close_fd); /* for ksys_close() */
674
675 /**
676 * __close_range() - Close all file descriptors in a given range.
677 *
678 * @fd: starting file descriptor to close
679 * @max_fd: last file descriptor to close
680 *
681 * This closes a range of file descriptors. All file descriptors
682 * from @fd up to and including @max_fd are closed.
683 */
__close_range(unsigned fd,unsigned max_fd,unsigned int flags)684 int __close_range(unsigned fd, unsigned max_fd, unsigned int flags)
685 {
686 unsigned int cur_max;
687 struct task_struct *me = current;
688 struct files_struct *cur_fds = me->files, *fds = NULL;
689
690 if (flags & ~CLOSE_RANGE_UNSHARE)
691 return -EINVAL;
692
693 if (fd > max_fd)
694 return -EINVAL;
695
696 rcu_read_lock();
697 cur_max = files_fdtable(cur_fds)->max_fds;
698 rcu_read_unlock();
699
700 /* cap to last valid index into fdtable */
701 cur_max--;
702
703 if (flags & CLOSE_RANGE_UNSHARE) {
704 int ret;
705 unsigned int max_unshare_fds = NR_OPEN_MAX;
706
707 /*
708 * If the requested range is greater than the current maximum,
709 * we're closing everything so only copy all file descriptors
710 * beneath the lowest file descriptor.
711 */
712 if (max_fd >= cur_max)
713 max_unshare_fds = fd;
714
715 ret = unshare_fd(CLONE_FILES, max_unshare_fds, &fds);
716 if (ret)
717 return ret;
718
719 /*
720 * We used to share our file descriptor table, and have now
721 * created a private one, make sure we're using it below.
722 */
723 if (fds)
724 swap(cur_fds, fds);
725 }
726
727 max_fd = min(max_fd, cur_max);
728 while (fd <= max_fd) {
729 struct file *file;
730
731 file = pick_file(cur_fds, fd++);
732 if (!file)
733 continue;
734
735 filp_close(file, cur_fds);
736 cond_resched();
737 }
738
739 if (fds) {
740 /*
741 * We're done closing the files we were supposed to. Time to install
742 * the new file descriptor table and drop the old one.
743 */
744 task_lock(me);
745 me->files = cur_fds;
746 task_unlock(me);
747 put_files_struct(fds);
748 }
749
750 return 0;
751 }
752
753 /*
754 * variant of __close_fd that gets a ref on the file for later fput.
755 * The caller must ensure that filp_close() called on the file, and then
756 * an fput().
757 */
__close_fd_get_file(unsigned int fd,struct file ** res)758 int __close_fd_get_file(unsigned int fd, struct file **res)
759 {
760 struct files_struct *files = current->files;
761 struct file *file;
762 struct fdtable *fdt;
763
764 spin_lock(&files->file_lock);
765 fdt = files_fdtable(files);
766 if (fd >= fdt->max_fds)
767 goto out_unlock;
768 file = fdt->fd[fd];
769 if (!file)
770 goto out_unlock;
771 rcu_assign_pointer(fdt->fd[fd], NULL);
772 __put_unused_fd(files, fd);
773 spin_unlock(&files->file_lock);
774 get_file(file);
775 *res = file;
776 return 0;
777
778 out_unlock:
779 spin_unlock(&files->file_lock);
780 *res = NULL;
781 return -ENOENT;
782 }
783
do_close_on_exec(struct files_struct * files)784 void do_close_on_exec(struct files_struct *files)
785 {
786 unsigned i;
787 struct fdtable *fdt;
788
789 /* exec unshares first */
790 spin_lock(&files->file_lock);
791 for (i = 0; ; i++) {
792 unsigned long set;
793 unsigned fd = i * BITS_PER_LONG;
794 fdt = files_fdtable(files);
795 if (fd >= fdt->max_fds)
796 break;
797 set = fdt->close_on_exec[i];
798 if (!set)
799 continue;
800 fdt->close_on_exec[i] = 0;
801 for ( ; set ; fd++, set >>= 1) {
802 struct file *file;
803 if (!(set & 1))
804 continue;
805 file = fdt->fd[fd];
806 if (!file)
807 continue;
808 rcu_assign_pointer(fdt->fd[fd], NULL);
809 __put_unused_fd(files, fd);
810 spin_unlock(&files->file_lock);
811 filp_close(file, files);
812 cond_resched();
813 spin_lock(&files->file_lock);
814 }
815
816 }
817 spin_unlock(&files->file_lock);
818 }
819
__fget_files(struct files_struct * files,unsigned int fd,fmode_t mask,unsigned int refs)820 static struct file *__fget_files(struct files_struct *files, unsigned int fd,
821 fmode_t mask, unsigned int refs)
822 {
823 struct file *file;
824
825 rcu_read_lock();
826 loop:
827 file = fcheck_files(files, fd);
828 if (file) {
829 /* File object ref couldn't be taken.
830 * dup2() atomicity guarantee is the reason
831 * we loop to catch the new file (or NULL pointer)
832 */
833 if (file->f_mode & mask)
834 file = NULL;
835 else if (!get_file_rcu_many(file, refs))
836 goto loop;
837 else if (__fcheck_files(files, fd) != file) {
838 fput_many(file, refs);
839 goto loop;
840 }
841 }
842 rcu_read_unlock();
843
844 return file;
845 }
846
__fget(unsigned int fd,fmode_t mask,unsigned int refs)847 static inline struct file *__fget(unsigned int fd, fmode_t mask,
848 unsigned int refs)
849 {
850 return __fget_files(current->files, fd, mask, refs);
851 }
852
fget_many(unsigned int fd,unsigned int refs)853 struct file *fget_many(unsigned int fd, unsigned int refs)
854 {
855 return __fget(fd, FMODE_PATH, refs);
856 }
857
fget(unsigned int fd)858 struct file *fget(unsigned int fd)
859 {
860 return __fget(fd, FMODE_PATH, 1);
861 }
862 EXPORT_SYMBOL(fget);
863
fget_raw(unsigned int fd)864 struct file *fget_raw(unsigned int fd)
865 {
866 return __fget(fd, 0, 1);
867 }
868 EXPORT_SYMBOL(fget_raw);
869
fget_task(struct task_struct * task,unsigned int fd)870 struct file *fget_task(struct task_struct *task, unsigned int fd)
871 {
872 struct file *file = NULL;
873
874 task_lock(task);
875 if (task->files)
876 file = __fget_files(task->files, fd, 0, 1);
877 task_unlock(task);
878
879 return file;
880 }
881
882 /*
883 * Lightweight file lookup - no refcnt increment if fd table isn't shared.
884 *
885 * You can use this instead of fget if you satisfy all of the following
886 * conditions:
887 * 1) You must call fput_light before exiting the syscall and returning control
888 * to userspace (i.e. you cannot remember the returned struct file * after
889 * returning to userspace).
890 * 2) You must not call filp_close on the returned struct file * in between
891 * calls to fget_light and fput_light.
892 * 3) You must not clone the current task in between the calls to fget_light
893 * and fput_light.
894 *
895 * The fput_needed flag returned by fget_light should be passed to the
896 * corresponding fput_light.
897 */
__fget_light(unsigned int fd,fmode_t mask)898 static unsigned long __fget_light(unsigned int fd, fmode_t mask)
899 {
900 struct files_struct *files = current->files;
901 struct file *file;
902
903 if (atomic_read(&files->count) == 1) {
904 file = __fcheck_files(files, fd);
905 if (!file || unlikely(file->f_mode & mask))
906 return 0;
907 return (unsigned long)file;
908 } else {
909 file = __fget(fd, mask, 1);
910 if (!file)
911 return 0;
912 return FDPUT_FPUT | (unsigned long)file;
913 }
914 }
__fdget(unsigned int fd)915 unsigned long __fdget(unsigned int fd)
916 {
917 return __fget_light(fd, FMODE_PATH);
918 }
919 EXPORT_SYMBOL(__fdget);
920
__fdget_raw(unsigned int fd)921 unsigned long __fdget_raw(unsigned int fd)
922 {
923 return __fget_light(fd, 0);
924 }
925
__fdget_pos(unsigned int fd)926 unsigned long __fdget_pos(unsigned int fd)
927 {
928 unsigned long v = __fdget(fd);
929 struct file *file = (struct file *)(v & ~3);
930
931 if (file && (file->f_mode & FMODE_ATOMIC_POS)) {
932 if (file_count(file) > 1) {
933 v |= FDPUT_POS_UNLOCK;
934 mutex_lock(&file->f_pos_lock);
935 }
936 }
937 return v;
938 }
939
__f_unlock_pos(struct file * f)940 void __f_unlock_pos(struct file *f)
941 {
942 mutex_unlock(&f->f_pos_lock);
943 }
944
945 /*
946 * We only lock f_pos if we have threads or if the file might be
947 * shared with another process. In both cases we'll have an elevated
948 * file count (done either by fdget() or by fork()).
949 */
950
set_close_on_exec(unsigned int fd,int flag)951 void set_close_on_exec(unsigned int fd, int flag)
952 {
953 struct files_struct *files = current->files;
954 struct fdtable *fdt;
955 spin_lock(&files->file_lock);
956 fdt = files_fdtable(files);
957 if (flag)
958 __set_close_on_exec(fd, fdt);
959 else
960 __clear_close_on_exec(fd, fdt);
961 spin_unlock(&files->file_lock);
962 }
963
get_close_on_exec(unsigned int fd)964 bool get_close_on_exec(unsigned int fd)
965 {
966 struct files_struct *files = current->files;
967 struct fdtable *fdt;
968 bool res;
969 rcu_read_lock();
970 fdt = files_fdtable(files);
971 res = close_on_exec(fd, fdt);
972 rcu_read_unlock();
973 return res;
974 }
975
do_dup2(struct files_struct * files,struct file * file,unsigned fd,unsigned flags)976 static int do_dup2(struct files_struct *files,
977 struct file *file, unsigned fd, unsigned flags)
978 __releases(&files->file_lock)
979 {
980 struct file *tofree;
981 struct fdtable *fdt;
982
983 /*
984 * We need to detect attempts to do dup2() over allocated but still
985 * not finished descriptor. NB: OpenBSD avoids that at the price of
986 * extra work in their equivalent of fget() - they insert struct
987 * file immediately after grabbing descriptor, mark it larval if
988 * more work (e.g. actual opening) is needed and make sure that
989 * fget() treats larval files as absent. Potentially interesting,
990 * but while extra work in fget() is trivial, locking implications
991 * and amount of surgery on open()-related paths in VFS are not.
992 * FreeBSD fails with -EBADF in the same situation, NetBSD "solution"
993 * deadlocks in rather amusing ways, AFAICS. All of that is out of
994 * scope of POSIX or SUS, since neither considers shared descriptor
995 * tables and this condition does not arise without those.
996 */
997 fdt = files_fdtable(files);
998 tofree = fdt->fd[fd];
999 if (!tofree && fd_is_open(fd, fdt))
1000 goto Ebusy;
1001 get_file(file);
1002 rcu_assign_pointer(fdt->fd[fd], file);
1003 __set_open_fd(fd, fdt);
1004 if (flags & O_CLOEXEC)
1005 __set_close_on_exec(fd, fdt);
1006 else
1007 __clear_close_on_exec(fd, fdt);
1008 spin_unlock(&files->file_lock);
1009
1010 if (tofree)
1011 filp_close(tofree, files);
1012
1013 return fd;
1014
1015 Ebusy:
1016 spin_unlock(&files->file_lock);
1017 return -EBUSY;
1018 }
1019
replace_fd(unsigned fd,struct file * file,unsigned flags)1020 int replace_fd(unsigned fd, struct file *file, unsigned flags)
1021 {
1022 int err;
1023 struct files_struct *files = current->files;
1024
1025 if (!file)
1026 return __close_fd(files, fd);
1027
1028 if (fd >= rlimit(RLIMIT_NOFILE))
1029 return -EBADF;
1030
1031 spin_lock(&files->file_lock);
1032 err = expand_files(files, fd);
1033 if (unlikely(err < 0))
1034 goto out_unlock;
1035 return do_dup2(files, file, fd, flags);
1036
1037 out_unlock:
1038 spin_unlock(&files->file_lock);
1039 return err;
1040 }
1041
1042 /**
1043 * __receive_fd() - Install received file into file descriptor table
1044 *
1045 * @fd: fd to install into (if negative, a new fd will be allocated)
1046 * @file: struct file that was received from another process
1047 * @ufd: __user pointer to write new fd number to
1048 * @o_flags: the O_* flags to apply to the new fd entry
1049 *
1050 * Installs a received file into the file descriptor table, with appropriate
1051 * checks and count updates. Optionally writes the fd number to userspace, if
1052 * @ufd is non-NULL.
1053 *
1054 * This helper handles its own reference counting of the incoming
1055 * struct file.
1056 *
1057 * Returns newly install fd or -ve on error.
1058 */
__receive_fd(int fd,struct file * file,int __user * ufd,unsigned int o_flags)1059 int __receive_fd(int fd, struct file *file, int __user *ufd, unsigned int o_flags)
1060 {
1061 int new_fd;
1062 int error;
1063
1064 error = security_file_receive(file);
1065 if (error)
1066 return error;
1067
1068 if (fd < 0) {
1069 new_fd = get_unused_fd_flags(o_flags);
1070 if (new_fd < 0)
1071 return new_fd;
1072 } else {
1073 new_fd = fd;
1074 }
1075
1076 if (ufd) {
1077 error = put_user(new_fd, ufd);
1078 if (error) {
1079 if (fd < 0)
1080 put_unused_fd(new_fd);
1081 return error;
1082 }
1083 }
1084
1085 if (fd < 0) {
1086 fd_install(new_fd, get_file(file));
1087 } else {
1088 error = replace_fd(new_fd, file, o_flags);
1089 if (error)
1090 return error;
1091 }
1092
1093 /* Bump the sock usage counts, if any. */
1094 __receive_sock(file);
1095 return new_fd;
1096 }
1097
ksys_dup3(unsigned int oldfd,unsigned int newfd,int flags)1098 static int ksys_dup3(unsigned int oldfd, unsigned int newfd, int flags)
1099 {
1100 int err = -EBADF;
1101 struct file *file;
1102 struct files_struct *files = current->files;
1103
1104 if ((flags & ~O_CLOEXEC) != 0)
1105 return -EINVAL;
1106
1107 if (unlikely(oldfd == newfd))
1108 return -EINVAL;
1109
1110 if (newfd >= rlimit(RLIMIT_NOFILE))
1111 return -EBADF;
1112
1113 spin_lock(&files->file_lock);
1114 err = expand_files(files, newfd);
1115 file = fcheck(oldfd);
1116 if (unlikely(!file))
1117 goto Ebadf;
1118 if (unlikely(err < 0)) {
1119 if (err == -EMFILE)
1120 goto Ebadf;
1121 goto out_unlock;
1122 }
1123 return do_dup2(files, file, newfd, flags);
1124
1125 Ebadf:
1126 err = -EBADF;
1127 out_unlock:
1128 spin_unlock(&files->file_lock);
1129 return err;
1130 }
1131
SYSCALL_DEFINE3(dup3,unsigned int,oldfd,unsigned int,newfd,int,flags)1132 SYSCALL_DEFINE3(dup3, unsigned int, oldfd, unsigned int, newfd, int, flags)
1133 {
1134 return ksys_dup3(oldfd, newfd, flags);
1135 }
1136
SYSCALL_DEFINE2(dup2,unsigned int,oldfd,unsigned int,newfd)1137 SYSCALL_DEFINE2(dup2, unsigned int, oldfd, unsigned int, newfd)
1138 {
1139 if (unlikely(newfd == oldfd)) { /* corner case */
1140 struct files_struct *files = current->files;
1141 int retval = oldfd;
1142
1143 rcu_read_lock();
1144 if (!fcheck_files(files, oldfd))
1145 retval = -EBADF;
1146 rcu_read_unlock();
1147 return retval;
1148 }
1149 return ksys_dup3(oldfd, newfd, 0);
1150 }
1151
SYSCALL_DEFINE1(dup,unsigned int,fildes)1152 SYSCALL_DEFINE1(dup, unsigned int, fildes)
1153 {
1154 int ret = -EBADF;
1155 struct file *file = fget_raw(fildes);
1156
1157 if (file) {
1158 ret = get_unused_fd_flags(0);
1159 if (ret >= 0)
1160 fd_install(ret, file);
1161 else
1162 fput(file);
1163 }
1164 return ret;
1165 }
1166
f_dupfd(unsigned int from,struct file * file,unsigned flags)1167 int f_dupfd(unsigned int from, struct file *file, unsigned flags)
1168 {
1169 int err;
1170 if (from >= rlimit(RLIMIT_NOFILE))
1171 return -EINVAL;
1172 err = alloc_fd(from, flags);
1173 if (err >= 0) {
1174 get_file(file);
1175 fd_install(err, file);
1176 }
1177 return err;
1178 }
1179
iterate_fd(struct files_struct * files,unsigned n,int (* f)(const void *,struct file *,unsigned),const void * p)1180 int iterate_fd(struct files_struct *files, unsigned n,
1181 int (*f)(const void *, struct file *, unsigned),
1182 const void *p)
1183 {
1184 struct fdtable *fdt;
1185 int res = 0;
1186 if (!files)
1187 return 0;
1188 spin_lock(&files->file_lock);
1189 for (fdt = files_fdtable(files); n < fdt->max_fds; n++) {
1190 struct file *file;
1191 file = rcu_dereference_check_fdtable(files, fdt->fd[n]);
1192 if (!file)
1193 continue;
1194 res = f(p, file, n);
1195 if (res)
1196 break;
1197 }
1198 spin_unlock(&files->file_lock);
1199 return res;
1200 }
1201 EXPORT_SYMBOL(iterate_fd);
1202