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
, "insufficient replicas"));
176 return (dgettext(TEXT_DOMAIN
, "device is reserved as a hot "
178 case EZFS_INVALCONFIG
:
179 return (dgettext(TEXT_DOMAIN
, "invalid vdev configuration"));
181 return (dgettext(TEXT_DOMAIN
, "recursive dataset dependency"));
183 return (dgettext(TEXT_DOMAIN
, "no history available"));
185 return (dgettext(TEXT_DOMAIN
, "failed to retrieve "
187 case EZFS_POOL_NOTSUP
:
188 return (dgettext(TEXT_DOMAIN
, "operation not supported "
189 "on this type of pool"));
190 case EZFS_POOL_INVALARG
:
191 return (dgettext(TEXT_DOMAIN
, "invalid argument for "
192 "this pool operation"));
193 case EZFS_NAMETOOLONG
:
194 return (dgettext(TEXT_DOMAIN
, "dataset name is too long"));
195 case EZFS_OPENFAILED
:
196 return (dgettext(TEXT_DOMAIN
, "open failed"));
198 return (dgettext(TEXT_DOMAIN
,
199 "disk capacity information could not be retrieved"));
200 case EZFS_LABELFAILED
:
201 return (dgettext(TEXT_DOMAIN
, "write of label failed"));
203 return (dgettext(TEXT_DOMAIN
, "invalid user/group"));
205 return (dgettext(TEXT_DOMAIN
, "invalid permission"));
206 case EZFS_BADPERMSET
:
207 return (dgettext(TEXT_DOMAIN
, "invalid permission set name"));
208 case EZFS_NODELEGATION
:
209 return (dgettext(TEXT_DOMAIN
, "delegated administration is "
210 "disabled on pool"));
212 return (dgettext(TEXT_DOMAIN
, "invalid or missing cache file"));
214 return (dgettext(TEXT_DOMAIN
, "device is in use as a cache"));
215 case EZFS_VDEVNOTSUP
:
216 return (dgettext(TEXT_DOMAIN
, "vdev specification is not "
219 return (dgettext(TEXT_DOMAIN
, "operation not supported "
221 case EZFS_IOC_NOTSUPPORTED
:
222 return (dgettext(TEXT_DOMAIN
, "operation not supported by "
223 "zfs kernel module"));
224 case EZFS_ACTIVE_SPARE
:
225 return (dgettext(TEXT_DOMAIN
, "pool has active shared spare "
227 case EZFS_UNPLAYED_LOGS
:
228 return (dgettext(TEXT_DOMAIN
, "log device has unplayed intent "
230 case EZFS_REFTAG_RELE
:
231 return (dgettext(TEXT_DOMAIN
, "no such tag on this dataset"));
232 case EZFS_REFTAG_HOLD
:
233 return (dgettext(TEXT_DOMAIN
, "tag already exists on this "
235 case EZFS_TAGTOOLONG
:
236 return (dgettext(TEXT_DOMAIN
, "tag too long"));
237 case EZFS_PIPEFAILED
:
238 return (dgettext(TEXT_DOMAIN
, "pipe create failed"));
239 case EZFS_THREADCREATEFAILED
:
240 return (dgettext(TEXT_DOMAIN
, "thread create failed"));
241 case EZFS_POSTSPLIT_ONLINE
:
242 return (dgettext(TEXT_DOMAIN
, "disk was split from this pool "
244 case EZFS_SCRUB_PAUSED
:
245 return (dgettext(TEXT_DOMAIN
, "scrub is paused; "
246 "use 'zpool scrub' to resume"));
248 return (dgettext(TEXT_DOMAIN
, "currently scrubbing; "
249 "use 'zpool scrub -s' to cancel current scrub"));
251 return (dgettext(TEXT_DOMAIN
, "there is no active scrub"));
253 return (dgettext(TEXT_DOMAIN
, "unable to generate diffs"));
255 return (dgettext(TEXT_DOMAIN
, "invalid diff data"));
256 case EZFS_POOLREADONLY
:
257 return (dgettext(TEXT_DOMAIN
, "pool is read-only"));
258 case EZFS_NO_PENDING
:
259 return (dgettext(TEXT_DOMAIN
, "operation is not "
261 case EZFS_CHECKPOINT_EXISTS
:
262 return (dgettext(TEXT_DOMAIN
, "checkpoint exists"));
263 case EZFS_DISCARDING_CHECKPOINT
:
264 return (dgettext(TEXT_DOMAIN
, "currently discarding "
266 case EZFS_NO_CHECKPOINT
:
267 return (dgettext(TEXT_DOMAIN
, "checkpoint does not exist"));
268 case EZFS_DEVRM_IN_PROGRESS
:
269 return (dgettext(TEXT_DOMAIN
, "device removal in progress"));
270 case EZFS_VDEV_TOO_BIG
:
271 return (dgettext(TEXT_DOMAIN
, "device exceeds supported size"));
272 case EZFS_ACTIVE_POOL
:
273 return (dgettext(TEXT_DOMAIN
, "pool is imported on a "
275 case EZFS_CRYPTOFAILED
:
276 return (dgettext(TEXT_DOMAIN
, "encryption failure"));
278 return (dgettext(TEXT_DOMAIN
, "argument list too long"));
279 case EZFS_INITIALIZING
:
280 return (dgettext(TEXT_DOMAIN
, "currently initializing"));
281 case EZFS_NO_INITIALIZE
:
282 return (dgettext(TEXT_DOMAIN
, "there is no active "
284 case EZFS_WRONG_PARENT
:
285 return (dgettext(TEXT_DOMAIN
, "invalid parent dataset"));
287 return (dgettext(TEXT_DOMAIN
, "currently trimming"));
289 return (dgettext(TEXT_DOMAIN
, "there is no active trim"));
290 case EZFS_TRIM_NOTSUP
:
291 return (dgettext(TEXT_DOMAIN
, "trim operations are not "
292 "supported by this device"));
293 case EZFS_NO_RESILVER_DEFER
:
294 return (dgettext(TEXT_DOMAIN
, "this action requires the "
295 "resilver_defer feature"));
296 case EZFS_EXPORT_IN_PROGRESS
:
297 return (dgettext(TEXT_DOMAIN
, "pool export in progress"));
298 case EZFS_REBUILDING
:
299 return (dgettext(TEXT_DOMAIN
, "currently sequentially "
301 case EZFS_VDEV_NOTSUP
:
302 return (dgettext(TEXT_DOMAIN
, "operation not supported "
303 "on this type of vdev"));
304 case EZFS_NOT_USER_NAMESPACE
:
305 return (dgettext(TEXT_DOMAIN
, "the provided file "
306 "was not a user namespace file"));
308 return (dgettext(TEXT_DOMAIN
, "unknown error"));
310 assert(hdl
->libzfs_error
== 0);
311 return (dgettext(TEXT_DOMAIN
, "no error"));
316 zfs_error_aux(libzfs_handle_t
*hdl
, const char *fmt
, ...)
322 (void) vsnprintf(hdl
->libzfs_desc
, sizeof (hdl
->libzfs_desc
),
324 hdl
->libzfs_desc_active
= 1;
330 zfs_verror(libzfs_handle_t
*hdl
, int error
, const char *fmt
, va_list ap
)
332 (void) vsnprintf(hdl
->libzfs_action
, sizeof (hdl
->libzfs_action
),
334 hdl
->libzfs_error
= error
;
336 if (hdl
->libzfs_desc_active
)
337 hdl
->libzfs_desc_active
= 0;
339 hdl
->libzfs_desc
[0] = '\0';
341 if (hdl
->libzfs_printerr
) {
342 if (error
== EZFS_UNKNOWN
) {
343 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
, "internal "
344 "error: %s: %s\n"), hdl
->libzfs_action
,
345 libzfs_error_description(hdl
));
349 (void) fprintf(stderr
, "%s: %s\n", hdl
->libzfs_action
,
350 libzfs_error_description(hdl
));
351 if (error
== EZFS_NOMEM
)
357 zfs_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
359 return (zfs_error_fmt(hdl
, error
, "%s", msg
));
363 zfs_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
369 zfs_verror(hdl
, error
, fmt
, ap
);
377 zfs_common_error(libzfs_handle_t
*hdl
, int error
, const char *fmt
,
383 zfs_verror(hdl
, EZFS_PERM
, fmt
, ap
);
387 zfs_verror(hdl
, EZFS_NODELEGATION
, fmt
, ap
);
391 zfs_verror(hdl
, EZFS_IO
, fmt
, ap
);
395 zfs_verror(hdl
, EZFS_FAULT
, fmt
, ap
);
399 zfs_verror(hdl
, EZFS_INTR
, fmt
, ap
);
403 zfs_verror(hdl
, EZFS_CKSUM
, fmt
, ap
);
411 zfs_standard_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
413 return (zfs_standard_error_fmt(hdl
, error
, "%s", msg
));
417 zfs_standard_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
423 if (zfs_common_error(hdl
, error
, fmt
, ap
) != 0) {
432 zfs_verror(hdl
, EZFS_IO
, fmt
, ap
);
436 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
437 "dataset does not exist"));
438 zfs_verror(hdl
, EZFS_NOENT
, fmt
, ap
);
443 zfs_verror(hdl
, EZFS_NOSPC
, fmt
, ap
);
447 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
448 "dataset already exists"));
449 zfs_verror(hdl
, EZFS_EXISTS
, fmt
, ap
);
453 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
455 zfs_verror(hdl
, EZFS_BUSY
, fmt
, ap
);
458 zfs_verror(hdl
, EZFS_POOLREADONLY
, fmt
, ap
);
461 zfs_verror(hdl
, EZFS_NAMETOOLONG
, fmt
, ap
);
464 zfs_verror(hdl
, EZFS_BADVERSION
, fmt
, ap
);
467 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
468 "pool I/O is currently suspended"));
469 zfs_verror(hdl
, EZFS_POOLUNAVAIL
, fmt
, ap
);
472 zfs_verror(hdl
, EZFS_ACTIVE_POOL
, fmt
, ap
);
474 case ZFS_ERR_UNKNOWN_SEND_STREAM_FEATURE
:
475 case ZFS_ERR_IOC_CMD_UNAVAIL
:
476 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "the loaded zfs "
477 "module does not support this operation. A reboot may "
478 "be required to enable this operation."));
479 zfs_verror(hdl
, EZFS_IOC_NOTSUPPORTED
, fmt
, ap
);
481 case ZFS_ERR_IOC_ARG_UNAVAIL
:
482 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "the loaded zfs "
483 "module does not support an option for this operation. "
484 "A reboot may be required to enable this option."));
485 zfs_verror(hdl
, EZFS_IOC_NOTSUPPORTED
, fmt
, ap
);
487 case ZFS_ERR_IOC_ARG_REQUIRED
:
488 case ZFS_ERR_IOC_ARG_BADTYPE
:
489 zfs_verror(hdl
, EZFS_IOC_NOTSUPPORTED
, fmt
, ap
);
491 case ZFS_ERR_WRONG_PARENT
:
492 zfs_verror(hdl
, EZFS_WRONG_PARENT
, fmt
, ap
);
494 case ZFS_ERR_BADPROP
:
495 zfs_verror(hdl
, EZFS_BADPROP
, fmt
, ap
);
497 case ZFS_ERR_NOT_USER_NAMESPACE
:
498 zfs_verror(hdl
, EZFS_NOT_USER_NAMESPACE
, fmt
, ap
);
501 zfs_error_aux(hdl
, "%s", strerror(error
));
502 zfs_verror(hdl
, EZFS_UNKNOWN
, fmt
, ap
);
511 zfs_setprop_error(libzfs_handle_t
*hdl
, zfs_prop_t prop
, int err
,
518 * For quotas and reservations, ENOSPC indicates
519 * something different; setting a quota or reservation
520 * doesn't use any disk space.
524 case ZFS_PROP_REFQUOTA
:
525 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
526 "size is less than current used or "
528 (void) zfs_error(hdl
, EZFS_PROPSPACE
, errbuf
);
531 case ZFS_PROP_RESERVATION
:
532 case ZFS_PROP_REFRESERVATION
:
533 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
534 "size is greater than available space"));
535 (void) zfs_error(hdl
, EZFS_PROPSPACE
, errbuf
);
539 (void) zfs_standard_error(hdl
, err
, errbuf
);
545 (void) zfs_standard_error(hdl
, EBUSY
, errbuf
);
549 (void) zfs_error(hdl
, EZFS_DSREADONLY
, errbuf
);
553 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
554 "property value too long"));
555 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
559 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
560 "pool and or dataset must be upgraded to set this "
561 "property or value"));
562 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
566 if (prop
== ZFS_PROP_COMPRESSION
||
567 prop
== ZFS_PROP_DNODESIZE
||
568 prop
== ZFS_PROP_RECORDSIZE
) {
569 (void) zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
570 "property setting is not allowed on "
571 "bootable datasets"));
572 (void) zfs_error(hdl
, EZFS_NOTSUP
, errbuf
);
573 } else if (prop
== ZFS_PROP_CHECKSUM
||
574 prop
== ZFS_PROP_DEDUP
) {
575 (void) zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
576 "property setting is not allowed on "
578 (void) zfs_error(hdl
, EZFS_NOTSUP
, errbuf
);
580 (void) zfs_standard_error(hdl
, err
, errbuf
);
585 if (prop
== ZPROP_INVAL
) {
586 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
588 (void) zfs_standard_error(hdl
, err
, errbuf
);
592 case ZFS_ERR_BADPROP
:
593 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
597 if (prop
== ZFS_PROP_KEYLOCATION
) {
598 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
599 "keylocation may only be set on encryption roots"));
600 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
602 (void) zfs_standard_error(hdl
, err
, errbuf
);
608 * This platform can't address a volume this big.
611 if (prop
== ZFS_PROP_VOLSIZE
) {
612 (void) zfs_error(hdl
, EZFS_VOLTOOBIG
, errbuf
);
618 (void) zfs_standard_error(hdl
, err
, errbuf
);
623 zpool_standard_error(libzfs_handle_t
*hdl
, int error
, const char *msg
)
625 return (zpool_standard_error_fmt(hdl
, error
, "%s", msg
));
629 zpool_standard_error_fmt(libzfs_handle_t
*hdl
, int error
, const char *fmt
, ...)
635 if (zfs_common_error(hdl
, error
, fmt
, ap
) != 0) {
642 zfs_verror(hdl
, EZFS_NODEVICE
, fmt
, ap
);
647 dgettext(TEXT_DOMAIN
, "no such pool or dataset"));
648 zfs_verror(hdl
, EZFS_NOENT
, fmt
, ap
);
652 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
653 "pool already exists"));
654 zfs_verror(hdl
, EZFS_EXISTS
, fmt
, ap
);
658 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "pool is busy"));
659 zfs_verror(hdl
, EZFS_BUSY
, fmt
, ap
);
662 /* There is no pending operation to cancel */
664 zfs_verror(hdl
, EZFS_NO_PENDING
, fmt
, ap
);
668 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
669 "one or more devices is currently unavailable"));
670 zfs_verror(hdl
, EZFS_BADDEV
, fmt
, ap
);
674 zfs_verror(hdl
, EZFS_DEVOVERFLOW
, fmt
, ap
);
678 zfs_verror(hdl
, EZFS_POOL_NOTSUP
, fmt
, ap
);
682 zfs_verror(hdl
, EZFS_POOL_INVALARG
, fmt
, ap
);
687 zfs_verror(hdl
, EZFS_NOSPC
, fmt
, ap
);
691 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
692 "pool I/O is currently suspended"));
693 zfs_verror(hdl
, EZFS_POOLUNAVAIL
, fmt
, ap
);
697 zfs_verror(hdl
, EZFS_POOLREADONLY
, fmt
, ap
);
700 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
701 "block size out of range or does not match"));
702 zfs_verror(hdl
, EZFS_BADPROP
, fmt
, ap
);
705 zfs_verror(hdl
, EZFS_ACTIVE_POOL
, fmt
, ap
);
707 case ZFS_ERR_CHECKPOINT_EXISTS
:
708 zfs_verror(hdl
, EZFS_CHECKPOINT_EXISTS
, fmt
, ap
);
710 case ZFS_ERR_DISCARDING_CHECKPOINT
:
711 zfs_verror(hdl
, EZFS_DISCARDING_CHECKPOINT
, fmt
, ap
);
713 case ZFS_ERR_NO_CHECKPOINT
:
714 zfs_verror(hdl
, EZFS_NO_CHECKPOINT
, fmt
, ap
);
716 case ZFS_ERR_DEVRM_IN_PROGRESS
:
717 zfs_verror(hdl
, EZFS_DEVRM_IN_PROGRESS
, fmt
, ap
);
719 case ZFS_ERR_VDEV_TOO_BIG
:
720 zfs_verror(hdl
, EZFS_VDEV_TOO_BIG
, fmt
, ap
);
722 case ZFS_ERR_EXPORT_IN_PROGRESS
:
723 zfs_verror(hdl
, EZFS_EXPORT_IN_PROGRESS
, fmt
, ap
);
725 case ZFS_ERR_RESILVER_IN_PROGRESS
:
726 zfs_verror(hdl
, EZFS_RESILVERING
, fmt
, ap
);
728 case ZFS_ERR_REBUILD_IN_PROGRESS
:
729 zfs_verror(hdl
, EZFS_REBUILDING
, fmt
, ap
);
731 case ZFS_ERR_BADPROP
:
732 zfs_verror(hdl
, EZFS_BADPROP
, fmt
, ap
);
734 case ZFS_ERR_VDEV_NOTSUP
:
735 zfs_verror(hdl
, EZFS_VDEV_NOTSUP
, fmt
, ap
);
737 case ZFS_ERR_IOC_CMD_UNAVAIL
:
738 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "the loaded zfs "
739 "module does not support this operation. A reboot may "
740 "be required to enable this operation."));
741 zfs_verror(hdl
, EZFS_IOC_NOTSUPPORTED
, fmt
, ap
);
743 case ZFS_ERR_IOC_ARG_UNAVAIL
:
744 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "the loaded zfs "
745 "module does not support an option for this operation. "
746 "A reboot may be required to enable this option."));
747 zfs_verror(hdl
, EZFS_IOC_NOTSUPPORTED
, fmt
, ap
);
749 case ZFS_ERR_IOC_ARG_REQUIRED
:
750 case ZFS_ERR_IOC_ARG_BADTYPE
:
751 zfs_verror(hdl
, EZFS_IOC_NOTSUPPORTED
, fmt
, ap
);
754 zfs_error_aux(hdl
, "%s", strerror(error
));
755 zfs_verror(hdl
, EZFS_UNKNOWN
, fmt
, ap
);
763 * Display an out of memory error message and abort the current program.
766 no_memory(libzfs_handle_t
*hdl
)
768 return (zfs_error(hdl
, EZFS_NOMEM
, "internal error"));
772 * A safe form of malloc() which will die if the allocation fails.
775 zfs_alloc(libzfs_handle_t
*hdl
, size_t size
)
779 if ((data
= calloc(1, size
)) == NULL
)
780 (void) no_memory(hdl
);
786 * A safe form of asprintf() which will die if the allocation fails.
789 zfs_asprintf(libzfs_handle_t
*hdl
, const char *fmt
, ...)
797 err
= vasprintf(&ret
, fmt
, ap
);
802 (void) no_memory(hdl
);
810 * A safe form of realloc(), which also zeroes newly allocated space.
813 zfs_realloc(libzfs_handle_t
*hdl
, void *ptr
, size_t oldsize
, size_t newsize
)
817 if ((ret
= realloc(ptr
, newsize
)) == NULL
) {
818 (void) no_memory(hdl
);
822 memset((char *)ret
+ oldsize
, 0, newsize
- oldsize
);
827 * A safe form of strdup() which will die if the allocation fails.
830 zfs_strdup(libzfs_handle_t
*hdl
, const char *str
)
834 if ((ret
= strdup(str
)) == NULL
)
835 (void) no_memory(hdl
);
841 libzfs_print_on_error(libzfs_handle_t
*hdl
, boolean_t printerr
)
843 hdl
->libzfs_printerr
= printerr
;
847 * Read lines from an open file descriptor and store them in an array of
848 * strings until EOF. lines[] will be allocated and populated with all the
849 * lines read. All newlines are replaced with NULL terminators for
850 * convenience. lines[] must be freed after use with libzfs_free_str_array().
852 * Returns the number of lines read.
855 libzfs_read_stdout_from_fd(int fd
, char **lines
[])
862 char **tmp_lines
= NULL
, **tmp
;
864 fp
= fdopen(fd
, "r");
869 while (getline(&line
, &len
, fp
) != -1) {
870 tmp
= realloc(tmp_lines
, sizeof (*tmp_lines
) * (lines_cnt
+ 1));
872 /* Return the lines we were able to process */
877 /* Remove newline if not EOF */
878 if (line
[strlen(line
) - 1] == '\n')
879 line
[strlen(line
) - 1] = '\0';
881 tmp_lines
[lines_cnt
] = strdup(line
);
882 if (tmp_lines
[lines_cnt
] == NULL
)
893 libzfs_run_process_impl(const char *path
, char *argv
[], char *env
[], int flags
,
894 char **lines
[], int *lines_cnt
)
897 int error
, devnull_fd
;
901 * Setup a pipe between our child and parent process if we're
904 if (lines
!= NULL
&& pipe2(link
, O_NONBLOCK
| O_CLOEXEC
) == -1)
910 devnull_fd
= open("/dev/null", O_WRONLY
| O_CLOEXEC
);
915 if (!(flags
& STDOUT_VERBOSE
) && (lines
== NULL
))
916 (void) dup2(devnull_fd
, STDOUT_FILENO
);
917 else if (lines
!= NULL
) {
918 /* Save the output to lines[] */
919 dup2(link
[1], STDOUT_FILENO
);
922 if (!(flags
& STDERR_VERBOSE
))
923 (void) dup2(devnull_fd
, STDERR_FILENO
);
925 if (flags
& NO_DEFAULT_PATH
) {
929 execve(path
, argv
, env
);
934 execvpe(path
, argv
, env
);
938 } else if (pid
> 0) {
942 while ((error
= waitpid(pid
, &status
, 0)) == -1 &&
945 if (error
< 0 || !WIFEXITED(status
))
950 *lines_cnt
= libzfs_read_stdout_from_fd(link
[0], lines
);
952 return (WEXITSTATUS(status
));
959 libzfs_run_process(const char *path
, char *argv
[], int flags
)
961 return (libzfs_run_process_impl(path
, argv
, NULL
, flags
, NULL
, NULL
));
965 * Run a command and store its stdout lines in an array of strings (lines[]).
966 * lines[] is allocated and populated for you, and the number of lines is set in
967 * lines_cnt. lines[] must be freed after use with libzfs_free_str_array().
968 * All newlines (\n) in lines[] are terminated for convenience.
971 libzfs_run_process_get_stdout(const char *path
, char *argv
[], char *env
[],
972 char **lines
[], int *lines_cnt
)
974 return (libzfs_run_process_impl(path
, argv
, env
, 0, lines
, lines_cnt
));
978 * Same as libzfs_run_process_get_stdout(), but run without $PATH set. This
979 * means that *path needs to be the full path to the executable.
982 libzfs_run_process_get_stdout_nopath(const char *path
, char *argv
[],
983 char *env
[], char **lines
[], int *lines_cnt
)
985 return (libzfs_run_process_impl(path
, argv
, env
, NO_DEFAULT_PATH
,
990 * Free an array of strings. Free both the strings contained in the array and
994 libzfs_free_str_array(char **strs
, int count
)
1003 * Returns 1 if environment variable is set to "YES", "yes", "ON", "on", or
1004 * a non-zero number.
1006 * Returns 0 otherwise.
1009 libzfs_envvar_is_set(const char *envvar
)
1011 char *env
= getenv(envvar
);
1012 return (env
&& (strtoul(env
, NULL
, 0) > 0 ||
1013 (!strncasecmp(env
, "YES", 3) && strnlen(env
, 4) == 3) ||
1014 (!strncasecmp(env
, "ON", 2) && strnlen(env
, 3) == 2)));
1020 libzfs_handle_t
*hdl
;
1024 if ((error
= libzfs_load_module()) != 0) {
1029 if ((hdl
= calloc(1, sizeof (libzfs_handle_t
))) == NULL
) {
1033 if (regcomp(&hdl
->libzfs_urire
, URI_REGEX
, 0) != 0) {
1038 if ((hdl
->libzfs_fd
= open(ZFS_DEV
, O_RDWR
|O_EXCL
|O_CLOEXEC
)) < 0) {
1043 if (libzfs_core_init() != 0) {
1044 (void) close(hdl
->libzfs_fd
);
1051 zpool_feature_init();
1053 libzfs_mnttab_init(hdl
);
1056 if (getenv("ZFS_PROP_DEBUG") != NULL
) {
1057 hdl
->libzfs_prop_debug
= B_TRUE
;
1059 if ((env
= getenv("ZFS_SENDRECV_MAX_NVLIST")) != NULL
) {
1060 if ((error
= zfs_nicestrtonum(hdl
, env
,
1061 &hdl
->libzfs_max_nvlist
))) {
1063 (void) close(hdl
->libzfs_fd
);
1068 hdl
->libzfs_max_nvlist
= (SPA_MAXBLOCKSIZE
* 4);
1072 * For testing, remove some settable properties and features
1074 if (libzfs_envvar_is_set("ZFS_SYSFS_PROP_SUPPORT_TEST")) {
1075 zprop_desc_t
*proptbl
;
1077 proptbl
= zpool_prop_get_table();
1078 proptbl
[ZPOOL_PROP_COMMENT
].pd_zfs_mod_supported
= B_FALSE
;
1080 proptbl
= zfs_prop_get_table();
1081 proptbl
[ZFS_PROP_DNODESIZE
].pd_zfs_mod_supported
= B_FALSE
;
1083 zfeature_info_t
*ftbl
= spa_feature_table
;
1084 ftbl
[SPA_FEATURE_LARGE_BLOCKS
].fi_zfs_mod_supported
= B_FALSE
;
1091 libzfs_fini(libzfs_handle_t
*hdl
)
1093 (void) close(hdl
->libzfs_fd
);
1094 zpool_free_handles(hdl
);
1095 namespace_clear(hdl
);
1096 libzfs_mnttab_fini(hdl
);
1098 regfree(&hdl
->libzfs_urire
);
1100 #if LIBFETCH_DYNAMIC
1101 if (hdl
->libfetch
!= (void *)-1 && hdl
->libfetch
!= NULL
)
1102 (void) dlclose(hdl
->libfetch
);
1103 free(hdl
->libfetch_load_error
);
1109 zpool_get_handle(zpool_handle_t
*zhp
)
1111 return (zhp
->zpool_hdl
);
1115 zfs_get_handle(zfs_handle_t
*zhp
)
1117 return (zhp
->zfs_hdl
);
1121 zfs_get_pool_handle(const zfs_handle_t
*zhp
)
1123 return (zhp
->zpool_hdl
);
1127 * Given a name, determine whether or not it's a valid path
1128 * (starts with '/' or "./"). If so, walk the mnttab trying
1129 * to match the device number. If not, treat the path as an
1130 * fs/vol/snap/bkmark name.
1133 zfs_path_to_zhandle(libzfs_handle_t
*hdl
, const char *path
, zfs_type_t argtype
)
1135 struct stat64 statbuf
;
1136 struct extmnttab entry
;
1138 if (path
[0] != '/' && strncmp(path
, "./", strlen("./")) != 0) {
1140 * It's not a valid path, assume it's a name of type 'argtype'.
1142 return (zfs_open(hdl
, path
, argtype
));
1145 if (getextmntent(path
, &entry
, &statbuf
) != 0)
1148 if (strcmp(entry
.mnt_fstype
, MNTTYPE_ZFS
) != 0) {
1149 (void) fprintf(stderr
, gettext("'%s': not a ZFS filesystem\n"),
1154 return (zfs_open(hdl
, entry
.mnt_special
, ZFS_TYPE_FILESYSTEM
));
1158 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
1162 zcmd_alloc_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, size_t len
)
1166 zc
->zc_nvlist_dst_size
= len
;
1168 (uint64_t)(uintptr_t)zfs_alloc(hdl
, zc
->zc_nvlist_dst_size
);
1172 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
1173 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
1174 * filled in by the kernel to indicate the actual required size.
1177 zcmd_expand_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
)
1179 free((void *)(uintptr_t)zc
->zc_nvlist_dst
);
1181 (uint64_t)(uintptr_t)zfs_alloc(hdl
, zc
->zc_nvlist_dst_size
);
1185 * Called to free the src and dst nvlists stored in the command structure.
1188 zcmd_free_nvlists(zfs_cmd_t
*zc
)
1190 free((void *)(uintptr_t)zc
->zc_nvlist_conf
);
1191 free((void *)(uintptr_t)zc
->zc_nvlist_src
);
1192 free((void *)(uintptr_t)zc
->zc_nvlist_dst
);
1193 zc
->zc_nvlist_conf
= 0;
1194 zc
->zc_nvlist_src
= 0;
1195 zc
->zc_nvlist_dst
= 0;
1199 zcmd_write_nvlist_com(libzfs_handle_t
*hdl
, uint64_t *outnv
, uint64_t *outlen
,
1204 size_t len
= fnvlist_size(nvl
);
1205 packed
= zfs_alloc(hdl
, len
);
1207 verify(nvlist_pack(nvl
, &packed
, &len
, NV_ENCODE_NATIVE
, 0) == 0);
1209 *outnv
= (uint64_t)(uintptr_t)packed
;
1214 zcmd_write_conf_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
*nvl
)
1216 zcmd_write_nvlist_com(hdl
, &zc
->zc_nvlist_conf
,
1217 &zc
->zc_nvlist_conf_size
, nvl
);
1221 zcmd_write_src_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
*nvl
)
1223 zcmd_write_nvlist_com(hdl
, &zc
->zc_nvlist_src
,
1224 &zc
->zc_nvlist_src_size
, nvl
);
1228 * Unpacks an nvlist from the ZFS ioctl command structure.
1231 zcmd_read_dst_nvlist(libzfs_handle_t
*hdl
, zfs_cmd_t
*zc
, nvlist_t
**nvlp
)
1233 if (nvlist_unpack((void *)(uintptr_t)zc
->zc_nvlist_dst
,
1234 zc
->zc_nvlist_dst_size
, nvlp
, 0) != 0)
1235 return (no_memory(hdl
));
1241 * ================================================================
1242 * API shared by zfs and zpool property management
1243 * ================================================================
1247 zprop_print_headers(zprop_get_cbdata_t
*cbp
, zfs_type_t type
)
1249 zprop_list_t
*pl
= cbp
->cb_proplist
;
1254 cbp
->cb_first
= B_FALSE
;
1255 if (cbp
->cb_scripted
)
1259 * Start with the length of the column headers.
1261 cbp
->cb_colwidths
[GET_COL_NAME
] = strlen(dgettext(TEXT_DOMAIN
, "NAME"));
1262 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = strlen(dgettext(TEXT_DOMAIN
,
1264 cbp
->cb_colwidths
[GET_COL_VALUE
] = strlen(dgettext(TEXT_DOMAIN
,
1266 cbp
->cb_colwidths
[GET_COL_RECVD
] = strlen(dgettext(TEXT_DOMAIN
,
1268 cbp
->cb_colwidths
[GET_COL_SOURCE
] = strlen(dgettext(TEXT_DOMAIN
,
1271 /* first property is always NAME */
1272 assert(cbp
->cb_proplist
->pl_prop
==
1273 ((type
== ZFS_TYPE_POOL
) ? ZPOOL_PROP_NAME
:
1274 ((type
== ZFS_TYPE_VDEV
) ? VDEV_PROP_NAME
: ZFS_PROP_NAME
)));
1277 * Go through and calculate the widths for each column. For the
1278 * 'source' column, we kludge it up by taking the worst-case scenario of
1279 * inheriting from the longest name. This is acceptable because in the
1280 * majority of cases 'SOURCE' is the last column displayed, and we don't
1281 * use the width anyway. Note that the 'VALUE' column can be oversized,
1282 * if the name of the property is much longer than any values we find.
1284 for (pl
= cbp
->cb_proplist
; pl
!= NULL
; pl
= pl
->pl_next
) {
1288 if (pl
->pl_prop
!= ZPROP_USERPROP
) {
1289 const char *propname
= (type
== ZFS_TYPE_POOL
) ?
1290 zpool_prop_to_name(pl
->pl_prop
) :
1291 ((type
== ZFS_TYPE_VDEV
) ?
1292 vdev_prop_to_name(pl
->pl_prop
) :
1293 zfs_prop_to_name(pl
->pl_prop
));
1295 assert(propname
!= NULL
);
1296 len
= strlen(propname
);
1297 if (len
> cbp
->cb_colwidths
[GET_COL_PROPERTY
])
1298 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = len
;
1300 assert(pl
->pl_user_prop
!= NULL
);
1301 len
= strlen(pl
->pl_user_prop
);
1302 if (len
> cbp
->cb_colwidths
[GET_COL_PROPERTY
])
1303 cbp
->cb_colwidths
[GET_COL_PROPERTY
] = len
;
1307 * 'VALUE' column. The first property is always the 'name'
1308 * property that was tacked on either by /sbin/zfs's
1309 * zfs_do_get() or when calling zprop_expand_list(), so we
1310 * ignore its width. If the user specified the name property
1311 * to display, then it will be later in the list in any case.
1313 if (pl
!= cbp
->cb_proplist
&&
1314 pl
->pl_width
> cbp
->cb_colwidths
[GET_COL_VALUE
])
1315 cbp
->cb_colwidths
[GET_COL_VALUE
] = pl
->pl_width
;
1317 /* 'RECEIVED' column. */
1318 if (pl
!= cbp
->cb_proplist
&&
1319 pl
->pl_recvd_width
> cbp
->cb_colwidths
[GET_COL_RECVD
])
1320 cbp
->cb_colwidths
[GET_COL_RECVD
] = pl
->pl_recvd_width
;
1323 * 'NAME' and 'SOURCE' columns
1325 if (pl
->pl_prop
== ((type
== ZFS_TYPE_POOL
) ? ZPOOL_PROP_NAME
:
1326 ((type
== ZFS_TYPE_VDEV
) ? VDEV_PROP_NAME
:
1327 ZFS_PROP_NAME
)) && pl
->pl_width
>
1328 cbp
->cb_colwidths
[GET_COL_NAME
]) {
1329 cbp
->cb_colwidths
[GET_COL_NAME
] = pl
->pl_width
;
1330 cbp
->cb_colwidths
[GET_COL_SOURCE
] = pl
->pl_width
+
1331 strlen(dgettext(TEXT_DOMAIN
, "inherited from"));
1336 * Now go through and print the headers.
1338 for (i
= 0; i
< ZFS_GET_NCOLS
; i
++) {
1339 switch (cbp
->cb_columns
[i
]) {
1341 title
= dgettext(TEXT_DOMAIN
, "NAME");
1343 case GET_COL_PROPERTY
:
1344 title
= dgettext(TEXT_DOMAIN
, "PROPERTY");
1347 title
= dgettext(TEXT_DOMAIN
, "VALUE");
1350 title
= dgettext(TEXT_DOMAIN
, "RECEIVED");
1352 case GET_COL_SOURCE
:
1353 title
= dgettext(TEXT_DOMAIN
, "SOURCE");
1359 if (title
!= NULL
) {
1360 if (i
== (ZFS_GET_NCOLS
- 1) ||
1361 cbp
->cb_columns
[i
+ 1] == GET_COL_NONE
)
1362 (void) printf("%s", title
);
1364 (void) printf("%-*s ",
1365 cbp
->cb_colwidths
[cbp
->cb_columns
[i
]],
1369 (void) printf("\n");
1373 * Display a single line of output, according to the settings in the callback
1377 zprop_print_one_property(const char *name
, zprop_get_cbdata_t
*cbp
,
1378 const char *propname
, const char *value
, zprop_source_t sourcetype
,
1379 const char *source
, const char *recvd_value
)
1382 const char *str
= NULL
;
1386 * Ignore those source types that the user has chosen to ignore.
1388 if ((sourcetype
& cbp
->cb_sources
) == 0)
1392 zprop_print_headers(cbp
, cbp
->cb_type
);
1394 for (i
= 0; i
< ZFS_GET_NCOLS
; i
++) {
1395 switch (cbp
->cb_columns
[i
]) {
1400 case GET_COL_PROPERTY
:
1408 case GET_COL_SOURCE
:
1409 switch (sourcetype
) {
1410 case ZPROP_SRC_NONE
:
1414 case ZPROP_SRC_DEFAULT
:
1418 case ZPROP_SRC_LOCAL
:
1422 case ZPROP_SRC_TEMPORARY
:
1426 case ZPROP_SRC_INHERITED
:
1427 (void) snprintf(buf
, sizeof (buf
),
1428 "inherited from %s", source
);
1431 case ZPROP_SRC_RECEIVED
:
1437 assert(!"unhandled zprop_source_t");
1442 str
= (recvd_value
== NULL
? "-" : recvd_value
);
1449 if (i
== (ZFS_GET_NCOLS
- 1) ||
1450 cbp
->cb_columns
[i
+ 1] == GET_COL_NONE
)
1451 (void) printf("%s", str
);
1452 else if (cbp
->cb_scripted
)
1453 (void) printf("%s\t", str
);
1455 (void) printf("%-*s ",
1456 cbp
->cb_colwidths
[cbp
->cb_columns
[i
]],
1460 (void) printf("\n");
1464 * Given a numeric suffix, convert the value into a number of bits that the
1465 * resulting value must be shifted.
1468 str2shift(libzfs_handle_t
*hdl
, const char *buf
)
1470 const char *ends
= "BKMGTPEZ";
1475 for (i
= 0; i
< strlen(ends
); i
++) {
1476 if (toupper(buf
[0]) == ends
[i
])
1479 if (i
== strlen(ends
)) {
1481 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1482 "invalid numeric suffix '%s'"), buf
);
1487 * Allow 'G' = 'GB' = 'GiB', case-insensitively.
1488 * However, 'BB' and 'BiB' are disallowed.
1490 if (buf
[1] == '\0' ||
1491 (toupper(buf
[0]) != 'B' &&
1492 ((toupper(buf
[1]) == 'B' && buf
[2] == '\0') ||
1493 (toupper(buf
[1]) == 'I' && toupper(buf
[2]) == 'B' &&
1498 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1499 "invalid numeric suffix '%s'"), buf
);
1504 * Convert a string of the form '100G' into a real number. Used when setting
1505 * properties or creating a volume. 'buf' is used to place an extended error
1506 * message for the caller to use.
1509 zfs_nicestrtonum(libzfs_handle_t
*hdl
, const char *value
, uint64_t *num
)
1516 /* Check to see if this looks like a number. */
1517 if ((value
[0] < '0' || value
[0] > '9') && value
[0] != '.') {
1519 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1520 "bad numeric value '%s'"), value
);
1524 /* Rely on strtoull() to process the numeric portion. */
1526 *num
= strtoull(value
, &end
, 10);
1529 * Check for ERANGE, which indicates that the value is too large to fit
1530 * in a 64-bit value.
1532 if (errno
== ERANGE
) {
1534 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1535 "numeric value is too large"));
1540 * If we have a decimal value, then do the computation with floating
1541 * point arithmetic. Otherwise, use standard arithmetic.
1544 double fval
= strtod(value
, &end
);
1546 if ((shift
= str2shift(hdl
, end
)) == -1)
1549 fval
*= pow(2, shift
);
1552 * UINT64_MAX is not exactly representable as a double.
1553 * The closest representation is UINT64_MAX + 1, so we
1554 * use a >= comparison instead of > for the bounds check.
1556 if (fval
>= (double)UINT64_MAX
) {
1558 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1559 "numeric value is too large"));
1563 *num
= (uint64_t)fval
;
1565 if ((shift
= str2shift(hdl
, end
)) == -1)
1568 /* Check for overflow */
1569 if (shift
>= 64 || (*num
<< shift
) >> shift
!= *num
) {
1571 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1572 "numeric value is too large"));
1583 * Given a propname=value nvpair to set, parse any numeric properties
1584 * (index, boolean, etc) if they are specified as strings and add the
1585 * resulting nvpair to the returned nvlist.
1587 * At the DSL layer, all properties are either 64-bit numbers or strings.
1588 * We want the user to be able to ignore this fact and specify properties
1589 * as native values (numbers, for example) or as strings (to simplify
1590 * command line utilities). This also handles converting index types
1591 * (compression, checksum, etc) from strings to their on-disk index.
1594 zprop_parse_value(libzfs_handle_t
*hdl
, nvpair_t
*elem
, int prop
,
1595 zfs_type_t type
, nvlist_t
*ret
, char **svalp
, uint64_t *ivalp
,
1598 data_type_t datatype
= nvpair_type(elem
);
1599 zprop_type_t proptype
;
1600 const char *propname
;
1602 boolean_t isnone
= B_FALSE
;
1603 boolean_t isauto
= B_FALSE
;
1606 if (type
== ZFS_TYPE_POOL
) {
1607 proptype
= zpool_prop_get_type(prop
);
1608 propname
= zpool_prop_to_name(prop
);
1609 } else if (type
== ZFS_TYPE_VDEV
) {
1610 proptype
= vdev_prop_get_type(prop
);
1611 propname
= vdev_prop_to_name(prop
);
1613 proptype
= zfs_prop_get_type(prop
);
1614 propname
= zfs_prop_to_name(prop
);
1618 * Convert any properties to the internal DSL value types.
1624 case PROP_TYPE_STRING
:
1625 if (datatype
!= DATA_TYPE_STRING
) {
1626 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1627 "'%s' must be a string"), nvpair_name(elem
));
1630 err
= nvpair_value_string(elem
, svalp
);
1632 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1633 "'%s' is invalid"), nvpair_name(elem
));
1636 if (strlen(*svalp
) >= ZFS_MAXPROPLEN
) {
1637 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1638 "'%s' is too long"), nvpair_name(elem
));
1643 case PROP_TYPE_NUMBER
:
1644 if (datatype
== DATA_TYPE_STRING
) {
1645 (void) nvpair_value_string(elem
, &value
);
1646 if (strcmp(value
, "none") == 0) {
1648 } else if (strcmp(value
, "auto") == 0) {
1650 } else if (zfs_nicestrtonum(hdl
, value
, ivalp
) != 0) {
1653 } else if (datatype
== DATA_TYPE_UINT64
) {
1654 (void) nvpair_value_uint64(elem
, ivalp
);
1656 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1657 "'%s' must be a number"), nvpair_name(elem
));
1662 * Quota special: force 'none' and don't allow 0.
1664 if ((type
& ZFS_TYPE_DATASET
) && *ivalp
== 0 && !isnone
&&
1665 (prop
== ZFS_PROP_QUOTA
|| prop
== ZFS_PROP_REFQUOTA
)) {
1666 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1667 "use 'none' to disable quota/refquota"));
1672 * Special handling for "*_limit=none". In this case it's not
1675 if ((type
& ZFS_TYPE_DATASET
) && isnone
&&
1676 (prop
== ZFS_PROP_FILESYSTEM_LIMIT
||
1677 prop
== ZFS_PROP_SNAPSHOT_LIMIT
)) {
1678 *ivalp
= UINT64_MAX
;
1682 * Special handling for setting 'refreservation' to 'auto'. Use
1683 * UINT64_MAX to tell the caller to use zfs_fix_auto_resv().
1684 * 'auto' is only allowed on volumes.
1688 case ZFS_PROP_REFRESERVATION
:
1689 if ((type
& ZFS_TYPE_VOLUME
) == 0) {
1690 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1691 "'%s=auto' only allowed on "
1692 "volumes"), nvpair_name(elem
));
1695 *ivalp
= UINT64_MAX
;
1698 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1699 "'auto' is invalid value for '%s'"),
1707 case PROP_TYPE_INDEX
:
1708 if (datatype
!= DATA_TYPE_STRING
) {
1709 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1710 "'%s' must be a string"), nvpair_name(elem
));
1714 (void) nvpair_value_string(elem
, &value
);
1716 if (zprop_string_to_index(prop
, value
, ivalp
, type
) != 0) {
1717 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1718 "'%s' must be one of '%s'"), propname
,
1719 zprop_values(prop
, type
));
1729 * Add the result to our return set of properties.
1731 if (*svalp
!= NULL
) {
1732 if (nvlist_add_string(ret
, propname
, *svalp
) != 0) {
1733 (void) no_memory(hdl
);
1737 if (nvlist_add_uint64(ret
, propname
, *ivalp
) != 0) {
1738 (void) no_memory(hdl
);
1745 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1750 addlist(libzfs_handle_t
*hdl
, const char *propname
, zprop_list_t
**listp
,
1753 int prop
= zprop_name_to_prop(propname
, type
);
1754 if (prop
!= ZPROP_INVAL
&& !zprop_valid_for_type(prop
, type
, B_FALSE
))
1758 * Return failure if no property table entry was found and this isn't
1759 * a user-defined property.
1761 if (prop
== ZPROP_USERPROP
&& ((type
== ZFS_TYPE_POOL
&&
1762 !zpool_prop_feature(propname
) &&
1763 !zpool_prop_unsupported(propname
)) ||
1764 ((type
== ZFS_TYPE_DATASET
) && !zfs_prop_user(propname
) &&
1765 !zfs_prop_userquota(propname
) && !zfs_prop_written(propname
)) ||
1766 ((type
== ZFS_TYPE_VDEV
) && !vdev_prop_user(propname
)))) {
1767 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1768 "invalid property '%s'"), propname
);
1769 return (zfs_error(hdl
, EZFS_BADPROP
,
1770 dgettext(TEXT_DOMAIN
, "bad property list")));
1773 zprop_list_t
*entry
= zfs_alloc(hdl
, sizeof (*entry
));
1775 entry
->pl_prop
= prop
;
1776 if (prop
== ZPROP_USERPROP
) {
1777 entry
->pl_user_prop
= zfs_strdup(hdl
, propname
);
1778 entry
->pl_width
= strlen(propname
);
1780 entry
->pl_width
= zprop_width(prop
, &entry
->pl_fixed
,
1790 * Given a comma-separated list of properties, construct a property list
1791 * containing both user-defined and native properties. This function will
1792 * return a NULL list if 'all' is specified, which can later be expanded
1793 * by zprop_expand_list().
1796 zprop_get_list(libzfs_handle_t
*hdl
, char *props
, zprop_list_t
**listp
,
1802 * If 'all' is specified, return a NULL list.
1804 if (strcmp(props
, "all") == 0)
1808 * If no props were specified, return an error.
1810 if (props
[0] == '\0') {
1811 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1812 "no properties specified"));
1813 return (zfs_error(hdl
, EZFS_BADPROP
, dgettext(TEXT_DOMAIN
,
1814 "bad property list")));
1817 for (char *p
; (p
= strsep(&props
, ",")); )
1818 if (strcmp(p
, "space") == 0) {
1819 static const char *const spaceprops
[] = {
1820 "name", "avail", "used", "usedbysnapshots",
1821 "usedbydataset", "usedbyrefreservation",
1825 for (int i
= 0; i
< ARRAY_SIZE(spaceprops
); i
++) {
1826 if (addlist(hdl
, spaceprops
[i
], listp
, type
))
1828 listp
= &(*listp
)->pl_next
;
1831 if (addlist(hdl
, p
, listp
, type
))
1833 listp
= &(*listp
)->pl_next
;
1840 zprop_free_list(zprop_list_t
*pl
)
1844 while (pl
!= NULL
) {
1846 free(pl
->pl_user_prop
);
1852 typedef struct expand_data
{
1853 zprop_list_t
**last
;
1854 libzfs_handle_t
*hdl
;
1859 zprop_expand_list_cb(int prop
, void *cb
)
1861 zprop_list_t
*entry
;
1862 expand_data_t
*edp
= cb
;
1864 entry
= zfs_alloc(edp
->hdl
, sizeof (zprop_list_t
));
1866 entry
->pl_prop
= prop
;
1867 entry
->pl_width
= zprop_width(prop
, &entry
->pl_fixed
, edp
->type
);
1868 entry
->pl_all
= B_TRUE
;
1870 *(edp
->last
) = entry
;
1871 edp
->last
= &entry
->pl_next
;
1873 return (ZPROP_CONT
);
1877 zprop_expand_list(libzfs_handle_t
*hdl
, zprop_list_t
**plp
, zfs_type_t type
)
1879 zprop_list_t
*entry
;
1880 zprop_list_t
**last
;
1885 * If this is the very first time we've been called for an 'all'
1886 * specification, expand the list to include all native
1895 if (zprop_iter_common(zprop_expand_list_cb
, &exp
, B_FALSE
,
1896 B_FALSE
, type
) == ZPROP_INVAL
)
1900 * Add 'name' to the beginning of the list, which is handled
1903 entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
));
1904 entry
->pl_prop
= ((type
== ZFS_TYPE_POOL
) ? ZPOOL_PROP_NAME
:
1905 ((type
== ZFS_TYPE_VDEV
) ? VDEV_PROP_NAME
: ZFS_PROP_NAME
));
1906 entry
->pl_width
= zprop_width(entry
->pl_prop
,
1907 &entry
->pl_fixed
, type
);
1908 entry
->pl_all
= B_TRUE
;
1909 entry
->pl_next
= *plp
;
1916 zprop_iter(zprop_func func
, void *cb
, boolean_t show_all
, boolean_t ordered
,
1919 return (zprop_iter_common(func
, cb
, show_all
, ordered
, type
));
1923 zfs_version_userland(void)
1925 return (ZFS_META_ALIAS
);
1929 * Prints both zfs userland and kernel versions
1930 * Returns 0 on success, and -1 on error
1933 zfs_version_print(void)
1935 (void) puts(ZFS_META_ALIAS
);
1937 char *kver
= zfs_version_kernel();
1939 fprintf(stderr
, "zfs_version_kernel() failed: %s\n",
1944 (void) printf("zfs-kmod-%s\n", kver
);
1950 * Return 1 if the user requested ANSI color output, and our terminal supports
1951 * it. Return 0 for no color.
1956 static int use_color
= -1;
1962 * For each zpool invocation, we do a single check to see if we should
1963 * be using color or not, and cache that value for the lifetime of the
1964 * the zpool command. That makes it cheap to call use_color() when
1965 * we're printing with color. We assume that the settings are not going
1966 * to change during the invocation of a zpool command (the user isn't
1967 * going to change the ZFS_COLOR value while zpool is running, for
1970 if (use_color
!= -1) {
1972 * We've already figured out if we should be using color or
1973 * not. Return the cached value.
1978 term
= getenv("TERM");
1980 * The user sets the ZFS_COLOR env var set to enable zpool ANSI color
1981 * output. However if NO_COLOR is set (https://no-color.org/) then
1982 * don't use it. Also, don't use color if terminal doesn't support
1985 if (libzfs_envvar_is_set("ZFS_COLOR") &&
1986 !libzfs_envvar_is_set("NO_COLOR") &&
1987 isatty(STDOUT_FILENO
) && term
&& strcmp("dumb", term
) != 0 &&
1988 strcmp("unknown", term
) != 0) {
1989 /* Color supported */
1999 * color_start() and color_end() are used for when you want to colorize a block
2000 * of text. For example:
2002 * color_start(ANSI_RED_FG)
2008 color_start(const char *color
)
2011 fputs(color
, stdout
);
2018 fputs(ANSI_RESET
, stdout
);
2021 /* printf() with a color. If color is NULL, then do a normal printf. */
2023 printf_color(const char *color
, const char *format
, ...)
2031 va_start(aptr
, format
);
2032 rc
= vprintf(format
, aptr
);