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