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 2019 Joyent, Inc.
25 * Copyright (c) 2011, 2020 by Delphix. All rights reserved.
26 * Copyright (c) 2012 DEY Storage Systems, Inc. All rights reserved.
27 * Copyright (c) 2012 Pawel Jakub Dawidek <pawel@dawidek.net>.
28 * Copyright (c) 2013 Martin Matuska. All rights reserved.
29 * Copyright (c) 2013 Steven Hartland. All rights reserved.
30 * Copyright 2017 Nexenta Systems, Inc.
31 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
32 * Copyright 2017-2018 RackTop Systems.
33 * Copyright (c) 2019 Datto Inc.
34 * Copyright (c) 2019, loli10K <ezomori.nozomu@gmail.com>
35 * Copyright (c) 2021 Matt Fiddaman
48 #include <sys/mntent.h>
49 #include <sys/mount.h>
56 #include <directory.h>
57 #endif /* HAVE_IDMAP */
59 #include <sys/dnode.h>
62 #include <sys/dsl_crypt.h>
66 #include "zfs_namecheck.h"
68 #include "libzfs_impl.h"
69 #include "zfs_deleg.h"
71 static int userquota_propname_decode(const char *propname
, boolean_t zoned
,
72 zfs_userquota_prop_t
*typep
, char *domain
, int domainlen
, uint64_t *ridp
);
75 * Given a single type (not a mask of types), return the type in a human
79 zfs_type_to_name(zfs_type_t type
)
82 case ZFS_TYPE_FILESYSTEM
:
83 return (dgettext(TEXT_DOMAIN
, "filesystem"));
84 case ZFS_TYPE_SNAPSHOT
:
85 return (dgettext(TEXT_DOMAIN
, "snapshot"));
87 return (dgettext(TEXT_DOMAIN
, "volume"));
89 return (dgettext(TEXT_DOMAIN
, "pool"));
90 case ZFS_TYPE_BOOKMARK
:
91 return (dgettext(TEXT_DOMAIN
, "bookmark"));
93 assert(!"unhandled zfs_type_t");
100 * Validate a ZFS path. This is used even before trying to open the dataset, to
101 * provide a more meaningful error message. We call zfs_error_aux() to
102 * explain exactly why the name was not valid.
105 zfs_validate_name(libzfs_handle_t
*hdl
, const char *path
, int type
,
111 if (!(type
& ZFS_TYPE_SNAPSHOT
) && strchr(path
, '@') != NULL
) {
113 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
114 "snapshot delimiter '@' is not expected here"));
118 if (type
== ZFS_TYPE_SNAPSHOT
&& strchr(path
, '@') == NULL
) {
120 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
121 "missing '@' delimiter in snapshot name"));
125 if (!(type
& ZFS_TYPE_BOOKMARK
) && strchr(path
, '#') != NULL
) {
127 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
128 "bookmark delimiter '#' is not expected here"));
132 if (type
== ZFS_TYPE_BOOKMARK
&& strchr(path
, '#') == NULL
) {
134 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
135 "missing '#' delimiter in bookmark name"));
139 if (modifying
&& strchr(path
, '%') != NULL
) {
141 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
142 "invalid character %c in name"), '%');
146 if (entity_namecheck(path
, &why
, &what
) != 0) {
149 case NAME_ERR_TOOLONG
:
150 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
151 "name is too long"));
154 case NAME_ERR_LEADING_SLASH
:
155 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
156 "leading slash in name"));
159 case NAME_ERR_EMPTY_COMPONENT
:
160 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
161 "empty component or misplaced '@'"
162 " or '#' delimiter in name"));
165 case NAME_ERR_TRAILING_SLASH
:
166 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
167 "trailing slash in name"));
170 case NAME_ERR_INVALCHAR
:
172 dgettext(TEXT_DOMAIN
, "invalid character "
173 "'%c' in name"), what
);
176 case NAME_ERR_MULTIPLE_DELIMITERS
:
177 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
178 "multiple '@' and/or '#' delimiters in "
182 case NAME_ERR_NOLETTER
:
183 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
184 "pool doesn't begin with a letter"));
187 case NAME_ERR_RESERVED
:
188 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
189 "name is reserved"));
192 case NAME_ERR_DISKLIKE
:
193 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
194 "reserved disk name"));
197 case NAME_ERR_SELF_REF
:
198 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
199 "self reference, '.' is found in name"));
202 case NAME_ERR_PARENT_REF
:
203 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
204 "parent reference, '..' is found in name"));
208 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
209 "(%d) not defined"), why
);
221 zfs_name_valid(const char *name
, zfs_type_t type
)
223 if (type
== ZFS_TYPE_POOL
)
224 return (zpool_name_valid(NULL
, B_FALSE
, name
));
225 return (zfs_validate_name(NULL
, name
, type
, B_FALSE
));
229 * This function takes the raw DSL properties, and filters out the user-defined
230 * properties into a separate nvlist.
233 process_user_props(zfs_handle_t
*zhp
, nvlist_t
*props
)
235 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
240 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0) {
241 (void) no_memory(hdl
);
246 while ((elem
= nvlist_next_nvpair(props
, elem
)) != NULL
) {
247 if (!zfs_prop_user(nvpair_name(elem
)))
250 verify(nvpair_value_nvlist(elem
, &propval
) == 0);
251 if (nvlist_add_nvlist(nvl
, nvpair_name(elem
), propval
) != 0) {
253 (void) no_memory(hdl
);
261 static zpool_handle_t
*
262 zpool_add_handle(zfs_handle_t
*zhp
, const char *pool_name
)
264 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
267 if ((zph
= zpool_open_canfail(hdl
, pool_name
)) != NULL
) {
268 if (hdl
->libzfs_pool_handles
!= NULL
)
269 zph
->zpool_next
= hdl
->libzfs_pool_handles
;
270 hdl
->libzfs_pool_handles
= zph
;
275 static zpool_handle_t
*
276 zpool_find_handle(zfs_handle_t
*zhp
, const char *pool_name
, int len
)
278 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
279 zpool_handle_t
*zph
= hdl
->libzfs_pool_handles
;
281 while ((zph
!= NULL
) &&
282 (strncmp(pool_name
, zpool_get_name(zph
), len
) != 0))
283 zph
= zph
->zpool_next
;
288 * Returns a handle to the pool that contains the provided dataset.
289 * If a handle to that pool already exists then that handle is returned.
290 * Otherwise, a new handle is created and added to the list of handles.
292 static zpool_handle_t
*
293 zpool_handle(zfs_handle_t
*zhp
)
299 len
= strcspn(zhp
->zfs_name
, "/@#") + 1;
300 pool_name
= zfs_alloc(zhp
->zfs_hdl
, len
);
301 (void) strlcpy(pool_name
, zhp
->zfs_name
, len
);
303 zph
= zpool_find_handle(zhp
, pool_name
, len
);
305 zph
= zpool_add_handle(zhp
, pool_name
);
312 zpool_free_handles(libzfs_handle_t
*hdl
)
314 zpool_handle_t
*next
, *zph
= hdl
->libzfs_pool_handles
;
316 while (zph
!= NULL
) {
317 next
= zph
->zpool_next
;
321 hdl
->libzfs_pool_handles
= NULL
;
325 * Utility function to gather stats (objset and zpl) for the given object.
328 get_stats_ioctl(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
330 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
332 (void) strlcpy(zc
->zc_name
, zhp
->zfs_name
, sizeof (zc
->zc_name
));
334 while (zfs_ioctl(hdl
, ZFS_IOC_OBJSET_STATS
, zc
) != 0) {
335 if (errno
== ENOMEM
) {
336 if (zcmd_expand_dst_nvlist(hdl
, zc
) != 0) {
347 * Utility function to get the received properties of the given object.
350 get_recvd_props_ioctl(zfs_handle_t
*zhp
)
352 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
353 nvlist_t
*recvdprops
;
354 zfs_cmd_t zc
= {"\0"};
357 if (zcmd_alloc_dst_nvlist(hdl
, &zc
, 0) != 0)
360 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
362 while (zfs_ioctl(hdl
, ZFS_IOC_OBJSET_RECVD_PROPS
, &zc
) != 0) {
363 if (errno
== ENOMEM
) {
364 if (zcmd_expand_dst_nvlist(hdl
, &zc
) != 0) {
368 zcmd_free_nvlists(&zc
);
373 err
= zcmd_read_dst_nvlist(zhp
->zfs_hdl
, &zc
, &recvdprops
);
374 zcmd_free_nvlists(&zc
);
378 nvlist_free(zhp
->zfs_recvd_props
);
379 zhp
->zfs_recvd_props
= recvdprops
;
385 put_stats_zhdl(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
387 nvlist_t
*allprops
, *userprops
;
389 zhp
->zfs_dmustats
= zc
->zc_objset_stats
; /* structure assignment */
391 if (zcmd_read_dst_nvlist(zhp
->zfs_hdl
, zc
, &allprops
) != 0) {
396 * XXX Why do we store the user props separately, in addition to
397 * storing them in zfs_props?
399 if ((userprops
= process_user_props(zhp
, allprops
)) == NULL
) {
400 nvlist_free(allprops
);
404 nvlist_free(zhp
->zfs_props
);
405 nvlist_free(zhp
->zfs_user_props
);
407 zhp
->zfs_props
= allprops
;
408 zhp
->zfs_user_props
= userprops
;
414 get_stats(zfs_handle_t
*zhp
)
417 zfs_cmd_t zc
= {"\0"};
419 if (zcmd_alloc_dst_nvlist(zhp
->zfs_hdl
, &zc
, 0) != 0)
421 if (get_stats_ioctl(zhp
, &zc
) != 0)
423 else if (put_stats_zhdl(zhp
, &zc
) != 0)
425 zcmd_free_nvlists(&zc
);
430 * Refresh the properties currently stored in the handle.
433 zfs_refresh_properties(zfs_handle_t
*zhp
)
435 (void) get_stats(zhp
);
439 * Makes a handle from the given dataset name. Used by zfs_open() and
440 * zfs_iter_* to create child handles on the fly.
443 make_dataset_handle_common(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
445 if (put_stats_zhdl(zhp
, zc
) != 0)
449 * We've managed to open the dataset and gather statistics. Determine
450 * the high-level type.
452 if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZVOL
)
453 zhp
->zfs_head_type
= ZFS_TYPE_VOLUME
;
454 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZFS
)
455 zhp
->zfs_head_type
= ZFS_TYPE_FILESYSTEM
;
456 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_OTHER
)
461 if (zhp
->zfs_dmustats
.dds_is_snapshot
)
462 zhp
->zfs_type
= ZFS_TYPE_SNAPSHOT
;
463 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZVOL
)
464 zhp
->zfs_type
= ZFS_TYPE_VOLUME
;
465 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZFS
)
466 zhp
->zfs_type
= ZFS_TYPE_FILESYSTEM
;
468 abort(); /* we should never see any other types */
470 if ((zhp
->zpool_hdl
= zpool_handle(zhp
)) == NULL
)
477 make_dataset_handle(libzfs_handle_t
*hdl
, const char *path
)
479 zfs_cmd_t zc
= {"\0"};
481 zfs_handle_t
*zhp
= calloc(1, sizeof (zfs_handle_t
));
487 (void) strlcpy(zhp
->zfs_name
, path
, sizeof (zhp
->zfs_name
));
488 if (zcmd_alloc_dst_nvlist(hdl
, &zc
, 0) != 0) {
492 if (get_stats_ioctl(zhp
, &zc
) == -1) {
493 zcmd_free_nvlists(&zc
);
497 if (make_dataset_handle_common(zhp
, &zc
) == -1) {
501 zcmd_free_nvlists(&zc
);
506 make_dataset_handle_zc(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
)
508 zfs_handle_t
*zhp
= calloc(1, sizeof (zfs_handle_t
));
514 (void) strlcpy(zhp
->zfs_name
, zc
->zc_name
, sizeof (zhp
->zfs_name
));
515 if (make_dataset_handle_common(zhp
, zc
) == -1) {
523 make_dataset_simple_handle_zc(zfs_handle_t
*pzhp
, zfs_cmd_t
*zc
)
525 zfs_handle_t
*zhp
= calloc(1, sizeof (zfs_handle_t
));
530 zhp
->zfs_hdl
= pzhp
->zfs_hdl
;
531 (void) strlcpy(zhp
->zfs_name
, zc
->zc_name
, sizeof (zhp
->zfs_name
));
532 zhp
->zfs_head_type
= pzhp
->zfs_type
;
533 zhp
->zfs_type
= ZFS_TYPE_SNAPSHOT
;
534 zhp
->zpool_hdl
= zpool_handle(zhp
);
540 zfs_handle_dup(zfs_handle_t
*zhp_orig
)
542 zfs_handle_t
*zhp
= calloc(1, sizeof (zfs_handle_t
));
547 zhp
->zfs_hdl
= zhp_orig
->zfs_hdl
;
548 zhp
->zpool_hdl
= zhp_orig
->zpool_hdl
;
549 (void) strlcpy(zhp
->zfs_name
, zhp_orig
->zfs_name
,
550 sizeof (zhp
->zfs_name
));
551 zhp
->zfs_type
= zhp_orig
->zfs_type
;
552 zhp
->zfs_head_type
= zhp_orig
->zfs_head_type
;
553 zhp
->zfs_dmustats
= zhp_orig
->zfs_dmustats
;
554 if (zhp_orig
->zfs_props
!= NULL
) {
555 if (nvlist_dup(zhp_orig
->zfs_props
, &zhp
->zfs_props
, 0) != 0) {
556 (void) no_memory(zhp
->zfs_hdl
);
561 if (zhp_orig
->zfs_user_props
!= NULL
) {
562 if (nvlist_dup(zhp_orig
->zfs_user_props
,
563 &zhp
->zfs_user_props
, 0) != 0) {
564 (void) no_memory(zhp
->zfs_hdl
);
569 if (zhp_orig
->zfs_recvd_props
!= NULL
) {
570 if (nvlist_dup(zhp_orig
->zfs_recvd_props
,
571 &zhp
->zfs_recvd_props
, 0)) {
572 (void) no_memory(zhp
->zfs_hdl
);
577 zhp
->zfs_mntcheck
= zhp_orig
->zfs_mntcheck
;
578 if (zhp_orig
->zfs_mntopts
!= NULL
) {
579 zhp
->zfs_mntopts
= zfs_strdup(zhp_orig
->zfs_hdl
,
580 zhp_orig
->zfs_mntopts
);
582 zhp
->zfs_props_table
= zhp_orig
->zfs_props_table
;
587 zfs_bookmark_exists(const char *path
)
591 char fsname
[ZFS_MAX_DATASET_NAME_LEN
];
597 (void) strlcpy(fsname
, path
, sizeof (fsname
));
598 pound
= strchr(fsname
, '#');
603 bmark_name
= pound
+ 1;
604 props
= fnvlist_alloc();
605 err
= lzc_get_bookmarks(fsname
, props
, &bmarks
);
612 rv
= nvlist_exists(bmarks
, bmark_name
);
618 make_bookmark_handle(zfs_handle_t
*parent
, const char *path
,
619 nvlist_t
*bmark_props
)
621 zfs_handle_t
*zhp
= calloc(1, sizeof (zfs_handle_t
));
626 /* Fill in the name. */
627 zhp
->zfs_hdl
= parent
->zfs_hdl
;
628 (void) strlcpy(zhp
->zfs_name
, path
, sizeof (zhp
->zfs_name
));
630 /* Set the property lists. */
631 if (nvlist_dup(bmark_props
, &zhp
->zfs_props
, 0) != 0) {
637 zhp
->zfs_head_type
= parent
->zfs_head_type
;
638 zhp
->zfs_type
= ZFS_TYPE_BOOKMARK
;
640 if ((zhp
->zpool_hdl
= zpool_handle(zhp
)) == NULL
) {
641 nvlist_free(zhp
->zfs_props
);
649 struct zfs_open_bookmarks_cb_data
{
655 zfs_open_bookmarks_cb(zfs_handle_t
*zhp
, void *data
)
657 struct zfs_open_bookmarks_cb_data
*dp
= data
;
660 * Is it the one we are looking for?
662 if (strcmp(dp
->path
, zfs_get_name(zhp
)) == 0) {
664 * We found it. Save it and let the caller know we are done.
671 * Not found. Close the handle and ask for another one.
678 * Opens the given snapshot, bookmark, filesystem, or volume. The 'types'
679 * argument is a mask of acceptable types. The function will print an
680 * appropriate error message and return NULL if it can't be opened.
683 zfs_open(libzfs_handle_t
*hdl
, const char *path
, int types
)
689 (void) snprintf(errbuf
, sizeof (errbuf
),
690 dgettext(TEXT_DOMAIN
, "cannot open '%s'"), path
);
693 * Validate the name before we even try to open it.
695 if (!zfs_validate_name(hdl
, path
, types
, B_FALSE
)) {
696 (void) zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
701 * Bookmarks needs to be handled separately.
703 bookp
= strchr(path
, '#');
706 * Try to get stats for the dataset, which will tell us if it
710 if ((zhp
= make_dataset_handle(hdl
, path
)) == NULL
) {
711 (void) zfs_standard_error(hdl
, errno
, errbuf
);
715 char dsname
[ZFS_MAX_DATASET_NAME_LEN
];
717 struct zfs_open_bookmarks_cb_data cb_data
= {path
, NULL
};
720 * We need to cut out '#' and everything after '#'
721 * to get the parent dataset name only.
723 assert(bookp
- path
< sizeof (dsname
));
724 (void) strncpy(dsname
, path
, bookp
- path
);
725 dsname
[bookp
- path
] = '\0';
728 * Create handle for the parent dataset.
731 if ((pzhp
= make_dataset_handle(hdl
, dsname
)) == NULL
) {
732 (void) zfs_standard_error(hdl
, errno
, errbuf
);
737 * Iterate bookmarks to find the right one.
740 if ((zfs_iter_bookmarks(pzhp
, zfs_open_bookmarks_cb
,
741 &cb_data
) == 0) && (cb_data
.zhp
== NULL
)) {
742 (void) zfs_error(hdl
, EZFS_NOENT
, errbuf
);
746 if (cb_data
.zhp
== NULL
) {
747 (void) zfs_standard_error(hdl
, errno
, errbuf
);
759 if (!(types
& zhp
->zfs_type
)) {
760 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
769 * Release a ZFS handle. Nothing to do but free the associated memory.
772 zfs_close(zfs_handle_t
*zhp
)
774 if (zhp
->zfs_mntopts
)
775 free(zhp
->zfs_mntopts
);
776 nvlist_free(zhp
->zfs_props
);
777 nvlist_free(zhp
->zfs_user_props
);
778 nvlist_free(zhp
->zfs_recvd_props
);
782 typedef struct mnttab_node
{
783 struct mnttab mtn_mt
;
788 libzfs_mnttab_cache_compare(const void *arg1
, const void *arg2
)
790 const mnttab_node_t
*mtn1
= (const mnttab_node_t
*)arg1
;
791 const mnttab_node_t
*mtn2
= (const mnttab_node_t
*)arg2
;
794 rv
= strcmp(mtn1
->mtn_mt
.mnt_special
, mtn2
->mtn_mt
.mnt_special
);
796 return (TREE_ISIGN(rv
));
800 libzfs_mnttab_init(libzfs_handle_t
*hdl
)
802 pthread_mutex_init(&hdl
->libzfs_mnttab_cache_lock
, NULL
);
803 assert(avl_numnodes(&hdl
->libzfs_mnttab_cache
) == 0);
804 avl_create(&hdl
->libzfs_mnttab_cache
, libzfs_mnttab_cache_compare
,
805 sizeof (mnttab_node_t
), offsetof(mnttab_node_t
, mtn_node
));
809 libzfs_mnttab_update(libzfs_handle_t
*hdl
)
814 if ((mnttab
= fopen(MNTTAB
, "re")) == NULL
)
817 while (getmntent(mnttab
, &entry
) == 0) {
821 if (strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0)
824 mtn
= zfs_alloc(hdl
, sizeof (mnttab_node_t
));
825 mtn
->mtn_mt
.mnt_special
= zfs_strdup(hdl
, entry
.mnt_special
);
826 mtn
->mtn_mt
.mnt_mountp
= zfs_strdup(hdl
, entry
.mnt_mountp
);
827 mtn
->mtn_mt
.mnt_fstype
= zfs_strdup(hdl
, entry
.mnt_fstype
);
828 mtn
->mtn_mt
.mnt_mntopts
= zfs_strdup(hdl
, entry
.mnt_mntopts
);
830 /* Exclude duplicate mounts */
831 if (avl_find(&hdl
->libzfs_mnttab_cache
, mtn
, &where
) != NULL
) {
832 free(mtn
->mtn_mt
.mnt_special
);
833 free(mtn
->mtn_mt
.mnt_mountp
);
834 free(mtn
->mtn_mt
.mnt_fstype
);
835 free(mtn
->mtn_mt
.mnt_mntopts
);
840 avl_add(&hdl
->libzfs_mnttab_cache
, mtn
);
843 (void) fclose(mnttab
);
848 libzfs_mnttab_fini(libzfs_handle_t
*hdl
)
853 while ((mtn
= avl_destroy_nodes(&hdl
->libzfs_mnttab_cache
, &cookie
))
855 free(mtn
->mtn_mt
.mnt_special
);
856 free(mtn
->mtn_mt
.mnt_mountp
);
857 free(mtn
->mtn_mt
.mnt_fstype
);
858 free(mtn
->mtn_mt
.mnt_mntopts
);
861 avl_destroy(&hdl
->libzfs_mnttab_cache
);
862 (void) pthread_mutex_destroy(&hdl
->libzfs_mnttab_cache_lock
);
866 libzfs_mnttab_cache(libzfs_handle_t
*hdl
, boolean_t enable
)
868 hdl
->libzfs_mnttab_enable
= enable
;
872 libzfs_mnttab_find(libzfs_handle_t
*hdl
, const char *fsname
,
873 struct mnttab
*entry
)
880 if (!hdl
->libzfs_mnttab_enable
) {
881 struct mnttab srch
= { 0 };
883 if (avl_numnodes(&hdl
->libzfs_mnttab_cache
))
884 libzfs_mnttab_fini(hdl
);
886 if ((mnttab
= fopen(MNTTAB
, "re")) == NULL
)
889 srch
.mnt_special
= (char *)fsname
;
890 srch
.mnt_fstype
= MNTTYPE_ZFS
;
891 ret
= getmntany(mnttab
, entry
, &srch
) ? ENOENT
: 0;
892 (void) fclose(mnttab
);
896 pthread_mutex_lock(&hdl
->libzfs_mnttab_cache_lock
);
897 if (avl_numnodes(&hdl
->libzfs_mnttab_cache
) == 0) {
900 if ((error
= libzfs_mnttab_update(hdl
)) != 0) {
901 pthread_mutex_unlock(&hdl
->libzfs_mnttab_cache_lock
);
906 find
.mtn_mt
.mnt_special
= (char *)fsname
;
907 mtn
= avl_find(&hdl
->libzfs_mnttab_cache
, &find
, NULL
);
909 *entry
= mtn
->mtn_mt
;
912 pthread_mutex_unlock(&hdl
->libzfs_mnttab_cache_lock
);
917 libzfs_mnttab_add(libzfs_handle_t
*hdl
, const char *special
,
918 const char *mountp
, const char *mntopts
)
922 pthread_mutex_lock(&hdl
->libzfs_mnttab_cache_lock
);
923 if (avl_numnodes(&hdl
->libzfs_mnttab_cache
) != 0) {
924 mtn
= zfs_alloc(hdl
, sizeof (mnttab_node_t
));
925 mtn
->mtn_mt
.mnt_special
= zfs_strdup(hdl
, special
);
926 mtn
->mtn_mt
.mnt_mountp
= zfs_strdup(hdl
, mountp
);
927 mtn
->mtn_mt
.mnt_fstype
= zfs_strdup(hdl
, MNTTYPE_ZFS
);
928 mtn
->mtn_mt
.mnt_mntopts
= zfs_strdup(hdl
, mntopts
);
930 * Another thread may have already added this entry
931 * via libzfs_mnttab_update. If so we should skip it.
933 if (avl_find(&hdl
->libzfs_mnttab_cache
, mtn
, NULL
) != NULL
) {
934 free(mtn
->mtn_mt
.mnt_special
);
935 free(mtn
->mtn_mt
.mnt_mountp
);
936 free(mtn
->mtn_mt
.mnt_fstype
);
937 free(mtn
->mtn_mt
.mnt_mntopts
);
940 avl_add(&hdl
->libzfs_mnttab_cache
, mtn
);
943 pthread_mutex_unlock(&hdl
->libzfs_mnttab_cache_lock
);
947 libzfs_mnttab_remove(libzfs_handle_t
*hdl
, const char *fsname
)
952 pthread_mutex_lock(&hdl
->libzfs_mnttab_cache_lock
);
953 find
.mtn_mt
.mnt_special
= (char *)fsname
;
954 if ((ret
= avl_find(&hdl
->libzfs_mnttab_cache
, (void *)&find
, NULL
))
956 avl_remove(&hdl
->libzfs_mnttab_cache
, ret
);
957 free(ret
->mtn_mt
.mnt_special
);
958 free(ret
->mtn_mt
.mnt_mountp
);
959 free(ret
->mtn_mt
.mnt_fstype
);
960 free(ret
->mtn_mt
.mnt_mntopts
);
963 pthread_mutex_unlock(&hdl
->libzfs_mnttab_cache_lock
);
967 zfs_spa_version(zfs_handle_t
*zhp
, int *spa_version
)
969 zpool_handle_t
*zpool_handle
= zhp
->zpool_hdl
;
971 if (zpool_handle
== NULL
)
974 *spa_version
= zpool_get_prop_int(zpool_handle
,
975 ZPOOL_PROP_VERSION
, NULL
);
980 * The choice of reservation property depends on the SPA version.
983 zfs_which_resv_prop(zfs_handle_t
*zhp
, zfs_prop_t
*resv_prop
)
987 if (zfs_spa_version(zhp
, &spa_version
) < 0)
990 if (spa_version
>= SPA_VERSION_REFRESERVATION
)
991 *resv_prop
= ZFS_PROP_REFRESERVATION
;
993 *resv_prop
= ZFS_PROP_RESERVATION
;
999 * Given an nvlist of properties to set, validates that they are correct, and
1000 * parses any numeric properties (index, boolean, etc) if they are specified as
1004 zfs_valid_proplist(libzfs_handle_t
*hdl
, zfs_type_t type
, nvlist_t
*nvl
,
1005 uint64_t zoned
, zfs_handle_t
*zhp
, zpool_handle_t
*zpool_hdl
,
1006 boolean_t key_params_ok
, const char *errbuf
)
1013 int chosen_normal
= -1;
1014 int chosen_utf
= -1;
1016 if (nvlist_alloc(&ret
, NV_UNIQUE_NAME
, 0) != 0) {
1017 (void) no_memory(hdl
);
1022 * Make sure this property is valid and applies to this type.
1026 while ((elem
= nvlist_next_nvpair(nvl
, elem
)) != NULL
) {
1027 const char *propname
= nvpair_name(elem
);
1029 prop
= zfs_name_to_prop(propname
);
1030 if (prop
== ZPROP_INVAL
&& zfs_prop_user(propname
)) {
1032 * This is a user property: make sure it's a
1033 * string, and that it's less than ZAP_MAXNAMELEN.
1035 if (nvpair_type(elem
) != DATA_TYPE_STRING
) {
1036 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1037 "'%s' must be a string"), propname
);
1038 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1042 if (strlen(nvpair_name(elem
)) >= ZAP_MAXNAMELEN
) {
1043 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1044 "property name '%s' is too long"),
1046 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1050 (void) nvpair_value_string(elem
, &strval
);
1051 if (nvlist_add_string(ret
, propname
, strval
) != 0) {
1052 (void) no_memory(hdl
);
1059 * Currently, only user properties can be modified on
1062 if (type
== ZFS_TYPE_SNAPSHOT
) {
1063 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1064 "this property can not be modified for snapshots"));
1065 (void) zfs_error(hdl
, EZFS_PROPTYPE
, errbuf
);
1069 if (prop
== ZPROP_INVAL
&& zfs_prop_userquota(propname
)) {
1070 zfs_userquota_prop_t uqtype
;
1071 char *newpropname
= NULL
;
1077 if (userquota_propname_decode(propname
, zoned
,
1078 &uqtype
, domain
, sizeof (domain
), &rid
) != 0) {
1080 dgettext(TEXT_DOMAIN
,
1081 "'%s' has an invalid user/group name"),
1083 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1087 if (uqtype
!= ZFS_PROP_USERQUOTA
&&
1088 uqtype
!= ZFS_PROP_GROUPQUOTA
&&
1089 uqtype
!= ZFS_PROP_USEROBJQUOTA
&&
1090 uqtype
!= ZFS_PROP_GROUPOBJQUOTA
&&
1091 uqtype
!= ZFS_PROP_PROJECTQUOTA
&&
1092 uqtype
!= ZFS_PROP_PROJECTOBJQUOTA
) {
1094 dgettext(TEXT_DOMAIN
, "'%s' is readonly"),
1096 (void) zfs_error(hdl
, EZFS_PROPREADONLY
,
1101 if (nvpair_type(elem
) == DATA_TYPE_STRING
) {
1102 (void) nvpair_value_string(elem
, &strval
);
1103 if (strcmp(strval
, "none") == 0) {
1105 } else if (zfs_nicestrtonum(hdl
,
1106 strval
, &intval
) != 0) {
1107 (void) zfs_error(hdl
,
1108 EZFS_BADPROP
, errbuf
);
1111 } else if (nvpair_type(elem
) ==
1113 (void) nvpair_value_uint64(elem
, &intval
);
1115 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1116 "use 'none' to disable "
1117 "{user|group|project}quota"));
1121 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1122 "'%s' must be a number"), propname
);
1123 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1128 * Encode the prop name as
1129 * userquota@<hex-rid>-domain, to make it easy
1130 * for the kernel to decode.
1132 rc
= asprintf(&newpropname
, "%s%llx-%s",
1133 zfs_userquota_prop_prefixes
[uqtype
],
1134 (longlong_t
)rid
, domain
);
1135 if (rc
== -1 || newpropname
== NULL
) {
1136 (void) no_memory(hdl
);
1143 if (nvlist_add_uint64_array(ret
, newpropname
,
1146 (void) no_memory(hdl
);
1151 } else if (prop
== ZPROP_INVAL
&& zfs_prop_written(propname
)) {
1152 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1153 "'%s' is readonly"),
1155 (void) zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
);
1159 if (prop
== ZPROP_INVAL
) {
1160 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1161 "invalid property '%s'"), propname
);
1162 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1166 if (!zfs_prop_valid_for_type(prop
, type
, B_FALSE
)) {
1168 dgettext(TEXT_DOMAIN
, "'%s' does not "
1169 "apply to datasets of this type"), propname
);
1170 (void) zfs_error(hdl
, EZFS_PROPTYPE
, errbuf
);
1174 if (zfs_prop_readonly(prop
) &&
1175 !(zfs_prop_setonce(prop
) && zhp
== NULL
) &&
1176 !(zfs_prop_encryption_key_param(prop
) && key_params_ok
)) {
1178 dgettext(TEXT_DOMAIN
, "'%s' is readonly"),
1180 (void) zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
);
1184 if (zprop_parse_value(hdl
, elem
, prop
, type
, ret
,
1185 &strval
, &intval
, errbuf
) != 0)
1189 * Perform some additional checks for specific properties.
1192 case ZFS_PROP_VERSION
:
1198 version
= zfs_prop_get_int(zhp
, ZFS_PROP_VERSION
);
1199 if (intval
< version
) {
1200 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1201 "Can not downgrade; already at version %u"),
1203 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1209 case ZFS_PROP_VOLBLOCKSIZE
:
1210 case ZFS_PROP_RECORDSIZE
:
1212 int maxbs
= SPA_MAXBLOCKSIZE
;
1215 if (zpool_hdl
!= NULL
) {
1216 maxbs
= zpool_get_prop_int(zpool_hdl
,
1217 ZPOOL_PROP_MAXBLOCKSIZE
, NULL
);
1220 * The value must be a power of two between
1221 * SPA_MINBLOCKSIZE and maxbs.
1223 if (intval
< SPA_MINBLOCKSIZE
||
1224 intval
> maxbs
|| !ISP2(intval
)) {
1225 zfs_nicebytes(maxbs
, buf
, sizeof (buf
));
1226 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1227 "'%s' must be power of 2 from 512B "
1228 "to %s"), propname
, buf
);
1229 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1235 case ZFS_PROP_SPECIAL_SMALL_BLOCKS
:
1237 int maxbs
= SPA_OLD_MAXBLOCKSIZE
;
1240 if (zpool_hdl
!= NULL
) {
1241 char state
[64] = "";
1243 maxbs
= zpool_get_prop_int(zpool_hdl
,
1244 ZPOOL_PROP_MAXBLOCKSIZE
, NULL
);
1247 * Issue a warning but do not fail so that
1248 * tests for settable properties succeed.
1250 if (zpool_prop_get_feature(zpool_hdl
,
1251 "feature@allocation_classes", state
,
1252 sizeof (state
)) != 0 ||
1253 strcmp(state
, ZFS_FEATURE_ACTIVE
) != 0) {
1254 (void) fprintf(stderr
, gettext(
1255 "%s: property requires a special "
1256 "device in the pool\n"), propname
);
1260 (intval
< SPA_MINBLOCKSIZE
||
1261 intval
> maxbs
|| !ISP2(intval
))) {
1262 zfs_nicebytes(maxbs
, buf
, sizeof (buf
));
1263 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1264 "invalid '%s=%llu' property: must be zero "
1265 "or a power of 2 from 512B to %s"),
1266 propname
, (unsigned long long)intval
, buf
);
1267 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1273 case ZFS_PROP_MLSLABEL
:
1275 #ifdef HAVE_MLSLABEL
1277 * Verify the mlslabel string and convert to
1278 * internal hex label string.
1282 char *hex
= NULL
; /* internal label string */
1284 /* Default value is already OK. */
1285 if (strcasecmp(strval
, ZFS_MLSLABEL_DEFAULT
) == 0)
1288 /* Verify the label can be converted to binary form */
1289 if (((new_sl
= m_label_alloc(MAC_LABEL
)) == NULL
) ||
1290 (str_to_label(strval
, &new_sl
, MAC_LABEL
,
1291 L_NO_CORRECTION
, NULL
) == -1)) {
1295 /* Now translate to hex internal label string */
1296 if (label_to_str(new_sl
, &hex
, M_INTERNAL
,
1302 m_label_free(new_sl
);
1304 /* If string is already in internal form, we're done. */
1305 if (strcmp(strval
, hex
) == 0) {
1310 /* Replace the label string with the internal form. */
1311 (void) nvlist_remove(ret
, zfs_prop_to_name(prop
),
1313 verify(nvlist_add_string(ret
, zfs_prop_to_name(prop
),
1320 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1321 "invalid mlslabel '%s'"), strval
);
1322 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1323 m_label_free(new_sl
); /* OK if null */
1326 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1327 "mlslabels are unsupported"));
1328 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1330 #endif /* HAVE_MLSLABEL */
1333 case ZFS_PROP_MOUNTPOINT
:
1335 namecheck_err_t why
;
1337 if (strcmp(strval
, ZFS_MOUNTPOINT_NONE
) == 0 ||
1338 strcmp(strval
, ZFS_MOUNTPOINT_LEGACY
) == 0)
1341 if (mountpoint_namecheck(strval
, &why
)) {
1343 case NAME_ERR_LEADING_SLASH
:
1345 dgettext(TEXT_DOMAIN
,
1346 "'%s' must be an absolute path, "
1347 "'none', or 'legacy'"), propname
);
1349 case NAME_ERR_TOOLONG
:
1351 dgettext(TEXT_DOMAIN
,
1352 "component of '%s' is too long"),
1358 dgettext(TEXT_DOMAIN
,
1359 "(%d) not defined"),
1363 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1369 case ZFS_PROP_SHARESMB
:
1370 case ZFS_PROP_SHARENFS
:
1372 * For the mountpoint and sharenfs or sharesmb
1373 * properties, check if it can be set in a
1374 * global/non-global zone based on
1375 * the zoned property value:
1377 * global zone non-global zone
1378 * --------------------------------------------------
1379 * zoned=on mountpoint (no) mountpoint (yes)
1380 * sharenfs (no) sharenfs (no)
1381 * sharesmb (no) sharesmb (no)
1383 * zoned=off mountpoint (yes) N/A
1388 if (getzoneid() == GLOBAL_ZONEID
) {
1389 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1390 "'%s' cannot be set on "
1391 "dataset in a non-global zone"),
1393 (void) zfs_error(hdl
, EZFS_ZONED
,
1396 } else if (prop
== ZFS_PROP_SHARENFS
||
1397 prop
== ZFS_PROP_SHARESMB
) {
1398 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1399 "'%s' cannot be set in "
1400 "a non-global zone"), propname
);
1401 (void) zfs_error(hdl
, EZFS_ZONED
,
1405 } else if (getzoneid() != GLOBAL_ZONEID
) {
1407 * If zoned property is 'off', this must be in
1408 * a global zone. If not, something is wrong.
1410 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1411 "'%s' cannot be set while dataset "
1412 "'zoned' property is set"), propname
);
1413 (void) zfs_error(hdl
, EZFS_ZONED
, errbuf
);
1418 * At this point, it is legitimate to set the
1419 * property. Now we want to make sure that the
1420 * property value is valid if it is sharenfs.
1422 if ((prop
== ZFS_PROP_SHARENFS
||
1423 prop
== ZFS_PROP_SHARESMB
) &&
1424 strcmp(strval
, "on") != 0 &&
1425 strcmp(strval
, "off") != 0) {
1426 zfs_share_proto_t proto
;
1428 if (prop
== ZFS_PROP_SHARESMB
)
1433 if (zfs_parse_options(strval
, proto
) != SA_OK
) {
1434 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1435 "'%s' cannot be set to invalid "
1436 "options"), propname
);
1437 (void) zfs_error(hdl
, EZFS_BADPROP
,
1445 case ZFS_PROP_KEYLOCATION
:
1446 if (!zfs_prop_valid_keylocation(strval
, B_FALSE
)) {
1447 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1448 "invalid keylocation"));
1449 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1455 zfs_prop_get_int(zhp
, ZFS_PROP_ENCRYPTION
);
1457 if (crypt
== ZIO_CRYPT_OFF
&&
1458 strcmp(strval
, "none") != 0) {
1459 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1460 "keylocation must be 'none' "
1461 "for unencrypted datasets"));
1462 (void) zfs_error(hdl
, EZFS_BADPROP
,
1465 } else if (crypt
!= ZIO_CRYPT_OFF
&&
1466 strcmp(strval
, "none") == 0) {
1467 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1468 "keylocation must not be 'none' "
1469 "for encrypted datasets"));
1470 (void) zfs_error(hdl
, EZFS_BADPROP
,
1477 case ZFS_PROP_PBKDF2_ITERS
:
1478 if (intval
< MIN_PBKDF2_ITERATIONS
) {
1479 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1480 "minimum pbkdf2 iterations is %u"),
1481 MIN_PBKDF2_ITERATIONS
);
1482 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1487 case ZFS_PROP_UTF8ONLY
:
1488 chosen_utf
= (int)intval
;
1491 case ZFS_PROP_NORMALIZE
:
1492 chosen_normal
= (int)intval
;
1500 * For changes to existing volumes, we have some additional
1501 * checks to enforce.
1503 if (type
== ZFS_TYPE_VOLUME
&& zhp
!= NULL
) {
1504 uint64_t blocksize
= zfs_prop_get_int(zhp
,
1505 ZFS_PROP_VOLBLOCKSIZE
);
1509 case ZFS_PROP_VOLSIZE
:
1510 if (intval
% blocksize
!= 0) {
1511 zfs_nicebytes(blocksize
, buf
,
1513 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1514 "'%s' must be a multiple of "
1515 "volume block size (%s)"),
1517 (void) zfs_error(hdl
, EZFS_BADPROP
,
1523 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1524 "'%s' cannot be zero"),
1526 (void) zfs_error(hdl
, EZFS_BADPROP
,
1537 /* check encryption properties */
1539 int64_t crypt
= zfs_prop_get_int(zhp
,
1540 ZFS_PROP_ENCRYPTION
);
1543 case ZFS_PROP_COPIES
:
1544 if (crypt
!= ZIO_CRYPT_OFF
&& intval
> 2) {
1545 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1546 "encrypted datasets cannot have "
1548 (void) zfs_error(hdl
, EZFS_BADPROP
,
1560 * If normalization was chosen, but no UTF8 choice was made,
1561 * enforce rejection of non-UTF8 names.
1563 * If normalization was chosen, but rejecting non-UTF8 names
1564 * was explicitly not chosen, it is an error.
1566 if (chosen_normal
> 0 && chosen_utf
< 0) {
1567 if (nvlist_add_uint64(ret
,
1568 zfs_prop_to_name(ZFS_PROP_UTF8ONLY
), 1) != 0) {
1569 (void) no_memory(hdl
);
1572 } else if (chosen_normal
> 0 && chosen_utf
== 0) {
1573 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1574 "'%s' must be set 'on' if normalization chosen"),
1575 zfs_prop_to_name(ZFS_PROP_UTF8ONLY
));
1576 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1587 zfs_add_synthetic_resv(zfs_handle_t
*zhp
, nvlist_t
*nvl
)
1589 uint64_t old_volsize
;
1590 uint64_t new_volsize
;
1591 uint64_t old_reservation
;
1592 uint64_t new_reservation
;
1593 zfs_prop_t resv_prop
;
1595 zpool_handle_t
*zph
= zpool_handle(zhp
);
1598 * If this is an existing volume, and someone is setting the volsize,
1599 * make sure that it matches the reservation, or add it if necessary.
1601 old_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
1602 if (zfs_which_resv_prop(zhp
, &resv_prop
) < 0)
1604 old_reservation
= zfs_prop_get_int(zhp
, resv_prop
);
1606 props
= fnvlist_alloc();
1607 fnvlist_add_uint64(props
, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
1608 zfs_prop_get_int(zhp
, ZFS_PROP_VOLBLOCKSIZE
));
1610 if ((zvol_volsize_to_reservation(zph
, old_volsize
, props
) !=
1611 old_reservation
) || nvlist_exists(nvl
,
1612 zfs_prop_to_name(resv_prop
))) {
1613 fnvlist_free(props
);
1616 if (nvlist_lookup_uint64(nvl
, zfs_prop_to_name(ZFS_PROP_VOLSIZE
),
1617 &new_volsize
) != 0) {
1618 fnvlist_free(props
);
1621 new_reservation
= zvol_volsize_to_reservation(zph
, new_volsize
, props
);
1622 fnvlist_free(props
);
1624 if (nvlist_add_uint64(nvl
, zfs_prop_to_name(resv_prop
),
1625 new_reservation
) != 0) {
1626 (void) no_memory(zhp
->zfs_hdl
);
1633 * Helper for 'zfs {set|clone} refreservation=auto'. Must be called after
1634 * zfs_valid_proplist(), as it is what sets the UINT64_MAX sentinel value.
1635 * Return codes must match zfs_add_synthetic_resv().
1638 zfs_fix_auto_resv(zfs_handle_t
*zhp
, nvlist_t
*nvl
)
1645 if (!ZFS_IS_VOLUME(zhp
)) {
1649 if (zfs_which_resv_prop(zhp
, &prop
) != 0) {
1653 if (prop
!= ZFS_PROP_REFRESERVATION
) {
1657 if (nvlist_lookup_uint64(nvl
, zfs_prop_to_name(prop
), &resvsize
) != 0) {
1658 /* No value being set, so it can't be "auto" */
1661 if (resvsize
!= UINT64_MAX
) {
1662 /* Being set to a value other than "auto" */
1666 props
= fnvlist_alloc();
1668 fnvlist_add_uint64(props
, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
1669 zfs_prop_get_int(zhp
, ZFS_PROP_VOLBLOCKSIZE
));
1671 if (nvlist_lookup_uint64(nvl
, zfs_prop_to_name(ZFS_PROP_VOLSIZE
),
1673 volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
1676 resvsize
= zvol_volsize_to_reservation(zpool_handle(zhp
), volsize
,
1678 fnvlist_free(props
);
1680 (void) nvlist_remove_all(nvl
, zfs_prop_to_name(prop
));
1681 if (nvlist_add_uint64(nvl
, zfs_prop_to_name(prop
), resvsize
) != 0) {
1682 (void) no_memory(zhp
->zfs_hdl
);
1689 zfs_is_namespace_prop(zfs_prop_t prop
)
1693 case ZFS_PROP_ATIME
:
1694 case ZFS_PROP_RELATIME
:
1695 case ZFS_PROP_DEVICES
:
1697 case ZFS_PROP_SETUID
:
1698 case ZFS_PROP_READONLY
:
1699 case ZFS_PROP_XATTR
:
1700 case ZFS_PROP_NBMAND
:
1709 * Given a property name and value, set the property for the given dataset.
1712 zfs_prop_set(zfs_handle_t
*zhp
, const char *propname
, const char *propval
)
1716 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1717 nvlist_t
*nvl
= NULL
;
1719 (void) snprintf(errbuf
, sizeof (errbuf
),
1720 dgettext(TEXT_DOMAIN
, "cannot set property for '%s'"),
1723 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0 ||
1724 nvlist_add_string(nvl
, propname
, propval
) != 0) {
1725 (void) no_memory(hdl
);
1729 ret
= zfs_prop_set_list(zhp
, nvl
);
1739 * Given an nvlist of property names and values, set the properties for the
1743 zfs_prop_set_list(zfs_handle_t
*zhp
, nvlist_t
*props
)
1745 zfs_cmd_t zc
= {"\0"};
1747 prop_changelist_t
**cls
= NULL
;
1750 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1754 zfs_prop_t prop
= 0;
1757 (void) snprintf(errbuf
, sizeof (errbuf
),
1758 dgettext(TEXT_DOMAIN
, "cannot set property for '%s'"),
1761 if ((nvl
= zfs_valid_proplist(hdl
, zhp
->zfs_type
, props
,
1762 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
), zhp
, zhp
->zpool_hdl
,
1763 B_FALSE
, errbuf
)) == NULL
)
1767 * We have to check for any extra properties which need to be added
1768 * before computing the length of the nvlist.
1770 for (elem
= nvlist_next_nvpair(nvl
, NULL
);
1772 elem
= nvlist_next_nvpair(nvl
, elem
)) {
1773 if (zfs_name_to_prop(nvpair_name(elem
)) == ZFS_PROP_VOLSIZE
&&
1774 (added_resv
= zfs_add_synthetic_resv(zhp
, nvl
)) == -1) {
1779 if (added_resv
!= 1 &&
1780 (added_resv
= zfs_fix_auto_resv(zhp
, nvl
)) == -1) {
1785 * Check how many properties we're setting and allocate an array to
1786 * store changelist pointers for postfix().
1788 for (elem
= nvlist_next_nvpair(nvl
, NULL
);
1790 elem
= nvlist_next_nvpair(nvl
, elem
))
1792 if ((cls
= calloc(nvl_len
, sizeof (prop_changelist_t
*))) == NULL
)
1796 for (elem
= nvlist_next_nvpair(nvl
, NULL
);
1798 elem
= nvlist_next_nvpair(nvl
, elem
)) {
1800 prop
= zfs_name_to_prop(nvpair_name(elem
));
1802 assert(cl_idx
< nvl_len
);
1804 * We don't want to unmount & remount the dataset when changing
1805 * its canmount property to 'on' or 'noauto'. We only use
1806 * the changelist logic to unmount when setting canmount=off.
1808 if (prop
!= ZFS_PROP_CANMOUNT
||
1809 (fnvpair_value_uint64(elem
) == ZFS_CANMOUNT_OFF
&&
1810 zfs_is_mounted(zhp
, NULL
))) {
1811 cls
[cl_idx
] = changelist_gather(zhp
, prop
, 0, 0);
1812 if (cls
[cl_idx
] == NULL
)
1816 if (prop
== ZFS_PROP_MOUNTPOINT
&&
1817 changelist_haszonedchild(cls
[cl_idx
])) {
1818 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1819 "child dataset with inherited mountpoint is used "
1820 "in a non-global zone"));
1821 ret
= zfs_error(hdl
, EZFS_ZONED
, errbuf
);
1825 if (cls
[cl_idx
] != NULL
&&
1826 (ret
= changelist_prefix(cls
[cl_idx
])) != 0)
1831 assert(cl_idx
== nvl_len
);
1834 * Execute the corresponding ioctl() to set this list of properties.
1836 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1838 if ((ret
= zcmd_write_src_nvlist(hdl
, &zc
, nvl
)) != 0 ||
1839 (ret
= zcmd_alloc_dst_nvlist(hdl
, &zc
, 0)) != 0)
1842 ret
= zfs_ioctl(hdl
, ZFS_IOC_SET_PROP
, &zc
);
1845 if (zc
.zc_nvlist_dst_filled
== B_FALSE
) {
1846 (void) zfs_standard_error(hdl
, errno
, errbuf
);
1850 /* Get the list of unset properties back and report them. */
1851 nvlist_t
*errorprops
= NULL
;
1852 if (zcmd_read_dst_nvlist(hdl
, &zc
, &errorprops
) != 0)
1854 for (nvpair_t
*elem
= nvlist_next_nvpair(errorprops
, NULL
);
1856 elem
= nvlist_next_nvpair(errorprops
, elem
)) {
1857 prop
= zfs_name_to_prop(nvpair_name(elem
));
1858 zfs_setprop_error(hdl
, prop
, errno
, errbuf
);
1860 nvlist_free(errorprops
);
1862 if (added_resv
&& errno
== ENOSPC
) {
1863 /* clean up the volsize property we tried to set */
1864 uint64_t old_volsize
= zfs_prop_get_int(zhp
,
1868 zcmd_free_nvlists(&zc
);
1870 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0)
1872 if (nvlist_add_uint64(nvl
,
1873 zfs_prop_to_name(ZFS_PROP_VOLSIZE
),
1876 if (zcmd_write_src_nvlist(hdl
, &zc
, nvl
) != 0)
1878 (void) zfs_ioctl(hdl
, ZFS_IOC_SET_PROP
, &zc
);
1881 for (cl_idx
= 0; cl_idx
< nvl_len
; cl_idx
++) {
1882 if (cls
[cl_idx
] != NULL
) {
1883 int clp_err
= changelist_postfix(cls
[cl_idx
]);
1891 * Refresh the statistics so the new property
1892 * value is reflected.
1894 (void) get_stats(zhp
);
1897 * Remount the filesystem to propagate the change
1898 * if one of the options handled by the generic
1899 * Linux namespace layer has been modified.
1901 if (zfs_is_namespace_prop(prop
) &&
1902 zfs_is_mounted(zhp
, NULL
))
1903 ret
= zfs_mount(zhp
, MNTOPT_REMOUNT
, 0);
1909 zcmd_free_nvlists(&zc
);
1911 for (cl_idx
= 0; cl_idx
< nvl_len
; cl_idx
++) {
1912 if (cls
[cl_idx
] != NULL
)
1913 changelist_free(cls
[cl_idx
]);
1921 * Given a property, inherit the value from the parent dataset, or if received
1922 * is TRUE, revert to the received value, if any.
1925 zfs_prop_inherit(zfs_handle_t
*zhp
, const char *propname
, boolean_t received
)
1927 zfs_cmd_t zc
= {"\0"};
1929 prop_changelist_t
*cl
;
1930 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1934 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1935 "cannot inherit %s for '%s'"), propname
, zhp
->zfs_name
);
1937 zc
.zc_cookie
= received
;
1938 if ((prop
= zfs_name_to_prop(propname
)) == ZPROP_INVAL
) {
1940 * For user properties, the amount of work we have to do is very
1941 * small, so just do it here.
1943 if (!zfs_prop_user(propname
)) {
1944 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1945 "invalid property"));
1946 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
1949 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1950 (void) strlcpy(zc
.zc_value
, propname
, sizeof (zc
.zc_value
));
1952 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_INHERIT_PROP
, &zc
) != 0)
1953 return (zfs_standard_error(hdl
, errno
, errbuf
));
1955 (void) get_stats(zhp
);
1960 * Verify that this property is inheritable.
1962 if (zfs_prop_readonly(prop
))
1963 return (zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
));
1965 if (!zfs_prop_inheritable(prop
) && !received
)
1966 return (zfs_error(hdl
, EZFS_PROPNONINHERIT
, errbuf
));
1969 * Check to see if the value applies to this type
1971 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
))
1972 return (zfs_error(hdl
, EZFS_PROPTYPE
, errbuf
));
1975 * Normalize the name, to get rid of shorthand abbreviations.
1977 propname
= zfs_prop_to_name(prop
);
1978 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1979 (void) strlcpy(zc
.zc_value
, propname
, sizeof (zc
.zc_value
));
1981 if (prop
== ZFS_PROP_MOUNTPOINT
&& getzoneid() == GLOBAL_ZONEID
&&
1982 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
)) {
1983 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1984 "dataset is used in a non-global zone"));
1985 return (zfs_error(hdl
, EZFS_ZONED
, errbuf
));
1989 * Determine datasets which will be affected by this change, if any.
1991 if ((cl
= changelist_gather(zhp
, prop
, 0, 0)) == NULL
)
1994 if (prop
== ZFS_PROP_MOUNTPOINT
&& changelist_haszonedchild(cl
)) {
1995 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1996 "child dataset with inherited mountpoint is used "
1997 "in a non-global zone"));
1998 ret
= zfs_error(hdl
, EZFS_ZONED
, errbuf
);
2002 if ((ret
= changelist_prefix(cl
)) != 0)
2005 if ((ret
= zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_INHERIT_PROP
, &zc
)) != 0) {
2006 return (zfs_standard_error(hdl
, errno
, errbuf
));
2009 if ((ret
= changelist_postfix(cl
)) != 0)
2013 * Refresh the statistics so the new property is reflected.
2015 (void) get_stats(zhp
);
2018 * Remount the filesystem to propagate the change
2019 * if one of the options handled by the generic
2020 * Linux namespace layer has been modified.
2022 if (zfs_is_namespace_prop(prop
) &&
2023 zfs_is_mounted(zhp
, NULL
))
2024 ret
= zfs_mount(zhp
, MNTOPT_REMOUNT
, 0);
2028 changelist_free(cl
);
2033 * True DSL properties are stored in an nvlist. The following two functions
2034 * extract them appropriately.
2037 getprop_uint64(zfs_handle_t
*zhp
, zfs_prop_t prop
, char **source
)
2043 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
2044 zfs_prop_to_name(prop
), &nv
) == 0) {
2045 verify(nvlist_lookup_uint64(nv
, ZPROP_VALUE
, &value
) == 0);
2046 (void) nvlist_lookup_string(nv
, ZPROP_SOURCE
, source
);
2048 verify(!zhp
->zfs_props_table
||
2049 zhp
->zfs_props_table
[prop
] == B_TRUE
);
2050 value
= zfs_prop_default_numeric(prop
);
2058 getprop_string(zfs_handle_t
*zhp
, zfs_prop_t prop
, char **source
)
2064 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
2065 zfs_prop_to_name(prop
), &nv
) == 0) {
2066 value
= fnvlist_lookup_string(nv
, ZPROP_VALUE
);
2067 (void) nvlist_lookup_string(nv
, ZPROP_SOURCE
, source
);
2069 verify(!zhp
->zfs_props_table
||
2070 zhp
->zfs_props_table
[prop
] == B_TRUE
);
2071 value
= zfs_prop_default_string(prop
);
2079 zfs_is_recvd_props_mode(zfs_handle_t
*zhp
)
2081 return (zhp
->zfs_props
== zhp
->zfs_recvd_props
);
2085 zfs_set_recvd_props_mode(zfs_handle_t
*zhp
, uint64_t *cookie
)
2087 *cookie
= (uint64_t)(uintptr_t)zhp
->zfs_props
;
2088 zhp
->zfs_props
= zhp
->zfs_recvd_props
;
2092 zfs_unset_recvd_props_mode(zfs_handle_t
*zhp
, uint64_t *cookie
)
2094 zhp
->zfs_props
= (nvlist_t
*)(uintptr_t)*cookie
;
2099 * Internal function for getting a numeric property. Both zfs_prop_get() and
2100 * zfs_prop_get_int() are built using this interface.
2102 * Certain properties can be overridden using 'mount -o'. In this case, scan
2103 * the contents of the /proc/self/mounts entry, searching for the
2104 * appropriate options. If they differ from the on-disk values, report the
2105 * current values and mark the source "temporary".
2108 get_numeric_property(zfs_handle_t
*zhp
, zfs_prop_t prop
, zprop_source_t
*src
,
2109 char **source
, uint64_t *val
)
2111 zfs_cmd_t zc
= {"\0"};
2112 nvlist_t
*zplprops
= NULL
;
2114 char *mntopt_on
= NULL
;
2115 char *mntopt_off
= NULL
;
2116 boolean_t received
= zfs_is_recvd_props_mode(zhp
);
2121 * If the property is being fetched for a snapshot, check whether
2122 * the property is valid for the snapshot's head dataset type.
2124 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
&&
2125 !zfs_prop_valid_for_type(prop
, zhp
->zfs_head_type
, B_TRUE
)) {
2126 *val
= zfs_prop_default_numeric(prop
);
2131 case ZFS_PROP_ATIME
:
2132 mntopt_on
= MNTOPT_ATIME
;
2133 mntopt_off
= MNTOPT_NOATIME
;
2136 case ZFS_PROP_RELATIME
:
2137 mntopt_on
= MNTOPT_RELATIME
;
2138 mntopt_off
= MNTOPT_NORELATIME
;
2141 case ZFS_PROP_DEVICES
:
2142 mntopt_on
= MNTOPT_DEVICES
;
2143 mntopt_off
= MNTOPT_NODEVICES
;
2147 mntopt_on
= MNTOPT_EXEC
;
2148 mntopt_off
= MNTOPT_NOEXEC
;
2151 case ZFS_PROP_READONLY
:
2152 mntopt_on
= MNTOPT_RO
;
2153 mntopt_off
= MNTOPT_RW
;
2156 case ZFS_PROP_SETUID
:
2157 mntopt_on
= MNTOPT_SETUID
;
2158 mntopt_off
= MNTOPT_NOSETUID
;
2161 case ZFS_PROP_XATTR
:
2162 mntopt_on
= MNTOPT_XATTR
;
2163 mntopt_off
= MNTOPT_NOXATTR
;
2166 case ZFS_PROP_NBMAND
:
2167 mntopt_on
= MNTOPT_NBMAND
;
2168 mntopt_off
= MNTOPT_NONBMAND
;
2176 * Because looking up the mount options is potentially expensive
2177 * (iterating over all of /proc/self/mounts), we defer its
2178 * calculation until we're looking up a property which requires
2181 if (!zhp
->zfs_mntcheck
&&
2182 (mntopt_on
!= NULL
|| prop
== ZFS_PROP_MOUNTED
)) {
2183 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
2184 struct mnttab entry
;
2186 if (libzfs_mnttab_find(hdl
, zhp
->zfs_name
, &entry
) == 0) {
2187 zhp
->zfs_mntopts
= zfs_strdup(hdl
,
2189 if (zhp
->zfs_mntopts
== NULL
)
2193 zhp
->zfs_mntcheck
= B_TRUE
;
2196 if (zhp
->zfs_mntopts
== NULL
)
2197 mnt
.mnt_mntopts
= "";
2199 mnt
.mnt_mntopts
= zhp
->zfs_mntopts
;
2202 case ZFS_PROP_ATIME
:
2203 case ZFS_PROP_RELATIME
:
2204 case ZFS_PROP_DEVICES
:
2206 case ZFS_PROP_READONLY
:
2207 case ZFS_PROP_SETUID
:
2209 case ZFS_PROP_XATTR
:
2211 case ZFS_PROP_NBMAND
:
2212 *val
= getprop_uint64(zhp
, prop
, source
);
2217 if (hasmntopt(&mnt
, mntopt_on
) && !*val
) {
2220 *src
= ZPROP_SRC_TEMPORARY
;
2221 } else if (hasmntopt(&mnt
, mntopt_off
) && *val
) {
2224 *src
= ZPROP_SRC_TEMPORARY
;
2228 case ZFS_PROP_CANMOUNT
:
2229 case ZFS_PROP_VOLSIZE
:
2230 case ZFS_PROP_QUOTA
:
2231 case ZFS_PROP_REFQUOTA
:
2232 case ZFS_PROP_RESERVATION
:
2233 case ZFS_PROP_REFRESERVATION
:
2234 case ZFS_PROP_FILESYSTEM_LIMIT
:
2235 case ZFS_PROP_SNAPSHOT_LIMIT
:
2236 case ZFS_PROP_FILESYSTEM_COUNT
:
2237 case ZFS_PROP_SNAPSHOT_COUNT
:
2238 *val
= getprop_uint64(zhp
, prop
, source
);
2240 if (*source
== NULL
) {
2241 /* not default, must be local */
2242 *source
= zhp
->zfs_name
;
2246 case ZFS_PROP_MOUNTED
:
2247 *val
= (zhp
->zfs_mntopts
!= NULL
);
2250 case ZFS_PROP_NUMCLONES
:
2251 *val
= zhp
->zfs_dmustats
.dds_num_clones
;
2254 case ZFS_PROP_VERSION
:
2255 case ZFS_PROP_NORMALIZE
:
2256 case ZFS_PROP_UTF8ONLY
:
2258 if (zcmd_alloc_dst_nvlist(zhp
->zfs_hdl
, &zc
, 0) != 0)
2260 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
2261 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_OBJSET_ZPLPROPS
, &zc
)) {
2262 zcmd_free_nvlists(&zc
);
2263 if (prop
== ZFS_PROP_VERSION
&&
2264 zhp
->zfs_type
== ZFS_TYPE_VOLUME
)
2265 *val
= zfs_prop_default_numeric(prop
);
2268 if (zcmd_read_dst_nvlist(zhp
->zfs_hdl
, &zc
, &zplprops
) != 0 ||
2269 nvlist_lookup_uint64(zplprops
, zfs_prop_to_name(prop
),
2271 zcmd_free_nvlists(&zc
);
2274 nvlist_free(zplprops
);
2275 zcmd_free_nvlists(&zc
);
2278 case ZFS_PROP_INCONSISTENT
:
2279 *val
= zhp
->zfs_dmustats
.dds_inconsistent
;
2282 case ZFS_PROP_REDACTED
:
2283 *val
= zhp
->zfs_dmustats
.dds_redacted
;
2287 switch (zfs_prop_get_type(prop
)) {
2288 case PROP_TYPE_NUMBER
:
2289 case PROP_TYPE_INDEX
:
2290 *val
= getprop_uint64(zhp
, prop
, source
);
2292 * If we tried to use a default value for a
2293 * readonly property, it means that it was not
2294 * present. Note this only applies to "truly"
2295 * readonly properties, not set-once properties
2296 * like volblocksize.
2298 if (zfs_prop_readonly(prop
) &&
2299 !zfs_prop_setonce(prop
) &&
2300 *source
!= NULL
&& (*source
)[0] == '\0') {
2306 case PROP_TYPE_STRING
:
2308 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
2309 "cannot get non-numeric property"));
2310 return (zfs_error(zhp
->zfs_hdl
, EZFS_BADPROP
,
2311 dgettext(TEXT_DOMAIN
, "internal error")));
2319 * Calculate the source type, given the raw source string.
2322 get_source(zfs_handle_t
*zhp
, zprop_source_t
*srctype
, char *source
,
2323 char *statbuf
, size_t statlen
)
2325 if (statbuf
== NULL
||
2326 srctype
== NULL
|| *srctype
== ZPROP_SRC_TEMPORARY
) {
2330 if (source
== NULL
) {
2331 *srctype
= ZPROP_SRC_NONE
;
2332 } else if (source
[0] == '\0') {
2333 *srctype
= ZPROP_SRC_DEFAULT
;
2334 } else if (strstr(source
, ZPROP_SOURCE_VAL_RECVD
) != NULL
) {
2335 *srctype
= ZPROP_SRC_RECEIVED
;
2337 if (strcmp(source
, zhp
->zfs_name
) == 0) {
2338 *srctype
= ZPROP_SRC_LOCAL
;
2340 (void) strlcpy(statbuf
, source
, statlen
);
2341 *srctype
= ZPROP_SRC_INHERITED
;
2348 zfs_prop_get_recvd(zfs_handle_t
*zhp
, const char *propname
, char *propbuf
,
2349 size_t proplen
, boolean_t literal
)
2354 if (zhp
->zfs_recvd_props
== NULL
)
2355 if (get_recvd_props_ioctl(zhp
) != 0)
2358 prop
= zfs_name_to_prop(propname
);
2360 if (prop
!= ZPROP_INVAL
) {
2362 if (!nvlist_exists(zhp
->zfs_recvd_props
, propname
))
2364 zfs_set_recvd_props_mode(zhp
, &cookie
);
2365 err
= zfs_prop_get(zhp
, prop
, propbuf
, proplen
,
2366 NULL
, NULL
, 0, literal
);
2367 zfs_unset_recvd_props_mode(zhp
, &cookie
);
2371 if (nvlist_lookup_nvlist(zhp
->zfs_recvd_props
,
2372 propname
, &propval
) != 0)
2374 verify(nvlist_lookup_string(propval
, ZPROP_VALUE
,
2376 (void) strlcpy(propbuf
, recvdval
, proplen
);
2379 return (err
== 0 ? 0 : -1);
2383 get_clones_string(zfs_handle_t
*zhp
, char *propbuf
, size_t proplen
)
2388 value
= zfs_get_clones_nvl(zhp
);
2389 if (value
== NULL
|| nvlist_empty(value
))
2393 for (pair
= nvlist_next_nvpair(value
, NULL
); pair
!= NULL
;
2394 pair
= nvlist_next_nvpair(value
, pair
)) {
2395 if (propbuf
[0] != '\0')
2396 (void) strlcat(propbuf
, ",", proplen
);
2397 (void) strlcat(propbuf
, nvpair_name(pair
), proplen
);
2403 struct get_clones_arg
{
2407 char buf
[ZFS_MAX_DATASET_NAME_LEN
];
2411 get_clones_cb(zfs_handle_t
*zhp
, void *arg
)
2413 struct get_clones_arg
*gca
= arg
;
2415 if (gca
->numclones
== 0) {
2420 if (zfs_prop_get(zhp
, ZFS_PROP_ORIGIN
, gca
->buf
, sizeof (gca
->buf
),
2421 NULL
, NULL
, 0, B_TRUE
) != 0)
2423 if (strcmp(gca
->buf
, gca
->origin
) == 0) {
2424 fnvlist_add_boolean(gca
->value
, zfs_get_name(zhp
));
2429 (void) zfs_iter_children(zhp
, get_clones_cb
, gca
);
2435 zfs_get_clones_nvl(zfs_handle_t
*zhp
)
2437 nvlist_t
*nv
, *value
;
2439 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
2440 zfs_prop_to_name(ZFS_PROP_CLONES
), &nv
) != 0) {
2441 struct get_clones_arg gca
;
2444 * if this is a snapshot, then the kernel wasn't able
2445 * to get the clones. Do it by slowly iterating.
2447 if (zhp
->zfs_type
!= ZFS_TYPE_SNAPSHOT
)
2449 if (nvlist_alloc(&nv
, NV_UNIQUE_NAME
, 0) != 0)
2451 if (nvlist_alloc(&value
, NV_UNIQUE_NAME
, 0) != 0) {
2456 gca
.numclones
= zfs_prop_get_int(zhp
, ZFS_PROP_NUMCLONES
);
2458 gca
.origin
= zhp
->zfs_name
;
2460 if (gca
.numclones
!= 0) {
2462 char pool
[ZFS_MAX_DATASET_NAME_LEN
];
2465 /* get the pool name */
2466 (void) strlcpy(pool
, zhp
->zfs_name
, sizeof (pool
));
2467 (void) strsep(&cp
, "/@");
2468 root
= zfs_open(zhp
->zfs_hdl
, pool
,
2469 ZFS_TYPE_FILESYSTEM
);
2476 (void) get_clones_cb(root
, &gca
);
2479 if (gca
.numclones
!= 0 ||
2480 nvlist_add_nvlist(nv
, ZPROP_VALUE
, value
) != 0 ||
2481 nvlist_add_nvlist(zhp
->zfs_props
,
2482 zfs_prop_to_name(ZFS_PROP_CLONES
), nv
) != 0) {
2489 verify(0 == nvlist_lookup_nvlist(zhp
->zfs_props
,
2490 zfs_prop_to_name(ZFS_PROP_CLONES
), &nv
));
2493 verify(nvlist_lookup_nvlist(nv
, ZPROP_VALUE
, &value
) == 0);
2499 get_rsnaps_string(zfs_handle_t
*zhp
, char *propbuf
, size_t proplen
)
2505 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
2506 zfs_prop_to_name(ZFS_PROP_REDACT_SNAPS
), &value
) != 0)
2508 if (nvlist_lookup_uint64_array(value
, ZPROP_VALUE
, &snaps
,
2512 /* There's no redaction snapshots; pass a special value back */
2513 (void) snprintf(propbuf
, proplen
, "none");
2517 for (int i
= 0; i
< nsnaps
; i
++) {
2519 if (propbuf
[0] != '\0')
2520 (void) strlcat(propbuf
, ",", proplen
);
2521 (void) snprintf(buf
, sizeof (buf
), "%llu",
2522 (u_longlong_t
)snaps
[i
]);
2523 (void) strlcat(propbuf
, buf
, proplen
);
2530 * Accepts a property and value and checks that the value
2531 * matches the one found by the channel program. If they are
2532 * not equal, print both of them.
2535 zcp_check(zfs_handle_t
*zhp
, zfs_prop_t prop
, uint64_t intval
,
2538 if (!zhp
->zfs_hdl
->libzfs_prop_debug
)
2541 char *poolname
= zhp
->zpool_hdl
->zpool_name
;
2542 const char *prop_name
= zfs_prop_to_name(prop
);
2543 const char *program
=
2545 "ds = args['dataset']\n"
2546 "prop = args['property']\n"
2547 "value, setpoint = zfs.get_prop(ds, prop)\n"
2548 "return {value=value, setpoint=setpoint}\n";
2551 nvlist_t
*argnvl
= fnvlist_alloc();
2553 fnvlist_add_string(argnvl
, "dataset", zhp
->zfs_name
);
2554 fnvlist_add_string(argnvl
, "property", zfs_prop_to_name(prop
));
2556 error
= lzc_channel_program_nosync(poolname
, program
,
2557 10 * 1000 * 1000, 10 * 1024 * 1024, argnvl
, &outnvl
);
2560 retnvl
= fnvlist_lookup_nvlist(outnvl
, "return");
2561 if (zfs_prop_get_type(prop
) == PROP_TYPE_NUMBER
) {
2563 error
= nvlist_lookup_int64(retnvl
, "value", &ans
);
2565 (void) fprintf(stderr
, "%s: zcp check error: "
2566 "%u\n", prop_name
, error
);
2569 if (ans
!= intval
) {
2570 (void) fprintf(stderr
, "%s: zfs found %llu, "
2571 "but zcp found %llu\n", prop_name
,
2572 (u_longlong_t
)intval
, (u_longlong_t
)ans
);
2576 error
= nvlist_lookup_string(retnvl
, "value", &str_ans
);
2578 (void) fprintf(stderr
, "%s: zcp check error: "
2579 "%u\n", prop_name
, error
);
2582 if (strcmp(strval
, str_ans
) != 0) {
2583 (void) fprintf(stderr
,
2584 "%s: zfs found '%s', but zcp found '%s'\n",
2585 prop_name
, strval
, str_ans
);
2589 (void) fprintf(stderr
, "%s: zcp check failed, channel program "
2590 "error: %u\n", prop_name
, error
);
2592 nvlist_free(argnvl
);
2593 nvlist_free(outnvl
);
2597 * Retrieve a property from the given object. If 'literal' is specified, then
2598 * numbers are left as exact values. Otherwise, numbers are converted to a
2599 * human-readable form.
2601 * Returns 0 on success, or -1 on error.
2604 zfs_prop_get(zfs_handle_t
*zhp
, zfs_prop_t prop
, char *propbuf
, size_t proplen
,
2605 zprop_source_t
*src
, char *statbuf
, size_t statlen
, boolean_t literal
)
2607 char *source
= NULL
;
2611 boolean_t received
= zfs_is_recvd_props_mode(zhp
);
2614 * Check to see if this property applies to our object
2616 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
))
2619 if (received
&& zfs_prop_readonly(prop
))
2623 *src
= ZPROP_SRC_NONE
;
2626 case ZFS_PROP_CREATION
:
2628 * 'creation' is a time_t stored in the statistics. We convert
2629 * this into a string unless 'literal' is specified.
2632 val
= getprop_uint64(zhp
, prop
, &source
);
2633 time_t time
= (time_t)val
;
2637 localtime_r(&time
, &t
) == NULL
||
2638 strftime(propbuf
, proplen
, "%a %b %e %k:%M %Y",
2640 (void) snprintf(propbuf
, proplen
, "%llu",
2643 zcp_check(zhp
, prop
, val
, NULL
);
2646 case ZFS_PROP_MOUNTPOINT
:
2648 * Getting the precise mountpoint can be tricky.
2650 * - for 'none' or 'legacy', return those values.
2651 * - for inherited mountpoints, we want to take everything
2652 * after our ancestor and append it to the inherited value.
2654 * If the pool has an alternate root, we want to prepend that
2655 * root to any values we return.
2658 str
= getprop_string(zhp
, prop
, &source
);
2660 if (str
[0] == '/') {
2661 char buf
[MAXPATHLEN
];
2663 const char *relpath
;
2666 * If we inherit the mountpoint, even from a dataset
2667 * with a received value, the source will be the path of
2668 * the dataset we inherit from. If source is
2669 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2672 if (strcmp(source
, ZPROP_SOURCE_VAL_RECVD
) == 0) {
2675 relpath
= zhp
->zfs_name
+ strlen(source
);
2676 if (relpath
[0] == '/')
2680 if ((zpool_get_prop(zhp
->zpool_hdl
,
2681 ZPOOL_PROP_ALTROOT
, buf
, MAXPATHLEN
, NULL
,
2682 B_FALSE
)) || (strcmp(root
, "-") == 0))
2685 * Special case an alternate root of '/'. This will
2686 * avoid having multiple leading slashes in the
2689 if (strcmp(root
, "/") == 0)
2693 * If the mountpoint is '/' then skip over this
2694 * if we are obtaining either an alternate root or
2695 * an inherited mountpoint.
2697 if (str
[1] == '\0' && (root
[0] != '\0' ||
2698 relpath
[0] != '\0'))
2701 if (relpath
[0] == '\0')
2702 (void) snprintf(propbuf
, proplen
, "%s%s",
2705 (void) snprintf(propbuf
, proplen
, "%s%s%s%s",
2706 root
, str
, relpath
[0] == '@' ? "" : "/",
2709 /* 'legacy' or 'none' */
2710 (void) strlcpy(propbuf
, str
, proplen
);
2712 zcp_check(zhp
, prop
, 0, propbuf
);
2715 case ZFS_PROP_ORIGIN
:
2716 str
= getprop_string(zhp
, prop
, &source
);
2719 (void) strlcpy(propbuf
, str
, proplen
);
2720 zcp_check(zhp
, prop
, 0, str
);
2723 case ZFS_PROP_REDACT_SNAPS
:
2724 if (get_rsnaps_string(zhp
, propbuf
, proplen
) != 0)
2728 case ZFS_PROP_CLONES
:
2729 if (get_clones_string(zhp
, propbuf
, proplen
) != 0)
2733 case ZFS_PROP_QUOTA
:
2734 case ZFS_PROP_REFQUOTA
:
2735 case ZFS_PROP_RESERVATION
:
2736 case ZFS_PROP_REFRESERVATION
:
2738 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2741 * If quota or reservation is 0, we translate this into 'none'
2742 * (unless literal is set), and indicate that it's the default
2743 * value. Otherwise, we print the number nicely and indicate
2744 * that its set locally.
2748 (void) strlcpy(propbuf
, "0", proplen
);
2750 (void) strlcpy(propbuf
, "none", proplen
);
2753 (void) snprintf(propbuf
, proplen
, "%llu",
2756 zfs_nicebytes(val
, propbuf
, proplen
);
2758 zcp_check(zhp
, prop
, val
, NULL
);
2761 case ZFS_PROP_FILESYSTEM_LIMIT
:
2762 case ZFS_PROP_SNAPSHOT_LIMIT
:
2763 case ZFS_PROP_FILESYSTEM_COUNT
:
2764 case ZFS_PROP_SNAPSHOT_COUNT
:
2766 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2770 * If limit is UINT64_MAX, we translate this into 'none' (unless
2771 * literal is set), and indicate that it's the default value.
2772 * Otherwise, we print the number nicely and indicate that it's
2776 (void) snprintf(propbuf
, proplen
, "%llu",
2778 } else if (val
== UINT64_MAX
) {
2779 (void) strlcpy(propbuf
, "none", proplen
);
2781 zfs_nicenum(val
, propbuf
, proplen
);
2784 zcp_check(zhp
, prop
, val
, NULL
);
2787 case ZFS_PROP_REFRATIO
:
2788 case ZFS_PROP_COMPRESSRATIO
:
2789 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2792 (void) snprintf(propbuf
, proplen
, "%llu.%02llu",
2793 (u_longlong_t
)(val
/ 100),
2794 (u_longlong_t
)(val
% 100));
2796 (void) snprintf(propbuf
, proplen
, "%llu.%02llux",
2797 (u_longlong_t
)(val
/ 100),
2798 (u_longlong_t
)(val
% 100));
2799 zcp_check(zhp
, prop
, val
, NULL
);
2803 switch (zhp
->zfs_type
) {
2804 case ZFS_TYPE_FILESYSTEM
:
2807 case ZFS_TYPE_VOLUME
:
2810 case ZFS_TYPE_SNAPSHOT
:
2813 case ZFS_TYPE_BOOKMARK
:
2819 (void) snprintf(propbuf
, proplen
, "%s", str
);
2820 zcp_check(zhp
, prop
, 0, propbuf
);
2823 case ZFS_PROP_MOUNTED
:
2825 * The 'mounted' property is a pseudo-property that described
2826 * whether the filesystem is currently mounted. Even though
2827 * it's a boolean value, the typical values of "on" and "off"
2828 * don't make sense, so we translate to "yes" and "no".
2830 if (get_numeric_property(zhp
, ZFS_PROP_MOUNTED
,
2831 src
, &source
, &val
) != 0)
2834 (void) strlcpy(propbuf
, "yes", proplen
);
2836 (void) strlcpy(propbuf
, "no", proplen
);
2841 * The 'name' property is a pseudo-property derived from the
2842 * dataset name. It is presented as a real property to simplify
2845 (void) strlcpy(propbuf
, zhp
->zfs_name
, proplen
);
2846 zcp_check(zhp
, prop
, 0, propbuf
);
2849 case ZFS_PROP_MLSLABEL
:
2851 #ifdef HAVE_MLSLABEL
2852 m_label_t
*new_sl
= NULL
;
2853 char *ascii
= NULL
; /* human readable label */
2855 (void) strlcpy(propbuf
,
2856 getprop_string(zhp
, prop
, &source
), proplen
);
2858 if (literal
|| (strcasecmp(propbuf
,
2859 ZFS_MLSLABEL_DEFAULT
) == 0))
2863 * Try to translate the internal hex string to
2864 * human-readable output. If there are any
2865 * problems just use the hex string.
2868 if (str_to_label(propbuf
, &new_sl
, MAC_LABEL
,
2869 L_NO_CORRECTION
, NULL
) == -1) {
2870 m_label_free(new_sl
);
2874 if (label_to_str(new_sl
, &ascii
, M_LABEL
,
2878 m_label_free(new_sl
);
2881 m_label_free(new_sl
);
2883 (void) strlcpy(propbuf
, ascii
, proplen
);
2886 (void) strlcpy(propbuf
,
2887 getprop_string(zhp
, prop
, &source
), proplen
);
2888 #endif /* HAVE_MLSLABEL */
2893 case ZFS_PROP_CREATETXG
:
2894 case ZFS_PROP_OBJSETID
:
2895 case ZFS_PROP_PBKDF2_ITERS
:
2897 * These properties are stored as numbers, but they are
2898 * identifiers or counters.
2899 * We don't want them to be pretty printed, because pretty
2900 * printing truncates their values making them useless.
2902 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2904 (void) snprintf(propbuf
, proplen
, "%llu", (u_longlong_t
)val
);
2905 zcp_check(zhp
, prop
, val
, NULL
);
2908 case ZFS_PROP_REFERENCED
:
2909 case ZFS_PROP_AVAILABLE
:
2911 case ZFS_PROP_USEDSNAP
:
2912 case ZFS_PROP_USEDDS
:
2913 case ZFS_PROP_USEDREFRESERV
:
2914 case ZFS_PROP_USEDCHILD
:
2915 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2918 (void) snprintf(propbuf
, proplen
, "%llu",
2921 zfs_nicebytes(val
, propbuf
, proplen
);
2923 zcp_check(zhp
, prop
, val
, NULL
);
2927 switch (zfs_prop_get_type(prop
)) {
2928 case PROP_TYPE_NUMBER
:
2929 if (get_numeric_property(zhp
, prop
, src
,
2930 &source
, &val
) != 0) {
2935 (void) snprintf(propbuf
, proplen
, "%llu",
2938 zfs_nicenum(val
, propbuf
, proplen
);
2940 zcp_check(zhp
, prop
, val
, NULL
);
2943 case PROP_TYPE_STRING
:
2944 str
= getprop_string(zhp
, prop
, &source
);
2948 (void) strlcpy(propbuf
, str
, proplen
);
2949 zcp_check(zhp
, prop
, 0, str
);
2952 case PROP_TYPE_INDEX
:
2953 if (get_numeric_property(zhp
, prop
, src
,
2954 &source
, &val
) != 0)
2956 if (zfs_prop_index_to_string(prop
, val
, &strval
) != 0)
2959 (void) strlcpy(propbuf
, strval
, proplen
);
2960 zcp_check(zhp
, prop
, 0, strval
);
2968 get_source(zhp
, src
, source
, statbuf
, statlen
);
2974 * Utility function to get the given numeric property. Does no validation that
2975 * the given property is the appropriate type; should only be used with
2976 * hard-coded property types.
2979 zfs_prop_get_int(zfs_handle_t
*zhp
, zfs_prop_t prop
)
2984 (void) get_numeric_property(zhp
, prop
, NULL
, &source
, &val
);
2990 zfs_prop_set_int(zfs_handle_t
*zhp
, zfs_prop_t prop
, uint64_t val
)
2994 (void) snprintf(buf
, sizeof (buf
), "%llu", (longlong_t
)val
);
2995 return (zfs_prop_set(zhp
, zfs_prop_to_name(prop
), buf
));
2999 * Similar to zfs_prop_get(), but returns the value as an integer.
3002 zfs_prop_get_numeric(zfs_handle_t
*zhp
, zfs_prop_t prop
, uint64_t *value
,
3003 zprop_source_t
*src
, char *statbuf
, size_t statlen
)
3008 * Check to see if this property applies to our object
3010 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
)) {
3011 return (zfs_error_fmt(zhp
->zfs_hdl
, EZFS_PROPTYPE
,
3012 dgettext(TEXT_DOMAIN
, "cannot get property '%s'"),
3013 zfs_prop_to_name(prop
)));
3017 *src
= ZPROP_SRC_NONE
;
3019 if (get_numeric_property(zhp
, prop
, src
, &source
, value
) != 0)
3022 get_source(zhp
, src
, source
, statbuf
, statlen
);
3029 idmap_id_to_numeric_domain_rid(uid_t id
, boolean_t isuser
,
3030 char **domainp
, idmap_rid_t
*ridp
)
3032 idmap_get_handle_t
*get_hdl
= NULL
;
3036 if (idmap_get_create(&get_hdl
) != IDMAP_SUCCESS
)
3040 err
= idmap_get_sidbyuid(get_hdl
, id
,
3041 IDMAP_REQ_FLG_USE_CACHE
, domainp
, ridp
, &status
);
3043 err
= idmap_get_sidbygid(get_hdl
, id
,
3044 IDMAP_REQ_FLG_USE_CACHE
, domainp
, ridp
, &status
);
3046 if (err
== IDMAP_SUCCESS
&&
3047 idmap_get_mappings(get_hdl
) == IDMAP_SUCCESS
&&
3048 status
== IDMAP_SUCCESS
)
3054 idmap_get_destroy(get_hdl
);
3057 #endif /* HAVE_IDMAP */
3060 * convert the propname into parameters needed by kernel
3061 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
3062 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
3063 * Eg: groupquota@staff -> ZFS_PROP_GROUPQUOTA, "", 1234
3064 * Eg: groupused@staff -> ZFS_PROP_GROUPUSED, "", 1234
3065 * Eg: projectquota@123 -> ZFS_PROP_PROJECTQUOTA, "", 123
3066 * Eg: projectused@789 -> ZFS_PROP_PROJECTUSED, "", 789
3069 userquota_propname_decode(const char *propname
, boolean_t zoned
,
3070 zfs_userquota_prop_t
*typep
, char *domain
, int domainlen
, uint64_t *ridp
)
3072 zfs_userquota_prop_t type
;
3076 boolean_t isproject
;
3082 /* Figure out the property type ({user|group|project}{quota|space}) */
3083 for (type
= 0; type
< ZFS_NUM_USERQUOTA_PROPS
; type
++) {
3084 if (strncmp(propname
, zfs_userquota_prop_prefixes
[type
],
3085 strlen(zfs_userquota_prop_prefixes
[type
])) == 0)
3088 if (type
== ZFS_NUM_USERQUOTA_PROPS
)
3092 isuser
= (type
== ZFS_PROP_USERQUOTA
|| type
== ZFS_PROP_USERUSED
||
3093 type
== ZFS_PROP_USEROBJQUOTA
||
3094 type
== ZFS_PROP_USEROBJUSED
);
3095 isgroup
= (type
== ZFS_PROP_GROUPQUOTA
|| type
== ZFS_PROP_GROUPUSED
||
3096 type
== ZFS_PROP_GROUPOBJQUOTA
||
3097 type
== ZFS_PROP_GROUPOBJUSED
);
3098 isproject
= (type
== ZFS_PROP_PROJECTQUOTA
||
3099 type
== ZFS_PROP_PROJECTUSED
|| type
== ZFS_PROP_PROJECTOBJQUOTA
||
3100 type
== ZFS_PROP_PROJECTOBJUSED
);
3102 cp
= strchr(propname
, '@') + 1;
3104 if (isuser
&& (pw
= getpwnam(cp
)) != NULL
) {
3105 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
3108 } else if (isgroup
&& (gr
= getgrnam(cp
)) != NULL
) {
3109 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
3112 } else if (!isproject
&& strchr(cp
, '@')) {
3115 * It's a SID name (eg "user@domain") that needs to be
3116 * turned into S-1-domainID-RID.
3118 directory_error_t e
;
3119 char *numericsid
= NULL
;
3122 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
3125 e
= directory_sid_from_user_name(NULL
,
3128 e
= directory_sid_from_group_name(NULL
,
3132 directory_error_free(e
);
3135 if (numericsid
== NULL
)
3138 (void) strlcpy(domain
, cp
, domainlen
);
3139 cp
= strrchr(domain
, '-');
3144 *ridp
= strtoull(cp
, &end
, 10);
3147 if (errno
!= 0 || *end
!= '\0')
3151 #endif /* HAVE_IDMAP */
3153 /* It's a user/group/project ID (eg "12345"). */
3156 id
= strtoul(cp
, &end
, 10);
3159 if (id
> MAXUID
&& !isproject
) {
3161 /* It's an ephemeral ID. */
3165 if (idmap_id_to_numeric_domain_rid(id
, isuser
,
3166 &mapdomain
, &rid
) != 0)
3168 (void) strlcpy(domain
, mapdomain
, domainlen
);
3172 #endif /* HAVE_IDMAP */
3182 zfs_prop_get_userquota_common(zfs_handle_t
*zhp
, const char *propname
,
3183 uint64_t *propvalue
, zfs_userquota_prop_t
*typep
)
3186 zfs_cmd_t zc
= {"\0"};
3188 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
3190 err
= userquota_propname_decode(propname
,
3191 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
),
3192 typep
, zc
.zc_value
, sizeof (zc
.zc_value
), &zc
.zc_guid
);
3193 zc
.zc_objset_type
= *typep
;
3197 err
= zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_USERSPACE_ONE
, &zc
);
3201 *propvalue
= zc
.zc_cookie
;
3206 zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
3207 uint64_t *propvalue
)
3209 zfs_userquota_prop_t type
;
3211 return (zfs_prop_get_userquota_common(zhp
, propname
, propvalue
,
3216 zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
3217 char *propbuf
, int proplen
, boolean_t literal
)
3221 zfs_userquota_prop_t type
;
3223 err
= zfs_prop_get_userquota_common(zhp
, propname
, &propvalue
,
3230 (void) snprintf(propbuf
, proplen
, "%llu",
3231 (u_longlong_t
)propvalue
);
3232 } else if (propvalue
== 0 &&
3233 (type
== ZFS_PROP_USERQUOTA
|| type
== ZFS_PROP_GROUPQUOTA
||
3234 type
== ZFS_PROP_USEROBJQUOTA
|| type
== ZFS_PROP_GROUPOBJQUOTA
||
3235 type
== ZFS_PROP_PROJECTQUOTA
||
3236 type
== ZFS_PROP_PROJECTOBJQUOTA
)) {
3237 (void) strlcpy(propbuf
, "none", proplen
);
3238 } else if (type
== ZFS_PROP_USERQUOTA
|| type
== ZFS_PROP_GROUPQUOTA
||
3239 type
== ZFS_PROP_USERUSED
|| type
== ZFS_PROP_GROUPUSED
||
3240 type
== ZFS_PROP_PROJECTUSED
|| type
== ZFS_PROP_PROJECTQUOTA
) {
3241 zfs_nicebytes(propvalue
, propbuf
, proplen
);
3243 zfs_nicenum(propvalue
, propbuf
, proplen
);
3249 * propname must start with "written@" or "written#".
3252 zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
3253 uint64_t *propvalue
)
3256 zfs_cmd_t zc
= {"\0"};
3257 const char *snapname
;
3259 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
3261 assert(zfs_prop_written(propname
));
3262 snapname
= propname
+ strlen("written@");
3263 if (strchr(snapname
, '@') != NULL
|| strchr(snapname
, '#') != NULL
) {
3264 /* full snapshot or bookmark name specified */
3265 (void) strlcpy(zc
.zc_value
, snapname
, sizeof (zc
.zc_value
));
3267 /* snapname is the short name, append it to zhp's fsname */
3270 (void) strlcpy(zc
.zc_value
, zhp
->zfs_name
,
3271 sizeof (zc
.zc_value
));
3272 cp
= strchr(zc
.zc_value
, '@');
3275 (void) strlcat(zc
.zc_value
, snapname
- 1, sizeof (zc
.zc_value
));
3278 err
= zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_SPACE_WRITTEN
, &zc
);
3282 *propvalue
= zc
.zc_cookie
;
3287 zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
3288 char *propbuf
, int proplen
, boolean_t literal
)
3293 err
= zfs_prop_get_written_int(zhp
, propname
, &propvalue
);
3299 (void) snprintf(propbuf
, proplen
, "%llu",
3300 (u_longlong_t
)propvalue
);
3302 zfs_nicebytes(propvalue
, propbuf
, proplen
);
3309 * Returns the name of the given zfs handle.
3312 zfs_get_name(const zfs_handle_t
*zhp
)
3314 return (zhp
->zfs_name
);
3318 * Returns the name of the parent pool for the given zfs handle.
3321 zfs_get_pool_name(const zfs_handle_t
*zhp
)
3323 return (zhp
->zpool_hdl
->zpool_name
);
3327 * Returns the type of the given zfs handle.
3330 zfs_get_type(const zfs_handle_t
*zhp
)
3332 return (zhp
->zfs_type
);
3336 * Returns the type of the given zfs handle,
3337 * or, if a snapshot, the type of the snapshotted dataset.
3340 zfs_get_underlying_type(const zfs_handle_t
*zhp
)
3342 return (zhp
->zfs_head_type
);
3346 * Is one dataset name a child dataset of another?
3348 * Needs to handle these cases:
3349 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
3350 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
3351 * Descendant? No. No. No. Yes.
3354 is_descendant(const char *ds1
, const char *ds2
)
3356 size_t d1len
= strlen(ds1
);
3358 /* ds2 can't be a descendant if it's smaller */
3359 if (strlen(ds2
) < d1len
)
3362 /* otherwise, compare strings and verify that there's a '/' char */
3363 return (ds2
[d1len
] == '/' && (strncmp(ds1
, ds2
, d1len
) == 0));
3367 * Given a complete name, return just the portion that refers to the parent.
3368 * Will return -1 if there is no parent (path is just the name of the
3372 parent_name(const char *path
, char *buf
, size_t buflen
)
3376 (void) strlcpy(buf
, path
, buflen
);
3378 if ((slashp
= strrchr(buf
, '/')) == NULL
)
3386 zfs_parent_name(zfs_handle_t
*zhp
, char *buf
, size_t buflen
)
3388 return (parent_name(zfs_get_name(zhp
), buf
, buflen
));
3392 * If accept_ancestor is false, then check to make sure that the given path has
3393 * a parent, and that it exists. If accept_ancestor is true, then find the
3394 * closest existing ancestor for the given path. In prefixlen return the
3395 * length of already existing prefix of the given path. We also fetch the
3396 * 'zoned' property, which is used to validate property settings when creating
3400 check_parents(libzfs_handle_t
*hdl
, const char *path
, uint64_t *zoned
,
3401 boolean_t accept_ancestor
, int *prefixlen
)
3403 zfs_cmd_t zc
= {"\0"};
3404 char parent
[ZFS_MAX_DATASET_NAME_LEN
];
3410 (void) snprintf(errbuf
, sizeof (errbuf
),
3411 dgettext(TEXT_DOMAIN
, "cannot create '%s'"), path
);
3413 /* get parent, and check to see if this is just a pool */
3414 if (parent_name(path
, parent
, sizeof (parent
)) != 0) {
3415 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3416 "missing dataset name"));
3417 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3420 /* check to see if the pool exists */
3421 if ((slash
= strchr(parent
, '/')) == NULL
)
3422 slash
= parent
+ strlen(parent
);
3423 (void) strncpy(zc
.zc_name
, parent
, slash
- parent
);
3424 zc
.zc_name
[slash
- parent
] = '\0';
3425 if (zfs_ioctl(hdl
, ZFS_IOC_OBJSET_STATS
, &zc
) != 0 &&
3427 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3428 "no such pool '%s'"), zc
.zc_name
);
3429 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3432 /* check to see if the parent dataset exists */
3433 while ((zhp
= make_dataset_handle(hdl
, parent
)) == NULL
) {
3434 if (errno
== ENOENT
&& accept_ancestor
) {
3436 * Go deeper to find an ancestor, give up on top level.
3438 if (parent_name(parent
, parent
, sizeof (parent
)) != 0) {
3439 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3440 "no such pool '%s'"), zc
.zc_name
);
3441 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3443 } else if (errno
== ENOENT
) {
3444 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3445 "parent does not exist"));
3446 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3448 return (zfs_standard_error(hdl
, errno
, errbuf
));
3451 is_zoned
= zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
);
3455 /* we are in a non-global zone, but parent is in the global zone */
3456 if (getzoneid() != GLOBAL_ZONEID
&& !is_zoned
) {
3457 (void) zfs_standard_error(hdl
, EPERM
, errbuf
);
3462 /* make sure parent is a filesystem */
3463 if (zfs_get_type(zhp
) != ZFS_TYPE_FILESYSTEM
) {
3464 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3465 "parent is not a filesystem"));
3466 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
3472 if (prefixlen
!= NULL
)
3473 *prefixlen
= strlen(parent
);
3478 * Finds whether the dataset of the given type(s) exists.
3481 zfs_dataset_exists(libzfs_handle_t
*hdl
, const char *path
, zfs_type_t types
)
3485 if (!zfs_validate_name(hdl
, path
, types
, B_FALSE
))
3489 * Try to get stats for the dataset, which will tell us if it exists.
3491 if ((zhp
= make_dataset_handle(hdl
, path
)) != NULL
) {
3492 int ds_type
= zhp
->zfs_type
;
3495 if (types
& ds_type
)
3502 * Given a path to 'target', create all the ancestors between
3503 * the prefixlen portion of the path, and the target itself.
3504 * Fail if the initial prefixlen-ancestor does not already exist.
3507 create_parents(libzfs_handle_t
*hdl
, char *target
, int prefixlen
)
3513 /* make sure prefix exists */
3514 cp
= target
+ prefixlen
;
3516 assert(strchr(cp
, '/') == NULL
);
3517 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3520 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3528 * Attempt to create, mount, and share any ancestor filesystems,
3529 * up to the prefixlen-long one.
3531 for (cp
= target
+ prefixlen
+ 1;
3532 (cp
= strchr(cp
, '/')) != NULL
; *cp
= '/', cp
++) {
3536 h
= make_dataset_handle(hdl
, target
);
3538 /* it already exists, nothing to do here */
3543 if (zfs_create(hdl
, target
, ZFS_TYPE_FILESYSTEM
,
3545 opname
= dgettext(TEXT_DOMAIN
, "create");
3549 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3551 opname
= dgettext(TEXT_DOMAIN
, "open");
3555 if (zfs_mount(h
, NULL
, 0) != 0) {
3556 opname
= dgettext(TEXT_DOMAIN
, "mount");
3560 if (zfs_share(h
) != 0) {
3561 opname
= dgettext(TEXT_DOMAIN
, "share");
3567 zfs_commit_all_shares();
3572 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3573 "failed to %s ancestor '%s'"), opname
, target
);
3578 * Creates non-existing ancestors of the given path.
3581 zfs_create_ancestors(libzfs_handle_t
*hdl
, const char *path
)
3588 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3589 "cannot create '%s'"), path
);
3592 * Check that we are not passing the nesting limit
3593 * before we start creating any ancestors.
3595 if (dataset_nestcheck(path
) != 0) {
3596 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3597 "maximum name nesting depth exceeded"));
3598 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3601 if (check_parents(hdl
, path
, NULL
, B_TRUE
, &prefix
) != 0)
3604 if ((path_copy
= strdup(path
)) != NULL
) {
3605 rc
= create_parents(hdl
, path_copy
, prefix
);
3608 if (path_copy
== NULL
|| rc
!= 0)
3615 * Create a new filesystem or volume.
3618 zfs_create(libzfs_handle_t
*hdl
, const char *path
, zfs_type_t type
,
3623 uint64_t blocksize
= zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE
);
3625 enum lzc_dataset_type ost
;
3626 zpool_handle_t
*zpool_handle
;
3627 uint8_t *wkeydata
= NULL
;
3630 char parent
[ZFS_MAX_DATASET_NAME_LEN
];
3632 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3633 "cannot create '%s'"), path
);
3635 /* validate the path, taking care to note the extended error message */
3636 if (!zfs_validate_name(hdl
, path
, type
, B_TRUE
))
3637 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3639 if (dataset_nestcheck(path
) != 0) {
3640 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3641 "maximum name nesting depth exceeded"));
3642 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3645 /* validate parents exist */
3646 if (check_parents(hdl
, path
, &zoned
, B_FALSE
, NULL
) != 0)
3650 * The failure modes when creating a dataset of a different type over
3651 * one that already exists is a little strange. In particular, if you
3652 * try to create a dataset on top of an existing dataset, the ioctl()
3653 * will return ENOENT, not EEXIST. To prevent this from happening, we
3654 * first try to see if the dataset exists.
3656 if (zfs_dataset_exists(hdl
, path
, ZFS_TYPE_DATASET
)) {
3657 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3658 "dataset already exists"));
3659 return (zfs_error(hdl
, EZFS_EXISTS
, errbuf
));
3662 if (type
== ZFS_TYPE_VOLUME
)
3663 ost
= LZC_DATSET_TYPE_ZVOL
;
3665 ost
= LZC_DATSET_TYPE_ZFS
;
3667 /* open zpool handle for prop validation */
3668 char pool_path
[ZFS_MAX_DATASET_NAME_LEN
];
3669 (void) strlcpy(pool_path
, path
, sizeof (pool_path
));
3671 /* truncate pool_path at first slash */
3672 char *p
= strchr(pool_path
, '/');
3676 if ((zpool_handle
= zpool_open(hdl
, pool_path
)) == NULL
)
3679 if (props
&& (props
= zfs_valid_proplist(hdl
, type
, props
,
3680 zoned
, NULL
, zpool_handle
, B_TRUE
, errbuf
)) == 0) {
3681 zpool_close(zpool_handle
);
3684 zpool_close(zpool_handle
);
3686 if (type
== ZFS_TYPE_VOLUME
) {
3688 * If we are creating a volume, the size and block size must
3689 * satisfy a few restraints. First, the blocksize must be a
3690 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3691 * volsize must be a multiple of the block size, and cannot be
3694 if (props
== NULL
|| nvlist_lookup_uint64(props
,
3695 zfs_prop_to_name(ZFS_PROP_VOLSIZE
), &size
) != 0) {
3697 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3698 "missing volume size"));
3699 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3702 if ((ret
= nvlist_lookup_uint64(props
,
3703 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
3704 &blocksize
)) != 0) {
3705 if (ret
== ENOENT
) {
3706 blocksize
= zfs_prop_default_numeric(
3707 ZFS_PROP_VOLBLOCKSIZE
);
3710 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3711 "missing volume block size"));
3712 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3718 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3719 "volume size cannot be zero"));
3720 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3723 if (size
% blocksize
!= 0) {
3725 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3726 "volume size must be a multiple of volume block "
3728 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3732 (void) parent_name(path
, parent
, sizeof (parent
));
3733 if (zfs_crypto_create(hdl
, parent
, props
, NULL
, B_TRUE
,
3734 &wkeydata
, &wkeylen
) != 0) {
3736 return (zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
));
3739 /* create the dataset */
3740 ret
= lzc_create(path
, ost
, props
, wkeydata
, wkeylen
);
3742 if (wkeydata
!= NULL
)
3745 /* check for failure */
3749 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3750 "no such parent '%s'"), parent
);
3751 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3754 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3755 "pool must be upgraded to set this "
3756 "property or value"));
3757 return (zfs_error(hdl
, EZFS_BADVERSION
, errbuf
));
3760 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3761 "encryption root's key is not loaded "
3763 return (zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
));
3766 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3767 "invalid property value(s) specified"));
3768 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3772 * This platform can't address a volume this big.
3774 if (type
== ZFS_TYPE_VOLUME
)
3775 return (zfs_error(hdl
, EZFS_VOLTOOBIG
,
3780 return (zfs_standard_error(hdl
, errno
, errbuf
));
3788 * Destroys the given dataset. The caller must make sure that the filesystem
3789 * isn't mounted, and that there are no active dependents. If the file system
3790 * does not exist this function does nothing.
3793 zfs_destroy(zfs_handle_t
*zhp
, boolean_t defer
)
3797 if (zhp
->zfs_type
!= ZFS_TYPE_SNAPSHOT
&& defer
)
3800 if (zhp
->zfs_type
== ZFS_TYPE_BOOKMARK
) {
3801 nvlist_t
*nv
= fnvlist_alloc();
3802 fnvlist_add_boolean(nv
, zhp
->zfs_name
);
3803 error
= lzc_destroy_bookmarks(nv
, NULL
);
3806 return (zfs_standard_error_fmt(zhp
->zfs_hdl
, error
,
3807 dgettext(TEXT_DOMAIN
, "cannot destroy '%s'"),
3813 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
) {
3814 nvlist_t
*nv
= fnvlist_alloc();
3815 fnvlist_add_boolean(nv
, zhp
->zfs_name
);
3816 error
= lzc_destroy_snaps(nv
, defer
, NULL
);
3819 error
= lzc_destroy(zhp
->zfs_name
);
3822 if (error
!= 0 && error
!= ENOENT
) {
3823 return (zfs_standard_error_fmt(zhp
->zfs_hdl
, errno
,
3824 dgettext(TEXT_DOMAIN
, "cannot destroy '%s'"),
3828 remove_mountpoint(zhp
);
3833 struct destroydata
{
3835 const char *snapname
;
3839 zfs_check_snap_cb(zfs_handle_t
*zhp
, void *arg
)
3841 struct destroydata
*dd
= arg
;
3842 char name
[ZFS_MAX_DATASET_NAME_LEN
];
3845 if (snprintf(name
, sizeof (name
), "%s@%s", zhp
->zfs_name
,
3846 dd
->snapname
) >= sizeof (name
))
3849 if (lzc_exists(name
))
3850 verify(nvlist_add_boolean(dd
->nvl
, name
) == 0);
3852 rv
= zfs_iter_filesystems(zhp
, zfs_check_snap_cb
, dd
);
3858 * Destroys all snapshots with the given name in zhp & descendants.
3861 zfs_destroy_snaps(zfs_handle_t
*zhp
, char *snapname
, boolean_t defer
)
3864 struct destroydata dd
= { 0 };
3866 dd
.snapname
= snapname
;
3867 verify(nvlist_alloc(&dd
.nvl
, NV_UNIQUE_NAME
, 0) == 0);
3868 (void) zfs_check_snap_cb(zfs_handle_dup(zhp
), &dd
);
3870 if (nvlist_empty(dd
.nvl
)) {
3871 ret
= zfs_standard_error_fmt(zhp
->zfs_hdl
, ENOENT
,
3872 dgettext(TEXT_DOMAIN
, "cannot destroy '%s@%s'"),
3873 zhp
->zfs_name
, snapname
);
3875 ret
= zfs_destroy_snaps_nvl(zhp
->zfs_hdl
, dd
.nvl
, defer
);
3877 nvlist_free(dd
.nvl
);
3882 * Destroys all the snapshots named in the nvlist.
3885 zfs_destroy_snaps_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
, boolean_t defer
)
3887 nvlist_t
*errlist
= NULL
;
3890 int ret
= zfs_destroy_snaps_nvl_os(hdl
, snaps
);
3894 ret
= lzc_destroy_snaps(snaps
, defer
, &errlist
);
3897 nvlist_free(errlist
);
3901 if (nvlist_empty(errlist
)) {
3903 (void) snprintf(errbuf
, sizeof (errbuf
),
3904 dgettext(TEXT_DOMAIN
, "cannot destroy snapshots"));
3906 ret
= zfs_standard_error(hdl
, ret
, errbuf
);
3908 for (pair
= nvlist_next_nvpair(errlist
, NULL
);
3909 pair
!= NULL
; pair
= nvlist_next_nvpair(errlist
, pair
)) {
3911 (void) snprintf(errbuf
, sizeof (errbuf
),
3912 dgettext(TEXT_DOMAIN
, "cannot destroy snapshot %s"),
3915 switch (fnvpair_value_int32(pair
)) {
3918 dgettext(TEXT_DOMAIN
, "snapshot is cloned"));
3919 ret
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3922 ret
= zfs_standard_error(hdl
, errno
, errbuf
);
3927 nvlist_free(errlist
);
3932 * Clones the given dataset. The target must be of the same type as the source.
3935 zfs_clone(zfs_handle_t
*zhp
, const char *target
, nvlist_t
*props
)
3937 char parent
[ZFS_MAX_DATASET_NAME_LEN
];
3940 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3943 assert(zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
);
3945 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3946 "cannot create '%s'"), target
);
3948 /* validate the target/clone name */
3949 if (!zfs_validate_name(hdl
, target
, ZFS_TYPE_FILESYSTEM
, B_TRUE
))
3950 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3952 /* validate parents exist */
3953 if (check_parents(hdl
, target
, &zoned
, B_FALSE
, NULL
) != 0)
3956 (void) parent_name(target
, parent
, sizeof (parent
));
3963 if (ZFS_IS_VOLUME(zhp
)) {
3964 type
= ZFS_TYPE_VOLUME
;
3966 type
= ZFS_TYPE_FILESYSTEM
;
3968 if ((props
= zfs_valid_proplist(hdl
, type
, props
, zoned
,
3969 zhp
, zhp
->zpool_hdl
, B_TRUE
, errbuf
)) == NULL
)
3971 if (zfs_fix_auto_resv(zhp
, props
) == -1) {
3977 if (zfs_crypto_clone_check(hdl
, zhp
, parent
, props
) != 0) {
3979 return (zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
));
3982 ret
= lzc_clone(target
, zhp
->zfs_name
, props
);
3990 * The parent doesn't exist. We should have caught this
3991 * above, but there may a race condition that has since
3992 * destroyed the parent.
3994 * At this point, we don't know whether it's the source
3995 * that doesn't exist anymore, or whether the target
3996 * dataset doesn't exist.
3998 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
3999 "no such parent '%s'"), parent
);
4000 return (zfs_error(zhp
->zfs_hdl
, EZFS_NOENT
, errbuf
));
4003 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
4004 "source and target pools differ"));
4005 return (zfs_error(zhp
->zfs_hdl
, EZFS_CROSSTARGET
,
4009 return (zfs_standard_error(zhp
->zfs_hdl
, errno
,
4018 * Promotes the given clone fs to be the clone parent.
4021 zfs_promote(zfs_handle_t
*zhp
)
4023 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4024 char snapname
[ZFS_MAX_DATASET_NAME_LEN
];
4028 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4029 "cannot promote '%s'"), zhp
->zfs_name
);
4031 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
) {
4032 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4033 "snapshots can not be promoted"));
4034 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
4037 if (zhp
->zfs_dmustats
.dds_origin
[0] == '\0') {
4038 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4039 "not a cloned filesystem"));
4040 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
4043 if (!zfs_validate_name(hdl
, zhp
->zfs_name
, zhp
->zfs_type
, B_TRUE
))
4044 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
4046 ret
= lzc_promote(zhp
->zfs_name
, snapname
, sizeof (snapname
));
4052 * Promoting encrypted dataset outside its
4055 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4056 "cannot promote dataset outside its "
4057 "encryption root"));
4058 return (zfs_error(hdl
, EZFS_EXISTS
, errbuf
));
4061 /* There is a conflicting snapshot name. */
4062 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4063 "conflicting snapshot '%s' from parent '%s'"),
4064 snapname
, zhp
->zfs_dmustats
.dds_origin
);
4065 return (zfs_error(hdl
, EZFS_EXISTS
, errbuf
));
4068 return (zfs_standard_error(hdl
, ret
, errbuf
));
4074 typedef struct snapdata
{
4076 const char *sd_snapname
;
4080 zfs_snapshot_cb(zfs_handle_t
*zhp
, void *arg
)
4082 snapdata_t
*sd
= arg
;
4083 char name
[ZFS_MAX_DATASET_NAME_LEN
];
4086 if (zfs_prop_get_int(zhp
, ZFS_PROP_INCONSISTENT
) == 0) {
4087 if (snprintf(name
, sizeof (name
), "%s@%s", zfs_get_name(zhp
),
4088 sd
->sd_snapname
) >= sizeof (name
))
4091 fnvlist_add_boolean(sd
->sd_nvl
, name
);
4093 rv
= zfs_iter_filesystems(zhp
, zfs_snapshot_cb
, sd
);
4101 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
4105 zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
, nvlist_t
*props
)
4111 zpool_handle_t
*zpool_hdl
;
4112 char pool
[ZFS_MAX_DATASET_NAME_LEN
];
4114 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4115 "cannot create snapshots "));
4118 while ((elem
= nvlist_next_nvpair(snaps
, elem
)) != NULL
) {
4119 const char *snapname
= nvpair_name(elem
);
4121 /* validate the target name */
4122 if (!zfs_validate_name(hdl
, snapname
, ZFS_TYPE_SNAPSHOT
,
4124 (void) snprintf(errbuf
, sizeof (errbuf
),
4125 dgettext(TEXT_DOMAIN
,
4126 "cannot create snapshot '%s'"), snapname
);
4127 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
4132 * get pool handle for prop validation. assumes all snaps are in the
4133 * same pool, as does lzc_snapshot (below).
4135 elem
= nvlist_next_nvpair(snaps
, NULL
);
4136 (void) strlcpy(pool
, nvpair_name(elem
), sizeof (pool
));
4137 pool
[strcspn(pool
, "/@")] = '\0';
4138 zpool_hdl
= zpool_open(hdl
, pool
);
4139 if (zpool_hdl
== NULL
)
4142 if (props
!= NULL
&&
4143 (props
= zfs_valid_proplist(hdl
, ZFS_TYPE_SNAPSHOT
,
4144 props
, B_FALSE
, NULL
, zpool_hdl
, B_FALSE
, errbuf
)) == NULL
) {
4145 zpool_close(zpool_hdl
);
4148 zpool_close(zpool_hdl
);
4150 ret
= lzc_snapshot(snaps
, props
, &errors
);
4153 boolean_t printed
= B_FALSE
;
4154 for (elem
= nvlist_next_nvpair(errors
, NULL
);
4156 elem
= nvlist_next_nvpair(errors
, elem
)) {
4157 (void) snprintf(errbuf
, sizeof (errbuf
),
4158 dgettext(TEXT_DOMAIN
,
4159 "cannot create snapshot '%s'"), nvpair_name(elem
));
4160 (void) zfs_standard_error(hdl
,
4161 fnvpair_value_int32(elem
), errbuf
);
4167 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4168 "multiple snapshots of same "
4170 (void) zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
4174 (void) zfs_standard_error(hdl
, ret
, errbuf
);
4180 nvlist_free(errors
);
4185 zfs_snapshot(libzfs_handle_t
*hdl
, const char *path
, boolean_t recursive
,
4189 snapdata_t sd
= { 0 };
4190 char fsname
[ZFS_MAX_DATASET_NAME_LEN
];
4195 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4196 "cannot snapshot %s"), path
);
4198 if (!zfs_validate_name(hdl
, path
, ZFS_TYPE_SNAPSHOT
, B_TRUE
))
4199 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
4201 (void) strlcpy(fsname
, path
, sizeof (fsname
));
4202 cp
= strchr(fsname
, '@');
4204 sd
.sd_snapname
= cp
+ 1;
4206 if ((zhp
= zfs_open(hdl
, fsname
, ZFS_TYPE_FILESYSTEM
|
4207 ZFS_TYPE_VOLUME
)) == NULL
) {
4211 verify(nvlist_alloc(&sd
.sd_nvl
, NV_UNIQUE_NAME
, 0) == 0);
4213 (void) zfs_snapshot_cb(zfs_handle_dup(zhp
), &sd
);
4215 fnvlist_add_boolean(sd
.sd_nvl
, path
);
4218 ret
= zfs_snapshot_nvl(hdl
, sd
.sd_nvl
, props
);
4219 nvlist_free(sd
.sd_nvl
);
4225 * Destroy any more recent snapshots. We invoke this callback on any dependents
4226 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
4227 * is a dependent and we should just destroy it without checking the transaction
4230 typedef struct rollback_data
{
4231 const char *cb_target
; /* the snapshot */
4232 uint64_t cb_create
; /* creation time reference */
4238 rollback_destroy_dependent(zfs_handle_t
*zhp
, void *data
)
4240 rollback_data_t
*cbp
= data
;
4241 prop_changelist_t
*clp
;
4243 /* We must destroy this clone; first unmount it */
4244 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
4245 cbp
->cb_force
? MS_FORCE
: 0);
4246 if (clp
== NULL
|| changelist_prefix(clp
) != 0) {
4247 cbp
->cb_error
= B_TRUE
;
4251 if (zfs_destroy(zhp
, B_FALSE
) != 0)
4252 cbp
->cb_error
= B_TRUE
;
4254 changelist_remove(clp
, zhp
->zfs_name
);
4255 (void) changelist_postfix(clp
);
4256 changelist_free(clp
);
4263 rollback_destroy(zfs_handle_t
*zhp
, void *data
)
4265 rollback_data_t
*cbp
= data
;
4267 if (zfs_prop_get_int(zhp
, ZFS_PROP_CREATETXG
) > cbp
->cb_create
) {
4268 cbp
->cb_error
|= zfs_iter_dependents(zhp
, B_FALSE
,
4269 rollback_destroy_dependent
, cbp
);
4271 cbp
->cb_error
|= zfs_destroy(zhp
, B_FALSE
);
4279 * Given a dataset, rollback to a specific snapshot, discarding any
4280 * data changes since then and making it the active dataset.
4282 * Any snapshots and bookmarks more recent than the target are
4283 * destroyed, along with their dependents (i.e. clones).
4286 zfs_rollback(zfs_handle_t
*zhp
, zfs_handle_t
*snap
, boolean_t force
)
4288 rollback_data_t cb
= { 0 };
4290 boolean_t restore_resv
= 0;
4291 uint64_t old_volsize
= 0, new_volsize
;
4292 zfs_prop_t resv_prop
= { 0 };
4293 uint64_t min_txg
= 0;
4295 assert(zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
||
4296 zhp
->zfs_type
== ZFS_TYPE_VOLUME
);
4299 * Destroy all recent snapshots and their dependents.
4301 cb
.cb_force
= force
;
4302 cb
.cb_target
= snap
->zfs_name
;
4303 cb
.cb_create
= zfs_prop_get_int(snap
, ZFS_PROP_CREATETXG
);
4305 if (cb
.cb_create
> 0)
4306 min_txg
= cb
.cb_create
;
4308 (void) zfs_iter_snapshots(zhp
, B_FALSE
, rollback_destroy
, &cb
,
4311 (void) zfs_iter_bookmarks(zhp
, rollback_destroy
, &cb
);
4317 * Now that we have verified that the snapshot is the latest,
4318 * rollback to the given snapshot.
4321 if (zhp
->zfs_type
== ZFS_TYPE_VOLUME
) {
4322 if (zfs_which_resv_prop(zhp
, &resv_prop
) < 0)
4324 old_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
4326 (old_volsize
== zfs_prop_get_int(zhp
, resv_prop
));
4330 * Pass both the filesystem and the wanted snapshot names,
4331 * we would get an error back if the snapshot is destroyed or
4332 * a new snapshot is created before this request is processed.
4334 err
= lzc_rollback_to(zhp
->zfs_name
, snap
->zfs_name
);
4338 (void) snprintf(errbuf
, sizeof (errbuf
),
4339 dgettext(TEXT_DOMAIN
, "cannot rollback '%s'"),
4343 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
4344 "there is a snapshot or bookmark more recent "
4345 "than '%s'"), snap
->zfs_name
);
4346 (void) zfs_error(zhp
->zfs_hdl
, EZFS_EXISTS
, errbuf
);
4349 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
4350 "'%s' is not found among snapshots of '%s'"),
4351 snap
->zfs_name
, zhp
->zfs_name
);
4352 (void) zfs_error(zhp
->zfs_hdl
, EZFS_NOENT
, errbuf
);
4355 (void) zfs_error(zhp
->zfs_hdl
, EZFS_BADTYPE
, errbuf
);
4358 (void) zfs_standard_error(zhp
->zfs_hdl
, err
, errbuf
);
4364 * For volumes, if the pre-rollback volsize matched the pre-
4365 * rollback reservation and the volsize has changed then set
4366 * the reservation property to the post-rollback volsize.
4367 * Make a new handle since the rollback closed the dataset.
4369 if ((zhp
->zfs_type
== ZFS_TYPE_VOLUME
) &&
4370 (zhp
= make_dataset_handle(zhp
->zfs_hdl
, zhp
->zfs_name
))) {
4372 new_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
4373 if (old_volsize
!= new_volsize
)
4374 err
= zfs_prop_set_int(zhp
, resv_prop
,
4383 * Renames the given dataset.
4386 zfs_rename(zfs_handle_t
*zhp
, const char *target
, renameflags_t flags
)
4389 zfs_cmd_t zc
= {"\0"};
4391 prop_changelist_t
*cl
= NULL
;
4392 char parent
[ZFS_MAX_DATASET_NAME_LEN
];
4393 char property
[ZFS_MAXPROPLEN
];
4394 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4397 /* if we have the same exact name, just return success */
4398 if (strcmp(zhp
->zfs_name
, target
) == 0)
4401 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4402 "cannot rename to '%s'"), target
);
4404 /* make sure source name is valid */
4405 if (!zfs_validate_name(hdl
, zhp
->zfs_name
, zhp
->zfs_type
, B_TRUE
))
4406 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
4409 * Make sure the target name is valid
4411 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
) {
4412 if ((strchr(target
, '@') == NULL
) ||
4415 * Snapshot target name is abbreviated,
4416 * reconstruct full dataset name
4418 (void) strlcpy(parent
, zhp
->zfs_name
,
4420 delim
= strchr(parent
, '@');
4421 if (strchr(target
, '@') == NULL
)
4425 (void) strlcat(parent
, target
, sizeof (parent
));
4429 * Make sure we're renaming within the same dataset.
4431 delim
= strchr(target
, '@');
4432 if (strncmp(zhp
->zfs_name
, target
, delim
- target
)
4433 != 0 || zhp
->zfs_name
[delim
- target
] != '@') {
4434 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4435 "snapshots must be part of same "
4437 return (zfs_error(hdl
, EZFS_CROSSTARGET
,
4442 if (!zfs_validate_name(hdl
, target
, zhp
->zfs_type
, B_TRUE
))
4443 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
4445 if (flags
.recursive
) {
4446 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4447 "recursive rename must be a snapshot"));
4448 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
4451 if (!zfs_validate_name(hdl
, target
, zhp
->zfs_type
, B_TRUE
))
4452 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
4454 /* validate parents */
4455 if (check_parents(hdl
, target
, NULL
, B_FALSE
, NULL
) != 0)
4458 /* make sure we're in the same pool */
4459 verify((delim
= strchr(target
, '/')) != NULL
);
4460 if (strncmp(zhp
->zfs_name
, target
, delim
- target
) != 0 ||
4461 zhp
->zfs_name
[delim
- target
] != '/') {
4462 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4463 "datasets must be within same pool"));
4464 return (zfs_error(hdl
, EZFS_CROSSTARGET
, errbuf
));
4467 /* new name cannot be a child of the current dataset name */
4468 if (is_descendant(zhp
->zfs_name
, target
)) {
4469 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4470 "New dataset name cannot be a descendant of "
4471 "current dataset name"));
4472 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
4476 (void) snprintf(errbuf
, sizeof (errbuf
),
4477 dgettext(TEXT_DOMAIN
, "cannot rename '%s'"), zhp
->zfs_name
);
4479 if (getzoneid() == GLOBAL_ZONEID
&&
4480 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
)) {
4481 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4482 "dataset is used in a non-global zone"));
4483 return (zfs_error(hdl
, EZFS_ZONED
, errbuf
));
4487 * Avoid unmounting file systems with mountpoint property set to
4488 * 'legacy' or 'none' even if -u option is not given.
4490 if (zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
&&
4491 !flags
.recursive
&& !flags
.nounmount
&&
4492 zfs_prop_get(zhp
, ZFS_PROP_MOUNTPOINT
, property
,
4493 sizeof (property
), NULL
, NULL
, 0, B_FALSE
) == 0 &&
4494 (strcmp(property
, "legacy") == 0 ||
4495 strcmp(property
, "none") == 0)) {
4496 flags
.nounmount
= B_TRUE
;
4498 if (flags
.recursive
) {
4499 char *parentname
= zfs_strdup(zhp
->zfs_hdl
, zhp
->zfs_name
);
4500 if (parentname
== NULL
) {
4504 delim
= strchr(parentname
, '@');
4506 zfs_handle_t
*zhrp
= zfs_open(zhp
->zfs_hdl
, parentname
,
4514 } else if (zhp
->zfs_type
!= ZFS_TYPE_SNAPSHOT
) {
4515 if ((cl
= changelist_gather(zhp
, ZFS_PROP_NAME
,
4516 flags
.nounmount
? CL_GATHER_DONT_UNMOUNT
:
4517 CL_GATHER_ITER_MOUNTED
,
4518 flags
.forceunmount
? MS_FORCE
: 0)) == NULL
)
4521 if (changelist_haszonedchild(cl
)) {
4522 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4523 "child dataset with inherited mountpoint is used "
4524 "in a non-global zone"));
4525 (void) zfs_error(hdl
, EZFS_ZONED
, errbuf
);
4530 if ((ret
= changelist_prefix(cl
)) != 0)
4534 if (ZFS_IS_VOLUME(zhp
))
4535 zc
.zc_objset_type
= DMU_OST_ZVOL
;
4537 zc
.zc_objset_type
= DMU_OST_ZFS
;
4539 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
4540 (void) strlcpy(zc
.zc_value
, target
, sizeof (zc
.zc_value
));
4542 zc
.zc_cookie
= !!flags
.recursive
;
4543 zc
.zc_cookie
|= (!!flags
.nounmount
) << 1;
4545 if ((ret
= zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_RENAME
, &zc
)) != 0) {
4547 * if it was recursive, the one that actually failed will
4550 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4551 "cannot rename '%s'"), zc
.zc_name
);
4553 if (flags
.recursive
&& errno
== EEXIST
) {
4554 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4555 "a child dataset already has a snapshot "
4556 "with the new name"));
4557 (void) zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
4558 } else if (errno
== EACCES
) {
4559 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4560 "cannot move encrypted child outside of "
4561 "its encryption root"));
4562 (void) zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
);
4564 (void) zfs_standard_error(zhp
->zfs_hdl
, errno
, errbuf
);
4568 * On failure, we still want to remount any filesystems that
4569 * were previously mounted, so we don't alter the system state.
4572 (void) changelist_postfix(cl
);
4575 changelist_rename(cl
, zfs_get_name(zhp
), target
);
4576 ret
= changelist_postfix(cl
);
4582 changelist_free(cl
);
4588 zfs_get_all_props(zfs_handle_t
*zhp
)
4590 return (zhp
->zfs_props
);
4594 zfs_get_recvd_props(zfs_handle_t
*zhp
)
4596 if (zhp
->zfs_recvd_props
== NULL
)
4597 if (get_recvd_props_ioctl(zhp
) != 0)
4599 return (zhp
->zfs_recvd_props
);
4603 zfs_get_user_props(zfs_handle_t
*zhp
)
4605 return (zhp
->zfs_user_props
);
4609 * This function is used by 'zfs list' to determine the exact set of columns to
4610 * display, and their maximum widths. This does two main things:
4612 * - If this is a list of all properties, then expand the list to include
4613 * all native properties, and set a flag so that for each dataset we look
4614 * for new unique user properties and add them to the list.
4616 * - For non fixed-width properties, keep track of the maximum width seen
4617 * so that we can size the column appropriately. If the user has
4618 * requested received property values, we also need to compute the width
4619 * of the RECEIVED column.
4622 zfs_expand_proplist(zfs_handle_t
*zhp
, zprop_list_t
**plp
, boolean_t received
,
4625 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4626 zprop_list_t
*entry
;
4627 zprop_list_t
**last
, **start
;
4628 nvlist_t
*userprops
, *propval
;
4631 char buf
[ZFS_MAXPROPLEN
];
4633 if (zprop_expand_list(hdl
, plp
, ZFS_TYPE_DATASET
) != 0)
4636 userprops
= zfs_get_user_props(zhp
);
4639 if (entry
->pl_all
&& nvlist_next_nvpair(userprops
, NULL
) != NULL
) {
4641 * Go through and add any user properties as necessary. We
4642 * start by incrementing our list pointer to the first
4643 * non-native property.
4646 while (*start
!= NULL
) {
4647 if ((*start
)->pl_prop
== ZPROP_INVAL
)
4649 start
= &(*start
)->pl_next
;
4653 while ((elem
= nvlist_next_nvpair(userprops
, elem
)) != NULL
) {
4655 * See if we've already found this property in our list.
4657 for (last
= start
; *last
!= NULL
;
4658 last
= &(*last
)->pl_next
) {
4659 if (strcmp((*last
)->pl_user_prop
,
4660 nvpair_name(elem
)) == 0)
4664 if (*last
== NULL
) {
4665 if ((entry
= zfs_alloc(hdl
,
4666 sizeof (zprop_list_t
))) == NULL
||
4667 ((entry
->pl_user_prop
= zfs_strdup(hdl
,
4668 nvpair_name(elem
)))) == NULL
) {
4673 entry
->pl_prop
= ZPROP_INVAL
;
4674 entry
->pl_width
= strlen(nvpair_name(elem
));
4675 entry
->pl_all
= B_TRUE
;
4682 * Now go through and check the width of any non-fixed columns
4684 for (entry
= *plp
; entry
!= NULL
; entry
= entry
->pl_next
) {
4685 if (entry
->pl_fixed
&& !literal
)
4688 if (entry
->pl_prop
!= ZPROP_INVAL
) {
4689 if (zfs_prop_get(zhp
, entry
->pl_prop
,
4690 buf
, sizeof (buf
), NULL
, NULL
, 0, literal
) == 0) {
4691 if (strlen(buf
) > entry
->pl_width
)
4692 entry
->pl_width
= strlen(buf
);
4694 if (received
&& zfs_prop_get_recvd(zhp
,
4695 zfs_prop_to_name(entry
->pl_prop
),
4696 buf
, sizeof (buf
), literal
) == 0)
4697 if (strlen(buf
) > entry
->pl_recvd_width
)
4698 entry
->pl_recvd_width
= strlen(buf
);
4700 if (nvlist_lookup_nvlist(userprops
, entry
->pl_user_prop
,
4702 verify(nvlist_lookup_string(propval
,
4703 ZPROP_VALUE
, &strval
) == 0);
4704 if (strlen(strval
) > entry
->pl_width
)
4705 entry
->pl_width
= strlen(strval
);
4707 if (received
&& zfs_prop_get_recvd(zhp
,
4708 entry
->pl_user_prop
,
4709 buf
, sizeof (buf
), literal
) == 0)
4710 if (strlen(buf
) > entry
->pl_recvd_width
)
4711 entry
->pl_recvd_width
= strlen(buf
);
4719 zfs_prune_proplist(zfs_handle_t
*zhp
, uint8_t *props
)
4725 * Keep a reference to the props-table against which we prune the
4728 zhp
->zfs_props_table
= props
;
4730 curr
= nvlist_next_nvpair(zhp
->zfs_props
, NULL
);
4733 zfs_prop_t zfs_prop
= zfs_name_to_prop(nvpair_name(curr
));
4734 next
= nvlist_next_nvpair(zhp
->zfs_props
, curr
);
4737 * User properties will result in ZPROP_INVAL, and since we
4738 * only know how to prune standard ZFS properties, we always
4739 * leave these in the list. This can also happen if we
4740 * encounter an unknown DSL property (when running older
4741 * software, for example).
4743 if (zfs_prop
!= ZPROP_INVAL
&& props
[zfs_prop
] == B_FALSE
)
4744 (void) nvlist_remove(zhp
->zfs_props
,
4745 nvpair_name(curr
), nvpair_type(curr
));
4751 zfs_smb_acl_mgmt(libzfs_handle_t
*hdl
, char *dataset
, char *path
,
4752 zfs_smb_acl_op_t cmd
, char *resource1
, char *resource2
)
4754 zfs_cmd_t zc
= {"\0"};
4755 nvlist_t
*nvlist
= NULL
;
4758 (void) strlcpy(zc
.zc_name
, dataset
, sizeof (zc
.zc_name
));
4759 (void) strlcpy(zc
.zc_value
, path
, sizeof (zc
.zc_value
));
4760 zc
.zc_cookie
= (uint64_t)cmd
;
4762 if (cmd
== ZFS_SMB_ACL_RENAME
) {
4763 if (nvlist_alloc(&nvlist
, NV_UNIQUE_NAME
, 0) != 0) {
4764 (void) no_memory(hdl
);
4770 case ZFS_SMB_ACL_ADD
:
4771 case ZFS_SMB_ACL_REMOVE
:
4772 (void) strlcpy(zc
.zc_string
, resource1
, sizeof (zc
.zc_string
));
4774 case ZFS_SMB_ACL_RENAME
:
4775 if (nvlist_add_string(nvlist
, ZFS_SMB_ACL_SRC
,
4777 (void) no_memory(hdl
);
4780 if (nvlist_add_string(nvlist
, ZFS_SMB_ACL_TARGET
,
4782 (void) no_memory(hdl
);
4785 if (zcmd_write_src_nvlist(hdl
, &zc
, nvlist
) != 0) {
4786 nvlist_free(nvlist
);
4790 case ZFS_SMB_ACL_PURGE
:
4795 error
= ioctl(hdl
->libzfs_fd
, ZFS_IOC_SMB_ACL
, &zc
);
4796 nvlist_free(nvlist
);
4801 zfs_smb_acl_add(libzfs_handle_t
*hdl
, char *dataset
,
4802 char *path
, char *resource
)
4804 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_ADD
,
4809 zfs_smb_acl_remove(libzfs_handle_t
*hdl
, char *dataset
,
4810 char *path
, char *resource
)
4812 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_REMOVE
,
4817 zfs_smb_acl_purge(libzfs_handle_t
*hdl
, char *dataset
, char *path
)
4819 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_PURGE
,
4824 zfs_smb_acl_rename(libzfs_handle_t
*hdl
, char *dataset
, char *path
,
4825 char *oldname
, char *newname
)
4827 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_RENAME
,
4832 zfs_userspace(zfs_handle_t
*zhp
, zfs_userquota_prop_t type
,
4833 zfs_userspace_cb_t func
, void *arg
)
4835 zfs_cmd_t zc
= {"\0"};
4836 zfs_useracct_t buf
[100];
4837 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4840 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
4842 zc
.zc_objset_type
= type
;
4843 zc
.zc_nvlist_dst
= (uintptr_t)buf
;
4846 zfs_useracct_t
*zua
= buf
;
4848 zc
.zc_nvlist_dst_size
= sizeof (buf
);
4849 if (zfs_ioctl(hdl
, ZFS_IOC_USERSPACE_MANY
, &zc
) != 0) {
4850 if ((errno
== ENOTSUP
&&
4851 (type
== ZFS_PROP_USEROBJUSED
||
4852 type
== ZFS_PROP_GROUPOBJUSED
||
4853 type
== ZFS_PROP_USEROBJQUOTA
||
4854 type
== ZFS_PROP_GROUPOBJQUOTA
||
4855 type
== ZFS_PROP_PROJECTOBJUSED
||
4856 type
== ZFS_PROP_PROJECTOBJQUOTA
||
4857 type
== ZFS_PROP_PROJECTUSED
||
4858 type
== ZFS_PROP_PROJECTQUOTA
)))
4861 return (zfs_standard_error_fmt(hdl
, errno
,
4862 dgettext(TEXT_DOMAIN
,
4863 "cannot get used/quota for %s"), zc
.zc_name
));
4865 if (zc
.zc_nvlist_dst_size
== 0)
4868 while (zc
.zc_nvlist_dst_size
> 0) {
4869 if ((ret
= func(arg
, zua
->zu_domain
, zua
->zu_rid
,
4870 zua
->zu_space
)) != 0)
4873 zc
.zc_nvlist_dst_size
-= sizeof (zfs_useracct_t
);
4882 const char *snapname
;
4884 boolean_t recursive
;
4889 zfs_hold_one(zfs_handle_t
*zhp
, void *arg
)
4891 struct holdarg
*ha
= arg
;
4892 char name
[ZFS_MAX_DATASET_NAME_LEN
];
4895 if (snprintf(name
, sizeof (name
), "%s@%s", zhp
->zfs_name
,
4896 ha
->snapname
) >= sizeof (name
))
4899 if (lzc_exists(name
))
4900 fnvlist_add_string(ha
->nvl
, name
, ha
->tag
);
4903 rv
= zfs_iter_filesystems(zhp
, zfs_hold_one
, ha
);
4909 zfs_hold(zfs_handle_t
*zhp
, const char *snapname
, const char *tag
,
4910 boolean_t recursive
, int cleanup_fd
)
4915 ha
.nvl
= fnvlist_alloc();
4916 ha
.snapname
= snapname
;
4918 ha
.recursive
= recursive
;
4919 (void) zfs_hold_one(zfs_handle_dup(zhp
), &ha
);
4921 if (nvlist_empty(ha
.nvl
)) {
4924 fnvlist_free(ha
.nvl
);
4926 (void) snprintf(errbuf
, sizeof (errbuf
),
4927 dgettext(TEXT_DOMAIN
,
4928 "cannot hold snapshot '%s@%s'"),
4929 zhp
->zfs_name
, snapname
);
4930 (void) zfs_standard_error(zhp
->zfs_hdl
, ret
, errbuf
);
4934 ret
= zfs_hold_nvl(zhp
, cleanup_fd
, ha
.nvl
);
4935 fnvlist_free(ha
.nvl
);
4941 zfs_hold_nvl(zfs_handle_t
*zhp
, int cleanup_fd
, nvlist_t
*holds
)
4945 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4950 ret
= lzc_hold(holds
, cleanup_fd
, &errors
);
4953 /* There may be errors even in the success case. */
4954 fnvlist_free(errors
);
4958 if (nvlist_empty(errors
)) {
4959 /* no hold-specific errors */
4960 (void) snprintf(errbuf
, sizeof (errbuf
),
4961 dgettext(TEXT_DOMAIN
, "cannot hold"));
4964 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4965 "pool must be upgraded"));
4966 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4969 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4972 (void) zfs_standard_error(hdl
, ret
, errbuf
);
4976 for (elem
= nvlist_next_nvpair(errors
, NULL
);
4978 elem
= nvlist_next_nvpair(errors
, elem
)) {
4979 (void) snprintf(errbuf
, sizeof (errbuf
),
4980 dgettext(TEXT_DOMAIN
,
4981 "cannot hold snapshot '%s'"), nvpair_name(elem
));
4982 switch (fnvpair_value_int32(elem
)) {
4985 * Temporary tags wind up having the ds object id
4986 * prepended. So even if we passed the length check
4987 * above, it's still possible for the tag to wind
4988 * up being slightly too long.
4990 (void) zfs_error(hdl
, EZFS_TAGTOOLONG
, errbuf
);
4993 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4996 (void) zfs_error(hdl
, EZFS_REFTAG_HOLD
, errbuf
);
4999 (void) zfs_standard_error(hdl
,
5000 fnvpair_value_int32(elem
), errbuf
);
5004 fnvlist_free(errors
);
5009 zfs_release_one(zfs_handle_t
*zhp
, void *arg
)
5011 struct holdarg
*ha
= arg
;
5012 char name
[ZFS_MAX_DATASET_NAME_LEN
];
5014 nvlist_t
*existing_holds
;
5016 if (snprintf(name
, sizeof (name
), "%s@%s", zhp
->zfs_name
,
5017 ha
->snapname
) >= sizeof (name
)) {
5022 if (lzc_get_holds(name
, &existing_holds
) != 0) {
5024 } else if (!nvlist_exists(existing_holds
, ha
->tag
)) {
5027 nvlist_t
*torelease
= fnvlist_alloc();
5028 fnvlist_add_boolean(torelease
, ha
->tag
);
5029 fnvlist_add_nvlist(ha
->nvl
, name
, torelease
);
5030 fnvlist_free(torelease
);
5034 rv
= zfs_iter_filesystems(zhp
, zfs_release_one
, ha
);
5040 zfs_release(zfs_handle_t
*zhp
, const char *snapname
, const char *tag
,
5041 boolean_t recursive
)
5045 nvlist_t
*errors
= NULL
;
5047 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
5050 ha
.nvl
= fnvlist_alloc();
5051 ha
.snapname
= snapname
;
5053 ha
.recursive
= recursive
;
5055 (void) zfs_release_one(zfs_handle_dup(zhp
), &ha
);
5057 if (nvlist_empty(ha
.nvl
)) {
5058 fnvlist_free(ha
.nvl
);
5060 (void) snprintf(errbuf
, sizeof (errbuf
),
5061 dgettext(TEXT_DOMAIN
,
5062 "cannot release hold from snapshot '%s@%s'"),
5063 zhp
->zfs_name
, snapname
);
5065 (void) zfs_error(hdl
, EZFS_REFTAG_RELE
, errbuf
);
5067 (void) zfs_standard_error(hdl
, ret
, errbuf
);
5072 ret
= lzc_release(ha
.nvl
, &errors
);
5073 fnvlist_free(ha
.nvl
);
5076 /* There may be errors even in the success case. */
5077 fnvlist_free(errors
);
5081 if (nvlist_empty(errors
)) {
5082 /* no hold-specific errors */
5083 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
5087 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
5088 "pool must be upgraded"));
5089 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
5092 (void) zfs_standard_error(hdl
, errno
, errbuf
);
5096 for (elem
= nvlist_next_nvpair(errors
, NULL
);
5098 elem
= nvlist_next_nvpair(errors
, elem
)) {
5099 (void) snprintf(errbuf
, sizeof (errbuf
),
5100 dgettext(TEXT_DOMAIN
,
5101 "cannot release hold from snapshot '%s'"),
5103 switch (fnvpair_value_int32(elem
)) {
5105 (void) zfs_error(hdl
, EZFS_REFTAG_RELE
, errbuf
);
5108 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
5111 (void) zfs_standard_error(hdl
,
5112 fnvpair_value_int32(elem
), errbuf
);
5116 fnvlist_free(errors
);
5121 zfs_get_fsacl(zfs_handle_t
*zhp
, nvlist_t
**nvl
)
5123 zfs_cmd_t zc
= {"\0"};
5124 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
5130 assert(zhp
->zfs_type
== ZFS_TYPE_VOLUME
||
5131 zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
);
5135 nvbuf
= malloc(nvsz
);
5136 if (nvbuf
== NULL
) {
5137 err
= (zfs_error(hdl
, EZFS_NOMEM
, strerror(errno
)));
5141 zc
.zc_nvlist_dst_size
= nvsz
;
5142 zc
.zc_nvlist_dst
= (uintptr_t)nvbuf
;
5144 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
5146 if (zfs_ioctl(hdl
, ZFS_IOC_GET_FSACL
, &zc
) != 0) {
5147 (void) snprintf(errbuf
, sizeof (errbuf
),
5148 dgettext(TEXT_DOMAIN
, "cannot get permissions on '%s'"),
5153 nvsz
= zc
.zc_nvlist_dst_size
;
5157 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
5158 "pool must be upgraded"));
5159 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
5162 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
5165 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
5168 err
= zfs_standard_error(hdl
, errno
, errbuf
);
5173 int rc
= nvlist_unpack(nvbuf
, zc
.zc_nvlist_dst_size
, nvl
, 0);
5175 err
= zfs_standard_error_fmt(hdl
, rc
, dgettext(
5176 TEXT_DOMAIN
, "cannot get permissions on '%s'"),
5187 zfs_set_fsacl(zfs_handle_t
*zhp
, boolean_t un
, nvlist_t
*nvl
)
5189 zfs_cmd_t zc
= {"\0"};
5190 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
5196 assert(zhp
->zfs_type
== ZFS_TYPE_VOLUME
||
5197 zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
);
5199 err
= nvlist_size(nvl
, &nvsz
, NV_ENCODE_NATIVE
);
5202 nvbuf
= malloc(nvsz
);
5204 err
= nvlist_pack(nvl
, &nvbuf
, &nvsz
, NV_ENCODE_NATIVE
, 0);
5207 zc
.zc_nvlist_src_size
= nvsz
;
5208 zc
.zc_nvlist_src
= (uintptr_t)nvbuf
;
5209 zc
.zc_perm_action
= un
;
5211 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
5213 if (zfs_ioctl(hdl
, ZFS_IOC_SET_FSACL
, &zc
) != 0) {
5214 (void) snprintf(errbuf
, sizeof (errbuf
),
5215 dgettext(TEXT_DOMAIN
, "cannot set permissions on '%s'"),
5219 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
5220 "pool must be upgraded"));
5221 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
5224 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
5227 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
5230 err
= zfs_standard_error(hdl
, errno
, errbuf
);
5241 zfs_get_holds(zfs_handle_t
*zhp
, nvlist_t
**nvl
)
5246 err
= lzc_get_holds(zhp
->zfs_name
, nvl
);
5249 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
5251 (void) snprintf(errbuf
, sizeof (errbuf
),
5252 dgettext(TEXT_DOMAIN
, "cannot get holds for '%s'"),
5256 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
5257 "pool must be upgraded"));
5258 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
5261 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
5264 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
5267 err
= zfs_standard_error(hdl
, errno
, errbuf
);
5276 * The theory of raidz space accounting
5278 * The "referenced" property of RAIDZ vdevs is scaled such that a 128KB block
5279 * will "reference" 128KB, even though it allocates more than that, to store the
5280 * parity information (and perhaps skip sectors). This concept of the
5281 * "referenced" (and other DMU space accounting) being lower than the allocated
5282 * space by a constant factor is called "raidz deflation."
5284 * As mentioned above, the constant factor for raidz deflation assumes a 128KB
5285 * block size. However, zvols typically have a much smaller block size (default
5286 * 8KB). These smaller blocks may require proportionally much more parity
5287 * information (and perhaps skip sectors). In this case, the change to the
5288 * "referenced" property may be much more than the logical block size.
5290 * Suppose a raidz vdev has 5 disks with ashift=12. A 128k block may be written
5293 * +-------+-------+-------+-------+-------+
5294 * | disk1 | disk2 | disk3 | disk4 | disk5 |
5295 * +-------+-------+-------+-------+-------+
5296 * | P0 | D0 | D8 | D16 | D24 |
5297 * | P1 | D1 | D9 | D17 | D25 |
5298 * | P2 | D2 | D10 | D18 | D26 |
5299 * | P3 | D3 | D11 | D19 | D27 |
5300 * | P4 | D4 | D12 | D20 | D28 |
5301 * | P5 | D5 | D13 | D21 | D29 |
5302 * | P6 | D6 | D14 | D22 | D30 |
5303 * | P7 | D7 | D15 | D23 | D31 |
5304 * +-------+-------+-------+-------+-------+
5306 * Above, notice that 160k was allocated: 8 x 4k parity sectors + 32 x 4k data
5307 * sectors. The dataset's referenced will increase by 128k and the pool's
5308 * allocated and free properties will be adjusted by 160k.
5310 * A 4k block written to the same raidz vdev will require two 4k sectors. The
5311 * blank cells represent unallocated space.
5313 * +-------+-------+-------+-------+-------+
5314 * | disk1 | disk2 | disk3 | disk4 | disk5 |
5315 * +-------+-------+-------+-------+-------+
5317 * +-------+-------+-------+-------+-------+
5319 * Above, notice that the 4k block required one sector for parity and another
5320 * for data. vdev_raidz_asize() will return 8k and as such the pool's allocated
5321 * and free properties will be adjusted by 8k. The dataset will not be charged
5322 * 8k. Rather, it will be charged a value that is scaled according to the
5323 * overhead of the 128k block on the same vdev. This 8k allocation will be
5324 * charged 8k * 128k / 160k. 128k is from SPA_OLD_MAXBLOCKSIZE and 160k is as
5325 * calculated in the 128k block example above.
5327 * Every raidz allocation is sized to be a multiple of nparity+1 sectors. That
5328 * is, every raidz1 allocation will be a multiple of 2 sectors, raidz2
5329 * allocations are a multiple of 3 sectors, and raidz3 allocations are a
5330 * multiple of of 4 sectors. When a block does not fill the required number of
5331 * sectors, skip blocks (sectors) are used.
5333 * An 8k block being written to a raidz vdev may be written as follows:
5335 * +-------+-------+-------+-------+-------+
5336 * | disk1 | disk2 | disk3 | disk4 | disk5 |
5337 * +-------+-------+-------+-------+-------+
5338 * | P0 | D0 | D1 | S0 | |
5339 * +-------+-------+-------+-------+-------+
5341 * In order to maintain the nparity+1 allocation size, a skip block (S0) was
5342 * added. For this 8k block, the pool's allocated and free properties are
5343 * adjusted by 16k and the dataset's referenced is increased by 16k * 128k /
5344 * 160k. Again, 128k is from SPA_OLD_MAXBLOCKSIZE and 160k is as calculated in
5345 * the 128k block example above.
5347 * The situation is slightly different for dRAID since the minimum allocation
5348 * size is the full group width. The same 8K block above would be written as
5349 * follows in a dRAID group:
5351 * +-------+-------+-------+-------+-------+
5352 * | disk1 | disk2 | disk3 | disk4 | disk5 |
5353 * +-------+-------+-------+-------+-------+
5354 * | P0 | D0 | D1 | S0 | S1 |
5355 * +-------+-------+-------+-------+-------+
5357 * Compression may lead to a variety of block sizes being written for the same
5358 * volume or file. There is no clear way to reserve just the amount of space
5359 * that will be required, so the worst case (no compression) is assumed.
5360 * Note that metadata blocks will typically be compressed, so the reservation
5361 * size returned by zvol_volsize_to_reservation() will generally be slightly
5362 * larger than the maximum that the volume can reference.
5366 * Derived from function of same name in module/zfs/vdev_raidz.c. Returns the
5367 * amount of space (in bytes) that will be allocated for the specified block
5368 * size. Note that the "referenced" space accounted will be less than this, but
5369 * not necessarily equal to "blksize", due to RAIDZ deflation.
5372 vdev_raidz_asize(uint64_t ndisks
, uint64_t nparity
, uint64_t ashift
,
5375 uint64_t asize
, ndata
;
5377 ASSERT3U(ndisks
, >, nparity
);
5378 ndata
= ndisks
- nparity
;
5379 asize
= ((blksize
- 1) >> ashift
) + 1;
5380 asize
+= nparity
* ((asize
+ ndata
- 1) / ndata
);
5381 asize
= roundup(asize
, nparity
+ 1) << ashift
;
5387 * Derived from function of same name in module/zfs/vdev_draid.c. Returns the
5388 * amount of space (in bytes) that will be allocated for the specified block
5392 vdev_draid_asize(uint64_t ndisks
, uint64_t nparity
, uint64_t ashift
,
5395 ASSERT3U(ndisks
, >, nparity
);
5396 uint64_t ndata
= ndisks
- nparity
;
5397 uint64_t rows
= ((blksize
- 1) / (ndata
<< ashift
)) + 1;
5398 uint64_t asize
= (rows
* ndisks
) << ashift
;
5404 * Determine how much space will be allocated if it lands on the most space-
5405 * inefficient top-level vdev. Returns the size in bytes required to store one
5406 * copy of the volume data. See theory comment above.
5409 volsize_from_vdevs(zpool_handle_t
*zhp
, uint64_t nblocks
, uint64_t blksize
)
5411 nvlist_t
*config
, *tree
, **vdevs
;
5415 config
= zpool_get_config(zhp
, NULL
);
5416 if (nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
, &tree
) != 0 ||
5417 nvlist_lookup_nvlist_array(tree
, ZPOOL_CONFIG_CHILDREN
,
5418 &vdevs
, &nvdevs
) != 0) {
5419 return (nblocks
* blksize
);
5422 for (int v
= 0; v
< nvdevs
; v
++) {
5424 uint64_t nparity
, ashift
, asize
, tsize
;
5427 if (nvlist_lookup_string(vdevs
[v
], ZPOOL_CONFIG_TYPE
,
5431 if (strcmp(type
, VDEV_TYPE_RAIDZ
) != 0 &&
5432 strcmp(type
, VDEV_TYPE_DRAID
) != 0)
5435 if (nvlist_lookup_uint64(vdevs
[v
],
5436 ZPOOL_CONFIG_NPARITY
, &nparity
) != 0)
5439 if (nvlist_lookup_uint64(vdevs
[v
],
5440 ZPOOL_CONFIG_ASHIFT
, &ashift
) != 0)
5443 if (strcmp(type
, VDEV_TYPE_RAIDZ
) == 0) {
5447 if (nvlist_lookup_nvlist_array(vdevs
[v
],
5448 ZPOOL_CONFIG_CHILDREN
, &disks
, &ndisks
) != 0)
5451 /* allocation size for the "typical" 128k block */
5452 tsize
= vdev_raidz_asize(ndisks
, nparity
, ashift
,
5453 SPA_OLD_MAXBLOCKSIZE
);
5455 /* allocation size for the blksize block */
5456 asize
= vdev_raidz_asize(ndisks
, nparity
, ashift
,
5461 if (nvlist_lookup_uint64(vdevs
[v
],
5462 ZPOOL_CONFIG_DRAID_NDATA
, &ndata
) != 0)
5465 /* allocation size for the "typical" 128k block */
5466 tsize
= vdev_draid_asize(ndata
+ nparity
, nparity
,
5467 ashift
, SPA_OLD_MAXBLOCKSIZE
);
5469 /* allocation size for the blksize block */
5470 asize
= vdev_draid_asize(ndata
+ nparity
, nparity
,
5475 * Scale this size down as a ratio of 128k / tsize.
5476 * See theory statement above.
5478 volsize
= nblocks
* asize
* SPA_OLD_MAXBLOCKSIZE
/ tsize
;
5479 if (volsize
> ret
) {
5485 ret
= nblocks
* blksize
;
5492 * Convert the zvol's volume size to an appropriate reservation. See theory
5495 * Note: If this routine is updated, it is necessary to update the ZFS test
5496 * suite's shell version in reservation.shlib.
5499 zvol_volsize_to_reservation(zpool_handle_t
*zph
, uint64_t volsize
,
5503 uint64_t nblocks
, volblocksize
;
5507 if (nvlist_lookup_string(props
,
5508 zfs_prop_to_name(ZFS_PROP_COPIES
), &strval
) == 0)
5509 ncopies
= atoi(strval
);
5512 if (nvlist_lookup_uint64(props
,
5513 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
5514 &volblocksize
) != 0)
5515 volblocksize
= ZVOL_DEFAULT_BLOCKSIZE
;
5517 nblocks
= volsize
/ volblocksize
;
5519 * Metadata defaults to using 128k blocks, not volblocksize blocks. For
5520 * this reason, only the data blocks are scaled based on vdev config.
5522 volsize
= volsize_from_vdevs(zph
, nblocks
, volblocksize
);
5524 /* start with metadnode L0-L6 */
5526 /* calculate number of indirects */
5527 while (nblocks
> 1) {
5528 nblocks
+= DNODES_PER_LEVEL
- 1;
5529 nblocks
/= DNODES_PER_LEVEL
;
5532 numdb
*= MIN(SPA_DVAS_PER_BP
, ncopies
+ 1);
5535 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
5536 * compressed, but in practice they compress down to about
5539 numdb
*= 1ULL << DN_MAX_INDBLKSHIFT
;
5545 * Wait for the given activity and return the status of the wait (whether or not
5546 * any waiting was done) in the 'waited' parameter. Non-existent fses are
5547 * reported via the 'missing' parameter, rather than by printing an error
5548 * message. This is convenient when this function is called in a loop over a
5549 * long period of time (as it is, for example, by zfs's wait cmd). In that
5550 * scenario, a fs being exported or destroyed should be considered a normal
5551 * event, so we don't want to print an error when we find that the fs doesn't
5555 zfs_wait_status(zfs_handle_t
*zhp
, zfs_wait_activity_t activity
,
5556 boolean_t
*missing
, boolean_t
*waited
)
5558 int error
= lzc_wait_fs(zhp
->zfs_name
, activity
, waited
);
5559 *missing
= (error
== ENOENT
);
5564 (void) zfs_standard_error_fmt(zhp
->zfs_hdl
, error
,
5565 dgettext(TEXT_DOMAIN
, "error waiting in fs '%s'"),