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 2015 Nexenta Systems, Inc. All rights reserved.
24 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
25 * Copyright (c) 2014 by Delphix. All rights reserved.
26 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
27 * Copyright 2017 RackTop Systems.
31 * Routines to manage ZFS mounts. We separate all the nasty routines that have
32 * to deal with the OS. The following functions are the main entry points --
33 * they are used by mount and unmount and when changing a filesystem's
41 * This file also contains the functions used to manage sharing filesystems via
54 * zfs_unshareall_nfs()
55 * zfs_unshareall_smb()
57 * zfs_unshareall_bypath()
59 * The following functions are available for pool consumers, and will
60 * mount/unmount and share/unshare all datasets within pool:
62 * zpool_enable_datasets()
63 * zpool_disable_datasets()
76 #include <sys/mntent.h>
77 #include <sys/mount.h>
82 #include "libzfs_impl.h"
85 #define MAXISALEN 257 /* based on sysinfo(2) man page */
87 static int zfs_share_proto(zfs_handle_t *, zfs_share_proto_t *);
88 zfs_share_type_t zfs_is_shared_proto(zfs_handle_t *, char **,
92 * The share protocols table must be in the same order as the zfs_share_proto_t
93 * enum in libzfs_impl.h
102 proto_table_t proto_table[PROTO_END] = {
103 {ZFS_PROP_SHARENFS, "nfs", EZFS_SHARENFSFAILED, EZFS_UNSHARENFSFAILED},
104 {ZFS_PROP_SHARESMB, "smb", EZFS_SHARESMBFAILED, EZFS_UNSHARESMBFAILED},
107 zfs_share_proto_t nfs_only[] = {
112 zfs_share_proto_t smb_only[] = {
116 zfs_share_proto_t share_all_proto[] = {
123 * Search the sharetab for the given mountpoint and protocol, returning
124 * a zfs_share_type_t value.
126 static zfs_share_type_t
127 is_shared(libzfs_handle_t *hdl, const char *mountpoint, zfs_share_proto_t proto)
129 char buf[MAXPATHLEN], *tab;
132 if (hdl->libzfs_sharetab == NULL)
133 return (SHARED_NOT_SHARED);
135 (void) fseek(hdl->libzfs_sharetab, 0, SEEK_SET);
137 while (fgets(buf, sizeof (buf), hdl->libzfs_sharetab) != NULL) {
139 /* the mountpoint is the first entry on each line */
140 if ((tab = strchr(buf, '\t')) == NULL)
144 if (strcmp(buf, mountpoint) == 0) {
147 * the protocol field is the third field
148 * skip over second field
151 if ((tab = strchr(ptr, '\t')) == NULL)
154 if ((tab = strchr(ptr, '\t')) == NULL)
158 proto_table[proto].p_name) == 0) {
169 if (proto == PROTO_NFS)
175 return (SHARED_NOT_SHARED);
180 * Returns true if the specified directory is empty. If we can't open the
181 * directory at all, return true so that the mount can fail with a more
182 * informative error message.
185 dir_is_empty(const char *dirname)
190 if ((dirp = opendir(dirname)) == NULL)
193 while ((dp = readdir64(dirp)) != NULL) {
195 if (strcmp(dp->d_name, ".") == 0 ||
196 strcmp(dp->d_name, "..") == 0)
199 (void) closedir(dirp);
203 (void) closedir(dirp);
209 * Checks to see if the mount is active. If the filesystem is mounted, we fill
210 * in 'where' with the current mountpoint, and return 1. Otherwise, we return
214 is_mounted(libzfs_handle_t *zfs_hdl, const char *special, char **where)
218 if (libzfs_mnttab_find(zfs_hdl, special, &entry) != 0)
222 *where = zfs_strdup(zfs_hdl, entry.mnt_mountp);
228 zfs_is_mounted(zfs_handle_t *zhp, char **where)
230 return (is_mounted(zhp->zfs_hdl, zfs_get_name(zhp), where));
234 * Returns true if the given dataset is mountable, false otherwise. Returns the
235 * mountpoint in 'buf'.
238 zfs_is_mountable(zfs_handle_t *zhp, char *buf, size_t buflen,
239 zprop_source_t *source)
241 char sourceloc[MAXNAMELEN];
242 zprop_source_t sourcetype;
244 if (!zfs_prop_valid_for_type(ZFS_PROP_MOUNTPOINT, zhp->zfs_type))
247 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, buf, buflen,
248 &sourcetype, sourceloc, sizeof (sourceloc), B_FALSE) == 0);
250 if (strcmp(buf, ZFS_MOUNTPOINT_NONE) == 0 ||
251 strcmp(buf, ZFS_MOUNTPOINT_LEGACY) == 0)
254 if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == ZFS_CANMOUNT_OFF)
257 if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED) &&
258 getzoneid() == GLOBAL_ZONEID)
262 *source = sourcetype;
268 * Mount the given filesystem.
271 zfs_mount(zfs_handle_t *zhp, const char *options, int flags)
274 char mountpoint[ZFS_MAXPROPLEN];
275 char mntopts[MNT_LINE_MAX];
276 libzfs_handle_t *hdl = zhp->zfs_hdl;
281 (void) strlcpy(mntopts, options, sizeof (mntopts));
284 * If the pool is imported read-only then all mounts must be read-only
286 if (zpool_get_prop_int(zhp->zpool_hdl, ZPOOL_PROP_READONLY, NULL))
289 if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint), NULL))
292 /* Create the directory if it doesn't already exist */
293 if (lstat(mountpoint, &buf) != 0) {
294 if (mkdirp(mountpoint, 0755) != 0) {
295 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
296 "failed to create mountpoint"));
297 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
298 dgettext(TEXT_DOMAIN, "cannot mount '%s'"),
303 #ifdef illumos /* FreeBSD: overlay mounts are not checked. */
305 * Determine if the mountpoint is empty. If so, refuse to perform the
306 * mount. We don't perform this check if MS_OVERLAY is specified, which
307 * would defeat the point. We also avoid this check if 'remount' is
310 if ((flags & MS_OVERLAY) == 0 &&
311 strstr(mntopts, MNTOPT_REMOUNT) == NULL &&
312 !dir_is_empty(mountpoint)) {
313 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
314 "directory is not empty"));
315 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
316 dgettext(TEXT_DOMAIN, "cannot mount '%s'"), mountpoint));
320 /* perform the mount */
321 if (zmount(zfs_get_name(zhp), mountpoint, flags,
322 MNTTYPE_ZFS, NULL, 0, mntopts, sizeof (mntopts)) != 0) {
324 * Generic errors are nasty, but there are just way too many
325 * from mount(), and they're well-understood. We pick a few
326 * common ones to improve upon.
328 if (errno == EBUSY) {
329 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
330 "mountpoint or dataset is busy"));
331 } else if (errno == EPERM) {
332 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
333 "Insufficient privileges"));
334 } else if (errno == ENOTSUP) {
338 VERIFY(zfs_spa_version(zhp, &spa_version) == 0);
339 (void) snprintf(buf, sizeof (buf),
340 dgettext(TEXT_DOMAIN, "Can't mount a version %lld "
341 "file system on a version %d pool. Pool must be"
342 " upgraded to mount this file system."),
343 (u_longlong_t)zfs_prop_get_int(zhp,
344 ZFS_PROP_VERSION), spa_version);
345 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, buf));
347 zfs_error_aux(hdl, strerror(errno));
349 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
350 dgettext(TEXT_DOMAIN, "cannot mount '%s'"),
354 /* add the mounted entry into our cache */
355 libzfs_mnttab_add(hdl, zfs_get_name(zhp), mountpoint,
361 * Unmount a single filesystem.
364 unmount_one(libzfs_handle_t *hdl, const char *mountpoint, int flags)
366 if (umount2(mountpoint, flags) != 0) {
367 zfs_error_aux(hdl, strerror(errno));
368 return (zfs_error_fmt(hdl, EZFS_UMOUNTFAILED,
369 dgettext(TEXT_DOMAIN, "cannot unmount '%s'"),
377 * Unmount the given filesystem.
380 zfs_unmount(zfs_handle_t *zhp, const char *mountpoint, int flags)
382 libzfs_handle_t *hdl = zhp->zfs_hdl;
386 /* check to see if we need to unmount the filesystem */
387 if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
388 libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0)) {
390 * mountpoint may have come from a call to
391 * getmnt/getmntany if it isn't NULL. If it is NULL,
392 * we know it comes from libzfs_mnttab_find which can
393 * then get freed later. We strdup it to play it safe.
395 if (mountpoint == NULL)
396 mntpt = zfs_strdup(hdl, entry.mnt_mountp);
398 mntpt = zfs_strdup(hdl, mountpoint);
401 * Unshare and unmount the filesystem
403 if (zfs_unshare_proto(zhp, mntpt, share_all_proto) != 0)
406 if (unmount_one(hdl, mntpt, flags) != 0) {
408 (void) zfs_shareall(zhp);
411 libzfs_mnttab_remove(hdl, zhp->zfs_name);
419 * Unmount this filesystem and any children inheriting the mountpoint property.
420 * To do this, just act like we're changing the mountpoint property, but don't
421 * remount the filesystems afterwards.
424 zfs_unmountall(zfs_handle_t *zhp, int flags)
426 prop_changelist_t *clp;
429 clp = changelist_gather(zhp, ZFS_PROP_MOUNTPOINT, 0, flags);
433 ret = changelist_prefix(clp);
434 changelist_free(clp);
440 zfs_is_shared(zfs_handle_t *zhp)
442 zfs_share_type_t rc = 0;
443 zfs_share_proto_t *curr_proto;
445 if (ZFS_IS_VOLUME(zhp))
448 for (curr_proto = share_all_proto; *curr_proto != PROTO_END;
450 rc |= zfs_is_shared_proto(zhp, NULL, *curr_proto);
452 return (rc ? B_TRUE : B_FALSE);
456 zfs_share(zfs_handle_t *zhp)
458 assert(!ZFS_IS_VOLUME(zhp));
459 return (zfs_share_proto(zhp, share_all_proto));
463 zfs_unshare(zfs_handle_t *zhp)
465 assert(!ZFS_IS_VOLUME(zhp));
466 return (zfs_unshareall(zhp));
470 * Check to see if the filesystem is currently shared.
473 zfs_is_shared_proto(zfs_handle_t *zhp, char **where, zfs_share_proto_t proto)
478 if (!zfs_is_mounted(zhp, &mountpoint))
479 return (SHARED_NOT_SHARED);
481 if ((rc = is_shared(zhp->zfs_hdl, mountpoint, proto))
482 != SHARED_NOT_SHARED) {
490 return (SHARED_NOT_SHARED);
495 zfs_is_shared_nfs(zfs_handle_t *zhp, char **where)
497 return (zfs_is_shared_proto(zhp, where,
498 PROTO_NFS) != SHARED_NOT_SHARED);
502 zfs_is_shared_smb(zfs_handle_t *zhp, char **where)
504 return (zfs_is_shared_proto(zhp, where,
505 PROTO_SMB) != SHARED_NOT_SHARED);
509 * Make sure things will work if libshare isn't installed by using
510 * wrapper functions that check to see that the pointers to functions
511 * initialized in _zfs_init_libshare() are actually present.
515 static sa_handle_t (*_sa_init)(int);
516 static void (*_sa_fini)(sa_handle_t);
517 static sa_share_t (*_sa_find_share)(sa_handle_t, char *);
518 static int (*_sa_enable_share)(sa_share_t, char *);
519 static int (*_sa_disable_share)(sa_share_t, char *);
520 static char *(*_sa_errorstr)(int);
521 static int (*_sa_parse_legacy_options)(sa_group_t, char *, char *);
522 static boolean_t (*_sa_needs_refresh)(sa_handle_t *);
523 static libzfs_handle_t *(*_sa_get_zfs_handle)(sa_handle_t);
524 static int (*_sa_zfs_process_share)(sa_handle_t, sa_group_t, sa_share_t,
525 char *, char *, zprop_source_t, char *, char *, char *);
526 static void (*_sa_update_sharetab_ts)(sa_handle_t);
530 * _zfs_init_libshare()
532 * Find the libshare.so.1 entry points that we use here and save the
533 * values to be used later. This is triggered by the runtime loader.
534 * Make sure the correct ISA version is loaded.
537 #pragma init(_zfs_init_libshare)
539 _zfs_init_libshare(void)
543 char path[MAXPATHLEN];
547 if (sysinfo(SI_ARCHITECTURE_64, isa, MAXISALEN) == -1)
552 (void) snprintf(path, MAXPATHLEN,
553 "/usr/lib/%s/libshare.so.1", isa);
555 if ((libshare = dlopen(path, RTLD_LAZY | RTLD_GLOBAL)) != NULL) {
556 _sa_init = (sa_handle_t (*)(int))dlsym(libshare, "sa_init");
557 _sa_fini = (void (*)(sa_handle_t))dlsym(libshare, "sa_fini");
558 _sa_find_share = (sa_share_t (*)(sa_handle_t, char *))
559 dlsym(libshare, "sa_find_share");
560 _sa_enable_share = (int (*)(sa_share_t, char *))dlsym(libshare,
562 _sa_disable_share = (int (*)(sa_share_t, char *))dlsym(libshare,
564 _sa_errorstr = (char *(*)(int))dlsym(libshare, "sa_errorstr");
565 _sa_parse_legacy_options = (int (*)(sa_group_t, char *, char *))
566 dlsym(libshare, "sa_parse_legacy_options");
567 _sa_needs_refresh = (boolean_t (*)(sa_handle_t *))
568 dlsym(libshare, "sa_needs_refresh");
569 _sa_get_zfs_handle = (libzfs_handle_t *(*)(sa_handle_t))
570 dlsym(libshare, "sa_get_zfs_handle");
571 _sa_zfs_process_share = (int (*)(sa_handle_t, sa_group_t,
572 sa_share_t, char *, char *, zprop_source_t, char *,
573 char *, char *))dlsym(libshare, "sa_zfs_process_share");
574 _sa_update_sharetab_ts = (void (*)(sa_handle_t))
575 dlsym(libshare, "sa_update_sharetab_ts");
576 if (_sa_init == NULL || _sa_fini == NULL ||
577 _sa_find_share == NULL || _sa_enable_share == NULL ||
578 _sa_disable_share == NULL || _sa_errorstr == NULL ||
579 _sa_parse_legacy_options == NULL ||
580 _sa_needs_refresh == NULL || _sa_get_zfs_handle == NULL ||
581 _sa_zfs_process_share == NULL ||
582 _sa_update_sharetab_ts == NULL) {
585 _sa_disable_share = NULL;
586 _sa_enable_share = NULL;
588 _sa_parse_legacy_options = NULL;
589 (void) dlclose(libshare);
590 _sa_needs_refresh = NULL;
591 _sa_get_zfs_handle = NULL;
592 _sa_zfs_process_share = NULL;
593 _sa_update_sharetab_ts = NULL;
600 * zfs_init_libshare(zhandle, service)
602 * Initialize the libshare API if it hasn't already been initialized.
603 * In all cases it returns 0 if it succeeded and an error if not. The
604 * service value is which part(s) of the API to initialize and is a
605 * direct map to the libshare sa_init(service) interface.
608 zfs_init_libshare(libzfs_handle_t *zhandle, int service)
613 if (_sa_init == NULL)
616 if (ret == SA_OK && zhandle->libzfs_shareflags & ZFSSHARE_MISS) {
618 * We had a cache miss. Most likely it is a new ZFS
619 * dataset that was just created. We want to make sure
620 * so check timestamps to see if a different process
621 * has updated any of the configuration. If there was
622 * some non-ZFS change, we need to re-initialize the
625 zhandle->libzfs_shareflags &= ~ZFSSHARE_MISS;
626 if (_sa_needs_refresh != NULL &&
627 _sa_needs_refresh(zhandle->libzfs_sharehdl)) {
628 zfs_uninit_libshare(zhandle);
629 zhandle->libzfs_sharehdl = _sa_init(service);
633 if (ret == SA_OK && zhandle && zhandle->libzfs_sharehdl == NULL)
634 zhandle->libzfs_sharehdl = _sa_init(service);
636 if (ret == SA_OK && zhandle->libzfs_sharehdl == NULL)
644 * zfs_uninit_libshare(zhandle)
646 * Uninitialize the libshare API if it hasn't already been
647 * uninitialized. It is OK to call multiple times.
650 zfs_uninit_libshare(libzfs_handle_t *zhandle)
652 if (zhandle != NULL && zhandle->libzfs_sharehdl != NULL) {
654 if (_sa_fini != NULL)
655 _sa_fini(zhandle->libzfs_sharehdl);
657 zhandle->libzfs_sharehdl = NULL;
662 * zfs_parse_options(options, proto)
664 * Call the legacy parse interface to get the protocol specific
665 * options using the NULL arg to indicate that this is a "parse" only.
668 zfs_parse_options(char *options, zfs_share_proto_t proto)
671 if (_sa_parse_legacy_options != NULL) {
672 return (_sa_parse_legacy_options(NULL, options,
673 proto_table[proto].p_name));
675 return (SA_CONFIG_ERR);
683 * zfs_sa_find_share(handle, path)
685 * wrapper around sa_find_share to find a share path in the
689 zfs_sa_find_share(sa_handle_t handle, char *path)
691 if (_sa_find_share != NULL)
692 return (_sa_find_share(handle, path));
697 * zfs_sa_enable_share(share, proto)
699 * Wrapper for sa_enable_share which enables a share for a specified
703 zfs_sa_enable_share(sa_share_t share, char *proto)
705 if (_sa_enable_share != NULL)
706 return (_sa_enable_share(share, proto));
707 return (SA_CONFIG_ERR);
711 * zfs_sa_disable_share(share, proto)
713 * Wrapper for sa_enable_share which disables a share for a specified
717 zfs_sa_disable_share(sa_share_t share, char *proto)
719 if (_sa_disable_share != NULL)
720 return (_sa_disable_share(share, proto));
721 return (SA_CONFIG_ERR);
726 * Share the given filesystem according to the options in the specified
727 * protocol specific properties (sharenfs, sharesmb). We rely
728 * on "libshare" to the dirty work for us.
731 zfs_share_proto(zfs_handle_t *zhp, zfs_share_proto_t *proto)
733 char mountpoint[ZFS_MAXPROPLEN];
734 char shareopts[ZFS_MAXPROPLEN];
735 char sourcestr[ZFS_MAXPROPLEN];
736 libzfs_handle_t *hdl = zhp->zfs_hdl;
737 zfs_share_proto_t *curr_proto;
738 zprop_source_t sourcetype;
741 if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint), NULL))
744 for (curr_proto = proto; *curr_proto != PROTO_END; curr_proto++) {
746 * Return success if there are no share options.
748 if (zfs_prop_get(zhp, proto_table[*curr_proto].p_prop,
749 shareopts, sizeof (shareopts), &sourcetype, sourcestr,
750 ZFS_MAXPROPLEN, B_FALSE) != 0 ||
751 strcmp(shareopts, "off") == 0)
755 ret = zfs_init_libshare(hdl, SA_INIT_SHARE_API);
757 (void) zfs_error_fmt(hdl, EZFS_SHARENFSFAILED,
758 dgettext(TEXT_DOMAIN, "cannot share '%s': %s"),
759 zfs_get_name(zhp), _sa_errorstr != NULL ?
760 _sa_errorstr(ret) : "");
766 * If the 'zoned' property is set, then zfs_is_mountable()
767 * will have already bailed out if we are in the global zone.
768 * But local zones cannot be NFS servers, so we ignore it for
769 * local zones as well.
771 if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED))
775 share = zfs_sa_find_share(hdl->libzfs_sharehdl, mountpoint);
778 * This may be a new file system that was just
779 * created so isn't in the internal cache
780 * (second time through). Rather than
781 * reloading the entire configuration, we can
782 * assume ZFS has done the checking and it is
783 * safe to add this to the internal
786 if (_sa_zfs_process_share(hdl->libzfs_sharehdl,
787 NULL, NULL, mountpoint,
788 proto_table[*curr_proto].p_name, sourcetype,
789 shareopts, sourcestr, zhp->zfs_name) != SA_OK) {
790 (void) zfs_error_fmt(hdl,
791 proto_table[*curr_proto].p_share_err,
792 dgettext(TEXT_DOMAIN, "cannot share '%s'"),
796 hdl->libzfs_shareflags |= ZFSSHARE_MISS;
797 share = zfs_sa_find_share(hdl->libzfs_sharehdl,
802 err = zfs_sa_enable_share(share,
803 proto_table[*curr_proto].p_name);
805 (void) zfs_error_fmt(hdl,
806 proto_table[*curr_proto].p_share_err,
807 dgettext(TEXT_DOMAIN, "cannot share '%s'"),
813 if (*curr_proto != PROTO_NFS) {
814 fprintf(stderr, "Unsupported share protocol: %d.\n",
819 if (strcmp(shareopts, "on") == 0)
820 error = fsshare(ZFS_EXPORTS_PATH, mountpoint, "");
822 error = fsshare(ZFS_EXPORTS_PATH, mountpoint, shareopts);
826 (void) zfs_error_fmt(hdl,
827 proto_table[*curr_proto].p_share_err,
828 dgettext(TEXT_DOMAIN, "cannot share '%s'"),
839 zfs_share_nfs(zfs_handle_t *zhp)
841 return (zfs_share_proto(zhp, nfs_only));
845 zfs_share_smb(zfs_handle_t *zhp)
847 return (zfs_share_proto(zhp, smb_only));
851 zfs_shareall(zfs_handle_t *zhp)
853 return (zfs_share_proto(zhp, share_all_proto));
857 * Unshare a filesystem by mountpoint.
860 unshare_one(libzfs_handle_t *hdl, const char *name, const char *mountpoint,
861 zfs_share_proto_t proto)
868 * Mountpoint could get trashed if libshare calls getmntany
869 * which it does during API initialization, so strdup the
872 mntpt = zfs_strdup(hdl, mountpoint);
874 /* make sure libshare initialized */
875 if ((err = zfs_init_libshare(hdl, SA_INIT_SHARE_API)) != SA_OK) {
876 free(mntpt); /* don't need the copy anymore */
877 return (zfs_error_fmt(hdl, proto_table[proto].p_unshare_err,
878 dgettext(TEXT_DOMAIN, "cannot unshare '%s': %s"),
879 name, _sa_errorstr(err)));
882 share = zfs_sa_find_share(hdl->libzfs_sharehdl, mntpt);
883 free(mntpt); /* don't need the copy anymore */
886 err = zfs_sa_disable_share(share, proto_table[proto].p_name);
888 return (zfs_error_fmt(hdl,
889 proto_table[proto].p_unshare_err,
890 dgettext(TEXT_DOMAIN, "cannot unshare '%s': %s"),
891 name, _sa_errorstr(err)));
894 return (zfs_error_fmt(hdl, proto_table[proto].p_unshare_err,
895 dgettext(TEXT_DOMAIN, "cannot unshare '%s': not found"),
899 char buf[MAXPATHLEN];
903 if (proto != PROTO_NFS) {
904 fprintf(stderr, "No SMB support in FreeBSD yet.\n");
908 err = fsunshare(ZFS_EXPORTS_PATH, mountpoint);
910 zfs_error_aux(hdl, "%s", strerror(err));
911 return (zfs_error_fmt(hdl, EZFS_UNSHARENFSFAILED,
912 dgettext(TEXT_DOMAIN,
913 "cannot unshare '%s'"), name));
920 * Unshare the given filesystem.
923 zfs_unshare_proto(zfs_handle_t *zhp, const char *mountpoint,
924 zfs_share_proto_t *proto)
926 libzfs_handle_t *hdl = zhp->zfs_hdl;
930 /* check to see if need to unmount the filesystem */
931 rewind(zhp->zfs_hdl->libzfs_mnttab);
932 if (mountpoint != NULL)
933 mountpoint = mntpt = zfs_strdup(hdl, mountpoint);
935 if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
936 libzfs_mnttab_find(hdl, zfs_get_name(zhp), &entry) == 0)) {
937 zfs_share_proto_t *curr_proto;
939 if (mountpoint == NULL)
940 mntpt = zfs_strdup(zhp->zfs_hdl, entry.mnt_mountp);
942 for (curr_proto = proto; *curr_proto != PROTO_END;
945 if (is_shared(hdl, mntpt, *curr_proto) &&
946 unshare_one(hdl, zhp->zfs_name,
947 mntpt, *curr_proto) != 0) {
961 zfs_unshare_nfs(zfs_handle_t *zhp, const char *mountpoint)
963 return (zfs_unshare_proto(zhp, mountpoint, nfs_only));
967 zfs_unshare_smb(zfs_handle_t *zhp, const char *mountpoint)
969 return (zfs_unshare_proto(zhp, mountpoint, smb_only));
973 * Same as zfs_unmountall(), but for NFS and SMB unshares.
976 zfs_unshareall_proto(zfs_handle_t *zhp, zfs_share_proto_t *proto)
978 prop_changelist_t *clp;
981 clp = changelist_gather(zhp, ZFS_PROP_SHARENFS, 0, 0);
985 ret = changelist_unshare(clp, proto);
986 changelist_free(clp);
992 zfs_unshareall_nfs(zfs_handle_t *zhp)
994 return (zfs_unshareall_proto(zhp, nfs_only));
998 zfs_unshareall_smb(zfs_handle_t *zhp)
1000 return (zfs_unshareall_proto(zhp, smb_only));
1004 zfs_unshareall(zfs_handle_t *zhp)
1006 return (zfs_unshareall_proto(zhp, share_all_proto));
1010 zfs_unshareall_bypath(zfs_handle_t *zhp, const char *mountpoint)
1012 return (zfs_unshare_proto(zhp, mountpoint, share_all_proto));
1016 * Remove the mountpoint associated with the current dataset, if necessary.
1017 * We only remove the underlying directory if:
1019 * - The mountpoint is not 'none' or 'legacy'
1020 * - The mountpoint is non-empty
1021 * - The mountpoint is the default or inherited
1022 * - The 'zoned' property is set, or we're in a local zone
1024 * Any other directories we leave alone.
1027 remove_mountpoint(zfs_handle_t *zhp)
1029 char mountpoint[ZFS_MAXPROPLEN];
1030 zprop_source_t source;
1032 if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint),
1036 if (source == ZPROP_SRC_DEFAULT ||
1037 source == ZPROP_SRC_INHERITED) {
1039 * Try to remove the directory, silently ignoring any errors.
1040 * The filesystem may have since been removed or moved around,
1041 * and this error isn't really useful to the administrator in
1044 (void) rmdir(mountpoint);
1049 libzfs_add_handle(get_all_cb_t *cbp, zfs_handle_t *zhp)
1051 if (cbp->cb_alloc == cbp->cb_used) {
1055 newsz = cbp->cb_alloc ? cbp->cb_alloc * 2 : 64;
1056 ptr = zfs_realloc(zhp->zfs_hdl,
1057 cbp->cb_handles, cbp->cb_alloc * sizeof (void *),
1058 newsz * sizeof (void *));
1059 cbp->cb_handles = ptr;
1060 cbp->cb_alloc = newsz;
1062 cbp->cb_handles[cbp->cb_used++] = zhp;
1066 mount_cb(zfs_handle_t *zhp, void *data)
1068 get_all_cb_t *cbp = data;
1070 if (!(zfs_get_type(zhp) & ZFS_TYPE_FILESYSTEM)) {
1075 if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == ZFS_CANMOUNT_NOAUTO) {
1081 * If this filesystem is inconsistent and has a receive resume
1082 * token, we can not mount it.
1084 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) &&
1085 zfs_prop_get(zhp, ZFS_PROP_RECEIVE_RESUME_TOKEN,
1086 NULL, 0, NULL, NULL, 0, B_TRUE) == 0) {
1091 libzfs_add_handle(cbp, zhp);
1092 if (zfs_iter_filesystems(zhp, mount_cb, cbp) != 0) {
1100 libzfs_dataset_cmp(const void *a, const void *b)
1102 zfs_handle_t **za = (zfs_handle_t **)a;
1103 zfs_handle_t **zb = (zfs_handle_t **)b;
1104 char mounta[MAXPATHLEN];
1105 char mountb[MAXPATHLEN];
1106 boolean_t gota, gotb;
1108 if ((gota = (zfs_get_type(*za) == ZFS_TYPE_FILESYSTEM)) != 0)
1109 verify(zfs_prop_get(*za, ZFS_PROP_MOUNTPOINT, mounta,
1110 sizeof (mounta), NULL, NULL, 0, B_FALSE) == 0);
1111 if ((gotb = (zfs_get_type(*zb) == ZFS_TYPE_FILESYSTEM)) != 0)
1112 verify(zfs_prop_get(*zb, ZFS_PROP_MOUNTPOINT, mountb,
1113 sizeof (mountb), NULL, NULL, 0, B_FALSE) == 0);
1116 return (strcmp(mounta, mountb));
1123 return (strcmp(zfs_get_name(a), zfs_get_name(b)));
1127 * Mount and share all datasets within the given pool. This assumes that no
1128 * datasets within the pool are currently mounted. Because users can create
1129 * complicated nested hierarchies of mountpoints, we first gather all the
1130 * datasets and mountpoints within the pool, and sort them by mountpoint. Once
1131 * we have the list of all filesystems, we iterate over them in order and mount
1132 * and/or share each one.
1134 #pragma weak zpool_mount_datasets = zpool_enable_datasets
1136 zpool_enable_datasets(zpool_handle_t *zhp, const char *mntopts, int flags)
1138 get_all_cb_t cb = { 0 };
1139 libzfs_handle_t *hdl = zhp->zpool_hdl;
1145 * Gather all non-snap datasets within the pool.
1147 if ((zfsp = zfs_open(hdl, zhp->zpool_name, ZFS_TYPE_DATASET)) == NULL)
1150 libzfs_add_handle(&cb, zfsp);
1151 if (zfs_iter_filesystems(zfsp, mount_cb, &cb) != 0)
1154 * Sort the datasets by mountpoint.
1156 qsort(cb.cb_handles, cb.cb_used, sizeof (void *),
1157 libzfs_dataset_cmp);
1160 * And mount all the datasets, keeping track of which ones
1161 * succeeded or failed.
1163 if ((good = zfs_alloc(zhp->zpool_hdl,
1164 cb.cb_used * sizeof (int))) == NULL)
1168 for (i = 0; i < cb.cb_used; i++) {
1169 if (zfs_mount(cb.cb_handles[i], mntopts, flags) != 0)
1176 * Then share all the ones that need to be shared. This needs
1177 * to be a separate pass in order to avoid excessive reloading
1178 * of the configuration. Good should never be NULL since
1179 * zfs_alloc is supposed to exit if memory isn't available.
1181 for (i = 0; i < cb.cb_used; i++) {
1182 if (good[i] && zfs_share(cb.cb_handles[i]) != 0)
1189 for (i = 0; i < cb.cb_used; i++)
1190 zfs_close(cb.cb_handles[i]);
1191 free(cb.cb_handles);
1197 mountpoint_compare(const void *a, const void *b)
1199 const char *mounta = *((char **)a);
1200 const char *mountb = *((char **)b);
1202 return (strcmp(mountb, mounta));
1205 /* alias for 2002/240 */
1206 #pragma weak zpool_unmount_datasets = zpool_disable_datasets
1208 * Unshare and unmount all datasets within the given pool. We don't want to
1209 * rely on traversing the DSL to discover the filesystems within the pool,
1210 * because this may be expensive (if not all of them are mounted), and can fail
1211 * arbitrarily (on I/O error, for example). Instead, we walk /etc/mnttab and
1212 * gather all the filesystems that are currently mounted.
1215 zpool_disable_datasets(zpool_handle_t *zhp, boolean_t force)
1218 struct mnttab entry;
1220 char **mountpoints = NULL;
1221 zfs_handle_t **datasets = NULL;
1222 libzfs_handle_t *hdl = zhp->zpool_hdl;
1225 int flags = (force ? MS_FORCE : 0);
1227 namelen = strlen(zhp->zpool_name);
1229 rewind(hdl->libzfs_mnttab);
1231 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
1233 * Ignore non-ZFS entries.
1235 if (entry.mnt_fstype == NULL ||
1236 strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
1240 * Ignore filesystems not within this pool.
1242 if (entry.mnt_mountp == NULL ||
1243 strncmp(entry.mnt_special, zhp->zpool_name, namelen) != 0 ||
1244 (entry.mnt_special[namelen] != '/' &&
1245 entry.mnt_special[namelen] != '\0'))
1249 * At this point we've found a filesystem within our pool. Add
1250 * it to our growing list.
1252 if (used == alloc) {
1254 if ((mountpoints = zfs_alloc(hdl,
1255 8 * sizeof (void *))) == NULL)
1258 if ((datasets = zfs_alloc(hdl,
1259 8 * sizeof (void *))) == NULL)
1266 if ((ptr = zfs_realloc(hdl, mountpoints,
1267 alloc * sizeof (void *),
1268 alloc * 2 * sizeof (void *))) == NULL)
1272 if ((ptr = zfs_realloc(hdl, datasets,
1273 alloc * sizeof (void *),
1274 alloc * 2 * sizeof (void *))) == NULL)
1282 if ((mountpoints[used] = zfs_strdup(hdl,
1283 entry.mnt_mountp)) == NULL)
1287 * This is allowed to fail, in case there is some I/O error. It
1288 * is only used to determine if we need to remove the underlying
1289 * mountpoint, so failure is not fatal.
1291 datasets[used] = make_dataset_handle(hdl, entry.mnt_special);
1297 * At this point, we have the entire list of filesystems, so sort it by
1300 qsort(mountpoints, used, sizeof (char *), mountpoint_compare);
1303 * Walk through and first unshare everything.
1305 for (i = 0; i < used; i++) {
1306 zfs_share_proto_t *curr_proto;
1307 for (curr_proto = share_all_proto; *curr_proto != PROTO_END;
1309 if (is_shared(hdl, mountpoints[i], *curr_proto) &&
1310 unshare_one(hdl, mountpoints[i],
1311 mountpoints[i], *curr_proto) != 0)
1317 * Now unmount everything, removing the underlying directories as
1320 for (i = 0; i < used; i++) {
1321 if (unmount_one(hdl, mountpoints[i], flags) != 0)
1325 for (i = 0; i < used; i++) {
1327 remove_mountpoint(datasets[i]);
1332 for (i = 0; i < used; i++) {
1334 zfs_close(datasets[i]);
1335 free(mountpoints[i]);