xref: /netbsd-src/sys/miscfs/umapfs/umap_vfsops.c (revision deb6f0161a9109e7de9b519dc8dfb9478668dcdd)
1 /*	$NetBSD: umap_vfsops.c,v 1.99 2017/04/11 07:51:37 hannken 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.99 2017/04/11 07:51:37 hannken 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/kauth.h>
55 #include <sys/module.h>
56 
57 #include <miscfs/umapfs/umap.h>
58 #include <miscfs/genfs/layer_extern.h>
59 
60 MODULE(MODULE_CLASS_VFS, umap, "layerfs");
61 
62 VFS_PROTOS(umapfs);
63 
64 static struct sysctllog *umapfs_sysctl_log;
65 
66 /*
67  * Mount umap layer
68  */
69 int
70 umapfs_mount(struct mount *mp, const char *path, void *data, size_t *data_len)
71 {
72 	struct lwp *l = curlwp;
73 	struct pathbuf *pb;
74 	struct nameidata nd;
75 	struct umap_args *args = data;
76 	struct vnode *lowerrootvp, *vp;
77 	struct umap_mount *amp;
78 	int error;
79 #ifdef UMAPFS_DIAGNOSTIC
80 	int i;
81 #endif
82 
83 	if (args == NULL)
84 		return EINVAL;
85 	if (*data_len < sizeof *args)
86 		return EINVAL;
87 
88 	if (mp->mnt_flag & MNT_GETARGS) {
89 		amp = MOUNTTOUMAPMOUNT(mp);
90 		if (amp == NULL)
91 			return EIO;
92 		args->la.target = NULL;
93 		args->nentries = amp->info_nentries;
94 		args->gnentries = amp->info_gnentries;
95 		*data_len = sizeof *args;
96 		return 0;
97 	}
98 
99 	/* only for root */
100 	error = kauth_authorize_system(l->l_cred, KAUTH_SYSTEM_MOUNT,
101 	    KAUTH_REQ_SYSTEM_MOUNT_UMAP, NULL, NULL, NULL);
102 	if (error)
103 		return error;
104 
105 #ifdef UMAPFS_DIAGNOSTIC
106 	printf("umapfs_mount(mp = %p)\n", mp);
107 #endif
108 
109 	/*
110 	 * Update is not supported
111 	 */
112 	if (mp->mnt_flag & MNT_UPDATE)
113 		return EOPNOTSUPP;
114 
115 	/*
116 	 * Find lower node
117 	 */
118 	error = pathbuf_copyin(args->umap_target, &pb);
119 	if (error) {
120 		return error;
121 	}
122 	NDINIT(&nd, LOOKUP, FOLLOW|LOCKLEAF, pb);
123 	if ((error = namei(&nd)) != 0) {
124 		pathbuf_destroy(pb);
125 		return error;
126 	}
127 
128 	/*
129 	 * Sanity check on lower vnode
130 	 */
131 	lowerrootvp = nd.ni_vp;
132 	pathbuf_destroy(pb);
133 #ifdef UMAPFS_DIAGNOSTIC
134 	printf("vp = %p, check for VDIR...\n", lowerrootvp);
135 #endif
136 
137 	if (lowerrootvp->v_type != VDIR) {
138 		vput(lowerrootvp);
139 		return (EINVAL);
140 	}
141 
142 #ifdef UMAPFS_DIAGNOSTIC
143 	printf("mp = %p\n", mp);
144 #endif
145 
146 	amp = kmem_zalloc(sizeof(struct umap_mount), KM_SLEEP);
147 	mp->mnt_data = amp;
148 
149 	/*
150 	 * Now copy in the number of entries and maps for umap mapping.
151 	 */
152 	if (args->nentries < 0 || args->nentries > MAPFILEENTRIES ||
153 	    args->gnentries < 0 || args->gnentries > GMAPFILEENTRIES) {
154 		vput(lowerrootvp);
155 		return (EINVAL);
156 	}
157 
158 	amp->info_nentries = args->nentries;
159 	amp->info_gnentries = args->gnentries;
160 	error = copyin(args->mapdata, amp->info_mapdata,
161 	    2*sizeof(u_long)*args->nentries);
162 	if (error) {
163 		vput(lowerrootvp);
164 		return (error);
165 	}
166 
167 #ifdef UMAPFS_DIAGNOSTIC
168 	printf("umap_mount:nentries %d\n",args->nentries);
169 	for (i = 0; i < args->nentries; i++)
170 		printf("   %ld maps to %ld\n", amp->info_mapdata[i][0],
171 	 	    amp->info_mapdata[i][1]);
172 #endif
173 
174 	error = copyin(args->gmapdata, amp->info_gmapdata,
175 	    2*sizeof(u_long)*args->gnentries);
176 	if (error) {
177 		vput(lowerrootvp);
178 		return (error);
179 	}
180 
181 #ifdef UMAPFS_DIAGNOSTIC
182 	printf("umap_mount:gnentries %d\n",args->gnentries);
183 	for (i = 0; i < args->gnentries; i++)
184 		printf("\tgroup %ld maps to %ld\n",
185 		    amp->info_gmapdata[i][0],
186 	 	    amp->info_gmapdata[i][1]);
187 #endif
188 
189 	/*
190 	 * Make sure the mount point's sufficiently initialized
191 	 * that the node create call will work.
192 	 */
193 	vfs_getnewfsid(mp);
194 	amp->umapm_size = sizeof(struct umap_node);
195 	amp->umapm_tag = VT_UMAP;
196 	amp->umapm_bypass = umap_bypass;
197 	amp->umapm_vnodeop_p = umap_vnodeop_p;
198 
199 	/*
200 	 * fix up umap node for root vnode.
201 	 */
202 	VOP_UNLOCK(lowerrootvp);
203 	error = layer_node_create(mp, lowerrootvp, &vp);
204 	/*
205 	 * Make sure the node alias worked
206 	 */
207 	if (error) {
208 		vrele(lowerrootvp);
209 		kmem_free(amp, sizeof(struct umap_mount));
210 		return error;
211 	}
212 
213 	/*
214 	 * Keep a held reference to the root vnode.
215 	 * It is vrele'd in umapfs_unmount.
216 	 */
217 	vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
218 	vp->v_vflag |= VV_ROOT;
219 	amp->umapm_rootvp = vp;
220 	VOP_UNLOCK(vp);
221 
222 	error = set_statvfs_info(path, UIO_USERSPACE, args->umap_target,
223 	    UIO_USERSPACE, mp->mnt_op->vfs_name, mp, l);
224 	if (error)
225 		return error;
226 
227 	mp->mnt_lower = lowerrootvp->v_mount;
228 	if (mp->mnt_lower->mnt_flag & MNT_LOCAL)
229 		mp->mnt_flag |= MNT_LOCAL;
230 #ifdef UMAPFS_DIAGNOSTIC
231 	printf("umapfs_mount: lower %s, alias at %s\n",
232 		mp->mnt_stat.f_mntfromname, mp->mnt_stat.f_mntonname);
233 #endif
234 	return 0;
235 }
236 
237 /*
238  * Free reference to umap layer
239  */
240 int
241 umapfs_unmount(struct mount *mp, int mntflags)
242 {
243 	struct umap_mount *amp = MOUNTTOUMAPMOUNT(mp);
244 	struct vnode *rtvp = amp->umapm_rootvp;
245 	int error;
246 	int flags = 0;
247 
248 #ifdef UMAPFS_DIAGNOSTIC
249 	printf("umapfs_unmount(mp = %p)\n", mp);
250 #endif
251 
252 	if (mntflags & MNT_FORCE)
253 		flags |= FORCECLOSE;
254 
255 	if (rtvp->v_usecount > 1 && (mntflags & MNT_FORCE) == 0)
256 		return (EBUSY);
257 	if ((error = vflush(mp, rtvp, flags)) != 0)
258 		return (error);
259 
260 #ifdef UMAPFS_DIAGNOSTIC
261 	vprint("alias root of lower", rtvp);
262 #endif
263 	/*
264 	 * Blow it away for future re-use
265 	 */
266 	vgone(rtvp);
267 	/*
268 	 * Finally, throw away the umap_mount structure
269 	 */
270 	kmem_free(amp, sizeof(struct umap_mount));
271 	mp->mnt_data = NULL;
272 	return 0;
273 }
274 
275 extern const struct vnodeopv_desc umapfs_vnodeop_opv_desc;
276 
277 const struct vnodeopv_desc * const umapfs_vnodeopv_descs[] = {
278 	&umapfs_vnodeop_opv_desc,
279 	NULL,
280 };
281 
282 struct vfsops umapfs_vfsops = {
283 	.vfs_name = MOUNT_UMAP,
284 	.vfs_min_mount_data = sizeof (struct umap_args),
285 	.vfs_mount = umapfs_mount,
286 	.vfs_start = layerfs_start,
287 	.vfs_unmount = umapfs_unmount,
288 	.vfs_root = layerfs_root,
289 	.vfs_quotactl = layerfs_quotactl,
290 	.vfs_statvfs = layerfs_statvfs,
291 	.vfs_sync = layerfs_sync,
292 	.vfs_loadvnode = layerfs_loadvnode,
293 	.vfs_vget = layerfs_vget,
294 	.vfs_fhtovp = layerfs_fhtovp,
295 	.vfs_vptofh = layerfs_vptofh,
296 	.vfs_init = layerfs_init,
297 	.vfs_done = layerfs_done,
298 	.vfs_snapshot = layerfs_snapshot,
299 	.vfs_extattrctl = vfs_stdextattrctl,
300 	.vfs_suspendctl = layerfs_suspendctl,
301 	.vfs_renamelock_enter = layerfs_renamelock_enter,
302 	.vfs_renamelock_exit = layerfs_renamelock_exit,
303 	.vfs_fsync = (void *)eopnotsupp,
304 	.vfs_opv_descs = umapfs_vnodeopv_descs
305 };
306 
307 static int
308 umap_modcmd(modcmd_t cmd, void *arg)
309 {
310 	int error;
311 
312 	switch (cmd) {
313 	case MODULE_CMD_INIT:
314 		error = vfs_attach(&umapfs_vfsops);
315 		if (error != 0)
316 			break;
317 		sysctl_createv(&umapfs_sysctl_log, 0, NULL, NULL,
318 			       CTLFLAG_PERMANENT,
319 			       CTLTYPE_NODE, "umap",
320 			       SYSCTL_DESCR("UID/GID remapping file system"),
321 			       NULL, 0, NULL, 0,
322 			       CTL_VFS, 10, CTL_EOL);
323 		/*
324 		 * XXX the "10" above could be dynamic, thereby eliminating
325 		 * one more instance of the "number to vfs" mapping problem,
326 		 * but "10" is the order as taken from sys/mount.h
327 		 */
328 		break;
329 	case MODULE_CMD_FINI:
330 		error = vfs_detach(&umapfs_vfsops);
331 		if (error != 0)
332 			break;
333 		sysctl_teardown(&umapfs_sysctl_log);
334 		break;
335 	default:
336 		error = ENOTTY;
337 		break;
338 	}
339 
340 	return (error);
341 }
342