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.
23 * Copyright (c) 2011 by Delphix. All rights reserved.
27 * Internal utility routines for the ZFS library.
41 #include <sys/mnttab.h>
42 #include <sys/mntent.h>
43 #include <sys/types.h>
48 #include "libzfs_impl.h"
52 libzfs_errno(libzfs_handle_t *hdl)
54 return (hdl->libzfs_error);
58 libzfs_error_action(libzfs_handle_t *hdl)
60 return (hdl->libzfs_action);
64 libzfs_error_description(libzfs_handle_t *hdl)
66 if (hdl->libzfs_desc[0] != '\0')
67 return (hdl->libzfs_desc);
69 switch (hdl->libzfs_error) {
71 return (dgettext(TEXT_DOMAIN, "out of memory"));
73 return (dgettext(TEXT_DOMAIN, "invalid property value"));
74 case EZFS_PROPREADONLY:
75 return (dgettext(TEXT_DOMAIN, "read-only property"));
77 return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
78 "datasets of this type"));
79 case EZFS_PROPNONINHERIT:
80 return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
82 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
84 return (dgettext(TEXT_DOMAIN, "operation not applicable to "
85 "datasets of this type"));
87 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
89 return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
91 return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
93 return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
95 return (dgettext(TEXT_DOMAIN, "dataset is read-only"));
97 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
99 case EZFS_INVALIDNAME:
100 return (dgettext(TEXT_DOMAIN, "invalid name"));
101 case EZFS_BADRESTORE:
102 return (dgettext(TEXT_DOMAIN, "unable to restore to "
105 return (dgettext(TEXT_DOMAIN, "backup failed"));
107 return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
109 return (dgettext(TEXT_DOMAIN, "no such device in pool"));
111 return (dgettext(TEXT_DOMAIN, "invalid device"));
112 case EZFS_NOREPLICAS:
113 return (dgettext(TEXT_DOMAIN, "no valid replicas"));
114 case EZFS_RESILVERING:
115 return (dgettext(TEXT_DOMAIN, "currently resilvering"));
116 case EZFS_BADVERSION:
117 return (dgettext(TEXT_DOMAIN, "unsupported version"));
118 case EZFS_POOLUNAVAIL:
119 return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
120 case EZFS_DEVOVERFLOW:
121 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
123 return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
124 case EZFS_CROSSTARGET:
125 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
128 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
129 case EZFS_MOUNTFAILED:
130 return (dgettext(TEXT_DOMAIN, "mount failed"));
131 case EZFS_UMOUNTFAILED:
132 return (dgettext(TEXT_DOMAIN, "umount failed"));
133 case EZFS_UNSHARENFSFAILED:
134 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
135 case EZFS_SHARENFSFAILED:
136 return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
137 case EZFS_UNSHARESMBFAILED:
138 return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
139 case EZFS_SHARESMBFAILED:
140 return (dgettext(TEXT_DOMAIN, "smb add share failed"));
142 return (dgettext(TEXT_DOMAIN, "permission denied"));
144 return (dgettext(TEXT_DOMAIN, "out of space"));
146 return (dgettext(TEXT_DOMAIN, "bad address"));
148 return (dgettext(TEXT_DOMAIN, "I/O error"));
150 return (dgettext(TEXT_DOMAIN, "signal received"));
152 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
154 case EZFS_INVALCONFIG:
155 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
157 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
159 return (dgettext(TEXT_DOMAIN, "no history available"));
161 return (dgettext(TEXT_DOMAIN, "failed to retrieve "
163 case EZFS_POOL_NOTSUP:
164 return (dgettext(TEXT_DOMAIN, "operation not supported "
165 "on this type of pool"));
166 case EZFS_POOL_INVALARG:
167 return (dgettext(TEXT_DOMAIN, "invalid argument for "
168 "this pool operation"));
169 case EZFS_NAMETOOLONG:
170 return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
171 case EZFS_OPENFAILED:
172 return (dgettext(TEXT_DOMAIN, "open failed"));
174 return (dgettext(TEXT_DOMAIN,
175 "disk capacity information could not be retrieved"));
176 case EZFS_LABELFAILED:
177 return (dgettext(TEXT_DOMAIN, "write of label failed"));
179 return (dgettext(TEXT_DOMAIN, "invalid user/group"));
181 return (dgettext(TEXT_DOMAIN, "invalid permission"));
182 case EZFS_BADPERMSET:
183 return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
184 case EZFS_NODELEGATION:
185 return (dgettext(TEXT_DOMAIN, "delegated administration is "
186 "disabled on pool"));
188 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
190 return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
191 case EZFS_VDEVNOTSUP:
192 return (dgettext(TEXT_DOMAIN, "vdev specification is not "
195 return (dgettext(TEXT_DOMAIN, "operation not supported "
197 case EZFS_ACTIVE_SPARE:
198 return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
200 case EZFS_UNPLAYED_LOGS:
201 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
203 case EZFS_REFTAG_RELE:
204 return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
205 case EZFS_REFTAG_HOLD:
206 return (dgettext(TEXT_DOMAIN, "tag already exists on this "
208 case EZFS_TAGTOOLONG:
209 return (dgettext(TEXT_DOMAIN, "tag too long"));
210 case EZFS_PIPEFAILED:
211 return (dgettext(TEXT_DOMAIN, "pipe create failed"));
212 case EZFS_THREADCREATEFAILED:
213 return (dgettext(TEXT_DOMAIN, "thread create failed"));
214 case EZFS_POSTSPLIT_ONLINE:
215 return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
218 return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
219 "use 'zpool scrub -s' to cancel current scrub"));
221 return (dgettext(TEXT_DOMAIN, "there is no active scrub"));
223 return (dgettext(TEXT_DOMAIN, "unable to generate diffs"));
225 return (dgettext(TEXT_DOMAIN, "invalid diff data"));
226 case EZFS_POOLREADONLY:
227 return (dgettext(TEXT_DOMAIN, "pool is read-only"));
229 return (dgettext(TEXT_DOMAIN, "unknown error"));
231 assert(hdl->libzfs_error == 0);
232 return (dgettext(TEXT_DOMAIN, "no error"));
238 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
244 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
246 hdl->libzfs_desc_active = 1;
252 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
254 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
256 hdl->libzfs_error = error;
258 if (hdl->libzfs_desc_active)
259 hdl->libzfs_desc_active = 0;
261 hdl->libzfs_desc[0] = '\0';
263 if (hdl->libzfs_printerr) {
264 if (error == EZFS_UNKNOWN) {
265 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
266 "error: %s\n"), libzfs_error_description(hdl));
270 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
271 libzfs_error_description(hdl));
272 if (error == EZFS_NOMEM)
278 zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
280 return (zfs_error_fmt(hdl, error, "%s", msg));
285 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
291 zfs_verror(hdl, error, fmt, ap);
299 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
305 zfs_verror(hdl, EZFS_PERM, fmt, ap);
309 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
313 zfs_verror(hdl, EZFS_IO, fmt, ap);
317 zfs_verror(hdl, EZFS_FAULT, fmt, ap);
321 zfs_verror(hdl, EZFS_INTR, fmt, ap);
329 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
331 return (zfs_standard_error_fmt(hdl, error, "%s", msg));
336 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
342 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
351 zfs_verror(hdl, EZFS_IO, fmt, ap);
355 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
356 "dataset does not exist"));
357 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
362 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
366 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
367 "dataset already exists"));
368 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
372 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
374 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
377 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
380 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
383 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap);
386 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
387 "pool I/O is currently suspended"));
388 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
391 zfs_error_aux(hdl, strerror(error));
392 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
401 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
403 return (zpool_standard_error_fmt(hdl, error, "%s", msg));
408 zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
414 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
421 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
426 dgettext(TEXT_DOMAIN, "no such pool or dataset"));
427 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
431 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
432 "pool already exists"));
433 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
437 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
438 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
442 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
443 "one or more devices is currently unavailable"));
444 zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
448 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
452 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
456 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
461 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
465 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
466 "pool I/O is currently suspended"));
467 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
471 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
475 zfs_error_aux(hdl, strerror(error));
476 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
484 * Display an out of memory error message and abort the current program.
487 no_memory(libzfs_handle_t *hdl)
489 return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
493 * A safe form of malloc() which will die if the allocation fails.
496 zfs_alloc(libzfs_handle_t *hdl, size_t size)
500 if ((data = calloc(1, size)) == NULL)
501 (void) no_memory(hdl);
507 * A safe form of asprintf() which will die if the allocation fails.
511 zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...)
519 err = vasprintf(&ret, fmt, ap);
524 (void) no_memory(hdl);
530 * A safe form of realloc(), which also zeroes newly allocated space.
533 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
537 if ((ret = realloc(ptr, newsize)) == NULL) {
538 (void) no_memory(hdl);
542 bzero((char *)ret + oldsize, (newsize - oldsize));
547 * A safe form of strdup() which will die if the allocation fails.
550 zfs_strdup(libzfs_handle_t *hdl, const char *str)
554 if ((ret = strdup(str)) == NULL)
555 (void) no_memory(hdl);
561 * Convert a number to an appropriately human-readable output.
564 zfs_nicenum(uint64_t num, char *buf, size_t buflen)
575 u = " KMGTPE"[index];
578 (void) snprintf(buf, buflen, "%llu", (u_longlong_t) n);
579 } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
581 * If this is an even multiple of the base, always display
582 * without any decimal precision.
584 (void) snprintf(buf, buflen, "%llu%c", (u_longlong_t) n, u);
587 * We want to choose a precision that reflects the best choice
588 * for fitting in 5 characters. This can get rather tricky when
589 * we have numbers that are very close to an order of magnitude.
590 * For example, when displaying 10239 (which is really 9.999K),
591 * we want only a single place of precision for 10.0K. We could
592 * develop some complex heuristics for this, but it's much
593 * easier just to try each combination in turn.
596 for (i = 2; i >= 0; i--) {
597 if (snprintf(buf, buflen, "%.*f%c", i,
598 (double)num / (1ULL << 10 * index), u) <= 5)
605 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
607 hdl->libzfs_printerr = printerr;
611 libzfs_module_loaded(const char *module)
613 const char path_prefix[] = "/sys/module/";
616 memcpy(path, path_prefix, sizeof(path_prefix) - 1);
617 strcpy(path + sizeof(path_prefix) - 1, module);
619 return (access(path, F_OK) == 0);
623 libzfs_run_process(const char *path, char *argv[], int flags)
630 devnull_fd = open("/dev/null", O_WRONLY);
635 if (!(flags & STDOUT_VERBOSE))
636 (void) dup2(devnull_fd, STDOUT_FILENO);
638 if (!(flags & STDERR_VERBOSE))
639 (void) dup2(devnull_fd, STDERR_FILENO);
643 (void) execvp(path, argv);
645 } else if (pid > 0) {
648 while ((rc = waitpid(pid, &status, 0)) == -1 &&
650 if (rc < 0 || !WIFEXITED(status))
653 return WEXITSTATUS(status);
660 libzfs_load_module(const char *module)
662 char *argv[4] = {"/sbin/modprobe", "-q", (char *)module, (char *)0};
664 if (libzfs_module_loaded(module))
667 return libzfs_run_process("/sbin/modprobe", argv, 0);
673 libzfs_handle_t *hdl;
675 if (libzfs_load_module("zfs") != 0) {
676 (void) fprintf(stderr, gettext("Failed to load ZFS module "
677 "stack.\nLoad the module manually by running "
678 "'insmod <location>/zfs.ko' as root.\n"));
682 if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
686 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
687 (void) fprintf(stderr, gettext("Unable to open %s: %s.\n"),
688 ZFS_DEV, strerror(errno));
690 (void) fprintf(stderr,
691 gettext("Verify the ZFS module stack is "
692 "loaded by running '/sbin/modprobe zfs'.\n"));
698 #ifdef HAVE_SETMNTENT
699 if ((hdl->libzfs_mnttab = setmntent(MNTTAB, "r")) == NULL) {
701 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
703 (void) close(hdl->libzfs_fd);
708 hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
712 libzfs_mnttab_init(hdl);
718 libzfs_fini(libzfs_handle_t *hdl)
720 (void) close(hdl->libzfs_fd);
721 if (hdl->libzfs_mnttab)
722 #ifdef HAVE_SETMNTENT
723 (void) endmntent(hdl->libzfs_mnttab);
725 (void) fclose(hdl->libzfs_mnttab);
727 if (hdl->libzfs_sharetab)
728 (void) fclose(hdl->libzfs_sharetab);
729 zfs_uninit_libshare(hdl);
730 if (hdl->libzfs_log_str)
731 (void) free(hdl->libzfs_log_str);
732 zpool_free_handles(hdl);
733 libzfs_fru_clear(hdl, B_TRUE);
734 namespace_clear(hdl);
735 libzfs_mnttab_fini(hdl);
740 zpool_get_handle(zpool_handle_t *zhp)
742 return (zhp->zpool_hdl);
746 zfs_get_handle(zfs_handle_t *zhp)
748 return (zhp->zfs_hdl);
752 zfs_get_pool_handle(const zfs_handle_t *zhp)
754 return (zhp->zpool_hdl);
758 * Given a name, determine whether or not it's a valid path
759 * (starts with '/' or "./"). If so, walk the mnttab trying
760 * to match the device number. If not, treat the path as an
764 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
766 struct stat64 statbuf;
767 struct extmnttab entry;
770 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
772 * It's not a valid path, assume it's a name of type 'argtype'.
774 return (zfs_open(hdl, path, argtype));
777 if (stat64(path, &statbuf) != 0) {
778 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
782 rewind(hdl->libzfs_mnttab);
783 while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
784 if (makedevice(entry.mnt_major, entry.mnt_minor) ==
793 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
794 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
799 return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
803 * Given a shorthand device name, check if a file by that name exists in a list
804 * of directories under /dev. If one is found, store its full path in the
805 * buffer pointed to by the path argument and return 0, else return -1. The
806 * path buffer must be allocated by the caller.
809 zfs_resolve_shortname(const char *name, char *path, size_t pathlen)
812 char dirs[6][9] = {"by-id", "by-label", "by-path", "by-uuid", "zpool",
816 (void) snprintf(path, pathlen, "%s/%s", DISK_ROOT, name);
817 err = access(path, F_OK);
822 (void) snprintf(path, pathlen, "%s/mapper/%s", DISK_ROOT, name);
823 err = access(path, F_OK);
827 /* /dev/disk/<dirs>/ */
828 for (i = 0; i < 6 && err < 0; i++) {
829 (void) snprintf(path, pathlen, "%s/%s/%s",
830 UDISK_ROOT, dirs[i], name);
831 err = access(path, F_OK);
838 * Append partition suffix to a device path. This should be used to generate
839 * the name of a whole disk as it is stored in the vdev label. The
840 * user-visible names of whole disks do not contain the partition information.
841 * Modifies buf which must be allocated by the caller.
844 zfs_append_partition(const char *path, char *buf, size_t buflen)
846 if (strncmp(path, UDISK_ROOT, strlen(UDISK_ROOT)) == 0)
847 (void) snprintf(buf, buflen, "%s%s%s", path, "-part",
850 (void) snprintf(buf, buflen, "%s%s%s", path,
851 isdigit(path[strlen(path)-1]) ? "p" : "",
856 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
860 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
864 zc->zc_nvlist_dst_size = len;
865 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
866 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
873 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
874 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
875 * filled in by the kernel to indicate the actual required size.
878 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
880 free((void *)(uintptr_t)zc->zc_nvlist_dst);
881 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
882 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
889 * Called to free the src and dst nvlists stored in the command structure.
892 zcmd_free_nvlists(zfs_cmd_t *zc)
894 free((void *)(uintptr_t)zc->zc_nvlist_conf);
895 free((void *)(uintptr_t)zc->zc_nvlist_src);
896 free((void *)(uintptr_t)zc->zc_nvlist_dst);
900 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
906 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
908 if ((packed = zfs_alloc(hdl, len)) == NULL)
911 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
913 *outnv = (uint64_t)(uintptr_t)packed;
920 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
922 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
923 &zc->zc_nvlist_conf_size, nvl));
927 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
929 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
930 &zc->zc_nvlist_src_size, nvl));
934 * Unpacks an nvlist from the ZFS ioctl command structure.
937 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
939 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
940 zc->zc_nvlist_dst_size, nvlp, 0) != 0)
941 return (no_memory(hdl));
947 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
951 zc->zc_history = (uint64_t)(uintptr_t)hdl->libzfs_log_str;
952 error = ioctl(hdl->libzfs_fd, request, zc);
953 if (hdl->libzfs_log_str) {
954 free(hdl->libzfs_log_str);
955 hdl->libzfs_log_str = NULL;
963 * ================================================================
964 * API shared by zfs and zpool property management
965 * ================================================================
969 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
971 zprop_list_t *pl = cbp->cb_proplist;
976 cbp->cb_first = B_FALSE;
977 if (cbp->cb_scripted)
981 * Start with the length of the column headers.
983 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
984 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
986 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
988 cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
990 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
993 /* first property is always NAME */
994 assert(cbp->cb_proplist->pl_prop ==
995 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME));
998 * Go through and calculate the widths for each column. For the
999 * 'source' column, we kludge it up by taking the worst-case scenario of
1000 * inheriting from the longest name. This is acceptable because in the
1001 * majority of cases 'SOURCE' is the last column displayed, and we don't
1002 * use the width anyway. Note that the 'VALUE' column can be oversized,
1003 * if the name of the property is much longer than any values we find.
1005 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
1009 if (pl->pl_prop != ZPROP_INVAL) {
1010 const char *propname = (type == ZFS_TYPE_POOL) ?
1011 zpool_prop_to_name(pl->pl_prop) :
1012 zfs_prop_to_name(pl->pl_prop);
1014 len = strlen(propname);
1015 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
1016 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
1018 len = strlen(pl->pl_user_prop);
1019 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
1020 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
1024 * 'VALUE' column. The first property is always the 'name'
1025 * property that was tacked on either by /sbin/zfs's
1026 * zfs_do_get() or when calling zprop_expand_list(), so we
1027 * ignore its width. If the user specified the name property
1028 * to display, then it will be later in the list in any case.
1030 if (pl != cbp->cb_proplist &&
1031 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
1032 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
1034 /* 'RECEIVED' column. */
1035 if (pl != cbp->cb_proplist &&
1036 pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
1037 cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
1040 * 'NAME' and 'SOURCE' columns
1042 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
1044 pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
1045 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
1046 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
1047 strlen(dgettext(TEXT_DOMAIN, "inherited from"));
1052 * Now go through and print the headers.
1054 for (i = 0; i < ZFS_GET_NCOLS; i++) {
1055 switch (cbp->cb_columns[i]) {
1057 title = dgettext(TEXT_DOMAIN, "NAME");
1059 case GET_COL_PROPERTY:
1060 title = dgettext(TEXT_DOMAIN, "PROPERTY");
1063 title = dgettext(TEXT_DOMAIN, "VALUE");
1066 title = dgettext(TEXT_DOMAIN, "RECEIVED");
1068 case GET_COL_SOURCE:
1069 title = dgettext(TEXT_DOMAIN, "SOURCE");
1075 if (title != NULL) {
1076 if (i == (ZFS_GET_NCOLS - 1) ||
1077 cbp->cb_columns[i + 1] == GET_COL_NONE)
1078 (void) printf("%s", title);
1080 (void) printf("%-*s ",
1081 cbp->cb_colwidths[cbp->cb_columns[i]],
1085 (void) printf("\n");
1089 * Display a single line of output, according to the settings in the callback
1093 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
1094 const char *propname, const char *value, zprop_source_t sourcetype,
1095 const char *source, const char *recvd_value)
1098 const char *str = NULL;
1102 * Ignore those source types that the user has chosen to ignore.
1104 if ((sourcetype & cbp->cb_sources) == 0)
1108 zprop_print_headers(cbp, cbp->cb_type);
1110 for (i = 0; i < ZFS_GET_NCOLS; i++) {
1111 switch (cbp->cb_columns[i]) {
1116 case GET_COL_PROPERTY:
1124 case GET_COL_SOURCE:
1125 switch (sourcetype) {
1126 case ZPROP_SRC_NONE:
1130 case ZPROP_SRC_DEFAULT:
1134 case ZPROP_SRC_LOCAL:
1138 case ZPROP_SRC_TEMPORARY:
1142 case ZPROP_SRC_INHERITED:
1143 (void) snprintf(buf, sizeof (buf),
1144 "inherited from %s", source);
1147 case ZPROP_SRC_RECEIVED:
1154 str = (recvd_value == NULL ? "-" : recvd_value);
1161 if (cbp->cb_columns[i + 1] == GET_COL_NONE)
1162 (void) printf("%s", str);
1163 else if (cbp->cb_scripted)
1164 (void) printf("%s\t", str);
1166 (void) printf("%-*s ",
1167 cbp->cb_colwidths[cbp->cb_columns[i]],
1171 (void) printf("\n");
1175 * Given a numeric suffix, convert the value into a number of bits that the
1176 * resulting value must be shifted.
1179 str2shift(libzfs_handle_t *hdl, const char *buf)
1181 const char *ends = "BKMGTPEZ";
1186 for (i = 0; i < strlen(ends); i++) {
1187 if (toupper(buf[0]) == ends[i])
1190 if (i == strlen(ends)) {
1191 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1192 "invalid numeric suffix '%s'"), buf);
1197 * Allow 'G' = 'GB' = 'GiB', case-insensitively.
1198 * However, 'BB' and 'BiB' are disallowed.
1200 if (buf[1] == '\0' ||
1201 (toupper(buf[0]) != 'B' &&
1202 ((toupper(buf[1]) == 'B' && buf[2] == '\0') ||
1203 (toupper(buf[1]) == 'I' && toupper(buf[2]) == 'B' &&
1207 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1208 "invalid numeric suffix '%s'"), buf);
1213 * Convert a string of the form '100G' into a real number. Used when setting
1214 * properties or creating a volume. 'buf' is used to place an extended error
1215 * message for the caller to use.
1218 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1225 /* Check to see if this looks like a number. */
1226 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1228 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1229 "bad numeric value '%s'"), value);
1233 /* Rely on strtoull() to process the numeric portion. */
1235 *num = strtoull(value, &end, 10);
1238 * Check for ERANGE, which indicates that the value is too large to fit
1239 * in a 64-bit value.
1241 if (errno == ERANGE) {
1243 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1244 "numeric value is too large"));
1249 * If we have a decimal value, then do the computation with floating
1250 * point arithmetic. Otherwise, use standard arithmetic.
1253 double fval = strtod(value, &end);
1255 if ((shift = str2shift(hdl, end)) == -1)
1258 fval *= pow(2, shift);
1260 if (fval > UINT64_MAX) {
1262 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1263 "numeric value is too large"));
1267 *num = (uint64_t)fval;
1269 if ((shift = str2shift(hdl, end)) == -1)
1272 /* Check for overflow */
1273 if (shift >= 64 || (*num << shift) >> shift != *num) {
1275 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1276 "numeric value is too large"));
1287 * Given a propname=value nvpair to set, parse any numeric properties
1288 * (index, boolean, etc) if they are specified as strings and add the
1289 * resulting nvpair to the returned nvlist.
1291 * At the DSL layer, all properties are either 64-bit numbers or strings.
1292 * We want the user to be able to ignore this fact and specify properties
1293 * as native values (numbers, for example) or as strings (to simplify
1294 * command line utilities). This also handles converting index types
1295 * (compression, checksum, etc) from strings to their on-disk index.
1298 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1299 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1302 data_type_t datatype = nvpair_type(elem);
1303 zprop_type_t proptype;
1304 const char *propname;
1306 boolean_t isnone = B_FALSE;
1308 if (type == ZFS_TYPE_POOL) {
1309 proptype = zpool_prop_get_type(prop);
1310 propname = zpool_prop_to_name(prop);
1312 proptype = zfs_prop_get_type(prop);
1313 propname = zfs_prop_to_name(prop);
1317 * Convert any properties to the internal DSL value types.
1323 case PROP_TYPE_STRING:
1324 if (datatype != DATA_TYPE_STRING) {
1325 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1326 "'%s' must be a string"), nvpair_name(elem));
1329 (void) nvpair_value_string(elem, svalp);
1330 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1331 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1332 "'%s' is too long"), nvpair_name(elem));
1337 case PROP_TYPE_NUMBER:
1338 if (datatype == DATA_TYPE_STRING) {
1339 (void) nvpair_value_string(elem, &value);
1340 if (strcmp(value, "none") == 0) {
1342 } else if (zfs_nicestrtonum(hdl, value, ivalp)
1346 } else if (datatype == DATA_TYPE_UINT64) {
1347 (void) nvpair_value_uint64(elem, ivalp);
1349 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1350 "'%s' must be a number"), nvpair_name(elem));
1355 * Quota special: force 'none' and don't allow 0.
1357 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1358 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1359 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1360 "use 'none' to disable quota/refquota"));
1365 case PROP_TYPE_INDEX:
1366 if (datatype != DATA_TYPE_STRING) {
1367 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1368 "'%s' must be a string"), nvpair_name(elem));
1372 (void) nvpair_value_string(elem, &value);
1374 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1375 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1376 "'%s' must be one of '%s'"), propname,
1377 zprop_values(prop, type));
1387 * Add the result to our return set of properties.
1389 if (*svalp != NULL) {
1390 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1391 (void) no_memory(hdl);
1395 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1396 (void) no_memory(hdl);
1403 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1408 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1412 zprop_list_t *entry;
1414 prop = zprop_name_to_prop(propname, type);
1416 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1420 * When no property table entry can be found, return failure if
1421 * this is a pool property or if this isn't a user-defined
1424 if (prop == ZPROP_INVAL && (type == ZFS_TYPE_POOL ||
1425 (!zfs_prop_user(propname) && !zfs_prop_userquota(propname) &&
1426 !zfs_prop_written(propname)))) {
1427 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1428 "invalid property '%s'"), propname);
1429 return (zfs_error(hdl, EZFS_BADPROP,
1430 dgettext(TEXT_DOMAIN, "bad property list")));
1433 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1436 entry->pl_prop = prop;
1437 if (prop == ZPROP_INVAL) {
1438 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) == NULL) {
1442 entry->pl_width = strlen(propname);
1444 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1454 * Given a comma-separated list of properties, construct a property list
1455 * containing both user-defined and native properties. This function will
1456 * return a NULL list if 'all' is specified, which can later be expanded
1457 * by zprop_expand_list().
1460 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1466 * If 'all' is specified, return a NULL list.
1468 if (strcmp(props, "all") == 0)
1472 * If no props were specified, return an error.
1474 if (props[0] == '\0') {
1475 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1476 "no properties specified"));
1477 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1478 "bad property list")));
1482 * It would be nice to use getsubopt() here, but the inclusion of column
1483 * aliases makes this more effort than it's worth.
1485 while (*props != '\0') {
1490 if ((p = strchr(props, ',')) == NULL) {
1491 len = strlen(props);
1498 * Check for empty options.
1501 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1502 "empty property name"));
1503 return (zfs_error(hdl, EZFS_BADPROP,
1504 dgettext(TEXT_DOMAIN, "bad property list")));
1508 * Check all regular property names.
1513 if (strcmp(props, "space") == 0) {
1514 static char *spaceprops[] = {
1515 "name", "avail", "used", "usedbysnapshots",
1516 "usedbydataset", "usedbyrefreservation",
1517 "usedbychildren", NULL
1521 for (i = 0; spaceprops[i]; i++) {
1522 if (addlist(hdl, spaceprops[i], listp, type))
1524 listp = &(*listp)->pl_next;
1527 if (addlist(hdl, props, listp, type))
1529 listp = &(*listp)->pl_next;
1541 zprop_free_list(zprop_list_t *pl)
1545 while (pl != NULL) {
1547 free(pl->pl_user_prop);
1553 typedef struct expand_data {
1554 zprop_list_t **last;
1555 libzfs_handle_t *hdl;
1560 zprop_expand_list_cb(int prop, void *cb)
1562 zprop_list_t *entry;
1563 expand_data_t *edp = cb;
1565 if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1566 return (ZPROP_INVAL);
1568 entry->pl_prop = prop;
1569 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1570 entry->pl_all = B_TRUE;
1572 *(edp->last) = entry;
1573 edp->last = &entry->pl_next;
1575 return (ZPROP_CONT);
1579 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1581 zprop_list_t *entry;
1582 zprop_list_t **last;
1587 * If this is the very first time we've been called for an 'all'
1588 * specification, expand the list to include all native
1597 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1598 B_FALSE, type) == ZPROP_INVAL)
1602 * Add 'name' to the beginning of the list, which is handled
1605 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1608 entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME :
1610 entry->pl_width = zprop_width(entry->pl_prop,
1611 &entry->pl_fixed, type);
1612 entry->pl_all = B_TRUE;
1613 entry->pl_next = *plp;
1620 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1623 return (zprop_iter_common(func, cb, show_all, ordered, type));