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.
40 #include <sys/mnttab.h>
41 #include <sys/mntent.h>
42 #include <sys/types.h>
46 #include "libzfs_impl.h"
50 libzfs_errno(libzfs_handle_t *hdl)
52 return (hdl->libzfs_error);
56 libzfs_error_action(libzfs_handle_t *hdl)
58 return (hdl->libzfs_action);
62 libzfs_error_description(libzfs_handle_t *hdl)
64 if (hdl->libzfs_desc[0] != '\0')
65 return (hdl->libzfs_desc);
67 switch (hdl->libzfs_error) {
69 return (dgettext(TEXT_DOMAIN, "out of memory"));
71 return (dgettext(TEXT_DOMAIN, "invalid property value"));
72 case EZFS_PROPREADONLY:
73 return (dgettext(TEXT_DOMAIN, "read-only property"));
75 return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
76 "datasets of this type"));
77 case EZFS_PROPNONINHERIT:
78 return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
80 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
82 return (dgettext(TEXT_DOMAIN, "operation not applicable to "
83 "datasets of this type"));
85 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
87 return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
89 return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
91 return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
93 return (dgettext(TEXT_DOMAIN, "dataset is read-only"));
95 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
97 case EZFS_INVALIDNAME:
98 return (dgettext(TEXT_DOMAIN, "invalid name"));
100 return (dgettext(TEXT_DOMAIN, "unable to restore to "
103 return (dgettext(TEXT_DOMAIN, "backup failed"));
105 return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
107 return (dgettext(TEXT_DOMAIN, "no such device in pool"));
109 return (dgettext(TEXT_DOMAIN, "invalid device"));
110 case EZFS_NOREPLICAS:
111 return (dgettext(TEXT_DOMAIN, "no valid replicas"));
112 case EZFS_RESILVERING:
113 return (dgettext(TEXT_DOMAIN, "currently resilvering"));
114 case EZFS_BADVERSION:
115 return (dgettext(TEXT_DOMAIN, "unsupported version"));
116 case EZFS_POOLUNAVAIL:
117 return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
118 case EZFS_DEVOVERFLOW:
119 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
121 return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
122 case EZFS_CROSSTARGET:
123 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
126 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
127 case EZFS_MOUNTFAILED:
128 return (dgettext(TEXT_DOMAIN, "mount failed"));
129 case EZFS_UMOUNTFAILED:
130 return (dgettext(TEXT_DOMAIN, "umount failed"));
131 case EZFS_UNSHARENFSFAILED:
132 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
133 case EZFS_SHARENFSFAILED:
134 return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
135 case EZFS_UNSHARESMBFAILED:
136 return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
137 case EZFS_SHARESMBFAILED:
138 return (dgettext(TEXT_DOMAIN, "smb add share failed"));
140 return (dgettext(TEXT_DOMAIN, "permission denied"));
142 return (dgettext(TEXT_DOMAIN, "out of space"));
144 return (dgettext(TEXT_DOMAIN, "bad address"));
146 return (dgettext(TEXT_DOMAIN, "I/O error"));
148 return (dgettext(TEXT_DOMAIN, "signal received"));
150 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
152 case EZFS_INVALCONFIG:
153 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
155 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
157 return (dgettext(TEXT_DOMAIN, "no history available"));
159 return (dgettext(TEXT_DOMAIN, "failed to retrieve "
161 case EZFS_POOL_NOTSUP:
162 return (dgettext(TEXT_DOMAIN, "operation not supported "
163 "on this type of pool"));
164 case EZFS_POOL_INVALARG:
165 return (dgettext(TEXT_DOMAIN, "invalid argument for "
166 "this pool operation"));
167 case EZFS_NAMETOOLONG:
168 return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
169 case EZFS_OPENFAILED:
170 return (dgettext(TEXT_DOMAIN, "open failed"));
172 return (dgettext(TEXT_DOMAIN,
173 "disk capacity information could not be retrieved"));
174 case EZFS_LABELFAILED:
175 return (dgettext(TEXT_DOMAIN, "write of label failed"));
177 return (dgettext(TEXT_DOMAIN, "invalid user/group"));
179 return (dgettext(TEXT_DOMAIN, "invalid permission"));
180 case EZFS_BADPERMSET:
181 return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
182 case EZFS_NODELEGATION:
183 return (dgettext(TEXT_DOMAIN, "delegated administration is "
184 "disabled on pool"));
186 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
188 return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
189 case EZFS_VDEVNOTSUP:
190 return (dgettext(TEXT_DOMAIN, "vdev specification is not "
193 return (dgettext(TEXT_DOMAIN, "operation not supported "
195 case EZFS_ACTIVE_SPARE:
196 return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
198 case EZFS_UNPLAYED_LOGS:
199 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
201 case EZFS_REFTAG_RELE:
202 return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
203 case EZFS_REFTAG_HOLD:
204 return (dgettext(TEXT_DOMAIN, "tag already exists on this "
206 case EZFS_TAGTOOLONG:
207 return (dgettext(TEXT_DOMAIN, "tag too long"));
208 case EZFS_PIPEFAILED:
209 return (dgettext(TEXT_DOMAIN, "pipe create failed"));
210 case EZFS_THREADCREATEFAILED:
211 return (dgettext(TEXT_DOMAIN, "thread create failed"));
212 case EZFS_POSTSPLIT_ONLINE:
213 return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
216 return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
217 "use 'zpool scrub -s' to cancel current scrub"));
219 return (dgettext(TEXT_DOMAIN, "there is no active scrub"));
221 return (dgettext(TEXT_DOMAIN, "unable to generate diffs"));
223 return (dgettext(TEXT_DOMAIN, "invalid diff data"));
224 case EZFS_POOLREADONLY:
225 return (dgettext(TEXT_DOMAIN, "pool is read-only"));
227 return (dgettext(TEXT_DOMAIN, "unknown error"));
229 assert(hdl->libzfs_error == 0);
230 return (dgettext(TEXT_DOMAIN, "no error"));
236 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
242 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
244 hdl->libzfs_desc_active = 1;
250 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
252 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
254 hdl->libzfs_error = error;
256 if (hdl->libzfs_desc_active)
257 hdl->libzfs_desc_active = 0;
259 hdl->libzfs_desc[0] = '\0';
261 if (hdl->libzfs_printerr) {
262 if (error == EZFS_UNKNOWN) {
263 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
264 "error: %s\n"), libzfs_error_description(hdl));
268 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
269 libzfs_error_description(hdl));
270 if (error == EZFS_NOMEM)
276 zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
278 return (zfs_error_fmt(hdl, error, "%s", msg));
283 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
289 zfs_verror(hdl, error, fmt, ap);
297 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
303 zfs_verror(hdl, EZFS_PERM, fmt, ap);
307 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
311 zfs_verror(hdl, EZFS_IO, fmt, ap);
315 zfs_verror(hdl, EZFS_FAULT, fmt, ap);
319 zfs_verror(hdl, EZFS_INTR, fmt, ap);
327 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
329 return (zfs_standard_error_fmt(hdl, error, "%s", msg));
334 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
340 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
348 zfs_verror(hdl, EZFS_IO, fmt, ap);
352 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
353 "dataset does not exist"));
354 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
359 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
363 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
364 "dataset already exists"));
365 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
369 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
371 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
374 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
377 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
380 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap);
383 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
384 "pool I/O is currently suspended"));
385 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
388 zfs_error_aux(hdl, strerror(error));
389 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
398 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
400 return (zpool_standard_error_fmt(hdl, error, "%s", msg));
405 zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
411 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
418 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
423 dgettext(TEXT_DOMAIN, "no such pool or dataset"));
424 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
428 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
429 "pool already exists"));
430 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
434 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
435 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
439 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
440 "one or more devices is currently unavailable"));
441 zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
445 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
449 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
453 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
458 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
462 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
463 "pool I/O is currently suspended"));
464 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
468 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
472 zfs_error_aux(hdl, strerror(error));
473 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
481 * Display an out of memory error message and abort the current program.
484 no_memory(libzfs_handle_t *hdl)
486 return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
490 * A safe form of malloc() which will die if the allocation fails.
493 zfs_alloc(libzfs_handle_t *hdl, size_t size)
497 if ((data = calloc(1, size)) == NULL)
498 (void) no_memory(hdl);
504 * A safe form of asprintf() which will die if the allocation fails.
508 zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...)
516 err = vasprintf(&ret, fmt, ap);
521 (void) no_memory(hdl);
527 * A safe form of realloc(), which also zeroes newly allocated space.
530 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
534 if ((ret = realloc(ptr, newsize)) == NULL) {
535 (void) no_memory(hdl);
539 bzero((char *)ret + oldsize, (newsize - oldsize));
544 * A safe form of strdup() which will die if the allocation fails.
547 zfs_strdup(libzfs_handle_t *hdl, const char *str)
551 if ((ret = strdup(str)) == NULL)
552 (void) no_memory(hdl);
558 * Convert a number to an appropriately human-readable output.
561 zfs_nicenum(uint64_t num, char *buf, size_t buflen)
572 u = " KMGTPE"[index];
575 (void) snprintf(buf, buflen, "%llu", (u_longlong_t) n);
576 } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
578 * If this is an even multiple of the base, always display
579 * without any decimal precision.
581 (void) snprintf(buf, buflen, "%llu%c", (u_longlong_t) n, u);
584 * We want to choose a precision that reflects the best choice
585 * for fitting in 5 characters. This can get rather tricky when
586 * we have numbers that are very close to an order of magnitude.
587 * For example, when displaying 10239 (which is really 9.999K),
588 * we want only a single place of precision for 10.0K. We could
589 * develop some complex heuristics for this, but it's much
590 * easier just to try each combination in turn.
593 for (i = 2; i >= 0; i--) {
594 if (snprintf(buf, buflen, "%.*f%c", i,
595 (double)num / (1ULL << 10 * index), u) <= 5)
602 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
604 hdl->libzfs_printerr = printerr;
610 libzfs_handle_t *hdl;
612 if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
616 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
621 #ifdef HAVE_SETMNTENT
622 if ((hdl->libzfs_mnttab = setmntent(MNTTAB, "r")) == NULL) {
624 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
626 (void) close(hdl->libzfs_fd);
631 hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
635 libzfs_mnttab_init(hdl);
641 libzfs_fini(libzfs_handle_t *hdl)
643 (void) close(hdl->libzfs_fd);
644 if (hdl->libzfs_mnttab)
645 #ifdef HAVE_SETMNTENT
646 (void) endmntent(hdl->libzfs_mnttab);
648 (void) fclose(hdl->libzfs_mnttab);
650 if (hdl->libzfs_sharetab)
651 (void) fclose(hdl->libzfs_sharetab);
653 zfs_uninit_libshare(hdl);
655 if (hdl->libzfs_log_str)
656 (void) free(hdl->libzfs_log_str);
657 zpool_free_handles(hdl);
658 libzfs_fru_clear(hdl, B_TRUE);
659 namespace_clear(hdl);
660 libzfs_mnttab_fini(hdl);
665 zpool_get_handle(zpool_handle_t *zhp)
667 return (zhp->zpool_hdl);
671 zfs_get_handle(zfs_handle_t *zhp)
673 return (zhp->zfs_hdl);
677 zfs_get_pool_handle(const zfs_handle_t *zhp)
679 return (zhp->zpool_hdl);
683 * Given a name, determine whether or not it's a valid path
684 * (starts with '/' or "./"). If so, walk the mnttab trying
685 * to match the device number. If not, treat the path as an
689 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
691 struct stat64 statbuf;
692 struct extmnttab entry;
695 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
697 * It's not a valid path, assume it's a name of type 'argtype'.
699 return (zfs_open(hdl, path, argtype));
702 if (stat64(path, &statbuf) != 0) {
703 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
707 rewind(hdl->libzfs_mnttab);
708 while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
709 if (makedevice(entry.mnt_major, entry.mnt_minor) ==
718 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
719 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
724 return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
728 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
732 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
736 zc->zc_nvlist_dst_size = len;
737 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
738 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
745 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
746 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
747 * filled in by the kernel to indicate the actual required size.
750 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
752 free((void *)(uintptr_t)zc->zc_nvlist_dst);
753 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
754 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
761 * Called to free the src and dst nvlists stored in the command structure.
764 zcmd_free_nvlists(zfs_cmd_t *zc)
766 free((void *)(uintptr_t)zc->zc_nvlist_conf);
767 free((void *)(uintptr_t)zc->zc_nvlist_src);
768 free((void *)(uintptr_t)zc->zc_nvlist_dst);
772 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
778 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
780 if ((packed = zfs_alloc(hdl, len)) == NULL)
783 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
785 *outnv = (uint64_t)(uintptr_t)packed;
792 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
794 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
795 &zc->zc_nvlist_conf_size, nvl));
799 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
801 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
802 &zc->zc_nvlist_src_size, nvl));
806 * Unpacks an nvlist from the ZFS ioctl command structure.
809 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
811 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
812 zc->zc_nvlist_dst_size, nvlp, 0) != 0)
813 return (no_memory(hdl));
819 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
823 zc->zc_history = (uint64_t)(uintptr_t)hdl->libzfs_log_str;
824 error = ioctl(hdl->libzfs_fd, request, zc);
825 if (hdl->libzfs_log_str) {
826 free(hdl->libzfs_log_str);
827 hdl->libzfs_log_str = NULL;
835 * ================================================================
836 * API shared by zfs and zpool property management
837 * ================================================================
841 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
843 zprop_list_t *pl = cbp->cb_proplist;
848 cbp->cb_first = B_FALSE;
849 if (cbp->cb_scripted)
853 * Start with the length of the column headers.
855 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
856 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
858 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
860 cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
862 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
865 /* first property is always NAME */
866 assert(cbp->cb_proplist->pl_prop ==
867 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME));
870 * Go through and calculate the widths for each column. For the
871 * 'source' column, we kludge it up by taking the worst-case scenario of
872 * inheriting from the longest name. This is acceptable because in the
873 * majority of cases 'SOURCE' is the last column displayed, and we don't
874 * use the width anyway. Note that the 'VALUE' column can be oversized,
875 * if the name of the property is much longer than any values we find.
877 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
881 if (pl->pl_prop != ZPROP_INVAL) {
882 const char *propname = (type == ZFS_TYPE_POOL) ?
883 zpool_prop_to_name(pl->pl_prop) :
884 zfs_prop_to_name(pl->pl_prop);
886 len = strlen(propname);
887 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
888 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
890 len = strlen(pl->pl_user_prop);
891 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
892 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
896 * 'VALUE' column. The first property is always the 'name'
897 * property that was tacked on either by /sbin/zfs's
898 * zfs_do_get() or when calling zprop_expand_list(), so we
899 * ignore its width. If the user specified the name property
900 * to display, then it will be later in the list in any case.
902 if (pl != cbp->cb_proplist &&
903 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
904 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
906 /* 'RECEIVED' column. */
907 if (pl != cbp->cb_proplist &&
908 pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
909 cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
912 * 'NAME' and 'SOURCE' columns
914 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
916 pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
917 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
918 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
919 strlen(dgettext(TEXT_DOMAIN, "inherited from"));
924 * Now go through and print the headers.
926 for (i = 0; i < ZFS_GET_NCOLS; i++) {
927 switch (cbp->cb_columns[i]) {
929 title = dgettext(TEXT_DOMAIN, "NAME");
931 case GET_COL_PROPERTY:
932 title = dgettext(TEXT_DOMAIN, "PROPERTY");
935 title = dgettext(TEXT_DOMAIN, "VALUE");
938 title = dgettext(TEXT_DOMAIN, "RECEIVED");
941 title = dgettext(TEXT_DOMAIN, "SOURCE");
948 if (i == (ZFS_GET_NCOLS - 1) ||
949 cbp->cb_columns[i + 1] == GET_COL_NONE)
950 (void) printf("%s", title);
952 (void) printf("%-*s ",
953 cbp->cb_colwidths[cbp->cb_columns[i]],
961 * Display a single line of output, according to the settings in the callback
965 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
966 const char *propname, const char *value, zprop_source_t sourcetype,
967 const char *source, const char *recvd_value)
970 const char *str = NULL;
974 * Ignore those source types that the user has chosen to ignore.
976 if ((sourcetype & cbp->cb_sources) == 0)
980 zprop_print_headers(cbp, cbp->cb_type);
982 for (i = 0; i < ZFS_GET_NCOLS; i++) {
983 switch (cbp->cb_columns[i]) {
988 case GET_COL_PROPERTY:
997 switch (sourcetype) {
1002 case ZPROP_SRC_DEFAULT:
1006 case ZPROP_SRC_LOCAL:
1010 case ZPROP_SRC_TEMPORARY:
1014 case ZPROP_SRC_INHERITED:
1015 (void) snprintf(buf, sizeof (buf),
1016 "inherited from %s", source);
1019 case ZPROP_SRC_RECEIVED:
1026 str = (recvd_value == NULL ? "-" : recvd_value);
1033 if (cbp->cb_columns[i + 1] == GET_COL_NONE)
1034 (void) printf("%s", str);
1035 else if (cbp->cb_scripted)
1036 (void) printf("%s\t", str);
1038 (void) printf("%-*s ",
1039 cbp->cb_colwidths[cbp->cb_columns[i]],
1043 (void) printf("\n");
1047 * Given a numeric suffix, convert the value into a number of bits that the
1048 * resulting value must be shifted.
1051 str2shift(libzfs_handle_t *hdl, const char *buf)
1053 const char *ends = "BKMGTPEZ";
1058 for (i = 0; i < strlen(ends); i++) {
1059 if (toupper(buf[0]) == ends[i])
1062 if (i == strlen(ends)) {
1063 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1064 "invalid numeric suffix '%s'"), buf);
1069 * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't
1070 * allow 'BB' - that's just weird.
1072 if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' &&
1073 toupper(buf[0]) != 'B'))
1076 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1077 "invalid numeric suffix '%s'"), buf);
1082 * Convert a string of the form '100G' into a real number. Used when setting
1083 * properties or creating a volume. 'buf' is used to place an extended error
1084 * message for the caller to use.
1087 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1094 /* Check to see if this looks like a number. */
1095 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1097 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1098 "bad numeric value '%s'"), value);
1102 /* Rely on strtoull() to process the numeric portion. */
1104 *num = strtoull(value, &end, 10);
1107 * Check for ERANGE, which indicates that the value is too large to fit
1108 * in a 64-bit value.
1110 if (errno == ERANGE) {
1112 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1113 "numeric value is too large"));
1118 * If we have a decimal value, then do the computation with floating
1119 * point arithmetic. Otherwise, use standard arithmetic.
1122 double fval = strtod(value, &end);
1124 if ((shift = str2shift(hdl, end)) == -1)
1127 fval *= pow(2, shift);
1129 if (fval > UINT64_MAX) {
1131 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1132 "numeric value is too large"));
1136 *num = (uint64_t)fval;
1138 if ((shift = str2shift(hdl, end)) == -1)
1141 /* Check for overflow */
1142 if (shift >= 64 || (*num << shift) >> shift != *num) {
1144 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1145 "numeric value is too large"));
1156 * Given a propname=value nvpair to set, parse any numeric properties
1157 * (index, boolean, etc) if they are specified as strings and add the
1158 * resulting nvpair to the returned nvlist.
1160 * At the DSL layer, all properties are either 64-bit numbers or strings.
1161 * We want the user to be able to ignore this fact and specify properties
1162 * as native values (numbers, for example) or as strings (to simplify
1163 * command line utilities). This also handles converting index types
1164 * (compression, checksum, etc) from strings to their on-disk index.
1167 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1168 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1171 data_type_t datatype = nvpair_type(elem);
1172 zprop_type_t proptype;
1173 const char *propname;
1175 boolean_t isnone = B_FALSE;
1177 if (type == ZFS_TYPE_POOL) {
1178 proptype = zpool_prop_get_type(prop);
1179 propname = zpool_prop_to_name(prop);
1181 proptype = zfs_prop_get_type(prop);
1182 propname = zfs_prop_to_name(prop);
1186 * Convert any properties to the internal DSL value types.
1192 case PROP_TYPE_STRING:
1193 if (datatype != DATA_TYPE_STRING) {
1194 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1195 "'%s' must be a string"), nvpair_name(elem));
1198 (void) nvpair_value_string(elem, svalp);
1199 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1200 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1201 "'%s' is too long"), nvpair_name(elem));
1206 case PROP_TYPE_NUMBER:
1207 if (datatype == DATA_TYPE_STRING) {
1208 (void) nvpair_value_string(elem, &value);
1209 if (strcmp(value, "none") == 0) {
1211 } else if (zfs_nicestrtonum(hdl, value, ivalp)
1215 } else if (datatype == DATA_TYPE_UINT64) {
1216 (void) nvpair_value_uint64(elem, ivalp);
1218 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1219 "'%s' must be a number"), nvpair_name(elem));
1224 * Quota special: force 'none' and don't allow 0.
1226 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1227 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1228 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1229 "use 'none' to disable quota/refquota"));
1234 case PROP_TYPE_INDEX:
1235 if (datatype != DATA_TYPE_STRING) {
1236 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1237 "'%s' must be a string"), nvpair_name(elem));
1241 (void) nvpair_value_string(elem, &value);
1243 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1244 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1245 "'%s' must be one of '%s'"), propname,
1246 zprop_values(prop, type));
1256 * Add the result to our return set of properties.
1258 if (*svalp != NULL) {
1259 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1260 (void) no_memory(hdl);
1264 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1265 (void) no_memory(hdl);
1272 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1277 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1281 zprop_list_t *entry;
1283 prop = zprop_name_to_prop(propname, type);
1285 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1289 * When no property table entry can be found, return failure if
1290 * this is a pool property or if this isn't a user-defined
1293 if (prop == ZPROP_INVAL && (type == ZFS_TYPE_POOL ||
1294 (!zfs_prop_user(propname) && !zfs_prop_userquota(propname)))) {
1295 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1296 "invalid property '%s'"), propname);
1297 return (zfs_error(hdl, EZFS_BADPROP,
1298 dgettext(TEXT_DOMAIN, "bad property list")));
1301 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1304 entry->pl_prop = prop;
1305 if (prop == ZPROP_INVAL) {
1306 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) == NULL) {
1310 entry->pl_width = strlen(propname);
1312 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1322 * Given a comma-separated list of properties, construct a property list
1323 * containing both user-defined and native properties. This function will
1324 * return a NULL list if 'all' is specified, which can later be expanded
1325 * by zprop_expand_list().
1328 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1334 * If 'all' is specified, return a NULL list.
1336 if (strcmp(props, "all") == 0)
1340 * If no props were specified, return an error.
1342 if (props[0] == '\0') {
1343 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1344 "no properties specified"));
1345 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1346 "bad property list")));
1350 * It would be nice to use getsubopt() here, but the inclusion of column
1351 * aliases makes this more effort than it's worth.
1353 while (*props != '\0') {
1358 if ((p = strchr(props, ',')) == NULL) {
1359 len = strlen(props);
1366 * Check for empty options.
1369 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1370 "empty property name"));
1371 return (zfs_error(hdl, EZFS_BADPROP,
1372 dgettext(TEXT_DOMAIN, "bad property list")));
1376 * Check all regular property names.
1381 if (strcmp(props, "space") == 0) {
1382 static char *spaceprops[] = {
1383 "name", "avail", "used", "usedbysnapshots",
1384 "usedbydataset", "usedbyrefreservation",
1385 "usedbychildren", NULL
1389 for (i = 0; spaceprops[i]; i++) {
1390 if (addlist(hdl, spaceprops[i], listp, type))
1392 listp = &(*listp)->pl_next;
1395 if (addlist(hdl, props, listp, type))
1397 listp = &(*listp)->pl_next;
1409 zprop_free_list(zprop_list_t *pl)
1413 while (pl != NULL) {
1415 free(pl->pl_user_prop);
1421 typedef struct expand_data {
1422 zprop_list_t **last;
1423 libzfs_handle_t *hdl;
1428 zprop_expand_list_cb(int prop, void *cb)
1430 zprop_list_t *entry;
1431 expand_data_t *edp = cb;
1433 if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1434 return (ZPROP_INVAL);
1436 entry->pl_prop = prop;
1437 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1438 entry->pl_all = B_TRUE;
1440 *(edp->last) = entry;
1441 edp->last = &entry->pl_next;
1443 return (ZPROP_CONT);
1447 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1449 zprop_list_t *entry;
1450 zprop_list_t **last;
1455 * If this is the very first time we've been called for an 'all'
1456 * specification, expand the list to include all native
1465 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1466 B_FALSE, type) == ZPROP_INVAL)
1470 * Add 'name' to the beginning of the list, which is handled
1473 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1476 entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME :
1478 entry->pl_width = zprop_width(entry->pl_prop,
1479 &entry->pl_fixed, type);
1480 entry->pl_all = B_TRUE;
1481 entry->pl_next = *plp;
1488 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1491 return (zprop_iter_common(func, cb, show_all, ordered, type));