4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
25 * Copyright (c) 2011, 2017 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 RackTop Systems.
46 #include <sys/mntent.h>
47 #include <sys/mount.h>
55 #include <directory.h>
56 #endif /* HAVE_IDMAP */
58 #include <sys/dnode.h>
61 #include <sys/dsl_crypt.h>
64 #include "zfs_namecheck.h"
66 #include "libzfs_impl.h"
68 #include "zfs_deleg.h"
70 static int userquota_propname_decode(const char *propname
, boolean_t zoned
,
71 zfs_userquota_prop_t
*typep
, char *domain
, int domainlen
, uint64_t *ridp
);
74 * Given a single type (not a mask of types), return the type in a human
78 zfs_type_to_name(zfs_type_t type
)
81 case ZFS_TYPE_FILESYSTEM
:
82 return (dgettext(TEXT_DOMAIN
, "filesystem"));
83 case ZFS_TYPE_SNAPSHOT
:
84 return (dgettext(TEXT_DOMAIN
, "snapshot"));
86 return (dgettext(TEXT_DOMAIN
, "volume"));
88 return (dgettext(TEXT_DOMAIN
, "pool"));
89 case ZFS_TYPE_BOOKMARK
:
90 return (dgettext(TEXT_DOMAIN
, "bookmark"));
92 assert(!"unhandled zfs_type_t");
99 * Validate a ZFS path. This is used even before trying to open the dataset, to
100 * provide a more meaningful error message. We call zfs_error_aux() to
101 * explain exactly why the name was not valid.
104 zfs_validate_name(libzfs_handle_t
*hdl
, const char *path
, int type
,
110 if (entity_namecheck(path
, &why
, &what
) != 0) {
113 case NAME_ERR_TOOLONG
:
114 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
115 "name is too long"));
118 case NAME_ERR_LEADING_SLASH
:
119 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
120 "leading slash in name"));
123 case NAME_ERR_EMPTY_COMPONENT
:
124 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
125 "empty component in name"));
128 case NAME_ERR_TRAILING_SLASH
:
129 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
130 "trailing slash in name"));
133 case NAME_ERR_INVALCHAR
:
135 dgettext(TEXT_DOMAIN
, "invalid character "
136 "'%c' in name"), what
);
139 case NAME_ERR_MULTIPLE_DELIMITERS
:
140 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
141 "multiple '@' and/or '#' delimiters in "
145 case NAME_ERR_NOLETTER
:
146 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
147 "pool doesn't begin with a letter"));
150 case NAME_ERR_RESERVED
:
151 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
152 "name is reserved"));
155 case NAME_ERR_DISKLIKE
:
156 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
157 "reserved disk name"));
161 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
162 "(%d) not defined"), why
);
170 if (!(type
& ZFS_TYPE_SNAPSHOT
) && strchr(path
, '@') != NULL
) {
172 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
173 "snapshot delimiter '@' is not expected here"));
177 if (type
== ZFS_TYPE_SNAPSHOT
&& strchr(path
, '@') == NULL
) {
179 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
180 "missing '@' delimiter in snapshot name"));
184 if (!(type
& ZFS_TYPE_BOOKMARK
) && strchr(path
, '#') != NULL
) {
186 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
187 "bookmark delimiter '#' is not expected here"));
191 if (type
== ZFS_TYPE_BOOKMARK
&& strchr(path
, '#') == NULL
) {
193 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
194 "missing '#' delimiter in bookmark name"));
198 if (modifying
&& strchr(path
, '%') != NULL
) {
200 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
201 "invalid character %c in name"), '%');
209 zfs_name_valid(const char *name
, zfs_type_t type
)
211 if (type
== ZFS_TYPE_POOL
)
212 return (zpool_name_valid(NULL
, B_FALSE
, name
));
213 return (zfs_validate_name(NULL
, name
, type
, B_FALSE
));
217 * This function takes the raw DSL properties, and filters out the user-defined
218 * properties into a separate nvlist.
221 process_user_props(zfs_handle_t
*zhp
, nvlist_t
*props
)
223 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
228 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0) {
229 (void) no_memory(hdl
);
234 while ((elem
= nvlist_next_nvpair(props
, elem
)) != NULL
) {
235 if (!zfs_prop_user(nvpair_name(elem
)))
238 verify(nvpair_value_nvlist(elem
, &propval
) == 0);
239 if (nvlist_add_nvlist(nvl
, nvpair_name(elem
), propval
) != 0) {
241 (void) no_memory(hdl
);
249 static zpool_handle_t
*
250 zpool_add_handle(zfs_handle_t
*zhp
, const char *pool_name
)
252 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
255 if ((zph
= zpool_open_canfail(hdl
, pool_name
)) != NULL
) {
256 if (hdl
->libzfs_pool_handles
!= NULL
)
257 zph
->zpool_next
= hdl
->libzfs_pool_handles
;
258 hdl
->libzfs_pool_handles
= zph
;
263 static zpool_handle_t
*
264 zpool_find_handle(zfs_handle_t
*zhp
, const char *pool_name
, int len
)
266 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
267 zpool_handle_t
*zph
= hdl
->libzfs_pool_handles
;
269 while ((zph
!= NULL
) &&
270 (strncmp(pool_name
, zpool_get_name(zph
), len
) != 0))
271 zph
= zph
->zpool_next
;
276 * Returns a handle to the pool that contains the provided dataset.
277 * If a handle to that pool already exists then that handle is returned.
278 * Otherwise, a new handle is created and added to the list of handles.
280 static zpool_handle_t
*
281 zpool_handle(zfs_handle_t
*zhp
)
287 len
= strcspn(zhp
->zfs_name
, "/@#") + 1;
288 pool_name
= zfs_alloc(zhp
->zfs_hdl
, len
);
289 (void) strlcpy(pool_name
, zhp
->zfs_name
, len
);
291 zph
= zpool_find_handle(zhp
, pool_name
, len
);
293 zph
= zpool_add_handle(zhp
, pool_name
);
300 zpool_free_handles(libzfs_handle_t
*hdl
)
302 zpool_handle_t
*next
, *zph
= hdl
->libzfs_pool_handles
;
304 while (zph
!= NULL
) {
305 next
= zph
->zpool_next
;
309 hdl
->libzfs_pool_handles
= NULL
;
313 * Utility function to gather stats (objset and zpl) for the given object.
316 get_stats_ioctl(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
318 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
320 (void) strlcpy(zc
->zc_name
, zhp
->zfs_name
, sizeof (zc
->zc_name
));
322 while (ioctl(hdl
->libzfs_fd
, ZFS_IOC_OBJSET_STATS
, zc
) != 0) {
323 if (errno
== ENOMEM
) {
324 if (zcmd_expand_dst_nvlist(hdl
, zc
) != 0) {
335 * Utility function to get the received properties of the given object.
338 get_recvd_props_ioctl(zfs_handle_t
*zhp
)
340 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
341 nvlist_t
*recvdprops
;
342 zfs_cmd_t zc
= {"\0"};
345 if (zcmd_alloc_dst_nvlist(hdl
, &zc
, 0) != 0)
348 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
350 while (ioctl(hdl
->libzfs_fd
, ZFS_IOC_OBJSET_RECVD_PROPS
, &zc
) != 0) {
351 if (errno
== ENOMEM
) {
352 if (zcmd_expand_dst_nvlist(hdl
, &zc
) != 0) {
356 zcmd_free_nvlists(&zc
);
361 err
= zcmd_read_dst_nvlist(zhp
->zfs_hdl
, &zc
, &recvdprops
);
362 zcmd_free_nvlists(&zc
);
366 nvlist_free(zhp
->zfs_recvd_props
);
367 zhp
->zfs_recvd_props
= recvdprops
;
373 put_stats_zhdl(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
375 nvlist_t
*allprops
, *userprops
;
377 zhp
->zfs_dmustats
= zc
->zc_objset_stats
; /* structure assignment */
379 if (zcmd_read_dst_nvlist(zhp
->zfs_hdl
, zc
, &allprops
) != 0) {
384 * XXX Why do we store the user props separately, in addition to
385 * storing them in zfs_props?
387 if ((userprops
= process_user_props(zhp
, allprops
)) == NULL
) {
388 nvlist_free(allprops
);
392 nvlist_free(zhp
->zfs_props
);
393 nvlist_free(zhp
->zfs_user_props
);
395 zhp
->zfs_props
= allprops
;
396 zhp
->zfs_user_props
= userprops
;
402 get_stats(zfs_handle_t
*zhp
)
405 zfs_cmd_t zc
= {"\0"};
407 if (zcmd_alloc_dst_nvlist(zhp
->zfs_hdl
, &zc
, 0) != 0)
409 if (get_stats_ioctl(zhp
, &zc
) != 0)
411 else if (put_stats_zhdl(zhp
, &zc
) != 0)
413 zcmd_free_nvlists(&zc
);
418 * Refresh the properties currently stored in the handle.
421 zfs_refresh_properties(zfs_handle_t
*zhp
)
423 (void) get_stats(zhp
);
427 * Makes a handle from the given dataset name. Used by zfs_open() and
428 * zfs_iter_* to create child handles on the fly.
431 make_dataset_handle_common(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
433 if (put_stats_zhdl(zhp
, zc
) != 0)
437 * We've managed to open the dataset and gather statistics. Determine
438 * the high-level type.
440 if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZVOL
)
441 zhp
->zfs_head_type
= ZFS_TYPE_VOLUME
;
442 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZFS
)
443 zhp
->zfs_head_type
= ZFS_TYPE_FILESYSTEM
;
444 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_OTHER
)
449 if (zhp
->zfs_dmustats
.dds_is_snapshot
)
450 zhp
->zfs_type
= ZFS_TYPE_SNAPSHOT
;
451 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZVOL
)
452 zhp
->zfs_type
= ZFS_TYPE_VOLUME
;
453 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZFS
)
454 zhp
->zfs_type
= ZFS_TYPE_FILESYSTEM
;
456 abort(); /* we should never see any other types */
458 if ((zhp
->zpool_hdl
= zpool_handle(zhp
)) == NULL
)
465 make_dataset_handle(libzfs_handle_t
*hdl
, const char *path
)
467 zfs_cmd_t zc
= {"\0"};
469 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
475 (void) strlcpy(zhp
->zfs_name
, path
, sizeof (zhp
->zfs_name
));
476 if (zcmd_alloc_dst_nvlist(hdl
, &zc
, 0) != 0) {
480 if (get_stats_ioctl(zhp
, &zc
) == -1) {
481 zcmd_free_nvlists(&zc
);
485 if (make_dataset_handle_common(zhp
, &zc
) == -1) {
489 zcmd_free_nvlists(&zc
);
494 make_dataset_handle_zc(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
)
496 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
502 (void) strlcpy(zhp
->zfs_name
, zc
->zc_name
, sizeof (zhp
->zfs_name
));
503 if (make_dataset_handle_common(zhp
, zc
) == -1) {
511 make_dataset_simple_handle_zc(zfs_handle_t
*pzhp
, zfs_cmd_t
*zc
)
513 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
518 zhp
->zfs_hdl
= pzhp
->zfs_hdl
;
519 (void) strlcpy(zhp
->zfs_name
, zc
->zc_name
, sizeof (zhp
->zfs_name
));
520 zhp
->zfs_head_type
= pzhp
->zfs_type
;
521 zhp
->zfs_type
= ZFS_TYPE_SNAPSHOT
;
522 zhp
->zpool_hdl
= zpool_handle(zhp
);
528 zfs_handle_dup(zfs_handle_t
*zhp_orig
)
530 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
535 zhp
->zfs_hdl
= zhp_orig
->zfs_hdl
;
536 zhp
->zpool_hdl
= zhp_orig
->zpool_hdl
;
537 (void) strlcpy(zhp
->zfs_name
, zhp_orig
->zfs_name
,
538 sizeof (zhp
->zfs_name
));
539 zhp
->zfs_type
= zhp_orig
->zfs_type
;
540 zhp
->zfs_head_type
= zhp_orig
->zfs_head_type
;
541 zhp
->zfs_dmustats
= zhp_orig
->zfs_dmustats
;
542 if (zhp_orig
->zfs_props
!= NULL
) {
543 if (nvlist_dup(zhp_orig
->zfs_props
, &zhp
->zfs_props
, 0) != 0) {
544 (void) no_memory(zhp
->zfs_hdl
);
549 if (zhp_orig
->zfs_user_props
!= NULL
) {
550 if (nvlist_dup(zhp_orig
->zfs_user_props
,
551 &zhp
->zfs_user_props
, 0) != 0) {
552 (void) no_memory(zhp
->zfs_hdl
);
557 if (zhp_orig
->zfs_recvd_props
!= NULL
) {
558 if (nvlist_dup(zhp_orig
->zfs_recvd_props
,
559 &zhp
->zfs_recvd_props
, 0)) {
560 (void) no_memory(zhp
->zfs_hdl
);
565 zhp
->zfs_mntcheck
= zhp_orig
->zfs_mntcheck
;
566 if (zhp_orig
->zfs_mntopts
!= NULL
) {
567 zhp
->zfs_mntopts
= zfs_strdup(zhp_orig
->zfs_hdl
,
568 zhp_orig
->zfs_mntopts
);
570 zhp
->zfs_props_table
= zhp_orig
->zfs_props_table
;
575 zfs_bookmark_exists(const char *path
)
579 char fsname
[ZFS_MAX_DATASET_NAME_LEN
];
586 (void) strlcpy(fsname
, path
, sizeof (fsname
));
587 pound
= strchr(fsname
, '#');
592 bmark_name
= pound
+ 1;
593 props
= fnvlist_alloc();
594 err
= lzc_get_bookmarks(fsname
, props
, &bmarks
);
601 rv
= nvlist_exists(bmarks
, bmark_name
);
607 make_bookmark_handle(zfs_handle_t
*parent
, const char *path
,
608 nvlist_t
*bmark_props
)
610 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
615 /* Fill in the name. */
616 zhp
->zfs_hdl
= parent
->zfs_hdl
;
617 (void) strlcpy(zhp
->zfs_name
, path
, sizeof (zhp
->zfs_name
));
619 /* Set the property lists. */
620 if (nvlist_dup(bmark_props
, &zhp
->zfs_props
, 0) != 0) {
626 zhp
->zfs_head_type
= parent
->zfs_head_type
;
627 zhp
->zfs_type
= ZFS_TYPE_BOOKMARK
;
629 if ((zhp
->zpool_hdl
= zpool_handle(zhp
)) == NULL
) {
630 nvlist_free(zhp
->zfs_props
);
638 struct zfs_open_bookmarks_cb_data
{
644 zfs_open_bookmarks_cb(zfs_handle_t
*zhp
, void *data
)
646 struct zfs_open_bookmarks_cb_data
*dp
= data
;
649 * Is it the one we are looking for?
651 if (strcmp(dp
->path
, zfs_get_name(zhp
)) == 0) {
653 * We found it. Save it and let the caller know we are done.
660 * Not found. Close the handle and ask for another one.
667 * Opens the given snapshot, bookmark, filesystem, or volume. The 'types'
668 * argument is a mask of acceptable types. The function will print an
669 * appropriate error message and return NULL if it can't be opened.
672 zfs_open(libzfs_handle_t
*hdl
, const char *path
, int types
)
678 (void) snprintf(errbuf
, sizeof (errbuf
),
679 dgettext(TEXT_DOMAIN
, "cannot open '%s'"), path
);
682 * Validate the name before we even try to open it.
684 if (!zfs_validate_name(hdl
, path
, types
, B_FALSE
)) {
685 (void) zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
690 * Bookmarks needs to be handled separately.
692 bookp
= strchr(path
, '#');
695 * Try to get stats for the dataset, which will tell us if it
699 if ((zhp
= make_dataset_handle(hdl
, path
)) == NULL
) {
700 (void) zfs_standard_error(hdl
, errno
, errbuf
);
704 char dsname
[ZFS_MAX_DATASET_NAME_LEN
];
706 struct zfs_open_bookmarks_cb_data cb_data
= {path
, NULL
};
709 * We need to cut out '#' and everything after '#'
710 * to get the parent dataset name only.
712 assert(bookp
- path
< sizeof (dsname
));
713 (void) strncpy(dsname
, path
, bookp
- path
);
714 dsname
[bookp
- path
] = '\0';
717 * Create handle for the parent dataset.
720 if ((pzhp
= make_dataset_handle(hdl
, dsname
)) == NULL
) {
721 (void) zfs_standard_error(hdl
, errno
, errbuf
);
726 * Iterate bookmarks to find the right one.
729 if ((zfs_iter_bookmarks(pzhp
, zfs_open_bookmarks_cb
,
730 &cb_data
) == 0) && (cb_data
.zhp
== NULL
)) {
731 (void) zfs_error(hdl
, EZFS_NOENT
, errbuf
);
735 if (cb_data
.zhp
== NULL
) {
736 (void) zfs_standard_error(hdl
, errno
, errbuf
);
748 if (!(types
& zhp
->zfs_type
)) {
749 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
758 * Release a ZFS handle. Nothing to do but free the associated memory.
761 zfs_close(zfs_handle_t
*zhp
)
763 if (zhp
->zfs_mntopts
)
764 free(zhp
->zfs_mntopts
);
765 nvlist_free(zhp
->zfs_props
);
766 nvlist_free(zhp
->zfs_user_props
);
767 nvlist_free(zhp
->zfs_recvd_props
);
771 typedef struct mnttab_node
{
772 struct mnttab mtn_mt
;
777 libzfs_mnttab_cache_compare(const void *arg1
, const void *arg2
)
779 const mnttab_node_t
*mtn1
= (const mnttab_node_t
*)arg1
;
780 const mnttab_node_t
*mtn2
= (const mnttab_node_t
*)arg2
;
783 rv
= strcmp(mtn1
->mtn_mt
.mnt_special
, mtn2
->mtn_mt
.mnt_special
);
785 return (AVL_ISIGN(rv
));
789 libzfs_mnttab_init(libzfs_handle_t
*hdl
)
791 assert(avl_numnodes(&hdl
->libzfs_mnttab_cache
) == 0);
792 avl_create(&hdl
->libzfs_mnttab_cache
, libzfs_mnttab_cache_compare
,
793 sizeof (mnttab_node_t
), offsetof(mnttab_node_t
, mtn_node
));
797 libzfs_mnttab_update(libzfs_handle_t
*hdl
)
801 /* Reopen MNTTAB to prevent reading stale data from open file */
802 if (freopen(MNTTAB
, "r", hdl
->libzfs_mnttab
) == NULL
)
805 while (getmntent(hdl
->libzfs_mnttab
, &entry
) == 0) {
809 if (strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0)
812 mtn
= zfs_alloc(hdl
, sizeof (mnttab_node_t
));
813 mtn
->mtn_mt
.mnt_special
= zfs_strdup(hdl
, entry
.mnt_special
);
814 mtn
->mtn_mt
.mnt_mountp
= zfs_strdup(hdl
, entry
.mnt_mountp
);
815 mtn
->mtn_mt
.mnt_fstype
= zfs_strdup(hdl
, entry
.mnt_fstype
);
816 mtn
->mtn_mt
.mnt_mntopts
= zfs_strdup(hdl
, entry
.mnt_mntopts
);
818 /* Exclude duplicate mounts */
819 if (avl_find(&hdl
->libzfs_mnttab_cache
, mtn
, &where
) != NULL
) {
820 free(mtn
->mtn_mt
.mnt_special
);
821 free(mtn
->mtn_mt
.mnt_mountp
);
822 free(mtn
->mtn_mt
.mnt_fstype
);
823 free(mtn
->mtn_mt
.mnt_mntopts
);
828 avl_add(&hdl
->libzfs_mnttab_cache
, mtn
);
835 libzfs_mnttab_fini(libzfs_handle_t
*hdl
)
840 while ((mtn
= avl_destroy_nodes(&hdl
->libzfs_mnttab_cache
, &cookie
))
842 free(mtn
->mtn_mt
.mnt_special
);
843 free(mtn
->mtn_mt
.mnt_mountp
);
844 free(mtn
->mtn_mt
.mnt_fstype
);
845 free(mtn
->mtn_mt
.mnt_mntopts
);
848 avl_destroy(&hdl
->libzfs_mnttab_cache
);
852 libzfs_mnttab_cache(libzfs_handle_t
*hdl
, boolean_t enable
)
854 hdl
->libzfs_mnttab_enable
= enable
;
858 libzfs_mnttab_find(libzfs_handle_t
*hdl
, const char *fsname
,
859 struct mnttab
*entry
)
865 if (!hdl
->libzfs_mnttab_enable
) {
866 struct mnttab srch
= { 0 };
868 if (avl_numnodes(&hdl
->libzfs_mnttab_cache
))
869 libzfs_mnttab_fini(hdl
);
871 /* Reopen MNTTAB to prevent reading stale data from open file */
872 if (freopen(MNTTAB
, "r", hdl
->libzfs_mnttab
) == NULL
)
875 srch
.mnt_special
= (char *)fsname
;
876 srch
.mnt_fstype
= MNTTYPE_ZFS
;
877 if (getmntany(hdl
->libzfs_mnttab
, entry
, &srch
) == 0)
883 if (avl_numnodes(&hdl
->libzfs_mnttab_cache
) == 0)
884 if ((error
= libzfs_mnttab_update(hdl
)) != 0)
887 find
.mtn_mt
.mnt_special
= (char *)fsname
;
888 mtn
= avl_find(&hdl
->libzfs_mnttab_cache
, &find
, NULL
);
890 *entry
= mtn
->mtn_mt
;
897 libzfs_mnttab_add(libzfs_handle_t
*hdl
, const char *special
,
898 const char *mountp
, const char *mntopts
)
902 if (avl_numnodes(&hdl
->libzfs_mnttab_cache
) == 0)
904 mtn
= zfs_alloc(hdl
, sizeof (mnttab_node_t
));
905 mtn
->mtn_mt
.mnt_special
= zfs_strdup(hdl
, special
);
906 mtn
->mtn_mt
.mnt_mountp
= zfs_strdup(hdl
, mountp
);
907 mtn
->mtn_mt
.mnt_fstype
= zfs_strdup(hdl
, MNTTYPE_ZFS
);
908 mtn
->mtn_mt
.mnt_mntopts
= zfs_strdup(hdl
, mntopts
);
909 avl_add(&hdl
->libzfs_mnttab_cache
, mtn
);
913 libzfs_mnttab_remove(libzfs_handle_t
*hdl
, const char *fsname
)
918 find
.mtn_mt
.mnt_special
= (char *)fsname
;
919 if ((ret
= avl_find(&hdl
->libzfs_mnttab_cache
, (void *)&find
, NULL
))
921 avl_remove(&hdl
->libzfs_mnttab_cache
, ret
);
922 free(ret
->mtn_mt
.mnt_special
);
923 free(ret
->mtn_mt
.mnt_mountp
);
924 free(ret
->mtn_mt
.mnt_fstype
);
925 free(ret
->mtn_mt
.mnt_mntopts
);
931 zfs_spa_version(zfs_handle_t
*zhp
, int *spa_version
)
933 zpool_handle_t
*zpool_handle
= zhp
->zpool_hdl
;
935 if (zpool_handle
== NULL
)
938 *spa_version
= zpool_get_prop_int(zpool_handle
,
939 ZPOOL_PROP_VERSION
, NULL
);
944 * The choice of reservation property depends on the SPA version.
947 zfs_which_resv_prop(zfs_handle_t
*zhp
, zfs_prop_t
*resv_prop
)
951 if (zfs_spa_version(zhp
, &spa_version
) < 0)
954 if (spa_version
>= SPA_VERSION_REFRESERVATION
)
955 *resv_prop
= ZFS_PROP_REFRESERVATION
;
957 *resv_prop
= ZFS_PROP_RESERVATION
;
963 * Given an nvlist of properties to set, validates that they are correct, and
964 * parses any numeric properties (index, boolean, etc) if they are specified as
968 zfs_valid_proplist(libzfs_handle_t
*hdl
, zfs_type_t type
, nvlist_t
*nvl
,
969 uint64_t zoned
, zfs_handle_t
*zhp
, zpool_handle_t
*zpool_hdl
,
970 boolean_t key_params_ok
, const char *errbuf
)
977 int chosen_normal
= -1;
980 if (nvlist_alloc(&ret
, NV_UNIQUE_NAME
, 0) != 0) {
981 (void) no_memory(hdl
);
986 * Make sure this property is valid and applies to this type.
990 while ((elem
= nvlist_next_nvpair(nvl
, elem
)) != NULL
) {
991 const char *propname
= nvpair_name(elem
);
993 prop
= zfs_name_to_prop(propname
);
994 if (prop
== ZPROP_INVAL
&& zfs_prop_user(propname
)) {
996 * This is a user property: make sure it's a
997 * string, and that it's less than ZAP_MAXNAMELEN.
999 if (nvpair_type(elem
) != DATA_TYPE_STRING
) {
1000 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1001 "'%s' must be a string"), propname
);
1002 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1006 if (strlen(nvpair_name(elem
)) >= ZAP_MAXNAMELEN
) {
1007 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1008 "property name '%s' is too long"),
1010 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1014 (void) nvpair_value_string(elem
, &strval
);
1015 if (nvlist_add_string(ret
, propname
, strval
) != 0) {
1016 (void) no_memory(hdl
);
1023 * Currently, only user properties can be modified on
1026 if (type
== ZFS_TYPE_SNAPSHOT
) {
1027 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1028 "this property can not be modified for snapshots"));
1029 (void) zfs_error(hdl
, EZFS_PROPTYPE
, errbuf
);
1033 if (prop
== ZPROP_INVAL
&& zfs_prop_userquota(propname
)) {
1034 zfs_userquota_prop_t uqtype
;
1035 char newpropname
[128];
1040 if (userquota_propname_decode(propname
, zoned
,
1041 &uqtype
, domain
, sizeof (domain
), &rid
) != 0) {
1043 dgettext(TEXT_DOMAIN
,
1044 "'%s' has an invalid user/group name"),
1046 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1050 if (uqtype
!= ZFS_PROP_USERQUOTA
&&
1051 uqtype
!= ZFS_PROP_GROUPQUOTA
&&
1052 uqtype
!= ZFS_PROP_USEROBJQUOTA
&&
1053 uqtype
!= ZFS_PROP_GROUPOBJQUOTA
&&
1054 uqtype
!= ZFS_PROP_PROJECTQUOTA
&&
1055 uqtype
!= ZFS_PROP_PROJECTOBJQUOTA
) {
1057 dgettext(TEXT_DOMAIN
, "'%s' is readonly"),
1059 (void) zfs_error(hdl
, EZFS_PROPREADONLY
,
1064 if (nvpair_type(elem
) == DATA_TYPE_STRING
) {
1065 (void) nvpair_value_string(elem
, &strval
);
1066 if (strcmp(strval
, "none") == 0) {
1068 } else if (zfs_nicestrtonum(hdl
,
1069 strval
, &intval
) != 0) {
1070 (void) zfs_error(hdl
,
1071 EZFS_BADPROP
, errbuf
);
1074 } else if (nvpair_type(elem
) ==
1076 (void) nvpair_value_uint64(elem
, &intval
);
1078 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1079 "use 'none' to disable "
1080 "{user|group|project}quota"));
1084 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1085 "'%s' must be a number"), propname
);
1086 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1091 * Encode the prop name as
1092 * userquota@<hex-rid>-domain, to make it easy
1093 * for the kernel to decode.
1095 (void) snprintf(newpropname
, sizeof (newpropname
),
1096 "%s%llx-%s", zfs_userquota_prop_prefixes
[uqtype
],
1097 (longlong_t
)rid
, domain
);
1101 if (nvlist_add_uint64_array(ret
, newpropname
,
1103 (void) no_memory(hdl
);
1107 } else if (prop
== ZPROP_INVAL
&& zfs_prop_written(propname
)) {
1108 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1109 "'%s' is readonly"),
1111 (void) zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
);
1115 if (prop
== ZPROP_INVAL
) {
1116 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1117 "invalid property '%s'"), propname
);
1118 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1122 if (!zfs_prop_valid_for_type(prop
, type
, B_FALSE
)) {
1124 dgettext(TEXT_DOMAIN
, "'%s' does not "
1125 "apply to datasets of this type"), propname
);
1126 (void) zfs_error(hdl
, EZFS_PROPTYPE
, errbuf
);
1130 if (zfs_prop_readonly(prop
) &&
1131 !(zfs_prop_setonce(prop
) && zhp
== NULL
) &&
1132 !(zfs_prop_encryption_key_param(prop
) && key_params_ok
)) {
1134 dgettext(TEXT_DOMAIN
, "'%s' is readonly"),
1136 (void) zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
);
1140 if (zprop_parse_value(hdl
, elem
, prop
, type
, ret
,
1141 &strval
, &intval
, errbuf
) != 0)
1145 * Perform some additional checks for specific properties.
1148 case ZFS_PROP_VERSION
:
1154 version
= zfs_prop_get_int(zhp
, ZFS_PROP_VERSION
);
1155 if (intval
< version
) {
1156 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1157 "Can not downgrade; already at version %u"),
1159 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1165 case ZFS_PROP_VOLBLOCKSIZE
:
1166 case ZFS_PROP_RECORDSIZE
:
1168 int maxbs
= SPA_MAXBLOCKSIZE
;
1171 if (zpool_hdl
!= NULL
) {
1172 maxbs
= zpool_get_prop_int(zpool_hdl
,
1173 ZPOOL_PROP_MAXBLOCKSIZE
, NULL
);
1176 * The value must be a power of two between
1177 * SPA_MINBLOCKSIZE and maxbs.
1179 if (intval
< SPA_MINBLOCKSIZE
||
1180 intval
> maxbs
|| !ISP2(intval
)) {
1181 zfs_nicebytes(maxbs
, buf
, sizeof (buf
));
1182 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1183 "'%s' must be power of 2 from 512B "
1184 "to %s"), propname
, buf
);
1185 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1190 case ZFS_PROP_MLSLABEL
:
1192 #ifdef HAVE_MLSLABEL
1194 * Verify the mlslabel string and convert to
1195 * internal hex label string.
1199 char *hex
= NULL
; /* internal label string */
1201 /* Default value is already OK. */
1202 if (strcasecmp(strval
, ZFS_MLSLABEL_DEFAULT
) == 0)
1205 /* Verify the label can be converted to binary form */
1206 if (((new_sl
= m_label_alloc(MAC_LABEL
)) == NULL
) ||
1207 (str_to_label(strval
, &new_sl
, MAC_LABEL
,
1208 L_NO_CORRECTION
, NULL
) == -1)) {
1212 /* Now translate to hex internal label string */
1213 if (label_to_str(new_sl
, &hex
, M_INTERNAL
,
1219 m_label_free(new_sl
);
1221 /* If string is already in internal form, we're done. */
1222 if (strcmp(strval
, hex
) == 0) {
1227 /* Replace the label string with the internal form. */
1228 (void) nvlist_remove(ret
, zfs_prop_to_name(prop
),
1230 verify(nvlist_add_string(ret
, zfs_prop_to_name(prop
),
1237 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1238 "invalid mlslabel '%s'"), strval
);
1239 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1240 m_label_free(new_sl
); /* OK if null */
1243 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1244 "mlslabels are unsupported"));
1245 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1247 #endif /* HAVE_MLSLABEL */
1250 case ZFS_PROP_MOUNTPOINT
:
1252 namecheck_err_t why
;
1254 if (strcmp(strval
, ZFS_MOUNTPOINT_NONE
) == 0 ||
1255 strcmp(strval
, ZFS_MOUNTPOINT_LEGACY
) == 0)
1258 if (mountpoint_namecheck(strval
, &why
)) {
1260 case NAME_ERR_LEADING_SLASH
:
1262 dgettext(TEXT_DOMAIN
,
1263 "'%s' must be an absolute path, "
1264 "'none', or 'legacy'"), propname
);
1266 case NAME_ERR_TOOLONG
:
1268 dgettext(TEXT_DOMAIN
,
1269 "component of '%s' is too long"),
1275 dgettext(TEXT_DOMAIN
,
1276 "(%d) not defined"),
1280 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1287 case ZFS_PROP_SHARESMB
:
1288 case ZFS_PROP_SHARENFS
:
1290 * For the mountpoint and sharenfs or sharesmb
1291 * properties, check if it can be set in a
1292 * global/non-global zone based on
1293 * the zoned property value:
1295 * global zone non-global zone
1296 * --------------------------------------------------
1297 * zoned=on mountpoint (no) mountpoint (yes)
1298 * sharenfs (no) sharenfs (no)
1299 * sharesmb (no) sharesmb (no)
1301 * zoned=off mountpoint (yes) N/A
1306 if (getzoneid() == GLOBAL_ZONEID
) {
1307 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1308 "'%s' cannot be set on "
1309 "dataset in a non-global zone"),
1311 (void) zfs_error(hdl
, EZFS_ZONED
,
1314 } else if (prop
== ZFS_PROP_SHARENFS
||
1315 prop
== ZFS_PROP_SHARESMB
) {
1316 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1317 "'%s' cannot be set in "
1318 "a non-global zone"), propname
);
1319 (void) zfs_error(hdl
, EZFS_ZONED
,
1323 } else if (getzoneid() != GLOBAL_ZONEID
) {
1325 * If zoned property is 'off', this must be in
1326 * a global zone. If not, something is wrong.
1328 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1329 "'%s' cannot be set while dataset "
1330 "'zoned' property is set"), propname
);
1331 (void) zfs_error(hdl
, EZFS_ZONED
, errbuf
);
1336 * At this point, it is legitimate to set the
1337 * property. Now we want to make sure that the
1338 * property value is valid if it is sharenfs.
1340 if ((prop
== ZFS_PROP_SHARENFS
||
1341 prop
== ZFS_PROP_SHARESMB
) &&
1342 strcmp(strval
, "on") != 0 &&
1343 strcmp(strval
, "off") != 0) {
1344 zfs_share_proto_t proto
;
1346 if (prop
== ZFS_PROP_SHARESMB
)
1352 * Must be an valid sharing protocol
1353 * option string so init the libshare
1354 * in order to enable the parser and
1355 * then parse the options. We use the
1356 * control API since we don't care about
1357 * the current configuration and don't
1358 * want the overhead of loading it
1359 * until we actually do something.
1362 if (zfs_init_libshare(hdl
,
1363 SA_INIT_CONTROL_API
) != SA_OK
) {
1365 * An error occurred so we can't do
1368 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1369 "'%s' cannot be set: problem "
1370 "in share initialization"),
1372 (void) zfs_error(hdl
, EZFS_BADPROP
,
1377 if (zfs_parse_options(strval
, proto
) != SA_OK
) {
1379 * There was an error in parsing so
1380 * deal with it by issuing an error
1381 * message and leaving after
1382 * uninitializing the the libshare
1385 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1386 "'%s' cannot be set to invalid "
1387 "options"), propname
);
1388 (void) zfs_error(hdl
, EZFS_BADPROP
,
1390 zfs_uninit_libshare(hdl
);
1393 zfs_uninit_libshare(hdl
);
1398 case ZFS_PROP_KEYLOCATION
:
1399 if (!zfs_prop_valid_keylocation(strval
, B_FALSE
)) {
1400 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1401 "invalid keylocation"));
1402 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1408 zfs_prop_get_int(zhp
, ZFS_PROP_ENCRYPTION
);
1410 if (crypt
== ZIO_CRYPT_OFF
&&
1411 strcmp(strval
, "none") != 0) {
1412 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1413 "keylocation must not be 'none' "
1414 "for encrypted datasets"));
1415 (void) zfs_error(hdl
, EZFS_BADPROP
,
1418 } else if (crypt
!= ZIO_CRYPT_OFF
&&
1419 strcmp(strval
, "none") == 0) {
1420 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1421 "keylocation must be 'none' "
1422 "for unencrypted datasets"));
1423 (void) zfs_error(hdl
, EZFS_BADPROP
,
1430 case ZFS_PROP_PBKDF2_ITERS
:
1431 if (intval
< MIN_PBKDF2_ITERATIONS
) {
1432 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1433 "minimum pbkdf2 iterations is %u"),
1434 MIN_PBKDF2_ITERATIONS
);
1435 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1440 case ZFS_PROP_UTF8ONLY
:
1441 chosen_utf
= (int)intval
;
1444 case ZFS_PROP_NORMALIZE
:
1445 chosen_normal
= (int)intval
;
1453 * For changes to existing volumes, we have some additional
1454 * checks to enforce.
1456 if (type
== ZFS_TYPE_VOLUME
&& zhp
!= NULL
) {
1457 uint64_t blocksize
= zfs_prop_get_int(zhp
,
1458 ZFS_PROP_VOLBLOCKSIZE
);
1462 case ZFS_PROP_VOLSIZE
:
1463 if (intval
% blocksize
!= 0) {
1464 zfs_nicebytes(blocksize
, buf
,
1466 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1467 "'%s' must be a multiple of "
1468 "volume block size (%s)"),
1470 (void) zfs_error(hdl
, EZFS_BADPROP
,
1476 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1477 "'%s' cannot be zero"),
1479 (void) zfs_error(hdl
, EZFS_BADPROP
,
1490 /* check encryption properties */
1492 int64_t crypt
= zfs_prop_get_int(zhp
,
1493 ZFS_PROP_ENCRYPTION
);
1496 case ZFS_PROP_COPIES
:
1497 if (crypt
!= ZIO_CRYPT_OFF
&& intval
> 2) {
1498 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1499 "encrypted datasets cannot have "
1501 (void) zfs_error(hdl
, EZFS_BADPROP
,
1513 * If normalization was chosen, but no UTF8 choice was made,
1514 * enforce rejection of non-UTF8 names.
1516 * If normalization was chosen, but rejecting non-UTF8 names
1517 * was explicitly not chosen, it is an error.
1519 if (chosen_normal
> 0 && chosen_utf
< 0) {
1520 if (nvlist_add_uint64(ret
,
1521 zfs_prop_to_name(ZFS_PROP_UTF8ONLY
), 1) != 0) {
1522 (void) no_memory(hdl
);
1525 } else if (chosen_normal
> 0 && chosen_utf
== 0) {
1526 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1527 "'%s' must be set 'on' if normalization chosen"),
1528 zfs_prop_to_name(ZFS_PROP_UTF8ONLY
));
1529 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1540 zfs_add_synthetic_resv(zfs_handle_t
*zhp
, nvlist_t
*nvl
)
1542 uint64_t old_volsize
;
1543 uint64_t new_volsize
;
1544 uint64_t old_reservation
;
1545 uint64_t new_reservation
;
1546 zfs_prop_t resv_prop
;
1550 * If this is an existing volume, and someone is setting the volsize,
1551 * make sure that it matches the reservation, or add it if necessary.
1553 old_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
1554 if (zfs_which_resv_prop(zhp
, &resv_prop
) < 0)
1556 old_reservation
= zfs_prop_get_int(zhp
, resv_prop
);
1558 props
= fnvlist_alloc();
1559 fnvlist_add_uint64(props
, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
1560 zfs_prop_get_int(zhp
, ZFS_PROP_VOLBLOCKSIZE
));
1562 if ((zvol_volsize_to_reservation(old_volsize
, props
) !=
1563 old_reservation
) || nvlist_exists(nvl
,
1564 zfs_prop_to_name(resv_prop
))) {
1565 fnvlist_free(props
);
1568 if (nvlist_lookup_uint64(nvl
, zfs_prop_to_name(ZFS_PROP_VOLSIZE
),
1569 &new_volsize
) != 0) {
1570 fnvlist_free(props
);
1573 new_reservation
= zvol_volsize_to_reservation(new_volsize
, props
);
1574 fnvlist_free(props
);
1576 if (nvlist_add_uint64(nvl
, zfs_prop_to_name(resv_prop
),
1577 new_reservation
) != 0) {
1578 (void) no_memory(zhp
->zfs_hdl
);
1585 zfs_setprop_error(libzfs_handle_t
*hdl
, zfs_prop_t prop
, int err
,
1592 * For quotas and reservations, ENOSPC indicates
1593 * something different; setting a quota or reservation
1594 * doesn't use any disk space.
1597 case ZFS_PROP_QUOTA
:
1598 case ZFS_PROP_REFQUOTA
:
1599 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1600 "size is less than current used or "
1602 (void) zfs_error(hdl
, EZFS_PROPSPACE
, errbuf
);
1605 case ZFS_PROP_RESERVATION
:
1606 case ZFS_PROP_REFRESERVATION
:
1607 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1608 "size is greater than available space"));
1609 (void) zfs_error(hdl
, EZFS_PROPSPACE
, errbuf
);
1613 (void) zfs_standard_error(hdl
, err
, errbuf
);
1619 (void) zfs_standard_error(hdl
, EBUSY
, errbuf
);
1623 (void) zfs_error(hdl
, EZFS_DSREADONLY
, errbuf
);
1627 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1628 "property value too long"));
1629 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1633 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1634 "pool and or dataset must be upgraded to set this "
1635 "property or value"));
1636 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
1640 if (prop
== ZFS_PROP_COMPRESSION
||
1641 prop
== ZFS_PROP_DNODESIZE
||
1642 prop
== ZFS_PROP_RECORDSIZE
) {
1643 (void) zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1644 "property setting is not allowed on "
1645 "bootable datasets"));
1646 (void) zfs_error(hdl
, EZFS_NOTSUP
, errbuf
);
1647 } else if (prop
== ZFS_PROP_CHECKSUM
||
1648 prop
== ZFS_PROP_DEDUP
) {
1649 (void) zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1650 "property setting is not allowed on "
1652 (void) zfs_error(hdl
, EZFS_NOTSUP
, errbuf
);
1654 (void) zfs_standard_error(hdl
, err
, errbuf
);
1659 if (prop
== ZPROP_INVAL
) {
1660 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1662 (void) zfs_standard_error(hdl
, err
, errbuf
);
1667 if (prop
== ZFS_PROP_KEYLOCATION
) {
1668 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1669 "keylocation may only be set on encryption roots"));
1670 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1672 (void) zfs_standard_error(hdl
, err
, errbuf
);
1678 * This platform can't address a volume this big.
1681 if (prop
== ZFS_PROP_VOLSIZE
) {
1682 (void) zfs_error(hdl
, EZFS_VOLTOOBIG
, errbuf
);
1688 (void) zfs_standard_error(hdl
, err
, errbuf
);
1693 zfs_is_namespace_prop(zfs_prop_t prop
)
1697 case ZFS_PROP_ATIME
:
1698 case ZFS_PROP_RELATIME
:
1699 case ZFS_PROP_DEVICES
:
1701 case ZFS_PROP_SETUID
:
1702 case ZFS_PROP_READONLY
:
1703 case ZFS_PROP_XATTR
:
1704 case ZFS_PROP_NBMAND
:
1713 * Given a property name and value, set the property for the given dataset.
1716 zfs_prop_set(zfs_handle_t
*zhp
, const char *propname
, const char *propval
)
1720 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1721 nvlist_t
*nvl
= NULL
;
1723 (void) snprintf(errbuf
, sizeof (errbuf
),
1724 dgettext(TEXT_DOMAIN
, "cannot set property for '%s'"),
1727 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0 ||
1728 nvlist_add_string(nvl
, propname
, propval
) != 0) {
1729 (void) no_memory(hdl
);
1733 ret
= zfs_prop_set_list(zhp
, nvl
);
1743 * Given an nvlist of property names and values, set the properties for the
1747 zfs_prop_set_list(zfs_handle_t
*zhp
, nvlist_t
*props
)
1749 zfs_cmd_t zc
= {"\0"};
1751 prop_changelist_t
**cls
= NULL
;
1754 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1758 zfs_prop_t prop
= 0;
1761 (void) snprintf(errbuf
, sizeof (errbuf
),
1762 dgettext(TEXT_DOMAIN
, "cannot set property for '%s'"),
1765 if ((nvl
= zfs_valid_proplist(hdl
, zhp
->zfs_type
, props
,
1766 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
), zhp
, zhp
->zpool_hdl
,
1767 B_FALSE
, errbuf
)) == NULL
)
1771 * We have to check for any extra properties which need to be added
1772 * before computing the length of the nvlist.
1774 for (elem
= nvlist_next_nvpair(nvl
, NULL
);
1776 elem
= nvlist_next_nvpair(nvl
, elem
)) {
1777 if (zfs_name_to_prop(nvpair_name(elem
)) == ZFS_PROP_VOLSIZE
&&
1778 (added_resv
= zfs_add_synthetic_resv(zhp
, nvl
)) == -1) {
1783 * Check how many properties we're setting and allocate an array to
1784 * store changelist pointers for postfix().
1786 for (elem
= nvlist_next_nvpair(nvl
, NULL
);
1788 elem
= nvlist_next_nvpair(nvl
, elem
))
1790 if ((cls
= calloc(nvl_len
, sizeof (prop_changelist_t
*))) == NULL
)
1794 for (elem
= nvlist_next_nvpair(nvl
, NULL
);
1796 elem
= nvlist_next_nvpair(nvl
, elem
)) {
1798 prop
= zfs_name_to_prop(nvpair_name(elem
));
1800 assert(cl_idx
< nvl_len
);
1802 * We don't want to unmount & remount the dataset when changing
1803 * its canmount property to 'on' or 'noauto'. We only use
1804 * the changelist logic to unmount when setting canmount=off.
1806 if (prop
!= ZFS_PROP_CANMOUNT
||
1807 (fnvpair_value_uint64(elem
) == ZFS_CANMOUNT_OFF
&&
1808 zfs_is_mounted(zhp
, NULL
))) {
1809 cls
[cl_idx
] = changelist_gather(zhp
, prop
, 0, 0);
1810 if (cls
[cl_idx
] == NULL
)
1814 if (prop
== ZFS_PROP_MOUNTPOINT
&&
1815 changelist_haszonedchild(cls
[cl_idx
])) {
1816 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1817 "child dataset with inherited mountpoint is used "
1818 "in a non-global zone"));
1819 ret
= zfs_error(hdl
, EZFS_ZONED
, errbuf
);
1823 if (cls
[cl_idx
] != NULL
&&
1824 (ret
= changelist_prefix(cls
[cl_idx
])) != 0)
1829 assert(cl_idx
== nvl_len
);
1832 * Execute the corresponding ioctl() to set this list of properties.
1834 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1836 if ((ret
= zcmd_write_src_nvlist(hdl
, &zc
, nvl
)) != 0 ||
1837 (ret
= zcmd_alloc_dst_nvlist(hdl
, &zc
, 0)) != 0)
1840 ret
= zfs_ioctl(hdl
, ZFS_IOC_SET_PROP
, &zc
);
1843 /* Get the list of unset properties back and report them. */
1844 nvlist_t
*errorprops
= NULL
;
1845 if (zcmd_read_dst_nvlist(hdl
, &zc
, &errorprops
) != 0)
1847 for (elem
= nvlist_next_nvpair(nvl
, NULL
);
1849 elem
= nvlist_next_nvpair(nvl
, elem
)) {
1850 prop
= zfs_name_to_prop(nvpair_name(elem
));
1851 zfs_setprop_error(hdl
, prop
, errno
, errbuf
);
1853 nvlist_free(errorprops
);
1855 if (added_resv
&& errno
== ENOSPC
) {
1856 /* clean up the volsize property we tried to set */
1857 uint64_t old_volsize
= zfs_prop_get_int(zhp
,
1861 zcmd_free_nvlists(&zc
);
1863 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0)
1865 if (nvlist_add_uint64(nvl
,
1866 zfs_prop_to_name(ZFS_PROP_VOLSIZE
),
1869 if (zcmd_write_src_nvlist(hdl
, &zc
, nvl
) != 0)
1871 (void) zfs_ioctl(hdl
, ZFS_IOC_SET_PROP
, &zc
);
1874 for (cl_idx
= 0; cl_idx
< nvl_len
; cl_idx
++) {
1875 if (cls
[cl_idx
] != NULL
) {
1876 int clp_err
= changelist_postfix(cls
[cl_idx
]);
1884 * Refresh the statistics so the new property
1885 * value is reflected.
1887 (void) get_stats(zhp
);
1890 * Remount the filesystem to propagate the change
1891 * if one of the options handled by the generic
1892 * Linux namespace layer has been modified.
1894 if (zfs_is_namespace_prop(prop
) &&
1895 zfs_is_mounted(zhp
, NULL
))
1896 ret
= zfs_mount(zhp
, MNTOPT_REMOUNT
, 0);
1902 zcmd_free_nvlists(&zc
);
1904 for (cl_idx
= 0; cl_idx
< nvl_len
; cl_idx
++) {
1905 if (cls
[cl_idx
] != NULL
)
1906 changelist_free(cls
[cl_idx
]);
1914 * Given a property, inherit the value from the parent dataset, or if received
1915 * is TRUE, revert to the received value, if any.
1918 zfs_prop_inherit(zfs_handle_t
*zhp
, const char *propname
, boolean_t received
)
1920 zfs_cmd_t zc
= {"\0"};
1922 prop_changelist_t
*cl
;
1923 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1927 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1928 "cannot inherit %s for '%s'"), propname
, zhp
->zfs_name
);
1930 zc
.zc_cookie
= received
;
1931 if ((prop
= zfs_name_to_prop(propname
)) == ZPROP_INVAL
) {
1933 * For user properties, the amount of work we have to do is very
1934 * small, so just do it here.
1936 if (!zfs_prop_user(propname
)) {
1937 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1938 "invalid property"));
1939 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
1942 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1943 (void) strlcpy(zc
.zc_value
, propname
, sizeof (zc
.zc_value
));
1945 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_INHERIT_PROP
, &zc
) != 0)
1946 return (zfs_standard_error(hdl
, errno
, errbuf
));
1952 * Verify that this property is inheritable.
1954 if (zfs_prop_readonly(prop
))
1955 return (zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
));
1957 if (!zfs_prop_inheritable(prop
) && !received
)
1958 return (zfs_error(hdl
, EZFS_PROPNONINHERIT
, errbuf
));
1961 * Check to see if the value applies to this type
1963 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
))
1964 return (zfs_error(hdl
, EZFS_PROPTYPE
, errbuf
));
1967 * Normalize the name, to get rid of shorthand abbreviations.
1969 propname
= zfs_prop_to_name(prop
);
1970 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1971 (void) strlcpy(zc
.zc_value
, propname
, sizeof (zc
.zc_value
));
1973 if (prop
== ZFS_PROP_MOUNTPOINT
&& getzoneid() == GLOBAL_ZONEID
&&
1974 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
)) {
1975 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1976 "dataset is used in a non-global zone"));
1977 return (zfs_error(hdl
, EZFS_ZONED
, errbuf
));
1981 * Determine datasets which will be affected by this change, if any.
1983 if ((cl
= changelist_gather(zhp
, prop
, 0, 0)) == NULL
)
1986 if (prop
== ZFS_PROP_MOUNTPOINT
&& changelist_haszonedchild(cl
)) {
1987 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1988 "child dataset with inherited mountpoint is used "
1989 "in a non-global zone"));
1990 ret
= zfs_error(hdl
, EZFS_ZONED
, errbuf
);
1994 if ((ret
= changelist_prefix(cl
)) != 0)
1997 if ((ret
= zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_INHERIT_PROP
, &zc
)) != 0) {
1998 return (zfs_standard_error(hdl
, errno
, errbuf
));
2001 if ((ret
= changelist_postfix(cl
)) != 0)
2005 * Refresh the statistics so the new property is reflected.
2007 (void) get_stats(zhp
);
2010 * Remount the filesystem to propagate the change
2011 * if one of the options handled by the generic
2012 * Linux namespace layer has been modified.
2014 if (zfs_is_namespace_prop(prop
) &&
2015 zfs_is_mounted(zhp
, NULL
))
2016 ret
= zfs_mount(zhp
, MNTOPT_REMOUNT
, 0);
2020 changelist_free(cl
);
2025 * True DSL properties are stored in an nvlist. The following two functions
2026 * extract them appropriately.
2029 getprop_uint64(zfs_handle_t
*zhp
, zfs_prop_t prop
, char **source
)
2035 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
2036 zfs_prop_to_name(prop
), &nv
) == 0) {
2037 verify(nvlist_lookup_uint64(nv
, ZPROP_VALUE
, &value
) == 0);
2038 (void) nvlist_lookup_string(nv
, ZPROP_SOURCE
, source
);
2040 verify(!zhp
->zfs_props_table
||
2041 zhp
->zfs_props_table
[prop
] == B_TRUE
);
2042 value
= zfs_prop_default_numeric(prop
);
2050 getprop_string(zfs_handle_t
*zhp
, zfs_prop_t prop
, char **source
)
2056 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
2057 zfs_prop_to_name(prop
), &nv
) == 0) {
2058 value
= fnvlist_lookup_string(nv
, ZPROP_VALUE
);
2059 (void) nvlist_lookup_string(nv
, ZPROP_SOURCE
, source
);
2061 verify(!zhp
->zfs_props_table
||
2062 zhp
->zfs_props_table
[prop
] == B_TRUE
);
2063 value
= zfs_prop_default_string(prop
);
2071 zfs_is_recvd_props_mode(zfs_handle_t
*zhp
)
2073 return (zhp
->zfs_props
== zhp
->zfs_recvd_props
);
2077 zfs_set_recvd_props_mode(zfs_handle_t
*zhp
, uint64_t *cookie
)
2079 *cookie
= (uint64_t)(uintptr_t)zhp
->zfs_props
;
2080 zhp
->zfs_props
= zhp
->zfs_recvd_props
;
2084 zfs_unset_recvd_props_mode(zfs_handle_t
*zhp
, uint64_t *cookie
)
2086 zhp
->zfs_props
= (nvlist_t
*)(uintptr_t)*cookie
;
2091 * Internal function for getting a numeric property. Both zfs_prop_get() and
2092 * zfs_prop_get_int() are built using this interface.
2094 * Certain properties can be overridden using 'mount -o'. In this case, scan
2095 * the contents of the /proc/self/mounts entry, searching for the
2096 * appropriate options. If they differ from the on-disk values, report the
2097 * current values and mark the source "temporary".
2100 get_numeric_property(zfs_handle_t
*zhp
, zfs_prop_t prop
, zprop_source_t
*src
,
2101 char **source
, uint64_t *val
)
2103 zfs_cmd_t zc
= {"\0"};
2104 nvlist_t
*zplprops
= NULL
;
2106 char *mntopt_on
= NULL
;
2107 char *mntopt_off
= NULL
;
2108 boolean_t received
= zfs_is_recvd_props_mode(zhp
);
2113 * If the property is being fetched for a snapshot, check whether
2114 * the property is valid for the snapshot's head dataset type.
2116 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
&&
2117 !zfs_prop_valid_for_type(prop
, zhp
->zfs_head_type
, B_TRUE
)) {
2118 *val
= zfs_prop_default_numeric(prop
);
2123 case ZFS_PROP_ATIME
:
2124 mntopt_on
= MNTOPT_ATIME
;
2125 mntopt_off
= MNTOPT_NOATIME
;
2128 case ZFS_PROP_RELATIME
:
2129 mntopt_on
= MNTOPT_RELATIME
;
2130 mntopt_off
= MNTOPT_NORELATIME
;
2133 case ZFS_PROP_DEVICES
:
2134 mntopt_on
= MNTOPT_DEVICES
;
2135 mntopt_off
= MNTOPT_NODEVICES
;
2139 mntopt_on
= MNTOPT_EXEC
;
2140 mntopt_off
= MNTOPT_NOEXEC
;
2143 case ZFS_PROP_READONLY
:
2144 mntopt_on
= MNTOPT_RO
;
2145 mntopt_off
= MNTOPT_RW
;
2148 case ZFS_PROP_SETUID
:
2149 mntopt_on
= MNTOPT_SETUID
;
2150 mntopt_off
= MNTOPT_NOSETUID
;
2153 case ZFS_PROP_XATTR
:
2154 mntopt_on
= MNTOPT_XATTR
;
2155 mntopt_off
= MNTOPT_NOXATTR
;
2158 case ZFS_PROP_NBMAND
:
2159 mntopt_on
= MNTOPT_NBMAND
;
2160 mntopt_off
= MNTOPT_NONBMAND
;
2168 * Because looking up the mount options is potentially expensive
2169 * (iterating over all of /proc/self/mounts), we defer its
2170 * calculation until we're looking up a property which requires
2173 if (!zhp
->zfs_mntcheck
&&
2174 (mntopt_on
!= NULL
|| prop
== ZFS_PROP_MOUNTED
)) {
2175 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
2176 struct mnttab entry
;
2178 if (libzfs_mnttab_find(hdl
, zhp
->zfs_name
, &entry
) == 0) {
2179 zhp
->zfs_mntopts
= zfs_strdup(hdl
,
2181 if (zhp
->zfs_mntopts
== NULL
)
2185 zhp
->zfs_mntcheck
= B_TRUE
;
2188 if (zhp
->zfs_mntopts
== NULL
)
2189 mnt
.mnt_mntopts
= "";
2191 mnt
.mnt_mntopts
= zhp
->zfs_mntopts
;
2194 case ZFS_PROP_ATIME
:
2195 case ZFS_PROP_RELATIME
:
2196 case ZFS_PROP_DEVICES
:
2198 case ZFS_PROP_READONLY
:
2199 case ZFS_PROP_SETUID
:
2200 case ZFS_PROP_XATTR
:
2201 case ZFS_PROP_NBMAND
:
2202 *val
= getprop_uint64(zhp
, prop
, source
);
2207 if (hasmntopt(&mnt
, mntopt_on
) && !*val
) {
2210 *src
= ZPROP_SRC_TEMPORARY
;
2211 } else if (hasmntopt(&mnt
, mntopt_off
) && *val
) {
2214 *src
= ZPROP_SRC_TEMPORARY
;
2218 case ZFS_PROP_CANMOUNT
:
2219 case ZFS_PROP_VOLSIZE
:
2220 case ZFS_PROP_QUOTA
:
2221 case ZFS_PROP_REFQUOTA
:
2222 case ZFS_PROP_RESERVATION
:
2223 case ZFS_PROP_REFRESERVATION
:
2224 case ZFS_PROP_FILESYSTEM_LIMIT
:
2225 case ZFS_PROP_SNAPSHOT_LIMIT
:
2226 case ZFS_PROP_FILESYSTEM_COUNT
:
2227 case ZFS_PROP_SNAPSHOT_COUNT
:
2228 *val
= getprop_uint64(zhp
, prop
, source
);
2230 if (*source
== NULL
) {
2231 /* not default, must be local */
2232 *source
= zhp
->zfs_name
;
2236 case ZFS_PROP_MOUNTED
:
2237 *val
= (zhp
->zfs_mntopts
!= NULL
);
2240 case ZFS_PROP_NUMCLONES
:
2241 *val
= zhp
->zfs_dmustats
.dds_num_clones
;
2244 case ZFS_PROP_VERSION
:
2245 case ZFS_PROP_NORMALIZE
:
2246 case ZFS_PROP_UTF8ONLY
:
2248 if (zcmd_alloc_dst_nvlist(zhp
->zfs_hdl
, &zc
, 0) != 0)
2250 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
2251 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_OBJSET_ZPLPROPS
, &zc
)) {
2252 zcmd_free_nvlists(&zc
);
2253 if (prop
== ZFS_PROP_VERSION
&&
2254 zhp
->zfs_type
== ZFS_TYPE_VOLUME
)
2255 *val
= zfs_prop_default_numeric(prop
);
2258 if (zcmd_read_dst_nvlist(zhp
->zfs_hdl
, &zc
, &zplprops
) != 0 ||
2259 nvlist_lookup_uint64(zplprops
, zfs_prop_to_name(prop
),
2261 zcmd_free_nvlists(&zc
);
2264 nvlist_free(zplprops
);
2265 zcmd_free_nvlists(&zc
);
2268 case ZFS_PROP_INCONSISTENT
:
2269 *val
= zhp
->zfs_dmustats
.dds_inconsistent
;
2273 switch (zfs_prop_get_type(prop
)) {
2274 case PROP_TYPE_NUMBER
:
2275 case PROP_TYPE_INDEX
:
2276 *val
= getprop_uint64(zhp
, prop
, source
);
2278 * If we tried to use a default value for a
2279 * readonly property, it means that it was not
2280 * present. Note this only applies to "truly"
2281 * readonly properties, not set-once properties
2282 * like volblocksize.
2284 if (zfs_prop_readonly(prop
) &&
2285 !zfs_prop_setonce(prop
) &&
2286 *source
!= NULL
&& (*source
)[0] == '\0') {
2292 case PROP_TYPE_STRING
:
2294 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
2295 "cannot get non-numeric property"));
2296 return (zfs_error(zhp
->zfs_hdl
, EZFS_BADPROP
,
2297 dgettext(TEXT_DOMAIN
, "internal error")));
2305 * Calculate the source type, given the raw source string.
2308 get_source(zfs_handle_t
*zhp
, zprop_source_t
*srctype
, char *source
,
2309 char *statbuf
, size_t statlen
)
2311 if (statbuf
== NULL
||
2312 srctype
== NULL
|| *srctype
== ZPROP_SRC_TEMPORARY
) {
2316 if (source
== NULL
) {
2317 *srctype
= ZPROP_SRC_NONE
;
2318 } else if (source
[0] == '\0') {
2319 *srctype
= ZPROP_SRC_DEFAULT
;
2320 } else if (strstr(source
, ZPROP_SOURCE_VAL_RECVD
) != NULL
) {
2321 *srctype
= ZPROP_SRC_RECEIVED
;
2323 if (strcmp(source
, zhp
->zfs_name
) == 0) {
2324 *srctype
= ZPROP_SRC_LOCAL
;
2326 (void) strlcpy(statbuf
, source
, statlen
);
2327 *srctype
= ZPROP_SRC_INHERITED
;
2334 zfs_prop_get_recvd(zfs_handle_t
*zhp
, const char *propname
, char *propbuf
,
2335 size_t proplen
, boolean_t literal
)
2340 if (zhp
->zfs_recvd_props
== NULL
)
2341 if (get_recvd_props_ioctl(zhp
) != 0)
2344 prop
= zfs_name_to_prop(propname
);
2346 if (prop
!= ZPROP_INVAL
) {
2348 if (!nvlist_exists(zhp
->zfs_recvd_props
, propname
))
2350 zfs_set_recvd_props_mode(zhp
, &cookie
);
2351 err
= zfs_prop_get(zhp
, prop
, propbuf
, proplen
,
2352 NULL
, NULL
, 0, literal
);
2353 zfs_unset_recvd_props_mode(zhp
, &cookie
);
2357 if (nvlist_lookup_nvlist(zhp
->zfs_recvd_props
,
2358 propname
, &propval
) != 0)
2360 verify(nvlist_lookup_string(propval
, ZPROP_VALUE
,
2362 (void) strlcpy(propbuf
, recvdval
, proplen
);
2365 return (err
== 0 ? 0 : -1);
2369 get_clones_string(zfs_handle_t
*zhp
, char *propbuf
, size_t proplen
)
2374 value
= zfs_get_clones_nvl(zhp
);
2379 for (pair
= nvlist_next_nvpair(value
, NULL
); pair
!= NULL
;
2380 pair
= nvlist_next_nvpair(value
, pair
)) {
2381 if (propbuf
[0] != '\0')
2382 (void) strlcat(propbuf
, ",", proplen
);
2383 (void) strlcat(propbuf
, nvpair_name(pair
), proplen
);
2389 struct get_clones_arg
{
2393 char buf
[ZFS_MAX_DATASET_NAME_LEN
];
2397 get_clones_cb(zfs_handle_t
*zhp
, void *arg
)
2399 struct get_clones_arg
*gca
= arg
;
2401 if (gca
->numclones
== 0) {
2406 if (zfs_prop_get(zhp
, ZFS_PROP_ORIGIN
, gca
->buf
, sizeof (gca
->buf
),
2407 NULL
, NULL
, 0, B_TRUE
) != 0)
2409 if (strcmp(gca
->buf
, gca
->origin
) == 0) {
2410 fnvlist_add_boolean(gca
->value
, zfs_get_name(zhp
));
2415 (void) zfs_iter_children(zhp
, get_clones_cb
, gca
);
2421 zfs_get_clones_nvl(zfs_handle_t
*zhp
)
2423 nvlist_t
*nv
, *value
;
2425 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
2426 zfs_prop_to_name(ZFS_PROP_CLONES
), &nv
) != 0) {
2427 struct get_clones_arg gca
;
2430 * if this is a snapshot, then the kernel wasn't able
2431 * to get the clones. Do it by slowly iterating.
2433 if (zhp
->zfs_type
!= ZFS_TYPE_SNAPSHOT
)
2435 if (nvlist_alloc(&nv
, NV_UNIQUE_NAME
, 0) != 0)
2437 if (nvlist_alloc(&value
, NV_UNIQUE_NAME
, 0) != 0) {
2442 gca
.numclones
= zfs_prop_get_int(zhp
, ZFS_PROP_NUMCLONES
);
2444 gca
.origin
= zhp
->zfs_name
;
2446 if (gca
.numclones
!= 0) {
2448 char pool
[ZFS_MAX_DATASET_NAME_LEN
];
2451 /* get the pool name */
2452 (void) strlcpy(pool
, zhp
->zfs_name
, sizeof (pool
));
2453 (void) strsep(&cp
, "/@");
2454 root
= zfs_open(zhp
->zfs_hdl
, pool
,
2455 ZFS_TYPE_FILESYSTEM
);
2462 (void) get_clones_cb(root
, &gca
);
2465 if (gca
.numclones
!= 0 ||
2466 nvlist_add_nvlist(nv
, ZPROP_VALUE
, value
) != 0 ||
2467 nvlist_add_nvlist(zhp
->zfs_props
,
2468 zfs_prop_to_name(ZFS_PROP_CLONES
), nv
) != 0) {
2475 verify(0 == nvlist_lookup_nvlist(zhp
->zfs_props
,
2476 zfs_prop_to_name(ZFS_PROP_CLONES
), &nv
));
2479 verify(nvlist_lookup_nvlist(nv
, ZPROP_VALUE
, &value
) == 0);
2485 * Accepts a property and value and checks that the value
2486 * matches the one found by the channel program. If they are
2487 * not equal, print both of them.
2490 zcp_check(zfs_handle_t
*zhp
, zfs_prop_t prop
, uint64_t intval
,
2493 if (!zhp
->zfs_hdl
->libzfs_prop_debug
)
2496 char *poolname
= zhp
->zpool_hdl
->zpool_name
;
2497 const char *prop_name
= zfs_prop_to_name(prop
);
2498 const char *program
=
2500 "ds = args['dataset']\n"
2501 "prop = args['property']\n"
2502 "value, setpoint = zfs.get_prop(ds, prop)\n"
2503 "return {value=value, setpoint=setpoint}\n";
2506 nvlist_t
*argnvl
= fnvlist_alloc();
2508 fnvlist_add_string(argnvl
, "dataset", zhp
->zfs_name
);
2509 fnvlist_add_string(argnvl
, "property", zfs_prop_to_name(prop
));
2511 error
= lzc_channel_program_nosync(poolname
, program
,
2512 10 * 1000 * 1000, 10 * 1024 * 1024, argnvl
, &outnvl
);
2515 retnvl
= fnvlist_lookup_nvlist(outnvl
, "return");
2516 if (zfs_prop_get_type(prop
) == PROP_TYPE_NUMBER
) {
2518 error
= nvlist_lookup_int64(retnvl
, "value", &ans
);
2520 (void) fprintf(stderr
, "%s: zcp check error: "
2521 "%u\n", prop_name
, error
);
2524 if (ans
!= intval
) {
2525 (void) fprintf(stderr
, "%s: zfs found %llu, "
2526 "but zcp found %llu\n", prop_name
,
2527 (u_longlong_t
)intval
, (u_longlong_t
)ans
);
2531 error
= nvlist_lookup_string(retnvl
, "value", &str_ans
);
2533 (void) fprintf(stderr
, "%s: zcp check error: "
2534 "%u\n", prop_name
, error
);
2537 if (strcmp(strval
, str_ans
) != 0) {
2538 (void) fprintf(stderr
,
2539 "%s: zfs found '%s', but zcp found '%s'\n",
2540 prop_name
, strval
, str_ans
);
2544 (void) fprintf(stderr
, "%s: zcp check failed, channel program "
2545 "error: %u\n", prop_name
, error
);
2547 nvlist_free(argnvl
);
2548 nvlist_free(outnvl
);
2552 * Retrieve a property from the given object. If 'literal' is specified, then
2553 * numbers are left as exact values. Otherwise, numbers are converted to a
2554 * human-readable form.
2556 * Returns 0 on success, or -1 on error.
2559 zfs_prop_get(zfs_handle_t
*zhp
, zfs_prop_t prop
, char *propbuf
, size_t proplen
,
2560 zprop_source_t
*src
, char *statbuf
, size_t statlen
, boolean_t literal
)
2562 char *source
= NULL
;
2566 boolean_t received
= zfs_is_recvd_props_mode(zhp
);
2569 * Check to see if this property applies to our object
2571 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
))
2574 if (received
&& zfs_prop_readonly(prop
))
2578 *src
= ZPROP_SRC_NONE
;
2581 case ZFS_PROP_CREATION
:
2583 * 'creation' is a time_t stored in the statistics. We convert
2584 * this into a string unless 'literal' is specified.
2587 val
= getprop_uint64(zhp
, prop
, &source
);
2588 time_t time
= (time_t)val
;
2592 localtime_r(&time
, &t
) == NULL
||
2593 strftime(propbuf
, proplen
, "%a %b %e %k:%M %Y",
2595 (void) snprintf(propbuf
, proplen
, "%llu",
2598 zcp_check(zhp
, prop
, val
, NULL
);
2601 case ZFS_PROP_MOUNTPOINT
:
2603 * Getting the precise mountpoint can be tricky.
2605 * - for 'none' or 'legacy', return those values.
2606 * - for inherited mountpoints, we want to take everything
2607 * after our ancestor and append it to the inherited value.
2609 * If the pool has an alternate root, we want to prepend that
2610 * root to any values we return.
2613 str
= getprop_string(zhp
, prop
, &source
);
2615 if (str
[0] == '/') {
2616 char buf
[MAXPATHLEN
];
2618 const char *relpath
;
2621 * If we inherit the mountpoint, even from a dataset
2622 * with a received value, the source will be the path of
2623 * the dataset we inherit from. If source is
2624 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2627 if (strcmp(source
, ZPROP_SOURCE_VAL_RECVD
) == 0) {
2630 relpath
= zhp
->zfs_name
+ strlen(source
);
2631 if (relpath
[0] == '/')
2635 if ((zpool_get_prop(zhp
->zpool_hdl
,
2636 ZPOOL_PROP_ALTROOT
, buf
, MAXPATHLEN
, NULL
,
2637 B_FALSE
)) || (strcmp(root
, "-") == 0))
2640 * Special case an alternate root of '/'. This will
2641 * avoid having multiple leading slashes in the
2644 if (strcmp(root
, "/") == 0)
2648 * If the mountpoint is '/' then skip over this
2649 * if we are obtaining either an alternate root or
2650 * an inherited mountpoint.
2652 if (str
[1] == '\0' && (root
[0] != '\0' ||
2653 relpath
[0] != '\0'))
2656 if (relpath
[0] == '\0')
2657 (void) snprintf(propbuf
, proplen
, "%s%s",
2660 (void) snprintf(propbuf
, proplen
, "%s%s%s%s",
2661 root
, str
, relpath
[0] == '@' ? "" : "/",
2664 /* 'legacy' or 'none' */
2665 (void) strlcpy(propbuf
, str
, proplen
);
2667 zcp_check(zhp
, prop
, 0, propbuf
);
2670 case ZFS_PROP_ORIGIN
:
2671 str
= getprop_string(zhp
, prop
, &source
);
2674 (void) strlcpy(propbuf
, str
, proplen
);
2675 zcp_check(zhp
, prop
, 0, str
);
2678 case ZFS_PROP_CLONES
:
2679 if (get_clones_string(zhp
, propbuf
, proplen
) != 0)
2683 case ZFS_PROP_QUOTA
:
2684 case ZFS_PROP_REFQUOTA
:
2685 case ZFS_PROP_RESERVATION
:
2686 case ZFS_PROP_REFRESERVATION
:
2688 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2691 * If quota or reservation is 0, we translate this into 'none'
2692 * (unless literal is set), and indicate that it's the default
2693 * value. Otherwise, we print the number nicely and indicate
2694 * that its set locally.
2698 (void) strlcpy(propbuf
, "0", proplen
);
2700 (void) strlcpy(propbuf
, "none", proplen
);
2703 (void) snprintf(propbuf
, proplen
, "%llu",
2706 zfs_nicebytes(val
, propbuf
, proplen
);
2708 zcp_check(zhp
, prop
, val
, NULL
);
2711 case ZFS_PROP_FILESYSTEM_LIMIT
:
2712 case ZFS_PROP_SNAPSHOT_LIMIT
:
2713 case ZFS_PROP_FILESYSTEM_COUNT
:
2714 case ZFS_PROP_SNAPSHOT_COUNT
:
2716 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2720 * If limit is UINT64_MAX, we translate this into 'none' (unless
2721 * literal is set), and indicate that it's the default value.
2722 * Otherwise, we print the number nicely and indicate that it's
2726 (void) snprintf(propbuf
, proplen
, "%llu",
2728 } else if (val
== UINT64_MAX
) {
2729 (void) strlcpy(propbuf
, "none", proplen
);
2731 zfs_nicenum(val
, propbuf
, proplen
);
2734 zcp_check(zhp
, prop
, val
, NULL
);
2737 case ZFS_PROP_REFRATIO
:
2738 case ZFS_PROP_COMPRESSRATIO
:
2739 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2742 (void) snprintf(propbuf
, proplen
, "%llu.%02llu",
2743 (u_longlong_t
)(val
/ 100),
2744 (u_longlong_t
)(val
% 100));
2746 (void) snprintf(propbuf
, proplen
, "%llu.%02llux",
2747 (u_longlong_t
)(val
/ 100),
2748 (u_longlong_t
)(val
% 100));
2749 zcp_check(zhp
, prop
, val
, NULL
);
2753 switch (zhp
->zfs_type
) {
2754 case ZFS_TYPE_FILESYSTEM
:
2757 case ZFS_TYPE_VOLUME
:
2760 case ZFS_TYPE_SNAPSHOT
:
2763 case ZFS_TYPE_BOOKMARK
:
2769 (void) snprintf(propbuf
, proplen
, "%s", str
);
2770 zcp_check(zhp
, prop
, 0, propbuf
);
2773 case ZFS_PROP_MOUNTED
:
2775 * The 'mounted' property is a pseudo-property that described
2776 * whether the filesystem is currently mounted. Even though
2777 * it's a boolean value, the typical values of "on" and "off"
2778 * don't make sense, so we translate to "yes" and "no".
2780 if (get_numeric_property(zhp
, ZFS_PROP_MOUNTED
,
2781 src
, &source
, &val
) != 0)
2784 (void) strlcpy(propbuf
, "yes", proplen
);
2786 (void) strlcpy(propbuf
, "no", proplen
);
2791 * The 'name' property is a pseudo-property derived from the
2792 * dataset name. It is presented as a real property to simplify
2795 (void) strlcpy(propbuf
, zhp
->zfs_name
, proplen
);
2796 zcp_check(zhp
, prop
, 0, propbuf
);
2799 case ZFS_PROP_MLSLABEL
:
2801 #ifdef HAVE_MLSLABEL
2802 m_label_t
*new_sl
= NULL
;
2803 char *ascii
= NULL
; /* human readable label */
2805 (void) strlcpy(propbuf
,
2806 getprop_string(zhp
, prop
, &source
), proplen
);
2808 if (literal
|| (strcasecmp(propbuf
,
2809 ZFS_MLSLABEL_DEFAULT
) == 0))
2813 * Try to translate the internal hex string to
2814 * human-readable output. If there are any
2815 * problems just use the hex string.
2818 if (str_to_label(propbuf
, &new_sl
, MAC_LABEL
,
2819 L_NO_CORRECTION
, NULL
) == -1) {
2820 m_label_free(new_sl
);
2824 if (label_to_str(new_sl
, &ascii
, M_LABEL
,
2828 m_label_free(new_sl
);
2831 m_label_free(new_sl
);
2833 (void) strlcpy(propbuf
, ascii
, proplen
);
2836 (void) strlcpy(propbuf
,
2837 getprop_string(zhp
, prop
, &source
), proplen
);
2838 #endif /* HAVE_MLSLABEL */
2843 case ZFS_PROP_CREATETXG
:
2845 * GUIDs are stored as numbers, but they are identifiers.
2846 * We don't want them to be pretty printed, because pretty
2847 * printing mangles the ID into a truncated and useless value.
2849 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2851 (void) snprintf(propbuf
, proplen
, "%llu", (u_longlong_t
)val
);
2852 zcp_check(zhp
, prop
, val
, NULL
);
2855 case ZFS_PROP_REFERENCED
:
2856 case ZFS_PROP_AVAILABLE
:
2858 case ZFS_PROP_USEDSNAP
:
2859 case ZFS_PROP_USEDDS
:
2860 case ZFS_PROP_USEDREFRESERV
:
2861 case ZFS_PROP_USEDCHILD
:
2862 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2865 (void) snprintf(propbuf
, proplen
, "%llu",
2868 zfs_nicebytes(val
, propbuf
, proplen
);
2870 zcp_check(zhp
, prop
, val
, NULL
);
2874 switch (zfs_prop_get_type(prop
)) {
2875 case PROP_TYPE_NUMBER
:
2876 if (get_numeric_property(zhp
, prop
, src
,
2877 &source
, &val
) != 0) {
2882 (void) snprintf(propbuf
, proplen
, "%llu",
2885 zfs_nicenum(val
, propbuf
, proplen
);
2887 zcp_check(zhp
, prop
, val
, NULL
);
2890 case PROP_TYPE_STRING
:
2891 str
= getprop_string(zhp
, prop
, &source
);
2895 (void) strlcpy(propbuf
, str
, proplen
);
2896 zcp_check(zhp
, prop
, 0, str
);
2899 case PROP_TYPE_INDEX
:
2900 if (get_numeric_property(zhp
, prop
, src
,
2901 &source
, &val
) != 0)
2903 if (zfs_prop_index_to_string(prop
, val
, &strval
) != 0)
2906 (void) strlcpy(propbuf
, strval
, proplen
);
2907 zcp_check(zhp
, prop
, 0, strval
);
2915 get_source(zhp
, src
, source
, statbuf
, statlen
);
2921 * Utility function to get the given numeric property. Does no validation that
2922 * the given property is the appropriate type; should only be used with
2923 * hard-coded property types.
2926 zfs_prop_get_int(zfs_handle_t
*zhp
, zfs_prop_t prop
)
2931 (void) get_numeric_property(zhp
, prop
, NULL
, &source
, &val
);
2937 zfs_prop_set_int(zfs_handle_t
*zhp
, zfs_prop_t prop
, uint64_t val
)
2941 (void) snprintf(buf
, sizeof (buf
), "%llu", (longlong_t
)val
);
2942 return (zfs_prop_set(zhp
, zfs_prop_to_name(prop
), buf
));
2946 * Similar to zfs_prop_get(), but returns the value as an integer.
2949 zfs_prop_get_numeric(zfs_handle_t
*zhp
, zfs_prop_t prop
, uint64_t *value
,
2950 zprop_source_t
*src
, char *statbuf
, size_t statlen
)
2955 * Check to see if this property applies to our object
2957 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
)) {
2958 return (zfs_error_fmt(zhp
->zfs_hdl
, EZFS_PROPTYPE
,
2959 dgettext(TEXT_DOMAIN
, "cannot get property '%s'"),
2960 zfs_prop_to_name(prop
)));
2964 *src
= ZPROP_SRC_NONE
;
2966 if (get_numeric_property(zhp
, prop
, src
, &source
, value
) != 0)
2969 get_source(zhp
, src
, source
, statbuf
, statlen
);
2976 idmap_id_to_numeric_domain_rid(uid_t id
, boolean_t isuser
,
2977 char **domainp
, idmap_rid_t
*ridp
)
2979 idmap_get_handle_t
*get_hdl
= NULL
;
2983 if (idmap_get_create(&get_hdl
) != IDMAP_SUCCESS
)
2987 err
= idmap_get_sidbyuid(get_hdl
, id
,
2988 IDMAP_REQ_FLG_USE_CACHE
, domainp
, ridp
, &status
);
2990 err
= idmap_get_sidbygid(get_hdl
, id
,
2991 IDMAP_REQ_FLG_USE_CACHE
, domainp
, ridp
, &status
);
2993 if (err
== IDMAP_SUCCESS
&&
2994 idmap_get_mappings(get_hdl
) == IDMAP_SUCCESS
&&
2995 status
== IDMAP_SUCCESS
)
3001 idmap_get_destroy(get_hdl
);
3004 #endif /* HAVE_IDMAP */
3007 * convert the propname into parameters needed by kernel
3008 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
3009 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
3010 * Eg: groupquota@staff -> ZFS_PROP_GROUPQUOTA, "", 1234
3011 * Eg: groupused@staff -> ZFS_PROP_GROUPUSED, "", 1234
3012 * Eg: projectquota@123 -> ZFS_PROP_PROJECTQUOTA, "", 123
3013 * Eg: projectused@789 -> ZFS_PROP_PROJECTUSED, "", 789
3016 userquota_propname_decode(const char *propname
, boolean_t zoned
,
3017 zfs_userquota_prop_t
*typep
, char *domain
, int domainlen
, uint64_t *ridp
)
3019 zfs_userquota_prop_t type
;
3023 boolean_t isproject
;
3029 /* Figure out the property type ({user|group|project}{quota|space}) */
3030 for (type
= 0; type
< ZFS_NUM_USERQUOTA_PROPS
; type
++) {
3031 if (strncmp(propname
, zfs_userquota_prop_prefixes
[type
],
3032 strlen(zfs_userquota_prop_prefixes
[type
])) == 0)
3035 if (type
== ZFS_NUM_USERQUOTA_PROPS
)
3039 isuser
= (type
== ZFS_PROP_USERQUOTA
|| type
== ZFS_PROP_USERUSED
||
3040 type
== ZFS_PROP_USEROBJQUOTA
||
3041 type
== ZFS_PROP_USEROBJUSED
);
3042 isgroup
= (type
== ZFS_PROP_GROUPQUOTA
|| type
== ZFS_PROP_GROUPUSED
||
3043 type
== ZFS_PROP_GROUPOBJQUOTA
||
3044 type
== ZFS_PROP_GROUPOBJUSED
);
3045 isproject
= (type
== ZFS_PROP_PROJECTQUOTA
||
3046 type
== ZFS_PROP_PROJECTUSED
|| type
== ZFS_PROP_PROJECTOBJQUOTA
||
3047 type
== ZFS_PROP_PROJECTOBJUSED
);
3049 cp
= strchr(propname
, '@') + 1;
3051 if (isuser
&& (pw
= getpwnam(cp
)) != NULL
) {
3052 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
3055 } else if (isgroup
&& (gr
= getgrnam(cp
)) != NULL
) {
3056 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
3059 } else if (!isproject
&& strchr(cp
, '@')) {
3062 * It's a SID name (eg "user@domain") that needs to be
3063 * turned into S-1-domainID-RID.
3065 directory_error_t e
;
3066 char *numericsid
= NULL
;
3069 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
3072 e
= directory_sid_from_user_name(NULL
,
3075 e
= directory_sid_from_group_name(NULL
,
3079 directory_error_free(e
);
3082 if (numericsid
== NULL
)
3085 (void) strlcpy(domain
, cp
, domainlen
);
3086 cp
= strrchr(domain
, '-');
3091 *ridp
= strtoull(cp
, &end
, 10);
3094 if (errno
!= 0 || *end
!= '\0')
3098 #endif /* HAVE_IDMAP */
3100 /* It's a user/group/project ID (eg "12345"). */
3103 id
= strtoul(cp
, &end
, 10);
3106 if (id
> MAXUID
&& !isproject
) {
3108 /* It's an ephemeral ID. */
3112 if (idmap_id_to_numeric_domain_rid(id
, isuser
,
3113 &mapdomain
, &rid
) != 0)
3115 (void) strlcpy(domain
, mapdomain
, domainlen
);
3119 #endif /* HAVE_IDMAP */
3129 zfs_prop_get_userquota_common(zfs_handle_t
*zhp
, const char *propname
,
3130 uint64_t *propvalue
, zfs_userquota_prop_t
*typep
)
3133 zfs_cmd_t zc
= {"\0"};
3135 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
3137 err
= userquota_propname_decode(propname
,
3138 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
),
3139 typep
, zc
.zc_value
, sizeof (zc
.zc_value
), &zc
.zc_guid
);
3140 zc
.zc_objset_type
= *typep
;
3144 err
= ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_USERSPACE_ONE
, &zc
);
3148 *propvalue
= zc
.zc_cookie
;
3153 zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
3154 uint64_t *propvalue
)
3156 zfs_userquota_prop_t type
;
3158 return (zfs_prop_get_userquota_common(zhp
, propname
, propvalue
,
3163 zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
3164 char *propbuf
, int proplen
, boolean_t literal
)
3168 zfs_userquota_prop_t type
;
3170 err
= zfs_prop_get_userquota_common(zhp
, propname
, &propvalue
,
3177 (void) snprintf(propbuf
, proplen
, "%llu",
3178 (u_longlong_t
)propvalue
);
3179 } else if (propvalue
== 0 &&
3180 (type
== ZFS_PROP_USERQUOTA
|| type
== ZFS_PROP_GROUPQUOTA
||
3181 type
== ZFS_PROP_USEROBJQUOTA
|| type
== ZFS_PROP_GROUPOBJQUOTA
||
3182 type
== ZFS_PROP_PROJECTQUOTA
||
3183 type
== ZFS_PROP_PROJECTOBJQUOTA
)) {
3184 (void) strlcpy(propbuf
, "none", proplen
);
3185 } else if (type
== ZFS_PROP_USERQUOTA
|| type
== ZFS_PROP_GROUPQUOTA
||
3186 type
== ZFS_PROP_USERUSED
|| type
== ZFS_PROP_GROUPUSED
||
3187 type
== ZFS_PROP_PROJECTUSED
|| type
== ZFS_PROP_PROJECTQUOTA
) {
3188 zfs_nicebytes(propvalue
, propbuf
, proplen
);
3190 zfs_nicenum(propvalue
, propbuf
, proplen
);
3196 zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
3197 uint64_t *propvalue
)
3200 zfs_cmd_t zc
= {"\0"};
3201 const char *snapname
;
3203 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
3205 snapname
= strchr(propname
, '@') + 1;
3206 if (strchr(snapname
, '@')) {
3207 (void) strlcpy(zc
.zc_value
, snapname
, sizeof (zc
.zc_value
));
3209 /* snapname is the short name, append it to zhp's fsname */
3212 (void) strlcpy(zc
.zc_value
, zhp
->zfs_name
,
3213 sizeof (zc
.zc_value
));
3214 cp
= strchr(zc
.zc_value
, '@');
3217 (void) strlcat(zc
.zc_value
, "@", sizeof (zc
.zc_value
));
3218 (void) strlcat(zc
.zc_value
, snapname
, sizeof (zc
.zc_value
));
3221 err
= ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_SPACE_WRITTEN
, &zc
);
3225 *propvalue
= zc
.zc_cookie
;
3230 zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
3231 char *propbuf
, int proplen
, boolean_t literal
)
3236 err
= zfs_prop_get_written_int(zhp
, propname
, &propvalue
);
3242 (void) snprintf(propbuf
, proplen
, "%llu",
3243 (u_longlong_t
)propvalue
);
3245 zfs_nicebytes(propvalue
, propbuf
, proplen
);
3252 * Returns the name of the given zfs handle.
3255 zfs_get_name(const zfs_handle_t
*zhp
)
3257 return (zhp
->zfs_name
);
3261 * Returns the name of the parent pool for the given zfs handle.
3264 zfs_get_pool_name(const zfs_handle_t
*zhp
)
3266 return (zhp
->zpool_hdl
->zpool_name
);
3270 * Returns the type of the given zfs handle.
3273 zfs_get_type(const zfs_handle_t
*zhp
)
3275 return (zhp
->zfs_type
);
3279 * Is one dataset name a child dataset of another?
3281 * Needs to handle these cases:
3282 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
3283 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
3284 * Descendant? No. No. No. Yes.
3287 is_descendant(const char *ds1
, const char *ds2
)
3289 size_t d1len
= strlen(ds1
);
3291 /* ds2 can't be a descendant if it's smaller */
3292 if (strlen(ds2
) < d1len
)
3295 /* otherwise, compare strings and verify that there's a '/' char */
3296 return (ds2
[d1len
] == '/' && (strncmp(ds1
, ds2
, d1len
) == 0));
3300 * Given a complete name, return just the portion that refers to the parent.
3301 * Will return -1 if there is no parent (path is just the name of the
3305 parent_name(const char *path
, char *buf
, size_t buflen
)
3309 (void) strlcpy(buf
, path
, buflen
);
3311 if ((slashp
= strrchr(buf
, '/')) == NULL
)
3319 zfs_parent_name(zfs_handle_t
*zhp
, char *buf
, size_t buflen
)
3321 return (parent_name(zfs_get_name(zhp
), buf
, buflen
));
3325 * If accept_ancestor is false, then check to make sure that the given path has
3326 * a parent, and that it exists. If accept_ancestor is true, then find the
3327 * closest existing ancestor for the given path. In prefixlen return the
3328 * length of already existing prefix of the given path. We also fetch the
3329 * 'zoned' property, which is used to validate property settings when creating
3333 check_parents(libzfs_handle_t
*hdl
, const char *path
, uint64_t *zoned
,
3334 boolean_t accept_ancestor
, int *prefixlen
)
3336 zfs_cmd_t zc
= {"\0"};
3337 char parent
[ZFS_MAX_DATASET_NAME_LEN
];
3343 (void) snprintf(errbuf
, sizeof (errbuf
),
3344 dgettext(TEXT_DOMAIN
, "cannot create '%s'"), path
);
3346 /* get parent, and check to see if this is just a pool */
3347 if (parent_name(path
, parent
, sizeof (parent
)) != 0) {
3348 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3349 "missing dataset name"));
3350 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3353 /* check to see if the pool exists */
3354 if ((slash
= strchr(parent
, '/')) == NULL
)
3355 slash
= parent
+ strlen(parent
);
3356 (void) strncpy(zc
.zc_name
, parent
, slash
- parent
);
3357 zc
.zc_name
[slash
- parent
] = '\0';
3358 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_OBJSET_STATS
, &zc
) != 0 &&
3360 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3361 "no such pool '%s'"), zc
.zc_name
);
3362 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3365 /* check to see if the parent dataset exists */
3366 while ((zhp
= make_dataset_handle(hdl
, parent
)) == NULL
) {
3367 if (errno
== ENOENT
&& accept_ancestor
) {
3369 * Go deeper to find an ancestor, give up on top level.
3371 if (parent_name(parent
, parent
, sizeof (parent
)) != 0) {
3372 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3373 "no such pool '%s'"), zc
.zc_name
);
3374 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3376 } else if (errno
== ENOENT
) {
3377 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3378 "parent does not exist"));
3379 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3381 return (zfs_standard_error(hdl
, errno
, errbuf
));
3384 is_zoned
= zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
);
3388 /* we are in a non-global zone, but parent is in the global zone */
3389 if (getzoneid() != GLOBAL_ZONEID
&& !is_zoned
) {
3390 (void) zfs_standard_error(hdl
, EPERM
, errbuf
);
3395 /* make sure parent is a filesystem */
3396 if (zfs_get_type(zhp
) != ZFS_TYPE_FILESYSTEM
) {
3397 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3398 "parent is not a filesystem"));
3399 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
3405 if (prefixlen
!= NULL
)
3406 *prefixlen
= strlen(parent
);
3411 * Finds whether the dataset of the given type(s) exists.
3414 zfs_dataset_exists(libzfs_handle_t
*hdl
, const char *path
, zfs_type_t types
)
3418 if (!zfs_validate_name(hdl
, path
, types
, B_FALSE
))
3422 * Try to get stats for the dataset, which will tell us if it exists.
3424 if ((zhp
= make_dataset_handle(hdl
, path
)) != NULL
) {
3425 int ds_type
= zhp
->zfs_type
;
3428 if (types
& ds_type
)
3435 * Given a path to 'target', create all the ancestors between
3436 * the prefixlen portion of the path, and the target itself.
3437 * Fail if the initial prefixlen-ancestor does not already exist.
3440 create_parents(libzfs_handle_t
*hdl
, char *target
, int prefixlen
)
3446 /* make sure prefix exists */
3447 cp
= target
+ prefixlen
;
3449 assert(strchr(cp
, '/') == NULL
);
3450 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3453 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3461 * Attempt to create, mount, and share any ancestor filesystems,
3462 * up to the prefixlen-long one.
3464 for (cp
= target
+ prefixlen
+ 1;
3465 (cp
= strchr(cp
, '/')) != NULL
; *cp
= '/', cp
++) {
3469 h
= make_dataset_handle(hdl
, target
);
3471 /* it already exists, nothing to do here */
3476 if (zfs_create(hdl
, target
, ZFS_TYPE_FILESYSTEM
,
3478 opname
= dgettext(TEXT_DOMAIN
, "create");
3482 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3484 opname
= dgettext(TEXT_DOMAIN
, "open");
3488 if (zfs_mount(h
, NULL
, 0) != 0) {
3489 opname
= dgettext(TEXT_DOMAIN
, "mount");
3493 if (zfs_share(h
) != 0) {
3494 opname
= dgettext(TEXT_DOMAIN
, "share");
3504 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3505 "failed to %s ancestor '%s'"), opname
, target
);
3510 * Creates non-existing ancestors of the given path.
3513 zfs_create_ancestors(libzfs_handle_t
*hdl
, const char *path
)
3519 if (check_parents(hdl
, path
, NULL
, B_TRUE
, &prefix
) != 0)
3522 if ((path_copy
= strdup(path
)) != NULL
) {
3523 rc
= create_parents(hdl
, path_copy
, prefix
);
3526 if (path_copy
== NULL
|| rc
!= 0)
3533 * Create a new filesystem or volume.
3536 zfs_create(libzfs_handle_t
*hdl
, const char *path
, zfs_type_t type
,
3541 uint64_t blocksize
= zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE
);
3543 enum lzc_dataset_type ost
;
3544 zpool_handle_t
*zpool_handle
;
3545 uint8_t *wkeydata
= NULL
;
3548 char parent
[ZFS_MAX_DATASET_NAME_LEN
];
3550 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3551 "cannot create '%s'"), path
);
3553 /* validate the path, taking care to note the extended error message */
3554 if (!zfs_validate_name(hdl
, path
, type
, B_TRUE
))
3555 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3557 /* validate parents exist */
3558 if (check_parents(hdl
, path
, &zoned
, B_FALSE
, NULL
) != 0)
3562 * The failure modes when creating a dataset of a different type over
3563 * one that already exists is a little strange. In particular, if you
3564 * try to create a dataset on top of an existing dataset, the ioctl()
3565 * will return ENOENT, not EEXIST. To prevent this from happening, we
3566 * first try to see if the dataset exists.
3568 if (zfs_dataset_exists(hdl
, path
, ZFS_TYPE_DATASET
)) {
3569 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3570 "dataset already exists"));
3571 return (zfs_error(hdl
, EZFS_EXISTS
, errbuf
));
3574 if (type
== ZFS_TYPE_VOLUME
)
3575 ost
= LZC_DATSET_TYPE_ZVOL
;
3577 ost
= LZC_DATSET_TYPE_ZFS
;
3579 /* open zpool handle for prop validation */
3580 char pool_path
[ZFS_MAX_DATASET_NAME_LEN
];
3581 (void) strlcpy(pool_path
, path
, sizeof (pool_path
));
3583 /* truncate pool_path at first slash */
3584 char *p
= strchr(pool_path
, '/');
3588 if ((zpool_handle
= zpool_open(hdl
, pool_path
)) == NULL
)
3591 if (props
&& (props
= zfs_valid_proplist(hdl
, type
, props
,
3592 zoned
, NULL
, zpool_handle
, B_TRUE
, errbuf
)) == 0) {
3593 zpool_close(zpool_handle
);
3596 zpool_close(zpool_handle
);
3598 if (type
== ZFS_TYPE_VOLUME
) {
3600 * If we are creating a volume, the size and block size must
3601 * satisfy a few restraints. First, the blocksize must be a
3602 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3603 * volsize must be a multiple of the block size, and cannot be
3606 if (props
== NULL
|| nvlist_lookup_uint64(props
,
3607 zfs_prop_to_name(ZFS_PROP_VOLSIZE
), &size
) != 0) {
3609 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3610 "missing volume size"));
3611 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3614 if ((ret
= nvlist_lookup_uint64(props
,
3615 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
3616 &blocksize
)) != 0) {
3617 if (ret
== ENOENT
) {
3618 blocksize
= zfs_prop_default_numeric(
3619 ZFS_PROP_VOLBLOCKSIZE
);
3622 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3623 "missing volume block size"));
3624 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3630 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3631 "volume size cannot be zero"));
3632 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3635 if (size
% blocksize
!= 0) {
3637 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3638 "volume size must be a multiple of volume block "
3640 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3644 (void) parent_name(path
, parent
, sizeof (parent
));
3645 if (zfs_crypto_create(hdl
, parent
, props
, NULL
, &wkeydata
,
3648 return (zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
));
3651 /* create the dataset */
3652 ret
= lzc_create(path
, ost
, props
, wkeydata
, wkeylen
);
3654 if (wkeydata
!= NULL
)
3657 /* check for failure */
3661 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3662 "no such parent '%s'"), parent
);
3663 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3666 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3667 "parent '%s' is not a filesystem"), parent
);
3668 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3671 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3672 "pool must be upgraded to set this "
3673 "property or value"));
3674 return (zfs_error(hdl
, EZFS_BADVERSION
, errbuf
));
3677 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3678 "encryption root's key is not loaded "
3680 return (zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
));
3683 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3684 "invalid property value(s) specified"));
3685 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3689 * This platform can't address a volume this big.
3691 if (type
== ZFS_TYPE_VOLUME
)
3692 return (zfs_error(hdl
, EZFS_VOLTOOBIG
,
3697 return (zfs_standard_error(hdl
, errno
, errbuf
));
3705 * Destroys the given dataset. The caller must make sure that the filesystem
3706 * isn't mounted, and that there are no active dependents. If the file system
3707 * does not exist this function does nothing.
3710 zfs_destroy(zfs_handle_t
*zhp
, boolean_t defer
)
3712 zfs_cmd_t zc
= {"\0"};
3714 if (zhp
->zfs_type
== ZFS_TYPE_BOOKMARK
) {
3715 nvlist_t
*nv
= fnvlist_alloc();
3716 fnvlist_add_boolean(nv
, zhp
->zfs_name
);
3717 int error
= lzc_destroy_bookmarks(nv
, NULL
);
3720 return (zfs_standard_error_fmt(zhp
->zfs_hdl
, errno
,
3721 dgettext(TEXT_DOMAIN
, "cannot destroy '%s'"),
3727 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
3729 if (ZFS_IS_VOLUME(zhp
)) {
3730 zc
.zc_objset_type
= DMU_OST_ZVOL
;
3732 zc
.zc_objset_type
= DMU_OST_ZFS
;
3735 zc
.zc_defer_destroy
= defer
;
3736 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_DESTROY
, &zc
) != 0 &&
3738 return (zfs_standard_error_fmt(zhp
->zfs_hdl
, errno
,
3739 dgettext(TEXT_DOMAIN
, "cannot destroy '%s'"),
3743 remove_mountpoint(zhp
);
3748 struct destroydata
{
3750 const char *snapname
;
3754 zfs_check_snap_cb(zfs_handle_t
*zhp
, void *arg
)
3756 struct destroydata
*dd
= arg
;
3757 char name
[ZFS_MAX_DATASET_NAME_LEN
];
3760 if (snprintf(name
, sizeof (name
), "%s@%s", zhp
->zfs_name
,
3761 dd
->snapname
) >= sizeof (name
))
3764 if (lzc_exists(name
))
3765 verify(nvlist_add_boolean(dd
->nvl
, name
) == 0);
3767 rv
= zfs_iter_filesystems(zhp
, zfs_check_snap_cb
, dd
);
3773 * Destroys all snapshots with the given name in zhp & descendants.
3776 zfs_destroy_snaps(zfs_handle_t
*zhp
, char *snapname
, boolean_t defer
)
3779 struct destroydata dd
= { 0 };
3781 dd
.snapname
= snapname
;
3782 verify(nvlist_alloc(&dd
.nvl
, NV_UNIQUE_NAME
, 0) == 0);
3783 (void) zfs_check_snap_cb(zfs_handle_dup(zhp
), &dd
);
3785 if (nvlist_empty(dd
.nvl
)) {
3786 ret
= zfs_standard_error_fmt(zhp
->zfs_hdl
, ENOENT
,
3787 dgettext(TEXT_DOMAIN
, "cannot destroy '%s@%s'"),
3788 zhp
->zfs_name
, snapname
);
3790 ret
= zfs_destroy_snaps_nvl(zhp
->zfs_hdl
, dd
.nvl
, defer
);
3792 nvlist_free(dd
.nvl
);
3797 * Destroys all the snapshots named in the nvlist.
3800 zfs_destroy_snaps_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
, boolean_t defer
)
3803 nvlist_t
*errlist
= NULL
;
3806 ret
= lzc_destroy_snaps(snaps
, defer
, &errlist
);
3809 nvlist_free(errlist
);
3813 if (nvlist_empty(errlist
)) {
3815 (void) snprintf(errbuf
, sizeof (errbuf
),
3816 dgettext(TEXT_DOMAIN
, "cannot destroy snapshots"));
3818 ret
= zfs_standard_error(hdl
, ret
, errbuf
);
3820 for (pair
= nvlist_next_nvpair(errlist
, NULL
);
3821 pair
!= NULL
; pair
= nvlist_next_nvpair(errlist
, pair
)) {
3823 (void) snprintf(errbuf
, sizeof (errbuf
),
3824 dgettext(TEXT_DOMAIN
, "cannot destroy snapshot %s"),
3827 switch (fnvpair_value_int32(pair
)) {
3830 dgettext(TEXT_DOMAIN
, "snapshot is cloned"));
3831 ret
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3834 ret
= zfs_standard_error(hdl
, errno
, errbuf
);
3839 nvlist_free(errlist
);
3844 * Clones the given dataset. The target must be of the same type as the source.
3847 zfs_clone(zfs_handle_t
*zhp
, const char *target
, nvlist_t
*props
)
3849 char parent
[ZFS_MAX_DATASET_NAME_LEN
];
3852 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3855 assert(zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
);
3857 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3858 "cannot create '%s'"), target
);
3860 /* validate the target/clone name */
3861 if (!zfs_validate_name(hdl
, target
, ZFS_TYPE_FILESYSTEM
, B_TRUE
))
3862 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3864 /* validate parents exist */
3865 if (check_parents(hdl
, target
, &zoned
, B_FALSE
, NULL
) != 0)
3868 (void) parent_name(target
, parent
, sizeof (parent
));
3874 if (ZFS_IS_VOLUME(zhp
)) {
3875 type
= ZFS_TYPE_VOLUME
;
3877 type
= ZFS_TYPE_FILESYSTEM
;
3879 if ((props
= zfs_valid_proplist(hdl
, type
, props
, zoned
,
3880 zhp
, zhp
->zpool_hdl
, B_TRUE
, errbuf
)) == NULL
)
3884 if (zfs_crypto_clone_check(hdl
, zhp
, parent
, props
) != 0) {
3886 return (zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
));
3889 ret
= lzc_clone(target
, zhp
->zfs_name
, props
);
3897 * The parent doesn't exist. We should have caught this
3898 * above, but there may a race condition that has since
3899 * destroyed the parent.
3901 * At this point, we don't know whether it's the source
3902 * that doesn't exist anymore, or whether the target
3903 * dataset doesn't exist.
3905 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
3906 "no such parent '%s'"), parent
);
3907 return (zfs_error(zhp
->zfs_hdl
, EZFS_NOENT
, errbuf
));
3910 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
3911 "source and target pools differ"));
3912 return (zfs_error(zhp
->zfs_hdl
, EZFS_CROSSTARGET
,
3916 return (zfs_standard_error(zhp
->zfs_hdl
, errno
,
3925 * Promotes the given clone fs to be the clone parent.
3928 zfs_promote(zfs_handle_t
*zhp
)
3930 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3931 char snapname
[ZFS_MAX_DATASET_NAME_LEN
];
3935 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3936 "cannot promote '%s'"), zhp
->zfs_name
);
3938 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
) {
3939 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3940 "snapshots can not be promoted"));
3941 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3944 if (zhp
->zfs_dmustats
.dds_origin
[0] == '\0') {
3945 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3946 "not a cloned filesystem"));
3947 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3950 if (!zfs_validate_name(hdl
, zhp
->zfs_name
, zhp
->zfs_type
, B_TRUE
))
3951 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3953 ret
= lzc_promote(zhp
->zfs_name
, snapname
, sizeof (snapname
));
3958 /* There is a conflicting snapshot name. */
3959 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3960 "conflicting snapshot '%s' from parent '%s'"),
3961 snapname
, zhp
->zfs_dmustats
.dds_origin
);
3962 return (zfs_error(hdl
, EZFS_EXISTS
, errbuf
));
3965 return (zfs_standard_error(hdl
, ret
, errbuf
));
3971 typedef struct snapdata
{
3973 const char *sd_snapname
;
3977 zfs_snapshot_cb(zfs_handle_t
*zhp
, void *arg
)
3979 snapdata_t
*sd
= arg
;
3980 char name
[ZFS_MAX_DATASET_NAME_LEN
];
3983 if (zfs_prop_get_int(zhp
, ZFS_PROP_INCONSISTENT
) == 0) {
3984 if (snprintf(name
, sizeof (name
), "%s@%s", zfs_get_name(zhp
),
3985 sd
->sd_snapname
) >= sizeof (name
))
3988 fnvlist_add_boolean(sd
->sd_nvl
, name
);
3990 rv
= zfs_iter_filesystems(zhp
, zfs_snapshot_cb
, sd
);
3998 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
4002 zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
, nvlist_t
*props
)
4008 zpool_handle_t
*zpool_hdl
;
4009 char pool
[ZFS_MAX_DATASET_NAME_LEN
];
4011 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4012 "cannot create snapshots "));
4015 while ((elem
= nvlist_next_nvpair(snaps
, elem
)) != NULL
) {
4016 const char *snapname
= nvpair_name(elem
);
4018 /* validate the target name */
4019 if (!zfs_validate_name(hdl
, snapname
, ZFS_TYPE_SNAPSHOT
,
4021 (void) snprintf(errbuf
, sizeof (errbuf
),
4022 dgettext(TEXT_DOMAIN
,
4023 "cannot create snapshot '%s'"), snapname
);
4024 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
4029 * get pool handle for prop validation. assumes all snaps are in the
4030 * same pool, as does lzc_snapshot (below).
4032 elem
= nvlist_next_nvpair(snaps
, NULL
);
4033 (void) strlcpy(pool
, nvpair_name(elem
), sizeof (pool
));
4034 pool
[strcspn(pool
, "/@")] = '\0';
4035 zpool_hdl
= zpool_open(hdl
, pool
);
4036 if (zpool_hdl
== NULL
)
4039 if (props
!= NULL
&&
4040 (props
= zfs_valid_proplist(hdl
, ZFS_TYPE_SNAPSHOT
,
4041 props
, B_FALSE
, NULL
, zpool_hdl
, B_FALSE
, errbuf
)) == NULL
) {
4042 zpool_close(zpool_hdl
);
4045 zpool_close(zpool_hdl
);
4047 ret
= lzc_snapshot(snaps
, props
, &errors
);
4050 boolean_t printed
= B_FALSE
;
4051 for (elem
= nvlist_next_nvpair(errors
, NULL
);
4053 elem
= nvlist_next_nvpair(errors
, elem
)) {
4054 (void) snprintf(errbuf
, sizeof (errbuf
),
4055 dgettext(TEXT_DOMAIN
,
4056 "cannot create snapshot '%s'"), nvpair_name(elem
));
4057 (void) zfs_standard_error(hdl
,
4058 fnvpair_value_int32(elem
), errbuf
);
4064 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4065 "multiple snapshots of same "
4067 (void) zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
4071 (void) zfs_standard_error(hdl
, ret
, errbuf
);
4077 nvlist_free(errors
);
4082 zfs_snapshot(libzfs_handle_t
*hdl
, const char *path
, boolean_t recursive
,
4086 snapdata_t sd
= { 0 };
4087 char fsname
[ZFS_MAX_DATASET_NAME_LEN
];
4092 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4093 "cannot snapshot %s"), path
);
4095 if (!zfs_validate_name(hdl
, path
, ZFS_TYPE_SNAPSHOT
, B_TRUE
))
4096 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
4098 (void) strlcpy(fsname
, path
, sizeof (fsname
));
4099 cp
= strchr(fsname
, '@');
4101 sd
.sd_snapname
= cp
+ 1;
4103 if ((zhp
= zfs_open(hdl
, fsname
, ZFS_TYPE_FILESYSTEM
|
4104 ZFS_TYPE_VOLUME
)) == NULL
) {
4108 verify(nvlist_alloc(&sd
.sd_nvl
, NV_UNIQUE_NAME
, 0) == 0);
4110 (void) zfs_snapshot_cb(zfs_handle_dup(zhp
), &sd
);
4112 fnvlist_add_boolean(sd
.sd_nvl
, path
);
4115 ret
= zfs_snapshot_nvl(hdl
, sd
.sd_nvl
, props
);
4116 nvlist_free(sd
.sd_nvl
);
4122 * Destroy any more recent snapshots. We invoke this callback on any dependents
4123 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
4124 * is a dependent and we should just destroy it without checking the transaction
4127 typedef struct rollback_data
{
4128 const char *cb_target
; /* the snapshot */
4129 uint64_t cb_create
; /* creation time reference */
4135 rollback_destroy_dependent(zfs_handle_t
*zhp
, void *data
)
4137 rollback_data_t
*cbp
= data
;
4138 prop_changelist_t
*clp
;
4140 /* We must destroy this clone; first unmount it */
4141 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
4142 cbp
->cb_force
? MS_FORCE
: 0);
4143 if (clp
== NULL
|| changelist_prefix(clp
) != 0) {
4144 cbp
->cb_error
= B_TRUE
;
4148 if (zfs_destroy(zhp
, B_FALSE
) != 0)
4149 cbp
->cb_error
= B_TRUE
;
4151 changelist_remove(clp
, zhp
->zfs_name
);
4152 (void) changelist_postfix(clp
);
4153 changelist_free(clp
);
4160 rollback_destroy(zfs_handle_t
*zhp
, void *data
)
4162 rollback_data_t
*cbp
= data
;
4164 if (zfs_prop_get_int(zhp
, ZFS_PROP_CREATETXG
) > cbp
->cb_create
) {
4165 cbp
->cb_error
|= zfs_iter_dependents(zhp
, B_FALSE
,
4166 rollback_destroy_dependent
, cbp
);
4168 cbp
->cb_error
|= zfs_destroy(zhp
, B_FALSE
);
4176 * Given a dataset, rollback to a specific snapshot, discarding any
4177 * data changes since then and making it the active dataset.
4179 * Any snapshots and bookmarks more recent than the target are
4180 * destroyed, along with their dependents (i.e. clones).
4183 zfs_rollback(zfs_handle_t
*zhp
, zfs_handle_t
*snap
, boolean_t force
)
4185 rollback_data_t cb
= { 0 };
4187 boolean_t restore_resv
= 0;
4188 uint64_t old_volsize
= 0, new_volsize
;
4189 zfs_prop_t resv_prop
= { 0 };
4191 assert(zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
||
4192 zhp
->zfs_type
== ZFS_TYPE_VOLUME
);
4195 * Destroy all recent snapshots and their dependents.
4197 cb
.cb_force
= force
;
4198 cb
.cb_target
= snap
->zfs_name
;
4199 cb
.cb_create
= zfs_prop_get_int(snap
, ZFS_PROP_CREATETXG
);
4200 (void) zfs_iter_snapshots(zhp
, B_FALSE
, rollback_destroy
, &cb
);
4201 (void) zfs_iter_bookmarks(zhp
, rollback_destroy
, &cb
);
4207 * Now that we have verified that the snapshot is the latest,
4208 * rollback to the given snapshot.
4211 if (zhp
->zfs_type
== ZFS_TYPE_VOLUME
) {
4212 if (zfs_which_resv_prop(zhp
, &resv_prop
) < 0)
4214 old_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
4216 (old_volsize
== zfs_prop_get_int(zhp
, resv_prop
));
4220 * Pass both the filesystem and the wanted snapshot names,
4221 * we would get an error back if the snapshot is destroyed or
4222 * a new snapshot is created before this request is processed.
4224 err
= lzc_rollback_to(zhp
->zfs_name
, snap
->zfs_name
);
4228 (void) snprintf(errbuf
, sizeof (errbuf
),
4229 dgettext(TEXT_DOMAIN
, "cannot rollback '%s'"),
4233 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
4234 "there is a snapshot or bookmark more recent "
4235 "than '%s'"), snap
->zfs_name
);
4236 (void) zfs_error(zhp
->zfs_hdl
, EZFS_EXISTS
, errbuf
);
4239 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
4240 "'%s' is not found among snapshots of '%s'"),
4241 snap
->zfs_name
, zhp
->zfs_name
);
4242 (void) zfs_error(zhp
->zfs_hdl
, EZFS_NOENT
, errbuf
);
4245 (void) zfs_error(zhp
->zfs_hdl
, EZFS_BADTYPE
, errbuf
);
4248 (void) zfs_standard_error(zhp
->zfs_hdl
, err
, errbuf
);
4254 * For volumes, if the pre-rollback volsize matched the pre-
4255 * rollback reservation and the volsize has changed then set
4256 * the reservation property to the post-rollback volsize.
4257 * Make a new handle since the rollback closed the dataset.
4259 if ((zhp
->zfs_type
== ZFS_TYPE_VOLUME
) &&
4260 (zhp
= make_dataset_handle(zhp
->zfs_hdl
, zhp
->zfs_name
))) {
4262 new_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
4263 if (old_volsize
!= new_volsize
)
4264 err
= zfs_prop_set_int(zhp
, resv_prop
,
4273 * Renames the given dataset.
4276 zfs_rename(zfs_handle_t
*zhp
, const char *target
, boolean_t recursive
,
4277 boolean_t force_unmount
)
4280 zfs_cmd_t zc
= {"\0"};
4282 prop_changelist_t
*cl
= NULL
;
4283 zfs_handle_t
*zhrp
= NULL
;
4284 char *parentname
= NULL
;
4285 char parent
[ZFS_MAX_DATASET_NAME_LEN
];
4286 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4289 /* if we have the same exact name, just return success */
4290 if (strcmp(zhp
->zfs_name
, target
) == 0)
4293 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4294 "cannot rename to '%s'"), target
);
4296 /* make sure source name is valid */
4297 if (!zfs_validate_name(hdl
, zhp
->zfs_name
, zhp
->zfs_type
, B_TRUE
))
4298 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
4301 * Make sure the target name is valid
4303 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
) {
4304 if ((strchr(target
, '@') == NULL
) ||
4307 * Snapshot target name is abbreviated,
4308 * reconstruct full dataset name
4310 (void) strlcpy(parent
, zhp
->zfs_name
,
4312 delim
= strchr(parent
, '@');
4313 if (strchr(target
, '@') == NULL
)
4317 (void) strlcat(parent
, target
, sizeof (parent
));
4321 * Make sure we're renaming within the same dataset.
4323 delim
= strchr(target
, '@');
4324 if (strncmp(zhp
->zfs_name
, target
, delim
- target
)
4325 != 0 || zhp
->zfs_name
[delim
- target
] != '@') {
4326 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4327 "snapshots must be part of same "
4329 return (zfs_error(hdl
, EZFS_CROSSTARGET
,
4333 if (!zfs_validate_name(hdl
, target
, zhp
->zfs_type
, B_TRUE
))
4334 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
4337 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4338 "recursive rename must be a snapshot"));
4339 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
4342 if (!zfs_validate_name(hdl
, target
, zhp
->zfs_type
, B_TRUE
))
4343 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
4345 /* validate parents */
4346 if (check_parents(hdl
, target
, NULL
, B_FALSE
, NULL
) != 0)
4349 /* make sure we're in the same pool */
4350 verify((delim
= strchr(target
, '/')) != NULL
);
4351 if (strncmp(zhp
->zfs_name
, target
, delim
- target
) != 0 ||
4352 zhp
->zfs_name
[delim
- target
] != '/') {
4353 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4354 "datasets must be within same pool"));
4355 return (zfs_error(hdl
, EZFS_CROSSTARGET
, errbuf
));
4358 /* new name cannot be a child of the current dataset name */
4359 if (is_descendant(zhp
->zfs_name
, target
)) {
4360 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4361 "New dataset name cannot be a descendant of "
4362 "current dataset name"));
4363 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
4367 (void) snprintf(errbuf
, sizeof (errbuf
),
4368 dgettext(TEXT_DOMAIN
, "cannot rename '%s'"), zhp
->zfs_name
);
4370 if (getzoneid() == GLOBAL_ZONEID
&&
4371 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
)) {
4372 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4373 "dataset is used in a non-global zone"));
4374 return (zfs_error(hdl
, EZFS_ZONED
, errbuf
));
4378 parentname
= zfs_strdup(zhp
->zfs_hdl
, zhp
->zfs_name
);
4379 if (parentname
== NULL
) {
4383 delim
= strchr(parentname
, '@');
4385 zhrp
= zfs_open(zhp
->zfs_hdl
, parentname
, ZFS_TYPE_DATASET
);
4390 } else if (zhp
->zfs_type
!= ZFS_TYPE_SNAPSHOT
) {
4391 if ((cl
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
4392 force_unmount
? MS_FORCE
: 0)) == NULL
)
4395 if (changelist_haszonedchild(cl
)) {
4396 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4397 "child dataset with inherited mountpoint is used "
4398 "in a non-global zone"));
4399 (void) zfs_error(hdl
, EZFS_ZONED
, errbuf
);
4404 if ((ret
= changelist_prefix(cl
)) != 0)
4408 if (ZFS_IS_VOLUME(zhp
))
4409 zc
.zc_objset_type
= DMU_OST_ZVOL
;
4411 zc
.zc_objset_type
= DMU_OST_ZFS
;
4413 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
4414 (void) strlcpy(zc
.zc_value
, target
, sizeof (zc
.zc_value
));
4416 zc
.zc_cookie
= recursive
;
4418 if ((ret
= zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_RENAME
, &zc
)) != 0) {
4420 * if it was recursive, the one that actually failed will
4423 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4424 "cannot rename '%s'"), zc
.zc_name
);
4426 if (recursive
&& errno
== EEXIST
) {
4427 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4428 "a child dataset already has a snapshot "
4429 "with the new name"));
4430 (void) zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
4431 } else if (errno
== EACCES
) {
4432 if (zfs_prop_get_int(zhp
, ZFS_PROP_ENCRYPTION
) ==
4434 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4435 "cannot rename an unencrypted dataset to "
4436 "be a decendent of an encrypted one"));
4438 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4439 "cannot move encryption child outside of "
4440 "its encryption root"));
4442 (void) zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
);
4444 (void) zfs_standard_error(zhp
->zfs_hdl
, errno
, errbuf
);
4448 * On failure, we still want to remount any filesystems that
4449 * were previously mounted, so we don't alter the system state.
4452 (void) changelist_postfix(cl
);
4455 changelist_rename(cl
, zfs_get_name(zhp
), target
);
4456 ret
= changelist_postfix(cl
);
4461 if (parentname
!= NULL
) {
4468 changelist_free(cl
);
4474 zfs_get_all_props(zfs_handle_t
*zhp
)
4476 return (zhp
->zfs_props
);
4480 zfs_get_recvd_props(zfs_handle_t
*zhp
)
4482 if (zhp
->zfs_recvd_props
== NULL
)
4483 if (get_recvd_props_ioctl(zhp
) != 0)
4485 return (zhp
->zfs_recvd_props
);
4489 zfs_get_user_props(zfs_handle_t
*zhp
)
4491 return (zhp
->zfs_user_props
);
4495 * This function is used by 'zfs list' to determine the exact set of columns to
4496 * display, and their maximum widths. This does two main things:
4498 * - If this is a list of all properties, then expand the list to include
4499 * all native properties, and set a flag so that for each dataset we look
4500 * for new unique user properties and add them to the list.
4502 * - For non fixed-width properties, keep track of the maximum width seen
4503 * so that we can size the column appropriately. If the user has
4504 * requested received property values, we also need to compute the width
4505 * of the RECEIVED column.
4508 zfs_expand_proplist(zfs_handle_t
*zhp
, zprop_list_t
**plp
, boolean_t received
,
4511 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4512 zprop_list_t
*entry
;
4513 zprop_list_t
**last
, **start
;
4514 nvlist_t
*userprops
, *propval
;
4517 char buf
[ZFS_MAXPROPLEN
];
4519 if (zprop_expand_list(hdl
, plp
, ZFS_TYPE_DATASET
) != 0)
4522 userprops
= zfs_get_user_props(zhp
);
4525 if (entry
->pl_all
&& nvlist_next_nvpair(userprops
, NULL
) != NULL
) {
4527 * Go through and add any user properties as necessary. We
4528 * start by incrementing our list pointer to the first
4529 * non-native property.
4532 while (*start
!= NULL
) {
4533 if ((*start
)->pl_prop
== ZPROP_INVAL
)
4535 start
= &(*start
)->pl_next
;
4539 while ((elem
= nvlist_next_nvpair(userprops
, elem
)) != NULL
) {
4541 * See if we've already found this property in our list.
4543 for (last
= start
; *last
!= NULL
;
4544 last
= &(*last
)->pl_next
) {
4545 if (strcmp((*last
)->pl_user_prop
,
4546 nvpair_name(elem
)) == 0)
4550 if (*last
== NULL
) {
4551 if ((entry
= zfs_alloc(hdl
,
4552 sizeof (zprop_list_t
))) == NULL
||
4553 ((entry
->pl_user_prop
= zfs_strdup(hdl
,
4554 nvpair_name(elem
)))) == NULL
) {
4559 entry
->pl_prop
= ZPROP_INVAL
;
4560 entry
->pl_width
= strlen(nvpair_name(elem
));
4561 entry
->pl_all
= B_TRUE
;
4568 * Now go through and check the width of any non-fixed columns
4570 for (entry
= *plp
; entry
!= NULL
; entry
= entry
->pl_next
) {
4571 if (entry
->pl_fixed
&& !literal
)
4574 if (entry
->pl_prop
!= ZPROP_INVAL
) {
4575 if (zfs_prop_get(zhp
, entry
->pl_prop
,
4576 buf
, sizeof (buf
), NULL
, NULL
, 0, literal
) == 0) {
4577 if (strlen(buf
) > entry
->pl_width
)
4578 entry
->pl_width
= strlen(buf
);
4580 if (received
&& zfs_prop_get_recvd(zhp
,
4581 zfs_prop_to_name(entry
->pl_prop
),
4582 buf
, sizeof (buf
), literal
) == 0)
4583 if (strlen(buf
) > entry
->pl_recvd_width
)
4584 entry
->pl_recvd_width
= strlen(buf
);
4586 if (nvlist_lookup_nvlist(userprops
, entry
->pl_user_prop
,
4588 verify(nvlist_lookup_string(propval
,
4589 ZPROP_VALUE
, &strval
) == 0);
4590 if (strlen(strval
) > entry
->pl_width
)
4591 entry
->pl_width
= strlen(strval
);
4593 if (received
&& zfs_prop_get_recvd(zhp
,
4594 entry
->pl_user_prop
,
4595 buf
, sizeof (buf
), literal
) == 0)
4596 if (strlen(buf
) > entry
->pl_recvd_width
)
4597 entry
->pl_recvd_width
= strlen(buf
);
4605 zfs_prune_proplist(zfs_handle_t
*zhp
, uint8_t *props
)
4611 * Keep a reference to the props-table against which we prune the
4614 zhp
->zfs_props_table
= props
;
4616 curr
= nvlist_next_nvpair(zhp
->zfs_props
, NULL
);
4619 zfs_prop_t zfs_prop
= zfs_name_to_prop(nvpair_name(curr
));
4620 next
= nvlist_next_nvpair(zhp
->zfs_props
, curr
);
4623 * User properties will result in ZPROP_INVAL, and since we
4624 * only know how to prune standard ZFS properties, we always
4625 * leave these in the list. This can also happen if we
4626 * encounter an unknown DSL property (when running older
4627 * software, for example).
4629 if (zfs_prop
!= ZPROP_INVAL
&& props
[zfs_prop
] == B_FALSE
)
4630 (void) nvlist_remove(zhp
->zfs_props
,
4631 nvpair_name(curr
), nvpair_type(curr
));
4637 zfs_smb_acl_mgmt(libzfs_handle_t
*hdl
, char *dataset
, char *path
,
4638 zfs_smb_acl_op_t cmd
, char *resource1
, char *resource2
)
4640 zfs_cmd_t zc
= {"\0"};
4641 nvlist_t
*nvlist
= NULL
;
4644 (void) strlcpy(zc
.zc_name
, dataset
, sizeof (zc
.zc_name
));
4645 (void) strlcpy(zc
.zc_value
, path
, sizeof (zc
.zc_value
));
4646 zc
.zc_cookie
= (uint64_t)cmd
;
4648 if (cmd
== ZFS_SMB_ACL_RENAME
) {
4649 if (nvlist_alloc(&nvlist
, NV_UNIQUE_NAME
, 0) != 0) {
4650 (void) no_memory(hdl
);
4656 case ZFS_SMB_ACL_ADD
:
4657 case ZFS_SMB_ACL_REMOVE
:
4658 (void) strlcpy(zc
.zc_string
, resource1
, sizeof (zc
.zc_string
));
4660 case ZFS_SMB_ACL_RENAME
:
4661 if (nvlist_add_string(nvlist
, ZFS_SMB_ACL_SRC
,
4663 (void) no_memory(hdl
);
4666 if (nvlist_add_string(nvlist
, ZFS_SMB_ACL_TARGET
,
4668 (void) no_memory(hdl
);
4671 if (zcmd_write_src_nvlist(hdl
, &zc
, nvlist
) != 0) {
4672 nvlist_free(nvlist
);
4676 case ZFS_SMB_ACL_PURGE
:
4681 error
= ioctl(hdl
->libzfs_fd
, ZFS_IOC_SMB_ACL
, &zc
);
4682 nvlist_free(nvlist
);
4687 zfs_smb_acl_add(libzfs_handle_t
*hdl
, char *dataset
,
4688 char *path
, char *resource
)
4690 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_ADD
,
4695 zfs_smb_acl_remove(libzfs_handle_t
*hdl
, char *dataset
,
4696 char *path
, char *resource
)
4698 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_REMOVE
,
4703 zfs_smb_acl_purge(libzfs_handle_t
*hdl
, char *dataset
, char *path
)
4705 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_PURGE
,
4710 zfs_smb_acl_rename(libzfs_handle_t
*hdl
, char *dataset
, char *path
,
4711 char *oldname
, char *newname
)
4713 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_RENAME
,
4718 zfs_userspace(zfs_handle_t
*zhp
, zfs_userquota_prop_t type
,
4719 zfs_userspace_cb_t func
, void *arg
)
4721 zfs_cmd_t zc
= {"\0"};
4722 zfs_useracct_t buf
[100];
4723 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4726 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
4728 zc
.zc_objset_type
= type
;
4729 zc
.zc_nvlist_dst
= (uintptr_t)buf
;
4732 zfs_useracct_t
*zua
= buf
;
4734 zc
.zc_nvlist_dst_size
= sizeof (buf
);
4735 if (zfs_ioctl(hdl
, ZFS_IOC_USERSPACE_MANY
, &zc
) != 0) {
4738 if ((errno
== ENOTSUP
&&
4739 (type
== ZFS_PROP_USEROBJUSED
||
4740 type
== ZFS_PROP_GROUPOBJUSED
||
4741 type
== ZFS_PROP_USEROBJQUOTA
||
4742 type
== ZFS_PROP_GROUPOBJQUOTA
||
4743 type
== ZFS_PROP_PROJECTOBJUSED
||
4744 type
== ZFS_PROP_PROJECTOBJQUOTA
||
4745 type
== ZFS_PROP_PROJECTUSED
||
4746 type
== ZFS_PROP_PROJECTQUOTA
)))
4749 (void) snprintf(errbuf
, sizeof (errbuf
),
4750 dgettext(TEXT_DOMAIN
,
4751 "cannot get used/quota for %s"), zc
.zc_name
);
4752 return (zfs_standard_error_fmt(hdl
, errno
, errbuf
));
4754 if (zc
.zc_nvlist_dst_size
== 0)
4757 while (zc
.zc_nvlist_dst_size
> 0) {
4758 if ((ret
= func(arg
, zua
->zu_domain
, zua
->zu_rid
,
4759 zua
->zu_space
)) != 0)
4762 zc
.zc_nvlist_dst_size
-= sizeof (zfs_useracct_t
);
4771 const char *snapname
;
4773 boolean_t recursive
;
4778 zfs_hold_one(zfs_handle_t
*zhp
, void *arg
)
4780 struct holdarg
*ha
= arg
;
4781 char name
[ZFS_MAX_DATASET_NAME_LEN
];
4784 if (snprintf(name
, sizeof (name
), "%s@%s", zhp
->zfs_name
,
4785 ha
->snapname
) >= sizeof (name
))
4788 if (lzc_exists(name
))
4789 fnvlist_add_string(ha
->nvl
, name
, ha
->tag
);
4792 rv
= zfs_iter_filesystems(zhp
, zfs_hold_one
, ha
);
4798 zfs_hold(zfs_handle_t
*zhp
, const char *snapname
, const char *tag
,
4799 boolean_t recursive
, int cleanup_fd
)
4804 ha
.nvl
= fnvlist_alloc();
4805 ha
.snapname
= snapname
;
4807 ha
.recursive
= recursive
;
4808 (void) zfs_hold_one(zfs_handle_dup(zhp
), &ha
);
4810 if (nvlist_empty(ha
.nvl
)) {
4813 fnvlist_free(ha
.nvl
);
4815 (void) snprintf(errbuf
, sizeof (errbuf
),
4816 dgettext(TEXT_DOMAIN
,
4817 "cannot hold snapshot '%s@%s'"),
4818 zhp
->zfs_name
, snapname
);
4819 (void) zfs_standard_error(zhp
->zfs_hdl
, ret
, errbuf
);
4823 ret
= zfs_hold_nvl(zhp
, cleanup_fd
, ha
.nvl
);
4824 fnvlist_free(ha
.nvl
);
4830 zfs_hold_nvl(zfs_handle_t
*zhp
, int cleanup_fd
, nvlist_t
*holds
)
4834 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4839 ret
= lzc_hold(holds
, cleanup_fd
, &errors
);
4842 /* There may be errors even in the success case. */
4843 fnvlist_free(errors
);
4847 if (nvlist_empty(errors
)) {
4848 /* no hold-specific errors */
4849 (void) snprintf(errbuf
, sizeof (errbuf
),
4850 dgettext(TEXT_DOMAIN
, "cannot hold"));
4853 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4854 "pool must be upgraded"));
4855 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4858 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4861 (void) zfs_standard_error(hdl
, ret
, errbuf
);
4865 for (elem
= nvlist_next_nvpair(errors
, NULL
);
4867 elem
= nvlist_next_nvpair(errors
, elem
)) {
4868 (void) snprintf(errbuf
, sizeof (errbuf
),
4869 dgettext(TEXT_DOMAIN
,
4870 "cannot hold snapshot '%s'"), nvpair_name(elem
));
4871 switch (fnvpair_value_int32(elem
)) {
4874 * Temporary tags wind up having the ds object id
4875 * prepended. So even if we passed the length check
4876 * above, it's still possible for the tag to wind
4877 * up being slightly too long.
4879 (void) zfs_error(hdl
, EZFS_TAGTOOLONG
, errbuf
);
4882 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4885 (void) zfs_error(hdl
, EZFS_REFTAG_HOLD
, errbuf
);
4888 (void) zfs_standard_error(hdl
,
4889 fnvpair_value_int32(elem
), errbuf
);
4893 fnvlist_free(errors
);
4898 zfs_release_one(zfs_handle_t
*zhp
, void *arg
)
4900 struct holdarg
*ha
= arg
;
4901 char name
[ZFS_MAX_DATASET_NAME_LEN
];
4903 nvlist_t
*existing_holds
;
4905 if (snprintf(name
, sizeof (name
), "%s@%s", zhp
->zfs_name
,
4906 ha
->snapname
) >= sizeof (name
)) {
4911 if (lzc_get_holds(name
, &existing_holds
) != 0) {
4913 } else if (!nvlist_exists(existing_holds
, ha
->tag
)) {
4916 nvlist_t
*torelease
= fnvlist_alloc();
4917 fnvlist_add_boolean(torelease
, ha
->tag
);
4918 fnvlist_add_nvlist(ha
->nvl
, name
, torelease
);
4919 fnvlist_free(torelease
);
4923 rv
= zfs_iter_filesystems(zhp
, zfs_release_one
, ha
);
4929 zfs_release(zfs_handle_t
*zhp
, const char *snapname
, const char *tag
,
4930 boolean_t recursive
)
4934 nvlist_t
*errors
= NULL
;
4936 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4939 ha
.nvl
= fnvlist_alloc();
4940 ha
.snapname
= snapname
;
4942 ha
.recursive
= recursive
;
4944 (void) zfs_release_one(zfs_handle_dup(zhp
), &ha
);
4946 if (nvlist_empty(ha
.nvl
)) {
4947 fnvlist_free(ha
.nvl
);
4949 (void) snprintf(errbuf
, sizeof (errbuf
),
4950 dgettext(TEXT_DOMAIN
,
4951 "cannot release hold from snapshot '%s@%s'"),
4952 zhp
->zfs_name
, snapname
);
4954 (void) zfs_error(hdl
, EZFS_REFTAG_RELE
, errbuf
);
4956 (void) zfs_standard_error(hdl
, ret
, errbuf
);
4961 ret
= lzc_release(ha
.nvl
, &errors
);
4962 fnvlist_free(ha
.nvl
);
4965 /* There may be errors even in the success case. */
4966 fnvlist_free(errors
);
4970 if (nvlist_empty(errors
)) {
4971 /* no hold-specific errors */
4972 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4976 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4977 "pool must be upgraded"));
4978 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4981 (void) zfs_standard_error_fmt(hdl
, errno
, errbuf
);
4985 for (elem
= nvlist_next_nvpair(errors
, NULL
);
4987 elem
= nvlist_next_nvpair(errors
, elem
)) {
4988 (void) snprintf(errbuf
, sizeof (errbuf
),
4989 dgettext(TEXT_DOMAIN
,
4990 "cannot release hold from snapshot '%s'"),
4992 switch (fnvpair_value_int32(elem
)) {
4994 (void) zfs_error(hdl
, EZFS_REFTAG_RELE
, errbuf
);
4997 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
5000 (void) zfs_standard_error_fmt(hdl
,
5001 fnvpair_value_int32(elem
), errbuf
);
5005 fnvlist_free(errors
);
5010 zfs_get_fsacl(zfs_handle_t
*zhp
, nvlist_t
**nvl
)
5012 zfs_cmd_t zc
= {"\0"};
5013 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
5019 assert(zhp
->zfs_type
== ZFS_TYPE_VOLUME
||
5020 zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
);
5024 nvbuf
= malloc(nvsz
);
5025 if (nvbuf
== NULL
) {
5026 err
= (zfs_error(hdl
, EZFS_NOMEM
, strerror(errno
)));
5030 zc
.zc_nvlist_dst_size
= nvsz
;
5031 zc
.zc_nvlist_dst
= (uintptr_t)nvbuf
;
5033 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
5035 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_GET_FSACL
, &zc
) != 0) {
5036 (void) snprintf(errbuf
, sizeof (errbuf
),
5037 dgettext(TEXT_DOMAIN
, "cannot get permissions on '%s'"),
5042 nvsz
= zc
.zc_nvlist_dst_size
;
5046 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
5047 "pool must be upgraded"));
5048 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
5051 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
5054 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
5057 err
= zfs_standard_error_fmt(hdl
, errno
, errbuf
);
5062 int rc
= nvlist_unpack(nvbuf
, zc
.zc_nvlist_dst_size
, nvl
, 0);
5064 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(
5065 TEXT_DOMAIN
, "cannot get permissions on '%s'"),
5067 err
= zfs_standard_error_fmt(hdl
, rc
, errbuf
);
5077 zfs_set_fsacl(zfs_handle_t
*zhp
, boolean_t un
, nvlist_t
*nvl
)
5079 zfs_cmd_t zc
= {"\0"};
5080 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
5086 assert(zhp
->zfs_type
== ZFS_TYPE_VOLUME
||
5087 zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
);
5089 err
= nvlist_size(nvl
, &nvsz
, NV_ENCODE_NATIVE
);
5092 nvbuf
= malloc(nvsz
);
5094 err
= nvlist_pack(nvl
, &nvbuf
, &nvsz
, NV_ENCODE_NATIVE
, 0);
5097 zc
.zc_nvlist_src_size
= nvsz
;
5098 zc
.zc_nvlist_src
= (uintptr_t)nvbuf
;
5099 zc
.zc_perm_action
= un
;
5101 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
5103 if (zfs_ioctl(hdl
, ZFS_IOC_SET_FSACL
, &zc
) != 0) {
5104 (void) snprintf(errbuf
, sizeof (errbuf
),
5105 dgettext(TEXT_DOMAIN
, "cannot set permissions on '%s'"),
5109 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
5110 "pool must be upgraded"));
5111 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
5114 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
5117 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
5120 err
= zfs_standard_error_fmt(hdl
, errno
, errbuf
);
5131 zfs_get_holds(zfs_handle_t
*zhp
, nvlist_t
**nvl
)
5136 err
= lzc_get_holds(zhp
->zfs_name
, nvl
);
5139 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
5141 (void) snprintf(errbuf
, sizeof (errbuf
),
5142 dgettext(TEXT_DOMAIN
, "cannot get holds for '%s'"),
5146 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
5147 "pool must be upgraded"));
5148 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
5151 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
5154 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
5157 err
= zfs_standard_error_fmt(hdl
, errno
, errbuf
);
5166 * Convert the zvol's volume size to an appropriate reservation.
5167 * Note: If this routine is updated, it is necessary to update the ZFS test
5168 * suite's shell version in reservation.kshlib.
5171 zvol_volsize_to_reservation(uint64_t volsize
, nvlist_t
*props
)
5174 uint64_t nblocks
, volblocksize
;
5178 if (nvlist_lookup_string(props
,
5179 zfs_prop_to_name(ZFS_PROP_COPIES
), &strval
) == 0)
5180 ncopies
= atoi(strval
);
5183 if (nvlist_lookup_uint64(props
,
5184 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
5185 &volblocksize
) != 0)
5186 volblocksize
= ZVOL_DEFAULT_BLOCKSIZE
;
5187 nblocks
= volsize
/volblocksize
;
5188 /* start with metadnode L0-L6 */
5190 /* calculate number of indirects */
5191 while (nblocks
> 1) {
5192 nblocks
+= DNODES_PER_LEVEL
- 1;
5193 nblocks
/= DNODES_PER_LEVEL
;
5196 numdb
*= MIN(SPA_DVAS_PER_BP
, ncopies
+ 1);
5199 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
5200 * compressed, but in practice they compress down to about
5203 numdb
*= 1ULL << DN_MAX_INDBLKSHIFT
;