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, 2014 by Delphix. All rights reserved.
26 * Copyright (c) 2012 DEY Storage Systems, Inc. All rights reserved.
27 * Copyright (c) 2011-2012 Pawel Jakub Dawidek <pawel@dawidek.net>.
28 * All rights reserved.
29 * Copyright (c) 2012 Martin Matuska <mm@FreeBSD.org>. All rights reserved.
30 * Copyright (c) 2013 Steven Hartland. All rights reserved.
31 * Copyright 2013 Nexenta Systems, Inc. All rights reserved.
45 #include <sys/mntent.h>
46 #include <sys/mount.h>
53 #include <sys/dnode.h>
59 #include "zfs_namecheck.h"
61 #include "libzfs_impl.h"
62 #include "zfs_deleg.h"
64 static int userquota_propname_decode(const char *propname, boolean_t zoned,
65 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
68 * Given a single type (not a mask of types), return the type in a human
72 zfs_type_to_name(zfs_type_t type)
75 case ZFS_TYPE_FILESYSTEM:
76 return (dgettext(TEXT_DOMAIN, "filesystem"));
77 case ZFS_TYPE_SNAPSHOT:
78 return (dgettext(TEXT_DOMAIN, "snapshot"));
80 return (dgettext(TEXT_DOMAIN, "volume"));
87 * Given a path and mask of ZFS types, return a string describing this dataset.
88 * This is used when we fail to open a dataset and we cannot get an exact type.
89 * We guess what the type would have been based on the path and the mask of
93 path_to_str(const char *path, int types)
96 * When given a single type, always report the exact type.
98 if (types == ZFS_TYPE_SNAPSHOT)
99 return (dgettext(TEXT_DOMAIN, "snapshot"));
100 if (types == ZFS_TYPE_FILESYSTEM)
101 return (dgettext(TEXT_DOMAIN, "filesystem"));
102 if (types == ZFS_TYPE_VOLUME)
103 return (dgettext(TEXT_DOMAIN, "volume"));
106 * The user is requesting more than one type of dataset. If this is the
107 * case, consult the path itself. If we're looking for a snapshot, and
108 * a '@' is found, then report it as "snapshot". Otherwise, remove the
109 * snapshot attribute and try again.
111 if (types & ZFS_TYPE_SNAPSHOT) {
112 if (strchr(path, '@') != NULL)
113 return (dgettext(TEXT_DOMAIN, "snapshot"));
114 return (path_to_str(path, types & ~ZFS_TYPE_SNAPSHOT));
118 * The user has requested either filesystems or volumes.
119 * We have no way of knowing a priori what type this would be, so always
120 * report it as "filesystem" or "volume", our two primitive types.
122 if (types & ZFS_TYPE_FILESYSTEM)
123 return (dgettext(TEXT_DOMAIN, "filesystem"));
125 assert(types & ZFS_TYPE_VOLUME);
126 return (dgettext(TEXT_DOMAIN, "volume"));
130 * Validate a ZFS path. This is used even before trying to open the dataset, to
131 * provide a more meaningful error message. We call zfs_error_aux() to
132 * explain exactly why the name was not valid.
135 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
141 (void) zfs_prop_get_table();
142 if (dataset_namecheck(path, &why, &what) != 0) {
145 case NAME_ERR_TOOLONG:
146 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
147 "name is too long"));
150 case NAME_ERR_LEADING_SLASH:
151 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
152 "leading slash in name"));
155 case NAME_ERR_EMPTY_COMPONENT:
156 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
157 "empty component in name"));
160 case NAME_ERR_TRAILING_SLASH:
161 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
162 "trailing slash in name"));
165 case NAME_ERR_INVALCHAR:
167 dgettext(TEXT_DOMAIN, "invalid character "
168 "'%c' in name"), what);
171 case NAME_ERR_MULTIPLE_AT:
172 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
173 "multiple '@' delimiters in name"));
176 case NAME_ERR_NOLETTER:
177 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
178 "pool doesn't begin with a letter"));
181 case NAME_ERR_RESERVED:
182 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
183 "name is reserved"));
186 case NAME_ERR_DISKLIKE:
187 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
188 "reserved disk name"));
196 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
198 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
199 "snapshot delimiter '@' in filesystem name"));
203 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
205 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
206 "missing '@' delimiter in snapshot name"));
210 if (modifying && strchr(path, '%') != NULL) {
212 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
213 "invalid character %c in name"), '%');
221 zfs_name_valid(const char *name, zfs_type_t type)
223 if (type == ZFS_TYPE_POOL)
224 return (zpool_name_valid(NULL, B_FALSE, name));
225 return (zfs_validate_name(NULL, name, type, B_FALSE));
229 * This function takes the raw DSL properties, and filters out the user-defined
230 * properties into a separate nvlist.
233 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
235 libzfs_handle_t *hdl = zhp->zfs_hdl;
240 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
241 (void) no_memory(hdl);
246 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
247 if (!zfs_prop_user(nvpair_name(elem)))
250 verify(nvpair_value_nvlist(elem, &propval) == 0);
251 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
253 (void) no_memory(hdl);
261 static zpool_handle_t *
262 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
264 libzfs_handle_t *hdl = zhp->zfs_hdl;
267 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
268 if (hdl->libzfs_pool_handles != NULL)
269 zph->zpool_next = hdl->libzfs_pool_handles;
270 hdl->libzfs_pool_handles = zph;
275 static zpool_handle_t *
276 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
278 libzfs_handle_t *hdl = zhp->zfs_hdl;
279 zpool_handle_t *zph = hdl->libzfs_pool_handles;
281 while ((zph != NULL) &&
282 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
283 zph = zph->zpool_next;
288 * Returns a handle to the pool that contains the provided dataset.
289 * If a handle to that pool already exists then that handle is returned.
290 * Otherwise, a new handle is created and added to the list of handles.
292 static zpool_handle_t *
293 zpool_handle(zfs_handle_t *zhp)
299 len = strcspn(zhp->zfs_name, "/@#") + 1;
300 pool_name = zfs_alloc(zhp->zfs_hdl, len);
301 (void) strlcpy(pool_name, zhp->zfs_name, len);
303 zph = zpool_find_handle(zhp, pool_name, len);
305 zph = zpool_add_handle(zhp, pool_name);
312 zpool_free_handles(libzfs_handle_t *hdl)
314 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
316 while (zph != NULL) {
317 next = zph->zpool_next;
321 hdl->libzfs_pool_handles = NULL;
325 * Utility function to gather stats (objset and zpl) for the given object.
328 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
330 libzfs_handle_t *hdl = zhp->zfs_hdl;
332 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
334 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, zc) != 0) {
335 if (errno == ENOMEM) {
336 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
347 * Utility function to get the received properties of the given object.
350 get_recvd_props_ioctl(zfs_handle_t *zhp)
352 libzfs_handle_t *hdl = zhp->zfs_hdl;
353 nvlist_t *recvdprops;
354 zfs_cmd_t zc = { 0 };
357 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
360 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
362 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
363 if (errno == ENOMEM) {
364 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
368 zcmd_free_nvlists(&zc);
373 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
374 zcmd_free_nvlists(&zc);
378 nvlist_free(zhp->zfs_recvd_props);
379 zhp->zfs_recvd_props = recvdprops;
385 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
387 nvlist_t *allprops, *userprops;
389 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
391 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
396 * XXX Why do we store the user props separately, in addition to
397 * storing them in zfs_props?
399 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
400 nvlist_free(allprops);
404 nvlist_free(zhp->zfs_props);
405 nvlist_free(zhp->zfs_user_props);
407 zhp->zfs_props = allprops;
408 zhp->zfs_user_props = userprops;
414 get_stats(zfs_handle_t *zhp)
417 zfs_cmd_t zc = { 0 };
419 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
421 if (get_stats_ioctl(zhp, &zc) != 0)
423 else if (put_stats_zhdl(zhp, &zc) != 0)
425 zcmd_free_nvlists(&zc);
430 * Refresh the properties currently stored in the handle.
433 zfs_refresh_properties(zfs_handle_t *zhp)
435 (void) get_stats(zhp);
439 * Makes a handle from the given dataset name. Used by zfs_open() and
440 * zfs_iter_* to create child handles on the fly.
443 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
445 if (put_stats_zhdl(zhp, zc) != 0)
449 * We've managed to open the dataset and gather statistics. Determine
450 * the high-level type.
452 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
453 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
454 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
455 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
459 if (zhp->zfs_dmustats.dds_is_snapshot)
460 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
461 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
462 zhp->zfs_type = ZFS_TYPE_VOLUME;
463 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
464 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
466 abort(); /* we should never see any other types */
468 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
475 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
477 zfs_cmd_t zc = { 0 };
479 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
485 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
486 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
490 if (get_stats_ioctl(zhp, &zc) == -1) {
491 zcmd_free_nvlists(&zc);
495 if (make_dataset_handle_common(zhp, &zc) == -1) {
499 zcmd_free_nvlists(&zc);
504 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
506 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
512 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
513 if (make_dataset_handle_common(zhp, zc) == -1) {
521 make_dataset_simple_handle_zc(zfs_handle_t *pzhp, zfs_cmd_t *zc)
523 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
528 zhp->zfs_hdl = pzhp->zfs_hdl;
529 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
530 zhp->zfs_head_type = pzhp->zfs_type;
531 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
532 zhp->zpool_hdl = zpool_handle(zhp);
537 zfs_handle_dup(zfs_handle_t *zhp_orig)
539 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
544 zhp->zfs_hdl = zhp_orig->zfs_hdl;
545 zhp->zpool_hdl = zhp_orig->zpool_hdl;
546 (void) strlcpy(zhp->zfs_name, zhp_orig->zfs_name,
547 sizeof (zhp->zfs_name));
548 zhp->zfs_type = zhp_orig->zfs_type;
549 zhp->zfs_head_type = zhp_orig->zfs_head_type;
550 zhp->zfs_dmustats = zhp_orig->zfs_dmustats;
551 if (zhp_orig->zfs_props != NULL) {
552 if (nvlist_dup(zhp_orig->zfs_props, &zhp->zfs_props, 0) != 0) {
553 (void) no_memory(zhp->zfs_hdl);
558 if (zhp_orig->zfs_user_props != NULL) {
559 if (nvlist_dup(zhp_orig->zfs_user_props,
560 &zhp->zfs_user_props, 0) != 0) {
561 (void) no_memory(zhp->zfs_hdl);
566 if (zhp_orig->zfs_recvd_props != NULL) {
567 if (nvlist_dup(zhp_orig->zfs_recvd_props,
568 &zhp->zfs_recvd_props, 0)) {
569 (void) no_memory(zhp->zfs_hdl);
574 zhp->zfs_mntcheck = zhp_orig->zfs_mntcheck;
575 if (zhp_orig->zfs_mntopts != NULL) {
576 zhp->zfs_mntopts = zfs_strdup(zhp_orig->zfs_hdl,
577 zhp_orig->zfs_mntopts);
579 zhp->zfs_props_table = zhp_orig->zfs_props_table;
584 zfs_bookmark_exists(const char *path)
588 char fsname[ZFS_MAXNAMELEN];
595 (void) strlcpy(fsname, path, sizeof (fsname));
596 pound = strchr(fsname, '#');
601 bmark_name = pound + 1;
602 props = fnvlist_alloc();
603 err = lzc_get_bookmarks(fsname, props, &bmarks);
610 rv = nvlist_exists(bmarks, bmark_name);
616 make_bookmark_handle(zfs_handle_t *parent, const char *path,
617 nvlist_t *bmark_props)
619 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
624 /* Fill in the name. */
625 zhp->zfs_hdl = parent->zfs_hdl;
626 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
628 /* Set the property lists. */
629 if (nvlist_dup(bmark_props, &zhp->zfs_props, 0) != 0) {
635 zhp->zfs_head_type = parent->zfs_head_type;
636 zhp->zfs_type = ZFS_TYPE_BOOKMARK;
638 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL) {
639 nvlist_free(zhp->zfs_props);
648 * Opens the given snapshot, filesystem, or volume. The 'types'
649 * argument is a mask of acceptable types. The function will print an
650 * appropriate error message and return NULL if it can't be opened.
653 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
658 (void) snprintf(errbuf, sizeof (errbuf),
659 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
662 * Validate the name before we even try to open it.
664 if (!zfs_validate_name(hdl, path, ZFS_TYPE_DATASET, B_FALSE)) {
665 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
666 "invalid dataset name"));
667 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
672 * Try to get stats for the dataset, which will tell us if it exists.
675 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
676 (void) zfs_standard_error(hdl, errno, errbuf);
681 char *at = strchr(path, '@');
686 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
687 (void) zfs_standard_error(hdl, errno, errbuf);
692 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
693 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
696 if (!(types & zhp->zfs_type)) {
697 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
706 * Release a ZFS handle. Nothing to do but free the associated memory.
709 zfs_close(zfs_handle_t *zhp)
711 if (zhp->zfs_mntopts)
712 free(zhp->zfs_mntopts);
713 nvlist_free(zhp->zfs_props);
714 nvlist_free(zhp->zfs_user_props);
715 nvlist_free(zhp->zfs_recvd_props);
719 typedef struct mnttab_node {
720 struct mnttab mtn_mt;
725 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
727 const mnttab_node_t *mtn1 = arg1;
728 const mnttab_node_t *mtn2 = arg2;
731 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
735 return (rv > 0 ? 1 : -1);
739 libzfs_mnttab_init(libzfs_handle_t *hdl)
741 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
742 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
743 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
747 libzfs_mnttab_update(libzfs_handle_t *hdl)
751 rewind(hdl->libzfs_mnttab);
752 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
755 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
757 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
758 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
759 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
760 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
761 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
762 avl_add(&hdl->libzfs_mnttab_cache, mtn);
767 libzfs_mnttab_fini(libzfs_handle_t *hdl)
772 while (mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie)) {
773 free(mtn->mtn_mt.mnt_special);
774 free(mtn->mtn_mt.mnt_mountp);
775 free(mtn->mtn_mt.mnt_fstype);
776 free(mtn->mtn_mt.mnt_mntopts);
779 avl_destroy(&hdl->libzfs_mnttab_cache);
783 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
785 hdl->libzfs_mnttab_enable = enable;
789 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
790 struct mnttab *entry)
795 if (!hdl->libzfs_mnttab_enable) {
796 struct mnttab srch = { 0 };
798 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
799 libzfs_mnttab_fini(hdl);
800 rewind(hdl->libzfs_mnttab);
801 srch.mnt_special = (char *)fsname;
802 srch.mnt_fstype = MNTTYPE_ZFS;
803 if (getmntany(hdl->libzfs_mnttab, entry, &srch) == 0)
809 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
810 libzfs_mnttab_update(hdl);
812 find.mtn_mt.mnt_special = (char *)fsname;
813 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
815 *entry = mtn->mtn_mt;
822 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
823 const char *mountp, const char *mntopts)
827 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
829 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
830 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
831 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
832 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
833 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
834 avl_add(&hdl->libzfs_mnttab_cache, mtn);
838 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
843 find.mtn_mt.mnt_special = (char *)fsname;
844 if (ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL)) {
845 avl_remove(&hdl->libzfs_mnttab_cache, ret);
846 free(ret->mtn_mt.mnt_special);
847 free(ret->mtn_mt.mnt_mountp);
848 free(ret->mtn_mt.mnt_fstype);
849 free(ret->mtn_mt.mnt_mntopts);
855 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
857 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
859 if (zpool_handle == NULL)
862 *spa_version = zpool_get_prop_int(zpool_handle,
863 ZPOOL_PROP_VERSION, NULL);
868 * The choice of reservation property depends on the SPA version.
871 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
875 if (zfs_spa_version(zhp, &spa_version) < 0)
878 if (spa_version >= SPA_VERSION_REFRESERVATION)
879 *resv_prop = ZFS_PROP_REFRESERVATION;
881 *resv_prop = ZFS_PROP_RESERVATION;
887 * Given an nvlist of properties to set, validates that they are correct, and
888 * parses any numeric properties (index, boolean, etc) if they are specified as
892 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
893 uint64_t zoned, zfs_handle_t *zhp, const char *errbuf)
900 int chosen_normal = -1;
903 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
904 (void) no_memory(hdl);
909 * Make sure this property is valid and applies to this type.
913 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
914 const char *propname = nvpair_name(elem);
916 prop = zfs_name_to_prop(propname);
917 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
919 * This is a user property: make sure it's a
920 * string, and that it's less than ZAP_MAXNAMELEN.
922 if (nvpair_type(elem) != DATA_TYPE_STRING) {
923 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
924 "'%s' must be a string"), propname);
925 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
929 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
930 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
931 "property name '%s' is too long"),
933 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
937 (void) nvpair_value_string(elem, &strval);
938 if (nvlist_add_string(ret, propname, strval) != 0) {
939 (void) no_memory(hdl);
946 * Currently, only user properties can be modified on
949 if (type == ZFS_TYPE_SNAPSHOT) {
950 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
951 "this property can not be modified for snapshots"));
952 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
956 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
957 zfs_userquota_prop_t uqtype;
958 char newpropname[128];
963 if (userquota_propname_decode(propname, zoned,
964 &uqtype, domain, sizeof (domain), &rid) != 0) {
966 dgettext(TEXT_DOMAIN,
967 "'%s' has an invalid user/group name"),
969 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
973 if (uqtype != ZFS_PROP_USERQUOTA &&
974 uqtype != ZFS_PROP_GROUPQUOTA) {
976 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
978 (void) zfs_error(hdl, EZFS_PROPREADONLY,
983 if (nvpair_type(elem) == DATA_TYPE_STRING) {
984 (void) nvpair_value_string(elem, &strval);
985 if (strcmp(strval, "none") == 0) {
987 } else if (zfs_nicestrtonum(hdl,
988 strval, &intval) != 0) {
989 (void) zfs_error(hdl,
990 EZFS_BADPROP, errbuf);
993 } else if (nvpair_type(elem) ==
995 (void) nvpair_value_uint64(elem, &intval);
997 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
998 "use 'none' to disable "
999 "userquota/groupquota"));
1003 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1004 "'%s' must be a number"), propname);
1005 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1010 * Encode the prop name as
1011 * userquota@<hex-rid>-domain, to make it easy
1012 * for the kernel to decode.
1014 (void) snprintf(newpropname, sizeof (newpropname),
1015 "%s%llx-%s", zfs_userquota_prop_prefixes[uqtype],
1016 (longlong_t)rid, domain);
1020 if (nvlist_add_uint64_array(ret, newpropname,
1022 (void) no_memory(hdl);
1026 } else if (prop == ZPROP_INVAL && zfs_prop_written(propname)) {
1027 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1028 "'%s' is readonly"),
1030 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1034 if (prop == ZPROP_INVAL) {
1035 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1036 "invalid property '%s'"), propname);
1037 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1041 if (!zfs_prop_valid_for_type(prop, type)) {
1043 dgettext(TEXT_DOMAIN, "'%s' does not "
1044 "apply to datasets of this type"), propname);
1045 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1049 if (zfs_prop_readonly(prop) &&
1050 (!zfs_prop_setonce(prop) || zhp != NULL)) {
1052 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1054 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1058 if (zprop_parse_value(hdl, elem, prop, type, ret,
1059 &strval, &intval, errbuf) != 0)
1063 * Perform some additional checks for specific properties.
1066 case ZFS_PROP_VERSION:
1072 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1073 if (intval < version) {
1074 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1075 "Can not downgrade; already at version %u"),
1077 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1083 case ZFS_PROP_VOLBLOCKSIZE:
1084 case ZFS_PROP_RECORDSIZE:
1086 int maxbs = SPA_MAXBLOCKSIZE;
1088 maxbs = zpool_get_prop_int(zhp->zpool_hdl,
1089 ZPOOL_PROP_MAXBLOCKSIZE, NULL);
1092 * Volumes are limited to a volblocksize of 128KB,
1093 * because they typically service workloads with
1094 * small random writes, which incur a large performance
1095 * penalty with large blocks.
1097 if (prop == ZFS_PROP_VOLBLOCKSIZE)
1098 maxbs = SPA_OLD_MAXBLOCKSIZE;
1100 * The value must be a power of two between
1101 * SPA_MINBLOCKSIZE and maxbs.
1103 if (intval < SPA_MINBLOCKSIZE ||
1104 intval > maxbs || !ISP2(intval)) {
1105 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1106 "'%s' must be power of 2 from 512B "
1107 "to %uKB"), propname, maxbs >> 10);
1108 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1113 case ZFS_PROP_MLSLABEL:
1117 * Verify the mlslabel string and convert to
1118 * internal hex label string.
1122 char *hex = NULL; /* internal label string */
1124 /* Default value is already OK. */
1125 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
1128 /* Verify the label can be converted to binary form */
1129 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
1130 (str_to_label(strval, &new_sl, MAC_LABEL,
1131 L_NO_CORRECTION, NULL) == -1)) {
1135 /* Now translate to hex internal label string */
1136 if (label_to_str(new_sl, &hex, M_INTERNAL,
1142 m_label_free(new_sl);
1144 /* If string is already in internal form, we're done. */
1145 if (strcmp(strval, hex) == 0) {
1150 /* Replace the label string with the internal form. */
1151 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
1153 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
1160 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1161 "invalid mlslabel '%s'"), strval);
1162 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1163 m_label_free(new_sl); /* OK if null */
1165 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1166 "mlslabel is not supported on FreeBSD"));
1167 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1173 case ZFS_PROP_MOUNTPOINT:
1175 namecheck_err_t why;
1177 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1178 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1181 if (mountpoint_namecheck(strval, &why)) {
1183 case NAME_ERR_LEADING_SLASH:
1185 dgettext(TEXT_DOMAIN,
1186 "'%s' must be an absolute path, "
1187 "'none', or 'legacy'"), propname);
1189 case NAME_ERR_TOOLONG:
1191 dgettext(TEXT_DOMAIN,
1192 "component of '%s' is too long"),
1196 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1203 case ZFS_PROP_SHARESMB:
1204 case ZFS_PROP_SHARENFS:
1206 * For the mountpoint and sharenfs or sharesmb
1207 * properties, check if it can be set in a
1208 * global/non-global zone based on
1209 * the zoned property value:
1211 * global zone non-global zone
1212 * --------------------------------------------------
1213 * zoned=on mountpoint (no) mountpoint (yes)
1214 * sharenfs (no) sharenfs (no)
1215 * sharesmb (no) sharesmb (no)
1217 * zoned=off mountpoint (yes) N/A
1222 if (getzoneid() == GLOBAL_ZONEID) {
1223 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1224 "'%s' cannot be set on "
1225 "dataset in a non-global zone"),
1227 (void) zfs_error(hdl, EZFS_ZONED,
1230 } else if (prop == ZFS_PROP_SHARENFS ||
1231 prop == ZFS_PROP_SHARESMB) {
1232 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1233 "'%s' cannot be set in "
1234 "a non-global zone"), propname);
1235 (void) zfs_error(hdl, EZFS_ZONED,
1239 } else if (getzoneid() != GLOBAL_ZONEID) {
1241 * If zoned property is 'off', this must be in
1242 * a global zone. If not, something is wrong.
1244 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1245 "'%s' cannot be set while dataset "
1246 "'zoned' property is set"), propname);
1247 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1252 * At this point, it is legitimate to set the
1253 * property. Now we want to make sure that the
1254 * property value is valid if it is sharenfs.
1256 if ((prop == ZFS_PROP_SHARENFS ||
1257 prop == ZFS_PROP_SHARESMB) &&
1258 strcmp(strval, "on") != 0 &&
1259 strcmp(strval, "off") != 0) {
1260 zfs_share_proto_t proto;
1262 if (prop == ZFS_PROP_SHARESMB)
1268 * Must be an valid sharing protocol
1269 * option string so init the libshare
1270 * in order to enable the parser and
1271 * then parse the options. We use the
1272 * control API since we don't care about
1273 * the current configuration and don't
1274 * want the overhead of loading it
1275 * until we actually do something.
1278 if (zfs_init_libshare(hdl,
1279 SA_INIT_CONTROL_API) != SA_OK) {
1281 * An error occurred so we can't do
1284 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1285 "'%s' cannot be set: problem "
1286 "in share initialization"),
1288 (void) zfs_error(hdl, EZFS_BADPROP,
1293 if (zfs_parse_options(strval, proto) != SA_OK) {
1295 * There was an error in parsing so
1296 * deal with it by issuing an error
1297 * message and leaving after
1298 * uninitializing the the libshare
1301 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1302 "'%s' cannot be set to invalid "
1303 "options"), propname);
1304 (void) zfs_error(hdl, EZFS_BADPROP,
1306 zfs_uninit_libshare(hdl);
1309 zfs_uninit_libshare(hdl);
1313 case ZFS_PROP_UTF8ONLY:
1314 chosen_utf = (int)intval;
1316 case ZFS_PROP_NORMALIZE:
1317 chosen_normal = (int)intval;
1322 * For changes to existing volumes, we have some additional
1323 * checks to enforce.
1325 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1326 uint64_t volsize = zfs_prop_get_int(zhp,
1328 uint64_t blocksize = zfs_prop_get_int(zhp,
1329 ZFS_PROP_VOLBLOCKSIZE);
1333 case ZFS_PROP_RESERVATION:
1334 case ZFS_PROP_REFRESERVATION:
1335 if (intval > volsize) {
1336 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1337 "'%s' is greater than current "
1338 "volume size"), propname);
1339 (void) zfs_error(hdl, EZFS_BADPROP,
1345 case ZFS_PROP_VOLSIZE:
1346 if (intval % blocksize != 0) {
1347 zfs_nicenum(blocksize, buf,
1349 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1350 "'%s' must be a multiple of "
1351 "volume block size (%s)"),
1353 (void) zfs_error(hdl, EZFS_BADPROP,
1359 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1360 "'%s' cannot be zero"),
1362 (void) zfs_error(hdl, EZFS_BADPROP,
1372 * If normalization was chosen, but no UTF8 choice was made,
1373 * enforce rejection of non-UTF8 names.
1375 * If normalization was chosen, but rejecting non-UTF8 names
1376 * was explicitly not chosen, it is an error.
1378 if (chosen_normal > 0 && chosen_utf < 0) {
1379 if (nvlist_add_uint64(ret,
1380 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1381 (void) no_memory(hdl);
1384 } else if (chosen_normal > 0 && chosen_utf == 0) {
1385 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1386 "'%s' must be set 'on' if normalization chosen"),
1387 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1388 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1399 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1401 uint64_t old_volsize;
1402 uint64_t new_volsize;
1403 uint64_t old_reservation;
1404 uint64_t new_reservation;
1405 zfs_prop_t resv_prop;
1409 * If this is an existing volume, and someone is setting the volsize,
1410 * make sure that it matches the reservation, or add it if necessary.
1412 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1413 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1415 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1417 props = fnvlist_alloc();
1418 fnvlist_add_uint64(props, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
1419 zfs_prop_get_int(zhp, ZFS_PROP_VOLBLOCKSIZE));
1421 if ((zvol_volsize_to_reservation(old_volsize, props) !=
1422 old_reservation) || nvlist_exists(nvl,
1423 zfs_prop_to_name(resv_prop))) {
1424 fnvlist_free(props);
1427 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1428 &new_volsize) != 0) {
1429 fnvlist_free(props);
1432 new_reservation = zvol_volsize_to_reservation(new_volsize, props);
1433 fnvlist_free(props);
1435 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1436 new_reservation) != 0) {
1437 (void) no_memory(zhp->zfs_hdl);
1444 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1451 * For quotas and reservations, ENOSPC indicates
1452 * something different; setting a quota or reservation
1453 * doesn't use any disk space.
1456 case ZFS_PROP_QUOTA:
1457 case ZFS_PROP_REFQUOTA:
1458 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1459 "size is less than current used or "
1461 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1464 case ZFS_PROP_RESERVATION:
1465 case ZFS_PROP_REFRESERVATION:
1466 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1467 "size is greater than available space"));
1468 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1472 (void) zfs_standard_error(hdl, err, errbuf);
1478 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1482 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1486 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1487 "pool and or dataset must be upgraded to set this "
1488 "property or value"));
1489 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1494 if (prop == ZFS_PROP_COMPRESSION ||
1495 prop == ZFS_PROP_RECORDSIZE) {
1496 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1497 "property setting is not allowed on "
1498 "bootable datasets"));
1499 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1500 } else if (prop == ZFS_PROP_CHECKSUM ||
1501 prop == ZFS_PROP_DEDUP) {
1502 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1503 "property setting is not allowed on "
1505 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1507 (void) zfs_standard_error(hdl, err, errbuf);
1512 if (prop == ZPROP_INVAL) {
1513 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1515 (void) zfs_standard_error(hdl, err, errbuf);
1521 * This platform can't address a volume this big.
1524 if (prop == ZFS_PROP_VOLSIZE) {
1525 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1531 (void) zfs_standard_error(hdl, err, errbuf);
1536 * Given a property name and value, set the property for the given dataset.
1539 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1543 libzfs_handle_t *hdl = zhp->zfs_hdl;
1544 nvlist_t *nvl = NULL;
1546 (void) snprintf(errbuf, sizeof (errbuf),
1547 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1550 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1551 nvlist_add_string(nvl, propname, propval) != 0) {
1552 (void) no_memory(hdl);
1556 ret = zfs_prop_set_list(zhp, nvl);
1566 * Given an nvlist of property names and values, set the properties for the
1570 zfs_prop_set_list(zfs_handle_t *zhp, nvlist_t *props)
1572 zfs_cmd_t zc = { 0 };
1574 prop_changelist_t **cls = NULL;
1577 libzfs_handle_t *hdl = zhp->zfs_hdl;
1582 (void) snprintf(errbuf, sizeof (errbuf),
1583 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1586 if ((nvl = zfs_valid_proplist(hdl, zhp->zfs_type, props,
1587 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, errbuf)) == NULL)
1591 * We have to check for any extra properties which need to be added
1592 * before computing the length of the nvlist.
1594 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1596 elem = nvlist_next_nvpair(nvl, elem)) {
1597 if (zfs_name_to_prop(nvpair_name(elem)) == ZFS_PROP_VOLSIZE &&
1598 (added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1) {
1603 * Check how many properties we're setting and allocate an array to
1604 * store changelist pointers for postfix().
1607 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1609 elem = nvlist_next_nvpair(nvl, elem))
1611 if ((cls = calloc(nvl_len, sizeof (prop_changelist_t *))) == NULL)
1615 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1617 elem = nvlist_next_nvpair(nvl, elem)) {
1619 zfs_prop_t prop = zfs_name_to_prop(nvpair_name(elem));
1621 assert(cl_idx < nvl_len);
1623 * We don't want to unmount & remount the dataset when changing
1624 * its canmount property to 'on' or 'noauto'. We only use
1625 * the changelist logic to unmount when setting canmount=off.
1627 if (!(prop == ZFS_PROP_CANMOUNT &&
1628 fnvpair_value_uint64(elem) != ZFS_CANMOUNT_OFF)) {
1629 cls[cl_idx] = changelist_gather(zhp, prop, 0, 0);
1630 if (cls[cl_idx] == NULL)
1634 if (prop == ZFS_PROP_MOUNTPOINT &&
1635 changelist_haszonedchild(cls[cl_idx])) {
1636 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1637 "child dataset with inherited mountpoint is used "
1638 "in a non-global zone"));
1639 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1643 /* We don't support those properties on FreeBSD. */
1645 case ZFS_PROP_DEVICES:
1646 case ZFS_PROP_ISCSIOPTIONS:
1647 case ZFS_PROP_XATTR:
1648 case ZFS_PROP_VSCAN:
1649 case ZFS_PROP_NBMAND:
1650 case ZFS_PROP_MLSLABEL:
1651 (void) snprintf(errbuf, sizeof (errbuf),
1652 "property '%s' not supported on FreeBSD",
1654 ret = zfs_error(hdl, EZFS_PERM, errbuf);
1658 if (cls[cl_idx] != NULL &&
1659 (ret = changelist_prefix(cls[cl_idx])) != 0)
1664 assert(cl_idx == nvl_len);
1667 * Execute the corresponding ioctl() to set this list of properties.
1669 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1671 if ((ret = zcmd_write_src_nvlist(hdl, &zc, nvl)) != 0 ||
1672 (ret = zcmd_alloc_dst_nvlist(hdl, &zc, 0)) != 0)
1675 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1678 /* Get the list of unset properties back and report them. */
1679 nvlist_t *errorprops = NULL;
1680 if (zcmd_read_dst_nvlist(hdl, &zc, &errorprops) != 0)
1682 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1684 elem = nvlist_next_nvpair(nvl, elem)) {
1685 zfs_prop_t prop = zfs_name_to_prop(nvpair_name(elem));
1686 zfs_setprop_error(hdl, prop, errno, errbuf);
1688 nvlist_free(errorprops);
1690 if (added_resv && errno == ENOSPC) {
1691 /* clean up the volsize property we tried to set */
1692 uint64_t old_volsize = zfs_prop_get_int(zhp,
1696 zcmd_free_nvlists(&zc);
1698 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1700 if (nvlist_add_uint64(nvl,
1701 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1704 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1706 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1709 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1710 if (cls[cl_idx] != NULL) {
1711 int clp_err = changelist_postfix(cls[cl_idx]);
1718 * Refresh the statistics so the new property value
1722 (void) get_stats(zhp);
1727 zcmd_free_nvlists(&zc);
1729 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1730 if (cls[cl_idx] != NULL)
1731 changelist_free(cls[cl_idx]);
1739 * Given a property, inherit the value from the parent dataset, or if received
1740 * is TRUE, revert to the received value, if any.
1743 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1745 zfs_cmd_t zc = { 0 };
1747 prop_changelist_t *cl;
1748 libzfs_handle_t *hdl = zhp->zfs_hdl;
1752 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1753 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1755 zc.zc_cookie = received;
1756 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1758 * For user properties, the amount of work we have to do is very
1759 * small, so just do it here.
1761 if (!zfs_prop_user(propname)) {
1762 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1763 "invalid property"));
1764 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1767 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1768 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1770 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1771 return (zfs_standard_error(hdl, errno, errbuf));
1777 * Verify that this property is inheritable.
1779 if (zfs_prop_readonly(prop))
1780 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1782 if (!zfs_prop_inheritable(prop) && !received)
1783 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1786 * Check to see if the value applies to this type
1788 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1789 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1792 * Normalize the name, to get rid of shorthand abbreviations.
1794 propname = zfs_prop_to_name(prop);
1795 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1796 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1798 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1799 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1800 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1801 "dataset is used in a non-global zone"));
1802 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1806 * Determine datasets which will be affected by this change, if any.
1808 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1811 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1812 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1813 "child dataset with inherited mountpoint is used "
1814 "in a non-global zone"));
1815 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1819 if ((ret = changelist_prefix(cl)) != 0)
1822 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1823 return (zfs_standard_error(hdl, errno, errbuf));
1826 if ((ret = changelist_postfix(cl)) != 0)
1830 * Refresh the statistics so the new property is reflected.
1832 (void) get_stats(zhp);
1836 changelist_free(cl);
1841 * True DSL properties are stored in an nvlist. The following two functions
1842 * extract them appropriately.
1845 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1851 if (nvlist_lookup_nvlist(zhp->zfs_props,
1852 zfs_prop_to_name(prop), &nv) == 0) {
1853 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1854 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1856 verify(!zhp->zfs_props_table ||
1857 zhp->zfs_props_table[prop] == B_TRUE);
1858 value = zfs_prop_default_numeric(prop);
1866 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1872 if (nvlist_lookup_nvlist(zhp->zfs_props,
1873 zfs_prop_to_name(prop), &nv) == 0) {
1874 value = fnvlist_lookup_string(nv, ZPROP_VALUE);
1875 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1877 verify(!zhp->zfs_props_table ||
1878 zhp->zfs_props_table[prop] == B_TRUE);
1879 value = zfs_prop_default_string(prop);
1887 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
1889 return (zhp->zfs_props == zhp->zfs_recvd_props);
1893 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1895 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
1896 zhp->zfs_props = zhp->zfs_recvd_props;
1900 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1902 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
1907 * Internal function for getting a numeric property. Both zfs_prop_get() and
1908 * zfs_prop_get_int() are built using this interface.
1910 * Certain properties can be overridden using 'mount -o'. In this case, scan
1911 * the contents of the /etc/mnttab entry, searching for the appropriate options.
1912 * If they differ from the on-disk values, report the current values and mark
1913 * the source "temporary".
1916 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
1917 char **source, uint64_t *val)
1919 zfs_cmd_t zc = { 0 };
1920 nvlist_t *zplprops = NULL;
1922 char *mntopt_on = NULL;
1923 char *mntopt_off = NULL;
1924 boolean_t received = zfs_is_recvd_props_mode(zhp);
1929 case ZFS_PROP_ATIME:
1930 mntopt_on = MNTOPT_ATIME;
1931 mntopt_off = MNTOPT_NOATIME;
1934 case ZFS_PROP_DEVICES:
1935 mntopt_on = MNTOPT_DEVICES;
1936 mntopt_off = MNTOPT_NODEVICES;
1940 mntopt_on = MNTOPT_EXEC;
1941 mntopt_off = MNTOPT_NOEXEC;
1944 case ZFS_PROP_READONLY:
1945 mntopt_on = MNTOPT_RO;
1946 mntopt_off = MNTOPT_RW;
1949 case ZFS_PROP_SETUID:
1950 mntopt_on = MNTOPT_SETUID;
1951 mntopt_off = MNTOPT_NOSETUID;
1954 case ZFS_PROP_XATTR:
1955 mntopt_on = MNTOPT_XATTR;
1956 mntopt_off = MNTOPT_NOXATTR;
1959 case ZFS_PROP_NBMAND:
1960 mntopt_on = MNTOPT_NBMAND;
1961 mntopt_off = MNTOPT_NONBMAND;
1966 * Because looking up the mount options is potentially expensive
1967 * (iterating over all of /etc/mnttab), we defer its calculation until
1968 * we're looking up a property which requires its presence.
1970 if (!zhp->zfs_mntcheck &&
1971 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
1972 libzfs_handle_t *hdl = zhp->zfs_hdl;
1973 struct mnttab entry;
1975 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
1976 zhp->zfs_mntopts = zfs_strdup(hdl,
1978 if (zhp->zfs_mntopts == NULL)
1982 zhp->zfs_mntcheck = B_TRUE;
1985 if (zhp->zfs_mntopts == NULL)
1986 mnt.mnt_mntopts = "";
1988 mnt.mnt_mntopts = zhp->zfs_mntopts;
1991 case ZFS_PROP_ATIME:
1992 case ZFS_PROP_DEVICES:
1994 case ZFS_PROP_READONLY:
1995 case ZFS_PROP_SETUID:
1996 case ZFS_PROP_XATTR:
1997 case ZFS_PROP_NBMAND:
1998 *val = getprop_uint64(zhp, prop, source);
2003 if (hasmntopt(&mnt, mntopt_on) && !*val) {
2006 *src = ZPROP_SRC_TEMPORARY;
2007 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
2010 *src = ZPROP_SRC_TEMPORARY;
2014 case ZFS_PROP_CANMOUNT:
2015 case ZFS_PROP_VOLSIZE:
2016 case ZFS_PROP_QUOTA:
2017 case ZFS_PROP_REFQUOTA:
2018 case ZFS_PROP_RESERVATION:
2019 case ZFS_PROP_REFRESERVATION:
2020 case ZFS_PROP_FILESYSTEM_LIMIT:
2021 case ZFS_PROP_SNAPSHOT_LIMIT:
2022 case ZFS_PROP_FILESYSTEM_COUNT:
2023 case ZFS_PROP_SNAPSHOT_COUNT:
2024 *val = getprop_uint64(zhp, prop, source);
2026 if (*source == NULL) {
2027 /* not default, must be local */
2028 *source = zhp->zfs_name;
2032 case ZFS_PROP_MOUNTED:
2033 *val = (zhp->zfs_mntopts != NULL);
2036 case ZFS_PROP_NUMCLONES:
2037 *val = zhp->zfs_dmustats.dds_num_clones;
2040 case ZFS_PROP_VERSION:
2041 case ZFS_PROP_NORMALIZE:
2042 case ZFS_PROP_UTF8ONLY:
2044 if (!zfs_prop_valid_for_type(prop, zhp->zfs_head_type) ||
2045 zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2047 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2048 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
2049 zcmd_free_nvlists(&zc);
2052 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
2053 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
2055 zcmd_free_nvlists(&zc);
2059 nvlist_free(zplprops);
2060 zcmd_free_nvlists(&zc);
2063 case ZFS_PROP_INCONSISTENT:
2064 *val = zhp->zfs_dmustats.dds_inconsistent;
2068 switch (zfs_prop_get_type(prop)) {
2069 case PROP_TYPE_NUMBER:
2070 case PROP_TYPE_INDEX:
2071 *val = getprop_uint64(zhp, prop, source);
2073 * If we tried to use a default value for a
2074 * readonly property, it means that it was not
2077 if (zfs_prop_readonly(prop) &&
2078 *source != NULL && (*source)[0] == '\0') {
2083 case PROP_TYPE_STRING:
2085 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
2086 "cannot get non-numeric property"));
2087 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
2088 dgettext(TEXT_DOMAIN, "internal error")));
2096 * Calculate the source type, given the raw source string.
2099 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
2100 char *statbuf, size_t statlen)
2102 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
2105 if (source == NULL) {
2106 *srctype = ZPROP_SRC_NONE;
2107 } else if (source[0] == '\0') {
2108 *srctype = ZPROP_SRC_DEFAULT;
2109 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
2110 *srctype = ZPROP_SRC_RECEIVED;
2112 if (strcmp(source, zhp->zfs_name) == 0) {
2113 *srctype = ZPROP_SRC_LOCAL;
2115 (void) strlcpy(statbuf, source, statlen);
2116 *srctype = ZPROP_SRC_INHERITED;
2123 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
2124 size_t proplen, boolean_t literal)
2129 if (zhp->zfs_recvd_props == NULL)
2130 if (get_recvd_props_ioctl(zhp) != 0)
2133 prop = zfs_name_to_prop(propname);
2135 if (prop != ZPROP_INVAL) {
2137 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
2139 zfs_set_recvd_props_mode(zhp, &cookie);
2140 err = zfs_prop_get(zhp, prop, propbuf, proplen,
2141 NULL, NULL, 0, literal);
2142 zfs_unset_recvd_props_mode(zhp, &cookie);
2146 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
2147 propname, &propval) != 0)
2149 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
2151 (void) strlcpy(propbuf, recvdval, proplen);
2154 return (err == 0 ? 0 : -1);
2158 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2163 value = zfs_get_clones_nvl(zhp);
2168 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
2169 pair = nvlist_next_nvpair(value, pair)) {
2170 if (propbuf[0] != '\0')
2171 (void) strlcat(propbuf, ",", proplen);
2172 (void) strlcat(propbuf, nvpair_name(pair), proplen);
2178 struct get_clones_arg {
2182 char buf[ZFS_MAXNAMELEN];
2186 get_clones_cb(zfs_handle_t *zhp, void *arg)
2188 struct get_clones_arg *gca = arg;
2190 if (gca->numclones == 0) {
2195 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
2196 NULL, NULL, 0, B_TRUE) != 0)
2198 if (strcmp(gca->buf, gca->origin) == 0) {
2199 fnvlist_add_boolean(gca->value, zfs_get_name(zhp));
2204 (void) zfs_iter_children(zhp, get_clones_cb, gca);
2210 zfs_get_clones_nvl(zfs_handle_t *zhp)
2212 nvlist_t *nv, *value;
2214 if (nvlist_lookup_nvlist(zhp->zfs_props,
2215 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
2216 struct get_clones_arg gca;
2219 * if this is a snapshot, then the kernel wasn't able
2220 * to get the clones. Do it by slowly iterating.
2222 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2224 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2226 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2231 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2233 gca.origin = zhp->zfs_name;
2235 if (gca.numclones != 0) {
2237 char pool[ZFS_MAXNAMELEN];
2240 /* get the pool name */
2241 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2242 (void) strsep(&cp, "/@");
2243 root = zfs_open(zhp->zfs_hdl, pool,
2244 ZFS_TYPE_FILESYSTEM);
2246 (void) get_clones_cb(root, &gca);
2249 if (gca.numclones != 0 ||
2250 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2251 nvlist_add_nvlist(zhp->zfs_props,
2252 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2259 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2260 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2263 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2269 * Retrieve a property from the given object. If 'literal' is specified, then
2270 * numbers are left as exact values. Otherwise, numbers are converted to a
2271 * human-readable form.
2273 * Returns 0 on success, or -1 on error.
2276 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2277 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2279 char *source = NULL;
2283 boolean_t received = zfs_is_recvd_props_mode(zhp);
2286 * Check to see if this property applies to our object
2288 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
2291 if (received && zfs_prop_readonly(prop))
2295 *src = ZPROP_SRC_NONE;
2298 case ZFS_PROP_CREATION:
2300 * 'creation' is a time_t stored in the statistics. We convert
2301 * this into a string unless 'literal' is specified.
2304 val = getprop_uint64(zhp, prop, &source);
2305 time_t time = (time_t)val;
2309 localtime_r(&time, &t) == NULL ||
2310 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2312 (void) snprintf(propbuf, proplen, "%llu", val);
2316 case ZFS_PROP_MOUNTPOINT:
2318 * Getting the precise mountpoint can be tricky.
2320 * - for 'none' or 'legacy', return those values.
2321 * - for inherited mountpoints, we want to take everything
2322 * after our ancestor and append it to the inherited value.
2324 * If the pool has an alternate root, we want to prepend that
2325 * root to any values we return.
2328 str = getprop_string(zhp, prop, &source);
2330 if (str[0] == '/') {
2331 char buf[MAXPATHLEN];
2333 const char *relpath;
2336 * If we inherit the mountpoint, even from a dataset
2337 * with a received value, the source will be the path of
2338 * the dataset we inherit from. If source is
2339 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2342 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2345 relpath = zhp->zfs_name + strlen(source);
2346 if (relpath[0] == '/')
2350 if ((zpool_get_prop(zhp->zpool_hdl,
2351 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2352 B_FALSE)) || (strcmp(root, "-") == 0))
2355 * Special case an alternate root of '/'. This will
2356 * avoid having multiple leading slashes in the
2359 if (strcmp(root, "/") == 0)
2363 * If the mountpoint is '/' then skip over this
2364 * if we are obtaining either an alternate root or
2365 * an inherited mountpoint.
2367 if (str[1] == '\0' && (root[0] != '\0' ||
2368 relpath[0] != '\0'))
2371 if (relpath[0] == '\0')
2372 (void) snprintf(propbuf, proplen, "%s%s",
2375 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2376 root, str, relpath[0] == '@' ? "" : "/",
2379 /* 'legacy' or 'none' */
2380 (void) strlcpy(propbuf, str, proplen);
2385 case ZFS_PROP_ORIGIN:
2386 str = getprop_string(zhp, prop, &source);
2389 (void) strlcpy(propbuf, str, proplen);
2392 case ZFS_PROP_CLONES:
2393 if (get_clones_string(zhp, propbuf, proplen) != 0)
2397 case ZFS_PROP_QUOTA:
2398 case ZFS_PROP_REFQUOTA:
2399 case ZFS_PROP_RESERVATION:
2400 case ZFS_PROP_REFRESERVATION:
2402 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2406 * If quota or reservation is 0, we translate this into 'none'
2407 * (unless literal is set), and indicate that it's the default
2408 * value. Otherwise, we print the number nicely and indicate
2409 * that its set locally.
2413 (void) strlcpy(propbuf, "0", proplen);
2415 (void) strlcpy(propbuf, "none", proplen);
2418 (void) snprintf(propbuf, proplen, "%llu",
2421 zfs_nicenum(val, propbuf, proplen);
2425 case ZFS_PROP_FILESYSTEM_LIMIT:
2426 case ZFS_PROP_SNAPSHOT_LIMIT:
2427 case ZFS_PROP_FILESYSTEM_COUNT:
2428 case ZFS_PROP_SNAPSHOT_COUNT:
2430 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2434 * If limit is UINT64_MAX, we translate this into 'none' (unless
2435 * literal is set), and indicate that it's the default value.
2436 * Otherwise, we print the number nicely and indicate that it's
2440 (void) snprintf(propbuf, proplen, "%llu",
2442 } else if (val == UINT64_MAX) {
2443 (void) strlcpy(propbuf, "none", proplen);
2445 zfs_nicenum(val, propbuf, proplen);
2449 case ZFS_PROP_REFRATIO:
2450 case ZFS_PROP_COMPRESSRATIO:
2451 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2453 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2454 (u_longlong_t)(val / 100),
2455 (u_longlong_t)(val % 100));
2459 switch (zhp->zfs_type) {
2460 case ZFS_TYPE_FILESYSTEM:
2463 case ZFS_TYPE_VOLUME:
2466 case ZFS_TYPE_SNAPSHOT:
2469 case ZFS_TYPE_BOOKMARK:
2475 (void) snprintf(propbuf, proplen, "%s", str);
2478 case ZFS_PROP_MOUNTED:
2480 * The 'mounted' property is a pseudo-property that described
2481 * whether the filesystem is currently mounted. Even though
2482 * it's a boolean value, the typical values of "on" and "off"
2483 * don't make sense, so we translate to "yes" and "no".
2485 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2486 src, &source, &val) != 0)
2489 (void) strlcpy(propbuf, "yes", proplen);
2491 (void) strlcpy(propbuf, "no", proplen);
2496 * The 'name' property is a pseudo-property derived from the
2497 * dataset name. It is presented as a real property to simplify
2500 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2503 case ZFS_PROP_MLSLABEL:
2506 m_label_t *new_sl = NULL;
2507 char *ascii = NULL; /* human readable label */
2509 (void) strlcpy(propbuf,
2510 getprop_string(zhp, prop, &source), proplen);
2512 if (literal || (strcasecmp(propbuf,
2513 ZFS_MLSLABEL_DEFAULT) == 0))
2517 * Try to translate the internal hex string to
2518 * human-readable output. If there are any
2519 * problems just use the hex string.
2522 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2523 L_NO_CORRECTION, NULL) == -1) {
2524 m_label_free(new_sl);
2528 if (label_to_str(new_sl, &ascii, M_LABEL,
2532 m_label_free(new_sl);
2535 m_label_free(new_sl);
2537 (void) strlcpy(propbuf, ascii, proplen);
2547 * GUIDs are stored as numbers, but they are identifiers.
2548 * We don't want them to be pretty printed, because pretty
2549 * printing mangles the ID into a truncated and useless value.
2551 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2553 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2557 switch (zfs_prop_get_type(prop)) {
2558 case PROP_TYPE_NUMBER:
2559 if (get_numeric_property(zhp, prop, src,
2560 &source, &val) != 0)
2563 (void) snprintf(propbuf, proplen, "%llu",
2566 zfs_nicenum(val, propbuf, proplen);
2569 case PROP_TYPE_STRING:
2570 str = getprop_string(zhp, prop, &source);
2573 (void) strlcpy(propbuf, str, proplen);
2576 case PROP_TYPE_INDEX:
2577 if (get_numeric_property(zhp, prop, src,
2578 &source, &val) != 0)
2580 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2582 (void) strlcpy(propbuf, strval, proplen);
2590 get_source(zhp, src, source, statbuf, statlen);
2596 * Utility function to get the given numeric property. Does no validation that
2597 * the given property is the appropriate type; should only be used with
2598 * hard-coded property types.
2601 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2606 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2612 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2616 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2617 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2621 * Similar to zfs_prop_get(), but returns the value as an integer.
2624 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2625 zprop_source_t *src, char *statbuf, size_t statlen)
2630 * Check to see if this property applies to our object
2632 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) {
2633 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2634 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2635 zfs_prop_to_name(prop)));
2639 *src = ZPROP_SRC_NONE;
2641 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2644 get_source(zhp, src, source, statbuf, statlen);
2650 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2651 char **domainp, idmap_rid_t *ridp)
2654 idmap_get_handle_t *get_hdl = NULL;
2658 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2662 err = idmap_get_sidbyuid(get_hdl, id,
2663 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2665 err = idmap_get_sidbygid(get_hdl, id,
2666 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2668 if (err == IDMAP_SUCCESS &&
2669 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2670 status == IDMAP_SUCCESS)
2676 idmap_get_destroy(get_hdl);
2679 assert(!"invalid code path");
2680 return (EINVAL); // silence compiler warning
2685 * convert the propname into parameters needed by kernel
2686 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2687 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2690 userquota_propname_decode(const char *propname, boolean_t zoned,
2691 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2693 zfs_userquota_prop_t type;
2695 char *numericsid = NULL;
2700 /* Figure out the property type ({user|group}{quota|space}) */
2701 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2702 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2703 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2706 if (type == ZFS_NUM_USERQUOTA_PROPS)
2710 isuser = (type == ZFS_PROP_USERQUOTA ||
2711 type == ZFS_PROP_USERUSED);
2713 cp = strchr(propname, '@') + 1;
2715 if (strchr(cp, '@')) {
2718 * It's a SID name (eg "user@domain") that needs to be
2719 * turned into S-1-domainID-RID.
2722 idmap_stat stat, map_stat;
2725 idmap_get_handle_t *gh = NULL;
2727 stat = idmap_get_create(&gh);
2728 if (stat != IDMAP_SUCCESS) {
2729 idmap_get_destroy(gh);
2732 if (zoned && getzoneid() == GLOBAL_ZONEID)
2735 stat = idmap_getuidbywinname(cp, NULL, flag, &pid);
2738 stat = idmap_get_sidbyuid(gh, pid, flag, &numericsid,
2741 stat = idmap_getgidbywinname(cp, NULL, flag, &pid);
2744 stat = idmap_get_sidbygid(gh, pid, flag, &numericsid,
2748 idmap_get_destroy(gh);
2751 stat = idmap_get_mappings(gh);
2752 idmap_get_destroy(gh);
2757 if (numericsid == NULL)
2761 /* will be further decoded below */
2767 if (strncmp(cp, "S-1-", 4) == 0) {
2768 /* It's a numeric SID (eg "S-1-234-567-89") */
2769 (void) strlcpy(domain, cp, domainlen);
2772 cp = strrchr(domain, '-');
2775 *ridp = strtoull(cp, &end, 10);
2783 if (errno != 0 || *end != '\0')
2785 } else if (!isdigit(*cp)) {
2787 * It's a user/group name (eg "user") that needs to be
2788 * turned into a uid/gid
2790 if (zoned && getzoneid() == GLOBAL_ZONEID)
2806 /* It's a user/group ID (eg "12345"). */
2807 uid_t id = strtoul(cp, &end, 10);
2814 /* It's an ephemeral ID. */
2815 if (idmap_id_to_numeric_domain_rid(id, isuser,
2816 &mapdomain, &rid) != 0)
2818 (void) strlcpy(domain, mapdomain, domainlen);
2825 ASSERT3P(numericsid, ==, NULL);
2830 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2831 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2834 zfs_cmd_t zc = { 0 };
2836 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2838 err = userquota_propname_decode(propname,
2839 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2840 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2841 zc.zc_objset_type = *typep;
2845 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2849 *propvalue = zc.zc_cookie;
2854 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2855 uint64_t *propvalue)
2857 zfs_userquota_prop_t type;
2859 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
2864 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
2865 char *propbuf, int proplen, boolean_t literal)
2869 zfs_userquota_prop_t type;
2871 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
2878 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2879 } else if (propvalue == 0 &&
2880 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
2881 (void) strlcpy(propbuf, "none", proplen);
2883 zfs_nicenum(propvalue, propbuf, proplen);
2889 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
2890 uint64_t *propvalue)
2893 zfs_cmd_t zc = { 0 };
2894 const char *snapname;
2896 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2898 snapname = strchr(propname, '@') + 1;
2899 if (strchr(snapname, '@')) {
2900 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
2902 /* snapname is the short name, append it to zhp's fsname */
2905 (void) strlcpy(zc.zc_value, zhp->zfs_name,
2906 sizeof (zc.zc_value));
2907 cp = strchr(zc.zc_value, '@');
2910 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
2911 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
2914 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
2918 *propvalue = zc.zc_cookie;
2923 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
2924 char *propbuf, int proplen, boolean_t literal)
2929 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
2935 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2937 zfs_nicenum(propvalue, propbuf, proplen);
2943 * Returns the name of the given zfs handle.
2946 zfs_get_name(const zfs_handle_t *zhp)
2948 return (zhp->zfs_name);
2952 * Returns the type of the given zfs handle.
2955 zfs_get_type(const zfs_handle_t *zhp)
2957 return (zhp->zfs_type);
2961 * Is one dataset name a child dataset of another?
2963 * Needs to handle these cases:
2964 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2965 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2966 * Descendant? No. No. No. Yes.
2969 is_descendant(const char *ds1, const char *ds2)
2971 size_t d1len = strlen(ds1);
2973 /* ds2 can't be a descendant if it's smaller */
2974 if (strlen(ds2) < d1len)
2977 /* otherwise, compare strings and verify that there's a '/' char */
2978 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
2982 * Given a complete name, return just the portion that refers to the parent.
2983 * Will return -1 if there is no parent (path is just the name of the
2987 parent_name(const char *path, char *buf, size_t buflen)
2991 (void) strlcpy(buf, path, buflen);
2993 if ((slashp = strrchr(buf, '/')) == NULL)
3001 * If accept_ancestor is false, then check to make sure that the given path has
3002 * a parent, and that it exists. If accept_ancestor is true, then find the
3003 * closest existing ancestor for the given path. In prefixlen return the
3004 * length of already existing prefix of the given path. We also fetch the
3005 * 'zoned' property, which is used to validate property settings when creating
3009 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
3010 boolean_t accept_ancestor, int *prefixlen)
3012 zfs_cmd_t zc = { 0 };
3013 char parent[ZFS_MAXNAMELEN];
3019 (void) snprintf(errbuf, sizeof (errbuf),
3020 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
3022 /* get parent, and check to see if this is just a pool */
3023 if (parent_name(path, parent, sizeof (parent)) != 0) {
3024 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3025 "missing dataset name"));
3026 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3029 /* check to see if the pool exists */
3030 if ((slash = strchr(parent, '/')) == NULL)
3031 slash = parent + strlen(parent);
3032 (void) strncpy(zc.zc_name, parent, slash - parent);
3033 zc.zc_name[slash - parent] = '\0';
3034 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
3036 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3037 "no such pool '%s'"), zc.zc_name);
3038 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3041 /* check to see if the parent dataset exists */
3042 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
3043 if (errno == ENOENT && accept_ancestor) {
3045 * Go deeper to find an ancestor, give up on top level.
3047 if (parent_name(parent, parent, sizeof (parent)) != 0) {
3048 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3049 "no such pool '%s'"), zc.zc_name);
3050 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3052 } else if (errno == ENOENT) {
3053 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3054 "parent does not exist"));
3055 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3057 return (zfs_standard_error(hdl, errno, errbuf));
3060 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
3064 /* we are in a non-global zone, but parent is in the global zone */
3065 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
3066 (void) zfs_standard_error(hdl, EPERM, errbuf);
3071 /* make sure parent is a filesystem */
3072 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
3073 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3074 "parent is not a filesystem"));
3075 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
3081 if (prefixlen != NULL)
3082 *prefixlen = strlen(parent);
3087 * Finds whether the dataset of the given type(s) exists.
3090 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
3094 if (!zfs_validate_name(hdl, path, types, B_FALSE))
3098 * Try to get stats for the dataset, which will tell us if it exists.
3100 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
3101 int ds_type = zhp->zfs_type;
3104 if (types & ds_type)
3111 * Given a path to 'target', create all the ancestors between
3112 * the prefixlen portion of the path, and the target itself.
3113 * Fail if the initial prefixlen-ancestor does not already exist.
3116 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
3122 /* make sure prefix exists */
3123 cp = target + prefixlen;
3125 assert(strchr(cp, '/') == NULL);
3126 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3129 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3137 * Attempt to create, mount, and share any ancestor filesystems,
3138 * up to the prefixlen-long one.
3140 for (cp = target + prefixlen + 1;
3141 cp = strchr(cp, '/'); *cp = '/', cp++) {
3145 h = make_dataset_handle(hdl, target);
3147 /* it already exists, nothing to do here */
3152 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
3154 opname = dgettext(TEXT_DOMAIN, "create");
3158 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3160 opname = dgettext(TEXT_DOMAIN, "open");
3164 if (zfs_mount(h, NULL, 0) != 0) {
3165 opname = dgettext(TEXT_DOMAIN, "mount");
3169 if (zfs_share(h) != 0) {
3170 opname = dgettext(TEXT_DOMAIN, "share");
3180 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3181 "failed to %s ancestor '%s'"), opname, target);
3186 * Creates non-existing ancestors of the given path.
3189 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
3195 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
3198 if ((path_copy = strdup(path)) != NULL) {
3199 rc = create_parents(hdl, path_copy, prefix);
3202 if (path_copy == NULL || rc != 0)
3209 * Create a new filesystem or volume.
3212 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
3217 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
3220 dmu_objset_type_t ost;
3222 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3223 "cannot create '%s'"), path);
3225 /* validate the path, taking care to note the extended error message */
3226 if (!zfs_validate_name(hdl, path, type, B_TRUE))
3227 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3229 /* validate parents exist */
3230 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
3234 * The failure modes when creating a dataset of a different type over
3235 * one that already exists is a little strange. In particular, if you
3236 * try to create a dataset on top of an existing dataset, the ioctl()
3237 * will return ENOENT, not EEXIST. To prevent this from happening, we
3238 * first try to see if the dataset exists.
3240 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
3241 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3242 "dataset already exists"));
3243 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3246 if (type == ZFS_TYPE_VOLUME)
3251 if (props && (props = zfs_valid_proplist(hdl, type, props,
3252 zoned, NULL, errbuf)) == 0)
3255 if (type == ZFS_TYPE_VOLUME) {
3257 * If we are creating a volume, the size and block size must
3258 * satisfy a few restraints. First, the blocksize must be a
3259 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3260 * volsize must be a multiple of the block size, and cannot be
3263 if (props == NULL || nvlist_lookup_uint64(props,
3264 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3266 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3267 "missing volume size"));
3268 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3271 if ((ret = nvlist_lookup_uint64(props,
3272 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3273 &blocksize)) != 0) {
3274 if (ret == ENOENT) {
3275 blocksize = zfs_prop_default_numeric(
3276 ZFS_PROP_VOLBLOCKSIZE);
3279 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3280 "missing volume block size"));
3281 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3287 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3288 "volume size cannot be zero"));
3289 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3292 if (size % blocksize != 0) {
3294 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3295 "volume size must be a multiple of volume block "
3297 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3301 /* create the dataset */
3302 ret = lzc_create(path, ost, props);
3305 /* check for failure */
3307 char parent[ZFS_MAXNAMELEN];
3308 (void) parent_name(path, parent, sizeof (parent));
3312 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3313 "no such parent '%s'"), parent);
3314 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3317 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3318 "parent '%s' is not a filesystem"), parent);
3319 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3322 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3323 "volume block size must be power of 2 from "
3326 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3329 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3330 "pool must be upgraded to set this "
3331 "property or value"));
3332 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3336 * This platform can't address a volume this big.
3338 if (type == ZFS_TYPE_VOLUME)
3339 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3344 return (zfs_standard_error(hdl, errno, errbuf));
3352 * Destroys the given dataset. The caller must make sure that the filesystem
3353 * isn't mounted, and that there are no active dependents. If the file system
3354 * does not exist this function does nothing.
3357 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3359 zfs_cmd_t zc = { 0 };
3361 if (zhp->zfs_type == ZFS_TYPE_BOOKMARK) {
3362 nvlist_t *nv = fnvlist_alloc();
3363 fnvlist_add_boolean(nv, zhp->zfs_name);
3364 int error = lzc_destroy_bookmarks(nv, NULL);
3367 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3368 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3374 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3376 if (ZFS_IS_VOLUME(zhp)) {
3377 zc.zc_objset_type = DMU_OST_ZVOL;
3379 zc.zc_objset_type = DMU_OST_ZFS;
3382 zc.zc_defer_destroy = defer;
3383 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0 &&
3385 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3386 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3390 remove_mountpoint(zhp);
3395 struct destroydata {
3397 const char *snapname;
3401 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3403 struct destroydata *dd = arg;
3404 char name[ZFS_MAXNAMELEN];
3407 (void) snprintf(name, sizeof (name),
3408 "%s@%s", zhp->zfs_name, dd->snapname);
3410 if (lzc_exists(name))
3411 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3413 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3419 * Destroys all snapshots with the given name in zhp & descendants.
3422 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3425 struct destroydata dd = { 0 };
3427 dd.snapname = snapname;
3428 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3429 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3431 if (nvlist_empty(dd.nvl)) {
3432 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3433 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3434 zhp->zfs_name, snapname);
3436 ret = zfs_destroy_snaps_nvl(zhp->zfs_hdl, dd.nvl, defer);
3438 nvlist_free(dd.nvl);
3443 * Destroys all the snapshots named in the nvlist.
3446 zfs_destroy_snaps_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, boolean_t defer)
3451 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3456 if (nvlist_empty(errlist)) {
3458 (void) snprintf(errbuf, sizeof (errbuf),
3459 dgettext(TEXT_DOMAIN, "cannot destroy snapshots"));
3461 ret = zfs_standard_error(hdl, ret, errbuf);
3463 for (nvpair_t *pair = nvlist_next_nvpair(errlist, NULL);
3464 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3466 (void) snprintf(errbuf, sizeof (errbuf),
3467 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3470 switch (fnvpair_value_int32(pair)) {
3473 dgettext(TEXT_DOMAIN, "snapshot is cloned"));
3474 ret = zfs_error(hdl, EZFS_EXISTS, errbuf);
3477 ret = zfs_standard_error(hdl, errno, errbuf);
3486 * Clones the given dataset. The target must be of the same type as the source.
3489 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3491 char parent[ZFS_MAXNAMELEN];
3494 libzfs_handle_t *hdl = zhp->zfs_hdl;
3497 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3499 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3500 "cannot create '%s'"), target);
3502 /* validate the target/clone name */
3503 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3504 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3506 /* validate parents exist */
3507 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3510 (void) parent_name(target, parent, sizeof (parent));
3516 if (ZFS_IS_VOLUME(zhp)) {
3517 type = ZFS_TYPE_VOLUME;
3519 type = ZFS_TYPE_FILESYSTEM;
3521 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3522 zhp, errbuf)) == NULL)
3526 ret = lzc_clone(target, zhp->zfs_name, props);
3534 * The parent doesn't exist. We should have caught this
3535 * above, but there may a race condition that has since
3536 * destroyed the parent.
3538 * At this point, we don't know whether it's the source
3539 * that doesn't exist anymore, or whether the target
3540 * dataset doesn't exist.
3542 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3543 "no such parent '%s'"), parent);
3544 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3547 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3548 "source and target pools differ"));
3549 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3553 return (zfs_standard_error(zhp->zfs_hdl, errno,
3562 * Promotes the given clone fs to be the clone parent.
3565 zfs_promote(zfs_handle_t *zhp)
3567 libzfs_handle_t *hdl = zhp->zfs_hdl;
3568 zfs_cmd_t zc = { 0 };
3569 char parent[MAXPATHLEN];
3573 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3574 "cannot promote '%s'"), zhp->zfs_name);
3576 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3577 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3578 "snapshots can not be promoted"));
3579 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3582 (void) strlcpy(parent, zhp->zfs_dmustats.dds_origin, sizeof (parent));
3583 if (parent[0] == '\0') {
3584 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3585 "not a cloned filesystem"));
3586 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3589 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_origin,
3590 sizeof (zc.zc_value));
3591 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3592 ret = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc);
3595 int save_errno = errno;
3597 switch (save_errno) {
3599 /* There is a conflicting snapshot name. */
3600 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3601 "conflicting snapshot '%s' from parent '%s'"),
3602 zc.zc_string, parent);
3603 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3606 return (zfs_standard_error(hdl, save_errno, errbuf));
3612 typedef struct snapdata {
3614 const char *sd_snapname;
3618 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
3620 snapdata_t *sd = arg;
3621 char name[ZFS_MAXNAMELEN];
3624 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) == 0) {
3625 (void) snprintf(name, sizeof (name),
3626 "%s@%s", zfs_get_name(zhp), sd->sd_snapname);
3628 fnvlist_add_boolean(sd->sd_nvl, name);
3630 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
3638 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3642 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
3649 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3650 "cannot create snapshots "));
3653 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
3654 const char *snapname = nvpair_name(elem);
3656 /* validate the target name */
3657 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
3659 (void) snprintf(errbuf, sizeof (errbuf),
3660 dgettext(TEXT_DOMAIN,
3661 "cannot create snapshot '%s'"), snapname);
3662 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3666 if (props != NULL &&
3667 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3668 props, B_FALSE, NULL, errbuf)) == NULL) {
3672 ret = lzc_snapshot(snaps, props, &errors);
3675 boolean_t printed = B_FALSE;
3676 for (elem = nvlist_next_nvpair(errors, NULL);
3678 elem = nvlist_next_nvpair(errors, elem)) {
3679 (void) snprintf(errbuf, sizeof (errbuf),
3680 dgettext(TEXT_DOMAIN,
3681 "cannot create snapshot '%s'"), nvpair_name(elem));
3682 (void) zfs_standard_error(hdl,
3683 fnvpair_value_int32(elem), errbuf);
3689 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3690 "multiple snapshots of same "
3692 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3696 (void) zfs_standard_error(hdl, ret, errbuf);
3702 nvlist_free(errors);
3707 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3711 snapdata_t sd = { 0 };
3712 char fsname[ZFS_MAXNAMELEN];
3717 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3718 "cannot snapshot %s"), path);
3720 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3721 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3723 (void) strlcpy(fsname, path, sizeof (fsname));
3724 cp = strchr(fsname, '@');
3726 sd.sd_snapname = cp + 1;
3728 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
3729 ZFS_TYPE_VOLUME)) == NULL) {
3733 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
3735 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
3737 fnvlist_add_boolean(sd.sd_nvl, path);
3740 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
3741 nvlist_free(sd.sd_nvl);
3747 * Destroy any more recent snapshots. We invoke this callback on any dependents
3748 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3749 * is a dependent and we should just destroy it without checking the transaction
3752 typedef struct rollback_data {
3753 const char *cb_target; /* the snapshot */
3754 uint64_t cb_create; /* creation time reference */
3760 rollback_destroy_dependent(zfs_handle_t *zhp, void *data)
3762 rollback_data_t *cbp = data;
3763 prop_changelist_t *clp;
3765 /* We must destroy this clone; first unmount it */
3766 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3767 cbp->cb_force ? MS_FORCE: 0);
3768 if (clp == NULL || changelist_prefix(clp) != 0) {
3769 cbp->cb_error = B_TRUE;
3773 if (zfs_destroy(zhp, B_FALSE) != 0)
3774 cbp->cb_error = B_TRUE;
3776 changelist_remove(clp, zhp->zfs_name);
3777 (void) changelist_postfix(clp);
3778 changelist_free(clp);
3785 rollback_destroy(zfs_handle_t *zhp, void *data)
3787 rollback_data_t *cbp = data;
3789 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > cbp->cb_create) {
3790 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3791 rollback_destroy_dependent, cbp);
3793 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3801 * Given a dataset, rollback to a specific snapshot, discarding any
3802 * data changes since then and making it the active dataset.
3804 * Any snapshots and bookmarks more recent than the target are
3805 * destroyed, along with their dependents (i.e. clones).
3808 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3810 rollback_data_t cb = { 0 };
3812 boolean_t restore_resv = 0;
3813 uint64_t old_volsize, new_volsize;
3814 zfs_prop_t resv_prop;
3816 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3817 zhp->zfs_type == ZFS_TYPE_VOLUME);
3820 * Destroy all recent snapshots and their dependents.
3822 cb.cb_force = force;
3823 cb.cb_target = snap->zfs_name;
3824 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3825 (void) zfs_iter_snapshots(zhp, B_FALSE, rollback_destroy, &cb);
3826 (void) zfs_iter_bookmarks(zhp, rollback_destroy, &cb);
3832 * Now that we have verified that the snapshot is the latest,
3833 * rollback to the given snapshot.
3836 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
3837 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
3839 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3841 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
3845 * We rely on zfs_iter_children() to verify that there are no
3846 * newer snapshots for the given dataset. Therefore, we can
3847 * simply pass the name on to the ioctl() call. There is still
3848 * an unlikely race condition where the user has taken a
3849 * snapshot since we verified that this was the most recent.
3851 err = lzc_rollback(zhp->zfs_name, NULL, 0);
3853 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3854 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
3860 * For volumes, if the pre-rollback volsize matched the pre-
3861 * rollback reservation and the volsize has changed then set
3862 * the reservation property to the post-rollback volsize.
3863 * Make a new handle since the rollback closed the dataset.
3865 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
3866 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
3868 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3869 if (old_volsize != new_volsize)
3870 err = zfs_prop_set_int(zhp, resv_prop,
3879 * Renames the given dataset.
3882 zfs_rename(zfs_handle_t *zhp, const char *source, const char *target,
3883 renameflags_t flags)
3886 zfs_cmd_t zc = { 0 };
3888 prop_changelist_t *cl = NULL;
3889 zfs_handle_t *zhrp = NULL;
3890 char *parentname = NULL;
3891 char parent[ZFS_MAXNAMELEN];
3892 char property[ZFS_MAXPROPLEN];
3893 libzfs_handle_t *hdl = zhp->zfs_hdl;
3896 /* if we have the same exact name, just return success */
3897 if (strcmp(zhp->zfs_name, target) == 0)
3900 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3901 "cannot rename to '%s'"), target);
3903 if (source != NULL) {
3905 * This is recursive snapshots rename, put snapshot name
3906 * (that might not exist) into zfs_name.
3908 assert(flags.recurse);
3910 (void) strlcat(zhp->zfs_name, "@", sizeof(zhp->zfs_name));
3911 (void) strlcat(zhp->zfs_name, source, sizeof(zhp->zfs_name));
3912 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
3916 * Make sure the target name is valid
3918 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3919 if ((strchr(target, '@') == NULL) ||
3922 * Snapshot target name is abbreviated,
3923 * reconstruct full dataset name
3925 (void) strlcpy(parent, zhp->zfs_name,
3927 delim = strchr(parent, '@');
3928 if (strchr(target, '@') == NULL)
3932 (void) strlcat(parent, target, sizeof (parent));
3936 * Make sure we're renaming within the same dataset.
3938 delim = strchr(target, '@');
3939 if (strncmp(zhp->zfs_name, target, delim - target)
3940 != 0 || zhp->zfs_name[delim - target] != '@') {
3941 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3942 "snapshots must be part of same "
3944 return (zfs_error(hdl, EZFS_CROSSTARGET,
3948 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3949 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3951 if (flags.recurse) {
3952 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3953 "recursive rename must be a snapshot"));
3954 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3957 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3958 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3960 /* validate parents */
3961 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
3964 /* make sure we're in the same pool */
3965 verify((delim = strchr(target, '/')) != NULL);
3966 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
3967 zhp->zfs_name[delim - target] != '/') {
3968 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3969 "datasets must be within same pool"));
3970 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
3973 /* new name cannot be a child of the current dataset name */
3974 if (is_descendant(zhp->zfs_name, target)) {
3975 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3976 "New dataset name cannot be a descendant of "
3977 "current dataset name"));
3978 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3982 (void) snprintf(errbuf, sizeof (errbuf),
3983 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
3985 if (getzoneid() == GLOBAL_ZONEID &&
3986 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
3987 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3988 "dataset is used in a non-global zone"));
3989 return (zfs_error(hdl, EZFS_ZONED, errbuf));
3993 * Avoid unmounting file systems with mountpoint property set to
3994 * 'legacy' or 'none' even if -u option is not given.
3996 if (zhp->zfs_type == ZFS_TYPE_FILESYSTEM &&
3997 !flags.recurse && !flags.nounmount &&
3998 zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, property,
3999 sizeof (property), NULL, NULL, 0, B_FALSE) == 0 &&
4000 (strcmp(property, "legacy") == 0 ||
4001 strcmp(property, "none") == 0)) {
4002 flags.nounmount = B_TRUE;
4004 if (flags.recurse) {
4006 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
4007 if (parentname == NULL) {
4011 delim = strchr(parentname, '@');
4013 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
4018 } else if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT) {
4019 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME,
4020 flags.nounmount ? CL_GATHER_DONT_UNMOUNT : 0,
4021 flags.forceunmount ? MS_FORCE : 0)) == NULL) {
4025 if (changelist_haszonedchild(cl)) {
4026 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4027 "child dataset with inherited mountpoint is used "
4028 "in a non-global zone"));
4029 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
4033 if ((ret = changelist_prefix(cl)) != 0)
4037 if (ZFS_IS_VOLUME(zhp))
4038 zc.zc_objset_type = DMU_OST_ZVOL;
4040 zc.zc_objset_type = DMU_OST_ZFS;
4042 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4043 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
4045 zc.zc_cookie = flags.recurse ? 1 : 0;
4046 if (flags.nounmount)
4049 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
4051 * if it was recursive, the one that actually failed will
4054 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4055 "cannot rename '%s'"), zc.zc_name);
4057 if (flags.recurse && errno == EEXIST) {
4058 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4059 "a child dataset already has a snapshot "
4060 "with the new name"));
4061 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
4063 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
4067 * On failure, we still want to remount any filesystems that
4068 * were previously mounted, so we don't alter the system state.
4071 (void) changelist_postfix(cl);
4074 changelist_rename(cl, zfs_get_name(zhp), target);
4075 ret = changelist_postfix(cl);
4080 if (parentname != NULL) {
4087 changelist_free(cl);
4093 zfs_get_user_props(zfs_handle_t *zhp)
4095 return (zhp->zfs_user_props);
4099 zfs_get_recvd_props(zfs_handle_t *zhp)
4101 if (zhp->zfs_recvd_props == NULL)
4102 if (get_recvd_props_ioctl(zhp) != 0)
4104 return (zhp->zfs_recvd_props);
4108 * This function is used by 'zfs list' to determine the exact set of columns to
4109 * display, and their maximum widths. This does two main things:
4111 * - If this is a list of all properties, then expand the list to include
4112 * all native properties, and set a flag so that for each dataset we look
4113 * for new unique user properties and add them to the list.
4115 * - For non fixed-width properties, keep track of the maximum width seen
4116 * so that we can size the column appropriately. If the user has
4117 * requested received property values, we also need to compute the width
4118 * of the RECEIVED column.
4121 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received,
4124 libzfs_handle_t *hdl = zhp->zfs_hdl;
4125 zprop_list_t *entry;
4126 zprop_list_t **last, **start;
4127 nvlist_t *userprops, *propval;
4130 char buf[ZFS_MAXPROPLEN];
4132 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
4135 userprops = zfs_get_user_props(zhp);
4138 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
4140 * Go through and add any user properties as necessary. We
4141 * start by incrementing our list pointer to the first
4142 * non-native property.
4145 while (*start != NULL) {
4146 if ((*start)->pl_prop == ZPROP_INVAL)
4148 start = &(*start)->pl_next;
4152 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
4154 * See if we've already found this property in our list.
4156 for (last = start; *last != NULL;
4157 last = &(*last)->pl_next) {
4158 if (strcmp((*last)->pl_user_prop,
4159 nvpair_name(elem)) == 0)
4163 if (*last == NULL) {
4164 if ((entry = zfs_alloc(hdl,
4165 sizeof (zprop_list_t))) == NULL ||
4166 ((entry->pl_user_prop = zfs_strdup(hdl,
4167 nvpair_name(elem)))) == NULL) {
4172 entry->pl_prop = ZPROP_INVAL;
4173 entry->pl_width = strlen(nvpair_name(elem));
4174 entry->pl_all = B_TRUE;
4181 * Now go through and check the width of any non-fixed columns
4183 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
4184 if (entry->pl_fixed && !literal)
4187 if (entry->pl_prop != ZPROP_INVAL) {
4188 if (zfs_prop_get(zhp, entry->pl_prop,
4189 buf, sizeof (buf), NULL, NULL, 0, literal) == 0) {
4190 if (strlen(buf) > entry->pl_width)
4191 entry->pl_width = strlen(buf);
4193 if (received && zfs_prop_get_recvd(zhp,
4194 zfs_prop_to_name(entry->pl_prop),
4195 buf, sizeof (buf), literal) == 0)
4196 if (strlen(buf) > entry->pl_recvd_width)
4197 entry->pl_recvd_width = strlen(buf);
4199 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
4201 verify(nvlist_lookup_string(propval,
4202 ZPROP_VALUE, &strval) == 0);
4203 if (strlen(strval) > entry->pl_width)
4204 entry->pl_width = strlen(strval);
4206 if (received && zfs_prop_get_recvd(zhp,
4207 entry->pl_user_prop,
4208 buf, sizeof (buf), literal) == 0)
4209 if (strlen(buf) > entry->pl_recvd_width)
4210 entry->pl_recvd_width = strlen(buf);
4218 zfs_deleg_share_nfs(libzfs_handle_t *hdl, char *dataset, char *path,
4219 char *resource, void *export, void *sharetab,
4220 int sharemax, zfs_share_op_t operation)
4222 zfs_cmd_t zc = { 0 };
4225 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4226 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4228 (void) strlcpy(zc.zc_string, resource, sizeof (zc.zc_string));
4229 zc.zc_share.z_sharedata = (uint64_t)(uintptr_t)sharetab;
4230 zc.zc_share.z_exportdata = (uint64_t)(uintptr_t)export;
4231 zc.zc_share.z_sharetype = operation;
4232 zc.zc_share.z_sharemax = sharemax;
4233 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SHARE, &zc);
4238 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
4243 * Keep a reference to the props-table against which we prune the
4246 zhp->zfs_props_table = props;
4248 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
4251 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
4252 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
4255 * User properties will result in ZPROP_INVAL, and since we
4256 * only know how to prune standard ZFS properties, we always
4257 * leave these in the list. This can also happen if we
4258 * encounter an unknown DSL property (when running older
4259 * software, for example).
4261 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
4262 (void) nvlist_remove(zhp->zfs_props,
4263 nvpair_name(curr), nvpair_type(curr));
4270 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
4271 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
4273 zfs_cmd_t zc = { 0 };
4274 nvlist_t *nvlist = NULL;
4277 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4278 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4279 zc.zc_cookie = (uint64_t)cmd;
4281 if (cmd == ZFS_SMB_ACL_RENAME) {
4282 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
4283 (void) no_memory(hdl);
4289 case ZFS_SMB_ACL_ADD:
4290 case ZFS_SMB_ACL_REMOVE:
4291 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4293 case ZFS_SMB_ACL_RENAME:
4294 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4296 (void) no_memory(hdl);
4299 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4301 (void) no_memory(hdl);
4304 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4305 nvlist_free(nvlist);
4309 case ZFS_SMB_ACL_PURGE:
4314 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4316 nvlist_free(nvlist);
4321 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4322 char *path, char *resource)
4324 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4329 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4330 char *path, char *resource)
4332 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4337 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4339 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4344 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4345 char *oldname, char *newname)
4347 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4353 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4354 zfs_userspace_cb_t func, void *arg)
4356 zfs_cmd_t zc = { 0 };
4357 zfs_useracct_t buf[100];
4358 libzfs_handle_t *hdl = zhp->zfs_hdl;
4361 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4363 zc.zc_objset_type = type;
4364 zc.zc_nvlist_dst = (uintptr_t)buf;
4367 zfs_useracct_t *zua = buf;
4369 zc.zc_nvlist_dst_size = sizeof (buf);
4370 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4373 (void) snprintf(errbuf, sizeof (errbuf),
4374 dgettext(TEXT_DOMAIN,
4375 "cannot get used/quota for %s"), zc.zc_name);
4376 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4378 if (zc.zc_nvlist_dst_size == 0)
4381 while (zc.zc_nvlist_dst_size > 0) {
4382 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4383 zua->zu_space)) != 0)
4386 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4395 const char *snapname;
4397 boolean_t recursive;
4402 zfs_hold_one(zfs_handle_t *zhp, void *arg)
4404 struct holdarg *ha = arg;
4405 char name[ZFS_MAXNAMELEN];
4408 (void) snprintf(name, sizeof (name),
4409 "%s@%s", zhp->zfs_name, ha->snapname);
4411 if (lzc_exists(name))
4412 fnvlist_add_string(ha->nvl, name, ha->tag);
4415 rv = zfs_iter_filesystems(zhp, zfs_hold_one, ha);
4421 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4422 boolean_t recursive, int cleanup_fd)
4427 ha.nvl = fnvlist_alloc();
4428 ha.snapname = snapname;
4430 ha.recursive = recursive;
4431 (void) zfs_hold_one(zfs_handle_dup(zhp), &ha);
4433 if (nvlist_empty(ha.nvl)) {
4436 fnvlist_free(ha.nvl);
4438 (void) snprintf(errbuf, sizeof (errbuf),
4439 dgettext(TEXT_DOMAIN,
4440 "cannot hold snapshot '%s@%s'"),
4441 zhp->zfs_name, snapname);
4442 (void) zfs_standard_error(zhp->zfs_hdl, ret, errbuf);
4446 ret = zfs_hold_nvl(zhp, cleanup_fd, ha.nvl);
4447 fnvlist_free(ha.nvl);
4453 zfs_hold_nvl(zfs_handle_t *zhp, int cleanup_fd, nvlist_t *holds)
4457 libzfs_handle_t *hdl = zhp->zfs_hdl;
4462 ret = lzc_hold(holds, cleanup_fd, &errors);
4465 /* There may be errors even in the success case. */
4466 fnvlist_free(errors);
4470 if (nvlist_empty(errors)) {
4471 /* no hold-specific errors */
4472 (void) snprintf(errbuf, sizeof (errbuf),
4473 dgettext(TEXT_DOMAIN, "cannot hold"));
4476 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4477 "pool must be upgraded"));
4478 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4481 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4484 (void) zfs_standard_error(hdl, ret, errbuf);
4488 for (elem = nvlist_next_nvpair(errors, NULL);
4490 elem = nvlist_next_nvpair(errors, elem)) {
4491 (void) snprintf(errbuf, sizeof (errbuf),
4492 dgettext(TEXT_DOMAIN,
4493 "cannot hold snapshot '%s'"), nvpair_name(elem));
4494 switch (fnvpair_value_int32(elem)) {
4497 * Temporary tags wind up having the ds object id
4498 * prepended. So even if we passed the length check
4499 * above, it's still possible for the tag to wind
4500 * up being slightly too long.
4502 (void) zfs_error(hdl, EZFS_TAGTOOLONG, errbuf);
4505 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4508 (void) zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf);
4511 (void) zfs_standard_error(hdl,
4512 fnvpair_value_int32(elem), errbuf);
4516 fnvlist_free(errors);
4521 zfs_release_one(zfs_handle_t *zhp, void *arg)
4523 struct holdarg *ha = arg;
4524 char name[ZFS_MAXNAMELEN];
4526 nvlist_t *existing_holds;
4528 (void) snprintf(name, sizeof (name),
4529 "%s@%s", zhp->zfs_name, ha->snapname);
4531 if (lzc_get_holds(name, &existing_holds) != 0) {
4533 } else if (!nvlist_exists(existing_holds, ha->tag)) {
4536 nvlist_t *torelease = fnvlist_alloc();
4537 fnvlist_add_boolean(torelease, ha->tag);
4538 fnvlist_add_nvlist(ha->nvl, name, torelease);
4539 fnvlist_free(torelease);
4543 rv = zfs_iter_filesystems(zhp, zfs_release_one, ha);
4549 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4550 boolean_t recursive)
4554 nvlist_t *errors = NULL;
4556 libzfs_handle_t *hdl = zhp->zfs_hdl;
4559 ha.nvl = fnvlist_alloc();
4560 ha.snapname = snapname;
4562 ha.recursive = recursive;
4564 (void) zfs_release_one(zfs_handle_dup(zhp), &ha);
4566 if (nvlist_empty(ha.nvl)) {
4567 fnvlist_free(ha.nvl);
4569 (void) snprintf(errbuf, sizeof (errbuf),
4570 dgettext(TEXT_DOMAIN,
4571 "cannot release hold from snapshot '%s@%s'"),
4572 zhp->zfs_name, snapname);
4574 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4576 (void) zfs_standard_error(hdl, ret, errbuf);
4581 ret = lzc_release(ha.nvl, &errors);
4582 fnvlist_free(ha.nvl);
4585 /* There may be errors even in the success case. */
4586 fnvlist_free(errors);
4590 if (nvlist_empty(errors)) {
4591 /* no hold-specific errors */
4592 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4596 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4597 "pool must be upgraded"));
4598 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4601 (void) zfs_standard_error_fmt(hdl, errno, errbuf);
4605 for (elem = nvlist_next_nvpair(errors, NULL);
4607 elem = nvlist_next_nvpair(errors, elem)) {
4608 (void) snprintf(errbuf, sizeof (errbuf),
4609 dgettext(TEXT_DOMAIN,
4610 "cannot release hold from snapshot '%s'"),
4612 switch (fnvpair_value_int32(elem)) {
4614 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4617 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4620 (void) zfs_standard_error_fmt(hdl,
4621 fnvpair_value_int32(elem), errbuf);
4625 fnvlist_free(errors);
4630 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4632 zfs_cmd_t zc = { 0 };
4633 libzfs_handle_t *hdl = zhp->zfs_hdl;
4639 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4640 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4644 nvbuf = malloc(nvsz);
4645 if (nvbuf == NULL) {
4646 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4650 zc.zc_nvlist_dst_size = nvsz;
4651 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4653 (void) strlcpy(zc.zc_name, zhp->zfs_name, ZFS_MAXNAMELEN);
4655 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4656 (void) snprintf(errbuf, sizeof (errbuf),
4657 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4662 nvsz = zc.zc_nvlist_dst_size;
4666 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4667 "pool must be upgraded"));
4668 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4671 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4674 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4677 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4682 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4684 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4685 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4687 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4697 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4699 zfs_cmd_t zc = { 0 };
4700 libzfs_handle_t *hdl = zhp->zfs_hdl;
4706 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4707 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4709 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
4712 nvbuf = malloc(nvsz);
4714 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
4717 zc.zc_nvlist_src_size = nvsz;
4718 zc.zc_nvlist_src = (uintptr_t)nvbuf;
4719 zc.zc_perm_action = un;
4721 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4723 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
4724 (void) snprintf(errbuf, sizeof (errbuf),
4725 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
4729 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4730 "pool must be upgraded"));
4731 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4734 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4737 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4740 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4751 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
4756 err = lzc_get_holds(zhp->zfs_name, nvl);
4759 libzfs_handle_t *hdl = zhp->zfs_hdl;
4761 (void) snprintf(errbuf, sizeof (errbuf),
4762 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4766 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4767 "pool must be upgraded"));
4768 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4771 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4774 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4777 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4786 * Convert the zvol's volume size to an appropriate reservation.
4787 * Note: If this routine is updated, it is necessary to update the ZFS test
4788 * suite's shell version in reservation.kshlib.
4791 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4794 uint64_t nblocks, volblocksize;
4798 if (nvlist_lookup_string(props,
4799 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4800 ncopies = atoi(strval);
4803 if (nvlist_lookup_uint64(props,
4804 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4805 &volblocksize) != 0)
4806 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4807 nblocks = volsize/volblocksize;
4808 /* start with metadnode L0-L6 */
4810 /* calculate number of indirects */
4811 while (nblocks > 1) {
4812 nblocks += DNODES_PER_LEVEL - 1;
4813 nblocks /= DNODES_PER_LEVEL;
4816 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4819 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4820 * compressed, but in practice they compress down to about
4823 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;
4829 * Attach/detach the given filesystem to/from the given jail.
4832 zfs_jail(zfs_handle_t *zhp, int jailid, int attach)
4834 libzfs_handle_t *hdl = zhp->zfs_hdl;
4835 zfs_cmd_t zc = { 0 };
4841 (void) snprintf(errbuf, sizeof (errbuf),
4842 dgettext(TEXT_DOMAIN, "cannot jail '%s'"), zhp->zfs_name);
4844 (void) snprintf(errbuf, sizeof (errbuf),
4845 dgettext(TEXT_DOMAIN, "cannot unjail '%s'"), zhp->zfs_name);
4848 switch (zhp->zfs_type) {
4849 case ZFS_TYPE_VOLUME:
4850 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4851 "volumes can not be jailed"));
4852 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4853 case ZFS_TYPE_SNAPSHOT:
4854 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4855 "snapshots can not be jailed"));
4856 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4858 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4860 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4861 zc.zc_objset_type = DMU_OST_ZFS;
4862 zc.zc_jailid = jailid;
4864 cmd = attach ? ZFS_IOC_JAIL : ZFS_IOC_UNJAIL;
4865 if ((ret = ioctl(hdl->libzfs_fd, cmd, &zc)) != 0)
4866 zfs_standard_error(hdl, errno, errbuf);