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