4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
25 * Copyright (c) 2012 by Delphix. All rights reserved.
29 * Internal utility routines for the ZFS library.
32 #include <sys/param.h>
33 #include <sys/linker.h>
34 #include <sys/module.h>
47 #include <sys/mnttab.h>
48 #include <sys/mntent.h>
49 #include <sys/types.h>
52 #include <libzfs_core.h>
54 #include "libzfs_impl.h"
56 #include "zfeature_common.h"
61 libzfs_errno(libzfs_handle_t *hdl)
63 return (hdl->libzfs_error);
67 libzfs_error_action(libzfs_handle_t *hdl)
69 return (hdl->libzfs_action);
73 libzfs_error_description(libzfs_handle_t *hdl)
75 if (hdl->libzfs_desc[0] != '\0')
76 return (hdl->libzfs_desc);
78 switch (hdl->libzfs_error) {
80 return (dgettext(TEXT_DOMAIN, "out of memory"));
82 return (dgettext(TEXT_DOMAIN, "invalid property value"));
83 case EZFS_PROPREADONLY:
84 return (dgettext(TEXT_DOMAIN, "read-only property"));
86 return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
87 "datasets of this type"));
88 case EZFS_PROPNONINHERIT:
89 return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
91 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
93 return (dgettext(TEXT_DOMAIN, "operation not applicable to "
94 "datasets of this type"));
96 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
98 return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
100 return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
102 return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
103 case EZFS_DSREADONLY:
104 return (dgettext(TEXT_DOMAIN, "dataset is read-only"));
106 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
108 case EZFS_INVALIDNAME:
109 return (dgettext(TEXT_DOMAIN, "invalid name"));
110 case EZFS_BADRESTORE:
111 return (dgettext(TEXT_DOMAIN, "unable to restore to "
114 return (dgettext(TEXT_DOMAIN, "backup failed"));
116 return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
118 return (dgettext(TEXT_DOMAIN, "no such device in pool"));
120 return (dgettext(TEXT_DOMAIN, "invalid device"));
121 case EZFS_NOREPLICAS:
122 return (dgettext(TEXT_DOMAIN, "no valid replicas"));
123 case EZFS_RESILVERING:
124 return (dgettext(TEXT_DOMAIN, "currently resilvering"));
125 case EZFS_BADVERSION:
126 return (dgettext(TEXT_DOMAIN, "unsupported version or "
128 case EZFS_POOLUNAVAIL:
129 return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
130 case EZFS_DEVOVERFLOW:
131 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
133 return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
134 case EZFS_CROSSTARGET:
135 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
138 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
139 case EZFS_MOUNTFAILED:
140 return (dgettext(TEXT_DOMAIN, "mount failed"));
141 case EZFS_UMOUNTFAILED:
142 return (dgettext(TEXT_DOMAIN, "umount failed"));
143 case EZFS_UNSHARENFSFAILED:
144 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
145 case EZFS_SHARENFSFAILED:
146 return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
147 case EZFS_UNSHARESMBFAILED:
148 return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
149 case EZFS_SHARESMBFAILED:
150 return (dgettext(TEXT_DOMAIN, "smb add share failed"));
152 return (dgettext(TEXT_DOMAIN, "permission denied"));
154 return (dgettext(TEXT_DOMAIN, "out of space"));
156 return (dgettext(TEXT_DOMAIN, "bad address"));
158 return (dgettext(TEXT_DOMAIN, "I/O error"));
160 return (dgettext(TEXT_DOMAIN, "signal received"));
162 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
164 case EZFS_INVALCONFIG:
165 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
167 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
169 return (dgettext(TEXT_DOMAIN, "no history available"));
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"));
198 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
200 return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
201 case EZFS_VDEVNOTSUP:
202 return (dgettext(TEXT_DOMAIN, "vdev specification is not "
205 return (dgettext(TEXT_DOMAIN, "operation not supported "
207 case EZFS_ACTIVE_SPARE:
208 return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
210 case EZFS_UNPLAYED_LOGS:
211 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
213 case EZFS_REFTAG_RELE:
214 return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
215 case EZFS_REFTAG_HOLD:
216 return (dgettext(TEXT_DOMAIN, "tag already exists on this "
218 case EZFS_TAGTOOLONG:
219 return (dgettext(TEXT_DOMAIN, "tag too long"));
220 case EZFS_PIPEFAILED:
221 return (dgettext(TEXT_DOMAIN, "pipe create failed"));
222 case EZFS_THREADCREATEFAILED:
223 return (dgettext(TEXT_DOMAIN, "thread create failed"));
224 case EZFS_POSTSPLIT_ONLINE:
225 return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
228 return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
229 "use 'zpool scrub -s' to cancel current scrub"));
231 return (dgettext(TEXT_DOMAIN, "there is no active scrub"));
233 return (dgettext(TEXT_DOMAIN, "unable to generate diffs"));
235 return (dgettext(TEXT_DOMAIN, "invalid diff data"));
236 case EZFS_POOLREADONLY:
237 return (dgettext(TEXT_DOMAIN, "pool is read-only"));
239 return (dgettext(TEXT_DOMAIN, "unknown error"));
241 assert(hdl->libzfs_error == 0);
242 return (dgettext(TEXT_DOMAIN, "no error"));
248 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
254 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
256 hdl->libzfs_desc_active = 1;
262 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
264 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
266 hdl->libzfs_error = error;
268 if (hdl->libzfs_desc_active)
269 hdl->libzfs_desc_active = 0;
271 hdl->libzfs_desc[0] = '\0';
273 if (hdl->libzfs_printerr) {
274 if (error == EZFS_UNKNOWN) {
275 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
276 "error: %s\n"), libzfs_error_description(hdl));
280 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
281 libzfs_error_description(hdl));
282 if (error == EZFS_NOMEM)
288 zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
290 return (zfs_error_fmt(hdl, error, "%s", msg));
295 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
301 zfs_verror(hdl, error, fmt, ap);
309 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
315 zfs_verror(hdl, EZFS_PERM, fmt, ap);
319 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
323 zfs_verror(hdl, EZFS_IO, fmt, ap);
327 zfs_verror(hdl, EZFS_FAULT, fmt, ap);
331 zfs_verror(hdl, EZFS_INTR, fmt, ap);
339 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
341 return (zfs_standard_error_fmt(hdl, error, "%s", msg));
346 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
352 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
361 zfs_verror(hdl, EZFS_IO, fmt, ap);
365 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
366 "dataset does not exist"));
367 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
372 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);
475 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
476 "pool I/O is currently suspended"));
477 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
481 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
485 zfs_error_aux(hdl, strerror(error));
486 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
494 * Display an out of memory error message and abort the current program.
497 no_memory(libzfs_handle_t *hdl)
499 return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
503 * A safe form of malloc() which will die if the allocation fails.
506 zfs_alloc(libzfs_handle_t *hdl, size_t size)
510 if ((data = calloc(1, size)) == NULL)
511 (void) no_memory(hdl);
517 * A safe form of asprintf() which will die if the allocation fails.
521 zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...)
529 err = vasprintf(&ret, fmt, ap);
534 (void) no_memory(hdl);
540 * A safe form of realloc(), which also zeroes newly allocated space.
543 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
547 if ((ret = realloc(ptr, newsize)) == NULL) {
548 (void) no_memory(hdl);
552 bzero((char *)ret + oldsize, (newsize - oldsize));
557 * A safe form of strdup() which will die if the allocation fails.
560 zfs_strdup(libzfs_handle_t *hdl, const char *str)
564 if ((ret = strdup(str)) == NULL)
565 (void) no_memory(hdl);
571 * Convert a number to an appropriately human-readable output.
574 zfs_nicenum(uint64_t num, char *buf, size_t buflen)
585 u = " KMGTPE"[index];
588 (void) snprintf(buf, buflen, "%llu", n);
589 } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
591 * If this is an even multiple of the base, always display
592 * without any decimal precision.
594 (void) snprintf(buf, buflen, "%llu%c", n, u);
597 * We want to choose a precision that reflects the best choice
598 * for fitting in 5 characters. This can get rather tricky when
599 * we have numbers that are very close to an order of magnitude.
600 * For example, when displaying 10239 (which is really 9.999K),
601 * we want only a single place of precision for 10.0K. We could
602 * develop some complex heuristics for this, but it's much
603 * easier just to try each combination in turn.
606 for (i = 2; i >= 0; i--) {
607 if (snprintf(buf, buflen, "%.*f%c", i,
608 (double)num / (1ULL << 10 * index), u) <= 5)
615 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
617 hdl->libzfs_printerr = printerr;
625 if (modfind("zfs") < 0) {
626 /* Not present in kernel, try loading it. */
627 if (kldload("zfs") < 0 || modfind("zfs") < 0) {
638 libzfs_handle_t *hdl;
640 if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
644 if (libzfs_load() < 0) {
649 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
654 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
655 (void) close(hdl->libzfs_fd);
660 hdl->libzfs_sharetab = fopen(ZFS_EXPORTS_PATH, "r");
662 if (libzfs_core_init() != 0) {
663 (void) close(hdl->libzfs_fd);
664 (void) fclose(hdl->libzfs_mnttab);
665 (void) fclose(hdl->libzfs_sharetab);
672 zpool_feature_init();
673 libzfs_mnttab_init(hdl);
679 libzfs_fini(libzfs_handle_t *hdl)
681 (void) close(hdl->libzfs_fd);
682 if (hdl->libzfs_mnttab)
683 (void) fclose(hdl->libzfs_mnttab);
684 if (hdl->libzfs_sharetab)
685 (void) fclose(hdl->libzfs_sharetab);
686 zfs_uninit_libshare(hdl);
687 zpool_free_handles(hdl);
689 libzfs_fru_clear(hdl, B_TRUE);
691 namespace_clear(hdl);
692 libzfs_mnttab_fini(hdl);
698 zpool_get_handle(zpool_handle_t *zhp)
700 return (zhp->zpool_hdl);
704 zfs_get_handle(zfs_handle_t *zhp)
706 return (zhp->zfs_hdl);
710 zfs_get_pool_handle(const zfs_handle_t *zhp)
712 return (zhp->zpool_hdl);
716 * Given a name, determine whether or not it's a valid path
717 * (starts with '/' or "./"). If so, walk the mnttab trying
718 * to match the device number. If not, treat the path as an
722 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
724 struct stat64 statbuf;
725 struct extmnttab entry;
728 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
730 * It's not a valid path, assume it's a name of type 'argtype'.
732 return (zfs_open(hdl, path, argtype));
735 if (stat64(path, &statbuf) != 0) {
736 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
741 rewind(hdl->libzfs_mnttab);
742 while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
743 if (makedevice(entry.mnt_major, entry.mnt_minor) ==
752 ret = statfs(path, &sfs);
754 statfs2mnttab(&sfs, &entry);
756 (void) fprintf(stderr, "%s: %s\n", path,
765 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
766 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
771 return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
775 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
779 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
783 zc->zc_nvlist_dst_size = len;
784 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
785 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
792 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
793 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
794 * filled in by the kernel to indicate the actual required size.
797 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
799 free((void *)(uintptr_t)zc->zc_nvlist_dst);
800 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
801 zfs_alloc(hdl, zc->zc_nvlist_dst_size))
809 * Called to free the src and dst nvlists stored in the command structure.
812 zcmd_free_nvlists(zfs_cmd_t *zc)
814 free((void *)(uintptr_t)zc->zc_nvlist_conf);
815 free((void *)(uintptr_t)zc->zc_nvlist_src);
816 free((void *)(uintptr_t)zc->zc_nvlist_dst);
820 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
826 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
828 if ((packed = zfs_alloc(hdl, len)) == NULL)
831 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
833 *outnv = (uint64_t)(uintptr_t)packed;
840 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
842 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
843 &zc->zc_nvlist_conf_size, nvl));
847 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
849 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
850 &zc->zc_nvlist_src_size, nvl));
854 * Unpacks an nvlist from the ZFS ioctl command structure.
857 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
859 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
860 zc->zc_nvlist_dst_size, nvlp, 0) != 0)
861 return (no_memory(hdl));
867 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
869 return (ioctl(hdl->libzfs_fd, request, zc));
873 * ================================================================
874 * API shared by zfs and zpool property management
875 * ================================================================
879 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
881 zprop_list_t *pl = cbp->cb_proplist;
886 cbp->cb_first = B_FALSE;
887 if (cbp->cb_scripted)
891 * Start with the length of the column headers.
893 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
894 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
896 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
898 cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
900 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
903 /* first property is always NAME */
904 assert(cbp->cb_proplist->pl_prop ==
905 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME));
908 * Go through and calculate the widths for each column. For the
909 * 'source' column, we kludge it up by taking the worst-case scenario of
910 * inheriting from the longest name. This is acceptable because in the
911 * majority of cases 'SOURCE' is the last column displayed, and we don't
912 * use the width anyway. Note that the 'VALUE' column can be oversized,
913 * if the name of the property is much longer than any values we find.
915 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
919 if (pl->pl_prop != ZPROP_INVAL) {
920 const char *propname = (type == ZFS_TYPE_POOL) ?
921 zpool_prop_to_name(pl->pl_prop) :
922 zfs_prop_to_name(pl->pl_prop);
924 len = strlen(propname);
925 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
926 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
928 len = strlen(pl->pl_user_prop);
929 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
930 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
934 * 'VALUE' column. The first property is always the 'name'
935 * property that was tacked on either by /sbin/zfs's
936 * zfs_do_get() or when calling zprop_expand_list(), so we
937 * ignore its width. If the user specified the name property
938 * to display, then it will be later in the list in any case.
940 if (pl != cbp->cb_proplist &&
941 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
942 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
944 /* 'RECEIVED' column. */
945 if (pl != cbp->cb_proplist &&
946 pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
947 cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
950 * 'NAME' and 'SOURCE' columns
952 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
954 pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
955 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
956 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
957 strlen(dgettext(TEXT_DOMAIN, "inherited from"));
962 * Now go through and print the headers.
964 for (i = 0; i < ZFS_GET_NCOLS; i++) {
965 switch (cbp->cb_columns[i]) {
967 title = dgettext(TEXT_DOMAIN, "NAME");
969 case GET_COL_PROPERTY:
970 title = dgettext(TEXT_DOMAIN, "PROPERTY");
973 title = dgettext(TEXT_DOMAIN, "VALUE");
976 title = dgettext(TEXT_DOMAIN, "RECEIVED");
979 title = dgettext(TEXT_DOMAIN, "SOURCE");
986 if (i == (ZFS_GET_NCOLS - 1) ||
987 cbp->cb_columns[i + 1] == GET_COL_NONE)
988 (void) printf("%s", title);
990 (void) printf("%-*s ",
991 cbp->cb_colwidths[cbp->cb_columns[i]],
999 * Display a single line of output, according to the settings in the callback
1003 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
1004 const char *propname, const char *value, zprop_source_t sourcetype,
1005 const char *source, const char *recvd_value)
1012 * Ignore those source types that the user has chosen to ignore.
1014 if ((sourcetype & cbp->cb_sources) == 0)
1018 zprop_print_headers(cbp, cbp->cb_type);
1020 for (i = 0; i < ZFS_GET_NCOLS; i++) {
1021 switch (cbp->cb_columns[i]) {
1026 case GET_COL_PROPERTY:
1034 case GET_COL_SOURCE:
1035 switch (sourcetype) {
1036 case ZPROP_SRC_NONE:
1040 case ZPROP_SRC_DEFAULT:
1044 case ZPROP_SRC_LOCAL:
1048 case ZPROP_SRC_TEMPORARY:
1052 case ZPROP_SRC_INHERITED:
1053 (void) snprintf(buf, sizeof (buf),
1054 "inherited from %s", source);
1057 case ZPROP_SRC_RECEIVED:
1064 str = (recvd_value == NULL ? "-" : recvd_value);
1071 if (cbp->cb_columns[i + 1] == GET_COL_NONE)
1072 (void) printf("%s", str);
1073 else if (cbp->cb_scripted)
1074 (void) printf("%s\t", str);
1076 (void) printf("%-*s ",
1077 cbp->cb_colwidths[cbp->cb_columns[i]],
1081 (void) printf("\n");
1085 * Given a numeric suffix, convert the value into a number of bits that the
1086 * resulting value must be shifted.
1089 str2shift(libzfs_handle_t *hdl, const char *buf)
1091 const char *ends = "BKMGTPEZ";
1096 for (i = 0; i < strlen(ends); i++) {
1097 if (toupper(buf[0]) == ends[i])
1100 if (i == strlen(ends)) {
1101 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1102 "invalid numeric suffix '%s'"), buf);
1107 * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't
1108 * allow 'BB' - that's just weird.
1110 if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' &&
1111 toupper(buf[0]) != 'B'))
1114 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1115 "invalid numeric suffix '%s'"), buf);
1120 * Convert a string of the form '100G' into a real number. Used when setting
1121 * properties or creating a volume. 'buf' is used to place an extended error
1122 * message for the caller to use.
1125 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1132 /* Check to see if this looks like a number. */
1133 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1135 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1136 "bad numeric value '%s'"), value);
1140 /* Rely on strtoull() to process the numeric portion. */
1142 *num = strtoull(value, &end, 10);
1145 * Check for ERANGE, which indicates that the value is too large to fit
1146 * in a 64-bit value.
1148 if (errno == ERANGE) {
1150 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1151 "numeric value is too large"));
1156 * If we have a decimal value, then do the computation with floating
1157 * point arithmetic. Otherwise, use standard arithmetic.
1160 double fval = strtod(value, &end);
1162 if ((shift = str2shift(hdl, end)) == -1)
1165 fval *= pow(2, shift);
1167 if (fval > UINT64_MAX) {
1169 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1170 "numeric value is too large"));
1174 *num = (uint64_t)fval;
1176 if ((shift = str2shift(hdl, end)) == -1)
1179 /* Check for overflow */
1180 if (shift >= 64 || (*num << shift) >> shift != *num) {
1182 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1183 "numeric value is too large"));
1194 * Given a propname=value nvpair to set, parse any numeric properties
1195 * (index, boolean, etc) if they are specified as strings and add the
1196 * resulting nvpair to the returned nvlist.
1198 * At the DSL layer, all properties are either 64-bit numbers or strings.
1199 * We want the user to be able to ignore this fact and specify properties
1200 * as native values (numbers, for example) or as strings (to simplify
1201 * command line utilities). This also handles converting index types
1202 * (compression, checksum, etc) from strings to their on-disk index.
1205 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1206 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1209 data_type_t datatype = nvpair_type(elem);
1210 zprop_type_t proptype;
1211 const char *propname;
1213 boolean_t isnone = B_FALSE;
1215 if (type == ZFS_TYPE_POOL) {
1216 proptype = zpool_prop_get_type(prop);
1217 propname = zpool_prop_to_name(prop);
1219 proptype = zfs_prop_get_type(prop);
1220 propname = zfs_prop_to_name(prop);
1224 * Convert any properties to the internal DSL value types.
1230 case PROP_TYPE_STRING:
1231 if (datatype != DATA_TYPE_STRING) {
1232 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1233 "'%s' must be a string"), nvpair_name(elem));
1236 (void) nvpair_value_string(elem, svalp);
1237 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1238 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1239 "'%s' is too long"), nvpair_name(elem));
1244 case PROP_TYPE_NUMBER:
1245 if (datatype == DATA_TYPE_STRING) {
1246 (void) nvpair_value_string(elem, &value);
1247 if (strcmp(value, "none") == 0) {
1249 } else if (zfs_nicestrtonum(hdl, value, ivalp)
1253 } else if (datatype == DATA_TYPE_UINT64) {
1254 (void) nvpair_value_uint64(elem, ivalp);
1256 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1257 "'%s' must be a number"), nvpair_name(elem));
1262 * Quota special: force 'none' and don't allow 0.
1264 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1265 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1266 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1267 "use 'none' to disable quota/refquota"));
1272 * Special handling for "*_limit=none". In this case it's not
1275 if ((type & ZFS_TYPE_DATASET) && isnone &&
1276 (prop == ZFS_PROP_FILESYSTEM_LIMIT ||
1277 prop == ZFS_PROP_SNAPSHOT_LIMIT)) {
1278 *ivalp = UINT64_MAX;
1282 case PROP_TYPE_INDEX:
1283 if (datatype != DATA_TYPE_STRING) {
1284 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1285 "'%s' must be a string"), nvpair_name(elem));
1289 (void) nvpair_value_string(elem, &value);
1291 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1292 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1293 "'%s' must be one of '%s'"), propname,
1294 zprop_values(prop, type));
1304 * Add the result to our return set of properties.
1306 if (*svalp != NULL) {
1307 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1308 (void) no_memory(hdl);
1312 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1313 (void) no_memory(hdl);
1320 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1325 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1329 zprop_list_t *entry;
1331 prop = zprop_name_to_prop(propname, type);
1333 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1337 * When no property table entry can be found, return failure if
1338 * this is a pool property or if this isn't a user-defined
1341 if (prop == ZPROP_INVAL && ((type == ZFS_TYPE_POOL &&
1342 !zpool_prop_feature(propname) &&
1343 !zpool_prop_unsupported(propname)) ||
1344 (type == ZFS_TYPE_DATASET && !zfs_prop_user(propname) &&
1345 !zfs_prop_userquota(propname) && !zfs_prop_written(propname)))) {
1346 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1347 "invalid property '%s'"), propname);
1348 return (zfs_error(hdl, EZFS_BADPROP,
1349 dgettext(TEXT_DOMAIN, "bad property list")));
1352 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1355 entry->pl_prop = prop;
1356 if (prop == ZPROP_INVAL) {
1357 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) ==
1362 entry->pl_width = strlen(propname);
1364 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1374 * Given a comma-separated list of properties, construct a property list
1375 * containing both user-defined and native properties. This function will
1376 * return a NULL list if 'all' is specified, which can later be expanded
1377 * by zprop_expand_list().
1380 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1386 * If 'all' is specified, return a NULL list.
1388 if (strcmp(props, "all") == 0)
1392 * If no props were specified, return an error.
1394 if (props[0] == '\0') {
1395 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1396 "no properties specified"));
1397 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1398 "bad property list")));
1402 * It would be nice to use getsubopt() here, but the inclusion of column
1403 * aliases makes this more effort than it's worth.
1405 while (*props != '\0') {
1410 if ((p = strchr(props, ',')) == NULL) {
1411 len = strlen(props);
1418 * Check for empty options.
1421 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1422 "empty property name"));
1423 return (zfs_error(hdl, EZFS_BADPROP,
1424 dgettext(TEXT_DOMAIN, "bad property list")));
1428 * Check all regular property names.
1433 if (strcmp(props, "space") == 0) {
1434 static char *spaceprops[] = {
1435 "name", "avail", "used", "usedbysnapshots",
1436 "usedbydataset", "usedbyrefreservation",
1437 "usedbychildren", NULL
1441 for (i = 0; spaceprops[i]; i++) {
1442 if (addlist(hdl, spaceprops[i], listp, type))
1444 listp = &(*listp)->pl_next;
1447 if (addlist(hdl, props, listp, type))
1449 listp = &(*listp)->pl_next;
1461 zprop_free_list(zprop_list_t *pl)
1465 while (pl != NULL) {
1467 free(pl->pl_user_prop);
1473 typedef struct expand_data {
1474 zprop_list_t **last;
1475 libzfs_handle_t *hdl;
1480 zprop_expand_list_cb(int prop, void *cb)
1482 zprop_list_t *entry;
1483 expand_data_t *edp = cb;
1485 if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1486 return (ZPROP_INVAL);
1488 entry->pl_prop = prop;
1489 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1490 entry->pl_all = B_TRUE;
1492 *(edp->last) = entry;
1493 edp->last = &entry->pl_next;
1495 return (ZPROP_CONT);
1499 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1501 zprop_list_t *entry;
1502 zprop_list_t **last;
1507 * If this is the very first time we've been called for an 'all'
1508 * specification, expand the list to include all native
1517 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1518 B_FALSE, type) == ZPROP_INVAL)
1522 * Add 'name' to the beginning of the list, which is handled
1525 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1528 entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME :
1530 entry->pl_width = zprop_width(entry->pl_prop,
1531 &entry->pl_fixed, type);
1532 entry->pl_all = B_TRUE;
1533 entry->pl_next = *plp;
1540 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1543 return (zprop_iter_common(func, cb, show_all, ordered, type));