[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/queue.h>
#include <sys/cdefs.h>

struct proc;
struct uio;
#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 */
	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));
	} *f_ops;
	off_t	f_offset;
	caddr_t	f_data;		/* vnode or socket */
};

#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_read(struct file *fp, struct uio *uio, struct ucred *cred, int flags, struct proc *p)
{
	int error;

	fref(fp);
	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;

	fref(fp);
	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;   

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