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) 2013 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 2013 Nexenta Systems, Inc. All rights reserved.
44 #include <sys/mntent.h>
45 #include <sys/mount.h>
54 #include <directory.h>
55 #endif /* HAVE_IDMAP */
57 #include <sys/dnode.h>
62 #include "zfs_namecheck.h"
64 #include "libzfs_impl.h"
65 #include "zfs_deleg.h"
67 static int userquota_propname_decode(const char *propname
, boolean_t zoned
,
68 zfs_userquota_prop_t
*typep
, char *domain
, int domainlen
, uint64_t *ridp
);
71 * Given a single type (not a mask of types), return the type in a human
75 zfs_type_to_name(zfs_type_t type
)
78 case ZFS_TYPE_FILESYSTEM
:
79 return (dgettext(TEXT_DOMAIN
, "filesystem"));
80 case ZFS_TYPE_SNAPSHOT
:
81 return (dgettext(TEXT_DOMAIN
, "snapshot"));
83 return (dgettext(TEXT_DOMAIN
, "volume"));
92 * Validate a ZFS path. This is used even before trying to open the dataset, to
93 * provide a more meaningful error message. We call zfs_error_aux() to
94 * explain exactly why the name was not valid.
97 zfs_validate_name(libzfs_handle_t
*hdl
, const char *path
, int type
,
103 (void) zfs_prop_get_table();
104 if (dataset_namecheck(path
, &why
, &what
) != 0) {
107 case NAME_ERR_TOOLONG
:
108 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
109 "name is too long"));
112 case NAME_ERR_LEADING_SLASH
:
113 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
114 "leading slash in name"));
117 case NAME_ERR_EMPTY_COMPONENT
:
118 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
119 "empty component in name"));
122 case NAME_ERR_TRAILING_SLASH
:
123 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
124 "trailing slash in name"));
127 case NAME_ERR_INVALCHAR
:
129 dgettext(TEXT_DOMAIN
, "invalid character "
130 "'%c' in name"), what
);
133 case NAME_ERR_MULTIPLE_AT
:
134 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
135 "multiple '@' delimiters in name"));
138 case NAME_ERR_NOLETTER
:
139 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
140 "pool doesn't begin with a letter"));
143 case NAME_ERR_RESERVED
:
144 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
145 "name is reserved"));
148 case NAME_ERR_DISKLIKE
:
149 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
150 "reserved disk name"));
160 if (!(type
& ZFS_TYPE_SNAPSHOT
) && strchr(path
, '@') != NULL
) {
162 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
163 "snapshot delimiter '@' in filesystem name"));
167 if (type
== ZFS_TYPE_SNAPSHOT
&& strchr(path
, '@') == NULL
) {
169 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
170 "missing '@' delimiter in snapshot name"));
174 if (modifying
&& strchr(path
, '%') != NULL
) {
176 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
177 "invalid character %c in name"), '%');
185 zfs_name_valid(const char *name
, zfs_type_t type
)
187 if (type
== ZFS_TYPE_POOL
)
188 return (zpool_name_valid(NULL
, B_FALSE
, name
));
189 return (zfs_validate_name(NULL
, name
, type
, B_FALSE
));
193 * This function takes the raw DSL properties, and filters out the user-defined
194 * properties into a separate nvlist.
197 process_user_props(zfs_handle_t
*zhp
, nvlist_t
*props
)
199 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
204 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0) {
205 (void) no_memory(hdl
);
210 while ((elem
= nvlist_next_nvpair(props
, elem
)) != NULL
) {
211 if (!zfs_prop_user(nvpair_name(elem
)))
214 verify(nvpair_value_nvlist(elem
, &propval
) == 0);
215 if (nvlist_add_nvlist(nvl
, nvpair_name(elem
), propval
) != 0) {
217 (void) no_memory(hdl
);
225 static zpool_handle_t
*
226 zpool_add_handle(zfs_handle_t
*zhp
, const char *pool_name
)
228 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
231 if ((zph
= zpool_open_canfail(hdl
, pool_name
)) != NULL
) {
232 if (hdl
->libzfs_pool_handles
!= NULL
)
233 zph
->zpool_next
= hdl
->libzfs_pool_handles
;
234 hdl
->libzfs_pool_handles
= zph
;
239 static zpool_handle_t
*
240 zpool_find_handle(zfs_handle_t
*zhp
, const char *pool_name
, int len
)
242 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
243 zpool_handle_t
*zph
= hdl
->libzfs_pool_handles
;
245 while ((zph
!= NULL
) &&
246 (strncmp(pool_name
, zpool_get_name(zph
), len
) != 0))
247 zph
= zph
->zpool_next
;
252 * Returns a handle to the pool that contains the provided dataset.
253 * If a handle to that pool already exists then that handle is returned.
254 * Otherwise, a new handle is created and added to the list of handles.
256 static zpool_handle_t
*
257 zpool_handle(zfs_handle_t
*zhp
)
263 len
= strcspn(zhp
->zfs_name
, "/@#") + 1;
264 pool_name
= zfs_alloc(zhp
->zfs_hdl
, len
);
265 (void) strlcpy(pool_name
, zhp
->zfs_name
, len
);
267 zph
= zpool_find_handle(zhp
, pool_name
, len
);
269 zph
= zpool_add_handle(zhp
, pool_name
);
276 zpool_free_handles(libzfs_handle_t
*hdl
)
278 zpool_handle_t
*next
, *zph
= hdl
->libzfs_pool_handles
;
280 while (zph
!= NULL
) {
281 next
= zph
->zpool_next
;
285 hdl
->libzfs_pool_handles
= NULL
;
289 * Utility function to gather stats (objset and zpl) for the given object.
292 get_stats_ioctl(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
294 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
296 (void) strlcpy(zc
->zc_name
, zhp
->zfs_name
, sizeof (zc
->zc_name
));
298 while (ioctl(hdl
->libzfs_fd
, ZFS_IOC_OBJSET_STATS
, zc
) != 0) {
299 if (errno
== ENOMEM
) {
300 if (zcmd_expand_dst_nvlist(hdl
, zc
) != 0) {
311 * Utility function to get the received properties of the given object.
314 get_recvd_props_ioctl(zfs_handle_t
*zhp
)
316 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
317 nvlist_t
*recvdprops
;
318 zfs_cmd_t zc
= {"\0"};
321 if (zcmd_alloc_dst_nvlist(hdl
, &zc
, 0) != 0)
324 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
326 while (ioctl(hdl
->libzfs_fd
, ZFS_IOC_OBJSET_RECVD_PROPS
, &zc
) != 0) {
327 if (errno
== ENOMEM
) {
328 if (zcmd_expand_dst_nvlist(hdl
, &zc
) != 0) {
332 zcmd_free_nvlists(&zc
);
337 err
= zcmd_read_dst_nvlist(zhp
->zfs_hdl
, &zc
, &recvdprops
);
338 zcmd_free_nvlists(&zc
);
342 nvlist_free(zhp
->zfs_recvd_props
);
343 zhp
->zfs_recvd_props
= recvdprops
;
349 put_stats_zhdl(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
351 nvlist_t
*allprops
, *userprops
;
353 zhp
->zfs_dmustats
= zc
->zc_objset_stats
; /* structure assignment */
355 if (zcmd_read_dst_nvlist(zhp
->zfs_hdl
, zc
, &allprops
) != 0) {
360 * XXX Why do we store the user props separately, in addition to
361 * storing them in zfs_props?
363 if ((userprops
= process_user_props(zhp
, allprops
)) == NULL
) {
364 nvlist_free(allprops
);
368 nvlist_free(zhp
->zfs_props
);
369 nvlist_free(zhp
->zfs_user_props
);
371 zhp
->zfs_props
= allprops
;
372 zhp
->zfs_user_props
= userprops
;
378 get_stats(zfs_handle_t
*zhp
)
381 zfs_cmd_t zc
= {"\0"};
383 if (zcmd_alloc_dst_nvlist(zhp
->zfs_hdl
, &zc
, 0) != 0)
385 if (get_stats_ioctl(zhp
, &zc
) != 0)
387 else if (put_stats_zhdl(zhp
, &zc
) != 0)
389 zcmd_free_nvlists(&zc
);
394 * Refresh the properties currently stored in the handle.
397 zfs_refresh_properties(zfs_handle_t
*zhp
)
399 (void) get_stats(zhp
);
403 * Makes a handle from the given dataset name. Used by zfs_open() and
404 * zfs_iter_* to create child handles on the fly.
407 make_dataset_handle_common(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
409 if (put_stats_zhdl(zhp
, zc
) != 0)
413 * We've managed to open the dataset and gather statistics. Determine
414 * the high-level type.
416 if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZVOL
)
417 zhp
->zfs_head_type
= ZFS_TYPE_VOLUME
;
418 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZFS
)
419 zhp
->zfs_head_type
= ZFS_TYPE_FILESYSTEM
;
420 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_OTHER
)
425 if (zhp
->zfs_dmustats
.dds_is_snapshot
)
426 zhp
->zfs_type
= ZFS_TYPE_SNAPSHOT
;
427 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZVOL
)
428 zhp
->zfs_type
= ZFS_TYPE_VOLUME
;
429 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZFS
)
430 zhp
->zfs_type
= ZFS_TYPE_FILESYSTEM
;
432 abort(); /* we should never see any other types */
434 if ((zhp
->zpool_hdl
= zpool_handle(zhp
)) == NULL
)
441 make_dataset_handle(libzfs_handle_t
*hdl
, const char *path
)
443 zfs_cmd_t zc
= {"\0"};
445 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
451 (void) strlcpy(zhp
->zfs_name
, path
, sizeof (zhp
->zfs_name
));
452 if (zcmd_alloc_dst_nvlist(hdl
, &zc
, 0) != 0) {
456 if (get_stats_ioctl(zhp
, &zc
) == -1) {
457 zcmd_free_nvlists(&zc
);
461 if (make_dataset_handle_common(zhp
, &zc
) == -1) {
465 zcmd_free_nvlists(&zc
);
470 make_dataset_handle_zc(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
)
472 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
478 (void) strlcpy(zhp
->zfs_name
, zc
->zc_name
, sizeof (zhp
->zfs_name
));
479 if (make_dataset_handle_common(zhp
, zc
) == -1) {
487 make_dataset_simple_handle_zc(zfs_handle_t
*pzhp
, zfs_cmd_t
*zc
)
489 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
494 zhp
->zfs_hdl
= pzhp
->zfs_hdl
;
495 (void) strlcpy(zhp
->zfs_name
, zc
->zc_name
, sizeof (zhp
->zfs_name
));
496 zhp
->zfs_head_type
= pzhp
->zfs_type
;
497 zhp
->zfs_type
= ZFS_TYPE_SNAPSHOT
;
498 zhp
->zpool_hdl
= zpool_handle(zhp
);
504 zfs_handle_dup(zfs_handle_t
*zhp_orig
)
506 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
511 zhp
->zfs_hdl
= zhp_orig
->zfs_hdl
;
512 zhp
->zpool_hdl
= zhp_orig
->zpool_hdl
;
513 (void) strlcpy(zhp
->zfs_name
, zhp_orig
->zfs_name
,
514 sizeof (zhp
->zfs_name
));
515 zhp
->zfs_type
= zhp_orig
->zfs_type
;
516 zhp
->zfs_head_type
= zhp_orig
->zfs_head_type
;
517 zhp
->zfs_dmustats
= zhp_orig
->zfs_dmustats
;
518 if (zhp_orig
->zfs_props
!= NULL
) {
519 if (nvlist_dup(zhp_orig
->zfs_props
, &zhp
->zfs_props
, 0) != 0) {
520 (void) no_memory(zhp
->zfs_hdl
);
525 if (zhp_orig
->zfs_user_props
!= NULL
) {
526 if (nvlist_dup(zhp_orig
->zfs_user_props
,
527 &zhp
->zfs_user_props
, 0) != 0) {
528 (void) no_memory(zhp
->zfs_hdl
);
533 if (zhp_orig
->zfs_recvd_props
!= NULL
) {
534 if (nvlist_dup(zhp_orig
->zfs_recvd_props
,
535 &zhp
->zfs_recvd_props
, 0)) {
536 (void) no_memory(zhp
->zfs_hdl
);
541 zhp
->zfs_mntcheck
= zhp_orig
->zfs_mntcheck
;
542 if (zhp_orig
->zfs_mntopts
!= NULL
) {
543 zhp
->zfs_mntopts
= zfs_strdup(zhp_orig
->zfs_hdl
,
544 zhp_orig
->zfs_mntopts
);
546 zhp
->zfs_props_table
= zhp_orig
->zfs_props_table
;
551 zfs_bookmark_exists(const char *path
)
555 char fsname
[ZFS_MAXNAMELEN
];
562 (void) strlcpy(fsname
, path
, sizeof (fsname
));
563 pound
= strchr(fsname
, '#');
568 bmark_name
= pound
+ 1;
569 props
= fnvlist_alloc();
570 err
= lzc_get_bookmarks(fsname
, props
, &bmarks
);
577 rv
= nvlist_exists(bmarks
, bmark_name
);
583 make_bookmark_handle(zfs_handle_t
*parent
, const char *path
,
584 nvlist_t
*bmark_props
)
586 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
591 /* Fill in the name. */
592 zhp
->zfs_hdl
= parent
->zfs_hdl
;
593 (void) strlcpy(zhp
->zfs_name
, path
, sizeof (zhp
->zfs_name
));
595 /* Set the property lists. */
596 if (nvlist_dup(bmark_props
, &zhp
->zfs_props
, 0) != 0) {
602 zhp
->zfs_head_type
= parent
->zfs_head_type
;
603 zhp
->zfs_type
= ZFS_TYPE_BOOKMARK
;
605 if ((zhp
->zpool_hdl
= zpool_handle(zhp
)) == NULL
) {
606 nvlist_free(zhp
->zfs_props
);
615 * Opens the given snapshot, filesystem, or volume. The 'types'
616 * argument is a mask of acceptable types. The function will print an
617 * appropriate error message and return NULL if it can't be opened.
620 zfs_open(libzfs_handle_t
*hdl
, const char *path
, int types
)
625 (void) snprintf(errbuf
, sizeof (errbuf
),
626 dgettext(TEXT_DOMAIN
, "cannot open '%s'"), path
);
629 * Validate the name before we even try to open it.
631 if (!zfs_validate_name(hdl
, path
, ZFS_TYPE_DATASET
, B_FALSE
)) {
632 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
633 "invalid dataset name"));
634 (void) zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
639 * Try to get stats for the dataset, which will tell us if it exists.
642 if ((zhp
= make_dataset_handle(hdl
, path
)) == NULL
) {
643 (void) zfs_standard_error(hdl
, errno
, errbuf
);
647 if (!(types
& zhp
->zfs_type
)) {
648 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
657 * Release a ZFS handle. Nothing to do but free the associated memory.
660 zfs_close(zfs_handle_t
*zhp
)
662 if (zhp
->zfs_mntopts
)
663 free(zhp
->zfs_mntopts
);
664 nvlist_free(zhp
->zfs_props
);
665 nvlist_free(zhp
->zfs_user_props
);
666 nvlist_free(zhp
->zfs_recvd_props
);
670 typedef struct mnttab_node
{
671 struct mnttab mtn_mt
;
676 libzfs_mnttab_cache_compare(const void *arg1
, const void *arg2
)
678 const mnttab_node_t
*mtn1
= arg1
;
679 const mnttab_node_t
*mtn2
= arg2
;
682 rv
= strcmp(mtn1
->mtn_mt
.mnt_special
, mtn2
->mtn_mt
.mnt_special
);
686 return (rv
> 0 ? 1 : -1);
690 libzfs_mnttab_init(libzfs_handle_t
*hdl
)
692 assert(avl_numnodes(&hdl
->libzfs_mnttab_cache
) == 0);
693 avl_create(&hdl
->libzfs_mnttab_cache
, libzfs_mnttab_cache_compare
,
694 sizeof (mnttab_node_t
), offsetof(mnttab_node_t
, mtn_node
));
698 libzfs_mnttab_update(libzfs_handle_t
*hdl
)
702 /* Reopen MNTTAB to prevent reading stale data from open file */
703 if (freopen(MNTTAB
, "r", hdl
->libzfs_mnttab
) == NULL
)
706 while (getmntent(hdl
->libzfs_mnttab
, &entry
) == 0) {
710 if (strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0)
713 mtn
= zfs_alloc(hdl
, sizeof (mnttab_node_t
));
714 mtn
->mtn_mt
.mnt_special
= zfs_strdup(hdl
, entry
.mnt_special
);
715 mtn
->mtn_mt
.mnt_mountp
= zfs_strdup(hdl
, entry
.mnt_mountp
);
716 mtn
->mtn_mt
.mnt_fstype
= zfs_strdup(hdl
, entry
.mnt_fstype
);
717 mtn
->mtn_mt
.mnt_mntopts
= zfs_strdup(hdl
, entry
.mnt_mntopts
);
719 /* Exclude duplicate mounts */
720 if (avl_find(&hdl
->libzfs_mnttab_cache
, mtn
, &where
) != NULL
) {
721 free(mtn
->mtn_mt
.mnt_special
);
722 free(mtn
->mtn_mt
.mnt_mountp
);
723 free(mtn
->mtn_mt
.mnt_fstype
);
724 free(mtn
->mtn_mt
.mnt_mntopts
);
729 avl_add(&hdl
->libzfs_mnttab_cache
, mtn
);
736 libzfs_mnttab_fini(libzfs_handle_t
*hdl
)
741 while ((mtn
= avl_destroy_nodes(&hdl
->libzfs_mnttab_cache
, &cookie
))) {
742 free(mtn
->mtn_mt
.mnt_special
);
743 free(mtn
->mtn_mt
.mnt_mountp
);
744 free(mtn
->mtn_mt
.mnt_fstype
);
745 free(mtn
->mtn_mt
.mnt_mntopts
);
748 avl_destroy(&hdl
->libzfs_mnttab_cache
);
752 libzfs_mnttab_cache(libzfs_handle_t
*hdl
, boolean_t enable
)
754 hdl
->libzfs_mnttab_enable
= enable
;
758 libzfs_mnttab_find(libzfs_handle_t
*hdl
, const char *fsname
,
759 struct mnttab
*entry
)
765 if (!hdl
->libzfs_mnttab_enable
) {
766 struct mnttab srch
= { 0 };
768 if (avl_numnodes(&hdl
->libzfs_mnttab_cache
))
769 libzfs_mnttab_fini(hdl
);
771 /* Reopen MNTTAB to prevent reading stale data from open file */
772 if (freopen(MNTTAB
, "r", hdl
->libzfs_mnttab
) == NULL
)
775 srch
.mnt_special
= (char *)fsname
;
776 srch
.mnt_fstype
= MNTTYPE_ZFS
;
777 if (getmntany(hdl
->libzfs_mnttab
, entry
, &srch
) == 0)
783 if (avl_numnodes(&hdl
->libzfs_mnttab_cache
) == 0)
784 if ((error
= libzfs_mnttab_update(hdl
)) != 0)
787 find
.mtn_mt
.mnt_special
= (char *)fsname
;
788 mtn
= avl_find(&hdl
->libzfs_mnttab_cache
, &find
, NULL
);
790 *entry
= mtn
->mtn_mt
;
797 libzfs_mnttab_add(libzfs_handle_t
*hdl
, const char *special
,
798 const char *mountp
, const char *mntopts
)
802 if (avl_numnodes(&hdl
->libzfs_mnttab_cache
) == 0)
804 mtn
= zfs_alloc(hdl
, sizeof (mnttab_node_t
));
805 mtn
->mtn_mt
.mnt_special
= zfs_strdup(hdl
, special
);
806 mtn
->mtn_mt
.mnt_mountp
= zfs_strdup(hdl
, mountp
);
807 mtn
->mtn_mt
.mnt_fstype
= zfs_strdup(hdl
, MNTTYPE_ZFS
);
808 mtn
->mtn_mt
.mnt_mntopts
= zfs_strdup(hdl
, mntopts
);
809 avl_add(&hdl
->libzfs_mnttab_cache
, mtn
);
813 libzfs_mnttab_remove(libzfs_handle_t
*hdl
, const char *fsname
)
818 find
.mtn_mt
.mnt_special
= (char *)fsname
;
819 if ((ret
= avl_find(&hdl
->libzfs_mnttab_cache
, (void *)&find
, NULL
))) {
820 avl_remove(&hdl
->libzfs_mnttab_cache
, ret
);
821 free(ret
->mtn_mt
.mnt_special
);
822 free(ret
->mtn_mt
.mnt_mountp
);
823 free(ret
->mtn_mt
.mnt_fstype
);
824 free(ret
->mtn_mt
.mnt_mntopts
);
830 zfs_spa_version(zfs_handle_t
*zhp
, int *spa_version
)
832 zpool_handle_t
*zpool_handle
= zhp
->zpool_hdl
;
834 if (zpool_handle
== NULL
)
837 *spa_version
= zpool_get_prop_int(zpool_handle
,
838 ZPOOL_PROP_VERSION
, NULL
);
843 * The choice of reservation property depends on the SPA version.
846 zfs_which_resv_prop(zfs_handle_t
*zhp
, zfs_prop_t
*resv_prop
)
850 if (zfs_spa_version(zhp
, &spa_version
) < 0)
853 if (spa_version
>= SPA_VERSION_REFRESERVATION
)
854 *resv_prop
= ZFS_PROP_REFRESERVATION
;
856 *resv_prop
= ZFS_PROP_RESERVATION
;
862 * Given an nvlist of properties to set, validates that they are correct, and
863 * parses any numeric properties (index, boolean, etc) if they are specified as
867 zfs_valid_proplist(libzfs_handle_t
*hdl
, zfs_type_t type
, nvlist_t
*nvl
,
868 uint64_t zoned
, zfs_handle_t
*zhp
, const char *errbuf
)
875 int chosen_normal
= -1;
878 if (nvlist_alloc(&ret
, NV_UNIQUE_NAME
, 0) != 0) {
879 (void) no_memory(hdl
);
884 * Make sure this property is valid and applies to this type.
888 while ((elem
= nvlist_next_nvpair(nvl
, elem
)) != NULL
) {
889 const char *propname
= nvpair_name(elem
);
891 prop
= zfs_name_to_prop(propname
);
892 if (prop
== ZPROP_INVAL
&& zfs_prop_user(propname
)) {
894 * This is a user property: make sure it's a
895 * string, and that it's less than ZAP_MAXNAMELEN.
897 if (nvpair_type(elem
) != DATA_TYPE_STRING
) {
898 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
899 "'%s' must be a string"), propname
);
900 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
904 if (strlen(nvpair_name(elem
)) >= ZAP_MAXNAMELEN
) {
905 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
906 "property name '%s' is too long"),
908 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
912 (void) nvpair_value_string(elem
, &strval
);
913 if (nvlist_add_string(ret
, propname
, strval
) != 0) {
914 (void) no_memory(hdl
);
921 * Currently, only user properties can be modified on
924 if (type
== ZFS_TYPE_SNAPSHOT
) {
925 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
926 "this property can not be modified for snapshots"));
927 (void) zfs_error(hdl
, EZFS_PROPTYPE
, errbuf
);
931 if (prop
== ZPROP_INVAL
&& zfs_prop_userquota(propname
)) {
932 zfs_userquota_prop_t uqtype
;
933 char newpropname
[128];
938 if (userquota_propname_decode(propname
, zoned
,
939 &uqtype
, domain
, sizeof (domain
), &rid
) != 0) {
941 dgettext(TEXT_DOMAIN
,
942 "'%s' has an invalid user/group name"),
944 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
948 if (uqtype
!= ZFS_PROP_USERQUOTA
&&
949 uqtype
!= ZFS_PROP_GROUPQUOTA
) {
951 dgettext(TEXT_DOMAIN
, "'%s' is readonly"),
953 (void) zfs_error(hdl
, EZFS_PROPREADONLY
,
958 if (nvpair_type(elem
) == DATA_TYPE_STRING
) {
959 (void) nvpair_value_string(elem
, &strval
);
960 if (strcmp(strval
, "none") == 0) {
962 } else if (zfs_nicestrtonum(hdl
,
963 strval
, &intval
) != 0) {
964 (void) zfs_error(hdl
,
965 EZFS_BADPROP
, errbuf
);
968 } else if (nvpair_type(elem
) ==
970 (void) nvpair_value_uint64(elem
, &intval
);
972 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
973 "use 'none' to disable "
974 "userquota/groupquota"));
978 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
979 "'%s' must be a number"), propname
);
980 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
985 * Encode the prop name as
986 * userquota@<hex-rid>-domain, to make it easy
987 * for the kernel to decode.
989 (void) snprintf(newpropname
, sizeof (newpropname
),
990 "%s%llx-%s", zfs_userquota_prop_prefixes
[uqtype
],
991 (longlong_t
)rid
, domain
);
995 if (nvlist_add_uint64_array(ret
, newpropname
,
997 (void) no_memory(hdl
);
1001 } else if (prop
== ZPROP_INVAL
&& zfs_prop_written(propname
)) {
1002 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1003 "'%s' is readonly"),
1005 (void) zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
);
1009 if (prop
== ZPROP_INVAL
) {
1010 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1011 "invalid property '%s'"), propname
);
1012 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1016 if (!zfs_prop_valid_for_type(prop
, type
, B_FALSE
)) {
1018 dgettext(TEXT_DOMAIN
, "'%s' does not "
1019 "apply to datasets of this type"), propname
);
1020 (void) zfs_error(hdl
, EZFS_PROPTYPE
, errbuf
);
1024 if (zfs_prop_readonly(prop
) &&
1025 (!zfs_prop_setonce(prop
) || zhp
!= NULL
)) {
1027 dgettext(TEXT_DOMAIN
, "'%s' is readonly"),
1029 (void) zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
);
1033 if (zprop_parse_value(hdl
, elem
, prop
, type
, ret
,
1034 &strval
, &intval
, errbuf
) != 0)
1038 * Perform some additional checks for specific properties.
1041 case ZFS_PROP_VERSION
:
1047 version
= zfs_prop_get_int(zhp
, ZFS_PROP_VERSION
);
1048 if (intval
< version
) {
1049 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1050 "Can not downgrade; already at version %u"),
1052 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1058 case ZFS_PROP_VOLBLOCKSIZE
:
1059 case ZFS_PROP_RECORDSIZE
:
1061 int maxbs
= SPA_MAXBLOCKSIZE
;
1063 maxbs
= zpool_get_prop_int(zhp
->zpool_hdl
,
1064 ZPOOL_PROP_MAXBLOCKSIZE
, NULL
);
1067 * The value must be a power of two between
1068 * SPA_MINBLOCKSIZE and maxbs.
1070 if (intval
< SPA_MINBLOCKSIZE
||
1071 intval
> maxbs
|| !ISP2(intval
)) {
1072 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1073 "'%s' must be power of 2 from 512B "
1074 "to %uKB"), propname
, maxbs
>> 10);
1075 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1080 case ZFS_PROP_MLSLABEL
:
1082 #ifdef HAVE_MLSLABEL
1084 * Verify the mlslabel string and convert to
1085 * internal hex label string.
1089 char *hex
= NULL
; /* internal label string */
1091 /* Default value is already OK. */
1092 if (strcasecmp(strval
, ZFS_MLSLABEL_DEFAULT
) == 0)
1095 /* Verify the label can be converted to binary form */
1096 if (((new_sl
= m_label_alloc(MAC_LABEL
)) == NULL
) ||
1097 (str_to_label(strval
, &new_sl
, MAC_LABEL
,
1098 L_NO_CORRECTION
, NULL
) == -1)) {
1102 /* Now translate to hex internal label string */
1103 if (label_to_str(new_sl
, &hex
, M_INTERNAL
,
1109 m_label_free(new_sl
);
1111 /* If string is already in internal form, we're done. */
1112 if (strcmp(strval
, hex
) == 0) {
1117 /* Replace the label string with the internal form. */
1118 (void) nvlist_remove(ret
, zfs_prop_to_name(prop
),
1120 verify(nvlist_add_string(ret
, zfs_prop_to_name(prop
),
1127 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1128 "invalid mlslabel '%s'"), strval
);
1129 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1130 m_label_free(new_sl
); /* OK if null */
1133 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1134 "mlslabels are unsupported"));
1135 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1137 #endif /* HAVE_MLSLABEL */
1140 case ZFS_PROP_MOUNTPOINT
:
1142 namecheck_err_t why
;
1144 if (strcmp(strval
, ZFS_MOUNTPOINT_NONE
) == 0 ||
1145 strcmp(strval
, ZFS_MOUNTPOINT_LEGACY
) == 0)
1148 if (mountpoint_namecheck(strval
, &why
)) {
1150 case NAME_ERR_LEADING_SLASH
:
1152 dgettext(TEXT_DOMAIN
,
1153 "'%s' must be an absolute path, "
1154 "'none', or 'legacy'"), propname
);
1156 case NAME_ERR_TOOLONG
:
1158 dgettext(TEXT_DOMAIN
,
1159 "component of '%s' is too long"),
1165 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1172 case ZFS_PROP_SHARESMB
:
1173 case ZFS_PROP_SHARENFS
:
1175 * For the mountpoint and sharenfs or sharesmb
1176 * properties, check if it can be set in a
1177 * global/non-global zone based on
1178 * the zoned property value:
1180 * global zone non-global zone
1181 * --------------------------------------------------
1182 * zoned=on mountpoint (no) mountpoint (yes)
1183 * sharenfs (no) sharenfs (no)
1184 * sharesmb (no) sharesmb (no)
1186 * zoned=off mountpoint (yes) N/A
1191 if (getzoneid() == GLOBAL_ZONEID
) {
1192 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1193 "'%s' cannot be set on "
1194 "dataset in a non-global zone"),
1196 (void) zfs_error(hdl
, EZFS_ZONED
,
1199 } else if (prop
== ZFS_PROP_SHARENFS
||
1200 prop
== ZFS_PROP_SHARESMB
) {
1201 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1202 "'%s' cannot be set in "
1203 "a non-global zone"), propname
);
1204 (void) zfs_error(hdl
, EZFS_ZONED
,
1208 } else if (getzoneid() != GLOBAL_ZONEID
) {
1210 * If zoned property is 'off', this must be in
1211 * a global zone. If not, something is wrong.
1213 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1214 "'%s' cannot be set while dataset "
1215 "'zoned' property is set"), propname
);
1216 (void) zfs_error(hdl
, EZFS_ZONED
, errbuf
);
1221 * At this point, it is legitimate to set the
1222 * property. Now we want to make sure that the
1223 * property value is valid if it is sharenfs.
1225 if ((prop
== ZFS_PROP_SHARENFS
||
1226 prop
== ZFS_PROP_SHARESMB
) &&
1227 strcmp(strval
, "on") != 0 &&
1228 strcmp(strval
, "off") != 0) {
1229 zfs_share_proto_t proto
;
1231 if (prop
== ZFS_PROP_SHARESMB
)
1237 * Must be an valid sharing protocol
1238 * option string so init the libshare
1239 * in order to enable the parser and
1240 * then parse the options. We use the
1241 * control API since we don't care about
1242 * the current configuration and don't
1243 * want the overhead of loading it
1244 * until we actually do something.
1247 if (zfs_init_libshare(hdl
,
1248 SA_INIT_CONTROL_API
) != SA_OK
) {
1250 * An error occurred so we can't do
1253 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1254 "'%s' cannot be set: problem "
1255 "in share initialization"),
1257 (void) zfs_error(hdl
, EZFS_BADPROP
,
1262 if (zfs_parse_options(strval
, proto
) != SA_OK
) {
1264 * There was an error in parsing so
1265 * deal with it by issuing an error
1266 * message and leaving after
1267 * uninitializing the the libshare
1270 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1271 "'%s' cannot be set to invalid "
1272 "options"), propname
);
1273 (void) zfs_error(hdl
, EZFS_BADPROP
,
1275 zfs_uninit_libshare(hdl
);
1278 zfs_uninit_libshare(hdl
);
1282 case ZFS_PROP_UTF8ONLY
:
1283 chosen_utf
= (int)intval
;
1285 case ZFS_PROP_NORMALIZE
:
1286 chosen_normal
= (int)intval
;
1293 * For changes to existing volumes, we have some additional
1294 * checks to enforce.
1296 if (type
== ZFS_TYPE_VOLUME
&& zhp
!= NULL
) {
1297 uint64_t volsize
= zfs_prop_get_int(zhp
,
1299 uint64_t blocksize
= zfs_prop_get_int(zhp
,
1300 ZFS_PROP_VOLBLOCKSIZE
);
1304 case ZFS_PROP_RESERVATION
:
1305 case ZFS_PROP_REFRESERVATION
:
1306 if (intval
> volsize
) {
1307 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1308 "'%s' is greater than current "
1309 "volume size"), propname
);
1310 (void) zfs_error(hdl
, EZFS_BADPROP
,
1316 case ZFS_PROP_VOLSIZE
:
1317 if (intval
% blocksize
!= 0) {
1318 zfs_nicenum(blocksize
, buf
,
1320 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1321 "'%s' must be a multiple of "
1322 "volume block size (%s)"),
1324 (void) zfs_error(hdl
, EZFS_BADPROP
,
1330 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1331 "'%s' cannot be zero"),
1333 (void) zfs_error(hdl
, EZFS_BADPROP
,
1345 * If normalization was chosen, but no UTF8 choice was made,
1346 * enforce rejection of non-UTF8 names.
1348 * If normalization was chosen, but rejecting non-UTF8 names
1349 * was explicitly not chosen, it is an error.
1351 if (chosen_normal
> 0 && chosen_utf
< 0) {
1352 if (nvlist_add_uint64(ret
,
1353 zfs_prop_to_name(ZFS_PROP_UTF8ONLY
), 1) != 0) {
1354 (void) no_memory(hdl
);
1357 } else if (chosen_normal
> 0 && chosen_utf
== 0) {
1358 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1359 "'%s' must be set 'on' if normalization chosen"),
1360 zfs_prop_to_name(ZFS_PROP_UTF8ONLY
));
1361 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1372 zfs_add_synthetic_resv(zfs_handle_t
*zhp
, nvlist_t
*nvl
)
1374 uint64_t old_volsize
;
1375 uint64_t new_volsize
;
1376 uint64_t old_reservation
;
1377 uint64_t new_reservation
;
1378 zfs_prop_t resv_prop
;
1381 * If this is an existing volume, and someone is setting the volsize,
1382 * make sure that it matches the reservation, or add it if necessary.
1384 old_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
1385 if (zfs_which_resv_prop(zhp
, &resv_prop
) < 0)
1387 old_reservation
= zfs_prop_get_int(zhp
, resv_prop
);
1388 if ((zvol_volsize_to_reservation(old_volsize
, zhp
->zfs_props
) !=
1389 old_reservation
) || nvlist_lookup_uint64(nvl
,
1390 zfs_prop_to_name(resv_prop
), &new_reservation
) != ENOENT
) {
1393 if (nvlist_lookup_uint64(nvl
, zfs_prop_to_name(ZFS_PROP_VOLSIZE
),
1396 new_reservation
= zvol_volsize_to_reservation(new_volsize
,
1398 if (nvlist_add_uint64(nvl
, zfs_prop_to_name(resv_prop
),
1399 new_reservation
) != 0) {
1400 (void) no_memory(zhp
->zfs_hdl
);
1407 zfs_setprop_error(libzfs_handle_t
*hdl
, zfs_prop_t prop
, int err
,
1414 * For quotas and reservations, ENOSPC indicates
1415 * something different; setting a quota or reservation
1416 * doesn't use any disk space.
1419 case ZFS_PROP_QUOTA
:
1420 case ZFS_PROP_REFQUOTA
:
1421 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1422 "size is less than current used or "
1424 (void) zfs_error(hdl
, EZFS_PROPSPACE
, errbuf
);
1427 case ZFS_PROP_RESERVATION
:
1428 case ZFS_PROP_REFRESERVATION
:
1429 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1430 "size is greater than available space"));
1431 (void) zfs_error(hdl
, EZFS_PROPSPACE
, errbuf
);
1435 (void) zfs_standard_error(hdl
, err
, errbuf
);
1441 (void) zfs_standard_error(hdl
, EBUSY
, errbuf
);
1445 (void) zfs_error(hdl
, EZFS_DSREADONLY
, errbuf
);
1449 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1450 "property value too long"));
1451 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1455 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1456 "pool and or dataset must be upgraded to set this "
1457 "property or value"));
1458 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
1462 if (prop
== ZFS_PROP_COMPRESSION
||
1463 prop
== ZFS_PROP_RECORDSIZE
) {
1464 (void) zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1465 "property setting is not allowed on "
1466 "bootable datasets"));
1467 (void) zfs_error(hdl
, EZFS_NOTSUP
, errbuf
);
1469 (void) zfs_standard_error(hdl
, err
, errbuf
);
1474 if (prop
== ZPROP_INVAL
) {
1475 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1477 (void) zfs_standard_error(hdl
, err
, errbuf
);
1483 * This platform can't address a volume this big.
1486 if (prop
== ZFS_PROP_VOLSIZE
) {
1487 (void) zfs_error(hdl
, EZFS_VOLTOOBIG
, errbuf
);
1493 (void) zfs_standard_error(hdl
, err
, errbuf
);
1498 zfs_is_namespace_prop(zfs_prop_t prop
)
1502 case ZFS_PROP_ATIME
:
1503 case ZFS_PROP_RELATIME
:
1504 case ZFS_PROP_DEVICES
:
1506 case ZFS_PROP_SETUID
:
1507 case ZFS_PROP_READONLY
:
1508 case ZFS_PROP_XATTR
:
1509 case ZFS_PROP_NBMAND
:
1518 * Given a property name and value, set the property for the given dataset.
1521 zfs_prop_set(zfs_handle_t
*zhp
, const char *propname
, const char *propval
)
1523 zfs_cmd_t zc
= {"\0"};
1525 prop_changelist_t
*cl
= NULL
;
1527 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1528 nvlist_t
*nvl
= NULL
, *realprops
;
1530 boolean_t do_prefix
= B_TRUE
;
1533 (void) snprintf(errbuf
, sizeof (errbuf
),
1534 dgettext(TEXT_DOMAIN
, "cannot set property for '%s'"),
1537 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0 ||
1538 nvlist_add_string(nvl
, propname
, propval
) != 0) {
1539 (void) no_memory(hdl
);
1543 if ((realprops
= zfs_valid_proplist(hdl
, zhp
->zfs_type
, nvl
,
1544 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
), zhp
, errbuf
)) == NULL
)
1550 prop
= zfs_name_to_prop(propname
);
1552 if (prop
== ZFS_PROP_VOLSIZE
) {
1553 if ((added_resv
= zfs_add_synthetic_resv(zhp
, nvl
)) == -1)
1557 if ((cl
= changelist_gather(zhp
, prop
, 0, 0)) == NULL
)
1560 if (prop
== ZFS_PROP_MOUNTPOINT
&& changelist_haszonedchild(cl
)) {
1561 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1562 "child dataset with inherited mountpoint is used "
1563 "in a non-global zone"));
1564 ret
= zfs_error(hdl
, EZFS_ZONED
, errbuf
);
1569 * We don't want to unmount & remount the dataset when changing
1570 * its canmount property to 'on' or 'noauto'. We only use
1571 * the changelist logic to unmount when setting canmount=off.
1573 if (prop
== ZFS_PROP_CANMOUNT
) {
1575 int err
= zprop_string_to_index(prop
, propval
, &idx
,
1577 if (err
== 0 && idx
!= ZFS_CANMOUNT_OFF
)
1578 do_prefix
= B_FALSE
;
1581 if (do_prefix
&& (ret
= changelist_prefix(cl
)) != 0)
1585 * Execute the corresponding ioctl() to set this property.
1587 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1589 if (zcmd_write_src_nvlist(hdl
, &zc
, nvl
) != 0)
1592 ret
= zfs_ioctl(hdl
, ZFS_IOC_SET_PROP
, &zc
);
1595 zfs_setprop_error(hdl
, prop
, errno
, errbuf
);
1596 if (added_resv
&& errno
== ENOSPC
) {
1597 /* clean up the volsize property we tried to set */
1598 uint64_t old_volsize
= zfs_prop_get_int(zhp
,
1601 zcmd_free_nvlists(&zc
);
1602 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0)
1604 if (nvlist_add_uint64(nvl
,
1605 zfs_prop_to_name(ZFS_PROP_VOLSIZE
),
1608 if (zcmd_write_src_nvlist(hdl
, &zc
, nvl
) != 0)
1610 (void) zfs_ioctl(hdl
, ZFS_IOC_SET_PROP
, &zc
);
1614 ret
= changelist_postfix(cl
);
1618 * Refresh the statistics so the new property
1619 * value is reflected.
1621 (void) get_stats(zhp
);
1624 * Remount the filesystem to propagate the change
1625 * if one of the options handled by the generic
1626 * Linux namespace layer has been modified.
1628 if (zfs_is_namespace_prop(prop
) &&
1629 zfs_is_mounted(zhp
, NULL
))
1630 ret
= zfs_mount(zhp
, MNTOPT_REMOUNT
, 0);
1636 zcmd_free_nvlists(&zc
);
1638 changelist_free(cl
);
1643 * Given a property, inherit the value from the parent dataset, or if received
1644 * is TRUE, revert to the received value, if any.
1647 zfs_prop_inherit(zfs_handle_t
*zhp
, const char *propname
, boolean_t received
)
1649 zfs_cmd_t zc
= {"\0"};
1651 prop_changelist_t
*cl
;
1652 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1656 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1657 "cannot inherit %s for '%s'"), propname
, zhp
->zfs_name
);
1659 zc
.zc_cookie
= received
;
1660 if ((prop
= zfs_name_to_prop(propname
)) == ZPROP_INVAL
) {
1662 * For user properties, the amount of work we have to do is very
1663 * small, so just do it here.
1665 if (!zfs_prop_user(propname
)) {
1666 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1667 "invalid property"));
1668 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
1671 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1672 (void) strlcpy(zc
.zc_value
, propname
, sizeof (zc
.zc_value
));
1674 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_INHERIT_PROP
, &zc
) != 0)
1675 return (zfs_standard_error(hdl
, errno
, errbuf
));
1681 * Verify that this property is inheritable.
1683 if (zfs_prop_readonly(prop
))
1684 return (zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
));
1686 if (!zfs_prop_inheritable(prop
) && !received
)
1687 return (zfs_error(hdl
, EZFS_PROPNONINHERIT
, errbuf
));
1690 * Check to see if the value applies to this type
1692 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
))
1693 return (zfs_error(hdl
, EZFS_PROPTYPE
, errbuf
));
1696 * Normalize the name, to get rid of shorthand abbreviations.
1698 propname
= zfs_prop_to_name(prop
);
1699 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1700 (void) strlcpy(zc
.zc_value
, propname
, sizeof (zc
.zc_value
));
1702 if (prop
== ZFS_PROP_MOUNTPOINT
&& getzoneid() == GLOBAL_ZONEID
&&
1703 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
)) {
1704 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1705 "dataset is used in a non-global zone"));
1706 return (zfs_error(hdl
, EZFS_ZONED
, errbuf
));
1710 * Determine datasets which will be affected by this change, if any.
1712 if ((cl
= changelist_gather(zhp
, prop
, 0, 0)) == NULL
)
1715 if (prop
== ZFS_PROP_MOUNTPOINT
&& changelist_haszonedchild(cl
)) {
1716 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1717 "child dataset with inherited mountpoint is used "
1718 "in a non-global zone"));
1719 ret
= zfs_error(hdl
, EZFS_ZONED
, errbuf
);
1723 if ((ret
= changelist_prefix(cl
)) != 0)
1726 if ((ret
= zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_INHERIT_PROP
, &zc
)) != 0) {
1727 return (zfs_standard_error(hdl
, errno
, errbuf
));
1730 if ((ret
= changelist_postfix(cl
)) != 0)
1734 * Refresh the statistics so the new property is reflected.
1736 (void) get_stats(zhp
);
1739 * Remount the filesystem to propagate the change
1740 * if one of the options handled by the generic
1741 * Linux namespace layer has been modified.
1743 if (zfs_is_namespace_prop(prop
) &&
1744 zfs_is_mounted(zhp
, NULL
))
1745 ret
= zfs_mount(zhp
, MNTOPT_REMOUNT
, 0);
1749 changelist_free(cl
);
1754 * True DSL properties are stored in an nvlist. The following two functions
1755 * extract them appropriately.
1758 getprop_uint64(zfs_handle_t
*zhp
, zfs_prop_t prop
, char **source
)
1764 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
1765 zfs_prop_to_name(prop
), &nv
) == 0) {
1766 verify(nvlist_lookup_uint64(nv
, ZPROP_VALUE
, &value
) == 0);
1767 (void) nvlist_lookup_string(nv
, ZPROP_SOURCE
, source
);
1769 verify(!zhp
->zfs_props_table
||
1770 zhp
->zfs_props_table
[prop
] == B_TRUE
);
1771 value
= zfs_prop_default_numeric(prop
);
1779 getprop_string(zfs_handle_t
*zhp
, zfs_prop_t prop
, char **source
)
1785 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
1786 zfs_prop_to_name(prop
), &nv
) == 0) {
1787 verify(nvlist_lookup_string(nv
, ZPROP_VALUE
, &value
) == 0);
1788 (void) nvlist_lookup_string(nv
, ZPROP_SOURCE
, source
);
1790 verify(!zhp
->zfs_props_table
||
1791 zhp
->zfs_props_table
[prop
] == B_TRUE
);
1792 if ((value
= (char *)zfs_prop_default_string(prop
)) == NULL
)
1801 zfs_is_recvd_props_mode(zfs_handle_t
*zhp
)
1803 return (zhp
->zfs_props
== zhp
->zfs_recvd_props
);
1807 zfs_set_recvd_props_mode(zfs_handle_t
*zhp
, uint64_t *cookie
)
1809 *cookie
= (uint64_t)(uintptr_t)zhp
->zfs_props
;
1810 zhp
->zfs_props
= zhp
->zfs_recvd_props
;
1814 zfs_unset_recvd_props_mode(zfs_handle_t
*zhp
, uint64_t *cookie
)
1816 zhp
->zfs_props
= (nvlist_t
*)(uintptr_t)*cookie
;
1821 * Internal function for getting a numeric property. Both zfs_prop_get() and
1822 * zfs_prop_get_int() are built using this interface.
1824 * Certain properties can be overridden using 'mount -o'. In this case, scan
1825 * the contents of the /etc/mtab entry, searching for the appropriate options.
1826 * If they differ from the on-disk values, report the current values and mark
1827 * the source "temporary".
1830 get_numeric_property(zfs_handle_t
*zhp
, zfs_prop_t prop
, zprop_source_t
*src
,
1831 char **source
, uint64_t *val
)
1833 zfs_cmd_t zc
= {"\0"};
1834 nvlist_t
*zplprops
= NULL
;
1836 char *mntopt_on
= NULL
;
1837 char *mntopt_off
= NULL
;
1838 boolean_t received
= zfs_is_recvd_props_mode(zhp
);
1843 * If the property is being fetched for a snapshot, check whether
1844 * the property is valid for the snapshot's head dataset type.
1846 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
&&
1847 !zfs_prop_valid_for_type(prop
, zhp
->zfs_head_type
, B_TRUE
)) {
1848 *val
= zfs_prop_default_numeric(prop
);
1853 case ZFS_PROP_ATIME
:
1854 mntopt_on
= MNTOPT_ATIME
;
1855 mntopt_off
= MNTOPT_NOATIME
;
1858 case ZFS_PROP_RELATIME
:
1859 mntopt_on
= MNTOPT_RELATIME
;
1860 mntopt_off
= MNTOPT_NORELATIME
;
1863 case ZFS_PROP_DEVICES
:
1864 mntopt_on
= MNTOPT_DEVICES
;
1865 mntopt_off
= MNTOPT_NODEVICES
;
1869 mntopt_on
= MNTOPT_EXEC
;
1870 mntopt_off
= MNTOPT_NOEXEC
;
1873 case ZFS_PROP_READONLY
:
1874 mntopt_on
= MNTOPT_RO
;
1875 mntopt_off
= MNTOPT_RW
;
1878 case ZFS_PROP_SETUID
:
1879 mntopt_on
= MNTOPT_SETUID
;
1880 mntopt_off
= MNTOPT_NOSETUID
;
1883 case ZFS_PROP_XATTR
:
1884 mntopt_on
= MNTOPT_XATTR
;
1885 mntopt_off
= MNTOPT_NOXATTR
;
1888 case ZFS_PROP_NBMAND
:
1889 mntopt_on
= MNTOPT_NBMAND
;
1890 mntopt_off
= MNTOPT_NONBMAND
;
1897 * Because looking up the mount options is potentially expensive
1898 * (iterating over all of /etc/mtab), we defer its calculation until
1899 * we're looking up a property which requires its presence.
1901 if (!zhp
->zfs_mntcheck
&&
1902 (mntopt_on
!= NULL
|| prop
== ZFS_PROP_MOUNTED
)) {
1903 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1904 struct mnttab entry
;
1906 if (libzfs_mnttab_find(hdl
, zhp
->zfs_name
, &entry
) == 0) {
1907 zhp
->zfs_mntopts
= zfs_strdup(hdl
,
1909 if (zhp
->zfs_mntopts
== NULL
)
1913 zhp
->zfs_mntcheck
= B_TRUE
;
1916 if (zhp
->zfs_mntopts
== NULL
)
1917 mnt
.mnt_mntopts
= "";
1919 mnt
.mnt_mntopts
= zhp
->zfs_mntopts
;
1922 case ZFS_PROP_DEVICES
:
1924 case ZFS_PROP_READONLY
:
1925 case ZFS_PROP_SETUID
:
1926 case ZFS_PROP_XATTR
:
1927 case ZFS_PROP_NBMAND
:
1928 *val
= getprop_uint64(zhp
, prop
, source
);
1933 if (hasmntopt(&mnt
, mntopt_on
) && !*val
) {
1936 *src
= ZPROP_SRC_TEMPORARY
;
1937 } else if (hasmntopt(&mnt
, mntopt_off
) && *val
) {
1940 *src
= ZPROP_SRC_TEMPORARY
;
1944 case ZFS_PROP_ATIME
:
1945 case ZFS_PROP_RELATIME
:
1946 case ZFS_PROP_CANMOUNT
:
1947 case ZFS_PROP_VOLSIZE
:
1948 case ZFS_PROP_QUOTA
:
1949 case ZFS_PROP_REFQUOTA
:
1950 case ZFS_PROP_RESERVATION
:
1951 case ZFS_PROP_REFRESERVATION
:
1952 case ZFS_PROP_FILESYSTEM_LIMIT
:
1953 case ZFS_PROP_SNAPSHOT_LIMIT
:
1954 case ZFS_PROP_FILESYSTEM_COUNT
:
1955 case ZFS_PROP_SNAPSHOT_COUNT
:
1956 *val
= getprop_uint64(zhp
, prop
, source
);
1958 if (*source
== NULL
) {
1959 /* not default, must be local */
1960 *source
= zhp
->zfs_name
;
1964 case ZFS_PROP_MOUNTED
:
1965 *val
= (zhp
->zfs_mntopts
!= NULL
);
1968 case ZFS_PROP_NUMCLONES
:
1969 *val
= zhp
->zfs_dmustats
.dds_num_clones
;
1972 case ZFS_PROP_VERSION
:
1973 case ZFS_PROP_NORMALIZE
:
1974 case ZFS_PROP_UTF8ONLY
:
1976 if (zcmd_alloc_dst_nvlist(zhp
->zfs_hdl
, &zc
, 0) != 0)
1978 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1979 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_OBJSET_ZPLPROPS
, &zc
)) {
1980 zcmd_free_nvlists(&zc
);
1981 if (prop
== ZFS_PROP_VERSION
&&
1982 zhp
->zfs_type
== ZFS_TYPE_VOLUME
)
1983 *val
= zfs_prop_default_numeric(prop
);
1986 if (zcmd_read_dst_nvlist(zhp
->zfs_hdl
, &zc
, &zplprops
) != 0 ||
1987 nvlist_lookup_uint64(zplprops
, zfs_prop_to_name(prop
),
1989 zcmd_free_nvlists(&zc
);
1993 nvlist_free(zplprops
);
1994 zcmd_free_nvlists(&zc
);
1997 case ZFS_PROP_INCONSISTENT
:
1998 *val
= zhp
->zfs_dmustats
.dds_inconsistent
;
2002 switch (zfs_prop_get_type(prop
)) {
2003 case PROP_TYPE_NUMBER
:
2004 case PROP_TYPE_INDEX
:
2005 *val
= getprop_uint64(zhp
, prop
, source
);
2007 * If we tried to use a default value for a
2008 * readonly property, it means that it was not
2011 if (zfs_prop_readonly(prop
) &&
2012 *source
!= NULL
&& (*source
)[0] == '\0') {
2017 case PROP_TYPE_STRING
:
2019 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
2020 "cannot get non-numeric property"));
2021 return (zfs_error(zhp
->zfs_hdl
, EZFS_BADPROP
,
2022 dgettext(TEXT_DOMAIN
, "internal error")));
2030 * Calculate the source type, given the raw source string.
2033 get_source(zfs_handle_t
*zhp
, zprop_source_t
*srctype
, char *source
,
2034 char *statbuf
, size_t statlen
)
2036 if (statbuf
== NULL
|| *srctype
== ZPROP_SRC_TEMPORARY
)
2039 if (source
== NULL
) {
2040 *srctype
= ZPROP_SRC_NONE
;
2041 } else if (source
[0] == '\0') {
2042 *srctype
= ZPROP_SRC_DEFAULT
;
2043 } else if (strstr(source
, ZPROP_SOURCE_VAL_RECVD
) != NULL
) {
2044 *srctype
= ZPROP_SRC_RECEIVED
;
2046 if (strcmp(source
, zhp
->zfs_name
) == 0) {
2047 *srctype
= ZPROP_SRC_LOCAL
;
2049 (void) strlcpy(statbuf
, source
, statlen
);
2050 *srctype
= ZPROP_SRC_INHERITED
;
2057 zfs_prop_get_recvd(zfs_handle_t
*zhp
, const char *propname
, char *propbuf
,
2058 size_t proplen
, boolean_t literal
)
2063 if (zhp
->zfs_recvd_props
== NULL
)
2064 if (get_recvd_props_ioctl(zhp
) != 0)
2067 prop
= zfs_name_to_prop(propname
);
2069 if (prop
!= ZPROP_INVAL
) {
2071 if (!nvlist_exists(zhp
->zfs_recvd_props
, propname
))
2073 zfs_set_recvd_props_mode(zhp
, &cookie
);
2074 err
= zfs_prop_get(zhp
, prop
, propbuf
, proplen
,
2075 NULL
, NULL
, 0, literal
);
2076 zfs_unset_recvd_props_mode(zhp
, &cookie
);
2080 if (nvlist_lookup_nvlist(zhp
->zfs_recvd_props
,
2081 propname
, &propval
) != 0)
2083 verify(nvlist_lookup_string(propval
, ZPROP_VALUE
,
2085 (void) strlcpy(propbuf
, recvdval
, proplen
);
2088 return (err
== 0 ? 0 : -1);
2092 get_clones_string(zfs_handle_t
*zhp
, char *propbuf
, size_t proplen
)
2097 value
= zfs_get_clones_nvl(zhp
);
2102 for (pair
= nvlist_next_nvpair(value
, NULL
); pair
!= NULL
;
2103 pair
= nvlist_next_nvpair(value
, pair
)) {
2104 if (propbuf
[0] != '\0')
2105 (void) strlcat(propbuf
, ",", proplen
);
2106 (void) strlcat(propbuf
, nvpair_name(pair
), proplen
);
2112 struct get_clones_arg
{
2116 char buf
[ZFS_MAXNAMELEN
];
2120 get_clones_cb(zfs_handle_t
*zhp
, void *arg
)
2122 struct get_clones_arg
*gca
= arg
;
2124 if (gca
->numclones
== 0) {
2129 if (zfs_prop_get(zhp
, ZFS_PROP_ORIGIN
, gca
->buf
, sizeof (gca
->buf
),
2130 NULL
, NULL
, 0, B_TRUE
) != 0)
2132 if (strcmp(gca
->buf
, gca
->origin
) == 0) {
2133 fnvlist_add_boolean(gca
->value
, zfs_get_name(zhp
));
2138 (void) zfs_iter_children(zhp
, get_clones_cb
, gca
);
2144 zfs_get_clones_nvl(zfs_handle_t
*zhp
)
2146 nvlist_t
*nv
, *value
;
2148 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
2149 zfs_prop_to_name(ZFS_PROP_CLONES
), &nv
) != 0) {
2150 struct get_clones_arg gca
;
2153 * if this is a snapshot, then the kernel wasn't able
2154 * to get the clones. Do it by slowly iterating.
2156 if (zhp
->zfs_type
!= ZFS_TYPE_SNAPSHOT
)
2158 if (nvlist_alloc(&nv
, NV_UNIQUE_NAME
, 0) != 0)
2160 if (nvlist_alloc(&value
, NV_UNIQUE_NAME
, 0) != 0) {
2165 gca
.numclones
= zfs_prop_get_int(zhp
, ZFS_PROP_NUMCLONES
);
2167 gca
.origin
= zhp
->zfs_name
;
2169 if (gca
.numclones
!= 0) {
2171 char pool
[ZFS_MAXNAMELEN
];
2174 /* get the pool name */
2175 (void) strlcpy(pool
, zhp
->zfs_name
, sizeof (pool
));
2176 (void) strsep(&cp
, "/@");
2177 root
= zfs_open(zhp
->zfs_hdl
, pool
,
2178 ZFS_TYPE_FILESYSTEM
);
2180 (void) get_clones_cb(root
, &gca
);
2183 if (gca
.numclones
!= 0 ||
2184 nvlist_add_nvlist(nv
, ZPROP_VALUE
, value
) != 0 ||
2185 nvlist_add_nvlist(zhp
->zfs_props
,
2186 zfs_prop_to_name(ZFS_PROP_CLONES
), nv
) != 0) {
2193 verify(0 == nvlist_lookup_nvlist(zhp
->zfs_props
,
2194 zfs_prop_to_name(ZFS_PROP_CLONES
), &nv
));
2197 verify(nvlist_lookup_nvlist(nv
, ZPROP_VALUE
, &value
) == 0);
2203 * Retrieve a property from the given object. If 'literal' is specified, then
2204 * numbers are left as exact values. Otherwise, numbers are converted to a
2205 * human-readable form.
2207 * Returns 0 on success, or -1 on error.
2210 zfs_prop_get(zfs_handle_t
*zhp
, zfs_prop_t prop
, char *propbuf
, size_t proplen
,
2211 zprop_source_t
*src
, char *statbuf
, size_t statlen
, boolean_t literal
)
2213 char *source
= NULL
;
2217 boolean_t received
= zfs_is_recvd_props_mode(zhp
);
2220 * Check to see if this property applies to our object
2222 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
))
2225 if (received
&& zfs_prop_readonly(prop
))
2229 *src
= ZPROP_SRC_NONE
;
2232 case ZFS_PROP_CREATION
:
2234 * 'creation' is a time_t stored in the statistics. We convert
2235 * this into a string unless 'literal' is specified.
2238 val
= getprop_uint64(zhp
, prop
, &source
);
2239 time_t time
= (time_t)val
;
2243 localtime_r(&time
, &t
) == NULL
||
2244 strftime(propbuf
, proplen
, "%a %b %e %k:%M %Y",
2246 (void) snprintf(propbuf
, proplen
, "%llu",
2247 (u_longlong_t
) val
);
2251 case ZFS_PROP_MOUNTPOINT
:
2253 * Getting the precise mountpoint can be tricky.
2255 * - for 'none' or 'legacy', return those values.
2256 * - for inherited mountpoints, we want to take everything
2257 * after our ancestor and append it to the inherited value.
2259 * If the pool has an alternate root, we want to prepend that
2260 * root to any values we return.
2263 str
= getprop_string(zhp
, prop
, &source
);
2265 if (str
[0] == '/') {
2266 char buf
[MAXPATHLEN
];
2268 const char *relpath
;
2271 * If we inherit the mountpoint, even from a dataset
2272 * with a received value, the source will be the path of
2273 * the dataset we inherit from. If source is
2274 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2277 if (strcmp(source
, ZPROP_SOURCE_VAL_RECVD
) == 0) {
2280 relpath
= zhp
->zfs_name
+ strlen(source
);
2281 if (relpath
[0] == '/')
2285 if ((zpool_get_prop(zhp
->zpool_hdl
,
2286 ZPOOL_PROP_ALTROOT
, buf
, MAXPATHLEN
, NULL
)) ||
2287 (strcmp(root
, "-") == 0))
2290 * Special case an alternate root of '/'. This will
2291 * avoid having multiple leading slashes in the
2294 if (strcmp(root
, "/") == 0)
2298 * If the mountpoint is '/' then skip over this
2299 * if we are obtaining either an alternate root or
2300 * an inherited mountpoint.
2302 if (str
[1] == '\0' && (root
[0] != '\0' ||
2303 relpath
[0] != '\0'))
2306 if (relpath
[0] == '\0')
2307 (void) snprintf(propbuf
, proplen
, "%s%s",
2310 (void) snprintf(propbuf
, proplen
, "%s%s%s%s",
2311 root
, str
, relpath
[0] == '@' ? "" : "/",
2314 /* 'legacy' or 'none' */
2315 (void) strlcpy(propbuf
, str
, proplen
);
2320 case ZFS_PROP_ORIGIN
:
2321 (void) strlcpy(propbuf
, getprop_string(zhp
, prop
, &source
),
2324 * If there is no parent at all, return failure to indicate that
2325 * it doesn't apply to this dataset.
2327 if (propbuf
[0] == '\0')
2331 case ZFS_PROP_CLONES
:
2332 if (get_clones_string(zhp
, propbuf
, proplen
) != 0)
2336 case ZFS_PROP_QUOTA
:
2337 case ZFS_PROP_REFQUOTA
:
2338 case ZFS_PROP_RESERVATION
:
2339 case ZFS_PROP_REFRESERVATION
:
2341 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2345 * If quota or reservation is 0, we translate this into 'none'
2346 * (unless literal is set), and indicate that it's the default
2347 * value. Otherwise, we print the number nicely and indicate
2348 * that its set locally.
2352 (void) strlcpy(propbuf
, "0", proplen
);
2354 (void) strlcpy(propbuf
, "none", proplen
);
2357 (void) snprintf(propbuf
, proplen
, "%llu",
2360 zfs_nicenum(val
, propbuf
, proplen
);
2364 case ZFS_PROP_FILESYSTEM_LIMIT
:
2365 case ZFS_PROP_SNAPSHOT_LIMIT
:
2366 case ZFS_PROP_FILESYSTEM_COUNT
:
2367 case ZFS_PROP_SNAPSHOT_COUNT
:
2369 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2373 * If limit is UINT64_MAX, we translate this into 'none' (unless
2374 * literal is set), and indicate that it's the default value.
2375 * Otherwise, we print the number nicely and indicate that it's
2379 (void) snprintf(propbuf
, proplen
, "%llu",
2381 } else if (val
== UINT64_MAX
) {
2382 (void) strlcpy(propbuf
, "none", proplen
);
2384 zfs_nicenum(val
, propbuf
, proplen
);
2388 case ZFS_PROP_REFRATIO
:
2389 case ZFS_PROP_COMPRESSRATIO
:
2390 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2392 (void) snprintf(propbuf
, proplen
, "%llu.%02llux",
2393 (u_longlong_t
)(val
/ 100),
2394 (u_longlong_t
)(val
% 100));
2398 switch (zhp
->zfs_type
) {
2399 case ZFS_TYPE_FILESYSTEM
:
2402 case ZFS_TYPE_VOLUME
:
2405 case ZFS_TYPE_SNAPSHOT
:
2408 case ZFS_TYPE_BOOKMARK
:
2414 (void) snprintf(propbuf
, proplen
, "%s", str
);
2417 case ZFS_PROP_MOUNTED
:
2419 * The 'mounted' property is a pseudo-property that described
2420 * whether the filesystem is currently mounted. Even though
2421 * it's a boolean value, the typical values of "on" and "off"
2422 * don't make sense, so we translate to "yes" and "no".
2424 if (get_numeric_property(zhp
, ZFS_PROP_MOUNTED
,
2425 src
, &source
, &val
) != 0)
2428 (void) strlcpy(propbuf
, "yes", proplen
);
2430 (void) strlcpy(propbuf
, "no", proplen
);
2435 * The 'name' property is a pseudo-property derived from the
2436 * dataset name. It is presented as a real property to simplify
2439 (void) strlcpy(propbuf
, zhp
->zfs_name
, proplen
);
2442 case ZFS_PROP_MLSLABEL
:
2444 #ifdef HAVE_MLSLABEL
2445 m_label_t
*new_sl
= NULL
;
2446 char *ascii
= NULL
; /* human readable label */
2448 (void) strlcpy(propbuf
,
2449 getprop_string(zhp
, prop
, &source
), proplen
);
2451 if (literal
|| (strcasecmp(propbuf
,
2452 ZFS_MLSLABEL_DEFAULT
) == 0))
2456 * Try to translate the internal hex string to
2457 * human-readable output. If there are any
2458 * problems just use the hex string.
2461 if (str_to_label(propbuf
, &new_sl
, MAC_LABEL
,
2462 L_NO_CORRECTION
, NULL
) == -1) {
2463 m_label_free(new_sl
);
2467 if (label_to_str(new_sl
, &ascii
, M_LABEL
,
2471 m_label_free(new_sl
);
2474 m_label_free(new_sl
);
2476 (void) strlcpy(propbuf
, ascii
, proplen
);
2479 (void) strlcpy(propbuf
,
2480 getprop_string(zhp
, prop
, &source
), proplen
);
2481 #endif /* HAVE_MLSLABEL */
2487 * GUIDs are stored as numbers, but they are identifiers.
2488 * We don't want them to be pretty printed, because pretty
2489 * printing mangles the ID into a truncated and useless value.
2491 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2493 (void) snprintf(propbuf
, proplen
, "%llu", (u_longlong_t
)val
);
2497 switch (zfs_prop_get_type(prop
)) {
2498 case PROP_TYPE_NUMBER
:
2499 if (get_numeric_property(zhp
, prop
, src
,
2500 &source
, &val
) != 0)
2503 (void) snprintf(propbuf
, proplen
, "%llu",
2506 zfs_nicenum(val
, propbuf
, proplen
);
2509 case PROP_TYPE_STRING
:
2510 (void) strlcpy(propbuf
,
2511 getprop_string(zhp
, prop
, &source
), proplen
);
2514 case PROP_TYPE_INDEX
:
2515 if (get_numeric_property(zhp
, prop
, src
,
2516 &source
, &val
) != 0)
2518 if (zfs_prop_index_to_string(prop
, val
, &strval
) != 0)
2520 (void) strlcpy(propbuf
, strval
, proplen
);
2528 get_source(zhp
, src
, source
, statbuf
, statlen
);
2534 * Utility function to get the given numeric property. Does no validation that
2535 * the given property is the appropriate type; should only be used with
2536 * hard-coded property types.
2539 zfs_prop_get_int(zfs_handle_t
*zhp
, zfs_prop_t prop
)
2544 (void) get_numeric_property(zhp
, prop
, NULL
, &source
, &val
);
2550 zfs_prop_set_int(zfs_handle_t
*zhp
, zfs_prop_t prop
, uint64_t val
)
2554 (void) snprintf(buf
, sizeof (buf
), "%llu", (longlong_t
)val
);
2555 return (zfs_prop_set(zhp
, zfs_prop_to_name(prop
), buf
));
2559 * Similar to zfs_prop_get(), but returns the value as an integer.
2562 zfs_prop_get_numeric(zfs_handle_t
*zhp
, zfs_prop_t prop
, uint64_t *value
,
2563 zprop_source_t
*src
, char *statbuf
, size_t statlen
)
2568 * Check to see if this property applies to our object
2570 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
)) {
2571 return (zfs_error_fmt(zhp
->zfs_hdl
, EZFS_PROPTYPE
,
2572 dgettext(TEXT_DOMAIN
, "cannot get property '%s'"),
2573 zfs_prop_to_name(prop
)));
2577 *src
= ZPROP_SRC_NONE
;
2579 if (get_numeric_property(zhp
, prop
, src
, &source
, value
) != 0)
2582 get_source(zhp
, src
, source
, statbuf
, statlen
);
2589 idmap_id_to_numeric_domain_rid(uid_t id
, boolean_t isuser
,
2590 char **domainp
, idmap_rid_t
*ridp
)
2592 idmap_get_handle_t
*get_hdl
= NULL
;
2596 if (idmap_get_create(&get_hdl
) != IDMAP_SUCCESS
)
2600 err
= idmap_get_sidbyuid(get_hdl
, id
,
2601 IDMAP_REQ_FLG_USE_CACHE
, domainp
, ridp
, &status
);
2603 err
= idmap_get_sidbygid(get_hdl
, id
,
2604 IDMAP_REQ_FLG_USE_CACHE
, domainp
, ridp
, &status
);
2606 if (err
== IDMAP_SUCCESS
&&
2607 idmap_get_mappings(get_hdl
) == IDMAP_SUCCESS
&&
2608 status
== IDMAP_SUCCESS
)
2614 idmap_get_destroy(get_hdl
);
2617 #endif /* HAVE_IDMAP */
2620 * convert the propname into parameters needed by kernel
2621 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2622 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2623 * Eg: groupquota@staff -> ZFS_PROP_GROUPQUOTA, "", 1234
2624 * Eg: groupused@staff -> ZFS_PROP_GROUPUSED, "", 1234
2627 userquota_propname_decode(const char *propname
, boolean_t zoned
,
2628 zfs_userquota_prop_t
*typep
, char *domain
, int domainlen
, uint64_t *ridp
)
2630 zfs_userquota_prop_t type
;
2639 /* Figure out the property type ({user|group}{quota|space}) */
2640 for (type
= 0; type
< ZFS_NUM_USERQUOTA_PROPS
; type
++) {
2641 if (strncmp(propname
, zfs_userquota_prop_prefixes
[type
],
2642 strlen(zfs_userquota_prop_prefixes
[type
])) == 0)
2645 if (type
== ZFS_NUM_USERQUOTA_PROPS
)
2649 isuser
= (type
== ZFS_PROP_USERQUOTA
|| type
== ZFS_PROP_USERUSED
);
2650 isgroup
= (type
== ZFS_PROP_GROUPQUOTA
|| type
== ZFS_PROP_GROUPUSED
);
2652 cp
= strchr(propname
, '@') + 1;
2654 if (isuser
&& (pw
= getpwnam(cp
)) != NULL
) {
2655 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
2658 } else if (isgroup
&& (gr
= getgrnam(cp
)) != NULL
) {
2659 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
2662 } else if (strchr(cp
, '@')) {
2665 * It's a SID name (eg "user@domain") that needs to be
2666 * turned into S-1-domainID-RID.
2668 directory_error_t e
;
2669 char *numericsid
= NULL
;
2672 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
2675 e
= directory_sid_from_user_name(NULL
,
2678 e
= directory_sid_from_group_name(NULL
,
2682 directory_error_free(e
);
2685 if (numericsid
== NULL
)
2688 (void) strlcpy(domain
, cp
, domainlen
);
2689 cp
= strrchr(domain
, '-');
2694 *ridp
= strtoull(cp
, &end
, 10);
2697 if (errno
!= 0 || *end
!= '\0')
2701 #endif /* HAVE_IDMAP */
2703 /* It's a user/group ID (eg "12345"). */
2706 id
= strtoul(cp
, &end
, 10);
2711 /* It's an ephemeral ID. */
2715 if (idmap_id_to_numeric_domain_rid(id
, isuser
,
2716 &mapdomain
, &rid
) != 0)
2718 (void) strlcpy(domain
, mapdomain
, domainlen
);
2722 #endif /* HAVE_IDMAP */
2732 zfs_prop_get_userquota_common(zfs_handle_t
*zhp
, const char *propname
,
2733 uint64_t *propvalue
, zfs_userquota_prop_t
*typep
)
2736 zfs_cmd_t zc
= {"\0"};
2738 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
2740 err
= userquota_propname_decode(propname
,
2741 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
),
2742 typep
, zc
.zc_value
, sizeof (zc
.zc_value
), &zc
.zc_guid
);
2743 zc
.zc_objset_type
= *typep
;
2747 err
= ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_USERSPACE_ONE
, &zc
);
2751 *propvalue
= zc
.zc_cookie
;
2756 zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
2757 uint64_t *propvalue
)
2759 zfs_userquota_prop_t type
;
2761 return (zfs_prop_get_userquota_common(zhp
, propname
, propvalue
,
2766 zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
2767 char *propbuf
, int proplen
, boolean_t literal
)
2771 zfs_userquota_prop_t type
;
2773 err
= zfs_prop_get_userquota_common(zhp
, propname
, &propvalue
,
2780 (void) snprintf(propbuf
, proplen
, "%llu",
2781 (u_longlong_t
)propvalue
);
2782 } else if (propvalue
== 0 &&
2783 (type
== ZFS_PROP_USERQUOTA
|| type
== ZFS_PROP_GROUPQUOTA
)) {
2784 (void) strlcpy(propbuf
, "none", proplen
);
2786 zfs_nicenum(propvalue
, propbuf
, proplen
);
2792 zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
2793 uint64_t *propvalue
)
2796 zfs_cmd_t zc
= {"\0"};
2797 const char *snapname
;
2799 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
2801 snapname
= strchr(propname
, '@') + 1;
2802 if (strchr(snapname
, '@')) {
2803 (void) strlcpy(zc
.zc_value
, snapname
, sizeof (zc
.zc_value
));
2805 /* snapname is the short name, append it to zhp's fsname */
2808 (void) strlcpy(zc
.zc_value
, zhp
->zfs_name
,
2809 sizeof (zc
.zc_value
));
2810 cp
= strchr(zc
.zc_value
, '@');
2813 (void) strlcat(zc
.zc_value
, "@", sizeof (zc
.zc_value
));
2814 (void) strlcat(zc
.zc_value
, snapname
, sizeof (zc
.zc_value
));
2817 err
= ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_SPACE_WRITTEN
, &zc
);
2821 *propvalue
= zc
.zc_cookie
;
2826 zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
2827 char *propbuf
, int proplen
, boolean_t literal
)
2832 err
= zfs_prop_get_written_int(zhp
, propname
, &propvalue
);
2838 (void) snprintf(propbuf
, proplen
, "%llu",
2839 (u_longlong_t
)propvalue
);
2841 zfs_nicenum(propvalue
, propbuf
, proplen
);
2848 * Returns the name of the given zfs handle.
2851 zfs_get_name(const zfs_handle_t
*zhp
)
2853 return (zhp
->zfs_name
);
2857 * Returns the type of the given zfs handle.
2860 zfs_get_type(const zfs_handle_t
*zhp
)
2862 return (zhp
->zfs_type
);
2866 * Is one dataset name a child dataset of another?
2868 * Needs to handle these cases:
2869 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2870 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2871 * Descendant? No. No. No. Yes.
2874 is_descendant(const char *ds1
, const char *ds2
)
2876 size_t d1len
= strlen(ds1
);
2878 /* ds2 can't be a descendant if it's smaller */
2879 if (strlen(ds2
) < d1len
)
2882 /* otherwise, compare strings and verify that there's a '/' char */
2883 return (ds2
[d1len
] == '/' && (strncmp(ds1
, ds2
, d1len
) == 0));
2887 * Given a complete name, return just the portion that refers to the parent.
2888 * Will return -1 if there is no parent (path is just the name of the
2892 parent_name(const char *path
, char *buf
, size_t buflen
)
2896 (void) strlcpy(buf
, path
, buflen
);
2898 if ((slashp
= strrchr(buf
, '/')) == NULL
)
2906 * If accept_ancestor is false, then check to make sure that the given path has
2907 * a parent, and that it exists. If accept_ancestor is true, then find the
2908 * closest existing ancestor for the given path. In prefixlen return the
2909 * length of already existing prefix of the given path. We also fetch the
2910 * 'zoned' property, which is used to validate property settings when creating
2914 check_parents(libzfs_handle_t
*hdl
, const char *path
, uint64_t *zoned
,
2915 boolean_t accept_ancestor
, int *prefixlen
)
2917 zfs_cmd_t zc
= {"\0"};
2918 char parent
[ZFS_MAXNAMELEN
];
2924 (void) snprintf(errbuf
, sizeof (errbuf
),
2925 dgettext(TEXT_DOMAIN
, "cannot create '%s'"), path
);
2927 /* get parent, and check to see if this is just a pool */
2928 if (parent_name(path
, parent
, sizeof (parent
)) != 0) {
2929 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2930 "missing dataset name"));
2931 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
2934 /* check to see if the pool exists */
2935 if ((slash
= strchr(parent
, '/')) == NULL
)
2936 slash
= parent
+ strlen(parent
);
2937 (void) strncpy(zc
.zc_name
, parent
, slash
- parent
);
2938 zc
.zc_name
[slash
- parent
] = '\0';
2939 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_OBJSET_STATS
, &zc
) != 0 &&
2941 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2942 "no such pool '%s'"), zc
.zc_name
);
2943 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
2946 /* check to see if the parent dataset exists */
2947 while ((zhp
= make_dataset_handle(hdl
, parent
)) == NULL
) {
2948 if (errno
== ENOENT
&& accept_ancestor
) {
2950 * Go deeper to find an ancestor, give up on top level.
2952 if (parent_name(parent
, parent
, sizeof (parent
)) != 0) {
2953 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2954 "no such pool '%s'"), zc
.zc_name
);
2955 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
2957 } else if (errno
== ENOENT
) {
2958 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2959 "parent does not exist"));
2960 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
2962 return (zfs_standard_error(hdl
, errno
, errbuf
));
2965 is_zoned
= zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
);
2969 /* we are in a non-global zone, but parent is in the global zone */
2970 if (getzoneid() != GLOBAL_ZONEID
&& !is_zoned
) {
2971 (void) zfs_standard_error(hdl
, EPERM
, errbuf
);
2976 /* make sure parent is a filesystem */
2977 if (zfs_get_type(zhp
) != ZFS_TYPE_FILESYSTEM
) {
2978 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2979 "parent is not a filesystem"));
2980 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
2986 if (prefixlen
!= NULL
)
2987 *prefixlen
= strlen(parent
);
2992 * Finds whether the dataset of the given type(s) exists.
2995 zfs_dataset_exists(libzfs_handle_t
*hdl
, const char *path
, zfs_type_t types
)
2999 if (!zfs_validate_name(hdl
, path
, types
, B_FALSE
))
3003 * Try to get stats for the dataset, which will tell us if it exists.
3005 if ((zhp
= make_dataset_handle(hdl
, path
)) != NULL
) {
3006 int ds_type
= zhp
->zfs_type
;
3009 if (types
& ds_type
)
3016 * Given a path to 'target', create all the ancestors between
3017 * the prefixlen portion of the path, and the target itself.
3018 * Fail if the initial prefixlen-ancestor does not already exist.
3021 create_parents(libzfs_handle_t
*hdl
, char *target
, int prefixlen
)
3027 /* make sure prefix exists */
3028 cp
= target
+ prefixlen
;
3030 assert(strchr(cp
, '/') == NULL
);
3031 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3034 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3042 * Attempt to create, mount, and share any ancestor filesystems,
3043 * up to the prefixlen-long one.
3045 for (cp
= target
+ prefixlen
+ 1;
3046 (cp
= strchr(cp
, '/')); *cp
= '/', cp
++) {
3050 h
= make_dataset_handle(hdl
, target
);
3052 /* it already exists, nothing to do here */
3057 if (zfs_create(hdl
, target
, ZFS_TYPE_FILESYSTEM
,
3059 opname
= dgettext(TEXT_DOMAIN
, "create");
3063 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3065 opname
= dgettext(TEXT_DOMAIN
, "open");
3069 if (zfs_mount(h
, NULL
, 0) != 0) {
3070 opname
= dgettext(TEXT_DOMAIN
, "mount");
3074 if (zfs_share(h
) != 0) {
3075 opname
= dgettext(TEXT_DOMAIN
, "share");
3085 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3086 "failed to %s ancestor '%s'"), opname
, target
);
3091 * Creates non-existing ancestors of the given path.
3094 zfs_create_ancestors(libzfs_handle_t
*hdl
, const char *path
)
3100 if (check_parents(hdl
, path
, NULL
, B_TRUE
, &prefix
) != 0)
3103 if ((path_copy
= strdup(path
)) != NULL
) {
3104 rc
= create_parents(hdl
, path_copy
, prefix
);
3107 if (path_copy
== NULL
|| rc
!= 0)
3114 * Create a new filesystem or volume.
3117 zfs_create(libzfs_handle_t
*hdl
, const char *path
, zfs_type_t type
,
3122 uint64_t blocksize
= zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE
);
3125 dmu_objset_type_t ost
;
3127 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3128 "cannot create '%s'"), path
);
3130 /* validate the path, taking care to note the extended error message */
3131 if (!zfs_validate_name(hdl
, path
, type
, B_TRUE
))
3132 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3134 /* validate parents exist */
3135 if (check_parents(hdl
, path
, &zoned
, B_FALSE
, NULL
) != 0)
3139 * The failure modes when creating a dataset of a different type over
3140 * one that already exists is a little strange. In particular, if you
3141 * try to create a dataset on top of an existing dataset, the ioctl()
3142 * will return ENOENT, not EEXIST. To prevent this from happening, we
3143 * first try to see if the dataset exists.
3145 if (zfs_dataset_exists(hdl
, path
, ZFS_TYPE_DATASET
)) {
3146 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3147 "dataset already exists"));
3148 return (zfs_error(hdl
, EZFS_EXISTS
, errbuf
));
3151 if (type
== ZFS_TYPE_VOLUME
)
3156 if (props
&& (props
= zfs_valid_proplist(hdl
, type
, props
,
3157 zoned
, NULL
, errbuf
)) == 0)
3160 if (type
== ZFS_TYPE_VOLUME
) {
3162 * If we are creating a volume, the size and block size must
3163 * satisfy a few restraints. First, the blocksize must be a
3164 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3165 * volsize must be a multiple of the block size, and cannot be
3168 if (props
== NULL
|| nvlist_lookup_uint64(props
,
3169 zfs_prop_to_name(ZFS_PROP_VOLSIZE
), &size
) != 0) {
3171 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3172 "missing volume size"));
3173 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3176 if ((ret
= nvlist_lookup_uint64(props
,
3177 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
3178 &blocksize
)) != 0) {
3179 if (ret
== ENOENT
) {
3180 blocksize
= zfs_prop_default_numeric(
3181 ZFS_PROP_VOLBLOCKSIZE
);
3184 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3185 "missing volume block size"));
3186 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3192 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3193 "volume size cannot be zero"));
3194 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3197 if (size
% blocksize
!= 0) {
3199 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3200 "volume size must be a multiple of volume block "
3202 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3206 /* create the dataset */
3207 ret
= lzc_create(path
, ost
, props
);
3210 /* check for failure */
3212 char parent
[ZFS_MAXNAMELEN
];
3213 (void) parent_name(path
, parent
, sizeof (parent
));
3217 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3218 "no such parent '%s'"), parent
);
3219 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3222 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3223 "parent '%s' is not a filesystem"), parent
);
3224 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3227 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3228 "volume block size must be power of 2 from "
3229 "512B to %uKB"), zfs_max_recordsize
>> 10);
3231 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3234 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3235 "pool must be upgraded to set this "
3236 "property or value"));
3237 return (zfs_error(hdl
, EZFS_BADVERSION
, errbuf
));
3241 * This platform can't address a volume this big.
3243 if (type
== ZFS_TYPE_VOLUME
)
3244 return (zfs_error(hdl
, EZFS_VOLTOOBIG
,
3249 return (zfs_standard_error(hdl
, errno
, errbuf
));
3257 * Destroys the given dataset. The caller must make sure that the filesystem
3258 * isn't mounted, and that there are no active dependents. If the file system
3259 * does not exist this function does nothing.
3262 zfs_destroy(zfs_handle_t
*zhp
, boolean_t defer
)
3264 zfs_cmd_t zc
= {"\0"};
3266 if (zhp
->zfs_type
== ZFS_TYPE_BOOKMARK
) {
3267 nvlist_t
*nv
= fnvlist_alloc();
3268 fnvlist_add_boolean(nv
, zhp
->zfs_name
);
3269 int error
= lzc_destroy_bookmarks(nv
, NULL
);
3272 return (zfs_standard_error_fmt(zhp
->zfs_hdl
, errno
,
3273 dgettext(TEXT_DOMAIN
, "cannot destroy '%s'"),
3279 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
3281 if (ZFS_IS_VOLUME(zhp
)) {
3282 zc
.zc_objset_type
= DMU_OST_ZVOL
;
3284 zc
.zc_objset_type
= DMU_OST_ZFS
;
3287 zc
.zc_defer_destroy
= defer
;
3288 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_DESTROY
, &zc
) != 0 &&
3290 return (zfs_standard_error_fmt(zhp
->zfs_hdl
, errno
,
3291 dgettext(TEXT_DOMAIN
, "cannot destroy '%s'"),
3295 remove_mountpoint(zhp
);
3300 struct destroydata
{
3302 const char *snapname
;
3306 zfs_check_snap_cb(zfs_handle_t
*zhp
, void *arg
)
3308 struct destroydata
*dd
= arg
;
3309 char name
[ZFS_MAXNAMELEN
];
3312 (void) snprintf(name
, sizeof (name
),
3313 "%s@%s", zhp
->zfs_name
, dd
->snapname
);
3315 if (lzc_exists(name
))
3316 verify(nvlist_add_boolean(dd
->nvl
, name
) == 0);
3318 rv
= zfs_iter_filesystems(zhp
, zfs_check_snap_cb
, dd
);
3324 * Destroys all snapshots with the given name in zhp & descendants.
3327 zfs_destroy_snaps(zfs_handle_t
*zhp
, char *snapname
, boolean_t defer
)
3330 struct destroydata dd
= { 0 };
3332 dd
.snapname
= snapname
;
3333 verify(nvlist_alloc(&dd
.nvl
, NV_UNIQUE_NAME
, 0) == 0);
3334 (void) zfs_check_snap_cb(zfs_handle_dup(zhp
), &dd
);
3336 if (nvlist_empty(dd
.nvl
)) {
3337 ret
= zfs_standard_error_fmt(zhp
->zfs_hdl
, ENOENT
,
3338 dgettext(TEXT_DOMAIN
, "cannot destroy '%s@%s'"),
3339 zhp
->zfs_name
, snapname
);
3341 ret
= zfs_destroy_snaps_nvl(zhp
->zfs_hdl
, dd
.nvl
, defer
);
3343 nvlist_free(dd
.nvl
);
3348 * Destroys all the snapshots named in the nvlist.
3351 zfs_destroy_snaps_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
, boolean_t defer
)
3357 ret
= lzc_destroy_snaps(snaps
, defer
, &errlist
);
3362 if (nvlist_empty(errlist
)) {
3364 (void) snprintf(errbuf
, sizeof (errbuf
),
3365 dgettext(TEXT_DOMAIN
, "cannot destroy snapshots"));
3367 ret
= zfs_standard_error(hdl
, ret
, errbuf
);
3369 for (pair
= nvlist_next_nvpair(errlist
, NULL
);
3370 pair
!= NULL
; pair
= nvlist_next_nvpair(errlist
, pair
)) {
3372 (void) snprintf(errbuf
, sizeof (errbuf
),
3373 dgettext(TEXT_DOMAIN
, "cannot destroy snapshot %s"),
3376 switch (fnvpair_value_int32(pair
)) {
3379 dgettext(TEXT_DOMAIN
, "snapshot is cloned"));
3380 ret
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3383 ret
= zfs_standard_error(hdl
, errno
, errbuf
);
3392 * Clones the given dataset. The target must be of the same type as the source.
3395 zfs_clone(zfs_handle_t
*zhp
, const char *target
, nvlist_t
*props
)
3397 char parent
[ZFS_MAXNAMELEN
];
3400 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3403 assert(zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
);
3405 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3406 "cannot create '%s'"), target
);
3408 /* validate the target/clone name */
3409 if (!zfs_validate_name(hdl
, target
, ZFS_TYPE_FILESYSTEM
, B_TRUE
))
3410 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3412 /* validate parents exist */
3413 if (check_parents(hdl
, target
, &zoned
, B_FALSE
, NULL
) != 0)
3416 (void) parent_name(target
, parent
, sizeof (parent
));
3422 if (ZFS_IS_VOLUME(zhp
)) {
3423 type
= ZFS_TYPE_VOLUME
;
3425 type
= ZFS_TYPE_FILESYSTEM
;
3427 if ((props
= zfs_valid_proplist(hdl
, type
, props
, zoned
,
3428 zhp
, errbuf
)) == NULL
)
3432 ret
= lzc_clone(target
, zhp
->zfs_name
, props
);
3440 * The parent doesn't exist. We should have caught this
3441 * above, but there may a race condition that has since
3442 * destroyed the parent.
3444 * At this point, we don't know whether it's the source
3445 * that doesn't exist anymore, or whether the target
3446 * dataset doesn't exist.
3448 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
3449 "no such parent '%s'"), parent
);
3450 return (zfs_error(zhp
->zfs_hdl
, EZFS_NOENT
, errbuf
));
3453 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
3454 "source and target pools differ"));
3455 return (zfs_error(zhp
->zfs_hdl
, EZFS_CROSSTARGET
,
3459 return (zfs_standard_error(zhp
->zfs_hdl
, errno
,
3468 * Promotes the given clone fs to be the clone parent.
3471 zfs_promote(zfs_handle_t
*zhp
)
3473 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3474 zfs_cmd_t zc
= {"\0"};
3475 char parent
[MAXPATHLEN
];
3479 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3480 "cannot promote '%s'"), zhp
->zfs_name
);
3482 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
) {
3483 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3484 "snapshots can not be promoted"));
3485 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3488 (void) strlcpy(parent
, zhp
->zfs_dmustats
.dds_origin
, sizeof (parent
));
3489 if (parent
[0] == '\0') {
3490 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3491 "not a cloned filesystem"));
3492 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3495 (void) strlcpy(zc
.zc_value
, zhp
->zfs_dmustats
.dds_origin
,
3496 sizeof (zc
.zc_value
));
3497 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
3498 ret
= zfs_ioctl(hdl
, ZFS_IOC_PROMOTE
, &zc
);
3501 int save_errno
= errno
;
3503 switch (save_errno
) {
3505 /* There is a conflicting snapshot name. */
3506 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3507 "conflicting snapshot '%s' from parent '%s'"),
3508 zc
.zc_string
, parent
);
3509 return (zfs_error(hdl
, EZFS_EXISTS
, errbuf
));
3512 return (zfs_standard_error(hdl
, save_errno
, errbuf
));
3518 typedef struct snapdata
{
3520 const char *sd_snapname
;
3524 zfs_snapshot_cb(zfs_handle_t
*zhp
, void *arg
)
3526 snapdata_t
*sd
= arg
;
3527 char name
[ZFS_MAXNAMELEN
];
3530 if (zfs_prop_get_int(zhp
, ZFS_PROP_INCONSISTENT
) == 0) {
3531 (void) snprintf(name
, sizeof (name
),
3532 "%s@%s", zfs_get_name(zhp
), sd
->sd_snapname
);
3534 fnvlist_add_boolean(sd
->sd_nvl
, name
);
3536 rv
= zfs_iter_filesystems(zhp
, zfs_snapshot_cb
, sd
);
3544 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3548 zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
, nvlist_t
*props
)
3555 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3556 "cannot create snapshots "));
3559 while ((elem
= nvlist_next_nvpair(snaps
, elem
)) != NULL
) {
3560 const char *snapname
= nvpair_name(elem
);
3562 /* validate the target name */
3563 if (!zfs_validate_name(hdl
, snapname
, ZFS_TYPE_SNAPSHOT
,
3565 (void) snprintf(errbuf
, sizeof (errbuf
),
3566 dgettext(TEXT_DOMAIN
,
3567 "cannot create snapshot '%s'"), snapname
);
3568 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3572 if (props
!= NULL
&&
3573 (props
= zfs_valid_proplist(hdl
, ZFS_TYPE_SNAPSHOT
,
3574 props
, B_FALSE
, NULL
, errbuf
)) == NULL
) {
3578 ret
= lzc_snapshot(snaps
, props
, &errors
);
3581 boolean_t printed
= B_FALSE
;
3582 for (elem
= nvlist_next_nvpair(errors
, NULL
);
3584 elem
= nvlist_next_nvpair(errors
, elem
)) {
3585 (void) snprintf(errbuf
, sizeof (errbuf
),
3586 dgettext(TEXT_DOMAIN
,
3587 "cannot create snapshot '%s'"), nvpair_name(elem
));
3588 (void) zfs_standard_error(hdl
,
3589 fnvpair_value_int32(elem
), errbuf
);
3595 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3596 "multiple snapshots of same "
3598 (void) zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3602 (void) zfs_standard_error(hdl
, ret
, errbuf
);
3608 nvlist_free(errors
);
3613 zfs_snapshot(libzfs_handle_t
*hdl
, const char *path
, boolean_t recursive
,
3617 snapdata_t sd
= { 0 };
3618 char fsname
[ZFS_MAXNAMELEN
];
3623 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3624 "cannot snapshot %s"), path
);
3626 if (!zfs_validate_name(hdl
, path
, ZFS_TYPE_SNAPSHOT
, B_TRUE
))
3627 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3629 (void) strlcpy(fsname
, path
, sizeof (fsname
));
3630 cp
= strchr(fsname
, '@');
3632 sd
.sd_snapname
= cp
+ 1;
3634 if ((zhp
= zfs_open(hdl
, fsname
, ZFS_TYPE_FILESYSTEM
|
3635 ZFS_TYPE_VOLUME
)) == NULL
) {
3639 verify(nvlist_alloc(&sd
.sd_nvl
, NV_UNIQUE_NAME
, 0) == 0);
3641 (void) zfs_snapshot_cb(zfs_handle_dup(zhp
), &sd
);
3643 fnvlist_add_boolean(sd
.sd_nvl
, path
);
3646 ret
= zfs_snapshot_nvl(hdl
, sd
.sd_nvl
, props
);
3647 nvlist_free(sd
.sd_nvl
);
3653 * Destroy any more recent snapshots. We invoke this callback on any dependents
3654 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3655 * is a dependent and we should just destroy it without checking the transaction
3658 typedef struct rollback_data
{
3659 const char *cb_target
; /* the snapshot */
3660 uint64_t cb_create
; /* creation time reference */
3666 rollback_destroy_dependent(zfs_handle_t
*zhp
, void *data
)
3668 rollback_data_t
*cbp
= data
;
3669 prop_changelist_t
*clp
;
3671 /* We must destroy this clone; first unmount it */
3672 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
3673 cbp
->cb_force
? MS_FORCE
: 0);
3674 if (clp
== NULL
|| changelist_prefix(clp
) != 0) {
3675 cbp
->cb_error
= B_TRUE
;
3679 if (zfs_destroy(zhp
, B_FALSE
) != 0)
3680 cbp
->cb_error
= B_TRUE
;
3682 changelist_remove(clp
, zhp
->zfs_name
);
3683 (void) changelist_postfix(clp
);
3684 changelist_free(clp
);
3691 rollback_destroy(zfs_handle_t
*zhp
, void *data
)
3693 rollback_data_t
*cbp
= data
;
3695 if (zfs_prop_get_int(zhp
, ZFS_PROP_CREATETXG
) > cbp
->cb_create
) {
3696 cbp
->cb_error
|= zfs_iter_dependents(zhp
, B_FALSE
,
3697 rollback_destroy_dependent
, cbp
);
3699 cbp
->cb_error
|= zfs_destroy(zhp
, B_FALSE
);
3707 * Given a dataset, rollback to a specific snapshot, discarding any
3708 * data changes since then and making it the active dataset.
3710 * Any snapshots and bookmarks more recent than the target are
3711 * destroyed, along with their dependents (i.e. clones).
3714 zfs_rollback(zfs_handle_t
*zhp
, zfs_handle_t
*snap
, boolean_t force
)
3716 rollback_data_t cb
= { 0 };
3718 boolean_t restore_resv
= 0;
3719 uint64_t old_volsize
= 0, new_volsize
;
3720 zfs_prop_t resv_prop
= { 0 };
3722 assert(zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
||
3723 zhp
->zfs_type
== ZFS_TYPE_VOLUME
);
3726 * Destroy all recent snapshots and their dependents.
3728 cb
.cb_force
= force
;
3729 cb
.cb_target
= snap
->zfs_name
;
3730 cb
.cb_create
= zfs_prop_get_int(snap
, ZFS_PROP_CREATETXG
);
3731 (void) zfs_iter_snapshots(zhp
, B_FALSE
, rollback_destroy
, &cb
);
3732 (void) zfs_iter_bookmarks(zhp
, rollback_destroy
, &cb
);
3738 * Now that we have verified that the snapshot is the latest,
3739 * rollback to the given snapshot.
3742 if (zhp
->zfs_type
== ZFS_TYPE_VOLUME
) {
3743 if (zfs_which_resv_prop(zhp
, &resv_prop
) < 0)
3745 old_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
3747 (old_volsize
== zfs_prop_get_int(zhp
, resv_prop
));
3751 * We rely on zfs_iter_children() to verify that there are no
3752 * newer snapshots for the given dataset. Therefore, we can
3753 * simply pass the name on to the ioctl() call. There is still
3754 * an unlikely race condition where the user has taken a
3755 * snapshot since we verified that this was the most recent.
3757 err
= lzc_rollback(zhp
->zfs_name
, NULL
, 0);
3759 (void) zfs_standard_error_fmt(zhp
->zfs_hdl
, errno
,
3760 dgettext(TEXT_DOMAIN
, "cannot rollback '%s'"),
3766 * For volumes, if the pre-rollback volsize matched the pre-
3767 * rollback reservation and the volsize has changed then set
3768 * the reservation property to the post-rollback volsize.
3769 * Make a new handle since the rollback closed the dataset.
3771 if ((zhp
->zfs_type
== ZFS_TYPE_VOLUME
) &&
3772 (zhp
= make_dataset_handle(zhp
->zfs_hdl
, zhp
->zfs_name
))) {
3774 new_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
3775 if (old_volsize
!= new_volsize
)
3776 err
= zfs_prop_set_int(zhp
, resv_prop
,
3785 * Renames the given dataset.
3788 zfs_rename(zfs_handle_t
*zhp
, const char *target
, boolean_t recursive
,
3789 boolean_t force_unmount
)
3792 zfs_cmd_t zc
= {"\0"};
3794 prop_changelist_t
*cl
= NULL
;
3795 zfs_handle_t
*zhrp
= NULL
;
3796 char *parentname
= NULL
;
3797 char parent
[ZFS_MAXNAMELEN
];
3798 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3801 /* if we have the same exact name, just return success */
3802 if (strcmp(zhp
->zfs_name
, target
) == 0)
3805 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3806 "cannot rename to '%s'"), target
);
3809 * Make sure the target name is valid
3811 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
) {
3812 if ((strchr(target
, '@') == NULL
) ||
3815 * Snapshot target name is abbreviated,
3816 * reconstruct full dataset name
3818 (void) strlcpy(parent
, zhp
->zfs_name
,
3820 delim
= strchr(parent
, '@');
3821 if (strchr(target
, '@') == NULL
)
3825 (void) strlcat(parent
, target
, sizeof (parent
));
3829 * Make sure we're renaming within the same dataset.
3831 delim
= strchr(target
, '@');
3832 if (strncmp(zhp
->zfs_name
, target
, delim
- target
)
3833 != 0 || zhp
->zfs_name
[delim
- target
] != '@') {
3834 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3835 "snapshots must be part of same "
3837 return (zfs_error(hdl
, EZFS_CROSSTARGET
,
3841 if (!zfs_validate_name(hdl
, target
, zhp
->zfs_type
, B_TRUE
))
3842 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3845 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3846 "recursive rename must be a snapshot"));
3847 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3850 if (!zfs_validate_name(hdl
, target
, zhp
->zfs_type
, B_TRUE
))
3851 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3853 /* validate parents */
3854 if (check_parents(hdl
, target
, NULL
, B_FALSE
, NULL
) != 0)
3857 /* make sure we're in the same pool */
3858 verify((delim
= strchr(target
, '/')) != NULL
);
3859 if (strncmp(zhp
->zfs_name
, target
, delim
- target
) != 0 ||
3860 zhp
->zfs_name
[delim
- target
] != '/') {
3861 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3862 "datasets must be within same pool"));
3863 return (zfs_error(hdl
, EZFS_CROSSTARGET
, errbuf
));
3866 /* new name cannot be a child of the current dataset name */
3867 if (is_descendant(zhp
->zfs_name
, target
)) {
3868 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3869 "New dataset name cannot be a descendant of "
3870 "current dataset name"));
3871 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3875 (void) snprintf(errbuf
, sizeof (errbuf
),
3876 dgettext(TEXT_DOMAIN
, "cannot rename '%s'"), zhp
->zfs_name
);
3878 if (getzoneid() == GLOBAL_ZONEID
&&
3879 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
)) {
3880 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3881 "dataset is used in a non-global zone"));
3882 return (zfs_error(hdl
, EZFS_ZONED
, errbuf
));
3887 parentname
= zfs_strdup(zhp
->zfs_hdl
, zhp
->zfs_name
);
3888 if (parentname
== NULL
) {
3892 delim
= strchr(parentname
, '@');
3894 zhrp
= zfs_open(zhp
->zfs_hdl
, parentname
, ZFS_TYPE_DATASET
);
3901 if ((cl
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
3902 force_unmount
? MS_FORCE
: 0)) == NULL
)
3905 if (changelist_haszonedchild(cl
)) {
3906 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3907 "child dataset with inherited mountpoint is used "
3908 "in a non-global zone"));
3909 (void) zfs_error(hdl
, EZFS_ZONED
, errbuf
);
3914 if ((ret
= changelist_prefix(cl
)) != 0)
3918 if (ZFS_IS_VOLUME(zhp
))
3919 zc
.zc_objset_type
= DMU_OST_ZVOL
;
3921 zc
.zc_objset_type
= DMU_OST_ZFS
;
3923 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
3924 (void) strlcpy(zc
.zc_value
, target
, sizeof (zc
.zc_value
));
3926 zc
.zc_cookie
= recursive
;
3928 if ((ret
= zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_RENAME
, &zc
)) != 0) {
3930 * if it was recursive, the one that actually failed will
3933 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3934 "cannot rename '%s'"), zc
.zc_name
);
3936 if (recursive
&& errno
== EEXIST
) {
3937 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3938 "a child dataset already has a snapshot "
3939 "with the new name"));
3940 (void) zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3942 (void) zfs_standard_error(zhp
->zfs_hdl
, errno
, errbuf
);
3946 * On failure, we still want to remount any filesystems that
3947 * were previously mounted, so we don't alter the system state.
3950 (void) changelist_postfix(cl
);
3953 changelist_rename(cl
, zfs_get_name(zhp
), target
);
3954 ret
= changelist_postfix(cl
);
3966 changelist_free(cl
);
3972 zfs_get_user_props(zfs_handle_t
*zhp
)
3974 return (zhp
->zfs_user_props
);
3978 * This function is used by 'zfs list' to determine the exact set of columns to
3979 * display, and their maximum widths. This does two main things:
3981 * - If this is a list of all properties, then expand the list to include
3982 * all native properties, and set a flag so that for each dataset we look
3983 * for new unique user properties and add them to the list.
3985 * - For non fixed-width properties, keep track of the maximum width seen
3986 * so that we can size the column appropriately. If the user has
3987 * requested received property values, we also need to compute the width
3988 * of the RECEIVED column.
3991 zfs_expand_proplist(zfs_handle_t
*zhp
, zprop_list_t
**plp
, boolean_t received
,
3994 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3995 zprop_list_t
*entry
;
3996 zprop_list_t
**last
, **start
;
3997 nvlist_t
*userprops
, *propval
;
4000 char buf
[ZFS_MAXPROPLEN
];
4002 if (zprop_expand_list(hdl
, plp
, ZFS_TYPE_DATASET
) != 0)
4005 userprops
= zfs_get_user_props(zhp
);
4008 if (entry
->pl_all
&& nvlist_next_nvpair(userprops
, NULL
) != NULL
) {
4010 * Go through and add any user properties as necessary. We
4011 * start by incrementing our list pointer to the first
4012 * non-native property.
4015 while (*start
!= NULL
) {
4016 if ((*start
)->pl_prop
== ZPROP_INVAL
)
4018 start
= &(*start
)->pl_next
;
4022 while ((elem
= nvlist_next_nvpair(userprops
, elem
)) != NULL
) {
4024 * See if we've already found this property in our list.
4026 for (last
= start
; *last
!= NULL
;
4027 last
= &(*last
)->pl_next
) {
4028 if (strcmp((*last
)->pl_user_prop
,
4029 nvpair_name(elem
)) == 0)
4033 if (*last
== NULL
) {
4034 if ((entry
= zfs_alloc(hdl
,
4035 sizeof (zprop_list_t
))) == NULL
||
4036 ((entry
->pl_user_prop
= zfs_strdup(hdl
,
4037 nvpair_name(elem
)))) == NULL
) {
4042 entry
->pl_prop
= ZPROP_INVAL
;
4043 entry
->pl_width
= strlen(nvpair_name(elem
));
4044 entry
->pl_all
= B_TRUE
;
4051 * Now go through and check the width of any non-fixed columns
4053 for (entry
= *plp
; entry
!= NULL
; entry
= entry
->pl_next
) {
4054 if (entry
->pl_fixed
&& !literal
)
4057 if (entry
->pl_prop
!= ZPROP_INVAL
) {
4058 if (zfs_prop_get(zhp
, entry
->pl_prop
,
4059 buf
, sizeof (buf
), NULL
, NULL
, 0, literal
) == 0) {
4060 if (strlen(buf
) > entry
->pl_width
)
4061 entry
->pl_width
= strlen(buf
);
4063 if (received
&& zfs_prop_get_recvd(zhp
,
4064 zfs_prop_to_name(entry
->pl_prop
),
4065 buf
, sizeof (buf
), literal
) == 0)
4066 if (strlen(buf
) > entry
->pl_recvd_width
)
4067 entry
->pl_recvd_width
= strlen(buf
);
4069 if (nvlist_lookup_nvlist(userprops
, entry
->pl_user_prop
,
4071 verify(nvlist_lookup_string(propval
,
4072 ZPROP_VALUE
, &strval
) == 0);
4073 if (strlen(strval
) > entry
->pl_width
)
4074 entry
->pl_width
= strlen(strval
);
4076 if (received
&& zfs_prop_get_recvd(zhp
,
4077 entry
->pl_user_prop
,
4078 buf
, sizeof (buf
), literal
) == 0)
4079 if (strlen(buf
) > entry
->pl_recvd_width
)
4080 entry
->pl_recvd_width
= strlen(buf
);
4088 zfs_prune_proplist(zfs_handle_t
*zhp
, uint8_t *props
)
4093 * Keep a reference to the props-table against which we prune the
4096 zhp
->zfs_props_table
= props
;
4098 curr
= nvlist_next_nvpair(zhp
->zfs_props
, NULL
);
4101 zfs_prop_t zfs_prop
= zfs_name_to_prop(nvpair_name(curr
));
4102 nvpair_t
*next
= nvlist_next_nvpair(zhp
->zfs_props
, curr
);
4105 * User properties will result in ZPROP_INVAL, and since we
4106 * only know how to prune standard ZFS properties, we always
4107 * leave these in the list. This can also happen if we
4108 * encounter an unknown DSL property (when running older
4109 * software, for example).
4111 if (zfs_prop
!= ZPROP_INVAL
&& props
[zfs_prop
] == B_FALSE
)
4112 (void) nvlist_remove(zhp
->zfs_props
,
4113 nvpair_name(curr
), nvpair_type(curr
));
4119 zfs_smb_acl_mgmt(libzfs_handle_t
*hdl
, char *dataset
, char *path
,
4120 zfs_smb_acl_op_t cmd
, char *resource1
, char *resource2
)
4122 zfs_cmd_t zc
= {"\0"};
4123 nvlist_t
*nvlist
= NULL
;
4126 (void) strlcpy(zc
.zc_name
, dataset
, sizeof (zc
.zc_name
));
4127 (void) strlcpy(zc
.zc_value
, path
, sizeof (zc
.zc_value
));
4128 zc
.zc_cookie
= (uint64_t)cmd
;
4130 if (cmd
== ZFS_SMB_ACL_RENAME
) {
4131 if (nvlist_alloc(&nvlist
, NV_UNIQUE_NAME
, 0) != 0) {
4132 (void) no_memory(hdl
);
4138 case ZFS_SMB_ACL_ADD
:
4139 case ZFS_SMB_ACL_REMOVE
:
4140 (void) strlcpy(zc
.zc_string
, resource1
, sizeof (zc
.zc_string
));
4142 case ZFS_SMB_ACL_RENAME
:
4143 if (nvlist_add_string(nvlist
, ZFS_SMB_ACL_SRC
,
4145 (void) no_memory(hdl
);
4148 if (nvlist_add_string(nvlist
, ZFS_SMB_ACL_TARGET
,
4150 (void) no_memory(hdl
);
4153 if (zcmd_write_src_nvlist(hdl
, &zc
, nvlist
) != 0) {
4154 nvlist_free(nvlist
);
4158 case ZFS_SMB_ACL_PURGE
:
4163 error
= ioctl(hdl
->libzfs_fd
, ZFS_IOC_SMB_ACL
, &zc
);
4165 nvlist_free(nvlist
);
4170 zfs_smb_acl_add(libzfs_handle_t
*hdl
, char *dataset
,
4171 char *path
, char *resource
)
4173 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_ADD
,
4178 zfs_smb_acl_remove(libzfs_handle_t
*hdl
, char *dataset
,
4179 char *path
, char *resource
)
4181 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_REMOVE
,
4186 zfs_smb_acl_purge(libzfs_handle_t
*hdl
, char *dataset
, char *path
)
4188 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_PURGE
,
4193 zfs_smb_acl_rename(libzfs_handle_t
*hdl
, char *dataset
, char *path
,
4194 char *oldname
, char *newname
)
4196 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_RENAME
,
4201 zfs_userspace(zfs_handle_t
*zhp
, zfs_userquota_prop_t type
,
4202 zfs_userspace_cb_t func
, void *arg
)
4204 zfs_cmd_t zc
= {"\0"};
4205 zfs_useracct_t buf
[100];
4206 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4209 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
4211 zc
.zc_objset_type
= type
;
4212 zc
.zc_nvlist_dst
= (uintptr_t)buf
;
4215 zfs_useracct_t
*zua
= buf
;
4217 zc
.zc_nvlist_dst_size
= sizeof (buf
);
4218 if (zfs_ioctl(hdl
, ZFS_IOC_USERSPACE_MANY
, &zc
) != 0) {
4219 char errbuf
[ZFS_MAXNAMELEN
+ 32];
4221 (void) snprintf(errbuf
, sizeof (errbuf
),
4222 dgettext(TEXT_DOMAIN
,
4223 "cannot get used/quota for %s"), zc
.zc_name
);
4224 return (zfs_standard_error_fmt(hdl
, errno
, errbuf
));
4226 if (zc
.zc_nvlist_dst_size
== 0)
4229 while (zc
.zc_nvlist_dst_size
> 0) {
4230 if ((ret
= func(arg
, zua
->zu_domain
, zua
->zu_rid
,
4231 zua
->zu_space
)) != 0)
4234 zc
.zc_nvlist_dst_size
-= sizeof (zfs_useracct_t
);
4243 const char *snapname
;
4245 boolean_t recursive
;
4250 zfs_hold_one(zfs_handle_t
*zhp
, void *arg
)
4252 struct holdarg
*ha
= arg
;
4253 char name
[ZFS_MAXNAMELEN
];
4256 (void) snprintf(name
, sizeof (name
),
4257 "%s@%s", zhp
->zfs_name
, ha
->snapname
);
4259 if (lzc_exists(name
))
4260 fnvlist_add_string(ha
->nvl
, name
, ha
->tag
);
4263 rv
= zfs_iter_filesystems(zhp
, zfs_hold_one
, ha
);
4269 zfs_hold(zfs_handle_t
*zhp
, const char *snapname
, const char *tag
,
4270 boolean_t recursive
, int cleanup_fd
)
4275 ha
.nvl
= fnvlist_alloc();
4276 ha
.snapname
= snapname
;
4278 ha
.recursive
= recursive
;
4279 (void) zfs_hold_one(zfs_handle_dup(zhp
), &ha
);
4281 if (nvlist_empty(ha
.nvl
)) {
4284 fnvlist_free(ha
.nvl
);
4286 (void) snprintf(errbuf
, sizeof (errbuf
),
4287 dgettext(TEXT_DOMAIN
,
4288 "cannot hold snapshot '%s@%s'"),
4289 zhp
->zfs_name
, snapname
);
4290 (void) zfs_standard_error(zhp
->zfs_hdl
, ret
, errbuf
);
4294 ret
= zfs_hold_nvl(zhp
, cleanup_fd
, ha
.nvl
);
4295 fnvlist_free(ha
.nvl
);
4301 zfs_hold_nvl(zfs_handle_t
*zhp
, int cleanup_fd
, nvlist_t
*holds
)
4305 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4310 ret
= lzc_hold(holds
, cleanup_fd
, &errors
);
4313 /* There may be errors even in the success case. */
4314 fnvlist_free(errors
);
4318 if (nvlist_empty(errors
)) {
4319 /* no hold-specific errors */
4320 (void) snprintf(errbuf
, sizeof (errbuf
),
4321 dgettext(TEXT_DOMAIN
, "cannot hold"));
4324 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4325 "pool must be upgraded"));
4326 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4329 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4332 (void) zfs_standard_error(hdl
, ret
, errbuf
);
4336 for (elem
= nvlist_next_nvpair(errors
, NULL
);
4338 elem
= nvlist_next_nvpair(errors
, elem
)) {
4339 (void) snprintf(errbuf
, sizeof (errbuf
),
4340 dgettext(TEXT_DOMAIN
,
4341 "cannot hold snapshot '%s'"), nvpair_name(elem
));
4342 switch (fnvpair_value_int32(elem
)) {
4345 * Temporary tags wind up having the ds object id
4346 * prepended. So even if we passed the length check
4347 * above, it's still possible for the tag to wind
4348 * up being slightly too long.
4350 (void) zfs_error(hdl
, EZFS_TAGTOOLONG
, errbuf
);
4353 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4356 (void) zfs_error(hdl
, EZFS_REFTAG_HOLD
, errbuf
);
4359 (void) zfs_standard_error(hdl
,
4360 fnvpair_value_int32(elem
), errbuf
);
4364 fnvlist_free(errors
);
4369 zfs_release_one(zfs_handle_t
*zhp
, void *arg
)
4371 struct holdarg
*ha
= arg
;
4372 char name
[ZFS_MAXNAMELEN
];
4374 nvlist_t
*existing_holds
;
4376 (void) snprintf(name
, sizeof (name
),
4377 "%s@%s", zhp
->zfs_name
, ha
->snapname
);
4379 if (lzc_get_holds(name
, &existing_holds
) != 0) {
4381 } else if (!nvlist_exists(existing_holds
, ha
->tag
)) {
4384 nvlist_t
*torelease
= fnvlist_alloc();
4385 fnvlist_add_boolean(torelease
, ha
->tag
);
4386 fnvlist_add_nvlist(ha
->nvl
, name
, torelease
);
4387 fnvlist_free(torelease
);
4391 rv
= zfs_iter_filesystems(zhp
, zfs_release_one
, ha
);
4397 zfs_release(zfs_handle_t
*zhp
, const char *snapname
, const char *tag
,
4398 boolean_t recursive
)
4402 nvlist_t
*errors
= NULL
;
4404 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4407 ha
.nvl
= fnvlist_alloc();
4408 ha
.snapname
= snapname
;
4410 ha
.recursive
= recursive
;
4412 (void) zfs_release_one(zfs_handle_dup(zhp
), &ha
);
4414 if (nvlist_empty(ha
.nvl
)) {
4415 fnvlist_free(ha
.nvl
);
4417 (void) snprintf(errbuf
, sizeof (errbuf
),
4418 dgettext(TEXT_DOMAIN
,
4419 "cannot release hold from snapshot '%s@%s'"),
4420 zhp
->zfs_name
, snapname
);
4422 (void) zfs_error(hdl
, EZFS_REFTAG_RELE
, errbuf
);
4424 (void) zfs_standard_error(hdl
, ret
, errbuf
);
4429 ret
= lzc_release(ha
.nvl
, &errors
);
4430 fnvlist_free(ha
.nvl
);
4433 /* There may be errors even in the success case. */
4434 fnvlist_free(errors
);
4438 if (nvlist_empty(errors
)) {
4439 /* no hold-specific errors */
4440 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4444 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4445 "pool must be upgraded"));
4446 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4449 (void) zfs_standard_error_fmt(hdl
, errno
, errbuf
);
4453 for (elem
= nvlist_next_nvpair(errors
, NULL
);
4455 elem
= nvlist_next_nvpair(errors
, elem
)) {
4456 (void) snprintf(errbuf
, sizeof (errbuf
),
4457 dgettext(TEXT_DOMAIN
,
4458 "cannot release hold from snapshot '%s'"),
4460 switch (fnvpair_value_int32(elem
)) {
4462 (void) zfs_error(hdl
, EZFS_REFTAG_RELE
, errbuf
);
4465 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4468 (void) zfs_standard_error_fmt(hdl
,
4469 fnvpair_value_int32(elem
), errbuf
);
4473 fnvlist_free(errors
);
4478 zfs_get_fsacl(zfs_handle_t
*zhp
, nvlist_t
**nvl
)
4480 zfs_cmd_t zc
= {"\0"};
4481 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4487 assert(zhp
->zfs_type
== ZFS_TYPE_VOLUME
||
4488 zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
);
4492 nvbuf
= malloc(nvsz
);
4493 if (nvbuf
== NULL
) {
4494 err
= (zfs_error(hdl
, EZFS_NOMEM
, strerror(errno
)));
4498 zc
.zc_nvlist_dst_size
= nvsz
;
4499 zc
.zc_nvlist_dst
= (uintptr_t)nvbuf
;
4501 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, ZFS_MAXNAMELEN
);
4503 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_GET_FSACL
, &zc
) != 0) {
4504 (void) snprintf(errbuf
, sizeof (errbuf
),
4505 dgettext(TEXT_DOMAIN
, "cannot get permissions on '%s'"),
4510 nvsz
= zc
.zc_nvlist_dst_size
;
4514 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4515 "pool must be upgraded"));
4516 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4519 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4522 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
4525 err
= zfs_standard_error_fmt(hdl
, errno
, errbuf
);
4530 int rc
= nvlist_unpack(nvbuf
, zc
.zc_nvlist_dst_size
, nvl
, 0);
4532 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(
4533 TEXT_DOMAIN
, "cannot get permissions on '%s'"),
4535 err
= zfs_standard_error_fmt(hdl
, rc
, errbuf
);
4545 zfs_set_fsacl(zfs_handle_t
*zhp
, boolean_t un
, nvlist_t
*nvl
)
4547 zfs_cmd_t zc
= {"\0"};
4548 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4554 assert(zhp
->zfs_type
== ZFS_TYPE_VOLUME
||
4555 zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
);
4557 err
= nvlist_size(nvl
, &nvsz
, NV_ENCODE_NATIVE
);
4560 nvbuf
= malloc(nvsz
);
4562 err
= nvlist_pack(nvl
, &nvbuf
, &nvsz
, NV_ENCODE_NATIVE
, 0);
4565 zc
.zc_nvlist_src_size
= nvsz
;
4566 zc
.zc_nvlist_src
= (uintptr_t)nvbuf
;
4567 zc
.zc_perm_action
= un
;
4569 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
4571 if (zfs_ioctl(hdl
, ZFS_IOC_SET_FSACL
, &zc
) != 0) {
4572 (void) snprintf(errbuf
, sizeof (errbuf
),
4573 dgettext(TEXT_DOMAIN
, "cannot set permissions on '%s'"),
4577 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4578 "pool must be upgraded"));
4579 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4582 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4585 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
4588 err
= zfs_standard_error_fmt(hdl
, errno
, errbuf
);
4599 zfs_get_holds(zfs_handle_t
*zhp
, nvlist_t
**nvl
)
4604 err
= lzc_get_holds(zhp
->zfs_name
, nvl
);
4607 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4609 (void) snprintf(errbuf
, sizeof (errbuf
),
4610 dgettext(TEXT_DOMAIN
, "cannot get holds for '%s'"),
4614 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4615 "pool must be upgraded"));
4616 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4619 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4622 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
4625 err
= zfs_standard_error_fmt(hdl
, errno
, errbuf
);
4634 * Convert the zvol's volume size to an appropriate reservation.
4635 * Note: If this routine is updated, it is necessary to update the ZFS test
4636 * suite's shell version in reservation.kshlib.
4639 zvol_volsize_to_reservation(uint64_t volsize
, nvlist_t
*props
)
4642 uint64_t nblocks
, volblocksize
;
4646 if (nvlist_lookup_string(props
,
4647 zfs_prop_to_name(ZFS_PROP_COPIES
), &strval
) == 0)
4648 ncopies
= atoi(strval
);
4651 if (nvlist_lookup_uint64(props
,
4652 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
4653 &volblocksize
) != 0)
4654 volblocksize
= ZVOL_DEFAULT_BLOCKSIZE
;
4655 nblocks
= volsize
/volblocksize
;
4656 /* start with metadnode L0-L6 */
4658 /* calculate number of indirects */
4659 while (nblocks
> 1) {
4660 nblocks
+= DNODES_PER_LEVEL
- 1;
4661 nblocks
/= DNODES_PER_LEVEL
;
4664 numdb
*= MIN(SPA_DVAS_PER_BP
, ncopies
+ 1);
4667 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4668 * compressed, but in practice they compress down to about
4671 numdb
*= 1ULL << DN_MAX_INDBLKSHIFT
;