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

/*
 * Copyright (c) 2000-2016 Apple 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>
#include <sys/filedesc.h>
#include <sys/guarded.h>

struct proc;
struct uio;
struct knote;
struct kevent_internal_s;

#ifdef __APPLE_API_UNSTABLE

struct file;


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

#define FILEPROC_NULL (struct fileproc *)0

#define FP_INCREATE     0x0001
#define FP_INCLOSE      0x0002
#define FP_INSELECT     0x0004
#define FP_UNUSED       0x0008  /* unused (was FP_INCHRREAD) */
#define FP_WRITTEN      0x0010
#define FP_CLOSING      0x0020
#define FP_WAITCLOSE    0x0040
#define FP_AIOISSUED    0x0080
#define FP_WAITEVENT    0x0100
#define FP_SELCONFLICT  0x0200  /* select conflict on an individual fp */

/* squeeze a "type" value into the upper flag bits */

#define _FP_TYPESHIFT   24
#define FP_TYPEMASK     (0x7 << _FP_TYPESHIFT)  /* 8 "types" of fileproc */

#define FILEPROC_TYPE(fp)       ((fp)->f_flags & FP_TYPEMASK)

#define FP_ISGUARDED(fp, attribs)  \
	        ((FILEPROC_TYPE(fp) == FTYPE_GUARDED) ? fp_isguarded(fp, attribs) : 0)

typedef enum {
	FTYPE_SIMPLE    = 0,
	FTYPE_GUARDED   = (1 << _FP_TYPESHIFT)
} fileproc_type_t;

#define FP_VALID_FLAGS  (FP_INCREATE | FP_INCLOSE | FP_INSELECT |\
	        FP_WRITTEN | FP_CLOSING | FP_WAITCLOSE |\
	        FP_AIOISSUED | FP_WAITEVENT | FP_SELCONFLICT | _FP_TYPEMASK)

#ifndef _KAUTH_CRED_T
#define _KAUTH_CRED_T
struct ucred;
typedef struct ucred *kauth_cred_t;
struct posix_cred;
typedef struct posix_cred *posix_cred_t;
#endif  /* !_KAUTH_CRED_T */

/* 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 */
	DTYPE_ATALK,            /* (obsolete) */
	DTYPE_NETPOLICY,        /* networking policy */
} 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 */
#define FG_PORTMADE     0x20    /* a port was at some point created for this fileglob */
#define FG_NOSIGPIPE    0x40    /* don't deliver SIGPIPE with EPIPE return */
#define FG_OFF_LOCKED   0x80    /* Used as a mutex for offset changes (for vnodes) */
#define FG_OFF_LOCKWANT 0x100   /* Somebody's wating for the lock */
#define FG_CONFINED     0x200   /* fileglob confined to process, immutably */
#define FG_HAS_OFDLOCK  0x400   /* Has or has had an OFD lock */

struct fileglob {
	LIST_ENTRY(fileglob) f_msglist;/* list of active files */
	int32_t fg_flag;                /* see fcntl.h */
	int32_t fg_count;       /* reference count */
	int32_t fg_msgcount;    /* references from message queue */
	int32_t fg_lflags;      /* file global flags */
	kauth_cred_t fg_cred;   /* credentials associated with descriptor */
	const struct fileops {
		file_type_t     fo_type;        /* descriptor type */
		int     (*fo_read)      (struct fileproc *fp, struct uio *uio,
		    int flags, vfs_context_t ctx);
		int     (*fo_write)     (struct fileproc *fp, struct uio *uio,
		    int flags, vfs_context_t ctx);
#define FOF_OFFSET      0x00000001      /* offset supplied to vn_write */
#define FOF_PCRED       0x00000002      /* cred from proc, not current thread */
		int     (*fo_ioctl)(struct fileproc *fp, u_long com,
		    caddr_t data, vfs_context_t ctx);
		int     (*fo_select)    (struct fileproc *fp, int which,
		    void *wql, vfs_context_t ctx);
		int     (*fo_close)     (struct fileglob *fg, vfs_context_t ctx);
		int     (*fo_kqfilter)  (struct fileproc *fp, struct knote *kn,
		    struct kevent_internal_s *kev, vfs_context_t ctx);
		int     (*fo_drain)     (struct fileproc *fp, vfs_context_t ctx);
	} *fg_ops;
	off_t   fg_offset;
	void    *fg_data;       /* vnode or socket or SHM or semaphore */
	void    *fg_vn_data;    /* Per fd vnode data, used for directories */
	lck_mtx_t fg_lock;
#if CONFIG_MACF
	struct label *fg_label;  /* JMM - use the one in the cred? */
#endif
};

#ifdef __APPLE_API_PRIVATE
LIST_HEAD(fmsglist, fileglob);
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 */
extern int maxfilesperproc;

#define FILEGLOB_DTYPE(fg)              ((const file_type_t)((fg)->fg_ops->fo_type))
#endif /* __APPLE_API_PRIVATE */


__BEGIN_DECLS
int fo_read(struct fileproc *fp, struct uio *uio, int flags, vfs_context_t ctx);
int fo_write(struct fileproc *fp, struct uio *uio, int flags,
    vfs_context_t ctx);
int fo_ioctl(struct fileproc *fp, u_long com, caddr_t data, vfs_context_t ctx);
int fo_select(struct fileproc *fp, int which, void *wql, vfs_context_t ctx);
int fo_close(struct fileglob *fg, vfs_context_t ctx);
int fo_kqfilter(struct fileproc *fp, struct knote *kn,
    struct kevent_internal_s *kev, vfs_context_t ctx);
void fileproc_drain(proc_t, struct fileproc *);
int fp_tryswap(proc_t, int fd, struct fileproc *nfp);
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_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 fp_isguarded(struct fileproc *fp, u_int attribs);
int fp_guard_exception(proc_t p, int fd, struct fileproc *fp, u_int attribs);
int closef_locked(struct fileproc *fp, struct fileglob *fg, struct proc *p);
int close_internal_locked(proc_t p, int fd, struct fileproc *fp, int flags);
struct nameidata;
struct vnode_attr;
int open1(vfs_context_t ctx, struct nameidata *ndp, int uflags,
    struct vnode_attr *vap, fp_allocfn_t fp_zalloc, void *cra,
    int32_t *retval);
int kqueue_body(struct proc *p, fp_allocfn_t, void *cra, int32_t *retval);
void fg_insertuipc(struct fileglob * fg);
boolean_t fg_insertuipc_mark(struct fileglob * fg);
void fg_removeuipc(struct fileglob * fg);
boolean_t fg_removeuipc_mark(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);
boolean_t file_issendable(struct proc * p, struct fileproc *fp);
extern int fdgetf_noref(proc_t, int, struct fileproc **);
extern struct fileproc *fileproc_alloc_init(void *crargs);
extern void fileproc_free(struct fileproc *fp);
extern void guarded_fileproc_free(struct fileproc *fp);
extern void fg_vn_data_free(void *fgvndata);
extern int nameiat(struct nameidata *ndp, int dirfd);
extern int falloc_guarded(struct proc *p, struct fileproc **fp, int *fd,
    vfs_context_t ctx, const guardid_t *guard, u_int attrs);
__END_DECLS

#endif /* __APPLE_API_UNSTABLE */

#endif /* KERNEL */

#endif /* !_SYS_FILE_INTERNAL_H_ */
Commit	Line	Data
91447636	1	/*
39037602	2	* Copyright (c) 2000-2016 Apple Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
0a7de745	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.
0a7de745	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
2d21ac55 A	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
0a7de745	17	*
2d21ac55 A	18	* The Original Code and all software distributed under the License are
2d21ac55 A	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.
0a7de745	25	*
2d21ac55	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_
0a7de745	65	#define _SYS_FILE_INTERNAL_H_
91447636 A	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>
39236c6e	77	#include <sys/filedesc.h>
39037602	78	#include <sys/guarded.h>
91447636 A	79
	80	struct proc;
	81	struct uio;
	82	struct knote;
5ba3f43e A	83	struct kevent_internal_s;
5ba3f43e A	84
91447636 A	85	#ifdef __APPLE_API_UNSTABLE
	86
	87	struct file;
	88
	89
	90	/*
	91	* Kernel descriptor table.
	92	* One entry for each open kernel vnode and socket.
	93	*/
	94	struct fileproc {
2d21ac55	95	unsigned int f_flags;
91447636 A	96	int32_t f_iocount;
91447636 A	97	struct fileglob * f_fglob;
3e170ce0	98	void *f_wset;
91447636 A	99	};
	100
	101	#define FILEPROC_NULL (struct fileproc *)0
	102
0a7de745 A	103	#define FP_INCREATE 0x0001
	104	#define FP_INCLOSE 0x0002
	105	#define FP_INSELECT 0x0004
	106	#define FP_UNUSED 0x0008 /* unused (was FP_INCHRREAD) */
	107	#define FP_WRITTEN 0x0010
	108	#define FP_CLOSING 0x0020
	109	#define FP_WAITCLOSE 0x0040
	110	#define FP_AIOISSUED 0x0080
	111	#define FP_WAITEVENT 0x0100
	112	#define FP_SELCONFLICT 0x0200 /* select conflict on an individual fp */
91447636	113
39236c6e	114	/* squeeze a "type" value into the upper flag bits */
2d21ac55	115
0a7de745 A	116	#define _FP_TYPESHIFT 24
0a7de745 A	117	#define FP_TYPEMASK (0x7 << _FP_TYPESHIFT) /* 8 "types" of fileproc */
39236c6e	118
0a7de745	119	#define FILEPROC_TYPE(fp) ((fp)->f_flags & FP_TYPEMASK)
39236c6e A	120
	121	#define FP_ISGUARDED(fp, attribs) \
	122	((FILEPROC_TYPE(fp) == FTYPE_GUARDED) ? fp_isguarded(fp, attribs) : 0)
	123
	124	typedef enum {
0a7de745 A	125	FTYPE_SIMPLE = 0,
0a7de745 A	126	FTYPE_GUARDED = (1 << _FP_TYPESHIFT)
39236c6e A	127	} fileproc_type_t;
39236c6e A	128
0a7de745 A	129	#define FP_VALID_FLAGS (FP_INCREATE \| FP_INCLOSE \| FP_INSELECT \|\
	130	FP_WRITTEN \| FP_CLOSING \| FP_WAITCLOSE \|\
	131	FP_AIOISSUED \| FP_WAITEVENT \| FP_SELCONFLICT \| _FP_TYPEMASK)
2d21ac55 A	132
2d21ac55 A	133	#ifndef _KAUTH_CRED_T
0a7de745	134	#define _KAUTH_CRED_T
2d21ac55 A	135	struct ucred;
2d21ac55 A	136	typedef struct ucred *kauth_cred_t;
6d2010ae A	137	struct posix_cred;
6d2010ae A	138	typedef struct posix_cred *posix_cred_t;
0a7de745	139	#endif /* !_KAUTH_CRED_T */
91447636	140
8f6c56a5 A	141	/* file types */
8f6c56a5 A	142	typedef enum {
0a7de745 A	143	DTYPE_VNODE = 1, /* file */
	144	DTYPE_SOCKET, /* communications endpoint */
	145	DTYPE_PSXSHM, /* POSIX Shared memory */
	146	DTYPE_PSXSEM, /* POSIX Semaphores */
	147	DTYPE_KQUEUE, /* kqueue */
	148	DTYPE_PIPE, /* pipe */
	149	DTYPE_FSEVENTS, /* fsevents */
	150	DTYPE_ATALK, /* (obsolete) */
	151	DTYPE_NETPOLICY, /* networking policy */
8f6c56a5 A	152	} file_type_t;
	153
	154	/* defines for fg_lflags */
0a7de745 A	155	#define FG_TERM 0x01 /* the fileglob is terminating .. */
	156	#define FG_INSMSGQ 0x02 /* insert to msgqueue pending .. */
	157	#define FG_WINSMSGQ 0x04 /* wait for the fielglob is in msgque */
	158	#define FG_RMMSGQ 0x08 /* the fileglob is being removed from msgqueue */
	159	#define FG_WRMMSGQ 0x10 /* wait for the fileglob to be removed from msgqueue */
	160	#define FG_PORTMADE 0x20 /* a port was at some point created for this fileglob */
	161	#define FG_NOSIGPIPE 0x40 /* don't deliver SIGPIPE with EPIPE return */
	162	#define FG_OFF_LOCKED 0x80 /* Used as a mutex for offset changes (for vnodes) */
	163	#define FG_OFF_LOCKWANT 0x100 /* Somebody's wating for the lock */
	164	#define FG_CONFINED 0x200 /* fileglob confined to process, immutably */
	165	#define FG_HAS_OFDLOCK 0x400 /* Has or has had an OFD lock */
91447636 A	166
91447636 A	167	struct fileglob {
91447636	168	LIST_ENTRY(fileglob) f_msglist;/* list of active files */
0a7de745 A	169	int32_t fg_flag; /* see fcntl.h */
	170	int32_t fg_count; /* reference count */
	171	int32_t fg_msgcount; /* references from message queue */
	172	int32_t fg_lflags; /* file global flags */
	173	kauth_cred_t fg_cred; /* credentials associated with descriptor */
39236c6e	174	const struct fileops {
0a7de745 A	175	file_type_t fo_type; /* descriptor type */
	176	int (fo_read) (struct fileproc fp, struct uio *uio,
	177	int flags, vfs_context_t ctx);
	178	int (fo_write) (struct fileproc fp, struct uio *uio,
	179	int flags, vfs_context_t ctx);
	180	#define FOF_OFFSET 0x00000001 /* offset supplied to vn_write */
	181	#define FOF_PCRED 0x00000002 /* cred from proc, not current thread */
	182	int (fo_ioctl)(struct fileproc fp, u_long com,
	183	caddr_t data, vfs_context_t ctx);
	184	int (fo_select) (struct fileproc fp, int which,
	185	void *wql, vfs_context_t ctx);
	186	int (fo_close) (struct fileglob fg, vfs_context_t ctx);
	187	int (fo_kqfilter) (struct fileproc fp, struct knote *kn,
	188	struct kevent_internal_s *kev, vfs_context_t ctx);
	189	int (fo_drain) (struct fileproc fp, vfs_context_t ctx);
91447636	190	} *fg_ops;
0a7de745 A	191	off_t fg_offset;
	192	void fg_data; / vnode or socket or SHM or semaphore */
	193	void fg_vn_data; / Per fd vnode data, used for directories */
91447636	194	lck_mtx_t fg_lock;
2d21ac55 A	195	#if CONFIG_MACF
	196	struct label fg_label; / JMM - use the one in the cred? */
	197	#endif
91447636 A	198	};
91447636 A	199
91447636	200	#ifdef __APPLE_API_PRIVATE
91447636	201	LIST_HEAD(fmsglist, fileglob);
0a7de745 A	202	extern struct fmsglist fmsghead; /* head of list of open files */
	203	extern int maxfiles; /* kernel limit on number of open files */
	204	extern int nfiles; /* actual number of open files */
b0d623f7	205	extern int maxfilesperproc;
39236c6e	206
0a7de745	207	#define FILEGLOB_DTYPE(fg) ((const file_type_t)((fg)->fg_ops->fo_type))
91447636 A	208	#endif /* __APPLE_API_PRIVATE */
	209
	210
	211	__BEGIN_DECLS
2d21ac55 A	212	int fo_read(struct fileproc fp, struct uio uio, int flags, vfs_context_t ctx);
2d21ac55 A	213	int fo_write(struct fileproc fp, struct uio uio, int flags,
0a7de745	214	vfs_context_t ctx);
2d21ac55 A	215	int fo_ioctl(struct fileproc *fp, u_long com, caddr_t data, vfs_context_t ctx);
	216	int fo_select(struct fileproc fp, int which, void wql, vfs_context_t ctx);
	217	int fo_close(struct fileglob *fg, vfs_context_t ctx);
5ba3f43e	218	int fo_kqfilter(struct fileproc fp, struct knote kn,
0a7de745	219	struct kevent_internal_s *kev, vfs_context_t ctx);
91447636	220	void fileproc_drain(proc_t, struct fileproc *);
39236c6e	221	int fp_tryswap(proc_t, int fd, struct fileproc *nfp);
91447636 A	222	int fp_drop(struct proc p, int fd, struct fileproc fp, int locked);
	223	int fp_drop_written(proc_t p, int fd, struct fileproc *fp);
	224	int fp_drop_event(proc_t p, int fd, struct fileproc *fp);
	225	int fp_free(struct proc * p, int fd, struct fileproc * fp);
	226	struct kqueue;
	227	int fp_getfkq(struct proc p, int fd, struct fileproc resultfp, struct kqueue *resultkq);
	228	struct psemnode;
	229	int fp_getfpsem(struct proc p, int fd, struct fileproc resultfp, struct psemnode *resultpsem);
0c530ab8 A	230	struct pshmnode;
	231	int fp_getfpshm(struct proc p, int fd, struct fileproc resultfp, struct pshmnode *resultpshm);
	232	struct pipe;
	233	int fp_getfpipe(struct proc p, int fd, struct fileproc resultfp, struct pipe *resultpipe);
	234	struct atalk;
	235	int fp_getfatalk(struct proc p, int fd, struct fileproc resultfp, struct atalk *resultatalk);
91447636	236	struct vnode;
0c530ab8	237	int fp_getfvpandvid(struct proc p, int fd, struct fileproc resultfp, struct vnode resultvp, uint32_t vidp);
91447636 A	238	struct socket;
	239	int fp_getfsock(struct proc p, int fd, struct fileproc resultfp, struct socket *results);
	240	int fp_lookup(struct proc p, int fd, struct fileproc *resultfp, int locked);
39236c6e A	241	int fp_isguarded(struct fileproc *fp, u_int attribs);
39236c6e A	242	int fp_guard_exception(proc_t p, int fd, struct fileproc *fp, u_int attribs);
91447636	243	int closef_locked(struct fileproc fp, struct fileglob fg, struct proc *p);
39236c6e A	244	int close_internal_locked(proc_t p, int fd, struct fileproc *fp, int flags);
	245	struct nameidata;
	246	struct vnode_attr;
	247	int open1(vfs_context_t ctx, struct nameidata *ndp, int uflags,
	248	struct vnode_attr vap, fp_allocfn_t fp_zalloc, void cra,
	249	int32_t *retval);
	250	int kqueue_body(struct proc p, fp_allocfn_t, void cra, int32_t *retval);
91447636	251	void fg_insertuipc(struct fileglob * fg);
3e170ce0	252	boolean_t fg_insertuipc_mark(struct fileglob * fg);
91447636	253	void fg_removeuipc(struct fileglob * fg);
3e170ce0	254	boolean_t fg_removeuipc_mark(struct fileglob * fg);
6601e61a A	255	void unp_gc_wait(void);
	256	void procfdtbl_reservefd(struct proc * p, int fd);
	257	void procfdtbl_markclosefd(struct proc * p, int fd);
	258	void procfdtbl_releasefd(struct proc * p, int fd, struct fileproc * fp);
	259	void procfdtbl_waitfd(struct proc * p, int fd);
	260	void procfdtbl_clearfd(struct proc * p, int fd);
3e170ce0	261	boolean_t file_issendable(struct proc * p, struct fileproc *fp);
b0d623f7	262	extern int fdgetf_noref(proc_t, int, struct fileproc **);
39236c6e A	263	extern struct fileproc fileproc_alloc_init(void crargs);
	264	extern void fileproc_free(struct fileproc *fp);
	265	extern void guarded_fileproc_free(struct fileproc *fp);
fe8ab488 A	266	extern void fg_vn_data_free(void *fgvndata);
fe8ab488 A	267	extern int nameiat(struct nameidata *ndp, int dirfd);
39037602 A	268	extern int falloc_guarded(struct proc p, struct fileproc fp, int fd,
39037602 A	269	vfs_context_t ctx, const guardid_t *guard, u_int attrs);
91447636 A	270	__END_DECLS
	271
	272	#endif /* __APPLE_API_UNSTABLE */
	273
	274	#endif /* KERNEL */
	275
	276	#endif /* !_SYS_FILE_INTERNAL_H_ */