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
)
297 if (rc
& MOUNT_SYSERR
)
299 if (rc
& MOUNT_USAGE
)
302 return (ENXIO
); /* Generic error */
309 do_unmount(const char *mntpt
, int flags
)
311 char force_opt
[] = "-f";
312 char lazy_opt
[] = "-l";
316 NULL
, NULL
, NULL
, NULL
};
319 if (flags
& MS_FORCE
) {
320 argv
[count
] = force_opt
;
324 if (flags
& MS_DETACH
) {
325 argv
[count
] = lazy_opt
;
329 argv
[count
] = (char *)mntpt
;
330 rc
= libzfs_run_process(argv
[0], argv
, STDOUT_VERBOSE
|STDERR_VERBOSE
);
332 return (rc
? EINVAL
: 0);
336 zfs_add_option(zfs_handle_t
*zhp
, char *options
, int len
,
337 zfs_prop_t prop
, char *on
, char *off
)
342 /* Skip adding duplicate default options */
343 if ((strstr(options
, on
) != NULL
) || (strstr(options
, off
) != NULL
))
347 * zfs_prop_get_int() to not used to ensure our mount options
348 * are not influenced by the current /etc/mtab contents.
350 value
= getprop_uint64(zhp
, prop
, &source
);
352 (void) strlcat(options
, ",", len
);
353 (void) strlcat(options
, value
? on
: off
, len
);
359 zfs_add_options(zfs_handle_t
*zhp
, char *options
, int len
)
363 error
= zfs_add_option(zhp
, options
, len
,
364 ZFS_PROP_ATIME
, MNTOPT_ATIME
, MNTOPT_NOATIME
);
365 error
= error
? error
: zfs_add_option(zhp
, options
, len
,
366 ZFS_PROP_DEVICES
, MNTOPT_DEVICES
, MNTOPT_NODEVICES
);
367 error
= error
? error
: zfs_add_option(zhp
, options
, len
,
368 ZFS_PROP_EXEC
, MNTOPT_EXEC
, MNTOPT_NOEXEC
);
369 error
= error
? error
: zfs_add_option(zhp
, options
, len
,
370 ZFS_PROP_READONLY
, MNTOPT_RO
, MNTOPT_RW
);
371 error
= error
? error
: zfs_add_option(zhp
, options
, len
,
372 ZFS_PROP_SETUID
, MNTOPT_SETUID
, MNTOPT_NOSETUID
);
373 error
= error
? error
: zfs_add_option(zhp
, options
, len
,
374 ZFS_PROP_XATTR
, MNTOPT_XATTR
, MNTOPT_NOXATTR
);
375 error
= error
? error
: zfs_add_option(zhp
, options
, len
,
376 ZFS_PROP_NBMAND
, MNTOPT_NBMAND
, MNTOPT_NONBMAND
);
382 * Mount the given filesystem.
385 zfs_mount(zfs_handle_t
*zhp
, const char *options
, int flags
)
388 char mountpoint
[ZFS_MAXPROPLEN
];
389 char mntopts
[MNT_LINE_MAX
];
390 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
393 if (options
== NULL
) {
394 (void) strlcpy(mntopts
, MNTOPT_DEFAULTS
, sizeof (mntopts
));
396 (void) strlcpy(mntopts
, options
, sizeof (mntopts
));
399 if (strstr(mntopts
, MNTOPT_REMOUNT
) != NULL
)
403 * If the pool is imported read-only then all mounts must be read-only
405 if (zpool_get_prop_int(zhp
->zpool_hdl
, ZPOOL_PROP_READONLY
, NULL
))
406 (void) strlcat(mntopts
, "," MNTOPT_RO
, sizeof (mntopts
));
409 * Append default mount options which apply to the mount point.
410 * This is done because under Linux (unlike Solaris) multiple mount
411 * points may reference a single super block. This means that just
412 * given a super block there is no back reference to update the per
413 * mount point options.
415 rc
= zfs_add_options(zhp
, mntopts
, sizeof (mntopts
));
417 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
418 "default options unavailable"));
419 return (zfs_error_fmt(hdl
, EZFS_MOUNTFAILED
,
420 dgettext(TEXT_DOMAIN
, "cannot mount '%s'"),
425 * Append zfsutil option so the mount helper allow the mount
427 strlcat(mntopts
, "," MNTOPT_ZFSUTIL
, sizeof (mntopts
));
429 if (!zfs_is_mountable(zhp
, mountpoint
, sizeof (mountpoint
), NULL
))
432 /* Create the directory if it doesn't already exist */
433 if (lstat(mountpoint
, &buf
) != 0) {
434 if (mkdirp(mountpoint
, 0755) != 0) {
435 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
436 "failed to create mountpoint"));
437 return (zfs_error_fmt(hdl
, EZFS_MOUNTFAILED
,
438 dgettext(TEXT_DOMAIN
, "cannot mount '%s'"),
444 * Determine if the mountpoint is empty. If so, refuse to perform the
445 * mount. We don't perform this check if 'remount' is
446 * specified or if overlay option(-O) is given
448 if ((flags
& MS_OVERLAY
) == 0 && !remount
&&
449 !dir_is_empty(mountpoint
)) {
450 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
451 "directory is not empty"));
452 return (zfs_error_fmt(hdl
, EZFS_MOUNTFAILED
,
453 dgettext(TEXT_DOMAIN
, "cannot mount '%s'"), mountpoint
));
456 /* perform the mount */
457 rc
= do_mount(zfs_get_name(zhp
), mountpoint
, mntopts
);
460 * Generic errors are nasty, but there are just way too many
461 * from mount(), and they're well-understood. We pick a few
462 * common ones to improve upon.
465 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
466 "mountpoint or dataset is busy"));
467 } else if (rc
== EPERM
) {
468 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
469 "Insufficient privileges"));
470 } else if (rc
== ENOTSUP
) {
474 VERIFY(zfs_spa_version(zhp
, &spa_version
) == 0);
475 (void) snprintf(buf
, sizeof (buf
),
476 dgettext(TEXT_DOMAIN
, "Can't mount a version %lld "
477 "file system on a version %d pool. Pool must be"
478 " upgraded to mount this file system."),
479 (u_longlong_t
)zfs_prop_get_int(zhp
,
480 ZFS_PROP_VERSION
), spa_version
);
481 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, buf
));
483 zfs_error_aux(hdl
, strerror(rc
));
485 return (zfs_error_fmt(hdl
, EZFS_MOUNTFAILED
,
486 dgettext(TEXT_DOMAIN
, "cannot mount '%s'"),
490 /* remove the mounted entry before re-adding on remount */
492 libzfs_mnttab_remove(hdl
, zhp
->zfs_name
);
494 /* add the mounted entry into our cache */
495 libzfs_mnttab_add(hdl
, zfs_get_name(zhp
), mountpoint
, mntopts
);
500 * Unmount a single filesystem.
503 unmount_one(libzfs_handle_t
*hdl
, const char *mountpoint
, int flags
)
507 error
= do_unmount(mountpoint
, flags
);
509 return (zfs_error_fmt(hdl
, EZFS_UMOUNTFAILED
,
510 dgettext(TEXT_DOMAIN
, "cannot unmount '%s'"),
518 * Unmount the given filesystem.
521 zfs_unmount(zfs_handle_t
*zhp
, const char *mountpoint
, int flags
)
523 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
527 /* check to see if we need to unmount the filesystem */
528 if (mountpoint
!= NULL
|| ((zfs_get_type(zhp
) == ZFS_TYPE_FILESYSTEM
) &&
529 libzfs_mnttab_find(hdl
, zhp
->zfs_name
, &entry
) == 0)) {
531 * mountpoint may have come from a call to
532 * getmnt/getmntany if it isn't NULL. If it is NULL,
533 * we know it comes from libzfs_mnttab_find which can
534 * then get freed later. We strdup it to play it safe.
536 if (mountpoint
== NULL
)
537 mntpt
= zfs_strdup(hdl
, entry
.mnt_mountp
);
539 mntpt
= zfs_strdup(hdl
, mountpoint
);
542 * Unshare and unmount the filesystem
544 if (zfs_unshare_proto(zhp
, mntpt
, share_all_proto
) != 0)
547 if (unmount_one(hdl
, mntpt
, flags
) != 0) {
549 (void) zfs_shareall(zhp
);
552 libzfs_mnttab_remove(hdl
, zhp
->zfs_name
);
560 * Unmount this filesystem and any children inheriting the mountpoint property.
561 * To do this, just act like we're changing the mountpoint property, but don't
562 * remount the filesystems afterwards.
565 zfs_unmountall(zfs_handle_t
*zhp
, int flags
)
567 prop_changelist_t
*clp
;
570 clp
= changelist_gather(zhp
, ZFS_PROP_MOUNTPOINT
, 0, flags
);
574 ret
= changelist_prefix(clp
);
575 changelist_free(clp
);
581 zfs_is_shared(zfs_handle_t
*zhp
)
583 zfs_share_type_t rc
= 0;
584 zfs_share_proto_t
*curr_proto
;
586 if (ZFS_IS_VOLUME(zhp
))
589 for (curr_proto
= share_all_proto
; *curr_proto
!= PROTO_END
;
591 rc
|= zfs_is_shared_proto(zhp
, NULL
, *curr_proto
);
593 return (rc
? B_TRUE
: B_FALSE
);
597 zfs_share(zfs_handle_t
*zhp
)
599 assert(!ZFS_IS_VOLUME(zhp
));
600 return (zfs_share_proto(zhp
, share_all_proto
));
604 zfs_unshare(zfs_handle_t
*zhp
)
606 assert(!ZFS_IS_VOLUME(zhp
));
607 return (zfs_unshareall(zhp
));
611 * Check to see if the filesystem is currently shared.
614 zfs_is_shared_proto(zfs_handle_t
*zhp
, char **where
, zfs_share_proto_t proto
)
619 if (!zfs_is_mounted(zhp
, &mountpoint
))
620 return (SHARED_NOT_SHARED
);
622 if ((rc
= is_shared(zhp
->zfs_hdl
, mountpoint
, proto
))) {
630 return (SHARED_NOT_SHARED
);
635 zfs_is_shared_nfs(zfs_handle_t
*zhp
, char **where
)
637 return (zfs_is_shared_proto(zhp
, where
,
638 PROTO_NFS
) != SHARED_NOT_SHARED
);
642 zfs_is_shared_smb(zfs_handle_t
*zhp
, char **where
)
644 return (zfs_is_shared_proto(zhp
, where
,
645 PROTO_SMB
) != SHARED_NOT_SHARED
);
649 * zfs_init_libshare(zhandle, service)
651 * Initialize the libshare API if it hasn't already been initialized.
652 * In all cases it returns 0 if it succeeded and an error if not. The
653 * service value is which part(s) of the API to initialize and is a
654 * direct map to the libshare sa_init(service) interface.
657 zfs_init_libshare(libzfs_handle_t
*zhandle
, int service
)
661 if (ret
== SA_OK
&& zhandle
->libzfs_shareflags
& ZFSSHARE_MISS
) {
663 * We had a cache miss. Most likely it is a new ZFS
664 * dataset that was just created. We want to make sure
665 * so check timestamps to see if a different process
666 * has updated any of the configuration. If there was
667 * some non-ZFS change, we need to re-initialize the
670 zhandle
->libzfs_shareflags
&= ~ZFSSHARE_MISS
;
671 if (sa_needs_refresh(zhandle
->libzfs_sharehdl
)) {
672 zfs_uninit_libshare(zhandle
);
673 zhandle
->libzfs_sharehdl
= sa_init(service
);
677 if (ret
== SA_OK
&& zhandle
&& zhandle
->libzfs_sharehdl
== NULL
)
678 zhandle
->libzfs_sharehdl
= sa_init(service
);
680 if (ret
== SA_OK
&& zhandle
->libzfs_sharehdl
== NULL
)
687 * zfs_uninit_libshare(zhandle)
689 * Uninitialize the libshare API if it hasn't already been
690 * uninitialized. It is OK to call multiple times.
693 zfs_uninit_libshare(libzfs_handle_t
*zhandle
)
695 if (zhandle
!= NULL
&& zhandle
->libzfs_sharehdl
!= NULL
) {
696 sa_fini(zhandle
->libzfs_sharehdl
);
697 zhandle
->libzfs_sharehdl
= NULL
;
702 * zfs_parse_options(options, proto)
704 * Call the legacy parse interface to get the protocol specific
705 * options using the NULL arg to indicate that this is a "parse" only.
708 zfs_parse_options(char *options
, zfs_share_proto_t proto
)
710 return (sa_parse_legacy_options(NULL
, options
,
711 proto_table
[proto
].p_name
));
715 * Share the given filesystem according to the options in the specified
716 * protocol specific properties (sharenfs, sharesmb). We rely
717 * on "libshare" to do the dirty work for us.
720 zfs_share_proto(zfs_handle_t
*zhp
, zfs_share_proto_t
*proto
)
722 char mountpoint
[ZFS_MAXPROPLEN
];
723 char shareopts
[ZFS_MAXPROPLEN
];
724 char sourcestr
[ZFS_MAXPROPLEN
];
725 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
727 zfs_share_proto_t
*curr_proto
;
728 zprop_source_t sourcetype
;
731 if (!zfs_is_mountable(zhp
, mountpoint
, sizeof (mountpoint
), NULL
))
734 if ((ret
= zfs_init_libshare(hdl
, SA_INIT_SHARE_API
)) != SA_OK
) {
735 (void) zfs_error_fmt(hdl
, EZFS_SHARENFSFAILED
,
736 dgettext(TEXT_DOMAIN
, "cannot share '%s': %s"),
737 zfs_get_name(zhp
), sa_errorstr(ret
));
741 for (curr_proto
= proto
; *curr_proto
!= PROTO_END
; curr_proto
++) {
743 * Return success if there are no share options.
745 if (zfs_prop_get(zhp
, proto_table
[*curr_proto
].p_prop
,
746 shareopts
, sizeof (shareopts
), &sourcetype
, sourcestr
,
747 ZFS_MAXPROPLEN
, B_FALSE
) != 0 ||
748 strcmp(shareopts
, "off") == 0)
752 * If the 'zoned' property is set, then zfs_is_mountable()
753 * will have already bailed out if we are in the global zone.
754 * But local zones cannot be NFS servers, so we ignore it for
755 * local zones as well.
757 if (zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
))
760 share
= sa_find_share(hdl
->libzfs_sharehdl
, mountpoint
);
763 * This may be a new file system that was just
764 * created so isn't in the internal cache
765 * (second time through). Rather than
766 * reloading the entire configuration, we can
767 * assume ZFS has done the checking and it is
768 * safe to add this to the internal
771 if (sa_zfs_process_share(hdl
->libzfs_sharehdl
,
772 NULL
, NULL
, mountpoint
,
773 proto_table
[*curr_proto
].p_name
, sourcetype
,
774 shareopts
, sourcestr
, zhp
->zfs_name
) != SA_OK
) {
775 (void) zfs_error_fmt(hdl
,
776 proto_table
[*curr_proto
].p_share_err
,
777 dgettext(TEXT_DOMAIN
, "cannot share '%s'"),
781 hdl
->libzfs_shareflags
|= ZFSSHARE_MISS
;
782 share
= sa_find_share(hdl
->libzfs_sharehdl
,
787 err
= sa_enable_share(share
,
788 proto_table
[*curr_proto
].p_name
);
790 (void) zfs_error_fmt(hdl
,
791 proto_table
[*curr_proto
].p_share_err
,
792 dgettext(TEXT_DOMAIN
, "cannot share '%s'"),
797 (void) zfs_error_fmt(hdl
,
798 proto_table
[*curr_proto
].p_share_err
,
799 dgettext(TEXT_DOMAIN
, "cannot share '%s'"),
810 zfs_share_nfs(zfs_handle_t
*zhp
)
812 return (zfs_share_proto(zhp
, nfs_only
));
816 zfs_share_smb(zfs_handle_t
*zhp
)
818 return (zfs_share_proto(zhp
, smb_only
));
822 zfs_shareall(zfs_handle_t
*zhp
)
824 return (zfs_share_proto(zhp
, share_all_proto
));
828 * Unshare a filesystem by mountpoint.
831 unshare_one(libzfs_handle_t
*hdl
, const char *name
, const char *mountpoint
,
832 zfs_share_proto_t proto
)
838 * Mountpoint could get trashed if libshare calls getmntany
839 * which it does during API initialization, so strdup the
842 mntpt
= zfs_strdup(hdl
, mountpoint
);
844 /* make sure libshare initialized */
845 if ((err
= zfs_init_libshare(hdl
, SA_INIT_SHARE_API
)) != SA_OK
) {
846 free(mntpt
); /* don't need the copy anymore */
847 return (zfs_error_fmt(hdl
, EZFS_SHARENFSFAILED
,
848 dgettext(TEXT_DOMAIN
, "cannot unshare '%s': %s"),
849 name
, sa_errorstr(err
)));
852 share
= sa_find_share(hdl
->libzfs_sharehdl
, mntpt
);
853 free(mntpt
); /* don't need the copy anymore */
856 err
= sa_disable_share(share
, proto_table
[proto
].p_name
);
858 return (zfs_error_fmt(hdl
, EZFS_UNSHARENFSFAILED
,
859 dgettext(TEXT_DOMAIN
, "cannot unshare '%s': %s"),
860 name
, sa_errorstr(err
)));
863 return (zfs_error_fmt(hdl
, EZFS_UNSHARENFSFAILED
,
864 dgettext(TEXT_DOMAIN
, "cannot unshare '%s': not found"),
871 * Unshare the given filesystem.
874 zfs_unshare_proto(zfs_handle_t
*zhp
, const char *mountpoint
,
875 zfs_share_proto_t
*proto
)
877 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
881 /* check to see if need to unmount the filesystem */
882 if (mountpoint
!= NULL
)
883 mountpoint
= mntpt
= zfs_strdup(hdl
, mountpoint
);
885 if (mountpoint
!= NULL
|| ((zfs_get_type(zhp
) == ZFS_TYPE_FILESYSTEM
) &&
886 libzfs_mnttab_find(hdl
, zfs_get_name(zhp
), &entry
) == 0)) {
887 zfs_share_proto_t
*curr_proto
;
889 if (mountpoint
== NULL
)
890 mntpt
= zfs_strdup(zhp
->zfs_hdl
, entry
.mnt_mountp
);
892 for (curr_proto
= proto
; *curr_proto
!= PROTO_END
;
895 if (is_shared(hdl
, mntpt
, *curr_proto
) &&
896 unshare_one(hdl
, zhp
->zfs_name
,
897 mntpt
, *curr_proto
) != 0) {
911 zfs_unshare_nfs(zfs_handle_t
*zhp
, const char *mountpoint
)
913 return (zfs_unshare_proto(zhp
, mountpoint
, nfs_only
));
917 zfs_unshare_smb(zfs_handle_t
*zhp
, const char *mountpoint
)
919 return (zfs_unshare_proto(zhp
, mountpoint
, smb_only
));
923 * Same as zfs_unmountall(), but for NFS and SMB unshares.
926 zfs_unshareall_proto(zfs_handle_t
*zhp
, zfs_share_proto_t
*proto
)
928 prop_changelist_t
*clp
;
931 clp
= changelist_gather(zhp
, ZFS_PROP_SHARENFS
, 0, 0);
935 ret
= changelist_unshare(clp
, proto
);
936 changelist_free(clp
);
942 zfs_unshareall_nfs(zfs_handle_t
*zhp
)
944 return (zfs_unshareall_proto(zhp
, nfs_only
));
948 zfs_unshareall_smb(zfs_handle_t
*zhp
)
950 return (zfs_unshareall_proto(zhp
, smb_only
));
954 zfs_unshareall(zfs_handle_t
*zhp
)
956 return (zfs_unshareall_proto(zhp
, share_all_proto
));
960 zfs_unshareall_bypath(zfs_handle_t
*zhp
, const char *mountpoint
)
962 return (zfs_unshare_proto(zhp
, mountpoint
, share_all_proto
));
966 * Remove the mountpoint associated with the current dataset, if necessary.
967 * We only remove the underlying directory if:
969 * - The mountpoint is not 'none' or 'legacy'
970 * - The mountpoint is non-empty
971 * - The mountpoint is the default or inherited
972 * - The 'zoned' property is set, or we're in a local zone
974 * Any other directories we leave alone.
977 remove_mountpoint(zfs_handle_t
*zhp
)
979 char mountpoint
[ZFS_MAXPROPLEN
];
980 zprop_source_t source
;
982 if (!zfs_is_mountable(zhp
, mountpoint
, sizeof (mountpoint
),
986 if (source
== ZPROP_SRC_DEFAULT
||
987 source
== ZPROP_SRC_INHERITED
) {
989 * Try to remove the directory, silently ignoring any errors.
990 * The filesystem may have since been removed or moved around,
991 * and this error isn't really useful to the administrator in
994 (void) rmdir(mountpoint
);
999 libzfs_add_handle(get_all_cb_t
*cbp
, zfs_handle_t
*zhp
)
1001 if (cbp
->cb_alloc
== cbp
->cb_used
) {
1005 newsz
= cbp
->cb_alloc
? cbp
->cb_alloc
* 2 : 64;
1006 ptr
= zfs_realloc(zhp
->zfs_hdl
,
1007 cbp
->cb_handles
, cbp
->cb_alloc
* sizeof (void *),
1008 newsz
* sizeof (void *));
1009 cbp
->cb_handles
= ptr
;
1010 cbp
->cb_alloc
= newsz
;
1012 cbp
->cb_handles
[cbp
->cb_used
++] = zhp
;
1016 mount_cb(zfs_handle_t
*zhp
, void *data
)
1018 get_all_cb_t
*cbp
= data
;
1020 if (!(zfs_get_type(zhp
) & ZFS_TYPE_FILESYSTEM
)) {
1025 if (zfs_prop_get_int(zhp
, ZFS_PROP_CANMOUNT
) == ZFS_CANMOUNT_NOAUTO
) {
1030 libzfs_add_handle(cbp
, zhp
);
1031 if (zfs_iter_filesystems(zhp
, mount_cb
, cbp
) != 0) {
1039 libzfs_dataset_cmp(const void *a
, const void *b
)
1041 zfs_handle_t
**za
= (zfs_handle_t
**)a
;
1042 zfs_handle_t
**zb
= (zfs_handle_t
**)b
;
1043 char mounta
[MAXPATHLEN
];
1044 char mountb
[MAXPATHLEN
];
1045 boolean_t gota
, gotb
;
1047 if ((gota
= (zfs_get_type(*za
) == ZFS_TYPE_FILESYSTEM
)) != 0)
1048 verify(zfs_prop_get(*za
, ZFS_PROP_MOUNTPOINT
, mounta
,
1049 sizeof (mounta
), NULL
, NULL
, 0, B_FALSE
) == 0);
1050 if ((gotb
= (zfs_get_type(*zb
) == ZFS_TYPE_FILESYSTEM
)) != 0)
1051 verify(zfs_prop_get(*zb
, ZFS_PROP_MOUNTPOINT
, mountb
,
1052 sizeof (mountb
), NULL
, NULL
, 0, B_FALSE
) == 0);
1055 return (strcmp(mounta
, mountb
));
1062 return (strcmp(zfs_get_name(a
), zfs_get_name(b
)));
1066 * Mount and share all datasets within the given pool. This assumes that no
1067 * datasets within the pool are currently mounted. Because users can create
1068 * complicated nested hierarchies of mountpoints, we first gather all the
1069 * datasets and mountpoints within the pool, and sort them by mountpoint. Once
1070 * we have the list of all filesystems, we iterate over them in order and mount
1071 * and/or share each one.
1073 #pragma weak zpool_mount_datasets = zpool_enable_datasets
1075 zpool_enable_datasets(zpool_handle_t
*zhp
, const char *mntopts
, int flags
)
1077 get_all_cb_t cb
= { 0 };
1078 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1084 * Gather all non-snap datasets within the pool.
1086 if ((zfsp
= zfs_open(hdl
, zhp
->zpool_name
, ZFS_TYPE_DATASET
)) == NULL
)
1089 libzfs_add_handle(&cb
, zfsp
);
1090 if (zfs_iter_filesystems(zfsp
, mount_cb
, &cb
) != 0)
1093 * Sort the datasets by mountpoint.
1095 qsort(cb
.cb_handles
, cb
.cb_used
, sizeof (void *),
1096 libzfs_dataset_cmp
);
1099 * And mount all the datasets, keeping track of which ones
1100 * succeeded or failed.
1102 if ((good
= zfs_alloc(zhp
->zpool_hdl
,
1103 cb
.cb_used
* sizeof (int))) == NULL
)
1107 for (i
= 0; i
< cb
.cb_used
; i
++) {
1108 if (zfs_mount(cb
.cb_handles
[i
], mntopts
, flags
) != 0)
1115 * Then share all the ones that need to be shared. This needs
1116 * to be a separate pass in order to avoid excessive reloading
1117 * of the configuration. Good should never be NULL since
1118 * zfs_alloc is supposed to exit if memory isn't available.
1120 for (i
= 0; i
< cb
.cb_used
; i
++) {
1121 if (good
[i
] && zfs_share(cb
.cb_handles
[i
]) != 0)
1128 for (i
= 0; i
< cb
.cb_used
; i
++)
1129 zfs_close(cb
.cb_handles
[i
]);
1130 free(cb
.cb_handles
);
1136 mountpoint_compare(const void *a
, const void *b
)
1138 const char *mounta
= *((char **)a
);
1139 const char *mountb
= *((char **)b
);
1141 return (strcmp(mountb
, mounta
));
1144 /* alias for 2002/240 */
1145 #pragma weak zpool_unmount_datasets = zpool_disable_datasets
1147 * Unshare and unmount all datasets within the given pool. We don't want to
1148 * rely on traversing the DSL to discover the filesystems within the pool,
1149 * because this may be expensive (if not all of them are mounted), and can fail
1150 * arbitrarily (on I/O error, for example). Instead, we walk /etc/mtab and
1151 * gather all the filesystems that are currently mounted.
1154 zpool_disable_datasets(zpool_handle_t
*zhp
, boolean_t force
)
1157 struct mnttab entry
;
1159 char **mountpoints
= NULL
;
1160 zfs_handle_t
**datasets
= NULL
;
1161 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1164 int flags
= (force
? MS_FORCE
: 0);
1166 namelen
= strlen(zhp
->zpool_name
);
1168 /* Reopen MNTTAB to prevent reading stale data from open file */
1169 if (freopen(MNTTAB
, "r", hdl
->libzfs_mnttab
) == NULL
)
1173 while (getmntent(hdl
->libzfs_mnttab
, &entry
) == 0) {
1175 * Ignore non-ZFS entries.
1177 if (entry
.mnt_fstype
== NULL
||
1178 strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0)
1182 * Ignore filesystems not within this pool.
1184 if (entry
.mnt_mountp
== NULL
||
1185 strncmp(entry
.mnt_special
, zhp
->zpool_name
, namelen
) != 0 ||
1186 (entry
.mnt_special
[namelen
] != '/' &&
1187 entry
.mnt_special
[namelen
] != '\0'))
1191 * At this point we've found a filesystem within our pool. Add
1192 * it to our growing list.
1194 if (used
== alloc
) {
1196 if ((mountpoints
= zfs_alloc(hdl
,
1197 8 * sizeof (void *))) == NULL
)
1200 if ((datasets
= zfs_alloc(hdl
,
1201 8 * sizeof (void *))) == NULL
)
1208 if ((ptr
= zfs_realloc(hdl
, mountpoints
,
1209 alloc
* sizeof (void *),
1210 alloc
* 2 * sizeof (void *))) == NULL
)
1214 if ((ptr
= zfs_realloc(hdl
, datasets
,
1215 alloc
* sizeof (void *),
1216 alloc
* 2 * sizeof (void *))) == NULL
)
1224 if ((mountpoints
[used
] = zfs_strdup(hdl
,
1225 entry
.mnt_mountp
)) == NULL
)
1229 * This is allowed to fail, in case there is some I/O error. It
1230 * is only used to determine if we need to remove the underlying
1231 * mountpoint, so failure is not fatal.
1233 datasets
[used
] = make_dataset_handle(hdl
, entry
.mnt_special
);
1239 * At this point, we have the entire list of filesystems, so sort it by
1242 qsort(mountpoints
, used
, sizeof (char *), mountpoint_compare
);
1245 * Walk through and first unshare everything.
1247 for (i
= 0; i
< used
; i
++) {
1248 zfs_share_proto_t
*curr_proto
;
1249 for (curr_proto
= share_all_proto
; *curr_proto
!= PROTO_END
;
1251 if (is_shared(hdl
, mountpoints
[i
], *curr_proto
) &&
1252 unshare_one(hdl
, mountpoints
[i
],
1253 mountpoints
[i
], *curr_proto
) != 0)
1259 * Now unmount everything, removing the underlying directories as
1262 for (i
= 0; i
< used
; i
++) {
1263 if (unmount_one(hdl
, mountpoints
[i
], flags
) != 0)
1267 for (i
= 0; i
< used
; i
++) {
1269 remove_mountpoint(datasets
[i
]);
1274 for (i
= 0; i
< used
; i
++) {
1276 zfs_close(datasets
[i
]);
1277 free(mountpoints
[i
]);