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"
60 libzfs_errno(libzfs_handle_t *hdl)
62 return (hdl->libzfs_error);
66 libzfs_error_action(libzfs_handle_t *hdl)
68 return (hdl->libzfs_action);
72 libzfs_error_description(libzfs_handle_t *hdl)
74 if (hdl->libzfs_desc[0] != '\0')
75 return (hdl->libzfs_desc);
77 switch (hdl->libzfs_error) {
79 return (dgettext(TEXT_DOMAIN, "out of memory"));
81 return (dgettext(TEXT_DOMAIN, "invalid property value"));
82 case EZFS_PROPREADONLY:
83 return (dgettext(TEXT_DOMAIN, "read-only property"));
85 return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
86 "datasets of this type"));
87 case EZFS_PROPNONINHERIT:
88 return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
90 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
92 return (dgettext(TEXT_DOMAIN, "operation not applicable to "
93 "datasets of this type"));
95 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
97 return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
99 return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
101 return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
102 case EZFS_DSREADONLY:
103 return (dgettext(TEXT_DOMAIN, "dataset is read-only"));
105 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
107 case EZFS_INVALIDNAME:
108 return (dgettext(TEXT_DOMAIN, "invalid name"));
109 case EZFS_BADRESTORE:
110 return (dgettext(TEXT_DOMAIN, "unable to restore to "
113 return (dgettext(TEXT_DOMAIN, "backup failed"));
115 return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
117 return (dgettext(TEXT_DOMAIN, "no such device in pool"));
119 return (dgettext(TEXT_DOMAIN, "invalid device"));
120 case EZFS_NOREPLICAS:
121 return (dgettext(TEXT_DOMAIN, "no valid replicas"));
122 case EZFS_RESILVERING:
123 return (dgettext(TEXT_DOMAIN, "currently resilvering"));
124 case EZFS_BADVERSION:
125 return (dgettext(TEXT_DOMAIN, "unsupported version or "
127 case EZFS_POOLUNAVAIL:
128 return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
129 case EZFS_DEVOVERFLOW:
130 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
132 return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
133 case EZFS_CROSSTARGET:
134 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
137 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
138 case EZFS_MOUNTFAILED:
139 return (dgettext(TEXT_DOMAIN, "mount failed"));
140 case EZFS_UMOUNTFAILED:
141 return (dgettext(TEXT_DOMAIN, "umount failed"));
142 case EZFS_UNSHARENFSFAILED:
143 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
144 case EZFS_SHARENFSFAILED:
145 return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
146 case EZFS_UNSHARESMBFAILED:
147 return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
148 case EZFS_SHARESMBFAILED:
149 return (dgettext(TEXT_DOMAIN, "smb add share failed"));
151 return (dgettext(TEXT_DOMAIN, "permission denied"));
153 return (dgettext(TEXT_DOMAIN, "out of space"));
155 return (dgettext(TEXT_DOMAIN, "bad address"));
157 return (dgettext(TEXT_DOMAIN, "I/O error"));
159 return (dgettext(TEXT_DOMAIN, "signal received"));
161 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
163 case EZFS_INVALCONFIG:
164 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
166 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
168 return (dgettext(TEXT_DOMAIN, "no history available"));
170 return (dgettext(TEXT_DOMAIN, "failed to retrieve "
172 case EZFS_POOL_NOTSUP:
173 return (dgettext(TEXT_DOMAIN, "operation not supported "
174 "on this type of pool"));
175 case EZFS_POOL_INVALARG:
176 return (dgettext(TEXT_DOMAIN, "invalid argument for "
177 "this pool operation"));
178 case EZFS_NAMETOOLONG:
179 return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
180 case EZFS_OPENFAILED:
181 return (dgettext(TEXT_DOMAIN, "open failed"));
183 return (dgettext(TEXT_DOMAIN,
184 "disk capacity information could not be retrieved"));
185 case EZFS_LABELFAILED:
186 return (dgettext(TEXT_DOMAIN, "write of label failed"));
188 return (dgettext(TEXT_DOMAIN, "invalid user/group"));
190 return (dgettext(TEXT_DOMAIN, "invalid permission"));
191 case EZFS_BADPERMSET:
192 return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
193 case EZFS_NODELEGATION:
194 return (dgettext(TEXT_DOMAIN, "delegated administration is "
195 "disabled on pool"));
197 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
199 return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
200 case EZFS_VDEVNOTSUP:
201 return (dgettext(TEXT_DOMAIN, "vdev specification is not "
204 return (dgettext(TEXT_DOMAIN, "operation not supported "
206 case EZFS_ACTIVE_SPARE:
207 return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
209 case EZFS_UNPLAYED_LOGS:
210 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
212 case EZFS_REFTAG_RELE:
213 return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
214 case EZFS_REFTAG_HOLD:
215 return (dgettext(TEXT_DOMAIN, "tag already exists on this "
217 case EZFS_TAGTOOLONG:
218 return (dgettext(TEXT_DOMAIN, "tag too long"));
219 case EZFS_PIPEFAILED:
220 return (dgettext(TEXT_DOMAIN, "pipe create failed"));
221 case EZFS_THREADCREATEFAILED:
222 return (dgettext(TEXT_DOMAIN, "thread create failed"));
223 case EZFS_POSTSPLIT_ONLINE:
224 return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
227 return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
228 "use 'zpool scrub -s' to cancel current scrub"));
230 return (dgettext(TEXT_DOMAIN, "there is no active scrub"));
232 return (dgettext(TEXT_DOMAIN, "unable to generate diffs"));
234 return (dgettext(TEXT_DOMAIN, "invalid diff data"));
235 case EZFS_POOLREADONLY:
236 return (dgettext(TEXT_DOMAIN, "pool is read-only"));
238 return (dgettext(TEXT_DOMAIN, "unknown error"));
240 assert(hdl->libzfs_error == 0);
241 return (dgettext(TEXT_DOMAIN, "no error"));
247 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
253 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
255 hdl->libzfs_desc_active = 1;
261 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
263 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
265 hdl->libzfs_error = error;
267 if (hdl->libzfs_desc_active)
268 hdl->libzfs_desc_active = 0;
270 hdl->libzfs_desc[0] = '\0';
272 if (hdl->libzfs_printerr) {
273 if (error == EZFS_UNKNOWN) {
274 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
275 "error: %s\n"), libzfs_error_description(hdl));
279 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
280 libzfs_error_description(hdl));
281 if (error == EZFS_NOMEM)
287 zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
289 return (zfs_error_fmt(hdl, error, "%s", msg));
294 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
300 zfs_verror(hdl, error, fmt, ap);
308 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
314 zfs_verror(hdl, EZFS_PERM, fmt, ap);
318 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
322 zfs_verror(hdl, EZFS_IO, fmt, ap);
326 zfs_verror(hdl, EZFS_FAULT, fmt, ap);
330 zfs_verror(hdl, EZFS_INTR, fmt, ap);
338 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
340 return (zfs_standard_error_fmt(hdl, error, "%s", msg));
345 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
351 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
360 zfs_verror(hdl, EZFS_IO, fmt, ap);
364 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
365 "dataset does not exist"));
366 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
371 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
375 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
376 "dataset already exists"));
377 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
381 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
383 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
386 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
389 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
392 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap);
395 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
396 "pool I/O is currently suspended"));
397 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
400 zfs_error_aux(hdl, strerror(error));
401 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
410 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
412 return (zpool_standard_error_fmt(hdl, error, "%s", msg));
417 zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
423 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
430 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
435 dgettext(TEXT_DOMAIN, "no such pool or dataset"));
436 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
440 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
441 "pool already exists"));
442 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
446 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
447 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
451 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
452 "one or more devices is currently unavailable"));
453 zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
457 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
461 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
465 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
470 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
474 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
475 "pool I/O is currently suspended"));
476 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
480 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
484 zfs_error_aux(hdl, strerror(error));
485 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
493 * Display an out of memory error message and abort the current program.
496 no_memory(libzfs_handle_t *hdl)
498 return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
502 * A safe form of malloc() which will die if the allocation fails.
505 zfs_alloc(libzfs_handle_t *hdl, size_t size)
509 if ((data = calloc(1, size)) == NULL)
510 (void) no_memory(hdl);
516 * A safe form of asprintf() which will die if the allocation fails.
520 zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...)
528 err = vasprintf(&ret, fmt, ap);
533 (void) no_memory(hdl);
539 * A safe form of realloc(), which also zeroes newly allocated space.
542 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
546 if ((ret = realloc(ptr, newsize)) == NULL) {
547 (void) no_memory(hdl);
551 bzero((char *)ret + oldsize, (newsize - oldsize));
556 * A safe form of strdup() which will die if the allocation fails.
559 zfs_strdup(libzfs_handle_t *hdl, const char *str)
563 if ((ret = strdup(str)) == NULL)
564 (void) no_memory(hdl);
570 * Convert a number to an appropriately human-readable output.
573 zfs_nicenum(uint64_t num, char *buf, size_t buflen)
584 u = " KMGTPE"[index];
587 (void) snprintf(buf, buflen, "%llu", n);
588 } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
590 * If this is an even multiple of the base, always display
591 * without any decimal precision.
593 (void) snprintf(buf, buflen, "%llu%c", n, u);
596 * We want to choose a precision that reflects the best choice
597 * for fitting in 5 characters. This can get rather tricky when
598 * we have numbers that are very close to an order of magnitude.
599 * For example, when displaying 10239 (which is really 9.999K),
600 * we want only a single place of precision for 10.0K. We could
601 * develop some complex heuristics for this, but it's much
602 * easier just to try each combination in turn.
605 for (i = 2; i >= 0; i--) {
606 if (snprintf(buf, buflen, "%.*f%c", i,
607 (double)num / (1ULL << 10 * index), u) <= 5)
614 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
616 hdl->libzfs_printerr = printerr;
624 if (modfind("zfs") < 0) {
625 /* Not present in kernel, try loading it. */
626 if (kldload("zfs") < 0 || modfind("zfs") < 0) {
637 libzfs_handle_t *hdl;
639 if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
643 if (libzfs_load() < 0) {
648 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
653 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
654 (void) close(hdl->libzfs_fd);
659 hdl->libzfs_sharetab = fopen(ZFS_EXPORTS_PATH, "r");
661 if (libzfs_core_init() != 0) {
662 (void) close(hdl->libzfs_fd);
663 (void) fclose(hdl->libzfs_mnttab);
664 (void) fclose(hdl->libzfs_sharetab);
671 zpool_feature_init();
672 libzfs_mnttab_init(hdl);
678 libzfs_fini(libzfs_handle_t *hdl)
680 (void) close(hdl->libzfs_fd);
681 if (hdl->libzfs_mnttab)
682 (void) fclose(hdl->libzfs_mnttab);
683 if (hdl->libzfs_sharetab)
684 (void) fclose(hdl->libzfs_sharetab);
685 zfs_uninit_libshare(hdl);
686 zpool_free_handles(hdl);
688 libzfs_fru_clear(hdl, B_TRUE);
690 namespace_clear(hdl);
691 libzfs_mnttab_fini(hdl);
697 zpool_get_handle(zpool_handle_t *zhp)
699 return (zhp->zpool_hdl);
703 zfs_get_handle(zfs_handle_t *zhp)
705 return (zhp->zfs_hdl);
709 zfs_get_pool_handle(const zfs_handle_t *zhp)
711 return (zhp->zpool_hdl);
715 * Given a name, determine whether or not it's a valid path
716 * (starts with '/' or "./"). If so, walk the mnttab trying
717 * to match the device number. If not, treat the path as an
721 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
723 struct stat64 statbuf;
724 struct extmnttab entry;
727 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
729 * It's not a valid path, assume it's a name of type 'argtype'.
731 return (zfs_open(hdl, path, argtype));
734 if (stat64(path, &statbuf) != 0) {
735 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
740 rewind(hdl->libzfs_mnttab);
741 while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
742 if (makedevice(entry.mnt_major, entry.mnt_minor) ==
751 ret = statfs(path, &sfs);
753 statfs2mnttab(&sfs, &entry);
755 (void) fprintf(stderr, "%s: %s\n", path,
764 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
765 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
770 return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
774 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
778 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
782 zc->zc_nvlist_dst_size = len;
783 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
784 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
791 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
792 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
793 * filled in by the kernel to indicate the actual required size.
796 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
798 free((void *)(uintptr_t)zc->zc_nvlist_dst);
799 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
800 zfs_alloc(hdl, zc->zc_nvlist_dst_size))
808 * Called to free the src and dst nvlists stored in the command structure.
811 zcmd_free_nvlists(zfs_cmd_t *zc)
813 free((void *)(uintptr_t)zc->zc_nvlist_conf);
814 free((void *)(uintptr_t)zc->zc_nvlist_src);
815 free((void *)(uintptr_t)zc->zc_nvlist_dst);
819 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
825 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
827 if ((packed = zfs_alloc(hdl, len)) == NULL)
830 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
832 *outnv = (uint64_t)(uintptr_t)packed;
839 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
841 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
842 &zc->zc_nvlist_conf_size, nvl));
846 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
848 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
849 &zc->zc_nvlist_src_size, nvl));
853 * Unpacks an nvlist from the ZFS ioctl command structure.
856 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
858 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
859 zc->zc_nvlist_dst_size, nvlp, 0) != 0)
860 return (no_memory(hdl));
866 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
868 return (ioctl(hdl->libzfs_fd, request, zc));
872 * ================================================================
873 * API shared by zfs and zpool property management
874 * ================================================================
878 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
880 zprop_list_t *pl = cbp->cb_proplist;
885 cbp->cb_first = B_FALSE;
886 if (cbp->cb_scripted)
890 * Start with the length of the column headers.
892 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
893 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
895 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
897 cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
899 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
902 /* first property is always NAME */
903 assert(cbp->cb_proplist->pl_prop ==
904 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME));
907 * Go through and calculate the widths for each column. For the
908 * 'source' column, we kludge it up by taking the worst-case scenario of
909 * inheriting from the longest name. This is acceptable because in the
910 * majority of cases 'SOURCE' is the last column displayed, and we don't
911 * use the width anyway. Note that the 'VALUE' column can be oversized,
912 * if the name of the property is much longer than any values we find.
914 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
918 if (pl->pl_prop != ZPROP_INVAL) {
919 const char *propname = (type == ZFS_TYPE_POOL) ?
920 zpool_prop_to_name(pl->pl_prop) :
921 zfs_prop_to_name(pl->pl_prop);
923 len = strlen(propname);
924 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
925 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
927 len = strlen(pl->pl_user_prop);
928 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
929 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
933 * 'VALUE' column. The first property is always the 'name'
934 * property that was tacked on either by /sbin/zfs's
935 * zfs_do_get() or when calling zprop_expand_list(), so we
936 * ignore its width. If the user specified the name property
937 * to display, then it will be later in the list in any case.
939 if (pl != cbp->cb_proplist &&
940 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
941 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
943 /* 'RECEIVED' column. */
944 if (pl != cbp->cb_proplist &&
945 pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
946 cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
949 * 'NAME' and 'SOURCE' columns
951 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
953 pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
954 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
955 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
956 strlen(dgettext(TEXT_DOMAIN, "inherited from"));
961 * Now go through and print the headers.
963 for (i = 0; i < ZFS_GET_NCOLS; i++) {
964 switch (cbp->cb_columns[i]) {
966 title = dgettext(TEXT_DOMAIN, "NAME");
968 case GET_COL_PROPERTY:
969 title = dgettext(TEXT_DOMAIN, "PROPERTY");
972 title = dgettext(TEXT_DOMAIN, "VALUE");
975 title = dgettext(TEXT_DOMAIN, "RECEIVED");
978 title = dgettext(TEXT_DOMAIN, "SOURCE");
985 if (i == (ZFS_GET_NCOLS - 1) ||
986 cbp->cb_columns[i + 1] == GET_COL_NONE)
987 (void) printf("%s", title);
989 (void) printf("%-*s ",
990 cbp->cb_colwidths[cbp->cb_columns[i]],
998 * Display a single line of output, according to the settings in the callback
1002 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
1003 const char *propname, const char *value, zprop_source_t sourcetype,
1004 const char *source, const char *recvd_value)
1011 * Ignore those source types that the user has chosen to ignore.
1013 if ((sourcetype & cbp->cb_sources) == 0)
1017 zprop_print_headers(cbp, cbp->cb_type);
1019 for (i = 0; i < ZFS_GET_NCOLS; i++) {
1020 switch (cbp->cb_columns[i]) {
1025 case GET_COL_PROPERTY:
1033 case GET_COL_SOURCE:
1034 switch (sourcetype) {
1035 case ZPROP_SRC_NONE:
1039 case ZPROP_SRC_DEFAULT:
1043 case ZPROP_SRC_LOCAL:
1047 case ZPROP_SRC_TEMPORARY:
1051 case ZPROP_SRC_INHERITED:
1052 (void) snprintf(buf, sizeof (buf),
1053 "inherited from %s", source);
1056 case ZPROP_SRC_RECEIVED:
1063 str = (recvd_value == NULL ? "-" : recvd_value);
1070 if (cbp->cb_columns[i + 1] == GET_COL_NONE)
1071 (void) printf("%s", str);
1072 else if (cbp->cb_scripted)
1073 (void) printf("%s\t", str);
1075 (void) printf("%-*s ",
1076 cbp->cb_colwidths[cbp->cb_columns[i]],
1080 (void) printf("\n");
1084 * Given a numeric suffix, convert the value into a number of bits that the
1085 * resulting value must be shifted.
1088 str2shift(libzfs_handle_t *hdl, const char *buf)
1090 const char *ends = "BKMGTPEZ";
1095 for (i = 0; i < strlen(ends); i++) {
1096 if (toupper(buf[0]) == ends[i])
1099 if (i == strlen(ends)) {
1100 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1101 "invalid numeric suffix '%s'"), buf);
1106 * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't
1107 * allow 'BB' - that's just weird.
1109 if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' &&
1110 toupper(buf[0]) != 'B'))
1113 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1114 "invalid numeric suffix '%s'"), buf);
1119 * Convert a string of the form '100G' into a real number. Used when setting
1120 * properties or creating a volume. 'buf' is used to place an extended error
1121 * message for the caller to use.
1124 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1131 /* Check to see if this looks like a number. */
1132 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1134 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1135 "bad numeric value '%s'"), value);
1139 /* Rely on strtoull() to process the numeric portion. */
1141 *num = strtoull(value, &end, 10);
1144 * Check for ERANGE, which indicates that the value is too large to fit
1145 * in a 64-bit value.
1147 if (errno == ERANGE) {
1149 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1150 "numeric value is too large"));
1155 * If we have a decimal value, then do the computation with floating
1156 * point arithmetic. Otherwise, use standard arithmetic.
1159 double fval = strtod(value, &end);
1161 if ((shift = str2shift(hdl, end)) == -1)
1164 fval *= pow(2, shift);
1166 if (fval > UINT64_MAX) {
1168 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1169 "numeric value is too large"));
1173 *num = (uint64_t)fval;
1175 if ((shift = str2shift(hdl, end)) == -1)
1178 /* Check for overflow */
1179 if (shift >= 64 || (*num << shift) >> shift != *num) {
1181 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1182 "numeric value is too large"));
1193 * Given a propname=value nvpair to set, parse any numeric properties
1194 * (index, boolean, etc) if they are specified as strings and add the
1195 * resulting nvpair to the returned nvlist.
1197 * At the DSL layer, all properties are either 64-bit numbers or strings.
1198 * We want the user to be able to ignore this fact and specify properties
1199 * as native values (numbers, for example) or as strings (to simplify
1200 * command line utilities). This also handles converting index types
1201 * (compression, checksum, etc) from strings to their on-disk index.
1204 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1205 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1208 data_type_t datatype = nvpair_type(elem);
1209 zprop_type_t proptype;
1210 const char *propname;
1212 boolean_t isnone = B_FALSE;
1214 if (type == ZFS_TYPE_POOL) {
1215 proptype = zpool_prop_get_type(prop);
1216 propname = zpool_prop_to_name(prop);
1218 proptype = zfs_prop_get_type(prop);
1219 propname = zfs_prop_to_name(prop);
1223 * Convert any properties to the internal DSL value types.
1229 case PROP_TYPE_STRING:
1230 if (datatype != DATA_TYPE_STRING) {
1231 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1232 "'%s' must be a string"), nvpair_name(elem));
1235 (void) nvpair_value_string(elem, svalp);
1236 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1237 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1238 "'%s' is too long"), nvpair_name(elem));
1243 case PROP_TYPE_NUMBER:
1244 if (datatype == DATA_TYPE_STRING) {
1245 (void) nvpair_value_string(elem, &value);
1246 if (strcmp(value, "none") == 0) {
1248 } else if (zfs_nicestrtonum(hdl, value, ivalp)
1252 } else if (datatype == DATA_TYPE_UINT64) {
1253 (void) nvpair_value_uint64(elem, ivalp);
1255 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1256 "'%s' must be a number"), nvpair_name(elem));
1261 * Quota special: force 'none' and don't allow 0.
1263 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1264 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1265 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1266 "use 'none' to disable quota/refquota"));
1271 * Special handling for "*_limit=none". In this case it's not
1274 if ((type & ZFS_TYPE_DATASET) && isnone &&
1275 (prop == ZFS_PROP_FILESYSTEM_LIMIT ||
1276 prop == ZFS_PROP_SNAPSHOT_LIMIT)) {
1277 *ivalp = UINT64_MAX;
1281 case PROP_TYPE_INDEX:
1282 if (datatype != DATA_TYPE_STRING) {
1283 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1284 "'%s' must be a string"), nvpair_name(elem));
1288 (void) nvpair_value_string(elem, &value);
1290 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1291 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1292 "'%s' must be one of '%s'"), propname,
1293 zprop_values(prop, type));
1303 * Add the result to our return set of properties.
1305 if (*svalp != NULL) {
1306 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1307 (void) no_memory(hdl);
1311 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1312 (void) no_memory(hdl);
1319 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1324 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1328 zprop_list_t *entry;
1330 prop = zprop_name_to_prop(propname, type);
1332 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1336 * When no property table entry can be found, return failure if
1337 * this is a pool property or if this isn't a user-defined
1340 if (prop == ZPROP_INVAL && ((type == ZFS_TYPE_POOL &&
1341 !zpool_prop_feature(propname) &&
1342 !zpool_prop_unsupported(propname)) ||
1343 (type == ZFS_TYPE_DATASET && !zfs_prop_user(propname) &&
1344 !zfs_prop_userquota(propname) && !zfs_prop_written(propname)))) {
1345 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1346 "invalid property '%s'"), propname);
1347 return (zfs_error(hdl, EZFS_BADPROP,
1348 dgettext(TEXT_DOMAIN, "bad property list")));
1351 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1354 entry->pl_prop = prop;
1355 if (prop == ZPROP_INVAL) {
1356 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) ==
1361 entry->pl_width = strlen(propname);
1363 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1373 * Given a comma-separated list of properties, construct a property list
1374 * containing both user-defined and native properties. This function will
1375 * return a NULL list if 'all' is specified, which can later be expanded
1376 * by zprop_expand_list().
1379 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1385 * If 'all' is specified, return a NULL list.
1387 if (strcmp(props, "all") == 0)
1391 * If no props were specified, return an error.
1393 if (props[0] == '\0') {
1394 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1395 "no properties specified"));
1396 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1397 "bad property list")));
1401 * It would be nice to use getsubopt() here, but the inclusion of column
1402 * aliases makes this more effort than it's worth.
1404 while (*props != '\0') {
1409 if ((p = strchr(props, ',')) == NULL) {
1410 len = strlen(props);
1417 * Check for empty options.
1420 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1421 "empty property name"));
1422 return (zfs_error(hdl, EZFS_BADPROP,
1423 dgettext(TEXT_DOMAIN, "bad property list")));
1427 * Check all regular property names.
1432 if (strcmp(props, "space") == 0) {
1433 static char *spaceprops[] = {
1434 "name", "avail", "used", "usedbysnapshots",
1435 "usedbydataset", "usedbyrefreservation",
1436 "usedbychildren", NULL
1440 for (i = 0; spaceprops[i]; i++) {
1441 if (addlist(hdl, spaceprops[i], listp, type))
1443 listp = &(*listp)->pl_next;
1446 if (addlist(hdl, props, listp, type))
1448 listp = &(*listp)->pl_next;
1460 zprop_free_list(zprop_list_t *pl)
1464 while (pl != NULL) {
1466 free(pl->pl_user_prop);
1472 typedef struct expand_data {
1473 zprop_list_t **last;
1474 libzfs_handle_t *hdl;
1479 zprop_expand_list_cb(int prop, void *cb)
1481 zprop_list_t *entry;
1482 expand_data_t *edp = cb;
1484 if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1485 return (ZPROP_INVAL);
1487 entry->pl_prop = prop;
1488 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1489 entry->pl_all = B_TRUE;
1491 *(edp->last) = entry;
1492 edp->last = &entry->pl_next;
1494 return (ZPROP_CONT);
1498 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1500 zprop_list_t *entry;
1501 zprop_list_t **last;
1506 * If this is the very first time we've been called for an 'all'
1507 * specification, expand the list to include all native
1516 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1517 B_FALSE, type) == ZPROP_INVAL)
1521 * Add 'name' to the beginning of the list, which is handled
1524 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1527 entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME :
1529 entry->pl_width = zprop_width(entry->pl_prop,
1530 &entry->pl_fixed, type);
1531 entry->pl_all = B_TRUE;
1532 entry->pl_next = *plp;
1539 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1542 return (zprop_iter_common(func, cb, show_all, ordered, type));