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) 2018, Joyent, Inc. All rights reserved.
25 * Copyright (c) 2011, 2014 by Delphix. All rights reserved.
26 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
27 * Copyright (c) 2017 Datto Inc.
31 * Internal utility routines for the ZFS library.
45 #include <sys/mnttab.h>
46 #include <sys/mntent.h>
47 #include <sys/types.h>
51 #include <libzfs_core.h>
53 #include "libzfs_impl.h"
55 #include "zfeature_common.h"
56 #include <zfs_fletcher.h>
59 libzfs_errno(libzfs_handle_t
*hdl
)
61 return (hdl
->libzfs_error
);
65 libzfs_error_init(int error
)
69 return (dgettext(TEXT_DOMAIN
, "The ZFS modules are not "
70 "loaded.\nTry running '/sbin/modprobe zfs' as root "
73 return (dgettext(TEXT_DOMAIN
, "/dev/zfs and /proc/self/mounts "
74 "are required.\nTry running 'udevadm trigger' and 'mount "
75 "-t proc proc /proc' as root.\n"));
77 return (dgettext(TEXT_DOMAIN
, "The ZFS modules cannot be "
78 "auto-loaded.\nTry running '/sbin/modprobe zfs' as "
79 "root to manually load them.\n"));
81 return (dgettext(TEXT_DOMAIN
, "Permission denied the "
82 "ZFS utilities must be run as root.\n"));
84 return (dgettext(TEXT_DOMAIN
, "Failed to initialize the "
85 "libzfs library.\n"));
90 libzfs_error_action(libzfs_handle_t
*hdl
)
92 return (hdl
->libzfs_action
);
96 libzfs_error_description(libzfs_handle_t
*hdl
)
98 if (hdl
->libzfs_desc
[0] != '\0')
99 return (hdl
->libzfs_desc
);
101 switch (hdl
->libzfs_error
) {
103 return (dgettext(TEXT_DOMAIN
, "out of memory"));
105 return (dgettext(TEXT_DOMAIN
, "invalid property value"));
106 case EZFS_PROPREADONLY
:
107 return (dgettext(TEXT_DOMAIN
, "read-only property"));
109 return (dgettext(TEXT_DOMAIN
, "property doesn't apply to "
110 "datasets of this type"));
111 case EZFS_PROPNONINHERIT
:
112 return (dgettext(TEXT_DOMAIN
, "property cannot be inherited"));
114 return (dgettext(TEXT_DOMAIN
, "invalid quota or reservation"));
116 return (dgettext(TEXT_DOMAIN
, "operation not applicable to "
117 "datasets of this type"));
119 return (dgettext(TEXT_DOMAIN
, "pool or dataset is busy"));
121 return (dgettext(TEXT_DOMAIN
, "pool or dataset exists"));
123 return (dgettext(TEXT_DOMAIN
, "no such pool or dataset"));
125 return (dgettext(TEXT_DOMAIN
, "invalid backup stream"));
126 case EZFS_DSREADONLY
:
127 return (dgettext(TEXT_DOMAIN
, "dataset is read-only"));
129 return (dgettext(TEXT_DOMAIN
, "volume size exceeds limit for "
131 case EZFS_INVALIDNAME
:
132 return (dgettext(TEXT_DOMAIN
, "invalid name"));
133 case EZFS_BADRESTORE
:
134 return (dgettext(TEXT_DOMAIN
, "unable to restore to "
137 return (dgettext(TEXT_DOMAIN
, "backup failed"));
139 return (dgettext(TEXT_DOMAIN
, "invalid target vdev"));
141 return (dgettext(TEXT_DOMAIN
, "no such device in pool"));
143 return (dgettext(TEXT_DOMAIN
, "invalid device"));
144 case EZFS_NOREPLICAS
:
145 return (dgettext(TEXT_DOMAIN
, "no valid replicas"));
146 case EZFS_RESILVERING
:
147 return (dgettext(TEXT_DOMAIN
, "currently resilvering"));
148 case EZFS_BADVERSION
:
149 return (dgettext(TEXT_DOMAIN
, "unsupported version or "
151 case EZFS_POOLUNAVAIL
:
152 return (dgettext(TEXT_DOMAIN
, "pool is unavailable"));
153 case EZFS_DEVOVERFLOW
:
154 return (dgettext(TEXT_DOMAIN
, "too many devices in one vdev"));
156 return (dgettext(TEXT_DOMAIN
, "must be an absolute path"));
157 case EZFS_CROSSTARGET
:
158 return (dgettext(TEXT_DOMAIN
, "operation crosses datasets or "
161 return (dgettext(TEXT_DOMAIN
, "dataset in use by local zone"));
162 case EZFS_MOUNTFAILED
:
163 return (dgettext(TEXT_DOMAIN
, "mount failed"));
164 case EZFS_UMOUNTFAILED
:
165 return (dgettext(TEXT_DOMAIN
, "umount failed"));
166 case EZFS_UNSHARENFSFAILED
:
167 return (dgettext(TEXT_DOMAIN
, "unshare(1M) failed"));
168 case EZFS_SHARENFSFAILED
:
169 return (dgettext(TEXT_DOMAIN
, "share(1M) failed"));
170 case EZFS_UNSHARESMBFAILED
:
171 return (dgettext(TEXT_DOMAIN
, "smb remove share failed"));
172 case EZFS_SHARESMBFAILED
:
173 return (dgettext(TEXT_DOMAIN
, "smb add share failed"));
175 return (dgettext(TEXT_DOMAIN
, "permission denied"));
177 return (dgettext(TEXT_DOMAIN
, "out of space"));
179 return (dgettext(TEXT_DOMAIN
, "bad address"));
181 return (dgettext(TEXT_DOMAIN
, "I/O error"));
183 return (dgettext(TEXT_DOMAIN
, "signal received"));
185 return (dgettext(TEXT_DOMAIN
, "device is reserved as a hot "
187 case EZFS_INVALCONFIG
:
188 return (dgettext(TEXT_DOMAIN
, "invalid vdev configuration"));
190 return (dgettext(TEXT_DOMAIN
, "recursive dataset dependency"));
192 return (dgettext(TEXT_DOMAIN
, "no history available"));
194 return (dgettext(TEXT_DOMAIN
, "failed to retrieve "
196 case EZFS_POOL_NOTSUP
:
197 return (dgettext(TEXT_DOMAIN
, "operation not supported "
198 "on this type of pool"));
199 case EZFS_POOL_INVALARG
:
200 return (dgettext(TEXT_DOMAIN
, "invalid argument for "
201 "this pool operation"));
202 case EZFS_NAMETOOLONG
:
203 return (dgettext(TEXT_DOMAIN
, "dataset name is too long"));
204 case EZFS_OPENFAILED
:
205 return (dgettext(TEXT_DOMAIN
, "open failed"));
207 return (dgettext(TEXT_DOMAIN
,
208 "disk capacity information could not be retrieved"));
209 case EZFS_LABELFAILED
:
210 return (dgettext(TEXT_DOMAIN
, "write of label failed"));
212 return (dgettext(TEXT_DOMAIN
, "invalid user/group"));
214 return (dgettext(TEXT_DOMAIN
, "invalid permission"));
215 case EZFS_BADPERMSET
:
216 return (dgettext(TEXT_DOMAIN
, "invalid permission set name"));
217 case EZFS_NODELEGATION
:
218 return (dgettext(TEXT_DOMAIN
, "delegated administration is "
219 "disabled on pool"));
221 return (dgettext(TEXT_DOMAIN
, "invalid or missing cache file"));
223 return (dgettext(TEXT_DOMAIN
, "device is in use as a cache"));
224 case EZFS_VDEVNOTSUP
:
225 return (dgettext(TEXT_DOMAIN
, "vdev specification is not "
228 return (dgettext(TEXT_DOMAIN
, "operation not supported "
230 case EZFS_ACTIVE_SPARE
:
231 return (dgettext(TEXT_DOMAIN
, "pool has active shared spare "
233 case EZFS_UNPLAYED_LOGS
:
234 return (dgettext(TEXT_DOMAIN
, "log device has unplayed intent "
236 case EZFS_REFTAG_RELE
:
237 return (dgettext(TEXT_DOMAIN
, "no such tag on this dataset"));
238 case EZFS_REFTAG_HOLD
:
239 return (dgettext(TEXT_DOMAIN
, "tag already exists on this "
241 case EZFS_TAGTOOLONG
:
242 return (dgettext(TEXT_DOMAIN
, "tag too long"));
243 case EZFS_PIPEFAILED
:
244 return (dgettext(TEXT_DOMAIN
, "pipe create failed"));
245 case EZFS_THREADCREATEFAILED
:
246 return (dgettext(TEXT_DOMAIN
, "thread create failed"));
247 case EZFS_POSTSPLIT_ONLINE
:
248 return (dgettext(TEXT_DOMAIN
, "disk was split from this pool "
250 case EZFS_SCRUB_PAUSED
:
251 return (dgettext(TEXT_DOMAIN
, "scrub is paused; "
252 "use 'zpool scrub' to resume"));
254 return (dgettext(TEXT_DOMAIN
, "currently scrubbing; "
255 "use 'zpool scrub -s' to cancel current scrub"));
257 return (dgettext(TEXT_DOMAIN
, "there is no active scrub"));
259 return (dgettext(TEXT_DOMAIN
, "unable to generate diffs"));
261 return (dgettext(TEXT_DOMAIN
, "invalid diff data"));
262 case EZFS_POOLREADONLY
:
263 return (dgettext(TEXT_DOMAIN
, "pool is read-only"));
264 case EZFS_NO_PENDING
:
265 return (dgettext(TEXT_DOMAIN
, "operation is not "
267 case EZFS_ACTIVE_POOL
:
268 return (dgettext(TEXT_DOMAIN
, "pool is imported on a "
270 case EZFS_CRYPTOFAILED
:
271 return (dgettext(TEXT_DOMAIN
, "encryption failure"));
273 return (dgettext(TEXT_DOMAIN
, "unknown error"));
275 assert(hdl
->libzfs_error
== 0);
276 return (dgettext(TEXT_DOMAIN
, "no error"));
282 zfs_error_aux(libzfs_handle_t
*hdl
, const char *fmt
, ...)
288 (void) vsnprintf(hdl
->libzfs_desc
, sizeof (hdl
->libzfs_desc
),
290 hdl
->libzfs_desc_active
= 1;
296 zfs_verror(libzfs_handle_t
*hdl
, int error
, const char *fmt
, va_list ap
)
298 (void) vsnprintf(hdl
->libzfs_action
, sizeof (hdl
->libzfs_action
),
300 hdl
->libzfs_error
= error
;
302 if (hdl
->libzfs_desc_active
)
303 hdl
->libzfs_desc_active
= 0;
305 hdl
->libzfs_desc
[0] = '\0';
307 if (hdl
->libzfs_printerr
) {
308 if (error
== EZFS_UNKNOWN
) {
309 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
, "internal "
310 "error: %s\n"), libzfs_error_description(hdl
));
314 (void) fprintf(stderr
, "%s: %s\n", hdl
->libzfs_action
,
315 libzfs_error_description(hdl
));
316 if (error
== EZFS_NOMEM
)
322 zfs_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
324 return (zfs_error_fmt(hdl
, error
, "%s", msg
));
329 zfs_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
335 zfs_verror(hdl
, error
, fmt
, ap
);
343 zfs_common_error(libzfs_handle_t
*hdl
, int error
, const char *fmt
,
349 zfs_verror(hdl
, EZFS_PERM
, fmt
, ap
);
353 zfs_verror(hdl
, EZFS_NODELEGATION
, fmt
, ap
);
357 zfs_verror(hdl
, EZFS_IO
, fmt
, ap
);
361 zfs_verror(hdl
, EZFS_FAULT
, fmt
, ap
);
365 zfs_verror(hdl
, EZFS_INTR
, fmt
, ap
);
373 zfs_standard_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
375 return (zfs_standard_error_fmt(hdl
, error
, "%s", msg
));
380 zfs_standard_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
386 if (zfs_common_error(hdl
, error
, fmt
, ap
) != 0) {
395 zfs_verror(hdl
, EZFS_IO
, fmt
, ap
);
399 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
400 "dataset does not exist"));
401 zfs_verror(hdl
, EZFS_NOENT
, fmt
, ap
);
406 zfs_verror(hdl
, EZFS_NOSPC
, fmt
, ap
);
410 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
411 "dataset already exists"));
412 zfs_verror(hdl
, EZFS_EXISTS
, fmt
, ap
);
416 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
418 zfs_verror(hdl
, EZFS_BUSY
, fmt
, ap
);
421 zfs_verror(hdl
, EZFS_POOLREADONLY
, fmt
, ap
);
424 zfs_verror(hdl
, EZFS_NAMETOOLONG
, fmt
, ap
);
427 zfs_verror(hdl
, EZFS_BADVERSION
, fmt
, ap
);
430 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
431 "pool I/O is currently suspended"));
432 zfs_verror(hdl
, EZFS_POOLUNAVAIL
, fmt
, ap
);
435 zfs_verror(hdl
, EZFS_ACTIVE_POOL
, fmt
, ap
);
438 zfs_error_aux(hdl
, strerror(error
));
439 zfs_verror(hdl
, EZFS_UNKNOWN
, fmt
, ap
);
448 zpool_standard_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
450 return (zpool_standard_error_fmt(hdl
, error
, "%s", msg
));
455 zpool_standard_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
461 if (zfs_common_error(hdl
, error
, fmt
, ap
) != 0) {
468 zfs_verror(hdl
, EZFS_NODEVICE
, fmt
, ap
);
473 dgettext(TEXT_DOMAIN
, "no such pool or dataset"));
474 zfs_verror(hdl
, EZFS_NOENT
, fmt
, ap
);
478 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
479 "pool already exists"));
480 zfs_verror(hdl
, EZFS_EXISTS
, fmt
, ap
);
484 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "pool is busy"));
485 zfs_verror(hdl
, EZFS_BUSY
, fmt
, ap
);
488 /* There is no pending operation to cancel */
490 zfs_verror(hdl
, EZFS_NO_PENDING
, fmt
, ap
);
494 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
495 "one or more devices is currently unavailable"));
496 zfs_verror(hdl
, EZFS_BADDEV
, fmt
, ap
);
500 zfs_verror(hdl
, EZFS_DEVOVERFLOW
, fmt
, ap
);
504 zfs_verror(hdl
, EZFS_POOL_NOTSUP
, fmt
, ap
);
508 zfs_verror(hdl
, EZFS_POOL_INVALARG
, fmt
, ap
);
513 zfs_verror(hdl
, EZFS_NOSPC
, fmt
, ap
);
517 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
518 "pool I/O is currently suspended"));
519 zfs_verror(hdl
, EZFS_POOLUNAVAIL
, fmt
, ap
);
523 zfs_verror(hdl
, EZFS_POOLREADONLY
, fmt
, ap
);
526 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
527 "block size out of range or does not match"));
528 zfs_verror(hdl
, EZFS_BADPROP
, fmt
, ap
);
531 zfs_verror(hdl
, EZFS_ACTIVE_POOL
, fmt
, ap
);
535 zfs_error_aux(hdl
, strerror(error
));
536 zfs_verror(hdl
, EZFS_UNKNOWN
, fmt
, ap
);
544 * Display an out of memory error message and abort the current program.
547 no_memory(libzfs_handle_t
*hdl
)
549 return (zfs_error(hdl
, EZFS_NOMEM
, "internal error"));
553 * A safe form of malloc() which will die if the allocation fails.
556 zfs_alloc(libzfs_handle_t
*hdl
, size_t size
)
560 if ((data
= calloc(1, size
)) == NULL
)
561 (void) no_memory(hdl
);
567 * A safe form of asprintf() which will die if the allocation fails.
571 zfs_asprintf(libzfs_handle_t
*hdl
, const char *fmt
, ...)
579 err
= vasprintf(&ret
, fmt
, ap
);
584 (void) no_memory(hdl
);
590 * A safe form of realloc(), which also zeroes newly allocated space.
593 zfs_realloc(libzfs_handle_t
*hdl
, void *ptr
, size_t oldsize
, size_t newsize
)
597 if ((ret
= realloc(ptr
, newsize
)) == NULL
) {
598 (void) no_memory(hdl
);
602 bzero((char *)ret
+ oldsize
, (newsize
- oldsize
));
607 * A safe form of strdup() which will die if the allocation fails.
610 zfs_strdup(libzfs_handle_t
*hdl
, const char *str
)
614 if ((ret
= strdup(str
)) == NULL
)
615 (void) no_memory(hdl
);
621 * Convert a number to an appropriately human-readable output.
624 zfs_nicenum_format(uint64_t num
, char *buf
, size_t buflen
,
625 enum zfs_nicenum_format format
)
630 const char *units
[3][7] = {
631 [ZFS_NICENUM_1024
] = {"", "K", "M", "G", "T", "P", "E"},
632 [ZFS_NICENUM_BYTES
] = {"B", "K", "M", "G", "T", "P", "E"},
633 [ZFS_NICENUM_TIME
] = {"ns", "us", "ms", "s", "?", "?", "?"}
636 const int units_len
[] = {[ZFS_NICENUM_1024
] = 6,
637 [ZFS_NICENUM_BYTES
] = 6,
638 [ZFS_NICENUM_TIME
] = 4};
640 const int k_unit
[] = { [ZFS_NICENUM_1024
] = 1024,
641 [ZFS_NICENUM_BYTES
] = 1024,
642 [ZFS_NICENUM_TIME
] = 1000};
646 if (format
== ZFS_NICENUM_RAW
) {
647 snprintf(buf
, buflen
, "%llu", (u_longlong_t
)num
);
649 } else if (format
== ZFS_NICENUM_RAWTIME
&& num
> 0) {
650 snprintf(buf
, buflen
, "%llu", (u_longlong_t
)num
);
652 } else if (format
== ZFS_NICENUM_RAWTIME
&& num
== 0) {
653 snprintf(buf
, buflen
, "%s", "-");
657 while (n
>= k_unit
[format
] && index
< units_len
[format
]) {
662 u
= units
[format
][index
];
664 /* Don't print zero latencies since they're invalid */
665 if ((format
== ZFS_NICENUM_TIME
) && (num
== 0)) {
666 (void) snprintf(buf
, buflen
, "-");
667 } else if ((index
== 0) || ((num
%
668 (uint64_t)powl(k_unit
[format
], index
)) == 0)) {
670 * If this is an even multiple of the base, always display
671 * without any decimal precision.
673 (void) snprintf(buf
, buflen
, "%llu%s", (u_longlong_t
)n
, u
);
677 * We want to choose a precision that reflects the best choice
678 * for fitting in 5 characters. This can get rather tricky when
679 * we have numbers that are very close to an order of magnitude.
680 * For example, when displaying 10239 (which is really 9.999K),
681 * we want only a single place of precision for 10.0K. We could
682 * develop some complex heuristics for this, but it's much
683 * easier just to try each combination in turn.
686 for (i
= 2; i
>= 0; i
--) {
688 (uint64_t)powl(k_unit
[format
], index
);
691 * Don't print floating point values for time. Note,
692 * we use floor() instead of round() here, since
693 * round can result in undesirable results. For
694 * example, if "num" is in the range of
695 * 999500-999999, it will print out "1000us". This
696 * doesn't happen if we use floor().
698 if (format
== ZFS_NICENUM_TIME
) {
699 if (snprintf(buf
, buflen
, "%d%s",
700 (unsigned int) floor(val
), u
) <= 5)
704 if (snprintf(buf
, buflen
, "%.*f%s", i
,
713 * Convert a number to an appropriately human-readable output.
716 zfs_nicenum(uint64_t num
, char *buf
, size_t buflen
)
718 zfs_nicenum_format(num
, buf
, buflen
, ZFS_NICENUM_1024
);
722 * Convert a time to an appropriately human-readable output.
723 * @num: Time in nanoseconds
726 zfs_nicetime(uint64_t num
, char *buf
, size_t buflen
)
728 zfs_nicenum_format(num
, buf
, buflen
, ZFS_NICENUM_TIME
);
732 * Print out a raw number with correct column spacing
735 zfs_niceraw(uint64_t num
, char *buf
, size_t buflen
)
737 zfs_nicenum_format(num
, buf
, buflen
, ZFS_NICENUM_RAW
);
741 * Convert a number of bytes to an appropriately human-readable output.
744 zfs_nicebytes(uint64_t num
, char *buf
, size_t buflen
)
746 zfs_nicenum_format(num
, buf
, buflen
, ZFS_NICENUM_BYTES
);
750 libzfs_print_on_error(libzfs_handle_t
*hdl
, boolean_t printerr
)
752 hdl
->libzfs_printerr
= printerr
;
756 libzfs_module_loaded(const char *module
)
758 const char path_prefix
[] = "/sys/module/";
761 memcpy(path
, path_prefix
, sizeof (path_prefix
) - 1);
762 strcpy(path
+ sizeof (path_prefix
) - 1, module
);
764 return (access(path
, F_OK
) == 0);
769 * Read lines from an open file descriptor and store them in an array of
770 * strings until EOF. lines[] will be allocated and populated with all the
771 * lines read. All newlines are replaced with NULL terminators for
772 * convenience. lines[] must be freed after use with libzfs_free_str_array().
774 * Returns the number of lines read.
777 libzfs_read_stdout_from_fd(int fd
, char **lines
[])
784 char **tmp_lines
= NULL
, **tmp
;
788 fp
= fdopen(fd
, "r");
792 rc
= getline(&line
, &len
, fp
);
796 tmp
= realloc(tmp_lines
, sizeof (*tmp_lines
) * (lines_cnt
+ 1));
798 /* Return the lines we were able to process */
803 /* Terminate newlines */
804 if ((nl
= strchr(line
, '\n')) != NULL
)
806 tmp_lines
[lines_cnt
] = line
;
816 libzfs_run_process_impl(const char *path
, char *argv
[], char *env
[], int flags
,
817 char **lines
[], int *lines_cnt
)
820 int error
, devnull_fd
;
824 * Setup a pipe between our child and parent process if we're
827 if ((lines
!= NULL
) && pipe(link
) == -1)
833 devnull_fd
= open("/dev/null", O_WRONLY
);
838 if (!(flags
& STDOUT_VERBOSE
) && (lines
== NULL
))
839 (void) dup2(devnull_fd
, STDOUT_FILENO
);
840 else if (lines
!= NULL
) {
841 /* Save the output to lines[] */
842 dup2(link
[1], STDOUT_FILENO
);
847 if (!(flags
& STDERR_VERBOSE
))
848 (void) dup2(devnull_fd
, STDERR_FILENO
);
852 if (flags
& NO_DEFAULT_PATH
) {
856 execve(path
, argv
, env
);
861 execvpe(path
, argv
, env
);
865 } else if (pid
> 0) {
869 while ((error
= waitpid(pid
, &status
, 0)) == -1 &&
871 if (error
< 0 || !WIFEXITED(status
))
876 *lines_cnt
= libzfs_read_stdout_from_fd(link
[0], lines
);
878 return (WEXITSTATUS(status
));
885 libzfs_run_process(const char *path
, char *argv
[], int flags
)
887 return (libzfs_run_process_impl(path
, argv
, NULL
, flags
, NULL
, NULL
));
891 * Run a command and store its stdout lines in an array of strings (lines[]).
892 * lines[] is allocated and populated for you, and the number of lines is set in
893 * lines_cnt. lines[] must be freed after use with libzfs_free_str_array().
894 * All newlines (\n) in lines[] are terminated for convenience.
897 libzfs_run_process_get_stdout(const char *path
, char *argv
[], char *env
[],
898 char **lines
[], int *lines_cnt
)
900 return (libzfs_run_process_impl(path
, argv
, env
, 0, lines
, lines_cnt
));
904 * Same as libzfs_run_process_get_stdout(), but run without $PATH set. This
905 * means that *path needs to be the full path to the executable.
908 libzfs_run_process_get_stdout_nopath(const char *path
, char *argv
[],
909 char *env
[], char **lines
[], int *lines_cnt
)
911 return (libzfs_run_process_impl(path
, argv
, env
, NO_DEFAULT_PATH
,
916 * Free an array of strings. Free both the strings contained in the array and
920 libzfs_free_str_array(char **strs
, int count
)
929 * Returns 1 if environment variable is set to "YES", "yes", "ON", "on", or
932 * Returns 0 otherwise.
935 libzfs_envvar_is_set(char *envvar
)
937 char *env
= getenv(envvar
);
938 if (env
&& (strtoul(env
, NULL
, 0) > 0 ||
939 (!strncasecmp(env
, "YES", 3) && strnlen(env
, 4) == 3) ||
940 (!strncasecmp(env
, "ON", 2) && strnlen(env
, 3) == 2)))
947 * Verify the required ZFS_DEV device is available and optionally attempt
948 * to load the ZFS modules. Under normal circumstances the modules
949 * should already have been loaded by some external mechanism.
951 * Environment variables:
952 * - ZFS_MODULE_LOADING="YES|yes|ON|on" - Attempt to load modules.
953 * - ZFS_MODULE_TIMEOUT="<seconds>" - Seconds to wait for ZFS_DEV
956 libzfs_load_module(const char *module
)
958 char *argv
[4] = {"/sbin/modprobe", "-q", (char *)module
, (char *)0};
959 char *load_str
, *timeout_str
;
960 long timeout
= 10; /* seconds */
961 long busy_timeout
= 10; /* milliseconds */
965 /* Optionally request module loading */
966 if (!libzfs_module_loaded(module
)) {
967 load_str
= getenv("ZFS_MODULE_LOADING");
969 if (!strncasecmp(load_str
, "YES", strlen("YES")) ||
970 !strncasecmp(load_str
, "ON", strlen("ON")))
977 if (libzfs_run_process("/sbin/modprobe", argv
, 0))
980 if (!libzfs_module_loaded(module
))
986 * Device creation by udev is asynchronous and waiting may be
987 * required. Busy wait for 10ms and then fall back to polling every
988 * 10ms for the allowed timeout (default 10s, max 10m). This is
989 * done to optimize for the common case where the device is
990 * immediately available and to avoid penalizing the possible
991 * case where udev is slow or unable to create the device.
993 timeout_str
= getenv("ZFS_MODULE_TIMEOUT");
995 timeout
= strtol(timeout_str
, NULL
, 0);
996 timeout
= MAX(MIN(timeout
, (10 * 60)), 0); /* 0 <= N <= 600 */
1001 fd
= open(ZFS_DEV
, O_RDWR
);
1005 } else if (errno
!= ENOENT
) {
1007 } else if (NSEC2MSEC(gethrtime() - start
) < busy_timeout
) {
1010 usleep(10 * MILLISEC
);
1012 } while (NSEC2MSEC(gethrtime() - start
) < (timeout
* MILLISEC
));
1020 libzfs_handle_t
*hdl
;
1023 error
= libzfs_load_module(ZFS_DRIVER
);
1029 if ((hdl
= calloc(1, sizeof (libzfs_handle_t
))) == NULL
) {
1033 if ((hdl
->libzfs_fd
= open(ZFS_DEV
, O_RDWR
)) < 0) {
1038 #ifdef HAVE_SETMNTENT
1039 if ((hdl
->libzfs_mnttab
= setmntent(MNTTAB
, "r")) == NULL
) {
1041 if ((hdl
->libzfs_mnttab
= fopen(MNTTAB
, "r")) == NULL
) {
1043 (void) close(hdl
->libzfs_fd
);
1048 hdl
->libzfs_sharetab
= fopen(ZFS_SHARETAB
, "r");
1050 if (libzfs_core_init() != 0) {
1051 (void) close(hdl
->libzfs_fd
);
1052 (void) fclose(hdl
->libzfs_mnttab
);
1053 if (hdl
->libzfs_sharetab
)
1054 (void) fclose(hdl
->libzfs_sharetab
);
1061 zpool_feature_init();
1062 libzfs_mnttab_init(hdl
);
1065 if (getenv("ZFS_PROP_DEBUG") != NULL
) {
1066 hdl
->libzfs_prop_debug
= B_TRUE
;
1073 libzfs_fini(libzfs_handle_t
*hdl
)
1075 (void) close(hdl
->libzfs_fd
);
1076 if (hdl
->libzfs_mnttab
)
1077 #ifdef HAVE_SETMNTENT
1078 (void) endmntent(hdl
->libzfs_mnttab
);
1080 (void) fclose(hdl
->libzfs_mnttab
);
1082 if (hdl
->libzfs_sharetab
)
1083 (void) fclose(hdl
->libzfs_sharetab
);
1084 zfs_uninit_libshare(hdl
);
1085 zpool_free_handles(hdl
);
1086 namespace_clear(hdl
);
1087 libzfs_mnttab_fini(hdl
);
1094 zpool_get_handle(zpool_handle_t
*zhp
)
1096 return (zhp
->zpool_hdl
);
1100 zfs_get_handle(zfs_handle_t
*zhp
)
1102 return (zhp
->zfs_hdl
);
1106 zfs_get_pool_handle(const zfs_handle_t
*zhp
)
1108 return (zhp
->zpool_hdl
);
1112 * Given a name, determine whether or not it's a valid path
1113 * (starts with '/' or "./"). If so, walk the mnttab trying
1114 * to match the device number. If not, treat the path as an
1115 * fs/vol/snap/bkmark name.
1118 zfs_path_to_zhandle(libzfs_handle_t
*hdl
, char *path
, zfs_type_t argtype
)
1120 struct stat64 statbuf
;
1121 struct extmnttab entry
;
1124 if (path
[0] != '/' && strncmp(path
, "./", strlen("./")) != 0) {
1126 * It's not a valid path, assume it's a name of type 'argtype'.
1128 return (zfs_open(hdl
, path
, argtype
));
1131 if (stat64(path
, &statbuf
) != 0) {
1132 (void) fprintf(stderr
, "%s: %s\n", path
, strerror(errno
));
1136 /* Reopen MNTTAB to prevent reading stale data from open file */
1137 if (freopen(MNTTAB
, "r", hdl
->libzfs_mnttab
) == NULL
)
1140 while ((ret
= getextmntent(hdl
->libzfs_mnttab
, &entry
, 0)) == 0) {
1141 if (makedevice(entry
.mnt_major
, entry
.mnt_minor
) ==
1150 if (strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0) {
1151 (void) fprintf(stderr
, gettext("'%s': not a ZFS filesystem\n"),
1156 return (zfs_open(hdl
, entry
.mnt_special
, ZFS_TYPE_FILESYSTEM
));
1160 * Append partition suffix to an otherwise fully qualified device path.
1161 * This is used to generate the name the full path as its stored in
1162 * ZPOOL_CONFIG_PATH for whole disk devices. On success the new length
1163 * of 'path' will be returned on error a negative value is returned.
1166 zfs_append_partition(char *path
, size_t max_len
)
1168 int len
= strlen(path
);
1170 if ((strncmp(path
, UDISK_ROOT
, strlen(UDISK_ROOT
)) == 0) ||
1171 (strncmp(path
, ZVOL_ROOT
, strlen(ZVOL_ROOT
)) == 0)) {
1172 if (len
+ 6 >= max_len
)
1175 (void) strcat(path
, "-part1");
1178 if (len
+ 2 >= max_len
)
1181 if (isdigit(path
[len
-1])) {
1182 (void) strcat(path
, "p1");
1185 (void) strcat(path
, "1");
1194 * Given a shorthand device name check if a file by that name exists in any
1195 * of the 'zpool_default_import_path' or ZPOOL_IMPORT_PATH directories. If
1196 * one is found, store its fully qualified path in the 'path' buffer passed
1197 * by the caller and return 0, otherwise return an error.
1200 zfs_resolve_shortname(const char *name
, char *path
, size_t len
)
1203 char *dir
, *env
, *envdup
;
1205 env
= getenv("ZPOOL_IMPORT_PATH");
1209 envdup
= strdup(env
);
1210 dir
= strtok(envdup
, ":");
1211 while (dir
&& error
) {
1212 (void) snprintf(path
, len
, "%s/%s", dir
, name
);
1213 error
= access(path
, F_OK
);
1214 dir
= strtok(NULL
, ":");
1218 for (i
= 0; i
< DEFAULT_IMPORT_PATH_SIZE
&& error
< 0; i
++) {
1219 (void) snprintf(path
, len
, "%s/%s",
1220 zpool_default_import_path
[i
], name
);
1221 error
= access(path
, F_OK
);
1225 return (error
? ENOENT
: 0);
1229 * Given a shorthand device name look for a match against 'cmp_name'. This
1230 * is done by checking all prefix expansions using either the default
1231 * 'zpool_default_import_paths' or the ZPOOL_IMPORT_PATH environment
1232 * variable. Proper partition suffixes will be appended if this is a
1233 * whole disk. When a match is found 0 is returned otherwise ENOENT.
1236 zfs_strcmp_shortname(char *name
, char *cmp_name
, int wholedisk
)
1238 int path_len
, cmp_len
, i
= 0, error
= ENOENT
;
1239 char *dir
, *env
, *envdup
= NULL
;
1240 char path_name
[MAXPATHLEN
];
1242 cmp_len
= strlen(cmp_name
);
1243 env
= getenv("ZPOOL_IMPORT_PATH");
1246 envdup
= strdup(env
);
1247 dir
= strtok(envdup
, ":");
1249 dir
= zpool_default_import_path
[i
];
1253 /* Trim trailing directory slashes from ZPOOL_IMPORT_PATH */
1254 while (dir
[strlen(dir
)-1] == '/')
1255 dir
[strlen(dir
)-1] = '\0';
1257 path_len
= snprintf(path_name
, MAXPATHLEN
, "%s/%s", dir
, name
);
1259 path_len
= zfs_append_partition(path_name
, MAXPATHLEN
);
1261 if ((path_len
== cmp_len
) && strcmp(path_name
, cmp_name
) == 0) {
1267 dir
= strtok(NULL
, ":");
1268 } else if (++i
< DEFAULT_IMPORT_PATH_SIZE
) {
1269 dir
= zpool_default_import_path
[i
];
1282 * Given either a shorthand or fully qualified path name look for a match
1283 * against 'cmp'. The passed name will be expanded as needed for comparison
1284 * purposes and redundant slashes stripped to ensure an accurate match.
1287 zfs_strcmp_pathname(char *name
, char *cmp
, int wholedisk
)
1289 int path_len
, cmp_len
;
1290 char path_name
[MAXPATHLEN
];
1291 char cmp_name
[MAXPATHLEN
];
1294 /* Strip redundant slashes if one exists due to ZPOOL_IMPORT_PATH */
1295 memset(cmp_name
, 0, MAXPATHLEN
);
1297 dir
= strtok(dup
, "/");
1299 strlcat(cmp_name
, "/", sizeof (cmp_name
));
1300 strlcat(cmp_name
, dir
, sizeof (cmp_name
));
1301 dir
= strtok(NULL
, "/");
1306 return (zfs_strcmp_shortname(name
, cmp_name
, wholedisk
));
1308 (void) strlcpy(path_name
, name
, MAXPATHLEN
);
1309 path_len
= strlen(path_name
);
1310 cmp_len
= strlen(cmp_name
);
1313 path_len
= zfs_append_partition(path_name
, MAXPATHLEN
);
1318 if ((path_len
!= cmp_len
) || strcmp(path_name
, cmp_name
))
1325 * Given a full path to a device determine if that device appears in the
1326 * import search path. If it does return the first match and store the
1327 * index in the passed 'order' variable, otherwise return an error.
1330 zfs_path_order(char *name
, int *order
)
1332 int i
= 0, error
= ENOENT
;
1333 char *dir
, *env
, *envdup
;
1335 env
= getenv("ZPOOL_IMPORT_PATH");
1337 envdup
= strdup(env
);
1338 dir
= strtok(envdup
, ":");
1340 if (strncmp(name
, dir
, strlen(dir
)) == 0) {
1345 dir
= strtok(NULL
, ":");
1350 for (i
= 0; i
< DEFAULT_IMPORT_PATH_SIZE
; i
++) {
1351 if (strncmp(name
, zpool_default_import_path
[i
],
1352 strlen(zpool_default_import_path
[i
])) == 0) {
1364 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
1368 zcmd_alloc_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, size_t len
)
1372 zc
->zc_nvlist_dst_size
= len
;
1374 (uint64_t)(uintptr_t)zfs_alloc(hdl
, zc
->zc_nvlist_dst_size
);
1375 if (zc
->zc_nvlist_dst
== 0)
1382 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
1383 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
1384 * filled in by the kernel to indicate the actual required size.
1387 zcmd_expand_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
)
1389 free((void *)(uintptr_t)zc
->zc_nvlist_dst
);
1391 (uint64_t)(uintptr_t)zfs_alloc(hdl
, zc
->zc_nvlist_dst_size
);
1392 if (zc
->zc_nvlist_dst
== 0)
1399 * Called to free the src and dst nvlists stored in the command structure.
1402 zcmd_free_nvlists(zfs_cmd_t
*zc
)
1404 free((void *)(uintptr_t)zc
->zc_nvlist_conf
);
1405 free((void *)(uintptr_t)zc
->zc_nvlist_src
);
1406 free((void *)(uintptr_t)zc
->zc_nvlist_dst
);
1407 zc
->zc_nvlist_conf
= 0;
1408 zc
->zc_nvlist_src
= 0;
1409 zc
->zc_nvlist_dst
= 0;
1413 zcmd_write_nvlist_com(libzfs_handle_t
*hdl
, uint64_t *outnv
, uint64_t *outlen
,
1419 verify(nvlist_size(nvl
, &len
, NV_ENCODE_NATIVE
) == 0);
1421 if ((packed
= zfs_alloc(hdl
, len
)) == NULL
)
1424 verify(nvlist_pack(nvl
, &packed
, &len
, NV_ENCODE_NATIVE
, 0) == 0);
1426 *outnv
= (uint64_t)(uintptr_t)packed
;
1433 zcmd_write_conf_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
*nvl
)
1435 return (zcmd_write_nvlist_com(hdl
, &zc
->zc_nvlist_conf
,
1436 &zc
->zc_nvlist_conf_size
, nvl
));
1440 zcmd_write_src_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
*nvl
)
1442 return (zcmd_write_nvlist_com(hdl
, &zc
->zc_nvlist_src
,
1443 &zc
->zc_nvlist_src_size
, nvl
));
1447 * Unpacks an nvlist from the ZFS ioctl command structure.
1450 zcmd_read_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
**nvlp
)
1452 if (nvlist_unpack((void *)(uintptr_t)zc
->zc_nvlist_dst
,
1453 zc
->zc_nvlist_dst_size
, nvlp
, 0) != 0)
1454 return (no_memory(hdl
));
1460 zfs_ioctl(libzfs_handle_t
*hdl
, int request
, zfs_cmd_t
*zc
)
1462 return (ioctl(hdl
->libzfs_fd
, request
, zc
));
1466 * ================================================================
1467 * API shared by zfs and zpool property management
1468 * ================================================================
1472 zprop_print_headers(zprop_get_cbdata_t
*cbp
, zfs_type_t type
)
1474 zprop_list_t
*pl
= cbp
->cb_proplist
;
1479 cbp
->cb_first
= B_FALSE
;
1480 if (cbp
->cb_scripted
)
1484 * Start with the length of the column headers.
1486 cbp
->cb_colwidths
[GET_COL_NAME
] = strlen(dgettext(TEXT_DOMAIN
, "NAME"));
1487 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = strlen(dgettext(TEXT_DOMAIN
,
1489 cbp
->cb_colwidths
[GET_COL_VALUE
] = strlen(dgettext(TEXT_DOMAIN
,
1491 cbp
->cb_colwidths
[GET_COL_RECVD
] = strlen(dgettext(TEXT_DOMAIN
,
1493 cbp
->cb_colwidths
[GET_COL_SOURCE
] = strlen(dgettext(TEXT_DOMAIN
,
1496 /* first property is always NAME */
1497 assert(cbp
->cb_proplist
->pl_prop
==
1498 ((type
== ZFS_TYPE_POOL
) ? ZPOOL_PROP_NAME
: ZFS_PROP_NAME
));
1501 * Go through and calculate the widths for each column. For the
1502 * 'source' column, we kludge it up by taking the worst-case scenario of
1503 * inheriting from the longest name. This is acceptable because in the
1504 * majority of cases 'SOURCE' is the last column displayed, and we don't
1505 * use the width anyway. Note that the 'VALUE' column can be oversized,
1506 * if the name of the property is much longer than any values we find.
1508 for (pl
= cbp
->cb_proplist
; pl
!= NULL
; pl
= pl
->pl_next
) {
1512 if (pl
->pl_prop
!= ZPROP_INVAL
) {
1513 const char *propname
= (type
== ZFS_TYPE_POOL
) ?
1514 zpool_prop_to_name(pl
->pl_prop
) :
1515 zfs_prop_to_name(pl
->pl_prop
);
1517 len
= strlen(propname
);
1518 if (len
> cbp
->cb_colwidths
[GET_COL_PROPERTY
])
1519 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = len
;
1521 len
= strlen(pl
->pl_user_prop
);
1522 if (len
> cbp
->cb_colwidths
[GET_COL_PROPERTY
])
1523 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = len
;
1527 * 'VALUE' column. The first property is always the 'name'
1528 * property that was tacked on either by /sbin/zfs's
1529 * zfs_do_get() or when calling zprop_expand_list(), so we
1530 * ignore its width. If the user specified the name property
1531 * to display, then it will be later in the list in any case.
1533 if (pl
!= cbp
->cb_proplist
&&
1534 pl
->pl_width
> cbp
->cb_colwidths
[GET_COL_VALUE
])
1535 cbp
->cb_colwidths
[GET_COL_VALUE
] = pl
->pl_width
;
1537 /* 'RECEIVED' column. */
1538 if (pl
!= cbp
->cb_proplist
&&
1539 pl
->pl_recvd_width
> cbp
->cb_colwidths
[GET_COL_RECVD
])
1540 cbp
->cb_colwidths
[GET_COL_RECVD
] = pl
->pl_recvd_width
;
1543 * 'NAME' and 'SOURCE' columns
1545 if (pl
->pl_prop
== (type
== ZFS_TYPE_POOL
? ZPOOL_PROP_NAME
:
1547 pl
->pl_width
> cbp
->cb_colwidths
[GET_COL_NAME
]) {
1548 cbp
->cb_colwidths
[GET_COL_NAME
] = pl
->pl_width
;
1549 cbp
->cb_colwidths
[GET_COL_SOURCE
] = pl
->pl_width
+
1550 strlen(dgettext(TEXT_DOMAIN
, "inherited from"));
1555 * Now go through and print the headers.
1557 for (i
= 0; i
< ZFS_GET_NCOLS
; i
++) {
1558 switch (cbp
->cb_columns
[i
]) {
1560 title
= dgettext(TEXT_DOMAIN
, "NAME");
1562 case GET_COL_PROPERTY
:
1563 title
= dgettext(TEXT_DOMAIN
, "PROPERTY");
1566 title
= dgettext(TEXT_DOMAIN
, "VALUE");
1569 title
= dgettext(TEXT_DOMAIN
, "RECEIVED");
1571 case GET_COL_SOURCE
:
1572 title
= dgettext(TEXT_DOMAIN
, "SOURCE");
1578 if (title
!= NULL
) {
1579 if (i
== (ZFS_GET_NCOLS
- 1) ||
1580 cbp
->cb_columns
[i
+ 1] == GET_COL_NONE
)
1581 (void) printf("%s", title
);
1583 (void) printf("%-*s ",
1584 cbp
->cb_colwidths
[cbp
->cb_columns
[i
]],
1588 (void) printf("\n");
1592 * Display a single line of output, according to the settings in the callback
1596 zprop_print_one_property(const char *name
, zprop_get_cbdata_t
*cbp
,
1597 const char *propname
, const char *value
, zprop_source_t sourcetype
,
1598 const char *source
, const char *recvd_value
)
1601 const char *str
= NULL
;
1605 * Ignore those source types that the user has chosen to ignore.
1607 if ((sourcetype
& cbp
->cb_sources
) == 0)
1611 zprop_print_headers(cbp
, cbp
->cb_type
);
1613 for (i
= 0; i
< ZFS_GET_NCOLS
; i
++) {
1614 switch (cbp
->cb_columns
[i
]) {
1619 case GET_COL_PROPERTY
:
1627 case GET_COL_SOURCE
:
1628 switch (sourcetype
) {
1629 case ZPROP_SRC_NONE
:
1633 case ZPROP_SRC_DEFAULT
:
1637 case ZPROP_SRC_LOCAL
:
1641 case ZPROP_SRC_TEMPORARY
:
1645 case ZPROP_SRC_INHERITED
:
1646 (void) snprintf(buf
, sizeof (buf
),
1647 "inherited from %s", source
);
1650 case ZPROP_SRC_RECEIVED
:
1656 assert(!"unhandled zprop_source_t");
1661 str
= (recvd_value
== NULL
? "-" : recvd_value
);
1668 if (i
== (ZFS_GET_NCOLS
- 1) ||
1669 cbp
->cb_columns
[i
+ 1] == GET_COL_NONE
)
1670 (void) printf("%s", str
);
1671 else if (cbp
->cb_scripted
)
1672 (void) printf("%s\t", str
);
1674 (void) printf("%-*s ",
1675 cbp
->cb_colwidths
[cbp
->cb_columns
[i
]],
1679 (void) printf("\n");
1683 * Given a numeric suffix, convert the value into a number of bits that the
1684 * resulting value must be shifted.
1687 str2shift(libzfs_handle_t
*hdl
, const char *buf
)
1689 const char *ends
= "BKMGTPEZ";
1694 for (i
= 0; i
< strlen(ends
); i
++) {
1695 if (toupper(buf
[0]) == ends
[i
])
1698 if (i
== strlen(ends
)) {
1700 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1701 "invalid numeric suffix '%s'"), buf
);
1706 * Allow 'G' = 'GB' = 'GiB', case-insensitively.
1707 * However, 'BB' and 'BiB' are disallowed.
1709 if (buf
[1] == '\0' ||
1710 (toupper(buf
[0]) != 'B' &&
1711 ((toupper(buf
[1]) == 'B' && buf
[2] == '\0') ||
1712 (toupper(buf
[1]) == 'I' && toupper(buf
[2]) == 'B' &&
1717 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1718 "invalid numeric suffix '%s'"), buf
);
1723 * Convert a string of the form '100G' into a real number. Used when setting
1724 * properties or creating a volume. 'buf' is used to place an extended error
1725 * message for the caller to use.
1728 zfs_nicestrtonum(libzfs_handle_t
*hdl
, const char *value
, uint64_t *num
)
1735 /* Check to see if this looks like a number. */
1736 if ((value
[0] < '0' || value
[0] > '9') && value
[0] != '.') {
1738 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1739 "bad numeric value '%s'"), value
);
1743 /* Rely on strtoull() to process the numeric portion. */
1745 *num
= strtoull(value
, &end
, 10);
1748 * Check for ERANGE, which indicates that the value is too large to fit
1749 * in a 64-bit value.
1751 if (errno
== ERANGE
) {
1753 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1754 "numeric value is too large"));
1759 * If we have a decimal value, then do the computation with floating
1760 * point arithmetic. Otherwise, use standard arithmetic.
1763 double fval
= strtod(value
, &end
);
1765 if ((shift
= str2shift(hdl
, end
)) == -1)
1768 fval
*= pow(2, shift
);
1770 if (fval
> UINT64_MAX
) {
1772 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1773 "numeric value is too large"));
1777 *num
= (uint64_t)fval
;
1779 if ((shift
= str2shift(hdl
, end
)) == -1)
1782 /* Check for overflow */
1783 if (shift
>= 64 || (*num
<< shift
) >> shift
!= *num
) {
1785 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1786 "numeric value is too large"));
1797 * Given a propname=value nvpair to set, parse any numeric properties
1798 * (index, boolean, etc) if they are specified as strings and add the
1799 * resulting nvpair to the returned nvlist.
1801 * At the DSL layer, all properties are either 64-bit numbers or strings.
1802 * We want the user to be able to ignore this fact and specify properties
1803 * as native values (numbers, for example) or as strings (to simplify
1804 * command line utilities). This also handles converting index types
1805 * (compression, checksum, etc) from strings to their on-disk index.
1808 zprop_parse_value(libzfs_handle_t
*hdl
, nvpair_t
*elem
, int prop
,
1809 zfs_type_t type
, nvlist_t
*ret
, char **svalp
, uint64_t *ivalp
,
1812 data_type_t datatype
= nvpair_type(elem
);
1813 zprop_type_t proptype
;
1814 const char *propname
;
1816 boolean_t isnone
= B_FALSE
;
1817 boolean_t isauto
= B_FALSE
;
1820 if (type
== ZFS_TYPE_POOL
) {
1821 proptype
= zpool_prop_get_type(prop
);
1822 propname
= zpool_prop_to_name(prop
);
1824 proptype
= zfs_prop_get_type(prop
);
1825 propname
= zfs_prop_to_name(prop
);
1829 * Convert any properties to the internal DSL value types.
1835 case PROP_TYPE_STRING
:
1836 if (datatype
!= DATA_TYPE_STRING
) {
1837 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1838 "'%s' must be a string"), nvpair_name(elem
));
1841 err
= nvpair_value_string(elem
, svalp
);
1843 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1844 "'%s' is invalid"), nvpair_name(elem
));
1847 if (strlen(*svalp
) >= ZFS_MAXPROPLEN
) {
1848 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1849 "'%s' is too long"), nvpair_name(elem
));
1854 case PROP_TYPE_NUMBER
:
1855 if (datatype
== DATA_TYPE_STRING
) {
1856 (void) nvpair_value_string(elem
, &value
);
1857 if (strcmp(value
, "none") == 0) {
1859 } else if (strcmp(value
, "auto") == 0) {
1861 } else if (zfs_nicestrtonum(hdl
, value
, ivalp
) != 0) {
1864 } else if (datatype
== DATA_TYPE_UINT64
) {
1865 (void) nvpair_value_uint64(elem
, ivalp
);
1867 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1868 "'%s' must be a number"), nvpair_name(elem
));
1873 * Quota special: force 'none' and don't allow 0.
1875 if ((type
& ZFS_TYPE_DATASET
) && *ivalp
== 0 && !isnone
&&
1876 (prop
== ZFS_PROP_QUOTA
|| prop
== ZFS_PROP_REFQUOTA
)) {
1877 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1878 "use 'none' to disable quota/refquota"));
1883 * Special handling for "*_limit=none". In this case it's not
1886 if ((type
& ZFS_TYPE_DATASET
) && isnone
&&
1887 (prop
== ZFS_PROP_FILESYSTEM_LIMIT
||
1888 prop
== ZFS_PROP_SNAPSHOT_LIMIT
)) {
1889 *ivalp
= UINT64_MAX
;
1893 * Special handling for setting 'refreservation' to 'auto'. Use
1894 * UINT64_MAX to tell the caller to use zfs_fix_auto_resv().
1895 * 'auto' is only allowed on volumes.
1899 case ZFS_PROP_REFRESERVATION
:
1900 if ((type
& ZFS_TYPE_VOLUME
) == 0) {
1901 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1902 "'%s=auto' only allowed on "
1903 "volumes"), nvpair_name(elem
));
1906 *ivalp
= UINT64_MAX
;
1909 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1910 "'auto' is invalid value for '%s'"),
1918 case PROP_TYPE_INDEX
:
1919 if (datatype
!= DATA_TYPE_STRING
) {
1920 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1921 "'%s' must be a string"), nvpair_name(elem
));
1925 (void) nvpair_value_string(elem
, &value
);
1927 if (zprop_string_to_index(prop
, value
, ivalp
, type
) != 0) {
1928 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1929 "'%s' must be one of '%s'"), propname
,
1930 zprop_values(prop
, type
));
1940 * Add the result to our return set of properties.
1942 if (*svalp
!= NULL
) {
1943 if (nvlist_add_string(ret
, propname
, *svalp
) != 0) {
1944 (void) no_memory(hdl
);
1948 if (nvlist_add_uint64(ret
, propname
, *ivalp
) != 0) {
1949 (void) no_memory(hdl
);
1956 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1961 addlist(libzfs_handle_t
*hdl
, char *propname
, zprop_list_t
**listp
,
1965 zprop_list_t
*entry
;
1967 prop
= zprop_name_to_prop(propname
, type
);
1969 if (prop
!= ZPROP_INVAL
&& !zprop_valid_for_type(prop
, type
, B_FALSE
))
1973 * When no property table entry can be found, return failure if
1974 * this is a pool property or if this isn't a user-defined
1977 if (prop
== ZPROP_INVAL
&& ((type
== ZFS_TYPE_POOL
&&
1978 !zpool_prop_feature(propname
) &&
1979 !zpool_prop_unsupported(propname
)) ||
1980 (type
== ZFS_TYPE_DATASET
&& !zfs_prop_user(propname
) &&
1981 !zfs_prop_userquota(propname
) && !zfs_prop_written(propname
)))) {
1982 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1983 "invalid property '%s'"), propname
);
1984 return (zfs_error(hdl
, EZFS_BADPROP
,
1985 dgettext(TEXT_DOMAIN
, "bad property list")));
1988 if ((entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
))) == NULL
)
1991 entry
->pl_prop
= prop
;
1992 if (prop
== ZPROP_INVAL
) {
1993 if ((entry
->pl_user_prop
= zfs_strdup(hdl
, propname
)) ==
1998 entry
->pl_width
= strlen(propname
);
2000 entry
->pl_width
= zprop_width(prop
, &entry
->pl_fixed
,
2010 * Given a comma-separated list of properties, construct a property list
2011 * containing both user-defined and native properties. This function will
2012 * return a NULL list if 'all' is specified, which can later be expanded
2013 * by zprop_expand_list().
2016 zprop_get_list(libzfs_handle_t
*hdl
, char *props
, zprop_list_t
**listp
,
2022 * If 'all' is specified, return a NULL list.
2024 if (strcmp(props
, "all") == 0)
2028 * If no props were specified, return an error.
2030 if (props
[0] == '\0') {
2031 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2032 "no properties specified"));
2033 return (zfs_error(hdl
, EZFS_BADPROP
, dgettext(TEXT_DOMAIN
,
2034 "bad property list")));
2038 * It would be nice to use getsubopt() here, but the inclusion of column
2039 * aliases makes this more effort than it's worth.
2041 while (*props
!= '\0') {
2046 if ((p
= strchr(props
, ',')) == NULL
) {
2047 len
= strlen(props
);
2054 * Check for empty options.
2057 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2058 "empty property name"));
2059 return (zfs_error(hdl
, EZFS_BADPROP
,
2060 dgettext(TEXT_DOMAIN
, "bad property list")));
2064 * Check all regular property names.
2069 if (strcmp(props
, "space") == 0) {
2070 static char *spaceprops
[] = {
2071 "name", "avail", "used", "usedbysnapshots",
2072 "usedbydataset", "usedbyrefreservation",
2073 "usedbychildren", NULL
2077 for (i
= 0; spaceprops
[i
]; i
++) {
2078 if (addlist(hdl
, spaceprops
[i
], listp
, type
))
2080 listp
= &(*listp
)->pl_next
;
2083 if (addlist(hdl
, props
, listp
, type
))
2085 listp
= &(*listp
)->pl_next
;
2097 zprop_free_list(zprop_list_t
*pl
)
2101 while (pl
!= NULL
) {
2103 free(pl
->pl_user_prop
);
2109 typedef struct expand_data
{
2110 zprop_list_t
**last
;
2111 libzfs_handle_t
*hdl
;
2116 zprop_expand_list_cb(int prop
, void *cb
)
2118 zprop_list_t
*entry
;
2119 expand_data_t
*edp
= cb
;
2121 if ((entry
= zfs_alloc(edp
->hdl
, sizeof (zprop_list_t
))) == NULL
)
2122 return (ZPROP_INVAL
);
2124 entry
->pl_prop
= prop
;
2125 entry
->pl_width
= zprop_width(prop
, &entry
->pl_fixed
, edp
->type
);
2126 entry
->pl_all
= B_TRUE
;
2128 *(edp
->last
) = entry
;
2129 edp
->last
= &entry
->pl_next
;
2131 return (ZPROP_CONT
);
2135 zprop_expand_list(libzfs_handle_t
*hdl
, zprop_list_t
**plp
, zfs_type_t type
)
2137 zprop_list_t
*entry
;
2138 zprop_list_t
**last
;
2143 * If this is the very first time we've been called for an 'all'
2144 * specification, expand the list to include all native
2153 if (zprop_iter_common(zprop_expand_list_cb
, &exp
, B_FALSE
,
2154 B_FALSE
, type
) == ZPROP_INVAL
)
2158 * Add 'name' to the beginning of the list, which is handled
2161 if ((entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
))) == NULL
)
2164 entry
->pl_prop
= (type
== ZFS_TYPE_POOL
) ? ZPOOL_PROP_NAME
:
2166 entry
->pl_width
= zprop_width(entry
->pl_prop
,
2167 &entry
->pl_fixed
, type
);
2168 entry
->pl_all
= B_TRUE
;
2169 entry
->pl_next
= *plp
;
2176 zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
, boolean_t ordered
,
2179 return (zprop_iter_common(func
, cb
, show_all
, ordered
, type
));