xref: /dragonfly/sys/vfs/nullfs/null_vfsops.c (revision ab23c864)
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. 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: src/sys/miscfs/nullfs/null_vfsops.c,v 1.35.2.3 2001/07/26 20:37:11 iedowse Exp $
36  * $DragonFly: src/sys/vfs/nullfs/null_vfsops.c,v 1.31 2008/09/17 21:44:25 dillon Exp $
37  */
38 
39 /*
40  * Null Layer
41  * (See null_vnops.c for a description of what this does.)
42  */
43 
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/proc.h>
48 #include <sys/malloc.h>
49 #include <sys/vnode.h>
50 #include <sys/mount.h>
51 #include <sys/namecache.h>
52 #include <sys/nlookup.h>
53 #include <sys/mountctl.h>
54 #include "null.h"
55 
56 extern struct vop_ops null_vnode_vops;
57 
58 static MALLOC_DEFINE(M_NULLFSMNT, "NULLFS mount", "NULLFS mount structure");
59 
60 static int	nullfs_root(struct mount *mp, struct vnode **vpp);
61 static int	nullfs_statfs(struct mount *mp, struct statfs *sbp,
62 				struct ucred *cred);
63 
64 /*
65  * Mount null layer
66  */
67 static int
68 nullfs_mount(struct mount *mp, char *path, caddr_t data, struct ucred *cred)
69 {
70 	int error = 0;
71 	struct null_args args;
72 	struct vnode *rootvp;
73 	struct null_mount *xmp;
74 	size_t size;
75 	struct nlookupdata nd;
76 	fhandle_t fh;
77 
78 	NULLFSDEBUG("nullfs_mount(mp = %p)\n", (void *)mp);
79 
80 	/*
81 	 * Get argument
82 	 */
83 	error = copyin(data, (caddr_t)&args, sizeof(struct null_args));
84         if (error)
85 		return (error);
86 
87 	/*
88 	 * XXX: Should we process mount export info ?
89 	 * If not, returning zero here is enough as the actual ro/rw update is
90 	 * being done in sys_mount().
91 	 */
92 	if (mp->mnt_flag & MNT_UPDATE) {
93 		xmp = MOUNTTONULLMOUNT(mp);
94 		error = vfs_export(mp, &xmp->export, &args.export);
95 		return (error);
96 	}
97 
98 	/*
99 	 * Find lower node
100 	 */
101 	rootvp = NULL;
102 	error = nlookup_init(&nd, args.target, UIO_USERSPACE, NLC_FOLLOW);
103 	if (error)
104 		goto fail1;
105 	error = nlookup(&nd);
106 	if (error)
107 		goto fail2;
108 	error = cache_vget(&nd.nl_nch, nd.nl_cred, LK_EXCLUSIVE, &rootvp);
109 	if (error)
110 		goto fail2;
111 
112 	xmp = (struct null_mount *) kmalloc(sizeof(struct null_mount),
113 				M_NULLFSMNT, M_WAITOK | M_ZERO);
114 
115 	/*
116 	 * Save reference to underlying FS
117 	 *
118          * As lite stacking enters the scene, the old way of doing this
119 	 * -- via the vnode -- is not good enough anymore.  Use the
120 	 * underlying filesystem's namecache handle as our mount point
121 	 * root, adjusting the mount to point to us.
122 	 *
123 	 * NCF_ISMOUNTPT is normally set on the mount point, but we also
124 	 * want to set it on the base directory being mounted to prevent
125 	 * that directory from being destroyed out from under the nullfs
126 	 * mount.
127 	 *
128 	 * The forwarding mount pointer (xmp->nullm_vfs) must be set to
129 	 * the actual target filesystem.  If the target filesystem was
130 	 * resolved via a nullfs mount nd.nl_nch.mount will be pointing
131 	 * to the nullfs mount structure instead of the target filesystem,
132 	 * which would otherwise cause the mount VOPS and VFSOPS to recurse
133 	 * endlessly.  If we are mounting via a nullfs mount we inherit
134 	 * its read-only state, if set.
135 	 */
136 	xmp->nullm_vfs = nd.nl_nch.mount;
137 	if (xmp->nullm_vfs != rootvp->v_mount) {
138 		if (xmp->nullm_vfs->mnt_flag & MNT_RDONLY)
139 			mp->mnt_flag |= MNT_RDONLY;
140 		if (xmp->nullm_vfs->mnt_flag & MNT_NOEXEC)
141 			mp->mnt_flag |= MNT_NOEXEC;
142 		xmp->nullm_vfs = rootvp->v_mount;
143 	}
144 
145 	/*
146 	 * ncmountpt is the parent glue.  When mounting a nullfs via a nullfs
147 	 * we retain the parent nullfs to create a unique chain tuple.
148 	 */
149 	mp->mnt_ncmountpt = nd.nl_nch;
150 	cache_changemount(&mp->mnt_ncmountpt, mp);
151 	mp->mnt_ncmountpt.ncp->nc_flag |= NCF_ISMOUNTPT;
152 	cache_unlock(&mp->mnt_ncmountpt);
153 	cache_zero(&nd.nl_nch);
154 	nlookup_done(&nd);
155 
156 	vfs_add_vnodeops(mp, &null_vnode_vops, &mp->mnt_vn_norm_ops);
157 
158 	vn_unlock(rootvp);		/* leave reference intact */
159 
160 	/*
161 	 * Keep a held reference to the root vnode.
162 	 * It is vrele'd in nullfs_unmount.
163 	 */
164 	xmp->nullm_rootvp = rootvp;
165 	/*
166 	 * XXX What's the proper safety condition for querying
167 	 * the underlying mount? Is this flag tuning necessary
168 	 * at all?
169 	 */
170 	if (xmp->nullm_vfs->mnt_flag & MNT_LOCAL)
171 		mp->mnt_flag |= MNT_LOCAL;
172 	mp->mnt_data = (qaddr_t) xmp;
173 
174 	/*
175 	 * Try to create a unique but non-random fsid for the nullfs to
176 	 * allow it to be exported via NFS.
177 	 *
178 	 * Use val[1] so as not to interfere with the generally unique
179 	 * val[0].
180 	 */
181 	bzero(&fh, sizeof(fh));
182 	fh.fh_fsid = rootvp->v_mount->mnt_stat.f_fsid;
183 	if (VFS_VPTOFH(rootvp, &fh.fh_fid) == 0) {
184 		fh.fh_fsid.val[1] ^= crc32(&fh.fh_fid, sizeof(fh.fh_fid));
185 		vfs_setfsid(mp, &fh.fh_fsid);
186 	} else {
187 		vfs_getnewfsid(mp);
188 	}
189 
190 	(void) copyinstr(args.target, mp->mnt_stat.f_mntfromname, MNAMELEN - 1,
191 			    &size);
192 	bzero(mp->mnt_stat.f_mntfromname + size, MNAMELEN - size);
193 	(void)nullfs_statfs(mp, &mp->mnt_stat, cred);
194 	NULLFSDEBUG("nullfs_mount: lower %s, alias at %s\n",
195 		mp->mnt_stat.f_mntfromname, mp->mnt_stat.f_mntfromname);
196 
197 	bzero(mp->mnt_stat.f_mntonname, MNAMELEN);
198 	if (path != NULL) {
199 		(void) copyinstr(path, mp->mnt_stat.f_mntonname, MNAMELEN - 1,
200 			&size);
201 	}
202 
203 	/*
204 	 * Set NCALIASED so unmount won't complain about namecache refs
205 	 * still existing.
206 	 *
207 	 * All NULLFS operations are MPSAFE, though it will be short-lived
208 	 * if the underlying filesystem is not.
209 	 */
210 	mp->mnt_kern_flag |= MNTK_NCALIASED | MNTK_ALL_MPSAFE;
211 
212 	/*
213 	 * And we don't need a syncer thread
214 	 */
215 	vn_syncer_thr_stop(mp);
216 	return (0);
217 fail2:
218 	nlookup_done(&nd);
219 fail1:
220 	return (error);
221 }
222 
223 /*
224  * Free reference to null layer
225  */
226 static int
227 nullfs_unmount(struct mount *mp, int mntflags)
228 {
229 	struct null_mount *xmp;
230 
231 	NULLFSDEBUG("nullfs_unmount: mp = %p\n", (void *)mp);
232 
233 	/*
234 	 * Throw away the null_mount structure
235 	 */
236 	xmp = (void *)mp->mnt_data;
237 	mp->mnt_data = 0;
238 	if (xmp->nullm_rootvp) {
239 		vrele(xmp->nullm_rootvp);
240 		xmp->nullm_rootvp = NULL;
241 	}
242 	kfree(xmp, M_NULLFSMNT);
243 	return 0;
244 }
245 
246 static int
247 nullfs_root(struct mount *mp, struct vnode **vpp)
248 {
249 	struct vnode *vp;
250 	int error;
251 
252 	NULLFSDEBUG("nullfs_root(mp = %p, vp = %p)\n", (void *)mp,
253 	    (void *)MOUNTTONULLMOUNT(mp)->nullm_rootvp);
254 
255 	/*
256 	 * Return locked reference to root.
257 	 */
258 	vp = MOUNTTONULLMOUNT(mp)->nullm_rootvp;
259 	error = vget(vp, LK_EXCLUSIVE | LK_RETRY);
260 	if (error == 0)
261 		*vpp = vp;
262 	return (error);
263 }
264 
265 static int
266 nullfs_quotactl(struct mount *mp, int cmd, uid_t uid, caddr_t arg,
267 		struct ucred *cred)
268 {
269 	return VFS_QUOTACTL(MOUNTTONULLMOUNT(mp)->nullm_vfs, cmd, uid, arg, cred);
270 }
271 
272 static int
273 nullfs_statfs(struct mount *mp, struct statfs *sbp, struct ucred *cred)
274 {
275 	int error;
276 	struct statfs mstat;
277 
278 	NULLFSDEBUG("nullfs_statfs(mp = %p, vp = %p)\n", (void *)mp,
279 	    (void *)MOUNTTONULLMOUNT(mp)->nullm_rootvp);
280 
281 	bzero(&mstat, sizeof(mstat));
282 
283 	error = VFS_STATFS(MOUNTTONULLMOUNT(mp)->nullm_vfs, &mstat, cred);
284 	if (error)
285 		return (error);
286 
287 	/* now copy across the "interesting" information and fake the rest */
288 	sbp->f_type = mstat.f_type;
289 	sbp->f_flags = mstat.f_flags;
290 	sbp->f_bsize = mstat.f_bsize;
291 	sbp->f_iosize = mstat.f_iosize;
292 	sbp->f_blocks = mstat.f_blocks;
293 	sbp->f_bfree = mstat.f_bfree;
294 	sbp->f_bavail = mstat.f_bavail;
295 	sbp->f_files = mstat.f_files;
296 	sbp->f_ffree = mstat.f_ffree;
297 	if (sbp != &mp->mnt_stat) {
298 		bcopy(&mp->mnt_stat.f_fsid, &sbp->f_fsid, sizeof(sbp->f_fsid));
299 		bcopy(mp->mnt_stat.f_mntfromname, sbp->f_mntfromname, MNAMELEN);
300 		bcopy(mp->mnt_stat.f_mntonname, sbp->f_mntonname, MNAMELEN);
301 	}
302 	return (0);
303 }
304 
305 /*
306  * Implement NFS export tracking
307  */
308 static int
309 nullfs_checkexp(struct mount *mp, struct sockaddr *nam, int *extflagsp,
310 		struct ucred **credanonp)
311 {
312 	struct null_mount *xmp = (void *)mp->mnt_data;
313 	struct netcred *np;
314 	int error;
315 
316 	np = vfs_export_lookup(mp, &xmp->export, nam);
317 	if (np) {
318 		*extflagsp = np->netc_exflags;
319 		*credanonp = &np->netc_anon;
320 		error = 0;
321 	} else {
322 		error = EACCES;
323 	}
324 	return(error);
325 #if 0
326 	return VFS_CHECKEXP(MOUNTTONULLMOUNT(mp)->nullm_vfs, nam,
327 		extflagsp, credanonp);
328 #endif
329 }
330 
331 int
332 nullfs_export(struct mount *mp, int op, const struct export_args *export)
333 {
334 	struct null_mount *xmp = (void *)mp->mnt_data;
335 	int error;
336 
337 	switch(op) {
338 	case MOUNTCTL_SET_EXPORT:
339 		error = vfs_export(mp, &xmp->export, export);
340 		break;
341 	default:
342 		error = EOPNOTSUPP;
343 		break;
344 	}
345 	return(error);
346 }
347 
348 /*
349  * Pass through file handle conversion functions.
350  */
351 static int
352 nullfs_vptofh(struct vnode *vp, struct fid *fhp)
353 {
354 	return VFS_VPTOFH(vp, fhp);
355 }
356 
357 /*
358  * Pass through file handle conversion functions.
359  *
360  * NOTE: currently only HAMMER uses rootvp.  HAMMER uses rootvp only
361  * to enforce PFS isolation.
362  */
363 static int
364 nullfs_fhtovp(struct mount *mp, struct vnode *rootvp,
365               struct fid *fhp, struct vnode **vpp)
366 {
367 	struct null_mount *xmp = MOUNTTONULLMOUNT(mp);
368 
369 	return VFS_FHTOVP(xmp->nullm_vfs, xmp->nullm_rootvp, fhp, vpp);
370 }
371 
372 static int
373 nullfs_extattrctl(struct mount *mp, int cmd, struct vnode *vp,
374 		  int attrnamespace, const char *attrname, struct ucred *cred)
375 {
376 	return VFS_EXTATTRCTL(MOUNTTONULLMOUNT(mp)->nullm_vfs, cmd,
377 			      vp, attrnamespace, attrname, cred);
378 }
379 
380 static void
381 nullfs_ncpgen_set(struct mount *mp, struct namecache *ncp)
382 {
383 	struct null_mount *xmp = MOUNTTONULLMOUNT(mp);
384 
385 	VFS_NCPGEN_SET(xmp->nullm_vfs, ncp);
386 }
387 
388 
389 static int
390 nullfs_ncpgen_test(struct mount *mp, struct namecache *ncp)
391 {
392 	struct null_mount *xmp = MOUNTTONULLMOUNT(mp);
393 
394 	return VFS_NCPGEN_TEST(xmp->nullm_vfs, ncp);
395 }
396 
397 
398 static struct vfsops null_vfsops = {
399 	.vfs_mount =   	 	nullfs_mount,
400 	.vfs_unmount =   	nullfs_unmount,
401 	.vfs_root =     	nullfs_root,
402 	.vfs_quotactl =   	nullfs_quotactl,
403 	.vfs_statfs =    	nullfs_statfs,
404 	.vfs_extattrctl =  	nullfs_extattrctl,
405 	.vfs_fhtovp =		nullfs_fhtovp,
406 	.vfs_vptofh =		nullfs_vptofh,
407 	.vfs_ncpgen_set =	nullfs_ncpgen_set,
408 	.vfs_ncpgen_test =	nullfs_ncpgen_test,
409 	.vfs_checkexp =  	nullfs_checkexp
410 };
411 
412 VFS_SET(null_vfsops, null, VFCF_LOOPBACK | VFCF_MPSAFE);
413 MODULE_VERSION(null, 1);
414