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;
1408 * If this is an existing volume, and someone is setting the volsize,
1409 * make sure that it matches the reservation, or add it if necessary.
1411 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1412 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1414 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1415 if ((zvol_volsize_to_reservation(old_volsize, zhp->zfs_props) !=
1416 old_reservation) || nvlist_lookup_uint64(nvl,
1417 zfs_prop_to_name(resv_prop), &new_reservation) != ENOENT) {
1420 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1423 new_reservation = zvol_volsize_to_reservation(new_volsize,
1425 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1426 new_reservation) != 0) {
1427 (void) no_memory(zhp->zfs_hdl);
1434 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1441 * For quotas and reservations, ENOSPC indicates
1442 * something different; setting a quota or reservation
1443 * doesn't use any disk space.
1446 case ZFS_PROP_QUOTA:
1447 case ZFS_PROP_REFQUOTA:
1448 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1449 "size is less than current used or "
1451 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1454 case ZFS_PROP_RESERVATION:
1455 case ZFS_PROP_REFRESERVATION:
1456 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1457 "size is greater than available space"));
1458 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1462 (void) zfs_standard_error(hdl, err, errbuf);
1468 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1472 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1476 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1477 "pool and or dataset must be upgraded to set this "
1478 "property or value"));
1479 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1484 if (prop == ZFS_PROP_COMPRESSION ||
1485 prop == ZFS_PROP_RECORDSIZE) {
1486 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1487 "property setting is not allowed on "
1488 "bootable datasets"));
1489 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1490 } else if (prop == ZFS_PROP_CHECKSUM ||
1491 prop == ZFS_PROP_DEDUP) {
1492 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1493 "property setting is not allowed on "
1495 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1497 (void) zfs_standard_error(hdl, err, errbuf);
1502 if (prop == ZPROP_INVAL) {
1503 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1505 (void) zfs_standard_error(hdl, err, errbuf);
1511 * This platform can't address a volume this big.
1514 if (prop == ZFS_PROP_VOLSIZE) {
1515 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1521 (void) zfs_standard_error(hdl, err, errbuf);
1526 * Given a property name and value, set the property for the given dataset.
1529 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1533 libzfs_handle_t *hdl = zhp->zfs_hdl;
1534 nvlist_t *nvl = NULL;
1536 (void) snprintf(errbuf, sizeof (errbuf),
1537 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1540 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1541 nvlist_add_string(nvl, propname, propval) != 0) {
1542 (void) no_memory(hdl);
1546 ret = zfs_prop_set_list(zhp, nvl);
1556 * Given an nvlist of property names and values, set the properties for the
1560 zfs_prop_set_list(zfs_handle_t *zhp, nvlist_t *props)
1562 zfs_cmd_t zc = { 0 };
1564 prop_changelist_t **cls = NULL;
1567 libzfs_handle_t *hdl = zhp->zfs_hdl;
1572 (void) snprintf(errbuf, sizeof (errbuf),
1573 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1576 if ((nvl = zfs_valid_proplist(hdl, zhp->zfs_type, props,
1577 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, errbuf)) == NULL)
1581 * We have to check for any extra properties which need to be added
1582 * before computing the length of the nvlist.
1584 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1586 elem = nvlist_next_nvpair(nvl, elem)) {
1587 if (zfs_name_to_prop(nvpair_name(elem)) == ZFS_PROP_VOLSIZE &&
1588 (added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1) {
1593 * Check how many properties we're setting and allocate an array to
1594 * store changelist pointers for postfix().
1597 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1599 elem = nvlist_next_nvpair(nvl, elem))
1601 if ((cls = calloc(nvl_len, sizeof (prop_changelist_t *))) == NULL)
1605 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1607 elem = nvlist_next_nvpair(nvl, elem)) {
1609 zfs_prop_t prop = zfs_name_to_prop(nvpair_name(elem));
1611 assert(cl_idx < nvl_len);
1613 * We don't want to unmount & remount the dataset when changing
1614 * its canmount property to 'on' or 'noauto'. We only use
1615 * the changelist logic to unmount when setting canmount=off.
1617 if (!(prop == ZFS_PROP_CANMOUNT &&
1618 fnvpair_value_uint64(elem) != ZFS_CANMOUNT_OFF)) {
1619 cls[cl_idx] = changelist_gather(zhp, prop, 0, 0);
1620 if (cls[cl_idx] == NULL)
1624 if (prop == ZFS_PROP_MOUNTPOINT &&
1625 changelist_haszonedchild(cls[cl_idx])) {
1626 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1627 "child dataset with inherited mountpoint is used "
1628 "in a non-global zone"));
1629 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1633 /* We don't support those properties on FreeBSD. */
1635 case ZFS_PROP_DEVICES:
1636 case ZFS_PROP_ISCSIOPTIONS:
1637 case ZFS_PROP_XATTR:
1638 case ZFS_PROP_VSCAN:
1639 case ZFS_PROP_NBMAND:
1640 case ZFS_PROP_MLSLABEL:
1641 (void) snprintf(errbuf, sizeof (errbuf),
1642 "property '%s' not supported on FreeBSD",
1644 ret = zfs_error(hdl, EZFS_PERM, errbuf);
1648 if (cls[cl_idx] != NULL &&
1649 (ret = changelist_prefix(cls[cl_idx])) != 0)
1654 assert(cl_idx == nvl_len);
1657 * Execute the corresponding ioctl() to set this list of properties.
1659 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1661 if ((ret = zcmd_write_src_nvlist(hdl, &zc, nvl)) != 0 ||
1662 (ret = zcmd_alloc_dst_nvlist(hdl, &zc, 0)) != 0)
1665 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1668 /* Get the list of unset properties back and report them. */
1669 nvlist_t *errorprops = NULL;
1670 if (zcmd_read_dst_nvlist(hdl, &zc, &errorprops) != 0)
1672 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1674 elem = nvlist_next_nvpair(nvl, elem)) {
1675 zfs_prop_t prop = zfs_name_to_prop(nvpair_name(elem));
1676 zfs_setprop_error(hdl, prop, errno, errbuf);
1678 nvlist_free(errorprops);
1680 if (added_resv && errno == ENOSPC) {
1681 /* clean up the volsize property we tried to set */
1682 uint64_t old_volsize = zfs_prop_get_int(zhp,
1686 zcmd_free_nvlists(&zc);
1688 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1690 if (nvlist_add_uint64(nvl,
1691 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1694 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1696 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1699 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1700 if (cls[cl_idx] != NULL) {
1701 int clp_err = changelist_postfix(cls[cl_idx]);
1708 * Refresh the statistics so the new property value
1712 (void) get_stats(zhp);
1717 zcmd_free_nvlists(&zc);
1719 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1720 if (cls[cl_idx] != NULL)
1721 changelist_free(cls[cl_idx]);
1729 * Given a property, inherit the value from the parent dataset, or if received
1730 * is TRUE, revert to the received value, if any.
1733 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1735 zfs_cmd_t zc = { 0 };
1737 prop_changelist_t *cl;
1738 libzfs_handle_t *hdl = zhp->zfs_hdl;
1742 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1743 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1745 zc.zc_cookie = received;
1746 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1748 * For user properties, the amount of work we have to do is very
1749 * small, so just do it here.
1751 if (!zfs_prop_user(propname)) {
1752 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1753 "invalid property"));
1754 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1757 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1758 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1760 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1761 return (zfs_standard_error(hdl, errno, errbuf));
1767 * Verify that this property is inheritable.
1769 if (zfs_prop_readonly(prop))
1770 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1772 if (!zfs_prop_inheritable(prop) && !received)
1773 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1776 * Check to see if the value applies to this type
1778 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1779 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1782 * Normalize the name, to get rid of shorthand abbreviations.
1784 propname = zfs_prop_to_name(prop);
1785 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1786 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1788 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1789 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1790 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1791 "dataset is used in a non-global zone"));
1792 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1796 * Determine datasets which will be affected by this change, if any.
1798 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1801 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1802 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1803 "child dataset with inherited mountpoint is used "
1804 "in a non-global zone"));
1805 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1809 if ((ret = changelist_prefix(cl)) != 0)
1812 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1813 return (zfs_standard_error(hdl, errno, errbuf));
1816 if ((ret = changelist_postfix(cl)) != 0)
1820 * Refresh the statistics so the new property is reflected.
1822 (void) get_stats(zhp);
1826 changelist_free(cl);
1831 * True DSL properties are stored in an nvlist. The following two functions
1832 * extract them appropriately.
1835 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1841 if (nvlist_lookup_nvlist(zhp->zfs_props,
1842 zfs_prop_to_name(prop), &nv) == 0) {
1843 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1844 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1846 verify(!zhp->zfs_props_table ||
1847 zhp->zfs_props_table[prop] == B_TRUE);
1848 value = zfs_prop_default_numeric(prop);
1856 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1862 if (nvlist_lookup_nvlist(zhp->zfs_props,
1863 zfs_prop_to_name(prop), &nv) == 0) {
1864 value = fnvlist_lookup_string(nv, ZPROP_VALUE);
1865 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1867 verify(!zhp->zfs_props_table ||
1868 zhp->zfs_props_table[prop] == B_TRUE);
1869 value = zfs_prop_default_string(prop);
1877 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
1879 return (zhp->zfs_props == zhp->zfs_recvd_props);
1883 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1885 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
1886 zhp->zfs_props = zhp->zfs_recvd_props;
1890 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1892 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
1897 * Internal function for getting a numeric property. Both zfs_prop_get() and
1898 * zfs_prop_get_int() are built using this interface.
1900 * Certain properties can be overridden using 'mount -o'. In this case, scan
1901 * the contents of the /etc/mnttab entry, searching for the appropriate options.
1902 * If they differ from the on-disk values, report the current values and mark
1903 * the source "temporary".
1906 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
1907 char **source, uint64_t *val)
1909 zfs_cmd_t zc = { 0 };
1910 nvlist_t *zplprops = NULL;
1912 char *mntopt_on = NULL;
1913 char *mntopt_off = NULL;
1914 boolean_t received = zfs_is_recvd_props_mode(zhp);
1919 case ZFS_PROP_ATIME:
1920 mntopt_on = MNTOPT_ATIME;
1921 mntopt_off = MNTOPT_NOATIME;
1924 case ZFS_PROP_DEVICES:
1925 mntopt_on = MNTOPT_DEVICES;
1926 mntopt_off = MNTOPT_NODEVICES;
1930 mntopt_on = MNTOPT_EXEC;
1931 mntopt_off = MNTOPT_NOEXEC;
1934 case ZFS_PROP_READONLY:
1935 mntopt_on = MNTOPT_RO;
1936 mntopt_off = MNTOPT_RW;
1939 case ZFS_PROP_SETUID:
1940 mntopt_on = MNTOPT_SETUID;
1941 mntopt_off = MNTOPT_NOSETUID;
1944 case ZFS_PROP_XATTR:
1945 mntopt_on = MNTOPT_XATTR;
1946 mntopt_off = MNTOPT_NOXATTR;
1949 case ZFS_PROP_NBMAND:
1950 mntopt_on = MNTOPT_NBMAND;
1951 mntopt_off = MNTOPT_NONBMAND;
1956 * Because looking up the mount options is potentially expensive
1957 * (iterating over all of /etc/mnttab), we defer its calculation until
1958 * we're looking up a property which requires its presence.
1960 if (!zhp->zfs_mntcheck &&
1961 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
1962 libzfs_handle_t *hdl = zhp->zfs_hdl;
1963 struct mnttab entry;
1965 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
1966 zhp->zfs_mntopts = zfs_strdup(hdl,
1968 if (zhp->zfs_mntopts == NULL)
1972 zhp->zfs_mntcheck = B_TRUE;
1975 if (zhp->zfs_mntopts == NULL)
1976 mnt.mnt_mntopts = "";
1978 mnt.mnt_mntopts = zhp->zfs_mntopts;
1981 case ZFS_PROP_ATIME:
1982 case ZFS_PROP_DEVICES:
1984 case ZFS_PROP_READONLY:
1985 case ZFS_PROP_SETUID:
1986 case ZFS_PROP_XATTR:
1987 case ZFS_PROP_NBMAND:
1988 *val = getprop_uint64(zhp, prop, source);
1993 if (hasmntopt(&mnt, mntopt_on) && !*val) {
1996 *src = ZPROP_SRC_TEMPORARY;
1997 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
2000 *src = ZPROP_SRC_TEMPORARY;
2004 case ZFS_PROP_CANMOUNT:
2005 case ZFS_PROP_VOLSIZE:
2006 case ZFS_PROP_QUOTA:
2007 case ZFS_PROP_REFQUOTA:
2008 case ZFS_PROP_RESERVATION:
2009 case ZFS_PROP_REFRESERVATION:
2010 case ZFS_PROP_FILESYSTEM_LIMIT:
2011 case ZFS_PROP_SNAPSHOT_LIMIT:
2012 case ZFS_PROP_FILESYSTEM_COUNT:
2013 case ZFS_PROP_SNAPSHOT_COUNT:
2014 *val = getprop_uint64(zhp, prop, source);
2016 if (*source == NULL) {
2017 /* not default, must be local */
2018 *source = zhp->zfs_name;
2022 case ZFS_PROP_MOUNTED:
2023 *val = (zhp->zfs_mntopts != NULL);
2026 case ZFS_PROP_NUMCLONES:
2027 *val = zhp->zfs_dmustats.dds_num_clones;
2030 case ZFS_PROP_VERSION:
2031 case ZFS_PROP_NORMALIZE:
2032 case ZFS_PROP_UTF8ONLY:
2034 if (!zfs_prop_valid_for_type(prop, zhp->zfs_head_type) ||
2035 zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2037 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2038 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
2039 zcmd_free_nvlists(&zc);
2042 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
2043 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
2045 zcmd_free_nvlists(&zc);
2049 nvlist_free(zplprops);
2050 zcmd_free_nvlists(&zc);
2053 case ZFS_PROP_INCONSISTENT:
2054 *val = zhp->zfs_dmustats.dds_inconsistent;
2058 switch (zfs_prop_get_type(prop)) {
2059 case PROP_TYPE_NUMBER:
2060 case PROP_TYPE_INDEX:
2061 *val = getprop_uint64(zhp, prop, source);
2063 * If we tried to use a default value for a
2064 * readonly property, it means that it was not
2067 if (zfs_prop_readonly(prop) &&
2068 *source != NULL && (*source)[0] == '\0') {
2073 case PROP_TYPE_STRING:
2075 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
2076 "cannot get non-numeric property"));
2077 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
2078 dgettext(TEXT_DOMAIN, "internal error")));
2086 * Calculate the source type, given the raw source string.
2089 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
2090 char *statbuf, size_t statlen)
2092 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
2095 if (source == NULL) {
2096 *srctype = ZPROP_SRC_NONE;
2097 } else if (source[0] == '\0') {
2098 *srctype = ZPROP_SRC_DEFAULT;
2099 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
2100 *srctype = ZPROP_SRC_RECEIVED;
2102 if (strcmp(source, zhp->zfs_name) == 0) {
2103 *srctype = ZPROP_SRC_LOCAL;
2105 (void) strlcpy(statbuf, source, statlen);
2106 *srctype = ZPROP_SRC_INHERITED;
2113 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
2114 size_t proplen, boolean_t literal)
2119 if (zhp->zfs_recvd_props == NULL)
2120 if (get_recvd_props_ioctl(zhp) != 0)
2123 prop = zfs_name_to_prop(propname);
2125 if (prop != ZPROP_INVAL) {
2127 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
2129 zfs_set_recvd_props_mode(zhp, &cookie);
2130 err = zfs_prop_get(zhp, prop, propbuf, proplen,
2131 NULL, NULL, 0, literal);
2132 zfs_unset_recvd_props_mode(zhp, &cookie);
2136 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
2137 propname, &propval) != 0)
2139 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
2141 (void) strlcpy(propbuf, recvdval, proplen);
2144 return (err == 0 ? 0 : -1);
2148 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2153 value = zfs_get_clones_nvl(zhp);
2158 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
2159 pair = nvlist_next_nvpair(value, pair)) {
2160 if (propbuf[0] != '\0')
2161 (void) strlcat(propbuf, ",", proplen);
2162 (void) strlcat(propbuf, nvpair_name(pair), proplen);
2168 struct get_clones_arg {
2172 char buf[ZFS_MAXNAMELEN];
2176 get_clones_cb(zfs_handle_t *zhp, void *arg)
2178 struct get_clones_arg *gca = arg;
2180 if (gca->numclones == 0) {
2185 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
2186 NULL, NULL, 0, B_TRUE) != 0)
2188 if (strcmp(gca->buf, gca->origin) == 0) {
2189 fnvlist_add_boolean(gca->value, zfs_get_name(zhp));
2194 (void) zfs_iter_children(zhp, get_clones_cb, gca);
2200 zfs_get_clones_nvl(zfs_handle_t *zhp)
2202 nvlist_t *nv, *value;
2204 if (nvlist_lookup_nvlist(zhp->zfs_props,
2205 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
2206 struct get_clones_arg gca;
2209 * if this is a snapshot, then the kernel wasn't able
2210 * to get the clones. Do it by slowly iterating.
2212 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2214 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2216 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2221 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2223 gca.origin = zhp->zfs_name;
2225 if (gca.numclones != 0) {
2227 char pool[ZFS_MAXNAMELEN];
2230 /* get the pool name */
2231 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2232 (void) strsep(&cp, "/@");
2233 root = zfs_open(zhp->zfs_hdl, pool,
2234 ZFS_TYPE_FILESYSTEM);
2236 (void) get_clones_cb(root, &gca);
2239 if (gca.numclones != 0 ||
2240 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2241 nvlist_add_nvlist(zhp->zfs_props,
2242 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2249 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2250 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2253 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2259 * Retrieve a property from the given object. If 'literal' is specified, then
2260 * numbers are left as exact values. Otherwise, numbers are converted to a
2261 * human-readable form.
2263 * Returns 0 on success, or -1 on error.
2266 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2267 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2269 char *source = NULL;
2273 boolean_t received = zfs_is_recvd_props_mode(zhp);
2276 * Check to see if this property applies to our object
2278 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
2281 if (received && zfs_prop_readonly(prop))
2285 *src = ZPROP_SRC_NONE;
2288 case ZFS_PROP_CREATION:
2290 * 'creation' is a time_t stored in the statistics. We convert
2291 * this into a string unless 'literal' is specified.
2294 val = getprop_uint64(zhp, prop, &source);
2295 time_t time = (time_t)val;
2299 localtime_r(&time, &t) == NULL ||
2300 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2302 (void) snprintf(propbuf, proplen, "%llu", val);
2306 case ZFS_PROP_MOUNTPOINT:
2308 * Getting the precise mountpoint can be tricky.
2310 * - for 'none' or 'legacy', return those values.
2311 * - for inherited mountpoints, we want to take everything
2312 * after our ancestor and append it to the inherited value.
2314 * If the pool has an alternate root, we want to prepend that
2315 * root to any values we return.
2318 str = getprop_string(zhp, prop, &source);
2320 if (str[0] == '/') {
2321 char buf[MAXPATHLEN];
2323 const char *relpath;
2326 * If we inherit the mountpoint, even from a dataset
2327 * with a received value, the source will be the path of
2328 * the dataset we inherit from. If source is
2329 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2332 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2335 relpath = zhp->zfs_name + strlen(source);
2336 if (relpath[0] == '/')
2340 if ((zpool_get_prop(zhp->zpool_hdl,
2341 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2342 B_FALSE)) || (strcmp(root, "-") == 0))
2345 * Special case an alternate root of '/'. This will
2346 * avoid having multiple leading slashes in the
2349 if (strcmp(root, "/") == 0)
2353 * If the mountpoint is '/' then skip over this
2354 * if we are obtaining either an alternate root or
2355 * an inherited mountpoint.
2357 if (str[1] == '\0' && (root[0] != '\0' ||
2358 relpath[0] != '\0'))
2361 if (relpath[0] == '\0')
2362 (void) snprintf(propbuf, proplen, "%s%s",
2365 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2366 root, str, relpath[0] == '@' ? "" : "/",
2369 /* 'legacy' or 'none' */
2370 (void) strlcpy(propbuf, str, proplen);
2375 case ZFS_PROP_ORIGIN:
2376 str = getprop_string(zhp, prop, &source);
2379 (void) strlcpy(propbuf, str, proplen);
2382 case ZFS_PROP_CLONES:
2383 if (get_clones_string(zhp, propbuf, proplen) != 0)
2387 case ZFS_PROP_QUOTA:
2388 case ZFS_PROP_REFQUOTA:
2389 case ZFS_PROP_RESERVATION:
2390 case ZFS_PROP_REFRESERVATION:
2392 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2396 * If quota or reservation is 0, we translate this into 'none'
2397 * (unless literal is set), and indicate that it's the default
2398 * value. Otherwise, we print the number nicely and indicate
2399 * that its set locally.
2403 (void) strlcpy(propbuf, "0", proplen);
2405 (void) strlcpy(propbuf, "none", proplen);
2408 (void) snprintf(propbuf, proplen, "%llu",
2411 zfs_nicenum(val, propbuf, proplen);
2415 case ZFS_PROP_FILESYSTEM_LIMIT:
2416 case ZFS_PROP_SNAPSHOT_LIMIT:
2417 case ZFS_PROP_FILESYSTEM_COUNT:
2418 case ZFS_PROP_SNAPSHOT_COUNT:
2420 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2424 * If limit is UINT64_MAX, we translate this into 'none' (unless
2425 * literal is set), and indicate that it's the default value.
2426 * Otherwise, we print the number nicely and indicate that it's
2430 (void) snprintf(propbuf, proplen, "%llu",
2432 } else if (val == UINT64_MAX) {
2433 (void) strlcpy(propbuf, "none", proplen);
2435 zfs_nicenum(val, propbuf, proplen);
2439 case ZFS_PROP_REFRATIO:
2440 case ZFS_PROP_COMPRESSRATIO:
2441 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2443 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2444 (u_longlong_t)(val / 100),
2445 (u_longlong_t)(val % 100));
2449 switch (zhp->zfs_type) {
2450 case ZFS_TYPE_FILESYSTEM:
2453 case ZFS_TYPE_VOLUME:
2456 case ZFS_TYPE_SNAPSHOT:
2459 case ZFS_TYPE_BOOKMARK:
2465 (void) snprintf(propbuf, proplen, "%s", str);
2468 case ZFS_PROP_MOUNTED:
2470 * The 'mounted' property is a pseudo-property that described
2471 * whether the filesystem is currently mounted. Even though
2472 * it's a boolean value, the typical values of "on" and "off"
2473 * don't make sense, so we translate to "yes" and "no".
2475 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2476 src, &source, &val) != 0)
2479 (void) strlcpy(propbuf, "yes", proplen);
2481 (void) strlcpy(propbuf, "no", proplen);
2486 * The 'name' property is a pseudo-property derived from the
2487 * dataset name. It is presented as a real property to simplify
2490 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2493 case ZFS_PROP_MLSLABEL:
2496 m_label_t *new_sl = NULL;
2497 char *ascii = NULL; /* human readable label */
2499 (void) strlcpy(propbuf,
2500 getprop_string(zhp, prop, &source), proplen);
2502 if (literal || (strcasecmp(propbuf,
2503 ZFS_MLSLABEL_DEFAULT) == 0))
2507 * Try to translate the internal hex string to
2508 * human-readable output. If there are any
2509 * problems just use the hex string.
2512 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2513 L_NO_CORRECTION, NULL) == -1) {
2514 m_label_free(new_sl);
2518 if (label_to_str(new_sl, &ascii, M_LABEL,
2522 m_label_free(new_sl);
2525 m_label_free(new_sl);
2527 (void) strlcpy(propbuf, ascii, proplen);
2537 * GUIDs are stored as numbers, but they are identifiers.
2538 * We don't want them to be pretty printed, because pretty
2539 * printing mangles the ID into a truncated and useless value.
2541 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2543 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2547 switch (zfs_prop_get_type(prop)) {
2548 case PROP_TYPE_NUMBER:
2549 if (get_numeric_property(zhp, prop, src,
2550 &source, &val) != 0)
2553 (void) snprintf(propbuf, proplen, "%llu",
2556 zfs_nicenum(val, propbuf, proplen);
2559 case PROP_TYPE_STRING:
2560 str = getprop_string(zhp, prop, &source);
2563 (void) strlcpy(propbuf, str, proplen);
2566 case PROP_TYPE_INDEX:
2567 if (get_numeric_property(zhp, prop, src,
2568 &source, &val) != 0)
2570 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2572 (void) strlcpy(propbuf, strval, proplen);
2580 get_source(zhp, src, source, statbuf, statlen);
2586 * Utility function to get the given numeric property. Does no validation that
2587 * the given property is the appropriate type; should only be used with
2588 * hard-coded property types.
2591 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2596 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2602 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2606 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2607 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2611 * Similar to zfs_prop_get(), but returns the value as an integer.
2614 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2615 zprop_source_t *src, char *statbuf, size_t statlen)
2620 * Check to see if this property applies to our object
2622 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) {
2623 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2624 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2625 zfs_prop_to_name(prop)));
2629 *src = ZPROP_SRC_NONE;
2631 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2634 get_source(zhp, src, source, statbuf, statlen);
2640 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2641 char **domainp, idmap_rid_t *ridp)
2644 idmap_get_handle_t *get_hdl = NULL;
2648 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2652 err = idmap_get_sidbyuid(get_hdl, id,
2653 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2655 err = idmap_get_sidbygid(get_hdl, id,
2656 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2658 if (err == IDMAP_SUCCESS &&
2659 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2660 status == IDMAP_SUCCESS)
2666 idmap_get_destroy(get_hdl);
2669 assert(!"invalid code path");
2670 return (EINVAL); // silence compiler warning
2675 * convert the propname into parameters needed by kernel
2676 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2677 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2680 userquota_propname_decode(const char *propname, boolean_t zoned,
2681 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2683 zfs_userquota_prop_t type;
2685 char *numericsid = NULL;
2690 /* Figure out the property type ({user|group}{quota|space}) */
2691 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2692 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2693 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2696 if (type == ZFS_NUM_USERQUOTA_PROPS)
2700 isuser = (type == ZFS_PROP_USERQUOTA ||
2701 type == ZFS_PROP_USERUSED);
2703 cp = strchr(propname, '@') + 1;
2705 if (strchr(cp, '@')) {
2708 * It's a SID name (eg "user@domain") that needs to be
2709 * turned into S-1-domainID-RID.
2712 idmap_stat stat, map_stat;
2715 idmap_get_handle_t *gh = NULL;
2717 stat = idmap_get_create(&gh);
2718 if (stat != IDMAP_SUCCESS) {
2719 idmap_get_destroy(gh);
2722 if (zoned && getzoneid() == GLOBAL_ZONEID)
2725 stat = idmap_getuidbywinname(cp, NULL, flag, &pid);
2728 stat = idmap_get_sidbyuid(gh, pid, flag, &numericsid,
2731 stat = idmap_getgidbywinname(cp, NULL, flag, &pid);
2734 stat = idmap_get_sidbygid(gh, pid, flag, &numericsid,
2738 idmap_get_destroy(gh);
2741 stat = idmap_get_mappings(gh);
2742 idmap_get_destroy(gh);
2747 if (numericsid == NULL)
2751 /* will be further decoded below */
2757 if (strncmp(cp, "S-1-", 4) == 0) {
2758 /* It's a numeric SID (eg "S-1-234-567-89") */
2759 (void) strlcpy(domain, cp, domainlen);
2762 cp = strrchr(domain, '-');
2765 *ridp = strtoull(cp, &end, 10);
2773 if (errno != 0 || *end != '\0')
2775 } else if (!isdigit(*cp)) {
2777 * It's a user/group name (eg "user") that needs to be
2778 * turned into a uid/gid
2780 if (zoned && getzoneid() == GLOBAL_ZONEID)
2796 /* It's a user/group ID (eg "12345"). */
2797 uid_t id = strtoul(cp, &end, 10);
2804 /* It's an ephemeral ID. */
2805 if (idmap_id_to_numeric_domain_rid(id, isuser,
2806 &mapdomain, &rid) != 0)
2808 (void) strlcpy(domain, mapdomain, domainlen);
2815 ASSERT3P(numericsid, ==, NULL);
2820 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2821 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2824 zfs_cmd_t zc = { 0 };
2826 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2828 err = userquota_propname_decode(propname,
2829 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2830 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2831 zc.zc_objset_type = *typep;
2835 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2839 *propvalue = zc.zc_cookie;
2844 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2845 uint64_t *propvalue)
2847 zfs_userquota_prop_t type;
2849 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
2854 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
2855 char *propbuf, int proplen, boolean_t literal)
2859 zfs_userquota_prop_t type;
2861 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
2868 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2869 } else if (propvalue == 0 &&
2870 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
2871 (void) strlcpy(propbuf, "none", proplen);
2873 zfs_nicenum(propvalue, propbuf, proplen);
2879 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
2880 uint64_t *propvalue)
2883 zfs_cmd_t zc = { 0 };
2884 const char *snapname;
2886 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2888 snapname = strchr(propname, '@') + 1;
2889 if (strchr(snapname, '@')) {
2890 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
2892 /* snapname is the short name, append it to zhp's fsname */
2895 (void) strlcpy(zc.zc_value, zhp->zfs_name,
2896 sizeof (zc.zc_value));
2897 cp = strchr(zc.zc_value, '@');
2900 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
2901 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
2904 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
2908 *propvalue = zc.zc_cookie;
2913 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
2914 char *propbuf, int proplen, boolean_t literal)
2919 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
2925 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2927 zfs_nicenum(propvalue, propbuf, proplen);
2933 * Returns the name of the given zfs handle.
2936 zfs_get_name(const zfs_handle_t *zhp)
2938 return (zhp->zfs_name);
2942 * Returns the type of the given zfs handle.
2945 zfs_get_type(const zfs_handle_t *zhp)
2947 return (zhp->zfs_type);
2951 * Is one dataset name a child dataset of another?
2953 * Needs to handle these cases:
2954 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2955 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2956 * Descendant? No. No. No. Yes.
2959 is_descendant(const char *ds1, const char *ds2)
2961 size_t d1len = strlen(ds1);
2963 /* ds2 can't be a descendant if it's smaller */
2964 if (strlen(ds2) < d1len)
2967 /* otherwise, compare strings and verify that there's a '/' char */
2968 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
2972 * Given a complete name, return just the portion that refers to the parent.
2973 * Will return -1 if there is no parent (path is just the name of the
2977 parent_name(const char *path, char *buf, size_t buflen)
2981 (void) strlcpy(buf, path, buflen);
2983 if ((slashp = strrchr(buf, '/')) == NULL)
2991 * If accept_ancestor is false, then check to make sure that the given path has
2992 * a parent, and that it exists. If accept_ancestor is true, then find the
2993 * closest existing ancestor for the given path. In prefixlen return the
2994 * length of already existing prefix of the given path. We also fetch the
2995 * 'zoned' property, which is used to validate property settings when creating
2999 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
3000 boolean_t accept_ancestor, int *prefixlen)
3002 zfs_cmd_t zc = { 0 };
3003 char parent[ZFS_MAXNAMELEN];
3009 (void) snprintf(errbuf, sizeof (errbuf),
3010 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
3012 /* get parent, and check to see if this is just a pool */
3013 if (parent_name(path, parent, sizeof (parent)) != 0) {
3014 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3015 "missing dataset name"));
3016 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3019 /* check to see if the pool exists */
3020 if ((slash = strchr(parent, '/')) == NULL)
3021 slash = parent + strlen(parent);
3022 (void) strncpy(zc.zc_name, parent, slash - parent);
3023 zc.zc_name[slash - parent] = '\0';
3024 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
3026 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3027 "no such pool '%s'"), zc.zc_name);
3028 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3031 /* check to see if the parent dataset exists */
3032 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
3033 if (errno == ENOENT && accept_ancestor) {
3035 * Go deeper to find an ancestor, give up on top level.
3037 if (parent_name(parent, parent, sizeof (parent)) != 0) {
3038 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3039 "no such pool '%s'"), zc.zc_name);
3040 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3042 } else if (errno == ENOENT) {
3043 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3044 "parent does not exist"));
3045 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3047 return (zfs_standard_error(hdl, errno, errbuf));
3050 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
3054 /* we are in a non-global zone, but parent is in the global zone */
3055 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
3056 (void) zfs_standard_error(hdl, EPERM, errbuf);
3061 /* make sure parent is a filesystem */
3062 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
3063 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3064 "parent is not a filesystem"));
3065 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
3071 if (prefixlen != NULL)
3072 *prefixlen = strlen(parent);
3077 * Finds whether the dataset of the given type(s) exists.
3080 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
3084 if (!zfs_validate_name(hdl, path, types, B_FALSE))
3088 * Try to get stats for the dataset, which will tell us if it exists.
3090 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
3091 int ds_type = zhp->zfs_type;
3094 if (types & ds_type)
3101 * Given a path to 'target', create all the ancestors between
3102 * the prefixlen portion of the path, and the target itself.
3103 * Fail if the initial prefixlen-ancestor does not already exist.
3106 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
3112 /* make sure prefix exists */
3113 cp = target + prefixlen;
3115 assert(strchr(cp, '/') == NULL);
3116 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3119 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3127 * Attempt to create, mount, and share any ancestor filesystems,
3128 * up to the prefixlen-long one.
3130 for (cp = target + prefixlen + 1;
3131 cp = strchr(cp, '/'); *cp = '/', cp++) {
3135 h = make_dataset_handle(hdl, target);
3137 /* it already exists, nothing to do here */
3142 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
3144 opname = dgettext(TEXT_DOMAIN, "create");
3148 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3150 opname = dgettext(TEXT_DOMAIN, "open");
3154 if (zfs_mount(h, NULL, 0) != 0) {
3155 opname = dgettext(TEXT_DOMAIN, "mount");
3159 if (zfs_share(h) != 0) {
3160 opname = dgettext(TEXT_DOMAIN, "share");
3170 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3171 "failed to %s ancestor '%s'"), opname, target);
3176 * Creates non-existing ancestors of the given path.
3179 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
3185 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
3188 if ((path_copy = strdup(path)) != NULL) {
3189 rc = create_parents(hdl, path_copy, prefix);
3192 if (path_copy == NULL || rc != 0)
3199 * Create a new filesystem or volume.
3202 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
3207 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
3210 dmu_objset_type_t ost;
3212 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3213 "cannot create '%s'"), path);
3215 /* validate the path, taking care to note the extended error message */
3216 if (!zfs_validate_name(hdl, path, type, B_TRUE))
3217 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3219 /* validate parents exist */
3220 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
3224 * The failure modes when creating a dataset of a different type over
3225 * one that already exists is a little strange. In particular, if you
3226 * try to create a dataset on top of an existing dataset, the ioctl()
3227 * will return ENOENT, not EEXIST. To prevent this from happening, we
3228 * first try to see if the dataset exists.
3230 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
3231 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3232 "dataset already exists"));
3233 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3236 if (type == ZFS_TYPE_VOLUME)
3241 if (props && (props = zfs_valid_proplist(hdl, type, props,
3242 zoned, NULL, errbuf)) == 0)
3245 if (type == ZFS_TYPE_VOLUME) {
3247 * If we are creating a volume, the size and block size must
3248 * satisfy a few restraints. First, the blocksize must be a
3249 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3250 * volsize must be a multiple of the block size, and cannot be
3253 if (props == NULL || nvlist_lookup_uint64(props,
3254 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3256 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3257 "missing volume size"));
3258 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3261 if ((ret = nvlist_lookup_uint64(props,
3262 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3263 &blocksize)) != 0) {
3264 if (ret == ENOENT) {
3265 blocksize = zfs_prop_default_numeric(
3266 ZFS_PROP_VOLBLOCKSIZE);
3269 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3270 "missing volume block size"));
3271 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3277 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3278 "volume size cannot be zero"));
3279 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3282 if (size % blocksize != 0) {
3284 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3285 "volume size must be a multiple of volume block "
3287 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3291 /* create the dataset */
3292 ret = lzc_create(path, ost, props);
3295 /* check for failure */
3297 char parent[ZFS_MAXNAMELEN];
3298 (void) parent_name(path, parent, sizeof (parent));
3302 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3303 "no such parent '%s'"), parent);
3304 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3307 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3308 "parent '%s' is not a filesystem"), parent);
3309 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3312 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3313 "volume block size must be power of 2 from "
3316 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3319 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3320 "pool must be upgraded to set this "
3321 "property or value"));
3322 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3326 * This platform can't address a volume this big.
3328 if (type == ZFS_TYPE_VOLUME)
3329 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3334 return (zfs_standard_error(hdl, errno, errbuf));
3342 * Destroys the given dataset. The caller must make sure that the filesystem
3343 * isn't mounted, and that there are no active dependents. If the file system
3344 * does not exist this function does nothing.
3347 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3349 zfs_cmd_t zc = { 0 };
3351 if (zhp->zfs_type == ZFS_TYPE_BOOKMARK) {
3352 nvlist_t *nv = fnvlist_alloc();
3353 fnvlist_add_boolean(nv, zhp->zfs_name);
3354 int error = lzc_destroy_bookmarks(nv, NULL);
3357 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3358 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3364 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3366 if (ZFS_IS_VOLUME(zhp)) {
3367 zc.zc_objset_type = DMU_OST_ZVOL;
3369 zc.zc_objset_type = DMU_OST_ZFS;
3372 zc.zc_defer_destroy = defer;
3373 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0 &&
3375 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3376 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3380 remove_mountpoint(zhp);
3385 struct destroydata {
3387 const char *snapname;
3391 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3393 struct destroydata *dd = arg;
3394 char name[ZFS_MAXNAMELEN];
3397 (void) snprintf(name, sizeof (name),
3398 "%s@%s", zhp->zfs_name, dd->snapname);
3400 if (lzc_exists(name))
3401 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3403 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3409 * Destroys all snapshots with the given name in zhp & descendants.
3412 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3415 struct destroydata dd = { 0 };
3417 dd.snapname = snapname;
3418 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3419 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3421 if (nvlist_empty(dd.nvl)) {
3422 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3423 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3424 zhp->zfs_name, snapname);
3426 ret = zfs_destroy_snaps_nvl(zhp->zfs_hdl, dd.nvl, defer);
3428 nvlist_free(dd.nvl);
3433 * Destroys all the snapshots named in the nvlist.
3436 zfs_destroy_snaps_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, boolean_t defer)
3441 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3446 if (nvlist_empty(errlist)) {
3448 (void) snprintf(errbuf, sizeof (errbuf),
3449 dgettext(TEXT_DOMAIN, "cannot destroy snapshots"));
3451 ret = zfs_standard_error(hdl, ret, errbuf);
3453 for (nvpair_t *pair = nvlist_next_nvpair(errlist, NULL);
3454 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3456 (void) snprintf(errbuf, sizeof (errbuf),
3457 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3460 switch (fnvpair_value_int32(pair)) {
3463 dgettext(TEXT_DOMAIN, "snapshot is cloned"));
3464 ret = zfs_error(hdl, EZFS_EXISTS, errbuf);
3467 ret = zfs_standard_error(hdl, errno, errbuf);
3476 * Clones the given dataset. The target must be of the same type as the source.
3479 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3481 char parent[ZFS_MAXNAMELEN];
3484 libzfs_handle_t *hdl = zhp->zfs_hdl;
3487 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3489 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3490 "cannot create '%s'"), target);
3492 /* validate the target/clone name */
3493 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3494 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3496 /* validate parents exist */
3497 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3500 (void) parent_name(target, parent, sizeof (parent));
3506 if (ZFS_IS_VOLUME(zhp)) {
3507 type = ZFS_TYPE_VOLUME;
3509 type = ZFS_TYPE_FILESYSTEM;
3511 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3512 zhp, errbuf)) == NULL)
3516 ret = lzc_clone(target, zhp->zfs_name, props);
3524 * The parent doesn't exist. We should have caught this
3525 * above, but there may a race condition that has since
3526 * destroyed the parent.
3528 * At this point, we don't know whether it's the source
3529 * that doesn't exist anymore, or whether the target
3530 * dataset doesn't exist.
3532 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3533 "no such parent '%s'"), parent);
3534 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3537 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3538 "source and target pools differ"));
3539 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3543 return (zfs_standard_error(zhp->zfs_hdl, errno,
3552 * Promotes the given clone fs to be the clone parent.
3555 zfs_promote(zfs_handle_t *zhp)
3557 libzfs_handle_t *hdl = zhp->zfs_hdl;
3558 zfs_cmd_t zc = { 0 };
3559 char parent[MAXPATHLEN];
3563 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3564 "cannot promote '%s'"), zhp->zfs_name);
3566 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3567 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3568 "snapshots can not be promoted"));
3569 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3572 (void) strlcpy(parent, zhp->zfs_dmustats.dds_origin, sizeof (parent));
3573 if (parent[0] == '\0') {
3574 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3575 "not a cloned filesystem"));
3576 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3579 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_origin,
3580 sizeof (zc.zc_value));
3581 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3582 ret = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc);
3585 int save_errno = errno;
3587 switch (save_errno) {
3589 /* There is a conflicting snapshot name. */
3590 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3591 "conflicting snapshot '%s' from parent '%s'"),
3592 zc.zc_string, parent);
3593 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3596 return (zfs_standard_error(hdl, save_errno, errbuf));
3602 typedef struct snapdata {
3604 const char *sd_snapname;
3608 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
3610 snapdata_t *sd = arg;
3611 char name[ZFS_MAXNAMELEN];
3614 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) == 0) {
3615 (void) snprintf(name, sizeof (name),
3616 "%s@%s", zfs_get_name(zhp), sd->sd_snapname);
3618 fnvlist_add_boolean(sd->sd_nvl, name);
3620 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
3628 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3632 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
3639 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3640 "cannot create snapshots "));
3643 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
3644 const char *snapname = nvpair_name(elem);
3646 /* validate the target name */
3647 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
3649 (void) snprintf(errbuf, sizeof (errbuf),
3650 dgettext(TEXT_DOMAIN,
3651 "cannot create snapshot '%s'"), snapname);
3652 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3656 if (props != NULL &&
3657 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3658 props, B_FALSE, NULL, errbuf)) == NULL) {
3662 ret = lzc_snapshot(snaps, props, &errors);
3665 boolean_t printed = B_FALSE;
3666 for (elem = nvlist_next_nvpair(errors, NULL);
3668 elem = nvlist_next_nvpair(errors, elem)) {
3669 (void) snprintf(errbuf, sizeof (errbuf),
3670 dgettext(TEXT_DOMAIN,
3671 "cannot create snapshot '%s'"), nvpair_name(elem));
3672 (void) zfs_standard_error(hdl,
3673 fnvpair_value_int32(elem), errbuf);
3679 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3680 "multiple snapshots of same "
3682 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3686 (void) zfs_standard_error(hdl, ret, errbuf);
3692 nvlist_free(errors);
3697 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3701 snapdata_t sd = { 0 };
3702 char fsname[ZFS_MAXNAMELEN];
3707 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3708 "cannot snapshot %s"), path);
3710 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3711 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3713 (void) strlcpy(fsname, path, sizeof (fsname));
3714 cp = strchr(fsname, '@');
3716 sd.sd_snapname = cp + 1;
3718 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
3719 ZFS_TYPE_VOLUME)) == NULL) {
3723 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
3725 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
3727 fnvlist_add_boolean(sd.sd_nvl, path);
3730 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
3731 nvlist_free(sd.sd_nvl);
3737 * Destroy any more recent snapshots. We invoke this callback on any dependents
3738 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3739 * is a dependent and we should just destroy it without checking the transaction
3742 typedef struct rollback_data {
3743 const char *cb_target; /* the snapshot */
3744 uint64_t cb_create; /* creation time reference */
3750 rollback_destroy_dependent(zfs_handle_t *zhp, void *data)
3752 rollback_data_t *cbp = data;
3753 prop_changelist_t *clp;
3755 /* We must destroy this clone; first unmount it */
3756 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3757 cbp->cb_force ? MS_FORCE: 0);
3758 if (clp == NULL || changelist_prefix(clp) != 0) {
3759 cbp->cb_error = B_TRUE;
3763 if (zfs_destroy(zhp, B_FALSE) != 0)
3764 cbp->cb_error = B_TRUE;
3766 changelist_remove(clp, zhp->zfs_name);
3767 (void) changelist_postfix(clp);
3768 changelist_free(clp);
3775 rollback_destroy(zfs_handle_t *zhp, void *data)
3777 rollback_data_t *cbp = data;
3779 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > cbp->cb_create) {
3780 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3781 rollback_destroy_dependent, cbp);
3783 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3791 * Given a dataset, rollback to a specific snapshot, discarding any
3792 * data changes since then and making it the active dataset.
3794 * Any snapshots and bookmarks more recent than the target are
3795 * destroyed, along with their dependents (i.e. clones).
3798 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3800 rollback_data_t cb = { 0 };
3802 boolean_t restore_resv = 0;
3803 uint64_t old_volsize, new_volsize;
3804 zfs_prop_t resv_prop;
3806 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3807 zhp->zfs_type == ZFS_TYPE_VOLUME);
3810 * Destroy all recent snapshots and their dependents.
3812 cb.cb_force = force;
3813 cb.cb_target = snap->zfs_name;
3814 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3815 (void) zfs_iter_snapshots(zhp, B_FALSE, rollback_destroy, &cb);
3816 (void) zfs_iter_bookmarks(zhp, rollback_destroy, &cb);
3822 * Now that we have verified that the snapshot is the latest,
3823 * rollback to the given snapshot.
3826 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
3827 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
3829 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3831 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
3835 * We rely on zfs_iter_children() to verify that there are no
3836 * newer snapshots for the given dataset. Therefore, we can
3837 * simply pass the name on to the ioctl() call. There is still
3838 * an unlikely race condition where the user has taken a
3839 * snapshot since we verified that this was the most recent.
3841 err = lzc_rollback(zhp->zfs_name, NULL, 0);
3843 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3844 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
3850 * For volumes, if the pre-rollback volsize matched the pre-
3851 * rollback reservation and the volsize has changed then set
3852 * the reservation property to the post-rollback volsize.
3853 * Make a new handle since the rollback closed the dataset.
3855 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
3856 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
3858 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3859 if (old_volsize != new_volsize)
3860 err = zfs_prop_set_int(zhp, resv_prop,
3869 * Renames the given dataset.
3872 zfs_rename(zfs_handle_t *zhp, const char *source, const char *target,
3873 renameflags_t flags)
3876 zfs_cmd_t zc = { 0 };
3878 prop_changelist_t *cl = NULL;
3879 zfs_handle_t *zhrp = NULL;
3880 char *parentname = NULL;
3881 char parent[ZFS_MAXNAMELEN];
3882 char property[ZFS_MAXPROPLEN];
3883 libzfs_handle_t *hdl = zhp->zfs_hdl;
3886 /* if we have the same exact name, just return success */
3887 if (strcmp(zhp->zfs_name, target) == 0)
3890 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3891 "cannot rename to '%s'"), target);
3893 if (source != NULL) {
3895 * This is recursive snapshots rename, put snapshot name
3896 * (that might not exist) into zfs_name.
3898 assert(flags.recurse);
3900 (void) strlcat(zhp->zfs_name, "@", sizeof(zhp->zfs_name));
3901 (void) strlcat(zhp->zfs_name, source, sizeof(zhp->zfs_name));
3902 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
3906 * Make sure the target name is valid
3908 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3909 if ((strchr(target, '@') == NULL) ||
3912 * Snapshot target name is abbreviated,
3913 * reconstruct full dataset name
3915 (void) strlcpy(parent, zhp->zfs_name,
3917 delim = strchr(parent, '@');
3918 if (strchr(target, '@') == NULL)
3922 (void) strlcat(parent, target, sizeof (parent));
3926 * Make sure we're renaming within the same dataset.
3928 delim = strchr(target, '@');
3929 if (strncmp(zhp->zfs_name, target, delim - target)
3930 != 0 || zhp->zfs_name[delim - target] != '@') {
3931 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3932 "snapshots must be part of same "
3934 return (zfs_error(hdl, EZFS_CROSSTARGET,
3938 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3939 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3941 if (flags.recurse) {
3942 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3943 "recursive rename must be a snapshot"));
3944 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3947 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3948 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3950 /* validate parents */
3951 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
3954 /* make sure we're in the same pool */
3955 verify((delim = strchr(target, '/')) != NULL);
3956 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
3957 zhp->zfs_name[delim - target] != '/') {
3958 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3959 "datasets must be within same pool"));
3960 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
3963 /* new name cannot be a child of the current dataset name */
3964 if (is_descendant(zhp->zfs_name, target)) {
3965 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3966 "New dataset name cannot be a descendant of "
3967 "current dataset name"));
3968 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3972 (void) snprintf(errbuf, sizeof (errbuf),
3973 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
3975 if (getzoneid() == GLOBAL_ZONEID &&
3976 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
3977 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3978 "dataset is used in a non-global zone"));
3979 return (zfs_error(hdl, EZFS_ZONED, errbuf));
3983 * Avoid unmounting file systems with mountpoint property set to
3984 * 'legacy' or 'none' even if -u option is not given.
3986 if (zhp->zfs_type == ZFS_TYPE_FILESYSTEM &&
3987 !flags.recurse && !flags.nounmount &&
3988 zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, property,
3989 sizeof (property), NULL, NULL, 0, B_FALSE) == 0 &&
3990 (strcmp(property, "legacy") == 0 ||
3991 strcmp(property, "none") == 0)) {
3992 flags.nounmount = B_TRUE;
3994 if (flags.recurse) {
3996 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
3997 if (parentname == NULL) {
4001 delim = strchr(parentname, '@');
4003 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
4008 } else if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT) {
4009 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME,
4010 flags.nounmount ? CL_GATHER_DONT_UNMOUNT : 0,
4011 flags.forceunmount ? MS_FORCE : 0)) == NULL) {
4015 if (changelist_haszonedchild(cl)) {
4016 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4017 "child dataset with inherited mountpoint is used "
4018 "in a non-global zone"));
4019 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
4023 if ((ret = changelist_prefix(cl)) != 0)
4027 if (ZFS_IS_VOLUME(zhp))
4028 zc.zc_objset_type = DMU_OST_ZVOL;
4030 zc.zc_objset_type = DMU_OST_ZFS;
4032 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4033 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
4035 zc.zc_cookie = flags.recurse ? 1 : 0;
4036 if (flags.nounmount)
4039 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
4041 * if it was recursive, the one that actually failed will
4044 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4045 "cannot rename '%s'"), zc.zc_name);
4047 if (flags.recurse && errno == EEXIST) {
4048 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4049 "a child dataset already has a snapshot "
4050 "with the new name"));
4051 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
4053 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
4057 * On failure, we still want to remount any filesystems that
4058 * were previously mounted, so we don't alter the system state.
4061 (void) changelist_postfix(cl);
4064 changelist_rename(cl, zfs_get_name(zhp), target);
4065 ret = changelist_postfix(cl);
4070 if (parentname != NULL) {
4077 changelist_free(cl);
4083 zfs_get_user_props(zfs_handle_t *zhp)
4085 return (zhp->zfs_user_props);
4089 zfs_get_recvd_props(zfs_handle_t *zhp)
4091 if (zhp->zfs_recvd_props == NULL)
4092 if (get_recvd_props_ioctl(zhp) != 0)
4094 return (zhp->zfs_recvd_props);
4098 * This function is used by 'zfs list' to determine the exact set of columns to
4099 * display, and their maximum widths. This does two main things:
4101 * - If this is a list of all properties, then expand the list to include
4102 * all native properties, and set a flag so that for each dataset we look
4103 * for new unique user properties and add them to the list.
4105 * - For non fixed-width properties, keep track of the maximum width seen
4106 * so that we can size the column appropriately. If the user has
4107 * requested received property values, we also need to compute the width
4108 * of the RECEIVED column.
4111 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received,
4114 libzfs_handle_t *hdl = zhp->zfs_hdl;
4115 zprop_list_t *entry;
4116 zprop_list_t **last, **start;
4117 nvlist_t *userprops, *propval;
4120 char buf[ZFS_MAXPROPLEN];
4122 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
4125 userprops = zfs_get_user_props(zhp);
4128 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
4130 * Go through and add any user properties as necessary. We
4131 * start by incrementing our list pointer to the first
4132 * non-native property.
4135 while (*start != NULL) {
4136 if ((*start)->pl_prop == ZPROP_INVAL)
4138 start = &(*start)->pl_next;
4142 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
4144 * See if we've already found this property in our list.
4146 for (last = start; *last != NULL;
4147 last = &(*last)->pl_next) {
4148 if (strcmp((*last)->pl_user_prop,
4149 nvpair_name(elem)) == 0)
4153 if (*last == NULL) {
4154 if ((entry = zfs_alloc(hdl,
4155 sizeof (zprop_list_t))) == NULL ||
4156 ((entry->pl_user_prop = zfs_strdup(hdl,
4157 nvpair_name(elem)))) == NULL) {
4162 entry->pl_prop = ZPROP_INVAL;
4163 entry->pl_width = strlen(nvpair_name(elem));
4164 entry->pl_all = B_TRUE;
4171 * Now go through and check the width of any non-fixed columns
4173 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
4174 if (entry->pl_fixed && !literal)
4177 if (entry->pl_prop != ZPROP_INVAL) {
4178 if (zfs_prop_get(zhp, entry->pl_prop,
4179 buf, sizeof (buf), NULL, NULL, 0, literal) == 0) {
4180 if (strlen(buf) > entry->pl_width)
4181 entry->pl_width = strlen(buf);
4183 if (received && zfs_prop_get_recvd(zhp,
4184 zfs_prop_to_name(entry->pl_prop),
4185 buf, sizeof (buf), literal) == 0)
4186 if (strlen(buf) > entry->pl_recvd_width)
4187 entry->pl_recvd_width = strlen(buf);
4189 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
4191 verify(nvlist_lookup_string(propval,
4192 ZPROP_VALUE, &strval) == 0);
4193 if (strlen(strval) > entry->pl_width)
4194 entry->pl_width = strlen(strval);
4196 if (received && zfs_prop_get_recvd(zhp,
4197 entry->pl_user_prop,
4198 buf, sizeof (buf), literal) == 0)
4199 if (strlen(buf) > entry->pl_recvd_width)
4200 entry->pl_recvd_width = strlen(buf);
4208 zfs_deleg_share_nfs(libzfs_handle_t *hdl, char *dataset, char *path,
4209 char *resource, void *export, void *sharetab,
4210 int sharemax, zfs_share_op_t operation)
4212 zfs_cmd_t zc = { 0 };
4215 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4216 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4218 (void) strlcpy(zc.zc_string, resource, sizeof (zc.zc_string));
4219 zc.zc_share.z_sharedata = (uint64_t)(uintptr_t)sharetab;
4220 zc.zc_share.z_exportdata = (uint64_t)(uintptr_t)export;
4221 zc.zc_share.z_sharetype = operation;
4222 zc.zc_share.z_sharemax = sharemax;
4223 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SHARE, &zc);
4228 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
4233 * Keep a reference to the props-table against which we prune the
4236 zhp->zfs_props_table = props;
4238 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
4241 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
4242 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
4245 * User properties will result in ZPROP_INVAL, and since we
4246 * only know how to prune standard ZFS properties, we always
4247 * leave these in the list. This can also happen if we
4248 * encounter an unknown DSL property (when running older
4249 * software, for example).
4251 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
4252 (void) nvlist_remove(zhp->zfs_props,
4253 nvpair_name(curr), nvpair_type(curr));
4260 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
4261 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
4263 zfs_cmd_t zc = { 0 };
4264 nvlist_t *nvlist = NULL;
4267 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4268 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4269 zc.zc_cookie = (uint64_t)cmd;
4271 if (cmd == ZFS_SMB_ACL_RENAME) {
4272 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
4273 (void) no_memory(hdl);
4279 case ZFS_SMB_ACL_ADD:
4280 case ZFS_SMB_ACL_REMOVE:
4281 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4283 case ZFS_SMB_ACL_RENAME:
4284 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4286 (void) no_memory(hdl);
4289 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4291 (void) no_memory(hdl);
4294 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4295 nvlist_free(nvlist);
4299 case ZFS_SMB_ACL_PURGE:
4304 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4306 nvlist_free(nvlist);
4311 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4312 char *path, char *resource)
4314 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4319 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4320 char *path, char *resource)
4322 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4327 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4329 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4334 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4335 char *oldname, char *newname)
4337 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4343 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4344 zfs_userspace_cb_t func, void *arg)
4346 zfs_cmd_t zc = { 0 };
4347 zfs_useracct_t buf[100];
4348 libzfs_handle_t *hdl = zhp->zfs_hdl;
4351 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4353 zc.zc_objset_type = type;
4354 zc.zc_nvlist_dst = (uintptr_t)buf;
4357 zfs_useracct_t *zua = buf;
4359 zc.zc_nvlist_dst_size = sizeof (buf);
4360 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4363 (void) snprintf(errbuf, sizeof (errbuf),
4364 dgettext(TEXT_DOMAIN,
4365 "cannot get used/quota for %s"), zc.zc_name);
4366 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4368 if (zc.zc_nvlist_dst_size == 0)
4371 while (zc.zc_nvlist_dst_size > 0) {
4372 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4373 zua->zu_space)) != 0)
4376 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4385 const char *snapname;
4387 boolean_t recursive;
4392 zfs_hold_one(zfs_handle_t *zhp, void *arg)
4394 struct holdarg *ha = arg;
4395 char name[ZFS_MAXNAMELEN];
4398 (void) snprintf(name, sizeof (name),
4399 "%s@%s", zhp->zfs_name, ha->snapname);
4401 if (lzc_exists(name))
4402 fnvlist_add_string(ha->nvl, name, ha->tag);
4405 rv = zfs_iter_filesystems(zhp, zfs_hold_one, ha);
4411 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4412 boolean_t recursive, int cleanup_fd)
4417 ha.nvl = fnvlist_alloc();
4418 ha.snapname = snapname;
4420 ha.recursive = recursive;
4421 (void) zfs_hold_one(zfs_handle_dup(zhp), &ha);
4423 if (nvlist_empty(ha.nvl)) {
4426 fnvlist_free(ha.nvl);
4428 (void) snprintf(errbuf, sizeof (errbuf),
4429 dgettext(TEXT_DOMAIN,
4430 "cannot hold snapshot '%s@%s'"),
4431 zhp->zfs_name, snapname);
4432 (void) zfs_standard_error(zhp->zfs_hdl, ret, errbuf);
4436 ret = zfs_hold_nvl(zhp, cleanup_fd, ha.nvl);
4437 fnvlist_free(ha.nvl);
4443 zfs_hold_nvl(zfs_handle_t *zhp, int cleanup_fd, nvlist_t *holds)
4447 libzfs_handle_t *hdl = zhp->zfs_hdl;
4452 ret = lzc_hold(holds, cleanup_fd, &errors);
4455 /* There may be errors even in the success case. */
4456 fnvlist_free(errors);
4460 if (nvlist_empty(errors)) {
4461 /* no hold-specific errors */
4462 (void) snprintf(errbuf, sizeof (errbuf),
4463 dgettext(TEXT_DOMAIN, "cannot hold"));
4466 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4467 "pool must be upgraded"));
4468 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4471 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4474 (void) zfs_standard_error(hdl, ret, errbuf);
4478 for (elem = nvlist_next_nvpair(errors, NULL);
4480 elem = nvlist_next_nvpair(errors, elem)) {
4481 (void) snprintf(errbuf, sizeof (errbuf),
4482 dgettext(TEXT_DOMAIN,
4483 "cannot hold snapshot '%s'"), nvpair_name(elem));
4484 switch (fnvpair_value_int32(elem)) {
4487 * Temporary tags wind up having the ds object id
4488 * prepended. So even if we passed the length check
4489 * above, it's still possible for the tag to wind
4490 * up being slightly too long.
4492 (void) zfs_error(hdl, EZFS_TAGTOOLONG, errbuf);
4495 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4498 (void) zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf);
4501 (void) zfs_standard_error(hdl,
4502 fnvpair_value_int32(elem), errbuf);
4506 fnvlist_free(errors);
4511 zfs_release_one(zfs_handle_t *zhp, void *arg)
4513 struct holdarg *ha = arg;
4514 char name[ZFS_MAXNAMELEN];
4516 nvlist_t *existing_holds;
4518 (void) snprintf(name, sizeof (name),
4519 "%s@%s", zhp->zfs_name, ha->snapname);
4521 if (lzc_get_holds(name, &existing_holds) != 0) {
4523 } else if (!nvlist_exists(existing_holds, ha->tag)) {
4526 nvlist_t *torelease = fnvlist_alloc();
4527 fnvlist_add_boolean(torelease, ha->tag);
4528 fnvlist_add_nvlist(ha->nvl, name, torelease);
4529 fnvlist_free(torelease);
4533 rv = zfs_iter_filesystems(zhp, zfs_release_one, ha);
4539 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4540 boolean_t recursive)
4544 nvlist_t *errors = NULL;
4546 libzfs_handle_t *hdl = zhp->zfs_hdl;
4549 ha.nvl = fnvlist_alloc();
4550 ha.snapname = snapname;
4552 ha.recursive = recursive;
4554 (void) zfs_release_one(zfs_handle_dup(zhp), &ha);
4556 if (nvlist_empty(ha.nvl)) {
4557 fnvlist_free(ha.nvl);
4559 (void) snprintf(errbuf, sizeof (errbuf),
4560 dgettext(TEXT_DOMAIN,
4561 "cannot release hold from snapshot '%s@%s'"),
4562 zhp->zfs_name, snapname);
4564 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4566 (void) zfs_standard_error(hdl, ret, errbuf);
4571 ret = lzc_release(ha.nvl, &errors);
4572 fnvlist_free(ha.nvl);
4575 /* There may be errors even in the success case. */
4576 fnvlist_free(errors);
4580 if (nvlist_empty(errors)) {
4581 /* no hold-specific errors */
4582 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4586 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4587 "pool must be upgraded"));
4588 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4591 (void) zfs_standard_error_fmt(hdl, errno, errbuf);
4595 for (elem = nvlist_next_nvpair(errors, NULL);
4597 elem = nvlist_next_nvpair(errors, elem)) {
4598 (void) snprintf(errbuf, sizeof (errbuf),
4599 dgettext(TEXT_DOMAIN,
4600 "cannot release hold from snapshot '%s'"),
4602 switch (fnvpair_value_int32(elem)) {
4604 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4607 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4610 (void) zfs_standard_error_fmt(hdl,
4611 fnvpair_value_int32(elem), errbuf);
4615 fnvlist_free(errors);
4620 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4622 zfs_cmd_t zc = { 0 };
4623 libzfs_handle_t *hdl = zhp->zfs_hdl;
4629 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4630 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4634 nvbuf = malloc(nvsz);
4635 if (nvbuf == NULL) {
4636 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4640 zc.zc_nvlist_dst_size = nvsz;
4641 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4643 (void) strlcpy(zc.zc_name, zhp->zfs_name, ZFS_MAXNAMELEN);
4645 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4646 (void) snprintf(errbuf, sizeof (errbuf),
4647 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4652 nvsz = zc.zc_nvlist_dst_size;
4656 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4657 "pool must be upgraded"));
4658 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4661 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4664 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4667 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4672 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4674 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4675 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4677 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4687 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4689 zfs_cmd_t zc = { 0 };
4690 libzfs_handle_t *hdl = zhp->zfs_hdl;
4696 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4697 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4699 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
4702 nvbuf = malloc(nvsz);
4704 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
4707 zc.zc_nvlist_src_size = nvsz;
4708 zc.zc_nvlist_src = (uintptr_t)nvbuf;
4709 zc.zc_perm_action = un;
4711 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4713 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
4714 (void) snprintf(errbuf, sizeof (errbuf),
4715 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
4719 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4720 "pool must be upgraded"));
4721 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4724 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4727 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4730 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4741 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
4746 err = lzc_get_holds(zhp->zfs_name, nvl);
4749 libzfs_handle_t *hdl = zhp->zfs_hdl;
4751 (void) snprintf(errbuf, sizeof (errbuf),
4752 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4756 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4757 "pool must be upgraded"));
4758 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4761 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4764 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4767 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4776 * Convert the zvol's volume size to an appropriate reservation.
4777 * Note: If this routine is updated, it is necessary to update the ZFS test
4778 * suite's shell version in reservation.kshlib.
4781 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4784 uint64_t nblocks, volblocksize;
4788 if (nvlist_lookup_string(props,
4789 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4790 ncopies = atoi(strval);
4793 if (nvlist_lookup_uint64(props,
4794 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4795 &volblocksize) != 0)
4796 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4797 nblocks = volsize/volblocksize;
4798 /* start with metadnode L0-L6 */
4800 /* calculate number of indirects */
4801 while (nblocks > 1) {
4802 nblocks += DNODES_PER_LEVEL - 1;
4803 nblocks /= DNODES_PER_LEVEL;
4806 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4809 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4810 * compressed, but in practice they compress down to about
4813 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;
4819 * Attach/detach the given filesystem to/from the given jail.
4822 zfs_jail(zfs_handle_t *zhp, int jailid, int attach)
4824 libzfs_handle_t *hdl = zhp->zfs_hdl;
4825 zfs_cmd_t zc = { 0 };
4831 (void) snprintf(errbuf, sizeof (errbuf),
4832 dgettext(TEXT_DOMAIN, "cannot jail '%s'"), zhp->zfs_name);
4834 (void) snprintf(errbuf, sizeof (errbuf),
4835 dgettext(TEXT_DOMAIN, "cannot unjail '%s'"), zhp->zfs_name);
4838 switch (zhp->zfs_type) {
4839 case ZFS_TYPE_VOLUME:
4840 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4841 "volumes can not be jailed"));
4842 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4843 case ZFS_TYPE_SNAPSHOT:
4844 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4845 "snapshots can not be jailed"));
4846 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4848 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4850 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4851 zc.zc_objset_type = DMU_OST_ZFS;
4852 zc.zc_jailid = jailid;
4854 cmd = attach ? ZFS_IOC_JAIL : ZFS_IOC_UNJAIL;
4855 if ((ret = ioctl(hdl->libzfs_fd, cmd, &zc)) != 0)
4856 zfs_standard_error(hdl, errno, errbuf);