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 2019 Joyent, Inc.
25 * Copyright (c) 2011, 2020 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 2017 Nexenta Systems, Inc.
31 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
32 * Copyright 2017-2018 RackTop Systems.
33 * Copyright (c) 2019 Datto Inc.
34 * Copyright (c) 2019, loli10K <ezomori.nozomu@gmail.com>
35 * Copyright (c) 2021 Matt Fiddaman
48 #include <sys/mntent.h>
49 #include <sys/mount.h>
56 #include <directory.h>
57 #endif /* HAVE_IDMAP */
59 #include <sys/dnode.h>
62 #include <sys/dsl_crypt.h>
66 #include "zfs_namecheck.h"
68 #include "libzfs_impl.h"
69 #include "zfs_deleg.h"
71 static int userquota_propname_decode(const char *propname, boolean_t zoned,
72 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
75 * Given a single type (not a mask of types), return the type in a human
79 zfs_type_to_name(zfs_type_t type)
82 case ZFS_TYPE_FILESYSTEM:
83 return (dgettext(TEXT_DOMAIN, "filesystem"));
84 case ZFS_TYPE_SNAPSHOT:
85 return (dgettext(TEXT_DOMAIN, "snapshot"));
87 return (dgettext(TEXT_DOMAIN, "volume"));
89 return (dgettext(TEXT_DOMAIN, "pool"));
90 case ZFS_TYPE_BOOKMARK:
91 return (dgettext(TEXT_DOMAIN, "bookmark"));
93 assert(!"unhandled zfs_type_t");
100 * Validate a ZFS path. This is used even before trying to open the dataset, to
101 * provide a more meaningful error message. We call zfs_error_aux() to
102 * explain exactly why the name was not valid.
105 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
111 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
113 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
114 "snapshot delimiter '@' is not expected here"));
118 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
120 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
121 "missing '@' delimiter in snapshot name"));
125 if (!(type & ZFS_TYPE_BOOKMARK) && strchr(path, '#') != NULL) {
127 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
128 "bookmark delimiter '#' is not expected here"));
132 if (type == ZFS_TYPE_BOOKMARK && strchr(path, '#') == NULL) {
134 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
135 "missing '#' delimiter in bookmark name"));
139 if (modifying && strchr(path, '%') != NULL) {
141 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
142 "invalid character %c in name"), '%');
146 if (entity_namecheck(path, &why, &what) != 0) {
149 case NAME_ERR_TOOLONG:
150 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
151 "name is too long"));
154 case NAME_ERR_LEADING_SLASH:
155 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
156 "leading slash in name"));
159 case NAME_ERR_EMPTY_COMPONENT:
160 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
161 "empty component or misplaced '@'"
162 " or '#' delimiter in name"));
165 case NAME_ERR_TRAILING_SLASH:
166 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
167 "trailing slash in name"));
170 case NAME_ERR_INVALCHAR:
172 dgettext(TEXT_DOMAIN, "invalid character "
173 "'%c' in name"), what);
176 case NAME_ERR_MULTIPLE_DELIMITERS:
177 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
178 "multiple '@' and/or '#' delimiters in "
182 case NAME_ERR_NOLETTER:
183 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
184 "pool doesn't begin with a letter"));
187 case NAME_ERR_RESERVED:
188 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
189 "name is reserved"));
192 case NAME_ERR_DISKLIKE:
193 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
194 "reserved disk name"));
197 case NAME_ERR_SELF_REF:
198 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
199 "self reference, '.' is found in name"));
202 case NAME_ERR_PARENT_REF:
203 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
204 "parent reference, '..' is found in name"));
208 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
209 "(%d) not defined"), why);
221 zfs_name_valid(const char *name, zfs_type_t type)
223 if (type == ZFS_TYPE_POOL)
224 return (zpool_name_valid(NULL, B_FALSE, name));
225 return (zfs_validate_name(NULL, name, type, B_FALSE));
229 * This function takes the raw DSL properties, and filters out the user-defined
230 * properties into a separate nvlist.
233 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
235 libzfs_handle_t *hdl = zhp->zfs_hdl;
240 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
241 (void) no_memory(hdl);
246 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
247 if (!zfs_prop_user(nvpair_name(elem)))
250 verify(nvpair_value_nvlist(elem, &propval) == 0);
251 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
253 (void) no_memory(hdl);
261 static zpool_handle_t *
262 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
264 libzfs_handle_t *hdl = zhp->zfs_hdl;
267 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
268 if (hdl->libzfs_pool_handles != NULL)
269 zph->zpool_next = hdl->libzfs_pool_handles;
270 hdl->libzfs_pool_handles = zph;
275 static zpool_handle_t *
276 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
278 libzfs_handle_t *hdl = zhp->zfs_hdl;
279 zpool_handle_t *zph = hdl->libzfs_pool_handles;
281 while ((zph != NULL) &&
282 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
283 zph = zph->zpool_next;
288 * Returns a handle to the pool that contains the provided dataset.
289 * If a handle to that pool already exists then that handle is returned.
290 * Otherwise, a new handle is created and added to the list of handles.
292 static zpool_handle_t *
293 zpool_handle(zfs_handle_t *zhp)
299 len = strcspn(zhp->zfs_name, "/@#") + 1;
300 pool_name = zfs_alloc(zhp->zfs_hdl, len);
301 (void) strlcpy(pool_name, zhp->zfs_name, len);
303 zph = zpool_find_handle(zhp, pool_name, len);
305 zph = zpool_add_handle(zhp, pool_name);
312 zpool_free_handles(libzfs_handle_t *hdl)
314 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
316 while (zph != NULL) {
317 next = zph->zpool_next;
321 hdl->libzfs_pool_handles = NULL;
325 * Utility function to gather stats (objset and zpl) for the given object.
328 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
330 libzfs_handle_t *hdl = zhp->zfs_hdl;
332 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
334 while (zfs_ioctl(hdl, ZFS_IOC_OBJSET_STATS, zc) != 0) {
335 if (errno == ENOMEM) {
336 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
347 * Utility function to get the received properties of the given object.
350 get_recvd_props_ioctl(zfs_handle_t *zhp)
352 libzfs_handle_t *hdl = zhp->zfs_hdl;
353 nvlist_t *recvdprops;
354 zfs_cmd_t zc = {"\0"};
357 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
360 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
362 while (zfs_ioctl(hdl, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
363 if (errno == ENOMEM) {
364 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
368 zcmd_free_nvlists(&zc);
373 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
374 zcmd_free_nvlists(&zc);
378 nvlist_free(zhp->zfs_recvd_props);
379 zhp->zfs_recvd_props = recvdprops;
385 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
387 nvlist_t *allprops, *userprops;
389 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
391 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
396 * XXX Why do we store the user props separately, in addition to
397 * storing them in zfs_props?
399 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
400 nvlist_free(allprops);
404 nvlist_free(zhp->zfs_props);
405 nvlist_free(zhp->zfs_user_props);
407 zhp->zfs_props = allprops;
408 zhp->zfs_user_props = userprops;
414 get_stats(zfs_handle_t *zhp)
417 zfs_cmd_t zc = {"\0"};
419 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
421 if (get_stats_ioctl(zhp, &zc) != 0)
423 else if (put_stats_zhdl(zhp, &zc) != 0)
425 zcmd_free_nvlists(&zc);
430 * Refresh the properties currently stored in the handle.
433 zfs_refresh_properties(zfs_handle_t *zhp)
435 (void) get_stats(zhp);
439 * Makes a handle from the given dataset name. Used by zfs_open() and
440 * zfs_iter_* to create child handles on the fly.
443 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
445 if (put_stats_zhdl(zhp, zc) != 0)
449 * We've managed to open the dataset and gather statistics. Determine
450 * the high-level type.
452 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
453 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
454 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
455 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
456 else if (zhp->zfs_dmustats.dds_type == DMU_OST_OTHER)
461 if (zhp->zfs_dmustats.dds_is_snapshot)
462 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
463 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
464 zhp->zfs_type = ZFS_TYPE_VOLUME;
465 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
466 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
468 abort(); /* we should never see any other types */
470 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
477 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
479 zfs_cmd_t zc = {"\0"};
481 zfs_handle_t *zhp = calloc(1, sizeof (zfs_handle_t));
487 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
488 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
492 if (get_stats_ioctl(zhp, &zc) == -1) {
493 zcmd_free_nvlists(&zc);
497 if (make_dataset_handle_common(zhp, &zc) == -1) {
501 zcmd_free_nvlists(&zc);
506 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
508 zfs_handle_t *zhp = calloc(1, sizeof (zfs_handle_t));
514 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
515 if (make_dataset_handle_common(zhp, zc) == -1) {
523 make_dataset_simple_handle_zc(zfs_handle_t *pzhp, zfs_cmd_t *zc)
525 zfs_handle_t *zhp = calloc(1, sizeof (zfs_handle_t));
530 zhp->zfs_hdl = pzhp->zfs_hdl;
531 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
532 zhp->zfs_head_type = pzhp->zfs_type;
533 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
534 zhp->zpool_hdl = zpool_handle(zhp);
540 zfs_handle_dup(zfs_handle_t *zhp_orig)
542 zfs_handle_t *zhp = calloc(1, sizeof (zfs_handle_t));
547 zhp->zfs_hdl = zhp_orig->zfs_hdl;
548 zhp->zpool_hdl = zhp_orig->zpool_hdl;
549 (void) strlcpy(zhp->zfs_name, zhp_orig->zfs_name,
550 sizeof (zhp->zfs_name));
551 zhp->zfs_type = zhp_orig->zfs_type;
552 zhp->zfs_head_type = zhp_orig->zfs_head_type;
553 zhp->zfs_dmustats = zhp_orig->zfs_dmustats;
554 if (zhp_orig->zfs_props != NULL) {
555 if (nvlist_dup(zhp_orig->zfs_props, &zhp->zfs_props, 0) != 0) {
556 (void) no_memory(zhp->zfs_hdl);
561 if (zhp_orig->zfs_user_props != NULL) {
562 if (nvlist_dup(zhp_orig->zfs_user_props,
563 &zhp->zfs_user_props, 0) != 0) {
564 (void) no_memory(zhp->zfs_hdl);
569 if (zhp_orig->zfs_recvd_props != NULL) {
570 if (nvlist_dup(zhp_orig->zfs_recvd_props,
571 &zhp->zfs_recvd_props, 0)) {
572 (void) no_memory(zhp->zfs_hdl);
577 zhp->zfs_mntcheck = zhp_orig->zfs_mntcheck;
578 if (zhp_orig->zfs_mntopts != NULL) {
579 zhp->zfs_mntopts = zfs_strdup(zhp_orig->zfs_hdl,
580 zhp_orig->zfs_mntopts);
582 zhp->zfs_props_table = zhp_orig->zfs_props_table;
587 zfs_bookmark_exists(const char *path)
591 char fsname[ZFS_MAX_DATASET_NAME_LEN];
597 (void) strlcpy(fsname, path, sizeof (fsname));
598 pound = strchr(fsname, '#');
603 bmark_name = pound + 1;
604 props = fnvlist_alloc();
605 err = lzc_get_bookmarks(fsname, props, &bmarks);
612 rv = nvlist_exists(bmarks, bmark_name);
618 make_bookmark_handle(zfs_handle_t *parent, const char *path,
619 nvlist_t *bmark_props)
621 zfs_handle_t *zhp = calloc(1, sizeof (zfs_handle_t));
626 /* Fill in the name. */
627 zhp->zfs_hdl = parent->zfs_hdl;
628 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
630 /* Set the property lists. */
631 if (nvlist_dup(bmark_props, &zhp->zfs_props, 0) != 0) {
637 zhp->zfs_head_type = parent->zfs_head_type;
638 zhp->zfs_type = ZFS_TYPE_BOOKMARK;
640 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL) {
641 nvlist_free(zhp->zfs_props);
649 struct zfs_open_bookmarks_cb_data {
655 zfs_open_bookmarks_cb(zfs_handle_t *zhp, void *data)
657 struct zfs_open_bookmarks_cb_data *dp = data;
660 * Is it the one we are looking for?
662 if (strcmp(dp->path, zfs_get_name(zhp)) == 0) {
664 * We found it. Save it and let the caller know we are done.
671 * Not found. Close the handle and ask for another one.
678 * Opens the given snapshot, bookmark, filesystem, or volume. The 'types'
679 * argument is a mask of acceptable types. The function will print an
680 * appropriate error message and return NULL if it can't be opened.
683 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
689 (void) snprintf(errbuf, sizeof (errbuf),
690 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
693 * Validate the name before we even try to open it.
695 if (!zfs_validate_name(hdl, path, types, B_FALSE)) {
696 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
701 * Bookmarks needs to be handled separately.
703 bookp = strchr(path, '#');
706 * Try to get stats for the dataset, which will tell us if it
710 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
711 (void) zfs_standard_error(hdl, errno, errbuf);
715 char dsname[ZFS_MAX_DATASET_NAME_LEN];
717 struct zfs_open_bookmarks_cb_data cb_data = {path, NULL};
720 * We need to cut out '#' and everything after '#'
721 * to get the parent dataset name only.
723 assert(bookp - path < sizeof (dsname));
724 (void) strncpy(dsname, path, bookp - path);
725 dsname[bookp - path] = '\0';
728 * Create handle for the parent dataset.
731 if ((pzhp = make_dataset_handle(hdl, dsname)) == NULL) {
732 (void) zfs_standard_error(hdl, errno, errbuf);
737 * Iterate bookmarks to find the right one.
740 if ((zfs_iter_bookmarks(pzhp, zfs_open_bookmarks_cb,
741 &cb_data) == 0) && (cb_data.zhp == NULL)) {
742 (void) zfs_error(hdl, EZFS_NOENT, errbuf);
746 if (cb_data.zhp == NULL) {
747 (void) zfs_standard_error(hdl, errno, errbuf);
759 if (!(types & zhp->zfs_type)) {
760 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
769 * Release a ZFS handle. Nothing to do but free the associated memory.
772 zfs_close(zfs_handle_t *zhp)
774 if (zhp->zfs_mntopts)
775 free(zhp->zfs_mntopts);
776 nvlist_free(zhp->zfs_props);
777 nvlist_free(zhp->zfs_user_props);
778 nvlist_free(zhp->zfs_recvd_props);
782 typedef struct mnttab_node {
783 struct mnttab mtn_mt;
788 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
790 const mnttab_node_t *mtn1 = (const mnttab_node_t *)arg1;
791 const mnttab_node_t *mtn2 = (const mnttab_node_t *)arg2;
794 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
796 return (TREE_ISIGN(rv));
800 libzfs_mnttab_init(libzfs_handle_t *hdl)
802 pthread_mutex_init(&hdl->libzfs_mnttab_cache_lock, NULL);
803 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
804 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
805 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
809 libzfs_mnttab_update(libzfs_handle_t *hdl)
814 if ((mnttab = fopen(MNTTAB, "re")) == NULL)
817 while (getmntent(mnttab, &entry) == 0) {
821 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
824 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
825 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
826 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
827 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
828 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
830 /* Exclude duplicate mounts */
831 if (avl_find(&hdl->libzfs_mnttab_cache, mtn, &where) != NULL) {
832 free(mtn->mtn_mt.mnt_special);
833 free(mtn->mtn_mt.mnt_mountp);
834 free(mtn->mtn_mt.mnt_fstype);
835 free(mtn->mtn_mt.mnt_mntopts);
840 avl_add(&hdl->libzfs_mnttab_cache, mtn);
843 (void) fclose(mnttab);
848 libzfs_mnttab_fini(libzfs_handle_t *hdl)
853 while ((mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie))
855 free(mtn->mtn_mt.mnt_special);
856 free(mtn->mtn_mt.mnt_mountp);
857 free(mtn->mtn_mt.mnt_fstype);
858 free(mtn->mtn_mt.mnt_mntopts);
861 avl_destroy(&hdl->libzfs_mnttab_cache);
862 (void) pthread_mutex_destroy(&hdl->libzfs_mnttab_cache_lock);
866 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
868 hdl->libzfs_mnttab_enable = enable;
872 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
873 struct mnttab *entry)
880 if (!hdl->libzfs_mnttab_enable) {
881 struct mnttab srch = { 0 };
883 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
884 libzfs_mnttab_fini(hdl);
886 if ((mnttab = fopen(MNTTAB, "re")) == NULL)
889 srch.mnt_special = (char *)fsname;
890 srch.mnt_fstype = MNTTYPE_ZFS;
891 ret = getmntany(mnttab, entry, &srch) ? ENOENT : 0;
892 (void) fclose(mnttab);
896 pthread_mutex_lock(&hdl->libzfs_mnttab_cache_lock);
897 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0) {
900 if ((error = libzfs_mnttab_update(hdl)) != 0) {
901 pthread_mutex_unlock(&hdl->libzfs_mnttab_cache_lock);
906 find.mtn_mt.mnt_special = (char *)fsname;
907 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
909 *entry = mtn->mtn_mt;
912 pthread_mutex_unlock(&hdl->libzfs_mnttab_cache_lock);
917 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
918 const char *mountp, const char *mntopts)
922 pthread_mutex_lock(&hdl->libzfs_mnttab_cache_lock);
923 if (avl_numnodes(&hdl->libzfs_mnttab_cache) != 0) {
924 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
925 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
926 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
927 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
928 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
930 * Another thread may have already added this entry
931 * via libzfs_mnttab_update. If so we should skip it.
933 if (avl_find(&hdl->libzfs_mnttab_cache, mtn, NULL) != NULL) {
934 free(mtn->mtn_mt.mnt_special);
935 free(mtn->mtn_mt.mnt_mountp);
936 free(mtn->mtn_mt.mnt_fstype);
937 free(mtn->mtn_mt.mnt_mntopts);
940 avl_add(&hdl->libzfs_mnttab_cache, mtn);
943 pthread_mutex_unlock(&hdl->libzfs_mnttab_cache_lock);
947 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
952 pthread_mutex_lock(&hdl->libzfs_mnttab_cache_lock);
953 find.mtn_mt.mnt_special = (char *)fsname;
954 if ((ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL))
956 avl_remove(&hdl->libzfs_mnttab_cache, ret);
957 free(ret->mtn_mt.mnt_special);
958 free(ret->mtn_mt.mnt_mountp);
959 free(ret->mtn_mt.mnt_fstype);
960 free(ret->mtn_mt.mnt_mntopts);
963 pthread_mutex_unlock(&hdl->libzfs_mnttab_cache_lock);
967 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
969 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
971 if (zpool_handle == NULL)
974 *spa_version = zpool_get_prop_int(zpool_handle,
975 ZPOOL_PROP_VERSION, NULL);
980 * The choice of reservation property depends on the SPA version.
983 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
987 if (zfs_spa_version(zhp, &spa_version) < 0)
990 if (spa_version >= SPA_VERSION_REFRESERVATION)
991 *resv_prop = ZFS_PROP_REFRESERVATION;
993 *resv_prop = ZFS_PROP_RESERVATION;
999 * Given an nvlist of properties to set, validates that they are correct, and
1000 * parses any numeric properties (index, boolean, etc) if they are specified as
1004 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
1005 uint64_t zoned, zfs_handle_t *zhp, zpool_handle_t *zpool_hdl,
1006 boolean_t key_params_ok, const char *errbuf)
1013 int chosen_normal = -1;
1014 int chosen_utf = -1;
1016 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
1017 (void) no_memory(hdl);
1022 * Make sure this property is valid and applies to this type.
1026 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
1027 const char *propname = nvpair_name(elem);
1029 prop = zfs_name_to_prop(propname);
1030 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
1032 * This is a user property: make sure it's a
1033 * string, and that it's less than ZAP_MAXNAMELEN.
1035 if (nvpair_type(elem) != DATA_TYPE_STRING) {
1036 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1037 "'%s' must be a string"), propname);
1038 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1042 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
1043 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1044 "property name '%s' is too long"),
1046 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1050 (void) nvpair_value_string(elem, &strval);
1051 if (nvlist_add_string(ret, propname, strval) != 0) {
1052 (void) no_memory(hdl);
1059 * Currently, only user properties can be modified on
1062 if (type == ZFS_TYPE_SNAPSHOT) {
1063 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1064 "this property can not be modified for snapshots"));
1065 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1069 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
1070 zfs_userquota_prop_t uqtype;
1071 char *newpropname = NULL;
1077 if (userquota_propname_decode(propname, zoned,
1078 &uqtype, domain, sizeof (domain), &rid) != 0) {
1080 dgettext(TEXT_DOMAIN,
1081 "'%s' has an invalid user/group name"),
1083 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1087 if (uqtype != ZFS_PROP_USERQUOTA &&
1088 uqtype != ZFS_PROP_GROUPQUOTA &&
1089 uqtype != ZFS_PROP_USEROBJQUOTA &&
1090 uqtype != ZFS_PROP_GROUPOBJQUOTA &&
1091 uqtype != ZFS_PROP_PROJECTQUOTA &&
1092 uqtype != ZFS_PROP_PROJECTOBJQUOTA) {
1094 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1096 (void) zfs_error(hdl, EZFS_PROPREADONLY,
1101 if (nvpair_type(elem) == DATA_TYPE_STRING) {
1102 (void) nvpair_value_string(elem, &strval);
1103 if (strcmp(strval, "none") == 0) {
1105 } else if (zfs_nicestrtonum(hdl,
1106 strval, &intval) != 0) {
1107 (void) zfs_error(hdl,
1108 EZFS_BADPROP, errbuf);
1111 } else if (nvpair_type(elem) ==
1113 (void) nvpair_value_uint64(elem, &intval);
1115 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1116 "use 'none' to disable "
1117 "{user|group|project}quota"));
1121 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1122 "'%s' must be a number"), propname);
1123 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1128 * Encode the prop name as
1129 * userquota@<hex-rid>-domain, to make it easy
1130 * for the kernel to decode.
1132 rc = asprintf(&newpropname, "%s%llx-%s",
1133 zfs_userquota_prop_prefixes[uqtype],
1134 (longlong_t)rid, domain);
1135 if (rc == -1 || newpropname == NULL) {
1136 (void) no_memory(hdl);
1143 if (nvlist_add_uint64_array(ret, newpropname,
1146 (void) no_memory(hdl);
1151 } else if (prop == ZPROP_INVAL && zfs_prop_written(propname)) {
1152 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1153 "'%s' is readonly"),
1155 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1159 if (prop == ZPROP_INVAL) {
1160 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1161 "invalid property '%s'"), propname);
1162 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1166 if (!zfs_prop_valid_for_type(prop, type, B_FALSE)) {
1168 dgettext(TEXT_DOMAIN, "'%s' does not "
1169 "apply to datasets of this type"), propname);
1170 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1174 if (zfs_prop_readonly(prop) &&
1175 !(zfs_prop_setonce(prop) && zhp == NULL) &&
1176 !(zfs_prop_encryption_key_param(prop) && key_params_ok)) {
1178 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1180 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1184 if (zprop_parse_value(hdl, elem, prop, type, ret,
1185 &strval, &intval, errbuf) != 0)
1189 * Perform some additional checks for specific properties.
1192 case ZFS_PROP_VERSION:
1198 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1199 if (intval < version) {
1200 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1201 "Can not downgrade; already at version %u"),
1203 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1209 case ZFS_PROP_VOLBLOCKSIZE:
1210 case ZFS_PROP_RECORDSIZE:
1212 int maxbs = SPA_MAXBLOCKSIZE;
1215 if (zpool_hdl != NULL) {
1216 maxbs = zpool_get_prop_int(zpool_hdl,
1217 ZPOOL_PROP_MAXBLOCKSIZE, NULL);
1220 * The value must be a power of two between
1221 * SPA_MINBLOCKSIZE and maxbs.
1223 if (intval < SPA_MINBLOCKSIZE ||
1224 intval > maxbs || !ISP2(intval)) {
1225 zfs_nicebytes(maxbs, buf, sizeof (buf));
1226 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1227 "'%s' must be power of 2 from 512B "
1228 "to %s"), propname, buf);
1229 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1235 case ZFS_PROP_SPECIAL_SMALL_BLOCKS:
1237 int maxbs = SPA_OLD_MAXBLOCKSIZE;
1240 if (zpool_hdl != NULL) {
1241 char state[64] = "";
1243 maxbs = zpool_get_prop_int(zpool_hdl,
1244 ZPOOL_PROP_MAXBLOCKSIZE, NULL);
1247 * Issue a warning but do not fail so that
1248 * tests for settable properties succeed.
1250 if (zpool_prop_get_feature(zpool_hdl,
1251 "feature@allocation_classes", state,
1252 sizeof (state)) != 0 ||
1253 strcmp(state, ZFS_FEATURE_ACTIVE) != 0) {
1254 (void) fprintf(stderr, gettext(
1255 "%s: property requires a special "
1256 "device in the pool\n"), propname);
1260 (intval < SPA_MINBLOCKSIZE ||
1261 intval > maxbs || !ISP2(intval))) {
1262 zfs_nicebytes(maxbs, buf, sizeof (buf));
1263 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1264 "invalid '%s=%d' property: must be zero or "
1265 "a power of 2 from 512B to %s"), propname,
1267 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1273 case ZFS_PROP_MLSLABEL:
1275 #ifdef HAVE_MLSLABEL
1277 * Verify the mlslabel string and convert to
1278 * internal hex label string.
1282 char *hex = NULL; /* internal label string */
1284 /* Default value is already OK. */
1285 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
1288 /* Verify the label can be converted to binary form */
1289 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
1290 (str_to_label(strval, &new_sl, MAC_LABEL,
1291 L_NO_CORRECTION, NULL) == -1)) {
1295 /* Now translate to hex internal label string */
1296 if (label_to_str(new_sl, &hex, M_INTERNAL,
1302 m_label_free(new_sl);
1304 /* If string is already in internal form, we're done. */
1305 if (strcmp(strval, hex) == 0) {
1310 /* Replace the label string with the internal form. */
1311 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
1313 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
1320 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1321 "invalid mlslabel '%s'"), strval);
1322 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1323 m_label_free(new_sl); /* OK if null */
1326 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1327 "mlslabels are unsupported"));
1328 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1330 #endif /* HAVE_MLSLABEL */
1333 case ZFS_PROP_MOUNTPOINT:
1335 namecheck_err_t why;
1337 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1338 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1341 if (mountpoint_namecheck(strval, &why)) {
1343 case NAME_ERR_LEADING_SLASH:
1345 dgettext(TEXT_DOMAIN,
1346 "'%s' must be an absolute path, "
1347 "'none', or 'legacy'"), propname);
1349 case NAME_ERR_TOOLONG:
1351 dgettext(TEXT_DOMAIN,
1352 "component of '%s' is too long"),
1358 dgettext(TEXT_DOMAIN,
1359 "(%d) not defined"),
1363 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1370 case ZFS_PROP_SHARESMB:
1371 case ZFS_PROP_SHARENFS:
1373 * For the mountpoint and sharenfs or sharesmb
1374 * properties, check if it can be set in a
1375 * global/non-global zone based on
1376 * the zoned property value:
1378 * global zone non-global zone
1379 * --------------------------------------------------
1380 * zoned=on mountpoint (no) mountpoint (yes)
1381 * sharenfs (no) sharenfs (no)
1382 * sharesmb (no) sharesmb (no)
1384 * zoned=off mountpoint (yes) N/A
1389 if (getzoneid() == GLOBAL_ZONEID) {
1390 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1391 "'%s' cannot be set on "
1392 "dataset in a non-global zone"),
1394 (void) zfs_error(hdl, EZFS_ZONED,
1397 } else if (prop == ZFS_PROP_SHARENFS ||
1398 prop == ZFS_PROP_SHARESMB) {
1399 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1400 "'%s' cannot be set in "
1401 "a non-global zone"), propname);
1402 (void) zfs_error(hdl, EZFS_ZONED,
1406 } else if (getzoneid() != GLOBAL_ZONEID) {
1408 * If zoned property is 'off', this must be in
1409 * a global zone. If not, something is wrong.
1411 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1412 "'%s' cannot be set while dataset "
1413 "'zoned' property is set"), propname);
1414 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1419 * At this point, it is legitimate to set the
1420 * property. Now we want to make sure that the
1421 * property value is valid if it is sharenfs.
1423 if ((prop == ZFS_PROP_SHARENFS ||
1424 prop == ZFS_PROP_SHARESMB) &&
1425 strcmp(strval, "on") != 0 &&
1426 strcmp(strval, "off") != 0) {
1427 zfs_share_proto_t proto;
1429 if (prop == ZFS_PROP_SHARESMB)
1434 if (zfs_parse_options(strval, proto) != SA_OK) {
1435 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1436 "'%s' cannot be set to invalid "
1437 "options"), propname);
1438 (void) zfs_error(hdl, EZFS_BADPROP,
1446 case ZFS_PROP_KEYLOCATION:
1447 if (!zfs_prop_valid_keylocation(strval, B_FALSE)) {
1448 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1449 "invalid keylocation"));
1450 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1456 zfs_prop_get_int(zhp, ZFS_PROP_ENCRYPTION);
1458 if (crypt == ZIO_CRYPT_OFF &&
1459 strcmp(strval, "none") != 0) {
1460 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1461 "keylocation must be 'none' "
1462 "for unencrypted datasets"));
1463 (void) zfs_error(hdl, EZFS_BADPROP,
1466 } else if (crypt != ZIO_CRYPT_OFF &&
1467 strcmp(strval, "none") == 0) {
1468 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1469 "keylocation must not be 'none' "
1470 "for encrypted datasets"));
1471 (void) zfs_error(hdl, EZFS_BADPROP,
1478 case ZFS_PROP_PBKDF2_ITERS:
1479 if (intval < MIN_PBKDF2_ITERATIONS) {
1480 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1481 "minimum pbkdf2 iterations is %u"),
1482 MIN_PBKDF2_ITERATIONS);
1483 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1488 case ZFS_PROP_UTF8ONLY:
1489 chosen_utf = (int)intval;
1492 case ZFS_PROP_NORMALIZE:
1493 chosen_normal = (int)intval;
1501 * For changes to existing volumes, we have some additional
1502 * checks to enforce.
1504 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1505 uint64_t blocksize = zfs_prop_get_int(zhp,
1506 ZFS_PROP_VOLBLOCKSIZE);
1510 case ZFS_PROP_VOLSIZE:
1511 if (intval % blocksize != 0) {
1512 zfs_nicebytes(blocksize, buf,
1514 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1515 "'%s' must be a multiple of "
1516 "volume block size (%s)"),
1518 (void) zfs_error(hdl, EZFS_BADPROP,
1524 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1525 "'%s' cannot be zero"),
1527 (void) zfs_error(hdl, EZFS_BADPROP,
1538 /* check encryption properties */
1540 int64_t crypt = zfs_prop_get_int(zhp,
1541 ZFS_PROP_ENCRYPTION);
1544 case ZFS_PROP_COPIES:
1545 if (crypt != ZIO_CRYPT_OFF && intval > 2) {
1546 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1547 "encrypted datasets cannot have "
1549 (void) zfs_error(hdl, EZFS_BADPROP,
1561 * If normalization was chosen, but no UTF8 choice was made,
1562 * enforce rejection of non-UTF8 names.
1564 * If normalization was chosen, but rejecting non-UTF8 names
1565 * was explicitly not chosen, it is an error.
1567 if (chosen_normal > 0 && chosen_utf < 0) {
1568 if (nvlist_add_uint64(ret,
1569 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1570 (void) no_memory(hdl);
1573 } else if (chosen_normal > 0 && chosen_utf == 0) {
1574 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1575 "'%s' must be set 'on' if normalization chosen"),
1576 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1577 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1588 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1590 uint64_t old_volsize;
1591 uint64_t new_volsize;
1592 uint64_t old_reservation;
1593 uint64_t new_reservation;
1594 zfs_prop_t resv_prop;
1596 zpool_handle_t *zph = zpool_handle(zhp);
1599 * If this is an existing volume, and someone is setting the volsize,
1600 * make sure that it matches the reservation, or add it if necessary.
1602 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1603 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1605 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1607 props = fnvlist_alloc();
1608 fnvlist_add_uint64(props, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
1609 zfs_prop_get_int(zhp, ZFS_PROP_VOLBLOCKSIZE));
1611 if ((zvol_volsize_to_reservation(zph, old_volsize, props) !=
1612 old_reservation) || nvlist_exists(nvl,
1613 zfs_prop_to_name(resv_prop))) {
1614 fnvlist_free(props);
1617 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1618 &new_volsize) != 0) {
1619 fnvlist_free(props);
1622 new_reservation = zvol_volsize_to_reservation(zph, new_volsize, props);
1623 fnvlist_free(props);
1625 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1626 new_reservation) != 0) {
1627 (void) no_memory(zhp->zfs_hdl);
1634 * Helper for 'zfs {set|clone} refreservation=auto'. Must be called after
1635 * zfs_valid_proplist(), as it is what sets the UINT64_MAX sentinel value.
1636 * Return codes must match zfs_add_synthetic_resv().
1639 zfs_fix_auto_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1646 if (!ZFS_IS_VOLUME(zhp)) {
1650 if (zfs_which_resv_prop(zhp, &prop) != 0) {
1654 if (prop != ZFS_PROP_REFRESERVATION) {
1658 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(prop), &resvsize) != 0) {
1659 /* No value being set, so it can't be "auto" */
1662 if (resvsize != UINT64_MAX) {
1663 /* Being set to a value other than "auto" */
1667 props = fnvlist_alloc();
1669 fnvlist_add_uint64(props, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
1670 zfs_prop_get_int(zhp, ZFS_PROP_VOLBLOCKSIZE));
1672 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1674 volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1677 resvsize = zvol_volsize_to_reservation(zpool_handle(zhp), volsize,
1679 fnvlist_free(props);
1681 (void) nvlist_remove_all(nvl, zfs_prop_to_name(prop));
1682 if (nvlist_add_uint64(nvl, zfs_prop_to_name(prop), resvsize) != 0) {
1683 (void) no_memory(zhp->zfs_hdl);
1690 zfs_is_namespace_prop(zfs_prop_t prop)
1694 case ZFS_PROP_ATIME:
1695 case ZFS_PROP_RELATIME:
1696 case ZFS_PROP_DEVICES:
1698 case ZFS_PROP_SETUID:
1699 case ZFS_PROP_READONLY:
1700 case ZFS_PROP_XATTR:
1701 case ZFS_PROP_NBMAND:
1710 * Given a property name and value, set the property for the given dataset.
1713 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1717 libzfs_handle_t *hdl = zhp->zfs_hdl;
1718 nvlist_t *nvl = NULL;
1720 (void) snprintf(errbuf, sizeof (errbuf),
1721 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1724 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1725 nvlist_add_string(nvl, propname, propval) != 0) {
1726 (void) no_memory(hdl);
1730 ret = zfs_prop_set_list(zhp, nvl);
1740 * Given an nvlist of property names and values, set the properties for the
1744 zfs_prop_set_list(zfs_handle_t *zhp, nvlist_t *props)
1746 zfs_cmd_t zc = {"\0"};
1748 prop_changelist_t **cls = NULL;
1751 libzfs_handle_t *hdl = zhp->zfs_hdl;
1755 zfs_prop_t prop = 0;
1758 (void) snprintf(errbuf, sizeof (errbuf),
1759 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1762 if ((nvl = zfs_valid_proplist(hdl, zhp->zfs_type, props,
1763 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, zhp->zpool_hdl,
1764 B_FALSE, errbuf)) == NULL)
1768 * We have to check for any extra properties which need to be added
1769 * before computing the length of the nvlist.
1771 for (elem = nvlist_next_nvpair(nvl, NULL);
1773 elem = nvlist_next_nvpair(nvl, elem)) {
1774 if (zfs_name_to_prop(nvpair_name(elem)) == ZFS_PROP_VOLSIZE &&
1775 (added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1) {
1780 if (added_resv != 1 &&
1781 (added_resv = zfs_fix_auto_resv(zhp, nvl)) == -1) {
1786 * Check how many properties we're setting and allocate an array to
1787 * store changelist pointers for postfix().
1789 for (elem = nvlist_next_nvpair(nvl, NULL);
1791 elem = nvlist_next_nvpair(nvl, elem))
1793 if ((cls = calloc(nvl_len, sizeof (prop_changelist_t *))) == NULL)
1797 for (elem = nvlist_next_nvpair(nvl, NULL);
1799 elem = nvlist_next_nvpair(nvl, elem)) {
1801 prop = zfs_name_to_prop(nvpair_name(elem));
1803 assert(cl_idx < nvl_len);
1805 * We don't want to unmount & remount the dataset when changing
1806 * its canmount property to 'on' or 'noauto'. We only use
1807 * the changelist logic to unmount when setting canmount=off.
1809 if (prop != ZFS_PROP_CANMOUNT ||
1810 (fnvpair_value_uint64(elem) == ZFS_CANMOUNT_OFF &&
1811 zfs_is_mounted(zhp, NULL))) {
1812 cls[cl_idx] = changelist_gather(zhp, prop, 0, 0);
1813 if (cls[cl_idx] == NULL)
1817 if (prop == ZFS_PROP_MOUNTPOINT &&
1818 changelist_haszonedchild(cls[cl_idx])) {
1819 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1820 "child dataset with inherited mountpoint is used "
1821 "in a non-global zone"));
1822 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1826 if (cls[cl_idx] != NULL &&
1827 (ret = changelist_prefix(cls[cl_idx])) != 0)
1832 assert(cl_idx == nvl_len);
1835 * Execute the corresponding ioctl() to set this list of properties.
1837 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1839 if ((ret = zcmd_write_src_nvlist(hdl, &zc, nvl)) != 0 ||
1840 (ret = zcmd_alloc_dst_nvlist(hdl, &zc, 0)) != 0)
1843 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1846 if (zc.zc_nvlist_dst_filled == B_FALSE) {
1847 (void) zfs_standard_error(hdl, errno, errbuf);
1851 /* Get the list of unset properties back and report them. */
1852 nvlist_t *errorprops = NULL;
1853 if (zcmd_read_dst_nvlist(hdl, &zc, &errorprops) != 0)
1855 for (nvpair_t *elem = nvlist_next_nvpair(errorprops, NULL);
1857 elem = nvlist_next_nvpair(errorprops, elem)) {
1858 prop = zfs_name_to_prop(nvpair_name(elem));
1859 zfs_setprop_error(hdl, prop, errno, errbuf);
1861 nvlist_free(errorprops);
1863 if (added_resv && errno == ENOSPC) {
1864 /* clean up the volsize property we tried to set */
1865 uint64_t old_volsize = zfs_prop_get_int(zhp,
1869 zcmd_free_nvlists(&zc);
1871 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1873 if (nvlist_add_uint64(nvl,
1874 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1877 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1879 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1882 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1883 if (cls[cl_idx] != NULL) {
1884 int clp_err = changelist_postfix(cls[cl_idx]);
1892 * Refresh the statistics so the new property
1893 * value is reflected.
1895 (void) get_stats(zhp);
1898 * Remount the filesystem to propagate the change
1899 * if one of the options handled by the generic
1900 * Linux namespace layer has been modified.
1902 if (zfs_is_namespace_prop(prop) &&
1903 zfs_is_mounted(zhp, NULL))
1904 ret = zfs_mount(zhp, MNTOPT_REMOUNT, 0);
1910 zcmd_free_nvlists(&zc);
1912 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1913 if (cls[cl_idx] != NULL)
1914 changelist_free(cls[cl_idx]);
1922 * Given a property, inherit the value from the parent dataset, or if received
1923 * is TRUE, revert to the received value, if any.
1926 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1928 zfs_cmd_t zc = {"\0"};
1930 prop_changelist_t *cl;
1931 libzfs_handle_t *hdl = zhp->zfs_hdl;
1935 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1936 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1938 zc.zc_cookie = received;
1939 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1941 * For user properties, the amount of work we have to do is very
1942 * small, so just do it here.
1944 if (!zfs_prop_user(propname)) {
1945 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1946 "invalid property"));
1947 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1950 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1951 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1953 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1954 return (zfs_standard_error(hdl, errno, errbuf));
1956 (void) get_stats(zhp);
1961 * Verify that this property is inheritable.
1963 if (zfs_prop_readonly(prop))
1964 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1966 if (!zfs_prop_inheritable(prop) && !received)
1967 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1970 * Check to see if the value applies to this type
1972 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE))
1973 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1976 * Normalize the name, to get rid of shorthand abbreviations.
1978 propname = zfs_prop_to_name(prop);
1979 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1980 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1982 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1983 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1984 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1985 "dataset is used in a non-global zone"));
1986 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1990 * Determine datasets which will be affected by this change, if any.
1992 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1995 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1996 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1997 "child dataset with inherited mountpoint is used "
1998 "in a non-global zone"));
1999 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
2003 if ((ret = changelist_prefix(cl)) != 0)
2006 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
2007 return (zfs_standard_error(hdl, errno, errbuf));
2010 if ((ret = changelist_postfix(cl)) != 0)
2014 * Refresh the statistics so the new property is reflected.
2016 (void) get_stats(zhp);
2019 * Remount the filesystem to propagate the change
2020 * if one of the options handled by the generic
2021 * Linux namespace layer has been modified.
2023 if (zfs_is_namespace_prop(prop) &&
2024 zfs_is_mounted(zhp, NULL))
2025 ret = zfs_mount(zhp, MNTOPT_REMOUNT, 0);
2029 changelist_free(cl);
2034 * True DSL properties are stored in an nvlist. The following two functions
2035 * extract them appropriately.
2038 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
2044 if (nvlist_lookup_nvlist(zhp->zfs_props,
2045 zfs_prop_to_name(prop), &nv) == 0) {
2046 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
2047 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
2049 verify(!zhp->zfs_props_table ||
2050 zhp->zfs_props_table[prop] == B_TRUE);
2051 value = zfs_prop_default_numeric(prop);
2059 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
2065 if (nvlist_lookup_nvlist(zhp->zfs_props,
2066 zfs_prop_to_name(prop), &nv) == 0) {
2067 value = fnvlist_lookup_string(nv, ZPROP_VALUE);
2068 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
2070 verify(!zhp->zfs_props_table ||
2071 zhp->zfs_props_table[prop] == B_TRUE);
2072 value = zfs_prop_default_string(prop);
2080 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
2082 return (zhp->zfs_props == zhp->zfs_recvd_props);
2086 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
2088 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
2089 zhp->zfs_props = zhp->zfs_recvd_props;
2093 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
2095 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
2100 * Internal function for getting a numeric property. Both zfs_prop_get() and
2101 * zfs_prop_get_int() are built using this interface.
2103 * Certain properties can be overridden using 'mount -o'. In this case, scan
2104 * the contents of the /proc/self/mounts entry, searching for the
2105 * appropriate options. If they differ from the on-disk values, report the
2106 * current values and mark the source "temporary".
2109 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
2110 char **source, uint64_t *val)
2112 zfs_cmd_t zc = {"\0"};
2113 nvlist_t *zplprops = NULL;
2115 char *mntopt_on = NULL;
2116 char *mntopt_off = NULL;
2117 boolean_t received = zfs_is_recvd_props_mode(zhp);
2122 * If the property is being fetched for a snapshot, check whether
2123 * the property is valid for the snapshot's head dataset type.
2125 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT &&
2126 !zfs_prop_valid_for_type(prop, zhp->zfs_head_type, B_TRUE)) {
2127 *val = zfs_prop_default_numeric(prop);
2132 case ZFS_PROP_ATIME:
2133 mntopt_on = MNTOPT_ATIME;
2134 mntopt_off = MNTOPT_NOATIME;
2137 case ZFS_PROP_RELATIME:
2138 mntopt_on = MNTOPT_RELATIME;
2139 mntopt_off = MNTOPT_NORELATIME;
2142 case ZFS_PROP_DEVICES:
2143 mntopt_on = MNTOPT_DEVICES;
2144 mntopt_off = MNTOPT_NODEVICES;
2148 mntopt_on = MNTOPT_EXEC;
2149 mntopt_off = MNTOPT_NOEXEC;
2152 case ZFS_PROP_READONLY:
2153 mntopt_on = MNTOPT_RO;
2154 mntopt_off = MNTOPT_RW;
2157 case ZFS_PROP_SETUID:
2158 mntopt_on = MNTOPT_SETUID;
2159 mntopt_off = MNTOPT_NOSETUID;
2162 case ZFS_PROP_XATTR:
2163 mntopt_on = MNTOPT_XATTR;
2164 mntopt_off = MNTOPT_NOXATTR;
2167 case ZFS_PROP_NBMAND:
2168 mntopt_on = MNTOPT_NBMAND;
2169 mntopt_off = MNTOPT_NONBMAND;
2177 * Because looking up the mount options is potentially expensive
2178 * (iterating over all of /proc/self/mounts), we defer its
2179 * calculation until we're looking up a property which requires
2182 if (!zhp->zfs_mntcheck &&
2183 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED) &&
2184 (src && (*src & ZPROP_SRC_TEMPORARY))) {
2185 libzfs_handle_t *hdl = zhp->zfs_hdl;
2186 struct mnttab entry;
2188 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
2189 zhp->zfs_mntopts = zfs_strdup(hdl,
2191 if (zhp->zfs_mntopts == NULL)
2195 zhp->zfs_mntcheck = B_TRUE;
2198 if (zhp->zfs_mntopts == NULL)
2199 mnt.mnt_mntopts = "";
2201 mnt.mnt_mntopts = zhp->zfs_mntopts;
2204 case ZFS_PROP_ATIME:
2205 case ZFS_PROP_RELATIME:
2206 case ZFS_PROP_DEVICES:
2208 case ZFS_PROP_READONLY:
2209 case ZFS_PROP_SETUID:
2211 case ZFS_PROP_XATTR:
2213 case ZFS_PROP_NBMAND:
2214 *val = getprop_uint64(zhp, prop, source);
2219 if (hasmntopt(&mnt, mntopt_on) && !*val) {
2222 *src = ZPROP_SRC_TEMPORARY;
2223 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
2226 *src = ZPROP_SRC_TEMPORARY;
2230 case ZFS_PROP_CANMOUNT:
2231 case ZFS_PROP_VOLSIZE:
2232 case ZFS_PROP_QUOTA:
2233 case ZFS_PROP_REFQUOTA:
2234 case ZFS_PROP_RESERVATION:
2235 case ZFS_PROP_REFRESERVATION:
2236 case ZFS_PROP_FILESYSTEM_LIMIT:
2237 case ZFS_PROP_SNAPSHOT_LIMIT:
2238 case ZFS_PROP_FILESYSTEM_COUNT:
2239 case ZFS_PROP_SNAPSHOT_COUNT:
2240 *val = getprop_uint64(zhp, prop, source);
2242 if (*source == NULL) {
2243 /* not default, must be local */
2244 *source = zhp->zfs_name;
2248 case ZFS_PROP_MOUNTED:
2249 *val = (zhp->zfs_mntopts != NULL);
2252 case ZFS_PROP_NUMCLONES:
2253 *val = zhp->zfs_dmustats.dds_num_clones;
2256 case ZFS_PROP_VERSION:
2257 case ZFS_PROP_NORMALIZE:
2258 case ZFS_PROP_UTF8ONLY:
2260 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2262 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2263 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
2264 zcmd_free_nvlists(&zc);
2265 if (prop == ZFS_PROP_VERSION &&
2266 zhp->zfs_type == ZFS_TYPE_VOLUME)
2267 *val = zfs_prop_default_numeric(prop);
2270 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
2271 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
2273 zcmd_free_nvlists(&zc);
2276 nvlist_free(zplprops);
2277 zcmd_free_nvlists(&zc);
2280 case ZFS_PROP_INCONSISTENT:
2281 *val = zhp->zfs_dmustats.dds_inconsistent;
2284 case ZFS_PROP_REDACTED:
2285 *val = zhp->zfs_dmustats.dds_redacted;
2289 switch (zfs_prop_get_type(prop)) {
2290 case PROP_TYPE_NUMBER:
2291 case PROP_TYPE_INDEX:
2292 *val = getprop_uint64(zhp, prop, source);
2294 * If we tried to use a default value for a
2295 * readonly property, it means that it was not
2296 * present. Note this only applies to "truly"
2297 * readonly properties, not set-once properties
2298 * like volblocksize.
2300 if (zfs_prop_readonly(prop) &&
2301 !zfs_prop_setonce(prop) &&
2302 *source != NULL && (*source)[0] == '\0') {
2308 case PROP_TYPE_STRING:
2310 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
2311 "cannot get non-numeric property"));
2312 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
2313 dgettext(TEXT_DOMAIN, "internal error")));
2321 * Calculate the source type, given the raw source string.
2324 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
2325 char *statbuf, size_t statlen)
2327 if (statbuf == NULL ||
2328 srctype == NULL || *srctype == ZPROP_SRC_TEMPORARY) {
2332 if (source == NULL) {
2333 *srctype = ZPROP_SRC_NONE;
2334 } else if (source[0] == '\0') {
2335 *srctype = ZPROP_SRC_DEFAULT;
2336 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
2337 *srctype = ZPROP_SRC_RECEIVED;
2339 if (strcmp(source, zhp->zfs_name) == 0) {
2340 *srctype = ZPROP_SRC_LOCAL;
2342 (void) strlcpy(statbuf, source, statlen);
2343 *srctype = ZPROP_SRC_INHERITED;
2350 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
2351 size_t proplen, boolean_t literal)
2356 if (zhp->zfs_recvd_props == NULL)
2357 if (get_recvd_props_ioctl(zhp) != 0)
2360 prop = zfs_name_to_prop(propname);
2362 if (prop != ZPROP_INVAL) {
2364 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
2366 zfs_set_recvd_props_mode(zhp, &cookie);
2367 err = zfs_prop_get(zhp, prop, propbuf, proplen,
2368 NULL, NULL, 0, literal);
2369 zfs_unset_recvd_props_mode(zhp, &cookie);
2373 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
2374 propname, &propval) != 0)
2376 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
2378 (void) strlcpy(propbuf, recvdval, proplen);
2381 return (err == 0 ? 0 : -1);
2385 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2390 value = zfs_get_clones_nvl(zhp);
2391 if (value == NULL || nvlist_empty(value))
2395 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
2396 pair = nvlist_next_nvpair(value, pair)) {
2397 if (propbuf[0] != '\0')
2398 (void) strlcat(propbuf, ",", proplen);
2399 (void) strlcat(propbuf, nvpair_name(pair), proplen);
2405 struct get_clones_arg {
2409 char buf[ZFS_MAX_DATASET_NAME_LEN];
2413 get_clones_cb(zfs_handle_t *zhp, void *arg)
2415 struct get_clones_arg *gca = arg;
2417 if (gca->numclones == 0) {
2422 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
2423 NULL, NULL, 0, B_TRUE) != 0)
2425 if (strcmp(gca->buf, gca->origin) == 0) {
2426 fnvlist_add_boolean(gca->value, zfs_get_name(zhp));
2431 (void) zfs_iter_children(zhp, get_clones_cb, gca);
2437 zfs_get_clones_nvl(zfs_handle_t *zhp)
2439 nvlist_t *nv, *value;
2441 if (nvlist_lookup_nvlist(zhp->zfs_props,
2442 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
2443 struct get_clones_arg gca;
2446 * if this is a snapshot, then the kernel wasn't able
2447 * to get the clones. Do it by slowly iterating.
2449 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2451 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2453 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2458 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2460 gca.origin = zhp->zfs_name;
2462 if (gca.numclones != 0) {
2464 char pool[ZFS_MAX_DATASET_NAME_LEN];
2467 /* get the pool name */
2468 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2469 (void) strsep(&cp, "/@");
2470 root = zfs_open(zhp->zfs_hdl, pool,
2471 ZFS_TYPE_FILESYSTEM);
2478 (void) get_clones_cb(root, &gca);
2481 if (gca.numclones != 0 ||
2482 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2483 nvlist_add_nvlist(zhp->zfs_props,
2484 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2491 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2492 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2495 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2501 get_rsnaps_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2507 if (nvlist_lookup_nvlist(zhp->zfs_props,
2508 zfs_prop_to_name(ZFS_PROP_REDACT_SNAPS), &value) != 0)
2510 if (nvlist_lookup_uint64_array(value, ZPROP_VALUE, &snaps,
2514 /* There's no redaction snapshots; pass a special value back */
2515 (void) snprintf(propbuf, proplen, "none");
2519 for (int i = 0; i < nsnaps; i++) {
2521 if (propbuf[0] != '\0')
2522 (void) strlcat(propbuf, ",", proplen);
2523 (void) snprintf(buf, sizeof (buf), "%llu",
2524 (u_longlong_t)snaps[i]);
2525 (void) strlcat(propbuf, buf, proplen);
2532 * Accepts a property and value and checks that the value
2533 * matches the one found by the channel program. If they are
2534 * not equal, print both of them.
2537 zcp_check(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t intval,
2540 if (!zhp->zfs_hdl->libzfs_prop_debug)
2543 char *poolname = zhp->zpool_hdl->zpool_name;
2544 const char *prop_name = zfs_prop_to_name(prop);
2545 const char *program =
2547 "ds = args['dataset']\n"
2548 "prop = args['property']\n"
2549 "value, setpoint = zfs.get_prop(ds, prop)\n"
2550 "return {value=value, setpoint=setpoint}\n";
2553 nvlist_t *argnvl = fnvlist_alloc();
2555 fnvlist_add_string(argnvl, "dataset", zhp->zfs_name);
2556 fnvlist_add_string(argnvl, "property", zfs_prop_to_name(prop));
2558 error = lzc_channel_program_nosync(poolname, program,
2559 10 * 1000 * 1000, 10 * 1024 * 1024, argnvl, &outnvl);
2562 retnvl = fnvlist_lookup_nvlist(outnvl, "return");
2563 if (zfs_prop_get_type(prop) == PROP_TYPE_NUMBER) {
2565 error = nvlist_lookup_int64(retnvl, "value", &ans);
2567 (void) fprintf(stderr, "%s: zcp check error: "
2568 "%u\n", prop_name, error);
2571 if (ans != intval) {
2572 (void) fprintf(stderr, "%s: zfs found %llu, "
2573 "but zcp found %llu\n", prop_name,
2574 (u_longlong_t)intval, (u_longlong_t)ans);
2578 error = nvlist_lookup_string(retnvl, "value", &str_ans);
2580 (void) fprintf(stderr, "%s: zcp check error: "
2581 "%u\n", prop_name, error);
2584 if (strcmp(strval, str_ans) != 0) {
2585 (void) fprintf(stderr,
2586 "%s: zfs found '%s', but zcp found '%s'\n",
2587 prop_name, strval, str_ans);
2591 (void) fprintf(stderr, "%s: zcp check failed, channel program "
2592 "error: %u\n", prop_name, error);
2594 nvlist_free(argnvl);
2595 nvlist_free(outnvl);
2599 * Retrieve a property from the given object.
2602 * src : On call, this must contain the bitmap of ZPROP_SRC_* types to
2603 * query. Properties whose values come from a different source
2604 * may not be returned. NULL will be treated as ZPROP_SRC_ALL. On
2605 * return, if not NULL, this variable will contain the source for
2606 * the queried property.
2607 * literal : If specified, then numbers are left as exact values. Otherwise,
2608 * they are converted to a human-readable form.
2610 * Returns 0 on success, or -1 on error.
2613 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2614 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2616 char *source = NULL;
2620 boolean_t received = zfs_is_recvd_props_mode(zhp);
2623 * Check to see if this property applies to our object
2625 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE))
2628 if (received && zfs_prop_readonly(prop))
2632 case ZFS_PROP_CREATION:
2634 * 'creation' is a time_t stored in the statistics. We convert
2635 * this into a string unless 'literal' is specified.
2638 val = getprop_uint64(zhp, prop, &source);
2639 time_t time = (time_t)val;
2643 localtime_r(&time, &t) == NULL ||
2644 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2646 (void) snprintf(propbuf, proplen, "%llu",
2649 zcp_check(zhp, prop, val, NULL);
2652 case ZFS_PROP_MOUNTPOINT:
2654 * Getting the precise mountpoint can be tricky.
2656 * - for 'none' or 'legacy', return those values.
2657 * - for inherited mountpoints, we want to take everything
2658 * after our ancestor and append it to the inherited value.
2660 * If the pool has an alternate root, we want to prepend that
2661 * root to any values we return.
2664 str = getprop_string(zhp, prop, &source);
2666 if (str[0] == '/') {
2667 char buf[MAXPATHLEN];
2669 const char *relpath;
2672 * If we inherit the mountpoint, even from a dataset
2673 * with a received value, the source will be the path of
2674 * the dataset we inherit from. If source is
2675 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2678 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2681 relpath = zhp->zfs_name + strlen(source);
2682 if (relpath[0] == '/')
2686 if ((zpool_get_prop(zhp->zpool_hdl,
2687 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2688 B_FALSE)) || (strcmp(root, "-") == 0))
2691 * Special case an alternate root of '/'. This will
2692 * avoid having multiple leading slashes in the
2695 if (strcmp(root, "/") == 0)
2699 * If the mountpoint is '/' then skip over this
2700 * if we are obtaining either an alternate root or
2701 * an inherited mountpoint.
2703 if (str[1] == '\0' && (root[0] != '\0' ||
2704 relpath[0] != '\0'))
2707 if (relpath[0] == '\0')
2708 (void) snprintf(propbuf, proplen, "%s%s",
2711 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2712 root, str, relpath[0] == '@' ? "" : "/",
2715 /* 'legacy' or 'none' */
2716 (void) strlcpy(propbuf, str, proplen);
2718 zcp_check(zhp, prop, 0, propbuf);
2721 case ZFS_PROP_ORIGIN:
2722 str = getprop_string(zhp, prop, &source);
2725 (void) strlcpy(propbuf, str, proplen);
2726 zcp_check(zhp, prop, 0, str);
2729 case ZFS_PROP_REDACT_SNAPS:
2730 if (get_rsnaps_string(zhp, propbuf, proplen) != 0)
2734 case ZFS_PROP_CLONES:
2735 if (get_clones_string(zhp, propbuf, proplen) != 0)
2739 case ZFS_PROP_QUOTA:
2740 case ZFS_PROP_REFQUOTA:
2741 case ZFS_PROP_RESERVATION:
2742 case ZFS_PROP_REFRESERVATION:
2744 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2747 * If quota or reservation is 0, we translate this into 'none'
2748 * (unless literal is set), and indicate that it's the default
2749 * value. Otherwise, we print the number nicely and indicate
2750 * that its set locally.
2754 (void) strlcpy(propbuf, "0", proplen);
2756 (void) strlcpy(propbuf, "none", proplen);
2759 (void) snprintf(propbuf, proplen, "%llu",
2762 zfs_nicebytes(val, propbuf, proplen);
2764 zcp_check(zhp, prop, val, NULL);
2767 case ZFS_PROP_FILESYSTEM_LIMIT:
2768 case ZFS_PROP_SNAPSHOT_LIMIT:
2769 case ZFS_PROP_FILESYSTEM_COUNT:
2770 case ZFS_PROP_SNAPSHOT_COUNT:
2772 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2776 * If limit is UINT64_MAX, we translate this into 'none' (unless
2777 * literal is set), and indicate that it's the default value.
2778 * Otherwise, we print the number nicely and indicate that it's
2782 (void) snprintf(propbuf, proplen, "%llu",
2784 } else if (val == UINT64_MAX) {
2785 (void) strlcpy(propbuf, "none", proplen);
2787 zfs_nicenum(val, propbuf, proplen);
2790 zcp_check(zhp, prop, val, NULL);
2793 case ZFS_PROP_REFRATIO:
2794 case ZFS_PROP_COMPRESSRATIO:
2795 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2798 (void) snprintf(propbuf, proplen, "%llu.%02llu",
2799 (u_longlong_t)(val / 100),
2800 (u_longlong_t)(val % 100));
2802 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2803 (u_longlong_t)(val / 100),
2804 (u_longlong_t)(val % 100));
2805 zcp_check(zhp, prop, val, NULL);
2809 switch (zhp->zfs_type) {
2810 case ZFS_TYPE_FILESYSTEM:
2813 case ZFS_TYPE_VOLUME:
2816 case ZFS_TYPE_SNAPSHOT:
2819 case ZFS_TYPE_BOOKMARK:
2825 (void) snprintf(propbuf, proplen, "%s", str);
2826 zcp_check(zhp, prop, 0, propbuf);
2829 case ZFS_PROP_MOUNTED:
2831 * The 'mounted' property is a pseudo-property that described
2832 * whether the filesystem is currently mounted. Even though
2833 * it's a boolean value, the typical values of "on" and "off"
2834 * don't make sense, so we translate to "yes" and "no".
2836 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2837 src, &source, &val) != 0)
2840 (void) strlcpy(propbuf, "yes", proplen);
2842 (void) strlcpy(propbuf, "no", proplen);
2847 * The 'name' property is a pseudo-property derived from the
2848 * dataset name. It is presented as a real property to simplify
2851 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2852 zcp_check(zhp, prop, 0, propbuf);
2855 case ZFS_PROP_MLSLABEL:
2857 #ifdef HAVE_MLSLABEL
2858 m_label_t *new_sl = NULL;
2859 char *ascii = NULL; /* human readable label */
2861 (void) strlcpy(propbuf,
2862 getprop_string(zhp, prop, &source), proplen);
2864 if (literal || (strcasecmp(propbuf,
2865 ZFS_MLSLABEL_DEFAULT) == 0))
2869 * Try to translate the internal hex string to
2870 * human-readable output. If there are any
2871 * problems just use the hex string.
2874 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2875 L_NO_CORRECTION, NULL) == -1) {
2876 m_label_free(new_sl);
2880 if (label_to_str(new_sl, &ascii, M_LABEL,
2884 m_label_free(new_sl);
2887 m_label_free(new_sl);
2889 (void) strlcpy(propbuf, ascii, proplen);
2892 (void) strlcpy(propbuf,
2893 getprop_string(zhp, prop, &source), proplen);
2894 #endif /* HAVE_MLSLABEL */
2899 case ZFS_PROP_CREATETXG:
2900 case ZFS_PROP_OBJSETID:
2901 case ZFS_PROP_PBKDF2_ITERS:
2903 * These properties are stored as numbers, but they are
2904 * identifiers or counters.
2905 * We don't want them to be pretty printed, because pretty
2906 * printing truncates their values making them useless.
2908 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2910 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2911 zcp_check(zhp, prop, val, NULL);
2914 case ZFS_PROP_REFERENCED:
2915 case ZFS_PROP_AVAILABLE:
2917 case ZFS_PROP_USEDSNAP:
2918 case ZFS_PROP_USEDDS:
2919 case ZFS_PROP_USEDREFRESERV:
2920 case ZFS_PROP_USEDCHILD:
2921 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2924 (void) snprintf(propbuf, proplen, "%llu",
2927 zfs_nicebytes(val, propbuf, proplen);
2929 zcp_check(zhp, prop, val, NULL);
2933 switch (zfs_prop_get_type(prop)) {
2934 case PROP_TYPE_NUMBER:
2935 if (get_numeric_property(zhp, prop, src,
2936 &source, &val) != 0) {
2941 (void) snprintf(propbuf, proplen, "%llu",
2944 zfs_nicenum(val, propbuf, proplen);
2946 zcp_check(zhp, prop, val, NULL);
2949 case PROP_TYPE_STRING:
2950 str = getprop_string(zhp, prop, &source);
2954 (void) strlcpy(propbuf, str, proplen);
2955 zcp_check(zhp, prop, 0, str);
2958 case PROP_TYPE_INDEX:
2959 if (get_numeric_property(zhp, prop, src,
2960 &source, &val) != 0)
2962 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2965 (void) strlcpy(propbuf, strval, proplen);
2966 zcp_check(zhp, prop, 0, strval);
2974 get_source(zhp, src, source, statbuf, statlen);
2980 * Utility function to get the given numeric property. Does no validation that
2981 * the given property is the appropriate type; should only be used with
2982 * hard-coded property types.
2985 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2990 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2996 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
3000 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
3001 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
3005 * Similar to zfs_prop_get(), but returns the value as an integer.
3008 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
3009 zprop_source_t *src, char *statbuf, size_t statlen)
3014 * Check to see if this property applies to our object
3016 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE)) {
3017 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
3018 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
3019 zfs_prop_to_name(prop)));
3023 *src = ZPROP_SRC_NONE;
3025 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
3028 get_source(zhp, src, source, statbuf, statlen);
3035 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
3036 char **domainp, idmap_rid_t *ridp)
3038 idmap_get_handle_t *get_hdl = NULL;
3042 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
3046 err = idmap_get_sidbyuid(get_hdl, id,
3047 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
3049 err = idmap_get_sidbygid(get_hdl, id,
3050 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
3052 if (err == IDMAP_SUCCESS &&
3053 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
3054 status == IDMAP_SUCCESS)
3060 idmap_get_destroy(get_hdl);
3063 #endif /* HAVE_IDMAP */
3066 * convert the propname into parameters needed by kernel
3067 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
3068 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
3069 * Eg: groupquota@staff -> ZFS_PROP_GROUPQUOTA, "", 1234
3070 * Eg: groupused@staff -> ZFS_PROP_GROUPUSED, "", 1234
3071 * Eg: projectquota@123 -> ZFS_PROP_PROJECTQUOTA, "", 123
3072 * Eg: projectused@789 -> ZFS_PROP_PROJECTUSED, "", 789
3075 userquota_propname_decode(const char *propname, boolean_t zoned,
3076 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
3078 zfs_userquota_prop_t type;
3082 boolean_t isproject;
3088 /* Figure out the property type ({user|group|project}{quota|space}) */
3089 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
3090 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
3091 strlen(zfs_userquota_prop_prefixes[type])) == 0)
3094 if (type == ZFS_NUM_USERQUOTA_PROPS)
3098 isuser = (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_USERUSED ||
3099 type == ZFS_PROP_USEROBJQUOTA ||
3100 type == ZFS_PROP_USEROBJUSED);
3101 isgroup = (type == ZFS_PROP_GROUPQUOTA || type == ZFS_PROP_GROUPUSED ||
3102 type == ZFS_PROP_GROUPOBJQUOTA ||
3103 type == ZFS_PROP_GROUPOBJUSED);
3104 isproject = (type == ZFS_PROP_PROJECTQUOTA ||
3105 type == ZFS_PROP_PROJECTUSED || type == ZFS_PROP_PROJECTOBJQUOTA ||
3106 type == ZFS_PROP_PROJECTOBJUSED);
3108 cp = strchr(propname, '@') + 1;
3110 if (isuser && (pw = getpwnam(cp)) != NULL) {
3111 if (zoned && getzoneid() == GLOBAL_ZONEID)
3114 } else if (isgroup && (gr = getgrnam(cp)) != NULL) {
3115 if (zoned && getzoneid() == GLOBAL_ZONEID)
3118 } else if (!isproject && strchr(cp, '@')) {
3121 * It's a SID name (eg "user@domain") that needs to be
3122 * turned into S-1-domainID-RID.
3124 directory_error_t e;
3125 char *numericsid = NULL;
3128 if (zoned && getzoneid() == GLOBAL_ZONEID)
3131 e = directory_sid_from_user_name(NULL,
3134 e = directory_sid_from_group_name(NULL,
3138 directory_error_free(e);
3141 if (numericsid == NULL)
3144 (void) strlcpy(domain, cp, domainlen);
3145 cp = strrchr(domain, '-');
3150 *ridp = strtoull(cp, &end, 10);
3153 if (errno != 0 || *end != '\0')
3157 #endif /* HAVE_IDMAP */
3159 /* It's a user/group/project ID (eg "12345"). */
3162 id = strtoul(cp, &end, 10);
3165 if (id > MAXUID && !isproject) {
3167 /* It's an ephemeral ID. */
3171 if (idmap_id_to_numeric_domain_rid(id, isuser,
3172 &mapdomain, &rid) != 0)
3174 (void) strlcpy(domain, mapdomain, domainlen);
3178 #endif /* HAVE_IDMAP */
3188 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
3189 uint64_t *propvalue, zfs_userquota_prop_t *typep)
3192 zfs_cmd_t zc = {"\0"};
3194 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3196 err = userquota_propname_decode(propname,
3197 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
3198 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
3199 zc.zc_objset_type = *typep;
3203 err = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_USERSPACE_ONE, &zc);
3207 *propvalue = zc.zc_cookie;
3212 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
3213 uint64_t *propvalue)
3215 zfs_userquota_prop_t type;
3217 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
3222 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
3223 char *propbuf, int proplen, boolean_t literal)
3227 zfs_userquota_prop_t type;
3229 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
3236 (void) snprintf(propbuf, proplen, "%llu",
3237 (u_longlong_t)propvalue);
3238 } else if (propvalue == 0 &&
3239 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA ||
3240 type == ZFS_PROP_USEROBJQUOTA || type == ZFS_PROP_GROUPOBJQUOTA ||
3241 type == ZFS_PROP_PROJECTQUOTA ||
3242 type == ZFS_PROP_PROJECTOBJQUOTA)) {
3243 (void) strlcpy(propbuf, "none", proplen);
3244 } else if (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA ||
3245 type == ZFS_PROP_USERUSED || type == ZFS_PROP_GROUPUSED ||
3246 type == ZFS_PROP_PROJECTUSED || type == ZFS_PROP_PROJECTQUOTA) {
3247 zfs_nicebytes(propvalue, propbuf, proplen);
3249 zfs_nicenum(propvalue, propbuf, proplen);
3255 * propname must start with "written@" or "written#".
3258 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
3259 uint64_t *propvalue)
3262 zfs_cmd_t zc = {"\0"};
3263 const char *snapname;
3265 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3267 assert(zfs_prop_written(propname));
3268 snapname = propname + strlen("written@");
3269 if (strchr(snapname, '@') != NULL || strchr(snapname, '#') != NULL) {
3270 /* full snapshot or bookmark name specified */
3271 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
3273 /* snapname is the short name, append it to zhp's fsname */
3276 (void) strlcpy(zc.zc_value, zhp->zfs_name,
3277 sizeof (zc.zc_value));
3278 cp = strchr(zc.zc_value, '@');
3281 (void) strlcat(zc.zc_value, snapname - 1, sizeof (zc.zc_value));
3284 err = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_SPACE_WRITTEN, &zc);
3288 *propvalue = zc.zc_cookie;
3293 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
3294 char *propbuf, int proplen, boolean_t literal)
3299 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
3305 (void) snprintf(propbuf, proplen, "%llu",
3306 (u_longlong_t)propvalue);
3308 zfs_nicebytes(propvalue, propbuf, proplen);
3315 * Returns the name of the given zfs handle.
3318 zfs_get_name(const zfs_handle_t *zhp)
3320 return (zhp->zfs_name);
3324 * Returns the name of the parent pool for the given zfs handle.
3327 zfs_get_pool_name(const zfs_handle_t *zhp)
3329 return (zhp->zpool_hdl->zpool_name);
3333 * Returns the type of the given zfs handle.
3336 zfs_get_type(const zfs_handle_t *zhp)
3338 return (zhp->zfs_type);
3342 * Is one dataset name a child dataset of another?
3344 * Needs to handle these cases:
3345 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
3346 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
3347 * Descendant? No. No. No. Yes.
3350 is_descendant(const char *ds1, const char *ds2)
3352 size_t d1len = strlen(ds1);
3354 /* ds2 can't be a descendant if it's smaller */
3355 if (strlen(ds2) < d1len)
3358 /* otherwise, compare strings and verify that there's a '/' char */
3359 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
3363 * Given a complete name, return just the portion that refers to the parent.
3364 * Will return -1 if there is no parent (path is just the name of the
3368 parent_name(const char *path, char *buf, size_t buflen)
3372 (void) strlcpy(buf, path, buflen);
3374 if ((slashp = strrchr(buf, '/')) == NULL)
3382 zfs_parent_name(zfs_handle_t *zhp, char *buf, size_t buflen)
3384 return (parent_name(zfs_get_name(zhp), buf, buflen));
3388 * If accept_ancestor is false, then check to make sure that the given path has
3389 * a parent, and that it exists. If accept_ancestor is true, then find the
3390 * closest existing ancestor for the given path. In prefixlen return the
3391 * length of already existing prefix of the given path. We also fetch the
3392 * 'zoned' property, which is used to validate property settings when creating
3396 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
3397 boolean_t accept_ancestor, int *prefixlen)
3399 zfs_cmd_t zc = {"\0"};
3400 char parent[ZFS_MAX_DATASET_NAME_LEN];
3406 (void) snprintf(errbuf, sizeof (errbuf),
3407 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
3409 /* get parent, and check to see if this is just a pool */
3410 if (parent_name(path, parent, sizeof (parent)) != 0) {
3411 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3412 "missing dataset name"));
3413 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3416 /* check to see if the pool exists */
3417 if ((slash = strchr(parent, '/')) == NULL)
3418 slash = parent + strlen(parent);
3419 (void) strncpy(zc.zc_name, parent, slash - parent);
3420 zc.zc_name[slash - parent] = '\0';
3421 if (zfs_ioctl(hdl, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
3423 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3424 "no such pool '%s'"), zc.zc_name);
3425 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3428 /* check to see if the parent dataset exists */
3429 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
3430 if (errno == ENOENT && accept_ancestor) {
3432 * Go deeper to find an ancestor, give up on top level.
3434 if (parent_name(parent, parent, sizeof (parent)) != 0) {
3435 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3436 "no such pool '%s'"), zc.zc_name);
3437 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3439 } else if (errno == ENOENT) {
3440 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3441 "parent does not exist"));
3442 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3444 return (zfs_standard_error(hdl, errno, errbuf));
3447 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
3451 /* we are in a non-global zone, but parent is in the global zone */
3452 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
3453 (void) zfs_standard_error(hdl, EPERM, errbuf);
3458 /* make sure parent is a filesystem */
3459 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
3460 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3461 "parent is not a filesystem"));
3462 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
3468 if (prefixlen != NULL)
3469 *prefixlen = strlen(parent);
3474 * Finds whether the dataset of the given type(s) exists.
3477 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
3481 if (!zfs_validate_name(hdl, path, types, B_FALSE))
3485 * Try to get stats for the dataset, which will tell us if it exists.
3487 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
3488 int ds_type = zhp->zfs_type;
3491 if (types & ds_type)
3498 * Given a path to 'target', create all the ancestors between
3499 * the prefixlen portion of the path, and the target itself.
3500 * Fail if the initial prefixlen-ancestor does not already exist.
3503 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
3509 /* make sure prefix exists */
3510 cp = target + prefixlen;
3512 assert(strchr(cp, '/') == NULL);
3513 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3516 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3524 * Attempt to create, mount, and share any ancestor filesystems,
3525 * up to the prefixlen-long one.
3527 for (cp = target + prefixlen + 1;
3528 (cp = strchr(cp, '/')) != NULL; *cp = '/', cp++) {
3532 h = make_dataset_handle(hdl, target);
3534 /* it already exists, nothing to do here */
3539 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
3541 opname = dgettext(TEXT_DOMAIN, "create");
3545 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3547 opname = dgettext(TEXT_DOMAIN, "open");
3551 if (zfs_mount(h, NULL, 0) != 0) {
3552 opname = dgettext(TEXT_DOMAIN, "mount");
3556 if (zfs_share(h) != 0) {
3557 opname = dgettext(TEXT_DOMAIN, "share");
3563 zfs_commit_all_shares();
3568 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3569 "failed to %s ancestor '%s'"), opname, target);
3574 * Creates non-existing ancestors of the given path.
3577 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
3584 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3585 "cannot create '%s'"), path);
3588 * Check that we are not passing the nesting limit
3589 * before we start creating any ancestors.
3591 if (dataset_nestcheck(path) != 0) {
3592 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3593 "maximum name nesting depth exceeded"));
3594 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3597 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
3600 if ((path_copy = strdup(path)) != NULL) {
3601 rc = create_parents(hdl, path_copy, prefix);
3604 if (path_copy == NULL || rc != 0)
3611 * Create a new filesystem or volume.
3614 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
3619 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
3621 enum lzc_dataset_type ost;
3622 zpool_handle_t *zpool_handle;
3623 uint8_t *wkeydata = NULL;
3626 char parent[ZFS_MAX_DATASET_NAME_LEN];
3628 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3629 "cannot create '%s'"), path);
3631 /* validate the path, taking care to note the extended error message */
3632 if (!zfs_validate_name(hdl, path, type, B_TRUE))
3633 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3635 if (dataset_nestcheck(path) != 0) {
3636 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3637 "maximum name nesting depth exceeded"));
3638 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3641 /* validate parents exist */
3642 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
3646 * The failure modes when creating a dataset of a different type over
3647 * one that already exists is a little strange. In particular, if you
3648 * try to create a dataset on top of an existing dataset, the ioctl()
3649 * will return ENOENT, not EEXIST. To prevent this from happening, we
3650 * first try to see if the dataset exists.
3652 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
3653 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3654 "dataset already exists"));
3655 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3658 if (type == ZFS_TYPE_VOLUME)
3659 ost = LZC_DATSET_TYPE_ZVOL;
3661 ost = LZC_DATSET_TYPE_ZFS;
3663 /* open zpool handle for prop validation */
3664 char pool_path[ZFS_MAX_DATASET_NAME_LEN];
3665 (void) strlcpy(pool_path, path, sizeof (pool_path));
3667 /* truncate pool_path at first slash */
3668 char *p = strchr(pool_path, '/');
3672 if ((zpool_handle = zpool_open(hdl, pool_path)) == NULL)
3675 if (props && (props = zfs_valid_proplist(hdl, type, props,
3676 zoned, NULL, zpool_handle, B_TRUE, errbuf)) == 0) {
3677 zpool_close(zpool_handle);
3680 zpool_close(zpool_handle);
3682 if (type == ZFS_TYPE_VOLUME) {
3684 * If we are creating a volume, the size and block size must
3685 * satisfy a few restraints. First, the blocksize must be a
3686 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3687 * volsize must be a multiple of the block size, and cannot be
3690 if (props == NULL || nvlist_lookup_uint64(props,
3691 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3693 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3694 "missing volume size"));
3695 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3698 if ((ret = nvlist_lookup_uint64(props,
3699 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3700 &blocksize)) != 0) {
3701 if (ret == ENOENT) {
3702 blocksize = zfs_prop_default_numeric(
3703 ZFS_PROP_VOLBLOCKSIZE);
3706 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3707 "missing volume block size"));
3708 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3714 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3715 "volume size cannot be zero"));
3716 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3719 if (size % blocksize != 0) {
3721 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3722 "volume size must be a multiple of volume block "
3724 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3728 (void) parent_name(path, parent, sizeof (parent));
3729 if (zfs_crypto_create(hdl, parent, props, NULL, B_TRUE,
3730 &wkeydata, &wkeylen) != 0) {
3732 return (zfs_error(hdl, EZFS_CRYPTOFAILED, errbuf));
3735 /* create the dataset */
3736 ret = lzc_create(path, ost, props, wkeydata, wkeylen);
3738 if (wkeydata != NULL)
3741 /* check for failure */
3745 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3746 "no such parent '%s'"), parent);
3747 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3750 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3751 "pool must be upgraded to set this "
3752 "property or value"));
3753 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3756 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3757 "encryption root's key is not loaded "
3759 return (zfs_error(hdl, EZFS_CRYPTOFAILED, errbuf));
3762 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3763 "invalid property value(s) specified"));
3764 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3768 * This platform can't address a volume this big.
3770 if (type == ZFS_TYPE_VOLUME)
3771 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3776 return (zfs_standard_error(hdl, errno, errbuf));
3784 * Destroys the given dataset. The caller must make sure that the filesystem
3785 * isn't mounted, and that there are no active dependents. If the file system
3786 * does not exist this function does nothing.
3789 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3793 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT && defer)
3796 if (zhp->zfs_type == ZFS_TYPE_BOOKMARK) {
3797 nvlist_t *nv = fnvlist_alloc();
3798 fnvlist_add_boolean(nv, zhp->zfs_name);
3799 error = lzc_destroy_bookmarks(nv, NULL);
3802 return (zfs_standard_error_fmt(zhp->zfs_hdl, error,
3803 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3809 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3810 nvlist_t *nv = fnvlist_alloc();
3811 fnvlist_add_boolean(nv, zhp->zfs_name);
3812 error = lzc_destroy_snaps(nv, defer, NULL);
3815 error = lzc_destroy(zhp->zfs_name);
3818 if (error != 0 && error != ENOENT) {
3819 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3820 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3824 remove_mountpoint(zhp);
3829 struct destroydata {
3831 const char *snapname;
3835 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3837 struct destroydata *dd = arg;
3838 char name[ZFS_MAX_DATASET_NAME_LEN];
3841 if (snprintf(name, sizeof (name), "%s@%s", zhp->zfs_name,
3842 dd->snapname) >= sizeof (name))
3845 if (lzc_exists(name))
3846 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3848 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3854 * Destroys all snapshots with the given name in zhp & descendants.
3857 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3860 struct destroydata dd = { 0 };
3862 dd.snapname = snapname;
3863 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3864 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3866 if (nvlist_empty(dd.nvl)) {
3867 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3868 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3869 zhp->zfs_name, snapname);
3871 ret = zfs_destroy_snaps_nvl(zhp->zfs_hdl, dd.nvl, defer);
3873 nvlist_free(dd.nvl);
3878 * Destroys all the snapshots named in the nvlist.
3881 zfs_destroy_snaps_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, boolean_t defer)
3884 nvlist_t *errlist = NULL;
3887 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3890 nvlist_free(errlist);
3894 if (nvlist_empty(errlist)) {
3896 (void) snprintf(errbuf, sizeof (errbuf),
3897 dgettext(TEXT_DOMAIN, "cannot destroy snapshots"));
3899 ret = zfs_standard_error(hdl, ret, errbuf);
3901 for (pair = nvlist_next_nvpair(errlist, NULL);
3902 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3904 (void) snprintf(errbuf, sizeof (errbuf),
3905 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3908 switch (fnvpair_value_int32(pair)) {
3911 dgettext(TEXT_DOMAIN, "snapshot is cloned"));
3912 ret = zfs_error(hdl, EZFS_EXISTS, errbuf);
3915 ret = zfs_standard_error(hdl, errno, errbuf);
3920 nvlist_free(errlist);
3925 * Clones the given dataset. The target must be of the same type as the source.
3928 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3930 char parent[ZFS_MAX_DATASET_NAME_LEN];
3933 libzfs_handle_t *hdl = zhp->zfs_hdl;
3936 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3938 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3939 "cannot create '%s'"), target);
3941 /* validate the target/clone name */
3942 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3943 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3945 /* validate parents exist */
3946 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3949 (void) parent_name(target, parent, sizeof (parent));
3956 if (ZFS_IS_VOLUME(zhp)) {
3957 type = ZFS_TYPE_VOLUME;
3959 type = ZFS_TYPE_FILESYSTEM;
3961 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3962 zhp, zhp->zpool_hdl, B_TRUE, errbuf)) == NULL)
3964 if (zfs_fix_auto_resv(zhp, props) == -1) {
3970 if (zfs_crypto_clone_check(hdl, zhp, parent, props) != 0) {
3972 return (zfs_error(hdl, EZFS_CRYPTOFAILED, errbuf));
3975 ret = lzc_clone(target, zhp->zfs_name, props);
3983 * The parent doesn't exist. We should have caught this
3984 * above, but there may a race condition that has since
3985 * destroyed the parent.
3987 * At this point, we don't know whether it's the source
3988 * that doesn't exist anymore, or whether the target
3989 * dataset doesn't exist.
3991 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3992 "no such parent '%s'"), parent);
3993 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3996 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3997 "source and target pools differ"));
3998 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
4002 return (zfs_standard_error(zhp->zfs_hdl, errno,
4011 * Promotes the given clone fs to be the clone parent.
4014 zfs_promote(zfs_handle_t *zhp)
4016 libzfs_handle_t *hdl = zhp->zfs_hdl;
4017 char snapname[ZFS_MAX_DATASET_NAME_LEN];
4021 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4022 "cannot promote '%s'"), zhp->zfs_name);
4024 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
4025 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4026 "snapshots can not be promoted"));
4027 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4030 if (zhp->zfs_dmustats.dds_origin[0] == '\0') {
4031 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4032 "not a cloned filesystem"));
4033 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4036 if (!zfs_validate_name(hdl, zhp->zfs_name, zhp->zfs_type, B_TRUE))
4037 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4039 ret = lzc_promote(zhp->zfs_name, snapname, sizeof (snapname));
4045 * Promoting encrypted dataset outside its
4048 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4049 "cannot promote dataset outside its "
4050 "encryption root"));
4051 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
4054 /* There is a conflicting snapshot name. */
4055 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4056 "conflicting snapshot '%s' from parent '%s'"),
4057 snapname, zhp->zfs_dmustats.dds_origin);
4058 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
4061 return (zfs_standard_error(hdl, ret, errbuf));
4067 typedef struct snapdata {
4069 const char *sd_snapname;
4073 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
4075 snapdata_t *sd = arg;
4076 char name[ZFS_MAX_DATASET_NAME_LEN];
4079 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) == 0) {
4080 if (snprintf(name, sizeof (name), "%s@%s", zfs_get_name(zhp),
4081 sd->sd_snapname) >= sizeof (name))
4084 fnvlist_add_boolean(sd->sd_nvl, name);
4086 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
4094 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
4098 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
4104 zpool_handle_t *zpool_hdl;
4105 char pool[ZFS_MAX_DATASET_NAME_LEN];
4107 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4108 "cannot create snapshots "));
4111 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
4112 const char *snapname = nvpair_name(elem);
4114 /* validate the target name */
4115 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
4117 (void) snprintf(errbuf, sizeof (errbuf),
4118 dgettext(TEXT_DOMAIN,
4119 "cannot create snapshot '%s'"), snapname);
4120 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4125 * get pool handle for prop validation. assumes all snaps are in the
4126 * same pool, as does lzc_snapshot (below).
4128 elem = nvlist_next_nvpair(snaps, NULL);
4129 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
4130 pool[strcspn(pool, "/@")] = '\0';
4131 zpool_hdl = zpool_open(hdl, pool);
4132 if (zpool_hdl == NULL)
4135 if (props != NULL &&
4136 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
4137 props, B_FALSE, NULL, zpool_hdl, B_FALSE, errbuf)) == NULL) {
4138 zpool_close(zpool_hdl);
4141 zpool_close(zpool_hdl);
4143 ret = lzc_snapshot(snaps, props, &errors);
4146 boolean_t printed = B_FALSE;
4147 for (elem = nvlist_next_nvpair(errors, NULL);
4149 elem = nvlist_next_nvpair(errors, elem)) {
4150 (void) snprintf(errbuf, sizeof (errbuf),
4151 dgettext(TEXT_DOMAIN,
4152 "cannot create snapshot '%s'"), nvpair_name(elem));
4153 (void) zfs_standard_error(hdl,
4154 fnvpair_value_int32(elem), errbuf);
4160 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4161 "multiple snapshots of same "
4163 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
4167 (void) zfs_standard_error(hdl, ret, errbuf);
4173 nvlist_free(errors);
4178 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
4182 snapdata_t sd = { 0 };
4183 char fsname[ZFS_MAX_DATASET_NAME_LEN];
4188 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4189 "cannot snapshot %s"), path);
4191 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
4192 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4194 (void) strlcpy(fsname, path, sizeof (fsname));
4195 cp = strchr(fsname, '@');
4197 sd.sd_snapname = cp + 1;
4199 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
4200 ZFS_TYPE_VOLUME)) == NULL) {
4204 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
4206 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
4208 fnvlist_add_boolean(sd.sd_nvl, path);
4211 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
4212 nvlist_free(sd.sd_nvl);
4218 * Destroy any more recent snapshots. We invoke this callback on any dependents
4219 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
4220 * is a dependent and we should just destroy it without checking the transaction
4223 typedef struct rollback_data {
4224 const char *cb_target; /* the snapshot */
4225 uint64_t cb_create; /* creation time reference */
4231 rollback_destroy_dependent(zfs_handle_t *zhp, void *data)
4233 rollback_data_t *cbp = data;
4234 prop_changelist_t *clp;
4236 /* We must destroy this clone; first unmount it */
4237 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
4238 cbp->cb_force ? MS_FORCE: 0);
4239 if (clp == NULL || changelist_prefix(clp) != 0) {
4240 cbp->cb_error = B_TRUE;
4244 if (zfs_destroy(zhp, B_FALSE) != 0)
4245 cbp->cb_error = B_TRUE;
4247 changelist_remove(clp, zhp->zfs_name);
4248 (void) changelist_postfix(clp);
4249 changelist_free(clp);
4256 rollback_destroy(zfs_handle_t *zhp, void *data)
4258 rollback_data_t *cbp = data;
4260 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > cbp->cb_create) {
4261 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
4262 rollback_destroy_dependent, cbp);
4264 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
4272 * Given a dataset, rollback to a specific snapshot, discarding any
4273 * data changes since then and making it the active dataset.
4275 * Any snapshots and bookmarks more recent than the target are
4276 * destroyed, along with their dependents (i.e. clones).
4279 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
4281 rollback_data_t cb = { 0 };
4283 boolean_t restore_resv = 0;
4284 uint64_t old_volsize = 0, new_volsize;
4285 zfs_prop_t resv_prop = { 0 };
4286 uint64_t min_txg = 0;
4288 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
4289 zhp->zfs_type == ZFS_TYPE_VOLUME);
4292 * Destroy all recent snapshots and their dependents.
4294 cb.cb_force = force;
4295 cb.cb_target = snap->zfs_name;
4296 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
4298 if (cb.cb_create > 0)
4299 min_txg = cb.cb_create;
4301 (void) zfs_iter_snapshots(zhp, B_FALSE, rollback_destroy, &cb,
4304 (void) zfs_iter_bookmarks(zhp, rollback_destroy, &cb);
4310 * Now that we have verified that the snapshot is the latest,
4311 * rollback to the given snapshot.
4314 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
4315 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
4317 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
4319 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
4323 * Pass both the filesystem and the wanted snapshot names,
4324 * we would get an error back if the snapshot is destroyed or
4325 * a new snapshot is created before this request is processed.
4327 err = lzc_rollback_to(zhp->zfs_name, snap->zfs_name);
4331 (void) snprintf(errbuf, sizeof (errbuf),
4332 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
4336 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
4337 "there is a snapshot or bookmark more recent "
4338 "than '%s'"), snap->zfs_name);
4339 (void) zfs_error(zhp->zfs_hdl, EZFS_EXISTS, errbuf);
4342 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
4343 "'%s' is not found among snapshots of '%s'"),
4344 snap->zfs_name, zhp->zfs_name);
4345 (void) zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf);
4348 (void) zfs_error(zhp->zfs_hdl, EZFS_BADTYPE, errbuf);
4351 (void) zfs_standard_error(zhp->zfs_hdl, err, errbuf);
4357 * For volumes, if the pre-rollback volsize matched the pre-
4358 * rollback reservation and the volsize has changed then set
4359 * the reservation property to the post-rollback volsize.
4360 * Make a new handle since the rollback closed the dataset.
4362 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
4363 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
4365 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
4366 if (old_volsize != new_volsize)
4367 err = zfs_prop_set_int(zhp, resv_prop,
4376 * Renames the given dataset.
4379 zfs_rename(zfs_handle_t *zhp, const char *target, renameflags_t flags)
4382 zfs_cmd_t zc = {"\0"};
4384 prop_changelist_t *cl = NULL;
4385 char parent[ZFS_MAX_DATASET_NAME_LEN];
4386 char property[ZFS_MAXPROPLEN];
4387 libzfs_handle_t *hdl = zhp->zfs_hdl;
4390 /* if we have the same exact name, just return success */
4391 if (strcmp(zhp->zfs_name, target) == 0)
4394 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4395 "cannot rename to '%s'"), target);
4397 /* make sure source name is valid */
4398 if (!zfs_validate_name(hdl, zhp->zfs_name, zhp->zfs_type, B_TRUE))
4399 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4402 * Make sure the target name is valid
4404 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
4405 if ((strchr(target, '@') == NULL) ||
4408 * Snapshot target name is abbreviated,
4409 * reconstruct full dataset name
4411 (void) strlcpy(parent, zhp->zfs_name,
4413 delim = strchr(parent, '@');
4414 if (strchr(target, '@') == NULL)
4418 (void) strlcat(parent, target, sizeof (parent));
4422 * Make sure we're renaming within the same dataset.
4424 delim = strchr(target, '@');
4425 if (strncmp(zhp->zfs_name, target, delim - target)
4426 != 0 || zhp->zfs_name[delim - target] != '@') {
4427 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4428 "snapshots must be part of same "
4430 return (zfs_error(hdl, EZFS_CROSSTARGET,
4435 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
4436 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4438 if (flags.recursive) {
4439 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4440 "recursive rename must be a snapshot"));
4441 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4444 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
4445 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4447 /* validate parents */
4448 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
4451 /* make sure we're in the same pool */
4452 verify((delim = strchr(target, '/')) != NULL);
4453 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
4454 zhp->zfs_name[delim - target] != '/') {
4455 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4456 "datasets must be within same pool"));
4457 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
4460 /* new name cannot be a child of the current dataset name */
4461 if (is_descendant(zhp->zfs_name, target)) {
4462 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4463 "New dataset name cannot be a descendant of "
4464 "current dataset name"));
4465 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4469 (void) snprintf(errbuf, sizeof (errbuf),
4470 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
4472 if (getzoneid() == GLOBAL_ZONEID &&
4473 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
4474 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4475 "dataset is used in a non-global zone"));
4476 return (zfs_error(hdl, EZFS_ZONED, errbuf));
4480 * Avoid unmounting file systems with mountpoint property set to
4481 * 'legacy' or 'none' even if -u option is not given.
4483 if (zhp->zfs_type == ZFS_TYPE_FILESYSTEM &&
4484 !flags.recursive && !flags.nounmount &&
4485 zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, property,
4486 sizeof (property), NULL, NULL, 0, B_FALSE) == 0 &&
4487 (strcmp(property, "legacy") == 0 ||
4488 strcmp(property, "none") == 0)) {
4489 flags.nounmount = B_TRUE;
4491 if (flags.recursive) {
4492 char *parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
4493 if (parentname == NULL) {
4497 delim = strchr(parentname, '@');
4499 zfs_handle_t *zhrp = zfs_open(zhp->zfs_hdl, parentname,
4507 } else if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT) {
4508 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME,
4509 flags.nounmount ? CL_GATHER_DONT_UNMOUNT :
4510 CL_GATHER_ITER_MOUNTED,
4511 flags.forceunmount ? MS_FORCE : 0)) == NULL)
4514 if (changelist_haszonedchild(cl)) {
4515 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4516 "child dataset with inherited mountpoint is used "
4517 "in a non-global zone"));
4518 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
4523 if ((ret = changelist_prefix(cl)) != 0)
4527 if (ZFS_IS_VOLUME(zhp))
4528 zc.zc_objset_type = DMU_OST_ZVOL;
4530 zc.zc_objset_type = DMU_OST_ZFS;
4532 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4533 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
4535 zc.zc_cookie = !!flags.recursive;
4536 zc.zc_cookie |= (!!flags.nounmount) << 1;
4538 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
4540 * if it was recursive, the one that actually failed will
4543 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4544 "cannot rename '%s'"), zc.zc_name);
4546 if (flags.recursive && errno == EEXIST) {
4547 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4548 "a child dataset already has a snapshot "
4549 "with the new name"));
4550 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
4551 } else if (errno == EACCES) {
4552 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4553 "cannot move encrypted child outside of "
4554 "its encryption root"));
4555 (void) zfs_error(hdl, EZFS_CRYPTOFAILED, errbuf);
4557 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
4561 * On failure, we still want to remount any filesystems that
4562 * were previously mounted, so we don't alter the system state.
4565 (void) changelist_postfix(cl);
4568 changelist_rename(cl, zfs_get_name(zhp), target);
4569 ret = changelist_postfix(cl);
4575 changelist_free(cl);
4581 zfs_get_all_props(zfs_handle_t *zhp)
4583 return (zhp->zfs_props);
4587 zfs_get_recvd_props(zfs_handle_t *zhp)
4589 if (zhp->zfs_recvd_props == NULL)
4590 if (get_recvd_props_ioctl(zhp) != 0)
4592 return (zhp->zfs_recvd_props);
4596 zfs_get_user_props(zfs_handle_t *zhp)
4598 return (zhp->zfs_user_props);
4602 * This function is used by 'zfs list' to determine the exact set of columns to
4603 * display, and their maximum widths. This does two main things:
4605 * - If this is a list of all properties, then expand the list to include
4606 * all native properties, and set a flag so that for each dataset we look
4607 * for new unique user properties and add them to the list.
4609 * - For non fixed-width properties, keep track of the maximum width seen
4610 * so that we can size the column appropriately. If the user has
4611 * requested received property values, we also need to compute the width
4612 * of the RECEIVED column.
4615 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received,
4618 libzfs_handle_t *hdl = zhp->zfs_hdl;
4619 zprop_list_t *entry;
4620 zprop_list_t **last, **start;
4621 nvlist_t *userprops, *propval;
4624 char buf[ZFS_MAXPROPLEN];
4626 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
4629 userprops = zfs_get_user_props(zhp);
4632 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
4634 * Go through and add any user properties as necessary. We
4635 * start by incrementing our list pointer to the first
4636 * non-native property.
4639 while (*start != NULL) {
4640 if ((*start)->pl_prop == ZPROP_INVAL)
4642 start = &(*start)->pl_next;
4646 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
4648 * See if we've already found this property in our list.
4650 for (last = start; *last != NULL;
4651 last = &(*last)->pl_next) {
4652 if (strcmp((*last)->pl_user_prop,
4653 nvpair_name(elem)) == 0)
4657 if (*last == NULL) {
4658 if ((entry = zfs_alloc(hdl,
4659 sizeof (zprop_list_t))) == NULL ||
4660 ((entry->pl_user_prop = zfs_strdup(hdl,
4661 nvpair_name(elem)))) == NULL) {
4666 entry->pl_prop = ZPROP_INVAL;
4667 entry->pl_width = strlen(nvpair_name(elem));
4668 entry->pl_all = B_TRUE;
4675 * Now go through and check the width of any non-fixed columns
4677 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
4678 if (entry->pl_fixed && !literal)
4681 if (entry->pl_prop != ZPROP_INVAL) {
4682 if (zfs_prop_get(zhp, entry->pl_prop,
4683 buf, sizeof (buf), NULL, NULL, 0, literal) == 0) {
4684 if (strlen(buf) > entry->pl_width)
4685 entry->pl_width = strlen(buf);
4687 if (received && zfs_prop_get_recvd(zhp,
4688 zfs_prop_to_name(entry->pl_prop),
4689 buf, sizeof (buf), literal) == 0)
4690 if (strlen(buf) > entry->pl_recvd_width)
4691 entry->pl_recvd_width = strlen(buf);
4693 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
4695 verify(nvlist_lookup_string(propval,
4696 ZPROP_VALUE, &strval) == 0);
4697 if (strlen(strval) > entry->pl_width)
4698 entry->pl_width = strlen(strval);
4700 if (received && zfs_prop_get_recvd(zhp,
4701 entry->pl_user_prop,
4702 buf, sizeof (buf), literal) == 0)
4703 if (strlen(buf) > entry->pl_recvd_width)
4704 entry->pl_recvd_width = strlen(buf);
4712 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
4718 * Keep a reference to the props-table against which we prune the
4721 zhp->zfs_props_table = props;
4723 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
4726 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
4727 next = nvlist_next_nvpair(zhp->zfs_props, curr);
4730 * User properties will result in ZPROP_INVAL, and since we
4731 * only know how to prune standard ZFS properties, we always
4732 * leave these in the list. This can also happen if we
4733 * encounter an unknown DSL property (when running older
4734 * software, for example).
4736 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
4737 (void) nvlist_remove(zhp->zfs_props,
4738 nvpair_name(curr), nvpair_type(curr));
4744 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
4745 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
4747 zfs_cmd_t zc = {"\0"};
4748 nvlist_t *nvlist = NULL;
4751 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4752 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4753 zc.zc_cookie = (uint64_t)cmd;
4755 if (cmd == ZFS_SMB_ACL_RENAME) {
4756 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
4757 (void) no_memory(hdl);
4763 case ZFS_SMB_ACL_ADD:
4764 case ZFS_SMB_ACL_REMOVE:
4765 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4767 case ZFS_SMB_ACL_RENAME:
4768 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4770 (void) no_memory(hdl);
4773 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4775 (void) no_memory(hdl);
4778 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4779 nvlist_free(nvlist);
4783 case ZFS_SMB_ACL_PURGE:
4788 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4789 nvlist_free(nvlist);
4794 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4795 char *path, char *resource)
4797 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4802 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4803 char *path, char *resource)
4805 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4810 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4812 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4817 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4818 char *oldname, char *newname)
4820 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4825 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4826 zfs_userspace_cb_t func, void *arg)
4828 zfs_cmd_t zc = {"\0"};
4829 zfs_useracct_t buf[100];
4830 libzfs_handle_t *hdl = zhp->zfs_hdl;
4833 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4835 zc.zc_objset_type = type;
4836 zc.zc_nvlist_dst = (uintptr_t)buf;
4839 zfs_useracct_t *zua = buf;
4841 zc.zc_nvlist_dst_size = sizeof (buf);
4842 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4845 if ((errno == ENOTSUP &&
4846 (type == ZFS_PROP_USEROBJUSED ||
4847 type == ZFS_PROP_GROUPOBJUSED ||
4848 type == ZFS_PROP_USEROBJQUOTA ||
4849 type == ZFS_PROP_GROUPOBJQUOTA ||
4850 type == ZFS_PROP_PROJECTOBJUSED ||
4851 type == ZFS_PROP_PROJECTOBJQUOTA ||
4852 type == ZFS_PROP_PROJECTUSED ||
4853 type == ZFS_PROP_PROJECTQUOTA)))
4856 (void) snprintf(errbuf, sizeof (errbuf),
4857 dgettext(TEXT_DOMAIN,
4858 "cannot get used/quota for %s"), zc.zc_name);
4859 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4861 if (zc.zc_nvlist_dst_size == 0)
4864 while (zc.zc_nvlist_dst_size > 0) {
4865 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4866 zua->zu_space)) != 0)
4869 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4878 const char *snapname;
4880 boolean_t recursive;
4885 zfs_hold_one(zfs_handle_t *zhp, void *arg)
4887 struct holdarg *ha = arg;
4888 char name[ZFS_MAX_DATASET_NAME_LEN];
4891 if (snprintf(name, sizeof (name), "%s@%s", zhp->zfs_name,
4892 ha->snapname) >= sizeof (name))
4895 if (lzc_exists(name))
4896 fnvlist_add_string(ha->nvl, name, ha->tag);
4899 rv = zfs_iter_filesystems(zhp, zfs_hold_one, ha);
4905 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4906 boolean_t recursive, int cleanup_fd)
4911 ha.nvl = fnvlist_alloc();
4912 ha.snapname = snapname;
4914 ha.recursive = recursive;
4915 (void) zfs_hold_one(zfs_handle_dup(zhp), &ha);
4917 if (nvlist_empty(ha.nvl)) {
4920 fnvlist_free(ha.nvl);
4922 (void) snprintf(errbuf, sizeof (errbuf),
4923 dgettext(TEXT_DOMAIN,
4924 "cannot hold snapshot '%s@%s'"),
4925 zhp->zfs_name, snapname);
4926 (void) zfs_standard_error(zhp->zfs_hdl, ret, errbuf);
4930 ret = zfs_hold_nvl(zhp, cleanup_fd, ha.nvl);
4931 fnvlist_free(ha.nvl);
4937 zfs_hold_nvl(zfs_handle_t *zhp, int cleanup_fd, nvlist_t *holds)
4941 libzfs_handle_t *hdl = zhp->zfs_hdl;
4946 ret = lzc_hold(holds, cleanup_fd, &errors);
4949 /* There may be errors even in the success case. */
4950 fnvlist_free(errors);
4954 if (nvlist_empty(errors)) {
4955 /* no hold-specific errors */
4956 (void) snprintf(errbuf, sizeof (errbuf),
4957 dgettext(TEXT_DOMAIN, "cannot hold"));
4960 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4961 "pool must be upgraded"));
4962 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4965 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4968 (void) zfs_standard_error(hdl, ret, errbuf);
4972 for (elem = nvlist_next_nvpair(errors, NULL);
4974 elem = nvlist_next_nvpair(errors, elem)) {
4975 (void) snprintf(errbuf, sizeof (errbuf),
4976 dgettext(TEXT_DOMAIN,
4977 "cannot hold snapshot '%s'"), nvpair_name(elem));
4978 switch (fnvpair_value_int32(elem)) {
4981 * Temporary tags wind up having the ds object id
4982 * prepended. So even if we passed the length check
4983 * above, it's still possible for the tag to wind
4984 * up being slightly too long.
4986 (void) zfs_error(hdl, EZFS_TAGTOOLONG, errbuf);
4989 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4992 (void) zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf);
4995 (void) zfs_standard_error(hdl,
4996 fnvpair_value_int32(elem), errbuf);
5000 fnvlist_free(errors);
5005 zfs_release_one(zfs_handle_t *zhp, void *arg)
5007 struct holdarg *ha = arg;
5008 char name[ZFS_MAX_DATASET_NAME_LEN];
5010 nvlist_t *existing_holds;
5012 if (snprintf(name, sizeof (name), "%s@%s", zhp->zfs_name,
5013 ha->snapname) >= sizeof (name)) {
5018 if (lzc_get_holds(name, &existing_holds) != 0) {
5020 } else if (!nvlist_exists(existing_holds, ha->tag)) {
5023 nvlist_t *torelease = fnvlist_alloc();
5024 fnvlist_add_boolean(torelease, ha->tag);
5025 fnvlist_add_nvlist(ha->nvl, name, torelease);
5026 fnvlist_free(torelease);
5030 rv = zfs_iter_filesystems(zhp, zfs_release_one, ha);
5036 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
5037 boolean_t recursive)
5041 nvlist_t *errors = NULL;
5043 libzfs_handle_t *hdl = zhp->zfs_hdl;
5046 ha.nvl = fnvlist_alloc();
5047 ha.snapname = snapname;
5049 ha.recursive = recursive;
5051 (void) zfs_release_one(zfs_handle_dup(zhp), &ha);
5053 if (nvlist_empty(ha.nvl)) {
5054 fnvlist_free(ha.nvl);
5056 (void) snprintf(errbuf, sizeof (errbuf),
5057 dgettext(TEXT_DOMAIN,
5058 "cannot release hold from snapshot '%s@%s'"),
5059 zhp->zfs_name, snapname);
5061 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
5063 (void) zfs_standard_error(hdl, ret, errbuf);
5068 ret = lzc_release(ha.nvl, &errors);
5069 fnvlist_free(ha.nvl);
5072 /* There may be errors even in the success case. */
5073 fnvlist_free(errors);
5077 if (nvlist_empty(errors)) {
5078 /* no hold-specific errors */
5079 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
5083 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
5084 "pool must be upgraded"));
5085 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
5088 (void) zfs_standard_error_fmt(hdl, errno, errbuf);
5092 for (elem = nvlist_next_nvpair(errors, NULL);
5094 elem = nvlist_next_nvpair(errors, elem)) {
5095 (void) snprintf(errbuf, sizeof (errbuf),
5096 dgettext(TEXT_DOMAIN,
5097 "cannot release hold from snapshot '%s'"),
5099 switch (fnvpair_value_int32(elem)) {
5101 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
5104 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
5107 (void) zfs_standard_error_fmt(hdl,
5108 fnvpair_value_int32(elem), errbuf);
5112 fnvlist_free(errors);
5117 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
5119 zfs_cmd_t zc = {"\0"};
5120 libzfs_handle_t *hdl = zhp->zfs_hdl;
5126 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
5127 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
5131 nvbuf = malloc(nvsz);
5132 if (nvbuf == NULL) {
5133 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
5137 zc.zc_nvlist_dst_size = nvsz;
5138 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
5140 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
5142 if (zfs_ioctl(hdl, ZFS_IOC_GET_FSACL, &zc) != 0) {
5143 (void) snprintf(errbuf, sizeof (errbuf),
5144 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
5149 nvsz = zc.zc_nvlist_dst_size;
5153 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
5154 "pool must be upgraded"));
5155 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
5158 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
5161 err = zfs_error(hdl, EZFS_NOENT, errbuf);
5164 err = zfs_standard_error_fmt(hdl, errno, errbuf);
5169 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
5171 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
5172 TEXT_DOMAIN, "cannot get permissions on '%s'"),
5174 err = zfs_standard_error_fmt(hdl, rc, errbuf);
5184 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
5186 zfs_cmd_t zc = {"\0"};
5187 libzfs_handle_t *hdl = zhp->zfs_hdl;
5193 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
5194 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
5196 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
5199 nvbuf = malloc(nvsz);
5201 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
5204 zc.zc_nvlist_src_size = nvsz;
5205 zc.zc_nvlist_src = (uintptr_t)nvbuf;
5206 zc.zc_perm_action = un;
5208 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
5210 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
5211 (void) snprintf(errbuf, sizeof (errbuf),
5212 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
5216 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
5217 "pool must be upgraded"));
5218 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
5221 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
5224 err = zfs_error(hdl, EZFS_NOENT, errbuf);
5227 err = zfs_standard_error_fmt(hdl, errno, errbuf);
5238 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
5243 err = lzc_get_holds(zhp->zfs_name, nvl);
5246 libzfs_handle_t *hdl = zhp->zfs_hdl;
5248 (void) snprintf(errbuf, sizeof (errbuf),
5249 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
5253 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
5254 "pool must be upgraded"));
5255 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
5258 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
5261 err = zfs_error(hdl, EZFS_NOENT, errbuf);
5264 err = zfs_standard_error_fmt(hdl, errno, errbuf);
5273 * The theory of raidz space accounting
5275 * The "referenced" property of RAIDZ vdevs is scaled such that a 128KB block
5276 * will "reference" 128KB, even though it allocates more than that, to store the
5277 * parity information (and perhaps skip sectors). This concept of the
5278 * "referenced" (and other DMU space accounting) being lower than the allocated
5279 * space by a constant factor is called "raidz deflation."
5281 * As mentioned above, the constant factor for raidz deflation assumes a 128KB
5282 * block size. However, zvols typically have a much smaller block size (default
5283 * 8KB). These smaller blocks may require proportionally much more parity
5284 * information (and perhaps skip sectors). In this case, the change to the
5285 * "referenced" property may be much more than the logical block size.
5287 * Suppose a raidz vdev has 5 disks with ashift=12. A 128k block may be written
5290 * +-------+-------+-------+-------+-------+
5291 * | disk1 | disk2 | disk3 | disk4 | disk5 |
5292 * +-------+-------+-------+-------+-------+
5293 * | P0 | D0 | D8 | D16 | D24 |
5294 * | P1 | D1 | D9 | D17 | D25 |
5295 * | P2 | D2 | D10 | D18 | D26 |
5296 * | P3 | D3 | D11 | D19 | D27 |
5297 * | P4 | D4 | D12 | D20 | D28 |
5298 * | P5 | D5 | D13 | D21 | D29 |
5299 * | P6 | D6 | D14 | D22 | D30 |
5300 * | P7 | D7 | D15 | D23 | D31 |
5301 * +-------+-------+-------+-------+-------+
5303 * Above, notice that 160k was allocated: 8 x 4k parity sectors + 32 x 4k data
5304 * sectors. The dataset's referenced will increase by 128k and the pool's
5305 * allocated and free properties will be adjusted by 160k.
5307 * A 4k block written to the same raidz vdev will require two 4k sectors. The
5308 * blank cells represent unallocated space.
5310 * +-------+-------+-------+-------+-------+
5311 * | disk1 | disk2 | disk3 | disk4 | disk5 |
5312 * +-------+-------+-------+-------+-------+
5314 * +-------+-------+-------+-------+-------+
5316 * Above, notice that the 4k block required one sector for parity and another
5317 * for data. vdev_raidz_asize() will return 8k and as such the pool's allocated
5318 * and free properties will be adjusted by 8k. The dataset will not be charged
5319 * 8k. Rather, it will be charged a value that is scaled according to the
5320 * overhead of the 128k block on the same vdev. This 8k allocation will be
5321 * charged 8k * 128k / 160k. 128k is from SPA_OLD_MAXBLOCKSIZE and 160k is as
5322 * calculated in the 128k block example above.
5324 * Every raidz allocation is sized to be a multiple of nparity+1 sectors. That
5325 * is, every raidz1 allocation will be a multiple of 2 sectors, raidz2
5326 * allocations are a multiple of 3 sectors, and raidz3 allocations are a
5327 * multiple of of 4 sectors. When a block does not fill the required number of
5328 * sectors, skip blocks (sectors) are used.
5330 * An 8k block being written to a raidz vdev may be written as follows:
5332 * +-------+-------+-------+-------+-------+
5333 * | disk1 | disk2 | disk3 | disk4 | disk5 |
5334 * +-------+-------+-------+-------+-------+
5335 * | P0 | D0 | D1 | S0 | |
5336 * +-------+-------+-------+-------+-------+
5338 * In order to maintain the nparity+1 allocation size, a skip block (S0) was
5339 * added. For this 8k block, the pool's allocated and free properties are
5340 * adjusted by 16k and the dataset's referenced is increased by 16k * 128k /
5341 * 160k. Again, 128k is from SPA_OLD_MAXBLOCKSIZE and 160k is as calculated in
5342 * the 128k block example above.
5344 * The situation is slightly different for dRAID since the minimum allocation
5345 * size is the full group width. The same 8K block above would be written as
5346 * follows in a dRAID group:
5348 * +-------+-------+-------+-------+-------+
5349 * | disk1 | disk2 | disk3 | disk4 | disk5 |
5350 * +-------+-------+-------+-------+-------+
5351 * | P0 | D0 | D1 | S0 | S1 |
5352 * +-------+-------+-------+-------+-------+
5354 * Compression may lead to a variety of block sizes being written for the same
5355 * volume or file. There is no clear way to reserve just the amount of space
5356 * that will be required, so the worst case (no compression) is assumed.
5357 * Note that metadata blocks will typically be compressed, so the reservation
5358 * size returned by zvol_volsize_to_reservation() will generally be slightly
5359 * larger than the maximum that the volume can reference.
5363 * Derived from function of same name in module/zfs/vdev_raidz.c. Returns the
5364 * amount of space (in bytes) that will be allocated for the specified block
5365 * size. Note that the "referenced" space accounted will be less than this, but
5366 * not necessarily equal to "blksize", due to RAIDZ deflation.
5369 vdev_raidz_asize(uint64_t ndisks, uint64_t nparity, uint64_t ashift,
5372 uint64_t asize, ndata;
5374 ASSERT3U(ndisks, >, nparity);
5375 ndata = ndisks - nparity;
5376 asize = ((blksize - 1) >> ashift) + 1;
5377 asize += nparity * ((asize + ndata - 1) / ndata);
5378 asize = roundup(asize, nparity + 1) << ashift;
5384 * Derived from function of same name in module/zfs/vdev_draid.c. Returns the
5385 * amount of space (in bytes) that will be allocated for the specified block
5389 vdev_draid_asize(uint64_t ndisks, uint64_t nparity, uint64_t ashift,
5392 ASSERT3U(ndisks, >, nparity);
5393 uint64_t ndata = ndisks - nparity;
5394 uint64_t rows = ((blksize - 1) / (ndata << ashift)) + 1;
5395 uint64_t asize = (rows * ndisks) << ashift;
5401 * Determine how much space will be allocated if it lands on the most space-
5402 * inefficient top-level vdev. Returns the size in bytes required to store one
5403 * copy of the volume data. See theory comment above.
5406 volsize_from_vdevs(zpool_handle_t *zhp, uint64_t nblocks, uint64_t blksize)
5408 nvlist_t *config, *tree, **vdevs;
5412 config = zpool_get_config(zhp, NULL);
5413 if (nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE, &tree) != 0 ||
5414 nvlist_lookup_nvlist_array(tree, ZPOOL_CONFIG_CHILDREN,
5415 &vdevs, &nvdevs) != 0) {
5416 return (nblocks * blksize);
5419 for (int v = 0; v < nvdevs; v++) {
5421 uint64_t nparity, ashift, asize, tsize;
5424 if (nvlist_lookup_string(vdevs[v], ZPOOL_CONFIG_TYPE,
5428 if (strcmp(type, VDEV_TYPE_RAIDZ) != 0 &&
5429 strcmp(type, VDEV_TYPE_DRAID) != 0)
5432 if (nvlist_lookup_uint64(vdevs[v],
5433 ZPOOL_CONFIG_NPARITY, &nparity) != 0)
5436 if (nvlist_lookup_uint64(vdevs[v],
5437 ZPOOL_CONFIG_ASHIFT, &ashift) != 0)
5440 if (strcmp(type, VDEV_TYPE_RAIDZ) == 0) {
5444 if (nvlist_lookup_nvlist_array(vdevs[v],
5445 ZPOOL_CONFIG_CHILDREN, &disks, &ndisks) != 0)
5448 /* allocation size for the "typical" 128k block */
5449 tsize = vdev_raidz_asize(ndisks, nparity, ashift,
5450 SPA_OLD_MAXBLOCKSIZE);
5452 /* allocation size for the blksize block */
5453 asize = vdev_raidz_asize(ndisks, nparity, ashift,
5458 if (nvlist_lookup_uint64(vdevs[v],
5459 ZPOOL_CONFIG_DRAID_NDATA, &ndata) != 0)
5462 /* allocation size for the "typical" 128k block */
5463 tsize = vdev_draid_asize(ndata + nparity, nparity,
5464 ashift, SPA_OLD_MAXBLOCKSIZE);
5466 /* allocation size for the blksize block */
5467 asize = vdev_draid_asize(ndata + nparity, nparity,
5472 * Scale this size down as a ratio of 128k / tsize.
5473 * See theory statement above.
5475 volsize = nblocks * asize * SPA_OLD_MAXBLOCKSIZE / tsize;
5476 if (volsize > ret) {
5482 ret = nblocks * blksize;
5489 * Convert the zvol's volume size to an appropriate reservation. See theory
5492 * Note: If this routine is updated, it is necessary to update the ZFS test
5493 * suite's shell version in reservation.shlib.
5496 zvol_volsize_to_reservation(zpool_handle_t *zph, uint64_t volsize,
5500 uint64_t nblocks, volblocksize;
5504 if (nvlist_lookup_string(props,
5505 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
5506 ncopies = atoi(strval);
5509 if (nvlist_lookup_uint64(props,
5510 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
5511 &volblocksize) != 0)
5512 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
5514 nblocks = volsize / volblocksize;
5516 * Metadata defaults to using 128k blocks, not volblocksize blocks. For
5517 * this reason, only the data blocks are scaled based on vdev config.
5519 volsize = volsize_from_vdevs(zph, nblocks, volblocksize);
5521 /* start with metadnode L0-L6 */
5523 /* calculate number of indirects */
5524 while (nblocks > 1) {
5525 nblocks += DNODES_PER_LEVEL - 1;
5526 nblocks /= DNODES_PER_LEVEL;
5529 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
5532 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
5533 * compressed, but in practice they compress down to about
5536 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;
5542 * Wait for the given activity and return the status of the wait (whether or not
5543 * any waiting was done) in the 'waited' parameter. Non-existent fses are
5544 * reported via the 'missing' parameter, rather than by printing an error
5545 * message. This is convenient when this function is called in a loop over a
5546 * long period of time (as it is, for example, by zfs's wait cmd). In that
5547 * scenario, a fs being exported or destroyed should be considered a normal
5548 * event, so we don't want to print an error when we find that the fs doesn't
5552 zfs_wait_status(zfs_handle_t *zhp, zfs_wait_activity_t activity,
5553 boolean_t *missing, boolean_t *waited)
5555 int error = lzc_wait_fs(zhp->zfs_name, activity, waited);
5556 *missing = (error == ENOENT);
5561 (void) zfs_standard_error_fmt(zhp->zfs_hdl, error,
5562 dgettext(TEXT_DOMAIN, "error waiting in fs '%s'"),