[apple/xnu.git] / bsd / miscfs / nullfs / null_subr.c

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 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 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.
 *
 *	@(#)null_subr.c	8.7 (Berkeley) 5/14/95
 *
 *	null_subr.c	8.4 (Berkeley) 1/21/94
 */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/proc.h>
#include <sys/time.h>
#include <sys/types.h>
#include <sys/vnode.h>
#include <sys/mount_internal.h>
#include <sys/namei.h>
#include <sys/malloc.h>
#include <sys/ubc.h>
#include <miscfs/nullfs/null.h>

#define LOG2_SIZEVNODE 7		/* log2(sizeof struct vnode) */
#define	NNULLNODECACHE 16

/*
 * Null layer cache:
 * Each cache entry holds a reference to the lower vnode
 * along with a pointer to the alias vnode.  When an
 * entry is added the lower vnode is vnode_get'd.  When the
 * alias is removed the lower vnode is vnode_put'd.
 */

#define	NULL_NHASH(vp) \
	(&null_node_hashtbl[(((u_long)vp)>>LOG2_SIZEVNODE) & null_node_hash])
LIST_HEAD(null_node_hashhead, null_node) *null_node_hashtbl;
u_long null_node_hash;

/*
 * Initialise cache headers
 */
nullfs_init()
{

#ifdef NULLFS_DIAGNOSTIC
	printf("nullfs_init\n");		/* printed during system boot */
#endif
	null_node_hashtbl = hashinit(NNULLNODECACHE, M_CACHE, &null_node_hash);
}

/*
 * Return a vnode_get'ed alias for lower vnode if already exists, else 0.
 */
static struct vnode *
null_node_find(mp, lowervp)
	struct mount *mp;
	struct vnode *lowervp;
{
	struct proc *p = curproc;	/* XXX */
	struct null_node_hashhead *hd;
	struct null_node *a;
	struct vnode *vp;

	/*
	 * Find hash base, and then search the (two-way) linked
	 * list looking for a null_node structure which is referencing
	 * the lower vnode.  If found, the increment the null_node
	 * reference count (but NOT the lower vnode's vnode_get counter).
	 */
	hd = NULL_NHASH(lowervp);
loop:
	for (a = hd->lh_first; a != 0; a = a->null_hash.le_next) {
		if (a->null_lowervp == lowervp && NULLTOV(a)->v_mount == mp) {
			vp = NULLTOV(a);

			if (vnode_get(vp)) {
				printf ("null_node_find: vget failed.\n");
				goto loop;
			};
			return (vp);
		}
	}

	return NULL;
}


/*
 * Make a new null_node node.
 * Vp is the alias vnode, lofsvp is the lower vnode.
 * Maintain a reference to (lowervp).
 */
static int
null_node_alloc(mp, lowervp, vpp)
	struct mount *mp;
	struct vnode *lowervp;
	struct vnode **vpp;
{
	struct null_node_hashhead *hd;
	struct null_node *xp;
	struct vnode *othervp, *vp;
	int error;

	MALLOC(xp, struct null_node *, sizeof(struct null_node), M_TEMP, M_WAITOK);
	if (error = getnewvnode(VT_NULL, mp, null_vnodeop_p, vpp)) {
		FREE(xp, M_TEMP);
		return (error);
	}
	vp = *vpp;

	vp->v_type = lowervp->v_type;
	xp->null_vnode = vp;
	vp->v_data = xp;
	xp->null_lowervp = lowervp;
	/*
	 * Before we insert our new node onto the hash chains,
	 * check to see if someone else has beaten us to it.
	 */
	if (othervp = null_node_find(lowervp)) {
		FREE(xp, M_TEMP);
		vp->v_type = VBAD;	/* node is discarded */
		vp->v_usecount = 0;	/* XXX */
		vp->v_data = 0; /* prevent access to freed data */
		*vpp = othervp;
		return 0;
	};
	if (vp->v_type == VREG)
		ubc_info_init(vp);
	vnode_get(lowervp);   /* Extra vnode_get will be vnode_put'd in null_node_create */
	hd = NULL_NHASH(lowervp);
	LIST_INSERT_HEAD(hd, xp, null_hash);
	return 0;
}


/*
 * Try to find an existing null_node vnode refering
 * to it, otherwise make a new null_node vnode which
 * contains a reference to the lower vnode.
 */
int
null_node_create(mp, lowervp, newvpp)
	struct mount *mp;
	struct vnode *lowervp;
	struct vnode **newvpp;
{
	struct vnode *aliasvp;

	if (aliasvp = null_node_find(mp, lowervp)) {
		/*
		 * null_node_find has taken another reference
		 * to the alias vnode.
		 */
#ifdef NULLFS_DIAGNOSTIC
		vprint("null_node_create: exists", NULLTOV(ap));
#endif
		/* vnode_get(aliasvp); --- done in null_node_find */
	} else {
		int error;

		/*
		 * Get new vnode.
		 */
#ifdef NULLFS_DIAGNOSTIC
		printf("null_node_create: create new alias vnode\n");
#endif

		/*
		 * Make new vnode reference the null_node.
		 */
		if (error = null_node_alloc(mp, lowervp, &aliasvp))
			return error;

		/*
		 * aliasvp is already vnode_get'd by getnewvnode()
		 */
	}

	vnode_put(lowervp);

#if DIAGNOSTIC
	if (lowervp->v_usecount < 1) {
		/* Should never happen... */
		vprint ("null_node_create: alias ", aliasvp);
		vprint ("null_node_create: lower ", lowervp);
		panic ("null_node_create: lower has 0 usecount.");
	};
#endif

#ifdef NULLFS_DIAGNOSTIC
	vprint("null_node_create: alias", aliasvp);
	vprint("null_node_create: lower", lowervp);
#endif

	*newvpp = aliasvp;
	return (0);
}
#ifdef NULLFS_DIAGNOSTIC
struct vnode *
null_checkvp(vp, fil, lno)
	struct vnode *vp;
	char *fil;
	int lno;
{
	struct null_node *a = VTONULL(vp);
#ifdef notyet
	/*
	 * Can't do this check because vnop_reclaim runs
	 * with a funny vop vector.
	 */
	if (vp->v_op != null_vnodeop_p) {
		printf ("null_checkvp: on non-null-node\n");
		while (null_checkvp_barrier) /*WAIT*/ ;
		panic("null_checkvp");
	};
#endif
	if (a->null_lowervp == NULL) {
		/* Should never happen */
		int i; u_long *p;
		printf("vp = %x, ZERO ptr\n", vp);
		for (p = (u_long *) a, i = 0; i < 8; i++)
			printf(" %x", p[i]);
		printf("\n");
		/* wait for debugger */
		while (null_checkvp_barrier) /*WAIT*/ ;
		panic("null_checkvp");
	}
	if (a->null_lowervp->v_usecount < 1) {
		int i; u_long *p;
		printf("vp = %x, unref'ed lowervp\n", vp);
		for (p = (u_long *) a, i = 0; i < 8; i++)
			printf(" %x", p[i]);
		printf("\n");
		/* wait for debugger */
		while (null_checkvp_barrier) /*WAIT*/ ;
		panic ("null with unref'ed lowervp");
	};
#ifdef notyet
	printf("null %x/%d -> %x/%d [%s, %d]\n",
	        NULLTOV(a), NULLTOV(a)->v_usecount,
		a->null_lowervp, a->null_lowervp->v_usecount,
		fil, lno);
#endif
	return a->null_lowervp;
}
#endif
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
e5568f75 A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
1c79356b	11	*
e5568f75 A	12	* This Original Code and all software distributed under the License are
e5568f75 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
e5568f75 A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	23	/*
	24	* Copyright (c) 1992, 1993
	25	* The Regents of the University of California. All rights reserved.
	26	*
	27	* This code is derived from software donated to Berkeley by
	28	* Jan-Simon Pendry.
	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	* @(#)null_subr.c 8.7 (Berkeley) 5/14/95
	59	*
	60	* null_subr.c 8.4 (Berkeley) 1/21/94
	61	*/
	62
	63	#include <sys/param.h>
	64	#include <sys/systm.h>
	65	#include <sys/proc.h>
	66	#include <sys/time.h>
	67	#include <sys/types.h>
	68	#include <sys/vnode.h>
91447636	69	#include <sys/mount_internal.h>
1c79356b A	70	#include <sys/namei.h>
	71	#include <sys/malloc.h>
	72	#include <sys/ubc.h>
	73	#include <miscfs/nullfs/null.h>
	74
	75	#define LOG2_SIZEVNODE 7 /* log2(sizeof struct vnode) */
	76	#define NNULLNODECACHE 16
	77
	78	/*
	79	* Null layer cache:
	80	* Each cache entry holds a reference to the lower vnode
	81	* along with a pointer to the alias vnode. When an
91447636 A	82	* entry is added the lower vnode is vnode_get'd. When the
91447636 A	83	* alias is removed the lower vnode is vnode_put'd.
1c79356b A	84	*/
	85
	86	#define NULL_NHASH(vp) \
	87	(&null_node_hashtbl[(((u_long)vp)>>LOG2_SIZEVNODE) & null_node_hash])
	88	LIST_HEAD(null_node_hashhead, null_node) *null_node_hashtbl;
	89	u_long null_node_hash;
	90
	91	/*
	92	* Initialise cache headers
	93	*/
	94	nullfs_init()
	95	{
	96
	97	#ifdef NULLFS_DIAGNOSTIC
	98	printf("nullfs_init\n"); /* printed during system boot */
	99	#endif
	100	null_node_hashtbl = hashinit(NNULLNODECACHE, M_CACHE, &null_node_hash);
	101	}
	102
	103	/*
91447636	104	* Return a vnode_get'ed alias for lower vnode if already exists, else 0.
1c79356b A	105	*/
	106	static struct vnode *
	107	null_node_find(mp, lowervp)
	108	struct mount *mp;
	109	struct vnode *lowervp;
	110	{
	111	struct proc p = curproc; / XXX */
	112	struct null_node_hashhead *hd;
	113	struct null_node *a;
	114	struct vnode *vp;
	115
	116	/*
	117	* Find hash base, and then search the (two-way) linked
	118	* list looking for a null_node structure which is referencing
	119	* the lower vnode. If found, the increment the null_node
91447636	120	* reference count (but NOT the lower vnode's vnode_get counter).
1c79356b A	121	*/
	122	hd = NULL_NHASH(lowervp);
	123	loop:
	124	for (a = hd->lh_first; a != 0; a = a->null_hash.le_next) {
	125	if (a->null_lowervp == lowervp && NULLTOV(a)->v_mount == mp) {
	126	vp = NULLTOV(a);
91447636 A	127
91447636 A	128	if (vnode_get(vp)) {
1c79356b A	129	printf ("null_node_find: vget failed.\n");
	130	goto loop;
	131	};
	132	return (vp);
	133	}
	134	}
	135
	136	return NULL;
	137	}
	138
	139
	140	/*
	141	* Make a new null_node node.
	142	* Vp is the alias vnode, lofsvp is the lower vnode.
	143	* Maintain a reference to (lowervp).
	144	*/
	145	static int
	146	null_node_alloc(mp, lowervp, vpp)
	147	struct mount *mp;
	148	struct vnode *lowervp;
	149	struct vnode **vpp;
	150	{
	151	struct null_node_hashhead *hd;
	152	struct null_node *xp;
	153	struct vnode othervp, vp;
	154	int error;
	155
	156	MALLOC(xp, struct null_node *, sizeof(struct null_node), M_TEMP, M_WAITOK);
	157	if (error = getnewvnode(VT_NULL, mp, null_vnodeop_p, vpp)) {
	158	FREE(xp, M_TEMP);
	159	return (error);
	160	}
	161	vp = *vpp;
	162
	163	vp->v_type = lowervp->v_type;
	164	xp->null_vnode = vp;
	165	vp->v_data = xp;
	166	xp->null_lowervp = lowervp;
	167	/*
	168	* Before we insert our new node onto the hash chains,
	169	* check to see if someone else has beaten us to it.
	170	*/
	171	if (othervp = null_node_find(lowervp)) {
	172	FREE(xp, M_TEMP);
	173	vp->v_type = VBAD; /* node is discarded */
	174	vp->v_usecount = 0; /* XXX */
	175	vp->v_data = 0; /* prevent access to freed data */
	176	*vpp = othervp;
	177	return 0;
	178	};
	179	if (vp->v_type == VREG)
	180	ubc_info_init(vp);
91447636	181	vnode_get(lowervp); /* Extra vnode_get will be vnode_put'd in null_node_create */
1c79356b A	182	hd = NULL_NHASH(lowervp);
	183	LIST_INSERT_HEAD(hd, xp, null_hash);
	184	return 0;
	185	}
	186
	187
	188	/*
	189	* Try to find an existing null_node vnode refering
	190	* to it, otherwise make a new null_node vnode which
	191	* contains a reference to the lower vnode.
	192	*/
	193	int
	194	null_node_create(mp, lowervp, newvpp)
	195	struct mount *mp;
	196	struct vnode *lowervp;
	197	struct vnode **newvpp;
	198	{
	199	struct vnode *aliasvp;
	200
	201	if (aliasvp = null_node_find(mp, lowervp)) {
	202	/*
	203	* null_node_find has taken another reference
	204	* to the alias vnode.
	205	*/
	206	#ifdef NULLFS_DIAGNOSTIC
	207	vprint("null_node_create: exists", NULLTOV(ap));
	208	#endif
91447636	209	/* vnode_get(aliasvp); --- done in null_node_find */
1c79356b A	210	} else {
	211	int error;
	212
	213	/*
	214	* Get new vnode.
	215	*/
	216	#ifdef NULLFS_DIAGNOSTIC
	217	printf("null_node_create: create new alias vnode\n");
	218	#endif
	219
	220	/*
	221	* Make new vnode reference the null_node.
	222	*/
	223	if (error = null_node_alloc(mp, lowervp, &aliasvp))
	224	return error;
	225
	226	/*
91447636	227	* aliasvp is already vnode_get'd by getnewvnode()
1c79356b A	228	*/
	229	}
	230
91447636	231	vnode_put(lowervp);
1c79356b A	232
	233	#if DIAGNOSTIC
	234	if (lowervp->v_usecount < 1) {
	235	/* Should never happen... */
	236	vprint ("null_node_create: alias ", aliasvp);
	237	vprint ("null_node_create: lower ", lowervp);
	238	panic ("null_node_create: lower has 0 usecount.");
	239	};
	240	#endif
	241
	242	#ifdef NULLFS_DIAGNOSTIC
	243	vprint("null_node_create: alias", aliasvp);
	244	vprint("null_node_create: lower", lowervp);
	245	#endif
	246
	247	*newvpp = aliasvp;
	248	return (0);
	249	}
	250	#ifdef NULLFS_DIAGNOSTIC
	251	struct vnode *
	252	null_checkvp(vp, fil, lno)
	253	struct vnode *vp;
	254	char *fil;
	255	int lno;
	256	{
	257	struct null_node *a = VTONULL(vp);
	258	#ifdef notyet
	259	/*
91447636	260	* Can't do this check because vnop_reclaim runs
1c79356b A	261	* with a funny vop vector.
	262	*/
	263	if (vp->v_op != null_vnodeop_p) {
	264	printf ("null_checkvp: on non-null-node\n");
	265	while (null_checkvp_barrier) /WAIT/ ;
	266	panic("null_checkvp");
	267	};
	268	#endif
	269	if (a->null_lowervp == NULL) {
	270	/* Should never happen */
	271	int i; u_long *p;
	272	printf("vp = %x, ZERO ptr\n", vp);
	273	for (p = (u_long *) a, i = 0; i < 8; i++)
	274	printf(" %x", p[i]);
	275	printf("\n");
	276	/* wait for debugger */
	277	while (null_checkvp_barrier) /WAIT/ ;
	278	panic("null_checkvp");
	279	}
	280	if (a->null_lowervp->v_usecount < 1) {
	281	int i; u_long *p;
	282	printf("vp = %x, unref'ed lowervp\n", vp);
	283	for (p = (u_long *) a, i = 0; i < 8; i++)
	284	printf(" %x", p[i]);
	285	printf("\n");
	286	/* wait for debugger */
	287	while (null_checkvp_barrier) /WAIT/ ;
	288	panic ("null with unref'ed lowervp");
	289	};
	290	#ifdef notyet
	291	printf("null %x/%d -> %x/%d [%s, %d]\n",
	292	NULLTOV(a), NULLTOV(a)->v_usecount,
	293	a->null_lowervp, a->null_lowervp->v_usecount,
	294	fil, lno);
	295	#endif
	296	return a->null_lowervp;
	297	}
	298	#endif