cmd/mount_zfs/mount_zfs.c

   1 /*
   2  * CDDL HEADER START
   3  *
   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.
   7  *
   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.
  12  *
  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]
  18  *
  19  * CDDL HEADER END
  20  */
  21
  22 /*
  23  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Copyright (c) 2011 Lawrence Livermore National Security, LLC.
  25  */
  26
  27 #include <libintl.h>
  28 #include <unistd.h>
  29 #include <sys/file.h>
  30 #include <sys/mount.h>
  31 #include <sys/stat.h>
  32 #include <libzfs.h>
  33 #ifdef HAVE_LIBSELINUX
  34 #include <selinux/selinux.h>
  35 #endif /* HAVE_LIBSELINUX */
  36
  37 libzfs_handle_t *g_zfs;
  38
  39 typedef struct option_map {
  40         const char *name;
  41         unsigned long mntmask;
  42         unsigned long zfsmask;
  43 } option_map_t;
  44
  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      },
  63 #ifdef MS_NOATIME
  64         { MNTOPT_NOATIME,       MS_NOATIME,     ZS_COMMENT      },
  65 #endif
  66 #ifdef MS_NODIRATIME
  67         { MNTOPT_NODIRATIME,    MS_NODIRATIME,  ZS_COMMENT      },
  68 #endif
  69 #ifdef MS_RELATIME
  70         { MNTOPT_RELATIME,      MS_RELATIME,    ZS_COMMENT      },
  71 #endif
  72 #ifdef MS_STRICTATIME
  73         { MNTOPT_DFRATIME,      MS_STRICTATIME, ZS_COMMENT      },
  74 #endif
  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    },
  80 #ifdef MS_I_VERSION
  81         { MNTOPT_IVERSION,      MS_I_VERSION,   ZS_COMMENT      },
  82 #endif
  83 #ifdef MS_MANDLOCK
  84         { MNTOPT_NBMAND,        MS_MANDLOCK,    ZS_COMMENT      },
  85 #endif
  86         /* Valid options not found in mount(8) */
  87         { MNTOPT_BIND,          MS_BIND,        ZS_COMMENT      },
  88 #ifdef MS_REC
  89         { MNTOPT_RBIND,         MS_BIND|MS_REC, ZS_COMMENT      },
  90 #endif
  91         { MNTOPT_COMMENT,       MS_COMMENT,     ZS_COMMENT      },
  92 #ifdef MS_NOSUB
  93         { MNTOPT_NOSUB,         MS_NOSUB,       ZS_COMMENT      },
  94 #endif
  95 #ifdef MS_SILENT
  96         { MNTOPT_QUIET,         MS_SILENT,      ZS_COMMENT      },
  97 #endif
  98         /* Custom zfs options */
  99         { MNTOPT_NOXATTR,       MS_COMMENT,     ZS_COMMENT      },
 100         { MNTOPT_ZFSUTIL,       MS_COMMENT,     ZS_ZFSUTIL      },
 101         { NULL,                 0,              0               } };
 102
 103 /*
 104  * Break the mount option in to a name/value pair.  The name is
 105  * validated against the option map and mount flags set accordingly.
 106  */
 107 static int
 108 parse_option(char *mntopt, unsigned long *mntflags,
 109     unsigned long *zfsflags, int sloppy)
 110 {
 111         const option_map_t *opt;
 112         char *ptr, *name, *value = NULL;
 113         int error = 0;
 114
 115         name = strdup(mntopt);
 116         if (name == NULL)
 117                 return (ENOMEM);
 118
 119         for (ptr = name; ptr && *ptr; ptr++) {
 120                 if (*ptr == '=') {
 121                         *ptr = '\0';
 122                         value = ptr+1;
 123                         break;
 124                 }
 125         }
 126
 127         for (opt = option_map; opt->name != NULL; opt++) {
 128                 if (strncmp(name, opt->name, strlen(name)) == 0) {
 129                         *mntflags |= opt->mntmask;
 130                         *zfsflags |= opt->zfsmask;
 131
 132                         /* MS_USERS implies default user options */
 133                         if (opt->mntmask & (MS_USERS))
 134                                 *mntflags |= (MS_NOEXEC|MS_NOSUID|MS_NODEV);
 135
 136                         /* MS_OWNER|MS_GROUP imply default owner options */
 137                         if (opt->mntmask & (MS_OWNER | MS_GROUP))
 138                                 *mntflags |= (MS_NOSUID|MS_NODEV);
 139
 140                         error = 0;
 141                         goto out;
 142                 }
 143         }
 144
 145         if (!sloppy)
 146                 error = ENOENT;
 147 out:
 148         /* If required further process on the value may be done here */
 149         free(name);
 150         return (error);
 151 }
 152
 153 /*
 154  * Translate the mount option string in to MS_* mount flags for the
 155  * kernel vfs.  When sloppy is non-zero unknown options will be ignored
 156  * otherwise they are considered fatal are copied in to badopt.
 157  */
 158 static int
 159 parse_options(char *mntopts, unsigned long *mntflags, unsigned long *zfsflags,
 160     int sloppy, char *badopt, char *mtabopt)
 161 {
 162         int error = 0, quote = 0, flag = 0, count = 0;
 163         char *ptr, *opt, *opts;
 164
 165         opts = strdup(mntopts);
 166         if (opts == NULL)
 167                 return (ENOMEM);
 168
 169         *mntflags = 0;
 170         opt = NULL;
 171
 172         /*
 173          * Scan through all mount options which must be comma delimited.
 174          * We must be careful to notice regions which are double quoted
 175          * and skip commas in these regions.  Each option is then checked
 176          * to determine if it is a known option.
 177          */
 178         for (ptr = opts; ptr && !flag; ptr++) {
 179                 if (opt == NULL)
 180                         opt = ptr;
 181
 182                 if (*ptr == '"')
 183                         quote = !quote;
 184
 185                 if (quote)
 186                         continue;
 187
 188                 if (*ptr == '\0')
 189                         flag = 1;
 190
 191                 if ((*ptr == ',') || (*ptr == '\0')) {
 192                         *ptr = '\0';
 193
 194                         error = parse_option(opt, mntflags, zfsflags, sloppy);
 195                         if (error) {
 196                                 strcpy(badopt, opt);
 197                                 goto out;
 198
 199                         }
 200
 201                         if (!(*mntflags & MS_REMOUNT) &&
 202                             !(*zfsflags & ZS_ZFSUTIL)) {
 203                                 if (count > 0)
 204                                         strlcat(mtabopt, ",", MNT_LINE_MAX);
 205
 206                                 strlcat(mtabopt, opt, MNT_LINE_MAX);
 207                                 count++;
 208                         }
 209
 210                         opt = NULL;
 211                 }
 212         }
 213
 214 out:
 215         free(opts);
 216         return (error);
 217 }
 218
 219 /*
 220  * If a file or directory in your current working directory is named
 221  * 'dataset' then mount(8) will prepend your current working directory
 222  * to dataset.  The is no way to prevent this behavior so we simply
 223  * check for it and strip the prepended patch when it is added.
 224  */
 225 static char *
 226 parse_dataset(char *dataset)
 227 {
 228         char cwd[PATH_MAX];
 229         int len;
 230
 231         (void) getcwd(cwd, PATH_MAX);
 232         len = strlen(cwd);
 233
 234         /* Do not add one when cwd already ends in a trailing '/' */
 235         if (!strncmp(cwd, dataset, len))
 236                 return (dataset + len + (cwd[len-1] != '/'));
 237
 238         return (dataset);
 239 }
 240
 241 /*
 242  * Update the mtab_* code to use the libmount library when it is commonly
 243  * available otherwise fallback to legacy mode.  The mount(8) utility will
 244  * manage the lock file for us to prevent racing updates to /etc/mtab.
 245  */
 246 static int
 247 mtab_is_writeable(void)
 248 {
 249         struct stat st;
 250         int error, fd;
 251
 252         error = stat(MNTTAB, &st);
 253         if (error || S_ISLNK(st.st_mode))
 254                 return (0);
 255
 256         fd = open(MNTTAB, O_RDWR | O_CREAT, 0644);
 257         if (fd < 0)
 258                 return (0);
 259
 260         close(fd);
 261         return (1);
 262 }
 263
 264 static int
 265 mtab_update(char *dataset, char *mntpoint, char *type, char *mntopts)
 266 {
 267         struct mntent mnt;
 268         FILE *fp;
 269         int error;
 270
 271         mnt.mnt_fsname = dataset;
 272         mnt.mnt_dir = mntpoint;
 273         mnt.mnt_type = type;
 274         mnt.mnt_opts = mntopts ? mntopts : "";
 275         mnt.mnt_freq = 0;
 276         mnt.mnt_passno = 0;
 277
 278         fp = setmntent(MNTTAB, "a+");
 279         if (!fp) {
 280                 (void) fprintf(stderr, gettext(
 281                     "filesystem '%s' was mounted, but %s "
 282                     "could not be opened due to error %d\n"),
 283                     dataset, MNTTAB, errno);
 284                 return (MOUNT_FILEIO);
 285         }
 286
 287         error = addmntent(fp, &mnt);
 288         if (error) {
 289                 (void) fprintf(stderr, gettext(
 290                     "filesystem '%s' was mounted, but %s "
 291                     "could not be updated due to error %d\n"),
 292                     dataset, MNTTAB, errno);
 293                 return (MOUNT_FILEIO);
 294         }
 295
 296         (void) endmntent(fp);
 297
 298         return (MOUNT_SUCCESS);
 299 }
 300
 301 int
 302 main(int argc, char **argv)
 303 {
 304         zfs_handle_t *zhp;
 305         char legacy[ZFS_MAXPROPLEN];
 306         char mntopts[MNT_LINE_MAX] = { '\0' };
 307         char badopt[MNT_LINE_MAX] = { '\0' };
 308         char mtabopt[MNT_LINE_MAX] = { '\0' };
 309         char *dataset, *mntpoint;
 310         unsigned long mntflags = 0, zfsflags = 0, remount_ro = 0;
 311         int sloppy = 0, fake = 0, verbose = 0, nomtab = 0, zfsutil = 0;
 312         int error, c;
 313
 314         (void) setlocale(LC_ALL, "");
 315         (void) textdomain(TEXT_DOMAIN);
 316
 317         opterr = 0;
 318
 319         /* check options */
 320         while ((c = getopt(argc, argv, "sfnvo:h?")) != -1) {
 321                 switch (c) {
 322                 case 's':
 323                         sloppy = 1;
 324                         break;
 325                 case 'f':
 326                         fake = 1;
 327                         break;
 328                 case 'n':
 329                         nomtab = 1;
 330                         break;
 331                 case 'v':
 332                         verbose++;
 333                         break;
 334                 case 'o':
 335                         (void) strlcpy(mntopts, optarg, sizeof (mntopts));
 336                         break;
 337                 case 'h':
 338                 case '?':
 339                         (void) fprintf(stderr, gettext("Invalid option '%c'\n"),
 340                             optopt);
 341                         (void) fprintf(stderr, gettext("Usage: mount.zfs "
 342                             "[-sfnv] [-o options] <dataset> <mountpoint>\n"));
 343                         return (MOUNT_USAGE);
 344                 }
 345         }
 346
 347         argc -= optind;
 348         argv += optind;
 349
 350         /* check that we only have two arguments */
 351         if (argc != 2) {
 352                 if (argc == 0)
 353                         (void) fprintf(stderr, gettext("missing dataset "
 354                             "argument\n"));
 355                 else if (argc == 1)
 356                         (void) fprintf(stderr,
 357                             gettext("missing mountpoint argument\n"));
 358                 else
 359                         (void) fprintf(stderr, gettext("too many arguments\n"));
 360                 (void) fprintf(stderr, "usage: mount <dataset> <mountpoint>\n");
 361                 return (MOUNT_USAGE);
 362         }
 363
 364         dataset = parse_dataset(argv[0]);
 365         mntpoint = argv[1];
 366
 367         /* validate mount options and set mntflags */
 368         error = parse_options(mntopts, &mntflags, &zfsflags, sloppy,
 369             badopt, mtabopt);
 370         if (error) {
 371                 switch (error) {
 372                 case ENOMEM:
 373                         (void) fprintf(stderr, gettext("filesystem '%s' "
 374                             "cannot be mounted due to a memory allocation "
 375                             "failure.\n"), dataset);
 376                         return (MOUNT_SYSERR);
 377                 case ENOENT:
 378                         (void) fprintf(stderr, gettext("filesystem '%s' "
 379                             "cannot be mounted of due invalid option "
 380                             "'%s'.\n"), dataset, badopt);
 381                         (void) fprintf(stderr, gettext("Use the '-s' option "
 382                             "to ignore the bad mount option.\n"));
 383                         return (MOUNT_USAGE);
 384                 default:
 385                         (void) fprintf(stderr, gettext("filesystem '%s' "
 386                             "cannot be mounted due to internal error %d.\n"),
 387                             dataset, error);
 388                         return (MOUNT_SOFTWARE);
 389                 }
 390         }
 391
 392 #ifdef HAVE_LIBSELINUX
 393         /*
 394          * Automatically add the default zfs context when selinux is enabled
 395          * and the caller has not specified their own context.  This must be
 396          * done until zfs is added to the default selinux policy configuration
 397          * as a known filesystem type which supports xattrs.
 398          */
 399         if (is_selinux_enabled() && !(zfsflags & ZS_NOCONTEXT)) {
 400                 (void) strlcat(mntopts, ",context=\"system_u:"
 401                     "object_r:file_t:s0\"", sizeof (mntopts));
 402                 (void) strlcat(mtabopt, ",context=\"system_u:"
 403                     "object_r:file_t:s0\"", sizeof (mtabopt));
 404         }
 405 #endif /* HAVE_LIBSELINUX */
 406
 407
 408         if (verbose)
 409                 (void) fprintf(stdout, gettext("mount.zfs:\n"
 410                     "  dataset:    \"%s\"\n  mountpoint: \"%s\"\n"
 411                     "  mountflags: 0x%lx\n  zfsflags:   0x%lx\n"
 412                     "  mountopts:  \"%s\"\n  mtabopts:   \"%s\"\n"),
 413                     dataset, mntpoint, mntflags, zfsflags, mntopts, mtabopt);
 414
 415         if (mntflags & MS_REMOUNT)
 416                 nomtab = 1;
 417
 418         if ((mntflags & MS_REMOUNT) && (mntflags & MS_RDONLY))
 419                 remount_ro = 1;
 420
 421         if (zfsflags & ZS_ZFSUTIL)
 422                 zfsutil = 1;
 423
 424         if ((g_zfs = libzfs_init()) == NULL)
 425                 return (MOUNT_SYSERR);
 426
 427         /* try to open the dataset to access the mount point */
 428         if ((zhp = zfs_open(g_zfs, dataset, ZFS_TYPE_FILESYSTEM)) == NULL) {
 429                 (void) fprintf(stderr, gettext("filesystem '%s' cannot be "
 430                     "mounted, unable to open the dataset\n"), dataset);
 431                 libzfs_fini(g_zfs);
 432                 return (MOUNT_USAGE);
 433         }
 434
 435         (void) zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, legacy,
 436             sizeof (legacy), NULL, NULL, 0, B_FALSE);
 437
 438         zfs_close(zhp);
 439         libzfs_fini(g_zfs);
 440
 441         /*
 442          * Legacy mount points may only be mounted using 'mount', never using
 443          * 'zfs mount'.  However, since 'zfs mount' actually invokes 'mount'
 444          * we differentiate the two cases using the 'zfsutil' mount option.
 445          * This mount option should only be supplied by the 'zfs mount' util.
 446          *
 447          * The only exception to the above rule is '-o remount,ro'.  This is
 448          * always allowed for non-legacy datasets for rc.sysinit/umountroot
 449          * to safely remount the root filesystem and flush its cache.
 450          */
 451         if (zfsutil && !strcmp(legacy, ZFS_MOUNTPOINT_LEGACY)) {
 452                 (void) fprintf(stderr, gettext(
 453                     "filesystem '%s' cannot be mounted using 'zfs mount'.\n"
 454                     "Use 'zfs set mountpoint=%s' or 'mount -t zfs %s %s'.\n"
 455                     "See zfs(8) for more information.\n"),
 456                    dataset, mntpoint, dataset, mntpoint);
 457                 return (MOUNT_USAGE);
 458         }
 459
 460         if (!zfsutil && strcmp(legacy, ZFS_MOUNTPOINT_LEGACY) && !remount_ro) {
 461                 (void) fprintf(stderr, gettext(
 462                     "filesystem '%s' cannot be mounted using 'mount'.\n"
 463                     "Use 'zfs set mountpoint=%s' or 'zfs mount %s'.\n"
 464                     "See zfs(8) for more information.\n"),
 465                     dataset, "legacy", dataset);
 466                 return (MOUNT_USAGE);
 467         }
 468
 469         if (!fake) {
 470                 error = mount(dataset, mntpoint, MNTTYPE_ZFS,
 471                     mntflags, mntopts);
 472                 if (error) {
 473                         switch (errno) {
 474                         case EBUSY:
 475                                 (void) fprintf(stderr, gettext("filesystem "
 476                                     "'%s' is already mounted\n"), dataset);
 477                                 return (MOUNT_SYSERR);
 478                         default:
 479                                 (void) fprintf(stderr, gettext("filesystem "
 480                                     "'%s' can not be mounted due to error "
 481                                     "%d\n"), dataset, errno);
 482                                 return (MOUNT_USAGE);
 483                         }
 484                 }
 485         }
 486
 487         if (!nomtab && mtab_is_writeable()) {
 488                 error = mtab_update(dataset, mntpoint, MNTTYPE_ZFS, mtabopt);
 489                 if (error)
 490                         return (error);
 491         }
 492
 493         return (MOUNT_SUCCESS);
 494 }