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]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
26 * Internal utility routines for the ZFS library.
39 #include <sys/mnttab.h>
40 #include <sys/mntent.h>
41 #include <sys/types.h>
45 #include "libzfs_impl.h"
49 libzfs_errno(libzfs_handle_t *hdl)
51 return (hdl->libzfs_error);
55 libzfs_error_action(libzfs_handle_t *hdl)
57 return (hdl->libzfs_action);
61 libzfs_error_description(libzfs_handle_t *hdl)
63 if (hdl->libzfs_desc[0] != '\0')
64 return (hdl->libzfs_desc);
66 switch (hdl->libzfs_error) {
68 return (dgettext(TEXT_DOMAIN, "out of memory"));
70 return (dgettext(TEXT_DOMAIN, "invalid property value"));
71 case EZFS_PROPREADONLY:
72 return (dgettext(TEXT_DOMAIN, "read-only property"));
74 return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
75 "datasets of this type"));
76 case EZFS_PROPNONINHERIT:
77 return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
79 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
81 return (dgettext(TEXT_DOMAIN, "operation not applicable to "
82 "datasets of this type"));
84 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
86 return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
88 return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
90 return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
92 return (dgettext(TEXT_DOMAIN, "dataset is read-only"));
94 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
96 case EZFS_INVALIDNAME:
97 return (dgettext(TEXT_DOMAIN, "invalid name"));
99 return (dgettext(TEXT_DOMAIN, "unable to restore to "
102 return (dgettext(TEXT_DOMAIN, "backup failed"));
104 return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
106 return (dgettext(TEXT_DOMAIN, "no such device in pool"));
108 return (dgettext(TEXT_DOMAIN, "invalid device"));
109 case EZFS_NOREPLICAS:
110 return (dgettext(TEXT_DOMAIN, "no valid replicas"));
111 case EZFS_RESILVERING:
112 return (dgettext(TEXT_DOMAIN, "currently resilvering"));
113 case EZFS_BADVERSION:
114 return (dgettext(TEXT_DOMAIN, "unsupported version"));
115 case EZFS_POOLUNAVAIL:
116 return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
117 case EZFS_DEVOVERFLOW:
118 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
120 return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
121 case EZFS_CROSSTARGET:
122 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
125 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
126 case EZFS_MOUNTFAILED:
127 return (dgettext(TEXT_DOMAIN, "mount failed"));
128 case EZFS_UMOUNTFAILED:
129 return (dgettext(TEXT_DOMAIN, "umount failed"));
130 case EZFS_UNSHARENFSFAILED:
131 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
132 case EZFS_SHARENFSFAILED:
133 return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
134 case EZFS_UNSHARESMBFAILED:
135 return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
136 case EZFS_SHARESMBFAILED:
137 return (dgettext(TEXT_DOMAIN, "smb add share failed"));
139 return (dgettext(TEXT_DOMAIN, "permission denied"));
141 return (dgettext(TEXT_DOMAIN, "out of space"));
143 return (dgettext(TEXT_DOMAIN, "bad address"));
145 return (dgettext(TEXT_DOMAIN, "I/O error"));
147 return (dgettext(TEXT_DOMAIN, "signal received"));
149 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
151 case EZFS_INVALCONFIG:
152 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
154 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
156 return (dgettext(TEXT_DOMAIN, "no history available"));
158 return (dgettext(TEXT_DOMAIN, "failed to retrieve "
160 case EZFS_POOL_NOTSUP:
161 return (dgettext(TEXT_DOMAIN, "operation not supported "
162 "on this type of pool"));
163 case EZFS_POOL_INVALARG:
164 return (dgettext(TEXT_DOMAIN, "invalid argument for "
165 "this pool operation"));
166 case EZFS_NAMETOOLONG:
167 return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
168 case EZFS_OPENFAILED:
169 return (dgettext(TEXT_DOMAIN, "open failed"));
171 return (dgettext(TEXT_DOMAIN,
172 "disk capacity information could not be retrieved"));
173 case EZFS_LABELFAILED:
174 return (dgettext(TEXT_DOMAIN, "write of label failed"));
176 return (dgettext(TEXT_DOMAIN, "invalid user/group"));
178 return (dgettext(TEXT_DOMAIN, "invalid permission"));
179 case EZFS_BADPERMSET:
180 return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
181 case EZFS_NODELEGATION:
182 return (dgettext(TEXT_DOMAIN, "delegated administration is "
183 "disabled on pool"));
185 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
187 return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
188 case EZFS_VDEVNOTSUP:
189 return (dgettext(TEXT_DOMAIN, "vdev specification is not "
192 return (dgettext(TEXT_DOMAIN, "operation not supported "
194 case EZFS_ACTIVE_SPARE:
195 return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
197 case EZFS_UNPLAYED_LOGS:
198 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
200 case EZFS_REFTAG_RELE:
201 return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
202 case EZFS_REFTAG_HOLD:
203 return (dgettext(TEXT_DOMAIN, "tag already exists on this "
205 case EZFS_TAGTOOLONG:
206 return (dgettext(TEXT_DOMAIN, "tag too long"));
207 case EZFS_PIPEFAILED:
208 return (dgettext(TEXT_DOMAIN, "pipe create failed"));
209 case EZFS_THREADCREATEFAILED:
210 return (dgettext(TEXT_DOMAIN, "thread create failed"));
211 case EZFS_POSTSPLIT_ONLINE:
212 return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
215 return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
216 "use 'zpool scrub -s' to cancel current scrub"));
218 return (dgettext(TEXT_DOMAIN, "there is no active scrub"));
220 return (dgettext(TEXT_DOMAIN, "unable to generate diffs"));
222 return (dgettext(TEXT_DOMAIN, "invalid diff data"));
223 case EZFS_POOLREADONLY:
224 return (dgettext(TEXT_DOMAIN, "pool is read-only"));
226 return (dgettext(TEXT_DOMAIN, "unknown error"));
228 assert(hdl->libzfs_error == 0);
229 return (dgettext(TEXT_DOMAIN, "no error"));
235 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
241 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
243 hdl->libzfs_desc_active = 1;
249 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
251 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
253 hdl->libzfs_error = error;
255 if (hdl->libzfs_desc_active)
256 hdl->libzfs_desc_active = 0;
258 hdl->libzfs_desc[0] = '\0';
260 if (hdl->libzfs_printerr) {
261 if (error == EZFS_UNKNOWN) {
262 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
263 "error: %s\n"), libzfs_error_description(hdl));
267 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
268 libzfs_error_description(hdl));
269 if (error == EZFS_NOMEM)
275 zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
277 return (zfs_error_fmt(hdl, error, "%s", msg));
282 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
288 zfs_verror(hdl, error, fmt, ap);
296 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
302 zfs_verror(hdl, EZFS_PERM, fmt, ap);
306 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
310 zfs_verror(hdl, EZFS_IO, fmt, ap);
314 zfs_verror(hdl, EZFS_FAULT, fmt, ap);
318 zfs_verror(hdl, EZFS_INTR, fmt, ap);
326 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
328 return (zfs_standard_error_fmt(hdl, error, "%s", msg));
333 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
339 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
347 zfs_verror(hdl, EZFS_IO, fmt, ap);
351 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
352 "dataset does not exist"));
353 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
358 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
362 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
363 "dataset already exists"));
364 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
368 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
370 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
373 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
376 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
379 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap);
382 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
383 "pool I/O is currently suspended"));
384 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
387 zfs_error_aux(hdl, strerror(error));
388 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
397 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
399 return (zpool_standard_error_fmt(hdl, error, "%s", msg));
404 zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
410 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
417 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
422 dgettext(TEXT_DOMAIN, "no such pool or dataset"));
423 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
427 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
428 "pool already exists"));
429 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
433 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
434 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
438 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
439 "one or more devices is currently unavailable"));
440 zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
444 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
448 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
452 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
457 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
461 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
462 "pool I/O is currently suspended"));
463 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
467 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
471 zfs_error_aux(hdl, strerror(error));
472 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
480 * Display an out of memory error message and abort the current program.
483 no_memory(libzfs_handle_t *hdl)
485 return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
489 * A safe form of malloc() which will die if the allocation fails.
492 zfs_alloc(libzfs_handle_t *hdl, size_t size)
496 if ((data = calloc(1, size)) == NULL)
497 (void) no_memory(hdl);
503 * A safe form of asprintf() which will die if the allocation fails.
507 zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...)
515 err = vasprintf(&ret, fmt, ap);
520 (void) no_memory(hdl);
526 * A safe form of realloc(), which also zeroes newly allocated space.
529 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
533 if ((ret = realloc(ptr, newsize)) == NULL) {
534 (void) no_memory(hdl);
538 bzero((char *)ret + oldsize, (newsize - oldsize));
543 * A safe form of strdup() which will die if the allocation fails.
546 zfs_strdup(libzfs_handle_t *hdl, const char *str)
550 if ((ret = strdup(str)) == NULL)
551 (void) no_memory(hdl);
557 * Convert a number to an appropriately human-readable output.
560 zfs_nicenum(uint64_t num, char *buf, size_t buflen)
571 u = " KMGTPE"[index];
574 (void) snprintf(buf, buflen, "%llu", (u_longlong_t) n);
575 } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
577 * If this is an even multiple of the base, always display
578 * without any decimal precision.
580 (void) snprintf(buf, buflen, "%llu%c", (u_longlong_t) n, u);
583 * We want to choose a precision that reflects the best choice
584 * for fitting in 5 characters. This can get rather tricky when
585 * we have numbers that are very close to an order of magnitude.
586 * For example, when displaying 10239 (which is really 9.999K),
587 * we want only a single place of precision for 10.0K. We could
588 * develop some complex heuristics for this, but it's much
589 * easier just to try each combination in turn.
592 for (i = 2; i >= 0; i--) {
593 if (snprintf(buf, buflen, "%.*f%c", i,
594 (double)num / (1ULL << 10 * index), u) <= 5)
601 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
603 hdl->libzfs_printerr = printerr;
609 libzfs_handle_t *hdl;
611 if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
615 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
620 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
621 (void) close(hdl->libzfs_fd);
626 hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
630 libzfs_mnttab_init(hdl);
636 libzfs_fini(libzfs_handle_t *hdl)
638 (void) close(hdl->libzfs_fd);
639 if (hdl->libzfs_mnttab)
640 (void) fclose(hdl->libzfs_mnttab);
641 if (hdl->libzfs_sharetab)
642 (void) fclose(hdl->libzfs_sharetab);
643 zfs_uninit_libshare(hdl);
644 if (hdl->libzfs_log_str)
645 (void) free(hdl->libzfs_log_str);
646 zpool_free_handles(hdl);
647 libzfs_fru_clear(hdl, B_TRUE);
648 namespace_clear(hdl);
649 libzfs_mnttab_fini(hdl);
654 zpool_get_handle(zpool_handle_t *zhp)
656 return (zhp->zpool_hdl);
660 zfs_get_handle(zfs_handle_t *zhp)
662 return (zhp->zfs_hdl);
666 zfs_get_pool_handle(const zfs_handle_t *zhp)
668 return (zhp->zpool_hdl);
672 * Given a name, determine whether or not it's a valid path
673 * (starts with '/' or "./"). If so, walk the mnttab trying
674 * to match the device number. If not, treat the path as an
678 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
680 struct stat64 statbuf;
681 struct extmnttab entry;
684 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
686 * It's not a valid path, assume it's a name of type 'argtype'.
688 return (zfs_open(hdl, path, argtype));
691 if (stat64(path, &statbuf) != 0) {
692 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
696 rewind(hdl->libzfs_mnttab);
697 while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
698 if (makedevice(entry.mnt_major, entry.mnt_minor) ==
707 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
708 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
713 return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
717 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
721 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
725 zc->zc_nvlist_dst_size = len;
726 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
727 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
734 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
735 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
736 * filled in by the kernel to indicate the actual required size.
739 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
741 free((void *)(uintptr_t)zc->zc_nvlist_dst);
742 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
743 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
750 * Called to free the src and dst nvlists stored in the command structure.
753 zcmd_free_nvlists(zfs_cmd_t *zc)
755 free((void *)(uintptr_t)zc->zc_nvlist_conf);
756 free((void *)(uintptr_t)zc->zc_nvlist_src);
757 free((void *)(uintptr_t)zc->zc_nvlist_dst);
761 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
767 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
769 if ((packed = zfs_alloc(hdl, len)) == NULL)
772 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
774 *outnv = (uint64_t)(uintptr_t)packed;
781 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
783 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
784 &zc->zc_nvlist_conf_size, nvl));
788 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
790 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
791 &zc->zc_nvlist_src_size, nvl));
795 * Unpacks an nvlist from the ZFS ioctl command structure.
798 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
800 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
801 zc->zc_nvlist_dst_size, nvlp, 0) != 0)
802 return (no_memory(hdl));
808 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
812 zc->zc_history = (uint64_t)(uintptr_t)hdl->libzfs_log_str;
813 error = ioctl(hdl->libzfs_fd, request, zc);
814 if (hdl->libzfs_log_str) {
815 free(hdl->libzfs_log_str);
816 hdl->libzfs_log_str = NULL;
824 * ================================================================
825 * API shared by zfs and zpool property management
826 * ================================================================
830 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
832 zprop_list_t *pl = cbp->cb_proplist;
837 cbp->cb_first = B_FALSE;
838 if (cbp->cb_scripted)
842 * Start with the length of the column headers.
844 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
845 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
847 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
849 cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
851 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
854 /* first property is always NAME */
855 assert(cbp->cb_proplist->pl_prop ==
856 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME));
859 * Go through and calculate the widths for each column. For the
860 * 'source' column, we kludge it up by taking the worst-case scenario of
861 * inheriting from the longest name. This is acceptable because in the
862 * majority of cases 'SOURCE' is the last column displayed, and we don't
863 * use the width anyway. Note that the 'VALUE' column can be oversized,
864 * if the name of the property is much longer than any values we find.
866 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
870 if (pl->pl_prop != ZPROP_INVAL) {
871 const char *propname = (type == ZFS_TYPE_POOL) ?
872 zpool_prop_to_name(pl->pl_prop) :
873 zfs_prop_to_name(pl->pl_prop);
875 len = strlen(propname);
876 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
877 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
879 len = strlen(pl->pl_user_prop);
880 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
881 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
885 * 'VALUE' column. The first property is always the 'name'
886 * property that was tacked on either by /sbin/zfs's
887 * zfs_do_get() or when calling zprop_expand_list(), so we
888 * ignore its width. If the user specified the name property
889 * to display, then it will be later in the list in any case.
891 if (pl != cbp->cb_proplist &&
892 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
893 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
895 /* 'RECEIVED' column. */
896 if (pl != cbp->cb_proplist &&
897 pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
898 cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
901 * 'NAME' and 'SOURCE' columns
903 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
905 pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
906 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
907 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
908 strlen(dgettext(TEXT_DOMAIN, "inherited from"));
913 * Now go through and print the headers.
915 for (i = 0; i < ZFS_GET_NCOLS; i++) {
916 switch (cbp->cb_columns[i]) {
918 title = dgettext(TEXT_DOMAIN, "NAME");
920 case GET_COL_PROPERTY:
921 title = dgettext(TEXT_DOMAIN, "PROPERTY");
924 title = dgettext(TEXT_DOMAIN, "VALUE");
927 title = dgettext(TEXT_DOMAIN, "RECEIVED");
930 title = dgettext(TEXT_DOMAIN, "SOURCE");
937 if (i == (ZFS_GET_NCOLS - 1) ||
938 cbp->cb_columns[i + 1] == GET_COL_NONE)
939 (void) printf("%s", title);
941 (void) printf("%-*s ",
942 cbp->cb_colwidths[cbp->cb_columns[i]],
950 * Display a single line of output, according to the settings in the callback
954 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
955 const char *propname, const char *value, zprop_source_t sourcetype,
956 const char *source, const char *recvd_value)
959 const char *str = NULL;
963 * Ignore those source types that the user has chosen to ignore.
965 if ((sourcetype & cbp->cb_sources) == 0)
969 zprop_print_headers(cbp, cbp->cb_type);
971 for (i = 0; i < ZFS_GET_NCOLS; i++) {
972 switch (cbp->cb_columns[i]) {
977 case GET_COL_PROPERTY:
986 switch (sourcetype) {
991 case ZPROP_SRC_DEFAULT:
995 case ZPROP_SRC_LOCAL:
999 case ZPROP_SRC_TEMPORARY:
1003 case ZPROP_SRC_INHERITED:
1004 (void) snprintf(buf, sizeof (buf),
1005 "inherited from %s", source);
1008 case ZPROP_SRC_RECEIVED:
1015 str = (recvd_value == NULL ? "-" : recvd_value);
1022 if (cbp->cb_columns[i + 1] == GET_COL_NONE)
1023 (void) printf("%s", str);
1024 else if (cbp->cb_scripted)
1025 (void) printf("%s\t", str);
1027 (void) printf("%-*s ",
1028 cbp->cb_colwidths[cbp->cb_columns[i]],
1032 (void) printf("\n");
1036 * Given a numeric suffix, convert the value into a number of bits that the
1037 * resulting value must be shifted.
1040 str2shift(libzfs_handle_t *hdl, const char *buf)
1042 const char *ends = "BKMGTPEZ";
1047 for (i = 0; i < strlen(ends); i++) {
1048 if (toupper(buf[0]) == ends[i])
1051 if (i == strlen(ends)) {
1052 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1053 "invalid numeric suffix '%s'"), buf);
1058 * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't
1059 * allow 'BB' - that's just weird.
1061 if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' &&
1062 toupper(buf[0]) != 'B'))
1065 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1066 "invalid numeric suffix '%s'"), buf);
1071 * Convert a string of the form '100G' into a real number. Used when setting
1072 * properties or creating a volume. 'buf' is used to place an extended error
1073 * message for the caller to use.
1076 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1083 /* Check to see if this looks like a number. */
1084 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1086 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1087 "bad numeric value '%s'"), value);
1091 /* Rely on strtoull() to process the numeric portion. */
1093 *num = strtoull(value, &end, 10);
1096 * Check for ERANGE, which indicates that the value is too large to fit
1097 * in a 64-bit value.
1099 if (errno == ERANGE) {
1101 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1102 "numeric value is too large"));
1107 * If we have a decimal value, then do the computation with floating
1108 * point arithmetic. Otherwise, use standard arithmetic.
1111 double fval = strtod(value, &end);
1113 if ((shift = str2shift(hdl, end)) == -1)
1116 fval *= pow(2, shift);
1118 if (fval > UINT64_MAX) {
1120 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1121 "numeric value is too large"));
1125 *num = (uint64_t)fval;
1127 if ((shift = str2shift(hdl, end)) == -1)
1130 /* Check for overflow */
1131 if (shift >= 64 || (*num << shift) >> shift != *num) {
1133 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1134 "numeric value is too large"));
1145 * Given a propname=value nvpair to set, parse any numeric properties
1146 * (index, boolean, etc) if they are specified as strings and add the
1147 * resulting nvpair to the returned nvlist.
1149 * At the DSL layer, all properties are either 64-bit numbers or strings.
1150 * We want the user to be able to ignore this fact and specify properties
1151 * as native values (numbers, for example) or as strings (to simplify
1152 * command line utilities). This also handles converting index types
1153 * (compression, checksum, etc) from strings to their on-disk index.
1156 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1157 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1160 data_type_t datatype = nvpair_type(elem);
1161 zprop_type_t proptype;
1162 const char *propname;
1164 boolean_t isnone = B_FALSE;
1166 if (type == ZFS_TYPE_POOL) {
1167 proptype = zpool_prop_get_type(prop);
1168 propname = zpool_prop_to_name(prop);
1170 proptype = zfs_prop_get_type(prop);
1171 propname = zfs_prop_to_name(prop);
1175 * Convert any properties to the internal DSL value types.
1181 case PROP_TYPE_STRING:
1182 if (datatype != DATA_TYPE_STRING) {
1183 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1184 "'%s' must be a string"), nvpair_name(elem));
1187 (void) nvpair_value_string(elem, svalp);
1188 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1189 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1190 "'%s' is too long"), nvpair_name(elem));
1195 case PROP_TYPE_NUMBER:
1196 if (datatype == DATA_TYPE_STRING) {
1197 (void) nvpair_value_string(elem, &value);
1198 if (strcmp(value, "none") == 0) {
1200 } else if (zfs_nicestrtonum(hdl, value, ivalp)
1204 } else if (datatype == DATA_TYPE_UINT64) {
1205 (void) nvpair_value_uint64(elem, ivalp);
1207 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1208 "'%s' must be a number"), nvpair_name(elem));
1213 * Quota special: force 'none' and don't allow 0.
1215 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1216 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1217 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1218 "use 'none' to disable quota/refquota"));
1223 case PROP_TYPE_INDEX:
1224 if (datatype != DATA_TYPE_STRING) {
1225 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1226 "'%s' must be a string"), nvpair_name(elem));
1230 (void) nvpair_value_string(elem, &value);
1232 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1233 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1234 "'%s' must be one of '%s'"), propname,
1235 zprop_values(prop, type));
1245 * Add the result to our return set of properties.
1247 if (*svalp != NULL) {
1248 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1249 (void) no_memory(hdl);
1253 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1254 (void) no_memory(hdl);
1261 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1266 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1270 zprop_list_t *entry;
1272 prop = zprop_name_to_prop(propname, type);
1274 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1278 * When no property table entry can be found, return failure if
1279 * this is a pool property or if this isn't a user-defined
1282 if (prop == ZPROP_INVAL && (type == ZFS_TYPE_POOL ||
1283 (!zfs_prop_user(propname) && !zfs_prop_userquota(propname)))) {
1284 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1285 "invalid property '%s'"), propname);
1286 return (zfs_error(hdl, EZFS_BADPROP,
1287 dgettext(TEXT_DOMAIN, "bad property list")));
1290 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1293 entry->pl_prop = prop;
1294 if (prop == ZPROP_INVAL) {
1295 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) == NULL) {
1299 entry->pl_width = strlen(propname);
1301 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1311 * Given a comma-separated list of properties, construct a property list
1312 * containing both user-defined and native properties. This function will
1313 * return a NULL list if 'all' is specified, which can later be expanded
1314 * by zprop_expand_list().
1317 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1323 * If 'all' is specified, return a NULL list.
1325 if (strcmp(props, "all") == 0)
1329 * If no props were specified, return an error.
1331 if (props[0] == '\0') {
1332 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1333 "no properties specified"));
1334 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1335 "bad property list")));
1339 * It would be nice to use getsubopt() here, but the inclusion of column
1340 * aliases makes this more effort than it's worth.
1342 while (*props != '\0') {
1347 if ((p = strchr(props, ',')) == NULL) {
1348 len = strlen(props);
1355 * Check for empty options.
1358 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1359 "empty property name"));
1360 return (zfs_error(hdl, EZFS_BADPROP,
1361 dgettext(TEXT_DOMAIN, "bad property list")));
1365 * Check all regular property names.
1370 if (strcmp(props, "space") == 0) {
1371 static char *spaceprops[] = {
1372 "name", "avail", "used", "usedbysnapshots",
1373 "usedbydataset", "usedbyrefreservation",
1374 "usedbychildren", NULL
1378 for (i = 0; spaceprops[i]; i++) {
1379 if (addlist(hdl, spaceprops[i], listp, type))
1381 listp = &(*listp)->pl_next;
1384 if (addlist(hdl, props, listp, type))
1386 listp = &(*listp)->pl_next;
1398 zprop_free_list(zprop_list_t *pl)
1402 while (pl != NULL) {
1404 free(pl->pl_user_prop);
1410 typedef struct expand_data {
1411 zprop_list_t **last;
1412 libzfs_handle_t *hdl;
1417 zprop_expand_list_cb(int prop, void *cb)
1419 zprop_list_t *entry;
1420 expand_data_t *edp = cb;
1422 if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1423 return (ZPROP_INVAL);
1425 entry->pl_prop = prop;
1426 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1427 entry->pl_all = B_TRUE;
1429 *(edp->last) = entry;
1430 edp->last = &entry->pl_next;
1432 return (ZPROP_CONT);
1436 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1438 zprop_list_t *entry;
1439 zprop_list_t **last;
1444 * If this is the very first time we've been called for an 'all'
1445 * specification, expand the list to include all native
1454 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1455 B_FALSE, type) == ZPROP_INVAL)
1459 * Add 'name' to the beginning of the list, which is handled
1462 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1465 entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME :
1467 entry->pl_width = zprop_width(entry->pl_prop,
1468 &entry->pl_fixed, type);
1469 entry->pl_all = B_TRUE;
1470 entry->pl_next = *plp;
1477 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1480 return (zprop_iter_common(func, cb, show_all, ordered, type));