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