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

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1982, 1986, 1989, 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.
 *
 *	@(#)file.h	8.3 (Berkeley) 1/9/95
 */

#ifndef _SYS_FILE_INTERNAL_H_
#define	_SYS_FILE_INTERNAL_H_

#include <sys/appleapiopts.h>
#include <sys/fcntl.h>
#include <sys/unistd.h>

#ifdef KERNEL
#include <sys/errno.h>
#include <sys/queue.h>
#include <sys/cdefs.h>
#include <sys/lock.h>
#include <sys/file.h>

struct proc;
struct uio;
struct knote;
#ifdef __APPLE_API_UNSTABLE

struct file;


/*
 * Kernel descriptor table.
 * One entry for each open kernel vnode and socket.
 */
struct fileproc {
	int32_t	f_flags;
	int32_t f_iocount;
	struct fileglob * f_fglob;
	void *	f_waddr;
};

#define FILEPROC_NULL (struct fileproc *)0

#define FP_INCREATE 	0x0001
#define FP_INCLOSE 	0x0002
#define FP_INSELECT	0x0004
#define FP_INCHRREAD	0x0008
#define FP_WRITTEN	0x0010
#define FP_CLOSING	0x0020
#define FP_WAITCLOSE	0x0040
#define FP_AIOISSUED	0x0080
#define FP_WAITEVENT	0x0100


/* defns of close_internal */
#define CLOSEINT_LOCKED     1
#define CLOSEINT_WAITONCLOSE 2
#define CLOSEINT_NOFDRELSE  4
#define CLOSEINT_NOFDNOREF  8
  
/* file types */
typedef enum {
	DTYPE_VNODE     = 1,    /* file */
	DTYPE_SOCKET,           /* communications endpoint */
	DTYPE_PSXSHM,           /* POSIX Shared memory */
	DTYPE_PSXSEM,           /* POSIX Semaphores */
	DTYPE_KQUEUE,           /* kqueue */
	DTYPE_PIPE,             /* pipe */
	DTYPE_FSEVENTS          /* fsevents */
} file_type_t;

/* defines for fg_lflags */
#define FG_TERM        0x01    /* the fileglob is terminating .. */
#define FG_INSMSGQ     0x02    /* insert to msgqueue pending .. */
#define FG_WINSMSGQ    0x04    /* wait for the fielglob is in msgque */
#define FG_RMMSGQ      0x08    /* the fileglob is being removed from msgqueue */
#define FG_WRMMSGQ     0x10    /* wait for the fileglob to  be removed from msgqueue */


struct fileglob {
	LIST_ENTRY(fileglob) f_list;/* list of active files */
	LIST_ENTRY(fileglob) f_msglist;/* list of active files */
	int32_t	fg_flag;		/* see fcntl.h */
	file_type_t fg_type;		/* descriptor type */
	int32_t	fg_count;	/* reference count */
	int32_t	fg_msgcount;	/* references from message queue */
	struct	ucred *fg_cred;	/* credentials associated with descriptor */
	struct	fileops {
		int	(*fo_read)	__P((struct fileproc *fp, struct uio *uio,
					    struct ucred *cred, int flags,
					    struct proc *p));
		int	(*fo_write)	__P((struct fileproc *fp, struct uio *uio,
					    struct ucred *cred, int flags,
					    struct proc *p));
#define	FOF_OFFSET	0x00000001	/* offset supplied to vn_write */
#define FOF_PCRED	0x00000002	/* cred from proc, not current thread */
		int	(*fo_ioctl)	__P((struct fileproc *fp, u_long com,
					    caddr_t data, struct proc *p));
		int	(*fo_select)	__P((struct fileproc *fp, int which,
						void *wql, struct proc *p));
		int	(*fo_close)	__P((struct fileglob *fg, struct proc *p));
		int	(*fo_kqfilter)	__P((struct fileproc *fp, struct knote *kn,
					     struct proc *p));
		int	(*fo_drain)	(struct fileproc *fp, struct proc *p);
	} *fg_ops;
	off_t	fg_offset;
	caddr_t	fg_data;		/* vnode or socket or SHM or semaphore */
	lck_mtx_t fg_lock;
	int32_t fg_lflags;		/* file global flags */
	unsigned int fg_lockpc[4];
	unsigned int fg_unlockpc[4];
};

#ifdef __APPLE_API_PRIVATE
LIST_HEAD(filelist, fileglob);
LIST_HEAD(fmsglist, fileglob);
extern struct filelist filehead;	/* head of list of open files */
extern struct fmsglist fmsghead;	/* head of list of open files */
extern int maxfiles;			/* kernel limit on number of open files */
extern int nfiles;			/* actual number of open files */
#endif /* __APPLE_API_PRIVATE */


__BEGIN_DECLS
int fo_read(struct fileproc *fp, struct uio *uio,
	struct ucred *cred, int flags, struct proc *p);
int fo_write(struct fileproc *fp, struct uio *uio,
	struct ucred *cred, int flags, struct proc *p);
int fo_ioctl(struct fileproc *fp, u_long com, caddr_t data,
	struct proc *p);
int fo_select(struct fileproc *fp, int which, void *wql,
	struct proc *p);
int fo_close(struct fileglob *fg, struct proc *p);
int fo_kqfilter(struct fileproc *fp, struct knote *kn,
	struct proc *p);
void fileproc_drain(proc_t, struct fileproc *);
void fp_setflags(proc_t, struct fileproc *, int);
void fp_clearflags(proc_t, struct fileproc *, int);
int fp_drop(struct proc *p, int fd, struct fileproc *fp, int locked);
int fp_drop_written(proc_t p, int fd, struct fileproc *fp);
int fp_drop_event(proc_t p, int fd, struct fileproc *fp);
int fp_free(struct proc * p, int fd, struct fileproc * fp);
struct kqueue;
int fp_getfkq(struct proc *p, int fd, struct fileproc **resultfp, struct kqueue  **resultkq);
struct psemnode;
int fp_getfpsem(struct proc *p, int fd, struct fileproc **resultfp, struct psemnode  **resultpsem);
struct pshmnode;
int fp_getfpshm(struct proc *p, int fd, struct fileproc **resultfp, struct pshmnode  **resultpshm);
struct pipe;
int fp_getfpipe(struct proc *p, int fd, struct fileproc **resultfp, struct pipe  **resultpipe);
struct atalk;
int fp_getfatalk(struct proc *p, int fd, struct fileproc **resultfp, struct atalk  **resultatalk);
struct vnode;
int fp_getfvp(struct proc *p, int fd, struct fileproc **resultfp, struct vnode  **resultvp);
int fp_getfvpandvid(struct proc *p, int fd, struct fileproc **resultfp, struct vnode  **resultvp, uint32_t * vidp);
struct socket;
int fp_getfsock(struct proc *p, int fd, struct fileproc **resultfp, struct socket  **results);
int fp_lookup(struct proc *p, int fd, struct fileproc **resultfp, int locked);
int close_internal(struct proc *p, int fd, struct fileproc *fp, int flags);
int closef_locked(struct fileproc *fp, struct fileglob *fg, struct proc *p);
void fg_insertuipc(struct fileglob * fg);
void fg_removeuipc(struct fileglob * fg);
void unp_gc_wait(void);
void procfdtbl_reservefd(struct proc * p, int fd);
void procfdtbl_markclosefd(struct proc * p, int fd);
void procfdtbl_releasefd(struct proc * p, int fd, struct fileproc * fp);
void procfdtbl_waitfd(struct proc * p, int fd);
void procfdtbl_clearfd(struct proc * p, int fd);
__END_DECLS

#endif /* __APPLE_API_UNSTABLE */

#endif /* KERNEL */

#endif /* !_SYS_FILE_INTERNAL_H_ */
Commit	Line	Data
91447636	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
6601e61a	4	* @APPLE_LICENSE_HEADER_START@
91447636	5	*
6601e61a A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
8f6c56a5	11	*
6601e61a A	12	* This Original Code and all software distributed under the License are
6601e61a A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
6601e61a A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
8f6c56a5	19	*
6601e61a	20	* @APPLE_LICENSE_HEADER_END@
91447636 A	21	*/
	22	/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
	23	/*
	24	* Copyright (c) 1982, 1986, 1989, 1993
	25	* The Regents of the University of California. All rights reserved.
	26	*
	27	* Redistribution and use in source and binary forms, with or without
	28	* modification, are permitted provided that the following conditions
	29	* are met:
	30	* 1. Redistributions of source code must retain the above copyright
	31	* notice, this list of conditions and the following disclaimer.
	32	* 2. Redistributions in binary form must reproduce the above copyright
	33	* notice, this list of conditions and the following disclaimer in the
	34	* documentation and/or other materials provided with the distribution.
	35	* 3. All advertising materials mentioning features or use of this software
	36	* must display the following acknowledgement:
	37	* This product includes software developed by the University of
	38	* California, Berkeley and its contributors.
	39	* 4. Neither the name of the University nor the names of its contributors
	40	* may be used to endorse or promote products derived from this software
	41	* without specific prior written permission.
	42	*
	43	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	44	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	45	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	46	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	47	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	48	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	49	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	50	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	51	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	52	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	53	* SUCH DAMAGE.
	54	*
	55	* @(#)file.h 8.3 (Berkeley) 1/9/95
	56	*/
	57
	58	#ifndef _SYS_FILE_INTERNAL_H_
	59	#define _SYS_FILE_INTERNAL_H_
	60
	61	#include <sys/appleapiopts.h>
	62	#include <sys/fcntl.h>
	63	#include <sys/unistd.h>
	64
	65	#ifdef KERNEL
	66	#include <sys/errno.h>
	67	#include <sys/queue.h>
	68	#include <sys/cdefs.h>
	69	#include <sys/lock.h>
	70	#include <sys/file.h>
	71
	72	struct proc;
	73	struct uio;
	74	struct knote;
	75	#ifdef __APPLE_API_UNSTABLE
	76
	77	struct file;
	78
	79
	80	/*
	81	* Kernel descriptor table.
	82	* One entry for each open kernel vnode and socket.
	83	*/
	84	struct fileproc {
85	int32_t f_flags;
86	int32_t f_iocount;
87	struct fileglob * f_fglob;
88	void * f_waddr;
89	};
90
91	#define FILEPROC_NULL (struct fileproc *)0
92
93	#define FP_INCREATE 0x0001
94	#define FP_INCLOSE 0x0002
95	#define FP_INSELECT 0x0004
96	#define FP_INCHRREAD 0x0008
97	#define FP_WRITTEN 0x0010
98	#define FP_CLOSING 0x0020
99	#define FP_WAITCLOSE 0x0040
100	#define FP_AIOISSUED 0x0080
101	#define FP_WAITEVENT 0x0100
102
103
104	/* defns of close_internal */
105	#define CLOSEINT_LOCKED 1
106	#define CLOSEINT_WAITONCLOSE 2
107	#define CLOSEINT_NOFDRELSE 4
108	#define CLOSEINT_NOFDNOREF 8
8f6c56a5 A	109
	110	/* file types */
	111	typedef enum {
	112	DTYPE_VNODE = 1, /* file */
	113	DTYPE_SOCKET, /* communications endpoint */
	114	DTYPE_PSXSHM, /* POSIX Shared memory */
	115	DTYPE_PSXSEM, /* POSIX Semaphores */
	116	DTYPE_KQUEUE, /* kqueue */
	117	DTYPE_PIPE, /* pipe */
	118	DTYPE_FSEVENTS /* fsevents */
	119	} file_type_t;
	120
	121	/* defines for fg_lflags */
	122	#define FG_TERM 0x01 /* the fileglob is terminating .. */
	123	#define FG_INSMSGQ 0x02 /* insert to msgqueue pending .. */
	124	#define FG_WINSMSGQ 0x04 /* wait for the fielglob is in msgque */
	125	#define FG_RMMSGQ 0x08 /* the fileglob is being removed from msgqueue */
	126	#define FG_WRMMSGQ 0x10 /* wait for the fileglob to be removed from msgqueue */
	127
91447636 A	128
	129	struct fileglob {
	130	LIST_ENTRY(fileglob) f_list;/* list of active files */
	131	LIST_ENTRY(fileglob) f_msglist;/* list of active files */
	132	int32_t fg_flag; /* see fcntl.h */
8f6c56a5	133	file_type_t fg_type; /* descriptor type */
91447636 A	134	int32_t fg_count; /* reference count */
	135	int32_t fg_msgcount; /* references from message queue */
	136	struct ucred fg_cred; / credentials associated with descriptor */
	137	struct fileops {
	138	int (fo_read) __P((struct fileproc fp, struct uio *uio,
	139	struct ucred *cred, int flags,
	140	struct proc *p));
	141	int (fo_write) __P((struct fileproc fp, struct uio *uio,
	142	struct ucred *cred, int flags,
	143	struct proc *p));
13fec989 A	144	#define FOF_OFFSET 0x00000001 /* offset supplied to vn_write */
13fec989 A	145	#define FOF_PCRED 0x00000002 /* cred from proc, not current thread */
91447636 A	146	int (fo_ioctl) __P((struct fileproc fp, u_long com,
	147	caddr_t data, struct proc *p));
	148	int (fo_select) __P((struct fileproc fp, int which,
	149	void wql, struct proc p));
	150	int (fo_close) __P((struct fileglob fg, struct proc *p));
	151	int (fo_kqfilter) __P((struct fileproc fp, struct knote *kn,
	152	struct proc *p));
	153	int (fo_drain) (struct fileproc fp, struct proc *p);
	154	} *fg_ops;
	155	off_t fg_offset;
	156	caddr_t fg_data; /* vnode or socket or SHM or semaphore */
	157	lck_mtx_t fg_lock;
	158	int32_t fg_lflags; /* file global flags */
	159	unsigned int fg_lockpc[4];
	160	unsigned int fg_unlockpc[4];
	161	};
	162
91447636 A	163	#ifdef __APPLE_API_PRIVATE
	164	LIST_HEAD(filelist, fileglob);
	165	LIST_HEAD(fmsglist, fileglob);
	166	extern struct filelist filehead; /* head of list of open files */
	167	extern struct fmsglist fmsghead; /* head of list of open files */
	168	extern int maxfiles; /* kernel limit on number of open files */
	169	extern int nfiles; /* actual number of open files */
	170	#endif /* __APPLE_API_PRIVATE */
	171
	172
	173	__BEGIN_DECLS
	174	int fo_read(struct fileproc fp, struct uio uio,
	175	struct ucred cred, int flags, struct proc p);
	176	int fo_write(struct fileproc fp, struct uio uio,
	177	struct ucred cred, int flags, struct proc p);
	178	int fo_ioctl(struct fileproc *fp, u_long com, caddr_t data,
	179	struct proc *p);
	180	int fo_select(struct fileproc fp, int which, void wql,
	181	struct proc *p);
	182	int fo_close(struct fileglob fg, struct proc p);
	183	int fo_kqfilter(struct fileproc fp, struct knote kn,
	184	struct proc *p);
	185	void fileproc_drain(proc_t, struct fileproc *);
	186	void fp_setflags(proc_t, struct fileproc *, int);
	187	void fp_clearflags(proc_t, struct fileproc *, int);
	188	int fp_drop(struct proc p, int fd, struct fileproc fp, int locked);
	189	int fp_drop_written(proc_t p, int fd, struct fileproc *fp);
	190	int fp_drop_event(proc_t p, int fd, struct fileproc *fp);
	191	int fp_free(struct proc * p, int fd, struct fileproc * fp);
	192	struct kqueue;
	193	int fp_getfkq(struct proc p, int fd, struct fileproc resultfp, struct kqueue *resultkq);
	194	struct psemnode;
	195	int fp_getfpsem(struct proc p, int fd, struct fileproc resultfp, struct psemnode *resultpsem);
0c530ab8 A	196	struct pshmnode;
	197	int fp_getfpshm(struct proc p, int fd, struct fileproc resultfp, struct pshmnode *resultpshm);
	198	struct pipe;
	199	int fp_getfpipe(struct proc p, int fd, struct fileproc resultfp, struct pipe *resultpipe);
	200	struct atalk;
	201	int fp_getfatalk(struct proc p, int fd, struct fileproc resultfp, struct atalk *resultatalk);
91447636 A	202	struct vnode;
91447636 A	203	int fp_getfvp(struct proc p, int fd, struct fileproc resultfp, struct vnode *resultvp);
0c530ab8	204	int fp_getfvpandvid(struct proc p, int fd, struct fileproc resultfp, struct vnode resultvp, uint32_t vidp);
91447636 A	205	struct socket;
	206	int fp_getfsock(struct proc p, int fd, struct fileproc resultfp, struct socket *results);
	207	int fp_lookup(struct proc p, int fd, struct fileproc *resultfp, int locked);
	208	int close_internal(struct proc p, int fd, struct fileproc fp, int flags);
	209	int closef_locked(struct fileproc fp, struct fileglob fg, struct proc *p);
	210	void fg_insertuipc(struct fileglob * fg);
	211	void fg_removeuipc(struct fileglob * fg);
6601e61a A	212	void unp_gc_wait(void);
	213	void procfdtbl_reservefd(struct proc * p, int fd);
	214	void procfdtbl_markclosefd(struct proc * p, int fd);
	215	void procfdtbl_releasefd(struct proc * p, int fd, struct fileproc * fp);
	216	void procfdtbl_waitfd(struct proc * p, int fd);
	217	void procfdtbl_clearfd(struct proc * p, int fd);
91447636 A	218	__END_DECLS
	219
	220	#endif /* __APPLE_API_UNSTABLE */
	221
	222	#endif /* KERNEL */
	223
	224	#endif /* !_SYS_FILE_INTERNAL_H_ */