lib/libzfs/libzfs_mount.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  */
  25
  26 /*
  27  * Routines to manage ZFS mounts.  We separate all the nasty routines that have
  28  * to deal with the OS.  The following functions are the main entry points --
  29  * they are used by mount and unmount and when changing a filesystem's
  30  * mountpoint.
  31  *
  32  *      zfs_is_mounted()
  33  *      zfs_mount()
  34  *      zfs_unmount()
  35  *      zfs_unmountall()
  36  *
  37  * This file also contains the functions used to manage sharing filesystems via
  38  * NFS and iSCSI:
  39  *
  40  *      zfs_is_shared()
  41  *      zfs_share()
  42  *      zfs_unshare()
  43  *
  44  *      zfs_is_shared_nfs()
  45  *      zfs_is_shared_smb()
  46  *      zfs_share_proto()
  47  *      zfs_shareall();
  48  *      zfs_unshare_nfs()
  49  *      zfs_unshare_smb()
  50  *      zfs_unshareall_nfs()
  51  *      zfs_unshareall_smb()
  52  *      zfs_unshareall()
  53  *      zfs_unshareall_bypath()
  54  *
  55  * The following functions are available for pool consumers, and will
  56  * mount/unmount and share/unshare all datasets within pool:
  57  *
  58  *      zpool_enable_datasets()
  59  *      zpool_disable_datasets()
  60  */
  61
  62 #include <dirent.h>
  63 #include <dlfcn.h>
  64 #include <errno.h>
  65 #include <libgen.h>
  66 #include <libintl.h>
  67 #include <stdio.h>
  68 #include <stdlib.h>
  69 #include <strings.h>
  70 #include <unistd.h>
  71 #include <zone.h>
  72 #include <sys/mntent.h>
  73 #include <sys/mount.h>
  74 #include <sys/stat.h>
  75
  76 #include <libzfs.h>
  77
  78 #include "libzfs_impl.h"
  79
  80 #include <libshare.h>
  81 #include <sys/systeminfo.h>
  82 #define MAXISALEN       257     /* based on sysinfo(2) man page */
  83
  84 static int zfs_share_proto(zfs_handle_t *, zfs_share_proto_t *);
  85 zfs_share_type_t zfs_is_shared_proto(zfs_handle_t *, char **,
  86     zfs_share_proto_t);
  87
  88 /*
  89  * The share protocols table must be in the same order as the zfs_share_prot_t
  90  * enum in libzfs_impl.h
  91  */
  92 typedef struct {
  93         zfs_prop_t p_prop;
  94         char *p_name;
  95         int p_share_err;
  96         int p_unshare_err;
  97 } proto_table_t;
  98
  99 proto_table_t proto_table[PROTO_END] = {
 100         {ZFS_PROP_SHARENFS, "nfs", EZFS_SHARENFSFAILED, EZFS_UNSHARENFSFAILED},
 101         {ZFS_PROP_SHARESMB, "smb", EZFS_SHARESMBFAILED, EZFS_UNSHARESMBFAILED},
 102 };
 103
 104 zfs_share_proto_t nfs_only[] = {
 105         PROTO_NFS,
 106         PROTO_END
 107 };
 108
 109 zfs_share_proto_t smb_only[] = {
 110         PROTO_SMB,
 111         PROTO_END
 112 };
 113 zfs_share_proto_t share_all_proto[] = {
 114         PROTO_NFS,
 115         PROTO_SMB,
 116         PROTO_END
 117 };
 118
 119 /*
 120  * Search the sharetab for the given mountpoint and protocol, returning
 121  * a zfs_share_type_t value.
 122  */
 123 static zfs_share_type_t
 124 is_shared(libzfs_handle_t *hdl, const char *mountpoint, zfs_share_proto_t proto)
 125 {
 126         char buf[MAXPATHLEN], *tab;
 127         char *ptr;
 128
 129         if (hdl->libzfs_sharetab == NULL)
 130                 return (SHARED_NOT_SHARED);
 131
 132         (void) fseek(hdl->libzfs_sharetab, 0, SEEK_SET);
 133
 134         while (fgets(buf, sizeof (buf), hdl->libzfs_sharetab) != NULL) {
 135
 136                 /* the mountpoint is the first entry on each line */
 137                 if ((tab = strchr(buf, '\t')) == NULL)
 138                         continue;
 139
 140                 *tab = '\0';
 141                 if (strcmp(buf, mountpoint) == 0) {
 142                         /*
 143                          * the protocol field is the third field
 144                          * skip over second field
 145                          */
 146                         ptr = ++tab;
 147                         if ((tab = strchr(ptr, '\t')) == NULL)
 148                                 continue;
 149                         ptr = ++tab;
 150                         if ((tab = strchr(ptr, '\t')) == NULL)
 151                                 continue;
 152                         *tab = '\0';
 153                         if (strcmp(ptr,
 154                             proto_table[proto].p_name) == 0) {
 155                                 switch (proto) {
 156                                 case PROTO_NFS:
 157                                         return (SHARED_NFS);
 158                                 case PROTO_SMB:
 159                                         return (SHARED_SMB);
 160                                 default:
 161                                         return (0);
 162                                 }
 163                         }
 164                 }
 165         }
 166
 167         return (SHARED_NOT_SHARED);
 168 }
 169
 170 /*
 171  * Returns true if the specified directory is empty.  If we can't open the
 172  * directory at all, return true so that the mount can fail with a more
 173  * informative error message.
 174  */
 175 static boolean_t
 176 dir_is_empty(const char *dirname)
 177 {
 178         DIR *dirp;
 179         struct dirent64 *dp;
 180
 181         if ((dirp = opendir(dirname)) == NULL)
 182                 return (B_TRUE);
 183
 184         while ((dp = readdir64(dirp)) != NULL) {
 185
 186                 if (strcmp(dp->d_name, ".") == 0 ||
 187                     strcmp(dp->d_name, "..") == 0)
 188                         continue;
 189
 190                 (void) closedir(dirp);
 191                 return (B_FALSE);
 192         }
 193
 194         (void) closedir(dirp);
 195         return (B_TRUE);
 196 }
 197
 198 /*
 199  * Checks to see if the mount is active.  If the filesystem is mounted, we fill
 200  * in 'where' with the current mountpoint, and return 1.  Otherwise, we return
 201  * 0.
 202  */
 203 boolean_t
 204 is_mounted(libzfs_handle_t *zfs_hdl, const char *special, char **where)
 205 {
 206         struct mnttab entry;
 207
 208         if (libzfs_mnttab_find(zfs_hdl, special, &entry) != 0)
 209                 return (B_FALSE);
 210
 211         if (where != NULL)
 212                 *where = zfs_strdup(zfs_hdl, entry.mnt_mountp);
 213
 214         return (B_TRUE);
 215 }
 216
 217 boolean_t
 218 zfs_is_mounted(zfs_handle_t *zhp, char **where)
 219 {
 220         return (is_mounted(zhp->zfs_hdl, zfs_get_name(zhp), where));
 221 }
 222
 223 /*
 224  * Returns true if the given dataset is mountable, false otherwise.  Returns the
 225  * mountpoint in 'buf'.
 226  */
 227 static boolean_t
 228 zfs_is_mountable(zfs_handle_t *zhp, char *buf, size_t buflen,
 229     zprop_source_t *source)
 230 {
 231         char sourceloc[ZFS_MAXNAMELEN];
 232         zprop_source_t sourcetype;
 233
 234         if (!zfs_prop_valid_for_type(ZFS_PROP_MOUNTPOINT, zhp->zfs_type))
 235                 return (B_FALSE);
 236
 237         verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, buf, buflen,
 238             &sourcetype, sourceloc, sizeof (sourceloc), B_FALSE) == 0);
 239
 240         if (strcmp(buf, ZFS_MOUNTPOINT_NONE) == 0 ||
 241             strcmp(buf, ZFS_MOUNTPOINT_LEGACY) == 0)
 242                 return (B_FALSE);
 243
 244         if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == ZFS_CANMOUNT_OFF)
 245                 return (B_FALSE);
 246
 247         if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED) &&
 248             getzoneid() == GLOBAL_ZONEID)
 249                 return (B_FALSE);
 250
 251         if (source)
 252                 *source = sourcetype;
 253
 254         return (B_TRUE);
 255 }
 256
 257 /*
 258  * The filesystem is mounted by invoking the system mount utility rather
 259  * than by the system call mount(2).  This ensures that the /etc/mtab
 260  * file is correctly locked for the update.  Performing our own locking
 261  * and /etc/mtab update requires making an unsafe assumption about how
 262  * the mount utility performs its locking.  Unfortunately, this also means
 263  * in the case of a mount failure we do not have the exact errno.  We must
 264  * make due with return value from the mount process.
 265  *
 266  * In the long term a shared library called libmount is under development
 267  * which provides a common API to address the locking and errno issues.
 268  * Once the standard mount utility has been updated to use this library
 269  * we can add an autoconf check to conditionally use it.
 270  *
 271  * http://www.kernel.org/pub/linux/utils/util-linux/libmount-docs/index.html
 272  */
 273
 274 static int
 275 do_mount(const char *src, const char *mntpt, char *opts)
 276 {
 277         char *argv[8] = {
 278             "/bin/mount",
 279             "-t", MNTTYPE_ZFS,
 280             "-o", opts,
 281             (char *)src,
 282             (char *)mntpt,
 283             (char *)NULL };
 284         int rc;
 285
 286         /* Return only the most critical mount error */
 287         rc = libzfs_run_process(argv[0], argv, STDOUT_VERBOSE|STDERR_VERBOSE);
 288         if (rc) {
 289                 if (rc & MOUNT_FILEIO)
 290                         return EIO;
 291                 if (rc & MOUNT_USER)
 292                         return EINTR;
 293                 if (rc & MOUNT_SOFTWARE)
 294                         return EPIPE;
 295                 if (rc & MOUNT_SYSERR)
 296                         return EAGAIN;
 297                 if (rc & MOUNT_USAGE)
 298                         return EINVAL;
 299
 300                 return ENXIO; /* Generic error */
 301         }
 302
 303         return 0;
 304 }
 305
 306 static int
 307 do_unmount(const char *mntpt, int flags)
 308 {
 309         char force_opt[] = "-f";
 310         char lazy_opt[] = "-l";
 311         char *argv[7] = {
 312             "/bin/umount",
 313             "-t", MNTTYPE_ZFS,
 314             NULL, NULL, NULL, NULL };
 315         int rc, count = 3;
 316
 317         if (flags & MS_FORCE) {
 318                 argv[count] = force_opt;
 319                 count++;
 320         }
 321
 322         if (flags & MS_DETACH) {
 323                 argv[count] = lazy_opt;
 324                 count++;
 325         }
 326
 327         argv[count] = (char *)mntpt;
 328         rc = libzfs_run_process(argv[0], argv, STDOUT_VERBOSE|STDERR_VERBOSE);
 329
 330         return (rc ? EINVAL : 0);
 331 }
 332
 333 static int
 334 zfs_add_option(zfs_handle_t *zhp, char *options, int len,
 335     zfs_prop_t prop, char *on, char *off)
 336 {
 337         char *source;
 338         uint64_t value;
 339
 340         /* Skip adding duplicate default options */
 341         if ((strstr(options, on) != NULL) || (strstr(options, off) != NULL))
 342                 return (0);
 343
 344         /*
 345          * zfs_prop_get_int() to not used to ensure our mount options
 346          * are not influenced by the current /etc/mtab contents.
 347          */
 348         value = getprop_uint64(zhp, prop, &source);
 349
 350         (void) strlcat(options, ",", len);
 351         (void) strlcat(options, value ? on : off, len);
 352
 353         return (0);
 354 }
 355
 356 static int
 357 zfs_add_options(zfs_handle_t *zhp, char *options, int len)
 358 {
 359         int error = 0;
 360
 361         error = zfs_add_option(zhp, options, len,
 362             ZFS_PROP_ATIME, MNTOPT_ATIME, MNTOPT_NOATIME);
 363         error = error ? error : zfs_add_option(zhp, options, len,
 364             ZFS_PROP_DEVICES, MNTOPT_DEVICES, MNTOPT_NODEVICES);
 365         error = error ? error : zfs_add_option(zhp, options, len,
 366             ZFS_PROP_EXEC, MNTOPT_EXEC, MNTOPT_NOEXEC);
 367         error = error ? error : zfs_add_option(zhp, options, len,
 368             ZFS_PROP_READONLY, MNTOPT_RO, MNTOPT_RW);
 369         error = error ? error : zfs_add_option(zhp, options, len,
 370             ZFS_PROP_SETUID, MNTOPT_SETUID, MNTOPT_NOSETUID);
 371         error = error ? error : zfs_add_option(zhp, options, len,
 372             ZFS_PROP_XATTR, MNTOPT_XATTR, MNTOPT_NOXATTR);
 373         error = error ? error : zfs_add_option(zhp, options, len,
 374             ZFS_PROP_NBMAND, MNTOPT_NBMAND, MNTOPT_NONBMAND);
 375
 376         return (error);
 377 }
 378
 379 /*
 380  * Mount the given filesystem.
 381  */
 382 int
 383 zfs_mount(zfs_handle_t *zhp, const char *options, int flags)
 384 {
 385         struct stat buf;
 386         char mountpoint[ZFS_MAXPROPLEN];
 387         char mntopts[MNT_LINE_MAX];
 388         libzfs_handle_t *hdl = zhp->zfs_hdl;
 389         int remount = 0, rc;
 390
 391         if (options == NULL) {
 392                 (void) strlcpy(mntopts, MNTOPT_DEFAULTS, sizeof (mntopts));
 393         } else {
 394                 (void) strlcpy(mntopts, options, sizeof (mntopts));
 395         }
 396
 397         if (strstr(mntopts, MNTOPT_REMOUNT) != NULL)
 398                 remount = 1;
 399
 400         /*
 401          * If the pool is imported read-only then all mounts must be read-only
 402          */
 403         if (zpool_get_prop_int(zhp->zpool_hdl, ZPOOL_PROP_READONLY, NULL))
 404                 (void) strlcat(mntopts, "," MNTOPT_RO, sizeof (mntopts));
 405
 406         /*
 407          * Append default mount options which apply to the mount point.
 408          * This is done because under Linux (unlike Solaris) multiple mount
 409          * points may reference a single super block.  This means that just
 410          * given a super block there is no back reference to update the per
 411          * mount point options.
 412          */
 413         rc = zfs_add_options(zhp, mntopts, sizeof (mntopts));
 414         if (rc) {
 415                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
 416                     "default options unavailable"));
 417                 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
 418                     dgettext(TEXT_DOMAIN, "cannot mount '%s'"),
 419                     mountpoint));
 420         }
 421
 422         /*
 423          * Append zfsutil option so the mount helper allow the mount
 424          */
 425         strlcat(mntopts, "," MNTOPT_ZFSUTIL, sizeof (mntopts));
 426
 427         if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint), NULL))
 428                 return (0);
 429
 430         /* Create the directory if it doesn't already exist */
 431         if (lstat(mountpoint, &buf) != 0) {
 432                 if (mkdirp(mountpoint, 0755) != 0) {
 433                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
 434                             "failed to create mountpoint"));
 435                         return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
 436                             dgettext(TEXT_DOMAIN, "cannot mount '%s'"),
 437                             mountpoint));
 438                 }
 439         }
 440
 441         /*
 442          * Determine if the mountpoint is empty.  If so, refuse to perform the
 443          * mount.  We don't perform this check if 'remount' is specified.
 444          */
 445         if (!remount && !dir_is_empty(mountpoint)) {
 446                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
 447                     "directory is not empty"));
 448                 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
 449                     dgettext(TEXT_DOMAIN, "cannot mount '%s'"), mountpoint));
 450         }
 451
 452         /* perform the mount */
 453         rc = do_mount(zfs_get_name(zhp), mountpoint, mntopts);
 454         if (rc) {
 455                 /*
 456                  * Generic errors are nasty, but there are just way too many
 457                  * from mount(), and they're well-understood.  We pick a few
 458                  * common ones to improve upon.
 459                  */
 460                 if (rc == EBUSY) {
 461                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
 462                             "mountpoint or dataset is busy"));
 463                 } else if (rc == EPERM) {
 464                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
 465                             "Insufficient privileges"));
 466                 } else if (rc == ENOTSUP) {
 467                         char buf[256];
 468                         int spa_version;
 469
 470                         VERIFY(zfs_spa_version(zhp, &spa_version) == 0);
 471                         (void) snprintf(buf, sizeof (buf),
 472                             dgettext(TEXT_DOMAIN, "Can't mount a version %lld "
 473                             "file system on a version %d pool. Pool must be"
 474                             " upgraded to mount this file system."),
 475                             (u_longlong_t)zfs_prop_get_int(zhp,
 476                             ZFS_PROP_VERSION), spa_version);
 477                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, buf));
 478                 } else {
 479                         zfs_error_aux(hdl, strerror(rc));
 480                 }
 481                 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
 482                     dgettext(TEXT_DOMAIN, "cannot mount '%s'"),
 483                     zhp->zfs_name));
 484         }
 485
 486         /* remove the mounted entry before re-adding on remount */
 487         if (remount)
 488                 libzfs_mnttab_remove(hdl, zhp->zfs_name);
 489
 490         /* add the mounted entry into our cache */
 491         libzfs_mnttab_add(hdl, zfs_get_name(zhp), mountpoint, mntopts);
 492         return (0);
 493 }
 494
 495 /*
 496  * Unmount a single filesystem.
 497  */
 498 static int
 499 unmount_one(libzfs_handle_t *hdl, const char *mountpoint, int flags)
 500 {
 501         int error;
 502
 503         error = do_unmount(mountpoint, flags);
 504         if (error != 0) {
 505                 return (zfs_error_fmt(hdl, EZFS_UMOUNTFAILED,
 506                     dgettext(TEXT_DOMAIN, "cannot unmount '%s'"),
 507                     mountpoint));
 508         }
 509
 510         return (0);
 511 }
 512
 513 /*
 514  * Unmount the given filesystem.
 515  */
 516 int
 517 zfs_unmount(zfs_handle_t *zhp, const char *mountpoint, int flags)
 518 {
 519         libzfs_handle_t *hdl = zhp->zfs_hdl;
 520         struct mnttab entry;
 521         char *mntpt = NULL;
 522
 523         /* check to see if we need to unmount the filesystem */
 524         if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
 525             libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0)) {
 526                 /*
 527                  * mountpoint may have come from a call to
 528                  * getmnt/getmntany if it isn't NULL. If it is NULL,
 529                  * we know it comes from libzfs_mnttab_find which can
 530                  * then get freed later. We strdup it to play it safe.
 531                  */
 532                 if (mountpoint == NULL)
 533                         mntpt = zfs_strdup(hdl, entry.mnt_mountp);
 534                 else
 535                         mntpt = zfs_strdup(hdl, mountpoint);
 536
 537                 /*
 538                  * Unshare and unmount the filesystem
 539                  */
 540                 if (zfs_unshare_proto(zhp, mntpt, share_all_proto) != 0)
 541                         return (-1);
 542
 543                 if (unmount_one(hdl, mntpt, flags) != 0) {
 544                         free(mntpt);
 545                         (void) zfs_shareall(zhp);
 546                         return (-1);
 547                 }
 548                 libzfs_mnttab_remove(hdl, zhp->zfs_name);
 549                 free(mntpt);
 550         }
 551
 552         return (0);
 553 }
 554
 555 /*
 556  * Unmount this filesystem and any children inheriting the mountpoint property.
 557  * To do this, just act like we're changing the mountpoint property, but don't
 558  * remount the filesystems afterwards.
 559  */
 560 int
 561 zfs_unmountall(zfs_handle_t *zhp, int flags)
 562 {
 563         prop_changelist_t *clp;
 564         int ret;
 565
 566         clp = changelist_gather(zhp, ZFS_PROP_MOUNTPOINT, 0, flags);
 567         if (clp == NULL)
 568                 return (-1);
 569
 570         ret = changelist_prefix(clp);
 571         changelist_free(clp);
 572
 573         return (ret);
 574 }
 575
 576 boolean_t
 577 zfs_is_shared(zfs_handle_t *zhp)
 578 {
 579         zfs_share_type_t rc = 0;
 580         zfs_share_proto_t *curr_proto;
 581
 582         if (ZFS_IS_VOLUME(zhp))
 583                 return (B_FALSE);
 584
 585         for (curr_proto = share_all_proto; *curr_proto != PROTO_END;
 586             curr_proto++)
 587                 rc |= zfs_is_shared_proto(zhp, NULL, *curr_proto);
 588
 589         return (rc ? B_TRUE : B_FALSE);
 590 }
 591
 592 int
 593 zfs_share(zfs_handle_t *zhp)
 594 {
 595         assert(!ZFS_IS_VOLUME(zhp));
 596         return (zfs_share_proto(zhp, share_all_proto));
 597 }
 598
 599 int
 600 zfs_unshare(zfs_handle_t *zhp)
 601 {
 602         assert(!ZFS_IS_VOLUME(zhp));
 603         return (zfs_unshareall(zhp));
 604 }
 605
 606 /*
 607  * Check to see if the filesystem is currently shared.
 608  */
 609 zfs_share_type_t
 610 zfs_is_shared_proto(zfs_handle_t *zhp, char **where, zfs_share_proto_t proto)
 611 {
 612         char *mountpoint;
 613         zfs_share_type_t rc;
 614
 615         if (!zfs_is_mounted(zhp, &mountpoint))
 616                 return (SHARED_NOT_SHARED);
 617
 618         if ((rc = is_shared(zhp->zfs_hdl, mountpoint, proto))) {
 619                 if (where != NULL)
 620                         *where = mountpoint;
 621                 else
 622                         free(mountpoint);
 623                 return (rc);
 624         } else {
 625                 free(mountpoint);
 626                 return (SHARED_NOT_SHARED);
 627         }
 628 }
 629
 630 boolean_t
 631 zfs_is_shared_nfs(zfs_handle_t *zhp, char **where)
 632 {
 633         return (zfs_is_shared_proto(zhp, where,
 634             PROTO_NFS) != SHARED_NOT_SHARED);
 635 }
 636
 637 boolean_t
 638 zfs_is_shared_smb(zfs_handle_t *zhp, char **where)
 639 {
 640         return (zfs_is_shared_proto(zhp, where,
 641             PROTO_SMB) != SHARED_NOT_SHARED);
 642 }
 643
 644 /*
 645  * zfs_init_libshare(zhandle, service)
 646  *
 647  * Initialize the libshare API if it hasn't already been initialized.
 648  * In all cases it returns 0 if it succeeded and an error if not. The
 649  * service value is which part(s) of the API to initialize and is a
 650  * direct map to the libshare sa_init(service) interface.
 651  */
 652 int
 653 zfs_init_libshare(libzfs_handle_t *zhandle, int service)
 654 {
 655         int ret = SA_OK;
 656
 657         if (ret == SA_OK && zhandle->libzfs_shareflags & ZFSSHARE_MISS) {
 658                 /*
 659                  * We had a cache miss. Most likely it is a new ZFS
 660                  * dataset that was just created. We want to make sure
 661                  * so check timestamps to see if a different process
 662                  * has updated any of the configuration. If there was
 663                  * some non-ZFS change, we need to re-initialize the
 664                  * internal cache.
 665                  */
 666                 zhandle->libzfs_shareflags &= ~ZFSSHARE_MISS;
 667                 if (sa_needs_refresh(zhandle->libzfs_sharehdl)) {
 668                         zfs_uninit_libshare(zhandle);
 669                         zhandle->libzfs_sharehdl = sa_init(service);
 670                 }
 671         }
 672
 673         if (ret == SA_OK && zhandle && zhandle->libzfs_sharehdl == NULL)
 674                 zhandle->libzfs_sharehdl = sa_init(service);
 675
 676         if (ret == SA_OK && zhandle->libzfs_sharehdl == NULL)
 677                 ret = SA_NO_MEMORY;
 678
 679         return (ret);
 680 }
 681
 682 /*
 683  * zfs_uninit_libshare(zhandle)
 684  *
 685  * Uninitialize the libshare API if it hasn't already been
 686  * uninitialized. It is OK to call multiple times.
 687  */
 688 void
 689 zfs_uninit_libshare(libzfs_handle_t *zhandle)
 690 {
 691         if (zhandle != NULL && zhandle->libzfs_sharehdl != NULL) {
 692                 sa_fini(zhandle->libzfs_sharehdl);
 693                 zhandle->libzfs_sharehdl = NULL;
 694         }
 695 }
 696
 697 /*
 698  * zfs_parse_options(options, proto)
 699  *
 700  * Call the legacy parse interface to get the protocol specific
 701  * options using the NULL arg to indicate that this is a "parse" only.
 702  */
 703 int
 704 zfs_parse_options(char *options, zfs_share_proto_t proto)
 705 {
 706         return (sa_parse_legacy_options(NULL, options,
 707             proto_table[proto].p_name));
 708 }
 709
 710 /*
 711  * Share the given filesystem according to the options in the specified
 712  * protocol specific properties (sharenfs, sharesmb).  We rely
 713  * on "libshare" to the dirty work for us.
 714  */
 715 static int
 716 zfs_share_proto(zfs_handle_t *zhp, zfs_share_proto_t *proto)
 717 {
 718         char mountpoint[ZFS_MAXPROPLEN];
 719         char shareopts[ZFS_MAXPROPLEN];
 720         char sourcestr[ZFS_MAXPROPLEN];
 721         libzfs_handle_t *hdl = zhp->zfs_hdl;
 722         sa_share_t share;
 723         zfs_share_proto_t *curr_proto;
 724         zprop_source_t sourcetype;
 725         int ret;
 726
 727         if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint), NULL))
 728                 return (0);
 729
 730         if ((ret = zfs_init_libshare(hdl, SA_INIT_SHARE_API)) != SA_OK) {
 731                 (void) zfs_error_fmt(hdl, EZFS_SHARENFSFAILED,
 732                     dgettext(TEXT_DOMAIN, "cannot share '%s': %s"),
 733                     zfs_get_name(zhp), sa_errorstr(ret));
 734                 return (-1);
 735         }
 736
 737         for (curr_proto = proto; *curr_proto != PROTO_END; curr_proto++) {
 738                 /*
 739                  * Return success if there are no share options.
 740                  */
 741                 if (zfs_prop_get(zhp, proto_table[*curr_proto].p_prop,
 742                     shareopts, sizeof (shareopts), &sourcetype, sourcestr,
 743                     ZFS_MAXPROPLEN, B_FALSE) != 0 ||
 744                     strcmp(shareopts, "off") == 0)
 745                         continue;
 746
 747                 /*
 748                  * If the 'zoned' property is set, then zfs_is_mountable()
 749                  * will have already bailed out if we are in the global zone.
 750                  * But local zones cannot be NFS servers, so we ignore it for
 751                  * local zones as well.
 752                  */
 753                 if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED))
 754                         continue;
 755
 756                 share = sa_find_share(hdl->libzfs_sharehdl, mountpoint);
 757                 if (share == NULL) {
 758                         /*
 759                          * This may be a new file system that was just
 760                          * created so isn't in the internal cache
 761                          * (second time through). Rather than
 762                          * reloading the entire configuration, we can
 763                          * assume ZFS has done the checking and it is
 764                          * safe to add this to the internal
 765                          * configuration.
 766                          */
 767                         if (sa_zfs_process_share(hdl->libzfs_sharehdl,
 768                             NULL, NULL, mountpoint,
 769                             proto_table[*curr_proto].p_name, sourcetype,
 770                             shareopts, sourcestr, zhp->zfs_name) != SA_OK) {
 771                                 (void) zfs_error_fmt(hdl,
 772                                     proto_table[*curr_proto].p_share_err,
 773                                     dgettext(TEXT_DOMAIN, "cannot share '%s'"),
 774                                     zfs_get_name(zhp));
 775                                 return (-1);
 776                         }
 777                         hdl->libzfs_shareflags |= ZFSSHARE_MISS;
 778                         share = sa_find_share(hdl->libzfs_sharehdl,
 779                             mountpoint);
 780                 }
 781                 if (share != NULL) {
 782                         int err;
 783                         err = sa_enable_share(share,
 784                             proto_table[*curr_proto].p_name);
 785                         if (err != SA_OK) {
 786                                 (void) zfs_error_fmt(hdl,
 787                                     proto_table[*curr_proto].p_share_err,
 788                                     dgettext(TEXT_DOMAIN, "cannot share '%s'"),
 789                                     zfs_get_name(zhp));
 790                                 return (-1);
 791                         }
 792                 } else {
 793                         (void) zfs_error_fmt(hdl,
 794                             proto_table[*curr_proto].p_share_err,
 795                             dgettext(TEXT_DOMAIN, "cannot share '%s'"),
 796                             zfs_get_name(zhp));
 797                         return (-1);
 798                 }
 799
 800         }
 801         return (0);
 802 }
 803
 804
 805 int
 806 zfs_share_nfs(zfs_handle_t *zhp)
 807 {
 808         return (zfs_share_proto(zhp, nfs_only));
 809 }
 810
 811 int
 812 zfs_share_smb(zfs_handle_t *zhp)
 813 {
 814         return (zfs_share_proto(zhp, smb_only));
 815 }
 816
 817 int
 818 zfs_shareall(zfs_handle_t *zhp)
 819 {
 820         return (zfs_share_proto(zhp, share_all_proto));
 821 }
 822
 823 /*
 824  * Unshare a filesystem by mountpoint.
 825  */
 826 static int
 827 unshare_one(libzfs_handle_t *hdl, const char *name, const char *mountpoint,
 828     zfs_share_proto_t proto)
 829 {
 830         sa_share_t share;
 831         int err;
 832         char *mntpt;
 833         /*
 834          * Mountpoint could get trashed if libshare calls getmntany
 835          * which it does during API initialization, so strdup the
 836          * value.
 837          */
 838         mntpt = zfs_strdup(hdl, mountpoint);
 839
 840         /* make sure libshare initialized */
 841         if ((err = zfs_init_libshare(hdl, SA_INIT_SHARE_API)) != SA_OK) {
 842                 free(mntpt);    /* don't need the copy anymore */
 843                 return (zfs_error_fmt(hdl, EZFS_SHARENFSFAILED,
 844                     dgettext(TEXT_DOMAIN, "cannot unshare '%s': %s"),
 845                     name, sa_errorstr(err)));
 846         }
 847
 848         share = sa_find_share(hdl->libzfs_sharehdl, mntpt);
 849         free(mntpt);    /* don't need the copy anymore */
 850
 851         if (share != NULL) {
 852                 err = sa_disable_share(share, proto_table[proto].p_name);
 853                 if (err != SA_OK) {
 854                         return (zfs_error_fmt(hdl, EZFS_UNSHARENFSFAILED,
 855                             dgettext(TEXT_DOMAIN, "cannot unshare '%s': %s"),
 856                             name, sa_errorstr(err)));
 857                 }
 858         } else {
 859                 return (zfs_error_fmt(hdl, EZFS_UNSHARENFSFAILED,
 860                     dgettext(TEXT_DOMAIN, "cannot unshare '%s': not found"),
 861                     name));
 862         }
 863         return (0);
 864 }
 865
 866 /*
 867  * Unshare the given filesystem.
 868  */
 869 int
 870 zfs_unshare_proto(zfs_handle_t *zhp, const char *mountpoint,
 871     zfs_share_proto_t *proto)
 872 {
 873         libzfs_handle_t *hdl = zhp->zfs_hdl;
 874         struct mnttab entry;
 875         char *mntpt = NULL;
 876
 877         /* check to see if need to unmount the filesystem */
 878         rewind(zhp->zfs_hdl->libzfs_mnttab);
 879         if (mountpoint != NULL)
 880                 mountpoint = mntpt = zfs_strdup(hdl, mountpoint);
 881
 882         if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
 883             libzfs_mnttab_find(hdl, zfs_get_name(zhp), &entry) == 0)) {
 884                 zfs_share_proto_t *curr_proto;
 885
 886                 if (mountpoint == NULL)
 887                         mntpt = zfs_strdup(zhp->zfs_hdl, entry.mnt_mountp);
 888
 889                 for (curr_proto = proto; *curr_proto != PROTO_END;
 890                     curr_proto++) {
 891
 892                         if (is_shared(hdl, mntpt, *curr_proto) &&
 893                             unshare_one(hdl, zhp->zfs_name,
 894                             mntpt, *curr_proto) != 0) {
 895                                 if (mntpt != NULL)
 896                                         free(mntpt);
 897                                 return (-1);
 898                         }
 899                 }
 900         }
 901         if (mntpt != NULL)
 902                 free(mntpt);
 903
 904         return (0);
 905 }
 906
 907 int
 908 zfs_unshare_nfs(zfs_handle_t *zhp, const char *mountpoint)
 909 {
 910         return (zfs_unshare_proto(zhp, mountpoint, nfs_only));
 911 }
 912
 913 int
 914 zfs_unshare_smb(zfs_handle_t *zhp, const char *mountpoint)
 915 {
 916         return (zfs_unshare_proto(zhp, mountpoint, smb_only));
 917 }
 918
 919 /*
 920  * Same as zfs_unmountall(), but for NFS and SMB unshares.
 921  */
 922 int
 923 zfs_unshareall_proto(zfs_handle_t *zhp, zfs_share_proto_t *proto)
 924 {
 925         prop_changelist_t *clp;
 926         int ret;
 927
 928         clp = changelist_gather(zhp, ZFS_PROP_SHARENFS, 0, 0);
 929         if (clp == NULL)
 930                 return (-1);
 931
 932         ret = changelist_unshare(clp, proto);
 933         changelist_free(clp);
 934
 935         return (ret);
 936 }
 937
 938 int
 939 zfs_unshareall_nfs(zfs_handle_t *zhp)
 940 {
 941         return (zfs_unshareall_proto(zhp, nfs_only));
 942 }
 943
 944 int
 945 zfs_unshareall_smb(zfs_handle_t *zhp)
 946 {
 947         return (zfs_unshareall_proto(zhp, smb_only));
 948 }
 949
 950 int
 951 zfs_unshareall(zfs_handle_t *zhp)
 952 {
 953         return (zfs_unshareall_proto(zhp, share_all_proto));
 954 }
 955
 956 int
 957 zfs_unshareall_bypath(zfs_handle_t *zhp, const char *mountpoint)
 958 {
 959         return (zfs_unshare_proto(zhp, mountpoint, share_all_proto));
 960 }
 961
 962 /*
 963  * Remove the mountpoint associated with the current dataset, if necessary.
 964  * We only remove the underlying directory if:
 965  *
 966  *      - The mountpoint is not 'none' or 'legacy'
 967  *      - The mountpoint is non-empty
 968  *      - The mountpoint is the default or inherited
 969  *      - The 'zoned' property is set, or we're in a local zone
 970  *
 971  * Any other directories we leave alone.
 972  */
 973 void
 974 remove_mountpoint(zfs_handle_t *zhp)
 975 {
 976         char mountpoint[ZFS_MAXPROPLEN];
 977         zprop_source_t source;
 978
 979         if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint),
 980             &source))
 981                 return;
 982
 983         if (source == ZPROP_SRC_DEFAULT ||
 984             source == ZPROP_SRC_INHERITED) {
 985                 /*
 986                  * Try to remove the directory, silently ignoring any errors.
 987                  * The filesystem may have since been removed or moved around,
 988                  * and this error isn't really useful to the administrator in
 989                  * any way.
 990                  */
 991                 (void) rmdir(mountpoint);
 992         }
 993 }
 994
 995 void
 996 libzfs_add_handle(get_all_cb_t *cbp, zfs_handle_t *zhp)
 997 {
 998         if (cbp->cb_alloc == cbp->cb_used) {
 999                 size_t newsz;
1000                 void *ptr;
1001
1002                 newsz = cbp->cb_alloc ? cbp->cb_alloc * 2 : 64;
1003                 ptr = zfs_realloc(zhp->zfs_hdl,
1004                     cbp->cb_handles, cbp->cb_alloc * sizeof (void *),
1005                     newsz * sizeof (void *));
1006                 cbp->cb_handles = ptr;
1007                 cbp->cb_alloc = newsz;
1008         }
1009         cbp->cb_handles[cbp->cb_used++] = zhp;
1010 }
1011
1012 static int
1013 mount_cb(zfs_handle_t *zhp, void *data)
1014 {
1015         get_all_cb_t *cbp = data;
1016
1017         if (!(zfs_get_type(zhp) & ZFS_TYPE_FILESYSTEM)) {
1018                 zfs_close(zhp);
1019                 return (0);
1020         }
1021
1022         if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == ZFS_CANMOUNT_NOAUTO) {
1023                 zfs_close(zhp);
1024                 return (0);
1025         }
1026
1027         libzfs_add_handle(cbp, zhp);
1028         if (zfs_iter_filesystems(zhp, mount_cb, cbp) != 0) {
1029                 zfs_close(zhp);
1030                 return (-1);
1031         }
1032         return (0);
1033 }
1034
1035 int
1036 libzfs_dataset_cmp(const void *a, const void *b)
1037 {
1038         zfs_handle_t **za = (zfs_handle_t **)a;
1039         zfs_handle_t **zb = (zfs_handle_t **)b;
1040         char mounta[MAXPATHLEN];
1041         char mountb[MAXPATHLEN];
1042         boolean_t gota, gotb;
1043
1044         if ((gota = (zfs_get_type(*za) == ZFS_TYPE_FILESYSTEM)) != 0)
1045                 verify(zfs_prop_get(*za, ZFS_PROP_MOUNTPOINT, mounta,
1046                     sizeof (mounta), NULL, NULL, 0, B_FALSE) == 0);
1047         if ((gotb = (zfs_get_type(*zb) == ZFS_TYPE_FILESYSTEM)) != 0)
1048                 verify(zfs_prop_get(*zb, ZFS_PROP_MOUNTPOINT, mountb,
1049                     sizeof (mountb), NULL, NULL, 0, B_FALSE) == 0);
1050
1051         if (gota && gotb)
1052                 return (strcmp(mounta, mountb));
1053
1054         if (gota)
1055                 return (-1);
1056         if (gotb)
1057                 return (1);
1058
1059         return (strcmp(zfs_get_name(a), zfs_get_name(b)));
1060 }
1061
1062 /*
1063  * Mount and share all datasets within the given pool.  This assumes that no
1064  * datasets within the pool are currently mounted.  Because users can create
1065  * complicated nested hierarchies of mountpoints, we first gather all the
1066  * datasets and mountpoints within the pool, and sort them by mountpoint.  Once
1067  * we have the list of all filesystems, we iterate over them in order and mount
1068  * and/or share each one.
1069  */
1070 #pragma weak zpool_mount_datasets = zpool_enable_datasets
1071 int
1072 zpool_enable_datasets(zpool_handle_t *zhp, const char *mntopts, int flags)
1073 {
1074         get_all_cb_t cb = { 0 };
1075         libzfs_handle_t *hdl = zhp->zpool_hdl;
1076         zfs_handle_t *zfsp;
1077         int i, ret = -1;
1078         int *good;
1079
1080         /*
1081          * Gather all non-snap datasets within the pool.
1082          */
1083         if ((zfsp = zfs_open(hdl, zhp->zpool_name, ZFS_TYPE_DATASET)) == NULL)
1084                 goto out;
1085
1086         libzfs_add_handle(&cb, zfsp);
1087         if (zfs_iter_filesystems(zfsp, mount_cb, &cb) != 0)
1088                 goto out;
1089         /*
1090          * Sort the datasets by mountpoint.
1091          */
1092         qsort(cb.cb_handles, cb.cb_used, sizeof (void *),
1093             libzfs_dataset_cmp);
1094
1095         /*
1096          * And mount all the datasets, keeping track of which ones
1097          * succeeded or failed.
1098          */
1099         if ((good = zfs_alloc(zhp->zpool_hdl,
1100             cb.cb_used * sizeof (int))) == NULL)
1101                 goto out;
1102
1103         ret = 0;
1104         for (i = 0; i < cb.cb_used; i++) {
1105                 if (zfs_mount(cb.cb_handles[i], mntopts, flags) != 0)
1106                         ret = -1;
1107                 else
1108                         good[i] = 1;
1109         }
1110
1111         /*
1112          * Then share all the ones that need to be shared. This needs
1113          * to be a separate pass in order to avoid excessive reloading
1114          * of the configuration. Good should never be NULL since
1115          * zfs_alloc is supposed to exit if memory isn't available.
1116          */
1117         for (i = 0; i < cb.cb_used; i++) {
1118                 if (good[i] && zfs_share(cb.cb_handles[i]) != 0)
1119                         ret = -1;
1120         }
1121
1122         free(good);
1123
1124 out:
1125         for (i = 0; i < cb.cb_used; i++)
1126                 zfs_close(cb.cb_handles[i]);
1127         free(cb.cb_handles);
1128
1129         return (ret);
1130 }
1131
1132 static int
1133 mountpoint_compare(const void *a, const void *b)
1134 {
1135         const char *mounta = *((char **)a);
1136         const char *mountb = *((char **)b);
1137
1138         return (strcmp(mountb, mounta));
1139 }
1140
1141 /* alias for 2002/240 */
1142 #pragma weak zpool_unmount_datasets = zpool_disable_datasets
1143 /*
1144  * Unshare and unmount all datasets within the given pool.  We don't want to
1145  * rely on traversing the DSL to discover the filesystems within the pool,
1146  * because this may be expensive (if not all of them are mounted), and can fail
1147  * arbitrarily (on I/O error, for example).  Instead, we walk /etc/mtab and
1148  * gather all the filesystems that are currently mounted.
1149  */
1150 int
1151 zpool_disable_datasets(zpool_handle_t *zhp, boolean_t force)
1152 {
1153         int used, alloc;
1154         struct mnttab entry;
1155         size_t namelen;
1156         char **mountpoints = NULL;
1157         zfs_handle_t **datasets = NULL;
1158         libzfs_handle_t *hdl = zhp->zpool_hdl;
1159         int i;
1160         int ret = -1;
1161         int flags = (force ? MS_FORCE : 0);
1162
1163         namelen = strlen(zhp->zpool_name);
1164
1165         rewind(hdl->libzfs_mnttab);
1166         used = alloc = 0;
1167         while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
1168                 /*
1169                  * Ignore non-ZFS entries.
1170                  */
1171                 if (entry.mnt_fstype == NULL ||
1172                     strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
1173                         continue;
1174
1175                 /*
1176                  * Ignore filesystems not within this pool.
1177                  */
1178                 if (entry.mnt_mountp == NULL ||
1179                     strncmp(entry.mnt_special, zhp->zpool_name, namelen) != 0 ||
1180                     (entry.mnt_special[namelen] != '/' &&
1181                     entry.mnt_special[namelen] != '\0'))
1182                         continue;
1183
1184                 /*
1185                  * At this point we've found a filesystem within our pool.  Add
1186                  * it to our growing list.
1187                  */
1188                 if (used == alloc) {
1189                         if (alloc == 0) {
1190                                 if ((mountpoints = zfs_alloc(hdl,
1191                                     8 * sizeof (void *))) == NULL)
1192                                         goto out;
1193
1194                                 if ((datasets = zfs_alloc(hdl,
1195                                     8 * sizeof (void *))) == NULL)
1196                                         goto out;
1197
1198                                 alloc = 8;
1199                         } else {
1200                                 void *ptr;
1201
1202                                 if ((ptr = zfs_realloc(hdl, mountpoints,
1203                                     alloc * sizeof (void *),
1204                                     alloc * 2 * sizeof (void *))) == NULL)
1205                                         goto out;
1206                                 mountpoints = ptr;
1207
1208                                 if ((ptr = zfs_realloc(hdl, datasets,
1209                                     alloc * sizeof (void *),
1210                                     alloc * 2 * sizeof (void *))) == NULL)
1211                                         goto out;
1212                                 datasets = ptr;
1213
1214                                 alloc *= 2;
1215                         }
1216                 }
1217
1218                 if ((mountpoints[used] = zfs_strdup(hdl,
1219                     entry.mnt_mountp)) == NULL)
1220                         goto out;
1221
1222                 /*
1223                  * This is allowed to fail, in case there is some I/O error.  It
1224                  * is only used to determine if we need to remove the underlying
1225                  * mountpoint, so failure is not fatal.
1226                  */
1227                 datasets[used] = make_dataset_handle(hdl, entry.mnt_special);
1228
1229                 used++;
1230         }
1231
1232         /*
1233          * At this point, we have the entire list of filesystems, so sort it by
1234          * mountpoint.
1235          */
1236         qsort(mountpoints, used, sizeof (char *), mountpoint_compare);
1237
1238         /*
1239          * Walk through and first unshare everything.
1240          */
1241         for (i = 0; i < used; i++) {
1242                 zfs_share_proto_t *curr_proto;
1243                 for (curr_proto = share_all_proto; *curr_proto != PROTO_END;
1244                     curr_proto++) {
1245                         if (is_shared(hdl, mountpoints[i], *curr_proto) &&
1246                             unshare_one(hdl, mountpoints[i],
1247                             mountpoints[i], *curr_proto) != 0)
1248                                 goto out;
1249                 }
1250         }
1251
1252         /*
1253          * Now unmount everything, removing the underlying directories as
1254          * appropriate.
1255          */
1256         for (i = 0; i < used; i++) {
1257                 if (unmount_one(hdl, mountpoints[i], flags) != 0)
1258                         goto out;
1259         }
1260
1261         for (i = 0; i < used; i++) {
1262                 if (datasets[i])
1263                         remove_mountpoint(datasets[i]);
1264         }
1265
1266         ret = 0;
1267 out:
1268         for (i = 0; i < used; i++) {
1269                 if (datasets[i])
1270                         zfs_close(datasets[i]);
1271                 free(mountpoints[i]);
1272         }
1273         free(datasets);
1274         free(mountpoints);
1275
1276         return (ret);
1277 }