fs/file.c

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