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