xref: /netbsd-src/sys/miscfs/umapfs/umap_vfsops.c (revision 21e37cc72a480a47828990a439cde7ac9ffaf0c6)
1 /*	$NetBSD: umap_vfsops.c,v 1.48 2004/05/29 23:48:08 wrstuden Exp $	*/
2 
3 /*
4  * Copyright (c) 1992, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software donated to Berkeley by
8  * the UCLA Ficus project.
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 University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	from: @(#)null_vfsops.c       1.5 (Berkeley) 7/10/92
35  *	@(#)umap_vfsops.c	8.8 (Berkeley) 5/14/95
36  */
37 
38 /*
39  * Umap Layer
40  * (See mount_umap(8) for a description of this layer.)
41  */
42 
43 #include <sys/cdefs.h>
44 __KERNEL_RCSID(0, "$NetBSD: umap_vfsops.c,v 1.48 2004/05/29 23:48:08 wrstuden Exp $");
45 
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/sysctl.h>
49 #include <sys/proc.h>
50 #include <sys/time.h>
51 #include <sys/vnode.h>
52 #include <sys/mount.h>
53 #include <sys/namei.h>
54 #include <sys/malloc.h>
55 #include <miscfs/umapfs/umap.h>
56 #include <miscfs/genfs/layer_extern.h>
57 
58 int	umapfs_mount __P((struct mount *, const char *, void *,
59 			  struct nameidata *, struct proc *));
60 int	umapfs_unmount __P((struct mount *, int, struct proc *));
61 
62 /*
63  * Mount umap layer
64  */
65 int
66 umapfs_mount(mp, path, data, ndp, p)
67 	struct mount *mp;
68 	const char *path;
69 	void *data;
70 	struct nameidata *ndp;
71 	struct proc *p;
72 {
73 	struct umap_args args;
74 	struct vnode *lowerrootvp, *vp;
75 	struct umap_mount *amp;
76 	int error;
77 #ifdef UMAPFS_DIAGNOSTIC
78 	int i;
79 #endif
80 	if (mp->mnt_flag & MNT_GETARGS) {
81 		amp = MOUNTTOUMAPMOUNT(mp);
82 		if (amp == NULL)
83 			return EIO;
84 		args.la.target = NULL;
85 		vfs_showexport(mp, &args.la.export, &amp->umapm_export);
86 		args.nentries = amp->info_nentries;
87 		args.gnentries = amp->info_gnentries;
88 		return copyout(&args, data, sizeof(args));
89 	}
90 
91 	/* only for root */
92 	if ((error = suser(p->p_ucred, &p->p_acflag)) != 0)
93 		return error;
94 
95 #ifdef UMAPFS_DIAGNOSTIC
96 	printf("umapfs_mount(mp = %p)\n", mp);
97 #endif
98 
99 	/*
100 	 * Get argument
101 	 */
102 	error = copyin(data, &args, sizeof(struct umap_args));
103 	if (error)
104 		return (error);
105 
106 	/*
107 	 * Update only does export updating.
108 	 */
109 	if (mp->mnt_flag & MNT_UPDATE) {
110 		amp = MOUNTTOUMAPMOUNT(mp);
111 		if (args.umap_target == 0)
112 			return (vfs_export(mp, &amp->umapm_export,
113 					&args.umap_export));
114 		else
115 			return (EOPNOTSUPP);
116 	}
117 
118 	/*
119 	 * Find lower node
120 	 */
121 	NDINIT(ndp, LOOKUP, FOLLOW|LOCKLEAF,
122 		UIO_USERSPACE, args.umap_target, p);
123 	if ((error = namei(ndp)) != 0)
124 		return (error);
125 
126 	/*
127 	 * Sanity check on lower vnode
128 	 */
129 	lowerrootvp = ndp->ni_vp;
130 #ifdef UMAPFS_DIAGNOSTIC
131 	printf("vp = %p, check for VDIR...\n", lowerrootvp);
132 #endif
133 
134 	if (lowerrootvp->v_type != VDIR) {
135 		vput(lowerrootvp);
136 		return (EINVAL);
137 	}
138 
139 #ifdef UMAPFS_DIAGNOSTIC
140 	printf("mp = %p\n", mp);
141 #endif
142 
143 	amp = (struct umap_mount *) malloc(sizeof(struct umap_mount),
144 				M_UFSMNT, M_WAITOK);	/* XXX */
145 	memset(amp, 0, sizeof(struct umap_mount));
146 
147 	mp->mnt_data = amp;
148 	amp->umapm_vfs = lowerrootvp->v_mount;
149 	if (amp->umapm_vfs->mnt_flag & MNT_LOCAL)
150 		mp->mnt_flag |= MNT_LOCAL;
151 
152 	/*
153 	 * Now copy in the number of entries and maps for umap mapping.
154 	 */
155 	if (args.nentries > MAPFILEENTRIES || args.gnentries > GMAPFILEENTRIES) {
156 		vput(lowerrootvp);
157 		return (error);
158 	}
159 
160 	amp->info_nentries = args.nentries;
161 	amp->info_gnentries = args.gnentries;
162 	error = copyin(args.mapdata, amp->info_mapdata,
163 	    2*sizeof(u_long)*args.nentries);
164 	if (error) {
165 		vput(lowerrootvp);
166 		return (error);
167 	}
168 
169 #ifdef UMAPFS_DIAGNOSTIC
170 	printf("umap_mount:nentries %d\n",args.nentries);
171 	for (i = 0; i < args.nentries; i++)
172 		printf("   %ld maps to %ld\n", amp->info_mapdata[i][0],
173 	 	    amp->info_mapdata[i][1]);
174 #endif
175 
176 	error = copyin(args.gmapdata, amp->info_gmapdata,
177 	    2*sizeof(u_long)*args.gnentries);
178 	if (error) {
179 		vput(lowerrootvp);
180 		return (error);
181 	}
182 
183 #ifdef UMAPFS_DIAGNOSTIC
184 	printf("umap_mount:gnentries %d\n",args.gnentries);
185 	for (i = 0; i < args.gnentries; i++)
186 		printf("\tgroup %ld maps to %ld\n",
187 		    amp->info_gmapdata[i][0],
188 	 	    amp->info_gmapdata[i][1]);
189 #endif
190 
191 	/*
192 	 * Make sure the mount point's sufficiently initialized
193 	 * that the node create call will work.
194 	 */
195 	vfs_getnewfsid(mp);
196 	amp->umapm_size = sizeof(struct umap_node);
197 	amp->umapm_tag = VT_UMAP;
198 	amp->umapm_bypass = umap_bypass;
199 	amp->umapm_alloc = layer_node_alloc;	/* the default alloc is fine */
200 	amp->umapm_vnodeop_p = umap_vnodeop_p;
201 	simple_lock_init(&amp->umapm_hashlock);
202 	amp->umapm_node_hashtbl = hashinit(NUMAPNODECACHE, HASH_LIST, M_CACHE,
203 	    M_WAITOK, &amp->umapm_node_hash);
204 
205 
206 	/*
207 	 * fix up umap node for root vnode.
208 	 */
209 	error = layer_node_create(mp, lowerrootvp, &vp);
210 	/*
211 	 * Make sure the node alias worked
212 	 */
213 	if (error) {
214 		vput(lowerrootvp);
215 		free(amp, M_UFSMNT);	/* XXX */
216 		return (error);
217 	}
218 	/*
219 	 * Unlock the node (either the lower or the alias)
220 	 */
221 	VOP_UNLOCK(vp, 0);
222 
223 	/*
224 	 * Keep a held reference to the root vnode.
225 	 * It is vrele'd in umapfs_unmount.
226 	 */
227 	vp->v_flag |= VROOT;
228 	amp->umapm_rootvp = vp;
229 
230 	error = set_statvfs_info(path, UIO_USERSPACE, args.umap_target,
231 	    UIO_USERSPACE, mp, p);
232 #ifdef UMAPFS_DIAGNOSTIC
233 	printf("umapfs_mount: lower %s, alias at %s\n",
234 		mp->mnt_stat.f_mntfromname, mp->mnt_stat.f_mntonname);
235 #endif
236 	return error;
237 }
238 
239 /*
240  * Free reference to umap layer
241  */
242 int
243 umapfs_unmount(mp, mntflags, p)
244 	struct mount *mp;
245 	int mntflags;
246 	struct proc *p;
247 {
248 	struct vnode *rootvp = MOUNTTOUMAPMOUNT(mp)->umapm_rootvp;
249 	int error;
250 	int flags = 0;
251 
252 #ifdef UMAPFS_DIAGNOSTIC
253 	printf("umapfs_unmount(mp = %p)\n", mp);
254 #endif
255 
256 	if (mntflags & MNT_FORCE)
257 		flags |= FORCECLOSE;
258 
259 	/*
260 	 * Clear out buffer cache.  I don't think we
261 	 * ever get anything cached at this level at the
262 	 * moment, but who knows...
263 	 */
264 #ifdef notyet
265 	mntflushbuf(mp, 0);
266 	if (mntinvalbuf(mp, 1))
267 		return (EBUSY);
268 #endif
269 	if (rootvp->v_usecount > 1)
270 		return (EBUSY);
271 	if ((error = vflush(mp, rootvp, flags)) != 0)
272 		return (error);
273 
274 #ifdef UMAPFS_DIAGNOSTIC
275 	vprint("alias root of lower", rootvp);
276 #endif
277 	/*
278 	 * Release reference on underlying root vnode
279 	 */
280 	vrele(rootvp);
281 	/*
282 	 * And blow it away for future re-use
283 	 */
284 	vgone(rootvp);
285 	/*
286 	 * Finally, throw away the umap_mount structure
287 	 */
288 	free(mp->mnt_data, M_UFSMNT);	/* XXX */
289 	mp->mnt_data = 0;
290 	return (0);
291 }
292 
293 SYSCTL_SETUP(sysctl_vfs_umap_setup, "sysctl vfs.umap subtree setup")
294 {
295 
296 	sysctl_createv(clog, 0, NULL, NULL,
297 		       CTLFLAG_PERMANENT,
298 		       CTLTYPE_NODE, "vfs", NULL,
299 		       NULL, 0, NULL, 0,
300 		       CTL_VFS, CTL_EOL);
301 	sysctl_createv(clog, 0, NULL, NULL,
302 		       CTLFLAG_PERMANENT,
303 		       CTLTYPE_NODE, "umap",
304 		       SYSCTL_DESCR("UID/GID remapping file system"),
305 		       NULL, 0, NULL, 0,
306 		       CTL_VFS, 10, CTL_EOL);
307 	/*
308 	 * XXX the "10" above could be dynamic, thereby eliminating
309 	 * one more instance of the "number to vfs" mapping problem,
310 	 * but "10" is the order as taken from sys/mount.h
311 	 */
312 }
313 
314 extern const struct vnodeopv_desc umapfs_vnodeop_opv_desc;
315 
316 const struct vnodeopv_desc * const umapfs_vnodeopv_descs[] = {
317 	&umapfs_vnodeop_opv_desc,
318 	NULL,
319 };
320 
321 struct vfsops umapfs_vfsops = {
322 	MOUNT_UMAP,
323 	umapfs_mount,
324 	layerfs_start,
325 	umapfs_unmount,
326 	layerfs_root,
327 	layerfs_quotactl,
328 	layerfs_statvfs,
329 	layerfs_sync,
330 	layerfs_vget,
331 	layerfs_fhtovp,
332 	layerfs_vptofh,
333 	layerfs_init,
334 	NULL,
335 	layerfs_done,
336 	NULL,
337 	NULL,				/* vfs_mountroot */
338 	layerfs_checkexp,
339 	layerfs_snapshot,
340 	umapfs_vnodeopv_descs,
341 };
342