[apple/xnu.git] / bsd / sys / file.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_H_
#define	_SYS_FILE_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>

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

/*
 * Kernel descriptor table.
 * One entry for each open kernel vnode and socket.
 */
struct file {
	LIST_ENTRY(file) f_list;/* list of active files */
	short	f_flag;		/* see fcntl.h */
#define	DTYPE_VNODE	1	/* file */
#define	DTYPE_SOCKET	2	/* communications endpoint */
#define	DTYPE_PSXSHM	3	/* POSIX Shared memory */
#define	DTYPE_PSXSEM	4	/* POSIX Semaphores */
#define DTYPE_KQUEUE	5	/* kqueue */
	short	f_type;		/* descriptor type */
	short	f_count;	/* reference count */
	short	f_msgcount;	/* references from message queue */
	struct	ucred *f_cred;	/* credentials associated with descriptor */
	struct	fileops {
		int	(*fo_read)	__P((struct file *fp, struct uio *uio,
					    struct ucred *cred, int flags,
					    struct proc *p));
		int	(*fo_write)	__P((struct file *fp, struct uio *uio,
					    struct ucred *cred, int flags,
					    struct proc *p));
#define	FOF_OFFSET	1
		int	(*fo_ioctl)	__P((struct file *fp, u_long com,
					    caddr_t data, struct proc *p));
		int	(*fo_select)	__P((struct file *fp, int which,
						void *wql, struct proc *p));
		int	(*fo_close)	__P((struct file *fp, struct proc *p));
		int	(*fo_kqfilter)	__P((struct file *fp, struct knote *kn,
					     struct proc *p));
	} *f_ops;
	off_t	f_offset;
	caddr_t	f_data;		/* vnode or socket or SHM or semaphore */
};

#ifdef __APPLE_API_PRIVATE
LIST_HEAD(filelist, file);
extern struct filelist filehead;	/* 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 fref __P((struct file *));	/* take a reference on file pointer */
int frele __P((struct file *));	/* release a reference on file pointer */
int fcount __P((struct file *));	/* returns the reference count */

static __inline int fo_read __P((struct file *fp, struct uio *uio,
	struct ucred *cred, int flags, struct proc *p));
static __inline int fo_write __P((struct file *fp, struct uio *uio,
	struct ucred *cred, int flags, struct proc *p));
static __inline int fo_ioctl __P((struct file *fp, u_long com, caddr_t data,
	struct proc *p));
static __inline int fo_select __P((struct file *fp, int which, void *wql,
	struct proc *p));
static __inline int fo_close __P((struct file *fp, struct proc *p));
static __inline int fo_kqfilter __P((struct file *fp, struct knote *kn,
	struct proc *p));

static __inline int
fo_read(struct file *fp, struct uio *uio, struct ucred *cred, int flags, struct proc *p)
{
	int error;

	if ((error = fref(fp)) == -1)
		return (EBADF);
	error = (*fp->f_ops->fo_read)(fp, uio, cred, flags, p);
	frele(fp);
	return (error);
}

static __inline int
fo_write(struct file *fp, struct uio *uio, struct ucred *cred, int flags, struct proc *p)
{
	int error;

	if ((error = fref(fp)) == -1)
		return (EBADF);
	error = (*fp->f_ops->fo_write)(fp, uio, cred, flags, p);
	frele(fp);
	return (error);
}

static __inline int 
fo_ioctl(struct file *fp, u_long com, caddr_t data, struct proc *p)
{
	int error;   

	if ((error = fref(fp)) == -1)
		return (EBADF);
	error = (*fp->f_ops->fo_ioctl)(fp, com, data, p);
	frele(fp);
	return (error);
}       

static __inline int
fo_select(struct file *fp, int which, void *wql, struct proc *p)
{       
	int error;

	error = (*fp->f_ops->fo_select)(fp, which, wql, p);
	return (error);
}

static __inline int
fo_close(struct file *fp, struct proc *p)
{       

	return ((*fp->f_ops->fo_close)(fp, p));
}

static __inline int
fo_kqfilter(struct file *fp, struct knote *kn, struct proc *p)
{
        return ((*fp->f_ops->fo_kqfilter)(fp, kn, p));
}

__END_DECLS

#endif /* __APPLE_API_UNSTABLE */

#endif /* KERNEL */

#endif /* !_SYS_FILE_H_ */
Commit	Line	Data
1c79356b	1	/*
9bccf70c	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
1c79356b A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
e5568f75 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.
1c79356b	11	*
e5568f75 A	12	* This Original Code and all software distributed under the License are
e5568f75 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
e5568f75 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.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	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_H_
	59	#define _SYS_FILE_H_
	60
9bccf70c	61	#include <sys/appleapiopts.h>
1c79356b A	62	#include <sys/fcntl.h>
	63	#include <sys/unistd.h>
	64
	65	#ifdef KERNEL
d7e50217	66	#include <sys/errno.h>
1c79356b A	67	#include <sys/queue.h>
	68	#include <sys/cdefs.h>
	69
	70	struct proc;
	71	struct uio;
55e303ae	72	struct knote;
9bccf70c	73	#ifdef __APPLE_API_UNSTABLE
1c79356b A	74
	75	/*
	76	* Kernel descriptor table.
	77	* One entry for each open kernel vnode and socket.
	78	*/
	79	struct file {
	80	LIST_ENTRY(file) f_list;/* list of active files */
	81	short f_flag; /* see fcntl.h */
	82	#define DTYPE_VNODE 1 /* file */
	83	#define DTYPE_SOCKET 2 /* communications endpoint */
	84	#define DTYPE_PSXSHM 3 /* POSIX Shared memory */
	85	#define DTYPE_PSXSEM 4 /* POSIX Semaphores */
55e303ae	86	#define DTYPE_KQUEUE 5 /* kqueue */
1c79356b A	87	short f_type; /* descriptor type */
	88	short f_count; /* reference count */
	89	short f_msgcount; /* references from message queue */
	90	struct ucred f_cred; / credentials associated with descriptor */
	91	struct fileops {
	92	int (fo_read) __P((struct file fp, struct uio *uio,
9bccf70c A	93	struct ucred *cred, int flags,
9bccf70c A	94	struct proc *p));
1c79356b	95	int (fo_write) __P((struct file fp, struct uio *uio,
9bccf70c A	96	struct ucred *cred, int flags,
	97	struct proc *p));
	98	#define FOF_OFFSET 1
1c79356b A	99	int (fo_ioctl) __P((struct file fp, u_long com,
	100	caddr_t data, struct proc *p));
	101	int (fo_select) __P((struct file fp, int which,
9bccf70c	102	void wql, struct proc p));
1c79356b	103	int (fo_close) __P((struct file fp, struct proc *p));
55e303ae A	104	int (fo_kqfilter) __P((struct file fp, struct knote *kn,
55e303ae A	105	struct proc *p));
1c79356b A	106	} *f_ops;
1c79356b A	107	off_t f_offset;
d7e50217	108	caddr_t f_data; /* vnode or socket or SHM or semaphore */
1c79356b A	109	};
1c79356b A	110
9bccf70c	111	#ifdef __APPLE_API_PRIVATE
1c79356b A	112	LIST_HEAD(filelist, file);
	113	extern struct filelist filehead; /* head of list of open files */
	114	extern int maxfiles; /* kernel limit on number of open files */
	115	extern int nfiles; /* actual number of open files */
9bccf70c	116	#endif /* __APPLE_API_PRIVATE */
1c79356b A	117
	118	__BEGIN_DECLS
	119	int fref __P((struct file )); / take a reference on file pointer */
	120	int frele __P((struct file )); / release a reference on file pointer */
	121	int fcount __P((struct file )); / returns the reference count */
9bccf70c A	122
	123	static __inline int fo_read __P((struct file fp, struct uio uio,
	124	struct ucred cred, int flags, struct proc p));
	125	static __inline int fo_write __P((struct file fp, struct uio uio,
	126	struct ucred cred, int flags, struct proc p));
	127	static __inline int fo_ioctl __P((struct file *fp, u_long com, caddr_t data,
	128	struct proc *p));
	129	static __inline int fo_select __P((struct file fp, int which, void wql,
	130	struct proc *p));
	131	static __inline int fo_close __P((struct file fp, struct proc p));
55e303ae A	132	static __inline int fo_kqfilter __P((struct file fp, struct knote kn,
55e303ae A	133	struct proc *p));
9bccf70c A	134
	135	static __inline int
	136	fo_read(struct file fp, struct uio uio, struct ucred cred, int flags, struct proc p)
	137	{
	138	int error;
	139
d7e50217 A	140	if ((error = fref(fp)) == -1)
d7e50217 A	141	return (EBADF);
9bccf70c A	142	error = (*fp->f_ops->fo_read)(fp, uio, cred, flags, p);
	143	frele(fp);
	144	return (error);
	145	}
	146
	147	static __inline int
	148	fo_write(struct file fp, struct uio uio, struct ucred cred, int flags, struct proc p)
	149	{
	150	int error;
	151
d7e50217 A	152	if ((error = fref(fp)) == -1)
d7e50217 A	153	return (EBADF);
9bccf70c A	154	error = (*fp->f_ops->fo_write)(fp, uio, cred, flags, p);
	155	frele(fp);
	156	return (error);
	157	}
	158
	159	static __inline int
	160	fo_ioctl(struct file fp, u_long com, caddr_t data, struct proc p)
	161	{
	162	int error;
	163
d7e50217 A	164	if ((error = fref(fp)) == -1)
d7e50217 A	165	return (EBADF);
9bccf70c A	166	error = (*fp->f_ops->fo_ioctl)(fp, com, data, p);
	167	frele(fp);
	168	return (error);
	169	}
	170
	171	static __inline int
	172	fo_select(struct file fp, int which, void wql, struct proc *p)
	173	{
	174	int error;
	175
	176	error = (*fp->f_ops->fo_select)(fp, which, wql, p);
	177	return (error);
	178	}
	179
	180	static __inline int
	181	fo_close(struct file fp, struct proc p)
	182	{
	183
	184	return ((*fp->f_ops->fo_close)(fp, p));
	185	}
55e303ae A	186
	187	static __inline int
	188	fo_kqfilter(struct file fp, struct knote kn, struct proc *p)
	189	{
	190	return ((*fp->f_ops->fo_kqfilter)(fp, kn, p));
	191	}
	192
1c79356b A	193	__END_DECLS
1c79356b A	194
9bccf70c A	195	#endif /* __APPLE_API_UNSTABLE */
9bccf70c A	196
1c79356b A	197	#endif /* KERNEL */
	198
	199	#endif /* !_SYS_FILE_H_ */