4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
25 * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
26 * Copyright (c) 2012 DEY Storage Systems, Inc. All rights reserved.
27 * Copyright (c) 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>
53 #include <directory.h>
54 #endif /* HAVE_IDMAP */
56 #include <sys/dnode.h>
61 #include "zfs_namecheck.h"
63 #include "libzfs_impl.h"
64 #include "zfs_deleg.h"
66 static int userquota_propname_decode(const char *propname
, boolean_t zoned
,
67 zfs_userquota_prop_t
*typep
, char *domain
, int domainlen
, uint64_t *ridp
);
70 * Given a single type (not a mask of types), return the type in a human
74 zfs_type_to_name(zfs_type_t type
)
77 case ZFS_TYPE_FILESYSTEM
:
78 return (dgettext(TEXT_DOMAIN
, "filesystem"));
79 case ZFS_TYPE_SNAPSHOT
:
80 return (dgettext(TEXT_DOMAIN
, "snapshot"));
82 return (dgettext(TEXT_DOMAIN
, "volume"));
91 * Validate a ZFS path. This is used even before trying to open the dataset, to
92 * provide a more meaningful error message. We call zfs_error_aux() to
93 * explain exactly why the name was not valid.
96 zfs_validate_name(libzfs_handle_t
*hdl
, const char *path
, int type
,
102 (void) zfs_prop_get_table();
103 if (dataset_namecheck(path
, &why
, &what
) != 0) {
106 case NAME_ERR_TOOLONG
:
107 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
108 "name is too long"));
111 case NAME_ERR_LEADING_SLASH
:
112 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
113 "leading slash in name"));
116 case NAME_ERR_EMPTY_COMPONENT
:
117 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
118 "empty component in name"));
121 case NAME_ERR_TRAILING_SLASH
:
122 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
123 "trailing slash in name"));
126 case NAME_ERR_INVALCHAR
:
128 dgettext(TEXT_DOMAIN
, "invalid character "
129 "'%c' in name"), what
);
132 case NAME_ERR_MULTIPLE_AT
:
133 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
134 "multiple '@' delimiters in name"));
137 case NAME_ERR_NOLETTER
:
138 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
139 "pool doesn't begin with a letter"));
142 case NAME_ERR_RESERVED
:
143 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
144 "name is reserved"));
147 case NAME_ERR_DISKLIKE
:
148 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
149 "reserved disk name"));
159 if (!(type
& ZFS_TYPE_SNAPSHOT
) && strchr(path
, '@') != NULL
) {
161 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
162 "snapshot delimiter '@' in filesystem name"));
166 if (type
== ZFS_TYPE_SNAPSHOT
&& strchr(path
, '@') == NULL
) {
168 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
169 "missing '@' delimiter in snapshot name"));
173 if (modifying
&& strchr(path
, '%') != NULL
) {
175 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
176 "invalid character %c in name"), '%');
184 zfs_name_valid(const char *name
, zfs_type_t type
)
186 if (type
== ZFS_TYPE_POOL
)
187 return (zpool_name_valid(NULL
, B_FALSE
, name
));
188 return (zfs_validate_name(NULL
, name
, type
, B_FALSE
));
192 * This function takes the raw DSL properties, and filters out the user-defined
193 * properties into a separate nvlist.
196 process_user_props(zfs_handle_t
*zhp
, nvlist_t
*props
)
198 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
203 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0) {
204 (void) no_memory(hdl
);
209 while ((elem
= nvlist_next_nvpair(props
, elem
)) != NULL
) {
210 if (!zfs_prop_user(nvpair_name(elem
)))
213 verify(nvpair_value_nvlist(elem
, &propval
) == 0);
214 if (nvlist_add_nvlist(nvl
, nvpair_name(elem
), propval
) != 0) {
216 (void) no_memory(hdl
);
224 static zpool_handle_t
*
225 zpool_add_handle(zfs_handle_t
*zhp
, const char *pool_name
)
227 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
230 if ((zph
= zpool_open_canfail(hdl
, pool_name
)) != NULL
) {
231 if (hdl
->libzfs_pool_handles
!= NULL
)
232 zph
->zpool_next
= hdl
->libzfs_pool_handles
;
233 hdl
->libzfs_pool_handles
= zph
;
238 static zpool_handle_t
*
239 zpool_find_handle(zfs_handle_t
*zhp
, const char *pool_name
, int len
)
241 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
242 zpool_handle_t
*zph
= hdl
->libzfs_pool_handles
;
244 while ((zph
!= NULL
) &&
245 (strncmp(pool_name
, zpool_get_name(zph
), len
) != 0))
246 zph
= zph
->zpool_next
;
251 * Returns a handle to the pool that contains the provided dataset.
252 * If a handle to that pool already exists then that handle is returned.
253 * Otherwise, a new handle is created and added to the list of handles.
255 static zpool_handle_t
*
256 zpool_handle(zfs_handle_t
*zhp
)
262 len
= strcspn(zhp
->zfs_name
, "/@#") + 1;
263 pool_name
= zfs_alloc(zhp
->zfs_hdl
, len
);
264 (void) strlcpy(pool_name
, zhp
->zfs_name
, len
);
266 zph
= zpool_find_handle(zhp
, pool_name
, len
);
268 zph
= zpool_add_handle(zhp
, pool_name
);
275 zpool_free_handles(libzfs_handle_t
*hdl
)
277 zpool_handle_t
*next
, *zph
= hdl
->libzfs_pool_handles
;
279 while (zph
!= NULL
) {
280 next
= zph
->zpool_next
;
284 hdl
->libzfs_pool_handles
= NULL
;
288 * Utility function to gather stats (objset and zpl) for the given object.
291 get_stats_ioctl(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
293 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
295 (void) strlcpy(zc
->zc_name
, zhp
->zfs_name
, sizeof (zc
->zc_name
));
297 while (ioctl(hdl
->libzfs_fd
, ZFS_IOC_OBJSET_STATS
, zc
) != 0) {
298 if (errno
== ENOMEM
) {
299 if (zcmd_expand_dst_nvlist(hdl
, zc
) != 0) {
310 * Utility function to get the received properties of the given object.
313 get_recvd_props_ioctl(zfs_handle_t
*zhp
)
315 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
316 nvlist_t
*recvdprops
;
317 zfs_cmd_t zc
= {"\0"};
320 if (zcmd_alloc_dst_nvlist(hdl
, &zc
, 0) != 0)
323 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
325 while (ioctl(hdl
->libzfs_fd
, ZFS_IOC_OBJSET_RECVD_PROPS
, &zc
) != 0) {
326 if (errno
== ENOMEM
) {
327 if (zcmd_expand_dst_nvlist(hdl
, &zc
) != 0) {
331 zcmd_free_nvlists(&zc
);
336 err
= zcmd_read_dst_nvlist(zhp
->zfs_hdl
, &zc
, &recvdprops
);
337 zcmd_free_nvlists(&zc
);
341 nvlist_free(zhp
->zfs_recvd_props
);
342 zhp
->zfs_recvd_props
= recvdprops
;
348 put_stats_zhdl(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
350 nvlist_t
*allprops
, *userprops
;
352 zhp
->zfs_dmustats
= zc
->zc_objset_stats
; /* structure assignment */
354 if (zcmd_read_dst_nvlist(zhp
->zfs_hdl
, zc
, &allprops
) != 0) {
359 * XXX Why do we store the user props separately, in addition to
360 * storing them in zfs_props?
362 if ((userprops
= process_user_props(zhp
, allprops
)) == NULL
) {
363 nvlist_free(allprops
);
367 nvlist_free(zhp
->zfs_props
);
368 nvlist_free(zhp
->zfs_user_props
);
370 zhp
->zfs_props
= allprops
;
371 zhp
->zfs_user_props
= userprops
;
377 get_stats(zfs_handle_t
*zhp
)
380 zfs_cmd_t zc
= {"\0"};
382 if (zcmd_alloc_dst_nvlist(zhp
->zfs_hdl
, &zc
, 0) != 0)
384 if (get_stats_ioctl(zhp
, &zc
) != 0)
386 else if (put_stats_zhdl(zhp
, &zc
) != 0)
388 zcmd_free_nvlists(&zc
);
393 * Refresh the properties currently stored in the handle.
396 zfs_refresh_properties(zfs_handle_t
*zhp
)
398 (void) get_stats(zhp
);
402 * Makes a handle from the given dataset name. Used by zfs_open() and
403 * zfs_iter_* to create child handles on the fly.
406 make_dataset_handle_common(zfs_handle_t
*zhp
, zfs_cmd_t
*zc
)
408 if (put_stats_zhdl(zhp
, zc
) != 0)
412 * We've managed to open the dataset and gather statistics. Determine
413 * the high-level type.
415 if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZVOL
)
416 zhp
->zfs_head_type
= ZFS_TYPE_VOLUME
;
417 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZFS
)
418 zhp
->zfs_head_type
= ZFS_TYPE_FILESYSTEM
;
419 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_OTHER
)
424 if (zhp
->zfs_dmustats
.dds_is_snapshot
)
425 zhp
->zfs_type
= ZFS_TYPE_SNAPSHOT
;
426 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZVOL
)
427 zhp
->zfs_type
= ZFS_TYPE_VOLUME
;
428 else if (zhp
->zfs_dmustats
.dds_type
== DMU_OST_ZFS
)
429 zhp
->zfs_type
= ZFS_TYPE_FILESYSTEM
;
431 abort(); /* we should never see any other types */
433 if ((zhp
->zpool_hdl
= zpool_handle(zhp
)) == NULL
)
440 make_dataset_handle(libzfs_handle_t
*hdl
, const char *path
)
442 zfs_cmd_t zc
= {"\0"};
444 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
450 (void) strlcpy(zhp
->zfs_name
, path
, sizeof (zhp
->zfs_name
));
451 if (zcmd_alloc_dst_nvlist(hdl
, &zc
, 0) != 0) {
455 if (get_stats_ioctl(zhp
, &zc
) == -1) {
456 zcmd_free_nvlists(&zc
);
460 if (make_dataset_handle_common(zhp
, &zc
) == -1) {
464 zcmd_free_nvlists(&zc
);
469 make_dataset_handle_zc(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
)
471 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
477 (void) strlcpy(zhp
->zfs_name
, zc
->zc_name
, sizeof (zhp
->zfs_name
));
478 if (make_dataset_handle_common(zhp
, zc
) == -1) {
486 make_dataset_simple_handle_zc(zfs_handle_t
*pzhp
, zfs_cmd_t
*zc
)
488 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
493 zhp
->zfs_hdl
= pzhp
->zfs_hdl
;
494 (void) strlcpy(zhp
->zfs_name
, zc
->zc_name
, sizeof (zhp
->zfs_name
));
495 zhp
->zfs_head_type
= pzhp
->zfs_type
;
496 zhp
->zfs_type
= ZFS_TYPE_SNAPSHOT
;
497 zhp
->zpool_hdl
= zpool_handle(zhp
);
503 zfs_handle_dup(zfs_handle_t
*zhp_orig
)
505 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
510 zhp
->zfs_hdl
= zhp_orig
->zfs_hdl
;
511 zhp
->zpool_hdl
= zhp_orig
->zpool_hdl
;
512 (void) strlcpy(zhp
->zfs_name
, zhp_orig
->zfs_name
,
513 sizeof (zhp
->zfs_name
));
514 zhp
->zfs_type
= zhp_orig
->zfs_type
;
515 zhp
->zfs_head_type
= zhp_orig
->zfs_head_type
;
516 zhp
->zfs_dmustats
= zhp_orig
->zfs_dmustats
;
517 if (zhp_orig
->zfs_props
!= NULL
) {
518 if (nvlist_dup(zhp_orig
->zfs_props
, &zhp
->zfs_props
, 0) != 0) {
519 (void) no_memory(zhp
->zfs_hdl
);
524 if (zhp_orig
->zfs_user_props
!= NULL
) {
525 if (nvlist_dup(zhp_orig
->zfs_user_props
,
526 &zhp
->zfs_user_props
, 0) != 0) {
527 (void) no_memory(zhp
->zfs_hdl
);
532 if (zhp_orig
->zfs_recvd_props
!= NULL
) {
533 if (nvlist_dup(zhp_orig
->zfs_recvd_props
,
534 &zhp
->zfs_recvd_props
, 0)) {
535 (void) no_memory(zhp
->zfs_hdl
);
540 zhp
->zfs_mntcheck
= zhp_orig
->zfs_mntcheck
;
541 if (zhp_orig
->zfs_mntopts
!= NULL
) {
542 zhp
->zfs_mntopts
= zfs_strdup(zhp_orig
->zfs_hdl
,
543 zhp_orig
->zfs_mntopts
);
545 zhp
->zfs_props_table
= zhp_orig
->zfs_props_table
;
550 zfs_bookmark_exists(const char *path
)
554 char fsname
[ZFS_MAX_DATASET_NAME_LEN
];
561 (void) strlcpy(fsname
, path
, sizeof (fsname
));
562 pound
= strchr(fsname
, '#');
567 bmark_name
= pound
+ 1;
568 props
= fnvlist_alloc();
569 err
= lzc_get_bookmarks(fsname
, props
, &bmarks
);
576 rv
= nvlist_exists(bmarks
, bmark_name
);
582 make_bookmark_handle(zfs_handle_t
*parent
, const char *path
,
583 nvlist_t
*bmark_props
)
585 zfs_handle_t
*zhp
= calloc(sizeof (zfs_handle_t
), 1);
590 /* Fill in the name. */
591 zhp
->zfs_hdl
= parent
->zfs_hdl
;
592 (void) strlcpy(zhp
->zfs_name
, path
, sizeof (zhp
->zfs_name
));
594 /* Set the property lists. */
595 if (nvlist_dup(bmark_props
, &zhp
->zfs_props
, 0) != 0) {
601 zhp
->zfs_head_type
= parent
->zfs_head_type
;
602 zhp
->zfs_type
= ZFS_TYPE_BOOKMARK
;
604 if ((zhp
->zpool_hdl
= zpool_handle(zhp
)) == NULL
) {
605 nvlist_free(zhp
->zfs_props
);
614 * Opens the given snapshot, filesystem, or volume. The 'types'
615 * argument is a mask of acceptable types. The function will print an
616 * appropriate error message and return NULL if it can't be opened.
619 zfs_open(libzfs_handle_t
*hdl
, const char *path
, int types
)
624 (void) snprintf(errbuf
, sizeof (errbuf
),
625 dgettext(TEXT_DOMAIN
, "cannot open '%s'"), path
);
628 * Validate the name before we even try to open it.
630 if (!zfs_validate_name(hdl
, path
, ZFS_TYPE_DATASET
, B_FALSE
)) {
631 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
632 "invalid dataset name"));
633 (void) zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
638 * Try to get stats for the dataset, which will tell us if it exists.
641 if ((zhp
= make_dataset_handle(hdl
, path
)) == NULL
) {
642 (void) zfs_standard_error(hdl
, errno
, errbuf
);
646 if (!(types
& zhp
->zfs_type
)) {
647 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
656 * Release a ZFS handle. Nothing to do but free the associated memory.
659 zfs_close(zfs_handle_t
*zhp
)
661 if (zhp
->zfs_mntopts
)
662 free(zhp
->zfs_mntopts
);
663 nvlist_free(zhp
->zfs_props
);
664 nvlist_free(zhp
->zfs_user_props
);
665 nvlist_free(zhp
->zfs_recvd_props
);
669 typedef struct mnttab_node
{
670 struct mnttab mtn_mt
;
675 libzfs_mnttab_cache_compare(const void *arg1
, const void *arg2
)
677 const mnttab_node_t
*mtn1
= (const mnttab_node_t
*)arg1
;
678 const mnttab_node_t
*mtn2
= (const mnttab_node_t
*)arg2
;
681 rv
= strcmp(mtn1
->mtn_mt
.mnt_special
, mtn2
->mtn_mt
.mnt_special
);
683 return (AVL_ISIGN(rv
));
687 libzfs_mnttab_init(libzfs_handle_t
*hdl
)
689 assert(avl_numnodes(&hdl
->libzfs_mnttab_cache
) == 0);
690 avl_create(&hdl
->libzfs_mnttab_cache
, libzfs_mnttab_cache_compare
,
691 sizeof (mnttab_node_t
), offsetof(mnttab_node_t
, mtn_node
));
695 libzfs_mnttab_update(libzfs_handle_t
*hdl
)
699 /* Reopen MNTTAB to prevent reading stale data from open file */
700 if (freopen(MNTTAB
, "r", hdl
->libzfs_mnttab
) == NULL
)
703 while (getmntent(hdl
->libzfs_mnttab
, &entry
) == 0) {
707 if (strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0)
710 mtn
= zfs_alloc(hdl
, sizeof (mnttab_node_t
));
711 mtn
->mtn_mt
.mnt_special
= zfs_strdup(hdl
, entry
.mnt_special
);
712 mtn
->mtn_mt
.mnt_mountp
= zfs_strdup(hdl
, entry
.mnt_mountp
);
713 mtn
->mtn_mt
.mnt_fstype
= zfs_strdup(hdl
, entry
.mnt_fstype
);
714 mtn
->mtn_mt
.mnt_mntopts
= zfs_strdup(hdl
, entry
.mnt_mntopts
);
716 /* Exclude duplicate mounts */
717 if (avl_find(&hdl
->libzfs_mnttab_cache
, mtn
, &where
) != NULL
) {
718 free(mtn
->mtn_mt
.mnt_special
);
719 free(mtn
->mtn_mt
.mnt_mountp
);
720 free(mtn
->mtn_mt
.mnt_fstype
);
721 free(mtn
->mtn_mt
.mnt_mntopts
);
726 avl_add(&hdl
->libzfs_mnttab_cache
, mtn
);
733 libzfs_mnttab_fini(libzfs_handle_t
*hdl
)
738 while ((mtn
= avl_destroy_nodes(&hdl
->libzfs_mnttab_cache
, &cookie
))) {
739 free(mtn
->mtn_mt
.mnt_special
);
740 free(mtn
->mtn_mt
.mnt_mountp
);
741 free(mtn
->mtn_mt
.mnt_fstype
);
742 free(mtn
->mtn_mt
.mnt_mntopts
);
745 avl_destroy(&hdl
->libzfs_mnttab_cache
);
749 libzfs_mnttab_cache(libzfs_handle_t
*hdl
, boolean_t enable
)
751 hdl
->libzfs_mnttab_enable
= enable
;
755 libzfs_mnttab_find(libzfs_handle_t
*hdl
, const char *fsname
,
756 struct mnttab
*entry
)
762 if (!hdl
->libzfs_mnttab_enable
) {
763 struct mnttab srch
= { 0 };
765 if (avl_numnodes(&hdl
->libzfs_mnttab_cache
))
766 libzfs_mnttab_fini(hdl
);
768 /* Reopen MNTTAB to prevent reading stale data from open file */
769 if (freopen(MNTTAB
, "r", hdl
->libzfs_mnttab
) == NULL
)
772 srch
.mnt_special
= (char *)fsname
;
773 srch
.mnt_fstype
= MNTTYPE_ZFS
;
774 if (getmntany(hdl
->libzfs_mnttab
, entry
, &srch
) == 0)
780 if (avl_numnodes(&hdl
->libzfs_mnttab_cache
) == 0)
781 if ((error
= libzfs_mnttab_update(hdl
)) != 0)
784 find
.mtn_mt
.mnt_special
= (char *)fsname
;
785 mtn
= avl_find(&hdl
->libzfs_mnttab_cache
, &find
, NULL
);
787 *entry
= mtn
->mtn_mt
;
794 libzfs_mnttab_add(libzfs_handle_t
*hdl
, const char *special
,
795 const char *mountp
, const char *mntopts
)
799 if (avl_numnodes(&hdl
->libzfs_mnttab_cache
) == 0)
801 mtn
= zfs_alloc(hdl
, sizeof (mnttab_node_t
));
802 mtn
->mtn_mt
.mnt_special
= zfs_strdup(hdl
, special
);
803 mtn
->mtn_mt
.mnt_mountp
= zfs_strdup(hdl
, mountp
);
804 mtn
->mtn_mt
.mnt_fstype
= zfs_strdup(hdl
, MNTTYPE_ZFS
);
805 mtn
->mtn_mt
.mnt_mntopts
= zfs_strdup(hdl
, mntopts
);
806 avl_add(&hdl
->libzfs_mnttab_cache
, mtn
);
810 libzfs_mnttab_remove(libzfs_handle_t
*hdl
, const char *fsname
)
815 find
.mtn_mt
.mnt_special
= (char *)fsname
;
816 if ((ret
= avl_find(&hdl
->libzfs_mnttab_cache
, (void *)&find
, NULL
))) {
817 avl_remove(&hdl
->libzfs_mnttab_cache
, ret
);
818 free(ret
->mtn_mt
.mnt_special
);
819 free(ret
->mtn_mt
.mnt_mountp
);
820 free(ret
->mtn_mt
.mnt_fstype
);
821 free(ret
->mtn_mt
.mnt_mntopts
);
827 zfs_spa_version(zfs_handle_t
*zhp
, int *spa_version
)
829 zpool_handle_t
*zpool_handle
= zhp
->zpool_hdl
;
831 if (zpool_handle
== NULL
)
834 *spa_version
= zpool_get_prop_int(zpool_handle
,
835 ZPOOL_PROP_VERSION
, NULL
);
840 * The choice of reservation property depends on the SPA version.
843 zfs_which_resv_prop(zfs_handle_t
*zhp
, zfs_prop_t
*resv_prop
)
847 if (zfs_spa_version(zhp
, &spa_version
) < 0)
850 if (spa_version
>= SPA_VERSION_REFRESERVATION
)
851 *resv_prop
= ZFS_PROP_REFRESERVATION
;
853 *resv_prop
= ZFS_PROP_RESERVATION
;
859 * Given an nvlist of properties to set, validates that they are correct, and
860 * parses any numeric properties (index, boolean, etc) if they are specified as
864 zfs_valid_proplist(libzfs_handle_t
*hdl
, zfs_type_t type
, nvlist_t
*nvl
,
865 uint64_t zoned
, zfs_handle_t
*zhp
, zpool_handle_t
*zpool_hdl
,
873 int chosen_normal
= -1;
876 if (nvlist_alloc(&ret
, NV_UNIQUE_NAME
, 0) != 0) {
877 (void) no_memory(hdl
);
882 * Make sure this property is valid and applies to this type.
886 while ((elem
= nvlist_next_nvpair(nvl
, elem
)) != NULL
) {
887 const char *propname
= nvpair_name(elem
);
889 prop
= zfs_name_to_prop(propname
);
890 if (prop
== ZPROP_INVAL
&& zfs_prop_user(propname
)) {
892 * This is a user property: make sure it's a
893 * string, and that it's less than ZAP_MAXNAMELEN.
895 if (nvpair_type(elem
) != DATA_TYPE_STRING
) {
896 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
897 "'%s' must be a string"), propname
);
898 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
902 if (strlen(nvpair_name(elem
)) >= ZAP_MAXNAMELEN
) {
903 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
904 "property name '%s' is too long"),
906 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
910 (void) nvpair_value_string(elem
, &strval
);
911 if (nvlist_add_string(ret
, propname
, strval
) != 0) {
912 (void) no_memory(hdl
);
919 * Currently, only user properties can be modified on
922 if (type
== ZFS_TYPE_SNAPSHOT
) {
923 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
924 "this property can not be modified for snapshots"));
925 (void) zfs_error(hdl
, EZFS_PROPTYPE
, errbuf
);
929 if (prop
== ZPROP_INVAL
&& zfs_prop_userquota(propname
)) {
930 zfs_userquota_prop_t uqtype
;
931 char newpropname
[128];
936 if (userquota_propname_decode(propname
, zoned
,
937 &uqtype
, domain
, sizeof (domain
), &rid
) != 0) {
939 dgettext(TEXT_DOMAIN
,
940 "'%s' has an invalid user/group name"),
942 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
946 if (uqtype
!= ZFS_PROP_USERQUOTA
&&
947 uqtype
!= ZFS_PROP_GROUPQUOTA
) {
949 dgettext(TEXT_DOMAIN
, "'%s' is readonly"),
951 (void) zfs_error(hdl
, EZFS_PROPREADONLY
,
956 if (nvpair_type(elem
) == DATA_TYPE_STRING
) {
957 (void) nvpair_value_string(elem
, &strval
);
958 if (strcmp(strval
, "none") == 0) {
960 } else if (zfs_nicestrtonum(hdl
,
961 strval
, &intval
) != 0) {
962 (void) zfs_error(hdl
,
963 EZFS_BADPROP
, errbuf
);
966 } else if (nvpair_type(elem
) ==
968 (void) nvpair_value_uint64(elem
, &intval
);
970 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
971 "use 'none' to disable "
972 "userquota/groupquota"));
976 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
977 "'%s' must be a number"), propname
);
978 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
983 * Encode the prop name as
984 * userquota@<hex-rid>-domain, to make it easy
985 * for the kernel to decode.
987 (void) snprintf(newpropname
, sizeof (newpropname
),
988 "%s%llx-%s", zfs_userquota_prop_prefixes
[uqtype
],
989 (longlong_t
)rid
, domain
);
993 if (nvlist_add_uint64_array(ret
, newpropname
,
995 (void) no_memory(hdl
);
999 } else if (prop
== ZPROP_INVAL
&& zfs_prop_written(propname
)) {
1000 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1001 "'%s' is readonly"),
1003 (void) zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
);
1007 if (prop
== ZPROP_INVAL
) {
1008 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1009 "invalid property '%s'"), propname
);
1010 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1014 if (!zfs_prop_valid_for_type(prop
, type
, B_FALSE
)) {
1016 dgettext(TEXT_DOMAIN
, "'%s' does not "
1017 "apply to datasets of this type"), propname
);
1018 (void) zfs_error(hdl
, EZFS_PROPTYPE
, errbuf
);
1022 if (zfs_prop_readonly(prop
) &&
1023 (!zfs_prop_setonce(prop
) || zhp
!= NULL
)) {
1025 dgettext(TEXT_DOMAIN
, "'%s' is readonly"),
1027 (void) zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
);
1031 if (zprop_parse_value(hdl
, elem
, prop
, type
, ret
,
1032 &strval
, &intval
, errbuf
) != 0)
1036 * Perform some additional checks for specific properties.
1039 case ZFS_PROP_VERSION
:
1045 version
= zfs_prop_get_int(zhp
, ZFS_PROP_VERSION
);
1046 if (intval
< version
) {
1047 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1048 "Can not downgrade; already at version %u"),
1050 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1056 case ZFS_PROP_VOLBLOCKSIZE
:
1057 case ZFS_PROP_RECORDSIZE
:
1059 int maxbs
= SPA_MAXBLOCKSIZE
;
1062 if (zpool_hdl
!= NULL
) {
1063 maxbs
= zpool_get_prop_int(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_nicenum(maxbs
, buf
, sizeof (buf
));
1073 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1074 "'%s' must be power of 2 from 512B "
1075 "to %s"), propname
, buf
);
1076 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1081 case ZFS_PROP_MLSLABEL
:
1083 #ifdef HAVE_MLSLABEL
1085 * Verify the mlslabel string and convert to
1086 * internal hex label string.
1090 char *hex
= NULL
; /* internal label string */
1092 /* Default value is already OK. */
1093 if (strcasecmp(strval
, ZFS_MLSLABEL_DEFAULT
) == 0)
1096 /* Verify the label can be converted to binary form */
1097 if (((new_sl
= m_label_alloc(MAC_LABEL
)) == NULL
) ||
1098 (str_to_label(strval
, &new_sl
, MAC_LABEL
,
1099 L_NO_CORRECTION
, NULL
) == -1)) {
1103 /* Now translate to hex internal label string */
1104 if (label_to_str(new_sl
, &hex
, M_INTERNAL
,
1110 m_label_free(new_sl
);
1112 /* If string is already in internal form, we're done. */
1113 if (strcmp(strval
, hex
) == 0) {
1118 /* Replace the label string with the internal form. */
1119 (void) nvlist_remove(ret
, zfs_prop_to_name(prop
),
1121 verify(nvlist_add_string(ret
, zfs_prop_to_name(prop
),
1128 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1129 "invalid mlslabel '%s'"), strval
);
1130 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1131 m_label_free(new_sl
); /* OK if null */
1134 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1135 "mlslabels are unsupported"));
1136 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1138 #endif /* HAVE_MLSLABEL */
1141 case ZFS_PROP_MOUNTPOINT
:
1143 namecheck_err_t why
;
1145 if (strcmp(strval
, ZFS_MOUNTPOINT_NONE
) == 0 ||
1146 strcmp(strval
, ZFS_MOUNTPOINT_LEGACY
) == 0)
1149 if (mountpoint_namecheck(strval
, &why
)) {
1151 case NAME_ERR_LEADING_SLASH
:
1153 dgettext(TEXT_DOMAIN
,
1154 "'%s' must be an absolute path, "
1155 "'none', or 'legacy'"), propname
);
1157 case NAME_ERR_TOOLONG
:
1159 dgettext(TEXT_DOMAIN
,
1160 "component of '%s' is too long"),
1166 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1173 case ZFS_PROP_SHARESMB
:
1174 case ZFS_PROP_SHARENFS
:
1176 * For the mountpoint and sharenfs or sharesmb
1177 * properties, check if it can be set in a
1178 * global/non-global zone based on
1179 * the zoned property value:
1181 * global zone non-global zone
1182 * --------------------------------------------------
1183 * zoned=on mountpoint (no) mountpoint (yes)
1184 * sharenfs (no) sharenfs (no)
1185 * sharesmb (no) sharesmb (no)
1187 * zoned=off mountpoint (yes) N/A
1192 if (getzoneid() == GLOBAL_ZONEID
) {
1193 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1194 "'%s' cannot be set on "
1195 "dataset in a non-global zone"),
1197 (void) zfs_error(hdl
, EZFS_ZONED
,
1200 } else if (prop
== ZFS_PROP_SHARENFS
||
1201 prop
== ZFS_PROP_SHARESMB
) {
1202 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1203 "'%s' cannot be set in "
1204 "a non-global zone"), propname
);
1205 (void) zfs_error(hdl
, EZFS_ZONED
,
1209 } else if (getzoneid() != GLOBAL_ZONEID
) {
1211 * If zoned property is 'off', this must be in
1212 * a global zone. If not, something is wrong.
1214 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1215 "'%s' cannot be set while dataset "
1216 "'zoned' property is set"), propname
);
1217 (void) zfs_error(hdl
, EZFS_ZONED
, errbuf
);
1222 * At this point, it is legitimate to set the
1223 * property. Now we want to make sure that the
1224 * property value is valid if it is sharenfs.
1226 if ((prop
== ZFS_PROP_SHARENFS
||
1227 prop
== ZFS_PROP_SHARESMB
) &&
1228 strcmp(strval
, "on") != 0 &&
1229 strcmp(strval
, "off") != 0) {
1230 zfs_share_proto_t proto
;
1232 if (prop
== ZFS_PROP_SHARESMB
)
1238 * Must be an valid sharing protocol
1239 * option string so init the libshare
1240 * in order to enable the parser and
1241 * then parse the options. We use the
1242 * control API since we don't care about
1243 * the current configuration and don't
1244 * want the overhead of loading it
1245 * until we actually do something.
1248 if (zfs_init_libshare(hdl
,
1249 SA_INIT_CONTROL_API
) != SA_OK
) {
1251 * An error occurred so we can't do
1254 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1255 "'%s' cannot be set: problem "
1256 "in share initialization"),
1258 (void) zfs_error(hdl
, EZFS_BADPROP
,
1263 if (zfs_parse_options(strval
, proto
) != SA_OK
) {
1265 * There was an error in parsing so
1266 * deal with it by issuing an error
1267 * message and leaving after
1268 * uninitializing the the libshare
1271 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1272 "'%s' cannot be set to invalid "
1273 "options"), propname
);
1274 (void) zfs_error(hdl
, EZFS_BADPROP
,
1276 zfs_uninit_libshare(hdl
);
1279 zfs_uninit_libshare(hdl
);
1283 case ZFS_PROP_UTF8ONLY
:
1284 chosen_utf
= (int)intval
;
1286 case ZFS_PROP_NORMALIZE
:
1287 chosen_normal
= (int)intval
;
1294 * For changes to existing volumes, we have some additional
1295 * checks to enforce.
1297 if (type
== ZFS_TYPE_VOLUME
&& zhp
!= NULL
) {
1298 uint64_t volsize
= zfs_prop_get_int(zhp
,
1300 uint64_t blocksize
= zfs_prop_get_int(zhp
,
1301 ZFS_PROP_VOLBLOCKSIZE
);
1305 case ZFS_PROP_RESERVATION
:
1306 case ZFS_PROP_REFRESERVATION
:
1307 if (intval
> volsize
) {
1308 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1309 "'%s' is greater than current "
1310 "volume size"), propname
);
1311 (void) zfs_error(hdl
, EZFS_BADPROP
,
1317 case ZFS_PROP_VOLSIZE
:
1318 if (intval
% blocksize
!= 0) {
1319 zfs_nicenum(blocksize
, buf
,
1321 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1322 "'%s' must be a multiple of "
1323 "volume block size (%s)"),
1325 (void) zfs_error(hdl
, EZFS_BADPROP
,
1331 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1332 "'%s' cannot be zero"),
1334 (void) zfs_error(hdl
, EZFS_BADPROP
,
1346 * If normalization was chosen, but no UTF8 choice was made,
1347 * enforce rejection of non-UTF8 names.
1349 * If normalization was chosen, but rejecting non-UTF8 names
1350 * was explicitly not chosen, it is an error.
1352 if (chosen_normal
> 0 && chosen_utf
< 0) {
1353 if (nvlist_add_uint64(ret
,
1354 zfs_prop_to_name(ZFS_PROP_UTF8ONLY
), 1) != 0) {
1355 (void) no_memory(hdl
);
1358 } else if (chosen_normal
> 0 && chosen_utf
== 0) {
1359 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1360 "'%s' must be set 'on' if normalization chosen"),
1361 zfs_prop_to_name(ZFS_PROP_UTF8ONLY
));
1362 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1373 zfs_add_synthetic_resv(zfs_handle_t
*zhp
, nvlist_t
*nvl
)
1375 uint64_t old_volsize
;
1376 uint64_t new_volsize
;
1377 uint64_t old_reservation
;
1378 uint64_t new_reservation
;
1379 zfs_prop_t resv_prop
;
1383 * If this is an existing volume, and someone is setting the volsize,
1384 * make sure that it matches the reservation, or add it if necessary.
1386 old_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
1387 if (zfs_which_resv_prop(zhp
, &resv_prop
) < 0)
1389 old_reservation
= zfs_prop_get_int(zhp
, resv_prop
);
1391 props
= fnvlist_alloc();
1392 fnvlist_add_uint64(props
, zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
1393 zfs_prop_get_int(zhp
, ZFS_PROP_VOLBLOCKSIZE
));
1395 if ((zvol_volsize_to_reservation(old_volsize
, props
) !=
1396 old_reservation
) || nvlist_exists(nvl
,
1397 zfs_prop_to_name(resv_prop
))) {
1398 fnvlist_free(props
);
1401 if (nvlist_lookup_uint64(nvl
, zfs_prop_to_name(ZFS_PROP_VOLSIZE
),
1402 &new_volsize
) != 0) {
1403 fnvlist_free(props
);
1406 new_reservation
= zvol_volsize_to_reservation(new_volsize
, props
);
1407 fnvlist_free(props
);
1409 if (nvlist_add_uint64(nvl
, zfs_prop_to_name(resv_prop
),
1410 new_reservation
) != 0) {
1411 (void) no_memory(zhp
->zfs_hdl
);
1418 zfs_setprop_error(libzfs_handle_t
*hdl
, zfs_prop_t prop
, int err
,
1425 * For quotas and reservations, ENOSPC indicates
1426 * something different; setting a quota or reservation
1427 * doesn't use any disk space.
1430 case ZFS_PROP_QUOTA
:
1431 case ZFS_PROP_REFQUOTA
:
1432 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1433 "size is less than current used or "
1435 (void) zfs_error(hdl
, EZFS_PROPSPACE
, errbuf
);
1438 case ZFS_PROP_RESERVATION
:
1439 case ZFS_PROP_REFRESERVATION
:
1440 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1441 "size is greater than available space"));
1442 (void) zfs_error(hdl
, EZFS_PROPSPACE
, errbuf
);
1446 (void) zfs_standard_error(hdl
, err
, errbuf
);
1452 (void) zfs_standard_error(hdl
, EBUSY
, errbuf
);
1456 (void) zfs_error(hdl
, EZFS_DSREADONLY
, errbuf
);
1460 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1461 "property value too long"));
1462 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1466 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1467 "pool and or dataset must be upgraded to set this "
1468 "property or value"));
1469 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
1473 if (prop
== ZFS_PROP_COMPRESSION
||
1474 prop
== ZFS_PROP_DNODESIZE
||
1475 prop
== ZFS_PROP_RECORDSIZE
) {
1476 (void) zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1477 "property setting is not allowed on "
1478 "bootable datasets"));
1479 (void) zfs_error(hdl
, EZFS_NOTSUP
, errbuf
);
1481 (void) zfs_standard_error(hdl
, err
, errbuf
);
1486 if (prop
== ZPROP_INVAL
) {
1487 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1489 (void) zfs_standard_error(hdl
, err
, errbuf
);
1495 * This platform can't address a volume this big.
1498 if (prop
== ZFS_PROP_VOLSIZE
) {
1499 (void) zfs_error(hdl
, EZFS_VOLTOOBIG
, errbuf
);
1505 (void) zfs_standard_error(hdl
, err
, errbuf
);
1510 zfs_is_namespace_prop(zfs_prop_t prop
)
1514 case ZFS_PROP_ATIME
:
1515 case ZFS_PROP_RELATIME
:
1516 case ZFS_PROP_DEVICES
:
1518 case ZFS_PROP_SETUID
:
1519 case ZFS_PROP_READONLY
:
1520 case ZFS_PROP_XATTR
:
1521 case ZFS_PROP_NBMAND
:
1530 * Given a property name and value, set the property for the given dataset.
1533 zfs_prop_set(zfs_handle_t
*zhp
, const char *propname
, const char *propval
)
1537 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1538 nvlist_t
*nvl
= NULL
;
1540 (void) snprintf(errbuf
, sizeof (errbuf
),
1541 dgettext(TEXT_DOMAIN
, "cannot set property for '%s'"),
1544 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0 ||
1545 nvlist_add_string(nvl
, propname
, propval
) != 0) {
1546 (void) no_memory(hdl
);
1550 ret
= zfs_prop_set_list(zhp
, nvl
);
1560 * Given an nvlist of property names and values, set the properties for the
1564 zfs_prop_set_list(zfs_handle_t
*zhp
, nvlist_t
*props
)
1566 zfs_cmd_t zc
= {"\0"};
1568 prop_changelist_t
**cls
= NULL
;
1571 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1575 zfs_prop_t prop
= 0;
1578 (void) snprintf(errbuf
, sizeof (errbuf
),
1579 dgettext(TEXT_DOMAIN
, "cannot set property for '%s'"),
1582 if ((nvl
= zfs_valid_proplist(hdl
, zhp
->zfs_type
, props
,
1583 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
), zhp
, zhp
->zpool_hdl
,
1588 * We have to check for any extra properties which need to be added
1589 * before computing the length of the nvlist.
1591 for (elem
= nvlist_next_nvpair(nvl
, NULL
);
1593 elem
= nvlist_next_nvpair(nvl
, elem
)) {
1594 if (zfs_name_to_prop(nvpair_name(elem
)) == ZFS_PROP_VOLSIZE
&&
1595 (added_resv
= zfs_add_synthetic_resv(zhp
, nvl
)) == -1) {
1600 * Check how many properties we're setting and allocate an array to
1601 * store changelist pointers for postfix().
1603 for (elem
= nvlist_next_nvpair(nvl
, NULL
);
1605 elem
= nvlist_next_nvpair(nvl
, elem
))
1607 if ((cls
= calloc(nvl_len
, sizeof (prop_changelist_t
*))) == NULL
)
1611 for (elem
= nvlist_next_nvpair(nvl
, NULL
);
1613 elem
= nvlist_next_nvpair(nvl
, elem
)) {
1615 prop
= zfs_name_to_prop(nvpair_name(elem
));
1617 assert(cl_idx
< nvl_len
);
1619 * We don't want to unmount & remount the dataset when changing
1620 * its canmount property to 'on' or 'noauto'. We only use
1621 * the changelist logic to unmount when setting canmount=off.
1623 if (!(prop
== ZFS_PROP_CANMOUNT
&&
1624 fnvpair_value_uint64(elem
) != ZFS_CANMOUNT_OFF
)) {
1625 cls
[cl_idx
] = changelist_gather(zhp
, prop
, 0, 0);
1626 if (cls
[cl_idx
] == NULL
)
1630 if (prop
== ZFS_PROP_MOUNTPOINT
&&
1631 changelist_haszonedchild(cls
[cl_idx
])) {
1632 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1633 "child dataset with inherited mountpoint is used "
1634 "in a non-global zone"));
1635 ret
= zfs_error(hdl
, EZFS_ZONED
, errbuf
);
1639 if (cls
[cl_idx
] != NULL
&&
1640 (ret
= changelist_prefix(cls
[cl_idx
])) != 0)
1645 assert(cl_idx
== nvl_len
);
1648 * Execute the corresponding ioctl() to set this list of properties.
1650 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1652 if ((ret
= zcmd_write_src_nvlist(hdl
, &zc
, nvl
)) != 0 ||
1653 (ret
= zcmd_alloc_dst_nvlist(hdl
, &zc
, 0)) != 0)
1656 ret
= zfs_ioctl(hdl
, ZFS_IOC_SET_PROP
, &zc
);
1659 /* Get the list of unset properties back and report them. */
1660 nvlist_t
*errorprops
= NULL
;
1661 if (zcmd_read_dst_nvlist(hdl
, &zc
, &errorprops
) != 0)
1663 for (elem
= nvlist_next_nvpair(nvl
, NULL
);
1665 elem
= nvlist_next_nvpair(nvl
, elem
)) {
1666 prop
= zfs_name_to_prop(nvpair_name(elem
));
1667 zfs_setprop_error(hdl
, prop
, errno
, errbuf
);
1669 nvlist_free(errorprops
);
1671 if (added_resv
&& errno
== ENOSPC
) {
1672 /* clean up the volsize property we tried to set */
1673 uint64_t old_volsize
= zfs_prop_get_int(zhp
,
1677 zcmd_free_nvlists(&zc
);
1679 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0)
1681 if (nvlist_add_uint64(nvl
,
1682 zfs_prop_to_name(ZFS_PROP_VOLSIZE
),
1685 if (zcmd_write_src_nvlist(hdl
, &zc
, nvl
) != 0)
1687 (void) zfs_ioctl(hdl
, ZFS_IOC_SET_PROP
, &zc
);
1690 for (cl_idx
= 0; cl_idx
< nvl_len
; cl_idx
++) {
1691 if (cls
[cl_idx
] != NULL
) {
1692 int clp_err
= changelist_postfix(cls
[cl_idx
]);
1700 * Refresh the statistics so the new property
1701 * value is reflected.
1703 (void) get_stats(zhp
);
1706 * Remount the filesystem to propagate the change
1707 * if one of the options handled by the generic
1708 * Linux namespace layer has been modified.
1710 if (zfs_is_namespace_prop(prop
) &&
1711 zfs_is_mounted(zhp
, NULL
))
1712 ret
= zfs_mount(zhp
, MNTOPT_REMOUNT
, 0);
1718 zcmd_free_nvlists(&zc
);
1720 for (cl_idx
= 0; cl_idx
< nvl_len
; cl_idx
++) {
1721 if (cls
[cl_idx
] != NULL
)
1722 changelist_free(cls
[cl_idx
]);
1730 * Given a property, inherit the value from the parent dataset, or if received
1731 * is TRUE, revert to the received value, if any.
1734 zfs_prop_inherit(zfs_handle_t
*zhp
, const char *propname
, boolean_t received
)
1736 zfs_cmd_t zc
= {"\0"};
1738 prop_changelist_t
*cl
;
1739 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1743 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1744 "cannot inherit %s for '%s'"), propname
, zhp
->zfs_name
);
1746 zc
.zc_cookie
= received
;
1747 if ((prop
= zfs_name_to_prop(propname
)) == ZPROP_INVAL
) {
1749 * For user properties, the amount of work we have to do is very
1750 * small, so just do it here.
1752 if (!zfs_prop_user(propname
)) {
1753 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1754 "invalid property"));
1755 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
1758 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1759 (void) strlcpy(zc
.zc_value
, propname
, sizeof (zc
.zc_value
));
1761 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_INHERIT_PROP
, &zc
) != 0)
1762 return (zfs_standard_error(hdl
, errno
, errbuf
));
1768 * Verify that this property is inheritable.
1770 if (zfs_prop_readonly(prop
))
1771 return (zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
));
1773 if (!zfs_prop_inheritable(prop
) && !received
)
1774 return (zfs_error(hdl
, EZFS_PROPNONINHERIT
, errbuf
));
1777 * Check to see if the value applies to this type
1779 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
))
1780 return (zfs_error(hdl
, EZFS_PROPTYPE
, errbuf
));
1783 * Normalize the name, to get rid of shorthand abbreviations.
1785 propname
= zfs_prop_to_name(prop
);
1786 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
1787 (void) strlcpy(zc
.zc_value
, propname
, sizeof (zc
.zc_value
));
1789 if (prop
== ZFS_PROP_MOUNTPOINT
&& getzoneid() == GLOBAL_ZONEID
&&
1790 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
)) {
1791 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1792 "dataset is used in a non-global zone"));
1793 return (zfs_error(hdl
, EZFS_ZONED
, errbuf
));
1797 * Determine datasets which will be affected by this change, if any.
1799 if ((cl
= changelist_gather(zhp
, prop
, 0, 0)) == NULL
)
1802 if (prop
== ZFS_PROP_MOUNTPOINT
&& changelist_haszonedchild(cl
)) {
1803 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1804 "child dataset with inherited mountpoint is used "
1805 "in a non-global zone"));
1806 ret
= zfs_error(hdl
, EZFS_ZONED
, errbuf
);
1810 if ((ret
= changelist_prefix(cl
)) != 0)
1813 if ((ret
= zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_INHERIT_PROP
, &zc
)) != 0) {
1814 return (zfs_standard_error(hdl
, errno
, errbuf
));
1817 if ((ret
= changelist_postfix(cl
)) != 0)
1821 * Refresh the statistics so the new property is reflected.
1823 (void) get_stats(zhp
);
1826 * Remount the filesystem to propagate the change
1827 * if one of the options handled by the generic
1828 * Linux namespace layer has been modified.
1830 if (zfs_is_namespace_prop(prop
) &&
1831 zfs_is_mounted(zhp
, NULL
))
1832 ret
= zfs_mount(zhp
, MNTOPT_REMOUNT
, 0);
1836 changelist_free(cl
);
1841 * True DSL properties are stored in an nvlist. The following two functions
1842 * extract them appropriately.
1845 getprop_uint64(zfs_handle_t
*zhp
, zfs_prop_t prop
, char **source
)
1851 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
1852 zfs_prop_to_name(prop
), &nv
) == 0) {
1853 verify(nvlist_lookup_uint64(nv
, ZPROP_VALUE
, &value
) == 0);
1854 (void) nvlist_lookup_string(nv
, ZPROP_SOURCE
, source
);
1856 verify(!zhp
->zfs_props_table
||
1857 zhp
->zfs_props_table
[prop
] == B_TRUE
);
1858 value
= zfs_prop_default_numeric(prop
);
1866 getprop_string(zfs_handle_t
*zhp
, zfs_prop_t prop
, char **source
)
1872 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
1873 zfs_prop_to_name(prop
), &nv
) == 0) {
1874 value
= fnvlist_lookup_string(nv
, ZPROP_VALUE
);
1875 (void) nvlist_lookup_string(nv
, ZPROP_SOURCE
, source
);
1877 verify(!zhp
->zfs_props_table
||
1878 zhp
->zfs_props_table
[prop
] == B_TRUE
);
1879 value
= zfs_prop_default_string(prop
);
1887 zfs_is_recvd_props_mode(zfs_handle_t
*zhp
)
1889 return (zhp
->zfs_props
== zhp
->zfs_recvd_props
);
1893 zfs_set_recvd_props_mode(zfs_handle_t
*zhp
, uint64_t *cookie
)
1895 *cookie
= (uint64_t)(uintptr_t)zhp
->zfs_props
;
1896 zhp
->zfs_props
= zhp
->zfs_recvd_props
;
1900 zfs_unset_recvd_props_mode(zfs_handle_t
*zhp
, uint64_t *cookie
)
1902 zhp
->zfs_props
= (nvlist_t
*)(uintptr_t)*cookie
;
1907 * Internal function for getting a numeric property. Both zfs_prop_get() and
1908 * zfs_prop_get_int() are built using this interface.
1910 * Certain properties can be overridden using 'mount -o'. In this case, scan
1911 * the contents of the /proc/self/mounts entry, searching for the
1912 * appropriate options. If they differ from the on-disk values, report the
1913 * current values and mark the source "temporary".
1916 get_numeric_property(zfs_handle_t
*zhp
, zfs_prop_t prop
, zprop_source_t
*src
,
1917 char **source
, uint64_t *val
)
1919 zfs_cmd_t zc
= {"\0"};
1920 nvlist_t
*zplprops
= NULL
;
1922 char *mntopt_on
= NULL
;
1923 char *mntopt_off
= NULL
;
1924 boolean_t received
= zfs_is_recvd_props_mode(zhp
);
1929 * If the property is being fetched for a snapshot, check whether
1930 * the property is valid for the snapshot's head dataset type.
1932 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
&&
1933 !zfs_prop_valid_for_type(prop
, zhp
->zfs_head_type
, B_TRUE
)) {
1934 *val
= zfs_prop_default_numeric(prop
);
1939 case ZFS_PROP_ATIME
:
1940 mntopt_on
= MNTOPT_ATIME
;
1941 mntopt_off
= MNTOPT_NOATIME
;
1944 case ZFS_PROP_RELATIME
:
1945 mntopt_on
= MNTOPT_RELATIME
;
1946 mntopt_off
= MNTOPT_NORELATIME
;
1949 case ZFS_PROP_DEVICES
:
1950 mntopt_on
= MNTOPT_DEVICES
;
1951 mntopt_off
= MNTOPT_NODEVICES
;
1955 mntopt_on
= MNTOPT_EXEC
;
1956 mntopt_off
= MNTOPT_NOEXEC
;
1959 case ZFS_PROP_READONLY
:
1960 mntopt_on
= MNTOPT_RO
;
1961 mntopt_off
= MNTOPT_RW
;
1964 case ZFS_PROP_SETUID
:
1965 mntopt_on
= MNTOPT_SETUID
;
1966 mntopt_off
= MNTOPT_NOSETUID
;
1969 case ZFS_PROP_XATTR
:
1970 mntopt_on
= MNTOPT_XATTR
;
1971 mntopt_off
= MNTOPT_NOXATTR
;
1974 case ZFS_PROP_NBMAND
:
1975 mntopt_on
= MNTOPT_NBMAND
;
1976 mntopt_off
= MNTOPT_NONBMAND
;
1983 * Because looking up the mount options is potentially expensive
1984 * (iterating over all of /proc/self/mounts), we defer its
1985 * calculation until we're looking up a property which requires
1988 if (!zhp
->zfs_mntcheck
&&
1989 (mntopt_on
!= NULL
|| prop
== ZFS_PROP_MOUNTED
)) {
1990 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
1991 struct mnttab entry
;
1993 if (libzfs_mnttab_find(hdl
, zhp
->zfs_name
, &entry
) == 0) {
1994 zhp
->zfs_mntopts
= zfs_strdup(hdl
,
1996 if (zhp
->zfs_mntopts
== NULL
)
2000 zhp
->zfs_mntcheck
= B_TRUE
;
2003 if (zhp
->zfs_mntopts
== NULL
)
2004 mnt
.mnt_mntopts
= "";
2006 mnt
.mnt_mntopts
= zhp
->zfs_mntopts
;
2009 case ZFS_PROP_ATIME
:
2010 case ZFS_PROP_RELATIME
:
2011 case ZFS_PROP_DEVICES
:
2013 case ZFS_PROP_READONLY
:
2014 case ZFS_PROP_SETUID
:
2015 case ZFS_PROP_XATTR
:
2016 case ZFS_PROP_NBMAND
:
2017 *val
= getprop_uint64(zhp
, prop
, source
);
2022 if (hasmntopt(&mnt
, mntopt_on
) && !*val
) {
2025 *src
= ZPROP_SRC_TEMPORARY
;
2026 } else if (hasmntopt(&mnt
, mntopt_off
) && *val
) {
2029 *src
= ZPROP_SRC_TEMPORARY
;
2033 case ZFS_PROP_CANMOUNT
:
2034 case ZFS_PROP_VOLSIZE
:
2035 case ZFS_PROP_QUOTA
:
2036 case ZFS_PROP_REFQUOTA
:
2037 case ZFS_PROP_RESERVATION
:
2038 case ZFS_PROP_REFRESERVATION
:
2039 case ZFS_PROP_FILESYSTEM_LIMIT
:
2040 case ZFS_PROP_SNAPSHOT_LIMIT
:
2041 case ZFS_PROP_FILESYSTEM_COUNT
:
2042 case ZFS_PROP_SNAPSHOT_COUNT
:
2043 *val
= getprop_uint64(zhp
, prop
, source
);
2045 if (*source
== NULL
) {
2046 /* not default, must be local */
2047 *source
= zhp
->zfs_name
;
2051 case ZFS_PROP_MOUNTED
:
2052 *val
= (zhp
->zfs_mntopts
!= NULL
);
2055 case ZFS_PROP_NUMCLONES
:
2056 *val
= zhp
->zfs_dmustats
.dds_num_clones
;
2059 case ZFS_PROP_VERSION
:
2060 case ZFS_PROP_NORMALIZE
:
2061 case ZFS_PROP_UTF8ONLY
:
2063 if (zcmd_alloc_dst_nvlist(zhp
->zfs_hdl
, &zc
, 0) != 0)
2065 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
2066 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_OBJSET_ZPLPROPS
, &zc
)) {
2067 zcmd_free_nvlists(&zc
);
2068 if (prop
== ZFS_PROP_VERSION
&&
2069 zhp
->zfs_type
== ZFS_TYPE_VOLUME
)
2070 *val
= zfs_prop_default_numeric(prop
);
2073 if (zcmd_read_dst_nvlist(zhp
->zfs_hdl
, &zc
, &zplprops
) != 0 ||
2074 nvlist_lookup_uint64(zplprops
, zfs_prop_to_name(prop
),
2076 zcmd_free_nvlists(&zc
);
2079 nvlist_free(zplprops
);
2080 zcmd_free_nvlists(&zc
);
2083 case ZFS_PROP_INCONSISTENT
:
2084 *val
= zhp
->zfs_dmustats
.dds_inconsistent
;
2088 switch (zfs_prop_get_type(prop
)) {
2089 case PROP_TYPE_NUMBER
:
2090 case PROP_TYPE_INDEX
:
2091 *val
= getprop_uint64(zhp
, prop
, source
);
2093 * If we tried to use a default value for a
2094 * readonly property, it means that it was not
2097 if (zfs_prop_readonly(prop
) &&
2098 *source
!= NULL
&& (*source
)[0] == '\0') {
2103 case PROP_TYPE_STRING
:
2105 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
2106 "cannot get non-numeric property"));
2107 return (zfs_error(zhp
->zfs_hdl
, EZFS_BADPROP
,
2108 dgettext(TEXT_DOMAIN
, "internal error")));
2116 * Calculate the source type, given the raw source string.
2119 get_source(zfs_handle_t
*zhp
, zprop_source_t
*srctype
, char *source
,
2120 char *statbuf
, size_t statlen
)
2122 if (statbuf
== NULL
|| *srctype
== ZPROP_SRC_TEMPORARY
)
2125 if (source
== NULL
) {
2126 *srctype
= ZPROP_SRC_NONE
;
2127 } else if (source
[0] == '\0') {
2128 *srctype
= ZPROP_SRC_DEFAULT
;
2129 } else if (strstr(source
, ZPROP_SOURCE_VAL_RECVD
) != NULL
) {
2130 *srctype
= ZPROP_SRC_RECEIVED
;
2132 if (strcmp(source
, zhp
->zfs_name
) == 0) {
2133 *srctype
= ZPROP_SRC_LOCAL
;
2135 (void) strlcpy(statbuf
, source
, statlen
);
2136 *srctype
= ZPROP_SRC_INHERITED
;
2143 zfs_prop_get_recvd(zfs_handle_t
*zhp
, const char *propname
, char *propbuf
,
2144 size_t proplen
, boolean_t literal
)
2149 if (zhp
->zfs_recvd_props
== NULL
)
2150 if (get_recvd_props_ioctl(zhp
) != 0)
2153 prop
= zfs_name_to_prop(propname
);
2155 if (prop
!= ZPROP_INVAL
) {
2157 if (!nvlist_exists(zhp
->zfs_recvd_props
, propname
))
2159 zfs_set_recvd_props_mode(zhp
, &cookie
);
2160 err
= zfs_prop_get(zhp
, prop
, propbuf
, proplen
,
2161 NULL
, NULL
, 0, literal
);
2162 zfs_unset_recvd_props_mode(zhp
, &cookie
);
2166 if (nvlist_lookup_nvlist(zhp
->zfs_recvd_props
,
2167 propname
, &propval
) != 0)
2169 verify(nvlist_lookup_string(propval
, ZPROP_VALUE
,
2171 (void) strlcpy(propbuf
, recvdval
, proplen
);
2174 return (err
== 0 ? 0 : -1);
2178 get_clones_string(zfs_handle_t
*zhp
, char *propbuf
, size_t proplen
)
2183 value
= zfs_get_clones_nvl(zhp
);
2188 for (pair
= nvlist_next_nvpair(value
, NULL
); pair
!= NULL
;
2189 pair
= nvlist_next_nvpair(value
, pair
)) {
2190 if (propbuf
[0] != '\0')
2191 (void) strlcat(propbuf
, ",", proplen
);
2192 (void) strlcat(propbuf
, nvpair_name(pair
), proplen
);
2198 struct get_clones_arg
{
2202 char buf
[ZFS_MAX_DATASET_NAME_LEN
];
2206 get_clones_cb(zfs_handle_t
*zhp
, void *arg
)
2208 struct get_clones_arg
*gca
= arg
;
2210 if (gca
->numclones
== 0) {
2215 if (zfs_prop_get(zhp
, ZFS_PROP_ORIGIN
, gca
->buf
, sizeof (gca
->buf
),
2216 NULL
, NULL
, 0, B_TRUE
) != 0)
2218 if (strcmp(gca
->buf
, gca
->origin
) == 0) {
2219 fnvlist_add_boolean(gca
->value
, zfs_get_name(zhp
));
2224 (void) zfs_iter_children(zhp
, get_clones_cb
, gca
);
2230 zfs_get_clones_nvl(zfs_handle_t
*zhp
)
2232 nvlist_t
*nv
, *value
;
2234 if (nvlist_lookup_nvlist(zhp
->zfs_props
,
2235 zfs_prop_to_name(ZFS_PROP_CLONES
), &nv
) != 0) {
2236 struct get_clones_arg gca
;
2239 * if this is a snapshot, then the kernel wasn't able
2240 * to get the clones. Do it by slowly iterating.
2242 if (zhp
->zfs_type
!= ZFS_TYPE_SNAPSHOT
)
2244 if (nvlist_alloc(&nv
, NV_UNIQUE_NAME
, 0) != 0)
2246 if (nvlist_alloc(&value
, NV_UNIQUE_NAME
, 0) != 0) {
2251 gca
.numclones
= zfs_prop_get_int(zhp
, ZFS_PROP_NUMCLONES
);
2253 gca
.origin
= zhp
->zfs_name
;
2255 if (gca
.numclones
!= 0) {
2257 char pool
[ZFS_MAX_DATASET_NAME_LEN
];
2260 /* get the pool name */
2261 (void) strlcpy(pool
, zhp
->zfs_name
, sizeof (pool
));
2262 (void) strsep(&cp
, "/@");
2263 root
= zfs_open(zhp
->zfs_hdl
, pool
,
2264 ZFS_TYPE_FILESYSTEM
);
2266 (void) get_clones_cb(root
, &gca
);
2269 if (gca
.numclones
!= 0 ||
2270 nvlist_add_nvlist(nv
, ZPROP_VALUE
, value
) != 0 ||
2271 nvlist_add_nvlist(zhp
->zfs_props
,
2272 zfs_prop_to_name(ZFS_PROP_CLONES
), nv
) != 0) {
2279 verify(0 == nvlist_lookup_nvlist(zhp
->zfs_props
,
2280 zfs_prop_to_name(ZFS_PROP_CLONES
), &nv
));
2283 verify(nvlist_lookup_nvlist(nv
, ZPROP_VALUE
, &value
) == 0);
2289 * Retrieve a property from the given object. If 'literal' is specified, then
2290 * numbers are left as exact values. Otherwise, numbers are converted to a
2291 * human-readable form.
2293 * Returns 0 on success, or -1 on error.
2296 zfs_prop_get(zfs_handle_t
*zhp
, zfs_prop_t prop
, char *propbuf
, size_t proplen
,
2297 zprop_source_t
*src
, char *statbuf
, size_t statlen
, boolean_t literal
)
2299 char *source
= NULL
;
2303 boolean_t received
= zfs_is_recvd_props_mode(zhp
);
2306 * Check to see if this property applies to our object
2308 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
))
2311 if (received
&& zfs_prop_readonly(prop
))
2315 *src
= ZPROP_SRC_NONE
;
2318 case ZFS_PROP_CREATION
:
2320 * 'creation' is a time_t stored in the statistics. We convert
2321 * this into a string unless 'literal' is specified.
2324 val
= getprop_uint64(zhp
, prop
, &source
);
2325 time_t time
= (time_t)val
;
2329 localtime_r(&time
, &t
) == NULL
||
2330 strftime(propbuf
, proplen
, "%a %b %e %k:%M %Y",
2332 (void) snprintf(propbuf
, proplen
, "%llu",
2333 (u_longlong_t
) val
);
2337 case ZFS_PROP_MOUNTPOINT
:
2339 * Getting the precise mountpoint can be tricky.
2341 * - for 'none' or 'legacy', return those values.
2342 * - for inherited mountpoints, we want to take everything
2343 * after our ancestor and append it to the inherited value.
2345 * If the pool has an alternate root, we want to prepend that
2346 * root to any values we return.
2349 str
= getprop_string(zhp
, prop
, &source
);
2351 if (str
[0] == '/') {
2352 char buf
[MAXPATHLEN
];
2354 const char *relpath
;
2357 * If we inherit the mountpoint, even from a dataset
2358 * with a received value, the source will be the path of
2359 * the dataset we inherit from. If source is
2360 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2363 if (strcmp(source
, ZPROP_SOURCE_VAL_RECVD
) == 0) {
2366 relpath
= zhp
->zfs_name
+ strlen(source
);
2367 if (relpath
[0] == '/')
2371 if ((zpool_get_prop(zhp
->zpool_hdl
,
2372 ZPOOL_PROP_ALTROOT
, buf
, MAXPATHLEN
, NULL
,
2373 B_FALSE
)) || (strcmp(root
, "-") == 0))
2376 * Special case an alternate root of '/'. This will
2377 * avoid having multiple leading slashes in the
2380 if (strcmp(root
, "/") == 0)
2384 * If the mountpoint is '/' then skip over this
2385 * if we are obtaining either an alternate root or
2386 * an inherited mountpoint.
2388 if (str
[1] == '\0' && (root
[0] != '\0' ||
2389 relpath
[0] != '\0'))
2392 if (relpath
[0] == '\0')
2393 (void) snprintf(propbuf
, proplen
, "%s%s",
2396 (void) snprintf(propbuf
, proplen
, "%s%s%s%s",
2397 root
, str
, relpath
[0] == '@' ? "" : "/",
2400 /* 'legacy' or 'none' */
2401 (void) strlcpy(propbuf
, str
, proplen
);
2406 case ZFS_PROP_ORIGIN
:
2407 str
= getprop_string(zhp
, prop
, &source
);
2410 (void) strlcpy(propbuf
, str
, proplen
);
2413 case ZFS_PROP_CLONES
:
2414 if (get_clones_string(zhp
, propbuf
, proplen
) != 0)
2418 case ZFS_PROP_QUOTA
:
2419 case ZFS_PROP_REFQUOTA
:
2420 case ZFS_PROP_RESERVATION
:
2421 case ZFS_PROP_REFRESERVATION
:
2423 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2427 * If quota or reservation is 0, we translate this into 'none'
2428 * (unless literal is set), and indicate that it's the default
2429 * value. Otherwise, we print the number nicely and indicate
2430 * that its set locally.
2434 (void) strlcpy(propbuf
, "0", proplen
);
2436 (void) strlcpy(propbuf
, "none", proplen
);
2439 (void) snprintf(propbuf
, proplen
, "%llu",
2442 zfs_nicenum(val
, propbuf
, proplen
);
2446 case ZFS_PROP_FILESYSTEM_LIMIT
:
2447 case ZFS_PROP_SNAPSHOT_LIMIT
:
2448 case ZFS_PROP_FILESYSTEM_COUNT
:
2449 case ZFS_PROP_SNAPSHOT_COUNT
:
2451 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2455 * If limit is UINT64_MAX, we translate this into 'none' (unless
2456 * literal is set), and indicate that it's the default value.
2457 * Otherwise, we print the number nicely and indicate that it's
2461 (void) snprintf(propbuf
, proplen
, "%llu",
2463 } else if (val
== UINT64_MAX
) {
2464 (void) strlcpy(propbuf
, "none", proplen
);
2466 zfs_nicenum(val
, propbuf
, proplen
);
2470 case ZFS_PROP_REFRATIO
:
2471 case ZFS_PROP_COMPRESSRATIO
:
2472 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2474 (void) snprintf(propbuf
, proplen
, "%llu.%02llux",
2475 (u_longlong_t
)(val
/ 100),
2476 (u_longlong_t
)(val
% 100));
2480 switch (zhp
->zfs_type
) {
2481 case ZFS_TYPE_FILESYSTEM
:
2484 case ZFS_TYPE_VOLUME
:
2487 case ZFS_TYPE_SNAPSHOT
:
2490 case ZFS_TYPE_BOOKMARK
:
2496 (void) snprintf(propbuf
, proplen
, "%s", str
);
2499 case ZFS_PROP_MOUNTED
:
2501 * The 'mounted' property is a pseudo-property that described
2502 * whether the filesystem is currently mounted. Even though
2503 * it's a boolean value, the typical values of "on" and "off"
2504 * don't make sense, so we translate to "yes" and "no".
2506 if (get_numeric_property(zhp
, ZFS_PROP_MOUNTED
,
2507 src
, &source
, &val
) != 0)
2510 (void) strlcpy(propbuf
, "yes", proplen
);
2512 (void) strlcpy(propbuf
, "no", proplen
);
2517 * The 'name' property is a pseudo-property derived from the
2518 * dataset name. It is presented as a real property to simplify
2521 (void) strlcpy(propbuf
, zhp
->zfs_name
, proplen
);
2524 case ZFS_PROP_MLSLABEL
:
2526 #ifdef HAVE_MLSLABEL
2527 m_label_t
*new_sl
= NULL
;
2528 char *ascii
= NULL
; /* human readable label */
2530 (void) strlcpy(propbuf
,
2531 getprop_string(zhp
, prop
, &source
), proplen
);
2533 if (literal
|| (strcasecmp(propbuf
,
2534 ZFS_MLSLABEL_DEFAULT
) == 0))
2538 * Try to translate the internal hex string to
2539 * human-readable output. If there are any
2540 * problems just use the hex string.
2543 if (str_to_label(propbuf
, &new_sl
, MAC_LABEL
,
2544 L_NO_CORRECTION
, NULL
) == -1) {
2545 m_label_free(new_sl
);
2549 if (label_to_str(new_sl
, &ascii
, M_LABEL
,
2553 m_label_free(new_sl
);
2556 m_label_free(new_sl
);
2558 (void) strlcpy(propbuf
, ascii
, proplen
);
2561 (void) strlcpy(propbuf
,
2562 getprop_string(zhp
, prop
, &source
), proplen
);
2563 #endif /* HAVE_MLSLABEL */
2569 * GUIDs are stored as numbers, but they are identifiers.
2570 * We don't want them to be pretty printed, because pretty
2571 * printing mangles the ID into a truncated and useless value.
2573 if (get_numeric_property(zhp
, prop
, src
, &source
, &val
) != 0)
2575 (void) snprintf(propbuf
, proplen
, "%llu", (u_longlong_t
)val
);
2579 switch (zfs_prop_get_type(prop
)) {
2580 case PROP_TYPE_NUMBER
:
2581 if (get_numeric_property(zhp
, prop
, src
,
2582 &source
, &val
) != 0)
2585 (void) snprintf(propbuf
, proplen
, "%llu",
2588 zfs_nicenum(val
, propbuf
, proplen
);
2591 case PROP_TYPE_STRING
:
2592 str
= getprop_string(zhp
, prop
, &source
);
2595 (void) strlcpy(propbuf
, str
, proplen
);
2598 case PROP_TYPE_INDEX
:
2599 if (get_numeric_property(zhp
, prop
, src
,
2600 &source
, &val
) != 0)
2602 if (zfs_prop_index_to_string(prop
, val
, &strval
) != 0)
2604 (void) strlcpy(propbuf
, strval
, proplen
);
2612 get_source(zhp
, src
, source
, statbuf
, statlen
);
2618 * Utility function to get the given numeric property. Does no validation that
2619 * the given property is the appropriate type; should only be used with
2620 * hard-coded property types.
2623 zfs_prop_get_int(zfs_handle_t
*zhp
, zfs_prop_t prop
)
2628 (void) get_numeric_property(zhp
, prop
, NULL
, &source
, &val
);
2634 zfs_prop_set_int(zfs_handle_t
*zhp
, zfs_prop_t prop
, uint64_t val
)
2638 (void) snprintf(buf
, sizeof (buf
), "%llu", (longlong_t
)val
);
2639 return (zfs_prop_set(zhp
, zfs_prop_to_name(prop
), buf
));
2643 * Similar to zfs_prop_get(), but returns the value as an integer.
2646 zfs_prop_get_numeric(zfs_handle_t
*zhp
, zfs_prop_t prop
, uint64_t *value
,
2647 zprop_source_t
*src
, char *statbuf
, size_t statlen
)
2652 * Check to see if this property applies to our object
2654 if (!zfs_prop_valid_for_type(prop
, zhp
->zfs_type
, B_FALSE
)) {
2655 return (zfs_error_fmt(zhp
->zfs_hdl
, EZFS_PROPTYPE
,
2656 dgettext(TEXT_DOMAIN
, "cannot get property '%s'"),
2657 zfs_prop_to_name(prop
)));
2661 *src
= ZPROP_SRC_NONE
;
2663 if (get_numeric_property(zhp
, prop
, src
, &source
, value
) != 0)
2666 get_source(zhp
, src
, source
, statbuf
, statlen
);
2673 idmap_id_to_numeric_domain_rid(uid_t id
, boolean_t isuser
,
2674 char **domainp
, idmap_rid_t
*ridp
)
2676 idmap_get_handle_t
*get_hdl
= NULL
;
2680 if (idmap_get_create(&get_hdl
) != IDMAP_SUCCESS
)
2684 err
= idmap_get_sidbyuid(get_hdl
, id
,
2685 IDMAP_REQ_FLG_USE_CACHE
, domainp
, ridp
, &status
);
2687 err
= idmap_get_sidbygid(get_hdl
, id
,
2688 IDMAP_REQ_FLG_USE_CACHE
, domainp
, ridp
, &status
);
2690 if (err
== IDMAP_SUCCESS
&&
2691 idmap_get_mappings(get_hdl
) == IDMAP_SUCCESS
&&
2692 status
== IDMAP_SUCCESS
)
2698 idmap_get_destroy(get_hdl
);
2701 #endif /* HAVE_IDMAP */
2704 * convert the propname into parameters needed by kernel
2705 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2706 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2707 * Eg: groupquota@staff -> ZFS_PROP_GROUPQUOTA, "", 1234
2708 * Eg: groupused@staff -> ZFS_PROP_GROUPUSED, "", 1234
2711 userquota_propname_decode(const char *propname
, boolean_t zoned
,
2712 zfs_userquota_prop_t
*typep
, char *domain
, int domainlen
, uint64_t *ridp
)
2714 zfs_userquota_prop_t type
;
2723 /* Figure out the property type ({user|group}{quota|space}) */
2724 for (type
= 0; type
< ZFS_NUM_USERQUOTA_PROPS
; type
++) {
2725 if (strncmp(propname
, zfs_userquota_prop_prefixes
[type
],
2726 strlen(zfs_userquota_prop_prefixes
[type
])) == 0)
2729 if (type
== ZFS_NUM_USERQUOTA_PROPS
)
2733 isuser
= (type
== ZFS_PROP_USERQUOTA
|| type
== ZFS_PROP_USERUSED
);
2734 isgroup
= (type
== ZFS_PROP_GROUPQUOTA
|| type
== ZFS_PROP_GROUPUSED
);
2736 cp
= strchr(propname
, '@') + 1;
2738 if (isuser
&& (pw
= getpwnam(cp
)) != NULL
) {
2739 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
2742 } else if (isgroup
&& (gr
= getgrnam(cp
)) != NULL
) {
2743 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
2746 } else if (strchr(cp
, '@')) {
2749 * It's a SID name (eg "user@domain") that needs to be
2750 * turned into S-1-domainID-RID.
2752 directory_error_t e
;
2753 char *numericsid
= NULL
;
2756 if (zoned
&& getzoneid() == GLOBAL_ZONEID
)
2759 e
= directory_sid_from_user_name(NULL
,
2762 e
= directory_sid_from_group_name(NULL
,
2766 directory_error_free(e
);
2769 if (numericsid
== NULL
)
2772 (void) strlcpy(domain
, cp
, domainlen
);
2773 cp
= strrchr(domain
, '-');
2778 *ridp
= strtoull(cp
, &end
, 10);
2781 if (errno
!= 0 || *end
!= '\0')
2785 #endif /* HAVE_IDMAP */
2787 /* It's a user/group ID (eg "12345"). */
2790 id
= strtoul(cp
, &end
, 10);
2795 /* It's an ephemeral ID. */
2799 if (idmap_id_to_numeric_domain_rid(id
, isuser
,
2800 &mapdomain
, &rid
) != 0)
2802 (void) strlcpy(domain
, mapdomain
, domainlen
);
2806 #endif /* HAVE_IDMAP */
2816 zfs_prop_get_userquota_common(zfs_handle_t
*zhp
, const char *propname
,
2817 uint64_t *propvalue
, zfs_userquota_prop_t
*typep
)
2820 zfs_cmd_t zc
= {"\0"};
2822 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
2824 err
= userquota_propname_decode(propname
,
2825 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
),
2826 typep
, zc
.zc_value
, sizeof (zc
.zc_value
), &zc
.zc_guid
);
2827 zc
.zc_objset_type
= *typep
;
2831 err
= ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_USERSPACE_ONE
, &zc
);
2835 *propvalue
= zc
.zc_cookie
;
2840 zfs_prop_get_userquota_int(zfs_handle_t
*zhp
, const char *propname
,
2841 uint64_t *propvalue
)
2843 zfs_userquota_prop_t type
;
2845 return (zfs_prop_get_userquota_common(zhp
, propname
, propvalue
,
2850 zfs_prop_get_userquota(zfs_handle_t
*zhp
, const char *propname
,
2851 char *propbuf
, int proplen
, boolean_t literal
)
2855 zfs_userquota_prop_t type
;
2857 err
= zfs_prop_get_userquota_common(zhp
, propname
, &propvalue
,
2864 (void) snprintf(propbuf
, proplen
, "%llu",
2865 (u_longlong_t
)propvalue
);
2866 } else if (propvalue
== 0 &&
2867 (type
== ZFS_PROP_USERQUOTA
|| type
== ZFS_PROP_GROUPQUOTA
)) {
2868 (void) strlcpy(propbuf
, "none", proplen
);
2870 zfs_nicenum(propvalue
, propbuf
, proplen
);
2876 zfs_prop_get_written_int(zfs_handle_t
*zhp
, const char *propname
,
2877 uint64_t *propvalue
)
2880 zfs_cmd_t zc
= {"\0"};
2881 const char *snapname
;
2883 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
2885 snapname
= strchr(propname
, '@') + 1;
2886 if (strchr(snapname
, '@')) {
2887 (void) strlcpy(zc
.zc_value
, snapname
, sizeof (zc
.zc_value
));
2889 /* snapname is the short name, append it to zhp's fsname */
2892 (void) strlcpy(zc
.zc_value
, zhp
->zfs_name
,
2893 sizeof (zc
.zc_value
));
2894 cp
= strchr(zc
.zc_value
, '@');
2897 (void) strlcat(zc
.zc_value
, "@", sizeof (zc
.zc_value
));
2898 (void) strlcat(zc
.zc_value
, snapname
, sizeof (zc
.zc_value
));
2901 err
= ioctl(zhp
->zfs_hdl
->libzfs_fd
, ZFS_IOC_SPACE_WRITTEN
, &zc
);
2905 *propvalue
= zc
.zc_cookie
;
2910 zfs_prop_get_written(zfs_handle_t
*zhp
, const char *propname
,
2911 char *propbuf
, int proplen
, boolean_t literal
)
2916 err
= zfs_prop_get_written_int(zhp
, propname
, &propvalue
);
2922 (void) snprintf(propbuf
, proplen
, "%llu",
2923 (u_longlong_t
)propvalue
);
2925 zfs_nicenum(propvalue
, propbuf
, proplen
);
2932 * Returns the name of the given zfs handle.
2935 zfs_get_name(const zfs_handle_t
*zhp
)
2937 return (zhp
->zfs_name
);
2941 * Returns the type of the given zfs handle.
2944 zfs_get_type(const zfs_handle_t
*zhp
)
2946 return (zhp
->zfs_type
);
2950 * Is one dataset name a child dataset of another?
2952 * Needs to handle these cases:
2953 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2954 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2955 * Descendant? No. No. No. Yes.
2958 is_descendant(const char *ds1
, const char *ds2
)
2960 size_t d1len
= strlen(ds1
);
2962 /* ds2 can't be a descendant if it's smaller */
2963 if (strlen(ds2
) < d1len
)
2966 /* otherwise, compare strings and verify that there's a '/' char */
2967 return (ds2
[d1len
] == '/' && (strncmp(ds1
, ds2
, d1len
) == 0));
2971 * Given a complete name, return just the portion that refers to the parent.
2972 * Will return -1 if there is no parent (path is just the name of the
2976 parent_name(const char *path
, char *buf
, size_t buflen
)
2980 (void) strlcpy(buf
, path
, buflen
);
2982 if ((slashp
= strrchr(buf
, '/')) == NULL
)
2990 * If accept_ancestor is false, then check to make sure that the given path has
2991 * a parent, and that it exists. If accept_ancestor is true, then find the
2992 * closest existing ancestor for the given path. In prefixlen return the
2993 * length of already existing prefix of the given path. We also fetch the
2994 * 'zoned' property, which is used to validate property settings when creating
2998 check_parents(libzfs_handle_t
*hdl
, const char *path
, uint64_t *zoned
,
2999 boolean_t accept_ancestor
, int *prefixlen
)
3001 zfs_cmd_t zc
= {"\0"};
3002 char parent
[ZFS_MAX_DATASET_NAME_LEN
];
3008 (void) snprintf(errbuf
, sizeof (errbuf
),
3009 dgettext(TEXT_DOMAIN
, "cannot create '%s'"), path
);
3011 /* get parent, and check to see if this is just a pool */
3012 if (parent_name(path
, parent
, sizeof (parent
)) != 0) {
3013 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3014 "missing dataset name"));
3015 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3018 /* check to see if the pool exists */
3019 if ((slash
= strchr(parent
, '/')) == NULL
)
3020 slash
= parent
+ strlen(parent
);
3021 (void) strncpy(zc
.zc_name
, parent
, slash
- parent
);
3022 zc
.zc_name
[slash
- parent
] = '\0';
3023 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_OBJSET_STATS
, &zc
) != 0 &&
3025 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3026 "no such pool '%s'"), zc
.zc_name
);
3027 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3030 /* check to see if the parent dataset exists */
3031 while ((zhp
= make_dataset_handle(hdl
, parent
)) == NULL
) {
3032 if (errno
== ENOENT
&& accept_ancestor
) {
3034 * Go deeper to find an ancestor, give up on top level.
3036 if (parent_name(parent
, parent
, sizeof (parent
)) != 0) {
3037 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3038 "no such pool '%s'"), zc
.zc_name
);
3039 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3041 } else if (errno
== ENOENT
) {
3042 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3043 "parent does not exist"));
3044 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3046 return (zfs_standard_error(hdl
, errno
, errbuf
));
3049 is_zoned
= zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
);
3053 /* we are in a non-global zone, but parent is in the global zone */
3054 if (getzoneid() != GLOBAL_ZONEID
&& !is_zoned
) {
3055 (void) zfs_standard_error(hdl
, EPERM
, errbuf
);
3060 /* make sure parent is a filesystem */
3061 if (zfs_get_type(zhp
) != ZFS_TYPE_FILESYSTEM
) {
3062 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3063 "parent is not a filesystem"));
3064 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
3070 if (prefixlen
!= NULL
)
3071 *prefixlen
= strlen(parent
);
3076 * Finds whether the dataset of the given type(s) exists.
3079 zfs_dataset_exists(libzfs_handle_t
*hdl
, const char *path
, zfs_type_t types
)
3083 if (!zfs_validate_name(hdl
, path
, types
, B_FALSE
))
3087 * Try to get stats for the dataset, which will tell us if it exists.
3089 if ((zhp
= make_dataset_handle(hdl
, path
)) != NULL
) {
3090 int ds_type
= zhp
->zfs_type
;
3093 if (types
& ds_type
)
3100 * Given a path to 'target', create all the ancestors between
3101 * the prefixlen portion of the path, and the target itself.
3102 * Fail if the initial prefixlen-ancestor does not already exist.
3105 create_parents(libzfs_handle_t
*hdl
, char *target
, int prefixlen
)
3111 /* make sure prefix exists */
3112 cp
= target
+ prefixlen
;
3114 assert(strchr(cp
, '/') == NULL
);
3115 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3118 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3126 * Attempt to create, mount, and share any ancestor filesystems,
3127 * up to the prefixlen-long one.
3129 for (cp
= target
+ prefixlen
+ 1;
3130 (cp
= strchr(cp
, '/')); *cp
= '/', cp
++) {
3134 h
= make_dataset_handle(hdl
, target
);
3136 /* it already exists, nothing to do here */
3141 if (zfs_create(hdl
, target
, ZFS_TYPE_FILESYSTEM
,
3143 opname
= dgettext(TEXT_DOMAIN
, "create");
3147 h
= zfs_open(hdl
, target
, ZFS_TYPE_FILESYSTEM
);
3149 opname
= dgettext(TEXT_DOMAIN
, "open");
3153 if (zfs_mount(h
, NULL
, 0) != 0) {
3154 opname
= dgettext(TEXT_DOMAIN
, "mount");
3158 if (zfs_share(h
) != 0) {
3159 opname
= dgettext(TEXT_DOMAIN
, "share");
3169 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3170 "failed to %s ancestor '%s'"), opname
, target
);
3175 * Creates non-existing ancestors of the given path.
3178 zfs_create_ancestors(libzfs_handle_t
*hdl
, const char *path
)
3184 if (check_parents(hdl
, path
, NULL
, B_TRUE
, &prefix
) != 0)
3187 if ((path_copy
= strdup(path
)) != NULL
) {
3188 rc
= create_parents(hdl
, path_copy
, prefix
);
3191 if (path_copy
== NULL
|| rc
!= 0)
3198 * Create a new filesystem or volume.
3201 zfs_create(libzfs_handle_t
*hdl
, const char *path
, zfs_type_t type
,
3206 uint64_t blocksize
= zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE
);
3209 dmu_objset_type_t ost
;
3211 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3212 "cannot create '%s'"), path
);
3214 /* validate the path, taking care to note the extended error message */
3215 if (!zfs_validate_name(hdl
, path
, type
, B_TRUE
))
3216 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3218 /* validate parents exist */
3219 if (check_parents(hdl
, path
, &zoned
, B_FALSE
, NULL
) != 0)
3223 * The failure modes when creating a dataset of a different type over
3224 * one that already exists is a little strange. In particular, if you
3225 * try to create a dataset on top of an existing dataset, the ioctl()
3226 * will return ENOENT, not EEXIST. To prevent this from happening, we
3227 * first try to see if the dataset exists.
3229 if (zfs_dataset_exists(hdl
, path
, ZFS_TYPE_DATASET
)) {
3230 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3231 "dataset already exists"));
3232 return (zfs_error(hdl
, EZFS_EXISTS
, errbuf
));
3235 if (type
== ZFS_TYPE_VOLUME
)
3240 /* open zpool handle for prop validation */
3241 char pool_path
[ZFS_MAX_DATASET_NAME_LEN
];
3242 (void) strlcpy(pool_path
, path
, sizeof (pool_path
));
3244 /* truncate pool_path at first slash */
3245 char *p
= strchr(pool_path
, '/');
3249 zpool_handle_t
*zpool_handle
= zpool_open(hdl
, pool_path
);
3251 if (props
&& (props
= zfs_valid_proplist(hdl
, type
, props
,
3252 zoned
, NULL
, zpool_handle
, errbuf
)) == 0) {
3253 zpool_close(zpool_handle
);
3256 zpool_close(zpool_handle
);
3258 if (type
== ZFS_TYPE_VOLUME
) {
3260 * If we are creating a volume, the size and block size must
3261 * satisfy a few restraints. First, the blocksize must be a
3262 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3263 * volsize must be a multiple of the block size, and cannot be
3266 if (props
== NULL
|| nvlist_lookup_uint64(props
,
3267 zfs_prop_to_name(ZFS_PROP_VOLSIZE
), &size
) != 0) {
3269 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3270 "missing volume size"));
3271 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3274 if ((ret
= nvlist_lookup_uint64(props
,
3275 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
3276 &blocksize
)) != 0) {
3277 if (ret
== ENOENT
) {
3278 blocksize
= zfs_prop_default_numeric(
3279 ZFS_PROP_VOLBLOCKSIZE
);
3282 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3283 "missing volume block size"));
3284 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3290 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3291 "volume size cannot be zero"));
3292 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3295 if (size
% blocksize
!= 0) {
3297 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3298 "volume size must be a multiple of volume block "
3300 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
3304 /* create the dataset */
3305 ret
= lzc_create(path
, ost
, props
);
3308 /* check for failure */
3310 char parent
[ZFS_MAX_DATASET_NAME_LEN
];
3311 (void) parent_name(path
, parent
, sizeof (parent
));
3315 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3316 "no such parent '%s'"), parent
);
3317 return (zfs_error(hdl
, EZFS_NOENT
, errbuf
));
3320 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3321 "parent '%s' is not a filesystem"), parent
);
3322 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3325 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3326 "pool must be upgraded to set this "
3327 "property or value"));
3328 return (zfs_error(hdl
, EZFS_BADVERSION
, errbuf
));
3332 * This platform can't address a volume this big.
3334 if (type
== ZFS_TYPE_VOLUME
)
3335 return (zfs_error(hdl
, EZFS_VOLTOOBIG
,
3340 return (zfs_standard_error(hdl
, errno
, errbuf
));
3348 * Destroys the given dataset. The caller must make sure that the filesystem
3349 * isn't mounted, and that there are no active dependents. If the file system
3350 * does not exist this function does nothing.
3353 zfs_destroy(zfs_handle_t
*zhp
, boolean_t defer
)
3355 zfs_cmd_t zc
= {"\0"};
3357 if (zhp
->zfs_type
== ZFS_TYPE_BOOKMARK
) {
3358 nvlist_t
*nv
= fnvlist_alloc();
3359 fnvlist_add_boolean(nv
, zhp
->zfs_name
);
3360 int error
= lzc_destroy_bookmarks(nv
, NULL
);
3363 return (zfs_standard_error_fmt(zhp
->zfs_hdl
, errno
,
3364 dgettext(TEXT_DOMAIN
, "cannot destroy '%s'"),
3370 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
3372 if (ZFS_IS_VOLUME(zhp
)) {
3373 zc
.zc_objset_type
= DMU_OST_ZVOL
;
3375 zc
.zc_objset_type
= DMU_OST_ZFS
;
3378 zc
.zc_defer_destroy
= defer
;
3379 if (zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_DESTROY
, &zc
) != 0 &&
3381 return (zfs_standard_error_fmt(zhp
->zfs_hdl
, errno
,
3382 dgettext(TEXT_DOMAIN
, "cannot destroy '%s'"),
3386 remove_mountpoint(zhp
);
3391 struct destroydata
{
3393 const char *snapname
;
3397 zfs_check_snap_cb(zfs_handle_t
*zhp
, void *arg
)
3399 struct destroydata
*dd
= arg
;
3400 char name
[ZFS_MAX_DATASET_NAME_LEN
];
3403 (void) snprintf(name
, sizeof (name
),
3404 "%s@%s", zhp
->zfs_name
, dd
->snapname
);
3406 if (lzc_exists(name
))
3407 verify(nvlist_add_boolean(dd
->nvl
, name
) == 0);
3409 rv
= zfs_iter_filesystems(zhp
, zfs_check_snap_cb
, dd
);
3415 * Destroys all snapshots with the given name in zhp & descendants.
3418 zfs_destroy_snaps(zfs_handle_t
*zhp
, char *snapname
, boolean_t defer
)
3421 struct destroydata dd
= { 0 };
3423 dd
.snapname
= snapname
;
3424 verify(nvlist_alloc(&dd
.nvl
, NV_UNIQUE_NAME
, 0) == 0);
3425 (void) zfs_check_snap_cb(zfs_handle_dup(zhp
), &dd
);
3427 if (nvlist_empty(dd
.nvl
)) {
3428 ret
= zfs_standard_error_fmt(zhp
->zfs_hdl
, ENOENT
,
3429 dgettext(TEXT_DOMAIN
, "cannot destroy '%s@%s'"),
3430 zhp
->zfs_name
, snapname
);
3432 ret
= zfs_destroy_snaps_nvl(zhp
->zfs_hdl
, dd
.nvl
, defer
);
3434 nvlist_free(dd
.nvl
);
3439 * Destroys all the snapshots named in the nvlist.
3442 zfs_destroy_snaps_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
, boolean_t defer
)
3445 nvlist_t
*errlist
= NULL
;
3448 ret
= lzc_destroy_snaps(snaps
, defer
, &errlist
);
3451 nvlist_free(errlist
);
3455 if (nvlist_empty(errlist
)) {
3457 (void) snprintf(errbuf
, sizeof (errbuf
),
3458 dgettext(TEXT_DOMAIN
, "cannot destroy snapshots"));
3460 ret
= zfs_standard_error(hdl
, ret
, errbuf
);
3462 for (pair
= nvlist_next_nvpair(errlist
, NULL
);
3463 pair
!= NULL
; pair
= nvlist_next_nvpair(errlist
, pair
)) {
3465 (void) snprintf(errbuf
, sizeof (errbuf
),
3466 dgettext(TEXT_DOMAIN
, "cannot destroy snapshot %s"),
3469 switch (fnvpair_value_int32(pair
)) {
3472 dgettext(TEXT_DOMAIN
, "snapshot is cloned"));
3473 ret
= zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3476 ret
= zfs_standard_error(hdl
, errno
, errbuf
);
3481 nvlist_free(errlist
);
3486 * Clones the given dataset. The target must be of the same type as the source.
3489 zfs_clone(zfs_handle_t
*zhp
, const char *target
, nvlist_t
*props
)
3491 char parent
[ZFS_MAX_DATASET_NAME_LEN
];
3494 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3497 assert(zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
);
3499 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3500 "cannot create '%s'"), target
);
3502 /* validate the target/clone name */
3503 if (!zfs_validate_name(hdl
, target
, ZFS_TYPE_FILESYSTEM
, B_TRUE
))
3504 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3506 /* validate parents exist */
3507 if (check_parents(hdl
, target
, &zoned
, B_FALSE
, NULL
) != 0)
3510 (void) parent_name(target
, parent
, sizeof (parent
));
3516 if (ZFS_IS_VOLUME(zhp
)) {
3517 type
= ZFS_TYPE_VOLUME
;
3519 type
= ZFS_TYPE_FILESYSTEM
;
3521 if ((props
= zfs_valid_proplist(hdl
, type
, props
, zoned
,
3522 zhp
, zhp
->zpool_hdl
, errbuf
)) == NULL
)
3526 ret
= lzc_clone(target
, zhp
->zfs_name
, props
);
3534 * The parent doesn't exist. We should have caught this
3535 * above, but there may a race condition that has since
3536 * destroyed the parent.
3538 * At this point, we don't know whether it's the source
3539 * that doesn't exist anymore, or whether the target
3540 * dataset doesn't exist.
3542 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
3543 "no such parent '%s'"), parent
);
3544 return (zfs_error(zhp
->zfs_hdl
, EZFS_NOENT
, errbuf
));
3547 zfs_error_aux(zhp
->zfs_hdl
, dgettext(TEXT_DOMAIN
,
3548 "source and target pools differ"));
3549 return (zfs_error(zhp
->zfs_hdl
, EZFS_CROSSTARGET
,
3553 return (zfs_standard_error(zhp
->zfs_hdl
, errno
,
3562 * Promotes the given clone fs to be the clone parent.
3565 zfs_promote(zfs_handle_t
*zhp
)
3567 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3568 zfs_cmd_t zc
= {"\0"};
3569 char parent
[MAXPATHLEN
];
3573 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3574 "cannot promote '%s'"), zhp
->zfs_name
);
3576 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
) {
3577 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3578 "snapshots can not be promoted"));
3579 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3582 (void) strlcpy(parent
, zhp
->zfs_dmustats
.dds_origin
, sizeof (parent
));
3583 if (parent
[0] == '\0') {
3584 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3585 "not a cloned filesystem"));
3586 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3589 (void) strlcpy(zc
.zc_value
, zhp
->zfs_dmustats
.dds_origin
,
3590 sizeof (zc
.zc_value
));
3591 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
3592 ret
= zfs_ioctl(hdl
, ZFS_IOC_PROMOTE
, &zc
);
3595 int save_errno
= errno
;
3597 switch (save_errno
) {
3599 /* There is a conflicting snapshot name. */
3600 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3601 "conflicting snapshot '%s' from parent '%s'"),
3602 zc
.zc_string
, parent
);
3603 return (zfs_error(hdl
, EZFS_EXISTS
, errbuf
));
3606 return (zfs_standard_error(hdl
, save_errno
, errbuf
));
3612 typedef struct snapdata
{
3614 const char *sd_snapname
;
3618 zfs_snapshot_cb(zfs_handle_t
*zhp
, void *arg
)
3620 snapdata_t
*sd
= arg
;
3621 char name
[ZFS_MAX_DATASET_NAME_LEN
];
3624 if (zfs_prop_get_int(zhp
, ZFS_PROP_INCONSISTENT
) == 0) {
3625 (void) snprintf(name
, sizeof (name
),
3626 "%s@%s", zfs_get_name(zhp
), sd
->sd_snapname
);
3628 fnvlist_add_boolean(sd
->sd_nvl
, name
);
3630 rv
= zfs_iter_filesystems(zhp
, zfs_snapshot_cb
, sd
);
3638 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3642 zfs_snapshot_nvl(libzfs_handle_t
*hdl
, nvlist_t
*snaps
, nvlist_t
*props
)
3649 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3650 "cannot create snapshots "));
3653 while ((elem
= nvlist_next_nvpair(snaps
, elem
)) != NULL
) {
3654 const char *snapname
= nvpair_name(elem
);
3656 /* validate the target name */
3657 if (!zfs_validate_name(hdl
, snapname
, ZFS_TYPE_SNAPSHOT
,
3659 (void) snprintf(errbuf
, sizeof (errbuf
),
3660 dgettext(TEXT_DOMAIN
,
3661 "cannot create snapshot '%s'"), snapname
);
3662 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3667 * get pool handle for prop validation. assumes all snaps are in the
3668 * same pool, as does lzc_snapshot (below).
3670 char pool
[ZFS_MAX_DATASET_NAME_LEN
];
3671 elem
= nvlist_next_nvpair(snaps
, NULL
);
3672 (void) strlcpy(pool
, nvpair_name(elem
), sizeof (pool
));
3673 pool
[strcspn(pool
, "/@")] = '\0';
3674 zpool_handle_t
*zpool_hdl
= zpool_open(hdl
, pool
);
3676 if (props
!= NULL
&&
3677 (props
= zfs_valid_proplist(hdl
, ZFS_TYPE_SNAPSHOT
,
3678 props
, B_FALSE
, NULL
, zpool_hdl
, errbuf
)) == NULL
) {
3679 zpool_close(zpool_hdl
);
3682 zpool_close(zpool_hdl
);
3684 ret
= lzc_snapshot(snaps
, props
, &errors
);
3687 boolean_t printed
= B_FALSE
;
3688 for (elem
= nvlist_next_nvpair(errors
, NULL
);
3690 elem
= nvlist_next_nvpair(errors
, elem
)) {
3691 (void) snprintf(errbuf
, sizeof (errbuf
),
3692 dgettext(TEXT_DOMAIN
,
3693 "cannot create snapshot '%s'"), nvpair_name(elem
));
3694 (void) zfs_standard_error(hdl
,
3695 fnvpair_value_int32(elem
), errbuf
);
3701 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3702 "multiple snapshots of same "
3704 (void) zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
3708 (void) zfs_standard_error(hdl
, ret
, errbuf
);
3714 nvlist_free(errors
);
3719 zfs_snapshot(libzfs_handle_t
*hdl
, const char *path
, boolean_t recursive
,
3723 snapdata_t sd
= { 0 };
3724 char fsname
[ZFS_MAX_DATASET_NAME_LEN
];
3729 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3730 "cannot snapshot %s"), path
);
3732 if (!zfs_validate_name(hdl
, path
, ZFS_TYPE_SNAPSHOT
, B_TRUE
))
3733 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3735 (void) strlcpy(fsname
, path
, sizeof (fsname
));
3736 cp
= strchr(fsname
, '@');
3738 sd
.sd_snapname
= cp
+ 1;
3740 if ((zhp
= zfs_open(hdl
, fsname
, ZFS_TYPE_FILESYSTEM
|
3741 ZFS_TYPE_VOLUME
)) == NULL
) {
3745 verify(nvlist_alloc(&sd
.sd_nvl
, NV_UNIQUE_NAME
, 0) == 0);
3747 (void) zfs_snapshot_cb(zfs_handle_dup(zhp
), &sd
);
3749 fnvlist_add_boolean(sd
.sd_nvl
, path
);
3752 ret
= zfs_snapshot_nvl(hdl
, sd
.sd_nvl
, props
);
3753 nvlist_free(sd
.sd_nvl
);
3759 * Destroy any more recent snapshots. We invoke this callback on any dependents
3760 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3761 * is a dependent and we should just destroy it without checking the transaction
3764 typedef struct rollback_data
{
3765 const char *cb_target
; /* the snapshot */
3766 uint64_t cb_create
; /* creation time reference */
3772 rollback_destroy_dependent(zfs_handle_t
*zhp
, void *data
)
3774 rollback_data_t
*cbp
= data
;
3775 prop_changelist_t
*clp
;
3777 /* We must destroy this clone; first unmount it */
3778 clp
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
3779 cbp
->cb_force
? MS_FORCE
: 0);
3780 if (clp
== NULL
|| changelist_prefix(clp
) != 0) {
3781 cbp
->cb_error
= B_TRUE
;
3785 if (zfs_destroy(zhp
, B_FALSE
) != 0)
3786 cbp
->cb_error
= B_TRUE
;
3788 changelist_remove(clp
, zhp
->zfs_name
);
3789 (void) changelist_postfix(clp
);
3790 changelist_free(clp
);
3797 rollback_destroy(zfs_handle_t
*zhp
, void *data
)
3799 rollback_data_t
*cbp
= data
;
3801 if (zfs_prop_get_int(zhp
, ZFS_PROP_CREATETXG
) > cbp
->cb_create
) {
3802 cbp
->cb_error
|= zfs_iter_dependents(zhp
, B_FALSE
,
3803 rollback_destroy_dependent
, cbp
);
3805 cbp
->cb_error
|= zfs_destroy(zhp
, B_FALSE
);
3813 * Given a dataset, rollback to a specific snapshot, discarding any
3814 * data changes since then and making it the active dataset.
3816 * Any snapshots and bookmarks more recent than the target are
3817 * destroyed, along with their dependents (i.e. clones).
3820 zfs_rollback(zfs_handle_t
*zhp
, zfs_handle_t
*snap
, boolean_t force
)
3822 rollback_data_t cb
= { 0 };
3824 boolean_t restore_resv
= 0;
3825 uint64_t old_volsize
= 0, new_volsize
;
3826 zfs_prop_t resv_prop
= { 0 };
3828 assert(zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
||
3829 zhp
->zfs_type
== ZFS_TYPE_VOLUME
);
3832 * Destroy all recent snapshots and their dependents.
3834 cb
.cb_force
= force
;
3835 cb
.cb_target
= snap
->zfs_name
;
3836 cb
.cb_create
= zfs_prop_get_int(snap
, ZFS_PROP_CREATETXG
);
3837 (void) zfs_iter_snapshots(zhp
, B_FALSE
, rollback_destroy
, &cb
);
3838 (void) zfs_iter_bookmarks(zhp
, rollback_destroy
, &cb
);
3844 * Now that we have verified that the snapshot is the latest,
3845 * rollback to the given snapshot.
3848 if (zhp
->zfs_type
== ZFS_TYPE_VOLUME
) {
3849 if (zfs_which_resv_prop(zhp
, &resv_prop
) < 0)
3851 old_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
3853 (old_volsize
== zfs_prop_get_int(zhp
, resv_prop
));
3857 * We rely on zfs_iter_children() to verify that there are no
3858 * newer snapshots for the given dataset. Therefore, we can
3859 * simply pass the name on to the ioctl() call. There is still
3860 * an unlikely race condition where the user has taken a
3861 * snapshot since we verified that this was the most recent.
3863 err
= lzc_rollback(zhp
->zfs_name
, NULL
, 0);
3865 (void) zfs_standard_error_fmt(zhp
->zfs_hdl
, errno
,
3866 dgettext(TEXT_DOMAIN
, "cannot rollback '%s'"),
3872 * For volumes, if the pre-rollback volsize matched the pre-
3873 * rollback reservation and the volsize has changed then set
3874 * the reservation property to the post-rollback volsize.
3875 * Make a new handle since the rollback closed the dataset.
3877 if ((zhp
->zfs_type
== ZFS_TYPE_VOLUME
) &&
3878 (zhp
= make_dataset_handle(zhp
->zfs_hdl
, zhp
->zfs_name
))) {
3880 new_volsize
= zfs_prop_get_int(zhp
, ZFS_PROP_VOLSIZE
);
3881 if (old_volsize
!= new_volsize
)
3882 err
= zfs_prop_set_int(zhp
, resv_prop
,
3891 * Renames the given dataset.
3894 zfs_rename(zfs_handle_t
*zhp
, const char *target
, boolean_t recursive
,
3895 boolean_t force_unmount
)
3898 zfs_cmd_t zc
= {"\0"};
3900 prop_changelist_t
*cl
= NULL
;
3901 zfs_handle_t
*zhrp
= NULL
;
3902 char *parentname
= NULL
;
3903 char parent
[ZFS_MAX_DATASET_NAME_LEN
];
3904 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
3907 /* if we have the same exact name, just return success */
3908 if (strcmp(zhp
->zfs_name
, target
) == 0)
3911 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3912 "cannot rename to '%s'"), target
);
3915 * Make sure the target name is valid
3917 if (zhp
->zfs_type
== ZFS_TYPE_SNAPSHOT
) {
3918 if ((strchr(target
, '@') == NULL
) ||
3921 * Snapshot target name is abbreviated,
3922 * reconstruct full dataset name
3924 (void) strlcpy(parent
, zhp
->zfs_name
,
3926 delim
= strchr(parent
, '@');
3927 if (strchr(target
, '@') == NULL
)
3931 (void) strlcat(parent
, target
, sizeof (parent
));
3935 * Make sure we're renaming within the same dataset.
3937 delim
= strchr(target
, '@');
3938 if (strncmp(zhp
->zfs_name
, target
, delim
- target
)
3939 != 0 || zhp
->zfs_name
[delim
- target
] != '@') {
3940 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3941 "snapshots must be part of same "
3943 return (zfs_error(hdl
, EZFS_CROSSTARGET
,
3947 if (!zfs_validate_name(hdl
, target
, zhp
->zfs_type
, B_TRUE
))
3948 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3951 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3952 "recursive rename must be a snapshot"));
3953 return (zfs_error(hdl
, EZFS_BADTYPE
, errbuf
));
3956 if (!zfs_validate_name(hdl
, target
, zhp
->zfs_type
, B_TRUE
))
3957 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3959 /* validate parents */
3960 if (check_parents(hdl
, target
, NULL
, B_FALSE
, NULL
) != 0)
3963 /* make sure we're in the same pool */
3964 verify((delim
= strchr(target
, '/')) != NULL
);
3965 if (strncmp(zhp
->zfs_name
, target
, delim
- target
) != 0 ||
3966 zhp
->zfs_name
[delim
- target
] != '/') {
3967 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3968 "datasets must be within same pool"));
3969 return (zfs_error(hdl
, EZFS_CROSSTARGET
, errbuf
));
3972 /* new name cannot be a child of the current dataset name */
3973 if (is_descendant(zhp
->zfs_name
, target
)) {
3974 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3975 "New dataset name cannot be a descendant of "
3976 "current dataset name"));
3977 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3981 (void) snprintf(errbuf
, sizeof (errbuf
),
3982 dgettext(TEXT_DOMAIN
, "cannot rename '%s'"), zhp
->zfs_name
);
3984 if (getzoneid() == GLOBAL_ZONEID
&&
3985 zfs_prop_get_int(zhp
, ZFS_PROP_ZONED
)) {
3986 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3987 "dataset is used in a non-global zone"));
3988 return (zfs_error(hdl
, EZFS_ZONED
, errbuf
));
3992 parentname
= zfs_strdup(zhp
->zfs_hdl
, zhp
->zfs_name
);
3993 if (parentname
== NULL
) {
3997 delim
= strchr(parentname
, '@');
3999 zhrp
= zfs_open(zhp
->zfs_hdl
, parentname
, ZFS_TYPE_DATASET
);
4004 } else if (zhp
->zfs_type
!= ZFS_TYPE_SNAPSHOT
) {
4005 if ((cl
= changelist_gather(zhp
, ZFS_PROP_NAME
, 0,
4006 force_unmount
? MS_FORCE
: 0)) == NULL
)
4009 if (changelist_haszonedchild(cl
)) {
4010 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4011 "child dataset with inherited mountpoint is used "
4012 "in a non-global zone"));
4013 (void) zfs_error(hdl
, EZFS_ZONED
, errbuf
);
4018 if ((ret
= changelist_prefix(cl
)) != 0)
4022 if (ZFS_IS_VOLUME(zhp
))
4023 zc
.zc_objset_type
= DMU_OST_ZVOL
;
4025 zc
.zc_objset_type
= DMU_OST_ZFS
;
4027 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
4028 (void) strlcpy(zc
.zc_value
, target
, sizeof (zc
.zc_value
));
4030 zc
.zc_cookie
= recursive
;
4032 if ((ret
= zfs_ioctl(zhp
->zfs_hdl
, ZFS_IOC_RENAME
, &zc
)) != 0) {
4034 * if it was recursive, the one that actually failed will
4037 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4038 "cannot rename '%s'"), zc
.zc_name
);
4040 if (recursive
&& errno
== EEXIST
) {
4041 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4042 "a child dataset already has a snapshot "
4043 "with the new name"));
4044 (void) zfs_error(hdl
, EZFS_EXISTS
, errbuf
);
4046 (void) zfs_standard_error(zhp
->zfs_hdl
, errno
, errbuf
);
4050 * On failure, we still want to remount any filesystems that
4051 * were previously mounted, so we don't alter the system state.
4054 (void) changelist_postfix(cl
);
4057 changelist_rename(cl
, zfs_get_name(zhp
), target
);
4058 ret
= changelist_postfix(cl
);
4063 if (parentname
!= NULL
) {
4070 changelist_free(cl
);
4076 zfs_get_user_props(zfs_handle_t
*zhp
)
4078 return (zhp
->zfs_user_props
);
4082 * This function is used by 'zfs list' to determine the exact set of columns to
4083 * display, and their maximum widths. This does two main things:
4085 * - If this is a list of all properties, then expand the list to include
4086 * all native properties, and set a flag so that for each dataset we look
4087 * for new unique user properties and add them to the list.
4089 * - For non fixed-width properties, keep track of the maximum width seen
4090 * so that we can size the column appropriately. If the user has
4091 * requested received property values, we also need to compute the width
4092 * of the RECEIVED column.
4095 zfs_expand_proplist(zfs_handle_t
*zhp
, zprop_list_t
**plp
, boolean_t received
,
4098 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4099 zprop_list_t
*entry
;
4100 zprop_list_t
**last
, **start
;
4101 nvlist_t
*userprops
, *propval
;
4104 char buf
[ZFS_MAXPROPLEN
];
4106 if (zprop_expand_list(hdl
, plp
, ZFS_TYPE_DATASET
) != 0)
4109 userprops
= zfs_get_user_props(zhp
);
4112 if (entry
->pl_all
&& nvlist_next_nvpair(userprops
, NULL
) != NULL
) {
4114 * Go through and add any user properties as necessary. We
4115 * start by incrementing our list pointer to the first
4116 * non-native property.
4119 while (*start
!= NULL
) {
4120 if ((*start
)->pl_prop
== ZPROP_INVAL
)
4122 start
= &(*start
)->pl_next
;
4126 while ((elem
= nvlist_next_nvpair(userprops
, elem
)) != NULL
) {
4128 * See if we've already found this property in our list.
4130 for (last
= start
; *last
!= NULL
;
4131 last
= &(*last
)->pl_next
) {
4132 if (strcmp((*last
)->pl_user_prop
,
4133 nvpair_name(elem
)) == 0)
4137 if (*last
== NULL
) {
4138 if ((entry
= zfs_alloc(hdl
,
4139 sizeof (zprop_list_t
))) == NULL
||
4140 ((entry
->pl_user_prop
= zfs_strdup(hdl
,
4141 nvpair_name(elem
)))) == NULL
) {
4146 entry
->pl_prop
= ZPROP_INVAL
;
4147 entry
->pl_width
= strlen(nvpair_name(elem
));
4148 entry
->pl_all
= B_TRUE
;
4155 * Now go through and check the width of any non-fixed columns
4157 for (entry
= *plp
; entry
!= NULL
; entry
= entry
->pl_next
) {
4158 if (entry
->pl_fixed
&& !literal
)
4161 if (entry
->pl_prop
!= ZPROP_INVAL
) {
4162 if (zfs_prop_get(zhp
, entry
->pl_prop
,
4163 buf
, sizeof (buf
), NULL
, NULL
, 0, literal
) == 0) {
4164 if (strlen(buf
) > entry
->pl_width
)
4165 entry
->pl_width
= strlen(buf
);
4167 if (received
&& zfs_prop_get_recvd(zhp
,
4168 zfs_prop_to_name(entry
->pl_prop
),
4169 buf
, sizeof (buf
), literal
) == 0)
4170 if (strlen(buf
) > entry
->pl_recvd_width
)
4171 entry
->pl_recvd_width
= strlen(buf
);
4173 if (nvlist_lookup_nvlist(userprops
, entry
->pl_user_prop
,
4175 verify(nvlist_lookup_string(propval
,
4176 ZPROP_VALUE
, &strval
) == 0);
4177 if (strlen(strval
) > entry
->pl_width
)
4178 entry
->pl_width
= strlen(strval
);
4180 if (received
&& zfs_prop_get_recvd(zhp
,
4181 entry
->pl_user_prop
,
4182 buf
, sizeof (buf
), literal
) == 0)
4183 if (strlen(buf
) > entry
->pl_recvd_width
)
4184 entry
->pl_recvd_width
= strlen(buf
);
4192 zfs_prune_proplist(zfs_handle_t
*zhp
, uint8_t *props
)
4198 * Keep a reference to the props-table against which we prune the
4201 zhp
->zfs_props_table
= props
;
4203 curr
= nvlist_next_nvpair(zhp
->zfs_props
, NULL
);
4206 zfs_prop_t zfs_prop
= zfs_name_to_prop(nvpair_name(curr
));
4207 next
= nvlist_next_nvpair(zhp
->zfs_props
, curr
);
4210 * User properties will result in ZPROP_INVAL, and since we
4211 * only know how to prune standard ZFS properties, we always
4212 * leave these in the list. This can also happen if we
4213 * encounter an unknown DSL property (when running older
4214 * software, for example).
4216 if (zfs_prop
!= ZPROP_INVAL
&& props
[zfs_prop
] == B_FALSE
)
4217 (void) nvlist_remove(zhp
->zfs_props
,
4218 nvpair_name(curr
), nvpair_type(curr
));
4224 zfs_smb_acl_mgmt(libzfs_handle_t
*hdl
, char *dataset
, char *path
,
4225 zfs_smb_acl_op_t cmd
, char *resource1
, char *resource2
)
4227 zfs_cmd_t zc
= {"\0"};
4228 nvlist_t
*nvlist
= NULL
;
4231 (void) strlcpy(zc
.zc_name
, dataset
, sizeof (zc
.zc_name
));
4232 (void) strlcpy(zc
.zc_value
, path
, sizeof (zc
.zc_value
));
4233 zc
.zc_cookie
= (uint64_t)cmd
;
4235 if (cmd
== ZFS_SMB_ACL_RENAME
) {
4236 if (nvlist_alloc(&nvlist
, NV_UNIQUE_NAME
, 0) != 0) {
4237 (void) no_memory(hdl
);
4243 case ZFS_SMB_ACL_ADD
:
4244 case ZFS_SMB_ACL_REMOVE
:
4245 (void) strlcpy(zc
.zc_string
, resource1
, sizeof (zc
.zc_string
));
4247 case ZFS_SMB_ACL_RENAME
:
4248 if (nvlist_add_string(nvlist
, ZFS_SMB_ACL_SRC
,
4250 (void) no_memory(hdl
);
4253 if (nvlist_add_string(nvlist
, ZFS_SMB_ACL_TARGET
,
4255 (void) no_memory(hdl
);
4258 if (zcmd_write_src_nvlist(hdl
, &zc
, nvlist
) != 0) {
4259 nvlist_free(nvlist
);
4263 case ZFS_SMB_ACL_PURGE
:
4268 error
= ioctl(hdl
->libzfs_fd
, ZFS_IOC_SMB_ACL
, &zc
);
4269 nvlist_free(nvlist
);
4274 zfs_smb_acl_add(libzfs_handle_t
*hdl
, char *dataset
,
4275 char *path
, char *resource
)
4277 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_ADD
,
4282 zfs_smb_acl_remove(libzfs_handle_t
*hdl
, char *dataset
,
4283 char *path
, char *resource
)
4285 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_REMOVE
,
4290 zfs_smb_acl_purge(libzfs_handle_t
*hdl
, char *dataset
, char *path
)
4292 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_PURGE
,
4297 zfs_smb_acl_rename(libzfs_handle_t
*hdl
, char *dataset
, char *path
,
4298 char *oldname
, char *newname
)
4300 return (zfs_smb_acl_mgmt(hdl
, dataset
, path
, ZFS_SMB_ACL_RENAME
,
4305 zfs_userspace(zfs_handle_t
*zhp
, zfs_userquota_prop_t type
,
4306 zfs_userspace_cb_t func
, void *arg
)
4308 zfs_cmd_t zc
= {"\0"};
4309 zfs_useracct_t buf
[100];
4310 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4313 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
4315 zc
.zc_objset_type
= type
;
4316 zc
.zc_nvlist_dst
= (uintptr_t)buf
;
4319 zfs_useracct_t
*zua
= buf
;
4321 zc
.zc_nvlist_dst_size
= sizeof (buf
);
4322 if (zfs_ioctl(hdl
, ZFS_IOC_USERSPACE_MANY
, &zc
) != 0) {
4325 (void) snprintf(errbuf
, sizeof (errbuf
),
4326 dgettext(TEXT_DOMAIN
,
4327 "cannot get used/quota for %s"), zc
.zc_name
);
4328 return (zfs_standard_error_fmt(hdl
, errno
, errbuf
));
4330 if (zc
.zc_nvlist_dst_size
== 0)
4333 while (zc
.zc_nvlist_dst_size
> 0) {
4334 if ((ret
= func(arg
, zua
->zu_domain
, zua
->zu_rid
,
4335 zua
->zu_space
)) != 0)
4338 zc
.zc_nvlist_dst_size
-= sizeof (zfs_useracct_t
);
4347 const char *snapname
;
4349 boolean_t recursive
;
4354 zfs_hold_one(zfs_handle_t
*zhp
, void *arg
)
4356 struct holdarg
*ha
= arg
;
4357 char name
[ZFS_MAX_DATASET_NAME_LEN
];
4360 (void) snprintf(name
, sizeof (name
),
4361 "%s@%s", zhp
->zfs_name
, ha
->snapname
);
4363 if (lzc_exists(name
))
4364 fnvlist_add_string(ha
->nvl
, name
, ha
->tag
);
4367 rv
= zfs_iter_filesystems(zhp
, zfs_hold_one
, ha
);
4373 zfs_hold(zfs_handle_t
*zhp
, const char *snapname
, const char *tag
,
4374 boolean_t recursive
, int cleanup_fd
)
4379 ha
.nvl
= fnvlist_alloc();
4380 ha
.snapname
= snapname
;
4382 ha
.recursive
= recursive
;
4383 (void) zfs_hold_one(zfs_handle_dup(zhp
), &ha
);
4385 if (nvlist_empty(ha
.nvl
)) {
4388 fnvlist_free(ha
.nvl
);
4390 (void) snprintf(errbuf
, sizeof (errbuf
),
4391 dgettext(TEXT_DOMAIN
,
4392 "cannot hold snapshot '%s@%s'"),
4393 zhp
->zfs_name
, snapname
);
4394 (void) zfs_standard_error(zhp
->zfs_hdl
, ret
, errbuf
);
4398 ret
= zfs_hold_nvl(zhp
, cleanup_fd
, ha
.nvl
);
4399 fnvlist_free(ha
.nvl
);
4405 zfs_hold_nvl(zfs_handle_t
*zhp
, int cleanup_fd
, nvlist_t
*holds
)
4409 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4414 ret
= lzc_hold(holds
, cleanup_fd
, &errors
);
4417 /* There may be errors even in the success case. */
4418 fnvlist_free(errors
);
4422 if (nvlist_empty(errors
)) {
4423 /* no hold-specific errors */
4424 (void) snprintf(errbuf
, sizeof (errbuf
),
4425 dgettext(TEXT_DOMAIN
, "cannot hold"));
4428 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4429 "pool must be upgraded"));
4430 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4433 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4436 (void) zfs_standard_error(hdl
, ret
, errbuf
);
4440 for (elem
= nvlist_next_nvpair(errors
, NULL
);
4442 elem
= nvlist_next_nvpair(errors
, elem
)) {
4443 (void) snprintf(errbuf
, sizeof (errbuf
),
4444 dgettext(TEXT_DOMAIN
,
4445 "cannot hold snapshot '%s'"), nvpair_name(elem
));
4446 switch (fnvpair_value_int32(elem
)) {
4449 * Temporary tags wind up having the ds object id
4450 * prepended. So even if we passed the length check
4451 * above, it's still possible for the tag to wind
4452 * up being slightly too long.
4454 (void) zfs_error(hdl
, EZFS_TAGTOOLONG
, errbuf
);
4457 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4460 (void) zfs_error(hdl
, EZFS_REFTAG_HOLD
, errbuf
);
4463 (void) zfs_standard_error(hdl
,
4464 fnvpair_value_int32(elem
), errbuf
);
4468 fnvlist_free(errors
);
4473 zfs_release_one(zfs_handle_t
*zhp
, void *arg
)
4475 struct holdarg
*ha
= arg
;
4476 char name
[ZFS_MAX_DATASET_NAME_LEN
];
4478 nvlist_t
*existing_holds
;
4480 (void) snprintf(name
, sizeof (name
),
4481 "%s@%s", zhp
->zfs_name
, ha
->snapname
);
4483 if (lzc_get_holds(name
, &existing_holds
) != 0) {
4485 } else if (!nvlist_exists(existing_holds
, ha
->tag
)) {
4488 nvlist_t
*torelease
= fnvlist_alloc();
4489 fnvlist_add_boolean(torelease
, ha
->tag
);
4490 fnvlist_add_nvlist(ha
->nvl
, name
, torelease
);
4491 fnvlist_free(torelease
);
4495 rv
= zfs_iter_filesystems(zhp
, zfs_release_one
, ha
);
4501 zfs_release(zfs_handle_t
*zhp
, const char *snapname
, const char *tag
,
4502 boolean_t recursive
)
4506 nvlist_t
*errors
= NULL
;
4508 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4511 ha
.nvl
= fnvlist_alloc();
4512 ha
.snapname
= snapname
;
4514 ha
.recursive
= recursive
;
4516 (void) zfs_release_one(zfs_handle_dup(zhp
), &ha
);
4518 if (nvlist_empty(ha
.nvl
)) {
4519 fnvlist_free(ha
.nvl
);
4521 (void) snprintf(errbuf
, sizeof (errbuf
),
4522 dgettext(TEXT_DOMAIN
,
4523 "cannot release hold from snapshot '%s@%s'"),
4524 zhp
->zfs_name
, snapname
);
4526 (void) zfs_error(hdl
, EZFS_REFTAG_RELE
, errbuf
);
4528 (void) zfs_standard_error(hdl
, ret
, errbuf
);
4533 ret
= lzc_release(ha
.nvl
, &errors
);
4534 fnvlist_free(ha
.nvl
);
4537 /* There may be errors even in the success case. */
4538 fnvlist_free(errors
);
4542 if (nvlist_empty(errors
)) {
4543 /* no hold-specific errors */
4544 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
4548 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4549 "pool must be upgraded"));
4550 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4553 (void) zfs_standard_error_fmt(hdl
, errno
, errbuf
);
4557 for (elem
= nvlist_next_nvpair(errors
, NULL
);
4559 elem
= nvlist_next_nvpair(errors
, elem
)) {
4560 (void) snprintf(errbuf
, sizeof (errbuf
),
4561 dgettext(TEXT_DOMAIN
,
4562 "cannot release hold from snapshot '%s'"),
4564 switch (fnvpair_value_int32(elem
)) {
4566 (void) zfs_error(hdl
, EZFS_REFTAG_RELE
, errbuf
);
4569 (void) zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4572 (void) zfs_standard_error_fmt(hdl
,
4573 fnvpair_value_int32(elem
), errbuf
);
4577 fnvlist_free(errors
);
4582 zfs_get_fsacl(zfs_handle_t
*zhp
, nvlist_t
**nvl
)
4584 zfs_cmd_t zc
= {"\0"};
4585 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4591 assert(zhp
->zfs_type
== ZFS_TYPE_VOLUME
||
4592 zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
);
4596 nvbuf
= malloc(nvsz
);
4597 if (nvbuf
== NULL
) {
4598 err
= (zfs_error(hdl
, EZFS_NOMEM
, strerror(errno
)));
4602 zc
.zc_nvlist_dst_size
= nvsz
;
4603 zc
.zc_nvlist_dst
= (uintptr_t)nvbuf
;
4605 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
4607 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_GET_FSACL
, &zc
) != 0) {
4608 (void) snprintf(errbuf
, sizeof (errbuf
),
4609 dgettext(TEXT_DOMAIN
, "cannot get permissions on '%s'"),
4614 nvsz
= zc
.zc_nvlist_dst_size
;
4618 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4619 "pool must be upgraded"));
4620 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4623 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4626 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
4629 err
= zfs_standard_error_fmt(hdl
, errno
, errbuf
);
4634 int rc
= nvlist_unpack(nvbuf
, zc
.zc_nvlist_dst_size
, nvl
, 0);
4636 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(
4637 TEXT_DOMAIN
, "cannot get permissions on '%s'"),
4639 err
= zfs_standard_error_fmt(hdl
, rc
, errbuf
);
4649 zfs_set_fsacl(zfs_handle_t
*zhp
, boolean_t un
, nvlist_t
*nvl
)
4651 zfs_cmd_t zc
= {"\0"};
4652 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4658 assert(zhp
->zfs_type
== ZFS_TYPE_VOLUME
||
4659 zhp
->zfs_type
== ZFS_TYPE_FILESYSTEM
);
4661 err
= nvlist_size(nvl
, &nvsz
, NV_ENCODE_NATIVE
);
4664 nvbuf
= malloc(nvsz
);
4666 err
= nvlist_pack(nvl
, &nvbuf
, &nvsz
, NV_ENCODE_NATIVE
, 0);
4669 zc
.zc_nvlist_src_size
= nvsz
;
4670 zc
.zc_nvlist_src
= (uintptr_t)nvbuf
;
4671 zc
.zc_perm_action
= un
;
4673 (void) strlcpy(zc
.zc_name
, zhp
->zfs_name
, sizeof (zc
.zc_name
));
4675 if (zfs_ioctl(hdl
, ZFS_IOC_SET_FSACL
, &zc
) != 0) {
4676 (void) snprintf(errbuf
, sizeof (errbuf
),
4677 dgettext(TEXT_DOMAIN
, "cannot set permissions on '%s'"),
4681 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4682 "pool must be upgraded"));
4683 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4686 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4689 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
4692 err
= zfs_standard_error_fmt(hdl
, errno
, errbuf
);
4703 zfs_get_holds(zfs_handle_t
*zhp
, nvlist_t
**nvl
)
4708 err
= lzc_get_holds(zhp
->zfs_name
, nvl
);
4711 libzfs_handle_t
*hdl
= zhp
->zfs_hdl
;
4713 (void) snprintf(errbuf
, sizeof (errbuf
),
4714 dgettext(TEXT_DOMAIN
, "cannot get holds for '%s'"),
4718 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4719 "pool must be upgraded"));
4720 err
= zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
4723 err
= zfs_error(hdl
, EZFS_BADTYPE
, errbuf
);
4726 err
= zfs_error(hdl
, EZFS_NOENT
, errbuf
);
4729 err
= zfs_standard_error_fmt(hdl
, errno
, errbuf
);
4738 * Convert the zvol's volume size to an appropriate reservation.
4739 * Note: If this routine is updated, it is necessary to update the ZFS test
4740 * suite's shell version in reservation.kshlib.
4743 zvol_volsize_to_reservation(uint64_t volsize
, nvlist_t
*props
)
4746 uint64_t nblocks
, volblocksize
;
4750 if (nvlist_lookup_string(props
,
4751 zfs_prop_to_name(ZFS_PROP_COPIES
), &strval
) == 0)
4752 ncopies
= atoi(strval
);
4755 if (nvlist_lookup_uint64(props
,
4756 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
4757 &volblocksize
) != 0)
4758 volblocksize
= ZVOL_DEFAULT_BLOCKSIZE
;
4759 nblocks
= volsize
/volblocksize
;
4760 /* start with metadnode L0-L6 */
4762 /* calculate number of indirects */
4763 while (nblocks
> 1) {
4764 nblocks
+= DNODES_PER_LEVEL
- 1;
4765 nblocks
/= DNODES_PER_LEVEL
;
4768 numdb
*= MIN(SPA_DVAS_PER_BP
, ncopies
+ 1);
4771 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4772 * compressed, but in practice they compress down to about
4775 numdb
*= 1ULL << DN_MAX_INDBLKSHIFT
;