xref: /freebsd/sys/fs/nullfs/null_vfsops.c (revision 3f2076da)
1 /*
2  * Copyright (c) 1992, 1993, 1995
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software donated to Berkeley by
6  * Jan-Simon Pendry.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by the University of
19  *	California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	@(#)null_vfsops.c	8.2 (Berkeley) 1/21/94
37  *
38  * @(#)lofs_vfsops.c	1.2 (Berkeley) 6/18/92
39  * $Id: null_vfsops.c,v 1.21 1998/01/01 08:28:05 bde Exp $
40  */
41 
42 /*
43  * Null Layer
44  * (See null_vnops.c for a description of what this does.)
45  */
46 
47 #include "opt_debug_nullfs.h"
48 
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/kernel.h>
52 #include <sys/proc.h>
53 #include <sys/malloc.h>
54 #include <sys/vnode.h>
55 #include <sys/mount.h>
56 #include <sys/namei.h>
57 #include <miscfs/nullfs/null.h>
58 
59 static MALLOC_DEFINE(M_NULLFSMNT, "NULLFS mount", "NULLFS mount structure");
60 
61 static int	nullfs_fhtovp __P((struct mount *mp, struct fid *fidp,
62 				   struct sockaddr *nam, struct vnode **vpp,
63 				   int *exflagsp, struct ucred **credanonp));
64 static int	nullfs_mount __P((struct mount *mp, char *path, caddr_t data,
65 				  struct nameidata *ndp, struct proc *p));
66 static int	nullfs_quotactl __P((struct mount *mp, int cmd, uid_t uid,
67 				     caddr_t arg, struct proc *p));
68 static int	nullfs_root __P((struct mount *mp, struct vnode **vpp));
69 static int	nullfs_start __P((struct mount *mp, int flags, struct proc *p));
70 static int	nullfs_statfs __P((struct mount *mp, struct statfs *sbp,
71 				   struct proc *p));
72 static int	nullfs_sync __P((struct mount *mp, int waitfor,
73 				 struct ucred *cred, struct proc *p));
74 static int	nullfs_unmount __P((struct mount *mp, int mntflags,
75 				    struct proc *p));
76 static int	nullfs_vget __P((struct mount *mp, ino_t ino,
77 				 struct vnode **vpp));
78 static int	nullfs_vptofh __P((struct vnode *vp, struct fid *fhp));
79 
80 /*
81  * Mount null layer
82  */
83 static int
84 nullfs_mount(mp, path, data, ndp, p)
85 	struct mount *mp;
86 	char *path;
87 	caddr_t data;
88 	struct nameidata *ndp;
89 	struct proc *p;
90 {
91 	int error = 0;
92 	struct null_args args;
93 	struct vnode *lowerrootvp, *vp;
94 	struct vnode *nullm_rootvp;
95 	struct null_mount *xmp;
96 	u_int size;
97 	int isvnunlocked = 0;
98 
99 #ifdef NULLFS_DIAGNOSTIC
100 	printf("nullfs_mount(mp = %x)\n", mp);
101 #endif
102 
103 	/*
104 	 * Update is a no-op
105 	 */
106 	if (mp->mnt_flag & MNT_UPDATE) {
107 		return (EOPNOTSUPP);
108 		/* return VFS_MOUNT(MOUNTTONULLMOUNT(mp)->nullm_vfs, path, data, ndp, p);*/
109 	}
110 
111 	/*
112 	 * Get argument
113 	 */
114 	error = copyin(data, (caddr_t)&args, sizeof(struct null_args));
115 	if (error)
116 		return (error);
117 
118 	/*
119 	 * Unlock lower node to avoid deadlock.
120 	 * (XXX) VOP_ISLOCKED is needed?
121 	 */
122 	if ((mp->mnt_vnodecovered->v_op == null_vnodeop_p) &&
123 		VOP_ISLOCKED(mp->mnt_vnodecovered)) {
124 		VOP_UNLOCK(mp->mnt_vnodecovered, 0, p);
125 		isvnunlocked = 1;
126 	}
127 	/*
128 	 * Find lower node
129 	 */
130 	NDINIT(ndp, LOOKUP, FOLLOW|WANTPARENT|LOCKLEAF,
131 		UIO_USERSPACE, args.target, p);
132 	error = namei(ndp);
133 	/*
134 	 * Re-lock vnode.
135 	 */
136 	if (isvnunlocked && !VOP_ISLOCKED(mp->mnt_vnodecovered))
137 		vn_lock(mp->mnt_vnodecovered, LK_EXCLUSIVE | LK_RETRY, p);
138 
139 	if (error)
140 		return (error);
141 
142 	/*
143 	 * Sanity check on lower vnode
144 	 */
145 	lowerrootvp = ndp->ni_vp;
146 
147 	vrele(ndp->ni_dvp);
148 	ndp->ni_dvp = NULLVP;
149 
150 	/*
151 	 * Check multi null mount to avoid `lock against myself' panic.
152 	 */
153 	if (lowerrootvp == VTONULL(mp->mnt_vnodecovered)->null_lowervp) {
154 #ifdef DIAGNOSTIC
155 		printf("nullfs_mount: multi null mount?\n");
156 #endif
157 		return (EDEADLK);
158 	}
159 
160 	xmp = (struct null_mount *) malloc(sizeof(struct null_mount),
161 				M_NULLFSMNT, M_WAITOK);	/* XXX */
162 
163 	/*
164 	 * Save reference to underlying FS
165 	 */
166 	xmp->nullm_vfs = lowerrootvp->v_mount;
167 
168 	/*
169 	 * Save reference.  Each mount also holds
170 	 * a reference on the root vnode.
171 	 */
172 	error = null_node_create(mp, lowerrootvp, &vp);
173 	/*
174 	 * Unlock the node (either the lower or the alias)
175 	 */
176 	VOP_UNLOCK(vp, 0, p);
177 	/*
178 	 * Make sure the node alias worked
179 	 */
180 	if (error) {
181 		vrele(lowerrootvp);
182 		free(xmp, M_NULLFSMNT);	/* XXX */
183 		return (error);
184 	}
185 
186 	/*
187 	 * Keep a held reference to the root vnode.
188 	 * It is vrele'd in nullfs_unmount.
189 	 */
190 	nullm_rootvp = vp;
191 	nullm_rootvp->v_flag |= VROOT;
192 	xmp->nullm_rootvp = nullm_rootvp;
193 	if (NULLVPTOLOWERVP(nullm_rootvp)->v_mount->mnt_flag & MNT_LOCAL)
194 		mp->mnt_flag |= MNT_LOCAL;
195 	mp->mnt_data = (qaddr_t) xmp;
196 	vfs_getnewfsid(mp);
197 
198 	(void) copyinstr(path, mp->mnt_stat.f_mntonname, MNAMELEN - 1, &size);
199 	bzero(mp->mnt_stat.f_mntonname + size, MNAMELEN - size);
200 	(void) copyinstr(args.target, mp->mnt_stat.f_mntfromname, MNAMELEN - 1,
201 	    &size);
202 	bzero(mp->mnt_stat.f_mntfromname + size, MNAMELEN - size);
203 	(void)nullfs_statfs(mp, &mp->mnt_stat, p);
204 #ifdef NULLFS_DIAGNOSTIC
205 	printf("nullfs_mount: lower %s, alias at %s\n",
206 		mp->mnt_stat.f_mntfromname, mp->mnt_stat.f_mntonname);
207 #endif
208 	return (0);
209 }
210 
211 /*
212  * VFS start.  Nothing needed here - the start routine
213  * on the underlying filesystem will have been called
214  * when that filesystem was mounted.
215  */
216 static int
217 nullfs_start(mp, flags, p)
218 	struct mount *mp;
219 	int flags;
220 	struct proc *p;
221 {
222 	return (0);
223 	/* return VFS_START(MOUNTTONULLMOUNT(mp)->nullm_vfs, flags, p); */
224 }
225 
226 /*
227  * Free reference to null layer
228  */
229 static int
230 nullfs_unmount(mp, mntflags, p)
231 	struct mount *mp;
232 	int mntflags;
233 	struct proc *p;
234 {
235 	struct vnode *nullm_rootvp = MOUNTTONULLMOUNT(mp)->nullm_rootvp;
236 	int error;
237 	int flags = 0;
238 
239 #ifdef NULLFS_DIAGNOSTIC
240 	printf("nullfs_unmount(mp = %x)\n", mp);
241 #endif
242 
243 	if (mntflags & MNT_FORCE)
244 		flags |= FORCECLOSE;
245 
246 	/*
247 	 * Clear out buffer cache.  I don't think we
248 	 * ever get anything cached at this level at the
249 	 * moment, but who knows...
250 	 */
251 #if 0
252 	mntflushbuf(mp, 0);
253 	if (mntinvalbuf(mp, 1))
254 		return (EBUSY);
255 #endif
256 	if (nullm_rootvp->v_usecount > 1)
257 		return (EBUSY);
258 	error = vflush(mp, nullm_rootvp, flags);
259 	if (error)
260 		return (error);
261 
262 #ifdef NULLFS_DIAGNOSTIC
263 	vprint("alias root of lower", nullm_rootvp);
264 #endif
265 	/*
266 	 * Release reference on underlying root vnode
267 	 */
268 	vrele(nullm_rootvp);
269 	/*
270 	 * And blow it away for future re-use
271 	 */
272 	vgone(nullm_rootvp);
273 	/*
274 	 * Finally, throw away the null_mount structure
275 	 */
276 	free(mp->mnt_data, M_NULLFSMNT);	/* XXX */
277 	mp->mnt_data = 0;
278 	return 0;
279 }
280 
281 static int
282 nullfs_root(mp, vpp)
283 	struct mount *mp;
284 	struct vnode **vpp;
285 {
286 	struct proc *p = curproc;	/* XXX */
287 	struct vnode *vp;
288 
289 #ifdef NULLFS_DIAGNOSTIC
290 	printf("nullfs_root(mp = %x, vp = %x->%x)\n", mp,
291 			MOUNTTONULLMOUNT(mp)->nullm_rootvp,
292 			NULLVPTOLOWERVP(MOUNTTONULLMOUNT(mp)->nullm_rootvp)
293 			);
294 #endif
295 
296 	/*
297 	 * Return locked reference to root.
298 	 */
299 	vp = MOUNTTONULLMOUNT(mp)->nullm_rootvp;
300 	VREF(vp);
301 	if (VOP_ISLOCKED(vp)) {
302 		/*
303 		 * XXX
304 		 * Should we check type of node?
305 		 */
306 #ifdef DIAGNOSTIC
307 		printf("nullfs_root: multi null mount?\n");
308 #endif
309 		vrele(vp);
310 		return (EDEADLK);
311 	} else
312 		vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, p);
313 	*vpp = vp;
314 	return 0;
315 }
316 
317 static int
318 nullfs_quotactl(mp, cmd, uid, arg, p)
319 	struct mount *mp;
320 	int cmd;
321 	uid_t uid;
322 	caddr_t arg;
323 	struct proc *p;
324 {
325 	return VFS_QUOTACTL(MOUNTTONULLMOUNT(mp)->nullm_vfs, cmd, uid, arg, p);
326 }
327 
328 static int
329 nullfs_statfs(mp, sbp, p)
330 	struct mount *mp;
331 	struct statfs *sbp;
332 	struct proc *p;
333 {
334 	int error;
335 	struct statfs mstat;
336 
337 #ifdef NULLFS_DIAGNOSTIC
338 	printf("nullfs_statfs(mp = %x, vp = %x->%x)\n", mp,
339 			MOUNTTONULLMOUNT(mp)->nullm_rootvp,
340 			NULLVPTOLOWERVP(MOUNTTONULLMOUNT(mp)->nullm_rootvp)
341 			);
342 #endif
343 
344 	bzero(&mstat, sizeof(mstat));
345 
346 	error = VFS_STATFS(MOUNTTONULLMOUNT(mp)->nullm_vfs, &mstat, p);
347 	if (error)
348 		return (error);
349 
350 	/* now copy across the "interesting" information and fake the rest */
351 	sbp->f_type = mstat.f_type;
352 	sbp->f_flags = mstat.f_flags;
353 	sbp->f_bsize = mstat.f_bsize;
354 	sbp->f_iosize = mstat.f_iosize;
355 	sbp->f_blocks = mstat.f_blocks;
356 	sbp->f_bfree = mstat.f_bfree;
357 	sbp->f_bavail = mstat.f_bavail;
358 	sbp->f_files = mstat.f_files;
359 	sbp->f_ffree = mstat.f_ffree;
360 	if (sbp != &mp->mnt_stat) {
361 		bcopy(&mp->mnt_stat.f_fsid, &sbp->f_fsid, sizeof(sbp->f_fsid));
362 		bcopy(mp->mnt_stat.f_mntonname, sbp->f_mntonname, MNAMELEN);
363 		bcopy(mp->mnt_stat.f_mntfromname, sbp->f_mntfromname, MNAMELEN);
364 	}
365 	return (0);
366 }
367 
368 static int
369 nullfs_sync(mp, waitfor, cred, p)
370 	struct mount *mp;
371 	int waitfor;
372 	struct ucred *cred;
373 	struct proc *p;
374 {
375 	/*
376 	 * XXX - Assumes no data cached at null layer.
377 	 */
378 	return (0);
379 }
380 
381 static int
382 nullfs_vget(mp, ino, vpp)
383 	struct mount *mp;
384 	ino_t ino;
385 	struct vnode **vpp;
386 {
387 
388 	return VFS_VGET(MOUNTTONULLMOUNT(mp)->nullm_vfs, ino, vpp);
389 }
390 
391 static int
392 nullfs_fhtovp(mp, fidp, nam, vpp, exflagsp, credanonp)
393 	struct mount *mp;
394 	struct fid *fidp;
395 	struct sockaddr *nam;
396 	struct vnode **vpp;
397 	int *exflagsp;
398 	struct ucred**credanonp;
399 {
400 
401 	return VFS_FHTOVP(MOUNTTONULLMOUNT(mp)->nullm_vfs, fidp, nam,
402 			  vpp, exflagsp, credanonp);
403 }
404 
405 static int
406 nullfs_vptofh(vp, fhp)
407 	struct vnode *vp;
408 	struct fid *fhp;
409 {
410 	return VFS_VPTOFH(NULLVPTOLOWERVP(vp), fhp);
411 }
412 
413 static struct vfsops null_vfsops = {
414 	nullfs_mount,
415 	nullfs_start,
416 	nullfs_unmount,
417 	nullfs_root,
418 	nullfs_quotactl,
419 	nullfs_statfs,
420 	nullfs_sync,
421 	nullfs_vget,
422 	nullfs_fhtovp,
423 	nullfs_vptofh,
424 	nullfs_init,
425 };
426 
427 VFS_SET(null_vfsops, null, MOUNT_NULL, VFCF_LOOPBACK);
428