xref: /freebsd/sys/fs/nullfs/null.h (revision e39756439c7255bc16ba14b7b991cb01ba1c93bd)
1df8bae1dSRodney W. Grimes /*
2df8bae1dSRodney W. Grimes  * Copyright (c) 1992, 1993
3df8bae1dSRodney W. Grimes  *	The Regents of the University of California.  All rights reserved.
4df8bae1dSRodney W. Grimes  *
5df8bae1dSRodney W. Grimes  * This code is derived from software donated to Berkeley by
6df8bae1dSRodney W. Grimes  * Jan-Simon Pendry.
7df8bae1dSRodney W. Grimes  *
8df8bae1dSRodney W. Grimes  * Redistribution and use in source and binary forms, with or without
9df8bae1dSRodney W. Grimes  * modification, are permitted provided that the following conditions
10df8bae1dSRodney W. Grimes  * are met:
11df8bae1dSRodney W. Grimes  * 1. Redistributions of source code must retain the above copyright
12df8bae1dSRodney W. Grimes  *    notice, this list of conditions and the following disclaimer.
13df8bae1dSRodney W. Grimes  * 2. Redistributions in binary form must reproduce the above copyright
14df8bae1dSRodney W. Grimes  *    notice, this list of conditions and the following disclaimer in the
15df8bae1dSRodney W. Grimes  *    documentation and/or other materials provided with the distribution.
16df8bae1dSRodney W. Grimes  * 3. All advertising materials mentioning features or use of this software
17df8bae1dSRodney W. Grimes  *    must display the following acknowledgement:
18df8bae1dSRodney W. Grimes  *	This product includes software developed by the University of
19df8bae1dSRodney W. Grimes  *	California, Berkeley and its contributors.
20df8bae1dSRodney W. Grimes  * 4. Neither the name of the University nor the names of its contributors
21df8bae1dSRodney W. Grimes  *    may be used to endorse or promote products derived from this software
22df8bae1dSRodney W. Grimes  *    without specific prior written permission.
23df8bae1dSRodney W. Grimes  *
24df8bae1dSRodney W. Grimes  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25df8bae1dSRodney W. Grimes  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26df8bae1dSRodney W. Grimes  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27df8bae1dSRodney W. Grimes  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28df8bae1dSRodney W. Grimes  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29df8bae1dSRodney W. Grimes  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30df8bae1dSRodney W. Grimes  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31df8bae1dSRodney W. Grimes  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32df8bae1dSRodney W. Grimes  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33df8bae1dSRodney W. Grimes  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34df8bae1dSRodney W. Grimes  * SUCH DAMAGE.
35df8bae1dSRodney W. Grimes  *
36996c772fSJohn Dyson  *	@(#)null.h	8.3 (Berkeley) 8/20/94
37df8bae1dSRodney W. Grimes  *
38c3aac50fSPeter Wemm  * $FreeBSD$
39df8bae1dSRodney W. Grimes  */
40df8bae1dSRodney W. Grimes 
41df8bae1dSRodney W. Grimes struct null_args {
42df8bae1dSRodney W. Grimes 	char		*target;	/* Target of loopback  */
43df8bae1dSRodney W. Grimes };
44df8bae1dSRodney W. Grimes 
45df8bae1dSRodney W. Grimes struct null_mount {
46df8bae1dSRodney W. Grimes 	struct mount	*nullm_vfs;
47df8bae1dSRodney W. Grimes 	struct vnode	*nullm_rootvp;	/* Reference to root null_node */
48df8bae1dSRodney W. Grimes };
49df8bae1dSRodney W. Grimes 
50c4473420SPeter Wemm #ifdef _KERNEL
51df8bae1dSRodney W. Grimes /*
52df8bae1dSRodney W. Grimes  * A cache of vnode references
53df8bae1dSRodney W. Grimes  */
54df8bae1dSRodney W. Grimes struct null_node {
55e3975643SJake Burkholder 	LIST_ENTRY(null_node)	null_hash;	/* Hash list */
56df8bae1dSRodney W. Grimes 	struct vnode	        *null_lowervp;	/* VREFed once */
57df8bae1dSRodney W. Grimes 	struct vnode		*null_vnode;	/* Back pointer */
58df8bae1dSRodney W. Grimes };
59df8bae1dSRodney W. Grimes 
6063f50488SMike Pritchard extern int nullfs_init __P((struct vfsconf *vfsp));
61df8bae1dSRodney W. Grimes extern int null_node_create __P((struct mount *mp, struct vnode *target, struct vnode **vpp));
62df8bae1dSRodney W. Grimes 
63df8bae1dSRodney W. Grimes #define	MOUNTTONULLMOUNT(mp) ((struct null_mount *)((mp)->mnt_data))
64df8bae1dSRodney W. Grimes #define	VTONULL(vp) ((struct null_node *)(vp)->v_data)
65df8bae1dSRodney W. Grimes #define	NULLTOV(xp) ((xp)->null_vnode)
66a0f40f54SBruce Evans #ifdef DIAGNOSTIC
67df8bae1dSRodney W. Grimes extern struct vnode *null_checkvp __P((struct vnode *vp, char *fil, int lno));
68df8bae1dSRodney W. Grimes #define	NULLVPTOLOWERVP(vp) null_checkvp((vp), __FILE__, __LINE__)
69df8bae1dSRodney W. Grimes #else
70df8bae1dSRodney W. Grimes #define	NULLVPTOLOWERVP(vp) (VTONULL(vp)->null_lowervp)
71df8bae1dSRodney W. Grimes #endif
72df8bae1dSRodney W. Grimes 
73e9f7506fSPeter Wemm extern int	null_bypass __P((struct vop_generic_args *ap));
74e9f7506fSPeter Wemm 
75f57e6547SBruce Evans extern vop_t **null_vnodeop_p;
76c4473420SPeter Wemm #endif /* _KERNEL */
77