4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
25 * Copyright (c) 2011, 2016 by Delphix. All rights reserved.
26 * Copyright (c) 2012 DEY Storage Systems, Inc. All rights reserved.
27 * Copyright (c) 2011-2012 Pawel Jakub Dawidek. All rights reserved.
28 * Copyright (c) 2013 Martin Matuska. All rights reserved.
29 * Copyright (c) 2013 Steven Hartland. All rights reserved.
30 * Copyright (c) 2014 Integros [integros.com]
31 * Copyright 2016 Nexenta Systems, Inc.
32 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
33 * Copyright 2017 RackTop Systems.
47 #include <sys/mntent.h>
48 #include <sys/mount.h>
55 #include <sys/dnode.h>
61 #include "zfs_namecheck.h"
63 #include "libzfs_impl.h"
64 #include "zfs_deleg.h"
66 static int userquota_propname_decode(const char *propname, boolean_t zoned,
67 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
70 * Given a single type (not a mask of types), return the type in a human
74 zfs_type_to_name(zfs_type_t type)
77 case ZFS_TYPE_FILESYSTEM:
78 return (dgettext(TEXT_DOMAIN, "filesystem"));
79 case ZFS_TYPE_SNAPSHOT:
80 return (dgettext(TEXT_DOMAIN, "snapshot"));
82 return (dgettext(TEXT_DOMAIN, "volume"));
84 return (dgettext(TEXT_DOMAIN, "pool"));
85 case ZFS_TYPE_BOOKMARK:
86 return (dgettext(TEXT_DOMAIN, "bookmark"));
88 assert(!"unhandled zfs_type_t");
95 * Validate a ZFS path. This is used even before trying to open the dataset, to
96 * provide a more meaningful error message. We call zfs_error_aux() to
97 * explain exactly why the name was not valid.
100 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
106 if (entity_namecheck(path, &why, &what) != 0) {
109 case NAME_ERR_TOOLONG:
110 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
111 "name is too long"));
114 case NAME_ERR_LEADING_SLASH:
115 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
116 "leading slash in name"));
119 case NAME_ERR_EMPTY_COMPONENT:
120 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
121 "empty component in name"));
124 case NAME_ERR_TRAILING_SLASH:
125 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
126 "trailing slash in name"));
129 case NAME_ERR_INVALCHAR:
131 dgettext(TEXT_DOMAIN, "invalid character "
132 "'%c' in name"), what);
135 case NAME_ERR_MULTIPLE_DELIMITERS:
136 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
137 "multiple '@' and/or '#' delimiters in "
141 case NAME_ERR_NOLETTER:
142 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
143 "pool doesn't begin with a letter"));
146 case NAME_ERR_RESERVED:
147 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
148 "name is reserved"));
151 case NAME_ERR_DISKLIKE:
152 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
153 "reserved disk name"));
157 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
158 "(%d) not defined"), why);
166 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
168 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
169 "snapshot delimiter '@' is not expected here"));
173 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
175 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
176 "missing '@' delimiter in snapshot name"));
180 if (!(type & ZFS_TYPE_BOOKMARK) && strchr(path, '#') != NULL) {
182 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
183 "bookmark delimiter '#' is not expected here"));
187 if (type == ZFS_TYPE_BOOKMARK && strchr(path, '#') == NULL) {
189 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
190 "missing '#' delimiter in bookmark name"));
194 if (modifying && strchr(path, '%') != NULL) {
196 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
197 "invalid character %c in name"), '%');
205 zfs_name_valid(const char *name, zfs_type_t type)
207 if (type == ZFS_TYPE_POOL)
208 return (zpool_name_valid(NULL, B_FALSE, name));
209 return (zfs_validate_name(NULL, name, type, B_FALSE));
213 * This function takes the raw DSL properties, and filters out the user-defined
214 * properties into a separate nvlist.
217 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
219 libzfs_handle_t *hdl = zhp->zfs_hdl;
224 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
225 (void) no_memory(hdl);
230 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
231 if (!zfs_prop_user(nvpair_name(elem)))
234 verify(nvpair_value_nvlist(elem, &propval) == 0);
235 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
237 (void) no_memory(hdl);
245 static zpool_handle_t *
246 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
248 libzfs_handle_t *hdl = zhp->zfs_hdl;
251 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
252 if (hdl->libzfs_pool_handles != NULL)
253 zph->zpool_next = hdl->libzfs_pool_handles;
254 hdl->libzfs_pool_handles = zph;
259 static zpool_handle_t *
260 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
262 libzfs_handle_t *hdl = zhp->zfs_hdl;
263 zpool_handle_t *zph = hdl->libzfs_pool_handles;
265 while ((zph != NULL) &&
266 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
267 zph = zph->zpool_next;
272 * Returns a handle to the pool that contains the provided dataset.
273 * If a handle to that pool already exists then that handle is returned.
274 * Otherwise, a new handle is created and added to the list of handles.
276 static zpool_handle_t *
277 zpool_handle(zfs_handle_t *zhp)
283 len = strcspn(zhp->zfs_name, "/@#") + 1;
284 pool_name = zfs_alloc(zhp->zfs_hdl, len);
285 (void) strlcpy(pool_name, zhp->zfs_name, len);
287 zph = zpool_find_handle(zhp, pool_name, len);
289 zph = zpool_add_handle(zhp, pool_name);
296 zpool_free_handles(libzfs_handle_t *hdl)
298 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
300 while (zph != NULL) {
301 next = zph->zpool_next;
305 hdl->libzfs_pool_handles = NULL;
309 * Utility function to gather stats (objset and zpl) for the given object.
312 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
314 libzfs_handle_t *hdl = zhp->zfs_hdl;
316 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
318 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, zc) != 0) {
319 if (errno == ENOMEM) {
320 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
331 * Utility function to get the received properties of the given object.
334 get_recvd_props_ioctl(zfs_handle_t *zhp)
336 libzfs_handle_t *hdl = zhp->zfs_hdl;
337 nvlist_t *recvdprops;
338 zfs_cmd_t zc = { 0 };
341 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
344 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
346 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
347 if (errno == ENOMEM) {
348 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
352 zcmd_free_nvlists(&zc);
357 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
358 zcmd_free_nvlists(&zc);
362 nvlist_free(zhp->zfs_recvd_props);
363 zhp->zfs_recvd_props = recvdprops;
369 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
371 nvlist_t *allprops, *userprops;
373 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
375 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
380 * XXX Why do we store the user props separately, in addition to
381 * storing them in zfs_props?
383 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
384 nvlist_free(allprops);
388 nvlist_free(zhp->zfs_props);
389 nvlist_free(zhp->zfs_user_props);
391 zhp->zfs_props = allprops;
392 zhp->zfs_user_props = userprops;
398 get_stats(zfs_handle_t *zhp)
401 zfs_cmd_t zc = { 0 };
403 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
405 if (get_stats_ioctl(zhp, &zc) != 0)
407 else if (put_stats_zhdl(zhp, &zc) != 0)
409 zcmd_free_nvlists(&zc);
414 * Refresh the properties currently stored in the handle.
417 zfs_refresh_properties(zfs_handle_t *zhp)
419 (void) get_stats(zhp);
423 * Makes a handle from the given dataset name. Used by zfs_open() and
424 * zfs_iter_* to create child handles on the fly.
427 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
429 if (put_stats_zhdl(zhp, zc) != 0)
433 * We've managed to open the dataset and gather statistics. Determine
434 * the high-level type.
436 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
437 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
438 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
439 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
443 if (zhp->zfs_dmustats.dds_is_snapshot)
444 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
445 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
446 zhp->zfs_type = ZFS_TYPE_VOLUME;
447 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
448 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
450 abort(); /* we should never see any other types */
452 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
459 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
461 zfs_cmd_t zc = { 0 };
463 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
469 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
470 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
474 if (get_stats_ioctl(zhp, &zc) == -1) {
475 zcmd_free_nvlists(&zc);
479 if (make_dataset_handle_common(zhp, &zc) == -1) {
483 zcmd_free_nvlists(&zc);
488 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
490 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
496 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
497 if (make_dataset_handle_common(zhp, zc) == -1) {
505 make_dataset_simple_handle_zc(zfs_handle_t *pzhp, zfs_cmd_t *zc)
507 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
512 zhp->zfs_hdl = pzhp->zfs_hdl;
513 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
514 zhp->zfs_head_type = pzhp->zfs_type;
515 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
516 zhp->zpool_hdl = zpool_handle(zhp);
521 zfs_handle_dup(zfs_handle_t *zhp_orig)
523 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
528 zhp->zfs_hdl = zhp_orig->zfs_hdl;
529 zhp->zpool_hdl = zhp_orig->zpool_hdl;
530 (void) strlcpy(zhp->zfs_name, zhp_orig->zfs_name,
531 sizeof (zhp->zfs_name));
532 zhp->zfs_type = zhp_orig->zfs_type;
533 zhp->zfs_head_type = zhp_orig->zfs_head_type;
534 zhp->zfs_dmustats = zhp_orig->zfs_dmustats;
535 if (zhp_orig->zfs_props != NULL) {
536 if (nvlist_dup(zhp_orig->zfs_props, &zhp->zfs_props, 0) != 0) {
537 (void) no_memory(zhp->zfs_hdl);
542 if (zhp_orig->zfs_user_props != NULL) {
543 if (nvlist_dup(zhp_orig->zfs_user_props,
544 &zhp->zfs_user_props, 0) != 0) {
545 (void) no_memory(zhp->zfs_hdl);
550 if (zhp_orig->zfs_recvd_props != NULL) {
551 if (nvlist_dup(zhp_orig->zfs_recvd_props,
552 &zhp->zfs_recvd_props, 0)) {
553 (void) no_memory(zhp->zfs_hdl);
558 zhp->zfs_mntcheck = zhp_orig->zfs_mntcheck;
559 if (zhp_orig->zfs_mntopts != NULL) {
560 zhp->zfs_mntopts = zfs_strdup(zhp_orig->zfs_hdl,
561 zhp_orig->zfs_mntopts);
563 zhp->zfs_props_table = zhp_orig->zfs_props_table;
568 zfs_bookmark_exists(const char *path)
572 char fsname[ZFS_MAX_DATASET_NAME_LEN];
579 (void) strlcpy(fsname, path, sizeof (fsname));
580 pound = strchr(fsname, '#');
585 bmark_name = pound + 1;
586 props = fnvlist_alloc();
587 err = lzc_get_bookmarks(fsname, props, &bmarks);
594 rv = nvlist_exists(bmarks, bmark_name);
600 make_bookmark_handle(zfs_handle_t *parent, const char *path,
601 nvlist_t *bmark_props)
603 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
608 /* Fill in the name. */
609 zhp->zfs_hdl = parent->zfs_hdl;
610 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
612 /* Set the property lists. */
613 if (nvlist_dup(bmark_props, &zhp->zfs_props, 0) != 0) {
619 zhp->zfs_head_type = parent->zfs_head_type;
620 zhp->zfs_type = ZFS_TYPE_BOOKMARK;
622 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL) {
623 nvlist_free(zhp->zfs_props);
631 struct zfs_open_bookmarks_cb_data {
637 zfs_open_bookmarks_cb(zfs_handle_t *zhp, void *data)
639 struct zfs_open_bookmarks_cb_data *dp = data;
642 * Is it the one we are looking for?
644 if (strcmp(dp->path, zfs_get_name(zhp)) == 0) {
646 * We found it. Save it and let the caller know we are done.
653 * Not found. Close the handle and ask for another one.
660 * Opens the given snapshot, bookmark, filesystem, or volume. The 'types'
661 * argument is a mask of acceptable types. The function will print an
662 * appropriate error message and return NULL if it can't be opened.
665 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
671 (void) snprintf(errbuf, sizeof (errbuf),
672 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
675 * Validate the name before we even try to open it.
677 if (!zfs_validate_name(hdl, path, types, B_FALSE)) {
678 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
683 * Bookmarks needs to be handled separately.
685 bookp = strchr(path, '#');
688 * Try to get stats for the dataset, which will tell us if it
692 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
693 (void) zfs_standard_error(hdl, errno, errbuf);
697 char dsname[ZFS_MAX_DATASET_NAME_LEN];
699 struct zfs_open_bookmarks_cb_data cb_data = {path, NULL};
702 * We need to cut out '#' and everything after '#'
703 * to get the parent dataset name only.
705 assert(bookp - path < sizeof (dsname));
706 (void) strncpy(dsname, path, bookp - path);
707 dsname[bookp - path] = '\0';
710 * Create handle for the parent dataset.
713 if ((pzhp = make_dataset_handle(hdl, dsname)) == NULL) {
714 (void) zfs_standard_error(hdl, errno, errbuf);
719 * Iterate bookmarks to find the right one.
722 if ((zfs_iter_bookmarks(pzhp, zfs_open_bookmarks_cb,
723 &cb_data) == 0) && (cb_data.zhp == NULL)) {
724 (void) zfs_error(hdl, EZFS_NOENT, errbuf);
728 if (cb_data.zhp == NULL) {
729 (void) zfs_standard_error(hdl, errno, errbuf);
742 char *at = strchr(path, '@');
747 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
748 (void) zfs_standard_error(hdl, errno, errbuf);
753 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
754 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
757 if (!(types & zhp->zfs_type)) {
758 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
767 * Release a ZFS handle. Nothing to do but free the associated memory.
770 zfs_close(zfs_handle_t *zhp)
772 if (zhp->zfs_mntopts)
773 free(zhp->zfs_mntopts);
774 nvlist_free(zhp->zfs_props);
775 nvlist_free(zhp->zfs_user_props);
776 nvlist_free(zhp->zfs_recvd_props);
780 typedef struct mnttab_node {
781 struct mnttab mtn_mt;
786 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
788 const mnttab_node_t *mtn1 = arg1;
789 const mnttab_node_t *mtn2 = arg2;
792 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
796 return (rv > 0 ? 1 : -1);
800 libzfs_mnttab_init(libzfs_handle_t *hdl)
802 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
803 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
804 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
808 libzfs_mnttab_update(libzfs_handle_t *hdl)
812 rewind(hdl->libzfs_mnttab);
813 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
816 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
818 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
819 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
820 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
821 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
822 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
823 avl_add(&hdl->libzfs_mnttab_cache, mtn);
828 libzfs_mnttab_fini(libzfs_handle_t *hdl)
833 while ((mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie))
835 free(mtn->mtn_mt.mnt_special);
836 free(mtn->mtn_mt.mnt_mountp);
837 free(mtn->mtn_mt.mnt_fstype);
838 free(mtn->mtn_mt.mnt_mntopts);
841 avl_destroy(&hdl->libzfs_mnttab_cache);
845 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
847 hdl->libzfs_mnttab_enable = enable;
851 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
852 struct mnttab *entry)
857 if (!hdl->libzfs_mnttab_enable) {
858 struct mnttab srch = { 0 };
860 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
861 libzfs_mnttab_fini(hdl);
862 rewind(hdl->libzfs_mnttab);
863 srch.mnt_special = (char *)fsname;
864 srch.mnt_fstype = MNTTYPE_ZFS;
865 if (getmntany(hdl->libzfs_mnttab, entry, &srch) == 0)
871 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
872 libzfs_mnttab_update(hdl);
874 find.mtn_mt.mnt_special = (char *)fsname;
875 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
877 *entry = mtn->mtn_mt;
884 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
885 const char *mountp, const char *mntopts)
889 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
891 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
892 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
893 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
894 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
895 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
896 avl_add(&hdl->libzfs_mnttab_cache, mtn);
900 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
905 find.mtn_mt.mnt_special = (char *)fsname;
906 if ((ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL))
908 avl_remove(&hdl->libzfs_mnttab_cache, ret);
909 free(ret->mtn_mt.mnt_special);
910 free(ret->mtn_mt.mnt_mountp);
911 free(ret->mtn_mt.mnt_fstype);
912 free(ret->mtn_mt.mnt_mntopts);
918 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
920 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
922 if (zpool_handle == NULL)
925 *spa_version = zpool_get_prop_int(zpool_handle,
926 ZPOOL_PROP_VERSION, NULL);
931 * The choice of reservation property depends on the SPA version.
934 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
938 if (zfs_spa_version(zhp, &spa_version) < 0)
941 if (spa_version >= SPA_VERSION_REFRESERVATION)
942 *resv_prop = ZFS_PROP_REFRESERVATION;
944 *resv_prop = ZFS_PROP_RESERVATION;
950 * Given an nvlist of properties to set, validates that they are correct, and
951 * parses any numeric properties (index, boolean, etc) if they are specified as
955 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
956 uint64_t zoned, zfs_handle_t *zhp, zpool_handle_t *zpool_hdl,
964 int chosen_normal = -1;
967 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
968 (void) no_memory(hdl);
973 * Make sure this property is valid and applies to this type.
977 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
978 const char *propname = nvpair_name(elem);
980 prop = zfs_name_to_prop(propname);
981 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
983 * This is a user property: make sure it's a
984 * string, and that it's less than ZAP_MAXNAMELEN.
986 if (nvpair_type(elem) != DATA_TYPE_STRING) {
987 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
988 "'%s' must be a string"), propname);
989 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
993 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
994 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
995 "property name '%s' is too long"),
997 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1001 (void) nvpair_value_string(elem, &strval);
1002 if (nvlist_add_string(ret, propname, strval) != 0) {
1003 (void) no_memory(hdl);
1010 * Currently, only user properties can be modified on
1013 if (type == ZFS_TYPE_SNAPSHOT) {
1014 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1015 "this property can not be modified for snapshots"));
1016 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1020 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
1021 zfs_userquota_prop_t uqtype;
1022 char newpropname[128];
1027 if (userquota_propname_decode(propname, zoned,
1028 &uqtype, domain, sizeof (domain), &rid) != 0) {
1030 dgettext(TEXT_DOMAIN,
1031 "'%s' has an invalid user/group name"),
1033 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1037 if (uqtype != ZFS_PROP_USERQUOTA &&
1038 uqtype != ZFS_PROP_GROUPQUOTA) {
1040 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1042 (void) zfs_error(hdl, EZFS_PROPREADONLY,
1047 if (nvpair_type(elem) == DATA_TYPE_STRING) {
1048 (void) nvpair_value_string(elem, &strval);
1049 if (strcmp(strval, "none") == 0) {
1051 } else if (zfs_nicestrtonum(hdl,
1052 strval, &intval) != 0) {
1053 (void) zfs_error(hdl,
1054 EZFS_BADPROP, errbuf);
1057 } else if (nvpair_type(elem) ==
1059 (void) nvpair_value_uint64(elem, &intval);
1061 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1062 "use 'none' to disable "
1063 "userquota/groupquota"));
1067 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1068 "'%s' must be a number"), propname);
1069 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1074 * Encode the prop name as
1075 * userquota@<hex-rid>-domain, to make it easy
1076 * for the kernel to decode.
1078 (void) snprintf(newpropname, sizeof (newpropname),
1079 "%s%llx-%s", zfs_userquota_prop_prefixes[uqtype],
1080 (longlong_t)rid, domain);
1084 if (nvlist_add_uint64_array(ret, newpropname,
1086 (void) no_memory(hdl);
1090 } else if (prop == ZPROP_INVAL && zfs_prop_written(propname)) {
1091 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1092 "'%s' is readonly"),
1094 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1098 if (prop == ZPROP_INVAL) {
1099 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1100 "invalid property '%s'"), propname);
1101 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1105 if (!zfs_prop_valid_for_type(prop, type)) {
1107 dgettext(TEXT_DOMAIN, "'%s' does not "
1108 "apply to datasets of this type"), propname);
1109 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1113 if (zfs_prop_readonly(prop) &&
1114 (!zfs_prop_setonce(prop) || zhp != NULL)) {
1116 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1118 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1122 if (zprop_parse_value(hdl, elem, prop, type, ret,
1123 &strval, &intval, errbuf) != 0)
1127 * Perform some additional checks for specific properties.
1130 case ZFS_PROP_VERSION:
1136 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1137 if (intval < version) {
1138 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1139 "Can not downgrade; already at version %u"),
1141 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1147 case ZFS_PROP_VOLBLOCKSIZE:
1148 case ZFS_PROP_RECORDSIZE:
1150 int maxbs = SPA_MAXBLOCKSIZE;
1151 if (zpool_hdl != NULL) {
1152 maxbs = zpool_get_prop_int(zpool_hdl,
1153 ZPOOL_PROP_MAXBLOCKSIZE, NULL);
1156 * Volumes are limited to a volblocksize of 128KB,
1157 * because they typically service workloads with
1158 * small random writes, which incur a large performance
1159 * penalty with large blocks.
1161 if (prop == ZFS_PROP_VOLBLOCKSIZE)
1162 maxbs = SPA_OLD_MAXBLOCKSIZE;
1164 * The value must be a power of two between
1165 * SPA_MINBLOCKSIZE and maxbs.
1167 if (intval < SPA_MINBLOCKSIZE ||
1168 intval > maxbs || !ISP2(intval)) {
1169 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1170 "'%s' must be power of 2 from 512B "
1171 "to %uKB"), propname, maxbs >> 10);
1172 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1177 case ZFS_PROP_MLSLABEL:
1181 * Verify the mlslabel string and convert to
1182 * internal hex label string.
1186 char *hex = NULL; /* internal label string */
1188 /* Default value is already OK. */
1189 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
1192 /* Verify the label can be converted to binary form */
1193 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
1194 (str_to_label(strval, &new_sl, MAC_LABEL,
1195 L_NO_CORRECTION, NULL) == -1)) {
1199 /* Now translate to hex internal label string */
1200 if (label_to_str(new_sl, &hex, M_INTERNAL,
1206 m_label_free(new_sl);
1208 /* If string is already in internal form, we're done. */
1209 if (strcmp(strval, hex) == 0) {
1214 /* Replace the label string with the internal form. */
1215 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
1217 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
1224 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1225 "invalid mlslabel '%s'"), strval);
1226 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1227 m_label_free(new_sl); /* OK if null */
1228 #else /* !illumos */
1229 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1230 "mlslabel is not supported on FreeBSD"));
1231 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1232 #endif /* illumos */
1237 case ZFS_PROP_MOUNTPOINT:
1239 namecheck_err_t why;
1241 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1242 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1245 if (mountpoint_namecheck(strval, &why)) {
1247 case NAME_ERR_LEADING_SLASH:
1249 dgettext(TEXT_DOMAIN,
1250 "'%s' must be an absolute path, "
1251 "'none', or 'legacy'"), propname);
1253 case NAME_ERR_TOOLONG:
1255 dgettext(TEXT_DOMAIN,
1256 "component of '%s' is too long"),
1262 dgettext(TEXT_DOMAIN,
1263 "(%d) not defined"),
1267 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1274 case ZFS_PROP_SHARESMB:
1275 case ZFS_PROP_SHARENFS:
1277 * For the mountpoint and sharenfs or sharesmb
1278 * properties, check if it can be set in a
1279 * global/non-global zone based on
1280 * the zoned property value:
1282 * global zone non-global zone
1283 * --------------------------------------------------
1284 * zoned=on mountpoint (no) mountpoint (yes)
1285 * sharenfs (no) sharenfs (no)
1286 * sharesmb (no) sharesmb (no)
1288 * zoned=off mountpoint (yes) N/A
1293 if (getzoneid() == GLOBAL_ZONEID) {
1294 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1295 "'%s' cannot be set on "
1296 "dataset in a non-global zone"),
1298 (void) zfs_error(hdl, EZFS_ZONED,
1301 } else if (prop == ZFS_PROP_SHARENFS ||
1302 prop == ZFS_PROP_SHARESMB) {
1303 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1304 "'%s' cannot be set in "
1305 "a non-global zone"), propname);
1306 (void) zfs_error(hdl, EZFS_ZONED,
1310 } else if (getzoneid() != GLOBAL_ZONEID) {
1312 * If zoned property is 'off', this must be in
1313 * a global zone. If not, something is wrong.
1315 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1316 "'%s' cannot be set while dataset "
1317 "'zoned' property is set"), propname);
1318 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1323 * At this point, it is legitimate to set the
1324 * property. Now we want to make sure that the
1325 * property value is valid if it is sharenfs.
1327 if ((prop == ZFS_PROP_SHARENFS ||
1328 prop == ZFS_PROP_SHARESMB) &&
1329 strcmp(strval, "on") != 0 &&
1330 strcmp(strval, "off") != 0) {
1331 zfs_share_proto_t proto;
1333 if (prop == ZFS_PROP_SHARESMB)
1339 * Must be an valid sharing protocol
1340 * option string so init the libshare
1341 * in order to enable the parser and
1342 * then parse the options. We use the
1343 * control API since we don't care about
1344 * the current configuration and don't
1345 * want the overhead of loading it
1346 * until we actually do something.
1349 if (zfs_init_libshare(hdl,
1350 SA_INIT_CONTROL_API) != SA_OK) {
1352 * An error occurred so we can't do
1355 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1356 "'%s' cannot be set: problem "
1357 "in share initialization"),
1359 (void) zfs_error(hdl, EZFS_BADPROP,
1364 if (zfs_parse_options(strval, proto) != SA_OK) {
1366 * There was an error in parsing so
1367 * deal with it by issuing an error
1368 * message and leaving after
1369 * uninitializing the the libshare
1372 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1373 "'%s' cannot be set to invalid "
1374 "options"), propname);
1375 (void) zfs_error(hdl, EZFS_BADPROP,
1377 zfs_uninit_libshare(hdl);
1380 zfs_uninit_libshare(hdl);
1385 case ZFS_PROP_UTF8ONLY:
1386 chosen_utf = (int)intval;
1389 case ZFS_PROP_NORMALIZE:
1390 chosen_normal = (int)intval;
1398 * For changes to existing volumes, we have some additional
1399 * checks to enforce.
1401 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1402 uint64_t volsize = zfs_prop_get_int(zhp,
1404 uint64_t blocksize = zfs_prop_get_int(zhp,
1405 ZFS_PROP_VOLBLOCKSIZE);
1409 case ZFS_PROP_RESERVATION:
1410 case ZFS_PROP_REFRESERVATION:
1411 if (intval > volsize) {
1412 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1413 "'%s' is greater than current "
1414 "volume size"), propname);
1415 (void) zfs_error(hdl, EZFS_BADPROP,
1421 case ZFS_PROP_VOLSIZE:
1422 if (intval % blocksize != 0) {
1423 zfs_nicenum(blocksize, buf,
1425 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1426 "'%s' must be a multiple of "
1427 "volume block size (%s)"),
1429 (void) zfs_error(hdl, EZFS_BADPROP,
1435 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1436 "'%s' cannot be zero"),
1438 (void) zfs_error(hdl, EZFS_BADPROP,
1451 * If normalization was chosen, but no UTF8 choice was made,
1452 * enforce rejection of non-UTF8 names.
1454 * If normalization was chosen, but rejecting non-UTF8 names
1455 * was explicitly not chosen, it is an error.
1457 if (chosen_normal > 0 && chosen_utf < 0) {
1458 if (nvlist_add_uint64(ret,
1459 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1460 (void) no_memory(hdl);
1463 } else if (chosen_normal > 0 && chosen_utf == 0) {
1464 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1465 "'%s' must be set 'on' if normalization chosen"),
1466 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1467 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1478 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1480 uint64_t old_volsize;
1481 uint64_t new_volsize;
1482 uint64_t old_reservation;
1483 uint64_t new_reservation;
1484 zfs_prop_t resv_prop;
1488 * If this is an existing volume, and someone is setting the volsize,
1489 * make sure that it matches the reservation, or add it if necessary.
1491 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1492 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1494 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1496 props = fnvlist_alloc();
1497 fnvlist_add_uint64(props, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
1498 zfs_prop_get_int(zhp, ZFS_PROP_VOLBLOCKSIZE));
1500 if ((zvol_volsize_to_reservation(old_volsize, props) !=
1501 old_reservation) || nvlist_exists(nvl,
1502 zfs_prop_to_name(resv_prop))) {
1503 fnvlist_free(props);
1506 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1507 &new_volsize) != 0) {
1508 fnvlist_free(props);
1511 new_reservation = zvol_volsize_to_reservation(new_volsize, props);
1512 fnvlist_free(props);
1514 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1515 new_reservation) != 0) {
1516 (void) no_memory(zhp->zfs_hdl);
1523 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1530 * For quotas and reservations, ENOSPC indicates
1531 * something different; setting a quota or reservation
1532 * doesn't use any disk space.
1535 case ZFS_PROP_QUOTA:
1536 case ZFS_PROP_REFQUOTA:
1537 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1538 "size is less than current used or "
1540 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1543 case ZFS_PROP_RESERVATION:
1544 case ZFS_PROP_REFRESERVATION:
1545 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1546 "size is greater than available space"));
1547 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1551 (void) zfs_standard_error(hdl, err, errbuf);
1557 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1561 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1565 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1566 "property value too long"));
1567 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1571 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1572 "pool and or dataset must be upgraded to set this "
1573 "property or value"));
1574 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1579 if (prop == ZFS_PROP_COMPRESSION ||
1580 prop == ZFS_PROP_RECORDSIZE) {
1581 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1582 "property setting is not allowed on "
1583 "bootable datasets"));
1584 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1585 } else if (prop == ZFS_PROP_CHECKSUM ||
1586 prop == ZFS_PROP_DEDUP) {
1587 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1588 "property setting is not allowed on "
1590 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1592 (void) zfs_standard_error(hdl, err, errbuf);
1597 if (prop == ZPROP_INVAL) {
1598 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1600 (void) zfs_standard_error(hdl, err, errbuf);
1606 * This platform can't address a volume this big.
1609 if (prop == ZFS_PROP_VOLSIZE) {
1610 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1616 (void) zfs_standard_error(hdl, err, errbuf);
1621 * Given a property name and value, set the property for the given dataset.
1624 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1628 libzfs_handle_t *hdl = zhp->zfs_hdl;
1629 nvlist_t *nvl = NULL;
1631 (void) snprintf(errbuf, sizeof (errbuf),
1632 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1635 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1636 nvlist_add_string(nvl, propname, propval) != 0) {
1637 (void) no_memory(hdl);
1641 ret = zfs_prop_set_list(zhp, nvl);
1651 * Given an nvlist of property names and values, set the properties for the
1655 zfs_prop_set_list(zfs_handle_t *zhp, nvlist_t *props)
1657 zfs_cmd_t zc = { 0 };
1659 prop_changelist_t **cls = NULL;
1662 libzfs_handle_t *hdl = zhp->zfs_hdl;
1667 (void) snprintf(errbuf, sizeof (errbuf),
1668 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1671 if ((nvl = zfs_valid_proplist(hdl, zhp->zfs_type, props,
1672 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, zhp->zpool_hdl,
1677 * We have to check for any extra properties which need to be added
1678 * before computing the length of the nvlist.
1680 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1682 elem = nvlist_next_nvpair(nvl, elem)) {
1683 if (zfs_name_to_prop(nvpair_name(elem)) == ZFS_PROP_VOLSIZE &&
1684 (added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1) {
1689 * Check how many properties we're setting and allocate an array to
1690 * store changelist pointers for postfix().
1693 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1695 elem = nvlist_next_nvpair(nvl, elem))
1697 if ((cls = calloc(nvl_len, sizeof (prop_changelist_t *))) == NULL)
1701 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1703 elem = nvlist_next_nvpair(nvl, elem)) {
1705 zfs_prop_t prop = zfs_name_to_prop(nvpair_name(elem));
1707 assert(cl_idx < nvl_len);
1709 * We don't want to unmount & remount the dataset when changing
1710 * its canmount property to 'on' or 'noauto'. We only use
1711 * the changelist logic to unmount when setting canmount=off.
1713 if (prop != ZFS_PROP_CANMOUNT ||
1714 (fnvpair_value_uint64(elem) == ZFS_CANMOUNT_OFF &&
1715 zfs_is_mounted(zhp, NULL))) {
1716 cls[cl_idx] = changelist_gather(zhp, prop, 0, 0);
1717 if (cls[cl_idx] == NULL)
1721 if (prop == ZFS_PROP_MOUNTPOINT &&
1722 changelist_haszonedchild(cls[cl_idx])) {
1723 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1724 "child dataset with inherited mountpoint is used "
1725 "in a non-global zone"));
1726 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1730 /* We don't support those properties on FreeBSD. */
1732 case ZFS_PROP_DEVICES:
1733 case ZFS_PROP_ISCSIOPTIONS:
1734 case ZFS_PROP_XATTR:
1735 case ZFS_PROP_VSCAN:
1736 case ZFS_PROP_NBMAND:
1737 case ZFS_PROP_MLSLABEL:
1738 (void) snprintf(errbuf, sizeof (errbuf),
1739 "property '%s' not supported on FreeBSD",
1741 ret = zfs_error(hdl, EZFS_PERM, errbuf);
1745 if (cls[cl_idx] != NULL &&
1746 (ret = changelist_prefix(cls[cl_idx])) != 0)
1751 assert(cl_idx == nvl_len);
1754 * Execute the corresponding ioctl() to set this list of properties.
1756 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1758 if ((ret = zcmd_write_src_nvlist(hdl, &zc, nvl)) != 0 ||
1759 (ret = zcmd_alloc_dst_nvlist(hdl, &zc, 0)) != 0)
1762 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1765 /* Get the list of unset properties back and report them. */
1766 nvlist_t *errorprops = NULL;
1767 if (zcmd_read_dst_nvlist(hdl, &zc, &errorprops) != 0)
1769 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1771 elem = nvlist_next_nvpair(nvl, elem)) {
1772 zfs_prop_t prop = zfs_name_to_prop(nvpair_name(elem));
1773 zfs_setprop_error(hdl, prop, errno, errbuf);
1775 nvlist_free(errorprops);
1777 if (added_resv && errno == ENOSPC) {
1778 /* clean up the volsize property we tried to set */
1779 uint64_t old_volsize = zfs_prop_get_int(zhp,
1783 zcmd_free_nvlists(&zc);
1785 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1787 if (nvlist_add_uint64(nvl,
1788 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1791 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1793 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1796 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1797 if (cls[cl_idx] != NULL) {
1798 int clp_err = changelist_postfix(cls[cl_idx]);
1805 * Refresh the statistics so the new property value
1809 (void) get_stats(zhp);
1814 zcmd_free_nvlists(&zc);
1816 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1817 if (cls[cl_idx] != NULL)
1818 changelist_free(cls[cl_idx]);
1826 * Given a property, inherit the value from the parent dataset, or if received
1827 * is TRUE, revert to the received value, if any.
1830 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1832 zfs_cmd_t zc = { 0 };
1834 prop_changelist_t *cl;
1835 libzfs_handle_t *hdl = zhp->zfs_hdl;
1839 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1840 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1842 zc.zc_cookie = received;
1843 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1845 * For user properties, the amount of work we have to do is very
1846 * small, so just do it here.
1848 if (!zfs_prop_user(propname)) {
1849 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1850 "invalid property"));
1851 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1854 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1855 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1857 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1858 return (zfs_standard_error(hdl, errno, errbuf));
1864 * Verify that this property is inheritable.
1866 if (zfs_prop_readonly(prop))
1867 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1869 if (!zfs_prop_inheritable(prop) && !received)
1870 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1873 * Check to see if the value applies to this type
1875 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1876 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1879 * Normalize the name, to get rid of shorthand abbreviations.
1881 propname = zfs_prop_to_name(prop);
1882 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1883 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1885 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1886 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1887 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1888 "dataset is used in a non-global zone"));
1889 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1893 * Determine datasets which will be affected by this change, if any.
1895 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1898 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1899 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1900 "child dataset with inherited mountpoint is used "
1901 "in a non-global zone"));
1902 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1906 if ((ret = changelist_prefix(cl)) != 0)
1909 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1910 return (zfs_standard_error(hdl, errno, errbuf));
1913 if ((ret = changelist_postfix(cl)) != 0)
1917 * Refresh the statistics so the new property is reflected.
1919 (void) get_stats(zhp);
1923 changelist_free(cl);
1928 * True DSL properties are stored in an nvlist. The following two functions
1929 * extract them appropriately.
1932 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1938 if (nvlist_lookup_nvlist(zhp->zfs_props,
1939 zfs_prop_to_name(prop), &nv) == 0) {
1940 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1941 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1943 verify(!zhp->zfs_props_table ||
1944 zhp->zfs_props_table[prop] == B_TRUE);
1945 value = zfs_prop_default_numeric(prop);
1953 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1959 if (nvlist_lookup_nvlist(zhp->zfs_props,
1960 zfs_prop_to_name(prop), &nv) == 0) {
1961 value = fnvlist_lookup_string(nv, ZPROP_VALUE);
1962 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1964 verify(!zhp->zfs_props_table ||
1965 zhp->zfs_props_table[prop] == B_TRUE);
1966 value = zfs_prop_default_string(prop);
1974 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
1976 return (zhp->zfs_props == zhp->zfs_recvd_props);
1980 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1982 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
1983 zhp->zfs_props = zhp->zfs_recvd_props;
1987 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1989 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
1994 * Internal function for getting a numeric property. Both zfs_prop_get() and
1995 * zfs_prop_get_int() are built using this interface.
1997 * Certain properties can be overridden using 'mount -o'. In this case, scan
1998 * the contents of the /etc/mnttab entry, searching for the appropriate options.
1999 * If they differ from the on-disk values, report the current values and mark
2000 * the source "temporary".
2003 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
2004 char **source, uint64_t *val)
2006 zfs_cmd_t zc = { 0 };
2007 nvlist_t *zplprops = NULL;
2009 char *mntopt_on = NULL;
2010 char *mntopt_off = NULL;
2011 boolean_t received = zfs_is_recvd_props_mode(zhp);
2016 case ZFS_PROP_ATIME:
2017 mntopt_on = MNTOPT_ATIME;
2018 mntopt_off = MNTOPT_NOATIME;
2021 case ZFS_PROP_DEVICES:
2022 mntopt_on = MNTOPT_DEVICES;
2023 mntopt_off = MNTOPT_NODEVICES;
2027 mntopt_on = MNTOPT_EXEC;
2028 mntopt_off = MNTOPT_NOEXEC;
2031 case ZFS_PROP_READONLY:
2032 mntopt_on = MNTOPT_RO;
2033 mntopt_off = MNTOPT_RW;
2036 case ZFS_PROP_SETUID:
2037 mntopt_on = MNTOPT_SETUID;
2038 mntopt_off = MNTOPT_NOSETUID;
2041 case ZFS_PROP_XATTR:
2042 mntopt_on = MNTOPT_XATTR;
2043 mntopt_off = MNTOPT_NOXATTR;
2046 case ZFS_PROP_NBMAND:
2047 mntopt_on = MNTOPT_NBMAND;
2048 mntopt_off = MNTOPT_NONBMAND;
2056 * Because looking up the mount options is potentially expensive
2057 * (iterating over all of /etc/mnttab), we defer its calculation until
2058 * we're looking up a property which requires its presence.
2060 if (!zhp->zfs_mntcheck &&
2061 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
2062 libzfs_handle_t *hdl = zhp->zfs_hdl;
2063 struct mnttab entry;
2065 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
2066 zhp->zfs_mntopts = zfs_strdup(hdl,
2068 if (zhp->zfs_mntopts == NULL)
2072 zhp->zfs_mntcheck = B_TRUE;
2075 if (zhp->zfs_mntopts == NULL)
2076 mnt.mnt_mntopts = "";
2078 mnt.mnt_mntopts = zhp->zfs_mntopts;
2081 case ZFS_PROP_ATIME:
2082 case ZFS_PROP_DEVICES:
2084 case ZFS_PROP_READONLY:
2085 case ZFS_PROP_SETUID:
2086 case ZFS_PROP_XATTR:
2087 case ZFS_PROP_NBMAND:
2088 *val = getprop_uint64(zhp, prop, source);
2093 if (hasmntopt(&mnt, mntopt_on) && !*val) {
2096 *src = ZPROP_SRC_TEMPORARY;
2097 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
2100 *src = ZPROP_SRC_TEMPORARY;
2104 case ZFS_PROP_CANMOUNT:
2105 case ZFS_PROP_VOLSIZE:
2106 case ZFS_PROP_QUOTA:
2107 case ZFS_PROP_REFQUOTA:
2108 case ZFS_PROP_RESERVATION:
2109 case ZFS_PROP_REFRESERVATION:
2110 case ZFS_PROP_FILESYSTEM_LIMIT:
2111 case ZFS_PROP_SNAPSHOT_LIMIT:
2112 case ZFS_PROP_FILESYSTEM_COUNT:
2113 case ZFS_PROP_SNAPSHOT_COUNT:
2114 *val = getprop_uint64(zhp, prop, source);
2116 if (*source == NULL) {
2117 /* not default, must be local */
2118 *source = zhp->zfs_name;
2122 case ZFS_PROP_MOUNTED:
2123 *val = (zhp->zfs_mntopts != NULL);
2126 case ZFS_PROP_NUMCLONES:
2127 *val = zhp->zfs_dmustats.dds_num_clones;
2130 case ZFS_PROP_VERSION:
2131 case ZFS_PROP_NORMALIZE:
2132 case ZFS_PROP_UTF8ONLY:
2134 if (!zfs_prop_valid_for_type(prop, zhp->zfs_head_type) ||
2135 zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2137 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2138 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
2139 zcmd_free_nvlists(&zc);
2142 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
2143 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
2145 zcmd_free_nvlists(&zc);
2148 nvlist_free(zplprops);
2149 zcmd_free_nvlists(&zc);
2152 case ZFS_PROP_INCONSISTENT:
2153 *val = zhp->zfs_dmustats.dds_inconsistent;
2157 switch (zfs_prop_get_type(prop)) {
2158 case PROP_TYPE_NUMBER:
2159 case PROP_TYPE_INDEX:
2160 *val = getprop_uint64(zhp, prop, source);
2162 * If we tried to use a default value for a
2163 * readonly property, it means that it was not
2166 if (zfs_prop_readonly(prop) &&
2167 *source != NULL && (*source)[0] == '\0') {
2173 case PROP_TYPE_STRING:
2175 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
2176 "cannot get non-numeric property"));
2177 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
2178 dgettext(TEXT_DOMAIN, "internal error")));
2186 * Calculate the source type, given the raw source string.
2189 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
2190 char *statbuf, size_t statlen)
2192 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
2195 if (source == NULL) {
2196 *srctype = ZPROP_SRC_NONE;
2197 } else if (source[0] == '\0') {
2198 *srctype = ZPROP_SRC_DEFAULT;
2199 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
2200 *srctype = ZPROP_SRC_RECEIVED;
2202 if (strcmp(source, zhp->zfs_name) == 0) {
2203 *srctype = ZPROP_SRC_LOCAL;
2205 (void) strlcpy(statbuf, source, statlen);
2206 *srctype = ZPROP_SRC_INHERITED;
2213 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
2214 size_t proplen, boolean_t literal)
2219 if (zhp->zfs_recvd_props == NULL)
2220 if (get_recvd_props_ioctl(zhp) != 0)
2223 prop = zfs_name_to_prop(propname);
2225 if (prop != ZPROP_INVAL) {
2227 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
2229 zfs_set_recvd_props_mode(zhp, &cookie);
2230 err = zfs_prop_get(zhp, prop, propbuf, proplen,
2231 NULL, NULL, 0, literal);
2232 zfs_unset_recvd_props_mode(zhp, &cookie);
2236 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
2237 propname, &propval) != 0)
2239 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
2241 (void) strlcpy(propbuf, recvdval, proplen);
2244 return (err == 0 ? 0 : -1);
2248 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2253 value = zfs_get_clones_nvl(zhp);
2258 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
2259 pair = nvlist_next_nvpair(value, pair)) {
2260 if (propbuf[0] != '\0')
2261 (void) strlcat(propbuf, ",", proplen);
2262 (void) strlcat(propbuf, nvpair_name(pair), proplen);
2268 struct get_clones_arg {
2272 char buf[ZFS_MAX_DATASET_NAME_LEN];
2276 get_clones_cb(zfs_handle_t *zhp, void *arg)
2278 struct get_clones_arg *gca = arg;
2280 if (gca->numclones == 0) {
2285 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
2286 NULL, NULL, 0, B_TRUE) != 0)
2288 if (strcmp(gca->buf, gca->origin) == 0) {
2289 fnvlist_add_boolean(gca->value, zfs_get_name(zhp));
2294 (void) zfs_iter_children(zhp, get_clones_cb, gca);
2300 zfs_get_clones_nvl(zfs_handle_t *zhp)
2302 nvlist_t *nv, *value;
2304 if (nvlist_lookup_nvlist(zhp->zfs_props,
2305 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
2306 struct get_clones_arg gca;
2309 * if this is a snapshot, then the kernel wasn't able
2310 * to get the clones. Do it by slowly iterating.
2312 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2314 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2316 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2321 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2323 gca.origin = zhp->zfs_name;
2325 if (gca.numclones != 0) {
2327 char pool[ZFS_MAX_DATASET_NAME_LEN];
2330 /* get the pool name */
2331 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2332 (void) strsep(&cp, "/@");
2333 root = zfs_open(zhp->zfs_hdl, pool,
2334 ZFS_TYPE_FILESYSTEM);
2336 (void) get_clones_cb(root, &gca);
2339 if (gca.numclones != 0 ||
2340 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2341 nvlist_add_nvlist(zhp->zfs_props,
2342 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2349 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2350 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2353 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2359 * Accepts a property and value and checks that the value
2360 * matches the one found by the channel program. If they are
2361 * not equal, print both of them.
2364 zcp_check(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t intval,
2367 if (!zhp->zfs_hdl->libzfs_prop_debug)
2370 char *poolname = zhp->zpool_hdl->zpool_name;
2371 const char *program =
2373 "ds = args['dataset']\n"
2374 "prop = args['property']\n"
2375 "value, setpoint = zfs.get_prop(ds, prop)\n"
2376 "return {value=value, setpoint=setpoint}\n";
2379 nvlist_t *argnvl = fnvlist_alloc();
2381 fnvlist_add_string(argnvl, "dataset", zhp->zfs_name);
2382 fnvlist_add_string(argnvl, "property", zfs_prop_to_name(prop));
2384 error = lzc_channel_program(poolname, program,
2385 10 * 1000 * 1000, 10 * 1024 * 1024, argnvl, &outnvl);
2388 retnvl = fnvlist_lookup_nvlist(outnvl, "return");
2389 if (zfs_prop_get_type(prop) == PROP_TYPE_NUMBER) {
2391 error = nvlist_lookup_int64(retnvl, "value", &ans);
2393 (void) fprintf(stderr, "zcp check error: %u\n",
2397 if (ans != intval) {
2398 (void) fprintf(stderr,
2399 "%s: zfs found %lld, but zcp found %lld\n",
2400 zfs_prop_to_name(prop),
2401 (longlong_t)intval, (longlong_t)ans);
2405 error = nvlist_lookup_string(retnvl, "value", &str_ans);
2407 (void) fprintf(stderr, "zcp check error: %u\n",
2411 if (strcmp(strval, str_ans) != 0) {
2412 (void) fprintf(stderr,
2413 "%s: zfs found %s, but zcp found %s\n",
2414 zfs_prop_to_name(prop),
2419 (void) fprintf(stderr,
2420 "zcp check failed, channel program error: %u\n", error);
2422 nvlist_free(argnvl);
2423 nvlist_free(outnvl);
2427 * Retrieve a property from the given object. If 'literal' is specified, then
2428 * numbers are left as exact values. Otherwise, numbers are converted to a
2429 * human-readable form.
2431 * Returns 0 on success, or -1 on error.
2434 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2435 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2437 char *source = NULL;
2441 boolean_t received = zfs_is_recvd_props_mode(zhp);
2444 * Check to see if this property applies to our object
2446 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
2449 if (received && zfs_prop_readonly(prop))
2453 *src = ZPROP_SRC_NONE;
2456 case ZFS_PROP_CREATION:
2458 * 'creation' is a time_t stored in the statistics. We convert
2459 * this into a string unless 'literal' is specified.
2462 val = getprop_uint64(zhp, prop, &source);
2463 time_t time = (time_t)val;
2467 localtime_r(&time, &t) == NULL ||
2468 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2470 (void) snprintf(propbuf, proplen, "%llu", val);
2472 zcp_check(zhp, prop, val, NULL);
2475 case ZFS_PROP_MOUNTPOINT:
2477 * Getting the precise mountpoint can be tricky.
2479 * - for 'none' or 'legacy', return those values.
2480 * - for inherited mountpoints, we want to take everything
2481 * after our ancestor and append it to the inherited value.
2483 * If the pool has an alternate root, we want to prepend that
2484 * root to any values we return.
2487 str = getprop_string(zhp, prop, &source);
2489 if (str[0] == '/') {
2490 char buf[MAXPATHLEN];
2492 const char *relpath;
2495 * If we inherit the mountpoint, even from a dataset
2496 * with a received value, the source will be the path of
2497 * the dataset we inherit from. If source is
2498 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2501 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2504 relpath = zhp->zfs_name + strlen(source);
2505 if (relpath[0] == '/')
2509 if ((zpool_get_prop(zhp->zpool_hdl,
2510 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2511 B_FALSE)) || (strcmp(root, "-") == 0))
2514 * Special case an alternate root of '/'. This will
2515 * avoid having multiple leading slashes in the
2518 if (strcmp(root, "/") == 0)
2522 * If the mountpoint is '/' then skip over this
2523 * if we are obtaining either an alternate root or
2524 * an inherited mountpoint.
2526 if (str[1] == '\0' && (root[0] != '\0' ||
2527 relpath[0] != '\0'))
2530 if (relpath[0] == '\0')
2531 (void) snprintf(propbuf, proplen, "%s%s",
2534 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2535 root, str, relpath[0] == '@' ? "" : "/",
2538 /* 'legacy' or 'none' */
2539 (void) strlcpy(propbuf, str, proplen);
2541 zcp_check(zhp, prop, NULL, propbuf);
2544 case ZFS_PROP_ORIGIN:
2545 str = getprop_string(zhp, prop, &source);
2548 (void) strlcpy(propbuf, str, proplen);
2549 zcp_check(zhp, prop, NULL, str);
2552 case ZFS_PROP_CLONES:
2553 if (get_clones_string(zhp, propbuf, proplen) != 0)
2557 case ZFS_PROP_QUOTA:
2558 case ZFS_PROP_REFQUOTA:
2559 case ZFS_PROP_RESERVATION:
2560 case ZFS_PROP_REFRESERVATION:
2562 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2565 * If quota or reservation is 0, we translate this into 'none'
2566 * (unless literal is set), and indicate that it's the default
2567 * value. Otherwise, we print the number nicely and indicate
2568 * that its set locally.
2572 (void) strlcpy(propbuf, "0", proplen);
2574 (void) strlcpy(propbuf, "none", proplen);
2577 (void) snprintf(propbuf, proplen, "%llu",
2580 zfs_nicenum(val, propbuf, proplen);
2582 zcp_check(zhp, prop, val, NULL);
2585 case ZFS_PROP_FILESYSTEM_LIMIT:
2586 case ZFS_PROP_SNAPSHOT_LIMIT:
2587 case ZFS_PROP_FILESYSTEM_COUNT:
2588 case ZFS_PROP_SNAPSHOT_COUNT:
2590 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2594 * If limit is UINT64_MAX, we translate this into 'none' (unless
2595 * literal is set), and indicate that it's the default value.
2596 * Otherwise, we print the number nicely and indicate that it's
2600 (void) snprintf(propbuf, proplen, "%llu",
2602 } else if (val == UINT64_MAX) {
2603 (void) strlcpy(propbuf, "none", proplen);
2605 zfs_nicenum(val, propbuf, proplen);
2608 zcp_check(zhp, prop, val, NULL);
2611 case ZFS_PROP_REFRATIO:
2612 case ZFS_PROP_COMPRESSRATIO:
2613 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2615 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2616 (u_longlong_t)(val / 100),
2617 (u_longlong_t)(val % 100));
2618 zcp_check(zhp, prop, val, NULL);
2622 switch (zhp->zfs_type) {
2623 case ZFS_TYPE_FILESYSTEM:
2626 case ZFS_TYPE_VOLUME:
2629 case ZFS_TYPE_SNAPSHOT:
2632 case ZFS_TYPE_BOOKMARK:
2638 (void) snprintf(propbuf, proplen, "%s", str);
2639 zcp_check(zhp, prop, NULL, propbuf);
2642 case ZFS_PROP_MOUNTED:
2644 * The 'mounted' property is a pseudo-property that described
2645 * whether the filesystem is currently mounted. Even though
2646 * it's a boolean value, the typical values of "on" and "off"
2647 * don't make sense, so we translate to "yes" and "no".
2649 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2650 src, &source, &val) != 0)
2653 (void) strlcpy(propbuf, "yes", proplen);
2655 (void) strlcpy(propbuf, "no", proplen);
2660 * The 'name' property is a pseudo-property derived from the
2661 * dataset name. It is presented as a real property to simplify
2664 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2665 zcp_check(zhp, prop, NULL, propbuf);
2668 case ZFS_PROP_MLSLABEL:
2671 m_label_t *new_sl = NULL;
2672 char *ascii = NULL; /* human readable label */
2674 (void) strlcpy(propbuf,
2675 getprop_string(zhp, prop, &source), proplen);
2677 if (literal || (strcasecmp(propbuf,
2678 ZFS_MLSLABEL_DEFAULT) == 0))
2682 * Try to translate the internal hex string to
2683 * human-readable output. If there are any
2684 * problems just use the hex string.
2687 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2688 L_NO_CORRECTION, NULL) == -1) {
2689 m_label_free(new_sl);
2693 if (label_to_str(new_sl, &ascii, M_LABEL,
2697 m_label_free(new_sl);
2700 m_label_free(new_sl);
2702 (void) strlcpy(propbuf, ascii, proplen);
2704 #else /* !illumos */
2706 #endif /* illumos */
2712 * GUIDs are stored as numbers, but they are identifiers.
2713 * We don't want them to be pretty printed, because pretty
2714 * printing mangles the ID into a truncated and useless value.
2716 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2718 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2719 zcp_check(zhp, prop, val, NULL);
2723 switch (zfs_prop_get_type(prop)) {
2724 case PROP_TYPE_NUMBER:
2725 if (get_numeric_property(zhp, prop, src,
2726 &source, &val) != 0) {
2731 (void) snprintf(propbuf, proplen, "%llu",
2734 zfs_nicenum(val, propbuf, proplen);
2736 zcp_check(zhp, prop, val, NULL);
2739 case PROP_TYPE_STRING:
2740 str = getprop_string(zhp, prop, &source);
2744 (void) strlcpy(propbuf, str, proplen);
2745 zcp_check(zhp, prop, NULL, str);
2748 case PROP_TYPE_INDEX:
2749 if (get_numeric_property(zhp, prop, src,
2750 &source, &val) != 0)
2752 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2755 (void) strlcpy(propbuf, strval, proplen);
2756 zcp_check(zhp, prop, NULL, strval);
2764 get_source(zhp, src, source, statbuf, statlen);
2770 * Utility function to get the given numeric property. Does no validation that
2771 * the given property is the appropriate type; should only be used with
2772 * hard-coded property types.
2775 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2780 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2786 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2790 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2791 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2795 * Similar to zfs_prop_get(), but returns the value as an integer.
2798 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2799 zprop_source_t *src, char *statbuf, size_t statlen)
2804 * Check to see if this property applies to our object
2806 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) {
2807 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2808 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2809 zfs_prop_to_name(prop)));
2813 *src = ZPROP_SRC_NONE;
2815 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2818 get_source(zhp, src, source, statbuf, statlen);
2824 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2825 char **domainp, idmap_rid_t *ridp)
2828 idmap_get_handle_t *get_hdl = NULL;
2832 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2836 err = idmap_get_sidbyuid(get_hdl, id,
2837 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2839 err = idmap_get_sidbygid(get_hdl, id,
2840 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2842 if (err == IDMAP_SUCCESS &&
2843 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2844 status == IDMAP_SUCCESS)
2850 idmap_get_destroy(get_hdl);
2852 #else /* !illumos */
2853 assert(!"invalid code path");
2854 return (EINVAL); // silence compiler warning
2855 #endif /* illumos */
2859 * convert the propname into parameters needed by kernel
2860 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2861 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2864 userquota_propname_decode(const char *propname, boolean_t zoned,
2865 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2867 zfs_userquota_prop_t type;
2869 char *numericsid = NULL;
2874 /* Figure out the property type ({user|group}{quota|space}) */
2875 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2876 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2877 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2880 if (type == ZFS_NUM_USERQUOTA_PROPS)
2884 isuser = (type == ZFS_PROP_USERQUOTA ||
2885 type == ZFS_PROP_USERUSED);
2887 cp = strchr(propname, '@') + 1;
2889 if (strchr(cp, '@')) {
2892 * It's a SID name (eg "user@domain") that needs to be
2893 * turned into S-1-domainID-RID.
2896 idmap_stat stat, map_stat;
2899 idmap_get_handle_t *gh = NULL;
2901 stat = idmap_get_create(&gh);
2902 if (stat != IDMAP_SUCCESS) {
2903 idmap_get_destroy(gh);
2906 if (zoned && getzoneid() == GLOBAL_ZONEID)
2909 stat = idmap_getuidbywinname(cp, NULL, flag, &pid);
2912 stat = idmap_get_sidbyuid(gh, pid, flag, &numericsid,
2915 stat = idmap_getgidbywinname(cp, NULL, flag, &pid);
2918 stat = idmap_get_sidbygid(gh, pid, flag, &numericsid,
2922 idmap_get_destroy(gh);
2925 stat = idmap_get_mappings(gh);
2926 idmap_get_destroy(gh);
2931 if (numericsid == NULL)
2935 /* will be further decoded below */
2936 #else /* !illumos */
2938 #endif /* illumos */
2941 if (strncmp(cp, "S-1-", 4) == 0) {
2942 /* It's a numeric SID (eg "S-1-234-567-89") */
2943 (void) strlcpy(domain, cp, domainlen);
2946 cp = strrchr(domain, '-');
2949 *ridp = strtoull(cp, &end, 10);
2957 if (errno != 0 || *end != '\0')
2959 } else if (!isdigit(*cp)) {
2961 * It's a user/group name (eg "user") that needs to be
2962 * turned into a uid/gid
2964 if (zoned && getzoneid() == GLOBAL_ZONEID)
2980 /* It's a user/group ID (eg "12345"). */
2981 uid_t id = strtoul(cp, &end, 10);
2988 /* It's an ephemeral ID. */
2989 if (idmap_id_to_numeric_domain_rid(id, isuser,
2990 &mapdomain, &rid) != 0)
2992 (void) strlcpy(domain, mapdomain, domainlen);
2999 ASSERT3P(numericsid, ==, NULL);
3004 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
3005 uint64_t *propvalue, zfs_userquota_prop_t *typep)
3008 zfs_cmd_t zc = { 0 };
3010 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3012 err = userquota_propname_decode(propname,
3013 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
3014 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
3015 zc.zc_objset_type = *typep;
3019 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
3023 *propvalue = zc.zc_cookie;
3028 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
3029 uint64_t *propvalue)
3031 zfs_userquota_prop_t type;
3033 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
3038 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
3039 char *propbuf, int proplen, boolean_t literal)
3043 zfs_userquota_prop_t type;
3045 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
3052 (void) snprintf(propbuf, proplen, "%llu", propvalue);
3053 } else if (propvalue == 0 &&
3054 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
3055 (void) strlcpy(propbuf, "none", proplen);
3057 zfs_nicenum(propvalue, propbuf, proplen);
3063 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
3064 uint64_t *propvalue)
3067 zfs_cmd_t zc = { 0 };
3068 const char *snapname;
3070 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3072 snapname = strchr(propname, '@') + 1;
3073 if (strchr(snapname, '@')) {
3074 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
3076 /* snapname is the short name, append it to zhp's fsname */
3079 (void) strlcpy(zc.zc_value, zhp->zfs_name,
3080 sizeof (zc.zc_value));
3081 cp = strchr(zc.zc_value, '@');
3084 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
3085 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
3088 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
3092 *propvalue = zc.zc_cookie;
3097 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
3098 char *propbuf, int proplen, boolean_t literal)
3103 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
3109 (void) snprintf(propbuf, proplen, "%llu", propvalue);
3111 zfs_nicenum(propvalue, propbuf, proplen);
3117 * Returns the name of the given zfs handle.
3120 zfs_get_name(const zfs_handle_t *zhp)
3122 return (zhp->zfs_name);
3126 * Returns the name of the parent pool for the given zfs handle.
3129 zfs_get_pool_name(const zfs_handle_t *zhp)
3131 return (zhp->zpool_hdl->zpool_name);
3135 * Returns the type of the given zfs handle.
3138 zfs_get_type(const zfs_handle_t *zhp)
3140 return (zhp->zfs_type);
3144 * Is one dataset name a child dataset of another?
3146 * Needs to handle these cases:
3147 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
3148 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
3149 * Descendant? No. No. No. Yes.
3152 is_descendant(const char *ds1, const char *ds2)
3154 size_t d1len = strlen(ds1);
3156 /* ds2 can't be a descendant if it's smaller */
3157 if (strlen(ds2) < d1len)
3160 /* otherwise, compare strings and verify that there's a '/' char */
3161 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
3165 * Given a complete name, return just the portion that refers to the parent.
3166 * Will return -1 if there is no parent (path is just the name of the
3170 parent_name(const char *path, char *buf, size_t buflen)
3174 (void) strlcpy(buf, path, buflen);
3176 if ((slashp = strrchr(buf, '/')) == NULL)
3184 * If accept_ancestor is false, then check to make sure that the given path has
3185 * a parent, and that it exists. If accept_ancestor is true, then find the
3186 * closest existing ancestor for the given path. In prefixlen return the
3187 * length of already existing prefix of the given path. We also fetch the
3188 * 'zoned' property, which is used to validate property settings when creating
3192 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
3193 boolean_t accept_ancestor, int *prefixlen)
3195 zfs_cmd_t zc = { 0 };
3196 char parent[ZFS_MAX_DATASET_NAME_LEN];
3202 (void) snprintf(errbuf, sizeof (errbuf),
3203 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
3205 /* get parent, and check to see if this is just a pool */
3206 if (parent_name(path, parent, sizeof (parent)) != 0) {
3207 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3208 "missing dataset name"));
3209 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3212 /* check to see if the pool exists */
3213 if ((slash = strchr(parent, '/')) == NULL)
3214 slash = parent + strlen(parent);
3215 (void) strncpy(zc.zc_name, parent, slash - parent);
3216 zc.zc_name[slash - parent] = '\0';
3217 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
3219 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3220 "no such pool '%s'"), zc.zc_name);
3221 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3224 /* check to see if the parent dataset exists */
3225 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
3226 if (errno == ENOENT && accept_ancestor) {
3228 * Go deeper to find an ancestor, give up on top level.
3230 if (parent_name(parent, parent, sizeof (parent)) != 0) {
3231 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3232 "no such pool '%s'"), zc.zc_name);
3233 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3235 } else if (errno == ENOENT) {
3236 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3237 "parent does not exist"));
3238 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3240 return (zfs_standard_error(hdl, errno, errbuf));
3243 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
3247 /* we are in a non-global zone, but parent is in the global zone */
3248 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
3249 (void) zfs_standard_error(hdl, EPERM, errbuf);
3254 /* make sure parent is a filesystem */
3255 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
3256 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3257 "parent is not a filesystem"));
3258 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
3264 if (prefixlen != NULL)
3265 *prefixlen = strlen(parent);
3270 * Finds whether the dataset of the given type(s) exists.
3273 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
3277 if (!zfs_validate_name(hdl, path, types, B_FALSE))
3281 * Try to get stats for the dataset, which will tell us if it exists.
3283 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
3284 int ds_type = zhp->zfs_type;
3287 if (types & ds_type)
3294 * Given a path to 'target', create all the ancestors between
3295 * the prefixlen portion of the path, and the target itself.
3296 * Fail if the initial prefixlen-ancestor does not already exist.
3299 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
3305 /* make sure prefix exists */
3306 cp = target + prefixlen;
3308 assert(strchr(cp, '/') == NULL);
3309 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3312 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3320 * Attempt to create, mount, and share any ancestor filesystems,
3321 * up to the prefixlen-long one.
3323 for (cp = target + prefixlen + 1;
3324 (cp = strchr(cp, '/')) != NULL; *cp = '/', cp++) {
3328 h = make_dataset_handle(hdl, target);
3330 /* it already exists, nothing to do here */
3335 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
3337 opname = dgettext(TEXT_DOMAIN, "create");
3341 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3343 opname = dgettext(TEXT_DOMAIN, "open");
3347 if (zfs_mount(h, NULL, 0) != 0) {
3348 opname = dgettext(TEXT_DOMAIN, "mount");
3352 if (zfs_share(h) != 0) {
3353 opname = dgettext(TEXT_DOMAIN, "share");
3363 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3364 "failed to %s ancestor '%s'"), opname, target);
3369 * Creates non-existing ancestors of the given path.
3372 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
3378 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
3381 if ((path_copy = strdup(path)) != NULL) {
3382 rc = create_parents(hdl, path_copy, prefix);
3385 if (path_copy == NULL || rc != 0)
3392 * Create a new filesystem or volume.
3395 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
3400 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
3403 enum lzc_dataset_type ost;
3404 zpool_handle_t *zpool_handle;
3406 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3407 "cannot create '%s'"), path);
3409 /* validate the path, taking care to note the extended error message */
3410 if (!zfs_validate_name(hdl, path, type, B_TRUE))
3411 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3413 /* validate parents exist */
3414 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
3418 * The failure modes when creating a dataset of a different type over
3419 * one that already exists is a little strange. In particular, if you
3420 * try to create a dataset on top of an existing dataset, the ioctl()
3421 * will return ENOENT, not EEXIST. To prevent this from happening, we
3422 * first try to see if the dataset exists.
3424 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
3425 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3426 "dataset already exists"));
3427 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3430 if (type == ZFS_TYPE_VOLUME)
3431 ost = LZC_DATSET_TYPE_ZVOL;
3433 ost = LZC_DATSET_TYPE_ZFS;
3435 /* open zpool handle for prop validation */
3436 char pool_path[ZFS_MAX_DATASET_NAME_LEN];
3437 (void) strlcpy(pool_path, path, sizeof (pool_path));
3439 /* truncate pool_path at first slash */
3440 char *p = strchr(pool_path, '/');
3444 if ((zpool_handle = zpool_open(hdl, pool_path)) == NULL)
3447 if (props && (props = zfs_valid_proplist(hdl, type, props,
3448 zoned, NULL, zpool_handle, errbuf)) == 0) {
3449 zpool_close(zpool_handle);
3452 zpool_close(zpool_handle);
3454 if (type == ZFS_TYPE_VOLUME) {
3456 * If we are creating a volume, the size and block size must
3457 * satisfy a few restraints. First, the blocksize must be a
3458 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3459 * volsize must be a multiple of the block size, and cannot be
3462 if (props == NULL || nvlist_lookup_uint64(props,
3463 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3465 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3466 "missing volume size"));
3467 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3470 if ((ret = nvlist_lookup_uint64(props,
3471 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3472 &blocksize)) != 0) {
3473 if (ret == ENOENT) {
3474 blocksize = zfs_prop_default_numeric(
3475 ZFS_PROP_VOLBLOCKSIZE);
3478 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3479 "missing volume block size"));
3480 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3486 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3487 "volume size cannot be zero"));
3488 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3491 if (size % blocksize != 0) {
3493 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3494 "volume size must be a multiple of volume block "
3496 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3500 /* create the dataset */
3501 ret = lzc_create(path, ost, props);
3504 /* check for failure */
3506 char parent[ZFS_MAX_DATASET_NAME_LEN];
3507 (void) parent_name(path, parent, sizeof (parent));
3511 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3512 "no such parent '%s'"), parent);
3513 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3516 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3517 "parent '%s' is not a filesystem"), parent);
3518 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3521 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3522 "pool must be upgraded to set this "
3523 "property or value"));
3524 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3528 * This platform can't address a volume this big.
3530 if (type == ZFS_TYPE_VOLUME)
3531 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3536 return (zfs_standard_error(hdl, errno, errbuf));
3544 * Destroys the given dataset. The caller must make sure that the filesystem
3545 * isn't mounted, and that there are no active dependents. If the file system
3546 * does not exist this function does nothing.
3549 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3551 zfs_cmd_t zc = { 0 };
3553 if (zhp->zfs_type == ZFS_TYPE_BOOKMARK) {
3554 nvlist_t *nv = fnvlist_alloc();
3555 fnvlist_add_boolean(nv, zhp->zfs_name);
3556 int error = lzc_destroy_bookmarks(nv, NULL);
3559 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3560 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3566 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3568 if (ZFS_IS_VOLUME(zhp)) {
3569 zc.zc_objset_type = DMU_OST_ZVOL;
3571 zc.zc_objset_type = DMU_OST_ZFS;
3574 zc.zc_defer_destroy = defer;
3575 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0 &&
3577 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3578 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3582 remove_mountpoint(zhp);
3587 struct destroydata {
3589 const char *snapname;
3593 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3595 struct destroydata *dd = arg;
3596 char name[ZFS_MAX_DATASET_NAME_LEN];
3599 (void) snprintf(name, sizeof (name),
3600 "%s@%s", zhp->zfs_name, dd->snapname);
3602 if (lzc_exists(name))
3603 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3605 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3611 * Destroys all snapshots with the given name in zhp & descendants.
3614 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3617 struct destroydata dd = { 0 };
3619 dd.snapname = snapname;
3620 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3621 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3623 if (nvlist_empty(dd.nvl)) {
3624 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3625 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3626 zhp->zfs_name, snapname);
3628 ret = zfs_destroy_snaps_nvl(zhp->zfs_hdl, dd.nvl, defer);
3630 nvlist_free(dd.nvl);
3635 * Destroys all the snapshots named in the nvlist.
3638 zfs_destroy_snaps_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, boolean_t defer)
3641 nvlist_t *errlist = NULL;
3643 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3646 nvlist_free(errlist);
3650 if (nvlist_empty(errlist)) {
3652 (void) snprintf(errbuf, sizeof (errbuf),
3653 dgettext(TEXT_DOMAIN, "cannot destroy snapshots"));
3655 ret = zfs_standard_error(hdl, ret, errbuf);
3657 for (nvpair_t *pair = nvlist_next_nvpair(errlist, NULL);
3658 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3660 (void) snprintf(errbuf, sizeof (errbuf),
3661 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3664 switch (fnvpair_value_int32(pair)) {
3667 dgettext(TEXT_DOMAIN, "snapshot is cloned"));
3668 ret = zfs_error(hdl, EZFS_EXISTS, errbuf);
3671 ret = zfs_standard_error(hdl, errno, errbuf);
3676 nvlist_free(errlist);
3681 * Clones the given dataset. The target must be of the same type as the source.
3684 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3686 char parent[ZFS_MAX_DATASET_NAME_LEN];
3689 libzfs_handle_t *hdl = zhp->zfs_hdl;
3692 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3694 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3695 "cannot create '%s'"), target);
3697 /* validate the target/clone name */
3698 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3699 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3701 /* validate parents exist */
3702 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3705 (void) parent_name(target, parent, sizeof (parent));
3711 if (ZFS_IS_VOLUME(zhp)) {
3712 type = ZFS_TYPE_VOLUME;
3714 type = ZFS_TYPE_FILESYSTEM;
3716 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3717 zhp, zhp->zpool_hdl, errbuf)) == NULL)
3721 ret = lzc_clone(target, zhp->zfs_name, props);
3729 * The parent doesn't exist. We should have caught this
3730 * above, but there may a race condition that has since
3731 * destroyed the parent.
3733 * At this point, we don't know whether it's the source
3734 * that doesn't exist anymore, or whether the target
3735 * dataset doesn't exist.
3737 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3738 "no such parent '%s'"), parent);
3739 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3742 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3743 "source and target pools differ"));
3744 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3748 return (zfs_standard_error(zhp->zfs_hdl, errno,
3757 * Promotes the given clone fs to be the clone parent.
3760 zfs_promote(zfs_handle_t *zhp)
3762 libzfs_handle_t *hdl = zhp->zfs_hdl;
3763 char snapname[ZFS_MAX_DATASET_NAME_LEN];
3767 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3768 "cannot promote '%s'"), zhp->zfs_name);
3770 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3771 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3772 "snapshots can not be promoted"));
3773 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3776 if (zhp->zfs_dmustats.dds_origin[0] == '\0') {
3777 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3778 "not a cloned filesystem"));
3779 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3782 ret = lzc_promote(zhp->zfs_name, snapname, sizeof (snapname));
3787 /* There is a conflicting snapshot name. */
3788 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3789 "conflicting snapshot '%s' from parent '%s'"),
3790 snapname, zhp->zfs_dmustats.dds_origin);
3791 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3794 return (zfs_standard_error(hdl, ret, errbuf));
3800 typedef struct snapdata {
3802 const char *sd_snapname;
3806 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
3808 snapdata_t *sd = arg;
3809 char name[ZFS_MAX_DATASET_NAME_LEN];
3812 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) == 0) {
3813 (void) snprintf(name, sizeof (name),
3814 "%s@%s", zfs_get_name(zhp), sd->sd_snapname);
3816 fnvlist_add_boolean(sd->sd_nvl, name);
3818 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
3826 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3830 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
3837 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3838 "cannot create snapshots "));
3841 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
3842 const char *snapname = nvpair_name(elem);
3844 /* validate the target name */
3845 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
3847 (void) snprintf(errbuf, sizeof (errbuf),
3848 dgettext(TEXT_DOMAIN,
3849 "cannot create snapshot '%s'"), snapname);
3850 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3855 * get pool handle for prop validation. assumes all snaps are in the
3856 * same pool, as does lzc_snapshot (below).
3858 char pool[ZFS_MAX_DATASET_NAME_LEN];
3859 elem = nvlist_next_nvpair(snaps, NULL);
3860 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
3861 pool[strcspn(pool, "/@")] = '\0';
3862 zpool_handle_t *zpool_hdl = zpool_open(hdl, pool);
3864 if (props != NULL &&
3865 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3866 props, B_FALSE, NULL, zpool_hdl, errbuf)) == NULL) {
3867 zpool_close(zpool_hdl);
3870 zpool_close(zpool_hdl);
3872 ret = lzc_snapshot(snaps, props, &errors);
3875 boolean_t printed = B_FALSE;
3876 for (elem = nvlist_next_nvpair(errors, NULL);
3878 elem = nvlist_next_nvpair(errors, elem)) {
3879 (void) snprintf(errbuf, sizeof (errbuf),
3880 dgettext(TEXT_DOMAIN,
3881 "cannot create snapshot '%s'"), nvpair_name(elem));
3882 (void) zfs_standard_error(hdl,
3883 fnvpair_value_int32(elem), errbuf);
3889 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3890 "multiple snapshots of same "
3892 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3896 (void) zfs_standard_error(hdl, ret, errbuf);
3902 nvlist_free(errors);
3907 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3911 snapdata_t sd = { 0 };
3912 char fsname[ZFS_MAX_DATASET_NAME_LEN];
3917 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3918 "cannot snapshot %s"), path);
3920 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3921 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3923 (void) strlcpy(fsname, path, sizeof (fsname));
3924 cp = strchr(fsname, '@');
3926 sd.sd_snapname = cp + 1;
3928 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
3929 ZFS_TYPE_VOLUME)) == NULL) {
3933 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
3935 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
3937 fnvlist_add_boolean(sd.sd_nvl, path);
3940 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
3941 nvlist_free(sd.sd_nvl);
3947 * Destroy any more recent snapshots. We invoke this callback on any dependents
3948 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3949 * is a dependent and we should just destroy it without checking the transaction
3952 typedef struct rollback_data {
3953 const char *cb_target; /* the snapshot */
3954 uint64_t cb_create; /* creation time reference */
3960 rollback_destroy_dependent(zfs_handle_t *zhp, void *data)
3962 rollback_data_t *cbp = data;
3963 prop_changelist_t *clp;
3965 /* We must destroy this clone; first unmount it */
3966 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3967 cbp->cb_force ? MS_FORCE: 0);
3968 if (clp == NULL || changelist_prefix(clp) != 0) {
3969 cbp->cb_error = B_TRUE;
3973 if (zfs_destroy(zhp, B_FALSE) != 0)
3974 cbp->cb_error = B_TRUE;
3976 changelist_remove(clp, zhp->zfs_name);
3977 (void) changelist_postfix(clp);
3978 changelist_free(clp);
3985 rollback_destroy(zfs_handle_t *zhp, void *data)
3987 rollback_data_t *cbp = data;
3989 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > cbp->cb_create) {
3990 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3991 rollback_destroy_dependent, cbp);
3993 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
4001 * Given a dataset, rollback to a specific snapshot, discarding any
4002 * data changes since then and making it the active dataset.
4004 * Any snapshots and bookmarks more recent than the target are
4005 * destroyed, along with their dependents (i.e. clones).
4008 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
4010 rollback_data_t cb = { 0 };
4012 boolean_t restore_resv = 0;
4013 uint64_t old_volsize = 0, new_volsize;
4014 zfs_prop_t resv_prop;
4016 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
4017 zhp->zfs_type == ZFS_TYPE_VOLUME);
4020 * Destroy all recent snapshots and their dependents.
4022 cb.cb_force = force;
4023 cb.cb_target = snap->zfs_name;
4024 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
4025 (void) zfs_iter_snapshots(zhp, B_FALSE, rollback_destroy, &cb);
4026 (void) zfs_iter_bookmarks(zhp, rollback_destroy, &cb);
4032 * Now that we have verified that the snapshot is the latest,
4033 * rollback to the given snapshot.
4036 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
4037 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
4039 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
4041 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
4045 * Pass both the filesystem and the wanted snapshot names,
4046 * we would get an error back if the snapshot is destroyed or
4047 * a new snapshot is created before this request is processed.
4049 err = lzc_rollback_to(zhp->zfs_name, snap->zfs_name);
4051 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
4052 "'%s' is not the latest snapshot"), snap->zfs_name);
4053 (void) zfs_error_fmt(zhp->zfs_hdl, EZFS_BUSY,
4054 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
4057 } else if (err != 0) {
4058 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
4059 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
4065 * For volumes, if the pre-rollback volsize matched the pre-
4066 * rollback reservation and the volsize has changed then set
4067 * the reservation property to the post-rollback volsize.
4068 * Make a new handle since the rollback closed the dataset.
4070 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
4071 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
4073 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
4074 if (old_volsize != new_volsize)
4075 err = zfs_prop_set_int(zhp, resv_prop,
4084 * Renames the given dataset.
4087 zfs_rename(zfs_handle_t *zhp, const char *source, const char *target,
4088 renameflags_t flags)
4091 zfs_cmd_t zc = { 0 };
4093 prop_changelist_t *cl = NULL;
4094 zfs_handle_t *zhrp = NULL;
4095 char *parentname = NULL;
4096 char parent[ZFS_MAX_DATASET_NAME_LEN];
4097 char property[ZFS_MAXPROPLEN];
4098 libzfs_handle_t *hdl = zhp->zfs_hdl;
4101 /* if we have the same exact name, just return success */
4102 if (strcmp(zhp->zfs_name, target) == 0)
4105 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4106 "cannot rename to '%s'"), target);
4108 if (source != NULL) {
4110 * This is recursive snapshots rename, put snapshot name
4111 * (that might not exist) into zfs_name.
4113 assert(flags.recurse);
4115 (void) strlcat(zhp->zfs_name, "@", sizeof(zhp->zfs_name));
4116 (void) strlcat(zhp->zfs_name, source, sizeof(zhp->zfs_name));
4117 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
4121 * Make sure the target name is valid
4123 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
4124 if ((strchr(target, '@') == NULL) ||
4127 * Snapshot target name is abbreviated,
4128 * reconstruct full dataset name
4130 (void) strlcpy(parent, zhp->zfs_name,
4132 delim = strchr(parent, '@');
4133 if (strchr(target, '@') == NULL)
4137 (void) strlcat(parent, target, sizeof (parent));
4141 * Make sure we're renaming within the same dataset.
4143 delim = strchr(target, '@');
4144 if (strncmp(zhp->zfs_name, target, delim - target)
4145 != 0 || zhp->zfs_name[delim - target] != '@') {
4146 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4147 "snapshots must be part of same "
4149 return (zfs_error(hdl, EZFS_CROSSTARGET,
4153 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
4154 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4156 if (flags.recurse) {
4157 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4158 "recursive rename must be a snapshot"));
4159 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4162 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
4163 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4165 /* validate parents */
4166 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
4169 /* make sure we're in the same pool */
4170 verify((delim = strchr(target, '/')) != NULL);
4171 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
4172 zhp->zfs_name[delim - target] != '/') {
4173 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4174 "datasets must be within same pool"));
4175 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
4178 /* new name cannot be a child of the current dataset name */
4179 if (is_descendant(zhp->zfs_name, target)) {
4180 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4181 "New dataset name cannot be a descendant of "
4182 "current dataset name"));
4183 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4187 (void) snprintf(errbuf, sizeof (errbuf),
4188 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
4190 if (getzoneid() == GLOBAL_ZONEID &&
4191 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
4192 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4193 "dataset is used in a non-global zone"));
4194 return (zfs_error(hdl, EZFS_ZONED, errbuf));
4198 * Avoid unmounting file systems with mountpoint property set to
4199 * 'legacy' or 'none' even if -u option is not given.
4201 if (zhp->zfs_type == ZFS_TYPE_FILESYSTEM &&
4202 !flags.recurse && !flags.nounmount &&
4203 zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, property,
4204 sizeof (property), NULL, NULL, 0, B_FALSE) == 0 &&
4205 (strcmp(property, "legacy") == 0 ||
4206 strcmp(property, "none") == 0)) {
4207 flags.nounmount = B_TRUE;
4209 if (flags.recurse) {
4211 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
4212 if (parentname == NULL) {
4216 delim = strchr(parentname, '@');
4218 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
4223 } else if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT) {
4224 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME,
4225 flags.nounmount ? CL_GATHER_DONT_UNMOUNT : 0,
4226 flags.forceunmount ? MS_FORCE : 0)) == NULL) {
4230 if (changelist_haszonedchild(cl)) {
4231 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4232 "child dataset with inherited mountpoint is used "
4233 "in a non-global zone"));
4234 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
4239 if ((ret = changelist_prefix(cl)) != 0)
4243 if (ZFS_IS_VOLUME(zhp))
4244 zc.zc_objset_type = DMU_OST_ZVOL;
4246 zc.zc_objset_type = DMU_OST_ZFS;
4248 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4249 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
4251 zc.zc_cookie = flags.recurse ? 1 : 0;
4252 if (flags.nounmount)
4255 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
4257 * if it was recursive, the one that actually failed will
4260 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4261 "cannot rename '%s'"), zc.zc_name);
4263 if (flags.recurse && errno == EEXIST) {
4264 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4265 "a child dataset already has a snapshot "
4266 "with the new name"));
4267 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
4269 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
4273 * On failure, we still want to remount any filesystems that
4274 * were previously mounted, so we don't alter the system state.
4277 (void) changelist_postfix(cl);
4280 changelist_rename(cl, zfs_get_name(zhp), target);
4281 ret = changelist_postfix(cl);
4286 if (parentname != NULL) {
4293 changelist_free(cl);
4299 zfs_get_user_props(zfs_handle_t *zhp)
4301 return (zhp->zfs_user_props);
4305 zfs_get_recvd_props(zfs_handle_t *zhp)
4307 if (zhp->zfs_recvd_props == NULL)
4308 if (get_recvd_props_ioctl(zhp) != 0)
4310 return (zhp->zfs_recvd_props);
4314 * This function is used by 'zfs list' to determine the exact set of columns to
4315 * display, and their maximum widths. This does two main things:
4317 * - If this is a list of all properties, then expand the list to include
4318 * all native properties, and set a flag so that for each dataset we look
4319 * for new unique user properties and add them to the list.
4321 * - For non fixed-width properties, keep track of the maximum width seen
4322 * so that we can size the column appropriately. If the user has
4323 * requested received property values, we also need to compute the width
4324 * of the RECEIVED column.
4327 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received,
4330 libzfs_handle_t *hdl = zhp->zfs_hdl;
4331 zprop_list_t *entry;
4332 zprop_list_t **last, **start;
4333 nvlist_t *userprops, *propval;
4336 char buf[ZFS_MAXPROPLEN];
4338 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
4341 userprops = zfs_get_user_props(zhp);
4344 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
4346 * Go through and add any user properties as necessary. We
4347 * start by incrementing our list pointer to the first
4348 * non-native property.
4351 while (*start != NULL) {
4352 if ((*start)->pl_prop == ZPROP_INVAL)
4354 start = &(*start)->pl_next;
4358 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
4360 * See if we've already found this property in our list.
4362 for (last = start; *last != NULL;
4363 last = &(*last)->pl_next) {
4364 if (strcmp((*last)->pl_user_prop,
4365 nvpair_name(elem)) == 0)
4369 if (*last == NULL) {
4370 if ((entry = zfs_alloc(hdl,
4371 sizeof (zprop_list_t))) == NULL ||
4372 ((entry->pl_user_prop = zfs_strdup(hdl,
4373 nvpair_name(elem)))) == NULL) {
4378 entry->pl_prop = ZPROP_INVAL;
4379 entry->pl_width = strlen(nvpair_name(elem));
4380 entry->pl_all = B_TRUE;
4387 * Now go through and check the width of any non-fixed columns
4389 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
4390 if (entry->pl_fixed && !literal)
4393 if (entry->pl_prop != ZPROP_INVAL) {
4394 if (zfs_prop_get(zhp, entry->pl_prop,
4395 buf, sizeof (buf), NULL, NULL, 0, literal) == 0) {
4396 if (strlen(buf) > entry->pl_width)
4397 entry->pl_width = strlen(buf);
4399 if (received && zfs_prop_get_recvd(zhp,
4400 zfs_prop_to_name(entry->pl_prop),
4401 buf, sizeof (buf), literal) == 0)
4402 if (strlen(buf) > entry->pl_recvd_width)
4403 entry->pl_recvd_width = strlen(buf);
4405 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
4407 verify(nvlist_lookup_string(propval,
4408 ZPROP_VALUE, &strval) == 0);
4409 if (strlen(strval) > entry->pl_width)
4410 entry->pl_width = strlen(strval);
4412 if (received && zfs_prop_get_recvd(zhp,
4413 entry->pl_user_prop,
4414 buf, sizeof (buf), literal) == 0)
4415 if (strlen(buf) > entry->pl_recvd_width)
4416 entry->pl_recvd_width = strlen(buf);
4424 zfs_deleg_share_nfs(libzfs_handle_t *hdl, char *dataset, char *path,
4425 char *resource, void *export, void *sharetab,
4426 int sharemax, zfs_share_op_t operation)
4428 zfs_cmd_t zc = { 0 };
4431 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4432 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4434 (void) strlcpy(zc.zc_string, resource, sizeof (zc.zc_string));
4435 zc.zc_share.z_sharedata = (uint64_t)(uintptr_t)sharetab;
4436 zc.zc_share.z_exportdata = (uint64_t)(uintptr_t)export;
4437 zc.zc_share.z_sharetype = operation;
4438 zc.zc_share.z_sharemax = sharemax;
4439 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SHARE, &zc);
4444 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
4449 * Keep a reference to the props-table against which we prune the
4452 zhp->zfs_props_table = props;
4454 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
4457 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
4458 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
4461 * User properties will result in ZPROP_INVAL, and since we
4462 * only know how to prune standard ZFS properties, we always
4463 * leave these in the list. This can also happen if we
4464 * encounter an unknown DSL property (when running older
4465 * software, for example).
4467 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
4468 (void) nvlist_remove(zhp->zfs_props,
4469 nvpair_name(curr), nvpair_type(curr));
4476 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
4477 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
4479 zfs_cmd_t zc = { 0 };
4480 nvlist_t *nvlist = NULL;
4483 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4484 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4485 zc.zc_cookie = (uint64_t)cmd;
4487 if (cmd == ZFS_SMB_ACL_RENAME) {
4488 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
4489 (void) no_memory(hdl);
4495 case ZFS_SMB_ACL_ADD:
4496 case ZFS_SMB_ACL_REMOVE:
4497 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4499 case ZFS_SMB_ACL_RENAME:
4500 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4502 (void) no_memory(hdl);
4505 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4507 (void) no_memory(hdl);
4510 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4511 nvlist_free(nvlist);
4515 case ZFS_SMB_ACL_PURGE:
4520 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4521 nvlist_free(nvlist);
4526 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4527 char *path, char *resource)
4529 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4534 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4535 char *path, char *resource)
4537 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4542 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4544 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4549 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4550 char *oldname, char *newname)
4552 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4555 #endif /* illumos */
4558 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4559 zfs_userspace_cb_t func, void *arg)
4561 zfs_cmd_t zc = { 0 };
4562 zfs_useracct_t buf[100];
4563 libzfs_handle_t *hdl = zhp->zfs_hdl;
4566 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4568 zc.zc_objset_type = type;
4569 zc.zc_nvlist_dst = (uintptr_t)buf;
4572 zfs_useracct_t *zua = buf;
4574 zc.zc_nvlist_dst_size = sizeof (buf);
4575 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4578 (void) snprintf(errbuf, sizeof (errbuf),
4579 dgettext(TEXT_DOMAIN,
4580 "cannot get used/quota for %s"), zc.zc_name);
4581 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4583 if (zc.zc_nvlist_dst_size == 0)
4586 while (zc.zc_nvlist_dst_size > 0) {
4587 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4588 zua->zu_space)) != 0)
4591 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4600 const char *snapname;
4602 boolean_t recursive;
4607 zfs_hold_one(zfs_handle_t *zhp, void *arg)
4609 struct holdarg *ha = arg;
4610 char name[ZFS_MAX_DATASET_NAME_LEN];
4613 (void) snprintf(name, sizeof (name),
4614 "%s@%s", zhp->zfs_name, ha->snapname);
4616 if (lzc_exists(name))
4617 fnvlist_add_string(ha->nvl, name, ha->tag);
4620 rv = zfs_iter_filesystems(zhp, zfs_hold_one, ha);
4626 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4627 boolean_t recursive, int cleanup_fd)
4632 ha.nvl = fnvlist_alloc();
4633 ha.snapname = snapname;
4635 ha.recursive = recursive;
4636 (void) zfs_hold_one(zfs_handle_dup(zhp), &ha);
4638 if (nvlist_empty(ha.nvl)) {
4641 fnvlist_free(ha.nvl);
4643 (void) snprintf(errbuf, sizeof (errbuf),
4644 dgettext(TEXT_DOMAIN,
4645 "cannot hold snapshot '%s@%s'"),
4646 zhp->zfs_name, snapname);
4647 (void) zfs_standard_error(zhp->zfs_hdl, ret, errbuf);
4651 ret = zfs_hold_nvl(zhp, cleanup_fd, ha.nvl);
4652 fnvlist_free(ha.nvl);
4658 zfs_hold_nvl(zfs_handle_t *zhp, int cleanup_fd, nvlist_t *holds)
4662 libzfs_handle_t *hdl = zhp->zfs_hdl;
4667 ret = lzc_hold(holds, cleanup_fd, &errors);
4670 /* There may be errors even in the success case. */
4671 fnvlist_free(errors);
4675 if (nvlist_empty(errors)) {
4676 /* no hold-specific errors */
4677 (void) snprintf(errbuf, sizeof (errbuf),
4678 dgettext(TEXT_DOMAIN, "cannot hold"));
4681 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4682 "pool must be upgraded"));
4683 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4686 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4689 (void) zfs_standard_error(hdl, ret, errbuf);
4693 for (elem = nvlist_next_nvpair(errors, NULL);
4695 elem = nvlist_next_nvpair(errors, elem)) {
4696 (void) snprintf(errbuf, sizeof (errbuf),
4697 dgettext(TEXT_DOMAIN,
4698 "cannot hold snapshot '%s'"), nvpair_name(elem));
4699 switch (fnvpair_value_int32(elem)) {
4702 * Temporary tags wind up having the ds object id
4703 * prepended. So even if we passed the length check
4704 * above, it's still possible for the tag to wind
4705 * up being slightly too long.
4707 (void) zfs_error(hdl, EZFS_TAGTOOLONG, errbuf);
4710 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4713 (void) zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf);
4716 (void) zfs_standard_error(hdl,
4717 fnvpair_value_int32(elem), errbuf);
4721 fnvlist_free(errors);
4726 zfs_release_one(zfs_handle_t *zhp, void *arg)
4728 struct holdarg *ha = arg;
4729 char name[ZFS_MAX_DATASET_NAME_LEN];
4731 nvlist_t *existing_holds;
4733 (void) snprintf(name, sizeof (name),
4734 "%s@%s", zhp->zfs_name, ha->snapname);
4736 if (lzc_get_holds(name, &existing_holds) != 0) {
4738 } else if (!nvlist_exists(existing_holds, ha->tag)) {
4741 nvlist_t *torelease = fnvlist_alloc();
4742 fnvlist_add_boolean(torelease, ha->tag);
4743 fnvlist_add_nvlist(ha->nvl, name, torelease);
4744 fnvlist_free(torelease);
4748 rv = zfs_iter_filesystems(zhp, zfs_release_one, ha);
4754 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4755 boolean_t recursive)
4759 nvlist_t *errors = NULL;
4761 libzfs_handle_t *hdl = zhp->zfs_hdl;
4764 ha.nvl = fnvlist_alloc();
4765 ha.snapname = snapname;
4767 ha.recursive = recursive;
4769 (void) zfs_release_one(zfs_handle_dup(zhp), &ha);
4771 if (nvlist_empty(ha.nvl)) {
4772 fnvlist_free(ha.nvl);
4774 (void) snprintf(errbuf, sizeof (errbuf),
4775 dgettext(TEXT_DOMAIN,
4776 "cannot release hold from snapshot '%s@%s'"),
4777 zhp->zfs_name, snapname);
4779 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4781 (void) zfs_standard_error(hdl, ret, errbuf);
4786 ret = lzc_release(ha.nvl, &errors);
4787 fnvlist_free(ha.nvl);
4790 /* There may be errors even in the success case. */
4791 fnvlist_free(errors);
4795 if (nvlist_empty(errors)) {
4796 /* no hold-specific errors */
4797 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4801 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4802 "pool must be upgraded"));
4803 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4806 (void) zfs_standard_error_fmt(hdl, errno, errbuf);
4810 for (elem = nvlist_next_nvpair(errors, NULL);
4812 elem = nvlist_next_nvpair(errors, elem)) {
4813 (void) snprintf(errbuf, sizeof (errbuf),
4814 dgettext(TEXT_DOMAIN,
4815 "cannot release hold from snapshot '%s'"),
4817 switch (fnvpair_value_int32(elem)) {
4819 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4822 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4825 (void) zfs_standard_error_fmt(hdl,
4826 fnvpair_value_int32(elem), errbuf);
4830 fnvlist_free(errors);
4835 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4837 zfs_cmd_t zc = { 0 };
4838 libzfs_handle_t *hdl = zhp->zfs_hdl;
4844 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4845 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4849 nvbuf = malloc(nvsz);
4850 if (nvbuf == NULL) {
4851 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4855 zc.zc_nvlist_dst_size = nvsz;
4856 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4858 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4860 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4861 (void) snprintf(errbuf, sizeof (errbuf),
4862 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4867 nvsz = zc.zc_nvlist_dst_size;
4871 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4872 "pool must be upgraded"));
4873 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4876 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4879 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4882 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4887 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4889 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4890 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4892 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4902 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4904 zfs_cmd_t zc = { 0 };
4905 libzfs_handle_t *hdl = zhp->zfs_hdl;
4911 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4912 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4914 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
4917 nvbuf = malloc(nvsz);
4919 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
4922 zc.zc_nvlist_src_size = nvsz;
4923 zc.zc_nvlist_src = (uintptr_t)nvbuf;
4924 zc.zc_perm_action = un;
4926 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4928 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
4929 (void) snprintf(errbuf, sizeof (errbuf),
4930 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
4934 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4935 "pool must be upgraded"));
4936 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4939 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4942 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4945 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4956 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
4961 err = lzc_get_holds(zhp->zfs_name, nvl);
4964 libzfs_handle_t *hdl = zhp->zfs_hdl;
4966 (void) snprintf(errbuf, sizeof (errbuf),
4967 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4971 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4972 "pool must be upgraded"));
4973 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4976 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4979 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4982 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4991 * Convert the zvol's volume size to an appropriate reservation.
4992 * Note: If this routine is updated, it is necessary to update the ZFS test
4993 * suite's shell version in reservation.kshlib.
4996 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4999 uint64_t nblocks, volblocksize;
5003 if (nvlist_lookup_string(props,
5004 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
5005 ncopies = atoi(strval);
5008 if (nvlist_lookup_uint64(props,
5009 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
5010 &volblocksize) != 0)
5011 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
5012 nblocks = volsize/volblocksize;
5013 /* start with metadnode L0-L6 */
5015 /* calculate number of indirects */
5016 while (nblocks > 1) {
5017 nblocks += DNODES_PER_LEVEL - 1;
5018 nblocks /= DNODES_PER_LEVEL;
5021 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
5024 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
5025 * compressed, but in practice they compress down to about
5028 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;
5034 * Attach/detach the given filesystem to/from the given jail.
5037 zfs_jail(zfs_handle_t *zhp, int jailid, int attach)
5039 libzfs_handle_t *hdl = zhp->zfs_hdl;
5040 zfs_cmd_t zc = { 0 };
5046 (void) snprintf(errbuf, sizeof (errbuf),
5047 dgettext(TEXT_DOMAIN, "cannot jail '%s'"), zhp->zfs_name);
5049 (void) snprintf(errbuf, sizeof (errbuf),
5050 dgettext(TEXT_DOMAIN, "cannot unjail '%s'"), zhp->zfs_name);
5053 switch (zhp->zfs_type) {
5054 case ZFS_TYPE_VOLUME:
5055 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
5056 "volumes can not be jailed"));
5057 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
5058 case ZFS_TYPE_SNAPSHOT:
5059 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
5060 "snapshots can not be jailed"));
5061 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
5063 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
5065 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
5066 zc.zc_objset_type = DMU_OST_ZFS;
5067 zc.zc_jailid = jailid;
5069 cmd = attach ? ZFS_IOC_JAIL : ZFS_IOC_UNJAIL;
5070 if ((ret = ioctl(hdl->libzfs_fd, cmd, &zc)) != 0)
5071 zfs_standard_error(hdl, errno, errbuf);