[apple/xnu.git] / bsd / miscfs / specfs / specdev.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, 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;
	int32_t si_opencount;
	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 */
#define SI_ALIASED	0x0002  /* multiple active vnodes refer to this device */

/*
 * 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	flock;
struct	buf;
struct	uio;

__BEGIN_DECLS
#ifdef BSD_KERNEL_PRIVATE
int spec_blktooff (struct  vnop_blktooff_args *);
int spec_offtoblk (struct  vnop_offtoblk_args *);
int	spec_fsync_internal (vnode_t, int, vfs_context_t);
int spec_blockmap (struct  vnop_blockmap_args *);
int spec_kqfilter (vnode_t vp, struct knote *kn);
#endif /* BSD_KERNEL_PRIVATE */

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 *);
#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
__END_DECLS

#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	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 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 License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* Copyright (c) 1995, 1998 Apple Computer, Inc. All Rights Reserved.
	30	* Copyright (c) 1990, 1993
	31	* The Regents of the University of California. All rights reserved.
	32	*
	33	* Redistribution and use in source and binary forms, with or without
	34	* modification, are permitted provided that the following conditions
	35	* are met:
	36	* 1. Redistributions of source code must retain the above copyright
	37	* notice, this list of conditions and the following disclaimer.
	38	* 2. Redistributions in binary form must reproduce the above copyright
	39	* notice, this list of conditions and the following disclaimer in the
	40	* documentation and/or other materials provided with the distribution.
	41	* 3. All advertising materials mentioning features or use of this software
	42	* must display the following acknowledgement:
	43	* This product includes software developed by the University of
	44	* California, Berkeley and its contributors.
	45	* 4. Neither the name of the University nor the names of its contributors
	46	* may be used to endorse or promote products derived from this software
	47	* without specific prior written permission.
	48	*
	49	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	50	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	51	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	52	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	53	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	54	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	55	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	56	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	57	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	58	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	59	* SUCH DAMAGE.
	60	*
	61	* @(#)specdev.h 8.6 (Berkeley) 5/21/95
	62	*/
	63
	64	#ifndef _MISCFS_SPECFS_SPECDEV_H_
	65	#define _MISCFS_SPECFS_SPECDEV_H_
	66
9bccf70c A	67	#include <sys/appleapiopts.h>
	68
	69	#ifdef __APPLE_API_PRIVATE
1c79356b A	70	#include <vfs/vfs_support.h>
	71
	72	/*
	73	* This structure defines the information maintained about
	74	* special devices. It is allocated in checkalias and freed
	75	* in vgone.
	76	*/
	77	struct specinfo {
	78	struct vnode **si_hashchain;
	79	struct vnode *si_specnext;
	80	long si_flags;
	81	dev_t si_rdev;
6d2010ae	82	int32_t si_opencount;
91447636 A	83	daddr_t si_size; /* device block size in bytes */
	84	daddr64_t si_lastr; /* last read blkno (read-ahead) */
	85	u_int64_t si_devsize; /* actual device size in bytes */
1c79356b A	86	};
	87	/*
	88	* Exported shorthand
	89	*/
	90	#define v_rdev v_specinfo->si_rdev
	91	#define v_hashchain v_specinfo->si_hashchain
	92	#define v_specnext v_specinfo->si_specnext
	93	#define v_specflags v_specinfo->si_flags
	94	#define v_specsize v_specinfo->si_size
55e303ae	95	#define v_specdevsize v_specinfo->si_devsize
91447636	96	#define v_speclastr v_specinfo->si_lastr
1c79356b A	97
	98	/*
	99	* Flags for specinfo
	100	*/
	101	#define SI_MOUNTEDON 0x0001 /* block special device is mounted on */
b0d623f7	102	#define SI_ALIASED 0x0002 /* multiple active vnodes refer to this device */
1c79356b A	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;
1c79356b A	122	struct flock;
	123	struct buf;
	124	struct uio;
	125
b0d623f7 A	126	__BEGIN_DECLS
	127	#ifdef BSD_KERNEL_PRIVATE
	128	int spec_blktooff (struct vnop_blktooff_args *);
	129	int spec_offtoblk (struct vnop_offtoblk_args *);
	130	int spec_fsync_internal (vnode_t, int, vfs_context_t);
	131	int spec_blockmap (struct vnop_blockmap_args *);
	132	int spec_kqfilter (vnode_t vp, struct knote *kn);
	133	#endif /* BSD_KERNEL_PRIVATE */
	134
91447636	135	int spec_ebadf(void *);
1c79356b	136
91447636 A	137	int spec_lookup (struct vnop_lookup_args *);
	138	#define spec_create (int () (struct vnop_access_args ))err_create
	139	#define spec_mknod (int () (struct vnop_access_args ))err_mknod
	140	int spec_open (struct vnop_open_args *);
	141	int spec_close (struct vnop_close_args *);
	142	#define spec_access (int () (struct vnop_access_args ))spec_ebadf
	143	#define spec_getattr (int () (struct vnop_getattr_args ))spec_ebadf
	144	#define spec_setattr (int () (struct vnop_setattr_args ))spec_ebadf
	145	int spec_read (struct vnop_read_args *);
	146	int spec_write (struct vnop_write_args *);
	147	int spec_ioctl (struct vnop_ioctl_args *);
	148	int spec_select (struct vnop_select_args *);
	149	#define spec_revoke (int () (struct vnop_access_args ))nop_revoke
	150	#define spec_mmap (int () (struct vnop_access_args ))err_mmap
	151	int spec_fsync (struct vnop_fsync_args *);
91447636 A	152	#define spec_remove (int () (struct vnop_access_args ))err_remove
	153	#define spec_link (int () (struct vnop_access_args ))err_link
	154	#define spec_rename (int () (struct vnop_access_args ))err_rename
	155	#define spec_mkdir (int () (struct vnop_access_args ))err_mkdir
	156	#define spec_rmdir (int () (struct vnop_access_args ))err_rmdir
	157	#define spec_symlink (int () (struct vnop_access_args ))err_symlink
	158	#define spec_readdir (int () (struct vnop_access_args ))err_readdir
	159	#define spec_readlink (int () (struct vnop_access_args ))err_readlink
	160	#define spec_inactive (int () (struct vnop_access_args ))nop_inactive
	161	#define spec_reclaim (int () (struct vnop_access_args ))nop_reclaim
	162	#define spec_lock (int () (struct vnop_access_args ))nop_lock
	163	#define spec_unlock (int ()(struct vnop_access_args ))nop_unlock
	164	int spec_strategy (struct vnop_strategy_args *);
	165	#define spec_islocked (int () (struct vnop_access_args ))nop_islocked
	166	int spec_pathconf (struct vnop_pathconf_args *);
	167	#define spec_advlock (int () (struct vnop_access_args ))err_advlock
	168	#define spec_blkatoff (int () (struct vnop_access_args ))err_blkatoff
	169	#define spec_valloc (int () (struct vnop_access_args ))err_valloc
	170	#define spec_vfree (int () (struct vnop_access_args ))err_vfree
	171	#define spec_bwrite (int () (struct vnop_bwrite_args ))nop_bwrite
b0d623f7	172	__END_DECLS
1c79356b	173
9bccf70c	174	#endif /* __APPLE_API_PRIVATE */
1c79356b	175	#endif /* _MISCFS_SPECFS_SPECDEV_H_ */