4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
25 * Copyright (c) 2011, 2017 by Delphix. All rights reserved.
26 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
27 * Copyright (c) 2017 Datto Inc.
31 * Internal utility routines for the ZFS library.
34 #include <sys/param.h>
35 #include <sys/linker.h>
36 #include <sys/module.h>
49 #include <sys/mnttab.h>
50 #include <sys/mntent.h>
51 #include <sys/types.h>
52 #include <libcmdutils.h>
55 #include <libzfs_core.h>
57 #include "libzfs_impl.h"
59 #include "zfeature_common.h"
63 libzfs_errno(libzfs_handle_t *hdl)
65 return (hdl->libzfs_error);
69 libzfs_error_action(libzfs_handle_t *hdl)
71 return (hdl->libzfs_action);
75 libzfs_error_description(libzfs_handle_t *hdl)
77 if (hdl->libzfs_desc[0] != '\0')
78 return (hdl->libzfs_desc);
80 switch (hdl->libzfs_error) {
82 return (dgettext(TEXT_DOMAIN, "out of memory"));
84 return (dgettext(TEXT_DOMAIN, "invalid property value"));
85 case EZFS_PROPREADONLY:
86 return (dgettext(TEXT_DOMAIN, "read-only property"));
88 return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
89 "datasets of this type"));
90 case EZFS_PROPNONINHERIT:
91 return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
93 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
95 return (dgettext(TEXT_DOMAIN, "operation not applicable to "
96 "datasets of this type"));
98 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
100 return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
102 return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
104 return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
105 case EZFS_DSREADONLY:
106 return (dgettext(TEXT_DOMAIN, "dataset is read-only"));
108 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
110 case EZFS_INVALIDNAME:
111 return (dgettext(TEXT_DOMAIN, "invalid name"));
112 case EZFS_BADRESTORE:
113 return (dgettext(TEXT_DOMAIN, "unable to restore to "
116 return (dgettext(TEXT_DOMAIN, "backup failed"));
118 return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
120 return (dgettext(TEXT_DOMAIN, "no such device in pool"));
122 return (dgettext(TEXT_DOMAIN, "invalid device"));
123 case EZFS_NOREPLICAS:
124 return (dgettext(TEXT_DOMAIN, "no valid replicas"));
125 case EZFS_RESILVERING:
126 return (dgettext(TEXT_DOMAIN, "currently resilvering"));
127 case EZFS_BADVERSION:
128 return (dgettext(TEXT_DOMAIN, "unsupported version or "
130 case EZFS_POOLUNAVAIL:
131 return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
132 case EZFS_DEVOVERFLOW:
133 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
135 return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
136 case EZFS_CROSSTARGET:
137 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
140 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
141 case EZFS_MOUNTFAILED:
142 return (dgettext(TEXT_DOMAIN, "mount failed"));
143 case EZFS_UMOUNTFAILED:
144 return (dgettext(TEXT_DOMAIN, "umount failed"));
145 case EZFS_UNSHARENFSFAILED:
146 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
147 case EZFS_SHARENFSFAILED:
148 return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
149 case EZFS_UNSHARESMBFAILED:
150 return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
151 case EZFS_SHARESMBFAILED:
152 return (dgettext(TEXT_DOMAIN, "smb add share failed"));
154 return (dgettext(TEXT_DOMAIN, "permission denied"));
156 return (dgettext(TEXT_DOMAIN, "out of space"));
158 return (dgettext(TEXT_DOMAIN, "bad address"));
160 return (dgettext(TEXT_DOMAIN, "I/O error"));
162 return (dgettext(TEXT_DOMAIN, "signal received"));
164 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
166 case EZFS_INVALCONFIG:
167 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
169 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
171 return (dgettext(TEXT_DOMAIN, "no history available"));
173 return (dgettext(TEXT_DOMAIN, "failed to retrieve "
175 case EZFS_POOL_NOTSUP:
176 return (dgettext(TEXT_DOMAIN, "operation not supported "
177 "on this type of pool"));
178 case EZFS_POOL_INVALARG:
179 return (dgettext(TEXT_DOMAIN, "invalid argument for "
180 "this pool operation"));
181 case EZFS_NAMETOOLONG:
182 return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
183 case EZFS_OPENFAILED:
184 return (dgettext(TEXT_DOMAIN, "open failed"));
186 return (dgettext(TEXT_DOMAIN,
187 "disk capacity information could not be retrieved"));
188 case EZFS_LABELFAILED:
189 return (dgettext(TEXT_DOMAIN, "write of label failed"));
191 return (dgettext(TEXT_DOMAIN, "invalid user/group"));
193 return (dgettext(TEXT_DOMAIN, "invalid permission"));
194 case EZFS_BADPERMSET:
195 return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
196 case EZFS_NODELEGATION:
197 return (dgettext(TEXT_DOMAIN, "delegated administration is "
198 "disabled on pool"));
200 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
202 return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
203 case EZFS_VDEVNOTSUP:
204 return (dgettext(TEXT_DOMAIN, "vdev specification is not "
207 return (dgettext(TEXT_DOMAIN, "operation not supported "
209 case EZFS_ACTIVE_SPARE:
210 return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
212 case EZFS_UNPLAYED_LOGS:
213 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
215 case EZFS_REFTAG_RELE:
216 return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
217 case EZFS_REFTAG_HOLD:
218 return (dgettext(TEXT_DOMAIN, "tag already exists on this "
220 case EZFS_TAGTOOLONG:
221 return (dgettext(TEXT_DOMAIN, "tag too long"));
222 case EZFS_PIPEFAILED:
223 return (dgettext(TEXT_DOMAIN, "pipe create failed"));
224 case EZFS_THREADCREATEFAILED:
225 return (dgettext(TEXT_DOMAIN, "thread create failed"));
226 case EZFS_POSTSPLIT_ONLINE:
227 return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
229 case EZFS_SCRUB_PAUSED:
230 return (dgettext(TEXT_DOMAIN, "scrub is paused; "
231 "use 'zpool scrub' to resume"));
233 return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
234 "use 'zpool scrub -s' to cancel current scrub"));
236 return (dgettext(TEXT_DOMAIN, "there is no active scrub"));
238 return (dgettext(TEXT_DOMAIN, "unable to generate diffs"));
240 return (dgettext(TEXT_DOMAIN, "invalid diff data"));
241 case EZFS_POOLREADONLY:
242 return (dgettext(TEXT_DOMAIN, "pool is read-only"));
243 case EZFS_NO_PENDING:
244 return (dgettext(TEXT_DOMAIN, "operation is not "
246 case EZFS_CHECKPOINT_EXISTS:
247 return (dgettext(TEXT_DOMAIN, "checkpoint exists"));
248 case EZFS_DISCARDING_CHECKPOINT:
249 return (dgettext(TEXT_DOMAIN, "currently discarding "
251 case EZFS_NO_CHECKPOINT:
252 return (dgettext(TEXT_DOMAIN, "checkpoint does not exist"));
253 case EZFS_DEVRM_IN_PROGRESS:
254 return (dgettext(TEXT_DOMAIN, "device removal in progress"));
255 case EZFS_VDEV_TOO_BIG:
256 return (dgettext(TEXT_DOMAIN, "device exceeds supported size"));
258 return (dgettext(TEXT_DOMAIN, "unknown error"));
260 assert(hdl->libzfs_error == 0);
261 return (dgettext(TEXT_DOMAIN, "no error"));
267 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
273 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
275 hdl->libzfs_desc_active = 1;
281 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
283 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
285 hdl->libzfs_error = error;
287 if (hdl->libzfs_desc_active)
288 hdl->libzfs_desc_active = 0;
290 hdl->libzfs_desc[0] = '\0';
292 if (hdl->libzfs_printerr) {
293 if (error == EZFS_UNKNOWN) {
294 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
295 "error: %s\n"), libzfs_error_description(hdl));
299 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
300 libzfs_error_description(hdl));
301 if (error == EZFS_NOMEM)
307 zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
309 return (zfs_error_fmt(hdl, error, "%s", msg));
314 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
320 zfs_verror(hdl, error, fmt, ap);
328 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
334 zfs_verror(hdl, EZFS_PERM, fmt, ap);
338 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
342 zfs_verror(hdl, EZFS_IO, fmt, ap);
346 zfs_verror(hdl, EZFS_FAULT, fmt, ap);
350 zfs_verror(hdl, EZFS_INTR, fmt, ap);
358 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
360 return (zfs_standard_error_fmt(hdl, error, "%s", msg));
365 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
371 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
380 zfs_verror(hdl, EZFS_IO, fmt, ap);
384 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
385 "dataset does not exist"));
386 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
391 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
396 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
397 "dataset already exists"));
398 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
402 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
404 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
407 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
410 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
413 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap);
416 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
417 "pool I/O is currently suspended"));
418 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
421 zfs_error_aux(hdl, strerror(error));
422 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
431 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
433 return (zpool_standard_error_fmt(hdl, error, "%s", msg));
438 zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
444 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
451 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
456 dgettext(TEXT_DOMAIN, "no such pool or dataset"));
457 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
461 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
462 "pool already exists"));
463 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
467 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
468 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
472 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
473 "one or more devices is currently unavailable"));
474 zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
478 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
482 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
486 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
491 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
496 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
497 "pool I/O is currently suspended"));
498 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
502 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
504 /* There is no pending operation to cancel */
506 zfs_verror(hdl, EZFS_NO_PENDING, fmt, ap);
508 case ZFS_ERR_CHECKPOINT_EXISTS:
509 zfs_verror(hdl, EZFS_CHECKPOINT_EXISTS, fmt, ap);
511 case ZFS_ERR_DISCARDING_CHECKPOINT:
512 zfs_verror(hdl, EZFS_DISCARDING_CHECKPOINT, fmt, ap);
514 case ZFS_ERR_NO_CHECKPOINT:
515 zfs_verror(hdl, EZFS_NO_CHECKPOINT, fmt, ap);
517 case ZFS_ERR_DEVRM_IN_PROGRESS:
518 zfs_verror(hdl, EZFS_DEVRM_IN_PROGRESS, fmt, ap);
520 case ZFS_ERR_VDEV_TOO_BIG:
521 zfs_verror(hdl, EZFS_VDEV_TOO_BIG, fmt, ap);
524 zfs_error_aux(hdl, strerror(error));
525 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
533 * Display an out of memory error message and abort the current program.
536 no_memory(libzfs_handle_t *hdl)
538 return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
542 * A safe form of malloc() which will die if the allocation fails.
545 zfs_alloc(libzfs_handle_t *hdl, size_t size)
549 if ((data = calloc(1, size)) == NULL)
550 (void) no_memory(hdl);
556 * A safe form of asprintf() which will die if the allocation fails.
560 zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...)
568 err = vasprintf(&ret, fmt, ap);
573 (void) no_memory(hdl);
579 * A safe form of realloc(), which also zeroes newly allocated space.
582 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
586 if ((ret = realloc(ptr, newsize)) == NULL) {
587 (void) no_memory(hdl);
591 bzero((char *)ret + oldsize, (newsize - oldsize));
596 * A safe form of strdup() which will die if the allocation fails.
599 zfs_strdup(libzfs_handle_t *hdl, const char *str)
603 if ((ret = strdup(str)) == NULL)
604 (void) no_memory(hdl);
610 * Convert a number to an appropriately human-readable output.
613 zfs_nicenum(uint64_t num, char *buf, size_t buflen)
615 nicenum(num, buf, buflen);
619 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
621 hdl->libzfs_printerr = printerr;
629 if (modfind("zfs") < 0) {
630 /* Not present in kernel, try loading it. */
631 if (kldload("zfs") < 0 || modfind("zfs") < 0) {
642 libzfs_handle_t *hdl;
644 if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
648 if (libzfs_load() < 0) {
653 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
658 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
659 (void) close(hdl->libzfs_fd);
664 hdl->libzfs_sharetab = fopen(ZFS_EXPORTS_PATH, "r");
666 if (libzfs_core_init() != 0) {
667 (void) close(hdl->libzfs_fd);
668 (void) fclose(hdl->libzfs_mnttab);
669 (void) fclose(hdl->libzfs_sharetab);
676 zpool_feature_init();
677 libzfs_mnttab_init(hdl);
679 if (getenv("ZFS_PROP_DEBUG") != NULL) {
680 hdl->libzfs_prop_debug = B_TRUE;
687 libzfs_fini(libzfs_handle_t *hdl)
689 (void) close(hdl->libzfs_fd);
690 if (hdl->libzfs_mnttab)
691 (void) fclose(hdl->libzfs_mnttab);
692 if (hdl->libzfs_sharetab)
693 (void) fclose(hdl->libzfs_sharetab);
694 zfs_uninit_libshare(hdl);
695 zpool_free_handles(hdl);
697 libzfs_fru_clear(hdl, B_TRUE);
699 namespace_clear(hdl);
700 libzfs_mnttab_fini(hdl);
706 zpool_get_handle(zpool_handle_t *zhp)
708 return (zhp->zpool_hdl);
712 zfs_get_handle(zfs_handle_t *zhp)
714 return (zhp->zfs_hdl);
718 zfs_get_pool_handle(const zfs_handle_t *zhp)
720 return (zhp->zpool_hdl);
724 * Given a name, determine whether or not it's a valid path
725 * (starts with '/' or "./"). If so, walk the mnttab trying
726 * to match the device number. If not, treat the path as an
727 * fs/vol/snap/bkmark name.
730 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
732 struct stat64 statbuf;
733 struct extmnttab entry;
736 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
738 * It's not a valid path, assume it's a name of type 'argtype'.
740 return (zfs_open(hdl, path, argtype));
743 if (stat64(path, &statbuf) != 0) {
744 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
749 rewind(hdl->libzfs_mnttab);
750 while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
751 if (makedevice(entry.mnt_major, entry.mnt_minor) ==
760 ret = statfs(path, &sfs);
762 statfs2mnttab(&sfs, &entry);
764 (void) fprintf(stderr, "%s: %s\n", path,
773 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
774 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
779 return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
783 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
787 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
791 zc->zc_nvlist_dst_size = len;
793 (uint64_t)(uintptr_t)zfs_alloc(hdl, zc->zc_nvlist_dst_size);
794 if (zc->zc_nvlist_dst == 0)
801 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
802 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
803 * filled in by the kernel to indicate the actual required size.
806 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
808 free((void *)(uintptr_t)zc->zc_nvlist_dst);
810 (uint64_t)(uintptr_t)zfs_alloc(hdl, zc->zc_nvlist_dst_size);
811 if (zc->zc_nvlist_dst == 0)
818 * Called to free the src and dst nvlists stored in the command structure.
821 zcmd_free_nvlists(zfs_cmd_t *zc)
823 free((void *)(uintptr_t)zc->zc_nvlist_conf);
824 free((void *)(uintptr_t)zc->zc_nvlist_src);
825 free((void *)(uintptr_t)zc->zc_nvlist_dst);
826 zc->zc_nvlist_conf = NULL;
827 zc->zc_nvlist_src = NULL;
828 zc->zc_nvlist_dst = NULL;
832 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
838 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
840 if ((packed = zfs_alloc(hdl, len)) == NULL)
843 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
845 *outnv = (uint64_t)(uintptr_t)packed;
852 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
854 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
855 &zc->zc_nvlist_conf_size, nvl));
859 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
861 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
862 &zc->zc_nvlist_src_size, nvl));
866 * Unpacks an nvlist from the ZFS ioctl command structure.
869 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
871 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
872 zc->zc_nvlist_dst_size, nvlp, 0) != 0)
873 return (no_memory(hdl));
879 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
881 return (ioctl(hdl->libzfs_fd, request, zc));
885 * ================================================================
886 * API shared by zfs and zpool property management
887 * ================================================================
891 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
893 zprop_list_t *pl = cbp->cb_proplist;
898 cbp->cb_first = B_FALSE;
899 if (cbp->cb_scripted)
903 * Start with the length of the column headers.
905 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
906 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
908 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
910 cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
912 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
915 /* first property is always NAME */
916 assert(cbp->cb_proplist->pl_prop ==
917 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME));
920 * Go through and calculate the widths for each column. For the
921 * 'source' column, we kludge it up by taking the worst-case scenario of
922 * inheriting from the longest name. This is acceptable because in the
923 * majority of cases 'SOURCE' is the last column displayed, and we don't
924 * use the width anyway. Note that the 'VALUE' column can be oversized,
925 * if the name of the property is much longer than any values we find.
927 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
931 if (pl->pl_prop != ZPROP_INVAL) {
932 const char *propname = (type == ZFS_TYPE_POOL) ?
933 zpool_prop_to_name(pl->pl_prop) :
934 zfs_prop_to_name(pl->pl_prop);
936 len = strlen(propname);
937 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
938 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
940 len = strlen(pl->pl_user_prop);
941 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
942 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
946 * 'VALUE' column. The first property is always the 'name'
947 * property that was tacked on either by /sbin/zfs's
948 * zfs_do_get() or when calling zprop_expand_list(), so we
949 * ignore its width. If the user specified the name property
950 * to display, then it will be later in the list in any case.
952 if (pl != cbp->cb_proplist &&
953 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
954 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
956 /* 'RECEIVED' column. */
957 if (pl != cbp->cb_proplist &&
958 pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
959 cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
962 * 'NAME' and 'SOURCE' columns
964 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
966 pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
967 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
968 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
969 strlen(dgettext(TEXT_DOMAIN, "inherited from"));
974 * Now go through and print the headers.
976 for (i = 0; i < ZFS_GET_NCOLS; i++) {
977 switch (cbp->cb_columns[i]) {
979 title = dgettext(TEXT_DOMAIN, "NAME");
981 case GET_COL_PROPERTY:
982 title = dgettext(TEXT_DOMAIN, "PROPERTY");
985 title = dgettext(TEXT_DOMAIN, "VALUE");
988 title = dgettext(TEXT_DOMAIN, "RECEIVED");
991 title = dgettext(TEXT_DOMAIN, "SOURCE");
998 if (i == (ZFS_GET_NCOLS - 1) ||
999 cbp->cb_columns[i + 1] == GET_COL_NONE)
1000 (void) printf("%s", title);
1002 (void) printf("%-*s ",
1003 cbp->cb_colwidths[cbp->cb_columns[i]],
1007 (void) printf("\n");
1011 * Display a single line of output, according to the settings in the callback
1015 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
1016 const char *propname, const char *value, zprop_source_t sourcetype,
1017 const char *source, const char *recvd_value)
1020 const char *str = NULL;
1024 * Ignore those source types that the user has chosen to ignore.
1026 if ((sourcetype & cbp->cb_sources) == 0)
1030 zprop_print_headers(cbp, cbp->cb_type);
1032 for (i = 0; i < ZFS_GET_NCOLS; i++) {
1033 switch (cbp->cb_columns[i]) {
1038 case GET_COL_PROPERTY:
1046 case GET_COL_SOURCE:
1047 switch (sourcetype) {
1048 case ZPROP_SRC_NONE:
1052 case ZPROP_SRC_DEFAULT:
1056 case ZPROP_SRC_LOCAL:
1060 case ZPROP_SRC_TEMPORARY:
1064 case ZPROP_SRC_INHERITED:
1065 (void) snprintf(buf, sizeof (buf),
1066 "inherited from %s", source);
1069 case ZPROP_SRC_RECEIVED:
1075 assert(!"unhandled zprop_source_t");
1080 str = (recvd_value == NULL ? "-" : recvd_value);
1087 if (cbp->cb_columns[i + 1] == GET_COL_NONE)
1088 (void) printf("%s", str);
1089 else if (cbp->cb_scripted)
1090 (void) printf("%s\t", str);
1092 (void) printf("%-*s ",
1093 cbp->cb_colwidths[cbp->cb_columns[i]],
1097 (void) printf("\n");
1101 * Given a numeric suffix, convert the value into a number of bits that the
1102 * resulting value must be shifted.
1105 str2shift(libzfs_handle_t *hdl, const char *buf)
1107 const char *ends = "BKMGTPEZ";
1112 for (i = 0; i < strlen(ends); i++) {
1113 if (toupper(buf[0]) == ends[i])
1116 if (i == strlen(ends)) {
1117 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1118 "invalid numeric suffix '%s'"), buf);
1123 * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't
1124 * allow 'BB' - that's just weird.
1126 if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' &&
1127 toupper(buf[0]) != 'B'))
1130 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1131 "invalid numeric suffix '%s'"), buf);
1136 * Convert a string of the form '100G' into a real number. Used when setting
1137 * properties or creating a volume. 'buf' is used to place an extended error
1138 * message for the caller to use.
1141 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1148 /* Check to see if this looks like a number. */
1149 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1151 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1152 "bad numeric value '%s'"), value);
1156 /* Rely on strtoull() to process the numeric portion. */
1158 *num = strtoull(value, &end, 10);
1161 * Check for ERANGE, which indicates that the value is too large to fit
1162 * in a 64-bit value.
1164 if (errno == ERANGE) {
1166 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1167 "numeric value is too large"));
1172 * If we have a decimal value, then do the computation with floating
1173 * point arithmetic. Otherwise, use standard arithmetic.
1176 double fval = strtod(value, &end);
1178 if ((shift = str2shift(hdl, end)) == -1)
1181 fval *= pow(2, shift);
1183 if (fval > UINT64_MAX) {
1185 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1186 "numeric value is too large"));
1190 *num = (uint64_t)fval;
1192 if ((shift = str2shift(hdl, end)) == -1)
1195 /* Check for overflow */
1196 if (shift >= 64 || (*num << shift) >> shift != *num) {
1198 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1199 "numeric value is too large"));
1210 * Given a propname=value nvpair to set, parse any numeric properties
1211 * (index, boolean, etc) if they are specified as strings and add the
1212 * resulting nvpair to the returned nvlist.
1214 * At the DSL layer, all properties are either 64-bit numbers or strings.
1215 * We want the user to be able to ignore this fact and specify properties
1216 * as native values (numbers, for example) or as strings (to simplify
1217 * command line utilities). This also handles converting index types
1218 * (compression, checksum, etc) from strings to their on-disk index.
1221 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1222 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1225 data_type_t datatype = nvpair_type(elem);
1226 zprop_type_t proptype;
1227 const char *propname;
1229 boolean_t isnone = B_FALSE;
1231 if (type == ZFS_TYPE_POOL) {
1232 proptype = zpool_prop_get_type(prop);
1233 propname = zpool_prop_to_name(prop);
1235 proptype = zfs_prop_get_type(prop);
1236 propname = zfs_prop_to_name(prop);
1240 * Convert any properties to the internal DSL value types.
1246 case PROP_TYPE_STRING:
1247 if (datatype != DATA_TYPE_STRING) {
1248 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1249 "'%s' must be a string"), nvpair_name(elem));
1252 (void) nvpair_value_string(elem, svalp);
1253 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1254 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1255 "'%s' is too long"), nvpair_name(elem));
1260 case PROP_TYPE_NUMBER:
1261 if (datatype == DATA_TYPE_STRING) {
1262 (void) nvpair_value_string(elem, &value);
1263 if (strcmp(value, "none") == 0) {
1265 } else if (zfs_nicestrtonum(hdl, value, ivalp)
1269 } else if (datatype == DATA_TYPE_UINT64) {
1270 (void) nvpair_value_uint64(elem, ivalp);
1272 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1273 "'%s' must be a number"), nvpair_name(elem));
1278 * Quota special: force 'none' and don't allow 0.
1280 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1281 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1282 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1283 "use 'none' to disable quota/refquota"));
1288 * Special handling for "*_limit=none". In this case it's not
1291 if ((type & ZFS_TYPE_DATASET) && isnone &&
1292 (prop == ZFS_PROP_FILESYSTEM_LIMIT ||
1293 prop == ZFS_PROP_SNAPSHOT_LIMIT)) {
1294 *ivalp = UINT64_MAX;
1298 case PROP_TYPE_INDEX:
1299 if (datatype != DATA_TYPE_STRING) {
1300 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1301 "'%s' must be a string"), nvpair_name(elem));
1305 (void) nvpair_value_string(elem, &value);
1307 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1308 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1309 "'%s' must be one of '%s'"), propname,
1310 zprop_values(prop, type));
1320 * Add the result to our return set of properties.
1322 if (*svalp != NULL) {
1323 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1324 (void) no_memory(hdl);
1328 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1329 (void) no_memory(hdl);
1336 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1341 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1345 zprop_list_t *entry;
1347 prop = zprop_name_to_prop(propname, type);
1349 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1353 * When no property table entry can be found, return failure if
1354 * this is a pool property or if this isn't a user-defined
1357 if (prop == ZPROP_INVAL && ((type == ZFS_TYPE_POOL &&
1358 !zpool_prop_feature(propname) &&
1359 !zpool_prop_unsupported(propname)) ||
1360 (type == ZFS_TYPE_DATASET && !zfs_prop_user(propname) &&
1361 !zfs_prop_userquota(propname) && !zfs_prop_written(propname)))) {
1362 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1363 "invalid property '%s'"), propname);
1364 return (zfs_error(hdl, EZFS_BADPROP,
1365 dgettext(TEXT_DOMAIN, "bad property list")));
1368 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1371 entry->pl_prop = prop;
1372 if (prop == ZPROP_INVAL) {
1373 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) ==
1378 entry->pl_width = strlen(propname);
1380 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1390 * Given a comma-separated list of properties, construct a property list
1391 * containing both user-defined and native properties. This function will
1392 * return a NULL list if 'all' is specified, which can later be expanded
1393 * by zprop_expand_list().
1396 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1402 * If 'all' is specified, return a NULL list.
1404 if (strcmp(props, "all") == 0)
1408 * If no props were specified, return an error.
1410 if (props[0] == '\0') {
1411 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1412 "no properties specified"));
1413 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1414 "bad property list")));
1418 * It would be nice to use getsubopt() here, but the inclusion of column
1419 * aliases makes this more effort than it's worth.
1421 while (*props != '\0') {
1426 if ((p = strchr(props, ',')) == NULL) {
1427 len = strlen(props);
1434 * Check for empty options.
1437 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1438 "empty property name"));
1439 return (zfs_error(hdl, EZFS_BADPROP,
1440 dgettext(TEXT_DOMAIN, "bad property list")));
1444 * Check all regular property names.
1449 if (strcmp(props, "space") == 0) {
1450 static char *spaceprops[] = {
1451 "name", "avail", "used", "usedbysnapshots",
1452 "usedbydataset", "usedbyrefreservation",
1453 "usedbychildren", NULL
1457 for (i = 0; spaceprops[i]; i++) {
1458 if (addlist(hdl, spaceprops[i], listp, type))
1460 listp = &(*listp)->pl_next;
1463 if (addlist(hdl, props, listp, type))
1465 listp = &(*listp)->pl_next;
1477 zprop_free_list(zprop_list_t *pl)
1481 while (pl != NULL) {
1483 free(pl->pl_user_prop);
1489 typedef struct expand_data {
1490 zprop_list_t **last;
1491 libzfs_handle_t *hdl;
1496 zprop_expand_list_cb(int prop, void *cb)
1498 zprop_list_t *entry;
1499 expand_data_t *edp = cb;
1501 if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1502 return (ZPROP_INVAL);
1504 entry->pl_prop = prop;
1505 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1506 entry->pl_all = B_TRUE;
1508 *(edp->last) = entry;
1509 edp->last = &entry->pl_next;
1511 return (ZPROP_CONT);
1515 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1517 zprop_list_t *entry;
1518 zprop_list_t **last;
1523 * If this is the very first time we've been called for an 'all'
1524 * specification, expand the list to include all native
1533 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1534 B_FALSE, type) == ZPROP_INVAL)
1538 * Add 'name' to the beginning of the list, which is handled
1541 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1544 entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME :
1546 entry->pl_width = zprop_width(entry->pl_prop,
1547 &entry->pl_fixed, type);
1548 entry->pl_all = B_TRUE;
1549 entry->pl_next = *plp;
1556 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1559 return (zprop_iter_common(func, cb, show_all, ordered, type));