4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
25 * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
26 * Copyright (c) 2012 DEY Storage Systems, Inc. All rights reserved.
27 * Copyright (c) 2011-2012 Pawel Jakub Dawidek. All rights reserved.
28 * Copyright (c) 2013 Martin Matuska. All rights reserved.
29 * Copyright (c) 2013 Steven Hartland. All rights reserved.
30 * Copyright (c) 2014 Integros [integros.com]
31 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
32 * Copyright 2016 Nexenta Systems, Inc.
46 #include <sys/mntent.h>
47 #include <sys/mount.h>
54 #include <sys/dnode.h>
60 #include "zfs_namecheck.h"
62 #include "libzfs_impl.h"
63 #include "zfs_deleg.h"
65 static int userquota_propname_decode(const char *propname, boolean_t zoned,
66 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
69 * Given a single type (not a mask of types), return the type in a human
73 zfs_type_to_name(zfs_type_t type)
76 case ZFS_TYPE_FILESYSTEM:
77 return (dgettext(TEXT_DOMAIN, "filesystem"));
78 case ZFS_TYPE_SNAPSHOT:
79 return (dgettext(TEXT_DOMAIN, "snapshot"));
81 return (dgettext(TEXT_DOMAIN, "volume"));
83 return (dgettext(TEXT_DOMAIN, "pool"));
84 case ZFS_TYPE_BOOKMARK:
85 return (dgettext(TEXT_DOMAIN, "bookmark"));
87 assert(!"unhandled zfs_type_t");
94 * Validate a ZFS path. This is used even before trying to open the dataset, to
95 * provide a more meaningful error message. We call zfs_error_aux() to
96 * explain exactly why the name was not valid.
99 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
105 (void) zfs_prop_get_table();
106 if (dataset_namecheck(path, &why, &what) != 0) {
109 case NAME_ERR_TOOLONG:
110 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
111 "name is too long"));
114 case NAME_ERR_LEADING_SLASH:
115 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
116 "leading slash in name"));
119 case NAME_ERR_EMPTY_COMPONENT:
120 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
121 "empty component in name"));
124 case NAME_ERR_TRAILING_SLASH:
125 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
126 "trailing slash in name"));
129 case NAME_ERR_INVALCHAR:
131 dgettext(TEXT_DOMAIN, "invalid character "
132 "'%c' in name"), what);
135 case NAME_ERR_MULTIPLE_AT:
136 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
137 "multiple '@' delimiters in name"));
140 case NAME_ERR_NOLETTER:
141 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
142 "pool doesn't begin with a letter"));
145 case NAME_ERR_RESERVED:
146 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
147 "name is reserved"));
150 case NAME_ERR_DISKLIKE:
151 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
152 "reserved disk name"));
156 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
157 "(%d) not defined"), why);
165 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
167 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
168 "snapshot delimiter '@' in filesystem name"));
172 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
174 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
175 "missing '@' delimiter in snapshot name"));
179 if (modifying && strchr(path, '%') != NULL) {
181 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
182 "invalid character %c in name"), '%');
190 zfs_name_valid(const char *name, zfs_type_t type)
192 if (type == ZFS_TYPE_POOL)
193 return (zpool_name_valid(NULL, B_FALSE, name));
194 return (zfs_validate_name(NULL, name, type, B_FALSE));
198 * This function takes the raw DSL properties, and filters out the user-defined
199 * properties into a separate nvlist.
202 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
204 libzfs_handle_t *hdl = zhp->zfs_hdl;
209 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
210 (void) no_memory(hdl);
215 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
216 if (!zfs_prop_user(nvpair_name(elem)))
219 verify(nvpair_value_nvlist(elem, &propval) == 0);
220 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
222 (void) no_memory(hdl);
230 static zpool_handle_t *
231 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
233 libzfs_handle_t *hdl = zhp->zfs_hdl;
236 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
237 if (hdl->libzfs_pool_handles != NULL)
238 zph->zpool_next = hdl->libzfs_pool_handles;
239 hdl->libzfs_pool_handles = zph;
244 static zpool_handle_t *
245 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
247 libzfs_handle_t *hdl = zhp->zfs_hdl;
248 zpool_handle_t *zph = hdl->libzfs_pool_handles;
250 while ((zph != NULL) &&
251 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
252 zph = zph->zpool_next;
257 * Returns a handle to the pool that contains the provided dataset.
258 * If a handle to that pool already exists then that handle is returned.
259 * Otherwise, a new handle is created and added to the list of handles.
261 static zpool_handle_t *
262 zpool_handle(zfs_handle_t *zhp)
268 len = strcspn(zhp->zfs_name, "/@#") + 1;
269 pool_name = zfs_alloc(zhp->zfs_hdl, len);
270 (void) strlcpy(pool_name, zhp->zfs_name, len);
272 zph = zpool_find_handle(zhp, pool_name, len);
274 zph = zpool_add_handle(zhp, pool_name);
281 zpool_free_handles(libzfs_handle_t *hdl)
283 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
285 while (zph != NULL) {
286 next = zph->zpool_next;
290 hdl->libzfs_pool_handles = NULL;
294 * Utility function to gather stats (objset and zpl) for the given object.
297 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
299 libzfs_handle_t *hdl = zhp->zfs_hdl;
301 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
303 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, zc) != 0) {
304 if (errno == ENOMEM) {
305 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
316 * Utility function to get the received properties of the given object.
319 get_recvd_props_ioctl(zfs_handle_t *zhp)
321 libzfs_handle_t *hdl = zhp->zfs_hdl;
322 nvlist_t *recvdprops;
323 zfs_cmd_t zc = { 0 };
326 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
329 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
331 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
332 if (errno == ENOMEM) {
333 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
337 zcmd_free_nvlists(&zc);
342 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
343 zcmd_free_nvlists(&zc);
347 nvlist_free(zhp->zfs_recvd_props);
348 zhp->zfs_recvd_props = recvdprops;
354 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
356 nvlist_t *allprops, *userprops;
358 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
360 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
365 * XXX Why do we store the user props separately, in addition to
366 * storing them in zfs_props?
368 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
369 nvlist_free(allprops);
373 nvlist_free(zhp->zfs_props);
374 nvlist_free(zhp->zfs_user_props);
376 zhp->zfs_props = allprops;
377 zhp->zfs_user_props = userprops;
383 get_stats(zfs_handle_t *zhp)
386 zfs_cmd_t zc = { 0 };
388 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
390 if (get_stats_ioctl(zhp, &zc) != 0)
392 else if (put_stats_zhdl(zhp, &zc) != 0)
394 zcmd_free_nvlists(&zc);
399 * Refresh the properties currently stored in the handle.
402 zfs_refresh_properties(zfs_handle_t *zhp)
404 (void) get_stats(zhp);
408 * Makes a handle from the given dataset name. Used by zfs_open() and
409 * zfs_iter_* to create child handles on the fly.
412 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
414 if (put_stats_zhdl(zhp, zc) != 0)
418 * We've managed to open the dataset and gather statistics. Determine
419 * the high-level type.
421 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
422 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
423 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
424 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
428 if (zhp->zfs_dmustats.dds_is_snapshot)
429 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
430 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
431 zhp->zfs_type = ZFS_TYPE_VOLUME;
432 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
433 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
435 abort(); /* we should never see any other types */
437 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
444 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
446 zfs_cmd_t zc = { 0 };
448 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
454 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
455 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
459 if (get_stats_ioctl(zhp, &zc) == -1) {
460 zcmd_free_nvlists(&zc);
464 if (make_dataset_handle_common(zhp, &zc) == -1) {
468 zcmd_free_nvlists(&zc);
473 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
475 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
481 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
482 if (make_dataset_handle_common(zhp, zc) == -1) {
490 make_dataset_simple_handle_zc(zfs_handle_t *pzhp, zfs_cmd_t *zc)
492 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
497 zhp->zfs_hdl = pzhp->zfs_hdl;
498 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
499 zhp->zfs_head_type = pzhp->zfs_type;
500 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
501 zhp->zpool_hdl = zpool_handle(zhp);
506 zfs_handle_dup(zfs_handle_t *zhp_orig)
508 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
513 zhp->zfs_hdl = zhp_orig->zfs_hdl;
514 zhp->zpool_hdl = zhp_orig->zpool_hdl;
515 (void) strlcpy(zhp->zfs_name, zhp_orig->zfs_name,
516 sizeof (zhp->zfs_name));
517 zhp->zfs_type = zhp_orig->zfs_type;
518 zhp->zfs_head_type = zhp_orig->zfs_head_type;
519 zhp->zfs_dmustats = zhp_orig->zfs_dmustats;
520 if (zhp_orig->zfs_props != NULL) {
521 if (nvlist_dup(zhp_orig->zfs_props, &zhp->zfs_props, 0) != 0) {
522 (void) no_memory(zhp->zfs_hdl);
527 if (zhp_orig->zfs_user_props != NULL) {
528 if (nvlist_dup(zhp_orig->zfs_user_props,
529 &zhp->zfs_user_props, 0) != 0) {
530 (void) no_memory(zhp->zfs_hdl);
535 if (zhp_orig->zfs_recvd_props != NULL) {
536 if (nvlist_dup(zhp_orig->zfs_recvd_props,
537 &zhp->zfs_recvd_props, 0)) {
538 (void) no_memory(zhp->zfs_hdl);
543 zhp->zfs_mntcheck = zhp_orig->zfs_mntcheck;
544 if (zhp_orig->zfs_mntopts != NULL) {
545 zhp->zfs_mntopts = zfs_strdup(zhp_orig->zfs_hdl,
546 zhp_orig->zfs_mntopts);
548 zhp->zfs_props_table = zhp_orig->zfs_props_table;
553 zfs_bookmark_exists(const char *path)
557 char fsname[ZFS_MAX_DATASET_NAME_LEN];
564 (void) strlcpy(fsname, path, sizeof (fsname));
565 pound = strchr(fsname, '#');
570 bmark_name = pound + 1;
571 props = fnvlist_alloc();
572 err = lzc_get_bookmarks(fsname, props, &bmarks);
579 rv = nvlist_exists(bmarks, bmark_name);
585 make_bookmark_handle(zfs_handle_t *parent, const char *path,
586 nvlist_t *bmark_props)
588 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
593 /* Fill in the name. */
594 zhp->zfs_hdl = parent->zfs_hdl;
595 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
597 /* Set the property lists. */
598 if (nvlist_dup(bmark_props, &zhp->zfs_props, 0) != 0) {
604 zhp->zfs_head_type = parent->zfs_head_type;
605 zhp->zfs_type = ZFS_TYPE_BOOKMARK;
607 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL) {
608 nvlist_free(zhp->zfs_props);
617 * Opens the given snapshot, filesystem, or volume. The 'types'
618 * argument is a mask of acceptable types. The function will print an
619 * appropriate error message and return NULL if it can't be opened.
622 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
627 (void) snprintf(errbuf, sizeof (errbuf),
628 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
631 * Validate the name before we even try to open it.
633 if (!zfs_validate_name(hdl, path, ZFS_TYPE_DATASET, B_FALSE)) {
634 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
635 "invalid dataset name"));
636 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
641 * Try to get stats for the dataset, which will tell us if it exists.
644 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
645 (void) zfs_standard_error(hdl, errno, errbuf);
650 char *at = strchr(path, '@');
655 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
656 (void) zfs_standard_error(hdl, errno, errbuf);
661 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
662 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
665 if (!(types & zhp->zfs_type)) {
666 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
675 * Release a ZFS handle. Nothing to do but free the associated memory.
678 zfs_close(zfs_handle_t *zhp)
680 if (zhp->zfs_mntopts)
681 free(zhp->zfs_mntopts);
682 nvlist_free(zhp->zfs_props);
683 nvlist_free(zhp->zfs_user_props);
684 nvlist_free(zhp->zfs_recvd_props);
688 typedef struct mnttab_node {
689 struct mnttab mtn_mt;
694 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
696 const mnttab_node_t *mtn1 = arg1;
697 const mnttab_node_t *mtn2 = arg2;
700 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
704 return (rv > 0 ? 1 : -1);
708 libzfs_mnttab_init(libzfs_handle_t *hdl)
710 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
711 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
712 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
716 libzfs_mnttab_update(libzfs_handle_t *hdl)
720 rewind(hdl->libzfs_mnttab);
721 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
724 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
726 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
727 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
728 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
729 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
730 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
731 avl_add(&hdl->libzfs_mnttab_cache, mtn);
736 libzfs_mnttab_fini(libzfs_handle_t *hdl)
741 while ((mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie))
743 free(mtn->mtn_mt.mnt_special);
744 free(mtn->mtn_mt.mnt_mountp);
745 free(mtn->mtn_mt.mnt_fstype);
746 free(mtn->mtn_mt.mnt_mntopts);
749 avl_destroy(&hdl->libzfs_mnttab_cache);
753 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
755 hdl->libzfs_mnttab_enable = enable;
759 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
760 struct mnttab *entry)
765 if (!hdl->libzfs_mnttab_enable) {
766 struct mnttab srch = { 0 };
768 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
769 libzfs_mnttab_fini(hdl);
770 rewind(hdl->libzfs_mnttab);
771 srch.mnt_special = (char *)fsname;
772 srch.mnt_fstype = MNTTYPE_ZFS;
773 if (getmntany(hdl->libzfs_mnttab, entry, &srch) == 0)
779 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
780 libzfs_mnttab_update(hdl);
782 find.mtn_mt.mnt_special = (char *)fsname;
783 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
785 *entry = mtn->mtn_mt;
792 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
793 const char *mountp, const char *mntopts)
797 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
799 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
800 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
801 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
802 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
803 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
804 avl_add(&hdl->libzfs_mnttab_cache, mtn);
808 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
813 find.mtn_mt.mnt_special = (char *)fsname;
814 if ((ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL))
816 avl_remove(&hdl->libzfs_mnttab_cache, ret);
817 free(ret->mtn_mt.mnt_special);
818 free(ret->mtn_mt.mnt_mountp);
819 free(ret->mtn_mt.mnt_fstype);
820 free(ret->mtn_mt.mnt_mntopts);
826 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
828 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
830 if (zpool_handle == NULL)
833 *spa_version = zpool_get_prop_int(zpool_handle,
834 ZPOOL_PROP_VERSION, NULL);
839 * The choice of reservation property depends on the SPA version.
842 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
846 if (zfs_spa_version(zhp, &spa_version) < 0)
849 if (spa_version >= SPA_VERSION_REFRESERVATION)
850 *resv_prop = ZFS_PROP_REFRESERVATION;
852 *resv_prop = ZFS_PROP_RESERVATION;
858 * Given an nvlist of properties to set, validates that they are correct, and
859 * parses any numeric properties (index, boolean, etc) if they are specified as
863 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
864 uint64_t zoned, zfs_handle_t *zhp, zpool_handle_t *zpool_hdl,
872 int chosen_normal = -1;
875 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
876 (void) no_memory(hdl);
881 * Make sure this property is valid and applies to this type.
885 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
886 const char *propname = nvpair_name(elem);
888 prop = zfs_name_to_prop(propname);
889 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
891 * This is a user property: make sure it's a
892 * string, and that it's less than ZAP_MAXNAMELEN.
894 if (nvpair_type(elem) != DATA_TYPE_STRING) {
895 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
896 "'%s' must be a string"), propname);
897 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
901 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
902 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
903 "property name '%s' is too long"),
905 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
909 (void) nvpair_value_string(elem, &strval);
910 if (nvlist_add_string(ret, propname, strval) != 0) {
911 (void) no_memory(hdl);
918 * Currently, only user properties can be modified on
921 if (type == ZFS_TYPE_SNAPSHOT) {
922 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
923 "this property can not be modified for snapshots"));
924 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
928 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
929 zfs_userquota_prop_t uqtype;
930 char newpropname[128];
935 if (userquota_propname_decode(propname, zoned,
936 &uqtype, domain, sizeof (domain), &rid) != 0) {
938 dgettext(TEXT_DOMAIN,
939 "'%s' has an invalid user/group name"),
941 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
945 if (uqtype != ZFS_PROP_USERQUOTA &&
946 uqtype != ZFS_PROP_GROUPQUOTA) {
948 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
950 (void) zfs_error(hdl, EZFS_PROPREADONLY,
955 if (nvpair_type(elem) == DATA_TYPE_STRING) {
956 (void) nvpair_value_string(elem, &strval);
957 if (strcmp(strval, "none") == 0) {
959 } else if (zfs_nicestrtonum(hdl,
960 strval, &intval) != 0) {
961 (void) zfs_error(hdl,
962 EZFS_BADPROP, errbuf);
965 } else if (nvpair_type(elem) ==
967 (void) nvpair_value_uint64(elem, &intval);
969 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
970 "use 'none' to disable "
971 "userquota/groupquota"));
975 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
976 "'%s' must be a number"), propname);
977 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
982 * Encode the prop name as
983 * userquota@<hex-rid>-domain, to make it easy
984 * for the kernel to decode.
986 (void) snprintf(newpropname, sizeof (newpropname),
987 "%s%llx-%s", zfs_userquota_prop_prefixes[uqtype],
988 (longlong_t)rid, domain);
992 if (nvlist_add_uint64_array(ret, newpropname,
994 (void) no_memory(hdl);
998 } else if (prop == ZPROP_INVAL && zfs_prop_written(propname)) {
999 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1000 "'%s' is readonly"),
1002 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1006 if (prop == ZPROP_INVAL) {
1007 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1008 "invalid property '%s'"), propname);
1009 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1013 if (!zfs_prop_valid_for_type(prop, type)) {
1015 dgettext(TEXT_DOMAIN, "'%s' does not "
1016 "apply to datasets of this type"), propname);
1017 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
1021 if (zfs_prop_readonly(prop) &&
1022 (!zfs_prop_setonce(prop) || zhp != NULL)) {
1024 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
1026 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
1030 if (zprop_parse_value(hdl, elem, prop, type, ret,
1031 &strval, &intval, errbuf) != 0)
1035 * Perform some additional checks for specific properties.
1038 case ZFS_PROP_VERSION:
1044 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
1045 if (intval < version) {
1046 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1047 "Can not downgrade; already at version %u"),
1049 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1055 case ZFS_PROP_VOLBLOCKSIZE:
1056 case ZFS_PROP_RECORDSIZE:
1058 int maxbs = SPA_MAXBLOCKSIZE;
1059 if (zpool_hdl != NULL) {
1060 maxbs = zpool_get_prop_int(zpool_hdl,
1061 ZPOOL_PROP_MAXBLOCKSIZE, NULL);
1064 * Volumes are limited to a volblocksize of 128KB,
1065 * because they typically service workloads with
1066 * small random writes, which incur a large performance
1067 * penalty with large blocks.
1069 if (prop == ZFS_PROP_VOLBLOCKSIZE)
1070 maxbs = SPA_OLD_MAXBLOCKSIZE;
1072 * The value must be a power of two between
1073 * SPA_MINBLOCKSIZE and maxbs.
1075 if (intval < SPA_MINBLOCKSIZE ||
1076 intval > maxbs || !ISP2(intval)) {
1077 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1078 "'%s' must be power of 2 from 512B "
1079 "to %uKB"), propname, maxbs >> 10);
1080 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1085 case ZFS_PROP_MLSLABEL:
1089 * Verify the mlslabel string and convert to
1090 * internal hex label string.
1094 char *hex = NULL; /* internal label string */
1096 /* Default value is already OK. */
1097 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
1100 /* Verify the label can be converted to binary form */
1101 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
1102 (str_to_label(strval, &new_sl, MAC_LABEL,
1103 L_NO_CORRECTION, NULL) == -1)) {
1107 /* Now translate to hex internal label string */
1108 if (label_to_str(new_sl, &hex, M_INTERNAL,
1114 m_label_free(new_sl);
1116 /* If string is already in internal form, we're done. */
1117 if (strcmp(strval, hex) == 0) {
1122 /* Replace the label string with the internal form. */
1123 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
1125 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
1132 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1133 "invalid mlslabel '%s'"), strval);
1134 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1135 m_label_free(new_sl); /* OK if null */
1136 #else /* !illumos */
1137 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1138 "mlslabel is not supported on FreeBSD"));
1139 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1140 #endif /* illumos */
1145 case ZFS_PROP_MOUNTPOINT:
1147 namecheck_err_t why;
1149 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1150 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1153 if (mountpoint_namecheck(strval, &why)) {
1155 case NAME_ERR_LEADING_SLASH:
1157 dgettext(TEXT_DOMAIN,
1158 "'%s' must be an absolute path, "
1159 "'none', or 'legacy'"), propname);
1161 case NAME_ERR_TOOLONG:
1163 dgettext(TEXT_DOMAIN,
1164 "component of '%s' is too long"),
1170 dgettext(TEXT_DOMAIN,
1171 "(%d) not defined"),
1175 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1182 case ZFS_PROP_SHARESMB:
1183 case ZFS_PROP_SHARENFS:
1185 * For the mountpoint and sharenfs or sharesmb
1186 * properties, check if it can be set in a
1187 * global/non-global zone based on
1188 * the zoned property value:
1190 * global zone non-global zone
1191 * --------------------------------------------------
1192 * zoned=on mountpoint (no) mountpoint (yes)
1193 * sharenfs (no) sharenfs (no)
1194 * sharesmb (no) sharesmb (no)
1196 * zoned=off mountpoint (yes) N/A
1201 if (getzoneid() == GLOBAL_ZONEID) {
1202 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1203 "'%s' cannot be set on "
1204 "dataset in a non-global zone"),
1206 (void) zfs_error(hdl, EZFS_ZONED,
1209 } else if (prop == ZFS_PROP_SHARENFS ||
1210 prop == ZFS_PROP_SHARESMB) {
1211 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1212 "'%s' cannot be set in "
1213 "a non-global zone"), propname);
1214 (void) zfs_error(hdl, EZFS_ZONED,
1218 } else if (getzoneid() != GLOBAL_ZONEID) {
1220 * If zoned property is 'off', this must be in
1221 * a global zone. If not, something is wrong.
1223 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1224 "'%s' cannot be set while dataset "
1225 "'zoned' property is set"), propname);
1226 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1231 * At this point, it is legitimate to set the
1232 * property. Now we want to make sure that the
1233 * property value is valid if it is sharenfs.
1235 if ((prop == ZFS_PROP_SHARENFS ||
1236 prop == ZFS_PROP_SHARESMB) &&
1237 strcmp(strval, "on") != 0 &&
1238 strcmp(strval, "off") != 0) {
1239 zfs_share_proto_t proto;
1241 if (prop == ZFS_PROP_SHARESMB)
1247 * Must be an valid sharing protocol
1248 * option string so init the libshare
1249 * in order to enable the parser and
1250 * then parse the options. We use the
1251 * control API since we don't care about
1252 * the current configuration and don't
1253 * want the overhead of loading it
1254 * until we actually do something.
1257 if (zfs_init_libshare(hdl,
1258 SA_INIT_CONTROL_API) != SA_OK) {
1260 * An error occurred so we can't do
1263 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1264 "'%s' cannot be set: problem "
1265 "in share initialization"),
1267 (void) zfs_error(hdl, EZFS_BADPROP,
1272 if (zfs_parse_options(strval, proto) != SA_OK) {
1274 * There was an error in parsing so
1275 * deal with it by issuing an error
1276 * message and leaving after
1277 * uninitializing the the libshare
1280 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1281 "'%s' cannot be set to invalid "
1282 "options"), propname);
1283 (void) zfs_error(hdl, EZFS_BADPROP,
1285 zfs_uninit_libshare(hdl);
1288 zfs_uninit_libshare(hdl);
1293 case ZFS_PROP_UTF8ONLY:
1294 chosen_utf = (int)intval;
1297 case ZFS_PROP_NORMALIZE:
1298 chosen_normal = (int)intval;
1306 * For changes to existing volumes, we have some additional
1307 * checks to enforce.
1309 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1310 uint64_t volsize = zfs_prop_get_int(zhp,
1312 uint64_t blocksize = zfs_prop_get_int(zhp,
1313 ZFS_PROP_VOLBLOCKSIZE);
1317 case ZFS_PROP_RESERVATION:
1318 case ZFS_PROP_REFRESERVATION:
1319 if (intval > volsize) {
1320 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1321 "'%s' is greater than current "
1322 "volume size"), propname);
1323 (void) zfs_error(hdl, EZFS_BADPROP,
1329 case ZFS_PROP_VOLSIZE:
1330 if (intval % blocksize != 0) {
1331 zfs_nicenum(blocksize, buf,
1333 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1334 "'%s' must be a multiple of "
1335 "volume block size (%s)"),
1337 (void) zfs_error(hdl, EZFS_BADPROP,
1343 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1344 "'%s' cannot be zero"),
1346 (void) zfs_error(hdl, EZFS_BADPROP,
1359 * If normalization was chosen, but no UTF8 choice was made,
1360 * enforce rejection of non-UTF8 names.
1362 * If normalization was chosen, but rejecting non-UTF8 names
1363 * was explicitly not chosen, it is an error.
1365 if (chosen_normal > 0 && chosen_utf < 0) {
1366 if (nvlist_add_uint64(ret,
1367 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1368 (void) no_memory(hdl);
1371 } else if (chosen_normal > 0 && chosen_utf == 0) {
1372 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1373 "'%s' must be set 'on' if normalization chosen"),
1374 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1375 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1386 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1388 uint64_t old_volsize;
1389 uint64_t new_volsize;
1390 uint64_t old_reservation;
1391 uint64_t new_reservation;
1392 zfs_prop_t resv_prop;
1396 * If this is an existing volume, and someone is setting the volsize,
1397 * make sure that it matches the reservation, or add it if necessary.
1399 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1400 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1402 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1404 props = fnvlist_alloc();
1405 fnvlist_add_uint64(props, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
1406 zfs_prop_get_int(zhp, ZFS_PROP_VOLBLOCKSIZE));
1408 if ((zvol_volsize_to_reservation(old_volsize, props) !=
1409 old_reservation) || nvlist_exists(nvl,
1410 zfs_prop_to_name(resv_prop))) {
1411 fnvlist_free(props);
1414 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1415 &new_volsize) != 0) {
1416 fnvlist_free(props);
1419 new_reservation = zvol_volsize_to_reservation(new_volsize, props);
1420 fnvlist_free(props);
1422 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1423 new_reservation) != 0) {
1424 (void) no_memory(zhp->zfs_hdl);
1431 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1438 * For quotas and reservations, ENOSPC indicates
1439 * something different; setting a quota or reservation
1440 * doesn't use any disk space.
1443 case ZFS_PROP_QUOTA:
1444 case ZFS_PROP_REFQUOTA:
1445 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1446 "size is less than current used or "
1448 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1451 case ZFS_PROP_RESERVATION:
1452 case ZFS_PROP_REFRESERVATION:
1453 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1454 "size is greater than available space"));
1455 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1459 (void) zfs_standard_error(hdl, err, errbuf);
1465 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1469 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1473 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1474 "pool and or dataset must be upgraded to set this "
1475 "property or value"));
1476 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1481 if (prop == ZFS_PROP_COMPRESSION ||
1482 prop == ZFS_PROP_RECORDSIZE) {
1483 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1484 "property setting is not allowed on "
1485 "bootable datasets"));
1486 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1487 } else if (prop == ZFS_PROP_CHECKSUM ||
1488 prop == ZFS_PROP_DEDUP) {
1489 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1490 "property setting is not allowed on "
1492 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1494 (void) zfs_standard_error(hdl, err, errbuf);
1499 if (prop == ZPROP_INVAL) {
1500 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1502 (void) zfs_standard_error(hdl, err, errbuf);
1508 * This platform can't address a volume this big.
1511 if (prop == ZFS_PROP_VOLSIZE) {
1512 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1518 (void) zfs_standard_error(hdl, err, errbuf);
1523 * Given a property name and value, set the property for the given dataset.
1526 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1530 libzfs_handle_t *hdl = zhp->zfs_hdl;
1531 nvlist_t *nvl = NULL;
1533 (void) snprintf(errbuf, sizeof (errbuf),
1534 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1537 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1538 nvlist_add_string(nvl, propname, propval) != 0) {
1539 (void) no_memory(hdl);
1543 ret = zfs_prop_set_list(zhp, nvl);
1553 * Given an nvlist of property names and values, set the properties for the
1557 zfs_prop_set_list(zfs_handle_t *zhp, nvlist_t *props)
1559 zfs_cmd_t zc = { 0 };
1561 prop_changelist_t **cls = NULL;
1564 libzfs_handle_t *hdl = zhp->zfs_hdl;
1569 (void) snprintf(errbuf, sizeof (errbuf),
1570 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1573 if ((nvl = zfs_valid_proplist(hdl, zhp->zfs_type, props,
1574 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, zhp->zpool_hdl,
1579 * We have to check for any extra properties which need to be added
1580 * before computing the length of the nvlist.
1582 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1584 elem = nvlist_next_nvpair(nvl, elem)) {
1585 if (zfs_name_to_prop(nvpair_name(elem)) == ZFS_PROP_VOLSIZE &&
1586 (added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1) {
1591 * Check how many properties we're setting and allocate an array to
1592 * store changelist pointers for postfix().
1595 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1597 elem = nvlist_next_nvpair(nvl, elem))
1599 if ((cls = calloc(nvl_len, sizeof (prop_changelist_t *))) == NULL)
1603 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1605 elem = nvlist_next_nvpair(nvl, elem)) {
1607 zfs_prop_t prop = zfs_name_to_prop(nvpair_name(elem));
1609 assert(cl_idx < nvl_len);
1611 * We don't want to unmount & remount the dataset when changing
1612 * its canmount property to 'on' or 'noauto'. We only use
1613 * the changelist logic to unmount when setting canmount=off.
1615 if (prop != ZFS_PROP_CANMOUNT ||
1616 (fnvpair_value_uint64(elem) == ZFS_CANMOUNT_OFF &&
1617 zfs_is_mounted(zhp, NULL))) {
1618 cls[cl_idx] = changelist_gather(zhp, prop, 0, 0);
1619 if (cls[cl_idx] == NULL)
1623 if (prop == ZFS_PROP_MOUNTPOINT &&
1624 changelist_haszonedchild(cls[cl_idx])) {
1625 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1626 "child dataset with inherited mountpoint is used "
1627 "in a non-global zone"));
1628 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1632 /* We don't support those properties on FreeBSD. */
1634 case ZFS_PROP_DEVICES:
1635 case ZFS_PROP_ISCSIOPTIONS:
1636 case ZFS_PROP_XATTR:
1637 case ZFS_PROP_VSCAN:
1638 case ZFS_PROP_NBMAND:
1639 case ZFS_PROP_MLSLABEL:
1640 (void) snprintf(errbuf, sizeof (errbuf),
1641 "property '%s' not supported on FreeBSD",
1643 ret = zfs_error(hdl, EZFS_PERM, errbuf);
1647 if (cls[cl_idx] != NULL &&
1648 (ret = changelist_prefix(cls[cl_idx])) != 0)
1653 assert(cl_idx == nvl_len);
1656 * Execute the corresponding ioctl() to set this list of properties.
1658 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1660 if ((ret = zcmd_write_src_nvlist(hdl, &zc, nvl)) != 0 ||
1661 (ret = zcmd_alloc_dst_nvlist(hdl, &zc, 0)) != 0)
1664 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1667 /* Get the list of unset properties back and report them. */
1668 nvlist_t *errorprops = NULL;
1669 if (zcmd_read_dst_nvlist(hdl, &zc, &errorprops) != 0)
1671 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1673 elem = nvlist_next_nvpair(nvl, elem)) {
1674 zfs_prop_t prop = zfs_name_to_prop(nvpair_name(elem));
1675 zfs_setprop_error(hdl, prop, errno, errbuf);
1677 nvlist_free(errorprops);
1679 if (added_resv && errno == ENOSPC) {
1680 /* clean up the volsize property we tried to set */
1681 uint64_t old_volsize = zfs_prop_get_int(zhp,
1685 zcmd_free_nvlists(&zc);
1687 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1689 if (nvlist_add_uint64(nvl,
1690 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1693 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1695 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1698 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1699 if (cls[cl_idx] != NULL) {
1700 int clp_err = changelist_postfix(cls[cl_idx]);
1707 * Refresh the statistics so the new property value
1711 (void) get_stats(zhp);
1716 zcmd_free_nvlists(&zc);
1718 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1719 if (cls[cl_idx] != NULL)
1720 changelist_free(cls[cl_idx]);
1728 * Given a property, inherit the value from the parent dataset, or if received
1729 * is TRUE, revert to the received value, if any.
1732 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1734 zfs_cmd_t zc = { 0 };
1736 prop_changelist_t *cl;
1737 libzfs_handle_t *hdl = zhp->zfs_hdl;
1741 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1742 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1744 zc.zc_cookie = received;
1745 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1747 * For user properties, the amount of work we have to do is very
1748 * small, so just do it here.
1750 if (!zfs_prop_user(propname)) {
1751 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1752 "invalid property"));
1753 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1756 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1757 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1759 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1760 return (zfs_standard_error(hdl, errno, errbuf));
1766 * Verify that this property is inheritable.
1768 if (zfs_prop_readonly(prop))
1769 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1771 if (!zfs_prop_inheritable(prop) && !received)
1772 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1775 * Check to see if the value applies to this type
1777 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1778 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1781 * Normalize the name, to get rid of shorthand abbreviations.
1783 propname = zfs_prop_to_name(prop);
1784 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1785 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1787 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1788 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1789 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1790 "dataset is used in a non-global zone"));
1791 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1795 * Determine datasets which will be affected by this change, if any.
1797 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1800 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1801 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1802 "child dataset with inherited mountpoint is used "
1803 "in a non-global zone"));
1804 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1808 if ((ret = changelist_prefix(cl)) != 0)
1811 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1812 return (zfs_standard_error(hdl, errno, errbuf));
1815 if ((ret = changelist_postfix(cl)) != 0)
1819 * Refresh the statistics so the new property is reflected.
1821 (void) get_stats(zhp);
1825 changelist_free(cl);
1830 * True DSL properties are stored in an nvlist. The following two functions
1831 * extract them appropriately.
1834 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1840 if (nvlist_lookup_nvlist(zhp->zfs_props,
1841 zfs_prop_to_name(prop), &nv) == 0) {
1842 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1843 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1845 verify(!zhp->zfs_props_table ||
1846 zhp->zfs_props_table[prop] == B_TRUE);
1847 value = zfs_prop_default_numeric(prop);
1855 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1861 if (nvlist_lookup_nvlist(zhp->zfs_props,
1862 zfs_prop_to_name(prop), &nv) == 0) {
1863 value = fnvlist_lookup_string(nv, ZPROP_VALUE);
1864 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1866 verify(!zhp->zfs_props_table ||
1867 zhp->zfs_props_table[prop] == B_TRUE);
1868 value = zfs_prop_default_string(prop);
1876 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
1878 return (zhp->zfs_props == zhp->zfs_recvd_props);
1882 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1884 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
1885 zhp->zfs_props = zhp->zfs_recvd_props;
1889 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1891 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
1896 * Internal function for getting a numeric property. Both zfs_prop_get() and
1897 * zfs_prop_get_int() are built using this interface.
1899 * Certain properties can be overridden using 'mount -o'. In this case, scan
1900 * the contents of the /etc/mnttab entry, searching for the appropriate options.
1901 * If they differ from the on-disk values, report the current values and mark
1902 * the source "temporary".
1905 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
1906 char **source, uint64_t *val)
1908 zfs_cmd_t zc = { 0 };
1909 nvlist_t *zplprops = NULL;
1911 char *mntopt_on = NULL;
1912 char *mntopt_off = NULL;
1913 boolean_t received = zfs_is_recvd_props_mode(zhp);
1918 case ZFS_PROP_ATIME:
1919 mntopt_on = MNTOPT_ATIME;
1920 mntopt_off = MNTOPT_NOATIME;
1923 case ZFS_PROP_DEVICES:
1924 mntopt_on = MNTOPT_DEVICES;
1925 mntopt_off = MNTOPT_NODEVICES;
1929 mntopt_on = MNTOPT_EXEC;
1930 mntopt_off = MNTOPT_NOEXEC;
1933 case ZFS_PROP_READONLY:
1934 mntopt_on = MNTOPT_RO;
1935 mntopt_off = MNTOPT_RW;
1938 case ZFS_PROP_SETUID:
1939 mntopt_on = MNTOPT_SETUID;
1940 mntopt_off = MNTOPT_NOSETUID;
1943 case ZFS_PROP_XATTR:
1944 mntopt_on = MNTOPT_XATTR;
1945 mntopt_off = MNTOPT_NOXATTR;
1948 case ZFS_PROP_NBMAND:
1949 mntopt_on = MNTOPT_NBMAND;
1950 mntopt_off = MNTOPT_NONBMAND;
1958 * Because looking up the mount options is potentially expensive
1959 * (iterating over all of /etc/mnttab), we defer its calculation until
1960 * we're looking up a property which requires its presence.
1962 if (!zhp->zfs_mntcheck &&
1963 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
1964 libzfs_handle_t *hdl = zhp->zfs_hdl;
1965 struct mnttab entry;
1967 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
1968 zhp->zfs_mntopts = zfs_strdup(hdl,
1970 if (zhp->zfs_mntopts == NULL)
1974 zhp->zfs_mntcheck = B_TRUE;
1977 if (zhp->zfs_mntopts == NULL)
1978 mnt.mnt_mntopts = "";
1980 mnt.mnt_mntopts = zhp->zfs_mntopts;
1983 case ZFS_PROP_ATIME:
1984 case ZFS_PROP_DEVICES:
1986 case ZFS_PROP_READONLY:
1987 case ZFS_PROP_SETUID:
1988 case ZFS_PROP_XATTR:
1989 case ZFS_PROP_NBMAND:
1990 *val = getprop_uint64(zhp, prop, source);
1995 if (hasmntopt(&mnt, mntopt_on) && !*val) {
1998 *src = ZPROP_SRC_TEMPORARY;
1999 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
2002 *src = ZPROP_SRC_TEMPORARY;
2006 case ZFS_PROP_CANMOUNT:
2007 case ZFS_PROP_VOLSIZE:
2008 case ZFS_PROP_QUOTA:
2009 case ZFS_PROP_REFQUOTA:
2010 case ZFS_PROP_RESERVATION:
2011 case ZFS_PROP_REFRESERVATION:
2012 case ZFS_PROP_FILESYSTEM_LIMIT:
2013 case ZFS_PROP_SNAPSHOT_LIMIT:
2014 case ZFS_PROP_FILESYSTEM_COUNT:
2015 case ZFS_PROP_SNAPSHOT_COUNT:
2016 *val = getprop_uint64(zhp, prop, source);
2018 if (*source == NULL) {
2019 /* not default, must be local */
2020 *source = zhp->zfs_name;
2024 case ZFS_PROP_MOUNTED:
2025 *val = (zhp->zfs_mntopts != NULL);
2028 case ZFS_PROP_NUMCLONES:
2029 *val = zhp->zfs_dmustats.dds_num_clones;
2032 case ZFS_PROP_VERSION:
2033 case ZFS_PROP_NORMALIZE:
2034 case ZFS_PROP_UTF8ONLY:
2036 if (!zfs_prop_valid_for_type(prop, zhp->zfs_head_type) ||
2037 zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2039 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2040 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
2041 zcmd_free_nvlists(&zc);
2044 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
2045 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
2047 zcmd_free_nvlists(&zc);
2050 nvlist_free(zplprops);
2051 zcmd_free_nvlists(&zc);
2054 case ZFS_PROP_INCONSISTENT:
2055 *val = zhp->zfs_dmustats.dds_inconsistent;
2059 switch (zfs_prop_get_type(prop)) {
2060 case PROP_TYPE_NUMBER:
2061 case PROP_TYPE_INDEX:
2062 *val = getprop_uint64(zhp, prop, source);
2064 * If we tried to use a default value for a
2065 * readonly property, it means that it was not
2068 if (zfs_prop_readonly(prop) &&
2069 *source != NULL && (*source)[0] == '\0') {
2074 case PROP_TYPE_STRING:
2076 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
2077 "cannot get non-numeric property"));
2078 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
2079 dgettext(TEXT_DOMAIN, "internal error")));
2087 * Calculate the source type, given the raw source string.
2090 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
2091 char *statbuf, size_t statlen)
2093 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
2096 if (source == NULL) {
2097 *srctype = ZPROP_SRC_NONE;
2098 } else if (source[0] == '\0') {
2099 *srctype = ZPROP_SRC_DEFAULT;
2100 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
2101 *srctype = ZPROP_SRC_RECEIVED;
2103 if (strcmp(source, zhp->zfs_name) == 0) {
2104 *srctype = ZPROP_SRC_LOCAL;
2106 (void) strlcpy(statbuf, source, statlen);
2107 *srctype = ZPROP_SRC_INHERITED;
2114 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
2115 size_t proplen, boolean_t literal)
2120 if (zhp->zfs_recvd_props == NULL)
2121 if (get_recvd_props_ioctl(zhp) != 0)
2124 prop = zfs_name_to_prop(propname);
2126 if (prop != ZPROP_INVAL) {
2128 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
2130 zfs_set_recvd_props_mode(zhp, &cookie);
2131 err = zfs_prop_get(zhp, prop, propbuf, proplen,
2132 NULL, NULL, 0, literal);
2133 zfs_unset_recvd_props_mode(zhp, &cookie);
2137 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
2138 propname, &propval) != 0)
2140 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
2142 (void) strlcpy(propbuf, recvdval, proplen);
2145 return (err == 0 ? 0 : -1);
2149 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2154 value = zfs_get_clones_nvl(zhp);
2159 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
2160 pair = nvlist_next_nvpair(value, pair)) {
2161 if (propbuf[0] != '\0')
2162 (void) strlcat(propbuf, ",", proplen);
2163 (void) strlcat(propbuf, nvpair_name(pair), proplen);
2169 struct get_clones_arg {
2173 char buf[ZFS_MAX_DATASET_NAME_LEN];
2177 get_clones_cb(zfs_handle_t *zhp, void *arg)
2179 struct get_clones_arg *gca = arg;
2181 if (gca->numclones == 0) {
2186 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
2187 NULL, NULL, 0, B_TRUE) != 0)
2189 if (strcmp(gca->buf, gca->origin) == 0) {
2190 fnvlist_add_boolean(gca->value, zfs_get_name(zhp));
2195 (void) zfs_iter_children(zhp, get_clones_cb, gca);
2201 zfs_get_clones_nvl(zfs_handle_t *zhp)
2203 nvlist_t *nv, *value;
2205 if (nvlist_lookup_nvlist(zhp->zfs_props,
2206 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
2207 struct get_clones_arg gca;
2210 * if this is a snapshot, then the kernel wasn't able
2211 * to get the clones. Do it by slowly iterating.
2213 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2215 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2217 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2222 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2224 gca.origin = zhp->zfs_name;
2226 if (gca.numclones != 0) {
2228 char pool[ZFS_MAX_DATASET_NAME_LEN];
2231 /* get the pool name */
2232 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2233 (void) strsep(&cp, "/@");
2234 root = zfs_open(zhp->zfs_hdl, pool,
2235 ZFS_TYPE_FILESYSTEM);
2237 (void) get_clones_cb(root, &gca);
2240 if (gca.numclones != 0 ||
2241 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2242 nvlist_add_nvlist(zhp->zfs_props,
2243 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2250 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2251 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2254 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2260 * Retrieve a property from the given object. If 'literal' is specified, then
2261 * numbers are left as exact values. Otherwise, numbers are converted to a
2262 * human-readable form.
2264 * Returns 0 on success, or -1 on error.
2267 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2268 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2270 char *source = NULL;
2274 boolean_t received = zfs_is_recvd_props_mode(zhp);
2277 * Check to see if this property applies to our object
2279 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
2282 if (received && zfs_prop_readonly(prop))
2286 *src = ZPROP_SRC_NONE;
2289 case ZFS_PROP_CREATION:
2291 * 'creation' is a time_t stored in the statistics. We convert
2292 * this into a string unless 'literal' is specified.
2295 val = getprop_uint64(zhp, prop, &source);
2296 time_t time = (time_t)val;
2300 localtime_r(&time, &t) == NULL ||
2301 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2303 (void) snprintf(propbuf, proplen, "%llu", val);
2307 case ZFS_PROP_MOUNTPOINT:
2309 * Getting the precise mountpoint can be tricky.
2311 * - for 'none' or 'legacy', return those values.
2312 * - for inherited mountpoints, we want to take everything
2313 * after our ancestor and append it to the inherited value.
2315 * If the pool has an alternate root, we want to prepend that
2316 * root to any values we return.
2319 str = getprop_string(zhp, prop, &source);
2321 if (str[0] == '/') {
2322 char buf[MAXPATHLEN];
2324 const char *relpath;
2327 * If we inherit the mountpoint, even from a dataset
2328 * with a received value, the source will be the path of
2329 * the dataset we inherit from. If source is
2330 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2333 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2336 relpath = zhp->zfs_name + strlen(source);
2337 if (relpath[0] == '/')
2341 if ((zpool_get_prop(zhp->zpool_hdl,
2342 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2343 B_FALSE)) || (strcmp(root, "-") == 0))
2346 * Special case an alternate root of '/'. This will
2347 * avoid having multiple leading slashes in the
2350 if (strcmp(root, "/") == 0)
2354 * If the mountpoint is '/' then skip over this
2355 * if we are obtaining either an alternate root or
2356 * an inherited mountpoint.
2358 if (str[1] == '\0' && (root[0] != '\0' ||
2359 relpath[0] != '\0'))
2362 if (relpath[0] == '\0')
2363 (void) snprintf(propbuf, proplen, "%s%s",
2366 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2367 root, str, relpath[0] == '@' ? "" : "/",
2370 /* 'legacy' or 'none' */
2371 (void) strlcpy(propbuf, str, proplen);
2376 case ZFS_PROP_ORIGIN:
2377 str = getprop_string(zhp, prop, &source);
2380 (void) strlcpy(propbuf, str, proplen);
2383 case ZFS_PROP_CLONES:
2384 if (get_clones_string(zhp, propbuf, proplen) != 0)
2388 case ZFS_PROP_QUOTA:
2389 case ZFS_PROP_REFQUOTA:
2390 case ZFS_PROP_RESERVATION:
2391 case ZFS_PROP_REFRESERVATION:
2393 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2397 * If quota or reservation is 0, we translate this into 'none'
2398 * (unless literal is set), and indicate that it's the default
2399 * value. Otherwise, we print the number nicely and indicate
2400 * that its set locally.
2404 (void) strlcpy(propbuf, "0", proplen);
2406 (void) strlcpy(propbuf, "none", proplen);
2409 (void) snprintf(propbuf, proplen, "%llu",
2412 zfs_nicenum(val, propbuf, proplen);
2416 case ZFS_PROP_FILESYSTEM_LIMIT:
2417 case ZFS_PROP_SNAPSHOT_LIMIT:
2418 case ZFS_PROP_FILESYSTEM_COUNT:
2419 case ZFS_PROP_SNAPSHOT_COUNT:
2421 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2425 * If limit is UINT64_MAX, we translate this into 'none' (unless
2426 * literal is set), and indicate that it's the default value.
2427 * Otherwise, we print the number nicely and indicate that it's
2431 (void) snprintf(propbuf, proplen, "%llu",
2433 } else if (val == UINT64_MAX) {
2434 (void) strlcpy(propbuf, "none", proplen);
2436 zfs_nicenum(val, propbuf, proplen);
2440 case ZFS_PROP_REFRATIO:
2441 case ZFS_PROP_COMPRESSRATIO:
2442 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2444 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2445 (u_longlong_t)(val / 100),
2446 (u_longlong_t)(val % 100));
2450 switch (zhp->zfs_type) {
2451 case ZFS_TYPE_FILESYSTEM:
2454 case ZFS_TYPE_VOLUME:
2457 case ZFS_TYPE_SNAPSHOT:
2460 case ZFS_TYPE_BOOKMARK:
2466 (void) snprintf(propbuf, proplen, "%s", str);
2469 case ZFS_PROP_MOUNTED:
2471 * The 'mounted' property is a pseudo-property that described
2472 * whether the filesystem is currently mounted. Even though
2473 * it's a boolean value, the typical values of "on" and "off"
2474 * don't make sense, so we translate to "yes" and "no".
2476 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2477 src, &source, &val) != 0)
2480 (void) strlcpy(propbuf, "yes", proplen);
2482 (void) strlcpy(propbuf, "no", proplen);
2487 * The 'name' property is a pseudo-property derived from the
2488 * dataset name. It is presented as a real property to simplify
2491 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2494 case ZFS_PROP_MLSLABEL:
2497 m_label_t *new_sl = NULL;
2498 char *ascii = NULL; /* human readable label */
2500 (void) strlcpy(propbuf,
2501 getprop_string(zhp, prop, &source), proplen);
2503 if (literal || (strcasecmp(propbuf,
2504 ZFS_MLSLABEL_DEFAULT) == 0))
2508 * Try to translate the internal hex string to
2509 * human-readable output. If there are any
2510 * problems just use the hex string.
2513 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2514 L_NO_CORRECTION, NULL) == -1) {
2515 m_label_free(new_sl);
2519 if (label_to_str(new_sl, &ascii, M_LABEL,
2523 m_label_free(new_sl);
2526 m_label_free(new_sl);
2528 (void) strlcpy(propbuf, ascii, proplen);
2530 #else /* !illumos */
2532 #endif /* illumos */
2538 * GUIDs are stored as numbers, but they are identifiers.
2539 * We don't want them to be pretty printed, because pretty
2540 * printing mangles the ID into a truncated and useless value.
2542 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2544 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2548 switch (zfs_prop_get_type(prop)) {
2549 case PROP_TYPE_NUMBER:
2550 if (get_numeric_property(zhp, prop, src,
2551 &source, &val) != 0)
2554 (void) snprintf(propbuf, proplen, "%llu",
2557 zfs_nicenum(val, propbuf, proplen);
2560 case PROP_TYPE_STRING:
2561 str = getprop_string(zhp, prop, &source);
2564 (void) strlcpy(propbuf, str, proplen);
2567 case PROP_TYPE_INDEX:
2568 if (get_numeric_property(zhp, prop, src,
2569 &source, &val) != 0)
2571 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2573 (void) strlcpy(propbuf, strval, proplen);
2581 get_source(zhp, src, source, statbuf, statlen);
2587 * Utility function to get the given numeric property. Does no validation that
2588 * the given property is the appropriate type; should only be used with
2589 * hard-coded property types.
2592 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2597 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2603 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2607 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2608 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2612 * Similar to zfs_prop_get(), but returns the value as an integer.
2615 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2616 zprop_source_t *src, char *statbuf, size_t statlen)
2621 * Check to see if this property applies to our object
2623 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) {
2624 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2625 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2626 zfs_prop_to_name(prop)));
2630 *src = ZPROP_SRC_NONE;
2632 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2635 get_source(zhp, src, source, statbuf, statlen);
2641 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2642 char **domainp, idmap_rid_t *ridp)
2645 idmap_get_handle_t *get_hdl = NULL;
2649 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2653 err = idmap_get_sidbyuid(get_hdl, id,
2654 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2656 err = idmap_get_sidbygid(get_hdl, id,
2657 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2659 if (err == IDMAP_SUCCESS &&
2660 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2661 status == IDMAP_SUCCESS)
2667 idmap_get_destroy(get_hdl);
2669 #else /* !illumos */
2670 assert(!"invalid code path");
2671 return (EINVAL); // silence compiler warning
2672 #endif /* illumos */
2676 * convert the propname into parameters needed by kernel
2677 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2678 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2681 userquota_propname_decode(const char *propname, boolean_t zoned,
2682 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2684 zfs_userquota_prop_t type;
2686 char *numericsid = NULL;
2691 /* Figure out the property type ({user|group}{quota|space}) */
2692 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2693 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2694 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2697 if (type == ZFS_NUM_USERQUOTA_PROPS)
2701 isuser = (type == ZFS_PROP_USERQUOTA ||
2702 type == ZFS_PROP_USERUSED);
2704 cp = strchr(propname, '@') + 1;
2706 if (strchr(cp, '@')) {
2709 * It's a SID name (eg "user@domain") that needs to be
2710 * turned into S-1-domainID-RID.
2713 idmap_stat stat, map_stat;
2716 idmap_get_handle_t *gh = NULL;
2718 stat = idmap_get_create(&gh);
2719 if (stat != IDMAP_SUCCESS) {
2720 idmap_get_destroy(gh);
2723 if (zoned && getzoneid() == GLOBAL_ZONEID)
2726 stat = idmap_getuidbywinname(cp, NULL, flag, &pid);
2729 stat = idmap_get_sidbyuid(gh, pid, flag, &numericsid,
2732 stat = idmap_getgidbywinname(cp, NULL, flag, &pid);
2735 stat = idmap_get_sidbygid(gh, pid, flag, &numericsid,
2739 idmap_get_destroy(gh);
2742 stat = idmap_get_mappings(gh);
2743 idmap_get_destroy(gh);
2748 if (numericsid == NULL)
2752 /* will be further decoded below */
2753 #else /* !illumos */
2755 #endif /* illumos */
2758 if (strncmp(cp, "S-1-", 4) == 0) {
2759 /* It's a numeric SID (eg "S-1-234-567-89") */
2760 (void) strlcpy(domain, cp, domainlen);
2763 cp = strrchr(domain, '-');
2766 *ridp = strtoull(cp, &end, 10);
2774 if (errno != 0 || *end != '\0')
2776 } else if (!isdigit(*cp)) {
2778 * It's a user/group name (eg "user") that needs to be
2779 * turned into a uid/gid
2781 if (zoned && getzoneid() == GLOBAL_ZONEID)
2797 /* It's a user/group ID (eg "12345"). */
2798 uid_t id = strtoul(cp, &end, 10);
2805 /* It's an ephemeral ID. */
2806 if (idmap_id_to_numeric_domain_rid(id, isuser,
2807 &mapdomain, &rid) != 0)
2809 (void) strlcpy(domain, mapdomain, domainlen);
2816 ASSERT3P(numericsid, ==, NULL);
2821 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2822 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2825 zfs_cmd_t zc = { 0 };
2827 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2829 err = userquota_propname_decode(propname,
2830 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2831 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2832 zc.zc_objset_type = *typep;
2836 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2840 *propvalue = zc.zc_cookie;
2845 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2846 uint64_t *propvalue)
2848 zfs_userquota_prop_t type;
2850 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
2855 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
2856 char *propbuf, int proplen, boolean_t literal)
2860 zfs_userquota_prop_t type;
2862 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
2869 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2870 } else if (propvalue == 0 &&
2871 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
2872 (void) strlcpy(propbuf, "none", proplen);
2874 zfs_nicenum(propvalue, propbuf, proplen);
2880 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
2881 uint64_t *propvalue)
2884 zfs_cmd_t zc = { 0 };
2885 const char *snapname;
2887 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2889 snapname = strchr(propname, '@') + 1;
2890 if (strchr(snapname, '@')) {
2891 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
2893 /* snapname is the short name, append it to zhp's fsname */
2896 (void) strlcpy(zc.zc_value, zhp->zfs_name,
2897 sizeof (zc.zc_value));
2898 cp = strchr(zc.zc_value, '@');
2901 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
2902 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
2905 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
2909 *propvalue = zc.zc_cookie;
2914 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
2915 char *propbuf, int proplen, boolean_t literal)
2920 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
2926 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2928 zfs_nicenum(propvalue, propbuf, proplen);
2934 * Returns the name of the given zfs handle.
2937 zfs_get_name(const zfs_handle_t *zhp)
2939 return (zhp->zfs_name);
2943 * Returns the name of the parent pool for the given zfs handle.
2946 zfs_get_pool_name(const zfs_handle_t *zhp)
2948 return (zhp->zpool_hdl->zpool_name);
2952 * Returns the type of the given zfs handle.
2955 zfs_get_type(const zfs_handle_t *zhp)
2957 return (zhp->zfs_type);
2961 * Is one dataset name a child dataset of another?
2963 * Needs to handle these cases:
2964 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2965 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2966 * Descendant? No. No. No. Yes.
2969 is_descendant(const char *ds1, const char *ds2)
2971 size_t d1len = strlen(ds1);
2973 /* ds2 can't be a descendant if it's smaller */
2974 if (strlen(ds2) < d1len)
2977 /* otherwise, compare strings and verify that there's a '/' char */
2978 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
2982 * Given a complete name, return just the portion that refers to the parent.
2983 * Will return -1 if there is no parent (path is just the name of the
2987 parent_name(const char *path, char *buf, size_t buflen)
2991 (void) strlcpy(buf, path, buflen);
2993 if ((slashp = strrchr(buf, '/')) == NULL)
3001 * If accept_ancestor is false, then check to make sure that the given path has
3002 * a parent, and that it exists. If accept_ancestor is true, then find the
3003 * closest existing ancestor for the given path. In prefixlen return the
3004 * length of already existing prefix of the given path. We also fetch the
3005 * 'zoned' property, which is used to validate property settings when creating
3009 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
3010 boolean_t accept_ancestor, int *prefixlen)
3012 zfs_cmd_t zc = { 0 };
3013 char parent[ZFS_MAX_DATASET_NAME_LEN];
3019 (void) snprintf(errbuf, sizeof (errbuf),
3020 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
3022 /* get parent, and check to see if this is just a pool */
3023 if (parent_name(path, parent, sizeof (parent)) != 0) {
3024 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3025 "missing dataset name"));
3026 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3029 /* check to see if the pool exists */
3030 if ((slash = strchr(parent, '/')) == NULL)
3031 slash = parent + strlen(parent);
3032 (void) strncpy(zc.zc_name, parent, slash - parent);
3033 zc.zc_name[slash - parent] = '\0';
3034 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
3036 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3037 "no such pool '%s'"), zc.zc_name);
3038 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3041 /* check to see if the parent dataset exists */
3042 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
3043 if (errno == ENOENT && accept_ancestor) {
3045 * Go deeper to find an ancestor, give up on top level.
3047 if (parent_name(parent, parent, sizeof (parent)) != 0) {
3048 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3049 "no such pool '%s'"), zc.zc_name);
3050 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3052 } else if (errno == ENOENT) {
3053 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3054 "parent does not exist"));
3055 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3057 return (zfs_standard_error(hdl, errno, errbuf));
3060 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
3064 /* we are in a non-global zone, but parent is in the global zone */
3065 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
3066 (void) zfs_standard_error(hdl, EPERM, errbuf);
3071 /* make sure parent is a filesystem */
3072 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
3073 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3074 "parent is not a filesystem"));
3075 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
3081 if (prefixlen != NULL)
3082 *prefixlen = strlen(parent);
3087 * Finds whether the dataset of the given type(s) exists.
3090 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
3094 if (!zfs_validate_name(hdl, path, types, B_FALSE))
3098 * Try to get stats for the dataset, which will tell us if it exists.
3100 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
3101 int ds_type = zhp->zfs_type;
3104 if (types & ds_type)
3111 * Given a path to 'target', create all the ancestors between
3112 * the prefixlen portion of the path, and the target itself.
3113 * Fail if the initial prefixlen-ancestor does not already exist.
3116 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
3122 /* make sure prefix exists */
3123 cp = target + prefixlen;
3125 assert(strchr(cp, '/') == NULL);
3126 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3129 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3137 * Attempt to create, mount, and share any ancestor filesystems,
3138 * up to the prefixlen-long one.
3140 for (cp = target + prefixlen + 1;
3141 (cp = strchr(cp, '/')) != NULL; *cp = '/', cp++) {
3145 h = make_dataset_handle(hdl, target);
3147 /* it already exists, nothing to do here */
3152 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
3154 opname = dgettext(TEXT_DOMAIN, "create");
3158 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3160 opname = dgettext(TEXT_DOMAIN, "open");
3164 if (zfs_mount(h, NULL, 0) != 0) {
3165 opname = dgettext(TEXT_DOMAIN, "mount");
3169 if (zfs_share(h) != 0) {
3170 opname = dgettext(TEXT_DOMAIN, "share");
3180 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3181 "failed to %s ancestor '%s'"), opname, target);
3186 * Creates non-existing ancestors of the given path.
3189 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
3195 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
3198 if ((path_copy = strdup(path)) != NULL) {
3199 rc = create_parents(hdl, path_copy, prefix);
3202 if (path_copy == NULL || rc != 0)
3209 * Create a new filesystem or volume.
3212 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
3217 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
3220 enum lzc_dataset_type ost;
3222 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3223 "cannot create '%s'"), path);
3225 /* validate the path, taking care to note the extended error message */
3226 if (!zfs_validate_name(hdl, path, type, B_TRUE))
3227 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3229 /* validate parents exist */
3230 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
3234 * The failure modes when creating a dataset of a different type over
3235 * one that already exists is a little strange. In particular, if you
3236 * try to create a dataset on top of an existing dataset, the ioctl()
3237 * will return ENOENT, not EEXIST. To prevent this from happening, we
3238 * first try to see if the dataset exists.
3240 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
3241 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3242 "dataset already exists"));
3243 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3246 if (type == ZFS_TYPE_VOLUME)
3247 ost = LZC_DATSET_TYPE_ZVOL;
3249 ost = LZC_DATSET_TYPE_ZFS;
3251 /* open zpool handle for prop validation */
3252 char pool_path[ZFS_MAX_DATASET_NAME_LEN];
3253 (void) strlcpy(pool_path, path, sizeof (pool_path));
3255 /* truncate pool_path at first slash */
3256 char *p = strchr(pool_path, '/');
3260 zpool_handle_t *zpool_handle = zpool_open(hdl, pool_path);
3262 if (props && (props = zfs_valid_proplist(hdl, type, props,
3263 zoned, NULL, zpool_handle, errbuf)) == 0) {
3264 zpool_close(zpool_handle);
3267 zpool_close(zpool_handle);
3269 if (type == ZFS_TYPE_VOLUME) {
3271 * If we are creating a volume, the size and block size must
3272 * satisfy a few restraints. First, the blocksize must be a
3273 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3274 * volsize must be a multiple of the block size, and cannot be
3277 if (props == NULL || nvlist_lookup_uint64(props,
3278 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3280 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3281 "missing volume size"));
3282 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3285 if ((ret = nvlist_lookup_uint64(props,
3286 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3287 &blocksize)) != 0) {
3288 if (ret == ENOENT) {
3289 blocksize = zfs_prop_default_numeric(
3290 ZFS_PROP_VOLBLOCKSIZE);
3293 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3294 "missing volume block size"));
3295 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3301 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3302 "volume size cannot be zero"));
3303 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3306 if (size % blocksize != 0) {
3308 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3309 "volume size must be a multiple of volume block "
3311 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3315 /* create the dataset */
3316 ret = lzc_create(path, ost, props);
3319 /* check for failure */
3321 char parent[ZFS_MAX_DATASET_NAME_LEN];
3322 (void) parent_name(path, parent, sizeof (parent));
3326 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3327 "no such parent '%s'"), parent);
3328 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3331 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3332 "parent '%s' is not a filesystem"), parent);
3333 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3336 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3337 "pool must be upgraded to set this "
3338 "property or value"));
3339 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3343 * This platform can't address a volume this big.
3345 if (type == ZFS_TYPE_VOLUME)
3346 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3351 return (zfs_standard_error(hdl, errno, errbuf));
3359 * Destroys the given dataset. The caller must make sure that the filesystem
3360 * isn't mounted, and that there are no active dependents. If the file system
3361 * does not exist this function does nothing.
3364 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3366 zfs_cmd_t zc = { 0 };
3368 if (zhp->zfs_type == ZFS_TYPE_BOOKMARK) {
3369 nvlist_t *nv = fnvlist_alloc();
3370 fnvlist_add_boolean(nv, zhp->zfs_name);
3371 int error = lzc_destroy_bookmarks(nv, NULL);
3374 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3375 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3381 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3383 if (ZFS_IS_VOLUME(zhp)) {
3384 zc.zc_objset_type = DMU_OST_ZVOL;
3386 zc.zc_objset_type = DMU_OST_ZFS;
3389 zc.zc_defer_destroy = defer;
3390 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0 &&
3392 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3393 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3397 remove_mountpoint(zhp);
3402 struct destroydata {
3404 const char *snapname;
3408 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3410 struct destroydata *dd = arg;
3411 char name[ZFS_MAX_DATASET_NAME_LEN];
3414 (void) snprintf(name, sizeof (name),
3415 "%s@%s", zhp->zfs_name, dd->snapname);
3417 if (lzc_exists(name))
3418 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3420 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3426 * Destroys all snapshots with the given name in zhp & descendants.
3429 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3432 struct destroydata dd = { 0 };
3434 dd.snapname = snapname;
3435 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3436 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3438 if (nvlist_empty(dd.nvl)) {
3439 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3440 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3441 zhp->zfs_name, snapname);
3443 ret = zfs_destroy_snaps_nvl(zhp->zfs_hdl, dd.nvl, defer);
3445 nvlist_free(dd.nvl);
3450 * Destroys all the snapshots named in the nvlist.
3453 zfs_destroy_snaps_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, boolean_t defer)
3456 nvlist_t *errlist = NULL;
3458 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3461 nvlist_free(errlist);
3465 if (nvlist_empty(errlist)) {
3467 (void) snprintf(errbuf, sizeof (errbuf),
3468 dgettext(TEXT_DOMAIN, "cannot destroy snapshots"));
3470 ret = zfs_standard_error(hdl, ret, errbuf);
3472 for (nvpair_t *pair = nvlist_next_nvpair(errlist, NULL);
3473 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3475 (void) snprintf(errbuf, sizeof (errbuf),
3476 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3479 switch (fnvpair_value_int32(pair)) {
3482 dgettext(TEXT_DOMAIN, "snapshot is cloned"));
3483 ret = zfs_error(hdl, EZFS_EXISTS, errbuf);
3486 ret = zfs_standard_error(hdl, errno, errbuf);
3491 nvlist_free(errlist);
3496 * Clones the given dataset. The target must be of the same type as the source.
3499 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3501 char parent[ZFS_MAX_DATASET_NAME_LEN];
3504 libzfs_handle_t *hdl = zhp->zfs_hdl;
3507 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3509 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3510 "cannot create '%s'"), target);
3512 /* validate the target/clone name */
3513 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3514 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3516 /* validate parents exist */
3517 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3520 (void) parent_name(target, parent, sizeof (parent));
3526 if (ZFS_IS_VOLUME(zhp)) {
3527 type = ZFS_TYPE_VOLUME;
3529 type = ZFS_TYPE_FILESYSTEM;
3531 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3532 zhp, zhp->zpool_hdl, errbuf)) == NULL)
3536 ret = lzc_clone(target, zhp->zfs_name, props);
3544 * The parent doesn't exist. We should have caught this
3545 * above, but there may a race condition that has since
3546 * destroyed the parent.
3548 * At this point, we don't know whether it's the source
3549 * that doesn't exist anymore, or whether the target
3550 * dataset doesn't exist.
3552 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3553 "no such parent '%s'"), parent);
3554 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3557 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3558 "source and target pools differ"));
3559 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3563 return (zfs_standard_error(zhp->zfs_hdl, errno,
3572 * Promotes the given clone fs to be the clone parent.
3575 zfs_promote(zfs_handle_t *zhp)
3577 libzfs_handle_t *hdl = zhp->zfs_hdl;
3578 zfs_cmd_t zc = { 0 };
3579 char parent[MAXPATHLEN];
3583 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3584 "cannot promote '%s'"), zhp->zfs_name);
3586 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3587 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3588 "snapshots can not be promoted"));
3589 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3592 (void) strlcpy(parent, zhp->zfs_dmustats.dds_origin, sizeof (parent));
3593 if (parent[0] == '\0') {
3594 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3595 "not a cloned filesystem"));
3596 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3599 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_origin,
3600 sizeof (zc.zc_value));
3601 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3602 ret = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc);
3605 int save_errno = errno;
3607 switch (save_errno) {
3609 /* There is a conflicting snapshot name. */
3610 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3611 "conflicting snapshot '%s' from parent '%s'"),
3612 zc.zc_string, parent);
3613 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3616 return (zfs_standard_error(hdl, save_errno, errbuf));
3622 typedef struct snapdata {
3624 const char *sd_snapname;
3628 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
3630 snapdata_t *sd = arg;
3631 char name[ZFS_MAX_DATASET_NAME_LEN];
3634 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) == 0) {
3635 (void) snprintf(name, sizeof (name),
3636 "%s@%s", zfs_get_name(zhp), sd->sd_snapname);
3638 fnvlist_add_boolean(sd->sd_nvl, name);
3640 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
3648 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3652 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
3659 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3660 "cannot create snapshots "));
3663 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
3664 const char *snapname = nvpair_name(elem);
3666 /* validate the target name */
3667 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
3669 (void) snprintf(errbuf, sizeof (errbuf),
3670 dgettext(TEXT_DOMAIN,
3671 "cannot create snapshot '%s'"), snapname);
3672 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3677 * get pool handle for prop validation. assumes all snaps are in the
3678 * same pool, as does lzc_snapshot (below).
3680 char pool[ZFS_MAX_DATASET_NAME_LEN];
3681 elem = nvlist_next_nvpair(snaps, NULL);
3682 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
3683 pool[strcspn(pool, "/@")] = '\0';
3684 zpool_handle_t *zpool_hdl = zpool_open(hdl, pool);
3686 if (props != NULL &&
3687 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3688 props, B_FALSE, NULL, zpool_hdl, errbuf)) == NULL) {
3689 zpool_close(zpool_hdl);
3692 zpool_close(zpool_hdl);
3694 ret = lzc_snapshot(snaps, props, &errors);
3697 boolean_t printed = B_FALSE;
3698 for (elem = nvlist_next_nvpair(errors, NULL);
3700 elem = nvlist_next_nvpair(errors, elem)) {
3701 (void) snprintf(errbuf, sizeof (errbuf),
3702 dgettext(TEXT_DOMAIN,
3703 "cannot create snapshot '%s'"), nvpair_name(elem));
3704 (void) zfs_standard_error(hdl,
3705 fnvpair_value_int32(elem), errbuf);
3711 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3712 "multiple snapshots of same "
3714 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3718 (void) zfs_standard_error(hdl, ret, errbuf);
3724 nvlist_free(errors);
3729 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3733 snapdata_t sd = { 0 };
3734 char fsname[ZFS_MAX_DATASET_NAME_LEN];
3739 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3740 "cannot snapshot %s"), path);
3742 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3743 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3745 (void) strlcpy(fsname, path, sizeof (fsname));
3746 cp = strchr(fsname, '@');
3748 sd.sd_snapname = cp + 1;
3750 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
3751 ZFS_TYPE_VOLUME)) == NULL) {
3755 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
3757 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
3759 fnvlist_add_boolean(sd.sd_nvl, path);
3762 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
3763 nvlist_free(sd.sd_nvl);
3769 * Destroy any more recent snapshots. We invoke this callback on any dependents
3770 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3771 * is a dependent and we should just destroy it without checking the transaction
3774 typedef struct rollback_data {
3775 const char *cb_target; /* the snapshot */
3776 uint64_t cb_create; /* creation time reference */
3782 rollback_destroy_dependent(zfs_handle_t *zhp, void *data)
3784 rollback_data_t *cbp = data;
3785 prop_changelist_t *clp;
3787 /* We must destroy this clone; first unmount it */
3788 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3789 cbp->cb_force ? MS_FORCE: 0);
3790 if (clp == NULL || changelist_prefix(clp) != 0) {
3791 cbp->cb_error = B_TRUE;
3795 if (zfs_destroy(zhp, B_FALSE) != 0)
3796 cbp->cb_error = B_TRUE;
3798 changelist_remove(clp, zhp->zfs_name);
3799 (void) changelist_postfix(clp);
3800 changelist_free(clp);
3807 rollback_destroy(zfs_handle_t *zhp, void *data)
3809 rollback_data_t *cbp = data;
3811 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > cbp->cb_create) {
3812 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3813 rollback_destroy_dependent, cbp);
3815 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3823 * Given a dataset, rollback to a specific snapshot, discarding any
3824 * data changes since then and making it the active dataset.
3826 * Any snapshots and bookmarks more recent than the target are
3827 * destroyed, along with their dependents (i.e. clones).
3830 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3832 rollback_data_t cb = { 0 };
3834 boolean_t restore_resv = 0;
3835 uint64_t old_volsize = 0, new_volsize;
3836 zfs_prop_t resv_prop;
3838 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3839 zhp->zfs_type == ZFS_TYPE_VOLUME);
3842 * Destroy all recent snapshots and their dependents.
3844 cb.cb_force = force;
3845 cb.cb_target = snap->zfs_name;
3846 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3847 (void) zfs_iter_snapshots(zhp, B_FALSE, rollback_destroy, &cb);
3848 (void) zfs_iter_bookmarks(zhp, rollback_destroy, &cb);
3854 * Now that we have verified that the snapshot is the latest,
3855 * rollback to the given snapshot.
3858 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
3859 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
3861 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3863 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
3867 * We rely on zfs_iter_children() to verify that there are no
3868 * newer snapshots for the given dataset. Therefore, we can
3869 * simply pass the name on to the ioctl() call. There is still
3870 * an unlikely race condition where the user has taken a
3871 * snapshot since we verified that this was the most recent.
3873 err = lzc_rollback(zhp->zfs_name, NULL, 0);
3875 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3876 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
3882 * For volumes, if the pre-rollback volsize matched the pre-
3883 * rollback reservation and the volsize has changed then set
3884 * the reservation property to the post-rollback volsize.
3885 * Make a new handle since the rollback closed the dataset.
3887 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
3888 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
3890 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3891 if (old_volsize != new_volsize)
3892 err = zfs_prop_set_int(zhp, resv_prop,
3901 * Renames the given dataset.
3904 zfs_rename(zfs_handle_t *zhp, const char *source, const char *target,
3905 renameflags_t flags)
3908 zfs_cmd_t zc = { 0 };
3910 prop_changelist_t *cl = NULL;
3911 zfs_handle_t *zhrp = NULL;
3912 char *parentname = NULL;
3913 char parent[ZFS_MAX_DATASET_NAME_LEN];
3914 char property[ZFS_MAXPROPLEN];
3915 libzfs_handle_t *hdl = zhp->zfs_hdl;
3918 /* if we have the same exact name, just return success */
3919 if (strcmp(zhp->zfs_name, target) == 0)
3922 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3923 "cannot rename to '%s'"), target);
3925 if (source != NULL) {
3927 * This is recursive snapshots rename, put snapshot name
3928 * (that might not exist) into zfs_name.
3930 assert(flags.recurse);
3932 (void) strlcat(zhp->zfs_name, "@", sizeof(zhp->zfs_name));
3933 (void) strlcat(zhp->zfs_name, source, sizeof(zhp->zfs_name));
3934 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
3938 * Make sure the target name is valid
3940 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3941 if ((strchr(target, '@') == NULL) ||
3944 * Snapshot target name is abbreviated,
3945 * reconstruct full dataset name
3947 (void) strlcpy(parent, zhp->zfs_name,
3949 delim = strchr(parent, '@');
3950 if (strchr(target, '@') == NULL)
3954 (void) strlcat(parent, target, sizeof (parent));
3958 * Make sure we're renaming within the same dataset.
3960 delim = strchr(target, '@');
3961 if (strncmp(zhp->zfs_name, target, delim - target)
3962 != 0 || zhp->zfs_name[delim - target] != '@') {
3963 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3964 "snapshots must be part of same "
3966 return (zfs_error(hdl, EZFS_CROSSTARGET,
3970 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3971 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3973 if (flags.recurse) {
3974 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3975 "recursive rename must be a snapshot"));
3976 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3979 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3980 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3982 /* validate parents */
3983 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
3986 /* make sure we're in the same pool */
3987 verify((delim = strchr(target, '/')) != NULL);
3988 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
3989 zhp->zfs_name[delim - target] != '/') {
3990 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3991 "datasets must be within same pool"));
3992 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
3995 /* new name cannot be a child of the current dataset name */
3996 if (is_descendant(zhp->zfs_name, target)) {
3997 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3998 "New dataset name cannot be a descendant of "
3999 "current dataset name"));
4000 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4004 (void) snprintf(errbuf, sizeof (errbuf),
4005 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
4007 if (getzoneid() == GLOBAL_ZONEID &&
4008 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
4009 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4010 "dataset is used in a non-global zone"));
4011 return (zfs_error(hdl, EZFS_ZONED, errbuf));
4015 * Avoid unmounting file systems with mountpoint property set to
4016 * 'legacy' or 'none' even if -u option is not given.
4018 if (zhp->zfs_type == ZFS_TYPE_FILESYSTEM &&
4019 !flags.recurse && !flags.nounmount &&
4020 zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, property,
4021 sizeof (property), NULL, NULL, 0, B_FALSE) == 0 &&
4022 (strcmp(property, "legacy") == 0 ||
4023 strcmp(property, "none") == 0)) {
4024 flags.nounmount = B_TRUE;
4026 if (flags.recurse) {
4028 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
4029 if (parentname == NULL) {
4033 delim = strchr(parentname, '@');
4035 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
4040 } else if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT) {
4041 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME,
4042 flags.nounmount ? CL_GATHER_DONT_UNMOUNT : 0,
4043 flags.forceunmount ? MS_FORCE : 0)) == NULL) {
4047 if (changelist_haszonedchild(cl)) {
4048 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4049 "child dataset with inherited mountpoint is used "
4050 "in a non-global zone"));
4051 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
4056 if ((ret = changelist_prefix(cl)) != 0)
4060 if (ZFS_IS_VOLUME(zhp))
4061 zc.zc_objset_type = DMU_OST_ZVOL;
4063 zc.zc_objset_type = DMU_OST_ZFS;
4065 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4066 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
4068 zc.zc_cookie = flags.recurse ? 1 : 0;
4069 if (flags.nounmount)
4072 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
4074 * if it was recursive, the one that actually failed will
4077 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4078 "cannot rename '%s'"), zc.zc_name);
4080 if (flags.recurse && errno == EEXIST) {
4081 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4082 "a child dataset already has a snapshot "
4083 "with the new name"));
4084 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
4086 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
4090 * On failure, we still want to remount any filesystems that
4091 * were previously mounted, so we don't alter the system state.
4094 (void) changelist_postfix(cl);
4097 changelist_rename(cl, zfs_get_name(zhp), target);
4098 ret = changelist_postfix(cl);
4103 if (parentname != NULL) {
4110 changelist_free(cl);
4116 zfs_get_user_props(zfs_handle_t *zhp)
4118 return (zhp->zfs_user_props);
4122 zfs_get_recvd_props(zfs_handle_t *zhp)
4124 if (zhp->zfs_recvd_props == NULL)
4125 if (get_recvd_props_ioctl(zhp) != 0)
4127 return (zhp->zfs_recvd_props);
4131 * This function is used by 'zfs list' to determine the exact set of columns to
4132 * display, and their maximum widths. This does two main things:
4134 * - If this is a list of all properties, then expand the list to include
4135 * all native properties, and set a flag so that for each dataset we look
4136 * for new unique user properties and add them to the list.
4138 * - For non fixed-width properties, keep track of the maximum width seen
4139 * so that we can size the column appropriately. If the user has
4140 * requested received property values, we also need to compute the width
4141 * of the RECEIVED column.
4144 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received,
4147 libzfs_handle_t *hdl = zhp->zfs_hdl;
4148 zprop_list_t *entry;
4149 zprop_list_t **last, **start;
4150 nvlist_t *userprops, *propval;
4153 char buf[ZFS_MAXPROPLEN];
4155 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
4158 userprops = zfs_get_user_props(zhp);
4161 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
4163 * Go through and add any user properties as necessary. We
4164 * start by incrementing our list pointer to the first
4165 * non-native property.
4168 while (*start != NULL) {
4169 if ((*start)->pl_prop == ZPROP_INVAL)
4171 start = &(*start)->pl_next;
4175 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
4177 * See if we've already found this property in our list.
4179 for (last = start; *last != NULL;
4180 last = &(*last)->pl_next) {
4181 if (strcmp((*last)->pl_user_prop,
4182 nvpair_name(elem)) == 0)
4186 if (*last == NULL) {
4187 if ((entry = zfs_alloc(hdl,
4188 sizeof (zprop_list_t))) == NULL ||
4189 ((entry->pl_user_prop = zfs_strdup(hdl,
4190 nvpair_name(elem)))) == NULL) {
4195 entry->pl_prop = ZPROP_INVAL;
4196 entry->pl_width = strlen(nvpair_name(elem));
4197 entry->pl_all = B_TRUE;
4204 * Now go through and check the width of any non-fixed columns
4206 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
4207 if (entry->pl_fixed && !literal)
4210 if (entry->pl_prop != ZPROP_INVAL) {
4211 if (zfs_prop_get(zhp, entry->pl_prop,
4212 buf, sizeof (buf), NULL, NULL, 0, literal) == 0) {
4213 if (strlen(buf) > entry->pl_width)
4214 entry->pl_width = strlen(buf);
4216 if (received && zfs_prop_get_recvd(zhp,
4217 zfs_prop_to_name(entry->pl_prop),
4218 buf, sizeof (buf), literal) == 0)
4219 if (strlen(buf) > entry->pl_recvd_width)
4220 entry->pl_recvd_width = strlen(buf);
4222 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
4224 verify(nvlist_lookup_string(propval,
4225 ZPROP_VALUE, &strval) == 0);
4226 if (strlen(strval) > entry->pl_width)
4227 entry->pl_width = strlen(strval);
4229 if (received && zfs_prop_get_recvd(zhp,
4230 entry->pl_user_prop,
4231 buf, sizeof (buf), literal) == 0)
4232 if (strlen(buf) > entry->pl_recvd_width)
4233 entry->pl_recvd_width = strlen(buf);
4241 zfs_deleg_share_nfs(libzfs_handle_t *hdl, char *dataset, char *path,
4242 char *resource, void *export, void *sharetab,
4243 int sharemax, zfs_share_op_t operation)
4245 zfs_cmd_t zc = { 0 };
4248 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4249 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4251 (void) strlcpy(zc.zc_string, resource, sizeof (zc.zc_string));
4252 zc.zc_share.z_sharedata = (uint64_t)(uintptr_t)sharetab;
4253 zc.zc_share.z_exportdata = (uint64_t)(uintptr_t)export;
4254 zc.zc_share.z_sharetype = operation;
4255 zc.zc_share.z_sharemax = sharemax;
4256 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SHARE, &zc);
4261 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
4266 * Keep a reference to the props-table against which we prune the
4269 zhp->zfs_props_table = props;
4271 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
4274 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
4275 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
4278 * User properties will result in ZPROP_INVAL, and since we
4279 * only know how to prune standard ZFS properties, we always
4280 * leave these in the list. This can also happen if we
4281 * encounter an unknown DSL property (when running older
4282 * software, for example).
4284 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
4285 (void) nvlist_remove(zhp->zfs_props,
4286 nvpair_name(curr), nvpair_type(curr));
4293 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
4294 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
4296 zfs_cmd_t zc = { 0 };
4297 nvlist_t *nvlist = NULL;
4300 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4301 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4302 zc.zc_cookie = (uint64_t)cmd;
4304 if (cmd == ZFS_SMB_ACL_RENAME) {
4305 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
4306 (void) no_memory(hdl);
4312 case ZFS_SMB_ACL_ADD:
4313 case ZFS_SMB_ACL_REMOVE:
4314 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4316 case ZFS_SMB_ACL_RENAME:
4317 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4319 (void) no_memory(hdl);
4322 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4324 (void) no_memory(hdl);
4327 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4328 nvlist_free(nvlist);
4332 case ZFS_SMB_ACL_PURGE:
4337 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4338 nvlist_free(nvlist);
4343 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4344 char *path, char *resource)
4346 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4351 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4352 char *path, char *resource)
4354 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4359 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4361 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4366 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4367 char *oldname, char *newname)
4369 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4372 #endif /* illumos */
4375 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4376 zfs_userspace_cb_t func, void *arg)
4378 zfs_cmd_t zc = { 0 };
4379 zfs_useracct_t buf[100];
4380 libzfs_handle_t *hdl = zhp->zfs_hdl;
4383 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4385 zc.zc_objset_type = type;
4386 zc.zc_nvlist_dst = (uintptr_t)buf;
4389 zfs_useracct_t *zua = buf;
4391 zc.zc_nvlist_dst_size = sizeof (buf);
4392 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4395 (void) snprintf(errbuf, sizeof (errbuf),
4396 dgettext(TEXT_DOMAIN,
4397 "cannot get used/quota for %s"), zc.zc_name);
4398 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4400 if (zc.zc_nvlist_dst_size == 0)
4403 while (zc.zc_nvlist_dst_size > 0) {
4404 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4405 zua->zu_space)) != 0)
4408 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4417 const char *snapname;
4419 boolean_t recursive;
4424 zfs_hold_one(zfs_handle_t *zhp, void *arg)
4426 struct holdarg *ha = arg;
4427 char name[ZFS_MAX_DATASET_NAME_LEN];
4430 (void) snprintf(name, sizeof (name),
4431 "%s@%s", zhp->zfs_name, ha->snapname);
4433 if (lzc_exists(name))
4434 fnvlist_add_string(ha->nvl, name, ha->tag);
4437 rv = zfs_iter_filesystems(zhp, zfs_hold_one, ha);
4443 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4444 boolean_t recursive, int cleanup_fd)
4449 ha.nvl = fnvlist_alloc();
4450 ha.snapname = snapname;
4452 ha.recursive = recursive;
4453 (void) zfs_hold_one(zfs_handle_dup(zhp), &ha);
4455 if (nvlist_empty(ha.nvl)) {
4458 fnvlist_free(ha.nvl);
4460 (void) snprintf(errbuf, sizeof (errbuf),
4461 dgettext(TEXT_DOMAIN,
4462 "cannot hold snapshot '%s@%s'"),
4463 zhp->zfs_name, snapname);
4464 (void) zfs_standard_error(zhp->zfs_hdl, ret, errbuf);
4468 ret = zfs_hold_nvl(zhp, cleanup_fd, ha.nvl);
4469 fnvlist_free(ha.nvl);
4475 zfs_hold_nvl(zfs_handle_t *zhp, int cleanup_fd, nvlist_t *holds)
4479 libzfs_handle_t *hdl = zhp->zfs_hdl;
4484 ret = lzc_hold(holds, cleanup_fd, &errors);
4487 /* There may be errors even in the success case. */
4488 fnvlist_free(errors);
4492 if (nvlist_empty(errors)) {
4493 /* no hold-specific errors */
4494 (void) snprintf(errbuf, sizeof (errbuf),
4495 dgettext(TEXT_DOMAIN, "cannot hold"));
4498 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4499 "pool must be upgraded"));
4500 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4503 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4506 (void) zfs_standard_error(hdl, ret, errbuf);
4510 for (elem = nvlist_next_nvpair(errors, NULL);
4512 elem = nvlist_next_nvpair(errors, elem)) {
4513 (void) snprintf(errbuf, sizeof (errbuf),
4514 dgettext(TEXT_DOMAIN,
4515 "cannot hold snapshot '%s'"), nvpair_name(elem));
4516 switch (fnvpair_value_int32(elem)) {
4519 * Temporary tags wind up having the ds object id
4520 * prepended. So even if we passed the length check
4521 * above, it's still possible for the tag to wind
4522 * up being slightly too long.
4524 (void) zfs_error(hdl, EZFS_TAGTOOLONG, errbuf);
4527 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4530 (void) zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf);
4533 (void) zfs_standard_error(hdl,
4534 fnvpair_value_int32(elem), errbuf);
4538 fnvlist_free(errors);
4543 zfs_release_one(zfs_handle_t *zhp, void *arg)
4545 struct holdarg *ha = arg;
4546 char name[ZFS_MAX_DATASET_NAME_LEN];
4548 nvlist_t *existing_holds;
4550 (void) snprintf(name, sizeof (name),
4551 "%s@%s", zhp->zfs_name, ha->snapname);
4553 if (lzc_get_holds(name, &existing_holds) != 0) {
4555 } else if (!nvlist_exists(existing_holds, ha->tag)) {
4558 nvlist_t *torelease = fnvlist_alloc();
4559 fnvlist_add_boolean(torelease, ha->tag);
4560 fnvlist_add_nvlist(ha->nvl, name, torelease);
4561 fnvlist_free(torelease);
4565 rv = zfs_iter_filesystems(zhp, zfs_release_one, ha);
4571 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4572 boolean_t recursive)
4576 nvlist_t *errors = NULL;
4578 libzfs_handle_t *hdl = zhp->zfs_hdl;
4581 ha.nvl = fnvlist_alloc();
4582 ha.snapname = snapname;
4584 ha.recursive = recursive;
4586 (void) zfs_release_one(zfs_handle_dup(zhp), &ha);
4588 if (nvlist_empty(ha.nvl)) {
4589 fnvlist_free(ha.nvl);
4591 (void) snprintf(errbuf, sizeof (errbuf),
4592 dgettext(TEXT_DOMAIN,
4593 "cannot release hold from snapshot '%s@%s'"),
4594 zhp->zfs_name, snapname);
4596 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4598 (void) zfs_standard_error(hdl, ret, errbuf);
4603 ret = lzc_release(ha.nvl, &errors);
4604 fnvlist_free(ha.nvl);
4607 /* There may be errors even in the success case. */
4608 fnvlist_free(errors);
4612 if (nvlist_empty(errors)) {
4613 /* no hold-specific errors */
4614 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4618 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4619 "pool must be upgraded"));
4620 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4623 (void) zfs_standard_error_fmt(hdl, errno, errbuf);
4627 for (elem = nvlist_next_nvpair(errors, NULL);
4629 elem = nvlist_next_nvpair(errors, elem)) {
4630 (void) snprintf(errbuf, sizeof (errbuf),
4631 dgettext(TEXT_DOMAIN,
4632 "cannot release hold from snapshot '%s'"),
4634 switch (fnvpair_value_int32(elem)) {
4636 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4639 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4642 (void) zfs_standard_error_fmt(hdl,
4643 fnvpair_value_int32(elem), errbuf);
4647 fnvlist_free(errors);
4652 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4654 zfs_cmd_t zc = { 0 };
4655 libzfs_handle_t *hdl = zhp->zfs_hdl;
4661 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4662 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4666 nvbuf = malloc(nvsz);
4667 if (nvbuf == NULL) {
4668 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4672 zc.zc_nvlist_dst_size = nvsz;
4673 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4675 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4677 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4678 (void) snprintf(errbuf, sizeof (errbuf),
4679 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4684 nvsz = zc.zc_nvlist_dst_size;
4688 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4689 "pool must be upgraded"));
4690 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4693 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4696 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4699 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4704 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4706 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4707 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4709 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4719 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4721 zfs_cmd_t zc = { 0 };
4722 libzfs_handle_t *hdl = zhp->zfs_hdl;
4728 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4729 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4731 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
4734 nvbuf = malloc(nvsz);
4736 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
4739 zc.zc_nvlist_src_size = nvsz;
4740 zc.zc_nvlist_src = (uintptr_t)nvbuf;
4741 zc.zc_perm_action = un;
4743 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4745 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
4746 (void) snprintf(errbuf, sizeof (errbuf),
4747 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
4751 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4752 "pool must be upgraded"));
4753 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4756 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4759 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4762 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4773 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
4778 err = lzc_get_holds(zhp->zfs_name, nvl);
4781 libzfs_handle_t *hdl = zhp->zfs_hdl;
4783 (void) snprintf(errbuf, sizeof (errbuf),
4784 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4788 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4789 "pool must be upgraded"));
4790 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4793 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4796 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4799 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4808 * Convert the zvol's volume size to an appropriate reservation.
4809 * Note: If this routine is updated, it is necessary to update the ZFS test
4810 * suite's shell version in reservation.kshlib.
4813 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4816 uint64_t nblocks, volblocksize;
4820 if (nvlist_lookup_string(props,
4821 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4822 ncopies = atoi(strval);
4825 if (nvlist_lookup_uint64(props,
4826 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4827 &volblocksize) != 0)
4828 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4829 nblocks = volsize/volblocksize;
4830 /* start with metadnode L0-L6 */
4832 /* calculate number of indirects */
4833 while (nblocks > 1) {
4834 nblocks += DNODES_PER_LEVEL - 1;
4835 nblocks /= DNODES_PER_LEVEL;
4838 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4841 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4842 * compressed, but in practice they compress down to about
4845 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;
4851 * Attach/detach the given filesystem to/from the given jail.
4854 zfs_jail(zfs_handle_t *zhp, int jailid, int attach)
4856 libzfs_handle_t *hdl = zhp->zfs_hdl;
4857 zfs_cmd_t zc = { 0 };
4863 (void) snprintf(errbuf, sizeof (errbuf),
4864 dgettext(TEXT_DOMAIN, "cannot jail '%s'"), zhp->zfs_name);
4866 (void) snprintf(errbuf, sizeof (errbuf),
4867 dgettext(TEXT_DOMAIN, "cannot unjail '%s'"), zhp->zfs_name);
4870 switch (zhp->zfs_type) {
4871 case ZFS_TYPE_VOLUME:
4872 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4873 "volumes can not be jailed"));
4874 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4875 case ZFS_TYPE_SNAPSHOT:
4876 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4877 "snapshots can not be jailed"));
4878 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4880 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4882 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4883 zc.zc_objset_type = DMU_OST_ZFS;
4884 zc.zc_jailid = jailid;
4886 cmd = attach ? ZFS_IOC_JAIL : ZFS_IOC_UNJAIL;
4887 if ((ret = ioctl(hdl->libzfs_fd, cmd, &zc)) != 0)
4888 zfs_standard_error(hdl, errno, errbuf);