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/mm.h>
  14 #include <linux/mmzone.h>
  15 #include <linux/time.h>
  16 #include <linux/sched/signal.h>
  17 #include <linux/slab.h>
  18 #include <linux/vmalloc.h>
  19 #include <linux/file.h>
  20 #include <linux/fdtable.h>
  21 #include <linux/bitops.h>
  22 #include <linux/interrupt.h>
  23 #include <linux/spinlock.h>
  24 #include <linux/rcupdate.h>
  25 #include <linux/workqueue.h>
  26
  27 unsigned int sysctl_nr_open __read_mostly = 1024*1024;
  28 unsigned int sysctl_nr_open_min = BITS_PER_LONG;
  29 /* our min() is unusable in constant expressions ;-/ */
  30 #define __const_min(x, y) ((x) < (y) ? (x) : (y))
  31 unsigned int sysctl_nr_open_max =
  32         __const_min(INT_MAX, ~(size_t)0/sizeof(void *)) & -BITS_PER_LONG;
  33
  34 static void __free_fdtable(struct fdtable *fdt)
  35 {
  36         kvfree(fdt->fd);
  37         kvfree(fdt->open_fds);
  38         kfree(fdt);
  39 }
  40
  41 static void free_fdtable_rcu(struct rcu_head *rcu)
  42 {
  43         __free_fdtable(container_of(rcu, struct fdtable, rcu));
  44 }
  45
  46 #define BITBIT_NR(nr)   BITS_TO_LONGS(BITS_TO_LONGS(nr))
  47 #define BITBIT_SIZE(nr) (BITBIT_NR(nr) * sizeof(long))
  48
  49 /*
  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  */
  54 static 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.
  75  */
  76 static void copy_fdtable(struct fdtable *nfdt, struct fdtable *ofdt)
  77 {
  78         size_t cpy, set;
  79
  80         BUG_ON(nfdt->max_fds < ofdt->max_fds);
  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);
  85         memset((char *)nfdt->fd + cpy, 0, set);
  86
  87         copy_fd_bitmaps(nfdt, ofdt, ofdt->max_fds);
  88 }
  89
  90 static struct fdtable * alloc_fdtable(unsigned int nr)
  91 {
  92         struct fdtable *fdt;
  93         void *data;
  94
  95         /*
  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.
 101          */
 102         nr /= (1024 / sizeof(struct file *));
 103         nr = roundup_pow_of_two(nr + 1);
 104         nr *= (1024 / sizeof(struct file *));
 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;
 115
 116         fdt = kmalloc(sizeof(struct fdtable), GFP_KERNEL_ACCOUNT);
 117         if (!fdt)
 118                 goto out;
 119         fdt->max_fds = nr;
 120         data = kvmalloc_array(nr, sizeof(struct file *), GFP_KERNEL_ACCOUNT);
 121         if (!data)
 122                 goto out_fdt;
 123         fdt->fd = data;
 124
 125         data = kvmalloc(max_t(size_t,
 126                                  2 * nr / BITS_PER_BYTE + BITBIT_SIZE(nr), L1_CACHE_BYTES),
 127                                  GFP_KERNEL_ACCOUNT);
 128         if (!data)
 129                 goto out_arr;
 130         fdt->open_fds = data;
 131         data += nr / BITS_PER_BYTE;
 132         fdt->close_on_exec = data;
 133         data += nr / BITS_PER_BYTE;
 134         fdt->full_fds_bits = data;
 135
 136         return fdt;
 137
 138 out_arr:
 139         kvfree(fdt->fd);
 140 out_fdt:
 141         kfree(fdt);
 142 out:
 143         return NULL;
 144 }
 145
 146 /*
 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.
 152  */
 153 static int expand_fdtable(struct files_struct *files, unsigned int nr)
 154         __releases(files->file_lock)
 155         __acquires(files->file_lock)
 156 {
 157         struct fdtable *new_fdt, *cur_fdt;
 158
 159         spin_unlock(&files->file_lock);
 160         new_fdt = alloc_fdtable(nr);
 161
 162         /* make sure all __fd_install() have seen resize_in_progress
 163          * or have finished their rcu_read_lock_sched() section.
 164          */
 165         if (atomic_read(&files->count) > 1)
 166                 synchronize_sched();
 167
 168         spin_lock(&files->file_lock);
 169         if (!new_fdt)
 170                 return -ENOMEM;
 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)) {
 176                 __free_fdtable(new_fdt);
 177                 return -EMFILE;
 178         }
 179         cur_fdt = files_fdtable(files);
 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);
 185         /* coupled with smp_rmb() in __fd_install() */
 186         smp_wmb();
 187         return 1;
 188 }
 189
 190 /*
 191  * Expand files.
 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.
 197  */
 198 static int expand_files(struct files_struct *files, unsigned int nr)
 199         __releases(files->file_lock)
 200         __acquires(files->file_lock)
 201 {
 202         struct fdtable *fdt;
 203         int expanded = 0;
 204
 205 repeat:
 206         fdt = files_fdtable(files);
 207
 208         /* Do we need to expand? */
 209         if (nr < fdt->max_fds)
 210                 return expanded;
 211
 212         /* Can we expand? */
 213         if (nr >= sysctl_nr_open)
 214                 return -EMFILE;
 215
 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
 224         /* All good, so we try */
 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;
 231 }
 232
 233 static inline void __set_close_on_exec(unsigned int fd, struct fdtable *fdt)
 234 {
 235         __set_bit(fd, fdt->close_on_exec);
 236 }
 237
 238 static inline void __clear_close_on_exec(unsigned int fd, struct fdtable *fdt)
 239 {
 240         if (test_bit(fd, fdt->close_on_exec))
 241                 __clear_bit(fd, fdt->close_on_exec);
 242 }
 243
 244 static inline void __set_open_fd(unsigned int fd, struct fdtable *fdt)
 245 {
 246         __set_bit(fd, fdt->open_fds);
 247         fd /= BITS_PER_LONG;
 248         if (!~fdt->open_fds[fd])
 249                 __set_bit(fd, fdt->full_fds_bits);
 250 }
 251
 252 static inline void __clear_open_fd(unsigned int fd, struct fdtable *fdt)
 253 {
 254         __clear_bit(fd, fdt->open_fds);
 255         __clear_bit(fd / BITS_PER_LONG, fdt->full_fds_bits);
 256 }
 257
 258 static unsigned int count_open_files(struct fdtable *fdt)
 259 {
 260         unsigned int size = fdt->max_fds;
 261         unsigned int i;
 262
 263         /* Find the last open fd */
 264         for (i = size / BITS_PER_LONG; i > 0; ) {
 265                 if (fdt->open_fds[--i])
 266                         break;
 267         }
 268         i = (i + 1) * BITS_PER_LONG;
 269         return i;
 270 }
 271
 272 /*
 273  * Allocate a new files structure and copy contents from the
 274  * passed in files structure.
 275  * errorp will be valid only when the returned files_struct is NULL.
 276  */
 277 struct files_struct *dup_fd(struct files_struct *oldf, int *errorp)
 278 {
 279         struct files_struct *newf;
 280         struct file **old_fds, **new_fds;
 281         unsigned int open_files, i;
 282         struct fdtable *old_fdt, *new_fdt;
 283
 284         *errorp = -ENOMEM;
 285         newf = kmem_cache_alloc(files_cachep, GFP_KERNEL);
 286         if (!newf)
 287                 goto out;
 288
 289         atomic_set(&newf->count, 1);
 290
 291         spin_lock_init(&newf->file_lock);
 292         newf->resize_in_progress = false;
 293         init_waitqueue_head(&newf->resize_wait);
 294         newf->next_fd = 0;
 295         new_fdt = &newf->fdtab;
 296         new_fdt->max_fds = NR_OPEN_DEFAULT;
 297         new_fdt->close_on_exec = newf->close_on_exec_init;
 298         new_fdt->open_fds = newf->open_fds_init;
 299         new_fdt->full_fds_bits = newf->full_fds_bits_init;
 300         new_fdt->fd = &newf->fd_array[0];
 301
 302         spin_lock(&oldf->file_lock);
 303         old_fdt = files_fdtable(oldf);
 304         open_files = count_open_files(old_fdt);
 305
 306         /*
 307          * Check whether we need to allocate a larger fd array and fd set.
 308          */
 309         while (unlikely(open_files > new_fdt->max_fds)) {
 310                 spin_unlock(&oldf->file_lock);
 311
 312                 if (new_fdt != &newf->fdtab)
 313                         __free_fdtable(new_fdt);
 314
 315                 new_fdt = alloc_fdtable(open_files - 1);
 316                 if (!new_fdt) {
 317                         *errorp = -ENOMEM;
 318                         goto out_release;
 319                 }
 320
 321                 /* beyond sysctl_nr_open; nothing to do */
 322                 if (unlikely(new_fdt->max_fds < open_files)) {
 323                         __free_fdtable(new_fdt);
 324                         *errorp = -EMFILE;
 325                         goto out_release;
 326                 }
 327
 328                 /*
 329                  * Reacquire the oldf lock and a pointer to its fd table
 330                  * who knows it may have a new bigger fd table. We need
 331                  * the latest pointer.
 332                  */
 333                 spin_lock(&oldf->file_lock);
 334                 old_fdt = files_fdtable(oldf);
 335                 open_files = count_open_files(old_fdt);
 336         }
 337
 338         copy_fd_bitmaps(new_fdt, old_fdt, open_files);
 339
 340         old_fds = old_fdt->fd;
 341         new_fds = new_fdt->fd;
 342
 343         for (i = open_files; i != 0; i--) {
 344                 struct file *f = *old_fds++;
 345                 if (f) {
 346                         get_file(f);
 347                 } else {
 348                         /*
 349                          * The fd may be claimed in the fd bitmap but not yet
 350                          * instantiated in the files array if a sibling thread
 351                          * is partway through open().  So make sure that this
 352                          * fd is available to the new process.
 353                          */
 354                         __clear_open_fd(open_files - i, new_fdt);
 355                 }
 356                 rcu_assign_pointer(*new_fds++, f);
 357         }
 358         spin_unlock(&oldf->file_lock);
 359
 360         /* clear the remainder */
 361         memset(new_fds, 0, (new_fdt->max_fds - open_files) * sizeof(struct file *));
 362
 363         rcu_assign_pointer(newf->fdt, new_fdt);
 364
 365         return newf;
 366
 367 out_release:
 368         kmem_cache_free(files_cachep, newf);
 369 out:
 370         return NULL;
 371 }
 372
 373 static struct fdtable *close_files(struct files_struct * files)
 374 {
 375         /*
 376          * It is safe to dereference the fd table without RCU or
 377          * ->file_lock because this is the last reference to the
 378          * files structure.
 379          */
 380         struct fdtable *fdt = rcu_dereference_raw(files->fdt);
 381         unsigned int i, j = 0;
 382
 383         for (;;) {
 384                 unsigned long set;
 385                 i = j * BITS_PER_LONG;
 386                 if (i >= fdt->max_fds)
 387                         break;
 388                 set = fdt->open_fds[j++];
 389                 while (set) {
 390                         if (set & 1) {
 391                                 struct file * file = xchg(&fdt->fd[i], NULL);
 392                                 if (file) {
 393                                         filp_close(file, files);
 394                                         cond_resched_rcu_qs();
 395                                 }
 396                         }
 397                         i++;
 398                         set >>= 1;
 399                 }
 400         }
 401
 402         return fdt;
 403 }
 404
 405 struct files_struct *get_files_struct(struct task_struct *task)
 406 {
 407         struct files_struct *files;
 408
 409         task_lock(task);
 410         files = task->files;
 411         if (files)
 412                 atomic_inc(&files->count);
 413         task_unlock(task);
 414
 415         return files;
 416 }
 417
 418 void put_files_struct(struct files_struct *files)
 419 {
 420         if (atomic_dec_and_test(&files->count)) {
 421                 struct fdtable *fdt = close_files(files);
 422
 423                 /* free the arrays if they are not embedded */
 424                 if (fdt != &files->fdtab)
 425                         __free_fdtable(fdt);
 426                 kmem_cache_free(files_cachep, files);
 427         }
 428 }
 429
 430 void reset_files_struct(struct files_struct *files)
 431 {
 432         struct task_struct *tsk = current;
 433         struct files_struct *old;
 434
 435         old = tsk->files;
 436         task_lock(tsk);
 437         tsk->files = files;
 438         task_unlock(tsk);
 439         put_files_struct(old);
 440 }
 441
 442 void exit_files(struct task_struct *tsk)
 443 {
 444         struct files_struct * files = tsk->files;
 445
 446         if (files) {
 447                 task_lock(tsk);
 448                 tsk->files = NULL;
 449                 task_unlock(tsk);
 450                 put_files_struct(files);
 451         }
 452 }
 453
 454 struct files_struct init_files = {
 455         .count          = ATOMIC_INIT(1),
 456         .fdt            = &init_files.fdtab,
 457         .fdtab          = {
 458                 .max_fds        = NR_OPEN_DEFAULT,
 459                 .fd             = &init_files.fd_array[0],
 460                 .close_on_exec  = init_files.close_on_exec_init,
 461                 .open_fds       = init_files.open_fds_init,
 462                 .full_fds_bits  = init_files.full_fds_bits_init,
 463         },
 464         .file_lock      = __SPIN_LOCK_UNLOCKED(init_files.file_lock),
 465         .resize_wait    = __WAIT_QUEUE_HEAD_INITIALIZER(init_files.resize_wait),
 466 };
 467
 468 static unsigned int find_next_fd(struct fdtable *fdt, unsigned int start)
 469 {
 470         unsigned int maxfd = fdt->max_fds;
 471         unsigned int maxbit = maxfd / BITS_PER_LONG;
 472         unsigned int bitbit = start / BITS_PER_LONG;
 473
 474         bitbit = find_next_zero_bit(fdt->full_fds_bits, maxbit, bitbit) * BITS_PER_LONG;
 475         if (bitbit > maxfd)
 476                 return maxfd;
 477         if (bitbit > start)
 478                 start = bitbit;
 479         return find_next_zero_bit(fdt->open_fds, maxfd, start);
 480 }
 481
 482 /*
 483  * allocate a file descriptor, mark it busy.
 484  */
 485 int __alloc_fd(struct files_struct *files,
 486                unsigned start, unsigned end, unsigned flags)
 487 {
 488         unsigned int fd;
 489         int error;
 490         struct fdtable *fdt;
 491
 492         spin_lock(&files->file_lock);
 493 repeat:
 494         fdt = files_fdtable(files);
 495         fd = start;
 496         if (fd < files->next_fd)
 497                 fd = files->next_fd;
 498
 499         if (fd < fdt->max_fds)
 500                 fd = find_next_fd(fdt, fd);
 501
 502         /*
 503          * N.B. For clone tasks sharing a files structure, this test
 504          * will limit the total number of files that can be opened.
 505          */
 506         error = -EMFILE;
 507         if (fd >= end)
 508                 goto out;
 509
 510         error = expand_files(files, fd);
 511         if (error < 0)
 512                 goto out;
 513
 514         /*
 515          * If we needed to expand the fs array we
 516          * might have blocked - try again.
 517          */
 518         if (error)
 519                 goto repeat;
 520
 521         if (start <= files->next_fd)
 522                 files->next_fd = fd + 1;
 523
 524         __set_open_fd(fd, fdt);
 525         if (flags & O_CLOEXEC)
 526                 __set_close_on_exec(fd, fdt);
 527         else
 528                 __clear_close_on_exec(fd, fdt);
 529         error = fd;
 530 #if 1
 531         /* Sanity check */
 532         if (rcu_access_pointer(fdt->fd[fd]) != NULL) {
 533                 printk(KERN_WARNING "alloc_fd: slot %d not NULL!\n", fd);
 534                 rcu_assign_pointer(fdt->fd[fd], NULL);
 535         }
 536 #endif
 537
 538 out:
 539         spin_unlock(&files->file_lock);
 540         return error;
 541 }
 542
 543 static int alloc_fd(unsigned start, unsigned flags)
 544 {
 545         return __alloc_fd(current->files, start, rlimit(RLIMIT_NOFILE), flags);
 546 }
 547
 548 int get_unused_fd_flags(unsigned flags)
 549 {
 550         return __alloc_fd(current->files, 0, rlimit(RLIMIT_NOFILE), flags);
 551 }
 552 EXPORT_SYMBOL(get_unused_fd_flags);
 553
 554 static void __put_unused_fd(struct files_struct *files, unsigned int fd)
 555 {
 556         struct fdtable *fdt = files_fdtable(files);
 557         __clear_open_fd(fd, fdt);
 558         if (fd < files->next_fd)
 559                 files->next_fd = fd;
 560 }
 561
 562 void put_unused_fd(unsigned int fd)
 563 {
 564         struct files_struct *files = current->files;
 565         spin_lock(&files->file_lock);
 566         __put_unused_fd(files, fd);
 567         spin_unlock(&files->file_lock);
 568 }
 569
 570 EXPORT_SYMBOL(put_unused_fd);
 571
 572 /*
 573  * Install a file pointer in the fd array.
 574  *
 575  * The VFS is full of places where we drop the files lock between
 576  * setting the open_fds bitmap and installing the file in the file
 577  * array.  At any such point, we are vulnerable to a dup2() race
 578  * installing a file in the array before us.  We need to detect this and
 579  * fput() the struct file we are about to overwrite in this case.
 580  *
 581  * It should never happen - if we allow dup2() do it, _really_ bad things
 582  * will follow.
 583  *
 584  * NOTE: __fd_install() variant is really, really low-level; don't
 585  * use it unless you are forced to by truly lousy API shoved down
 586  * your throat.  'files' *MUST* be either current->files or obtained
 587  * by get_files_struct(current) done by whoever had given it to you,
 588  * or really bad things will happen.  Normally you want to use
 589  * fd_install() instead.
 590  */
 591
 592 void __fd_install(struct files_struct *files, unsigned int fd,
 593                 struct file *file)
 594 {
 595         struct fdtable *fdt;
 596
 597         might_sleep();
 598         rcu_read_lock_sched();
 599
 600         while (unlikely(files->resize_in_progress)) {
 601                 rcu_read_unlock_sched();
 602                 wait_event(files->resize_wait, !files->resize_in_progress);
 603                 rcu_read_lock_sched();
 604         }
 605         /* coupled with smp_wmb() in expand_fdtable() */
 606         smp_rmb();
 607         fdt = rcu_dereference_sched(files->fdt);
 608         BUG_ON(fdt->fd[fd] != NULL);
 609         rcu_assign_pointer(fdt->fd[fd], file);
 610         rcu_read_unlock_sched();
 611 }
 612
 613 void fd_install(unsigned int fd, struct file *file)
 614 {
 615         __fd_install(current->files, fd, file);
 616 }
 617
 618 EXPORT_SYMBOL(fd_install);
 619
 620 /*
 621  * The same warnings as for __alloc_fd()/__fd_install() apply here...
 622  */
 623 int __close_fd(struct files_struct *files, unsigned fd)
 624 {
 625         struct file *file;
 626         struct fdtable *fdt;
 627
 628         spin_lock(&files->file_lock);
 629         fdt = files_fdtable(files);
 630         if (fd >= fdt->max_fds)
 631                 goto out_unlock;
 632         fd = array_index_nospec(fd, fdt->max_fds);
 633         file = fdt->fd[fd];
 634         if (!file)
 635                 goto out_unlock;
 636         rcu_assign_pointer(fdt->fd[fd], NULL);
 637         __clear_close_on_exec(fd, fdt);
 638         __put_unused_fd(files, fd);
 639         spin_unlock(&files->file_lock);
 640         return filp_close(file, files);
 641
 642 out_unlock:
 643         spin_unlock(&files->file_lock);
 644         return -EBADF;
 645 }
 646
 647 void do_close_on_exec(struct files_struct *files)
 648 {
 649         unsigned i;
 650         struct fdtable *fdt;
 651
 652         /* exec unshares first */
 653         spin_lock(&files->file_lock);
 654         for (i = 0; ; i++) {
 655                 unsigned long set;
 656                 unsigned fd = i * BITS_PER_LONG;
 657                 fdt = files_fdtable(files);
 658                 if (fd >= fdt->max_fds)
 659                         break;
 660                 set = fdt->close_on_exec[i];
 661                 if (!set)
 662                         continue;
 663                 fdt->close_on_exec[i] = 0;
 664                 for ( ; set ; fd++, set >>= 1) {
 665                         struct file *file;
 666                         if (!(set & 1))
 667                                 continue;
 668                         file = fdt->fd[fd];
 669                         if (!file)
 670                                 continue;
 671                         rcu_assign_pointer(fdt->fd[fd], NULL);
 672                         __put_unused_fd(files, fd);
 673                         spin_unlock(&files->file_lock);
 674                         filp_close(file, files);
 675                         cond_resched();
 676                         spin_lock(&files->file_lock);
 677                 }
 678
 679         }
 680         spin_unlock(&files->file_lock);
 681 }
 682
 683 static inline struct file *__fget_files_rcu(struct files_struct *files,
 684                 unsigned int fd, fmode_t mask, unsigned int refs)
 685 {
 686         for (;;) {
 687                 struct file *file;
 688                 struct fdtable *fdt = rcu_dereference_raw(files->fdt);
 689                 struct file __rcu **fdentry;
 690
 691                 if (unlikely(fd >= fdt->max_fds))
 692                         return NULL;
 693
 694                 fdentry = fdt->fd + array_index_nospec(fd, fdt->max_fds);
 695                 file = rcu_dereference_raw(*fdentry);
 696                 if (unlikely(!file))
 697                         return NULL;
 698
 699                 if (unlikely(file->f_mode & mask))
 700                         return NULL;
 701
 702                 /*
 703                  * Ok, we have a file pointer. However, because we do
 704                  * this all locklessly under RCU, we may be racing with
 705                  * that file being closed.
 706                  *
 707                  * Such a race can take two forms:
 708                  *
 709                  *  (a) the file ref already went down to zero,
 710                  *      and get_file_rcu_many() fails. Just try
 711                  *      again:
 712                  */
 713                 if (unlikely(!get_file_rcu_many(file, refs)))
 714                         continue;
 715
 716                 /*
 717                  *  (b) the file table entry has changed under us.
 718                  *       Note that we don't need to re-check the 'fdt->fd'
 719                  *       pointer having changed, because it always goes
 720                  *       hand-in-hand with 'fdt'.
 721                  *
 722                  * If so, we need to put our refs and try again.
 723                  */
 724                 if (unlikely(rcu_dereference_raw(files->fdt) != fdt) ||
 725                     unlikely(rcu_dereference_raw(*fdentry) != file)) {
 726                         fput_many(file, refs);
 727                         continue;
 728                 }
 729
 730                 /*
 731                  * Ok, we have a ref to the file, and checked that it
 732                  * still exists.
 733                  */
 734                 return file;
 735         }
 736 }
 737
 738
 739 static struct file *__fget(unsigned int fd, fmode_t mask, unsigned int refs)
 740 {
 741         struct files_struct *files = current->files;
 742         struct file *file;
 743
 744         rcu_read_lock();
 745         file = __fget_files_rcu(files, fd, mask, refs);
 746         rcu_read_unlock();
 747
 748         return file;
 749 }
 750
 751 struct file *fget_many(unsigned int fd, unsigned int refs)
 752 {
 753         return __fget(fd, FMODE_PATH, refs);
 754 }
 755
 756 struct file *fget(unsigned int fd)
 757 {
 758         return __fget(fd, FMODE_PATH, 1);
 759 }
 760 EXPORT_SYMBOL(fget);
 761
 762 struct file *fget_raw(unsigned int fd)
 763 {
 764         return __fget(fd, 0, 1);
 765 }
 766 EXPORT_SYMBOL(fget_raw);
 767
 768 /*
 769  * Lightweight file lookup - no refcnt increment if fd table isn't shared.
 770  *
 771  * You can use this instead of fget if you satisfy all of the following
 772  * conditions:
 773  * 1) You must call fput_light before exiting the syscall and returning control
 774  *    to userspace (i.e. you cannot remember the returned struct file * after
 775  *    returning to userspace).
 776  * 2) You must not call filp_close on the returned struct file * in between
 777  *    calls to fget_light and fput_light.
 778  * 3) You must not clone the current task in between the calls to fget_light
 779  *    and fput_light.
 780  *
 781  * The fput_needed flag returned by fget_light should be passed to the
 782  * corresponding fput_light.
 783  */
 784 static unsigned long __fget_light(unsigned int fd, fmode_t mask)
 785 {
 786         struct files_struct *files = current->files;
 787         struct file *file;
 788
 789         if (atomic_read(&files->count) == 1) {
 790                 file = __fcheck_files(files, fd);
 791                 if (!file || unlikely(file->f_mode & mask))
 792                         return 0;
 793                 return (unsigned long)file;
 794         } else {
 795                 file = __fget(fd, mask, 1);
 796                 if (!file)
 797                         return 0;
 798                 return FDPUT_FPUT | (unsigned long)file;
 799         }
 800 }
 801 unsigned long __fdget(unsigned int fd)
 802 {
 803         return __fget_light(fd, FMODE_PATH);
 804 }
 805 EXPORT_SYMBOL(__fdget);
 806
 807 unsigned long __fdget_raw(unsigned int fd)
 808 {
 809         return __fget_light(fd, 0);
 810 }
 811
 812 unsigned long __fdget_pos(unsigned int fd)
 813 {
 814         unsigned long v = __fdget(fd);
 815         struct file *file = (struct file *)(v & ~3);
 816
 817         if (file && (file->f_mode & FMODE_ATOMIC_POS)) {
 818                 if (file_count(file) > 1) {
 819                         v |= FDPUT_POS_UNLOCK;
 820                         mutex_lock(&file->f_pos_lock);
 821                 }
 822         }
 823         return v;
 824 }
 825
 826 void __f_unlock_pos(struct file *f)
 827 {
 828         mutex_unlock(&f->f_pos_lock);
 829 }
 830
 831 /*
 832  * We only lock f_pos if we have threads or if the file might be
 833  * shared with another process. In both cases we'll have an elevated
 834  * file count (done either by fdget() or by fork()).
 835  */
 836
 837 void set_close_on_exec(unsigned int fd, int flag)
 838 {
 839         struct files_struct *files = current->files;
 840         struct fdtable *fdt;
 841         spin_lock(&files->file_lock);
 842         fdt = files_fdtable(files);
 843         if (flag)
 844                 __set_close_on_exec(fd, fdt);
 845         else
 846                 __clear_close_on_exec(fd, fdt);
 847         spin_unlock(&files->file_lock);
 848 }
 849
 850 bool get_close_on_exec(unsigned int fd)
 851 {
 852         struct files_struct *files = current->files;
 853         struct fdtable *fdt;
 854         bool res;
 855         rcu_read_lock();
 856         fdt = files_fdtable(files);
 857         res = close_on_exec(fd, fdt);
 858         rcu_read_unlock();
 859         return res;
 860 }
 861
 862 static int do_dup2(struct files_struct *files,
 863         struct file *file, unsigned fd, unsigned flags)
 864 __releases(&files->file_lock)
 865 {
 866         struct file *tofree;
 867         struct fdtable *fdt;
 868
 869         /*
 870          * We need to detect attempts to do dup2() over allocated but still
 871          * not finished descriptor.  NB: OpenBSD avoids that at the price of
 872          * extra work in their equivalent of fget() - they insert struct
 873          * file immediately after grabbing descriptor, mark it larval if
 874          * more work (e.g. actual opening) is needed and make sure that
 875          * fget() treats larval files as absent.  Potentially interesting,
 876          * but while extra work in fget() is trivial, locking implications
 877          * and amount of surgery on open()-related paths in VFS are not.
 878          * FreeBSD fails with -EBADF in the same situation, NetBSD "solution"
 879          * deadlocks in rather amusing ways, AFAICS.  All of that is out of
 880          * scope of POSIX or SUS, since neither considers shared descriptor
 881          * tables and this condition does not arise without those.
 882          */
 883         fdt = files_fdtable(files);
 884         tofree = fdt->fd[fd];
 885         if (!tofree && fd_is_open(fd, fdt))
 886                 goto Ebusy;
 887         get_file(file);
 888         rcu_assign_pointer(fdt->fd[fd], file);
 889         __set_open_fd(fd, fdt);
 890         if (flags & O_CLOEXEC)
 891                 __set_close_on_exec(fd, fdt);
 892         else
 893                 __clear_close_on_exec(fd, fdt);
 894         spin_unlock(&files->file_lock);
 895
 896         if (tofree)
 897                 filp_close(tofree, files);
 898
 899         return fd;
 900
 901 Ebusy:
 902         spin_unlock(&files->file_lock);
 903         return -EBUSY;
 904 }
 905
 906 int replace_fd(unsigned fd, struct file *file, unsigned flags)
 907 {
 908         int err;
 909         struct files_struct *files = current->files;
 910
 911         if (!file)
 912                 return __close_fd(files, fd);
 913
 914         if (fd >= rlimit(RLIMIT_NOFILE))
 915                 return -EBADF;
 916
 917         spin_lock(&files->file_lock);
 918         err = expand_files(files, fd);
 919         if (unlikely(err < 0))
 920                 goto out_unlock;
 921         return do_dup2(files, file, fd, flags);
 922
 923 out_unlock:
 924         spin_unlock(&files->file_lock);
 925         return err;
 926 }
 927
 928 SYSCALL_DEFINE3(dup3, unsigned int, oldfd, unsigned int, newfd, int, flags)
 929 {
 930         int err = -EBADF;
 931         struct file *file;
 932         struct files_struct *files = current->files;
 933
 934         if ((flags & ~O_CLOEXEC) != 0)
 935                 return -EINVAL;
 936
 937         if (unlikely(oldfd == newfd))
 938                 return -EINVAL;
 939
 940         if (newfd >= rlimit(RLIMIT_NOFILE))
 941                 return -EBADF;
 942
 943         spin_lock(&files->file_lock);
 944         err = expand_files(files, newfd);
 945         file = fcheck(oldfd);
 946         if (unlikely(!file))
 947                 goto Ebadf;
 948         if (unlikely(err < 0)) {
 949                 if (err == -EMFILE)
 950                         goto Ebadf;
 951                 goto out_unlock;
 952         }
 953         return do_dup2(files, file, newfd, flags);
 954
 955 Ebadf:
 956         err = -EBADF;
 957 out_unlock:
 958         spin_unlock(&files->file_lock);
 959         return err;
 960 }
 961
 962 SYSCALL_DEFINE2(dup2, unsigned int, oldfd, unsigned int, newfd)
 963 {
 964         if (unlikely(newfd == oldfd)) { /* corner case */
 965                 struct files_struct *files = current->files;
 966                 int retval = oldfd;
 967
 968                 rcu_read_lock();
 969                 if (!fcheck_files(files, oldfd))
 970                         retval = -EBADF;
 971                 rcu_read_unlock();
 972                 return retval;
 973         }
 974         return sys_dup3(oldfd, newfd, 0);
 975 }
 976
 977 SYSCALL_DEFINE1(dup, unsigned int, fildes)
 978 {
 979         int ret = -EBADF;
 980         struct file *file = fget_raw(fildes);
 981
 982         if (file) {
 983                 ret = get_unused_fd_flags(0);
 984                 if (ret >= 0)
 985                         fd_install(ret, file);
 986                 else
 987                         fput(file);
 988         }
 989         return ret;
 990 }
 991
 992 int f_dupfd(unsigned int from, struct file *file, unsigned flags)
 993 {
 994         int err;
 995         if (from >= rlimit(RLIMIT_NOFILE))
 996                 return -EINVAL;
 997         err = alloc_fd(from, flags);
 998         if (err >= 0) {
 999                 get_file(file);
1000                 fd_install(err, file);
1001         }
1002         return err;
1003 }
1004
1005 int iterate_fd(struct files_struct *files, unsigned n,
1006                 int (*f)(const void *, struct file *, unsigned),
1007                 const void *p)
1008 {
1009         struct fdtable *fdt;
1010         int res = 0;
1011         if (!files)
1012                 return 0;
1013         spin_lock(&files->file_lock);
1014         for (fdt = files_fdtable(files); n < fdt->max_fds; n++) {
1015                 struct file *file;
1016                 file = rcu_dereference_check_fdtable(files, fdt->fd[n]);
1017                 if (!file)
1018                         continue;
1019                 res = f(p, file, n);
1020                 if (res)
1021                         break;
1022         }
1023         spin_unlock(&files->file_lock);
1024         return res;
1025 }
1026 EXPORT_SYMBOL(iterate_fd);