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) 2013 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_RECORDSIZE:
1084 case ZFS_PROP_VOLBLOCKSIZE:
1085 /* must be power of two within SPA_{MIN,MAX}BLOCKSIZE */
1086 if (intval < SPA_MINBLOCKSIZE ||
1087 intval > SPA_MAXBLOCKSIZE || !ISP2(intval)) {
1088 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1089 "'%s' must be power of 2 from %u "
1090 "to %uk"), propname,
1091 (uint_t)SPA_MINBLOCKSIZE,
1092 (uint_t)SPA_MAXBLOCKSIZE >> 10);
1093 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1098 case ZFS_PROP_MLSLABEL:
1102 * Verify the mlslabel string and convert to
1103 * internal hex label string.
1107 char *hex = NULL; /* internal label string */
1109 /* Default value is already OK. */
1110 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
1113 /* Verify the label can be converted to binary form */
1114 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
1115 (str_to_label(strval, &new_sl, MAC_LABEL,
1116 L_NO_CORRECTION, NULL) == -1)) {
1120 /* Now translate to hex internal label string */
1121 if (label_to_str(new_sl, &hex, M_INTERNAL,
1127 m_label_free(new_sl);
1129 /* If string is already in internal form, we're done. */
1130 if (strcmp(strval, hex) == 0) {
1135 /* Replace the label string with the internal form. */
1136 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
1138 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
1145 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1146 "invalid mlslabel '%s'"), strval);
1147 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1148 m_label_free(new_sl); /* OK if null */
1150 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1151 "mlslabel is not supported on FreeBSD"));
1152 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1158 case ZFS_PROP_MOUNTPOINT:
1160 namecheck_err_t why;
1162 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1163 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1166 if (mountpoint_namecheck(strval, &why)) {
1168 case NAME_ERR_LEADING_SLASH:
1170 dgettext(TEXT_DOMAIN,
1171 "'%s' must be an absolute path, "
1172 "'none', or 'legacy'"), propname);
1174 case NAME_ERR_TOOLONG:
1176 dgettext(TEXT_DOMAIN,
1177 "component of '%s' is too long"),
1181 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1188 case ZFS_PROP_SHARESMB:
1189 case ZFS_PROP_SHARENFS:
1191 * For the mountpoint and sharenfs or sharesmb
1192 * properties, check if it can be set in a
1193 * global/non-global zone based on
1194 * the zoned property value:
1196 * global zone non-global zone
1197 * --------------------------------------------------
1198 * zoned=on mountpoint (no) mountpoint (yes)
1199 * sharenfs (no) sharenfs (no)
1200 * sharesmb (no) sharesmb (no)
1202 * zoned=off mountpoint (yes) N/A
1207 if (getzoneid() == GLOBAL_ZONEID) {
1208 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1209 "'%s' cannot be set on "
1210 "dataset in a non-global zone"),
1212 (void) zfs_error(hdl, EZFS_ZONED,
1215 } else if (prop == ZFS_PROP_SHARENFS ||
1216 prop == ZFS_PROP_SHARESMB) {
1217 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1218 "'%s' cannot be set in "
1219 "a non-global zone"), propname);
1220 (void) zfs_error(hdl, EZFS_ZONED,
1224 } else if (getzoneid() != GLOBAL_ZONEID) {
1226 * If zoned property is 'off', this must be in
1227 * a global zone. If not, something is wrong.
1229 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1230 "'%s' cannot be set while dataset "
1231 "'zoned' property is set"), propname);
1232 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1237 * At this point, it is legitimate to set the
1238 * property. Now we want to make sure that the
1239 * property value is valid if it is sharenfs.
1241 if ((prop == ZFS_PROP_SHARENFS ||
1242 prop == ZFS_PROP_SHARESMB) &&
1243 strcmp(strval, "on") != 0 &&
1244 strcmp(strval, "off") != 0) {
1245 zfs_share_proto_t proto;
1247 if (prop == ZFS_PROP_SHARESMB)
1253 * Must be an valid sharing protocol
1254 * option string so init the libshare
1255 * in order to enable the parser and
1256 * then parse the options. We use the
1257 * control API since we don't care about
1258 * the current configuration and don't
1259 * want the overhead of loading it
1260 * until we actually do something.
1263 if (zfs_init_libshare(hdl,
1264 SA_INIT_CONTROL_API) != SA_OK) {
1266 * An error occurred so we can't do
1269 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1270 "'%s' cannot be set: problem "
1271 "in share initialization"),
1273 (void) zfs_error(hdl, EZFS_BADPROP,
1278 if (zfs_parse_options(strval, proto) != SA_OK) {
1280 * There was an error in parsing so
1281 * deal with it by issuing an error
1282 * message and leaving after
1283 * uninitializing the the libshare
1286 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1287 "'%s' cannot be set to invalid "
1288 "options"), propname);
1289 (void) zfs_error(hdl, EZFS_BADPROP,
1291 zfs_uninit_libshare(hdl);
1294 zfs_uninit_libshare(hdl);
1298 case ZFS_PROP_UTF8ONLY:
1299 chosen_utf = (int)intval;
1301 case ZFS_PROP_NORMALIZE:
1302 chosen_normal = (int)intval;
1307 * For changes to existing volumes, we have some additional
1308 * checks to enforce.
1310 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1311 uint64_t volsize = zfs_prop_get_int(zhp,
1313 uint64_t blocksize = zfs_prop_get_int(zhp,
1314 ZFS_PROP_VOLBLOCKSIZE);
1318 case ZFS_PROP_RESERVATION:
1319 case ZFS_PROP_REFRESERVATION:
1320 if (intval > volsize) {
1321 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1322 "'%s' is greater than current "
1323 "volume size"), propname);
1324 (void) zfs_error(hdl, EZFS_BADPROP,
1330 case ZFS_PROP_VOLSIZE:
1331 if (intval % blocksize != 0) {
1332 zfs_nicenum(blocksize, buf,
1334 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1335 "'%s' must be a multiple of "
1336 "volume block size (%s)"),
1338 (void) zfs_error(hdl, EZFS_BADPROP,
1344 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1345 "'%s' cannot be zero"),
1347 (void) zfs_error(hdl, EZFS_BADPROP,
1357 * If normalization was chosen, but no UTF8 choice was made,
1358 * enforce rejection of non-UTF8 names.
1360 * If normalization was chosen, but rejecting non-UTF8 names
1361 * was explicitly not chosen, it is an error.
1363 if (chosen_normal > 0 && chosen_utf < 0) {
1364 if (nvlist_add_uint64(ret,
1365 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1366 (void) no_memory(hdl);
1369 } else if (chosen_normal > 0 && chosen_utf == 0) {
1370 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1371 "'%s' must be set 'on' if normalization chosen"),
1372 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1373 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1384 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1386 uint64_t old_volsize;
1387 uint64_t new_volsize;
1388 uint64_t old_reservation;
1389 uint64_t new_reservation;
1390 zfs_prop_t resv_prop;
1393 * If this is an existing volume, and someone is setting the volsize,
1394 * make sure that it matches the reservation, or add it if necessary.
1396 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1397 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1399 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1400 if ((zvol_volsize_to_reservation(old_volsize, zhp->zfs_props) !=
1401 old_reservation) || nvlist_lookup_uint64(nvl,
1402 zfs_prop_to_name(resv_prop), &new_reservation) != ENOENT) {
1405 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1408 new_reservation = zvol_volsize_to_reservation(new_volsize,
1410 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1411 new_reservation) != 0) {
1412 (void) no_memory(zhp->zfs_hdl);
1419 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1426 * For quotas and reservations, ENOSPC indicates
1427 * something different; setting a quota or reservation
1428 * doesn't use any disk space.
1431 case ZFS_PROP_QUOTA:
1432 case ZFS_PROP_REFQUOTA:
1433 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1434 "size is less than current used or "
1436 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1439 case ZFS_PROP_RESERVATION:
1440 case ZFS_PROP_REFRESERVATION:
1441 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1442 "size is greater than available space"));
1443 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1447 (void) zfs_standard_error(hdl, err, errbuf);
1453 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1457 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1461 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1462 "pool and or dataset must be upgraded to set this "
1463 "property or value"));
1464 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1468 if (prop == ZFS_PROP_COMPRESSION) {
1469 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1470 "property setting is not allowed on "
1471 "bootable datasets"));
1472 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1474 (void) zfs_standard_error(hdl, err, errbuf);
1479 if (prop == ZPROP_INVAL) {
1480 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1482 (void) zfs_standard_error(hdl, err, errbuf);
1488 * This platform can't address a volume this big.
1491 if (prop == ZFS_PROP_VOLSIZE) {
1492 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1498 (void) zfs_standard_error(hdl, err, errbuf);
1503 * Given a property name and value, set the property for the given dataset.
1506 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1508 zfs_cmd_t zc = { 0 };
1510 prop_changelist_t *cl = NULL;
1512 libzfs_handle_t *hdl = zhp->zfs_hdl;
1513 nvlist_t *nvl = NULL, *realprops;
1515 boolean_t do_prefix = B_TRUE;
1518 (void) snprintf(errbuf, sizeof (errbuf),
1519 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1522 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1523 nvlist_add_string(nvl, propname, propval) != 0) {
1524 (void) no_memory(hdl);
1528 if ((realprops = zfs_valid_proplist(hdl, zhp->zfs_type, nvl,
1529 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, errbuf)) == NULL)
1535 prop = zfs_name_to_prop(propname);
1537 /* We don't support those properties on FreeBSD. */
1539 case ZFS_PROP_DEVICES:
1540 case ZFS_PROP_ISCSIOPTIONS:
1541 case ZFS_PROP_XATTR:
1542 case ZFS_PROP_VSCAN:
1543 case ZFS_PROP_NBMAND:
1544 case ZFS_PROP_MLSLABEL:
1545 (void) snprintf(errbuf, sizeof (errbuf),
1546 "property '%s' not supported on FreeBSD", propname);
1547 ret = zfs_error(hdl, EZFS_PERM, errbuf);
1551 if (prop == ZFS_PROP_VOLSIZE) {
1552 if ((added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1)
1556 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1559 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1560 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1561 "child dataset with inherited mountpoint is used "
1562 "in a non-global zone"));
1563 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1568 * We don't want to unmount & remount the dataset when changing
1569 * its canmount property to 'on' or 'noauto'. We only use
1570 * the changelist logic to unmount when setting canmount=off.
1572 if (prop == ZFS_PROP_CANMOUNT) {
1574 int err = zprop_string_to_index(prop, propval, &idx,
1576 if (err == 0 && idx != ZFS_CANMOUNT_OFF)
1577 do_prefix = B_FALSE;
1580 if (do_prefix && (ret = changelist_prefix(cl)) != 0)
1584 * Execute the corresponding ioctl() to set this property.
1586 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1588 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1591 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1594 zfs_setprop_error(hdl, prop, errno, errbuf);
1595 if (added_resv && errno == ENOSPC) {
1596 /* clean up the volsize property we tried to set */
1597 uint64_t old_volsize = zfs_prop_get_int(zhp,
1600 zcmd_free_nvlists(&zc);
1601 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1603 if (nvlist_add_uint64(nvl,
1604 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1607 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1609 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1613 ret = changelist_postfix(cl);
1616 * Refresh the statistics so the new property value
1620 (void) get_stats(zhp);
1625 zcmd_free_nvlists(&zc);
1627 changelist_free(cl);
1632 * Given a property, inherit the value from the parent dataset, or if received
1633 * is TRUE, revert to the received value, if any.
1636 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1638 zfs_cmd_t zc = { 0 };
1640 prop_changelist_t *cl;
1641 libzfs_handle_t *hdl = zhp->zfs_hdl;
1645 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1646 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1648 zc.zc_cookie = received;
1649 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1651 * For user properties, the amount of work we have to do is very
1652 * small, so just do it here.
1654 if (!zfs_prop_user(propname)) {
1655 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1656 "invalid property"));
1657 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1660 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1661 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1663 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1664 return (zfs_standard_error(hdl, errno, errbuf));
1670 * Verify that this property is inheritable.
1672 if (zfs_prop_readonly(prop))
1673 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1675 if (!zfs_prop_inheritable(prop) && !received)
1676 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1679 * Check to see if the value applies to this type
1681 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1682 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1685 * Normalize the name, to get rid of shorthand abbreviations.
1687 propname = zfs_prop_to_name(prop);
1688 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1689 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1691 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1692 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1693 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1694 "dataset is used in a non-global zone"));
1695 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1699 * Determine datasets which will be affected by this change, if any.
1701 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1704 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1705 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1706 "child dataset with inherited mountpoint is used "
1707 "in a non-global zone"));
1708 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1712 if ((ret = changelist_prefix(cl)) != 0)
1715 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1716 return (zfs_standard_error(hdl, errno, errbuf));
1719 if ((ret = changelist_postfix(cl)) != 0)
1723 * Refresh the statistics so the new property is reflected.
1725 (void) get_stats(zhp);
1729 changelist_free(cl);
1734 * True DSL properties are stored in an nvlist. The following two functions
1735 * extract them appropriately.
1738 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1744 if (nvlist_lookup_nvlist(zhp->zfs_props,
1745 zfs_prop_to_name(prop), &nv) == 0) {
1746 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1747 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1749 verify(!zhp->zfs_props_table ||
1750 zhp->zfs_props_table[prop] == B_TRUE);
1751 value = zfs_prop_default_numeric(prop);
1759 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1765 if (nvlist_lookup_nvlist(zhp->zfs_props,
1766 zfs_prop_to_name(prop), &nv) == 0) {
1767 verify(nvlist_lookup_string(nv, ZPROP_VALUE, &value) == 0);
1768 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1770 verify(!zhp->zfs_props_table ||
1771 zhp->zfs_props_table[prop] == B_TRUE);
1772 if ((value = (char *)zfs_prop_default_string(prop)) == NULL)
1781 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
1783 return (zhp->zfs_props == zhp->zfs_recvd_props);
1787 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1789 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
1790 zhp->zfs_props = zhp->zfs_recvd_props;
1794 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1796 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
1801 * Internal function for getting a numeric property. Both zfs_prop_get() and
1802 * zfs_prop_get_int() are built using this interface.
1804 * Certain properties can be overridden using 'mount -o'. In this case, scan
1805 * the contents of the /etc/mnttab entry, searching for the appropriate options.
1806 * If they differ from the on-disk values, report the current values and mark
1807 * the source "temporary".
1810 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
1811 char **source, uint64_t *val)
1813 zfs_cmd_t zc = { 0 };
1814 nvlist_t *zplprops = NULL;
1816 char *mntopt_on = NULL;
1817 char *mntopt_off = NULL;
1818 boolean_t received = zfs_is_recvd_props_mode(zhp);
1823 case ZFS_PROP_ATIME:
1824 mntopt_on = MNTOPT_ATIME;
1825 mntopt_off = MNTOPT_NOATIME;
1828 case ZFS_PROP_DEVICES:
1829 mntopt_on = MNTOPT_DEVICES;
1830 mntopt_off = MNTOPT_NODEVICES;
1834 mntopt_on = MNTOPT_EXEC;
1835 mntopt_off = MNTOPT_NOEXEC;
1838 case ZFS_PROP_READONLY:
1839 mntopt_on = MNTOPT_RO;
1840 mntopt_off = MNTOPT_RW;
1843 case ZFS_PROP_SETUID:
1844 mntopt_on = MNTOPT_SETUID;
1845 mntopt_off = MNTOPT_NOSETUID;
1848 case ZFS_PROP_XATTR:
1849 mntopt_on = MNTOPT_XATTR;
1850 mntopt_off = MNTOPT_NOXATTR;
1853 case ZFS_PROP_NBMAND:
1854 mntopt_on = MNTOPT_NBMAND;
1855 mntopt_off = MNTOPT_NONBMAND;
1860 * Because looking up the mount options is potentially expensive
1861 * (iterating over all of /etc/mnttab), we defer its calculation until
1862 * we're looking up a property which requires its presence.
1864 if (!zhp->zfs_mntcheck &&
1865 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
1866 libzfs_handle_t *hdl = zhp->zfs_hdl;
1867 struct mnttab entry;
1869 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
1870 zhp->zfs_mntopts = zfs_strdup(hdl,
1872 if (zhp->zfs_mntopts == NULL)
1876 zhp->zfs_mntcheck = B_TRUE;
1879 if (zhp->zfs_mntopts == NULL)
1880 mnt.mnt_mntopts = "";
1882 mnt.mnt_mntopts = zhp->zfs_mntopts;
1885 case ZFS_PROP_ATIME:
1886 case ZFS_PROP_DEVICES:
1888 case ZFS_PROP_READONLY:
1889 case ZFS_PROP_SETUID:
1890 case ZFS_PROP_XATTR:
1891 case ZFS_PROP_NBMAND:
1892 *val = getprop_uint64(zhp, prop, source);
1897 if (hasmntopt(&mnt, mntopt_on) && !*val) {
1900 *src = ZPROP_SRC_TEMPORARY;
1901 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
1904 *src = ZPROP_SRC_TEMPORARY;
1908 case ZFS_PROP_CANMOUNT:
1909 case ZFS_PROP_VOLSIZE:
1910 case ZFS_PROP_QUOTA:
1911 case ZFS_PROP_REFQUOTA:
1912 case ZFS_PROP_RESERVATION:
1913 case ZFS_PROP_REFRESERVATION:
1914 case ZFS_PROP_FILESYSTEM_LIMIT:
1915 case ZFS_PROP_SNAPSHOT_LIMIT:
1916 case ZFS_PROP_FILESYSTEM_COUNT:
1917 case ZFS_PROP_SNAPSHOT_COUNT:
1918 *val = getprop_uint64(zhp, prop, source);
1920 if (*source == NULL) {
1921 /* not default, must be local */
1922 *source = zhp->zfs_name;
1926 case ZFS_PROP_MOUNTED:
1927 *val = (zhp->zfs_mntopts != NULL);
1930 case ZFS_PROP_NUMCLONES:
1931 *val = zhp->zfs_dmustats.dds_num_clones;
1934 case ZFS_PROP_VERSION:
1935 case ZFS_PROP_NORMALIZE:
1936 case ZFS_PROP_UTF8ONLY:
1938 if (!zfs_prop_valid_for_type(prop, zhp->zfs_head_type) ||
1939 zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
1941 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1942 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
1943 zcmd_free_nvlists(&zc);
1946 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
1947 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
1949 zcmd_free_nvlists(&zc);
1953 nvlist_free(zplprops);
1954 zcmd_free_nvlists(&zc);
1957 case ZFS_PROP_INCONSISTENT:
1958 *val = zhp->zfs_dmustats.dds_inconsistent;
1962 switch (zfs_prop_get_type(prop)) {
1963 case PROP_TYPE_NUMBER:
1964 case PROP_TYPE_INDEX:
1965 *val = getprop_uint64(zhp, prop, source);
1967 * If we tried to use a default value for a
1968 * readonly property, it means that it was not
1971 if (zfs_prop_readonly(prop) &&
1972 *source != NULL && (*source)[0] == '\0') {
1977 case PROP_TYPE_STRING:
1979 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
1980 "cannot get non-numeric property"));
1981 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
1982 dgettext(TEXT_DOMAIN, "internal error")));
1990 * Calculate the source type, given the raw source string.
1993 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
1994 char *statbuf, size_t statlen)
1996 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
1999 if (source == NULL) {
2000 *srctype = ZPROP_SRC_NONE;
2001 } else if (source[0] == '\0') {
2002 *srctype = ZPROP_SRC_DEFAULT;
2003 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
2004 *srctype = ZPROP_SRC_RECEIVED;
2006 if (strcmp(source, zhp->zfs_name) == 0) {
2007 *srctype = ZPROP_SRC_LOCAL;
2009 (void) strlcpy(statbuf, source, statlen);
2010 *srctype = ZPROP_SRC_INHERITED;
2017 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
2018 size_t proplen, boolean_t literal)
2023 if (zhp->zfs_recvd_props == NULL)
2024 if (get_recvd_props_ioctl(zhp) != 0)
2027 prop = zfs_name_to_prop(propname);
2029 if (prop != ZPROP_INVAL) {
2031 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
2033 zfs_set_recvd_props_mode(zhp, &cookie);
2034 err = zfs_prop_get(zhp, prop, propbuf, proplen,
2035 NULL, NULL, 0, literal);
2036 zfs_unset_recvd_props_mode(zhp, &cookie);
2040 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
2041 propname, &propval) != 0)
2043 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
2045 (void) strlcpy(propbuf, recvdval, proplen);
2048 return (err == 0 ? 0 : -1);
2052 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2057 value = zfs_get_clones_nvl(zhp);
2062 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
2063 pair = nvlist_next_nvpair(value, pair)) {
2064 if (propbuf[0] != '\0')
2065 (void) strlcat(propbuf, ",", proplen);
2066 (void) strlcat(propbuf, nvpair_name(pair), proplen);
2072 struct get_clones_arg {
2076 char buf[ZFS_MAXNAMELEN];
2080 get_clones_cb(zfs_handle_t *zhp, void *arg)
2082 struct get_clones_arg *gca = arg;
2084 if (gca->numclones == 0) {
2089 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
2090 NULL, NULL, 0, B_TRUE) != 0)
2092 if (strcmp(gca->buf, gca->origin) == 0) {
2093 fnvlist_add_boolean(gca->value, zfs_get_name(zhp));
2098 (void) zfs_iter_children(zhp, get_clones_cb, gca);
2104 zfs_get_clones_nvl(zfs_handle_t *zhp)
2106 nvlist_t *nv, *value;
2108 if (nvlist_lookup_nvlist(zhp->zfs_props,
2109 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
2110 struct get_clones_arg gca;
2113 * if this is a snapshot, then the kernel wasn't able
2114 * to get the clones. Do it by slowly iterating.
2116 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2118 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2120 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2125 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2127 gca.origin = zhp->zfs_name;
2129 if (gca.numclones != 0) {
2131 char pool[ZFS_MAXNAMELEN];
2134 /* get the pool name */
2135 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2136 (void) strsep(&cp, "/@");
2137 root = zfs_open(zhp->zfs_hdl, pool,
2138 ZFS_TYPE_FILESYSTEM);
2140 (void) get_clones_cb(root, &gca);
2143 if (gca.numclones != 0 ||
2144 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2145 nvlist_add_nvlist(zhp->zfs_props,
2146 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2153 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2154 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2157 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2163 * Retrieve a property from the given object. If 'literal' is specified, then
2164 * numbers are left as exact values. Otherwise, numbers are converted to a
2165 * human-readable form.
2167 * Returns 0 on success, or -1 on error.
2170 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2171 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2173 char *source = NULL;
2177 boolean_t received = zfs_is_recvd_props_mode(zhp);
2180 * Check to see if this property applies to our object
2182 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
2185 if (received && zfs_prop_readonly(prop))
2189 *src = ZPROP_SRC_NONE;
2192 case ZFS_PROP_CREATION:
2194 * 'creation' is a time_t stored in the statistics. We convert
2195 * this into a string unless 'literal' is specified.
2198 val = getprop_uint64(zhp, prop, &source);
2199 time_t time = (time_t)val;
2203 localtime_r(&time, &t) == NULL ||
2204 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2206 (void) snprintf(propbuf, proplen, "%llu", val);
2210 case ZFS_PROP_MOUNTPOINT:
2212 * Getting the precise mountpoint can be tricky.
2214 * - for 'none' or 'legacy', return those values.
2215 * - for inherited mountpoints, we want to take everything
2216 * after our ancestor and append it to the inherited value.
2218 * If the pool has an alternate root, we want to prepend that
2219 * root to any values we return.
2222 str = getprop_string(zhp, prop, &source);
2224 if (str[0] == '/') {
2225 char buf[MAXPATHLEN];
2227 const char *relpath;
2230 * If we inherit the mountpoint, even from a dataset
2231 * with a received value, the source will be the path of
2232 * the dataset we inherit from. If source is
2233 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2236 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2239 relpath = zhp->zfs_name + strlen(source);
2240 if (relpath[0] == '/')
2244 if ((zpool_get_prop(zhp->zpool_hdl,
2245 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2246 B_FALSE)) || (strcmp(root, "-") == 0))
2249 * Special case an alternate root of '/'. This will
2250 * avoid having multiple leading slashes in the
2253 if (strcmp(root, "/") == 0)
2257 * If the mountpoint is '/' then skip over this
2258 * if we are obtaining either an alternate root or
2259 * an inherited mountpoint.
2261 if (str[1] == '\0' && (root[0] != '\0' ||
2262 relpath[0] != '\0'))
2265 if (relpath[0] == '\0')
2266 (void) snprintf(propbuf, proplen, "%s%s",
2269 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2270 root, str, relpath[0] == '@' ? "" : "/",
2273 /* 'legacy' or 'none' */
2274 (void) strlcpy(propbuf, str, proplen);
2279 case ZFS_PROP_ORIGIN:
2280 (void) strlcpy(propbuf, getprop_string(zhp, prop, &source),
2283 * If there is no parent at all, return failure to indicate that
2284 * it doesn't apply to this dataset.
2286 if (propbuf[0] == '\0')
2290 case ZFS_PROP_CLONES:
2291 if (get_clones_string(zhp, propbuf, proplen) != 0)
2295 case ZFS_PROP_QUOTA:
2296 case ZFS_PROP_REFQUOTA:
2297 case ZFS_PROP_RESERVATION:
2298 case ZFS_PROP_REFRESERVATION:
2300 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2304 * If quota or reservation is 0, we translate this into 'none'
2305 * (unless literal is set), and indicate that it's the default
2306 * value. Otherwise, we print the number nicely and indicate
2307 * that its set locally.
2311 (void) strlcpy(propbuf, "0", proplen);
2313 (void) strlcpy(propbuf, "none", proplen);
2316 (void) snprintf(propbuf, proplen, "%llu",
2319 zfs_nicenum(val, propbuf, proplen);
2323 case ZFS_PROP_FILESYSTEM_LIMIT:
2324 case ZFS_PROP_SNAPSHOT_LIMIT:
2325 case ZFS_PROP_FILESYSTEM_COUNT:
2326 case ZFS_PROP_SNAPSHOT_COUNT:
2328 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2332 * If limit is UINT64_MAX, we translate this into 'none' (unless
2333 * literal is set), and indicate that it's the default value.
2334 * Otherwise, we print the number nicely and indicate that it's
2338 (void) snprintf(propbuf, proplen, "%llu",
2340 } else if (val == UINT64_MAX) {
2341 (void) strlcpy(propbuf, "none", proplen);
2343 zfs_nicenum(val, propbuf, proplen);
2347 case ZFS_PROP_REFRATIO:
2348 case ZFS_PROP_COMPRESSRATIO:
2349 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2351 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2352 (u_longlong_t)(val / 100),
2353 (u_longlong_t)(val % 100));
2357 switch (zhp->zfs_type) {
2358 case ZFS_TYPE_FILESYSTEM:
2361 case ZFS_TYPE_VOLUME:
2364 case ZFS_TYPE_SNAPSHOT:
2367 case ZFS_TYPE_BOOKMARK:
2373 (void) snprintf(propbuf, proplen, "%s", str);
2376 case ZFS_PROP_MOUNTED:
2378 * The 'mounted' property is a pseudo-property that described
2379 * whether the filesystem is currently mounted. Even though
2380 * it's a boolean value, the typical values of "on" and "off"
2381 * don't make sense, so we translate to "yes" and "no".
2383 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2384 src, &source, &val) != 0)
2387 (void) strlcpy(propbuf, "yes", proplen);
2389 (void) strlcpy(propbuf, "no", proplen);
2394 * The 'name' property is a pseudo-property derived from the
2395 * dataset name. It is presented as a real property to simplify
2398 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2401 case ZFS_PROP_MLSLABEL:
2404 m_label_t *new_sl = NULL;
2405 char *ascii = NULL; /* human readable label */
2407 (void) strlcpy(propbuf,
2408 getprop_string(zhp, prop, &source), proplen);
2410 if (literal || (strcasecmp(propbuf,
2411 ZFS_MLSLABEL_DEFAULT) == 0))
2415 * Try to translate the internal hex string to
2416 * human-readable output. If there are any
2417 * problems just use the hex string.
2420 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2421 L_NO_CORRECTION, NULL) == -1) {
2422 m_label_free(new_sl);
2426 if (label_to_str(new_sl, &ascii, M_LABEL,
2430 m_label_free(new_sl);
2433 m_label_free(new_sl);
2435 (void) strlcpy(propbuf, ascii, proplen);
2445 * GUIDs are stored as numbers, but they are identifiers.
2446 * We don't want them to be pretty printed, because pretty
2447 * printing mangles the ID into a truncated and useless value.
2449 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2451 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2455 switch (zfs_prop_get_type(prop)) {
2456 case PROP_TYPE_NUMBER:
2457 if (get_numeric_property(zhp, prop, src,
2458 &source, &val) != 0)
2461 (void) snprintf(propbuf, proplen, "%llu",
2464 zfs_nicenum(val, propbuf, proplen);
2467 case PROP_TYPE_STRING:
2468 (void) strlcpy(propbuf,
2469 getprop_string(zhp, prop, &source), proplen);
2472 case PROP_TYPE_INDEX:
2473 if (get_numeric_property(zhp, prop, src,
2474 &source, &val) != 0)
2476 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2478 (void) strlcpy(propbuf, strval, proplen);
2486 get_source(zhp, src, source, statbuf, statlen);
2492 * Utility function to get the given numeric property. Does no validation that
2493 * the given property is the appropriate type; should only be used with
2494 * hard-coded property types.
2497 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2502 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2508 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2512 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2513 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2517 * Similar to zfs_prop_get(), but returns the value as an integer.
2520 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2521 zprop_source_t *src, char *statbuf, size_t statlen)
2526 * Check to see if this property applies to our object
2528 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) {
2529 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2530 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2531 zfs_prop_to_name(prop)));
2535 *src = ZPROP_SRC_NONE;
2537 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2540 get_source(zhp, src, source, statbuf, statlen);
2546 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2547 char **domainp, idmap_rid_t *ridp)
2550 idmap_get_handle_t *get_hdl = NULL;
2554 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2558 err = idmap_get_sidbyuid(get_hdl, id,
2559 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2561 err = idmap_get_sidbygid(get_hdl, id,
2562 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2564 if (err == IDMAP_SUCCESS &&
2565 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2566 status == IDMAP_SUCCESS)
2572 idmap_get_destroy(get_hdl);
2575 assert(!"invalid code path");
2580 * convert the propname into parameters needed by kernel
2581 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2582 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2585 userquota_propname_decode(const char *propname, boolean_t zoned,
2586 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2588 zfs_userquota_prop_t type;
2590 char *numericsid = NULL;
2595 /* Figure out the property type ({user|group}{quota|space}) */
2596 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2597 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2598 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2601 if (type == ZFS_NUM_USERQUOTA_PROPS)
2605 isuser = (type == ZFS_PROP_USERQUOTA ||
2606 type == ZFS_PROP_USERUSED);
2608 cp = strchr(propname, '@') + 1;
2610 if (strchr(cp, '@')) {
2613 * It's a SID name (eg "user@domain") that needs to be
2614 * turned into S-1-domainID-RID.
2616 directory_error_t e;
2617 if (zoned && getzoneid() == GLOBAL_ZONEID)
2620 e = directory_sid_from_user_name(NULL,
2623 e = directory_sid_from_group_name(NULL,
2627 directory_error_free(e);
2630 if (numericsid == NULL)
2633 /* will be further decoded below */
2639 if (strncmp(cp, "S-1-", 4) == 0) {
2640 /* It's a numeric SID (eg "S-1-234-567-89") */
2641 (void) strlcpy(domain, cp, domainlen);
2642 cp = strrchr(domain, '-');
2647 *ridp = strtoull(cp, &end, 10);
2652 if (errno != 0 || *end != '\0')
2654 } else if (!isdigit(*cp)) {
2656 * It's a user/group name (eg "user") that needs to be
2657 * turned into a uid/gid
2659 if (zoned && getzoneid() == GLOBAL_ZONEID)
2675 /* It's a user/group ID (eg "12345"). */
2676 uid_t id = strtoul(cp, &end, 10);
2683 /* It's an ephemeral ID. */
2684 if (idmap_id_to_numeric_domain_rid(id, isuser,
2685 &mapdomain, &rid) != 0)
2687 (void) strlcpy(domain, mapdomain, domainlen);
2694 ASSERT3P(numericsid, ==, NULL);
2699 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2700 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2703 zfs_cmd_t zc = { 0 };
2705 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2707 err = userquota_propname_decode(propname,
2708 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2709 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2710 zc.zc_objset_type = *typep;
2714 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2718 *propvalue = zc.zc_cookie;
2723 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2724 uint64_t *propvalue)
2726 zfs_userquota_prop_t type;
2728 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
2733 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
2734 char *propbuf, int proplen, boolean_t literal)
2738 zfs_userquota_prop_t type;
2740 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
2747 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2748 } else if (propvalue == 0 &&
2749 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
2750 (void) strlcpy(propbuf, "none", proplen);
2752 zfs_nicenum(propvalue, propbuf, proplen);
2758 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
2759 uint64_t *propvalue)
2762 zfs_cmd_t zc = { 0 };
2763 const char *snapname;
2765 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2767 snapname = strchr(propname, '@') + 1;
2768 if (strchr(snapname, '@')) {
2769 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
2771 /* snapname is the short name, append it to zhp's fsname */
2774 (void) strlcpy(zc.zc_value, zhp->zfs_name,
2775 sizeof (zc.zc_value));
2776 cp = strchr(zc.zc_value, '@');
2779 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
2780 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
2783 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
2787 *propvalue = zc.zc_cookie;
2792 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
2793 char *propbuf, int proplen, boolean_t literal)
2798 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
2804 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2806 zfs_nicenum(propvalue, propbuf, proplen);
2812 * Returns the name of the given zfs handle.
2815 zfs_get_name(const zfs_handle_t *zhp)
2817 return (zhp->zfs_name);
2821 * Returns the type of the given zfs handle.
2824 zfs_get_type(const zfs_handle_t *zhp)
2826 return (zhp->zfs_type);
2830 * Is one dataset name a child dataset of another?
2832 * Needs to handle these cases:
2833 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2834 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2835 * Descendant? No. No. No. Yes.
2838 is_descendant(const char *ds1, const char *ds2)
2840 size_t d1len = strlen(ds1);
2842 /* ds2 can't be a descendant if it's smaller */
2843 if (strlen(ds2) < d1len)
2846 /* otherwise, compare strings and verify that there's a '/' char */
2847 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
2851 * Given a complete name, return just the portion that refers to the parent.
2852 * Will return -1 if there is no parent (path is just the name of the
2856 parent_name(const char *path, char *buf, size_t buflen)
2860 (void) strlcpy(buf, path, buflen);
2862 if ((slashp = strrchr(buf, '/')) == NULL)
2870 * If accept_ancestor is false, then check to make sure that the given path has
2871 * a parent, and that it exists. If accept_ancestor is true, then find the
2872 * closest existing ancestor for the given path. In prefixlen return the
2873 * length of already existing prefix of the given path. We also fetch the
2874 * 'zoned' property, which is used to validate property settings when creating
2878 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
2879 boolean_t accept_ancestor, int *prefixlen)
2881 zfs_cmd_t zc = { 0 };
2882 char parent[ZFS_MAXNAMELEN];
2888 (void) snprintf(errbuf, sizeof (errbuf),
2889 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
2891 /* get parent, and check to see if this is just a pool */
2892 if (parent_name(path, parent, sizeof (parent)) != 0) {
2893 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2894 "missing dataset name"));
2895 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
2898 /* check to see if the pool exists */
2899 if ((slash = strchr(parent, '/')) == NULL)
2900 slash = parent + strlen(parent);
2901 (void) strncpy(zc.zc_name, parent, slash - parent);
2902 zc.zc_name[slash - parent] = '\0';
2903 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
2905 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2906 "no such pool '%s'"), zc.zc_name);
2907 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2910 /* check to see if the parent dataset exists */
2911 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
2912 if (errno == ENOENT && accept_ancestor) {
2914 * Go deeper to find an ancestor, give up on top level.
2916 if (parent_name(parent, parent, sizeof (parent)) != 0) {
2917 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2918 "no such pool '%s'"), zc.zc_name);
2919 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2921 } else if (errno == ENOENT) {
2922 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2923 "parent does not exist"));
2924 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2926 return (zfs_standard_error(hdl, errno, errbuf));
2929 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
2933 /* we are in a non-global zone, but parent is in the global zone */
2934 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
2935 (void) zfs_standard_error(hdl, EPERM, errbuf);
2940 /* make sure parent is a filesystem */
2941 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
2942 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2943 "parent is not a filesystem"));
2944 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
2950 if (prefixlen != NULL)
2951 *prefixlen = strlen(parent);
2956 * Finds whether the dataset of the given type(s) exists.
2959 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
2963 if (!zfs_validate_name(hdl, path, types, B_FALSE))
2967 * Try to get stats for the dataset, which will tell us if it exists.
2969 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
2970 int ds_type = zhp->zfs_type;
2973 if (types & ds_type)
2980 * Given a path to 'target', create all the ancestors between
2981 * the prefixlen portion of the path, and the target itself.
2982 * Fail if the initial prefixlen-ancestor does not already exist.
2985 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
2991 /* make sure prefix exists */
2992 cp = target + prefixlen;
2994 assert(strchr(cp, '/') == NULL);
2995 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2998 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3006 * Attempt to create, mount, and share any ancestor filesystems,
3007 * up to the prefixlen-long one.
3009 for (cp = target + prefixlen + 1;
3010 cp = strchr(cp, '/'); *cp = '/', cp++) {
3014 h = make_dataset_handle(hdl, target);
3016 /* it already exists, nothing to do here */
3021 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
3023 opname = dgettext(TEXT_DOMAIN, "create");
3027 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3029 opname = dgettext(TEXT_DOMAIN, "open");
3033 if (zfs_mount(h, NULL, 0) != 0) {
3034 opname = dgettext(TEXT_DOMAIN, "mount");
3038 if (zfs_share(h) != 0) {
3039 opname = dgettext(TEXT_DOMAIN, "share");
3049 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3050 "failed to %s ancestor '%s'"), opname, target);
3055 * Creates non-existing ancestors of the given path.
3058 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
3064 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
3067 if ((path_copy = strdup(path)) != NULL) {
3068 rc = create_parents(hdl, path_copy, prefix);
3071 if (path_copy == NULL || rc != 0)
3078 * Create a new filesystem or volume.
3081 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
3086 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
3089 dmu_objset_type_t ost;
3091 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3092 "cannot create '%s'"), path);
3094 /* validate the path, taking care to note the extended error message */
3095 if (!zfs_validate_name(hdl, path, type, B_TRUE))
3096 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3098 /* validate parents exist */
3099 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
3103 * The failure modes when creating a dataset of a different type over
3104 * one that already exists is a little strange. In particular, if you
3105 * try to create a dataset on top of an existing dataset, the ioctl()
3106 * will return ENOENT, not EEXIST. To prevent this from happening, we
3107 * first try to see if the dataset exists.
3109 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
3110 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3111 "dataset already exists"));
3112 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3115 if (type == ZFS_TYPE_VOLUME)
3120 if (props && (props = zfs_valid_proplist(hdl, type, props,
3121 zoned, NULL, errbuf)) == 0)
3124 if (type == ZFS_TYPE_VOLUME) {
3126 * If we are creating a volume, the size and block size must
3127 * satisfy a few restraints. First, the blocksize must be a
3128 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3129 * volsize must be a multiple of the block size, and cannot be
3132 if (props == NULL || nvlist_lookup_uint64(props,
3133 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3135 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3136 "missing volume size"));
3137 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3140 if ((ret = nvlist_lookup_uint64(props,
3141 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3142 &blocksize)) != 0) {
3143 if (ret == ENOENT) {
3144 blocksize = zfs_prop_default_numeric(
3145 ZFS_PROP_VOLBLOCKSIZE);
3148 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3149 "missing volume block size"));
3150 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3156 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3157 "volume size cannot be zero"));
3158 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3161 if (size % blocksize != 0) {
3163 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3164 "volume size must be a multiple of volume block "
3166 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3170 /* create the dataset */
3171 ret = lzc_create(path, ost, props);
3174 /* check for failure */
3176 char parent[ZFS_MAXNAMELEN];
3177 (void) parent_name(path, parent, sizeof (parent));
3181 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3182 "no such parent '%s'"), parent);
3183 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3186 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3187 "parent '%s' is not a filesystem"), parent);
3188 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3191 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3192 "volume block size must be power of 2 from "
3194 (uint_t)SPA_MINBLOCKSIZE,
3195 (uint_t)SPA_MAXBLOCKSIZE >> 10);
3197 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3200 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3201 "pool must be upgraded to set this "
3202 "property or value"));
3203 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3207 * This platform can't address a volume this big.
3209 if (type == ZFS_TYPE_VOLUME)
3210 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3215 return (zfs_standard_error(hdl, errno, errbuf));
3223 * Destroys the given dataset. The caller must make sure that the filesystem
3224 * isn't mounted, and that there are no active dependents. If the file system
3225 * does not exist this function does nothing.
3228 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3230 zfs_cmd_t zc = { 0 };
3232 if (zhp->zfs_type == ZFS_TYPE_BOOKMARK) {
3233 nvlist_t *nv = fnvlist_alloc();
3234 fnvlist_add_boolean(nv, zhp->zfs_name);
3235 int error = lzc_destroy_bookmarks(nv, NULL);
3238 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3239 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3245 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3247 if (ZFS_IS_VOLUME(zhp)) {
3248 zc.zc_objset_type = DMU_OST_ZVOL;
3250 zc.zc_objset_type = DMU_OST_ZFS;
3253 zc.zc_defer_destroy = defer;
3254 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0 &&
3256 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3257 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3261 remove_mountpoint(zhp);
3266 struct destroydata {
3268 const char *snapname;
3272 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3274 struct destroydata *dd = arg;
3275 char name[ZFS_MAXNAMELEN];
3278 (void) snprintf(name, sizeof (name),
3279 "%s@%s", zhp->zfs_name, dd->snapname);
3281 if (lzc_exists(name))
3282 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3284 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3290 * Destroys all snapshots with the given name in zhp & descendants.
3293 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3296 struct destroydata dd = { 0 };
3298 dd.snapname = snapname;
3299 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3300 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3302 if (nvlist_empty(dd.nvl)) {
3303 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3304 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3305 zhp->zfs_name, snapname);
3307 ret = zfs_destroy_snaps_nvl(zhp->zfs_hdl, dd.nvl, defer);
3309 nvlist_free(dd.nvl);
3314 * Destroys all the snapshots named in the nvlist.
3317 zfs_destroy_snaps_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, boolean_t defer)
3322 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3327 if (nvlist_empty(errlist)) {
3329 (void) snprintf(errbuf, sizeof (errbuf),
3330 dgettext(TEXT_DOMAIN, "cannot destroy snapshots"));
3332 ret = zfs_standard_error(hdl, ret, errbuf);
3334 for (nvpair_t *pair = nvlist_next_nvpair(errlist, NULL);
3335 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3337 (void) snprintf(errbuf, sizeof (errbuf),
3338 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3341 switch (fnvpair_value_int32(pair)) {
3344 dgettext(TEXT_DOMAIN, "snapshot is cloned"));
3345 ret = zfs_error(hdl, EZFS_EXISTS, errbuf);
3348 ret = zfs_standard_error(hdl, errno, errbuf);
3357 * Clones the given dataset. The target must be of the same type as the source.
3360 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3362 char parent[ZFS_MAXNAMELEN];
3365 libzfs_handle_t *hdl = zhp->zfs_hdl;
3368 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3370 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3371 "cannot create '%s'"), target);
3373 /* validate the target/clone name */
3374 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3375 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3377 /* validate parents exist */
3378 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3381 (void) parent_name(target, parent, sizeof (parent));
3387 if (ZFS_IS_VOLUME(zhp)) {
3388 type = ZFS_TYPE_VOLUME;
3390 type = ZFS_TYPE_FILESYSTEM;
3392 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3393 zhp, errbuf)) == NULL)
3397 ret = lzc_clone(target, zhp->zfs_name, props);
3405 * The parent doesn't exist. We should have caught this
3406 * above, but there may a race condition that has since
3407 * destroyed the parent.
3409 * At this point, we don't know whether it's the source
3410 * that doesn't exist anymore, or whether the target
3411 * dataset doesn't exist.
3413 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3414 "no such parent '%s'"), parent);
3415 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3418 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3419 "source and target pools differ"));
3420 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3424 return (zfs_standard_error(zhp->zfs_hdl, errno,
3433 * Promotes the given clone fs to be the clone parent.
3436 zfs_promote(zfs_handle_t *zhp)
3438 libzfs_handle_t *hdl = zhp->zfs_hdl;
3439 zfs_cmd_t zc = { 0 };
3440 char parent[MAXPATHLEN];
3444 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3445 "cannot promote '%s'"), zhp->zfs_name);
3447 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3448 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3449 "snapshots can not be promoted"));
3450 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3453 (void) strlcpy(parent, zhp->zfs_dmustats.dds_origin, sizeof (parent));
3454 if (parent[0] == '\0') {
3455 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3456 "not a cloned filesystem"));
3457 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3460 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_origin,
3461 sizeof (zc.zc_value));
3462 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3463 ret = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc);
3466 int save_errno = errno;
3468 switch (save_errno) {
3470 /* There is a conflicting snapshot name. */
3471 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3472 "conflicting snapshot '%s' from parent '%s'"),
3473 zc.zc_string, parent);
3474 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3477 return (zfs_standard_error(hdl, save_errno, errbuf));
3483 typedef struct snapdata {
3485 const char *sd_snapname;
3489 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
3491 snapdata_t *sd = arg;
3492 char name[ZFS_MAXNAMELEN];
3495 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) == 0) {
3496 (void) snprintf(name, sizeof (name),
3497 "%s@%s", zfs_get_name(zhp), sd->sd_snapname);
3499 fnvlist_add_boolean(sd->sd_nvl, name);
3501 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
3509 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3513 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
3520 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3521 "cannot create snapshots "));
3524 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
3525 const char *snapname = nvpair_name(elem);
3527 /* validate the target name */
3528 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
3530 (void) snprintf(errbuf, sizeof (errbuf),
3531 dgettext(TEXT_DOMAIN,
3532 "cannot create snapshot '%s'"), snapname);
3533 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3537 if (props != NULL &&
3538 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3539 props, B_FALSE, NULL, errbuf)) == NULL) {
3543 ret = lzc_snapshot(snaps, props, &errors);
3546 boolean_t printed = B_FALSE;
3547 for (elem = nvlist_next_nvpair(errors, NULL);
3549 elem = nvlist_next_nvpair(errors, elem)) {
3550 (void) snprintf(errbuf, sizeof (errbuf),
3551 dgettext(TEXT_DOMAIN,
3552 "cannot create snapshot '%s'"), nvpair_name(elem));
3553 (void) zfs_standard_error(hdl,
3554 fnvpair_value_int32(elem), errbuf);
3560 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3561 "multiple snapshots of same "
3563 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3567 (void) zfs_standard_error(hdl, ret, errbuf);
3573 nvlist_free(errors);
3578 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3582 snapdata_t sd = { 0 };
3583 char fsname[ZFS_MAXNAMELEN];
3588 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3589 "cannot snapshot %s"), path);
3591 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3592 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3594 (void) strlcpy(fsname, path, sizeof (fsname));
3595 cp = strchr(fsname, '@');
3597 sd.sd_snapname = cp + 1;
3599 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
3600 ZFS_TYPE_VOLUME)) == NULL) {
3604 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
3606 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
3608 fnvlist_add_boolean(sd.sd_nvl, path);
3611 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
3612 nvlist_free(sd.sd_nvl);
3618 * Destroy any more recent snapshots. We invoke this callback on any dependents
3619 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3620 * is a dependent and we should just destroy it without checking the transaction
3623 typedef struct rollback_data {
3624 const char *cb_target; /* the snapshot */
3625 uint64_t cb_create; /* creation time reference */
3631 rollback_destroy_dependent(zfs_handle_t *zhp, void *data)
3633 rollback_data_t *cbp = data;
3634 prop_changelist_t *clp;
3636 /* We must destroy this clone; first unmount it */
3637 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3638 cbp->cb_force ? MS_FORCE: 0);
3639 if (clp == NULL || changelist_prefix(clp) != 0) {
3640 cbp->cb_error = B_TRUE;
3644 if (zfs_destroy(zhp, B_FALSE) != 0)
3645 cbp->cb_error = B_TRUE;
3647 changelist_remove(clp, zhp->zfs_name);
3648 (void) changelist_postfix(clp);
3649 changelist_free(clp);
3656 rollback_destroy(zfs_handle_t *zhp, void *data)
3658 rollback_data_t *cbp = data;
3660 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > cbp->cb_create) {
3661 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3662 rollback_destroy_dependent, cbp);
3664 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3672 * Given a dataset, rollback to a specific snapshot, discarding any
3673 * data changes since then and making it the active dataset.
3675 * Any snapshots and bookmarks more recent than the target are
3676 * destroyed, along with their dependents (i.e. clones).
3679 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3681 rollback_data_t cb = { 0 };
3683 boolean_t restore_resv = 0;
3684 uint64_t old_volsize, new_volsize;
3685 zfs_prop_t resv_prop;
3687 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3688 zhp->zfs_type == ZFS_TYPE_VOLUME);
3691 * Destroy all recent snapshots and their dependents.
3693 cb.cb_force = force;
3694 cb.cb_target = snap->zfs_name;
3695 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3696 (void) zfs_iter_snapshots(zhp, B_FALSE, rollback_destroy, &cb);
3697 (void) zfs_iter_bookmarks(zhp, rollback_destroy, &cb);
3703 * Now that we have verified that the snapshot is the latest,
3704 * rollback to the given snapshot.
3707 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
3708 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
3710 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3712 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
3716 * We rely on zfs_iter_children() to verify that there are no
3717 * newer snapshots for the given dataset. Therefore, we can
3718 * simply pass the name on to the ioctl() call. There is still
3719 * an unlikely race condition where the user has taken a
3720 * snapshot since we verified that this was the most recent.
3722 err = lzc_rollback(zhp->zfs_name, NULL, 0);
3724 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3725 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
3731 * For volumes, if the pre-rollback volsize matched the pre-
3732 * rollback reservation and the volsize has changed then set
3733 * the reservation property to the post-rollback volsize.
3734 * Make a new handle since the rollback closed the dataset.
3736 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
3737 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
3739 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3740 if (old_volsize != new_volsize)
3741 err = zfs_prop_set_int(zhp, resv_prop,
3750 * Renames the given dataset.
3753 zfs_rename(zfs_handle_t *zhp, const char *source, const char *target,
3754 renameflags_t flags)
3757 zfs_cmd_t zc = { 0 };
3759 prop_changelist_t *cl = NULL;
3760 zfs_handle_t *zhrp = NULL;
3761 char *parentname = NULL;
3762 char parent[ZFS_MAXNAMELEN];
3763 char property[ZFS_MAXPROPLEN];
3764 libzfs_handle_t *hdl = zhp->zfs_hdl;
3767 /* if we have the same exact name, just return success */
3768 if (strcmp(zhp->zfs_name, target) == 0)
3771 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3772 "cannot rename to '%s'"), target);
3774 if (source != NULL) {
3776 * This is recursive snapshots rename, put snapshot name
3777 * (that might not exist) into zfs_name.
3779 assert(flags.recurse);
3781 (void) strlcat(zhp->zfs_name, "@", sizeof(zhp->zfs_name));
3782 (void) strlcat(zhp->zfs_name, source, sizeof(zhp->zfs_name));
3783 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
3787 * Make sure the target name is valid
3789 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3790 if ((strchr(target, '@') == NULL) ||
3793 * Snapshot target name is abbreviated,
3794 * reconstruct full dataset name
3796 (void) strlcpy(parent, zhp->zfs_name,
3798 delim = strchr(parent, '@');
3799 if (strchr(target, '@') == NULL)
3803 (void) strlcat(parent, target, sizeof (parent));
3807 * Make sure we're renaming within the same dataset.
3809 delim = strchr(target, '@');
3810 if (strncmp(zhp->zfs_name, target, delim - target)
3811 != 0 || zhp->zfs_name[delim - target] != '@') {
3812 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3813 "snapshots must be part of same "
3815 return (zfs_error(hdl, EZFS_CROSSTARGET,
3819 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3820 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3822 if (flags.recurse) {
3823 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3824 "recursive rename must be a snapshot"));
3825 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3828 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3829 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3831 /* validate parents */
3832 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
3835 /* make sure we're in the same pool */
3836 verify((delim = strchr(target, '/')) != NULL);
3837 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
3838 zhp->zfs_name[delim - target] != '/') {
3839 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3840 "datasets must be within same pool"));
3841 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
3844 /* new name cannot be a child of the current dataset name */
3845 if (is_descendant(zhp->zfs_name, target)) {
3846 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3847 "New dataset name cannot be a descendant of "
3848 "current dataset name"));
3849 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3853 (void) snprintf(errbuf, sizeof (errbuf),
3854 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
3856 if (getzoneid() == GLOBAL_ZONEID &&
3857 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
3858 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3859 "dataset is used in a non-global zone"));
3860 return (zfs_error(hdl, EZFS_ZONED, errbuf));
3864 * Avoid unmounting file systems with mountpoint property set to
3865 * 'legacy' or 'none' even if -u option is not given.
3867 if (zhp->zfs_type == ZFS_TYPE_FILESYSTEM &&
3868 !flags.recurse && !flags.nounmount &&
3869 zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, property,
3870 sizeof (property), NULL, NULL, 0, B_FALSE) == 0 &&
3871 (strcmp(property, "legacy") == 0 ||
3872 strcmp(property, "none") == 0)) {
3873 flags.nounmount = B_TRUE;
3876 if (flags.recurse) {
3878 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
3879 if (parentname == NULL) {
3883 delim = strchr(parentname, '@');
3885 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
3892 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME,
3893 flags.nounmount ? CL_GATHER_DONT_UNMOUNT : 0,
3894 flags.forceunmount ? MS_FORCE : 0)) == NULL) {
3898 if (changelist_haszonedchild(cl)) {
3899 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3900 "child dataset with inherited mountpoint is used "
3901 "in a non-global zone"));
3902 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
3906 if ((ret = changelist_prefix(cl)) != 0)
3910 if (ZFS_IS_VOLUME(zhp))
3911 zc.zc_objset_type = DMU_OST_ZVOL;
3913 zc.zc_objset_type = DMU_OST_ZFS;
3915 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3916 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
3918 zc.zc_cookie = flags.recurse ? 1 : 0;
3919 if (flags.nounmount)
3922 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
3924 * if it was recursive, the one that actually failed will
3927 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3928 "cannot rename '%s'"), zc.zc_name);
3930 if (flags.recurse && errno == EEXIST) {
3931 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3932 "a child dataset already has a snapshot "
3933 "with the new name"));
3934 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3936 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
3940 * On failure, we still want to remount any filesystems that
3941 * were previously mounted, so we don't alter the system state.
3944 (void) changelist_postfix(cl);
3946 if (!flags.recurse) {
3947 changelist_rename(cl, zfs_get_name(zhp), target);
3948 ret = changelist_postfix(cl);
3960 changelist_free(cl);
3966 zfs_get_user_props(zfs_handle_t *zhp)
3968 return (zhp->zfs_user_props);
3972 zfs_get_recvd_props(zfs_handle_t *zhp)
3974 if (zhp->zfs_recvd_props == NULL)
3975 if (get_recvd_props_ioctl(zhp) != 0)
3977 return (zhp->zfs_recvd_props);
3981 * This function is used by 'zfs list' to determine the exact set of columns to
3982 * display, and their maximum widths. This does two main things:
3984 * - If this is a list of all properties, then expand the list to include
3985 * all native properties, and set a flag so that for each dataset we look
3986 * for new unique user properties and add them to the list.
3988 * - For non fixed-width properties, keep track of the maximum width seen
3989 * so that we can size the column appropriately. If the user has
3990 * requested received property values, we also need to compute the width
3991 * of the RECEIVED column.
3994 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received,
3997 libzfs_handle_t *hdl = zhp->zfs_hdl;
3998 zprop_list_t *entry;
3999 zprop_list_t **last, **start;
4000 nvlist_t *userprops, *propval;
4003 char buf[ZFS_MAXPROPLEN];
4005 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
4008 userprops = zfs_get_user_props(zhp);
4011 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
4013 * Go through and add any user properties as necessary. We
4014 * start by incrementing our list pointer to the first
4015 * non-native property.
4018 while (*start != NULL) {
4019 if ((*start)->pl_prop == ZPROP_INVAL)
4021 start = &(*start)->pl_next;
4025 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
4027 * See if we've already found this property in our list.
4029 for (last = start; *last != NULL;
4030 last = &(*last)->pl_next) {
4031 if (strcmp((*last)->pl_user_prop,
4032 nvpair_name(elem)) == 0)
4036 if (*last == NULL) {
4037 if ((entry = zfs_alloc(hdl,
4038 sizeof (zprop_list_t))) == NULL ||
4039 ((entry->pl_user_prop = zfs_strdup(hdl,
4040 nvpair_name(elem)))) == NULL) {
4045 entry->pl_prop = ZPROP_INVAL;
4046 entry->pl_width = strlen(nvpair_name(elem));
4047 entry->pl_all = B_TRUE;
4054 * Now go through and check the width of any non-fixed columns
4056 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
4057 if (entry->pl_fixed && !literal)
4060 if (entry->pl_prop != ZPROP_INVAL) {
4061 if (zfs_prop_get(zhp, entry->pl_prop,
4062 buf, sizeof (buf), NULL, NULL, 0, literal) == 0) {
4063 if (strlen(buf) > entry->pl_width)
4064 entry->pl_width = strlen(buf);
4066 if (received && zfs_prop_get_recvd(zhp,
4067 zfs_prop_to_name(entry->pl_prop),
4068 buf, sizeof (buf), literal) == 0)
4069 if (strlen(buf) > entry->pl_recvd_width)
4070 entry->pl_recvd_width = strlen(buf);
4072 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
4074 verify(nvlist_lookup_string(propval,
4075 ZPROP_VALUE, &strval) == 0);
4076 if (strlen(strval) > entry->pl_width)
4077 entry->pl_width = strlen(strval);
4079 if (received && zfs_prop_get_recvd(zhp,
4080 entry->pl_user_prop,
4081 buf, sizeof (buf), literal) == 0)
4082 if (strlen(buf) > entry->pl_recvd_width)
4083 entry->pl_recvd_width = strlen(buf);
4091 zfs_deleg_share_nfs(libzfs_handle_t *hdl, char *dataset, char *path,
4092 char *resource, void *export, void *sharetab,
4093 int sharemax, zfs_share_op_t operation)
4095 zfs_cmd_t zc = { 0 };
4098 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4099 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4101 (void) strlcpy(zc.zc_string, resource, sizeof (zc.zc_string));
4102 zc.zc_share.z_sharedata = (uint64_t)(uintptr_t)sharetab;
4103 zc.zc_share.z_exportdata = (uint64_t)(uintptr_t)export;
4104 zc.zc_share.z_sharetype = operation;
4105 zc.zc_share.z_sharemax = sharemax;
4106 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SHARE, &zc);
4111 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
4116 * Keep a reference to the props-table against which we prune the
4119 zhp->zfs_props_table = props;
4121 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
4124 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
4125 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
4128 * User properties will result in ZPROP_INVAL, and since we
4129 * only know how to prune standard ZFS properties, we always
4130 * leave these in the list. This can also happen if we
4131 * encounter an unknown DSL property (when running older
4132 * software, for example).
4134 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
4135 (void) nvlist_remove(zhp->zfs_props,
4136 nvpair_name(curr), nvpair_type(curr));
4143 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
4144 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
4146 zfs_cmd_t zc = { 0 };
4147 nvlist_t *nvlist = NULL;
4150 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4151 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4152 zc.zc_cookie = (uint64_t)cmd;
4154 if (cmd == ZFS_SMB_ACL_RENAME) {
4155 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
4156 (void) no_memory(hdl);
4162 case ZFS_SMB_ACL_ADD:
4163 case ZFS_SMB_ACL_REMOVE:
4164 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4166 case ZFS_SMB_ACL_RENAME:
4167 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4169 (void) no_memory(hdl);
4172 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4174 (void) no_memory(hdl);
4177 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4178 nvlist_free(nvlist);
4182 case ZFS_SMB_ACL_PURGE:
4187 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4189 nvlist_free(nvlist);
4194 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4195 char *path, char *resource)
4197 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4202 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4203 char *path, char *resource)
4205 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4210 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4212 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4217 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4218 char *oldname, char *newname)
4220 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4226 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4227 zfs_userspace_cb_t func, void *arg)
4229 zfs_cmd_t zc = { 0 };
4230 zfs_useracct_t buf[100];
4231 libzfs_handle_t *hdl = zhp->zfs_hdl;
4234 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4236 zc.zc_objset_type = type;
4237 zc.zc_nvlist_dst = (uintptr_t)buf;
4240 zfs_useracct_t *zua = buf;
4242 zc.zc_nvlist_dst_size = sizeof (buf);
4243 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4246 (void) snprintf(errbuf, sizeof (errbuf),
4247 dgettext(TEXT_DOMAIN,
4248 "cannot get used/quota for %s"), zc.zc_name);
4249 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4251 if (zc.zc_nvlist_dst_size == 0)
4254 while (zc.zc_nvlist_dst_size > 0) {
4255 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4256 zua->zu_space)) != 0)
4259 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4268 const char *snapname;
4270 boolean_t recursive;
4275 zfs_hold_one(zfs_handle_t *zhp, void *arg)
4277 struct holdarg *ha = arg;
4278 char name[ZFS_MAXNAMELEN];
4281 (void) snprintf(name, sizeof (name),
4282 "%s@%s", zhp->zfs_name, ha->snapname);
4284 if (lzc_exists(name))
4285 fnvlist_add_string(ha->nvl, name, ha->tag);
4288 rv = zfs_iter_filesystems(zhp, zfs_hold_one, ha);
4294 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4295 boolean_t recursive, int cleanup_fd)
4300 ha.nvl = fnvlist_alloc();
4301 ha.snapname = snapname;
4303 ha.recursive = recursive;
4304 (void) zfs_hold_one(zfs_handle_dup(zhp), &ha);
4306 if (nvlist_empty(ha.nvl)) {
4309 fnvlist_free(ha.nvl);
4311 (void) snprintf(errbuf, sizeof (errbuf),
4312 dgettext(TEXT_DOMAIN,
4313 "cannot hold snapshot '%s@%s'"),
4314 zhp->zfs_name, snapname);
4315 (void) zfs_standard_error(zhp->zfs_hdl, ret, errbuf);
4319 ret = zfs_hold_nvl(zhp, cleanup_fd, ha.nvl);
4320 fnvlist_free(ha.nvl);
4326 zfs_hold_nvl(zfs_handle_t *zhp, int cleanup_fd, nvlist_t *holds)
4330 libzfs_handle_t *hdl = zhp->zfs_hdl;
4335 ret = lzc_hold(holds, cleanup_fd, &errors);
4338 /* There may be errors even in the success case. */
4339 fnvlist_free(errors);
4343 if (nvlist_empty(errors)) {
4344 /* no hold-specific errors */
4345 (void) snprintf(errbuf, sizeof (errbuf),
4346 dgettext(TEXT_DOMAIN, "cannot hold"));
4349 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4350 "pool must be upgraded"));
4351 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4354 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4357 (void) zfs_standard_error(hdl, ret, errbuf);
4361 for (elem = nvlist_next_nvpair(errors, NULL);
4363 elem = nvlist_next_nvpair(errors, elem)) {
4364 (void) snprintf(errbuf, sizeof (errbuf),
4365 dgettext(TEXT_DOMAIN,
4366 "cannot hold snapshot '%s'"), nvpair_name(elem));
4367 switch (fnvpair_value_int32(elem)) {
4370 * Temporary tags wind up having the ds object id
4371 * prepended. So even if we passed the length check
4372 * above, it's still possible for the tag to wind
4373 * up being slightly too long.
4375 (void) zfs_error(hdl, EZFS_TAGTOOLONG, errbuf);
4378 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4381 (void) zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf);
4384 (void) zfs_standard_error(hdl,
4385 fnvpair_value_int32(elem), errbuf);
4389 fnvlist_free(errors);
4394 zfs_release_one(zfs_handle_t *zhp, void *arg)
4396 struct holdarg *ha = arg;
4397 char name[ZFS_MAXNAMELEN];
4399 nvlist_t *existing_holds;
4401 (void) snprintf(name, sizeof (name),
4402 "%s@%s", zhp->zfs_name, ha->snapname);
4404 if (lzc_get_holds(name, &existing_holds) != 0) {
4406 } else if (!nvlist_exists(existing_holds, ha->tag)) {
4409 nvlist_t *torelease = fnvlist_alloc();
4410 fnvlist_add_boolean(torelease, ha->tag);
4411 fnvlist_add_nvlist(ha->nvl, name, torelease);
4412 fnvlist_free(torelease);
4416 rv = zfs_iter_filesystems(zhp, zfs_release_one, ha);
4422 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4423 boolean_t recursive)
4427 nvlist_t *errors = NULL;
4429 libzfs_handle_t *hdl = zhp->zfs_hdl;
4432 ha.nvl = fnvlist_alloc();
4433 ha.snapname = snapname;
4435 ha.recursive = recursive;
4437 (void) zfs_release_one(zfs_handle_dup(zhp), &ha);
4439 if (nvlist_empty(ha.nvl)) {
4440 fnvlist_free(ha.nvl);
4442 (void) snprintf(errbuf, sizeof (errbuf),
4443 dgettext(TEXT_DOMAIN,
4444 "cannot release hold from snapshot '%s@%s'"),
4445 zhp->zfs_name, snapname);
4447 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4449 (void) zfs_standard_error(hdl, ret, errbuf);
4454 ret = lzc_release(ha.nvl, &errors);
4455 fnvlist_free(ha.nvl);
4458 /* There may be errors even in the success case. */
4459 fnvlist_free(errors);
4463 if (nvlist_empty(errors)) {
4464 /* no hold-specific errors */
4465 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4469 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4470 "pool must be upgraded"));
4471 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4474 (void) zfs_standard_error_fmt(hdl, errno, 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 release hold from snapshot '%s'"),
4485 switch (fnvpair_value_int32(elem)) {
4487 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4490 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4493 (void) zfs_standard_error_fmt(hdl,
4494 fnvpair_value_int32(elem), errbuf);
4498 fnvlist_free(errors);
4503 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4505 zfs_cmd_t zc = { 0 };
4506 libzfs_handle_t *hdl = zhp->zfs_hdl;
4512 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4513 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4517 nvbuf = malloc(nvsz);
4518 if (nvbuf == NULL) {
4519 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4523 zc.zc_nvlist_dst_size = nvsz;
4524 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4526 (void) strlcpy(zc.zc_name, zhp->zfs_name, ZFS_MAXNAMELEN);
4528 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4529 (void) snprintf(errbuf, sizeof (errbuf),
4530 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4535 nvsz = zc.zc_nvlist_dst_size;
4539 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4540 "pool must be upgraded"));
4541 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4544 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4547 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4550 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4555 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4557 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4558 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4560 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4570 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4572 zfs_cmd_t zc = { 0 };
4573 libzfs_handle_t *hdl = zhp->zfs_hdl;
4579 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4580 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4582 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
4585 nvbuf = malloc(nvsz);
4587 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
4590 zc.zc_nvlist_src_size = nvsz;
4591 zc.zc_nvlist_src = (uintptr_t)nvbuf;
4592 zc.zc_perm_action = un;
4594 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4596 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
4597 (void) snprintf(errbuf, sizeof (errbuf),
4598 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
4602 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4603 "pool must be upgraded"));
4604 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4607 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4610 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4613 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4624 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
4629 err = lzc_get_holds(zhp->zfs_name, nvl);
4632 libzfs_handle_t *hdl = zhp->zfs_hdl;
4634 (void) snprintf(errbuf, sizeof (errbuf),
4635 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4639 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4640 "pool must be upgraded"));
4641 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4644 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4647 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4650 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4659 * Convert the zvol's volume size to an appropriate reservation.
4660 * Note: If this routine is updated, it is necessary to update the ZFS test
4661 * suite's shell version in reservation.kshlib.
4664 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4667 uint64_t nblocks, volblocksize;
4671 if (nvlist_lookup_string(props,
4672 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4673 ncopies = atoi(strval);
4676 if (nvlist_lookup_uint64(props,
4677 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4678 &volblocksize) != 0)
4679 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4680 nblocks = volsize/volblocksize;
4681 /* start with metadnode L0-L6 */
4683 /* calculate number of indirects */
4684 while (nblocks > 1) {
4685 nblocks += DNODES_PER_LEVEL - 1;
4686 nblocks /= DNODES_PER_LEVEL;
4689 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4692 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4693 * compressed, but in practice they compress down to about
4696 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;
4702 * Attach/detach the given filesystem to/from the given jail.
4705 zfs_jail(zfs_handle_t *zhp, int jailid, int attach)
4707 libzfs_handle_t *hdl = zhp->zfs_hdl;
4708 zfs_cmd_t zc = { 0 };
4714 (void) snprintf(errbuf, sizeof (errbuf),
4715 dgettext(TEXT_DOMAIN, "cannot jail '%s'"), zhp->zfs_name);
4717 (void) snprintf(errbuf, sizeof (errbuf),
4718 dgettext(TEXT_DOMAIN, "cannot jail '%s'"), zhp->zfs_name);
4721 switch (zhp->zfs_type) {
4722 case ZFS_TYPE_VOLUME:
4723 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4724 "volumes can not be jailed"));
4725 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4726 case ZFS_TYPE_SNAPSHOT:
4727 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4728 "snapshots can not be jailed"));
4729 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4731 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4733 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4734 zc.zc_objset_type = DMU_OST_ZFS;
4735 zc.zc_jailid = jailid;
4737 cmd = attach ? ZFS_IOC_JAIL : ZFS_IOC_UNJAIL;
4738 if ((ret = ioctl(hdl->libzfs_fd, cmd, &zc)) != 0)
4739 zfs_standard_error(hdl, errno, errbuf);