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 2010 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
38 #include <sys/mntent.h>
39 #include <sys/mount.h>
47 #include <directory.h>
49 #include <sys/dnode.h>
54 #include "zfs_namecheck.h"
56 #include "libzfs_impl.h"
57 #include "zfs_deleg.h"
59 static int userquota_propname_decode(const char *propname, boolean_t zoned,
60 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
63 * Given a single type (not a mask of types), return the type in a human
67 zfs_type_to_name(zfs_type_t type)
70 case ZFS_TYPE_FILESYSTEM:
71 return (dgettext(TEXT_DOMAIN, "filesystem"));
72 case ZFS_TYPE_SNAPSHOT:
73 return (dgettext(TEXT_DOMAIN, "snapshot"));
75 return (dgettext(TEXT_DOMAIN, "volume"));
82 * Given a path and mask of ZFS types, return a string describing this dataset.
83 * This is used when we fail to open a dataset and we cannot get an exact type.
84 * We guess what the type would have been based on the path and the mask of
88 path_to_str(const char *path, int types)
91 * When given a single type, always report the exact type.
93 if (types == ZFS_TYPE_SNAPSHOT)
94 return (dgettext(TEXT_DOMAIN, "snapshot"));
95 if (types == ZFS_TYPE_FILESYSTEM)
96 return (dgettext(TEXT_DOMAIN, "filesystem"));
97 if (types == ZFS_TYPE_VOLUME)
98 return (dgettext(TEXT_DOMAIN, "volume"));
101 * The user is requesting more than one type of dataset. If this is the
102 * case, consult the path itself. If we're looking for a snapshot, and
103 * a '@' is found, then report it as "snapshot". Otherwise, remove the
104 * snapshot attribute and try again.
106 if (types & ZFS_TYPE_SNAPSHOT) {
107 if (strchr(path, '@') != NULL)
108 return (dgettext(TEXT_DOMAIN, "snapshot"));
109 return (path_to_str(path, types & ~ZFS_TYPE_SNAPSHOT));
113 * The user has requested either filesystems or volumes.
114 * We have no way of knowing a priori what type this would be, so always
115 * report it as "filesystem" or "volume", our two primitive types.
117 if (types & ZFS_TYPE_FILESYSTEM)
118 return (dgettext(TEXT_DOMAIN, "filesystem"));
120 assert(types & ZFS_TYPE_VOLUME);
121 return (dgettext(TEXT_DOMAIN, "volume"));
125 * Validate a ZFS path. This is used even before trying to open the dataset, to
126 * provide a more meaningful error message. We call zfs_error_aux() to
127 * explain exactly why the name was not valid.
130 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
136 if (dataset_namecheck(path, &why, &what) != 0) {
139 case NAME_ERR_TOOLONG:
140 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
141 "name is too long"));
144 case NAME_ERR_LEADING_SLASH:
145 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
146 "leading slash in name"));
149 case NAME_ERR_EMPTY_COMPONENT:
150 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
151 "empty component in name"));
154 case NAME_ERR_TRAILING_SLASH:
155 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
156 "trailing slash in name"));
159 case NAME_ERR_INVALCHAR:
161 dgettext(TEXT_DOMAIN, "invalid character "
162 "'%c' in name"), what);
165 case NAME_ERR_MULTIPLE_AT:
166 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
167 "multiple '@' delimiters in name"));
170 case NAME_ERR_NOLETTER:
171 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
172 "pool doesn't begin with a letter"));
175 case NAME_ERR_RESERVED:
176 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
177 "name is reserved"));
180 case NAME_ERR_DISKLIKE:
181 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
182 "reserved disk name"));
190 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
192 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
193 "snapshot delimiter '@' in filesystem name"));
197 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
199 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
200 "missing '@' delimiter in snapshot name"));
204 if (modifying && strchr(path, '%') != NULL) {
206 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
207 "invalid character %c in name"), '%');
215 zfs_name_valid(const char *name, zfs_type_t type)
217 if (type == ZFS_TYPE_POOL)
218 return (zpool_name_valid(NULL, B_FALSE, name));
219 return (zfs_validate_name(NULL, name, type, B_FALSE));
223 * This function takes the raw DSL properties, and filters out the user-defined
224 * properties into a separate nvlist.
227 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
229 libzfs_handle_t *hdl = zhp->zfs_hdl;
234 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
235 (void) no_memory(hdl);
240 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
241 if (!zfs_prop_user(nvpair_name(elem)))
244 verify(nvpair_value_nvlist(elem, &propval) == 0);
245 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
247 (void) no_memory(hdl);
255 static zpool_handle_t *
256 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
258 libzfs_handle_t *hdl = zhp->zfs_hdl;
261 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
262 if (hdl->libzfs_pool_handles != NULL)
263 zph->zpool_next = hdl->libzfs_pool_handles;
264 hdl->libzfs_pool_handles = zph;
269 static zpool_handle_t *
270 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
272 libzfs_handle_t *hdl = zhp->zfs_hdl;
273 zpool_handle_t *zph = hdl->libzfs_pool_handles;
275 while ((zph != NULL) &&
276 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
277 zph = zph->zpool_next;
282 * Returns a handle to the pool that contains the provided dataset.
283 * If a handle to that pool already exists then that handle is returned.
284 * Otherwise, a new handle is created and added to the list of handles.
286 static zpool_handle_t *
287 zpool_handle(zfs_handle_t *zhp)
293 len = strcspn(zhp->zfs_name, "/@") + 1;
294 pool_name = zfs_alloc(zhp->zfs_hdl, len);
295 (void) strlcpy(pool_name, zhp->zfs_name, len);
297 zph = zpool_find_handle(zhp, pool_name, len);
299 zph = zpool_add_handle(zhp, pool_name);
306 zpool_free_handles(libzfs_handle_t *hdl)
308 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
310 while (zph != NULL) {
311 next = zph->zpool_next;
315 hdl->libzfs_pool_handles = NULL;
319 * Utility function to gather stats (objset and zpl) for the given object.
322 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
324 libzfs_handle_t *hdl = zhp->zfs_hdl;
326 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
328 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, zc) != 0) {
329 if (errno == ENOMEM) {
330 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
341 * Utility function to get the received properties of the given object.
344 get_recvd_props_ioctl(zfs_handle_t *zhp)
346 libzfs_handle_t *hdl = zhp->zfs_hdl;
347 nvlist_t *recvdprops;
348 zfs_cmd_t zc = { 0 };
351 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
354 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
356 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
357 if (errno == ENOMEM) {
358 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
362 zcmd_free_nvlists(&zc);
367 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
368 zcmd_free_nvlists(&zc);
372 nvlist_free(zhp->zfs_recvd_props);
373 zhp->zfs_recvd_props = recvdprops;
379 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
381 nvlist_t *allprops, *userprops;
383 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
385 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
390 * XXX Why do we store the user props separately, in addition to
391 * storing them in zfs_props?
393 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
394 nvlist_free(allprops);
398 nvlist_free(zhp->zfs_props);
399 nvlist_free(zhp->zfs_user_props);
401 zhp->zfs_props = allprops;
402 zhp->zfs_user_props = userprops;
408 get_stats(zfs_handle_t *zhp)
411 zfs_cmd_t zc = { 0 };
413 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
415 if (get_stats_ioctl(zhp, &zc) != 0)
417 else if (put_stats_zhdl(zhp, &zc) != 0)
419 zcmd_free_nvlists(&zc);
424 * Refresh the properties currently stored in the handle.
427 zfs_refresh_properties(zfs_handle_t *zhp)
429 (void) get_stats(zhp);
433 * Makes a handle from the given dataset name. Used by zfs_open() and
434 * zfs_iter_* to create child handles on the fly.
437 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
439 if (put_stats_zhdl(zhp, zc) != 0)
443 * We've managed to open the dataset and gather statistics. Determine
444 * the high-level type.
446 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
447 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
448 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
449 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
453 if (zhp->zfs_dmustats.dds_is_snapshot)
454 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
455 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
456 zhp->zfs_type = ZFS_TYPE_VOLUME;
457 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
458 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
460 abort(); /* we should never see any other types */
462 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
469 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
471 zfs_cmd_t zc = { 0 };
473 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
479 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
480 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
484 if (get_stats_ioctl(zhp, &zc) == -1) {
485 zcmd_free_nvlists(&zc);
489 if (make_dataset_handle_common(zhp, &zc) == -1) {
493 zcmd_free_nvlists(&zc);
497 static zfs_handle_t *
498 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
500 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
506 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
507 if (make_dataset_handle_common(zhp, zc) == -1) {
515 * Opens the given snapshot, filesystem, or volume. The 'types'
516 * argument is a mask of acceptable types. The function will print an
517 * appropriate error message and return NULL if it can't be opened.
520 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
525 (void) snprintf(errbuf, sizeof (errbuf),
526 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
529 * Validate the name before we even try to open it.
531 if (!zfs_validate_name(hdl, path, ZFS_TYPE_DATASET, B_FALSE)) {
532 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
533 "invalid dataset name"));
534 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
539 * Try to get stats for the dataset, which will tell us if it exists.
542 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
543 (void) zfs_standard_error(hdl, errno, errbuf);
547 if (!(types & zhp->zfs_type)) {
548 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
557 * Release a ZFS handle. Nothing to do but free the associated memory.
560 zfs_close(zfs_handle_t *zhp)
562 if (zhp->zfs_mntopts)
563 free(zhp->zfs_mntopts);
564 nvlist_free(zhp->zfs_props);
565 nvlist_free(zhp->zfs_user_props);
566 nvlist_free(zhp->zfs_recvd_props);
570 typedef struct mnttab_node {
571 struct mnttab mtn_mt;
576 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
578 const mnttab_node_t *mtn1 = arg1;
579 const mnttab_node_t *mtn2 = arg2;
582 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
586 return (rv > 0 ? 1 : -1);
590 libzfs_mnttab_init(libzfs_handle_t *hdl)
592 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
593 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
594 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
598 libzfs_mnttab_update(libzfs_handle_t *hdl)
602 rewind(hdl->libzfs_mnttab);
603 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
606 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
608 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
609 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
610 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
611 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
612 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
613 avl_add(&hdl->libzfs_mnttab_cache, mtn);
618 libzfs_mnttab_fini(libzfs_handle_t *hdl)
623 while (mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie)) {
624 free(mtn->mtn_mt.mnt_special);
625 free(mtn->mtn_mt.mnt_mountp);
626 free(mtn->mtn_mt.mnt_fstype);
627 free(mtn->mtn_mt.mnt_mntopts);
630 avl_destroy(&hdl->libzfs_mnttab_cache);
634 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
636 hdl->libzfs_mnttab_enable = enable;
640 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
641 struct mnttab *entry)
646 if (!hdl->libzfs_mnttab_enable) {
647 struct mnttab srch = { 0 };
649 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
650 libzfs_mnttab_fini(hdl);
651 rewind(hdl->libzfs_mnttab);
652 srch.mnt_special = (char *)fsname;
653 srch.mnt_fstype = MNTTYPE_ZFS;
654 if (getmntany(hdl->libzfs_mnttab, entry, &srch) == 0)
660 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
661 libzfs_mnttab_update(hdl);
663 find.mtn_mt.mnt_special = (char *)fsname;
664 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
666 *entry = mtn->mtn_mt;
673 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
674 const char *mountp, const char *mntopts)
678 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
680 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
681 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
682 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
683 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
684 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
685 avl_add(&hdl->libzfs_mnttab_cache, mtn);
689 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
694 find.mtn_mt.mnt_special = (char *)fsname;
695 if (ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL)) {
696 avl_remove(&hdl->libzfs_mnttab_cache, ret);
697 free(ret->mtn_mt.mnt_special);
698 free(ret->mtn_mt.mnt_mountp);
699 free(ret->mtn_mt.mnt_fstype);
700 free(ret->mtn_mt.mnt_mntopts);
706 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
708 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
710 if (zpool_handle == NULL)
713 *spa_version = zpool_get_prop_int(zpool_handle,
714 ZPOOL_PROP_VERSION, NULL);
719 * The choice of reservation property depends on the SPA version.
722 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
726 if (zfs_spa_version(zhp, &spa_version) < 0)
729 if (spa_version >= SPA_VERSION_REFRESERVATION)
730 *resv_prop = ZFS_PROP_REFRESERVATION;
732 *resv_prop = ZFS_PROP_RESERVATION;
738 * Given an nvlist of properties to set, validates that they are correct, and
739 * parses any numeric properties (index, boolean, etc) if they are specified as
743 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
744 uint64_t zoned, zfs_handle_t *zhp, const char *errbuf)
751 int chosen_normal = -1;
754 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
755 (void) no_memory(hdl);
760 * Make sure this property is valid and applies to this type.
764 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
765 const char *propname = nvpair_name(elem);
767 prop = zfs_name_to_prop(propname);
768 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
770 * This is a user property: make sure it's a
771 * string, and that it's less than ZAP_MAXNAMELEN.
773 if (nvpair_type(elem) != DATA_TYPE_STRING) {
774 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
775 "'%s' must be a string"), propname);
776 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
780 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
781 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
782 "property name '%s' is too long"),
784 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
788 (void) nvpair_value_string(elem, &strval);
789 if (nvlist_add_string(ret, propname, strval) != 0) {
790 (void) no_memory(hdl);
797 * Currently, only user properties can be modified on
800 if (type == ZFS_TYPE_SNAPSHOT) {
801 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
802 "this property can not be modified for snapshots"));
803 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
807 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
808 zfs_userquota_prop_t uqtype;
809 char newpropname[128];
814 if (userquota_propname_decode(propname, zoned,
815 &uqtype, domain, sizeof (domain), &rid) != 0) {
817 dgettext(TEXT_DOMAIN,
818 "'%s' has an invalid user/group name"),
820 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
824 if (uqtype != ZFS_PROP_USERQUOTA &&
825 uqtype != ZFS_PROP_GROUPQUOTA) {
827 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
829 (void) zfs_error(hdl, EZFS_PROPREADONLY,
834 if (nvpair_type(elem) == DATA_TYPE_STRING) {
835 (void) nvpair_value_string(elem, &strval);
836 if (strcmp(strval, "none") == 0) {
838 } else if (zfs_nicestrtonum(hdl,
839 strval, &intval) != 0) {
840 (void) zfs_error(hdl,
841 EZFS_BADPROP, errbuf);
844 } else if (nvpair_type(elem) ==
846 (void) nvpair_value_uint64(elem, &intval);
848 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
849 "use 'none' to disable "
850 "userquota/groupquota"));
854 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
855 "'%s' must be a number"), propname);
856 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
861 * Encode the prop name as
862 * userquota@<hex-rid>-domain, to make it easy
863 * for the kernel to decode.
865 (void) snprintf(newpropname, sizeof (newpropname),
866 "%s%llx-%s", zfs_userquota_prop_prefixes[uqtype],
867 (longlong_t)rid, domain);
871 if (nvlist_add_uint64_array(ret, newpropname,
873 (void) no_memory(hdl);
879 if (prop == ZPROP_INVAL) {
880 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
881 "invalid property '%s'"), propname);
882 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
886 if (!zfs_prop_valid_for_type(prop, type)) {
888 dgettext(TEXT_DOMAIN, "'%s' does not "
889 "apply to datasets of this type"), propname);
890 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
894 if (zfs_prop_readonly(prop) &&
895 (!zfs_prop_setonce(prop) || zhp != NULL)) {
897 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
899 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
903 if (zprop_parse_value(hdl, elem, prop, type, ret,
904 &strval, &intval, errbuf) != 0)
908 * Perform some additional checks for specific properties.
911 case ZFS_PROP_VERSION:
917 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
918 if (intval < version) {
919 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
920 "Can not downgrade; already at version %u"),
922 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
928 case ZFS_PROP_RECORDSIZE:
929 case ZFS_PROP_VOLBLOCKSIZE:
930 /* must be power of two within SPA_{MIN,MAX}BLOCKSIZE */
931 if (intval < SPA_MINBLOCKSIZE ||
932 intval > SPA_MAXBLOCKSIZE || !ISP2(intval)) {
933 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
934 "'%s' must be power of 2 from %u "
936 (uint_t)SPA_MINBLOCKSIZE,
937 (uint_t)SPA_MAXBLOCKSIZE >> 10);
938 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
943 case ZFS_PROP_MLSLABEL:
946 * Verify the mlslabel string and convert to
947 * internal hex label string.
951 char *hex = NULL; /* internal label string */
953 /* Default value is already OK. */
954 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
957 /* Verify the label can be converted to binary form */
958 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
959 (str_to_label(strval, &new_sl, MAC_LABEL,
960 L_NO_CORRECTION, NULL) == -1)) {
964 /* Now translate to hex internal label string */
965 if (label_to_str(new_sl, &hex, M_INTERNAL,
971 m_label_free(new_sl);
973 /* If string is already in internal form, we're done. */
974 if (strcmp(strval, hex) == 0) {
979 /* Replace the label string with the internal form. */
980 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
982 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
989 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
990 "invalid mlslabel '%s'"), strval);
991 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
992 m_label_free(new_sl); /* OK if null */
997 case ZFS_PROP_MOUNTPOINT:
1001 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1002 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1005 if (mountpoint_namecheck(strval, &why)) {
1007 case NAME_ERR_LEADING_SLASH:
1009 dgettext(TEXT_DOMAIN,
1010 "'%s' must be an absolute path, "
1011 "'none', or 'legacy'"), propname);
1013 case NAME_ERR_TOOLONG:
1015 dgettext(TEXT_DOMAIN,
1016 "component of '%s' is too long"),
1020 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1027 case ZFS_PROP_SHARESMB:
1028 case ZFS_PROP_SHARENFS:
1030 * For the mountpoint and sharenfs or sharesmb
1031 * properties, check if it can be set in a
1032 * global/non-global zone based on
1033 * the zoned property value:
1035 * global zone non-global zone
1036 * --------------------------------------------------
1037 * zoned=on mountpoint (no) mountpoint (yes)
1038 * sharenfs (no) sharenfs (no)
1039 * sharesmb (no) sharesmb (no)
1041 * zoned=off mountpoint (yes) N/A
1046 if (getzoneid() == GLOBAL_ZONEID) {
1047 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1048 "'%s' cannot be set on "
1049 "dataset in a non-global zone"),
1051 (void) zfs_error(hdl, EZFS_ZONED,
1054 } else if (prop == ZFS_PROP_SHARENFS ||
1055 prop == ZFS_PROP_SHARESMB) {
1056 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1057 "'%s' cannot be set in "
1058 "a non-global zone"), propname);
1059 (void) zfs_error(hdl, EZFS_ZONED,
1063 } else if (getzoneid() != GLOBAL_ZONEID) {
1065 * If zoned property is 'off', this must be in
1066 * a global zone. If not, something is wrong.
1068 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1069 "'%s' cannot be set while dataset "
1070 "'zoned' property is set"), propname);
1071 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1076 * At this point, it is legitimate to set the
1077 * property. Now we want to make sure that the
1078 * property value is valid if it is sharenfs.
1080 if ((prop == ZFS_PROP_SHARENFS ||
1081 prop == ZFS_PROP_SHARESMB) &&
1082 strcmp(strval, "on") != 0 &&
1083 strcmp(strval, "off") != 0) {
1084 zfs_share_proto_t proto;
1086 if (prop == ZFS_PROP_SHARESMB)
1092 * Must be an valid sharing protocol
1093 * option string so init the libshare
1094 * in order to enable the parser and
1095 * then parse the options. We use the
1096 * control API since we don't care about
1097 * the current configuration and don't
1098 * want the overhead of loading it
1099 * until we actually do something.
1102 if (zfs_init_libshare(hdl,
1103 SA_INIT_CONTROL_API) != SA_OK) {
1105 * An error occurred so we can't do
1108 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1109 "'%s' cannot be set: problem "
1110 "in share initialization"),
1112 (void) zfs_error(hdl, EZFS_BADPROP,
1117 if (zfs_parse_options(strval, proto) != SA_OK) {
1119 * There was an error in parsing so
1120 * deal with it by issuing an error
1121 * message and leaving after
1122 * uninitializing the the libshare
1125 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1126 "'%s' cannot be set to invalid "
1127 "options"), propname);
1128 (void) zfs_error(hdl, EZFS_BADPROP,
1130 zfs_uninit_libshare(hdl);
1133 zfs_uninit_libshare(hdl);
1137 case ZFS_PROP_UTF8ONLY:
1138 chosen_utf = (int)intval;
1140 case ZFS_PROP_NORMALIZE:
1141 chosen_normal = (int)intval;
1146 * For changes to existing volumes, we have some additional
1147 * checks to enforce.
1149 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1150 uint64_t volsize = zfs_prop_get_int(zhp,
1152 uint64_t blocksize = zfs_prop_get_int(zhp,
1153 ZFS_PROP_VOLBLOCKSIZE);
1157 case ZFS_PROP_RESERVATION:
1158 case ZFS_PROP_REFRESERVATION:
1159 if (intval > volsize) {
1160 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1161 "'%s' is greater than current "
1162 "volume size"), propname);
1163 (void) zfs_error(hdl, EZFS_BADPROP,
1169 case ZFS_PROP_VOLSIZE:
1170 if (intval % blocksize != 0) {
1171 zfs_nicenum(blocksize, buf,
1173 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1174 "'%s' must be a multiple of "
1175 "volume block size (%s)"),
1177 (void) zfs_error(hdl, EZFS_BADPROP,
1183 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1184 "'%s' cannot be zero"),
1186 (void) zfs_error(hdl, EZFS_BADPROP,
1196 * If normalization was chosen, but no UTF8 choice was made,
1197 * enforce rejection of non-UTF8 names.
1199 * If normalization was chosen, but rejecting non-UTF8 names
1200 * was explicitly not chosen, it is an error.
1202 if (chosen_normal > 0 && chosen_utf < 0) {
1203 if (nvlist_add_uint64(ret,
1204 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1205 (void) no_memory(hdl);
1208 } else if (chosen_normal > 0 && chosen_utf == 0) {
1209 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1210 "'%s' must be set 'on' if normalization chosen"),
1211 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1212 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1217 * If this is an existing volume, and someone is setting the volsize,
1218 * make sure that it matches the reservation, or add it if necessary.
1220 if (zhp != NULL && type == ZFS_TYPE_VOLUME &&
1221 nvlist_lookup_uint64(ret, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1223 uint64_t old_volsize = zfs_prop_get_int(zhp,
1225 uint64_t old_reservation;
1226 uint64_t new_reservation;
1227 zfs_prop_t resv_prop;
1229 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1231 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1233 if (old_volsize == old_reservation &&
1234 nvlist_lookup_uint64(ret, zfs_prop_to_name(resv_prop),
1235 &new_reservation) != 0) {
1236 if (nvlist_add_uint64(ret,
1237 zfs_prop_to_name(resv_prop), intval) != 0) {
1238 (void) no_memory(hdl);
1251 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1258 * For quotas and reservations, ENOSPC indicates
1259 * something different; setting a quota or reservation
1260 * doesn't use any disk space.
1263 case ZFS_PROP_QUOTA:
1264 case ZFS_PROP_REFQUOTA:
1265 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1266 "size is less than current used or "
1268 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1271 case ZFS_PROP_RESERVATION:
1272 case ZFS_PROP_REFRESERVATION:
1273 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1274 "size is greater than available space"));
1275 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1279 (void) zfs_standard_error(hdl, err, errbuf);
1285 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1289 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1293 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1294 "pool and or dataset must be upgraded to set this "
1295 "property or value"));
1296 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1300 if (prop == ZFS_PROP_COMPRESSION) {
1301 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1302 "property setting is not allowed on "
1303 "bootable datasets"));
1304 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1306 (void) zfs_standard_error(hdl, err, errbuf);
1311 if (prop == ZPROP_INVAL) {
1312 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1314 (void) zfs_standard_error(hdl, err, errbuf);
1320 * This platform can't address a volume this big.
1323 if (prop == ZFS_PROP_VOLSIZE) {
1324 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1330 (void) zfs_standard_error(hdl, err, errbuf);
1335 * Given a property name and value, set the property for the given dataset.
1338 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1340 zfs_cmd_t zc = { 0 };
1342 prop_changelist_t *cl = NULL;
1344 libzfs_handle_t *hdl = zhp->zfs_hdl;
1345 nvlist_t *nvl = NULL, *realprops;
1347 boolean_t do_prefix;
1350 (void) snprintf(errbuf, sizeof (errbuf),
1351 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1354 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1355 nvlist_add_string(nvl, propname, propval) != 0) {
1356 (void) no_memory(hdl);
1360 if ((realprops = zfs_valid_proplist(hdl, zhp->zfs_type, nvl,
1361 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, errbuf)) == NULL)
1367 prop = zfs_name_to_prop(propname);
1369 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1372 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1373 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1374 "child dataset with inherited mountpoint is used "
1375 "in a non-global zone"));
1376 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1381 * If the dataset's canmount property is being set to noauto,
1382 * then we want to prevent unmounting & remounting it.
1384 do_prefix = !((prop == ZFS_PROP_CANMOUNT) &&
1385 (zprop_string_to_index(prop, propval, &idx,
1386 ZFS_TYPE_DATASET) == 0) && (idx == ZFS_CANMOUNT_NOAUTO));
1388 if (do_prefix && (ret = changelist_prefix(cl)) != 0)
1392 * Execute the corresponding ioctl() to set this property.
1394 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1396 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1399 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1402 zfs_setprop_error(hdl, prop, errno, errbuf);
1405 ret = changelist_postfix(cl);
1408 * Refresh the statistics so the new property value
1412 (void) get_stats(zhp);
1417 zcmd_free_nvlists(&zc);
1419 changelist_free(cl);
1424 * Given a property, inherit the value from the parent dataset, or if received
1425 * is TRUE, revert to the received value, if any.
1428 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1430 zfs_cmd_t zc = { 0 };
1432 prop_changelist_t *cl;
1433 libzfs_handle_t *hdl = zhp->zfs_hdl;
1437 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1438 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1440 zc.zc_cookie = received;
1441 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1443 * For user properties, the amount of work we have to do is very
1444 * small, so just do it here.
1446 if (!zfs_prop_user(propname)) {
1447 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1448 "invalid property"));
1449 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1452 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1453 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1455 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1456 return (zfs_standard_error(hdl, errno, errbuf));
1462 * Verify that this property is inheritable.
1464 if (zfs_prop_readonly(prop))
1465 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1467 if (!zfs_prop_inheritable(prop) && !received)
1468 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1471 * Check to see if the value applies to this type
1473 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1474 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1477 * Normalize the name, to get rid of shorthand abbrevations.
1479 propname = zfs_prop_to_name(prop);
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 (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1484 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1485 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1486 "dataset is used in a non-global zone"));
1487 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1491 * Determine datasets which will be affected by this change, if any.
1493 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1496 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1497 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1498 "child dataset with inherited mountpoint is used "
1499 "in a non-global zone"));
1500 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1504 if ((ret = changelist_prefix(cl)) != 0)
1507 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1508 return (zfs_standard_error(hdl, errno, errbuf));
1511 if ((ret = changelist_postfix(cl)) != 0)
1515 * Refresh the statistics so the new property is reflected.
1517 (void) get_stats(zhp);
1521 changelist_free(cl);
1526 * True DSL properties are stored in an nvlist. The following two functions
1527 * extract them appropriately.
1530 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1536 if (nvlist_lookup_nvlist(zhp->zfs_props,
1537 zfs_prop_to_name(prop), &nv) == 0) {
1538 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1539 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1541 verify(!zhp->zfs_props_table ||
1542 zhp->zfs_props_table[prop] == B_TRUE);
1543 value = zfs_prop_default_numeric(prop);
1551 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1557 if (nvlist_lookup_nvlist(zhp->zfs_props,
1558 zfs_prop_to_name(prop), &nv) == 0) {
1559 verify(nvlist_lookup_string(nv, ZPROP_VALUE, &value) == 0);
1560 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1562 verify(!zhp->zfs_props_table ||
1563 zhp->zfs_props_table[prop] == B_TRUE);
1564 if ((value = (char *)zfs_prop_default_string(prop)) == NULL)
1573 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
1575 return (zhp->zfs_props == zhp->zfs_recvd_props);
1579 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1581 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
1582 zhp->zfs_props = zhp->zfs_recvd_props;
1586 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1588 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
1593 * Internal function for getting a numeric property. Both zfs_prop_get() and
1594 * zfs_prop_get_int() are built using this interface.
1596 * Certain properties can be overridden using 'mount -o'. In this case, scan
1597 * the contents of the /etc/mnttab entry, searching for the appropriate options.
1598 * If they differ from the on-disk values, report the current values and mark
1599 * the source "temporary".
1602 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
1603 char **source, uint64_t *val)
1605 zfs_cmd_t zc = { 0 };
1606 nvlist_t *zplprops = NULL;
1608 char *mntopt_on = NULL;
1609 char *mntopt_off = NULL;
1610 boolean_t received = zfs_is_recvd_props_mode(zhp);
1615 case ZFS_PROP_ATIME:
1616 mntopt_on = MNTOPT_ATIME;
1617 mntopt_off = MNTOPT_NOATIME;
1620 case ZFS_PROP_DEVICES:
1621 mntopt_on = MNTOPT_DEVICES;
1622 mntopt_off = MNTOPT_NODEVICES;
1626 mntopt_on = MNTOPT_EXEC;
1627 mntopt_off = MNTOPT_NOEXEC;
1630 case ZFS_PROP_READONLY:
1631 mntopt_on = MNTOPT_RO;
1632 mntopt_off = MNTOPT_RW;
1635 case ZFS_PROP_SETUID:
1636 mntopt_on = MNTOPT_SETUID;
1637 mntopt_off = MNTOPT_NOSETUID;
1640 case ZFS_PROP_XATTR:
1641 mntopt_on = MNTOPT_XATTR;
1642 mntopt_off = MNTOPT_NOXATTR;
1645 case ZFS_PROP_NBMAND:
1646 mntopt_on = MNTOPT_NBMAND;
1647 mntopt_off = MNTOPT_NONBMAND;
1652 * Because looking up the mount options is potentially expensive
1653 * (iterating over all of /etc/mnttab), we defer its calculation until
1654 * we're looking up a property which requires its presence.
1656 if (!zhp->zfs_mntcheck &&
1657 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
1658 libzfs_handle_t *hdl = zhp->zfs_hdl;
1659 struct mnttab entry;
1661 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
1662 zhp->zfs_mntopts = zfs_strdup(hdl,
1664 if (zhp->zfs_mntopts == NULL)
1668 zhp->zfs_mntcheck = B_TRUE;
1671 if (zhp->zfs_mntopts == NULL)
1672 mnt.mnt_mntopts = "";
1674 mnt.mnt_mntopts = zhp->zfs_mntopts;
1677 case ZFS_PROP_ATIME:
1678 case ZFS_PROP_DEVICES:
1680 case ZFS_PROP_READONLY:
1681 case ZFS_PROP_SETUID:
1682 case ZFS_PROP_XATTR:
1683 case ZFS_PROP_NBMAND:
1684 *val = getprop_uint64(zhp, prop, source);
1689 if (hasmntopt(&mnt, mntopt_on) && !*val) {
1692 *src = ZPROP_SRC_TEMPORARY;
1693 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
1696 *src = ZPROP_SRC_TEMPORARY;
1700 case ZFS_PROP_CANMOUNT:
1701 case ZFS_PROP_VOLSIZE:
1702 case ZFS_PROP_QUOTA:
1703 case ZFS_PROP_REFQUOTA:
1704 case ZFS_PROP_RESERVATION:
1705 case ZFS_PROP_REFRESERVATION:
1706 *val = getprop_uint64(zhp, prop, source);
1708 if (*source == NULL) {
1709 /* not default, must be local */
1710 *source = zhp->zfs_name;
1714 case ZFS_PROP_MOUNTED:
1715 *val = (zhp->zfs_mntopts != NULL);
1718 case ZFS_PROP_NUMCLONES:
1719 *val = zhp->zfs_dmustats.dds_num_clones;
1722 case ZFS_PROP_VERSION:
1723 case ZFS_PROP_NORMALIZE:
1724 case ZFS_PROP_UTF8ONLY:
1726 if (!zfs_prop_valid_for_type(prop, zhp->zfs_head_type) ||
1727 zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
1729 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1730 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
1731 zcmd_free_nvlists(&zc);
1734 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
1735 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
1737 zcmd_free_nvlists(&zc);
1741 nvlist_free(zplprops);
1742 zcmd_free_nvlists(&zc);
1746 switch (zfs_prop_get_type(prop)) {
1747 case PROP_TYPE_NUMBER:
1748 case PROP_TYPE_INDEX:
1749 *val = getprop_uint64(zhp, prop, source);
1751 * If we tried to use a default value for a
1752 * readonly property, it means that it was not
1755 if (zfs_prop_readonly(prop) &&
1756 *source != NULL && (*source)[0] == '\0') {
1761 case PROP_TYPE_STRING:
1763 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
1764 "cannot get non-numeric property"));
1765 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
1766 dgettext(TEXT_DOMAIN, "internal error")));
1774 * Calculate the source type, given the raw source string.
1777 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
1778 char *statbuf, size_t statlen)
1780 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
1783 if (source == NULL) {
1784 *srctype = ZPROP_SRC_NONE;
1785 } else if (source[0] == '\0') {
1786 *srctype = ZPROP_SRC_DEFAULT;
1787 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
1788 *srctype = ZPROP_SRC_RECEIVED;
1790 if (strcmp(source, zhp->zfs_name) == 0) {
1791 *srctype = ZPROP_SRC_LOCAL;
1793 (void) strlcpy(statbuf, source, statlen);
1794 *srctype = ZPROP_SRC_INHERITED;
1801 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
1802 size_t proplen, boolean_t literal)
1807 if (zhp->zfs_recvd_props == NULL)
1808 if (get_recvd_props_ioctl(zhp) != 0)
1811 prop = zfs_name_to_prop(propname);
1813 if (prop != ZPROP_INVAL) {
1815 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
1817 zfs_set_recvd_props_mode(zhp, &cookie);
1818 err = zfs_prop_get(zhp, prop, propbuf, proplen,
1819 NULL, NULL, 0, literal);
1820 zfs_unset_recvd_props_mode(zhp, &cookie);
1821 } else if (zfs_prop_userquota(propname)) {
1826 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
1827 propname, &propval) != 0)
1829 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
1831 (void) strlcpy(propbuf, recvdval, proplen);
1834 return (err == 0 ? 0 : -1);
1838 * Retrieve a property from the given object. If 'literal' is specified, then
1839 * numbers are left as exact values. Otherwise, numbers are converted to a
1840 * human-readable form.
1842 * Returns 0 on success, or -1 on error.
1845 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
1846 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
1848 char *source = NULL;
1852 boolean_t received = zfs_is_recvd_props_mode(zhp);
1855 * Check to see if this property applies to our object
1857 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1860 if (received && zfs_prop_readonly(prop))
1864 *src = ZPROP_SRC_NONE;
1867 case ZFS_PROP_CREATION:
1869 * 'creation' is a time_t stored in the statistics. We convert
1870 * this into a string unless 'literal' is specified.
1873 val = getprop_uint64(zhp, prop, &source);
1874 time_t time = (time_t)val;
1878 localtime_r(&time, &t) == NULL ||
1879 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
1881 (void) snprintf(propbuf, proplen, "%llu", val);
1885 case ZFS_PROP_MOUNTPOINT:
1887 * Getting the precise mountpoint can be tricky.
1889 * - for 'none' or 'legacy', return those values.
1890 * - for inherited mountpoints, we want to take everything
1891 * after our ancestor and append it to the inherited value.
1893 * If the pool has an alternate root, we want to prepend that
1894 * root to any values we return.
1897 str = getprop_string(zhp, prop, &source);
1899 if (str[0] == '/') {
1900 char buf[MAXPATHLEN];
1902 const char *relpath;
1905 * If we inherit the mountpoint, even from a dataset
1906 * with a received value, the source will be the path of
1907 * the dataset we inherit from. If source is
1908 * ZPROP_SOURCE_VAL_RECVD, the received value is not
1911 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
1914 relpath = zhp->zfs_name + strlen(source);
1915 if (relpath[0] == '/')
1919 if ((zpool_get_prop(zhp->zpool_hdl,
1920 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL)) ||
1921 (strcmp(root, "-") == 0))
1924 * Special case an alternate root of '/'. This will
1925 * avoid having multiple leading slashes in the
1928 if (strcmp(root, "/") == 0)
1932 * If the mountpoint is '/' then skip over this
1933 * if we are obtaining either an alternate root or
1934 * an inherited mountpoint.
1936 if (str[1] == '\0' && (root[0] != '\0' ||
1937 relpath[0] != '\0'))
1940 if (relpath[0] == '\0')
1941 (void) snprintf(propbuf, proplen, "%s%s",
1944 (void) snprintf(propbuf, proplen, "%s%s%s%s",
1945 root, str, relpath[0] == '@' ? "" : "/",
1948 /* 'legacy' or 'none' */
1949 (void) strlcpy(propbuf, str, proplen);
1954 case ZFS_PROP_ORIGIN:
1955 (void) strlcpy(propbuf, getprop_string(zhp, prop, &source),
1958 * If there is no parent at all, return failure to indicate that
1959 * it doesn't apply to this dataset.
1961 if (propbuf[0] == '\0')
1965 case ZFS_PROP_QUOTA:
1966 case ZFS_PROP_REFQUOTA:
1967 case ZFS_PROP_RESERVATION:
1968 case ZFS_PROP_REFRESERVATION:
1970 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
1974 * If quota or reservation is 0, we translate this into 'none'
1975 * (unless literal is set), and indicate that it's the default
1976 * value. Otherwise, we print the number nicely and indicate
1977 * that its set locally.
1981 (void) strlcpy(propbuf, "0", proplen);
1983 (void) strlcpy(propbuf, "none", proplen);
1986 (void) snprintf(propbuf, proplen, "%llu",
1989 zfs_nicenum(val, propbuf, proplen);
1993 case ZFS_PROP_COMPRESSRATIO:
1994 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
1996 (void) snprintf(propbuf, proplen, "%llu.%02llux",
1997 (u_longlong_t)(val / 100),
1998 (u_longlong_t)(val % 100));
2002 switch (zhp->zfs_type) {
2003 case ZFS_TYPE_FILESYSTEM:
2006 case ZFS_TYPE_VOLUME:
2009 case ZFS_TYPE_SNAPSHOT:
2015 (void) snprintf(propbuf, proplen, "%s", str);
2018 case ZFS_PROP_MOUNTED:
2020 * The 'mounted' property is a pseudo-property that described
2021 * whether the filesystem is currently mounted. Even though
2022 * it's a boolean value, the typical values of "on" and "off"
2023 * don't make sense, so we translate to "yes" and "no".
2025 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2026 src, &source, &val) != 0)
2029 (void) strlcpy(propbuf, "yes", proplen);
2031 (void) strlcpy(propbuf, "no", proplen);
2036 * The 'name' property is a pseudo-property derived from the
2037 * dataset name. It is presented as a real property to simplify
2040 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2043 case ZFS_PROP_MLSLABEL:
2045 m_label_t *new_sl = NULL;
2046 char *ascii = NULL; /* human readable label */
2048 (void) strlcpy(propbuf,
2049 getprop_string(zhp, prop, &source), proplen);
2051 if (literal || (strcasecmp(propbuf,
2052 ZFS_MLSLABEL_DEFAULT) == 0))
2056 * Try to translate the internal hex string to
2057 * human-readable output. If there are any
2058 * problems just use the hex string.
2061 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2062 L_NO_CORRECTION, NULL) == -1) {
2063 m_label_free(new_sl);
2067 if (label_to_str(new_sl, &ascii, M_LABEL,
2071 m_label_free(new_sl);
2074 m_label_free(new_sl);
2076 (void) strlcpy(propbuf, ascii, proplen);
2082 switch (zfs_prop_get_type(prop)) {
2083 case PROP_TYPE_NUMBER:
2084 if (get_numeric_property(zhp, prop, src,
2085 &source, &val) != 0)
2088 (void) snprintf(propbuf, proplen, "%llu",
2091 zfs_nicenum(val, propbuf, proplen);
2094 case PROP_TYPE_STRING:
2095 (void) strlcpy(propbuf,
2096 getprop_string(zhp, prop, &source), proplen);
2099 case PROP_TYPE_INDEX:
2100 if (get_numeric_property(zhp, prop, src,
2101 &source, &val) != 0)
2103 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2105 (void) strlcpy(propbuf, strval, proplen);
2113 get_source(zhp, src, source, statbuf, statlen);
2119 * Utility function to get the given numeric property. Does no validation that
2120 * the given property is the appropriate type; should only be used with
2121 * hard-coded property types.
2124 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2129 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2135 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2139 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2140 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2144 * Similar to zfs_prop_get(), but returns the value as an integer.
2147 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2148 zprop_source_t *src, char *statbuf, size_t statlen)
2153 * Check to see if this property applies to our object
2155 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) {
2156 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2157 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2158 zfs_prop_to_name(prop)));
2162 *src = ZPROP_SRC_NONE;
2164 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2167 get_source(zhp, src, source, statbuf, statlen);
2173 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2174 char **domainp, idmap_rid_t *ridp)
2176 idmap_handle_t *idmap_hdl = NULL;
2177 idmap_get_handle_t *get_hdl = NULL;
2181 if (idmap_init(&idmap_hdl) != IDMAP_SUCCESS)
2183 if (idmap_get_create(idmap_hdl, &get_hdl) != IDMAP_SUCCESS)
2187 err = idmap_get_sidbyuid(get_hdl, id,
2188 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2190 err = idmap_get_sidbygid(get_hdl, id,
2191 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2193 if (err == IDMAP_SUCCESS &&
2194 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2195 status == IDMAP_SUCCESS)
2201 idmap_get_destroy(get_hdl);
2203 (void) idmap_fini(idmap_hdl);
2208 * convert the propname into parameters needed by kernel
2209 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2210 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2213 userquota_propname_decode(const char *propname, boolean_t zoned,
2214 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2216 zfs_userquota_prop_t type;
2218 char *numericsid = NULL;
2223 /* Figure out the property type ({user|group}{quota|space}) */
2224 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2225 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2226 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2229 if (type == ZFS_NUM_USERQUOTA_PROPS)
2233 isuser = (type == ZFS_PROP_USERQUOTA ||
2234 type == ZFS_PROP_USERUSED);
2236 cp = strchr(propname, '@') + 1;
2238 if (strchr(cp, '@')) {
2240 * It's a SID name (eg "user@domain") that needs to be
2241 * turned into S-1-domainID-RID.
2243 directory_error_t e;
2244 if (zoned && getzoneid() == GLOBAL_ZONEID)
2247 e = directory_sid_from_user_name(NULL,
2250 e = directory_sid_from_group_name(NULL,
2254 directory_error_free(e);
2257 if (numericsid == NULL)
2260 /* will be further decoded below */
2263 if (strncmp(cp, "S-1-", 4) == 0) {
2264 /* It's a numeric SID (eg "S-1-234-567-89") */
2265 (void) strlcpy(domain, cp, domainlen);
2266 cp = strrchr(domain, '-');
2271 *ridp = strtoull(cp, &end, 10);
2276 if (errno != 0 || *end != '\0')
2278 } else if (!isdigit(*cp)) {
2280 * It's a user/group name (eg "user") that needs to be
2281 * turned into a uid/gid
2283 if (zoned && getzoneid() == GLOBAL_ZONEID)
2299 /* It's a user/group ID (eg "12345"). */
2300 uid_t id = strtoul(cp, &end, 10);
2307 /* It's an ephemeral ID. */
2308 if (idmap_id_to_numeric_domain_rid(id, isuser,
2309 &mapdomain, &rid) != 0)
2311 (void) strlcpy(domain, mapdomain, domainlen);
2318 ASSERT3P(numericsid, ==, NULL);
2323 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2324 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2327 zfs_cmd_t zc = { 0 };
2329 (void) strncpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2331 err = userquota_propname_decode(propname,
2332 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2333 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2334 zc.zc_objset_type = *typep;
2338 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2342 *propvalue = zc.zc_cookie;
2347 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2348 uint64_t *propvalue)
2350 zfs_userquota_prop_t type;
2352 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
2357 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
2358 char *propbuf, int proplen, boolean_t literal)
2362 zfs_userquota_prop_t type;
2364 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
2371 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2372 } else if (propvalue == 0 &&
2373 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
2374 (void) strlcpy(propbuf, "none", proplen);
2376 zfs_nicenum(propvalue, propbuf, proplen);
2382 * Returns the name of the given zfs handle.
2385 zfs_get_name(const zfs_handle_t *zhp)
2387 return (zhp->zfs_name);
2391 * Returns the type of the given zfs handle.
2394 zfs_get_type(const zfs_handle_t *zhp)
2396 return (zhp->zfs_type);
2400 zfs_do_list_ioctl(zfs_handle_t *zhp, int arg, zfs_cmd_t *zc)
2403 uint64_t orig_cookie;
2405 orig_cookie = zc->zc_cookie;
2407 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
2408 rc = ioctl(zhp->zfs_hdl->libzfs_fd, arg, zc);
2413 /* expand nvlist memory and try again */
2414 if (zcmd_expand_dst_nvlist(zhp->zfs_hdl, zc) != 0) {
2415 zcmd_free_nvlists(zc);
2418 zc->zc_cookie = orig_cookie;
2421 * An errno value of ESRCH indicates normal completion.
2422 * If ENOENT is returned, then the underlying dataset
2423 * has been removed since we obtained the handle.
2430 rc = zfs_standard_error(zhp->zfs_hdl, errno,
2431 dgettext(TEXT_DOMAIN,
2432 "cannot iterate filesystems"));
2440 * Iterate over all child filesystems
2443 zfs_iter_filesystems(zfs_handle_t *zhp, zfs_iter_f func, void *data)
2445 zfs_cmd_t zc = { 0 };
2449 if (zhp->zfs_type != ZFS_TYPE_FILESYSTEM)
2452 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2455 while ((ret = zfs_do_list_ioctl(zhp, ZFS_IOC_DATASET_LIST_NEXT,
2458 * Silently ignore errors, as the only plausible explanation is
2459 * that the pool has since been removed.
2461 if ((nzhp = make_dataset_handle_zc(zhp->zfs_hdl,
2466 if ((ret = func(nzhp, data)) != 0) {
2467 zcmd_free_nvlists(&zc);
2471 zcmd_free_nvlists(&zc);
2472 return ((ret < 0) ? ret : 0);
2476 * Iterate over all snapshots
2479 zfs_iter_snapshots(zfs_handle_t *zhp, zfs_iter_f func, void *data)
2481 zfs_cmd_t zc = { 0 };
2485 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT)
2488 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2490 while ((ret = zfs_do_list_ioctl(zhp, ZFS_IOC_SNAPSHOT_LIST_NEXT,
2493 if ((nzhp = make_dataset_handle_zc(zhp->zfs_hdl,
2498 if ((ret = func(nzhp, data)) != 0) {
2499 zcmd_free_nvlists(&zc);
2503 zcmd_free_nvlists(&zc);
2504 return ((ret < 0) ? ret : 0);
2508 * Iterate over all children, snapshots and filesystems
2511 zfs_iter_children(zfs_handle_t *zhp, zfs_iter_f func, void *data)
2515 if ((ret = zfs_iter_filesystems(zhp, func, data)) != 0)
2518 return (zfs_iter_snapshots(zhp, func, data));
2522 * Is one dataset name a child dataset of another?
2524 * Needs to handle these cases:
2525 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2526 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2527 * Descendant? No. No. No. Yes.
2530 is_descendant(const char *ds1, const char *ds2)
2532 size_t d1len = strlen(ds1);
2534 /* ds2 can't be a descendant if it's smaller */
2535 if (strlen(ds2) < d1len)
2538 /* otherwise, compare strings and verify that there's a '/' char */
2539 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
2543 * Given a complete name, return just the portion that refers to the parent.
2544 * Can return NULL if this is a pool.
2547 parent_name(const char *path, char *buf, size_t buflen)
2551 if ((loc = strrchr(path, '/')) == NULL)
2554 (void) strncpy(buf, path, MIN(buflen, loc - path));
2555 buf[loc - path] = '\0';
2561 * If accept_ancestor is false, then check to make sure that the given path has
2562 * a parent, and that it exists. If accept_ancestor is true, then find the
2563 * closest existing ancestor for the given path. In prefixlen return the
2564 * length of already existing prefix of the given path. We also fetch the
2565 * 'zoned' property, which is used to validate property settings when creating
2569 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
2570 boolean_t accept_ancestor, int *prefixlen)
2572 zfs_cmd_t zc = { 0 };
2573 char parent[ZFS_MAXNAMELEN];
2579 (void) snprintf(errbuf, sizeof (errbuf),
2580 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
2582 /* get parent, and check to see if this is just a pool */
2583 if (parent_name(path, parent, sizeof (parent)) != 0) {
2584 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2585 "missing dataset name"));
2586 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
2589 /* check to see if the pool exists */
2590 if ((slash = strchr(parent, '/')) == NULL)
2591 slash = parent + strlen(parent);
2592 (void) strncpy(zc.zc_name, parent, slash - parent);
2593 zc.zc_name[slash - parent] = '\0';
2594 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
2596 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2597 "no such pool '%s'"), zc.zc_name);
2598 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2601 /* check to see if the parent dataset exists */
2602 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
2603 if (errno == ENOENT && accept_ancestor) {
2605 * Go deeper to find an ancestor, give up on top level.
2607 if (parent_name(parent, parent, sizeof (parent)) != 0) {
2608 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2609 "no such pool '%s'"), zc.zc_name);
2610 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2612 } else if (errno == ENOENT) {
2613 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2614 "parent does not exist"));
2615 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2617 return (zfs_standard_error(hdl, errno, errbuf));
2620 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
2624 /* we are in a non-global zone, but parent is in the global zone */
2625 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
2626 (void) zfs_standard_error(hdl, EPERM, errbuf);
2631 /* make sure parent is a filesystem */
2632 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
2633 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2634 "parent is not a filesystem"));
2635 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
2641 if (prefixlen != NULL)
2642 *prefixlen = strlen(parent);
2647 * Finds whether the dataset of the given type(s) exists.
2650 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
2654 if (!zfs_validate_name(hdl, path, types, B_FALSE))
2658 * Try to get stats for the dataset, which will tell us if it exists.
2660 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
2661 int ds_type = zhp->zfs_type;
2664 if (types & ds_type)
2671 * Given a path to 'target', create all the ancestors between
2672 * the prefixlen portion of the path, and the target itself.
2673 * Fail if the initial prefixlen-ancestor does not already exist.
2676 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
2682 /* make sure prefix exists */
2683 cp = target + prefixlen;
2685 assert(strchr(cp, '/') == NULL);
2686 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2689 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2697 * Attempt to create, mount, and share any ancestor filesystems,
2698 * up to the prefixlen-long one.
2700 for (cp = target + prefixlen + 1;
2701 cp = strchr(cp, '/'); *cp = '/', cp++) {
2706 h = make_dataset_handle(hdl, target);
2708 /* it already exists, nothing to do here */
2713 logstr = hdl->libzfs_log_str;
2714 hdl->libzfs_log_str = NULL;
2715 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
2717 hdl->libzfs_log_str = logstr;
2718 opname = dgettext(TEXT_DOMAIN, "create");
2722 hdl->libzfs_log_str = logstr;
2723 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2725 opname = dgettext(TEXT_DOMAIN, "open");
2729 if (zfs_mount(h, NULL, 0) != 0) {
2730 opname = dgettext(TEXT_DOMAIN, "mount");
2734 if (zfs_share(h) != 0) {
2735 opname = dgettext(TEXT_DOMAIN, "share");
2745 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2746 "failed to %s ancestor '%s'"), opname, target);
2751 * Creates non-existing ancestors of the given path.
2754 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
2760 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
2763 if ((path_copy = strdup(path)) != NULL) {
2764 rc = create_parents(hdl, path_copy, prefix);
2767 if (path_copy == NULL || rc != 0)
2774 * Create a new filesystem or volume.
2777 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
2780 zfs_cmd_t zc = { 0 };
2783 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
2787 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
2788 "cannot create '%s'"), path);
2790 /* validate the path, taking care to note the extended error message */
2791 if (!zfs_validate_name(hdl, path, type, B_TRUE))
2792 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
2794 /* validate parents exist */
2795 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
2799 * The failure modes when creating a dataset of a different type over
2800 * one that already exists is a little strange. In particular, if you
2801 * try to create a dataset on top of an existing dataset, the ioctl()
2802 * will return ENOENT, not EEXIST. To prevent this from happening, we
2803 * first try to see if the dataset exists.
2805 (void) strlcpy(zc.zc_name, path, sizeof (zc.zc_name));
2806 if (zfs_dataset_exists(hdl, zc.zc_name, ZFS_TYPE_DATASET)) {
2807 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2808 "dataset already exists"));
2809 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
2812 if (type == ZFS_TYPE_VOLUME)
2813 zc.zc_objset_type = DMU_OST_ZVOL;
2815 zc.zc_objset_type = DMU_OST_ZFS;
2817 if (props && (props = zfs_valid_proplist(hdl, type, props,
2818 zoned, NULL, errbuf)) == 0)
2821 if (type == ZFS_TYPE_VOLUME) {
2823 * If we are creating a volume, the size and block size must
2824 * satisfy a few restraints. First, the blocksize must be a
2825 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
2826 * volsize must be a multiple of the block size, and cannot be
2829 if (props == NULL || nvlist_lookup_uint64(props,
2830 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
2832 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2833 "missing volume size"));
2834 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
2837 if ((ret = nvlist_lookup_uint64(props,
2838 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
2839 &blocksize)) != 0) {
2840 if (ret == ENOENT) {
2841 blocksize = zfs_prop_default_numeric(
2842 ZFS_PROP_VOLBLOCKSIZE);
2845 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2846 "missing volume block size"));
2847 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
2853 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2854 "volume size cannot be zero"));
2855 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
2858 if (size % blocksize != 0) {
2860 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2861 "volume size must be a multiple of volume block "
2863 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
2867 if (props && zcmd_write_src_nvlist(hdl, &zc, props) != 0)
2871 /* create the dataset */
2872 ret = zfs_ioctl(hdl, ZFS_IOC_CREATE, &zc);
2874 zcmd_free_nvlists(&zc);
2876 /* check for failure */
2878 char parent[ZFS_MAXNAMELEN];
2879 (void) parent_name(path, parent, sizeof (parent));
2883 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2884 "no such parent '%s'"), parent);
2885 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2888 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2889 "parent '%s' is not a filesystem"), parent);
2890 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
2893 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2894 "volume block size must be power of 2 from "
2896 (uint_t)SPA_MINBLOCKSIZE,
2897 (uint_t)SPA_MAXBLOCKSIZE >> 10);
2899 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
2902 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2903 "pool must be upgraded to set this "
2904 "property or value"));
2905 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
2909 * This platform can't address a volume this big.
2911 if (type == ZFS_TYPE_VOLUME)
2912 return (zfs_error(hdl, EZFS_VOLTOOBIG,
2917 return (zfs_standard_error(hdl, errno, errbuf));
2925 * Destroys the given dataset. The caller must make sure that the filesystem
2926 * isn't mounted, and that there are no active dependents.
2929 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
2931 zfs_cmd_t zc = { 0 };
2933 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2935 if (ZFS_IS_VOLUME(zhp)) {
2936 zc.zc_objset_type = DMU_OST_ZVOL;
2938 zc.zc_objset_type = DMU_OST_ZFS;
2941 zc.zc_defer_destroy = defer;
2942 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0) {
2943 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
2944 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
2948 remove_mountpoint(zhp);
2953 struct destroydata {
2960 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
2962 struct destroydata *dd = arg;
2964 char name[ZFS_MAXNAMELEN];
2965 boolean_t closezhp = dd->closezhp;
2968 (void) strlcpy(name, zhp->zfs_name, sizeof (name));
2969 (void) strlcat(name, "@", sizeof (name));
2970 (void) strlcat(name, dd->snapname, sizeof (name));
2972 szhp = make_dataset_handle(zhp->zfs_hdl, name);
2974 dd->gotone = B_TRUE;
2978 dd->closezhp = B_TRUE;
2980 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, arg);
2987 * Destroys all snapshots with the given name in zhp & descendants.
2990 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
2992 zfs_cmd_t zc = { 0 };
2994 struct destroydata dd = { 0 };
2996 dd.snapname = snapname;
2997 (void) zfs_check_snap_cb(zhp, &dd);
3000 return (zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3001 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3002 zhp->zfs_name, snapname));
3005 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3006 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
3007 zc.zc_defer_destroy = defer;
3009 ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY_SNAPS, &zc);
3013 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3014 "cannot destroy '%s@%s'"), zc.zc_name, snapname);
3018 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3019 "snapshot is cloned"));
3020 return (zfs_error(zhp->zfs_hdl, EZFS_EXISTS, errbuf));
3023 return (zfs_standard_error(zhp->zfs_hdl, errno,
3032 * Clones the given dataset. The target must be of the same type as the source.
3035 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3037 zfs_cmd_t zc = { 0 };
3038 char parent[ZFS_MAXNAMELEN];
3041 libzfs_handle_t *hdl = zhp->zfs_hdl;
3045 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3047 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3048 "cannot create '%s'"), target);
3050 /* validate the target name */
3051 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3052 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3054 /* validate parents exist */
3055 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3058 (void) parent_name(target, parent, sizeof (parent));
3061 if (ZFS_IS_VOLUME(zhp)) {
3062 zc.zc_objset_type = DMU_OST_ZVOL;
3063 type = ZFS_TYPE_VOLUME;
3065 zc.zc_objset_type = DMU_OST_ZFS;
3066 type = ZFS_TYPE_FILESYSTEM;
3070 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3071 zhp, errbuf)) == NULL)
3074 if (zcmd_write_src_nvlist(hdl, &zc, props) != 0) {
3082 (void) strlcpy(zc.zc_name, target, sizeof (zc.zc_name));
3083 (void) strlcpy(zc.zc_value, zhp->zfs_name, sizeof (zc.zc_value));
3084 ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_CREATE, &zc);
3086 zcmd_free_nvlists(&zc);
3093 * The parent doesn't exist. We should have caught this
3094 * above, but there may a race condition that has since
3095 * destroyed the parent.
3097 * At this point, we don't know whether it's the source
3098 * that doesn't exist anymore, or whether the target
3099 * dataset doesn't exist.
3101 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3102 "no such parent '%s'"), parent);
3103 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3106 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3107 "source and target pools differ"));
3108 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3112 return (zfs_standard_error(zhp->zfs_hdl, errno,
3121 * Promotes the given clone fs to be the clone parent.
3124 zfs_promote(zfs_handle_t *zhp)
3126 libzfs_handle_t *hdl = zhp->zfs_hdl;
3127 zfs_cmd_t zc = { 0 };
3128 char parent[MAXPATHLEN];
3132 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3133 "cannot promote '%s'"), zhp->zfs_name);
3135 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3136 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3137 "snapshots can not be promoted"));
3138 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3141 (void) strlcpy(parent, zhp->zfs_dmustats.dds_origin, sizeof (parent));
3142 if (parent[0] == '\0') {
3143 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3144 "not a cloned filesystem"));
3145 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3148 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_origin,
3149 sizeof (zc.zc_value));
3150 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3151 ret = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc);
3154 int save_errno = errno;
3156 switch (save_errno) {
3158 /* There is a conflicting snapshot name. */
3159 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3160 "conflicting snapshot '%s' from parent '%s'"),
3161 zc.zc_string, parent);
3162 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3165 return (zfs_standard_error(hdl, save_errno, errbuf));
3172 * Takes a snapshot of the given dataset.
3175 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3179 char parent[ZFS_MAXNAMELEN];
3181 zfs_cmd_t zc = { 0 };
3185 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3186 "cannot snapshot '%s'"), path);
3188 /* validate the target name */
3189 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3190 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3193 if ((props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3194 props, B_FALSE, NULL, errbuf)) == NULL)
3197 if (zcmd_write_src_nvlist(hdl, &zc, props) != 0) {
3205 /* make sure the parent exists and is of the appropriate type */
3206 delim = strchr(path, '@');
3207 (void) strncpy(parent, path, delim - path);
3208 parent[delim - path] = '\0';
3210 if ((zhp = zfs_open(hdl, parent, ZFS_TYPE_FILESYSTEM |
3211 ZFS_TYPE_VOLUME)) == NULL) {
3212 zcmd_free_nvlists(&zc);
3216 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3217 (void) strlcpy(zc.zc_value, delim+1, sizeof (zc.zc_value));
3218 if (ZFS_IS_VOLUME(zhp))
3219 zc.zc_objset_type = DMU_OST_ZVOL;
3221 zc.zc_objset_type = DMU_OST_ZFS;
3222 zc.zc_cookie = recursive;
3223 ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_SNAPSHOT, &zc);
3225 zcmd_free_nvlists(&zc);
3228 * if it was recursive, the one that actually failed will be in
3232 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3233 "cannot create snapshot '%s@%s'"), zc.zc_name, zc.zc_value);
3234 (void) zfs_standard_error(hdl, errno, errbuf);
3243 * Destroy any more recent snapshots. We invoke this callback on any dependents
3244 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3245 * is a dependent and we should just destroy it without checking the transaction
3248 typedef struct rollback_data {
3249 const char *cb_target; /* the snapshot */
3250 uint64_t cb_create; /* creation time reference */
3252 boolean_t cb_dependent;
3257 rollback_destroy(zfs_handle_t *zhp, void *data)
3259 rollback_data_t *cbp = data;
3261 if (!cbp->cb_dependent) {
3262 if (strcmp(zhp->zfs_name, cbp->cb_target) != 0 &&
3263 zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT &&
3264 zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) >
3268 cbp->cb_dependent = B_TRUE;
3269 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3270 rollback_destroy, cbp);
3271 cbp->cb_dependent = B_FALSE;
3273 logstr = zhp->zfs_hdl->libzfs_log_str;
3274 zhp->zfs_hdl->libzfs_log_str = NULL;
3275 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3276 zhp->zfs_hdl->libzfs_log_str = logstr;
3279 /* We must destroy this clone; first unmount it */
3280 prop_changelist_t *clp;
3282 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3283 cbp->cb_force ? MS_FORCE: 0);
3284 if (clp == NULL || changelist_prefix(clp) != 0) {
3285 cbp->cb_error = B_TRUE;
3289 if (zfs_destroy(zhp, B_FALSE) != 0)
3290 cbp->cb_error = B_TRUE;
3292 changelist_remove(clp, zhp->zfs_name);
3293 (void) changelist_postfix(clp);
3294 changelist_free(clp);
3302 * Given a dataset, rollback to a specific snapshot, discarding any
3303 * data changes since then and making it the active dataset.
3305 * Any snapshots more recent than the target are destroyed, along with
3309 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3311 rollback_data_t cb = { 0 };
3313 zfs_cmd_t zc = { 0 };
3314 boolean_t restore_resv = 0;
3315 uint64_t old_volsize, new_volsize;
3316 zfs_prop_t resv_prop;
3318 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3319 zhp->zfs_type == ZFS_TYPE_VOLUME);
3322 * Destroy all recent snapshots and its dependends.
3324 cb.cb_force = force;
3325 cb.cb_target = snap->zfs_name;
3326 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3327 (void) zfs_iter_children(zhp, rollback_destroy, &cb);
3333 * Now that we have verified that the snapshot is the latest,
3334 * rollback to the given snapshot.
3337 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
3338 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
3340 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3342 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
3345 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3347 if (ZFS_IS_VOLUME(zhp))
3348 zc.zc_objset_type = DMU_OST_ZVOL;
3350 zc.zc_objset_type = DMU_OST_ZFS;
3353 * We rely on zfs_iter_children() to verify that there are no
3354 * newer snapshots for the given dataset. Therefore, we can
3355 * simply pass the name on to the ioctl() call. There is still
3356 * an unlikely race condition where the user has taken a
3357 * snapshot since we verified that this was the most recent.
3360 if ((err = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_ROLLBACK, &zc)) != 0) {
3361 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3362 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
3368 * For volumes, if the pre-rollback volsize matched the pre-
3369 * rollback reservation and the volsize has changed then set
3370 * the reservation property to the post-rollback volsize.
3371 * Make a new handle since the rollback closed the dataset.
3373 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
3374 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
3376 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3377 if (old_volsize != new_volsize)
3378 err = zfs_prop_set_int(zhp, resv_prop,
3387 * Iterate over all dependents for a given dataset. This includes both
3388 * hierarchical dependents (children) and data dependents (snapshots and
3389 * clones). The bulk of the processing occurs in get_dependents() in
3393 zfs_iter_dependents(zfs_handle_t *zhp, boolean_t allowrecursion,
3394 zfs_iter_f func, void *data)
3399 zfs_handle_t *child;
3402 if (get_dependents(zhp->zfs_hdl, allowrecursion, zhp->zfs_name,
3403 &dependents, &count) != 0)
3406 for (i = 0; i < count; i++) {
3407 if ((child = make_dataset_handle(zhp->zfs_hdl,
3408 dependents[i])) == NULL)
3411 if ((ret = func(child, data)) != 0)
3415 for (i = 0; i < count; i++)
3416 free(dependents[i]);
3423 * Renames the given dataset.
3426 zfs_rename(zfs_handle_t *zhp, const char *target, boolean_t recursive)
3429 zfs_cmd_t zc = { 0 };
3431 prop_changelist_t *cl = NULL;
3432 zfs_handle_t *zhrp = NULL;
3433 char *parentname = NULL;
3434 char parent[ZFS_MAXNAMELEN];
3435 libzfs_handle_t *hdl = zhp->zfs_hdl;
3438 /* if we have the same exact name, just return success */
3439 if (strcmp(zhp->zfs_name, target) == 0)
3442 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3443 "cannot rename to '%s'"), target);
3446 * Make sure the target name is valid
3448 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3449 if ((strchr(target, '@') == NULL) ||
3452 * Snapshot target name is abbreviated,
3453 * reconstruct full dataset name
3455 (void) strlcpy(parent, zhp->zfs_name,
3457 delim = strchr(parent, '@');
3458 if (strchr(target, '@') == NULL)
3462 (void) strlcat(parent, target, sizeof (parent));
3466 * Make sure we're renaming within the same dataset.
3468 delim = strchr(target, '@');
3469 if (strncmp(zhp->zfs_name, target, delim - target)
3470 != 0 || zhp->zfs_name[delim - target] != '@') {
3471 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3472 "snapshots must be part of same "
3474 return (zfs_error(hdl, EZFS_CROSSTARGET,
3478 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3479 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3482 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3483 "recursive rename must be a snapshot"));
3484 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3487 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3488 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3490 /* validate parents */
3491 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
3494 /* make sure we're in the same pool */
3495 verify((delim = strchr(target, '/')) != NULL);
3496 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
3497 zhp->zfs_name[delim - target] != '/') {
3498 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3499 "datasets must be within same pool"));
3500 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
3503 /* new name cannot be a child of the current dataset name */
3504 if (is_descendant(zhp->zfs_name, target)) {
3505 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3506 "New dataset name cannot be a descendant of "
3507 "current dataset name"));
3508 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3512 (void) snprintf(errbuf, sizeof (errbuf),
3513 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
3515 if (getzoneid() == GLOBAL_ZONEID &&
3516 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
3517 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3518 "dataset is used in a non-global zone"));
3519 return (zfs_error(hdl, EZFS_ZONED, errbuf));
3524 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
3525 if (parentname == NULL) {
3529 delim = strchr(parentname, '@');
3531 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
3538 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0, 0)) == NULL)
3541 if (changelist_haszonedchild(cl)) {
3542 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3543 "child dataset with inherited mountpoint is used "
3544 "in a non-global zone"));
3545 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
3549 if ((ret = changelist_prefix(cl)) != 0)
3553 if (ZFS_IS_VOLUME(zhp))
3554 zc.zc_objset_type = DMU_OST_ZVOL;
3556 zc.zc_objset_type = DMU_OST_ZFS;
3558 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3559 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
3561 zc.zc_cookie = recursive;
3563 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
3565 * if it was recursive, the one that actually failed will
3568 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3569 "cannot rename '%s'"), zc.zc_name);
3571 if (recursive && errno == EEXIST) {
3572 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3573 "a child dataset already has a snapshot "
3574 "with the new name"));
3575 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3577 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
3581 * On failure, we still want to remount any filesystems that
3582 * were previously mounted, so we don't alter the system state.
3585 (void) changelist_postfix(cl);
3588 changelist_rename(cl, zfs_get_name(zhp), target);
3589 ret = changelist_postfix(cl);
3601 changelist_free(cl);
3607 zfs_get_user_props(zfs_handle_t *zhp)
3609 return (zhp->zfs_user_props);
3613 zfs_get_recvd_props(zfs_handle_t *zhp)
3615 if (zhp->zfs_recvd_props == NULL)
3616 if (get_recvd_props_ioctl(zhp) != 0)
3618 return (zhp->zfs_recvd_props);
3622 * This function is used by 'zfs list' to determine the exact set of columns to
3623 * display, and their maximum widths. This does two main things:
3625 * - If this is a list of all properties, then expand the list to include
3626 * all native properties, and set a flag so that for each dataset we look
3627 * for new unique user properties and add them to the list.
3629 * - For non fixed-width properties, keep track of the maximum width seen
3630 * so that we can size the column appropriately. If the user has
3631 * requested received property values, we also need to compute the width
3632 * of the RECEIVED column.
3635 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received)
3637 libzfs_handle_t *hdl = zhp->zfs_hdl;
3638 zprop_list_t *entry;
3639 zprop_list_t **last, **start;
3640 nvlist_t *userprops, *propval;
3643 char buf[ZFS_MAXPROPLEN];
3645 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
3648 userprops = zfs_get_user_props(zhp);
3651 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
3653 * Go through and add any user properties as necessary. We
3654 * start by incrementing our list pointer to the first
3655 * non-native property.
3658 while (*start != NULL) {
3659 if ((*start)->pl_prop == ZPROP_INVAL)
3661 start = &(*start)->pl_next;
3665 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
3667 * See if we've already found this property in our list.
3669 for (last = start; *last != NULL;
3670 last = &(*last)->pl_next) {
3671 if (strcmp((*last)->pl_user_prop,
3672 nvpair_name(elem)) == 0)
3676 if (*last == NULL) {
3677 if ((entry = zfs_alloc(hdl,
3678 sizeof (zprop_list_t))) == NULL ||
3679 ((entry->pl_user_prop = zfs_strdup(hdl,
3680 nvpair_name(elem)))) == NULL) {
3685 entry->pl_prop = ZPROP_INVAL;
3686 entry->pl_width = strlen(nvpair_name(elem));
3687 entry->pl_all = B_TRUE;
3694 * Now go through and check the width of any non-fixed columns
3696 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
3697 if (entry->pl_fixed)
3700 if (entry->pl_prop != ZPROP_INVAL) {
3701 if (zfs_prop_get(zhp, entry->pl_prop,
3702 buf, sizeof (buf), NULL, NULL, 0, B_FALSE) == 0) {
3703 if (strlen(buf) > entry->pl_width)
3704 entry->pl_width = strlen(buf);
3706 if (received && zfs_prop_get_recvd(zhp,
3707 zfs_prop_to_name(entry->pl_prop),
3708 buf, sizeof (buf), B_FALSE) == 0)
3709 if (strlen(buf) > entry->pl_recvd_width)
3710 entry->pl_recvd_width = strlen(buf);
3712 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
3714 verify(nvlist_lookup_string(propval,
3715 ZPROP_VALUE, &strval) == 0);
3716 if (strlen(strval) > entry->pl_width)
3717 entry->pl_width = strlen(strval);
3719 if (received && zfs_prop_get_recvd(zhp,
3720 entry->pl_user_prop,
3721 buf, sizeof (buf), B_FALSE) == 0)
3722 if (strlen(buf) > entry->pl_recvd_width)
3723 entry->pl_recvd_width = strlen(buf);
3731 zfs_deleg_share_nfs(libzfs_handle_t *hdl, char *dataset, char *path,
3732 char *resource, void *export, void *sharetab,
3733 int sharemax, zfs_share_op_t operation)
3735 zfs_cmd_t zc = { 0 };
3738 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
3739 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
3741 (void) strlcpy(zc.zc_string, resource, sizeof (zc.zc_string));
3742 zc.zc_share.z_sharedata = (uint64_t)(uintptr_t)sharetab;
3743 zc.zc_share.z_exportdata = (uint64_t)(uintptr_t)export;
3744 zc.zc_share.z_sharetype = operation;
3745 zc.zc_share.z_sharemax = sharemax;
3746 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SHARE, &zc);
3751 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
3756 * Keep a reference to the props-table against which we prune the
3759 zhp->zfs_props_table = props;
3761 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
3764 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
3765 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
3768 * User properties will result in ZPROP_INVAL, and since we
3769 * only know how to prune standard ZFS properties, we always
3770 * leave these in the list. This can also happen if we
3771 * encounter an unknown DSL property (when running older
3772 * software, for example).
3774 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
3775 (void) nvlist_remove(zhp->zfs_props,
3776 nvpair_name(curr), nvpair_type(curr));
3782 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
3783 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
3785 zfs_cmd_t zc = { 0 };
3786 nvlist_t *nvlist = NULL;
3789 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
3790 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
3791 zc.zc_cookie = (uint64_t)cmd;
3793 if (cmd == ZFS_SMB_ACL_RENAME) {
3794 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
3795 (void) no_memory(hdl);
3801 case ZFS_SMB_ACL_ADD:
3802 case ZFS_SMB_ACL_REMOVE:
3803 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
3805 case ZFS_SMB_ACL_RENAME:
3806 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
3808 (void) no_memory(hdl);
3811 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
3813 (void) no_memory(hdl);
3816 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
3817 nvlist_free(nvlist);
3821 case ZFS_SMB_ACL_PURGE:
3826 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
3828 nvlist_free(nvlist);
3833 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
3834 char *path, char *resource)
3836 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
3841 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
3842 char *path, char *resource)
3844 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
3849 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
3851 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
3856 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
3857 char *oldname, char *newname)
3859 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
3864 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
3865 zfs_userspace_cb_t func, void *arg)
3867 zfs_cmd_t zc = { 0 };
3869 zfs_useracct_t buf[100];
3871 (void) strncpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3873 zc.zc_objset_type = type;
3874 zc.zc_nvlist_dst = (uintptr_t)buf;
3878 zfs_useracct_t *zua = buf;
3880 zc.zc_nvlist_dst_size = sizeof (buf);
3881 error = ioctl(zhp->zfs_hdl->libzfs_fd,
3882 ZFS_IOC_USERSPACE_MANY, &zc);
3883 if (error || zc.zc_nvlist_dst_size == 0)
3886 while (zc.zc_nvlist_dst_size > 0) {
3887 error = func(arg, zua->zu_domain, zua->zu_rid,
3892 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
3900 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
3901 boolean_t recursive, boolean_t temphold, boolean_t enoent_ok)
3903 zfs_cmd_t zc = { 0 };
3904 libzfs_handle_t *hdl = zhp->zfs_hdl;
3906 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3907 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
3908 if (strlcpy(zc.zc_string, tag, sizeof (zc.zc_string))
3909 >= sizeof (zc.zc_string))
3910 return (zfs_error(hdl, EZFS_TAGTOOLONG, tag));
3911 zc.zc_cookie = recursive;
3912 zc.zc_temphold = temphold;
3914 if (zfs_ioctl(hdl, ZFS_IOC_HOLD, &zc) != 0) {
3915 char errbuf[ZFS_MAXNAMELEN+32];
3918 * if it was recursive, the one that actually failed will be in
3921 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3922 "cannot hold '%s@%s'"), zc.zc_name, snapname);
3926 * Temporary tags wind up having the ds object id
3927 * prepended. So even if we passed the length check
3928 * above, it's still possible for the tag to wind
3929 * up being slightly too long.
3931 return (zfs_error(hdl, EZFS_TAGTOOLONG, errbuf));
3933 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3934 "pool must be upgraded"));
3935 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3937 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3939 return (zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf));
3945 return (zfs_standard_error_fmt(hdl, errno, errbuf));
3952 struct hold_range_arg {
3953 zfs_handle_t *origin;
3954 const char *fromsnap;
3956 char lastsnapheld[ZFS_MAXNAMELEN];
3962 boolean_t recursive;
3963 snapfilter_cb_t *filter_cb;
3964 void *filter_cb_arg;
3968 zfs_hold_range_one(zfs_handle_t *zhp, void *arg)
3970 struct hold_range_arg *hra = arg;
3971 const char *thissnap;
3974 thissnap = strchr(zfs_get_name(zhp), '@') + 1;
3976 if (hra->fromsnap && !hra->seenfrom &&
3977 strcmp(hra->fromsnap, thissnap) == 0)
3978 hra->seenfrom = B_TRUE;
3980 /* snap is older or newer than the desired range, ignore it */
3981 if (hra->seento || !hra->seenfrom) {
3986 if (!hra->seento && strcmp(hra->tosnap, thissnap) == 0)
3987 hra->seento = B_TRUE;
3989 if (hra->filter_cb != NULL &&
3990 hra->filter_cb(zhp, hra->filter_cb_arg) == B_FALSE) {
3996 /* We could be racing with destroy, so ignore ENOENT. */
3997 error = zfs_hold(hra->origin, thissnap, hra->tag,
3998 hra->recursive, hra->temphold, B_TRUE);
4000 (void) strlcpy(hra->lastsnapheld, zfs_get_name(zhp),
4001 sizeof (hra->lastsnapheld));
4004 error = zfs_release(hra->origin, thissnap, hra->tag,
4013 * Add a user hold on the set of snapshots starting with fromsnap up to
4014 * and including tosnap. If we're unable to to acquire a particular hold,
4015 * undo any holds up to that point.
4018 zfs_hold_range(zfs_handle_t *zhp, const char *fromsnap, const char *tosnap,
4019 const char *tag, boolean_t recursive, boolean_t temphold,
4020 snapfilter_cb_t filter_cb, void *cbarg)
4022 struct hold_range_arg arg = { 0 };
4026 arg.fromsnap = fromsnap;
4027 arg.tosnap = tosnap;
4029 arg.temphold = temphold;
4030 arg.holding = B_TRUE;
4031 arg.recursive = recursive;
4032 arg.seenfrom = (fromsnap == NULL);
4033 arg.filter_cb = filter_cb;
4034 arg.filter_cb_arg = cbarg;
4036 error = zfs_iter_snapshots_sorted(zhp, zfs_hold_range_one, &arg);
4039 * Make sure we either hold the entire range or none.
4041 if (error && arg.lastsnapheld[0] != '\0') {
4042 (void) zfs_release_range(zhp, fromsnap,
4043 (const char *)arg.lastsnapheld, tag, recursive);
4049 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4050 boolean_t recursive)
4052 zfs_cmd_t zc = { 0 };
4053 libzfs_handle_t *hdl = zhp->zfs_hdl;
4055 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4056 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
4057 if (strlcpy(zc.zc_string, tag, sizeof (zc.zc_string))
4058 >= sizeof (zc.zc_string))
4059 return (zfs_error(hdl, EZFS_TAGTOOLONG, tag));
4060 zc.zc_cookie = recursive;
4062 if (zfs_ioctl(hdl, ZFS_IOC_RELEASE, &zc) != 0) {
4063 char errbuf[ZFS_MAXNAMELEN+32];
4066 * if it was recursive, the one that actually failed will be in
4069 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4070 "cannot release '%s' from '%s@%s'"), tag, zc.zc_name,
4074 return (zfs_error(hdl, EZFS_REFTAG_RELE, errbuf));
4076 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4077 "pool must be upgraded"));
4078 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
4080 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4082 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4090 * Release a user hold from the set of snapshots starting with fromsnap
4091 * up to and including tosnap.
4094 zfs_release_range(zfs_handle_t *zhp, const char *fromsnap, const char *tosnap,
4095 const char *tag, boolean_t recursive)
4097 struct hold_range_arg arg = { 0 };
4100 arg.fromsnap = fromsnap;
4101 arg.tosnap = tosnap;
4103 arg.recursive = recursive;
4104 arg.seenfrom = (fromsnap == NULL);
4106 return (zfs_iter_snapshots_sorted(zhp, zfs_hold_range_one, &arg));
4110 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4113 uint64_t nblocks, volblocksize;
4117 if (nvlist_lookup_string(props,
4118 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4119 ncopies = atoi(strval);
4122 if (nvlist_lookup_uint64(props,
4123 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4124 &volblocksize) != 0)
4125 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4126 nblocks = volsize/volblocksize;
4127 /* start with metadnode L0-L6 */
4129 /* calculate number of indirects */
4130 while (nblocks > 1) {
4131 nblocks += DNODES_PER_LEVEL - 1;
4132 nblocks /= DNODES_PER_LEVEL;
4135 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4138 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4139 * compressed, but in practice they compress down to about
4142 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;