xref: /netbsd-src/sys/miscfs/nullfs/null_vfsops.c (revision 001c68bd94f75ce9270b69227c4199fbf34ee396)
1 /*	$NetBSD: null_vfsops.c,v 1.42 2003/06/29 22:31:43 fvdl Exp $	*/
2 
3 /*
4  * Copyright (c) 1999 National Aeronautics & Space Administration
5  * All rights reserved.
6  *
7  * This software was written by William Studenmund of the
8  * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the National Aeronautics & Space Administration
19  *    nor the names of its contributors may be used to endorse or promote
20  *    products derived from this software without specific prior written
21  *    permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE NATIONAL AERONAUTICS & SPACE ADMINISTRATION
24  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ADMINISTRATION OR CONTRIB-
27  * UTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
28  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  */
35 /*
36  * Copyright (c) 1992, 1993, 1995
37  *	The Regents of the University of California.  All rights reserved.
38  *
39  * This code is derived from software donated to Berkeley by
40  * Jan-Simon Pendry.
41  *
42  * Redistribution and use in source and binary forms, with or without
43  * modification, are permitted provided that the following conditions
44  * are met:
45  * 1. Redistributions of source code must retain the above copyright
46  *    notice, this list of conditions and the following disclaimer.
47  * 2. Redistributions in binary form must reproduce the above copyright
48  *    notice, this list of conditions and the following disclaimer in the
49  *    documentation and/or other materials provided with the distribution.
50  * 3. All advertising materials mentioning features or use of this software
51  *    must display the following acknowledgement:
52  *	This product includes software developed by the University of
53  *	California, Berkeley and its contributors.
54  * 4. Neither the name of the University nor the names of its contributors
55  *    may be used to endorse or promote products derived from this software
56  *    without specific prior written permission.
57  *
58  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
59  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
60  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
61  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
62  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
63  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
64  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
65  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
66  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
67  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
68  * SUCH DAMAGE.
69  *
70  *	from: Id: lofs_vfsops.c,v 1.9 1992/05/30 10:26:24 jsp Exp
71  *	from: @(#)lofs_vfsops.c	1.2 (Berkeley) 6/18/92
72  *	@(#)null_vfsops.c	8.7 (Berkeley) 5/14/95
73  */
74 
75 /*
76  * Null Layer
77  * (See null_vnops.c for a description of what this does.)
78  */
79 
80 #include <sys/cdefs.h>
81 __KERNEL_RCSID(0, "$NetBSD: null_vfsops.c,v 1.42 2003/06/29 22:31:43 fvdl Exp $");
82 
83 #include <sys/param.h>
84 #include <sys/systm.h>
85 #include <sys/time.h>
86 #include <sys/proc.h>
87 #include <sys/vnode.h>
88 #include <sys/mount.h>
89 #include <sys/namei.h>
90 #include <sys/malloc.h>
91 
92 #include <miscfs/nullfs/null.h>
93 #include <miscfs/genfs/layer_extern.h>
94 
95 int	nullfs_mount __P((struct mount *, const char *, void *,
96 	    struct nameidata *, struct proc *));
97 int	nullfs_unmount __P((struct mount *, int, struct proc *));
98 
99 /*
100  * Mount null layer
101  */
102 int
103 nullfs_mount(mp, path, data, ndp, p)
104 	struct mount *mp;
105 	const char *path;
106 	void *data;
107 	struct nameidata *ndp;
108 	struct proc *p;
109 {
110 	struct null_args args;
111 	struct vnode *lowerrootvp, *vp;
112 	struct null_mount *nmp;
113 	struct layer_mount *lmp;
114 	int error = 0;
115 
116 #ifdef NULLFS_DIAGNOSTIC
117 	printf("nullfs_mount(mp = %p)\n", mp);
118 #endif
119 
120 	if (mp->mnt_flag & MNT_GETARGS) {
121 		lmp = MOUNTTOLAYERMOUNT(mp);
122 		if (lmp == NULL)
123 			return EIO;
124 		args.la.target = NULL;
125 		vfs_showexport(mp, &args.la.export, &lmp->layerm_export);
126 		return copyout(&args, data, sizeof(args));
127 	}
128 	/*
129 	 * Get argument
130 	 */
131 	error = copyin(data, (caddr_t)&args, sizeof(struct null_args));
132 	if (error)
133 		return (error);
134 
135 	/*
136 	 * Update only does export updating.
137 	 */
138 	if (mp->mnt_flag & MNT_UPDATE) {
139 		lmp = MOUNTTOLAYERMOUNT(mp);
140 		if (args.nulla_target == NULL)
141 			return (vfs_export(mp, &lmp->layerm_export,
142 			    &args.la.export));
143 		else
144 			return (EOPNOTSUPP);
145 	}
146 
147 	/*
148 	 * Find lower node
149 	 */
150 	NDINIT(ndp, LOOKUP, FOLLOW|LOCKLEAF,
151 		UIO_USERSPACE, args.la.target, p);
152 	if ((error = namei(ndp)) != 0)
153 		return (error);
154 
155 	/*
156 	 * Sanity check on lower vnode
157 	 */
158 	lowerrootvp = ndp->ni_vp;
159 
160 	/*
161 	 * First cut at fixing up upper mount point
162 	 */
163 	nmp = (struct null_mount *) malloc(sizeof(struct null_mount),
164 	    M_UFSMNT, M_WAITOK);		/* XXX */
165 	memset((caddr_t)nmp, 0, sizeof(struct null_mount));
166 
167 	mp->mnt_data = nmp;
168 	nmp->nullm_vfs = lowerrootvp->v_mount;
169 	if (nmp->nullm_vfs->mnt_flag & MNT_LOCAL)
170 		mp->mnt_flag |= MNT_LOCAL;
171 
172 	/*
173 	 * Make sure that the mount point is sufficiently initialized
174 	 * that the node create call will work.
175 	 */
176 	vfs_getnewfsid(mp);
177 
178 	nmp->nullm_size = sizeof(struct null_node);
179 	nmp->nullm_tag = VT_NULL;
180 	nmp->nullm_bypass = layer_bypass;
181 	nmp->nullm_alloc = layer_node_alloc;	/* the default alloc is fine */
182 	nmp->nullm_vnodeop_p = null_vnodeop_p;
183 	simple_lock_init(&nmp->nullm_hashlock);
184 	nmp->nullm_node_hashtbl = hashinit(desiredvnodes, HASH_LIST, M_CACHE,
185 	    M_WAITOK, &nmp->nullm_node_hash);
186 
187 	/*
188 	 * Fix up null node for root vnode
189 	 */
190 	error = layer_node_create(mp, lowerrootvp, &vp);
191 	/*
192 	 * Make sure the fixup worked
193 	 */
194 	if (error) {
195 		vput(lowerrootvp);
196 		hashdone(nmp->nullm_node_hashtbl, M_CACHE);
197 		free(nmp, M_UFSMNT);	/* XXX */
198 		return (error);
199 	}
200 	/*
201 	 * Unlock the node
202 	 */
203 	VOP_UNLOCK(vp, 0);
204 
205 	/*
206 	 * Keep a held reference to the root vnode.
207 	 * It is vrele'd in nullfs_unmount.
208 	 */
209 	vp->v_flag |= VROOT;
210 	nmp->nullm_rootvp = vp;
211 
212 	error = set_statfs_info(path, UIO_USERSPACE, args.la.target,
213 	    UIO_USERSPACE, mp, p);
214 #ifdef NULLFS_DIAGNOSTIC
215 	printf("nullfs_mount: lower %s, alias at %s\n",
216 	    mp->mnt_stat.f_mntfromname, mp->mnt_stat.f_mntonname);
217 #endif
218 	return error;
219 }
220 
221 /*
222  * Free reference to null layer
223  */
224 int
225 nullfs_unmount(mp, mntflags, p)
226 	struct mount *mp;
227 	int mntflags;
228 	struct proc *p;
229 {
230 	struct null_mount *nmp = MOUNTTONULLMOUNT(mp);
231 	struct vnode *null_rootvp = nmp->nullm_rootvp;
232 	int error;
233 	int flags = 0;
234 
235 #ifdef NULLFS_DIAGNOSTIC
236 	printf("nullfs_unmount(mp = %p)\n", mp);
237 #endif
238 
239 	if (mntflags & MNT_FORCE)
240 		flags |= FORCECLOSE;
241 
242 	/*
243 	 * Clear out buffer cache.  I don't think we
244 	 * ever get anything cached at this level at the
245 	 * moment, but who knows...
246 	 */
247 #if 0
248 	mntflushbuf(mp, 0);
249 	if (mntinvalbuf(mp, 1))
250 		return (EBUSY);
251 #endif
252 	if (null_rootvp->v_usecount > 1)
253 		return (EBUSY);
254 	if ((error = vflush(mp, null_rootvp, flags)) != 0)
255 		return (error);
256 
257 #ifdef NULLFS_DIAGNOSTIC
258 	vprint("alias root of lower", null_rootvp);
259 #endif
260 	/*
261 	 * Release reference on underlying root vnode
262 	 */
263 	vrele(null_rootvp);
264 
265 	/*
266 	 * And blow it away for future re-use
267 	 */
268 	vgone(null_rootvp);
269 
270 	/*
271 	 * Finally, throw away the null_mount structure
272 	 */
273 	hashdone(nmp->nullm_node_hashtbl, M_CACHE);
274 	free(mp->mnt_data, M_UFSMNT);	/* XXX */
275 	mp->mnt_data = NULL;
276 	return (0);
277 }
278 
279 extern const struct vnodeopv_desc null_vnodeop_opv_desc;
280 
281 const struct vnodeopv_desc * const nullfs_vnodeopv_descs[] = {
282 	&null_vnodeop_opv_desc,
283 	NULL,
284 };
285 
286 struct vfsops nullfs_vfsops = {
287 	MOUNT_NULL,
288 	nullfs_mount,
289 	layerfs_start,
290 	nullfs_unmount,
291 	layerfs_root,
292 	layerfs_quotactl,
293 	layerfs_statfs,
294 	layerfs_sync,
295 	layerfs_vget,
296 	layerfs_fhtovp,
297 	layerfs_vptofh,
298 	layerfs_init,
299 	NULL,
300 	layerfs_done,
301 	layerfs_sysctl,
302 	NULL,				/* vfs_mountroot */
303 	layerfs_checkexp,
304 	nullfs_vnodeopv_descs,
305 };
306