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_MAXNAMELEN];
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. We only use the changelist logic to
1613 * unmount when setting canmount=off for a mounted filesystem
1614 * or when setting canmount=on for an unmounted filesystem.
1615 * For all other changes to canmount property the filesystem
1618 if (prop != ZFS_PROP_CANMOUNT ||
1619 (fnvpair_value_uint64(elem) == ZFS_CANMOUNT_OFF &&
1620 zfs_is_mounted(zhp, NULL)) ||
1621 (fnvpair_value_uint64(elem) == ZFS_CANMOUNT_ON &&
1622 !zfs_is_mounted(zhp, NULL))) {
1623 cls[cl_idx] = changelist_gather(zhp, prop, 0, 0);
1624 if (cls[cl_idx] == NULL)
1628 if (prop == ZFS_PROP_MOUNTPOINT &&
1629 changelist_haszonedchild(cls[cl_idx])) {
1630 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1631 "child dataset with inherited mountpoint is used "
1632 "in a non-global zone"));
1633 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1637 /* We don't support those properties on FreeBSD. */
1639 case ZFS_PROP_DEVICES:
1640 case ZFS_PROP_ISCSIOPTIONS:
1641 case ZFS_PROP_XATTR:
1642 case ZFS_PROP_VSCAN:
1643 case ZFS_PROP_NBMAND:
1644 case ZFS_PROP_MLSLABEL:
1645 (void) snprintf(errbuf, sizeof (errbuf),
1646 "property '%s' not supported on FreeBSD",
1648 ret = zfs_error(hdl, EZFS_PERM, errbuf);
1652 if (cls[cl_idx] != NULL &&
1653 (ret = changelist_prefix(cls[cl_idx])) != 0)
1658 assert(cl_idx == nvl_len);
1661 * Execute the corresponding ioctl() to set this list of properties.
1663 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1665 if ((ret = zcmd_write_src_nvlist(hdl, &zc, nvl)) != 0 ||
1666 (ret = zcmd_alloc_dst_nvlist(hdl, &zc, 0)) != 0)
1669 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1672 /* Get the list of unset properties back and report them. */
1673 nvlist_t *errorprops = NULL;
1674 if (zcmd_read_dst_nvlist(hdl, &zc, &errorprops) != 0)
1676 for (nvpair_t *elem = nvlist_next_nvpair(nvl, NULL);
1678 elem = nvlist_next_nvpair(nvl, elem)) {
1679 zfs_prop_t prop = zfs_name_to_prop(nvpair_name(elem));
1680 zfs_setprop_error(hdl, prop, errno, errbuf);
1682 nvlist_free(errorprops);
1684 if (added_resv && errno == ENOSPC) {
1685 /* clean up the volsize property we tried to set */
1686 uint64_t old_volsize = zfs_prop_get_int(zhp,
1690 zcmd_free_nvlists(&zc);
1692 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1694 if (nvlist_add_uint64(nvl,
1695 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1698 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1700 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1703 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1704 if (cls[cl_idx] != NULL) {
1705 int clp_err = changelist_postfix(cls[cl_idx]);
1712 * Refresh the statistics so the new property value
1716 (void) get_stats(zhp);
1721 zcmd_free_nvlists(&zc);
1723 for (cl_idx = 0; cl_idx < nvl_len; cl_idx++) {
1724 if (cls[cl_idx] != NULL)
1725 changelist_free(cls[cl_idx]);
1733 * Given a property, inherit the value from the parent dataset, or if received
1734 * is TRUE, revert to the received value, if any.
1737 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1739 zfs_cmd_t zc = { 0 };
1741 prop_changelist_t *cl;
1742 libzfs_handle_t *hdl = zhp->zfs_hdl;
1746 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1747 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1749 zc.zc_cookie = received;
1750 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1752 * For user properties, the amount of work we have to do is very
1753 * small, so just do it here.
1755 if (!zfs_prop_user(propname)) {
1756 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1757 "invalid property"));
1758 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1761 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1762 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1764 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1765 return (zfs_standard_error(hdl, errno, errbuf));
1771 * Verify that this property is inheritable.
1773 if (zfs_prop_readonly(prop))
1774 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1776 if (!zfs_prop_inheritable(prop) && !received)
1777 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1780 * Check to see if the value applies to this type
1782 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1783 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1786 * Normalize the name, to get rid of shorthand abbreviations.
1788 propname = zfs_prop_to_name(prop);
1789 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1790 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1792 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1793 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1794 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1795 "dataset is used in a non-global zone"));
1796 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1800 * Determine datasets which will be affected by this change, if any.
1802 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1805 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1806 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1807 "child dataset with inherited mountpoint is used "
1808 "in a non-global zone"));
1809 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1813 if ((ret = changelist_prefix(cl)) != 0)
1816 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1817 return (zfs_standard_error(hdl, errno, errbuf));
1820 if ((ret = changelist_postfix(cl)) != 0)
1824 * Refresh the statistics so the new property is reflected.
1826 (void) get_stats(zhp);
1830 changelist_free(cl);
1835 * True DSL properties are stored in an nvlist. The following two functions
1836 * extract them appropriately.
1839 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1845 if (nvlist_lookup_nvlist(zhp->zfs_props,
1846 zfs_prop_to_name(prop), &nv) == 0) {
1847 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1848 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1850 verify(!zhp->zfs_props_table ||
1851 zhp->zfs_props_table[prop] == B_TRUE);
1852 value = zfs_prop_default_numeric(prop);
1860 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1866 if (nvlist_lookup_nvlist(zhp->zfs_props,
1867 zfs_prop_to_name(prop), &nv) == 0) {
1868 value = fnvlist_lookup_string(nv, ZPROP_VALUE);
1869 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1871 verify(!zhp->zfs_props_table ||
1872 zhp->zfs_props_table[prop] == B_TRUE);
1873 value = zfs_prop_default_string(prop);
1881 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
1883 return (zhp->zfs_props == zhp->zfs_recvd_props);
1887 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1889 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
1890 zhp->zfs_props = zhp->zfs_recvd_props;
1894 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1896 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
1901 * Internal function for getting a numeric property. Both zfs_prop_get() and
1902 * zfs_prop_get_int() are built using this interface.
1904 * Certain properties can be overridden using 'mount -o'. In this case, scan
1905 * the contents of the /etc/mnttab entry, searching for the appropriate options.
1906 * If they differ from the on-disk values, report the current values and mark
1907 * the source "temporary".
1910 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
1911 char **source, uint64_t *val)
1913 zfs_cmd_t zc = { 0 };
1914 nvlist_t *zplprops = NULL;
1916 char *mntopt_on = NULL;
1917 char *mntopt_off = NULL;
1918 boolean_t received = zfs_is_recvd_props_mode(zhp);
1923 case ZFS_PROP_ATIME:
1924 mntopt_on = MNTOPT_ATIME;
1925 mntopt_off = MNTOPT_NOATIME;
1928 case ZFS_PROP_DEVICES:
1929 mntopt_on = MNTOPT_DEVICES;
1930 mntopt_off = MNTOPT_NODEVICES;
1934 mntopt_on = MNTOPT_EXEC;
1935 mntopt_off = MNTOPT_NOEXEC;
1938 case ZFS_PROP_READONLY:
1939 mntopt_on = MNTOPT_RO;
1940 mntopt_off = MNTOPT_RW;
1943 case ZFS_PROP_SETUID:
1944 mntopt_on = MNTOPT_SETUID;
1945 mntopt_off = MNTOPT_NOSETUID;
1948 case ZFS_PROP_XATTR:
1949 mntopt_on = MNTOPT_XATTR;
1950 mntopt_off = MNTOPT_NOXATTR;
1953 case ZFS_PROP_NBMAND:
1954 mntopt_on = MNTOPT_NBMAND;
1955 mntopt_off = MNTOPT_NONBMAND;
1963 * Because looking up the mount options is potentially expensive
1964 * (iterating over all of /etc/mnttab), we defer its calculation until
1965 * we're looking up a property which requires its presence.
1967 if (!zhp->zfs_mntcheck &&
1968 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
1969 libzfs_handle_t *hdl = zhp->zfs_hdl;
1970 struct mnttab entry;
1972 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
1973 zhp->zfs_mntopts = zfs_strdup(hdl,
1975 if (zhp->zfs_mntopts == NULL)
1979 zhp->zfs_mntcheck = B_TRUE;
1982 if (zhp->zfs_mntopts == NULL)
1983 mnt.mnt_mntopts = "";
1985 mnt.mnt_mntopts = zhp->zfs_mntopts;
1988 case ZFS_PROP_ATIME:
1989 case ZFS_PROP_DEVICES:
1991 case ZFS_PROP_READONLY:
1992 case ZFS_PROP_SETUID:
1993 case ZFS_PROP_XATTR:
1994 case ZFS_PROP_NBMAND:
1995 *val = getprop_uint64(zhp, prop, source);
2000 if (hasmntopt(&mnt, mntopt_on) && !*val) {
2003 *src = ZPROP_SRC_TEMPORARY;
2004 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
2007 *src = ZPROP_SRC_TEMPORARY;
2011 case ZFS_PROP_CANMOUNT:
2012 case ZFS_PROP_VOLSIZE:
2013 case ZFS_PROP_QUOTA:
2014 case ZFS_PROP_REFQUOTA:
2015 case ZFS_PROP_RESERVATION:
2016 case ZFS_PROP_REFRESERVATION:
2017 case ZFS_PROP_FILESYSTEM_LIMIT:
2018 case ZFS_PROP_SNAPSHOT_LIMIT:
2019 case ZFS_PROP_FILESYSTEM_COUNT:
2020 case ZFS_PROP_SNAPSHOT_COUNT:
2021 *val = getprop_uint64(zhp, prop, source);
2023 if (*source == NULL) {
2024 /* not default, must be local */
2025 *source = zhp->zfs_name;
2029 case ZFS_PROP_MOUNTED:
2030 *val = (zhp->zfs_mntopts != NULL);
2033 case ZFS_PROP_NUMCLONES:
2034 *val = zhp->zfs_dmustats.dds_num_clones;
2037 case ZFS_PROP_VERSION:
2038 case ZFS_PROP_NORMALIZE:
2039 case ZFS_PROP_UTF8ONLY:
2041 if (!zfs_prop_valid_for_type(prop, zhp->zfs_head_type) ||
2042 zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
2044 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2045 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
2046 zcmd_free_nvlists(&zc);
2049 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
2050 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
2052 zcmd_free_nvlists(&zc);
2055 nvlist_free(zplprops);
2056 zcmd_free_nvlists(&zc);
2059 case ZFS_PROP_INCONSISTENT:
2060 *val = zhp->zfs_dmustats.dds_inconsistent;
2064 switch (zfs_prop_get_type(prop)) {
2065 case PROP_TYPE_NUMBER:
2066 case PROP_TYPE_INDEX:
2067 *val = getprop_uint64(zhp, prop, source);
2069 * If we tried to use a default value for a
2070 * readonly property, it means that it was not
2073 if (zfs_prop_readonly(prop) &&
2074 *source != NULL && (*source)[0] == '\0') {
2079 case PROP_TYPE_STRING:
2081 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
2082 "cannot get non-numeric property"));
2083 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
2084 dgettext(TEXT_DOMAIN, "internal error")));
2092 * Calculate the source type, given the raw source string.
2095 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
2096 char *statbuf, size_t statlen)
2098 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
2101 if (source == NULL) {
2102 *srctype = ZPROP_SRC_NONE;
2103 } else if (source[0] == '\0') {
2104 *srctype = ZPROP_SRC_DEFAULT;
2105 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
2106 *srctype = ZPROP_SRC_RECEIVED;
2108 if (strcmp(source, zhp->zfs_name) == 0) {
2109 *srctype = ZPROP_SRC_LOCAL;
2111 (void) strlcpy(statbuf, source, statlen);
2112 *srctype = ZPROP_SRC_INHERITED;
2119 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
2120 size_t proplen, boolean_t literal)
2125 if (zhp->zfs_recvd_props == NULL)
2126 if (get_recvd_props_ioctl(zhp) != 0)
2129 prop = zfs_name_to_prop(propname);
2131 if (prop != ZPROP_INVAL) {
2133 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
2135 zfs_set_recvd_props_mode(zhp, &cookie);
2136 err = zfs_prop_get(zhp, prop, propbuf, proplen,
2137 NULL, NULL, 0, literal);
2138 zfs_unset_recvd_props_mode(zhp, &cookie);
2142 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
2143 propname, &propval) != 0)
2145 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
2147 (void) strlcpy(propbuf, recvdval, proplen);
2150 return (err == 0 ? 0 : -1);
2154 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
2159 value = zfs_get_clones_nvl(zhp);
2164 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
2165 pair = nvlist_next_nvpair(value, pair)) {
2166 if (propbuf[0] != '\0')
2167 (void) strlcat(propbuf, ",", proplen);
2168 (void) strlcat(propbuf, nvpair_name(pair), proplen);
2174 struct get_clones_arg {
2178 char buf[ZFS_MAXNAMELEN];
2182 get_clones_cb(zfs_handle_t *zhp, void *arg)
2184 struct get_clones_arg *gca = arg;
2186 if (gca->numclones == 0) {
2191 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
2192 NULL, NULL, 0, B_TRUE) != 0)
2194 if (strcmp(gca->buf, gca->origin) == 0) {
2195 fnvlist_add_boolean(gca->value, zfs_get_name(zhp));
2200 (void) zfs_iter_children(zhp, get_clones_cb, gca);
2206 zfs_get_clones_nvl(zfs_handle_t *zhp)
2208 nvlist_t *nv, *value;
2210 if (nvlist_lookup_nvlist(zhp->zfs_props,
2211 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
2212 struct get_clones_arg gca;
2215 * if this is a snapshot, then the kernel wasn't able
2216 * to get the clones. Do it by slowly iterating.
2218 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2220 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2222 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2227 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2229 gca.origin = zhp->zfs_name;
2231 if (gca.numclones != 0) {
2233 char pool[ZFS_MAXNAMELEN];
2236 /* get the pool name */
2237 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2238 (void) strsep(&cp, "/@");
2239 root = zfs_open(zhp->zfs_hdl, pool,
2240 ZFS_TYPE_FILESYSTEM);
2242 (void) get_clones_cb(root, &gca);
2245 if (gca.numclones != 0 ||
2246 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2247 nvlist_add_nvlist(zhp->zfs_props,
2248 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2255 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2256 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2259 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2265 * Retrieve a property from the given object. If 'literal' is specified, then
2266 * numbers are left as exact values. Otherwise, numbers are converted to a
2267 * human-readable form.
2269 * Returns 0 on success, or -1 on error.
2272 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2273 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2275 char *source = NULL;
2279 boolean_t received = zfs_is_recvd_props_mode(zhp);
2282 * Check to see if this property applies to our object
2284 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
2287 if (received && zfs_prop_readonly(prop))
2291 *src = ZPROP_SRC_NONE;
2294 case ZFS_PROP_CREATION:
2296 * 'creation' is a time_t stored in the statistics. We convert
2297 * this into a string unless 'literal' is specified.
2300 val = getprop_uint64(zhp, prop, &source);
2301 time_t time = (time_t)val;
2305 localtime_r(&time, &t) == NULL ||
2306 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2308 (void) snprintf(propbuf, proplen, "%llu", val);
2312 case ZFS_PROP_MOUNTPOINT:
2314 * Getting the precise mountpoint can be tricky.
2316 * - for 'none' or 'legacy', return those values.
2317 * - for inherited mountpoints, we want to take everything
2318 * after our ancestor and append it to the inherited value.
2320 * If the pool has an alternate root, we want to prepend that
2321 * root to any values we return.
2324 str = getprop_string(zhp, prop, &source);
2326 if (str[0] == '/') {
2327 char buf[MAXPATHLEN];
2329 const char *relpath;
2332 * If we inherit the mountpoint, even from a dataset
2333 * with a received value, the source will be the path of
2334 * the dataset we inherit from. If source is
2335 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2338 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2341 relpath = zhp->zfs_name + strlen(source);
2342 if (relpath[0] == '/')
2346 if ((zpool_get_prop(zhp->zpool_hdl,
2347 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2348 B_FALSE)) || (strcmp(root, "-") == 0))
2351 * Special case an alternate root of '/'. This will
2352 * avoid having multiple leading slashes in the
2355 if (strcmp(root, "/") == 0)
2359 * If the mountpoint is '/' then skip over this
2360 * if we are obtaining either an alternate root or
2361 * an inherited mountpoint.
2363 if (str[1] == '\0' && (root[0] != '\0' ||
2364 relpath[0] != '\0'))
2367 if (relpath[0] == '\0')
2368 (void) snprintf(propbuf, proplen, "%s%s",
2371 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2372 root, str, relpath[0] == '@' ? "" : "/",
2375 /* 'legacy' or 'none' */
2376 (void) strlcpy(propbuf, str, proplen);
2381 case ZFS_PROP_ORIGIN:
2382 str = getprop_string(zhp, prop, &source);
2385 (void) strlcpy(propbuf, str, proplen);
2388 case ZFS_PROP_CLONES:
2389 if (get_clones_string(zhp, propbuf, proplen) != 0)
2393 case ZFS_PROP_QUOTA:
2394 case ZFS_PROP_REFQUOTA:
2395 case ZFS_PROP_RESERVATION:
2396 case ZFS_PROP_REFRESERVATION:
2398 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2402 * If quota or reservation is 0, we translate this into 'none'
2403 * (unless literal is set), and indicate that it's the default
2404 * value. Otherwise, we print the number nicely and indicate
2405 * that its set locally.
2409 (void) strlcpy(propbuf, "0", proplen);
2411 (void) strlcpy(propbuf, "none", proplen);
2414 (void) snprintf(propbuf, proplen, "%llu",
2417 zfs_nicenum(val, propbuf, proplen);
2421 case ZFS_PROP_FILESYSTEM_LIMIT:
2422 case ZFS_PROP_SNAPSHOT_LIMIT:
2423 case ZFS_PROP_FILESYSTEM_COUNT:
2424 case ZFS_PROP_SNAPSHOT_COUNT:
2426 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2430 * If limit is UINT64_MAX, we translate this into 'none' (unless
2431 * literal is set), and indicate that it's the default value.
2432 * Otherwise, we print the number nicely and indicate that it's
2436 (void) snprintf(propbuf, proplen, "%llu",
2438 } else if (val == UINT64_MAX) {
2439 (void) strlcpy(propbuf, "none", proplen);
2441 zfs_nicenum(val, propbuf, proplen);
2445 case ZFS_PROP_REFRATIO:
2446 case ZFS_PROP_COMPRESSRATIO:
2447 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2449 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2450 (u_longlong_t)(val / 100),
2451 (u_longlong_t)(val % 100));
2455 switch (zhp->zfs_type) {
2456 case ZFS_TYPE_FILESYSTEM:
2459 case ZFS_TYPE_VOLUME:
2462 case ZFS_TYPE_SNAPSHOT:
2465 case ZFS_TYPE_BOOKMARK:
2471 (void) snprintf(propbuf, proplen, "%s", str);
2474 case ZFS_PROP_MOUNTED:
2476 * The 'mounted' property is a pseudo-property that described
2477 * whether the filesystem is currently mounted. Even though
2478 * it's a boolean value, the typical values of "on" and "off"
2479 * don't make sense, so we translate to "yes" and "no".
2481 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2482 src, &source, &val) != 0)
2485 (void) strlcpy(propbuf, "yes", proplen);
2487 (void) strlcpy(propbuf, "no", proplen);
2492 * The 'name' property is a pseudo-property derived from the
2493 * dataset name. It is presented as a real property to simplify
2496 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2499 case ZFS_PROP_MLSLABEL:
2502 m_label_t *new_sl = NULL;
2503 char *ascii = NULL; /* human readable label */
2505 (void) strlcpy(propbuf,
2506 getprop_string(zhp, prop, &source), proplen);
2508 if (literal || (strcasecmp(propbuf,
2509 ZFS_MLSLABEL_DEFAULT) == 0))
2513 * Try to translate the internal hex string to
2514 * human-readable output. If there are any
2515 * problems just use the hex string.
2518 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2519 L_NO_CORRECTION, NULL) == -1) {
2520 m_label_free(new_sl);
2524 if (label_to_str(new_sl, &ascii, M_LABEL,
2528 m_label_free(new_sl);
2531 m_label_free(new_sl);
2533 (void) strlcpy(propbuf, ascii, proplen);
2535 #else /* !illumos */
2537 #endif /* illumos */
2543 * GUIDs are stored as numbers, but they are identifiers.
2544 * We don't want them to be pretty printed, because pretty
2545 * printing mangles the ID into a truncated and useless value.
2547 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2549 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2553 switch (zfs_prop_get_type(prop)) {
2554 case PROP_TYPE_NUMBER:
2555 if (get_numeric_property(zhp, prop, src,
2556 &source, &val) != 0)
2559 (void) snprintf(propbuf, proplen, "%llu",
2562 zfs_nicenum(val, propbuf, proplen);
2565 case PROP_TYPE_STRING:
2566 str = getprop_string(zhp, prop, &source);
2569 (void) strlcpy(propbuf, str, proplen);
2572 case PROP_TYPE_INDEX:
2573 if (get_numeric_property(zhp, prop, src,
2574 &source, &val) != 0)
2576 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2578 (void) strlcpy(propbuf, strval, proplen);
2586 get_source(zhp, src, source, statbuf, statlen);
2592 * Utility function to get the given numeric property. Does no validation that
2593 * the given property is the appropriate type; should only be used with
2594 * hard-coded property types.
2597 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2602 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2608 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2612 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2613 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2617 * Similar to zfs_prop_get(), but returns the value as an integer.
2620 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2621 zprop_source_t *src, char *statbuf, size_t statlen)
2626 * Check to see if this property applies to our object
2628 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) {
2629 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2630 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2631 zfs_prop_to_name(prop)));
2635 *src = ZPROP_SRC_NONE;
2637 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2640 get_source(zhp, src, source, statbuf, statlen);
2646 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2647 char **domainp, idmap_rid_t *ridp)
2650 idmap_get_handle_t *get_hdl = NULL;
2654 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2658 err = idmap_get_sidbyuid(get_hdl, id,
2659 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2661 err = idmap_get_sidbygid(get_hdl, id,
2662 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2664 if (err == IDMAP_SUCCESS &&
2665 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2666 status == IDMAP_SUCCESS)
2672 idmap_get_destroy(get_hdl);
2674 #else /* !illumos */
2675 assert(!"invalid code path");
2676 return (EINVAL); // silence compiler warning
2677 #endif /* illumos */
2681 * convert the propname into parameters needed by kernel
2682 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2683 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2686 userquota_propname_decode(const char *propname, boolean_t zoned,
2687 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2689 zfs_userquota_prop_t type;
2691 char *numericsid = NULL;
2696 /* Figure out the property type ({user|group}{quota|space}) */
2697 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2698 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2699 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2702 if (type == ZFS_NUM_USERQUOTA_PROPS)
2706 isuser = (type == ZFS_PROP_USERQUOTA ||
2707 type == ZFS_PROP_USERUSED);
2709 cp = strchr(propname, '@') + 1;
2711 if (strchr(cp, '@')) {
2714 * It's a SID name (eg "user@domain") that needs to be
2715 * turned into S-1-domainID-RID.
2718 idmap_stat stat, map_stat;
2721 idmap_get_handle_t *gh = NULL;
2723 stat = idmap_get_create(&gh);
2724 if (stat != IDMAP_SUCCESS) {
2725 idmap_get_destroy(gh);
2728 if (zoned && getzoneid() == GLOBAL_ZONEID)
2731 stat = idmap_getuidbywinname(cp, NULL, flag, &pid);
2734 stat = idmap_get_sidbyuid(gh, pid, flag, &numericsid,
2737 stat = idmap_getgidbywinname(cp, NULL, flag, &pid);
2740 stat = idmap_get_sidbygid(gh, pid, flag, &numericsid,
2744 idmap_get_destroy(gh);
2747 stat = idmap_get_mappings(gh);
2748 idmap_get_destroy(gh);
2753 if (numericsid == NULL)
2757 /* will be further decoded below */
2758 #else /* !illumos */
2760 #endif /* illumos */
2763 if (strncmp(cp, "S-1-", 4) == 0) {
2764 /* It's a numeric SID (eg "S-1-234-567-89") */
2765 (void) strlcpy(domain, cp, domainlen);
2768 cp = strrchr(domain, '-');
2771 *ridp = strtoull(cp, &end, 10);
2779 if (errno != 0 || *end != '\0')
2781 } else if (!isdigit(*cp)) {
2783 * It's a user/group name (eg "user") that needs to be
2784 * turned into a uid/gid
2786 if (zoned && getzoneid() == GLOBAL_ZONEID)
2802 /* It's a user/group ID (eg "12345"). */
2803 uid_t id = strtoul(cp, &end, 10);
2810 /* It's an ephemeral ID. */
2811 if (idmap_id_to_numeric_domain_rid(id, isuser,
2812 &mapdomain, &rid) != 0)
2814 (void) strlcpy(domain, mapdomain, domainlen);
2821 ASSERT3P(numericsid, ==, NULL);
2826 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2827 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2830 zfs_cmd_t zc = { 0 };
2832 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2834 err = userquota_propname_decode(propname,
2835 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2836 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2837 zc.zc_objset_type = *typep;
2841 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2845 *propvalue = zc.zc_cookie;
2850 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2851 uint64_t *propvalue)
2853 zfs_userquota_prop_t type;
2855 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
2860 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
2861 char *propbuf, int proplen, boolean_t literal)
2865 zfs_userquota_prop_t type;
2867 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
2874 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2875 } else if (propvalue == 0 &&
2876 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
2877 (void) strlcpy(propbuf, "none", proplen);
2879 zfs_nicenum(propvalue, propbuf, proplen);
2885 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
2886 uint64_t *propvalue)
2889 zfs_cmd_t zc = { 0 };
2890 const char *snapname;
2892 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2894 snapname = strchr(propname, '@') + 1;
2895 if (strchr(snapname, '@')) {
2896 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
2898 /* snapname is the short name, append it to zhp's fsname */
2901 (void) strlcpy(zc.zc_value, zhp->zfs_name,
2902 sizeof (zc.zc_value));
2903 cp = strchr(zc.zc_value, '@');
2906 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
2907 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
2910 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
2914 *propvalue = zc.zc_cookie;
2919 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
2920 char *propbuf, int proplen, boolean_t literal)
2925 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
2931 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2933 zfs_nicenum(propvalue, propbuf, proplen);
2939 * Returns the name of the given zfs handle.
2942 zfs_get_name(const zfs_handle_t *zhp)
2944 return (zhp->zfs_name);
2948 * Returns the name of the parent pool for the given zfs handle.
2951 zfs_get_pool_name(const zfs_handle_t *zhp)
2953 return (zhp->zpool_hdl->zpool_name);
2957 * Returns the type of the given zfs handle.
2960 zfs_get_type(const zfs_handle_t *zhp)
2962 return (zhp->zfs_type);
2966 * Is one dataset name a child dataset of another?
2968 * Needs to handle these cases:
2969 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2970 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2971 * Descendant? No. No. No. Yes.
2974 is_descendant(const char *ds1, const char *ds2)
2976 size_t d1len = strlen(ds1);
2978 /* ds2 can't be a descendant if it's smaller */
2979 if (strlen(ds2) < d1len)
2982 /* otherwise, compare strings and verify that there's a '/' char */
2983 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
2987 * Given a complete name, return just the portion that refers to the parent.
2988 * Will return -1 if there is no parent (path is just the name of the
2992 parent_name(const char *path, char *buf, size_t buflen)
2996 (void) strlcpy(buf, path, buflen);
2998 if ((slashp = strrchr(buf, '/')) == NULL)
3006 * If accept_ancestor is false, then check to make sure that the given path has
3007 * a parent, and that it exists. If accept_ancestor is true, then find the
3008 * closest existing ancestor for the given path. In prefixlen return the
3009 * length of already existing prefix of the given path. We also fetch the
3010 * 'zoned' property, which is used to validate property settings when creating
3014 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
3015 boolean_t accept_ancestor, int *prefixlen)
3017 zfs_cmd_t zc = { 0 };
3018 char parent[ZFS_MAXNAMELEN];
3024 (void) snprintf(errbuf, sizeof (errbuf),
3025 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
3027 /* get parent, and check to see if this is just a pool */
3028 if (parent_name(path, parent, sizeof (parent)) != 0) {
3029 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3030 "missing dataset name"));
3031 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3034 /* check to see if the pool exists */
3035 if ((slash = strchr(parent, '/')) == NULL)
3036 slash = parent + strlen(parent);
3037 (void) strncpy(zc.zc_name, parent, slash - parent);
3038 zc.zc_name[slash - parent] = '\0';
3039 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
3041 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3042 "no such pool '%s'"), zc.zc_name);
3043 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3046 /* check to see if the parent dataset exists */
3047 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
3048 if (errno == ENOENT && accept_ancestor) {
3050 * Go deeper to find an ancestor, give up on top level.
3052 if (parent_name(parent, parent, sizeof (parent)) != 0) {
3053 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3054 "no such pool '%s'"), zc.zc_name);
3055 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3057 } else if (errno == ENOENT) {
3058 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3059 "parent does not exist"));
3060 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3062 return (zfs_standard_error(hdl, errno, errbuf));
3065 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
3069 /* we are in a non-global zone, but parent is in the global zone */
3070 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
3071 (void) zfs_standard_error(hdl, EPERM, errbuf);
3076 /* make sure parent is a filesystem */
3077 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
3078 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3079 "parent is not a filesystem"));
3080 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
3086 if (prefixlen != NULL)
3087 *prefixlen = strlen(parent);
3092 * Finds whether the dataset of the given type(s) exists.
3095 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
3099 if (!zfs_validate_name(hdl, path, types, B_FALSE))
3103 * Try to get stats for the dataset, which will tell us if it exists.
3105 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
3106 int ds_type = zhp->zfs_type;
3109 if (types & ds_type)
3116 * Given a path to 'target', create all the ancestors between
3117 * the prefixlen portion of the path, and the target itself.
3118 * Fail if the initial prefixlen-ancestor does not already exist.
3121 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
3127 /* make sure prefix exists */
3128 cp = target + prefixlen;
3130 assert(strchr(cp, '/') == NULL);
3131 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3134 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3142 * Attempt to create, mount, and share any ancestor filesystems,
3143 * up to the prefixlen-long one.
3145 for (cp = target + prefixlen + 1;
3146 (cp = strchr(cp, '/')) != NULL; *cp = '/', cp++) {
3150 h = make_dataset_handle(hdl, target);
3152 /* it already exists, nothing to do here */
3157 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
3159 opname = dgettext(TEXT_DOMAIN, "create");
3163 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
3165 opname = dgettext(TEXT_DOMAIN, "open");
3169 if (zfs_mount(h, NULL, 0) != 0) {
3170 opname = dgettext(TEXT_DOMAIN, "mount");
3174 if (zfs_share(h) != 0) {
3175 opname = dgettext(TEXT_DOMAIN, "share");
3185 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3186 "failed to %s ancestor '%s'"), opname, target);
3191 * Creates non-existing ancestors of the given path.
3194 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
3200 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
3203 if ((path_copy = strdup(path)) != NULL) {
3204 rc = create_parents(hdl, path_copy, prefix);
3207 if (path_copy == NULL || rc != 0)
3214 * Create a new filesystem or volume.
3217 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
3222 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
3225 enum lzc_dataset_type ost;
3227 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3228 "cannot create '%s'"), path);
3230 /* validate the path, taking care to note the extended error message */
3231 if (!zfs_validate_name(hdl, path, type, B_TRUE))
3232 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3234 /* validate parents exist */
3235 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
3239 * The failure modes when creating a dataset of a different type over
3240 * one that already exists is a little strange. In particular, if you
3241 * try to create a dataset on top of an existing dataset, the ioctl()
3242 * will return ENOENT, not EEXIST. To prevent this from happening, we
3243 * first try to see if the dataset exists.
3245 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
3246 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3247 "dataset already exists"));
3248 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3251 if (type == ZFS_TYPE_VOLUME)
3252 ost = LZC_DATSET_TYPE_ZVOL;
3254 ost = LZC_DATSET_TYPE_ZFS;
3256 /* open zpool handle for prop validation */
3257 char pool_path[MAXNAMELEN];
3258 (void) strlcpy(pool_path, path, sizeof (pool_path));
3260 /* truncate pool_path at first slash */
3261 char *p = strchr(pool_path, '/');
3265 zpool_handle_t *zpool_handle = zpool_open(hdl, pool_path);
3267 if (props && (props = zfs_valid_proplist(hdl, type, props,
3268 zoned, NULL, zpool_handle, errbuf)) == 0) {
3269 zpool_close(zpool_handle);
3272 zpool_close(zpool_handle);
3274 if (type == ZFS_TYPE_VOLUME) {
3276 * If we are creating a volume, the size and block size must
3277 * satisfy a few restraints. First, the blocksize must be a
3278 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3279 * volsize must be a multiple of the block size, and cannot be
3282 if (props == NULL || nvlist_lookup_uint64(props,
3283 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3285 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3286 "missing volume size"));
3287 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3290 if ((ret = nvlist_lookup_uint64(props,
3291 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3292 &blocksize)) != 0) {
3293 if (ret == ENOENT) {
3294 blocksize = zfs_prop_default_numeric(
3295 ZFS_PROP_VOLBLOCKSIZE);
3298 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3299 "missing volume block size"));
3300 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3306 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3307 "volume size cannot be zero"));
3308 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3311 if (size % blocksize != 0) {
3313 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3314 "volume size must be a multiple of volume block "
3316 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3320 /* create the dataset */
3321 ret = lzc_create(path, ost, props);
3324 /* check for failure */
3326 char parent[ZFS_MAXNAMELEN];
3327 (void) parent_name(path, parent, sizeof (parent));
3331 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3332 "no such parent '%s'"), parent);
3333 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3336 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3337 "parent '%s' is not a filesystem"), parent);
3338 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3341 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3342 "pool must be upgraded to set this "
3343 "property or value"));
3344 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3348 * This platform can't address a volume this big.
3350 if (type == ZFS_TYPE_VOLUME)
3351 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3356 return (zfs_standard_error(hdl, errno, errbuf));
3364 * Destroys the given dataset. The caller must make sure that the filesystem
3365 * isn't mounted, and that there are no active dependents. If the file system
3366 * does not exist this function does nothing.
3369 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3371 zfs_cmd_t zc = { 0 };
3373 if (zhp->zfs_type == ZFS_TYPE_BOOKMARK) {
3374 nvlist_t *nv = fnvlist_alloc();
3375 fnvlist_add_boolean(nv, zhp->zfs_name);
3376 int error = lzc_destroy_bookmarks(nv, NULL);
3379 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3380 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3386 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3388 if (ZFS_IS_VOLUME(zhp)) {
3389 zc.zc_objset_type = DMU_OST_ZVOL;
3391 zc.zc_objset_type = DMU_OST_ZFS;
3394 zc.zc_defer_destroy = defer;
3395 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0 &&
3397 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3398 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3402 remove_mountpoint(zhp);
3407 struct destroydata {
3409 const char *snapname;
3413 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3415 struct destroydata *dd = arg;
3416 char name[ZFS_MAXNAMELEN];
3419 (void) snprintf(name, sizeof (name),
3420 "%s@%s", zhp->zfs_name, dd->snapname);
3422 if (lzc_exists(name))
3423 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3425 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3431 * Destroys all snapshots with the given name in zhp & descendants.
3434 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3437 struct destroydata dd = { 0 };
3439 dd.snapname = snapname;
3440 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3441 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3443 if (nvlist_empty(dd.nvl)) {
3444 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3445 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3446 zhp->zfs_name, snapname);
3448 ret = zfs_destroy_snaps_nvl(zhp->zfs_hdl, dd.nvl, defer);
3450 nvlist_free(dd.nvl);
3455 * Destroys all the snapshots named in the nvlist.
3458 zfs_destroy_snaps_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, boolean_t defer)
3461 nvlist_t *errlist = NULL;
3463 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3466 nvlist_free(errlist);
3470 if (nvlist_empty(errlist)) {
3472 (void) snprintf(errbuf, sizeof (errbuf),
3473 dgettext(TEXT_DOMAIN, "cannot destroy snapshots"));
3475 ret = zfs_standard_error(hdl, ret, errbuf);
3477 for (nvpair_t *pair = nvlist_next_nvpair(errlist, NULL);
3478 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3480 (void) snprintf(errbuf, sizeof (errbuf),
3481 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3484 switch (fnvpair_value_int32(pair)) {
3487 dgettext(TEXT_DOMAIN, "snapshot is cloned"));
3488 ret = zfs_error(hdl, EZFS_EXISTS, errbuf);
3491 ret = zfs_standard_error(hdl, errno, errbuf);
3496 nvlist_free(errlist);
3501 * Clones the given dataset. The target must be of the same type as the source.
3504 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3506 char parent[ZFS_MAXNAMELEN];
3509 libzfs_handle_t *hdl = zhp->zfs_hdl;
3512 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3514 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3515 "cannot create '%s'"), target);
3517 /* validate the target/clone name */
3518 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3519 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3521 /* validate parents exist */
3522 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3525 (void) parent_name(target, parent, sizeof (parent));
3531 if (ZFS_IS_VOLUME(zhp)) {
3532 type = ZFS_TYPE_VOLUME;
3534 type = ZFS_TYPE_FILESYSTEM;
3536 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3537 zhp, zhp->zpool_hdl, errbuf)) == NULL)
3541 ret = lzc_clone(target, zhp->zfs_name, props);
3549 * The parent doesn't exist. We should have caught this
3550 * above, but there may a race condition that has since
3551 * destroyed the parent.
3553 * At this point, we don't know whether it's the source
3554 * that doesn't exist anymore, or whether the target
3555 * dataset doesn't exist.
3557 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3558 "no such parent '%s'"), parent);
3559 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3562 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3563 "source and target pools differ"));
3564 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3568 return (zfs_standard_error(zhp->zfs_hdl, errno,
3577 * Promotes the given clone fs to be the clone parent.
3580 zfs_promote(zfs_handle_t *zhp)
3582 libzfs_handle_t *hdl = zhp->zfs_hdl;
3583 zfs_cmd_t zc = { 0 };
3584 char parent[MAXPATHLEN];
3588 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3589 "cannot promote '%s'"), zhp->zfs_name);
3591 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3592 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3593 "snapshots can not be promoted"));
3594 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3597 (void) strlcpy(parent, zhp->zfs_dmustats.dds_origin, sizeof (parent));
3598 if (parent[0] == '\0') {
3599 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3600 "not a cloned filesystem"));
3601 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3604 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_origin,
3605 sizeof (zc.zc_value));
3606 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3607 ret = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc);
3610 int save_errno = errno;
3612 switch (save_errno) {
3614 /* There is a conflicting snapshot name. */
3615 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3616 "conflicting snapshot '%s' from parent '%s'"),
3617 zc.zc_string, parent);
3618 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3621 return (zfs_standard_error(hdl, save_errno, errbuf));
3627 typedef struct snapdata {
3629 const char *sd_snapname;
3633 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
3635 snapdata_t *sd = arg;
3636 char name[ZFS_MAXNAMELEN];
3639 if (zfs_prop_get_int(zhp, ZFS_PROP_INCONSISTENT) == 0) {
3640 (void) snprintf(name, sizeof (name),
3641 "%s@%s", zfs_get_name(zhp), sd->sd_snapname);
3643 fnvlist_add_boolean(sd->sd_nvl, name);
3645 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
3653 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3657 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
3664 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3665 "cannot create snapshots "));
3668 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
3669 const char *snapname = nvpair_name(elem);
3671 /* validate the target name */
3672 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
3674 (void) snprintf(errbuf, sizeof (errbuf),
3675 dgettext(TEXT_DOMAIN,
3676 "cannot create snapshot '%s'"), snapname);
3677 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3682 * get pool handle for prop validation. assumes all snaps are in the
3683 * same pool, as does lzc_snapshot (below).
3685 char pool[MAXNAMELEN];
3686 elem = nvlist_next_nvpair(snaps, NULL);
3687 (void) strlcpy(pool, nvpair_name(elem), sizeof (pool));
3688 pool[strcspn(pool, "/@")] = '\0';
3689 zpool_handle_t *zpool_hdl = zpool_open(hdl, pool);
3691 if (props != NULL &&
3692 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3693 props, B_FALSE, NULL, zpool_hdl, errbuf)) == NULL) {
3694 zpool_close(zpool_hdl);
3697 zpool_close(zpool_hdl);
3699 ret = lzc_snapshot(snaps, props, &errors);
3702 boolean_t printed = B_FALSE;
3703 for (elem = nvlist_next_nvpair(errors, NULL);
3705 elem = nvlist_next_nvpair(errors, elem)) {
3706 (void) snprintf(errbuf, sizeof (errbuf),
3707 dgettext(TEXT_DOMAIN,
3708 "cannot create snapshot '%s'"), nvpair_name(elem));
3709 (void) zfs_standard_error(hdl,
3710 fnvpair_value_int32(elem), errbuf);
3716 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3717 "multiple snapshots of same "
3719 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3723 (void) zfs_standard_error(hdl, ret, errbuf);
3729 nvlist_free(errors);
3734 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3738 snapdata_t sd = { 0 };
3739 char fsname[ZFS_MAXNAMELEN];
3744 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3745 "cannot snapshot %s"), path);
3747 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3748 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3750 (void) strlcpy(fsname, path, sizeof (fsname));
3751 cp = strchr(fsname, '@');
3753 sd.sd_snapname = cp + 1;
3755 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
3756 ZFS_TYPE_VOLUME)) == NULL) {
3760 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
3762 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
3764 fnvlist_add_boolean(sd.sd_nvl, path);
3767 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
3768 nvlist_free(sd.sd_nvl);
3774 * Destroy any more recent snapshots. We invoke this callback on any dependents
3775 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3776 * is a dependent and we should just destroy it without checking the transaction
3779 typedef struct rollback_data {
3780 const char *cb_target; /* the snapshot */
3781 uint64_t cb_create; /* creation time reference */
3787 rollback_destroy_dependent(zfs_handle_t *zhp, void *data)
3789 rollback_data_t *cbp = data;
3790 prop_changelist_t *clp;
3792 /* We must destroy this clone; first unmount it */
3793 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3794 cbp->cb_force ? MS_FORCE: 0);
3795 if (clp == NULL || changelist_prefix(clp) != 0) {
3796 cbp->cb_error = B_TRUE;
3800 if (zfs_destroy(zhp, B_FALSE) != 0)
3801 cbp->cb_error = B_TRUE;
3803 changelist_remove(clp, zhp->zfs_name);
3804 (void) changelist_postfix(clp);
3805 changelist_free(clp);
3812 rollback_destroy(zfs_handle_t *zhp, void *data)
3814 rollback_data_t *cbp = data;
3816 if (zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > cbp->cb_create) {
3817 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3818 rollback_destroy_dependent, cbp);
3820 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3828 * Given a dataset, rollback to a specific snapshot, discarding any
3829 * data changes since then and making it the active dataset.
3831 * Any snapshots and bookmarks more recent than the target are
3832 * destroyed, along with their dependents (i.e. clones).
3835 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3837 rollback_data_t cb = { 0 };
3839 boolean_t restore_resv = 0;
3840 uint64_t old_volsize = 0, new_volsize;
3841 zfs_prop_t resv_prop;
3843 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3844 zhp->zfs_type == ZFS_TYPE_VOLUME);
3847 * Destroy all recent snapshots and their dependents.
3849 cb.cb_force = force;
3850 cb.cb_target = snap->zfs_name;
3851 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3852 (void) zfs_iter_snapshots(zhp, B_FALSE, rollback_destroy, &cb);
3853 (void) zfs_iter_bookmarks(zhp, rollback_destroy, &cb);
3859 * Now that we have verified that the snapshot is the latest,
3860 * rollback to the given snapshot.
3863 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
3864 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
3866 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3868 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
3872 * We rely on zfs_iter_children() to verify that there are no
3873 * newer snapshots for the given dataset. Therefore, we can
3874 * simply pass the name on to the ioctl() call. There is still
3875 * an unlikely race condition where the user has taken a
3876 * snapshot since we verified that this was the most recent.
3878 err = lzc_rollback(zhp->zfs_name, NULL, 0);
3880 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3881 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
3887 * For volumes, if the pre-rollback volsize matched the pre-
3888 * rollback reservation and the volsize has changed then set
3889 * the reservation property to the post-rollback volsize.
3890 * Make a new handle since the rollback closed the dataset.
3892 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
3893 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
3895 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3896 if (old_volsize != new_volsize)
3897 err = zfs_prop_set_int(zhp, resv_prop,
3906 * Renames the given dataset.
3909 zfs_rename(zfs_handle_t *zhp, const char *source, const char *target,
3910 renameflags_t flags)
3913 zfs_cmd_t zc = { 0 };
3915 prop_changelist_t *cl = NULL;
3916 zfs_handle_t *zhrp = NULL;
3917 char *parentname = NULL;
3918 char parent[ZFS_MAXNAMELEN];
3919 char property[ZFS_MAXPROPLEN];
3920 libzfs_handle_t *hdl = zhp->zfs_hdl;
3923 /* if we have the same exact name, just return success */
3924 if (strcmp(zhp->zfs_name, target) == 0)
3927 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3928 "cannot rename to '%s'"), target);
3930 if (source != NULL) {
3932 * This is recursive snapshots rename, put snapshot name
3933 * (that might not exist) into zfs_name.
3935 assert(flags.recurse);
3937 (void) strlcat(zhp->zfs_name, "@", sizeof(zhp->zfs_name));
3938 (void) strlcat(zhp->zfs_name, source, sizeof(zhp->zfs_name));
3939 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
3943 * Make sure the target name is valid
3945 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3946 if ((strchr(target, '@') == NULL) ||
3949 * Snapshot target name is abbreviated,
3950 * reconstruct full dataset name
3952 (void) strlcpy(parent, zhp->zfs_name,
3954 delim = strchr(parent, '@');
3955 if (strchr(target, '@') == NULL)
3959 (void) strlcat(parent, target, sizeof (parent));
3963 * Make sure we're renaming within the same dataset.
3965 delim = strchr(target, '@');
3966 if (strncmp(zhp->zfs_name, target, delim - target)
3967 != 0 || zhp->zfs_name[delim - target] != '@') {
3968 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3969 "snapshots must be part of same "
3971 return (zfs_error(hdl, EZFS_CROSSTARGET,
3975 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3976 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3978 if (flags.recurse) {
3979 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3980 "recursive rename must be a snapshot"));
3981 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3984 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3985 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3987 /* validate parents */
3988 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
3991 /* make sure we're in the same pool */
3992 verify((delim = strchr(target, '/')) != NULL);
3993 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
3994 zhp->zfs_name[delim - target] != '/') {
3995 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3996 "datasets must be within same pool"));
3997 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
4000 /* new name cannot be a child of the current dataset name */
4001 if (is_descendant(zhp->zfs_name, target)) {
4002 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4003 "New dataset name cannot be a descendant of "
4004 "current dataset name"));
4005 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
4009 (void) snprintf(errbuf, sizeof (errbuf),
4010 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
4012 if (getzoneid() == GLOBAL_ZONEID &&
4013 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
4014 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4015 "dataset is used in a non-global zone"));
4016 return (zfs_error(hdl, EZFS_ZONED, errbuf));
4020 * Avoid unmounting file systems with mountpoint property set to
4021 * 'legacy' or 'none' even if -u option is not given.
4023 if (zhp->zfs_type == ZFS_TYPE_FILESYSTEM &&
4024 !flags.recurse && !flags.nounmount &&
4025 zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, property,
4026 sizeof (property), NULL, NULL, 0, B_FALSE) == 0 &&
4027 (strcmp(property, "legacy") == 0 ||
4028 strcmp(property, "none") == 0)) {
4029 flags.nounmount = B_TRUE;
4031 if (flags.recurse) {
4033 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
4034 if (parentname == NULL) {
4038 delim = strchr(parentname, '@');
4040 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
4045 } else if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT) {
4046 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME,
4047 flags.nounmount ? CL_GATHER_DONT_UNMOUNT : 0,
4048 flags.forceunmount ? MS_FORCE : 0)) == NULL) {
4052 if (changelist_haszonedchild(cl)) {
4053 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4054 "child dataset with inherited mountpoint is used "
4055 "in a non-global zone"));
4056 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
4061 if ((ret = changelist_prefix(cl)) != 0)
4065 if (ZFS_IS_VOLUME(zhp))
4066 zc.zc_objset_type = DMU_OST_ZVOL;
4068 zc.zc_objset_type = DMU_OST_ZFS;
4070 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4071 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
4073 zc.zc_cookie = flags.recurse ? 1 : 0;
4074 if (flags.nounmount)
4077 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
4079 * if it was recursive, the one that actually failed will
4082 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4083 "cannot rename '%s'"), zc.zc_name);
4085 if (flags.recurse && errno == EEXIST) {
4086 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4087 "a child dataset already has a snapshot "
4088 "with the new name"));
4089 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
4091 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
4095 * On failure, we still want to remount any filesystems that
4096 * were previously mounted, so we don't alter the system state.
4099 (void) changelist_postfix(cl);
4102 changelist_rename(cl, zfs_get_name(zhp), target);
4103 ret = changelist_postfix(cl);
4108 if (parentname != NULL) {
4115 changelist_free(cl);
4121 zfs_get_user_props(zfs_handle_t *zhp)
4123 return (zhp->zfs_user_props);
4127 zfs_get_recvd_props(zfs_handle_t *zhp)
4129 if (zhp->zfs_recvd_props == NULL)
4130 if (get_recvd_props_ioctl(zhp) != 0)
4132 return (zhp->zfs_recvd_props);
4136 * This function is used by 'zfs list' to determine the exact set of columns to
4137 * display, and their maximum widths. This does two main things:
4139 * - If this is a list of all properties, then expand the list to include
4140 * all native properties, and set a flag so that for each dataset we look
4141 * for new unique user properties and add them to the list.
4143 * - For non fixed-width properties, keep track of the maximum width seen
4144 * so that we can size the column appropriately. If the user has
4145 * requested received property values, we also need to compute the width
4146 * of the RECEIVED column.
4149 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received,
4152 libzfs_handle_t *hdl = zhp->zfs_hdl;
4153 zprop_list_t *entry;
4154 zprop_list_t **last, **start;
4155 nvlist_t *userprops, *propval;
4158 char buf[ZFS_MAXPROPLEN];
4160 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
4163 userprops = zfs_get_user_props(zhp);
4166 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
4168 * Go through and add any user properties as necessary. We
4169 * start by incrementing our list pointer to the first
4170 * non-native property.
4173 while (*start != NULL) {
4174 if ((*start)->pl_prop == ZPROP_INVAL)
4176 start = &(*start)->pl_next;
4180 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
4182 * See if we've already found this property in our list.
4184 for (last = start; *last != NULL;
4185 last = &(*last)->pl_next) {
4186 if (strcmp((*last)->pl_user_prop,
4187 nvpair_name(elem)) == 0)
4191 if (*last == NULL) {
4192 if ((entry = zfs_alloc(hdl,
4193 sizeof (zprop_list_t))) == NULL ||
4194 ((entry->pl_user_prop = zfs_strdup(hdl,
4195 nvpair_name(elem)))) == NULL) {
4200 entry->pl_prop = ZPROP_INVAL;
4201 entry->pl_width = strlen(nvpair_name(elem));
4202 entry->pl_all = B_TRUE;
4209 * Now go through and check the width of any non-fixed columns
4211 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
4212 if (entry->pl_fixed && !literal)
4215 if (entry->pl_prop != ZPROP_INVAL) {
4216 if (zfs_prop_get(zhp, entry->pl_prop,
4217 buf, sizeof (buf), NULL, NULL, 0, literal) == 0) {
4218 if (strlen(buf) > entry->pl_width)
4219 entry->pl_width = strlen(buf);
4221 if (received && zfs_prop_get_recvd(zhp,
4222 zfs_prop_to_name(entry->pl_prop),
4223 buf, sizeof (buf), literal) == 0)
4224 if (strlen(buf) > entry->pl_recvd_width)
4225 entry->pl_recvd_width = strlen(buf);
4227 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
4229 verify(nvlist_lookup_string(propval,
4230 ZPROP_VALUE, &strval) == 0);
4231 if (strlen(strval) > entry->pl_width)
4232 entry->pl_width = strlen(strval);
4234 if (received && zfs_prop_get_recvd(zhp,
4235 entry->pl_user_prop,
4236 buf, sizeof (buf), literal) == 0)
4237 if (strlen(buf) > entry->pl_recvd_width)
4238 entry->pl_recvd_width = strlen(buf);
4246 zfs_deleg_share_nfs(libzfs_handle_t *hdl, char *dataset, char *path,
4247 char *resource, void *export, void *sharetab,
4248 int sharemax, zfs_share_op_t operation)
4250 zfs_cmd_t zc = { 0 };
4253 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4254 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4256 (void) strlcpy(zc.zc_string, resource, sizeof (zc.zc_string));
4257 zc.zc_share.z_sharedata = (uint64_t)(uintptr_t)sharetab;
4258 zc.zc_share.z_exportdata = (uint64_t)(uintptr_t)export;
4259 zc.zc_share.z_sharetype = operation;
4260 zc.zc_share.z_sharemax = sharemax;
4261 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SHARE, &zc);
4266 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
4271 * Keep a reference to the props-table against which we prune the
4274 zhp->zfs_props_table = props;
4276 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
4279 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
4280 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
4283 * User properties will result in ZPROP_INVAL, and since we
4284 * only know how to prune standard ZFS properties, we always
4285 * leave these in the list. This can also happen if we
4286 * encounter an unknown DSL property (when running older
4287 * software, for example).
4289 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
4290 (void) nvlist_remove(zhp->zfs_props,
4291 nvpair_name(curr), nvpair_type(curr));
4298 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
4299 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
4301 zfs_cmd_t zc = { 0 };
4302 nvlist_t *nvlist = NULL;
4305 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
4306 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
4307 zc.zc_cookie = (uint64_t)cmd;
4309 if (cmd == ZFS_SMB_ACL_RENAME) {
4310 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
4311 (void) no_memory(hdl);
4317 case ZFS_SMB_ACL_ADD:
4318 case ZFS_SMB_ACL_REMOVE:
4319 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4321 case ZFS_SMB_ACL_RENAME:
4322 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4324 (void) no_memory(hdl);
4327 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4329 (void) no_memory(hdl);
4332 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4333 nvlist_free(nvlist);
4337 case ZFS_SMB_ACL_PURGE:
4342 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4343 nvlist_free(nvlist);
4348 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4349 char *path, char *resource)
4351 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4356 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4357 char *path, char *resource)
4359 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4364 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4366 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4371 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4372 char *oldname, char *newname)
4374 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4377 #endif /* illumos */
4380 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4381 zfs_userspace_cb_t func, void *arg)
4383 zfs_cmd_t zc = { 0 };
4384 zfs_useracct_t buf[100];
4385 libzfs_handle_t *hdl = zhp->zfs_hdl;
4388 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4390 zc.zc_objset_type = type;
4391 zc.zc_nvlist_dst = (uintptr_t)buf;
4394 zfs_useracct_t *zua = buf;
4396 zc.zc_nvlist_dst_size = sizeof (buf);
4397 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4400 (void) snprintf(errbuf, sizeof (errbuf),
4401 dgettext(TEXT_DOMAIN,
4402 "cannot get used/quota for %s"), zc.zc_name);
4403 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4405 if (zc.zc_nvlist_dst_size == 0)
4408 while (zc.zc_nvlist_dst_size > 0) {
4409 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4410 zua->zu_space)) != 0)
4413 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4422 const char *snapname;
4424 boolean_t recursive;
4429 zfs_hold_one(zfs_handle_t *zhp, void *arg)
4431 struct holdarg *ha = arg;
4432 char name[ZFS_MAXNAMELEN];
4435 (void) snprintf(name, sizeof (name),
4436 "%s@%s", zhp->zfs_name, ha->snapname);
4438 if (lzc_exists(name))
4439 fnvlist_add_string(ha->nvl, name, ha->tag);
4442 rv = zfs_iter_filesystems(zhp, zfs_hold_one, ha);
4448 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4449 boolean_t recursive, int cleanup_fd)
4454 ha.nvl = fnvlist_alloc();
4455 ha.snapname = snapname;
4457 ha.recursive = recursive;
4458 (void) zfs_hold_one(zfs_handle_dup(zhp), &ha);
4460 if (nvlist_empty(ha.nvl)) {
4463 fnvlist_free(ha.nvl);
4465 (void) snprintf(errbuf, sizeof (errbuf),
4466 dgettext(TEXT_DOMAIN,
4467 "cannot hold snapshot '%s@%s'"),
4468 zhp->zfs_name, snapname);
4469 (void) zfs_standard_error(zhp->zfs_hdl, ret, errbuf);
4473 ret = zfs_hold_nvl(zhp, cleanup_fd, ha.nvl);
4474 fnvlist_free(ha.nvl);
4480 zfs_hold_nvl(zfs_handle_t *zhp, int cleanup_fd, nvlist_t *holds)
4484 libzfs_handle_t *hdl = zhp->zfs_hdl;
4489 ret = lzc_hold(holds, cleanup_fd, &errors);
4492 /* There may be errors even in the success case. */
4493 fnvlist_free(errors);
4497 if (nvlist_empty(errors)) {
4498 /* no hold-specific errors */
4499 (void) snprintf(errbuf, sizeof (errbuf),
4500 dgettext(TEXT_DOMAIN, "cannot hold"));
4503 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4504 "pool must be upgraded"));
4505 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4508 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4511 (void) zfs_standard_error(hdl, ret, errbuf);
4515 for (elem = nvlist_next_nvpair(errors, NULL);
4517 elem = nvlist_next_nvpair(errors, elem)) {
4518 (void) snprintf(errbuf, sizeof (errbuf),
4519 dgettext(TEXT_DOMAIN,
4520 "cannot hold snapshot '%s'"), nvpair_name(elem));
4521 switch (fnvpair_value_int32(elem)) {
4524 * Temporary tags wind up having the ds object id
4525 * prepended. So even if we passed the length check
4526 * above, it's still possible for the tag to wind
4527 * up being slightly too long.
4529 (void) zfs_error(hdl, EZFS_TAGTOOLONG, errbuf);
4532 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4535 (void) zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf);
4538 (void) zfs_standard_error(hdl,
4539 fnvpair_value_int32(elem), errbuf);
4543 fnvlist_free(errors);
4548 zfs_release_one(zfs_handle_t *zhp, void *arg)
4550 struct holdarg *ha = arg;
4551 char name[ZFS_MAXNAMELEN];
4553 nvlist_t *existing_holds;
4555 (void) snprintf(name, sizeof (name),
4556 "%s@%s", zhp->zfs_name, ha->snapname);
4558 if (lzc_get_holds(name, &existing_holds) != 0) {
4560 } else if (!nvlist_exists(existing_holds, ha->tag)) {
4563 nvlist_t *torelease = fnvlist_alloc();
4564 fnvlist_add_boolean(torelease, ha->tag);
4565 fnvlist_add_nvlist(ha->nvl, name, torelease);
4566 fnvlist_free(torelease);
4570 rv = zfs_iter_filesystems(zhp, zfs_release_one, ha);
4576 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4577 boolean_t recursive)
4581 nvlist_t *errors = NULL;
4583 libzfs_handle_t *hdl = zhp->zfs_hdl;
4586 ha.nvl = fnvlist_alloc();
4587 ha.snapname = snapname;
4589 ha.recursive = recursive;
4591 (void) zfs_release_one(zfs_handle_dup(zhp), &ha);
4593 if (nvlist_empty(ha.nvl)) {
4594 fnvlist_free(ha.nvl);
4596 (void) snprintf(errbuf, sizeof (errbuf),
4597 dgettext(TEXT_DOMAIN,
4598 "cannot release hold from snapshot '%s@%s'"),
4599 zhp->zfs_name, snapname);
4601 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4603 (void) zfs_standard_error(hdl, ret, errbuf);
4608 ret = lzc_release(ha.nvl, &errors);
4609 fnvlist_free(ha.nvl);
4612 /* There may be errors even in the success case. */
4613 fnvlist_free(errors);
4617 if (nvlist_empty(errors)) {
4618 /* no hold-specific errors */
4619 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4623 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4624 "pool must be upgraded"));
4625 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
4628 (void) zfs_standard_error_fmt(hdl, errno, errbuf);
4632 for (elem = nvlist_next_nvpair(errors, NULL);
4634 elem = nvlist_next_nvpair(errors, elem)) {
4635 (void) snprintf(errbuf, sizeof (errbuf),
4636 dgettext(TEXT_DOMAIN,
4637 "cannot release hold from snapshot '%s'"),
4639 switch (fnvpair_value_int32(elem)) {
4641 (void) zfs_error(hdl, EZFS_REFTAG_RELE, errbuf);
4644 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
4647 (void) zfs_standard_error_fmt(hdl,
4648 fnvpair_value_int32(elem), errbuf);
4652 fnvlist_free(errors);
4657 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4659 zfs_cmd_t zc = { 0 };
4660 libzfs_handle_t *hdl = zhp->zfs_hdl;
4666 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4667 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4671 nvbuf = malloc(nvsz);
4672 if (nvbuf == NULL) {
4673 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4677 zc.zc_nvlist_dst_size = nvsz;
4678 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4680 (void) strlcpy(zc.zc_name, zhp->zfs_name, ZFS_MAXNAMELEN);
4682 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4683 (void) snprintf(errbuf, sizeof (errbuf),
4684 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4689 nvsz = zc.zc_nvlist_dst_size;
4693 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4694 "pool must be upgraded"));
4695 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4698 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4701 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4704 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4709 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4711 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4712 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4714 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4724 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4726 zfs_cmd_t zc = { 0 };
4727 libzfs_handle_t *hdl = zhp->zfs_hdl;
4733 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4734 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4736 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
4739 nvbuf = malloc(nvsz);
4741 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
4744 zc.zc_nvlist_src_size = nvsz;
4745 zc.zc_nvlist_src = (uintptr_t)nvbuf;
4746 zc.zc_perm_action = un;
4748 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4750 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
4751 (void) snprintf(errbuf, sizeof (errbuf),
4752 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
4756 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4757 "pool must be upgraded"));
4758 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4761 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4764 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4767 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4778 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
4783 err = lzc_get_holds(zhp->zfs_name, nvl);
4786 libzfs_handle_t *hdl = zhp->zfs_hdl;
4788 (void) snprintf(errbuf, sizeof (errbuf),
4789 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4793 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4794 "pool must be upgraded"));
4795 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4798 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4801 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4804 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4813 * Convert the zvol's volume size to an appropriate reservation.
4814 * Note: If this routine is updated, it is necessary to update the ZFS test
4815 * suite's shell version in reservation.kshlib.
4818 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4821 uint64_t nblocks, volblocksize;
4825 if (nvlist_lookup_string(props,
4826 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4827 ncopies = atoi(strval);
4830 if (nvlist_lookup_uint64(props,
4831 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4832 &volblocksize) != 0)
4833 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4834 nblocks = volsize/volblocksize;
4835 /* start with metadnode L0-L6 */
4837 /* calculate number of indirects */
4838 while (nblocks > 1) {
4839 nblocks += DNODES_PER_LEVEL - 1;
4840 nblocks /= DNODES_PER_LEVEL;
4843 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4846 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4847 * compressed, but in practice they compress down to about
4850 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;
4856 * Attach/detach the given filesystem to/from the given jail.
4859 zfs_jail(zfs_handle_t *zhp, int jailid, int attach)
4861 libzfs_handle_t *hdl = zhp->zfs_hdl;
4862 zfs_cmd_t zc = { 0 };
4868 (void) snprintf(errbuf, sizeof (errbuf),
4869 dgettext(TEXT_DOMAIN, "cannot jail '%s'"), zhp->zfs_name);
4871 (void) snprintf(errbuf, sizeof (errbuf),
4872 dgettext(TEXT_DOMAIN, "cannot unjail '%s'"), zhp->zfs_name);
4875 switch (zhp->zfs_type) {
4876 case ZFS_TYPE_VOLUME:
4877 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4878 "volumes can not be jailed"));
4879 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4880 case ZFS_TYPE_SNAPSHOT:
4881 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4882 "snapshots can not be jailed"));
4883 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4885 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4887 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4888 zc.zc_objset_type = DMU_OST_ZFS;
4889 zc.zc_jailid = jailid;
4891 cmd = attach ? ZFS_IOC_JAIL : ZFS_IOC_UNJAIL;
4892 if ((ret = ioctl(hdl->libzfs_fd, cmd, &zc)) != 0)
4893 zfs_standard_error(hdl, errno, errbuf);