2 * SPDX-License-Identifier: BSD-3-Clause
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.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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
36 * @(#)kern_descrip.c 8.6 (Berkeley) 4/19/94
39 #include <sys/cdefs.h>
40 __FBSDID("$FreeBSD$");
42 #include "opt_capsicum.h"
44 #include "opt_ktrace.h"
46 #include <sys/param.h>
47 #include <sys/systm.h>
49 #include <sys/capsicum.h>
51 #include <sys/fcntl.h>
53 #include <sys/filedesc.h>
54 #include <sys/filio.h>
56 #include <sys/kernel.h>
57 #include <sys/limits.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>
66 #include <sys/protosw.h>
67 #include <sys/racct.h>
68 #include <sys/resourcevar.h>
70 #include <sys/signalvar.h>
74 #include <sys/syscallsubr.h>
75 #include <sys/sysctl.h>
76 #include <sys/sysproto.h>
77 #include <sys/unistd.h>
79 #include <sys/vnode.h>
81 #include <sys/ktrace.h>
86 #include <security/audit/audit.h>
93 static MALLOC_DEFINE(M_FILEDESC, "filedesc", "Open file descriptor table");
94 static MALLOC_DEFINE(M_FILEDESC_TO_LEADER, "filedesc_to_leader",
95 "file desc to leader structures");
96 static MALLOC_DEFINE(M_SIGIO, "sigio", "sigio structures");
97 MALLOC_DEFINE(M_FILECAPS, "filecaps", "descriptor capabilities");
99 MALLOC_DECLARE(M_FADVISE);
101 static __read_mostly uma_zone_t file_zone;
102 static __read_mostly uma_zone_t filedesc0_zone;
104 static int closefp(struct filedesc *fdp, int fd, struct file *fp,
105 struct thread *td, int holdleaders);
106 static int fd_first_free(struct filedesc *fdp, int low, int size);
107 static int fd_last_used(struct filedesc *fdp, int size);
108 static void fdgrowtable(struct filedesc *fdp, int nfd);
109 static void fdgrowtable_exp(struct filedesc *fdp, int nfd);
110 static void fdunused(struct filedesc *fdp, int fd);
111 static void fdused(struct filedesc *fdp, int fd);
112 static int getmaxfd(struct thread *td);
113 static u_long *filecaps_copy_prep(const struct filecaps *src);
114 static void filecaps_copy_finish(const struct filecaps *src,
115 struct filecaps *dst, u_long *ioctls);
116 static u_long *filecaps_free_prep(struct filecaps *fcaps);
117 static void filecaps_free_finish(u_long *ioctls);
122 * - An array of open file descriptors (fd_ofiles)
123 * - An array of file flags (fd_ofileflags)
124 * - A bitmap recording which descriptors are in use (fd_map)
126 * A process starts out with NDFILE descriptors. The value of NDFILE has
127 * been selected based the historical limit of 20 open files, and an
128 * assumption that the majority of processes, especially short-lived
129 * processes like shells, will never need more.
131 * If this initial allocation is exhausted, a larger descriptor table and
132 * map are allocated dynamically, and the pointers in the process's struct
133 * filedesc are updated to point to those. This is repeated every time
134 * the process runs out of file descriptors (provided it hasn't hit its
137 * Since threads may hold references to individual descriptor table
138 * entries, the tables are never freed. Instead, they are placed on a
139 * linked list and freed only when the struct filedesc is released.
142 #define NDSLOTSIZE sizeof(NDSLOTTYPE)
143 #define NDENTRIES (NDSLOTSIZE * __CHAR_BIT)
144 #define NDSLOT(x) ((x) / NDENTRIES)
145 #define NDBIT(x) ((NDSLOTTYPE)1 << ((x) % NDENTRIES))
146 #define NDSLOTS(x) (((x) + NDENTRIES - 1) / NDENTRIES)
149 * SLIST entry used to keep track of ofiles which must be reclaimed when
153 struct fdescenttbl *ft_table;
154 SLIST_ENTRY(freetable) ft_next;
158 * Initial allocation: a filedesc structure + the head of SLIST used to
159 * keep track of old ofiles + enough space for NDFILE descriptors.
162 struct fdescenttbl0 {
164 struct filedescent fdt_ofiles[NDFILE];
168 struct filedesc fd_fd;
169 SLIST_HEAD(, freetable) fd_free;
170 struct fdescenttbl0 fd_dfiles;
171 NDSLOTTYPE fd_dmap[NDSLOTS(NDFILE)];
175 * Descriptor management.
177 volatile int __exclusive_cache_line openfiles; /* actual number of open files */
178 struct mtx sigio_lock; /* mtx to protect pointers to sigio */
179 void __read_mostly (*mq_fdclose)(struct thread *td, int fd, struct file *fp);
182 * If low >= size, just return low. Otherwise find the first zero bit in the
183 * given bitmap, starting at low and not exceeding size - 1. Return size if
187 fd_first_free(struct filedesc *fdp, int low, int size)
189 NDSLOTTYPE *map = fdp->fd_map;
197 if (low % NDENTRIES) {
198 mask = ~(~(NDSLOTTYPE)0 >> (NDENTRIES - (low % NDENTRIES)));
199 if ((mask &= ~map[off]) != 0UL)
200 return (off * NDENTRIES + ffsl(mask) - 1);
203 for (maxoff = NDSLOTS(size); off < maxoff; ++off)
204 if (map[off] != ~0UL)
205 return (off * NDENTRIES + ffsl(~map[off]) - 1);
210 * Find the highest non-zero bit in the given bitmap, starting at 0 and
211 * not exceeding size - 1. Return -1 if not found.
214 fd_last_used(struct filedesc *fdp, int size)
216 NDSLOTTYPE *map = fdp->fd_map;
221 if (size % NDENTRIES) {
222 mask = ~(~(NDSLOTTYPE)0 << (size % NDENTRIES));
223 if ((mask &= map[off]) != 0)
224 return (off * NDENTRIES + flsl(mask) - 1);
227 for (minoff = NDSLOT(0); off >= minoff; --off)
229 return (off * NDENTRIES + flsl(map[off]) - 1);
234 fdisused(struct filedesc *fdp, int fd)
237 KASSERT(fd >= 0 && fd < fdp->fd_nfiles,
238 ("file descriptor %d out of range (0, %d)", fd, fdp->fd_nfiles));
240 return ((fdp->fd_map[NDSLOT(fd)] & NDBIT(fd)) != 0);
244 * Mark a file descriptor as used.
247 fdused_init(struct filedesc *fdp, int fd)
250 KASSERT(!fdisused(fdp, fd), ("fd=%d is already used", fd));
252 fdp->fd_map[NDSLOT(fd)] |= NDBIT(fd);
256 fdused(struct filedesc *fdp, int fd)
259 FILEDESC_XLOCK_ASSERT(fdp);
261 fdused_init(fdp, fd);
262 if (fd > fdp->fd_lastfile)
263 fdp->fd_lastfile = fd;
264 if (fd == fdp->fd_freefile)
269 * Mark a file descriptor as unused.
272 fdunused(struct filedesc *fdp, int fd)
275 FILEDESC_XLOCK_ASSERT(fdp);
277 KASSERT(fdisused(fdp, fd), ("fd=%d is already unused", fd));
278 KASSERT(fdp->fd_ofiles[fd].fde_file == NULL,
279 ("fd=%d is still in use", fd));
281 fdp->fd_map[NDSLOT(fd)] &= ~NDBIT(fd);
282 if (fd < fdp->fd_freefile)
283 fdp->fd_freefile = fd;
284 if (fd == fdp->fd_lastfile)
285 fdp->fd_lastfile = fd_last_used(fdp, fd);
289 * Free a file descriptor.
291 * Avoid some work if fdp is about to be destroyed.
294 fdefree_last(struct filedescent *fde)
297 filecaps_free(&fde->fde_caps);
301 fdfree(struct filedesc *fdp, int fd)
303 struct filedescent *fde;
305 fde = &fdp->fd_ofiles[fd];
307 seq_write_begin(&fde->fde_seq);
309 fde->fde_file = NULL;
311 seq_write_end(&fde->fde_seq);
318 pwd_ensure_dirs(void)
320 struct filedesc *fdp;
324 if (fdp->fd_cdir == NULL) {
325 fdp->fd_cdir = rootvnode;
328 if (fdp->fd_rdir == NULL) {
329 fdp->fd_rdir = rootvnode;
332 FILEDESC_XUNLOCK(fdp);
336 * System calls on descriptors.
338 #ifndef _SYS_SYSPROTO_H_
339 struct getdtablesize_args {
345 sys_getdtablesize(struct thread *td, struct getdtablesize_args *uap)
352 min((int)lim_cur(td, RLIMIT_NOFILE), maxfilesperproc);
354 PROC_LOCK(td->td_proc);
355 lim = racct_get_limit(td->td_proc, RACCT_NOFILE);
356 PROC_UNLOCK(td->td_proc);
357 if (lim < td->td_retval[0])
358 td->td_retval[0] = lim;
364 * Duplicate a file descriptor to a particular value.
366 * Note: keep in mind that a potential race condition exists when closing
367 * descriptors from a shared descriptor table (via rfork).
369 #ifndef _SYS_SYSPROTO_H_
377 sys_dup2(struct thread *td, struct dup2_args *uap)
380 return (kern_dup(td, FDDUP_FIXED, 0, (int)uap->from, (int)uap->to));
384 * Duplicate a file descriptor.
386 #ifndef _SYS_SYSPROTO_H_
393 sys_dup(struct thread *td, struct dup_args *uap)
396 return (kern_dup(td, FDDUP_NORMAL, 0, (int)uap->fd, 0));
400 * The file control system call.
402 #ifndef _SYS_SYSPROTO_H_
411 sys_fcntl(struct thread *td, struct fcntl_args *uap)
414 return (kern_fcntl_freebsd(td, uap->fd, uap->cmd, uap->arg));
418 kern_fcntl_freebsd(struct thread *td, int fd, int cmd, long arg)
432 * Convert old flock structure to new.
434 error = copyin((void *)(intptr_t)arg, &ofl, sizeof(ofl));
435 fl.l_start = ofl.l_start;
436 fl.l_len = ofl.l_len;
437 fl.l_pid = ofl.l_pid;
438 fl.l_type = ofl.l_type;
439 fl.l_whence = ofl.l_whence;
453 arg1 = (intptr_t)&fl;
459 error = copyin((void *)(intptr_t)arg, &fl, sizeof(fl));
460 arg1 = (intptr_t)&fl;
468 error = kern_fcntl(td, fd, newcmd, arg1);
471 if (cmd == F_OGETLK) {
472 ofl.l_start = fl.l_start;
473 ofl.l_len = fl.l_len;
474 ofl.l_pid = fl.l_pid;
475 ofl.l_type = fl.l_type;
476 ofl.l_whence = fl.l_whence;
477 error = copyout(&ofl, (void *)(intptr_t)arg, sizeof(ofl));
478 } else if (cmd == F_GETLK) {
479 error = copyout(&fl, (void *)(intptr_t)arg, sizeof(fl));
485 kern_fcntl(struct thread *td, int fd, int cmd, intptr_t arg)
487 struct filedesc *fdp;
489 struct file *fp, *fp2;
490 struct filedescent *fde;
507 error = kern_dup(td, FDDUP_FCNTL, 0, fd, tmp);
510 case F_DUPFD_CLOEXEC:
512 error = kern_dup(td, FDDUP_FCNTL, FDDUP_FLAG_CLOEXEC, fd, tmp);
517 error = kern_dup(td, FDDUP_FIXED, 0, fd, tmp);
520 case F_DUP2FD_CLOEXEC:
522 error = kern_dup(td, FDDUP_FIXED, FDDUP_FLAG_CLOEXEC, fd, tmp);
528 fde = fdeget_locked(fdp, fd);
531 (fde->fde_flags & UF_EXCLOSE) ? FD_CLOEXEC : 0;
534 FILEDESC_SUNLOCK(fdp);
540 fde = fdeget_locked(fdp, fd);
542 fde->fde_flags = (fde->fde_flags & ~UF_EXCLOSE) |
543 (arg & FD_CLOEXEC ? UF_EXCLOSE : 0);
546 FILEDESC_XUNLOCK(fdp);
550 error = fget_fcntl(td, fd, &cap_fcntl_rights, F_GETFL, &fp);
553 td->td_retval[0] = OFLAGS(fp->f_flag);
558 error = fget_fcntl(td, fd, &cap_fcntl_rights, F_SETFL, &fp);
562 tmp = flg = fp->f_flag;
564 tmp |= FFLAGS(arg & ~O_ACCMODE) & FCNTLFLAGS;
565 } while(atomic_cmpset_int(&fp->f_flag, flg, tmp) == 0);
566 tmp = fp->f_flag & FNONBLOCK;
567 error = fo_ioctl(fp, FIONBIO, &tmp, td->td_ucred, td);
572 tmp = fp->f_flag & FASYNC;
573 error = fo_ioctl(fp, FIOASYNC, &tmp, td->td_ucred, td);
578 atomic_clear_int(&fp->f_flag, FNONBLOCK);
580 (void)fo_ioctl(fp, FIONBIO, &tmp, td->td_ucred, td);
585 error = fget_fcntl(td, fd, &cap_fcntl_rights, F_GETOWN, &fp);
588 error = fo_ioctl(fp, FIOGETOWN, &tmp, td->td_ucred, td);
590 td->td_retval[0] = tmp;
595 error = fget_fcntl(td, fd, &cap_fcntl_rights, F_SETOWN, &fp);
599 error = fo_ioctl(fp, FIOSETOWN, &tmp, td->td_ucred, td);
604 error = priv_check(td, PRIV_NFS_LOCKD);
612 /* FALLTHROUGH F_SETLK */
616 error = fget_unlocked(fdp, fd, &cap_flock_rights, &fp, NULL);
619 if (fp->f_type != DTYPE_VNODE) {
625 flp = (struct flock *)arg;
626 if (flp->l_whence == SEEK_CUR) {
627 foffset = foffset_get(fp);
630 foffset > OFF_MAX - flp->l_start)) {
635 flp->l_start += foffset;
639 switch (flp->l_type) {
641 if ((fp->f_flag & FREAD) == 0) {
645 if ((p->p_leader->p_flag & P_ADVLOCK) == 0) {
646 PROC_LOCK(p->p_leader);
647 p->p_leader->p_flag |= P_ADVLOCK;
648 PROC_UNLOCK(p->p_leader);
650 error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader, F_SETLK,
654 if ((fp->f_flag & FWRITE) == 0) {
658 if ((p->p_leader->p_flag & P_ADVLOCK) == 0) {
659 PROC_LOCK(p->p_leader);
660 p->p_leader->p_flag |= P_ADVLOCK;
661 PROC_UNLOCK(p->p_leader);
663 error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader, F_SETLK,
667 error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader, F_UNLCK,
672 * Temporary api for testing remote lock
675 if (flg != F_REMOTE) {
679 error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader,
680 F_UNLCKSYS, flp, flg);
686 if (error != 0 || flp->l_type == F_UNLCK ||
687 flp->l_type == F_UNLCKSYS) {
693 * Check for a race with close.
695 * The vnode is now advisory locked (or unlocked, but this case
696 * is not really important) as the caller requested.
697 * We had to drop the filedesc lock, so we need to recheck if
698 * the descriptor is still valid, because if it was closed
699 * in the meantime we need to remove advisory lock from the
700 * vnode - close on any descriptor leading to an advisory
701 * locked vnode, removes that lock.
702 * We will return 0 on purpose in that case, as the result of
703 * successful advisory lock might have been externally visible
704 * already. This is fine - effectively we pretend to the caller
705 * that the closing thread was a bit slower and that the
706 * advisory lock succeeded before the close.
708 error = fget_unlocked(fdp, fd, &cap_no_rights, &fp2, NULL);
714 flp->l_whence = SEEK_SET;
717 flp->l_type = F_UNLCK;
718 (void) VOP_ADVLOCK(vp, (caddr_t)p->p_leader,
719 F_UNLCK, flp, F_POSIX);
726 error = fget_unlocked(fdp, fd, &cap_flock_rights, &fp, NULL);
729 if (fp->f_type != DTYPE_VNODE) {
734 flp = (struct flock *)arg;
735 if (flp->l_type != F_RDLCK && flp->l_type != F_WRLCK &&
736 flp->l_type != F_UNLCK) {
741 if (flp->l_whence == SEEK_CUR) {
742 foffset = foffset_get(fp);
743 if ((flp->l_start > 0 &&
744 foffset > OFF_MAX - flp->l_start) ||
746 foffset < OFF_MIN - flp->l_start)) {
751 flp->l_start += foffset;
754 error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader, F_GETLK, flp,
760 arg = arg ? 128 * 1024: 0;
763 error = fget_unlocked(fdp, fd, &cap_no_rights, &fp, NULL);
766 if (fp->f_type != DTYPE_VNODE) {
773 * Exclusive lock synchronizes against f_seqcount reads and
774 * writes in sequential_heuristic().
776 error = vn_lock(vp, LK_EXCLUSIVE);
782 bsize = fp->f_vnode->v_mount->mnt_stat.f_iosize;
783 fp->f_seqcount = (arg + bsize - 1) / bsize;
784 atomic_set_int(&fp->f_flag, FRDAHEAD);
786 atomic_clear_int(&fp->f_flag, FRDAHEAD);
800 getmaxfd(struct thread *td)
803 return (min((int)lim_cur(td, RLIMIT_NOFILE), maxfilesperproc));
807 * Common code for dup, dup2, fcntl(F_DUPFD) and fcntl(F_DUP2FD).
810 kern_dup(struct thread *td, u_int mode, int flags, int old, int new)
812 struct filedesc *fdp;
813 struct filedescent *oldfde, *newfde;
816 u_long *oioctls, *nioctls;
823 MPASS((flags & ~(FDDUP_FLAG_CLOEXEC)) == 0);
824 MPASS(mode < FDDUP_LASTMODE);
827 /* XXXRW: if (flags & FDDUP_FIXED) AUDIT_ARG_FD2(new); */
830 * Verify we have a valid descriptor to dup from and possibly to
831 * dup to. Unlike dup() and dup2(), fcntl()'s F_DUPFD should
832 * return EINVAL when the new descriptor is out of bounds.
837 return (mode == FDDUP_FCNTL ? EINVAL : EBADF);
838 maxfd = getmaxfd(td);
840 return (mode == FDDUP_FCNTL ? EINVAL : EBADF);
844 if (fget_locked(fdp, old) == NULL)
846 if ((mode == FDDUP_FIXED || mode == FDDUP_MUSTREPLACE) && old == new) {
847 td->td_retval[0] = new;
848 if (flags & FDDUP_FLAG_CLOEXEC)
849 fdp->fd_ofiles[new].fde_flags |= UF_EXCLOSE;
855 * If the caller specified a file descriptor, make sure the file
856 * table is large enough to hold it, and grab it. Otherwise, just
857 * allocate a new descriptor the usual way.
862 if ((error = fdalloc(td, new, &new)) != 0)
865 case FDDUP_MUSTREPLACE:
866 /* Target file descriptor must exist. */
867 if (fget_locked(fdp, new) == NULL)
871 if (new >= fdp->fd_nfiles) {
873 * The resource limits are here instead of e.g.
874 * fdalloc(), because the file descriptor table may be
875 * shared between processes, so we can't really use
876 * racct_add()/racct_sub(). Instead of counting the
877 * number of actually allocated descriptors, just put
878 * the limit on the size of the file descriptor table.
881 if (RACCT_ENABLED()) {
882 error = racct_set_unlocked(p, RACCT_NOFILE, new + 1);
889 fdgrowtable_exp(fdp, new + 1);
891 if (!fdisused(fdp, new))
895 KASSERT(0, ("%s unsupported mode %d", __func__, mode));
898 KASSERT(old != new, ("new fd is same as old"));
900 oldfde = &fdp->fd_ofiles[old];
901 fhold(oldfde->fde_file);
902 newfde = &fdp->fd_ofiles[new];
903 delfp = newfde->fde_file;
905 oioctls = filecaps_free_prep(&newfde->fde_caps);
906 nioctls = filecaps_copy_prep(&oldfde->fde_caps);
909 * Duplicate the source descriptor.
912 seq_write_begin(&newfde->fde_seq);
914 memcpy(newfde, oldfde, fde_change_size);
915 filecaps_copy_finish(&oldfde->fde_caps, &newfde->fde_caps,
917 if ((flags & FDDUP_FLAG_CLOEXEC) != 0)
918 newfde->fde_flags = oldfde->fde_flags | UF_EXCLOSE;
920 newfde->fde_flags = oldfde->fde_flags & ~UF_EXCLOSE;
922 seq_write_end(&newfde->fde_seq);
924 td->td_retval[0] = new;
929 (void) closefp(fdp, new, delfp, td, 1);
930 FILEDESC_UNLOCK_ASSERT(fdp);
933 FILEDESC_XUNLOCK(fdp);
936 filecaps_free_finish(oioctls);
941 * If sigio is on the list associated with a process or process group,
942 * disable signalling from the device, remove sigio from the list and
946 funsetown(struct sigio **sigiop)
958 *(sigio->sio_myref) = NULL;
959 if ((sigio)->sio_pgid < 0) {
960 struct pgrp *pg = (sigio)->sio_pgrp;
962 SLIST_REMOVE(&sigio->sio_pgrp->pg_sigiolst, sigio,
966 struct proc *p = (sigio)->sio_proc;
968 SLIST_REMOVE(&sigio->sio_proc->p_sigiolst, sigio,
973 crfree(sigio->sio_ucred);
974 free(sigio, M_SIGIO);
978 * Free a list of sigio structures.
979 * We only need to lock the SIGIO_LOCK because we have made ourselves
980 * inaccessible to callers of fsetown and therefore do not need to lock
981 * the proc or pgrp struct for the list manipulation.
984 funsetownlst(struct sigiolst *sigiolst)
990 sigio = SLIST_FIRST(sigiolst);
997 * Every entry of the list should belong
998 * to a single proc or pgrp.
1000 if (sigio->sio_pgid < 0) {
1001 pg = sigio->sio_pgrp;
1002 PGRP_LOCK_ASSERT(pg, MA_NOTOWNED);
1003 } else /* if (sigio->sio_pgid > 0) */ {
1004 p = sigio->sio_proc;
1005 PROC_LOCK_ASSERT(p, MA_NOTOWNED);
1009 while ((sigio = SLIST_FIRST(sigiolst)) != NULL) {
1010 *(sigio->sio_myref) = NULL;
1012 KASSERT(sigio->sio_pgid < 0,
1013 ("Proc sigio in pgrp sigio list"));
1014 KASSERT(sigio->sio_pgrp == pg,
1015 ("Bogus pgrp in sigio list"));
1017 SLIST_REMOVE(&pg->pg_sigiolst, sigio, sigio,
1020 } else /* if (p != NULL) */ {
1021 KASSERT(sigio->sio_pgid > 0,
1022 ("Pgrp sigio in proc sigio list"));
1023 KASSERT(sigio->sio_proc == p,
1024 ("Bogus proc in sigio list"));
1026 SLIST_REMOVE(&p->p_sigiolst, sigio, sigio,
1031 crfree(sigio->sio_ucred);
1032 free(sigio, M_SIGIO);
1039 * This is common code for FIOSETOWN ioctl called by fcntl(fd, F_SETOWN, arg).
1041 * After permission checking, add a sigio structure to the sigio list for
1042 * the process or process group.
1045 fsetown(pid_t pgid, struct sigio **sigiop)
1049 struct sigio *sigio;
1059 /* Allocate and fill in the new sigio out of locks. */
1060 sigio = malloc(sizeof(struct sigio), M_SIGIO, M_WAITOK);
1061 sigio->sio_pgid = pgid;
1062 sigio->sio_ucred = crhold(curthread->td_ucred);
1063 sigio->sio_myref = sigiop;
1065 sx_slock(&proctree_lock);
1074 * Policy - Don't allow a process to FSETOWN a process
1075 * in another session.
1077 * Remove this test to allow maximum flexibility or
1078 * restrict FSETOWN to the current process or process
1079 * group for maximum safety.
1082 if (proc->p_session != curthread->td_proc->p_session) {
1088 } else /* if (pgid < 0) */ {
1089 pgrp = pgfind(-pgid);
1097 * Policy - Don't allow a process to FSETOWN a process
1098 * in another session.
1100 * Remove this test to allow maximum flexibility or
1101 * restrict FSETOWN to the current process or process
1102 * group for maximum safety.
1104 if (pgrp->pg_session != curthread->td_proc->p_session) {
1115 * Since funsetownlst() is called without the proctree
1116 * locked, we need to check for P_WEXIT.
1117 * XXX: is ESRCH correct?
1119 if ((proc->p_flag & P_WEXIT) != 0) {
1124 SLIST_INSERT_HEAD(&proc->p_sigiolst, sigio, sio_pgsigio);
1125 sigio->sio_proc = proc;
1129 SLIST_INSERT_HEAD(&pgrp->pg_sigiolst, sigio, sio_pgsigio);
1130 sigio->sio_pgrp = pgrp;
1133 sx_sunlock(&proctree_lock);
1140 sx_sunlock(&proctree_lock);
1141 crfree(sigio->sio_ucred);
1142 free(sigio, M_SIGIO);
1147 * This is common code for FIOGETOWN ioctl called by fcntl(fd, F_GETOWN, arg).
1150 fgetown(struct sigio **sigiop)
1155 pgid = (*sigiop != NULL) ? (*sigiop)->sio_pgid : 0;
1161 * Function drops the filedesc lock on return.
1164 closefp(struct filedesc *fdp, int fd, struct file *fp, struct thread *td,
1169 FILEDESC_XLOCK_ASSERT(fdp);
1172 if (td->td_proc->p_fdtol != NULL) {
1174 * Ask fdfree() to sleep to ensure that all relevant
1175 * process leaders can be traversed in closef().
1177 fdp->fd_holdleaderscount++;
1184 * We now hold the fp reference that used to be owned by the
1185 * descriptor array. We have to unlock the FILEDESC *AFTER*
1186 * knote_fdclose to prevent a race of the fd getting opened, a knote
1187 * added, and deleteing a knote for the new fd.
1189 if (__predict_false(!TAILQ_EMPTY(&fdp->fd_kqlist)))
1190 knote_fdclose(td, fd);
1193 * We need to notify mqueue if the object is of type mqueue.
1195 if (__predict_false(fp->f_type == DTYPE_MQUEUE))
1196 mq_fdclose(td, fd, fp);
1197 FILEDESC_XUNLOCK(fdp);
1199 error = closef(fp, td);
1201 FILEDESC_XLOCK(fdp);
1202 fdp->fd_holdleaderscount--;
1203 if (fdp->fd_holdleaderscount == 0 &&
1204 fdp->fd_holdleaderswakeup != 0) {
1205 fdp->fd_holdleaderswakeup = 0;
1206 wakeup(&fdp->fd_holdleaderscount);
1208 FILEDESC_XUNLOCK(fdp);
1214 * Close a file descriptor.
1216 #ifndef _SYS_SYSPROTO_H_
1223 sys_close(struct thread *td, struct close_args *uap)
1226 return (kern_close(td, uap->fd));
1230 kern_close(struct thread *td, int fd)
1232 struct filedesc *fdp;
1235 fdp = td->td_proc->p_fd;
1237 AUDIT_SYSCLOSE(td, fd);
1239 FILEDESC_XLOCK(fdp);
1240 if ((fp = fget_locked(fdp, fd)) == NULL) {
1241 FILEDESC_XUNLOCK(fdp);
1246 /* closefp() drops the FILEDESC lock for us. */
1247 return (closefp(fdp, fd, fp, td, 1));
1251 * Close open file descriptors.
1253 #ifndef _SYS_SYSPROTO_H_
1254 struct closefrom_args {
1260 sys_closefrom(struct thread *td, struct closefrom_args *uap)
1262 struct filedesc *fdp;
1265 fdp = td->td_proc->p_fd;
1266 AUDIT_ARG_FD(uap->lowfd);
1269 * Treat negative starting file descriptor values identical to
1270 * closefrom(0) which closes all files.
1274 FILEDESC_SLOCK(fdp);
1275 for (fd = uap->lowfd; fd <= fdp->fd_lastfile; fd++) {
1276 if (fdp->fd_ofiles[fd].fde_file != NULL) {
1277 FILEDESC_SUNLOCK(fdp);
1278 (void)kern_close(td, fd);
1279 FILEDESC_SLOCK(fdp);
1282 FILEDESC_SUNLOCK(fdp);
1286 #if defined(COMPAT_43)
1288 * Return status information about a file descriptor.
1290 #ifndef _SYS_SYSPROTO_H_
1291 struct ofstat_args {
1298 ofstat(struct thread *td, struct ofstat_args *uap)
1304 error = kern_fstat(td, uap->fd, &ub);
1307 error = copyout(&oub, uap->sb, sizeof(oub));
1311 #endif /* COMPAT_43 */
1313 #if defined(COMPAT_FREEBSD11)
1315 freebsd11_fstat(struct thread *td, struct freebsd11_fstat_args *uap)
1318 struct freebsd11_stat osb;
1321 error = kern_fstat(td, uap->fd, &sb);
1324 error = freebsd11_cvtstat(&sb, &osb);
1326 error = copyout(&osb, uap->sb, sizeof(osb));
1329 #endif /* COMPAT_FREEBSD11 */
1332 * Return status information about a file descriptor.
1334 #ifndef _SYS_SYSPROTO_H_
1342 sys_fstat(struct thread *td, struct fstat_args *uap)
1347 error = kern_fstat(td, uap->fd, &ub);
1349 error = copyout(&ub, uap->sb, sizeof(ub));
1354 kern_fstat(struct thread *td, int fd, struct stat *sbp)
1361 error = fget(td, fd, &cap_fstat_rights, &fp);
1365 AUDIT_ARG_FILE(td->td_proc, fp);
1367 error = fo_stat(fp, sbp, td->td_ucred, td);
1369 #ifdef __STAT_TIME_T_EXT
1371 sbp->st_atim_ext = 0;
1372 sbp->st_mtim_ext = 0;
1373 sbp->st_ctim_ext = 0;
1374 sbp->st_btim_ext = 0;
1378 if (error == 0 && KTRPOINT(td, KTR_STRUCT))
1384 #if defined(COMPAT_FREEBSD11)
1386 * Return status information about a file descriptor.
1388 #ifndef _SYS_SYSPROTO_H_
1389 struct freebsd11_nfstat_args {
1396 freebsd11_nfstat(struct thread *td, struct freebsd11_nfstat_args *uap)
1402 error = kern_fstat(td, uap->fd, &ub);
1404 freebsd11_cvtnstat(&ub, &nub);
1405 error = copyout(&nub, uap->sb, sizeof(nub));
1409 #endif /* COMPAT_FREEBSD11 */
1412 * Return pathconf information about a file descriptor.
1414 #ifndef _SYS_SYSPROTO_H_
1415 struct fpathconf_args {
1422 sys_fpathconf(struct thread *td, struct fpathconf_args *uap)
1427 error = kern_fpathconf(td, uap->fd, uap->name, &value);
1429 td->td_retval[0] = value;
1434 kern_fpathconf(struct thread *td, int fd, int name, long *valuep)
1440 error = fget(td, fd, &cap_fpathconf_rights, &fp);
1444 if (name == _PC_ASYNC_IO) {
1445 *valuep = _POSIX_ASYNCHRONOUS_IO;
1450 vn_lock(vp, LK_SHARED | LK_RETRY);
1451 error = VOP_PATHCONF(vp, name, valuep);
1453 } else if (fp->f_type == DTYPE_PIPE || fp->f_type == DTYPE_SOCKET) {
1454 if (name != _PC_PIPE_BUF) {
1469 * Initialize filecaps structure.
1472 filecaps_init(struct filecaps *fcaps)
1475 bzero(fcaps, sizeof(*fcaps));
1476 fcaps->fc_nioctls = -1;
1480 * Copy filecaps structure allocating memory for ioctls array if needed.
1482 * The last parameter indicates whether the fdtable is locked. If it is not and
1483 * ioctls are encountered, copying fails and the caller must lock the table.
1485 * Note that if the table was not locked, the caller has to check the relevant
1486 * sequence counter to determine whether the operation was successful.
1489 filecaps_copy(const struct filecaps *src, struct filecaps *dst, bool locked)
1493 if (src->fc_ioctls != NULL && !locked)
1495 memcpy(dst, src, sizeof(*src));
1496 if (src->fc_ioctls == NULL)
1499 KASSERT(src->fc_nioctls > 0,
1500 ("fc_ioctls != NULL, but fc_nioctls=%hd", src->fc_nioctls));
1502 size = sizeof(src->fc_ioctls[0]) * src->fc_nioctls;
1503 dst->fc_ioctls = malloc(size, M_FILECAPS, M_WAITOK);
1504 memcpy(dst->fc_ioctls, src->fc_ioctls, size);
1509 filecaps_copy_prep(const struct filecaps *src)
1514 if (__predict_true(src->fc_ioctls == NULL))
1517 KASSERT(src->fc_nioctls > 0,
1518 ("fc_ioctls != NULL, but fc_nioctls=%hd", src->fc_nioctls));
1520 size = sizeof(src->fc_ioctls[0]) * src->fc_nioctls;
1521 ioctls = malloc(size, M_FILECAPS, M_WAITOK);
1526 filecaps_copy_finish(const struct filecaps *src, struct filecaps *dst,
1532 if (__predict_true(src->fc_ioctls == NULL)) {
1533 MPASS(ioctls == NULL);
1537 size = sizeof(src->fc_ioctls[0]) * src->fc_nioctls;
1538 dst->fc_ioctls = ioctls;
1539 bcopy(src->fc_ioctls, dst->fc_ioctls, size);
1543 * Move filecaps structure to the new place and clear the old place.
1546 filecaps_move(struct filecaps *src, struct filecaps *dst)
1550 bzero(src, sizeof(*src));
1554 * Fill the given filecaps structure with full rights.
1557 filecaps_fill(struct filecaps *fcaps)
1560 CAP_ALL(&fcaps->fc_rights);
1561 fcaps->fc_ioctls = NULL;
1562 fcaps->fc_nioctls = -1;
1563 fcaps->fc_fcntls = CAP_FCNTL_ALL;
1567 * Free memory allocated within filecaps structure.
1570 filecaps_free(struct filecaps *fcaps)
1573 free(fcaps->fc_ioctls, M_FILECAPS);
1574 bzero(fcaps, sizeof(*fcaps));
1578 filecaps_free_prep(struct filecaps *fcaps)
1582 ioctls = fcaps->fc_ioctls;
1583 bzero(fcaps, sizeof(*fcaps));
1588 filecaps_free_finish(u_long *ioctls)
1591 free(ioctls, M_FILECAPS);
1595 * Validate the given filecaps structure.
1598 filecaps_validate(const struct filecaps *fcaps, const char *func)
1601 KASSERT(cap_rights_is_valid(&fcaps->fc_rights),
1602 ("%s: invalid rights", func));
1603 KASSERT((fcaps->fc_fcntls & ~CAP_FCNTL_ALL) == 0,
1604 ("%s: invalid fcntls", func));
1605 KASSERT(fcaps->fc_fcntls == 0 ||
1606 cap_rights_is_set(&fcaps->fc_rights, CAP_FCNTL),
1607 ("%s: fcntls without CAP_FCNTL", func));
1608 KASSERT(fcaps->fc_ioctls != NULL ? fcaps->fc_nioctls > 0 :
1609 (fcaps->fc_nioctls == -1 || fcaps->fc_nioctls == 0),
1610 ("%s: invalid ioctls", func));
1611 KASSERT(fcaps->fc_nioctls == 0 ||
1612 cap_rights_is_set(&fcaps->fc_rights, CAP_IOCTL),
1613 ("%s: ioctls without CAP_IOCTL", func));
1617 fdgrowtable_exp(struct filedesc *fdp, int nfd)
1621 FILEDESC_XLOCK_ASSERT(fdp);
1623 nfd1 = fdp->fd_nfiles * 2;
1626 fdgrowtable(fdp, nfd1);
1630 * Grow the file table to accommodate (at least) nfd descriptors.
1633 fdgrowtable(struct filedesc *fdp, int nfd)
1635 struct filedesc0 *fdp0;
1636 struct freetable *ft;
1637 struct fdescenttbl *ntable;
1638 struct fdescenttbl *otable;
1639 int nnfiles, onfiles;
1640 NDSLOTTYPE *nmap, *omap;
1643 * If lastfile is -1 this struct filedesc was just allocated and we are
1644 * growing it to accommodate for the one we are going to copy from. There
1645 * is no need to have a lock on this one as it's not visible to anyone.
1647 if (fdp->fd_lastfile != -1)
1648 FILEDESC_XLOCK_ASSERT(fdp);
1650 KASSERT(fdp->fd_nfiles > 0, ("zero-length file table"));
1652 /* save old values */
1653 onfiles = fdp->fd_nfiles;
1654 otable = fdp->fd_files;
1657 /* compute the size of the new table */
1658 nnfiles = NDSLOTS(nfd) * NDENTRIES; /* round up */
1659 if (nnfiles <= onfiles)
1660 /* the table is already large enough */
1664 * Allocate a new table. We need enough space for the number of
1665 * entries, file entries themselves and the struct freetable we will use
1666 * when we decommission the table and place it on the freelist.
1667 * We place the struct freetable in the middle so we don't have
1668 * to worry about padding.
1670 ntable = malloc(offsetof(struct fdescenttbl, fdt_ofiles) +
1671 nnfiles * sizeof(ntable->fdt_ofiles[0]) +
1672 sizeof(struct freetable),
1673 M_FILEDESC, M_ZERO | M_WAITOK);
1674 /* copy the old data */
1675 ntable->fdt_nfiles = nnfiles;
1676 memcpy(ntable->fdt_ofiles, otable->fdt_ofiles,
1677 onfiles * sizeof(ntable->fdt_ofiles[0]));
1680 * Allocate a new map only if the old is not large enough. It will
1681 * grow at a slower rate than the table as it can map more
1682 * entries than the table can hold.
1684 if (NDSLOTS(nnfiles) > NDSLOTS(onfiles)) {
1685 nmap = malloc(NDSLOTS(nnfiles) * NDSLOTSIZE, M_FILEDESC,
1687 /* copy over the old data and update the pointer */
1688 memcpy(nmap, omap, NDSLOTS(onfiles) * sizeof(*omap));
1693 * Make sure that ntable is correctly initialized before we replace
1694 * fd_files poiner. Otherwise fget_unlocked() may see inconsistent
1697 atomic_store_rel_ptr((volatile void *)&fdp->fd_files, (uintptr_t)ntable);
1700 * Do not free the old file table, as some threads may still
1701 * reference entries within it. Instead, place it on a freelist
1702 * which will be processed when the struct filedesc is released.
1704 * Note that if onfiles == NDFILE, we're dealing with the original
1705 * static allocation contained within (struct filedesc0 *)fdp,
1706 * which must not be freed.
1708 if (onfiles > NDFILE) {
1709 ft = (struct freetable *)&otable->fdt_ofiles[onfiles];
1710 fdp0 = (struct filedesc0 *)fdp;
1711 ft->ft_table = otable;
1712 SLIST_INSERT_HEAD(&fdp0->fd_free, ft, ft_next);
1715 * The map does not have the same possibility of threads still
1716 * holding references to it. So always free it as long as it
1717 * does not reference the original static allocation.
1719 if (NDSLOTS(onfiles) > NDSLOTS(NDFILE))
1720 free(omap, M_FILEDESC);
1724 * Allocate a file descriptor for the process.
1727 fdalloc(struct thread *td, int minfd, int *result)
1729 struct proc *p = td->td_proc;
1730 struct filedesc *fdp = p->p_fd;
1731 int fd, maxfd, allocfd;
1736 FILEDESC_XLOCK_ASSERT(fdp);
1738 if (fdp->fd_freefile > minfd)
1739 minfd = fdp->fd_freefile;
1741 maxfd = getmaxfd(td);
1744 * Search the bitmap for a free descriptor starting at minfd.
1745 * If none is found, grow the file table.
1747 fd = fd_first_free(fdp, minfd, fdp->fd_nfiles);
1750 if (fd >= fdp->fd_nfiles) {
1751 allocfd = min(fd * 2, maxfd);
1753 if (RACCT_ENABLED()) {
1754 error = racct_set_unlocked(p, RACCT_NOFILE, allocfd);
1760 * fd is already equal to first free descriptor >= minfd, so
1761 * we only need to grow the table and we are done.
1763 fdgrowtable_exp(fdp, allocfd);
1767 * Perform some sanity checks, then mark the file descriptor as
1768 * used and return it to the caller.
1770 KASSERT(fd >= 0 && fd < min(maxfd, fdp->fd_nfiles),
1771 ("invalid descriptor %d", fd));
1772 KASSERT(!fdisused(fdp, fd),
1773 ("fd_first_free() returned non-free descriptor"));
1774 KASSERT(fdp->fd_ofiles[fd].fde_file == NULL,
1775 ("file descriptor isn't free"));
1782 * Allocate n file descriptors for the process.
1785 fdallocn(struct thread *td, int minfd, int *fds, int n)
1787 struct proc *p = td->td_proc;
1788 struct filedesc *fdp = p->p_fd;
1791 FILEDESC_XLOCK_ASSERT(fdp);
1793 for (i = 0; i < n; i++)
1794 if (fdalloc(td, 0, &fds[i]) != 0)
1798 for (i--; i >= 0; i--)
1799 fdunused(fdp, fds[i]);
1807 * Create a new open file structure and allocate a file descriptor for the
1808 * process that refers to it. We add one reference to the file for the
1809 * descriptor table and one reference for resultfp. This is to prevent us
1810 * being preempted and the entry in the descriptor table closed after we
1811 * release the FILEDESC lock.
1814 falloc_caps(struct thread *td, struct file **resultfp, int *resultfd, int flags,
1815 struct filecaps *fcaps)
1820 error = falloc_noinstall(td, &fp);
1822 return (error); /* no reference held on error */
1824 error = finstall(td, fp, &fd, flags, fcaps);
1826 fdrop(fp, td); /* one reference (fp only) */
1830 if (resultfp != NULL)
1831 *resultfp = fp; /* copy out result */
1833 fdrop(fp, td); /* release local reference */
1835 if (resultfd != NULL)
1842 * Create a new open file structure without allocating a file descriptor.
1845 falloc_noinstall(struct thread *td, struct file **resultfp)
1848 int maxuserfiles = maxfiles - (maxfiles / 20);
1850 static struct timeval lastfail;
1853 KASSERT(resultfp != NULL, ("%s: resultfp == NULL", __func__));
1855 openfiles_new = atomic_fetchadd_int(&openfiles, 1) + 1;
1856 if ((openfiles_new >= maxuserfiles &&
1857 priv_check(td, PRIV_MAXFILES) != 0) ||
1858 openfiles_new >= maxfiles) {
1859 atomic_subtract_int(&openfiles, 1);
1860 if (ppsratecheck(&lastfail, &curfail, 1)) {
1861 printf("kern.maxfiles limit exceeded by uid %i, (%s) "
1862 "please see tuning(7).\n", td->td_ucred->cr_ruid, td->td_proc->p_comm);
1866 fp = uma_zalloc(file_zone, M_WAITOK);
1867 bzero(fp, sizeof(*fp));
1868 refcount_init(&fp->f_count, 1);
1869 fp->f_cred = crhold(td->td_ucred);
1870 fp->f_ops = &badfileops;
1876 * Install a file in a file descriptor table.
1879 _finstall(struct filedesc *fdp, struct file *fp, int fd, int flags,
1880 struct filecaps *fcaps)
1882 struct filedescent *fde;
1886 filecaps_validate(fcaps, __func__);
1887 FILEDESC_XLOCK_ASSERT(fdp);
1889 fde = &fdp->fd_ofiles[fd];
1891 seq_write_begin(&fde->fde_seq);
1894 fde->fde_flags = (flags & O_CLOEXEC) != 0 ? UF_EXCLOSE : 0;
1896 filecaps_move(fcaps, &fde->fde_caps);
1898 filecaps_fill(&fde->fde_caps);
1900 seq_write_end(&fde->fde_seq);
1905 finstall(struct thread *td, struct file *fp, int *fd, int flags,
1906 struct filecaps *fcaps)
1908 struct filedesc *fdp = td->td_proc->p_fd;
1913 FILEDESC_XLOCK(fdp);
1914 if ((error = fdalloc(td, 0, fd))) {
1915 FILEDESC_XUNLOCK(fdp);
1919 _finstall(fdp, fp, *fd, flags, fcaps);
1920 FILEDESC_XUNLOCK(fdp);
1925 * Build a new filedesc structure from another.
1926 * Copy the current, root, and jail root vnode references.
1928 * If fdp is not NULL, return with it shared locked.
1931 fdinit(struct filedesc *fdp, bool prepfiles)
1933 struct filedesc0 *newfdp0;
1934 struct filedesc *newfdp;
1936 newfdp0 = uma_zalloc(filedesc0_zone, M_WAITOK | M_ZERO);
1937 newfdp = &newfdp0->fd_fd;
1939 /* Create the file descriptor table. */
1940 FILEDESC_LOCK_INIT(newfdp);
1941 refcount_init(&newfdp->fd_refcnt, 1);
1942 refcount_init(&newfdp->fd_holdcnt, 1);
1943 newfdp->fd_cmask = CMASK;
1944 newfdp->fd_map = newfdp0->fd_dmap;
1945 newfdp->fd_lastfile = -1;
1946 newfdp->fd_files = (struct fdescenttbl *)&newfdp0->fd_dfiles;
1947 newfdp->fd_files->fdt_nfiles = NDFILE;
1952 if (prepfiles && fdp->fd_lastfile >= newfdp->fd_nfiles)
1953 fdgrowtable(newfdp, fdp->fd_lastfile + 1);
1955 FILEDESC_SLOCK(fdp);
1956 newfdp->fd_cdir = fdp->fd_cdir;
1957 if (newfdp->fd_cdir)
1958 vrefact(newfdp->fd_cdir);
1959 newfdp->fd_rdir = fdp->fd_rdir;
1960 if (newfdp->fd_rdir)
1961 vrefact(newfdp->fd_rdir);
1962 newfdp->fd_jdir = fdp->fd_jdir;
1963 if (newfdp->fd_jdir)
1964 vrefact(newfdp->fd_jdir);
1967 FILEDESC_SUNLOCK(fdp);
1969 while (fdp->fd_lastfile >= newfdp->fd_nfiles) {
1970 FILEDESC_SUNLOCK(fdp);
1971 fdgrowtable(newfdp, fdp->fd_lastfile + 1);
1972 FILEDESC_SLOCK(fdp);
1979 static struct filedesc *
1980 fdhold(struct proc *p)
1982 struct filedesc *fdp;
1984 PROC_LOCK_ASSERT(p, MA_OWNED);
1987 refcount_acquire(&fdp->fd_holdcnt);
1992 fddrop(struct filedesc *fdp)
1995 if (fdp->fd_holdcnt > 1) {
1996 if (refcount_release(&fdp->fd_holdcnt) == 0)
2000 FILEDESC_LOCK_DESTROY(fdp);
2001 uma_zfree(filedesc0_zone, fdp);
2005 * Share a filedesc structure.
2008 fdshare(struct filedesc *fdp)
2011 refcount_acquire(&fdp->fd_refcnt);
2016 * Unshare a filedesc structure, if necessary by making a copy
2019 fdunshare(struct thread *td)
2021 struct filedesc *tmp;
2022 struct proc *p = td->td_proc;
2024 if (p->p_fd->fd_refcnt == 1)
2027 tmp = fdcopy(p->p_fd);
2033 fdinstall_remapped(struct thread *td, struct filedesc *fdp)
2037 td->td_proc->p_fd = fdp;
2041 * Copy a filedesc structure. A NULL pointer in returns a NULL reference,
2042 * this is to ease callers, not catch errors.
2045 fdcopy(struct filedesc *fdp)
2047 struct filedesc *newfdp;
2048 struct filedescent *nfde, *ofde;
2053 newfdp = fdinit(fdp, true);
2054 /* copy all passable descriptors (i.e. not kqueue) */
2055 newfdp->fd_freefile = -1;
2056 for (i = 0; i <= fdp->fd_lastfile; ++i) {
2057 ofde = &fdp->fd_ofiles[i];
2058 if (ofde->fde_file == NULL ||
2059 (ofde->fde_file->f_ops->fo_flags & DFLAG_PASSABLE) == 0) {
2060 if (newfdp->fd_freefile == -1)
2061 newfdp->fd_freefile = i;
2064 nfde = &newfdp->fd_ofiles[i];
2066 filecaps_copy(&ofde->fde_caps, &nfde->fde_caps, true);
2067 fhold(nfde->fde_file);
2068 fdused_init(newfdp, i);
2069 newfdp->fd_lastfile = i;
2071 if (newfdp->fd_freefile == -1)
2072 newfdp->fd_freefile = i;
2073 newfdp->fd_cmask = fdp->fd_cmask;
2074 FILEDESC_SUNLOCK(fdp);
2079 * Copies a filedesc structure, while remapping all file descriptors
2080 * stored inside using a translation table.
2082 * File descriptors are copied over to the new file descriptor table,
2083 * regardless of whether the close-on-exec flag is set.
2086 fdcopy_remapped(struct filedesc *fdp, const int *fds, size_t nfds,
2087 struct filedesc **ret)
2089 struct filedesc *newfdp;
2090 struct filedescent *nfde, *ofde;
2095 newfdp = fdinit(fdp, true);
2096 if (nfds > fdp->fd_lastfile + 1) {
2097 /* New table cannot be larger than the old one. */
2101 /* Copy all passable descriptors (i.e. not kqueue). */
2102 newfdp->fd_freefile = nfds;
2103 for (i = 0; i < nfds; ++i) {
2104 if (fds[i] < 0 || fds[i] > fdp->fd_lastfile) {
2105 /* File descriptor out of bounds. */
2109 ofde = &fdp->fd_ofiles[fds[i]];
2110 if (ofde->fde_file == NULL) {
2111 /* Unused file descriptor. */
2115 if ((ofde->fde_file->f_ops->fo_flags & DFLAG_PASSABLE) == 0) {
2116 /* File descriptor cannot be passed. */
2120 nfde = &newfdp->fd_ofiles[i];
2122 filecaps_copy(&ofde->fde_caps, &nfde->fde_caps, true);
2123 fhold(nfde->fde_file);
2124 fdused_init(newfdp, i);
2125 newfdp->fd_lastfile = i;
2127 newfdp->fd_cmask = fdp->fd_cmask;
2128 FILEDESC_SUNLOCK(fdp);
2132 FILEDESC_SUNLOCK(fdp);
2133 fdescfree_remapped(newfdp);
2138 * Clear POSIX style locks. This is only used when fdp looses a reference (i.e.
2139 * one of processes using it exits) and the table used to be shared.
2142 fdclearlocks(struct thread *td)
2144 struct filedesc *fdp;
2145 struct filedesc_to_leader *fdtol;
2155 MPASS(fdtol != NULL);
2157 FILEDESC_XLOCK(fdp);
2158 KASSERT(fdtol->fdl_refcount > 0,
2159 ("filedesc_to_refcount botch: fdl_refcount=%d",
2160 fdtol->fdl_refcount));
2161 if (fdtol->fdl_refcount == 1 &&
2162 (p->p_leader->p_flag & P_ADVLOCK) != 0) {
2163 for (i = 0; i <= fdp->fd_lastfile; i++) {
2164 fp = fdp->fd_ofiles[i].fde_file;
2165 if (fp == NULL || fp->f_type != DTYPE_VNODE)
2168 FILEDESC_XUNLOCK(fdp);
2169 lf.l_whence = SEEK_SET;
2172 lf.l_type = F_UNLCK;
2174 (void) VOP_ADVLOCK(vp,
2175 (caddr_t)p->p_leader, F_UNLCK,
2177 FILEDESC_XLOCK(fdp);
2182 if (fdtol->fdl_refcount == 1) {
2183 if (fdp->fd_holdleaderscount > 0 &&
2184 (p->p_leader->p_flag & P_ADVLOCK) != 0) {
2186 * close() or kern_dup() has cleared a reference
2187 * in a shared file descriptor table.
2189 fdp->fd_holdleaderswakeup = 1;
2190 sx_sleep(&fdp->fd_holdleaderscount,
2191 FILEDESC_LOCK(fdp), PLOCK, "fdlhold", 0);
2194 if (fdtol->fdl_holdcount > 0) {
2196 * Ensure that fdtol->fdl_leader remains
2197 * valid in closef().
2199 fdtol->fdl_wakeup = 1;
2200 sx_sleep(fdtol, FILEDESC_LOCK(fdp), PLOCK,
2205 fdtol->fdl_refcount--;
2206 if (fdtol->fdl_refcount == 0 &&
2207 fdtol->fdl_holdcount == 0) {
2208 fdtol->fdl_next->fdl_prev = fdtol->fdl_prev;
2209 fdtol->fdl_prev->fdl_next = fdtol->fdl_next;
2213 FILEDESC_XUNLOCK(fdp);
2215 free(fdtol, M_FILEDESC_TO_LEADER);
2219 * Release a filedesc structure.
2222 fdescfree_fds(struct thread *td, struct filedesc *fdp, bool needclose)
2224 struct filedesc0 *fdp0;
2225 struct freetable *ft, *tft;
2226 struct filedescent *fde;
2230 for (i = 0; i <= fdp->fd_lastfile; i++) {
2231 fde = &fdp->fd_ofiles[i];
2236 (void) closef(fp, td);
2242 if (NDSLOTS(fdp->fd_nfiles) > NDSLOTS(NDFILE))
2243 free(fdp->fd_map, M_FILEDESC);
2244 if (fdp->fd_nfiles > NDFILE)
2245 free(fdp->fd_files, M_FILEDESC);
2247 fdp0 = (struct filedesc0 *)fdp;
2248 SLIST_FOREACH_SAFE(ft, &fdp0->fd_free, ft_next, tft)
2249 free(ft->ft_table, M_FILEDESC);
2255 fdescfree(struct thread *td)
2258 struct filedesc *fdp;
2259 struct vnode *cdir, *jdir, *rdir;
2266 if (RACCT_ENABLED())
2267 racct_set_unlocked(p, RACCT_NOFILE, 0);
2270 if (p->p_fdtol != NULL)
2277 if (refcount_release(&fdp->fd_refcnt) == 0)
2280 FILEDESC_XLOCK(fdp);
2281 cdir = fdp->fd_cdir;
2282 fdp->fd_cdir = NULL;
2283 rdir = fdp->fd_rdir;
2284 fdp->fd_rdir = NULL;
2285 jdir = fdp->fd_jdir;
2286 fdp->fd_jdir = NULL;
2287 FILEDESC_XUNLOCK(fdp);
2296 fdescfree_fds(td, fdp, 1);
2300 fdescfree_remapped(struct filedesc *fdp)
2303 if (fdp->fd_cdir != NULL)
2304 vrele(fdp->fd_cdir);
2305 if (fdp->fd_rdir != NULL)
2306 vrele(fdp->fd_rdir);
2307 if (fdp->fd_jdir != NULL)
2308 vrele(fdp->fd_jdir);
2310 fdescfree_fds(curthread, fdp, 0);
2314 * For setugid programs, we don't want to people to use that setugidness
2315 * to generate error messages which write to a file which otherwise would
2316 * otherwise be off-limits to the process. We check for filesystems where
2317 * the vnode can change out from under us after execve (like [lin]procfs).
2319 * Since fdsetugidsafety calls this only for fd 0, 1 and 2, this check is
2320 * sufficient. We also don't check for setugidness since we know we are.
2323 is_unsafe(struct file *fp)
2327 if (fp->f_type != DTYPE_VNODE)
2331 return ((vp->v_vflag & VV_PROCDEP) != 0);
2335 * Make this setguid thing safe, if at all possible.
2338 fdsetugidsafety(struct thread *td)
2340 struct filedesc *fdp;
2344 fdp = td->td_proc->p_fd;
2345 KASSERT(fdp->fd_refcnt == 1, ("the fdtable should not be shared"));
2346 MPASS(fdp->fd_nfiles >= 3);
2347 for (i = 0; i <= 2; i++) {
2348 fp = fdp->fd_ofiles[i].fde_file;
2349 if (fp != NULL && is_unsafe(fp)) {
2350 FILEDESC_XLOCK(fdp);
2351 knote_fdclose(td, i);
2353 * NULL-out descriptor prior to close to avoid
2354 * a race while close blocks.
2357 FILEDESC_XUNLOCK(fdp);
2358 (void) closef(fp, td);
2364 * If a specific file object occupies a specific file descriptor, close the
2365 * file descriptor entry and drop a reference on the file object. This is a
2366 * convenience function to handle a subsequent error in a function that calls
2367 * falloc() that handles the race that another thread might have closed the
2368 * file descriptor out from under the thread creating the file object.
2371 fdclose(struct thread *td, struct file *fp, int idx)
2373 struct filedesc *fdp = td->td_proc->p_fd;
2375 FILEDESC_XLOCK(fdp);
2376 if (fdp->fd_ofiles[idx].fde_file == fp) {
2378 FILEDESC_XUNLOCK(fdp);
2381 FILEDESC_XUNLOCK(fdp);
2385 * Close any files on exec?
2388 fdcloseexec(struct thread *td)
2390 struct filedesc *fdp;
2391 struct filedescent *fde;
2395 fdp = td->td_proc->p_fd;
2396 KASSERT(fdp->fd_refcnt == 1, ("the fdtable should not be shared"));
2397 for (i = 0; i <= fdp->fd_lastfile; i++) {
2398 fde = &fdp->fd_ofiles[i];
2400 if (fp != NULL && (fp->f_type == DTYPE_MQUEUE ||
2401 (fde->fde_flags & UF_EXCLOSE))) {
2402 FILEDESC_XLOCK(fdp);
2404 (void) closefp(fdp, i, fp, td, 0);
2405 FILEDESC_UNLOCK_ASSERT(fdp);
2411 * It is unsafe for set[ug]id processes to be started with file
2412 * descriptors 0..2 closed, as these descriptors are given implicit
2413 * significance in the Standard C library. fdcheckstd() will create a
2414 * descriptor referencing /dev/null for each of stdin, stdout, and
2415 * stderr that is not already open.
2418 fdcheckstd(struct thread *td)
2420 struct filedesc *fdp;
2422 int i, error, devnull;
2424 fdp = td->td_proc->p_fd;
2425 KASSERT(fdp->fd_refcnt == 1, ("the fdtable should not be shared"));
2426 MPASS(fdp->fd_nfiles >= 3);
2428 for (i = 0; i <= 2; i++) {
2429 if (fdp->fd_ofiles[i].fde_file != NULL)
2432 save = td->td_retval[0];
2433 if (devnull != -1) {
2434 error = kern_dup(td, FDDUP_FIXED, 0, devnull, i);
2436 error = kern_openat(td, AT_FDCWD, "/dev/null",
2437 UIO_SYSSPACE, O_RDWR, 0);
2439 devnull = td->td_retval[0];
2440 KASSERT(devnull == i, ("we didn't get our fd"));
2443 td->td_retval[0] = save;
2451 * Internal form of close. Decrement reference count on file structure.
2452 * Note: td may be NULL when closing a file that was being passed in a
2455 * XXXRW: Giant is not required for the caller, but often will be held; this
2456 * makes it moderately likely the Giant will be recursed in the VFS case.
2459 closef(struct file *fp, struct thread *td)
2463 struct filedesc_to_leader *fdtol;
2464 struct filedesc *fdp;
2467 * POSIX record locking dictates that any close releases ALL
2468 * locks owned by this process. This is handled by setting
2469 * a flag in the unlock to free ONLY locks obeying POSIX
2470 * semantics, and not to free BSD-style file locks.
2471 * If the descriptor was in a message, POSIX-style locks
2472 * aren't passed with the descriptor, and the thread pointer
2473 * will be NULL. Callers should be careful only to pass a
2474 * NULL thread pointer when there really is no owning
2475 * context that might have locks, or the locks will be
2478 if (fp->f_type == DTYPE_VNODE && td != NULL) {
2480 if ((td->td_proc->p_leader->p_flag & P_ADVLOCK) != 0) {
2481 lf.l_whence = SEEK_SET;
2484 lf.l_type = F_UNLCK;
2485 (void) VOP_ADVLOCK(vp, (caddr_t)td->td_proc->p_leader,
2486 F_UNLCK, &lf, F_POSIX);
2488 fdtol = td->td_proc->p_fdtol;
2489 if (fdtol != NULL) {
2491 * Handle special case where file descriptor table is
2492 * shared between multiple process leaders.
2494 fdp = td->td_proc->p_fd;
2495 FILEDESC_XLOCK(fdp);
2496 for (fdtol = fdtol->fdl_next;
2497 fdtol != td->td_proc->p_fdtol;
2498 fdtol = fdtol->fdl_next) {
2499 if ((fdtol->fdl_leader->p_flag &
2502 fdtol->fdl_holdcount++;
2503 FILEDESC_XUNLOCK(fdp);
2504 lf.l_whence = SEEK_SET;
2507 lf.l_type = F_UNLCK;
2509 (void) VOP_ADVLOCK(vp,
2510 (caddr_t)fdtol->fdl_leader, F_UNLCK, &lf,
2512 FILEDESC_XLOCK(fdp);
2513 fdtol->fdl_holdcount--;
2514 if (fdtol->fdl_holdcount == 0 &&
2515 fdtol->fdl_wakeup != 0) {
2516 fdtol->fdl_wakeup = 0;
2520 FILEDESC_XUNLOCK(fdp);
2523 return (fdrop(fp, td));
2527 * Initialize the file pointer with the specified properties.
2529 * The ops are set with release semantics to be certain that the flags, type,
2530 * and data are visible when ops is. This is to prevent ops methods from being
2531 * called with bad data.
2534 finit(struct file *fp, u_int flag, short type, void *data, struct fileops *ops)
2539 atomic_store_rel_ptr((volatile uintptr_t *)&fp->f_ops, (uintptr_t)ops);
2543 fget_cap_locked(struct filedesc *fdp, int fd, cap_rights_t *needrightsp,
2544 struct file **fpp, struct filecaps *havecapsp)
2546 struct filedescent *fde;
2549 FILEDESC_LOCK_ASSERT(fdp);
2551 fde = fdeget_locked(fdp, fd);
2558 error = cap_check(cap_rights_fde_inline(fde), needrightsp);
2563 if (havecapsp != NULL)
2564 filecaps_copy(&fde->fde_caps, havecapsp, true);
2566 *fpp = fde->fde_file;
2574 fget_cap(struct thread *td, int fd, cap_rights_t *needrightsp,
2575 struct file **fpp, struct filecaps *havecapsp)
2577 struct filedesc *fdp = td->td_proc->p_fd;
2579 #ifndef CAPABILITIES
2580 error = fget_unlocked(fdp, fd, needrightsp, fpp, NULL);
2581 if (error == 0 && havecapsp != NULL)
2582 filecaps_fill(havecapsp);
2588 error = fget_unlocked(fdp, fd, needrightsp, &fp, &seq);
2592 if (havecapsp != NULL) {
2593 if (!filecaps_copy(&fdp->fd_ofiles[fd].fde_caps,
2594 havecapsp, false)) {
2600 if (!fd_modified(fdp, fd, seq))
2609 FILEDESC_SLOCK(fdp);
2610 error = fget_cap_locked(fdp, fd, needrightsp, fpp, havecapsp);
2613 FILEDESC_SUNLOCK(fdp);
2619 fget_unlocked(struct filedesc *fdp, int fd, cap_rights_t *needrightsp,
2620 struct file **fpp, seq_t *seqp)
2623 const struct filedescent *fde;
2625 const struct fdescenttbl *fdt;
2630 cap_rights_t haverights;
2634 fdt = fdp->fd_files;
2635 if (__predict_false((u_int)fd >= fdt->fdt_nfiles))
2638 * Fetch the descriptor locklessly. We avoid fdrop() races by
2639 * never raising a refcount above 0. To accomplish this we have
2640 * to use a cmpset loop rather than an atomic_add. The descriptor
2641 * must be re-verified once we acquire a reference to be certain
2642 * that the identity is still correct and we did not lose a race
2643 * due to preemption.
2647 seq = seq_read(fd_seq(fdt, fd));
2648 fde = &fdt->fdt_ofiles[fd];
2649 haverights = *cap_rights_fde_inline(fde);
2651 if (!seq_consistent(fd_seq(fdt, fd), seq))
2654 fp = fdt->fdt_ofiles[fd].fde_file;
2659 error = cap_check(&haverights, needrightsp);
2663 count = fp->f_count;
2667 * Force a reload. Other thread could reallocate the
2668 * table before this fd was closed, so it possible that
2669 * there is a stale fp pointer in cached version.
2671 fdt = *(const struct fdescenttbl * const volatile *)&(fdp->fd_files);
2675 * Use an acquire barrier to force re-reading of fdt so it is
2676 * refreshed for verification.
2678 if (atomic_fcmpset_acq_int(&fp->f_count, &count, count + 1) == 0)
2680 fdt = fdp->fd_files;
2682 if (seq_consistent_nomb(fd_seq(fdt, fd), seq))
2684 if (fp == fdt->fdt_ofiles[fd].fde_file)
2687 fdrop(fp, curthread);
2699 * Extract the file pointer associated with the specified descriptor for the
2700 * current user process.
2702 * If the descriptor doesn't exist or doesn't match 'flags', EBADF is
2705 * File's rights will be checked against the capability rights mask.
2707 * If an error occurred the non-zero error is returned and *fpp is set to
2708 * NULL. Otherwise *fpp is held and set and zero is returned. Caller is
2709 * responsible for fdrop().
2712 _fget(struct thread *td, int fd, struct file **fpp, int flags,
2713 cap_rights_t *needrightsp, seq_t *seqp)
2715 struct filedesc *fdp;
2720 fdp = td->td_proc->p_fd;
2721 error = fget_unlocked(fdp, fd, needrightsp, &fp, seqp);
2724 if (fp->f_ops == &badfileops) {
2730 * FREAD and FWRITE failure return EBADF as per POSIX.
2736 if ((fp->f_flag & flags) == 0)
2740 if ((fp->f_flag & (FREAD | FEXEC)) == 0 ||
2741 ((fp->f_flag & FWRITE) != 0))
2747 KASSERT(0, ("wrong flags"));
2760 fget(struct thread *td, int fd, cap_rights_t *rightsp, struct file **fpp)
2763 return (_fget(td, fd, fpp, 0, rightsp, NULL));
2767 fget_mmap(struct thread *td, int fd, cap_rights_t *rightsp, u_char *maxprotp,
2771 #ifndef CAPABILITIES
2772 error = _fget(td, fd, fpp, 0, rightsp, NULL);
2773 if (maxprotp != NULL)
2774 *maxprotp = VM_PROT_ALL;
2776 struct filedesc *fdp = td->td_proc->p_fd;
2779 MPASS(cap_rights_is_set(rightsp, CAP_MMAP));
2781 error = _fget(td, fd, fpp, 0, rightsp, &seq);
2785 * If requested, convert capability rights to access flags.
2787 if (maxprotp != NULL)
2788 *maxprotp = cap_rights_to_vmprot(cap_rights(fdp, fd));
2789 if (!fd_modified(fdp, fd, seq))
2798 fget_read(struct thread *td, int fd, cap_rights_t *rightsp, struct file **fpp)
2801 return (_fget(td, fd, fpp, FREAD, rightsp, NULL));
2805 fget_write(struct thread *td, int fd, cap_rights_t *rightsp, struct file **fpp)
2808 return (_fget(td, fd, fpp, FWRITE, rightsp, NULL));
2812 fget_fcntl(struct thread *td, int fd, cap_rights_t *rightsp, int needfcntl,
2815 struct filedesc *fdp = td->td_proc->p_fd;
2816 #ifndef CAPABILITIES
2817 return (fget_unlocked(fdp, fd, rightsp, fpp, NULL));
2822 MPASS(cap_rights_is_set(rightsp, CAP_FCNTL));
2824 error = fget_unlocked(fdp, fd, rightsp, fpp, &seq);
2827 error = cap_fcntl_check(fdp, fd, needfcntl);
2828 if (!fd_modified(fdp, fd, seq))
2841 * Like fget() but loads the underlying vnode, or returns an error if the
2842 * descriptor does not represent a vnode. Note that pipes use vnodes but
2843 * never have VM objects. The returned vnode will be vref()'d.
2845 * XXX: what about the unused flags ?
2848 _fgetvp(struct thread *td, int fd, int flags, cap_rights_t *needrightsp,
2855 error = _fget(td, fd, &fp, flags, needrightsp, NULL);
2858 if (fp->f_vnode == NULL) {
2870 fgetvp(struct thread *td, int fd, cap_rights_t *rightsp, struct vnode **vpp)
2873 return (_fgetvp(td, fd, 0, rightsp, vpp));
2877 fgetvp_rights(struct thread *td, int fd, cap_rights_t *needrightsp,
2878 struct filecaps *havecaps, struct vnode **vpp)
2880 struct filedesc *fdp;
2881 struct filecaps caps;
2885 fdp = td->td_proc->p_fd;
2886 error = fget_cap_locked(fdp, fd, needrightsp, &fp, &caps);
2889 if (fp->f_ops == &badfileops) {
2893 if (fp->f_vnode == NULL) {
2904 filecaps_free(&caps);
2909 fgetvp_read(struct thread *td, int fd, cap_rights_t *rightsp, struct vnode **vpp)
2912 return (_fgetvp(td, fd, FREAD, rightsp, vpp));
2916 fgetvp_exec(struct thread *td, int fd, cap_rights_t *rightsp, struct vnode **vpp)
2919 return (_fgetvp(td, fd, FEXEC, rightsp, vpp));
2924 fgetvp_write(struct thread *td, int fd, cap_rights_t *rightsp,
2928 return (_fgetvp(td, fd, FWRITE, rightsp, vpp));
2933 * Handle the last reference to a file being closed.
2935 * Without the noinline attribute clang keeps inlining the func thorough this
2936 * file when fdrop is used.
2939 _fdrop(struct file *fp, struct thread *td)
2943 if (fp->f_count != 0)
2944 panic("fdrop: count %d", fp->f_count);
2945 error = fo_close(fp, td);
2946 atomic_subtract_int(&openfiles, 1);
2948 free(fp->f_advice, M_FADVISE);
2949 uma_zfree(file_zone, fp);
2955 * Apply an advisory lock on a file descriptor.
2957 * Just attempt to get a record lock of the requested type on the entire file
2958 * (l_whence = SEEK_SET, l_start = 0, l_len = 0).
2960 #ifndef _SYS_SYSPROTO_H_
2968 sys_flock(struct thread *td, struct flock_args *uap)
2975 error = fget(td, uap->fd, &cap_flock_rights, &fp);
2978 if (fp->f_type != DTYPE_VNODE) {
2980 return (EOPNOTSUPP);
2984 lf.l_whence = SEEK_SET;
2987 if (uap->how & LOCK_UN) {
2988 lf.l_type = F_UNLCK;
2989 atomic_clear_int(&fp->f_flag, FHASLOCK);
2990 error = VOP_ADVLOCK(vp, (caddr_t)fp, F_UNLCK, &lf, F_FLOCK);
2993 if (uap->how & LOCK_EX)
2994 lf.l_type = F_WRLCK;
2995 else if (uap->how & LOCK_SH)
2996 lf.l_type = F_RDLCK;
3001 atomic_set_int(&fp->f_flag, FHASLOCK);
3002 error = VOP_ADVLOCK(vp, (caddr_t)fp, F_SETLK, &lf,
3003 (uap->how & LOCK_NB) ? F_FLOCK : F_FLOCK | F_WAIT);
3009 * Duplicate the specified descriptor to a free descriptor.
3012 dupfdopen(struct thread *td, struct filedesc *fdp, int dfd, int mode,
3013 int openerror, int *indxp)
3015 struct filedescent *newfde, *oldfde;
3020 KASSERT(openerror == ENODEV || openerror == ENXIO,
3021 ("unexpected error %d in %s", openerror, __func__));
3024 * If the to-be-dup'd fd number is greater than the allowed number
3025 * of file descriptors, or the fd to be dup'd has already been
3026 * closed, then reject.
3028 FILEDESC_XLOCK(fdp);
3029 if ((fp = fget_locked(fdp, dfd)) == NULL) {
3030 FILEDESC_XUNLOCK(fdp);
3034 error = fdalloc(td, 0, &indx);
3036 FILEDESC_XUNLOCK(fdp);
3041 * There are two cases of interest here.
3043 * For ENODEV simply dup (dfd) to file descriptor (indx) and return.
3045 * For ENXIO steal away the file structure from (dfd) and store it in
3046 * (indx). (dfd) is effectively closed by this operation.
3048 switch (openerror) {
3051 * Check that the mode the file is being opened for is a
3052 * subset of the mode of the existing descriptor.
3054 if (((mode & (FREAD|FWRITE)) | fp->f_flag) != fp->f_flag) {
3055 fdunused(fdp, indx);
3056 FILEDESC_XUNLOCK(fdp);
3060 newfde = &fdp->fd_ofiles[indx];
3061 oldfde = &fdp->fd_ofiles[dfd];
3062 ioctls = filecaps_copy_prep(&oldfde->fde_caps);
3064 seq_write_begin(&newfde->fde_seq);
3066 memcpy(newfde, oldfde, fde_change_size);
3067 filecaps_copy_finish(&oldfde->fde_caps, &newfde->fde_caps,
3070 seq_write_end(&newfde->fde_seq);
3075 * Steal away the file pointer from dfd and stuff it into indx.
3077 newfde = &fdp->fd_ofiles[indx];
3078 oldfde = &fdp->fd_ofiles[dfd];
3080 seq_write_begin(&newfde->fde_seq);
3082 memcpy(newfde, oldfde, fde_change_size);
3083 oldfde->fde_file = NULL;
3086 seq_write_end(&newfde->fde_seq);
3090 FILEDESC_XUNLOCK(fdp);
3096 * This sysctl determines if we will allow a process to chroot(2) if it
3097 * has a directory open:
3098 * 0: disallowed for all processes.
3099 * 1: allowed for processes that were not already chroot(2)'ed.
3100 * 2: allowed for all processes.
3103 static int chroot_allow_open_directories = 1;
3105 SYSCTL_INT(_kern, OID_AUTO, chroot_allow_open_directories, CTLFLAG_RW,
3106 &chroot_allow_open_directories, 0,
3107 "Allow a process to chroot(2) if it has a directory open");
3110 * Helper function for raised chroot(2) security function: Refuse if
3111 * any filedescriptors are open directories.
3114 chroot_refuse_vdir_fds(struct filedesc *fdp)
3120 FILEDESC_LOCK_ASSERT(fdp);
3122 for (fd = 0; fd <= fdp->fd_lastfile; fd++) {
3123 fp = fget_locked(fdp, fd);
3126 if (fp->f_type == DTYPE_VNODE) {
3128 if (vp->v_type == VDIR)
3136 * Common routine for kern_chroot() and jail_attach(). The caller is
3137 * responsible for invoking priv_check() and mac_vnode_check_chroot() to
3138 * authorize this operation.
3141 pwd_chroot(struct thread *td, struct vnode *vp)
3143 struct filedesc *fdp;
3144 struct vnode *oldvp;
3147 fdp = td->td_proc->p_fd;
3148 FILEDESC_XLOCK(fdp);
3149 if (chroot_allow_open_directories == 0 ||
3150 (chroot_allow_open_directories == 1 && fdp->fd_rdir != rootvnode)) {
3151 error = chroot_refuse_vdir_fds(fdp);
3153 FILEDESC_XUNLOCK(fdp);
3157 oldvp = fdp->fd_rdir;
3160 if (fdp->fd_jdir == NULL) {
3164 FILEDESC_XUNLOCK(fdp);
3170 pwd_chdir(struct thread *td, struct vnode *vp)
3172 struct filedesc *fdp;
3173 struct vnode *oldvp;
3175 fdp = td->td_proc->p_fd;
3176 FILEDESC_XLOCK(fdp);
3177 VNASSERT(vp->v_usecount > 0, vp,
3178 ("chdir to a vnode with zero usecount"));
3179 oldvp = fdp->fd_cdir;
3181 FILEDESC_XUNLOCK(fdp);
3186 * Scan all active processes and prisons to see if any of them have a current
3187 * or root directory of `olddp'. If so, replace them with the new mount point.
3190 mountcheckdirs(struct vnode *olddp, struct vnode *newdp)
3192 struct filedesc *fdp;
3197 if (vrefcnt(olddp) == 1)
3200 sx_slock(&allproc_lock);
3201 FOREACH_PROC_IN_SYSTEM(p) {
3207 FILEDESC_XLOCK(fdp);
3208 if (fdp->fd_cdir == olddp) {
3210 fdp->fd_cdir = newdp;
3213 if (fdp->fd_rdir == olddp) {
3215 fdp->fd_rdir = newdp;
3218 if (fdp->fd_jdir == olddp) {
3220 fdp->fd_jdir = newdp;
3223 FILEDESC_XUNLOCK(fdp);
3226 sx_sunlock(&allproc_lock);
3227 if (rootvnode == olddp) {
3232 mtx_lock(&prison0.pr_mtx);
3233 if (prison0.pr_root == olddp) {
3235 prison0.pr_root = newdp;
3238 mtx_unlock(&prison0.pr_mtx);
3239 sx_slock(&allprison_lock);
3240 TAILQ_FOREACH(pr, &allprison, pr_list) {
3241 mtx_lock(&pr->pr_mtx);
3242 if (pr->pr_root == olddp) {
3244 pr->pr_root = newdp;
3247 mtx_unlock(&pr->pr_mtx);
3249 sx_sunlock(&allprison_lock);
3254 struct filedesc_to_leader *
3255 filedesc_to_leader_alloc(struct filedesc_to_leader *old, struct filedesc *fdp, struct proc *leader)
3257 struct filedesc_to_leader *fdtol;
3259 fdtol = malloc(sizeof(struct filedesc_to_leader),
3260 M_FILEDESC_TO_LEADER, M_WAITOK);
3261 fdtol->fdl_refcount = 1;
3262 fdtol->fdl_holdcount = 0;
3263 fdtol->fdl_wakeup = 0;
3264 fdtol->fdl_leader = leader;
3266 FILEDESC_XLOCK(fdp);
3267 fdtol->fdl_next = old->fdl_next;
3268 fdtol->fdl_prev = old;
3269 old->fdl_next = fdtol;
3270 fdtol->fdl_next->fdl_prev = fdtol;
3271 FILEDESC_XUNLOCK(fdp);
3273 fdtol->fdl_next = fdtol;
3274 fdtol->fdl_prev = fdtol;
3280 sysctl_kern_proc_nfds(SYSCTL_HANDLER_ARGS)
3282 struct filedesc *fdp;
3283 int i, count, slots;
3285 if (*(int *)arg1 != 0)
3288 fdp = curproc->p_fd;
3290 FILEDESC_SLOCK(fdp);
3291 slots = NDSLOTS(fdp->fd_lastfile + 1);
3292 for (i = 0; i < slots; i++)
3293 count += bitcountl(fdp->fd_map[i]);
3294 FILEDESC_SUNLOCK(fdp);
3296 return (SYSCTL_OUT(req, &count, sizeof(count)));
3299 static SYSCTL_NODE(_kern_proc, KERN_PROC_NFDS, nfds,
3300 CTLFLAG_RD|CTLFLAG_CAPRD|CTLFLAG_MPSAFE, sysctl_kern_proc_nfds,
3301 "Number of open file descriptors");
3304 * Get file structures globally.
3307 sysctl_kern_file(SYSCTL_HANDLER_ARGS)
3310 struct filedesc *fdp;
3315 error = sysctl_wire_old_buffer(req, 0);
3318 if (req->oldptr == NULL) {
3320 sx_slock(&allproc_lock);
3321 FOREACH_PROC_IN_SYSTEM(p) {
3323 if (p->p_state == PRS_NEW) {
3331 /* overestimates sparse tables. */
3332 if (fdp->fd_lastfile > 0)
3333 n += fdp->fd_lastfile;
3336 sx_sunlock(&allproc_lock);
3337 return (SYSCTL_OUT(req, 0, n * sizeof(xf)));
3340 bzero(&xf, sizeof(xf));
3341 xf.xf_size = sizeof(xf);
3342 sx_slock(&allproc_lock);
3343 FOREACH_PROC_IN_SYSTEM(p) {
3345 if (p->p_state == PRS_NEW) {
3349 if (p_cansee(req->td, p) != 0) {
3353 xf.xf_pid = p->p_pid;
3354 xf.xf_uid = p->p_ucred->cr_uid;
3359 FILEDESC_SLOCK(fdp);
3360 for (n = 0; fdp->fd_refcnt > 0 && n <= fdp->fd_lastfile; ++n) {
3361 if ((fp = fdp->fd_ofiles[n].fde_file) == NULL)
3364 xf.xf_file = (uintptr_t)fp;
3365 xf.xf_data = (uintptr_t)fp->f_data;
3366 xf.xf_vnode = (uintptr_t)fp->f_vnode;
3367 xf.xf_type = (uintptr_t)fp->f_type;
3368 xf.xf_count = fp->f_count;
3370 xf.xf_offset = foffset_get(fp);
3371 xf.xf_flag = fp->f_flag;
3372 error = SYSCTL_OUT(req, &xf, sizeof(xf));
3376 FILEDESC_SUNLOCK(fdp);
3381 sx_sunlock(&allproc_lock);
3385 SYSCTL_PROC(_kern, KERN_FILE, file, CTLTYPE_OPAQUE|CTLFLAG_RD|CTLFLAG_MPSAFE,
3386 0, 0, sysctl_kern_file, "S,xfile", "Entire file table");
3388 #ifdef KINFO_FILE_SIZE
3389 CTASSERT(sizeof(struct kinfo_file) == KINFO_FILE_SIZE);
3393 xlate_fflags(int fflags)
3395 static const struct {
3398 } fflags_table[] = {
3399 { FAPPEND, KF_FLAG_APPEND },
3400 { FASYNC, KF_FLAG_ASYNC },
3401 { FFSYNC, KF_FLAG_FSYNC },
3402 { FHASLOCK, KF_FLAG_HASLOCK },
3403 { FNONBLOCK, KF_FLAG_NONBLOCK },
3404 { FREAD, KF_FLAG_READ },
3405 { FWRITE, KF_FLAG_WRITE },
3406 { O_CREAT, KF_FLAG_CREAT },
3407 { O_DIRECT, KF_FLAG_DIRECT },
3408 { O_EXCL, KF_FLAG_EXCL },
3409 { O_EXEC, KF_FLAG_EXEC },
3410 { O_EXLOCK, KF_FLAG_EXLOCK },
3411 { O_NOFOLLOW, KF_FLAG_NOFOLLOW },
3412 { O_SHLOCK, KF_FLAG_SHLOCK },
3413 { O_TRUNC, KF_FLAG_TRUNC }
3419 for (i = 0; i < nitems(fflags_table); i++)
3420 if (fflags & fflags_table[i].fflag)
3421 kflags |= fflags_table[i].kf_fflag;
3425 /* Trim unused data from kf_path by truncating the structure size. */
3427 pack_kinfo(struct kinfo_file *kif)
3430 kif->kf_structsize = offsetof(struct kinfo_file, kf_path) +
3431 strlen(kif->kf_path) + 1;
3432 kif->kf_structsize = roundup(kif->kf_structsize, sizeof(uint64_t));
3436 export_file_to_kinfo(struct file *fp, int fd, cap_rights_t *rightsp,
3437 struct kinfo_file *kif, struct filedesc *fdp, int flags)
3441 bzero(kif, sizeof(*kif));
3443 /* Set a default type to allow for empty fill_kinfo() methods. */
3444 kif->kf_type = KF_TYPE_UNKNOWN;
3445 kif->kf_flags = xlate_fflags(fp->f_flag);
3446 if (rightsp != NULL)
3447 kif->kf_cap_rights = *rightsp;
3449 cap_rights_init(&kif->kf_cap_rights);
3451 kif->kf_ref_count = fp->f_count;
3452 kif->kf_offset = foffset_get(fp);
3455 * This may drop the filedesc lock, so the 'fp' cannot be
3456 * accessed after this call.
3458 error = fo_fill_kinfo(fp, kif, fdp);
3460 kif->kf_status |= KF_ATTR_VALID;
3461 if ((flags & KERN_FILEDESC_PACK_KINFO) != 0)
3464 kif->kf_structsize = roundup2(sizeof(*kif), sizeof(uint64_t));
3468 export_vnode_to_kinfo(struct vnode *vp, int fd, int fflags,
3469 struct kinfo_file *kif, int flags)
3473 bzero(kif, sizeof(*kif));
3475 kif->kf_type = KF_TYPE_VNODE;
3476 error = vn_fill_kinfo_vnode(vp, kif);
3478 kif->kf_status |= KF_ATTR_VALID;
3479 kif->kf_flags = xlate_fflags(fflags);
3480 cap_rights_init(&kif->kf_cap_rights);
3482 kif->kf_ref_count = -1;
3483 kif->kf_offset = -1;
3484 if ((flags & KERN_FILEDESC_PACK_KINFO) != 0)
3487 kif->kf_structsize = roundup2(sizeof(*kif), sizeof(uint64_t));
3491 struct export_fd_buf {
3492 struct filedesc *fdp;
3495 struct kinfo_file kif;
3500 export_kinfo_to_sb(struct export_fd_buf *efbuf)
3502 struct kinfo_file *kif;
3505 if (efbuf->remainder != -1) {
3506 if (efbuf->remainder < kif->kf_structsize) {
3507 /* Terminate export. */
3508 efbuf->remainder = 0;
3511 efbuf->remainder -= kif->kf_structsize;
3513 return (sbuf_bcat(efbuf->sb, kif, kif->kf_structsize) == 0 ? 0 : ENOMEM);
3517 export_file_to_sb(struct file *fp, int fd, cap_rights_t *rightsp,
3518 struct export_fd_buf *efbuf)
3522 if (efbuf->remainder == 0)
3524 export_file_to_kinfo(fp, fd, rightsp, &efbuf->kif, efbuf->fdp,
3526 FILEDESC_SUNLOCK(efbuf->fdp);
3527 error = export_kinfo_to_sb(efbuf);
3528 FILEDESC_SLOCK(efbuf->fdp);
3533 export_vnode_to_sb(struct vnode *vp, int fd, int fflags,
3534 struct export_fd_buf *efbuf)
3538 if (efbuf->remainder == 0)
3540 if (efbuf->fdp != NULL)
3541 FILEDESC_SUNLOCK(efbuf->fdp);
3542 export_vnode_to_kinfo(vp, fd, fflags, &efbuf->kif, efbuf->flags);
3543 error = export_kinfo_to_sb(efbuf);
3544 if (efbuf->fdp != NULL)
3545 FILEDESC_SLOCK(efbuf->fdp);
3550 * Store a process file descriptor information to sbuf.
3552 * Takes a locked proc as argument, and returns with the proc unlocked.
3555 kern_proc_filedesc_out(struct proc *p, struct sbuf *sb, ssize_t maxlen,
3559 struct filedesc *fdp;
3560 struct export_fd_buf *efbuf;
3561 struct vnode *cttyvp, *textvp, *tracevp;
3563 cap_rights_t rights;
3565 PROC_LOCK_ASSERT(p, MA_OWNED);
3568 tracevp = p->p_tracevp;
3569 if (tracevp != NULL)
3572 textvp = p->p_textvp;
3575 /* Controlling tty. */
3577 if (p->p_pgrp != NULL && p->p_pgrp->pg_session != NULL) {
3578 cttyvp = p->p_pgrp->pg_session->s_ttyvp;
3584 efbuf = malloc(sizeof(*efbuf), M_TEMP, M_WAITOK);
3587 efbuf->remainder = maxlen;
3588 efbuf->flags = flags;
3589 if (tracevp != NULL)
3590 export_vnode_to_sb(tracevp, KF_FD_TYPE_TRACE, FREAD | FWRITE,
3593 export_vnode_to_sb(textvp, KF_FD_TYPE_TEXT, FREAD, efbuf);
3595 export_vnode_to_sb(cttyvp, KF_FD_TYPE_CTTY, FREAD | FWRITE,
3601 FILEDESC_SLOCK(fdp);
3602 /* working directory */
3603 if (fdp->fd_cdir != NULL) {
3604 vrefact(fdp->fd_cdir);
3605 export_vnode_to_sb(fdp->fd_cdir, KF_FD_TYPE_CWD, FREAD, efbuf);
3607 /* root directory */
3608 if (fdp->fd_rdir != NULL) {
3609 vrefact(fdp->fd_rdir);
3610 export_vnode_to_sb(fdp->fd_rdir, KF_FD_TYPE_ROOT, FREAD, efbuf);
3612 /* jail directory */
3613 if (fdp->fd_jdir != NULL) {
3614 vrefact(fdp->fd_jdir);
3615 export_vnode_to_sb(fdp->fd_jdir, KF_FD_TYPE_JAIL, FREAD, efbuf);
3617 for (i = 0; fdp->fd_refcnt > 0 && i <= fdp->fd_lastfile; i++) {
3618 if ((fp = fdp->fd_ofiles[i].fde_file) == NULL)
3621 rights = *cap_rights(fdp, i);
3622 #else /* !CAPABILITIES */
3623 rights = cap_no_rights;
3626 * Create sysctl entry. It is OK to drop the filedesc
3627 * lock inside of export_file_to_sb() as we will
3628 * re-validate and re-evaluate its properties when the
3631 error = export_file_to_sb(fp, i, &rights, efbuf);
3632 if (error != 0 || efbuf->remainder == 0)
3635 FILEDESC_SUNLOCK(fdp);
3638 free(efbuf, M_TEMP);
3642 #define FILEDESC_SBUF_SIZE (sizeof(struct kinfo_file) * 5)
3645 * Get per-process file descriptors for use by procstat(1), et al.
3648 sysctl_kern_proc_filedesc(SYSCTL_HANDLER_ARGS)
3653 int error, error2, *name;
3657 sbuf_new_for_sysctl(&sb, NULL, FILEDESC_SBUF_SIZE, req);
3658 sbuf_clear_flags(&sb, SBUF_INCLUDENUL);
3659 error = pget((pid_t)name[0], PGET_CANDEBUG | PGET_NOTWEXIT, &p);
3664 maxlen = req->oldptr != NULL ? req->oldlen : -1;
3665 error = kern_proc_filedesc_out(p, &sb, maxlen,
3666 KERN_FILEDESC_PACK_KINFO);
3667 error2 = sbuf_finish(&sb);
3669 return (error != 0 ? error : error2);
3672 #ifdef COMPAT_FREEBSD7
3673 #ifdef KINFO_OFILE_SIZE
3674 CTASSERT(sizeof(struct kinfo_ofile) == KINFO_OFILE_SIZE);
3678 kinfo_to_okinfo(struct kinfo_file *kif, struct kinfo_ofile *okif)
3681 okif->kf_structsize = sizeof(*okif);
3682 okif->kf_type = kif->kf_type;
3683 okif->kf_fd = kif->kf_fd;
3684 okif->kf_ref_count = kif->kf_ref_count;
3685 okif->kf_flags = kif->kf_flags & (KF_FLAG_READ | KF_FLAG_WRITE |
3686 KF_FLAG_APPEND | KF_FLAG_ASYNC | KF_FLAG_FSYNC | KF_FLAG_NONBLOCK |
3687 KF_FLAG_DIRECT | KF_FLAG_HASLOCK);
3688 okif->kf_offset = kif->kf_offset;
3689 if (kif->kf_type == KF_TYPE_VNODE)
3690 okif->kf_vnode_type = kif->kf_un.kf_file.kf_file_type;
3692 okif->kf_vnode_type = KF_VTYPE_VNON;
3693 strlcpy(okif->kf_path, kif->kf_path, sizeof(okif->kf_path));
3694 if (kif->kf_type == KF_TYPE_SOCKET) {
3695 okif->kf_sock_domain = kif->kf_un.kf_sock.kf_sock_domain0;
3696 okif->kf_sock_type = kif->kf_un.kf_sock.kf_sock_type0;
3697 okif->kf_sock_protocol = kif->kf_un.kf_sock.kf_sock_protocol0;
3698 okif->kf_sa_local = kif->kf_un.kf_sock.kf_sa_local;
3699 okif->kf_sa_peer = kif->kf_un.kf_sock.kf_sa_peer;
3701 okif->kf_sa_local.ss_family = AF_UNSPEC;
3702 okif->kf_sa_peer.ss_family = AF_UNSPEC;
3707 export_vnode_for_osysctl(struct vnode *vp, int type, struct kinfo_file *kif,
3708 struct kinfo_ofile *okif, struct filedesc *fdp, struct sysctl_req *req)
3713 FILEDESC_SUNLOCK(fdp);
3714 export_vnode_to_kinfo(vp, type, 0, kif, KERN_FILEDESC_PACK_KINFO);
3715 kinfo_to_okinfo(kif, okif);
3716 error = SYSCTL_OUT(req, okif, sizeof(*okif));
3717 FILEDESC_SLOCK(fdp);
3722 * Get per-process file descriptors for use by procstat(1), et al.
3725 sysctl_kern_proc_ofiledesc(SYSCTL_HANDLER_ARGS)
3727 struct kinfo_ofile *okif;
3728 struct kinfo_file *kif;
3729 struct filedesc *fdp;
3730 int error, i, *name;
3735 error = pget((pid_t)name[0], PGET_CANDEBUG | PGET_NOTWEXIT, &p);
3742 kif = malloc(sizeof(*kif), M_TEMP, M_WAITOK);
3743 okif = malloc(sizeof(*okif), M_TEMP, M_WAITOK);
3744 FILEDESC_SLOCK(fdp);
3745 if (fdp->fd_cdir != NULL)
3746 export_vnode_for_osysctl(fdp->fd_cdir, KF_FD_TYPE_CWD, kif,
3748 if (fdp->fd_rdir != NULL)
3749 export_vnode_for_osysctl(fdp->fd_rdir, KF_FD_TYPE_ROOT, kif,
3751 if (fdp->fd_jdir != NULL)
3752 export_vnode_for_osysctl(fdp->fd_jdir, KF_FD_TYPE_JAIL, kif,
3754 for (i = 0; fdp->fd_refcnt > 0 && i <= fdp->fd_lastfile; i++) {
3755 if ((fp = fdp->fd_ofiles[i].fde_file) == NULL)
3757 export_file_to_kinfo(fp, i, NULL, kif, fdp,
3758 KERN_FILEDESC_PACK_KINFO);
3759 FILEDESC_SUNLOCK(fdp);
3760 kinfo_to_okinfo(kif, okif);
3761 error = SYSCTL_OUT(req, okif, sizeof(*okif));
3762 FILEDESC_SLOCK(fdp);
3766 FILEDESC_SUNLOCK(fdp);
3773 static SYSCTL_NODE(_kern_proc, KERN_PROC_OFILEDESC, ofiledesc,
3774 CTLFLAG_RD|CTLFLAG_MPSAFE, sysctl_kern_proc_ofiledesc,
3775 "Process ofiledesc entries");
3776 #endif /* COMPAT_FREEBSD7 */
3779 vntype_to_kinfo(int vtype)
3784 } vtypes_table[] = {
3785 { VBAD, KF_VTYPE_VBAD },
3786 { VBLK, KF_VTYPE_VBLK },
3787 { VCHR, KF_VTYPE_VCHR },
3788 { VDIR, KF_VTYPE_VDIR },
3789 { VFIFO, KF_VTYPE_VFIFO },
3790 { VLNK, KF_VTYPE_VLNK },
3791 { VNON, KF_VTYPE_VNON },
3792 { VREG, KF_VTYPE_VREG },
3793 { VSOCK, KF_VTYPE_VSOCK }
3798 * Perform vtype translation.
3800 for (i = 0; i < nitems(vtypes_table); i++)
3801 if (vtypes_table[i].vtype == vtype)
3802 return (vtypes_table[i].kf_vtype);
3804 return (KF_VTYPE_UNKNOWN);
3807 static SYSCTL_NODE(_kern_proc, KERN_PROC_FILEDESC, filedesc,
3808 CTLFLAG_RD|CTLFLAG_MPSAFE, sysctl_kern_proc_filedesc,
3809 "Process filedesc entries");
3812 * Store a process current working directory information to sbuf.
3814 * Takes a locked proc as argument, and returns with the proc unlocked.
3817 kern_proc_cwd_out(struct proc *p, struct sbuf *sb, ssize_t maxlen)
3819 struct filedesc *fdp;
3820 struct export_fd_buf *efbuf;
3823 PROC_LOCK_ASSERT(p, MA_OWNED);
3830 efbuf = malloc(sizeof(*efbuf), M_TEMP, M_WAITOK);
3833 efbuf->remainder = maxlen;
3835 FILEDESC_SLOCK(fdp);
3836 if (fdp->fd_cdir == NULL)
3839 vrefact(fdp->fd_cdir);
3840 error = export_vnode_to_sb(fdp->fd_cdir, KF_FD_TYPE_CWD,
3843 FILEDESC_SUNLOCK(fdp);
3845 free(efbuf, M_TEMP);
3850 * Get per-process current working directory.
3853 sysctl_kern_proc_cwd(SYSCTL_HANDLER_ARGS)
3858 int error, error2, *name;
3862 sbuf_new_for_sysctl(&sb, NULL, sizeof(struct kinfo_file), req);
3863 sbuf_clear_flags(&sb, SBUF_INCLUDENUL);
3864 error = pget((pid_t)name[0], PGET_CANDEBUG | PGET_NOTWEXIT, &p);
3869 maxlen = req->oldptr != NULL ? req->oldlen : -1;
3870 error = kern_proc_cwd_out(p, &sb, maxlen);
3871 error2 = sbuf_finish(&sb);
3873 return (error != 0 ? error : error2);
3876 static SYSCTL_NODE(_kern_proc, KERN_PROC_CWD, cwd, CTLFLAG_RD|CTLFLAG_MPSAFE,
3877 sysctl_kern_proc_cwd, "Process current working directory");
3881 * For the purposes of debugging, generate a human-readable string for the
3885 file_type_to_name(short type)
3913 case DTYPE_PROCDESC:
3915 case DTYPE_LINUXEFD:
3917 case DTYPE_LINUXTFD:
3925 * For the purposes of debugging, identify a process (if any, perhaps one of
3926 * many) that references the passed file in its file descriptor array. Return
3929 static struct proc *
3930 file_to_first_proc(struct file *fp)
3932 struct filedesc *fdp;
3936 FOREACH_PROC_IN_SYSTEM(p) {
3937 if (p->p_state == PRS_NEW)
3942 for (n = 0; n <= fdp->fd_lastfile; n++) {
3943 if (fp == fdp->fd_ofiles[n].fde_file)
3951 db_print_file(struct file *fp, int header)
3953 #define XPTRWIDTH ((int)howmany(sizeof(void *) * NBBY, 4))
3957 db_printf("%*s %6s %*s %8s %4s %5s %6s %*s %5s %s\n",
3958 XPTRWIDTH, "File", "Type", XPTRWIDTH, "Data", "Flag",
3959 "GCFl", "Count", "MCount", XPTRWIDTH, "Vnode", "FPID",
3961 p = file_to_first_proc(fp);
3962 db_printf("%*p %6s %*p %08x %04x %5d %6d %*p %5d %s\n", XPTRWIDTH,
3963 fp, file_type_to_name(fp->f_type), XPTRWIDTH, fp->f_data,
3964 fp->f_flag, 0, fp->f_count, 0, XPTRWIDTH, fp->f_vnode,
3965 p != NULL ? p->p_pid : -1, p != NULL ? p->p_comm : "-");
3970 DB_SHOW_COMMAND(file, db_show_file)
3975 db_printf("usage: show file <addr>\n");
3978 fp = (struct file *)addr;
3979 db_print_file(fp, 1);
3982 DB_SHOW_COMMAND(files, db_show_files)
3984 struct filedesc *fdp;
3991 FOREACH_PROC_IN_SYSTEM(p) {
3992 if (p->p_state == PRS_NEW)
3994 if ((fdp = p->p_fd) == NULL)
3996 for (n = 0; n <= fdp->fd_lastfile; ++n) {
3997 if ((fp = fdp->fd_ofiles[n].fde_file) == NULL)
3999 db_print_file(fp, header);
4006 SYSCTL_INT(_kern, KERN_MAXFILESPERPROC, maxfilesperproc, CTLFLAG_RW,
4007 &maxfilesperproc, 0, "Maximum files allowed open per process");
4009 SYSCTL_INT(_kern, KERN_MAXFILES, maxfiles, CTLFLAG_RW,
4010 &maxfiles, 0, "Maximum number of files");
4012 SYSCTL_INT(_kern, OID_AUTO, openfiles, CTLFLAG_RD,
4013 __DEVOLATILE(int *, &openfiles), 0, "System-wide number of open files");
4017 filelistinit(void *dummy)
4020 file_zone = uma_zcreate("Files", sizeof(struct file), NULL, NULL,
4021 NULL, NULL, UMA_ALIGN_PTR, UMA_ZONE_NOFREE);
4022 filedesc0_zone = uma_zcreate("filedesc0", sizeof(struct filedesc0),
4023 NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
4024 mtx_init(&sigio_lock, "sigio lock", NULL, MTX_DEF);
4026 SYSINIT(select, SI_SUB_LOCK, SI_ORDER_FIRST, filelistinit, NULL);
4028 /*-------------------------------------------------------------------*/
4031 badfo_readwrite(struct file *fp, struct uio *uio, struct ucred *active_cred,
4032 int flags, struct thread *td)
4039 badfo_truncate(struct file *fp, off_t length, struct ucred *active_cred,
4047 badfo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
4055 badfo_poll(struct file *fp, int events, struct ucred *active_cred,
4063 badfo_kqfilter(struct file *fp, struct knote *kn)
4070 badfo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred,
4078 badfo_close(struct file *fp, struct thread *td)
4085 badfo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
4093 badfo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
4101 badfo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio,
4102 struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags,
4110 badfo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
4116 struct fileops badfileops = {
4117 .fo_read = badfo_readwrite,
4118 .fo_write = badfo_readwrite,
4119 .fo_truncate = badfo_truncate,
4120 .fo_ioctl = badfo_ioctl,
4121 .fo_poll = badfo_poll,
4122 .fo_kqfilter = badfo_kqfilter,
4123 .fo_stat = badfo_stat,
4124 .fo_close = badfo_close,
4125 .fo_chmod = badfo_chmod,
4126 .fo_chown = badfo_chown,
4127 .fo_sendfile = badfo_sendfile,
4128 .fo_fill_kinfo = badfo_fill_kinfo,
4132 invfo_rdwr(struct file *fp, struct uio *uio, struct ucred *active_cred,
4133 int flags, struct thread *td)
4136 return (EOPNOTSUPP);
4140 invfo_truncate(struct file *fp, off_t length, struct ucred *active_cred,
4148 invfo_ioctl(struct file *fp, u_long com, void *data,
4149 struct ucred *active_cred, struct thread *td)
4156 invfo_poll(struct file *fp, int events, struct ucred *active_cred,
4160 return (poll_no_poll(events));
4164 invfo_kqfilter(struct file *fp, struct knote *kn)
4171 invfo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
4179 invfo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
4187 invfo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio,
4188 struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags,
4195 /*-------------------------------------------------------------------*/
4198 * File Descriptor pseudo-device driver (/dev/fd/).
4200 * Opening minor device N dup()s the file (if any) connected to file
4201 * descriptor N belonging to the calling process. Note that this driver
4202 * consists of only the ``open()'' routine, because all subsequent
4203 * references to this file will be direct to the other driver.
4205 * XXX: we could give this one a cloning event handler if necessary.
4210 fdopen(struct cdev *dev, int mode, int type, struct thread *td)
4214 * XXX Kludge: set curthread->td_dupfd to contain the value of the
4215 * the file descriptor being sought for duplication. The error
4216 * return ensures that the vnode for this device will be released
4217 * by vn_open. Open will detect this special error and take the
4218 * actions in dupfdopen below. Other callers of vn_open or VOP_OPEN
4219 * will simply report the error.
4221 td->td_dupfd = dev2unit(dev);
4225 static struct cdevsw fildesc_cdevsw = {
4226 .d_version = D_VERSION,
4232 fildesc_drvinit(void *unused)
4236 dev = make_dev_credf(MAKEDEV_ETERNAL, &fildesc_cdevsw, 0, NULL,
4237 UID_ROOT, GID_WHEEL, 0666, "fd/0");
4238 make_dev_alias(dev, "stdin");
4239 dev = make_dev_credf(MAKEDEV_ETERNAL, &fildesc_cdevsw, 1, NULL,
4240 UID_ROOT, GID_WHEEL, 0666, "fd/1");
4241 make_dev_alias(dev, "stdout");
4242 dev = make_dev_credf(MAKEDEV_ETERNAL, &fildesc_cdevsw, 2, NULL,
4243 UID_ROOT, GID_WHEEL, 0666, "fd/2");
4244 make_dev_alias(dev, "stderr");
4247 SYSINIT(fildescdev, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, fildesc_drvinit, NULL);