4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
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
37 * This file also contains the functions used to manage sharing filesystems via
50 * zfs_unshareall_nfs()
51 * zfs_unshareall_smb()
53 * zfs_unshareall_bypath()
55 * The following functions are available for pool consumers, and will
56 * mount/unmount and share/unshare all datasets within pool:
58 * zpool_enable_datasets()
59 * zpool_disable_datasets()
72 #include <sys/mntent.h>
73 #include <sys/mount.h>
75 #ifdef HAVE_LIBSELINUX
76 #include <selinux/selinux.h>
77 #endif /* HAVE_LIBSELINUX */
81 #include "libzfs_impl.h"
84 #include <sys/systeminfo.h>
85 #define MAXISALEN 257 /* based on sysinfo(2) man page */
88 static int zfs_share_proto(zfs_handle_t *, zfs_share_proto_t *);
89 zfs_share_type_t zfs_is_shared_proto(zfs_handle_t *, char **,
93 * The share protocols table must be in the same order as the zfs_share_prot_t
94 * enum in libzfs_impl.h
103 proto_table_t proto_table[PROTO_END] = {
104 {ZFS_PROP_SHARENFS, "nfs", EZFS_SHARENFSFAILED, EZFS_UNSHARENFSFAILED},
105 {ZFS_PROP_SHARESMB, "smb", EZFS_SHARESMBFAILED, EZFS_UNSHARESMBFAILED},
108 zfs_share_proto_t nfs_only[] = {
113 zfs_share_proto_t smb_only[] = {
117 zfs_share_proto_t share_all_proto[] = {
124 * Search the sharetab for the given mountpoint and protocol, returning
125 * a zfs_share_type_t value.
127 static zfs_share_type_t
128 is_shared(libzfs_handle_t *hdl, const char *mountpoint, zfs_share_proto_t proto)
130 char buf[MAXPATHLEN], *tab;
133 if (hdl->libzfs_sharetab == NULL)
134 return (SHARED_NOT_SHARED);
136 (void) fseek(hdl->libzfs_sharetab, 0, SEEK_SET);
138 while (fgets(buf, sizeof (buf), hdl->libzfs_sharetab) != NULL) {
140 /* the mountpoint is the first entry on each line */
141 if ((tab = strchr(buf, '\t')) == NULL)
145 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) {
171 return (SHARED_NOT_SHARED);
175 * Returns true if the specified directory is empty. If we can't open the
176 * directory at all, return true so that the mount can fail with a more
177 * informative error message.
180 dir_is_empty(const char *dirname)
185 if ((dirp = opendir(dirname)) == NULL)
188 while ((dp = readdir64(dirp)) != NULL) {
190 if (strcmp(dp->d_name, ".") == 0 ||
191 strcmp(dp->d_name, "..") == 0)
194 (void) closedir(dirp);
198 (void) closedir(dirp);
203 * Checks to see if the mount is active. If the filesystem is mounted, we fill
204 * in 'where' with the current mountpoint, and return 1. Otherwise, we return
208 is_mounted(libzfs_handle_t *zfs_hdl, const char *special, char **where)
212 if (libzfs_mnttab_find(zfs_hdl, special, &entry) != 0)
216 *where = zfs_strdup(zfs_hdl, entry.mnt_mountp);
222 zfs_is_mounted(zfs_handle_t *zhp, char **where)
224 return (is_mounted(zhp->zfs_hdl, zfs_get_name(zhp), where));
228 * Returns true if the given dataset is mountable, false otherwise. Returns the
229 * mountpoint in 'buf'.
232 zfs_is_mountable(zfs_handle_t *zhp, char *buf, size_t buflen,
233 zprop_source_t *source)
235 char sourceloc[ZFS_MAXNAMELEN];
236 zprop_source_t sourcetype;
238 if (!zfs_prop_valid_for_type(ZFS_PROP_MOUNTPOINT, zhp->zfs_type))
241 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, buf, buflen,
242 &sourcetype, sourceloc, sizeof (sourceloc), B_FALSE) == 0);
244 if (strcmp(buf, ZFS_MOUNTPOINT_NONE) == 0 ||
245 strcmp(buf, ZFS_MOUNTPOINT_LEGACY) == 0)
248 if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == ZFS_CANMOUNT_OFF)
251 if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED) &&
252 getzoneid() == GLOBAL_ZONEID)
256 *source = sourcetype;
262 * The filesystem is mounted by invoking the system mount utility rather
263 * than by the system call mount(2). This ensures that the /etc/mtab
264 * file is correctly locked for the update. Performing our own locking
265 * and /etc/mtab update requires making an unsafe assumption about how
266 * the mount utility performs its locking. Unfortunately, this also means
267 * in the case of a mount failure we do not have the exact errno. We must
268 * make due with return value from the mount process.
270 * In the long term a shared library called libmount is under development
271 * which provides a common API to address the locking and errno issues.
272 * Once the standard mount utility has been updated to use this library
273 * we can add an autoconf check to conditionally use it.
275 * http://www.kernel.org/pub/linux/utils/util-linux/libmount-docs/index.html
279 do_mount(const char *src, const char *mntpt, char *opts)
290 /* Return only the most critical mount error */
291 rc = libzfs_run_process(argv[0], argv);
293 if (rc & MOUNT_FILEIO)
297 if (rc & MOUNT_SOFTWARE)
299 if (rc & MOUNT_SYSERR)
301 if (rc & MOUNT_USAGE)
304 return ENXIO; /* Generic error */
311 do_unmount(const char *mntpt, int flags)
313 char force_opt[] = "-f";
314 char lazy_opt[] = "-l";
318 NULL, NULL, NULL, NULL };
321 if (flags & MS_FORCE) {
322 argv[count] = force_opt;
326 if (flags & MS_DETACH) {
327 argv[count] = lazy_opt;
331 argv[count] = (char *)mntpt;
332 rc = libzfs_run_process(argv[0], argv);
334 return (rc ? EINVAL : 0);
338 * Mount the given filesystem.
341 zfs_mount(zfs_handle_t *zhp, const char *options, int flags)
344 char mountpoint[ZFS_MAXPROPLEN];
345 char mntopts[MNT_LINE_MAX];
346 libzfs_handle_t *hdl = zhp->zfs_hdl;
350 (void) strlcpy(mntopts, MNTOPT_DEFAULTS, sizeof (mntopts));
352 (void) strlcpy(mntopts, options, sizeof (mntopts));
355 * If the pool is imported read-only then all mounts must be read-only
357 if (zpool_get_prop_int(zhp->zpool_hdl, ZPOOL_PROP_READONLY, NULL))
358 (void) strlcat(mntopts, "," MNTOPT_RO, sizeof (mntopts));
361 * Append zfsutil option so the mount helper allow the mount
363 strlcat(mntopts, "," MNTOPT_ZFSUTIL, sizeof (mntopts));
365 #ifdef HAVE_LIBSELINUX
366 if (is_selinux_enabled())
367 (void) strlcat(mntopts, ",context=\"system_u:"
368 "object_r:file_t:s0\"", sizeof (mntopts));
369 #endif /* HAVE_LIBSELINUX */
371 if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint), NULL))
374 /* Create the directory if it doesn't already exist */
375 if (lstat(mountpoint, &buf) != 0) {
376 if (mkdirp(mountpoint, 0755) != 0) {
377 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
378 "failed to create mountpoint"));
379 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
380 dgettext(TEXT_DOMAIN, "cannot mount '%s'"),
386 * Determine if the mountpoint is empty. If so, refuse to perform the
387 * mount. We don't perform this check if 'remount' is specified.
389 if (strstr(mntopts, MNTOPT_REMOUNT) == NULL &&
390 !dir_is_empty(mountpoint)) {
391 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
392 "directory is not empty"));
393 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
394 dgettext(TEXT_DOMAIN, "cannot mount '%s'"), mountpoint));
397 /* perform the mount */
398 rc = do_mount(zfs_get_name(zhp), mountpoint, mntopts);
401 * Generic errors are nasty, but there are just way too many
402 * from mount(), and they're well-understood. We pick a few
403 * common ones to improve upon.
406 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
407 "mountpoint or dataset is busy"));
408 } else if (rc == EPERM) {
409 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
410 "Insufficient privileges"));
411 } else if (rc == ENOTSUP) {
415 VERIFY(zfs_spa_version(zhp, &spa_version) == 0);
416 (void) snprintf(buf, sizeof (buf),
417 dgettext(TEXT_DOMAIN, "Can't mount a version %lld "
418 "file system on a version %d pool. Pool must be"
419 " upgraded to mount this file system."),
420 (u_longlong_t)zfs_prop_get_int(zhp,
421 ZFS_PROP_VERSION), spa_version);
422 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, buf));
424 zfs_error_aux(hdl, strerror(rc));
426 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
427 dgettext(TEXT_DOMAIN, "cannot mount '%s'"),
431 /* add the mounted entry into our cache */
432 libzfs_mnttab_add(hdl, zfs_get_name(zhp), mountpoint, mntopts);
437 * Unmount a single filesystem.
440 unmount_one(libzfs_handle_t *hdl, const char *mountpoint, int flags)
442 if (do_unmount(mountpoint, flags) != 0) {
443 zfs_error_aux(hdl, strerror(errno));
444 return (zfs_error_fmt(hdl, EZFS_UMOUNTFAILED,
445 dgettext(TEXT_DOMAIN, "cannot unmount '%s'"),
453 * Unmount the given filesystem.
456 zfs_unmount(zfs_handle_t *zhp, const char *mountpoint, int flags)
458 libzfs_handle_t *hdl = zhp->zfs_hdl;
462 /* check to see if we need to unmount the filesystem */
463 if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
464 libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0)) {
466 * mountpoint may have come from a call to
467 * getmnt/getmntany if it isn't NULL. If it is NULL,
468 * we know it comes from libzfs_mnttab_find which can
469 * then get freed later. We strdup it to play it safe.
471 if (mountpoint == NULL)
472 mntpt = zfs_strdup(hdl, entry.mnt_mountp);
474 mntpt = zfs_strdup(hdl, mountpoint);
477 * Unshare and unmount the filesystem
479 if (zfs_unshare_proto(zhp, mntpt, share_all_proto) != 0)
482 if (unmount_one(hdl, mntpt, flags) != 0) {
484 (void) zfs_shareall(zhp);
487 libzfs_mnttab_remove(hdl, zhp->zfs_name);
495 * Unmount this filesystem and any children inheriting the mountpoint property.
496 * To do this, just act like we're changing the mountpoint property, but don't
497 * remount the filesystems afterwards.
500 zfs_unmountall(zfs_handle_t *zhp, int flags)
502 prop_changelist_t *clp;
505 clp = changelist_gather(zhp, ZFS_PROP_MOUNTPOINT, 0, flags);
509 ret = changelist_prefix(clp);
510 changelist_free(clp);
516 zfs_is_shared(zfs_handle_t *zhp)
518 zfs_share_type_t rc = 0;
519 zfs_share_proto_t *curr_proto;
521 if (ZFS_IS_VOLUME(zhp))
524 for (curr_proto = share_all_proto; *curr_proto != PROTO_END;
526 rc |= zfs_is_shared_proto(zhp, NULL, *curr_proto);
528 return (rc ? B_TRUE : B_FALSE);
532 zfs_share(zfs_handle_t *zhp)
534 assert(!ZFS_IS_VOLUME(zhp));
535 return (zfs_share_proto(zhp, share_all_proto));
539 zfs_unshare(zfs_handle_t *zhp)
541 assert(!ZFS_IS_VOLUME(zhp));
542 return (zfs_unshareall(zhp));
546 * Check to see if the filesystem is currently shared.
549 zfs_is_shared_proto(zfs_handle_t *zhp, char **where, zfs_share_proto_t proto)
554 if (!zfs_is_mounted(zhp, &mountpoint))
555 return (SHARED_NOT_SHARED);
557 if ((rc = is_shared(zhp->zfs_hdl, mountpoint, proto))) {
565 return (SHARED_NOT_SHARED);
570 zfs_is_shared_nfs(zfs_handle_t *zhp, char **where)
572 return (zfs_is_shared_proto(zhp, where,
573 PROTO_NFS) != SHARED_NOT_SHARED);
577 zfs_is_shared_smb(zfs_handle_t *zhp, char **where)
579 return (zfs_is_shared_proto(zhp, where,
580 PROTO_SMB) != SHARED_NOT_SHARED);
584 * Make sure things will work if libshare isn't installed by using
585 * wrapper functions that check to see that the pointers to functions
586 * initialized in _zfs_init_libshare() are actually present.
589 static sa_handle_t (*_sa_init)(int);
590 static void (*_sa_fini)(sa_handle_t);
591 static sa_share_t (*_sa_find_share)(sa_handle_t, char *);
592 static int (*_sa_enable_share)(sa_share_t, char *);
593 static int (*_sa_disable_share)(sa_share_t, char *);
594 static char *(*_sa_errorstr)(int);
595 static int (*_sa_parse_legacy_options)(sa_group_t, char *, char *);
596 static boolean_t (*_sa_needs_refresh)(sa_handle_t *);
597 static libzfs_handle_t *(*_sa_get_zfs_handle)(sa_handle_t);
598 static int (*_sa_zfs_process_share)(sa_handle_t, sa_group_t, sa_share_t,
599 char *, char *, zprop_source_t, char *, char *, char *);
600 static void (*_sa_update_sharetab_ts)(sa_handle_t);
603 * _zfs_init_libshare()
605 * Find the libshare.so.1 entry points that we use here and save the
606 * values to be used later. This is triggered by the runtime loader.
607 * Make sure the correct ISA version is loaded.
611 _zfs_init_libshare(void) __attribute__((constructor));
613 #pragma init(_zfs_init_libshare)
616 _zfs_init_libshare(void)
619 char path[MAXPATHLEN];
623 if (sysinfo(SI_ARCHITECTURE_64, isa, MAXISALEN) == -1)
628 (void) snprintf(path, MAXPATHLEN,
629 "/usr/lib/%s/libshare.so.1", isa);
631 if ((libshare = dlopen(path, RTLD_LAZY | RTLD_GLOBAL)) != NULL) {
632 _sa_init = (sa_handle_t (*)(int))dlsym(libshare, "sa_init");
633 _sa_fini = (void (*)(sa_handle_t))dlsym(libshare, "sa_fini");
634 _sa_find_share = (sa_share_t (*)(sa_handle_t, char *))
635 dlsym(libshare, "sa_find_share");
636 _sa_enable_share = (int (*)(sa_share_t, char *))dlsym(libshare,
638 _sa_disable_share = (int (*)(sa_share_t, char *))dlsym(libshare,
640 _sa_errorstr = (char *(*)(int))dlsym(libshare, "sa_errorstr");
641 _sa_parse_legacy_options = (int (*)(sa_group_t, char *, char *))
642 dlsym(libshare, "sa_parse_legacy_options");
643 _sa_needs_refresh = (boolean_t (*)(sa_handle_t *))
644 dlsym(libshare, "sa_needs_refresh");
645 _sa_get_zfs_handle = (libzfs_handle_t *(*)(sa_handle_t))
646 dlsym(libshare, "sa_get_zfs_handle");
647 _sa_zfs_process_share = (int (*)(sa_handle_t, sa_group_t,
648 sa_share_t, char *, char *, zprop_source_t, char *,
649 char *, char *))dlsym(libshare, "sa_zfs_process_share");
650 _sa_update_sharetab_ts = (void (*)(sa_handle_t))
651 dlsym(libshare, "sa_update_sharetab_ts");
652 if (_sa_init == NULL || _sa_fini == NULL ||
653 _sa_find_share == NULL || _sa_enable_share == NULL ||
654 _sa_disable_share == NULL || _sa_errorstr == NULL ||
655 _sa_parse_legacy_options == NULL ||
656 _sa_needs_refresh == NULL || _sa_get_zfs_handle == NULL ||
657 _sa_zfs_process_share == NULL ||
658 _sa_update_sharetab_ts == NULL) {
661 _sa_disable_share = NULL;
662 _sa_enable_share = NULL;
664 _sa_parse_legacy_options = NULL;
665 (void) dlclose(libshare);
666 _sa_needs_refresh = NULL;
667 _sa_get_zfs_handle = NULL;
668 _sa_zfs_process_share = NULL;
669 _sa_update_sharetab_ts = NULL;
675 * zfs_init_libshare(zhandle, service)
677 * Initialize the libshare API if it hasn't already been initialized.
678 * In all cases it returns 0 if it succeeded and an error if not. The
679 * service value is which part(s) of the API to initialize and is a
680 * direct map to the libshare sa_init(service) interface.
683 zfs_init_libshare(libzfs_handle_t *zhandle, int service)
687 if (_sa_init == NULL)
690 if (ret == SA_OK && zhandle->libzfs_shareflags & ZFSSHARE_MISS) {
692 * We had a cache miss. Most likely it is a new ZFS
693 * dataset that was just created. We want to make sure
694 * so check timestamps to see if a different process
695 * has updated any of the configuration. If there was
696 * some non-ZFS change, we need to re-initialize the
699 zhandle->libzfs_shareflags &= ~ZFSSHARE_MISS;
700 if (_sa_needs_refresh != NULL &&
701 _sa_needs_refresh(zhandle->libzfs_sharehdl)) {
702 zfs_uninit_libshare(zhandle);
703 zhandle->libzfs_sharehdl = _sa_init(service);
707 if (ret == SA_OK && zhandle && zhandle->libzfs_sharehdl == NULL)
708 zhandle->libzfs_sharehdl = _sa_init(service);
710 if (ret == SA_OK && zhandle->libzfs_sharehdl == NULL)
717 * zfs_uninit_libshare(zhandle)
719 * Uninitialize the libshare API if it hasn't already been
720 * uninitialized. It is OK to call multiple times.
723 zfs_uninit_libshare(libzfs_handle_t *zhandle)
725 if (zhandle != NULL && zhandle->libzfs_sharehdl != NULL) {
726 if (_sa_fini != NULL)
727 _sa_fini(zhandle->libzfs_sharehdl);
728 zhandle->libzfs_sharehdl = NULL;
733 * zfs_parse_options(options, proto)
735 * Call the legacy parse interface to get the protocol specific
736 * options using the NULL arg to indicate that this is a "parse" only.
739 zfs_parse_options(char *options, zfs_share_proto_t proto)
741 if (_sa_parse_legacy_options != NULL) {
742 return (_sa_parse_legacy_options(NULL, options,
743 proto_table[proto].p_name));
745 return (SA_CONFIG_ERR);
749 * zfs_sa_find_share(handle, path)
751 * wrapper around sa_find_share to find a share path in the
755 zfs_sa_find_share(sa_handle_t handle, char *path)
757 if (_sa_find_share != NULL)
758 return (_sa_find_share(handle, path));
763 * zfs_sa_enable_share(share, proto)
765 * Wrapper for sa_enable_share which enables a share for a specified
769 zfs_sa_enable_share(sa_share_t share, char *proto)
771 if (_sa_enable_share != NULL)
772 return (_sa_enable_share(share, proto));
773 return (SA_CONFIG_ERR);
777 * zfs_sa_disable_share(share, proto)
779 * Wrapper for sa_enable_share which disables a share for a specified
783 zfs_sa_disable_share(sa_share_t share, char *proto)
785 if (_sa_disable_share != NULL)
786 return (_sa_disable_share(share, proto));
787 return (SA_CONFIG_ERR);
791 * Share the given filesystem according to the options in the specified
792 * protocol specific properties (sharenfs, sharesmb). We rely
793 * on "libshare" to the dirty work for us.
796 zfs_share_proto(zfs_handle_t *zhp, zfs_share_proto_t *proto)
798 char mountpoint[ZFS_MAXPROPLEN];
799 char shareopts[ZFS_MAXPROPLEN];
800 char sourcestr[ZFS_MAXPROPLEN];
801 libzfs_handle_t *hdl = zhp->zfs_hdl;
803 zfs_share_proto_t *curr_proto;
804 zprop_source_t sourcetype;
807 if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint), NULL))
810 if ((ret = zfs_init_libshare(hdl, SA_INIT_SHARE_API)) != SA_OK) {
811 (void) zfs_error_fmt(hdl, EZFS_SHARENFSFAILED,
812 dgettext(TEXT_DOMAIN, "cannot share '%s': %s"),
813 zfs_get_name(zhp), _sa_errorstr != NULL ?
814 _sa_errorstr(ret) : "");
818 for (curr_proto = proto; *curr_proto != PROTO_END; curr_proto++) {
820 * Return success if there are no share options.
822 if (zfs_prop_get(zhp, proto_table[*curr_proto].p_prop,
823 shareopts, sizeof (shareopts), &sourcetype, sourcestr,
824 ZFS_MAXPROPLEN, B_FALSE) != 0 ||
825 strcmp(shareopts, "off") == 0)
829 * If the 'zoned' property is set, then zfs_is_mountable()
830 * will have already bailed out if we are in the global zone.
831 * But local zones cannot be NFS servers, so we ignore it for
832 * local zones as well.
834 if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED))
837 share = zfs_sa_find_share(hdl->libzfs_sharehdl, mountpoint);
840 * This may be a new file system that was just
841 * created so isn't in the internal cache
842 * (second time through). Rather than
843 * reloading the entire configuration, we can
844 * assume ZFS has done the checking and it is
845 * safe to add this to the internal
848 if (_sa_zfs_process_share(hdl->libzfs_sharehdl,
849 NULL, NULL, mountpoint,
850 proto_table[*curr_proto].p_name, sourcetype,
851 shareopts, sourcestr, zhp->zfs_name) != SA_OK) {
852 (void) zfs_error_fmt(hdl,
853 proto_table[*curr_proto].p_share_err,
854 dgettext(TEXT_DOMAIN, "cannot share '%s'"),
858 hdl->libzfs_shareflags |= ZFSSHARE_MISS;
859 share = zfs_sa_find_share(hdl->libzfs_sharehdl,
864 err = zfs_sa_enable_share(share,
865 proto_table[*curr_proto].p_name);
867 (void) zfs_error_fmt(hdl,
868 proto_table[*curr_proto].p_share_err,
869 dgettext(TEXT_DOMAIN, "cannot share '%s'"),
874 (void) zfs_error_fmt(hdl,
875 proto_table[*curr_proto].p_share_err,
876 dgettext(TEXT_DOMAIN, "cannot share '%s'"),
887 zfs_share_nfs(zfs_handle_t *zhp)
889 return (zfs_share_proto(zhp, nfs_only));
893 zfs_share_smb(zfs_handle_t *zhp)
895 return (zfs_share_proto(zhp, smb_only));
899 zfs_shareall(zfs_handle_t *zhp)
901 return (zfs_share_proto(zhp, share_all_proto));
905 * Unshare a filesystem by mountpoint.
908 unshare_one(libzfs_handle_t *hdl, const char *name, const char *mountpoint,
909 zfs_share_proto_t proto)
915 * Mountpoint could get trashed if libshare calls getmntany
916 * which it does during API initialization, so strdup the
919 mntpt = zfs_strdup(hdl, mountpoint);
921 /* make sure libshare initialized */
922 if ((err = zfs_init_libshare(hdl, SA_INIT_SHARE_API)) != SA_OK) {
923 free(mntpt); /* don't need the copy anymore */
924 return (zfs_error_fmt(hdl, EZFS_SHARENFSFAILED,
925 dgettext(TEXT_DOMAIN, "cannot unshare '%s': %s"),
926 name, _sa_errorstr(err)));
929 share = zfs_sa_find_share(hdl->libzfs_sharehdl, mntpt);
930 free(mntpt); /* don't need the copy anymore */
933 err = zfs_sa_disable_share(share, proto_table[proto].p_name);
935 return (zfs_error_fmt(hdl, EZFS_UNSHARENFSFAILED,
936 dgettext(TEXT_DOMAIN, "cannot unshare '%s': %s"),
937 name, _sa_errorstr(err)));
940 return (zfs_error_fmt(hdl, EZFS_UNSHARENFSFAILED,
941 dgettext(TEXT_DOMAIN, "cannot unshare '%s': not found"),
948 * Unshare the given filesystem.
951 zfs_unshare_proto(zfs_handle_t *zhp, const char *mountpoint,
952 zfs_share_proto_t *proto)
954 libzfs_handle_t *hdl = zhp->zfs_hdl;
958 /* check to see if need to unmount the filesystem */
959 rewind(zhp->zfs_hdl->libzfs_mnttab);
960 if (mountpoint != NULL)
961 mountpoint = mntpt = zfs_strdup(hdl, mountpoint);
963 if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
964 libzfs_mnttab_find(hdl, zfs_get_name(zhp), &entry) == 0)) {
965 zfs_share_proto_t *curr_proto;
967 if (mountpoint == NULL)
968 mntpt = zfs_strdup(zhp->zfs_hdl, entry.mnt_mountp);
970 for (curr_proto = proto; *curr_proto != PROTO_END;
973 if (is_shared(hdl, mntpt, *curr_proto) &&
974 unshare_one(hdl, zhp->zfs_name,
975 mntpt, *curr_proto) != 0) {
989 zfs_unshare_nfs(zfs_handle_t *zhp, const char *mountpoint)
991 return (zfs_unshare_proto(zhp, mountpoint, nfs_only));
995 zfs_unshare_smb(zfs_handle_t *zhp, const char *mountpoint)
997 return (zfs_unshare_proto(zhp, mountpoint, smb_only));
1001 * Same as zfs_unmountall(), but for NFS and SMB unshares.
1004 zfs_unshareall_proto(zfs_handle_t *zhp, zfs_share_proto_t *proto)
1006 prop_changelist_t *clp;
1009 clp = changelist_gather(zhp, ZFS_PROP_SHARENFS, 0, 0);
1013 ret = changelist_unshare(clp, proto);
1014 changelist_free(clp);
1020 zfs_unshareall_nfs(zfs_handle_t *zhp)
1022 return (zfs_unshareall_proto(zhp, nfs_only));
1026 zfs_unshareall_smb(zfs_handle_t *zhp)
1028 return (zfs_unshareall_proto(zhp, smb_only));
1032 zfs_unshareall(zfs_handle_t *zhp)
1034 return (zfs_unshareall_proto(zhp, share_all_proto));
1038 zfs_unshareall_bypath(zfs_handle_t *zhp, const char *mountpoint)
1040 return (zfs_unshare_proto(zhp, mountpoint, share_all_proto));
1044 * Remove the mountpoint associated with the current dataset, if necessary.
1045 * We only remove the underlying directory if:
1047 * - The mountpoint is not 'none' or 'legacy'
1048 * - The mountpoint is non-empty
1049 * - The mountpoint is the default or inherited
1050 * - The 'zoned' property is set, or we're in a local zone
1052 * Any other directories we leave alone.
1055 remove_mountpoint(zfs_handle_t *zhp)
1057 char mountpoint[ZFS_MAXPROPLEN];
1058 zprop_source_t source;
1060 if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint),
1064 if (source == ZPROP_SRC_DEFAULT ||
1065 source == ZPROP_SRC_INHERITED) {
1067 * Try to remove the directory, silently ignoring any errors.
1068 * The filesystem may have since been removed or moved around,
1069 * and this error isn't really useful to the administrator in
1072 (void) rmdir(mountpoint);
1077 libzfs_add_handle(get_all_cb_t *cbp, zfs_handle_t *zhp)
1079 if (cbp->cb_alloc == cbp->cb_used) {
1083 newsz = cbp->cb_alloc ? cbp->cb_alloc * 2 : 64;
1084 ptr = zfs_realloc(zhp->zfs_hdl,
1085 cbp->cb_handles, cbp->cb_alloc * sizeof (void *),
1086 newsz * sizeof (void *));
1087 cbp->cb_handles = ptr;
1088 cbp->cb_alloc = newsz;
1090 cbp->cb_handles[cbp->cb_used++] = zhp;
1094 mount_cb(zfs_handle_t *zhp, void *data)
1096 get_all_cb_t *cbp = data;
1098 if (!(zfs_get_type(zhp) & ZFS_TYPE_FILESYSTEM)) {
1103 if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == ZFS_CANMOUNT_NOAUTO) {
1108 libzfs_add_handle(cbp, zhp);
1109 if (zfs_iter_filesystems(zhp, mount_cb, cbp) != 0) {
1117 libzfs_dataset_cmp(const void *a, const void *b)
1119 zfs_handle_t **za = (zfs_handle_t **)a;
1120 zfs_handle_t **zb = (zfs_handle_t **)b;
1121 char mounta[MAXPATHLEN];
1122 char mountb[MAXPATHLEN];
1123 boolean_t gota, gotb;
1125 if ((gota = (zfs_get_type(*za) == ZFS_TYPE_FILESYSTEM)) != 0)
1126 verify(zfs_prop_get(*za, ZFS_PROP_MOUNTPOINT, mounta,
1127 sizeof (mounta), NULL, NULL, 0, B_FALSE) == 0);
1128 if ((gotb = (zfs_get_type(*zb) == ZFS_TYPE_FILESYSTEM)) != 0)
1129 verify(zfs_prop_get(*zb, ZFS_PROP_MOUNTPOINT, mountb,
1130 sizeof (mountb), NULL, NULL, 0, B_FALSE) == 0);
1133 return (strcmp(mounta, mountb));
1140 return (strcmp(zfs_get_name(a), zfs_get_name(b)));
1144 * Mount and share all datasets within the given pool. This assumes that no
1145 * datasets within the pool are currently mounted. Because users can create
1146 * complicated nested hierarchies of mountpoints, we first gather all the
1147 * datasets and mountpoints within the pool, and sort them by mountpoint. Once
1148 * we have the list of all filesystems, we iterate over them in order and mount
1149 * and/or share each one.
1151 #pragma weak zpool_mount_datasets = zpool_enable_datasets
1153 zpool_enable_datasets(zpool_handle_t *zhp, const char *mntopts, int flags)
1155 get_all_cb_t cb = { 0 };
1156 libzfs_handle_t *hdl = zhp->zpool_hdl;
1162 * Gather all non-snap datasets within the pool.
1164 if ((zfsp = zfs_open(hdl, zhp->zpool_name, ZFS_TYPE_DATASET)) == NULL)
1167 libzfs_add_handle(&cb, zfsp);
1168 if (zfs_iter_filesystems(zfsp, mount_cb, &cb) != 0)
1171 * Sort the datasets by mountpoint.
1173 qsort(cb.cb_handles, cb.cb_used, sizeof (void *),
1174 libzfs_dataset_cmp);
1177 * And mount all the datasets, keeping track of which ones
1178 * succeeded or failed.
1180 if ((good = zfs_alloc(zhp->zpool_hdl,
1181 cb.cb_used * sizeof (int))) == NULL)
1185 for (i = 0; i < cb.cb_used; i++) {
1186 if (zfs_mount(cb.cb_handles[i], mntopts, flags) != 0)
1193 * Then share all the ones that need to be shared. This needs
1194 * to be a separate pass in order to avoid excessive reloading
1195 * of the configuration. Good should never be NULL since
1196 * zfs_alloc is supposed to exit if memory isn't available.
1198 for (i = 0; i < cb.cb_used; i++) {
1199 if (good[i] && zfs_share(cb.cb_handles[i]) != 0)
1206 for (i = 0; i < cb.cb_used; i++)
1207 zfs_close(cb.cb_handles[i]);
1208 free(cb.cb_handles);
1214 mountpoint_compare(const void *a, const void *b)
1216 const char *mounta = *((char **)a);
1217 const char *mountb = *((char **)b);
1219 return (strcmp(mountb, mounta));
1222 /* alias for 2002/240 */
1223 #pragma weak zpool_unmount_datasets = zpool_disable_datasets
1225 * Unshare and unmount all datasets within the given pool. We don't want to
1226 * rely on traversing the DSL to discover the filesystems within the pool,
1227 * because this may be expensive (if not all of them are mounted), and can fail
1228 * arbitrarily (on I/O error, for example). Instead, we walk /etc/mnttab and
1229 * gather all the filesystems that are currently mounted.
1232 zpool_disable_datasets(zpool_handle_t *zhp, boolean_t force)
1235 struct mnttab entry;
1237 char **mountpoints = NULL;
1238 zfs_handle_t **datasets = NULL;
1239 libzfs_handle_t *hdl = zhp->zpool_hdl;
1242 int flags = (force ? MS_FORCE : 0);
1244 namelen = strlen(zhp->zpool_name);
1246 rewind(hdl->libzfs_mnttab);
1248 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
1250 * Ignore non-ZFS entries.
1252 if (entry.mnt_fstype == NULL ||
1253 strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
1257 * Ignore filesystems not within this pool.
1259 if (entry.mnt_mountp == NULL ||
1260 strncmp(entry.mnt_special, zhp->zpool_name, namelen) != 0 ||
1261 (entry.mnt_special[namelen] != '/' &&
1262 entry.mnt_special[namelen] != '\0'))
1266 * At this point we've found a filesystem within our pool. Add
1267 * it to our growing list.
1269 if (used == alloc) {
1271 if ((mountpoints = zfs_alloc(hdl,
1272 8 * sizeof (void *))) == NULL)
1275 if ((datasets = zfs_alloc(hdl,
1276 8 * sizeof (void *))) == NULL)
1283 if ((ptr = zfs_realloc(hdl, mountpoints,
1284 alloc * sizeof (void *),
1285 alloc * 2 * sizeof (void *))) == NULL)
1289 if ((ptr = zfs_realloc(hdl, datasets,
1290 alloc * sizeof (void *),
1291 alloc * 2 * sizeof (void *))) == NULL)
1299 if ((mountpoints[used] = zfs_strdup(hdl,
1300 entry.mnt_mountp)) == NULL)
1304 * This is allowed to fail, in case there is some I/O error. It
1305 * is only used to determine if we need to remove the underlying
1306 * mountpoint, so failure is not fatal.
1308 datasets[used] = make_dataset_handle(hdl, entry.mnt_special);
1314 * At this point, we have the entire list of filesystems, so sort it by
1317 qsort(mountpoints, used, sizeof (char *), mountpoint_compare);
1320 * Walk through and first unshare everything.
1322 for (i = 0; i < used; i++) {
1323 zfs_share_proto_t *curr_proto;
1324 for (curr_proto = share_all_proto; *curr_proto != PROTO_END;
1326 if (is_shared(hdl, mountpoints[i], *curr_proto) &&
1327 unshare_one(hdl, mountpoints[i],
1328 mountpoints[i], *curr_proto) != 0)
1334 * Now unmount everything, removing the underlying directories as
1337 for (i = 0; i < used; i++) {
1338 if (unmount_one(hdl, mountpoints[i], flags) != 0)
1342 for (i = 0; i < used; i++) {
1344 remove_mountpoint(datasets[i]);
1349 for (i = 0; i < used; i++) {
1351 zfs_close(datasets[i]);
1352 free(mountpoints[i]);
1360 #else /* HAVE_ZPL */
1363 zfs_unshare_iscsi(zfs_handle_t *zhp)
1369 zfs_unmount(zfs_handle_t *zhp, const char *mountpoint, int flags)
1375 remove_mountpoint(zfs_handle_t *zhp) {
1380 is_mounted(libzfs_handle_t *zfs_hdl, const char *special, char **where)
1386 zfs_is_mounted(zfs_handle_t *zhp, char **where)
1388 return is_mounted(zhp->zfs_hdl, zfs_get_name(zhp), where);
1392 zfs_is_shared(zfs_handle_t *zhp)
1398 zpool_enable_datasets(zpool_handle_t *zhp, const char *mntopts, int flags)
1404 zpool_disable_datasets(zpool_handle_t *zhp, boolean_t force)
1408 #endif /* HAVE_ZPL */