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>
78 #include "libzfs_impl.h"
81 #include <sys/systeminfo.h>
82 #define MAXISALEN 257 /* based on sysinfo(2) man page */
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 **,
89 * The share protocols table must be in the same order as the zfs_share_prot_t
90 * enum in libzfs_impl.h
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
},
104 zfs_share_proto_t nfs_only
[] = {
109 zfs_share_proto_t smb_only
[] = {
113 zfs_share_proto_t share_all_proto
[] = {
120 * Search the sharetab for the given mountpoint and protocol, returning
121 * a zfs_share_type_t value.
123 static zfs_share_type_t
124 is_shared(libzfs_handle_t
*hdl
, const char *mountpoint
, zfs_share_proto_t proto
)
126 char buf
[MAXPATHLEN
], *tab
;
129 if (hdl
->libzfs_sharetab
== NULL
)
130 return (SHARED_NOT_SHARED
);
132 (void) fseek(hdl
->libzfs_sharetab
, 0, SEEK_SET
);
134 while (fgets(buf
, sizeof (buf
), hdl
->libzfs_sharetab
) != NULL
) {
136 /* the mountpoint is the first entry on each line */
137 if ((tab
= strchr(buf
, '\t')) == NULL
)
141 if (strcmp(buf
, mountpoint
) == 0) {
143 * the protocol field is the third field
144 * skip over second field
147 if ((tab
= strchr(ptr
, '\t')) == NULL
)
150 if ((tab
= strchr(ptr
, '\t')) == NULL
)
154 proto_table
[proto
].p_name
) == 0) {
167 return (SHARED_NOT_SHARED
);
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.
176 dir_is_empty(const char *dirname
)
181 if ((dirp
= opendir(dirname
)) == NULL
)
184 while ((dp
= readdir64(dirp
)) != NULL
) {
186 if (strcmp(dp
->d_name
, ".") == 0 ||
187 strcmp(dp
->d_name
, "..") == 0)
190 (void) closedir(dirp
);
194 (void) closedir(dirp
);
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
204 is_mounted(libzfs_handle_t
*zfs_hdl
, const char *special
, char **where
)
208 if (libzfs_mnttab_find(zfs_hdl
, special
, &entry
) != 0)
212 *where
= zfs_strdup(zfs_hdl
, entry
.mnt_mountp
);
218 zfs_is_mounted(zfs_handle_t
*zhp
, char **where
)
220 return (is_mounted(zhp
->zfs_hdl
, zfs_get_name(zhp
), where
));
224 * Returns true if the given dataset is mountable, false otherwise. Returns the
225 * mountpoint in 'buf'.
228 zfs_is_mountable(zfs_handle_t
*zhp
, char *buf
, size_t buflen
,
229 zprop_source_t
*source
)
231 char sourceloc
[ZFS_MAXNAMELEN
];
232 zprop_source_t sourcetype
;
234 if (!zfs_prop_valid_for_type(ZFS_PROP_MOUNTPOINT
, zhp
->zfs_type
))
237 verify(zfs_prop_get(zhp
, ZFS_PROP_MOUNTPOINT
, buf
, buflen
,
238 &sourcetype
, sourceloc
, sizeof (sourceloc
), B_FALSE
) == 0);
240 if (strcmp(buf
, ZFS_MOUNTPOINT_NONE
) == 0 ||
241 strcmp(buf
, ZFS_MOUNTPOINT_LEGACY
) == 0)
244 if (zfs_prop_get_int(zhp
, ZFS_PROP_CANMOUNT
) == ZFS_CANMOUNT_OFF
)
247 if (zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
) &&
248 getzoneid() == GLOBAL_ZONEID
)
252 *source
= sourcetype
;
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.
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.
271 * http://www.kernel.org/pub/linux/utils/util-linux/libmount-docs/index.html
275 do_mount(const char *src
, const char *mntpt
, char *opts
)
286 /* Return only the most critical mount error */
287 rc
= libzfs_run_process(argv
[0], argv
, STDOUT_VERBOSE
|STDERR_VERBOSE
);
289 if (rc
& MOUNT_FILEIO
)
293 if (rc
& MOUNT_SOFTWARE
)
295 if (rc
& MOUNT_SYSERR
)
297 if (rc
& MOUNT_USAGE
)
300 return ENXIO
; /* Generic error */
307 do_unmount(const char *mntpt
, int flags
)
309 char force_opt
[] = "-f";
310 char lazy_opt
[] = "-l";
314 NULL
, NULL
, NULL
, NULL
};
317 if (flags
& MS_FORCE
) {
318 argv
[count
] = force_opt
;
322 if (flags
& MS_DETACH
) {
323 argv
[count
] = lazy_opt
;
327 argv
[count
] = (char *)mntpt
;
328 rc
= libzfs_run_process(argv
[0], argv
, STDOUT_VERBOSE
|STDERR_VERBOSE
);
330 return (rc
? EINVAL
: 0);
334 zfs_add_option(zfs_handle_t
*zhp
, char *options
, int len
,
335 zfs_prop_t prop
, char *on
, char *off
)
340 /* Skip adding duplicate default options */
341 if ((strstr(options
, on
) != NULL
) || (strstr(options
, off
) != NULL
))
345 * zfs_prop_get_int() to not used to ensure our mount options
346 * are not influenced by the current /etc/mtab contents.
348 value
= getprop_uint64(zhp
, prop
, &source
);
350 (void) strlcat(options
, ",", len
);
351 (void) strlcat(options
, value
? on
: off
, len
);
357 zfs_add_options(zfs_handle_t
*zhp
, char *options
, int len
)
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
);
380 * Mount the given filesystem.
383 zfs_mount(zfs_handle_t
*zhp
, const char *options
, int flags
)
386 char mountpoint
[ZFS_MAXPROPLEN
];
387 char mntopts
[MNT_LINE_MAX
];
388 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
391 if (options
== NULL
) {
392 (void) strlcpy(mntopts
, MNTOPT_DEFAULTS
, sizeof (mntopts
));
394 (void) strlcpy(mntopts
, options
, sizeof (mntopts
));
397 if (strstr(mntopts
, MNTOPT_REMOUNT
) != NULL
)
401 * If the pool is imported read-only then all mounts must be read-only
403 if (zpool_get_prop_int(zhp
->zpool_hdl
, ZPOOL_PROP_READONLY
, NULL
))
404 (void) strlcat(mntopts
, "," MNTOPT_RO
, sizeof (mntopts
));
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.
413 rc
= zfs_add_options(zhp
, mntopts
, sizeof (mntopts
));
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'"),
423 * Append zfsutil option so the mount helper allow the mount
425 strlcat(mntopts
, "," MNTOPT_ZFSUTIL
, sizeof (mntopts
));
427 if (!zfs_is_mountable(zhp
, mountpoint
, sizeof (mountpoint
), NULL
))
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'"),
442 * Determine if the mountpoint is empty. If so, refuse to perform the
443 * mount. We don't perform this check if 'remount' is
444 * specified or if overlay option(-O) is given
446 if ((flags
& MS_OVERLAY
) == 0 && !remount
&&
447 !dir_is_empty(mountpoint
)) {
448 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
449 "directory is not empty"));
450 return (zfs_error_fmt(hdl
, EZFS_MOUNTFAILED
,
451 dgettext(TEXT_DOMAIN
, "cannot mount '%s'"), mountpoint
));
454 /* perform the mount */
455 rc
= do_mount(zfs_get_name(zhp
), mountpoint
, mntopts
);
458 * Generic errors are nasty, but there are just way too many
459 * from mount(), and they're well-understood. We pick a few
460 * common ones to improve upon.
463 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
464 "mountpoint or dataset is busy"));
465 } else if (rc
== EPERM
) {
466 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
467 "Insufficient privileges"));
468 } else if (rc
== ENOTSUP
) {
472 VERIFY(zfs_spa_version(zhp
, &spa_version
) == 0);
473 (void) snprintf(buf
, sizeof (buf
),
474 dgettext(TEXT_DOMAIN
, "Can't mount a version %lld "
475 "file system on a version %d pool. Pool must be"
476 " upgraded to mount this file system."),
477 (u_longlong_t
)zfs_prop_get_int(zhp
,
478 ZFS_PROP_VERSION
), spa_version
);
479 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, buf
));
481 zfs_error_aux(hdl
, strerror(rc
));
483 return (zfs_error_fmt(hdl
, EZFS_MOUNTFAILED
,
484 dgettext(TEXT_DOMAIN
, "cannot mount '%s'"),
488 /* remove the mounted entry before re-adding on remount */
490 libzfs_mnttab_remove(hdl
, zhp
->zfs_name
);
492 /* add the mounted entry into our cache */
493 libzfs_mnttab_add(hdl
, zfs_get_name(zhp
), mountpoint
, mntopts
);
498 * Unmount a single filesystem.
501 unmount_one(libzfs_handle_t
*hdl
, const char *mountpoint
, int flags
)
505 error
= do_unmount(mountpoint
, flags
);
507 return (zfs_error_fmt(hdl
, EZFS_UMOUNTFAILED
,
508 dgettext(TEXT_DOMAIN
, "cannot unmount '%s'"),
516 * Unmount the given filesystem.
519 zfs_unmount(zfs_handle_t
*zhp
, const char *mountpoint
, int flags
)
521 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
525 /* check to see if we need to unmount the filesystem */
526 if (mountpoint
!= NULL
|| ((zfs_get_type(zhp
) == ZFS_TYPE_FILESYSTEM
) &&
527 libzfs_mnttab_find(hdl
, zhp
->zfs_name
, &entry
) == 0)) {
529 * mountpoint may have come from a call to
530 * getmnt/getmntany if it isn't NULL. If it is NULL,
531 * we know it comes from libzfs_mnttab_find which can
532 * then get freed later. We strdup it to play it safe.
534 if (mountpoint
== NULL
)
535 mntpt
= zfs_strdup(hdl
, entry
.mnt_mountp
);
537 mntpt
= zfs_strdup(hdl
, mountpoint
);
540 * Unshare and unmount the filesystem
542 if (zfs_unshare_proto(zhp
, mntpt
, share_all_proto
) != 0)
545 if (unmount_one(hdl
, mntpt
, flags
) != 0) {
547 (void) zfs_shareall(zhp
);
550 libzfs_mnttab_remove(hdl
, zhp
->zfs_name
);
558 * Unmount this filesystem and any children inheriting the mountpoint property.
559 * To do this, just act like we're changing the mountpoint property, but don't
560 * remount the filesystems afterwards.
563 zfs_unmountall(zfs_handle_t
*zhp
, int flags
)
565 prop_changelist_t
*clp
;
568 clp
= changelist_gather(zhp
, ZFS_PROP_MOUNTPOINT
, 0, flags
);
572 ret
= changelist_prefix(clp
);
573 changelist_free(clp
);
579 zfs_is_shared(zfs_handle_t
*zhp
)
581 zfs_share_type_t rc
= 0;
582 zfs_share_proto_t
*curr_proto
;
584 if (ZFS_IS_VOLUME(zhp
))
587 for (curr_proto
= share_all_proto
; *curr_proto
!= PROTO_END
;
589 rc
|= zfs_is_shared_proto(zhp
, NULL
, *curr_proto
);
591 return (rc
? B_TRUE
: B_FALSE
);
595 zfs_share(zfs_handle_t
*zhp
)
597 assert(!ZFS_IS_VOLUME(zhp
));
598 return (zfs_share_proto(zhp
, share_all_proto
));
602 zfs_unshare(zfs_handle_t
*zhp
)
604 assert(!ZFS_IS_VOLUME(zhp
));
605 return (zfs_unshareall(zhp
));
609 * Check to see if the filesystem is currently shared.
612 zfs_is_shared_proto(zfs_handle_t
*zhp
, char **where
, zfs_share_proto_t proto
)
617 if (!zfs_is_mounted(zhp
, &mountpoint
))
618 return (SHARED_NOT_SHARED
);
620 if ((rc
= is_shared(zhp
->zfs_hdl
, mountpoint
, proto
))) {
628 return (SHARED_NOT_SHARED
);
633 zfs_is_shared_nfs(zfs_handle_t
*zhp
, char **where
)
635 return (zfs_is_shared_proto(zhp
, where
,
636 PROTO_NFS
) != SHARED_NOT_SHARED
);
640 zfs_is_shared_smb(zfs_handle_t
*zhp
, char **where
)
642 return (zfs_is_shared_proto(zhp
, where
,
643 PROTO_SMB
) != SHARED_NOT_SHARED
);
647 * zfs_init_libshare(zhandle, service)
649 * Initialize the libshare API if it hasn't already been initialized.
650 * In all cases it returns 0 if it succeeded and an error if not. The
651 * service value is which part(s) of the API to initialize and is a
652 * direct map to the libshare sa_init(service) interface.
655 zfs_init_libshare(libzfs_handle_t
*zhandle
, int service
)
659 if (ret
== SA_OK
&& zhandle
->libzfs_shareflags
& ZFSSHARE_MISS
) {
661 * We had a cache miss. Most likely it is a new ZFS
662 * dataset that was just created. We want to make sure
663 * so check timestamps to see if a different process
664 * has updated any of the configuration. If there was
665 * some non-ZFS change, we need to re-initialize the
668 zhandle
->libzfs_shareflags
&= ~ZFSSHARE_MISS
;
669 if (sa_needs_refresh(zhandle
->libzfs_sharehdl
)) {
670 zfs_uninit_libshare(zhandle
);
671 zhandle
->libzfs_sharehdl
= sa_init(service
);
675 if (ret
== SA_OK
&& zhandle
&& zhandle
->libzfs_sharehdl
== NULL
)
676 zhandle
->libzfs_sharehdl
= sa_init(service
);
678 if (ret
== SA_OK
&& zhandle
->libzfs_sharehdl
== NULL
)
685 * zfs_uninit_libshare(zhandle)
687 * Uninitialize the libshare API if it hasn't already been
688 * uninitialized. It is OK to call multiple times.
691 zfs_uninit_libshare(libzfs_handle_t
*zhandle
)
693 if (zhandle
!= NULL
&& zhandle
->libzfs_sharehdl
!= NULL
) {
694 sa_fini(zhandle
->libzfs_sharehdl
);
695 zhandle
->libzfs_sharehdl
= NULL
;
700 * zfs_parse_options(options, proto)
702 * Call the legacy parse interface to get the protocol specific
703 * options using the NULL arg to indicate that this is a "parse" only.
706 zfs_parse_options(char *options
, zfs_share_proto_t proto
)
708 return (sa_parse_legacy_options(NULL
, options
,
709 proto_table
[proto
].p_name
));
713 * Share the given filesystem according to the options in the specified
714 * protocol specific properties (sharenfs, sharesmb). We rely
715 * on "libshare" to the dirty work for us.
718 zfs_share_proto(zfs_handle_t
*zhp
, zfs_share_proto_t
*proto
)
720 char mountpoint
[ZFS_MAXPROPLEN
];
721 char shareopts
[ZFS_MAXPROPLEN
];
722 char sourcestr
[ZFS_MAXPROPLEN
];
723 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
725 zfs_share_proto_t
*curr_proto
;
726 zprop_source_t sourcetype
;
729 if (!zfs_is_mountable(zhp
, mountpoint
, sizeof (mountpoint
), NULL
))
732 if ((ret
= zfs_init_libshare(hdl
, SA_INIT_SHARE_API
)) != SA_OK
) {
733 (void) zfs_error_fmt(hdl
, EZFS_SHARENFSFAILED
,
734 dgettext(TEXT_DOMAIN
, "cannot share '%s': %s"),
735 zfs_get_name(zhp
), sa_errorstr(ret
));
739 for (curr_proto
= proto
; *curr_proto
!= PROTO_END
; curr_proto
++) {
741 * Return success if there are no share options.
743 if (zfs_prop_get(zhp
, proto_table
[*curr_proto
].p_prop
,
744 shareopts
, sizeof (shareopts
), &sourcetype
, sourcestr
,
745 ZFS_MAXPROPLEN
, B_FALSE
) != 0 ||
746 strcmp(shareopts
, "off") == 0)
750 * If the 'zoned' property is set, then zfs_is_mountable()
751 * will have already bailed out if we are in the global zone.
752 * But local zones cannot be NFS servers, so we ignore it for
753 * local zones as well.
755 if (zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
))
758 share
= sa_find_share(hdl
->libzfs_sharehdl
, mountpoint
);
761 * This may be a new file system that was just
762 * created so isn't in the internal cache
763 * (second time through). Rather than
764 * reloading the entire configuration, we can
765 * assume ZFS has done the checking and it is
766 * safe to add this to the internal
769 if (sa_zfs_process_share(hdl
->libzfs_sharehdl
,
770 NULL
, NULL
, mountpoint
,
771 proto_table
[*curr_proto
].p_name
, sourcetype
,
772 shareopts
, sourcestr
, zhp
->zfs_name
) != SA_OK
) {
773 (void) zfs_error_fmt(hdl
,
774 proto_table
[*curr_proto
].p_share_err
,
775 dgettext(TEXT_DOMAIN
, "cannot share '%s'"),
779 hdl
->libzfs_shareflags
|= ZFSSHARE_MISS
;
780 share
= sa_find_share(hdl
->libzfs_sharehdl
,
785 err
= sa_enable_share(share
,
786 proto_table
[*curr_proto
].p_name
);
788 (void) zfs_error_fmt(hdl
,
789 proto_table
[*curr_proto
].p_share_err
,
790 dgettext(TEXT_DOMAIN
, "cannot share '%s'"),
795 (void) zfs_error_fmt(hdl
,
796 proto_table
[*curr_proto
].p_share_err
,
797 dgettext(TEXT_DOMAIN
, "cannot share '%s'"),
808 zfs_share_nfs(zfs_handle_t
*zhp
)
810 return (zfs_share_proto(zhp
, nfs_only
));
814 zfs_share_smb(zfs_handle_t
*zhp
)
816 return (zfs_share_proto(zhp
, smb_only
));
820 zfs_shareall(zfs_handle_t
*zhp
)
822 return (zfs_share_proto(zhp
, share_all_proto
));
826 * Unshare a filesystem by mountpoint.
829 unshare_one(libzfs_handle_t
*hdl
, const char *name
, const char *mountpoint
,
830 zfs_share_proto_t proto
)
836 * Mountpoint could get trashed if libshare calls getmntany
837 * which it does during API initialization, so strdup the
840 mntpt
= zfs_strdup(hdl
, mountpoint
);
842 /* make sure libshare initialized */
843 if ((err
= zfs_init_libshare(hdl
, SA_INIT_SHARE_API
)) != SA_OK
) {
844 free(mntpt
); /* don't need the copy anymore */
845 return (zfs_error_fmt(hdl
, EZFS_SHARENFSFAILED
,
846 dgettext(TEXT_DOMAIN
, "cannot unshare '%s': %s"),
847 name
, sa_errorstr(err
)));
850 share
= sa_find_share(hdl
->libzfs_sharehdl
, mntpt
);
851 free(mntpt
); /* don't need the copy anymore */
854 err
= sa_disable_share(share
, proto_table
[proto
].p_name
);
856 return (zfs_error_fmt(hdl
, EZFS_UNSHARENFSFAILED
,
857 dgettext(TEXT_DOMAIN
, "cannot unshare '%s': %s"),
858 name
, sa_errorstr(err
)));
861 return (zfs_error_fmt(hdl
, EZFS_UNSHARENFSFAILED
,
862 dgettext(TEXT_DOMAIN
, "cannot unshare '%s': not found"),
869 * Unshare the given filesystem.
872 zfs_unshare_proto(zfs_handle_t
*zhp
, const char *mountpoint
,
873 zfs_share_proto_t
*proto
)
875 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
879 /* check to see if need to unmount the filesystem */
880 rewind(zhp
->zfs_hdl
->libzfs_mnttab
);
881 if (mountpoint
!= NULL
)
882 mountpoint
= mntpt
= zfs_strdup(hdl
, mountpoint
);
884 if (mountpoint
!= NULL
|| ((zfs_get_type(zhp
) == ZFS_TYPE_FILESYSTEM
) &&
885 libzfs_mnttab_find(hdl
, zfs_get_name(zhp
), &entry
) == 0)) {
886 zfs_share_proto_t
*curr_proto
;
888 if (mountpoint
== NULL
)
889 mntpt
= zfs_strdup(zhp
->zfs_hdl
, entry
.mnt_mountp
);
891 for (curr_proto
= proto
; *curr_proto
!= PROTO_END
;
894 if (is_shared(hdl
, mntpt
, *curr_proto
) &&
895 unshare_one(hdl
, zhp
->zfs_name
,
896 mntpt
, *curr_proto
) != 0) {
910 zfs_unshare_nfs(zfs_handle_t
*zhp
, const char *mountpoint
)
912 return (zfs_unshare_proto(zhp
, mountpoint
, nfs_only
));
916 zfs_unshare_smb(zfs_handle_t
*zhp
, const char *mountpoint
)
918 return (zfs_unshare_proto(zhp
, mountpoint
, smb_only
));
922 * Same as zfs_unmountall(), but for NFS and SMB unshares.
925 zfs_unshareall_proto(zfs_handle_t
*zhp
, zfs_share_proto_t
*proto
)
927 prop_changelist_t
*clp
;
930 clp
= changelist_gather(zhp
, ZFS_PROP_SHARENFS
, 0, 0);
934 ret
= changelist_unshare(clp
, proto
);
935 changelist_free(clp
);
941 zfs_unshareall_nfs(zfs_handle_t
*zhp
)
943 return (zfs_unshareall_proto(zhp
, nfs_only
));
947 zfs_unshareall_smb(zfs_handle_t
*zhp
)
949 return (zfs_unshareall_proto(zhp
, smb_only
));
953 zfs_unshareall(zfs_handle_t
*zhp
)
955 return (zfs_unshareall_proto(zhp
, share_all_proto
));
959 zfs_unshareall_bypath(zfs_handle_t
*zhp
, const char *mountpoint
)
961 return (zfs_unshare_proto(zhp
, mountpoint
, share_all_proto
));
965 * Remove the mountpoint associated with the current dataset, if necessary.
966 * We only remove the underlying directory if:
968 * - The mountpoint is not 'none' or 'legacy'
969 * - The mountpoint is non-empty
970 * - The mountpoint is the default or inherited
971 * - The 'zoned' property is set, or we're in a local zone
973 * Any other directories we leave alone.
976 remove_mountpoint(zfs_handle_t
*zhp
)
978 char mountpoint
[ZFS_MAXPROPLEN
];
979 zprop_source_t source
;
981 if (!zfs_is_mountable(zhp
, mountpoint
, sizeof (mountpoint
),
985 if (source
== ZPROP_SRC_DEFAULT
||
986 source
== ZPROP_SRC_INHERITED
) {
988 * Try to remove the directory, silently ignoring any errors.
989 * The filesystem may have since been removed or moved around,
990 * and this error isn't really useful to the administrator in
993 (void) rmdir(mountpoint
);
998 libzfs_add_handle(get_all_cb_t
*cbp
, zfs_handle_t
*zhp
)
1000 if (cbp
->cb_alloc
== cbp
->cb_used
) {
1004 newsz
= cbp
->cb_alloc
? cbp
->cb_alloc
* 2 : 64;
1005 ptr
= zfs_realloc(zhp
->zfs_hdl
,
1006 cbp
->cb_handles
, cbp
->cb_alloc
* sizeof (void *),
1007 newsz
* sizeof (void *));
1008 cbp
->cb_handles
= ptr
;
1009 cbp
->cb_alloc
= newsz
;
1011 cbp
->cb_handles
[cbp
->cb_used
++] = zhp
;
1015 mount_cb(zfs_handle_t
*zhp
, void *data
)
1017 get_all_cb_t
*cbp
= data
;
1019 if (!(zfs_get_type(zhp
) & ZFS_TYPE_FILESYSTEM
)) {
1024 if (zfs_prop_get_int(zhp
, ZFS_PROP_CANMOUNT
) == ZFS_CANMOUNT_NOAUTO
) {
1029 libzfs_add_handle(cbp
, zhp
);
1030 if (zfs_iter_filesystems(zhp
, mount_cb
, cbp
) != 0) {
1038 libzfs_dataset_cmp(const void *a
, const void *b
)
1040 zfs_handle_t
**za
= (zfs_handle_t
**)a
;
1041 zfs_handle_t
**zb
= (zfs_handle_t
**)b
;
1042 char mounta
[MAXPATHLEN
];
1043 char mountb
[MAXPATHLEN
];
1044 boolean_t gota
, gotb
;
1046 if ((gota
= (zfs_get_type(*za
) == ZFS_TYPE_FILESYSTEM
)) != 0)
1047 verify(zfs_prop_get(*za
, ZFS_PROP_MOUNTPOINT
, mounta
,
1048 sizeof (mounta
), NULL
, NULL
, 0, B_FALSE
) == 0);
1049 if ((gotb
= (zfs_get_type(*zb
) == ZFS_TYPE_FILESYSTEM
)) != 0)
1050 verify(zfs_prop_get(*zb
, ZFS_PROP_MOUNTPOINT
, mountb
,
1051 sizeof (mountb
), NULL
, NULL
, 0, B_FALSE
) == 0);
1054 return (strcmp(mounta
, mountb
));
1061 return (strcmp(zfs_get_name(a
), zfs_get_name(b
)));
1065 * Mount and share all datasets within the given pool. This assumes that no
1066 * datasets within the pool are currently mounted. Because users can create
1067 * complicated nested hierarchies of mountpoints, we first gather all the
1068 * datasets and mountpoints within the pool, and sort them by mountpoint. Once
1069 * we have the list of all filesystems, we iterate over them in order and mount
1070 * and/or share each one.
1072 #pragma weak zpool_mount_datasets = zpool_enable_datasets
1074 zpool_enable_datasets(zpool_handle_t
*zhp
, const char *mntopts
, int flags
)
1076 get_all_cb_t cb
= { 0 };
1077 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1083 * Gather all non-snap datasets within the pool.
1085 if ((zfsp
= zfs_open(hdl
, zhp
->zpool_name
, ZFS_TYPE_DATASET
)) == NULL
)
1088 libzfs_add_handle(&cb
, zfsp
);
1089 if (zfs_iter_filesystems(zfsp
, mount_cb
, &cb
) != 0)
1092 * Sort the datasets by mountpoint.
1094 qsort(cb
.cb_handles
, cb
.cb_used
, sizeof (void *),
1095 libzfs_dataset_cmp
);
1098 * And mount all the datasets, keeping track of which ones
1099 * succeeded or failed.
1101 if ((good
= zfs_alloc(zhp
->zpool_hdl
,
1102 cb
.cb_used
* sizeof (int))) == NULL
)
1106 for (i
= 0; i
< cb
.cb_used
; i
++) {
1107 if (zfs_mount(cb
.cb_handles
[i
], mntopts
, flags
) != 0)
1114 * Then share all the ones that need to be shared. This needs
1115 * to be a separate pass in order to avoid excessive reloading
1116 * of the configuration. Good should never be NULL since
1117 * zfs_alloc is supposed to exit if memory isn't available.
1119 for (i
= 0; i
< cb
.cb_used
; i
++) {
1120 if (good
[i
] && zfs_share(cb
.cb_handles
[i
]) != 0)
1127 for (i
= 0; i
< cb
.cb_used
; i
++)
1128 zfs_close(cb
.cb_handles
[i
]);
1129 free(cb
.cb_handles
);
1135 mountpoint_compare(const void *a
, const void *b
)
1137 const char *mounta
= *((char **)a
);
1138 const char *mountb
= *((char **)b
);
1140 return (strcmp(mountb
, mounta
));
1143 /* alias for 2002/240 */
1144 #pragma weak zpool_unmount_datasets = zpool_disable_datasets
1146 * Unshare and unmount all datasets within the given pool. We don't want to
1147 * rely on traversing the DSL to discover the filesystems within the pool,
1148 * because this may be expensive (if not all of them are mounted), and can fail
1149 * arbitrarily (on I/O error, for example). Instead, we walk /etc/mtab and
1150 * gather all the filesystems that are currently mounted.
1153 zpool_disable_datasets(zpool_handle_t
*zhp
, boolean_t force
)
1156 struct mnttab entry
;
1158 char **mountpoints
= NULL
;
1159 zfs_handle_t
**datasets
= NULL
;
1160 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1163 int flags
= (force
? MS_FORCE
: 0);
1165 namelen
= strlen(zhp
->zpool_name
);
1167 rewind(hdl
->libzfs_mnttab
);
1169 while (getmntent(hdl
->libzfs_mnttab
, &entry
) == 0) {
1171 * Ignore non-ZFS entries.
1173 if (entry
.mnt_fstype
== NULL
||
1174 strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0)
1178 * Ignore filesystems not within this pool.
1180 if (entry
.mnt_mountp
== NULL
||
1181 strncmp(entry
.mnt_special
, zhp
->zpool_name
, namelen
) != 0 ||
1182 (entry
.mnt_special
[namelen
] != '/' &&
1183 entry
.mnt_special
[namelen
] != '\0'))
1187 * At this point we've found a filesystem within our pool. Add
1188 * it to our growing list.
1190 if (used
== alloc
) {
1192 if ((mountpoints
= zfs_alloc(hdl
,
1193 8 * sizeof (void *))) == NULL
)
1196 if ((datasets
= zfs_alloc(hdl
,
1197 8 * sizeof (void *))) == NULL
)
1204 if ((ptr
= zfs_realloc(hdl
, mountpoints
,
1205 alloc
* sizeof (void *),
1206 alloc
* 2 * sizeof (void *))) == NULL
)
1210 if ((ptr
= zfs_realloc(hdl
, datasets
,
1211 alloc
* sizeof (void *),
1212 alloc
* 2 * sizeof (void *))) == NULL
)
1220 if ((mountpoints
[used
] = zfs_strdup(hdl
,
1221 entry
.mnt_mountp
)) == NULL
)
1225 * This is allowed to fail, in case there is some I/O error. It
1226 * is only used to determine if we need to remove the underlying
1227 * mountpoint, so failure is not fatal.
1229 datasets
[used
] = make_dataset_handle(hdl
, entry
.mnt_special
);
1235 * At this point, we have the entire list of filesystems, so sort it by
1238 qsort(mountpoints
, used
, sizeof (char *), mountpoint_compare
);
1241 * Walk through and first unshare everything.
1243 for (i
= 0; i
< used
; i
++) {
1244 zfs_share_proto_t
*curr_proto
;
1245 for (curr_proto
= share_all_proto
; *curr_proto
!= PROTO_END
;
1247 if (is_shared(hdl
, mountpoints
[i
], *curr_proto
) &&
1248 unshare_one(hdl
, mountpoints
[i
],
1249 mountpoints
[i
], *curr_proto
) != 0)
1255 * Now unmount everything, removing the underlying directories as
1258 for (i
= 0; i
< used
; i
++) {
1259 if (unmount_one(hdl
, mountpoints
[i
], flags
) != 0)
1263 for (i
= 0; i
< used
; i
++) {
1265 remove_mountpoint(datasets
[i
]);
1270 for (i
= 0; i
< used
; i
++) {
1272 zfs_close(datasets
[i
]);
1273 free(mountpoints
[i
]);