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) 2012 by Delphix. All rights reserved.
28 * Internal utility routines for the ZFS library.
42 #include <sys/mnttab.h>
43 #include <sys/mntent.h>
44 #include <sys/types.h>
49 #include "libzfs_impl.h"
51 #include "zfeature_common.h"
54 libzfs_errno(libzfs_handle_t *hdl)
56 return (hdl->libzfs_error);
60 libzfs_error_action(libzfs_handle_t *hdl)
62 return (hdl->libzfs_action);
66 libzfs_error_description(libzfs_handle_t *hdl)
68 if (hdl->libzfs_desc[0] != '\0')
69 return (hdl->libzfs_desc);
71 switch (hdl->libzfs_error) {
73 return (dgettext(TEXT_DOMAIN, "out of memory"));
75 return (dgettext(TEXT_DOMAIN, "invalid property value"));
76 case EZFS_PROPREADONLY:
77 return (dgettext(TEXT_DOMAIN, "read-only property"));
79 return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
80 "datasets of this type"));
81 case EZFS_PROPNONINHERIT:
82 return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
84 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
86 return (dgettext(TEXT_DOMAIN, "operation not applicable to "
87 "datasets of this type"));
89 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
91 return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
93 return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
95 return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
97 return (dgettext(TEXT_DOMAIN, "dataset is read-only"));
99 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
101 case EZFS_INVALIDNAME:
102 return (dgettext(TEXT_DOMAIN, "invalid name"));
103 case EZFS_BADRESTORE:
104 return (dgettext(TEXT_DOMAIN, "unable to restore to "
107 return (dgettext(TEXT_DOMAIN, "backup failed"));
109 return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
111 return (dgettext(TEXT_DOMAIN, "no such device in pool"));
113 return (dgettext(TEXT_DOMAIN, "invalid device"));
114 case EZFS_NOREPLICAS:
115 return (dgettext(TEXT_DOMAIN, "no valid replicas"));
116 case EZFS_RESILVERING:
117 return (dgettext(TEXT_DOMAIN, "currently resilvering"));
118 case EZFS_BADVERSION:
119 return (dgettext(TEXT_DOMAIN, "unsupported version or "
121 case EZFS_POOLUNAVAIL:
122 return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
123 case EZFS_DEVOVERFLOW:
124 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
126 return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
127 case EZFS_CROSSTARGET:
128 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
131 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
132 case EZFS_MOUNTFAILED:
133 return (dgettext(TEXT_DOMAIN, "mount failed"));
134 case EZFS_UMOUNTFAILED:
135 return (dgettext(TEXT_DOMAIN, "umount failed"));
136 case EZFS_UNSHARENFSFAILED:
137 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
138 case EZFS_SHARENFSFAILED:
139 return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
140 case EZFS_UNSHARESMBFAILED:
141 return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
142 case EZFS_SHARESMBFAILED:
143 return (dgettext(TEXT_DOMAIN, "smb add share failed"));
145 return (dgettext(TEXT_DOMAIN, "permission denied"));
147 return (dgettext(TEXT_DOMAIN, "out of space"));
149 return (dgettext(TEXT_DOMAIN, "bad address"));
151 return (dgettext(TEXT_DOMAIN, "I/O error"));
153 return (dgettext(TEXT_DOMAIN, "signal received"));
155 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
157 case EZFS_INVALCONFIG:
158 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
160 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
162 return (dgettext(TEXT_DOMAIN, "no history available"));
164 return (dgettext(TEXT_DOMAIN, "failed to retrieve "
166 case EZFS_POOL_NOTSUP:
167 return (dgettext(TEXT_DOMAIN, "operation not supported "
168 "on this type of pool"));
169 case EZFS_POOL_INVALARG:
170 return (dgettext(TEXT_DOMAIN, "invalid argument for "
171 "this pool operation"));
172 case EZFS_NAMETOOLONG:
173 return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
174 case EZFS_OPENFAILED:
175 return (dgettext(TEXT_DOMAIN, "open failed"));
177 return (dgettext(TEXT_DOMAIN,
178 "disk capacity information could not be retrieved"));
179 case EZFS_LABELFAILED:
180 return (dgettext(TEXT_DOMAIN, "write of label failed"));
182 return (dgettext(TEXT_DOMAIN, "invalid user/group"));
184 return (dgettext(TEXT_DOMAIN, "invalid permission"));
185 case EZFS_BADPERMSET:
186 return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
187 case EZFS_NODELEGATION:
188 return (dgettext(TEXT_DOMAIN, "delegated administration is "
189 "disabled on pool"));
191 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
193 return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
194 case EZFS_VDEVNOTSUP:
195 return (dgettext(TEXT_DOMAIN, "vdev specification is not "
198 return (dgettext(TEXT_DOMAIN, "operation not supported "
200 case EZFS_ACTIVE_SPARE:
201 return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
203 case EZFS_UNPLAYED_LOGS:
204 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
206 case EZFS_REFTAG_RELE:
207 return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
208 case EZFS_REFTAG_HOLD:
209 return (dgettext(TEXT_DOMAIN, "tag already exists on this "
211 case EZFS_TAGTOOLONG:
212 return (dgettext(TEXT_DOMAIN, "tag too long"));
213 case EZFS_PIPEFAILED:
214 return (dgettext(TEXT_DOMAIN, "pipe create failed"));
215 case EZFS_THREADCREATEFAILED:
216 return (dgettext(TEXT_DOMAIN, "thread create failed"));
217 case EZFS_POSTSPLIT_ONLINE:
218 return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
221 return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
222 "use 'zpool scrub -s' to cancel current scrub"));
224 return (dgettext(TEXT_DOMAIN, "there is no active scrub"));
226 return (dgettext(TEXT_DOMAIN, "unable to generate diffs"));
228 return (dgettext(TEXT_DOMAIN, "invalid diff data"));
229 case EZFS_POOLREADONLY:
230 return (dgettext(TEXT_DOMAIN, "pool is read-only"));
232 return (dgettext(TEXT_DOMAIN, "unknown error"));
234 assert(hdl->libzfs_error == 0);
235 return (dgettext(TEXT_DOMAIN, "no error"));
241 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
247 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
249 hdl->libzfs_desc_active = 1;
255 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
257 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
259 hdl->libzfs_error = error;
261 if (hdl->libzfs_desc_active)
262 hdl->libzfs_desc_active = 0;
264 hdl->libzfs_desc[0] = '\0';
266 if (hdl->libzfs_printerr) {
267 if (error == EZFS_UNKNOWN) {
268 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
269 "error: %s\n"), libzfs_error_description(hdl));
273 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
274 libzfs_error_description(hdl));
275 if (error == EZFS_NOMEM)
281 zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
283 return (zfs_error_fmt(hdl, error, "%s", msg));
288 zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
294 zfs_verror(hdl, error, fmt, ap);
302 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
308 zfs_verror(hdl, EZFS_PERM, fmt, ap);
312 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
316 zfs_verror(hdl, EZFS_IO, fmt, ap);
320 zfs_verror(hdl, EZFS_FAULT, fmt, ap);
324 zfs_verror(hdl, EZFS_INTR, fmt, ap);
332 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
334 return (zfs_standard_error_fmt(hdl, error, "%s", msg));
339 zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
345 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
354 zfs_verror(hdl, EZFS_IO, fmt, ap);
358 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
359 "dataset does not exist"));
360 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
365 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
369 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
370 "dataset already exists"));
371 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
375 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
377 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
380 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
383 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
386 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap);
389 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
390 "pool I/O is currently suspended"));
391 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
394 zfs_error_aux(hdl, strerror(error));
395 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
404 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
406 return (zpool_standard_error_fmt(hdl, error, "%s", msg));
411 zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
417 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
424 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
429 dgettext(TEXT_DOMAIN, "no such pool or dataset"));
430 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
434 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
435 "pool already exists"));
436 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
440 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
441 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
445 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
446 "one or more devices is currently unavailable"));
447 zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
451 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
455 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
459 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
464 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
468 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
469 "pool I/O is currently suspended"));
470 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
474 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
478 zfs_error_aux(hdl, strerror(error));
479 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
487 * Display an out of memory error message and abort the current program.
490 no_memory(libzfs_handle_t *hdl)
492 return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
496 * A safe form of malloc() which will die if the allocation fails.
499 zfs_alloc(libzfs_handle_t *hdl, size_t size)
503 if ((data = calloc(1, size)) == NULL)
504 (void) no_memory(hdl);
510 * A safe form of asprintf() which will die if the allocation fails.
514 zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...)
522 err = vasprintf(&ret, fmt, ap);
527 (void) no_memory(hdl);
533 * A safe form of realloc(), which also zeroes newly allocated space.
536 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
540 if ((ret = realloc(ptr, newsize)) == NULL) {
541 (void) no_memory(hdl);
545 bzero((char *)ret + oldsize, (newsize - oldsize));
550 * A safe form of strdup() which will die if the allocation fails.
553 zfs_strdup(libzfs_handle_t *hdl, const char *str)
557 if ((ret = strdup(str)) == NULL)
558 (void) no_memory(hdl);
564 * Convert a number to an appropriately human-readable output.
567 zfs_nicenum(uint64_t num, char *buf, size_t buflen)
578 u = " KMGTPE"[index];
581 (void) snprintf(buf, buflen, "%llu", (u_longlong_t) n);
582 } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
584 * If this is an even multiple of the base, always display
585 * without any decimal precision.
587 (void) snprintf(buf, buflen, "%llu%c", (u_longlong_t) n, u);
590 * We want to choose a precision that reflects the best choice
591 * for fitting in 5 characters. This can get rather tricky when
592 * we have numbers that are very close to an order of magnitude.
593 * For example, when displaying 10239 (which is really 9.999K),
594 * we want only a single place of precision for 10.0K. We could
595 * develop some complex heuristics for this, but it's much
596 * easier just to try each combination in turn.
599 for (i = 2; i >= 0; i--) {
600 if (snprintf(buf, buflen, "%.*f%c", i,
601 (double)num / (1ULL << 10 * index), u) <= 5)
608 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
610 hdl->libzfs_printerr = printerr;
614 libzfs_module_loaded(const char *module)
616 const char path_prefix[] = "/sys/module/";
619 memcpy(path, path_prefix, sizeof(path_prefix) - 1);
620 strcpy(path + sizeof(path_prefix) - 1, module);
622 return (access(path, F_OK) == 0);
626 libzfs_run_process(const char *path, char *argv[], int flags)
633 devnull_fd = open("/dev/null", O_WRONLY);
638 if (!(flags & STDOUT_VERBOSE))
639 (void) dup2(devnull_fd, STDOUT_FILENO);
641 if (!(flags & STDERR_VERBOSE))
642 (void) dup2(devnull_fd, STDERR_FILENO);
646 (void) execvp(path, argv);
648 } else if (pid > 0) {
651 while ((rc = waitpid(pid, &status, 0)) == -1 &&
653 if (rc < 0 || !WIFEXITED(status))
656 return WEXITSTATUS(status);
663 libzfs_load_module(const char *module)
665 char *argv[4] = {"/sbin/modprobe", "-q", (char *)module, (char *)0};
667 if (libzfs_module_loaded(module))
670 return libzfs_run_process("/sbin/modprobe", argv, 0);
676 libzfs_handle_t *hdl;
678 if (libzfs_load_module("zfs") != 0) {
679 (void) fprintf(stderr, gettext("Failed to load ZFS module "
680 "stack.\nLoad the module manually by running "
681 "'insmod <location>/zfs.ko' as root.\n"));
685 if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
689 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
690 (void) fprintf(stderr, gettext("Unable to open %s: %s.\n"),
691 ZFS_DEV, strerror(errno));
693 (void) fprintf(stderr,
694 gettext("Verify the ZFS module stack is "
695 "loaded by running '/sbin/modprobe zfs'.\n"));
701 #ifdef HAVE_SETMNTENT
702 if ((hdl->libzfs_mnttab = setmntent(MNTTAB, "r")) == NULL) {
704 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
706 (void) close(hdl->libzfs_fd);
711 hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
715 zpool_feature_init();
716 libzfs_mnttab_init(hdl);
722 libzfs_fini(libzfs_handle_t *hdl)
724 (void) close(hdl->libzfs_fd);
725 if (hdl->libzfs_mnttab)
726 #ifdef HAVE_SETMNTENT
727 (void) endmntent(hdl->libzfs_mnttab);
729 (void) fclose(hdl->libzfs_mnttab);
731 if (hdl->libzfs_sharetab)
732 (void) fclose(hdl->libzfs_sharetab);
733 zfs_uninit_libshare(hdl);
734 if (hdl->libzfs_log_str)
735 (void) free(hdl->libzfs_log_str);
736 zpool_free_handles(hdl);
737 libzfs_fru_clear(hdl, B_TRUE);
738 namespace_clear(hdl);
739 libzfs_mnttab_fini(hdl);
744 zpool_get_handle(zpool_handle_t *zhp)
746 return (zhp->zpool_hdl);
750 zfs_get_handle(zfs_handle_t *zhp)
752 return (zhp->zfs_hdl);
756 zfs_get_pool_handle(const zfs_handle_t *zhp)
758 return (zhp->zpool_hdl);
762 * Given a name, determine whether or not it's a valid path
763 * (starts with '/' or "./"). If so, walk the mnttab trying
764 * to match the device number. If not, treat the path as an
768 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
770 struct stat64 statbuf;
771 struct extmnttab entry;
774 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
776 * It's not a valid path, assume it's a name of type 'argtype'.
778 return (zfs_open(hdl, path, argtype));
781 if (stat64(path, &statbuf) != 0) {
782 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
786 rewind(hdl->libzfs_mnttab);
787 while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
788 if (makedevice(entry.mnt_major, entry.mnt_minor) ==
797 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
798 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
803 return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
807 * Append partition suffix to an otherwise fully qualified device path.
808 * This is used to generate the name the full path as its stored in
809 * ZPOOL_CONFIG_PATH for whole disk devices. On success the new length
810 * of 'path' will be returned on error a negative value is returned.
813 zfs_append_partition(char *path, size_t max_len)
815 int len = strlen(path);
817 if (strncmp(path, UDISK_ROOT, strlen(UDISK_ROOT)) == 0) {
818 if (len + 6 >= max_len)
821 (void) strcat(path, "-part1");
824 if (len + 2 >= max_len)
827 if (isdigit(path[len-1])) {
828 (void) strcat(path, "p1");
831 (void) strcat(path, "1");
840 * Given a shorthand device name check if a file by that name exists in any
841 * of the 'zpool_default_import_path' or ZPOOL_IMPORT_PATH directories. If
842 * one is found, store its fully qualified path in the 'path' buffer passed
843 * by the caller and return 0, otherwise return an error.
846 zfs_resolve_shortname(const char *name, char *path, size_t len)
849 char *dir, *env, *envdup;
851 env = getenv("ZPOOL_IMPORT_PATH");
855 envdup = strdup(env);
856 dir = strtok(envdup, ":");
857 while (dir && error) {
858 (void) snprintf(path, len, "%s/%s", dir, name);
859 error = access(path, F_OK);
860 dir = strtok(NULL, ":");
864 for (i = 0; i < DEFAULT_IMPORT_PATH_SIZE && error < 0; i++) {
865 (void) snprintf(path, len, "%s/%s",
866 zpool_default_import_path[i], name);
867 error = access(path, F_OK);
871 return (error ? ENOENT : 0);
875 * Given a shorthand device name look for a match against 'cmp_name'. This
876 * is done by checking all prefix expansions using either the default
877 * 'zpool_default_import_paths' or the ZPOOL_IMPORT_PATH environment
878 * variable. Proper partition suffixes will be appended if this is a
879 * whole disk. When a match is found 0 is returned otherwise ENOENT.
882 zfs_strcmp_shortname(char *name, char *cmp_name, int wholedisk)
884 int path_len, cmp_len, i = 0, error = ENOENT;
885 char *dir, *env, *envdup = NULL;
886 char path_name[MAXPATHLEN];
888 cmp_len = strlen(cmp_name);
889 env = getenv("ZPOOL_IMPORT_PATH");
892 envdup = strdup(env);
893 dir = strtok(envdup, ":");
895 dir = zpool_default_import_path[i];
899 /* Trim trailing directory slashes from ZPOOL_IMPORT_PATH */
900 while (dir[strlen(dir)-1] == '/')
901 dir[strlen(dir)-1] = '\0';
903 path_len = snprintf(path_name, MAXPATHLEN, "%s/%s", dir, name);
905 path_len = zfs_append_partition(path_name, MAXPATHLEN);
907 if ((path_len == cmp_len) && !strcmp(path_name, cmp_name)) {
913 dir = strtok(NULL, ":");
914 } else if (++i < DEFAULT_IMPORT_PATH_SIZE) {
915 dir = zpool_default_import_path[i];
928 * Given either a shorthand or fully qualified path name look for a match
929 * against 'cmp'. The passed name will be expanded as needed for comparison
930 * purposes and redundant slashes stripped to ensure an accurate match.
933 zfs_strcmp_pathname(char *name, char *cmp, int wholedisk)
935 int path_len, cmp_len;
936 char path_name[MAXPATHLEN];
937 char cmp_name[MAXPATHLEN];
940 /* Strip redundant slashes if one exists due to ZPOOL_IMPORT_PATH */
941 memset(cmp_name, 0, MAXPATHLEN);
942 dir = strtok(cmp, "/");
944 strcat(cmp_name, "/");
945 strcat(cmp_name, dir);
946 dir = strtok(NULL, "/");
950 return zfs_strcmp_shortname(name, cmp_name, wholedisk);
952 strncpy(path_name, name, MAXPATHLEN);
953 path_len = strlen(path_name);
954 cmp_len = strlen(cmp_name);
957 path_len = zfs_append_partition(path_name, MAXPATHLEN);
962 if ((path_len != cmp_len) || strcmp(path_name, cmp_name))
969 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
973 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
977 zc->zc_nvlist_dst_size = len;
978 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
979 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
986 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
987 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
988 * filled in by the kernel to indicate the actual required size.
991 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
993 free((void *)(uintptr_t)zc->zc_nvlist_dst);
994 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
995 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
1002 * Called to free the src and dst nvlists stored in the command structure.
1005 zcmd_free_nvlists(zfs_cmd_t *zc)
1007 free((void *)(uintptr_t)zc->zc_nvlist_conf);
1008 free((void *)(uintptr_t)zc->zc_nvlist_src);
1009 free((void *)(uintptr_t)zc->zc_nvlist_dst);
1013 zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
1019 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
1021 if ((packed = zfs_alloc(hdl, len)) == NULL)
1024 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
1026 *outnv = (uint64_t)(uintptr_t)packed;
1033 zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
1035 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
1036 &zc->zc_nvlist_conf_size, nvl));
1040 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
1042 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
1043 &zc->zc_nvlist_src_size, nvl));
1047 * Unpacks an nvlist from the ZFS ioctl command structure.
1050 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
1052 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
1053 zc->zc_nvlist_dst_size, nvlp, 0) != 0)
1054 return (no_memory(hdl));
1060 zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
1064 zc->zc_history = (uint64_t)(uintptr_t)hdl->libzfs_log_str;
1065 error = ioctl(hdl->libzfs_fd, request, zc);
1066 if (hdl->libzfs_log_str) {
1067 free(hdl->libzfs_log_str);
1068 hdl->libzfs_log_str = NULL;
1076 * ================================================================
1077 * API shared by zfs and zpool property management
1078 * ================================================================
1082 zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
1084 zprop_list_t *pl = cbp->cb_proplist;
1089 cbp->cb_first = B_FALSE;
1090 if (cbp->cb_scripted)
1094 * Start with the length of the column headers.
1096 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
1097 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
1099 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
1101 cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
1103 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
1106 /* first property is always NAME */
1107 assert(cbp->cb_proplist->pl_prop ==
1108 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME));
1111 * Go through and calculate the widths for each column. For the
1112 * 'source' column, we kludge it up by taking the worst-case scenario of
1113 * inheriting from the longest name. This is acceptable because in the
1114 * majority of cases 'SOURCE' is the last column displayed, and we don't
1115 * use the width anyway. Note that the 'VALUE' column can be oversized,
1116 * if the name of the property is much longer than any values we find.
1118 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
1122 if (pl->pl_prop != ZPROP_INVAL) {
1123 const char *propname = (type == ZFS_TYPE_POOL) ?
1124 zpool_prop_to_name(pl->pl_prop) :
1125 zfs_prop_to_name(pl->pl_prop);
1127 len = strlen(propname);
1128 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
1129 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
1131 len = strlen(pl->pl_user_prop);
1132 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
1133 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
1137 * 'VALUE' column. The first property is always the 'name'
1138 * property that was tacked on either by /sbin/zfs's
1139 * zfs_do_get() or when calling zprop_expand_list(), so we
1140 * ignore its width. If the user specified the name property
1141 * to display, then it will be later in the list in any case.
1143 if (pl != cbp->cb_proplist &&
1144 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
1145 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
1147 /* 'RECEIVED' column. */
1148 if (pl != cbp->cb_proplist &&
1149 pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
1150 cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
1153 * 'NAME' and 'SOURCE' columns
1155 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
1157 pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
1158 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
1159 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
1160 strlen(dgettext(TEXT_DOMAIN, "inherited from"));
1165 * Now go through and print the headers.
1167 for (i = 0; i < ZFS_GET_NCOLS; i++) {
1168 switch (cbp->cb_columns[i]) {
1170 title = dgettext(TEXT_DOMAIN, "NAME");
1172 case GET_COL_PROPERTY:
1173 title = dgettext(TEXT_DOMAIN, "PROPERTY");
1176 title = dgettext(TEXT_DOMAIN, "VALUE");
1179 title = dgettext(TEXT_DOMAIN, "RECEIVED");
1181 case GET_COL_SOURCE:
1182 title = dgettext(TEXT_DOMAIN, "SOURCE");
1188 if (title != NULL) {
1189 if (i == (ZFS_GET_NCOLS - 1) ||
1190 cbp->cb_columns[i + 1] == GET_COL_NONE)
1191 (void) printf("%s", title);
1193 (void) printf("%-*s ",
1194 cbp->cb_colwidths[cbp->cb_columns[i]],
1198 (void) printf("\n");
1202 * Display a single line of output, according to the settings in the callback
1206 zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
1207 const char *propname, const char *value, zprop_source_t sourcetype,
1208 const char *source, const char *recvd_value)
1211 const char *str = NULL;
1215 * Ignore those source types that the user has chosen to ignore.
1217 if ((sourcetype & cbp->cb_sources) == 0)
1221 zprop_print_headers(cbp, cbp->cb_type);
1223 for (i = 0; i < ZFS_GET_NCOLS; i++) {
1224 switch (cbp->cb_columns[i]) {
1229 case GET_COL_PROPERTY:
1237 case GET_COL_SOURCE:
1238 switch (sourcetype) {
1239 case ZPROP_SRC_NONE:
1243 case ZPROP_SRC_DEFAULT:
1247 case ZPROP_SRC_LOCAL:
1251 case ZPROP_SRC_TEMPORARY:
1255 case ZPROP_SRC_INHERITED:
1256 (void) snprintf(buf, sizeof (buf),
1257 "inherited from %s", source);
1260 case ZPROP_SRC_RECEIVED:
1267 str = (recvd_value == NULL ? "-" : recvd_value);
1274 if (cbp->cb_columns[i + 1] == GET_COL_NONE)
1275 (void) printf("%s", str);
1276 else if (cbp->cb_scripted)
1277 (void) printf("%s\t", str);
1279 (void) printf("%-*s ",
1280 cbp->cb_colwidths[cbp->cb_columns[i]],
1284 (void) printf("\n");
1288 * Given a numeric suffix, convert the value into a number of bits that the
1289 * resulting value must be shifted.
1292 str2shift(libzfs_handle_t *hdl, const char *buf)
1294 const char *ends = "BKMGTPEZ";
1299 for (i = 0; i < strlen(ends); i++) {
1300 if (toupper(buf[0]) == ends[i])
1303 if (i == strlen(ends)) {
1305 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1306 "invalid numeric suffix '%s'"), buf);
1311 * Allow 'G' = 'GB' = 'GiB', case-insensitively.
1312 * However, 'BB' and 'BiB' are disallowed.
1314 if (buf[1] == '\0' ||
1315 (toupper(buf[0]) != 'B' &&
1316 ((toupper(buf[1]) == 'B' && buf[2] == '\0') ||
1317 (toupper(buf[1]) == 'I' && toupper(buf[2]) == 'B' &&
1322 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1323 "invalid numeric suffix '%s'"), buf);
1328 * Convert a string of the form '100G' into a real number. Used when setting
1329 * properties or creating a volume. 'buf' is used to place an extended error
1330 * message for the caller to use.
1333 zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1340 /* Check to see if this looks like a number. */
1341 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1343 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1344 "bad numeric value '%s'"), value);
1348 /* Rely on strtoull() to process the numeric portion. */
1350 *num = strtoull(value, &end, 10);
1353 * Check for ERANGE, which indicates that the value is too large to fit
1354 * in a 64-bit value.
1356 if (errno == ERANGE) {
1358 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1359 "numeric value is too large"));
1364 * If we have a decimal value, then do the computation with floating
1365 * point arithmetic. Otherwise, use standard arithmetic.
1368 double fval = strtod(value, &end);
1370 if ((shift = str2shift(hdl, end)) == -1)
1373 fval *= pow(2, shift);
1375 if (fval > UINT64_MAX) {
1377 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1378 "numeric value is too large"));
1382 *num = (uint64_t)fval;
1384 if ((shift = str2shift(hdl, end)) == -1)
1387 /* Check for overflow */
1388 if (shift >= 64 || (*num << shift) >> shift != *num) {
1390 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1391 "numeric value is too large"));
1402 * Given a propname=value nvpair to set, parse any numeric properties
1403 * (index, boolean, etc) if they are specified as strings and add the
1404 * resulting nvpair to the returned nvlist.
1406 * At the DSL layer, all properties are either 64-bit numbers or strings.
1407 * We want the user to be able to ignore this fact and specify properties
1408 * as native values (numbers, for example) or as strings (to simplify
1409 * command line utilities). This also handles converting index types
1410 * (compression, checksum, etc) from strings to their on-disk index.
1413 zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1414 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1417 data_type_t datatype = nvpair_type(elem);
1418 zprop_type_t proptype;
1419 const char *propname;
1421 boolean_t isnone = B_FALSE;
1423 if (type == ZFS_TYPE_POOL) {
1424 proptype = zpool_prop_get_type(prop);
1425 propname = zpool_prop_to_name(prop);
1427 proptype = zfs_prop_get_type(prop);
1428 propname = zfs_prop_to_name(prop);
1432 * Convert any properties to the internal DSL value types.
1438 case PROP_TYPE_STRING:
1439 if (datatype != DATA_TYPE_STRING) {
1440 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1441 "'%s' must be a string"), nvpair_name(elem));
1444 (void) nvpair_value_string(elem, svalp);
1445 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1446 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1447 "'%s' is too long"), nvpair_name(elem));
1452 case PROP_TYPE_NUMBER:
1453 if (datatype == DATA_TYPE_STRING) {
1454 (void) nvpair_value_string(elem, &value);
1455 if (strcmp(value, "none") == 0) {
1457 } else if (zfs_nicestrtonum(hdl, value, ivalp)
1461 } else if (datatype == DATA_TYPE_UINT64) {
1462 (void) nvpair_value_uint64(elem, ivalp);
1464 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1465 "'%s' must be a number"), nvpair_name(elem));
1470 * Quota special: force 'none' and don't allow 0.
1472 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1473 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1474 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1475 "use 'none' to disable quota/refquota"));
1480 case PROP_TYPE_INDEX:
1481 if (datatype != DATA_TYPE_STRING) {
1482 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1483 "'%s' must be a string"), nvpair_name(elem));
1487 (void) nvpair_value_string(elem, &value);
1489 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1490 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1491 "'%s' must be one of '%s'"), propname,
1492 zprop_values(prop, type));
1502 * Add the result to our return set of properties.
1504 if (*svalp != NULL) {
1505 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1506 (void) no_memory(hdl);
1510 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1511 (void) no_memory(hdl);
1518 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1523 addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1527 zprop_list_t *entry;
1529 prop = zprop_name_to_prop(propname, type);
1531 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type))
1535 * When no property table entry can be found, return failure if
1536 * this is a pool property or if this isn't a user-defined
1539 if (prop == ZPROP_INVAL && ((type == ZFS_TYPE_POOL &&
1540 !zpool_prop_feature(propname) &&
1541 !zpool_prop_unsupported(propname)) ||
1542 (type == ZFS_TYPE_DATASET && !zfs_prop_user(propname) &&
1543 !zfs_prop_userquota(propname) && !zfs_prop_written(propname)))) {
1544 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1545 "invalid property '%s'"), propname);
1546 return (zfs_error(hdl, EZFS_BADPROP,
1547 dgettext(TEXT_DOMAIN, "bad property list")));
1550 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1553 entry->pl_prop = prop;
1554 if (prop == ZPROP_INVAL) {
1555 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) ==
1560 entry->pl_width = strlen(propname);
1562 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1572 * Given a comma-separated list of properties, construct a property list
1573 * containing both user-defined and native properties. This function will
1574 * return a NULL list if 'all' is specified, which can later be expanded
1575 * by zprop_expand_list().
1578 zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1584 * If 'all' is specified, return a NULL list.
1586 if (strcmp(props, "all") == 0)
1590 * If no props were specified, return an error.
1592 if (props[0] == '\0') {
1593 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1594 "no properties specified"));
1595 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1596 "bad property list")));
1600 * It would be nice to use getsubopt() here, but the inclusion of column
1601 * aliases makes this more effort than it's worth.
1603 while (*props != '\0') {
1608 if ((p = strchr(props, ',')) == NULL) {
1609 len = strlen(props);
1616 * Check for empty options.
1619 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1620 "empty property name"));
1621 return (zfs_error(hdl, EZFS_BADPROP,
1622 dgettext(TEXT_DOMAIN, "bad property list")));
1626 * Check all regular property names.
1631 if (strcmp(props, "space") == 0) {
1632 static char *spaceprops[] = {
1633 "name", "avail", "used", "usedbysnapshots",
1634 "usedbydataset", "usedbyrefreservation",
1635 "usedbychildren", NULL
1639 for (i = 0; spaceprops[i]; i++) {
1640 if (addlist(hdl, spaceprops[i], listp, type))
1642 listp = &(*listp)->pl_next;
1645 if (addlist(hdl, props, listp, type))
1647 listp = &(*listp)->pl_next;
1659 zprop_free_list(zprop_list_t *pl)
1663 while (pl != NULL) {
1665 free(pl->pl_user_prop);
1671 typedef struct expand_data {
1672 zprop_list_t **last;
1673 libzfs_handle_t *hdl;
1678 zprop_expand_list_cb(int prop, void *cb)
1680 zprop_list_t *entry;
1681 expand_data_t *edp = cb;
1683 if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1684 return (ZPROP_INVAL);
1686 entry->pl_prop = prop;
1687 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1688 entry->pl_all = B_TRUE;
1690 *(edp->last) = entry;
1691 edp->last = &entry->pl_next;
1693 return (ZPROP_CONT);
1697 zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1699 zprop_list_t *entry;
1700 zprop_list_t **last;
1705 * If this is the very first time we've been called for an 'all'
1706 * specification, expand the list to include all native
1715 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1716 B_FALSE, type) == ZPROP_INVAL)
1720 * Add 'name' to the beginning of the list, which is handled
1723 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1726 entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME :
1728 entry->pl_width = zprop_width(entry->pl_prop,
1729 &entry->pl_fixed, type);
1730 entry->pl_all = B_TRUE;
1731 entry->pl_next = *plp;
1738 zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1741 return (zprop_iter_common(func, cb, show_all, ordered, type));