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) 2011, 2015 by Delphix. All rights reserved.
26 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
27 * Copyright (c) 2017 Datto Inc.
31 * Internal utility routines for the ZFS library.
34 #include <sys/param.h>
35 #include <sys/linker.h>
36 #include <sys/module.h>
49 #include <sys/mnttab.h>
50 #include <sys/mntent.h>
51 #include <sys/types.h>
52 #include <libcmdutils.h>
55 #include <libzfs_core.h>
57 #include "libzfs_impl.h"
59 #include "zfeature_common.h"
63 libzfs_errno(libzfs_handle_t *hdl)
65 return (hdl->libzfs_error);
69 libzfs_error_action(libzfs_handle_t *hdl)
71 return (hdl->libzfs_action);
75 libzfs_error_description(libzfs_handle_t *hdl)
77 if (hdl->libzfs_desc[0] != '\0')
78 return (hdl->libzfs_desc);
80 switch (hdl->libzfs_error) {
82 return (dgettext(TEXT_DOMAIN, "out of memory"));
84 return (dgettext(TEXT_DOMAIN, "invalid property value"));
85 case EZFS_PROPREADONLY:
86 return (dgettext(TEXT_DOMAIN, "read-only property"));
88 return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
89 "datasets of this type"));
90 case EZFS_PROPNONINHERIT:
91 return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
93 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
95 return (dgettext(TEXT_DOMAIN, "operation not applicable to "
96 "datasets of this type"));
98 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
100 return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
102 return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
104 return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
105 case EZFS_DSREADONLY:
106 return (dgettext(TEXT_DOMAIN, "dataset is read-only"));
108 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
110 case EZFS_INVALIDNAME:
111 return (dgettext(TEXT_DOMAIN, "invalid name"));
112 case EZFS_BADRESTORE:
113 return (dgettext(TEXT_DOMAIN, "unable to restore to "
116 return (dgettext(TEXT_DOMAIN, "backup failed"));
118 return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
120 return (dgettext(TEXT_DOMAIN, "no such device in pool"));
122 return (dgettext(TEXT_DOMAIN, "invalid device"));
123 case EZFS_NOREPLICAS:
124 return (dgettext(TEXT_DOMAIN, "no valid replicas"));
125 case EZFS_RESILVERING:
126 return (dgettext(TEXT_DOMAIN, "currently resilvering"));
127 case EZFS_BADVERSION:
128 return (dgettext(TEXT_DOMAIN, "unsupported version or "
130 case EZFS_POOLUNAVAIL:
131 return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
132 case EZFS_DEVOVERFLOW:
133 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
135 return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
136 case EZFS_CROSSTARGET:
137 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
140 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
141 case EZFS_MOUNTFAILED:
142 return (dgettext(TEXT_DOMAIN, "mount failed"));
143 case EZFS_UMOUNTFAILED:
144 return (dgettext(TEXT_DOMAIN, "umount failed"));
145 case EZFS_UNSHARENFSFAILED:
146 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
147 case EZFS_SHARENFSFAILED:
148 return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
149 case EZFS_UNSHARESMBFAILED:
150 return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
151 case EZFS_SHARESMBFAILED:
152 return (dgettext(TEXT_DOMAIN, "smb add share failed"));
154 return (dgettext(TEXT_DOMAIN, "permission denied"));
156 return (dgettext(TEXT_DOMAIN, "out of space"));
158 return (dgettext(TEXT_DOMAIN, "bad address"));
160 return (dgettext(TEXT_DOMAIN, "I/O error"));
162 return (dgettext(TEXT_DOMAIN, "signal received"));
164 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
166 case EZFS_INVALCONFIG:
167 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
169 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
171 return (dgettext(TEXT_DOMAIN, "no history available"));
173 return (dgettext(TEXT_DOMAIN, "failed to retrieve "
175 case EZFS_POOL_NOTSUP:
176 return (dgettext(TEXT_DOMAIN, "operation not supported "
177 "on this type of pool"));
178 case EZFS_POOL_INVALARG:
179 return (dgettext(TEXT_DOMAIN, "invalid argument for "
180 "this pool operation"));
181 case EZFS_NAMETOOLONG:
182 return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
183 case EZFS_OPENFAILED:
184 return (dgettext(TEXT_DOMAIN, "open failed"));
186 return (dgettext(TEXT_DOMAIN,
187 "disk capacity information could not be retrieved"));
188 case EZFS_LABELFAILED:
189 return (dgettext(TEXT_DOMAIN, "write of label failed"));
191 return (dgettext(TEXT_DOMAIN, "invalid user/group"));
193 return (dgettext(TEXT_DOMAIN, "invalid permission"));
194 case EZFS_BADPERMSET:
195 return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
196 case EZFS_NODELEGATION:
197 return (dgettext(TEXT_DOMAIN, "delegated administration is "
198 "disabled on pool"));
200 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
202 return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
203 case EZFS_VDEVNOTSUP:
204 return (dgettext(TEXT_DOMAIN, "vdev specification is not "
207 return (dgettext(TEXT_DOMAIN, "operation not supported "
209 case EZFS_ACTIVE_SPARE:
210 return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
212 case EZFS_UNPLAYED_LOGS:
213 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
215 case EZFS_REFTAG_RELE:
216 return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
217 case EZFS_REFTAG_HOLD:
218 return (dgettext(TEXT_DOMAIN, "tag already exists on this "
220 case EZFS_TAGTOOLONG:
221 return (dgettext(TEXT_DOMAIN, "tag too long"));
222 case EZFS_PIPEFAILED:
223 return (dgettext(TEXT_DOMAIN, "pipe create failed"));
224 case EZFS_THREADCREATEFAILED:
225 return (dgettext(TEXT_DOMAIN, "thread create failed"));
226 case EZFS_POSTSPLIT_ONLINE:
227 return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
229 case EZFS_SCRUB_PAUSED:
230 return (dgettext(TEXT_DOMAIN, "scrub is paused; "
231 "use 'zpool scrub' to resume"));
233 return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
234 "use 'zpool scrub -s' to cancel current scrub"));
236 return (dgettext(TEXT_DOMAIN, "there is no active scrub"));
238 return (dgettext(TEXT_DOMAIN, "unable to generate diffs"));
240 return (dgettext(TEXT_DOMAIN, "invalid diff data"));
241 case EZFS_POOLREADONLY:
242 return (dgettext(TEXT_DOMAIN, "pool is read-only"));
244 return (dgettext(TEXT_DOMAIN, "unknown error"));
246 assert(hdl->libzfs_error == 0);
247 return (dgettext(TEXT_DOMAIN, "no error"));
253 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
259 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
261 hdl->libzfs_desc_active = 1;
267 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
269 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
271 hdl->libzfs_error = error;
273 if (hdl->libzfs_desc_active)
274 hdl->libzfs_desc_active = 0;
276 hdl->libzfs_desc[0] = '\0';
278 if (hdl->libzfs_printerr) {
279 if (error == EZFS_UNKNOWN) {
280 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
281 "error: %s\n"), libzfs_error_description(hdl));
285 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
286 libzfs_error_description(hdl));
287 if (error == EZFS_NOMEM)
293 zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
295 return (zfs_error_fmt(hdl, error, "%s", msg));
300 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
306 zfs_verror(hdl, error, fmt, ap);
314 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
320 zfs_verror(hdl, EZFS_PERM, fmt, ap);
324 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
328 zfs_verror(hdl, EZFS_IO, fmt, ap);
332 zfs_verror(hdl, EZFS_FAULT, fmt, ap);
336 zfs_verror(hdl, EZFS_INTR, fmt, ap);
344 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
346 return (zfs_standard_error_fmt(hdl, error, "%s", msg));
351 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
357 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
366 zfs_verror(hdl, EZFS_IO, fmt, ap);
370 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
371 "dataset does not exist"));
372 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
377 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
382 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
383 "dataset already exists"));
384 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
388 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
390 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
393 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
396 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
399 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap);
402 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
403 "pool I/O is currently suspended"));
404 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
407 zfs_error_aux(hdl, strerror(error));
408 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
417 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
419 return (zpool_standard_error_fmt(hdl, error, "%s", msg));
424 zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
430 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
437 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
442 dgettext(TEXT_DOMAIN, "no such pool or dataset"));
443 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
447 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
448 "pool already exists"));
449 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
453 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
454 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
458 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
459 "one or more devices is currently unavailable"));
460 zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
464 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
468 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
472 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
477 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
482 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
483 "pool I/O is currently suspended"));
484 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
488 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
492 zfs_error_aux(hdl, strerror(error));
493 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
501 * Display an out of memory error message and abort the current program.
504 no_memory(libzfs_handle_t *hdl)
506 return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
510 * A safe form of malloc() which will die if the allocation fails.
513 zfs_alloc(libzfs_handle_t *hdl, size_t size)
517 if ((data = calloc(1, size)) == NULL)
518 (void) no_memory(hdl);
524 * A safe form of asprintf() which will die if the allocation fails.
528 zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...)
536 err = vasprintf(&ret, fmt, ap);
541 (void) no_memory(hdl);
547 * A safe form of realloc(), which also zeroes newly allocated space.
550 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
554 if ((ret = realloc(ptr, newsize)) == NULL) {
555 (void) no_memory(hdl);
559 bzero((char *)ret + oldsize, (newsize - oldsize));
564 * A safe form of strdup() which will die if the allocation fails.
567 zfs_strdup(libzfs_handle_t *hdl, const char *str)
571 if ((ret = strdup(str)) == NULL)
572 (void) no_memory(hdl);
578 * Convert a number to an appropriately human-readable output.
581 zfs_nicenum(uint64_t num, char *buf, size_t buflen)
583 nicenum(num, buf, buflen);
587 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
589 hdl->libzfs_printerr = printerr;
597 if (modfind("zfs") < 0) {
598 /* Not present in kernel, try loading it. */
599 if (kldload("zfs") < 0 || modfind("zfs") < 0) {
610 libzfs_handle_t *hdl;
612 if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
616 if (libzfs_load() < 0) {
621 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
626 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
627 (void) close(hdl->libzfs_fd);
632 hdl->libzfs_sharetab = fopen(ZFS_EXPORTS_PATH, "r");
634 if (libzfs_core_init() != 0) {
635 (void) close(hdl->libzfs_fd);
636 (void) fclose(hdl->libzfs_mnttab);
637 (void) fclose(hdl->libzfs_sharetab);
644 zpool_feature_init();
645 libzfs_mnttab_init(hdl);
647 if (getenv("ZFS_PROP_DEBUG") != NULL) {
648 hdl->libzfs_prop_debug = B_TRUE;
655 libzfs_fini(libzfs_handle_t *hdl)
657 (void) close(hdl->libzfs_fd);
658 if (hdl->libzfs_mnttab)
659 (void) fclose(hdl->libzfs_mnttab);
660 if (hdl->libzfs_sharetab)
661 (void) fclose(hdl->libzfs_sharetab);
662 zfs_uninit_libshare(hdl);
663 zpool_free_handles(hdl);
665 libzfs_fru_clear(hdl, B_TRUE);
667 namespace_clear(hdl);
668 libzfs_mnttab_fini(hdl);
674 zpool_get_handle(zpool_handle_t *zhp)
676 return (zhp->zpool_hdl);
680 zfs_get_handle(zfs_handle_t *zhp)
682 return (zhp->zfs_hdl);
686 zfs_get_pool_handle(const zfs_handle_t *zhp)
688 return (zhp->zpool_hdl);
692 * Given a name, determine whether or not it's a valid path
693 * (starts with '/' or "./"). If so, walk the mnttab trying
694 * to match the device number. If not, treat the path as an
695 * fs/vol/snap/bkmark name.
698 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
700 struct stat64 statbuf;
701 struct extmnttab entry;
704 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
706 * It's not a valid path, assume it's a name of type 'argtype'.
708 return (zfs_open(hdl, path, argtype));
711 if (stat64(path, &statbuf) != 0) {
712 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
717 rewind(hdl->libzfs_mnttab);
718 while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
719 if (makedevice(entry.mnt_major, entry.mnt_minor) ==
728 ret = statfs(path, &sfs);
730 statfs2mnttab(&sfs, &entry);
732 (void) fprintf(stderr, "%s: %s\n", path,
741 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
742 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
747 return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
751 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
755 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
759 zc->zc_nvlist_dst_size = len;
761 (uint64_t)(uintptr_t)zfs_alloc(hdl, zc->zc_nvlist_dst_size);
762 if (zc->zc_nvlist_dst == 0)
769 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
770 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
771 * filled in by the kernel to indicate the actual required size.
774 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
776 free((void *)(uintptr_t)zc->zc_nvlist_dst);
778 (uint64_t)(uintptr_t)zfs_alloc(hdl, zc->zc_nvlist_dst_size);
779 if (zc->zc_nvlist_dst == 0)
786 * Called to free the src and dst nvlists stored in the command structure.
789 zcmd_free_nvlists(zfs_cmd_t *zc)
791 free((void *)(uintptr_t)zc->zc_nvlist_conf);
792 free((void *)(uintptr_t)zc->zc_nvlist_src);
793 free((void *)(uintptr_t)zc->zc_nvlist_dst);
794 zc->zc_nvlist_conf = NULL;
795 zc->zc_nvlist_src = NULL;
796 zc->zc_nvlist_dst = NULL;
800 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
806 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
808 if ((packed = zfs_alloc(hdl, len)) == NULL)
811 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
813 *outnv = (uint64_t)(uintptr_t)packed;
820 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
822 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
823 &zc->zc_nvlist_conf_size, nvl));
827 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
829 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
830 &zc->zc_nvlist_src_size, nvl));
834 * Unpacks an nvlist from the ZFS ioctl command structure.
837 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
839 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
840 zc->zc_nvlist_dst_size, nvlp, 0) != 0)
841 return (no_memory(hdl));
847 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
849 return (ioctl(hdl->libzfs_fd, request, zc));
853 * ================================================================
854 * API shared by zfs and zpool property management
855 * ================================================================
859 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
861 zprop_list_t *pl = cbp->cb_proplist;
866 cbp->cb_first = B_FALSE;
867 if (cbp->cb_scripted)
871 * Start with the length of the column headers.
873 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
874 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
876 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
878 cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
880 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
883 /* first property is always NAME */
884 assert(cbp->cb_proplist->pl_prop ==
885 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME));
888 * Go through and calculate the widths for each column. For the
889 * 'source' column, we kludge it up by taking the worst-case scenario of
890 * inheriting from the longest name. This is acceptable because in the
891 * majority of cases 'SOURCE' is the last column displayed, and we don't
892 * use the width anyway. Note that the 'VALUE' column can be oversized,
893 * if the name of the property is much longer than any values we find.
895 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
899 if (pl->pl_prop != ZPROP_INVAL) {
900 const char *propname = (type == ZFS_TYPE_POOL) ?
901 zpool_prop_to_name(pl->pl_prop) :
902 zfs_prop_to_name(pl->pl_prop);
904 len = strlen(propname);
905 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
906 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
908 len = strlen(pl->pl_user_prop);
909 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
910 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
914 * 'VALUE' column. The first property is always the 'name'
915 * property that was tacked on either by /sbin/zfs's
916 * zfs_do_get() or when calling zprop_expand_list(), so we
917 * ignore its width. If the user specified the name property
918 * to display, then it will be later in the list in any case.
920 if (pl != cbp->cb_proplist &&
921 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
922 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
924 /* 'RECEIVED' column. */
925 if (pl != cbp->cb_proplist &&
926 pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
927 cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
930 * 'NAME' and 'SOURCE' columns
932 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
934 pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
935 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
936 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
937 strlen(dgettext(TEXT_DOMAIN, "inherited from"));
942 * Now go through and print the headers.
944 for (i = 0; i < ZFS_GET_NCOLS; i++) {
945 switch (cbp->cb_columns[i]) {
947 title = dgettext(TEXT_DOMAIN, "NAME");
949 case GET_COL_PROPERTY:
950 title = dgettext(TEXT_DOMAIN, "PROPERTY");
953 title = dgettext(TEXT_DOMAIN, "VALUE");
956 title = dgettext(TEXT_DOMAIN, "RECEIVED");
959 title = dgettext(TEXT_DOMAIN, "SOURCE");
966 if (i == (ZFS_GET_NCOLS - 1) ||
967 cbp->cb_columns[i + 1] == GET_COL_NONE)
968 (void) printf("%s", title);
970 (void) printf("%-*s ",
971 cbp->cb_colwidths[cbp->cb_columns[i]],
979 * Display a single line of output, according to the settings in the callback
983 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
984 const char *propname, const char *value, zprop_source_t sourcetype,
985 const char *source, const char *recvd_value)
988 const char *str = NULL;
992 * Ignore those source types that the user has chosen to ignore.
994 if ((sourcetype & cbp->cb_sources) == 0)
998 zprop_print_headers(cbp, cbp->cb_type);
1000 for (i = 0; i < ZFS_GET_NCOLS; i++) {
1001 switch (cbp->cb_columns[i]) {
1006 case GET_COL_PROPERTY:
1014 case GET_COL_SOURCE:
1015 switch (sourcetype) {
1016 case ZPROP_SRC_NONE:
1020 case ZPROP_SRC_DEFAULT:
1024 case ZPROP_SRC_LOCAL:
1028 case ZPROP_SRC_TEMPORARY:
1032 case ZPROP_SRC_INHERITED:
1033 (void) snprintf(buf, sizeof (buf),
1034 "inherited from %s", source);
1037 case ZPROP_SRC_RECEIVED:
1043 assert(!"unhandled zprop_source_t");
1048 str = (recvd_value == NULL ? "-" : recvd_value);
1055 if (cbp->cb_columns[i + 1] == GET_COL_NONE)
1056 (void) printf("%s", str);
1057 else if (cbp->cb_scripted)
1058 (void) printf("%s\t", str);
1060 (void) printf("%-*s ",
1061 cbp->cb_colwidths[cbp->cb_columns[i]],
1065 (void) printf("\n");
1069 * Given a numeric suffix, convert the value into a number of bits that the
1070 * resulting value must be shifted.
1073 str2shift(libzfs_handle_t *hdl, const char *buf)
1075 const char *ends = "BKMGTPEZ";
1080 for (i = 0; i < strlen(ends); i++) {
1081 if (toupper(buf[0]) == ends[i])
1084 if (i == strlen(ends)) {
1085 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1086 "invalid numeric suffix '%s'"), buf);
1091 * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't
1092 * allow 'BB' - that's just weird.
1094 if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' &&
1095 toupper(buf[0]) != 'B'))
1098 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1099 "invalid numeric suffix '%s'"), buf);
1104 * Convert a string of the form '100G' into a real number. Used when setting
1105 * properties or creating a volume. 'buf' is used to place an extended error
1106 * message for the caller to use.
1109 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1116 /* Check to see if this looks like a number. */
1117 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1119 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1120 "bad numeric value '%s'"), value);
1124 /* Rely on strtoull() to process the numeric portion. */
1126 *num = strtoull(value, &end, 10);
1129 * Check for ERANGE, which indicates that the value is too large to fit
1130 * in a 64-bit value.
1132 if (errno == ERANGE) {
1134 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1135 "numeric value is too large"));
1140 * If we have a decimal value, then do the computation with floating
1141 * point arithmetic. Otherwise, use standard arithmetic.
1144 double fval = strtod(value, &end);
1146 if ((shift = str2shift(hdl, end)) == -1)
1149 fval *= pow(2, shift);
1151 if (fval > UINT64_MAX) {
1153 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1154 "numeric value is too large"));
1158 *num = (uint64_t)fval;
1160 if ((shift = str2shift(hdl, end)) == -1)
1163 /* Check for overflow */
1164 if (shift >= 64 || (*num << shift) >> shift != *num) {
1166 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1167 "numeric value is too large"));
1178 * Given a propname=value nvpair to set, parse any numeric properties
1179 * (index, boolean, etc) if they are specified as strings and add the
1180 * resulting nvpair to the returned nvlist.
1182 * At the DSL layer, all properties are either 64-bit numbers or strings.
1183 * We want the user to be able to ignore this fact and specify properties
1184 * as native values (numbers, for example) or as strings (to simplify
1185 * command line utilities). This also handles converting index types
1186 * (compression, checksum, etc) from strings to their on-disk index.
1189 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1190 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1193 data_type_t datatype = nvpair_type(elem);
1194 zprop_type_t proptype;
1195 const char *propname;
1197 boolean_t isnone = B_FALSE;
1199 if (type == ZFS_TYPE_POOL) {
1200 proptype = zpool_prop_get_type(prop);
1201 propname = zpool_prop_to_name(prop);
1203 proptype = zfs_prop_get_type(prop);
1204 propname = zfs_prop_to_name(prop);
1208 * Convert any properties to the internal DSL value types.
1214 case PROP_TYPE_STRING:
1215 if (datatype != DATA_TYPE_STRING) {
1216 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1217 "'%s' must be a string"), nvpair_name(elem));
1220 (void) nvpair_value_string(elem, svalp);
1221 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1222 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1223 "'%s' is too long"), nvpair_name(elem));
1228 case PROP_TYPE_NUMBER:
1229 if (datatype == DATA_TYPE_STRING) {
1230 (void) nvpair_value_string(elem, &value);
1231 if (strcmp(value, "none") == 0) {
1233 } else if (zfs_nicestrtonum(hdl, value, ivalp)
1237 } else if (datatype == DATA_TYPE_UINT64) {
1238 (void) nvpair_value_uint64(elem, ivalp);
1240 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1241 "'%s' must be a number"), nvpair_name(elem));
1246 * Quota special: force 'none' and don't allow 0.
1248 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1249 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1250 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1251 "use 'none' to disable quota/refquota"));
1256 * Special handling for "*_limit=none". In this case it's not
1259 if ((type & ZFS_TYPE_DATASET) && isnone &&
1260 (prop == ZFS_PROP_FILESYSTEM_LIMIT ||
1261 prop == ZFS_PROP_SNAPSHOT_LIMIT)) {
1262 *ivalp = UINT64_MAX;
1266 case PROP_TYPE_INDEX:
1267 if (datatype != DATA_TYPE_STRING) {
1268 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1269 "'%s' must be a string"), nvpair_name(elem));
1273 (void) nvpair_value_string(elem, &value);
1275 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1276 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1277 "'%s' must be one of '%s'"), propname,
1278 zprop_values(prop, type));
1288 * Add the result to our return set of properties.
1290 if (*svalp != NULL) {
1291 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1292 (void) no_memory(hdl);
1296 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1297 (void) no_memory(hdl);
1304 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1309 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1313 zprop_list_t *entry;
1315 prop = zprop_name_to_prop(propname, type);
1317 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1321 * When no property table entry can be found, return failure if
1322 * this is a pool property or if this isn't a user-defined
1325 if (prop == ZPROP_INVAL && ((type == ZFS_TYPE_POOL &&
1326 !zpool_prop_feature(propname) &&
1327 !zpool_prop_unsupported(propname)) ||
1328 (type == ZFS_TYPE_DATASET && !zfs_prop_user(propname) &&
1329 !zfs_prop_userquota(propname) && !zfs_prop_written(propname)))) {
1330 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1331 "invalid property '%s'"), propname);
1332 return (zfs_error(hdl, EZFS_BADPROP,
1333 dgettext(TEXT_DOMAIN, "bad property list")));
1336 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1339 entry->pl_prop = prop;
1340 if (prop == ZPROP_INVAL) {
1341 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) ==
1346 entry->pl_width = strlen(propname);
1348 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1358 * Given a comma-separated list of properties, construct a property list
1359 * containing both user-defined and native properties. This function will
1360 * return a NULL list if 'all' is specified, which can later be expanded
1361 * by zprop_expand_list().
1364 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1370 * If 'all' is specified, return a NULL list.
1372 if (strcmp(props, "all") == 0)
1376 * If no props were specified, return an error.
1378 if (props[0] == '\0') {
1379 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1380 "no properties specified"));
1381 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1382 "bad property list")));
1386 * It would be nice to use getsubopt() here, but the inclusion of column
1387 * aliases makes this more effort than it's worth.
1389 while (*props != '\0') {
1394 if ((p = strchr(props, ',')) == NULL) {
1395 len = strlen(props);
1402 * Check for empty options.
1405 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1406 "empty property name"));
1407 return (zfs_error(hdl, EZFS_BADPROP,
1408 dgettext(TEXT_DOMAIN, "bad property list")));
1412 * Check all regular property names.
1417 if (strcmp(props, "space") == 0) {
1418 static char *spaceprops[] = {
1419 "name", "avail", "used", "usedbysnapshots",
1420 "usedbydataset", "usedbyrefreservation",
1421 "usedbychildren", NULL
1425 for (i = 0; spaceprops[i]; i++) {
1426 if (addlist(hdl, spaceprops[i], listp, type))
1428 listp = &(*listp)->pl_next;
1431 if (addlist(hdl, props, listp, type))
1433 listp = &(*listp)->pl_next;
1445 zprop_free_list(zprop_list_t *pl)
1449 while (pl != NULL) {
1451 free(pl->pl_user_prop);
1457 typedef struct expand_data {
1458 zprop_list_t **last;
1459 libzfs_handle_t *hdl;
1464 zprop_expand_list_cb(int prop, void *cb)
1466 zprop_list_t *entry;
1467 expand_data_t *edp = cb;
1469 if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1470 return (ZPROP_INVAL);
1472 entry->pl_prop = prop;
1473 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1474 entry->pl_all = B_TRUE;
1476 *(edp->last) = entry;
1477 edp->last = &entry->pl_next;
1479 return (ZPROP_CONT);
1483 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1485 zprop_list_t *entry;
1486 zprop_list_t **last;
1491 * If this is the very first time we've been called for an 'all'
1492 * specification, expand the list to include all native
1501 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1502 B_FALSE, type) == ZPROP_INVAL)
1506 * Add 'name' to the beginning of the list, which is handled
1509 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1512 entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME :
1514 entry->pl_width = zprop_width(entry->pl_prop,
1515 &entry->pl_fixed, type);
1516 entry->pl_all = B_TRUE;
1517 entry->pl_next = *plp;
1524 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1527 return (zprop_iter_common(func, cb, show_all, ordered, type));