sd: remove 'ssd' driver support
[unleashed/tickless.git] / usr / src / lib / libzfs / common / libzfs_mount.c
blobeb00aa4de3ac8a7d2948f085eed1a75e98b81fff
1 /*
2 * CDDL HEADER START
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]
19 * CDDL HEADER END
23 * Copyright 2015 Nexenta Systems, Inc. All rights reserved.
24 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
25 * Copyright (c) 2014, 2016 by Delphix. All rights reserved.
26 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
30 * Routines to manage ZFS mounts. We separate all the nasty routines that have
31 * to deal with the OS. The following functions are the main entry points --
32 * they are used by mount and unmount and when changing a filesystem's
33 * mountpoint.
35 * zfs_is_mounted()
36 * zfs_mount()
37 * zfs_unmount()
38 * zfs_unmountall()
40 * This file also contains the functions used to manage sharing filesystems via
41 * NFS and iSCSI:
43 * zfs_is_shared()
44 * zfs_share()
45 * zfs_unshare()
47 * zfs_is_shared_nfs()
48 * zfs_is_shared_smb()
49 * zfs_share_proto()
50 * zfs_shareall();
51 * zfs_unshare_nfs()
52 * zfs_unshare_smb()
53 * zfs_unshareall_nfs()
54 * zfs_unshareall_smb()
55 * zfs_unshareall()
56 * zfs_unshareall_bypath()
58 * The following functions are available for pool consumers, and will
59 * mount/unmount and share/unshare all datasets within pool:
61 * zpool_enable_datasets()
62 * zpool_disable_datasets()
65 #include <dirent.h>
66 #include <dlfcn.h>
67 #include <errno.h>
68 #include <fcntl.h>
69 #include <libgen.h>
70 #include <libintl.h>
71 #include <stdio.h>
72 #include <stdlib.h>
73 #include <strings.h>
74 #include <unistd.h>
75 #include <zone.h>
76 #include <sys/mntent.h>
77 #include <sys/mount.h>
78 #include <sys/stat.h>
79 #include <sys/statvfs.h>
81 #include <libzfs.h>
83 #include "libzfs_impl.h"
85 #include <libshare.h>
86 #include <sys/systeminfo.h>
87 #define MAXISALEN 257 /* based on sysinfo(2) man page */
89 static int zfs_share_proto(zfs_handle_t *, zfs_share_proto_t *);
90 zfs_share_type_t zfs_is_shared_proto(zfs_handle_t *, char **,
91 zfs_share_proto_t);
94 * The share protocols table must be in the same order as the zfs_share_prot_t
95 * enum in libzfs_impl.h
97 typedef struct {
98 zfs_prop_t p_prop;
99 char *p_name;
100 int p_share_err;
101 int p_unshare_err;
102 } proto_table_t;
104 proto_table_t proto_table[PROTO_END] = {
105 {ZFS_PROP_SHARENFS, "nfs", EZFS_SHARENFSFAILED, EZFS_UNSHARENFSFAILED},
106 {ZFS_PROP_SHARESMB, "smb", EZFS_SHARESMBFAILED, EZFS_UNSHARESMBFAILED},
109 zfs_share_proto_t nfs_only[] = {
110 PROTO_NFS,
111 PROTO_END
114 zfs_share_proto_t smb_only[] = {
115 PROTO_SMB,
116 PROTO_END
118 zfs_share_proto_t share_all_proto[] = {
119 PROTO_NFS,
120 PROTO_SMB,
121 PROTO_END
125 * Search the sharetab for the given mountpoint and protocol, returning
126 * a zfs_share_type_t value.
128 static zfs_share_type_t
129 is_shared(libzfs_handle_t *hdl, const char *mountpoint, zfs_share_proto_t proto)
131 char buf[MAXPATHLEN], *tab;
132 char *ptr;
134 if (hdl->libzfs_sharetab == NULL)
135 return (SHARED_NOT_SHARED);
137 (void) fseek(hdl->libzfs_sharetab, 0, SEEK_SET);
139 while (fgets(buf, sizeof (buf), hdl->libzfs_sharetab) != NULL) {
141 /* the mountpoint is the first entry on each line */
142 if ((tab = strchr(buf, '\t')) == NULL)
143 continue;
145 *tab = '\0';
146 if (strcmp(buf, mountpoint) == 0) {
148 * the protocol field is the third field
149 * skip over second field
151 ptr = ++tab;
152 if ((tab = strchr(ptr, '\t')) == NULL)
153 continue;
154 ptr = ++tab;
155 if ((tab = strchr(ptr, '\t')) == NULL)
156 continue;
157 *tab = '\0';
158 if (strcmp(ptr,
159 proto_table[proto].p_name) == 0) {
160 switch (proto) {
161 case PROTO_NFS:
162 return (SHARED_NFS);
163 case PROTO_SMB:
164 return (SHARED_SMB);
165 default:
166 return (0);
172 return (SHARED_NOT_SHARED);
175 static boolean_t
176 dir_is_empty_stat(const char *dirname)
178 struct stat st;
181 * We only want to return false if the given path is a non empty
182 * directory, all other errors are handled elsewhere.
184 if (stat(dirname, &st) < 0 || !S_ISDIR(st.st_mode)) {
185 return (B_TRUE);
189 * An empty directory will still have two entries in it, one
190 * entry for each of "." and "..".
192 if (st.st_size > 2) {
193 return (B_FALSE);
196 return (B_TRUE);
199 static boolean_t
200 dir_is_empty_readdir(const char *dirname)
202 DIR *dirp;
203 struct dirent64 *dp;
204 int dirfd;
206 if ((dirfd = openat(AT_FDCWD, dirname,
207 O_RDONLY | O_NDELAY | O_LARGEFILE | O_CLOEXEC, 0)) < 0) {
208 return (B_TRUE);
211 if ((dirp = fdopendir(dirfd)) == NULL) {
212 return (B_TRUE);
215 while ((dp = readdir64(dirp)) != NULL) {
217 if (strcmp(dp->d_name, ".") == 0 ||
218 strcmp(dp->d_name, "..") == 0)
219 continue;
221 (void) closedir(dirp);
222 return (B_FALSE);
225 (void) closedir(dirp);
226 return (B_TRUE);
230 * Returns true if the specified directory is empty. If we can't open the
231 * directory at all, return true so that the mount can fail with a more
232 * informative error message.
234 static boolean_t
235 dir_is_empty(const char *dirname)
237 struct statvfs64 st;
240 * If the statvfs call fails or the filesystem is not a ZFS
241 * filesystem, fall back to the slow path which uses readdir.
243 if ((statvfs64(dirname, &st) != 0) ||
244 (strcmp(st.f_basetype, "zfs") != 0)) {
245 return (dir_is_empty_readdir(dirname));
249 * At this point, we know the provided path is on a ZFS
250 * filesystem, so we can use stat instead of readdir to
251 * determine if the directory is empty or not. We try to avoid
252 * using readdir because that requires opening "dirname"; this
253 * open file descriptor can potentially end up in a child
254 * process if there's a concurrent fork, thus preventing the
255 * zfs_mount() from otherwise succeeding (the open file
256 * descriptor inherited by the child process will cause the
257 * parent's mount to fail with EBUSY). The performance
258 * implications of replacing the open, read, and close with a
259 * single stat is nice; but is not the main motivation for the
260 * added complexity.
262 return (dir_is_empty_stat(dirname));
266 * Checks to see if the mount is active. If the filesystem is mounted, we fill
267 * in 'where' with the current mountpoint, and return 1. Otherwise, we return
268 * 0.
270 boolean_t
271 is_mounted(libzfs_handle_t *zfs_hdl, const char *special, char **where)
273 struct mnttab entry;
275 if (libzfs_mnttab_find(zfs_hdl, special, &entry) != 0)
276 return (B_FALSE);
278 if (where != NULL)
279 *where = zfs_strdup(zfs_hdl, entry.mnt_mountp);
281 return (B_TRUE);
284 boolean_t
285 zfs_is_mounted(zfs_handle_t *zhp, char **where)
287 return (is_mounted(zhp->zfs_hdl, zfs_get_name(zhp), where));
291 * Returns true if the given dataset is mountable, false otherwise. Returns the
292 * mountpoint in 'buf'.
294 static boolean_t
295 zfs_is_mountable(zfs_handle_t *zhp, char *buf, size_t buflen,
296 zprop_source_t *source)
298 char sourceloc[MAXNAMELEN];
299 zprop_source_t sourcetype;
301 if (!zfs_prop_valid_for_type(ZFS_PROP_MOUNTPOINT, zhp->zfs_type))
302 return (B_FALSE);
304 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, buf, buflen,
305 &sourcetype, sourceloc, sizeof (sourceloc), B_FALSE) == 0);
307 if (strcmp(buf, ZFS_MOUNTPOINT_NONE) == 0 ||
308 strcmp(buf, ZFS_MOUNTPOINT_LEGACY) == 0)
309 return (B_FALSE);
311 if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == ZFS_CANMOUNT_OFF)
312 return (B_FALSE);
314 if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED) &&
315 getzoneid() == GLOBAL_ZONEID)
316 return (B_FALSE);
318 if (source)
319 *source = sourcetype;
321 return (B_TRUE);
325 * Mount the given filesystem.
328 zfs_mount(zfs_handle_t *zhp, const char *options, int flags)
330 struct stat buf;
331 char mountpoint[ZFS_MAXPROPLEN];
332 char mntopts[MNT_LINE_MAX];
333 libzfs_handle_t *hdl = zhp->zfs_hdl;
335 if (options == NULL)
336 mntopts[0] = '\0';
337 else
338 (void) strlcpy(mntopts, options, sizeof (mntopts));
341 * If the pool is imported read-only then all mounts must be read-only
343 if (zpool_get_prop_int(zhp->zpool_hdl, ZPOOL_PROP_READONLY, NULL))
344 flags |= MS_RDONLY;
346 if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint), NULL))
347 return (0);
349 /* Create the directory if it doesn't already exist */
350 if (lstat(mountpoint, &buf) != 0) {
351 if (mkdirp(mountpoint, 0755) != 0) {
352 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
353 "failed to create mountpoint"));
354 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
355 dgettext(TEXT_DOMAIN, "cannot mount '%s'"),
356 mountpoint));
361 * Determine if the mountpoint is empty. If so, refuse to perform the
362 * mount. We don't perform this check if MS_OVERLAY is specified, which
363 * would defeat the point. We also avoid this check if 'remount' is
364 * specified.
366 if ((flags & MS_OVERLAY) == 0 &&
367 strstr(mntopts, MNTOPT_REMOUNT) == NULL &&
368 !dir_is_empty(mountpoint)) {
369 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
370 "directory is not empty"));
371 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
372 dgettext(TEXT_DOMAIN, "cannot mount '%s'"), mountpoint));
375 /* perform the mount */
376 if (mount(zfs_get_name(zhp), mountpoint, MS_OPTIONSTR | flags,
377 MNTTYPE_ZFS, NULL, 0, mntopts, sizeof (mntopts)) != 0) {
379 * Generic errors are nasty, but there are just way too many
380 * from mount(), and they're well-understood. We pick a few
381 * common ones to improve upon.
383 if (errno == EBUSY) {
384 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
385 "mountpoint or dataset is busy"));
386 } else if (errno == EPERM) {
387 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
388 "Insufficient privileges"));
389 } else if (errno == ENOTSUP) {
390 char buf[256];
391 int spa_version;
393 VERIFY(zfs_spa_version(zhp, &spa_version) == 0);
394 (void) snprintf(buf, sizeof (buf),
395 dgettext(TEXT_DOMAIN, "Can't mount a version %lld "
396 "file system on a version %d pool. Pool must be"
397 " upgraded to mount this file system."),
398 (u_longlong_t)zfs_prop_get_int(zhp,
399 ZFS_PROP_VERSION), spa_version);
400 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, buf));
401 } else {
402 zfs_error_aux(hdl, strerror(errno));
404 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
405 dgettext(TEXT_DOMAIN, "cannot mount '%s'"),
406 zhp->zfs_name));
409 /* add the mounted entry into our cache */
410 libzfs_mnttab_add(hdl, zfs_get_name(zhp), mountpoint,
411 mntopts);
412 return (0);
416 * Unmount a single filesystem.
418 static int
419 unmount_one(libzfs_handle_t *hdl, const char *mountpoint, int flags)
421 if (umount2(mountpoint, flags) != 0) {
422 zfs_error_aux(hdl, strerror(errno));
423 return (zfs_error_fmt(hdl, EZFS_UMOUNTFAILED,
424 dgettext(TEXT_DOMAIN, "cannot unmount '%s'"),
425 mountpoint));
428 return (0);
432 * Unmount the given filesystem.
435 zfs_unmount(zfs_handle_t *zhp, const char *mountpoint, int flags)
437 libzfs_handle_t *hdl = zhp->zfs_hdl;
438 struct mnttab entry;
439 char *mntpt = NULL;
441 /* check to see if we need to unmount the filesystem */
442 if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
443 libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0)) {
445 * mountpoint may have come from a call to
446 * getmnt/getmntany if it isn't NULL. If it is NULL,
447 * we know it comes from libzfs_mnttab_find which can
448 * then get freed later. We strdup it to play it safe.
450 if (mountpoint == NULL)
451 mntpt = zfs_strdup(hdl, entry.mnt_mountp);
452 else
453 mntpt = zfs_strdup(hdl, mountpoint);
456 * Unshare and unmount the filesystem
458 if (zfs_unshare_proto(zhp, mntpt, share_all_proto) != 0)
459 return (-1);
461 if (unmount_one(hdl, mntpt, flags) != 0) {
462 free(mntpt);
463 (void) zfs_shareall(zhp);
464 return (-1);
466 libzfs_mnttab_remove(hdl, zhp->zfs_name);
467 free(mntpt);
470 return (0);
474 * Unmount this filesystem and any children inheriting the mountpoint property.
475 * To do this, just act like we're changing the mountpoint property, but don't
476 * remount the filesystems afterwards.
479 zfs_unmountall(zfs_handle_t *zhp, int flags)
481 prop_changelist_t *clp;
482 int ret;
484 clp = changelist_gather(zhp, ZFS_PROP_MOUNTPOINT, 0, flags);
485 if (clp == NULL)
486 return (-1);
488 ret = changelist_prefix(clp);
489 changelist_free(clp);
491 return (ret);
494 boolean_t
495 zfs_is_shared(zfs_handle_t *zhp)
497 zfs_share_type_t rc = 0;
498 zfs_share_proto_t *curr_proto;
500 if (ZFS_IS_VOLUME(zhp))
501 return (B_FALSE);
503 for (curr_proto = share_all_proto; *curr_proto != PROTO_END;
504 curr_proto++)
505 rc |= zfs_is_shared_proto(zhp, NULL, *curr_proto);
507 return (rc ? B_TRUE : B_FALSE);
511 zfs_share(zfs_handle_t *zhp)
513 assert(!ZFS_IS_VOLUME(zhp));
514 return (zfs_share_proto(zhp, share_all_proto));
518 zfs_unshare(zfs_handle_t *zhp)
520 assert(!ZFS_IS_VOLUME(zhp));
521 return (zfs_unshareall(zhp));
525 * Check to see if the filesystem is currently shared.
527 zfs_share_type_t
528 zfs_is_shared_proto(zfs_handle_t *zhp, char **where, zfs_share_proto_t proto)
530 char *mountpoint;
531 zfs_share_type_t rc;
533 if (!zfs_is_mounted(zhp, &mountpoint))
534 return (SHARED_NOT_SHARED);
536 if ((rc = is_shared(zhp->zfs_hdl, mountpoint, proto))
537 != SHARED_NOT_SHARED) {
538 if (where != NULL)
539 *where = mountpoint;
540 else
541 free(mountpoint);
542 return (rc);
543 } else {
544 free(mountpoint);
545 return (SHARED_NOT_SHARED);
549 boolean_t
550 zfs_is_shared_nfs(zfs_handle_t *zhp, char **where)
552 return (zfs_is_shared_proto(zhp, where,
553 PROTO_NFS) != SHARED_NOT_SHARED);
556 boolean_t
557 zfs_is_shared_smb(zfs_handle_t *zhp, char **where)
559 return (zfs_is_shared_proto(zhp, where,
560 PROTO_SMB) != SHARED_NOT_SHARED);
564 * Make sure things will work if libshare isn't installed by using
565 * wrapper functions that check to see that the pointers to functions
566 * initialized in _zfs_init_libshare() are actually present.
569 static sa_handle_t (*_sa_init)(int);
570 static sa_handle_t (*_sa_init_arg)(int, void *);
571 static void (*_sa_fini)(sa_handle_t);
572 static sa_share_t (*_sa_find_share)(sa_handle_t, char *);
573 static int (*_sa_enable_share)(sa_share_t, char *);
574 static int (*_sa_disable_share)(sa_share_t, char *);
575 static char *(*_sa_errorstr)(int);
576 static int (*_sa_parse_legacy_options)(sa_group_t, char *, char *);
577 static boolean_t (*_sa_needs_refresh)(sa_handle_t *);
578 static libzfs_handle_t *(*_sa_get_zfs_handle)(sa_handle_t);
579 static int (*_sa_zfs_process_share)(sa_handle_t, sa_group_t, sa_share_t,
580 char *, char *, zprop_source_t, char *, char *, char *);
581 static void (*_sa_update_sharetab_ts)(sa_handle_t);
584 * _zfs_init_libshare()
586 * Find the libshare.so.1 entry points that we use here and save the
587 * values to be used later. This is triggered by the runtime loader.
588 * Make sure the correct ISA version is loaded.
591 #pragma init(_zfs_init_libshare)
592 static void
593 _zfs_init_libshare(void)
595 void *libshare;
596 char path[MAXPATHLEN];
597 char isa[MAXISALEN];
599 #if defined(_LP64)
600 if (sysinfo(SI_ARCHITECTURE_64, isa, MAXISALEN) == -1)
601 isa[0] = '\0';
602 #else
603 isa[0] = '\0';
604 #endif
605 (void) snprintf(path, MAXPATHLEN,
606 "/usr/lib/%s/libshare.so.1", isa);
608 if ((libshare = dlopen(path, RTLD_LAZY | RTLD_GLOBAL)) != NULL) {
609 _sa_init = (sa_handle_t (*)(int))dlsym(libshare, "sa_init");
610 _sa_init_arg = (sa_handle_t (*)(int, void *))dlsym(libshare,
611 "sa_init_arg");
612 _sa_fini = (void (*)(sa_handle_t))dlsym(libshare, "sa_fini");
613 _sa_find_share = (sa_share_t (*)(sa_handle_t, char *))
614 dlsym(libshare, "sa_find_share");
615 _sa_enable_share = (int (*)(sa_share_t, char *))dlsym(libshare,
616 "sa_enable_share");
617 _sa_disable_share = (int (*)(sa_share_t, char *))dlsym(libshare,
618 "sa_disable_share");
619 _sa_errorstr = (char *(*)(int))dlsym(libshare, "sa_errorstr");
620 _sa_parse_legacy_options = (int (*)(sa_group_t, char *, char *))
621 dlsym(libshare, "sa_parse_legacy_options");
622 _sa_needs_refresh = (boolean_t (*)(sa_handle_t *))
623 dlsym(libshare, "sa_needs_refresh");
624 _sa_get_zfs_handle = (libzfs_handle_t *(*)(sa_handle_t))
625 dlsym(libshare, "sa_get_zfs_handle");
626 _sa_zfs_process_share = (int (*)(sa_handle_t, sa_group_t,
627 sa_share_t, char *, char *, zprop_source_t, char *,
628 char *, char *))dlsym(libshare, "sa_zfs_process_share");
629 _sa_update_sharetab_ts = (void (*)(sa_handle_t))
630 dlsym(libshare, "sa_update_sharetab_ts");
631 if (_sa_init == NULL || _sa_init_arg == NULL ||
632 _sa_fini == NULL || _sa_find_share == NULL ||
633 _sa_enable_share == NULL || _sa_disable_share == NULL ||
634 _sa_errorstr == NULL || _sa_parse_legacy_options == NULL ||
635 _sa_needs_refresh == NULL || _sa_get_zfs_handle == NULL ||
636 _sa_zfs_process_share == NULL ||
637 _sa_update_sharetab_ts == NULL) {
638 _sa_init = NULL;
639 _sa_init_arg = NULL;
640 _sa_fini = NULL;
641 _sa_disable_share = NULL;
642 _sa_enable_share = NULL;
643 _sa_errorstr = NULL;
644 _sa_parse_legacy_options = NULL;
645 (void) dlclose(libshare);
646 _sa_needs_refresh = NULL;
647 _sa_get_zfs_handle = NULL;
648 _sa_zfs_process_share = NULL;
649 _sa_update_sharetab_ts = NULL;
655 * zfs_init_libshare(zhandle, service)
657 * Initialize the libshare API if it hasn't already been initialized.
658 * In all cases it returns 0 if it succeeded and an error if not. The
659 * service value is which part(s) of the API to initialize and is a
660 * direct map to the libshare sa_init(service) interface.
662 static int
663 zfs_init_libshare_impl(libzfs_handle_t *zhandle, int service, void *arg)
665 if (_sa_init == NULL)
666 return (SA_CONFIG_ERR);
669 * Attempt to refresh libshare. This is necessary if there was a cache
670 * miss for a new ZFS dataset that was just created, or if state of the
671 * sharetab file has changed since libshare was last initialized. We
672 * want to make sure so check timestamps to see if a different process
673 * has updated any of the configuration. If there was some non-ZFS
674 * change, we need to re-initialize the internal cache.
676 if (_sa_needs_refresh != NULL &&
677 _sa_needs_refresh(zhandle->libzfs_sharehdl)) {
678 zfs_uninit_libshare(zhandle);
679 zhandle->libzfs_sharehdl = _sa_init_arg(service, arg);
682 if (zhandle && zhandle->libzfs_sharehdl == NULL)
683 zhandle->libzfs_sharehdl = _sa_init_arg(service, arg);
685 if (zhandle->libzfs_sharehdl == NULL)
686 return (SA_NO_MEMORY);
688 return (SA_OK);
691 zfs_init_libshare(libzfs_handle_t *zhandle, int service)
693 return (zfs_init_libshare_impl(zhandle, service, NULL));
697 zfs_init_libshare_arg(libzfs_handle_t *zhandle, int service, void *arg)
699 return (zfs_init_libshare_impl(zhandle, service, arg));
704 * zfs_uninit_libshare(zhandle)
706 * Uninitialize the libshare API if it hasn't already been
707 * uninitialized. It is OK to call multiple times.
709 void
710 zfs_uninit_libshare(libzfs_handle_t *zhandle)
712 if (zhandle != NULL && zhandle->libzfs_sharehdl != NULL) {
713 if (_sa_fini != NULL)
714 _sa_fini(zhandle->libzfs_sharehdl);
715 zhandle->libzfs_sharehdl = NULL;
720 * zfs_parse_options(options, proto)
722 * Call the legacy parse interface to get the protocol specific
723 * options using the NULL arg to indicate that this is a "parse" only.
726 zfs_parse_options(char *options, zfs_share_proto_t proto)
728 if (_sa_parse_legacy_options != NULL) {
729 return (_sa_parse_legacy_options(NULL, options,
730 proto_table[proto].p_name));
732 return (SA_CONFIG_ERR);
736 * zfs_sa_find_share(handle, path)
738 * wrapper around sa_find_share to find a share path in the
739 * configuration.
741 static sa_share_t
742 zfs_sa_find_share(sa_handle_t handle, char *path)
744 if (_sa_find_share != NULL)
745 return (_sa_find_share(handle, path));
746 return (NULL);
750 * zfs_sa_enable_share(share, proto)
752 * Wrapper for sa_enable_share which enables a share for a specified
753 * protocol.
755 static int
756 zfs_sa_enable_share(sa_share_t share, char *proto)
758 if (_sa_enable_share != NULL)
759 return (_sa_enable_share(share, proto));
760 return (SA_CONFIG_ERR);
764 * zfs_sa_disable_share(share, proto)
766 * Wrapper for sa_enable_share which disables a share for a specified
767 * protocol.
769 static int
770 zfs_sa_disable_share(sa_share_t share, char *proto)
772 if (_sa_disable_share != NULL)
773 return (_sa_disable_share(share, proto));
774 return (SA_CONFIG_ERR);
778 * Share the given filesystem according to the options in the specified
779 * protocol specific properties (sharenfs, sharesmb). We rely
780 * on "libshare" to the dirty work for us.
782 static int
783 zfs_share_proto(zfs_handle_t *zhp, zfs_share_proto_t *proto)
785 char mountpoint[ZFS_MAXPROPLEN];
786 char shareopts[ZFS_MAXPROPLEN];
787 char sourcestr[ZFS_MAXPROPLEN];
788 libzfs_handle_t *hdl = zhp->zfs_hdl;
789 sa_share_t share;
790 zfs_share_proto_t *curr_proto;
791 zprop_source_t sourcetype;
792 int ret;
794 if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint), NULL))
795 return (0);
797 for (curr_proto = proto; *curr_proto != PROTO_END; curr_proto++) {
799 * Return success if there are no share options.
801 if (zfs_prop_get(zhp, proto_table[*curr_proto].p_prop,
802 shareopts, sizeof (shareopts), &sourcetype, sourcestr,
803 ZFS_MAXPROPLEN, B_FALSE) != 0 ||
804 strcmp(shareopts, "off") == 0)
805 continue;
806 ret = zfs_init_libshare_arg(hdl, SA_INIT_ONE_SHARE_FROM_HANDLE,
807 zhp);
808 if (ret != SA_OK) {
809 (void) zfs_error_fmt(hdl, EZFS_SHARENFSFAILED,
810 dgettext(TEXT_DOMAIN, "cannot share '%s': %s"),
811 zfs_get_name(zhp), _sa_errorstr != NULL ?
812 _sa_errorstr(ret) : "");
813 return (-1);
817 * If the 'zoned' property is set, then zfs_is_mountable()
818 * will have already bailed out if we are in the global zone.
819 * But local zones cannot be NFS servers, so we ignore it for
820 * local zones as well.
822 if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED))
823 continue;
825 share = zfs_sa_find_share(hdl->libzfs_sharehdl, mountpoint);
826 if (share == NULL) {
828 * This may be a new file system that was just
829 * created so isn't in the internal cache
830 * (second time through). Rather than
831 * reloading the entire configuration, we can
832 * assume ZFS has done the checking and it is
833 * safe to add this to the internal
834 * configuration.
836 if (_sa_zfs_process_share(hdl->libzfs_sharehdl,
837 NULL, NULL, mountpoint,
838 proto_table[*curr_proto].p_name, sourcetype,
839 shareopts, sourcestr, zhp->zfs_name) != SA_OK) {
840 (void) zfs_error_fmt(hdl,
841 proto_table[*curr_proto].p_share_err,
842 dgettext(TEXT_DOMAIN, "cannot share '%s'"),
843 zfs_get_name(zhp));
844 return (-1);
846 share = zfs_sa_find_share(hdl->libzfs_sharehdl,
847 mountpoint);
849 if (share != NULL) {
850 int err;
851 err = zfs_sa_enable_share(share,
852 proto_table[*curr_proto].p_name);
853 if (err != SA_OK) {
854 (void) zfs_error_fmt(hdl,
855 proto_table[*curr_proto].p_share_err,
856 dgettext(TEXT_DOMAIN, "cannot share '%s'"),
857 zfs_get_name(zhp));
858 return (-1);
860 } else {
861 (void) zfs_error_fmt(hdl,
862 proto_table[*curr_proto].p_share_err,
863 dgettext(TEXT_DOMAIN, "cannot share '%s'"),
864 zfs_get_name(zhp));
865 return (-1);
869 return (0);
874 zfs_share_nfs(zfs_handle_t *zhp)
876 return (zfs_share_proto(zhp, nfs_only));
880 zfs_share_smb(zfs_handle_t *zhp)
882 return (zfs_share_proto(zhp, smb_only));
886 zfs_shareall(zfs_handle_t *zhp)
888 return (zfs_share_proto(zhp, share_all_proto));
892 * Unshare a filesystem by mountpoint.
894 static int
895 unshare_one(libzfs_handle_t *hdl, const char *name, const char *mountpoint,
896 zfs_share_proto_t proto)
898 sa_share_t share;
899 int err;
900 char *mntpt;
903 * Mountpoint could get trashed if libshare calls getmntany
904 * which it does during API initialization, so strdup the
905 * value.
907 mntpt = zfs_strdup(hdl, mountpoint);
910 * make sure libshare initialized, initialize everything because we
911 * don't know what other unsharing may happen later. Functions up the
912 * stack are allowed to initialize instead a subset of shares at the
913 * time the set is known.
915 if ((err = zfs_init_libshare_arg(hdl, SA_INIT_ONE_SHARE_FROM_NAME,
916 (void *)name)) != SA_OK) {
917 free(mntpt); /* don't need the copy anymore */
918 return (zfs_error_fmt(hdl, EZFS_UNSHARENFSFAILED,
919 dgettext(TEXT_DOMAIN, "cannot unshare '%s': %s"),
920 name, _sa_errorstr(err)));
923 share = zfs_sa_find_share(hdl->libzfs_sharehdl, mntpt);
924 free(mntpt); /* don't need the copy anymore */
926 if (share != NULL) {
927 err = zfs_sa_disable_share(share, proto_table[proto].p_name);
928 if (err != SA_OK) {
929 return (zfs_error_fmt(hdl, EZFS_UNSHARENFSFAILED,
930 dgettext(TEXT_DOMAIN, "cannot unshare '%s': %s"),
931 name, _sa_errorstr(err)));
933 } else {
934 return (zfs_error_fmt(hdl, EZFS_UNSHARENFSFAILED,
935 dgettext(TEXT_DOMAIN, "cannot unshare '%s': not found"),
936 name));
938 return (0);
942 * Unshare the given filesystem.
945 zfs_unshare_proto(zfs_handle_t *zhp, const char *mountpoint,
946 zfs_share_proto_t *proto)
948 libzfs_handle_t *hdl = zhp->zfs_hdl;
949 struct mnttab entry;
950 char *mntpt = NULL;
952 /* check to see if need to unmount the filesystem */
953 rewind(zhp->zfs_hdl->libzfs_mnttab);
954 if (mountpoint != NULL)
955 mountpoint = mntpt = zfs_strdup(hdl, mountpoint);
957 if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
958 libzfs_mnttab_find(hdl, zfs_get_name(zhp), &entry) == 0)) {
959 zfs_share_proto_t *curr_proto;
961 if (mountpoint == NULL)
962 mntpt = zfs_strdup(zhp->zfs_hdl, entry.mnt_mountp);
964 for (curr_proto = proto; *curr_proto != PROTO_END;
965 curr_proto++) {
967 if (is_shared(hdl, mntpt, *curr_proto) &&
968 unshare_one(hdl, zhp->zfs_name,
969 mntpt, *curr_proto) != 0) {
970 free(mntpt);
971 return (-1);
975 free(mntpt);
977 return (0);
981 zfs_unshare_nfs(zfs_handle_t *zhp, const char *mountpoint)
983 return (zfs_unshare_proto(zhp, mountpoint, nfs_only));
987 zfs_unshare_smb(zfs_handle_t *zhp, const char *mountpoint)
989 return (zfs_unshare_proto(zhp, mountpoint, smb_only));
993 * Same as zfs_unmountall(), but for NFS and SMB unshares.
996 zfs_unshareall_proto(zfs_handle_t *zhp, zfs_share_proto_t *proto)
998 prop_changelist_t *clp;
999 int ret;
1001 clp = changelist_gather(zhp, ZFS_PROP_SHARENFS, 0, 0);
1002 if (clp == NULL)
1003 return (-1);
1005 ret = changelist_unshare(clp, proto);
1006 changelist_free(clp);
1008 return (ret);
1012 zfs_unshareall_nfs(zfs_handle_t *zhp)
1014 return (zfs_unshareall_proto(zhp, nfs_only));
1018 zfs_unshareall_smb(zfs_handle_t *zhp)
1020 return (zfs_unshareall_proto(zhp, smb_only));
1024 zfs_unshareall(zfs_handle_t *zhp)
1026 return (zfs_unshareall_proto(zhp, share_all_proto));
1030 zfs_unshareall_bypath(zfs_handle_t *zhp, const char *mountpoint)
1032 return (zfs_unshare_proto(zhp, mountpoint, share_all_proto));
1036 * Remove the mountpoint associated with the current dataset, if necessary.
1037 * We only remove the underlying directory if:
1039 * - The mountpoint is not 'none' or 'legacy'
1040 * - The mountpoint is non-empty
1041 * - The mountpoint is the default or inherited
1042 * - The 'zoned' property is set, or we're in a local zone
1044 * Any other directories we leave alone.
1046 void
1047 remove_mountpoint(zfs_handle_t *zhp)
1049 char mountpoint[ZFS_MAXPROPLEN];
1050 zprop_source_t source;
1052 if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint),
1053 &source))
1054 return;
1056 if (source == ZPROP_SRC_DEFAULT ||
1057 source == ZPROP_SRC_INHERITED) {
1059 * Try to remove the directory, silently ignoring any errors.
1060 * The filesystem may have since been removed or moved around,
1061 * and this error isn't really useful to the administrator in
1062 * any way.
1064 (void) rmdir(mountpoint);
1068 void
1069 libzfs_add_handle(get_all_cb_t *cbp, zfs_handle_t *zhp)
1071 if (cbp->cb_alloc == cbp->cb_used) {
1072 size_t newsz;
1073 void *ptr;
1075 newsz = cbp->cb_alloc ? cbp->cb_alloc * 2 : 64;
1076 ptr = zfs_realloc(zhp->zfs_hdl,
1077 cbp->cb_handles, cbp->cb_alloc * sizeof (void *),
1078 newsz * sizeof (void *));
1079 cbp->cb_handles = ptr;
1080 cbp->cb_alloc = newsz;
1082 cbp->cb_handles[cbp->cb_used++] = zhp;
1085 static int
1086 mount_cb(zfs_handle_t *zhp, void *data)
1088 get_all_cb_t *cbp = data;
1090 if (!(zfs_get_type(zhp) & ZFS_TYPE_FILESYSTEM)) {
1091 zfs_close(zhp);
1092 return (0);
1095 if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == ZFS_CANMOUNT_NOAUTO) {
1096 zfs_close(zhp);
1097 return (0);
1101 * If this filesystem is inconsistent and has a receive resume
1102 * token, we can not mount it.
1104 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) &&
1105 zfs_prop_get(zhp, ZFS_PROP_RECEIVE_RESUME_TOKEN,
1106 NULL, 0, NULL, NULL, 0, B_TRUE) == 0) {
1107 zfs_close(zhp);
1108 return (0);
1111 libzfs_add_handle(cbp, zhp);
1112 if (zfs_iter_filesystems(zhp, mount_cb, cbp) != 0) {
1113 zfs_close(zhp);
1114 return (-1);
1116 return (0);
1120 libzfs_dataset_cmp(const void *a, const void *b)
1122 zfs_handle_t **za = (zfs_handle_t **)a;
1123 zfs_handle_t **zb = (zfs_handle_t **)b;
1124 char mounta[MAXPATHLEN];
1125 char mountb[MAXPATHLEN];
1126 boolean_t gota, gotb;
1128 if ((gota = (zfs_get_type(*za) == ZFS_TYPE_FILESYSTEM)) != 0)
1129 verify(zfs_prop_get(*za, ZFS_PROP_MOUNTPOINT, mounta,
1130 sizeof (mounta), NULL, NULL, 0, B_FALSE) == 0);
1131 if ((gotb = (zfs_get_type(*zb) == ZFS_TYPE_FILESYSTEM)) != 0)
1132 verify(zfs_prop_get(*zb, ZFS_PROP_MOUNTPOINT, mountb,
1133 sizeof (mountb), NULL, NULL, 0, B_FALSE) == 0);
1135 if (gota && gotb)
1136 return (strcmp(mounta, mountb));
1138 if (gota)
1139 return (-1);
1140 if (gotb)
1141 return (1);
1143 return (strcmp(zfs_get_name(a), zfs_get_name(b)));
1147 * Mount and share all datasets within the given pool. This assumes that no
1148 * datasets within the pool are currently mounted. Because users can create
1149 * complicated nested hierarchies of mountpoints, we first gather all the
1150 * datasets and mountpoints within the pool, and sort them by mountpoint. Once
1151 * we have the list of all filesystems, we iterate over them in order and mount
1152 * and/or share each one.
1154 #pragma weak zpool_mount_datasets = zpool_enable_datasets
1156 zpool_enable_datasets(zpool_handle_t *zhp, const char *mntopts, int flags)
1158 get_all_cb_t cb = { 0 };
1159 libzfs_handle_t *hdl = zhp->zpool_hdl;
1160 zfs_handle_t *zfsp;
1161 int i, ret = -1;
1162 int *good;
1165 * Gather all non-snap datasets within the pool.
1167 if ((zfsp = zfs_open(hdl, zhp->zpool_name, ZFS_TYPE_DATASET)) == NULL)
1168 goto out;
1170 libzfs_add_handle(&cb, zfsp);
1171 if (zfs_iter_filesystems(zfsp, mount_cb, &cb) != 0)
1172 goto out;
1174 * Sort the datasets by mountpoint.
1176 qsort(cb.cb_handles, cb.cb_used, sizeof (void *),
1177 libzfs_dataset_cmp);
1180 * And mount all the datasets, keeping track of which ones
1181 * succeeded or failed.
1183 if ((good = zfs_alloc(zhp->zpool_hdl,
1184 cb.cb_used * sizeof (int))) == NULL)
1185 goto out;
1187 ret = 0;
1188 for (i = 0; i < cb.cb_used; i++) {
1189 if (zfs_mount(cb.cb_handles[i], mntopts, flags) != 0)
1190 ret = -1;
1191 else
1192 good[i] = 1;
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_handles[i]) != 0)
1203 ret = -1;
1206 free(good);
1208 out:
1209 for (i = 0; i < cb.cb_used; i++)
1210 zfs_close(cb.cb_handles[i]);
1211 free(cb.cb_handles);
1213 return (ret);
1216 static int
1217 mountpoint_compare(const void *a, const void *b)
1219 const char *mounta = *((char **)a);
1220 const char *mountb = *((char **)b);
1222 return (strcmp(mountb, mounta));
1225 /* alias for 2002/240 */
1226 #pragma weak zpool_unmount_datasets = zpool_disable_datasets
1228 * Unshare and unmount all datasets within the given pool. We don't want to
1229 * rely on traversing the DSL to discover the filesystems within the pool,
1230 * because this may be expensive (if not all of them are mounted), and can fail
1231 * arbitrarily (on I/O error, for example). Instead, we walk /etc/mnttab and
1232 * gather all the filesystems that are currently mounted.
1235 zpool_disable_datasets(zpool_handle_t *zhp, boolean_t force)
1237 int used, alloc;
1238 struct mnttab entry;
1239 size_t namelen;
1240 char **mountpoints = NULL;
1241 zfs_handle_t **datasets = NULL;
1242 libzfs_handle_t *hdl = zhp->zpool_hdl;
1243 int i;
1244 int ret = -1;
1245 int flags = (force ? MS_FORCE : 0);
1246 sa_init_selective_arg_t sharearg;
1248 namelen = strlen(zhp->zpool_name);
1250 rewind(hdl->libzfs_mnttab);
1251 used = alloc = 0;
1252 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
1254 * Ignore non-ZFS entries.
1256 if (entry.mnt_fstype == NULL ||
1257 strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
1258 continue;
1261 * Ignore filesystems not within this pool.
1263 if (entry.mnt_mountp == NULL ||
1264 strncmp(entry.mnt_special, zhp->zpool_name, namelen) != 0 ||
1265 (entry.mnt_special[namelen] != '/' &&
1266 entry.mnt_special[namelen] != '\0'))
1267 continue;
1270 * At this point we've found a filesystem within our pool. Add
1271 * it to our growing list.
1273 if (used == alloc) {
1274 if (alloc == 0) {
1275 if ((mountpoints = zfs_alloc(hdl,
1276 8 * sizeof (void *))) == NULL)
1277 goto out;
1279 if ((datasets = zfs_alloc(hdl,
1280 8 * sizeof (void *))) == NULL)
1281 goto out;
1283 alloc = 8;
1284 } else {
1285 void *ptr;
1287 if ((ptr = zfs_realloc(hdl, mountpoints,
1288 alloc * sizeof (void *),
1289 alloc * 2 * sizeof (void *))) == NULL)
1290 goto out;
1291 mountpoints = ptr;
1293 if ((ptr = zfs_realloc(hdl, datasets,
1294 alloc * sizeof (void *),
1295 alloc * 2 * sizeof (void *))) == NULL)
1296 goto out;
1297 datasets = ptr;
1299 alloc *= 2;
1303 if ((mountpoints[used] = zfs_strdup(hdl,
1304 entry.mnt_mountp)) == NULL)
1305 goto out;
1308 * This is allowed to fail, in case there is some I/O error. It
1309 * is only used to determine if we need to remove the underlying
1310 * mountpoint, so failure is not fatal.
1312 datasets[used] = make_dataset_handle(hdl, entry.mnt_special);
1314 used++;
1318 * At this point, we have the entire list of filesystems, so sort it by
1319 * mountpoint.
1321 sharearg.zhandle_arr = datasets;
1322 sharearg.zhandle_len = used;
1323 ret = zfs_init_libshare_arg(hdl, SA_INIT_SHARE_API_SELECTIVE,
1324 &sharearg);
1325 if (ret != 0)
1326 goto out;
1327 qsort(mountpoints, used, sizeof (char *), mountpoint_compare);
1330 * Walk through and first unshare everything.
1332 for (i = 0; i < used; i++) {
1333 zfs_share_proto_t *curr_proto;
1334 for (curr_proto = share_all_proto; *curr_proto != PROTO_END;
1335 curr_proto++) {
1336 if (is_shared(hdl, mountpoints[i], *curr_proto) &&
1337 unshare_one(hdl, mountpoints[i],
1338 mountpoints[i], *curr_proto) != 0)
1339 goto out;
1344 * Now unmount everything, removing the underlying directories as
1345 * appropriate.
1347 for (i = 0; i < used; i++) {
1348 if (unmount_one(hdl, mountpoints[i], flags) != 0)
1349 goto out;
1352 for (i = 0; i < used; i++) {
1353 if (datasets[i])
1354 remove_mountpoint(datasets[i]);
1357 ret = 0;
1358 out:
1359 for (i = 0; i < used; i++) {
1360 if (datasets[i])
1361 zfs_close(datasets[i]);
1362 free(mountpoints[i]);
1364 free(datasets);
1365 free(mountpoints);
1367 return (ret);