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