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 2009 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
27 * 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 "
98 return (dgettext(TEXT_DOMAIN, "volume has data"));
99 case EZFS_INVALIDNAME:
100 return (dgettext(TEXT_DOMAIN, "invalid name"));
101 case EZFS_BADRESTORE:
102 return (dgettext(TEXT_DOMAIN, "unable to restore to "
105 return (dgettext(TEXT_DOMAIN, "backup failed"));
107 return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
109 return (dgettext(TEXT_DOMAIN, "no such device in pool"));
111 return (dgettext(TEXT_DOMAIN, "invalid device"));
112 case EZFS_NOREPLICAS:
113 return (dgettext(TEXT_DOMAIN, "no valid replicas"));
114 case EZFS_RESILVERING:
115 return (dgettext(TEXT_DOMAIN, "currently resilvering"));
116 case EZFS_BADVERSION:
117 return (dgettext(TEXT_DOMAIN, "unsupported version"));
118 case EZFS_POOLUNAVAIL:
119 return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
120 case EZFS_DEVOVERFLOW:
121 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
123 return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
124 case EZFS_CROSSTARGET:
125 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
128 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
129 case EZFS_MOUNTFAILED:
130 return (dgettext(TEXT_DOMAIN, "mount failed"));
131 case EZFS_UMOUNTFAILED:
132 return (dgettext(TEXT_DOMAIN, "umount failed"));
133 case EZFS_UNSHARENFSFAILED:
134 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
135 case EZFS_SHARENFSFAILED:
136 return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
137 case EZFS_UNSHARESMBFAILED:
138 return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
139 case EZFS_SHARESMBFAILED:
140 return (dgettext(TEXT_DOMAIN, "smb add share failed"));
141 case EZFS_ISCSISVCUNAVAIL:
142 return (dgettext(TEXT_DOMAIN,
143 "iscsitgt service need to be enabled by "
144 "a privileged user"));
146 return (dgettext(TEXT_DOMAIN, "failed to create /dev links"));
148 return (dgettext(TEXT_DOMAIN, "permission denied"));
150 return (dgettext(TEXT_DOMAIN, "out of space"));
152 return (dgettext(TEXT_DOMAIN, "I/O error"));
154 return (dgettext(TEXT_DOMAIN, "signal received"));
156 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
158 case EZFS_INVALCONFIG:
159 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
161 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
163 return (dgettext(TEXT_DOMAIN, "no history available"));
164 case EZFS_UNSHAREISCSIFAILED:
165 return (dgettext(TEXT_DOMAIN,
166 "iscsitgtd failed request to unshare"));
167 case EZFS_SHAREISCSIFAILED:
168 return (dgettext(TEXT_DOMAIN,
169 "iscsitgtd failed request to share"));
171 return (dgettext(TEXT_DOMAIN, "failed to retrieve "
173 case EZFS_POOL_NOTSUP:
174 return (dgettext(TEXT_DOMAIN, "operation not supported "
175 "on this type of pool"));
176 case EZFS_POOL_INVALARG:
177 return (dgettext(TEXT_DOMAIN, "invalid argument for "
178 "this pool operation"));
179 case EZFS_NAMETOOLONG:
180 return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
181 case EZFS_OPENFAILED:
182 return (dgettext(TEXT_DOMAIN, "open failed"));
184 return (dgettext(TEXT_DOMAIN,
185 "disk capacity information could not be retrieved"));
186 case EZFS_LABELFAILED:
187 return (dgettext(TEXT_DOMAIN, "write of label failed"));
189 return (dgettext(TEXT_DOMAIN, "invalid user/group"));
191 return (dgettext(TEXT_DOMAIN, "invalid permission"));
192 case EZFS_BADPERMSET:
193 return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
194 case EZFS_NODELEGATION:
195 return (dgettext(TEXT_DOMAIN, "delegated administration is "
196 "disabled on pool"));
197 case EZFS_PERMRDONLY:
198 return (dgettext(TEXT_DOMAIN, "snapshot permissions cannot be"
201 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
203 return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
204 case EZFS_VDEVNOTSUP:
205 return (dgettext(TEXT_DOMAIN, "vdev specification is not "
208 return (dgettext(TEXT_DOMAIN, "operation not supported "
210 case EZFS_ACTIVE_SPARE:
211 return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
213 case EZFS_UNPLAYED_LOGS:
214 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
217 return (dgettext(TEXT_DOMAIN, "unknown error"));
219 assert(hdl->libzfs_error == 0);
220 return (dgettext(TEXT_DOMAIN, "no error"));
226 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
232 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
234 hdl->libzfs_desc_active = 1;
240 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
242 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
244 hdl->libzfs_error = error;
246 if (hdl->libzfs_desc_active)
247 hdl->libzfs_desc_active = 0;
249 hdl->libzfs_desc[0] = '\0';
251 if (hdl->libzfs_printerr) {
252 if (error == EZFS_UNKNOWN) {
253 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
254 "error: %s\n"), libzfs_error_description(hdl));
258 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
259 libzfs_error_description(hdl));
260 if (error == EZFS_NOMEM)
266 zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
268 return (zfs_error_fmt(hdl, error, "%s", msg));
273 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
279 zfs_verror(hdl, error, fmt, ap);
287 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
293 zfs_verror(hdl, EZFS_PERM, fmt, ap);
297 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
301 zfs_verror(hdl, EZFS_IO, fmt, ap);
305 zfs_verror(hdl, EZFS_INTR, fmt, ap);
313 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
315 return (zfs_standard_error_fmt(hdl, error, "%s", msg));
320 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
326 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
334 zfs_verror(hdl, EZFS_IO, fmt, ap);
338 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
339 "dataset does not exist"));
340 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
345 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
349 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
350 "dataset already exists"));
351 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
355 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
357 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
360 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
361 "snapshot permissions cannot be modified"));
362 zfs_verror(hdl, EZFS_PERMRDONLY, fmt, ap);
365 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
368 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap);
371 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
372 "pool I/O is currently suspended"));
373 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
376 zfs_error_aux(hdl, strerror(errno));
377 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
386 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
388 return (zpool_standard_error_fmt(hdl, error, "%s", msg));
393 zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
399 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
406 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
411 dgettext(TEXT_DOMAIN, "no such pool or dataset"));
412 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
416 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
417 "pool already exists"));
418 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
422 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
423 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
427 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
428 "one or more devices is currently unavailable"));
429 zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
433 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
437 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
441 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
446 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
449 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
450 "pool I/O is currently suspended"));
451 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
455 zfs_error_aux(hdl, strerror(error));
456 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
464 * Display an out of memory error message and abort the current program.
467 no_memory(libzfs_handle_t *hdl)
469 return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
473 * A safe form of malloc() which will die if the allocation fails.
476 zfs_alloc(libzfs_handle_t *hdl, size_t size)
480 if ((data = calloc(1, size)) == NULL)
481 (void) no_memory(hdl);
487 * A safe form of realloc(), which also zeroes newly allocated space.
490 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
494 if ((ret = realloc(ptr, newsize)) == NULL) {
495 (void) no_memory(hdl);
499 bzero((char *)ret + oldsize, (newsize - oldsize));
504 * A safe form of strdup() which will die if the allocation fails.
507 zfs_strdup(libzfs_handle_t *hdl, const char *str)
511 if ((ret = strdup(str)) == NULL)
512 (void) no_memory(hdl);
518 * Convert a number to an appropriately human-readable output.
521 zfs_nicenum(uint64_t num, char *buf, size_t buflen)
532 u = " KMGTPE"[index];
535 (void) snprintf(buf, buflen, "%llu", n);
536 } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
538 * If this is an even multiple of the base, always display
539 * without any decimal precision.
541 (void) snprintf(buf, buflen, "%llu%c", n, u);
544 * We want to choose a precision that reflects the best choice
545 * for fitting in 5 characters. This can get rather tricky when
546 * we have numbers that are very close to an order of magnitude.
547 * For example, when displaying 10239 (which is really 9.999K),
548 * we want only a single place of precision for 10.0K. We could
549 * develop some complex heuristics for this, but it's much
550 * easier just to try each combination in turn.
553 for (i = 2; i >= 0; i--) {
554 if (snprintf(buf, buflen, "%.*f%c", i,
555 (double)num / (1ULL << 10 * index), u) <= 5)
562 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
564 hdl->libzfs_printerr = printerr;
572 if (modfind("zfs") < 0) {
573 /* Not present in kernel, try loading it. */
574 if (kldload("zfs") < 0 || modfind("zfs") < 0) {
585 libzfs_handle_t *hdl;
587 if ((hdl = calloc(sizeof (libzfs_handle_t), 1)) == NULL) {
591 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
592 if (libzfs_load() == 0)
593 hdl->libzfs_fd = open(ZFS_DEV, O_RDWR);
594 if (hdl->libzfs_fd < 0) {
600 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
601 (void) close(hdl->libzfs_fd);
606 hdl->libzfs_sharetab = fopen(ZFS_EXPORTS_PATH, "r");
610 libzfs_mnttab_init(hdl);
616 libzfs_fini(libzfs_handle_t *hdl)
618 (void) close(hdl->libzfs_fd);
619 if (hdl->libzfs_mnttab)
620 (void) fclose(hdl->libzfs_mnttab);
621 if (hdl->libzfs_sharetab)
622 (void) fclose(hdl->libzfs_sharetab);
623 zfs_uninit_libshare(hdl);
624 if (hdl->libzfs_log_str)
625 (void) free(hdl->libzfs_log_str);
626 zpool_free_handles(hdl);
627 namespace_clear(hdl);
628 libzfs_mnttab_fini(hdl);
633 zpool_get_handle(zpool_handle_t *zhp)
635 return (zhp->zpool_hdl);
639 zfs_get_handle(zfs_handle_t *zhp)
641 return (zhp->zfs_hdl);
645 zfs_get_pool_handle(const zfs_handle_t *zhp)
647 return (zhp->zpool_hdl);
651 * Given a name, determine whether or not it's a valid path
652 * (starts with '/' or "./"). If so, walk the mnttab trying
653 * to match the device number. If not, treat the path as an
657 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
659 struct statfs statbuf;
661 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
663 * It's not a valid path, assume it's a name of type 'argtype'.
665 return (zfs_open(hdl, path, argtype));
668 if (statfs(path, &statbuf) != 0) {
669 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
673 if (strcmp(statbuf.f_fstypename, MNTTYPE_ZFS) != 0) {
674 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
679 return (zfs_open(hdl, statbuf.f_mntfromname, ZFS_TYPE_FILESYSTEM));
683 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
687 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
691 zc->zc_nvlist_dst_size = len;
692 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
693 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
700 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
701 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
702 * filled in by the kernel to indicate the actual required size.
705 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
707 free((void *)(uintptr_t)zc->zc_nvlist_dst);
708 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
709 zfs_alloc(hdl, zc->zc_nvlist_dst_size))
717 * Called to free the src and dst nvlists stored in the command structure.
720 zcmd_free_nvlists(zfs_cmd_t *zc)
722 free((void *)(uintptr_t)zc->zc_nvlist_conf);
723 free((void *)(uintptr_t)zc->zc_nvlist_src);
724 free((void *)(uintptr_t)zc->zc_nvlist_dst);
728 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
734 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
736 if ((packed = zfs_alloc(hdl, len)) == NULL)
739 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
741 *outnv = (uint64_t)(uintptr_t)packed;
748 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
750 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
751 &zc->zc_nvlist_conf_size, nvl));
755 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
757 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
758 &zc->zc_nvlist_src_size, nvl));
762 * Unpacks an nvlist from the ZFS ioctl command structure.
765 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
767 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
768 zc->zc_nvlist_dst_size, nvlp, 0) != 0)
769 return (no_memory(hdl));
775 zfs_ioctl(libzfs_handle_t *hdl, unsigned long request, zfs_cmd_t *zc)
779 zc->zc_history = (uint64_t)(uintptr_t)hdl->libzfs_log_str;
780 error = ioctl(hdl->libzfs_fd, request, zc);
781 if (hdl->libzfs_log_str) {
782 free(hdl->libzfs_log_str);
783 hdl->libzfs_log_str = NULL;
791 * ================================================================
792 * API shared by zfs and zpool property management
793 * ================================================================
797 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
799 zprop_list_t *pl = cbp->cb_proplist;
804 cbp->cb_first = B_FALSE;
805 if (cbp->cb_scripted)
809 * Start with the length of the column headers.
811 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
812 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
814 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
816 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
819 /* first property is always NAME */
820 assert(cbp->cb_proplist->pl_prop ==
821 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME));
824 * Go through and calculate the widths for each column. For the
825 * 'source' column, we kludge it up by taking the worst-case scenario of
826 * inheriting from the longest name. This is acceptable because in the
827 * majority of cases 'SOURCE' is the last column displayed, and we don't
828 * use the width anyway. Note that the 'VALUE' column can be oversized,
829 * if the name of the property is much longer the any values we find.
831 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
835 if (pl->pl_prop != ZPROP_INVAL) {
836 const char *propname = (type == ZFS_TYPE_POOL) ?
837 zpool_prop_to_name(pl->pl_prop) :
838 zfs_prop_to_name(pl->pl_prop);
840 len = strlen(propname);
841 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
842 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
844 len = strlen(pl->pl_user_prop);
845 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
846 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
850 * 'VALUE' column. The first property is always the 'name'
851 * property that was tacked on either by /sbin/zfs's
852 * zfs_do_get() or when calling zprop_expand_list(), so we
853 * ignore its width. If the user specified the name property
854 * to display, then it will be later in the list in any case.
856 if (pl != cbp->cb_proplist &&
857 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
858 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
861 * 'NAME' and 'SOURCE' columns
863 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
865 pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
866 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
867 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
868 strlen(dgettext(TEXT_DOMAIN, "inherited from"));
873 * Now go through and print the headers.
875 for (i = 0; i < 4; i++) {
876 switch (cbp->cb_columns[i]) {
878 title = dgettext(TEXT_DOMAIN, "NAME");
880 case GET_COL_PROPERTY:
881 title = dgettext(TEXT_DOMAIN, "PROPERTY");
884 title = dgettext(TEXT_DOMAIN, "VALUE");
887 title = dgettext(TEXT_DOMAIN, "SOURCE");
894 if (i == 3 || cbp->cb_columns[i + 1] == 0)
895 (void) printf("%s", title);
897 (void) printf("%-*s ",
898 cbp->cb_colwidths[cbp->cb_columns[i]],
906 * Display a single line of output, according to the settings in the callback
910 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
911 const char *propname, const char *value, zprop_source_t sourcetype,
919 * Ignore those source types that the user has chosen to ignore.
921 if ((sourcetype & cbp->cb_sources) == 0)
925 zprop_print_headers(cbp, cbp->cb_type);
927 for (i = 0; i < 4; i++) {
928 switch (cbp->cb_columns[i]) {
933 case GET_COL_PROPERTY:
942 switch (sourcetype) {
947 case ZPROP_SRC_DEFAULT:
951 case ZPROP_SRC_LOCAL:
955 case ZPROP_SRC_TEMPORARY:
959 case ZPROP_SRC_INHERITED:
960 (void) snprintf(buf, sizeof (buf),
961 "inherited from %s", source);
971 if (cbp->cb_columns[i + 1] == 0)
972 (void) printf("%s", str);
973 else if (cbp->cb_scripted)
974 (void) printf("%s\t", str);
976 (void) printf("%-*s ",
977 cbp->cb_colwidths[cbp->cb_columns[i]],
986 * Given a numeric suffix, convert the value into a number of bits that the
987 * resulting value must be shifted.
990 str2shift(libzfs_handle_t *hdl, const char *buf)
992 const char *ends = "BKMGTPEZ";
997 for (i = 0; i < strlen(ends); i++) {
998 if (toupper(buf[0]) == ends[i])
1001 if (i == strlen(ends)) {
1002 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1003 "invalid numeric suffix '%s'"), buf);
1008 * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't
1009 * allow 'BB' - that's just weird.
1011 if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' &&
1012 toupper(buf[0]) != 'B'))
1015 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1016 "invalid numeric suffix '%s'"), buf);
1021 * Convert a string of the form '100G' into a real number. Used when setting
1022 * properties or creating a volume. 'buf' is used to place an extended error
1023 * message for the caller to use.
1026 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1033 /* Check to see if this looks like a number. */
1034 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1036 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1037 "bad numeric value '%s'"), value);
1041 /* Rely on stroull() to process the numeric portion. */
1043 *num = strtoull(value, &end, 10);
1046 * Check for ERANGE, which indicates that the value is too large to fit
1047 * in a 64-bit value.
1049 if (errno == ERANGE) {
1051 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1052 "numeric value is too large"));
1057 * If we have a decimal value, then do the computation with floating
1058 * point arithmetic. Otherwise, use standard arithmetic.
1061 double fval = strtod(value, &end);
1063 if ((shift = str2shift(hdl, end)) == -1)
1066 fval *= pow(2, shift);
1068 if (fval > UINT64_MAX) {
1070 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1071 "numeric value is too large"));
1075 *num = (uint64_t)fval;
1077 if ((shift = str2shift(hdl, end)) == -1)
1080 /* Check for overflow */
1081 if (shift >= 64 || (*num << shift) >> shift != *num) {
1083 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1084 "numeric value is too large"));
1095 * Given a propname=value nvpair to set, parse any numeric properties
1096 * (index, boolean, etc) if they are specified as strings and add the
1097 * resulting nvpair to the returned nvlist.
1099 * At the DSL layer, all properties are either 64-bit numbers or strings.
1100 * We want the user to be able to ignore this fact and specify properties
1101 * as native values (numbers, for example) or as strings (to simplify
1102 * command line utilities). This also handles converting index types
1103 * (compression, checksum, etc) from strings to their on-disk index.
1106 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1107 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1110 data_type_t datatype = nvpair_type(elem);
1111 zprop_type_t proptype;
1112 const char *propname;
1114 boolean_t isnone = B_FALSE;
1116 if (type == ZFS_TYPE_POOL) {
1117 proptype = zpool_prop_get_type(prop);
1118 propname = zpool_prop_to_name(prop);
1120 proptype = zfs_prop_get_type(prop);
1121 propname = zfs_prop_to_name(prop);
1125 * Convert any properties to the internal DSL value types.
1131 case PROP_TYPE_STRING:
1132 if (datatype != DATA_TYPE_STRING) {
1133 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1134 "'%s' must be a string"), nvpair_name(elem));
1137 (void) nvpair_value_string(elem, svalp);
1138 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1139 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1140 "'%s' is too long"), nvpair_name(elem));
1145 case PROP_TYPE_NUMBER:
1146 if (datatype == DATA_TYPE_STRING) {
1147 (void) nvpair_value_string(elem, &value);
1148 if (strcmp(value, "none") == 0) {
1150 } else if (zfs_nicestrtonum(hdl, value, ivalp)
1154 } else if (datatype == DATA_TYPE_UINT64) {
1155 (void) nvpair_value_uint64(elem, ivalp);
1157 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1158 "'%s' must be a number"), nvpair_name(elem));
1163 * Quota special: force 'none' and don't allow 0.
1165 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1166 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1167 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1168 "use 'none' to disable quota/refquota"));
1173 case PROP_TYPE_INDEX:
1174 if (datatype != DATA_TYPE_STRING) {
1175 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1176 "'%s' must be a string"), nvpair_name(elem));
1180 (void) nvpair_value_string(elem, &value);
1182 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1183 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1184 "'%s' must be one of '%s'"), propname,
1185 zprop_values(prop, type));
1195 * Add the result to our return set of properties.
1197 if (*svalp != NULL) {
1198 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1199 (void) no_memory(hdl);
1203 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1204 (void) no_memory(hdl);
1211 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1216 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1220 zprop_list_t *entry;
1222 prop = zprop_name_to_prop(propname, type);
1224 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1228 * When no property table entry can be found, return failure if
1229 * this is a pool property or if this isn't a user-defined
1232 if (prop == ZPROP_INVAL && (type == ZFS_TYPE_POOL ||
1233 (!zfs_prop_user(propname) && !zfs_prop_userquota(propname)))) {
1234 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1235 "invalid property '%s'"), propname);
1236 return (zfs_error(hdl, EZFS_BADPROP,
1237 dgettext(TEXT_DOMAIN, "bad property list")));
1240 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1243 entry->pl_prop = prop;
1244 if (prop == ZPROP_INVAL) {
1245 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) == NULL) {
1249 entry->pl_width = strlen(propname);
1251 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1261 * Given a comma-separated list of properties, construct a property list
1262 * containing both user-defined and native properties. This function will
1263 * return a NULL list if 'all' is specified, which can later be expanded
1264 * by zprop_expand_list().
1267 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1273 * If 'all' is specified, return a NULL list.
1275 if (strcmp(props, "all") == 0)
1279 * If no props were specified, return an error.
1281 if (props[0] == '\0') {
1282 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1283 "no properties specified"));
1284 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1285 "bad property list")));
1289 * It would be nice to use getsubopt() here, but the inclusion of column
1290 * aliases makes this more effort than it's worth.
1292 while (*props != '\0') {
1297 if ((p = strchr(props, ',')) == NULL) {
1298 len = strlen(props);
1305 * Check for empty options.
1308 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1309 "empty property name"));
1310 return (zfs_error(hdl, EZFS_BADPROP,
1311 dgettext(TEXT_DOMAIN, "bad property list")));
1315 * Check all regular property names.
1320 if (strcmp(props, "space") == 0) {
1321 static char *spaceprops[] = {
1322 "name", "avail", "used", "usedbysnapshots",
1323 "usedbydataset", "usedbyrefreservation",
1324 "usedbychildren", NULL
1328 for (i = 0; spaceprops[i]; i++) {
1329 if (addlist(hdl, spaceprops[i], listp, type))
1331 listp = &(*listp)->pl_next;
1334 if (addlist(hdl, props, listp, type))
1336 listp = &(*listp)->pl_next;
1348 zprop_free_list(zprop_list_t *pl)
1352 while (pl != NULL) {
1354 free(pl->pl_user_prop);
1360 typedef struct expand_data {
1361 zprop_list_t **last;
1362 libzfs_handle_t *hdl;
1367 zprop_expand_list_cb(int prop, void *cb)
1369 zprop_list_t *entry;
1370 expand_data_t *edp = cb;
1372 if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1373 return (ZPROP_INVAL);
1375 entry->pl_prop = prop;
1376 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1377 entry->pl_all = B_TRUE;
1379 *(edp->last) = entry;
1380 edp->last = &entry->pl_next;
1382 return (ZPROP_CONT);
1386 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1388 zprop_list_t *entry;
1389 zprop_list_t **last;
1394 * If this is the very first time we've been called for an 'all'
1395 * specification, expand the list to include all native
1404 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1405 B_FALSE, type) == ZPROP_INVAL)
1409 * Add 'name' to the beginning of the list, which is handled
1412 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1415 entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME :
1417 entry->pl_width = zprop_width(entry->pl_prop,
1418 &entry->pl_fixed, type);
1419 entry->pl_all = B_TRUE;
1420 entry->pl_next = *plp;
1427 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1430 return (zprop_iter_common(func, cb, show_all, ordered, type));