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.
24 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
25 * Copyright (c) 2011, 2016 by Delphix. All rights reserved.
26 * Copyright (c) 2012 DEY Storage Systems, Inc. All rights reserved.
27 * Copyright (c) 2012 Pawel Jakub Dawidek <pawel@dawidek.net>.
28 * Copyright (c) 2013 Martin Matuska. All rights reserved.
29 * Copyright (c) 2013 Steven Hartland. All rights reserved.
30 * Copyright 2016 Nexenta Systems, Inc.
31 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
32 * Copyright 2017 RackTop Systems.
46 #include <sys/mntent.h>
47 #include <sys/mount.h>
55 #include <directory.h>
56 #endif /* HAVE_IDMAP */
58 #include <sys/dnode.h>
63 #include "zfs_namecheck.h"
65 #include "libzfs_impl.h"
66 #include "zfs_deleg.h"
68 static int userquota_propname_decode(const char *propname, boolean_t zoned,
69 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
72 * Given a single type (not a mask of types), return the type in a human
76 zfs_type_to_name(zfs_type_t type)
79 case ZFS_TYPE_FILESYSTEM:
80 return (dgettext(TEXT_DOMAIN, "filesystem"));
81 case ZFS_TYPE_SNAPSHOT:
82 return (dgettext(TEXT_DOMAIN, "snapshot"));
84 return (dgettext(TEXT_DOMAIN, "volume"));
86 return (dgettext(TEXT_DOMAIN, "pool"));
87 case ZFS_TYPE_BOOKMARK:
88 return (dgettext(TEXT_DOMAIN, "bookmark"));
90 assert(!"unhandled zfs_type_t");
97 * Validate a ZFS path. This is used even before trying to open the dataset, to
98 * provide a more meaningful error message. We call zfs_error_aux() to
99 * explain exactly why the name was not valid.
102 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
108 if (entity_namecheck(path, &why, &what) != 0) {
111 case NAME_ERR_TOOLONG:
112 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
113 "name is too long"));
116 case NAME_ERR_LEADING_SLASH:
117 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
118 "leading slash in name"));
121 case NAME_ERR_EMPTY_COMPONENT:
122 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
123 "empty component in name"));
126 case NAME_ERR_TRAILING_SLASH:
127 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
128 "trailing slash in name"));
131 case NAME_ERR_INVALCHAR:
133 dgettext(TEXT_DOMAIN, "invalid character "
134 "'%c' in name"), what);
137 case NAME_ERR_MULTIPLE_DELIMITERS:
138 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
139 "multiple '@' and/or '#' delimiters in "
143 case NAME_ERR_NOLETTER:
144 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
145 "pool doesn't begin with a letter"));
148 case NAME_ERR_RESERVED:
149 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
150 "name is reserved"));
153 case NAME_ERR_DISKLIKE:
154 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
155 "reserved disk name"));
159 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
160 "(%d) not defined"), why);
168 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
170 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
171 "snapshot delimiter '@' is not expected here"));
175 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
177 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
178 "missing '@' delimiter in snapshot name"));
182 if (!(type & ZFS_TYPE_BOOKMARK) && strchr(path, '#') != NULL) {
184 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
185 "bookmark delimiter '#' is not expected here"));
189 if (type == ZFS_TYPE_BOOKMARK && strchr(path, '#') == NULL) {
191 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
192 "missing '#' delimiter in bookmark name"));
196 if (modifying && strchr(path, '%') != NULL) {
198 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
199 "invalid character %c in name"), '%');
207 zfs_name_valid(const char *name, zfs_type_t type)
209 if (type == ZFS_TYPE_POOL)
210 return (zpool_name_valid(NULL, B_FALSE, name));
211 return (zfs_validate_name(NULL, name, type, B_FALSE));
215 * This function takes the raw DSL properties, and filters out the user-defined
216 * properties into a separate nvlist.
219 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
221 libzfs_handle_t *hdl = zhp->zfs_hdl;
226 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
227 (void) no_memory(hdl);
232 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
233 if (!zfs_prop_user(nvpair_name(elem)))
236 verify(nvpair_value_nvlist(elem, &propval) == 0);
237 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
239 (void) no_memory(hdl);
247 static zpool_handle_t *
248 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
250 libzfs_handle_t *hdl = zhp->zfs_hdl;
253 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
254 if (hdl->libzfs_pool_handles != NULL)
255 zph->zpool_next = hdl->libzfs_pool_handles;
256 hdl->libzfs_pool_handles = zph;
261 static zpool_handle_t *
262 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
264 libzfs_handle_t *hdl = zhp->zfs_hdl;
265 zpool_handle_t *zph = hdl->libzfs_pool_handles;
267 while ((zph != NULL) &&
268 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
269 zph = zph->zpool_next;
274 * Returns a handle to the pool that contains the provided dataset.
275 * If a handle to that pool already exists then that handle is returned.
276 * Otherwise, a new handle is created and added to the list of handles.
278 static zpool_handle_t *
279 zpool_handle(zfs_handle_t *zhp)
285 len = strcspn(zhp->zfs_name, "/@#") + 1;
286 pool_name = zfs_alloc(zhp->zfs_hdl, len);
287 (void) strlcpy(pool_name, zhp->zfs_name, len);
289 zph = zpool_find_handle(zhp, pool_name, len);
291 zph = zpool_add_handle(zhp, pool_name);
298 zpool_free_handles(libzfs_handle_t *hdl)
300 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
302 while (zph != NULL) {
303 next = zph->zpool_next;
307 hdl->libzfs_pool_handles = NULL;
311 * Utility function to gather stats (objset and zpl) for the given object.
314 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
316 libzfs_handle_t *hdl = zhp->zfs_hdl;
318 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
320 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, zc) != 0) {
321 if (errno == ENOMEM) {
322 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
333 * Utility function to get the received properties of the given object.
336 get_recvd_props_ioctl(zfs_handle_t *zhp)
338 libzfs_handle_t *hdl = zhp->zfs_hdl;
339 nvlist_t *recvdprops;
340 zfs_cmd_t zc = {"\0"};
343 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
346 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
348 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
349 if (errno == ENOMEM) {
350 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
354 zcmd_free_nvlists(&zc);
359 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
360 zcmd_free_nvlists(&zc);
364 nvlist_free(zhp->zfs_recvd_props);
365 zhp->zfs_recvd_props = recvdprops;
371 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
373 nvlist_t *allprops, *userprops;
375 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
377 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
382 * XXX Why do we store the user props separately, in addition to
383 * storing them in zfs_props?
385 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
386 nvlist_free(allprops);
390 nvlist_free(zhp->zfs_props);
391 nvlist_free(zhp->zfs_user_props);
393 zhp->zfs_props = allprops;
394 zhp->zfs_user_props = userprops;
400 get_stats(zfs_handle_t *zhp)
403 zfs_cmd_t zc = {"\0"};
405 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
407 if (get_stats_ioctl(zhp, &zc) != 0)
409 else if (put_stats_zhdl(zhp, &zc) != 0)
411 zcmd_free_nvlists(&zc);
416 * Refresh the properties currently stored in the handle.
419 zfs_refresh_properties(zfs_handle_t *zhp)
421 (void) get_stats(zhp);
425 * Makes a handle from the given dataset name. Used by zfs_open() and
426 * zfs_iter_* to create child handles on the fly.
429 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
431 if (put_stats_zhdl(zhp, zc) != 0)
435 * We've managed to open the dataset and gather statistics. Determine
436 * the high-level type.
438 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
439 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
440 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
441 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
442 else if (zhp->zfs_dmustats.dds_type == DMU_OST_OTHER)
447 if (zhp->zfs_dmustats.dds_is_snapshot)
448 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
449 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
450 zhp->zfs_type = ZFS_TYPE_VOLUME;
451 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
452 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
454 abort(); /* we should never see any other types */
456 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
463 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
465 zfs_cmd_t zc = {"\0"};
467 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
473 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
474 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
478 if (get_stats_ioctl(zhp, &zc) == -1) {
479 zcmd_free_nvlists(&zc);
483 if (make_dataset_handle_common(zhp, &zc) == -1) {
487 zcmd_free_nvlists(&zc);
492 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
494 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
500 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
501 if (make_dataset_handle_common(zhp, zc) == -1) {
509 make_dataset_simple_handle_zc(zfs_handle_t *pzhp, zfs_cmd_t *zc)
511 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
516 zhp->zfs_hdl = pzhp->zfs_hdl;
517 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
518 zhp->zfs_head_type = pzhp->zfs_type;
519 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
520 zhp->zpool_hdl = zpool_handle(zhp);
526 zfs_handle_dup(zfs_handle_t *zhp_orig)
528 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
533 zhp->zfs_hdl = zhp_orig->zfs_hdl;
534 zhp->zpool_hdl = zhp_orig->zpool_hdl;
535 (void) strlcpy(zhp->zfs_name, zhp_orig->zfs_name,
536 sizeof (zhp->zfs_name));
537 zhp->zfs_type = zhp_orig->zfs_type;
538 zhp->zfs_head_type = zhp_orig->zfs_head_type;
539 zhp->zfs_dmustats = zhp_orig->zfs_dmustats;
540 if (zhp_orig->zfs_props != NULL) {
541 if (nvlist_dup(zhp_orig->zfs_props, &zhp->zfs_props, 0) != 0) {
542 (void) no_memory(zhp->zfs_hdl);
547 if (zhp_orig->zfs_user_props != NULL) {
548 if (nvlist_dup(zhp_orig->zfs_user_props,
549 &zhp->zfs_user_props, 0) != 0) {
550 (void) no_memory(zhp->zfs_hdl);
555 if (zhp_orig->zfs_recvd_props != NULL) {
556 if (nvlist_dup(zhp_orig->zfs_recvd_props,
557 &zhp->zfs_recvd_props, 0)) {
558 (void) no_memory(zhp->zfs_hdl);
563 zhp->zfs_mntcheck = zhp_orig->zfs_mntcheck;
564 if (zhp_orig->zfs_mntopts != NULL) {
565 zhp->zfs_mntopts = zfs_strdup(zhp_orig->zfs_hdl,
566 zhp_orig->zfs_mntopts);
568 zhp->zfs_props_table = zhp_orig->zfs_props_table;
573 zfs_bookmark_exists(const char *path)
577 char fsname[ZFS_MAX_DATASET_NAME_LEN];
584 (void) strlcpy(fsname, path, sizeof (fsname));
585 pound = strchr(fsname, '#');
590 bmark_name = pound + 1;
591 props = fnvlist_alloc();
592 err = lzc_get_bookmarks(fsname, props, &bmarks);
599 rv = nvlist_exists(bmarks, bmark_name);
605 make_bookmark_handle(zfs_handle_t *parent, const char *path,
606 nvlist_t *bmark_props)
608 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
613 /* Fill in the name. */
614 zhp->zfs_hdl = parent->zfs_hdl;
615 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
617 /* Set the property lists. */
618 if (nvlist_dup(bmark_props, &zhp->zfs_props, 0) != 0) {
624 zhp->zfs_head_type = parent->zfs_head_type;
625 zhp->zfs_type = ZFS_TYPE_BOOKMARK;
627 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL) {
628 nvlist_free(zhp->zfs_props);
636 struct zfs_open_bookmarks_cb_data {
642 zfs_open_bookmarks_cb(zfs_handle_t *zhp, void *data)
644 struct zfs_open_bookmarks_cb_data *dp = data;
647 * Is it the one we are looking for?
649 if (strcmp(dp->path, zfs_get_name(zhp)) == 0) {
651 * We found it. Save it and let the caller know we are done.
658 * Not found. Close the handle and ask for another one.
665 * Opens the given snapshot, bookmark, filesystem, or volume. The 'types'
666 * argument is a mask of acceptable types. The function will print an
667 * appropriate error message and return NULL if it can't be opened.
670 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
676 (void) snprintf(errbuf, sizeof (errbuf),
677 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
680 * Validate the name before we even try to open it.
682 if (!zfs_validate_name(hdl, path, types, B_FALSE)) {
683 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
688 * Bookmarks needs to be handled separately.
690 bookp = strchr(path, '#');
693 * Try to get stats for the dataset, which will tell us if it
697 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
698 (void) zfs_standard_error(hdl, errno, errbuf);
702 char dsname[ZFS_MAX_DATASET_NAME_LEN];
704 struct zfs_open_bookmarks_cb_data cb_data = {path, NULL};
707 * We need to cut out '#' and everything after '#'
708 * to get the parent dataset name only.
710 assert(bookp - path < sizeof (dsname));
711 (void) strncpy(dsname, path, bookp - path);
712 dsname[bookp - path] = '\0';
715 * Create handle for the parent dataset.
718 if ((pzhp = make_dataset_handle(hdl, dsname)) == NULL) {
719 (void) zfs_standard_error(hdl, errno, errbuf);
724 * Iterate bookmarks to find the right one.
727 if ((zfs_iter_bookmarks(pzhp, zfs_open_bookmarks_cb,
728 &cb_data) == 0) && (cb_data.zhp == NULL)) {
729 (void) zfs_error(hdl, EZFS_NOENT, errbuf);
733 if (cb_data.zhp == NULL) {
734 (void) zfs_standard_error(hdl, errno, errbuf);
746 if (!(types & zhp->zfs_type)) {
747 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
756 * Release a ZFS handle. Nothing to do but free the associated memory.
759 zfs_close(zfs_handle_t *zhp)
761 if (zhp->zfs_mntopts)
762 free(zhp->zfs_mntopts);
763 nvlist_free(zhp->zfs_props);
764 nvlist_free(zhp->zfs_user_props);
765 nvlist_free(zhp->zfs_recvd_props);
769 typedef struct mnttab_node {
770 struct mnttab mtn_mt;
775 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
777 const mnttab_node_t *mtn1 = (const mnttab_node_t *)arg1;
778 const mnttab_node_t *mtn2 = (const mnttab_node_t *)arg2;
781 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
783 return (AVL_ISIGN(rv));
787 libzfs_mnttab_init(libzfs_handle_t *hdl)
789 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
790 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
791 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
795 libzfs_mnttab_update(libzfs_handle_t *hdl)
799 /* Reopen MNTTAB to prevent reading stale data from open file */
800 if (freopen(MNTTAB, "r", hdl->libzfs_mnttab) == NULL)
803 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
807 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
810 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
811 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
812 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
813 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
814 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
816 /* Exclude duplicate mounts */
817 if (avl_find(&hdl->libzfs_mnttab_cache, mtn, &where) != NULL) {
818 free(mtn->mtn_mt.mnt_special);
819 free(mtn->mtn_mt.mnt_mountp);
820 free(mtn->mtn_mt.mnt_fstype);
821 free(mtn->mtn_mt.mnt_mntopts);
826 avl_add(&hdl->libzfs_mnttab_cache, mtn);
833 libzfs_mnttab_fini(libzfs_handle_t *hdl)
838 while ((mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie))
840 free(mtn->mtn_mt.mnt_special);
841 free(mtn->mtn_mt.mnt_mountp);
842 free(mtn->mtn_mt.mnt_fstype);
843 free(mtn->mtn_mt.mnt_mntopts);
846 avl_destroy(&hdl->libzfs_mnttab_cache);
850 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
852 hdl->libzfs_mnttab_enable = enable;
856 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
857 struct mnttab *entry)
863 if (!hdl->libzfs_mnttab_enable) {
864 struct mnttab srch = { 0 };
866 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
867 libzfs_mnttab_fini(hdl);
869 /* Reopen MNTTAB to prevent reading stale data from open file */
870 if (freopen(MNTTAB, "r", hdl->libzfs_mnttab) == NULL)
873 srch.mnt_special = (char *)fsname;
874 srch.mnt_fstype = MNTTYPE_ZFS;
875 if (getmntany(hdl->libzfs_mnttab, entry, &srch) == 0)
881 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
882 if ((error = libzfs_mnttab_update(hdl)) != 0)
885 find.mtn_mt.mnt_special = (char *)fsname;
886 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
888 *entry = mtn->mtn_mt;
895 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
896 const char *mountp, const char *mntopts)
900 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
902 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
903 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
904 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
905 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
906 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
907 avl_add(&hdl->libzfs_mnttab_cache, mtn);
911 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
916 find.mtn_mt.mnt_special = (char *)fsname;
917 if ((ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL))
919 avl_remove(&hdl->libzfs_mnttab_cache, ret);
920 free(ret->mtn_mt.mnt_special);
921 free(ret->mtn_mt.mnt_mountp);
922 free(ret->mtn_mt.mnt_fstype);
923 free(ret->mtn_mt.mnt_mntopts);
929 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
931 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
933 if (zpool_handle == NULL)
936 *spa_version = zpool_get_prop_int(zpool_handle,
937 ZPOOL_PROP_VERSION, NULL);
942 * The choice of reservation property depends on the SPA version.
945 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
949 if (zfs_spa_version(zhp, &spa_version) < 0)
952 if (spa_version >= SPA_VERSION_REFRESERVATION)
953 *resv_prop = ZFS_PROP_REFRESERVATION;
955 *resv_prop = ZFS_PROP_RESERVATION;
961 * Given an nvlist of properties to set, validates that they are correct, and
962 * parses any numeric properties (index, boolean, etc) if they are specified as
966 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
967 uint64_t zoned, zfs_handle_t *zhp, zpool_handle_t *zpool_hdl,
975 int chosen_normal = -1;
978 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
979 (void) no_memory(hdl);
984 * Make sure this property is valid and applies to this type.
988 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
989 const char *propname = nvpair_name(elem);
991 prop = zfs_name_to_prop(propname);
992 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
994 * This is a user property: make sure it's a
995 * string, and that it's less than ZAP_MAXNAMELEN.
997 if (nvpair_type(elem) != DATA_TYPE_STRING) {
998 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
999 "'%s' must be a string"), propname);
1000 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1004 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
1005 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1006 "property name '%s' is too long"),
1008 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1012 (void) nvpair_value_string(elem, &strval);
1013 if (nvlist_add_string(ret, propname, strval) != 0) {
1014 (void) no_memory(hdl);
1021 * Currently, only user properties can be modified on
1024 if (type == ZFS_TYPE_SNAPSHOT) {
1025 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1026 "this property can not be modified for snapshots"));
1027 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1031 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
1032 zfs_userquota_prop_t uqtype;
1033 char newpropname[128];
1038 if (userquota_propname_decode(propname, zoned,
1039 &uqtype, domain, sizeof (domain), &rid) != 0) {
1041 dgettext(TEXT_DOMAIN,
1042 "'%s' has an invalid user/group name"),
1044 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1048 if (uqtype != ZFS_PROP_USERQUOTA &&
1049 uqtype != ZFS_PROP_GROUPQUOTA &&
1050 uqtype != ZFS_PROP_USEROBJQUOTA &&
1051 uqtype != ZFS_PROP_GROUPOBJQUOTA) {
1053 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1055 (void) zfs_error(hdl, EZFS_PROPREADONLY,
1060 if (nvpair_type(elem) == DATA_TYPE_STRING) {
1061 (void) nvpair_value_string(elem, &strval);
1062 if (strcmp(strval, "none") == 0) {
1064 } else if (zfs_nicestrtonum(hdl,
1065 strval, &intval) != 0) {
1066 (void) zfs_error(hdl,
1067 EZFS_BADPROP, errbuf);
1070 } else if (nvpair_type(elem) ==
1072 (void) nvpair_value_uint64(elem, &intval);
1074 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1075 "use 'none' to disable "
1076 "userquota/groupquota"));
1080 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1081 "'%s' must be a number"), propname);
1082 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1087 * Encode the prop name as
1088 * userquota@<hex-rid>-domain, to make it easy
1089 * for the kernel to decode.
1091 (void) snprintf(newpropname, sizeof (newpropname),
1092 "%s%llx-%s", zfs_userquota_prop_prefixes[uqtype],
1093 (longlong_t)rid, domain);
1097 if (nvlist_add_uint64_array(ret, newpropname,
1099 (void) no_memory(hdl);
1103 } else if (prop == ZPROP_INVAL && zfs_prop_written(propname)) {
1104 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1105 "'%s' is readonly"),
1107 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1111 if (prop == ZPROP_INVAL) {
1112 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1113 "invalid property '%s'"), propname);
1114 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1118 if (!zfs_prop_valid_for_type(prop, type, B_FALSE)) {
1120 dgettext(TEXT_DOMAIN, "'%s' does not "
1121 "apply to datasets of this type"), propname);
1122 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1126 if (zfs_prop_readonly(prop) &&
1127 (!zfs_prop_setonce(prop) || zhp != NULL)) {
1129 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1131 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1135 if (zprop_parse_value(hdl, elem, prop, type, ret,
1136 &strval, &intval, errbuf) != 0)
1140 * Perform some additional checks for specific properties.
1143 case ZFS_PROP_VERSION:
1149 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1150 if (intval < version) {
1151 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1152 "Can not downgrade; already at version %u"),
1154 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1160 case ZFS_PROP_VOLBLOCKSIZE:
1161 case ZFS_PROP_RECORDSIZE:
1163 int maxbs = SPA_MAXBLOCKSIZE;
1166 if (zpool_hdl != NULL) {
1167 maxbs = zpool_get_prop_int(zpool_hdl,
1168 ZPOOL_PROP_MAXBLOCKSIZE, NULL);
1171 * The value must be a power of two between
1172 * SPA_MINBLOCKSIZE and maxbs.
1174 if (intval < SPA_MINBLOCKSIZE ||
1175 intval > maxbs || !ISP2(intval)) {
1176 zfs_nicebytes(maxbs, buf, sizeof (buf));
1177 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1178 "'%s' must be power of 2 from 512B "
1179 "to %s"), propname, buf);
1180 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1185 case ZFS_PROP_MLSLABEL:
1187 #ifdef HAVE_MLSLABEL
1189 * Verify the mlslabel string and convert to
1190 * internal hex label string.
1194 char *hex = NULL; /* internal label string */
1196 /* Default value is already OK. */
1197 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
1200 /* Verify the label can be converted to binary form */
1201 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
1202 (str_to_label(strval, &new_sl, MAC_LABEL,
1203 L_NO_CORRECTION, NULL) == -1)) {
1207 /* Now translate to hex internal label string */
1208 if (label_to_str(new_sl, &hex, M_INTERNAL,
1214 m_label_free(new_sl);
1216 /* If string is already in internal form, we're done. */
1217 if (strcmp(strval, hex) == 0) {
1222 /* Replace the label string with the internal form. */
1223 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
1225 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
1232 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1233 "invalid mlslabel '%s'"), strval);
1234 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1235 m_label_free(new_sl); /* OK if null */
1238 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1239 "mlslabels are unsupported"));
1240 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1242 #endif /* HAVE_MLSLABEL */
1245 case ZFS_PROP_MOUNTPOINT:
1247 namecheck_err_t why;
1249 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1250 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1253 if (mountpoint_namecheck(strval, &why)) {
1255 case NAME_ERR_LEADING_SLASH:
1257 dgettext(TEXT_DOMAIN,
1258 "'%s' must be an absolute path, "
1259 "'none', or 'legacy'"), propname);
1261 case NAME_ERR_TOOLONG:
1263 dgettext(TEXT_DOMAIN,
1264 "component of '%s' is too long"),
1270 dgettext(TEXT_DOMAIN,
1271 "(%d) not defined"),
1275 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1282 case ZFS_PROP_SHARESMB:
1283 case ZFS_PROP_SHARENFS:
1285 * For the mountpoint and sharenfs or sharesmb
1286 * properties, check if it can be set in a
1287 * global/non-global zone based on
1288 * the zoned property value:
1290 * global zone non-global zone
1291 * --------------------------------------------------
1292 * zoned=on mountpoint (no) mountpoint (yes)
1293 * sharenfs (no) sharenfs (no)
1294 * sharesmb (no) sharesmb (no)
1296 * zoned=off mountpoint (yes) N/A
1301 if (getzoneid() == GLOBAL_ZONEID) {
1302 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1303 "'%s' cannot be set on "
1304 "dataset in a non-global zone"),
1306 (void) zfs_error(hdl, EZFS_ZONED,
1309 } else if (prop == ZFS_PROP_SHARENFS ||
1310 prop == ZFS_PROP_SHARESMB) {
1311 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1312 "'%s' cannot be set in "
1313 "a non-global zone"), propname);
1314 (void) zfs_error(hdl, EZFS_ZONED,
1318 } else if (getzoneid() != GLOBAL_ZONEID) {
1320 * If zoned property is 'off', this must be in
1321 * a global zone. If not, something is wrong.
1323 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1324 "'%s' cannot be set while dataset "
1325 "'zoned' property is set"), propname);
1326 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1331 * At this point, it is legitimate to set the
1332 * property. Now we want to make sure that the
1333 * property value is valid if it is sharenfs.
1335 if ((prop == ZFS_PROP_SHARENFS ||
1336 prop == ZFS_PROP_SHARESMB) &&
1337 strcmp(strval, "on") != 0 &&
1338 strcmp(strval, "off") != 0) {
1339 zfs_share_proto_t proto;
1341 if (prop == ZFS_PROP_SHARESMB)
1347 * Must be an valid sharing protocol
1348 * option string so init the libshare
1349 * in order to enable the parser and
1350 * then parse the options. We use the
1351 * control API since we don't care about
1352 * the current configuration and don't
1353 * want the overhead of loading it
1354 * until we actually do something.
1357 if (zfs_init_libshare(hdl,
1358 SA_INIT_CONTROL_API) != SA_OK) {
1360 * An error occurred so we can't do
1363 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1364 "'%s' cannot be set: problem "
1365 "in share initialization"),
1367 (void) zfs_error(hdl, EZFS_BADPROP,
1372 if (zfs_parse_options(strval, proto) != SA_OK) {
1374 * There was an error in parsing so
1375 * deal with it by issuing an error
1376 * message and leaving after
1377 * uninitializing the the libshare
1380 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1381 "'%s' cannot be set to invalid "
1382 "options"), propname);
1383 (void) zfs_error(hdl, EZFS_BADPROP,
1385 zfs_uninit_libshare(hdl);
1388 zfs_uninit_libshare(hdl);
1393 case ZFS_PROP_UTF8ONLY:
1394 chosen_utf = (int)intval;
1397 case ZFS_PROP_NORMALIZE:
1398 chosen_normal = (int)intval;
1406 * For changes to existing volumes, we have some additional
1407 * checks to enforce.
1409 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1410 uint64_t volsize = zfs_prop_get_int(zhp,
1412 uint64_t blocksize = zfs_prop_get_int(zhp,
1413 ZFS_PROP_VOLBLOCKSIZE);
1417 case ZFS_PROP_RESERVATION:
1418 case ZFS_PROP_REFRESERVATION:
1419 if (intval > volsize) {
1420 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1421 "'%s' is greater than current "
1422 "volume size"), propname);
1423 (void) zfs_error(hdl, EZFS_BADPROP,
1429 case ZFS_PROP_VOLSIZE:
1430 if (intval % blocksize != 0) {
1431 zfs_nicebytes(blocksize, buf,
1433 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1434 "'%s' must be a multiple of "
1435 "volume block size (%s)"),
1437 (void) zfs_error(hdl, EZFS_BADPROP,
1443 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1444 "'%s' cannot be zero"),
1446 (void) zfs_error(hdl, EZFS_BADPROP,
1459 * If normalization was chosen, but no UTF8 choice was made,
1460 * enforce rejection of non-UTF8 names.
1462 * If normalization was chosen, but rejecting non-UTF8 names
1463 * was explicitly not chosen, it is an error.
1465 if (chosen_normal > 0 && chosen_utf < 0) {
1466 if (nvlist_add_uint64(ret,
1467 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1468 (void) no_memory(hdl);
1471 } else if (chosen_normal > 0 && chosen_utf == 0) {
1472 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1473 "'%s' must be set 'on' if normalization chosen"),
1474 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1475 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1486 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1488 uint64_t old_volsize;
1489 uint64_t new_volsize;
1490 uint64_t old_reservation;
1491 uint64_t new_reservation;
1492 zfs_prop_t resv_prop;
1496 * If this is an existing volume, and someone is setting the volsize,
1497 * make sure that it matches the reservation, or add it if necessary.
1499 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1500 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1502 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1504 props = fnvlist_alloc();
1505 fnvlist_add_uint64(props, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
1506 zfs_prop_get_int(zhp, ZFS_PROP_VOLBLOCKSIZE));
1508 if ((zvol_volsize_to_reservation(old_volsize, props) !=
1509 old_reservation) || nvlist_exists(nvl,
1510 zfs_prop_to_name(resv_prop))) {
1511 fnvlist_free(props);
1514 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1515 &new_volsize) != 0) {
1516 fnvlist_free(props);
1519 new_reservation = zvol_volsize_to_reservation(new_volsize, props);
1520 fnvlist_free(props);
1522 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1523 new_reservation) != 0) {
1524 (void) no_memory(zhp->zfs_hdl);
1531 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1538 * For quotas and reservations, ENOSPC indicates
1539 * something different; setting a quota or reservation
1540 * doesn't use any disk space.
1543 case ZFS_PROP_QUOTA:
1544 case ZFS_PROP_REFQUOTA:
1545 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1546 "size is less than current used or "
1548 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1551 case ZFS_PROP_RESERVATION:
1552 case ZFS_PROP_REFRESERVATION:
1553 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1554 "size is greater than available space"));
1555 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1559 (void) zfs_standard_error(hdl, err, errbuf);
1565 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1569 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1573 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1574 "property value too long"));
1575 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1579 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1580 "pool and or dataset must be upgraded to set this "
1581 "property or value"));
1582 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1586 if (prop == ZFS_PROP_COMPRESSION ||
1587 prop == ZFS_PROP_DNODESIZE ||
1588 prop == ZFS_PROP_RECORDSIZE) {
1589 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1590 "property setting is not allowed on "
1591 "bootable datasets"));
1592 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1593 } else if (prop == ZFS_PROP_CHECKSUM ||
1594 prop == ZFS_PROP_DEDUP) {
1595 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1596 "property setting is not allowed on "
1598 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1600 (void) zfs_standard_error(hdl, err, errbuf);
1605 if (prop == ZPROP_INVAL) {
1606 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1608 (void) zfs_standard_error(hdl, err, errbuf);
1614 * This platform can't address a volume this big.
1617 if (prop == ZFS_PROP_VOLSIZE) {
1618 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1624 (void) zfs_standard_error(hdl, err, errbuf);
1629 zfs_is_namespace_prop(zfs_prop_t prop)
1633 case ZFS_PROP_ATIME:
1634 case ZFS_PROP_RELATIME:
1635 case ZFS_PROP_DEVICES:
1637 case ZFS_PROP_SETUID:
1638 case ZFS_PROP_READONLY:
1639 case ZFS_PROP_XATTR:
1640 case ZFS_PROP_NBMAND:
1649 * Given a property name and value, set the property for the given dataset.
1652 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1656 libzfs_handle_t *hdl = zhp->zfs_hdl;
1657 nvlist_t *nvl = NULL;
1659 (void) snprintf(errbuf, sizeof (errbuf),
1660 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1663 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1664 nvlist_add_string(nvl, propname, propval) != 0) {
1665 (void) no_memory(hdl);
1669 ret = zfs_prop_set_list(zhp, nvl);
1679 * Given an nvlist of property names and values, set the properties for the
1683 zfs_prop_set_list(zfs_handle_t *zhp, nvlist_t *props)
1685 zfs_cmd_t zc = {"\0"};
1687 prop_changelist_t **cls = NULL;
1690 libzfs_handle_t *hdl = zhp->zfs_hdl;
1694 zfs_prop_t prop = 0;
1697 (void) snprintf(errbuf, sizeof (errbuf),
1698 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1701 if ((nvl = zfs_valid_proplist(hdl, zhp->zfs_type, props,
1702 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, zhp->zpool_hdl,
1707 * We have to check for any extra properties which need to be added
1708 * before computing the length of the nvlist.
1710 for (elem = nvlist_next_nvpair(nvl, NULL);
1712 elem = nvlist_next_nvpair(nvl, elem)) {
1713 if (zfs_name_to_prop(nvpair_name(elem)) == ZFS_PROP_VOLSIZE &&
1714 (added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1) {
1719 * Check how many properties we're setting and allocate an array to
1720 * store changelist pointers for postfix().
1722 for (elem = nvlist_next_nvpair(nvl, NULL);
1724 elem = nvlist_next_nvpair(nvl, elem))
1726 if ((cls = calloc(nvl_len, sizeof (prop_changelist_t *))) == NULL)
1730 for (elem = nvlist_next_nvpair(nvl, NULL);
1732 elem = nvlist_next_nvpair(nvl, elem)) {
1734 prop = zfs_name_to_prop(nvpair_name(elem));
1736 assert(cl_idx < nvl_len);
1738 * We don't want to unmount & remount the dataset when changing
1739 * its canmount property to 'on' or 'noauto'. We only use
1740 * the changelist logic to unmount when setting canmount=off.
1742 if (prop != ZFS_PROP_CANMOUNT ||
1743 (fnvpair_value_uint64(elem) == ZFS_CANMOUNT_OFF &&
1744 zfs_is_mounted(zhp, NULL))) {
1745 cls[cl_idx] = changelist_gather(zhp, prop, 0, 0);
1746 if (cls[cl_idx] == NULL)
1750 if (prop == ZFS_PROP_MOUNTPOINT &&
1751 changelist_haszonedchild(cls[cl_idx])) {
1752 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1753 "child dataset with inherited mountpoint is used "
1754 "in a non-global zone"));
1755 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1759 if (cls[cl_idx] != NULL &&
1760 (ret = changelist_prefix(cls[cl_idx])) != 0)
1765 assert(cl_idx == nvl_len);
1768 * Execute the corresponding ioctl() to set this list of properties.
1770 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1772 if ((ret = zcmd_write_src_nvlist(hdl, &zc, nvl)) != 0 ||
1773 (ret = zcmd_alloc_dst_nvlist(hdl, &zc, 0)) != 0)
1776 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1779 /* Get the list of unset properties back and report them. */
1780 nvlist_t *errorprops = NULL;
1781 if (zcmd_read_dst_nvlist(hdl, &zc, &errorprops) != 0)
1783 for (elem = nvlist_next_nvpair(nvl, NULL);
1785 elem = nvlist_next_nvpair(nvl, elem)) {
1786 prop = zfs_name_to_prop(nvpair_name(elem));
1787 zfs_setprop_error(hdl, prop, errno, errbuf);
1789 nvlist_free(errorprops);
1791 if (added_resv && errno == ENOSPC) {
1792 /* clean up the volsize property we tried to set */
1793 uint64_t old_volsize = zfs_prop_get_int(zhp,
1797 zcmd_free_nvlists(&zc);
1799 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1801 if (nvlist_add_uint64(nvl,
1802 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1805 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1807 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1810 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1811 if (cls[cl_idx] != NULL) {
1812 int clp_err = changelist_postfix(cls[cl_idx]);
1820 * Refresh the statistics so the new property
1821 * value is reflected.
1823 (void) get_stats(zhp);
1826 * Remount the filesystem to propagate the change
1827 * if one of the options handled by the generic
1828 * Linux namespace layer has been modified.
1830 if (zfs_is_namespace_prop(prop) &&
1831 zfs_is_mounted(zhp, NULL))
1832 ret = zfs_mount(zhp, MNTOPT_REMOUNT, 0);
1838 zcmd_free_nvlists(&zc);
1840 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1841 if (cls[cl_idx] != NULL)
1842 changelist_free(cls[cl_idx]);
1850 * Given a property, inherit the value from the parent dataset, or if received
1851 * is TRUE, revert to the received value, if any.
1854 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1856 zfs_cmd_t zc = {"\0"};
1858 prop_changelist_t *cl;
1859 libzfs_handle_t *hdl = zhp->zfs_hdl;
1863 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1864 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1866 zc.zc_cookie = received;
1867 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1869 * For user properties, the amount of work we have to do is very
1870 * small, so just do it here.
1872 if (!zfs_prop_user(propname)) {
1873 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1874 "invalid property"));
1875 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1878 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1879 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1881 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1882 return (zfs_standard_error(hdl, errno, errbuf));
1888 * Verify that this property is inheritable.
1890 if (zfs_prop_readonly(prop))
1891 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1893 if (!zfs_prop_inheritable(prop) && !received)
1894 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1897 * Check to see if the value applies to this type
1899 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE))
1900 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1903 * Normalize the name, to get rid of shorthand abbreviations.
1905 propname = zfs_prop_to_name(prop);
1906 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1907 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1909 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1910 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1911 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1912 "dataset is used in a non-global zone"));
1913 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1917 * Determine datasets which will be affected by this change, if any.
1919 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1922 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1923 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1924 "child dataset with inherited mountpoint is used "
1925 "in a non-global zone"));
1926 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1930 if ((ret = changelist_prefix(cl)) != 0)
1933 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1934 return (zfs_standard_error(hdl, errno, errbuf));
1937 if ((ret = changelist_postfix(cl)) != 0)
1941 * Refresh the statistics so the new property is reflected.
1943 (void) get_stats(zhp);
1946 * Remount the filesystem to propagate the change
1947 * if one of the options handled by the generic
1948 * Linux namespace layer has been modified.
1950 if (zfs_is_namespace_prop(prop) &&
1951 zfs_is_mounted(zhp, NULL))
1952 ret = zfs_mount(zhp, MNTOPT_REMOUNT, 0);
1956 changelist_free(cl);
1961 * True DSL properties are stored in an nvlist. The following two functions
1962 * extract them appropriately.
1965 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1971 if (nvlist_lookup_nvlist(zhp->zfs_props,
1972 zfs_prop_to_name(prop), &nv) == 0) {
1973 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1974 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1976 verify(!zhp->zfs_props_table ||
1977 zhp->zfs_props_table[prop] == B_TRUE);
1978 value = zfs_prop_default_numeric(prop);
1986 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1992 if (nvlist_lookup_nvlist(zhp->zfs_props,
1993 zfs_prop_to_name(prop), &nv) == 0) {
1994 value = fnvlist_lookup_string(nv, ZPROP_VALUE);
1995 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1997 verify(!zhp->zfs_props_table ||
1998 zhp->zfs_props_table[prop] == B_TRUE);
1999 value = zfs_prop_default_string(prop);
2007 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
2009 return (zhp->zfs_props == zhp->zfs_recvd_props);
2013 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
2015 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
2016 zhp->zfs_props = zhp->zfs_recvd_props;
2020 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
2022 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
2027 * Internal function for getting a numeric property. Both zfs_prop_get() and
2028 * zfs_prop_get_int() are built using this interface.
2030 * Certain properties can be overridden using 'mount -o'. In this case, scan
2031 * the contents of the /proc/self/mounts entry, searching for the
2032 * appropriate options. If they differ from the on-disk values, report the
2033 * current values and mark the source "temporary".
2036 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
2037 char **source, uint64_t *val)
2039 zfs_cmd_t zc = {"\0"};
2040 nvlist_t *zplprops = NULL;
2042 char *mntopt_on = NULL;
2043 char *mntopt_off = NULL;
2044 boolean_t received = zfs_is_recvd_props_mode(zhp);
2049 * If the property is being fetched for a snapshot, check whether
2050 * the property is valid for the snapshot's head dataset type.
2052 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT &&
2053 !zfs_prop_valid_for_type(prop, zhp->zfs_head_type, B_TRUE)) {
2054 *val = zfs_prop_default_numeric(prop);
2059 case ZFS_PROP_ATIME:
2060 mntopt_on = MNTOPT_ATIME;
2061 mntopt_off = MNTOPT_NOATIME;
2064 case ZFS_PROP_RELATIME:
2065 mntopt_on = MNTOPT_RELATIME;
2066 mntopt_off = MNTOPT_NORELATIME;
2069 case ZFS_PROP_DEVICES:
2070 mntopt_on = MNTOPT_DEVICES;
2071 mntopt_off = MNTOPT_NODEVICES;
2075 mntopt_on = MNTOPT_EXEC;
2076 mntopt_off = MNTOPT_NOEXEC;
2079 case ZFS_PROP_READONLY:
2080 mntopt_on = MNTOPT_RO;
2081 mntopt_off = MNTOPT_RW;
2084 case ZFS_PROP_SETUID:
2085 mntopt_on = MNTOPT_SETUID;
2086 mntopt_off = MNTOPT_NOSETUID;
2089 case ZFS_PROP_XATTR:
2090 mntopt_on = MNTOPT_XATTR;
2091 mntopt_off = MNTOPT_NOXATTR;
2094 case ZFS_PROP_NBMAND:
2095 mntopt_on = MNTOPT_NBMAND;
2096 mntopt_off = MNTOPT_NONBMAND;
2104 * Because looking up the mount options is potentially expensive
2105 * (iterating over all of /proc/self/mounts), we defer its
2106 * calculation until we're looking up a property which requires
2109 if (!zhp->zfs_mntcheck &&
2110 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
2111 libzfs_handle_t *hdl = zhp->zfs_hdl;
2112 struct mnttab entry;
2114 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
2115 zhp->zfs_mntopts = zfs_strdup(hdl,
2117 if (zhp->zfs_mntopts == NULL)
2121 zhp->zfs_mntcheck = B_TRUE;
2124 if (zhp->zfs_mntopts == NULL)
2125 mnt.mnt_mntopts = "";
2127 mnt.mnt_mntopts = zhp->zfs_mntopts;
2130 case ZFS_PROP_ATIME:
2131 case ZFS_PROP_RELATIME:
2132 case ZFS_PROP_DEVICES:
2134 case ZFS_PROP_READONLY:
2135 case ZFS_PROP_SETUID:
2136 case ZFS_PROP_XATTR:
2137 case ZFS_PROP_NBMAND:
2138 *val = getprop_uint64(zhp, prop, source);
2143 if (hasmntopt(&mnt, mntopt_on) && !*val) {
2146 *src = ZPROP_SRC_TEMPORARY;
2147 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
2150 *src = ZPROP_SRC_TEMPORARY;
2154 case ZFS_PROP_CANMOUNT:
2155 case ZFS_PROP_VOLSIZE:
2156 case ZFS_PROP_QUOTA:
2157 case ZFS_PROP_REFQUOTA:
2158 case ZFS_PROP_RESERVATION:
2159 case ZFS_PROP_REFRESERVATION:
2160 case ZFS_PROP_FILESYSTEM_LIMIT:
2161 case ZFS_PROP_SNAPSHOT_LIMIT:
2162 case ZFS_PROP_FILESYSTEM_COUNT:
2163 case ZFS_PROP_SNAPSHOT_COUNT:
2164 *val = getprop_uint64(zhp, prop, source);
2166 if (*source == NULL) {
2167 /* not default, must be local */
2168 *source = zhp->zfs_name;
2172 case ZFS_PROP_MOUNTED:
2173 *val = (zhp->zfs_mntopts != NULL);
2176 case ZFS_PROP_NUMCLONES:
2177 *val = zhp->zfs_dmustats.dds_num_clones;
2180 case ZFS_PROP_VERSION:
2181 case ZFS_PROP_NORMALIZE:
2182 case ZFS_PROP_UTF8ONLY:
2184 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2186 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2187 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
2188 zcmd_free_nvlists(&zc);
2189 if (prop == ZFS_PROP_VERSION &&
2190 zhp->zfs_type == ZFS_TYPE_VOLUME)
2191 *val = zfs_prop_default_numeric(prop);
2194 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
2195 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
2197 zcmd_free_nvlists(&zc);
2200 nvlist_free(zplprops);
2201 zcmd_free_nvlists(&zc);
2204 case ZFS_PROP_INCONSISTENT:
2205 *val = zhp->zfs_dmustats.dds_inconsistent;
2209 switch (zfs_prop_get_type(prop)) {
2210 case PROP_TYPE_NUMBER:
2211 case PROP_TYPE_INDEX:
2212 *val = getprop_uint64(zhp, prop, source);
2214 * If we tried to use a default value for a
2215 * readonly property, it means that it was not
2216 * present. Note this only applies to "truly"
2217 * readonly properties, not set-once properties
2218 * like volblocksize.
2220 if (zfs_prop_readonly(prop) &&
2221 !zfs_prop_setonce(prop) &&
2222 *source != NULL && (*source)[0] == '\0') {
2228 case PROP_TYPE_STRING:
2230 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
2231 "cannot get non-numeric property"));
2232 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
2233 dgettext(TEXT_DOMAIN, "internal error")));
2241 * Calculate the source type, given the raw source string.
2244 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
2245 char *statbuf, size_t statlen)
2247 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
2250 if (source == NULL) {
2251 *srctype = ZPROP_SRC_NONE;
2252 } else if (source[0] == '\0') {
2253 *srctype = ZPROP_SRC_DEFAULT;
2254 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
2255 *srctype = ZPROP_SRC_RECEIVED;
2257 if (strcmp(source, zhp->zfs_name) == 0) {
2258 *srctype = ZPROP_SRC_LOCAL;
2260 (void) strlcpy(statbuf, source, statlen);
2261 *srctype = ZPROP_SRC_INHERITED;
2268 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
2269 size_t proplen, boolean_t literal)
2274 if (zhp->zfs_recvd_props == NULL)
2275 if (get_recvd_props_ioctl(zhp) != 0)
2278 prop = zfs_name_to_prop(propname);
2280 if (prop != ZPROP_INVAL) {
2282 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
2284 zfs_set_recvd_props_mode(zhp, &cookie);
2285 err = zfs_prop_get(zhp, prop, propbuf, proplen,
2286 NULL, NULL, 0, literal);
2287 zfs_unset_recvd_props_mode(zhp, &cookie);
2291 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
2292 propname, &propval) != 0)
2294 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
2296 (void) strlcpy(propbuf, recvdval, proplen);
2299 return (err == 0 ? 0 : -1);
2303 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2308 value = zfs_get_clones_nvl(zhp);
2313 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
2314 pair = nvlist_next_nvpair(value, pair)) {
2315 if (propbuf[0] != '\0')
2316 (void) strlcat(propbuf, ",", proplen);
2317 (void) strlcat(propbuf, nvpair_name(pair), proplen);
2323 struct get_clones_arg {
2327 char buf[ZFS_MAX_DATASET_NAME_LEN];
2331 get_clones_cb(zfs_handle_t *zhp, void *arg)
2333 struct get_clones_arg *gca = arg;
2335 if (gca->numclones == 0) {
2340 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
2341 NULL, NULL, 0, B_TRUE) != 0)
2343 if (strcmp(gca->buf, gca->origin) == 0) {
2344 fnvlist_add_boolean(gca->value, zfs_get_name(zhp));
2349 (void) zfs_iter_children(zhp, get_clones_cb, gca);
2355 zfs_get_clones_nvl(zfs_handle_t *zhp)
2357 nvlist_t *nv, *value;
2359 if (nvlist_lookup_nvlist(zhp->zfs_props,
2360 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
2361 struct get_clones_arg gca;
2364 * if this is a snapshot, then the kernel wasn't able
2365 * to get the clones. Do it by slowly iterating.
2367 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2369 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2371 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2376 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2378 gca.origin = zhp->zfs_name;
2380 if (gca.numclones != 0) {
2382 char pool[ZFS_MAX_DATASET_NAME_LEN];
2385 /* get the pool name */
2386 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2387 (void) strsep(&cp, "/@");
2388 root = zfs_open(zhp->zfs_hdl, pool,
2389 ZFS_TYPE_FILESYSTEM);
2396 (void) get_clones_cb(root, &gca);
2399 if (gca.numclones != 0 ||
2400 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2401 nvlist_add_nvlist(zhp->zfs_props,
2402 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2409 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2410 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2413 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2419 * Retrieve a property from the given object. If 'literal' is specified, then
2420 * numbers are left as exact values. Otherwise, numbers are converted to a
2421 * human-readable form.
2423 * Returns 0 on success, or -1 on error.
2426 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2427 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2429 char *source = NULL;
2433 boolean_t received = zfs_is_recvd_props_mode(zhp);
2436 * Check to see if this property applies to our object
2438 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE))
2441 if (received && zfs_prop_readonly(prop))
2445 *src = ZPROP_SRC_NONE;
2448 case ZFS_PROP_CREATION:
2450 * 'creation' is a time_t stored in the statistics. We convert
2451 * this into a string unless 'literal' is specified.
2454 val = getprop_uint64(zhp, prop, &source);
2455 time_t time = (time_t)val;
2459 localtime_r(&time, &t) == NULL ||
2460 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2462 (void) snprintf(propbuf, proplen, "%llu",
2467 case ZFS_PROP_MOUNTPOINT:
2469 * Getting the precise mountpoint can be tricky.
2471 * - for 'none' or 'legacy', return those values.
2472 * - for inherited mountpoints, we want to take everything
2473 * after our ancestor and append it to the inherited value.
2475 * If the pool has an alternate root, we want to prepend that
2476 * root to any values we return.
2479 str = getprop_string(zhp, prop, &source);
2481 if (str[0] == '/') {
2482 char buf[MAXPATHLEN];
2484 const char *relpath;
2487 * If we inherit the mountpoint, even from a dataset
2488 * with a received value, the source will be the path of
2489 * the dataset we inherit from. If source is
2490 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2493 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2496 relpath = zhp->zfs_name + strlen(source);
2497 if (relpath[0] == '/')
2501 if ((zpool_get_prop(zhp->zpool_hdl,
2502 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2503 B_FALSE)) || (strcmp(root, "-") == 0))
2506 * Special case an alternate root of '/'. This will
2507 * avoid having multiple leading slashes in the
2510 if (strcmp(root, "/") == 0)
2514 * If the mountpoint is '/' then skip over this
2515 * if we are obtaining either an alternate root or
2516 * an inherited mountpoint.
2518 if (str[1] == '\0' && (root[0] != '\0' ||
2519 relpath[0] != '\0'))
2522 if (relpath[0] == '\0')
2523 (void) snprintf(propbuf, proplen, "%s%s",
2526 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2527 root, str, relpath[0] == '@' ? "" : "/",
2530 /* 'legacy' or 'none' */
2531 (void) strlcpy(propbuf, str, proplen);
2536 case ZFS_PROP_ORIGIN:
2537 str = getprop_string(zhp, prop, &source);
2540 (void) strlcpy(propbuf, str, proplen);
2543 case ZFS_PROP_CLONES:
2544 if (get_clones_string(zhp, propbuf, proplen) != 0)
2548 case ZFS_PROP_QUOTA:
2549 case ZFS_PROP_REFQUOTA:
2550 case ZFS_PROP_RESERVATION:
2551 case ZFS_PROP_REFRESERVATION:
2553 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2557 * If quota or reservation is 0, we translate this into 'none'
2558 * (unless literal is set), and indicate that it's the default
2559 * value. Otherwise, we print the number nicely and indicate
2560 * that its set locally.
2564 (void) strlcpy(propbuf, "0", proplen);
2566 (void) strlcpy(propbuf, "none", proplen);
2569 (void) snprintf(propbuf, proplen, "%llu",
2572 zfs_nicebytes(val, propbuf, proplen);
2576 case ZFS_PROP_FILESYSTEM_LIMIT:
2577 case ZFS_PROP_SNAPSHOT_LIMIT:
2578 case ZFS_PROP_FILESYSTEM_COUNT:
2579 case ZFS_PROP_SNAPSHOT_COUNT:
2581 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2585 * If limit is UINT64_MAX, we translate this into 'none' (unless
2586 * literal is set), and indicate that it's the default value.
2587 * Otherwise, we print the number nicely and indicate that it's
2591 (void) snprintf(propbuf, proplen, "%llu",
2593 } else if (val == UINT64_MAX) {
2594 (void) strlcpy(propbuf, "none", proplen);
2596 zfs_nicenum(val, propbuf, proplen);
2600 case ZFS_PROP_REFRATIO:
2601 case ZFS_PROP_COMPRESSRATIO:
2602 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2604 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2605 (u_longlong_t)(val / 100),
2606 (u_longlong_t)(val % 100));
2610 switch (zhp->zfs_type) {
2611 case ZFS_TYPE_FILESYSTEM:
2614 case ZFS_TYPE_VOLUME:
2617 case ZFS_TYPE_SNAPSHOT:
2620 case ZFS_TYPE_BOOKMARK:
2626 (void) snprintf(propbuf, proplen, "%s", str);
2629 case ZFS_PROP_MOUNTED:
2631 * The 'mounted' property is a pseudo-property that described
2632 * whether the filesystem is currently mounted. Even though
2633 * it's a boolean value, the typical values of "on" and "off"
2634 * don't make sense, so we translate to "yes" and "no".
2636 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2637 src, &source, &val) != 0)
2640 (void) strlcpy(propbuf, "yes", proplen);
2642 (void) strlcpy(propbuf, "no", proplen);
2647 * The 'name' property is a pseudo-property derived from the
2648 * dataset name. It is presented as a real property to simplify
2651 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2654 case ZFS_PROP_MLSLABEL:
2656 #ifdef HAVE_MLSLABEL
2657 m_label_t *new_sl = NULL;
2658 char *ascii = NULL; /* human readable label */
2660 (void) strlcpy(propbuf,
2661 getprop_string(zhp, prop, &source), proplen);
2663 if (literal || (strcasecmp(propbuf,
2664 ZFS_MLSLABEL_DEFAULT) == 0))
2668 * Try to translate the internal hex string to
2669 * human-readable output. If there are any
2670 * problems just use the hex string.
2673 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2674 L_NO_CORRECTION, NULL) == -1) {
2675 m_label_free(new_sl);
2679 if (label_to_str(new_sl, &ascii, M_LABEL,
2683 m_label_free(new_sl);
2686 m_label_free(new_sl);
2688 (void) strlcpy(propbuf, ascii, proplen);
2691 (void) strlcpy(propbuf,
2692 getprop_string(zhp, prop, &source), proplen);
2693 #endif /* HAVE_MLSLABEL */
2698 case ZFS_PROP_CREATETXG:
2700 * GUIDs are stored as numbers, but they are identifiers.
2701 * We don't want them to be pretty printed, because pretty
2702 * printing mangles the ID into a truncated and useless value.
2704 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2706 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2709 case ZFS_PROP_REFERENCED:
2710 case ZFS_PROP_AVAILABLE:
2712 case ZFS_PROP_USEDSNAP:
2713 case ZFS_PROP_USEDDS:
2714 case ZFS_PROP_USEDREFRESERV:
2715 case ZFS_PROP_USEDCHILD:
2716 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2719 (void) snprintf(propbuf, proplen, "%llu",
2722 zfs_nicebytes(val, propbuf, proplen);
2726 switch (zfs_prop_get_type(prop)) {
2727 case PROP_TYPE_NUMBER:
2728 if (get_numeric_property(zhp, prop, src,
2729 &source, &val) != 0)
2732 (void) snprintf(propbuf, proplen, "%llu",
2735 zfs_nicenum(val, propbuf, proplen);
2738 case PROP_TYPE_STRING:
2739 str = getprop_string(zhp, prop, &source);
2742 (void) strlcpy(propbuf, str, proplen);
2745 case PROP_TYPE_INDEX:
2746 if (get_numeric_property(zhp, prop, src,
2747 &source, &val) != 0)
2749 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2751 (void) strlcpy(propbuf, strval, proplen);
2759 get_source(zhp, src, source, statbuf, statlen);
2765 * Utility function to get the given numeric property. Does no validation that
2766 * the given property is the appropriate type; should only be used with
2767 * hard-coded property types.
2770 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2775 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2781 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2785 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2786 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2790 * Similar to zfs_prop_get(), but returns the value as an integer.
2793 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2794 zprop_source_t *src, char *statbuf, size_t statlen)
2799 * Check to see if this property applies to our object
2801 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE)) {
2802 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2803 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2804 zfs_prop_to_name(prop)));
2808 *src = ZPROP_SRC_NONE;
2810 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2813 get_source(zhp, src, source, statbuf, statlen);
2820 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2821 char **domainp, idmap_rid_t *ridp)
2823 idmap_get_handle_t *get_hdl = NULL;
2827 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2831 err = idmap_get_sidbyuid(get_hdl, id,
2832 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2834 err = idmap_get_sidbygid(get_hdl, id,
2835 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2837 if (err == IDMAP_SUCCESS &&
2838 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2839 status == IDMAP_SUCCESS)
2845 idmap_get_destroy(get_hdl);
2848 #endif /* HAVE_IDMAP */
2851 * convert the propname into parameters needed by kernel
2852 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2853 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2854 * Eg: groupquota@staff -> ZFS_PROP_GROUPQUOTA, "", 1234
2855 * Eg: groupused@staff -> ZFS_PROP_GROUPUSED, "", 1234
2858 userquota_propname_decode(const char *propname, boolean_t zoned,
2859 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2861 zfs_userquota_prop_t type;
2870 /* Figure out the property type ({user|group}{quota|space}) */
2871 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2872 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2873 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2876 if (type == ZFS_NUM_USERQUOTA_PROPS)
2880 isuser = (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_USERUSED ||
2881 type == ZFS_PROP_USEROBJQUOTA ||
2882 type == ZFS_PROP_USEROBJUSED);
2883 isgroup = (type == ZFS_PROP_GROUPQUOTA || type == ZFS_PROP_GROUPUSED ||
2884 type == ZFS_PROP_GROUPOBJQUOTA ||
2885 type == ZFS_PROP_GROUPOBJUSED);
2887 cp = strchr(propname, '@') + 1;
2889 if (isuser && (pw = getpwnam(cp)) != NULL) {
2890 if (zoned && getzoneid() == GLOBAL_ZONEID)
2893 } else if (isgroup && (gr = getgrnam(cp)) != NULL) {
2894 if (zoned && getzoneid() == GLOBAL_ZONEID)
2897 } else if (strchr(cp, '@')) {
2900 * It's a SID name (eg "user@domain") that needs to be
2901 * turned into S-1-domainID-RID.
2903 directory_error_t e;
2904 char *numericsid = NULL;
2907 if (zoned && getzoneid() == GLOBAL_ZONEID)
2910 e = directory_sid_from_user_name(NULL,
2913 e = directory_sid_from_group_name(NULL,
2917 directory_error_free(e);
2920 if (numericsid == NULL)
2923 (void) strlcpy(domain, cp, domainlen);
2924 cp = strrchr(domain, '-');
2929 *ridp = strtoull(cp, &end, 10);
2932 if (errno != 0 || *end != '\0')
2936 #endif /* HAVE_IDMAP */
2938 /* It's a user/group ID (eg "12345"). */
2941 id = strtoul(cp, &end, 10);
2946 /* It's an ephemeral ID. */
2950 if (idmap_id_to_numeric_domain_rid(id, isuser,
2951 &mapdomain, &rid) != 0)
2953 (void) strlcpy(domain, mapdomain, domainlen);
2957 #endif /* HAVE_IDMAP */
2967 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2968 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2971 zfs_cmd_t zc = {"\0"};
2973 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2975 err = userquota_propname_decode(propname,
2976 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2977 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2978 zc.zc_objset_type = *typep;
2982 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2986 *propvalue = zc.zc_cookie;
2991 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2992 uint64_t *propvalue)
2994 zfs_userquota_prop_t type;
2996 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
3001 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
3002 char *propbuf, int proplen, boolean_t literal)
3006 zfs_userquota_prop_t type;
3008 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
3015 (void) snprintf(propbuf, proplen, "%llu",
3016 (u_longlong_t)propvalue);
3017 } else if (propvalue == 0 &&
3018 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA ||
3019 type == ZFS_PROP_USEROBJQUOTA || type == ZFS_PROP_GROUPOBJQUOTA)) {
3020 (void) strlcpy(propbuf, "none", proplen);
3021 } else if (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA ||
3022 type == ZFS_PROP_USERUSED || type == ZFS_PROP_GROUPUSED) {
3023 zfs_nicebytes(propvalue, propbuf, proplen);
3025 zfs_nicenum(propvalue, propbuf, proplen);
3031 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
3032 uint64_t *propvalue)
3035 zfs_cmd_t zc = {"\0"};
3036 const char *snapname;
3038 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3040 snapname = strchr(propname, '@') + 1;
3041 if (strchr(snapname, '@')) {
3042 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
3044 /* snapname is the short name, append it to zhp's fsname */
3047 (void) strlcpy(zc.zc_value, zhp->zfs_name,
3048 sizeof (zc.zc_value));
3049 cp = strchr(zc.zc_value, '@');
3052 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
3053 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
3056 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
3060 *propvalue = zc.zc_cookie;
3065 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
3066 char *propbuf, int proplen, boolean_t literal)
3071 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
3077 (void) snprintf(propbuf, proplen, "%llu",
3078 (u_longlong_t)propvalue);
3080 zfs_nicebytes(propvalue, propbuf, proplen);
3087 * Returns the name of the given zfs handle.
3090 zfs_get_name(const zfs_handle_t *zhp)
3092 return (zhp->zfs_name);
3096 * Returns the name of the parent pool for the given zfs handle.
3099 zfs_get_pool_name(const zfs_handle_t *zhp)
3101 return (zhp->zpool_hdl->zpool_name);
3105 * Returns the type of the given zfs handle.
3108 zfs_get_type(const zfs_handle_t *zhp)
3110 return (zhp->zfs_type);
3114 * Is one dataset name a child dataset of another?
3116 * Needs to handle these cases:
3117 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
3118 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
3119 * Descendant? No. No. No. Yes.
3122 is_descendant(const char *ds1, const char *ds2)
3124 size_t d1len = strlen(ds1);
3126 /* ds2 can't be a descendant if it's smaller */
3127 if (strlen(ds2) < d1len)
3130 /* otherwise, compare strings and verify that there's a '/' char */
3131 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
3135 * Given a complete name, return just the portion that refers to the parent.
3136 * Will return -1 if there is no parent (path is just the name of the
3140 parent_name(const char *path, char *buf, size_t buflen)
3144 (void) strlcpy(buf, path, buflen);
3146 if ((slashp = strrchr(buf, '/')) == NULL)
3154 * If accept_ancestor is false, then check to make sure that the given path has
3155 * a parent, and that it exists. If accept_ancestor is true, then find the
3156 * closest existing ancestor for the given path. In prefixlen return the
3157 * length of already existing prefix of the given path. We also fetch the
3158 * 'zoned' property, which is used to validate property settings when creating
3162 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
3163 boolean_t accept_ancestor, int *prefixlen)
3165 zfs_cmd_t zc = {"\0"};
3166 char parent[ZFS_MAX_DATASET_NAME_LEN];
3172 (void) snprintf(errbuf, sizeof (errbuf),
3173 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
3175 /* get parent, and check to see if this is just a pool */
3176 if (parent_name(path, parent, sizeof (parent)) != 0) {
3177 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3178 "missing dataset name"));
3179 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3182 /* check to see if the pool exists */
3183 if ((slash = strchr(parent, '/')) == NULL)
3184 slash = parent + strlen(parent);
3185 (void) strncpy(zc.zc_name, parent, slash - parent);
3186 zc.zc_name[slash - parent] = '\0';
3187 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
3189 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3190 "no such pool '%s'"), zc.zc_name);
3191 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3194 /* check to see if the parent dataset exists */
3195 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
3196 if (errno == ENOENT && accept_ancestor) {
3198 * Go deeper to find an ancestor, give up on top level.
3200 if (parent_name(parent, parent, sizeof (parent)) != 0) {
3201 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3202 "no such pool '%s'"), zc.zc_name);
3203 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3205 } else if (errno == ENOENT) {
3206 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3207 "parent does not exist"));
3208 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3210 return (zfs_standard_error(hdl, errno, errbuf));
3213 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
3217 /* we are in a non-global zone, but parent is in the global zone */
3218 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
3219 (void) zfs_standard_error(hdl, EPERM, errbuf);
3224 /* make sure parent is a filesystem */
3225 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
3226 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3227 "parent is not a filesystem"));
3228 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
3234 if (prefixlen != NULL)
3235 *prefixlen = strlen(parent);
3240 * Finds whether the dataset of the given type(s) exists.
3243 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
3247 if (!zfs_validate_name(hdl, path, types, B_FALSE))
3251 * Try to get stats for the dataset, which will tell us if it exists.
3253 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
3254 int ds_type = zhp->zfs_type;
3257 if (types & ds_type)
3264 * Given a path to 'target', create all the ancestors between
3265 * the prefixlen portion of the path, and the target itself.
3266 * Fail if the initial prefixlen-ancestor does not already exist.
3269 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
3275 /* make sure prefix exists */
3276 cp = target + prefixlen;
3278 assert(strchr(cp, '/') == NULL);
3279 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3282 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3290 * Attempt to create, mount, and share any ancestor filesystems,
3291 * up to the prefixlen-long one.
3293 for (cp = target + prefixlen + 1;
3294 (cp = strchr(cp, '/')) != NULL; *cp = '/', cp++) {
3298 h = make_dataset_handle(hdl, target);
3300 /* it already exists, nothing to do here */
3305 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
3307 opname = dgettext(TEXT_DOMAIN, "create");
3311 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3313 opname = dgettext(TEXT_DOMAIN, "open");
3317 if (zfs_mount(h, NULL, 0) != 0) {
3318 opname = dgettext(TEXT_DOMAIN, "mount");
3322 if (zfs_share(h) != 0) {
3323 opname = dgettext(TEXT_DOMAIN, "share");
3333 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3334 "failed to %s ancestor '%s'"), opname, target);
3339 * Creates non-existing ancestors of the given path.
3342 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
3348 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
3351 if ((path_copy = strdup(path)) != NULL) {
3352 rc = create_parents(hdl, path_copy, prefix);
3355 if (path_copy == NULL || rc != 0)
3362 * Create a new filesystem or volume.
3365 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
3370 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
3373 enum lzc_dataset_type ost;
3374 zpool_handle_t *zpool_handle;
3376 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3377 "cannot create '%s'"), path);
3379 /* validate the path, taking care to note the extended error message */
3380 if (!zfs_validate_name(hdl, path, type, B_TRUE))
3381 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3383 /* validate parents exist */
3384 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
3388 * The failure modes when creating a dataset of a different type over
3389 * one that already exists is a little strange. In particular, if you
3390 * try to create a dataset on top of an existing dataset, the ioctl()
3391 * will return ENOENT, not EEXIST. To prevent this from happening, we
3392 * first try to see if the dataset exists.
3394 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
3395 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3396 "dataset already exists"));
3397 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3400 if (type == ZFS_TYPE_VOLUME)
3401 ost = LZC_DATSET_TYPE_ZVOL;
3403 ost = LZC_DATSET_TYPE_ZFS;
3405 /* open zpool handle for prop validation */
3406 char pool_path[ZFS_MAX_DATASET_NAME_LEN];
3407 (void) strlcpy(pool_path, path, sizeof (pool_path));
3409 /* truncate pool_path at first slash */
3410 char *p = strchr(pool_path, '/');
3414 if ((zpool_handle = zpool_open(hdl, pool_path)) == NULL)
3417 if (props && (props = zfs_valid_proplist(hdl, type, props,
3418 zoned, NULL, zpool_handle, errbuf)) == 0) {
3419 zpool_close(zpool_handle);
3422 zpool_close(zpool_handle);
3424 if (type == ZFS_TYPE_VOLUME) {
3426 * If we are creating a volume, the size and block size must
3427 * satisfy a few restraints. First, the blocksize must be a
3428 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3429 * volsize must be a multiple of the block size, and cannot be
3432 if (props == NULL || nvlist_lookup_uint64(props,
3433 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3435 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3436 "missing volume size"));
3437 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3440 if ((ret = nvlist_lookup_uint64(props,
3441 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3442 &blocksize)) != 0) {
3443 if (ret == ENOENT) {
3444 blocksize = zfs_prop_default_numeric(
3445 ZFS_PROP_VOLBLOCKSIZE);
3448 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3449 "missing volume block size"));
3450 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3456 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3457 "volume size cannot be zero"));
3458 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3461 if (size % blocksize != 0) {
3463 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3464 "volume size must be a multiple of volume block "
3466 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3470 /* create the dataset */
3471 ret = lzc_create(path, ost, props);
3474 /* check for failure */
3476 char parent[ZFS_MAX_DATASET_NAME_LEN];
3477 (void) parent_name(path, parent, sizeof (parent));
3481 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3482 "no such parent '%s'"), parent);
3483 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3486 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3487 "parent '%s' is not a filesystem"), parent);
3488 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3491 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3492 "pool must be upgraded to set this "
3493 "property or value"));
3494 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3498 * This platform can't address a volume this big.
3500 if (type == ZFS_TYPE_VOLUME)
3501 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3506 return (zfs_standard_error(hdl, errno, errbuf));
3514 * Destroys the given dataset. The caller must make sure that the filesystem
3515 * isn't mounted, and that there are no active dependents. If the file system
3516 * does not exist this function does nothing.
3519 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3521 zfs_cmd_t zc = {"\0"};
3523 if (zhp->zfs_type == ZFS_TYPE_BOOKMARK) {
3524 nvlist_t *nv = fnvlist_alloc();
3525 fnvlist_add_boolean(nv, zhp->zfs_name);
3526 int error = lzc_destroy_bookmarks(nv, NULL);
3529 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3530 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3536 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3538 if (ZFS_IS_VOLUME(zhp)) {
3539 zc.zc_objset_type = DMU_OST_ZVOL;
3541 zc.zc_objset_type = DMU_OST_ZFS;
3544 zc.zc_defer_destroy = defer;
3545 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0 &&
3547 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3548 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3552 remove_mountpoint(zhp);
3557 struct destroydata {
3559 const char *snapname;
3563 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3565 struct destroydata *dd = arg;
3566 char name[ZFS_MAX_DATASET_NAME_LEN];
3569 if (snprintf(name, sizeof (name), "%s@%s", zhp->zfs_name,
3570 dd->snapname) >= sizeof (name))
3573 if (lzc_exists(name))
3574 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3576 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3582 * Destroys all snapshots with the given name in zhp & descendants.
3585 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3588 struct destroydata dd = { 0 };
3590 dd.snapname = snapname;
3591 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3592 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3594 if (nvlist_empty(dd.nvl)) {
3595 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3596 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3597 zhp->zfs_name, snapname);
3599 ret = zfs_destroy_snaps_nvl(zhp->zfs_hdl, dd.nvl, defer);
3601 nvlist_free(dd.nvl);
3606 * Destroys all the snapshots named in the nvlist.
3609 zfs_destroy_snaps_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, boolean_t defer)
3612 nvlist_t *errlist = NULL;
3615 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3618 nvlist_free(errlist);
3622 if (nvlist_empty(errlist)) {
3624 (void) snprintf(errbuf, sizeof (errbuf),
3625 dgettext(TEXT_DOMAIN, "cannot destroy snapshots"));
3627 ret = zfs_standard_error(hdl, ret, errbuf);
3629 for (pair = nvlist_next_nvpair(errlist, NULL);
3630 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3632 (void) snprintf(errbuf, sizeof (errbuf),
3633 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3636 switch (fnvpair_value_int32(pair)) {
3639 dgettext(TEXT_DOMAIN, "snapshot is cloned"));
3640 ret = zfs_error(hdl, EZFS_EXISTS, errbuf);
3643 ret = zfs_standard_error(hdl, errno, errbuf);
3648 nvlist_free(errlist);
3653 * Clones the given dataset. The target must be of the same type as the source.
3656 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3658 char parent[ZFS_MAX_DATASET_NAME_LEN];
3661 libzfs_handle_t *hdl = zhp->zfs_hdl;
3664 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3666 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3667 "cannot create '%s'"), target);
3669 /* validate the target/clone name */
3670 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3671 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3673 /* validate parents exist */
3674 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3677 (void) parent_name(target, parent, sizeof (parent));
3683 if (ZFS_IS_VOLUME(zhp)) {
3684 type = ZFS_TYPE_VOLUME;
3686 type = ZFS_TYPE_FILESYSTEM;
3688 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3689 zhp, zhp->zpool_hdl, errbuf)) == NULL)
3693 ret = lzc_clone(target, zhp->zfs_name, props);
3701 * The parent doesn't exist. We should have caught this
3702 * above, but there may a race condition that has since
3703 * destroyed the parent.
3705 * At this point, we don't know whether it's the source
3706 * that doesn't exist anymore, or whether the target
3707 * dataset doesn't exist.
3709 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3710 "no such parent '%s'"), parent);
3711 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3714 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3715 "source and target pools differ"));
3716 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3720 return (zfs_standard_error(zhp->zfs_hdl, errno,
3729 * Promotes the given clone fs to be the clone parent.
3732 zfs_promote(zfs_handle_t *zhp)
3734 libzfs_handle_t *hdl = zhp->zfs_hdl;
3735 char snapname[ZFS_MAX_DATASET_NAME_LEN];
3739 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3740 "cannot promote '%s'"), zhp->zfs_name);
3742 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3743 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3744 "snapshots can not be promoted"));
3745 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3748 if (zhp->zfs_dmustats.dds_origin[0] == '\0') {
3749 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3750 "not a cloned filesystem"));
3751 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3754 ret = lzc_promote(zhp->zfs_name, snapname, sizeof (snapname));
3759 /* There is a conflicting snapshot name. */
3760 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3761 "conflicting snapshot '%s' from parent '%s'"),
3762 snapname, zhp->zfs_dmustats.dds_origin);
3763 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3766 return (zfs_standard_error(hdl, ret, errbuf));
3772 typedef struct snapdata {
3774 const char *sd_snapname;
3778 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
3780 snapdata_t *sd = arg;
3781 char name[ZFS_MAX_DATASET_NAME_LEN];
3784 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) == 0) {
3785 if (snprintf(name, sizeof (name), "%s@%s", zfs_get_name(zhp),
3786 sd->sd_snapname) >= sizeof (name))
3789 fnvlist_add_boolean(sd->sd_nvl, name);
3791 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
3799 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3803 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
3809 zpool_handle_t *zpool_hdl;
3810 char pool[ZFS_MAX_DATASET_NAME_LEN];
3812 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3813 "cannot create snapshots "));
3816 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
3817 const char *snapname = nvpair_name(elem);
3819 /* validate the target name */
3820 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
3822 (void) snprintf(errbuf, sizeof (errbuf),
3823 dgettext(TEXT_DOMAIN,
3824 "cannot create snapshot '%s'"), snapname);
3825 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3830 * get pool handle for prop validation. assumes all snaps are in the
3831 * same pool, as does lzc_snapshot (below).
3833 elem = nvlist_next_nvpair(snaps, NULL);
3834 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
3835 pool[strcspn(pool, "/@")] = '\0';
3836 zpool_hdl = zpool_open(hdl, pool);
3837 if (zpool_hdl == NULL)
3840 if (props != NULL &&
3841 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3842 props, B_FALSE, NULL, zpool_hdl, errbuf)) == NULL) {
3843 zpool_close(zpool_hdl);
3846 zpool_close(zpool_hdl);
3848 ret = lzc_snapshot(snaps, props, &errors);
3851 boolean_t printed = B_FALSE;
3852 for (elem = nvlist_next_nvpair(errors, NULL);
3854 elem = nvlist_next_nvpair(errors, elem)) {
3855 (void) snprintf(errbuf, sizeof (errbuf),
3856 dgettext(TEXT_DOMAIN,
3857 "cannot create snapshot '%s'"), nvpair_name(elem));
3858 (void) zfs_standard_error(hdl,
3859 fnvpair_value_int32(elem), errbuf);
3865 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3866 "multiple snapshots of same "
3868 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3872 (void) zfs_standard_error(hdl, ret, errbuf);
3878 nvlist_free(errors);
3883 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3887 snapdata_t sd = { 0 };
3888 char fsname[ZFS_MAX_DATASET_NAME_LEN];
3893 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3894 "cannot snapshot %s"), path);
3896 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3897 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3899 (void) strlcpy(fsname, path, sizeof (fsname));
3900 cp = strchr(fsname, '@');
3902 sd.sd_snapname = cp + 1;
3904 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
3905 ZFS_TYPE_VOLUME)) == NULL) {
3909 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
3911 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
3913 fnvlist_add_boolean(sd.sd_nvl, path);
3916 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
3917 nvlist_free(sd.sd_nvl);
3923 * Destroy any more recent snapshots. We invoke this callback on any dependents
3924 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3925 * is a dependent and we should just destroy it without checking the transaction
3928 typedef struct rollback_data {
3929 const char *cb_target; /* the snapshot */
3930 uint64_t cb_create; /* creation time reference */
3936 rollback_destroy_dependent(zfs_handle_t *zhp, void *data)
3938 rollback_data_t *cbp = data;
3939 prop_changelist_t *clp;
3941 /* We must destroy this clone; first unmount it */
3942 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3943 cbp->cb_force ? MS_FORCE: 0);
3944 if (clp == NULL || changelist_prefix(clp) != 0) {
3945 cbp->cb_error = B_TRUE;
3949 if (zfs_destroy(zhp, B_FALSE) != 0)
3950 cbp->cb_error = B_TRUE;
3952 changelist_remove(clp, zhp->zfs_name);
3953 (void) changelist_postfix(clp);
3954 changelist_free(clp);
3961 rollback_destroy(zfs_handle_t *zhp, void *data)
3963 rollback_data_t *cbp = data;
3965 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > cbp->cb_create) {
3966 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3967 rollback_destroy_dependent, cbp);
3969 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3977 * Given a dataset, rollback to a specific snapshot, discarding any
3978 * data changes since then and making it the active dataset.
3980 * Any snapshots and bookmarks more recent than the target are
3981 * destroyed, along with their dependents (i.e. clones).
3984 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3986 rollback_data_t cb = { 0 };
3988 boolean_t restore_resv = 0;
3989 uint64_t old_volsize = 0, new_volsize;
3990 zfs_prop_t resv_prop = { 0 };
3992 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3993 zhp->zfs_type == ZFS_TYPE_VOLUME);
3996 * Destroy all recent snapshots and their dependents.
3998 cb.cb_force = force;
3999 cb.cb_target = snap->zfs_name;
4000 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
4001 (void) zfs_iter_snapshots(zhp, B_FALSE, rollback_destroy, &cb);
4002 (void) zfs_iter_bookmarks(zhp, rollback_destroy, &cb);
4008 * Now that we have verified that the snapshot is the latest,
4009 * rollback to the given snapshot.
4012 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
4013 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
4015 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
4017 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
4021 * We rely on zfs_iter_children() to verify that there are no
4022 * newer snapshots for the given dataset. Therefore, we can
4023 * simply pass the name on to the ioctl() call. There is still
4024 * an unlikely race condition where the user has taken a
4025 * snapshot since we verified that this was the most recent.
4027 err = lzc_rollback(zhp->zfs_name, NULL, 0);
4029 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
4030 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
4036 * For volumes, if the pre-rollback volsize matched the pre-
4037 * rollback reservation and the volsize has changed then set
4038 * the reservation property to the post-rollback volsize.
4039 * Make a new handle since the rollback closed the dataset.
4041 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
4042 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
4044 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
4045 if (old_volsize != new_volsize)
4046 err = zfs_prop_set_int(zhp, resv_prop,
4055 * Renames the given dataset.
4058 zfs_rename(zfs_handle_t *zhp, const char *target, boolean_t recursive,
4059 boolean_t force_unmount)
4062 zfs_cmd_t zc = {"\0"};
4064 prop_changelist_t *cl = NULL;
4065 zfs_handle_t *zhrp = NULL;
4066 char *parentname = NULL;
4067 char parent[ZFS_MAX_DATASET_NAME_LEN];
4068 libzfs_handle_t *hdl = zhp->zfs_hdl;
4071 /* if we have the same exact name, just return success */
4072 if (strcmp(zhp->zfs_name, target) == 0)
4075 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4076 "cannot rename to '%s'"), target);
4079 * Make sure the target name is valid
4081 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
4082 if ((strchr(target, '@') == NULL) ||
4085 * Snapshot target name is abbreviated,
4086 * reconstruct full dataset name
4088 (void) strlcpy(parent, zhp->zfs_name,
4090 delim = strchr(parent, '@');
4091 if (strchr(target, '@') == NULL)
4095 (void) strlcat(parent, target, sizeof (parent));
4099 * Make sure we're renaming within the same dataset.
4101 delim = strchr(target, '@');
4102 if (strncmp(zhp->zfs_name, target, delim - target)
4103 != 0 || zhp->zfs_name[delim - target] != '@') {
4104 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4105 "snapshots must be part of same "
4107 return (zfs_error(hdl, EZFS_CROSSTARGET,
4111 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
4112 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4115 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4116 "recursive rename must be a snapshot"));
4117 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4120 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
4121 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4123 /* validate parents */
4124 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
4127 /* make sure we're in the same pool */
4128 verify((delim = strchr(target, '/')) != NULL);
4129 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
4130 zhp->zfs_name[delim - target] != '/') {
4131 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4132 "datasets must be within same pool"));
4133 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
4136 /* new name cannot be a child of the current dataset name */
4137 if (is_descendant(zhp->zfs_name, target)) {
4138 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4139 "New dataset name cannot be a descendant of "
4140 "current dataset name"));
4141 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4145 (void) snprintf(errbuf, sizeof (errbuf),
4146 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
4148 if (getzoneid() == GLOBAL_ZONEID &&
4149 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
4150 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4151 "dataset is used in a non-global zone"));
4152 return (zfs_error(hdl, EZFS_ZONED, errbuf));
4156 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
4157 if (parentname == NULL) {
4161 delim = strchr(parentname, '@');
4163 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
4168 } else if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT) {
4169 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0,
4170 force_unmount ? MS_FORCE : 0)) == NULL)
4173 if (changelist_haszonedchild(cl)) {
4174 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4175 "child dataset with inherited mountpoint is used "
4176 "in a non-global zone"));
4177 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
4182 if ((ret = changelist_prefix(cl)) != 0)
4186 if (ZFS_IS_VOLUME(zhp))
4187 zc.zc_objset_type = DMU_OST_ZVOL;
4189 zc.zc_objset_type = DMU_OST_ZFS;
4191 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4192 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
4194 zc.zc_cookie = recursive;
4196 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
4198 * if it was recursive, the one that actually failed will
4201 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4202 "cannot rename '%s'"), zc.zc_name);
4204 if (recursive && errno == EEXIST) {
4205 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4206 "a child dataset already has a snapshot "
4207 "with the new name"));
4208 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
4210 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
4214 * On failure, we still want to remount any filesystems that
4215 * were previously mounted, so we don't alter the system state.
4218 (void) changelist_postfix(cl);
4221 changelist_rename(cl, zfs_get_name(zhp), target);
4222 ret = changelist_postfix(cl);
4227 if (parentname != NULL) {
4234 changelist_free(cl);
4240 zfs_get_user_props(zfs_handle_t *zhp)
4242 return (zhp->zfs_user_props);
4246 * This function is used by 'zfs list' to determine the exact set of columns to
4247 * display, and their maximum widths. This does two main things:
4249 * - If this is a list of all properties, then expand the list to include
4250 * all native properties, and set a flag so that for each dataset we look
4251 * for new unique user properties and add them to the list.
4253 * - For non fixed-width properties, keep track of the maximum width seen
4254 * so that we can size the column appropriately. If the user has
4255 * requested received property values, we also need to compute the width
4256 * of the RECEIVED column.
4259 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received,
4262 libzfs_handle_t *hdl = zhp->zfs_hdl;
4263 zprop_list_t *entry;
4264 zprop_list_t **last, **start;
4265 nvlist_t *userprops, *propval;
4268 char buf[ZFS_MAXPROPLEN];
4270 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
4273 userprops = zfs_get_user_props(zhp);
4276 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
4278 * Go through and add any user properties as necessary. We
4279 * start by incrementing our list pointer to the first
4280 * non-native property.
4283 while (*start != NULL) {
4284 if ((*start)->pl_prop == ZPROP_INVAL)
4286 start = &(*start)->pl_next;
4290 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
4292 * See if we've already found this property in our list.
4294 for (last = start; *last != NULL;
4295 last = &(*last)->pl_next) {
4296 if (strcmp((*last)->pl_user_prop,
4297 nvpair_name(elem)) == 0)
4301 if (*last == NULL) {
4302 if ((entry = zfs_alloc(hdl,
4303 sizeof (zprop_list_t))) == NULL ||
4304 ((entry->pl_user_prop = zfs_strdup(hdl,
4305 nvpair_name(elem)))) == NULL) {
4310 entry->pl_prop = ZPROP_INVAL;
4311 entry->pl_width = strlen(nvpair_name(elem));
4312 entry->pl_all = B_TRUE;
4319 * Now go through and check the width of any non-fixed columns
4321 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
4322 if (entry->pl_fixed && !literal)
4325 if (entry->pl_prop != ZPROP_INVAL) {
4326 if (zfs_prop_get(zhp, entry->pl_prop,
4327 buf, sizeof (buf), NULL, NULL, 0, literal) == 0) {
4328 if (strlen(buf) > entry->pl_width)
4329 entry->pl_width = strlen(buf);
4331 if (received && zfs_prop_get_recvd(zhp,
4332 zfs_prop_to_name(entry->pl_prop),
4333 buf, sizeof (buf), literal) == 0)
4334 if (strlen(buf) > entry->pl_recvd_width)
4335 entry->pl_recvd_width = strlen(buf);
4337 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
4339 verify(nvlist_lookup_string(propval,
4340 ZPROP_VALUE, &strval) == 0);
4341 if (strlen(strval) > entry->pl_width)
4342 entry->pl_width = strlen(strval);
4344 if (received && zfs_prop_get_recvd(zhp,
4345 entry->pl_user_prop,
4346 buf, sizeof (buf), literal) == 0)
4347 if (strlen(buf) > entry->pl_recvd_width)
4348 entry->pl_recvd_width = strlen(buf);
4356 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
4362 * Keep a reference to the props-table against which we prune the
4365 zhp->zfs_props_table = props;
4367 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
4370 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
4371 next = nvlist_next_nvpair(zhp->zfs_props, curr);
4374 * User properties will result in ZPROP_INVAL, and since we
4375 * only know how to prune standard ZFS properties, we always
4376 * leave these in the list. This can also happen if we
4377 * encounter an unknown DSL property (when running older
4378 * software, for example).
4380 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
4381 (void) nvlist_remove(zhp->zfs_props,
4382 nvpair_name(curr), nvpair_type(curr));
4388 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
4389 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
4391 zfs_cmd_t zc = {"\0"};
4392 nvlist_t *nvlist = NULL;
4395 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4396 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4397 zc.zc_cookie = (uint64_t)cmd;
4399 if (cmd == ZFS_SMB_ACL_RENAME) {
4400 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
4401 (void) no_memory(hdl);
4407 case ZFS_SMB_ACL_ADD:
4408 case ZFS_SMB_ACL_REMOVE:
4409 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4411 case ZFS_SMB_ACL_RENAME:
4412 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4414 (void) no_memory(hdl);
4417 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4419 (void) no_memory(hdl);
4422 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4423 nvlist_free(nvlist);
4427 case ZFS_SMB_ACL_PURGE:
4432 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4433 nvlist_free(nvlist);
4438 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4439 char *path, char *resource)
4441 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4446 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4447 char *path, char *resource)
4449 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4454 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4456 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4461 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4462 char *oldname, char *newname)
4464 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4469 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4470 zfs_userspace_cb_t func, void *arg)
4472 zfs_cmd_t zc = {"\0"};
4473 zfs_useracct_t buf[100];
4474 libzfs_handle_t *hdl = zhp->zfs_hdl;
4477 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4479 zc.zc_objset_type = type;
4480 zc.zc_nvlist_dst = (uintptr_t)buf;
4483 zfs_useracct_t *zua = buf;
4485 zc.zc_nvlist_dst_size = sizeof (buf);
4486 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4489 if ((errno == ENOTSUP &&
4490 (type == ZFS_PROP_USEROBJUSED ||
4491 type == ZFS_PROP_GROUPOBJUSED ||
4492 type == ZFS_PROP_USEROBJQUOTA ||
4493 type == ZFS_PROP_GROUPOBJQUOTA)))
4496 (void) snprintf(errbuf, sizeof (errbuf),
4497 dgettext(TEXT_DOMAIN,
4498 "cannot get used/quota for %s"), zc.zc_name);
4499 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4501 if (zc.zc_nvlist_dst_size == 0)
4504 while (zc.zc_nvlist_dst_size > 0) {
4505 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4506 zua->zu_space)) != 0)
4509 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4518 const char *snapname;
4520 boolean_t recursive;
4525 zfs_hold_one(zfs_handle_t *zhp, void *arg)
4527 struct holdarg *ha = arg;
4528 char name[ZFS_MAX_DATASET_NAME_LEN];
4531 if (snprintf(name, sizeof (name), "%s@%s", zhp->zfs_name,
4532 ha->snapname) >= sizeof (name))
4535 if (lzc_exists(name))
4536 fnvlist_add_string(ha->nvl, name, ha->tag);
4539 rv = zfs_iter_filesystems(zhp, zfs_hold_one, ha);
4545 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4546 boolean_t recursive, int cleanup_fd)
4551 ha.nvl = fnvlist_alloc();
4552 ha.snapname = snapname;
4554 ha.recursive = recursive;
4555 (void) zfs_hold_one(zfs_handle_dup(zhp), &ha);
4557 if (nvlist_empty(ha.nvl)) {
4560 fnvlist_free(ha.nvl);
4562 (void) snprintf(errbuf, sizeof (errbuf),
4563 dgettext(TEXT_DOMAIN,
4564 "cannot hold snapshot '%s@%s'"),
4565 zhp->zfs_name, snapname);
4566 (void) zfs_standard_error(zhp->zfs_hdl, ret, errbuf);
4570 ret = zfs_hold_nvl(zhp, cleanup_fd, ha.nvl);
4571 fnvlist_free(ha.nvl);
4577 zfs_hold_nvl(zfs_handle_t *zhp, int cleanup_fd, nvlist_t *holds)
4581 libzfs_handle_t *hdl = zhp->zfs_hdl;
4586 ret = lzc_hold(holds, cleanup_fd, &errors);
4589 /* There may be errors even in the success case. */
4590 fnvlist_free(errors);
4594 if (nvlist_empty(errors)) {
4595 /* no hold-specific errors */
4596 (void) snprintf(errbuf, sizeof (errbuf),
4597 dgettext(TEXT_DOMAIN, "cannot hold"));
4600 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4601 "pool must be upgraded"));
4602 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4605 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4608 (void) zfs_standard_error(hdl, ret, errbuf);
4612 for (elem = nvlist_next_nvpair(errors, NULL);
4614 elem = nvlist_next_nvpair(errors, elem)) {
4615 (void) snprintf(errbuf, sizeof (errbuf),
4616 dgettext(TEXT_DOMAIN,
4617 "cannot hold snapshot '%s'"), nvpair_name(elem));
4618 switch (fnvpair_value_int32(elem)) {
4621 * Temporary tags wind up having the ds object id
4622 * prepended. So even if we passed the length check
4623 * above, it's still possible for the tag to wind
4624 * up being slightly too long.
4626 (void) zfs_error(hdl, EZFS_TAGTOOLONG, errbuf);
4629 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4632 (void) zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf);
4635 (void) zfs_standard_error(hdl,
4636 fnvpair_value_int32(elem), errbuf);
4640 fnvlist_free(errors);
4645 zfs_release_one(zfs_handle_t *zhp, void *arg)
4647 struct holdarg *ha = arg;
4648 char name[ZFS_MAX_DATASET_NAME_LEN];
4650 nvlist_t *existing_holds;
4652 if (snprintf(name, sizeof (name), "%s@%s", zhp->zfs_name,
4653 ha->snapname) >= sizeof (name)) {
4658 if (lzc_get_holds(name, &existing_holds) != 0) {
4660 } else if (!nvlist_exists(existing_holds, ha->tag)) {
4663 nvlist_t *torelease = fnvlist_alloc();
4664 fnvlist_add_boolean(torelease, ha->tag);
4665 fnvlist_add_nvlist(ha->nvl, name, torelease);
4666 fnvlist_free(torelease);
4670 rv = zfs_iter_filesystems(zhp, zfs_release_one, ha);
4676 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4677 boolean_t recursive)
4681 nvlist_t *errors = NULL;
4683 libzfs_handle_t *hdl = zhp->zfs_hdl;
4686 ha.nvl = fnvlist_alloc();
4687 ha.snapname = snapname;
4689 ha.recursive = recursive;
4691 (void) zfs_release_one(zfs_handle_dup(zhp), &ha);
4693 if (nvlist_empty(ha.nvl)) {
4694 fnvlist_free(ha.nvl);
4696 (void) snprintf(errbuf, sizeof (errbuf),
4697 dgettext(TEXT_DOMAIN,
4698 "cannot release hold from snapshot '%s@%s'"),
4699 zhp->zfs_name, snapname);
4701 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4703 (void) zfs_standard_error(hdl, ret, errbuf);
4708 ret = lzc_release(ha.nvl, &errors);
4709 fnvlist_free(ha.nvl);
4712 /* There may be errors even in the success case. */
4713 fnvlist_free(errors);
4717 if (nvlist_empty(errors)) {
4718 /* no hold-specific errors */
4719 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4723 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4724 "pool must be upgraded"));
4725 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4728 (void) zfs_standard_error_fmt(hdl, errno, errbuf);
4732 for (elem = nvlist_next_nvpair(errors, NULL);
4734 elem = nvlist_next_nvpair(errors, elem)) {
4735 (void) snprintf(errbuf, sizeof (errbuf),
4736 dgettext(TEXT_DOMAIN,
4737 "cannot release hold from snapshot '%s'"),
4739 switch (fnvpair_value_int32(elem)) {
4741 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4744 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4747 (void) zfs_standard_error_fmt(hdl,
4748 fnvpair_value_int32(elem), errbuf);
4752 fnvlist_free(errors);
4757 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4759 zfs_cmd_t zc = {"\0"};
4760 libzfs_handle_t *hdl = zhp->zfs_hdl;
4766 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4767 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4771 nvbuf = malloc(nvsz);
4772 if (nvbuf == NULL) {
4773 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4777 zc.zc_nvlist_dst_size = nvsz;
4778 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4780 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4782 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4783 (void) snprintf(errbuf, sizeof (errbuf),
4784 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4789 nvsz = zc.zc_nvlist_dst_size;
4793 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4794 "pool must be upgraded"));
4795 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4798 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4801 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4804 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4809 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4811 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4812 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4814 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4824 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4826 zfs_cmd_t zc = {"\0"};
4827 libzfs_handle_t *hdl = zhp->zfs_hdl;
4833 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4834 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4836 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
4839 nvbuf = malloc(nvsz);
4841 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
4844 zc.zc_nvlist_src_size = nvsz;
4845 zc.zc_nvlist_src = (uintptr_t)nvbuf;
4846 zc.zc_perm_action = un;
4848 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4850 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
4851 (void) snprintf(errbuf, sizeof (errbuf),
4852 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
4856 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4857 "pool must be upgraded"));
4858 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4861 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4864 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4867 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4878 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
4883 err = lzc_get_holds(zhp->zfs_name, nvl);
4886 libzfs_handle_t *hdl = zhp->zfs_hdl;
4888 (void) snprintf(errbuf, sizeof (errbuf),
4889 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4893 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4894 "pool must be upgraded"));
4895 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4898 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4901 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4904 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4913 * Convert the zvol's volume size to an appropriate reservation.
4914 * Note: If this routine is updated, it is necessary to update the ZFS test
4915 * suite's shell version in reservation.kshlib.
4918 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4921 uint64_t nblocks, volblocksize;
4925 if (nvlist_lookup_string(props,
4926 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4927 ncopies = atoi(strval);
4930 if (nvlist_lookup_uint64(props,
4931 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4932 &volblocksize) != 0)
4933 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4934 nblocks = volsize/volblocksize;
4935 /* start with metadnode L0-L6 */
4937 /* calculate number of indirects */
4938 while (nblocks > 1) {
4939 nblocks += DNODES_PER_LEVEL - 1;
4940 nblocks /= DNODES_PER_LEVEL;
4943 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4946 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4947 * compressed, but in practice they compress down to about
4950 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;