sys/kern/kern_descrip.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1989, 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  * (c) UNIX System Laboratories, Inc.
   7  * All or some portions of this file are derived from material licensed
   8  * to the University of California by American Telephone and Telegraph
   9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  10  * the permission of UNIX System Laboratories, Inc.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)kern_descrip.c      8.6 (Berkeley) 4/19/94
  37  */
  38
  39 #include <sys/cdefs.h>
  40 __FBSDID("$FreeBSD$");
  41
  42 #include "opt_capsicum.h"
  43 #include "opt_ddb.h"
  44 #include "opt_ktrace.h"
  45
  46 #include <sys/param.h>
  47 #include <sys/systm.h>
  48
  49 #include <sys/capsicum.h>
  50 #include <sys/conf.h>
  51 #include <sys/fcntl.h>
  52 #include <sys/file.h>
  53 #include <sys/filedesc.h>
  54 #include <sys/filio.h>
  55 #include <sys/jail.h>
  56 #include <sys/kernel.h>
  57 #include <sys/limits.h>
  58 #include <sys/lock.h>
  59 #include <sys/malloc.h>
  60 #include <sys/mount.h>
  61 #include <sys/mutex.h>
  62 #include <sys/namei.h>
  63 #include <sys/selinfo.h>
  64 #include <sys/priv.h>
  65 #include <sys/proc.h>
  66 #include <sys/protosw.h>
  67 #include <sys/racct.h>
  68 #include <sys/resourcevar.h>
  69 #include <sys/sbuf.h>
  70 #include <sys/signalvar.h>
  71 #include <sys/kdb.h>
  72 #include <sys/smr.h>
  73 #include <sys/stat.h>
  74 #include <sys/sx.h>
  75 #include <sys/syscallsubr.h>
  76 #include <sys/sysctl.h>
  77 #include <sys/sysproto.h>
  78 #include <sys/unistd.h>
  79 #include <sys/user.h>
  80 #include <sys/vnode.h>
  81 #ifdef KTRACE
  82 #include <sys/ktrace.h>
  83 #endif
  84
  85 #include <net/vnet.h>
  86
  87 #include <security/audit/audit.h>
  88
  89 #include <vm/uma.h>
  90 #include <vm/vm.h>
  91
  92 #include <ddb/ddb.h>
  93
  94 static MALLOC_DEFINE(M_FILEDESC, "filedesc", "Open file descriptor table");
  95 static MALLOC_DEFINE(M_PWD, "pwd", "Descriptor table vnodes");
  96 static MALLOC_DEFINE(M_PWDDESC, "pwddesc", "Pwd descriptors");
  97 static MALLOC_DEFINE(M_FILEDESC_TO_LEADER, "filedesc_to_leader",
  98     "file desc to leader structures");
  99 static MALLOC_DEFINE(M_SIGIO, "sigio", "sigio structures");
 100 MALLOC_DEFINE(M_FILECAPS, "filecaps", "descriptor capabilities");
 101
 102 MALLOC_DECLARE(M_FADVISE);
 103
 104 static __read_mostly uma_zone_t file_zone;
 105 static __read_mostly uma_zone_t filedesc0_zone;
 106 __read_mostly uma_zone_t pwd_zone;
 107 VFS_SMR_DECLARE;
 108
 109 static int      closefp(struct filedesc *fdp, int fd, struct file *fp,
 110                     struct thread *td, bool holdleaders, bool audit);
 111 static int      fd_first_free(struct filedesc *fdp, int low, int size);
 112 static void     fdgrowtable(struct filedesc *fdp, int nfd);
 113 static void     fdgrowtable_exp(struct filedesc *fdp, int nfd);
 114 static void     fdunused(struct filedesc *fdp, int fd);
 115 static void     fdused(struct filedesc *fdp, int fd);
 116 static int      getmaxfd(struct thread *td);
 117 static u_long   *filecaps_copy_prep(const struct filecaps *src);
 118 static void     filecaps_copy_finish(const struct filecaps *src,
 119                     struct filecaps *dst, u_long *ioctls);
 120 static u_long   *filecaps_free_prep(struct filecaps *fcaps);
 121 static void     filecaps_free_finish(u_long *ioctls);
 122
 123 static struct pwd *pwd_alloc(void);
 124
 125 /*
 126  * Each process has:
 127  *
 128  * - An array of open file descriptors (fd_ofiles)
 129  * - An array of file flags (fd_ofileflags)
 130  * - A bitmap recording which descriptors are in use (fd_map)
 131  *
 132  * A process starts out with NDFILE descriptors.  The value of NDFILE has
 133  * been selected based the historical limit of 20 open files, and an
 134  * assumption that the majority of processes, especially short-lived
 135  * processes like shells, will never need more.
 136  *
 137  * If this initial allocation is exhausted, a larger descriptor table and
 138  * map are allocated dynamically, and the pointers in the process's struct
 139  * filedesc are updated to point to those.  This is repeated every time
 140  * the process runs out of file descriptors (provided it hasn't hit its
 141  * resource limit).
 142  *
 143  * Since threads may hold references to individual descriptor table
 144  * entries, the tables are never freed.  Instead, they are placed on a
 145  * linked list and freed only when the struct filedesc is released.
 146  */
 147 #define NDFILE          20
 148 #define NDSLOTSIZE      sizeof(NDSLOTTYPE)
 149 #define NDENTRIES       (NDSLOTSIZE * __CHAR_BIT)
 150 #define NDSLOT(x)       ((x) / NDENTRIES)
 151 #define NDBIT(x)        ((NDSLOTTYPE)1 << ((x) % NDENTRIES))
 152 #define NDSLOTS(x)      (((x) + NDENTRIES - 1) / NDENTRIES)
 153
 154 /*
 155  * SLIST entry used to keep track of ofiles which must be reclaimed when
 156  * the process exits.
 157  */
 158 struct freetable {
 159         struct fdescenttbl *ft_table;
 160         SLIST_ENTRY(freetable) ft_next;
 161 };
 162
 163 /*
 164  * Initial allocation: a filedesc structure + the head of SLIST used to
 165  * keep track of old ofiles + enough space for NDFILE descriptors.
 166  */
 167
 168 struct fdescenttbl0 {
 169         int     fdt_nfiles;
 170         struct  filedescent fdt_ofiles[NDFILE];
 171 };
 172
 173 struct filedesc0 {
 174         struct filedesc fd_fd;
 175         SLIST_HEAD(, freetable) fd_free;
 176         struct  fdescenttbl0 fd_dfiles;
 177         NDSLOTTYPE fd_dmap[NDSLOTS(NDFILE)];
 178 };
 179
 180 /*
 181  * Descriptor management.
 182  */
 183 static int __exclusive_cache_line openfiles; /* actual number of open files */
 184 struct mtx sigio_lock;          /* mtx to protect pointers to sigio */
 185 void __read_mostly (*mq_fdclose)(struct thread *td, int fd, struct file *fp);
 186
 187 /*
 188  * If low >= size, just return low. Otherwise find the first zero bit in the
 189  * given bitmap, starting at low and not exceeding size - 1. Return size if
 190  * not found.
 191  */
 192 static int
 193 fd_first_free(struct filedesc *fdp, int low, int size)
 194 {
 195         NDSLOTTYPE *map = fdp->fd_map;
 196         NDSLOTTYPE mask;
 197         int off, maxoff;
 198
 199         if (low >= size)
 200                 return (low);
 201
 202         off = NDSLOT(low);
 203         if (low % NDENTRIES) {
 204                 mask = ~(~(NDSLOTTYPE)0 >> (NDENTRIES - (low % NDENTRIES)));
 205                 if ((mask &= ~map[off]) != 0UL)
 206                         return (off * NDENTRIES + ffsl(mask) - 1);
 207                 ++off;
 208         }
 209         for (maxoff = NDSLOTS(size); off < maxoff; ++off)
 210                 if (map[off] != ~0UL)
 211                         return (off * NDENTRIES + ffsl(~map[off]) - 1);
 212         return (size);
 213 }
 214
 215 /*
 216  * Find the last used fd.
 217  *
 218  * Call this variant if fdp can't be modified by anyone else (e.g, during exec).
 219  * Otherwise use fdlastfile.
 220  */
 221 int
 222 fdlastfile_single(struct filedesc *fdp)
 223 {
 224         NDSLOTTYPE *map = fdp->fd_map;
 225         int off, minoff;
 226
 227         off = NDSLOT(fdp->fd_nfiles - 1);
 228         for (minoff = NDSLOT(0); off >= minoff; --off)
 229                 if (map[off] != 0)
 230                         return (off * NDENTRIES + flsl(map[off]) - 1);
 231         return (-1);
 232 }
 233
 234 int
 235 fdlastfile(struct filedesc *fdp)
 236 {
 237
 238         FILEDESC_LOCK_ASSERT(fdp);
 239         return (fdlastfile_single(fdp));
 240 }
 241
 242 static int
 243 fdisused(struct filedesc *fdp, int fd)
 244 {
 245
 246         KASSERT(fd >= 0 && fd < fdp->fd_nfiles,
 247             ("file descriptor %d out of range (0, %d)", fd, fdp->fd_nfiles));
 248
 249         return ((fdp->fd_map[NDSLOT(fd)] & NDBIT(fd)) != 0);
 250 }
 251
 252 /*
 253  * Mark a file descriptor as used.
 254  */
 255 static void
 256 fdused_init(struct filedesc *fdp, int fd)
 257 {
 258
 259         KASSERT(!fdisused(fdp, fd), ("fd=%d is already used", fd));
 260
 261         fdp->fd_map[NDSLOT(fd)] |= NDBIT(fd);
 262 }
 263
 264 static void
 265 fdused(struct filedesc *fdp, int fd)
 266 {
 267
 268         FILEDESC_XLOCK_ASSERT(fdp);
 269
 270         fdused_init(fdp, fd);
 271         if (fd == fdp->fd_freefile)
 272                 fdp->fd_freefile++;
 273 }
 274
 275 /*
 276  * Mark a file descriptor as unused.
 277  */
 278 static void
 279 fdunused(struct filedesc *fdp, int fd)
 280 {
 281
 282         FILEDESC_XLOCK_ASSERT(fdp);
 283
 284         KASSERT(fdisused(fdp, fd), ("fd=%d is already unused", fd));
 285         KASSERT(fdp->fd_ofiles[fd].fde_file == NULL,
 286             ("fd=%d is still in use", fd));
 287
 288         fdp->fd_map[NDSLOT(fd)] &= ~NDBIT(fd);
 289         if (fd < fdp->fd_freefile)
 290                 fdp->fd_freefile = fd;
 291 }
 292
 293 /*
 294  * Free a file descriptor.
 295  *
 296  * Avoid some work if fdp is about to be destroyed.
 297  */
 298 static inline void
 299 fdefree_last(struct filedescent *fde)
 300 {
 301
 302         filecaps_free(&fde->fde_caps);
 303 }
 304
 305 static inline void
 306 fdfree(struct filedesc *fdp, int fd)
 307 {
 308         struct filedescent *fde;
 309
 310         fde = &fdp->fd_ofiles[fd];
 311 #ifdef CAPABILITIES
 312         seqc_write_begin(&fde->fde_seqc);
 313 #endif
 314         fde->fde_file = NULL;
 315 #ifdef CAPABILITIES
 316         seqc_write_end(&fde->fde_seqc);
 317 #endif
 318         fdefree_last(fde);
 319         fdunused(fdp, fd);
 320 }
 321
 322 /*
 323  * System calls on descriptors.
 324  */
 325 #ifndef _SYS_SYSPROTO_H_
 326 struct getdtablesize_args {
 327         int     dummy;
 328 };
 329 #endif
 330 /* ARGSUSED */
 331 int
 332 sys_getdtablesize(struct thread *td, struct getdtablesize_args *uap)
 333 {
 334 #ifdef  RACCT
 335         uint64_t lim;
 336 #endif
 337
 338         td->td_retval[0] = getmaxfd(td);
 339 #ifdef  RACCT
 340         PROC_LOCK(td->td_proc);
 341         lim = racct_get_limit(td->td_proc, RACCT_NOFILE);
 342         PROC_UNLOCK(td->td_proc);
 343         if (lim < td->td_retval[0])
 344                 td->td_retval[0] = lim;
 345 #endif
 346         return (0);
 347 }
 348
 349 /*
 350  * Duplicate a file descriptor to a particular value.
 351  *
 352  * Note: keep in mind that a potential race condition exists when closing
 353  * descriptors from a shared descriptor table (via rfork).
 354  */
 355 #ifndef _SYS_SYSPROTO_H_
 356 struct dup2_args {
 357         u_int   from;
 358         u_int   to;
 359 };
 360 #endif
 361 /* ARGSUSED */
 362 int
 363 sys_dup2(struct thread *td, struct dup2_args *uap)
 364 {
 365
 366         return (kern_dup(td, FDDUP_FIXED, 0, (int)uap->from, (int)uap->to));
 367 }
 368
 369 /*
 370  * Duplicate a file descriptor.
 371  */
 372 #ifndef _SYS_SYSPROTO_H_
 373 struct dup_args {
 374         u_int   fd;
 375 };
 376 #endif
 377 /* ARGSUSED */
 378 int
 379 sys_dup(struct thread *td, struct dup_args *uap)
 380 {
 381
 382         return (kern_dup(td, FDDUP_NORMAL, 0, (int)uap->fd, 0));
 383 }
 384
 385 /*
 386  * The file control system call.
 387  */
 388 #ifndef _SYS_SYSPROTO_H_
 389 struct fcntl_args {
 390         int     fd;
 391         int     cmd;
 392         long    arg;
 393 };
 394 #endif
 395 /* ARGSUSED */
 396 int
 397 sys_fcntl(struct thread *td, struct fcntl_args *uap)
 398 {
 399
 400         return (kern_fcntl_freebsd(td, uap->fd, uap->cmd, uap->arg));
 401 }
 402
 403 int
 404 kern_fcntl_freebsd(struct thread *td, int fd, int cmd, long arg)
 405 {
 406         struct flock fl;
 407         struct __oflock ofl;
 408         intptr_t arg1;
 409         int error, newcmd;
 410
 411         error = 0;
 412         newcmd = cmd;
 413         switch (cmd) {
 414         case F_OGETLK:
 415         case F_OSETLK:
 416         case F_OSETLKW:
 417                 /*
 418                  * Convert old flock structure to new.
 419                  */
 420                 error = copyin((void *)(intptr_t)arg, &ofl, sizeof(ofl));
 421                 fl.l_start = ofl.l_start;
 422                 fl.l_len = ofl.l_len;
 423                 fl.l_pid = ofl.l_pid;
 424                 fl.l_type = ofl.l_type;
 425                 fl.l_whence = ofl.l_whence;
 426                 fl.l_sysid = 0;
 427
 428                 switch (cmd) {
 429                 case F_OGETLK:
 430                         newcmd = F_GETLK;
 431                         break;
 432                 case F_OSETLK:
 433                         newcmd = F_SETLK;
 434                         break;
 435                 case F_OSETLKW:
 436                         newcmd = F_SETLKW;
 437                         break;
 438                 }
 439                 arg1 = (intptr_t)&fl;
 440                 break;
 441         case F_GETLK:
 442         case F_SETLK:
 443         case F_SETLKW:
 444         case F_SETLK_REMOTE:
 445                 error = copyin((void *)(intptr_t)arg, &fl, sizeof(fl));
 446                 arg1 = (intptr_t)&fl;
 447                 break;
 448         default:
 449                 arg1 = arg;
 450                 break;
 451         }
 452         if (error)
 453                 return (error);
 454         error = kern_fcntl(td, fd, newcmd, arg1);
 455         if (error)
 456                 return (error);
 457         if (cmd == F_OGETLK) {
 458                 ofl.l_start = fl.l_start;
 459                 ofl.l_len = fl.l_len;
 460                 ofl.l_pid = fl.l_pid;
 461                 ofl.l_type = fl.l_type;
 462                 ofl.l_whence = fl.l_whence;
 463                 error = copyout(&ofl, (void *)(intptr_t)arg, sizeof(ofl));
 464         } else if (cmd == F_GETLK) {
 465                 error = copyout(&fl, (void *)(intptr_t)arg, sizeof(fl));
 466         }
 467         return (error);
 468 }
 469
 470 int
 471 kern_fcntl(struct thread *td, int fd, int cmd, intptr_t arg)
 472 {
 473         struct filedesc *fdp;
 474         struct flock *flp;
 475         struct file *fp, *fp2;
 476         struct filedescent *fde;
 477         struct proc *p;
 478         struct vnode *vp;
 479         struct mount *mp;
 480         int error, flg, seals, tmp;
 481         uint64_t bsize;
 482         off_t foffset;
 483
 484         error = 0;
 485         flg = F_POSIX;
 486         p = td->td_proc;
 487         fdp = p->p_fd;
 488
 489         AUDIT_ARG_FD(cmd);
 490         AUDIT_ARG_CMD(cmd);
 491         switch (cmd) {
 492         case F_DUPFD:
 493                 tmp = arg;
 494                 error = kern_dup(td, FDDUP_FCNTL, 0, fd, tmp);
 495                 break;
 496
 497         case F_DUPFD_CLOEXEC:
 498                 tmp = arg;
 499                 error = kern_dup(td, FDDUP_FCNTL, FDDUP_FLAG_CLOEXEC, fd, tmp);
 500                 break;
 501
 502         case F_DUP2FD:
 503                 tmp = arg;
 504                 error = kern_dup(td, FDDUP_FIXED, 0, fd, tmp);
 505                 break;
 506
 507         case F_DUP2FD_CLOEXEC:
 508                 tmp = arg;
 509                 error = kern_dup(td, FDDUP_FIXED, FDDUP_FLAG_CLOEXEC, fd, tmp);
 510                 break;
 511
 512         case F_GETFD:
 513                 error = EBADF;
 514                 FILEDESC_SLOCK(fdp);
 515                 fde = fdeget_locked(fdp, fd);
 516                 if (fde != NULL) {
 517                         td->td_retval[0] =
 518                             (fde->fde_flags & UF_EXCLOSE) ? FD_CLOEXEC : 0;
 519                         error = 0;
 520                 }
 521                 FILEDESC_SUNLOCK(fdp);
 522                 break;
 523
 524         case F_SETFD:
 525                 error = EBADF;
 526                 FILEDESC_XLOCK(fdp);
 527                 fde = fdeget_locked(fdp, fd);
 528                 if (fde != NULL) {
 529                         fde->fde_flags = (fde->fde_flags & ~UF_EXCLOSE) |
 530                             (arg & FD_CLOEXEC ? UF_EXCLOSE : 0);
 531                         error = 0;
 532                 }
 533                 FILEDESC_XUNLOCK(fdp);
 534                 break;
 535
 536         case F_GETFL:
 537                 error = fget_fcntl(td, fd, &cap_fcntl_rights, F_GETFL, &fp);
 538                 if (error != 0)
 539                         break;
 540                 td->td_retval[0] = OFLAGS(fp->f_flag);
 541                 fdrop(fp, td);
 542                 break;
 543
 544         case F_SETFL:
 545                 error = fget_fcntl(td, fd, &cap_fcntl_rights, F_SETFL, &fp);
 546                 if (error != 0)
 547                         break;
 548                 do {
 549                         tmp = flg = fp->f_flag;
 550                         tmp &= ~FCNTLFLAGS;
 551                         tmp |= FFLAGS(arg & ~O_ACCMODE) & FCNTLFLAGS;
 552                 } while(atomic_cmpset_int(&fp->f_flag, flg, tmp) == 0);
 553                 tmp = fp->f_flag & FNONBLOCK;
 554                 error = fo_ioctl(fp, FIONBIO, &tmp, td->td_ucred, td);
 555                 if (error != 0) {
 556                         fdrop(fp, td);
 557                         break;
 558                 }
 559                 tmp = fp->f_flag & FASYNC;
 560                 error = fo_ioctl(fp, FIOASYNC, &tmp, td->td_ucred, td);
 561                 if (error == 0) {
 562                         fdrop(fp, td);
 563                         break;
 564                 }
 565                 atomic_clear_int(&fp->f_flag, FNONBLOCK);
 566                 tmp = 0;
 567                 (void)fo_ioctl(fp, FIONBIO, &tmp, td->td_ucred, td);
 568                 fdrop(fp, td);
 569                 break;
 570
 571         case F_GETOWN:
 572                 error = fget_fcntl(td, fd, &cap_fcntl_rights, F_GETOWN, &fp);
 573                 if (error != 0)
 574                         break;
 575                 error = fo_ioctl(fp, FIOGETOWN, &tmp, td->td_ucred, td);
 576                 if (error == 0)
 577                         td->td_retval[0] = tmp;
 578                 fdrop(fp, td);
 579                 break;
 580
 581         case F_SETOWN:
 582                 error = fget_fcntl(td, fd, &cap_fcntl_rights, F_SETOWN, &fp);
 583                 if (error != 0)
 584                         break;
 585                 tmp = arg;
 586                 error = fo_ioctl(fp, FIOSETOWN, &tmp, td->td_ucred, td);
 587                 fdrop(fp, td);
 588                 break;
 589
 590         case F_SETLK_REMOTE:
 591                 error = priv_check(td, PRIV_NFS_LOCKD);
 592                 if (error != 0)
 593                         return (error);
 594                 flg = F_REMOTE;
 595                 goto do_setlk;
 596
 597         case F_SETLKW:
 598                 flg |= F_WAIT;
 599                 /* FALLTHROUGH F_SETLK */
 600
 601         case F_SETLK:
 602         do_setlk:
 603                 flp = (struct flock *)arg;
 604                 if ((flg & F_REMOTE) != 0 && flp->l_sysid == 0) {
 605                         error = EINVAL;
 606                         break;
 607                 }
 608
 609                 error = fget_unlocked(fdp, fd, &cap_flock_rights, &fp);
 610                 if (error != 0)
 611                         break;
 612                 if (fp->f_type != DTYPE_VNODE) {
 613                         error = EBADF;
 614                         fdrop(fp, td);
 615                         break;
 616                 }
 617
 618                 if (flp->l_whence == SEEK_CUR) {
 619                         foffset = foffset_get(fp);
 620                         if (foffset < 0 ||
 621                             (flp->l_start > 0 &&
 622                              foffset > OFF_MAX - flp->l_start)) {
 623                                 error = EOVERFLOW;
 624                                 fdrop(fp, td);
 625                                 break;
 626                         }
 627                         flp->l_start += foffset;
 628                 }
 629
 630                 vp = fp->f_vnode;
 631                 switch (flp->l_type) {
 632                 case F_RDLCK:
 633                         if ((fp->f_flag & FREAD) == 0) {
 634                                 error = EBADF;
 635                                 break;
 636                         }
 637                         if ((p->p_leader->p_flag & P_ADVLOCK) == 0) {
 638                                 PROC_LOCK(p->p_leader);
 639                                 p->p_leader->p_flag |= P_ADVLOCK;
 640                                 PROC_UNLOCK(p->p_leader);
 641                         }
 642                         error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader, F_SETLK,
 643                             flp, flg);
 644                         break;
 645                 case F_WRLCK:
 646                         if ((fp->f_flag & FWRITE) == 0) {
 647                                 error = EBADF;
 648                                 break;
 649                         }
 650                         if ((p->p_leader->p_flag & P_ADVLOCK) == 0) {
 651                                 PROC_LOCK(p->p_leader);
 652                                 p->p_leader->p_flag |= P_ADVLOCK;
 653                                 PROC_UNLOCK(p->p_leader);
 654                         }
 655                         error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader, F_SETLK,
 656                             flp, flg);
 657                         break;
 658                 case F_UNLCK:
 659                         error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader, F_UNLCK,
 660                             flp, flg);
 661                         break;
 662                 case F_UNLCKSYS:
 663                         if (flg != F_REMOTE) {
 664                                 error = EINVAL;
 665                                 break;
 666                         }
 667                         error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader,
 668                             F_UNLCKSYS, flp, flg);
 669                         break;
 670                 default:
 671                         error = EINVAL;
 672                         break;
 673                 }
 674                 if (error != 0 || flp->l_type == F_UNLCK ||
 675                     flp->l_type == F_UNLCKSYS) {
 676                         fdrop(fp, td);
 677                         break;
 678                 }
 679
 680                 /*
 681                  * Check for a race with close.
 682                  *
 683                  * The vnode is now advisory locked (or unlocked, but this case
 684                  * is not really important) as the caller requested.
 685                  * We had to drop the filedesc lock, so we need to recheck if
 686                  * the descriptor is still valid, because if it was closed
 687                  * in the meantime we need to remove advisory lock from the
 688                  * vnode - close on any descriptor leading to an advisory
 689                  * locked vnode, removes that lock.
 690                  * We will return 0 on purpose in that case, as the result of
 691                  * successful advisory lock might have been externally visible
 692                  * already. This is fine - effectively we pretend to the caller
 693                  * that the closing thread was a bit slower and that the
 694                  * advisory lock succeeded before the close.
 695                  */
 696                 error = fget_unlocked(fdp, fd, &cap_no_rights, &fp2);
 697                 if (error != 0) {
 698                         fdrop(fp, td);
 699                         break;
 700                 }
 701                 if (fp != fp2) {
 702                         flp->l_whence = SEEK_SET;
 703                         flp->l_start = 0;
 704                         flp->l_len = 0;
 705                         flp->l_type = F_UNLCK;
 706                         (void) VOP_ADVLOCK(vp, (caddr_t)p->p_leader,
 707                             F_UNLCK, flp, F_POSIX);
 708                 }
 709                 fdrop(fp, td);
 710                 fdrop(fp2, td);
 711                 break;
 712
 713         case F_GETLK:
 714                 error = fget_unlocked(fdp, fd, &cap_flock_rights, &fp);
 715                 if (error != 0)
 716                         break;
 717                 if (fp->f_type != DTYPE_VNODE) {
 718                         error = EBADF;
 719                         fdrop(fp, td);
 720                         break;
 721                 }
 722                 flp = (struct flock *)arg;
 723                 if (flp->l_type != F_RDLCK && flp->l_type != F_WRLCK &&
 724                     flp->l_type != F_UNLCK) {
 725                         error = EINVAL;
 726                         fdrop(fp, td);
 727                         break;
 728                 }
 729                 if (flp->l_whence == SEEK_CUR) {
 730                         foffset = foffset_get(fp);
 731                         if ((flp->l_start > 0 &&
 732                             foffset > OFF_MAX - flp->l_start) ||
 733                             (flp->l_start < 0 &&
 734                             foffset < OFF_MIN - flp->l_start)) {
 735                                 error = EOVERFLOW;
 736                                 fdrop(fp, td);
 737                                 break;
 738                         }
 739                         flp->l_start += foffset;
 740                 }
 741                 vp = fp->f_vnode;
 742                 error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader, F_GETLK, flp,
 743                     F_POSIX);
 744                 fdrop(fp, td);
 745                 break;
 746
 747         case F_ADD_SEALS:
 748                 error = fget_unlocked(fdp, fd, &cap_no_rights, &fp);
 749                 if (error != 0)
 750                         break;
 751                 error = fo_add_seals(fp, arg);
 752                 fdrop(fp, td);
 753                 break;
 754
 755         case F_GET_SEALS:
 756                 error = fget_unlocked(fdp, fd, &cap_no_rights, &fp);
 757                 if (error != 0)
 758                         break;
 759                 if (fo_get_seals(fp, &seals) == 0)
 760                         td->td_retval[0] = seals;
 761                 else
 762                         error = EINVAL;
 763                 fdrop(fp, td);
 764                 break;
 765
 766         case F_RDAHEAD:
 767                 arg = arg ? 128 * 1024: 0;
 768                 /* FALLTHROUGH */
 769         case F_READAHEAD:
 770                 error = fget_unlocked(fdp, fd, &cap_no_rights, &fp);
 771                 if (error != 0)
 772                         break;
 773                 if (fp->f_type != DTYPE_VNODE) {
 774                         fdrop(fp, td);
 775                         error = EBADF;
 776                         break;
 777                 }
 778                 vp = fp->f_vnode;
 779                 if (vp->v_type != VREG) {
 780                         fdrop(fp, td);
 781                         error = ENOTTY;
 782                         break;
 783                 }
 784
 785                 /*
 786                  * Exclusive lock synchronizes against f_seqcount reads and
 787                  * writes in sequential_heuristic().
 788                  */
 789                 error = vn_lock(vp, LK_EXCLUSIVE);
 790                 if (error != 0) {
 791                         fdrop(fp, td);
 792                         break;
 793                 }
 794                 if (arg >= 0) {
 795                         bsize = fp->f_vnode->v_mount->mnt_stat.f_iosize;
 796                         arg = MIN(arg, INT_MAX - bsize + 1);
 797                         fp->f_seqcount[UIO_READ] = MIN(IO_SEQMAX,
 798                             (arg + bsize - 1) / bsize);
 799                         atomic_set_int(&fp->f_flag, FRDAHEAD);
 800                 } else {
 801                         atomic_clear_int(&fp->f_flag, FRDAHEAD);
 802                 }
 803                 VOP_UNLOCK(vp);
 804                 fdrop(fp, td);
 805                 break;
 806
 807         case F_ISUNIONSTACK:
 808                 /*
 809                  * Check if the vnode is part of a union stack (either the
 810                  * "union" flag from mount(2) or unionfs).
 811                  *
 812                  * Prior to introduction of this op libc's readdir would call
 813                  * fstatfs(2), in effect unnecessarily copying kilobytes of
 814                  * data just to check fs name and a mount flag.
 815                  *
 816                  * Fixing the code to handle everything in the kernel instead
 817                  * is a non-trivial endeavor and has low priority, thus this
 818                  * horrible kludge facilitates the current behavior in a much
 819                  * cheaper manner until someone(tm) sorts this out.
 820                  */
 821                 error = fget_unlocked(fdp, fd, &cap_no_rights, &fp);
 822                 if (error != 0)
 823                         break;
 824                 if (fp->f_type != DTYPE_VNODE) {
 825                         fdrop(fp, td);
 826                         error = EBADF;
 827                         break;
 828                 }
 829                 vp = fp->f_vnode;
 830                 /*
 831                  * Since we don't prevent dooming the vnode even non-null mp
 832                  * found can become immediately stale. This is tolerable since
 833                  * mount points are type-stable (providing safe memory access)
 834                  * and any vfs op on this vnode going forward will return an
 835                  * error (meaning return value in this case is meaningless).
 836                  */
 837                 mp = atomic_load_ptr(&vp->v_mount);
 838                 if (__predict_false(mp == NULL)) {
 839                         fdrop(fp, td);
 840                         error = EBADF;
 841                         break;
 842                 }
 843                 td->td_retval[0] = 0;
 844                 if (mp->mnt_kern_flag & MNTK_UNIONFS ||
 845                     mp->mnt_flag & MNT_UNION)
 846                         td->td_retval[0] = 1;
 847                 fdrop(fp, td);
 848                 break;
 849
 850         default:
 851                 error = EINVAL;
 852                 break;
 853         }
 854         return (error);
 855 }
 856
 857 static int
 858 getmaxfd(struct thread *td)
 859 {
 860
 861         return (min((int)lim_cur(td, RLIMIT_NOFILE), maxfilesperproc));
 862 }
 863
 864 /*
 865  * Common code for dup, dup2, fcntl(F_DUPFD) and fcntl(F_DUP2FD).
 866  */
 867 int
 868 kern_dup(struct thread *td, u_int mode, int flags, int old, int new)
 869 {
 870         struct filedesc *fdp;
 871         struct filedescent *oldfde, *newfde;
 872         struct proc *p;
 873         struct file *delfp, *oldfp;
 874         u_long *oioctls, *nioctls;
 875         int error, maxfd;
 876
 877         p = td->td_proc;
 878         fdp = p->p_fd;
 879         oioctls = NULL;
 880
 881         MPASS((flags & ~(FDDUP_FLAG_CLOEXEC)) == 0);
 882         MPASS(mode < FDDUP_LASTMODE);
 883
 884         AUDIT_ARG_FD(old);
 885         /* XXXRW: if (flags & FDDUP_FIXED) AUDIT_ARG_FD2(new); */
 886
 887         /*
 888          * Verify we have a valid descriptor to dup from and possibly to
 889          * dup to. Unlike dup() and dup2(), fcntl()'s F_DUPFD should
 890          * return EINVAL when the new descriptor is out of bounds.
 891          */
 892         if (old < 0)
 893                 return (EBADF);
 894         if (new < 0)
 895                 return (mode == FDDUP_FCNTL ? EINVAL : EBADF);
 896         maxfd = getmaxfd(td);
 897         if (new >= maxfd)
 898                 return (mode == FDDUP_FCNTL ? EINVAL : EBADF);
 899
 900         error = EBADF;
 901         FILEDESC_XLOCK(fdp);
 902         if (fget_locked(fdp, old) == NULL)
 903                 goto unlock;
 904         if ((mode == FDDUP_FIXED || mode == FDDUP_MUSTREPLACE) && old == new) {
 905                 td->td_retval[0] = new;
 906                 if (flags & FDDUP_FLAG_CLOEXEC)
 907                         fdp->fd_ofiles[new].fde_flags |= UF_EXCLOSE;
 908                 error = 0;
 909                 goto unlock;
 910         }
 911
 912         oldfde = &fdp->fd_ofiles[old];
 913         oldfp = oldfde->fde_file;
 914         if (!fhold(oldfp))
 915                 goto unlock;
 916
 917         /*
 918          * If the caller specified a file descriptor, make sure the file
 919          * table is large enough to hold it, and grab it.  Otherwise, just
 920          * allocate a new descriptor the usual way.
 921          */
 922         switch (mode) {
 923         case FDDUP_NORMAL:
 924         case FDDUP_FCNTL:
 925                 if ((error = fdalloc(td, new, &new)) != 0) {
 926                         fdrop(oldfp, td);
 927                         goto unlock;
 928                 }
 929                 break;
 930         case FDDUP_MUSTREPLACE:
 931                 /* Target file descriptor must exist. */
 932                 if (fget_locked(fdp, new) == NULL) {
 933                         fdrop(oldfp, td);
 934                         goto unlock;
 935                 }
 936                 break;
 937         case FDDUP_FIXED:
 938                 if (new >= fdp->fd_nfiles) {
 939                         /*
 940                          * The resource limits are here instead of e.g.
 941                          * fdalloc(), because the file descriptor table may be
 942                          * shared between processes, so we can't really use
 943                          * racct_add()/racct_sub().  Instead of counting the
 944                          * number of actually allocated descriptors, just put
 945                          * the limit on the size of the file descriptor table.
 946                          */
 947 #ifdef RACCT
 948                         if (RACCT_ENABLED()) {
 949                                 error = racct_set_unlocked(p, RACCT_NOFILE, new + 1);
 950                                 if (error != 0) {
 951                                         error = EMFILE;
 952                                         fdrop(oldfp, td);
 953                                         goto unlock;
 954                                 }
 955                         }
 956 #endif
 957                         fdgrowtable_exp(fdp, new + 1);
 958                 }
 959                 if (!fdisused(fdp, new))
 960                         fdused(fdp, new);
 961                 break;
 962         default:
 963                 KASSERT(0, ("%s unsupported mode %d", __func__, mode));
 964         }
 965
 966         KASSERT(old != new, ("new fd is same as old"));
 967
 968         /* Refetch oldfde because the table may have grown and old one freed. */
 969         oldfde = &fdp->fd_ofiles[old];
 970         KASSERT(oldfp == oldfde->fde_file,
 971             ("fdt_ofiles shift from growth observed at fd %d",
 972             old));
 973
 974         newfde = &fdp->fd_ofiles[new];
 975         delfp = newfde->fde_file;
 976
 977         nioctls = filecaps_copy_prep(&oldfde->fde_caps);
 978
 979         /*
 980          * Duplicate the source descriptor.
 981          */
 982 #ifdef CAPABILITIES
 983         seqc_write_begin(&newfde->fde_seqc);
 984 #endif
 985         oioctls = filecaps_free_prep(&newfde->fde_caps);
 986         memcpy(newfde, oldfde, fde_change_size);
 987         filecaps_copy_finish(&oldfde->fde_caps, &newfde->fde_caps,
 988             nioctls);
 989         if ((flags & FDDUP_FLAG_CLOEXEC) != 0)
 990                 newfde->fde_flags = oldfde->fde_flags | UF_EXCLOSE;
 991         else
 992                 newfde->fde_flags = oldfde->fde_flags & ~UF_EXCLOSE;
 993 #ifdef CAPABILITIES
 994         seqc_write_end(&newfde->fde_seqc);
 995 #endif
 996         td->td_retval[0] = new;
 997
 998         error = 0;
 999
1000         if (delfp != NULL) {
1001                 (void) closefp(fdp, new, delfp, td, true, false);
1002                 FILEDESC_UNLOCK_ASSERT(fdp);
1003         } else {
1004 unlock:
1005                 FILEDESC_XUNLOCK(fdp);
1006         }
1007
1008         filecaps_free_finish(oioctls);
1009         return (error);
1010 }
1011
1012 static void
1013 sigiofree(struct sigio *sigio)
1014 {
1015         crfree(sigio->sio_ucred);
1016         free(sigio, M_SIGIO);
1017 }
1018
1019 static struct sigio *
1020 funsetown_locked(struct sigio *sigio)
1021 {
1022         struct proc *p;
1023         struct pgrp *pg;
1024
1025         SIGIO_ASSERT_LOCKED();
1026
1027         if (sigio == NULL)
1028                 return (NULL);
1029         *(sigio->sio_myref) = NULL;
1030         if (sigio->sio_pgid < 0) {
1031                 pg = sigio->sio_pgrp;
1032                 PGRP_LOCK(pg);
1033                 SLIST_REMOVE(&sigio->sio_pgrp->pg_sigiolst, sigio,
1034                     sigio, sio_pgsigio);
1035                 PGRP_UNLOCK(pg);
1036         } else {
1037                 p = sigio->sio_proc;
1038                 PROC_LOCK(p);
1039                 SLIST_REMOVE(&sigio->sio_proc->p_sigiolst, sigio,
1040                     sigio, sio_pgsigio);
1041                 PROC_UNLOCK(p);
1042         }
1043         return (sigio);
1044 }
1045
1046 /*
1047  * If sigio is on the list associated with a process or process group,
1048  * disable signalling from the device, remove sigio from the list and
1049  * free sigio.
1050  */
1051 void
1052 funsetown(struct sigio **sigiop)
1053 {
1054         struct sigio *sigio;
1055
1056         /* Racy check, consumers must provide synchronization. */
1057         if (*sigiop == NULL)
1058                 return;
1059
1060         SIGIO_LOCK();
1061         sigio = funsetown_locked(*sigiop);
1062         SIGIO_UNLOCK();
1063         if (sigio != NULL)
1064                 sigiofree(sigio);
1065 }
1066
1067 /*
1068  * Free a list of sigio structures.  The caller must ensure that new sigio
1069  * structures cannot be added after this point.  For process groups this is
1070  * guaranteed using the proctree lock; for processes, the P_WEXIT flag serves
1071  * as an interlock.
1072  */
1073 void
1074 funsetownlst(struct sigiolst *sigiolst)
1075 {
1076         struct proc *p;
1077         struct pgrp *pg;
1078         struct sigio *sigio, *tmp;
1079
1080         /* Racy check. */
1081         sigio = SLIST_FIRST(sigiolst);
1082         if (sigio == NULL)
1083                 return;
1084
1085         p = NULL;
1086         pg = NULL;
1087
1088         SIGIO_LOCK();
1089         sigio = SLIST_FIRST(sigiolst);
1090         if (sigio == NULL) {
1091                 SIGIO_UNLOCK();
1092                 return;
1093         }
1094
1095         /*
1096          * Every entry of the list should belong to a single proc or pgrp.
1097          */
1098         if (sigio->sio_pgid < 0) {
1099                 pg = sigio->sio_pgrp;
1100                 sx_assert(&proctree_lock, SX_XLOCKED);
1101                 PGRP_LOCK(pg);
1102         } else /* if (sigio->sio_pgid > 0) */ {
1103                 p = sigio->sio_proc;
1104                 PROC_LOCK(p);
1105                 KASSERT((p->p_flag & P_WEXIT) != 0,
1106                     ("%s: process %p is not exiting", __func__, p));
1107         }
1108
1109         SLIST_FOREACH(sigio, sigiolst, sio_pgsigio) {
1110                 *sigio->sio_myref = NULL;
1111                 if (pg != NULL) {
1112                         KASSERT(sigio->sio_pgid < 0,
1113                             ("Proc sigio in pgrp sigio list"));
1114                         KASSERT(sigio->sio_pgrp == pg,
1115                             ("Bogus pgrp in sigio list"));
1116                 } else /* if (p != NULL) */ {
1117                         KASSERT(sigio->sio_pgid > 0,
1118                             ("Pgrp sigio in proc sigio list"));
1119                         KASSERT(sigio->sio_proc == p,
1120                             ("Bogus proc in sigio list"));
1121                 }
1122         }
1123
1124         if (pg != NULL)
1125                 PGRP_UNLOCK(pg);
1126         else
1127                 PROC_UNLOCK(p);
1128         SIGIO_UNLOCK();
1129
1130         SLIST_FOREACH_SAFE(sigio, sigiolst, sio_pgsigio, tmp)
1131                 sigiofree(sigio);
1132 }
1133
1134 /*
1135  * This is common code for FIOSETOWN ioctl called by fcntl(fd, F_SETOWN, arg).
1136  *
1137  * After permission checking, add a sigio structure to the sigio list for
1138  * the process or process group.
1139  */
1140 int
1141 fsetown(pid_t pgid, struct sigio **sigiop)
1142 {
1143         struct proc *proc;
1144         struct pgrp *pgrp;
1145         struct sigio *osigio, *sigio;
1146         int ret;
1147
1148         if (pgid == 0) {
1149                 funsetown(sigiop);
1150                 return (0);
1151         }
1152
1153         ret = 0;
1154
1155         sigio = malloc(sizeof(struct sigio), M_SIGIO, M_WAITOK);
1156         sigio->sio_pgid = pgid;
1157         sigio->sio_ucred = crhold(curthread->td_ucred);
1158         sigio->sio_myref = sigiop;
1159
1160         sx_slock(&proctree_lock);
1161         SIGIO_LOCK();
1162         osigio = funsetown_locked(*sigiop);
1163         if (pgid > 0) {
1164                 proc = pfind(pgid);
1165                 if (proc == NULL) {
1166                         ret = ESRCH;
1167                         goto fail;
1168                 }
1169
1170                 /*
1171                  * Policy - Don't allow a process to FSETOWN a process
1172                  * in another session.
1173                  *
1174                  * Remove this test to allow maximum flexibility or
1175                  * restrict FSETOWN to the current process or process
1176                  * group for maximum safety.
1177                  */
1178                 if (proc->p_session != curthread->td_proc->p_session) {
1179                         PROC_UNLOCK(proc);
1180                         ret = EPERM;
1181                         goto fail;
1182                 }
1183
1184                 sigio->sio_proc = proc;
1185                 SLIST_INSERT_HEAD(&proc->p_sigiolst, sigio, sio_pgsigio);
1186                 PROC_UNLOCK(proc);
1187         } else /* if (pgid < 0) */ {
1188                 pgrp = pgfind(-pgid);
1189                 if (pgrp == NULL) {
1190                         ret = ESRCH;
1191                         goto fail;
1192                 }
1193
1194                 /*
1195                  * Policy - Don't allow a process to FSETOWN a process
1196                  * in another session.
1197                  *
1198                  * Remove this test to allow maximum flexibility or
1199                  * restrict FSETOWN to the current process or process
1200                  * group for maximum safety.
1201                  */
1202                 if (pgrp->pg_session != curthread->td_proc->p_session) {
1203                         PGRP_UNLOCK(pgrp);
1204                         ret = EPERM;
1205                         goto fail;
1206                 }
1207
1208                 SLIST_INSERT_HEAD(&pgrp->pg_sigiolst, sigio, sio_pgsigio);
1209                 sigio->sio_pgrp = pgrp;
1210                 PGRP_UNLOCK(pgrp);
1211         }
1212         sx_sunlock(&proctree_lock);
1213         *sigiop = sigio;
1214         SIGIO_UNLOCK();
1215         if (osigio != NULL)
1216                 sigiofree(osigio);
1217         return (0);
1218
1219 fail:
1220         SIGIO_UNLOCK();
1221         sx_sunlock(&proctree_lock);
1222         sigiofree(sigio);
1223         if (osigio != NULL)
1224                 sigiofree(osigio);
1225         return (ret);
1226 }
1227
1228 /*
1229  * This is common code for FIOGETOWN ioctl called by fcntl(fd, F_GETOWN, arg).
1230  */
1231 pid_t
1232 fgetown(struct sigio **sigiop)
1233 {
1234         pid_t pgid;
1235
1236         SIGIO_LOCK();
1237         pgid = (*sigiop != NULL) ? (*sigiop)->sio_pgid : 0;
1238         SIGIO_UNLOCK();
1239         return (pgid);
1240 }
1241
1242 static int
1243 closefp_impl(struct filedesc *fdp, int fd, struct file *fp, struct thread *td,
1244     bool audit)
1245 {
1246         int error;
1247
1248         FILEDESC_XLOCK_ASSERT(fdp);
1249
1250         /*
1251          * We now hold the fp reference that used to be owned by the
1252          * descriptor array.  We have to unlock the FILEDESC *AFTER*
1253          * knote_fdclose to prevent a race of the fd getting opened, a knote
1254          * added, and deleteing a knote for the new fd.
1255          */
1256         if (__predict_false(!TAILQ_EMPTY(&fdp->fd_kqlist)))
1257                 knote_fdclose(td, fd);
1258
1259         /*
1260          * We need to notify mqueue if the object is of type mqueue.
1261          */
1262         if (__predict_false(fp->f_type == DTYPE_MQUEUE))
1263                 mq_fdclose(td, fd, fp);
1264         FILEDESC_XUNLOCK(fdp);
1265
1266 #ifdef AUDIT
1267         if (AUDITING_TD(td) && audit)
1268                 audit_sysclose(td, fd, fp);
1269 #endif
1270         error = closef(fp, td);
1271
1272         /*
1273          * All paths leading up to closefp() will have already removed or
1274          * replaced the fd in the filedesc table, so a restart would not
1275          * operate on the same file.
1276          */
1277         if (error == ERESTART)
1278                 error = EINTR;
1279
1280         return (error);
1281 }
1282
1283 static int
1284 closefp_hl(struct filedesc *fdp, int fd, struct file *fp, struct thread *td,
1285     bool holdleaders, bool audit)
1286 {
1287         int error;
1288
1289         FILEDESC_XLOCK_ASSERT(fdp);
1290
1291         if (holdleaders) {
1292                 if (td->td_proc->p_fdtol != NULL) {
1293                         /*
1294                          * Ask fdfree() to sleep to ensure that all relevant
1295                          * process leaders can be traversed in closef().
1296                          */
1297                         fdp->fd_holdleaderscount++;
1298                 } else {
1299                         holdleaders = false;
1300                 }
1301         }
1302
1303         error = closefp_impl(fdp, fd, fp, td, audit);
1304         if (holdleaders) {
1305                 FILEDESC_XLOCK(fdp);
1306                 fdp->fd_holdleaderscount--;
1307                 if (fdp->fd_holdleaderscount == 0 &&
1308                     fdp->fd_holdleaderswakeup != 0) {
1309                         fdp->fd_holdleaderswakeup = 0;
1310                         wakeup(&fdp->fd_holdleaderscount);
1311                 }
1312                 FILEDESC_XUNLOCK(fdp);
1313         }
1314         return (error);
1315 }
1316
1317 static int
1318 closefp(struct filedesc *fdp, int fd, struct file *fp, struct thread *td,
1319     bool holdleaders, bool audit)
1320 {
1321
1322         FILEDESC_XLOCK_ASSERT(fdp);
1323
1324         if (__predict_false(td->td_proc->p_fdtol != NULL)) {
1325                 return (closefp_hl(fdp, fd, fp, td, holdleaders, audit));
1326         } else {
1327                 return (closefp_impl(fdp, fd, fp, td, audit));
1328         }
1329 }
1330
1331 /*
1332  * Close a file descriptor.
1333  */
1334 #ifndef _SYS_SYSPROTO_H_
1335 struct close_args {
1336         int     fd;
1337 };
1338 #endif
1339 /* ARGSUSED */
1340 int
1341 sys_close(struct thread *td, struct close_args *uap)
1342 {
1343
1344         return (kern_close(td, uap->fd));
1345 }
1346
1347 int
1348 kern_close(struct thread *td, int fd)
1349 {
1350         struct filedesc *fdp;
1351         struct file *fp;
1352
1353         fdp = td->td_proc->p_fd;
1354
1355         FILEDESC_XLOCK(fdp);
1356         if ((fp = fget_locked(fdp, fd)) == NULL) {
1357                 FILEDESC_XUNLOCK(fdp);
1358                 return (EBADF);
1359         }
1360         fdfree(fdp, fd);
1361
1362         /* closefp() drops the FILEDESC lock for us. */
1363         return (closefp(fdp, fd, fp, td, true, true));
1364 }
1365
1366 int
1367 kern_close_range(struct thread *td, u_int lowfd, u_int highfd)
1368 {
1369         struct filedesc *fdp;
1370         int fd, ret, lastfile;
1371
1372         ret = 0;
1373         fdp = td->td_proc->p_fd;
1374         FILEDESC_SLOCK(fdp);
1375
1376         /*
1377          * Check this prior to clamping; closefrom(3) with only fd 0, 1, and 2
1378          * open should not be a usage error.  From a close_range() perspective,
1379          * close_range(3, ~0U, 0) in the same scenario should also likely not
1380          * be a usage error as all fd above 3 are in-fact already closed.
1381          */
1382         if (highfd < lowfd) {
1383                 ret = EINVAL;
1384                 goto out;
1385         }
1386
1387         /*
1388          * If lastfile == -1, we're dealing with either a fresh file
1389          * table or one in which every fd has been closed.  Just return
1390          * successful; there's nothing left to do.
1391          */
1392         lastfile = fdlastfile(fdp);
1393         if (lastfile == -1)
1394                 goto out;
1395         /* Clamped to [lowfd, lastfile] */
1396         highfd = MIN(highfd, lastfile);
1397         for (fd = lowfd; fd <= highfd; fd++) {
1398                 if (fdp->fd_ofiles[fd].fde_file != NULL) {
1399                         FILEDESC_SUNLOCK(fdp);
1400                         (void)kern_close(td, fd);
1401                         FILEDESC_SLOCK(fdp);
1402                 }
1403         }
1404 out:
1405         FILEDESC_SUNLOCK(fdp);
1406         return (ret);
1407 }
1408
1409 #ifndef _SYS_SYSPROTO_H_
1410 struct close_range_args {
1411         u_int   lowfd;
1412         u_int   highfd;
1413         int     flags;
1414 };
1415 #endif
1416 int
1417 sys_close_range(struct thread *td, struct close_range_args *uap)
1418 {
1419
1420         /* No flags currently defined */
1421         if (uap->flags != 0)
1422                 return (EINVAL);
1423         return (kern_close_range(td, uap->lowfd, uap->highfd));
1424 }
1425
1426 #ifdef COMPAT_FREEBSD12
1427 /*
1428  * Close open file descriptors.
1429  */
1430 #ifndef _SYS_SYSPROTO_H_
1431 struct freebsd12_closefrom_args {
1432         int     lowfd;
1433 };
1434 #endif
1435 /* ARGSUSED */
1436 int
1437 freebsd12_closefrom(struct thread *td, struct freebsd12_closefrom_args *uap)
1438 {
1439         u_int lowfd;
1440
1441         AUDIT_ARG_FD(uap->lowfd);
1442
1443         /*
1444          * Treat negative starting file descriptor values identical to
1445          * closefrom(0) which closes all files.
1446          */
1447         lowfd = MAX(0, uap->lowfd);
1448         return (kern_close_range(td, lowfd, ~0U));
1449 }
1450 #endif  /* COMPAT_FREEBSD12 */
1451
1452 #if defined(COMPAT_43)
1453 /*
1454  * Return status information about a file descriptor.
1455  */
1456 #ifndef _SYS_SYSPROTO_H_
1457 struct ofstat_args {
1458         int     fd;
1459         struct  ostat *sb;
1460 };
1461 #endif
1462 /* ARGSUSED */
1463 int
1464 ofstat(struct thread *td, struct ofstat_args *uap)
1465 {
1466         struct ostat oub;
1467         struct stat ub;
1468         int error;
1469
1470         error = kern_fstat(td, uap->fd, &ub);
1471         if (error == 0) {
1472                 cvtstat(&ub, &oub);
1473                 error = copyout(&oub, uap->sb, sizeof(oub));
1474         }
1475         return (error);
1476 }
1477 #endif /* COMPAT_43 */
1478
1479 #if defined(COMPAT_FREEBSD11)
1480 int
1481 freebsd11_fstat(struct thread *td, struct freebsd11_fstat_args *uap)
1482 {
1483         struct stat sb;
1484         struct freebsd11_stat osb;
1485         int error;
1486
1487         error = kern_fstat(td, uap->fd, &sb);
1488         if (error != 0)
1489                 return (error);
1490         error = freebsd11_cvtstat(&sb, &osb);
1491         if (error == 0)
1492                 error = copyout(&osb, uap->sb, sizeof(osb));
1493         return (error);
1494 }
1495 #endif  /* COMPAT_FREEBSD11 */
1496
1497 /*
1498  * Return status information about a file descriptor.
1499  */
1500 #ifndef _SYS_SYSPROTO_H_
1501 struct fstat_args {
1502         int     fd;
1503         struct  stat *sb;
1504 };
1505 #endif
1506 /* ARGSUSED */
1507 int
1508 sys_fstat(struct thread *td, struct fstat_args *uap)
1509 {
1510         struct stat ub;
1511         int error;
1512
1513         error = kern_fstat(td, uap->fd, &ub);
1514         if (error == 0)
1515                 error = copyout(&ub, uap->sb, sizeof(ub));
1516         return (error);
1517 }
1518
1519 int
1520 kern_fstat(struct thread *td, int fd, struct stat *sbp)
1521 {
1522         struct file *fp;
1523         int error;
1524
1525         AUDIT_ARG_FD(fd);
1526
1527         error = fget(td, fd, &cap_fstat_rights, &fp);
1528         if (__predict_false(error != 0))
1529                 return (error);
1530
1531         AUDIT_ARG_FILE(td->td_proc, fp);
1532
1533         error = fo_stat(fp, sbp, td->td_ucred, td);
1534         fdrop(fp, td);
1535 #ifdef __STAT_TIME_T_EXT
1536         sbp->st_atim_ext = 0;
1537         sbp->st_mtim_ext = 0;
1538         sbp->st_ctim_ext = 0;
1539         sbp->st_btim_ext = 0;
1540 #endif
1541 #ifdef KTRACE
1542         if (KTRPOINT(td, KTR_STRUCT))
1543                 ktrstat_error(sbp, error);
1544 #endif
1545         return (error);
1546 }
1547
1548 #if defined(COMPAT_FREEBSD11)
1549 /*
1550  * Return status information about a file descriptor.
1551  */
1552 #ifndef _SYS_SYSPROTO_H_
1553 struct freebsd11_nfstat_args {
1554         int     fd;
1555         struct  nstat *sb;
1556 };
1557 #endif
1558 /* ARGSUSED */
1559 int
1560 freebsd11_nfstat(struct thread *td, struct freebsd11_nfstat_args *uap)
1561 {
1562         struct nstat nub;
1563         struct stat ub;
1564         int error;
1565
1566         error = kern_fstat(td, uap->fd, &ub);
1567         if (error == 0) {
1568                 freebsd11_cvtnstat(&ub, &nub);
1569                 error = copyout(&nub, uap->sb, sizeof(nub));
1570         }
1571         return (error);
1572 }
1573 #endif /* COMPAT_FREEBSD11 */
1574
1575 /*
1576  * Return pathconf information about a file descriptor.
1577  */
1578 #ifndef _SYS_SYSPROTO_H_
1579 struct fpathconf_args {
1580         int     fd;
1581         int     name;
1582 };
1583 #endif
1584 /* ARGSUSED */
1585 int
1586 sys_fpathconf(struct thread *td, struct fpathconf_args *uap)
1587 {
1588         long value;
1589         int error;
1590
1591         error = kern_fpathconf(td, uap->fd, uap->name, &value);
1592         if (error == 0)
1593                 td->td_retval[0] = value;
1594         return (error);
1595 }
1596
1597 int
1598 kern_fpathconf(struct thread *td, int fd, int name, long *valuep)
1599 {
1600         struct file *fp;
1601         struct vnode *vp;
1602         int error;
1603
1604         error = fget(td, fd, &cap_fpathconf_rights, &fp);
1605         if (error != 0)
1606                 return (error);
1607
1608         if (name == _PC_ASYNC_IO) {
1609                 *valuep = _POSIX_ASYNCHRONOUS_IO;
1610                 goto out;
1611         }
1612         vp = fp->f_vnode;
1613         if (vp != NULL) {
1614                 vn_lock(vp, LK_SHARED | LK_RETRY);
1615                 error = VOP_PATHCONF(vp, name, valuep);
1616                 VOP_UNLOCK(vp);
1617         } else if (fp->f_type == DTYPE_PIPE || fp->f_type == DTYPE_SOCKET) {
1618                 if (name != _PC_PIPE_BUF) {
1619                         error = EINVAL;
1620                 } else {
1621                         *valuep = PIPE_BUF;
1622                         error = 0;
1623                 }
1624         } else {
1625                 error = EOPNOTSUPP;
1626         }
1627 out:
1628         fdrop(fp, td);
1629         return (error);
1630 }
1631
1632 /*
1633  * Copy filecaps structure allocating memory for ioctls array if needed.
1634  *
1635  * The last parameter indicates whether the fdtable is locked. If it is not and
1636  * ioctls are encountered, copying fails and the caller must lock the table.
1637  *
1638  * Note that if the table was not locked, the caller has to check the relevant
1639  * sequence counter to determine whether the operation was successful.
1640  */
1641 bool
1642 filecaps_copy(const struct filecaps *src, struct filecaps *dst, bool locked)
1643 {
1644         size_t size;
1645
1646         if (src->fc_ioctls != NULL && !locked)
1647                 return (false);
1648         memcpy(dst, src, sizeof(*src));
1649         if (src->fc_ioctls == NULL)
1650                 return (true);
1651
1652         KASSERT(src->fc_nioctls > 0,
1653             ("fc_ioctls != NULL, but fc_nioctls=%hd", src->fc_nioctls));
1654
1655         size = sizeof(src->fc_ioctls[0]) * src->fc_nioctls;
1656         dst->fc_ioctls = malloc(size, M_FILECAPS, M_WAITOK);
1657         memcpy(dst->fc_ioctls, src->fc_ioctls, size);
1658         return (true);
1659 }
1660
1661 static u_long *
1662 filecaps_copy_prep(const struct filecaps *src)
1663 {
1664         u_long *ioctls;
1665         size_t size;
1666
1667         if (__predict_true(src->fc_ioctls == NULL))
1668                 return (NULL);
1669
1670         KASSERT(src->fc_nioctls > 0,
1671             ("fc_ioctls != NULL, but fc_nioctls=%hd", src->fc_nioctls));
1672
1673         size = sizeof(src->fc_ioctls[0]) * src->fc_nioctls;
1674         ioctls = malloc(size, M_FILECAPS, M_WAITOK);
1675         return (ioctls);
1676 }
1677
1678 static void
1679 filecaps_copy_finish(const struct filecaps *src, struct filecaps *dst,
1680     u_long *ioctls)
1681 {
1682         size_t size;
1683
1684         *dst = *src;
1685         if (__predict_true(src->fc_ioctls == NULL)) {
1686                 MPASS(ioctls == NULL);
1687                 return;
1688         }
1689
1690         size = sizeof(src->fc_ioctls[0]) * src->fc_nioctls;
1691         dst->fc_ioctls = ioctls;
1692         bcopy(src->fc_ioctls, dst->fc_ioctls, size);
1693 }
1694
1695 /*
1696  * Move filecaps structure to the new place and clear the old place.
1697  */
1698 void
1699 filecaps_move(struct filecaps *src, struct filecaps *dst)
1700 {
1701
1702         *dst = *src;
1703         bzero(src, sizeof(*src));
1704 }
1705
1706 /*
1707  * Fill the given filecaps structure with full rights.
1708  */
1709 static void
1710 filecaps_fill(struct filecaps *fcaps)
1711 {
1712
1713         CAP_ALL(&fcaps->fc_rights);
1714         fcaps->fc_ioctls = NULL;
1715         fcaps->fc_nioctls = -1;
1716         fcaps->fc_fcntls = CAP_FCNTL_ALL;
1717 }
1718
1719 /*
1720  * Free memory allocated within filecaps structure.
1721  */
1722 void
1723 filecaps_free(struct filecaps *fcaps)
1724 {
1725
1726         free(fcaps->fc_ioctls, M_FILECAPS);
1727         bzero(fcaps, sizeof(*fcaps));
1728 }
1729
1730 static u_long *
1731 filecaps_free_prep(struct filecaps *fcaps)
1732 {
1733         u_long *ioctls;
1734
1735         ioctls = fcaps->fc_ioctls;
1736         bzero(fcaps, sizeof(*fcaps));
1737         return (ioctls);
1738 }
1739
1740 static void
1741 filecaps_free_finish(u_long *ioctls)
1742 {
1743
1744         free(ioctls, M_FILECAPS);
1745 }
1746
1747 /*
1748  * Validate the given filecaps structure.
1749  */
1750 static void
1751 filecaps_validate(const struct filecaps *fcaps, const char *func)
1752 {
1753
1754         KASSERT(cap_rights_is_valid(&fcaps->fc_rights),
1755             ("%s: invalid rights", func));
1756         KASSERT((fcaps->fc_fcntls & ~CAP_FCNTL_ALL) == 0,
1757             ("%s: invalid fcntls", func));
1758         KASSERT(fcaps->fc_fcntls == 0 ||
1759             cap_rights_is_set(&fcaps->fc_rights, CAP_FCNTL),
1760             ("%s: fcntls without CAP_FCNTL", func));
1761         KASSERT(fcaps->fc_ioctls != NULL ? fcaps->fc_nioctls > 0 :
1762             (fcaps->fc_nioctls == -1 || fcaps->fc_nioctls == 0),
1763             ("%s: invalid ioctls", func));
1764         KASSERT(fcaps->fc_nioctls == 0 ||
1765             cap_rights_is_set(&fcaps->fc_rights, CAP_IOCTL),
1766             ("%s: ioctls without CAP_IOCTL", func));
1767 }
1768
1769 static void
1770 fdgrowtable_exp(struct filedesc *fdp, int nfd)
1771 {
1772         int nfd1;
1773
1774         FILEDESC_XLOCK_ASSERT(fdp);
1775
1776         nfd1 = fdp->fd_nfiles * 2;
1777         if (nfd1 < nfd)
1778                 nfd1 = nfd;
1779         fdgrowtable(fdp, nfd1);
1780 }
1781
1782 /*
1783  * Grow the file table to accommodate (at least) nfd descriptors.
1784  */
1785 static void
1786 fdgrowtable(struct filedesc *fdp, int nfd)
1787 {
1788         struct filedesc0 *fdp0;
1789         struct freetable *ft;
1790         struct fdescenttbl *ntable;
1791         struct fdescenttbl *otable;
1792         int nnfiles, onfiles;
1793         NDSLOTTYPE *nmap, *omap;
1794
1795         KASSERT(fdp->fd_nfiles > 0, ("zero-length file table"));
1796
1797         /* save old values */
1798         onfiles = fdp->fd_nfiles;
1799         otable = fdp->fd_files;
1800         omap = fdp->fd_map;
1801
1802         /* compute the size of the new table */
1803         nnfiles = NDSLOTS(nfd) * NDENTRIES; /* round up */
1804         if (nnfiles <= onfiles)
1805                 /* the table is already large enough */
1806                 return;
1807
1808         /*
1809          * Allocate a new table.  We need enough space for the number of
1810          * entries, file entries themselves and the struct freetable we will use
1811          * when we decommission the table and place it on the freelist.
1812          * We place the struct freetable in the middle so we don't have
1813          * to worry about padding.
1814          */
1815         ntable = malloc(offsetof(struct fdescenttbl, fdt_ofiles) +
1816             nnfiles * sizeof(ntable->fdt_ofiles[0]) +
1817             sizeof(struct freetable),
1818             M_FILEDESC, M_ZERO | M_WAITOK);
1819         /* copy the old data */
1820         ntable->fdt_nfiles = nnfiles;
1821         memcpy(ntable->fdt_ofiles, otable->fdt_ofiles,
1822             onfiles * sizeof(ntable->fdt_ofiles[0]));
1823
1824         /*
1825          * Allocate a new map only if the old is not large enough.  It will
1826          * grow at a slower rate than the table as it can map more
1827          * entries than the table can hold.
1828          */
1829         if (NDSLOTS(nnfiles) > NDSLOTS(onfiles)) {
1830                 nmap = malloc(NDSLOTS(nnfiles) * NDSLOTSIZE, M_FILEDESC,
1831                     M_ZERO | M_WAITOK);
1832                 /* copy over the old data and update the pointer */
1833                 memcpy(nmap, omap, NDSLOTS(onfiles) * sizeof(*omap));
1834                 fdp->fd_map = nmap;
1835         }
1836
1837         /*
1838          * Make sure that ntable is correctly initialized before we replace
1839          * fd_files poiner. Otherwise fget_unlocked() may see inconsistent
1840          * data.
1841          */
1842         atomic_store_rel_ptr((volatile void *)&fdp->fd_files, (uintptr_t)ntable);
1843
1844         /*
1845          * Free the old file table when not shared by other threads or processes.
1846          * The old file table is considered to be shared when either are true:
1847          * - The process has more than one thread.
1848          * - The file descriptor table has been shared via fdshare().
1849          *
1850          * When shared, the old file table will be placed on a freelist
1851          * which will be processed when the struct filedesc is released.
1852          *
1853          * Note that if onfiles == NDFILE, we're dealing with the original
1854          * static allocation contained within (struct filedesc0 *)fdp,
1855          * which must not be freed.
1856          */
1857         if (onfiles > NDFILE) {
1858                 if (curproc->p_numthreads == 1 &&
1859                     refcount_load(&fdp->fd_refcnt) == 1)
1860                         free(otable, M_FILEDESC);
1861                 else {
1862                         ft = (struct freetable *)&otable->fdt_ofiles[onfiles];
1863                         fdp0 = (struct filedesc0 *)fdp;
1864                         ft->ft_table = otable;
1865                         SLIST_INSERT_HEAD(&fdp0->fd_free, ft, ft_next);
1866                 }
1867         }
1868         /*
1869          * The map does not have the same possibility of threads still
1870          * holding references to it.  So always free it as long as it
1871          * does not reference the original static allocation.
1872          */
1873         if (NDSLOTS(onfiles) > NDSLOTS(NDFILE))
1874                 free(omap, M_FILEDESC);
1875 }
1876
1877 /*
1878  * Allocate a file descriptor for the process.
1879  */
1880 int
1881 fdalloc(struct thread *td, int minfd, int *result)
1882 {
1883         struct proc *p = td->td_proc;
1884         struct filedesc *fdp = p->p_fd;
1885         int fd, maxfd, allocfd;
1886 #ifdef RACCT
1887         int error;
1888 #endif
1889
1890         FILEDESC_XLOCK_ASSERT(fdp);
1891
1892         if (fdp->fd_freefile > minfd)
1893                 minfd = fdp->fd_freefile;
1894
1895         maxfd = getmaxfd(td);
1896
1897         /*
1898          * Search the bitmap for a free descriptor starting at minfd.
1899          * If none is found, grow the file table.
1900          */
1901         fd = fd_first_free(fdp, minfd, fdp->fd_nfiles);
1902         if (__predict_false(fd >= maxfd))
1903                 return (EMFILE);
1904         if (__predict_false(fd >= fdp->fd_nfiles)) {
1905                 allocfd = min(fd * 2, maxfd);
1906 #ifdef RACCT
1907                 if (RACCT_ENABLED()) {
1908                         error = racct_set_unlocked(p, RACCT_NOFILE, allocfd);
1909                         if (error != 0)
1910                                 return (EMFILE);
1911                 }
1912 #endif
1913                 /*
1914                  * fd is already equal to first free descriptor >= minfd, so
1915                  * we only need to grow the table and we are done.
1916                  */
1917                 fdgrowtable_exp(fdp, allocfd);
1918         }
1919
1920         /*
1921          * Perform some sanity checks, then mark the file descriptor as
1922          * used and return it to the caller.
1923          */
1924         KASSERT(fd >= 0 && fd < min(maxfd, fdp->fd_nfiles),
1925             ("invalid descriptor %d", fd));
1926         KASSERT(!fdisused(fdp, fd),
1927             ("fd_first_free() returned non-free descriptor"));
1928         KASSERT(fdp->fd_ofiles[fd].fde_file == NULL,
1929             ("file descriptor isn't free"));
1930         fdused(fdp, fd);
1931         *result = fd;
1932         return (0);
1933 }
1934
1935 /*
1936  * Allocate n file descriptors for the process.
1937  */
1938 int
1939 fdallocn(struct thread *td, int minfd, int *fds, int n)
1940 {
1941         struct proc *p = td->td_proc;
1942         struct filedesc *fdp = p->p_fd;
1943         int i;
1944
1945         FILEDESC_XLOCK_ASSERT(fdp);
1946
1947         for (i = 0; i < n; i++)
1948                 if (fdalloc(td, 0, &fds[i]) != 0)
1949                         break;
1950
1951         if (i < n) {
1952                 for (i--; i >= 0; i--)
1953                         fdunused(fdp, fds[i]);
1954                 return (EMFILE);
1955         }
1956
1957         return (0);
1958 }
1959
1960 /*
1961  * Create a new open file structure and allocate a file descriptor for the
1962  * process that refers to it.  We add one reference to the file for the
1963  * descriptor table and one reference for resultfp. This is to prevent us
1964  * being preempted and the entry in the descriptor table closed after we
1965  * release the FILEDESC lock.
1966  */
1967 int
1968 falloc_caps(struct thread *td, struct file **resultfp, int *resultfd, int flags,
1969     struct filecaps *fcaps)
1970 {
1971         struct file *fp;
1972         int error, fd;
1973
1974         error = falloc_noinstall(td, &fp);
1975         if (error)
1976                 return (error);         /* no reference held on error */
1977
1978         error = finstall(td, fp, &fd, flags, fcaps);
1979         if (error) {
1980                 fdrop(fp, td);          /* one reference (fp only) */
1981                 return (error);
1982         }
1983
1984         if (resultfp != NULL)
1985                 *resultfp = fp;         /* copy out result */
1986         else
1987                 fdrop(fp, td);          /* release local reference */
1988
1989         if (resultfd != NULL)
1990                 *resultfd = fd;
1991
1992         return (0);
1993 }
1994
1995 /*
1996  * Create a new open file structure without allocating a file descriptor.
1997  */
1998 int
1999 falloc_noinstall(struct thread *td, struct file **resultfp)
2000 {
2001         struct file *fp;
2002         int maxuserfiles = maxfiles - (maxfiles / 20);
2003         int openfiles_new;
2004         static struct timeval lastfail;
2005         static int curfail;
2006
2007         KASSERT(resultfp != NULL, ("%s: resultfp == NULL", __func__));
2008
2009         openfiles_new = atomic_fetchadd_int(&openfiles, 1) + 1;
2010         if ((openfiles_new >= maxuserfiles &&
2011             priv_check(td, PRIV_MAXFILES) != 0) ||
2012             openfiles_new >= maxfiles) {
2013                 atomic_subtract_int(&openfiles, 1);
2014                 if (ppsratecheck(&lastfail, &curfail, 1)) {
2015                         printf("kern.maxfiles limit exceeded by uid %i, (%s) "
2016                             "please see tuning(7).\n", td->td_ucred->cr_ruid, td->td_proc->p_comm);
2017                 }
2018                 return (ENFILE);
2019         }
2020         fp = uma_zalloc(file_zone, M_WAITOK);
2021         bzero(fp, sizeof(*fp));
2022         refcount_init(&fp->f_count, 1);
2023         fp->f_cred = crhold(td->td_ucred);
2024         fp->f_ops = &badfileops;
2025         *resultfp = fp;
2026         return (0);
2027 }
2028
2029 /*
2030  * Install a file in a file descriptor table.
2031  */
2032 void
2033 _finstall(struct filedesc *fdp, struct file *fp, int fd, int flags,
2034     struct filecaps *fcaps)
2035 {
2036         struct filedescent *fde;
2037
2038         MPASS(fp != NULL);
2039         if (fcaps != NULL)
2040                 filecaps_validate(fcaps, __func__);
2041         FILEDESC_XLOCK_ASSERT(fdp);
2042
2043         fde = &fdp->fd_ofiles[fd];
2044 #ifdef CAPABILITIES
2045         seqc_write_begin(&fde->fde_seqc);
2046 #endif
2047         fde->fde_file = fp;
2048         fde->fde_flags = (flags & O_CLOEXEC) != 0 ? UF_EXCLOSE : 0;
2049         if (fcaps != NULL)
2050                 filecaps_move(fcaps, &fde->fde_caps);
2051         else
2052                 filecaps_fill(&fde->fde_caps);
2053 #ifdef CAPABILITIES
2054         seqc_write_end(&fde->fde_seqc);
2055 #endif
2056 }
2057
2058 int
2059 finstall(struct thread *td, struct file *fp, int *fd, int flags,
2060     struct filecaps *fcaps)
2061 {
2062         struct filedesc *fdp = td->td_proc->p_fd;
2063         int error;
2064
2065         MPASS(fd != NULL);
2066
2067         if (!fhold(fp))
2068                 return (EBADF);
2069         FILEDESC_XLOCK(fdp);
2070         error = fdalloc(td, 0, fd);
2071         if (__predict_false(error != 0)) {
2072                 FILEDESC_XUNLOCK(fdp);
2073                 fdrop(fp, td);
2074                 return (error);
2075         }
2076         _finstall(fdp, fp, *fd, flags, fcaps);
2077         FILEDESC_XUNLOCK(fdp);
2078         return (0);
2079 }
2080
2081 /*
2082  * Build a new filedesc structure from another.
2083  *
2084  * If fdp is not NULL, return with it shared locked.
2085  */
2086 struct filedesc *
2087 fdinit(struct filedesc *fdp, bool prepfiles, int *lastfile)
2088 {
2089         struct filedesc0 *newfdp0;
2090         struct filedesc *newfdp;
2091
2092         if (prepfiles)
2093                 MPASS(lastfile != NULL);
2094         else
2095                 MPASS(lastfile == NULL);
2096
2097         newfdp0 = uma_zalloc(filedesc0_zone, M_WAITOK | M_ZERO);
2098         newfdp = &newfdp0->fd_fd;
2099
2100         /* Create the file descriptor table. */
2101         FILEDESC_LOCK_INIT(newfdp);
2102         refcount_init(&newfdp->fd_refcnt, 1);
2103         refcount_init(&newfdp->fd_holdcnt, 1);
2104         newfdp->fd_map = newfdp0->fd_dmap;
2105         newfdp->fd_files = (struct fdescenttbl *)&newfdp0->fd_dfiles;
2106         newfdp->fd_files->fdt_nfiles = NDFILE;
2107
2108         if (fdp == NULL)
2109                 return (newfdp);
2110
2111         FILEDESC_SLOCK(fdp);
2112         if (!prepfiles) {
2113                 FILEDESC_SUNLOCK(fdp);
2114                 return (newfdp);
2115         }
2116
2117         for (;;) {
2118                 *lastfile = fdlastfile(fdp);
2119                 if (*lastfile < newfdp->fd_nfiles)
2120                         break;
2121                 FILEDESC_SUNLOCK(fdp);
2122                 fdgrowtable(newfdp, *lastfile + 1);
2123                 FILEDESC_SLOCK(fdp);
2124         }
2125
2126         return (newfdp);
2127 }
2128
2129 /*
2130  * Build a pwddesc structure from another.
2131  * Copy the current, root, and jail root vnode references.
2132  *
2133  * If pdp is not NULL, return with it shared locked.
2134  */
2135 struct pwddesc *
2136 pdinit(struct pwddesc *pdp, bool keeplock)
2137 {
2138         struct pwddesc *newpdp;
2139         struct pwd *newpwd;
2140
2141         newpdp = malloc(sizeof(*newpdp), M_PWDDESC, M_WAITOK | M_ZERO);
2142
2143         PWDDESC_LOCK_INIT(newpdp);
2144         refcount_init(&newpdp->pd_refcount, 1);
2145         newpdp->pd_cmask = CMASK;
2146
2147         if (pdp == NULL) {
2148                 newpwd = pwd_alloc();
2149                 smr_serialized_store(&newpdp->pd_pwd, newpwd, true);
2150                 return (newpdp);
2151         }
2152
2153         PWDDESC_XLOCK(pdp);
2154         newpwd = pwd_hold_pwddesc(pdp);
2155         smr_serialized_store(&newpdp->pd_pwd, newpwd, true);
2156         if (!keeplock)
2157                 PWDDESC_XUNLOCK(pdp);
2158         return (newpdp);
2159 }
2160
2161 static struct filedesc *
2162 fdhold(struct proc *p)
2163 {
2164         struct filedesc *fdp;
2165
2166         PROC_LOCK_ASSERT(p, MA_OWNED);
2167         fdp = p->p_fd;
2168         if (fdp != NULL)
2169                 refcount_acquire(&fdp->fd_holdcnt);
2170         return (fdp);
2171 }
2172
2173 static struct pwddesc *
2174 pdhold(struct proc *p)
2175 {
2176         struct pwddesc *pdp;
2177
2178         PROC_LOCK_ASSERT(p, MA_OWNED);
2179         pdp = p->p_pd;
2180         if (pdp != NULL)
2181                 refcount_acquire(&pdp->pd_refcount);
2182         return (pdp);
2183 }
2184
2185 static void
2186 fddrop(struct filedesc *fdp)
2187 {
2188
2189         if (refcount_load(&fdp->fd_holdcnt) > 1) {
2190                 if (refcount_release(&fdp->fd_holdcnt) == 0)
2191                         return;
2192         }
2193
2194         FILEDESC_LOCK_DESTROY(fdp);
2195         uma_zfree(filedesc0_zone, fdp);
2196 }
2197
2198 static void
2199 pddrop(struct pwddesc *pdp)
2200 {
2201         struct pwd *pwd;
2202
2203         if (refcount_release_if_not_last(&pdp->pd_refcount))
2204                 return;
2205
2206         PWDDESC_XLOCK(pdp);
2207         if (refcount_release(&pdp->pd_refcount) == 0) {
2208                 PWDDESC_XUNLOCK(pdp);
2209                 return;
2210         }
2211         pwd = PWDDESC_XLOCKED_LOAD_PWD(pdp);
2212         pwd_set(pdp, NULL);
2213         PWDDESC_XUNLOCK(pdp);
2214         pwd_drop(pwd);
2215
2216         PWDDESC_LOCK_DESTROY(pdp);
2217         free(pdp, M_PWDDESC);
2218 }
2219
2220 /*
2221  * Share a filedesc structure.
2222  */
2223 struct filedesc *
2224 fdshare(struct filedesc *fdp)
2225 {
2226
2227         refcount_acquire(&fdp->fd_refcnt);
2228         return (fdp);
2229 }
2230
2231 /*
2232  * Share a pwddesc structure.
2233  */
2234 struct pwddesc *
2235 pdshare(struct pwddesc *pdp)
2236 {
2237         refcount_acquire(&pdp->pd_refcount);
2238         return (pdp);
2239 }
2240
2241 /*
2242  * Unshare a filedesc structure, if necessary by making a copy
2243  */
2244 void
2245 fdunshare(struct thread *td)
2246 {
2247         struct filedesc *tmp;
2248         struct proc *p = td->td_proc;
2249
2250         if (refcount_load(&p->p_fd->fd_refcnt) == 1)
2251                 return;
2252
2253         tmp = fdcopy(p->p_fd);
2254         fdescfree(td);
2255         p->p_fd = tmp;
2256 }
2257
2258 /*
2259  * Unshare a pwddesc structure.
2260  */
2261 void
2262 pdunshare(struct thread *td)
2263 {
2264         struct pwddesc *pdp;
2265         struct proc *p;
2266
2267         p = td->td_proc;
2268         /* Not shared. */
2269         if (p->p_pd->pd_refcount == 1)
2270                 return;
2271
2272         pdp = pdcopy(p->p_pd);
2273         pdescfree(td);
2274         p->p_pd = pdp;
2275 }
2276
2277 void
2278 fdinstall_remapped(struct thread *td, struct filedesc *fdp)
2279 {
2280
2281         fdescfree(td);
2282         td->td_proc->p_fd = fdp;
2283 }
2284
2285 /*
2286  * Copy a filedesc structure.  A NULL pointer in returns a NULL reference,
2287  * this is to ease callers, not catch errors.
2288  */
2289 struct filedesc *
2290 fdcopy(struct filedesc *fdp)
2291 {
2292         struct filedesc *newfdp;
2293         struct filedescent *nfde, *ofde;
2294         int i, lastfile;
2295
2296         MPASS(fdp != NULL);
2297
2298         newfdp = fdinit(fdp, true, &lastfile);
2299         /* copy all passable descriptors (i.e. not kqueue) */
2300         newfdp->fd_freefile = -1;
2301         for (i = 0; i <= lastfile; ++i) {
2302                 ofde = &fdp->fd_ofiles[i];
2303                 if (ofde->fde_file == NULL ||
2304                     (ofde->fde_file->f_ops->fo_flags & DFLAG_PASSABLE) == 0 ||
2305                     !fhold(ofde->fde_file)) {
2306                         if (newfdp->fd_freefile == -1)
2307                                 newfdp->fd_freefile = i;
2308                         continue;
2309                 }
2310                 nfde = &newfdp->fd_ofiles[i];
2311                 *nfde = *ofde;
2312                 filecaps_copy(&ofde->fde_caps, &nfde->fde_caps, true);
2313                 fdused_init(newfdp, i);
2314         }
2315         if (newfdp->fd_freefile == -1)
2316                 newfdp->fd_freefile = i;
2317         FILEDESC_SUNLOCK(fdp);
2318         return (newfdp);
2319 }
2320
2321 /*
2322  * Copy a pwddesc structure.
2323  */
2324 struct pwddesc *
2325 pdcopy(struct pwddesc *pdp)
2326 {
2327         struct pwddesc *newpdp;
2328
2329         MPASS(pdp != NULL);
2330
2331         newpdp = pdinit(pdp, true);
2332         newpdp->pd_cmask = pdp->pd_cmask;
2333         PWDDESC_XUNLOCK(pdp);
2334         return (newpdp);
2335 }
2336
2337 /*
2338  * Copies a filedesc structure, while remapping all file descriptors
2339  * stored inside using a translation table.
2340  *
2341  * File descriptors are copied over to the new file descriptor table,
2342  * regardless of whether the close-on-exec flag is set.
2343  */
2344 int
2345 fdcopy_remapped(struct filedesc *fdp, const int *fds, size_t nfds,
2346     struct filedesc **ret)
2347 {
2348         struct filedesc *newfdp;
2349         struct filedescent *nfde, *ofde;
2350         int error, i, lastfile;
2351
2352         MPASS(fdp != NULL);
2353
2354         newfdp = fdinit(fdp, true, &lastfile);
2355         if (nfds > lastfile + 1) {
2356                 /* New table cannot be larger than the old one. */
2357                 error = E2BIG;
2358                 goto bad;
2359         }
2360         /* Copy all passable descriptors (i.e. not kqueue). */
2361         newfdp->fd_freefile = nfds;
2362         for (i = 0; i < nfds; ++i) {
2363                 if (fds[i] < 0 || fds[i] > lastfile) {
2364                         /* File descriptor out of bounds. */
2365                         error = EBADF;
2366                         goto bad;
2367                 }
2368                 ofde = &fdp->fd_ofiles[fds[i]];
2369                 if (ofde->fde_file == NULL) {
2370                         /* Unused file descriptor. */
2371                         error = EBADF;
2372                         goto bad;
2373                 }
2374                 if ((ofde->fde_file->f_ops->fo_flags & DFLAG_PASSABLE) == 0) {
2375                         /* File descriptor cannot be passed. */
2376                         error = EINVAL;
2377                         goto bad;
2378                 }
2379                 if (!fhold(ofde->fde_file)) {
2380                         error = EBADF;
2381                         goto bad;
2382                 }
2383                 nfde = &newfdp->fd_ofiles[i];
2384                 *nfde = *ofde;
2385                 filecaps_copy(&ofde->fde_caps, &nfde->fde_caps, true);
2386                 fdused_init(newfdp, i);
2387         }
2388         FILEDESC_SUNLOCK(fdp);
2389         *ret = newfdp;
2390         return (0);
2391 bad:
2392         FILEDESC_SUNLOCK(fdp);
2393         fdescfree_remapped(newfdp);
2394         return (error);
2395 }
2396
2397 /*
2398  * Clear POSIX style locks. This is only used when fdp looses a reference (i.e.
2399  * one of processes using it exits) and the table used to be shared.
2400  */
2401 static void
2402 fdclearlocks(struct thread *td)
2403 {
2404         struct filedesc *fdp;
2405         struct filedesc_to_leader *fdtol;
2406         struct flock lf;
2407         struct file *fp;
2408         struct proc *p;
2409         struct vnode *vp;
2410         int i, lastfile;
2411
2412         p = td->td_proc;
2413         fdp = p->p_fd;
2414         fdtol = p->p_fdtol;
2415         MPASS(fdtol != NULL);
2416
2417         FILEDESC_XLOCK(fdp);
2418         KASSERT(fdtol->fdl_refcount > 0,
2419             ("filedesc_to_refcount botch: fdl_refcount=%d",
2420             fdtol->fdl_refcount));
2421         if (fdtol->fdl_refcount == 1 &&
2422             (p->p_leader->p_flag & P_ADVLOCK) != 0) {
2423                 lastfile = fdlastfile(fdp);
2424                 for (i = 0; i <= lastfile; i++) {
2425                         fp = fdp->fd_ofiles[i].fde_file;
2426                         if (fp == NULL || fp->f_type != DTYPE_VNODE ||
2427                             !fhold(fp))
2428                                 continue;
2429                         FILEDESC_XUNLOCK(fdp);
2430                         lf.l_whence = SEEK_SET;
2431                         lf.l_start = 0;
2432                         lf.l_len = 0;
2433                         lf.l_type = F_UNLCK;
2434                         vp = fp->f_vnode;
2435                         (void) VOP_ADVLOCK(vp,
2436                             (caddr_t)p->p_leader, F_UNLCK,
2437                             &lf, F_POSIX);
2438                         FILEDESC_XLOCK(fdp);
2439                         fdrop(fp, td);
2440                 }
2441         }
2442 retry:
2443         if (fdtol->fdl_refcount == 1) {
2444                 if (fdp->fd_holdleaderscount > 0 &&
2445                     (p->p_leader->p_flag & P_ADVLOCK) != 0) {
2446                         /*
2447                          * close() or kern_dup() has cleared a reference
2448                          * in a shared file descriptor table.
2449                          */
2450                         fdp->fd_holdleaderswakeup = 1;
2451                         sx_sleep(&fdp->fd_holdleaderscount,
2452                             FILEDESC_LOCK(fdp), PLOCK, "fdlhold", 0);
2453                         goto retry;
2454                 }
2455                 if (fdtol->fdl_holdcount > 0) {
2456                         /*
2457                          * Ensure that fdtol->fdl_leader remains
2458                          * valid in closef().
2459                          */
2460                         fdtol->fdl_wakeup = 1;
2461                         sx_sleep(fdtol, FILEDESC_LOCK(fdp), PLOCK,
2462                             "fdlhold", 0);
2463                         goto retry;
2464                 }
2465         }
2466         fdtol->fdl_refcount--;
2467         if (fdtol->fdl_refcount == 0 &&
2468             fdtol->fdl_holdcount == 0) {
2469                 fdtol->fdl_next->fdl_prev = fdtol->fdl_prev;
2470                 fdtol->fdl_prev->fdl_next = fdtol->fdl_next;
2471         } else
2472                 fdtol = NULL;
2473         p->p_fdtol = NULL;
2474         FILEDESC_XUNLOCK(fdp);
2475         if (fdtol != NULL)
2476                 free(fdtol, M_FILEDESC_TO_LEADER);
2477 }
2478
2479 /*
2480  * Release a filedesc structure.
2481  */
2482 static void
2483 fdescfree_fds(struct thread *td, struct filedesc *fdp, bool needclose)
2484 {
2485         struct filedesc0 *fdp0;
2486         struct freetable *ft, *tft;
2487         struct filedescent *fde;
2488         struct file *fp;
2489         int i, lastfile;
2490
2491         KASSERT(refcount_load(&fdp->fd_refcnt) == 0,
2492             ("%s: fd table %p carries references", __func__, fdp));
2493
2494         /*
2495          * Serialize with threads iterating over the table, if any.
2496          */
2497         if (refcount_load(&fdp->fd_holdcnt) > 1) {
2498                 FILEDESC_XLOCK(fdp);
2499                 FILEDESC_XUNLOCK(fdp);
2500         }
2501
2502         lastfile = fdlastfile_single(fdp);
2503         for (i = 0; i <= lastfile; i++) {
2504                 fde = &fdp->fd_ofiles[i];
2505                 fp = fde->fde_file;
2506                 if (fp != NULL) {
2507                         fdefree_last(fde);
2508                         if (needclose)
2509                                 (void) closef(fp, td);
2510                         else
2511                                 fdrop(fp, td);
2512                 }
2513         }
2514
2515         if (NDSLOTS(fdp->fd_nfiles) > NDSLOTS(NDFILE))
2516                 free(fdp->fd_map, M_FILEDESC);
2517         if (fdp->fd_nfiles > NDFILE)
2518                 free(fdp->fd_files, M_FILEDESC);
2519
2520         fdp0 = (struct filedesc0 *)fdp;
2521         SLIST_FOREACH_SAFE(ft, &fdp0->fd_free, ft_next, tft)
2522                 free(ft->ft_table, M_FILEDESC);
2523
2524         fddrop(fdp);
2525 }
2526
2527 void
2528 fdescfree(struct thread *td)
2529 {
2530         struct proc *p;
2531         struct filedesc *fdp;
2532
2533         p = td->td_proc;
2534         fdp = p->p_fd;
2535         MPASS(fdp != NULL);
2536
2537 #ifdef RACCT
2538         if (RACCT_ENABLED())
2539                 racct_set_unlocked(p, RACCT_NOFILE, 0);
2540 #endif
2541
2542         if (p->p_fdtol != NULL)
2543                 fdclearlocks(td);
2544
2545         PROC_LOCK(p);
2546         p->p_fd = NULL;
2547         PROC_UNLOCK(p);
2548
2549         if (refcount_release(&fdp->fd_refcnt) == 0)
2550                 return;
2551
2552         fdescfree_fds(td, fdp, 1);
2553 }
2554
2555 void
2556 pdescfree(struct thread *td)
2557 {
2558         struct proc *p;
2559         struct pwddesc *pdp;
2560
2561         p = td->td_proc;
2562         pdp = p->p_pd;
2563         MPASS(pdp != NULL);
2564
2565         PROC_LOCK(p);
2566         p->p_pd = NULL;
2567         PROC_UNLOCK(p);
2568
2569         pddrop(pdp);
2570 }
2571
2572 void
2573 fdescfree_remapped(struct filedesc *fdp)
2574 {
2575 #ifdef INVARIANTS
2576         /* fdescfree_fds() asserts that fd_refcnt == 0. */
2577         if (!refcount_release(&fdp->fd_refcnt))
2578                 panic("%s: fd table %p has extra references", __func__, fdp);
2579 #endif
2580         fdescfree_fds(curthread, fdp, 0);
2581 }
2582
2583 /*
2584  * For setugid programs, we don't want to people to use that setugidness
2585  * to generate error messages which write to a file which otherwise would
2586  * otherwise be off-limits to the process.  We check for filesystems where
2587  * the vnode can change out from under us after execve (like [lin]procfs).
2588  *
2589  * Since fdsetugidsafety calls this only for fd 0, 1 and 2, this check is
2590  * sufficient.  We also don't check for setugidness since we know we are.
2591  */
2592 static bool
2593 is_unsafe(struct file *fp)
2594 {
2595         struct vnode *vp;
2596
2597         if (fp->f_type != DTYPE_VNODE)
2598                 return (false);
2599
2600         vp = fp->f_vnode;
2601         return ((vp->v_vflag & VV_PROCDEP) != 0);
2602 }
2603
2604 /*
2605  * Make this setguid thing safe, if at all possible.
2606  */
2607 void
2608 fdsetugidsafety(struct thread *td)
2609 {
2610         struct filedesc *fdp;
2611         struct file *fp;
2612         int i;
2613
2614         fdp = td->td_proc->p_fd;
2615         KASSERT(refcount_load(&fdp->fd_refcnt) == 1,
2616             ("the fdtable should not be shared"));
2617         MPASS(fdp->fd_nfiles >= 3);
2618         for (i = 0; i <= 2; i++) {
2619                 fp = fdp->fd_ofiles[i].fde_file;
2620                 if (fp != NULL && is_unsafe(fp)) {
2621                         FILEDESC_XLOCK(fdp);
2622                         knote_fdclose(td, i);
2623                         /*
2624                          * NULL-out descriptor prior to close to avoid
2625                          * a race while close blocks.
2626                          */
2627                         fdfree(fdp, i);
2628                         FILEDESC_XUNLOCK(fdp);
2629                         (void) closef(fp, td);
2630                 }
2631         }
2632 }
2633
2634 /*
2635  * If a specific file object occupies a specific file descriptor, close the
2636  * file descriptor entry and drop a reference on the file object.  This is a
2637  * convenience function to handle a subsequent error in a function that calls
2638  * falloc() that handles the race that another thread might have closed the
2639  * file descriptor out from under the thread creating the file object.
2640  */
2641 void
2642 fdclose(struct thread *td, struct file *fp, int idx)
2643 {
2644         struct filedesc *fdp = td->td_proc->p_fd;
2645
2646         FILEDESC_XLOCK(fdp);
2647         if (fdp->fd_ofiles[idx].fde_file == fp) {
2648                 fdfree(fdp, idx);
2649                 FILEDESC_XUNLOCK(fdp);
2650                 fdrop(fp, td);
2651         } else
2652                 FILEDESC_XUNLOCK(fdp);
2653 }
2654
2655 /*
2656  * Close any files on exec?
2657  */
2658 void
2659 fdcloseexec(struct thread *td)
2660 {
2661         struct filedesc *fdp;
2662         struct filedescent *fde;
2663         struct file *fp;
2664         int i, lastfile;
2665
2666         fdp = td->td_proc->p_fd;
2667         KASSERT(refcount_load(&fdp->fd_refcnt) == 1,
2668             ("the fdtable should not be shared"));
2669         lastfile = fdlastfile_single(fdp);
2670         for (i = 0; i <= lastfile; i++) {
2671                 fde = &fdp->fd_ofiles[i];
2672                 fp = fde->fde_file;
2673                 if (fp != NULL && (fp->f_type == DTYPE_MQUEUE ||
2674                     (fde->fde_flags & UF_EXCLOSE))) {
2675                         FILEDESC_XLOCK(fdp);
2676                         fdfree(fdp, i);
2677                         (void) closefp(fdp, i, fp, td, false, false);
2678                         FILEDESC_UNLOCK_ASSERT(fdp);
2679                 }
2680         }
2681 }
2682
2683 /*
2684  * It is unsafe for set[ug]id processes to be started with file
2685  * descriptors 0..2 closed, as these descriptors are given implicit
2686  * significance in the Standard C library.  fdcheckstd() will create a
2687  * descriptor referencing /dev/null for each of stdin, stdout, and
2688  * stderr that is not already open.
2689  */
2690 int
2691 fdcheckstd(struct thread *td)
2692 {
2693         struct filedesc *fdp;
2694         register_t save;
2695         int i, error, devnull;
2696
2697         fdp = td->td_proc->p_fd;
2698         KASSERT(refcount_load(&fdp->fd_refcnt) == 1,
2699             ("the fdtable should not be shared"));
2700         MPASS(fdp->fd_nfiles >= 3);
2701         devnull = -1;
2702         for (i = 0; i <= 2; i++) {
2703                 if (fdp->fd_ofiles[i].fde_file != NULL)
2704                         continue;
2705
2706                 save = td->td_retval[0];
2707                 if (devnull != -1) {
2708                         error = kern_dup(td, FDDUP_FIXED, 0, devnull, i);
2709                 } else {
2710                         error = kern_openat(td, AT_FDCWD, "/dev/null",
2711                             UIO_SYSSPACE, O_RDWR, 0);
2712                         if (error == 0) {
2713                                 devnull = td->td_retval[0];
2714                                 KASSERT(devnull == i, ("we didn't get our fd"));
2715                         }
2716                 }
2717                 td->td_retval[0] = save;
2718                 if (error != 0)
2719                         return (error);
2720         }
2721         return (0);
2722 }
2723
2724 /*
2725  * Internal form of close.  Decrement reference count on file structure.
2726  * Note: td may be NULL when closing a file that was being passed in a
2727  * message.
2728  */
2729 int
2730 closef(struct file *fp, struct thread *td)
2731 {
2732         struct vnode *vp;
2733         struct flock lf;
2734         struct filedesc_to_leader *fdtol;
2735         struct filedesc *fdp;
2736
2737         /*
2738          * POSIX record locking dictates that any close releases ALL
2739          * locks owned by this process.  This is handled by setting
2740          * a flag in the unlock to free ONLY locks obeying POSIX
2741          * semantics, and not to free BSD-style file locks.
2742          * If the descriptor was in a message, POSIX-style locks
2743          * aren't passed with the descriptor, and the thread pointer
2744          * will be NULL.  Callers should be careful only to pass a
2745          * NULL thread pointer when there really is no owning
2746          * context that might have locks, or the locks will be
2747          * leaked.
2748          */
2749         if (fp->f_type == DTYPE_VNODE && td != NULL) {
2750                 vp = fp->f_vnode;
2751                 if ((td->td_proc->p_leader->p_flag & P_ADVLOCK) != 0) {
2752                         lf.l_whence = SEEK_SET;
2753                         lf.l_start = 0;
2754                         lf.l_len = 0;
2755                         lf.l_type = F_UNLCK;
2756                         (void) VOP_ADVLOCK(vp, (caddr_t)td->td_proc->p_leader,
2757                             F_UNLCK, &lf, F_POSIX);
2758                 }
2759                 fdtol = td->td_proc->p_fdtol;
2760                 if (fdtol != NULL) {
2761                         /*
2762                          * Handle special case where file descriptor table is
2763                          * shared between multiple process leaders.
2764                          */
2765                         fdp = td->td_proc->p_fd;
2766                         FILEDESC_XLOCK(fdp);
2767                         for (fdtol = fdtol->fdl_next;
2768                             fdtol != td->td_proc->p_fdtol;
2769                             fdtol = fdtol->fdl_next) {
2770                                 if ((fdtol->fdl_leader->p_flag &
2771                                     P_ADVLOCK) == 0)
2772                                         continue;
2773                                 fdtol->fdl_holdcount++;
2774                                 FILEDESC_XUNLOCK(fdp);
2775                                 lf.l_whence = SEEK_SET;
2776                                 lf.l_start = 0;
2777                                 lf.l_len = 0;
2778                                 lf.l_type = F_UNLCK;
2779                                 vp = fp->f_vnode;
2780                                 (void) VOP_ADVLOCK(vp,
2781                                     (caddr_t)fdtol->fdl_leader, F_UNLCK, &lf,
2782                                     F_POSIX);
2783                                 FILEDESC_XLOCK(fdp);
2784                                 fdtol->fdl_holdcount--;
2785                                 if (fdtol->fdl_holdcount == 0 &&
2786                                     fdtol->fdl_wakeup != 0) {
2787                                         fdtol->fdl_wakeup = 0;
2788                                         wakeup(fdtol);
2789                                 }
2790                         }
2791                         FILEDESC_XUNLOCK(fdp);
2792                 }
2793         }
2794         return (fdrop_close(fp, td));
2795 }
2796
2797 /*
2798  * Initialize the file pointer with the specified properties.
2799  *
2800  * The ops are set with release semantics to be certain that the flags, type,
2801  * and data are visible when ops is.  This is to prevent ops methods from being
2802  * called with bad data.
2803  */
2804 void
2805 finit(struct file *fp, u_int flag, short type, void *data, struct fileops *ops)
2806 {
2807         fp->f_data = data;
2808         fp->f_flag = flag;
2809         fp->f_type = type;
2810         atomic_store_rel_ptr((volatile uintptr_t *)&fp->f_ops, (uintptr_t)ops);
2811 }
2812
2813 void
2814 finit_vnode(struct file *fp, u_int flag, void *data, struct fileops *ops)
2815 {
2816         fp->f_seqcount[UIO_READ] = 1;
2817         fp->f_seqcount[UIO_WRITE] = 1;
2818         finit(fp, (flag & FMASK) | (fp->f_flag & FHASLOCK), DTYPE_VNODE,
2819             data, ops);
2820 }
2821
2822 int
2823 fget_cap_locked(struct filedesc *fdp, int fd, cap_rights_t *needrightsp,
2824     struct file **fpp, struct filecaps *havecapsp)
2825 {
2826         struct filedescent *fde;
2827         int error;
2828
2829         FILEDESC_LOCK_ASSERT(fdp);
2830
2831         fde = fdeget_locked(fdp, fd);
2832         if (fde == NULL) {
2833                 error = EBADF;
2834                 goto out;
2835         }
2836
2837 #ifdef CAPABILITIES
2838         error = cap_check(cap_rights_fde_inline(fde), needrightsp);
2839         if (error != 0)
2840                 goto out;
2841 #endif
2842
2843         if (havecapsp != NULL)
2844                 filecaps_copy(&fde->fde_caps, havecapsp, true);
2845
2846         *fpp = fde->fde_file;
2847
2848         error = 0;
2849 out:
2850         return (error);
2851 }
2852
2853 int
2854 fget_cap(struct thread *td, int fd, cap_rights_t *needrightsp,
2855     struct file **fpp, struct filecaps *havecapsp)
2856 {
2857         struct filedesc *fdp = td->td_proc->p_fd;
2858         int error;
2859 #ifndef CAPABILITIES
2860         error = fget_unlocked(fdp, fd, needrightsp, fpp);
2861         if (havecapsp != NULL && error == 0)
2862                 filecaps_fill(havecapsp);
2863 #else
2864         struct file *fp;
2865         seqc_t seq;
2866
2867         *fpp = NULL;
2868         for (;;) {
2869                 error = fget_unlocked_seq(fdp, fd, needrightsp, &fp, &seq);
2870                 if (error != 0)
2871                         return (error);
2872
2873                 if (havecapsp != NULL) {
2874                         if (!filecaps_copy(&fdp->fd_ofiles[fd].fde_caps,
2875                             havecapsp, false)) {
2876                                 fdrop(fp, td);
2877                                 goto get_locked;
2878                         }
2879                 }
2880
2881                 if (!fd_modified(fdp, fd, seq))
2882                         break;
2883                 fdrop(fp, td);
2884         }
2885
2886         *fpp = fp;
2887         return (0);
2888
2889 get_locked:
2890         FILEDESC_SLOCK(fdp);
2891         error = fget_cap_locked(fdp, fd, needrightsp, fpp, havecapsp);
2892         if (error == 0 && !fhold(*fpp))
2893                 error = EBADF;
2894         FILEDESC_SUNLOCK(fdp);
2895 #endif
2896         return (error);
2897 }
2898
2899 #ifdef CAPABILITIES
2900 int
2901 fgetvp_lookup_smr(int fd, struct nameidata *ndp, struct vnode **vpp, bool *fsearch)
2902 {
2903         const struct filedescent *fde;
2904         const struct fdescenttbl *fdt;
2905         struct filedesc *fdp;
2906         struct file *fp;
2907         struct vnode *vp;
2908         const cap_rights_t *haverights;
2909         cap_rights_t rights;
2910         seqc_t seq;
2911
2912         VFS_SMR_ASSERT_ENTERED();
2913
2914         rights = *ndp->ni_rightsneeded;
2915         cap_rights_set_one(&rights, CAP_LOOKUP);
2916
2917         fdp = curproc->p_fd;
2918         fdt = fdp->fd_files;
2919         if (__predict_false((u_int)fd >= fdt->fdt_nfiles))
2920                 return (EBADF);
2921         seq = seqc_read_any(fd_seqc(fdt, fd));
2922         if (__predict_false(seqc_in_modify(seq)))
2923                 return (EAGAIN);
2924         fde = &fdt->fdt_ofiles[fd];
2925         haverights = cap_rights_fde_inline(fde);
2926         fp = fde->fde_file;
2927         if (__predict_false(fp == NULL))
2928                 return (EAGAIN);
2929         if (__predict_false(cap_check_inline_transient(haverights, &rights)))
2930                 return (EAGAIN);
2931         *fsearch = ((fp->f_flag & FSEARCH) != 0);
2932         vp = fp->f_vnode;
2933         if (__predict_false(vp == NULL || vp->v_type != VDIR)) {
2934                 return (EAGAIN);
2935         }
2936         if (!filecaps_copy(&fde->fde_caps, &ndp->ni_filecaps, false)) {
2937                 return (EAGAIN);
2938         }
2939         /*
2940          * Use an acquire barrier to force re-reading of fdt so it is
2941          * refreshed for verification.
2942          */
2943         atomic_thread_fence_acq();
2944         fdt = fdp->fd_files;
2945         if (__predict_false(!seqc_consistent_nomb(fd_seqc(fdt, fd), seq)))
2946                 return (EAGAIN);
2947         /*
2948          * If file descriptor doesn't have all rights,
2949          * all lookups relative to it must also be
2950          * strictly relative.
2951          *
2952          * Not yet supported by fast path.
2953          */
2954         CAP_ALL(&rights);
2955         if (!cap_rights_contains(&ndp->ni_filecaps.fc_rights, &rights) ||
2956             ndp->ni_filecaps.fc_fcntls != CAP_FCNTL_ALL ||
2957             ndp->ni_filecaps.fc_nioctls != -1) {
2958 #ifdef notyet
2959                 ndp->ni_lcf |= NI_LCF_STRICTRELATIVE;
2960 #else
2961                 return (EAGAIN);
2962 #endif
2963         }
2964         *vpp = vp;
2965         return (0);
2966 }
2967 #else
2968 int
2969 fgetvp_lookup_smr(int fd, struct nameidata *ndp, struct vnode **vpp, bool *fsearch)
2970 {
2971         const struct fdescenttbl *fdt;
2972         struct filedesc *fdp;
2973         struct file *fp;
2974         struct vnode *vp;
2975
2976         VFS_SMR_ASSERT_ENTERED();
2977
2978         fdp = curproc->p_fd;
2979         fdt = fdp->fd_files;
2980         if (__predict_false((u_int)fd >= fdt->fdt_nfiles))
2981                 return (EBADF);
2982         fp = fdt->fdt_ofiles[fd].fde_file;
2983         if (__predict_false(fp == NULL))
2984                 return (EAGAIN);
2985         *fsearch = ((fp->f_flag & FSEARCH) != 0);
2986         vp = fp->f_vnode;
2987         if (__predict_false(vp == NULL || vp->v_type != VDIR)) {
2988                 return (EAGAIN);
2989         }
2990         /*
2991          * Use an acquire barrier to force re-reading of fdt so it is
2992          * refreshed for verification.
2993          */
2994         atomic_thread_fence_acq();
2995         fdt = fdp->fd_files;
2996         if (__predict_false(fp != fdt->fdt_ofiles[fd].fde_file))
2997                 return (EAGAIN);
2998         filecaps_fill(&ndp->ni_filecaps);
2999         *vpp = vp;
3000         return (0);
3001 }
3002 #endif
3003
3004 int
3005 fget_unlocked_seq(struct filedesc *fdp, int fd, cap_rights_t *needrightsp,
3006     struct file **fpp, seqc_t *seqp)
3007 {
3008 #ifdef CAPABILITIES
3009         const struct filedescent *fde;
3010 #endif
3011         const struct fdescenttbl *fdt;
3012         struct file *fp;
3013 #ifdef CAPABILITIES
3014         seqc_t seq;
3015         cap_rights_t haverights;
3016         int error;
3017 #endif
3018
3019         fdt = fdp->fd_files;
3020         if (__predict_false((u_int)fd >= fdt->fdt_nfiles))
3021                 return (EBADF);
3022         /*
3023          * Fetch the descriptor locklessly.  We avoid fdrop() races by
3024          * never raising a refcount above 0.  To accomplish this we have
3025          * to use a cmpset loop rather than an atomic_add.  The descriptor
3026          * must be re-verified once we acquire a reference to be certain
3027          * that the identity is still correct and we did not lose a race
3028          * due to preemption.
3029          */
3030         for (;;) {
3031 #ifdef CAPABILITIES
3032                 seq = seqc_read(fd_seqc(fdt, fd));
3033                 fde = &fdt->fdt_ofiles[fd];
3034                 haverights = *cap_rights_fde_inline(fde);
3035                 fp = fde->fde_file;
3036                 if (!seqc_consistent(fd_seqc(fdt, fd), seq))
3037                         continue;
3038 #else
3039                 fp = fdt->fdt_ofiles[fd].fde_file;
3040 #endif
3041                 if (fp == NULL)
3042                         return (EBADF);
3043 #ifdef CAPABILITIES
3044                 error = cap_check_inline(&haverights, needrightsp);
3045                 if (error != 0)
3046                         return (error);
3047 #endif
3048                 if (__predict_false(!refcount_acquire_if_not_zero(&fp->f_count))) {
3049                         /*
3050                          * Force a reload. Other thread could reallocate the
3051                          * table before this fd was closed, so it is possible
3052                          * that there is a stale fp pointer in cached version.
3053                          */
3054                         fdt = atomic_load_ptr(&fdp->fd_files);
3055                         continue;
3056                 }
3057                 /*
3058                  * Use an acquire barrier to force re-reading of fdt so it is
3059                  * refreshed for verification.
3060                  */
3061                 atomic_thread_fence_acq();
3062                 fdt = fdp->fd_files;
3063 #ifdef  CAPABILITIES
3064                 if (seqc_consistent_nomb(fd_seqc(fdt, fd), seq))
3065 #else
3066                 if (fp == fdt->fdt_ofiles[fd].fde_file)
3067 #endif
3068                         break;
3069                 fdrop(fp, curthread);
3070         }
3071         *fpp = fp;
3072         if (seqp != NULL) {
3073 #ifdef CAPABILITIES
3074                 *seqp = seq;
3075 #endif
3076         }
3077         return (0);
3078 }
3079
3080 /*
3081  * See the comments in fget_unlocked_seq for an explanation of how this works.
3082  *
3083  * This is a simplified variant which bails out to the aforementioned routine
3084  * if anything goes wrong. In practice this only happens when userspace is
3085  * racing with itself.
3086  */
3087 int
3088 fget_unlocked(struct filedesc *fdp, int fd, cap_rights_t *needrightsp,
3089     struct file **fpp)
3090 {
3091 #ifdef CAPABILITIES
3092         const struct filedescent *fde;
3093 #endif
3094         const struct fdescenttbl *fdt;
3095         struct file *fp;
3096 #ifdef CAPABILITIES
3097         seqc_t seq;
3098         const cap_rights_t *haverights;
3099 #endif
3100
3101         fdt = fdp->fd_files;
3102         if (__predict_false((u_int)fd >= fdt->fdt_nfiles))
3103                 return (EBADF);
3104 #ifdef CAPABILITIES
3105         seq = seqc_read_any(fd_seqc(fdt, fd));
3106         if (__predict_false(seqc_in_modify(seq)))
3107                 goto out_fallback;
3108         fde = &fdt->fdt_ofiles[fd];
3109         haverights = cap_rights_fde_inline(fde);
3110         fp = fde->fde_file;
3111 #else
3112         fp = fdt->fdt_ofiles[fd].fde_file;
3113 #endif
3114         if (__predict_false(fp == NULL))
3115                 goto out_fallback;
3116 #ifdef CAPABILITIES
3117         if (__predict_false(cap_check_inline_transient(haverights, needrightsp)))
3118                 goto out_fallback;
3119 #endif
3120         if (__predict_false(!refcount_acquire_if_not_zero(&fp->f_count)))
3121                 goto out_fallback;
3122
3123         /*
3124          * Use an acquire barrier to force re-reading of fdt so it is
3125          * refreshed for verification.
3126          */
3127         atomic_thread_fence_acq();
3128         fdt = fdp->fd_files;
3129 #ifdef  CAPABILITIES
3130         if (__predict_false(!seqc_consistent_nomb(fd_seqc(fdt, fd), seq)))
3131 #else
3132         if (__predict_false(fp != fdt->fdt_ofiles[fd].fde_file))
3133 #endif
3134                 goto out_fdrop;
3135         *fpp = fp;
3136         return (0);
3137 out_fdrop:
3138         fdrop(fp, curthread);
3139 out_fallback:
3140         return (fget_unlocked_seq(fdp, fd, needrightsp, fpp, NULL));
3141 }
3142
3143 /*
3144  * Extract the file pointer associated with the specified descriptor for the
3145  * current user process.
3146  *
3147  * If the descriptor doesn't exist or doesn't match 'flags', EBADF is
3148  * returned.
3149  *
3150  * File's rights will be checked against the capability rights mask.
3151  *
3152  * If an error occurred the non-zero error is returned and *fpp is set to
3153  * NULL.  Otherwise *fpp is held and set and zero is returned.  Caller is
3154  * responsible for fdrop().
3155  */
3156 static __inline int
3157 _fget(struct thread *td, int fd, struct file **fpp, int flags,
3158     cap_rights_t *needrightsp)
3159 {
3160         struct filedesc *fdp;
3161         struct file *fp;
3162         int error;
3163
3164         *fpp = NULL;
3165         fdp = td->td_proc->p_fd;
3166         error = fget_unlocked(fdp, fd, needrightsp, &fp);
3167         if (__predict_false(error != 0))
3168                 return (error);
3169         if (__predict_false(fp->f_ops == &badfileops)) {
3170                 fdrop(fp, td);
3171                 return (EBADF);
3172         }
3173
3174         /*
3175          * FREAD and FWRITE failure return EBADF as per POSIX.
3176          */
3177         error = 0;
3178         switch (flags) {
3179         case FREAD:
3180         case FWRITE:
3181                 if ((fp->f_flag & flags) == 0)
3182                         error = EBADF;
3183                 break;
3184         case FEXEC:
3185                 if ((fp->f_flag & (FREAD | FEXEC)) == 0 ||
3186                     ((fp->f_flag & FWRITE) != 0))
3187                         error = EBADF;
3188                 break;
3189         case 0:
3190                 break;
3191         default:
3192                 KASSERT(0, ("wrong flags"));
3193         }
3194
3195         if (error != 0) {
3196                 fdrop(fp, td);
3197                 return (error);
3198         }
3199
3200         *fpp = fp;
3201         return (0);
3202 }
3203
3204 int
3205 fget(struct thread *td, int fd, cap_rights_t *rightsp, struct file **fpp)
3206 {
3207
3208         return (_fget(td, fd, fpp, 0, rightsp));
3209 }
3210
3211 int
3212 fget_mmap(struct thread *td, int fd, cap_rights_t *rightsp, vm_prot_t *maxprotp,
3213     struct file **fpp)
3214 {
3215         int error;
3216 #ifndef CAPABILITIES
3217         error = _fget(td, fd, fpp, 0, rightsp);
3218         if (maxprotp != NULL)
3219                 *maxprotp = VM_PROT_ALL;
3220         return (error);
3221 #else
3222         cap_rights_t fdrights;
3223         struct filedesc *fdp;
3224         struct file *fp;
3225         seqc_t seq;
3226
3227         *fpp = NULL;
3228         fdp = td->td_proc->p_fd;
3229         MPASS(cap_rights_is_set(rightsp, CAP_MMAP));
3230         for (;;) {
3231                 error = fget_unlocked_seq(fdp, fd, rightsp, &fp, &seq);
3232                 if (__predict_false(error != 0))
3233                         return (error);
3234                 if (__predict_false(fp->f_ops == &badfileops)) {
3235                         fdrop(fp, td);
3236                         return (EBADF);
3237                 }
3238                 if (maxprotp != NULL)
3239                         fdrights = *cap_rights(fdp, fd);
3240                 if (!fd_modified(fdp, fd, seq))
3241                         break;
3242                 fdrop(fp, td);
3243         }
3244
3245         /*
3246          * If requested, convert capability rights to access flags.
3247          */
3248         if (maxprotp != NULL)
3249                 *maxprotp = cap_rights_to_vmprot(&fdrights);
3250         *fpp = fp;
3251         return (0);
3252 #endif
3253 }
3254
3255 int
3256 fget_read(struct thread *td, int fd, cap_rights_t *rightsp, struct file **fpp)
3257 {
3258
3259         return (_fget(td, fd, fpp, FREAD, rightsp));
3260 }
3261
3262 int
3263 fget_write(struct thread *td, int fd, cap_rights_t *rightsp, struct file **fpp)
3264 {
3265
3266         return (_fget(td, fd, fpp, FWRITE, rightsp));
3267 }
3268
3269 int
3270 fget_fcntl(struct thread *td, int fd, cap_rights_t *rightsp, int needfcntl,
3271     struct file **fpp)
3272 {
3273         struct filedesc *fdp = td->td_proc->p_fd;
3274 #ifndef CAPABILITIES
3275         return (fget_unlocked(fdp, fd, rightsp, fpp));
3276 #else
3277         struct file *fp;
3278         int error;
3279         seqc_t seq;
3280
3281         *fpp = NULL;
3282         MPASS(cap_rights_is_set(rightsp, CAP_FCNTL));
3283         for (;;) {
3284                 error = fget_unlocked_seq(fdp, fd, rightsp, &fp, &seq);
3285                 if (error != 0)
3286                         return (error);
3287                 error = cap_fcntl_check(fdp, fd, needfcntl);
3288                 if (!fd_modified(fdp, fd, seq))
3289                         break;
3290                 fdrop(fp, td);
3291         }
3292         if (error != 0) {
3293                 fdrop(fp, td);
3294                 return (error);
3295         }
3296         *fpp = fp;
3297         return (0);
3298 #endif
3299 }
3300
3301 /*
3302  * Like fget() but loads the underlying vnode, or returns an error if the
3303  * descriptor does not represent a vnode.  Note that pipes use vnodes but
3304  * never have VM objects.  The returned vnode will be vref()'d.
3305  *
3306  * XXX: what about the unused flags ?
3307  */
3308 static __inline int
3309 _fgetvp(struct thread *td, int fd, int flags, cap_rights_t *needrightsp,
3310     struct vnode **vpp)
3311 {
3312         struct file *fp;
3313         int error;
3314
3315         *vpp = NULL;
3316         error = _fget(td, fd, &fp, flags, needrightsp);
3317         if (error != 0)
3318                 return (error);
3319         if (fp->f_vnode == NULL) {
3320                 error = EINVAL;
3321         } else {
3322                 *vpp = fp->f_vnode;
3323                 vrefact(*vpp);
3324         }
3325         fdrop(fp, td);
3326
3327         return (error);
3328 }
3329
3330 int
3331 fgetvp(struct thread *td, int fd, cap_rights_t *rightsp, struct vnode **vpp)
3332 {
3333
3334         return (_fgetvp(td, fd, 0, rightsp, vpp));
3335 }
3336
3337 int
3338 fgetvp_rights(struct thread *td, int fd, cap_rights_t *needrightsp,
3339     struct filecaps *havecaps, struct vnode **vpp)
3340 {
3341         struct filecaps caps;
3342         struct file *fp;
3343         int error;
3344
3345         error = fget_cap(td, fd, needrightsp, &fp, &caps);
3346         if (error != 0)
3347                 return (error);
3348         if (fp->f_ops == &badfileops) {
3349                 error = EBADF;
3350                 goto out;
3351         }
3352         if (fp->f_vnode == NULL) {
3353                 error = EINVAL;
3354                 goto out;
3355         }
3356
3357         *havecaps = caps;
3358         *vpp = fp->f_vnode;
3359         vrefact(*vpp);
3360         fdrop(fp, td);
3361
3362         return (0);
3363 out:
3364         filecaps_free(&caps);
3365         fdrop(fp, td);
3366         return (error);
3367 }
3368
3369 int
3370 fgetvp_read(struct thread *td, int fd, cap_rights_t *rightsp, struct vnode **vpp)
3371 {
3372
3373         return (_fgetvp(td, fd, FREAD, rightsp, vpp));
3374 }
3375
3376 int
3377 fgetvp_exec(struct thread *td, int fd, cap_rights_t *rightsp, struct vnode **vpp)
3378 {
3379
3380         return (_fgetvp(td, fd, FEXEC, rightsp, vpp));
3381 }
3382
3383 #ifdef notyet
3384 int
3385 fgetvp_write(struct thread *td, int fd, cap_rights_t *rightsp,
3386     struct vnode **vpp)
3387 {
3388
3389         return (_fgetvp(td, fd, FWRITE, rightsp, vpp));
3390 }
3391 #endif
3392
3393 /*
3394  * Handle the last reference to a file being closed.
3395  *
3396  * Without the noinline attribute clang keeps inlining the func thorough this
3397  * file when fdrop is used.
3398  */
3399 int __noinline
3400 _fdrop(struct file *fp, struct thread *td)
3401 {
3402         int error;
3403 #ifdef INVARIANTS
3404         int count;
3405
3406         count = refcount_load(&fp->f_count);
3407         if (count != 0)
3408                 panic("fdrop: fp %p count %d", fp, count);
3409 #endif
3410         error = fo_close(fp, td);
3411         atomic_subtract_int(&openfiles, 1);
3412         crfree(fp->f_cred);
3413         free(fp->f_advice, M_FADVISE);
3414         uma_zfree(file_zone, fp);
3415
3416         return (error);
3417 }
3418
3419 /*
3420  * Apply an advisory lock on a file descriptor.
3421  *
3422  * Just attempt to get a record lock of the requested type on the entire file
3423  * (l_whence = SEEK_SET, l_start = 0, l_len = 0).
3424  */
3425 #ifndef _SYS_SYSPROTO_H_
3426 struct flock_args {
3427         int     fd;
3428         int     how;
3429 };
3430 #endif
3431 /* ARGSUSED */
3432 int
3433 sys_flock(struct thread *td, struct flock_args *uap)
3434 {
3435         struct file *fp;
3436         struct vnode *vp;
3437         struct flock lf;
3438         int error;
3439
3440         error = fget(td, uap->fd, &cap_flock_rights, &fp);
3441         if (error != 0)
3442                 return (error);
3443         if (fp->f_type != DTYPE_VNODE) {
3444                 fdrop(fp, td);
3445                 return (EOPNOTSUPP);
3446         }
3447
3448         vp = fp->f_vnode;
3449         lf.l_whence = SEEK_SET;
3450         lf.l_start = 0;
3451         lf.l_len = 0;
3452         if (uap->how & LOCK_UN) {
3453                 lf.l_type = F_UNLCK;
3454                 atomic_clear_int(&fp->f_flag, FHASLOCK);
3455                 error = VOP_ADVLOCK(vp, (caddr_t)fp, F_UNLCK, &lf, F_FLOCK);
3456                 goto done2;
3457         }
3458         if (uap->how & LOCK_EX)
3459                 lf.l_type = F_WRLCK;
3460         else if (uap->how & LOCK_SH)
3461                 lf.l_type = F_RDLCK;
3462         else {
3463                 error = EBADF;
3464                 goto done2;
3465         }
3466         atomic_set_int(&fp->f_flag, FHASLOCK);
3467         error = VOP_ADVLOCK(vp, (caddr_t)fp, F_SETLK, &lf,
3468             (uap->how & LOCK_NB) ? F_FLOCK : F_FLOCK | F_WAIT);
3469 done2:
3470         fdrop(fp, td);
3471         return (error);
3472 }
3473 /*
3474  * Duplicate the specified descriptor to a free descriptor.
3475  */
3476 int
3477 dupfdopen(struct thread *td, struct filedesc *fdp, int dfd, int mode,
3478     int openerror, int *indxp)
3479 {
3480         struct filedescent *newfde, *oldfde;
3481         struct file *fp;
3482         u_long *ioctls;
3483         int error, indx;
3484
3485         KASSERT(openerror == ENODEV || openerror == ENXIO,
3486             ("unexpected error %d in %s", openerror, __func__));
3487
3488         /*
3489          * If the to-be-dup'd fd number is greater than the allowed number
3490          * of file descriptors, or the fd to be dup'd has already been
3491          * closed, then reject.
3492          */
3493         FILEDESC_XLOCK(fdp);
3494         if ((fp = fget_locked(fdp, dfd)) == NULL) {
3495                 FILEDESC_XUNLOCK(fdp);
3496                 return (EBADF);
3497         }
3498
3499         error = fdalloc(td, 0, &indx);
3500         if (error != 0) {
3501                 FILEDESC_XUNLOCK(fdp);
3502                 return (error);
3503         }
3504
3505         /*
3506          * There are two cases of interest here.
3507          *
3508          * For ENODEV simply dup (dfd) to file descriptor (indx) and return.
3509          *
3510          * For ENXIO steal away the file structure from (dfd) and store it in
3511          * (indx).  (dfd) is effectively closed by this operation.
3512          */
3513         switch (openerror) {
3514         case ENODEV:
3515                 /*
3516                  * Check that the mode the file is being opened for is a
3517                  * subset of the mode of the existing descriptor.
3518                  */
3519                 if (((mode & (FREAD|FWRITE)) | fp->f_flag) != fp->f_flag) {
3520                         fdunused(fdp, indx);
3521                         FILEDESC_XUNLOCK(fdp);
3522                         return (EACCES);
3523                 }
3524                 if (!fhold(fp)) {
3525                         fdunused(fdp, indx);
3526                         FILEDESC_XUNLOCK(fdp);
3527                         return (EBADF);
3528                 }
3529                 newfde = &fdp->fd_ofiles[indx];
3530                 oldfde = &fdp->fd_ofiles[dfd];
3531                 ioctls = filecaps_copy_prep(&oldfde->fde_caps);
3532 #ifdef CAPABILITIES
3533                 seqc_write_begin(&newfde->fde_seqc);
3534 #endif
3535                 memcpy(newfde, oldfde, fde_change_size);
3536                 filecaps_copy_finish(&oldfde->fde_caps, &newfde->fde_caps,
3537                     ioctls);
3538 #ifdef CAPABILITIES
3539                 seqc_write_end(&newfde->fde_seqc);
3540 #endif
3541                 break;
3542         case ENXIO:
3543                 /*
3544                  * Steal away the file pointer from dfd and stuff it into indx.
3545                  */
3546                 newfde = &fdp->fd_ofiles[indx];
3547                 oldfde = &fdp->fd_ofiles[dfd];
3548 #ifdef CAPABILITIES
3549                 seqc_write_begin(&newfde->fde_seqc);
3550 #endif
3551                 memcpy(newfde, oldfde, fde_change_size);
3552                 oldfde->fde_file = NULL;
3553                 fdunused(fdp, dfd);
3554 #ifdef CAPABILITIES
3555                 seqc_write_end(&newfde->fde_seqc);
3556 #endif
3557                 break;
3558         }
3559         FILEDESC_XUNLOCK(fdp);
3560         *indxp = indx;
3561         return (0);
3562 }
3563
3564 /*
3565  * This sysctl determines if we will allow a process to chroot(2) if it
3566  * has a directory open:
3567  *      0: disallowed for all processes.
3568  *      1: allowed for processes that were not already chroot(2)'ed.
3569  *      2: allowed for all processes.
3570  */
3571
3572 static int chroot_allow_open_directories = 1;
3573
3574 SYSCTL_INT(_kern, OID_AUTO, chroot_allow_open_directories, CTLFLAG_RW,
3575     &chroot_allow_open_directories, 0,
3576     "Allow a process to chroot(2) if it has a directory open");
3577
3578 /*
3579  * Helper function for raised chroot(2) security function:  Refuse if
3580  * any filedescriptors are open directories.
3581  */
3582 static int
3583 chroot_refuse_vdir_fds(struct filedesc *fdp)
3584 {
3585         struct vnode *vp;
3586         struct file *fp;
3587         int fd, lastfile;
3588
3589         FILEDESC_LOCK_ASSERT(fdp);
3590
3591         lastfile = fdlastfile(fdp);
3592         for (fd = 0; fd <= lastfile; fd++) {
3593                 fp = fget_locked(fdp, fd);
3594                 if (fp == NULL)
3595                         continue;
3596                 if (fp->f_type == DTYPE_VNODE) {
3597                         vp = fp->f_vnode;
3598                         if (vp->v_type == VDIR)
3599                                 return (EPERM);
3600                 }
3601         }
3602         return (0);
3603 }
3604
3605 static void
3606 pwd_fill(struct pwd *oldpwd, struct pwd *newpwd)
3607 {
3608
3609         if (newpwd->pwd_cdir == NULL && oldpwd->pwd_cdir != NULL) {
3610                 vrefact(oldpwd->pwd_cdir);
3611                 newpwd->pwd_cdir = oldpwd->pwd_cdir;
3612         }
3613
3614         if (newpwd->pwd_rdir == NULL && oldpwd->pwd_rdir != NULL) {
3615                 vrefact(oldpwd->pwd_rdir);
3616                 newpwd->pwd_rdir = oldpwd->pwd_rdir;
3617         }
3618
3619         if (newpwd->pwd_jdir == NULL && oldpwd->pwd_jdir != NULL) {
3620                 vrefact(oldpwd->pwd_jdir);
3621                 newpwd->pwd_jdir = oldpwd->pwd_jdir;
3622         }
3623 }
3624
3625 struct pwd *
3626 pwd_hold_pwddesc(struct pwddesc *pdp)
3627 {
3628         struct pwd *pwd;
3629
3630         PWDDESC_ASSERT_XLOCKED(pdp);
3631         pwd = PWDDESC_XLOCKED_LOAD_PWD(pdp);
3632         if (pwd != NULL)
3633                 refcount_acquire(&pwd->pwd_refcount);
3634         return (pwd);
3635 }
3636
3637 bool
3638 pwd_hold_smr(struct pwd *pwd)
3639 {
3640
3641         MPASS(pwd != NULL);
3642         if (__predict_true(refcount_acquire_if_not_zero(&pwd->pwd_refcount))) {
3643                 return (true);
3644         }
3645         return (false);
3646 }
3647
3648 struct pwd *
3649 pwd_hold(struct thread *td)
3650 {
3651         struct pwddesc *pdp;
3652         struct pwd *pwd;
3653
3654         pdp = td->td_proc->p_pd;
3655
3656         vfs_smr_enter();
3657         pwd = vfs_smr_entered_load(&pdp->pd_pwd);
3658         if (pwd_hold_smr(pwd)) {
3659                 vfs_smr_exit();
3660                 return (pwd);
3661         }
3662         vfs_smr_exit();
3663         PWDDESC_XLOCK(pdp);
3664         pwd = pwd_hold_pwddesc(pdp);
3665         MPASS(pwd != NULL);
3666         PWDDESC_XUNLOCK(pdp);
3667         return (pwd);
3668 }
3669
3670 struct pwd *
3671 pwd_get_smr(void)
3672 {
3673         struct pwd *pwd;
3674
3675         pwd = vfs_smr_entered_load(&curproc->p_pd->pd_pwd);
3676         MPASS(pwd != NULL);
3677         return (pwd);
3678 }
3679
3680 static struct pwd *
3681 pwd_alloc(void)
3682 {
3683         struct pwd *pwd;
3684
3685         pwd = uma_zalloc_smr(pwd_zone, M_WAITOK);
3686         bzero(pwd, sizeof(*pwd));
3687         refcount_init(&pwd->pwd_refcount, 1);
3688         return (pwd);
3689 }
3690
3691 void
3692 pwd_drop(struct pwd *pwd)
3693 {
3694
3695         if (!refcount_release(&pwd->pwd_refcount))
3696                 return;
3697
3698         if (pwd->pwd_cdir != NULL)
3699                 vrele(pwd->pwd_cdir);
3700         if (pwd->pwd_rdir != NULL)
3701                 vrele(pwd->pwd_rdir);
3702         if (pwd->pwd_jdir != NULL)
3703                 vrele(pwd->pwd_jdir);
3704         uma_zfree_smr(pwd_zone, pwd);
3705 }
3706
3707 /*
3708 * Common routine for kern_chroot() and jail_attach().  The caller is
3709 * responsible for invoking priv_check() and mac_vnode_check_chroot() to
3710 * authorize this operation.
3711 */
3712 int
3713 pwd_chroot(struct thread *td, struct vnode *vp)
3714 {
3715         struct pwddesc *pdp;
3716         struct filedesc *fdp;
3717         struct pwd *newpwd, *oldpwd;
3718         int error;
3719
3720         fdp = td->td_proc->p_fd;
3721         pdp = td->td_proc->p_pd;
3722         newpwd = pwd_alloc();
3723         FILEDESC_SLOCK(fdp);
3724         PWDDESC_XLOCK(pdp);
3725         oldpwd = PWDDESC_XLOCKED_LOAD_PWD(pdp);
3726         if (chroot_allow_open_directories == 0 ||
3727             (chroot_allow_open_directories == 1 &&
3728             oldpwd->pwd_rdir != rootvnode)) {
3729                 error = chroot_refuse_vdir_fds(fdp);
3730                 FILEDESC_SUNLOCK(fdp);
3731                 if (error != 0) {
3732                         PWDDESC_XUNLOCK(pdp);
3733                         pwd_drop(newpwd);
3734                         return (error);
3735                 }
3736         } else {
3737                 FILEDESC_SUNLOCK(fdp);
3738         }
3739
3740         vrefact(vp);
3741         newpwd->pwd_rdir = vp;
3742         if (oldpwd->pwd_jdir == NULL) {
3743                 vrefact(vp);
3744                 newpwd->pwd_jdir = vp;
3745         }
3746         pwd_fill(oldpwd, newpwd);
3747         pwd_set(pdp, newpwd);
3748         PWDDESC_XUNLOCK(pdp);
3749         pwd_drop(oldpwd);
3750         return (0);
3751 }
3752
3753 void
3754 pwd_chdir(struct thread *td, struct vnode *vp)
3755 {
3756         struct pwddesc *pdp;
3757         struct pwd *newpwd, *oldpwd;
3758
3759         VNPASS(vp->v_usecount > 0, vp);
3760
3761         newpwd = pwd_alloc();
3762         pdp = td->td_proc->p_pd;
3763         PWDDESC_XLOCK(pdp);
3764         oldpwd = PWDDESC_XLOCKED_LOAD_PWD(pdp);
3765         newpwd->pwd_cdir = vp;
3766         pwd_fill(oldpwd, newpwd);
3767         pwd_set(pdp, newpwd);
3768         PWDDESC_XUNLOCK(pdp);
3769         pwd_drop(oldpwd);
3770 }
3771
3772 void
3773 pwd_ensure_dirs(void)
3774 {
3775         struct pwddesc *pdp;
3776         struct pwd *oldpwd, *newpwd;
3777
3778         pdp = curproc->p_pd;
3779         PWDDESC_XLOCK(pdp);
3780         oldpwd = PWDDESC_XLOCKED_LOAD_PWD(pdp);
3781         if (oldpwd->pwd_cdir != NULL && oldpwd->pwd_rdir != NULL) {
3782                 PWDDESC_XUNLOCK(pdp);
3783                 return;
3784         }
3785         PWDDESC_XUNLOCK(pdp);
3786
3787         newpwd = pwd_alloc();
3788         PWDDESC_XLOCK(pdp);
3789         oldpwd = PWDDESC_XLOCKED_LOAD_PWD(pdp);
3790         pwd_fill(oldpwd, newpwd);
3791         if (newpwd->pwd_cdir == NULL) {
3792                 vrefact(rootvnode);
3793                 newpwd->pwd_cdir = rootvnode;
3794         }
3795         if (newpwd->pwd_rdir == NULL) {
3796                 vrefact(rootvnode);
3797                 newpwd->pwd_rdir = rootvnode;
3798         }
3799         pwd_set(pdp, newpwd);
3800         PWDDESC_XUNLOCK(pdp);
3801         pwd_drop(oldpwd);
3802 }
3803
3804 void
3805 pwd_set_rootvnode(void)
3806 {
3807         struct pwddesc *pdp;
3808         struct pwd *oldpwd, *newpwd;
3809
3810         pdp = curproc->p_pd;
3811
3812         newpwd = pwd_alloc();
3813         PWDDESC_XLOCK(pdp);
3814         oldpwd = PWDDESC_XLOCKED_LOAD_PWD(pdp);
3815         vrefact(rootvnode);
3816         newpwd->pwd_cdir = rootvnode;
3817         vrefact(rootvnode);
3818         newpwd->pwd_rdir = rootvnode;
3819         pwd_fill(oldpwd, newpwd);
3820         pwd_set(pdp, newpwd);
3821         PWDDESC_XUNLOCK(pdp);
3822         pwd_drop(oldpwd);
3823 }
3824
3825 /*
3826  * Scan all active processes and prisons to see if any of them have a current
3827  * or root directory of `olddp'. If so, replace them with the new mount point.
3828  */
3829 void
3830 mountcheckdirs(struct vnode *olddp, struct vnode *newdp)
3831 {
3832         struct pwddesc *pdp;
3833         struct pwd *newpwd, *oldpwd;
3834         struct prison *pr;
3835         struct proc *p;
3836         int nrele;
3837
3838         if (vrefcnt(olddp) == 1)
3839                 return;
3840         nrele = 0;
3841         newpwd = pwd_alloc();
3842         sx_slock(&allproc_lock);
3843         FOREACH_PROC_IN_SYSTEM(p) {
3844                 PROC_LOCK(p);
3845                 pdp = pdhold(p);
3846                 PROC_UNLOCK(p);
3847                 if (pdp == NULL)
3848                         continue;
3849                 PWDDESC_XLOCK(pdp);
3850                 oldpwd = PWDDESC_XLOCKED_LOAD_PWD(pdp);
3851                 if (oldpwd == NULL ||
3852                     (oldpwd->pwd_cdir != olddp &&
3853                     oldpwd->pwd_rdir != olddp &&
3854                     oldpwd->pwd_jdir != olddp)) {
3855                         PWDDESC_XUNLOCK(pdp);
3856                         pddrop(pdp);
3857                         continue;
3858                 }
3859                 if (oldpwd->pwd_cdir == olddp) {
3860                         vrefact(newdp);
3861                         newpwd->pwd_cdir = newdp;
3862                 }
3863                 if (oldpwd->pwd_rdir == olddp) {
3864                         vrefact(newdp);
3865                         newpwd->pwd_rdir = newdp;
3866                 }
3867                 if (oldpwd->pwd_jdir == olddp) {
3868                         vrefact(newdp);
3869                         newpwd->pwd_jdir = newdp;
3870                 }
3871                 pwd_fill(oldpwd, newpwd);
3872                 pwd_set(pdp, newpwd);
3873                 PWDDESC_XUNLOCK(pdp);
3874                 pwd_drop(oldpwd);
3875                 pddrop(pdp);
3876                 newpwd = pwd_alloc();
3877         }
3878         sx_sunlock(&allproc_lock);
3879         pwd_drop(newpwd);
3880         if (rootvnode == olddp) {
3881                 vrefact(newdp);
3882                 rootvnode = newdp;
3883                 nrele++;
3884         }
3885         mtx_lock(&prison0.pr_mtx);
3886         if (prison0.pr_root == olddp) {
3887                 vrefact(newdp);
3888                 prison0.pr_root = newdp;
3889                 nrele++;
3890         }
3891         mtx_unlock(&prison0.pr_mtx);
3892         sx_slock(&allprison_lock);
3893         TAILQ_FOREACH(pr, &allprison, pr_list) {
3894                 mtx_lock(&pr->pr_mtx);
3895                 if (pr->pr_root == olddp) {
3896                         vrefact(newdp);
3897                         pr->pr_root = newdp;
3898                         nrele++;
3899                 }
3900                 mtx_unlock(&pr->pr_mtx);
3901         }
3902         sx_sunlock(&allprison_lock);
3903         while (nrele--)
3904                 vrele(olddp);
3905 }
3906
3907 struct filedesc_to_leader *
3908 filedesc_to_leader_alloc(struct filedesc_to_leader *old, struct filedesc *fdp, struct proc *leader)
3909 {
3910         struct filedesc_to_leader *fdtol;
3911
3912         fdtol = malloc(sizeof(struct filedesc_to_leader),
3913             M_FILEDESC_TO_LEADER, M_WAITOK);
3914         fdtol->fdl_refcount = 1;
3915         fdtol->fdl_holdcount = 0;
3916         fdtol->fdl_wakeup = 0;
3917         fdtol->fdl_leader = leader;
3918         if (old != NULL) {
3919                 FILEDESC_XLOCK(fdp);
3920                 fdtol->fdl_next = old->fdl_next;
3921                 fdtol->fdl_prev = old;
3922                 old->fdl_next = fdtol;
3923                 fdtol->fdl_next->fdl_prev = fdtol;
3924                 FILEDESC_XUNLOCK(fdp);
3925         } else {
3926                 fdtol->fdl_next = fdtol;
3927                 fdtol->fdl_prev = fdtol;
3928         }
3929         return (fdtol);
3930 }
3931
3932 static int
3933 sysctl_kern_proc_nfds(SYSCTL_HANDLER_ARGS)
3934 {
3935         NDSLOTTYPE *map;
3936         struct filedesc *fdp;
3937         int count, off, minoff;
3938
3939         if (*(int *)arg1 != 0)
3940                 return (EINVAL);
3941
3942         fdp = curproc->p_fd;
3943         count = 0;
3944         FILEDESC_SLOCK(fdp);
3945         map = fdp->fd_map;
3946         off = NDSLOT(fdp->fd_nfiles - 1);
3947         for (minoff = NDSLOT(0); off >= minoff; --off)
3948                 count += bitcountl(map[off]);
3949         FILEDESC_SUNLOCK(fdp);
3950
3951         return (SYSCTL_OUT(req, &count, sizeof(count)));
3952 }
3953
3954 static SYSCTL_NODE(_kern_proc, KERN_PROC_NFDS, nfds,
3955     CTLFLAG_RD|CTLFLAG_CAPRD|CTLFLAG_MPSAFE, sysctl_kern_proc_nfds,
3956     "Number of open file descriptors");
3957
3958 /*
3959  * Get file structures globally.
3960  */
3961 static int
3962 sysctl_kern_file(SYSCTL_HANDLER_ARGS)
3963 {
3964         struct xfile xf;
3965         struct filedesc *fdp;
3966         struct file *fp;
3967         struct proc *p;
3968         int error, n, lastfile;
3969
3970         error = sysctl_wire_old_buffer(req, 0);
3971         if (error != 0)
3972                 return (error);
3973         if (req->oldptr == NULL) {
3974                 n = 0;
3975                 sx_slock(&allproc_lock);
3976                 FOREACH_PROC_IN_SYSTEM(p) {
3977                         PROC_LOCK(p);
3978                         if (p->p_state == PRS_NEW) {
3979                                 PROC_UNLOCK(p);
3980                                 continue;
3981                         }
3982                         fdp = fdhold(p);
3983                         PROC_UNLOCK(p);
3984                         if (fdp == NULL)
3985                                 continue;
3986                         /* overestimates sparse tables. */
3987                         n += fdp->fd_nfiles;
3988                         fddrop(fdp);
3989                 }
3990                 sx_sunlock(&allproc_lock);
3991                 return (SYSCTL_OUT(req, 0, n * sizeof(xf)));
3992         }
3993         error = 0;
3994         bzero(&xf, sizeof(xf));
3995         xf.xf_size = sizeof(xf);
3996         sx_slock(&allproc_lock);
3997         FOREACH_PROC_IN_SYSTEM(p) {
3998                 PROC_LOCK(p);
3999                 if (p->p_state == PRS_NEW) {
4000                         PROC_UNLOCK(p);
4001                         continue;
4002                 }
4003                 if (p_cansee(req->td, p) != 0) {
4004                         PROC_UNLOCK(p);
4005                         continue;
4006                 }
4007                 xf.xf_pid = p->p_pid;
4008                 xf.xf_uid = p->p_ucred->cr_uid;
4009                 fdp = fdhold(p);
4010                 PROC_UNLOCK(p);
4011                 if (fdp == NULL)
4012                         continue;
4013                 FILEDESC_SLOCK(fdp);
4014                 lastfile = fdlastfile(fdp);
4015                 for (n = 0; refcount_load(&fdp->fd_refcnt) > 0 && n <= lastfile;
4016                     n++) {
4017                         if ((fp = fdp->fd_ofiles[n].fde_file) == NULL)
4018                                 continue;
4019                         xf.xf_fd = n;
4020                         xf.xf_file = (uintptr_t)fp;
4021                         xf.xf_data = (uintptr_t)fp->f_data;
4022                         xf.xf_vnode = (uintptr_t)fp->f_vnode;
4023                         xf.xf_type = (uintptr_t)fp->f_type;
4024                         xf.xf_count = refcount_load(&fp->f_count);
4025                         xf.xf_msgcount = 0;
4026                         xf.xf_offset = foffset_get(fp);
4027                         xf.xf_flag = fp->f_flag;
4028                         error = SYSCTL_OUT(req, &xf, sizeof(xf));
4029                         if (error)
4030                                 break;
4031                 }
4032                 FILEDESC_SUNLOCK(fdp);
4033                 fddrop(fdp);
4034                 if (error)
4035                         break;
4036         }
4037         sx_sunlock(&allproc_lock);
4038         return (error);
4039 }
4040
4041 SYSCTL_PROC(_kern, KERN_FILE, file, CTLTYPE_OPAQUE|CTLFLAG_RD|CTLFLAG_MPSAFE,
4042     0, 0, sysctl_kern_file, "S,xfile", "Entire file table");
4043
4044 #ifdef KINFO_FILE_SIZE
4045 CTASSERT(sizeof(struct kinfo_file) == KINFO_FILE_SIZE);
4046 #endif
4047
4048 static int
4049 xlate_fflags(int fflags)
4050 {
4051         static const struct {
4052                 int     fflag;
4053                 int     kf_fflag;
4054         } fflags_table[] = {
4055                 { FAPPEND, KF_FLAG_APPEND },
4056                 { FASYNC, KF_FLAG_ASYNC },
4057                 { FFSYNC, KF_FLAG_FSYNC },
4058                 { FHASLOCK, KF_FLAG_HASLOCK },
4059                 { FNONBLOCK, KF_FLAG_NONBLOCK },
4060                 { FREAD, KF_FLAG_READ },
4061                 { FWRITE, KF_FLAG_WRITE },
4062                 { O_CREAT, KF_FLAG_CREAT },
4063                 { O_DIRECT, KF_FLAG_DIRECT },
4064                 { O_EXCL, KF_FLAG_EXCL },
4065                 { O_EXEC, KF_FLAG_EXEC },
4066                 { O_EXLOCK, KF_FLAG_EXLOCK },
4067                 { O_NOFOLLOW, KF_FLAG_NOFOLLOW },
4068                 { O_SHLOCK, KF_FLAG_SHLOCK },
4069                 { O_TRUNC, KF_FLAG_TRUNC }
4070         };
4071         unsigned int i;
4072         int kflags;
4073
4074         kflags = 0;
4075         for (i = 0; i < nitems(fflags_table); i++)
4076                 if (fflags & fflags_table[i].fflag)
4077                         kflags |=  fflags_table[i].kf_fflag;
4078         return (kflags);
4079 }
4080
4081 /* Trim unused data from kf_path by truncating the structure size. */
4082 void
4083 pack_kinfo(struct kinfo_file *kif)
4084 {
4085
4086         kif->kf_structsize = offsetof(struct kinfo_file, kf_path) +
4087             strlen(kif->kf_path) + 1;
4088         kif->kf_structsize = roundup(kif->kf_structsize, sizeof(uint64_t));
4089 }
4090
4091 static void
4092 export_file_to_kinfo(struct file *fp, int fd, cap_rights_t *rightsp,
4093     struct kinfo_file *kif, struct filedesc *fdp, int flags)
4094 {
4095         int error;
4096
4097         bzero(kif, sizeof(*kif));
4098
4099         /* Set a default type to allow for empty fill_kinfo() methods. */
4100         kif->kf_type = KF_TYPE_UNKNOWN;
4101         kif->kf_flags = xlate_fflags(fp->f_flag);
4102         if (rightsp != NULL)
4103                 kif->kf_cap_rights = *rightsp;
4104         else
4105                 cap_rights_init_zero(&kif->kf_cap_rights);
4106         kif->kf_fd = fd;
4107         kif->kf_ref_count = refcount_load(&fp->f_count);
4108         kif->kf_offset = foffset_get(fp);
4109
4110         /*
4111          * This may drop the filedesc lock, so the 'fp' cannot be
4112          * accessed after this call.
4113          */
4114         error = fo_fill_kinfo(fp, kif, fdp);
4115         if (error == 0)
4116                 kif->kf_status |= KF_ATTR_VALID;
4117         if ((flags & KERN_FILEDESC_PACK_KINFO) != 0)
4118                 pack_kinfo(kif);
4119         else
4120                 kif->kf_structsize = roundup2(sizeof(*kif), sizeof(uint64_t));
4121 }
4122
4123 static void
4124 export_vnode_to_kinfo(struct vnode *vp, int fd, int fflags,
4125     struct kinfo_file *kif, int flags)
4126 {
4127         int error;
4128
4129         bzero(kif, sizeof(*kif));
4130
4131         kif->kf_type = KF_TYPE_VNODE;
4132         error = vn_fill_kinfo_vnode(vp, kif);
4133         if (error == 0)
4134                 kif->kf_status |= KF_ATTR_VALID;
4135         kif->kf_flags = xlate_fflags(fflags);
4136         cap_rights_init_zero(&kif->kf_cap_rights);
4137         kif->kf_fd = fd;
4138         kif->kf_ref_count = -1;
4139         kif->kf_offset = -1;
4140         if ((flags & KERN_FILEDESC_PACK_KINFO) != 0)
4141                 pack_kinfo(kif);
4142         else
4143                 kif->kf_structsize = roundup2(sizeof(*kif), sizeof(uint64_t));
4144         vrele(vp);
4145 }
4146
4147 struct export_fd_buf {
4148         struct filedesc         *fdp;
4149         struct pwddesc  *pdp;
4150         struct sbuf             *sb;
4151         ssize_t                 remainder;
4152         struct kinfo_file       kif;
4153         int                     flags;
4154 };
4155
4156 static int
4157 export_kinfo_to_sb(struct export_fd_buf *efbuf)
4158 {
4159         struct kinfo_file *kif;
4160
4161         kif = &efbuf->kif;
4162         if (efbuf->remainder != -1) {
4163                 if (efbuf->remainder < kif->kf_structsize) {
4164                         /* Terminate export. */
4165                         efbuf->remainder = 0;
4166                         return (0);
4167                 }
4168                 efbuf->remainder -= kif->kf_structsize;
4169         }
4170         return (sbuf_bcat(efbuf->sb, kif, kif->kf_structsize) == 0 ? 0 : ENOMEM);
4171 }
4172
4173 static int
4174 export_file_to_sb(struct file *fp, int fd, cap_rights_t *rightsp,
4175     struct export_fd_buf *efbuf)
4176 {
4177         int error;
4178
4179         if (efbuf->remainder == 0)
4180                 return (0);
4181         export_file_to_kinfo(fp, fd, rightsp, &efbuf->kif, efbuf->fdp,
4182             efbuf->flags);
4183         FILEDESC_SUNLOCK(efbuf->fdp);
4184         error = export_kinfo_to_sb(efbuf);
4185         FILEDESC_SLOCK(efbuf->fdp);
4186         return (error);
4187 }
4188
4189 static int
4190 export_vnode_to_sb(struct vnode *vp, int fd, int fflags,
4191     struct export_fd_buf *efbuf)
4192 {
4193         int error;
4194
4195         if (efbuf->remainder == 0)
4196                 return (0);
4197         if (efbuf->pdp != NULL)
4198                 PWDDESC_XUNLOCK(efbuf->pdp);
4199         export_vnode_to_kinfo(vp, fd, fflags, &efbuf->kif, efbuf->flags);
4200         error = export_kinfo_to_sb(efbuf);
4201         if (efbuf->pdp != NULL)
4202                 PWDDESC_XLOCK(efbuf->pdp);
4203         return (error);
4204 }
4205
4206 /*
4207  * Store a process file descriptor information to sbuf.
4208  *
4209  * Takes a locked proc as argument, and returns with the proc unlocked.
4210  */
4211 int
4212 kern_proc_filedesc_out(struct proc *p,  struct sbuf *sb, ssize_t maxlen,
4213     int flags)
4214 {
4215         struct file *fp;
4216         struct filedesc *fdp;
4217         struct pwddesc *pdp;
4218         struct export_fd_buf *efbuf;
4219         struct vnode *cttyvp, *textvp, *tracevp;
4220         struct pwd *pwd;
4221         int error, i, lastfile;
4222         cap_rights_t rights;
4223
4224         PROC_LOCK_ASSERT(p, MA_OWNED);
4225
4226         /* ktrace vnode */
4227         tracevp = p->p_tracevp;
4228         if (tracevp != NULL)
4229                 vrefact(tracevp);
4230         /* text vnode */
4231         textvp = p->p_textvp;
4232         if (textvp != NULL)
4233                 vrefact(textvp);
4234         /* Controlling tty. */
4235         cttyvp = NULL;
4236         if (p->p_pgrp != NULL && p->p_pgrp->pg_session != NULL) {
4237                 cttyvp = p->p_pgrp->pg_session->s_ttyvp;
4238                 if (cttyvp != NULL)
4239                         vrefact(cttyvp);
4240         }
4241         fdp = fdhold(p);
4242         pdp = pdhold(p);
4243         PROC_UNLOCK(p);
4244         efbuf = malloc(sizeof(*efbuf), M_TEMP, M_WAITOK);
4245         efbuf->fdp = NULL;
4246         efbuf->pdp = NULL;
4247         efbuf->sb = sb;
4248         efbuf->remainder = maxlen;
4249         efbuf->flags = flags;
4250         if (tracevp != NULL)
4251                 export_vnode_to_sb(tracevp, KF_FD_TYPE_TRACE, FREAD | FWRITE,
4252                     efbuf);
4253         if (textvp != NULL)
4254                 export_vnode_to_sb(textvp, KF_FD_TYPE_TEXT, FREAD, efbuf);
4255         if (cttyvp != NULL)
4256                 export_vnode_to_sb(cttyvp, KF_FD_TYPE_CTTY, FREAD | FWRITE,
4257                     efbuf);
4258         error = 0;
4259         if (pdp == NULL || fdp == NULL)
4260                 goto fail;
4261         efbuf->fdp = fdp;
4262         efbuf->pdp = pdp;
4263         PWDDESC_XLOCK(pdp);
4264         pwd = pwd_hold_pwddesc(pdp);
4265         if (pwd != NULL) {
4266                 /* working directory */
4267                 if (pwd->pwd_cdir != NULL) {
4268                         vrefact(pwd->pwd_cdir);
4269                         export_vnode_to_sb(pwd->pwd_cdir, KF_FD_TYPE_CWD, FREAD, efbuf);
4270                 }
4271                 /* root directory */
4272                 if (pwd->pwd_rdir != NULL) {
4273                         vrefact(pwd->pwd_rdir);
4274                         export_vnode_to_sb(pwd->pwd_rdir, KF_FD_TYPE_ROOT, FREAD, efbuf);
4275                 }
4276                 /* jail directory */
4277                 if (pwd->pwd_jdir != NULL) {
4278                         vrefact(pwd->pwd_jdir);
4279                         export_vnode_to_sb(pwd->pwd_jdir, KF_FD_TYPE_JAIL, FREAD, efbuf);
4280                 }
4281         }
4282         PWDDESC_XUNLOCK(pdp);
4283         if (pwd != NULL)
4284                 pwd_drop(pwd);
4285         FILEDESC_SLOCK(fdp);
4286         lastfile = fdlastfile(fdp);
4287         for (i = 0; refcount_load(&fdp->fd_refcnt) > 0 && i <= lastfile; i++) {
4288                 if ((fp = fdp->fd_ofiles[i].fde_file) == NULL)
4289                         continue;
4290 #ifdef CAPABILITIES
4291                 rights = *cap_rights(fdp, i);
4292 #else /* !CAPABILITIES */
4293                 rights = cap_no_rights;
4294 #endif
4295                 /*
4296                  * Create sysctl entry.  It is OK to drop the filedesc
4297                  * lock inside of export_file_to_sb() as we will
4298                  * re-validate and re-evaluate its properties when the
4299                  * loop continues.
4300                  */
4301                 error = export_file_to_sb(fp, i, &rights, efbuf);
4302                 if (error != 0 || efbuf->remainder == 0)
4303                         break;
4304         }
4305         FILEDESC_SUNLOCK(fdp);
4306 fail:
4307         if (fdp != NULL)
4308                 fddrop(fdp);
4309         if (pdp != NULL)
4310                 pddrop(pdp);
4311         free(efbuf, M_TEMP);
4312         return (error);
4313 }
4314
4315 #define FILEDESC_SBUF_SIZE      (sizeof(struct kinfo_file) * 5)
4316
4317 /*
4318  * Get per-process file descriptors for use by procstat(1), et al.
4319  */
4320 static int
4321 sysctl_kern_proc_filedesc(SYSCTL_HANDLER_ARGS)
4322 {
4323         struct sbuf sb;
4324         struct proc *p;
4325         ssize_t maxlen;
4326         int error, error2, *name;
4327
4328         name = (int *)arg1;
4329
4330         sbuf_new_for_sysctl(&sb, NULL, FILEDESC_SBUF_SIZE, req);
4331         sbuf_clear_flags(&sb, SBUF_INCLUDENUL);
4332         error = pget((pid_t)name[0], PGET_CANDEBUG | PGET_NOTWEXIT, &p);
4333         if (error != 0) {
4334                 sbuf_delete(&sb);
4335                 return (error);
4336         }
4337         maxlen = req->oldptr != NULL ? req->oldlen : -1;
4338         error = kern_proc_filedesc_out(p, &sb, maxlen,
4339             KERN_FILEDESC_PACK_KINFO);
4340         error2 = sbuf_finish(&sb);
4341         sbuf_delete(&sb);
4342         return (error != 0 ? error : error2);
4343 }
4344
4345 #ifdef COMPAT_FREEBSD7
4346 #ifdef KINFO_OFILE_SIZE
4347 CTASSERT(sizeof(struct kinfo_ofile) == KINFO_OFILE_SIZE);
4348 #endif
4349
4350 static void
4351 kinfo_to_okinfo(struct kinfo_file *kif, struct kinfo_ofile *okif)
4352 {
4353
4354         okif->kf_structsize = sizeof(*okif);
4355         okif->kf_type = kif->kf_type;
4356         okif->kf_fd = kif->kf_fd;
4357         okif->kf_ref_count = kif->kf_ref_count;
4358         okif->kf_flags = kif->kf_flags & (KF_FLAG_READ | KF_FLAG_WRITE |
4359             KF_FLAG_APPEND | KF_FLAG_ASYNC | KF_FLAG_FSYNC | KF_FLAG_NONBLOCK |
4360             KF_FLAG_DIRECT | KF_FLAG_HASLOCK);
4361         okif->kf_offset = kif->kf_offset;
4362         if (kif->kf_type == KF_TYPE_VNODE)
4363                 okif->kf_vnode_type = kif->kf_un.kf_file.kf_file_type;
4364         else
4365                 okif->kf_vnode_type = KF_VTYPE_VNON;
4366         strlcpy(okif->kf_path, kif->kf_path, sizeof(okif->kf_path));
4367         if (kif->kf_type == KF_TYPE_SOCKET) {
4368                 okif->kf_sock_domain = kif->kf_un.kf_sock.kf_sock_domain0;
4369                 okif->kf_sock_type = kif->kf_un.kf_sock.kf_sock_type0;
4370                 okif->kf_sock_protocol = kif->kf_un.kf_sock.kf_sock_protocol0;
4371                 okif->kf_sa_local = kif->kf_un.kf_sock.kf_sa_local;
4372                 okif->kf_sa_peer = kif->kf_un.kf_sock.kf_sa_peer;
4373         } else {
4374                 okif->kf_sa_local.ss_family = AF_UNSPEC;
4375                 okif->kf_sa_peer.ss_family = AF_UNSPEC;
4376         }
4377 }
4378
4379 static int
4380 export_vnode_for_osysctl(struct vnode *vp, int type, struct kinfo_file *kif,
4381     struct kinfo_ofile *okif, struct pwddesc *pdp, struct sysctl_req *req)
4382 {
4383         int error;
4384
4385         vrefact(vp);
4386         PWDDESC_XUNLOCK(pdp);
4387         export_vnode_to_kinfo(vp, type, 0, kif, KERN_FILEDESC_PACK_KINFO);
4388         kinfo_to_okinfo(kif, okif);
4389         error = SYSCTL_OUT(req, okif, sizeof(*okif));
4390         PWDDESC_XLOCK(pdp);
4391         return (error);
4392 }
4393
4394 /*
4395  * Get per-process file descriptors for use by procstat(1), et al.
4396  */
4397 static int
4398 sysctl_kern_proc_ofiledesc(SYSCTL_HANDLER_ARGS)
4399 {
4400         struct kinfo_ofile *okif;
4401         struct kinfo_file *kif;
4402         struct filedesc *fdp;
4403         struct pwddesc *pdp;
4404         struct pwd *pwd;
4405         int error, i, lastfile, *name;
4406         struct file *fp;
4407         struct proc *p;
4408
4409         name = (int *)arg1;
4410         error = pget((pid_t)name[0], PGET_CANDEBUG | PGET_NOTWEXIT, &p);
4411         if (error != 0)
4412                 return (error);
4413         fdp = fdhold(p);
4414         if (fdp != NULL)
4415                 pdp = pdhold(p);
4416         PROC_UNLOCK(p);
4417         if (fdp == NULL || pdp == NULL) {
4418                 if (fdp != NULL)
4419                         fddrop(fdp);
4420                 return (ENOENT);
4421         }
4422         kif = malloc(sizeof(*kif), M_TEMP, M_WAITOK);
4423         okif = malloc(sizeof(*okif), M_TEMP, M_WAITOK);
4424         PWDDESC_XLOCK(pdp);
4425         pwd = pwd_hold_pwddesc(pdp);
4426         if (pwd != NULL) {
4427                 if (pwd->pwd_cdir != NULL)
4428                         export_vnode_for_osysctl(pwd->pwd_cdir, KF_FD_TYPE_CWD, kif,
4429                             okif, pdp, req);
4430                 if (pwd->pwd_rdir != NULL)
4431                         export_vnode_for_osysctl(pwd->pwd_rdir, KF_FD_TYPE_ROOT, kif,
4432                             okif, pdp, req);
4433                 if (pwd->pwd_jdir != NULL)
4434                         export_vnode_for_osysctl(pwd->pwd_jdir, KF_FD_TYPE_JAIL, kif,
4435                             okif, pdp, req);
4436         }
4437         PWDDESC_XUNLOCK(pdp);
4438         if (pwd != NULL)
4439                 pwd_drop(pwd);
4440         FILEDESC_SLOCK(fdp);
4441         lastfile = fdlastfile(fdp);
4442         for (i = 0; refcount_load(&fdp->fd_refcnt) > 0 && i <= lastfile; i++) {
4443                 if ((fp = fdp->fd_ofiles[i].fde_file) == NULL)
4444                         continue;
4445                 export_file_to_kinfo(fp, i, NULL, kif, fdp,
4446                     KERN_FILEDESC_PACK_KINFO);
4447                 FILEDESC_SUNLOCK(fdp);
4448                 kinfo_to_okinfo(kif, okif);
4449                 error = SYSCTL_OUT(req, okif, sizeof(*okif));
4450                 FILEDESC_SLOCK(fdp);
4451                 if (error)
4452                         break;
4453         }
4454         FILEDESC_SUNLOCK(fdp);
4455         fddrop(fdp);
4456         pddrop(pdp);
4457         free(kif, M_TEMP);
4458         free(okif, M_TEMP);
4459         return (0);
4460 }
4461
4462 static SYSCTL_NODE(_kern_proc, KERN_PROC_OFILEDESC, ofiledesc,
4463     CTLFLAG_RD|CTLFLAG_MPSAFE, sysctl_kern_proc_ofiledesc,
4464     "Process ofiledesc entries");
4465 #endif  /* COMPAT_FREEBSD7 */
4466
4467 int
4468 vntype_to_kinfo(int vtype)
4469 {
4470         struct {
4471                 int     vtype;
4472                 int     kf_vtype;
4473         } vtypes_table[] = {
4474                 { VBAD, KF_VTYPE_VBAD },
4475                 { VBLK, KF_VTYPE_VBLK },
4476                 { VCHR, KF_VTYPE_VCHR },
4477                 { VDIR, KF_VTYPE_VDIR },
4478                 { VFIFO, KF_VTYPE_VFIFO },
4479                 { VLNK, KF_VTYPE_VLNK },
4480                 { VNON, KF_VTYPE_VNON },
4481                 { VREG, KF_VTYPE_VREG },
4482                 { VSOCK, KF_VTYPE_VSOCK }
4483         };
4484         unsigned int i;
4485
4486         /*
4487          * Perform vtype translation.
4488          */
4489         for (i = 0; i < nitems(vtypes_table); i++)
4490                 if (vtypes_table[i].vtype == vtype)
4491                         return (vtypes_table[i].kf_vtype);
4492
4493         return (KF_VTYPE_UNKNOWN);
4494 }
4495
4496 static SYSCTL_NODE(_kern_proc, KERN_PROC_FILEDESC, filedesc,
4497     CTLFLAG_RD|CTLFLAG_MPSAFE, sysctl_kern_proc_filedesc,
4498     "Process filedesc entries");
4499
4500 /*
4501  * Store a process current working directory information to sbuf.
4502  *
4503  * Takes a locked proc as argument, and returns with the proc unlocked.
4504  */
4505 int
4506 kern_proc_cwd_out(struct proc *p,  struct sbuf *sb, ssize_t maxlen)
4507 {
4508         struct pwddesc *pdp;
4509         struct pwd *pwd;
4510         struct export_fd_buf *efbuf;
4511         struct vnode *cdir;
4512         int error;
4513
4514         PROC_LOCK_ASSERT(p, MA_OWNED);
4515
4516         pdp = pdhold(p);
4517         PROC_UNLOCK(p);
4518         if (pdp == NULL)
4519                 return (EINVAL);
4520
4521         efbuf = malloc(sizeof(*efbuf), M_TEMP, M_WAITOK);
4522         efbuf->pdp = pdp;
4523         efbuf->sb = sb;
4524         efbuf->remainder = maxlen;
4525
4526         PWDDESC_XLOCK(pdp);
4527         pwd = PWDDESC_XLOCKED_LOAD_PWD(pdp);
4528         cdir = pwd->pwd_cdir;
4529         if (cdir == NULL) {
4530                 error = EINVAL;
4531         } else {
4532                 vrefact(cdir);
4533                 error = export_vnode_to_sb(cdir, KF_FD_TYPE_CWD, FREAD, efbuf);
4534         }
4535         PWDDESC_XUNLOCK(pdp);
4536         pddrop(pdp);
4537         free(efbuf, M_TEMP);
4538         return (error);
4539 }
4540
4541 /*
4542  * Get per-process current working directory.
4543  */
4544 static int
4545 sysctl_kern_proc_cwd(SYSCTL_HANDLER_ARGS)
4546 {
4547         struct sbuf sb;
4548         struct proc *p;
4549         ssize_t maxlen;
4550         int error, error2, *name;
4551
4552         name = (int *)arg1;
4553
4554         sbuf_new_for_sysctl(&sb, NULL, sizeof(struct kinfo_file), req);
4555         sbuf_clear_flags(&sb, SBUF_INCLUDENUL);
4556         error = pget((pid_t)name[0], PGET_CANDEBUG | PGET_NOTWEXIT, &p);
4557         if (error != 0) {
4558                 sbuf_delete(&sb);
4559                 return (error);
4560         }
4561         maxlen = req->oldptr != NULL ? req->oldlen : -1;
4562         error = kern_proc_cwd_out(p, &sb, maxlen);
4563         error2 = sbuf_finish(&sb);
4564         sbuf_delete(&sb);
4565         return (error != 0 ? error : error2);
4566 }
4567
4568 static SYSCTL_NODE(_kern_proc, KERN_PROC_CWD, cwd, CTLFLAG_RD|CTLFLAG_MPSAFE,
4569     sysctl_kern_proc_cwd, "Process current working directory");
4570
4571 #ifdef DDB
4572 /*
4573  * For the purposes of debugging, generate a human-readable string for the
4574  * file type.
4575  */
4576 static const char *
4577 file_type_to_name(short type)
4578 {
4579
4580         switch (type) {
4581         case 0:
4582                 return ("zero");
4583         case DTYPE_VNODE:
4584                 return ("vnode");
4585         case DTYPE_SOCKET:
4586                 return ("socket");
4587         case DTYPE_PIPE:
4588                 return ("pipe");
4589         case DTYPE_FIFO:
4590                 return ("fifo");
4591         case DTYPE_KQUEUE:
4592                 return ("kqueue");
4593         case DTYPE_CRYPTO:
4594                 return ("crypto");
4595         case DTYPE_MQUEUE:
4596                 return ("mqueue");
4597         case DTYPE_SHM:
4598                 return ("shm");
4599         case DTYPE_SEM:
4600                 return ("ksem");
4601         case DTYPE_PTS:
4602                 return ("pts");
4603         case DTYPE_DEV:
4604                 return ("dev");
4605         case DTYPE_PROCDESC:
4606                 return ("proc");
4607         case DTYPE_LINUXEFD:
4608                 return ("levent");
4609         case DTYPE_LINUXTFD:
4610                 return ("ltimer");
4611         default:
4612                 return ("unkn");
4613         }
4614 }
4615
4616 /*
4617  * For the purposes of debugging, identify a process (if any, perhaps one of
4618  * many) that references the passed file in its file descriptor array. Return
4619  * NULL if none.
4620  */
4621 static struct proc *
4622 file_to_first_proc(struct file *fp)
4623 {
4624         struct filedesc *fdp;
4625         struct proc *p;
4626         int n;
4627
4628         FOREACH_PROC_IN_SYSTEM(p) {
4629                 if (p->p_state == PRS_NEW)
4630                         continue;
4631                 fdp = p->p_fd;
4632                 if (fdp == NULL)
4633                         continue;
4634                 for (n = 0; n < fdp->fd_nfiles; n++) {
4635                         if (fp == fdp->fd_ofiles[n].fde_file)
4636                                 return (p);
4637                 }
4638         }
4639         return (NULL);
4640 }
4641
4642 static void
4643 db_print_file(struct file *fp, int header)
4644 {
4645 #define XPTRWIDTH ((int)howmany(sizeof(void *) * NBBY, 4))
4646         struct proc *p;
4647
4648         if (header)
4649                 db_printf("%*s %6s %*s %8s %4s %5s %6s %*s %5s %s\n",
4650                     XPTRWIDTH, "File", "Type", XPTRWIDTH, "Data", "Flag",
4651                     "GCFl", "Count", "MCount", XPTRWIDTH, "Vnode", "FPID",
4652                     "FCmd");
4653         p = file_to_first_proc(fp);
4654         db_printf("%*p %6s %*p %08x %04x %5d %6d %*p %5d %s\n", XPTRWIDTH,
4655             fp, file_type_to_name(fp->f_type), XPTRWIDTH, fp->f_data,
4656             fp->f_flag, 0, refcount_load(&fp->f_count), 0, XPTRWIDTH, fp->f_vnode,
4657             p != NULL ? p->p_pid : -1, p != NULL ? p->p_comm : "-");
4658
4659 #undef XPTRWIDTH
4660 }
4661
4662 DB_SHOW_COMMAND(file, db_show_file)
4663 {
4664         struct file *fp;
4665
4666         if (!have_addr) {
4667                 db_printf("usage: show file <addr>\n");
4668                 return;
4669         }
4670         fp = (struct file *)addr;
4671         db_print_file(fp, 1);
4672 }
4673
4674 DB_SHOW_COMMAND(files, db_show_files)
4675 {
4676         struct filedesc *fdp;
4677         struct file *fp;
4678         struct proc *p;
4679         int header;
4680         int n;
4681
4682         header = 1;
4683         FOREACH_PROC_IN_SYSTEM(p) {
4684                 if (p->p_state == PRS_NEW)
4685                         continue;
4686                 if ((fdp = p->p_fd) == NULL)
4687                         continue;
4688                 for (n = 0; n < fdp->fd_nfiles; ++n) {
4689                         if ((fp = fdp->fd_ofiles[n].fde_file) == NULL)
4690                                 continue;
4691                         db_print_file(fp, header);
4692                         header = 0;
4693                 }
4694         }
4695 }
4696 #endif
4697
4698 SYSCTL_INT(_kern, KERN_MAXFILESPERPROC, maxfilesperproc, CTLFLAG_RW,
4699     &maxfilesperproc, 0, "Maximum files allowed open per process");
4700
4701 SYSCTL_INT(_kern, KERN_MAXFILES, maxfiles, CTLFLAG_RW,
4702     &maxfiles, 0, "Maximum number of files");
4703
4704 SYSCTL_INT(_kern, OID_AUTO, openfiles, CTLFLAG_RD,
4705     &openfiles, 0, "System-wide number of open files");
4706
4707 /* ARGSUSED*/
4708 static void
4709 filelistinit(void *dummy)
4710 {
4711
4712         file_zone = uma_zcreate("Files", sizeof(struct file), NULL, NULL,
4713             NULL, NULL, UMA_ALIGN_PTR, UMA_ZONE_NOFREE);
4714         filedesc0_zone = uma_zcreate("filedesc0", sizeof(struct filedesc0),
4715             NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
4716         pwd_zone = uma_zcreate("PWD", sizeof(struct pwd), NULL, NULL,
4717             NULL, NULL, UMA_ALIGN_PTR, UMA_ZONE_SMR);
4718         /*
4719          * XXXMJG this is a temporary hack due to boot ordering issues against
4720          * the vnode zone.
4721          */
4722         vfs_smr = uma_zone_get_smr(pwd_zone);
4723         mtx_init(&sigio_lock, "sigio lock", NULL, MTX_DEF);
4724 }
4725 SYSINIT(select, SI_SUB_LOCK, SI_ORDER_FIRST, filelistinit, NULL);
4726
4727 /*-------------------------------------------------------------------*/
4728
4729 static int
4730 badfo_readwrite(struct file *fp, struct uio *uio, struct ucred *active_cred,
4731     int flags, struct thread *td)
4732 {
4733
4734         return (EBADF);
4735 }
4736
4737 static int
4738 badfo_truncate(struct file *fp, off_t length, struct ucred *active_cred,
4739     struct thread *td)
4740 {
4741
4742         return (EINVAL);
4743 }
4744
4745 static int
4746 badfo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
4747     struct thread *td)
4748 {
4749
4750         return (EBADF);
4751 }
4752
4753 static int
4754 badfo_poll(struct file *fp, int events, struct ucred *active_cred,
4755     struct thread *td)
4756 {
4757
4758         return (0);
4759 }
4760
4761 static int
4762 badfo_kqfilter(struct file *fp, struct knote *kn)
4763 {
4764
4765         return (EBADF);
4766 }
4767
4768 static int
4769 badfo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred,
4770     struct thread *td)
4771 {
4772
4773         return (EBADF);
4774 }
4775
4776 static int
4777 badfo_close(struct file *fp, struct thread *td)
4778 {
4779
4780         return (0);
4781 }
4782
4783 static int
4784 badfo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
4785     struct thread *td)
4786 {
4787
4788         return (EBADF);
4789 }
4790
4791 static int
4792 badfo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
4793     struct thread *td)
4794 {
4795
4796         return (EBADF);
4797 }
4798
4799 static int
4800 badfo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio,
4801     struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags,
4802     struct thread *td)
4803 {
4804
4805         return (EBADF);
4806 }
4807
4808 static int
4809 badfo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
4810 {
4811
4812         return (0);
4813 }
4814
4815 struct fileops badfileops = {
4816         .fo_read = badfo_readwrite,
4817         .fo_write = badfo_readwrite,
4818         .fo_truncate = badfo_truncate,
4819         .fo_ioctl = badfo_ioctl,
4820         .fo_poll = badfo_poll,
4821         .fo_kqfilter = badfo_kqfilter,
4822         .fo_stat = badfo_stat,
4823         .fo_close = badfo_close,
4824         .fo_chmod = badfo_chmod,
4825         .fo_chown = badfo_chown,
4826         .fo_sendfile = badfo_sendfile,
4827         .fo_fill_kinfo = badfo_fill_kinfo,
4828 };
4829
4830 int
4831 invfo_rdwr(struct file *fp, struct uio *uio, struct ucred *active_cred,
4832     int flags, struct thread *td)
4833 {
4834
4835         return (EOPNOTSUPP);
4836 }
4837
4838 int
4839 invfo_truncate(struct file *fp, off_t length, struct ucred *active_cred,
4840     struct thread *td)
4841 {
4842
4843         return (EINVAL);
4844 }
4845
4846 int
4847 invfo_ioctl(struct file *fp, u_long com, void *data,
4848     struct ucred *active_cred, struct thread *td)
4849 {
4850
4851         return (ENOTTY);
4852 }
4853
4854 int
4855 invfo_poll(struct file *fp, int events, struct ucred *active_cred,
4856     struct thread *td)
4857 {
4858
4859         return (poll_no_poll(events));
4860 }
4861
4862 int
4863 invfo_kqfilter(struct file *fp, struct knote *kn)
4864 {
4865
4866         return (EINVAL);
4867 }
4868
4869 int
4870 invfo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
4871     struct thread *td)
4872 {
4873
4874         return (EINVAL);
4875 }
4876
4877 int
4878 invfo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
4879     struct thread *td)
4880 {
4881
4882         return (EINVAL);
4883 }
4884
4885 int
4886 invfo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio,
4887     struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags,
4888     struct thread *td)
4889 {
4890
4891         return (EINVAL);
4892 }
4893
4894 /*-------------------------------------------------------------------*/
4895
4896 /*
4897  * File Descriptor pseudo-device driver (/dev/fd/).
4898  *
4899  * Opening minor device N dup()s the file (if any) connected to file
4900  * descriptor N belonging to the calling process.  Note that this driver
4901  * consists of only the ``open()'' routine, because all subsequent
4902  * references to this file will be direct to the other driver.
4903  *
4904  * XXX: we could give this one a cloning event handler if necessary.
4905  */
4906
4907 /* ARGSUSED */
4908 static int
4909 fdopen(struct cdev *dev, int mode, int type, struct thread *td)
4910 {
4911
4912         /*
4913          * XXX Kludge: set curthread->td_dupfd to contain the value of the
4914          * the file descriptor being sought for duplication. The error
4915          * return ensures that the vnode for this device will be released
4916          * by vn_open. Open will detect this special error and take the
4917          * actions in dupfdopen below. Other callers of vn_open or VOP_OPEN
4918          * will simply report the error.
4919          */
4920         td->td_dupfd = dev2unit(dev);
4921         return (ENODEV);
4922 }
4923
4924 static struct cdevsw fildesc_cdevsw = {
4925         .d_version =    D_VERSION,
4926         .d_open =       fdopen,
4927         .d_name =       "FD",
4928 };
4929
4930 static void
4931 fildesc_drvinit(void *unused)
4932 {
4933         struct cdev *dev;
4934
4935         dev = make_dev_credf(MAKEDEV_ETERNAL, &fildesc_cdevsw, 0, NULL,
4936             UID_ROOT, GID_WHEEL, 0666, "fd/0");
4937         make_dev_alias(dev, "stdin");
4938         dev = make_dev_credf(MAKEDEV_ETERNAL, &fildesc_cdevsw, 1, NULL,
4939             UID_ROOT, GID_WHEEL, 0666, "fd/1");
4940         make_dev_alias(dev, "stdout");
4941         dev = make_dev_credf(MAKEDEV_ETERNAL, &fildesc_cdevsw, 2, NULL,
4942             UID_ROOT, GID_WHEEL, 0666, "fd/2");
4943         make_dev_alias(dev, "stderr");
4944 }
4945
4946 SYSINIT(fildescdev, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, fildesc_drvinit, NULL);