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