[apple/xnu.git] / bsd / sys / filedesc.h

/*
 * Copyright (c) 2000-2012 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1990, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)filedesc.h	8.1 (Berkeley) 6/2/93
 */

#ifndef _SYS_FILEDESC_H_
#define	_SYS_FILEDESC_H_

#include <sys/appleapiopts.h>

/*
 * This structure is used for the management of descriptors.  It may be
 * shared by multiple processes.
 *
 * A process is initially started out with NDFILE descriptors [XXXstored within
 * this structureXXX], selected to be enough for typical applications based on
 * the historical limit of 20 open files (and the usage of descriptors by
 * shells).  If these descriptors are exhausted, a larger descriptor table
 * may be allocated, up to a process' resource limit; [XXXthe internal arrays
 * are then unusedXXX].  The initial expansion is set to NDEXTENT; each time
 * it runs out, it is doubled until the resource limit is reached. NDEXTENT
 * should be selected to be the biggest multiple of OFILESIZE (see below)
 * that will fit in a power-of-two sized piece of memory.
 */
#define NDFILE		25		/* 125 bytes */
#define NDEXTENT	50		/* 250 bytes in 256-byte alloc. */ 

#ifdef BSD_KERNEL_PRIVATE

#include <kern/locks.h>

struct klist;
struct kqlist;

struct filedesc {
	struct	fileproc **fd_ofiles;	/* file structures for open files */
	lck_mtx_t fd_kqhashlock;        /* lock for dynamic kqueue hash */
	u_long  fd_kqhashmask;          /* size of dynamic kqueue hash */
	struct  kqlist *fd_kqhash;      /* hash table for dynamic kqueues */
	struct  kqueue *fd_wqkqueue;    /* the workq kqueue */
	char	*fd_ofileflags;		/* per-process open file flags */
	struct	vnode *fd_cdir;		/* current directory */
	struct	vnode *fd_rdir;		/* root directory */
	int	fd_nfiles;		/* number of open files allocated */
	int	fd_lastfile;		/* high-water mark of fd_ofiles */
	int	fd_freefile;		/* approx. next free file */
	u_short	fd_cmask;		/* mask for file creation */
        int	fd_flags;
	int     fd_knlistsize;          /* size of knlist */
	struct  klist *fd_knlist;       /* list of attached knotes */
	u_long  fd_knhashmask;          /* size of knhash */
	struct  klist *fd_knhash;       /* hash table for attached knotes */
	lck_mtx_t fd_knhashlock;	/* lock for hash table for attached knotes */
};

/*
 * definitions for fd_flags;
 */
#define	FD_CHROOT	0x01	/* process was chrooted... keep track even */
                                /* if we're force unmounted and unable to */
                                /* take a vnode_ref on fd_rdir during a fork */

#define FD_WORKLOOP	0x02	/* process has created a kqworkloop that */
                                /* requires manual cleanup on exit */

/*
 * Per-process open flags.
 */
#define UF_EXCLOSE	0x01		/* auto-close on exec */
#define UF_FORKCLOSE	0x02		/* auto-close on fork */
#define UF_RESERVED	0x04		/* open pending / in progress */
#define UF_CLOSING	0x08		/* close in progress */

#ifdef KERNEL
#define UF_RESVWAIT	0x10		/* close in progress */
#define	UF_INHERIT	0x20		/* "inherit-on-exec" */

#define UF_VALID_FLAGS	\
	(UF_EXCLOSE | UF_FORKCLOSE | UF_RESERVED | UF_CLOSING |\
	UF_RESVWAIT | UF_INHERIT)
#endif /* KERNEL */

/*
 * Storage required per open file descriptor.
 */
#define OFILESIZE (sizeof(struct file *) + sizeof(char))

#ifdef KERNEL
/*
 * Kernel global variables and routines.
 */
extern int	dupfdopen(struct filedesc *fdp,
				int indx, int dfd, int mode, int error);
extern int	fdalloc(proc_t p, int want, int *result);
extern void	fdrelse(proc_t p, int fd);
extern int	fdavail(proc_t p, int n);
#define		fdfile(p, fd)					\
			(&(p)->p_fd->fd_ofiles[(fd)])
#define		fdflags(p, fd)					\
			(&(p)->p_fd->fd_ofileflags[(fd)])

/*
 * Accesor macros for fd flags
 */
#define FDFLAGS_GET(p, fd) (*fdflags(p, fd) & (UF_EXCLOSE|UF_FORKCLOSE))
#define FDFLAGS_SET(p, fd, bits) \
	   (*fdflags(p, fd) |= ((bits) & (UF_EXCLOSE|UF_FORKCLOSE)))
#define FDFLAGS_CLR(p, fd, bits) \
	   (*fdflags(p, fd) &= ~((bits) & (UF_EXCLOSE|UF_FORKCLOSE)))

extern int	falloc(proc_t p, struct fileproc **resultfp, int *resultfd, vfs_context_t ctx);

#ifdef __APPLE_API_PRIVATE
typedef struct fileproc *(*fp_allocfn_t)(void *);
extern int	falloc_withalloc(proc_t p, struct fileproc **resultfp,
    int *resultfd, vfs_context_t ctx,
    fp_allocfn_t fp_zalloc, void *crarg);

extern struct	filedesc *fdcopy(proc_t p, struct vnode *uth_cdir);
extern void	fdfree(proc_t p);
extern void	fdexec(proc_t p, short flags, int self_exec);
#endif /* __APPLE_API_PRIVATE */

#endif /* KERNEL */

#endif /* BSD_KERNEL_PRIVATE */

#endif /* !_SYS_FILEDESC_H_ */
Commit	Line	Data
1c79356b	1	/*
39236c6e	2	* Copyright (c) 2000-2012 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
	29	/*
	30	* Copyright (c) 1990, 1993
	31	* The Regents of the University of California. All rights reserved.
	32	*
	33	* Redistribution and use in source and binary forms, with or without
	34	* modification, are permitted provided that the following conditions
	35	* are met:
	36	* 1. Redistributions of source code must retain the above copyright
	37	* notice, this list of conditions and the following disclaimer.
	38	* 2. Redistributions in binary form must reproduce the above copyright
	39	* notice, this list of conditions and the following disclaimer in the
	40	* documentation and/or other materials provided with the distribution.
	41	* 3. All advertising materials mentioning features or use of this software
	42	* must display the following acknowledgement:
	43	* This product includes software developed by the University of
	44	* California, Berkeley and its contributors.
	45	* 4. Neither the name of the University nor the names of its contributors
	46	* may be used to endorse or promote products derived from this software
	47	* without specific prior written permission.
	48	*
	49	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	50	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	51	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	52	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	53	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	54	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	55	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	56	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	57	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	58	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	59	* SUCH DAMAGE.
	60	*
	61	* @(#)filedesc.h 8.1 (Berkeley) 6/2/93
	62	*/
	63
	64	#ifndef _SYS_FILEDESC_H_
	65	#define _SYS_FILEDESC_H_
	66
9bccf70c A	67	#include <sys/appleapiopts.h>
9bccf70c A	68
1c79356b A	69	/*
	70	* This structure is used for the management of descriptors. It may be
	71	* shared by multiple processes.
	72	*
	73	* A process is initially started out with NDFILE descriptors [XXXstored within
	74	* this structureXXX], selected to be enough for typical applications based on
	75	* the historical limit of 20 open files (and the usage of descriptors by
	76	* shells). If these descriptors are exhausted, a larger descriptor table
	77	* may be allocated, up to a process' resource limit; [XXXthe internal arrays
	78	* are then unusedXXX]. The initial expansion is set to NDEXTENT; each time
	79	* it runs out, it is doubled until the resource limit is reached. NDEXTENT
	80	* should be selected to be the biggest multiple of OFILESIZE (see below)
	81	* that will fit in a power-of-two sized piece of memory.
	82	*/
	83	#define NDFILE 25 /* 125 bytes */
	84	#define NDEXTENT 50 /* 250 bytes in 256-byte alloc. */
	85
b0d623f7 A	86	#ifdef BSD_KERNEL_PRIVATE
b0d623f7 A	87
5ba3f43e A	88	#include <kern/locks.h>
5ba3f43e A	89
55e303ae	90	struct klist;
5ba3f43e	91	struct kqlist;
55e303ae	92
1c79356b	93	struct filedesc {
91447636	94	struct fileproc *fd_ofiles; / file structures for open files */
5ba3f43e A	95	lck_mtx_t fd_kqhashlock; /* lock for dynamic kqueue hash */
	96	u_long fd_kqhashmask; /* size of dynamic kqueue hash */
	97	struct kqlist fd_kqhash; / hash table for dynamic kqueues */
	98	struct kqueue fd_wqkqueue; / the workq kqueue */
1c79356b A	99	char fd_ofileflags; / per-process open file flags */
	100	struct vnode fd_cdir; / current directory */
	101	struct vnode fd_rdir; / root directory */
	102	int fd_nfiles; /* number of open files allocated */
2d21ac55 A	103	int fd_lastfile; /* high-water mark of fd_ofiles */
2d21ac55 A	104	int fd_freefile; /* approx. next free file */
1c79356b	105	u_short fd_cmask; /* mask for file creation */
5ba3f43e	106	int fd_flags;
55e303ae A	107	int fd_knlistsize; /* size of knlist */
	108	struct klist fd_knlist; / list of attached knotes */
	109	u_long fd_knhashmask; /* size of knhash */
	110	struct klist fd_knhash; / hash table for attached knotes */
5ba3f43e	111	lck_mtx_t fd_knhashlock; /* lock for hash table for attached knotes */
1c79356b A	112	};
1c79356b A	113
91447636 A	114	/*
	115	* definitions for fd_flags;
	116	*/
	117	#define FD_CHROOT 0x01 /* process was chrooted... keep track even */
	118	/* if we're force unmounted and unable to */
	119	/* take a vnode_ref on fd_rdir during a fork */
	120
d9a64523 A	121	#define FD_WORKLOOP 0x02 /* process has created a kqworkloop that */
	122	/* requires manual cleanup on exit */
	123
1c79356b A	124	/*
	125	* Per-process open flags.
	126	*/
39236c6e A	127	#define UF_EXCLOSE 0x01 /* auto-close on exec */
39236c6e A	128	#define UF_FORKCLOSE 0x02 /* auto-close on fork */
1c79356b	129	#define UF_RESERVED 0x04 /* open pending / in progress */
91447636	130	#define UF_CLOSING 0x08 /* close in progress */
1c79356b	131
6601e61a A	132	#ifdef KERNEL
6601e61a A	133	#define UF_RESVWAIT 0x10 /* close in progress */
6d2010ae	134	#define UF_INHERIT 0x20 /* "inherit-on-exec" */
39236c6e	135
6d2010ae	136	#define UF_VALID_FLAGS \
39236c6e A	137	(UF_EXCLOSE \| UF_FORKCLOSE \| UF_RESERVED \| UF_CLOSING \|\
39236c6e A	138	UF_RESVWAIT \| UF_INHERIT)
2d21ac55 A	139	#endif /* KERNEL */
2d21ac55 A	140
1c79356b A	141	/*
	142	* Storage required per open file descriptor.
	143	*/
	144	#define OFILESIZE (sizeof(struct file *) + sizeof(char))
	145
	146	#ifdef KERNEL
	147	/*
	148	* Kernel global variables and routines.
	149	*/
91447636 A	150	extern int dupfdopen(struct filedesc *fdp,
91447636 A	151	int indx, int dfd, int mode, int error);
2d21ac55 A	152	extern int fdalloc(proc_t p, int want, int *result);
	153	extern void fdrelse(proc_t p, int fd);
	154	extern int fdavail(proc_t p, int n);
1c79356b A	155	#define fdfile(p, fd) \
	156	(&(p)->p_fd->fd_ofiles[(fd)])
	157	#define fdflags(p, fd) \
	158	(&(p)->p_fd->fd_ofileflags[(fd)])
3e170ce0 A	159
	160	/*
	161	* Accesor macros for fd flags
	162	*/
	163	#define FDFLAGS_GET(p, fd) (*fdflags(p, fd) & (UF_EXCLOSE\|UF_FORKCLOSE))
	164	#define FDFLAGS_SET(p, fd, bits) \
	165	(*fdflags(p, fd) \|= ((bits) & (UF_EXCLOSE\|UF_FORKCLOSE)))
	166	#define FDFLAGS_CLR(p, fd, bits) \
	167	(*fdflags(p, fd) &= ~((bits) & (UF_EXCLOSE\|UF_FORKCLOSE)))
	168
2d21ac55	169	extern int falloc(proc_t p, struct fileproc *resultfp, int resultfd, vfs_context_t ctx);
9bccf70c A	170
9bccf70c A	171	#ifdef __APPLE_API_PRIVATE
39236c6e A	172	typedef struct fileproc (fp_allocfn_t)(void *);
	173	extern int falloc_withalloc(proc_t p, struct fileproc **resultfp,
	174	int *resultfd, vfs_context_t ctx,
	175	fp_allocfn_t fp_zalloc, void *crarg);
	176
2d21ac55 A	177	extern struct filedesc fdcopy(proc_t p, struct vnode uth_cdir);
2d21ac55 A	178	extern void fdfree(proc_t p);
5ba3f43e	179	extern void fdexec(proc_t p, short flags, int self_exec);
9bccf70c	180	#endif /* __APPLE_API_PRIVATE */
1c79356b A	181
	182	#endif /* KERNEL */
	183
b0d623f7	184	#endif /* BSD_KERNEL_PRIVATE */
9bccf70c	185
1c79356b	186	#endif /* !_SYS_FILEDESC_H_ */