[apple/xnu.git] / bsd / miscfs / fdesc / fdesc.h

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_OSREFERENCE_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_LICENSE_OSREFERENCE_HEADER_END@
 */
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1992, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software donated to Berkeley by
 * Jan-Simon Pendry.
 *
 * 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.
 *
 *	@(#)fdesc.h	8.6 (Berkeley) 8/20/94
 *
 * #Id: fdesc.h,v 1.8 1993/04/06 15:28:33 jsp Exp #
 */
#ifndef __FDESC_FDESC_H__
#define __FDESC_FDESC_H__

#include  <sys/appleapiopts.h>

#ifdef __APPLE_API_PRIVATE
#ifdef KERNEL
struct fdescmount {
	struct vnode	*f_root;	/* Root node */
};

#define FD_ROOT		2
#define FD_DEVFD	3
#define FD_STDIN	4
#define FD_STDOUT	5
#define FD_STDERR	6
#define FD_DESC		8
#define FD_MAX		12

typedef enum {
	Froot,
	Fdevfd,
	Fdesc,
	Flink
} fdntype;

struct fdescnode {
	LIST_ENTRY(fdescnode) fd_hash;	/* Hash list */
	struct vnode	*fd_vnode;	/* Back ptr to vnode */
	fdntype			fd_type;	/* Type of this node */
	unsigned		fd_fd;		/* Fd to be dup'ed */
	char			*fd_link;	/* Link to fd/n */
	int				fd_ix;		/* filesystem index */
};

#define VFSTOFDESC(mp)	((struct fdescmount *)((mp)->mnt_data))
#define	VTOFDESC(vp) ((struct fdescnode *)(vp)->v_data)

extern int fdesc_allocvp(fdntype, int, struct mount *, struct vnode **, enum vtype);
extern int fdesc_badop(void);
extern int fdesc_getattr(struct vnop_getattr_args *ap);
extern int fdesc_inactive(struct vnop_inactive_args *ap);
extern int fdesc_init(struct vfsconf *);
extern int fdesc_ioctl(struct vnop_ioctl_args *ap);
extern int fdesc_lookup(struct vnop_lookup_args *ap);
extern int fdesc_open(struct vnop_open_args *ap);
extern int fdesc_pathconf(struct vnop_pathconf_args *ap);
extern int fdesc_read(struct vnop_read_args *ap);
extern int fdesc_readdir(struct vnop_readdir_args *ap);
extern int fdesc_readlink(struct vnop_readlink_args *ap);
extern int fdesc_reclaim(struct vnop_reclaim_args *ap);
extern int fdesc_root(struct mount *, struct vnode **, vfs_context_t);
extern int fdesc_select(struct vnop_select_args *ap);
extern int fdesc_setattr(struct vnop_setattr_args *ap);
extern int fdesc_write(struct vnop_write_args *ap);

extern int (**fdesc_vnodeop_p)(void *);
extern struct vfsops fdesc_vfsops;
#endif /* KERNEL */
#endif /* __APPLE_API_PRIVATE */
#endif /* __FDESC_FDESC_H__ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
8ad349bb	4	* @APPLE_LICENSE_OSREFERENCE_HEADER_START@
1c79356b	5	*
8ad349bb 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
	10	* License may not be used to create, or enable the creation or
	11	* redistribution of, unlawful or unlicensed copies of an Apple operating
	12	* system, or to circumvent, violate, or enable the circumvention or
	13	* violation of, any terms of an Apple operating system software license
	14	* agreement.
	15	*
	16	* Please obtain a copy of the License at
	17	* http://www.opensource.apple.com/apsl/ and read it before using this
	18	* file.
	19	*
	20	* The Original Code and all software distributed under the License are
	21	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	22	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	23	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	24	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	25	* Please see the License for the specific language governing rights and
	26	* limitations under the License.
	27	*
	28	* @APPLE_LICENSE_OSREFERENCE_HEADER_END@
1c79356b A	29	*/
	30	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	31	/*
	32	* Copyright (c) 1992, 1993
	33	* The Regents of the University of California. All rights reserved.
	34	*
	35	* This code is derived from software donated to Berkeley by
	36	* Jan-Simon Pendry.
	37	*
	38	* Redistribution and use in source and binary forms, with or without
	39	* modification, are permitted provided that the following conditions
	40	* are met:
	41	* 1. Redistributions of source code must retain the above copyright
	42	* notice, this list of conditions and the following disclaimer.
	43	* 2. Redistributions in binary form must reproduce the above copyright
	44	* notice, this list of conditions and the following disclaimer in the
	45	* documentation and/or other materials provided with the distribution.
	46	* 3. All advertising materials mentioning features or use of this software
	47	* must display the following acknowledgement:
	48	* This product includes software developed by the University of
	49	* California, Berkeley and its contributors.
	50	* 4. Neither the name of the University nor the names of its contributors
	51	* may be used to endorse or promote products derived from this software
	52	* without specific prior written permission.
	53	*
	54	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	55	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	56	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	57	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	58	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	59	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	60	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	61	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	62	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	63	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	64	* SUCH DAMAGE.
	65	*
	66	* @(#)fdesc.h 8.6 (Berkeley) 8/20/94
	67	*
	68	* #Id: fdesc.h,v 1.8 1993/04/06 15:28:33 jsp Exp #
	69	*/
9bccf70c A	70	#ifndef __FDESC_FDESC_H__
9bccf70c A	71	#define __FDESC_FDESC_H__
1c79356b	72
9bccf70c A	73	#include <sys/appleapiopts.h>
	74
	75	#ifdef __APPLE_API_PRIVATE
1c79356b A	76	#ifdef KERNEL
	77	struct fdescmount {
	78	struct vnode f_root; / Root node */
	79	};
	80
	81	#define FD_ROOT 2
	82	#define FD_DEVFD 3
	83	#define FD_STDIN 4
	84	#define FD_STDOUT 5
	85	#define FD_STDERR 6
1c79356b A	86	#define FD_DESC 8
	87	#define FD_MAX 12
	88
	89	typedef enum {
	90	Froot,
	91	Fdevfd,
	92	Fdesc,
55e303ae	93	Flink
1c79356b A	94	} fdntype;
	95
	96	struct fdescnode {
	97	LIST_ENTRY(fdescnode) fd_hash; /* Hash list */
	98	struct vnode fd_vnode; / Back ptr to vnode */
91447636 A	99	fdntype fd_type; /* Type of this node */
	100	unsigned fd_fd; /* Fd to be dup'ed */
	101	char fd_link; / Link to fd/n */
	102	int fd_ix; /* filesystem index */
1c79356b A	103	};
	104
	105	#define VFSTOFDESC(mp) ((struct fdescmount *)((mp)->mnt_data))
	106	#define VTOFDESC(vp) ((struct fdescnode *)(vp)->v_data)
	107
91447636 A	108	extern int fdesc_allocvp(fdntype, int, struct mount , struct vnode *, enum vtype);
	109	extern int fdesc_badop(void);
	110	extern int fdesc_getattr(struct vnop_getattr_args *ap);
	111	extern int fdesc_inactive(struct vnop_inactive_args *ap);
	112	extern int fdesc_init(struct vfsconf *);
	113	extern int fdesc_ioctl(struct vnop_ioctl_args *ap);
	114	extern int fdesc_lookup(struct vnop_lookup_args *ap);
	115	extern int fdesc_open(struct vnop_open_args *ap);
	116	extern int fdesc_pathconf(struct vnop_pathconf_args *ap);
	117	extern int fdesc_read(struct vnop_read_args *ap);
	118	extern int fdesc_readdir(struct vnop_readdir_args *ap);
	119	extern int fdesc_readlink(struct vnop_readlink_args *ap);
	120	extern int fdesc_reclaim(struct vnop_reclaim_args *ap);
	121	extern int fdesc_root(struct mount , struct vnode *, vfs_context_t);
	122	extern int fdesc_select(struct vnop_select_args *ap);
	123	extern int fdesc_setattr(struct vnop_setattr_args *ap);
	124	extern int fdesc_write(struct vnop_write_args *ap);
	125
1c79356b A	126	extern int (*fdesc_vnodeop_p)(void );
	127	extern struct vfsops fdesc_vfsops;
	128	#endif /* KERNEL */
9bccf70c A	129	#endif /* __APPLE_API_PRIVATE */
9bccf70c A	130	#endif /* __FDESC_FDESC_H__ */