[apple/xnu.git] / bsd / miscfs / specfs / specdev.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, 1998 Apple Computer, Inc. All Rights Reserved.
 * Copyright (c) 1990, 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.
 *
 *	@(#)specdev.h	8.6 (Berkeley) 5/21/95
 */

#ifndef _MISCFS_SPECFS_SPECDEV_H_
#define _MISCFS_SPECFS_SPECDEV_H_

#include  <sys/appleapiopts.h>

#ifdef __APPLE_API_PRIVATE
#include <vfs/vfs_support.h>

/*
 * This structure defines the information maintained about
 * special devices. It is allocated in checkalias and freed
 * in vgone.
 */
struct specinfo {
	struct	vnode **si_hashchain;
	struct	vnode *si_specnext;
	long	si_flags;
	dev_t	si_rdev;
	daddr_t	si_size;		/* device block size in bytes */
	daddr64_t	si_lastr;	/* last read blkno (read-ahead) */
	u_int64_t	si_devsize;	/* actual device size in bytes */
};
/*
 * Exported shorthand
 */
#define v_rdev v_specinfo->si_rdev
#define v_hashchain v_specinfo->si_hashchain
#define v_specnext v_specinfo->si_specnext
#define v_specflags v_specinfo->si_flags
#define v_specsize v_specinfo->si_size
#define v_specdevsize v_specinfo->si_devsize
#define v_speclastr v_specinfo->si_lastr

/*
 * Flags for specinfo
 */
#define	SI_MOUNTEDON	0x0001	/* block special device is mounted on */

/*
 * Special device management
 */
#define	SPECHSZ	64
#if	((SPECHSZ&(SPECHSZ-1)) == 0)
#define	SPECHASH(rdev)	(((rdev>>5)+(rdev))&(SPECHSZ-1))
#else
#define	SPECHASH(rdev)	(((unsigned)((rdev>>5)+(rdev)))%SPECHSZ)
#endif

extern struct vnode *speclisth[SPECHSZ];

/*
 * Prototypes for special file operations on vnodes.
 */
extern	int (**spec_vnodeop_p)(void *);
struct	nameidata;
struct	componentname;
struct	ucred;
struct	flock;
struct	buf;
struct	uio;

int	spec_ebadf(void *);

int	spec_lookup (struct vnop_lookup_args *);
#define spec_create (int (*) (struct  vnop_access_args *))err_create
#define spec_mknod (int (*) (struct  vnop_access_args *))err_mknod
int	spec_open (struct vnop_open_args *);
int	spec_close (struct vnop_close_args *);
#define spec_access (int (*) (struct  vnop_access_args *))spec_ebadf
#define spec_getattr (int (*) (struct  vnop_getattr_args *))spec_ebadf
#define spec_setattr (int (*) (struct  vnop_setattr_args *))spec_ebadf
int	spec_read (struct vnop_read_args *);
int	spec_write (struct vnop_write_args *);
int	spec_ioctl (struct vnop_ioctl_args *);
int	spec_select (struct vnop_select_args *);
#define spec_revoke (int (*) (struct  vnop_access_args *))nop_revoke
#define spec_mmap (int (*) (struct  vnop_access_args *))err_mmap
int	spec_fsync (struct  vnop_fsync_args *);
int	spec_fsync_internal (vnode_t, int, vfs_context_t);
#define spec_remove (int (*) (struct  vnop_access_args *))err_remove
#define spec_link (int (*) (struct  vnop_access_args *))err_link
#define spec_rename (int (*) (struct  vnop_access_args *))err_rename
#define spec_mkdir (int (*) (struct  vnop_access_args *))err_mkdir
#define spec_rmdir (int (*) (struct  vnop_access_args *))err_rmdir
#define spec_symlink (int (*) (struct  vnop_access_args *))err_symlink
#define spec_readdir (int (*) (struct  vnop_access_args *))err_readdir
#define spec_readlink (int (*) (struct  vnop_access_args *))err_readlink
#define spec_inactive (int (*) (struct  vnop_access_args *))nop_inactive
#define spec_reclaim (int (*) (struct  vnop_access_args *))nop_reclaim
#define spec_lock (int (*) (struct  vnop_access_args *))nop_lock
#define spec_unlock (int (*)(struct  vnop_access_args *))nop_unlock
int	spec_strategy (struct vnop_strategy_args *);
#define spec_islocked (int (*) (struct  vnop_access_args *))nop_islocked
int	spec_pathconf (struct vnop_pathconf_args *);
#define spec_advlock (int (*) (struct  vnop_access_args *))err_advlock
#define spec_blkatoff (int (*) (struct  vnop_access_args *))err_blkatoff
#define spec_valloc (int (*) (struct  vnop_access_args *))err_valloc
#define spec_vfree (int (*) (struct  vnop_access_args *))err_vfree
#define spec_bwrite (int (*) (struct  vnop_bwrite_args *))nop_bwrite
int spec_blktooff (struct  vnop_blktooff_args *);
int spec_offtoblk (struct  vnop_offtoblk_args *);
int spec_blockmap (struct  vnop_blockmap_args *);

#endif /* __APPLE_API_PRIVATE */
#endif /* _MISCFS_SPECFS_SPECDEV_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	/*
	31	* Copyright (c) 1995, 1998 Apple Computer, Inc. All Rights Reserved.
	32	* Copyright (c) 1990, 1993
	33	* The Regents of the University of California. All rights reserved.
	34	*
	35	* Redistribution and use in source and binary forms, with or without
	36	* modification, are permitted provided that the following conditions
	37	* are met:
	38	* 1. Redistributions of source code must retain the above copyright
	39	* notice, this list of conditions and the following disclaimer.
	40	* 2. Redistributions in binary form must reproduce the above copyright
	41	* notice, this list of conditions and the following disclaimer in the
	42	* documentation and/or other materials provided with the distribution.
	43	* 3. All advertising materials mentioning features or use of this software
	44	* must display the following acknowledgement:
	45	* This product includes software developed by the University of
	46	* California, Berkeley and its contributors.
	47	* 4. Neither the name of the University nor the names of its contributors
	48	* may be used to endorse or promote products derived from this software
	49	* without specific prior written permission.
	50	*
	51	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	52	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	53	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	54	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	55	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	56	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	57	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	58	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	59	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	60	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	61	* SUCH DAMAGE.
	62	*
	63	* @(#)specdev.h 8.6 (Berkeley) 5/21/95
	64	*/
	65
	66	#ifndef _MISCFS_SPECFS_SPECDEV_H_
	67	#define _MISCFS_SPECFS_SPECDEV_H_
	68
9bccf70c A	69	#include <sys/appleapiopts.h>
	70
	71	#ifdef __APPLE_API_PRIVATE
1c79356b A	72	#include <vfs/vfs_support.h>
	73
	74	/*
	75	* This structure defines the information maintained about
	76	* special devices. It is allocated in checkalias and freed
	77	* in vgone.
	78	*/
	79	struct specinfo {
	80	struct vnode **si_hashchain;
	81	struct vnode *si_specnext;
	82	long si_flags;
	83	dev_t si_rdev;
91447636 A	84	daddr_t si_size; /* device block size in bytes */
	85	daddr64_t si_lastr; /* last read blkno (read-ahead) */
	86	u_int64_t si_devsize; /* actual device size in bytes */
1c79356b A	87	};
	88	/*
	89	* Exported shorthand
	90	*/
	91	#define v_rdev v_specinfo->si_rdev
	92	#define v_hashchain v_specinfo->si_hashchain
	93	#define v_specnext v_specinfo->si_specnext
	94	#define v_specflags v_specinfo->si_flags
	95	#define v_specsize v_specinfo->si_size
55e303ae	96	#define v_specdevsize v_specinfo->si_devsize
91447636	97	#define v_speclastr v_specinfo->si_lastr
1c79356b A	98
	99	/*
	100	* Flags for specinfo
	101	*/
	102	#define SI_MOUNTEDON 0x0001 /* block special device is mounted on */
	103
	104	/*
	105	* Special device management
	106	*/
	107	#define SPECHSZ 64
	108	#if ((SPECHSZ&(SPECHSZ-1)) == 0)
	109	#define SPECHASH(rdev) (((rdev>>5)+(rdev))&(SPECHSZ-1))
	110	#else
	111	#define SPECHASH(rdev) (((unsigned)((rdev>>5)+(rdev)))%SPECHSZ)
	112	#endif
	113
	114	extern struct vnode *speclisth[SPECHSZ];
	115
	116	/*
	117	* Prototypes for special file operations on vnodes.
	118	*/
	119	extern int (*spec_vnodeop_p)(void );
	120	struct nameidata;
	121	struct componentname;
	122	struct ucred;
	123	struct flock;
	124	struct buf;
	125	struct uio;
	126
91447636	127	int spec_ebadf(void *);
1c79356b	128
91447636 A	129	int spec_lookup (struct vnop_lookup_args *);
	130	#define spec_create (int () (struct vnop_access_args ))err_create
	131	#define spec_mknod (int () (struct vnop_access_args ))err_mknod
	132	int spec_open (struct vnop_open_args *);
	133	int spec_close (struct vnop_close_args *);
	134	#define spec_access (int () (struct vnop_access_args ))spec_ebadf
	135	#define spec_getattr (int () (struct vnop_getattr_args ))spec_ebadf
	136	#define spec_setattr (int () (struct vnop_setattr_args ))spec_ebadf
	137	int spec_read (struct vnop_read_args *);
	138	int spec_write (struct vnop_write_args *);
	139	int spec_ioctl (struct vnop_ioctl_args *);
	140	int spec_select (struct vnop_select_args *);
	141	#define spec_revoke (int () (struct vnop_access_args ))nop_revoke
	142	#define spec_mmap (int () (struct vnop_access_args ))err_mmap
	143	int spec_fsync (struct vnop_fsync_args *);
	144	int spec_fsync_internal (vnode_t, int, vfs_context_t);
	145	#define spec_remove (int () (struct vnop_access_args ))err_remove
	146	#define spec_link (int () (struct vnop_access_args ))err_link
	147	#define spec_rename (int () (struct vnop_access_args ))err_rename
	148	#define spec_mkdir (int () (struct vnop_access_args ))err_mkdir
	149	#define spec_rmdir (int () (struct vnop_access_args ))err_rmdir
	150	#define spec_symlink (int () (struct vnop_access_args ))err_symlink
	151	#define spec_readdir (int () (struct vnop_access_args ))err_readdir
	152	#define spec_readlink (int () (struct vnop_access_args ))err_readlink
	153	#define spec_inactive (int () (struct vnop_access_args ))nop_inactive
	154	#define spec_reclaim (int () (struct vnop_access_args ))nop_reclaim
	155	#define spec_lock (int () (struct vnop_access_args ))nop_lock
	156	#define spec_unlock (int ()(struct vnop_access_args ))nop_unlock
	157	int spec_strategy (struct vnop_strategy_args *);
	158	#define spec_islocked (int () (struct vnop_access_args ))nop_islocked
	159	int spec_pathconf (struct vnop_pathconf_args *);
	160	#define spec_advlock (int () (struct vnop_access_args ))err_advlock
	161	#define spec_blkatoff (int () (struct vnop_access_args ))err_blkatoff
	162	#define spec_valloc (int () (struct vnop_access_args ))err_valloc
	163	#define spec_vfree (int () (struct vnop_access_args ))err_vfree
	164	#define spec_bwrite (int () (struct vnop_bwrite_args ))nop_bwrite
91447636 A	165	int spec_blktooff (struct vnop_blktooff_args *);
	166	int spec_offtoblk (struct vnop_offtoblk_args *);
	167	int spec_blockmap (struct vnop_blockmap_args *);
1c79356b	168
9bccf70c	169	#endif /* __APPLE_API_PRIVATE */
1c79356b	170	#endif /* _MISCFS_SPECFS_SPECDEV_H_ */