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) 2012 by Delphix. All rights reserved.
28 * Internal utility routines for the ZFS library.
31 #include <sys/param.h>
32 #include <sys/linker.h>
33 #include <sys/module.h>
46 #include <sys/mnttab.h>
47 #include <sys/mntent.h>
48 #include <sys/types.h>
51 #include <libzfs_core.h>
53 #include "libzfs_impl.h"
55 #include "zfeature_common.h"
60 libzfs_errno(libzfs_handle_t *hdl)
62 return (hdl->libzfs_error);
66 libzfs_error_action(libzfs_handle_t *hdl)
68 return (hdl->libzfs_action);
72 libzfs_error_description(libzfs_handle_t *hdl)
74 if (hdl->libzfs_desc[0] != '\0')
75 return (hdl->libzfs_desc);
77 switch (hdl->libzfs_error) {
79 return (dgettext(TEXT_DOMAIN, "out of memory"));
81 return (dgettext(TEXT_DOMAIN, "invalid property value"));
82 case EZFS_PROPREADONLY:
83 return (dgettext(TEXT_DOMAIN, "read-only property"));
85 return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
86 "datasets of this type"));
87 case EZFS_PROPNONINHERIT:
88 return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
90 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
92 return (dgettext(TEXT_DOMAIN, "operation not applicable to "
93 "datasets of this type"));
95 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
97 return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
99 return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
101 return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
102 case EZFS_DSREADONLY:
103 return (dgettext(TEXT_DOMAIN, "dataset is read-only"));
105 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
107 case EZFS_INVALIDNAME:
108 return (dgettext(TEXT_DOMAIN, "invalid name"));
109 case EZFS_BADRESTORE:
110 return (dgettext(TEXT_DOMAIN, "unable to restore to "
113 return (dgettext(TEXT_DOMAIN, "backup failed"));
115 return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
117 return (dgettext(TEXT_DOMAIN, "no such device in pool"));
119 return (dgettext(TEXT_DOMAIN, "invalid device"));
120 case EZFS_NOREPLICAS:
121 return (dgettext(TEXT_DOMAIN, "no valid replicas"));
122 case EZFS_RESILVERING:
123 return (dgettext(TEXT_DOMAIN, "currently resilvering"));
124 case EZFS_BADVERSION:
125 return (dgettext(TEXT_DOMAIN, "unsupported version or "
127 case EZFS_POOLUNAVAIL:
128 return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
129 case EZFS_DEVOVERFLOW:
130 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
132 return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
133 case EZFS_CROSSTARGET:
134 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
137 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
138 case EZFS_MOUNTFAILED:
139 return (dgettext(TEXT_DOMAIN, "mount failed"));
140 case EZFS_UMOUNTFAILED:
141 return (dgettext(TEXT_DOMAIN, "umount failed"));
142 case EZFS_UNSHARENFSFAILED:
143 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
144 case EZFS_SHARENFSFAILED:
145 return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
146 case EZFS_UNSHARESMBFAILED:
147 return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
148 case EZFS_SHARESMBFAILED:
149 return (dgettext(TEXT_DOMAIN, "smb add share failed"));
151 return (dgettext(TEXT_DOMAIN, "permission denied"));
153 return (dgettext(TEXT_DOMAIN, "out of space"));
155 return (dgettext(TEXT_DOMAIN, "bad address"));
157 return (dgettext(TEXT_DOMAIN, "I/O error"));
159 return (dgettext(TEXT_DOMAIN, "signal received"));
161 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
163 case EZFS_INVALCONFIG:
164 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
166 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
168 return (dgettext(TEXT_DOMAIN, "no history available"));
170 return (dgettext(TEXT_DOMAIN, "failed to retrieve "
172 case EZFS_POOL_NOTSUP:
173 return (dgettext(TEXT_DOMAIN, "operation not supported "
174 "on this type of pool"));
175 case EZFS_POOL_INVALARG:
176 return (dgettext(TEXT_DOMAIN, "invalid argument for "
177 "this pool operation"));
178 case EZFS_NAMETOOLONG:
179 return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
180 case EZFS_OPENFAILED:
181 return (dgettext(TEXT_DOMAIN, "open failed"));
183 return (dgettext(TEXT_DOMAIN,
184 "disk capacity information could not be retrieved"));
185 case EZFS_LABELFAILED:
186 return (dgettext(TEXT_DOMAIN, "write of label failed"));
188 return (dgettext(TEXT_DOMAIN, "invalid user/group"));
190 return (dgettext(TEXT_DOMAIN, "invalid permission"));
191 case EZFS_BADPERMSET:
192 return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
193 case EZFS_NODELEGATION:
194 return (dgettext(TEXT_DOMAIN, "delegated administration is "
195 "disabled on pool"));
197 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
199 return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
200 case EZFS_VDEVNOTSUP:
201 return (dgettext(TEXT_DOMAIN, "vdev specification is not "
204 return (dgettext(TEXT_DOMAIN, "operation not supported "
206 case EZFS_ACTIVE_SPARE:
207 return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
209 case EZFS_UNPLAYED_LOGS:
210 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
212 case EZFS_REFTAG_RELE:
213 return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
214 case EZFS_REFTAG_HOLD:
215 return (dgettext(TEXT_DOMAIN, "tag already exists on this "
217 case EZFS_TAGTOOLONG:
218 return (dgettext(TEXT_DOMAIN, "tag too long"));
219 case EZFS_PIPEFAILED:
220 return (dgettext(TEXT_DOMAIN, "pipe create failed"));
221 case EZFS_THREADCREATEFAILED:
222 return (dgettext(TEXT_DOMAIN, "thread create failed"));
223 case EZFS_POSTSPLIT_ONLINE:
224 return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
227 return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
228 "use 'zpool scrub -s' to cancel current scrub"));
230 return (dgettext(TEXT_DOMAIN, "there is no active scrub"));
232 return (dgettext(TEXT_DOMAIN, "unable to generate diffs"));
234 return (dgettext(TEXT_DOMAIN, "invalid diff data"));
235 case EZFS_POOLREADONLY:
236 return (dgettext(TEXT_DOMAIN, "pool is read-only"));
238 return (dgettext(TEXT_DOMAIN, "unknown error"));
240 assert(hdl->libzfs_error == 0);
241 return (dgettext(TEXT_DOMAIN, "no error"));
247 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
253 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
255 hdl->libzfs_desc_active = 1;
261 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
263 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
265 hdl->libzfs_error = error;
267 if (hdl->libzfs_desc_active)
268 hdl->libzfs_desc_active = 0;
270 hdl->libzfs_desc[0] = '\0';
272 if (hdl->libzfs_printerr) {
273 if (error == EZFS_UNKNOWN) {
274 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
275 "error: %s\n"), libzfs_error_description(hdl));
279 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
280 libzfs_error_description(hdl));
281 if (error == EZFS_NOMEM)
287 zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
289 return (zfs_error_fmt(hdl, error, "%s", msg));
294 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
300 zfs_verror(hdl, error, fmt, ap);
308 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
314 zfs_verror(hdl, EZFS_PERM, fmt, ap);
318 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
322 zfs_verror(hdl, EZFS_IO, fmt, ap);
326 zfs_verror(hdl, EZFS_FAULT, fmt, ap);
330 zfs_verror(hdl, EZFS_INTR, fmt, ap);
338 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
340 return (zfs_standard_error_fmt(hdl, error, "%s", msg));
345 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
351 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
360 zfs_verror(hdl, EZFS_IO, fmt, ap);
364 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
365 "dataset does not exist"));
366 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
371 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
376 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
377 "dataset already exists"));
378 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
382 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
384 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
387 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
390 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
393 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap);
396 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
397 "pool I/O is currently suspended"));
398 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
401 zfs_error_aux(hdl, strerror(error));
402 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
411 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
413 return (zpool_standard_error_fmt(hdl, error, "%s", msg));
418 zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
424 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
431 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
436 dgettext(TEXT_DOMAIN, "no such pool or dataset"));
437 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
441 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
442 "pool already exists"));
443 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
447 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
448 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
452 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
453 "one or more devices is currently unavailable"));
454 zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
458 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
462 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
466 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
471 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
476 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
477 "pool I/O is currently suspended"));
478 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
482 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
486 zfs_error_aux(hdl, strerror(error));
487 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
495 * Display an out of memory error message and abort the current program.
498 no_memory(libzfs_handle_t *hdl)
500 return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
504 * A safe form of malloc() which will die if the allocation fails.
507 zfs_alloc(libzfs_handle_t *hdl, size_t size)
511 if ((data = calloc(1, size)) == NULL)
512 (void) no_memory(hdl);
518 * A safe form of asprintf() which will die if the allocation fails.
522 zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...)
530 err = vasprintf(&ret, fmt, ap);
535 (void) no_memory(hdl);
541 * A safe form of realloc(), which also zeroes newly allocated space.
544 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
548 if ((ret = realloc(ptr, newsize)) == NULL) {
549 (void) no_memory(hdl);
553 bzero((char *)ret + oldsize, (newsize - oldsize));
558 * A safe form of strdup() which will die if the allocation fails.
561 zfs_strdup(libzfs_handle_t *hdl, const char *str)
565 if ((ret = strdup(str)) == NULL)
566 (void) no_memory(hdl);
572 * Convert a number to an appropriately human-readable output.
575 zfs_nicenum(uint64_t num, char *buf, size_t buflen)
586 u = " KMGTPE"[index];
589 (void) snprintf(buf, buflen, "%llu", n);
590 } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
592 * If this is an even multiple of the base, always display
593 * without any decimal precision.
595 (void) snprintf(buf, buflen, "%llu%c", n, u);
598 * We want to choose a precision that reflects the best choice
599 * for fitting in 5 characters. This can get rather tricky when
600 * we have numbers that are very close to an order of magnitude.
601 * For example, when displaying 10239 (which is really 9.999K),
602 * we want only a single place of precision for 10.0K. We could
603 * develop some complex heuristics for this, but it's much
604 * easier just to try each combination in turn.
607 for (i = 2; i >= 0; i--) {
608 if (snprintf(buf, buflen, "%.*f%c", i,
609 (double)num / (1ULL << 10 * index), u) <= 5)
616 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
618 hdl->libzfs_printerr = printerr;
626 if (modfind("zfs") < 0) {
627 /* Not present in kernel, try loading it. */
628 if (kldload("zfs") < 0 || modfind("zfs") < 0) {
639 libzfs_handle_t *hdl;
641 if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
645 if (libzfs_load() < 0) {
650 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
655 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
656 (void) close(hdl->libzfs_fd);
661 hdl->libzfs_sharetab = fopen(ZFS_EXPORTS_PATH, "r");
663 if (libzfs_core_init() != 0) {
664 (void) close(hdl->libzfs_fd);
665 (void) fclose(hdl->libzfs_mnttab);
666 (void) fclose(hdl->libzfs_sharetab);
673 zpool_feature_init();
674 libzfs_mnttab_init(hdl);
680 libzfs_fini(libzfs_handle_t *hdl)
682 (void) close(hdl->libzfs_fd);
683 if (hdl->libzfs_mnttab)
684 (void) fclose(hdl->libzfs_mnttab);
685 if (hdl->libzfs_sharetab)
686 (void) fclose(hdl->libzfs_sharetab);
687 zfs_uninit_libshare(hdl);
688 zpool_free_handles(hdl);
690 libzfs_fru_clear(hdl, B_TRUE);
692 namespace_clear(hdl);
693 libzfs_mnttab_fini(hdl);
699 zpool_get_handle(zpool_handle_t *zhp)
701 return (zhp->zpool_hdl);
705 zfs_get_handle(zfs_handle_t *zhp)
707 return (zhp->zfs_hdl);
711 zfs_get_pool_handle(const zfs_handle_t *zhp)
713 return (zhp->zpool_hdl);
717 * Given a name, determine whether or not it's a valid path
718 * (starts with '/' or "./"). If so, walk the mnttab trying
719 * to match the device number. If not, treat the path as an
723 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
725 struct stat64 statbuf;
726 struct extmnttab entry;
729 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
731 * It's not a valid path, assume it's a name of type 'argtype'.
733 return (zfs_open(hdl, path, argtype));
736 if (stat64(path, &statbuf) != 0) {
737 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
742 rewind(hdl->libzfs_mnttab);
743 while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
744 if (makedevice(entry.mnt_major, entry.mnt_minor) ==
753 ret = statfs(path, &sfs);
755 statfs2mnttab(&sfs, &entry);
757 (void) fprintf(stderr, "%s: %s\n", path,
766 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
767 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
772 return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
776 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
780 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
784 zc->zc_nvlist_dst_size = len;
785 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
786 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
793 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
794 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
795 * filled in by the kernel to indicate the actual required size.
798 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
800 free((void *)(uintptr_t)zc->zc_nvlist_dst);
801 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
802 zfs_alloc(hdl, zc->zc_nvlist_dst_size))
810 * Called to free the src and dst nvlists stored in the command structure.
813 zcmd_free_nvlists(zfs_cmd_t *zc)
815 free((void *)(uintptr_t)zc->zc_nvlist_conf);
816 free((void *)(uintptr_t)zc->zc_nvlist_src);
817 free((void *)(uintptr_t)zc->zc_nvlist_dst);
821 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
827 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
829 if ((packed = zfs_alloc(hdl, len)) == NULL)
832 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
834 *outnv = (uint64_t)(uintptr_t)packed;
841 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
843 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
844 &zc->zc_nvlist_conf_size, nvl));
848 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
850 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
851 &zc->zc_nvlist_src_size, nvl));
855 * Unpacks an nvlist from the ZFS ioctl command structure.
858 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
860 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
861 zc->zc_nvlist_dst_size, nvlp, 0) != 0)
862 return (no_memory(hdl));
868 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
870 return (ioctl(hdl->libzfs_fd, request, zc));
874 * ================================================================
875 * API shared by zfs and zpool property management
876 * ================================================================
880 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
882 zprop_list_t *pl = cbp->cb_proplist;
887 cbp->cb_first = B_FALSE;
888 if (cbp->cb_scripted)
892 * Start with the length of the column headers.
894 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
895 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
897 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
899 cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
901 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
904 /* first property is always NAME */
905 assert(cbp->cb_proplist->pl_prop ==
906 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME));
909 * Go through and calculate the widths for each column. For the
910 * 'source' column, we kludge it up by taking the worst-case scenario of
911 * inheriting from the longest name. This is acceptable because in the
912 * majority of cases 'SOURCE' is the last column displayed, and we don't
913 * use the width anyway. Note that the 'VALUE' column can be oversized,
914 * if the name of the property is much longer than any values we find.
916 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
920 if (pl->pl_prop != ZPROP_INVAL) {
921 const char *propname = (type == ZFS_TYPE_POOL) ?
922 zpool_prop_to_name(pl->pl_prop) :
923 zfs_prop_to_name(pl->pl_prop);
925 len = strlen(propname);
926 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
927 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
929 len = strlen(pl->pl_user_prop);
930 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
931 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
935 * 'VALUE' column. The first property is always the 'name'
936 * property that was tacked on either by /sbin/zfs's
937 * zfs_do_get() or when calling zprop_expand_list(), so we
938 * ignore its width. If the user specified the name property
939 * to display, then it will be later in the list in any case.
941 if (pl != cbp->cb_proplist &&
942 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
943 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
945 /* 'RECEIVED' column. */
946 if (pl != cbp->cb_proplist &&
947 pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
948 cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
951 * 'NAME' and 'SOURCE' columns
953 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
955 pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
956 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
957 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
958 strlen(dgettext(TEXT_DOMAIN, "inherited from"));
963 * Now go through and print the headers.
965 for (i = 0; i < ZFS_GET_NCOLS; i++) {
966 switch (cbp->cb_columns[i]) {
968 title = dgettext(TEXT_DOMAIN, "NAME");
970 case GET_COL_PROPERTY:
971 title = dgettext(TEXT_DOMAIN, "PROPERTY");
974 title = dgettext(TEXT_DOMAIN, "VALUE");
977 title = dgettext(TEXT_DOMAIN, "RECEIVED");
980 title = dgettext(TEXT_DOMAIN, "SOURCE");
987 if (i == (ZFS_GET_NCOLS - 1) ||
988 cbp->cb_columns[i + 1] == GET_COL_NONE)
989 (void) printf("%s", title);
991 (void) printf("%-*s ",
992 cbp->cb_colwidths[cbp->cb_columns[i]],
1000 * Display a single line of output, according to the settings in the callback
1004 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
1005 const char *propname, const char *value, zprop_source_t sourcetype,
1006 const char *source, const char *recvd_value)
1013 * Ignore those source types that the user has chosen to ignore.
1015 if ((sourcetype & cbp->cb_sources) == 0)
1019 zprop_print_headers(cbp, cbp->cb_type);
1021 for (i = 0; i < ZFS_GET_NCOLS; i++) {
1022 switch (cbp->cb_columns[i]) {
1027 case GET_COL_PROPERTY:
1035 case GET_COL_SOURCE:
1036 switch (sourcetype) {
1037 case ZPROP_SRC_NONE:
1041 case ZPROP_SRC_DEFAULT:
1045 case ZPROP_SRC_LOCAL:
1049 case ZPROP_SRC_TEMPORARY:
1053 case ZPROP_SRC_INHERITED:
1054 (void) snprintf(buf, sizeof (buf),
1055 "inherited from %s", source);
1058 case ZPROP_SRC_RECEIVED:
1065 str = (recvd_value == NULL ? "-" : recvd_value);
1072 if (cbp->cb_columns[i + 1] == GET_COL_NONE)
1073 (void) printf("%s", str);
1074 else if (cbp->cb_scripted)
1075 (void) printf("%s\t", str);
1077 (void) printf("%-*s ",
1078 cbp->cb_colwidths[cbp->cb_columns[i]],
1082 (void) printf("\n");
1086 * Given a numeric suffix, convert the value into a number of bits that the
1087 * resulting value must be shifted.
1090 str2shift(libzfs_handle_t *hdl, const char *buf)
1092 const char *ends = "BKMGTPEZ";
1097 for (i = 0; i < strlen(ends); i++) {
1098 if (toupper(buf[0]) == ends[i])
1101 if (i == strlen(ends)) {
1102 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1103 "invalid numeric suffix '%s'"), buf);
1108 * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't
1109 * allow 'BB' - that's just weird.
1111 if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' &&
1112 toupper(buf[0]) != 'B'))
1115 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1116 "invalid numeric suffix '%s'"), buf);
1121 * Convert a string of the form '100G' into a real number. Used when setting
1122 * properties or creating a volume. 'buf' is used to place an extended error
1123 * message for the caller to use.
1126 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1133 /* Check to see if this looks like a number. */
1134 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1136 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1137 "bad numeric value '%s'"), value);
1141 /* Rely on strtoull() to process the numeric portion. */
1143 *num = strtoull(value, &end, 10);
1146 * Check for ERANGE, which indicates that the value is too large to fit
1147 * in a 64-bit value.
1149 if (errno == ERANGE) {
1151 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1152 "numeric value is too large"));
1157 * If we have a decimal value, then do the computation with floating
1158 * point arithmetic. Otherwise, use standard arithmetic.
1161 double fval = strtod(value, &end);
1163 if ((shift = str2shift(hdl, end)) == -1)
1166 fval *= pow(2, shift);
1168 if (fval > UINT64_MAX) {
1170 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1171 "numeric value is too large"));
1175 *num = (uint64_t)fval;
1177 if ((shift = str2shift(hdl, end)) == -1)
1180 /* Check for overflow */
1181 if (shift >= 64 || (*num << shift) >> shift != *num) {
1183 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1184 "numeric value is too large"));
1195 * Given a propname=value nvpair to set, parse any numeric properties
1196 * (index, boolean, etc) if they are specified as strings and add the
1197 * resulting nvpair to the returned nvlist.
1199 * At the DSL layer, all properties are either 64-bit numbers or strings.
1200 * We want the user to be able to ignore this fact and specify properties
1201 * as native values (numbers, for example) or as strings (to simplify
1202 * command line utilities). This also handles converting index types
1203 * (compression, checksum, etc) from strings to their on-disk index.
1206 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1207 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1210 data_type_t datatype = nvpair_type(elem);
1211 zprop_type_t proptype;
1212 const char *propname;
1214 boolean_t isnone = B_FALSE;
1216 if (type == ZFS_TYPE_POOL) {
1217 proptype = zpool_prop_get_type(prop);
1218 propname = zpool_prop_to_name(prop);
1220 proptype = zfs_prop_get_type(prop);
1221 propname = zfs_prop_to_name(prop);
1225 * Convert any properties to the internal DSL value types.
1231 case PROP_TYPE_STRING:
1232 if (datatype != DATA_TYPE_STRING) {
1233 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1234 "'%s' must be a string"), nvpair_name(elem));
1237 (void) nvpair_value_string(elem, svalp);
1238 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1239 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1240 "'%s' is too long"), nvpair_name(elem));
1245 case PROP_TYPE_NUMBER:
1246 if (datatype == DATA_TYPE_STRING) {
1247 (void) nvpair_value_string(elem, &value);
1248 if (strcmp(value, "none") == 0) {
1250 } else if (zfs_nicestrtonum(hdl, value, ivalp)
1254 } else if (datatype == DATA_TYPE_UINT64) {
1255 (void) nvpair_value_uint64(elem, ivalp);
1257 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1258 "'%s' must be a number"), nvpair_name(elem));
1263 * Quota special: force 'none' and don't allow 0.
1265 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1266 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1267 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1268 "use 'none' to disable quota/refquota"));
1273 case PROP_TYPE_INDEX:
1274 if (datatype != DATA_TYPE_STRING) {
1275 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1276 "'%s' must be a string"), nvpair_name(elem));
1280 (void) nvpair_value_string(elem, &value);
1282 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1283 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1284 "'%s' must be one of '%s'"), propname,
1285 zprop_values(prop, type));
1295 * Add the result to our return set of properties.
1297 if (*svalp != NULL) {
1298 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1299 (void) no_memory(hdl);
1303 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1304 (void) no_memory(hdl);
1311 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1316 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1320 zprop_list_t *entry;
1322 prop = zprop_name_to_prop(propname, type);
1324 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1328 * When no property table entry can be found, return failure if
1329 * this is a pool property or if this isn't a user-defined
1332 if (prop == ZPROP_INVAL && ((type == ZFS_TYPE_POOL &&
1333 !zpool_prop_feature(propname) &&
1334 !zpool_prop_unsupported(propname)) ||
1335 (type == ZFS_TYPE_DATASET && !zfs_prop_user(propname) &&
1336 !zfs_prop_userquota(propname) && !zfs_prop_written(propname)))) {
1337 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1338 "invalid property '%s'"), propname);
1339 return (zfs_error(hdl, EZFS_BADPROP,
1340 dgettext(TEXT_DOMAIN, "bad property list")));
1343 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1346 entry->pl_prop = prop;
1347 if (prop == ZPROP_INVAL) {
1348 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) ==
1353 entry->pl_width = strlen(propname);
1355 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1365 * Given a comma-separated list of properties, construct a property list
1366 * containing both user-defined and native properties. This function will
1367 * return a NULL list if 'all' is specified, which can later be expanded
1368 * by zprop_expand_list().
1371 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1377 * If 'all' is specified, return a NULL list.
1379 if (strcmp(props, "all") == 0)
1383 * If no props were specified, return an error.
1385 if (props[0] == '\0') {
1386 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1387 "no properties specified"));
1388 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1389 "bad property list")));
1393 * It would be nice to use getsubopt() here, but the inclusion of column
1394 * aliases makes this more effort than it's worth.
1396 while (*props != '\0') {
1401 if ((p = strchr(props, ',')) == NULL) {
1402 len = strlen(props);
1409 * Check for empty options.
1412 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1413 "empty property name"));
1414 return (zfs_error(hdl, EZFS_BADPROP,
1415 dgettext(TEXT_DOMAIN, "bad property list")));
1419 * Check all regular property names.
1424 if (strcmp(props, "space") == 0) {
1425 static char *spaceprops[] = {
1426 "name", "avail", "used", "usedbysnapshots",
1427 "usedbydataset", "usedbyrefreservation",
1428 "usedbychildren", NULL
1432 for (i = 0; spaceprops[i]; i++) {
1433 if (addlist(hdl, spaceprops[i], listp, type))
1435 listp = &(*listp)->pl_next;
1438 if (addlist(hdl, props, listp, type))
1440 listp = &(*listp)->pl_next;
1452 zprop_free_list(zprop_list_t *pl)
1456 while (pl != NULL) {
1458 free(pl->pl_user_prop);
1464 typedef struct expand_data {
1465 zprop_list_t **last;
1466 libzfs_handle_t *hdl;
1471 zprop_expand_list_cb(int prop, void *cb)
1473 zprop_list_t *entry;
1474 expand_data_t *edp = cb;
1476 if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1477 return (ZPROP_INVAL);
1479 entry->pl_prop = prop;
1480 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1481 entry->pl_all = B_TRUE;
1483 *(edp->last) = entry;
1484 edp->last = &entry->pl_next;
1486 return (ZPROP_CONT);
1490 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1492 zprop_list_t *entry;
1493 zprop_list_t **last;
1498 * If this is the very first time we've been called for an 'all'
1499 * specification, expand the list to include all native
1508 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1509 B_FALSE, type) == ZPROP_INVAL)
1513 * Add 'name' to the beginning of the list, which is handled
1516 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1519 entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME :
1521 entry->pl_width = zprop_width(entry->pl_prop,
1522 &entry->pl_fixed, type);
1523 entry->pl_all = B_TRUE;
1524 entry->pl_next = *plp;
1531 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1534 return (zprop_iter_common(func, cb, show_all, ordered, type));