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

/*
 * Copyright (c) 2000-2002 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) 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);
__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	*
8f6c56a5	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
91447636	5	*
8f6c56a5 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.
	14	*
	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
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
8ad349bb	24	* limitations under the License.
8f6c56a5 A	25	*
8f6c56a5 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
91447636 A	27	*/
	28	/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
	29	/*
	30	* Copyright (c) 1982, 1986, 1989, 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	* @(#)file.h 8.3 (Berkeley) 1/9/95
	62	*/
	63
	64	#ifndef _SYS_FILE_INTERNAL_H_
	65	#define _SYS_FILE_INTERNAL_H_
	66
	67	#include <sys/appleapiopts.h>
	68	#include <sys/fcntl.h>
	69	#include <sys/unistd.h>
	70
	71	#ifdef KERNEL
	72	#include <sys/errno.h>
	73	#include <sys/queue.h>
	74	#include <sys/cdefs.h>
	75	#include <sys/lock.h>
	76	#include <sys/file.h>
	77
	78	struct proc;
	79	struct uio;
	80	struct knote;
	81	#ifdef __APPLE_API_UNSTABLE
	82
	83	struct file;
	84
	85
	86	/*
	87	* Kernel descriptor table.
	88	* One entry for each open kernel vnode and socket.
	89	*/
	90	struct fileproc {
91	int32_t f_flags;
92	int32_t f_iocount;
93	struct fileglob * f_fglob;
94	void * f_waddr;
95	};
96
97	#define FILEPROC_NULL (struct fileproc *)0
98
99	#define FP_INCREATE 0x0001
100	#define FP_INCLOSE 0x0002
101	#define FP_INSELECT 0x0004
102	#define FP_INCHRREAD 0x0008
103	#define FP_WRITTEN 0x0010
104	#define FP_CLOSING 0x0020
105	#define FP_WAITCLOSE 0x0040
106	#define FP_AIOISSUED 0x0080
107	#define FP_WAITEVENT 0x0100
108
109
110	/* defns of close_internal */
111	#define CLOSEINT_LOCKED 1
112	#define CLOSEINT_WAITONCLOSE 2
113	#define CLOSEINT_NOFDRELSE 4
114	#define CLOSEINT_NOFDNOREF 8
8f6c56a5 A	115
	116	/* file types */
	117	typedef enum {
	118	DTYPE_VNODE = 1, /* file */
	119	DTYPE_SOCKET, /* communications endpoint */
	120	DTYPE_PSXSHM, /* POSIX Shared memory */
	121	DTYPE_PSXSEM, /* POSIX Semaphores */
	122	DTYPE_KQUEUE, /* kqueue */
	123	DTYPE_PIPE, /* pipe */
	124	DTYPE_FSEVENTS /* fsevents */
	125	} file_type_t;
	126
	127	/* defines for fg_lflags */
	128	#define FG_TERM 0x01 /* the fileglob is terminating .. */
	129	#define FG_INSMSGQ 0x02 /* insert to msgqueue pending .. */
	130	#define FG_WINSMSGQ 0x04 /* wait for the fielglob is in msgque */
	131	#define FG_RMMSGQ 0x08 /* the fileglob is being removed from msgqueue */
	132	#define FG_WRMMSGQ 0x10 /* wait for the fileglob to be removed from msgqueue */
	133
91447636 A	134
	135	struct fileglob {
	136	LIST_ENTRY(fileglob) f_list;/* list of active files */
	137	LIST_ENTRY(fileglob) f_msglist;/* list of active files */
	138	int32_t fg_flag; /* see fcntl.h */
8f6c56a5	139	file_type_t fg_type; /* descriptor type */
91447636 A	140	int32_t fg_count; /* reference count */
	141	int32_t fg_msgcount; /* references from message queue */
	142	struct ucred fg_cred; / credentials associated with descriptor */
	143	struct fileops {
	144	int (fo_read) __P((struct fileproc fp, struct uio *uio,
	145	struct ucred *cred, int flags,
	146	struct proc *p));
	147	int (fo_write) __P((struct fileproc fp, struct uio *uio,
	148	struct ucred *cred, int flags,
	149	struct proc *p));
13fec989 A	150	#define FOF_OFFSET 0x00000001 /* offset supplied to vn_write */
13fec989 A	151	#define FOF_PCRED 0x00000002 /* cred from proc, not current thread */
91447636 A	152	int (fo_ioctl) __P((struct fileproc fp, u_long com,
	153	caddr_t data, struct proc *p));
	154	int (fo_select) __P((struct fileproc fp, int which,
	155	void wql, struct proc p));
	156	int (fo_close) __P((struct fileglob fg, struct proc *p));
	157	int (fo_kqfilter) __P((struct fileproc fp, struct knote *kn,
	158	struct proc *p));
	159	int (fo_drain) (struct fileproc fp, struct proc *p);
	160	} *fg_ops;
	161	off_t fg_offset;
	162	caddr_t fg_data; /* vnode or socket or SHM or semaphore */
	163	lck_mtx_t fg_lock;
	164	int32_t fg_lflags; /* file global flags */
	165	unsigned int fg_lockpc[4];
	166	unsigned int fg_unlockpc[4];
	167	};
	168
91447636 A	169	#ifdef __APPLE_API_PRIVATE
	170	LIST_HEAD(filelist, fileglob);
	171	LIST_HEAD(fmsglist, fileglob);
	172	extern struct filelist filehead; /* head of list of open files */
	173	extern struct fmsglist fmsghead; /* head of list of open files */
	174	extern int maxfiles; /* kernel limit on number of open files */
	175	extern int nfiles; /* actual number of open files */
	176	#endif /* __APPLE_API_PRIVATE */
	177
	178
	179	__BEGIN_DECLS
	180	int fo_read(struct fileproc fp, struct uio uio,
	181	struct ucred cred, int flags, struct proc p);
	182	int fo_write(struct fileproc fp, struct uio uio,
	183	struct ucred cred, int flags, struct proc p);
	184	int fo_ioctl(struct fileproc *fp, u_long com, caddr_t data,
	185	struct proc *p);
	186	int fo_select(struct fileproc fp, int which, void wql,
	187	struct proc *p);
	188	int fo_close(struct fileglob fg, struct proc p);
	189	int fo_kqfilter(struct fileproc fp, struct knote kn,
	190	struct proc *p);
	191	void fileproc_drain(proc_t, struct fileproc *);
	192	void fp_setflags(proc_t, struct fileproc *, int);
	193	void fp_clearflags(proc_t, struct fileproc *, int);
	194	int fp_drop(struct proc p, int fd, struct fileproc fp, int locked);
	195	int fp_drop_written(proc_t p, int fd, struct fileproc *fp);
	196	int fp_drop_event(proc_t p, int fd, struct fileproc *fp);
	197	int fp_free(struct proc * p, int fd, struct fileproc * fp);
	198	struct kqueue;
	199	int fp_getfkq(struct proc p, int fd, struct fileproc resultfp, struct kqueue *resultkq);
	200	struct psemnode;
	201	int fp_getfpsem(struct proc p, int fd, struct fileproc resultfp, struct psemnode *resultpsem);
89b3af67 A	202	struct pshmnode;
	203	int fp_getfpshm(struct proc p, int fd, struct fileproc resultfp, struct pshmnode *resultpshm);
	204	struct pipe;
	205	int fp_getfpipe(struct proc p, int fd, struct fileproc resultfp, struct pipe *resultpipe);
	206	struct atalk;
	207	int fp_getfatalk(struct proc p, int fd, struct fileproc resultfp, struct atalk *resultatalk);
91447636 A	208	struct vnode;
91447636 A	209	int fp_getfvp(struct proc p, int fd, struct fileproc resultfp, struct vnode *resultvp);
89b3af67	210	int fp_getfvpandvid(struct proc p, int fd, struct fileproc resultfp, struct vnode resultvp, uint32_t vidp);
91447636 A	211	struct socket;
	212	int fp_getfsock(struct proc p, int fd, struct fileproc resultfp, struct socket *results);
	213	int fp_lookup(struct proc p, int fd, struct fileproc *resultfp, int locked);
	214	int close_internal(struct proc p, int fd, struct fileproc fp, int flags);
	215	int closef_locked(struct fileproc fp, struct fileglob fg, struct proc *p);
	216	void fg_insertuipc(struct fileglob * fg);
	217	void fg_removeuipc(struct fileglob * fg);
	218	__END_DECLS
	219
	220	#endif /* __APPLE_API_UNSTABLE */
	221
	222	#endif /* KERNEL */
	223
	224	#endif /* !_SYS_FILE_INTERNAL_H_ */