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.
37 #include <sys/mntent.h>
38 #include <sys/mount.h>
46 #include <directory.h>
48 #include <sys/dnode.h>
53 #include "zfs_namecheck.h"
55 #include "libzfs_impl.h"
56 #include "zfs_deleg.h"
58 static int userquota_propname_decode(const char *propname, boolean_t zoned,
59 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
62 * Given a single type (not a mask of types), return the type in a human
66 zfs_type_to_name(zfs_type_t type)
69 case ZFS_TYPE_FILESYSTEM:
70 return (dgettext(TEXT_DOMAIN, "filesystem"));
71 case ZFS_TYPE_SNAPSHOT:
72 return (dgettext(TEXT_DOMAIN, "snapshot"));
74 return (dgettext(TEXT_DOMAIN, "volume"));
81 * Given a path and mask of ZFS types, return a string describing this dataset.
82 * This is used when we fail to open a dataset and we cannot get an exact type.
83 * We guess what the type would have been based on the path and the mask of
87 path_to_str(const char *path, int types)
90 * When given a single type, always report the exact type.
92 if (types == ZFS_TYPE_SNAPSHOT)
93 return (dgettext(TEXT_DOMAIN, "snapshot"));
94 if (types == ZFS_TYPE_FILESYSTEM)
95 return (dgettext(TEXT_DOMAIN, "filesystem"));
96 if (types == ZFS_TYPE_VOLUME)
97 return (dgettext(TEXT_DOMAIN, "volume"));
100 * The user is requesting more than one type of dataset. If this is the
101 * case, consult the path itself. If we're looking for a snapshot, and
102 * a '@' is found, then report it as "snapshot". Otherwise, remove the
103 * snapshot attribute and try again.
105 if (types & ZFS_TYPE_SNAPSHOT) {
106 if (strchr(path, '@') != NULL)
107 return (dgettext(TEXT_DOMAIN, "snapshot"));
108 return (path_to_str(path, types & ~ZFS_TYPE_SNAPSHOT));
112 * The user has requested either filesystems or volumes.
113 * We have no way of knowing a priori what type this would be, so always
114 * report it as "filesystem" or "volume", our two primitive types.
116 if (types & ZFS_TYPE_FILESYSTEM)
117 return (dgettext(TEXT_DOMAIN, "filesystem"));
119 assert(types & ZFS_TYPE_VOLUME);
120 return (dgettext(TEXT_DOMAIN, "volume"));
124 * Validate a ZFS path. This is used even before trying to open the dataset, to
125 * provide a more meaningful error message. We call zfs_error_aux() to
126 * explain exactly why the name was not valid.
129 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
135 if (dataset_namecheck(path, &why, &what) != 0) {
138 case NAME_ERR_TOOLONG:
139 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
140 "name is too long"));
143 case NAME_ERR_LEADING_SLASH:
144 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
145 "leading slash in name"));
148 case NAME_ERR_EMPTY_COMPONENT:
149 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
150 "empty component in name"));
153 case NAME_ERR_TRAILING_SLASH:
154 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
155 "trailing slash in name"));
158 case NAME_ERR_INVALCHAR:
160 dgettext(TEXT_DOMAIN, "invalid character "
161 "'%c' in name"), what);
164 case NAME_ERR_MULTIPLE_AT:
165 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
166 "multiple '@' delimiters in name"));
169 case NAME_ERR_NOLETTER:
170 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
171 "pool doesn't begin with a letter"));
174 case NAME_ERR_RESERVED:
175 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
176 "name is reserved"));
179 case NAME_ERR_DISKLIKE:
180 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
181 "reserved disk name"));
189 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
191 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
192 "snapshot delimiter '@' in filesystem name"));
196 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
198 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
199 "missing '@' delimiter in snapshot name"));
203 if (modifying && strchr(path, '%') != NULL) {
205 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
206 "invalid character %c in name"), '%');
214 zfs_name_valid(const char *name, zfs_type_t type)
216 if (type == ZFS_TYPE_POOL)
217 return (zpool_name_valid(NULL, B_FALSE, name));
218 return (zfs_validate_name(NULL, name, type, B_FALSE));
222 * This function takes the raw DSL properties, and filters out the user-defined
223 * properties into a separate nvlist.
226 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
228 libzfs_handle_t *hdl = zhp->zfs_hdl;
233 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
234 (void) no_memory(hdl);
239 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
240 if (!zfs_prop_user(nvpair_name(elem)))
243 verify(nvpair_value_nvlist(elem, &propval) == 0);
244 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
246 (void) no_memory(hdl);
254 static zpool_handle_t *
255 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
257 libzfs_handle_t *hdl = zhp->zfs_hdl;
260 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
261 if (hdl->libzfs_pool_handles != NULL)
262 zph->zpool_next = hdl->libzfs_pool_handles;
263 hdl->libzfs_pool_handles = zph;
268 static zpool_handle_t *
269 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
271 libzfs_handle_t *hdl = zhp->zfs_hdl;
272 zpool_handle_t *zph = hdl->libzfs_pool_handles;
274 while ((zph != NULL) &&
275 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
276 zph = zph->zpool_next;
281 * Returns a handle to the pool that contains the provided dataset.
282 * If a handle to that pool already exists then that handle is returned.
283 * Otherwise, a new handle is created and added to the list of handles.
285 static zpool_handle_t *
286 zpool_handle(zfs_handle_t *zhp)
292 len = strcspn(zhp->zfs_name, "/@") + 1;
293 pool_name = zfs_alloc(zhp->zfs_hdl, len);
294 (void) strlcpy(pool_name, zhp->zfs_name, len);
296 zph = zpool_find_handle(zhp, pool_name, len);
298 zph = zpool_add_handle(zhp, pool_name);
305 zpool_free_handles(libzfs_handle_t *hdl)
307 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
309 while (zph != NULL) {
310 next = zph->zpool_next;
314 hdl->libzfs_pool_handles = NULL;
318 * Utility function to gather stats (objset and zpl) for the given object.
321 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
323 libzfs_handle_t *hdl = zhp->zfs_hdl;
325 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
327 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, zc) != 0) {
328 if (errno == ENOMEM) {
329 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
340 * Utility function to get the received properties of the given object.
343 get_recvd_props_ioctl(zfs_handle_t *zhp)
345 libzfs_handle_t *hdl = zhp->zfs_hdl;
346 nvlist_t *recvdprops;
347 zfs_cmd_t zc = { 0 };
350 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
353 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
355 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
356 if (errno == ENOMEM) {
357 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
361 zcmd_free_nvlists(&zc);
366 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
367 zcmd_free_nvlists(&zc);
371 nvlist_free(zhp->zfs_recvd_props);
372 zhp->zfs_recvd_props = recvdprops;
378 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
380 nvlist_t *allprops, *userprops;
382 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
384 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
389 * XXX Why do we store the user props separately, in addition to
390 * storing them in zfs_props?
392 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
393 nvlist_free(allprops);
397 nvlist_free(zhp->zfs_props);
398 nvlist_free(zhp->zfs_user_props);
400 zhp->zfs_props = allprops;
401 zhp->zfs_user_props = userprops;
407 get_stats(zfs_handle_t *zhp)
410 zfs_cmd_t zc = { 0 };
412 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
414 if (get_stats_ioctl(zhp, &zc) != 0)
416 else if (put_stats_zhdl(zhp, &zc) != 0)
418 zcmd_free_nvlists(&zc);
423 * Refresh the properties currently stored in the handle.
426 zfs_refresh_properties(zfs_handle_t *zhp)
428 (void) get_stats(zhp);
432 * Makes a handle from the given dataset name. Used by zfs_open() and
433 * zfs_iter_* to create child handles on the fly.
436 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
438 if (put_stats_zhdl(zhp, zc) != 0)
442 * We've managed to open the dataset and gather statistics. Determine
443 * the high-level type.
445 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
446 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
447 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
448 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
452 if (zhp->zfs_dmustats.dds_is_snapshot)
453 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
454 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
455 zhp->zfs_type = ZFS_TYPE_VOLUME;
456 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
457 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
459 abort(); /* we should never see any other types */
461 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
468 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
470 zfs_cmd_t zc = { 0 };
472 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
478 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
479 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
483 if (get_stats_ioctl(zhp, &zc) == -1) {
484 zcmd_free_nvlists(&zc);
488 if (make_dataset_handle_common(zhp, &zc) == -1) {
492 zcmd_free_nvlists(&zc);
496 static zfs_handle_t *
497 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
499 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
505 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
506 if (make_dataset_handle_common(zhp, zc) == -1) {
514 * Opens the given snapshot, filesystem, or volume. The 'types'
515 * argument is a mask of acceptable types. The function will print an
516 * appropriate error message and return NULL if it can't be opened.
519 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
524 (void) snprintf(errbuf, sizeof (errbuf),
525 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
528 * Validate the name before we even try to open it.
530 if (!zfs_validate_name(hdl, path, ZFS_TYPE_DATASET, B_FALSE)) {
531 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
532 "invalid dataset name"));
533 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
538 * Try to get stats for the dataset, which will tell us if it exists.
541 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
542 (void) zfs_standard_error(hdl, errno, errbuf);
546 if (!(types & zhp->zfs_type)) {
547 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
556 * Release a ZFS handle. Nothing to do but free the associated memory.
559 zfs_close(zfs_handle_t *zhp)
561 if (zhp->zfs_mntopts)
562 free(zhp->zfs_mntopts);
563 nvlist_free(zhp->zfs_props);
564 nvlist_free(zhp->zfs_user_props);
565 nvlist_free(zhp->zfs_recvd_props);
569 typedef struct mnttab_node {
570 struct mnttab mtn_mt;
575 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
577 const mnttab_node_t *mtn1 = arg1;
578 const mnttab_node_t *mtn2 = arg2;
581 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
585 return (rv > 0 ? 1 : -1);
589 libzfs_mnttab_init(libzfs_handle_t *hdl)
591 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
592 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
593 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
597 libzfs_mnttab_update(libzfs_handle_t *hdl)
601 rewind(hdl->libzfs_mnttab);
602 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
605 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
607 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
608 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
609 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
610 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
611 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
612 avl_add(&hdl->libzfs_mnttab_cache, mtn);
617 libzfs_mnttab_fini(libzfs_handle_t *hdl)
622 while (mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie)) {
623 free(mtn->mtn_mt.mnt_special);
624 free(mtn->mtn_mt.mnt_mountp);
625 free(mtn->mtn_mt.mnt_fstype);
626 free(mtn->mtn_mt.mnt_mntopts);
629 avl_destroy(&hdl->libzfs_mnttab_cache);
633 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
635 hdl->libzfs_mnttab_enable = enable;
639 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
640 struct mnttab *entry)
645 if (!hdl->libzfs_mnttab_enable) {
646 struct mnttab srch = { 0 };
648 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
649 libzfs_mnttab_fini(hdl);
650 rewind(hdl->libzfs_mnttab);
651 srch.mnt_special = (char *)fsname;
652 srch.mnt_fstype = MNTTYPE_ZFS;
653 if (getmntany(hdl->libzfs_mnttab, entry, &srch) == 0)
659 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
660 libzfs_mnttab_update(hdl);
662 find.mtn_mt.mnt_special = (char *)fsname;
663 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
665 *entry = mtn->mtn_mt;
672 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
673 const char *mountp, const char *mntopts)
677 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
679 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
680 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
681 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
682 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
683 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
684 avl_add(&hdl->libzfs_mnttab_cache, mtn);
688 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
693 find.mtn_mt.mnt_special = (char *)fsname;
694 if (ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL)) {
695 avl_remove(&hdl->libzfs_mnttab_cache, ret);
696 free(ret->mtn_mt.mnt_special);
697 free(ret->mtn_mt.mnt_mountp);
698 free(ret->mtn_mt.mnt_fstype);
699 free(ret->mtn_mt.mnt_mntopts);
705 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
707 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
709 if (zpool_handle == NULL)
712 *spa_version = zpool_get_prop_int(zpool_handle,
713 ZPOOL_PROP_VERSION, NULL);
718 * The choice of reservation property depends on the SPA version.
721 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
725 if (zfs_spa_version(zhp, &spa_version) < 0)
728 if (spa_version >= SPA_VERSION_REFRESERVATION)
729 *resv_prop = ZFS_PROP_REFRESERVATION;
731 *resv_prop = ZFS_PROP_RESERVATION;
737 * Given an nvlist of properties to set, validates that they are correct, and
738 * parses any numeric properties (index, boolean, etc) if they are specified as
742 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
743 uint64_t zoned, zfs_handle_t *zhp, const char *errbuf)
750 int chosen_normal = -1;
753 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
754 (void) no_memory(hdl);
759 * Make sure this property is valid and applies to this type.
763 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
764 const char *propname = nvpair_name(elem);
766 prop = zfs_name_to_prop(propname);
767 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
769 * This is a user property: make sure it's a
770 * string, and that it's less than ZAP_MAXNAMELEN.
772 if (nvpair_type(elem) != DATA_TYPE_STRING) {
773 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
774 "'%s' must be a string"), propname);
775 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
779 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
780 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
781 "property name '%s' is too long"),
783 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
787 (void) nvpair_value_string(elem, &strval);
788 if (nvlist_add_string(ret, propname, strval) != 0) {
789 (void) no_memory(hdl);
796 * Currently, only user properties can be modified on
799 if (type == ZFS_TYPE_SNAPSHOT) {
800 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
801 "this property can not be modified for snapshots"));
802 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
806 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
807 zfs_userquota_prop_t uqtype;
808 char newpropname[128];
813 if (userquota_propname_decode(propname, zoned,
814 &uqtype, domain, sizeof (domain), &rid) != 0) {
816 dgettext(TEXT_DOMAIN,
817 "'%s' has an invalid user/group name"),
819 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
823 if (uqtype != ZFS_PROP_USERQUOTA &&
824 uqtype != ZFS_PROP_GROUPQUOTA) {
826 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
828 (void) zfs_error(hdl, EZFS_PROPREADONLY,
833 if (nvpair_type(elem) == DATA_TYPE_STRING) {
834 (void) nvpair_value_string(elem, &strval);
835 if (strcmp(strval, "none") == 0) {
837 } else if (zfs_nicestrtonum(hdl,
838 strval, &intval) != 0) {
839 (void) zfs_error(hdl,
840 EZFS_BADPROP, errbuf);
843 } else if (nvpair_type(elem) ==
845 (void) nvpair_value_uint64(elem, &intval);
847 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
848 "use 'none' to disable "
849 "userquota/groupquota"));
853 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
854 "'%s' must be a number"), propname);
855 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
860 * Encode the prop name as
861 * userquota@<hex-rid>-domain, to make it easy
862 * for the kernel to decode.
864 (void) snprintf(newpropname, sizeof (newpropname),
865 "%s%llx-%s", zfs_userquota_prop_prefixes[uqtype],
866 (longlong_t)rid, domain);
870 if (nvlist_add_uint64_array(ret, newpropname,
872 (void) no_memory(hdl);
878 if (prop == ZPROP_INVAL) {
879 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
880 "invalid property '%s'"), propname);
881 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
885 if (!zfs_prop_valid_for_type(prop, type)) {
887 dgettext(TEXT_DOMAIN, "'%s' does not "
888 "apply to datasets of this type"), propname);
889 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
893 if (zfs_prop_readonly(prop) &&
894 (!zfs_prop_setonce(prop) || zhp != NULL)) {
896 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
898 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
902 if (zprop_parse_value(hdl, elem, prop, type, ret,
903 &strval, &intval, errbuf) != 0)
907 * Perform some additional checks for specific properties.
910 case ZFS_PROP_VERSION:
916 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
917 if (intval < version) {
918 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
919 "Can not downgrade; already at version %u"),
921 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
927 case ZFS_PROP_RECORDSIZE:
928 case ZFS_PROP_VOLBLOCKSIZE:
929 /* must be power of two within SPA_{MIN,MAX}BLOCKSIZE */
930 if (intval < SPA_MINBLOCKSIZE ||
931 intval > SPA_MAXBLOCKSIZE || !ISP2(intval)) {
932 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
933 "'%s' must be power of 2 from %u "
935 (uint_t)SPA_MINBLOCKSIZE,
936 (uint_t)SPA_MAXBLOCKSIZE >> 10);
937 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
942 case ZFS_PROP_MLSLABEL:
945 * Verify the mlslabel string and convert to
946 * internal hex label string.
950 char *hex = NULL; /* internal label string */
952 /* Default value is already OK. */
953 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
956 /* Verify the label can be converted to binary form */
957 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
958 (str_to_label(strval, &new_sl, MAC_LABEL,
959 L_NO_CORRECTION, NULL) == -1)) {
963 /* Now translate to hex internal label string */
964 if (label_to_str(new_sl, &hex, M_INTERNAL,
970 m_label_free(new_sl);
972 /* If string is already in internal form, we're done. */
973 if (strcmp(strval, hex) == 0) {
978 /* Replace the label string with the internal form. */
979 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
981 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
988 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
989 "invalid mlslabel '%s'"), strval);
990 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
991 m_label_free(new_sl); /* OK if null */
996 case ZFS_PROP_MOUNTPOINT:
1000 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1001 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1004 if (mountpoint_namecheck(strval, &why)) {
1006 case NAME_ERR_LEADING_SLASH:
1008 dgettext(TEXT_DOMAIN,
1009 "'%s' must be an absolute path, "
1010 "'none', or 'legacy'"), propname);
1012 case NAME_ERR_TOOLONG:
1014 dgettext(TEXT_DOMAIN,
1015 "component of '%s' is too long"),
1019 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1026 case ZFS_PROP_SHARESMB:
1027 case ZFS_PROP_SHARENFS:
1029 * For the mountpoint and sharenfs or sharesmb
1030 * properties, check if it can be set in a
1031 * global/non-global zone based on
1032 * the zoned property value:
1034 * global zone non-global zone
1035 * --------------------------------------------------
1036 * zoned=on mountpoint (no) mountpoint (yes)
1037 * sharenfs (no) sharenfs (no)
1038 * sharesmb (no) sharesmb (no)
1040 * zoned=off mountpoint (yes) N/A
1045 if (getzoneid() == GLOBAL_ZONEID) {
1046 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1047 "'%s' cannot be set on "
1048 "dataset in a non-global zone"),
1050 (void) zfs_error(hdl, EZFS_ZONED,
1053 } else if (prop == ZFS_PROP_SHARENFS ||
1054 prop == ZFS_PROP_SHARESMB) {
1055 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1056 "'%s' cannot be set in "
1057 "a non-global zone"), propname);
1058 (void) zfs_error(hdl, EZFS_ZONED,
1062 } else if (getzoneid() != GLOBAL_ZONEID) {
1064 * If zoned property is 'off', this must be in
1065 * a global zone. If not, something is wrong.
1067 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1068 "'%s' cannot be set while dataset "
1069 "'zoned' property is set"), propname);
1070 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1075 * At this point, it is legitimate to set the
1076 * property. Now we want to make sure that the
1077 * property value is valid if it is sharenfs.
1079 if ((prop == ZFS_PROP_SHARENFS ||
1080 prop == ZFS_PROP_SHARESMB) &&
1081 strcmp(strval, "on") != 0 &&
1082 strcmp(strval, "off") != 0) {
1083 zfs_share_proto_t proto;
1085 if (prop == ZFS_PROP_SHARESMB)
1091 * Must be an valid sharing protocol
1092 * option string so init the libshare
1093 * in order to enable the parser and
1094 * then parse the options. We use the
1095 * control API since we don't care about
1096 * the current configuration and don't
1097 * want the overhead of loading it
1098 * until we actually do something.
1101 if (zfs_init_libshare(hdl,
1102 SA_INIT_CONTROL_API) != SA_OK) {
1104 * An error occurred so we can't do
1107 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1108 "'%s' cannot be set: problem "
1109 "in share initialization"),
1111 (void) zfs_error(hdl, EZFS_BADPROP,
1116 if (zfs_parse_options(strval, proto) != SA_OK) {
1118 * There was an error in parsing so
1119 * deal with it by issuing an error
1120 * message and leaving after
1121 * uninitializing the the libshare
1124 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1125 "'%s' cannot be set to invalid "
1126 "options"), propname);
1127 (void) zfs_error(hdl, EZFS_BADPROP,
1129 zfs_uninit_libshare(hdl);
1132 zfs_uninit_libshare(hdl);
1136 case ZFS_PROP_UTF8ONLY:
1137 chosen_utf = (int)intval;
1139 case ZFS_PROP_NORMALIZE:
1140 chosen_normal = (int)intval;
1145 * For changes to existing volumes, we have some additional
1146 * checks to enforce.
1148 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1149 uint64_t volsize = zfs_prop_get_int(zhp,
1151 uint64_t blocksize = zfs_prop_get_int(zhp,
1152 ZFS_PROP_VOLBLOCKSIZE);
1156 case ZFS_PROP_RESERVATION:
1157 case ZFS_PROP_REFRESERVATION:
1158 if (intval > volsize) {
1159 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1160 "'%s' is greater than current "
1161 "volume size"), propname);
1162 (void) zfs_error(hdl, EZFS_BADPROP,
1168 case ZFS_PROP_VOLSIZE:
1169 if (intval % blocksize != 0) {
1170 zfs_nicenum(blocksize, buf,
1172 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1173 "'%s' must be a multiple of "
1174 "volume block size (%s)"),
1176 (void) zfs_error(hdl, EZFS_BADPROP,
1182 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1183 "'%s' cannot be zero"),
1185 (void) zfs_error(hdl, EZFS_BADPROP,
1195 * If normalization was chosen, but no UTF8 choice was made,
1196 * enforce rejection of non-UTF8 names.
1198 * If normalization was chosen, but rejecting non-UTF8 names
1199 * was explicitly not chosen, it is an error.
1201 if (chosen_normal > 0 && chosen_utf < 0) {
1202 if (nvlist_add_uint64(ret,
1203 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1204 (void) no_memory(hdl);
1207 } else if (chosen_normal > 0 && chosen_utf == 0) {
1208 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1209 "'%s' must be set 'on' if normalization chosen"),
1210 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1211 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1222 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1224 uint64_t old_volsize;
1225 uint64_t new_volsize;
1226 uint64_t old_reservation;
1227 uint64_t new_reservation;
1228 zfs_prop_t resv_prop;
1231 * If this is an existing volume, and someone is setting the volsize,
1232 * make sure that it matches the reservation, or add it if necessary.
1234 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1235 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1237 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1238 if ((zvol_volsize_to_reservation(old_volsize, zhp->zfs_props) !=
1239 old_reservation) || nvlist_lookup_uint64(nvl,
1240 zfs_prop_to_name(resv_prop), &new_reservation) != ENOENT) {
1243 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1246 new_reservation = zvol_volsize_to_reservation(new_volsize,
1248 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1249 new_reservation) != 0) {
1250 (void) no_memory(zhp->zfs_hdl);
1257 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1264 * For quotas and reservations, ENOSPC indicates
1265 * something different; setting a quota or reservation
1266 * doesn't use any disk space.
1269 case ZFS_PROP_QUOTA:
1270 case ZFS_PROP_REFQUOTA:
1271 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1272 "size is less than current used or "
1274 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1277 case ZFS_PROP_RESERVATION:
1278 case ZFS_PROP_REFRESERVATION:
1279 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1280 "size is greater than available space"));
1281 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1285 (void) zfs_standard_error(hdl, err, errbuf);
1291 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1295 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1299 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1300 "pool and or dataset must be upgraded to set this "
1301 "property or value"));
1302 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1306 if (prop == ZFS_PROP_COMPRESSION) {
1307 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1308 "property setting is not allowed on "
1309 "bootable datasets"));
1310 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1312 (void) zfs_standard_error(hdl, err, errbuf);
1317 if (prop == ZPROP_INVAL) {
1318 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1320 (void) zfs_standard_error(hdl, err, errbuf);
1326 * This platform can't address a volume this big.
1329 if (prop == ZFS_PROP_VOLSIZE) {
1330 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1336 (void) zfs_standard_error(hdl, err, errbuf);
1341 * Given a property name and value, set the property for the given dataset.
1344 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1346 zfs_cmd_t zc = { 0 };
1348 prop_changelist_t *cl = NULL;
1350 libzfs_handle_t *hdl = zhp->zfs_hdl;
1351 nvlist_t *nvl = NULL, *realprops;
1353 boolean_t do_prefix;
1357 (void) snprintf(errbuf, sizeof (errbuf),
1358 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1361 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1362 nvlist_add_string(nvl, propname, propval) != 0) {
1363 (void) no_memory(hdl);
1367 if ((realprops = zfs_valid_proplist(hdl, zhp->zfs_type, nvl,
1368 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, errbuf)) == NULL)
1374 prop = zfs_name_to_prop(propname);
1376 if (prop == ZFS_PROP_VOLSIZE) {
1377 if ((added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1)
1381 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1384 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1385 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1386 "child dataset with inherited mountpoint is used "
1387 "in a non-global zone"));
1388 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1393 * If the dataset's canmount property is being set to noauto,
1394 * then we want to prevent unmounting & remounting it.
1396 do_prefix = !((prop == ZFS_PROP_CANMOUNT) &&
1397 (zprop_string_to_index(prop, propval, &idx,
1398 ZFS_TYPE_DATASET) == 0) && (idx == ZFS_CANMOUNT_NOAUTO));
1400 if (do_prefix && (ret = changelist_prefix(cl)) != 0)
1404 * Execute the corresponding ioctl() to set this property.
1406 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1408 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1411 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1414 zfs_setprop_error(hdl, prop, errno, errbuf);
1415 if (added_resv && errno == ENOSPC) {
1416 /* clean up the volsize property we tried to set */
1417 uint64_t old_volsize = zfs_prop_get_int(zhp,
1420 zcmd_free_nvlists(&zc);
1421 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1423 if (nvlist_add_uint64(nvl,
1424 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1427 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1429 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1433 ret = changelist_postfix(cl);
1436 * Refresh the statistics so the new property value
1440 (void) get_stats(zhp);
1445 zcmd_free_nvlists(&zc);
1447 changelist_free(cl);
1452 * Given a property, inherit the value from the parent dataset, or if received
1453 * is TRUE, revert to the received value, if any.
1456 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1458 zfs_cmd_t zc = { 0 };
1460 prop_changelist_t *cl;
1461 libzfs_handle_t *hdl = zhp->zfs_hdl;
1465 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1466 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1468 zc.zc_cookie = received;
1469 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1471 * For user properties, the amount of work we have to do is very
1472 * small, so just do it here.
1474 if (!zfs_prop_user(propname)) {
1475 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1476 "invalid property"));
1477 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1480 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1481 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1483 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1484 return (zfs_standard_error(hdl, errno, errbuf));
1490 * Verify that this property is inheritable.
1492 if (zfs_prop_readonly(prop))
1493 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1495 if (!zfs_prop_inheritable(prop) && !received)
1496 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1499 * Check to see if the value applies to this type
1501 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1502 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1505 * Normalize the name, to get rid of shorthand abbreviations.
1507 propname = zfs_prop_to_name(prop);
1508 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1509 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1511 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1512 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1513 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1514 "dataset is used in a non-global zone"));
1515 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1519 * Determine datasets which will be affected by this change, if any.
1521 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1524 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1525 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1526 "child dataset with inherited mountpoint is used "
1527 "in a non-global zone"));
1528 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1532 if ((ret = changelist_prefix(cl)) != 0)
1535 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1536 return (zfs_standard_error(hdl, errno, errbuf));
1539 if ((ret = changelist_postfix(cl)) != 0)
1543 * Refresh the statistics so the new property is reflected.
1545 (void) get_stats(zhp);
1549 changelist_free(cl);
1554 * True DSL properties are stored in an nvlist. The following two functions
1555 * extract them appropriately.
1558 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1564 if (nvlist_lookup_nvlist(zhp->zfs_props,
1565 zfs_prop_to_name(prop), &nv) == 0) {
1566 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1567 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1569 verify(!zhp->zfs_props_table ||
1570 zhp->zfs_props_table[prop] == B_TRUE);
1571 value = zfs_prop_default_numeric(prop);
1579 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1585 if (nvlist_lookup_nvlist(zhp->zfs_props,
1586 zfs_prop_to_name(prop), &nv) == 0) {
1587 verify(nvlist_lookup_string(nv, ZPROP_VALUE, &value) == 0);
1588 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1590 verify(!zhp->zfs_props_table ||
1591 zhp->zfs_props_table[prop] == B_TRUE);
1592 if ((value = (char *)zfs_prop_default_string(prop)) == NULL)
1601 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
1603 return (zhp->zfs_props == zhp->zfs_recvd_props);
1607 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1609 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
1610 zhp->zfs_props = zhp->zfs_recvd_props;
1614 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1616 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
1621 * Internal function for getting a numeric property. Both zfs_prop_get() and
1622 * zfs_prop_get_int() are built using this interface.
1624 * Certain properties can be overridden using 'mount -o'. In this case, scan
1625 * the contents of the /etc/mnttab entry, searching for the appropriate options.
1626 * If they differ from the on-disk values, report the current values and mark
1627 * the source "temporary".
1630 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
1631 char **source, uint64_t *val)
1633 zfs_cmd_t zc = { 0 };
1634 nvlist_t *zplprops = NULL;
1636 char *mntopt_on = NULL;
1637 char *mntopt_off = NULL;
1638 boolean_t received = zfs_is_recvd_props_mode(zhp);
1643 case ZFS_PROP_ATIME:
1644 mntopt_on = MNTOPT_ATIME;
1645 mntopt_off = MNTOPT_NOATIME;
1648 case ZFS_PROP_DEVICES:
1649 mntopt_on = MNTOPT_DEVICES;
1650 mntopt_off = MNTOPT_NODEVICES;
1654 mntopt_on = MNTOPT_EXEC;
1655 mntopt_off = MNTOPT_NOEXEC;
1658 case ZFS_PROP_READONLY:
1659 mntopt_on = MNTOPT_RO;
1660 mntopt_off = MNTOPT_RW;
1663 case ZFS_PROP_SETUID:
1664 mntopt_on = MNTOPT_SETUID;
1665 mntopt_off = MNTOPT_NOSETUID;
1668 case ZFS_PROP_XATTR:
1669 mntopt_on = MNTOPT_XATTR;
1670 mntopt_off = MNTOPT_NOXATTR;
1673 case ZFS_PROP_NBMAND:
1674 mntopt_on = MNTOPT_NBMAND;
1675 mntopt_off = MNTOPT_NONBMAND;
1680 * Because looking up the mount options is potentially expensive
1681 * (iterating over all of /etc/mnttab), we defer its calculation until
1682 * we're looking up a property which requires its presence.
1684 if (!zhp->zfs_mntcheck &&
1685 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
1686 libzfs_handle_t *hdl = zhp->zfs_hdl;
1687 struct mnttab entry;
1689 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
1690 zhp->zfs_mntopts = zfs_strdup(hdl,
1692 if (zhp->zfs_mntopts == NULL)
1696 zhp->zfs_mntcheck = B_TRUE;
1699 if (zhp->zfs_mntopts == NULL)
1700 mnt.mnt_mntopts = "";
1702 mnt.mnt_mntopts = zhp->zfs_mntopts;
1705 case ZFS_PROP_ATIME:
1706 case ZFS_PROP_DEVICES:
1708 case ZFS_PROP_READONLY:
1709 case ZFS_PROP_SETUID:
1710 case ZFS_PROP_XATTR:
1711 case ZFS_PROP_NBMAND:
1712 *val = getprop_uint64(zhp, prop, source);
1717 if (hasmntopt(&mnt, mntopt_on) && !*val) {
1720 *src = ZPROP_SRC_TEMPORARY;
1721 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
1724 *src = ZPROP_SRC_TEMPORARY;
1728 case ZFS_PROP_CANMOUNT:
1729 case ZFS_PROP_VOLSIZE:
1730 case ZFS_PROP_QUOTA:
1731 case ZFS_PROP_REFQUOTA:
1732 case ZFS_PROP_RESERVATION:
1733 case ZFS_PROP_REFRESERVATION:
1734 *val = getprop_uint64(zhp, prop, source);
1736 if (*source == NULL) {
1737 /* not default, must be local */
1738 *source = zhp->zfs_name;
1742 case ZFS_PROP_MOUNTED:
1743 *val = (zhp->zfs_mntopts != NULL);
1746 case ZFS_PROP_NUMCLONES:
1747 *val = zhp->zfs_dmustats.dds_num_clones;
1750 case ZFS_PROP_VERSION:
1751 case ZFS_PROP_NORMALIZE:
1752 case ZFS_PROP_UTF8ONLY:
1754 if (!zfs_prop_valid_for_type(prop, zhp->zfs_head_type) ||
1755 zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
1757 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1758 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
1759 zcmd_free_nvlists(&zc);
1762 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
1763 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
1765 zcmd_free_nvlists(&zc);
1769 nvlist_free(zplprops);
1770 zcmd_free_nvlists(&zc);
1774 switch (zfs_prop_get_type(prop)) {
1775 case PROP_TYPE_NUMBER:
1776 case PROP_TYPE_INDEX:
1777 *val = getprop_uint64(zhp, prop, source);
1779 * If we tried to use a default value for a
1780 * readonly property, it means that it was not
1783 if (zfs_prop_readonly(prop) &&
1784 *source != NULL && (*source)[0] == '\0') {
1789 case PROP_TYPE_STRING:
1791 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
1792 "cannot get non-numeric property"));
1793 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
1794 dgettext(TEXT_DOMAIN, "internal error")));
1802 * Calculate the source type, given the raw source string.
1805 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
1806 char *statbuf, size_t statlen)
1808 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
1811 if (source == NULL) {
1812 *srctype = ZPROP_SRC_NONE;
1813 } else if (source[0] == '\0') {
1814 *srctype = ZPROP_SRC_DEFAULT;
1815 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
1816 *srctype = ZPROP_SRC_RECEIVED;
1818 if (strcmp(source, zhp->zfs_name) == 0) {
1819 *srctype = ZPROP_SRC_LOCAL;
1821 (void) strlcpy(statbuf, source, statlen);
1822 *srctype = ZPROP_SRC_INHERITED;
1829 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
1830 size_t proplen, boolean_t literal)
1835 if (zhp->zfs_recvd_props == NULL)
1836 if (get_recvd_props_ioctl(zhp) != 0)
1839 prop = zfs_name_to_prop(propname);
1841 if (prop != ZPROP_INVAL) {
1843 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
1845 zfs_set_recvd_props_mode(zhp, &cookie);
1846 err = zfs_prop_get(zhp, prop, propbuf, proplen,
1847 NULL, NULL, 0, literal);
1848 zfs_unset_recvd_props_mode(zhp, &cookie);
1849 } else if (zfs_prop_userquota(propname)) {
1854 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
1855 propname, &propval) != 0)
1857 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
1859 (void) strlcpy(propbuf, recvdval, proplen);
1862 return (err == 0 ? 0 : -1);
1866 * Retrieve a property from the given object. If 'literal' is specified, then
1867 * numbers are left as exact values. Otherwise, numbers are converted to a
1868 * human-readable form.
1870 * Returns 0 on success, or -1 on error.
1873 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
1874 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
1876 char *source = NULL;
1880 boolean_t received = zfs_is_recvd_props_mode(zhp);
1883 * Check to see if this property applies to our object
1885 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1888 if (received && zfs_prop_readonly(prop))
1892 *src = ZPROP_SRC_NONE;
1895 case ZFS_PROP_CREATION:
1897 * 'creation' is a time_t stored in the statistics. We convert
1898 * this into a string unless 'literal' is specified.
1901 val = getprop_uint64(zhp, prop, &source);
1902 time_t time = (time_t)val;
1906 localtime_r(&time, &t) == NULL ||
1907 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
1909 (void) snprintf(propbuf, proplen, "%llu", val);
1913 case ZFS_PROP_MOUNTPOINT:
1915 * Getting the precise mountpoint can be tricky.
1917 * - for 'none' or 'legacy', return those values.
1918 * - for inherited mountpoints, we want to take everything
1919 * after our ancestor and append it to the inherited value.
1921 * If the pool has an alternate root, we want to prepend that
1922 * root to any values we return.
1925 str = getprop_string(zhp, prop, &source);
1927 if (str[0] == '/') {
1928 char buf[MAXPATHLEN];
1930 const char *relpath;
1933 * If we inherit the mountpoint, even from a dataset
1934 * with a received value, the source will be the path of
1935 * the dataset we inherit from. If source is
1936 * ZPROP_SOURCE_VAL_RECVD, the received value is not
1939 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
1942 relpath = zhp->zfs_name + strlen(source);
1943 if (relpath[0] == '/')
1947 if ((zpool_get_prop(zhp->zpool_hdl,
1948 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL)) ||
1949 (strcmp(root, "-") == 0))
1952 * Special case an alternate root of '/'. This will
1953 * avoid having multiple leading slashes in the
1956 if (strcmp(root, "/") == 0)
1960 * If the mountpoint is '/' then skip over this
1961 * if we are obtaining either an alternate root or
1962 * an inherited mountpoint.
1964 if (str[1] == '\0' && (root[0] != '\0' ||
1965 relpath[0] != '\0'))
1968 if (relpath[0] == '\0')
1969 (void) snprintf(propbuf, proplen, "%s%s",
1972 (void) snprintf(propbuf, proplen, "%s%s%s%s",
1973 root, str, relpath[0] == '@' ? "" : "/",
1976 /* 'legacy' or 'none' */
1977 (void) strlcpy(propbuf, str, proplen);
1982 case ZFS_PROP_ORIGIN:
1983 (void) strlcpy(propbuf, getprop_string(zhp, prop, &source),
1986 * If there is no parent at all, return failure to indicate that
1987 * it doesn't apply to this dataset.
1989 if (propbuf[0] == '\0')
1993 case ZFS_PROP_QUOTA:
1994 case ZFS_PROP_REFQUOTA:
1995 case ZFS_PROP_RESERVATION:
1996 case ZFS_PROP_REFRESERVATION:
1998 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2002 * If quota or reservation is 0, we translate this into 'none'
2003 * (unless literal is set), and indicate that it's the default
2004 * value. Otherwise, we print the number nicely and indicate
2005 * that its set locally.
2009 (void) strlcpy(propbuf, "0", proplen);
2011 (void) strlcpy(propbuf, "none", proplen);
2014 (void) snprintf(propbuf, proplen, "%llu",
2017 zfs_nicenum(val, propbuf, proplen);
2021 case ZFS_PROP_COMPRESSRATIO:
2022 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2024 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2025 (u_longlong_t)(val / 100),
2026 (u_longlong_t)(val % 100));
2030 switch (zhp->zfs_type) {
2031 case ZFS_TYPE_FILESYSTEM:
2034 case ZFS_TYPE_VOLUME:
2037 case ZFS_TYPE_SNAPSHOT:
2043 (void) snprintf(propbuf, proplen, "%s", str);
2046 case ZFS_PROP_MOUNTED:
2048 * The 'mounted' property is a pseudo-property that described
2049 * whether the filesystem is currently mounted. Even though
2050 * it's a boolean value, the typical values of "on" and "off"
2051 * don't make sense, so we translate to "yes" and "no".
2053 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2054 src, &source, &val) != 0)
2057 (void) strlcpy(propbuf, "yes", proplen);
2059 (void) strlcpy(propbuf, "no", proplen);
2064 * The 'name' property is a pseudo-property derived from the
2065 * dataset name. It is presented as a real property to simplify
2068 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2071 case ZFS_PROP_MLSLABEL:
2073 m_label_t *new_sl = NULL;
2074 char *ascii = NULL; /* human readable label */
2076 (void) strlcpy(propbuf,
2077 getprop_string(zhp, prop, &source), proplen);
2079 if (literal || (strcasecmp(propbuf,
2080 ZFS_MLSLABEL_DEFAULT) == 0))
2084 * Try to translate the internal hex string to
2085 * human-readable output. If there are any
2086 * problems just use the hex string.
2089 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2090 L_NO_CORRECTION, NULL) == -1) {
2091 m_label_free(new_sl);
2095 if (label_to_str(new_sl, &ascii, M_LABEL,
2099 m_label_free(new_sl);
2102 m_label_free(new_sl);
2104 (void) strlcpy(propbuf, ascii, proplen);
2110 switch (zfs_prop_get_type(prop)) {
2111 case PROP_TYPE_NUMBER:
2112 if (get_numeric_property(zhp, prop, src,
2113 &source, &val) != 0)
2116 (void) snprintf(propbuf, proplen, "%llu",
2119 zfs_nicenum(val, propbuf, proplen);
2122 case PROP_TYPE_STRING:
2123 (void) strlcpy(propbuf,
2124 getprop_string(zhp, prop, &source), proplen);
2127 case PROP_TYPE_INDEX:
2128 if (get_numeric_property(zhp, prop, src,
2129 &source, &val) != 0)
2131 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2133 (void) strlcpy(propbuf, strval, proplen);
2141 get_source(zhp, src, source, statbuf, statlen);
2147 * Utility function to get the given numeric property. Does no validation that
2148 * the given property is the appropriate type; should only be used with
2149 * hard-coded property types.
2152 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2157 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2163 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2167 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2168 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2172 * Similar to zfs_prop_get(), but returns the value as an integer.
2175 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2176 zprop_source_t *src, char *statbuf, size_t statlen)
2181 * Check to see if this property applies to our object
2183 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) {
2184 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2185 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2186 zfs_prop_to_name(prop)));
2190 *src = ZPROP_SRC_NONE;
2192 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2195 get_source(zhp, src, source, statbuf, statlen);
2201 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2202 char **domainp, idmap_rid_t *ridp)
2204 idmap_get_handle_t *get_hdl = NULL;
2208 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2212 err = idmap_get_sidbyuid(get_hdl, id,
2213 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2215 err = idmap_get_sidbygid(get_hdl, id,
2216 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2218 if (err == IDMAP_SUCCESS &&
2219 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2220 status == IDMAP_SUCCESS)
2226 idmap_get_destroy(get_hdl);
2231 * convert the propname into parameters needed by kernel
2232 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2233 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2236 userquota_propname_decode(const char *propname, boolean_t zoned,
2237 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2239 zfs_userquota_prop_t type;
2241 char *numericsid = NULL;
2246 /* Figure out the property type ({user|group}{quota|space}) */
2247 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2248 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2249 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2252 if (type == ZFS_NUM_USERQUOTA_PROPS)
2256 isuser = (type == ZFS_PROP_USERQUOTA ||
2257 type == ZFS_PROP_USERUSED);
2259 cp = strchr(propname, '@') + 1;
2261 if (strchr(cp, '@')) {
2263 * It's a SID name (eg "user@domain") that needs to be
2264 * turned into S-1-domainID-RID.
2266 directory_error_t e;
2267 if (zoned && getzoneid() == GLOBAL_ZONEID)
2270 e = directory_sid_from_user_name(NULL,
2273 e = directory_sid_from_group_name(NULL,
2277 directory_error_free(e);
2280 if (numericsid == NULL)
2283 /* will be further decoded below */
2286 if (strncmp(cp, "S-1-", 4) == 0) {
2287 /* It's a numeric SID (eg "S-1-234-567-89") */
2288 (void) strlcpy(domain, cp, domainlen);
2289 cp = strrchr(domain, '-');
2294 *ridp = strtoull(cp, &end, 10);
2299 if (errno != 0 || *end != '\0')
2301 } else if (!isdigit(*cp)) {
2303 * It's a user/group name (eg "user") that needs to be
2304 * turned into a uid/gid
2306 if (zoned && getzoneid() == GLOBAL_ZONEID)
2322 /* It's a user/group ID (eg "12345"). */
2323 uid_t id = strtoul(cp, &end, 10);
2330 /* It's an ephemeral ID. */
2331 if (idmap_id_to_numeric_domain_rid(id, isuser,
2332 &mapdomain, &rid) != 0)
2334 (void) strlcpy(domain, mapdomain, domainlen);
2341 ASSERT3P(numericsid, ==, NULL);
2346 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2347 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2350 zfs_cmd_t zc = { 0 };
2352 (void) strncpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2354 err = userquota_propname_decode(propname,
2355 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2356 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2357 zc.zc_objset_type = *typep;
2361 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2365 *propvalue = zc.zc_cookie;
2370 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2371 uint64_t *propvalue)
2373 zfs_userquota_prop_t type;
2375 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
2380 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
2381 char *propbuf, int proplen, boolean_t literal)
2385 zfs_userquota_prop_t type;
2387 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
2394 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2395 } else if (propvalue == 0 &&
2396 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
2397 (void) strlcpy(propbuf, "none", proplen);
2399 zfs_nicenum(propvalue, propbuf, proplen);
2405 * Returns the name of the given zfs handle.
2408 zfs_get_name(const zfs_handle_t *zhp)
2410 return (zhp->zfs_name);
2414 * Returns the type of the given zfs handle.
2417 zfs_get_type(const zfs_handle_t *zhp)
2419 return (zhp->zfs_type);
2423 zfs_do_list_ioctl(zfs_handle_t *zhp, int arg, zfs_cmd_t *zc)
2426 uint64_t orig_cookie;
2428 orig_cookie = zc->zc_cookie;
2430 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
2431 rc = ioctl(zhp->zfs_hdl->libzfs_fd, arg, zc);
2436 /* expand nvlist memory and try again */
2437 if (zcmd_expand_dst_nvlist(zhp->zfs_hdl, zc) != 0) {
2438 zcmd_free_nvlists(zc);
2441 zc->zc_cookie = orig_cookie;
2444 * An errno value of ESRCH indicates normal completion.
2445 * If ENOENT is returned, then the underlying dataset
2446 * has been removed since we obtained the handle.
2453 rc = zfs_standard_error(zhp->zfs_hdl, errno,
2454 dgettext(TEXT_DOMAIN,
2455 "cannot iterate filesystems"));
2463 * Iterate over all child filesystems
2466 zfs_iter_filesystems(zfs_handle_t *zhp, zfs_iter_f func, void *data)
2468 zfs_cmd_t zc = { 0 };
2472 if (zhp->zfs_type != ZFS_TYPE_FILESYSTEM)
2475 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2478 while ((ret = zfs_do_list_ioctl(zhp, ZFS_IOC_DATASET_LIST_NEXT,
2481 * Silently ignore errors, as the only plausible explanation is
2482 * that the pool has since been removed.
2484 if ((nzhp = make_dataset_handle_zc(zhp->zfs_hdl,
2489 if ((ret = func(nzhp, data)) != 0) {
2490 zcmd_free_nvlists(&zc);
2494 zcmd_free_nvlists(&zc);
2495 return ((ret < 0) ? ret : 0);
2499 * Iterate over all snapshots
2502 zfs_iter_snapshots(zfs_handle_t *zhp, zfs_iter_f func, void *data)
2504 zfs_cmd_t zc = { 0 };
2508 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT)
2511 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2513 while ((ret = zfs_do_list_ioctl(zhp, ZFS_IOC_SNAPSHOT_LIST_NEXT,
2516 if ((nzhp = make_dataset_handle_zc(zhp->zfs_hdl,
2521 if ((ret = func(nzhp, data)) != 0) {
2522 zcmd_free_nvlists(&zc);
2526 zcmd_free_nvlists(&zc);
2527 return ((ret < 0) ? ret : 0);
2531 * Iterate over all children, snapshots and filesystems
2534 zfs_iter_children(zfs_handle_t *zhp, zfs_iter_f func, void *data)
2538 if ((ret = zfs_iter_filesystems(zhp, func, data)) != 0)
2541 return (zfs_iter_snapshots(zhp, func, data));
2545 * Is one dataset name a child dataset of another?
2547 * Needs to handle these cases:
2548 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2549 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2550 * Descendant? No. No. No. Yes.
2553 is_descendant(const char *ds1, const char *ds2)
2555 size_t d1len = strlen(ds1);
2557 /* ds2 can't be a descendant if it's smaller */
2558 if (strlen(ds2) < d1len)
2561 /* otherwise, compare strings and verify that there's a '/' char */
2562 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
2566 * Given a complete name, return just the portion that refers to the parent.
2567 * Can return NULL if this is a pool.
2570 parent_name(const char *path, char *buf, size_t buflen)
2574 if ((loc = strrchr(path, '/')) == NULL)
2577 (void) strncpy(buf, path, MIN(buflen, loc - path));
2578 buf[loc - path] = '\0';
2584 * If accept_ancestor is false, then check to make sure that the given path has
2585 * a parent, and that it exists. If accept_ancestor is true, then find the
2586 * closest existing ancestor for the given path. In prefixlen return the
2587 * length of already existing prefix of the given path. We also fetch the
2588 * 'zoned' property, which is used to validate property settings when creating
2592 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
2593 boolean_t accept_ancestor, int *prefixlen)
2595 zfs_cmd_t zc = { 0 };
2596 char parent[ZFS_MAXNAMELEN];
2602 (void) snprintf(errbuf, sizeof (errbuf),
2603 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
2605 /* get parent, and check to see if this is just a pool */
2606 if (parent_name(path, parent, sizeof (parent)) != 0) {
2607 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2608 "missing dataset name"));
2609 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
2612 /* check to see if the pool exists */
2613 if ((slash = strchr(parent, '/')) == NULL)
2614 slash = parent + strlen(parent);
2615 (void) strncpy(zc.zc_name, parent, slash - parent);
2616 zc.zc_name[slash - parent] = '\0';
2617 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
2619 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2620 "no such pool '%s'"), zc.zc_name);
2621 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2624 /* check to see if the parent dataset exists */
2625 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
2626 if (errno == ENOENT && accept_ancestor) {
2628 * Go deeper to find an ancestor, give up on top level.
2630 if (parent_name(parent, parent, sizeof (parent)) != 0) {
2631 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2632 "no such pool '%s'"), zc.zc_name);
2633 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2635 } else if (errno == ENOENT) {
2636 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2637 "parent does not exist"));
2638 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2640 return (zfs_standard_error(hdl, errno, errbuf));
2643 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
2647 /* we are in a non-global zone, but parent is in the global zone */
2648 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
2649 (void) zfs_standard_error(hdl, EPERM, errbuf);
2654 /* make sure parent is a filesystem */
2655 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
2656 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2657 "parent is not a filesystem"));
2658 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
2664 if (prefixlen != NULL)
2665 *prefixlen = strlen(parent);
2670 * Finds whether the dataset of the given type(s) exists.
2673 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
2677 if (!zfs_validate_name(hdl, path, types, B_FALSE))
2681 * Try to get stats for the dataset, which will tell us if it exists.
2683 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
2684 int ds_type = zhp->zfs_type;
2687 if (types & ds_type)
2694 * Given a path to 'target', create all the ancestors between
2695 * the prefixlen portion of the path, and the target itself.
2696 * Fail if the initial prefixlen-ancestor does not already exist.
2699 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
2705 /* make sure prefix exists */
2706 cp = target + prefixlen;
2708 assert(strchr(cp, '/') == NULL);
2709 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2712 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2720 * Attempt to create, mount, and share any ancestor filesystems,
2721 * up to the prefixlen-long one.
2723 for (cp = target + prefixlen + 1;
2724 cp = strchr(cp, '/'); *cp = '/', cp++) {
2729 h = make_dataset_handle(hdl, target);
2731 /* it already exists, nothing to do here */
2736 logstr = hdl->libzfs_log_str;
2737 hdl->libzfs_log_str = NULL;
2738 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
2740 hdl->libzfs_log_str = logstr;
2741 opname = dgettext(TEXT_DOMAIN, "create");
2745 hdl->libzfs_log_str = logstr;
2746 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2748 opname = dgettext(TEXT_DOMAIN, "open");
2752 if (zfs_mount(h, NULL, 0) != 0) {
2753 opname = dgettext(TEXT_DOMAIN, "mount");
2757 if (zfs_share(h) != 0) {
2758 opname = dgettext(TEXT_DOMAIN, "share");
2768 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2769 "failed to %s ancestor '%s'"), opname, target);
2774 * Creates non-existing ancestors of the given path.
2777 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
2783 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
2786 if ((path_copy = strdup(path)) != NULL) {
2787 rc = create_parents(hdl, path_copy, prefix);
2790 if (path_copy == NULL || rc != 0)
2797 * Create a new filesystem or volume.
2800 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
2803 zfs_cmd_t zc = { 0 };
2806 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
2810 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
2811 "cannot create '%s'"), path);
2813 /* validate the path, taking care to note the extended error message */
2814 if (!zfs_validate_name(hdl, path, type, B_TRUE))
2815 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
2817 /* validate parents exist */
2818 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
2822 * The failure modes when creating a dataset of a different type over
2823 * one that already exists is a little strange. In particular, if you
2824 * try to create a dataset on top of an existing dataset, the ioctl()
2825 * will return ENOENT, not EEXIST. To prevent this from happening, we
2826 * first try to see if the dataset exists.
2828 (void) strlcpy(zc.zc_name, path, sizeof (zc.zc_name));
2829 if (zfs_dataset_exists(hdl, zc.zc_name, ZFS_TYPE_DATASET)) {
2830 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2831 "dataset already exists"));
2832 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
2835 if (type == ZFS_TYPE_VOLUME)
2836 zc.zc_objset_type = DMU_OST_ZVOL;
2838 zc.zc_objset_type = DMU_OST_ZFS;
2840 if (props && (props = zfs_valid_proplist(hdl, type, props,
2841 zoned, NULL, errbuf)) == 0)
2844 if (type == ZFS_TYPE_VOLUME) {
2846 * If we are creating a volume, the size and block size must
2847 * satisfy a few restraints. First, the blocksize must be a
2848 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
2849 * volsize must be a multiple of the block size, and cannot be
2852 if (props == NULL || nvlist_lookup_uint64(props,
2853 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
2855 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2856 "missing volume size"));
2857 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
2860 if ((ret = nvlist_lookup_uint64(props,
2861 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
2862 &blocksize)) != 0) {
2863 if (ret == ENOENT) {
2864 blocksize = zfs_prop_default_numeric(
2865 ZFS_PROP_VOLBLOCKSIZE);
2868 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2869 "missing volume block size"));
2870 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
2876 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2877 "volume size cannot be zero"));
2878 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
2881 if (size % blocksize != 0) {
2883 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2884 "volume size must be a multiple of volume block "
2886 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
2890 if (props && zcmd_write_src_nvlist(hdl, &zc, props) != 0)
2894 /* create the dataset */
2895 ret = zfs_ioctl(hdl, ZFS_IOC_CREATE, &zc);
2897 zcmd_free_nvlists(&zc);
2899 /* check for failure */
2901 char parent[ZFS_MAXNAMELEN];
2902 (void) parent_name(path, parent, sizeof (parent));
2906 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2907 "no such parent '%s'"), parent);
2908 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2911 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2912 "parent '%s' is not a filesystem"), parent);
2913 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
2916 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2917 "volume block size must be power of 2 from "
2919 (uint_t)SPA_MINBLOCKSIZE,
2920 (uint_t)SPA_MAXBLOCKSIZE >> 10);
2922 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
2925 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2926 "pool must be upgraded to set this "
2927 "property or value"));
2928 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
2932 * This platform can't address a volume this big.
2934 if (type == ZFS_TYPE_VOLUME)
2935 return (zfs_error(hdl, EZFS_VOLTOOBIG,
2940 return (zfs_standard_error(hdl, errno, errbuf));
2948 * Destroys the given dataset. The caller must make sure that the filesystem
2949 * isn't mounted, and that there are no active dependents.
2952 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
2954 zfs_cmd_t zc = { 0 };
2956 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2958 if (ZFS_IS_VOLUME(zhp)) {
2959 zc.zc_objset_type = DMU_OST_ZVOL;
2961 zc.zc_objset_type = DMU_OST_ZFS;
2964 zc.zc_defer_destroy = defer;
2965 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0) {
2966 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
2967 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
2971 remove_mountpoint(zhp);
2976 struct destroydata {
2983 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
2985 struct destroydata *dd = arg;
2987 char name[ZFS_MAXNAMELEN];
2988 boolean_t closezhp = dd->closezhp;
2991 (void) strlcpy(name, zhp->zfs_name, sizeof (name));
2992 (void) strlcat(name, "@", sizeof (name));
2993 (void) strlcat(name, dd->snapname, sizeof (name));
2995 szhp = make_dataset_handle(zhp->zfs_hdl, name);
2997 dd->gotone = B_TRUE;
3001 dd->closezhp = B_TRUE;
3003 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, arg);
3010 * Destroys all snapshots with the given name in zhp & descendants.
3013 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3015 zfs_cmd_t zc = { 0 };
3017 struct destroydata dd = { 0 };
3019 dd.snapname = snapname;
3020 (void) zfs_check_snap_cb(zhp, &dd);
3023 return (zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3024 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3025 zhp->zfs_name, snapname));
3028 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3029 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
3030 zc.zc_defer_destroy = defer;
3032 ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY_SNAPS, &zc);
3036 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3037 "cannot destroy '%s@%s'"), zc.zc_name, snapname);
3041 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3042 "snapshot is cloned"));
3043 return (zfs_error(zhp->zfs_hdl, EZFS_EXISTS, errbuf));
3046 return (zfs_standard_error(zhp->zfs_hdl, errno,
3055 * Clones the given dataset. The target must be of the same type as the source.
3058 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3060 zfs_cmd_t zc = { 0 };
3061 char parent[ZFS_MAXNAMELEN];
3064 libzfs_handle_t *hdl = zhp->zfs_hdl;
3068 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3070 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3071 "cannot create '%s'"), target);
3073 /* validate the target name */
3074 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3075 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3077 /* validate parents exist */
3078 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3081 (void) parent_name(target, parent, sizeof (parent));
3084 if (ZFS_IS_VOLUME(zhp)) {
3085 zc.zc_objset_type = DMU_OST_ZVOL;
3086 type = ZFS_TYPE_VOLUME;
3088 zc.zc_objset_type = DMU_OST_ZFS;
3089 type = ZFS_TYPE_FILESYSTEM;
3093 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3094 zhp, errbuf)) == NULL)
3097 if (zcmd_write_src_nvlist(hdl, &zc, props) != 0) {
3105 (void) strlcpy(zc.zc_name, target, sizeof (zc.zc_name));
3106 (void) strlcpy(zc.zc_value, zhp->zfs_name, sizeof (zc.zc_value));
3107 ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_CREATE, &zc);
3109 zcmd_free_nvlists(&zc);
3116 * The parent doesn't exist. We should have caught this
3117 * above, but there may a race condition that has since
3118 * destroyed the parent.
3120 * At this point, we don't know whether it's the source
3121 * that doesn't exist anymore, or whether the target
3122 * dataset doesn't exist.
3124 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3125 "no such parent '%s'"), parent);
3126 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3129 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3130 "source and target pools differ"));
3131 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3135 return (zfs_standard_error(zhp->zfs_hdl, errno,
3144 * Promotes the given clone fs to be the clone parent.
3147 zfs_promote(zfs_handle_t *zhp)
3149 libzfs_handle_t *hdl = zhp->zfs_hdl;
3150 zfs_cmd_t zc = { 0 };
3151 char parent[MAXPATHLEN];
3155 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3156 "cannot promote '%s'"), zhp->zfs_name);
3158 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3159 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3160 "snapshots can not be promoted"));
3161 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3164 (void) strlcpy(parent, zhp->zfs_dmustats.dds_origin, sizeof (parent));
3165 if (parent[0] == '\0') {
3166 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3167 "not a cloned filesystem"));
3168 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3171 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_origin,
3172 sizeof (zc.zc_value));
3173 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3174 ret = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc);
3177 int save_errno = errno;
3179 switch (save_errno) {
3181 /* There is a conflicting snapshot name. */
3182 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3183 "conflicting snapshot '%s' from parent '%s'"),
3184 zc.zc_string, parent);
3185 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3188 return (zfs_standard_error(hdl, save_errno, errbuf));
3195 * Takes a snapshot of the given dataset.
3198 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3202 char parent[ZFS_MAXNAMELEN];
3204 zfs_cmd_t zc = { 0 };
3208 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3209 "cannot snapshot '%s'"), path);
3211 /* validate the target name */
3212 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3213 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3216 if ((props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3217 props, B_FALSE, NULL, errbuf)) == NULL)
3220 if (zcmd_write_src_nvlist(hdl, &zc, props) != 0) {
3228 /* make sure the parent exists and is of the appropriate type */
3229 delim = strchr(path, '@');
3230 (void) strncpy(parent, path, delim - path);
3231 parent[delim - path] = '\0';
3233 if ((zhp = zfs_open(hdl, parent, ZFS_TYPE_FILESYSTEM |
3234 ZFS_TYPE_VOLUME)) == NULL) {
3235 zcmd_free_nvlists(&zc);
3239 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3240 (void) strlcpy(zc.zc_value, delim+1, sizeof (zc.zc_value));
3241 if (ZFS_IS_VOLUME(zhp))
3242 zc.zc_objset_type = DMU_OST_ZVOL;
3244 zc.zc_objset_type = DMU_OST_ZFS;
3245 zc.zc_cookie = recursive;
3246 ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_SNAPSHOT, &zc);
3248 zcmd_free_nvlists(&zc);
3251 * if it was recursive, the one that actually failed will be in
3255 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3256 "cannot create snapshot '%s@%s'"), zc.zc_name, zc.zc_value);
3257 (void) zfs_standard_error(hdl, errno, errbuf);
3266 * Destroy any more recent snapshots. We invoke this callback on any dependents
3267 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3268 * is a dependent and we should just destroy it without checking the transaction
3271 typedef struct rollback_data {
3272 const char *cb_target; /* the snapshot */
3273 uint64_t cb_create; /* creation time reference */
3275 boolean_t cb_dependent;
3280 rollback_destroy(zfs_handle_t *zhp, void *data)
3282 rollback_data_t *cbp = data;
3284 if (!cbp->cb_dependent) {
3285 if (strcmp(zhp->zfs_name, cbp->cb_target) != 0 &&
3286 zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT &&
3287 zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) >
3291 cbp->cb_dependent = B_TRUE;
3292 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3293 rollback_destroy, cbp);
3294 cbp->cb_dependent = B_FALSE;
3296 logstr = zhp->zfs_hdl->libzfs_log_str;
3297 zhp->zfs_hdl->libzfs_log_str = NULL;
3298 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3299 zhp->zfs_hdl->libzfs_log_str = logstr;
3302 /* We must destroy this clone; first unmount it */
3303 prop_changelist_t *clp;
3305 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3306 cbp->cb_force ? MS_FORCE: 0);
3307 if (clp == NULL || changelist_prefix(clp) != 0) {
3308 cbp->cb_error = B_TRUE;
3312 if (zfs_destroy(zhp, B_FALSE) != 0)
3313 cbp->cb_error = B_TRUE;
3315 changelist_remove(clp, zhp->zfs_name);
3316 (void) changelist_postfix(clp);
3317 changelist_free(clp);
3325 * Given a dataset, rollback to a specific snapshot, discarding any
3326 * data changes since then and making it the active dataset.
3328 * Any snapshots more recent than the target are destroyed, along with
3332 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3334 rollback_data_t cb = { 0 };
3336 zfs_cmd_t zc = { 0 };
3337 boolean_t restore_resv = 0;
3338 uint64_t old_volsize, new_volsize;
3339 zfs_prop_t resv_prop;
3341 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3342 zhp->zfs_type == ZFS_TYPE_VOLUME);
3345 * Destroy all recent snapshots and its dependends.
3347 cb.cb_force = force;
3348 cb.cb_target = snap->zfs_name;
3349 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3350 (void) zfs_iter_children(zhp, rollback_destroy, &cb);
3356 * Now that we have verified that the snapshot is the latest,
3357 * rollback to the given snapshot.
3360 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
3361 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
3363 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3365 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
3368 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3370 if (ZFS_IS_VOLUME(zhp))
3371 zc.zc_objset_type = DMU_OST_ZVOL;
3373 zc.zc_objset_type = DMU_OST_ZFS;
3376 * We rely on zfs_iter_children() to verify that there are no
3377 * newer snapshots for the given dataset. Therefore, we can
3378 * simply pass the name on to the ioctl() call. There is still
3379 * an unlikely race condition where the user has taken a
3380 * snapshot since we verified that this was the most recent.
3383 if ((err = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_ROLLBACK, &zc)) != 0) {
3384 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3385 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
3391 * For volumes, if the pre-rollback volsize matched the pre-
3392 * rollback reservation and the volsize has changed then set
3393 * the reservation property to the post-rollback volsize.
3394 * Make a new handle since the rollback closed the dataset.
3396 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
3397 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
3399 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3400 if (old_volsize != new_volsize)
3401 err = zfs_prop_set_int(zhp, resv_prop,
3410 * Iterate over all dependents for a given dataset. This includes both
3411 * hierarchical dependents (children) and data dependents (snapshots and
3412 * clones). The bulk of the processing occurs in get_dependents() in
3416 zfs_iter_dependents(zfs_handle_t *zhp, boolean_t allowrecursion,
3417 zfs_iter_f func, void *data)
3422 zfs_handle_t *child;
3425 if (get_dependents(zhp->zfs_hdl, allowrecursion, zhp->zfs_name,
3426 &dependents, &count) != 0)
3429 for (i = 0; i < count; i++) {
3430 if ((child = make_dataset_handle(zhp->zfs_hdl,
3431 dependents[i])) == NULL)
3434 if ((ret = func(child, data)) != 0)
3438 for (i = 0; i < count; i++)
3439 free(dependents[i]);
3446 * Renames the given dataset.
3449 zfs_rename(zfs_handle_t *zhp, const char *target, boolean_t recursive)
3452 zfs_cmd_t zc = { 0 };
3454 prop_changelist_t *cl = NULL;
3455 zfs_handle_t *zhrp = NULL;
3456 char *parentname = NULL;
3457 char parent[ZFS_MAXNAMELEN];
3458 libzfs_handle_t *hdl = zhp->zfs_hdl;
3461 /* if we have the same exact name, just return success */
3462 if (strcmp(zhp->zfs_name, target) == 0)
3465 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3466 "cannot rename to '%s'"), target);
3469 * Make sure the target name is valid
3471 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3472 if ((strchr(target, '@') == NULL) ||
3475 * Snapshot target name is abbreviated,
3476 * reconstruct full dataset name
3478 (void) strlcpy(parent, zhp->zfs_name,
3480 delim = strchr(parent, '@');
3481 if (strchr(target, '@') == NULL)
3485 (void) strlcat(parent, target, sizeof (parent));
3489 * Make sure we're renaming within the same dataset.
3491 delim = strchr(target, '@');
3492 if (strncmp(zhp->zfs_name, target, delim - target)
3493 != 0 || zhp->zfs_name[delim - target] != '@') {
3494 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3495 "snapshots must be part of same "
3497 return (zfs_error(hdl, EZFS_CROSSTARGET,
3501 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3502 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3505 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3506 "recursive rename must be a snapshot"));
3507 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3510 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3511 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3513 /* validate parents */
3514 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
3517 /* make sure we're in the same pool */
3518 verify((delim = strchr(target, '/')) != NULL);
3519 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
3520 zhp->zfs_name[delim - target] != '/') {
3521 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3522 "datasets must be within same pool"));
3523 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
3526 /* new name cannot be a child of the current dataset name */
3527 if (is_descendant(zhp->zfs_name, target)) {
3528 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3529 "New dataset name cannot be a descendant of "
3530 "current dataset name"));
3531 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3535 (void) snprintf(errbuf, sizeof (errbuf),
3536 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
3538 if (getzoneid() == GLOBAL_ZONEID &&
3539 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
3540 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3541 "dataset is used in a non-global zone"));
3542 return (zfs_error(hdl, EZFS_ZONED, errbuf));
3547 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
3548 if (parentname == NULL) {
3552 delim = strchr(parentname, '@');
3554 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
3561 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0, 0)) == NULL)
3564 if (changelist_haszonedchild(cl)) {
3565 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3566 "child dataset with inherited mountpoint is used "
3567 "in a non-global zone"));
3568 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
3572 if ((ret = changelist_prefix(cl)) != 0)
3576 if (ZFS_IS_VOLUME(zhp))
3577 zc.zc_objset_type = DMU_OST_ZVOL;
3579 zc.zc_objset_type = DMU_OST_ZFS;
3581 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3582 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
3584 zc.zc_cookie = recursive;
3586 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
3588 * if it was recursive, the one that actually failed will
3591 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3592 "cannot rename '%s'"), zc.zc_name);
3594 if (recursive && errno == EEXIST) {
3595 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3596 "a child dataset already has a snapshot "
3597 "with the new name"));
3598 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3600 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
3604 * On failure, we still want to remount any filesystems that
3605 * were previously mounted, so we don't alter the system state.
3608 (void) changelist_postfix(cl);
3611 changelist_rename(cl, zfs_get_name(zhp), target);
3612 ret = changelist_postfix(cl);
3624 changelist_free(cl);
3630 zfs_get_user_props(zfs_handle_t *zhp)
3632 return (zhp->zfs_user_props);
3636 zfs_get_recvd_props(zfs_handle_t *zhp)
3638 if (zhp->zfs_recvd_props == NULL)
3639 if (get_recvd_props_ioctl(zhp) != 0)
3641 return (zhp->zfs_recvd_props);
3645 * This function is used by 'zfs list' to determine the exact set of columns to
3646 * display, and their maximum widths. This does two main things:
3648 * - If this is a list of all properties, then expand the list to include
3649 * all native properties, and set a flag so that for each dataset we look
3650 * for new unique user properties and add them to the list.
3652 * - For non fixed-width properties, keep track of the maximum width seen
3653 * so that we can size the column appropriately. If the user has
3654 * requested received property values, we also need to compute the width
3655 * of the RECEIVED column.
3658 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received)
3660 libzfs_handle_t *hdl = zhp->zfs_hdl;
3661 zprop_list_t *entry;
3662 zprop_list_t **last, **start;
3663 nvlist_t *userprops, *propval;
3666 char buf[ZFS_MAXPROPLEN];
3668 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
3671 userprops = zfs_get_user_props(zhp);
3674 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
3676 * Go through and add any user properties as necessary. We
3677 * start by incrementing our list pointer to the first
3678 * non-native property.
3681 while (*start != NULL) {
3682 if ((*start)->pl_prop == ZPROP_INVAL)
3684 start = &(*start)->pl_next;
3688 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
3690 * See if we've already found this property in our list.
3692 for (last = start; *last != NULL;
3693 last = &(*last)->pl_next) {
3694 if (strcmp((*last)->pl_user_prop,
3695 nvpair_name(elem)) == 0)
3699 if (*last == NULL) {
3700 if ((entry = zfs_alloc(hdl,
3701 sizeof (zprop_list_t))) == NULL ||
3702 ((entry->pl_user_prop = zfs_strdup(hdl,
3703 nvpair_name(elem)))) == NULL) {
3708 entry->pl_prop = ZPROP_INVAL;
3709 entry->pl_width = strlen(nvpair_name(elem));
3710 entry->pl_all = B_TRUE;
3717 * Now go through and check the width of any non-fixed columns
3719 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
3720 if (entry->pl_fixed)
3723 if (entry->pl_prop != ZPROP_INVAL) {
3724 if (zfs_prop_get(zhp, entry->pl_prop,
3725 buf, sizeof (buf), NULL, NULL, 0, B_FALSE) == 0) {
3726 if (strlen(buf) > entry->pl_width)
3727 entry->pl_width = strlen(buf);
3729 if (received && zfs_prop_get_recvd(zhp,
3730 zfs_prop_to_name(entry->pl_prop),
3731 buf, sizeof (buf), B_FALSE) == 0)
3732 if (strlen(buf) > entry->pl_recvd_width)
3733 entry->pl_recvd_width = strlen(buf);
3735 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
3737 verify(nvlist_lookup_string(propval,
3738 ZPROP_VALUE, &strval) == 0);
3739 if (strlen(strval) > entry->pl_width)
3740 entry->pl_width = strlen(strval);
3742 if (received && zfs_prop_get_recvd(zhp,
3743 entry->pl_user_prop,
3744 buf, sizeof (buf), B_FALSE) == 0)
3745 if (strlen(buf) > entry->pl_recvd_width)
3746 entry->pl_recvd_width = strlen(buf);
3754 zfs_deleg_share_nfs(libzfs_handle_t *hdl, char *dataset, char *path,
3755 char *resource, void *export, void *sharetab,
3756 int sharemax, zfs_share_op_t operation)
3758 zfs_cmd_t zc = { 0 };
3761 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
3762 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
3764 (void) strlcpy(zc.zc_string, resource, sizeof (zc.zc_string));
3765 zc.zc_share.z_sharedata = (uint64_t)(uintptr_t)sharetab;
3766 zc.zc_share.z_exportdata = (uint64_t)(uintptr_t)export;
3767 zc.zc_share.z_sharetype = operation;
3768 zc.zc_share.z_sharemax = sharemax;
3769 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SHARE, &zc);
3774 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
3779 * Keep a reference to the props-table against which we prune the
3782 zhp->zfs_props_table = props;
3784 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
3787 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
3788 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
3791 * User properties will result in ZPROP_INVAL, and since we
3792 * only know how to prune standard ZFS properties, we always
3793 * leave these in the list. This can also happen if we
3794 * encounter an unknown DSL property (when running older
3795 * software, for example).
3797 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
3798 (void) nvlist_remove(zhp->zfs_props,
3799 nvpair_name(curr), nvpair_type(curr));
3805 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
3806 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
3808 zfs_cmd_t zc = { 0 };
3809 nvlist_t *nvlist = NULL;
3812 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
3813 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
3814 zc.zc_cookie = (uint64_t)cmd;
3816 if (cmd == ZFS_SMB_ACL_RENAME) {
3817 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
3818 (void) no_memory(hdl);
3824 case ZFS_SMB_ACL_ADD:
3825 case ZFS_SMB_ACL_REMOVE:
3826 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
3828 case ZFS_SMB_ACL_RENAME:
3829 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
3831 (void) no_memory(hdl);
3834 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
3836 (void) no_memory(hdl);
3839 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
3840 nvlist_free(nvlist);
3844 case ZFS_SMB_ACL_PURGE:
3849 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
3851 nvlist_free(nvlist);
3856 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
3857 char *path, char *resource)
3859 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
3864 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
3865 char *path, char *resource)
3867 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
3872 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
3874 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
3879 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
3880 char *oldname, char *newname)
3882 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
3887 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
3888 zfs_userspace_cb_t func, void *arg)
3890 zfs_cmd_t zc = { 0 };
3892 zfs_useracct_t buf[100];
3894 (void) strncpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3896 zc.zc_objset_type = type;
3897 zc.zc_nvlist_dst = (uintptr_t)buf;
3901 zfs_useracct_t *zua = buf;
3903 zc.zc_nvlist_dst_size = sizeof (buf);
3904 error = ioctl(zhp->zfs_hdl->libzfs_fd,
3905 ZFS_IOC_USERSPACE_MANY, &zc);
3906 if (error || zc.zc_nvlist_dst_size == 0)
3909 while (zc.zc_nvlist_dst_size > 0) {
3910 error = func(arg, zua->zu_domain, zua->zu_rid,
3915 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
3923 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
3924 boolean_t recursive, boolean_t temphold, boolean_t enoent_ok,
3925 int cleanup_fd, uint64_t dsobj, uint64_t createtxg)
3927 zfs_cmd_t zc = { 0 };
3928 libzfs_handle_t *hdl = zhp->zfs_hdl;
3930 ASSERT(!recursive || dsobj == 0);
3932 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3933 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
3934 if (strlcpy(zc.zc_string, tag, sizeof (zc.zc_string))
3935 >= sizeof (zc.zc_string))
3936 return (zfs_error(hdl, EZFS_TAGTOOLONG, tag));
3937 zc.zc_cookie = recursive;
3938 zc.zc_temphold = temphold;
3939 zc.zc_cleanup_fd = cleanup_fd;
3940 zc.zc_sendobj = dsobj;
3941 zc.zc_createtxg = createtxg;
3943 if (zfs_ioctl(hdl, ZFS_IOC_HOLD, &zc) != 0) {
3944 char errbuf[ZFS_MAXNAMELEN+32];
3947 * if it was recursive, the one that actually failed will be in
3950 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3951 "cannot hold '%s@%s'"), zc.zc_name, snapname);
3955 * Temporary tags wind up having the ds object id
3956 * prepended. So even if we passed the length check
3957 * above, it's still possible for the tag to wind
3958 * up being slightly too long.
3960 return (zfs_error(hdl, EZFS_TAGTOOLONG, errbuf));
3962 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3963 "pool must be upgraded"));
3964 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3966 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3968 return (zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf));
3974 return (zfs_standard_error_fmt(hdl, errno, errbuf));
3982 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
3983 boolean_t recursive)
3985 zfs_cmd_t zc = { 0 };
3986 libzfs_handle_t *hdl = zhp->zfs_hdl;
3988 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3989 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
3990 if (strlcpy(zc.zc_string, tag, sizeof (zc.zc_string))
3991 >= sizeof (zc.zc_string))
3992 return (zfs_error(hdl, EZFS_TAGTOOLONG, tag));
3993 zc.zc_cookie = recursive;
3995 if (zfs_ioctl(hdl, ZFS_IOC_RELEASE, &zc) != 0) {
3996 char errbuf[ZFS_MAXNAMELEN+32];
3999 * if it was recursive, the one that actually failed will be in
4002 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4003 "cannot release '%s' from '%s@%s'"), tag, zc.zc_name,
4007 return (zfs_error(hdl, EZFS_REFTAG_RELE, errbuf));
4009 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4010 "pool must be upgraded"));
4011 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
4013 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4015 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4023 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4026 uint64_t nblocks, volblocksize;
4030 if (nvlist_lookup_string(props,
4031 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4032 ncopies = atoi(strval);
4035 if (nvlist_lookup_uint64(props,
4036 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4037 &volblocksize) != 0)
4038 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4039 nblocks = volsize/volblocksize;
4040 /* start with metadnode L0-L6 */
4042 /* calculate number of indirects */
4043 while (nblocks > 1) {
4044 nblocks += DNODES_PER_LEVEL - 1;
4045 nblocks /= DNODES_PER_LEVEL;
4048 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4051 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4052 * compressed, but in practice they compress down to about
4055 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;