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) 2012 Pawel Jakub Dawidek <pawel@dawidek.net>.
28 * Copyright (c) 2013 Martin Matuska. All rights reserved.
29 * Copyright (c) 2013 Steven Hartland. All rights reserved.
30 * Copyright 2013 Nexenta Systems, Inc. All rights reserved.
44 #include <sys/mntent.h>
45 #include <sys/mount.h>
54 #include <directory.h>
55 #endif /* HAVE_IDMAP */
57 #include <sys/dnode.h>
62 #include "zfs_namecheck.h"
64 #include "libzfs_impl.h"
65 #include "zfs_deleg.h"
67 static int userquota_propname_decode(const char *propname, boolean_t zoned,
68 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
71 * Given a single type (not a mask of types), return the type in a human
75 zfs_type_to_name(zfs_type_t type)
78 case ZFS_TYPE_FILESYSTEM:
79 return (dgettext(TEXT_DOMAIN, "filesystem"));
80 case ZFS_TYPE_SNAPSHOT:
81 return (dgettext(TEXT_DOMAIN, "snapshot"));
83 return (dgettext(TEXT_DOMAIN, "volume"));
92 * Validate a ZFS path. This is used even before trying to open the dataset, to
93 * provide a more meaningful error message. We call zfs_error_aux() to
94 * explain exactly why the name was not valid.
97 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
103 (void) zfs_prop_get_table();
104 if (dataset_namecheck(path, &why, &what) != 0) {
107 case NAME_ERR_TOOLONG:
108 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
109 "name is too long"));
112 case NAME_ERR_LEADING_SLASH:
113 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
114 "leading slash in name"));
117 case NAME_ERR_EMPTY_COMPONENT:
118 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
119 "empty component in name"));
122 case NAME_ERR_TRAILING_SLASH:
123 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
124 "trailing slash in name"));
127 case NAME_ERR_INVALCHAR:
129 dgettext(TEXT_DOMAIN, "invalid character "
130 "'%c' in name"), what);
133 case NAME_ERR_MULTIPLE_AT:
134 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
135 "multiple '@' delimiters in name"));
138 case NAME_ERR_NOLETTER:
139 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
140 "pool doesn't begin with a letter"));
143 case NAME_ERR_RESERVED:
144 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
145 "name is reserved"));
148 case NAME_ERR_DISKLIKE:
149 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
150 "reserved disk name"));
160 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
162 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
163 "snapshot delimiter '@' in filesystem name"));
167 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
169 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
170 "missing '@' delimiter in snapshot name"));
174 if (modifying && strchr(path, '%') != NULL) {
176 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
177 "invalid character %c in name"), '%');
185 zfs_name_valid(const char *name, zfs_type_t type)
187 if (type == ZFS_TYPE_POOL)
188 return (zpool_name_valid(NULL, B_FALSE, name));
189 return (zfs_validate_name(NULL, name, type, B_FALSE));
193 * This function takes the raw DSL properties, and filters out the user-defined
194 * properties into a separate nvlist.
197 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
199 libzfs_handle_t *hdl = zhp->zfs_hdl;
204 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
205 (void) no_memory(hdl);
210 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
211 if (!zfs_prop_user(nvpair_name(elem)))
214 verify(nvpair_value_nvlist(elem, &propval) == 0);
215 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
217 (void) no_memory(hdl);
225 static zpool_handle_t *
226 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
228 libzfs_handle_t *hdl = zhp->zfs_hdl;
231 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
232 if (hdl->libzfs_pool_handles != NULL)
233 zph->zpool_next = hdl->libzfs_pool_handles;
234 hdl->libzfs_pool_handles = zph;
239 static zpool_handle_t *
240 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
242 libzfs_handle_t *hdl = zhp->zfs_hdl;
243 zpool_handle_t *zph = hdl->libzfs_pool_handles;
245 while ((zph != NULL) &&
246 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
247 zph = zph->zpool_next;
252 * Returns a handle to the pool that contains the provided dataset.
253 * If a handle to that pool already exists then that handle is returned.
254 * Otherwise, a new handle is created and added to the list of handles.
256 static zpool_handle_t *
257 zpool_handle(zfs_handle_t *zhp)
263 len = strcspn(zhp->zfs_name, "/@#") + 1;
264 pool_name = zfs_alloc(zhp->zfs_hdl, len);
265 (void) strlcpy(pool_name, zhp->zfs_name, len);
267 zph = zpool_find_handle(zhp, pool_name, len);
269 zph = zpool_add_handle(zhp, pool_name);
276 zpool_free_handles(libzfs_handle_t *hdl)
278 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
280 while (zph != NULL) {
281 next = zph->zpool_next;
285 hdl->libzfs_pool_handles = NULL;
289 * Utility function to gather stats (objset and zpl) for the given object.
292 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
294 libzfs_handle_t *hdl = zhp->zfs_hdl;
296 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
298 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, zc) != 0) {
299 if (errno == ENOMEM) {
300 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
311 * Utility function to get the received properties of the given object.
314 get_recvd_props_ioctl(zfs_handle_t *zhp)
316 libzfs_handle_t *hdl = zhp->zfs_hdl;
317 nvlist_t *recvdprops;
318 zfs_cmd_t zc = {"\0"};
321 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
324 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
326 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
327 if (errno == ENOMEM) {
328 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
332 zcmd_free_nvlists(&zc);
337 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
338 zcmd_free_nvlists(&zc);
342 nvlist_free(zhp->zfs_recvd_props);
343 zhp->zfs_recvd_props = recvdprops;
349 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
351 nvlist_t *allprops, *userprops;
353 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
355 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
360 * XXX Why do we store the user props separately, in addition to
361 * storing them in zfs_props?
363 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
364 nvlist_free(allprops);
368 nvlist_free(zhp->zfs_props);
369 nvlist_free(zhp->zfs_user_props);
371 zhp->zfs_props = allprops;
372 zhp->zfs_user_props = userprops;
378 get_stats(zfs_handle_t *zhp)
381 zfs_cmd_t zc = {"\0"};
383 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
385 if (get_stats_ioctl(zhp, &zc) != 0)
387 else if (put_stats_zhdl(zhp, &zc) != 0)
389 zcmd_free_nvlists(&zc);
394 * Refresh the properties currently stored in the handle.
397 zfs_refresh_properties(zfs_handle_t *zhp)
399 (void) get_stats(zhp);
403 * Makes a handle from the given dataset name. Used by zfs_open() and
404 * zfs_iter_* to create child handles on the fly.
407 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
409 if (put_stats_zhdl(zhp, zc) != 0)
413 * We've managed to open the dataset and gather statistics. Determine
414 * the high-level type.
416 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
417 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
418 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
419 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
420 else if (zhp->zfs_dmustats.dds_type == DMU_OST_OTHER)
425 if (zhp->zfs_dmustats.dds_is_snapshot)
426 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
427 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
428 zhp->zfs_type = ZFS_TYPE_VOLUME;
429 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
430 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
432 abort(); /* we should never see any other types */
434 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
441 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
443 zfs_cmd_t zc = {"\0"};
445 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
451 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
452 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
456 if (get_stats_ioctl(zhp, &zc) == -1) {
457 zcmd_free_nvlists(&zc);
461 if (make_dataset_handle_common(zhp, &zc) == -1) {
465 zcmd_free_nvlists(&zc);
470 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
472 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
478 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
479 if (make_dataset_handle_common(zhp, zc) == -1) {
487 make_dataset_simple_handle_zc(zfs_handle_t *pzhp, zfs_cmd_t *zc)
489 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
494 zhp->zfs_hdl = pzhp->zfs_hdl;
495 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
496 zhp->zfs_head_type = pzhp->zfs_type;
497 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
498 zhp->zpool_hdl = zpool_handle(zhp);
504 zfs_handle_dup(zfs_handle_t *zhp_orig)
506 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
511 zhp->zfs_hdl = zhp_orig->zfs_hdl;
512 zhp->zpool_hdl = zhp_orig->zpool_hdl;
513 (void) strlcpy(zhp->zfs_name, zhp_orig->zfs_name,
514 sizeof (zhp->zfs_name));
515 zhp->zfs_type = zhp_orig->zfs_type;
516 zhp->zfs_head_type = zhp_orig->zfs_head_type;
517 zhp->zfs_dmustats = zhp_orig->zfs_dmustats;
518 if (zhp_orig->zfs_props != NULL) {
519 if (nvlist_dup(zhp_orig->zfs_props, &zhp->zfs_props, 0) != 0) {
520 (void) no_memory(zhp->zfs_hdl);
525 if (zhp_orig->zfs_user_props != NULL) {
526 if (nvlist_dup(zhp_orig->zfs_user_props,
527 &zhp->zfs_user_props, 0) != 0) {
528 (void) no_memory(zhp->zfs_hdl);
533 if (zhp_orig->zfs_recvd_props != NULL) {
534 if (nvlist_dup(zhp_orig->zfs_recvd_props,
535 &zhp->zfs_recvd_props, 0)) {
536 (void) no_memory(zhp->zfs_hdl);
541 zhp->zfs_mntcheck = zhp_orig->zfs_mntcheck;
542 if (zhp_orig->zfs_mntopts != NULL) {
543 zhp->zfs_mntopts = zfs_strdup(zhp_orig->zfs_hdl,
544 zhp_orig->zfs_mntopts);
546 zhp->zfs_props_table = zhp_orig->zfs_props_table;
551 zfs_bookmark_exists(const char *path)
555 char fsname[ZFS_MAXNAMELEN];
562 (void) strlcpy(fsname, path, sizeof (fsname));
563 pound = strchr(fsname, '#');
568 bmark_name = pound + 1;
569 props = fnvlist_alloc();
570 err = lzc_get_bookmarks(fsname, props, &bmarks);
577 rv = nvlist_exists(bmarks, bmark_name);
583 make_bookmark_handle(zfs_handle_t *parent, const char *path,
584 nvlist_t *bmark_props)
586 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
591 /* Fill in the name. */
592 zhp->zfs_hdl = parent->zfs_hdl;
593 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
595 /* Set the property lists. */
596 if (nvlist_dup(bmark_props, &zhp->zfs_props, 0) != 0) {
602 zhp->zfs_head_type = parent->zfs_head_type;
603 zhp->zfs_type = ZFS_TYPE_BOOKMARK;
605 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL) {
606 nvlist_free(zhp->zfs_props);
615 * Opens the given snapshot, filesystem, or volume. The 'types'
616 * argument is a mask of acceptable types. The function will print an
617 * appropriate error message and return NULL if it can't be opened.
620 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
625 (void) snprintf(errbuf, sizeof (errbuf),
626 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
629 * Validate the name before we even try to open it.
631 if (!zfs_validate_name(hdl, path, ZFS_TYPE_DATASET, B_FALSE)) {
632 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
633 "invalid dataset name"));
634 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
639 * Try to get stats for the dataset, which will tell us if it exists.
642 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
643 (void) zfs_standard_error(hdl, errno, errbuf);
647 if (!(types & zhp->zfs_type)) {
648 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
657 * Release a ZFS handle. Nothing to do but free the associated memory.
660 zfs_close(zfs_handle_t *zhp)
662 if (zhp->zfs_mntopts)
663 free(zhp->zfs_mntopts);
664 nvlist_free(zhp->zfs_props);
665 nvlist_free(zhp->zfs_user_props);
666 nvlist_free(zhp->zfs_recvd_props);
670 typedef struct mnttab_node {
671 struct mnttab mtn_mt;
676 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
678 const mnttab_node_t *mtn1 = arg1;
679 const mnttab_node_t *mtn2 = arg2;
682 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
686 return (rv > 0 ? 1 : -1);
690 libzfs_mnttab_init(libzfs_handle_t *hdl)
692 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
693 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
694 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
698 libzfs_mnttab_update(libzfs_handle_t *hdl)
702 /* Reopen MNTTAB to prevent reading stale data from open file */
703 if (freopen(MNTTAB, "r", hdl->libzfs_mnttab) == NULL)
706 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
710 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
713 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
714 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
715 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
716 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
717 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
719 /* Exclude duplicate mounts */
720 if (avl_find(&hdl->libzfs_mnttab_cache, mtn, &where) != NULL) {
721 free(mtn->mtn_mt.mnt_special);
722 free(mtn->mtn_mt.mnt_mountp);
723 free(mtn->mtn_mt.mnt_fstype);
724 free(mtn->mtn_mt.mnt_mntopts);
729 avl_add(&hdl->libzfs_mnttab_cache, mtn);
736 libzfs_mnttab_fini(libzfs_handle_t *hdl)
741 while ((mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie))) {
742 free(mtn->mtn_mt.mnt_special);
743 free(mtn->mtn_mt.mnt_mountp);
744 free(mtn->mtn_mt.mnt_fstype);
745 free(mtn->mtn_mt.mnt_mntopts);
748 avl_destroy(&hdl->libzfs_mnttab_cache);
752 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
754 hdl->libzfs_mnttab_enable = enable;
758 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
759 struct mnttab *entry)
765 if (!hdl->libzfs_mnttab_enable) {
766 struct mnttab srch = { 0 };
768 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
769 libzfs_mnttab_fini(hdl);
771 /* Reopen MNTTAB to prevent reading stale data from open file */
772 if (freopen(MNTTAB, "r", hdl->libzfs_mnttab) == NULL)
775 srch.mnt_special = (char *)fsname;
776 srch.mnt_fstype = MNTTYPE_ZFS;
777 if (getmntany(hdl->libzfs_mnttab, entry, &srch) == 0)
783 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
784 if ((error = libzfs_mnttab_update(hdl)) != 0)
787 find.mtn_mt.mnt_special = (char *)fsname;
788 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
790 *entry = mtn->mtn_mt;
797 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
798 const char *mountp, const char *mntopts)
802 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
804 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
805 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
806 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
807 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
808 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
809 avl_add(&hdl->libzfs_mnttab_cache, mtn);
813 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
818 find.mtn_mt.mnt_special = (char *)fsname;
819 if ((ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL))) {
820 avl_remove(&hdl->libzfs_mnttab_cache, ret);
821 free(ret->mtn_mt.mnt_special);
822 free(ret->mtn_mt.mnt_mountp);
823 free(ret->mtn_mt.mnt_fstype);
824 free(ret->mtn_mt.mnt_mntopts);
830 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
832 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
834 if (zpool_handle == NULL)
837 *spa_version = zpool_get_prop_int(zpool_handle,
838 ZPOOL_PROP_VERSION, NULL);
843 * The choice of reservation property depends on the SPA version.
846 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
850 if (zfs_spa_version(zhp, &spa_version) < 0)
853 if (spa_version >= SPA_VERSION_REFRESERVATION)
854 *resv_prop = ZFS_PROP_REFRESERVATION;
856 *resv_prop = ZFS_PROP_RESERVATION;
862 * Given an nvlist of properties to set, validates that they are correct, and
863 * parses any numeric properties (index, boolean, etc) if they are specified as
867 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
868 uint64_t zoned, zfs_handle_t *zhp, const char *errbuf)
875 int chosen_normal = -1;
878 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
879 (void) no_memory(hdl);
884 * Make sure this property is valid and applies to this type.
888 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
889 const char *propname = nvpair_name(elem);
891 prop = zfs_name_to_prop(propname);
892 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
894 * This is a user property: make sure it's a
895 * string, and that it's less than ZAP_MAXNAMELEN.
897 if (nvpair_type(elem) != DATA_TYPE_STRING) {
898 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
899 "'%s' must be a string"), propname);
900 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
904 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
905 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
906 "property name '%s' is too long"),
908 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
912 (void) nvpair_value_string(elem, &strval);
913 if (nvlist_add_string(ret, propname, strval) != 0) {
914 (void) no_memory(hdl);
921 * Currently, only user properties can be modified on
924 if (type == ZFS_TYPE_SNAPSHOT) {
925 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
926 "this property can not be modified for snapshots"));
927 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
931 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
932 zfs_userquota_prop_t uqtype;
933 char newpropname[128];
938 if (userquota_propname_decode(propname, zoned,
939 &uqtype, domain, sizeof (domain), &rid) != 0) {
941 dgettext(TEXT_DOMAIN,
942 "'%s' has an invalid user/group name"),
944 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
948 if (uqtype != ZFS_PROP_USERQUOTA &&
949 uqtype != ZFS_PROP_GROUPQUOTA) {
951 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
953 (void) zfs_error(hdl, EZFS_PROPREADONLY,
958 if (nvpair_type(elem) == DATA_TYPE_STRING) {
959 (void) nvpair_value_string(elem, &strval);
960 if (strcmp(strval, "none") == 0) {
962 } else if (zfs_nicestrtonum(hdl,
963 strval, &intval) != 0) {
964 (void) zfs_error(hdl,
965 EZFS_BADPROP, errbuf);
968 } else if (nvpair_type(elem) ==
970 (void) nvpair_value_uint64(elem, &intval);
972 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
973 "use 'none' to disable "
974 "userquota/groupquota"));
978 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
979 "'%s' must be a number"), propname);
980 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
985 * Encode the prop name as
986 * userquota@<hex-rid>-domain, to make it easy
987 * for the kernel to decode.
989 (void) snprintf(newpropname, sizeof (newpropname),
990 "%s%llx-%s", zfs_userquota_prop_prefixes[uqtype],
991 (longlong_t)rid, domain);
995 if (nvlist_add_uint64_array(ret, newpropname,
997 (void) no_memory(hdl);
1001 } else if (prop == ZPROP_INVAL && zfs_prop_written(propname)) {
1002 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1003 "'%s' is readonly"),
1005 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1009 if (prop == ZPROP_INVAL) {
1010 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1011 "invalid property '%s'"), propname);
1012 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1016 if (!zfs_prop_valid_for_type(prop, type, B_FALSE)) {
1018 dgettext(TEXT_DOMAIN, "'%s' does not "
1019 "apply to datasets of this type"), propname);
1020 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1024 if (zfs_prop_readonly(prop) &&
1025 (!zfs_prop_setonce(prop) || zhp != NULL)) {
1027 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1029 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1033 if (zprop_parse_value(hdl, elem, prop, type, ret,
1034 &strval, &intval, errbuf) != 0)
1038 * Perform some additional checks for specific properties.
1041 case ZFS_PROP_VERSION:
1047 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1048 if (intval < version) {
1049 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1050 "Can not downgrade; already at version %u"),
1052 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1058 case ZFS_PROP_RECORDSIZE:
1059 case ZFS_PROP_VOLBLOCKSIZE:
1060 /* must be power of two within SPA_{MIN,MAX}BLOCKSIZE */
1061 if (intval < SPA_MINBLOCKSIZE ||
1062 intval > SPA_MAXBLOCKSIZE || !ISP2(intval)) {
1063 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1064 "'%s' must be power of 2 from %u "
1065 "to %uk"), propname,
1066 (uint_t)SPA_MINBLOCKSIZE,
1067 (uint_t)SPA_MAXBLOCKSIZE >> 10);
1068 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1073 case ZFS_PROP_MLSLABEL:
1075 #ifdef HAVE_MLSLABEL
1077 * Verify the mlslabel string and convert to
1078 * internal hex label string.
1082 char *hex = NULL; /* internal label string */
1084 /* Default value is already OK. */
1085 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
1088 /* Verify the label can be converted to binary form */
1089 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
1090 (str_to_label(strval, &new_sl, MAC_LABEL,
1091 L_NO_CORRECTION, NULL) == -1)) {
1095 /* Now translate to hex internal label string */
1096 if (label_to_str(new_sl, &hex, M_INTERNAL,
1102 m_label_free(new_sl);
1104 /* If string is already in internal form, we're done. */
1105 if (strcmp(strval, hex) == 0) {
1110 /* Replace the label string with the internal form. */
1111 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
1113 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
1120 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1121 "invalid mlslabel '%s'"), strval);
1122 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1123 m_label_free(new_sl); /* OK if null */
1126 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1127 "mlslabels are unsupported"));
1128 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1130 #endif /* HAVE_MLSLABEL */
1133 case ZFS_PROP_MOUNTPOINT:
1135 namecheck_err_t why;
1137 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1138 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1141 if (mountpoint_namecheck(strval, &why)) {
1143 case NAME_ERR_LEADING_SLASH:
1145 dgettext(TEXT_DOMAIN,
1146 "'%s' must be an absolute path, "
1147 "'none', or 'legacy'"), propname);
1149 case NAME_ERR_TOOLONG:
1151 dgettext(TEXT_DOMAIN,
1152 "component of '%s' is too long"),
1158 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1165 case ZFS_PROP_SHARESMB:
1166 case ZFS_PROP_SHARENFS:
1168 * For the mountpoint and sharenfs or sharesmb
1169 * properties, check if it can be set in a
1170 * global/non-global zone based on
1171 * the zoned property value:
1173 * global zone non-global zone
1174 * --------------------------------------------------
1175 * zoned=on mountpoint (no) mountpoint (yes)
1176 * sharenfs (no) sharenfs (no)
1177 * sharesmb (no) sharesmb (no)
1179 * zoned=off mountpoint (yes) N/A
1184 if (getzoneid() == GLOBAL_ZONEID) {
1185 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1186 "'%s' cannot be set on "
1187 "dataset in a non-global zone"),
1189 (void) zfs_error(hdl, EZFS_ZONED,
1192 } else if (prop == ZFS_PROP_SHARENFS ||
1193 prop == ZFS_PROP_SHARESMB) {
1194 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1195 "'%s' cannot be set in "
1196 "a non-global zone"), propname);
1197 (void) zfs_error(hdl, EZFS_ZONED,
1201 } else if (getzoneid() != GLOBAL_ZONEID) {
1203 * If zoned property is 'off', this must be in
1204 * a global zone. If not, something is wrong.
1206 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1207 "'%s' cannot be set while dataset "
1208 "'zoned' property is set"), propname);
1209 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1214 * At this point, it is legitimate to set the
1215 * property. Now we want to make sure that the
1216 * property value is valid if it is sharenfs.
1218 if ((prop == ZFS_PROP_SHARENFS ||
1219 prop == ZFS_PROP_SHARESMB) &&
1220 strcmp(strval, "on") != 0 &&
1221 strcmp(strval, "off") != 0) {
1222 zfs_share_proto_t proto;
1224 if (prop == ZFS_PROP_SHARESMB)
1230 * Must be an valid sharing protocol
1231 * option string so init the libshare
1232 * in order to enable the parser and
1233 * then parse the options. We use the
1234 * control API since we don't care about
1235 * the current configuration and don't
1236 * want the overhead of loading it
1237 * until we actually do something.
1240 if (zfs_init_libshare(hdl,
1241 SA_INIT_CONTROL_API) != SA_OK) {
1243 * An error occurred so we can't do
1246 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1247 "'%s' cannot be set: problem "
1248 "in share initialization"),
1250 (void) zfs_error(hdl, EZFS_BADPROP,
1255 if (zfs_parse_options(strval, proto) != SA_OK) {
1257 * There was an error in parsing so
1258 * deal with it by issuing an error
1259 * message and leaving after
1260 * uninitializing the the libshare
1263 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1264 "'%s' cannot be set to invalid "
1265 "options"), propname);
1266 (void) zfs_error(hdl, EZFS_BADPROP,
1268 zfs_uninit_libshare(hdl);
1271 zfs_uninit_libshare(hdl);
1275 case ZFS_PROP_UTF8ONLY:
1276 chosen_utf = (int)intval;
1278 case ZFS_PROP_NORMALIZE:
1279 chosen_normal = (int)intval;
1286 * For changes to existing volumes, we have some additional
1287 * checks to enforce.
1289 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1290 uint64_t volsize = zfs_prop_get_int(zhp,
1292 uint64_t blocksize = zfs_prop_get_int(zhp,
1293 ZFS_PROP_VOLBLOCKSIZE);
1297 case ZFS_PROP_RESERVATION:
1298 case ZFS_PROP_REFRESERVATION:
1299 if (intval > volsize) {
1300 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1301 "'%s' is greater than current "
1302 "volume size"), propname);
1303 (void) zfs_error(hdl, EZFS_BADPROP,
1309 case ZFS_PROP_VOLSIZE:
1310 if (intval % blocksize != 0) {
1311 zfs_nicenum(blocksize, buf,
1313 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1314 "'%s' must be a multiple of "
1315 "volume block size (%s)"),
1317 (void) zfs_error(hdl, EZFS_BADPROP,
1323 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1324 "'%s' cannot be zero"),
1326 (void) zfs_error(hdl, EZFS_BADPROP,
1338 * If normalization was chosen, but no UTF8 choice was made,
1339 * enforce rejection of non-UTF8 names.
1341 * If normalization was chosen, but rejecting non-UTF8 names
1342 * was explicitly not chosen, it is an error.
1344 if (chosen_normal > 0 && chosen_utf < 0) {
1345 if (nvlist_add_uint64(ret,
1346 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1347 (void) no_memory(hdl);
1350 } else if (chosen_normal > 0 && chosen_utf == 0) {
1351 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1352 "'%s' must be set 'on' if normalization chosen"),
1353 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1354 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1365 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1367 uint64_t old_volsize;
1368 uint64_t new_volsize;
1369 uint64_t old_reservation;
1370 uint64_t new_reservation;
1371 zfs_prop_t resv_prop;
1374 * If this is an existing volume, and someone is setting the volsize,
1375 * make sure that it matches the reservation, or add it if necessary.
1377 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1378 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1380 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1381 if ((zvol_volsize_to_reservation(old_volsize, zhp->zfs_props) !=
1382 old_reservation) || nvlist_lookup_uint64(nvl,
1383 zfs_prop_to_name(resv_prop), &new_reservation) != ENOENT) {
1386 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1389 new_reservation = zvol_volsize_to_reservation(new_volsize,
1391 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1392 new_reservation) != 0) {
1393 (void) no_memory(zhp->zfs_hdl);
1400 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1407 * For quotas and reservations, ENOSPC indicates
1408 * something different; setting a quota or reservation
1409 * doesn't use any disk space.
1412 case ZFS_PROP_QUOTA:
1413 case ZFS_PROP_REFQUOTA:
1414 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1415 "size is less than current used or "
1417 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1420 case ZFS_PROP_RESERVATION:
1421 case ZFS_PROP_REFRESERVATION:
1422 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1423 "size is greater than available space"));
1424 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1428 (void) zfs_standard_error(hdl, err, errbuf);
1434 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1438 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1442 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1443 "pool and or dataset must be upgraded to set this "
1444 "property or value"));
1445 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1449 if (prop == ZFS_PROP_COMPRESSION) {
1450 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1451 "property setting is not allowed on "
1452 "bootable datasets"));
1453 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1455 (void) zfs_standard_error(hdl, err, errbuf);
1460 if (prop == ZPROP_INVAL) {
1461 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1463 (void) zfs_standard_error(hdl, err, errbuf);
1469 * This platform can't address a volume this big.
1472 if (prop == ZFS_PROP_VOLSIZE) {
1473 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1479 (void) zfs_standard_error(hdl, err, errbuf);
1484 zfs_is_namespace_prop(zfs_prop_t prop)
1488 case ZFS_PROP_ATIME:
1489 case ZFS_PROP_RELATIME:
1490 case ZFS_PROP_DEVICES:
1492 case ZFS_PROP_SETUID:
1493 case ZFS_PROP_READONLY:
1494 case ZFS_PROP_XATTR:
1495 case ZFS_PROP_NBMAND:
1504 * Given a property name and value, set the property for the given dataset.
1507 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1509 zfs_cmd_t zc = {"\0"};
1511 prop_changelist_t *cl = NULL;
1513 libzfs_handle_t *hdl = zhp->zfs_hdl;
1514 nvlist_t *nvl = NULL, *realprops;
1516 boolean_t do_prefix = B_TRUE;
1519 (void) snprintf(errbuf, sizeof (errbuf),
1520 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1523 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1524 nvlist_add_string(nvl, propname, propval) != 0) {
1525 (void) no_memory(hdl);
1529 if ((realprops = zfs_valid_proplist(hdl, zhp->zfs_type, nvl,
1530 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, errbuf)) == NULL)
1536 prop = zfs_name_to_prop(propname);
1538 if (prop == ZFS_PROP_VOLSIZE) {
1539 if ((added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1)
1543 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1546 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1547 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1548 "child dataset with inherited mountpoint is used "
1549 "in a non-global zone"));
1550 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1555 * We don't want to unmount & remount the dataset when changing
1556 * its canmount property to 'on' or 'noauto'. We only use
1557 * the changelist logic to unmount when setting canmount=off.
1559 if (prop == ZFS_PROP_CANMOUNT) {
1561 int err = zprop_string_to_index(prop, propval, &idx,
1563 if (err == 0 && idx != ZFS_CANMOUNT_OFF)
1564 do_prefix = B_FALSE;
1567 if (do_prefix && (ret = changelist_prefix(cl)) != 0)
1571 * Execute the corresponding ioctl() to set this property.
1573 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1575 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1578 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1581 zfs_setprop_error(hdl, prop, errno, errbuf);
1582 if (added_resv && errno == ENOSPC) {
1583 /* clean up the volsize property we tried to set */
1584 uint64_t old_volsize = zfs_prop_get_int(zhp,
1587 zcmd_free_nvlists(&zc);
1588 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1590 if (nvlist_add_uint64(nvl,
1591 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1594 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1596 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1600 ret = changelist_postfix(cl);
1604 * Refresh the statistics so the new property
1605 * value is reflected.
1607 (void) get_stats(zhp);
1610 * Remount the filesystem to propagate the change
1611 * if one of the options handled by the generic
1612 * Linux namespace layer has been modified.
1614 if (zfs_is_namespace_prop(prop) &&
1615 zfs_is_mounted(zhp, NULL))
1616 ret = zfs_mount(zhp, MNTOPT_REMOUNT, 0);
1622 zcmd_free_nvlists(&zc);
1624 changelist_free(cl);
1629 * Given a property, inherit the value from the parent dataset, or if received
1630 * is TRUE, revert to the received value, if any.
1633 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1635 zfs_cmd_t zc = {"\0"};
1637 prop_changelist_t *cl;
1638 libzfs_handle_t *hdl = zhp->zfs_hdl;
1642 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1643 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1645 zc.zc_cookie = received;
1646 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1648 * For user properties, the amount of work we have to do is very
1649 * small, so just do it here.
1651 if (!zfs_prop_user(propname)) {
1652 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1653 "invalid property"));
1654 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1657 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1658 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1660 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1661 return (zfs_standard_error(hdl, errno, errbuf));
1667 * Verify that this property is inheritable.
1669 if (zfs_prop_readonly(prop))
1670 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1672 if (!zfs_prop_inheritable(prop) && !received)
1673 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1676 * Check to see if the value applies to this type
1678 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE))
1679 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1682 * Normalize the name, to get rid of shorthand abbreviations.
1684 propname = zfs_prop_to_name(prop);
1685 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1686 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1688 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1689 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1690 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1691 "dataset is used in a non-global zone"));
1692 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1696 * Determine datasets which will be affected by this change, if any.
1698 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1701 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1702 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1703 "child dataset with inherited mountpoint is used "
1704 "in a non-global zone"));
1705 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1709 if ((ret = changelist_prefix(cl)) != 0)
1712 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1713 return (zfs_standard_error(hdl, errno, errbuf));
1716 if ((ret = changelist_postfix(cl)) != 0)
1720 * Refresh the statistics so the new property is reflected.
1722 (void) get_stats(zhp);
1725 * Remount the filesystem to propagate the change
1726 * if one of the options handled by the generic
1727 * Linux namespace layer has been modified.
1729 if (zfs_is_namespace_prop(prop) &&
1730 zfs_is_mounted(zhp, NULL))
1731 ret = zfs_mount(zhp, MNTOPT_REMOUNT, 0);
1735 changelist_free(cl);
1740 * True DSL properties are stored in an nvlist. The following two functions
1741 * extract them appropriately.
1744 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1750 if (nvlist_lookup_nvlist(zhp->zfs_props,
1751 zfs_prop_to_name(prop), &nv) == 0) {
1752 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1753 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1755 verify(!zhp->zfs_props_table ||
1756 zhp->zfs_props_table[prop] == B_TRUE);
1757 value = zfs_prop_default_numeric(prop);
1765 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1771 if (nvlist_lookup_nvlist(zhp->zfs_props,
1772 zfs_prop_to_name(prop), &nv) == 0) {
1773 verify(nvlist_lookup_string(nv, ZPROP_VALUE, &value) == 0);
1774 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1776 verify(!zhp->zfs_props_table ||
1777 zhp->zfs_props_table[prop] == B_TRUE);
1778 if ((value = (char *)zfs_prop_default_string(prop)) == NULL)
1787 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
1789 return (zhp->zfs_props == zhp->zfs_recvd_props);
1793 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1795 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
1796 zhp->zfs_props = zhp->zfs_recvd_props;
1800 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1802 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
1807 * Internal function for getting a numeric property. Both zfs_prop_get() and
1808 * zfs_prop_get_int() are built using this interface.
1810 * Certain properties can be overridden using 'mount -o'. In this case, scan
1811 * the contents of the /etc/mtab entry, searching for the appropriate options.
1812 * If they differ from the on-disk values, report the current values and mark
1813 * the source "temporary".
1816 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
1817 char **source, uint64_t *val)
1819 zfs_cmd_t zc = {"\0"};
1820 nvlist_t *zplprops = NULL;
1822 char *mntopt_on = NULL;
1823 char *mntopt_off = NULL;
1824 boolean_t received = zfs_is_recvd_props_mode(zhp);
1829 * If the property is being fetched for a snapshot, check whether
1830 * the property is valid for the snapshot's head dataset type.
1832 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT &&
1833 !zfs_prop_valid_for_type(prop, zhp->zfs_head_type, B_TRUE)) {
1834 *val = zfs_prop_default_numeric(prop);
1839 case ZFS_PROP_ATIME:
1840 mntopt_on = MNTOPT_ATIME;
1841 mntopt_off = MNTOPT_NOATIME;
1844 case ZFS_PROP_RELATIME:
1845 mntopt_on = MNTOPT_RELATIME;
1846 mntopt_off = MNTOPT_NORELATIME;
1849 case ZFS_PROP_DEVICES:
1850 mntopt_on = MNTOPT_DEVICES;
1851 mntopt_off = MNTOPT_NODEVICES;
1855 mntopt_on = MNTOPT_EXEC;
1856 mntopt_off = MNTOPT_NOEXEC;
1859 case ZFS_PROP_READONLY:
1860 mntopt_on = MNTOPT_RO;
1861 mntopt_off = MNTOPT_RW;
1864 case ZFS_PROP_SETUID:
1865 mntopt_on = MNTOPT_SETUID;
1866 mntopt_off = MNTOPT_NOSETUID;
1869 case ZFS_PROP_XATTR:
1870 mntopt_on = MNTOPT_XATTR;
1871 mntopt_off = MNTOPT_NOXATTR;
1874 case ZFS_PROP_NBMAND:
1875 mntopt_on = MNTOPT_NBMAND;
1876 mntopt_off = MNTOPT_NONBMAND;
1883 * Because looking up the mount options is potentially expensive
1884 * (iterating over all of /etc/mtab), we defer its calculation until
1885 * we're looking up a property which requires its presence.
1887 if (!zhp->zfs_mntcheck &&
1888 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
1889 libzfs_handle_t *hdl = zhp->zfs_hdl;
1890 struct mnttab entry;
1892 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
1893 zhp->zfs_mntopts = zfs_strdup(hdl,
1895 if (zhp->zfs_mntopts == NULL)
1899 zhp->zfs_mntcheck = B_TRUE;
1902 if (zhp->zfs_mntopts == NULL)
1903 mnt.mnt_mntopts = "";
1905 mnt.mnt_mntopts = zhp->zfs_mntopts;
1908 case ZFS_PROP_DEVICES:
1910 case ZFS_PROP_READONLY:
1911 case ZFS_PROP_SETUID:
1912 case ZFS_PROP_XATTR:
1913 case ZFS_PROP_NBMAND:
1914 *val = getprop_uint64(zhp, prop, source);
1919 if (hasmntopt(&mnt, mntopt_on) && !*val) {
1922 *src = ZPROP_SRC_TEMPORARY;
1923 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
1926 *src = ZPROP_SRC_TEMPORARY;
1930 case ZFS_PROP_ATIME:
1931 case ZFS_PROP_RELATIME:
1932 case ZFS_PROP_CANMOUNT:
1933 case ZFS_PROP_VOLSIZE:
1934 case ZFS_PROP_QUOTA:
1935 case ZFS_PROP_REFQUOTA:
1936 case ZFS_PROP_RESERVATION:
1937 case ZFS_PROP_REFRESERVATION:
1938 case ZFS_PROP_FILESYSTEM_LIMIT:
1939 case ZFS_PROP_SNAPSHOT_LIMIT:
1940 case ZFS_PROP_FILESYSTEM_COUNT:
1941 case ZFS_PROP_SNAPSHOT_COUNT:
1942 *val = getprop_uint64(zhp, prop, source);
1944 if (*source == NULL) {
1945 /* not default, must be local */
1946 *source = zhp->zfs_name;
1950 case ZFS_PROP_MOUNTED:
1951 *val = (zhp->zfs_mntopts != NULL);
1954 case ZFS_PROP_NUMCLONES:
1955 *val = zhp->zfs_dmustats.dds_num_clones;
1958 case ZFS_PROP_VERSION:
1959 case ZFS_PROP_NORMALIZE:
1960 case ZFS_PROP_UTF8ONLY:
1962 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
1964 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1965 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
1966 zcmd_free_nvlists(&zc);
1967 if (prop == ZFS_PROP_VERSION &&
1968 zhp->zfs_type == ZFS_TYPE_VOLUME)
1969 *val = zfs_prop_default_numeric(prop);
1972 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
1973 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
1975 zcmd_free_nvlists(&zc);
1979 nvlist_free(zplprops);
1980 zcmd_free_nvlists(&zc);
1983 case ZFS_PROP_INCONSISTENT:
1984 *val = zhp->zfs_dmustats.dds_inconsistent;
1988 switch (zfs_prop_get_type(prop)) {
1989 case PROP_TYPE_NUMBER:
1990 case PROP_TYPE_INDEX:
1991 *val = getprop_uint64(zhp, prop, source);
1993 * If we tried to use a default value for a
1994 * readonly property, it means that it was not
1997 if (zfs_prop_readonly(prop) &&
1998 *source != NULL && (*source)[0] == '\0') {
2003 case PROP_TYPE_STRING:
2005 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
2006 "cannot get non-numeric property"));
2007 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
2008 dgettext(TEXT_DOMAIN, "internal error")));
2016 * Calculate the source type, given the raw source string.
2019 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
2020 char *statbuf, size_t statlen)
2022 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
2025 if (source == NULL) {
2026 *srctype = ZPROP_SRC_NONE;
2027 } else if (source[0] == '\0') {
2028 *srctype = ZPROP_SRC_DEFAULT;
2029 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
2030 *srctype = ZPROP_SRC_RECEIVED;
2032 if (strcmp(source, zhp->zfs_name) == 0) {
2033 *srctype = ZPROP_SRC_LOCAL;
2035 (void) strlcpy(statbuf, source, statlen);
2036 *srctype = ZPROP_SRC_INHERITED;
2043 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
2044 size_t proplen, boolean_t literal)
2049 if (zhp->zfs_recvd_props == NULL)
2050 if (get_recvd_props_ioctl(zhp) != 0)
2053 prop = zfs_name_to_prop(propname);
2055 if (prop != ZPROP_INVAL) {
2057 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
2059 zfs_set_recvd_props_mode(zhp, &cookie);
2060 err = zfs_prop_get(zhp, prop, propbuf, proplen,
2061 NULL, NULL, 0, literal);
2062 zfs_unset_recvd_props_mode(zhp, &cookie);
2066 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
2067 propname, &propval) != 0)
2069 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
2071 (void) strlcpy(propbuf, recvdval, proplen);
2074 return (err == 0 ? 0 : -1);
2078 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2083 value = zfs_get_clones_nvl(zhp);
2088 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
2089 pair = nvlist_next_nvpair(value, pair)) {
2090 if (propbuf[0] != '\0')
2091 (void) strlcat(propbuf, ",", proplen);
2092 (void) strlcat(propbuf, nvpair_name(pair), proplen);
2098 struct get_clones_arg {
2102 char buf[ZFS_MAXNAMELEN];
2106 get_clones_cb(zfs_handle_t *zhp, void *arg)
2108 struct get_clones_arg *gca = arg;
2110 if (gca->numclones == 0) {
2115 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
2116 NULL, NULL, 0, B_TRUE) != 0)
2118 if (strcmp(gca->buf, gca->origin) == 0) {
2119 fnvlist_add_boolean(gca->value, zfs_get_name(zhp));
2124 (void) zfs_iter_children(zhp, get_clones_cb, gca);
2130 zfs_get_clones_nvl(zfs_handle_t *zhp)
2132 nvlist_t *nv, *value;
2134 if (nvlist_lookup_nvlist(zhp->zfs_props,
2135 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
2136 struct get_clones_arg gca;
2139 * if this is a snapshot, then the kernel wasn't able
2140 * to get the clones. Do it by slowly iterating.
2142 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2144 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2146 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2151 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2153 gca.origin = zhp->zfs_name;
2155 if (gca.numclones != 0) {
2157 char pool[ZFS_MAXNAMELEN];
2160 /* get the pool name */
2161 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2162 (void) strsep(&cp, "/@");
2163 root = zfs_open(zhp->zfs_hdl, pool,
2164 ZFS_TYPE_FILESYSTEM);
2166 (void) get_clones_cb(root, &gca);
2169 if (gca.numclones != 0 ||
2170 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2171 nvlist_add_nvlist(zhp->zfs_props,
2172 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2179 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2180 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2183 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2189 * Retrieve a property from the given object. If 'literal' is specified, then
2190 * numbers are left as exact values. Otherwise, numbers are converted to a
2191 * human-readable form.
2193 * Returns 0 on success, or -1 on error.
2196 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2197 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2199 char *source = NULL;
2203 boolean_t received = zfs_is_recvd_props_mode(zhp);
2206 * Check to see if this property applies to our object
2208 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE))
2211 if (received && zfs_prop_readonly(prop))
2215 *src = ZPROP_SRC_NONE;
2218 case ZFS_PROP_CREATION:
2220 * 'creation' is a time_t stored in the statistics. We convert
2221 * this into a string unless 'literal' is specified.
2224 val = getprop_uint64(zhp, prop, &source);
2225 time_t time = (time_t)val;
2229 localtime_r(&time, &t) == NULL ||
2230 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2232 (void) snprintf(propbuf, proplen, "%llu",
2233 (u_longlong_t) val);
2237 case ZFS_PROP_MOUNTPOINT:
2239 * Getting the precise mountpoint can be tricky.
2241 * - for 'none' or 'legacy', return those values.
2242 * - for inherited mountpoints, we want to take everything
2243 * after our ancestor and append it to the inherited value.
2245 * If the pool has an alternate root, we want to prepend that
2246 * root to any values we return.
2249 str = getprop_string(zhp, prop, &source);
2251 if (str[0] == '/') {
2252 char buf[MAXPATHLEN];
2254 const char *relpath;
2257 * If we inherit the mountpoint, even from a dataset
2258 * with a received value, the source will be the path of
2259 * the dataset we inherit from. If source is
2260 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2263 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2266 relpath = zhp->zfs_name + strlen(source);
2267 if (relpath[0] == '/')
2271 if ((zpool_get_prop(zhp->zpool_hdl,
2272 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL)) ||
2273 (strcmp(root, "-") == 0))
2276 * Special case an alternate root of '/'. This will
2277 * avoid having multiple leading slashes in the
2280 if (strcmp(root, "/") == 0)
2284 * If the mountpoint is '/' then skip over this
2285 * if we are obtaining either an alternate root or
2286 * an inherited mountpoint.
2288 if (str[1] == '\0' && (root[0] != '\0' ||
2289 relpath[0] != '\0'))
2292 if (relpath[0] == '\0')
2293 (void) snprintf(propbuf, proplen, "%s%s",
2296 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2297 root, str, relpath[0] == '@' ? "" : "/",
2300 /* 'legacy' or 'none' */
2301 (void) strlcpy(propbuf, str, proplen);
2306 case ZFS_PROP_ORIGIN:
2307 (void) strlcpy(propbuf, getprop_string(zhp, prop, &source),
2310 * If there is no parent at all, return failure to indicate that
2311 * it doesn't apply to this dataset.
2313 if (propbuf[0] == '\0')
2317 case ZFS_PROP_CLONES:
2318 if (get_clones_string(zhp, propbuf, proplen) != 0)
2322 case ZFS_PROP_QUOTA:
2323 case ZFS_PROP_REFQUOTA:
2324 case ZFS_PROP_RESERVATION:
2325 case ZFS_PROP_REFRESERVATION:
2327 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2331 * If quota or reservation is 0, we translate this into 'none'
2332 * (unless literal is set), and indicate that it's the default
2333 * value. Otherwise, we print the number nicely and indicate
2334 * that its set locally.
2338 (void) strlcpy(propbuf, "0", proplen);
2340 (void) strlcpy(propbuf, "none", proplen);
2343 (void) snprintf(propbuf, proplen, "%llu",
2346 zfs_nicenum(val, propbuf, proplen);
2350 case ZFS_PROP_FILESYSTEM_LIMIT:
2351 case ZFS_PROP_SNAPSHOT_LIMIT:
2352 case ZFS_PROP_FILESYSTEM_COUNT:
2353 case ZFS_PROP_SNAPSHOT_COUNT:
2355 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2359 * If limit is UINT64_MAX, we translate this into 'none' (unless
2360 * literal is set), and indicate that it's the default value.
2361 * Otherwise, we print the number nicely and indicate that it's
2365 (void) snprintf(propbuf, proplen, "%llu",
2367 } else if (val == UINT64_MAX) {
2368 (void) strlcpy(propbuf, "none", proplen);
2370 zfs_nicenum(val, propbuf, proplen);
2374 case ZFS_PROP_REFRATIO:
2375 case ZFS_PROP_COMPRESSRATIO:
2376 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2378 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2379 (u_longlong_t)(val / 100),
2380 (u_longlong_t)(val % 100));
2384 switch (zhp->zfs_type) {
2385 case ZFS_TYPE_FILESYSTEM:
2388 case ZFS_TYPE_VOLUME:
2391 case ZFS_TYPE_SNAPSHOT:
2394 case ZFS_TYPE_BOOKMARK:
2400 (void) snprintf(propbuf, proplen, "%s", str);
2403 case ZFS_PROP_MOUNTED:
2405 * The 'mounted' property is a pseudo-property that described
2406 * whether the filesystem is currently mounted. Even though
2407 * it's a boolean value, the typical values of "on" and "off"
2408 * don't make sense, so we translate to "yes" and "no".
2410 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2411 src, &source, &val) != 0)
2414 (void) strlcpy(propbuf, "yes", proplen);
2416 (void) strlcpy(propbuf, "no", proplen);
2421 * The 'name' property is a pseudo-property derived from the
2422 * dataset name. It is presented as a real property to simplify
2425 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2428 case ZFS_PROP_MLSLABEL:
2430 #ifdef HAVE_MLSLABEL
2431 m_label_t *new_sl = NULL;
2432 char *ascii = NULL; /* human readable label */
2434 (void) strlcpy(propbuf,
2435 getprop_string(zhp, prop, &source), proplen);
2437 if (literal || (strcasecmp(propbuf,
2438 ZFS_MLSLABEL_DEFAULT) == 0))
2442 * Try to translate the internal hex string to
2443 * human-readable output. If there are any
2444 * problems just use the hex string.
2447 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2448 L_NO_CORRECTION, NULL) == -1) {
2449 m_label_free(new_sl);
2453 if (label_to_str(new_sl, &ascii, M_LABEL,
2457 m_label_free(new_sl);
2460 m_label_free(new_sl);
2462 (void) strlcpy(propbuf, ascii, proplen);
2465 (void) strlcpy(propbuf,
2466 getprop_string(zhp, prop, &source), proplen);
2467 #endif /* HAVE_MLSLABEL */
2473 * GUIDs are stored as numbers, but they are identifiers.
2474 * We don't want them to be pretty printed, because pretty
2475 * printing mangles the ID into a truncated and useless value.
2477 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2479 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2483 switch (zfs_prop_get_type(prop)) {
2484 case PROP_TYPE_NUMBER:
2485 if (get_numeric_property(zhp, prop, src,
2486 &source, &val) != 0)
2489 (void) snprintf(propbuf, proplen, "%llu",
2492 zfs_nicenum(val, propbuf, proplen);
2495 case PROP_TYPE_STRING:
2496 (void) strlcpy(propbuf,
2497 getprop_string(zhp, prop, &source), proplen);
2500 case PROP_TYPE_INDEX:
2501 if (get_numeric_property(zhp, prop, src,
2502 &source, &val) != 0)
2504 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2506 (void) strlcpy(propbuf, strval, proplen);
2514 get_source(zhp, src, source, statbuf, statlen);
2520 * Utility function to get the given numeric property. Does no validation that
2521 * the given property is the appropriate type; should only be used with
2522 * hard-coded property types.
2525 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2530 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2536 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2540 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2541 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2545 * Similar to zfs_prop_get(), but returns the value as an integer.
2548 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2549 zprop_source_t *src, char *statbuf, size_t statlen)
2554 * Check to see if this property applies to our object
2556 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE)) {
2557 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2558 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2559 zfs_prop_to_name(prop)));
2563 *src = ZPROP_SRC_NONE;
2565 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2568 get_source(zhp, src, source, statbuf, statlen);
2575 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2576 char **domainp, idmap_rid_t *ridp)
2578 idmap_get_handle_t *get_hdl = NULL;
2582 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2586 err = idmap_get_sidbyuid(get_hdl, id,
2587 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2589 err = idmap_get_sidbygid(get_hdl, id,
2590 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2592 if (err == IDMAP_SUCCESS &&
2593 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2594 status == IDMAP_SUCCESS)
2600 idmap_get_destroy(get_hdl);
2603 #endif /* HAVE_IDMAP */
2606 * convert the propname into parameters needed by kernel
2607 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2608 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2609 * Eg: groupquota@staff -> ZFS_PROP_GROUPQUOTA, "", 1234
2610 * Eg: groupused@staff -> ZFS_PROP_GROUPUSED, "", 1234
2613 userquota_propname_decode(const char *propname, boolean_t zoned,
2614 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2616 zfs_userquota_prop_t type;
2625 /* Figure out the property type ({user|group}{quota|space}) */
2626 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2627 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2628 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2631 if (type == ZFS_NUM_USERQUOTA_PROPS)
2635 isuser = (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_USERUSED);
2636 isgroup = (type == ZFS_PROP_GROUPQUOTA || type == ZFS_PROP_GROUPUSED);
2638 cp = strchr(propname, '@') + 1;
2640 if (isuser && (pw = getpwnam(cp)) != NULL) {
2641 if (zoned && getzoneid() == GLOBAL_ZONEID)
2644 } else if (isgroup && (gr = getgrnam(cp)) != NULL) {
2645 if (zoned && getzoneid() == GLOBAL_ZONEID)
2648 } else if (strchr(cp, '@')) {
2651 * It's a SID name (eg "user@domain") that needs to be
2652 * turned into S-1-domainID-RID.
2654 directory_error_t e;
2655 char *numericsid = NULL;
2658 if (zoned && getzoneid() == GLOBAL_ZONEID)
2661 e = directory_sid_from_user_name(NULL,
2664 e = directory_sid_from_group_name(NULL,
2668 directory_error_free(e);
2671 if (numericsid == NULL)
2674 (void) strlcpy(domain, cp, domainlen);
2675 cp = strrchr(domain, '-');
2680 *ridp = strtoull(cp, &end, 10);
2683 if (errno != 0 || *end != '\0')
2687 #endif /* HAVE_IDMAP */
2689 /* It's a user/group ID (eg "12345"). */
2692 id = strtoul(cp, &end, 10);
2697 /* It's an ephemeral ID. */
2701 if (idmap_id_to_numeric_domain_rid(id, isuser,
2702 &mapdomain, &rid) != 0)
2704 (void) strlcpy(domain, mapdomain, domainlen);
2708 #endif /* HAVE_IDMAP */
2718 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2719 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2722 zfs_cmd_t zc = {"\0"};
2724 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2726 err = userquota_propname_decode(propname,
2727 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2728 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2729 zc.zc_objset_type = *typep;
2733 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2737 *propvalue = zc.zc_cookie;
2742 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2743 uint64_t *propvalue)
2745 zfs_userquota_prop_t type;
2747 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
2752 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
2753 char *propbuf, int proplen, boolean_t literal)
2757 zfs_userquota_prop_t type;
2759 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
2766 (void) snprintf(propbuf, proplen, "%llu",
2767 (u_longlong_t)propvalue);
2768 } else if (propvalue == 0 &&
2769 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
2770 (void) strlcpy(propbuf, "none", proplen);
2772 zfs_nicenum(propvalue, propbuf, proplen);
2778 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
2779 uint64_t *propvalue)
2782 zfs_cmd_t zc = {"\0"};
2783 const char *snapname;
2785 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2787 snapname = strchr(propname, '@') + 1;
2788 if (strchr(snapname, '@')) {
2789 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
2791 /* snapname is the short name, append it to zhp's fsname */
2794 (void) strlcpy(zc.zc_value, zhp->zfs_name,
2795 sizeof (zc.zc_value));
2796 cp = strchr(zc.zc_value, '@');
2799 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
2800 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
2803 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
2807 *propvalue = zc.zc_cookie;
2812 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
2813 char *propbuf, int proplen, boolean_t literal)
2818 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
2824 (void) snprintf(propbuf, proplen, "%llu",
2825 (u_longlong_t)propvalue);
2827 zfs_nicenum(propvalue, propbuf, proplen);
2834 * Returns the name of the given zfs handle.
2837 zfs_get_name(const zfs_handle_t *zhp)
2839 return (zhp->zfs_name);
2843 * Returns the type of the given zfs handle.
2846 zfs_get_type(const zfs_handle_t *zhp)
2848 return (zhp->zfs_type);
2852 * Is one dataset name a child dataset of another?
2854 * Needs to handle these cases:
2855 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2856 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2857 * Descendant? No. No. No. Yes.
2860 is_descendant(const char *ds1, const char *ds2)
2862 size_t d1len = strlen(ds1);
2864 /* ds2 can't be a descendant if it's smaller */
2865 if (strlen(ds2) < d1len)
2868 /* otherwise, compare strings and verify that there's a '/' char */
2869 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
2873 * Given a complete name, return just the portion that refers to the parent.
2874 * Will return -1 if there is no parent (path is just the name of the
2878 parent_name(const char *path, char *buf, size_t buflen)
2882 (void) strlcpy(buf, path, buflen);
2884 if ((slashp = strrchr(buf, '/')) == NULL)
2892 * If accept_ancestor is false, then check to make sure that the given path has
2893 * a parent, and that it exists. If accept_ancestor is true, then find the
2894 * closest existing ancestor for the given path. In prefixlen return the
2895 * length of already existing prefix of the given path. We also fetch the
2896 * 'zoned' property, which is used to validate property settings when creating
2900 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
2901 boolean_t accept_ancestor, int *prefixlen)
2903 zfs_cmd_t zc = {"\0"};
2904 char parent[ZFS_MAXNAMELEN];
2910 (void) snprintf(errbuf, sizeof (errbuf),
2911 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
2913 /* get parent, and check to see if this is just a pool */
2914 if (parent_name(path, parent, sizeof (parent)) != 0) {
2915 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2916 "missing dataset name"));
2917 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
2920 /* check to see if the pool exists */
2921 if ((slash = strchr(parent, '/')) == NULL)
2922 slash = parent + strlen(parent);
2923 (void) strncpy(zc.zc_name, parent, slash - parent);
2924 zc.zc_name[slash - parent] = '\0';
2925 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
2927 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2928 "no such pool '%s'"), zc.zc_name);
2929 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2932 /* check to see if the parent dataset exists */
2933 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
2934 if (errno == ENOENT && accept_ancestor) {
2936 * Go deeper to find an ancestor, give up on top level.
2938 if (parent_name(parent, parent, sizeof (parent)) != 0) {
2939 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2940 "no such pool '%s'"), zc.zc_name);
2941 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2943 } else if (errno == ENOENT) {
2944 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2945 "parent does not exist"));
2946 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2948 return (zfs_standard_error(hdl, errno, errbuf));
2951 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
2955 /* we are in a non-global zone, but parent is in the global zone */
2956 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
2957 (void) zfs_standard_error(hdl, EPERM, errbuf);
2962 /* make sure parent is a filesystem */
2963 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
2964 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2965 "parent is not a filesystem"));
2966 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
2972 if (prefixlen != NULL)
2973 *prefixlen = strlen(parent);
2978 * Finds whether the dataset of the given type(s) exists.
2981 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
2985 if (!zfs_validate_name(hdl, path, types, B_FALSE))
2989 * Try to get stats for the dataset, which will tell us if it exists.
2991 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
2992 int ds_type = zhp->zfs_type;
2995 if (types & ds_type)
3002 * Given a path to 'target', create all the ancestors between
3003 * the prefixlen portion of the path, and the target itself.
3004 * Fail if the initial prefixlen-ancestor does not already exist.
3007 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
3013 /* make sure prefix exists */
3014 cp = target + prefixlen;
3016 assert(strchr(cp, '/') == NULL);
3017 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3020 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3028 * Attempt to create, mount, and share any ancestor filesystems,
3029 * up to the prefixlen-long one.
3031 for (cp = target + prefixlen + 1;
3032 (cp = strchr(cp, '/')); *cp = '/', cp++) {
3036 h = make_dataset_handle(hdl, target);
3038 /* it already exists, nothing to do here */
3043 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
3045 opname = dgettext(TEXT_DOMAIN, "create");
3049 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3051 opname = dgettext(TEXT_DOMAIN, "open");
3055 if (zfs_mount(h, NULL, 0) != 0) {
3056 opname = dgettext(TEXT_DOMAIN, "mount");
3060 if (zfs_share(h) != 0) {
3061 opname = dgettext(TEXT_DOMAIN, "share");
3071 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3072 "failed to %s ancestor '%s'"), opname, target);
3077 * Creates non-existing ancestors of the given path.
3080 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
3086 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
3089 if ((path_copy = strdup(path)) != NULL) {
3090 rc = create_parents(hdl, path_copy, prefix);
3093 if (path_copy == NULL || rc != 0)
3100 * Create a new filesystem or volume.
3103 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
3108 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
3111 dmu_objset_type_t ost;
3113 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3114 "cannot create '%s'"), path);
3116 /* validate the path, taking care to note the extended error message */
3117 if (!zfs_validate_name(hdl, path, type, B_TRUE))
3118 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3120 /* validate parents exist */
3121 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
3125 * The failure modes when creating a dataset of a different type over
3126 * one that already exists is a little strange. In particular, if you
3127 * try to create a dataset on top of an existing dataset, the ioctl()
3128 * will return ENOENT, not EEXIST. To prevent this from happening, we
3129 * first try to see if the dataset exists.
3131 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
3132 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3133 "dataset already exists"));
3134 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3137 if (type == ZFS_TYPE_VOLUME)
3142 if (props && (props = zfs_valid_proplist(hdl, type, props,
3143 zoned, NULL, errbuf)) == 0)
3146 if (type == ZFS_TYPE_VOLUME) {
3148 * If we are creating a volume, the size and block size must
3149 * satisfy a few restraints. First, the blocksize must be a
3150 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3151 * volsize must be a multiple of the block size, and cannot be
3154 if (props == NULL || nvlist_lookup_uint64(props,
3155 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3157 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3158 "missing volume size"));
3159 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3162 if ((ret = nvlist_lookup_uint64(props,
3163 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3164 &blocksize)) != 0) {
3165 if (ret == ENOENT) {
3166 blocksize = zfs_prop_default_numeric(
3167 ZFS_PROP_VOLBLOCKSIZE);
3170 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3171 "missing volume block size"));
3172 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3178 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3179 "volume size cannot be zero"));
3180 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3183 if (size % blocksize != 0) {
3185 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3186 "volume size must be a multiple of volume block "
3188 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3192 /* create the dataset */
3193 ret = lzc_create(path, ost, props);
3196 /* check for failure */
3198 char parent[ZFS_MAXNAMELEN];
3199 (void) parent_name(path, parent, sizeof (parent));
3203 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3204 "no such parent '%s'"), parent);
3205 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3208 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3209 "parent '%s' is not a filesystem"), parent);
3210 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3213 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3214 "volume block size must be power of 2 from "
3216 (uint_t)SPA_MINBLOCKSIZE,
3217 (uint_t)SPA_MAXBLOCKSIZE >> 10);
3219 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3222 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3223 "pool must be upgraded to set this "
3224 "property or value"));
3225 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3229 * This platform can't address a volume this big.
3231 if (type == ZFS_TYPE_VOLUME)
3232 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3237 return (zfs_standard_error(hdl, errno, errbuf));
3245 * Destroys the given dataset. The caller must make sure that the filesystem
3246 * isn't mounted, and that there are no active dependents. If the file system
3247 * does not exist this function does nothing.
3250 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3252 zfs_cmd_t zc = {"\0"};
3254 if (zhp->zfs_type == ZFS_TYPE_BOOKMARK) {
3255 nvlist_t *nv = fnvlist_alloc();
3256 fnvlist_add_boolean(nv, zhp->zfs_name);
3257 int error = lzc_destroy_bookmarks(nv, NULL);
3260 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3261 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3267 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3269 if (ZFS_IS_VOLUME(zhp)) {
3270 zc.zc_objset_type = DMU_OST_ZVOL;
3272 zc.zc_objset_type = DMU_OST_ZFS;
3275 zc.zc_defer_destroy = defer;
3276 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0 &&
3278 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3279 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3283 remove_mountpoint(zhp);
3288 struct destroydata {
3290 const char *snapname;
3294 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3296 struct destroydata *dd = arg;
3297 char name[ZFS_MAXNAMELEN];
3300 (void) snprintf(name, sizeof (name),
3301 "%s@%s", zhp->zfs_name, dd->snapname);
3303 if (lzc_exists(name))
3304 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3306 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3312 * Destroys all snapshots with the given name in zhp & descendants.
3315 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3318 struct destroydata dd = { 0 };
3320 dd.snapname = snapname;
3321 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3322 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3324 if (nvlist_empty(dd.nvl)) {
3325 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3326 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3327 zhp->zfs_name, snapname);
3329 ret = zfs_destroy_snaps_nvl(zhp->zfs_hdl, dd.nvl, defer);
3331 nvlist_free(dd.nvl);
3336 * Destroys all the snapshots named in the nvlist.
3339 zfs_destroy_snaps_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, boolean_t defer)
3345 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3350 if (nvlist_empty(errlist)) {
3352 (void) snprintf(errbuf, sizeof (errbuf),
3353 dgettext(TEXT_DOMAIN, "cannot destroy snapshots"));
3355 ret = zfs_standard_error(hdl, ret, errbuf);
3357 for (pair = nvlist_next_nvpair(errlist, NULL);
3358 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3360 (void) snprintf(errbuf, sizeof (errbuf),
3361 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3364 switch (fnvpair_value_int32(pair)) {
3367 dgettext(TEXT_DOMAIN, "snapshot is cloned"));
3368 ret = zfs_error(hdl, EZFS_EXISTS, errbuf);
3371 ret = zfs_standard_error(hdl, errno, errbuf);
3380 * Clones the given dataset. The target must be of the same type as the source.
3383 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3385 char parent[ZFS_MAXNAMELEN];
3388 libzfs_handle_t *hdl = zhp->zfs_hdl;
3391 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3393 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3394 "cannot create '%s'"), target);
3396 /* validate the target/clone name */
3397 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3398 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3400 /* validate parents exist */
3401 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3404 (void) parent_name(target, parent, sizeof (parent));
3410 if (ZFS_IS_VOLUME(zhp)) {
3411 type = ZFS_TYPE_VOLUME;
3413 type = ZFS_TYPE_FILESYSTEM;
3415 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3416 zhp, errbuf)) == NULL)
3420 ret = lzc_clone(target, zhp->zfs_name, props);
3428 * The parent doesn't exist. We should have caught this
3429 * above, but there may a race condition that has since
3430 * destroyed the parent.
3432 * At this point, we don't know whether it's the source
3433 * that doesn't exist anymore, or whether the target
3434 * dataset doesn't exist.
3436 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3437 "no such parent '%s'"), parent);
3438 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3441 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3442 "source and target pools differ"));
3443 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3447 return (zfs_standard_error(zhp->zfs_hdl, errno,
3456 * Promotes the given clone fs to be the clone parent.
3459 zfs_promote(zfs_handle_t *zhp)
3461 libzfs_handle_t *hdl = zhp->zfs_hdl;
3462 zfs_cmd_t zc = {"\0"};
3463 char parent[MAXPATHLEN];
3467 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3468 "cannot promote '%s'"), zhp->zfs_name);
3470 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3471 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3472 "snapshots can not be promoted"));
3473 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3476 (void) strlcpy(parent, zhp->zfs_dmustats.dds_origin, sizeof (parent));
3477 if (parent[0] == '\0') {
3478 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3479 "not a cloned filesystem"));
3480 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3483 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_origin,
3484 sizeof (zc.zc_value));
3485 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3486 ret = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc);
3489 int save_errno = errno;
3491 switch (save_errno) {
3493 /* There is a conflicting snapshot name. */
3494 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3495 "conflicting snapshot '%s' from parent '%s'"),
3496 zc.zc_string, parent);
3497 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3500 return (zfs_standard_error(hdl, save_errno, errbuf));
3506 typedef struct snapdata {
3508 const char *sd_snapname;
3512 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
3514 snapdata_t *sd = arg;
3515 char name[ZFS_MAXNAMELEN];
3518 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) == 0) {
3519 (void) snprintf(name, sizeof (name),
3520 "%s@%s", zfs_get_name(zhp), sd->sd_snapname);
3522 fnvlist_add_boolean(sd->sd_nvl, name);
3524 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
3532 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3536 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
3543 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3544 "cannot create snapshots "));
3547 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
3548 const char *snapname = nvpair_name(elem);
3550 /* validate the target name */
3551 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
3553 (void) snprintf(errbuf, sizeof (errbuf),
3554 dgettext(TEXT_DOMAIN,
3555 "cannot create snapshot '%s'"), snapname);
3556 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3560 if (props != NULL &&
3561 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3562 props, B_FALSE, NULL, errbuf)) == NULL) {
3566 ret = lzc_snapshot(snaps, props, &errors);
3569 boolean_t printed = B_FALSE;
3570 for (elem = nvlist_next_nvpair(errors, NULL);
3572 elem = nvlist_next_nvpair(errors, elem)) {
3573 (void) snprintf(errbuf, sizeof (errbuf),
3574 dgettext(TEXT_DOMAIN,
3575 "cannot create snapshot '%s'"), nvpair_name(elem));
3576 (void) zfs_standard_error(hdl,
3577 fnvpair_value_int32(elem), errbuf);
3583 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3584 "multiple snapshots of same "
3586 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3590 (void) zfs_standard_error(hdl, ret, errbuf);
3596 nvlist_free(errors);
3601 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3605 snapdata_t sd = { 0 };
3606 char fsname[ZFS_MAXNAMELEN];
3611 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3612 "cannot snapshot %s"), path);
3614 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3615 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3617 (void) strlcpy(fsname, path, sizeof (fsname));
3618 cp = strchr(fsname, '@');
3620 sd.sd_snapname = cp + 1;
3622 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
3623 ZFS_TYPE_VOLUME)) == NULL) {
3627 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
3629 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
3631 fnvlist_add_boolean(sd.sd_nvl, path);
3634 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
3635 nvlist_free(sd.sd_nvl);
3641 * Destroy any more recent snapshots. We invoke this callback on any dependents
3642 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3643 * is a dependent and we should just destroy it without checking the transaction
3646 typedef struct rollback_data {
3647 const char *cb_target; /* the snapshot */
3648 uint64_t cb_create; /* creation time reference */
3654 rollback_destroy_dependent(zfs_handle_t *zhp, void *data)
3656 rollback_data_t *cbp = data;
3657 prop_changelist_t *clp;
3659 /* We must destroy this clone; first unmount it */
3660 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3661 cbp->cb_force ? MS_FORCE: 0);
3662 if (clp == NULL || changelist_prefix(clp) != 0) {
3663 cbp->cb_error = B_TRUE;
3667 if (zfs_destroy(zhp, B_FALSE) != 0)
3668 cbp->cb_error = B_TRUE;
3670 changelist_remove(clp, zhp->zfs_name);
3671 (void) changelist_postfix(clp);
3672 changelist_free(clp);
3679 rollback_destroy(zfs_handle_t *zhp, void *data)
3681 rollback_data_t *cbp = data;
3683 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > cbp->cb_create) {
3684 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3685 rollback_destroy_dependent, cbp);
3687 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3695 * Given a dataset, rollback to a specific snapshot, discarding any
3696 * data changes since then and making it the active dataset.
3698 * Any snapshots and bookmarks more recent than the target are
3699 * destroyed, along with their dependents (i.e. clones).
3702 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3704 rollback_data_t cb = { 0 };
3706 boolean_t restore_resv = 0;
3707 uint64_t old_volsize = 0, new_volsize;
3708 zfs_prop_t resv_prop = { 0 };
3710 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3711 zhp->zfs_type == ZFS_TYPE_VOLUME);
3714 * Destroy all recent snapshots and their dependents.
3716 cb.cb_force = force;
3717 cb.cb_target = snap->zfs_name;
3718 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3719 (void) zfs_iter_snapshots(zhp, B_FALSE, rollback_destroy, &cb);
3720 (void) zfs_iter_bookmarks(zhp, rollback_destroy, &cb);
3726 * Now that we have verified that the snapshot is the latest,
3727 * rollback to the given snapshot.
3730 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
3731 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
3733 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3735 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
3739 * We rely on zfs_iter_children() to verify that there are no
3740 * newer snapshots for the given dataset. Therefore, we can
3741 * simply pass the name on to the ioctl() call. There is still
3742 * an unlikely race condition where the user has taken a
3743 * snapshot since we verified that this was the most recent.
3745 err = lzc_rollback(zhp->zfs_name, NULL, 0);
3747 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3748 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
3754 * For volumes, if the pre-rollback volsize matched the pre-
3755 * rollback reservation and the volsize has changed then set
3756 * the reservation property to the post-rollback volsize.
3757 * Make a new handle since the rollback closed the dataset.
3759 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
3760 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
3762 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3763 if (old_volsize != new_volsize)
3764 err = zfs_prop_set_int(zhp, resv_prop,
3773 * Renames the given dataset.
3776 zfs_rename(zfs_handle_t *zhp, const char *target, boolean_t recursive,
3777 boolean_t force_unmount)
3780 zfs_cmd_t zc = {"\0"};
3782 prop_changelist_t *cl = NULL;
3783 zfs_handle_t *zhrp = NULL;
3784 char *parentname = NULL;
3785 char parent[ZFS_MAXNAMELEN];
3786 libzfs_handle_t *hdl = zhp->zfs_hdl;
3789 /* if we have the same exact name, just return success */
3790 if (strcmp(zhp->zfs_name, target) == 0)
3793 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3794 "cannot rename to '%s'"), target);
3797 * Make sure the target name is valid
3799 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3800 if ((strchr(target, '@') == NULL) ||
3803 * Snapshot target name is abbreviated,
3804 * reconstruct full dataset name
3806 (void) strlcpy(parent, zhp->zfs_name,
3808 delim = strchr(parent, '@');
3809 if (strchr(target, '@') == NULL)
3813 (void) strlcat(parent, target, sizeof (parent));
3817 * Make sure we're renaming within the same dataset.
3819 delim = strchr(target, '@');
3820 if (strncmp(zhp->zfs_name, target, delim - target)
3821 != 0 || zhp->zfs_name[delim - target] != '@') {
3822 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3823 "snapshots must be part of same "
3825 return (zfs_error(hdl, EZFS_CROSSTARGET,
3829 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3830 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3833 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3834 "recursive rename must be a snapshot"));
3835 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3838 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3839 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3841 /* validate parents */
3842 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
3845 /* make sure we're in the same pool */
3846 verify((delim = strchr(target, '/')) != NULL);
3847 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
3848 zhp->zfs_name[delim - target] != '/') {
3849 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3850 "datasets must be within same pool"));
3851 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
3854 /* new name cannot be a child of the current dataset name */
3855 if (is_descendant(zhp->zfs_name, target)) {
3856 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3857 "New dataset name cannot be a descendant of "
3858 "current dataset name"));
3859 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3863 (void) snprintf(errbuf, sizeof (errbuf),
3864 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
3866 if (getzoneid() == GLOBAL_ZONEID &&
3867 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
3868 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3869 "dataset is used in a non-global zone"));
3870 return (zfs_error(hdl, EZFS_ZONED, errbuf));
3875 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
3876 if (parentname == NULL) {
3880 delim = strchr(parentname, '@');
3882 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
3889 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3890 force_unmount ? MS_FORCE : 0)) == NULL)
3893 if (changelist_haszonedchild(cl)) {
3894 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3895 "child dataset with inherited mountpoint is used "
3896 "in a non-global zone"));
3897 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
3902 if ((ret = changelist_prefix(cl)) != 0)
3906 if (ZFS_IS_VOLUME(zhp))
3907 zc.zc_objset_type = DMU_OST_ZVOL;
3909 zc.zc_objset_type = DMU_OST_ZFS;
3911 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3912 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
3914 zc.zc_cookie = recursive;
3916 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
3918 * if it was recursive, the one that actually failed will
3921 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3922 "cannot rename '%s'"), zc.zc_name);
3924 if (recursive && errno == EEXIST) {
3925 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3926 "a child dataset already has a snapshot "
3927 "with the new name"));
3928 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3930 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
3934 * On failure, we still want to remount any filesystems that
3935 * were previously mounted, so we don't alter the system state.
3938 (void) changelist_postfix(cl);
3941 changelist_rename(cl, zfs_get_name(zhp), target);
3942 ret = changelist_postfix(cl);
3954 changelist_free(cl);
3960 zfs_get_user_props(zfs_handle_t *zhp)
3962 return (zhp->zfs_user_props);
3966 * This function is used by 'zfs list' to determine the exact set of columns to
3967 * display, and their maximum widths. This does two main things:
3969 * - If this is a list of all properties, then expand the list to include
3970 * all native properties, and set a flag so that for each dataset we look
3971 * for new unique user properties and add them to the list.
3973 * - For non fixed-width properties, keep track of the maximum width seen
3974 * so that we can size the column appropriately. If the user has
3975 * requested received property values, we also need to compute the width
3976 * of the RECEIVED column.
3979 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received,
3982 libzfs_handle_t *hdl = zhp->zfs_hdl;
3983 zprop_list_t *entry;
3984 zprop_list_t **last, **start;
3985 nvlist_t *userprops, *propval;
3988 char buf[ZFS_MAXPROPLEN];
3990 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
3993 userprops = zfs_get_user_props(zhp);
3996 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
3998 * Go through and add any user properties as necessary. We
3999 * start by incrementing our list pointer to the first
4000 * non-native property.
4003 while (*start != NULL) {
4004 if ((*start)->pl_prop == ZPROP_INVAL)
4006 start = &(*start)->pl_next;
4010 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
4012 * See if we've already found this property in our list.
4014 for (last = start; *last != NULL;
4015 last = &(*last)->pl_next) {
4016 if (strcmp((*last)->pl_user_prop,
4017 nvpair_name(elem)) == 0)
4021 if (*last == NULL) {
4022 if ((entry = zfs_alloc(hdl,
4023 sizeof (zprop_list_t))) == NULL ||
4024 ((entry->pl_user_prop = zfs_strdup(hdl,
4025 nvpair_name(elem)))) == NULL) {
4030 entry->pl_prop = ZPROP_INVAL;
4031 entry->pl_width = strlen(nvpair_name(elem));
4032 entry->pl_all = B_TRUE;
4039 * Now go through and check the width of any non-fixed columns
4041 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
4042 if (entry->pl_fixed && !literal)
4045 if (entry->pl_prop != ZPROP_INVAL) {
4046 if (zfs_prop_get(zhp, entry->pl_prop,
4047 buf, sizeof (buf), NULL, NULL, 0, literal) == 0) {
4048 if (strlen(buf) > entry->pl_width)
4049 entry->pl_width = strlen(buf);
4051 if (received && zfs_prop_get_recvd(zhp,
4052 zfs_prop_to_name(entry->pl_prop),
4053 buf, sizeof (buf), literal) == 0)
4054 if (strlen(buf) > entry->pl_recvd_width)
4055 entry->pl_recvd_width = strlen(buf);
4057 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
4059 verify(nvlist_lookup_string(propval,
4060 ZPROP_VALUE, &strval) == 0);
4061 if (strlen(strval) > entry->pl_width)
4062 entry->pl_width = strlen(strval);
4064 if (received && zfs_prop_get_recvd(zhp,
4065 entry->pl_user_prop,
4066 buf, sizeof (buf), literal) == 0)
4067 if (strlen(buf) > entry->pl_recvd_width)
4068 entry->pl_recvd_width = strlen(buf);
4076 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
4081 * Keep a reference to the props-table against which we prune the
4084 zhp->zfs_props_table = props;
4086 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
4089 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
4090 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
4093 * User properties will result in ZPROP_INVAL, and since we
4094 * only know how to prune standard ZFS properties, we always
4095 * leave these in the list. This can also happen if we
4096 * encounter an unknown DSL property (when running older
4097 * software, for example).
4099 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
4100 (void) nvlist_remove(zhp->zfs_props,
4101 nvpair_name(curr), nvpair_type(curr));
4107 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
4108 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
4110 zfs_cmd_t zc = {"\0"};
4111 nvlist_t *nvlist = NULL;
4114 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4115 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4116 zc.zc_cookie = (uint64_t)cmd;
4118 if (cmd == ZFS_SMB_ACL_RENAME) {
4119 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
4120 (void) no_memory(hdl);
4126 case ZFS_SMB_ACL_ADD:
4127 case ZFS_SMB_ACL_REMOVE:
4128 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4130 case ZFS_SMB_ACL_RENAME:
4131 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4133 (void) no_memory(hdl);
4136 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4138 (void) no_memory(hdl);
4141 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4142 nvlist_free(nvlist);
4146 case ZFS_SMB_ACL_PURGE:
4151 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4153 nvlist_free(nvlist);
4158 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4159 char *path, char *resource)
4161 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4166 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4167 char *path, char *resource)
4169 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4174 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4176 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4181 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4182 char *oldname, char *newname)
4184 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4189 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4190 zfs_userspace_cb_t func, void *arg)
4192 zfs_cmd_t zc = {"\0"};
4193 zfs_useracct_t buf[100];
4194 libzfs_handle_t *hdl = zhp->zfs_hdl;
4197 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4199 zc.zc_objset_type = type;
4200 zc.zc_nvlist_dst = (uintptr_t)buf;
4203 zfs_useracct_t *zua = buf;
4205 zc.zc_nvlist_dst_size = sizeof (buf);
4206 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4207 char errbuf[ZFS_MAXNAMELEN + 32];
4209 (void) snprintf(errbuf, sizeof (errbuf),
4210 dgettext(TEXT_DOMAIN,
4211 "cannot get used/quota for %s"), zc.zc_name);
4212 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4214 if (zc.zc_nvlist_dst_size == 0)
4217 while (zc.zc_nvlist_dst_size > 0) {
4218 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4219 zua->zu_space)) != 0)
4222 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4231 const char *snapname;
4233 boolean_t recursive;
4238 zfs_hold_one(zfs_handle_t *zhp, void *arg)
4240 struct holdarg *ha = arg;
4241 char name[ZFS_MAXNAMELEN];
4244 (void) snprintf(name, sizeof (name),
4245 "%s@%s", zhp->zfs_name, ha->snapname);
4247 if (lzc_exists(name))
4248 fnvlist_add_string(ha->nvl, name, ha->tag);
4251 rv = zfs_iter_filesystems(zhp, zfs_hold_one, ha);
4257 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4258 boolean_t recursive, int cleanup_fd)
4263 ha.nvl = fnvlist_alloc();
4264 ha.snapname = snapname;
4266 ha.recursive = recursive;
4267 (void) zfs_hold_one(zfs_handle_dup(zhp), &ha);
4269 if (nvlist_empty(ha.nvl)) {
4272 fnvlist_free(ha.nvl);
4274 (void) snprintf(errbuf, sizeof (errbuf),
4275 dgettext(TEXT_DOMAIN,
4276 "cannot hold snapshot '%s@%s'"),
4277 zhp->zfs_name, snapname);
4278 (void) zfs_standard_error(zhp->zfs_hdl, ret, errbuf);
4282 ret = zfs_hold_nvl(zhp, cleanup_fd, ha.nvl);
4283 fnvlist_free(ha.nvl);
4289 zfs_hold_nvl(zfs_handle_t *zhp, int cleanup_fd, nvlist_t *holds)
4293 libzfs_handle_t *hdl = zhp->zfs_hdl;
4298 ret = lzc_hold(holds, cleanup_fd, &errors);
4301 /* There may be errors even in the success case. */
4302 fnvlist_free(errors);
4306 if (nvlist_empty(errors)) {
4307 /* no hold-specific errors */
4308 (void) snprintf(errbuf, sizeof (errbuf),
4309 dgettext(TEXT_DOMAIN, "cannot hold"));
4312 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4313 "pool must be upgraded"));
4314 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4317 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4320 (void) zfs_standard_error(hdl, ret, errbuf);
4324 for (elem = nvlist_next_nvpair(errors, NULL);
4326 elem = nvlist_next_nvpair(errors, elem)) {
4327 (void) snprintf(errbuf, sizeof (errbuf),
4328 dgettext(TEXT_DOMAIN,
4329 "cannot hold snapshot '%s'"), nvpair_name(elem));
4330 switch (fnvpair_value_int32(elem)) {
4333 * Temporary tags wind up having the ds object id
4334 * prepended. So even if we passed the length check
4335 * above, it's still possible for the tag to wind
4336 * up being slightly too long.
4338 (void) zfs_error(hdl, EZFS_TAGTOOLONG, errbuf);
4341 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4344 (void) zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf);
4347 (void) zfs_standard_error(hdl,
4348 fnvpair_value_int32(elem), errbuf);
4352 fnvlist_free(errors);
4357 zfs_release_one(zfs_handle_t *zhp, void *arg)
4359 struct holdarg *ha = arg;
4360 char name[ZFS_MAXNAMELEN];
4362 nvlist_t *existing_holds;
4364 (void) snprintf(name, sizeof (name),
4365 "%s@%s", zhp->zfs_name, ha->snapname);
4367 if (lzc_get_holds(name, &existing_holds) != 0) {
4369 } else if (!nvlist_exists(existing_holds, ha->tag)) {
4372 nvlist_t *torelease = fnvlist_alloc();
4373 fnvlist_add_boolean(torelease, ha->tag);
4374 fnvlist_add_nvlist(ha->nvl, name, torelease);
4375 fnvlist_free(torelease);
4379 rv = zfs_iter_filesystems(zhp, zfs_release_one, ha);
4385 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4386 boolean_t recursive)
4390 nvlist_t *errors = NULL;
4392 libzfs_handle_t *hdl = zhp->zfs_hdl;
4395 ha.nvl = fnvlist_alloc();
4396 ha.snapname = snapname;
4398 ha.recursive = recursive;
4400 (void) zfs_release_one(zfs_handle_dup(zhp), &ha);
4402 if (nvlist_empty(ha.nvl)) {
4403 fnvlist_free(ha.nvl);
4405 (void) snprintf(errbuf, sizeof (errbuf),
4406 dgettext(TEXT_DOMAIN,
4407 "cannot release hold from snapshot '%s@%s'"),
4408 zhp->zfs_name, snapname);
4410 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4412 (void) zfs_standard_error(hdl, ret, errbuf);
4417 ret = lzc_release(ha.nvl, &errors);
4418 fnvlist_free(ha.nvl);
4421 /* There may be errors even in the success case. */
4422 fnvlist_free(errors);
4426 if (nvlist_empty(errors)) {
4427 /* no hold-specific errors */
4428 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4432 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4433 "pool must be upgraded"));
4434 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4437 (void) zfs_standard_error_fmt(hdl, errno, errbuf);
4441 for (elem = nvlist_next_nvpair(errors, NULL);
4443 elem = nvlist_next_nvpair(errors, elem)) {
4444 (void) snprintf(errbuf, sizeof (errbuf),
4445 dgettext(TEXT_DOMAIN,
4446 "cannot release hold from snapshot '%s'"),
4448 switch (fnvpair_value_int32(elem)) {
4450 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4453 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4456 (void) zfs_standard_error_fmt(hdl,
4457 fnvpair_value_int32(elem), errbuf);
4461 fnvlist_free(errors);
4466 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4468 zfs_cmd_t zc = {"\0"};
4469 libzfs_handle_t *hdl = zhp->zfs_hdl;
4475 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4476 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4480 nvbuf = malloc(nvsz);
4481 if (nvbuf == NULL) {
4482 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4486 zc.zc_nvlist_dst_size = nvsz;
4487 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4489 (void) strlcpy(zc.zc_name, zhp->zfs_name, ZFS_MAXNAMELEN);
4491 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4492 (void) snprintf(errbuf, sizeof (errbuf),
4493 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4498 nvsz = zc.zc_nvlist_dst_size;
4502 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4503 "pool must be upgraded"));
4504 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4507 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4510 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4513 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4518 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4520 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4521 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4523 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4533 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4535 zfs_cmd_t zc = {"\0"};
4536 libzfs_handle_t *hdl = zhp->zfs_hdl;
4542 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4543 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4545 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
4548 nvbuf = malloc(nvsz);
4550 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
4553 zc.zc_nvlist_src_size = nvsz;
4554 zc.zc_nvlist_src = (uintptr_t)nvbuf;
4555 zc.zc_perm_action = un;
4557 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4559 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
4560 (void) snprintf(errbuf, sizeof (errbuf),
4561 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
4565 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4566 "pool must be upgraded"));
4567 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4570 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4573 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4576 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4587 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
4592 err = lzc_get_holds(zhp->zfs_name, nvl);
4595 libzfs_handle_t *hdl = zhp->zfs_hdl;
4597 (void) snprintf(errbuf, sizeof (errbuf),
4598 dgettext(TEXT_DOMAIN, "cannot get holds for '%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);
4622 * Convert the zvol's volume size to an appropriate reservation.
4623 * Note: If this routine is updated, it is necessary to update the ZFS test
4624 * suite's shell version in reservation.kshlib.
4627 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4630 uint64_t nblocks, volblocksize;
4634 if (nvlist_lookup_string(props,
4635 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4636 ncopies = atoi(strval);
4639 if (nvlist_lookup_uint64(props,
4640 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4641 &volblocksize) != 0)
4642 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4643 nblocks = volsize/volblocksize;
4644 /* start with metadnode L0-L6 */
4646 /* calculate number of indirects */
4647 while (nblocks > 1) {
4648 nblocks += DNODES_PER_LEVEL - 1;
4649 nblocks /= DNODES_PER_LEVEL;
4652 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4655 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4656 * compressed, but in practice they compress down to about
4659 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;