null_vfsops.c revision 33964
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.24 1998/02/06 12:13:40 eivind 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
59static MALLOC_DEFINE(M_NULLFSMNT, "NULLFS mount", "NULLFS mount structure");
60
61static int	nullfs_fhtovp __P((struct mount *mp, struct fid *fidp,
62				   struct sockaddr *nam, struct vnode **vpp,
63				   int *exflagsp, struct ucred **credanonp));
64static int	nullfs_mount __P((struct mount *mp, char *path, caddr_t data,
65				  struct nameidata *ndp, struct proc *p));
66static int	nullfs_quotactl __P((struct mount *mp, int cmd, uid_t uid,
67				     caddr_t arg, struct proc *p));
68static int	nullfs_root __P((struct mount *mp, struct vnode **vpp));
69static int	nullfs_start __P((struct mount *mp, int flags, struct proc *p));
70static int	nullfs_statfs __P((struct mount *mp, struct statfs *sbp,
71				   struct proc *p));
72static int	nullfs_sync __P((struct mount *mp, int waitfor,
73				 struct ucred *cred, struct proc *p));
74static int	nullfs_unmount __P((struct mount *mp, int mntflags,
75				    struct proc *p));
76static int	nullfs_vget __P((struct mount *mp, ino_t ino,
77				 struct vnode **vpp));
78static int	nullfs_vrele __P((struct mount *mp, struct vnode *vp));
79static int	nullfs_vptofh __P((struct vnode *vp, struct fid *fhp));
80
81/*
82 * Mount null layer
83 */
84static int
85nullfs_mount(mp, path, data, ndp, p)
86	struct mount *mp;
87	char *path;
88	caddr_t data;
89	struct nameidata *ndp;
90	struct proc *p;
91{
92	int error = 0;
93	struct null_args args;
94	struct vnode *lowerrootvp, *vp;
95	struct vnode *nullm_rootvp;
96	struct null_mount *xmp;
97	u_int size;
98	int isvnunlocked = 0;
99
100#ifdef NULLFS_DIAGNOSTIC
101	printf("nullfs_mount(mp = %x)\n", mp);
102#endif
103
104	/*
105	 * Update is a no-op
106	 */
107	if (mp->mnt_flag & MNT_UPDATE) {
108		return (EOPNOTSUPP);
109		/* return VFS_MOUNT(MOUNTTONULLMOUNT(mp)->nullm_vfs, path, data, ndp, p);*/
110	}
111
112	/*
113	 * Get argument
114	 */
115	error = copyin(data, (caddr_t)&args, sizeof(struct null_args));
116	if (error)
117		return (error);
118
119	/*
120	 * Unlock lower node to avoid deadlock.
121	 * (XXX) VOP_ISLOCKED is needed?
122	 */
123	if ((mp->mnt_vnodecovered->v_op == null_vnodeop_p) &&
124		VOP_ISLOCKED(mp->mnt_vnodecovered)) {
125		VOP_UNLOCK(mp->mnt_vnodecovered, 0, p);
126		isvnunlocked = 1;
127	}
128	/*
129	 * Find lower node
130	 */
131	NDINIT(ndp, LOOKUP, FOLLOW|WANTPARENT|LOCKLEAF,
132		UIO_USERSPACE, args.target, p);
133	error = namei(ndp);
134	/*
135	 * Re-lock vnode.
136	 */
137	if (isvnunlocked && !VOP_ISLOCKED(mp->mnt_vnodecovered))
138		vn_lock(mp->mnt_vnodecovered, LK_EXCLUSIVE | LK_RETRY, p);
139
140	if (error)
141		return (error);
142
143	/*
144	 * Sanity check on lower vnode
145	 */
146	lowerrootvp = ndp->ni_vp;
147
148	vrele(ndp->ni_dvp);
149	ndp->ni_dvp = NULLVP;
150
151	/*
152	 * Check multi null mount to avoid `lock against myself' panic.
153	 */
154	if (lowerrootvp == VTONULL(mp->mnt_vnodecovered)->null_lowervp) {
155#ifdef DIAGNOSTIC
156		printf("nullfs_mount: multi null mount?\n");
157#endif
158		return (EDEADLK);
159	}
160
161	xmp = (struct null_mount *) malloc(sizeof(struct null_mount),
162				M_NULLFSMNT, M_WAITOK);	/* XXX */
163
164	/*
165	 * Save reference to underlying FS
166	 */
167	xmp->nullm_vfs = lowerrootvp->v_mount;
168
169	/*
170	 * Save reference.  Each mount also holds
171	 * a reference on the root vnode.
172	 */
173	error = null_node_create(mp, lowerrootvp, &vp);
174	/*
175	 * Unlock the node (either the lower or the alias)
176	 */
177	VOP_UNLOCK(vp, 0, p);
178	/*
179	 * Make sure the node alias worked
180	 */
181	if (error) {
182		vrele(lowerrootvp);
183		free(xmp, M_NULLFSMNT);	/* XXX */
184		return (error);
185	}
186
187	/*
188	 * Keep a held reference to the root vnode.
189	 * It is vrele'd in nullfs_unmount.
190	 */
191	nullm_rootvp = vp;
192	nullm_rootvp->v_flag |= VROOT;
193	xmp->nullm_rootvp = nullm_rootvp;
194	if (NULLVPTOLOWERVP(nullm_rootvp)->v_mount->mnt_flag & MNT_LOCAL)
195		mp->mnt_flag |= MNT_LOCAL;
196	mp->mnt_data = (qaddr_t) xmp;
197	vfs_getnewfsid(mp);
198
199	(void) copyinstr(path, mp->mnt_stat.f_mntonname, MNAMELEN - 1, &size);
200	bzero(mp->mnt_stat.f_mntonname + size, MNAMELEN - size);
201	(void) copyinstr(args.target, mp->mnt_stat.f_mntfromname, MNAMELEN - 1,
202	    &size);
203	bzero(mp->mnt_stat.f_mntfromname + size, MNAMELEN - size);
204	(void)nullfs_statfs(mp, &mp->mnt_stat, p);
205#ifdef NULLFS_DIAGNOSTIC
206	printf("nullfs_mount: lower %s, alias at %s\n",
207		mp->mnt_stat.f_mntfromname, mp->mnt_stat.f_mntonname);
208#endif
209	return (0);
210}
211
212/*
213 * VFS start.  Nothing needed here - the start routine
214 * on the underlying filesystem will have been called
215 * when that filesystem was mounted.
216 */
217static int
218nullfs_start(mp, flags, p)
219	struct mount *mp;
220	int flags;
221	struct proc *p;
222{
223	return (0);
224	/* return VFS_START(MOUNTTONULLMOUNT(mp)->nullm_vfs, flags, p); */
225}
226
227/*
228 * Free reference to null layer
229 */
230static int
231nullfs_unmount(mp, mntflags, p)
232	struct mount *mp;
233	int mntflags;
234	struct proc *p;
235{
236	struct vnode *nullm_rootvp = MOUNTTONULLMOUNT(mp)->nullm_rootvp;
237	int error;
238	int flags = 0;
239
240#ifdef NULLFS_DIAGNOSTIC
241	printf("nullfs_unmount(mp = %x)\n", mp);
242#endif
243
244	if (mntflags & MNT_FORCE)
245		flags |= FORCECLOSE;
246
247	/*
248	 * Clear out buffer cache.  I don't think we
249	 * ever get anything cached at this level at the
250	 * moment, but who knows...
251	 */
252#if 0
253	mntflushbuf(mp, 0);
254	if (mntinvalbuf(mp, 1))
255		return (EBUSY);
256#endif
257	if (nullm_rootvp->v_usecount > 1)
258		return (EBUSY);
259	error = vflush(mp, nullm_rootvp, flags);
260	if (error)
261		return (error);
262
263#ifdef NULLFS_DIAGNOSTIC
264	vprint("alias root of lower", nullm_rootvp);
265#endif
266	/*
267	 * Release reference on underlying root vnode
268	 */
269	vrele(nullm_rootvp);
270	/*
271	 * And blow it away for future re-use
272	 */
273	vgone(nullm_rootvp);
274	/*
275	 * Finally, throw away the null_mount structure
276	 */
277	free(mp->mnt_data, M_NULLFSMNT);	/* XXX */
278	mp->mnt_data = 0;
279	return 0;
280}
281
282static int
283nullfs_root(mp, vpp)
284	struct mount *mp;
285	struct vnode **vpp;
286{
287	struct proc *p = curproc;	/* XXX */
288	struct vnode *vp;
289
290#ifdef NULLFS_DIAGNOSTIC
291	printf("nullfs_root(mp = %x, vp = %x->%x)\n", mp,
292			MOUNTTONULLMOUNT(mp)->nullm_rootvp,
293			NULLVPTOLOWERVP(MOUNTTONULLMOUNT(mp)->nullm_rootvp)
294			);
295#endif
296
297	/*
298	 * Return locked reference to root.
299	 */
300	vp = MOUNTTONULLMOUNT(mp)->nullm_rootvp;
301	VREF(vp);
302	if (VOP_ISLOCKED(vp)) {
303		/*
304		 * XXX
305		 * Should we check type of node?
306		 */
307#ifdef DIAGNOSTIC
308		printf("nullfs_root: multi null mount?\n");
309#endif
310		vrele(vp);
311		return (EDEADLK);
312	} else
313		vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, p);
314	*vpp = vp;
315	return 0;
316}
317
318static int
319nullfs_quotactl(mp, cmd, uid, arg, p)
320	struct mount *mp;
321	int cmd;
322	uid_t uid;
323	caddr_t arg;
324	struct proc *p;
325{
326	return VFS_QUOTACTL(MOUNTTONULLMOUNT(mp)->nullm_vfs, cmd, uid, arg, p);
327}
328
329static int
330nullfs_statfs(mp, sbp, p)
331	struct mount *mp;
332	struct statfs *sbp;
333	struct proc *p;
334{
335	int error;
336	struct statfs mstat;
337
338#ifdef NULLFS_DIAGNOSTIC
339	printf("nullfs_statfs(mp = %x, vp = %x->%x)\n", mp,
340			MOUNTTONULLMOUNT(mp)->nullm_rootvp,
341			NULLVPTOLOWERVP(MOUNTTONULLMOUNT(mp)->nullm_rootvp)
342			);
343#endif
344
345	bzero(&mstat, sizeof(mstat));
346
347	error = VFS_STATFS(MOUNTTONULLMOUNT(mp)->nullm_vfs, &mstat, p);
348	if (error)
349		return (error);
350
351	/* now copy across the "interesting" information and fake the rest */
352	sbp->f_type = mstat.f_type;
353	sbp->f_flags = mstat.f_flags;
354	sbp->f_bsize = mstat.f_bsize;
355	sbp->f_iosize = mstat.f_iosize;
356	sbp->f_blocks = mstat.f_blocks;
357	sbp->f_bfree = mstat.f_bfree;
358	sbp->f_bavail = mstat.f_bavail;
359	sbp->f_files = mstat.f_files;
360	sbp->f_ffree = mstat.f_ffree;
361	if (sbp != &mp->mnt_stat) {
362		bcopy(&mp->mnt_stat.f_fsid, &sbp->f_fsid, sizeof(sbp->f_fsid));
363		bcopy(mp->mnt_stat.f_mntonname, sbp->f_mntonname, MNAMELEN);
364		bcopy(mp->mnt_stat.f_mntfromname, sbp->f_mntfromname, MNAMELEN);
365	}
366	return (0);
367}
368
369static int
370nullfs_sync(mp, waitfor, cred, p)
371	struct mount *mp;
372	int waitfor;
373	struct ucred *cred;
374	struct proc *p;
375{
376	/*
377	 * XXX - Assumes no data cached at null layer.
378	 */
379	return (0);
380}
381
382static int
383nullfs_vget(mp, ino, vpp)
384	struct mount *mp;
385	ino_t ino;
386	struct vnode **vpp;
387{
388
389	return VFS_VGET(MOUNTTONULLMOUNT(mp)->nullm_vfs, ino, vpp);
390}
391
392/*
393 * Complement to all vpp returning ops.
394 * XXX - initially only to get rid of WILLRELE.
395 */
396/* ARGSUSED */
397static int
398nullfs_vrele(mp, vp)
399	struct mount *mp;
400	struct vnode *vp;
401{
402	int error = 0;
403
404	error = VFS_VRELE(MOUNTTONULLMOUNT(mp)->nullm_vfs,
405			  NULLVPTOLOWERVP(vp));
406	vrele(vp);
407	return (error);
408}
409
410static int
411nullfs_fhtovp(mp, fidp, nam, vpp, exflagsp, credanonp)
412	struct mount *mp;
413	struct fid *fidp;
414	struct sockaddr *nam;
415	struct vnode **vpp;
416	int *exflagsp;
417	struct ucred**credanonp;
418{
419
420	return VFS_FHTOVP(MOUNTTONULLMOUNT(mp)->nullm_vfs, fidp, nam,
421			  vpp, exflagsp, credanonp);
422}
423
424static int
425nullfs_vptofh(vp, fhp)
426	struct vnode *vp;
427	struct fid *fhp;
428{
429	return VFS_VPTOFH(NULLVPTOLOWERVP(vp), fhp);
430}
431
432static struct vfsops null_vfsops = {
433	nullfs_mount,
434	nullfs_start,
435	nullfs_unmount,
436	nullfs_root,
437	nullfs_quotactl,
438	nullfs_statfs,
439	nullfs_sync,
440	nullfs_vget,
441	nullfs_vrele,
442	nullfs_fhtovp,
443	nullfs_vptofh,
444	nullfs_init,
445};
446
447VFS_SET(null_vfsops, null, MOUNT_NULL, VFCF_LOOPBACK);
448