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