4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2011 Lawrence Livermore National Security, LLC.
30 #include <sys/mount.h>
33 #ifdef HAVE_LIBSELINUX
34 #include <selinux/selinux.h>
35 #endif /* HAVE_LIBSELINUX */
37 libzfs_handle_t *g_zfs;
39 typedef struct option_map {
41 unsigned long mntmask;
42 unsigned long zfsmask;
45 static const option_map_t option_map[] = {
46 /* Canonicalized filesystem independent options from mount(8) */
47 { MNTOPT_NOAUTO, MS_COMMENT, ZS_COMMENT },
48 { MNTOPT_DEFAULTS, MS_COMMENT, ZS_COMMENT },
49 { MNTOPT_NODEVICES, MS_NODEV, ZS_COMMENT },
50 { MNTOPT_DIRSYNC, MS_DIRSYNC, ZS_COMMENT },
51 { MNTOPT_NOEXEC, MS_NOEXEC, ZS_COMMENT },
52 { MNTOPT_GROUP, MS_GROUP, ZS_COMMENT },
53 { MNTOPT_NETDEV, MS_COMMENT, ZS_COMMENT },
54 { MNTOPT_NOFAIL, MS_COMMENT, ZS_COMMENT },
55 { MNTOPT_NOSUID, MS_NOSUID, ZS_COMMENT },
56 { MNTOPT_OWNER, MS_OWNER, ZS_COMMENT },
57 { MNTOPT_REMOUNT, MS_REMOUNT, ZS_COMMENT },
58 { MNTOPT_RO, MS_RDONLY, ZS_COMMENT },
59 { MNTOPT_RW, MS_COMMENT, ZS_COMMENT },
60 { MNTOPT_SYNC, MS_SYNCHRONOUS, ZS_COMMENT },
61 { MNTOPT_USER, MS_USERS, ZS_COMMENT },
62 { MNTOPT_USERS, MS_USERS, ZS_COMMENT },
64 { MNTOPT_NOATIME, MS_NOATIME, ZS_COMMENT },
67 { MNTOPT_NODIRATIME, MS_NODIRATIME, ZS_COMMENT },
70 { MNTOPT_RELATIME, MS_RELATIME, ZS_COMMENT },
73 { MNTOPT_DFRATIME, MS_STRICTATIME, ZS_COMMENT },
75 { MNTOPT_CONTEXT, MS_COMMENT, ZS_NOCONTEXT },
76 { MNTOPT_NOCONTEXT, MS_COMMENT, ZS_NOCONTEXT },
77 { MNTOPT_FSCONTEXT, MS_COMMENT, ZS_NOCONTEXT },
78 { MNTOPT_DEFCONTEXT, MS_COMMENT, ZS_NOCONTEXT },
79 { MNTOPT_ROOTCONTEXT, MS_COMMENT, ZS_NOCONTEXT },
81 { MNTOPT_IVERSION, MS_I_VERSION, ZS_COMMENT },
84 { MNTOPT_NBMAND, MS_MANDLOCK, ZS_COMMENT },
86 /* Valid options not found in mount(8) */
87 { MNTOPT_BIND, MS_BIND, ZS_COMMENT },
89 { MNTOPT_RBIND, MS_BIND|MS_REC, ZS_COMMENT },
91 { MNTOPT_COMMENT, MS_COMMENT, ZS_COMMENT },
93 { MNTOPT_NOSUB, MS_NOSUB, ZS_COMMENT },
96 { MNTOPT_QUIET, MS_SILENT, ZS_COMMENT },
98 /* Custom zfs options */
99 { MNTOPT_XATTR, MS_COMMENT, ZS_COMMENT },
100 { MNTOPT_NOXATTR, MS_COMMENT, ZS_COMMENT },
101 { MNTOPT_ZFSUTIL, MS_COMMENT, ZS_ZFSUTIL },
105 * Break the mount option in to a name/value pair. The name is
106 * validated against the option map and mount flags set accordingly.
109 parse_option(char *mntopt, unsigned long *mntflags,
110 unsigned long *zfsflags, int sloppy)
112 const option_map_t *opt;
113 char *ptr, *name, *value = NULL;
116 name = strdup(mntopt);
120 for (ptr = name; ptr && *ptr; ptr++) {
124 VERIFY3P(value, !=, NULL);
129 for (opt = option_map; opt->name != NULL; opt++) {
130 if (strncmp(name, opt->name, strlen(name)) == 0) {
131 *mntflags |= opt->mntmask;
132 *zfsflags |= opt->zfsmask;
134 /* MS_USERS implies default user options */
135 if (opt->mntmask & (MS_USERS))
136 *mntflags |= (MS_NOEXEC|MS_NOSUID|MS_NODEV);
138 /* MS_OWNER|MS_GROUP imply default owner options */
139 if (opt->mntmask & (MS_OWNER | MS_GROUP))
140 *mntflags |= (MS_NOSUID|MS_NODEV);
150 /* If required further process on the value may be done here */
156 * Translate the mount option string in to MS_* mount flags for the
157 * kernel vfs. When sloppy is non-zero unknown options will be ignored
158 * otherwise they are considered fatal are copied in to badopt.
161 parse_options(char *mntopts, unsigned long *mntflags, unsigned long *zfsflags,
162 int sloppy, char *badopt, char *mtabopt)
164 int error = 0, quote = 0, flag = 0, count = 0;
165 char *ptr, *opt, *opts;
167 opts = strdup(mntopts);
175 * Scan through all mount options which must be comma delimited.
176 * We must be careful to notice regions which are double quoted
177 * and skip commas in these regions. Each option is then checked
178 * to determine if it is a known option.
180 for (ptr = opts; ptr && !flag; ptr++) {
193 if ((*ptr == ',') || (*ptr == '\0')) {
196 error = parse_option(opt, mntflags, zfsflags, sloppy);
203 if (!(*mntflags & MS_REMOUNT) &&
204 !(*zfsflags & ZS_ZFSUTIL)) {
206 strlcat(mtabopt, ",", MNT_LINE_MAX);
208 strlcat(mtabopt, opt, MNT_LINE_MAX);
222 * If a file or directory in your current working directory is named
223 * 'dataset' then mount(8) will prepend your current working directory
224 * to dataset. The is no way to prevent this behavior so we simply
225 * check for it and strip the prepended patch when it is added.
228 parse_dataset(char *dataset)
233 if (getcwd(cwd, PATH_MAX) == NULL)
238 /* Do not add one when cwd already ends in a trailing '/' */
239 if (!strncmp(cwd, dataset, len))
240 return (dataset + len + (cwd[len-1] != '/'));
246 * Update the mtab_* code to use the libmount library when it is commonly
247 * available otherwise fallback to legacy mode. The mount(8) utility will
248 * manage the lock file for us to prevent racing updates to /etc/mtab.
251 mtab_is_writeable(void)
256 error = lstat(MNTTAB, &st);
257 if (error || S_ISLNK(st.st_mode))
260 fd = open(MNTTAB, O_RDWR | O_CREAT, 0644);
269 mtab_update(char *dataset, char *mntpoint, char *type, char *mntopts)
275 mnt.mnt_fsname = dataset;
276 mnt.mnt_dir = mntpoint;
278 mnt.mnt_opts = mntopts ? mntopts : "";
282 fp = setmntent(MNTTAB, "a+");
284 (void) fprintf(stderr, gettext(
285 "filesystem '%s' was mounted, but %s "
286 "could not be opened due to error %d\n"),
287 dataset, MNTTAB, errno);
288 return (MOUNT_FILEIO);
291 error = addmntent(fp, &mnt);
293 (void) fprintf(stderr, gettext(
294 "filesystem '%s' was mounted, but %s "
295 "could not be updated due to error %d\n"),
296 dataset, MNTTAB, errno);
297 return (MOUNT_FILEIO);
300 (void) endmntent(fp);
302 return (MOUNT_SUCCESS);
306 main(int argc, char **argv)
309 char legacy[ZFS_MAXPROPLEN];
310 char mntopts[MNT_LINE_MAX] = { '\0' };
311 char badopt[MNT_LINE_MAX] = { '\0' };
312 char mtabopt[MNT_LINE_MAX] = { '\0' };
313 char *dataset, *mntpoint;
314 unsigned long mntflags = 0, zfsflags = 0, remount_ro = 0;
315 int sloppy = 0, fake = 0, verbose = 0, nomtab = 0, zfsutil = 0;
318 (void) setlocale(LC_ALL, "");
319 (void) textdomain(TEXT_DOMAIN);
324 while ((c = getopt(argc, argv, "sfnvo:h?")) != -1) {
339 (void) strlcpy(mntopts, optarg, sizeof (mntopts));
343 (void) fprintf(stderr, gettext("Invalid option '%c'\n"),
345 (void) fprintf(stderr, gettext("Usage: mount.zfs "
346 "[-sfnv] [-o options] <dataset> <mountpoint>\n"));
347 return (MOUNT_USAGE);
354 /* check that we only have two arguments */
357 (void) fprintf(stderr, gettext("missing dataset "
360 (void) fprintf(stderr,
361 gettext("missing mountpoint argument\n"));
363 (void) fprintf(stderr, gettext("too many arguments\n"));
364 (void) fprintf(stderr, "usage: mount <dataset> <mountpoint>\n");
365 return (MOUNT_USAGE);
368 dataset = parse_dataset(argv[0]);
371 /* validate mount options and set mntflags */
372 error = parse_options(mntopts, &mntflags, &zfsflags, sloppy,
377 (void) fprintf(stderr, gettext("filesystem '%s' "
378 "cannot be mounted due to a memory allocation "
379 "failure.\n"), dataset);
380 return (MOUNT_SYSERR);
382 (void) fprintf(stderr, gettext("filesystem '%s' "
383 "cannot be mounted of due invalid option "
384 "'%s'.\n"), dataset, badopt);
385 (void) fprintf(stderr, gettext("Use the '-s' option "
386 "to ignore the bad mount option.\n"));
387 return (MOUNT_USAGE);
389 (void) fprintf(stderr, gettext("filesystem '%s' "
390 "cannot be mounted due to internal error %d.\n"),
392 return (MOUNT_SOFTWARE);
396 #ifdef HAVE_LIBSELINUX
398 * Automatically add the default zfs context when selinux is enabled
399 * and the caller has not specified their own context. This must be
400 * done until zfs is added to the default selinux policy configuration
401 * as a known filesystem type which supports xattrs.
403 if (is_selinux_enabled() && !(zfsflags & ZS_NOCONTEXT)) {
404 (void) strlcat(mntopts, ",context=\"system_u:"
405 "object_r:file_t:s0\"", sizeof (mntopts));
406 (void) strlcat(mtabopt, ",context=\"system_u:"
407 "object_r:file_t:s0\"", sizeof (mtabopt));
409 #endif /* HAVE_LIBSELINUX */
413 (void) fprintf(stdout, gettext("mount.zfs:\n"
414 " dataset: \"%s\"\n mountpoint: \"%s\"\n"
415 " mountflags: 0x%lx\n zfsflags: 0x%lx\n"
416 " mountopts: \"%s\"\n mtabopts: \"%s\"\n"),
417 dataset, mntpoint, mntflags, zfsflags, mntopts, mtabopt);
419 if (mntflags & MS_REMOUNT)
422 if ((mntflags & MS_REMOUNT) && (mntflags & MS_RDONLY))
425 if (zfsflags & ZS_ZFSUTIL)
428 if ((g_zfs = libzfs_init()) == NULL)
429 return (MOUNT_SYSERR);
431 /* try to open the dataset to access the mount point */
432 if ((zhp = zfs_open(g_zfs, dataset,
433 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT)) == NULL) {
434 (void) fprintf(stderr, gettext("filesystem '%s' cannot be "
435 "mounted, unable to open the dataset\n"), dataset);
437 return (MOUNT_USAGE);
440 /* treat all snapshots as legacy mount points */
441 if (zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT)
442 (void) strlcpy(legacy, ZFS_MOUNTPOINT_LEGACY, ZFS_MAXPROPLEN);
444 (void) zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, legacy,
445 sizeof (legacy), NULL, NULL, 0, B_FALSE);
451 * Legacy mount points may only be mounted using 'mount', never using
452 * 'zfs mount'. However, since 'zfs mount' actually invokes 'mount'
453 * we differentiate the two cases using the 'zfsutil' mount option.
454 * This mount option should only be supplied by the 'zfs mount' util.
456 * The only exception to the above rule is '-o remount,ro'. This is
457 * always allowed for non-legacy datasets for rc.sysinit/umountroot
458 * to safely remount the root filesystem and flush its cache.
460 if (zfsutil && !strcmp(legacy, ZFS_MOUNTPOINT_LEGACY)) {
461 (void) fprintf(stderr, gettext(
462 "filesystem '%s' cannot be mounted using 'zfs mount'.\n"
463 "Use 'zfs set mountpoint=%s' or 'mount -t zfs %s %s'.\n"
464 "See zfs(8) for more information.\n"),
465 dataset, mntpoint, dataset, mntpoint);
466 return (MOUNT_USAGE);
469 if (!zfsutil && strcmp(legacy, ZFS_MOUNTPOINT_LEGACY) && !remount_ro) {
470 (void) fprintf(stderr, gettext(
471 "filesystem '%s' cannot be mounted using 'mount'.\n"
472 "Use 'zfs set mountpoint=%s' or 'zfs mount %s'.\n"
473 "See zfs(8) for more information.\n"),
474 dataset, "legacy", dataset);
475 return (MOUNT_USAGE);
479 error = mount(dataset, mntpoint, MNTTYPE_ZFS,
484 (void) fprintf(stderr, gettext("filesystem "
485 "'%s' is already mounted\n"), dataset);
486 return (MOUNT_SYSERR);
488 (void) fprintf(stderr, gettext("filesystem "
489 "'%s' can not be mounted due to error "
490 "%d\n"), dataset, errno);
491 return (MOUNT_USAGE);
496 if (!nomtab && mtab_is_writeable()) {
497 error = mtab_update(dataset, mntpoint, MNTTYPE_ZFS, mtabopt);
502 return (MOUNT_SUCCESS);