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 https://opensource.org/licenses/CDDL-1.0.
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 2020 Joyent, Inc. All rights reserved.
25 * Copyright (c) 2011, 2020 by Delphix. All rights reserved.
26 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
27 * Copyright (c) 2017 Datto Inc.
28 * Copyright (c) 2020 The FreeBSD Foundation
30 * Portions of this software were developed by Allan Jude
31 * under sponsorship from the FreeBSD Foundation.
35 * Internal utility routines for the ZFS library.
51 #include <sys/mnttab.h>
52 #include <sys/mntent.h>
53 #include <sys/types.h>
57 #include <libzfs_core.h>
59 #include "libzfs_impl.h"
61 #include "zfeature_common.h"
62 #include <zfs_fletcher.h>
66 * We only care about the scheme in order to match the scheme
67 * with the handler. Each handler should validate the full URI
70 #define URI_REGEX "^\\([A-Za-z][A-Za-z0-9+.\\-]*\\):"
73 libzfs_errno(libzfs_handle_t
*hdl
)
75 return (hdl
->libzfs_error
);
79 libzfs_error_action(libzfs_handle_t
*hdl
)
81 return (hdl
->libzfs_action
);
85 libzfs_error_description(libzfs_handle_t
*hdl
)
87 if (hdl
->libzfs_desc
[0] != '\0')
88 return (hdl
->libzfs_desc
);
90 switch (hdl
->libzfs_error
) {
92 return (dgettext(TEXT_DOMAIN
, "out of memory"));
94 return (dgettext(TEXT_DOMAIN
, "invalid property value"));
95 case EZFS_PROPREADONLY
:
96 return (dgettext(TEXT_DOMAIN
, "read-only property"));
98 return (dgettext(TEXT_DOMAIN
, "property doesn't apply to "
99 "datasets of this type"));
100 case EZFS_PROPNONINHERIT
:
101 return (dgettext(TEXT_DOMAIN
, "property cannot be inherited"));
103 return (dgettext(TEXT_DOMAIN
, "invalid quota or reservation"));
105 return (dgettext(TEXT_DOMAIN
, "operation not applicable to "
106 "datasets of this type"));
108 return (dgettext(TEXT_DOMAIN
, "pool or dataset is busy"));
110 return (dgettext(TEXT_DOMAIN
, "pool or dataset exists"));
112 return (dgettext(TEXT_DOMAIN
, "no such pool or dataset"));
114 return (dgettext(TEXT_DOMAIN
, "invalid backup stream"));
115 case EZFS_DSREADONLY
:
116 return (dgettext(TEXT_DOMAIN
, "dataset is read-only"));
118 return (dgettext(TEXT_DOMAIN
, "volume size exceeds limit for "
120 case EZFS_INVALIDNAME
:
121 return (dgettext(TEXT_DOMAIN
, "invalid name"));
122 case EZFS_BADRESTORE
:
123 return (dgettext(TEXT_DOMAIN
, "unable to restore to "
126 return (dgettext(TEXT_DOMAIN
, "backup failed"));
128 return (dgettext(TEXT_DOMAIN
, "invalid target vdev"));
130 return (dgettext(TEXT_DOMAIN
, "no such device in pool"));
132 return (dgettext(TEXT_DOMAIN
, "invalid device"));
133 case EZFS_NOREPLICAS
:
134 return (dgettext(TEXT_DOMAIN
, "no valid replicas"));
135 case EZFS_RESILVERING
:
136 return (dgettext(TEXT_DOMAIN
, "currently resilvering"));
137 case EZFS_BADVERSION
:
138 return (dgettext(TEXT_DOMAIN
, "unsupported version or "
140 case EZFS_POOLUNAVAIL
:
141 return (dgettext(TEXT_DOMAIN
, "pool is unavailable"));
142 case EZFS_DEVOVERFLOW
:
143 return (dgettext(TEXT_DOMAIN
, "too many devices in one vdev"));
145 return (dgettext(TEXT_DOMAIN
, "must be an absolute path"));
146 case EZFS_CROSSTARGET
:
147 return (dgettext(TEXT_DOMAIN
, "operation crosses datasets or "
150 return (dgettext(TEXT_DOMAIN
, "dataset in use by local zone"));
151 case EZFS_MOUNTFAILED
:
152 return (dgettext(TEXT_DOMAIN
, "mount failed"));
153 case EZFS_UMOUNTFAILED
:
154 return (dgettext(TEXT_DOMAIN
, "unmount failed"));
155 case EZFS_UNSHARENFSFAILED
:
156 return (dgettext(TEXT_DOMAIN
, "NFS share removal failed"));
157 case EZFS_SHARENFSFAILED
:
158 return (dgettext(TEXT_DOMAIN
, "NFS share creation failed"));
159 case EZFS_UNSHARESMBFAILED
:
160 return (dgettext(TEXT_DOMAIN
, "SMB share removal failed"));
161 case EZFS_SHARESMBFAILED
:
162 return (dgettext(TEXT_DOMAIN
, "SMB share creation failed"));
164 return (dgettext(TEXT_DOMAIN
, "permission denied"));
166 return (dgettext(TEXT_DOMAIN
, "out of space"));
168 return (dgettext(TEXT_DOMAIN
, "bad address"));
170 return (dgettext(TEXT_DOMAIN
, "I/O error"));
172 return (dgettext(TEXT_DOMAIN
, "signal received"));
174 return (dgettext(TEXT_DOMAIN
, "device is reserved as a hot "
176 case EZFS_INVALCONFIG
:
177 return (dgettext(TEXT_DOMAIN
, "invalid vdev configuration"));
179 return (dgettext(TEXT_DOMAIN
, "recursive dataset dependency"));
181 return (dgettext(TEXT_DOMAIN
, "no history available"));
183 return (dgettext(TEXT_DOMAIN
, "failed to retrieve "
185 case EZFS_POOL_NOTSUP
:
186 return (dgettext(TEXT_DOMAIN
, "operation not supported "
187 "on this type of pool"));
188 case EZFS_POOL_INVALARG
:
189 return (dgettext(TEXT_DOMAIN
, "invalid argument for "
190 "this pool operation"));
191 case EZFS_NAMETOOLONG
:
192 return (dgettext(TEXT_DOMAIN
, "dataset name is too long"));
193 case EZFS_OPENFAILED
:
194 return (dgettext(TEXT_DOMAIN
, "open failed"));
196 return (dgettext(TEXT_DOMAIN
,
197 "disk capacity information could not be retrieved"));
198 case EZFS_LABELFAILED
:
199 return (dgettext(TEXT_DOMAIN
, "write of label failed"));
201 return (dgettext(TEXT_DOMAIN
, "invalid user/group"));
203 return (dgettext(TEXT_DOMAIN
, "invalid permission"));
204 case EZFS_BADPERMSET
:
205 return (dgettext(TEXT_DOMAIN
, "invalid permission set name"));
206 case EZFS_NODELEGATION
:
207 return (dgettext(TEXT_DOMAIN
, "delegated administration is "
208 "disabled on pool"));
210 return (dgettext(TEXT_DOMAIN
, "invalid or missing cache file"));
212 return (dgettext(TEXT_DOMAIN
, "device is in use as a cache"));
213 case EZFS_VDEVNOTSUP
:
214 return (dgettext(TEXT_DOMAIN
, "vdev specification is not "
217 return (dgettext(TEXT_DOMAIN
, "operation not supported "
219 case EZFS_IOC_NOTSUPPORTED
:
220 return (dgettext(TEXT_DOMAIN
, "operation not supported by "
221 "zfs kernel module"));
222 case EZFS_ACTIVE_SPARE
:
223 return (dgettext(TEXT_DOMAIN
, "pool has active shared spare "
225 case EZFS_UNPLAYED_LOGS
:
226 return (dgettext(TEXT_DOMAIN
, "log device has unplayed intent "
228 case EZFS_REFTAG_RELE
:
229 return (dgettext(TEXT_DOMAIN
, "no such tag on this dataset"));
230 case EZFS_REFTAG_HOLD
:
231 return (dgettext(TEXT_DOMAIN
, "tag already exists on this "
233 case EZFS_TAGTOOLONG
:
234 return (dgettext(TEXT_DOMAIN
, "tag too long"));
235 case EZFS_PIPEFAILED
:
236 return (dgettext(TEXT_DOMAIN
, "pipe create failed"));
237 case EZFS_THREADCREATEFAILED
:
238 return (dgettext(TEXT_DOMAIN
, "thread create failed"));
239 case EZFS_POSTSPLIT_ONLINE
:
240 return (dgettext(TEXT_DOMAIN
, "disk was split from this pool "
242 case EZFS_SCRUB_PAUSED
:
243 return (dgettext(TEXT_DOMAIN
, "scrub is paused; "
244 "use 'zpool scrub' to resume"));
246 return (dgettext(TEXT_DOMAIN
, "currently scrubbing; "
247 "use 'zpool scrub -s' to cancel current scrub"));
249 return (dgettext(TEXT_DOMAIN
, "there is no active scrub"));
251 return (dgettext(TEXT_DOMAIN
, "unable to generate diffs"));
253 return (dgettext(TEXT_DOMAIN
, "invalid diff data"));
254 case EZFS_POOLREADONLY
:
255 return (dgettext(TEXT_DOMAIN
, "pool is read-only"));
256 case EZFS_NO_PENDING
:
257 return (dgettext(TEXT_DOMAIN
, "operation is not "
259 case EZFS_CHECKPOINT_EXISTS
:
260 return (dgettext(TEXT_DOMAIN
, "checkpoint exists"));
261 case EZFS_DISCARDING_CHECKPOINT
:
262 return (dgettext(TEXT_DOMAIN
, "currently discarding "
264 case EZFS_NO_CHECKPOINT
:
265 return (dgettext(TEXT_DOMAIN
, "checkpoint does not exist"));
266 case EZFS_DEVRM_IN_PROGRESS
:
267 return (dgettext(TEXT_DOMAIN
, "device removal in progress"));
268 case EZFS_VDEV_TOO_BIG
:
269 return (dgettext(TEXT_DOMAIN
, "device exceeds supported size"));
270 case EZFS_ACTIVE_POOL
:
271 return (dgettext(TEXT_DOMAIN
, "pool is imported on a "
273 case EZFS_CRYPTOFAILED
:
274 return (dgettext(TEXT_DOMAIN
, "encryption failure"));
276 return (dgettext(TEXT_DOMAIN
, "argument list too long"));
277 case EZFS_INITIALIZING
:
278 return (dgettext(TEXT_DOMAIN
, "currently initializing"));
279 case EZFS_NO_INITIALIZE
:
280 return (dgettext(TEXT_DOMAIN
, "there is no active "
282 case EZFS_WRONG_PARENT
:
283 return (dgettext(TEXT_DOMAIN
, "invalid parent dataset"));
285 return (dgettext(TEXT_DOMAIN
, "currently trimming"));
287 return (dgettext(TEXT_DOMAIN
, "there is no active trim"));
288 case EZFS_TRIM_NOTSUP
:
289 return (dgettext(TEXT_DOMAIN
, "trim operations are not "
290 "supported by this device"));
291 case EZFS_NO_RESILVER_DEFER
:
292 return (dgettext(TEXT_DOMAIN
, "this action requires the "
293 "resilver_defer feature"));
294 case EZFS_EXPORT_IN_PROGRESS
:
295 return (dgettext(TEXT_DOMAIN
, "pool export in progress"));
296 case EZFS_REBUILDING
:
297 return (dgettext(TEXT_DOMAIN
, "currently sequentially "
299 case EZFS_VDEV_NOTSUP
:
300 return (dgettext(TEXT_DOMAIN
, "operation not supported "
301 "on this type of vdev"));
302 case EZFS_NOT_USER_NAMESPACE
:
303 return (dgettext(TEXT_DOMAIN
, "the provided file "
304 "was not a user namespace file"));
306 return (dgettext(TEXT_DOMAIN
, "unknown error"));
308 assert(hdl
->libzfs_error
== 0);
309 return (dgettext(TEXT_DOMAIN
, "no error"));
314 zfs_error_aux(libzfs_handle_t
*hdl
, const char *fmt
, ...)
320 (void) vsnprintf(hdl
->libzfs_desc
, sizeof (hdl
->libzfs_desc
),
322 hdl
->libzfs_desc_active
= 1;
328 zfs_verror(libzfs_handle_t
*hdl
, int error
, const char *fmt
, va_list ap
)
330 (void) vsnprintf(hdl
->libzfs_action
, sizeof (hdl
->libzfs_action
),
332 hdl
->libzfs_error
= error
;
334 if (hdl
->libzfs_desc_active
)
335 hdl
->libzfs_desc_active
= 0;
337 hdl
->libzfs_desc
[0] = '\0';
339 if (hdl
->libzfs_printerr
) {
340 if (error
== EZFS_UNKNOWN
) {
341 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
, "internal "
342 "error: %s: %s\n"), hdl
->libzfs_action
,
343 libzfs_error_description(hdl
));
347 (void) fprintf(stderr
, "%s: %s\n", hdl
->libzfs_action
,
348 libzfs_error_description(hdl
));
349 if (error
== EZFS_NOMEM
)
355 zfs_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
357 return (zfs_error_fmt(hdl
, error
, "%s", msg
));
361 zfs_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
367 zfs_verror(hdl
, error
, fmt
, ap
);
375 zfs_common_error(libzfs_handle_t
*hdl
, int error
, const char *fmt
,
381 zfs_verror(hdl
, EZFS_PERM
, fmt
, ap
);
385 zfs_verror(hdl
, EZFS_NODELEGATION
, fmt
, ap
);
389 zfs_verror(hdl
, EZFS_IO
, fmt
, ap
);
393 zfs_verror(hdl
, EZFS_FAULT
, fmt
, ap
);
397 zfs_verror(hdl
, EZFS_INTR
, fmt
, ap
);
405 zfs_standard_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
407 return (zfs_standard_error_fmt(hdl
, error
, "%s", msg
));
411 zfs_standard_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
417 if (zfs_common_error(hdl
, error
, fmt
, ap
) != 0) {
426 zfs_verror(hdl
, EZFS_IO
, fmt
, ap
);
430 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
431 "dataset does not exist"));
432 zfs_verror(hdl
, EZFS_NOENT
, fmt
, ap
);
437 zfs_verror(hdl
, EZFS_NOSPC
, fmt
, ap
);
441 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
442 "dataset already exists"));
443 zfs_verror(hdl
, EZFS_EXISTS
, fmt
, ap
);
447 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
449 zfs_verror(hdl
, EZFS_BUSY
, fmt
, ap
);
452 zfs_verror(hdl
, EZFS_POOLREADONLY
, fmt
, ap
);
455 zfs_verror(hdl
, EZFS_NAMETOOLONG
, fmt
, ap
);
458 zfs_verror(hdl
, EZFS_BADVERSION
, fmt
, ap
);
461 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
462 "pool I/O is currently suspended"));
463 zfs_verror(hdl
, EZFS_POOLUNAVAIL
, fmt
, ap
);
466 zfs_verror(hdl
, EZFS_ACTIVE_POOL
, fmt
, ap
);
468 case ZFS_ERR_UNKNOWN_SEND_STREAM_FEATURE
:
469 case ZFS_ERR_IOC_CMD_UNAVAIL
:
470 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "the loaded zfs "
471 "module does not support this operation. A reboot may "
472 "be required to enable this operation."));
473 zfs_verror(hdl
, EZFS_IOC_NOTSUPPORTED
, fmt
, ap
);
475 case ZFS_ERR_IOC_ARG_UNAVAIL
:
476 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "the loaded zfs "
477 "module does not support an option for this operation. "
478 "A reboot may be required to enable this option."));
479 zfs_verror(hdl
, EZFS_IOC_NOTSUPPORTED
, fmt
, ap
);
481 case ZFS_ERR_IOC_ARG_REQUIRED
:
482 case ZFS_ERR_IOC_ARG_BADTYPE
:
483 zfs_verror(hdl
, EZFS_IOC_NOTSUPPORTED
, fmt
, ap
);
485 case ZFS_ERR_WRONG_PARENT
:
486 zfs_verror(hdl
, EZFS_WRONG_PARENT
, fmt
, ap
);
488 case ZFS_ERR_BADPROP
:
489 zfs_verror(hdl
, EZFS_BADPROP
, fmt
, ap
);
491 case ZFS_ERR_NOT_USER_NAMESPACE
:
492 zfs_verror(hdl
, EZFS_NOT_USER_NAMESPACE
, fmt
, ap
);
495 zfs_error_aux(hdl
, "%s", strerror(error
));
496 zfs_verror(hdl
, EZFS_UNKNOWN
, fmt
, ap
);
505 zfs_setprop_error(libzfs_handle_t
*hdl
, zfs_prop_t prop
, int err
,
512 * For quotas and reservations, ENOSPC indicates
513 * something different; setting a quota or reservation
514 * doesn't use any disk space.
518 case ZFS_PROP_REFQUOTA
:
519 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
520 "size is less than current used or "
522 (void) zfs_error(hdl
, EZFS_PROPSPACE
, errbuf
);
525 case ZFS_PROP_RESERVATION
:
526 case ZFS_PROP_REFRESERVATION
:
527 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
528 "size is greater than available space"));
529 (void) zfs_error(hdl
, EZFS_PROPSPACE
, errbuf
);
533 (void) zfs_standard_error(hdl
, err
, errbuf
);
539 (void) zfs_standard_error(hdl
, EBUSY
, errbuf
);
543 (void) zfs_error(hdl
, EZFS_DSREADONLY
, errbuf
);
547 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
548 "property value too long"));
549 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
553 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
554 "pool and or dataset must be upgraded to set this "
555 "property or value"));
556 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
560 if (prop
== ZFS_PROP_COMPRESSION
||
561 prop
== ZFS_PROP_DNODESIZE
||
562 prop
== ZFS_PROP_RECORDSIZE
) {
563 (void) zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
564 "property setting is not allowed on "
565 "bootable datasets"));
566 (void) zfs_error(hdl
, EZFS_NOTSUP
, errbuf
);
567 } else if (prop
== ZFS_PROP_CHECKSUM
||
568 prop
== ZFS_PROP_DEDUP
) {
569 (void) zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
570 "property setting is not allowed on "
572 (void) zfs_error(hdl
, EZFS_NOTSUP
, errbuf
);
574 (void) zfs_standard_error(hdl
, err
, errbuf
);
579 if (prop
== ZPROP_INVAL
) {
580 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
582 (void) zfs_standard_error(hdl
, err
, errbuf
);
586 case ZFS_ERR_BADPROP
:
587 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
591 if (prop
== ZFS_PROP_KEYLOCATION
) {
592 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
593 "keylocation may only be set on encryption roots"));
594 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
596 (void) zfs_standard_error(hdl
, err
, errbuf
);
602 * This platform can't address a volume this big.
605 if (prop
== ZFS_PROP_VOLSIZE
) {
606 (void) zfs_error(hdl
, EZFS_VOLTOOBIG
, errbuf
);
612 (void) zfs_standard_error(hdl
, err
, errbuf
);
617 zpool_standard_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
619 return (zpool_standard_error_fmt(hdl
, error
, "%s", msg
));
623 zpool_standard_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
629 if (zfs_common_error(hdl
, error
, fmt
, ap
) != 0) {
636 zfs_verror(hdl
, EZFS_NODEVICE
, fmt
, ap
);
641 dgettext(TEXT_DOMAIN
, "no such pool or dataset"));
642 zfs_verror(hdl
, EZFS_NOENT
, fmt
, ap
);
646 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
647 "pool already exists"));
648 zfs_verror(hdl
, EZFS_EXISTS
, fmt
, ap
);
652 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "pool is busy"));
653 zfs_verror(hdl
, EZFS_BUSY
, fmt
, ap
);
656 /* There is no pending operation to cancel */
658 zfs_verror(hdl
, EZFS_NO_PENDING
, fmt
, ap
);
662 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
663 "one or more devices is currently unavailable"));
664 zfs_verror(hdl
, EZFS_BADDEV
, fmt
, ap
);
668 zfs_verror(hdl
, EZFS_DEVOVERFLOW
, fmt
, ap
);
672 zfs_verror(hdl
, EZFS_POOL_NOTSUP
, fmt
, ap
);
676 zfs_verror(hdl
, EZFS_POOL_INVALARG
, fmt
, ap
);
681 zfs_verror(hdl
, EZFS_NOSPC
, fmt
, ap
);
685 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
686 "pool I/O is currently suspended"));
687 zfs_verror(hdl
, EZFS_POOLUNAVAIL
, fmt
, ap
);
691 zfs_verror(hdl
, EZFS_POOLREADONLY
, fmt
, ap
);
694 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
695 "block size out of range or does not match"));
696 zfs_verror(hdl
, EZFS_BADPROP
, fmt
, ap
);
699 zfs_verror(hdl
, EZFS_ACTIVE_POOL
, fmt
, ap
);
701 case ZFS_ERR_CHECKPOINT_EXISTS
:
702 zfs_verror(hdl
, EZFS_CHECKPOINT_EXISTS
, fmt
, ap
);
704 case ZFS_ERR_DISCARDING_CHECKPOINT
:
705 zfs_verror(hdl
, EZFS_DISCARDING_CHECKPOINT
, fmt
, ap
);
707 case ZFS_ERR_NO_CHECKPOINT
:
708 zfs_verror(hdl
, EZFS_NO_CHECKPOINT
, fmt
, ap
);
710 case ZFS_ERR_DEVRM_IN_PROGRESS
:
711 zfs_verror(hdl
, EZFS_DEVRM_IN_PROGRESS
, fmt
, ap
);
713 case ZFS_ERR_VDEV_TOO_BIG
:
714 zfs_verror(hdl
, EZFS_VDEV_TOO_BIG
, fmt
, ap
);
716 case ZFS_ERR_EXPORT_IN_PROGRESS
:
717 zfs_verror(hdl
, EZFS_EXPORT_IN_PROGRESS
, fmt
, ap
);
719 case ZFS_ERR_RESILVER_IN_PROGRESS
:
720 zfs_verror(hdl
, EZFS_RESILVERING
, fmt
, ap
);
722 case ZFS_ERR_REBUILD_IN_PROGRESS
:
723 zfs_verror(hdl
, EZFS_REBUILDING
, fmt
, ap
);
725 case ZFS_ERR_BADPROP
:
726 zfs_verror(hdl
, EZFS_BADPROP
, fmt
, ap
);
728 case ZFS_ERR_VDEV_NOTSUP
:
729 zfs_verror(hdl
, EZFS_VDEV_NOTSUP
, fmt
, ap
);
731 case ZFS_ERR_IOC_CMD_UNAVAIL
:
732 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "the loaded zfs "
733 "module does not support this operation. A reboot may "
734 "be required to enable this operation."));
735 zfs_verror(hdl
, EZFS_IOC_NOTSUPPORTED
, fmt
, ap
);
737 case ZFS_ERR_IOC_ARG_UNAVAIL
:
738 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "the loaded zfs "
739 "module does not support an option for this operation. "
740 "A reboot may be required to enable this option."));
741 zfs_verror(hdl
, EZFS_IOC_NOTSUPPORTED
, fmt
, ap
);
743 case ZFS_ERR_IOC_ARG_REQUIRED
:
744 case ZFS_ERR_IOC_ARG_BADTYPE
:
745 zfs_verror(hdl
, EZFS_IOC_NOTSUPPORTED
, fmt
, ap
);
748 zfs_error_aux(hdl
, "%s", strerror(error
));
749 zfs_verror(hdl
, EZFS_UNKNOWN
, fmt
, ap
);
757 * Display an out of memory error message and abort the current program.
760 no_memory(libzfs_handle_t
*hdl
)
762 return (zfs_error(hdl
, EZFS_NOMEM
, "internal error"));
766 * A safe form of malloc() which will die if the allocation fails.
769 zfs_alloc(libzfs_handle_t
*hdl
, size_t size
)
773 if ((data
= calloc(1, size
)) == NULL
)
774 (void) no_memory(hdl
);
780 * A safe form of asprintf() which will die if the allocation fails.
783 zfs_asprintf(libzfs_handle_t
*hdl
, const char *fmt
, ...)
791 err
= vasprintf(&ret
, fmt
, ap
);
796 (void) no_memory(hdl
);
804 * A safe form of realloc(), which also zeroes newly allocated space.
807 zfs_realloc(libzfs_handle_t
*hdl
, void *ptr
, size_t oldsize
, size_t newsize
)
811 if ((ret
= realloc(ptr
, newsize
)) == NULL
) {
812 (void) no_memory(hdl
);
816 memset((char *)ret
+ oldsize
, 0, newsize
- oldsize
);
821 * A safe form of strdup() which will die if the allocation fails.
824 zfs_strdup(libzfs_handle_t
*hdl
, const char *str
)
828 if ((ret
= strdup(str
)) == NULL
)
829 (void) no_memory(hdl
);
835 libzfs_print_on_error(libzfs_handle_t
*hdl
, boolean_t printerr
)
837 hdl
->libzfs_printerr
= printerr
;
841 * Read lines from an open file descriptor and store them in an array of
842 * strings until EOF. lines[] will be allocated and populated with all the
843 * lines read. All newlines are replaced with NULL terminators for
844 * convenience. lines[] must be freed after use with libzfs_free_str_array().
846 * Returns the number of lines read.
849 libzfs_read_stdout_from_fd(int fd
, char **lines
[])
856 char **tmp_lines
= NULL
, **tmp
;
858 fp
= fdopen(fd
, "r");
863 while (getline(&line
, &len
, fp
) != -1) {
864 tmp
= realloc(tmp_lines
, sizeof (*tmp_lines
) * (lines_cnt
+ 1));
866 /* Return the lines we were able to process */
871 /* Remove newline if not EOF */
872 if (line
[strlen(line
) - 1] == '\n')
873 line
[strlen(line
) - 1] = '\0';
875 tmp_lines
[lines_cnt
] = strdup(line
);
876 if (tmp_lines
[lines_cnt
] == NULL
)
887 libzfs_run_process_impl(const char *path
, char *argv
[], char *env
[], int flags
,
888 char **lines
[], int *lines_cnt
)
891 int error
, devnull_fd
;
895 * Setup a pipe between our child and parent process if we're
898 if (lines
!= NULL
&& pipe2(link
, O_NONBLOCK
| O_CLOEXEC
) == -1)
904 devnull_fd
= open("/dev/null", O_WRONLY
| O_CLOEXEC
);
909 if (!(flags
& STDOUT_VERBOSE
) && (lines
== NULL
))
910 (void) dup2(devnull_fd
, STDOUT_FILENO
);
911 else if (lines
!= NULL
) {
912 /* Save the output to lines[] */
913 dup2(link
[1], STDOUT_FILENO
);
916 if (!(flags
& STDERR_VERBOSE
))
917 (void) dup2(devnull_fd
, STDERR_FILENO
);
919 if (flags
& NO_DEFAULT_PATH
) {
923 execve(path
, argv
, env
);
928 execvpe(path
, argv
, env
);
932 } else if (pid
> 0) {
936 while ((error
= waitpid(pid
, &status
, 0)) == -1 &&
939 if (error
< 0 || !WIFEXITED(status
))
944 *lines_cnt
= libzfs_read_stdout_from_fd(link
[0], lines
);
946 return (WEXITSTATUS(status
));
953 libzfs_run_process(const char *path
, char *argv
[], int flags
)
955 return (libzfs_run_process_impl(path
, argv
, NULL
, flags
, NULL
, NULL
));
959 * Run a command and store its stdout lines in an array of strings (lines[]).
960 * lines[] is allocated and populated for you, and the number of lines is set in
961 * lines_cnt. lines[] must be freed after use with libzfs_free_str_array().
962 * All newlines (\n) in lines[] are terminated for convenience.
965 libzfs_run_process_get_stdout(const char *path
, char *argv
[], char *env
[],
966 char **lines
[], int *lines_cnt
)
968 return (libzfs_run_process_impl(path
, argv
, env
, 0, lines
, lines_cnt
));
972 * Same as libzfs_run_process_get_stdout(), but run without $PATH set. This
973 * means that *path needs to be the full path to the executable.
976 libzfs_run_process_get_stdout_nopath(const char *path
, char *argv
[],
977 char *env
[], char **lines
[], int *lines_cnt
)
979 return (libzfs_run_process_impl(path
, argv
, env
, NO_DEFAULT_PATH
,
984 * Free an array of strings. Free both the strings contained in the array and
988 libzfs_free_str_array(char **strs
, int count
)
997 * Returns 1 if environment variable is set to "YES", "yes", "ON", "on", or
1000 * Returns 0 otherwise.
1003 libzfs_envvar_is_set(const char *envvar
)
1005 char *env
= getenv(envvar
);
1006 return (env
&& (strtoul(env
, NULL
, 0) > 0 ||
1007 (!strncasecmp(env
, "YES", 3) && strnlen(env
, 4) == 3) ||
1008 (!strncasecmp(env
, "ON", 2) && strnlen(env
, 3) == 2)));
1014 libzfs_handle_t
*hdl
;
1018 if ((error
= libzfs_load_module()) != 0) {
1023 if ((hdl
= calloc(1, sizeof (libzfs_handle_t
))) == NULL
) {
1027 if (regcomp(&hdl
->libzfs_urire
, URI_REGEX
, 0) != 0) {
1032 if ((hdl
->libzfs_fd
= open(ZFS_DEV
, O_RDWR
|O_EXCL
|O_CLOEXEC
)) < 0) {
1037 if (libzfs_core_init() != 0) {
1038 (void) close(hdl
->libzfs_fd
);
1045 zpool_feature_init();
1047 libzfs_mnttab_init(hdl
);
1050 if (getenv("ZFS_PROP_DEBUG") != NULL
) {
1051 hdl
->libzfs_prop_debug
= B_TRUE
;
1053 if ((env
= getenv("ZFS_SENDRECV_MAX_NVLIST")) != NULL
) {
1054 if ((error
= zfs_nicestrtonum(hdl
, env
,
1055 &hdl
->libzfs_max_nvlist
))) {
1057 (void) close(hdl
->libzfs_fd
);
1062 hdl
->libzfs_max_nvlist
= (SPA_MAXBLOCKSIZE
* 4);
1066 * For testing, remove some settable properties and features
1068 if (libzfs_envvar_is_set("ZFS_SYSFS_PROP_SUPPORT_TEST")) {
1069 zprop_desc_t
*proptbl
;
1071 proptbl
= zpool_prop_get_table();
1072 proptbl
[ZPOOL_PROP_COMMENT
].pd_zfs_mod_supported
= B_FALSE
;
1074 proptbl
= zfs_prop_get_table();
1075 proptbl
[ZFS_PROP_DNODESIZE
].pd_zfs_mod_supported
= B_FALSE
;
1077 zfeature_info_t
*ftbl
= spa_feature_table
;
1078 ftbl
[SPA_FEATURE_LARGE_BLOCKS
].fi_zfs_mod_supported
= B_FALSE
;
1085 libzfs_fini(libzfs_handle_t
*hdl
)
1087 (void) close(hdl
->libzfs_fd
);
1088 zpool_free_handles(hdl
);
1089 namespace_clear(hdl
);
1090 libzfs_mnttab_fini(hdl
);
1092 regfree(&hdl
->libzfs_urire
);
1094 #if LIBFETCH_DYNAMIC
1095 if (hdl
->libfetch
!= (void *)-1 && hdl
->libfetch
!= NULL
)
1096 (void) dlclose(hdl
->libfetch
);
1097 free(hdl
->libfetch_load_error
);
1103 zpool_get_handle(zpool_handle_t
*zhp
)
1105 return (zhp
->zpool_hdl
);
1109 zfs_get_handle(zfs_handle_t
*zhp
)
1111 return (zhp
->zfs_hdl
);
1115 zfs_get_pool_handle(const zfs_handle_t
*zhp
)
1117 return (zhp
->zpool_hdl
);
1121 * Given a name, determine whether or not it's a valid path
1122 * (starts with '/' or "./"). If so, walk the mnttab trying
1123 * to match the device number. If not, treat the path as an
1124 * fs/vol/snap/bkmark name.
1127 zfs_path_to_zhandle(libzfs_handle_t
*hdl
, const char *path
, zfs_type_t argtype
)
1129 struct stat64 statbuf
;
1130 struct extmnttab entry
;
1132 if (path
[0] != '/' && strncmp(path
, "./", strlen("./")) != 0) {
1134 * It's not a valid path, assume it's a name of type 'argtype'.
1136 return (zfs_open(hdl
, path
, argtype
));
1139 if (getextmntent(path
, &entry
, &statbuf
) != 0)
1142 if (strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0) {
1143 (void) fprintf(stderr
, gettext("'%s': not a ZFS filesystem\n"),
1148 return (zfs_open(hdl
, entry
.mnt_special
, ZFS_TYPE_FILESYSTEM
));
1152 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
1156 zcmd_alloc_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, size_t len
)
1160 zc
->zc_nvlist_dst_size
= len
;
1162 (uint64_t)(uintptr_t)zfs_alloc(hdl
, zc
->zc_nvlist_dst_size
);
1166 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
1167 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
1168 * filled in by the kernel to indicate the actual required size.
1171 zcmd_expand_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
)
1173 free((void *)(uintptr_t)zc
->zc_nvlist_dst
);
1175 (uint64_t)(uintptr_t)zfs_alloc(hdl
, zc
->zc_nvlist_dst_size
);
1179 * Called to free the src and dst nvlists stored in the command structure.
1182 zcmd_free_nvlists(zfs_cmd_t
*zc
)
1184 free((void *)(uintptr_t)zc
->zc_nvlist_conf
);
1185 free((void *)(uintptr_t)zc
->zc_nvlist_src
);
1186 free((void *)(uintptr_t)zc
->zc_nvlist_dst
);
1187 zc
->zc_nvlist_conf
= 0;
1188 zc
->zc_nvlist_src
= 0;
1189 zc
->zc_nvlist_dst
= 0;
1193 zcmd_write_nvlist_com(libzfs_handle_t
*hdl
, uint64_t *outnv
, uint64_t *outlen
,
1198 size_t len
= fnvlist_size(nvl
);
1199 packed
= zfs_alloc(hdl
, len
);
1201 verify(nvlist_pack(nvl
, &packed
, &len
, NV_ENCODE_NATIVE
, 0) == 0);
1203 *outnv
= (uint64_t)(uintptr_t)packed
;
1208 zcmd_write_conf_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
*nvl
)
1210 zcmd_write_nvlist_com(hdl
, &zc
->zc_nvlist_conf
,
1211 &zc
->zc_nvlist_conf_size
, nvl
);
1215 zcmd_write_src_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
*nvl
)
1217 zcmd_write_nvlist_com(hdl
, &zc
->zc_nvlist_src
,
1218 &zc
->zc_nvlist_src_size
, nvl
);
1222 * Unpacks an nvlist from the ZFS ioctl command structure.
1225 zcmd_read_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
**nvlp
)
1227 if (nvlist_unpack((void *)(uintptr_t)zc
->zc_nvlist_dst
,
1228 zc
->zc_nvlist_dst_size
, nvlp
, 0) != 0)
1229 return (no_memory(hdl
));
1235 * ================================================================
1236 * API shared by zfs and zpool property management
1237 * ================================================================
1241 zprop_print_headers(zprop_get_cbdata_t
*cbp
, zfs_type_t type
)
1243 zprop_list_t
*pl
= cbp
->cb_proplist
;
1248 cbp
->cb_first
= B_FALSE
;
1249 if (cbp
->cb_scripted
)
1253 * Start with the length of the column headers.
1255 cbp
->cb_colwidths
[GET_COL_NAME
] = strlen(dgettext(TEXT_DOMAIN
, "NAME"));
1256 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = strlen(dgettext(TEXT_DOMAIN
,
1258 cbp
->cb_colwidths
[GET_COL_VALUE
] = strlen(dgettext(TEXT_DOMAIN
,
1260 cbp
->cb_colwidths
[GET_COL_RECVD
] = strlen(dgettext(TEXT_DOMAIN
,
1262 cbp
->cb_colwidths
[GET_COL_SOURCE
] = strlen(dgettext(TEXT_DOMAIN
,
1265 /* first property is always NAME */
1266 assert(cbp
->cb_proplist
->pl_prop
==
1267 ((type
== ZFS_TYPE_POOL
) ? ZPOOL_PROP_NAME
:
1268 ((type
== ZFS_TYPE_VDEV
) ? VDEV_PROP_NAME
: ZFS_PROP_NAME
)));
1271 * Go through and calculate the widths for each column. For the
1272 * 'source' column, we kludge it up by taking the worst-case scenario of
1273 * inheriting from the longest name. This is acceptable because in the
1274 * majority of cases 'SOURCE' is the last column displayed, and we don't
1275 * use the width anyway. Note that the 'VALUE' column can be oversized,
1276 * if the name of the property is much longer than any values we find.
1278 for (pl
= cbp
->cb_proplist
; pl
!= NULL
; pl
= pl
->pl_next
) {
1282 if (pl
->pl_prop
!= ZPROP_USERPROP
) {
1283 const char *propname
= (type
== ZFS_TYPE_POOL
) ?
1284 zpool_prop_to_name(pl
->pl_prop
) :
1285 ((type
== ZFS_TYPE_VDEV
) ?
1286 vdev_prop_to_name(pl
->pl_prop
) :
1287 zfs_prop_to_name(pl
->pl_prop
));
1289 assert(propname
!= NULL
);
1290 len
= strlen(propname
);
1291 if (len
> cbp
->cb_colwidths
[GET_COL_PROPERTY
])
1292 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = len
;
1294 assert(pl
->pl_user_prop
!= NULL
);
1295 len
= strlen(pl
->pl_user_prop
);
1296 if (len
> cbp
->cb_colwidths
[GET_COL_PROPERTY
])
1297 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = len
;
1301 * 'VALUE' column. The first property is always the 'name'
1302 * property that was tacked on either by /sbin/zfs's
1303 * zfs_do_get() or when calling zprop_expand_list(), so we
1304 * ignore its width. If the user specified the name property
1305 * to display, then it will be later in the list in any case.
1307 if (pl
!= cbp
->cb_proplist
&&
1308 pl
->pl_width
> cbp
->cb_colwidths
[GET_COL_VALUE
])
1309 cbp
->cb_colwidths
[GET_COL_VALUE
] = pl
->pl_width
;
1311 /* 'RECEIVED' column. */
1312 if (pl
!= cbp
->cb_proplist
&&
1313 pl
->pl_recvd_width
> cbp
->cb_colwidths
[GET_COL_RECVD
])
1314 cbp
->cb_colwidths
[GET_COL_RECVD
] = pl
->pl_recvd_width
;
1317 * 'NAME' and 'SOURCE' columns
1319 if (pl
->pl_prop
== ((type
== ZFS_TYPE_POOL
) ? ZPOOL_PROP_NAME
:
1320 ((type
== ZFS_TYPE_VDEV
) ? VDEV_PROP_NAME
:
1321 ZFS_PROP_NAME
)) && pl
->pl_width
>
1322 cbp
->cb_colwidths
[GET_COL_NAME
]) {
1323 cbp
->cb_colwidths
[GET_COL_NAME
] = pl
->pl_width
;
1324 cbp
->cb_colwidths
[GET_COL_SOURCE
] = pl
->pl_width
+
1325 strlen(dgettext(TEXT_DOMAIN
, "inherited from"));
1330 * Now go through and print the headers.
1332 for (i
= 0; i
< ZFS_GET_NCOLS
; i
++) {
1333 switch (cbp
->cb_columns
[i
]) {
1335 title
= dgettext(TEXT_DOMAIN
, "NAME");
1337 case GET_COL_PROPERTY
:
1338 title
= dgettext(TEXT_DOMAIN
, "PROPERTY");
1341 title
= dgettext(TEXT_DOMAIN
, "VALUE");
1344 title
= dgettext(TEXT_DOMAIN
, "RECEIVED");
1346 case GET_COL_SOURCE
:
1347 title
= dgettext(TEXT_DOMAIN
, "SOURCE");
1353 if (title
!= NULL
) {
1354 if (i
== (ZFS_GET_NCOLS
- 1) ||
1355 cbp
->cb_columns
[i
+ 1] == GET_COL_NONE
)
1356 (void) printf("%s", title
);
1358 (void) printf("%-*s ",
1359 cbp
->cb_colwidths
[cbp
->cb_columns
[i
]],
1363 (void) printf("\n");
1367 * Display a single line of output, according to the settings in the callback
1371 zprop_print_one_property(const char *name
, zprop_get_cbdata_t
*cbp
,
1372 const char *propname
, const char *value
, zprop_source_t sourcetype
,
1373 const char *source
, const char *recvd_value
)
1376 const char *str
= NULL
;
1380 * Ignore those source types that the user has chosen to ignore.
1382 if ((sourcetype
& cbp
->cb_sources
) == 0)
1386 zprop_print_headers(cbp
, cbp
->cb_type
);
1388 for (i
= 0; i
< ZFS_GET_NCOLS
; i
++) {
1389 switch (cbp
->cb_columns
[i
]) {
1394 case GET_COL_PROPERTY
:
1402 case GET_COL_SOURCE
:
1403 switch (sourcetype
) {
1404 case ZPROP_SRC_NONE
:
1408 case ZPROP_SRC_DEFAULT
:
1412 case ZPROP_SRC_LOCAL
:
1416 case ZPROP_SRC_TEMPORARY
:
1420 case ZPROP_SRC_INHERITED
:
1421 (void) snprintf(buf
, sizeof (buf
),
1422 "inherited from %s", source
);
1425 case ZPROP_SRC_RECEIVED
:
1431 assert(!"unhandled zprop_source_t");
1436 str
= (recvd_value
== NULL
? "-" : recvd_value
);
1443 if (i
== (ZFS_GET_NCOLS
- 1) ||
1444 cbp
->cb_columns
[i
+ 1] == GET_COL_NONE
)
1445 (void) printf("%s", str
);
1446 else if (cbp
->cb_scripted
)
1447 (void) printf("%s\t", str
);
1449 (void) printf("%-*s ",
1450 cbp
->cb_colwidths
[cbp
->cb_columns
[i
]],
1454 (void) printf("\n");
1458 * Given a numeric suffix, convert the value into a number of bits that the
1459 * resulting value must be shifted.
1462 str2shift(libzfs_handle_t
*hdl
, const char *buf
)
1464 const char *ends
= "BKMGTPEZ";
1469 for (i
= 0; i
< strlen(ends
); i
++) {
1470 if (toupper(buf
[0]) == ends
[i
])
1473 if (i
== strlen(ends
)) {
1475 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1476 "invalid numeric suffix '%s'"), buf
);
1481 * Allow 'G' = 'GB' = 'GiB', case-insensitively.
1482 * However, 'BB' and 'BiB' are disallowed.
1484 if (buf
[1] == '\0' ||
1485 (toupper(buf
[0]) != 'B' &&
1486 ((toupper(buf
[1]) == 'B' && buf
[2] == '\0') ||
1487 (toupper(buf
[1]) == 'I' && toupper(buf
[2]) == 'B' &&
1492 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1493 "invalid numeric suffix '%s'"), buf
);
1498 * Convert a string of the form '100G' into a real number. Used when setting
1499 * properties or creating a volume. 'buf' is used to place an extended error
1500 * message for the caller to use.
1503 zfs_nicestrtonum(libzfs_handle_t
*hdl
, const char *value
, uint64_t *num
)
1510 /* Check to see if this looks like a number. */
1511 if ((value
[0] < '0' || value
[0] > '9') && value
[0] != '.') {
1513 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1514 "bad numeric value '%s'"), value
);
1518 /* Rely on strtoull() to process the numeric portion. */
1520 *num
= strtoull(value
, &end
, 10);
1523 * Check for ERANGE, which indicates that the value is too large to fit
1524 * in a 64-bit value.
1526 if (errno
== ERANGE
) {
1528 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1529 "numeric value is too large"));
1534 * If we have a decimal value, then do the computation with floating
1535 * point arithmetic. Otherwise, use standard arithmetic.
1538 double fval
= strtod(value
, &end
);
1540 if ((shift
= str2shift(hdl
, end
)) == -1)
1543 fval
*= pow(2, shift
);
1546 * UINT64_MAX is not exactly representable as a double.
1547 * The closest representation is UINT64_MAX + 1, so we
1548 * use a >= comparison instead of > for the bounds check.
1550 if (fval
>= (double)UINT64_MAX
) {
1552 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1553 "numeric value is too large"));
1557 *num
= (uint64_t)fval
;
1559 if ((shift
= str2shift(hdl
, end
)) == -1)
1562 /* Check for overflow */
1563 if (shift
>= 64 || (*num
<< shift
) >> shift
!= *num
) {
1565 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1566 "numeric value is too large"));
1577 * Given a propname=value nvpair to set, parse any numeric properties
1578 * (index, boolean, etc) if they are specified as strings and add the
1579 * resulting nvpair to the returned nvlist.
1581 * At the DSL layer, all properties are either 64-bit numbers or strings.
1582 * We want the user to be able to ignore this fact and specify properties
1583 * as native values (numbers, for example) or as strings (to simplify
1584 * command line utilities). This also handles converting index types
1585 * (compression, checksum, etc) from strings to their on-disk index.
1588 zprop_parse_value(libzfs_handle_t
*hdl
, nvpair_t
*elem
, int prop
,
1589 zfs_type_t type
, nvlist_t
*ret
, char **svalp
, uint64_t *ivalp
,
1592 data_type_t datatype
= nvpair_type(elem
);
1593 zprop_type_t proptype
;
1594 const char *propname
;
1596 boolean_t isnone
= B_FALSE
;
1597 boolean_t isauto
= B_FALSE
;
1600 if (type
== ZFS_TYPE_POOL
) {
1601 proptype
= zpool_prop_get_type(prop
);
1602 propname
= zpool_prop_to_name(prop
);
1603 } else if (type
== ZFS_TYPE_VDEV
) {
1604 proptype
= vdev_prop_get_type(prop
);
1605 propname
= vdev_prop_to_name(prop
);
1607 proptype
= zfs_prop_get_type(prop
);
1608 propname
= zfs_prop_to_name(prop
);
1612 * Convert any properties to the internal DSL value types.
1618 case PROP_TYPE_STRING
:
1619 if (datatype
!= DATA_TYPE_STRING
) {
1620 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1621 "'%s' must be a string"), nvpair_name(elem
));
1624 err
= nvpair_value_string(elem
, svalp
);
1626 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1627 "'%s' is invalid"), nvpair_name(elem
));
1630 if (strlen(*svalp
) >= ZFS_MAXPROPLEN
) {
1631 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1632 "'%s' is too long"), nvpair_name(elem
));
1637 case PROP_TYPE_NUMBER
:
1638 if (datatype
== DATA_TYPE_STRING
) {
1639 (void) nvpair_value_string(elem
, &value
);
1640 if (strcmp(value
, "none") == 0) {
1642 } else if (strcmp(value
, "auto") == 0) {
1644 } else if (zfs_nicestrtonum(hdl
, value
, ivalp
) != 0) {
1647 } else if (datatype
== DATA_TYPE_UINT64
) {
1648 (void) nvpair_value_uint64(elem
, ivalp
);
1650 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1651 "'%s' must be a number"), nvpair_name(elem
));
1656 * Quota special: force 'none' and don't allow 0.
1658 if ((type
& ZFS_TYPE_DATASET
) && *ivalp
== 0 && !isnone
&&
1659 (prop
== ZFS_PROP_QUOTA
|| prop
== ZFS_PROP_REFQUOTA
)) {
1660 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1661 "use 'none' to disable quota/refquota"));
1666 * Special handling for "*_limit=none". In this case it's not
1669 if ((type
& ZFS_TYPE_DATASET
) && isnone
&&
1670 (prop
== ZFS_PROP_FILESYSTEM_LIMIT
||
1671 prop
== ZFS_PROP_SNAPSHOT_LIMIT
)) {
1672 *ivalp
= UINT64_MAX
;
1676 * Special handling for setting 'refreservation' to 'auto'. Use
1677 * UINT64_MAX to tell the caller to use zfs_fix_auto_resv().
1678 * 'auto' is only allowed on volumes.
1682 case ZFS_PROP_REFRESERVATION
:
1683 if ((type
& ZFS_TYPE_VOLUME
) == 0) {
1684 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1685 "'%s=auto' only allowed on "
1686 "volumes"), nvpair_name(elem
));
1689 *ivalp
= UINT64_MAX
;
1692 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1693 "'auto' is invalid value for '%s'"),
1701 case PROP_TYPE_INDEX
:
1702 if (datatype
!= DATA_TYPE_STRING
) {
1703 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1704 "'%s' must be a string"), nvpair_name(elem
));
1708 (void) nvpair_value_string(elem
, &value
);
1710 if (zprop_string_to_index(prop
, value
, ivalp
, type
) != 0) {
1711 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1712 "'%s' must be one of '%s'"), propname
,
1713 zprop_values(prop
, type
));
1723 * Add the result to our return set of properties.
1725 if (*svalp
!= NULL
) {
1726 if (nvlist_add_string(ret
, propname
, *svalp
) != 0) {
1727 (void) no_memory(hdl
);
1731 if (nvlist_add_uint64(ret
, propname
, *ivalp
) != 0) {
1732 (void) no_memory(hdl
);
1739 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1744 addlist(libzfs_handle_t
*hdl
, const char *propname
, zprop_list_t
**listp
,
1747 int prop
= zprop_name_to_prop(propname
, type
);
1748 if (prop
!= ZPROP_INVAL
&& !zprop_valid_for_type(prop
, type
, B_FALSE
))
1752 * Return failure if no property table entry was found and this isn't
1753 * a user-defined property.
1755 if (prop
== ZPROP_USERPROP
&& ((type
== ZFS_TYPE_POOL
&&
1756 !zpool_prop_feature(propname
) &&
1757 !zpool_prop_unsupported(propname
)) ||
1758 ((type
== ZFS_TYPE_DATASET
) && !zfs_prop_user(propname
) &&
1759 !zfs_prop_userquota(propname
) && !zfs_prop_written(propname
)) ||
1760 ((type
== ZFS_TYPE_VDEV
) && !vdev_prop_user(propname
)))) {
1761 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1762 "invalid property '%s'"), propname
);
1763 return (zfs_error(hdl
, EZFS_BADPROP
,
1764 dgettext(TEXT_DOMAIN
, "bad property list")));
1767 zprop_list_t
*entry
= zfs_alloc(hdl
, sizeof (*entry
));
1769 entry
->pl_prop
= prop
;
1770 if (prop
== ZPROP_USERPROP
) {
1771 entry
->pl_user_prop
= zfs_strdup(hdl
, propname
);
1772 entry
->pl_width
= strlen(propname
);
1774 entry
->pl_width
= zprop_width(prop
, &entry
->pl_fixed
,
1784 * Given a comma-separated list of properties, construct a property list
1785 * containing both user-defined and native properties. This function will
1786 * return a NULL list if 'all' is specified, which can later be expanded
1787 * by zprop_expand_list().
1790 zprop_get_list(libzfs_handle_t
*hdl
, char *props
, zprop_list_t
**listp
,
1796 * If 'all' is specified, return a NULL list.
1798 if (strcmp(props
, "all") == 0)
1802 * If no props were specified, return an error.
1804 if (props
[0] == '\0') {
1805 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1806 "no properties specified"));
1807 return (zfs_error(hdl
, EZFS_BADPROP
, dgettext(TEXT_DOMAIN
,
1808 "bad property list")));
1811 for (char *p
; (p
= strsep(&props
, ",")); )
1812 if (strcmp(p
, "space") == 0) {
1813 static const char *const spaceprops
[] = {
1814 "name", "avail", "used", "usedbysnapshots",
1815 "usedbydataset", "usedbyrefreservation",
1819 for (int i
= 0; i
< ARRAY_SIZE(spaceprops
); i
++) {
1820 if (addlist(hdl
, spaceprops
[i
], listp
, type
))
1822 listp
= &(*listp
)->pl_next
;
1825 if (addlist(hdl
, p
, listp
, type
))
1827 listp
= &(*listp
)->pl_next
;
1834 zprop_free_list(zprop_list_t
*pl
)
1838 while (pl
!= NULL
) {
1840 free(pl
->pl_user_prop
);
1846 typedef struct expand_data
{
1847 zprop_list_t
**last
;
1848 libzfs_handle_t
*hdl
;
1853 zprop_expand_list_cb(int prop
, void *cb
)
1855 zprop_list_t
*entry
;
1856 expand_data_t
*edp
= cb
;
1858 entry
= zfs_alloc(edp
->hdl
, sizeof (zprop_list_t
));
1860 entry
->pl_prop
= prop
;
1861 entry
->pl_width
= zprop_width(prop
, &entry
->pl_fixed
, edp
->type
);
1862 entry
->pl_all
= B_TRUE
;
1864 *(edp
->last
) = entry
;
1865 edp
->last
= &entry
->pl_next
;
1867 return (ZPROP_CONT
);
1871 zprop_expand_list(libzfs_handle_t
*hdl
, zprop_list_t
**plp
, zfs_type_t type
)
1873 zprop_list_t
*entry
;
1874 zprop_list_t
**last
;
1879 * If this is the very first time we've been called for an 'all'
1880 * specification, expand the list to include all native
1889 if (zprop_iter_common(zprop_expand_list_cb
, &exp
, B_FALSE
,
1890 B_FALSE
, type
) == ZPROP_INVAL
)
1894 * Add 'name' to the beginning of the list, which is handled
1897 entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
));
1898 entry
->pl_prop
= ((type
== ZFS_TYPE_POOL
) ? ZPOOL_PROP_NAME
:
1899 ((type
== ZFS_TYPE_VDEV
) ? VDEV_PROP_NAME
: ZFS_PROP_NAME
));
1900 entry
->pl_width
= zprop_width(entry
->pl_prop
,
1901 &entry
->pl_fixed
, type
);
1902 entry
->pl_all
= B_TRUE
;
1903 entry
->pl_next
= *plp
;
1910 zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
, boolean_t ordered
,
1913 return (zprop_iter_common(func
, cb
, show_all
, ordered
, type
));
1917 zfs_version_userland(void)
1919 return (ZFS_META_ALIAS
);
1923 * Prints both zfs userland and kernel versions
1924 * Returns 0 on success, and -1 on error
1927 zfs_version_print(void)
1929 (void) puts(ZFS_META_ALIAS
);
1931 char *kver
= zfs_version_kernel();
1933 fprintf(stderr
, "zfs_version_kernel() failed: %s\n",
1938 (void) printf("zfs-kmod-%s\n", kver
);
1944 * Return 1 if the user requested ANSI color output, and our terminal supports
1945 * it. Return 0 for no color.
1950 static int use_color
= -1;
1956 * For each zpool invocation, we do a single check to see if we should
1957 * be using color or not, and cache that value for the lifetime of the
1958 * the zpool command. That makes it cheap to call use_color() when
1959 * we're printing with color. We assume that the settings are not going
1960 * to change during the invocation of a zpool command (the user isn't
1961 * going to change the ZFS_COLOR value while zpool is running, for
1964 if (use_color
!= -1) {
1966 * We've already figured out if we should be using color or
1967 * not. Return the cached value.
1972 term
= getenv("TERM");
1974 * The user sets the ZFS_COLOR env var set to enable zpool ANSI color
1975 * output. However if NO_COLOR is set (https://no-color.org/) then
1976 * don't use it. Also, don't use color if terminal doesn't support
1979 if (libzfs_envvar_is_set("ZFS_COLOR") &&
1980 !libzfs_envvar_is_set("NO_COLOR") &&
1981 isatty(STDOUT_FILENO
) && term
&& strcmp("dumb", term
) != 0 &&
1982 strcmp("unknown", term
) != 0) {
1983 /* Color supported */
1993 * color_start() and color_end() are used for when you want to colorize a block
1994 * of text. For example:
1996 * color_start(ANSI_RED_FG)
2002 color_start(const char *color
)
2005 fputs(color
, stdout
);
2012 fputs(ANSI_RESET
, stdout
);
2015 /* printf() with a color. If color is NULL, then do a normal printf. */
2017 printf_color(const char *color
, const char *format
, ...)
2025 va_start(aptr
, format
);
2026 rc
= vprintf(format
, aptr
);