xnu-7195.101.1.tar.gz

[apple/xnu.git] / bsd / miscfs / devfs / fdesc.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 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

#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 {
	Fdesc,
} 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 */
	int                     fd_fd;          /* Fd to be dup'ed */
	const 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)

__BEGIN_DECLS
extern int fdesc_allocvp(fdntype, int, struct mount *, struct vnode **, enum vtype, int);
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 devfs_fdesc_init(void);
extern int devfs_fdesc_makelinks(void);
extern int fdesc_ioctl(struct vnop_ioctl_args *ap);
extern int devfs_devfd_lookup(struct vnop_lookup_args *ap);
extern int devfs_devfd_readdir(struct vnop_readdir_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 int(**devfs_devfd_vnodeop_p)(void*);
extern struct vfsops fdesc_vfsops;
__END_DECLS

#endif /* KERNEL */
#endif /* __APPLE_API_PRIVATE */
#endif /* __FDESC_FDESC_H__ */