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 2008 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
28 * Routines to manage ZFS mounts. We separate all the nasty routines that have
29 * to deal with the OS. The following functions are the main entry points --
30 * they are used by mount and unmount and when changing a filesystem's
38 * This file also contains the functions used to manage sharing filesystems via
47 * zfs_is_shared_iscsi()
53 * zfs_unshareall_nfs()
54 * zfs_unshareall_smb()
56 * 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 #include <sys/systeminfo.h>
86 #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 **,
92 static int (*iscsitgt_zfs_share)(const char *);
93 static int (*iscsitgt_zfs_unshare)(const char *);
94 static int (*iscsitgt_zfs_is_shared)(const char *);
95 static int (*iscsitgt_svc_online)();
98 * The share protocols table must be in the same order as the zfs_share_prot_t
99 * enum in libzfs_impl.h
108 proto_table_t proto_table[PROTO_END] = {
109 {ZFS_PROP_SHARENFS, "nfs", EZFS_SHARENFSFAILED, EZFS_UNSHARENFSFAILED},
110 {ZFS_PROP_SHARESMB, "smb", EZFS_SHARESMBFAILED, EZFS_UNSHARESMBFAILED},
113 zfs_share_proto_t nfs_only[] = {
118 zfs_share_proto_t smb_only[] = {
122 zfs_share_proto_t share_all_proto[] = {
128 #pragma init(zfs_iscsi_init)
134 if ((libiscsitgt = dlopen("/lib/libiscsitgt.so.1",
135 RTLD_LAZY | RTLD_GLOBAL)) == NULL ||
136 (iscsitgt_zfs_share = (int (*)(const char *))dlsym(libiscsitgt,
137 "iscsitgt_zfs_share")) == NULL ||
138 (iscsitgt_zfs_unshare = (int (*)(const char *))dlsym(libiscsitgt,
139 "iscsitgt_zfs_unshare")) == NULL ||
140 (iscsitgt_zfs_is_shared = (int (*)(const char *))dlsym(libiscsitgt,
141 "iscsitgt_zfs_is_shared")) == NULL ||
142 (iscsitgt_svc_online = (int (*)(const char *))dlsym(libiscsitgt,
143 "iscsitgt_svc_online")) == NULL) {
144 iscsitgt_zfs_share = NULL;
145 iscsitgt_zfs_unshare = NULL;
146 iscsitgt_zfs_is_shared = NULL;
147 iscsitgt_svc_online = NULL;
152 * Search the sharetab for the given mountpoint and protocol, returning
153 * a zfs_share_type_t value.
155 static zfs_share_type_t
156 is_shared(libzfs_handle_t *hdl, const char *mountpoint, zfs_share_proto_t proto)
158 char buf[MAXPATHLEN], *tab;
161 if (hdl->libzfs_sharetab == NULL)
162 return (SHARED_NOT_SHARED);
164 (void) fseek(hdl->libzfs_sharetab, 0, SEEK_SET);
166 while (fgets(buf, sizeof (buf), hdl->libzfs_sharetab) != NULL) {
168 /* the mountpoint is the first entry on each line */
169 if ((tab = strchr(buf, '\t')) == NULL)
173 if (strcmp(buf, mountpoint) == 0) {
175 * the protocol field is the third field
176 * skip over second field
179 if ((tab = strchr(ptr, '\t')) == NULL)
182 if ((tab = strchr(ptr, '\t')) == NULL)
186 proto_table[proto].p_name) == 0) {
199 return (SHARED_NOT_SHARED);
203 * Returns true if the specified directory is empty. If we can't open the
204 * directory at all, return true so that the mount can fail with a more
205 * informative error message.
208 dir_is_empty(const char *dirname)
213 if ((dirp = opendir(dirname)) == NULL)
216 while ((dp = readdir64(dirp)) != NULL) {
218 if (strcmp(dp->d_name, ".") == 0 ||
219 strcmp(dp->d_name, "..") == 0)
222 (void) closedir(dirp);
226 (void) closedir(dirp);
231 * Checks to see if the mount is active. If the filesystem is mounted, we fill
232 * in 'where' with the current mountpoint, and return 1. Otherwise, we return
236 is_mounted(libzfs_handle_t *zfs_hdl, const char *special, char **where)
240 if (libzfs_mnttab_find(zfs_hdl, special, &entry) != 0)
244 *where = zfs_strdup(zfs_hdl, entry.mnt_mountp);
250 zfs_is_mounted(zfs_handle_t *zhp, char **where)
252 return (is_mounted(zhp->zfs_hdl, zfs_get_name(zhp), where));
256 * Returns true if the given dataset is mountable, false otherwise. Returns the
257 * mountpoint in 'buf'.
260 zfs_is_mountable(zfs_handle_t *zhp, char *buf, size_t buflen,
261 zprop_source_t *source)
263 char sourceloc[ZFS_MAXNAMELEN];
264 zprop_source_t sourcetype;
266 if (!zfs_prop_valid_for_type(ZFS_PROP_MOUNTPOINT, zhp->zfs_type))
269 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, buf, buflen,
270 &sourcetype, sourceloc, sizeof (sourceloc), B_FALSE) == 0);
272 if (strcmp(buf, ZFS_MOUNTPOINT_NONE) == 0 ||
273 strcmp(buf, ZFS_MOUNTPOINT_LEGACY) == 0)
276 if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == ZFS_CANMOUNT_OFF)
279 if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED) &&
280 getzoneid() == GLOBAL_ZONEID)
284 *source = sourcetype;
290 * Mount the given filesystem.
293 zfs_mount(zfs_handle_t *zhp, const char *options, int flags)
296 char mountpoint[ZFS_MAXPROPLEN];
297 char mntopts[MNT_LINE_MAX];
298 libzfs_handle_t *hdl = zhp->zfs_hdl;
303 (void) strlcpy(mntopts, options, sizeof (mntopts));
305 if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint), NULL))
308 /* Create the directory if it doesn't already exist */
309 if (lstat(mountpoint, &buf) != 0) {
310 if (mkdirp(mountpoint, 0755) != 0) {
311 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
312 "failed to create mountpoint"));
313 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
314 dgettext(TEXT_DOMAIN, "cannot mount '%s'"),
320 * Determine if the mountpoint is empty. If so, refuse to perform the
321 * mount. We don't perform this check if MS_OVERLAY is specified, which
322 * would defeat the point. We also avoid this check if 'remount' is
325 if ((flags & MS_OVERLAY) == 0 &&
326 strstr(mntopts, MNTOPT_REMOUNT) == NULL &&
327 !dir_is_empty(mountpoint)) {
328 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
329 "directory is not empty"));
330 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
331 dgettext(TEXT_DOMAIN, "cannot mount '%s'"), mountpoint));
334 /* perform the mount */
335 if (mount(zfs_get_name(zhp), mountpoint, MS_OPTIONSTR | flags,
336 MNTTYPE_ZFS, NULL, 0, mntopts, sizeof (mntopts)) != 0) {
338 * Generic errors are nasty, but there are just way too many
339 * from mount(), and they're well-understood. We pick a few
340 * common ones to improve upon.
342 if (errno == EBUSY) {
343 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
344 "mountpoint or dataset is busy"));
345 } else if (errno == EPERM) {
346 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
347 "Insufficient privileges"));
349 zfs_error_aux(hdl, strerror(errno));
351 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
352 dgettext(TEXT_DOMAIN, "cannot mount '%s'"),
356 /* add the mounted entry into our cache */
357 libzfs_mnttab_add(hdl, zfs_get_name(zhp), mountpoint,
363 * Unmount a single filesystem.
366 unmount_one(libzfs_handle_t *hdl, const char *mountpoint, int flags)
368 if (umount2(mountpoint, flags) != 0) {
369 zfs_error_aux(hdl, strerror(errno));
370 return (zfs_error_fmt(hdl, EZFS_UMOUNTFAILED,
371 dgettext(TEXT_DOMAIN, "cannot unmount '%s'"),
379 * Unmount the given filesystem.
382 zfs_unmount(zfs_handle_t *zhp, const char *mountpoint, int flags)
384 libzfs_handle_t *hdl = zhp->zfs_hdl;
388 /* check to see if we need to unmount the filesystem */
389 if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
390 libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0)) {
392 * mountpoint may have come from a call to
393 * getmnt/getmntany if it isn't NULL. If it is NULL,
394 * we know it comes from libzfs_mnttab_find which can
395 * then get freed later. We strdup it to play it safe.
397 if (mountpoint == NULL)
398 mntpt = zfs_strdup(hdl, entry.mnt_mountp);
400 mntpt = zfs_strdup(hdl, mountpoint);
403 * Unshare and unmount the filesystem
405 if (zfs_unshare_proto(zhp, mntpt, share_all_proto) != 0)
408 if (unmount_one(hdl, mntpt, flags) != 0) {
410 (void) zfs_shareall(zhp);
413 libzfs_mnttab_remove(hdl, zhp->zfs_name);
421 * Unmount this filesystem and any children inheriting the mountpoint property.
422 * To do this, just act like we're changing the mountpoint property, but don't
423 * remount the filesystems afterwards.
426 zfs_unmountall(zfs_handle_t *zhp, int flags)
428 prop_changelist_t *clp;
431 clp = changelist_gather(zhp, ZFS_PROP_MOUNTPOINT, 0, flags);
435 ret = changelist_prefix(clp);
436 changelist_free(clp);
442 zfs_is_shared(zfs_handle_t *zhp)
444 zfs_share_type_t rc = 0;
445 zfs_share_proto_t *curr_proto;
447 if (ZFS_IS_VOLUME(zhp))
448 return (zfs_is_shared_iscsi(zhp));
450 for (curr_proto = share_all_proto; *curr_proto != PROTO_END;
452 rc |= zfs_is_shared_proto(zhp, NULL, *curr_proto);
454 return (rc ? B_TRUE : B_FALSE);
458 zfs_share(zfs_handle_t *zhp)
460 if (ZFS_IS_VOLUME(zhp))
461 return (zfs_share_iscsi(zhp));
463 return (zfs_share_proto(zhp, share_all_proto));
467 zfs_unshare(zfs_handle_t *zhp)
469 if (ZFS_IS_VOLUME(zhp))
470 return (zfs_unshare_iscsi(zhp));
472 return (zfs_unshareall(zhp));
476 * Check to see if the filesystem is currently shared.
479 zfs_is_shared_proto(zfs_handle_t *zhp, char **where, zfs_share_proto_t proto)
484 if (!zfs_is_mounted(zhp, &mountpoint))
485 return (SHARED_NOT_SHARED);
487 if (rc = is_shared(zhp->zfs_hdl, mountpoint, proto)) {
495 return (SHARED_NOT_SHARED);
500 zfs_is_shared_nfs(zfs_handle_t *zhp, char **where)
502 return (zfs_is_shared_proto(zhp, where,
503 PROTO_NFS) != SHARED_NOT_SHARED);
507 zfs_is_shared_smb(zfs_handle_t *zhp, char **where)
509 return (zfs_is_shared_proto(zhp, where,
510 PROTO_SMB) != SHARED_NOT_SHARED);
514 * Make sure things will work if libshare isn't installed by using
515 * wrapper functions that check to see that the pointers to functions
516 * initialized in _zfs_init_libshare() are actually present.
519 static sa_handle_t (*_sa_init)(int);
520 static void (*_sa_fini)(sa_handle_t);
521 static sa_share_t (*_sa_find_share)(sa_handle_t, char *);
522 static int (*_sa_enable_share)(sa_share_t, char *);
523 static int (*_sa_disable_share)(sa_share_t, char *);
524 static char *(*_sa_errorstr)(int);
525 static int (*_sa_parse_legacy_options)(sa_group_t, char *, char *);
526 static boolean_t (*_sa_needs_refresh)(sa_handle_t *);
527 static libzfs_handle_t *(*_sa_get_zfs_handle)(sa_handle_t);
528 static int (*_sa_zfs_process_share)(sa_handle_t, sa_group_t, sa_share_t,
529 char *, char *, zprop_source_t, char *, char *, char *);
530 static void (*_sa_update_sharetab_ts)(sa_handle_t);
533 * _zfs_init_libshare()
535 * Find the libshare.so.1 entry points that we use here and save the
536 * values to be used later. This is triggered by the runtime loader.
537 * Make sure the correct ISA version is loaded.
540 #pragma init(_zfs_init_libshare)
542 _zfs_init_libshare(void)
545 char path[MAXPATHLEN];
549 if (sysinfo(SI_ARCHITECTURE_64, isa, MAXISALEN) == -1)
554 (void) snprintf(path, MAXPATHLEN,
555 "/usr/lib/%s/libshare.so.1", isa);
557 if ((libshare = dlopen(path, RTLD_LAZY | RTLD_GLOBAL)) != NULL) {
558 _sa_init = (sa_handle_t (*)(int))dlsym(libshare, "sa_init");
559 _sa_fini = (void (*)(sa_handle_t))dlsym(libshare, "sa_fini");
560 _sa_find_share = (sa_share_t (*)(sa_handle_t, char *))
561 dlsym(libshare, "sa_find_share");
562 _sa_enable_share = (int (*)(sa_share_t, char *))dlsym(libshare,
564 _sa_disable_share = (int (*)(sa_share_t, char *))dlsym(libshare,
566 _sa_errorstr = (char *(*)(int))dlsym(libshare, "sa_errorstr");
567 _sa_parse_legacy_options = (int (*)(sa_group_t, char *, char *))
568 dlsym(libshare, "sa_parse_legacy_options");
569 _sa_needs_refresh = (boolean_t (*)(sa_handle_t *))
570 dlsym(libshare, "sa_needs_refresh");
571 _sa_get_zfs_handle = (libzfs_handle_t *(*)(sa_handle_t))
572 dlsym(libshare, "sa_get_zfs_handle");
573 _sa_zfs_process_share = (int (*)(sa_handle_t, sa_group_t,
574 sa_share_t, char *, char *, zprop_source_t, char *,
575 char *, char *))dlsym(libshare, "sa_zfs_process_share");
576 _sa_update_sharetab_ts = (void (*)(sa_handle_t))
577 dlsym(libshare, "sa_update_sharetab_ts");
578 if (_sa_init == NULL || _sa_fini == NULL ||
579 _sa_find_share == NULL || _sa_enable_share == NULL ||
580 _sa_disable_share == NULL || _sa_errorstr == NULL ||
581 _sa_parse_legacy_options == NULL ||
582 _sa_needs_refresh == NULL || _sa_get_zfs_handle == NULL ||
583 _sa_zfs_process_share == NULL ||
584 _sa_update_sharetab_ts == NULL) {
587 _sa_disable_share = NULL;
588 _sa_enable_share = NULL;
590 _sa_parse_legacy_options = NULL;
591 (void) dlclose(libshare);
592 _sa_needs_refresh = NULL;
593 _sa_get_zfs_handle = NULL;
594 _sa_zfs_process_share = NULL;
595 _sa_update_sharetab_ts = NULL;
601 * zfs_init_libshare(zhandle, service)
603 * Initialize the libshare API if it hasn't already been initialized.
604 * In all cases it returns 0 if it succeeded and an error if not. The
605 * service value is which part(s) of the API to initialize and is a
606 * direct map to the libshare sa_init(service) interface.
609 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)
643 * zfs_uninit_libshare(zhandle)
645 * Uninitialize the libshare API if it hasn't already been
646 * uninitialized. It is OK to call multiple times.
649 zfs_uninit_libshare(libzfs_handle_t *zhandle)
651 if (zhandle != NULL && zhandle->libzfs_sharehdl != NULL) {
652 if (_sa_fini != NULL)
653 _sa_fini(zhandle->libzfs_sharehdl);
654 zhandle->libzfs_sharehdl = NULL;
659 * zfs_parse_options(options, proto)
661 * Call the legacy parse interface to get the protocol specific
662 * options using the NULL arg to indicate that this is a "parse" only.
665 zfs_parse_options(char *options, zfs_share_proto_t proto)
667 if (_sa_parse_legacy_options != NULL) {
668 return (_sa_parse_legacy_options(NULL, options,
669 proto_table[proto].p_name));
671 return (SA_CONFIG_ERR);
675 * zfs_sa_find_share(handle, path)
677 * wrapper around sa_find_share to find a share path in the
681 zfs_sa_find_share(sa_handle_t handle, char *path)
683 if (_sa_find_share != NULL)
684 return (_sa_find_share(handle, path));
689 * zfs_sa_enable_share(share, proto)
691 * Wrapper for sa_enable_share which enables a share for a specified
695 zfs_sa_enable_share(sa_share_t share, char *proto)
697 if (_sa_enable_share != NULL)
698 return (_sa_enable_share(share, proto));
699 return (SA_CONFIG_ERR);
703 * zfs_sa_disable_share(share, proto)
705 * Wrapper for sa_enable_share which disables a share for a specified
709 zfs_sa_disable_share(sa_share_t share, char *proto)
711 if (_sa_disable_share != NULL)
712 return (_sa_disable_share(share, proto));
713 return (SA_CONFIG_ERR);
717 * Share the given filesystem according to the options in the specified
718 * protocol specific properties (sharenfs, sharesmb). We rely
719 * on "libshare" to the dirty work for us.
722 zfs_share_proto(zfs_handle_t *zhp, zfs_share_proto_t *proto)
724 char mountpoint[ZFS_MAXPROPLEN];
725 char shareopts[ZFS_MAXPROPLEN];
726 char sourcestr[ZFS_MAXPROPLEN];
727 libzfs_handle_t *hdl = zhp->zfs_hdl;
729 zfs_share_proto_t *curr_proto;
730 zprop_source_t sourcetype;
733 if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint), NULL))
736 if ((ret = zfs_init_libshare(hdl, SA_INIT_SHARE_API)) != SA_OK) {
737 (void) zfs_error_fmt(hdl, EZFS_SHARENFSFAILED,
738 dgettext(TEXT_DOMAIN, "cannot share '%s': %s"),
739 zfs_get_name(zhp), _sa_errorstr != NULL ?
740 _sa_errorstr(ret) : "");
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 * If the 'zoned' property is set, then zfs_is_mountable()
756 * will have already bailed out if we are in the global zone.
757 * But local zones cannot be NFS servers, so we ignore it for
758 * local zones as well.
760 if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED))
763 share = zfs_sa_find_share(hdl->libzfs_sharehdl, mountpoint);
766 * This may be a new file system that was just
767 * created so isn't in the internal cache
768 * (second time through). Rather than
769 * reloading the entire configuration, we can
770 * assume ZFS has done the checking and it is
771 * safe to add this to the internal
774 if (_sa_zfs_process_share(hdl->libzfs_sharehdl,
775 NULL, NULL, mountpoint,
776 proto_table[*curr_proto].p_name, sourcetype,
777 shareopts, sourcestr, zhp->zfs_name) != SA_OK) {
778 (void) zfs_error_fmt(hdl,
779 proto_table[*curr_proto].p_share_err,
780 dgettext(TEXT_DOMAIN, "cannot share '%s'"),
784 hdl->libzfs_shareflags |= ZFSSHARE_MISS;
785 share = zfs_sa_find_share(hdl->libzfs_sharehdl,
790 err = zfs_sa_enable_share(share,
791 proto_table[*curr_proto].p_name);
793 (void) zfs_error_fmt(hdl,
794 proto_table[*curr_proto].p_share_err,
795 dgettext(TEXT_DOMAIN, "cannot share '%s'"),
800 (void) zfs_error_fmt(hdl,
801 proto_table[*curr_proto].p_share_err,
802 dgettext(TEXT_DOMAIN, "cannot share '%s'"),
813 zfs_share_nfs(zfs_handle_t *zhp)
815 return (zfs_share_proto(zhp, nfs_only));
819 zfs_share_smb(zfs_handle_t *zhp)
821 return (zfs_share_proto(zhp, smb_only));
825 zfs_shareall(zfs_handle_t *zhp)
827 return (zfs_share_proto(zhp, share_all_proto));
831 * Unshare a filesystem by mountpoint.
834 unshare_one(libzfs_handle_t *hdl, const char *name, const char *mountpoint,
835 zfs_share_proto_t proto)
841 * Mountpoint could get trashed if libshare calls getmntany
842 * which it does during API initialization, so strdup the
845 mntpt = zfs_strdup(hdl, mountpoint);
847 /* make sure libshare initialized */
848 if ((err = zfs_init_libshare(hdl, SA_INIT_SHARE_API)) != SA_OK) {
849 free(mntpt); /* don't need the copy anymore */
850 return (zfs_error_fmt(hdl, EZFS_SHARENFSFAILED,
851 dgettext(TEXT_DOMAIN, "cannot unshare '%s': %s"),
852 name, _sa_errorstr(err)));
855 share = zfs_sa_find_share(hdl->libzfs_sharehdl, mntpt);
856 free(mntpt); /* don't need the copy anymore */
859 err = zfs_sa_disable_share(share, proto_table[proto].p_name);
861 return (zfs_error_fmt(hdl, EZFS_UNSHARENFSFAILED,
862 dgettext(TEXT_DOMAIN, "cannot unshare '%s': %s"),
863 name, _sa_errorstr(err)));
866 return (zfs_error_fmt(hdl, EZFS_UNSHARENFSFAILED,
867 dgettext(TEXT_DOMAIN, "cannot unshare '%s': not found"),
874 * Unshare the given filesystem.
877 zfs_unshare_proto(zfs_handle_t *zhp, const char *mountpoint,
878 zfs_share_proto_t *proto)
880 libzfs_handle_t *hdl = zhp->zfs_hdl;
884 /* check to see if need to unmount the filesystem */
885 rewind(zhp->zfs_hdl->libzfs_mnttab);
886 if (mountpoint != NULL)
887 mountpoint = mntpt = zfs_strdup(hdl, mountpoint);
889 if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
890 libzfs_mnttab_find(hdl, zfs_get_name(zhp), &entry) == 0)) {
891 zfs_share_proto_t *curr_proto;
893 if (mountpoint == NULL)
894 mntpt = zfs_strdup(zhp->zfs_hdl, entry.mnt_mountp);
896 for (curr_proto = proto; *curr_proto != PROTO_END;
899 if (is_shared(hdl, mntpt, *curr_proto) &&
900 unshare_one(hdl, zhp->zfs_name,
901 mntpt, *curr_proto) != 0) {
915 zfs_unshare_nfs(zfs_handle_t *zhp, const char *mountpoint)
917 return (zfs_unshare_proto(zhp, mountpoint, nfs_only));
921 zfs_unshare_smb(zfs_handle_t *zhp, const char *mountpoint)
923 return (zfs_unshare_proto(zhp, mountpoint, smb_only));
927 * Same as zfs_unmountall(), but for NFS and SMB unshares.
930 zfs_unshareall_proto(zfs_handle_t *zhp, zfs_share_proto_t *proto)
932 prop_changelist_t *clp;
935 clp = changelist_gather(zhp, ZFS_PROP_SHARENFS, 0, 0);
939 ret = changelist_unshare(clp, proto);
940 changelist_free(clp);
946 zfs_unshareall_nfs(zfs_handle_t *zhp)
948 return (zfs_unshareall_proto(zhp, nfs_only));
952 zfs_unshareall_smb(zfs_handle_t *zhp)
954 return (zfs_unshareall_proto(zhp, smb_only));
958 zfs_unshareall(zfs_handle_t *zhp)
960 return (zfs_unshareall_proto(zhp, share_all_proto));
964 zfs_unshareall_bypath(zfs_handle_t *zhp, const char *mountpoint)
966 return (zfs_unshare_proto(zhp, mountpoint, share_all_proto));
970 * Remove the mountpoint associated with the current dataset, if necessary.
971 * We only remove the underlying directory if:
973 * - The mountpoint is not 'none' or 'legacy'
974 * - The mountpoint is non-empty
975 * - The mountpoint is the default or inherited
976 * - The 'zoned' property is set, or we're in a local zone
978 * Any other directories we leave alone.
981 remove_mountpoint(zfs_handle_t *zhp)
983 char mountpoint[ZFS_MAXPROPLEN];
984 zprop_source_t source;
986 if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint),
990 if (source == ZPROP_SRC_DEFAULT ||
991 source == ZPROP_SRC_INHERITED) {
993 * Try to remove the directory, silently ignoring any errors.
994 * The filesystem may have since been removed or moved around,
995 * and this error isn't really useful to the administrator in
998 (void) rmdir(mountpoint);
1003 zfs_is_shared_iscsi(zfs_handle_t *zhp)
1007 * If iscsi deamon isn't running then we aren't shared
1009 if (iscsitgt_svc_online && iscsitgt_svc_online() == 1)
1012 return (iscsitgt_zfs_is_shared != NULL &&
1013 iscsitgt_zfs_is_shared(zhp->zfs_name) != 0);
1017 zfs_share_iscsi(zfs_handle_t *zhp)
1019 char shareopts[ZFS_MAXPROPLEN];
1020 const char *dataset = zhp->zfs_name;
1021 libzfs_handle_t *hdl = zhp->zfs_hdl;
1024 * Return success if there are no share options.
1026 if (zfs_prop_get(zhp, ZFS_PROP_SHAREISCSI, shareopts,
1027 sizeof (shareopts), NULL, NULL, 0, B_FALSE) != 0 ||
1028 strcmp(shareopts, "off") == 0)
1031 if (iscsitgt_zfs_share == NULL || iscsitgt_zfs_share(dataset) != 0) {
1032 int error = EZFS_SHAREISCSIFAILED;
1035 * If service isn't availabele and EPERM was
1036 * returned then use special error.
1038 if (iscsitgt_svc_online && errno == EPERM &&
1039 (iscsitgt_svc_online() != 0))
1040 error = EZFS_ISCSISVCUNAVAIL;
1042 return (zfs_error_fmt(hdl, error,
1043 dgettext(TEXT_DOMAIN, "cannot share '%s'"), dataset));
1050 zfs_unshare_iscsi(zfs_handle_t *zhp)
1052 const char *dataset = zfs_get_name(zhp);
1053 libzfs_handle_t *hdl = zhp->zfs_hdl;
1056 * Return if the volume is not shared
1058 if (zfs_is_shared_iscsi(zhp) != SHARED_ISCSI)
1062 * If this fails with ENODEV it indicates that zvol wasn't shared so
1063 * we should return success in that case.
1065 if (iscsitgt_zfs_unshare == NULL ||
1066 (iscsitgt_zfs_unshare(dataset) != 0 && errno != ENODEV)) {
1068 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1069 "Insufficient privileges to unshare iscsi"));
1070 return (zfs_error_fmt(hdl, EZFS_UNSHAREISCSIFAILED,
1071 dgettext(TEXT_DOMAIN, "cannot unshare '%s'"), dataset));
1077 typedef struct mount_cbdata {
1078 zfs_handle_t **cb_datasets;
1084 mount_cb(zfs_handle_t *zhp, void *data)
1086 mount_cbdata_t *cbp = data;
1088 if (!(zfs_get_type(zhp) & (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME))) {
1093 if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == ZFS_CANMOUNT_NOAUTO) {
1098 if (cbp->cb_alloc == cbp->cb_used) {
1101 if ((ptr = zfs_realloc(zhp->zfs_hdl,
1102 cbp->cb_datasets, cbp->cb_alloc * sizeof (void *),
1103 cbp->cb_alloc * 2 * sizeof (void *))) == NULL)
1105 cbp->cb_datasets = ptr;
1110 cbp->cb_datasets[cbp->cb_used++] = zhp;
1112 return (zfs_iter_filesystems(zhp, mount_cb, cbp));
1116 dataset_cmp(const void *a, const void *b)
1118 zfs_handle_t **za = (zfs_handle_t **)a;
1119 zfs_handle_t **zb = (zfs_handle_t **)b;
1120 char mounta[MAXPATHLEN];
1121 char mountb[MAXPATHLEN];
1122 boolean_t gota, gotb;
1124 if ((gota = (zfs_get_type(*za) == ZFS_TYPE_FILESYSTEM)) != 0)
1125 verify(zfs_prop_get(*za, ZFS_PROP_MOUNTPOINT, mounta,
1126 sizeof (mounta), NULL, NULL, 0, B_FALSE) == 0);
1127 if ((gotb = (zfs_get_type(*zb) == ZFS_TYPE_FILESYSTEM)) != 0)
1128 verify(zfs_prop_get(*zb, ZFS_PROP_MOUNTPOINT, mountb,
1129 sizeof (mountb), NULL, NULL, 0, B_FALSE) == 0);
1132 return (strcmp(mounta, mountb));
1139 return (strcmp(zfs_get_name(a), zfs_get_name(b)));
1143 * Mount and share all datasets within the given pool. This assumes that no
1144 * datasets within the pool are currently mounted. Because users can create
1145 * complicated nested hierarchies of mountpoints, we first gather all the
1146 * datasets and mountpoints within the pool, and sort them by mountpoint. Once
1147 * we have the list of all filesystems, we iterate over them in order and mount
1148 * and/or share each one.
1150 #pragma weak zpool_mount_datasets = zpool_enable_datasets
1152 zpool_enable_datasets(zpool_handle_t *zhp, const char *mntopts, int flags)
1154 mount_cbdata_t cb = { 0 };
1155 libzfs_handle_t *hdl = zhp->zpool_hdl;
1161 * Gather all non-snap datasets within the pool.
1163 if ((cb.cb_datasets = zfs_alloc(hdl, 4 * sizeof (void *))) == NULL)
1167 if ((zfsp = zfs_open(hdl, zhp->zpool_name, ZFS_TYPE_DATASET)) == NULL)
1170 cb.cb_datasets[0] = zfsp;
1173 if (zfs_iter_filesystems(zfsp, mount_cb, &cb) != 0)
1177 * Sort the datasets by mountpoint.
1179 qsort(cb.cb_datasets, cb.cb_used, sizeof (void *), dataset_cmp);
1182 * And mount all the datasets, keeping track of which ones
1183 * succeeded or failed. By using zfs_alloc(), the good pointer
1184 * will always be non-NULL.
1186 good = zfs_alloc(zhp->zpool_hdl, cb.cb_used * sizeof (int));
1188 for (i = 0; i < cb.cb_used; i++) {
1189 if (zfs_mount(cb.cb_datasets[i], mntopts, flags) != 0)
1196 * Then share all the ones that need to be shared. This needs
1197 * to be a separate pass in order to avoid excessive reloading
1198 * of the configuration. Good should never be NULL since
1199 * zfs_alloc is supposed to exit if memory isn't available.
1201 for (i = 0; i < cb.cb_used; i++) {
1202 if (good[i] && zfs_share(cb.cb_datasets[i]) != 0)
1209 for (i = 0; i < cb.cb_used; i++)
1210 zfs_close(cb.cb_datasets[i]);
1211 free(cb.cb_datasets);
1218 zvol_cb(const char *dataset, void *data)
1220 libzfs_handle_t *hdl = data;
1224 * Ignore snapshots and ignore failures from non-existant datasets.
1226 if (strchr(dataset, '@') != NULL ||
1227 (zhp = zfs_open(hdl, dataset, ZFS_TYPE_VOLUME)) == NULL)
1230 if (zfs_unshare_iscsi(zhp) != 0)
1239 mountpoint_compare(const void *a, const void *b)
1241 const char *mounta = *((char **)a);
1242 const char *mountb = *((char **)b);
1244 return (strcmp(mountb, mounta));
1248 * Unshare and unmount all datasets within the given pool. We don't want to
1249 * rely on traversing the DSL to discover the filesystems within the pool,
1250 * because this may be expensive (if not all of them are mounted), and can fail
1251 * arbitrarily (on I/O error, for example). Instead, we walk /etc/mnttab and
1252 * gather all the filesystems that are currently mounted.
1254 #pragma weak zpool_unmount_datasets = zpool_disable_datasets
1256 zpool_disable_datasets(zpool_handle_t *zhp, boolean_t force)
1259 struct mnttab entry;
1261 char **mountpoints = NULL;
1262 zfs_handle_t **datasets = NULL;
1263 libzfs_handle_t *hdl = zhp->zpool_hdl;
1266 int flags = (force ? MS_FORCE : 0);
1269 * First unshare all zvols.
1271 if (zpool_iter_zvol(zhp, zvol_cb, hdl) != 0)
1274 namelen = strlen(zhp->zpool_name);
1276 rewind(hdl->libzfs_mnttab);
1278 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
1280 * Ignore non-ZFS entries.
1282 if (entry.mnt_fstype == NULL ||
1283 strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
1287 * Ignore filesystems not within this pool.
1289 if (entry.mnt_mountp == NULL ||
1290 strncmp(entry.mnt_special, zhp->zpool_name, namelen) != 0 ||
1291 (entry.mnt_special[namelen] != '/' &&
1292 entry.mnt_special[namelen] != '\0'))
1296 * At this point we've found a filesystem within our pool. Add
1297 * it to our growing list.
1299 if (used == alloc) {
1301 if ((mountpoints = zfs_alloc(hdl,
1302 8 * sizeof (void *))) == NULL)
1305 if ((datasets = zfs_alloc(hdl,
1306 8 * sizeof (void *))) == NULL)
1313 if ((ptr = zfs_realloc(hdl, mountpoints,
1314 alloc * sizeof (void *),
1315 alloc * 2 * sizeof (void *))) == NULL)
1319 if ((ptr = zfs_realloc(hdl, datasets,
1320 alloc * sizeof (void *),
1321 alloc * 2 * sizeof (void *))) == NULL)
1329 if ((mountpoints[used] = zfs_strdup(hdl,
1330 entry.mnt_mountp)) == NULL)
1334 * This is allowed to fail, in case there is some I/O error. It
1335 * is only used to determine if we need to remove the underlying
1336 * mountpoint, so failure is not fatal.
1338 datasets[used] = make_dataset_handle(hdl, entry.mnt_special);
1344 * At this point, we have the entire list of filesystems, so sort it by
1347 qsort(mountpoints, used, sizeof (char *), mountpoint_compare);
1350 * Walk through and first unshare everything.
1352 for (i = 0; i < used; i++) {
1353 zfs_share_proto_t *curr_proto;
1354 for (curr_proto = share_all_proto; *curr_proto != PROTO_END;
1356 if (is_shared(hdl, mountpoints[i], *curr_proto) &&
1357 unshare_one(hdl, mountpoints[i],
1358 mountpoints[i], *curr_proto) != 0)
1364 * Now unmount everything, removing the underlying directories as
1367 for (i = 0; i < used; i++) {
1368 if (unmount_one(hdl, mountpoints[i], flags) != 0)
1372 for (i = 0; i < used; i++) {
1374 remove_mountpoint(datasets[i]);
1379 for (i = 0; i < used; i++) {
1381 zfs_close(datasets[i]);
1382 free(mountpoints[i]);