kern_descrip.c revision 183808
1/*-
2 * Copyright (c) 1982, 1986, 1989, 1991, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 4. Neither the name of the University nor the names of its contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 *	@(#)kern_descrip.c	8.6 (Berkeley) 4/19/94
35 */
36
37#include <sys/cdefs.h>
38__FBSDID("$FreeBSD: head/sys/kern/kern_descrip.c 183808 2008-10-12 20:03:17Z rwatson $");
39
40#include "opt_compat.h"
41#include "opt_ddb.h"
42#include "opt_ktrace.h"
43
44#include <sys/param.h>
45#include <sys/systm.h>
46
47#include <sys/conf.h>
48#include <sys/domain.h>
49#include <sys/fcntl.h>
50#include <sys/file.h>
51#include <sys/filedesc.h>
52#include <sys/filio.h>
53#include <sys/jail.h>
54#include <sys/kernel.h>
55#include <sys/limits.h>
56#include <sys/lock.h>
57#include <sys/malloc.h>
58#include <sys/mount.h>
59#include <sys/mqueue.h>
60#include <sys/mutex.h>
61#include <sys/namei.h>
62#include <sys/priv.h>
63#include <sys/proc.h>
64#include <sys/protosw.h>
65#include <sys/resourcevar.h>
66#include <sys/signalvar.h>
67#include <sys/socketvar.h>
68#include <sys/stat.h>
69#include <sys/sx.h>
70#include <sys/syscallsubr.h>
71#include <sys/sysctl.h>
72#include <sys/sysproto.h>
73#include <sys/tty.h>
74#include <sys/unistd.h>
75#include <sys/user.h>
76#include <sys/vnode.h>
77#ifdef KTRACE
78#include <sys/ktrace.h>
79#endif
80
81#include <security/audit/audit.h>
82
83#include <vm/uma.h>
84
85#include <ddb/ddb.h>
86
87static MALLOC_DEFINE(M_FILEDESC, "filedesc", "Open file descriptor table");
88static MALLOC_DEFINE(M_FILEDESC_TO_LEADER, "filedesc_to_leader",
89		     "file desc to leader structures");
90static MALLOC_DEFINE(M_SIGIO, "sigio", "sigio structures");
91
92static uma_zone_t file_zone;
93
94
95/* Flags for do_dup() */
96#define DUP_FIXED	0x1	/* Force fixed allocation */
97#define DUP_FCNTL	0x2	/* fcntl()-style errors */
98
99static int do_dup(struct thread *td, int flags, int old, int new,
100    register_t *retval);
101static int	fd_first_free(struct filedesc *, int, int);
102static int	fd_last_used(struct filedesc *, int, int);
103static void	fdgrowtable(struct filedesc *, int);
104static void	fdunused(struct filedesc *fdp, int fd);
105static void	fdused(struct filedesc *fdp, int fd);
106
107/*
108 * A process is initially started out with NDFILE descriptors stored within
109 * this structure, selected to be enough for typical applications based on
110 * the historical limit of 20 open files (and the usage of descriptors by
111 * shells).  If these descriptors are exhausted, a larger descriptor table
112 * may be allocated, up to a process' resource limit; the internal arrays
113 * are then unused.
114 */
115#define NDFILE		20
116#define NDSLOTSIZE	sizeof(NDSLOTTYPE)
117#define	NDENTRIES	(NDSLOTSIZE * __CHAR_BIT)
118#define NDSLOT(x)	((x) / NDENTRIES)
119#define NDBIT(x)	((NDSLOTTYPE)1 << ((x) % NDENTRIES))
120#define	NDSLOTS(x)	(((x) + NDENTRIES - 1) / NDENTRIES)
121
122/*
123 * Storage required per open file descriptor.
124 */
125#define OFILESIZE (sizeof(struct file *) + sizeof(char))
126
127/*
128 * Basic allocation of descriptors:
129 * one of the above, plus arrays for NDFILE descriptors.
130 */
131struct filedesc0 {
132	struct	filedesc fd_fd;
133	/*
134	 * These arrays are used when the number of open files is
135	 * <= NDFILE, and are then pointed to by the pointers above.
136	 */
137	struct	file *fd_dfiles[NDFILE];
138	char	fd_dfileflags[NDFILE];
139	NDSLOTTYPE fd_dmap[NDSLOTS(NDFILE)];
140};
141
142/*
143 * Descriptor management.
144 */
145volatile int openfiles;			/* actual number of open files */
146struct mtx sigio_lock;		/* mtx to protect pointers to sigio */
147void	(*mq_fdclose)(struct thread *td, int fd, struct file *fp);
148
149/* A mutex to protect the association between a proc and filedesc. */
150static struct mtx	fdesc_mtx;
151
152/*
153 * Find the first zero bit in the given bitmap, starting at low and not
154 * exceeding size - 1.
155 */
156static int
157fd_first_free(struct filedesc *fdp, int low, int size)
158{
159	NDSLOTTYPE *map = fdp->fd_map;
160	NDSLOTTYPE mask;
161	int off, maxoff;
162
163	if (low >= size)
164		return (low);
165
166	off = NDSLOT(low);
167	if (low % NDENTRIES) {
168		mask = ~(~(NDSLOTTYPE)0 >> (NDENTRIES - (low % NDENTRIES)));
169		if ((mask &= ~map[off]) != 0UL)
170			return (off * NDENTRIES + ffsl(mask) - 1);
171		++off;
172	}
173	for (maxoff = NDSLOTS(size); off < maxoff; ++off)
174		if (map[off] != ~0UL)
175			return (off * NDENTRIES + ffsl(~map[off]) - 1);
176	return (size);
177}
178
179/*
180 * Find the highest non-zero bit in the given bitmap, starting at low and
181 * not exceeding size - 1.
182 */
183static int
184fd_last_used(struct filedesc *fdp, int low, int size)
185{
186	NDSLOTTYPE *map = fdp->fd_map;
187	NDSLOTTYPE mask;
188	int off, minoff;
189
190	if (low >= size)
191		return (-1);
192
193	off = NDSLOT(size);
194	if (size % NDENTRIES) {
195		mask = ~(~(NDSLOTTYPE)0 << (size % NDENTRIES));
196		if ((mask &= map[off]) != 0)
197			return (off * NDENTRIES + flsl(mask) - 1);
198		--off;
199	}
200	for (minoff = NDSLOT(low); off >= minoff; --off)
201		if (map[off] != 0)
202			return (off * NDENTRIES + flsl(map[off]) - 1);
203	return (low - 1);
204}
205
206static int
207fdisused(struct filedesc *fdp, int fd)
208{
209        KASSERT(fd >= 0 && fd < fdp->fd_nfiles,
210            ("file descriptor %d out of range (0, %d)", fd, fdp->fd_nfiles));
211	return ((fdp->fd_map[NDSLOT(fd)] & NDBIT(fd)) != 0);
212}
213
214/*
215 * Mark a file descriptor as used.
216 */
217static void
218fdused(struct filedesc *fdp, int fd)
219{
220
221	FILEDESC_XLOCK_ASSERT(fdp);
222	KASSERT(!fdisused(fdp, fd),
223	    ("fd already used"));
224
225	fdp->fd_map[NDSLOT(fd)] |= NDBIT(fd);
226	if (fd > fdp->fd_lastfile)
227		fdp->fd_lastfile = fd;
228	if (fd == fdp->fd_freefile)
229		fdp->fd_freefile = fd_first_free(fdp, fd, fdp->fd_nfiles);
230}
231
232/*
233 * Mark a file descriptor as unused.
234 */
235static void
236fdunused(struct filedesc *fdp, int fd)
237{
238
239	FILEDESC_XLOCK_ASSERT(fdp);
240	KASSERT(fdisused(fdp, fd),
241	    ("fd is already unused"));
242	KASSERT(fdp->fd_ofiles[fd] == NULL,
243	    ("fd is still in use"));
244
245	fdp->fd_map[NDSLOT(fd)] &= ~NDBIT(fd);
246	if (fd < fdp->fd_freefile)
247		fdp->fd_freefile = fd;
248	if (fd == fdp->fd_lastfile)
249		fdp->fd_lastfile = fd_last_used(fdp, 0, fd);
250}
251
252/*
253 * System calls on descriptors.
254 */
255#ifndef _SYS_SYSPROTO_H_
256struct getdtablesize_args {
257	int	dummy;
258};
259#endif
260/* ARGSUSED */
261int
262getdtablesize(struct thread *td, struct getdtablesize_args *uap)
263{
264	struct proc *p = td->td_proc;
265
266	PROC_LOCK(p);
267	td->td_retval[0] =
268	    min((int)lim_cur(p, RLIMIT_NOFILE), maxfilesperproc);
269	PROC_UNLOCK(p);
270	return (0);
271}
272
273/*
274 * Duplicate a file descriptor to a particular value.
275 *
276 * Note: keep in mind that a potential race condition exists when closing
277 * descriptors from a shared descriptor table (via rfork).
278 */
279#ifndef _SYS_SYSPROTO_H_
280struct dup2_args {
281	u_int	from;
282	u_int	to;
283};
284#endif
285/* ARGSUSED */
286int
287dup2(struct thread *td, struct dup2_args *uap)
288{
289
290	return (do_dup(td, DUP_FIXED, (int)uap->from, (int)uap->to,
291		    td->td_retval));
292}
293
294/*
295 * Duplicate a file descriptor.
296 */
297#ifndef _SYS_SYSPROTO_H_
298struct dup_args {
299	u_int	fd;
300};
301#endif
302/* ARGSUSED */
303int
304dup(struct thread *td, struct dup_args *uap)
305{
306
307	return (do_dup(td, 0, (int)uap->fd, 0, td->td_retval));
308}
309
310/*
311 * The file control system call.
312 */
313#ifndef _SYS_SYSPROTO_H_
314struct fcntl_args {
315	int	fd;
316	int	cmd;
317	long	arg;
318};
319#endif
320/* ARGSUSED */
321int
322fcntl(struct thread *td, struct fcntl_args *uap)
323{
324	struct flock fl;
325	struct oflock ofl;
326	intptr_t arg;
327	int error;
328	int cmd;
329
330	error = 0;
331	cmd = uap->cmd;
332	switch (uap->cmd) {
333	case F_OGETLK:
334	case F_OSETLK:
335	case F_OSETLKW:
336		/*
337		 * Convert old flock structure to new.
338		 */
339		error = copyin((void *)(intptr_t)uap->arg, &ofl, sizeof(ofl));
340		fl.l_start = ofl.l_start;
341		fl.l_len = ofl.l_len;
342		fl.l_pid = ofl.l_pid;
343		fl.l_type = ofl.l_type;
344		fl.l_whence = ofl.l_whence;
345		fl.l_sysid = 0;
346
347		switch (uap->cmd) {
348		case F_OGETLK:
349		    cmd = F_GETLK;
350		    break;
351		case F_OSETLK:
352		    cmd = F_SETLK;
353		    break;
354		case F_OSETLKW:
355		    cmd = F_SETLKW;
356		    break;
357		}
358		arg = (intptr_t)&fl;
359		break;
360        case F_GETLK:
361        case F_SETLK:
362        case F_SETLKW:
363	case F_SETLK_REMOTE:
364                error = copyin((void *)(intptr_t)uap->arg, &fl, sizeof(fl));
365                arg = (intptr_t)&fl;
366                break;
367	default:
368		arg = uap->arg;
369		break;
370	}
371	if (error)
372		return (error);
373	error = kern_fcntl(td, uap->fd, cmd, arg);
374	if (error)
375		return (error);
376	if (uap->cmd == F_OGETLK) {
377		ofl.l_start = fl.l_start;
378		ofl.l_len = fl.l_len;
379		ofl.l_pid = fl.l_pid;
380		ofl.l_type = fl.l_type;
381		ofl.l_whence = fl.l_whence;
382		error = copyout(&ofl, (void *)(intptr_t)uap->arg, sizeof(ofl));
383	} else if (uap->cmd == F_GETLK) {
384		error = copyout(&fl, (void *)(intptr_t)uap->arg, sizeof(fl));
385	}
386	return (error);
387}
388
389static inline struct file *
390fdtofp(int fd, struct filedesc *fdp)
391{
392	struct file *fp;
393
394	FILEDESC_LOCK_ASSERT(fdp);
395	if ((unsigned)fd >= fdp->fd_nfiles ||
396	    (fp = fdp->fd_ofiles[fd]) == NULL)
397		return (NULL);
398	return (fp);
399}
400
401int
402kern_fcntl(struct thread *td, int fd, int cmd, intptr_t arg)
403{
404	struct filedesc *fdp;
405	struct flock *flp;
406	struct file *fp;
407	struct proc *p;
408	char *pop;
409	struct vnode *vp;
410	int error, flg, tmp;
411	int vfslocked;
412
413	vfslocked = 0;
414	error = 0;
415	flg = F_POSIX;
416	p = td->td_proc;
417	fdp = p->p_fd;
418
419	switch (cmd) {
420	case F_DUPFD:
421		tmp = arg;
422		error = do_dup(td, DUP_FCNTL, fd, tmp, td->td_retval);
423		break;
424
425	case F_DUP2FD:
426		tmp = arg;
427		error = do_dup(td, DUP_FIXED, fd, tmp, td->td_retval);
428		break;
429
430	case F_GETFD:
431		FILEDESC_SLOCK(fdp);
432		if ((fp = fdtofp(fd, fdp)) == NULL) {
433			FILEDESC_SUNLOCK(fdp);
434			error = EBADF;
435			break;
436		}
437		pop = &fdp->fd_ofileflags[fd];
438		td->td_retval[0] = (*pop & UF_EXCLOSE) ? FD_CLOEXEC : 0;
439		FILEDESC_SUNLOCK(fdp);
440		break;
441
442	case F_SETFD:
443		FILEDESC_XLOCK(fdp);
444		if ((fp = fdtofp(fd, fdp)) == NULL) {
445			FILEDESC_XUNLOCK(fdp);
446			error = EBADF;
447			break;
448		}
449		pop = &fdp->fd_ofileflags[fd];
450		*pop = (*pop &~ UF_EXCLOSE) |
451		    (arg & FD_CLOEXEC ? UF_EXCLOSE : 0);
452		FILEDESC_XUNLOCK(fdp);
453		break;
454
455	case F_GETFL:
456		FILEDESC_SLOCK(fdp);
457		if ((fp = fdtofp(fd, fdp)) == NULL) {
458			FILEDESC_SUNLOCK(fdp);
459			error = EBADF;
460			break;
461		}
462		td->td_retval[0] = OFLAGS(fp->f_flag);
463		FILEDESC_SUNLOCK(fdp);
464		break;
465
466	case F_SETFL:
467		FILEDESC_SLOCK(fdp);
468		if ((fp = fdtofp(fd, fdp)) == NULL) {
469			FILEDESC_SUNLOCK(fdp);
470			error = EBADF;
471			break;
472		}
473		fhold(fp);
474		FILEDESC_SUNLOCK(fdp);
475		do {
476			tmp = flg = fp->f_flag;
477			tmp &= ~FCNTLFLAGS;
478			tmp |= FFLAGS(arg & ~O_ACCMODE) & FCNTLFLAGS;
479		} while(atomic_cmpset_int(&fp->f_flag, flg, tmp) == 0);
480		tmp = fp->f_flag & FNONBLOCK;
481		error = fo_ioctl(fp, FIONBIO, &tmp, td->td_ucred, td);
482		if (error) {
483			fdrop(fp, td);
484			break;
485		}
486		tmp = fp->f_flag & FASYNC;
487		error = fo_ioctl(fp, FIOASYNC, &tmp, td->td_ucred, td);
488		if (error == 0) {
489			fdrop(fp, td);
490			break;
491		}
492		atomic_clear_int(&fp->f_flag, FNONBLOCK);
493		tmp = 0;
494		(void)fo_ioctl(fp, FIONBIO, &tmp, td->td_ucred, td);
495		fdrop(fp, td);
496		break;
497
498	case F_GETOWN:
499		FILEDESC_SLOCK(fdp);
500		if ((fp = fdtofp(fd, fdp)) == NULL) {
501			FILEDESC_SUNLOCK(fdp);
502			error = EBADF;
503			break;
504		}
505		fhold(fp);
506		FILEDESC_SUNLOCK(fdp);
507		error = fo_ioctl(fp, FIOGETOWN, &tmp, td->td_ucred, td);
508		if (error == 0)
509			td->td_retval[0] = tmp;
510		fdrop(fp, td);
511		break;
512
513	case F_SETOWN:
514		FILEDESC_SLOCK(fdp);
515		if ((fp = fdtofp(fd, fdp)) == NULL) {
516			FILEDESC_SUNLOCK(fdp);
517			error = EBADF;
518			break;
519		}
520		fhold(fp);
521		FILEDESC_SUNLOCK(fdp);
522		tmp = arg;
523		error = fo_ioctl(fp, FIOSETOWN, &tmp, td->td_ucred, td);
524		fdrop(fp, td);
525		break;
526
527	case F_SETLK_REMOTE:
528		error = priv_check(td, PRIV_NFS_LOCKD);
529		if (error)
530			return (error);
531		flg = F_REMOTE;
532		goto do_setlk;
533
534	case F_SETLKW:
535		flg |= F_WAIT;
536		/* FALLTHROUGH F_SETLK */
537
538	case F_SETLK:
539	do_setlk:
540		FILEDESC_SLOCK(fdp);
541		if ((fp = fdtofp(fd, fdp)) == NULL) {
542			FILEDESC_SUNLOCK(fdp);
543			error = EBADF;
544			break;
545		}
546		if (fp->f_type != DTYPE_VNODE) {
547			FILEDESC_SUNLOCK(fdp);
548			error = EBADF;
549			break;
550		}
551		flp = (struct flock *)arg;
552		if (flp->l_whence == SEEK_CUR) {
553			if (fp->f_offset < 0 ||
554			    (flp->l_start > 0 &&
555			     fp->f_offset > OFF_MAX - flp->l_start)) {
556				FILEDESC_SUNLOCK(fdp);
557				error = EOVERFLOW;
558				break;
559			}
560			flp->l_start += fp->f_offset;
561		}
562
563		/*
564		 * VOP_ADVLOCK() may block.
565		 */
566		fhold(fp);
567		FILEDESC_SUNLOCK(fdp);
568		vp = fp->f_vnode;
569		vfslocked = VFS_LOCK_GIANT(vp->v_mount);
570		switch (flp->l_type) {
571		case F_RDLCK:
572			if ((fp->f_flag & FREAD) == 0) {
573				error = EBADF;
574				break;
575			}
576			PROC_LOCK(p->p_leader);
577			p->p_leader->p_flag |= P_ADVLOCK;
578			PROC_UNLOCK(p->p_leader);
579			error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader, F_SETLK,
580			    flp, flg);
581			break;
582		case F_WRLCK:
583			if ((fp->f_flag & FWRITE) == 0) {
584				error = EBADF;
585				break;
586			}
587			PROC_LOCK(p->p_leader);
588			p->p_leader->p_flag |= P_ADVLOCK;
589			PROC_UNLOCK(p->p_leader);
590			error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader, F_SETLK,
591			    flp, flg);
592			break;
593		case F_UNLCK:
594			error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader, F_UNLCK,
595			    flp, flg);
596			break;
597		case F_UNLCKSYS:
598			/*
599			 * Temporary api for testing remote lock
600			 * infrastructure.
601			 */
602			if (flg != F_REMOTE) {
603				error = EINVAL;
604				break;
605			}
606			error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader,
607			    F_UNLCKSYS, flp, flg);
608			break;
609		default:
610			error = EINVAL;
611			break;
612		}
613		VFS_UNLOCK_GIANT(vfslocked);
614		vfslocked = 0;
615		/* Check for race with close */
616		FILEDESC_SLOCK(fdp);
617		if ((unsigned) fd >= fdp->fd_nfiles ||
618		    fp != fdp->fd_ofiles[fd]) {
619			FILEDESC_SUNLOCK(fdp);
620			flp->l_whence = SEEK_SET;
621			flp->l_start = 0;
622			flp->l_len = 0;
623			flp->l_type = F_UNLCK;
624			vfslocked = VFS_LOCK_GIANT(vp->v_mount);
625			(void) VOP_ADVLOCK(vp, (caddr_t)p->p_leader,
626					   F_UNLCK, flp, F_POSIX);
627			VFS_UNLOCK_GIANT(vfslocked);
628			vfslocked = 0;
629		} else
630			FILEDESC_SUNLOCK(fdp);
631		fdrop(fp, td);
632		break;
633
634	case F_GETLK:
635		FILEDESC_SLOCK(fdp);
636		if ((fp = fdtofp(fd, fdp)) == NULL) {
637			FILEDESC_SUNLOCK(fdp);
638			error = EBADF;
639			break;
640		}
641		if (fp->f_type != DTYPE_VNODE) {
642			FILEDESC_SUNLOCK(fdp);
643			error = EBADF;
644			break;
645		}
646		flp = (struct flock *)arg;
647		if (flp->l_type != F_RDLCK && flp->l_type != F_WRLCK &&
648		    flp->l_type != F_UNLCK) {
649			FILEDESC_SUNLOCK(fdp);
650			error = EINVAL;
651			break;
652		}
653		if (flp->l_whence == SEEK_CUR) {
654			if ((flp->l_start > 0 &&
655			    fp->f_offset > OFF_MAX - flp->l_start) ||
656			    (flp->l_start < 0 &&
657			     fp->f_offset < OFF_MIN - flp->l_start)) {
658				FILEDESC_SUNLOCK(fdp);
659				error = EOVERFLOW;
660				break;
661			}
662			flp->l_start += fp->f_offset;
663		}
664		/*
665		 * VOP_ADVLOCK() may block.
666		 */
667		fhold(fp);
668		FILEDESC_SUNLOCK(fdp);
669		vp = fp->f_vnode;
670		vfslocked = VFS_LOCK_GIANT(vp->v_mount);
671		error = VOP_ADVLOCK(vp, (caddr_t)p->p_leader, F_GETLK, flp,
672		    F_POSIX);
673		VFS_UNLOCK_GIANT(vfslocked);
674		vfslocked = 0;
675		fdrop(fp, td);
676		break;
677	default:
678		error = EINVAL;
679		break;
680	}
681	VFS_UNLOCK_GIANT(vfslocked);
682	return (error);
683}
684
685/*
686 * Common code for dup, dup2, fcntl(F_DUPFD) and fcntl(F_DUP2FD).
687 */
688static int
689do_dup(struct thread *td, int flags, int old, int new,
690    register_t *retval)
691{
692	struct filedesc *fdp;
693	struct proc *p;
694	struct file *fp;
695	struct file *delfp;
696	int error, holdleaders, maxfd;
697
698	p = td->td_proc;
699	fdp = p->p_fd;
700
701	/*
702	 * Verify we have a valid descriptor to dup from and possibly to
703	 * dup to. Unlike dup() and dup2(), fcntl()'s F_DUPFD should
704	 * return EINVAL when the new descriptor is out of bounds.
705	 */
706	if (old < 0)
707		return (EBADF);
708	if (new < 0)
709		return (flags & DUP_FCNTL ? EINVAL : EBADF);
710	PROC_LOCK(p);
711	maxfd = min((int)lim_cur(p, RLIMIT_NOFILE), maxfilesperproc);
712	PROC_UNLOCK(p);
713	if (new >= maxfd)
714		return (flags & DUP_FCNTL ? EINVAL : EMFILE);
715
716	FILEDESC_XLOCK(fdp);
717	if (old >= fdp->fd_nfiles || fdp->fd_ofiles[old] == NULL) {
718		FILEDESC_XUNLOCK(fdp);
719		return (EBADF);
720	}
721	if (flags & DUP_FIXED && old == new) {
722		*retval = new;
723		FILEDESC_XUNLOCK(fdp);
724		return (0);
725	}
726	fp = fdp->fd_ofiles[old];
727	fhold(fp);
728
729	/*
730	 * If the caller specified a file descriptor, make sure the file
731	 * table is large enough to hold it, and grab it.  Otherwise, just
732	 * allocate a new descriptor the usual way.  Since the filedesc
733	 * lock may be temporarily dropped in the process, we have to look
734	 * out for a race.
735	 */
736	if (flags & DUP_FIXED) {
737		if (new >= fdp->fd_nfiles)
738			fdgrowtable(fdp, new + 1);
739		if (fdp->fd_ofiles[new] == NULL)
740			fdused(fdp, new);
741	} else {
742		if ((error = fdalloc(td, new, &new)) != 0) {
743			FILEDESC_XUNLOCK(fdp);
744			fdrop(fp, td);
745			return (error);
746		}
747	}
748
749	/*
750	 * If the old file changed out from under us then treat it as a
751	 * bad file descriptor.  Userland should do its own locking to
752	 * avoid this case.
753	 */
754	if (fdp->fd_ofiles[old] != fp) {
755		/* we've allocated a descriptor which we won't use */
756		if (fdp->fd_ofiles[new] == NULL)
757			fdunused(fdp, new);
758		FILEDESC_XUNLOCK(fdp);
759		fdrop(fp, td);
760		return (EBADF);
761	}
762	KASSERT(old != new,
763	    ("new fd is same as old"));
764
765	/*
766	 * Save info on the descriptor being overwritten.  We cannot close
767	 * it without introducing an ownership race for the slot, since we
768	 * need to drop the filedesc lock to call closef().
769	 *
770	 * XXX this duplicates parts of close().
771	 */
772	delfp = fdp->fd_ofiles[new];
773	holdleaders = 0;
774	if (delfp != NULL) {
775		if (td->td_proc->p_fdtol != NULL) {
776			/*
777			 * Ask fdfree() to sleep to ensure that all relevant
778			 * process leaders can be traversed in closef().
779			 */
780			fdp->fd_holdleaderscount++;
781			holdleaders = 1;
782		}
783	}
784
785	/*
786	 * Duplicate the source descriptor
787	 */
788	fdp->fd_ofiles[new] = fp;
789	fdp->fd_ofileflags[new] = fdp->fd_ofileflags[old] &~ UF_EXCLOSE;
790	if (new > fdp->fd_lastfile)
791		fdp->fd_lastfile = new;
792	*retval = new;
793
794	/*
795	 * If we dup'd over a valid file, we now own the reference to it
796	 * and must dispose of it using closef() semantics (as if a
797	 * close() were performed on it).
798	 *
799	 * XXX this duplicates parts of close().
800	 */
801	if (delfp != NULL) {
802		knote_fdclose(td, new);
803		if (delfp->f_type == DTYPE_MQUEUE)
804			mq_fdclose(td, new, delfp);
805		FILEDESC_XUNLOCK(fdp);
806		(void) closef(delfp, td);
807		if (holdleaders) {
808			FILEDESC_XLOCK(fdp);
809			fdp->fd_holdleaderscount--;
810			if (fdp->fd_holdleaderscount == 0 &&
811			    fdp->fd_holdleaderswakeup != 0) {
812				fdp->fd_holdleaderswakeup = 0;
813				wakeup(&fdp->fd_holdleaderscount);
814			}
815			FILEDESC_XUNLOCK(fdp);
816		}
817	} else {
818		FILEDESC_XUNLOCK(fdp);
819	}
820	return (0);
821}
822
823/*
824 * If sigio is on the list associated with a process or process group,
825 * disable signalling from the device, remove sigio from the list and
826 * free sigio.
827 */
828void
829funsetown(struct sigio **sigiop)
830{
831	struct sigio *sigio;
832
833	SIGIO_LOCK();
834	sigio = *sigiop;
835	if (sigio == NULL) {
836		SIGIO_UNLOCK();
837		return;
838	}
839	*(sigio->sio_myref) = NULL;
840	if ((sigio)->sio_pgid < 0) {
841		struct pgrp *pg = (sigio)->sio_pgrp;
842		PGRP_LOCK(pg);
843		SLIST_REMOVE(&sigio->sio_pgrp->pg_sigiolst, sigio,
844			     sigio, sio_pgsigio);
845		PGRP_UNLOCK(pg);
846	} else {
847		struct proc *p = (sigio)->sio_proc;
848		PROC_LOCK(p);
849		SLIST_REMOVE(&sigio->sio_proc->p_sigiolst, sigio,
850			     sigio, sio_pgsigio);
851		PROC_UNLOCK(p);
852	}
853	SIGIO_UNLOCK();
854	crfree(sigio->sio_ucred);
855	FREE(sigio, M_SIGIO);
856}
857
858/*
859 * Free a list of sigio structures.
860 * We only need to lock the SIGIO_LOCK because we have made ourselves
861 * inaccessible to callers of fsetown and therefore do not need to lock
862 * the proc or pgrp struct for the list manipulation.
863 */
864void
865funsetownlst(struct sigiolst *sigiolst)
866{
867	struct proc *p;
868	struct pgrp *pg;
869	struct sigio *sigio;
870
871	sigio = SLIST_FIRST(sigiolst);
872	if (sigio == NULL)
873		return;
874	p = NULL;
875	pg = NULL;
876
877	/*
878	 * Every entry of the list should belong
879	 * to a single proc or pgrp.
880	 */
881	if (sigio->sio_pgid < 0) {
882		pg = sigio->sio_pgrp;
883		PGRP_LOCK_ASSERT(pg, MA_NOTOWNED);
884	} else /* if (sigio->sio_pgid > 0) */ {
885		p = sigio->sio_proc;
886		PROC_LOCK_ASSERT(p, MA_NOTOWNED);
887	}
888
889	SIGIO_LOCK();
890	while ((sigio = SLIST_FIRST(sigiolst)) != NULL) {
891		*(sigio->sio_myref) = NULL;
892		if (pg != NULL) {
893			KASSERT(sigio->sio_pgid < 0,
894			    ("Proc sigio in pgrp sigio list"));
895			KASSERT(sigio->sio_pgrp == pg,
896			    ("Bogus pgrp in sigio list"));
897			PGRP_LOCK(pg);
898			SLIST_REMOVE(&pg->pg_sigiolst, sigio, sigio,
899			    sio_pgsigio);
900			PGRP_UNLOCK(pg);
901		} else /* if (p != NULL) */ {
902			KASSERT(sigio->sio_pgid > 0,
903			    ("Pgrp sigio in proc sigio list"));
904			KASSERT(sigio->sio_proc == p,
905			    ("Bogus proc in sigio list"));
906			PROC_LOCK(p);
907			SLIST_REMOVE(&p->p_sigiolst, sigio, sigio,
908			    sio_pgsigio);
909			PROC_UNLOCK(p);
910		}
911		SIGIO_UNLOCK();
912		crfree(sigio->sio_ucred);
913		FREE(sigio, M_SIGIO);
914		SIGIO_LOCK();
915	}
916	SIGIO_UNLOCK();
917}
918
919/*
920 * This is common code for FIOSETOWN ioctl called by fcntl(fd, F_SETOWN, arg).
921 *
922 * After permission checking, add a sigio structure to the sigio list for
923 * the process or process group.
924 */
925int
926fsetown(pid_t pgid, struct sigio **sigiop)
927{
928	struct proc *proc;
929	struct pgrp *pgrp;
930	struct sigio *sigio;
931	int ret;
932
933	if (pgid == 0) {
934		funsetown(sigiop);
935		return (0);
936	}
937
938	ret = 0;
939
940	/* Allocate and fill in the new sigio out of locks. */
941	MALLOC(sigio, struct sigio *, sizeof(struct sigio), M_SIGIO, M_WAITOK);
942	sigio->sio_pgid = pgid;
943	sigio->sio_ucred = crhold(curthread->td_ucred);
944	sigio->sio_myref = sigiop;
945
946	sx_slock(&proctree_lock);
947	if (pgid > 0) {
948		proc = pfind(pgid);
949		if (proc == NULL) {
950			ret = ESRCH;
951			goto fail;
952		}
953
954		/*
955		 * Policy - Don't allow a process to FSETOWN a process
956		 * in another session.
957		 *
958		 * Remove this test to allow maximum flexibility or
959		 * restrict FSETOWN to the current process or process
960		 * group for maximum safety.
961		 */
962		PROC_UNLOCK(proc);
963		if (proc->p_session != curthread->td_proc->p_session) {
964			ret = EPERM;
965			goto fail;
966		}
967
968		pgrp = NULL;
969	} else /* if (pgid < 0) */ {
970		pgrp = pgfind(-pgid);
971		if (pgrp == NULL) {
972			ret = ESRCH;
973			goto fail;
974		}
975		PGRP_UNLOCK(pgrp);
976
977		/*
978		 * Policy - Don't allow a process to FSETOWN a process
979		 * in another session.
980		 *
981		 * Remove this test to allow maximum flexibility or
982		 * restrict FSETOWN to the current process or process
983		 * group for maximum safety.
984		 */
985		if (pgrp->pg_session != curthread->td_proc->p_session) {
986			ret = EPERM;
987			goto fail;
988		}
989
990		proc = NULL;
991	}
992	funsetown(sigiop);
993	if (pgid > 0) {
994		PROC_LOCK(proc);
995		/*
996		 * Since funsetownlst() is called without the proctree
997		 * locked, we need to check for P_WEXIT.
998		 * XXX: is ESRCH correct?
999		 */
1000		if ((proc->p_flag & P_WEXIT) != 0) {
1001			PROC_UNLOCK(proc);
1002			ret = ESRCH;
1003			goto fail;
1004		}
1005		SLIST_INSERT_HEAD(&proc->p_sigiolst, sigio, sio_pgsigio);
1006		sigio->sio_proc = proc;
1007		PROC_UNLOCK(proc);
1008	} else {
1009		PGRP_LOCK(pgrp);
1010		SLIST_INSERT_HEAD(&pgrp->pg_sigiolst, sigio, sio_pgsigio);
1011		sigio->sio_pgrp = pgrp;
1012		PGRP_UNLOCK(pgrp);
1013	}
1014	sx_sunlock(&proctree_lock);
1015	SIGIO_LOCK();
1016	*sigiop = sigio;
1017	SIGIO_UNLOCK();
1018	return (0);
1019
1020fail:
1021	sx_sunlock(&proctree_lock);
1022	crfree(sigio->sio_ucred);
1023	FREE(sigio, M_SIGIO);
1024	return (ret);
1025}
1026
1027/*
1028 * This is common code for FIOGETOWN ioctl called by fcntl(fd, F_GETOWN, arg).
1029 */
1030pid_t
1031fgetown(sigiop)
1032	struct sigio **sigiop;
1033{
1034	pid_t pgid;
1035
1036	SIGIO_LOCK();
1037	pgid = (*sigiop != NULL) ? (*sigiop)->sio_pgid : 0;
1038	SIGIO_UNLOCK();
1039	return (pgid);
1040}
1041
1042/*
1043 * Close a file descriptor.
1044 */
1045#ifndef _SYS_SYSPROTO_H_
1046struct close_args {
1047	int     fd;
1048};
1049#endif
1050/* ARGSUSED */
1051int
1052close(td, uap)
1053	struct thread *td;
1054	struct close_args *uap;
1055{
1056
1057	return (kern_close(td, uap->fd));
1058}
1059
1060int
1061kern_close(td, fd)
1062	struct thread *td;
1063	int fd;
1064{
1065	struct filedesc *fdp;
1066	struct file *fp;
1067	int error;
1068	int holdleaders;
1069
1070	error = 0;
1071	holdleaders = 0;
1072	fdp = td->td_proc->p_fd;
1073
1074	AUDIT_SYSCLOSE(td, fd);
1075
1076	FILEDESC_XLOCK(fdp);
1077	if ((unsigned)fd >= fdp->fd_nfiles ||
1078	    (fp = fdp->fd_ofiles[fd]) == NULL) {
1079		FILEDESC_XUNLOCK(fdp);
1080		return (EBADF);
1081	}
1082	fdp->fd_ofiles[fd] = NULL;
1083	fdp->fd_ofileflags[fd] = 0;
1084	fdunused(fdp, fd);
1085	if (td->td_proc->p_fdtol != NULL) {
1086		/*
1087		 * Ask fdfree() to sleep to ensure that all relevant
1088		 * process leaders can be traversed in closef().
1089		 */
1090		fdp->fd_holdleaderscount++;
1091		holdleaders = 1;
1092	}
1093
1094	/*
1095	 * We now hold the fp reference that used to be owned by the
1096	 * descriptor array.  We have to unlock the FILEDESC *AFTER*
1097	 * knote_fdclose to prevent a race of the fd getting opened, a knote
1098	 * added, and deleteing a knote for the new fd.
1099	 */
1100	knote_fdclose(td, fd);
1101	if (fp->f_type == DTYPE_MQUEUE)
1102		mq_fdclose(td, fd, fp);
1103	FILEDESC_XUNLOCK(fdp);
1104
1105	error = closef(fp, td);
1106	if (holdleaders) {
1107		FILEDESC_XLOCK(fdp);
1108		fdp->fd_holdleaderscount--;
1109		if (fdp->fd_holdleaderscount == 0 &&
1110		    fdp->fd_holdleaderswakeup != 0) {
1111			fdp->fd_holdleaderswakeup = 0;
1112			wakeup(&fdp->fd_holdleaderscount);
1113		}
1114		FILEDESC_XUNLOCK(fdp);
1115	}
1116	return (error);
1117}
1118
1119#if defined(COMPAT_43)
1120/*
1121 * Return status information about a file descriptor.
1122 */
1123#ifndef _SYS_SYSPROTO_H_
1124struct ofstat_args {
1125	int	fd;
1126	struct	ostat *sb;
1127};
1128#endif
1129/* ARGSUSED */
1130int
1131ofstat(struct thread *td, struct ofstat_args *uap)
1132{
1133	struct ostat oub;
1134	struct stat ub;
1135	int error;
1136
1137	error = kern_fstat(td, uap->fd, &ub);
1138	if (error == 0) {
1139		cvtstat(&ub, &oub);
1140		error = copyout(&oub, uap->sb, sizeof(oub));
1141	}
1142	return (error);
1143}
1144#endif /* COMPAT_43 */
1145
1146/*
1147 * Return status information about a file descriptor.
1148 */
1149#ifndef _SYS_SYSPROTO_H_
1150struct fstat_args {
1151	int	fd;
1152	struct	stat *sb;
1153};
1154#endif
1155/* ARGSUSED */
1156int
1157fstat(struct thread *td, struct fstat_args *uap)
1158{
1159	struct stat ub;
1160	int error;
1161
1162	error = kern_fstat(td, uap->fd, &ub);
1163	if (error == 0)
1164		error = copyout(&ub, uap->sb, sizeof(ub));
1165	return (error);
1166}
1167
1168int
1169kern_fstat(struct thread *td, int fd, struct stat *sbp)
1170{
1171	struct file *fp;
1172	int error;
1173
1174	AUDIT_ARG(fd, fd);
1175
1176	if ((error = fget(td, fd, &fp)) != 0)
1177		return (error);
1178
1179	AUDIT_ARG(file, td->td_proc, fp);
1180
1181	error = fo_stat(fp, sbp, td->td_ucred, td);
1182	fdrop(fp, td);
1183#ifdef KTRACE
1184	if (error == 0 && KTRPOINT(td, KTR_STRUCT))
1185		ktrstat(sbp);
1186#endif
1187	return (error);
1188}
1189
1190/*
1191 * Return status information about a file descriptor.
1192 */
1193#ifndef _SYS_SYSPROTO_H_
1194struct nfstat_args {
1195	int	fd;
1196	struct	nstat *sb;
1197};
1198#endif
1199/* ARGSUSED */
1200int
1201nfstat(struct thread *td, struct nfstat_args *uap)
1202{
1203	struct nstat nub;
1204	struct stat ub;
1205	int error;
1206
1207	error = kern_fstat(td, uap->fd, &ub);
1208	if (error == 0) {
1209		cvtnstat(&ub, &nub);
1210		error = copyout(&nub, uap->sb, sizeof(nub));
1211	}
1212	return (error);
1213}
1214
1215/*
1216 * Return pathconf information about a file descriptor.
1217 */
1218#ifndef _SYS_SYSPROTO_H_
1219struct fpathconf_args {
1220	int	fd;
1221	int	name;
1222};
1223#endif
1224/* ARGSUSED */
1225int
1226fpathconf(struct thread *td, struct fpathconf_args *uap)
1227{
1228	struct file *fp;
1229	struct vnode *vp;
1230	int error;
1231
1232	if ((error = fget(td, uap->fd, &fp)) != 0)
1233		return (error);
1234
1235	/* If asynchronous I/O is available, it works for all descriptors. */
1236	if (uap->name == _PC_ASYNC_IO) {
1237		td->td_retval[0] = async_io_version;
1238		goto out;
1239	}
1240	vp = fp->f_vnode;
1241	if (vp != NULL) {
1242		int vfslocked;
1243		vfslocked = VFS_LOCK_GIANT(vp->v_mount);
1244		vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
1245		error = VOP_PATHCONF(vp, uap->name, td->td_retval);
1246		VOP_UNLOCK(vp, 0);
1247		VFS_UNLOCK_GIANT(vfslocked);
1248	} else if (fp->f_type == DTYPE_PIPE || fp->f_type == DTYPE_SOCKET) {
1249		if (uap->name != _PC_PIPE_BUF) {
1250			error = EINVAL;
1251		} else {
1252			td->td_retval[0] = PIPE_BUF;
1253		error = 0;
1254		}
1255	} else {
1256		error = EOPNOTSUPP;
1257	}
1258out:
1259	fdrop(fp, td);
1260	return (error);
1261}
1262
1263/*
1264 * Grow the file table to accomodate (at least) nfd descriptors.  This may
1265 * block and drop the filedesc lock, but it will reacquire it before
1266 * returning.
1267 */
1268static void
1269fdgrowtable(struct filedesc *fdp, int nfd)
1270{
1271	struct file **ntable;
1272	char *nfileflags;
1273	int nnfiles, onfiles;
1274	NDSLOTTYPE *nmap;
1275
1276	FILEDESC_XLOCK_ASSERT(fdp);
1277
1278	KASSERT(fdp->fd_nfiles > 0,
1279	    ("zero-length file table"));
1280
1281	/* compute the size of the new table */
1282	onfiles = fdp->fd_nfiles;
1283	nnfiles = NDSLOTS(nfd) * NDENTRIES; /* round up */
1284	if (nnfiles <= onfiles)
1285		/* the table is already large enough */
1286		return;
1287
1288	/* allocate a new table and (if required) new bitmaps */
1289	FILEDESC_XUNLOCK(fdp);
1290	MALLOC(ntable, struct file **, nnfiles * OFILESIZE,
1291	    M_FILEDESC, M_ZERO | M_WAITOK);
1292	nfileflags = (char *)&ntable[nnfiles];
1293	if (NDSLOTS(nnfiles) > NDSLOTS(onfiles))
1294		MALLOC(nmap, NDSLOTTYPE *, NDSLOTS(nnfiles) * NDSLOTSIZE,
1295		    M_FILEDESC, M_ZERO | M_WAITOK);
1296	else
1297		nmap = NULL;
1298	FILEDESC_XLOCK(fdp);
1299
1300	/*
1301	 * We now have new tables ready to go.  Since we dropped the
1302	 * filedesc lock to call malloc(), watch out for a race.
1303	 */
1304	onfiles = fdp->fd_nfiles;
1305	if (onfiles >= nnfiles) {
1306		/* we lost the race, but that's OK */
1307		free(ntable, M_FILEDESC);
1308		if (nmap != NULL)
1309			free(nmap, M_FILEDESC);
1310		return;
1311	}
1312	bcopy(fdp->fd_ofiles, ntable, onfiles * sizeof(*ntable));
1313	bcopy(fdp->fd_ofileflags, nfileflags, onfiles);
1314	if (onfiles > NDFILE)
1315		free(fdp->fd_ofiles, M_FILEDESC);
1316	fdp->fd_ofiles = ntable;
1317	fdp->fd_ofileflags = nfileflags;
1318	if (NDSLOTS(nnfiles) > NDSLOTS(onfiles)) {
1319		bcopy(fdp->fd_map, nmap, NDSLOTS(onfiles) * sizeof(*nmap));
1320		if (NDSLOTS(onfiles) > NDSLOTS(NDFILE))
1321			free(fdp->fd_map, M_FILEDESC);
1322		fdp->fd_map = nmap;
1323	}
1324	fdp->fd_nfiles = nnfiles;
1325}
1326
1327/*
1328 * Allocate a file descriptor for the process.
1329 */
1330int
1331fdalloc(struct thread *td, int minfd, int *result)
1332{
1333	struct proc *p = td->td_proc;
1334	struct filedesc *fdp = p->p_fd;
1335	int fd = -1, maxfd;
1336
1337	FILEDESC_XLOCK_ASSERT(fdp);
1338
1339	if (fdp->fd_freefile > minfd)
1340		minfd = fdp->fd_freefile;
1341
1342	PROC_LOCK(p);
1343	maxfd = min((int)lim_cur(p, RLIMIT_NOFILE), maxfilesperproc);
1344	PROC_UNLOCK(p);
1345
1346	/*
1347	 * Search the bitmap for a free descriptor.  If none is found, try
1348	 * to grow the file table.  Keep at it until we either get a file
1349	 * descriptor or run into process or system limits; fdgrowtable()
1350	 * may drop the filedesc lock, so we're in a race.
1351	 */
1352	for (;;) {
1353		fd = fd_first_free(fdp, minfd, fdp->fd_nfiles);
1354		if (fd >= maxfd)
1355			return (EMFILE);
1356		if (fd < fdp->fd_nfiles)
1357			break;
1358		fdgrowtable(fdp, min(fdp->fd_nfiles * 2, maxfd));
1359	}
1360
1361	/*
1362	 * Perform some sanity checks, then mark the file descriptor as
1363	 * used and return it to the caller.
1364	 */
1365	KASSERT(!fdisused(fdp, fd),
1366	    ("fd_first_free() returned non-free descriptor"));
1367	KASSERT(fdp->fd_ofiles[fd] == NULL,
1368	    ("free descriptor isn't"));
1369	fdp->fd_ofileflags[fd] = 0; /* XXX needed? */
1370	fdused(fdp, fd);
1371	*result = fd;
1372	return (0);
1373}
1374
1375/*
1376 * Check to see whether n user file descriptors are available to the process
1377 * p.
1378 */
1379int
1380fdavail(struct thread *td, int n)
1381{
1382	struct proc *p = td->td_proc;
1383	struct filedesc *fdp = td->td_proc->p_fd;
1384	struct file **fpp;
1385	int i, lim, last;
1386
1387	FILEDESC_LOCK_ASSERT(fdp);
1388
1389	PROC_LOCK(p);
1390	lim = min((int)lim_cur(p, RLIMIT_NOFILE), maxfilesperproc);
1391	PROC_UNLOCK(p);
1392	if ((i = lim - fdp->fd_nfiles) > 0 && (n -= i) <= 0)
1393		return (1);
1394	last = min(fdp->fd_nfiles, lim);
1395	fpp = &fdp->fd_ofiles[fdp->fd_freefile];
1396	for (i = last - fdp->fd_freefile; --i >= 0; fpp++) {
1397		if (*fpp == NULL && --n <= 0)
1398			return (1);
1399	}
1400	return (0);
1401}
1402
1403/*
1404 * Create a new open file structure and allocate a file decriptor for the
1405 * process that refers to it.  We add one reference to the file for the
1406 * descriptor table and one reference for resultfp. This is to prevent us
1407 * being preempted and the entry in the descriptor table closed after we
1408 * release the FILEDESC lock.
1409 */
1410int
1411falloc(struct thread *td, struct file **resultfp, int *resultfd)
1412{
1413	struct proc *p = td->td_proc;
1414	struct file *fp;
1415	int error, i;
1416	int maxuserfiles = maxfiles - (maxfiles / 20);
1417	static struct timeval lastfail;
1418	static int curfail;
1419
1420	fp = uma_zalloc(file_zone, M_WAITOK | M_ZERO);
1421	if ((openfiles >= maxuserfiles &&
1422	    priv_check(td, PRIV_MAXFILES) != 0) ||
1423	    openfiles >= maxfiles) {
1424		if (ppsratecheck(&lastfail, &curfail, 1)) {
1425			printf("kern.maxfiles limit exceeded by uid %i, please see tuning(7).\n",
1426				td->td_ucred->cr_ruid);
1427		}
1428		uma_zfree(file_zone, fp);
1429		return (ENFILE);
1430	}
1431	atomic_add_int(&openfiles, 1);
1432
1433	/*
1434	 * If the process has file descriptor zero open, add the new file
1435	 * descriptor to the list of open files at that point, otherwise
1436	 * put it at the front of the list of open files.
1437	 */
1438	refcount_init(&fp->f_count, 1);
1439	if (resultfp)
1440		fhold(fp);
1441	fp->f_cred = crhold(td->td_ucred);
1442	fp->f_ops = &badfileops;
1443	fp->f_data = NULL;
1444	fp->f_vnode = NULL;
1445	FILEDESC_XLOCK(p->p_fd);
1446	if ((error = fdalloc(td, 0, &i))) {
1447		FILEDESC_XUNLOCK(p->p_fd);
1448		fdrop(fp, td);
1449		if (resultfp)
1450			fdrop(fp, td);
1451		return (error);
1452	}
1453	p->p_fd->fd_ofiles[i] = fp;
1454	FILEDESC_XUNLOCK(p->p_fd);
1455	if (resultfp)
1456		*resultfp = fp;
1457	if (resultfd)
1458		*resultfd = i;
1459	return (0);
1460}
1461
1462/*
1463 * Build a new filedesc structure from another.
1464 * Copy the current, root, and jail root vnode references.
1465 */
1466struct filedesc *
1467fdinit(struct filedesc *fdp)
1468{
1469	struct filedesc0 *newfdp;
1470
1471	newfdp = malloc(sizeof *newfdp, M_FILEDESC, M_WAITOK | M_ZERO);
1472	FILEDESC_LOCK_INIT(&newfdp->fd_fd);
1473	if (fdp != NULL) {
1474		FILEDESC_XLOCK(fdp);
1475		newfdp->fd_fd.fd_cdir = fdp->fd_cdir;
1476		if (newfdp->fd_fd.fd_cdir)
1477			VREF(newfdp->fd_fd.fd_cdir);
1478		newfdp->fd_fd.fd_rdir = fdp->fd_rdir;
1479		if (newfdp->fd_fd.fd_rdir)
1480			VREF(newfdp->fd_fd.fd_rdir);
1481		newfdp->fd_fd.fd_jdir = fdp->fd_jdir;
1482		if (newfdp->fd_fd.fd_jdir)
1483			VREF(newfdp->fd_fd.fd_jdir);
1484		FILEDESC_XUNLOCK(fdp);
1485	}
1486
1487	/* Create the file descriptor table. */
1488	newfdp->fd_fd.fd_refcnt = 1;
1489	newfdp->fd_fd.fd_holdcnt = 1;
1490	newfdp->fd_fd.fd_cmask = CMASK;
1491	newfdp->fd_fd.fd_ofiles = newfdp->fd_dfiles;
1492	newfdp->fd_fd.fd_ofileflags = newfdp->fd_dfileflags;
1493	newfdp->fd_fd.fd_nfiles = NDFILE;
1494	newfdp->fd_fd.fd_map = newfdp->fd_dmap;
1495	newfdp->fd_fd.fd_lastfile = -1;
1496	return (&newfdp->fd_fd);
1497}
1498
1499static struct filedesc *
1500fdhold(struct proc *p)
1501{
1502	struct filedesc *fdp;
1503
1504	mtx_lock(&fdesc_mtx);
1505	fdp = p->p_fd;
1506	if (fdp != NULL)
1507		fdp->fd_holdcnt++;
1508	mtx_unlock(&fdesc_mtx);
1509	return (fdp);
1510}
1511
1512static void
1513fddrop(struct filedesc *fdp)
1514{
1515	int i;
1516
1517	mtx_lock(&fdesc_mtx);
1518	i = --fdp->fd_holdcnt;
1519	mtx_unlock(&fdesc_mtx);
1520	if (i > 0)
1521		return;
1522
1523	FILEDESC_LOCK_DESTROY(fdp);
1524	FREE(fdp, M_FILEDESC);
1525}
1526
1527/*
1528 * Share a filedesc structure.
1529 */
1530struct filedesc *
1531fdshare(struct filedesc *fdp)
1532{
1533
1534	FILEDESC_XLOCK(fdp);
1535	fdp->fd_refcnt++;
1536	FILEDESC_XUNLOCK(fdp);
1537	return (fdp);
1538}
1539
1540/*
1541 * Unshare a filedesc structure, if necessary by making a copy
1542 */
1543void
1544fdunshare(struct proc *p, struct thread *td)
1545{
1546
1547	FILEDESC_XLOCK(p->p_fd);
1548	if (p->p_fd->fd_refcnt > 1) {
1549		struct filedesc *tmp;
1550
1551		FILEDESC_XUNLOCK(p->p_fd);
1552		tmp = fdcopy(p->p_fd);
1553		fdfree(td);
1554		p->p_fd = tmp;
1555	} else
1556		FILEDESC_XUNLOCK(p->p_fd);
1557}
1558
1559/*
1560 * Copy a filedesc structure.  A NULL pointer in returns a NULL reference,
1561 * this is to ease callers, not catch errors.
1562 */
1563struct filedesc *
1564fdcopy(struct filedesc *fdp)
1565{
1566	struct filedesc *newfdp;
1567	int i;
1568
1569	/* Certain daemons might not have file descriptors. */
1570	if (fdp == NULL)
1571		return (NULL);
1572
1573	newfdp = fdinit(fdp);
1574	FILEDESC_SLOCK(fdp);
1575	while (fdp->fd_lastfile >= newfdp->fd_nfiles) {
1576		FILEDESC_SUNLOCK(fdp);
1577		FILEDESC_XLOCK(newfdp);
1578		fdgrowtable(newfdp, fdp->fd_lastfile + 1);
1579		FILEDESC_XUNLOCK(newfdp);
1580		FILEDESC_SLOCK(fdp);
1581	}
1582	/* copy everything except kqueue descriptors */
1583	newfdp->fd_freefile = -1;
1584	for (i = 0; i <= fdp->fd_lastfile; ++i) {
1585		if (fdisused(fdp, i) &&
1586		    fdp->fd_ofiles[i]->f_type != DTYPE_KQUEUE) {
1587			newfdp->fd_ofiles[i] = fdp->fd_ofiles[i];
1588			newfdp->fd_ofileflags[i] = fdp->fd_ofileflags[i];
1589			fhold(newfdp->fd_ofiles[i]);
1590			newfdp->fd_lastfile = i;
1591		} else {
1592			if (newfdp->fd_freefile == -1)
1593				newfdp->fd_freefile = i;
1594		}
1595	}
1596	FILEDESC_SUNLOCK(fdp);
1597	FILEDESC_XLOCK(newfdp);
1598	for (i = 0; i <= newfdp->fd_lastfile; ++i)
1599		if (newfdp->fd_ofiles[i] != NULL)
1600			fdused(newfdp, i);
1601	FILEDESC_XUNLOCK(newfdp);
1602	FILEDESC_SLOCK(fdp);
1603	if (newfdp->fd_freefile == -1)
1604		newfdp->fd_freefile = i;
1605	newfdp->fd_cmask = fdp->fd_cmask;
1606	FILEDESC_SUNLOCK(fdp);
1607	return (newfdp);
1608}
1609
1610/*
1611 * Release a filedesc structure.
1612 */
1613void
1614fdfree(struct thread *td)
1615{
1616	struct filedesc *fdp;
1617	struct file **fpp;
1618	int i, locked;
1619	struct filedesc_to_leader *fdtol;
1620	struct file *fp;
1621	struct vnode *cdir, *jdir, *rdir, *vp;
1622	struct flock lf;
1623
1624	/* Certain daemons might not have file descriptors. */
1625	fdp = td->td_proc->p_fd;
1626	if (fdp == NULL)
1627		return;
1628
1629	/* Check for special need to clear POSIX style locks */
1630	fdtol = td->td_proc->p_fdtol;
1631	if (fdtol != NULL) {
1632		FILEDESC_XLOCK(fdp);
1633		KASSERT(fdtol->fdl_refcount > 0,
1634			("filedesc_to_refcount botch: fdl_refcount=%d",
1635			 fdtol->fdl_refcount));
1636		if (fdtol->fdl_refcount == 1 &&
1637		    (td->td_proc->p_leader->p_flag & P_ADVLOCK) != 0) {
1638			for (i = 0, fpp = fdp->fd_ofiles;
1639			     i <= fdp->fd_lastfile;
1640			     i++, fpp++) {
1641				if (*fpp == NULL ||
1642				    (*fpp)->f_type != DTYPE_VNODE)
1643					continue;
1644				fp = *fpp;
1645				fhold(fp);
1646				FILEDESC_XUNLOCK(fdp);
1647				lf.l_whence = SEEK_SET;
1648				lf.l_start = 0;
1649				lf.l_len = 0;
1650				lf.l_type = F_UNLCK;
1651				vp = fp->f_vnode;
1652				locked = VFS_LOCK_GIANT(vp->v_mount);
1653				(void) VOP_ADVLOCK(vp,
1654						   (caddr_t)td->td_proc->
1655						   p_leader,
1656						   F_UNLCK,
1657						   &lf,
1658						   F_POSIX);
1659				VFS_UNLOCK_GIANT(locked);
1660				FILEDESC_XLOCK(fdp);
1661				fdrop(fp, td);
1662				fpp = fdp->fd_ofiles + i;
1663			}
1664		}
1665	retry:
1666		if (fdtol->fdl_refcount == 1) {
1667			if (fdp->fd_holdleaderscount > 0 &&
1668			    (td->td_proc->p_leader->p_flag & P_ADVLOCK) != 0) {
1669				/*
1670				 * close() or do_dup() has cleared a reference
1671				 * in a shared file descriptor table.
1672				 */
1673				fdp->fd_holdleaderswakeup = 1;
1674				sx_sleep(&fdp->fd_holdleaderscount,
1675				    FILEDESC_LOCK(fdp), PLOCK, "fdlhold", 0);
1676				goto retry;
1677			}
1678			if (fdtol->fdl_holdcount > 0) {
1679				/*
1680				 * Ensure that fdtol->fdl_leader remains
1681				 * valid in closef().
1682				 */
1683				fdtol->fdl_wakeup = 1;
1684				sx_sleep(fdtol, FILEDESC_LOCK(fdp), PLOCK,
1685				    "fdlhold", 0);
1686				goto retry;
1687			}
1688		}
1689		fdtol->fdl_refcount--;
1690		if (fdtol->fdl_refcount == 0 &&
1691		    fdtol->fdl_holdcount == 0) {
1692			fdtol->fdl_next->fdl_prev = fdtol->fdl_prev;
1693			fdtol->fdl_prev->fdl_next = fdtol->fdl_next;
1694		} else
1695			fdtol = NULL;
1696		td->td_proc->p_fdtol = NULL;
1697		FILEDESC_XUNLOCK(fdp);
1698		if (fdtol != NULL)
1699			FREE(fdtol, M_FILEDESC_TO_LEADER);
1700	}
1701	FILEDESC_XLOCK(fdp);
1702	i = --fdp->fd_refcnt;
1703	FILEDESC_XUNLOCK(fdp);
1704	if (i > 0)
1705		return;
1706	/*
1707	 * We are the last reference to the structure, so we can
1708	 * safely assume it will not change out from under us.
1709	 */
1710	fpp = fdp->fd_ofiles;
1711	for (i = fdp->fd_lastfile; i-- >= 0; fpp++) {
1712		if (*fpp)
1713			(void) closef(*fpp, td);
1714	}
1715	FILEDESC_XLOCK(fdp);
1716
1717	/* XXX This should happen earlier. */
1718	mtx_lock(&fdesc_mtx);
1719	td->td_proc->p_fd = NULL;
1720	mtx_unlock(&fdesc_mtx);
1721
1722	if (fdp->fd_nfiles > NDFILE)
1723		FREE(fdp->fd_ofiles, M_FILEDESC);
1724	if (NDSLOTS(fdp->fd_nfiles) > NDSLOTS(NDFILE))
1725		FREE(fdp->fd_map, M_FILEDESC);
1726
1727	fdp->fd_nfiles = 0;
1728
1729	cdir = fdp->fd_cdir;
1730	fdp->fd_cdir = NULL;
1731	rdir = fdp->fd_rdir;
1732	fdp->fd_rdir = NULL;
1733	jdir = fdp->fd_jdir;
1734	fdp->fd_jdir = NULL;
1735	FILEDESC_XUNLOCK(fdp);
1736
1737	if (cdir) {
1738		locked = VFS_LOCK_GIANT(cdir->v_mount);
1739		vrele(cdir);
1740		VFS_UNLOCK_GIANT(locked);
1741	}
1742	if (rdir) {
1743		locked = VFS_LOCK_GIANT(rdir->v_mount);
1744		vrele(rdir);
1745		VFS_UNLOCK_GIANT(locked);
1746	}
1747	if (jdir) {
1748		locked = VFS_LOCK_GIANT(jdir->v_mount);
1749		vrele(jdir);
1750		VFS_UNLOCK_GIANT(locked);
1751	}
1752
1753	fddrop(fdp);
1754}
1755
1756/*
1757 * For setugid programs, we don't want to people to use that setugidness
1758 * to generate error messages which write to a file which otherwise would
1759 * otherwise be off-limits to the process.  We check for filesystems where
1760 * the vnode can change out from under us after execve (like [lin]procfs).
1761 *
1762 * Since setugidsafety calls this only for fd 0, 1 and 2, this check is
1763 * sufficient.  We also don't check for setugidness since we know we are.
1764 */
1765static int
1766is_unsafe(struct file *fp)
1767{
1768	if (fp->f_type == DTYPE_VNODE) {
1769		struct vnode *vp = fp->f_vnode;
1770
1771		if ((vp->v_vflag & VV_PROCDEP) != 0)
1772			return (1);
1773	}
1774	return (0);
1775}
1776
1777/*
1778 * Make this setguid thing safe, if at all possible.
1779 */
1780void
1781setugidsafety(struct thread *td)
1782{
1783	struct filedesc *fdp;
1784	int i;
1785
1786	/* Certain daemons might not have file descriptors. */
1787	fdp = td->td_proc->p_fd;
1788	if (fdp == NULL)
1789		return;
1790
1791	/*
1792	 * Note: fdp->fd_ofiles may be reallocated out from under us while
1793	 * we are blocked in a close.  Be careful!
1794	 */
1795	FILEDESC_XLOCK(fdp);
1796	for (i = 0; i <= fdp->fd_lastfile; i++) {
1797		if (i > 2)
1798			break;
1799		if (fdp->fd_ofiles[i] && is_unsafe(fdp->fd_ofiles[i])) {
1800			struct file *fp;
1801
1802			knote_fdclose(td, i);
1803			/*
1804			 * NULL-out descriptor prior to close to avoid
1805			 * a race while close blocks.
1806			 */
1807			fp = fdp->fd_ofiles[i];
1808			fdp->fd_ofiles[i] = NULL;
1809			fdp->fd_ofileflags[i] = 0;
1810			fdunused(fdp, i);
1811			FILEDESC_XUNLOCK(fdp);
1812			(void) closef(fp, td);
1813			FILEDESC_XLOCK(fdp);
1814		}
1815	}
1816	FILEDESC_XUNLOCK(fdp);
1817}
1818
1819/*
1820 * If a specific file object occupies a specific file descriptor, close the
1821 * file descriptor entry and drop a reference on the file object.  This is a
1822 * convenience function to handle a subsequent error in a function that calls
1823 * falloc() that handles the race that another thread might have closed the
1824 * file descriptor out from under the thread creating the file object.
1825 */
1826void
1827fdclose(struct filedesc *fdp, struct file *fp, int idx, struct thread *td)
1828{
1829
1830	FILEDESC_XLOCK(fdp);
1831	if (fdp->fd_ofiles[idx] == fp) {
1832		fdp->fd_ofiles[idx] = NULL;
1833		fdunused(fdp, idx);
1834		FILEDESC_XUNLOCK(fdp);
1835		fdrop(fp, td);
1836	} else
1837		FILEDESC_XUNLOCK(fdp);
1838}
1839
1840/*
1841 * Close any files on exec?
1842 */
1843void
1844fdcloseexec(struct thread *td)
1845{
1846	struct filedesc *fdp;
1847	int i;
1848
1849	/* Certain daemons might not have file descriptors. */
1850	fdp = td->td_proc->p_fd;
1851	if (fdp == NULL)
1852		return;
1853
1854	FILEDESC_XLOCK(fdp);
1855
1856	/*
1857	 * We cannot cache fd_ofiles or fd_ofileflags since operations
1858	 * may block and rip them out from under us.
1859	 */
1860	for (i = 0; i <= fdp->fd_lastfile; i++) {
1861		if (fdp->fd_ofiles[i] != NULL &&
1862		    (fdp->fd_ofiles[i]->f_type == DTYPE_MQUEUE ||
1863		    (fdp->fd_ofileflags[i] & UF_EXCLOSE))) {
1864			struct file *fp;
1865
1866			knote_fdclose(td, i);
1867			/*
1868			 * NULL-out descriptor prior to close to avoid
1869			 * a race while close blocks.
1870			 */
1871			fp = fdp->fd_ofiles[i];
1872			fdp->fd_ofiles[i] = NULL;
1873			fdp->fd_ofileflags[i] = 0;
1874			fdunused(fdp, i);
1875			if (fp->f_type == DTYPE_MQUEUE)
1876				mq_fdclose(td, i, fp);
1877			FILEDESC_XUNLOCK(fdp);
1878			(void) closef(fp, td);
1879			FILEDESC_XLOCK(fdp);
1880		}
1881	}
1882	FILEDESC_XUNLOCK(fdp);
1883}
1884
1885/*
1886 * It is unsafe for set[ug]id processes to be started with file
1887 * descriptors 0..2 closed, as these descriptors are given implicit
1888 * significance in the Standard C library.  fdcheckstd() will create a
1889 * descriptor referencing /dev/null for each of stdin, stdout, and
1890 * stderr that is not already open.
1891 */
1892int
1893fdcheckstd(struct thread *td)
1894{
1895	struct filedesc *fdp;
1896	register_t retval, save;
1897	int i, error, devnull;
1898
1899	fdp = td->td_proc->p_fd;
1900	if (fdp == NULL)
1901		return (0);
1902	KASSERT(fdp->fd_refcnt == 1, ("the fdtable should not be shared"));
1903	devnull = -1;
1904	error = 0;
1905	for (i = 0; i < 3; i++) {
1906		if (fdp->fd_ofiles[i] != NULL)
1907			continue;
1908		if (devnull < 0) {
1909			save = td->td_retval[0];
1910			error = kern_open(td, "/dev/null", UIO_SYSSPACE,
1911			    O_RDWR, 0);
1912			devnull = td->td_retval[0];
1913			KASSERT(devnull == i, ("oof, we didn't get our fd"));
1914			td->td_retval[0] = save;
1915			if (error)
1916				break;
1917		} else {
1918			error = do_dup(td, DUP_FIXED, devnull, i, &retval);
1919			if (error != 0)
1920				break;
1921		}
1922	}
1923	return (error);
1924}
1925
1926/*
1927 * Internal form of close.  Decrement reference count on file structure.
1928 * Note: td may be NULL when closing a file that was being passed in a
1929 * message.
1930 *
1931 * XXXRW: Giant is not required for the caller, but often will be held; this
1932 * makes it moderately likely the Giant will be recursed in the VFS case.
1933 */
1934int
1935closef(struct file *fp, struct thread *td)
1936{
1937	struct vnode *vp;
1938	struct flock lf;
1939	struct filedesc_to_leader *fdtol;
1940	struct filedesc *fdp;
1941
1942	/*
1943	 * POSIX record locking dictates that any close releases ALL
1944	 * locks owned by this process.  This is handled by setting
1945	 * a flag in the unlock to free ONLY locks obeying POSIX
1946	 * semantics, and not to free BSD-style file locks.
1947	 * If the descriptor was in a message, POSIX-style locks
1948	 * aren't passed with the descriptor, and the thread pointer
1949	 * will be NULL.  Callers should be careful only to pass a
1950	 * NULL thread pointer when there really is no owning
1951	 * context that might have locks, or the locks will be
1952	 * leaked.
1953	 */
1954	if (fp->f_type == DTYPE_VNODE && td != NULL) {
1955		int vfslocked;
1956
1957		vp = fp->f_vnode;
1958		vfslocked = VFS_LOCK_GIANT(vp->v_mount);
1959		if ((td->td_proc->p_leader->p_flag & P_ADVLOCK) != 0) {
1960			lf.l_whence = SEEK_SET;
1961			lf.l_start = 0;
1962			lf.l_len = 0;
1963			lf.l_type = F_UNLCK;
1964			(void) VOP_ADVLOCK(vp, (caddr_t)td->td_proc->p_leader,
1965					   F_UNLCK, &lf, F_POSIX);
1966		}
1967		fdtol = td->td_proc->p_fdtol;
1968		if (fdtol != NULL) {
1969			/*
1970			 * Handle special case where file descriptor table is
1971			 * shared between multiple process leaders.
1972			 */
1973			fdp = td->td_proc->p_fd;
1974			FILEDESC_XLOCK(fdp);
1975			for (fdtol = fdtol->fdl_next;
1976			     fdtol != td->td_proc->p_fdtol;
1977			     fdtol = fdtol->fdl_next) {
1978				if ((fdtol->fdl_leader->p_flag &
1979				     P_ADVLOCK) == 0)
1980					continue;
1981				fdtol->fdl_holdcount++;
1982				FILEDESC_XUNLOCK(fdp);
1983				lf.l_whence = SEEK_SET;
1984				lf.l_start = 0;
1985				lf.l_len = 0;
1986				lf.l_type = F_UNLCK;
1987				vp = fp->f_vnode;
1988				(void) VOP_ADVLOCK(vp,
1989						   (caddr_t)fdtol->fdl_leader,
1990						   F_UNLCK, &lf, F_POSIX);
1991				FILEDESC_XLOCK(fdp);
1992				fdtol->fdl_holdcount--;
1993				if (fdtol->fdl_holdcount == 0 &&
1994				    fdtol->fdl_wakeup != 0) {
1995					fdtol->fdl_wakeup = 0;
1996					wakeup(fdtol);
1997				}
1998			}
1999			FILEDESC_XUNLOCK(fdp);
2000		}
2001		VFS_UNLOCK_GIANT(vfslocked);
2002	}
2003	return (fdrop(fp, td));
2004}
2005
2006/*
2007 * Initialize the file pointer with the specified properties.
2008 *
2009 * The ops are set with release semantics to be certain that the flags, type,
2010 * and data are visible when ops is.  This is to prevent ops methods from being
2011 * called with bad data.
2012 */
2013void
2014finit(struct file *fp, u_int flag, short type, void *data, struct fileops *ops)
2015{
2016	fp->f_data = data;
2017	fp->f_flag = flag;
2018	fp->f_type = type;
2019	atomic_store_rel_ptr((volatile uintptr_t *)&fp->f_ops, (uintptr_t)ops);
2020}
2021
2022
2023/*
2024 * Extract the file pointer associated with the specified descriptor for the
2025 * current user process.
2026 *
2027 * If the descriptor doesn't exist, EBADF is returned.
2028 *
2029 * If the descriptor exists but doesn't match 'flags' then return EBADF for
2030 * read attempts and EINVAL for write attempts.
2031 *
2032 * If 'hold' is set (non-zero) the file's refcount will be bumped on return.
2033 * It should be dropped with fdrop().  If it is not set, then the refcount
2034 * will not be bumped however the thread's filedesc struct will be returned
2035 * locked (for fgetsock).
2036 *
2037 * If an error occured the non-zero error is returned and *fpp is set to
2038 * NULL.  Otherwise *fpp is set and zero is returned.
2039 */
2040static __inline int
2041_fget(struct thread *td, int fd, struct file **fpp, int flags, int hold)
2042{
2043	struct filedesc *fdp;
2044	struct file *fp;
2045
2046	*fpp = NULL;
2047	if (td == NULL || (fdp = td->td_proc->p_fd) == NULL)
2048		return (EBADF);
2049	FILEDESC_SLOCK(fdp);
2050	if ((fp = fget_locked(fdp, fd)) == NULL || fp->f_ops == &badfileops) {
2051		FILEDESC_SUNLOCK(fdp);
2052		return (EBADF);
2053	}
2054
2055	/*
2056	 * FREAD and FWRITE failure return EBADF as per POSIX.
2057	 *
2058	 * Only one flag, or 0, may be specified.
2059	 */
2060	if (flags == FREAD && (fp->f_flag & FREAD) == 0) {
2061		FILEDESC_SUNLOCK(fdp);
2062		return (EBADF);
2063	}
2064	if (flags == FWRITE && (fp->f_flag & FWRITE) == 0) {
2065		FILEDESC_SUNLOCK(fdp);
2066		return (EBADF);
2067	}
2068	if (hold) {
2069		fhold(fp);
2070		FILEDESC_SUNLOCK(fdp);
2071	}
2072	*fpp = fp;
2073	return (0);
2074}
2075
2076int
2077fget(struct thread *td, int fd, struct file **fpp)
2078{
2079
2080	return(_fget(td, fd, fpp, 0, 1));
2081}
2082
2083int
2084fget_read(struct thread *td, int fd, struct file **fpp)
2085{
2086
2087	return(_fget(td, fd, fpp, FREAD, 1));
2088}
2089
2090int
2091fget_write(struct thread *td, int fd, struct file **fpp)
2092{
2093
2094	return(_fget(td, fd, fpp, FWRITE, 1));
2095}
2096
2097/*
2098 * Like fget() but loads the underlying vnode, or returns an error if the
2099 * descriptor does not represent a vnode.  Note that pipes use vnodes but
2100 * never have VM objects.  The returned vnode will be vref()'d.
2101 *
2102 * XXX: what about the unused flags ?
2103 */
2104static __inline int
2105_fgetvp(struct thread *td, int fd, struct vnode **vpp, int flags)
2106{
2107	struct file *fp;
2108	int error;
2109
2110	*vpp = NULL;
2111	if ((error = _fget(td, fd, &fp, flags, 0)) != 0)
2112		return (error);
2113	if (fp->f_vnode == NULL) {
2114		error = EINVAL;
2115	} else {
2116		*vpp = fp->f_vnode;
2117		vref(*vpp);
2118	}
2119	FILEDESC_SUNLOCK(td->td_proc->p_fd);
2120	return (error);
2121}
2122
2123int
2124fgetvp(struct thread *td, int fd, struct vnode **vpp)
2125{
2126
2127	return (_fgetvp(td, fd, vpp, 0));
2128}
2129
2130int
2131fgetvp_read(struct thread *td, int fd, struct vnode **vpp)
2132{
2133
2134	return (_fgetvp(td, fd, vpp, FREAD));
2135}
2136
2137#ifdef notyet
2138int
2139fgetvp_write(struct thread *td, int fd, struct vnode **vpp)
2140{
2141
2142	return (_fgetvp(td, fd, vpp, FWRITE));
2143}
2144#endif
2145
2146/*
2147 * Like fget() but loads the underlying socket, or returns an error if the
2148 * descriptor does not represent a socket.
2149 *
2150 * We bump the ref count on the returned socket.  XXX Also obtain the SX lock
2151 * in the future.
2152 *
2153 * Note: fgetsock() and fputsock() are deprecated, as consumers should rely
2154 * on their file descriptor reference to prevent the socket from being free'd
2155 * during use.
2156 */
2157int
2158fgetsock(struct thread *td, int fd, struct socket **spp, u_int *fflagp)
2159{
2160	struct file *fp;
2161	int error;
2162
2163	*spp = NULL;
2164	if (fflagp != NULL)
2165		*fflagp = 0;
2166	if ((error = _fget(td, fd, &fp, 0, 0)) != 0)
2167		return (error);
2168	if (fp->f_type != DTYPE_SOCKET) {
2169		error = ENOTSOCK;
2170	} else {
2171		*spp = fp->f_data;
2172		if (fflagp)
2173			*fflagp = fp->f_flag;
2174		SOCK_LOCK(*spp);
2175		soref(*spp);
2176		SOCK_UNLOCK(*spp);
2177	}
2178	FILEDESC_SUNLOCK(td->td_proc->p_fd);
2179	return (error);
2180}
2181
2182/*
2183 * Drop the reference count on the socket and XXX release the SX lock in the
2184 * future.  The last reference closes the socket.
2185 *
2186 * Note: fputsock() is deprecated, see comment for fgetsock().
2187 */
2188void
2189fputsock(struct socket *so)
2190{
2191
2192	ACCEPT_LOCK();
2193	SOCK_LOCK(so);
2194	sorele(so);
2195}
2196
2197/*
2198 * Handle the last reference to a file being closed.
2199 */
2200int
2201_fdrop(struct file *fp, struct thread *td)
2202{
2203	int error;
2204
2205	error = 0;
2206	if (fp->f_count != 0)
2207		panic("fdrop: count %d", fp->f_count);
2208	if (fp->f_ops != &badfileops)
2209		error = fo_close(fp, td);
2210	/*
2211	 * The f_cdevpriv cannot be assigned non-NULL value while we
2212	 * are destroying the file.
2213	 */
2214	if (fp->f_cdevpriv != NULL)
2215		devfs_fpdrop(fp);
2216	atomic_subtract_int(&openfiles, 1);
2217	crfree(fp->f_cred);
2218	uma_zfree(file_zone, fp);
2219
2220	return (error);
2221}
2222
2223/*
2224 * Apply an advisory lock on a file descriptor.
2225 *
2226 * Just attempt to get a record lock of the requested type on the entire file
2227 * (l_whence = SEEK_SET, l_start = 0, l_len = 0).
2228 */
2229#ifndef _SYS_SYSPROTO_H_
2230struct flock_args {
2231	int	fd;
2232	int	how;
2233};
2234#endif
2235/* ARGSUSED */
2236int
2237flock(struct thread *td, struct flock_args *uap)
2238{
2239	struct file *fp;
2240	struct vnode *vp;
2241	struct flock lf;
2242	int vfslocked;
2243	int error;
2244
2245	if ((error = fget(td, uap->fd, &fp)) != 0)
2246		return (error);
2247	if (fp->f_type != DTYPE_VNODE) {
2248		fdrop(fp, td);
2249		return (EOPNOTSUPP);
2250	}
2251
2252	vp = fp->f_vnode;
2253	vfslocked = VFS_LOCK_GIANT(vp->v_mount);
2254	lf.l_whence = SEEK_SET;
2255	lf.l_start = 0;
2256	lf.l_len = 0;
2257	if (uap->how & LOCK_UN) {
2258		lf.l_type = F_UNLCK;
2259		atomic_clear_int(&fp->f_flag, FHASLOCK);
2260		error = VOP_ADVLOCK(vp, (caddr_t)fp, F_UNLCK, &lf, F_FLOCK);
2261		goto done2;
2262	}
2263	if (uap->how & LOCK_EX)
2264		lf.l_type = F_WRLCK;
2265	else if (uap->how & LOCK_SH)
2266		lf.l_type = F_RDLCK;
2267	else {
2268		error = EBADF;
2269		goto done2;
2270	}
2271	atomic_set_int(&fp->f_flag, FHASLOCK);
2272	error = VOP_ADVLOCK(vp, (caddr_t)fp, F_SETLK, &lf,
2273	    (uap->how & LOCK_NB) ? F_FLOCK : F_FLOCK | F_WAIT);
2274done2:
2275	fdrop(fp, td);
2276	VFS_UNLOCK_GIANT(vfslocked);
2277	return (error);
2278}
2279/*
2280 * Duplicate the specified descriptor to a free descriptor.
2281 */
2282int
2283dupfdopen(struct thread *td, struct filedesc *fdp, int indx, int dfd, int mode, int error)
2284{
2285	struct file *wfp;
2286	struct file *fp;
2287
2288	/*
2289	 * If the to-be-dup'd fd number is greater than the allowed number
2290	 * of file descriptors, or the fd to be dup'd has already been
2291	 * closed, then reject.
2292	 */
2293	FILEDESC_XLOCK(fdp);
2294	if (dfd < 0 || dfd >= fdp->fd_nfiles ||
2295	    (wfp = fdp->fd_ofiles[dfd]) == NULL) {
2296		FILEDESC_XUNLOCK(fdp);
2297		return (EBADF);
2298	}
2299
2300	/*
2301	 * There are two cases of interest here.
2302	 *
2303	 * For ENODEV simply dup (dfd) to file descriptor (indx) and return.
2304	 *
2305	 * For ENXIO steal away the file structure from (dfd) and store it in
2306	 * (indx).  (dfd) is effectively closed by this operation.
2307	 *
2308	 * Any other error code is just returned.
2309	 */
2310	switch (error) {
2311	case ENODEV:
2312		/*
2313		 * Check that the mode the file is being opened for is a
2314		 * subset of the mode of the existing descriptor.
2315		 */
2316		if (((mode & (FREAD|FWRITE)) | wfp->f_flag) != wfp->f_flag) {
2317			FILEDESC_XUNLOCK(fdp);
2318			return (EACCES);
2319		}
2320		fp = fdp->fd_ofiles[indx];
2321		fdp->fd_ofiles[indx] = wfp;
2322		fdp->fd_ofileflags[indx] = fdp->fd_ofileflags[dfd];
2323		if (fp == NULL)
2324			fdused(fdp, indx);
2325		fhold(wfp);
2326		FILEDESC_XUNLOCK(fdp);
2327		if (fp != NULL)
2328			/*
2329			 * We now own the reference to fp that the ofiles[]
2330			 * array used to own.  Release it.
2331			 */
2332			fdrop(fp, td);
2333		return (0);
2334
2335	case ENXIO:
2336		/*
2337		 * Steal away the file pointer from dfd and stuff it into indx.
2338		 */
2339		fp = fdp->fd_ofiles[indx];
2340		fdp->fd_ofiles[indx] = fdp->fd_ofiles[dfd];
2341		fdp->fd_ofiles[dfd] = NULL;
2342		fdp->fd_ofileflags[indx] = fdp->fd_ofileflags[dfd];
2343		fdp->fd_ofileflags[dfd] = 0;
2344		fdunused(fdp, dfd);
2345		if (fp == NULL)
2346			fdused(fdp, indx);
2347		FILEDESC_XUNLOCK(fdp);
2348
2349		/*
2350		 * We now own the reference to fp that the ofiles[] array
2351		 * used to own.  Release it.
2352		 */
2353		if (fp != NULL)
2354			fdrop(fp, td);
2355		return (0);
2356
2357	default:
2358		FILEDESC_XUNLOCK(fdp);
2359		return (error);
2360	}
2361	/* NOTREACHED */
2362}
2363
2364/*
2365 * Scan all active processes to see if any of them have a current or root
2366 * directory of `olddp'. If so, replace them with the new mount point.
2367 */
2368void
2369mountcheckdirs(struct vnode *olddp, struct vnode *newdp)
2370{
2371	struct filedesc *fdp;
2372	struct proc *p;
2373	int nrele;
2374
2375	if (vrefcnt(olddp) == 1)
2376		return;
2377	sx_slock(&allproc_lock);
2378	FOREACH_PROC_IN_SYSTEM(p) {
2379		fdp = fdhold(p);
2380		if (fdp == NULL)
2381			continue;
2382		nrele = 0;
2383		FILEDESC_XLOCK(fdp);
2384		if (fdp->fd_cdir == olddp) {
2385			vref(newdp);
2386			fdp->fd_cdir = newdp;
2387			nrele++;
2388		}
2389		if (fdp->fd_rdir == olddp) {
2390			vref(newdp);
2391			fdp->fd_rdir = newdp;
2392			nrele++;
2393		}
2394		FILEDESC_XUNLOCK(fdp);
2395		fddrop(fdp);
2396		while (nrele--)
2397			vrele(olddp);
2398	}
2399	sx_sunlock(&allproc_lock);
2400	if (rootvnode == olddp) {
2401		vrele(rootvnode);
2402		vref(newdp);
2403		rootvnode = newdp;
2404	}
2405}
2406
2407struct filedesc_to_leader *
2408filedesc_to_leader_alloc(struct filedesc_to_leader *old, struct filedesc *fdp, struct proc *leader)
2409{
2410	struct filedesc_to_leader *fdtol;
2411
2412	MALLOC(fdtol, struct filedesc_to_leader *,
2413	       sizeof(struct filedesc_to_leader),
2414	       M_FILEDESC_TO_LEADER,
2415	       M_WAITOK);
2416	fdtol->fdl_refcount = 1;
2417	fdtol->fdl_holdcount = 0;
2418	fdtol->fdl_wakeup = 0;
2419	fdtol->fdl_leader = leader;
2420	if (old != NULL) {
2421		FILEDESC_XLOCK(fdp);
2422		fdtol->fdl_next = old->fdl_next;
2423		fdtol->fdl_prev = old;
2424		old->fdl_next = fdtol;
2425		fdtol->fdl_next->fdl_prev = fdtol;
2426		FILEDESC_XUNLOCK(fdp);
2427	} else {
2428		fdtol->fdl_next = fdtol;
2429		fdtol->fdl_prev = fdtol;
2430	}
2431	return (fdtol);
2432}
2433
2434/*
2435 * Get file structures globally.
2436 */
2437static int
2438sysctl_kern_file(SYSCTL_HANDLER_ARGS)
2439{
2440	struct xfile xf;
2441	struct filedesc *fdp;
2442	struct file *fp;
2443	struct proc *p;
2444	int error, n;
2445
2446	error = sysctl_wire_old_buffer(req, 0);
2447	if (error != 0)
2448		return (error);
2449	if (req->oldptr == NULL) {
2450		n = 0;
2451		sx_slock(&allproc_lock);
2452		FOREACH_PROC_IN_SYSTEM(p) {
2453			if (p->p_state == PRS_NEW)
2454				continue;
2455			fdp = fdhold(p);
2456			if (fdp == NULL)
2457				continue;
2458			/* overestimates sparse tables. */
2459			if (fdp->fd_lastfile > 0)
2460				n += fdp->fd_lastfile;
2461			fddrop(fdp);
2462		}
2463		sx_sunlock(&allproc_lock);
2464		return (SYSCTL_OUT(req, 0, n * sizeof(xf)));
2465	}
2466	error = 0;
2467	bzero(&xf, sizeof(xf));
2468	xf.xf_size = sizeof(xf);
2469	sx_slock(&allproc_lock);
2470	FOREACH_PROC_IN_SYSTEM(p) {
2471		if (p->p_state == PRS_NEW)
2472			continue;
2473		PROC_LOCK(p);
2474		if (p_cansee(req->td, p) != 0) {
2475			PROC_UNLOCK(p);
2476			continue;
2477		}
2478		xf.xf_pid = p->p_pid;
2479		xf.xf_uid = p->p_ucred->cr_uid;
2480		PROC_UNLOCK(p);
2481		fdp = fdhold(p);
2482		if (fdp == NULL)
2483			continue;
2484		FILEDESC_SLOCK(fdp);
2485		for (n = 0; fdp->fd_refcnt > 0 && n < fdp->fd_nfiles; ++n) {
2486			if ((fp = fdp->fd_ofiles[n]) == NULL)
2487				continue;
2488			xf.xf_fd = n;
2489			xf.xf_file = fp;
2490			xf.xf_data = fp->f_data;
2491			xf.xf_vnode = fp->f_vnode;
2492			xf.xf_type = fp->f_type;
2493			xf.xf_count = fp->f_count;
2494			xf.xf_msgcount = 0;
2495			xf.xf_offset = fp->f_offset;
2496			xf.xf_flag = fp->f_flag;
2497			error = SYSCTL_OUT(req, &xf, sizeof(xf));
2498			if (error)
2499				break;
2500		}
2501		FILEDESC_SUNLOCK(fdp);
2502		fddrop(fdp);
2503		if (error)
2504			break;
2505	}
2506	sx_sunlock(&allproc_lock);
2507	return (error);
2508}
2509
2510SYSCTL_PROC(_kern, KERN_FILE, file, CTLTYPE_OPAQUE|CTLFLAG_RD,
2511    0, 0, sysctl_kern_file, "S,xfile", "Entire file table");
2512
2513static int
2514export_vnode_for_sysctl(struct vnode *vp, int type,
2515    struct kinfo_file *kif, struct filedesc *fdp, struct sysctl_req *req)
2516{
2517	int error;
2518	char *fullpath, *freepath;
2519	int vfslocked;
2520
2521	bzero(kif, sizeof(*kif));
2522	kif->kf_structsize = sizeof(*kif);
2523
2524	vref(vp);
2525	kif->kf_fd = type;
2526	kif->kf_type = KF_TYPE_VNODE;
2527	/* This function only handles directories. */
2528	KASSERT(vp->v_type == VDIR, ("export_vnode_for_sysctl: vnode not directory"));
2529	kif->kf_vnode_type = KF_VTYPE_VDIR;
2530
2531	/*
2532	 * This is not a true file descriptor, so we set a bogus refcount
2533	 * and offset to indicate these fields should be ignored.
2534	 */
2535	kif->kf_ref_count = -1;
2536	kif->kf_offset = -1;
2537
2538	freepath = NULL;
2539	fullpath = "-";
2540	FILEDESC_SUNLOCK(fdp);
2541	vfslocked = VFS_LOCK_GIANT(vp->v_mount);
2542	vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
2543	vn_fullpath(curthread, vp, &fullpath, &freepath);
2544	vput(vp);
2545	VFS_UNLOCK_GIANT(vfslocked);
2546	strlcpy(kif->kf_path, fullpath, sizeof(kif->kf_path));
2547	if (freepath != NULL)
2548		free(freepath, M_TEMP);
2549	error = SYSCTL_OUT(req, kif, sizeof(*kif));
2550	FILEDESC_SLOCK(fdp);
2551	return (error);
2552}
2553
2554/*
2555 * Get per-process file descriptors for use by procstat(1), et al.
2556 */
2557static int
2558sysctl_kern_proc_filedesc(SYSCTL_HANDLER_ARGS)
2559{
2560	char *fullpath, *freepath;
2561	struct kinfo_file *kif;
2562	struct filedesc *fdp;
2563	int error, i, *name;
2564	struct socket *so;
2565	struct vnode *vp;
2566	struct file *fp;
2567	struct proc *p;
2568	struct tty *tp;
2569	int vfslocked;
2570
2571	name = (int *)arg1;
2572	if ((p = pfind((pid_t)name[0])) == NULL)
2573		return (ESRCH);
2574	if ((error = p_candebug(curthread, p))) {
2575		PROC_UNLOCK(p);
2576		return (error);
2577	}
2578	fdp = fdhold(p);
2579	PROC_UNLOCK(p);
2580	if (fdp == NULL)
2581		return (ENOENT);
2582	kif = malloc(sizeof(*kif), M_TEMP, M_WAITOK);
2583	FILEDESC_SLOCK(fdp);
2584	if (fdp->fd_cdir != NULL)
2585		export_vnode_for_sysctl(fdp->fd_cdir, KF_FD_TYPE_CWD, kif,
2586				fdp, req);
2587	if (fdp->fd_rdir != NULL)
2588		export_vnode_for_sysctl(fdp->fd_rdir, KF_FD_TYPE_ROOT, kif,
2589				fdp, req);
2590	if (fdp->fd_jdir != NULL)
2591		export_vnode_for_sysctl(fdp->fd_jdir, KF_FD_TYPE_JAIL, kif,
2592				fdp, req);
2593	for (i = 0; i < fdp->fd_nfiles; i++) {
2594		if ((fp = fdp->fd_ofiles[i]) == NULL)
2595			continue;
2596		bzero(kif, sizeof(*kif));
2597		kif->kf_structsize = sizeof(*kif);
2598		vp = NULL;
2599		so = NULL;
2600		tp = NULL;
2601		kif->kf_fd = i;
2602		switch (fp->f_type) {
2603		case DTYPE_VNODE:
2604			kif->kf_type = KF_TYPE_VNODE;
2605			vp = fp->f_vnode;
2606			break;
2607
2608		case DTYPE_SOCKET:
2609			kif->kf_type = KF_TYPE_SOCKET;
2610			so = fp->f_data;
2611			break;
2612
2613		case DTYPE_PIPE:
2614			kif->kf_type = KF_TYPE_PIPE;
2615			break;
2616
2617		case DTYPE_FIFO:
2618			kif->kf_type = KF_TYPE_FIFO;
2619			vp = fp->f_vnode;
2620			vref(vp);
2621			break;
2622
2623		case DTYPE_KQUEUE:
2624			kif->kf_type = KF_TYPE_KQUEUE;
2625			break;
2626
2627		case DTYPE_CRYPTO:
2628			kif->kf_type = KF_TYPE_CRYPTO;
2629			break;
2630
2631		case DTYPE_MQUEUE:
2632			kif->kf_type = KF_TYPE_MQUEUE;
2633			break;
2634
2635		case DTYPE_SHM:
2636			kif->kf_type = KF_TYPE_SHM;
2637			break;
2638
2639		case DTYPE_SEM:
2640			kif->kf_type = KF_TYPE_SEM;
2641			break;
2642
2643		case DTYPE_PTS:
2644			kif->kf_type = KF_TYPE_PTS;
2645			tp = fp->f_data;
2646			break;
2647
2648		default:
2649			kif->kf_type = KF_TYPE_UNKNOWN;
2650			break;
2651		}
2652		kif->kf_ref_count = fp->f_count;
2653		if (fp->f_flag & FREAD)
2654			kif->kf_flags |= KF_FLAG_READ;
2655		if (fp->f_flag & FWRITE)
2656			kif->kf_flags |= KF_FLAG_WRITE;
2657		if (fp->f_flag & FAPPEND)
2658			kif->kf_flags |= KF_FLAG_APPEND;
2659		if (fp->f_flag & FASYNC)
2660			kif->kf_flags |= KF_FLAG_ASYNC;
2661		if (fp->f_flag & FFSYNC)
2662			kif->kf_flags |= KF_FLAG_FSYNC;
2663		if (fp->f_flag & FNONBLOCK)
2664			kif->kf_flags |= KF_FLAG_NONBLOCK;
2665		if (fp->f_flag & O_DIRECT)
2666			kif->kf_flags |= KF_FLAG_DIRECT;
2667		if (fp->f_flag & FHASLOCK)
2668			kif->kf_flags |= KF_FLAG_HASLOCK;
2669		kif->kf_offset = fp->f_offset;
2670		if (vp != NULL) {
2671			vref(vp);
2672			switch (vp->v_type) {
2673			case VNON:
2674				kif->kf_vnode_type = KF_VTYPE_VNON;
2675				break;
2676			case VREG:
2677				kif->kf_vnode_type = KF_VTYPE_VREG;
2678				break;
2679			case VDIR:
2680				kif->kf_vnode_type = KF_VTYPE_VDIR;
2681				break;
2682			case VBLK:
2683				kif->kf_vnode_type = KF_VTYPE_VBLK;
2684				break;
2685			case VCHR:
2686				kif->kf_vnode_type = KF_VTYPE_VCHR;
2687				break;
2688			case VLNK:
2689				kif->kf_vnode_type = KF_VTYPE_VLNK;
2690				break;
2691			case VSOCK:
2692				kif->kf_vnode_type = KF_VTYPE_VSOCK;
2693				break;
2694			case VFIFO:
2695				kif->kf_vnode_type = KF_VTYPE_VFIFO;
2696				break;
2697			case VBAD:
2698				kif->kf_vnode_type = KF_VTYPE_VBAD;
2699				break;
2700			default:
2701				kif->kf_vnode_type = KF_VTYPE_UNKNOWN;
2702				break;
2703			}
2704			/*
2705			 * It is OK to drop the filedesc lock here as we will
2706			 * re-validate and re-evaluate its properties when
2707			 * the loop continues.
2708			 */
2709			freepath = NULL;
2710			fullpath = "-";
2711			FILEDESC_SUNLOCK(fdp);
2712			vfslocked = VFS_LOCK_GIANT(vp->v_mount);
2713			vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
2714			vn_fullpath(curthread, vp, &fullpath, &freepath);
2715			vput(vp);
2716			VFS_UNLOCK_GIANT(vfslocked);
2717			strlcpy(kif->kf_path, fullpath,
2718			    sizeof(kif->kf_path));
2719			if (freepath != NULL)
2720				free(freepath, M_TEMP);
2721			FILEDESC_SLOCK(fdp);
2722		}
2723		if (so != NULL) {
2724			struct sockaddr *sa;
2725
2726			if (so->so_proto->pr_usrreqs->pru_sockaddr(so, &sa)
2727			    == 0 && sa->sa_len <= sizeof(kif->kf_sa_local)) {
2728				bcopy(sa, &kif->kf_sa_local, sa->sa_len);
2729				free(sa, M_SONAME);
2730			}
2731			if (so->so_proto->pr_usrreqs->pru_peeraddr(so, &sa)
2732			    == 00 && sa->sa_len <= sizeof(kif->kf_sa_peer)) {
2733				bcopy(sa, &kif->kf_sa_peer, sa->sa_len);
2734				free(sa, M_SONAME);
2735			}
2736			kif->kf_sock_domain =
2737			    so->so_proto->pr_domain->dom_family;
2738			kif->kf_sock_type = so->so_type;
2739			kif->kf_sock_protocol = so->so_proto->pr_protocol;
2740		}
2741		if (tp != NULL) {
2742			strlcpy(kif->kf_path, tty_devname(tp),
2743			    sizeof(kif->kf_path));
2744		}
2745		error = SYSCTL_OUT(req, kif, sizeof(*kif));
2746		if (error)
2747			break;
2748	}
2749	FILEDESC_SUNLOCK(fdp);
2750	fddrop(fdp);
2751	free(kif, M_TEMP);
2752	return (0);
2753}
2754
2755static SYSCTL_NODE(_kern_proc, KERN_PROC_FILEDESC, filedesc, CTLFLAG_RD,
2756    sysctl_kern_proc_filedesc, "Process filedesc entries");
2757
2758#ifdef DDB
2759/*
2760 * For the purposes of debugging, generate a human-readable string for the
2761 * file type.
2762 */
2763static const char *
2764file_type_to_name(short type)
2765{
2766
2767	switch (type) {
2768	case 0:
2769		return ("zero");
2770	case DTYPE_VNODE:
2771		return ("vnod");
2772	case DTYPE_SOCKET:
2773		return ("sock");
2774	case DTYPE_PIPE:
2775		return ("pipe");
2776	case DTYPE_FIFO:
2777		return ("fifo");
2778	case DTYPE_KQUEUE:
2779		return ("kque");
2780	case DTYPE_CRYPTO:
2781		return ("crpt");
2782	case DTYPE_MQUEUE:
2783		return ("mque");
2784	case DTYPE_SHM:
2785		return ("shm");
2786	case DTYPE_SEM:
2787		return ("ksem");
2788	default:
2789		return ("unkn");
2790	}
2791}
2792
2793/*
2794 * For the purposes of debugging, identify a process (if any, perhaps one of
2795 * many) that references the passed file in its file descriptor array. Return
2796 * NULL if none.
2797 */
2798static struct proc *
2799file_to_first_proc(struct file *fp)
2800{
2801	struct filedesc *fdp;
2802	struct proc *p;
2803	int n;
2804
2805	FOREACH_PROC_IN_SYSTEM(p) {
2806		if (p->p_state == PRS_NEW)
2807			continue;
2808		fdp = p->p_fd;
2809		if (fdp == NULL)
2810			continue;
2811		for (n = 0; n < fdp->fd_nfiles; n++) {
2812			if (fp == fdp->fd_ofiles[n])
2813				return (p);
2814		}
2815	}
2816	return (NULL);
2817}
2818
2819static void
2820db_print_file(struct file *fp, int header)
2821{
2822	struct proc *p;
2823
2824	if (header)
2825		db_printf("%8s %4s %8s %8s %4s %5s %6s %8s %5s %12s\n",
2826		    "File", "Type", "Data", "Flag", "GCFl", "Count",
2827		    "MCount", "Vnode", "FPID", "FCmd");
2828	p = file_to_first_proc(fp);
2829	db_printf("%8p %4s %8p %08x %04x %5d %6d %8p %5d %12s\n", fp,
2830	    file_type_to_name(fp->f_type), fp->f_data, fp->f_flag,
2831	    0, fp->f_count, 0, fp->f_vnode,
2832	    p != NULL ? p->p_pid : -1, p != NULL ? p->p_comm : "-");
2833}
2834
2835DB_SHOW_COMMAND(file, db_show_file)
2836{
2837	struct file *fp;
2838
2839	if (!have_addr) {
2840		db_printf("usage: show file <addr>\n");
2841		return;
2842	}
2843	fp = (struct file *)addr;
2844	db_print_file(fp, 1);
2845}
2846
2847DB_SHOW_COMMAND(files, db_show_files)
2848{
2849	struct filedesc *fdp;
2850	struct file *fp;
2851	struct proc *p;
2852	int header;
2853	int n;
2854
2855	header = 1;
2856	FOREACH_PROC_IN_SYSTEM(p) {
2857		if (p->p_state == PRS_NEW)
2858			continue;
2859		if ((fdp = p->p_fd) == NULL)
2860			continue;
2861		for (n = 0; n < fdp->fd_nfiles; ++n) {
2862			if ((fp = fdp->fd_ofiles[n]) == NULL)
2863				continue;
2864			db_print_file(fp, header);
2865			header = 0;
2866		}
2867	}
2868}
2869#endif
2870
2871SYSCTL_INT(_kern, KERN_MAXFILESPERPROC, maxfilesperproc, CTLFLAG_RW,
2872    &maxfilesperproc, 0, "Maximum files allowed open per process");
2873
2874SYSCTL_INT(_kern, KERN_MAXFILES, maxfiles, CTLFLAG_RW,
2875    &maxfiles, 0, "Maximum number of files");
2876
2877SYSCTL_INT(_kern, OID_AUTO, openfiles, CTLFLAG_RD,
2878    __DEVOLATILE(int *, &openfiles), 0, "System-wide number of open files");
2879
2880/* ARGSUSED*/
2881static void
2882filelistinit(void *dummy)
2883{
2884
2885	file_zone = uma_zcreate("Files", sizeof(struct file), NULL, NULL,
2886	    NULL, NULL, UMA_ALIGN_PTR, 0);
2887	mtx_init(&sigio_lock, "sigio lock", NULL, MTX_DEF);
2888	mtx_init(&fdesc_mtx, "fdesc", NULL, MTX_DEF);
2889}
2890SYSINIT(select, SI_SUB_LOCK, SI_ORDER_FIRST, filelistinit, NULL);
2891
2892/*-------------------------------------------------------------------*/
2893
2894static int
2895badfo_readwrite(struct file *fp, struct uio *uio, struct ucred *active_cred, int flags, struct thread *td)
2896{
2897
2898	return (EBADF);
2899}
2900
2901static int
2902badfo_truncate(struct file *fp, off_t length, struct ucred *active_cred, struct thread *td)
2903{
2904
2905	return (EINVAL);
2906}
2907
2908static int
2909badfo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred, struct thread *td)
2910{
2911
2912	return (EBADF);
2913}
2914
2915static int
2916badfo_poll(struct file *fp, int events, struct ucred *active_cred, struct thread *td)
2917{
2918
2919	return (0);
2920}
2921
2922static int
2923badfo_kqfilter(struct file *fp, struct knote *kn)
2924{
2925
2926	return (EBADF);
2927}
2928
2929static int
2930badfo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred, struct thread *td)
2931{
2932
2933	return (EBADF);
2934}
2935
2936static int
2937badfo_close(struct file *fp, struct thread *td)
2938{
2939
2940	return (EBADF);
2941}
2942
2943struct fileops badfileops = {
2944	.fo_read = badfo_readwrite,
2945	.fo_write = badfo_readwrite,
2946	.fo_truncate = badfo_truncate,
2947	.fo_ioctl = badfo_ioctl,
2948	.fo_poll = badfo_poll,
2949	.fo_kqfilter = badfo_kqfilter,
2950	.fo_stat = badfo_stat,
2951	.fo_close = badfo_close,
2952};
2953
2954
2955/*-------------------------------------------------------------------*/
2956
2957/*
2958 * File Descriptor pseudo-device driver (/dev/fd/).
2959 *
2960 * Opening minor device N dup()s the file (if any) connected to file
2961 * descriptor N belonging to the calling process.  Note that this driver
2962 * consists of only the ``open()'' routine, because all subsequent
2963 * references to this file will be direct to the other driver.
2964 *
2965 * XXX: we could give this one a cloning event handler if necessary.
2966 */
2967
2968/* ARGSUSED */
2969static int
2970fdopen(struct cdev *dev, int mode, int type, struct thread *td)
2971{
2972
2973	/*
2974	 * XXX Kludge: set curthread->td_dupfd to contain the value of the
2975	 * the file descriptor being sought for duplication. The error
2976	 * return ensures that the vnode for this device will be released
2977	 * by vn_open. Open will detect this special error and take the
2978	 * actions in dupfdopen below. Other callers of vn_open or VOP_OPEN
2979	 * will simply report the error.
2980	 */
2981	td->td_dupfd = dev2unit(dev);
2982	return (ENODEV);
2983}
2984
2985static struct cdevsw fildesc_cdevsw = {
2986	.d_version =	D_VERSION,
2987	.d_open =	fdopen,
2988	.d_name =	"FD",
2989};
2990
2991static void
2992fildesc_drvinit(void *unused)
2993{
2994	struct cdev *dev;
2995
2996	dev = make_dev(&fildesc_cdevsw, 0, UID_ROOT, GID_WHEEL, 0666, "fd/0");
2997	make_dev_alias(dev, "stdin");
2998	dev = make_dev(&fildesc_cdevsw, 1, UID_ROOT, GID_WHEEL, 0666, "fd/1");
2999	make_dev_alias(dev, "stdout");
3000	dev = make_dev(&fildesc_cdevsw, 2, UID_ROOT, GID_WHEEL, 0666, "fd/2");
3001	make_dev_alias(dev, "stderr");
3002}
3003
3004SYSINIT(fildescdev, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, fildesc_drvinit, NULL);
3005