[apple/xnu.git] / bsd / miscfs / specfs / specdev.h

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * 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. 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_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 */
	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

/*
 * 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();

int	spec_lookup __P((struct vop_lookup_args *));
#define spec_create ((int (*) __P((struct  vop_access_args *)))err_create)
#define spec_mknod ((int (*) __P((struct  vop_access_args *)))err_mknod)
int	spec_open __P((struct vop_open_args *));
int	spec_close __P((struct vop_close_args *));
#define spec_access ((int (*) __P((struct  vop_access_args *)))spec_ebadf)
#define spec_getattr ((int (*) __P((struct  vop_getattr_args *)))spec_ebadf)
#define spec_setattr ((int (*) __P((struct  vop_setattr_args *)))spec_ebadf)
int	spec_read __P((struct vop_read_args *));
int	spec_write __P((struct vop_write_args *));
#define spec_lease_check ((int (*) __P((struct  vop_access_args *)))nop_lease)
int	spec_ioctl __P((struct vop_ioctl_args *));
int	spec_select __P((struct vop_select_args *));
#define spec_revoke ((int (*) __P((struct  vop_access_args *)))nop_revoke)
#define spec_mmap ((int (*) __P((struct  vop_access_args *)))err_mmap)
int	spec_fsync __P((struct  vop_fsync_args *));
#define spec_seek ((int (*) __P((struct  vop_access_args *)))err_seek)
#define spec_remove ((int (*) __P((struct  vop_access_args *)))err_remove)
#define spec_link ((int (*) __P((struct  vop_access_args *)))err_link)
#define spec_rename ((int (*) __P((struct  vop_access_args *)))err_rename)
#define spec_mkdir ((int (*) __P((struct  vop_access_args *)))err_mkdir)
#define spec_rmdir ((int (*) __P((struct  vop_access_args *)))err_rmdir)
#define spec_symlink ((int (*) __P((struct  vop_access_args *)))err_symlink)
#define spec_readdir ((int (*) __P((struct  vop_access_args *)))err_readdir)
#define spec_readlink ((int (*) __P((struct  vop_access_args *)))err_readlink)
#define spec_abortop ((int (*) __P((struct  vop_access_args *)))err_abortop)
#define spec_inactive ((int (*) __P((struct  vop_access_args *)))nop_inactive)
#define spec_reclaim ((int (*) __P((struct  vop_access_args *)))nop_reclaim)
#define spec_lock ((int (*) __P((struct  vop_access_args *)))nop_lock)
#define spec_unlock ((int (*) __P((struct  vop_access_args *)))nop_unlock)
int	spec_bmap __P((struct vop_bmap_args *));
int	spec_strategy __P((struct vop_strategy_args *));
int	spec_print __P((struct vop_print_args *));
#define spec_islocked ((int (*) __P((struct  vop_access_args *)))nop_islocked)
int	spec_pathconf __P((struct vop_pathconf_args *));
#define spec_advlock ((int (*) __P((struct  vop_access_args *)))err_advlock)
#define spec_blkatoff ((int (*) __P((struct  vop_access_args *)))err_blkatoff)
#define spec_valloc ((int (*) __P((struct  vop_access_args *)))err_valloc)
#define spec_vfree ((int (*) __P((struct  vop_access_args *)))err_vfree)
#define spec_truncate ((int (*) __P((struct  vop_access_args *)))nop_truncate)
#define spec_update ((int (*) __P((struct  vop_access_args *)))nop_update)
#define spec_reallocblks \
	((int (*) __P((struct  vop_reallocblks_args *)))err_reallocblks)
#define spec_bwrite ((int (*) __P((struct  vop_bwrite_args *)))nop_bwrite)
int     spec_devblocksize __P((struct vop_devblocksize_args *));
int spec_blktooff __P((struct  vop_blktooff_args *));
int spec_offtoblk __P((struct  vop_offtoblk_args *));
int spec_cmap __P((struct  vop_cmap_args *));

#endif /* __APPLE_API_PRIVATE */
#endif /* _MISCFS_SPECFS_SPECDEV_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	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/*
	26	* Copyright (c) 1995, 1998 Apple Computer, Inc. All Rights Reserved.
	27	* Copyright (c) 1990, 1993
	28	* The Regents of the University of California. All rights reserved.
	29	*
	30	* Redistribution and use in source and binary forms, with or without
	31	* modification, are permitted provided that the following conditions
	32	* are met:
	33	* 1. Redistributions of source code must retain the above copyright
	34	* notice, this list of conditions and the following disclaimer.
	35	* 2. Redistributions in binary form must reproduce the above copyright
	36	* notice, this list of conditions and the following disclaimer in the
	37	* documentation and/or other materials provided with the distribution.
	38	* 3. All advertising materials mentioning features or use of this software
	39	* must display the following acknowledgement:
	40	* This product includes software developed by the University of
	41	* California, Berkeley and its contributors.
	42	* 4. Neither the name of the University nor the names of its contributors
	43	* may be used to endorse or promote products derived from this software
	44	* without specific prior written permission.
	45	*
	46	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	47	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	48	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	49	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	50	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	51	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	52	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	53	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	54	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	55	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	56	* SUCH DAMAGE.
	57	*
	58	* @(#)specdev.h 8.6 (Berkeley) 5/21/95
	59	*/
	60
	61	#ifndef _MISCFS_SPECFS_SPECDEV_H_
	62	#define _MISCFS_SPECFS_SPECDEV_H_
	63
9bccf70c A	64	#include <sys/appleapiopts.h>
	65
	66	#ifdef __APPLE_API_PRIVATE
1c79356b A	67	#include <vfs/vfs_support.h>
	68
	69	/*
	70	* This structure defines the information maintained about
	71	* special devices. It is allocated in checkalias and freed
	72	* in vgone.
	73	*/
	74	struct specinfo {
	75	struct vnode **si_hashchain;
	76	struct vnode *si_specnext;
	77	long si_flags;
	78	dev_t si_rdev;
55e303ae A	79	daddr_t si_size; /* device block size in bytes */
55e303ae A	80	u_int64_t si_devsize; /* actual device size in bytes */
1c79356b A	81	};
	82	/*
	83	* Exported shorthand
	84	*/
	85	#define v_rdev v_specinfo->si_rdev
	86	#define v_hashchain v_specinfo->si_hashchain
	87	#define v_specnext v_specinfo->si_specnext
	88	#define v_specflags v_specinfo->si_flags
	89	#define v_specsize v_specinfo->si_size
55e303ae	90	#define v_specdevsize v_specinfo->si_devsize
1c79356b A	91
	92	/*
	93	* Flags for specinfo
	94	*/
	95	#define SI_MOUNTEDON 0x0001 /* block special device is mounted on */
	96
	97	/*
	98	* Special device management
	99	*/
	100	#define SPECHSZ 64
	101	#if ((SPECHSZ&(SPECHSZ-1)) == 0)
	102	#define SPECHASH(rdev) (((rdev>>5)+(rdev))&(SPECHSZ-1))
	103	#else
	104	#define SPECHASH(rdev) (((unsigned)((rdev>>5)+(rdev)))%SPECHSZ)
	105	#endif
	106
	107	extern struct vnode *speclisth[SPECHSZ];
	108
	109	/*
	110	* Prototypes for special file operations on vnodes.
	111	*/
	112	extern int (*spec_vnodeop_p)(void );
	113	struct nameidata;
	114	struct componentname;
	115	struct ucred;
	116	struct flock;
	117	struct buf;
	118	struct uio;
	119
	120	int spec_ebadf();
	121
	122	int spec_lookup __P((struct vop_lookup_args *));
	123	#define spec_create ((int () __P((struct vop_access_args )))err_create)
	124	#define spec_mknod ((int () __P((struct vop_access_args )))err_mknod)
	125	int spec_open __P((struct vop_open_args *));
	126	int spec_close __P((struct vop_close_args *));
	127	#define spec_access ((int () __P((struct vop_access_args )))spec_ebadf)
	128	#define spec_getattr ((int () __P((struct vop_getattr_args )))spec_ebadf)
	129	#define spec_setattr ((int () __P((struct vop_setattr_args )))spec_ebadf)
	130	int spec_read __P((struct vop_read_args *));
	131	int spec_write __P((struct vop_write_args *));
	132	#define spec_lease_check ((int () __P((struct vop_access_args )))nop_lease)
	133	int spec_ioctl __P((struct vop_ioctl_args *));
	134	int spec_select __P((struct vop_select_args *));
	135	#define spec_revoke ((int () __P((struct vop_access_args )))nop_revoke)
	136	#define spec_mmap ((int () __P((struct vop_access_args )))err_mmap)
	137	int spec_fsync __P((struct vop_fsync_args *));
	138	#define spec_seek ((int () __P((struct vop_access_args )))err_seek)
	139	#define spec_remove ((int () __P((struct vop_access_args )))err_remove)
	140	#define spec_link ((int () __P((struct vop_access_args )))err_link)
	141	#define spec_rename ((int () __P((struct vop_access_args )))err_rename)
	142	#define spec_mkdir ((int () __P((struct vop_access_args )))err_mkdir)
	143	#define spec_rmdir ((int () __P((struct vop_access_args )))err_rmdir)
	144	#define spec_symlink ((int () __P((struct vop_access_args )))err_symlink)
	145	#define spec_readdir ((int () __P((struct vop_access_args )))err_readdir)
	146	#define spec_readlink ((int () __P((struct vop_access_args )))err_readlink)
	147	#define spec_abortop ((int () __P((struct vop_access_args )))err_abortop)
	148	#define spec_inactive ((int () __P((struct vop_access_args )))nop_inactive)
	149	#define spec_reclaim ((int () __P((struct vop_access_args )))nop_reclaim)
	150	#define spec_lock ((int () __P((struct vop_access_args )))nop_lock)
	151	#define spec_unlock ((int () __P((struct vop_access_args )))nop_unlock)
	152	int spec_bmap __P((struct vop_bmap_args *));
	153	int spec_strategy __P((struct vop_strategy_args *));
	154	int spec_print __P((struct vop_print_args *));
155	#define spec_islocked ((int () __P((struct vop_access_args )))nop_islocked)
156	int spec_pathconf __P((struct vop_pathconf_args *));
157	#define spec_advlock ((int () __P((struct vop_access_args )))err_advlock)
158	#define spec_blkatoff ((int () __P((struct vop_access_args )))err_blkatoff)
159	#define spec_valloc ((int () __P((struct vop_access_args )))err_valloc)
160	#define spec_vfree ((int () __P((struct vop_access_args )))err_vfree)
161	#define spec_truncate ((int () __P((struct vop_access_args )))nop_truncate)
162	#define spec_update ((int () __P((struct vop_access_args )))nop_update)
163	#define spec_reallocblks \
164	((int () __P((struct vop_reallocblks_args )))err_reallocblks)
165	#define spec_bwrite ((int () __P((struct vop_bwrite_args )))nop_bwrite)
166	int spec_devblocksize __P((struct vop_devblocksize_args *));
167	int spec_blktooff __P((struct vop_blktooff_args *));
168	int spec_offtoblk __P((struct vop_offtoblk_args *));
169	int spec_cmap __P((struct vop_cmap_args *));
170
9bccf70c	171	#endif /* __APPLE_API_PRIVATE */
1c79356b	172	#endif /* _MISCFS_SPECFS_SPECDEV_H_ */