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
[], int flags
)
642 if (!(flags
& STDOUT_VERBOSE
))
643 close(STDOUT_FILENO
);
645 if (!(flags
& STDERR_VERBOSE
))
646 close(STDERR_FILENO
);
648 (void) execvp(path
, argv
);
650 } else if (pid
> 0) {
653 while ((rc
= waitpid(pid
, &status
, 0)) == -1 &&
655 if (rc
< 0 || !WIFEXITED(status
))
658 return WEXITSTATUS(status
);
665 libzfs_load_module(const char *module
)
667 char *argv
[4] = {"/sbin/modprobe", "-q", (char *)module
, (char *)0};
669 if (libzfs_module_loaded(module
))
672 return libzfs_run_process("/sbin/modprobe", argv
, 0);
678 libzfs_handle_t
*hdl
;
680 if (libzfs_load_module("zfs") != 0) {
681 (void) fprintf(stderr
, gettext("Failed to load ZFS module "
682 "stack.\nLoad the module manually by running "
683 "'insmod <location>/zfs.ko' as root.\n"));
687 if ((hdl
= calloc(1, sizeof (libzfs_handle_t
))) == NULL
) {
691 if ((hdl
->libzfs_fd
= open(ZFS_DEV
, O_RDWR
)) < 0) {
692 (void) fprintf(stderr
, gettext("Unable to open %s: %s.\n"),
693 ZFS_DEV
, strerror(errno
));
695 (void) fprintf(stderr
,
696 gettext("Verify the ZFS module stack is "
697 "loaded by running '/sbin/modprobe zfs'.\n"));
703 #ifdef HAVE_SETMNTENT
704 if ((hdl
->libzfs_mnttab
= setmntent(MNTTAB
, "r")) == NULL
) {
706 if ((hdl
->libzfs_mnttab
= fopen(MNTTAB
, "r")) == NULL
) {
708 (void) close(hdl
->libzfs_fd
);
713 hdl
->libzfs_sharetab
= fopen("/etc/dfs/sharetab", "r");
717 libzfs_mnttab_init(hdl
);
723 libzfs_fini(libzfs_handle_t
*hdl
)
725 (void) close(hdl
->libzfs_fd
);
726 if (hdl
->libzfs_mnttab
)
727 #ifdef HAVE_SETMNTENT
728 (void) endmntent(hdl
->libzfs_mnttab
);
730 (void) fclose(hdl
->libzfs_mnttab
);
732 if (hdl
->libzfs_sharetab
)
733 (void) fclose(hdl
->libzfs_sharetab
);
734 zfs_uninit_libshare(hdl
);
735 if (hdl
->libzfs_log_str
)
736 (void) free(hdl
->libzfs_log_str
);
737 zpool_free_handles(hdl
);
738 libzfs_fru_clear(hdl
, B_TRUE
);
739 namespace_clear(hdl
);
740 libzfs_mnttab_fini(hdl
);
745 zpool_get_handle(zpool_handle_t
*zhp
)
747 return (zhp
->zpool_hdl
);
751 zfs_get_handle(zfs_handle_t
*zhp
)
753 return (zhp
->zfs_hdl
);
757 zfs_get_pool_handle(const zfs_handle_t
*zhp
)
759 return (zhp
->zpool_hdl
);
763 * Given a name, determine whether or not it's a valid path
764 * (starts with '/' or "./"). If so, walk the mnttab trying
765 * to match the device number. If not, treat the path as an
769 zfs_path_to_zhandle(libzfs_handle_t
*hdl
, char *path
, zfs_type_t argtype
)
771 struct stat64 statbuf
;
772 struct extmnttab entry
;
775 if (path
[0] != '/' && strncmp(path
, "./", strlen("./")) != 0) {
777 * It's not a valid path, assume it's a name of type 'argtype'.
779 return (zfs_open(hdl
, path
, argtype
));
782 if (stat64(path
, &statbuf
) != 0) {
783 (void) fprintf(stderr
, "%s: %s\n", path
, strerror(errno
));
787 rewind(hdl
->libzfs_mnttab
);
788 while ((ret
= getextmntent(hdl
->libzfs_mnttab
, &entry
, 0)) == 0) {
789 if (makedevice(entry
.mnt_major
, entry
.mnt_minor
) ==
798 if (strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0) {
799 (void) fprintf(stderr
, gettext("'%s': not a ZFS filesystem\n"),
804 return (zfs_open(hdl
, entry
.mnt_special
, ZFS_TYPE_FILESYSTEM
));
808 * Given a shorthand device name, check if a file by that name exists in a list
809 * of directories under /dev. If one is found, store its full path in the
810 * buffer pointed to by the path argument and return 0, else return -1. The
811 * path buffer must be allocated by the caller.
814 zfs_resolve_shortname(const char *name
, char *path
, size_t pathlen
)
817 char dirs
[5][9] = {"by-id", "by-label", "by-path", "by-uuid", "zpool"};
819 (void) snprintf(path
, pathlen
, "%s/%s", DISK_ROOT
, name
);
820 err
= access(path
, F_OK
);
821 for (i
= 0; i
< 5 && err
< 0; i
++) {
822 (void) snprintf(path
, pathlen
, "%s/%s/%s",
823 UDISK_ROOT
, dirs
[i
], name
);
824 err
= access(path
, F_OK
);
830 * Append partition suffix to a device path. This should be used to generate
831 * the name of a whole disk as it is stored in the vdev label. The
832 * user-visible names of whole disks do not contain the partition information.
833 * Modifies buf which must be allocated by the caller.
836 zfs_append_partition(const char *path
, char *buf
, size_t buflen
)
838 if (strncmp(path
, UDISK_ROOT
, strlen(UDISK_ROOT
)) == 0)
839 (void) snprintf(buf
, buflen
, "%s%s%s", path
, "-part",
842 (void) snprintf(buf
, buflen
, "%s%s%s", path
,
843 isdigit(path
[strlen(path
)-1]) ? "p" : "",
848 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
852 zcmd_alloc_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, size_t len
)
856 zc
->zc_nvlist_dst_size
= len
;
857 if ((zc
->zc_nvlist_dst
= (uint64_t)(uintptr_t)
858 zfs_alloc(hdl
, zc
->zc_nvlist_dst_size
)) == 0)
865 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
866 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
867 * filled in by the kernel to indicate the actual required size.
870 zcmd_expand_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
)
872 free((void *)(uintptr_t)zc
->zc_nvlist_dst
);
873 if ((zc
->zc_nvlist_dst
= (uint64_t)(uintptr_t)
874 zfs_alloc(hdl
, zc
->zc_nvlist_dst_size
)) == 0)
881 * Called to free the src and dst nvlists stored in the command structure.
884 zcmd_free_nvlists(zfs_cmd_t
*zc
)
886 free((void *)(uintptr_t)zc
->zc_nvlist_conf
);
887 free((void *)(uintptr_t)zc
->zc_nvlist_src
);
888 free((void *)(uintptr_t)zc
->zc_nvlist_dst
);
892 zcmd_write_nvlist_com(libzfs_handle_t
*hdl
, uint64_t *outnv
, uint64_t *outlen
,
898 verify(nvlist_size(nvl
, &len
, NV_ENCODE_NATIVE
) == 0);
900 if ((packed
= zfs_alloc(hdl
, len
)) == NULL
)
903 verify(nvlist_pack(nvl
, &packed
, &len
, NV_ENCODE_NATIVE
, 0) == 0);
905 *outnv
= (uint64_t)(uintptr_t)packed
;
912 zcmd_write_conf_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
*nvl
)
914 return (zcmd_write_nvlist_com(hdl
, &zc
->zc_nvlist_conf
,
915 &zc
->zc_nvlist_conf_size
, nvl
));
919 zcmd_write_src_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
*nvl
)
921 return (zcmd_write_nvlist_com(hdl
, &zc
->zc_nvlist_src
,
922 &zc
->zc_nvlist_src_size
, nvl
));
926 * Unpacks an nvlist from the ZFS ioctl command structure.
929 zcmd_read_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
**nvlp
)
931 if (nvlist_unpack((void *)(uintptr_t)zc
->zc_nvlist_dst
,
932 zc
->zc_nvlist_dst_size
, nvlp
, 0) != 0)
933 return (no_memory(hdl
));
939 zfs_ioctl(libzfs_handle_t
*hdl
, int request
, zfs_cmd_t
*zc
)
943 zc
->zc_history
= (uint64_t)(uintptr_t)hdl
->libzfs_log_str
;
944 error
= ioctl(hdl
->libzfs_fd
, request
, zc
);
945 if (hdl
->libzfs_log_str
) {
946 free(hdl
->libzfs_log_str
);
947 hdl
->libzfs_log_str
= NULL
;
955 * ================================================================
956 * API shared by zfs and zpool property management
957 * ================================================================
961 zprop_print_headers(zprop_get_cbdata_t
*cbp
, zfs_type_t type
)
963 zprop_list_t
*pl
= cbp
->cb_proplist
;
968 cbp
->cb_first
= B_FALSE
;
969 if (cbp
->cb_scripted
)
973 * Start with the length of the column headers.
975 cbp
->cb_colwidths
[GET_COL_NAME
] = strlen(dgettext(TEXT_DOMAIN
, "NAME"));
976 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = strlen(dgettext(TEXT_DOMAIN
,
978 cbp
->cb_colwidths
[GET_COL_VALUE
] = strlen(dgettext(TEXT_DOMAIN
,
980 cbp
->cb_colwidths
[GET_COL_RECVD
] = strlen(dgettext(TEXT_DOMAIN
,
982 cbp
->cb_colwidths
[GET_COL_SOURCE
] = strlen(dgettext(TEXT_DOMAIN
,
985 /* first property is always NAME */
986 assert(cbp
->cb_proplist
->pl_prop
==
987 ((type
== ZFS_TYPE_POOL
) ? ZPOOL_PROP_NAME
: ZFS_PROP_NAME
));
990 * Go through and calculate the widths for each column. For the
991 * 'source' column, we kludge it up by taking the worst-case scenario of
992 * inheriting from the longest name. This is acceptable because in the
993 * majority of cases 'SOURCE' is the last column displayed, and we don't
994 * use the width anyway. Note that the 'VALUE' column can be oversized,
995 * if the name of the property is much longer than any values we find.
997 for (pl
= cbp
->cb_proplist
; pl
!= NULL
; pl
= pl
->pl_next
) {
1001 if (pl
->pl_prop
!= ZPROP_INVAL
) {
1002 const char *propname
= (type
== ZFS_TYPE_POOL
) ?
1003 zpool_prop_to_name(pl
->pl_prop
) :
1004 zfs_prop_to_name(pl
->pl_prop
);
1006 len
= strlen(propname
);
1007 if (len
> cbp
->cb_colwidths
[GET_COL_PROPERTY
])
1008 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = len
;
1010 len
= strlen(pl
->pl_user_prop
);
1011 if (len
> cbp
->cb_colwidths
[GET_COL_PROPERTY
])
1012 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = len
;
1016 * 'VALUE' column. The first property is always the 'name'
1017 * property that was tacked on either by /sbin/zfs's
1018 * zfs_do_get() or when calling zprop_expand_list(), so we
1019 * ignore its width. If the user specified the name property
1020 * to display, then it will be later in the list in any case.
1022 if (pl
!= cbp
->cb_proplist
&&
1023 pl
->pl_width
> cbp
->cb_colwidths
[GET_COL_VALUE
])
1024 cbp
->cb_colwidths
[GET_COL_VALUE
] = pl
->pl_width
;
1026 /* 'RECEIVED' column. */
1027 if (pl
!= cbp
->cb_proplist
&&
1028 pl
->pl_recvd_width
> cbp
->cb_colwidths
[GET_COL_RECVD
])
1029 cbp
->cb_colwidths
[GET_COL_RECVD
] = pl
->pl_recvd_width
;
1032 * 'NAME' and 'SOURCE' columns
1034 if (pl
->pl_prop
== (type
== ZFS_TYPE_POOL
? ZPOOL_PROP_NAME
:
1036 pl
->pl_width
> cbp
->cb_colwidths
[GET_COL_NAME
]) {
1037 cbp
->cb_colwidths
[GET_COL_NAME
] = pl
->pl_width
;
1038 cbp
->cb_colwidths
[GET_COL_SOURCE
] = pl
->pl_width
+
1039 strlen(dgettext(TEXT_DOMAIN
, "inherited from"));
1044 * Now go through and print the headers.
1046 for (i
= 0; i
< ZFS_GET_NCOLS
; i
++) {
1047 switch (cbp
->cb_columns
[i
]) {
1049 title
= dgettext(TEXT_DOMAIN
, "NAME");
1051 case GET_COL_PROPERTY
:
1052 title
= dgettext(TEXT_DOMAIN
, "PROPERTY");
1055 title
= dgettext(TEXT_DOMAIN
, "VALUE");
1058 title
= dgettext(TEXT_DOMAIN
, "RECEIVED");
1060 case GET_COL_SOURCE
:
1061 title
= dgettext(TEXT_DOMAIN
, "SOURCE");
1067 if (title
!= NULL
) {
1068 if (i
== (ZFS_GET_NCOLS
- 1) ||
1069 cbp
->cb_columns
[i
+ 1] == GET_COL_NONE
)
1070 (void) printf("%s", title
);
1072 (void) printf("%-*s ",
1073 cbp
->cb_colwidths
[cbp
->cb_columns
[i
]],
1077 (void) printf("\n");
1081 * Display a single line of output, according to the settings in the callback
1085 zprop_print_one_property(const char *name
, zprop_get_cbdata_t
*cbp
,
1086 const char *propname
, const char *value
, zprop_source_t sourcetype
,
1087 const char *source
, const char *recvd_value
)
1090 const char *str
= NULL
;
1094 * Ignore those source types that the user has chosen to ignore.
1096 if ((sourcetype
& cbp
->cb_sources
) == 0)
1100 zprop_print_headers(cbp
, cbp
->cb_type
);
1102 for (i
= 0; i
< ZFS_GET_NCOLS
; i
++) {
1103 switch (cbp
->cb_columns
[i
]) {
1108 case GET_COL_PROPERTY
:
1116 case GET_COL_SOURCE
:
1117 switch (sourcetype
) {
1118 case ZPROP_SRC_NONE
:
1122 case ZPROP_SRC_DEFAULT
:
1126 case ZPROP_SRC_LOCAL
:
1130 case ZPROP_SRC_TEMPORARY
:
1134 case ZPROP_SRC_INHERITED
:
1135 (void) snprintf(buf
, sizeof (buf
),
1136 "inherited from %s", source
);
1139 case ZPROP_SRC_RECEIVED
:
1146 str
= (recvd_value
== NULL
? "-" : recvd_value
);
1153 if (cbp
->cb_columns
[i
+ 1] == GET_COL_NONE
)
1154 (void) printf("%s", str
);
1155 else if (cbp
->cb_scripted
)
1156 (void) printf("%s\t", str
);
1158 (void) printf("%-*s ",
1159 cbp
->cb_colwidths
[cbp
->cb_columns
[i
]],
1163 (void) printf("\n");
1167 * Given a numeric suffix, convert the value into a number of bits that the
1168 * resulting value must be shifted.
1171 str2shift(libzfs_handle_t
*hdl
, const char *buf
)
1173 const char *ends
= "BKMGTPEZ";
1178 for (i
= 0; i
< strlen(ends
); i
++) {
1179 if (toupper(buf
[0]) == ends
[i
])
1182 if (i
== strlen(ends
)) {
1183 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1184 "invalid numeric suffix '%s'"), buf
);
1189 * Allow 'G' = 'GB' = 'GiB', case-insensitively.
1190 * However, 'BB' and 'BiB' are disallowed.
1192 if (buf
[1] == '\0' ||
1193 (toupper(buf
[0]) != 'B' &&
1194 ((toupper(buf
[1]) == 'B' && buf
[2] == '\0') ||
1195 (toupper(buf
[1]) == 'I' && toupper(buf
[2]) == 'B' &&
1199 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1200 "invalid numeric suffix '%s'"), buf
);
1205 * Convert a string of the form '100G' into a real number. Used when setting
1206 * properties or creating a volume. 'buf' is used to place an extended error
1207 * message for the caller to use.
1210 zfs_nicestrtonum(libzfs_handle_t
*hdl
, const char *value
, uint64_t *num
)
1217 /* Check to see if this looks like a number. */
1218 if ((value
[0] < '0' || value
[0] > '9') && value
[0] != '.') {
1220 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1221 "bad numeric value '%s'"), value
);
1225 /* Rely on strtoull() to process the numeric portion. */
1227 *num
= strtoull(value
, &end
, 10);
1230 * Check for ERANGE, which indicates that the value is too large to fit
1231 * in a 64-bit value.
1233 if (errno
== ERANGE
) {
1235 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1236 "numeric value is too large"));
1241 * If we have a decimal value, then do the computation with floating
1242 * point arithmetic. Otherwise, use standard arithmetic.
1245 double fval
= strtod(value
, &end
);
1247 if ((shift
= str2shift(hdl
, end
)) == -1)
1250 fval
*= pow(2, shift
);
1252 if (fval
> UINT64_MAX
) {
1254 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1255 "numeric value is too large"));
1259 *num
= (uint64_t)fval
;
1261 if ((shift
= str2shift(hdl
, end
)) == -1)
1264 /* Check for overflow */
1265 if (shift
>= 64 || (*num
<< shift
) >> shift
!= *num
) {
1267 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1268 "numeric value is too large"));
1279 * Given a propname=value nvpair to set, parse any numeric properties
1280 * (index, boolean, etc) if they are specified as strings and add the
1281 * resulting nvpair to the returned nvlist.
1283 * At the DSL layer, all properties are either 64-bit numbers or strings.
1284 * We want the user to be able to ignore this fact and specify properties
1285 * as native values (numbers, for example) or as strings (to simplify
1286 * command line utilities). This also handles converting index types
1287 * (compression, checksum, etc) from strings to their on-disk index.
1290 zprop_parse_value(libzfs_handle_t
*hdl
, nvpair_t
*elem
, int prop
,
1291 zfs_type_t type
, nvlist_t
*ret
, char **svalp
, uint64_t *ivalp
,
1294 data_type_t datatype
= nvpair_type(elem
);
1295 zprop_type_t proptype
;
1296 const char *propname
;
1298 boolean_t isnone
= B_FALSE
;
1300 if (type
== ZFS_TYPE_POOL
) {
1301 proptype
= zpool_prop_get_type(prop
);
1302 propname
= zpool_prop_to_name(prop
);
1304 proptype
= zfs_prop_get_type(prop
);
1305 propname
= zfs_prop_to_name(prop
);
1309 * Convert any properties to the internal DSL value types.
1315 case PROP_TYPE_STRING
:
1316 if (datatype
!= DATA_TYPE_STRING
) {
1317 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1318 "'%s' must be a string"), nvpair_name(elem
));
1321 (void) nvpair_value_string(elem
, svalp
);
1322 if (strlen(*svalp
) >= ZFS_MAXPROPLEN
) {
1323 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1324 "'%s' is too long"), nvpair_name(elem
));
1329 case PROP_TYPE_NUMBER
:
1330 if (datatype
== DATA_TYPE_STRING
) {
1331 (void) nvpair_value_string(elem
, &value
);
1332 if (strcmp(value
, "none") == 0) {
1334 } else if (zfs_nicestrtonum(hdl
, value
, ivalp
)
1338 } else if (datatype
== DATA_TYPE_UINT64
) {
1339 (void) nvpair_value_uint64(elem
, ivalp
);
1341 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1342 "'%s' must be a number"), nvpair_name(elem
));
1347 * Quota special: force 'none' and don't allow 0.
1349 if ((type
& ZFS_TYPE_DATASET
) && *ivalp
== 0 && !isnone
&&
1350 (prop
== ZFS_PROP_QUOTA
|| prop
== ZFS_PROP_REFQUOTA
)) {
1351 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1352 "use 'none' to disable quota/refquota"));
1357 case PROP_TYPE_INDEX
:
1358 if (datatype
!= DATA_TYPE_STRING
) {
1359 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1360 "'%s' must be a string"), nvpair_name(elem
));
1364 (void) nvpair_value_string(elem
, &value
);
1366 if (zprop_string_to_index(prop
, value
, ivalp
, type
) != 0) {
1367 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1368 "'%s' must be one of '%s'"), propname
,
1369 zprop_values(prop
, type
));
1379 * Add the result to our return set of properties.
1381 if (*svalp
!= NULL
) {
1382 if (nvlist_add_string(ret
, propname
, *svalp
) != 0) {
1383 (void) no_memory(hdl
);
1387 if (nvlist_add_uint64(ret
, propname
, *ivalp
) != 0) {
1388 (void) no_memory(hdl
);
1395 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1400 addlist(libzfs_handle_t
*hdl
, char *propname
, zprop_list_t
**listp
,
1404 zprop_list_t
*entry
;
1406 prop
= zprop_name_to_prop(propname
, type
);
1408 if (prop
!= ZPROP_INVAL
&& !zprop_valid_for_type(prop
, type
))
1412 * When no property table entry can be found, return failure if
1413 * this is a pool property or if this isn't a user-defined
1416 if (prop
== ZPROP_INVAL
&& (type
== ZFS_TYPE_POOL
||
1417 (!zfs_prop_user(propname
) && !zfs_prop_userquota(propname
)))) {
1418 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1419 "invalid property '%s'"), propname
);
1420 return (zfs_error(hdl
, EZFS_BADPROP
,
1421 dgettext(TEXT_DOMAIN
, "bad property list")));
1424 if ((entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
))) == NULL
)
1427 entry
->pl_prop
= prop
;
1428 if (prop
== ZPROP_INVAL
) {
1429 if ((entry
->pl_user_prop
= zfs_strdup(hdl
, propname
)) == NULL
) {
1433 entry
->pl_width
= strlen(propname
);
1435 entry
->pl_width
= zprop_width(prop
, &entry
->pl_fixed
,
1445 * Given a comma-separated list of properties, construct a property list
1446 * containing both user-defined and native properties. This function will
1447 * return a NULL list if 'all' is specified, which can later be expanded
1448 * by zprop_expand_list().
1451 zprop_get_list(libzfs_handle_t
*hdl
, char *props
, zprop_list_t
**listp
,
1457 * If 'all' is specified, return a NULL list.
1459 if (strcmp(props
, "all") == 0)
1463 * If no props were specified, return an error.
1465 if (props
[0] == '\0') {
1466 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1467 "no properties specified"));
1468 return (zfs_error(hdl
, EZFS_BADPROP
, dgettext(TEXT_DOMAIN
,
1469 "bad property list")));
1473 * It would be nice to use getsubopt() here, but the inclusion of column
1474 * aliases makes this more effort than it's worth.
1476 while (*props
!= '\0') {
1481 if ((p
= strchr(props
, ',')) == NULL
) {
1482 len
= strlen(props
);
1489 * Check for empty options.
1492 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1493 "empty property name"));
1494 return (zfs_error(hdl
, EZFS_BADPROP
,
1495 dgettext(TEXT_DOMAIN
, "bad property list")));
1499 * Check all regular property names.
1504 if (strcmp(props
, "space") == 0) {
1505 static char *spaceprops
[] = {
1506 "name", "avail", "used", "usedbysnapshots",
1507 "usedbydataset", "usedbyrefreservation",
1508 "usedbychildren", NULL
1512 for (i
= 0; spaceprops
[i
]; i
++) {
1513 if (addlist(hdl
, spaceprops
[i
], listp
, type
))
1515 listp
= &(*listp
)->pl_next
;
1518 if (addlist(hdl
, props
, listp
, type
))
1520 listp
= &(*listp
)->pl_next
;
1532 zprop_free_list(zprop_list_t
*pl
)
1536 while (pl
!= NULL
) {
1538 free(pl
->pl_user_prop
);
1544 typedef struct expand_data
{
1545 zprop_list_t
**last
;
1546 libzfs_handle_t
*hdl
;
1551 zprop_expand_list_cb(int prop
, void *cb
)
1553 zprop_list_t
*entry
;
1554 expand_data_t
*edp
= cb
;
1556 if ((entry
= zfs_alloc(edp
->hdl
, sizeof (zprop_list_t
))) == NULL
)
1557 return (ZPROP_INVAL
);
1559 entry
->pl_prop
= prop
;
1560 entry
->pl_width
= zprop_width(prop
, &entry
->pl_fixed
, edp
->type
);
1561 entry
->pl_all
= B_TRUE
;
1563 *(edp
->last
) = entry
;
1564 edp
->last
= &entry
->pl_next
;
1566 return (ZPROP_CONT
);
1570 zprop_expand_list(libzfs_handle_t
*hdl
, zprop_list_t
**plp
, zfs_type_t type
)
1572 zprop_list_t
*entry
;
1573 zprop_list_t
**last
;
1578 * If this is the very first time we've been called for an 'all'
1579 * specification, expand the list to include all native
1588 if (zprop_iter_common(zprop_expand_list_cb
, &exp
, B_FALSE
,
1589 B_FALSE
, type
) == ZPROP_INVAL
)
1593 * Add 'name' to the beginning of the list, which is handled
1596 if ((entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
))) == NULL
)
1599 entry
->pl_prop
= (type
== ZFS_TYPE_POOL
) ? ZPOOL_PROP_NAME
:
1601 entry
->pl_width
= zprop_width(entry
->pl_prop
,
1602 &entry
->pl_fixed
, type
);
1603 entry
->pl_all
= B_TRUE
;
1604 entry
->pl_next
= *plp
;
1611 zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
, boolean_t ordered
,
1614 return (zprop_iter_common(func
, cb
, show_all
, ordered
, type
));