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