xref: /freebsd/sys/kern/vfs_mount.c (revision 32cf4514cad66ff69ffc96ede20d8debc9b96790)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1999-2004 Poul-Henning Kamp
5  * Copyright (c) 1999 Michael Smith
6  * Copyright (c) 1989, 1993
7  *	The Regents of the University of California.  All rights reserved.
8  * (c) UNIX System Laboratories, Inc.
9  * All or some portions of this file are derived from material licensed
10  * to the University of California by American Telephone and Telegraph
11  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
12  * the permission of UNIX System Laboratories, Inc.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  * 2. Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the distribution.
22  * 3. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  */
38 
39 #include <sys/param.h>
40 #include <sys/conf.h>
41 #include <sys/smp.h>
42 #include <sys/devctl.h>
43 #include <sys/eventhandler.h>
44 #include <sys/fcntl.h>
45 #include <sys/jail.h>
46 #include <sys/kernel.h>
47 #include <sys/ktr.h>
48 #include <sys/libkern.h>
49 #include <sys/limits.h>
50 #include <sys/malloc.h>
51 #include <sys/mount.h>
52 #include <sys/mutex.h>
53 #include <sys/namei.h>
54 #include <sys/priv.h>
55 #include <sys/proc.h>
56 #include <sys/filedesc.h>
57 #include <sys/reboot.h>
58 #include <sys/sbuf.h>
59 #include <sys/stdarg.h>
60 #include <sys/syscallsubr.h>
61 #include <sys/sysproto.h>
62 #include <sys/sx.h>
63 #include <sys/sysctl.h>
64 #include <sys/systm.h>
65 #include <sys/taskqueue.h>
66 #include <sys/vnode.h>
67 #include <vm/uma.h>
68 
69 #include <geom/geom.h>
70 
71 #include <security/audit/audit.h>
72 #include <security/mac/mac_framework.h>
73 
74 #define	VFS_MOUNTARG_SIZE_MAX	(1024 * 64)
75 
76 static int	vfs_domount(struct thread *td, const char *fstype, char *fspath,
77 		    uint64_t fsflags, bool only_export, bool jail_export,
78 		    struct vfsoptlist **optlist);
79 static void	free_mntarg(struct mntarg *ma);
80 
81 static int	usermount = 0;
82 SYSCTL_INT(_vfs, OID_AUTO, usermount, CTLFLAG_RW, &usermount, 0,
83     "Unprivileged users may mount and unmount file systems");
84 
85 static bool	default_autoro = false;
86 SYSCTL_BOOL(_vfs, OID_AUTO, default_autoro, CTLFLAG_RW, &default_autoro, 0,
87     "Retry failed r/w mount as r/o if no explicit ro/rw option is specified");
88 
89 static bool	recursive_forced_unmount = false;
90 SYSCTL_BOOL(_vfs, OID_AUTO, recursive_forced_unmount, CTLFLAG_RW,
91     &recursive_forced_unmount, 0, "Recursively unmount stacked upper mounts"
92     " when a file system is forcibly unmounted");
93 
94 static SYSCTL_NODE(_vfs, OID_AUTO, deferred_unmount,
95     CTLFLAG_RD | CTLFLAG_MPSAFE, 0, "deferred unmount controls");
96 
97 static unsigned int	deferred_unmount_retry_limit = 10;
98 SYSCTL_UINT(_vfs_deferred_unmount, OID_AUTO, retry_limit, CTLFLAG_RW,
99     &deferred_unmount_retry_limit, 0,
100     "Maximum number of retries for deferred unmount failure");
101 
102 static int	deferred_unmount_retry_delay_hz;
103 SYSCTL_INT(_vfs_deferred_unmount, OID_AUTO, retry_delay_hz, CTLFLAG_RW,
104     &deferred_unmount_retry_delay_hz, 0,
105     "Delay in units of [1/kern.hz]s when retrying a failed deferred unmount");
106 
107 static int	deferred_unmount_total_retries = 0;
108 SYSCTL_INT(_vfs_deferred_unmount, OID_AUTO, total_retries, CTLFLAG_RD,
109     &deferred_unmount_total_retries, 0,
110     "Total number of retried deferred unmounts");
111 
112 MALLOC_DEFINE(M_MOUNT, "mount", "vfs mount structure");
113 MALLOC_DEFINE(M_STATFS, "statfs", "statfs structure");
114 static uma_zone_t mount_zone;
115 
116 /* List of mounted filesystems. */
117 struct mntlist mountlist = TAILQ_HEAD_INITIALIZER(mountlist);
118 
119 /* For any iteration/modification of mountlist */
120 struct mtx_padalign __exclusive_cache_line mountlist_mtx;
121 
122 EVENTHANDLER_LIST_DEFINE(vfs_mounted);
123 EVENTHANDLER_LIST_DEFINE(vfs_unmounted);
124 
125 static void vfs_deferred_unmount(void *arg, int pending);
126 static struct timeout_task deferred_unmount_task;
127 static struct mtx deferred_unmount_lock;
128 MTX_SYSINIT(deferred_unmount, &deferred_unmount_lock, "deferred_unmount",
129     MTX_DEF);
130 static STAILQ_HEAD(, mount) deferred_unmount_list =
131     STAILQ_HEAD_INITIALIZER(deferred_unmount_list);
132 TASKQUEUE_DEFINE_THREAD(deferred_unmount);
133 
134 static void mount_devctl_event(const char *type, struct mount *mp, bool donew);
135 
136 /*
137  * Global opts, taken by all filesystems
138  */
139 static const char *global_opts[] = {
140 	"errmsg",
141 	"fstype",
142 	"fspath",
143 	"ro",
144 	"rw",
145 	"nosuid",
146 	"noexec",
147 	NULL
148 };
149 
150 static int
mount_init(void * mem,int size,int flags)151 mount_init(void *mem, int size, int flags)
152 {
153 	struct mount *mp;
154 
155 	mp = (struct mount *)mem;
156 	mtx_init(&mp->mnt_mtx, "struct mount mtx", NULL, MTX_DEF);
157 	mtx_init(&mp->mnt_listmtx, "struct mount vlist mtx", NULL, MTX_DEF);
158 	lockinit(&mp->mnt_explock, PVFS, "explock", 0, 0);
159 	lockinit(&mp->mnt_renamelock, PVFS, "rename", 0, 0);
160 	mp->mnt_pcpu = uma_zalloc_pcpu(pcpu_zone_16, M_WAITOK | M_ZERO);
161 	mp->mnt_ref = 0;
162 	mp->mnt_vfs_ops = 1;
163 	mp->mnt_rootvnode = NULL;
164 	return (0);
165 }
166 
167 static void
mount_fini(void * mem,int size)168 mount_fini(void *mem, int size)
169 {
170 	struct mount *mp;
171 
172 	mp = (struct mount *)mem;
173 	uma_zfree_pcpu(pcpu_zone_16, mp->mnt_pcpu);
174 	lockdestroy(&mp->mnt_renamelock);
175 	lockdestroy(&mp->mnt_explock);
176 	mtx_destroy(&mp->mnt_listmtx);
177 	mtx_destroy(&mp->mnt_mtx);
178 }
179 
180 static void
vfs_mount_init(void * dummy __unused)181 vfs_mount_init(void *dummy __unused)
182 {
183 	TIMEOUT_TASK_INIT(taskqueue_deferred_unmount, &deferred_unmount_task,
184 	    0, vfs_deferred_unmount, NULL);
185 	deferred_unmount_retry_delay_hz = hz;
186 	mount_zone = uma_zcreate("Mountpoints", sizeof(struct mount), NULL,
187 	    NULL, mount_init, mount_fini, UMA_ALIGN_CACHE, UMA_ZONE_NOFREE);
188 	mtx_init(&mountlist_mtx, "mountlist", NULL, MTX_DEF);
189 }
190 SYSINIT(vfs_mount, SI_SUB_VFS, SI_ORDER_ANY, vfs_mount_init, NULL);
191 
192 /*
193  * ---------------------------------------------------------------------
194  * Functions for building and sanitizing the mount options
195  */
196 
197 /* Remove one mount option. */
198 static void
vfs_freeopt(struct vfsoptlist * opts,struct vfsopt * opt)199 vfs_freeopt(struct vfsoptlist *opts, struct vfsopt *opt)
200 {
201 
202 	TAILQ_REMOVE(opts, opt, link);
203 	free(opt->name, M_MOUNT);
204 	if (opt->value != NULL)
205 		free(opt->value, M_MOUNT);
206 	free(opt, M_MOUNT);
207 }
208 
209 /* Release all resources related to the mount options. */
210 void
vfs_freeopts(struct vfsoptlist * opts)211 vfs_freeopts(struct vfsoptlist *opts)
212 {
213 	struct vfsopt *opt;
214 
215 	while (!TAILQ_EMPTY(opts)) {
216 		opt = TAILQ_FIRST(opts);
217 		vfs_freeopt(opts, opt);
218 	}
219 	free(opts, M_MOUNT);
220 }
221 
222 void
vfs_deleteopt(struct vfsoptlist * opts,const char * name)223 vfs_deleteopt(struct vfsoptlist *opts, const char *name)
224 {
225 	struct vfsopt *opt, *temp;
226 
227 	if (opts == NULL)
228 		return;
229 	TAILQ_FOREACH_SAFE(opt, opts, link, temp)  {
230 		if (strcmp(opt->name, name) == 0)
231 			vfs_freeopt(opts, opt);
232 	}
233 }
234 
235 static int
vfs_isopt_ro(const char * opt)236 vfs_isopt_ro(const char *opt)
237 {
238 
239 	if (strcmp(opt, "ro") == 0 || strcmp(opt, "rdonly") == 0 ||
240 	    strcmp(opt, "norw") == 0)
241 		return (1);
242 	return (0);
243 }
244 
245 static int
vfs_isopt_rw(const char * opt)246 vfs_isopt_rw(const char *opt)
247 {
248 
249 	if (strcmp(opt, "rw") == 0 || strcmp(opt, "noro") == 0)
250 		return (1);
251 	return (0);
252 }
253 
254 /*
255  * Check if options are equal (with or without the "no" prefix).
256  */
257 static int
vfs_equalopts(const char * opt1,const char * opt2)258 vfs_equalopts(const char *opt1, const char *opt2)
259 {
260 	char *p;
261 
262 	/* "opt" vs. "opt" or "noopt" vs. "noopt" */
263 	if (strcmp(opt1, opt2) == 0)
264 		return (1);
265 	/* "noopt" vs. "opt" */
266 	if (strncmp(opt1, "no", 2) == 0 && strcmp(opt1 + 2, opt2) == 0)
267 		return (1);
268 	/* "opt" vs. "noopt" */
269 	if (strncmp(opt2, "no", 2) == 0 && strcmp(opt1, opt2 + 2) == 0)
270 		return (1);
271 	while ((p = strchr(opt1, '.')) != NULL &&
272 	    !strncmp(opt1, opt2, ++p - opt1)) {
273 		opt2 += p - opt1;
274 		opt1 = p;
275 		/* "foo.noopt" vs. "foo.opt" */
276 		if (strncmp(opt1, "no", 2) == 0 && strcmp(opt1 + 2, opt2) == 0)
277 			return (1);
278 		/* "foo.opt" vs. "foo.noopt" */
279 		if (strncmp(opt2, "no", 2) == 0 && strcmp(opt1, opt2 + 2) == 0)
280 			return (1);
281 	}
282 	/* "ro" / "rdonly" / "norw" / "rw" / "noro" */
283 	if ((vfs_isopt_ro(opt1) || vfs_isopt_rw(opt1)) &&
284 	    (vfs_isopt_ro(opt2) || vfs_isopt_rw(opt2)))
285 		return (1);
286 	return (0);
287 }
288 
289 /*
290  * If a mount option is specified several times,
291  * (with or without the "no" prefix) only keep
292  * the last occurrence of it.
293  */
294 static void
vfs_sanitizeopts(struct vfsoptlist * opts)295 vfs_sanitizeopts(struct vfsoptlist *opts)
296 {
297 	struct vfsopt *opt, *opt2, *tmp;
298 
299 	TAILQ_FOREACH_REVERSE(opt, opts, vfsoptlist, link) {
300 		opt2 = TAILQ_PREV(opt, vfsoptlist, link);
301 		while (opt2 != NULL) {
302 			if (vfs_equalopts(opt->name, opt2->name)) {
303 				tmp = TAILQ_PREV(opt2, vfsoptlist, link);
304 				vfs_freeopt(opts, opt2);
305 				opt2 = tmp;
306 			} else {
307 				opt2 = TAILQ_PREV(opt2, vfsoptlist, link);
308 			}
309 		}
310 	}
311 }
312 
313 /*
314  * Build a linked list of mount options from a struct uio.
315  */
316 int
vfs_buildopts(struct uio * auio,struct vfsoptlist ** options)317 vfs_buildopts(struct uio *auio, struct vfsoptlist **options)
318 {
319 	struct vfsoptlist *opts;
320 	struct vfsopt *opt;
321 	size_t memused, namelen, optlen;
322 	unsigned int i, iovcnt;
323 	int error;
324 
325 	opts = malloc(sizeof(struct vfsoptlist), M_MOUNT, M_WAITOK);
326 	TAILQ_INIT(opts);
327 	memused = 0;
328 	iovcnt = auio->uio_iovcnt;
329 	for (i = 0; i < iovcnt; i += 2) {
330 		namelen = auio->uio_iov[i].iov_len;
331 		optlen = auio->uio_iov[i + 1].iov_len;
332 		memused += sizeof(struct vfsopt) + optlen + namelen;
333 		/*
334 		 * Avoid consuming too much memory, and attempts to overflow
335 		 * memused.
336 		 */
337 		if (memused > VFS_MOUNTARG_SIZE_MAX ||
338 		    optlen > VFS_MOUNTARG_SIZE_MAX ||
339 		    namelen > VFS_MOUNTARG_SIZE_MAX) {
340 			error = EINVAL;
341 			goto bad;
342 		}
343 
344 		opt = malloc(sizeof(struct vfsopt), M_MOUNT, M_WAITOK);
345 		opt->name = malloc(namelen, M_MOUNT, M_WAITOK);
346 		opt->value = NULL;
347 		opt->len = 0;
348 		opt->pos = i / 2;
349 		opt->seen = 0;
350 
351 		/*
352 		 * Do this early, so jumps to "bad" will free the current
353 		 * option.
354 		 */
355 		TAILQ_INSERT_TAIL(opts, opt, link);
356 
357 		if (auio->uio_segflg == UIO_SYSSPACE) {
358 			bcopy(auio->uio_iov[i].iov_base, opt->name, namelen);
359 		} else {
360 			error = copyin(auio->uio_iov[i].iov_base, opt->name,
361 			    namelen);
362 			if (error)
363 				goto bad;
364 		}
365 		/* Ensure names are null-terminated strings. */
366 		if (namelen == 0 || opt->name[namelen - 1] != '\0') {
367 			error = EINVAL;
368 			goto bad;
369 		}
370 		if (optlen != 0) {
371 			opt->len = optlen;
372 			opt->value = malloc(optlen, M_MOUNT, M_WAITOK);
373 			if (auio->uio_segflg == UIO_SYSSPACE) {
374 				bcopy(auio->uio_iov[i + 1].iov_base, opt->value,
375 				    optlen);
376 			} else {
377 				error = copyin(auio->uio_iov[i + 1].iov_base,
378 				    opt->value, optlen);
379 				if (error)
380 					goto bad;
381 			}
382 		}
383 	}
384 	vfs_sanitizeopts(opts);
385 	*options = opts;
386 	return (0);
387 bad:
388 	vfs_freeopts(opts);
389 	return (error);
390 }
391 
392 /*
393  * Merge the old mount options with the new ones passed
394  * in the MNT_UPDATE case.
395  *
396  * XXX: This function will keep a "nofoo" option in the new
397  * options.  E.g, if the option's canonical name is "foo",
398  * "nofoo" ends up in the mount point's active options.
399  */
400 static void
vfs_mergeopts(struct vfsoptlist * toopts,struct vfsoptlist * oldopts)401 vfs_mergeopts(struct vfsoptlist *toopts, struct vfsoptlist *oldopts)
402 {
403 	struct vfsopt *opt, *new;
404 
405 	TAILQ_FOREACH(opt, oldopts, link) {
406 		new = malloc(sizeof(struct vfsopt), M_MOUNT, M_WAITOK);
407 		new->name = strdup(opt->name, M_MOUNT);
408 		if (opt->len != 0) {
409 			new->value = malloc(opt->len, M_MOUNT, M_WAITOK);
410 			bcopy(opt->value, new->value, opt->len);
411 		} else
412 			new->value = NULL;
413 		new->len = opt->len;
414 		new->seen = opt->seen;
415 		TAILQ_INSERT_HEAD(toopts, new, link);
416 	}
417 	vfs_sanitizeopts(toopts);
418 }
419 
420 /*
421  * Mount a filesystem.
422  */
423 #ifndef _SYS_SYSPROTO_H_
424 struct nmount_args {
425 	struct iovec *iovp;
426 	unsigned int iovcnt;
427 	int flags;
428 };
429 #endif
430 int
sys_nmount(struct thread * td,struct nmount_args * uap)431 sys_nmount(struct thread *td, struct nmount_args *uap)
432 {
433 	struct uio *auio;
434 	int error;
435 	u_int iovcnt;
436 	uint64_t flags;
437 
438 	/*
439 	 * Mount flags are now 64-bits. On 32-bit archtectures only
440 	 * 32-bits are passed in, but from here on everything handles
441 	 * 64-bit flags correctly.
442 	 */
443 	flags = uap->flags;
444 
445 	AUDIT_ARG_FFLAGS(flags);
446 	CTR4(KTR_VFS, "%s: iovp %p with iovcnt %d and flags %d", __func__,
447 	    uap->iovp, uap->iovcnt, flags);
448 
449 	/*
450 	 * Filter out MNT_ROOTFS.  We do not want clients of nmount() in
451 	 * userspace to set this flag, but we must filter it out if we want
452 	 * MNT_UPDATE on the root file system to work.
453 	 * MNT_ROOTFS should only be set by the kernel when mounting its
454 	 * root file system.
455 	 */
456 	flags &= ~MNT_ROOTFS;
457 
458 	iovcnt = uap->iovcnt;
459 	/*
460 	 * Check that we have an even number of iovec's
461 	 * and that we have at least two options.
462 	 */
463 	if ((iovcnt & 1) || (iovcnt < 4)) {
464 		CTR2(KTR_VFS, "%s: failed for invalid iovcnt %d", __func__,
465 		    uap->iovcnt);
466 		return (EINVAL);
467 	}
468 
469 	error = copyinuio(uap->iovp, iovcnt, &auio);
470 	if (error) {
471 		CTR2(KTR_VFS, "%s: failed for invalid uio op with %d errno",
472 		    __func__, error);
473 		return (error);
474 	}
475 	error = vfs_donmount(td, flags, auio);
476 
477 	freeuio(auio);
478 	return (error);
479 }
480 
481 /*
482  * ---------------------------------------------------------------------
483  * Various utility functions
484  */
485 
486 /*
487  * Get a reference on a mount point from a vnode.
488  *
489  * The vnode is allowed to be passed unlocked and race against dooming. Note in
490  * such case there are no guarantees the referenced mount point will still be
491  * associated with it after the function returns.
492  */
493 struct mount *
vfs_ref_from_vp(struct vnode * vp)494 vfs_ref_from_vp(struct vnode *vp)
495 {
496 	struct mount *mp;
497 	struct mount_pcpu *mpcpu;
498 
499 	mp = atomic_load_ptr(&vp->v_mount);
500 	if (__predict_false(mp == NULL)) {
501 		return (mp);
502 	}
503 	if (vfs_op_thread_enter(mp, &mpcpu)) {
504 		if (__predict_true(mp == vp->v_mount)) {
505 			vfs_mp_count_add_pcpu(mpcpu, ref, 1);
506 			vfs_op_thread_exit(mp, mpcpu);
507 		} else {
508 			vfs_op_thread_exit(mp, mpcpu);
509 			mp = NULL;
510 		}
511 	} else {
512 		MNT_ILOCK(mp);
513 		if (mp == vp->v_mount) {
514 			MNT_REF(mp);
515 			MNT_IUNLOCK(mp);
516 		} else {
517 			MNT_IUNLOCK(mp);
518 			mp = NULL;
519 		}
520 	}
521 	return (mp);
522 }
523 
524 void
vfs_ref(struct mount * mp)525 vfs_ref(struct mount *mp)
526 {
527 	struct mount_pcpu *mpcpu;
528 
529 	CTR2(KTR_VFS, "%s: mp %p", __func__, mp);
530 	if (vfs_op_thread_enter(mp, &mpcpu)) {
531 		vfs_mp_count_add_pcpu(mpcpu, ref, 1);
532 		vfs_op_thread_exit(mp, mpcpu);
533 		return;
534 	}
535 
536 	MNT_ILOCK(mp);
537 	MNT_REF(mp);
538 	MNT_IUNLOCK(mp);
539 }
540 
541 /*
542  * Register ump as an upper mount of the mount associated with
543  * vnode vp.  This registration will be tracked through
544  * mount_upper_node upper, which should be allocated by the
545  * caller and stored in per-mount data associated with mp.
546  *
547  * If successful, this function will return the mount associated
548  * with vp, and will ensure that it cannot be unmounted until
549  * ump has been unregistered as one of its upper mounts.
550  *
551  * Upon failure this function will return NULL.
552  */
553 struct mount *
vfs_register_upper_from_vp(struct vnode * vp,struct mount * ump,struct mount_upper_node * upper)554 vfs_register_upper_from_vp(struct vnode *vp, struct mount *ump,
555     struct mount_upper_node *upper)
556 {
557 	struct mount *mp;
558 
559 	mp = atomic_load_ptr(&vp->v_mount);
560 	if (mp == NULL)
561 		return (NULL);
562 	MNT_ILOCK(mp);
563 	if (mp != vp->v_mount ||
564 	    ((mp->mnt_kern_flag & (MNTK_UNMOUNT | MNTK_RECURSE)) != 0)) {
565 		MNT_IUNLOCK(mp);
566 		return (NULL);
567 	}
568 	KASSERT(ump != mp, ("upper and lower mounts are identical"));
569 	upper->mp = ump;
570 	MNT_REF(mp);
571 	TAILQ_INSERT_TAIL(&mp->mnt_uppers, upper, mnt_upper_link);
572 	MNT_IUNLOCK(mp);
573 	return (mp);
574 }
575 
576 /*
577  * Register upper mount ump to receive vnode unlink/reclaim
578  * notifications from lower mount mp. This registration will
579  * be tracked through mount_upper_node upper, which should be
580  * allocated by the caller and stored in per-mount data
581  * associated with mp.
582  *
583  * ump must already be registered as an upper mount of mp
584  * through a call to vfs_register_upper_from_vp().
585  */
586 void
vfs_register_for_notification(struct mount * mp,struct mount * ump,struct mount_upper_node * upper)587 vfs_register_for_notification(struct mount *mp, struct mount *ump,
588     struct mount_upper_node *upper)
589 {
590 	upper->mp = ump;
591 	MNT_ILOCK(mp);
592 	TAILQ_INSERT_TAIL(&mp->mnt_notify, upper, mnt_upper_link);
593 	MNT_IUNLOCK(mp);
594 }
595 
596 static void
vfs_drain_upper_locked(struct mount * mp)597 vfs_drain_upper_locked(struct mount *mp)
598 {
599 	mtx_assert(MNT_MTX(mp), MA_OWNED);
600 	while (mp->mnt_upper_pending != 0) {
601 		mp->mnt_kern_flag |= MNTK_UPPER_WAITER;
602 		msleep(&mp->mnt_uppers, MNT_MTX(mp), 0, "mntupw", 0);
603 	}
604 }
605 
606 /*
607  * Undo a previous call to vfs_register_for_notification().
608  * The mount represented by upper must be currently registered
609  * as an upper mount for mp.
610  */
611 void
vfs_unregister_for_notification(struct mount * mp,struct mount_upper_node * upper)612 vfs_unregister_for_notification(struct mount *mp,
613     struct mount_upper_node *upper)
614 {
615 	MNT_ILOCK(mp);
616 	vfs_drain_upper_locked(mp);
617 	TAILQ_REMOVE(&mp->mnt_notify, upper, mnt_upper_link);
618 	MNT_IUNLOCK(mp);
619 }
620 
621 /*
622  * Undo a previous call to vfs_register_upper_from_vp().
623  * This must be done before mp can be unmounted.
624  */
625 void
vfs_unregister_upper(struct mount * mp,struct mount_upper_node * upper)626 vfs_unregister_upper(struct mount *mp, struct mount_upper_node *upper)
627 {
628 	MNT_ILOCK(mp);
629 	KASSERT((mp->mnt_kern_flag & MNTK_UNMOUNT) == 0,
630 	    ("registered upper with pending unmount"));
631 	vfs_drain_upper_locked(mp);
632 	TAILQ_REMOVE(&mp->mnt_uppers, upper, mnt_upper_link);
633 	if ((mp->mnt_kern_flag & MNTK_TASKQUEUE_WAITER) != 0 &&
634 	    TAILQ_EMPTY(&mp->mnt_uppers)) {
635 		mp->mnt_kern_flag &= ~MNTK_TASKQUEUE_WAITER;
636 		wakeup(&mp->mnt_taskqueue_link);
637 	}
638 	MNT_REL(mp);
639 	MNT_IUNLOCK(mp);
640 }
641 
642 void
vfs_rel(struct mount * mp)643 vfs_rel(struct mount *mp)
644 {
645 	struct mount_pcpu *mpcpu;
646 
647 	CTR2(KTR_VFS, "%s: mp %p", __func__, mp);
648 	if (vfs_op_thread_enter(mp, &mpcpu)) {
649 		vfs_mp_count_sub_pcpu(mpcpu, ref, 1);
650 		vfs_op_thread_exit(mp, mpcpu);
651 		return;
652 	}
653 
654 	MNT_ILOCK(mp);
655 	MNT_REL(mp);
656 	MNT_IUNLOCK(mp);
657 }
658 
659 /*
660  * Allocate and initialize the mount point struct.
661  */
662 struct mount *
vfs_mount_alloc(struct vnode * vp,struct vfsconf * vfsp,const char * fspath,struct ucred * cred)663 vfs_mount_alloc(struct vnode *vp, struct vfsconf *vfsp, const char *fspath,
664     struct ucred *cred)
665 {
666 	struct mount *mp;
667 
668 	mp = uma_zalloc(mount_zone, M_WAITOK);
669 	bzero(&mp->mnt_startzero,
670 	    __rangeof(struct mount, mnt_startzero, mnt_endzero));
671 	mp->mnt_kern_flag = 0;
672 	mp->mnt_flag = 0;
673 	mp->mnt_rootvnode = NULL;
674 	mp->mnt_vnodecovered = NULL;
675 	mp->mnt_op = NULL;
676 	mp->mnt_vfc = NULL;
677 	TAILQ_INIT(&mp->mnt_nvnodelist);
678 	mp->mnt_nvnodelistsize = 0;
679 	TAILQ_INIT(&mp->mnt_lazyvnodelist);
680 	mp->mnt_lazyvnodelistsize = 0;
681 	MPPASS(mp->mnt_ref == 0 && mp->mnt_lockref == 0 &&
682 	    mp->mnt_writeopcount == 0, mp);
683 	MPASSERT(mp->mnt_vfs_ops == 1, mp,
684 	    ("vfs_ops should be 1 but %d found", mp->mnt_vfs_ops));
685 	(void) vfs_busy(mp, MBF_NOWAIT);
686 	mp->mnt_op = vfsp->vfc_vfsops;
687 	mp->mnt_vfc = vfsp;
688 	mp->mnt_stat.f_type = vfsp->vfc_typenum;
689 	mp->mnt_gen++;
690 	strlcpy(mp->mnt_stat.f_fstypename, vfsp->vfc_name, MFSNAMELEN);
691 	mp->mnt_vnodecovered = vp;
692 	mp->mnt_cred = crdup(cred);
693 	mp->mnt_stat.f_owner = cred->cr_uid;
694 	strlcpy(mp->mnt_stat.f_mntonname, fspath, MNAMELEN);
695 	mp->mnt_iosize_max = DFLTPHYS;
696 #ifdef MAC
697 	mac_mount_init(mp);
698 	mac_mount_create(cred, mp);
699 #endif
700 	arc4rand(&mp->mnt_hashseed, sizeof mp->mnt_hashseed, 0);
701 	mp->mnt_upper_pending = 0;
702 	TAILQ_INIT(&mp->mnt_uppers);
703 	TAILQ_INIT(&mp->mnt_notify);
704 	mp->mnt_taskqueue_flags = 0;
705 	mp->mnt_unmount_retries = 0;
706 	return (mp);
707 }
708 
709 /*
710  * Destroy the mount struct previously allocated by vfs_mount_alloc().
711  */
712 void
vfs_mount_destroy(struct mount * mp)713 vfs_mount_destroy(struct mount *mp)
714 {
715 
716 	MPPASS(mp->mnt_vfs_ops != 0, mp);
717 
718 	vfs_assert_mount_counters(mp);
719 
720 	MNT_ILOCK(mp);
721 	mp->mnt_kern_flag |= MNTK_REFEXPIRE;
722 	if (mp->mnt_kern_flag & MNTK_MWAIT) {
723 		mp->mnt_kern_flag &= ~MNTK_MWAIT;
724 		wakeup(mp);
725 	}
726 	while (mp->mnt_ref)
727 		msleep(mp, MNT_MTX(mp), PVFS, "mntref", 0);
728 	KASSERT(mp->mnt_ref == 0,
729 	    ("%s: invalid refcount in the drain path @ %s:%d", __func__,
730 	    __FILE__, __LINE__));
731 	MPPASS(mp->mnt_writeopcount == 0, mp);
732 	MPPASS(mp->mnt_secondary_writes == 0, mp);
733 	if (!TAILQ_EMPTY(&mp->mnt_nvnodelist)) {
734 		struct vnode *vp;
735 
736 		TAILQ_FOREACH(vp, &mp->mnt_nvnodelist, v_nmntvnodes)
737 			vn_printf(vp, "dangling vnode ");
738 		panic("unmount: dangling vnode");
739 	}
740 	KASSERT(mp->mnt_upper_pending == 0, ("mnt_upper_pending"));
741 	KASSERT(TAILQ_EMPTY(&mp->mnt_uppers), ("mnt_uppers"));
742 	KASSERT(TAILQ_EMPTY(&mp->mnt_notify), ("mnt_notify"));
743 	MPPASS(mp->mnt_nvnodelistsize == 0, mp);
744 	MPPASS(mp->mnt_lazyvnodelistsize == 0, mp);
745 	MPPASS(mp->mnt_lockref == 0, mp);
746 	MNT_IUNLOCK(mp);
747 
748 	MPASSERT(mp->mnt_vfs_ops == 1, mp,
749 	    ("vfs_ops should be 1 but %d found", mp->mnt_vfs_ops));
750 
751 	MPASSERT(mp->mnt_rootvnode == NULL, mp,
752 	    ("mount point still has a root vnode %p", mp->mnt_rootvnode));
753 
754 	if (mp->mnt_vnodecovered != NULL)
755 		vrele(mp->mnt_vnodecovered);
756 #ifdef MAC
757 	mac_mount_destroy(mp);
758 #endif
759 	if (mp->mnt_opt != NULL)
760 		vfs_freeopts(mp->mnt_opt);
761 	if (mp->mnt_exjail != NULL) {
762 		atomic_subtract_int(&mp->mnt_exjail->cr_prison->pr_exportcnt,
763 		    1);
764 		crfree(mp->mnt_exjail);
765 	}
766 	if (mp->mnt_export != NULL) {
767 		vfs_free_addrlist(mp->mnt_export);
768 		free(mp->mnt_export, M_MOUNT);
769 	}
770 	vfsconf_lock();
771 	mp->mnt_vfc->vfc_refcount--;
772 	vfsconf_unlock();
773 	crfree(mp->mnt_cred);
774 	uma_zfree(mount_zone, mp);
775 }
776 
777 static bool
vfs_should_downgrade_to_ro_mount(uint64_t fsflags,int error)778 vfs_should_downgrade_to_ro_mount(uint64_t fsflags, int error)
779 {
780 	/* This is an upgrade of an exisiting mount. */
781 	if ((fsflags & MNT_UPDATE) != 0)
782 		return (false);
783 	/* This is already an R/O mount. */
784 	if ((fsflags & MNT_RDONLY) != 0)
785 		return (false);
786 
787 	switch (error) {
788 	case ENODEV:	/* generic, geom, ... */
789 	case EACCES:	/* cam/scsi, ... */
790 	case EROFS:	/* md, mmcsd, ... */
791 		/*
792 		 * These errors can be returned by the storage layer to signal
793 		 * that the media is read-only.  No harm in the R/O mount
794 		 * attempt if the error was returned for some other reason.
795 		 */
796 		return (true);
797 	default:
798 		return (false);
799 	}
800 }
801 
802 int
vfs_donmount(struct thread * td,uint64_t fsflags,struct uio * fsoptions)803 vfs_donmount(struct thread *td, uint64_t fsflags, struct uio *fsoptions)
804 {
805 	struct vfsoptlist *optlist;
806 	struct vfsopt *opt, *tmp_opt;
807 	char *fstype, *fspath, *errmsg;
808 	int error, fstypelen, fspathlen, errmsg_len, errmsg_pos;
809 	bool autoro, has_nonexport, only_export, jail_export;
810 
811 	errmsg = fspath = NULL;
812 	errmsg_len = fspathlen = 0;
813 	errmsg_pos = -1;
814 	autoro = default_autoro;
815 
816 	error = vfs_buildopts(fsoptions, &optlist);
817 	if (error)
818 		return (error);
819 
820 	if (vfs_getopt(optlist, "errmsg", (void **)&errmsg, &errmsg_len) == 0)
821 		errmsg_pos = vfs_getopt_pos(optlist, "errmsg");
822 
823 	/*
824 	 * We need these two options before the others,
825 	 * and they are mandatory for any filesystem.
826 	 * Ensure they are NUL terminated as well.
827 	 */
828 	fstypelen = 0;
829 	error = vfs_getopt(optlist, "fstype", (void **)&fstype, &fstypelen);
830 	if (error || fstypelen <= 0 || fstype[fstypelen - 1] != '\0') {
831 		error = EINVAL;
832 		if (errmsg != NULL)
833 			strncpy(errmsg, "Invalid fstype", errmsg_len);
834 		goto bail;
835 	}
836 	fspathlen = 0;
837 	error = vfs_getopt(optlist, "fspath", (void **)&fspath, &fspathlen);
838 	if (error || fspathlen <= 0 || fspath[fspathlen - 1] != '\0') {
839 		error = EINVAL;
840 		if (errmsg != NULL)
841 			strncpy(errmsg, "Invalid fspath", errmsg_len);
842 		goto bail;
843 	}
844 
845 	/*
846 	 * Check to see that "export" is only used with the "update", "fstype",
847 	 * "fspath", "from" and "errmsg" options when in a vnet jail.
848 	 * These are the ones used to set/update exports by mountd(8).
849 	 * If only the above options are set in a jail that can run mountd(8),
850 	 * then the jail_export argument of vfs_domount() will be true.
851 	 * When jail_export is true, the vfs_suser() check does not cause
852 	 * failure, but limits the update to exports only.
853 	 * This allows mountd(8) running within the vnet jail
854 	 * to export file systems visible within the jail, but
855 	 * mounted outside of the jail.
856 	 */
857 	/*
858 	 * We need to see if we have the "update" option
859 	 * before we call vfs_domount(), since vfs_domount() has special
860 	 * logic based on MNT_UPDATE.  This is very important
861 	 * when we want to update the root filesystem.
862 	 */
863 	has_nonexport = false;
864 	only_export = false;
865 	TAILQ_FOREACH_SAFE(opt, optlist, link, tmp_opt) {
866 		int do_freeopt = 0;
867 
868 		if (strcmp(opt->name, "export") != 0 &&
869 		    strcmp(opt->name, "update") != 0 &&
870 		    strcmp(opt->name, "fstype") != 0 &&
871 		    strcmp(opt->name, "fspath") != 0 &&
872 		    strcmp(opt->name, "from") != 0 &&
873 		    strcmp(opt->name, "errmsg") != 0)
874 			has_nonexport = true;
875 		if (strcmp(opt->name, "update") == 0) {
876 			fsflags |= MNT_UPDATE;
877 			do_freeopt = 1;
878 		}
879 		else if (strcmp(opt->name, "async") == 0)
880 			fsflags |= MNT_ASYNC;
881 		else if (strcmp(opt->name, "force") == 0) {
882 			fsflags |= MNT_FORCE;
883 			do_freeopt = 1;
884 		}
885 		else if (strcmp(opt->name, "reload") == 0) {
886 			fsflags |= MNT_RELOAD;
887 			do_freeopt = 1;
888 		}
889 		else if (strcmp(opt->name, "multilabel") == 0)
890 			fsflags |= MNT_MULTILABEL;
891 		else if (strcmp(opt->name, "noasync") == 0)
892 			fsflags &= ~MNT_ASYNC;
893 		else if (strcmp(opt->name, "noatime") == 0)
894 			fsflags |= MNT_NOATIME;
895 		else if (strcmp(opt->name, "atime") == 0) {
896 			free(opt->name, M_MOUNT);
897 			opt->name = strdup("nonoatime", M_MOUNT);
898 		}
899 		else if (strcmp(opt->name, "noclusterr") == 0)
900 			fsflags |= MNT_NOCLUSTERR;
901 		else if (strcmp(opt->name, "clusterr") == 0) {
902 			free(opt->name, M_MOUNT);
903 			opt->name = strdup("nonoclusterr", M_MOUNT);
904 		}
905 		else if (strcmp(opt->name, "noclusterw") == 0)
906 			fsflags |= MNT_NOCLUSTERW;
907 		else if (strcmp(opt->name, "clusterw") == 0) {
908 			free(opt->name, M_MOUNT);
909 			opt->name = strdup("nonoclusterw", M_MOUNT);
910 		}
911 		else if (strcmp(opt->name, "noexec") == 0)
912 			fsflags |= MNT_NOEXEC;
913 		else if (strcmp(opt->name, "exec") == 0) {
914 			free(opt->name, M_MOUNT);
915 			opt->name = strdup("nonoexec", M_MOUNT);
916 		}
917 		else if (strcmp(opt->name, "nosuid") == 0)
918 			fsflags |= MNT_NOSUID;
919 		else if (strcmp(opt->name, "suid") == 0) {
920 			free(opt->name, M_MOUNT);
921 			opt->name = strdup("nonosuid", M_MOUNT);
922 		}
923 		else if (strcmp(opt->name, "nosymfollow") == 0)
924 			fsflags |= MNT_NOSYMFOLLOW;
925 		else if (strcmp(opt->name, "symfollow") == 0) {
926 			free(opt->name, M_MOUNT);
927 			opt->name = strdup("nonosymfollow", M_MOUNT);
928 		}
929 		else if (strcmp(opt->name, "noro") == 0) {
930 			fsflags &= ~MNT_RDONLY;
931 			autoro = false;
932 		}
933 		else if (strcmp(opt->name, "rw") == 0) {
934 			fsflags &= ~MNT_RDONLY;
935 			autoro = false;
936 		}
937 		else if (strcmp(opt->name, "ro") == 0) {
938 			fsflags |= MNT_RDONLY;
939 			autoro = false;
940 		}
941 		else if (strcmp(opt->name, "rdonly") == 0) {
942 			free(opt->name, M_MOUNT);
943 			opt->name = strdup("ro", M_MOUNT);
944 			fsflags |= MNT_RDONLY;
945 			autoro = false;
946 		}
947 		else if (strcmp(opt->name, "autoro") == 0) {
948 			do_freeopt = 1;
949 			autoro = true;
950 		}
951 		else if (strcmp(opt->name, "suiddir") == 0)
952 			fsflags |= MNT_SUIDDIR;
953 		else if (strcmp(opt->name, "sync") == 0)
954 			fsflags |= MNT_SYNCHRONOUS;
955 		else if (strcmp(opt->name, "union") == 0)
956 			fsflags |= MNT_UNION;
957 		else if (strcmp(opt->name, "export") == 0) {
958 			fsflags |= MNT_EXPORTED;
959 			only_export = true;
960 		} else if (strcmp(opt->name, "automounted") == 0) {
961 			fsflags |= MNT_AUTOMOUNTED;
962 			do_freeopt = 1;
963 		} else if (strcmp(opt->name, "nocover") == 0) {
964 			fsflags |= MNT_NOCOVER;
965 			do_freeopt = 1;
966 		} else if (strcmp(opt->name, "cover") == 0) {
967 			fsflags &= ~MNT_NOCOVER;
968 			do_freeopt = 1;
969 		} else if (strcmp(opt->name, "emptydir") == 0) {
970 			fsflags |= MNT_EMPTYDIR;
971 			do_freeopt = 1;
972 		} else if (strcmp(opt->name, "noemptydir") == 0) {
973 			fsflags &= ~MNT_EMPTYDIR;
974 			do_freeopt = 1;
975 		}
976 		if (do_freeopt)
977 			vfs_freeopt(optlist, opt);
978 	}
979 
980 	/*
981 	 * Be ultra-paranoid about making sure the type and fspath
982 	 * variables will fit in our mp buffers, including the
983 	 * terminating NUL.
984 	 */
985 	if (fstypelen > MFSNAMELEN || fspathlen > MNAMELEN) {
986 		error = ENAMETOOLONG;
987 		goto bail;
988 	}
989 
990 	/*
991 	 * only_export is set to true only if exports are being
992 	 * updated and nothing else is being updated.
993 	 */
994 	if (has_nonexport)
995 		only_export = false;
996 	/*
997 	 * If only_export is true and the caller is running within a
998 	 * vnet prison that can run mountd(8), set jail_export true.
999 	 */
1000 	jail_export = false;
1001 	if (only_export && jailed(td->td_ucred) &&
1002 	    prison_check_nfsd(td->td_ucred))
1003 		jail_export = true;
1004 
1005 	error = vfs_domount(td, fstype, fspath, fsflags, only_export,
1006 	    jail_export, &optlist);
1007 	if (error == ENODEV) {
1008 		error = EINVAL;
1009 		if (errmsg != NULL)
1010 			strncpy(errmsg, "Invalid fstype", errmsg_len);
1011 		goto bail;
1012 	}
1013 
1014 	/*
1015 	 * See if we can mount in the read-only mode if the error code suggests
1016 	 * that it could be possible and the mount options allow for that.
1017 	 * Never try it if "[no]{ro|rw}" has been explicitly requested and not
1018 	 * overridden by "autoro".
1019 	 */
1020 	if (autoro && vfs_should_downgrade_to_ro_mount(fsflags, error)) {
1021 		printf("%s: R/W mount failed, possibly R/O media,"
1022 		    " trying R/O mount\n", __func__);
1023 		fsflags |= MNT_RDONLY;
1024 		error = vfs_domount(td, fstype, fspath, fsflags, only_export,
1025 		    jail_export, &optlist);
1026 	}
1027 bail:
1028 	/* copyout the errmsg */
1029 	if (errmsg_pos != -1 && ((2 * errmsg_pos + 1) < fsoptions->uio_iovcnt)
1030 	    && errmsg_len > 0 && errmsg != NULL) {
1031 		if (fsoptions->uio_segflg == UIO_SYSSPACE) {
1032 			bcopy(errmsg,
1033 			    fsoptions->uio_iov[2 * errmsg_pos + 1].iov_base,
1034 			    fsoptions->uio_iov[2 * errmsg_pos + 1].iov_len);
1035 		} else {
1036 			(void)copyout(errmsg,
1037 			    fsoptions->uio_iov[2 * errmsg_pos + 1].iov_base,
1038 			    fsoptions->uio_iov[2 * errmsg_pos + 1].iov_len);
1039 		}
1040 	}
1041 
1042 	if (optlist != NULL)
1043 		vfs_freeopts(optlist);
1044 	return (error);
1045 }
1046 
1047 /*
1048  * Old mount API.
1049  */
1050 #ifndef _SYS_SYSPROTO_H_
1051 struct mount_args {
1052 	char	*type;
1053 	char	*path;
1054 	int	flags;
1055 	caddr_t	data;
1056 };
1057 #endif
1058 /* ARGSUSED */
1059 int
sys_mount(struct thread * td,struct mount_args * uap)1060 sys_mount(struct thread *td, struct mount_args *uap)
1061 {
1062 	char *fstype;
1063 	struct vfsconf *vfsp = NULL;
1064 	struct mntarg *ma = NULL;
1065 	uint64_t flags;
1066 	int error;
1067 
1068 	/*
1069 	 * Mount flags are now 64-bits. On 32-bit architectures only
1070 	 * 32-bits are passed in, but from here on everything handles
1071 	 * 64-bit flags correctly.
1072 	 */
1073 	flags = uap->flags;
1074 
1075 	AUDIT_ARG_FFLAGS(flags);
1076 
1077 	/*
1078 	 * Filter out MNT_ROOTFS.  We do not want clients of mount() in
1079 	 * userspace to set this flag, but we must filter it out if we want
1080 	 * MNT_UPDATE on the root file system to work.
1081 	 * MNT_ROOTFS should only be set by the kernel when mounting its
1082 	 * root file system.
1083 	 */
1084 	flags &= ~MNT_ROOTFS;
1085 
1086 	fstype = malloc(MFSNAMELEN, M_TEMP, M_WAITOK);
1087 	error = copyinstr(uap->type, fstype, MFSNAMELEN, NULL);
1088 	if (error) {
1089 		free(fstype, M_TEMP);
1090 		return (error);
1091 	}
1092 
1093 	AUDIT_ARG_TEXT(fstype);
1094 	vfsp = vfs_byname_kld(fstype, td, &error);
1095 	free(fstype, M_TEMP);
1096 	if (vfsp == NULL)
1097 		return (EINVAL);
1098 	if (((vfsp->vfc_flags & VFCF_SBDRY) != 0 &&
1099 	    vfsp->vfc_vfsops_sd->vfs_cmount == NULL) ||
1100 	    ((vfsp->vfc_flags & VFCF_SBDRY) == 0 &&
1101 	    vfsp->vfc_vfsops->vfs_cmount == NULL))
1102 		return (EOPNOTSUPP);
1103 
1104 	ma = mount_argsu(ma, "fstype", uap->type, MFSNAMELEN);
1105 	ma = mount_argsu(ma, "fspath", uap->path, MNAMELEN);
1106 	ma = mount_argb(ma, flags & MNT_RDONLY, "noro");
1107 	ma = mount_argb(ma, !(flags & MNT_NOSUID), "nosuid");
1108 	ma = mount_argb(ma, !(flags & MNT_NOEXEC), "noexec");
1109 
1110 	if ((vfsp->vfc_flags & VFCF_SBDRY) != 0)
1111 		return (vfsp->vfc_vfsops_sd->vfs_cmount(ma, uap->data, flags));
1112 	return (vfsp->vfc_vfsops->vfs_cmount(ma, uap->data, flags));
1113 }
1114 
1115 /*
1116  * vfs_domount_first(): first file system mount (not update)
1117  */
1118 static int
vfs_domount_first(struct thread * td,struct vfsconf * vfsp,char * fspath,struct vnode * vp,uint64_t fsflags,struct vfsoptlist ** optlist)1119 vfs_domount_first(
1120 	struct thread *td,		/* Calling thread. */
1121 	struct vfsconf *vfsp,		/* File system type. */
1122 	char *fspath,			/* Mount path. */
1123 	struct vnode *vp,		/* Vnode to be covered. */
1124 	uint64_t fsflags,		/* Flags common to all filesystems. */
1125 	struct vfsoptlist **optlist	/* Options local to the filesystem. */
1126 	)
1127 {
1128 	struct vattr va;
1129 	struct mount *mp;
1130 	struct vnode *newdp, *rootvp;
1131 	int error, error1;
1132 	bool unmounted;
1133 
1134 	ASSERT_VOP_ELOCKED(vp, __func__);
1135 	KASSERT((fsflags & MNT_UPDATE) == 0, ("MNT_UPDATE shouldn't be here"));
1136 
1137 	/*
1138 	 * If the jail of the calling thread lacks permission for this type of
1139 	 * file system, or is trying to cover its own root, deny immediately.
1140 	 */
1141 	if (jailed(td->td_ucred) && (!prison_allow(td->td_ucred,
1142 	    vfsp->vfc_prison_flag) || vp == td->td_ucred->cr_prison->pr_root)) {
1143 		vput(vp);
1144 		vfs_unref_vfsconf(vfsp);
1145 		return (EPERM);
1146 	}
1147 
1148 	/*
1149 	 * If the user is not root, ensure that they own the directory
1150 	 * onto which we are attempting to mount.
1151 	 */
1152 	error = VOP_GETATTR(vp, &va, td->td_ucred);
1153 	if (error == 0 && va.va_uid != td->td_ucred->cr_uid)
1154 		error = priv_check_cred(td->td_ucred, PRIV_VFS_ADMIN);
1155 #ifdef MAC
1156 	/*
1157 	 * XXX XNU also has a check_mount_late variant, which takes the
1158 	 * struct mount instead and gives MAC visibility into, e.g.,
1159 	 * f_mntfromname and other facts.
1160 	 */
1161 	if (error == 0) {
1162 		error = mac_mount_check_mount(td->td_ucred, vp, vfsp,
1163 		    optlist, fsflags);
1164 	}
1165 #endif
1166 	if (error == 0)
1167 		error = vinvalbuf(vp, V_SAVE, 0, 0);
1168 	if (vfsp->vfc_flags & VFCF_FILEMOUNT) {
1169 		if (error == 0 && vp->v_type != VDIR && vp->v_type != VREG)
1170 			error = EINVAL;
1171 		/*
1172 		 * For file mounts, ensure that there is only one hardlink to the file.
1173 		 */
1174 		if (error == 0 && vp->v_type == VREG && va.va_nlink != 1)
1175 			error = EINVAL;
1176 	} else {
1177 		if (error == 0 && vp->v_type != VDIR)
1178 			error = ENOTDIR;
1179 	}
1180 	if (error == 0 && (fsflags & MNT_EMPTYDIR) != 0)
1181 		error = vn_dir_check_empty(vp);
1182 	if (error == 0) {
1183 		VI_LOCK(vp);
1184 		if ((vp->v_iflag & VI_MOUNT) == 0 && vp->v_mountedhere == NULL)
1185 			vp->v_iflag |= VI_MOUNT;
1186 		else
1187 			error = EBUSY;
1188 		VI_UNLOCK(vp);
1189 	}
1190 	if (error != 0) {
1191 		vput(vp);
1192 		vfs_unref_vfsconf(vfsp);
1193 		return (error);
1194 	}
1195 	vn_seqc_write_begin(vp);
1196 	VOP_UNLOCK(vp);
1197 
1198 	/* Allocate and initialize the filesystem. */
1199 	mp = vfs_mount_alloc(vp, vfsp, fspath, td->td_ucred);
1200 	/* XXXMAC: pass to vfs_mount_alloc? */
1201 	mp->mnt_optnew = *optlist;
1202 	/* Set the mount level flags. */
1203 	mp->mnt_flag = (fsflags &
1204 	    (MNT_UPDATEMASK | MNT_ROOTFS | MNT_RDONLY | MNT_FORCE));
1205 
1206 	/*
1207 	 * Mount the filesystem.
1208 	 * XXX The final recipients of VFS_MOUNT just overwrite the ndp they
1209 	 * get.  No freeing of cn_pnbuf.
1210 	 */
1211 	error1 = 0;
1212 	unmounted = true;
1213 	if ((error = VFS_MOUNT(mp)) != 0 ||
1214 	    (error1 = VFS_STATFS(mp, &mp->mnt_stat)) != 0 ||
1215 	    (error1 = VFS_ROOT(mp, LK_EXCLUSIVE, &newdp)) != 0) {
1216 		rootvp = NULL;
1217 		if (error1 != 0) {
1218 			MPASS(error == 0);
1219 			rootvp = vfs_cache_root_clear(mp);
1220 			if (rootvp != NULL) {
1221 				vhold(rootvp);
1222 				vrele(rootvp);
1223 			}
1224 			(void)vn_start_write(NULL, &mp, V_WAIT);
1225 			MNT_ILOCK(mp);
1226 			mp->mnt_kern_flag |= MNTK_UNMOUNT | MNTK_UNMOUNTF;
1227 			MNT_IUNLOCK(mp);
1228 			VFS_PURGE(mp);
1229 			error = VFS_UNMOUNT(mp, 0);
1230 			vn_finished_write(mp);
1231 			if (error != 0) {
1232 				printf(
1233 		    "failed post-mount (%d): rollback unmount returned %d\n",
1234 				    error1, error);
1235 				unmounted = false;
1236 			}
1237 			error = error1;
1238 		}
1239 		vfs_unbusy(mp);
1240 		mp->mnt_vnodecovered = NULL;
1241 		if (unmounted) {
1242 			/* XXXKIB wait for mnt_lockref drain? */
1243 			vfs_mount_destroy(mp);
1244 		}
1245 		VI_LOCK(vp);
1246 		vp->v_iflag &= ~VI_MOUNT;
1247 		VI_UNLOCK(vp);
1248 		if (rootvp != NULL) {
1249 			vn_seqc_write_end(rootvp);
1250 			vdrop(rootvp);
1251 		}
1252 		vn_seqc_write_end(vp);
1253 		vrele(vp);
1254 		return (error);
1255 	}
1256 	vn_seqc_write_begin(newdp);
1257 	VOP_UNLOCK(newdp);
1258 
1259 	if (mp->mnt_opt != NULL)
1260 		vfs_freeopts(mp->mnt_opt);
1261 	mp->mnt_opt = mp->mnt_optnew;
1262 	*optlist = NULL;
1263 
1264 	/*
1265 	 * Prevent external consumers of mount options from reading mnt_optnew.
1266 	 */
1267 	mp->mnt_optnew = NULL;
1268 
1269 	MNT_ILOCK(mp);
1270 	if ((mp->mnt_flag & MNT_ASYNC) != 0 &&
1271 	    (mp->mnt_kern_flag & MNTK_NOASYNC) == 0)
1272 		mp->mnt_kern_flag |= MNTK_ASYNC;
1273 	else
1274 		mp->mnt_kern_flag &= ~MNTK_ASYNC;
1275 	MNT_IUNLOCK(mp);
1276 
1277 	/*
1278 	 * VIRF_MOUNTPOINT and v_mountedhere need to be set under the
1279 	 * vp lock to satisfy vfs_lookup() requirements.
1280 	 */
1281 	VOP_LOCK(vp, LK_EXCLUSIVE | LK_RETRY);
1282 	VI_LOCK(vp);
1283 	vn_irflag_set_locked(vp, VIRF_MOUNTPOINT);
1284 	vp->v_mountedhere = mp;
1285 	VI_UNLOCK(vp);
1286 	VOP_UNLOCK(vp);
1287 	cache_purge(vp);
1288 
1289 	/*
1290 	 * We need to lock both vnodes.
1291 	 *
1292 	 * Use vn_lock_pair to avoid establishing an ordering between vnodes
1293 	 * from different filesystems.
1294 	 */
1295 	vn_lock_pair(vp, false, LK_EXCLUSIVE, newdp, false, LK_EXCLUSIVE);
1296 
1297 	VI_LOCK(vp);
1298 	vp->v_iflag &= ~VI_MOUNT;
1299 	VI_UNLOCK(vp);
1300 	/* Place the new filesystem at the end of the mount list. */
1301 	mtx_lock(&mountlist_mtx);
1302 	TAILQ_INSERT_TAIL(&mountlist, mp, mnt_list);
1303 	mtx_unlock(&mountlist_mtx);
1304 	vfs_event_signal(NULL, VQ_MOUNT, 0);
1305 	VOP_UNLOCK(vp);
1306 	EVENTHANDLER_DIRECT_INVOKE(vfs_mounted, mp, newdp, td);
1307 	VOP_UNLOCK(newdp);
1308 	mount_devctl_event("MOUNT", mp, false);
1309 	mountcheckdirs(vp, newdp);
1310 	vn_seqc_write_end(vp);
1311 	vn_seqc_write_end(newdp);
1312 	vrele(newdp);
1313 	if ((mp->mnt_flag & MNT_RDONLY) == 0)
1314 		vfs_allocate_syncvnode(mp);
1315 	vfs_op_exit(mp);
1316 	vfs_unbusy(mp);
1317 	return (0);
1318 }
1319 
1320 /*
1321  * vfs_domount_update(): update of mounted file system
1322  */
1323 static int
vfs_domount_update(struct thread * td,struct vnode * vp,uint64_t fsflags,bool only_export,bool jail_export,struct vfsoptlist ** optlist)1324 vfs_domount_update(
1325 	struct thread *td,		/* Calling thread. */
1326 	struct vnode *vp,		/* Mount point vnode. */
1327 	uint64_t fsflags,		/* Flags common to all filesystems. */
1328 	bool only_export,		/* Got export option. */
1329 	bool jail_export,		/* Got export option in vnet prison. */
1330 	struct vfsoptlist **optlist	/* Options local to the filesystem. */
1331 	)
1332 {
1333 	struct export_args export;
1334 	struct o2export_args o2export;
1335 	struct vnode *rootvp;
1336 	void *bufp;
1337 	struct mount *mp;
1338 	int error, export_error, i, len, fsid_up_len;
1339 	uint64_t flag, mnt_union;
1340 	gid_t *grps;
1341 	fsid_t *fsid_up;
1342 	bool vfs_suser_failed;
1343 
1344 	ASSERT_VOP_ELOCKED(vp, __func__);
1345 	KASSERT((fsflags & MNT_UPDATE) != 0, ("MNT_UPDATE should be here"));
1346 	mp = vp->v_mount;
1347 
1348 	if ((vp->v_vflag & VV_ROOT) == 0) {
1349 		if (vfs_copyopt(*optlist, "export", &export, sizeof(export))
1350 		    == 0)
1351 			error = EXDEV;
1352 		else
1353 			error = EINVAL;
1354 		vput(vp);
1355 		return (error);
1356 	}
1357 
1358 	/*
1359 	 * We only allow the filesystem to be reloaded if it
1360 	 * is currently mounted read-only.
1361 	 */
1362 	flag = mp->mnt_flag;
1363 	if ((fsflags & MNT_RELOAD) != 0 && (flag & MNT_RDONLY) == 0) {
1364 		vput(vp);
1365 		return (EOPNOTSUPP);	/* Needs translation */
1366 	}
1367 	/*
1368 	 * Only privileged root, or (if MNT_USER is set) the user that
1369 	 * did the original mount is permitted to update it.
1370 	 */
1371 	/*
1372 	 * For the case of mountd(8) doing exports in a jail, the vfs_suser()
1373 	 * call does not cause failure.  vfs_domount() has already checked
1374 	 * that "root" is doing this and vfs_suser() will fail when
1375 	 * the file system has been mounted outside the jail.
1376 	 * jail_export set true indicates that "export" is not mixed
1377 	 * with other options that change mount behaviour.
1378 	 */
1379 	vfs_suser_failed = false;
1380 	error = vfs_suser(mp, td);
1381 	if (jail_export && error != 0) {
1382 		error = 0;
1383 		vfs_suser_failed = true;
1384 	}
1385 #ifdef MAC
1386 	if (error == 0) {
1387 		error = mac_mount_check_update(td->td_ucred, mp, optlist,
1388 		    fsflags);
1389 	}
1390 #endif
1391 	if (error != 0) {
1392 		vput(vp);
1393 		return (error);
1394 	}
1395 	if (vfs_busy(mp, MBF_NOWAIT)) {
1396 		vput(vp);
1397 		return (EBUSY);
1398 	}
1399 	VI_LOCK(vp);
1400 	if ((vp->v_iflag & VI_MOUNT) != 0 || vp->v_mountedhere != NULL) {
1401 		VI_UNLOCK(vp);
1402 		vfs_unbusy(mp);
1403 		vput(vp);
1404 		return (EBUSY);
1405 	}
1406 	vp->v_iflag |= VI_MOUNT;
1407 	VI_UNLOCK(vp);
1408 	VOP_UNLOCK(vp);
1409 
1410 	rootvp = NULL;
1411 	vfs_op_enter(mp);
1412 	vn_seqc_write_begin(vp);
1413 
1414 	if (vfs_getopt(*optlist, "fsid", (void **)&fsid_up,
1415 	    &fsid_up_len) == 0) {
1416 		if (fsid_up_len != sizeof(*fsid_up)) {
1417 			error = EINVAL;
1418 			goto end;
1419 		}
1420 		if (fsidcmp(fsid_up, &mp->mnt_stat.f_fsid) != 0) {
1421 			error = ENOENT;
1422 			goto end;
1423 		}
1424 		vfs_deleteopt(*optlist, "fsid");
1425 	}
1426 
1427 	mnt_union = 0;
1428 	MNT_ILOCK(mp);
1429 	if ((mp->mnt_kern_flag & MNTK_UNMOUNT) != 0) {
1430 		MNT_IUNLOCK(mp);
1431 		error = EBUSY;
1432 		goto end;
1433 	}
1434 	if (vfs_suser_failed) {
1435 		KASSERT((fsflags & (MNT_EXPORTED | MNT_UPDATE)) ==
1436 		    (MNT_EXPORTED | MNT_UPDATE),
1437 		    ("%s: jailed export did not set expected fsflags",
1438 		     __func__));
1439 		/*
1440 		 * For this case, only MNT_UPDATE and
1441 		 * MNT_EXPORTED have been set in fsflags
1442 		 * by the options.  Only set MNT_UPDATE,
1443 		 * since that is the one that would be set
1444 		 * when set in fsflags, below.
1445 		 */
1446 		mp->mnt_flag |= MNT_UPDATE;
1447 	} else {
1448 		mp->mnt_flag &= ~MNT_UPDATEMASK;
1449 		if ((mp->mnt_flag & MNT_UNION) == 0 &&
1450 		    (fsflags & MNT_UNION) != 0) {
1451 			fsflags &= ~MNT_UNION;
1452 			mnt_union = MNT_UNION;
1453 		}
1454 		mp->mnt_flag |= fsflags & (MNT_RELOAD | MNT_FORCE | MNT_UPDATE |
1455 		    MNT_SNAPSHOT | MNT_ROOTFS | MNT_UPDATEMASK | MNT_RDONLY);
1456 		if ((mp->mnt_flag & MNT_ASYNC) == 0)
1457 			mp->mnt_kern_flag &= ~MNTK_ASYNC;
1458 	}
1459 	rootvp = vfs_cache_root_clear(mp);
1460 	MNT_IUNLOCK(mp);
1461 	mp->mnt_optnew = *optlist;
1462 	vfs_mergeopts(mp->mnt_optnew, mp->mnt_opt);
1463 
1464 	/*
1465 	 * Mount the filesystem.
1466 	 * XXX The final recipients of VFS_MOUNT just overwrite the ndp they
1467 	 * get.  No freeing of cn_pnbuf.
1468 	 */
1469 	/*
1470 	 * When only updating mount exports, VFS_MOUNT() does not need to
1471 	 * be called, as indicated by only_export being set true.
1472 	 * For the case of mountd(8) doing exports from within a vnet jail,
1473 	 * "from" is typically not set correctly such that VFS_MOUNT() will
1474 	 * return ENOENT. For ZFS, there is a locking bug which can result in
1475 	 * deadlock if VFS_MOUNT() is called when extended attributes are
1476 	 * being updated.
1477 	 */
1478 	error = 0;
1479 	if (!only_export)
1480 		error = VFS_MOUNT(mp);
1481 
1482 	export_error = 0;
1483 	/* Process the export option. */
1484 	if (error == 0 && vfs_getopt(mp->mnt_optnew, "export", &bufp,
1485 	    &len) == 0) {
1486 		/* Assume that there is only 1 ABI for each length. */
1487 		switch (len) {
1488 		case (sizeof(struct oexport_args)):
1489 			bzero(&o2export, sizeof(o2export));
1490 			/* FALLTHROUGH */
1491 		case (sizeof(o2export)):
1492 			bcopy(bufp, &o2export, len);
1493 			export.ex_flags = (uint64_t)o2export.ex_flags;
1494 			export.ex_root = o2export.ex_root;
1495 			export.ex_uid = o2export.ex_anon.cr_uid;
1496 			export.ex_groups = NULL;
1497 			export.ex_ngroups = o2export.ex_anon.cr_ngroups;
1498 			if (export.ex_ngroups > 0) {
1499 				if (export.ex_ngroups <= XU_NGROUPS) {
1500 					export.ex_groups = malloc(
1501 					    export.ex_ngroups * sizeof(gid_t),
1502 					    M_TEMP, M_WAITOK);
1503 					for (i = 0; i < export.ex_ngroups; i++)
1504 						export.ex_groups[i] =
1505 						  o2export.ex_anon.cr_groups[i];
1506 				} else
1507 					export_error = EINVAL;
1508 			} else if (export.ex_ngroups < 0)
1509 				export_error = EINVAL;
1510 			export.ex_addr = o2export.ex_addr;
1511 			export.ex_addrlen = o2export.ex_addrlen;
1512 			export.ex_mask = o2export.ex_mask;
1513 			export.ex_masklen = o2export.ex_masklen;
1514 			export.ex_indexfile = o2export.ex_indexfile;
1515 			export.ex_numsecflavors = o2export.ex_numsecflavors;
1516 			if (export.ex_numsecflavors < MAXSECFLAVORS) {
1517 				for (i = 0; i < export.ex_numsecflavors; i++)
1518 					export.ex_secflavors[i] =
1519 					    o2export.ex_secflavors[i];
1520 			} else
1521 				export_error = EINVAL;
1522 			if (export_error == 0)
1523 				export_error = vfs_export(mp, &export, true);
1524 			free(export.ex_groups, M_TEMP);
1525 			break;
1526 		case (sizeof(export)):
1527 			bcopy(bufp, &export, len);
1528 			grps = NULL;
1529 			if (export.ex_ngroups > 0) {
1530 				if (export.ex_ngroups <= ngroups_max + 1) {
1531 					grps = malloc(export.ex_ngroups *
1532 					    sizeof(gid_t), M_TEMP, M_WAITOK);
1533 					export_error = copyin(export.ex_groups,
1534 					    grps, export.ex_ngroups *
1535 					    sizeof(gid_t));
1536 					if (export_error == 0)
1537 						export.ex_groups = grps;
1538 				} else
1539 					export_error = EINVAL;
1540 			} else if (export.ex_ngroups == 0)
1541 				export.ex_groups = NULL;
1542 			else
1543 				export_error = EINVAL;
1544 			if (export_error == 0)
1545 				export_error = vfs_export(mp, &export, true);
1546 			free(grps, M_TEMP);
1547 			break;
1548 		default:
1549 			export_error = EINVAL;
1550 			break;
1551 		}
1552 	}
1553 
1554 	MNT_ILOCK(mp);
1555 	if (error == 0) {
1556 		mp->mnt_flag &= ~(MNT_UPDATE | MNT_RELOAD | MNT_FORCE |
1557 		    MNT_SNAPSHOT);
1558 		mp->mnt_flag |= mnt_union;
1559 	} else {
1560 		/*
1561 		 * If we fail, restore old mount flags. MNT_QUOTA is special,
1562 		 * because it is not part of MNT_UPDATEMASK, but it could have
1563 		 * changed in the meantime if quotactl(2) was called.
1564 		 * All in all we want current value of MNT_QUOTA, not the old
1565 		 * one.
1566 		 */
1567 		mp->mnt_flag = (mp->mnt_flag & MNT_QUOTA) | (flag & ~MNT_QUOTA);
1568 	}
1569 	if ((mp->mnt_flag & MNT_ASYNC) != 0 &&
1570 	    (mp->mnt_kern_flag & MNTK_NOASYNC) == 0)
1571 		mp->mnt_kern_flag |= MNTK_ASYNC;
1572 	else
1573 		mp->mnt_kern_flag &= ~MNTK_ASYNC;
1574 	MNT_IUNLOCK(mp);
1575 
1576 	if (error != 0)
1577 		goto end;
1578 
1579 	mount_devctl_event("REMOUNT", mp, true);
1580 	if (mp->mnt_opt != NULL)
1581 		vfs_freeopts(mp->mnt_opt);
1582 	mp->mnt_opt = mp->mnt_optnew;
1583 	*optlist = NULL;
1584 	(void)VFS_STATFS(mp, &mp->mnt_stat);
1585 	/*
1586 	 * Prevent external consumers of mount options from reading
1587 	 * mnt_optnew.
1588 	 */
1589 	mp->mnt_optnew = NULL;
1590 
1591 	if ((mp->mnt_flag & MNT_RDONLY) == 0)
1592 		vfs_allocate_syncvnode(mp);
1593 	else
1594 		vfs_deallocate_syncvnode(mp);
1595 end:
1596 	vfs_op_exit(mp);
1597 	if (rootvp != NULL) {
1598 		vn_seqc_write_end(rootvp);
1599 		vrele(rootvp);
1600 	}
1601 	vn_seqc_write_end(vp);
1602 	vfs_unbusy(mp);
1603 	VI_LOCK(vp);
1604 	vp->v_iflag &= ~VI_MOUNT;
1605 	VI_UNLOCK(vp);
1606 	vrele(vp);
1607 	return (error != 0 ? error : export_error);
1608 }
1609 
1610 /*
1611  * vfs_domount(): actually attempt a filesystem mount.
1612  */
1613 static int
vfs_domount(struct thread * td,const char * fstype,char * fspath,uint64_t fsflags,bool only_export,bool jail_export,struct vfsoptlist ** optlist)1614 vfs_domount(
1615 	struct thread *td,		/* Calling thread. */
1616 	const char *fstype,		/* Filesystem type. */
1617 	char *fspath,			/* Mount path. */
1618 	uint64_t fsflags,		/* Flags common to all filesystems. */
1619 	bool only_export,		/* Got export option. */
1620 	bool jail_export,		/* Got export option in vnet prison. */
1621 	struct vfsoptlist **optlist	/* Options local to the filesystem. */
1622 	)
1623 {
1624 	struct vfsconf *vfsp;
1625 	struct nameidata nd;
1626 	struct vnode *vp;
1627 	char *pathbuf;
1628 	int error;
1629 
1630 	/*
1631 	 * Be ultra-paranoid about making sure the type and fspath
1632 	 * variables will fit in our mp buffers, including the
1633 	 * terminating NUL.
1634 	 */
1635 	if (strlen(fstype) >= MFSNAMELEN || strlen(fspath) >= MNAMELEN)
1636 		return (ENAMETOOLONG);
1637 
1638 	if (jail_export) {
1639 		error = priv_check(td, PRIV_NFS_DAEMON);
1640 		if (error)
1641 			return (error);
1642 	} else if (jailed(td->td_ucred) || usermount == 0) {
1643 		if ((error = priv_check(td, PRIV_VFS_MOUNT)) != 0)
1644 			return (error);
1645 	}
1646 
1647 	/*
1648 	 * Do not allow NFS export or MNT_SUIDDIR by unprivileged users.
1649 	 */
1650 	if (fsflags & MNT_EXPORTED) {
1651 		error = priv_check(td, PRIV_VFS_MOUNT_EXPORTED);
1652 		if (error)
1653 			return (error);
1654 	}
1655 	if (fsflags & MNT_SUIDDIR) {
1656 		error = priv_check(td, PRIV_VFS_MOUNT_SUIDDIR);
1657 		if (error)
1658 			return (error);
1659 	}
1660 	/*
1661 	 * Silently enforce MNT_NOSUID and MNT_USER for unprivileged users.
1662 	 */
1663 	if ((fsflags & (MNT_NOSUID | MNT_USER)) != (MNT_NOSUID | MNT_USER)) {
1664 		if (priv_check(td, PRIV_VFS_MOUNT_NONUSER) != 0)
1665 			fsflags |= MNT_NOSUID | MNT_USER;
1666 	}
1667 
1668 	/* Load KLDs before we lock the covered vnode to avoid reversals. */
1669 	vfsp = NULL;
1670 	if ((fsflags & MNT_UPDATE) == 0) {
1671 		/* Don't try to load KLDs if we're mounting the root. */
1672 		if (fsflags & MNT_ROOTFS) {
1673 			if ((vfsp = vfs_byname(fstype)) == NULL)
1674 				return (ENODEV);
1675 		} else {
1676 			if ((vfsp = vfs_byname_kld(fstype, td, &error)) == NULL)
1677 				return (error);
1678 		}
1679 	}
1680 
1681 	/*
1682 	 * Get vnode to be covered or mount point's vnode in case of MNT_UPDATE.
1683 	 */
1684 	NDINIT(&nd, LOOKUP, FOLLOW | LOCKLEAF | AUDITVNODE1 | WANTPARENT,
1685 	    UIO_SYSSPACE, fspath);
1686 	error = namei(&nd);
1687 	if (error != 0)
1688 		return (error);
1689 	vp = nd.ni_vp;
1690 	/*
1691 	 * Don't allow stacking file mounts to work around problems with the way
1692 	 * that namei sets nd.ni_dvp to vp_crossmp for these.
1693 	 */
1694 	if (vp->v_type == VREG)
1695 		fsflags |= MNT_NOCOVER;
1696 	if ((fsflags & MNT_UPDATE) == 0) {
1697 		if ((vp->v_vflag & VV_ROOT) != 0 &&
1698 		    (fsflags & MNT_NOCOVER) != 0) {
1699 			vput(vp);
1700 			error = EBUSY;
1701 			goto out;
1702 		}
1703 		pathbuf = malloc(MNAMELEN, M_TEMP, M_WAITOK);
1704 		strcpy(pathbuf, fspath);
1705 		/*
1706 		 * Note: we allow any vnode type here. If the path sanity check
1707 		 * succeeds, the type will be validated in vfs_domount_first
1708 		 * above.
1709 		 */
1710 		if (vp->v_type == VDIR)
1711 			error = vn_path_to_global_path(td, vp, pathbuf,
1712 			    MNAMELEN);
1713 		else
1714 			error = vn_path_to_global_path_hardlink(td, vp,
1715 			    nd.ni_dvp, pathbuf, MNAMELEN,
1716 			    nd.ni_cnd.cn_nameptr, nd.ni_cnd.cn_namelen);
1717 		if (error == 0) {
1718 			error = vfs_domount_first(td, vfsp, pathbuf, vp,
1719 			    fsflags, optlist);
1720 		}
1721 		free(pathbuf, M_TEMP);
1722 	} else
1723 		error = vfs_domount_update(td, vp, fsflags, only_export,
1724 		    jail_export, optlist);
1725 
1726 out:
1727 	NDFREE_PNBUF(&nd);
1728 	vrele(nd.ni_dvp);
1729 
1730 	return (error);
1731 }
1732 
1733 /*
1734  * Unmount a filesystem.
1735  *
1736  * Note: unmount takes a path to the vnode mounted on as argument, not
1737  * special file (as before).
1738  */
1739 #ifndef _SYS_SYSPROTO_H_
1740 struct unmount_args {
1741 	char	*path;
1742 	int	flags;
1743 };
1744 #endif
1745 /* ARGSUSED */
1746 int
sys_unmount(struct thread * td,struct unmount_args * uap)1747 sys_unmount(struct thread *td, struct unmount_args *uap)
1748 {
1749 
1750 	return (kern_unmount(td, uap->path, (unsigned)uap->flags));
1751 }
1752 
1753 int
kern_unmount(struct thread * td,const char * path,uint64_t flags)1754 kern_unmount(struct thread *td, const char *path, uint64_t flags)
1755 {
1756 	struct nameidata nd;
1757 	struct mount *mp;
1758 	char *fsidbuf, *pathbuf;
1759 	fsid_t fsid;
1760 	int error;
1761 
1762 	AUDIT_ARG_VALUE(flags);
1763 	if ((flags & (MNT_DEFERRED | MNT_RECURSE)) != 0)
1764 		return (EINVAL);
1765 	if (jailed(td->td_ucred) || usermount == 0) {
1766 		error = priv_check(td, PRIV_VFS_UNMOUNT);
1767 		if (error)
1768 			return (error);
1769 	}
1770 	if (flags & MNT_BYFSID) {
1771 		fsidbuf = malloc(MNAMELEN, M_TEMP, M_WAITOK);
1772 		error = copyinstr(path, fsidbuf, MNAMELEN, NULL);
1773 		if (error) {
1774 			free(fsidbuf, M_TEMP);
1775 			return (error);
1776 		}
1777 
1778 		AUDIT_ARG_TEXT(fsidbuf);
1779 		/* Decode the filesystem ID. */
1780 		if (sscanf(fsidbuf, "FSID:%d:%d", &fsid.val[0], &fsid.val[1]) != 2) {
1781 			free(fsidbuf, M_TEMP);
1782 			return (EINVAL);
1783 		}
1784 
1785 		mp = vfs_getvfs(&fsid);
1786 		free(fsidbuf, M_TEMP);
1787 		if (mp == NULL) {
1788 			return (ENOENT);
1789 		}
1790 	} else {
1791 		pathbuf = malloc(MNAMELEN, M_TEMP, M_WAITOK);
1792 		error = copyinstr(path, pathbuf, MNAMELEN, NULL);
1793 		if (error) {
1794 			free(pathbuf, M_TEMP);
1795 			return (error);
1796 		}
1797 
1798 		/*
1799 		 * Try to find global path for path argument.
1800 		 */
1801 		NDINIT(&nd, LOOKUP, FOLLOW | LOCKLEAF | AUDITVNODE1,
1802 		    UIO_SYSSPACE, pathbuf);
1803 		if (namei(&nd) == 0) {
1804 			NDFREE_PNBUF(&nd);
1805 			error = vn_path_to_global_path(td, nd.ni_vp, pathbuf,
1806 			    MNAMELEN);
1807 			if (error == 0)
1808 				vput(nd.ni_vp);
1809 		}
1810 		mtx_lock(&mountlist_mtx);
1811 		TAILQ_FOREACH_REVERSE(mp, &mountlist, mntlist, mnt_list) {
1812 			if (strcmp(mp->mnt_stat.f_mntonname, pathbuf) == 0) {
1813 				vfs_ref(mp);
1814 				break;
1815 			}
1816 		}
1817 		mtx_unlock(&mountlist_mtx);
1818 		free(pathbuf, M_TEMP);
1819 		if (mp == NULL) {
1820 			/*
1821 			 * Previously we returned ENOENT for a nonexistent path and
1822 			 * EINVAL for a non-mountpoint.  We cannot tell these apart
1823 			 * now, so in the !MNT_BYFSID case return the more likely
1824 			 * EINVAL for compatibility.
1825 			 */
1826 			return (EINVAL);
1827 		}
1828 	}
1829 
1830 	/*
1831 	 * Don't allow unmounting the root filesystem.
1832 	 */
1833 	if (mp->mnt_flag & MNT_ROOTFS) {
1834 		vfs_rel(mp);
1835 		return (EINVAL);
1836 	}
1837 #ifdef MAC
1838 	error = mac_mount_check_unmount(td->td_ucred, mp, flags);
1839 	if (error != 0) {
1840 		vfs_rel(mp);
1841 		return (error);
1842 	}
1843 #endif
1844 	error = dounmount(mp, flags, td);
1845 	return (error);
1846 }
1847 
1848 /*
1849  * Return error if any of the vnodes, ignoring the root vnode
1850  * and the syncer vnode, have non-zero usecount.
1851  *
1852  * This function is purely advisory - it can return false positives
1853  * and negatives.
1854  */
1855 static int
vfs_check_usecounts(struct mount * mp)1856 vfs_check_usecounts(struct mount *mp)
1857 {
1858 	struct vnode *vp, *mvp;
1859 
1860 	MNT_VNODE_FOREACH_ALL(vp, mp, mvp) {
1861 		if ((vp->v_vflag & VV_ROOT) == 0 && vp->v_type != VNON &&
1862 		    vp->v_usecount != 0) {
1863 			VI_UNLOCK(vp);
1864 			MNT_VNODE_FOREACH_ALL_ABORT(mp, mvp);
1865 			return (EBUSY);
1866 		}
1867 		VI_UNLOCK(vp);
1868 	}
1869 
1870 	return (0);
1871 }
1872 
1873 static void
dounmount_cleanup(struct mount * mp,struct vnode * coveredvp,int mntkflags)1874 dounmount_cleanup(struct mount *mp, struct vnode *coveredvp, int mntkflags)
1875 {
1876 
1877 	mtx_assert(MNT_MTX(mp), MA_OWNED);
1878 	mp->mnt_kern_flag &= ~mntkflags;
1879 	if ((mp->mnt_kern_flag & MNTK_MWAIT) != 0) {
1880 		mp->mnt_kern_flag &= ~MNTK_MWAIT;
1881 		wakeup(mp);
1882 	}
1883 	vfs_op_exit_locked(mp);
1884 	MNT_IUNLOCK(mp);
1885 	if (coveredvp != NULL) {
1886 		VOP_UNLOCK(coveredvp);
1887 		vdrop(coveredvp);
1888 	}
1889 	vn_finished_write(mp);
1890 	vfs_rel(mp);
1891 }
1892 
1893 /*
1894  * There are various reference counters associated with the mount point.
1895  * Normally it is permitted to modify them without taking the mnt ilock,
1896  * but this behavior can be temporarily disabled if stable value is needed
1897  * or callers are expected to block (e.g. to not allow new users during
1898  * forced unmount).
1899  */
1900 void
vfs_op_enter(struct mount * mp)1901 vfs_op_enter(struct mount *mp)
1902 {
1903 	struct mount_pcpu *mpcpu;
1904 	int cpu;
1905 
1906 	MNT_ILOCK(mp);
1907 	mp->mnt_vfs_ops++;
1908 	if (mp->mnt_vfs_ops > 1) {
1909 		MNT_IUNLOCK(mp);
1910 		return;
1911 	}
1912 	vfs_op_barrier_wait(mp);
1913 	CPU_FOREACH(cpu) {
1914 		mpcpu = vfs_mount_pcpu_remote(mp, cpu);
1915 
1916 		mp->mnt_ref += mpcpu->mntp_ref;
1917 		mpcpu->mntp_ref = 0;
1918 
1919 		mp->mnt_lockref += mpcpu->mntp_lockref;
1920 		mpcpu->mntp_lockref = 0;
1921 
1922 		mp->mnt_writeopcount += mpcpu->mntp_writeopcount;
1923 		mpcpu->mntp_writeopcount = 0;
1924 	}
1925 	MPASSERT(mp->mnt_ref > 0 && mp->mnt_lockref >= 0 &&
1926 	    mp->mnt_writeopcount >= 0, mp,
1927 	    ("invalid count(s): ref %d lockref %d writeopcount %d",
1928 	    mp->mnt_ref, mp->mnt_lockref, mp->mnt_writeopcount));
1929 	MNT_IUNLOCK(mp);
1930 	vfs_assert_mount_counters(mp);
1931 }
1932 
1933 void
vfs_op_exit_locked(struct mount * mp)1934 vfs_op_exit_locked(struct mount *mp)
1935 {
1936 
1937 	mtx_assert(MNT_MTX(mp), MA_OWNED);
1938 
1939 	MPASSERT(mp->mnt_vfs_ops > 0, mp,
1940 	    ("invalid vfs_ops count %d", mp->mnt_vfs_ops));
1941 	MPASSERT(mp->mnt_vfs_ops > 1 ||
1942 	    (mp->mnt_kern_flag & (MNTK_UNMOUNT | MNTK_SUSPEND)) == 0, mp,
1943 	    ("vfs_ops too low %d in unmount or suspend", mp->mnt_vfs_ops));
1944 	mp->mnt_vfs_ops--;
1945 }
1946 
1947 void
vfs_op_exit(struct mount * mp)1948 vfs_op_exit(struct mount *mp)
1949 {
1950 
1951 	MNT_ILOCK(mp);
1952 	vfs_op_exit_locked(mp);
1953 	MNT_IUNLOCK(mp);
1954 }
1955 
1956 struct vfs_op_barrier_ipi {
1957 	struct mount *mp;
1958 	struct smp_rendezvous_cpus_retry_arg srcra;
1959 };
1960 
1961 static void
vfs_op_action_func(void * arg)1962 vfs_op_action_func(void *arg)
1963 {
1964 	struct vfs_op_barrier_ipi *vfsopipi;
1965 	struct mount *mp;
1966 
1967 	vfsopipi = __containerof(arg, struct vfs_op_barrier_ipi, srcra);
1968 	mp = vfsopipi->mp;
1969 
1970 	if (!vfs_op_thread_entered(mp))
1971 		smp_rendezvous_cpus_done(arg);
1972 }
1973 
1974 static void
vfs_op_wait_func(void * arg,int cpu)1975 vfs_op_wait_func(void *arg, int cpu)
1976 {
1977 	struct vfs_op_barrier_ipi *vfsopipi;
1978 	struct mount *mp;
1979 	struct mount_pcpu *mpcpu;
1980 
1981 	vfsopipi = __containerof(arg, struct vfs_op_barrier_ipi, srcra);
1982 	mp = vfsopipi->mp;
1983 
1984 	mpcpu = vfs_mount_pcpu_remote(mp, cpu);
1985 	while (atomic_load_int(&mpcpu->mntp_thread_in_ops))
1986 		cpu_spinwait();
1987 }
1988 
1989 void
vfs_op_barrier_wait(struct mount * mp)1990 vfs_op_barrier_wait(struct mount *mp)
1991 {
1992 	struct vfs_op_barrier_ipi vfsopipi;
1993 
1994 	vfsopipi.mp = mp;
1995 
1996 	smp_rendezvous_cpus_retry(all_cpus,
1997 	    smp_no_rendezvous_barrier,
1998 	    vfs_op_action_func,
1999 	    smp_no_rendezvous_barrier,
2000 	    vfs_op_wait_func,
2001 	    &vfsopipi.srcra);
2002 }
2003 
2004 #ifdef DIAGNOSTIC
2005 void
vfs_assert_mount_counters(struct mount * mp)2006 vfs_assert_mount_counters(struct mount *mp)
2007 {
2008 	struct mount_pcpu *mpcpu;
2009 	int cpu;
2010 
2011 	if (mp->mnt_vfs_ops == 0)
2012 		return;
2013 
2014 	CPU_FOREACH(cpu) {
2015 		mpcpu = vfs_mount_pcpu_remote(mp, cpu);
2016 		if (mpcpu->mntp_ref != 0 ||
2017 		    mpcpu->mntp_lockref != 0 ||
2018 		    mpcpu->mntp_writeopcount != 0)
2019 			vfs_dump_mount_counters(mp);
2020 	}
2021 }
2022 
2023 void
vfs_dump_mount_counters(struct mount * mp)2024 vfs_dump_mount_counters(struct mount *mp)
2025 {
2026 	struct mount_pcpu *mpcpu;
2027 	int ref, lockref, writeopcount;
2028 	int cpu;
2029 
2030 	printf("%s: mp %p vfs_ops %d\n", __func__, mp, mp->mnt_vfs_ops);
2031 
2032 	printf("        ref : ");
2033 	ref = mp->mnt_ref;
2034 	CPU_FOREACH(cpu) {
2035 		mpcpu = vfs_mount_pcpu_remote(mp, cpu);
2036 		printf("%d ", mpcpu->mntp_ref);
2037 		ref += mpcpu->mntp_ref;
2038 	}
2039 	printf("\n");
2040 	printf("    lockref : ");
2041 	lockref = mp->mnt_lockref;
2042 	CPU_FOREACH(cpu) {
2043 		mpcpu = vfs_mount_pcpu_remote(mp, cpu);
2044 		printf("%d ", mpcpu->mntp_lockref);
2045 		lockref += mpcpu->mntp_lockref;
2046 	}
2047 	printf("\n");
2048 	printf("writeopcount: ");
2049 	writeopcount = mp->mnt_writeopcount;
2050 	CPU_FOREACH(cpu) {
2051 		mpcpu = vfs_mount_pcpu_remote(mp, cpu);
2052 		printf("%d ", mpcpu->mntp_writeopcount);
2053 		writeopcount += mpcpu->mntp_writeopcount;
2054 	}
2055 	printf("\n");
2056 
2057 	printf("counter       struct total\n");
2058 	printf("ref             %-5d  %-5d\n", mp->mnt_ref, ref);
2059 	printf("lockref         %-5d  %-5d\n", mp->mnt_lockref, lockref);
2060 	printf("writeopcount    %-5d  %-5d\n", mp->mnt_writeopcount, writeopcount);
2061 
2062 	panic("invalid counts on struct mount");
2063 }
2064 #endif
2065 
2066 int
vfs_mount_fetch_counter(struct mount * mp,enum mount_counter which)2067 vfs_mount_fetch_counter(struct mount *mp, enum mount_counter which)
2068 {
2069 	struct mount_pcpu *mpcpu;
2070 	int cpu, sum;
2071 
2072 	switch (which) {
2073 	case MNT_COUNT_REF:
2074 		sum = mp->mnt_ref;
2075 		break;
2076 	case MNT_COUNT_LOCKREF:
2077 		sum = mp->mnt_lockref;
2078 		break;
2079 	case MNT_COUNT_WRITEOPCOUNT:
2080 		sum = mp->mnt_writeopcount;
2081 		break;
2082 	}
2083 
2084 	CPU_FOREACH(cpu) {
2085 		mpcpu = vfs_mount_pcpu_remote(mp, cpu);
2086 		switch (which) {
2087 		case MNT_COUNT_REF:
2088 			sum += mpcpu->mntp_ref;
2089 			break;
2090 		case MNT_COUNT_LOCKREF:
2091 			sum += mpcpu->mntp_lockref;
2092 			break;
2093 		case MNT_COUNT_WRITEOPCOUNT:
2094 			sum += mpcpu->mntp_writeopcount;
2095 			break;
2096 		}
2097 	}
2098 	return (sum);
2099 }
2100 
2101 static bool
deferred_unmount_enqueue(struct mount * mp,uint64_t flags,bool requeue,int timeout_ticks)2102 deferred_unmount_enqueue(struct mount *mp, uint64_t flags, bool requeue,
2103     int timeout_ticks)
2104 {
2105 	bool enqueued;
2106 
2107 	enqueued = false;
2108 	mtx_lock(&deferred_unmount_lock);
2109 	if ((mp->mnt_taskqueue_flags & MNT_DEFERRED) == 0 || requeue) {
2110 		mp->mnt_taskqueue_flags = flags | MNT_DEFERRED;
2111 		STAILQ_INSERT_TAIL(&deferred_unmount_list, mp,
2112 		    mnt_taskqueue_link);
2113 		enqueued = true;
2114 	}
2115 	mtx_unlock(&deferred_unmount_lock);
2116 
2117 	if (enqueued) {
2118 		taskqueue_enqueue_timeout(taskqueue_deferred_unmount,
2119 		    &deferred_unmount_task, timeout_ticks);
2120 	}
2121 
2122 	return (enqueued);
2123 }
2124 
2125 /*
2126  * Taskqueue handler for processing async/recursive unmounts
2127  */
2128 static void
vfs_deferred_unmount(void * argi __unused,int pending __unused)2129 vfs_deferred_unmount(void *argi __unused, int pending __unused)
2130 {
2131 	STAILQ_HEAD(, mount) local_unmounts;
2132 	uint64_t flags;
2133 	struct mount *mp, *tmp;
2134 	int error;
2135 	unsigned int retries;
2136 	bool unmounted;
2137 
2138 	STAILQ_INIT(&local_unmounts);
2139 	mtx_lock(&deferred_unmount_lock);
2140 	STAILQ_CONCAT(&local_unmounts, &deferred_unmount_list);
2141 	mtx_unlock(&deferred_unmount_lock);
2142 
2143 	STAILQ_FOREACH_SAFE(mp, &local_unmounts, mnt_taskqueue_link, tmp) {
2144 		flags = mp->mnt_taskqueue_flags;
2145 		KASSERT((flags & MNT_DEFERRED) != 0,
2146 		    ("taskqueue unmount without MNT_DEFERRED"));
2147 		error = dounmount(mp, flags, curthread);
2148 		if (error != 0) {
2149 			MNT_ILOCK(mp);
2150 			unmounted = ((mp->mnt_kern_flag & MNTK_REFEXPIRE) != 0);
2151 			MNT_IUNLOCK(mp);
2152 
2153 			/*
2154 			 * The deferred unmount thread is the only thread that
2155 			 * modifies the retry counts, so locking/atomics aren't
2156 			 * needed here.
2157 			 */
2158 			retries = (mp->mnt_unmount_retries)++;
2159 			deferred_unmount_total_retries++;
2160 			if (!unmounted && retries < deferred_unmount_retry_limit) {
2161 				deferred_unmount_enqueue(mp, flags, true,
2162 				    -deferred_unmount_retry_delay_hz);
2163 			} else {
2164 				if (retries >= deferred_unmount_retry_limit) {
2165 					printf("giving up on deferred unmount "
2166 					    "of %s after %d retries, error %d\n",
2167 					    mp->mnt_stat.f_mntonname, retries, error);
2168 				}
2169 				vfs_rel(mp);
2170 			}
2171 		}
2172 	}
2173 }
2174 
2175 /*
2176  * Do the actual filesystem unmount.
2177  */
2178 int
dounmount(struct mount * mp,uint64_t flags,struct thread * td)2179 dounmount(struct mount *mp, uint64_t flags, struct thread *td)
2180 {
2181 	struct mount_upper_node *upper;
2182 	struct vnode *coveredvp, *rootvp;
2183 	int error;
2184 	uint64_t async_flag;
2185 	int mnt_gen_r;
2186 	unsigned int retries;
2187 
2188 	KASSERT((flags & MNT_DEFERRED) == 0 ||
2189 	    (flags & (MNT_RECURSE | MNT_FORCE)) == (MNT_RECURSE | MNT_FORCE),
2190 	    ("MNT_DEFERRED requires MNT_RECURSE | MNT_FORCE"));
2191 
2192 	/*
2193 	 * If the caller has explicitly requested the unmount to be handled by
2194 	 * the taskqueue and we're not already in taskqueue context, queue
2195 	 * up the unmount request and exit.  This is done prior to any
2196 	 * credential checks; MNT_DEFERRED should be used only for kernel-
2197 	 * initiated unmounts and will therefore be processed with the
2198 	 * (kernel) credentials of the taskqueue thread.  Still, callers
2199 	 * should be sure this is the behavior they want.
2200 	 */
2201 	if ((flags & MNT_DEFERRED) != 0 &&
2202 	    taskqueue_member(taskqueue_deferred_unmount, curthread) == 0) {
2203 		if (!deferred_unmount_enqueue(mp, flags, false, 0))
2204 			vfs_rel(mp);
2205 		return (EINPROGRESS);
2206 	}
2207 
2208 	/*
2209 	 * Only privileged root, or (if MNT_USER is set) the user that did the
2210 	 * original mount is permitted to unmount this filesystem.
2211 	 * This check should be made prior to queueing up any recursive
2212 	 * unmounts of upper filesystems.  Those unmounts will be executed
2213 	 * with kernel thread credentials and are expected to succeed, so
2214 	 * we must at least ensure the originating context has sufficient
2215 	 * privilege to unmount the base filesystem before proceeding with
2216 	 * the uppers.
2217 	 */
2218 	error = vfs_suser(mp, td);
2219 	if (error != 0) {
2220 		KASSERT((flags & MNT_DEFERRED) == 0,
2221 		    ("taskqueue unmount with insufficient privilege"));
2222 		vfs_rel(mp);
2223 		return (error);
2224 	}
2225 
2226 	if (recursive_forced_unmount && ((flags & MNT_FORCE) != 0))
2227 		flags |= MNT_RECURSE;
2228 
2229 	if ((flags & MNT_RECURSE) != 0) {
2230 		KASSERT((flags & MNT_FORCE) != 0,
2231 		    ("MNT_RECURSE requires MNT_FORCE"));
2232 
2233 		MNT_ILOCK(mp);
2234 		/*
2235 		 * Set MNTK_RECURSE to prevent new upper mounts from being
2236 		 * added, and note that an operation on the uppers list is in
2237 		 * progress.  This will ensure that unregistration from the
2238 		 * uppers list, and therefore any pending unmount of the upper
2239 		 * FS, can't complete until after we finish walking the list.
2240 		 */
2241 		mp->mnt_kern_flag |= MNTK_RECURSE;
2242 		mp->mnt_upper_pending++;
2243 		TAILQ_FOREACH(upper, &mp->mnt_uppers, mnt_upper_link) {
2244 			retries = upper->mp->mnt_unmount_retries;
2245 			if (retries > deferred_unmount_retry_limit) {
2246 				error = EBUSY;
2247 				continue;
2248 			}
2249 			MNT_IUNLOCK(mp);
2250 
2251 			vfs_ref(upper->mp);
2252 			if (!deferred_unmount_enqueue(upper->mp, flags,
2253 			    false, 0))
2254 				vfs_rel(upper->mp);
2255 			MNT_ILOCK(mp);
2256 		}
2257 		mp->mnt_upper_pending--;
2258 		if ((mp->mnt_kern_flag & MNTK_UPPER_WAITER) != 0 &&
2259 		    mp->mnt_upper_pending == 0) {
2260 			mp->mnt_kern_flag &= ~MNTK_UPPER_WAITER;
2261 			wakeup(&mp->mnt_uppers);
2262 		}
2263 
2264 		/*
2265 		 * If we're not on the taskqueue, wait until the uppers list
2266 		 * is drained before proceeding with unmount.  Otherwise, if
2267 		 * we are on the taskqueue and there are still pending uppers,
2268 		 * just re-enqueue on the end of the taskqueue.
2269 		 */
2270 		if ((flags & MNT_DEFERRED) == 0) {
2271 			while (error == 0 && !TAILQ_EMPTY(&mp->mnt_uppers)) {
2272 				mp->mnt_kern_flag |= MNTK_TASKQUEUE_WAITER;
2273 				error = msleep(&mp->mnt_taskqueue_link,
2274 				    MNT_MTX(mp), PCATCH, "umntqw", 0);
2275 			}
2276 			if (error != 0) {
2277 				MNT_REL(mp);
2278 				MNT_IUNLOCK(mp);
2279 				return (error);
2280 			}
2281 		} else if (!TAILQ_EMPTY(&mp->mnt_uppers)) {
2282 			MNT_IUNLOCK(mp);
2283 			if (error == 0)
2284 				deferred_unmount_enqueue(mp, flags, true, 0);
2285 			return (error);
2286 		}
2287 		MNT_IUNLOCK(mp);
2288 		KASSERT(TAILQ_EMPTY(&mp->mnt_uppers), ("mnt_uppers not empty"));
2289 	}
2290 
2291 	/* Allow the taskqueue to safely re-enqueue on failure */
2292 	if ((flags & MNT_DEFERRED) != 0)
2293 		vfs_ref(mp);
2294 
2295 	if ((coveredvp = mp->mnt_vnodecovered) != NULL) {
2296 		mnt_gen_r = mp->mnt_gen;
2297 		VI_LOCK(coveredvp);
2298 		vholdl(coveredvp);
2299 		vn_lock(coveredvp, LK_EXCLUSIVE | LK_INTERLOCK | LK_RETRY);
2300 		/*
2301 		 * Check for mp being unmounted while waiting for the
2302 		 * covered vnode lock.
2303 		 */
2304 		if (coveredvp->v_mountedhere != mp ||
2305 		    coveredvp->v_mountedhere->mnt_gen != mnt_gen_r) {
2306 			VOP_UNLOCK(coveredvp);
2307 			vdrop(coveredvp);
2308 			vfs_rel(mp);
2309 			return (EBUSY);
2310 		}
2311 	}
2312 
2313 	vfs_op_enter(mp);
2314 
2315 	vn_start_write(NULL, &mp, V_WAIT);
2316 	MNT_ILOCK(mp);
2317 	if ((mp->mnt_kern_flag & MNTK_UNMOUNT) != 0 ||
2318 	    (mp->mnt_flag & MNT_UPDATE) != 0 ||
2319 	    !TAILQ_EMPTY(&mp->mnt_uppers)) {
2320 		dounmount_cleanup(mp, coveredvp, 0);
2321 		return (EBUSY);
2322 	}
2323 	mp->mnt_kern_flag |= MNTK_UNMOUNT;
2324 	rootvp = vfs_cache_root_clear(mp);
2325 	if (coveredvp != NULL)
2326 		vn_seqc_write_begin(coveredvp);
2327 	if (flags & MNT_NONBUSY) {
2328 		MNT_IUNLOCK(mp);
2329 		error = vfs_check_usecounts(mp);
2330 		MNT_ILOCK(mp);
2331 		if (error != 0) {
2332 			vn_seqc_write_end(coveredvp);
2333 			dounmount_cleanup(mp, coveredvp, MNTK_UNMOUNT);
2334 			if (rootvp != NULL) {
2335 				vn_seqc_write_end(rootvp);
2336 				vrele(rootvp);
2337 			}
2338 			return (error);
2339 		}
2340 	}
2341 	/* Allow filesystems to detect that a forced unmount is in progress. */
2342 	if (flags & MNT_FORCE) {
2343 		mp->mnt_kern_flag |= MNTK_UNMOUNTF;
2344 		MNT_IUNLOCK(mp);
2345 		/*
2346 		 * Must be done after setting MNTK_UNMOUNTF and before
2347 		 * waiting for mnt_lockref to become 0.
2348 		 */
2349 		VFS_PURGE(mp);
2350 		MNT_ILOCK(mp);
2351 	}
2352 	error = 0;
2353 	if (mp->mnt_lockref) {
2354 		mp->mnt_kern_flag |= MNTK_DRAINING;
2355 		error = msleep(&mp->mnt_lockref, MNT_MTX(mp), PVFS,
2356 		    "mount drain", 0);
2357 	}
2358 	MNT_IUNLOCK(mp);
2359 	KASSERT(mp->mnt_lockref == 0,
2360 	    ("%s: invalid lock refcount in the drain path @ %s:%d",
2361 	    __func__, __FILE__, __LINE__));
2362 	KASSERT(error == 0,
2363 	    ("%s: invalid return value for msleep in the drain path @ %s:%d",
2364 	    __func__, __FILE__, __LINE__));
2365 
2366 	/*
2367 	 * We want to keep the vnode around so that we can vn_seqc_write_end
2368 	 * after we are done with unmount. Downgrade our reference to a mere
2369 	 * hold count so that we don't interefere with anything.
2370 	 */
2371 	if (rootvp != NULL) {
2372 		vhold(rootvp);
2373 		vrele(rootvp);
2374 	}
2375 
2376 	if (mp->mnt_flag & MNT_EXPUBLIC)
2377 		vfs_setpublicfs(NULL, NULL, NULL);
2378 
2379 	vfs_periodic(mp, MNT_WAIT);
2380 	MNT_ILOCK(mp);
2381 	async_flag = mp->mnt_flag & MNT_ASYNC;
2382 	mp->mnt_flag &= ~MNT_ASYNC;
2383 	mp->mnt_kern_flag &= ~MNTK_ASYNC;
2384 	MNT_IUNLOCK(mp);
2385 	vfs_deallocate_syncvnode(mp);
2386 	error = VFS_UNMOUNT(mp, flags);
2387 	vn_finished_write(mp);
2388 	vfs_rel(mp);
2389 	/*
2390 	 * If we failed to flush the dirty blocks for this mount point,
2391 	 * undo all the cdir/rdir and rootvnode changes we made above.
2392 	 * Unless we failed to do so because the device is reporting that
2393 	 * it doesn't exist anymore.
2394 	 */
2395 	if (error && error != ENXIO) {
2396 		MNT_ILOCK(mp);
2397 		if ((mp->mnt_flag & MNT_RDONLY) == 0) {
2398 			MNT_IUNLOCK(mp);
2399 			vfs_allocate_syncvnode(mp);
2400 			MNT_ILOCK(mp);
2401 		}
2402 		mp->mnt_kern_flag &= ~(MNTK_UNMOUNT | MNTK_UNMOUNTF);
2403 		mp->mnt_flag |= async_flag;
2404 		if ((mp->mnt_flag & MNT_ASYNC) != 0 &&
2405 		    (mp->mnt_kern_flag & MNTK_NOASYNC) == 0)
2406 			mp->mnt_kern_flag |= MNTK_ASYNC;
2407 		if (mp->mnt_kern_flag & MNTK_MWAIT) {
2408 			mp->mnt_kern_flag &= ~MNTK_MWAIT;
2409 			wakeup(mp);
2410 		}
2411 		vfs_op_exit_locked(mp);
2412 		MNT_IUNLOCK(mp);
2413 		if (coveredvp) {
2414 			vn_seqc_write_end(coveredvp);
2415 			VOP_UNLOCK(coveredvp);
2416 			vdrop(coveredvp);
2417 		}
2418 		if (rootvp != NULL) {
2419 			vn_seqc_write_end(rootvp);
2420 			vdrop(rootvp);
2421 		}
2422 		return (error);
2423 	}
2424 
2425 	mtx_lock(&mountlist_mtx);
2426 	TAILQ_REMOVE(&mountlist, mp, mnt_list);
2427 	mtx_unlock(&mountlist_mtx);
2428 	EVENTHANDLER_DIRECT_INVOKE(vfs_unmounted, mp, td);
2429 	if (coveredvp != NULL) {
2430 		VI_LOCK(coveredvp);
2431 		vn_irflag_unset_locked(coveredvp, VIRF_MOUNTPOINT);
2432 		coveredvp->v_mountedhere = NULL;
2433 		vn_seqc_write_end_locked(coveredvp);
2434 		VI_UNLOCK(coveredvp);
2435 		VOP_UNLOCK(coveredvp);
2436 		vdrop(coveredvp);
2437 	}
2438 	mount_devctl_event("UNMOUNT", mp, false);
2439 	if (rootvp != NULL) {
2440 		vn_seqc_write_end(rootvp);
2441 		vdrop(rootvp);
2442 	}
2443 	vfs_event_signal(NULL, VQ_UNMOUNT, 0);
2444 	if (rootvnode != NULL && mp == rootvnode->v_mount) {
2445 		vrele(rootvnode);
2446 		rootvnode = NULL;
2447 	}
2448 	if (mp == rootdevmp)
2449 		rootdevmp = NULL;
2450 	if ((flags & MNT_DEFERRED) != 0)
2451 		vfs_rel(mp);
2452 	vfs_mount_destroy(mp);
2453 	return (0);
2454 }
2455 
2456 /*
2457  * Report errors during filesystem mounting.
2458  */
2459 void
vfs_mount_error(struct mount * mp,const char * fmt,...)2460 vfs_mount_error(struct mount *mp, const char *fmt, ...)
2461 {
2462 	struct vfsoptlist *moptlist = mp->mnt_optnew;
2463 	va_list ap;
2464 	int error, len;
2465 	char *errmsg;
2466 
2467 	error = vfs_getopt(moptlist, "errmsg", (void **)&errmsg, &len);
2468 	if (error || errmsg == NULL || len <= 0)
2469 		return;
2470 
2471 	va_start(ap, fmt);
2472 	vsnprintf(errmsg, (size_t)len, fmt, ap);
2473 	va_end(ap);
2474 }
2475 
2476 void
vfs_opterror(struct vfsoptlist * opts,const char * fmt,...)2477 vfs_opterror(struct vfsoptlist *opts, const char *fmt, ...)
2478 {
2479 	va_list ap;
2480 	int error, len;
2481 	char *errmsg;
2482 
2483 	error = vfs_getopt(opts, "errmsg", (void **)&errmsg, &len);
2484 	if (error || errmsg == NULL || len <= 0)
2485 		return;
2486 
2487 	va_start(ap, fmt);
2488 	vsnprintf(errmsg, (size_t)len, fmt, ap);
2489 	va_end(ap);
2490 }
2491 
2492 /*
2493  * ---------------------------------------------------------------------
2494  * Functions for querying mount options/arguments from filesystems.
2495  */
2496 
2497 /*
2498  * Check that no unknown options are given
2499  */
2500 int
vfs_filteropt(struct vfsoptlist * opts,const char ** legal)2501 vfs_filteropt(struct vfsoptlist *opts, const char **legal)
2502 {
2503 	struct vfsopt *opt;
2504 	char errmsg[255];
2505 	const char **t, *p, *q;
2506 	int ret = 0;
2507 
2508 	TAILQ_FOREACH(opt, opts, link) {
2509 		p = opt->name;
2510 		q = NULL;
2511 		if (p[0] == 'n' && p[1] == 'o')
2512 			q = p + 2;
2513 		for(t = global_opts; *t != NULL; t++) {
2514 			if (strcmp(*t, p) == 0)
2515 				break;
2516 			if (q != NULL) {
2517 				if (strcmp(*t, q) == 0)
2518 					break;
2519 			}
2520 		}
2521 		if (*t != NULL)
2522 			continue;
2523 		for(t = legal; *t != NULL; t++) {
2524 			if (strcmp(*t, p) == 0)
2525 				break;
2526 			if (q != NULL) {
2527 				if (strcmp(*t, q) == 0)
2528 					break;
2529 			}
2530 		}
2531 		if (*t != NULL)
2532 			continue;
2533 		snprintf(errmsg, sizeof(errmsg),
2534 		    "mount option <%s> is unknown", p);
2535 		ret = EINVAL;
2536 	}
2537 	if (ret != 0) {
2538 		TAILQ_FOREACH(opt, opts, link) {
2539 			if (strcmp(opt->name, "errmsg") == 0) {
2540 				strncpy((char *)opt->value, errmsg, opt->len);
2541 				break;
2542 			}
2543 		}
2544 		if (opt == NULL)
2545 			printf("%s\n", errmsg);
2546 	}
2547 	return (ret);
2548 }
2549 
2550 /*
2551  * Get a mount option by its name.
2552  *
2553  * Return 0 if the option was found, ENOENT otherwise.
2554  * If len is non-NULL it will be filled with the length
2555  * of the option. If buf is non-NULL, it will be filled
2556  * with the address of the option.
2557  */
2558 int
vfs_getopt(struct vfsoptlist * opts,const char * name,void ** buf,int * len)2559 vfs_getopt(struct vfsoptlist *opts, const char *name, void **buf, int *len)
2560 {
2561 	struct vfsopt *opt;
2562 
2563 	KASSERT(opts != NULL, ("vfs_getopt: caller passed 'opts' as NULL"));
2564 
2565 	TAILQ_FOREACH(opt, opts, link) {
2566 		if (strcmp(name, opt->name) == 0) {
2567 			opt->seen = 1;
2568 			if (len != NULL)
2569 				*len = opt->len;
2570 			if (buf != NULL)
2571 				*buf = opt->value;
2572 			return (0);
2573 		}
2574 	}
2575 	return (ENOENT);
2576 }
2577 
2578 int
vfs_getopt_pos(struct vfsoptlist * opts,const char * name)2579 vfs_getopt_pos(struct vfsoptlist *opts, const char *name)
2580 {
2581 	struct vfsopt *opt;
2582 
2583 	if (opts == NULL)
2584 		return (-1);
2585 
2586 	TAILQ_FOREACH(opt, opts, link) {
2587 		if (strcmp(name, opt->name) == 0) {
2588 			opt->seen = 1;
2589 			return (opt->pos);
2590 		}
2591 	}
2592 	return (-1);
2593 }
2594 
2595 int
vfs_getopt_size(struct vfsoptlist * opts,const char * name,off_t * value)2596 vfs_getopt_size(struct vfsoptlist *opts, const char *name, off_t *value)
2597 {
2598 	char *opt_value, *vtp;
2599 	quad_t iv;
2600 	int error, opt_len;
2601 
2602 	error = vfs_getopt(opts, name, (void **)&opt_value, &opt_len);
2603 	if (error != 0)
2604 		return (error);
2605 	if (opt_len == 0 || opt_value == NULL)
2606 		return (EINVAL);
2607 	if (opt_value[0] == '\0' || opt_value[opt_len - 1] != '\0')
2608 		return (EINVAL);
2609 	iv = strtoq(opt_value, &vtp, 0);
2610 	if (vtp == opt_value || (vtp[0] != '\0' && vtp[1] != '\0'))
2611 		return (EINVAL);
2612 	if (iv < 0)
2613 		return (EINVAL);
2614 	switch (vtp[0]) {
2615 	case 't': case 'T':
2616 		iv *= 1024;
2617 		/* FALLTHROUGH */
2618 	case 'g': case 'G':
2619 		iv *= 1024;
2620 		/* FALLTHROUGH */
2621 	case 'm': case 'M':
2622 		iv *= 1024;
2623 		/* FALLTHROUGH */
2624 	case 'k': case 'K':
2625 		iv *= 1024;
2626 	case '\0':
2627 		break;
2628 	default:
2629 		return (EINVAL);
2630 	}
2631 	*value = iv;
2632 
2633 	return (0);
2634 }
2635 
2636 char *
vfs_getopts(struct vfsoptlist * opts,const char * name,int * error)2637 vfs_getopts(struct vfsoptlist *opts, const char *name, int *error)
2638 {
2639 	struct vfsopt *opt;
2640 
2641 	*error = 0;
2642 	TAILQ_FOREACH(opt, opts, link) {
2643 		if (strcmp(name, opt->name) != 0)
2644 			continue;
2645 		opt->seen = 1;
2646 		if (opt->len == 0 ||
2647 		    ((char *)opt->value)[opt->len - 1] != '\0') {
2648 			*error = EINVAL;
2649 			return (NULL);
2650 		}
2651 		return (opt->value);
2652 	}
2653 	*error = ENOENT;
2654 	return (NULL);
2655 }
2656 
2657 int
vfs_flagopt(struct vfsoptlist * opts,const char * name,uint64_t * w,uint64_t val)2658 vfs_flagopt(struct vfsoptlist *opts, const char *name, uint64_t *w,
2659 	uint64_t val)
2660 {
2661 	struct vfsopt *opt;
2662 
2663 	TAILQ_FOREACH(opt, opts, link) {
2664 		if (strcmp(name, opt->name) == 0) {
2665 			opt->seen = 1;
2666 			if (w != NULL)
2667 				*w |= val;
2668 			return (1);
2669 		}
2670 	}
2671 	if (w != NULL)
2672 		*w &= ~val;
2673 	return (0);
2674 }
2675 
2676 int
vfs_scanopt(struct vfsoptlist * opts,const char * name,const char * fmt,...)2677 vfs_scanopt(struct vfsoptlist *opts, const char *name, const char *fmt, ...)
2678 {
2679 	va_list ap;
2680 	struct vfsopt *opt;
2681 	int ret;
2682 
2683 	KASSERT(opts != NULL, ("vfs_getopt: caller passed 'opts' as NULL"));
2684 
2685 	TAILQ_FOREACH(opt, opts, link) {
2686 		if (strcmp(name, opt->name) != 0)
2687 			continue;
2688 		opt->seen = 1;
2689 		if (opt->len == 0 || opt->value == NULL)
2690 			return (0);
2691 		if (((char *)opt->value)[opt->len - 1] != '\0')
2692 			return (0);
2693 		va_start(ap, fmt);
2694 		ret = vsscanf(opt->value, fmt, ap);
2695 		va_end(ap);
2696 		return (ret);
2697 	}
2698 	return (0);
2699 }
2700 
2701 int
vfs_setopt(struct vfsoptlist * opts,const char * name,void * value,int len)2702 vfs_setopt(struct vfsoptlist *opts, const char *name, void *value, int len)
2703 {
2704 	struct vfsopt *opt;
2705 
2706 	TAILQ_FOREACH(opt, opts, link) {
2707 		if (strcmp(name, opt->name) != 0)
2708 			continue;
2709 		opt->seen = 1;
2710 		if (opt->value == NULL)
2711 			opt->len = len;
2712 		else {
2713 			if (opt->len != len)
2714 				return (EINVAL);
2715 			bcopy(value, opt->value, len);
2716 		}
2717 		return (0);
2718 	}
2719 	return (ENOENT);
2720 }
2721 
2722 int
vfs_setopt_part(struct vfsoptlist * opts,const char * name,void * value,int len)2723 vfs_setopt_part(struct vfsoptlist *opts, const char *name, void *value, int len)
2724 {
2725 	struct vfsopt *opt;
2726 
2727 	TAILQ_FOREACH(opt, opts, link) {
2728 		if (strcmp(name, opt->name) != 0)
2729 			continue;
2730 		opt->seen = 1;
2731 		if (opt->value == NULL)
2732 			opt->len = len;
2733 		else {
2734 			if (opt->len < len)
2735 				return (EINVAL);
2736 			opt->len = len;
2737 			bcopy(value, opt->value, len);
2738 		}
2739 		return (0);
2740 	}
2741 	return (ENOENT);
2742 }
2743 
2744 int
vfs_setopts(struct vfsoptlist * opts,const char * name,const char * value)2745 vfs_setopts(struct vfsoptlist *opts, const char *name, const char *value)
2746 {
2747 	struct vfsopt *opt;
2748 
2749 	TAILQ_FOREACH(opt, opts, link) {
2750 		if (strcmp(name, opt->name) != 0)
2751 			continue;
2752 		opt->seen = 1;
2753 		if (opt->value == NULL)
2754 			opt->len = strlen(value) + 1;
2755 		else if (strlcpy(opt->value, value, opt->len) >= opt->len)
2756 			return (EINVAL);
2757 		return (0);
2758 	}
2759 	return (ENOENT);
2760 }
2761 
2762 /*
2763  * Find and copy a mount option.
2764  *
2765  * The size of the buffer has to be specified
2766  * in len, if it is not the same length as the
2767  * mount option, EINVAL is returned.
2768  * Returns ENOENT if the option is not found.
2769  */
2770 int
vfs_copyopt(struct vfsoptlist * opts,const char * name,void * dest,int len)2771 vfs_copyopt(struct vfsoptlist *opts, const char *name, void *dest, int len)
2772 {
2773 	struct vfsopt *opt;
2774 
2775 	KASSERT(opts != NULL, ("vfs_copyopt: caller passed 'opts' as NULL"));
2776 
2777 	TAILQ_FOREACH(opt, opts, link) {
2778 		if (strcmp(name, opt->name) == 0) {
2779 			opt->seen = 1;
2780 			if (len != opt->len)
2781 				return (EINVAL);
2782 			bcopy(opt->value, dest, opt->len);
2783 			return (0);
2784 		}
2785 	}
2786 	return (ENOENT);
2787 }
2788 
2789 int
__vfs_statfs(struct mount * mp,struct statfs * sbp)2790 __vfs_statfs(struct mount *mp, struct statfs *sbp)
2791 {
2792 	/*
2793 	 * Filesystems only fill in part of the structure for updates, we
2794 	 * have to read the entirety first to get all content.
2795 	 */
2796 	if (sbp != &mp->mnt_stat)
2797 		memcpy(sbp, &mp->mnt_stat, sizeof(*sbp));
2798 
2799 	/*
2800 	 * Set these in case the underlying filesystem fails to do so.
2801 	 */
2802 	sbp->f_version = STATFS_VERSION;
2803 	sbp->f_namemax = NAME_MAX;
2804 	sbp->f_flags = mp->mnt_flag & MNT_VISFLAGMASK;
2805 	sbp->f_nvnodelistsize = mp->mnt_nvnodelistsize;
2806 
2807 	return (mp->mnt_op->vfs_statfs(mp, sbp));
2808 }
2809 
2810 void
vfs_mountedfrom(struct mount * mp,const char * from)2811 vfs_mountedfrom(struct mount *mp, const char *from)
2812 {
2813 
2814 	bzero(mp->mnt_stat.f_mntfromname, sizeof mp->mnt_stat.f_mntfromname);
2815 	strlcpy(mp->mnt_stat.f_mntfromname, from,
2816 	    sizeof mp->mnt_stat.f_mntfromname);
2817 }
2818 
2819 /*
2820  * ---------------------------------------------------------------------
2821  * This is the api for building mount args and mounting filesystems from
2822  * inside the kernel.
2823  *
2824  * The API works by accumulation of individual args.  First error is
2825  * latched.
2826  *
2827  * XXX: should be documented in new manpage kernel_mount(9)
2828  */
2829 
2830 /* A memory allocation which must be freed when we are done */
2831 struct mntaarg {
2832 	SLIST_ENTRY(mntaarg)	next;
2833 };
2834 
2835 /* The header for the mount arguments */
2836 struct mntarg {
2837 	struct iovec *v;
2838 	int len;
2839 	int error;
2840 	SLIST_HEAD(, mntaarg)	list;
2841 };
2842 
2843 /*
2844  * Add a boolean argument.
2845  *
2846  * flag is the boolean value.
2847  * name must start with "no".
2848  */
2849 struct mntarg *
mount_argb(struct mntarg * ma,int flag,const char * name)2850 mount_argb(struct mntarg *ma, int flag, const char *name)
2851 {
2852 
2853 	KASSERT(name[0] == 'n' && name[1] == 'o',
2854 	    ("mount_argb(...,%s): name must start with 'no'", name));
2855 
2856 	return (mount_arg(ma, name + (flag ? 2 : 0), NULL, 0));
2857 }
2858 
2859 /*
2860  * Add an argument printf style
2861  */
2862 struct mntarg *
mount_argf(struct mntarg * ma,const char * name,const char * fmt,...)2863 mount_argf(struct mntarg *ma, const char *name, const char *fmt, ...)
2864 {
2865 	va_list ap;
2866 	struct mntaarg *maa;
2867 	struct sbuf *sb;
2868 	int len;
2869 
2870 	if (ma == NULL) {
2871 		ma = malloc(sizeof *ma, M_MOUNT, M_WAITOK | M_ZERO);
2872 		SLIST_INIT(&ma->list);
2873 	}
2874 	if (ma->error)
2875 		return (ma);
2876 
2877 	ma->v = realloc(ma->v, sizeof *ma->v * (ma->len + 2),
2878 	    M_MOUNT, M_WAITOK);
2879 	ma->v[ma->len].iov_base = (void *)(uintptr_t)name;
2880 	ma->v[ma->len].iov_len = strlen(name) + 1;
2881 	ma->len++;
2882 
2883 	sb = sbuf_new_auto();
2884 	va_start(ap, fmt);
2885 	sbuf_vprintf(sb, fmt, ap);
2886 	va_end(ap);
2887 	sbuf_finish(sb);
2888 	len = sbuf_len(sb) + 1;
2889 	maa = malloc(sizeof *maa + len, M_MOUNT, M_WAITOK | M_ZERO);
2890 	SLIST_INSERT_HEAD(&ma->list, maa, next);
2891 	bcopy(sbuf_data(sb), maa + 1, len);
2892 	sbuf_delete(sb);
2893 
2894 	ma->v[ma->len].iov_base = maa + 1;
2895 	ma->v[ma->len].iov_len = len;
2896 	ma->len++;
2897 
2898 	return (ma);
2899 }
2900 
2901 /*
2902  * Add an argument which is a userland string.
2903  */
2904 struct mntarg *
mount_argsu(struct mntarg * ma,const char * name,const void * val,int len)2905 mount_argsu(struct mntarg *ma, const char *name, const void *val, int len)
2906 {
2907 	struct mntaarg *maa;
2908 	char *tbuf;
2909 
2910 	if (val == NULL)
2911 		return (ma);
2912 	if (ma == NULL) {
2913 		ma = malloc(sizeof *ma, M_MOUNT, M_WAITOK | M_ZERO);
2914 		SLIST_INIT(&ma->list);
2915 	}
2916 	if (ma->error)
2917 		return (ma);
2918 	maa = malloc(sizeof *maa + len, M_MOUNT, M_WAITOK | M_ZERO);
2919 	SLIST_INSERT_HEAD(&ma->list, maa, next);
2920 	tbuf = (void *)(maa + 1);
2921 	ma->error = copyinstr(val, tbuf, len, NULL);
2922 	return (mount_arg(ma, name, tbuf, -1));
2923 }
2924 
2925 /*
2926  * Plain argument.
2927  *
2928  * If length is -1, treat value as a C string.
2929  */
2930 struct mntarg *
mount_arg(struct mntarg * ma,const char * name,const void * val,int len)2931 mount_arg(struct mntarg *ma, const char *name, const void *val, int len)
2932 {
2933 
2934 	if (ma == NULL) {
2935 		ma = malloc(sizeof *ma, M_MOUNT, M_WAITOK | M_ZERO);
2936 		SLIST_INIT(&ma->list);
2937 	}
2938 	if (ma->error)
2939 		return (ma);
2940 
2941 	ma->v = realloc(ma->v, sizeof *ma->v * (ma->len + 2),
2942 	    M_MOUNT, M_WAITOK);
2943 	ma->v[ma->len].iov_base = (void *)(uintptr_t)name;
2944 	ma->v[ma->len].iov_len = strlen(name) + 1;
2945 	ma->len++;
2946 
2947 	ma->v[ma->len].iov_base = (void *)(uintptr_t)val;
2948 	if (len < 0)
2949 		ma->v[ma->len].iov_len = strlen(val) + 1;
2950 	else
2951 		ma->v[ma->len].iov_len = len;
2952 	ma->len++;
2953 	return (ma);
2954 }
2955 
2956 /*
2957  * Free a mntarg structure
2958  */
2959 static void
free_mntarg(struct mntarg * ma)2960 free_mntarg(struct mntarg *ma)
2961 {
2962 	struct mntaarg *maa;
2963 
2964 	while (!SLIST_EMPTY(&ma->list)) {
2965 		maa = SLIST_FIRST(&ma->list);
2966 		SLIST_REMOVE_HEAD(&ma->list, next);
2967 		free(maa, M_MOUNT);
2968 	}
2969 	free(ma->v, M_MOUNT);
2970 	free(ma, M_MOUNT);
2971 }
2972 
2973 /*
2974  * Mount a filesystem
2975  */
2976 int
kernel_mount(struct mntarg * ma,uint64_t flags)2977 kernel_mount(struct mntarg *ma, uint64_t flags)
2978 {
2979 	struct uio auio;
2980 	int error;
2981 
2982 	KASSERT(ma != NULL, ("kernel_mount NULL ma"));
2983 	KASSERT(ma->error != 0 || ma->v != NULL, ("kernel_mount NULL ma->v"));
2984 	KASSERT(!(ma->len & 1), ("kernel_mount odd ma->len (%d)", ma->len));
2985 
2986 	error = ma->error;
2987 	if (error == 0) {
2988 		auio.uio_iov = ma->v;
2989 		auio.uio_iovcnt = ma->len;
2990 		auio.uio_segflg = UIO_SYSSPACE;
2991 		error = vfs_donmount(curthread, flags, &auio);
2992 	}
2993 	free_mntarg(ma);
2994 	return (error);
2995 }
2996 
2997 /* Map from mount options to printable formats. */
2998 static struct mntoptnames optnames[] = {
2999 	MNTOPT_NAMES
3000 };
3001 
3002 #define DEVCTL_LEN 1024
3003 static void
mount_devctl_event(const char * type,struct mount * mp,bool donew)3004 mount_devctl_event(const char *type, struct mount *mp, bool donew)
3005 {
3006 	const uint8_t *cp;
3007 	struct mntoptnames *fp;
3008 	struct sbuf sb;
3009 	struct statfs *sfp = &mp->mnt_stat;
3010 	char *buf;
3011 
3012 	buf = malloc(DEVCTL_LEN, M_MOUNT, M_NOWAIT);
3013 	if (buf == NULL)
3014 		return;
3015 	sbuf_new(&sb, buf, DEVCTL_LEN, SBUF_FIXEDLEN);
3016 	sbuf_cpy(&sb, "mount-point=\"");
3017 	devctl_safe_quote_sb(&sb, sfp->f_mntonname);
3018 	sbuf_cat(&sb, "\" mount-dev=\"");
3019 	devctl_safe_quote_sb(&sb, sfp->f_mntfromname);
3020 	sbuf_cat(&sb, "\" mount-type=\"");
3021 	devctl_safe_quote_sb(&sb, sfp->f_fstypename);
3022 	sbuf_cat(&sb, "\" fsid=0x");
3023 	cp = (const uint8_t *)&sfp->f_fsid.val[0];
3024 	for (int i = 0; i < sizeof(sfp->f_fsid); i++)
3025 		sbuf_printf(&sb, "%02x", cp[i]);
3026 	sbuf_printf(&sb, " owner=%u flags=\"", sfp->f_owner);
3027 	for (fp = optnames; fp->o_opt != 0; fp++) {
3028 		if ((mp->mnt_flag & fp->o_opt) != 0) {
3029 			sbuf_cat(&sb, fp->o_name);
3030 			sbuf_putc(&sb, ';');
3031 		}
3032 	}
3033 	sbuf_putc(&sb, '"');
3034 	sbuf_finish(&sb);
3035 
3036 	/*
3037 	 * Options are not published because the form of the options depends on
3038 	 * the file system and may include binary data. In addition, they don't
3039 	 * necessarily provide enough useful information to be actionable when
3040 	 * devd processes them.
3041 	 */
3042 
3043 	if (sbuf_error(&sb) == 0)
3044 		devctl_notify("VFS", "FS", type, sbuf_data(&sb));
3045 	sbuf_delete(&sb);
3046 	free(buf, M_MOUNT);
3047 }
3048 
3049 /*
3050  * Force remount specified mount point to read-only.  The argument
3051  * must be busied to avoid parallel unmount attempts.
3052  *
3053  * Intended use is to prevent further writes if some metadata
3054  * inconsistency is detected.  Note that the function still flushes
3055  * all cached metadata and data for the mount point, which might be
3056  * not always suitable.
3057  */
3058 int
vfs_remount_ro(struct mount * mp)3059 vfs_remount_ro(struct mount *mp)
3060 {
3061 	struct vfsoptlist *opts;
3062 	struct vfsopt *opt;
3063 	struct vnode *vp_covered, *rootvp;
3064 	int error;
3065 
3066 	vfs_op_enter(mp);
3067 	KASSERT(mp->mnt_lockref > 0,
3068 	    ("vfs_remount_ro: mp %p is not busied", mp));
3069 	KASSERT((mp->mnt_kern_flag & MNTK_UNMOUNT) == 0,
3070 	    ("vfs_remount_ro: mp %p is being unmounted (and busy?)", mp));
3071 
3072 	rootvp = NULL;
3073 	vp_covered = mp->mnt_vnodecovered;
3074 	error = vget(vp_covered, LK_EXCLUSIVE | LK_NOWAIT);
3075 	if (error != 0) {
3076 		vfs_op_exit(mp);
3077 		return (error);
3078 	}
3079 	VI_LOCK(vp_covered);
3080 	if ((vp_covered->v_iflag & VI_MOUNT) != 0) {
3081 		VI_UNLOCK(vp_covered);
3082 		vput(vp_covered);
3083 		vfs_op_exit(mp);
3084 		return (EBUSY);
3085 	}
3086 	vp_covered->v_iflag |= VI_MOUNT;
3087 	VI_UNLOCK(vp_covered);
3088 	vn_seqc_write_begin(vp_covered);
3089 
3090 	MNT_ILOCK(mp);
3091 	if ((mp->mnt_flag & MNT_RDONLY) != 0) {
3092 		MNT_IUNLOCK(mp);
3093 		error = EBUSY;
3094 		goto out;
3095 	}
3096 	mp->mnt_flag |= MNT_UPDATE | MNT_FORCE | MNT_RDONLY;
3097 	rootvp = vfs_cache_root_clear(mp);
3098 	MNT_IUNLOCK(mp);
3099 
3100 	opts = malloc(sizeof(struct vfsoptlist), M_MOUNT, M_WAITOK | M_ZERO);
3101 	TAILQ_INIT(opts);
3102 	opt = malloc(sizeof(struct vfsopt), M_MOUNT, M_WAITOK | M_ZERO);
3103 	opt->name = strdup("ro", M_MOUNT);
3104 	opt->value = NULL;
3105 	TAILQ_INSERT_TAIL(opts, opt, link);
3106 	vfs_mergeopts(opts, mp->mnt_opt);
3107 	mp->mnt_optnew = opts;
3108 
3109 	error = VFS_MOUNT(mp);
3110 
3111 	if (error == 0) {
3112 		MNT_ILOCK(mp);
3113 		mp->mnt_flag &= ~(MNT_UPDATE | MNT_FORCE);
3114 		MNT_IUNLOCK(mp);
3115 		vfs_deallocate_syncvnode(mp);
3116 		if (mp->mnt_opt != NULL)
3117 			vfs_freeopts(mp->mnt_opt);
3118 		mp->mnt_opt = mp->mnt_optnew;
3119 	} else {
3120 		MNT_ILOCK(mp);
3121 		mp->mnt_flag &= ~(MNT_UPDATE | MNT_FORCE | MNT_RDONLY);
3122 		MNT_IUNLOCK(mp);
3123 		vfs_freeopts(mp->mnt_optnew);
3124 	}
3125 	mp->mnt_optnew = NULL;
3126 
3127 out:
3128 	vfs_op_exit(mp);
3129 	VI_LOCK(vp_covered);
3130 	vp_covered->v_iflag &= ~VI_MOUNT;
3131 	VI_UNLOCK(vp_covered);
3132 	vput(vp_covered);
3133 	vn_seqc_write_end(vp_covered);
3134 	if (rootvp != NULL) {
3135 		vn_seqc_write_end(rootvp);
3136 		vrele(rootvp);
3137 	}
3138 	return (error);
3139 }
3140 
3141 /*
3142  * Suspend write operations on all local writeable filesystems.  Does
3143  * full sync of them in the process.
3144  *
3145  * Iterate over the mount points in reverse order, suspending most
3146  * recently mounted filesystems first.  It handles a case where a
3147  * filesystem mounted from a md(4) vnode-backed device should be
3148  * suspended before the filesystem that owns the vnode.
3149  */
3150 void
suspend_all_fs(void)3151 suspend_all_fs(void)
3152 {
3153 	struct mount *mp;
3154 	int error;
3155 
3156 	mtx_lock(&mountlist_mtx);
3157 	TAILQ_FOREACH_REVERSE(mp, &mountlist, mntlist, mnt_list) {
3158 		error = vfs_busy(mp, MBF_MNTLSTLOCK | MBF_NOWAIT);
3159 		if (error != 0)
3160 			continue;
3161 		if ((mp->mnt_flag & (MNT_RDONLY | MNT_LOCAL)) != MNT_LOCAL ||
3162 		    (mp->mnt_kern_flag & MNTK_SUSPEND) != 0) {
3163 			mtx_lock(&mountlist_mtx);
3164 			vfs_unbusy(mp);
3165 			continue;
3166 		}
3167 		error = vfs_write_suspend(mp, 0);
3168 		if (error == 0) {
3169 			MNT_ILOCK(mp);
3170 			MPASS((mp->mnt_kern_flag & MNTK_SUSPEND_ALL) == 0);
3171 			mp->mnt_kern_flag |= MNTK_SUSPEND_ALL;
3172 			MNT_IUNLOCK(mp);
3173 			mtx_lock(&mountlist_mtx);
3174 		} else {
3175 			printf("suspend of %s failed, error %d\n",
3176 			    mp->mnt_stat.f_mntonname, error);
3177 			mtx_lock(&mountlist_mtx);
3178 			vfs_unbusy(mp);
3179 		}
3180 	}
3181 	mtx_unlock(&mountlist_mtx);
3182 }
3183 
3184 /*
3185  * Clone the mnt_exjail field to a new mount point.
3186  */
3187 void
vfs_exjail_clone(struct mount * inmp,struct mount * outmp)3188 vfs_exjail_clone(struct mount *inmp, struct mount *outmp)
3189 {
3190 	struct ucred *cr;
3191 	struct prison *pr;
3192 
3193 	MNT_ILOCK(inmp);
3194 	cr = inmp->mnt_exjail;
3195 	if (cr != NULL) {
3196 		crhold(cr);
3197 		MNT_IUNLOCK(inmp);
3198 		pr = cr->cr_prison;
3199 		sx_slock(&allprison_lock);
3200 		if (!prison_isalive(pr)) {
3201 			sx_sunlock(&allprison_lock);
3202 			crfree(cr);
3203 			return;
3204 		}
3205 		MNT_ILOCK(outmp);
3206 		if (outmp->mnt_exjail == NULL) {
3207 			outmp->mnt_exjail = cr;
3208 			atomic_add_int(&pr->pr_exportcnt, 1);
3209 			cr = NULL;
3210 		}
3211 		MNT_IUNLOCK(outmp);
3212 		sx_sunlock(&allprison_lock);
3213 		if (cr != NULL)
3214 			crfree(cr);
3215 	} else
3216 		MNT_IUNLOCK(inmp);
3217 }
3218 
3219 void
resume_all_fs(void)3220 resume_all_fs(void)
3221 {
3222 	struct mount *mp;
3223 
3224 	mtx_lock(&mountlist_mtx);
3225 	TAILQ_FOREACH(mp, &mountlist, mnt_list) {
3226 		if ((mp->mnt_kern_flag & MNTK_SUSPEND_ALL) == 0)
3227 			continue;
3228 		mtx_unlock(&mountlist_mtx);
3229 		MNT_ILOCK(mp);
3230 		MPASS((mp->mnt_kern_flag & MNTK_SUSPEND) != 0);
3231 		mp->mnt_kern_flag &= ~MNTK_SUSPEND_ALL;
3232 		MNT_IUNLOCK(mp);
3233 		vfs_write_resume(mp, 0);
3234 		mtx_lock(&mountlist_mtx);
3235 		vfs_unbusy(mp);
3236 	}
3237 	mtx_unlock(&mountlist_mtx);
3238 }
3239