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 "pool and or dataset must be upgraded to set this "
1451 "property or value"));
1452 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
1456 if (prop
== ZFS_PROP_COMPRESSION
||
1457 prop
== ZFS_PROP_RECORDSIZE
) {
1458 (void) zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1459 "property setting is not allowed on "
1460 "bootable datasets"));
1461 (void) zfs_error(hdl
, EZFS_NOTSUP
, errbuf
);
1463 (void) zfs_standard_error(hdl
, err
, errbuf
);
1468 if (prop
== ZPROP_INVAL
) {
1469 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1471 (void) zfs_standard_error(hdl
, err
, errbuf
);
1477 * This platform can't address a volume this big.
1480 if (prop
== ZFS_PROP_VOLSIZE
) {
1481 (void) zfs_error(hdl
, EZFS_VOLTOOBIG
, errbuf
);
1487 (void) zfs_standard_error(hdl
, err
, errbuf
);
1492 zfs_is_namespace_prop(zfs_prop_t prop
)
1496 case ZFS_PROP_ATIME
:
1497 case ZFS_PROP_RELATIME
:
1498 case ZFS_PROP_DEVICES
:
1500 case ZFS_PROP_SETUID
:
1501 case ZFS_PROP_READONLY
:
1502 case ZFS_PROP_XATTR
:
1503 case ZFS_PROP_NBMAND
:
1512 * Given a property name and value, set the property for the given dataset.
1515 zfs_prop_set(zfs_handle_t
*zhp
, const char *propname
, const char *propval
)
1517 zfs_cmd_t zc
= {"\0"};
1519 prop_changelist_t
*cl
= NULL
;
1521 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1522 nvlist_t
*nvl
= NULL
, *realprops
;
1524 boolean_t do_prefix
= B_TRUE
;
1527 (void) snprintf(errbuf
, sizeof (errbuf
),
1528 dgettext(TEXT_DOMAIN
, "cannot set property for '%s'"),
1531 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0 ||
1532 nvlist_add_string(nvl
, propname
, propval
) != 0) {
1533 (void) no_memory(hdl
);
1537 if ((realprops
= zfs_valid_proplist(hdl
, zhp
->zfs_type
, nvl
,
1538 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
), zhp
, errbuf
)) == NULL
)
1544 prop
= zfs_name_to_prop(propname
);
1546 if (prop
== ZFS_PROP_VOLSIZE
) {
1547 if ((added_resv
= zfs_add_synthetic_resv(zhp
, nvl
)) == -1)
1551 if ((cl
= changelist_gather(zhp
, prop
, 0, 0)) == NULL
)
1554 if (prop
== ZFS_PROP_MOUNTPOINT
&& changelist_haszonedchild(cl
)) {
1555 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1556 "child dataset with inherited mountpoint is used "
1557 "in a non-global zone"));
1558 ret
= zfs_error(hdl
, EZFS_ZONED
, errbuf
);
1563 * We don't want to unmount & remount the dataset when changing
1564 * its canmount property to 'on' or 'noauto'. We only use
1565 * the changelist logic to unmount when setting canmount=off.
1567 if (prop
== ZFS_PROP_CANMOUNT
) {
1569 int err
= zprop_string_to_index(prop
, propval
, &idx
,
1571 if (err
== 0 && idx
!= ZFS_CANMOUNT_OFF
)
1572 do_prefix
= B_FALSE
;
1575 if (do_prefix
&& (ret
= changelist_prefix(cl
)) != 0)
1579 * Execute the corresponding ioctl() to set this property.
1581 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1583 if (zcmd_write_src_nvlist(hdl
, &zc
, nvl
) != 0)
1586 ret
= zfs_ioctl(hdl
, ZFS_IOC_SET_PROP
, &zc
);
1589 zfs_setprop_error(hdl
, prop
, errno
, errbuf
);
1590 if (added_resv
&& errno
== ENOSPC
) {
1591 /* clean up the volsize property we tried to set */
1592 uint64_t old_volsize
= zfs_prop_get_int(zhp
,
1595 zcmd_free_nvlists(&zc
);
1596 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0)
1598 if (nvlist_add_uint64(nvl
,
1599 zfs_prop_to_name(ZFS_PROP_VOLSIZE
),
1602 if (zcmd_write_src_nvlist(hdl
, &zc
, nvl
) != 0)
1604 (void) zfs_ioctl(hdl
, ZFS_IOC_SET_PROP
, &zc
);
1608 ret
= changelist_postfix(cl
);
1612 * Refresh the statistics so the new property
1613 * value is reflected.
1615 (void) get_stats(zhp
);
1618 * Remount the filesystem to propagate the change
1619 * if one of the options handled by the generic
1620 * Linux namespace layer has been modified.
1622 if (zfs_is_namespace_prop(prop
) &&
1623 zfs_is_mounted(zhp
, NULL
))
1624 ret
= zfs_mount(zhp
, MNTOPT_REMOUNT
, 0);
1630 zcmd_free_nvlists(&zc
);
1632 changelist_free(cl
);
1637 * Given a property, inherit the value from the parent dataset, or if received
1638 * is TRUE, revert to the received value, if any.
1641 zfs_prop_inherit(zfs_handle_t
*zhp
, const char *propname
, boolean_t received
)
1643 zfs_cmd_t zc
= {"\0"};
1645 prop_changelist_t
*cl
;
1646 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1650 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1651 "cannot inherit %s for '%s'"), propname
, zhp
->zfs_name
);
1653 zc
.zc_cookie
= received
;
1654 if ((prop
= zfs_name_to_prop(propname
)) == ZPROP_INVAL
) {
1656 * For user properties, the amount of work we have to do is very
1657 * small, so just do it here.
1659 if (!zfs_prop_user(propname
)) {
1660 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1661 "invalid property"));
1662 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
1665 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1666 (void) strlcpy(zc
.zc_value
, propname
, sizeof (zc
.zc_value
));
1668 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_INHERIT_PROP
, &zc
) != 0)
1669 return (zfs_standard_error(hdl
, errno
, errbuf
));
1675 * Verify that this property is inheritable.
1677 if (zfs_prop_readonly(prop
))
1678 return (zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
));
1680 if (!zfs_prop_inheritable(prop
) && !received
)
1681 return (zfs_error(hdl
, EZFS_PROPNONINHERIT
, errbuf
));
1684 * Check to see if the value applies to this type
1686 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
))
1687 return (zfs_error(hdl
, EZFS_PROPTYPE
, errbuf
));
1690 * Normalize the name, to get rid of shorthand abbreviations.
1692 propname
= zfs_prop_to_name(prop
);
1693 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1694 (void) strlcpy(zc
.zc_value
, propname
, sizeof (zc
.zc_value
));
1696 if (prop
== ZFS_PROP_MOUNTPOINT
&& getzoneid() == GLOBAL_ZONEID
&&
1697 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
)) {
1698 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1699 "dataset is used in a non-global zone"));
1700 return (zfs_error(hdl
, EZFS_ZONED
, errbuf
));
1704 * Determine datasets which will be affected by this change, if any.
1706 if ((cl
= changelist_gather(zhp
, prop
, 0, 0)) == NULL
)
1709 if (prop
== ZFS_PROP_MOUNTPOINT
&& changelist_haszonedchild(cl
)) {
1710 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1711 "child dataset with inherited mountpoint is used "
1712 "in a non-global zone"));
1713 ret
= zfs_error(hdl
, EZFS_ZONED
, errbuf
);
1717 if ((ret
= changelist_prefix(cl
)) != 0)
1720 if ((ret
= zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_INHERIT_PROP
, &zc
)) != 0) {
1721 return (zfs_standard_error(hdl
, errno
, errbuf
));
1724 if ((ret
= changelist_postfix(cl
)) != 0)
1728 * Refresh the statistics so the new property is reflected.
1730 (void) get_stats(zhp
);
1733 * Remount the filesystem to propagate the change
1734 * if one of the options handled by the generic
1735 * Linux namespace layer has been modified.
1737 if (zfs_is_namespace_prop(prop
) &&
1738 zfs_is_mounted(zhp
, NULL
))
1739 ret
= zfs_mount(zhp
, MNTOPT_REMOUNT
, 0);
1743 changelist_free(cl
);
1748 * True DSL properties are stored in an nvlist. The following two functions
1749 * extract them appropriately.
1752 getprop_uint64(zfs_handle_t
*zhp
, zfs_prop_t prop
, char **source
)
1758 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
1759 zfs_prop_to_name(prop
), &nv
) == 0) {
1760 verify(nvlist_lookup_uint64(nv
, ZPROP_VALUE
, &value
) == 0);
1761 (void) nvlist_lookup_string(nv
, ZPROP_SOURCE
, source
);
1763 verify(!zhp
->zfs_props_table
||
1764 zhp
->zfs_props_table
[prop
] == B_TRUE
);
1765 value
= zfs_prop_default_numeric(prop
);
1773 getprop_string(zfs_handle_t
*zhp
, zfs_prop_t prop
, char **source
)
1779 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
1780 zfs_prop_to_name(prop
), &nv
) == 0) {
1781 verify(nvlist_lookup_string(nv
, ZPROP_VALUE
, &value
) == 0);
1782 (void) nvlist_lookup_string(nv
, ZPROP_SOURCE
, source
);
1784 verify(!zhp
->zfs_props_table
||
1785 zhp
->zfs_props_table
[prop
] == B_TRUE
);
1786 if ((value
= (char *)zfs_prop_default_string(prop
)) == NULL
)
1795 zfs_is_recvd_props_mode(zfs_handle_t
*zhp
)
1797 return (zhp
->zfs_props
== zhp
->zfs_recvd_props
);
1801 zfs_set_recvd_props_mode(zfs_handle_t
*zhp
, uint64_t *cookie
)
1803 *cookie
= (uint64_t)(uintptr_t)zhp
->zfs_props
;
1804 zhp
->zfs_props
= zhp
->zfs_recvd_props
;
1808 zfs_unset_recvd_props_mode(zfs_handle_t
*zhp
, uint64_t *cookie
)
1810 zhp
->zfs_props
= (nvlist_t
*)(uintptr_t)*cookie
;
1815 * Internal function for getting a numeric property. Both zfs_prop_get() and
1816 * zfs_prop_get_int() are built using this interface.
1818 * Certain properties can be overridden using 'mount -o'. In this case, scan
1819 * the contents of the /etc/mtab entry, searching for the appropriate options.
1820 * If they differ from the on-disk values, report the current values and mark
1821 * the source "temporary".
1824 get_numeric_property(zfs_handle_t
*zhp
, zfs_prop_t prop
, zprop_source_t
*src
,
1825 char **source
, uint64_t *val
)
1827 zfs_cmd_t zc
= {"\0"};
1828 nvlist_t
*zplprops
= NULL
;
1830 char *mntopt_on
= NULL
;
1831 char *mntopt_off
= NULL
;
1832 boolean_t received
= zfs_is_recvd_props_mode(zhp
);
1837 * If the property is being fetched for a snapshot, check whether
1838 * the property is valid for the snapshot's head dataset type.
1840 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
&&
1841 !zfs_prop_valid_for_type(prop
, zhp
->zfs_head_type
, B_TRUE
)) {
1842 *val
= zfs_prop_default_numeric(prop
);
1847 case ZFS_PROP_ATIME
:
1848 mntopt_on
= MNTOPT_ATIME
;
1849 mntopt_off
= MNTOPT_NOATIME
;
1852 case ZFS_PROP_RELATIME
:
1853 mntopt_on
= MNTOPT_RELATIME
;
1854 mntopt_off
= MNTOPT_NORELATIME
;
1857 case ZFS_PROP_DEVICES
:
1858 mntopt_on
= MNTOPT_DEVICES
;
1859 mntopt_off
= MNTOPT_NODEVICES
;
1863 mntopt_on
= MNTOPT_EXEC
;
1864 mntopt_off
= MNTOPT_NOEXEC
;
1867 case ZFS_PROP_READONLY
:
1868 mntopt_on
= MNTOPT_RO
;
1869 mntopt_off
= MNTOPT_RW
;
1872 case ZFS_PROP_SETUID
:
1873 mntopt_on
= MNTOPT_SETUID
;
1874 mntopt_off
= MNTOPT_NOSETUID
;
1877 case ZFS_PROP_XATTR
:
1878 mntopt_on
= MNTOPT_XATTR
;
1879 mntopt_off
= MNTOPT_NOXATTR
;
1882 case ZFS_PROP_NBMAND
:
1883 mntopt_on
= MNTOPT_NBMAND
;
1884 mntopt_off
= MNTOPT_NONBMAND
;
1891 * Because looking up the mount options is potentially expensive
1892 * (iterating over all of /etc/mtab), we defer its calculation until
1893 * we're looking up a property which requires its presence.
1895 if (!zhp
->zfs_mntcheck
&&
1896 (mntopt_on
!= NULL
|| prop
== ZFS_PROP_MOUNTED
)) {
1897 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1898 struct mnttab entry
;
1900 if (libzfs_mnttab_find(hdl
, zhp
->zfs_name
, &entry
) == 0) {
1901 zhp
->zfs_mntopts
= zfs_strdup(hdl
,
1903 if (zhp
->zfs_mntopts
== NULL
)
1907 zhp
->zfs_mntcheck
= B_TRUE
;
1910 if (zhp
->zfs_mntopts
== NULL
)
1911 mnt
.mnt_mntopts
= "";
1913 mnt
.mnt_mntopts
= zhp
->zfs_mntopts
;
1916 case ZFS_PROP_DEVICES
:
1918 case ZFS_PROP_READONLY
:
1919 case ZFS_PROP_SETUID
:
1920 case ZFS_PROP_XATTR
:
1921 case ZFS_PROP_NBMAND
:
1922 *val
= getprop_uint64(zhp
, prop
, source
);
1927 if (hasmntopt(&mnt
, mntopt_on
) && !*val
) {
1930 *src
= ZPROP_SRC_TEMPORARY
;
1931 } else if (hasmntopt(&mnt
, mntopt_off
) && *val
) {
1934 *src
= ZPROP_SRC_TEMPORARY
;
1938 case ZFS_PROP_ATIME
:
1939 case ZFS_PROP_RELATIME
:
1940 case ZFS_PROP_CANMOUNT
:
1941 case ZFS_PROP_VOLSIZE
:
1942 case ZFS_PROP_QUOTA
:
1943 case ZFS_PROP_REFQUOTA
:
1944 case ZFS_PROP_RESERVATION
:
1945 case ZFS_PROP_REFRESERVATION
:
1946 case ZFS_PROP_FILESYSTEM_LIMIT
:
1947 case ZFS_PROP_SNAPSHOT_LIMIT
:
1948 case ZFS_PROP_FILESYSTEM_COUNT
:
1949 case ZFS_PROP_SNAPSHOT_COUNT
:
1950 *val
= getprop_uint64(zhp
, prop
, source
);
1952 if (*source
== NULL
) {
1953 /* not default, must be local */
1954 *source
= zhp
->zfs_name
;
1958 case ZFS_PROP_MOUNTED
:
1959 *val
= (zhp
->zfs_mntopts
!= NULL
);
1962 case ZFS_PROP_NUMCLONES
:
1963 *val
= zhp
->zfs_dmustats
.dds_num_clones
;
1966 case ZFS_PROP_VERSION
:
1967 case ZFS_PROP_NORMALIZE
:
1968 case ZFS_PROP_UTF8ONLY
:
1970 if (zcmd_alloc_dst_nvlist(zhp
->zfs_hdl
, &zc
, 0) != 0)
1972 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1973 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_OBJSET_ZPLPROPS
, &zc
)) {
1974 zcmd_free_nvlists(&zc
);
1975 if (prop
== ZFS_PROP_VERSION
&&
1976 zhp
->zfs_type
== ZFS_TYPE_VOLUME
)
1977 *val
= zfs_prop_default_numeric(prop
);
1980 if (zcmd_read_dst_nvlist(zhp
->zfs_hdl
, &zc
, &zplprops
) != 0 ||
1981 nvlist_lookup_uint64(zplprops
, zfs_prop_to_name(prop
),
1983 zcmd_free_nvlists(&zc
);
1987 nvlist_free(zplprops
);
1988 zcmd_free_nvlists(&zc
);
1991 case ZFS_PROP_INCONSISTENT
:
1992 *val
= zhp
->zfs_dmustats
.dds_inconsistent
;
1996 switch (zfs_prop_get_type(prop
)) {
1997 case PROP_TYPE_NUMBER
:
1998 case PROP_TYPE_INDEX
:
1999 *val
= getprop_uint64(zhp
, prop
, source
);
2001 * If we tried to use a default value for a
2002 * readonly property, it means that it was not
2005 if (zfs_prop_readonly(prop
) &&
2006 *source
!= NULL
&& (*source
)[0] == '\0') {
2011 case PROP_TYPE_STRING
:
2013 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
2014 "cannot get non-numeric property"));
2015 return (zfs_error(zhp
->zfs_hdl
, EZFS_BADPROP
,
2016 dgettext(TEXT_DOMAIN
, "internal error")));
2024 * Calculate the source type, given the raw source string.
2027 get_source(zfs_handle_t
*zhp
, zprop_source_t
*srctype
, char *source
,
2028 char *statbuf
, size_t statlen
)
2030 if (statbuf
== NULL
|| *srctype
== ZPROP_SRC_TEMPORARY
)
2033 if (source
== NULL
) {
2034 *srctype
= ZPROP_SRC_NONE
;
2035 } else if (source
[0] == '\0') {
2036 *srctype
= ZPROP_SRC_DEFAULT
;
2037 } else if (strstr(source
, ZPROP_SOURCE_VAL_RECVD
) != NULL
) {
2038 *srctype
= ZPROP_SRC_RECEIVED
;
2040 if (strcmp(source
, zhp
->zfs_name
) == 0) {
2041 *srctype
= ZPROP_SRC_LOCAL
;
2043 (void) strlcpy(statbuf
, source
, statlen
);
2044 *srctype
= ZPROP_SRC_INHERITED
;
2051 zfs_prop_get_recvd(zfs_handle_t
*zhp
, const char *propname
, char *propbuf
,
2052 size_t proplen
, boolean_t literal
)
2057 if (zhp
->zfs_recvd_props
== NULL
)
2058 if (get_recvd_props_ioctl(zhp
) != 0)
2061 prop
= zfs_name_to_prop(propname
);
2063 if (prop
!= ZPROP_INVAL
) {
2065 if (!nvlist_exists(zhp
->zfs_recvd_props
, propname
))
2067 zfs_set_recvd_props_mode(zhp
, &cookie
);
2068 err
= zfs_prop_get(zhp
, prop
, propbuf
, proplen
,
2069 NULL
, NULL
, 0, literal
);
2070 zfs_unset_recvd_props_mode(zhp
, &cookie
);
2074 if (nvlist_lookup_nvlist(zhp
->zfs_recvd_props
,
2075 propname
, &propval
) != 0)
2077 verify(nvlist_lookup_string(propval
, ZPROP_VALUE
,
2079 (void) strlcpy(propbuf
, recvdval
, proplen
);
2082 return (err
== 0 ? 0 : -1);
2086 get_clones_string(zfs_handle_t
*zhp
, char *propbuf
, size_t proplen
)
2091 value
= zfs_get_clones_nvl(zhp
);
2096 for (pair
= nvlist_next_nvpair(value
, NULL
); pair
!= NULL
;
2097 pair
= nvlist_next_nvpair(value
, pair
)) {
2098 if (propbuf
[0] != '\0')
2099 (void) strlcat(propbuf
, ",", proplen
);
2100 (void) strlcat(propbuf
, nvpair_name(pair
), proplen
);
2106 struct get_clones_arg
{
2110 char buf
[ZFS_MAXNAMELEN
];
2114 get_clones_cb(zfs_handle_t
*zhp
, void *arg
)
2116 struct get_clones_arg
*gca
= arg
;
2118 if (gca
->numclones
== 0) {
2123 if (zfs_prop_get(zhp
, ZFS_PROP_ORIGIN
, gca
->buf
, sizeof (gca
->buf
),
2124 NULL
, NULL
, 0, B_TRUE
) != 0)
2126 if (strcmp(gca
->buf
, gca
->origin
) == 0) {
2127 fnvlist_add_boolean(gca
->value
, zfs_get_name(zhp
));
2132 (void) zfs_iter_children(zhp
, get_clones_cb
, gca
);
2138 zfs_get_clones_nvl(zfs_handle_t
*zhp
)
2140 nvlist_t
*nv
, *value
;
2142 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
2143 zfs_prop_to_name(ZFS_PROP_CLONES
), &nv
) != 0) {
2144 struct get_clones_arg gca
;
2147 * if this is a snapshot, then the kernel wasn't able
2148 * to get the clones. Do it by slowly iterating.
2150 if (zhp
->zfs_type
!= ZFS_TYPE_SNAPSHOT
)
2152 if (nvlist_alloc(&nv
, NV_UNIQUE_NAME
, 0) != 0)
2154 if (nvlist_alloc(&value
, NV_UNIQUE_NAME
, 0) != 0) {
2159 gca
.numclones
= zfs_prop_get_int(zhp
, ZFS_PROP_NUMCLONES
);
2161 gca
.origin
= zhp
->zfs_name
;
2163 if (gca
.numclones
!= 0) {
2165 char pool
[ZFS_MAXNAMELEN
];
2168 /* get the pool name */
2169 (void) strlcpy(pool
, zhp
->zfs_name
, sizeof (pool
));
2170 (void) strsep(&cp
, "/@");
2171 root
= zfs_open(zhp
->zfs_hdl
, pool
,
2172 ZFS_TYPE_FILESYSTEM
);
2174 (void) get_clones_cb(root
, &gca
);
2177 if (gca
.numclones
!= 0 ||
2178 nvlist_add_nvlist(nv
, ZPROP_VALUE
, value
) != 0 ||
2179 nvlist_add_nvlist(zhp
->zfs_props
,
2180 zfs_prop_to_name(ZFS_PROP_CLONES
), nv
) != 0) {
2187 verify(0 == nvlist_lookup_nvlist(zhp
->zfs_props
,
2188 zfs_prop_to_name(ZFS_PROP_CLONES
), &nv
));
2191 verify(nvlist_lookup_nvlist(nv
, ZPROP_VALUE
, &value
) == 0);
2197 * Retrieve a property from the given object. If 'literal' is specified, then
2198 * numbers are left as exact values. Otherwise, numbers are converted to a
2199 * human-readable form.
2201 * Returns 0 on success, or -1 on error.
2204 zfs_prop_get(zfs_handle_t
*zhp
, zfs_prop_t prop
, char *propbuf
, size_t proplen
,
2205 zprop_source_t
*src
, char *statbuf
, size_t statlen
, boolean_t literal
)
2207 char *source
= NULL
;
2211 boolean_t received
= zfs_is_recvd_props_mode(zhp
);
2214 * Check to see if this property applies to our object
2216 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
))
2219 if (received
&& zfs_prop_readonly(prop
))
2223 *src
= ZPROP_SRC_NONE
;
2226 case ZFS_PROP_CREATION
:
2228 * 'creation' is a time_t stored in the statistics. We convert
2229 * this into a string unless 'literal' is specified.
2232 val
= getprop_uint64(zhp
, prop
, &source
);
2233 time_t time
= (time_t)val
;
2237 localtime_r(&time
, &t
) == NULL
||
2238 strftime(propbuf
, proplen
, "%a %b %e %k:%M %Y",
2240 (void) snprintf(propbuf
, proplen
, "%llu",
2241 (u_longlong_t
) val
);
2245 case ZFS_PROP_MOUNTPOINT
:
2247 * Getting the precise mountpoint can be tricky.
2249 * - for 'none' or 'legacy', return those values.
2250 * - for inherited mountpoints, we want to take everything
2251 * after our ancestor and append it to the inherited value.
2253 * If the pool has an alternate root, we want to prepend that
2254 * root to any values we return.
2257 str
= getprop_string(zhp
, prop
, &source
);
2259 if (str
[0] == '/') {
2260 char buf
[MAXPATHLEN
];
2262 const char *relpath
;
2265 * If we inherit the mountpoint, even from a dataset
2266 * with a received value, the source will be the path of
2267 * the dataset we inherit from. If source is
2268 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2271 if (strcmp(source
, ZPROP_SOURCE_VAL_RECVD
) == 0) {
2274 relpath
= zhp
->zfs_name
+ strlen(source
);
2275 if (relpath
[0] == '/')
2279 if ((zpool_get_prop(zhp
->zpool_hdl
,
2280 ZPOOL_PROP_ALTROOT
, buf
, MAXPATHLEN
, NULL
)) ||
2281 (strcmp(root
, "-") == 0))
2284 * Special case an alternate root of '/'. This will
2285 * avoid having multiple leading slashes in the
2288 if (strcmp(root
, "/") == 0)
2292 * If the mountpoint is '/' then skip over this
2293 * if we are obtaining either an alternate root or
2294 * an inherited mountpoint.
2296 if (str
[1] == '\0' && (root
[0] != '\0' ||
2297 relpath
[0] != '\0'))
2300 if (relpath
[0] == '\0')
2301 (void) snprintf(propbuf
, proplen
, "%s%s",
2304 (void) snprintf(propbuf
, proplen
, "%s%s%s%s",
2305 root
, str
, relpath
[0] == '@' ? "" : "/",
2308 /* 'legacy' or 'none' */
2309 (void) strlcpy(propbuf
, str
, proplen
);
2314 case ZFS_PROP_ORIGIN
:
2315 (void) strlcpy(propbuf
, getprop_string(zhp
, prop
, &source
),
2318 * If there is no parent at all, return failure to indicate that
2319 * it doesn't apply to this dataset.
2321 if (propbuf
[0] == '\0')
2325 case ZFS_PROP_CLONES
:
2326 if (get_clones_string(zhp
, propbuf
, proplen
) != 0)
2330 case ZFS_PROP_QUOTA
:
2331 case ZFS_PROP_REFQUOTA
:
2332 case ZFS_PROP_RESERVATION
:
2333 case ZFS_PROP_REFRESERVATION
:
2335 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2339 * If quota or reservation is 0, we translate this into 'none'
2340 * (unless literal is set), and indicate that it's the default
2341 * value. Otherwise, we print the number nicely and indicate
2342 * that its set locally.
2346 (void) strlcpy(propbuf
, "0", proplen
);
2348 (void) strlcpy(propbuf
, "none", proplen
);
2351 (void) snprintf(propbuf
, proplen
, "%llu",
2354 zfs_nicenum(val
, propbuf
, proplen
);
2358 case ZFS_PROP_FILESYSTEM_LIMIT
:
2359 case ZFS_PROP_SNAPSHOT_LIMIT
:
2360 case ZFS_PROP_FILESYSTEM_COUNT
:
2361 case ZFS_PROP_SNAPSHOT_COUNT
:
2363 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2367 * If limit is UINT64_MAX, we translate this into 'none' (unless
2368 * literal is set), and indicate that it's the default value.
2369 * Otherwise, we print the number nicely and indicate that it's
2373 (void) snprintf(propbuf
, proplen
, "%llu",
2375 } else if (val
== UINT64_MAX
) {
2376 (void) strlcpy(propbuf
, "none", proplen
);
2378 zfs_nicenum(val
, propbuf
, proplen
);
2382 case ZFS_PROP_REFRATIO
:
2383 case ZFS_PROP_COMPRESSRATIO
:
2384 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2386 (void) snprintf(propbuf
, proplen
, "%llu.%02llux",
2387 (u_longlong_t
)(val
/ 100),
2388 (u_longlong_t
)(val
% 100));
2392 switch (zhp
->zfs_type
) {
2393 case ZFS_TYPE_FILESYSTEM
:
2396 case ZFS_TYPE_VOLUME
:
2399 case ZFS_TYPE_SNAPSHOT
:
2402 case ZFS_TYPE_BOOKMARK
:
2408 (void) snprintf(propbuf
, proplen
, "%s", str
);
2411 case ZFS_PROP_MOUNTED
:
2413 * The 'mounted' property is a pseudo-property that described
2414 * whether the filesystem is currently mounted. Even though
2415 * it's a boolean value, the typical values of "on" and "off"
2416 * don't make sense, so we translate to "yes" and "no".
2418 if (get_numeric_property(zhp
, ZFS_PROP_MOUNTED
,
2419 src
, &source
, &val
) != 0)
2422 (void) strlcpy(propbuf
, "yes", proplen
);
2424 (void) strlcpy(propbuf
, "no", proplen
);
2429 * The 'name' property is a pseudo-property derived from the
2430 * dataset name. It is presented as a real property to simplify
2433 (void) strlcpy(propbuf
, zhp
->zfs_name
, proplen
);
2436 case ZFS_PROP_MLSLABEL
:
2438 #ifdef HAVE_MLSLABEL
2439 m_label_t
*new_sl
= NULL
;
2440 char *ascii
= NULL
; /* human readable label */
2442 (void) strlcpy(propbuf
,
2443 getprop_string(zhp
, prop
, &source
), proplen
);
2445 if (literal
|| (strcasecmp(propbuf
,
2446 ZFS_MLSLABEL_DEFAULT
) == 0))
2450 * Try to translate the internal hex string to
2451 * human-readable output. If there are any
2452 * problems just use the hex string.
2455 if (str_to_label(propbuf
, &new_sl
, MAC_LABEL
,
2456 L_NO_CORRECTION
, NULL
) == -1) {
2457 m_label_free(new_sl
);
2461 if (label_to_str(new_sl
, &ascii
, M_LABEL
,
2465 m_label_free(new_sl
);
2468 m_label_free(new_sl
);
2470 (void) strlcpy(propbuf
, ascii
, proplen
);
2473 (void) strlcpy(propbuf
,
2474 getprop_string(zhp
, prop
, &source
), proplen
);
2475 #endif /* HAVE_MLSLABEL */
2481 * GUIDs are stored as numbers, but they are identifiers.
2482 * We don't want them to be pretty printed, because pretty
2483 * printing mangles the ID into a truncated and useless value.
2485 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2487 (void) snprintf(propbuf
, proplen
, "%llu", (u_longlong_t
)val
);
2491 switch (zfs_prop_get_type(prop
)) {
2492 case PROP_TYPE_NUMBER
:
2493 if (get_numeric_property(zhp
, prop
, src
,
2494 &source
, &val
) != 0)
2497 (void) snprintf(propbuf
, proplen
, "%llu",
2500 zfs_nicenum(val
, propbuf
, proplen
);
2503 case PROP_TYPE_STRING
:
2504 (void) strlcpy(propbuf
,
2505 getprop_string(zhp
, prop
, &source
), proplen
);
2508 case PROP_TYPE_INDEX
:
2509 if (get_numeric_property(zhp
, prop
, src
,
2510 &source
, &val
) != 0)
2512 if (zfs_prop_index_to_string(prop
, val
, &strval
) != 0)
2514 (void) strlcpy(propbuf
, strval
, proplen
);
2522 get_source(zhp
, src
, source
, statbuf
, statlen
);
2528 * Utility function to get the given numeric property. Does no validation that
2529 * the given property is the appropriate type; should only be used with
2530 * hard-coded property types.
2533 zfs_prop_get_int(zfs_handle_t
*zhp
, zfs_prop_t prop
)
2538 (void) get_numeric_property(zhp
, prop
, NULL
, &source
, &val
);
2544 zfs_prop_set_int(zfs_handle_t
*zhp
, zfs_prop_t prop
, uint64_t val
)
2548 (void) snprintf(buf
, sizeof (buf
), "%llu", (longlong_t
)val
);
2549 return (zfs_prop_set(zhp
, zfs_prop_to_name(prop
), buf
));
2553 * Similar to zfs_prop_get(), but returns the value as an integer.
2556 zfs_prop_get_numeric(zfs_handle_t
*zhp
, zfs_prop_t prop
, uint64_t *value
,
2557 zprop_source_t
*src
, char *statbuf
, size_t statlen
)
2562 * Check to see if this property applies to our object
2564 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
)) {
2565 return (zfs_error_fmt(zhp
->zfs_hdl
, EZFS_PROPTYPE
,
2566 dgettext(TEXT_DOMAIN
, "cannot get property '%s'"),
2567 zfs_prop_to_name(prop
)));
2571 *src
= ZPROP_SRC_NONE
;
2573 if (get_numeric_property(zhp
, prop
, src
, &source
, value
) != 0)
2576 get_source(zhp
, src
, source
, statbuf
, statlen
);
2583 idmap_id_to_numeric_domain_rid(uid_t id
, boolean_t isuser
,
2584 char **domainp
, idmap_rid_t
*ridp
)
2586 idmap_get_handle_t
*get_hdl
= NULL
;
2590 if (idmap_get_create(&get_hdl
) != IDMAP_SUCCESS
)
2594 err
= idmap_get_sidbyuid(get_hdl
, id
,
2595 IDMAP_REQ_FLG_USE_CACHE
, domainp
, ridp
, &status
);
2597 err
= idmap_get_sidbygid(get_hdl
, id
,
2598 IDMAP_REQ_FLG_USE_CACHE
, domainp
, ridp
, &status
);
2600 if (err
== IDMAP_SUCCESS
&&
2601 idmap_get_mappings(get_hdl
) == IDMAP_SUCCESS
&&
2602 status
== IDMAP_SUCCESS
)
2608 idmap_get_destroy(get_hdl
);
2611 #endif /* HAVE_IDMAP */
2614 * convert the propname into parameters needed by kernel
2615 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2616 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2617 * Eg: groupquota@staff -> ZFS_PROP_GROUPQUOTA, "", 1234
2618 * Eg: groupused@staff -> ZFS_PROP_GROUPUSED, "", 1234
2621 userquota_propname_decode(const char *propname
, boolean_t zoned
,
2622 zfs_userquota_prop_t
*typep
, char *domain
, int domainlen
, uint64_t *ridp
)
2624 zfs_userquota_prop_t type
;
2633 /* Figure out the property type ({user|group}{quota|space}) */
2634 for (type
= 0; type
< ZFS_NUM_USERQUOTA_PROPS
; type
++) {
2635 if (strncmp(propname
, zfs_userquota_prop_prefixes
[type
],
2636 strlen(zfs_userquota_prop_prefixes
[type
])) == 0)
2639 if (type
== ZFS_NUM_USERQUOTA_PROPS
)
2643 isuser
= (type
== ZFS_PROP_USERQUOTA
|| type
== ZFS_PROP_USERUSED
);
2644 isgroup
= (type
== ZFS_PROP_GROUPQUOTA
|| type
== ZFS_PROP_GROUPUSED
);
2646 cp
= strchr(propname
, '@') + 1;
2648 if (isuser
&& (pw
= getpwnam(cp
)) != NULL
) {
2649 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
2652 } else if (isgroup
&& (gr
= getgrnam(cp
)) != NULL
) {
2653 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
2656 } else if (strchr(cp
, '@')) {
2659 * It's a SID name (eg "user@domain") that needs to be
2660 * turned into S-1-domainID-RID.
2662 directory_error_t e
;
2663 char *numericsid
= NULL
;
2666 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
2669 e
= directory_sid_from_user_name(NULL
,
2672 e
= directory_sid_from_group_name(NULL
,
2676 directory_error_free(e
);
2679 if (numericsid
== NULL
)
2682 (void) strlcpy(domain
, cp
, domainlen
);
2683 cp
= strrchr(domain
, '-');
2688 *ridp
= strtoull(cp
, &end
, 10);
2691 if (errno
!= 0 || *end
!= '\0')
2695 #endif /* HAVE_IDMAP */
2697 /* It's a user/group ID (eg "12345"). */
2700 id
= strtoul(cp
, &end
, 10);
2705 /* It's an ephemeral ID. */
2709 if (idmap_id_to_numeric_domain_rid(id
, isuser
,
2710 &mapdomain
, &rid
) != 0)
2712 (void) strlcpy(domain
, mapdomain
, domainlen
);
2716 #endif /* HAVE_IDMAP */
2726 zfs_prop_get_userquota_common(zfs_handle_t
*zhp
, const char *propname
,
2727 uint64_t *propvalue
, zfs_userquota_prop_t
*typep
)
2730 zfs_cmd_t zc
= {"\0"};
2732 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
2734 err
= userquota_propname_decode(propname
,
2735 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
),
2736 typep
, zc
.zc_value
, sizeof (zc
.zc_value
), &zc
.zc_guid
);
2737 zc
.zc_objset_type
= *typep
;
2741 err
= ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_USERSPACE_ONE
, &zc
);
2745 *propvalue
= zc
.zc_cookie
;
2750 zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
2751 uint64_t *propvalue
)
2753 zfs_userquota_prop_t type
;
2755 return (zfs_prop_get_userquota_common(zhp
, propname
, propvalue
,
2760 zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
2761 char *propbuf
, int proplen
, boolean_t literal
)
2765 zfs_userquota_prop_t type
;
2767 err
= zfs_prop_get_userquota_common(zhp
, propname
, &propvalue
,
2774 (void) snprintf(propbuf
, proplen
, "%llu",
2775 (u_longlong_t
)propvalue
);
2776 } else if (propvalue
== 0 &&
2777 (type
== ZFS_PROP_USERQUOTA
|| type
== ZFS_PROP_GROUPQUOTA
)) {
2778 (void) strlcpy(propbuf
, "none", proplen
);
2780 zfs_nicenum(propvalue
, propbuf
, proplen
);
2786 zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
2787 uint64_t *propvalue
)
2790 zfs_cmd_t zc
= {"\0"};
2791 const char *snapname
;
2793 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
2795 snapname
= strchr(propname
, '@') + 1;
2796 if (strchr(snapname
, '@')) {
2797 (void) strlcpy(zc
.zc_value
, snapname
, sizeof (zc
.zc_value
));
2799 /* snapname is the short name, append it to zhp's fsname */
2802 (void) strlcpy(zc
.zc_value
, zhp
->zfs_name
,
2803 sizeof (zc
.zc_value
));
2804 cp
= strchr(zc
.zc_value
, '@');
2807 (void) strlcat(zc
.zc_value
, "@", sizeof (zc
.zc_value
));
2808 (void) strlcat(zc
.zc_value
, snapname
, sizeof (zc
.zc_value
));
2811 err
= ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_SPACE_WRITTEN
, &zc
);
2815 *propvalue
= zc
.zc_cookie
;
2820 zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
2821 char *propbuf
, int proplen
, boolean_t literal
)
2826 err
= zfs_prop_get_written_int(zhp
, propname
, &propvalue
);
2832 (void) snprintf(propbuf
, proplen
, "%llu",
2833 (u_longlong_t
)propvalue
);
2835 zfs_nicenum(propvalue
, propbuf
, proplen
);
2842 * Returns the name of the given zfs handle.
2845 zfs_get_name(const zfs_handle_t
*zhp
)
2847 return (zhp
->zfs_name
);
2851 * Returns the type of the given zfs handle.
2854 zfs_get_type(const zfs_handle_t
*zhp
)
2856 return (zhp
->zfs_type
);
2860 * Is one dataset name a child dataset of another?
2862 * Needs to handle these cases:
2863 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2864 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2865 * Descendant? No. No. No. Yes.
2868 is_descendant(const char *ds1
, const char *ds2
)
2870 size_t d1len
= strlen(ds1
);
2872 /* ds2 can't be a descendant if it's smaller */
2873 if (strlen(ds2
) < d1len
)
2876 /* otherwise, compare strings and verify that there's a '/' char */
2877 return (ds2
[d1len
] == '/' && (strncmp(ds1
, ds2
, d1len
) == 0));
2881 * Given a complete name, return just the portion that refers to the parent.
2882 * Will return -1 if there is no parent (path is just the name of the
2886 parent_name(const char *path
, char *buf
, size_t buflen
)
2890 (void) strlcpy(buf
, path
, buflen
);
2892 if ((slashp
= strrchr(buf
, '/')) == NULL
)
2900 * If accept_ancestor is false, then check to make sure that the given path has
2901 * a parent, and that it exists. If accept_ancestor is true, then find the
2902 * closest existing ancestor for the given path. In prefixlen return the
2903 * length of already existing prefix of the given path. We also fetch the
2904 * 'zoned' property, which is used to validate property settings when creating
2908 check_parents(libzfs_handle_t
*hdl
, const char *path
, uint64_t *zoned
,
2909 boolean_t accept_ancestor
, int *prefixlen
)
2911 zfs_cmd_t zc
= {"\0"};
2912 char parent
[ZFS_MAXNAMELEN
];
2918 (void) snprintf(errbuf
, sizeof (errbuf
),
2919 dgettext(TEXT_DOMAIN
, "cannot create '%s'"), path
);
2921 /* get parent, and check to see if this is just a pool */
2922 if (parent_name(path
, parent
, sizeof (parent
)) != 0) {
2923 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2924 "missing dataset name"));
2925 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
2928 /* check to see if the pool exists */
2929 if ((slash
= strchr(parent
, '/')) == NULL
)
2930 slash
= parent
+ strlen(parent
);
2931 (void) strncpy(zc
.zc_name
, parent
, slash
- parent
);
2932 zc
.zc_name
[slash
- parent
] = '\0';
2933 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_OBJSET_STATS
, &zc
) != 0 &&
2935 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2936 "no such pool '%s'"), zc
.zc_name
);
2937 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
2940 /* check to see if the parent dataset exists */
2941 while ((zhp
= make_dataset_handle(hdl
, parent
)) == NULL
) {
2942 if (errno
== ENOENT
&& accept_ancestor
) {
2944 * Go deeper to find an ancestor, give up on top level.
2946 if (parent_name(parent
, parent
, sizeof (parent
)) != 0) {
2947 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2948 "no such pool '%s'"), zc
.zc_name
);
2949 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
2951 } else if (errno
== ENOENT
) {
2952 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2953 "parent does not exist"));
2954 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
2956 return (zfs_standard_error(hdl
, errno
, errbuf
));
2959 is_zoned
= zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
);
2963 /* we are in a non-global zone, but parent is in the global zone */
2964 if (getzoneid() != GLOBAL_ZONEID
&& !is_zoned
) {
2965 (void) zfs_standard_error(hdl
, EPERM
, errbuf
);
2970 /* make sure parent is a filesystem */
2971 if (zfs_get_type(zhp
) != ZFS_TYPE_FILESYSTEM
) {
2972 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2973 "parent is not a filesystem"));
2974 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
2980 if (prefixlen
!= NULL
)
2981 *prefixlen
= strlen(parent
);
2986 * Finds whether the dataset of the given type(s) exists.
2989 zfs_dataset_exists(libzfs_handle_t
*hdl
, const char *path
, zfs_type_t types
)
2993 if (!zfs_validate_name(hdl
, path
, types
, B_FALSE
))
2997 * Try to get stats for the dataset, which will tell us if it exists.
2999 if ((zhp
= make_dataset_handle(hdl
, path
)) != NULL
) {
3000 int ds_type
= zhp
->zfs_type
;
3003 if (types
& ds_type
)
3010 * Given a path to 'target', create all the ancestors between
3011 * the prefixlen portion of the path, and the target itself.
3012 * Fail if the initial prefixlen-ancestor does not already exist.
3015 create_parents(libzfs_handle_t
*hdl
, char *target
, int prefixlen
)
3021 /* make sure prefix exists */
3022 cp
= target
+ prefixlen
;
3024 assert(strchr(cp
, '/') == NULL
);
3025 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3028 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3036 * Attempt to create, mount, and share any ancestor filesystems,
3037 * up to the prefixlen-long one.
3039 for (cp
= target
+ prefixlen
+ 1;
3040 (cp
= strchr(cp
, '/')); *cp
= '/', cp
++) {
3044 h
= make_dataset_handle(hdl
, target
);
3046 /* it already exists, nothing to do here */
3051 if (zfs_create(hdl
, target
, ZFS_TYPE_FILESYSTEM
,
3053 opname
= dgettext(TEXT_DOMAIN
, "create");
3057 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3059 opname
= dgettext(TEXT_DOMAIN
, "open");
3063 if (zfs_mount(h
, NULL
, 0) != 0) {
3064 opname
= dgettext(TEXT_DOMAIN
, "mount");
3068 if (zfs_share(h
) != 0) {
3069 opname
= dgettext(TEXT_DOMAIN
, "share");
3079 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3080 "failed to %s ancestor '%s'"), opname
, target
);
3085 * Creates non-existing ancestors of the given path.
3088 zfs_create_ancestors(libzfs_handle_t
*hdl
, const char *path
)
3094 if (check_parents(hdl
, path
, NULL
, B_TRUE
, &prefix
) != 0)
3097 if ((path_copy
= strdup(path
)) != NULL
) {
3098 rc
= create_parents(hdl
, path_copy
, prefix
);
3101 if (path_copy
== NULL
|| rc
!= 0)
3108 * Create a new filesystem or volume.
3111 zfs_create(libzfs_handle_t
*hdl
, const char *path
, zfs_type_t type
,
3116 uint64_t blocksize
= zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE
);
3119 dmu_objset_type_t ost
;
3121 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3122 "cannot create '%s'"), path
);
3124 /* validate the path, taking care to note the extended error message */
3125 if (!zfs_validate_name(hdl
, path
, type
, B_TRUE
))
3126 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3128 /* validate parents exist */
3129 if (check_parents(hdl
, path
, &zoned
, B_FALSE
, NULL
) != 0)
3133 * The failure modes when creating a dataset of a different type over
3134 * one that already exists is a little strange. In particular, if you
3135 * try to create a dataset on top of an existing dataset, the ioctl()
3136 * will return ENOENT, not EEXIST. To prevent this from happening, we
3137 * first try to see if the dataset exists.
3139 if (zfs_dataset_exists(hdl
, path
, ZFS_TYPE_DATASET
)) {
3140 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3141 "dataset already exists"));
3142 return (zfs_error(hdl
, EZFS_EXISTS
, errbuf
));
3145 if (type
== ZFS_TYPE_VOLUME
)
3150 if (props
&& (props
= zfs_valid_proplist(hdl
, type
, props
,
3151 zoned
, NULL
, errbuf
)) == 0)
3154 if (type
== ZFS_TYPE_VOLUME
) {
3156 * If we are creating a volume, the size and block size must
3157 * satisfy a few restraints. First, the blocksize must be a
3158 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3159 * volsize must be a multiple of the block size, and cannot be
3162 if (props
== NULL
|| nvlist_lookup_uint64(props
,
3163 zfs_prop_to_name(ZFS_PROP_VOLSIZE
), &size
) != 0) {
3165 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3166 "missing volume size"));
3167 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3170 if ((ret
= nvlist_lookup_uint64(props
,
3171 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
3172 &blocksize
)) != 0) {
3173 if (ret
== ENOENT
) {
3174 blocksize
= zfs_prop_default_numeric(
3175 ZFS_PROP_VOLBLOCKSIZE
);
3178 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3179 "missing volume block size"));
3180 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3186 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3187 "volume size cannot be zero"));
3188 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3191 if (size
% blocksize
!= 0) {
3193 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3194 "volume size must be a multiple of volume block "
3196 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3200 /* create the dataset */
3201 ret
= lzc_create(path
, ost
, props
);
3204 /* check for failure */
3206 char parent
[ZFS_MAXNAMELEN
];
3207 (void) parent_name(path
, parent
, sizeof (parent
));
3211 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3212 "no such parent '%s'"), parent
);
3213 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3216 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3217 "parent '%s' is not a filesystem"), parent
);
3218 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3221 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3222 "volume block size must be power of 2 from "
3223 "512B to %uKB"), zfs_max_recordsize
>> 10);
3225 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3228 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3229 "pool must be upgraded to set this "
3230 "property or value"));
3231 return (zfs_error(hdl
, EZFS_BADVERSION
, errbuf
));
3235 * This platform can't address a volume this big.
3237 if (type
== ZFS_TYPE_VOLUME
)
3238 return (zfs_error(hdl
, EZFS_VOLTOOBIG
,
3243 return (zfs_standard_error(hdl
, errno
, errbuf
));
3251 * Destroys the given dataset. The caller must make sure that the filesystem
3252 * isn't mounted, and that there are no active dependents. If the file system
3253 * does not exist this function does nothing.
3256 zfs_destroy(zfs_handle_t
*zhp
, boolean_t defer
)
3258 zfs_cmd_t zc
= {"\0"};
3260 if (zhp
->zfs_type
== ZFS_TYPE_BOOKMARK
) {
3261 nvlist_t
*nv
= fnvlist_alloc();
3262 fnvlist_add_boolean(nv
, zhp
->zfs_name
);
3263 int error
= lzc_destroy_bookmarks(nv
, NULL
);
3266 return (zfs_standard_error_fmt(zhp
->zfs_hdl
, errno
,
3267 dgettext(TEXT_DOMAIN
, "cannot destroy '%s'"),
3273 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
3275 if (ZFS_IS_VOLUME(zhp
)) {
3276 zc
.zc_objset_type
= DMU_OST_ZVOL
;
3278 zc
.zc_objset_type
= DMU_OST_ZFS
;
3281 zc
.zc_defer_destroy
= defer
;
3282 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_DESTROY
, &zc
) != 0 &&
3284 return (zfs_standard_error_fmt(zhp
->zfs_hdl
, errno
,
3285 dgettext(TEXT_DOMAIN
, "cannot destroy '%s'"),
3289 remove_mountpoint(zhp
);
3294 struct destroydata
{
3296 const char *snapname
;
3300 zfs_check_snap_cb(zfs_handle_t
*zhp
, void *arg
)
3302 struct destroydata
*dd
= arg
;
3303 char name
[ZFS_MAXNAMELEN
];
3306 (void) snprintf(name
, sizeof (name
),
3307 "%s@%s", zhp
->zfs_name
, dd
->snapname
);
3309 if (lzc_exists(name
))
3310 verify(nvlist_add_boolean(dd
->nvl
, name
) == 0);
3312 rv
= zfs_iter_filesystems(zhp
, zfs_check_snap_cb
, dd
);
3318 * Destroys all snapshots with the given name in zhp & descendants.
3321 zfs_destroy_snaps(zfs_handle_t
*zhp
, char *snapname
, boolean_t defer
)
3324 struct destroydata dd
= { 0 };
3326 dd
.snapname
= snapname
;
3327 verify(nvlist_alloc(&dd
.nvl
, NV_UNIQUE_NAME
, 0) == 0);
3328 (void) zfs_check_snap_cb(zfs_handle_dup(zhp
), &dd
);
3330 if (nvlist_empty(dd
.nvl
)) {
3331 ret
= zfs_standard_error_fmt(zhp
->zfs_hdl
, ENOENT
,
3332 dgettext(TEXT_DOMAIN
, "cannot destroy '%s@%s'"),
3333 zhp
->zfs_name
, snapname
);
3335 ret
= zfs_destroy_snaps_nvl(zhp
->zfs_hdl
, dd
.nvl
, defer
);
3337 nvlist_free(dd
.nvl
);
3342 * Destroys all the snapshots named in the nvlist.
3345 zfs_destroy_snaps_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
, boolean_t defer
)
3351 ret
= lzc_destroy_snaps(snaps
, defer
, &errlist
);
3356 if (nvlist_empty(errlist
)) {
3358 (void) snprintf(errbuf
, sizeof (errbuf
),
3359 dgettext(TEXT_DOMAIN
, "cannot destroy snapshots"));
3361 ret
= zfs_standard_error(hdl
, ret
, errbuf
);
3363 for (pair
= nvlist_next_nvpair(errlist
, NULL
);
3364 pair
!= NULL
; pair
= nvlist_next_nvpair(errlist
, pair
)) {
3366 (void) snprintf(errbuf
, sizeof (errbuf
),
3367 dgettext(TEXT_DOMAIN
, "cannot destroy snapshot %s"),
3370 switch (fnvpair_value_int32(pair
)) {
3373 dgettext(TEXT_DOMAIN
, "snapshot is cloned"));
3374 ret
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3377 ret
= zfs_standard_error(hdl
, errno
, errbuf
);
3386 * Clones the given dataset. The target must be of the same type as the source.
3389 zfs_clone(zfs_handle_t
*zhp
, const char *target
, nvlist_t
*props
)
3391 char parent
[ZFS_MAXNAMELEN
];
3394 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3397 assert(zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
);
3399 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3400 "cannot create '%s'"), target
);
3402 /* validate the target/clone name */
3403 if (!zfs_validate_name(hdl
, target
, ZFS_TYPE_FILESYSTEM
, B_TRUE
))
3404 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3406 /* validate parents exist */
3407 if (check_parents(hdl
, target
, &zoned
, B_FALSE
, NULL
) != 0)
3410 (void) parent_name(target
, parent
, sizeof (parent
));
3416 if (ZFS_IS_VOLUME(zhp
)) {
3417 type
= ZFS_TYPE_VOLUME
;
3419 type
= ZFS_TYPE_FILESYSTEM
;
3421 if ((props
= zfs_valid_proplist(hdl
, type
, props
, zoned
,
3422 zhp
, errbuf
)) == NULL
)
3426 ret
= lzc_clone(target
, zhp
->zfs_name
, props
);
3434 * The parent doesn't exist. We should have caught this
3435 * above, but there may a race condition that has since
3436 * destroyed the parent.
3438 * At this point, we don't know whether it's the source
3439 * that doesn't exist anymore, or whether the target
3440 * dataset doesn't exist.
3442 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
3443 "no such parent '%s'"), parent
);
3444 return (zfs_error(zhp
->zfs_hdl
, EZFS_NOENT
, errbuf
));
3447 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
3448 "source and target pools differ"));
3449 return (zfs_error(zhp
->zfs_hdl
, EZFS_CROSSTARGET
,
3453 return (zfs_standard_error(zhp
->zfs_hdl
, errno
,
3462 * Promotes the given clone fs to be the clone parent.
3465 zfs_promote(zfs_handle_t
*zhp
)
3467 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3468 zfs_cmd_t zc
= {"\0"};
3469 char parent
[MAXPATHLEN
];
3473 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3474 "cannot promote '%s'"), zhp
->zfs_name
);
3476 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
) {
3477 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3478 "snapshots can not be promoted"));
3479 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3482 (void) strlcpy(parent
, zhp
->zfs_dmustats
.dds_origin
, sizeof (parent
));
3483 if (parent
[0] == '\0') {
3484 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3485 "not a cloned filesystem"));
3486 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3489 (void) strlcpy(zc
.zc_value
, zhp
->zfs_dmustats
.dds_origin
,
3490 sizeof (zc
.zc_value
));
3491 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
3492 ret
= zfs_ioctl(hdl
, ZFS_IOC_PROMOTE
, &zc
);
3495 int save_errno
= errno
;
3497 switch (save_errno
) {
3499 /* There is a conflicting snapshot name. */
3500 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3501 "conflicting snapshot '%s' from parent '%s'"),
3502 zc
.zc_string
, parent
);
3503 return (zfs_error(hdl
, EZFS_EXISTS
, errbuf
));
3506 return (zfs_standard_error(hdl
, save_errno
, errbuf
));
3512 typedef struct snapdata
{
3514 const char *sd_snapname
;
3518 zfs_snapshot_cb(zfs_handle_t
*zhp
, void *arg
)
3520 snapdata_t
*sd
= arg
;
3521 char name
[ZFS_MAXNAMELEN
];
3524 if (zfs_prop_get_int(zhp
, ZFS_PROP_INCONSISTENT
) == 0) {
3525 (void) snprintf(name
, sizeof (name
),
3526 "%s@%s", zfs_get_name(zhp
), sd
->sd_snapname
);
3528 fnvlist_add_boolean(sd
->sd_nvl
, name
);
3530 rv
= zfs_iter_filesystems(zhp
, zfs_snapshot_cb
, sd
);
3538 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3542 zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
, nvlist_t
*props
)
3549 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3550 "cannot create snapshots "));
3553 while ((elem
= nvlist_next_nvpair(snaps
, elem
)) != NULL
) {
3554 const char *snapname
= nvpair_name(elem
);
3556 /* validate the target name */
3557 if (!zfs_validate_name(hdl
, snapname
, ZFS_TYPE_SNAPSHOT
,
3559 (void) snprintf(errbuf
, sizeof (errbuf
),
3560 dgettext(TEXT_DOMAIN
,
3561 "cannot create snapshot '%s'"), snapname
);
3562 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3566 if (props
!= NULL
&&
3567 (props
= zfs_valid_proplist(hdl
, ZFS_TYPE_SNAPSHOT
,
3568 props
, B_FALSE
, NULL
, errbuf
)) == NULL
) {
3572 ret
= lzc_snapshot(snaps
, props
, &errors
);
3575 boolean_t printed
= B_FALSE
;
3576 for (elem
= nvlist_next_nvpair(errors
, NULL
);
3578 elem
= nvlist_next_nvpair(errors
, elem
)) {
3579 (void) snprintf(errbuf
, sizeof (errbuf
),
3580 dgettext(TEXT_DOMAIN
,
3581 "cannot create snapshot '%s'"), nvpair_name(elem
));
3582 (void) zfs_standard_error(hdl
,
3583 fnvpair_value_int32(elem
), errbuf
);
3589 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3590 "multiple snapshots of same "
3592 (void) zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3596 (void) zfs_standard_error(hdl
, ret
, errbuf
);
3602 nvlist_free(errors
);
3607 zfs_snapshot(libzfs_handle_t
*hdl
, const char *path
, boolean_t recursive
,
3611 snapdata_t sd
= { 0 };
3612 char fsname
[ZFS_MAXNAMELEN
];
3617 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3618 "cannot snapshot %s"), path
);
3620 if (!zfs_validate_name(hdl
, path
, ZFS_TYPE_SNAPSHOT
, B_TRUE
))
3621 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3623 (void) strlcpy(fsname
, path
, sizeof (fsname
));
3624 cp
= strchr(fsname
, '@');
3626 sd
.sd_snapname
= cp
+ 1;
3628 if ((zhp
= zfs_open(hdl
, fsname
, ZFS_TYPE_FILESYSTEM
|
3629 ZFS_TYPE_VOLUME
)) == NULL
) {
3633 verify(nvlist_alloc(&sd
.sd_nvl
, NV_UNIQUE_NAME
, 0) == 0);
3635 (void) zfs_snapshot_cb(zfs_handle_dup(zhp
), &sd
);
3637 fnvlist_add_boolean(sd
.sd_nvl
, path
);
3640 ret
= zfs_snapshot_nvl(hdl
, sd
.sd_nvl
, props
);
3641 nvlist_free(sd
.sd_nvl
);
3647 * Destroy any more recent snapshots. We invoke this callback on any dependents
3648 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3649 * is a dependent and we should just destroy it without checking the transaction
3652 typedef struct rollback_data
{
3653 const char *cb_target
; /* the snapshot */
3654 uint64_t cb_create
; /* creation time reference */
3660 rollback_destroy_dependent(zfs_handle_t
*zhp
, void *data
)
3662 rollback_data_t
*cbp
= data
;
3663 prop_changelist_t
*clp
;
3665 /* We must destroy this clone; first unmount it */
3666 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
3667 cbp
->cb_force
? MS_FORCE
: 0);
3668 if (clp
== NULL
|| changelist_prefix(clp
) != 0) {
3669 cbp
->cb_error
= B_TRUE
;
3673 if (zfs_destroy(zhp
, B_FALSE
) != 0)
3674 cbp
->cb_error
= B_TRUE
;
3676 changelist_remove(clp
, zhp
->zfs_name
);
3677 (void) changelist_postfix(clp
);
3678 changelist_free(clp
);
3685 rollback_destroy(zfs_handle_t
*zhp
, void *data
)
3687 rollback_data_t
*cbp
= data
;
3689 if (zfs_prop_get_int(zhp
, ZFS_PROP_CREATETXG
) > cbp
->cb_create
) {
3690 cbp
->cb_error
|= zfs_iter_dependents(zhp
, B_FALSE
,
3691 rollback_destroy_dependent
, cbp
);
3693 cbp
->cb_error
|= zfs_destroy(zhp
, B_FALSE
);
3701 * Given a dataset, rollback to a specific snapshot, discarding any
3702 * data changes since then and making it the active dataset.
3704 * Any snapshots and bookmarks more recent than the target are
3705 * destroyed, along with their dependents (i.e. clones).
3708 zfs_rollback(zfs_handle_t
*zhp
, zfs_handle_t
*snap
, boolean_t force
)
3710 rollback_data_t cb
= { 0 };
3712 boolean_t restore_resv
= 0;
3713 uint64_t old_volsize
= 0, new_volsize
;
3714 zfs_prop_t resv_prop
= { 0 };
3716 assert(zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
||
3717 zhp
->zfs_type
== ZFS_TYPE_VOLUME
);
3720 * Destroy all recent snapshots and their dependents.
3722 cb
.cb_force
= force
;
3723 cb
.cb_target
= snap
->zfs_name
;
3724 cb
.cb_create
= zfs_prop_get_int(snap
, ZFS_PROP_CREATETXG
);
3725 (void) zfs_iter_snapshots(zhp
, B_FALSE
, rollback_destroy
, &cb
);
3726 (void) zfs_iter_bookmarks(zhp
, rollback_destroy
, &cb
);
3732 * Now that we have verified that the snapshot is the latest,
3733 * rollback to the given snapshot.
3736 if (zhp
->zfs_type
== ZFS_TYPE_VOLUME
) {
3737 if (zfs_which_resv_prop(zhp
, &resv_prop
) < 0)
3739 old_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
3741 (old_volsize
== zfs_prop_get_int(zhp
, resv_prop
));
3745 * We rely on zfs_iter_children() to verify that there are no
3746 * newer snapshots for the given dataset. Therefore, we can
3747 * simply pass the name on to the ioctl() call. There is still
3748 * an unlikely race condition where the user has taken a
3749 * snapshot since we verified that this was the most recent.
3751 err
= lzc_rollback(zhp
->zfs_name
, NULL
, 0);
3753 (void) zfs_standard_error_fmt(zhp
->zfs_hdl
, errno
,
3754 dgettext(TEXT_DOMAIN
, "cannot rollback '%s'"),
3760 * For volumes, if the pre-rollback volsize matched the pre-
3761 * rollback reservation and the volsize has changed then set
3762 * the reservation property to the post-rollback volsize.
3763 * Make a new handle since the rollback closed the dataset.
3765 if ((zhp
->zfs_type
== ZFS_TYPE_VOLUME
) &&
3766 (zhp
= make_dataset_handle(zhp
->zfs_hdl
, zhp
->zfs_name
))) {
3768 new_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
3769 if (old_volsize
!= new_volsize
)
3770 err
= zfs_prop_set_int(zhp
, resv_prop
,
3779 * Renames the given dataset.
3782 zfs_rename(zfs_handle_t
*zhp
, const char *target
, boolean_t recursive
,
3783 boolean_t force_unmount
)
3786 zfs_cmd_t zc
= {"\0"};
3788 prop_changelist_t
*cl
= NULL
;
3789 zfs_handle_t
*zhrp
= NULL
;
3790 char *parentname
= NULL
;
3791 char parent
[ZFS_MAXNAMELEN
];
3792 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3795 /* if we have the same exact name, just return success */
3796 if (strcmp(zhp
->zfs_name
, target
) == 0)
3799 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3800 "cannot rename to '%s'"), target
);
3803 * Make sure the target name is valid
3805 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
) {
3806 if ((strchr(target
, '@') == NULL
) ||
3809 * Snapshot target name is abbreviated,
3810 * reconstruct full dataset name
3812 (void) strlcpy(parent
, zhp
->zfs_name
,
3814 delim
= strchr(parent
, '@');
3815 if (strchr(target
, '@') == NULL
)
3819 (void) strlcat(parent
, target
, sizeof (parent
));
3823 * Make sure we're renaming within the same dataset.
3825 delim
= strchr(target
, '@');
3826 if (strncmp(zhp
->zfs_name
, target
, delim
- target
)
3827 != 0 || zhp
->zfs_name
[delim
- target
] != '@') {
3828 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3829 "snapshots must be part of same "
3831 return (zfs_error(hdl
, EZFS_CROSSTARGET
,
3835 if (!zfs_validate_name(hdl
, target
, zhp
->zfs_type
, B_TRUE
))
3836 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3839 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3840 "recursive rename must be a snapshot"));
3841 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3844 if (!zfs_validate_name(hdl
, target
, zhp
->zfs_type
, B_TRUE
))
3845 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3847 /* validate parents */
3848 if (check_parents(hdl
, target
, NULL
, B_FALSE
, NULL
) != 0)
3851 /* make sure we're in the same pool */
3852 verify((delim
= strchr(target
, '/')) != NULL
);
3853 if (strncmp(zhp
->zfs_name
, target
, delim
- target
) != 0 ||
3854 zhp
->zfs_name
[delim
- target
] != '/') {
3855 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3856 "datasets must be within same pool"));
3857 return (zfs_error(hdl
, EZFS_CROSSTARGET
, errbuf
));
3860 /* new name cannot be a child of the current dataset name */
3861 if (is_descendant(zhp
->zfs_name
, target
)) {
3862 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3863 "New dataset name cannot be a descendant of "
3864 "current dataset name"));
3865 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3869 (void) snprintf(errbuf
, sizeof (errbuf
),
3870 dgettext(TEXT_DOMAIN
, "cannot rename '%s'"), zhp
->zfs_name
);
3872 if (getzoneid() == GLOBAL_ZONEID
&&
3873 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
)) {
3874 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3875 "dataset is used in a non-global zone"));
3876 return (zfs_error(hdl
, EZFS_ZONED
, errbuf
));
3881 parentname
= zfs_strdup(zhp
->zfs_hdl
, zhp
->zfs_name
);
3882 if (parentname
== NULL
) {
3886 delim
= strchr(parentname
, '@');
3888 zhrp
= zfs_open(zhp
->zfs_hdl
, parentname
, ZFS_TYPE_DATASET
);
3895 if ((cl
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
3896 force_unmount
? MS_FORCE
: 0)) == NULL
)
3899 if (changelist_haszonedchild(cl
)) {
3900 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3901 "child dataset with inherited mountpoint is used "
3902 "in a non-global zone"));
3903 (void) zfs_error(hdl
, EZFS_ZONED
, errbuf
);
3908 if ((ret
= changelist_prefix(cl
)) != 0)
3912 if (ZFS_IS_VOLUME(zhp
))
3913 zc
.zc_objset_type
= DMU_OST_ZVOL
;
3915 zc
.zc_objset_type
= DMU_OST_ZFS
;
3917 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
3918 (void) strlcpy(zc
.zc_value
, target
, sizeof (zc
.zc_value
));
3920 zc
.zc_cookie
= recursive
;
3922 if ((ret
= zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_RENAME
, &zc
)) != 0) {
3924 * if it was recursive, the one that actually failed will
3927 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3928 "cannot rename '%s'"), zc
.zc_name
);
3930 if (recursive
&& errno
== EEXIST
) {
3931 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3932 "a child dataset already has a snapshot "
3933 "with the new name"));
3934 (void) zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3936 (void) zfs_standard_error(zhp
->zfs_hdl
, errno
, errbuf
);
3940 * On failure, we still want to remount any filesystems that
3941 * were previously mounted, so we don't alter the system state.
3944 (void) changelist_postfix(cl
);
3947 changelist_rename(cl
, zfs_get_name(zhp
), target
);
3948 ret
= changelist_postfix(cl
);
3960 changelist_free(cl
);
3966 zfs_get_user_props(zfs_handle_t
*zhp
)
3968 return (zhp
->zfs_user_props
);
3972 * This function is used by 'zfs list' to determine the exact set of columns to
3973 * display, and their maximum widths. This does two main things:
3975 * - If this is a list of all properties, then expand the list to include
3976 * all native properties, and set a flag so that for each dataset we look
3977 * for new unique user properties and add them to the list.
3979 * - For non fixed-width properties, keep track of the maximum width seen
3980 * so that we can size the column appropriately. If the user has
3981 * requested received property values, we also need to compute the width
3982 * of the RECEIVED column.
3985 zfs_expand_proplist(zfs_handle_t
*zhp
, zprop_list_t
**plp
, boolean_t received
,
3988 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3989 zprop_list_t
*entry
;
3990 zprop_list_t
**last
, **start
;
3991 nvlist_t
*userprops
, *propval
;
3994 char buf
[ZFS_MAXPROPLEN
];
3996 if (zprop_expand_list(hdl
, plp
, ZFS_TYPE_DATASET
) != 0)
3999 userprops
= zfs_get_user_props(zhp
);
4002 if (entry
->pl_all
&& nvlist_next_nvpair(userprops
, NULL
) != NULL
) {
4004 * Go through and add any user properties as necessary. We
4005 * start by incrementing our list pointer to the first
4006 * non-native property.
4009 while (*start
!= NULL
) {
4010 if ((*start
)->pl_prop
== ZPROP_INVAL
)
4012 start
= &(*start
)->pl_next
;
4016 while ((elem
= nvlist_next_nvpair(userprops
, elem
)) != NULL
) {
4018 * See if we've already found this property in our list.
4020 for (last
= start
; *last
!= NULL
;
4021 last
= &(*last
)->pl_next
) {
4022 if (strcmp((*last
)->pl_user_prop
,
4023 nvpair_name(elem
)) == 0)
4027 if (*last
== NULL
) {
4028 if ((entry
= zfs_alloc(hdl
,
4029 sizeof (zprop_list_t
))) == NULL
||
4030 ((entry
->pl_user_prop
= zfs_strdup(hdl
,
4031 nvpair_name(elem
)))) == NULL
) {
4036 entry
->pl_prop
= ZPROP_INVAL
;
4037 entry
->pl_width
= strlen(nvpair_name(elem
));
4038 entry
->pl_all
= B_TRUE
;
4045 * Now go through and check the width of any non-fixed columns
4047 for (entry
= *plp
; entry
!= NULL
; entry
= entry
->pl_next
) {
4048 if (entry
->pl_fixed
&& !literal
)
4051 if (entry
->pl_prop
!= ZPROP_INVAL
) {
4052 if (zfs_prop_get(zhp
, entry
->pl_prop
,
4053 buf
, sizeof (buf
), NULL
, NULL
, 0, literal
) == 0) {
4054 if (strlen(buf
) > entry
->pl_width
)
4055 entry
->pl_width
= strlen(buf
);
4057 if (received
&& zfs_prop_get_recvd(zhp
,
4058 zfs_prop_to_name(entry
->pl_prop
),
4059 buf
, sizeof (buf
), literal
) == 0)
4060 if (strlen(buf
) > entry
->pl_recvd_width
)
4061 entry
->pl_recvd_width
= strlen(buf
);
4063 if (nvlist_lookup_nvlist(userprops
, entry
->pl_user_prop
,
4065 verify(nvlist_lookup_string(propval
,
4066 ZPROP_VALUE
, &strval
) == 0);
4067 if (strlen(strval
) > entry
->pl_width
)
4068 entry
->pl_width
= strlen(strval
);
4070 if (received
&& zfs_prop_get_recvd(zhp
,
4071 entry
->pl_user_prop
,
4072 buf
, sizeof (buf
), literal
) == 0)
4073 if (strlen(buf
) > entry
->pl_recvd_width
)
4074 entry
->pl_recvd_width
= strlen(buf
);
4082 zfs_prune_proplist(zfs_handle_t
*zhp
, uint8_t *props
)
4087 * Keep a reference to the props-table against which we prune the
4090 zhp
->zfs_props_table
= props
;
4092 curr
= nvlist_next_nvpair(zhp
->zfs_props
, NULL
);
4095 zfs_prop_t zfs_prop
= zfs_name_to_prop(nvpair_name(curr
));
4096 nvpair_t
*next
= nvlist_next_nvpair(zhp
->zfs_props
, curr
);
4099 * User properties will result in ZPROP_INVAL, and since we
4100 * only know how to prune standard ZFS properties, we always
4101 * leave these in the list. This can also happen if we
4102 * encounter an unknown DSL property (when running older
4103 * software, for example).
4105 if (zfs_prop
!= ZPROP_INVAL
&& props
[zfs_prop
] == B_FALSE
)
4106 (void) nvlist_remove(zhp
->zfs_props
,
4107 nvpair_name(curr
), nvpair_type(curr
));
4113 zfs_smb_acl_mgmt(libzfs_handle_t
*hdl
, char *dataset
, char *path
,
4114 zfs_smb_acl_op_t cmd
, char *resource1
, char *resource2
)
4116 zfs_cmd_t zc
= {"\0"};
4117 nvlist_t
*nvlist
= NULL
;
4120 (void) strlcpy(zc
.zc_name
, dataset
, sizeof (zc
.zc_name
));
4121 (void) strlcpy(zc
.zc_value
, path
, sizeof (zc
.zc_value
));
4122 zc
.zc_cookie
= (uint64_t)cmd
;
4124 if (cmd
== ZFS_SMB_ACL_RENAME
) {
4125 if (nvlist_alloc(&nvlist
, NV_UNIQUE_NAME
, 0) != 0) {
4126 (void) no_memory(hdl
);
4132 case ZFS_SMB_ACL_ADD
:
4133 case ZFS_SMB_ACL_REMOVE
:
4134 (void) strlcpy(zc
.zc_string
, resource1
, sizeof (zc
.zc_string
));
4136 case ZFS_SMB_ACL_RENAME
:
4137 if (nvlist_add_string(nvlist
, ZFS_SMB_ACL_SRC
,
4139 (void) no_memory(hdl
);
4142 if (nvlist_add_string(nvlist
, ZFS_SMB_ACL_TARGET
,
4144 (void) no_memory(hdl
);
4147 if (zcmd_write_src_nvlist(hdl
, &zc
, nvlist
) != 0) {
4148 nvlist_free(nvlist
);
4152 case ZFS_SMB_ACL_PURGE
:
4157 error
= ioctl(hdl
->libzfs_fd
, ZFS_IOC_SMB_ACL
, &zc
);
4159 nvlist_free(nvlist
);
4164 zfs_smb_acl_add(libzfs_handle_t
*hdl
, char *dataset
,
4165 char *path
, char *resource
)
4167 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_ADD
,
4172 zfs_smb_acl_remove(libzfs_handle_t
*hdl
, char *dataset
,
4173 char *path
, char *resource
)
4175 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_REMOVE
,
4180 zfs_smb_acl_purge(libzfs_handle_t
*hdl
, char *dataset
, char *path
)
4182 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_PURGE
,
4187 zfs_smb_acl_rename(libzfs_handle_t
*hdl
, char *dataset
, char *path
,
4188 char *oldname
, char *newname
)
4190 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_RENAME
,
4195 zfs_userspace(zfs_handle_t
*zhp
, zfs_userquota_prop_t type
,
4196 zfs_userspace_cb_t func
, void *arg
)
4198 zfs_cmd_t zc
= {"\0"};
4199 zfs_useracct_t buf
[100];
4200 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4203 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
4205 zc
.zc_objset_type
= type
;
4206 zc
.zc_nvlist_dst
= (uintptr_t)buf
;
4209 zfs_useracct_t
*zua
= buf
;
4211 zc
.zc_nvlist_dst_size
= sizeof (buf
);
4212 if (zfs_ioctl(hdl
, ZFS_IOC_USERSPACE_MANY
, &zc
) != 0) {
4213 char errbuf
[ZFS_MAXNAMELEN
+ 32];
4215 (void) snprintf(errbuf
, sizeof (errbuf
),
4216 dgettext(TEXT_DOMAIN
,
4217 "cannot get used/quota for %s"), zc
.zc_name
);
4218 return (zfs_standard_error_fmt(hdl
, errno
, errbuf
));
4220 if (zc
.zc_nvlist_dst_size
== 0)
4223 while (zc
.zc_nvlist_dst_size
> 0) {
4224 if ((ret
= func(arg
, zua
->zu_domain
, zua
->zu_rid
,
4225 zua
->zu_space
)) != 0)
4228 zc
.zc_nvlist_dst_size
-= sizeof (zfs_useracct_t
);
4237 const char *snapname
;
4239 boolean_t recursive
;
4244 zfs_hold_one(zfs_handle_t
*zhp
, void *arg
)
4246 struct holdarg
*ha
= arg
;
4247 char name
[ZFS_MAXNAMELEN
];
4250 (void) snprintf(name
, sizeof (name
),
4251 "%s@%s", zhp
->zfs_name
, ha
->snapname
);
4253 if (lzc_exists(name
))
4254 fnvlist_add_string(ha
->nvl
, name
, ha
->tag
);
4257 rv
= zfs_iter_filesystems(zhp
, zfs_hold_one
, ha
);
4263 zfs_hold(zfs_handle_t
*zhp
, const char *snapname
, const char *tag
,
4264 boolean_t recursive
, int cleanup_fd
)
4269 ha
.nvl
= fnvlist_alloc();
4270 ha
.snapname
= snapname
;
4272 ha
.recursive
= recursive
;
4273 (void) zfs_hold_one(zfs_handle_dup(zhp
), &ha
);
4275 if (nvlist_empty(ha
.nvl
)) {
4278 fnvlist_free(ha
.nvl
);
4280 (void) snprintf(errbuf
, sizeof (errbuf
),
4281 dgettext(TEXT_DOMAIN
,
4282 "cannot hold snapshot '%s@%s'"),
4283 zhp
->zfs_name
, snapname
);
4284 (void) zfs_standard_error(zhp
->zfs_hdl
, ret
, errbuf
);
4288 ret
= zfs_hold_nvl(zhp
, cleanup_fd
, ha
.nvl
);
4289 fnvlist_free(ha
.nvl
);
4295 zfs_hold_nvl(zfs_handle_t
*zhp
, int cleanup_fd
, nvlist_t
*holds
)
4299 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4304 ret
= lzc_hold(holds
, cleanup_fd
, &errors
);
4307 /* There may be errors even in the success case. */
4308 fnvlist_free(errors
);
4312 if (nvlist_empty(errors
)) {
4313 /* no hold-specific errors */
4314 (void) snprintf(errbuf
, sizeof (errbuf
),
4315 dgettext(TEXT_DOMAIN
, "cannot hold"));
4318 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4319 "pool must be upgraded"));
4320 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4323 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4326 (void) zfs_standard_error(hdl
, ret
, errbuf
);
4330 for (elem
= nvlist_next_nvpair(errors
, NULL
);
4332 elem
= nvlist_next_nvpair(errors
, elem
)) {
4333 (void) snprintf(errbuf
, sizeof (errbuf
),
4334 dgettext(TEXT_DOMAIN
,
4335 "cannot hold snapshot '%s'"), nvpair_name(elem
));
4336 switch (fnvpair_value_int32(elem
)) {
4339 * Temporary tags wind up having the ds object id
4340 * prepended. So even if we passed the length check
4341 * above, it's still possible for the tag to wind
4342 * up being slightly too long.
4344 (void) zfs_error(hdl
, EZFS_TAGTOOLONG
, errbuf
);
4347 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4350 (void) zfs_error(hdl
, EZFS_REFTAG_HOLD
, errbuf
);
4353 (void) zfs_standard_error(hdl
,
4354 fnvpair_value_int32(elem
), errbuf
);
4358 fnvlist_free(errors
);
4363 zfs_release_one(zfs_handle_t
*zhp
, void *arg
)
4365 struct holdarg
*ha
= arg
;
4366 char name
[ZFS_MAXNAMELEN
];
4368 nvlist_t
*existing_holds
;
4370 (void) snprintf(name
, sizeof (name
),
4371 "%s@%s", zhp
->zfs_name
, ha
->snapname
);
4373 if (lzc_get_holds(name
, &existing_holds
) != 0) {
4375 } else if (!nvlist_exists(existing_holds
, ha
->tag
)) {
4378 nvlist_t
*torelease
= fnvlist_alloc();
4379 fnvlist_add_boolean(torelease
, ha
->tag
);
4380 fnvlist_add_nvlist(ha
->nvl
, name
, torelease
);
4381 fnvlist_free(torelease
);
4385 rv
= zfs_iter_filesystems(zhp
, zfs_release_one
, ha
);
4391 zfs_release(zfs_handle_t
*zhp
, const char *snapname
, const char *tag
,
4392 boolean_t recursive
)
4396 nvlist_t
*errors
= NULL
;
4398 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4401 ha
.nvl
= fnvlist_alloc();
4402 ha
.snapname
= snapname
;
4404 ha
.recursive
= recursive
;
4406 (void) zfs_release_one(zfs_handle_dup(zhp
), &ha
);
4408 if (nvlist_empty(ha
.nvl
)) {
4409 fnvlist_free(ha
.nvl
);
4411 (void) snprintf(errbuf
, sizeof (errbuf
),
4412 dgettext(TEXT_DOMAIN
,
4413 "cannot release hold from snapshot '%s@%s'"),
4414 zhp
->zfs_name
, snapname
);
4416 (void) zfs_error(hdl
, EZFS_REFTAG_RELE
, errbuf
);
4418 (void) zfs_standard_error(hdl
, ret
, errbuf
);
4423 ret
= lzc_release(ha
.nvl
, &errors
);
4424 fnvlist_free(ha
.nvl
);
4427 /* There may be errors even in the success case. */
4428 fnvlist_free(errors
);
4432 if (nvlist_empty(errors
)) {
4433 /* no hold-specific errors */
4434 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4438 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4439 "pool must be upgraded"));
4440 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4443 (void) zfs_standard_error_fmt(hdl
, errno
, errbuf
);
4447 for (elem
= nvlist_next_nvpair(errors
, NULL
);
4449 elem
= nvlist_next_nvpair(errors
, elem
)) {
4450 (void) snprintf(errbuf
, sizeof (errbuf
),
4451 dgettext(TEXT_DOMAIN
,
4452 "cannot release hold from snapshot '%s'"),
4454 switch (fnvpair_value_int32(elem
)) {
4456 (void) zfs_error(hdl
, EZFS_REFTAG_RELE
, errbuf
);
4459 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4462 (void) zfs_standard_error_fmt(hdl
,
4463 fnvpair_value_int32(elem
), errbuf
);
4467 fnvlist_free(errors
);
4472 zfs_get_fsacl(zfs_handle_t
*zhp
, nvlist_t
**nvl
)
4474 zfs_cmd_t zc
= {"\0"};
4475 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4481 assert(zhp
->zfs_type
== ZFS_TYPE_VOLUME
||
4482 zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
);
4486 nvbuf
= malloc(nvsz
);
4487 if (nvbuf
== NULL
) {
4488 err
= (zfs_error(hdl
, EZFS_NOMEM
, strerror(errno
)));
4492 zc
.zc_nvlist_dst_size
= nvsz
;
4493 zc
.zc_nvlist_dst
= (uintptr_t)nvbuf
;
4495 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, ZFS_MAXNAMELEN
);
4497 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_GET_FSACL
, &zc
) != 0) {
4498 (void) snprintf(errbuf
, sizeof (errbuf
),
4499 dgettext(TEXT_DOMAIN
, "cannot get permissions on '%s'"),
4504 nvsz
= zc
.zc_nvlist_dst_size
;
4508 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4509 "pool must be upgraded"));
4510 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4513 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4516 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
4519 err
= zfs_standard_error_fmt(hdl
, errno
, errbuf
);
4524 int rc
= nvlist_unpack(nvbuf
, zc
.zc_nvlist_dst_size
, nvl
, 0);
4526 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(
4527 TEXT_DOMAIN
, "cannot get permissions on '%s'"),
4529 err
= zfs_standard_error_fmt(hdl
, rc
, errbuf
);
4539 zfs_set_fsacl(zfs_handle_t
*zhp
, boolean_t un
, nvlist_t
*nvl
)
4541 zfs_cmd_t zc
= {"\0"};
4542 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4548 assert(zhp
->zfs_type
== ZFS_TYPE_VOLUME
||
4549 zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
);
4551 err
= nvlist_size(nvl
, &nvsz
, NV_ENCODE_NATIVE
);
4554 nvbuf
= malloc(nvsz
);
4556 err
= nvlist_pack(nvl
, &nvbuf
, &nvsz
, NV_ENCODE_NATIVE
, 0);
4559 zc
.zc_nvlist_src_size
= nvsz
;
4560 zc
.zc_nvlist_src
= (uintptr_t)nvbuf
;
4561 zc
.zc_perm_action
= un
;
4563 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
4565 if (zfs_ioctl(hdl
, ZFS_IOC_SET_FSACL
, &zc
) != 0) {
4566 (void) snprintf(errbuf
, sizeof (errbuf
),
4567 dgettext(TEXT_DOMAIN
, "cannot set permissions on '%s'"),
4571 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4572 "pool must be upgraded"));
4573 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4576 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4579 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
4582 err
= zfs_standard_error_fmt(hdl
, errno
, errbuf
);
4593 zfs_get_holds(zfs_handle_t
*zhp
, nvlist_t
**nvl
)
4598 err
= lzc_get_holds(zhp
->zfs_name
, nvl
);
4601 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4603 (void) snprintf(errbuf
, sizeof (errbuf
),
4604 dgettext(TEXT_DOMAIN
, "cannot get holds for '%s'"),
4608 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4609 "pool must be upgraded"));
4610 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4613 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4616 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
4619 err
= zfs_standard_error_fmt(hdl
, errno
, errbuf
);
4628 * Convert the zvol's volume size to an appropriate reservation.
4629 * Note: If this routine is updated, it is necessary to update the ZFS test
4630 * suite's shell version in reservation.kshlib.
4633 zvol_volsize_to_reservation(uint64_t volsize
, nvlist_t
*props
)
4636 uint64_t nblocks
, volblocksize
;
4640 if (nvlist_lookup_string(props
,
4641 zfs_prop_to_name(ZFS_PROP_COPIES
), &strval
) == 0)
4642 ncopies
= atoi(strval
);
4645 if (nvlist_lookup_uint64(props
,
4646 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
4647 &volblocksize
) != 0)
4648 volblocksize
= ZVOL_DEFAULT_BLOCKSIZE
;
4649 nblocks
= volsize
/volblocksize
;
4650 /* start with metadnode L0-L6 */
4652 /* calculate number of indirects */
4653 while (nblocks
> 1) {
4654 nblocks
+= DNODES_PER_LEVEL
- 1;
4655 nblocks
/= DNODES_PER_LEVEL
;
4658 numdb
*= MIN(SPA_DVAS_PER_BP
, ncopies
+ 1);
4661 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4662 * compressed, but in practice they compress down to about
4665 numdb
*= 1ULL << DN_MAX_INDBLKSHIFT
;