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 reset_files_struct(struct files_struct *files)
 440 {
 441         struct task_struct *tsk = current;
 442         struct files_struct *old;
 443
 444         old = tsk->files;
 445         task_lock(tsk);
 446         tsk->files = files;
 447         task_unlock(tsk);
 448         put_files_struct(old);
 449 }
 450
 451 void exit_files(struct task_struct *tsk)
 452 {
 453         struct files_struct * files = tsk->files;
 454
 455         if (files) {
 456                 io_uring_files_cancel(files);
 457                 task_lock(tsk);
 458                 tsk->files = NULL;
 459                 task_unlock(tsk);
 460                 put_files_struct(files);
 461         }
 462 }
 463
 464 struct files_struct init_files = {
 465         .count          = ATOMIC_INIT(1),
 466         .fdt            = &init_files.fdtab,
 467         .fdtab          = {
 468                 .max_fds        = NR_OPEN_DEFAULT,
 469                 .fd             = &init_files.fd_array[0],
 470                 .close_on_exec  = init_files.close_on_exec_init,
 471                 .open_fds       = init_files.open_fds_init,
 472                 .full_fds_bits  = init_files.full_fds_bits_init,
 473         },
 474         .file_lock      = __SPIN_LOCK_UNLOCKED(init_files.file_lock),
 475         .resize_wait    = __WAIT_QUEUE_HEAD_INITIALIZER(init_files.resize_wait),
 476 };
 477
 478 static unsigned int find_next_fd(struct fdtable *fdt, unsigned int start)
 479 {
 480         unsigned int maxfd = fdt->max_fds;
 481         unsigned int maxbit = maxfd / BITS_PER_LONG;
 482         unsigned int bitbit = start / BITS_PER_LONG;
 483
 484         bitbit = find_next_zero_bit(fdt->full_fds_bits, maxbit, bitbit) * BITS_PER_LONG;
 485         if (bitbit > maxfd)
 486                 return maxfd;
 487         if (bitbit > start)
 488                 start = bitbit;
 489         return find_next_zero_bit(fdt->open_fds, maxfd, start);
 490 }
 491
 492 /*
 493  * allocate a file descriptor, mark it busy.
 494  */
 495 int __alloc_fd(struct files_struct *files,
 496                unsigned start, unsigned end, unsigned flags)
 497 {
 498         unsigned int fd;
 499         int error;
 500         struct fdtable *fdt;
 501
 502         spin_lock(&files->file_lock);
 503 repeat:
 504         fdt = files_fdtable(files);
 505         fd = start;
 506         if (fd < files->next_fd)
 507                 fd = files->next_fd;
 508
 509         if (fd < fdt->max_fds)
 510                 fd = find_next_fd(fdt, fd);
 511
 512         /*
 513          * N.B. For clone tasks sharing a files structure, this test
 514          * will limit the total number of files that can be opened.
 515          */
 516         error = -EMFILE;
 517         if (fd >= end)
 518                 goto out;
 519
 520         error = expand_files(files, fd);
 521         if (error < 0)
 522                 goto out;
 523
 524         /*
 525          * If we needed to expand the fs array we
 526          * might have blocked - try again.
 527          */
 528         if (error)
 529                 goto repeat;
 530
 531         if (start <= files->next_fd)
 532                 files->next_fd = fd + 1;
 533
 534         __set_open_fd(fd, fdt);
 535         if (flags & O_CLOEXEC)
 536                 __set_close_on_exec(fd, fdt);
 537         else
 538                 __clear_close_on_exec(fd, fdt);
 539         error = fd;
 540 #if 1
 541         /* Sanity check */
 542         if (rcu_access_pointer(fdt->fd[fd]) != NULL) {
 543                 printk(KERN_WARNING "alloc_fd: slot %d not NULL!\n", fd);
 544                 rcu_assign_pointer(fdt->fd[fd], NULL);
 545         }
 546 #endif
 547
 548 out:
 549         spin_unlock(&files->file_lock);
 550         return error;
 551 }
 552
 553 static int alloc_fd(unsigned start, unsigned flags)
 554 {
 555         return __alloc_fd(current->files, start, rlimit(RLIMIT_NOFILE), flags);
 556 }
 557
 558 int __get_unused_fd_flags(unsigned flags, unsigned long nofile)
 559 {
 560         return __alloc_fd(current->files, 0, nofile, flags);
 561 }
 562
 563 int get_unused_fd_flags(unsigned flags)
 564 {
 565         return __get_unused_fd_flags(flags, rlimit(RLIMIT_NOFILE));
 566 }
 567 EXPORT_SYMBOL(get_unused_fd_flags);
 568
 569 static void __put_unused_fd(struct files_struct *files, unsigned int fd)
 570 {
 571         struct fdtable *fdt = files_fdtable(files);
 572         __clear_open_fd(fd, fdt);
 573         if (fd < files->next_fd)
 574                 files->next_fd = fd;
 575 }
 576
 577 void put_unused_fd(unsigned int fd)
 578 {
 579         struct files_struct *files = current->files;
 580         spin_lock(&files->file_lock);
 581         __put_unused_fd(files, fd);
 582         spin_unlock(&files->file_lock);
 583 }
 584
 585 EXPORT_SYMBOL(put_unused_fd);
 586
 587 /*
 588  * Install a file pointer in the fd array.
 589  *
 590  * The VFS is full of places where we drop the files lock between
 591  * setting the open_fds bitmap and installing the file in the file
 592  * array.  At any such point, we are vulnerable to a dup2() race
 593  * installing a file in the array before us.  We need to detect this and
 594  * fput() the struct file we are about to overwrite in this case.
 595  *
 596  * It should never happen - if we allow dup2() do it, _really_ bad things
 597  * will follow.
 598  *
 599  * NOTE: __fd_install() variant is really, really low-level; don't
 600  * use it unless you are forced to by truly lousy API shoved down
 601  * your throat.  'files' *MUST* be either current->files or obtained
 602  * by get_files_struct(current) done by whoever had given it to you,
 603  * or really bad things will happen.  Normally you want to use
 604  * fd_install() instead.
 605  */
 606
 607 void __fd_install(struct files_struct *files, unsigned int fd,
 608                 struct file *file)
 609 {
 610         struct fdtable *fdt;
 611
 612         rcu_read_lock_sched();
 613
 614         if (unlikely(files->resize_in_progress)) {
 615                 rcu_read_unlock_sched();
 616                 spin_lock(&files->file_lock);
 617                 fdt = files_fdtable(files);
 618                 BUG_ON(fdt->fd[fd] != NULL);
 619                 rcu_assign_pointer(fdt->fd[fd], file);
 620                 spin_unlock(&files->file_lock);
 621                 return;
 622         }
 623         /* coupled with smp_wmb() in expand_fdtable() */
 624         smp_rmb();
 625         fdt = rcu_dereference_sched(files->fdt);
 626         BUG_ON(fdt->fd[fd] != NULL);
 627         rcu_assign_pointer(fdt->fd[fd], file);
 628         rcu_read_unlock_sched();
 629 }
 630
 631 /*
 632  * This consumes the "file" refcount, so callers should treat it
 633  * as if they had called fput(file).
 634  */
 635 void fd_install(unsigned int fd, struct file *file)
 636 {
 637         __fd_install(current->files, fd, file);
 638 }
 639
 640 EXPORT_SYMBOL(fd_install);
 641
 642 static struct file *pick_file(struct files_struct *files, unsigned fd)
 643 {
 644         struct file *file = NULL;
 645         struct fdtable *fdt;
 646
 647         spin_lock(&files->file_lock);
 648         fdt = files_fdtable(files);
 649         if (fd >= fdt->max_fds)
 650                 goto out_unlock;
 651         file = fdt->fd[fd];
 652         if (!file)
 653                 goto out_unlock;
 654         rcu_assign_pointer(fdt->fd[fd], NULL);
 655         __put_unused_fd(files, fd);
 656
 657 out_unlock:
 658         spin_unlock(&files->file_lock);
 659         return file;
 660 }
 661
 662 /*
 663  * The same warnings as for __alloc_fd()/__fd_install() apply here...
 664  */
 665 int __close_fd(struct files_struct *files, unsigned fd)
 666 {
 667         struct file *file;
 668
 669         file = pick_file(files, fd);
 670         if (!file)
 671                 return -EBADF;
 672
 673         return filp_close(file, files);
 674 }
 675 EXPORT_SYMBOL(__close_fd); /* for ksys_close() */
 676
 677 static inline void __range_cloexec(struct files_struct *cur_fds,
 678                                    unsigned int fd, unsigned int max_fd)
 679 {
 680         struct fdtable *fdt;
 681
 682         if (fd > max_fd)
 683                 return;
 684
 685         spin_lock(&cur_fds->file_lock);
 686         fdt = files_fdtable(cur_fds);
 687         bitmap_set(fdt->close_on_exec, fd, max_fd - fd + 1);
 688         spin_unlock(&cur_fds->file_lock);
 689 }
 690
 691 static inline void __range_close(struct files_struct *cur_fds, unsigned int fd,
 692                                  unsigned int max_fd)
 693 {
 694         while (fd <= max_fd) {
 695                 struct file *file;
 696
 697                 file = pick_file(cur_fds, fd++);
 698                 if (!file)
 699                         continue;
 700
 701                 filp_close(file, cur_fds);
 702                 cond_resched();
 703         }
 704 }
 705
 706 /**
 707  * __close_range() - Close all file descriptors in a given range.
 708  *
 709  * @fd:     starting file descriptor to close
 710  * @max_fd: last file descriptor to close
 711  *
 712  * This closes a range of file descriptors. All file descriptors
 713  * from @fd up to and including @max_fd are closed.
 714  */
 715 int __close_range(unsigned fd, unsigned max_fd, unsigned int flags)
 716 {
 717         unsigned int cur_max;
 718         struct task_struct *me = current;
 719         struct files_struct *cur_fds = me->files, *fds = NULL;
 720
 721         if (flags & ~(CLOSE_RANGE_UNSHARE | CLOSE_RANGE_CLOEXEC))
 722                 return -EINVAL;
 723
 724         if (fd > max_fd)
 725                 return -EINVAL;
 726
 727         rcu_read_lock();
 728         cur_max = files_fdtable(cur_fds)->max_fds;
 729         rcu_read_unlock();
 730
 731         /* cap to last valid index into fdtable */
 732         cur_max--;
 733
 734         if (flags & CLOSE_RANGE_UNSHARE) {
 735                 int ret;
 736                 unsigned int max_unshare_fds = NR_OPEN_MAX;
 737
 738                 /*
 739                  * If the requested range is greater than the current maximum,
 740                  * we're closing everything so only copy all file descriptors
 741                  * beneath the lowest file descriptor.
 742                  */
 743                 if (max_fd >= cur_max)
 744                         max_unshare_fds = fd;
 745
 746                 ret = unshare_fd(CLONE_FILES, max_unshare_fds, &fds);
 747                 if (ret)
 748                         return ret;
 749
 750                 /*
 751                  * We used to share our file descriptor table, and have now
 752                  * created a private one, make sure we're using it below.
 753                  */
 754                 if (fds)
 755                         swap(cur_fds, fds);
 756         }
 757
 758         max_fd = min(max_fd, cur_max);
 759
 760         if (flags & CLOSE_RANGE_CLOEXEC)
 761                 __range_cloexec(cur_fds, fd, max_fd);
 762         else
 763                 __range_close(cur_fds, fd, max_fd);
 764
 765         if (fds) {
 766                 /*
 767                  * We're done closing the files we were supposed to. Time to install
 768                  * the new file descriptor table and drop the old one.
 769                  */
 770                 task_lock(me);
 771                 me->files = cur_fds;
 772                 task_unlock(me);
 773                 put_files_struct(fds);
 774         }
 775
 776         return 0;
 777 }
 778
 779 /*
 780  * variant of __close_fd that gets a ref on the file for later fput.
 781  * The caller must ensure that filp_close() called on the file, and then
 782  * an fput().
 783  */
 784 int __close_fd_get_file(unsigned int fd, struct file **res)
 785 {
 786         struct files_struct *files = current->files;
 787         struct file *file;
 788         struct fdtable *fdt;
 789
 790         spin_lock(&files->file_lock);
 791         fdt = files_fdtable(files);
 792         if (fd >= fdt->max_fds)
 793                 goto out_unlock;
 794         file = fdt->fd[fd];
 795         if (!file)
 796                 goto out_unlock;
 797         rcu_assign_pointer(fdt->fd[fd], NULL);
 798         __put_unused_fd(files, fd);
 799         spin_unlock(&files->file_lock);
 800         get_file(file);
 801         *res = file;
 802         return 0;
 803
 804 out_unlock:
 805         spin_unlock(&files->file_lock);
 806         *res = NULL;
 807         return -ENOENT;
 808 }
 809
 810 void do_close_on_exec(struct files_struct *files)
 811 {
 812         unsigned i;
 813         struct fdtable *fdt;
 814
 815         /* exec unshares first */
 816         spin_lock(&files->file_lock);
 817         for (i = 0; ; i++) {
 818                 unsigned long set;
 819                 unsigned fd = i * BITS_PER_LONG;
 820                 fdt = files_fdtable(files);
 821                 if (fd >= fdt->max_fds)
 822                         break;
 823                 set = fdt->close_on_exec[i];
 824                 if (!set)
 825                         continue;
 826                 fdt->close_on_exec[i] = 0;
 827                 for ( ; set ; fd++, set >>= 1) {
 828                         struct file *file;
 829                         if (!(set & 1))
 830                                 continue;
 831                         file = fdt->fd[fd];
 832                         if (!file)
 833                                 continue;
 834                         rcu_assign_pointer(fdt->fd[fd], NULL);
 835                         __put_unused_fd(files, fd);
 836                         spin_unlock(&files->file_lock);
 837                         filp_close(file, files);
 838                         cond_resched();
 839                         spin_lock(&files->file_lock);
 840                 }
 841
 842         }
 843         spin_unlock(&files->file_lock);
 844 }
 845
 846 static struct file *__fget_files(struct files_struct *files, unsigned int fd,
 847                                  fmode_t mask, unsigned int refs)
 848 {
 849         struct file *file;
 850
 851         rcu_read_lock();
 852 loop:
 853         file = fcheck_files(files, fd);
 854         if (file) {
 855                 /* File object ref couldn't be taken.
 856                  * dup2() atomicity guarantee is the reason
 857                  * we loop to catch the new file (or NULL pointer)
 858                  */
 859                 if (file->f_mode & mask)
 860                         file = NULL;
 861                 else if (!get_file_rcu_many(file, refs))
 862                         goto loop;
 863         }
 864         rcu_read_unlock();
 865
 866         return file;
 867 }
 868
 869 static inline struct file *__fget(unsigned int fd, fmode_t mask,
 870                                   unsigned int refs)
 871 {
 872         return __fget_files(current->files, fd, mask, refs);
 873 }
 874
 875 struct file *fget_many(unsigned int fd, unsigned int refs)
 876 {
 877         return __fget(fd, FMODE_PATH, refs);
 878 }
 879
 880 struct file *fget(unsigned int fd)
 881 {
 882         return __fget(fd, FMODE_PATH, 1);
 883 }
 884 EXPORT_SYMBOL(fget);
 885
 886 struct file *fget_raw(unsigned int fd)
 887 {
 888         return __fget(fd, 0, 1);
 889 }
 890 EXPORT_SYMBOL(fget_raw);
 891
 892 struct file *fget_task(struct task_struct *task, unsigned int fd)
 893 {
 894         struct file *file = NULL;
 895
 896         task_lock(task);
 897         if (task->files)
 898                 file = __fget_files(task->files, fd, 0, 1);
 899         task_unlock(task);
 900
 901         return file;
 902 }
 903
 904 /*
 905  * Lightweight file lookup - no refcnt increment if fd table isn't shared.
 906  *
 907  * You can use this instead of fget if you satisfy all of the following
 908  * conditions:
 909  * 1) You must call fput_light before exiting the syscall and returning control
 910  *    to userspace (i.e. you cannot remember the returned struct file * after
 911  *    returning to userspace).
 912  * 2) You must not call filp_close on the returned struct file * in between
 913  *    calls to fget_light and fput_light.
 914  * 3) You must not clone the current task in between the calls to fget_light
 915  *    and fput_light.
 916  *
 917  * The fput_needed flag returned by fget_light should be passed to the
 918  * corresponding fput_light.
 919  */
 920 static unsigned long __fget_light(unsigned int fd, fmode_t mask)
 921 {
 922         struct files_struct *files = current->files;
 923         struct file *file;
 924
 925         if (atomic_read(&files->count) == 1) {
 926                 file = __fcheck_files(files, fd);
 927                 if (!file || unlikely(file->f_mode & mask))
 928                         return 0;
 929                 return (unsigned long)file;
 930         } else {
 931                 file = __fget(fd, mask, 1);
 932                 if (!file)
 933                         return 0;
 934                 return FDPUT_FPUT | (unsigned long)file;
 935         }
 936 }
 937 unsigned long __fdget(unsigned int fd)
 938 {
 939         return __fget_light(fd, FMODE_PATH);
 940 }
 941 EXPORT_SYMBOL(__fdget);
 942
 943 unsigned long __fdget_raw(unsigned int fd)
 944 {
 945         return __fget_light(fd, 0);
 946 }
 947
 948 unsigned long __fdget_pos(unsigned int fd)
 949 {
 950         unsigned long v = __fdget(fd);
 951         struct file *file = (struct file *)(v & ~3);
 952
 953         if (file && (file->f_mode & FMODE_ATOMIC_POS)) {
 954                 if (file_count(file) > 1) {
 955                         v |= FDPUT_POS_UNLOCK;
 956                         mutex_lock(&file->f_pos_lock);
 957                 }
 958         }
 959         return v;
 960 }
 961
 962 void __f_unlock_pos(struct file *f)
 963 {
 964         mutex_unlock(&f->f_pos_lock);
 965 }
 966
 967 /*
 968  * We only lock f_pos if we have threads or if the file might be
 969  * shared with another process. In both cases we'll have an elevated
 970  * file count (done either by fdget() or by fork()).
 971  */
 972
 973 void set_close_on_exec(unsigned int fd, int flag)
 974 {
 975         struct files_struct *files = current->files;
 976         struct fdtable *fdt;
 977         spin_lock(&files->file_lock);
 978         fdt = files_fdtable(files);
 979         if (flag)
 980                 __set_close_on_exec(fd, fdt);
 981         else
 982                 __clear_close_on_exec(fd, fdt);
 983         spin_unlock(&files->file_lock);
 984 }
 985
 986 bool get_close_on_exec(unsigned int fd)
 987 {
 988         struct files_struct *files = current->files;
 989         struct fdtable *fdt;
 990         bool res;
 991         rcu_read_lock();
 992         fdt = files_fdtable(files);
 993         res = close_on_exec(fd, fdt);
 994         rcu_read_unlock();
 995         return res;
 996 }
 997
 998 static int do_dup2(struct files_struct *files,
 999         struct file *file, unsigned fd, unsigned flags)
1000 __releases(&files->file_lock)
1001 {
1002         struct file *tofree;
1003         struct fdtable *fdt;
1004
1005         /*
1006          * We need to detect attempts to do dup2() over allocated but still
1007          * not finished descriptor.  NB: OpenBSD avoids that at the price of
1008          * extra work in their equivalent of fget() - they insert struct
1009          * file immediately after grabbing descriptor, mark it larval if
1010          * more work (e.g. actual opening) is needed and make sure that
1011          * fget() treats larval files as absent.  Potentially interesting,
1012          * but while extra work in fget() is trivial, locking implications
1013          * and amount of surgery on open()-related paths in VFS are not.
1014          * FreeBSD fails with -EBADF in the same situation, NetBSD "solution"
1015          * deadlocks in rather amusing ways, AFAICS.  All of that is out of
1016          * scope of POSIX or SUS, since neither considers shared descriptor
1017          * tables and this condition does not arise without those.
1018          */
1019         fdt = files_fdtable(files);
1020         tofree = fdt->fd[fd];
1021         if (!tofree && fd_is_open(fd, fdt))
1022                 goto Ebusy;
1023         get_file(file);
1024         rcu_assign_pointer(fdt->fd[fd], file);
1025         __set_open_fd(fd, fdt);
1026         if (flags & O_CLOEXEC)
1027                 __set_close_on_exec(fd, fdt);
1028         else
1029                 __clear_close_on_exec(fd, fdt);
1030         spin_unlock(&files->file_lock);
1031
1032         if (tofree)
1033                 filp_close(tofree, files);
1034
1035         return fd;
1036
1037 Ebusy:
1038         spin_unlock(&files->file_lock);
1039         return -EBUSY;
1040 }
1041
1042 int replace_fd(unsigned fd, struct file *file, unsigned flags)
1043 {
1044         int err;
1045         struct files_struct *files = current->files;
1046
1047         if (!file)
1048                 return __close_fd(files, fd);
1049
1050         if (fd >= rlimit(RLIMIT_NOFILE))
1051                 return -EBADF;
1052
1053         spin_lock(&files->file_lock);
1054         err = expand_files(files, fd);
1055         if (unlikely(err < 0))
1056                 goto out_unlock;
1057         return do_dup2(files, file, fd, flags);
1058
1059 out_unlock:
1060         spin_unlock(&files->file_lock);
1061         return err;
1062 }
1063
1064 /**
1065  * __receive_fd() - Install received file into file descriptor table
1066  *
1067  * @fd: fd to install into (if negative, a new fd will be allocated)
1068  * @file: struct file that was received from another process
1069  * @ufd: __user pointer to write new fd number to
1070  * @o_flags: the O_* flags to apply to the new fd entry
1071  *
1072  * Installs a received file into the file descriptor table, with appropriate
1073  * checks and count updates. Optionally writes the fd number to userspace, if
1074  * @ufd is non-NULL.
1075  *
1076  * This helper handles its own reference counting of the incoming
1077  * struct file.
1078  *
1079  * Returns newly install fd or -ve on error.
1080  */
1081 int __receive_fd(int fd, struct file *file, int __user *ufd, unsigned int o_flags)
1082 {
1083         int new_fd;
1084         int error;
1085
1086         error = security_file_receive(file);
1087         if (error)
1088                 return error;
1089
1090         if (fd < 0) {
1091                 new_fd = get_unused_fd_flags(o_flags);
1092                 if (new_fd < 0)
1093                         return new_fd;
1094         } else {
1095                 new_fd = fd;
1096         }
1097
1098         if (ufd) {
1099                 error = put_user(new_fd, ufd);
1100                 if (error) {
1101                         if (fd < 0)
1102                                 put_unused_fd(new_fd);
1103                         return error;
1104                 }
1105         }
1106
1107         if (fd < 0) {
1108                 fd_install(new_fd, get_file(file));
1109         } else {
1110                 error = replace_fd(new_fd, file, o_flags);
1111                 if (error)
1112                         return error;
1113         }
1114
1115         /* Bump the sock usage counts, if any. */
1116         __receive_sock(file);
1117         return new_fd;
1118 }
1119
1120 static int ksys_dup3(unsigned int oldfd, unsigned int newfd, int flags)
1121 {
1122         int err = -EBADF;
1123         struct file *file;
1124         struct files_struct *files = current->files;
1125
1126         if ((flags & ~O_CLOEXEC) != 0)
1127                 return -EINVAL;
1128
1129         if (unlikely(oldfd == newfd))
1130                 return -EINVAL;
1131
1132         if (newfd >= rlimit(RLIMIT_NOFILE))
1133                 return -EBADF;
1134
1135         spin_lock(&files->file_lock);
1136         err = expand_files(files, newfd);
1137         file = fcheck(oldfd);
1138         if (unlikely(!file))
1139                 goto Ebadf;
1140         if (unlikely(err < 0)) {
1141                 if (err == -EMFILE)
1142                         goto Ebadf;
1143                 goto out_unlock;
1144         }
1145         return do_dup2(files, file, newfd, flags);
1146
1147 Ebadf:
1148         err = -EBADF;
1149 out_unlock:
1150         spin_unlock(&files->file_lock);
1151         return err;
1152 }
1153
1154 SYSCALL_DEFINE3(dup3, unsigned int, oldfd, unsigned int, newfd, int, flags)
1155 {
1156         return ksys_dup3(oldfd, newfd, flags);
1157 }
1158
1159 SYSCALL_DEFINE2(dup2, unsigned int, oldfd, unsigned int, newfd)
1160 {
1161         if (unlikely(newfd == oldfd)) { /* corner case */
1162                 struct files_struct *files = current->files;
1163                 int retval = oldfd;
1164
1165                 rcu_read_lock();
1166                 if (!fcheck_files(files, oldfd))
1167                         retval = -EBADF;
1168                 rcu_read_unlock();
1169                 return retval;
1170         }
1171         return ksys_dup3(oldfd, newfd, 0);
1172 }
1173
1174 SYSCALL_DEFINE1(dup, unsigned int, fildes)
1175 {
1176         int ret = -EBADF;
1177         struct file *file = fget_raw(fildes);
1178
1179         if (file) {
1180                 ret = get_unused_fd_flags(0);
1181                 if (ret >= 0)
1182                         fd_install(ret, file);
1183                 else
1184                         fput(file);
1185         }
1186         return ret;
1187 }
1188
1189 int f_dupfd(unsigned int from, struct file *file, unsigned flags)
1190 {
1191         int err;
1192         if (from >= rlimit(RLIMIT_NOFILE))
1193                 return -EINVAL;
1194         err = alloc_fd(from, flags);
1195         if (err >= 0) {
1196                 get_file(file);
1197                 fd_install(err, file);
1198         }
1199         return err;
1200 }
1201
1202 int iterate_fd(struct files_struct *files, unsigned n,
1203                 int (*f)(const void *, struct file *, unsigned),
1204                 const void *p)
1205 {
1206         struct fdtable *fdt;
1207         int res = 0;
1208         if (!files)
1209                 return 0;
1210         spin_lock(&files->file_lock);
1211         for (fdt = files_fdtable(files); n < fdt->max_fds; n++) {
1212                 struct file *file;
1213                 file = rcu_dereference_check_fdtable(files, fdt->fd[n]);
1214                 if (!file)
1215                         continue;
1216                 res = f(p, file, n);
1217                 if (res)
1218                         break;
1219         }
1220         spin_unlock(&files->file_lock);
1221         return res;
1222 }
1223 EXPORT_SYMBOL(iterate_fd);