null_vfsops.c revision 138075
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 * 4. Neither the name of the University nor the names of its contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 *	@(#)null_vfsops.c	8.2 (Berkeley) 1/21/94
33 *
34 * @(#)lofs_vfsops.c	1.2 (Berkeley) 6/18/92
35 * $FreeBSD: head/sys/fs/nullfs/null_vfsops.c 138075 2004-11-25 09:11:27Z phk $
36 */
37
38/*
39 * Null Layer
40 * (See null_vnops.c for a description of what this does.)
41 */
42
43#include <sys/param.h>
44#include <sys/systm.h>
45#include <sys/kdb.h>
46#include <sys/kernel.h>
47#include <sys/lock.h>
48#include <sys/malloc.h>
49#include <sys/mount.h>
50#include <sys/namei.h>
51#include <sys/proc.h>
52#include <sys/vnode.h>
53
54#include <fs/nullfs/null.h>
55
56static MALLOC_DEFINE(M_NULLFSMNT, "NULLFS mount", "NULLFS mount structure");
57
58static vfs_fhtovp_t	nullfs_fhtovp;
59static vfs_checkexp_t	nullfs_checkexp;
60static vfs_mount_t	nullfs_mount;
61static vfs_quotactl_t	nullfs_quotactl;
62static vfs_root_t	nullfs_root;
63static vfs_sync_t	nullfs_sync;
64static vfs_statfs_t	nullfs_statfs;
65static vfs_unmount_t	nullfs_unmount;
66static vfs_vget_t	nullfs_vget;
67static vfs_vptofh_t	nullfs_vptofh;
68static vfs_extattrctl_t	nullfs_extattrctl;
69
70/*
71 * Mount null layer
72 */
73static int
74nullfs_mount(struct mount *mp, struct thread *td)
75{
76	int error = 0;
77	struct vnode *lowerrootvp, *vp;
78	struct vnode *nullm_rootvp;
79	struct null_mount *xmp;
80	char *target;
81	size_t size;
82	int isvnunlocked = 0, len;
83	struct nameidata nd, *ndp = &nd;
84
85	NULLFSDEBUG("nullfs_mount(mp = %p)\n", (void *)mp);
86
87	if (mp->mnt_flag & MNT_ROOTFS)
88		return (EOPNOTSUPP);
89	/*
90	 * Update is a no-op
91	 */
92	if (mp->mnt_flag & MNT_UPDATE) {
93		return (EOPNOTSUPP);
94		/* return VFS_MOUNT(MOUNTTONULLMOUNT(mp)->nullm_vfs, path, data, ndp, td);*/
95	}
96
97	/*
98	 * Get argument
99	 */
100	error = vfs_getopt(mp->mnt_optnew, "target", (void **)&target, &len);
101	if (error || target[len - 1] != '\0')
102		return (EINVAL);
103
104	/*
105	 * Unlock lower node to avoid deadlock.
106	 * (XXX) VOP_ISLOCKED is needed?
107	 */
108	if ((mp->mnt_vnodecovered->v_op == null_vnodeop_p) &&
109		VOP_ISLOCKED(mp->mnt_vnodecovered, NULL)) {
110		VOP_UNLOCK(mp->mnt_vnodecovered, 0, td);
111		isvnunlocked = 1;
112	}
113	/*
114	 * Find lower node
115	 */
116	NDINIT(ndp, LOOKUP, FOLLOW|WANTPARENT|LOCKLEAF,
117		UIO_SYSSPACE, target, td);
118	error = namei(ndp);
119	/*
120	 * Re-lock vnode.
121	 */
122	if (isvnunlocked && !VOP_ISLOCKED(mp->mnt_vnodecovered, NULL))
123		vn_lock(mp->mnt_vnodecovered, LK_EXCLUSIVE | LK_RETRY, td);
124
125	if (error)
126		return (error);
127	NDFREE(ndp, NDF_ONLY_PNBUF);
128
129	/*
130	 * Sanity check on lower vnode
131	 */
132	lowerrootvp = ndp->ni_vp;
133
134	vrele(ndp->ni_dvp);
135	ndp->ni_dvp = NULLVP;
136
137	/*
138	 * Check multi null mount to avoid `lock against myself' panic.
139	 */
140	if (lowerrootvp == VTONULL(mp->mnt_vnodecovered)->null_lowervp) {
141		NULLFSDEBUG("nullfs_mount: multi null mount?\n");
142		vput(lowerrootvp);
143		return (EDEADLK);
144	}
145
146	xmp = (struct null_mount *) malloc(sizeof(struct null_mount),
147				M_NULLFSMNT, M_WAITOK);	/* XXX */
148
149	/*
150	 * Save reference to underlying FS
151	 */
152	xmp->nullm_vfs = lowerrootvp->v_mount;
153
154	/*
155	 * Save reference.  Each mount also holds
156	 * a reference on the root vnode.
157	 */
158	error = null_nodeget(mp, lowerrootvp, &vp);
159	/*
160	 * Make sure the node alias worked
161	 */
162	if (error) {
163		VOP_UNLOCK(vp, 0, td);
164		vrele(lowerrootvp);
165		free(xmp, M_NULLFSMNT);	/* XXX */
166		return (error);
167	}
168
169	/*
170	 * Keep a held reference to the root vnode.
171	 * It is vrele'd in nullfs_unmount.
172	 */
173	nullm_rootvp = vp;
174	nullm_rootvp->v_vflag |= VV_ROOT;
175	xmp->nullm_rootvp = nullm_rootvp;
176
177	/*
178	 * Unlock the node (either the lower or the alias)
179	 */
180	VOP_UNLOCK(vp, 0, td);
181
182	if (NULLVPTOLOWERVP(nullm_rootvp)->v_mount->mnt_flag & MNT_LOCAL)
183		mp->mnt_flag |= MNT_LOCAL;
184	mp->mnt_data = (qaddr_t) xmp;
185	vfs_getnewfsid(mp);
186
187	(void) copystr(target, mp->mnt_stat.f_mntfromname,
188	    MNAMELEN - 1, &size);
189	bzero(mp->mnt_stat.f_mntfromname + size, MNAMELEN - size);
190	(void)nullfs_statfs(mp, &mp->mnt_stat, td);
191	NULLFSDEBUG("nullfs_mount: lower %s, alias at %s\n",
192		mp->mnt_stat.f_mntfromname, mp->mnt_stat.f_mntonname);
193	return (0);
194}
195
196/*
197 * Free reference to null layer
198 */
199static int
200nullfs_unmount(mp, mntflags, td)
201	struct mount *mp;
202	int mntflags;
203	struct thread *td;
204{
205	void *mntdata;
206	int error;
207	int flags = 0;
208
209	NULLFSDEBUG("nullfs_unmount: mp = %p\n", (void *)mp);
210
211	if (mntflags & MNT_FORCE)
212		flags |= FORCECLOSE;
213
214	/* There is 1 extra root vnode reference (nullm_rootvp). */
215	error = vflush(mp, 1, flags, td);
216	if (error)
217		return (error);
218
219	/*
220	 * Finally, throw away the null_mount structure
221	 */
222	mntdata = mp->mnt_data;
223	mp->mnt_data = 0;
224	free(mntdata, M_NULLFSMNT);
225	return 0;
226}
227
228static int
229nullfs_root(mp, vpp, td)
230	struct mount *mp;
231	struct vnode **vpp;
232	struct thread *td;
233{
234	struct vnode *vp;
235
236	NULLFSDEBUG("nullfs_root(mp = %p, vp = %p->%p)\n", (void *)mp,
237	    (void *)MOUNTTONULLMOUNT(mp)->nullm_rootvp,
238	    (void *)NULLVPTOLOWERVP(MOUNTTONULLMOUNT(mp)->nullm_rootvp));
239
240	/*
241	 * Return locked reference to root.
242	 */
243	vp = MOUNTTONULLMOUNT(mp)->nullm_rootvp;
244	VREF(vp);
245
246#ifdef NULLFS_DEBUG
247	if (VOP_ISLOCKED(vp, NULL)) {
248		kdb_enter("root vnode is locked.\n");
249		vrele(vp);
250		return (EDEADLK);
251	}
252#endif
253	vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, td);
254	*vpp = vp;
255	return 0;
256}
257
258static int
259nullfs_quotactl(mp, cmd, uid, arg, td)
260	struct mount *mp;
261	int cmd;
262	uid_t uid;
263	caddr_t arg;
264	struct thread *td;
265{
266	return VFS_QUOTACTL(MOUNTTONULLMOUNT(mp)->nullm_vfs, cmd, uid, arg, td);
267}
268
269static int
270nullfs_statfs(mp, sbp, td)
271	struct mount *mp;
272	struct statfs *sbp;
273	struct thread *td;
274{
275	int error;
276	struct statfs mstat;
277
278	NULLFSDEBUG("nullfs_statfs(mp = %p, vp = %p->%p)\n", (void *)mp,
279	    (void *)MOUNTTONULLMOUNT(mp)->nullm_rootvp,
280	    (void *)NULLVPTOLOWERVP(MOUNTTONULLMOUNT(mp)->nullm_rootvp));
281
282	bzero(&mstat, sizeof(mstat));
283
284	error = VFS_STATFS(MOUNTTONULLMOUNT(mp)->nullm_vfs, &mstat, td);
285	if (error)
286		return (error);
287
288	/* now copy across the "interesting" information and fake the rest */
289	sbp->f_type = mstat.f_type;
290	sbp->f_flags = mstat.f_flags;
291	sbp->f_bsize = mstat.f_bsize;
292	sbp->f_iosize = mstat.f_iosize;
293	sbp->f_blocks = mstat.f_blocks;
294	sbp->f_bfree = mstat.f_bfree;
295	sbp->f_bavail = mstat.f_bavail;
296	sbp->f_files = mstat.f_files;
297	sbp->f_ffree = mstat.f_ffree;
298	if (sbp != &mp->mnt_stat) {
299		bcopy(&mp->mnt_stat.f_fsid, &sbp->f_fsid, sizeof(sbp->f_fsid));
300		bcopy(mp->mnt_stat.f_mntonname, sbp->f_mntonname, MNAMELEN);
301		bcopy(mp->mnt_stat.f_mntfromname, sbp->f_mntfromname, MNAMELEN);
302	}
303	return (0);
304}
305
306static int
307nullfs_sync(mp, waitfor, cred, td)
308	struct mount *mp;
309	int waitfor;
310	struct ucred *cred;
311	struct thread *td;
312{
313	/*
314	 * XXX - Assumes no data cached at null layer.
315	 */
316	return (0);
317}
318
319static int
320nullfs_vget(mp, ino, flags, vpp)
321	struct mount *mp;
322	ino_t ino;
323	int flags;
324	struct vnode **vpp;
325{
326	int error;
327	error = VFS_VGET(MOUNTTONULLMOUNT(mp)->nullm_vfs, ino, flags, vpp);
328	if (error)
329		return (error);
330
331	return (null_nodeget(mp, *vpp, vpp));
332}
333
334static int
335nullfs_fhtovp(mp, fidp, vpp)
336	struct mount *mp;
337	struct fid *fidp;
338	struct vnode **vpp;
339{
340	int error;
341	error = VFS_FHTOVP(MOUNTTONULLMOUNT(mp)->nullm_vfs, fidp, vpp);
342	if (error)
343		return (error);
344
345	return (null_nodeget(mp, *vpp, vpp));
346}
347
348static int
349nullfs_checkexp(mp, nam, extflagsp, credanonp)
350	struct mount *mp;
351	struct sockaddr *nam;
352	int *extflagsp;
353	struct ucred **credanonp;
354{
355
356	return VFS_CHECKEXP(MOUNTTONULLMOUNT(mp)->nullm_vfs, nam,
357		extflagsp, credanonp);
358}
359
360static int
361nullfs_vptofh(vp, fhp)
362	struct vnode *vp;
363	struct fid *fhp;
364{
365	struct vnode *lvp;
366
367	lvp = NULLVPTOLOWERVP(vp);
368	return VFS_VPTOFH(lvp, fhp);
369}
370
371static int
372nullfs_extattrctl(mp, cmd, filename_vp, namespace, attrname, td)
373	struct mount *mp;
374	int cmd;
375	struct vnode *filename_vp;
376	int namespace;
377	const char *attrname;
378	struct thread *td;
379{
380	return VFS_EXTATTRCTL(MOUNTTONULLMOUNT(mp)->nullm_vfs, cmd, filename_vp,
381	    namespace, attrname, td);
382}
383
384
385static struct vfsops null_vfsops = {
386	.vfs_checkexp =		nullfs_checkexp,
387	.vfs_extattrctl =	nullfs_extattrctl,
388	.vfs_fhtovp =		nullfs_fhtovp,
389	.vfs_init =		nullfs_init,
390	.vfs_mount =		nullfs_mount,
391	.vfs_quotactl =		nullfs_quotactl,
392	.vfs_root =		nullfs_root,
393	.vfs_statfs =		nullfs_statfs,
394	.vfs_sync =		nullfs_sync,
395	.vfs_uninit =		nullfs_uninit,
396	.vfs_unmount =		nullfs_unmount,
397	.vfs_vget =		nullfs_vget,
398	.vfs_vptofh =		nullfs_vptofh,
399};
400
401VFS_SET(null_vfsops, nullfs, VFCF_LOOPBACK);
402