4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
25 * Copyright (c) 2011, 2015 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>
53 #include <directory.h>
54 #endif /* HAVE_IDMAP */
56 #include <sys/dnode.h>
61 #include "zfs_namecheck.h"
63 #include "libzfs_impl.h"
64 #include "zfs_deleg.h"
66 static int userquota_propname_decode(const char *propname, boolean_t zoned,
67 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
70 * Given a single type (not a mask of types), return the type in a human
74 zfs_type_to_name(zfs_type_t type)
77 case ZFS_TYPE_FILESYSTEM:
78 return (dgettext(TEXT_DOMAIN, "filesystem"));
79 case ZFS_TYPE_SNAPSHOT:
80 return (dgettext(TEXT_DOMAIN, "snapshot"));
82 return (dgettext(TEXT_DOMAIN, "volume"));
91 * Validate a ZFS path. This is used even before trying to open the dataset, to
92 * provide a more meaningful error message. We call zfs_error_aux() to
93 * explain exactly why the name was not valid.
96 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
102 (void) zfs_prop_get_table();
103 if (dataset_namecheck(path, &why, &what) != 0) {
106 case NAME_ERR_TOOLONG:
107 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
108 "name is too long"));
111 case NAME_ERR_LEADING_SLASH:
112 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
113 "leading slash in name"));
116 case NAME_ERR_EMPTY_COMPONENT:
117 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
118 "empty component in name"));
121 case NAME_ERR_TRAILING_SLASH:
122 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
123 "trailing slash in name"));
126 case NAME_ERR_INVALCHAR:
128 dgettext(TEXT_DOMAIN, "invalid character "
129 "'%c' in name"), what);
132 case NAME_ERR_MULTIPLE_AT:
133 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
134 "multiple '@' delimiters in name"));
137 case NAME_ERR_NOLETTER:
138 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
139 "pool doesn't begin with a letter"));
142 case NAME_ERR_RESERVED:
143 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
144 "name is reserved"));
147 case NAME_ERR_DISKLIKE:
148 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
149 "reserved disk name"));
159 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
161 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
162 "snapshot delimiter '@' in filesystem name"));
166 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
168 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
169 "missing '@' delimiter in snapshot name"));
173 if (modifying && strchr(path, '%') != NULL) {
175 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
176 "invalid character %c in name"), '%');
184 zfs_name_valid(const char *name, zfs_type_t type)
186 if (type == ZFS_TYPE_POOL)
187 return (zpool_name_valid(NULL, B_FALSE, name));
188 return (zfs_validate_name(NULL, name, type, B_FALSE));
192 * This function takes the raw DSL properties, and filters out the user-defined
193 * properties into a separate nvlist.
196 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
198 libzfs_handle_t *hdl = zhp->zfs_hdl;
203 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
204 (void) no_memory(hdl);
209 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
210 if (!zfs_prop_user(nvpair_name(elem)))
213 verify(nvpair_value_nvlist(elem, &propval) == 0);
214 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
216 (void) no_memory(hdl);
224 static zpool_handle_t *
225 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
227 libzfs_handle_t *hdl = zhp->zfs_hdl;
230 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
231 if (hdl->libzfs_pool_handles != NULL)
232 zph->zpool_next = hdl->libzfs_pool_handles;
233 hdl->libzfs_pool_handles = zph;
238 static zpool_handle_t *
239 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
241 libzfs_handle_t *hdl = zhp->zfs_hdl;
242 zpool_handle_t *zph = hdl->libzfs_pool_handles;
244 while ((zph != NULL) &&
245 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
246 zph = zph->zpool_next;
251 * Returns a handle to the pool that contains the provided dataset.
252 * If a handle to that pool already exists then that handle is returned.
253 * Otherwise, a new handle is created and added to the list of handles.
255 static zpool_handle_t *
256 zpool_handle(zfs_handle_t *zhp)
262 len = strcspn(zhp->zfs_name, "/@#") + 1;
263 pool_name = zfs_alloc(zhp->zfs_hdl, len);
264 (void) strlcpy(pool_name, zhp->zfs_name, len);
266 zph = zpool_find_handle(zhp, pool_name, len);
268 zph = zpool_add_handle(zhp, pool_name);
275 zpool_free_handles(libzfs_handle_t *hdl)
277 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
279 while (zph != NULL) {
280 next = zph->zpool_next;
284 hdl->libzfs_pool_handles = NULL;
288 * Utility function to gather stats (objset and zpl) for the given object.
291 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
293 libzfs_handle_t *hdl = zhp->zfs_hdl;
295 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
297 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, zc) != 0) {
298 if (errno == ENOMEM) {
299 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
310 * Utility function to get the received properties of the given object.
313 get_recvd_props_ioctl(zfs_handle_t *zhp)
315 libzfs_handle_t *hdl = zhp->zfs_hdl;
316 nvlist_t *recvdprops;
317 zfs_cmd_t zc = {"\0"};
320 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
323 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
325 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
326 if (errno == ENOMEM) {
327 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
331 zcmd_free_nvlists(&zc);
336 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
337 zcmd_free_nvlists(&zc);
341 nvlist_free(zhp->zfs_recvd_props);
342 zhp->zfs_recvd_props = recvdprops;
348 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
350 nvlist_t *allprops, *userprops;
352 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
354 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
359 * XXX Why do we store the user props separately, in addition to
360 * storing them in zfs_props?
362 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
363 nvlist_free(allprops);
367 nvlist_free(zhp->zfs_props);
368 nvlist_free(zhp->zfs_user_props);
370 zhp->zfs_props = allprops;
371 zhp->zfs_user_props = userprops;
377 get_stats(zfs_handle_t *zhp)
380 zfs_cmd_t zc = {"\0"};
382 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
384 if (get_stats_ioctl(zhp, &zc) != 0)
386 else if (put_stats_zhdl(zhp, &zc) != 0)
388 zcmd_free_nvlists(&zc);
393 * Refresh the properties currently stored in the handle.
396 zfs_refresh_properties(zfs_handle_t *zhp)
398 (void) get_stats(zhp);
402 * Makes a handle from the given dataset name. Used by zfs_open() and
403 * zfs_iter_* to create child handles on the fly.
406 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
408 if (put_stats_zhdl(zhp, zc) != 0)
412 * We've managed to open the dataset and gather statistics. Determine
413 * the high-level type.
415 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
416 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
417 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
418 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
419 else if (zhp->zfs_dmustats.dds_type == DMU_OST_OTHER)
424 if (zhp->zfs_dmustats.dds_is_snapshot)
425 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
426 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
427 zhp->zfs_type = ZFS_TYPE_VOLUME;
428 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
429 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
431 abort(); /* we should never see any other types */
433 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
440 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
442 zfs_cmd_t zc = {"\0"};
444 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
450 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
451 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
455 if (get_stats_ioctl(zhp, &zc) == -1) {
456 zcmd_free_nvlists(&zc);
460 if (make_dataset_handle_common(zhp, &zc) == -1) {
464 zcmd_free_nvlists(&zc);
469 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
471 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
477 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
478 if (make_dataset_handle_common(zhp, zc) == -1) {
486 make_dataset_simple_handle_zc(zfs_handle_t *pzhp, zfs_cmd_t *zc)
488 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
493 zhp->zfs_hdl = pzhp->zfs_hdl;
494 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
495 zhp->zfs_head_type = pzhp->zfs_type;
496 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
497 zhp->zpool_hdl = zpool_handle(zhp);
503 zfs_handle_dup(zfs_handle_t *zhp_orig)
505 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
510 zhp->zfs_hdl = zhp_orig->zfs_hdl;
511 zhp->zpool_hdl = zhp_orig->zpool_hdl;
512 (void) strlcpy(zhp->zfs_name, zhp_orig->zfs_name,
513 sizeof (zhp->zfs_name));
514 zhp->zfs_type = zhp_orig->zfs_type;
515 zhp->zfs_head_type = zhp_orig->zfs_head_type;
516 zhp->zfs_dmustats = zhp_orig->zfs_dmustats;
517 if (zhp_orig->zfs_props != NULL) {
518 if (nvlist_dup(zhp_orig->zfs_props, &zhp->zfs_props, 0) != 0) {
519 (void) no_memory(zhp->zfs_hdl);
524 if (zhp_orig->zfs_user_props != NULL) {
525 if (nvlist_dup(zhp_orig->zfs_user_props,
526 &zhp->zfs_user_props, 0) != 0) {
527 (void) no_memory(zhp->zfs_hdl);
532 if (zhp_orig->zfs_recvd_props != NULL) {
533 if (nvlist_dup(zhp_orig->zfs_recvd_props,
534 &zhp->zfs_recvd_props, 0)) {
535 (void) no_memory(zhp->zfs_hdl);
540 zhp->zfs_mntcheck = zhp_orig->zfs_mntcheck;
541 if (zhp_orig->zfs_mntopts != NULL) {
542 zhp->zfs_mntopts = zfs_strdup(zhp_orig->zfs_hdl,
543 zhp_orig->zfs_mntopts);
545 zhp->zfs_props_table = zhp_orig->zfs_props_table;
550 zfs_bookmark_exists(const char *path)
554 char fsname[ZFS_MAX_DATASET_NAME_LEN];
561 (void) strlcpy(fsname, path, sizeof (fsname));
562 pound = strchr(fsname, '#');
567 bmark_name = pound + 1;
568 props = fnvlist_alloc();
569 err = lzc_get_bookmarks(fsname, props, &bmarks);
576 rv = nvlist_exists(bmarks, bmark_name);
582 make_bookmark_handle(zfs_handle_t *parent, const char *path,
583 nvlist_t *bmark_props)
585 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
590 /* Fill in the name. */
591 zhp->zfs_hdl = parent->zfs_hdl;
592 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
594 /* Set the property lists. */
595 if (nvlist_dup(bmark_props, &zhp->zfs_props, 0) != 0) {
601 zhp->zfs_head_type = parent->zfs_head_type;
602 zhp->zfs_type = ZFS_TYPE_BOOKMARK;
604 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL) {
605 nvlist_free(zhp->zfs_props);
614 * Opens the given snapshot, filesystem, or volume. The 'types'
615 * argument is a mask of acceptable types. The function will print an
616 * appropriate error message and return NULL if it can't be opened.
619 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
624 (void) snprintf(errbuf, sizeof (errbuf),
625 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
628 * Validate the name before we even try to open it.
630 if (!zfs_validate_name(hdl, path, ZFS_TYPE_DATASET, B_FALSE)) {
631 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
632 "invalid dataset name"));
633 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
638 * Try to get stats for the dataset, which will tell us if it exists.
641 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
642 (void) zfs_standard_error(hdl, errno, errbuf);
646 if (!(types & zhp->zfs_type)) {
647 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
656 * Release a ZFS handle. Nothing to do but free the associated memory.
659 zfs_close(zfs_handle_t *zhp)
661 if (zhp->zfs_mntopts)
662 free(zhp->zfs_mntopts);
663 nvlist_free(zhp->zfs_props);
664 nvlist_free(zhp->zfs_user_props);
665 nvlist_free(zhp->zfs_recvd_props);
669 typedef struct mnttab_node {
670 struct mnttab mtn_mt;
675 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
677 const mnttab_node_t *mtn1 = (const mnttab_node_t *)arg1;
678 const mnttab_node_t *mtn2 = (const mnttab_node_t *)arg2;
681 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
683 return (AVL_ISIGN(rv));
687 libzfs_mnttab_init(libzfs_handle_t *hdl)
689 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
690 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
691 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
695 libzfs_mnttab_update(libzfs_handle_t *hdl)
699 /* Reopen MNTTAB to prevent reading stale data from open file */
700 if (freopen(MNTTAB, "r", hdl->libzfs_mnttab) == NULL)
703 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
707 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
710 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
711 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
712 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
713 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
714 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
716 /* Exclude duplicate mounts */
717 if (avl_find(&hdl->libzfs_mnttab_cache, mtn, &where) != NULL) {
718 free(mtn->mtn_mt.mnt_special);
719 free(mtn->mtn_mt.mnt_mountp);
720 free(mtn->mtn_mt.mnt_fstype);
721 free(mtn->mtn_mt.mnt_mntopts);
726 avl_add(&hdl->libzfs_mnttab_cache, mtn);
733 libzfs_mnttab_fini(libzfs_handle_t *hdl)
738 while ((mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie))) {
739 free(mtn->mtn_mt.mnt_special);
740 free(mtn->mtn_mt.mnt_mountp);
741 free(mtn->mtn_mt.mnt_fstype);
742 free(mtn->mtn_mt.mnt_mntopts);
745 avl_destroy(&hdl->libzfs_mnttab_cache);
749 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
751 hdl->libzfs_mnttab_enable = enable;
755 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
756 struct mnttab *entry)
762 if (!hdl->libzfs_mnttab_enable) {
763 struct mnttab srch = { 0 };
765 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
766 libzfs_mnttab_fini(hdl);
768 /* Reopen MNTTAB to prevent reading stale data from open file */
769 if (freopen(MNTTAB, "r", hdl->libzfs_mnttab) == NULL)
772 srch.mnt_special = (char *)fsname;
773 srch.mnt_fstype = MNTTYPE_ZFS;
774 if (getmntany(hdl->libzfs_mnttab, entry, &srch) == 0)
780 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
781 if ((error = libzfs_mnttab_update(hdl)) != 0)
784 find.mtn_mt.mnt_special = (char *)fsname;
785 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
787 *entry = mtn->mtn_mt;
794 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
795 const char *mountp, const char *mntopts)
799 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
801 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
802 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
803 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
804 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
805 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
806 avl_add(&hdl->libzfs_mnttab_cache, mtn);
810 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
815 find.mtn_mt.mnt_special = (char *)fsname;
816 if ((ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL))) {
817 avl_remove(&hdl->libzfs_mnttab_cache, ret);
818 free(ret->mtn_mt.mnt_special);
819 free(ret->mtn_mt.mnt_mountp);
820 free(ret->mtn_mt.mnt_fstype);
821 free(ret->mtn_mt.mnt_mntopts);
827 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
829 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
831 if (zpool_handle == NULL)
834 *spa_version = zpool_get_prop_int(zpool_handle,
835 ZPOOL_PROP_VERSION, NULL);
840 * The choice of reservation property depends on the SPA version.
843 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
847 if (zfs_spa_version(zhp, &spa_version) < 0)
850 if (spa_version >= SPA_VERSION_REFRESERVATION)
851 *resv_prop = ZFS_PROP_REFRESERVATION;
853 *resv_prop = ZFS_PROP_RESERVATION;
859 * Given an nvlist of properties to set, validates that they are correct, and
860 * parses any numeric properties (index, boolean, etc) if they are specified as
864 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
865 uint64_t zoned, zfs_handle_t *zhp, zpool_handle_t *zpool_hdl,
873 int chosen_normal = -1;
876 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
877 (void) no_memory(hdl);
882 * Make sure this property is valid and applies to this type.
886 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
887 const char *propname = nvpair_name(elem);
889 prop = zfs_name_to_prop(propname);
890 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
892 * This is a user property: make sure it's a
893 * string, and that it's less than ZAP_MAXNAMELEN.
895 if (nvpair_type(elem) != DATA_TYPE_STRING) {
896 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
897 "'%s' must be a string"), propname);
898 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
902 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
903 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
904 "property name '%s' is too long"),
906 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
910 (void) nvpair_value_string(elem, &strval);
911 if (nvlist_add_string(ret, propname, strval) != 0) {
912 (void) no_memory(hdl);
919 * Currently, only user properties can be modified on
922 if (type == ZFS_TYPE_SNAPSHOT) {
923 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
924 "this property can not be modified for snapshots"));
925 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
929 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
930 zfs_userquota_prop_t uqtype;
931 char newpropname[128];
936 if (userquota_propname_decode(propname, zoned,
937 &uqtype, domain, sizeof (domain), &rid) != 0) {
939 dgettext(TEXT_DOMAIN,
940 "'%s' has an invalid user/group name"),
942 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
946 if (uqtype != ZFS_PROP_USERQUOTA &&
947 uqtype != ZFS_PROP_GROUPQUOTA &&
948 uqtype != ZFS_PROP_USEROBJQUOTA &&
949 uqtype != ZFS_PROP_GROUPOBJQUOTA) {
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_VOLBLOCKSIZE:
1059 case ZFS_PROP_RECORDSIZE:
1061 int maxbs = SPA_MAXBLOCKSIZE;
1064 if (zpool_hdl != NULL) {
1065 maxbs = zpool_get_prop_int(zpool_hdl,
1066 ZPOOL_PROP_MAXBLOCKSIZE, NULL);
1069 * The value must be a power of two between
1070 * SPA_MINBLOCKSIZE and maxbs.
1072 if (intval < SPA_MINBLOCKSIZE ||
1073 intval > maxbs || !ISP2(intval)) {
1074 zfs_nicenum(maxbs, buf, sizeof (buf));
1075 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1076 "'%s' must be power of 2 from 512B "
1077 "to %s"), propname, buf);
1078 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1083 case ZFS_PROP_MLSLABEL:
1085 #ifdef HAVE_MLSLABEL
1087 * Verify the mlslabel string and convert to
1088 * internal hex label string.
1092 char *hex = NULL; /* internal label string */
1094 /* Default value is already OK. */
1095 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
1098 /* Verify the label can be converted to binary form */
1099 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
1100 (str_to_label(strval, &new_sl, MAC_LABEL,
1101 L_NO_CORRECTION, NULL) == -1)) {
1105 /* Now translate to hex internal label string */
1106 if (label_to_str(new_sl, &hex, M_INTERNAL,
1112 m_label_free(new_sl);
1114 /* If string is already in internal form, we're done. */
1115 if (strcmp(strval, hex) == 0) {
1120 /* Replace the label string with the internal form. */
1121 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
1123 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
1130 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1131 "invalid mlslabel '%s'"), strval);
1132 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1133 m_label_free(new_sl); /* OK if null */
1136 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1137 "mlslabels are unsupported"));
1138 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1140 #endif /* HAVE_MLSLABEL */
1143 case ZFS_PROP_MOUNTPOINT:
1145 namecheck_err_t why;
1147 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1148 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1151 if (mountpoint_namecheck(strval, &why)) {
1153 case NAME_ERR_LEADING_SLASH:
1155 dgettext(TEXT_DOMAIN,
1156 "'%s' must be an absolute path, "
1157 "'none', or 'legacy'"), propname);
1159 case NAME_ERR_TOOLONG:
1161 dgettext(TEXT_DOMAIN,
1162 "component of '%s' is too long"),
1168 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1175 case ZFS_PROP_SHARESMB:
1176 case ZFS_PROP_SHARENFS:
1178 * For the mountpoint and sharenfs or sharesmb
1179 * properties, check if it can be set in a
1180 * global/non-global zone based on
1181 * the zoned property value:
1183 * global zone non-global zone
1184 * --------------------------------------------------
1185 * zoned=on mountpoint (no) mountpoint (yes)
1186 * sharenfs (no) sharenfs (no)
1187 * sharesmb (no) sharesmb (no)
1189 * zoned=off mountpoint (yes) N/A
1194 if (getzoneid() == GLOBAL_ZONEID) {
1195 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1196 "'%s' cannot be set on "
1197 "dataset in a non-global zone"),
1199 (void) zfs_error(hdl, EZFS_ZONED,
1202 } else if (prop == ZFS_PROP_SHARENFS ||
1203 prop == ZFS_PROP_SHARESMB) {
1204 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1205 "'%s' cannot be set in "
1206 "a non-global zone"), propname);
1207 (void) zfs_error(hdl, EZFS_ZONED,
1211 } else if (getzoneid() != GLOBAL_ZONEID) {
1213 * If zoned property is 'off', this must be in
1214 * a global zone. If not, something is wrong.
1216 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1217 "'%s' cannot be set while dataset "
1218 "'zoned' property is set"), propname);
1219 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1224 * At this point, it is legitimate to set the
1225 * property. Now we want to make sure that the
1226 * property value is valid if it is sharenfs.
1228 if ((prop == ZFS_PROP_SHARENFS ||
1229 prop == ZFS_PROP_SHARESMB) &&
1230 strcmp(strval, "on") != 0 &&
1231 strcmp(strval, "off") != 0) {
1232 zfs_share_proto_t proto;
1234 if (prop == ZFS_PROP_SHARESMB)
1240 * Must be an valid sharing protocol
1241 * option string so init the libshare
1242 * in order to enable the parser and
1243 * then parse the options. We use the
1244 * control API since we don't care about
1245 * the current configuration and don't
1246 * want the overhead of loading it
1247 * until we actually do something.
1250 if (zfs_init_libshare(hdl,
1251 SA_INIT_CONTROL_API) != SA_OK) {
1253 * An error occurred so we can't do
1256 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1257 "'%s' cannot be set: problem "
1258 "in share initialization"),
1260 (void) zfs_error(hdl, EZFS_BADPROP,
1265 if (zfs_parse_options(strval, proto) != SA_OK) {
1267 * There was an error in parsing so
1268 * deal with it by issuing an error
1269 * message and leaving after
1270 * uninitializing the the libshare
1273 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1274 "'%s' cannot be set to invalid "
1275 "options"), propname);
1276 (void) zfs_error(hdl, EZFS_BADPROP,
1278 zfs_uninit_libshare(hdl);
1281 zfs_uninit_libshare(hdl);
1285 case ZFS_PROP_UTF8ONLY:
1286 chosen_utf = (int)intval;
1288 case ZFS_PROP_NORMALIZE:
1289 chosen_normal = (int)intval;
1296 * For changes to existing volumes, we have some additional
1297 * checks to enforce.
1299 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1300 uint64_t volsize = zfs_prop_get_int(zhp,
1302 uint64_t blocksize = zfs_prop_get_int(zhp,
1303 ZFS_PROP_VOLBLOCKSIZE);
1307 case ZFS_PROP_RESERVATION:
1308 case ZFS_PROP_REFRESERVATION:
1309 if (intval > volsize) {
1310 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1311 "'%s' is greater than current "
1312 "volume size"), propname);
1313 (void) zfs_error(hdl, EZFS_BADPROP,
1319 case ZFS_PROP_VOLSIZE:
1320 if (intval % blocksize != 0) {
1321 zfs_nicenum(blocksize, buf,
1323 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1324 "'%s' must be a multiple of "
1325 "volume block size (%s)"),
1327 (void) zfs_error(hdl, EZFS_BADPROP,
1333 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1334 "'%s' cannot be zero"),
1336 (void) zfs_error(hdl, EZFS_BADPROP,
1348 * If normalization was chosen, but no UTF8 choice was made,
1349 * enforce rejection of non-UTF8 names.
1351 * If normalization was chosen, but rejecting non-UTF8 names
1352 * was explicitly not chosen, it is an error.
1354 if (chosen_normal > 0 && chosen_utf < 0) {
1355 if (nvlist_add_uint64(ret,
1356 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1357 (void) no_memory(hdl);
1360 } else if (chosen_normal > 0 && chosen_utf == 0) {
1361 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1362 "'%s' must be set 'on' if normalization chosen"),
1363 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1364 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1375 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1377 uint64_t old_volsize;
1378 uint64_t new_volsize;
1379 uint64_t old_reservation;
1380 uint64_t new_reservation;
1381 zfs_prop_t resv_prop;
1385 * If this is an existing volume, and someone is setting the volsize,
1386 * make sure that it matches the reservation, or add it if necessary.
1388 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1389 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1391 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1393 props = fnvlist_alloc();
1394 fnvlist_add_uint64(props, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
1395 zfs_prop_get_int(zhp, ZFS_PROP_VOLBLOCKSIZE));
1397 if ((zvol_volsize_to_reservation(old_volsize, props) !=
1398 old_reservation) || nvlist_exists(nvl,
1399 zfs_prop_to_name(resv_prop))) {
1400 fnvlist_free(props);
1403 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1404 &new_volsize) != 0) {
1405 fnvlist_free(props);
1408 new_reservation = zvol_volsize_to_reservation(new_volsize, props);
1409 fnvlist_free(props);
1411 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1412 new_reservation) != 0) {
1413 (void) no_memory(zhp->zfs_hdl);
1420 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1427 * For quotas and reservations, ENOSPC indicates
1428 * something different; setting a quota or reservation
1429 * doesn't use any disk space.
1432 case ZFS_PROP_QUOTA:
1433 case ZFS_PROP_REFQUOTA:
1434 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1435 "size is less than current used or "
1437 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1440 case ZFS_PROP_RESERVATION:
1441 case ZFS_PROP_REFRESERVATION:
1442 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1443 "size is greater than available space"));
1444 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1448 (void) zfs_standard_error(hdl, err, errbuf);
1454 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1458 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1462 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1463 "property value too long"));
1464 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1468 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1469 "pool and or dataset must be upgraded to set this "
1470 "property or value"));
1471 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1475 if (prop == ZFS_PROP_COMPRESSION ||
1476 prop == ZFS_PROP_DNODESIZE ||
1477 prop == ZFS_PROP_RECORDSIZE) {
1478 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1479 "property setting is not allowed on "
1480 "bootable datasets"));
1481 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1482 } else if (prop == ZFS_PROP_CHECKSUM ||
1483 prop == ZFS_PROP_DEDUP) {
1484 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1485 "property setting is not allowed on "
1487 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1489 (void) zfs_standard_error(hdl, err, errbuf);
1494 if (prop == ZPROP_INVAL) {
1495 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1497 (void) zfs_standard_error(hdl, err, errbuf);
1503 * This platform can't address a volume this big.
1506 if (prop == ZFS_PROP_VOLSIZE) {
1507 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1513 (void) zfs_standard_error(hdl, err, errbuf);
1518 zfs_is_namespace_prop(zfs_prop_t prop)
1522 case ZFS_PROP_ATIME:
1523 case ZFS_PROP_RELATIME:
1524 case ZFS_PROP_DEVICES:
1526 case ZFS_PROP_SETUID:
1527 case ZFS_PROP_READONLY:
1528 case ZFS_PROP_XATTR:
1529 case ZFS_PROP_NBMAND:
1538 * Given a property name and value, set the property for the given dataset.
1541 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1545 libzfs_handle_t *hdl = zhp->zfs_hdl;
1546 nvlist_t *nvl = NULL;
1548 (void) snprintf(errbuf, sizeof (errbuf),
1549 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1552 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1553 nvlist_add_string(nvl, propname, propval) != 0) {
1554 (void) no_memory(hdl);
1558 ret = zfs_prop_set_list(zhp, nvl);
1568 * Given an nvlist of property names and values, set the properties for the
1572 zfs_prop_set_list(zfs_handle_t *zhp, nvlist_t *props)
1574 zfs_cmd_t zc = {"\0"};
1576 prop_changelist_t **cls = NULL;
1579 libzfs_handle_t *hdl = zhp->zfs_hdl;
1583 zfs_prop_t prop = 0;
1586 (void) snprintf(errbuf, sizeof (errbuf),
1587 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1590 if ((nvl = zfs_valid_proplist(hdl, zhp->zfs_type, props,
1591 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, zhp->zpool_hdl,
1596 * We have to check for any extra properties which need to be added
1597 * before computing the length of the nvlist.
1599 for (elem = nvlist_next_nvpair(nvl, NULL);
1601 elem = nvlist_next_nvpair(nvl, elem)) {
1602 if (zfs_name_to_prop(nvpair_name(elem)) == ZFS_PROP_VOLSIZE &&
1603 (added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1) {
1608 * Check how many properties we're setting and allocate an array to
1609 * store changelist pointers for postfix().
1611 for (elem = nvlist_next_nvpair(nvl, NULL);
1613 elem = nvlist_next_nvpair(nvl, elem))
1615 if ((cls = calloc(nvl_len, sizeof (prop_changelist_t *))) == NULL)
1619 for (elem = nvlist_next_nvpair(nvl, NULL);
1621 elem = nvlist_next_nvpair(nvl, elem)) {
1623 prop = zfs_name_to_prop(nvpair_name(elem));
1625 assert(cl_idx < nvl_len);
1627 * We don't want to unmount & remount the dataset when changing
1628 * its canmount property to 'on' or 'noauto'. We only use
1629 * the changelist logic to unmount when setting canmount=off.
1631 if (!(prop == ZFS_PROP_CANMOUNT &&
1632 fnvpair_value_uint64(elem) != ZFS_CANMOUNT_OFF)) {
1633 cls[cl_idx] = changelist_gather(zhp, prop, 0, 0);
1634 if (cls[cl_idx] == NULL)
1638 if (prop == ZFS_PROP_MOUNTPOINT &&
1639 changelist_haszonedchild(cls[cl_idx])) {
1640 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1641 "child dataset with inherited mountpoint is used "
1642 "in a non-global zone"));
1643 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1647 if (cls[cl_idx] != NULL &&
1648 (ret = changelist_prefix(cls[cl_idx])) != 0)
1653 assert(cl_idx == nvl_len);
1656 * Execute the corresponding ioctl() to set this list of properties.
1658 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1660 if ((ret = zcmd_write_src_nvlist(hdl, &zc, nvl)) != 0 ||
1661 (ret = zcmd_alloc_dst_nvlist(hdl, &zc, 0)) != 0)
1664 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1667 /* Get the list of unset properties back and report them. */
1668 nvlist_t *errorprops = NULL;
1669 if (zcmd_read_dst_nvlist(hdl, &zc, &errorprops) != 0)
1671 for (elem = nvlist_next_nvpair(nvl, NULL);
1673 elem = nvlist_next_nvpair(nvl, elem)) {
1674 prop = zfs_name_to_prop(nvpair_name(elem));
1675 zfs_setprop_error(hdl, prop, errno, errbuf);
1677 nvlist_free(errorprops);
1679 if (added_resv && errno == ENOSPC) {
1680 /* clean up the volsize property we tried to set */
1681 uint64_t old_volsize = zfs_prop_get_int(zhp,
1685 zcmd_free_nvlists(&zc);
1687 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1689 if (nvlist_add_uint64(nvl,
1690 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1693 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1695 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1698 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1699 if (cls[cl_idx] != NULL) {
1700 int clp_err = changelist_postfix(cls[cl_idx]);
1708 * Refresh the statistics so the new property
1709 * value is reflected.
1711 (void) get_stats(zhp);
1714 * Remount the filesystem to propagate the change
1715 * if one of the options handled by the generic
1716 * Linux namespace layer has been modified.
1718 if (zfs_is_namespace_prop(prop) &&
1719 zfs_is_mounted(zhp, NULL))
1720 ret = zfs_mount(zhp, MNTOPT_REMOUNT, 0);
1726 zcmd_free_nvlists(&zc);
1728 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1729 if (cls[cl_idx] != NULL)
1730 changelist_free(cls[cl_idx]);
1738 * Given a property, inherit the value from the parent dataset, or if received
1739 * is TRUE, revert to the received value, if any.
1742 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1744 zfs_cmd_t zc = {"\0"};
1746 prop_changelist_t *cl;
1747 libzfs_handle_t *hdl = zhp->zfs_hdl;
1751 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1752 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1754 zc.zc_cookie = received;
1755 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1757 * For user properties, the amount of work we have to do is very
1758 * small, so just do it here.
1760 if (!zfs_prop_user(propname)) {
1761 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1762 "invalid property"));
1763 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1766 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1767 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1769 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1770 return (zfs_standard_error(hdl, errno, errbuf));
1776 * Verify that this property is inheritable.
1778 if (zfs_prop_readonly(prop))
1779 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1781 if (!zfs_prop_inheritable(prop) && !received)
1782 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1785 * Check to see if the value applies to this type
1787 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE))
1788 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1791 * Normalize the name, to get rid of shorthand abbreviations.
1793 propname = zfs_prop_to_name(prop);
1794 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1795 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1797 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1798 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1799 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1800 "dataset is used in a non-global zone"));
1801 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1805 * Determine datasets which will be affected by this change, if any.
1807 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1810 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1811 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1812 "child dataset with inherited mountpoint is used "
1813 "in a non-global zone"));
1814 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1818 if ((ret = changelist_prefix(cl)) != 0)
1821 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1822 return (zfs_standard_error(hdl, errno, errbuf));
1825 if ((ret = changelist_postfix(cl)) != 0)
1829 * Refresh the statistics so the new property is reflected.
1831 (void) get_stats(zhp);
1834 * Remount the filesystem to propagate the change
1835 * if one of the options handled by the generic
1836 * Linux namespace layer has been modified.
1838 if (zfs_is_namespace_prop(prop) &&
1839 zfs_is_mounted(zhp, NULL))
1840 ret = zfs_mount(zhp, MNTOPT_REMOUNT, 0);
1844 changelist_free(cl);
1849 * True DSL properties are stored in an nvlist. The following two functions
1850 * extract them appropriately.
1853 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1859 if (nvlist_lookup_nvlist(zhp->zfs_props,
1860 zfs_prop_to_name(prop), &nv) == 0) {
1861 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1862 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1864 verify(!zhp->zfs_props_table ||
1865 zhp->zfs_props_table[prop] == B_TRUE);
1866 value = zfs_prop_default_numeric(prop);
1874 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1880 if (nvlist_lookup_nvlist(zhp->zfs_props,
1881 zfs_prop_to_name(prop), &nv) == 0) {
1882 value = fnvlist_lookup_string(nv, ZPROP_VALUE);
1883 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1885 verify(!zhp->zfs_props_table ||
1886 zhp->zfs_props_table[prop] == B_TRUE);
1887 value = zfs_prop_default_string(prop);
1895 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
1897 return (zhp->zfs_props == zhp->zfs_recvd_props);
1901 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1903 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
1904 zhp->zfs_props = zhp->zfs_recvd_props;
1908 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1910 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
1915 * Internal function for getting a numeric property. Both zfs_prop_get() and
1916 * zfs_prop_get_int() are built using this interface.
1918 * Certain properties can be overridden using 'mount -o'. In this case, scan
1919 * the contents of the /proc/self/mounts entry, searching for the
1920 * appropriate options. If they differ from the on-disk values, report the
1921 * current values and mark the source "temporary".
1924 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
1925 char **source, uint64_t *val)
1927 zfs_cmd_t zc = {"\0"};
1928 nvlist_t *zplprops = NULL;
1930 char *mntopt_on = NULL;
1931 char *mntopt_off = NULL;
1932 boolean_t received = zfs_is_recvd_props_mode(zhp);
1937 * If the property is being fetched for a snapshot, check whether
1938 * the property is valid for the snapshot's head dataset type.
1940 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT &&
1941 !zfs_prop_valid_for_type(prop, zhp->zfs_head_type, B_TRUE)) {
1942 *val = zfs_prop_default_numeric(prop);
1947 case ZFS_PROP_ATIME:
1948 mntopt_on = MNTOPT_ATIME;
1949 mntopt_off = MNTOPT_NOATIME;
1952 case ZFS_PROP_RELATIME:
1953 mntopt_on = MNTOPT_RELATIME;
1954 mntopt_off = MNTOPT_NORELATIME;
1957 case ZFS_PROP_DEVICES:
1958 mntopt_on = MNTOPT_DEVICES;
1959 mntopt_off = MNTOPT_NODEVICES;
1963 mntopt_on = MNTOPT_EXEC;
1964 mntopt_off = MNTOPT_NOEXEC;
1967 case ZFS_PROP_READONLY:
1968 mntopt_on = MNTOPT_RO;
1969 mntopt_off = MNTOPT_RW;
1972 case ZFS_PROP_SETUID:
1973 mntopt_on = MNTOPT_SETUID;
1974 mntopt_off = MNTOPT_NOSETUID;
1977 case ZFS_PROP_XATTR:
1978 mntopt_on = MNTOPT_XATTR;
1979 mntopt_off = MNTOPT_NOXATTR;
1982 case ZFS_PROP_NBMAND:
1983 mntopt_on = MNTOPT_NBMAND;
1984 mntopt_off = MNTOPT_NONBMAND;
1991 * Because looking up the mount options is potentially expensive
1992 * (iterating over all of /proc/self/mounts), we defer its
1993 * calculation until we're looking up a property which requires
1996 if (!zhp->zfs_mntcheck &&
1997 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
1998 libzfs_handle_t *hdl = zhp->zfs_hdl;
1999 struct mnttab entry;
2001 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
2002 zhp->zfs_mntopts = zfs_strdup(hdl,
2004 if (zhp->zfs_mntopts == NULL)
2008 zhp->zfs_mntcheck = B_TRUE;
2011 if (zhp->zfs_mntopts == NULL)
2012 mnt.mnt_mntopts = "";
2014 mnt.mnt_mntopts = zhp->zfs_mntopts;
2017 case ZFS_PROP_ATIME:
2018 case ZFS_PROP_RELATIME:
2019 case ZFS_PROP_DEVICES:
2021 case ZFS_PROP_READONLY:
2022 case ZFS_PROP_SETUID:
2023 case ZFS_PROP_XATTR:
2024 case ZFS_PROP_NBMAND:
2025 *val = getprop_uint64(zhp, prop, source);
2030 if (hasmntopt(&mnt, mntopt_on) && !*val) {
2033 *src = ZPROP_SRC_TEMPORARY;
2034 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
2037 *src = ZPROP_SRC_TEMPORARY;
2041 case ZFS_PROP_CANMOUNT:
2042 case ZFS_PROP_VOLSIZE:
2043 case ZFS_PROP_QUOTA:
2044 case ZFS_PROP_REFQUOTA:
2045 case ZFS_PROP_RESERVATION:
2046 case ZFS_PROP_REFRESERVATION:
2047 case ZFS_PROP_FILESYSTEM_LIMIT:
2048 case ZFS_PROP_SNAPSHOT_LIMIT:
2049 case ZFS_PROP_FILESYSTEM_COUNT:
2050 case ZFS_PROP_SNAPSHOT_COUNT:
2051 *val = getprop_uint64(zhp, prop, source);
2053 if (*source == NULL) {
2054 /* not default, must be local */
2055 *source = zhp->zfs_name;
2059 case ZFS_PROP_MOUNTED:
2060 *val = (zhp->zfs_mntopts != NULL);
2063 case ZFS_PROP_NUMCLONES:
2064 *val = zhp->zfs_dmustats.dds_num_clones;
2067 case ZFS_PROP_VERSION:
2068 case ZFS_PROP_NORMALIZE:
2069 case ZFS_PROP_UTF8ONLY:
2071 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2073 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2074 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
2075 zcmd_free_nvlists(&zc);
2076 if (prop == ZFS_PROP_VERSION &&
2077 zhp->zfs_type == ZFS_TYPE_VOLUME)
2078 *val = zfs_prop_default_numeric(prop);
2081 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
2082 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
2084 zcmd_free_nvlists(&zc);
2087 nvlist_free(zplprops);
2088 zcmd_free_nvlists(&zc);
2091 case ZFS_PROP_INCONSISTENT:
2092 *val = zhp->zfs_dmustats.dds_inconsistent;
2096 switch (zfs_prop_get_type(prop)) {
2097 case PROP_TYPE_NUMBER:
2098 case PROP_TYPE_INDEX:
2099 *val = getprop_uint64(zhp, prop, source);
2101 * If we tried to use a default value for a
2102 * readonly property, it means that it was not
2105 if (zfs_prop_readonly(prop) &&
2106 *source != NULL && (*source)[0] == '\0') {
2111 case PROP_TYPE_STRING:
2113 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
2114 "cannot get non-numeric property"));
2115 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
2116 dgettext(TEXT_DOMAIN, "internal error")));
2124 * Calculate the source type, given the raw source string.
2127 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
2128 char *statbuf, size_t statlen)
2130 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
2133 if (source == NULL) {
2134 *srctype = ZPROP_SRC_NONE;
2135 } else if (source[0] == '\0') {
2136 *srctype = ZPROP_SRC_DEFAULT;
2137 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
2138 *srctype = ZPROP_SRC_RECEIVED;
2140 if (strcmp(source, zhp->zfs_name) == 0) {
2141 *srctype = ZPROP_SRC_LOCAL;
2143 (void) strlcpy(statbuf, source, statlen);
2144 *srctype = ZPROP_SRC_INHERITED;
2151 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
2152 size_t proplen, boolean_t literal)
2157 if (zhp->zfs_recvd_props == NULL)
2158 if (get_recvd_props_ioctl(zhp) != 0)
2161 prop = zfs_name_to_prop(propname);
2163 if (prop != ZPROP_INVAL) {
2165 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
2167 zfs_set_recvd_props_mode(zhp, &cookie);
2168 err = zfs_prop_get(zhp, prop, propbuf, proplen,
2169 NULL, NULL, 0, literal);
2170 zfs_unset_recvd_props_mode(zhp, &cookie);
2174 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
2175 propname, &propval) != 0)
2177 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
2179 (void) strlcpy(propbuf, recvdval, proplen);
2182 return (err == 0 ? 0 : -1);
2186 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2191 value = zfs_get_clones_nvl(zhp);
2196 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
2197 pair = nvlist_next_nvpair(value, pair)) {
2198 if (propbuf[0] != '\0')
2199 (void) strlcat(propbuf, ",", proplen);
2200 (void) strlcat(propbuf, nvpair_name(pair), proplen);
2206 struct get_clones_arg {
2210 char buf[ZFS_MAX_DATASET_NAME_LEN];
2214 get_clones_cb(zfs_handle_t *zhp, void *arg)
2216 struct get_clones_arg *gca = arg;
2218 if (gca->numclones == 0) {
2223 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
2224 NULL, NULL, 0, B_TRUE) != 0)
2226 if (strcmp(gca->buf, gca->origin) == 0) {
2227 fnvlist_add_boolean(gca->value, zfs_get_name(zhp));
2232 (void) zfs_iter_children(zhp, get_clones_cb, gca);
2238 zfs_get_clones_nvl(zfs_handle_t *zhp)
2240 nvlist_t *nv, *value;
2242 if (nvlist_lookup_nvlist(zhp->zfs_props,
2243 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
2244 struct get_clones_arg gca;
2247 * if this is a snapshot, then the kernel wasn't able
2248 * to get the clones. Do it by slowly iterating.
2250 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2252 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2254 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2259 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2261 gca.origin = zhp->zfs_name;
2263 if (gca.numclones != 0) {
2265 char pool[ZFS_MAX_DATASET_NAME_LEN];
2268 /* get the pool name */
2269 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2270 (void) strsep(&cp, "/@");
2271 root = zfs_open(zhp->zfs_hdl, pool,
2272 ZFS_TYPE_FILESYSTEM);
2279 (void) get_clones_cb(root, &gca);
2282 if (gca.numclones != 0 ||
2283 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2284 nvlist_add_nvlist(zhp->zfs_props,
2285 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2292 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2293 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2296 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2302 * Retrieve a property from the given object. If 'literal' is specified, then
2303 * numbers are left as exact values. Otherwise, numbers are converted to a
2304 * human-readable form.
2306 * Returns 0 on success, or -1 on error.
2309 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2310 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2312 char *source = NULL;
2316 boolean_t received = zfs_is_recvd_props_mode(zhp);
2319 * Check to see if this property applies to our object
2321 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE))
2324 if (received && zfs_prop_readonly(prop))
2328 *src = ZPROP_SRC_NONE;
2331 case ZFS_PROP_CREATION:
2333 * 'creation' is a time_t stored in the statistics. We convert
2334 * this into a string unless 'literal' is specified.
2337 val = getprop_uint64(zhp, prop, &source);
2338 time_t time = (time_t)val;
2342 localtime_r(&time, &t) == NULL ||
2343 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2345 (void) snprintf(propbuf, proplen, "%llu",
2346 (u_longlong_t) val);
2350 case ZFS_PROP_MOUNTPOINT:
2352 * Getting the precise mountpoint can be tricky.
2354 * - for 'none' or 'legacy', return those values.
2355 * - for inherited mountpoints, we want to take everything
2356 * after our ancestor and append it to the inherited value.
2358 * If the pool has an alternate root, we want to prepend that
2359 * root to any values we return.
2362 str = getprop_string(zhp, prop, &source);
2364 if (str[0] == '/') {
2365 char buf[MAXPATHLEN];
2367 const char *relpath;
2370 * If we inherit the mountpoint, even from a dataset
2371 * with a received value, the source will be the path of
2372 * the dataset we inherit from. If source is
2373 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2376 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2379 relpath = zhp->zfs_name + strlen(source);
2380 if (relpath[0] == '/')
2384 if ((zpool_get_prop(zhp->zpool_hdl,
2385 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2386 B_FALSE)) || (strcmp(root, "-") == 0))
2389 * Special case an alternate root of '/'. This will
2390 * avoid having multiple leading slashes in the
2393 if (strcmp(root, "/") == 0)
2397 * If the mountpoint is '/' then skip over this
2398 * if we are obtaining either an alternate root or
2399 * an inherited mountpoint.
2401 if (str[1] == '\0' && (root[0] != '\0' ||
2402 relpath[0] != '\0'))
2405 if (relpath[0] == '\0')
2406 (void) snprintf(propbuf, proplen, "%s%s",
2409 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2410 root, str, relpath[0] == '@' ? "" : "/",
2413 /* 'legacy' or 'none' */
2414 (void) strlcpy(propbuf, str, proplen);
2419 case ZFS_PROP_ORIGIN:
2420 str = getprop_string(zhp, prop, &source);
2423 (void) strlcpy(propbuf, str, proplen);
2426 case ZFS_PROP_CLONES:
2427 if (get_clones_string(zhp, propbuf, proplen) != 0)
2431 case ZFS_PROP_QUOTA:
2432 case ZFS_PROP_REFQUOTA:
2433 case ZFS_PROP_RESERVATION:
2434 case ZFS_PROP_REFRESERVATION:
2436 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2440 * If quota or reservation is 0, we translate this into 'none'
2441 * (unless literal is set), and indicate that it's the default
2442 * value. Otherwise, we print the number nicely and indicate
2443 * that its set locally.
2447 (void) strlcpy(propbuf, "0", proplen);
2449 (void) strlcpy(propbuf, "none", proplen);
2452 (void) snprintf(propbuf, proplen, "%llu",
2455 zfs_nicenum(val, propbuf, proplen);
2459 case ZFS_PROP_FILESYSTEM_LIMIT:
2460 case ZFS_PROP_SNAPSHOT_LIMIT:
2461 case ZFS_PROP_FILESYSTEM_COUNT:
2462 case ZFS_PROP_SNAPSHOT_COUNT:
2464 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2468 * If limit is UINT64_MAX, we translate this into 'none' (unless
2469 * literal is set), and indicate that it's the default value.
2470 * Otherwise, we print the number nicely and indicate that it's
2474 (void) snprintf(propbuf, proplen, "%llu",
2476 } else if (val == UINT64_MAX) {
2477 (void) strlcpy(propbuf, "none", proplen);
2479 zfs_nicenum(val, propbuf, proplen);
2483 case ZFS_PROP_REFRATIO:
2484 case ZFS_PROP_COMPRESSRATIO:
2485 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2487 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2488 (u_longlong_t)(val / 100),
2489 (u_longlong_t)(val % 100));
2493 switch (zhp->zfs_type) {
2494 case ZFS_TYPE_FILESYSTEM:
2497 case ZFS_TYPE_VOLUME:
2500 case ZFS_TYPE_SNAPSHOT:
2503 case ZFS_TYPE_BOOKMARK:
2509 (void) snprintf(propbuf, proplen, "%s", str);
2512 case ZFS_PROP_MOUNTED:
2514 * The 'mounted' property is a pseudo-property that described
2515 * whether the filesystem is currently mounted. Even though
2516 * it's a boolean value, the typical values of "on" and "off"
2517 * don't make sense, so we translate to "yes" and "no".
2519 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2520 src, &source, &val) != 0)
2523 (void) strlcpy(propbuf, "yes", proplen);
2525 (void) strlcpy(propbuf, "no", proplen);
2530 * The 'name' property is a pseudo-property derived from the
2531 * dataset name. It is presented as a real property to simplify
2534 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2537 case ZFS_PROP_MLSLABEL:
2539 #ifdef HAVE_MLSLABEL
2540 m_label_t *new_sl = NULL;
2541 char *ascii = NULL; /* human readable label */
2543 (void) strlcpy(propbuf,
2544 getprop_string(zhp, prop, &source), proplen);
2546 if (literal || (strcasecmp(propbuf,
2547 ZFS_MLSLABEL_DEFAULT) == 0))
2551 * Try to translate the internal hex string to
2552 * human-readable output. If there are any
2553 * problems just use the hex string.
2556 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2557 L_NO_CORRECTION, NULL) == -1) {
2558 m_label_free(new_sl);
2562 if (label_to_str(new_sl, &ascii, M_LABEL,
2566 m_label_free(new_sl);
2569 m_label_free(new_sl);
2571 (void) strlcpy(propbuf, ascii, proplen);
2574 (void) strlcpy(propbuf,
2575 getprop_string(zhp, prop, &source), proplen);
2576 #endif /* HAVE_MLSLABEL */
2582 * GUIDs are stored as numbers, but they are identifiers.
2583 * We don't want them to be pretty printed, because pretty
2584 * printing mangles the ID into a truncated and useless value.
2586 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2588 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2592 switch (zfs_prop_get_type(prop)) {
2593 case PROP_TYPE_NUMBER:
2594 if (get_numeric_property(zhp, prop, src,
2595 &source, &val) != 0)
2598 (void) snprintf(propbuf, proplen, "%llu",
2601 zfs_nicenum(val, propbuf, proplen);
2604 case PROP_TYPE_STRING:
2605 str = getprop_string(zhp, prop, &source);
2608 (void) strlcpy(propbuf, str, proplen);
2611 case PROP_TYPE_INDEX:
2612 if (get_numeric_property(zhp, prop, src,
2613 &source, &val) != 0)
2615 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2617 (void) strlcpy(propbuf, strval, proplen);
2625 get_source(zhp, src, source, statbuf, statlen);
2631 * Utility function to get the given numeric property. Does no validation that
2632 * the given property is the appropriate type; should only be used with
2633 * hard-coded property types.
2636 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2641 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2647 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2651 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2652 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2656 * Similar to zfs_prop_get(), but returns the value as an integer.
2659 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2660 zprop_source_t *src, char *statbuf, size_t statlen)
2665 * Check to see if this property applies to our object
2667 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type, B_FALSE)) {
2668 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2669 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2670 zfs_prop_to_name(prop)));
2674 *src = ZPROP_SRC_NONE;
2676 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2679 get_source(zhp, src, source, statbuf, statlen);
2686 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2687 char **domainp, idmap_rid_t *ridp)
2689 idmap_get_handle_t *get_hdl = NULL;
2693 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2697 err = idmap_get_sidbyuid(get_hdl, id,
2698 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2700 err = idmap_get_sidbygid(get_hdl, id,
2701 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2703 if (err == IDMAP_SUCCESS &&
2704 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2705 status == IDMAP_SUCCESS)
2711 idmap_get_destroy(get_hdl);
2714 #endif /* HAVE_IDMAP */
2717 * convert the propname into parameters needed by kernel
2718 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2719 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2720 * Eg: groupquota@staff -> ZFS_PROP_GROUPQUOTA, "", 1234
2721 * Eg: groupused@staff -> ZFS_PROP_GROUPUSED, "", 1234
2724 userquota_propname_decode(const char *propname, boolean_t zoned,
2725 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2727 zfs_userquota_prop_t type;
2736 /* Figure out the property type ({user|group}{quota|space}) */
2737 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2738 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2739 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2742 if (type == ZFS_NUM_USERQUOTA_PROPS)
2746 isuser = (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_USERUSED ||
2747 type == ZFS_PROP_USEROBJQUOTA ||
2748 type == ZFS_PROP_USEROBJUSED);
2749 isgroup = (type == ZFS_PROP_GROUPQUOTA || type == ZFS_PROP_GROUPUSED ||
2750 type == ZFS_PROP_GROUPOBJQUOTA ||
2751 type == ZFS_PROP_GROUPOBJUSED);
2753 cp = strchr(propname, '@') + 1;
2755 if (isuser && (pw = getpwnam(cp)) != NULL) {
2756 if (zoned && getzoneid() == GLOBAL_ZONEID)
2759 } else if (isgroup && (gr = getgrnam(cp)) != NULL) {
2760 if (zoned && getzoneid() == GLOBAL_ZONEID)
2763 } else if (strchr(cp, '@')) {
2766 * It's a SID name (eg "user@domain") that needs to be
2767 * turned into S-1-domainID-RID.
2769 directory_error_t e;
2770 char *numericsid = NULL;
2773 if (zoned && getzoneid() == GLOBAL_ZONEID)
2776 e = directory_sid_from_user_name(NULL,
2779 e = directory_sid_from_group_name(NULL,
2783 directory_error_free(e);
2786 if (numericsid == NULL)
2789 (void) strlcpy(domain, cp, domainlen);
2790 cp = strrchr(domain, '-');
2795 *ridp = strtoull(cp, &end, 10);
2798 if (errno != 0 || *end != '\0')
2802 #endif /* HAVE_IDMAP */
2804 /* It's a user/group ID (eg "12345"). */
2807 id = strtoul(cp, &end, 10);
2812 /* It's an ephemeral ID. */
2816 if (idmap_id_to_numeric_domain_rid(id, isuser,
2817 &mapdomain, &rid) != 0)
2819 (void) strlcpy(domain, mapdomain, domainlen);
2823 #endif /* HAVE_IDMAP */
2833 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2834 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2837 zfs_cmd_t zc = {"\0"};
2839 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2841 err = userquota_propname_decode(propname,
2842 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2843 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2844 zc.zc_objset_type = *typep;
2848 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2852 *propvalue = zc.zc_cookie;
2857 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2858 uint64_t *propvalue)
2860 zfs_userquota_prop_t type;
2862 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
2867 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
2868 char *propbuf, int proplen, boolean_t literal)
2872 zfs_userquota_prop_t type;
2874 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
2881 (void) snprintf(propbuf, proplen, "%llu",
2882 (u_longlong_t)propvalue);
2883 } else if (propvalue == 0 &&
2884 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA ||
2885 type == ZFS_PROP_USEROBJQUOTA || type == ZFS_PROP_GROUPOBJQUOTA)) {
2886 (void) strlcpy(propbuf, "none", proplen);
2888 zfs_nicenum(propvalue, propbuf, proplen);
2894 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
2895 uint64_t *propvalue)
2898 zfs_cmd_t zc = {"\0"};
2899 const char *snapname;
2901 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2903 snapname = strchr(propname, '@') + 1;
2904 if (strchr(snapname, '@')) {
2905 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
2907 /* snapname is the short name, append it to zhp's fsname */
2910 (void) strlcpy(zc.zc_value, zhp->zfs_name,
2911 sizeof (zc.zc_value));
2912 cp = strchr(zc.zc_value, '@');
2915 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
2916 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
2919 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
2923 *propvalue = zc.zc_cookie;
2928 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
2929 char *propbuf, int proplen, boolean_t literal)
2934 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
2940 (void) snprintf(propbuf, proplen, "%llu",
2941 (u_longlong_t)propvalue);
2943 zfs_nicenum(propvalue, propbuf, proplen);
2950 * Returns the name of the given zfs handle.
2953 zfs_get_name(const zfs_handle_t *zhp)
2955 return (zhp->zfs_name);
2959 * Returns the type of the given zfs handle.
2962 zfs_get_type(const zfs_handle_t *zhp)
2964 return (zhp->zfs_type);
2968 * Is one dataset name a child dataset of another?
2970 * Needs to handle these cases:
2971 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2972 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2973 * Descendant? No. No. No. Yes.
2976 is_descendant(const char *ds1, const char *ds2)
2978 size_t d1len = strlen(ds1);
2980 /* ds2 can't be a descendant if it's smaller */
2981 if (strlen(ds2) < d1len)
2984 /* otherwise, compare strings and verify that there's a '/' char */
2985 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
2989 * Given a complete name, return just the portion that refers to the parent.
2990 * Will return -1 if there is no parent (path is just the name of the
2994 parent_name(const char *path, char *buf, size_t buflen)
2998 (void) strlcpy(buf, path, buflen);
3000 if ((slashp = strrchr(buf, '/')) == NULL)
3008 * If accept_ancestor is false, then check to make sure that the given path has
3009 * a parent, and that it exists. If accept_ancestor is true, then find the
3010 * closest existing ancestor for the given path. In prefixlen return the
3011 * length of already existing prefix of the given path. We also fetch the
3012 * 'zoned' property, which is used to validate property settings when creating
3016 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
3017 boolean_t accept_ancestor, int *prefixlen)
3019 zfs_cmd_t zc = {"\0"};
3020 char parent[ZFS_MAX_DATASET_NAME_LEN];
3026 (void) snprintf(errbuf, sizeof (errbuf),
3027 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
3029 /* get parent, and check to see if this is just a pool */
3030 if (parent_name(path, parent, sizeof (parent)) != 0) {
3031 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3032 "missing dataset name"));
3033 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3036 /* check to see if the pool exists */
3037 if ((slash = strchr(parent, '/')) == NULL)
3038 slash = parent + strlen(parent);
3039 (void) strncpy(zc.zc_name, parent, slash - parent);
3040 zc.zc_name[slash - parent] = '\0';
3041 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
3043 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3044 "no such pool '%s'"), zc.zc_name);
3045 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3048 /* check to see if the parent dataset exists */
3049 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
3050 if (errno == ENOENT && accept_ancestor) {
3052 * Go deeper to find an ancestor, give up on top level.
3054 if (parent_name(parent, parent, sizeof (parent)) != 0) {
3055 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3056 "no such pool '%s'"), zc.zc_name);
3057 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3059 } else if (errno == ENOENT) {
3060 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3061 "parent does not exist"));
3062 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3064 return (zfs_standard_error(hdl, errno, errbuf));
3067 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
3071 /* we are in a non-global zone, but parent is in the global zone */
3072 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
3073 (void) zfs_standard_error(hdl, EPERM, errbuf);
3078 /* make sure parent is a filesystem */
3079 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
3080 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3081 "parent is not a filesystem"));
3082 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
3088 if (prefixlen != NULL)
3089 *prefixlen = strlen(parent);
3094 * Finds whether the dataset of the given type(s) exists.
3097 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
3101 if (!zfs_validate_name(hdl, path, types, B_FALSE))
3105 * Try to get stats for the dataset, which will tell us if it exists.
3107 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
3108 int ds_type = zhp->zfs_type;
3111 if (types & ds_type)
3118 * Given a path to 'target', create all the ancestors between
3119 * the prefixlen portion of the path, and the target itself.
3120 * Fail if the initial prefixlen-ancestor does not already exist.
3123 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
3129 /* make sure prefix exists */
3130 cp = target + prefixlen;
3132 assert(strchr(cp, '/') == NULL);
3133 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3136 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3144 * Attempt to create, mount, and share any ancestor filesystems,
3145 * up to the prefixlen-long one.
3147 for (cp = target + prefixlen + 1;
3148 (cp = strchr(cp, '/')); *cp = '/', cp++) {
3152 h = make_dataset_handle(hdl, target);
3154 /* it already exists, nothing to do here */
3159 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
3161 opname = dgettext(TEXT_DOMAIN, "create");
3165 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3167 opname = dgettext(TEXT_DOMAIN, "open");
3171 if (zfs_mount(h, NULL, 0) != 0) {
3172 opname = dgettext(TEXT_DOMAIN, "mount");
3176 if (zfs_share(h) != 0) {
3177 opname = dgettext(TEXT_DOMAIN, "share");
3187 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3188 "failed to %s ancestor '%s'"), opname, target);
3193 * Creates non-existing ancestors of the given path.
3196 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
3202 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
3205 if ((path_copy = strdup(path)) != NULL) {
3206 rc = create_parents(hdl, path_copy, prefix);
3209 if (path_copy == NULL || rc != 0)
3216 * Create a new filesystem or volume.
3219 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
3224 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
3227 dmu_objset_type_t ost;
3229 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3230 "cannot create '%s'"), path);
3232 /* validate the path, taking care to note the extended error message */
3233 if (!zfs_validate_name(hdl, path, type, B_TRUE))
3234 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3236 /* validate parents exist */
3237 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
3241 * The failure modes when creating a dataset of a different type over
3242 * one that already exists is a little strange. In particular, if you
3243 * try to create a dataset on top of an existing dataset, the ioctl()
3244 * will return ENOENT, not EEXIST. To prevent this from happening, we
3245 * first try to see if the dataset exists.
3247 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
3248 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3249 "dataset already exists"));
3250 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3253 if (type == ZFS_TYPE_VOLUME)
3258 /* open zpool handle for prop validation */
3259 char pool_path[ZFS_MAX_DATASET_NAME_LEN];
3260 (void) strlcpy(pool_path, path, sizeof (pool_path));
3262 /* truncate pool_path at first slash */
3263 char *p = strchr(pool_path, '/');
3267 zpool_handle_t *zpool_handle = zpool_open(hdl, pool_path);
3269 if (props && (props = zfs_valid_proplist(hdl, type, props,
3270 zoned, NULL, zpool_handle, errbuf)) == 0) {
3271 zpool_close(zpool_handle);
3274 zpool_close(zpool_handle);
3276 if (type == ZFS_TYPE_VOLUME) {
3278 * If we are creating a volume, the size and block size must
3279 * satisfy a few restraints. First, the blocksize must be a
3280 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3281 * volsize must be a multiple of the block size, and cannot be
3284 if (props == NULL || nvlist_lookup_uint64(props,
3285 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3287 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3288 "missing volume size"));
3289 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3292 if ((ret = nvlist_lookup_uint64(props,
3293 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3294 &blocksize)) != 0) {
3295 if (ret == ENOENT) {
3296 blocksize = zfs_prop_default_numeric(
3297 ZFS_PROP_VOLBLOCKSIZE);
3300 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3301 "missing volume block size"));
3302 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3308 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3309 "volume size cannot be zero"));
3310 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3313 if (size % blocksize != 0) {
3315 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3316 "volume size must be a multiple of volume block "
3318 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3322 /* create the dataset */
3323 ret = lzc_create(path, ost, props);
3326 /* check for failure */
3328 char parent[ZFS_MAX_DATASET_NAME_LEN];
3329 (void) parent_name(path, parent, sizeof (parent));
3333 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3334 "no such parent '%s'"), parent);
3335 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3338 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3339 "parent '%s' is not a filesystem"), parent);
3340 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3343 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3344 "pool must be upgraded to set this "
3345 "property or value"));
3346 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3350 * This platform can't address a volume this big.
3352 if (type == ZFS_TYPE_VOLUME)
3353 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3358 return (zfs_standard_error(hdl, errno, errbuf));
3366 * Destroys the given dataset. The caller must make sure that the filesystem
3367 * isn't mounted, and that there are no active dependents. If the file system
3368 * does not exist this function does nothing.
3371 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3373 zfs_cmd_t zc = {"\0"};
3375 if (zhp->zfs_type == ZFS_TYPE_BOOKMARK) {
3376 nvlist_t *nv = fnvlist_alloc();
3377 fnvlist_add_boolean(nv, zhp->zfs_name);
3378 int error = lzc_destroy_bookmarks(nv, NULL);
3381 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3382 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3388 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3390 if (ZFS_IS_VOLUME(zhp)) {
3391 zc.zc_objset_type = DMU_OST_ZVOL;
3393 zc.zc_objset_type = DMU_OST_ZFS;
3396 zc.zc_defer_destroy = defer;
3397 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0 &&
3399 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3400 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3404 remove_mountpoint(zhp);
3409 struct destroydata {
3411 const char *snapname;
3415 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3417 struct destroydata *dd = arg;
3418 char name[ZFS_MAX_DATASET_NAME_LEN];
3421 (void) snprintf(name, sizeof (name),
3422 "%s@%s", zhp->zfs_name, dd->snapname);
3424 if (lzc_exists(name))
3425 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3427 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3433 * Destroys all snapshots with the given name in zhp & descendants.
3436 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3439 struct destroydata dd = { 0 };
3441 dd.snapname = snapname;
3442 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3443 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3445 if (nvlist_empty(dd.nvl)) {
3446 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3447 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3448 zhp->zfs_name, snapname);
3450 ret = zfs_destroy_snaps_nvl(zhp->zfs_hdl, dd.nvl, defer);
3452 nvlist_free(dd.nvl);
3457 * Destroys all the snapshots named in the nvlist.
3460 zfs_destroy_snaps_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, boolean_t defer)
3463 nvlist_t *errlist = NULL;
3466 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3469 nvlist_free(errlist);
3473 if (nvlist_empty(errlist)) {
3475 (void) snprintf(errbuf, sizeof (errbuf),
3476 dgettext(TEXT_DOMAIN, "cannot destroy snapshots"));
3478 ret = zfs_standard_error(hdl, ret, errbuf);
3480 for (pair = nvlist_next_nvpair(errlist, NULL);
3481 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3483 (void) snprintf(errbuf, sizeof (errbuf),
3484 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3487 switch (fnvpair_value_int32(pair)) {
3490 dgettext(TEXT_DOMAIN, "snapshot is cloned"));
3491 ret = zfs_error(hdl, EZFS_EXISTS, errbuf);
3494 ret = zfs_standard_error(hdl, errno, errbuf);
3499 nvlist_free(errlist);
3504 * Clones the given dataset. The target must be of the same type as the source.
3507 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3509 char parent[ZFS_MAX_DATASET_NAME_LEN];
3512 libzfs_handle_t *hdl = zhp->zfs_hdl;
3515 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3517 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3518 "cannot create '%s'"), target);
3520 /* validate the target/clone name */
3521 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3522 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3524 /* validate parents exist */
3525 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3528 (void) parent_name(target, parent, sizeof (parent));
3534 if (ZFS_IS_VOLUME(zhp)) {
3535 type = ZFS_TYPE_VOLUME;
3537 type = ZFS_TYPE_FILESYSTEM;
3539 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3540 zhp, zhp->zpool_hdl, errbuf)) == NULL)
3544 ret = lzc_clone(target, zhp->zfs_name, props);
3552 * The parent doesn't exist. We should have caught this
3553 * above, but there may a race condition that has since
3554 * destroyed the parent.
3556 * At this point, we don't know whether it's the source
3557 * that doesn't exist anymore, or whether the target
3558 * dataset doesn't exist.
3560 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3561 "no such parent '%s'"), parent);
3562 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3565 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3566 "source and target pools differ"));
3567 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3571 return (zfs_standard_error(zhp->zfs_hdl, errno,
3580 * Promotes the given clone fs to be the clone parent.
3583 zfs_promote(zfs_handle_t *zhp)
3585 libzfs_handle_t *hdl = zhp->zfs_hdl;
3586 zfs_cmd_t zc = {"\0"};
3587 char parent[MAXPATHLEN];
3591 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3592 "cannot promote '%s'"), zhp->zfs_name);
3594 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3595 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3596 "snapshots can not be promoted"));
3597 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3600 (void) strlcpy(parent, zhp->zfs_dmustats.dds_origin, sizeof (parent));
3601 if (parent[0] == '\0') {
3602 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3603 "not a cloned filesystem"));
3604 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3607 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_origin,
3608 sizeof (zc.zc_value));
3609 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3610 ret = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc);
3613 int save_errno = errno;
3615 switch (save_errno) {
3617 /* There is a conflicting snapshot name. */
3618 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3619 "conflicting snapshot '%s' from parent '%s'"),
3620 zc.zc_string, parent);
3621 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3624 return (zfs_standard_error(hdl, save_errno, errbuf));
3630 typedef struct snapdata {
3632 const char *sd_snapname;
3636 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
3638 snapdata_t *sd = arg;
3639 char name[ZFS_MAX_DATASET_NAME_LEN];
3642 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) == 0) {
3643 (void) snprintf(name, sizeof (name),
3644 "%s@%s", zfs_get_name(zhp), sd->sd_snapname);
3646 fnvlist_add_boolean(sd->sd_nvl, name);
3648 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
3656 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3660 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
3666 zpool_handle_t *zpool_hdl;
3667 char pool[ZFS_MAX_DATASET_NAME_LEN];
3669 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3670 "cannot create snapshots "));
3673 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
3674 const char *snapname = nvpair_name(elem);
3676 /* validate the target name */
3677 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
3679 (void) snprintf(errbuf, sizeof (errbuf),
3680 dgettext(TEXT_DOMAIN,
3681 "cannot create snapshot '%s'"), snapname);
3682 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3687 * get pool handle for prop validation. assumes all snaps are in the
3688 * same pool, as does lzc_snapshot (below).
3690 elem = nvlist_next_nvpair(snaps, NULL);
3691 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
3692 pool[strcspn(pool, "/@")] = '\0';
3693 zpool_hdl = zpool_open(hdl, pool);
3694 if (zpool_hdl == NULL)
3697 if (props != NULL &&
3698 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3699 props, B_FALSE, NULL, zpool_hdl, errbuf)) == NULL) {
3700 zpool_close(zpool_hdl);
3703 zpool_close(zpool_hdl);
3705 ret = lzc_snapshot(snaps, props, &errors);
3708 boolean_t printed = B_FALSE;
3709 for (elem = nvlist_next_nvpair(errors, NULL);
3711 elem = nvlist_next_nvpair(errors, elem)) {
3712 (void) snprintf(errbuf, sizeof (errbuf),
3713 dgettext(TEXT_DOMAIN,
3714 "cannot create snapshot '%s'"), nvpair_name(elem));
3715 (void) zfs_standard_error(hdl,
3716 fnvpair_value_int32(elem), errbuf);
3722 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3723 "multiple snapshots of same "
3725 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3729 (void) zfs_standard_error(hdl, ret, errbuf);
3735 nvlist_free(errors);
3740 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3744 snapdata_t sd = { 0 };
3745 char fsname[ZFS_MAX_DATASET_NAME_LEN];
3750 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3751 "cannot snapshot %s"), path);
3753 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3754 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3756 (void) strlcpy(fsname, path, sizeof (fsname));
3757 cp = strchr(fsname, '@');
3759 sd.sd_snapname = cp + 1;
3761 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
3762 ZFS_TYPE_VOLUME)) == NULL) {
3766 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
3768 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
3770 fnvlist_add_boolean(sd.sd_nvl, path);
3773 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
3774 nvlist_free(sd.sd_nvl);
3780 * Destroy any more recent snapshots. We invoke this callback on any dependents
3781 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3782 * is a dependent and we should just destroy it without checking the transaction
3785 typedef struct rollback_data {
3786 const char *cb_target; /* the snapshot */
3787 uint64_t cb_create; /* creation time reference */
3793 rollback_destroy_dependent(zfs_handle_t *zhp, void *data)
3795 rollback_data_t *cbp = data;
3796 prop_changelist_t *clp;
3798 /* We must destroy this clone; first unmount it */
3799 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3800 cbp->cb_force ? MS_FORCE: 0);
3801 if (clp == NULL || changelist_prefix(clp) != 0) {
3802 cbp->cb_error = B_TRUE;
3806 if (zfs_destroy(zhp, B_FALSE) != 0)
3807 cbp->cb_error = B_TRUE;
3809 changelist_remove(clp, zhp->zfs_name);
3810 (void) changelist_postfix(clp);
3811 changelist_free(clp);
3818 rollback_destroy(zfs_handle_t *zhp, void *data)
3820 rollback_data_t *cbp = data;
3822 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > cbp->cb_create) {
3823 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3824 rollback_destroy_dependent, cbp);
3826 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3834 * Given a dataset, rollback to a specific snapshot, discarding any
3835 * data changes since then and making it the active dataset.
3837 * Any snapshots and bookmarks more recent than the target are
3838 * destroyed, along with their dependents (i.e. clones).
3841 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3843 rollback_data_t cb = { 0 };
3845 boolean_t restore_resv = 0;
3846 uint64_t old_volsize = 0, new_volsize;
3847 zfs_prop_t resv_prop = { 0 };
3849 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3850 zhp->zfs_type == ZFS_TYPE_VOLUME);
3853 * Destroy all recent snapshots and their dependents.
3855 cb.cb_force = force;
3856 cb.cb_target = snap->zfs_name;
3857 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3858 (void) zfs_iter_snapshots(zhp, B_FALSE, rollback_destroy, &cb);
3859 (void) zfs_iter_bookmarks(zhp, rollback_destroy, &cb);
3865 * Now that we have verified that the snapshot is the latest,
3866 * rollback to the given snapshot.
3869 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
3870 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
3872 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3874 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
3878 * We rely on zfs_iter_children() to verify that there are no
3879 * newer snapshots for the given dataset. Therefore, we can
3880 * simply pass the name on to the ioctl() call. There is still
3881 * an unlikely race condition where the user has taken a
3882 * snapshot since we verified that this was the most recent.
3884 err = lzc_rollback(zhp->zfs_name, NULL, 0);
3886 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3887 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
3893 * For volumes, if the pre-rollback volsize matched the pre-
3894 * rollback reservation and the volsize has changed then set
3895 * the reservation property to the post-rollback volsize.
3896 * Make a new handle since the rollback closed the dataset.
3898 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
3899 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
3901 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3902 if (old_volsize != new_volsize)
3903 err = zfs_prop_set_int(zhp, resv_prop,
3912 * Renames the given dataset.
3915 zfs_rename(zfs_handle_t *zhp, const char *target, boolean_t recursive,
3916 boolean_t force_unmount)
3919 zfs_cmd_t zc = {"\0"};
3921 prop_changelist_t *cl = NULL;
3922 zfs_handle_t *zhrp = NULL;
3923 char *parentname = NULL;
3924 char parent[ZFS_MAX_DATASET_NAME_LEN];
3925 libzfs_handle_t *hdl = zhp->zfs_hdl;
3928 /* if we have the same exact name, just return success */
3929 if (strcmp(zhp->zfs_name, target) == 0)
3932 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3933 "cannot rename to '%s'"), target);
3936 * Make sure the target name is valid
3938 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3939 if ((strchr(target, '@') == NULL) ||
3942 * Snapshot target name is abbreviated,
3943 * reconstruct full dataset name
3945 (void) strlcpy(parent, zhp->zfs_name,
3947 delim = strchr(parent, '@');
3948 if (strchr(target, '@') == NULL)
3952 (void) strlcat(parent, target, sizeof (parent));
3956 * Make sure we're renaming within the same dataset.
3958 delim = strchr(target, '@');
3959 if (strncmp(zhp->zfs_name, target, delim - target)
3960 != 0 || zhp->zfs_name[delim - target] != '@') {
3961 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3962 "snapshots must be part of same "
3964 return (zfs_error(hdl, EZFS_CROSSTARGET,
3968 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3969 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3972 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3973 "recursive rename must be a snapshot"));
3974 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3977 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3978 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3980 /* validate parents */
3981 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
3984 /* make sure we're in the same pool */
3985 verify((delim = strchr(target, '/')) != NULL);
3986 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
3987 zhp->zfs_name[delim - target] != '/') {
3988 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3989 "datasets must be within same pool"));
3990 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
3993 /* new name cannot be a child of the current dataset name */
3994 if (is_descendant(zhp->zfs_name, target)) {
3995 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3996 "New dataset name cannot be a descendant of "
3997 "current dataset name"));
3998 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4002 (void) snprintf(errbuf, sizeof (errbuf),
4003 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
4005 if (getzoneid() == GLOBAL_ZONEID &&
4006 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
4007 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4008 "dataset is used in a non-global zone"));
4009 return (zfs_error(hdl, EZFS_ZONED, errbuf));
4013 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
4014 if (parentname == NULL) {
4018 delim = strchr(parentname, '@');
4020 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
4025 } else if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT) {
4026 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0,
4027 force_unmount ? MS_FORCE : 0)) == NULL)
4030 if (changelist_haszonedchild(cl)) {
4031 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4032 "child dataset with inherited mountpoint is used "
4033 "in a non-global zone"));
4034 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
4039 if ((ret = changelist_prefix(cl)) != 0)
4043 if (ZFS_IS_VOLUME(zhp))
4044 zc.zc_objset_type = DMU_OST_ZVOL;
4046 zc.zc_objset_type = DMU_OST_ZFS;
4048 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4049 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
4051 zc.zc_cookie = recursive;
4053 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
4055 * if it was recursive, the one that actually failed will
4058 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4059 "cannot rename '%s'"), zc.zc_name);
4061 if (recursive && errno == EEXIST) {
4062 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4063 "a child dataset already has a snapshot "
4064 "with the new name"));
4065 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
4067 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
4071 * On failure, we still want to remount any filesystems that
4072 * were previously mounted, so we don't alter the system state.
4075 (void) changelist_postfix(cl);
4078 changelist_rename(cl, zfs_get_name(zhp), target);
4079 ret = changelist_postfix(cl);
4084 if (parentname != NULL) {
4091 changelist_free(cl);
4097 zfs_get_user_props(zfs_handle_t *zhp)
4099 return (zhp->zfs_user_props);
4103 * This function is used by 'zfs list' to determine the exact set of columns to
4104 * display, and their maximum widths. This does two main things:
4106 * - If this is a list of all properties, then expand the list to include
4107 * all native properties, and set a flag so that for each dataset we look
4108 * for new unique user properties and add them to the list.
4110 * - For non fixed-width properties, keep track of the maximum width seen
4111 * so that we can size the column appropriately. If the user has
4112 * requested received property values, we also need to compute the width
4113 * of the RECEIVED column.
4116 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received,
4119 libzfs_handle_t *hdl = zhp->zfs_hdl;
4120 zprop_list_t *entry;
4121 zprop_list_t **last, **start;
4122 nvlist_t *userprops, *propval;
4125 char buf[ZFS_MAXPROPLEN];
4127 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
4130 userprops = zfs_get_user_props(zhp);
4133 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
4135 * Go through and add any user properties as necessary. We
4136 * start by incrementing our list pointer to the first
4137 * non-native property.
4140 while (*start != NULL) {
4141 if ((*start)->pl_prop == ZPROP_INVAL)
4143 start = &(*start)->pl_next;
4147 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
4149 * See if we've already found this property in our list.
4151 for (last = start; *last != NULL;
4152 last = &(*last)->pl_next) {
4153 if (strcmp((*last)->pl_user_prop,
4154 nvpair_name(elem)) == 0)
4158 if (*last == NULL) {
4159 if ((entry = zfs_alloc(hdl,
4160 sizeof (zprop_list_t))) == NULL ||
4161 ((entry->pl_user_prop = zfs_strdup(hdl,
4162 nvpair_name(elem)))) == NULL) {
4167 entry->pl_prop = ZPROP_INVAL;
4168 entry->pl_width = strlen(nvpair_name(elem));
4169 entry->pl_all = B_TRUE;
4176 * Now go through and check the width of any non-fixed columns
4178 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
4179 if (entry->pl_fixed && !literal)
4182 if (entry->pl_prop != ZPROP_INVAL) {
4183 if (zfs_prop_get(zhp, entry->pl_prop,
4184 buf, sizeof (buf), NULL, NULL, 0, literal) == 0) {
4185 if (strlen(buf) > entry->pl_width)
4186 entry->pl_width = strlen(buf);
4188 if (received && zfs_prop_get_recvd(zhp,
4189 zfs_prop_to_name(entry->pl_prop),
4190 buf, sizeof (buf), literal) == 0)
4191 if (strlen(buf) > entry->pl_recvd_width)
4192 entry->pl_recvd_width = strlen(buf);
4194 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
4196 verify(nvlist_lookup_string(propval,
4197 ZPROP_VALUE, &strval) == 0);
4198 if (strlen(strval) > entry->pl_width)
4199 entry->pl_width = strlen(strval);
4201 if (received && zfs_prop_get_recvd(zhp,
4202 entry->pl_user_prop,
4203 buf, sizeof (buf), literal) == 0)
4204 if (strlen(buf) > entry->pl_recvd_width)
4205 entry->pl_recvd_width = strlen(buf);
4213 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
4219 * Keep a reference to the props-table against which we prune the
4222 zhp->zfs_props_table = props;
4224 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
4227 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
4228 next = nvlist_next_nvpair(zhp->zfs_props, curr);
4231 * User properties will result in ZPROP_INVAL, and since we
4232 * only know how to prune standard ZFS properties, we always
4233 * leave these in the list. This can also happen if we
4234 * encounter an unknown DSL property (when running older
4235 * software, for example).
4237 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
4238 (void) nvlist_remove(zhp->zfs_props,
4239 nvpair_name(curr), nvpair_type(curr));
4245 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
4246 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
4248 zfs_cmd_t zc = {"\0"};
4249 nvlist_t *nvlist = NULL;
4252 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4253 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4254 zc.zc_cookie = (uint64_t)cmd;
4256 if (cmd == ZFS_SMB_ACL_RENAME) {
4257 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
4258 (void) no_memory(hdl);
4264 case ZFS_SMB_ACL_ADD:
4265 case ZFS_SMB_ACL_REMOVE:
4266 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4268 case ZFS_SMB_ACL_RENAME:
4269 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4271 (void) no_memory(hdl);
4274 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4276 (void) no_memory(hdl);
4279 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4280 nvlist_free(nvlist);
4284 case ZFS_SMB_ACL_PURGE:
4289 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4290 nvlist_free(nvlist);
4295 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4296 char *path, char *resource)
4298 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4303 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4304 char *path, char *resource)
4306 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4311 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4313 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4318 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4319 char *oldname, char *newname)
4321 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4326 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4327 zfs_userspace_cb_t func, void *arg)
4329 zfs_cmd_t zc = {"\0"};
4330 zfs_useracct_t buf[100];
4331 libzfs_handle_t *hdl = zhp->zfs_hdl;
4334 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4336 zc.zc_objset_type = type;
4337 zc.zc_nvlist_dst = (uintptr_t)buf;
4340 zfs_useracct_t *zua = buf;
4342 zc.zc_nvlist_dst_size = sizeof (buf);
4343 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4346 if ((errno == ENOTSUP &&
4347 (type == ZFS_PROP_USEROBJUSED ||
4348 type == ZFS_PROP_GROUPOBJUSED ||
4349 type == ZFS_PROP_USEROBJQUOTA ||
4350 type == ZFS_PROP_GROUPOBJQUOTA)))
4353 (void) snprintf(errbuf, sizeof (errbuf),
4354 dgettext(TEXT_DOMAIN,
4355 "cannot get used/quota for %s"), zc.zc_name);
4356 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4358 if (zc.zc_nvlist_dst_size == 0)
4361 while (zc.zc_nvlist_dst_size > 0) {
4362 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4363 zua->zu_space)) != 0)
4366 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4375 const char *snapname;
4377 boolean_t recursive;
4382 zfs_hold_one(zfs_handle_t *zhp, void *arg)
4384 struct holdarg *ha = arg;
4385 char name[ZFS_MAX_DATASET_NAME_LEN];
4388 (void) snprintf(name, sizeof (name),
4389 "%s@%s", zhp->zfs_name, ha->snapname);
4391 if (lzc_exists(name))
4392 fnvlist_add_string(ha->nvl, name, ha->tag);
4395 rv = zfs_iter_filesystems(zhp, zfs_hold_one, ha);
4401 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4402 boolean_t recursive, int cleanup_fd)
4407 ha.nvl = fnvlist_alloc();
4408 ha.snapname = snapname;
4410 ha.recursive = recursive;
4411 (void) zfs_hold_one(zfs_handle_dup(zhp), &ha);
4413 if (nvlist_empty(ha.nvl)) {
4416 fnvlist_free(ha.nvl);
4418 (void) snprintf(errbuf, sizeof (errbuf),
4419 dgettext(TEXT_DOMAIN,
4420 "cannot hold snapshot '%s@%s'"),
4421 zhp->zfs_name, snapname);
4422 (void) zfs_standard_error(zhp->zfs_hdl, ret, errbuf);
4426 ret = zfs_hold_nvl(zhp, cleanup_fd, ha.nvl);
4427 fnvlist_free(ha.nvl);
4433 zfs_hold_nvl(zfs_handle_t *zhp, int cleanup_fd, nvlist_t *holds)
4437 libzfs_handle_t *hdl = zhp->zfs_hdl;
4442 ret = lzc_hold(holds, cleanup_fd, &errors);
4445 /* There may be errors even in the success case. */
4446 fnvlist_free(errors);
4450 if (nvlist_empty(errors)) {
4451 /* no hold-specific errors */
4452 (void) snprintf(errbuf, sizeof (errbuf),
4453 dgettext(TEXT_DOMAIN, "cannot hold"));
4456 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4457 "pool must be upgraded"));
4458 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4461 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4464 (void) zfs_standard_error(hdl, ret, errbuf);
4468 for (elem = nvlist_next_nvpair(errors, NULL);
4470 elem = nvlist_next_nvpair(errors, elem)) {
4471 (void) snprintf(errbuf, sizeof (errbuf),
4472 dgettext(TEXT_DOMAIN,
4473 "cannot hold snapshot '%s'"), nvpair_name(elem));
4474 switch (fnvpair_value_int32(elem)) {
4477 * Temporary tags wind up having the ds object id
4478 * prepended. So even if we passed the length check
4479 * above, it's still possible for the tag to wind
4480 * up being slightly too long.
4482 (void) zfs_error(hdl, EZFS_TAGTOOLONG, errbuf);
4485 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4488 (void) zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf);
4491 (void) zfs_standard_error(hdl,
4492 fnvpair_value_int32(elem), errbuf);
4496 fnvlist_free(errors);
4501 zfs_release_one(zfs_handle_t *zhp, void *arg)
4503 struct holdarg *ha = arg;
4504 char name[ZFS_MAX_DATASET_NAME_LEN];
4506 nvlist_t *existing_holds;
4508 (void) snprintf(name, sizeof (name),
4509 "%s@%s", zhp->zfs_name, ha->snapname);
4511 if (lzc_get_holds(name, &existing_holds) != 0) {
4513 } else if (!nvlist_exists(existing_holds, ha->tag)) {
4516 nvlist_t *torelease = fnvlist_alloc();
4517 fnvlist_add_boolean(torelease, ha->tag);
4518 fnvlist_add_nvlist(ha->nvl, name, torelease);
4519 fnvlist_free(torelease);
4523 rv = zfs_iter_filesystems(zhp, zfs_release_one, ha);
4529 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4530 boolean_t recursive)
4534 nvlist_t *errors = NULL;
4536 libzfs_handle_t *hdl = zhp->zfs_hdl;
4539 ha.nvl = fnvlist_alloc();
4540 ha.snapname = snapname;
4542 ha.recursive = recursive;
4544 (void) zfs_release_one(zfs_handle_dup(zhp), &ha);
4546 if (nvlist_empty(ha.nvl)) {
4547 fnvlist_free(ha.nvl);
4549 (void) snprintf(errbuf, sizeof (errbuf),
4550 dgettext(TEXT_DOMAIN,
4551 "cannot release hold from snapshot '%s@%s'"),
4552 zhp->zfs_name, snapname);
4554 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4556 (void) zfs_standard_error(hdl, ret, errbuf);
4561 ret = lzc_release(ha.nvl, &errors);
4562 fnvlist_free(ha.nvl);
4565 /* There may be errors even in the success case. */
4566 fnvlist_free(errors);
4570 if (nvlist_empty(errors)) {
4571 /* no hold-specific errors */
4572 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4576 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4577 "pool must be upgraded"));
4578 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4581 (void) zfs_standard_error_fmt(hdl, errno, errbuf);
4585 for (elem = nvlist_next_nvpair(errors, NULL);
4587 elem = nvlist_next_nvpair(errors, elem)) {
4588 (void) snprintf(errbuf, sizeof (errbuf),
4589 dgettext(TEXT_DOMAIN,
4590 "cannot release hold from snapshot '%s'"),
4592 switch (fnvpair_value_int32(elem)) {
4594 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4597 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4600 (void) zfs_standard_error_fmt(hdl,
4601 fnvpair_value_int32(elem), errbuf);
4605 fnvlist_free(errors);
4610 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4612 zfs_cmd_t zc = {"\0"};
4613 libzfs_handle_t *hdl = zhp->zfs_hdl;
4619 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4620 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4624 nvbuf = malloc(nvsz);
4625 if (nvbuf == NULL) {
4626 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4630 zc.zc_nvlist_dst_size = nvsz;
4631 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4633 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4635 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4636 (void) snprintf(errbuf, sizeof (errbuf),
4637 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4642 nvsz = zc.zc_nvlist_dst_size;
4646 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4647 "pool must be upgraded"));
4648 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4651 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4654 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4657 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4662 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4664 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4665 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4667 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4677 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4679 zfs_cmd_t zc = {"\0"};
4680 libzfs_handle_t *hdl = zhp->zfs_hdl;
4686 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4687 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4689 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
4692 nvbuf = malloc(nvsz);
4694 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
4697 zc.zc_nvlist_src_size = nvsz;
4698 zc.zc_nvlist_src = (uintptr_t)nvbuf;
4699 zc.zc_perm_action = un;
4701 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4703 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
4704 (void) snprintf(errbuf, sizeof (errbuf),
4705 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
4709 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4710 "pool must be upgraded"));
4711 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4714 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4717 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4720 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4731 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
4736 err = lzc_get_holds(zhp->zfs_name, nvl);
4739 libzfs_handle_t *hdl = zhp->zfs_hdl;
4741 (void) snprintf(errbuf, sizeof (errbuf),
4742 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4746 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4747 "pool must be upgraded"));
4748 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4751 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4754 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4757 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4766 * Convert the zvol's volume size to an appropriate reservation.
4767 * Note: If this routine is updated, it is necessary to update the ZFS test
4768 * suite's shell version in reservation.kshlib.
4771 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4774 uint64_t nblocks, volblocksize;
4778 if (nvlist_lookup_string(props,
4779 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4780 ncopies = atoi(strval);
4783 if (nvlist_lookup_uint64(props,
4784 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4785 &volblocksize) != 0)
4786 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4787 nblocks = volsize/volblocksize;
4788 /* start with metadnode L0-L6 */
4790 /* calculate number of indirects */
4791 while (nblocks > 1) {
4792 nblocks += DNODES_PER_LEVEL - 1;
4793 nblocks /= DNODES_PER_LEVEL;
4796 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4799 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4800 * compressed, but in practice they compress down to about
4803 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;