4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
26 * Internal utility routines for the ZFS library.
40 #include <sys/mnttab.h>
41 #include <sys/mntent.h>
42 #include <sys/types.h>
47 #include "libzfs_impl.h"
51 libzfs_errno(libzfs_handle_t *hdl)
53 return (hdl->libzfs_error);
57 libzfs_error_action(libzfs_handle_t *hdl)
59 return (hdl->libzfs_action);
63 libzfs_error_description(libzfs_handle_t *hdl)
65 if (hdl->libzfs_desc[0] != '\0')
66 return (hdl->libzfs_desc);
68 switch (hdl->libzfs_error) {
70 return (dgettext(TEXT_DOMAIN, "out of memory"));
72 return (dgettext(TEXT_DOMAIN, "invalid property value"));
73 case EZFS_PROPREADONLY:
74 return (dgettext(TEXT_DOMAIN, "read-only property"));
76 return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
77 "datasets of this type"));
78 case EZFS_PROPNONINHERIT:
79 return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
81 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
83 return (dgettext(TEXT_DOMAIN, "operation not applicable to "
84 "datasets of this type"));
86 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
88 return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
90 return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
92 return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
94 return (dgettext(TEXT_DOMAIN, "dataset is read-only"));
96 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
98 case EZFS_INVALIDNAME:
99 return (dgettext(TEXT_DOMAIN, "invalid name"));
100 case EZFS_BADRESTORE:
101 return (dgettext(TEXT_DOMAIN, "unable to restore to "
104 return (dgettext(TEXT_DOMAIN, "backup failed"));
106 return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
108 return (dgettext(TEXT_DOMAIN, "no such device in pool"));
110 return (dgettext(TEXT_DOMAIN, "invalid device"));
111 case EZFS_NOREPLICAS:
112 return (dgettext(TEXT_DOMAIN, "no valid replicas"));
113 case EZFS_RESILVERING:
114 return (dgettext(TEXT_DOMAIN, "currently resilvering"));
115 case EZFS_BADVERSION:
116 return (dgettext(TEXT_DOMAIN, "unsupported version"));
117 case EZFS_POOLUNAVAIL:
118 return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
119 case EZFS_DEVOVERFLOW:
120 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
122 return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
123 case EZFS_CROSSTARGET:
124 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
127 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
128 case EZFS_MOUNTFAILED:
129 return (dgettext(TEXT_DOMAIN, "mount failed"));
130 case EZFS_UMOUNTFAILED:
131 return (dgettext(TEXT_DOMAIN, "umount failed"));
132 case EZFS_UNSHARENFSFAILED:
133 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
134 case EZFS_SHARENFSFAILED:
135 return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
136 case EZFS_UNSHARESMBFAILED:
137 return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
138 case EZFS_SHARESMBFAILED:
139 return (dgettext(TEXT_DOMAIN, "smb add share failed"));
141 return (dgettext(TEXT_DOMAIN, "permission denied"));
143 return (dgettext(TEXT_DOMAIN, "out of space"));
145 return (dgettext(TEXT_DOMAIN, "bad address"));
147 return (dgettext(TEXT_DOMAIN, "I/O error"));
149 return (dgettext(TEXT_DOMAIN, "signal received"));
151 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
153 case EZFS_INVALCONFIG:
154 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
156 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
158 return (dgettext(TEXT_DOMAIN, "no history available"));
160 return (dgettext(TEXT_DOMAIN, "failed to retrieve "
162 case EZFS_POOL_NOTSUP:
163 return (dgettext(TEXT_DOMAIN, "operation not supported "
164 "on this type of pool"));
165 case EZFS_POOL_INVALARG:
166 return (dgettext(TEXT_DOMAIN, "invalid argument for "
167 "this pool operation"));
168 case EZFS_NAMETOOLONG:
169 return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
170 case EZFS_OPENFAILED:
171 return (dgettext(TEXT_DOMAIN, "open failed"));
173 return (dgettext(TEXT_DOMAIN,
174 "disk capacity information could not be retrieved"));
175 case EZFS_LABELFAILED:
176 return (dgettext(TEXT_DOMAIN, "write of label failed"));
178 return (dgettext(TEXT_DOMAIN, "invalid user/group"));
180 return (dgettext(TEXT_DOMAIN, "invalid permission"));
181 case EZFS_BADPERMSET:
182 return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
183 case EZFS_NODELEGATION:
184 return (dgettext(TEXT_DOMAIN, "delegated administration is "
185 "disabled on pool"));
187 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
189 return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
190 case EZFS_VDEVNOTSUP:
191 return (dgettext(TEXT_DOMAIN, "vdev specification is not "
194 return (dgettext(TEXT_DOMAIN, "operation not supported "
196 case EZFS_ACTIVE_SPARE:
197 return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
199 case EZFS_UNPLAYED_LOGS:
200 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
202 case EZFS_REFTAG_RELE:
203 return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
204 case EZFS_REFTAG_HOLD:
205 return (dgettext(TEXT_DOMAIN, "tag already exists on this "
207 case EZFS_TAGTOOLONG:
208 return (dgettext(TEXT_DOMAIN, "tag too long"));
209 case EZFS_PIPEFAILED:
210 return (dgettext(TEXT_DOMAIN, "pipe create failed"));
211 case EZFS_THREADCREATEFAILED:
212 return (dgettext(TEXT_DOMAIN, "thread create failed"));
213 case EZFS_POSTSPLIT_ONLINE:
214 return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
217 return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
218 "use 'zpool scrub -s' to cancel current scrub"));
220 return (dgettext(TEXT_DOMAIN, "there is no active scrub"));
222 return (dgettext(TEXT_DOMAIN, "unable to generate diffs"));
224 return (dgettext(TEXT_DOMAIN, "invalid diff data"));
225 case EZFS_POOLREADONLY:
226 return (dgettext(TEXT_DOMAIN, "pool is read-only"));
228 return (dgettext(TEXT_DOMAIN, "unknown error"));
230 assert(hdl->libzfs_error == 0);
231 return (dgettext(TEXT_DOMAIN, "no error"));
237 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
243 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
245 hdl->libzfs_desc_active = 1;
251 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
253 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
255 hdl->libzfs_error = error;
257 if (hdl->libzfs_desc_active)
258 hdl->libzfs_desc_active = 0;
260 hdl->libzfs_desc[0] = '\0';
262 if (hdl->libzfs_printerr) {
263 if (error == EZFS_UNKNOWN) {
264 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
265 "error: %s\n"), libzfs_error_description(hdl));
269 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
270 libzfs_error_description(hdl));
271 if (error == EZFS_NOMEM)
277 zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
279 return (zfs_error_fmt(hdl, error, "%s", msg));
284 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
290 zfs_verror(hdl, error, fmt, ap);
298 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
304 zfs_verror(hdl, EZFS_PERM, fmt, ap);
308 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
312 zfs_verror(hdl, EZFS_IO, fmt, ap);
316 zfs_verror(hdl, EZFS_FAULT, fmt, ap);
320 zfs_verror(hdl, EZFS_INTR, fmt, ap);
328 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
330 return (zfs_standard_error_fmt(hdl, error, "%s", msg));
335 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
341 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
349 zfs_verror(hdl, EZFS_IO, fmt, ap);
353 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
354 "dataset does not exist"));
355 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
360 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
364 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
365 "dataset already exists"));
366 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
370 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
372 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
375 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
378 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
381 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap);
384 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
385 "pool I/O is currently suspended"));
386 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
389 zfs_error_aux(hdl, strerror(error));
390 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
399 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
401 return (zpool_standard_error_fmt(hdl, error, "%s", msg));
406 zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
412 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
419 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
424 dgettext(TEXT_DOMAIN, "no such pool or dataset"));
425 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
429 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
430 "pool already exists"));
431 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
435 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
436 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
440 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
441 "one or more devices is currently unavailable"));
442 zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
446 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
450 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
454 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
459 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
463 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
464 "pool I/O is currently suspended"));
465 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
469 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
473 zfs_error_aux(hdl, strerror(error));
474 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
482 * Display an out of memory error message and abort the current program.
485 no_memory(libzfs_handle_t *hdl)
487 return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
491 * A safe form of malloc() which will die if the allocation fails.
494 zfs_alloc(libzfs_handle_t *hdl, size_t size)
498 if ((data = calloc(1, size)) == NULL)
499 (void) no_memory(hdl);
505 * A safe form of asprintf() which will die if the allocation fails.
509 zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...)
517 err = vasprintf(&ret, fmt, ap);
522 (void) no_memory(hdl);
528 * A safe form of realloc(), which also zeroes newly allocated space.
531 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
535 if ((ret = realloc(ptr, newsize)) == NULL) {
536 (void) no_memory(hdl);
540 bzero((char *)ret + oldsize, (newsize - oldsize));
545 * A safe form of strdup() which will die if the allocation fails.
548 zfs_strdup(libzfs_handle_t *hdl, const char *str)
552 if ((ret = strdup(str)) == NULL)
553 (void) no_memory(hdl);
559 * Convert a number to an appropriately human-readable output.
562 zfs_nicenum(uint64_t num, char *buf, size_t buflen)
573 u = " KMGTPE"[index];
576 (void) snprintf(buf, buflen, "%llu", (u_longlong_t) n);
577 } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
579 * If this is an even multiple of the base, always display
580 * without any decimal precision.
582 (void) snprintf(buf, buflen, "%llu%c", (u_longlong_t) n, u);
585 * We want to choose a precision that reflects the best choice
586 * for fitting in 5 characters. This can get rather tricky when
587 * we have numbers that are very close to an order of magnitude.
588 * For example, when displaying 10239 (which is really 9.999K),
589 * we want only a single place of precision for 10.0K. We could
590 * develop some complex heuristics for this, but it's much
591 * easier just to try each combination in turn.
594 for (i = 2; i >= 0; i--) {
595 if (snprintf(buf, buflen, "%.*f%c", i,
596 (double)num / (1ULL << 10 * index), u) <= 5)
603 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
605 hdl->libzfs_printerr = printerr;
609 libzfs_module_loaded(const char *module)
615 f = fopen("/proc/modules", "r");
619 while (fgets(name, sizeof(name), f)) {
620 char *c = strchr(name, ' ');
624 if (strcmp(module, name) == 0) {
635 libzfs_run_process(const char *path, char *argv[])
644 (void) execvp(path, argv);
646 } else if (pid > 0) {
649 while ((rc = waitpid(pid, &status, 0)) == -1 &&
651 if (rc < 0 || !WIFEXITED(status))
654 return WEXITSTATUS(status);
661 libzfs_load_module(const char *module)
663 char *argv[4] = {"/sbin/modprobe", "-q", (char *)module, (char *)0};
665 if (libzfs_module_loaded(module))
668 return libzfs_run_process("/sbin/modprobe", argv);
674 libzfs_handle_t *hdl;
676 if (libzfs_load_module("zfs") != 0) {
677 (void) fprintf(stderr, gettext("Failed to load ZFS module "
678 "stack.\nLoad the module manually by running "
679 "'insmod <location>/zfs.ko' as root.\n"));
683 if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
687 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
688 (void) fprintf(stderr, gettext("Unable to open %s: %s.\n"),
689 ZFS_DEV, strerror(errno));
691 (void) fprintf(stderr,
692 gettext("Verify the ZFS module stack is "
693 "loaded by running '/sbin/modprobe zfs'.\n"));
699 #ifdef HAVE_SETMNTENT
700 if ((hdl->libzfs_mnttab = setmntent(MNTTAB, "r")) == NULL) {
702 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
704 (void) close(hdl->libzfs_fd);
709 hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
713 libzfs_mnttab_init(hdl);
719 libzfs_fini(libzfs_handle_t *hdl)
721 (void) close(hdl->libzfs_fd);
722 if (hdl->libzfs_mnttab)
723 #ifdef HAVE_SETMNTENT
724 (void) endmntent(hdl->libzfs_mnttab);
726 (void) fclose(hdl->libzfs_mnttab);
728 if (hdl->libzfs_sharetab)
729 (void) fclose(hdl->libzfs_sharetab);
730 zfs_uninit_libshare(hdl);
731 if (hdl->libzfs_log_str)
732 (void) free(hdl->libzfs_log_str);
733 zpool_free_handles(hdl);
734 libzfs_fru_clear(hdl, B_TRUE);
735 namespace_clear(hdl);
736 libzfs_mnttab_fini(hdl);
741 zpool_get_handle(zpool_handle_t *zhp)
743 return (zhp->zpool_hdl);
747 zfs_get_handle(zfs_handle_t *zhp)
749 return (zhp->zfs_hdl);
753 zfs_get_pool_handle(const zfs_handle_t *zhp)
755 return (zhp->zpool_hdl);
759 * Given a name, determine whether or not it's a valid path
760 * (starts with '/' or "./"). If so, walk the mnttab trying
761 * to match the device number. If not, treat the path as an
765 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
767 struct stat64 statbuf;
768 struct extmnttab entry;
771 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
773 * It's not a valid path, assume it's a name of type 'argtype'.
775 return (zfs_open(hdl, path, argtype));
778 if (stat64(path, &statbuf) != 0) {
779 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
783 rewind(hdl->libzfs_mnttab);
784 while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
785 if (makedevice(entry.mnt_major, entry.mnt_minor) ==
794 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
795 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
800 return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
804 * Given a shorthand device name, check if a file by that name exists in a list
805 * of directories under /dev. If one is found, store its full path in the
806 * buffer pointed to by the path argument and return 0, else return -1. The
807 * path buffer must be allocated by the caller.
810 zfs_resolve_shortname(const char *name, char *path, size_t pathlen)
813 char dirs[5][9] = {"by-id", "by-label", "by-path", "by-uuid", "zpool"};
815 (void) snprintf(path, pathlen, "%s/%s", DISK_ROOT, name);
816 err = access(path, F_OK);
817 for (i = 0; i < 5 && err < 0; i++) {
818 (void) snprintf(path, pathlen, "%s/%s/%s",
819 UDISK_ROOT, dirs[i], name);
820 err = access(path, F_OK);
826 * Append partition suffix to a device path. This should be used to generate
827 * the name of a whole disk as it is stored in the vdev label. The
828 * user-visible names of whole disks do not contain the partition information.
829 * Modifies buf which must be allocated by the caller.
832 zfs_append_partition(const char *path, char *buf, size_t buflen)
834 if (strncmp(path, UDISK_ROOT, strlen(UDISK_ROOT)) == 0)
835 (void) snprintf(buf, buflen, "%s%s%s", path, "-part",
838 (void) snprintf(buf, buflen, "%s%s%s", path,
839 isdigit(path[strlen(path)-1]) ? "p" : "",
844 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
848 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
852 zc->zc_nvlist_dst_size = len;
853 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
854 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
861 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
862 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
863 * filled in by the kernel to indicate the actual required size.
866 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
868 free((void *)(uintptr_t)zc->zc_nvlist_dst);
869 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
870 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
877 * Called to free the src and dst nvlists stored in the command structure.
880 zcmd_free_nvlists(zfs_cmd_t *zc)
882 free((void *)(uintptr_t)zc->zc_nvlist_conf);
883 free((void *)(uintptr_t)zc->zc_nvlist_src);
884 free((void *)(uintptr_t)zc->zc_nvlist_dst);
888 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
894 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
896 if ((packed = zfs_alloc(hdl, len)) == NULL)
899 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
901 *outnv = (uint64_t)(uintptr_t)packed;
908 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
910 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
911 &zc->zc_nvlist_conf_size, nvl));
915 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
917 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
918 &zc->zc_nvlist_src_size, nvl));
922 * Unpacks an nvlist from the ZFS ioctl command structure.
925 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
927 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
928 zc->zc_nvlist_dst_size, nvlp, 0) != 0)
929 return (no_memory(hdl));
935 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
939 zc->zc_history = (uint64_t)(uintptr_t)hdl->libzfs_log_str;
940 error = ioctl(hdl->libzfs_fd, request, zc);
941 if (hdl->libzfs_log_str) {
942 free(hdl->libzfs_log_str);
943 hdl->libzfs_log_str = NULL;
951 * ================================================================
952 * API shared by zfs and zpool property management
953 * ================================================================
957 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
959 zprop_list_t *pl = cbp->cb_proplist;
964 cbp->cb_first = B_FALSE;
965 if (cbp->cb_scripted)
969 * Start with the length of the column headers.
971 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
972 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
974 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
976 cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
978 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
981 /* first property is always NAME */
982 assert(cbp->cb_proplist->pl_prop ==
983 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME));
986 * Go through and calculate the widths for each column. For the
987 * 'source' column, we kludge it up by taking the worst-case scenario of
988 * inheriting from the longest name. This is acceptable because in the
989 * majority of cases 'SOURCE' is the last column displayed, and we don't
990 * use the width anyway. Note that the 'VALUE' column can be oversized,
991 * if the name of the property is much longer than any values we find.
993 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
997 if (pl->pl_prop != ZPROP_INVAL) {
998 const char *propname = (type == ZFS_TYPE_POOL) ?
999 zpool_prop_to_name(pl->pl_prop) :
1000 zfs_prop_to_name(pl->pl_prop);
1002 len = strlen(propname);
1003 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
1004 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
1006 len = strlen(pl->pl_user_prop);
1007 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
1008 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
1012 * 'VALUE' column. The first property is always the 'name'
1013 * property that was tacked on either by /sbin/zfs's
1014 * zfs_do_get() or when calling zprop_expand_list(), so we
1015 * ignore its width. If the user specified the name property
1016 * to display, then it will be later in the list in any case.
1018 if (pl != cbp->cb_proplist &&
1019 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
1020 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
1022 /* 'RECEIVED' column. */
1023 if (pl != cbp->cb_proplist &&
1024 pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
1025 cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
1028 * 'NAME' and 'SOURCE' columns
1030 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
1032 pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
1033 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
1034 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
1035 strlen(dgettext(TEXT_DOMAIN, "inherited from"));
1040 * Now go through and print the headers.
1042 for (i = 0; i < ZFS_GET_NCOLS; i++) {
1043 switch (cbp->cb_columns[i]) {
1045 title = dgettext(TEXT_DOMAIN, "NAME");
1047 case GET_COL_PROPERTY:
1048 title = dgettext(TEXT_DOMAIN, "PROPERTY");
1051 title = dgettext(TEXT_DOMAIN, "VALUE");
1054 title = dgettext(TEXT_DOMAIN, "RECEIVED");
1056 case GET_COL_SOURCE:
1057 title = dgettext(TEXT_DOMAIN, "SOURCE");
1063 if (title != NULL) {
1064 if (i == (ZFS_GET_NCOLS - 1) ||
1065 cbp->cb_columns[i + 1] == GET_COL_NONE)
1066 (void) printf("%s", title);
1068 (void) printf("%-*s ",
1069 cbp->cb_colwidths[cbp->cb_columns[i]],
1073 (void) printf("\n");
1077 * Display a single line of output, according to the settings in the callback
1081 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
1082 const char *propname, const char *value, zprop_source_t sourcetype,
1083 const char *source, const char *recvd_value)
1086 const char *str = NULL;
1090 * Ignore those source types that the user has chosen to ignore.
1092 if ((sourcetype & cbp->cb_sources) == 0)
1096 zprop_print_headers(cbp, cbp->cb_type);
1098 for (i = 0; i < ZFS_GET_NCOLS; i++) {
1099 switch (cbp->cb_columns[i]) {
1104 case GET_COL_PROPERTY:
1112 case GET_COL_SOURCE:
1113 switch (sourcetype) {
1114 case ZPROP_SRC_NONE:
1118 case ZPROP_SRC_DEFAULT:
1122 case ZPROP_SRC_LOCAL:
1126 case ZPROP_SRC_TEMPORARY:
1130 case ZPROP_SRC_INHERITED:
1131 (void) snprintf(buf, sizeof (buf),
1132 "inherited from %s", source);
1135 case ZPROP_SRC_RECEIVED:
1142 str = (recvd_value == NULL ? "-" : recvd_value);
1149 if (cbp->cb_columns[i + 1] == GET_COL_NONE)
1150 (void) printf("%s", str);
1151 else if (cbp->cb_scripted)
1152 (void) printf("%s\t", str);
1154 (void) printf("%-*s ",
1155 cbp->cb_colwidths[cbp->cb_columns[i]],
1159 (void) printf("\n");
1163 * Given a numeric suffix, convert the value into a number of bits that the
1164 * resulting value must be shifted.
1167 str2shift(libzfs_handle_t *hdl, const char *buf)
1169 const char *ends = "BKMGTPEZ";
1174 for (i = 0; i < strlen(ends); i++) {
1175 if (toupper(buf[0]) == ends[i])
1178 if (i == strlen(ends)) {
1179 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1180 "invalid numeric suffix '%s'"), buf);
1185 * We want to allow trailing 'b' characters for 'GB' or 'Mb'. But don't
1186 * allow 'BB' - that's just weird.
1188 if (buf[1] == '\0' || (toupper(buf[1]) == 'B' && buf[2] == '\0' &&
1189 toupper(buf[0]) != 'B'))
1192 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1193 "invalid numeric suffix '%s'"), buf);
1198 * Convert a string of the form '100G' into a real number. Used when setting
1199 * properties or creating a volume. 'buf' is used to place an extended error
1200 * message for the caller to use.
1203 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1210 /* Check to see if this looks like a number. */
1211 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1213 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1214 "bad numeric value '%s'"), value);
1218 /* Rely on strtoull() to process the numeric portion. */
1220 *num = strtoull(value, &end, 10);
1223 * Check for ERANGE, which indicates that the value is too large to fit
1224 * in a 64-bit value.
1226 if (errno == ERANGE) {
1228 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1229 "numeric value is too large"));
1234 * If we have a decimal value, then do the computation with floating
1235 * point arithmetic. Otherwise, use standard arithmetic.
1238 double fval = strtod(value, &end);
1240 if ((shift = str2shift(hdl, end)) == -1)
1243 fval *= pow(2, shift);
1245 if (fval > UINT64_MAX) {
1247 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1248 "numeric value is too large"));
1252 *num = (uint64_t)fval;
1254 if ((shift = str2shift(hdl, end)) == -1)
1257 /* Check for overflow */
1258 if (shift >= 64 || (*num << shift) >> shift != *num) {
1260 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1261 "numeric value is too large"));
1272 * Given a propname=value nvpair to set, parse any numeric properties
1273 * (index, boolean, etc) if they are specified as strings and add the
1274 * resulting nvpair to the returned nvlist.
1276 * At the DSL layer, all properties are either 64-bit numbers or strings.
1277 * We want the user to be able to ignore this fact and specify properties
1278 * as native values (numbers, for example) or as strings (to simplify
1279 * command line utilities). This also handles converting index types
1280 * (compression, checksum, etc) from strings to their on-disk index.
1283 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1284 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1287 data_type_t datatype = nvpair_type(elem);
1288 zprop_type_t proptype;
1289 const char *propname;
1291 boolean_t isnone = B_FALSE;
1293 if (type == ZFS_TYPE_POOL) {
1294 proptype = zpool_prop_get_type(prop);
1295 propname = zpool_prop_to_name(prop);
1297 proptype = zfs_prop_get_type(prop);
1298 propname = zfs_prop_to_name(prop);
1302 * Convert any properties to the internal DSL value types.
1308 case PROP_TYPE_STRING:
1309 if (datatype != DATA_TYPE_STRING) {
1310 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1311 "'%s' must be a string"), nvpair_name(elem));
1314 (void) nvpair_value_string(elem, svalp);
1315 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1316 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1317 "'%s' is too long"), nvpair_name(elem));
1322 case PROP_TYPE_NUMBER:
1323 if (datatype == DATA_TYPE_STRING) {
1324 (void) nvpair_value_string(elem, &value);
1325 if (strcmp(value, "none") == 0) {
1327 } else if (zfs_nicestrtonum(hdl, value, ivalp)
1331 } else if (datatype == DATA_TYPE_UINT64) {
1332 (void) nvpair_value_uint64(elem, ivalp);
1334 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1335 "'%s' must be a number"), nvpair_name(elem));
1340 * Quota special: force 'none' and don't allow 0.
1342 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1343 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1344 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1345 "use 'none' to disable quota/refquota"));
1350 case PROP_TYPE_INDEX:
1351 if (datatype != DATA_TYPE_STRING) {
1352 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1353 "'%s' must be a string"), nvpair_name(elem));
1357 (void) nvpair_value_string(elem, &value);
1359 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1360 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1361 "'%s' must be one of '%s'"), propname,
1362 zprop_values(prop, type));
1372 * Add the result to our return set of properties.
1374 if (*svalp != NULL) {
1375 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1376 (void) no_memory(hdl);
1380 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1381 (void) no_memory(hdl);
1388 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1393 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1397 zprop_list_t *entry;
1399 prop = zprop_name_to_prop(propname, type);
1401 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1405 * When no property table entry can be found, return failure if
1406 * this is a pool property or if this isn't a user-defined
1409 if (prop == ZPROP_INVAL && (type == ZFS_TYPE_POOL ||
1410 (!zfs_prop_user(propname) && !zfs_prop_userquota(propname)))) {
1411 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1412 "invalid property '%s'"), propname);
1413 return (zfs_error(hdl, EZFS_BADPROP,
1414 dgettext(TEXT_DOMAIN, "bad property list")));
1417 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1420 entry->pl_prop = prop;
1421 if (prop == ZPROP_INVAL) {
1422 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) == NULL) {
1426 entry->pl_width = strlen(propname);
1428 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1438 * Given a comma-separated list of properties, construct a property list
1439 * containing both user-defined and native properties. This function will
1440 * return a NULL list if 'all' is specified, which can later be expanded
1441 * by zprop_expand_list().
1444 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1450 * If 'all' is specified, return a NULL list.
1452 if (strcmp(props, "all") == 0)
1456 * If no props were specified, return an error.
1458 if (props[0] == '\0') {
1459 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1460 "no properties specified"));
1461 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1462 "bad property list")));
1466 * It would be nice to use getsubopt() here, but the inclusion of column
1467 * aliases makes this more effort than it's worth.
1469 while (*props != '\0') {
1474 if ((p = strchr(props, ',')) == NULL) {
1475 len = strlen(props);
1482 * Check for empty options.
1485 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1486 "empty property name"));
1487 return (zfs_error(hdl, EZFS_BADPROP,
1488 dgettext(TEXT_DOMAIN, "bad property list")));
1492 * Check all regular property names.
1497 if (strcmp(props, "space") == 0) {
1498 static char *spaceprops[] = {
1499 "name", "avail", "used", "usedbysnapshots",
1500 "usedbydataset", "usedbyrefreservation",
1501 "usedbychildren", NULL
1505 for (i = 0; spaceprops[i]; i++) {
1506 if (addlist(hdl, spaceprops[i], listp, type))
1508 listp = &(*listp)->pl_next;
1511 if (addlist(hdl, props, listp, type))
1513 listp = &(*listp)->pl_next;
1525 zprop_free_list(zprop_list_t *pl)
1529 while (pl != NULL) {
1531 free(pl->pl_user_prop);
1537 typedef struct expand_data {
1538 zprop_list_t **last;
1539 libzfs_handle_t *hdl;
1544 zprop_expand_list_cb(int prop, void *cb)
1546 zprop_list_t *entry;
1547 expand_data_t *edp = cb;
1549 if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1550 return (ZPROP_INVAL);
1552 entry->pl_prop = prop;
1553 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1554 entry->pl_all = B_TRUE;
1556 *(edp->last) = entry;
1557 edp->last = &entry->pl_next;
1559 return (ZPROP_CONT);
1563 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1565 zprop_list_t *entry;
1566 zprop_list_t **last;
1571 * If this is the very first time we've been called for an 'all'
1572 * specification, expand the list to include all native
1581 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1582 B_FALSE, type) == ZPROP_INVAL)
1586 * Add 'name' to the beginning of the list, which is handled
1589 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1592 entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME :
1594 entry->pl_width = zprop_width(entry->pl_prop,
1595 &entry->pl_fixed, type);
1596 entry->pl_all = B_TRUE;
1597 entry->pl_next = *plp;
1604 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1607 return (zprop_iter_common(func, cb, show_all, ordered, type));