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 2015 Nexenta Systems, Inc. All rights reserved.
24 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
25 * Copyright (c) 2011, 2024 by Delphix. All rights reserved.
26 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
27 * Copyright (c) 2018 Datto Inc.
28 * Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
29 * Copyright (c) 2017, Intel Corporation.
30 * Copyright (c) 2018, loli10K <ezomori.nozomu@gmail.com>
31 * Copyright (c) 2021, Colm Buckley <colm@tuatha.org>
32 * Copyright (c) 2021, 2023, Klara Inc.
44 #include <sys/efi_partition.h>
45 #include <sys/systeminfo.h>
46 #include <sys/zfs_ioctl.h>
47 #include <sys/zfs_sysfs.h>
48 #include <sys/vdev_disk.h>
49 #include <sys/types.h>
54 #include "zfs_namecheck.h"
56 #include "libzfs_impl.h"
57 #include "zfs_comutil.h"
58 #include "zfeature_common.h"
60 static boolean_t
zpool_vdev_is_interior(const char *name
);
62 typedef struct prop_flags
{
63 unsigned int create
:1; /* Validate property on creation */
64 unsigned int import
:1; /* Validate property on import */
65 unsigned int vdevprop
:1; /* Validate property as a VDEV property */
69 * ====================================================================
70 * zpool property functions
71 * ====================================================================
75 zpool_get_all_props(zpool_handle_t
*zhp
)
77 zfs_cmd_t zc
= {"\0"};
78 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
80 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
82 zcmd_alloc_dst_nvlist(hdl
, &zc
, 0);
84 while (zfs_ioctl(hdl
, ZFS_IOC_POOL_GET_PROPS
, &zc
) != 0) {
86 zcmd_expand_dst_nvlist(hdl
, &zc
);
88 zcmd_free_nvlists(&zc
);
93 if (zcmd_read_dst_nvlist(hdl
, &zc
, &zhp
->zpool_props
) != 0) {
94 zcmd_free_nvlists(&zc
);
98 zcmd_free_nvlists(&zc
);
104 zpool_props_refresh(zpool_handle_t
*zhp
)
108 old_props
= zhp
->zpool_props
;
110 if (zpool_get_all_props(zhp
) != 0)
113 nvlist_free(old_props
);
118 zpool_get_prop_string(zpool_handle_t
*zhp
, zpool_prop_t prop
,
123 zprop_source_t source
;
125 nvl
= zhp
->zpool_props
;
126 if (nvlist_lookup_nvlist(nvl
, zpool_prop_to_name(prop
), &nv
) == 0) {
127 source
= fnvlist_lookup_uint64(nv
, ZPROP_SOURCE
);
128 value
= fnvlist_lookup_string(nv
, ZPROP_VALUE
);
130 source
= ZPROP_SRC_DEFAULT
;
131 if ((value
= zpool_prop_default_string(prop
)) == NULL
)
142 zpool_get_prop_int(zpool_handle_t
*zhp
, zpool_prop_t prop
, zprop_source_t
*src
)
146 zprop_source_t source
;
148 if (zhp
->zpool_props
== NULL
&& zpool_get_all_props(zhp
)) {
150 * zpool_get_all_props() has most likely failed because
151 * the pool is faulted, but if all we need is the top level
152 * vdev's guid then get it from the zhp config nvlist.
154 if ((prop
== ZPOOL_PROP_GUID
) &&
155 (nvlist_lookup_nvlist(zhp
->zpool_config
,
156 ZPOOL_CONFIG_VDEV_TREE
, &nv
) == 0) &&
157 (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_GUID
, &value
)
161 return (zpool_prop_default_numeric(prop
));
164 nvl
= zhp
->zpool_props
;
165 if (nvlist_lookup_nvlist(nvl
, zpool_prop_to_name(prop
), &nv
) == 0) {
166 source
= fnvlist_lookup_uint64(nv
, ZPROP_SOURCE
);
167 value
= fnvlist_lookup_uint64(nv
, ZPROP_VALUE
);
169 source
= ZPROP_SRC_DEFAULT
;
170 value
= zpool_prop_default_numeric(prop
);
180 * Map VDEV STATE to printed strings.
183 zpool_state_to_name(vdev_state_t state
, vdev_aux_t aux
)
186 case VDEV_STATE_CLOSED
:
187 case VDEV_STATE_OFFLINE
:
188 return (gettext("OFFLINE"));
189 case VDEV_STATE_REMOVED
:
190 return (gettext("REMOVED"));
191 case VDEV_STATE_CANT_OPEN
:
192 if (aux
== VDEV_AUX_CORRUPT_DATA
|| aux
== VDEV_AUX_BAD_LOG
)
193 return (gettext("FAULTED"));
194 else if (aux
== VDEV_AUX_SPLIT_POOL
)
195 return (gettext("SPLIT"));
197 return (gettext("UNAVAIL"));
198 case VDEV_STATE_FAULTED
:
199 return (gettext("FAULTED"));
200 case VDEV_STATE_DEGRADED
:
201 return (gettext("DEGRADED"));
202 case VDEV_STATE_HEALTHY
:
203 return (gettext("ONLINE"));
209 return (gettext("UNKNOWN"));
213 * Map POOL STATE to printed strings.
216 zpool_pool_state_to_name(pool_state_t state
)
221 case POOL_STATE_ACTIVE
:
222 return (gettext("ACTIVE"));
223 case POOL_STATE_EXPORTED
:
224 return (gettext("EXPORTED"));
225 case POOL_STATE_DESTROYED
:
226 return (gettext("DESTROYED"));
227 case POOL_STATE_SPARE
:
228 return (gettext("SPARE"));
229 case POOL_STATE_L2CACHE
:
230 return (gettext("L2CACHE"));
231 case POOL_STATE_UNINITIALIZED
:
232 return (gettext("UNINITIALIZED"));
233 case POOL_STATE_UNAVAIL
:
234 return (gettext("UNAVAIL"));
235 case POOL_STATE_POTENTIALLY_ACTIVE
:
236 return (gettext("POTENTIALLY_ACTIVE"));
239 return (gettext("UNKNOWN"));
243 * Given a pool handle, return the pool health string ("ONLINE", "DEGRADED",
247 zpool_get_state_str(zpool_handle_t
*zhp
)
249 zpool_errata_t errata
;
250 zpool_status_t status
;
253 status
= zpool_get_status(zhp
, NULL
, &errata
);
255 if (zpool_get_state(zhp
) == POOL_STATE_UNAVAIL
) {
256 str
= gettext("FAULTED");
257 } else if (status
== ZPOOL_STATUS_IO_FAILURE_WAIT
||
258 status
== ZPOOL_STATUS_IO_FAILURE_CONTINUE
||
259 status
== ZPOOL_STATUS_IO_FAILURE_MMP
) {
260 str
= gettext("SUSPENDED");
262 nvlist_t
*nvroot
= fnvlist_lookup_nvlist(
263 zpool_get_config(zhp
, NULL
), ZPOOL_CONFIG_VDEV_TREE
);
265 vdev_stat_t
*vs
= (vdev_stat_t
*)fnvlist_lookup_uint64_array(
266 nvroot
, ZPOOL_CONFIG_VDEV_STATS
, &vsc
);
267 str
= zpool_state_to_name(vs
->vs_state
, vs
->vs_aux
);
273 * Get a zpool property value for 'prop' and return the value in
274 * a pre-allocated buffer.
277 zpool_get_prop(zpool_handle_t
*zhp
, zpool_prop_t prop
, char *buf
,
278 size_t len
, zprop_source_t
*srctype
, boolean_t literal
)
282 zprop_source_t src
= ZPROP_SRC_NONE
;
284 if (zpool_get_state(zhp
) == POOL_STATE_UNAVAIL
) {
286 case ZPOOL_PROP_NAME
:
287 (void) strlcpy(buf
, zpool_get_name(zhp
), len
);
290 case ZPOOL_PROP_HEALTH
:
291 (void) strlcpy(buf
, zpool_get_state_str(zhp
), len
);
294 case ZPOOL_PROP_GUID
:
295 intval
= zpool_get_prop_int(zhp
, prop
, &src
);
296 (void) snprintf(buf
, len
, "%llu", (u_longlong_t
)intval
);
299 case ZPOOL_PROP_ALTROOT
:
300 case ZPOOL_PROP_CACHEFILE
:
301 case ZPOOL_PROP_COMMENT
:
302 case ZPOOL_PROP_COMPATIBILITY
:
303 if (zhp
->zpool_props
!= NULL
||
304 zpool_get_all_props(zhp
) == 0) {
306 zpool_get_prop_string(zhp
, prop
, &src
),
312 (void) strlcpy(buf
, "-", len
);
321 if (zhp
->zpool_props
== NULL
&& zpool_get_all_props(zhp
) &&
322 prop
!= ZPOOL_PROP_NAME
)
325 switch (zpool_prop_get_type(prop
)) {
326 case PROP_TYPE_STRING
:
327 (void) strlcpy(buf
, zpool_get_prop_string(zhp
, prop
, &src
),
331 case PROP_TYPE_NUMBER
:
332 intval
= zpool_get_prop_int(zhp
, prop
, &src
);
335 case ZPOOL_PROP_SIZE
:
336 case ZPOOL_PROP_ALLOCATED
:
337 case ZPOOL_PROP_FREE
:
338 case ZPOOL_PROP_FREEING
:
339 case ZPOOL_PROP_LEAKED
:
340 case ZPOOL_PROP_ASHIFT
:
341 case ZPOOL_PROP_MAXBLOCKSIZE
:
342 case ZPOOL_PROP_MAXDNODESIZE
:
343 case ZPOOL_PROP_BCLONESAVED
:
344 case ZPOOL_PROP_BCLONEUSED
:
346 (void) snprintf(buf
, len
, "%llu",
347 (u_longlong_t
)intval
);
349 (void) zfs_nicenum(intval
, buf
, len
);
352 case ZPOOL_PROP_EXPANDSZ
:
353 case ZPOOL_PROP_CHECKPOINT
:
355 (void) strlcpy(buf
, "-", len
);
356 } else if (literal
) {
357 (void) snprintf(buf
, len
, "%llu",
358 (u_longlong_t
)intval
);
360 (void) zfs_nicebytes(intval
, buf
, len
);
364 case ZPOOL_PROP_CAPACITY
:
366 (void) snprintf(buf
, len
, "%llu",
367 (u_longlong_t
)intval
);
369 (void) snprintf(buf
, len
, "%llu%%",
370 (u_longlong_t
)intval
);
374 case ZPOOL_PROP_FRAGMENTATION
:
375 if (intval
== UINT64_MAX
) {
376 (void) strlcpy(buf
, "-", len
);
377 } else if (literal
) {
378 (void) snprintf(buf
, len
, "%llu",
379 (u_longlong_t
)intval
);
381 (void) snprintf(buf
, len
, "%llu%%",
382 (u_longlong_t
)intval
);
386 case ZPOOL_PROP_BCLONERATIO
:
387 case ZPOOL_PROP_DEDUPRATIO
:
389 (void) snprintf(buf
, len
, "%llu.%02llu",
390 (u_longlong_t
)(intval
/ 100),
391 (u_longlong_t
)(intval
% 100));
393 (void) snprintf(buf
, len
, "%llu.%02llux",
394 (u_longlong_t
)(intval
/ 100),
395 (u_longlong_t
)(intval
% 100));
398 case ZPOOL_PROP_HEALTH
:
399 (void) strlcpy(buf
, zpool_get_state_str(zhp
), len
);
401 case ZPOOL_PROP_VERSION
:
402 if (intval
>= SPA_VERSION_FEATURES
) {
403 (void) snprintf(buf
, len
, "-");
408 (void) snprintf(buf
, len
, "%llu", (u_longlong_t
)intval
);
412 case PROP_TYPE_INDEX
:
413 intval
= zpool_get_prop_int(zhp
, prop
, &src
);
414 if (zpool_prop_index_to_string(prop
, intval
, &strval
)
417 (void) strlcpy(buf
, strval
, len
);
431 * Get a zpool property value for 'propname' and return the value in
432 * a pre-allocated buffer.
435 zpool_get_userprop(zpool_handle_t
*zhp
, const char *propname
, char *buf
,
436 size_t len
, zprop_source_t
*srctype
)
441 zprop_source_t source
= ZPROP_SRC_LOCAL
;
443 nvl
= zhp
->zpool_props
;
444 if (nvlist_lookup_nvlist(nvl
, propname
, &nv
) == 0) {
445 if (nvlist_lookup_uint64(nv
, ZPROP_SOURCE
, &ival
) == 0)
447 verify(nvlist_lookup_string(nv
, ZPROP_VALUE
, &value
) == 0);
449 source
= ZPROP_SRC_DEFAULT
;
456 (void) strlcpy(buf
, value
, len
);
462 * Check if the bootfs name has the same pool name as it is set to.
463 * Assuming bootfs is a valid dataset name.
466 bootfs_name_valid(const char *pool
, const char *bootfs
)
468 int len
= strlen(pool
);
469 if (bootfs
[0] == '\0')
472 if (!zfs_name_valid(bootfs
, ZFS_TYPE_FILESYSTEM
|ZFS_TYPE_SNAPSHOT
))
475 if (strncmp(pool
, bootfs
, len
) == 0 &&
476 (bootfs
[len
] == '/' || bootfs
[len
] == '\0'))
483 * Given an nvlist of zpool properties to be set, validate that they are
484 * correct, and parse any numeric properties (index, boolean, etc) if they are
485 * specified as strings.
488 zpool_valid_proplist(libzfs_handle_t
*hdl
, const char *poolname
,
489 nvlist_t
*props
, uint64_t version
, prop_flags_t flags
, char *errbuf
)
496 const char *slash
, *check
;
497 struct stat64 statbuf
;
501 if (nvlist_alloc(&retprops
, NV_UNIQUE_NAME
, 0) != 0) {
502 (void) no_memory(hdl
);
507 while ((elem
= nvlist_next_nvpair(props
, elem
)) != NULL
) {
508 const char *propname
= nvpair_name(elem
);
510 if (flags
.vdevprop
&& zpool_prop_vdev(propname
)) {
511 vdev_prop_t vprop
= vdev_name_to_prop(propname
);
513 if (vdev_prop_readonly(vprop
)) {
514 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "'%s' "
515 "is readonly"), propname
);
516 (void) zfs_error(hdl
, EZFS_PROPREADONLY
,
521 if (zprop_parse_value(hdl
, elem
, vprop
, ZFS_TYPE_VDEV
,
522 retprops
, &strval
, &intval
, errbuf
) != 0)
526 } else if (flags
.vdevprop
&& vdev_prop_user(propname
)) {
527 if (nvlist_add_nvpair(retprops
, elem
) != 0) {
528 (void) no_memory(hdl
);
532 } else if (flags
.vdevprop
) {
533 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
534 "invalid property: '%s'"), propname
);
535 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
539 prop
= zpool_name_to_prop(propname
);
540 if (prop
== ZPOOL_PROP_INVAL
&& zpool_prop_feature(propname
)) {
542 char *fname
= strchr(propname
, '@') + 1;
544 err
= zfeature_lookup_name(fname
, NULL
);
546 ASSERT3U(err
, ==, ENOENT
);
547 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
548 "feature '%s' unsupported by kernel"),
550 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
554 if (nvpair_type(elem
) != DATA_TYPE_STRING
) {
555 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
556 "'%s' must be a string"), propname
);
557 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
561 (void) nvpair_value_string(elem
, &strval
);
562 if (strcmp(strval
, ZFS_FEATURE_ENABLED
) != 0 &&
563 strcmp(strval
, ZFS_FEATURE_DISABLED
) != 0) {
564 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
565 "property '%s' can only be set to "
566 "'enabled' or 'disabled'"), propname
);
567 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
572 strcmp(strval
, ZFS_FEATURE_DISABLED
) == 0) {
573 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
574 "property '%s' can only be set to "
575 "'disabled' at creation time"), propname
);
576 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
580 if (nvlist_add_uint64(retprops
, propname
, 0) != 0) {
581 (void) no_memory(hdl
);
585 } else if (prop
== ZPOOL_PROP_INVAL
&&
586 zfs_prop_user(propname
)) {
588 * This is a user property: make sure it's a
589 * string, and that it's less than ZAP_MAXNAMELEN.
591 if (nvpair_type(elem
) != DATA_TYPE_STRING
) {
592 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
593 "'%s' must be a string"), propname
);
594 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
598 if (strlen(nvpair_name(elem
)) >= ZAP_MAXNAMELEN
) {
599 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
600 "property name '%s' is too long"),
602 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
606 (void) nvpair_value_string(elem
, &strval
);
608 if (strlen(strval
) >= ZFS_MAXPROPLEN
) {
609 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
610 "property value '%s' is too long"),
612 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
616 if (nvlist_add_string(retprops
, propname
,
618 (void) no_memory(hdl
);
626 * Make sure this property is valid and applies to this type.
628 if (prop
== ZPOOL_PROP_INVAL
) {
629 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
630 "invalid property '%s'"), propname
);
631 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
635 if (zpool_prop_readonly(prop
)) {
636 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "'%s' "
637 "is readonly"), propname
);
638 (void) zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
);
642 if (!flags
.create
&& zpool_prop_setonce(prop
)) {
643 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
644 "property '%s' can only be set at "
645 "creation time"), propname
);
646 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
650 if (zprop_parse_value(hdl
, elem
, prop
, ZFS_TYPE_POOL
, retprops
,
651 &strval
, &intval
, errbuf
) != 0)
655 * Perform additional checking for specific properties.
658 case ZPOOL_PROP_VERSION
:
659 if (intval
< version
||
660 !SPA_VERSION_IS_SUPPORTED(intval
)) {
661 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
662 "property '%s' number %llu is invalid."),
663 propname
, (unsigned long long)intval
);
664 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
669 case ZPOOL_PROP_ASHIFT
:
671 (intval
< ASHIFT_MIN
|| intval
> ASHIFT_MAX
)) {
672 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
673 "property '%s' number %llu is invalid, "
674 "only values between %" PRId32
" and %"
675 PRId32
" are allowed."),
676 propname
, (unsigned long long)intval
,
677 ASHIFT_MIN
, ASHIFT_MAX
);
678 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
683 case ZPOOL_PROP_BOOTFS
:
684 if (flags
.create
|| flags
.import
) {
685 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
686 "property '%s' cannot be set at creation "
687 "or import time"), propname
);
688 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
692 if (version
< SPA_VERSION_BOOTFS
) {
693 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
694 "pool must be upgraded to support "
695 "'%s' property"), propname
);
696 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
701 * bootfs property value has to be a dataset name and
702 * the dataset has to be in the same pool as it sets to.
704 if (!bootfs_name_valid(poolname
, strval
)) {
705 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "'%s' "
706 "is an invalid name"), strval
);
707 (void) zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
711 if ((zhp
= zpool_open_canfail(hdl
, poolname
)) == NULL
) {
712 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
713 "could not open pool '%s'"), poolname
);
714 (void) zfs_error(hdl
, EZFS_OPENFAILED
, errbuf
);
720 case ZPOOL_PROP_ALTROOT
:
721 if (!flags
.create
&& !flags
.import
) {
722 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
723 "property '%s' can only be set during pool "
724 "creation or import"), propname
);
725 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
729 if (strval
[0] != '/') {
730 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
731 "bad alternate root '%s'"), strval
);
732 (void) zfs_error(hdl
, EZFS_BADPATH
, errbuf
);
737 case ZPOOL_PROP_CACHEFILE
:
738 if (strval
[0] == '\0')
741 if (strcmp(strval
, "none") == 0)
744 if (strval
[0] != '/') {
745 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
746 "property '%s' must be empty, an "
747 "absolute path, or 'none'"), propname
);
748 (void) zfs_error(hdl
, EZFS_BADPATH
, errbuf
);
752 slash
= strrchr(strval
, '/');
754 if (slash
[1] == '\0' || strcmp(slash
, "/.") == 0 ||
755 strcmp(slash
, "/..") == 0) {
756 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
757 "'%s' is not a valid file"), strval
);
758 (void) zfs_error(hdl
, EZFS_BADPATH
, errbuf
);
762 *(char *)slash
= '\0';
764 if (strval
[0] != '\0' &&
765 (stat64(strval
, &statbuf
) != 0 ||
766 !S_ISDIR(statbuf
.st_mode
))) {
767 *(char *)slash
= '/';
768 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
769 "'%s' is not a valid directory"),
771 (void) zfs_error(hdl
, EZFS_BADPATH
, errbuf
);
775 *(char *)slash
= '/';
778 case ZPOOL_PROP_COMPATIBILITY
:
779 switch (zpool_load_compat(strval
, NULL
, report
, 1024)) {
780 case ZPOOL_COMPATIBILITY_OK
:
781 case ZPOOL_COMPATIBILITY_WARNTOKEN
:
783 case ZPOOL_COMPATIBILITY_BADFILE
:
784 case ZPOOL_COMPATIBILITY_BADTOKEN
:
785 case ZPOOL_COMPATIBILITY_NOFILES
:
786 zfs_error_aux(hdl
, "%s", report
);
787 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
792 case ZPOOL_PROP_COMMENT
:
793 for (check
= strval
; *check
!= '\0'; check
++) {
794 if (!isprint(*check
)) {
796 dgettext(TEXT_DOMAIN
,
797 "comment may only have printable "
799 (void) zfs_error(hdl
, EZFS_BADPROP
,
804 if (strlen(strval
) > ZPROP_MAX_COMMENT
) {
805 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
806 "comment must not exceed %d characters"),
808 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
812 case ZPOOL_PROP_READONLY
:
814 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
815 "property '%s' can only be set at "
816 "import time"), propname
);
817 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
821 case ZPOOL_PROP_MULTIHOST
:
822 if (get_system_hostid() == 0) {
823 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
824 "requires a non-zero system hostid"));
825 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
829 case ZPOOL_PROP_DEDUPDITTO
:
830 printf("Note: property '%s' no longer has "
831 "any effect\n", propname
);
841 nvlist_free(retprops
);
846 * Set zpool property : propname=propval.
849 zpool_set_prop(zpool_handle_t
*zhp
, const char *propname
, const char *propval
)
851 zfs_cmd_t zc
= {"\0"};
853 char errbuf
[ERRBUFLEN
];
854 nvlist_t
*nvl
= NULL
;
857 prop_flags_t flags
= { 0 };
859 (void) snprintf(errbuf
, sizeof (errbuf
),
860 dgettext(TEXT_DOMAIN
, "cannot set property for '%s'"),
863 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0)
864 return (no_memory(zhp
->zpool_hdl
));
866 if (nvlist_add_string(nvl
, propname
, propval
) != 0) {
868 return (no_memory(zhp
->zpool_hdl
));
871 version
= zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
);
872 if ((realprops
= zpool_valid_proplist(zhp
->zpool_hdl
,
873 zhp
->zpool_name
, nvl
, version
, flags
, errbuf
)) == NULL
) {
882 * Execute the corresponding ioctl() to set this property.
884 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
886 zcmd_write_src_nvlist(zhp
->zpool_hdl
, &zc
, nvl
);
888 ret
= zfs_ioctl(zhp
->zpool_hdl
, ZFS_IOC_POOL_SET_PROPS
, &zc
);
890 zcmd_free_nvlists(&zc
);
894 (void) zpool_standard_error(zhp
->zpool_hdl
, errno
, errbuf
);
896 (void) zpool_props_refresh(zhp
);
902 zpool_expand_proplist(zpool_handle_t
*zhp
, zprop_list_t
**plp
,
903 zfs_type_t type
, boolean_t literal
)
905 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
907 char buf
[ZFS_MAXPROPLEN
];
908 nvlist_t
*features
= NULL
;
911 boolean_t firstexpand
= (NULL
== *plp
);
914 if (zprop_expand_list(hdl
, plp
, type
) != 0)
917 if (type
== ZFS_TYPE_VDEV
)
921 while (*last
!= NULL
)
922 last
= &(*last
)->pl_next
;
925 features
= zpool_get_features(zhp
);
927 if ((*plp
)->pl_all
&& firstexpand
) {
928 /* Handle userprops in the all properties case */
929 if (zhp
->zpool_props
== NULL
&& zpool_props_refresh(zhp
))
933 while ((nvp
= nvlist_next_nvpair(zhp
->zpool_props
, nvp
)) !=
935 const char *propname
= nvpair_name(nvp
);
937 if (!zfs_prop_user(propname
))
940 entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
));
941 entry
->pl_prop
= ZPROP_USERPROP
;
942 entry
->pl_user_prop
= zfs_strdup(hdl
, propname
);
943 entry
->pl_width
= strlen(entry
->pl_user_prop
);
944 entry
->pl_all
= B_TRUE
;
947 last
= &entry
->pl_next
;
950 for (i
= 0; i
< SPA_FEATURES
; i
++) {
951 entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
));
952 entry
->pl_prop
= ZPROP_USERPROP
;
953 entry
->pl_user_prop
= zfs_asprintf(hdl
, "feature@%s",
954 spa_feature_table
[i
].fi_uname
);
955 entry
->pl_width
= strlen(entry
->pl_user_prop
);
956 entry
->pl_all
= B_TRUE
;
959 last
= &entry
->pl_next
;
963 /* add any unsupported features */
964 for (nvp
= nvlist_next_nvpair(features
, NULL
);
965 nvp
!= NULL
; nvp
= nvlist_next_nvpair(features
, nvp
)) {
969 if (zfeature_is_supported(nvpair_name(nvp
)))
972 propname
= zfs_asprintf(hdl
, "unsupported@%s",
976 * Before adding the property to the list make sure that no
977 * other pool already added the same property.
981 while (entry
!= NULL
) {
982 if (entry
->pl_user_prop
!= NULL
&&
983 strcmp(propname
, entry
->pl_user_prop
) == 0) {
987 entry
= entry
->pl_next
;
994 entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
));
995 entry
->pl_prop
= ZPROP_USERPROP
;
996 entry
->pl_user_prop
= propname
;
997 entry
->pl_width
= strlen(entry
->pl_user_prop
);
998 entry
->pl_all
= B_TRUE
;
1001 last
= &entry
->pl_next
;
1004 for (entry
= *plp
; entry
!= NULL
; entry
= entry
->pl_next
) {
1005 if (entry
->pl_fixed
&& !literal
)
1008 if (entry
->pl_prop
!= ZPROP_USERPROP
&&
1009 zpool_get_prop(zhp
, entry
->pl_prop
, buf
, sizeof (buf
),
1010 NULL
, literal
) == 0) {
1011 if (strlen(buf
) > entry
->pl_width
)
1012 entry
->pl_width
= strlen(buf
);
1013 } else if (entry
->pl_prop
== ZPROP_INVAL
&&
1014 zfs_prop_user(entry
->pl_user_prop
) &&
1015 zpool_get_userprop(zhp
, entry
->pl_user_prop
, buf
,
1016 sizeof (buf
), NULL
) == 0) {
1017 if (strlen(buf
) > entry
->pl_width
)
1018 entry
->pl_width
= strlen(buf
);
1026 vdev_expand_proplist(zpool_handle_t
*zhp
, const char *vdevname
,
1029 zprop_list_t
*entry
;
1030 char buf
[ZFS_MAXPROPLEN
];
1031 const char *strval
= NULL
;
1033 nvpair_t
*elem
= NULL
;
1034 nvlist_t
*vprops
= NULL
;
1035 nvlist_t
*propval
= NULL
;
1036 const char *propname
;
1038 zprop_list_t
**last
;
1040 for (entry
= *plp
; entry
!= NULL
; entry
= entry
->pl_next
) {
1041 if (entry
->pl_fixed
)
1044 if (zpool_get_vdev_prop(zhp
, vdevname
, entry
->pl_prop
,
1045 entry
->pl_user_prop
, buf
, sizeof (buf
), NULL
,
1047 if (strlen(buf
) > entry
->pl_width
)
1048 entry
->pl_width
= strlen(buf
);
1050 if (entry
->pl_prop
== VDEV_PROP_NAME
&&
1051 strlen(vdevname
) > entry
->pl_width
)
1052 entry
->pl_width
= strlen(vdevname
);
1055 /* Handle the all properties case */
1057 if (*last
!= NULL
&& (*last
)->pl_all
== B_TRUE
) {
1058 while (*last
!= NULL
)
1059 last
= &(*last
)->pl_next
;
1061 err
= zpool_get_all_vdev_props(zhp
, vdevname
, &vprops
);
1065 while ((elem
= nvlist_next_nvpair(vprops
, elem
)) != NULL
) {
1066 propname
= nvpair_name(elem
);
1068 /* Skip properties that are not user defined */
1069 if ((prop
= vdev_name_to_prop(propname
)) !=
1073 if (nvpair_value_nvlist(elem
, &propval
) != 0)
1076 strval
= fnvlist_lookup_string(propval
, ZPROP_VALUE
);
1078 entry
= zfs_alloc(zhp
->zpool_hdl
,
1079 sizeof (zprop_list_t
));
1080 entry
->pl_prop
= prop
;
1081 entry
->pl_user_prop
= zfs_strdup(zhp
->zpool_hdl
,
1083 entry
->pl_width
= strlen(strval
);
1084 entry
->pl_all
= B_TRUE
;
1086 last
= &entry
->pl_next
;
1094 * Get the state for the given feature on the given ZFS pool.
1097 zpool_prop_get_feature(zpool_handle_t
*zhp
, const char *propname
, char *buf
,
1101 boolean_t found
= B_FALSE
;
1102 nvlist_t
*features
= zpool_get_features(zhp
);
1103 boolean_t supported
;
1104 const char *feature
= strchr(propname
, '@') + 1;
1106 supported
= zpool_prop_feature(propname
);
1107 ASSERT(supported
|| zpool_prop_unsupported(propname
));
1110 * Convert from feature name to feature guid. This conversion is
1111 * unnecessary for unsupported@... properties because they already
1118 ret
= zfeature_lookup_name(feature
, &fid
);
1120 (void) strlcpy(buf
, "-", len
);
1123 feature
= spa_feature_table
[fid
].fi_guid
;
1126 if (nvlist_lookup_uint64(features
, feature
, &refcount
) == 0)
1131 (void) strlcpy(buf
, ZFS_FEATURE_DISABLED
, len
);
1134 (void) strlcpy(buf
, ZFS_FEATURE_ENABLED
, len
);
1136 (void) strlcpy(buf
, ZFS_FEATURE_ACTIVE
, len
);
1140 if (refcount
== 0) {
1141 (void) strcpy(buf
, ZFS_UNSUPPORTED_INACTIVE
);
1143 (void) strcpy(buf
, ZFS_UNSUPPORTED_READONLY
);
1146 (void) strlcpy(buf
, "-", len
);
1155 * Validate the given pool name, optionally putting an extended error message in
1159 zpool_name_valid(libzfs_handle_t
*hdl
, boolean_t isopen
, const char *pool
)
1161 namecheck_err_t why
;
1165 ret
= pool_namecheck(pool
, &why
, &what
);
1168 * The rules for reserved pool names were extended at a later point.
1169 * But we need to support users with existing pools that may now be
1170 * invalid. So we only check for this expanded set of names during a
1171 * create (or import), and only in userland.
1173 if (ret
== 0 && !isopen
&&
1174 (strncmp(pool
, "mirror", 6) == 0 ||
1175 strncmp(pool
, "raidz", 5) == 0 ||
1176 strncmp(pool
, "draid", 5) == 0 ||
1177 strncmp(pool
, "spare", 5) == 0 ||
1178 strcmp(pool
, "log") == 0)) {
1181 dgettext(TEXT_DOMAIN
, "name is reserved"));
1189 case NAME_ERR_TOOLONG
:
1191 dgettext(TEXT_DOMAIN
, "name is too long"));
1194 case NAME_ERR_INVALCHAR
:
1196 dgettext(TEXT_DOMAIN
, "invalid character "
1197 "'%c' in pool name"), what
);
1200 case NAME_ERR_NOLETTER
:
1201 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1202 "name must begin with a letter"));
1205 case NAME_ERR_RESERVED
:
1206 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1207 "name is reserved"));
1210 case NAME_ERR_DISKLIKE
:
1211 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1212 "pool name is reserved"));
1215 case NAME_ERR_LEADING_SLASH
:
1216 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1217 "leading slash in name"));
1220 case NAME_ERR_EMPTY_COMPONENT
:
1221 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1222 "empty component in name"));
1225 case NAME_ERR_TRAILING_SLASH
:
1226 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1227 "trailing slash in name"));
1230 case NAME_ERR_MULTIPLE_DELIMITERS
:
1231 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1232 "multiple '@' and/or '#' delimiters in "
1236 case NAME_ERR_NO_AT
:
1237 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1238 "permission set is missing '@'"));
1242 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1243 "(%d) not defined"), why
);
1254 * Open a handle to the given pool, even if the pool is currently in the FAULTED
1258 zpool_open_canfail(libzfs_handle_t
*hdl
, const char *pool
)
1260 zpool_handle_t
*zhp
;
1264 * Make sure the pool name is valid.
1266 if (!zpool_name_valid(hdl
, B_TRUE
, pool
)) {
1267 (void) zfs_error_fmt(hdl
, EZFS_INVALIDNAME
,
1268 dgettext(TEXT_DOMAIN
, "cannot open '%s'"),
1273 zhp
= zfs_alloc(hdl
, sizeof (zpool_handle_t
));
1275 zhp
->zpool_hdl
= hdl
;
1276 (void) strlcpy(zhp
->zpool_name
, pool
, sizeof (zhp
->zpool_name
));
1278 if (zpool_refresh_stats(zhp
, &missing
) != 0) {
1284 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "no such pool"));
1285 (void) zfs_error_fmt(hdl
, EZFS_NOENT
,
1286 dgettext(TEXT_DOMAIN
, "cannot open '%s'"), pool
);
1295 * Like the above, but silent on error. Used when iterating over pools (because
1296 * the configuration cache may be out of date).
1299 zpool_open_silent(libzfs_handle_t
*hdl
, const char *pool
, zpool_handle_t
**ret
)
1301 zpool_handle_t
*zhp
;
1304 zhp
= zfs_alloc(hdl
, sizeof (zpool_handle_t
));
1306 zhp
->zpool_hdl
= hdl
;
1307 (void) strlcpy(zhp
->zpool_name
, pool
, sizeof (zhp
->zpool_name
));
1309 if (zpool_refresh_stats(zhp
, &missing
) != 0) {
1325 * Similar to zpool_open_canfail(), but refuses to open pools in the faulted
1329 zpool_open(libzfs_handle_t
*hdl
, const char *pool
)
1331 zpool_handle_t
*zhp
;
1333 if ((zhp
= zpool_open_canfail(hdl
, pool
)) == NULL
)
1336 if (zhp
->zpool_state
== POOL_STATE_UNAVAIL
) {
1337 (void) zfs_error_fmt(hdl
, EZFS_POOLUNAVAIL
,
1338 dgettext(TEXT_DOMAIN
, "cannot open '%s'"), zhp
->zpool_name
);
1347 * Close the handle. Simply frees the memory associated with the handle.
1350 zpool_close(zpool_handle_t
*zhp
)
1352 nvlist_free(zhp
->zpool_config
);
1353 nvlist_free(zhp
->zpool_old_config
);
1354 nvlist_free(zhp
->zpool_props
);
1359 * Return the name of the pool.
1362 zpool_get_name(zpool_handle_t
*zhp
)
1364 return (zhp
->zpool_name
);
1369 * Return the state of the pool (ACTIVE or UNAVAILABLE)
1372 zpool_get_state(zpool_handle_t
*zhp
)
1374 return (zhp
->zpool_state
);
1378 * Check if vdev list contains a special vdev
1381 zpool_has_special_vdev(nvlist_t
*nvroot
)
1386 if (nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_CHILDREN
, &child
,
1388 for (uint_t c
= 0; c
< children
; c
++) {
1391 if (nvlist_lookup_string(child
[c
],
1392 ZPOOL_CONFIG_ALLOCATION_BIAS
, &bias
) == 0 &&
1393 strcmp(bias
, VDEV_ALLOC_BIAS_SPECIAL
) == 0) {
1402 * Check if vdev list contains a dRAID vdev
1405 zpool_has_draid_vdev(nvlist_t
*nvroot
)
1410 if (nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_CHILDREN
,
1411 &child
, &children
) == 0) {
1412 for (uint_t c
= 0; c
< children
; c
++) {
1415 if (nvlist_lookup_string(child
[c
],
1416 ZPOOL_CONFIG_TYPE
, &type
) == 0 &&
1417 strcmp(type
, VDEV_TYPE_DRAID
) == 0) {
1426 * Output a dRAID top-level vdev name in to the provided buffer.
1429 zpool_draid_name(char *name
, int len
, uint64_t data
, uint64_t parity
,
1430 uint64_t spares
, uint64_t children
)
1432 snprintf(name
, len
, "%s%llu:%llud:%lluc:%llus",
1433 VDEV_TYPE_DRAID
, (u_longlong_t
)parity
, (u_longlong_t
)data
,
1434 (u_longlong_t
)children
, (u_longlong_t
)spares
);
1440 * Return B_TRUE if the provided name is a dRAID spare name.
1443 zpool_is_draid_spare(const char *name
)
1445 uint64_t spare_id
, parity
, vdev_id
;
1447 if (sscanf(name
, VDEV_TYPE_DRAID
"%llu-%llu-%llu",
1448 (u_longlong_t
*)&parity
, (u_longlong_t
*)&vdev_id
,
1449 (u_longlong_t
*)&spare_id
) == 3) {
1457 * Create the named pool, using the provided vdev list. It is assumed
1458 * that the consumer has already validated the contents of the nvlist, so we
1459 * don't have to worry about error semantics.
1462 zpool_create(libzfs_handle_t
*hdl
, const char *pool
, nvlist_t
*nvroot
,
1463 nvlist_t
*props
, nvlist_t
*fsprops
)
1465 zfs_cmd_t zc
= {"\0"};
1466 nvlist_t
*zc_fsprops
= NULL
;
1467 nvlist_t
*zc_props
= NULL
;
1468 nvlist_t
*hidden_args
= NULL
;
1469 uint8_t *wkeydata
= NULL
;
1471 char errbuf
[ERRBUFLEN
];
1474 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1475 "cannot create '%s'"), pool
);
1477 if (!zpool_name_valid(hdl
, B_FALSE
, pool
))
1478 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
1480 zcmd_write_conf_nvlist(hdl
, &zc
, nvroot
);
1483 prop_flags_t flags
= { .create
= B_TRUE
, .import
= B_FALSE
};
1485 if ((zc_props
= zpool_valid_proplist(hdl
, pool
, props
,
1486 SPA_VERSION_1
, flags
, errbuf
)) == NULL
) {
1493 const char *zonestr
;
1495 zoned
= ((nvlist_lookup_string(fsprops
,
1496 zfs_prop_to_name(ZFS_PROP_ZONED
), &zonestr
) == 0) &&
1497 strcmp(zonestr
, "on") == 0);
1499 if ((zc_fsprops
= zfs_valid_proplist(hdl
, ZFS_TYPE_FILESYSTEM
,
1500 fsprops
, zoned
, NULL
, NULL
, B_TRUE
, errbuf
)) == NULL
) {
1504 if (nvlist_exists(zc_fsprops
,
1505 zfs_prop_to_name(ZFS_PROP_SPECIAL_SMALL_BLOCKS
)) &&
1506 !zpool_has_special_vdev(nvroot
)) {
1507 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1508 "%s property requires a special vdev"),
1509 zfs_prop_to_name(ZFS_PROP_SPECIAL_SMALL_BLOCKS
));
1510 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1515 (nvlist_alloc(&zc_props
, NV_UNIQUE_NAME
, 0) != 0)) {
1518 if (zfs_crypto_create(hdl
, NULL
, zc_fsprops
, props
, B_TRUE
,
1519 &wkeydata
, &wkeylen
) != 0) {
1520 zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
);
1523 if (nvlist_add_nvlist(zc_props
,
1524 ZPOOL_ROOTFS_PROPS
, zc_fsprops
) != 0) {
1527 if (wkeydata
!= NULL
) {
1528 if (nvlist_alloc(&hidden_args
, NV_UNIQUE_NAME
, 0) != 0)
1531 if (nvlist_add_uint8_array(hidden_args
, "wkeydata",
1532 wkeydata
, wkeylen
) != 0)
1535 if (nvlist_add_nvlist(zc_props
, ZPOOL_HIDDEN_ARGS
,
1542 zcmd_write_src_nvlist(hdl
, &zc
, zc_props
);
1544 (void) strlcpy(zc
.zc_name
, pool
, sizeof (zc
.zc_name
));
1546 if ((ret
= zfs_ioctl(hdl
, ZFS_IOC_POOL_CREATE
, &zc
)) != 0) {
1548 zcmd_free_nvlists(&zc
);
1549 nvlist_free(zc_props
);
1550 nvlist_free(zc_fsprops
);
1551 nvlist_free(hidden_args
);
1552 if (wkeydata
!= NULL
)
1558 * This can happen if the user has specified the same
1559 * device multiple times. We can't reliably detect this
1560 * until we try to add it and see we already have a
1561 * label. This can also happen under if the device is
1562 * part of an active md or lvm device.
1564 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1565 "one or more vdevs refer to the same device, or "
1566 "one of\nthe devices is part of an active md or "
1568 return (zfs_error(hdl
, EZFS_BADDEV
, errbuf
));
1572 * This happens if the record size is smaller or larger
1573 * than the allowed size range, or not a power of 2.
1575 * NOTE: although zfs_valid_proplist is called earlier,
1576 * this case may have slipped through since the
1577 * pool does not exist yet and it is therefore
1578 * impossible to read properties e.g. max blocksize
1581 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1582 "record size invalid"));
1583 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
1587 * This occurs when one of the devices is below
1588 * SPA_MINDEVSIZE. Unfortunately, we can't detect which
1589 * device was the problem device since there's no
1590 * reliable way to determine device size from userland.
1595 zfs_nicebytes(SPA_MINDEVSIZE
, buf
,
1598 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1599 "one or more devices is less than the "
1600 "minimum size (%s)"), buf
);
1602 return (zfs_error(hdl
, EZFS_BADDEV
, errbuf
));
1605 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1606 "one or more devices is out of space"));
1607 return (zfs_error(hdl
, EZFS_BADDEV
, errbuf
));
1610 if (zpool_has_draid_vdev(nvroot
) &&
1611 zfeature_lookup_name("draid", NULL
) != 0) {
1612 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1613 "dRAID vdevs are unsupported by the "
1615 return (zfs_error(hdl
, EZFS_BADDEV
, errbuf
));
1617 return (zpool_standard_error(hdl
, errno
,
1622 return (zpool_standard_error(hdl
, errno
, errbuf
));
1627 zcmd_free_nvlists(&zc
);
1628 nvlist_free(zc_props
);
1629 nvlist_free(zc_fsprops
);
1630 nvlist_free(hidden_args
);
1631 if (wkeydata
!= NULL
)
1637 * Destroy the given pool. It is up to the caller to ensure that there are no
1638 * datasets left in the pool.
1641 zpool_destroy(zpool_handle_t
*zhp
, const char *log_str
)
1643 zfs_cmd_t zc
= {"\0"};
1644 zfs_handle_t
*zfp
= NULL
;
1645 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1646 char errbuf
[ERRBUFLEN
];
1648 if (zhp
->zpool_state
== POOL_STATE_ACTIVE
&&
1649 (zfp
= zfs_open(hdl
, zhp
->zpool_name
, ZFS_TYPE_FILESYSTEM
)) == NULL
)
1652 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
1653 zc
.zc_history
= (uint64_t)(uintptr_t)log_str
;
1655 if (zfs_ioctl(hdl
, ZFS_IOC_POOL_DESTROY
, &zc
) != 0) {
1656 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1657 "cannot destroy '%s'"), zhp
->zpool_name
);
1659 if (errno
== EROFS
) {
1660 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1661 "one or more devices is read only"));
1662 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
1664 (void) zpool_standard_error(hdl
, errno
, errbuf
);
1673 remove_mountpoint(zfp
);
1681 * Create a checkpoint in the given pool.
1684 zpool_checkpoint(zpool_handle_t
*zhp
)
1686 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1687 char errbuf
[ERRBUFLEN
];
1690 error
= lzc_pool_checkpoint(zhp
->zpool_name
);
1692 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1693 "cannot checkpoint '%s'"), zhp
->zpool_name
);
1694 (void) zpool_standard_error(hdl
, error
, errbuf
);
1702 * Discard the checkpoint from the given pool.
1705 zpool_discard_checkpoint(zpool_handle_t
*zhp
)
1707 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1708 char errbuf
[ERRBUFLEN
];
1711 error
= lzc_pool_checkpoint_discard(zhp
->zpool_name
);
1713 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1714 "cannot discard checkpoint in '%s'"), zhp
->zpool_name
);
1715 (void) zpool_standard_error(hdl
, error
, errbuf
);
1723 * Add the given vdevs to the pool. The caller must have already performed the
1724 * necessary verification to ensure that the vdev specification is well-formed.
1727 zpool_add(zpool_handle_t
*zhp
, nvlist_t
*nvroot
, boolean_t check_ashift
)
1729 zfs_cmd_t zc
= {"\0"};
1731 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1732 char errbuf
[ERRBUFLEN
];
1733 nvlist_t
**spares
, **l2cache
;
1734 uint_t nspares
, nl2cache
;
1736 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1737 "cannot add to '%s'"), zhp
->zpool_name
);
1739 if (zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
) <
1740 SPA_VERSION_SPARES
&&
1741 nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_SPARES
,
1742 &spares
, &nspares
) == 0) {
1743 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "pool must be "
1744 "upgraded to add hot spares"));
1745 return (zfs_error(hdl
, EZFS_BADVERSION
, errbuf
));
1748 if (zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
) <
1749 SPA_VERSION_L2CACHE
&&
1750 nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_L2CACHE
,
1751 &l2cache
, &nl2cache
) == 0) {
1752 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "pool must be "
1753 "upgraded to add cache devices"));
1754 return (zfs_error(hdl
, EZFS_BADVERSION
, errbuf
));
1757 zcmd_write_conf_nvlist(hdl
, &zc
, nvroot
);
1758 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
1759 zc
.zc_flags
= check_ashift
;
1761 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_ADD
, &zc
) != 0) {
1765 * This can happen if the user has specified the same
1766 * device multiple times. We can't reliably detect this
1767 * until we try to add it and see we already have a
1770 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1771 "one or more vdevs refer to the same device"));
1772 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
1777 if (zpool_has_draid_vdev(nvroot
) &&
1778 zfeature_lookup_name("draid", NULL
) != 0) {
1779 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1780 "dRAID vdevs are unsupported by the "
1783 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1784 "invalid config; a pool with removing/"
1785 "removed vdevs does not support adding "
1786 "raidz or dRAID vdevs"));
1789 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
1794 * This occurs when one of the devices is below
1795 * SPA_MINDEVSIZE. Unfortunately, we can't detect which
1796 * device was the problem device since there's no
1797 * reliable way to determine device size from userland.
1802 zfs_nicebytes(SPA_MINDEVSIZE
, buf
,
1805 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1806 "device is less than the minimum "
1809 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
1813 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1814 "pool must be upgraded to add these vdevs"));
1815 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
1819 (void) zpool_standard_error(hdl
, errno
, errbuf
);
1827 zcmd_free_nvlists(&zc
);
1833 * Exports the pool from the system. The caller must ensure that there are no
1834 * mounted datasets in the pool.
1837 zpool_export_common(zpool_handle_t
*zhp
, boolean_t force
, boolean_t hardforce
,
1838 const char *log_str
)
1840 zfs_cmd_t zc
= {"\0"};
1842 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
1843 zc
.zc_cookie
= force
;
1844 zc
.zc_guid
= hardforce
;
1845 zc
.zc_history
= (uint64_t)(uintptr_t)log_str
;
1847 if (zfs_ioctl(zhp
->zpool_hdl
, ZFS_IOC_POOL_EXPORT
, &zc
) != 0) {
1850 zfs_error_aux(zhp
->zpool_hdl
, dgettext(TEXT_DOMAIN
,
1851 "use '-f' to override the following errors:\n"
1852 "'%s' has an active shared spare which could be"
1853 " used by other pools once '%s' is exported."),
1854 zhp
->zpool_name
, zhp
->zpool_name
);
1855 return (zfs_error_fmt(zhp
->zpool_hdl
, EZFS_ACTIVE_SPARE
,
1856 dgettext(TEXT_DOMAIN
, "cannot export '%s'"),
1859 return (zpool_standard_error_fmt(zhp
->zpool_hdl
, errno
,
1860 dgettext(TEXT_DOMAIN
, "cannot export '%s'"),
1869 zpool_export(zpool_handle_t
*zhp
, boolean_t force
, const char *log_str
)
1871 return (zpool_export_common(zhp
, force
, B_FALSE
, log_str
));
1875 zpool_export_force(zpool_handle_t
*zhp
, const char *log_str
)
1877 return (zpool_export_common(zhp
, B_TRUE
, B_TRUE
, log_str
));
1881 zpool_rewind_exclaim(libzfs_handle_t
*hdl
, const char *name
, boolean_t dryrun
,
1884 nvlist_t
*nv
= NULL
;
1890 if (!hdl
->libzfs_printerr
|| config
== NULL
)
1893 if (nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_LOAD_INFO
, &nv
) != 0 ||
1894 nvlist_lookup_nvlist(nv
, ZPOOL_CONFIG_REWIND_INFO
, &nv
) != 0) {
1898 if (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_LOAD_TIME
, &rewindto
) != 0)
1900 (void) nvlist_lookup_int64(nv
, ZPOOL_CONFIG_REWIND_TIME
, &loss
);
1902 if (localtime_r((time_t *)&rewindto
, &t
) != NULL
&&
1903 ctime_r((time_t *)&rewindto
, timestr
) != NULL
) {
1906 (void) printf(dgettext(TEXT_DOMAIN
,
1907 "Would be able to return %s "
1908 "to its state as of %s.\n"),
1911 (void) printf(dgettext(TEXT_DOMAIN
,
1912 "Pool %s returned to its state as of %s.\n"),
1916 (void) printf(dgettext(TEXT_DOMAIN
,
1917 "%s approximately %lld "),
1918 dryrun
? "Would discard" : "Discarded",
1919 ((longlong_t
)loss
+ 30) / 60);
1920 (void) printf(dgettext(TEXT_DOMAIN
,
1921 "minutes of transactions.\n"));
1922 } else if (loss
> 0) {
1923 (void) printf(dgettext(TEXT_DOMAIN
,
1924 "%s approximately %lld "),
1925 dryrun
? "Would discard" : "Discarded",
1927 (void) printf(dgettext(TEXT_DOMAIN
,
1928 "seconds of transactions.\n"));
1934 zpool_explain_recover(libzfs_handle_t
*hdl
, const char *name
, int reason
,
1937 nvlist_t
*nv
= NULL
;
1939 uint64_t edata
= UINT64_MAX
;
1944 if (!hdl
->libzfs_printerr
)
1948 (void) printf(dgettext(TEXT_DOMAIN
, "action: "));
1950 (void) printf(dgettext(TEXT_DOMAIN
, "\t"));
1952 /* All attempted rewinds failed if ZPOOL_CONFIG_LOAD_TIME missing */
1953 if (nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_LOAD_INFO
, &nv
) != 0 ||
1954 nvlist_lookup_nvlist(nv
, ZPOOL_CONFIG_REWIND_INFO
, &nv
) != 0 ||
1955 nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_LOAD_TIME
, &rewindto
) != 0)
1958 (void) nvlist_lookup_int64(nv
, ZPOOL_CONFIG_REWIND_TIME
, &loss
);
1959 (void) nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_LOAD_DATA_ERRORS
,
1962 (void) printf(dgettext(TEXT_DOMAIN
,
1963 "Recovery is possible, but will result in some data loss.\n"));
1965 if (localtime_r((time_t *)&rewindto
, &t
) != NULL
&&
1966 ctime_r((time_t *)&rewindto
, timestr
) != NULL
) {
1968 (void) printf(dgettext(TEXT_DOMAIN
,
1969 "\tReturning the pool to its state as of %s\n"
1970 "\tshould correct the problem. "),
1973 (void) printf(dgettext(TEXT_DOMAIN
,
1974 "\tReverting the pool to an earlier state "
1975 "should correct the problem.\n\t"));
1979 (void) printf(dgettext(TEXT_DOMAIN
,
1980 "Approximately %lld minutes of data\n"
1981 "\tmust be discarded, irreversibly. "),
1982 ((longlong_t
)loss
+ 30) / 60);
1983 } else if (loss
> 0) {
1984 (void) printf(dgettext(TEXT_DOMAIN
,
1985 "Approximately %lld seconds of data\n"
1986 "\tmust be discarded, irreversibly. "),
1989 if (edata
!= 0 && edata
!= UINT64_MAX
) {
1991 (void) printf(dgettext(TEXT_DOMAIN
,
1992 "After rewind, at least\n"
1993 "\tone persistent user-data error will remain. "));
1995 (void) printf(dgettext(TEXT_DOMAIN
,
1996 "After rewind, several\n"
1997 "\tpersistent user-data errors will remain. "));
2000 (void) printf(dgettext(TEXT_DOMAIN
,
2001 "Recovery can be attempted\n\tby executing 'zpool %s -F %s'. "),
2002 reason
>= 0 ? "clear" : "import", name
);
2004 (void) printf(dgettext(TEXT_DOMAIN
,
2005 "A scrub of the pool\n"
2006 "\tis strongly recommended after recovery.\n"));
2010 (void) printf(dgettext(TEXT_DOMAIN
,
2011 "Destroy and re-create the pool from\n\ta backup source.\n"));
2015 * zpool_import() is a contracted interface. Should be kept the same
2018 * Applications should use zpool_import_props() to import a pool with
2019 * new properties value to be set.
2022 zpool_import(libzfs_handle_t
*hdl
, nvlist_t
*config
, const char *newname
,
2025 nvlist_t
*props
= NULL
;
2028 if (altroot
!= NULL
) {
2029 if (nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0) != 0) {
2030 return (zfs_error_fmt(hdl
, EZFS_NOMEM
,
2031 dgettext(TEXT_DOMAIN
, "cannot import '%s'"),
2035 if (nvlist_add_string(props
,
2036 zpool_prop_to_name(ZPOOL_PROP_ALTROOT
), altroot
) != 0 ||
2037 nvlist_add_string(props
,
2038 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE
), "none") != 0) {
2040 return (zfs_error_fmt(hdl
, EZFS_NOMEM
,
2041 dgettext(TEXT_DOMAIN
, "cannot import '%s'"),
2046 ret
= zpool_import_props(hdl
, config
, newname
, props
,
2053 print_vdev_tree(libzfs_handle_t
*hdl
, const char *name
, nvlist_t
*nv
,
2059 uint64_t is_log
= 0;
2061 (void) nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_IS_LOG
,
2065 (void) printf("\t%*s%s%s\n", indent
, "", name
,
2066 is_log
? " [log]" : "");
2068 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
2069 &child
, &children
) != 0)
2072 for (c
= 0; c
< children
; c
++) {
2073 vname
= zpool_vdev_name(hdl
, NULL
, child
[c
], VDEV_NAME_TYPE_ID
);
2074 print_vdev_tree(hdl
, vname
, child
[c
], indent
+ 2);
2080 zpool_print_unsup_feat(nvlist_t
*config
)
2082 nvlist_t
*nvinfo
, *unsup_feat
;
2084 nvinfo
= fnvlist_lookup_nvlist(config
, ZPOOL_CONFIG_LOAD_INFO
);
2085 unsup_feat
= fnvlist_lookup_nvlist(nvinfo
, ZPOOL_CONFIG_UNSUP_FEAT
);
2087 for (nvpair_t
*nvp
= nvlist_next_nvpair(unsup_feat
, NULL
);
2088 nvp
!= NULL
; nvp
= nvlist_next_nvpair(unsup_feat
, nvp
)) {
2089 const char *desc
= fnvpair_value_string(nvp
);
2090 if (strlen(desc
) > 0)
2091 (void) printf("\t%s (%s)\n", nvpair_name(nvp
), desc
);
2093 (void) printf("\t%s\n", nvpair_name(nvp
));
2098 * Import the given pool using the known configuration and a list of
2099 * properties to be set. The configuration should have come from
2100 * zpool_find_import(). The 'newname' parameters control whether the pool
2101 * is imported with a different name.
2104 zpool_import_props(libzfs_handle_t
*hdl
, nvlist_t
*config
, const char *newname
,
2105 nvlist_t
*props
, int flags
)
2107 zfs_cmd_t zc
= {"\0"};
2108 zpool_load_policy_t policy
;
2109 nvlist_t
*nv
= NULL
;
2110 nvlist_t
*nvinfo
= NULL
;
2111 nvlist_t
*missing
= NULL
;
2112 const char *thename
;
2113 const char *origname
;
2116 char errbuf
[ERRBUFLEN
];
2118 origname
= fnvlist_lookup_string(config
, ZPOOL_CONFIG_POOL_NAME
);
2120 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
2121 "cannot import pool '%s'"), origname
);
2123 if (newname
!= NULL
) {
2124 if (!zpool_name_valid(hdl
, B_FALSE
, newname
))
2125 return (zfs_error_fmt(hdl
, EZFS_INVALIDNAME
,
2126 dgettext(TEXT_DOMAIN
, "cannot import '%s'"),
2133 if (props
!= NULL
) {
2135 prop_flags_t flags
= { .create
= B_FALSE
, .import
= B_TRUE
};
2137 version
= fnvlist_lookup_uint64(config
, ZPOOL_CONFIG_VERSION
);
2139 if ((props
= zpool_valid_proplist(hdl
, origname
,
2140 props
, version
, flags
, errbuf
)) == NULL
)
2142 zcmd_write_src_nvlist(hdl
, &zc
, props
);
2146 (void) strlcpy(zc
.zc_name
, thename
, sizeof (zc
.zc_name
));
2148 zc
.zc_guid
= fnvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_GUID
);
2150 zcmd_write_conf_nvlist(hdl
, &zc
, config
);
2151 zcmd_alloc_dst_nvlist(hdl
, &zc
, zc
.zc_nvlist_conf_size
* 2);
2153 zc
.zc_cookie
= flags
;
2154 while ((ret
= zfs_ioctl(hdl
, ZFS_IOC_POOL_IMPORT
, &zc
)) != 0 &&
2156 zcmd_expand_dst_nvlist(hdl
, &zc
);
2160 (void) zcmd_read_dst_nvlist(hdl
, &zc
, &nv
);
2162 zcmd_free_nvlists(&zc
);
2164 zpool_get_load_policy(config
, &policy
);
2171 * Dry-run failed, but we print out what success
2172 * looks like if we found a best txg
2174 if (policy
.zlp_rewind
& ZPOOL_TRY_REWIND
) {
2175 zpool_rewind_exclaim(hdl
, newname
? origname
: thename
,
2181 if (newname
== NULL
)
2182 (void) snprintf(desc
, sizeof (desc
),
2183 dgettext(TEXT_DOMAIN
, "cannot import '%s'"),
2186 (void) snprintf(desc
, sizeof (desc
),
2187 dgettext(TEXT_DOMAIN
, "cannot import '%s' as '%s'"),
2192 if (nv
!= NULL
&& nvlist_lookup_nvlist(nv
,
2193 ZPOOL_CONFIG_LOAD_INFO
, &nvinfo
) == 0 &&
2194 nvlist_exists(nvinfo
, ZPOOL_CONFIG_UNSUP_FEAT
)) {
2195 (void) printf(dgettext(TEXT_DOMAIN
, "This "
2196 "pool uses the following feature(s) not "
2197 "supported by this system:\n"));
2198 zpool_print_unsup_feat(nv
);
2199 if (nvlist_exists(nvinfo
,
2200 ZPOOL_CONFIG_CAN_RDONLY
)) {
2201 (void) printf(dgettext(TEXT_DOMAIN
,
2202 "All unsupported features are only "
2203 "required for writing to the pool."
2204 "\nThe pool can be imported using "
2205 "'-o readonly=on'.\n"));
2209 * Unsupported version.
2211 (void) zfs_error(hdl
, EZFS_BADVERSION
, desc
);
2215 if (nv
!= NULL
&& nvlist_lookup_nvlist(nv
,
2216 ZPOOL_CONFIG_LOAD_INFO
, &nvinfo
) == 0) {
2217 const char *hostname
= "<unknown>";
2218 uint64_t hostid
= 0;
2219 mmp_state_t mmp_state
;
2221 mmp_state
= fnvlist_lookup_uint64(nvinfo
,
2222 ZPOOL_CONFIG_MMP_STATE
);
2224 if (nvlist_exists(nvinfo
,
2225 ZPOOL_CONFIG_MMP_HOSTNAME
))
2226 hostname
= fnvlist_lookup_string(nvinfo
,
2227 ZPOOL_CONFIG_MMP_HOSTNAME
);
2229 if (nvlist_exists(nvinfo
,
2230 ZPOOL_CONFIG_MMP_HOSTID
))
2231 hostid
= fnvlist_lookup_uint64(nvinfo
,
2232 ZPOOL_CONFIG_MMP_HOSTID
);
2234 if (mmp_state
== MMP_STATE_ACTIVE
) {
2235 (void) snprintf(aux
, sizeof (aux
),
2236 dgettext(TEXT_DOMAIN
, "pool is imp"
2237 "orted on host '%s' (hostid=%lx).\n"
2238 "Export the pool on the other "
2239 "system, then run 'zpool import'."),
2240 hostname
, (unsigned long) hostid
);
2241 } else if (mmp_state
== MMP_STATE_NO_HOSTID
) {
2242 (void) snprintf(aux
, sizeof (aux
),
2243 dgettext(TEXT_DOMAIN
, "pool has "
2244 "the multihost property on and "
2245 "the\nsystem's hostid is not set. "
2246 "Set a unique system hostid with "
2247 "the zgenhostid(8) command.\n"));
2250 (void) zfs_error_aux(hdl
, "%s", aux
);
2252 (void) zfs_error(hdl
, EZFS_ACTIVE_POOL
, desc
);
2256 (void) zfs_error(hdl
, EZFS_INVALCONFIG
, desc
);
2260 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2261 "one or more devices is read only"));
2262 (void) zfs_error(hdl
, EZFS_BADDEV
, desc
);
2266 if (nv
&& nvlist_lookup_nvlist(nv
,
2267 ZPOOL_CONFIG_LOAD_INFO
, &nvinfo
) == 0 &&
2268 nvlist_lookup_nvlist(nvinfo
,
2269 ZPOOL_CONFIG_MISSING_DEVICES
, &missing
) == 0) {
2270 (void) printf(dgettext(TEXT_DOMAIN
,
2271 "The devices below are missing or "
2272 "corrupted, use '-m' to import the pool "
2274 print_vdev_tree(hdl
, NULL
, missing
, 2);
2275 (void) printf("\n");
2277 (void) zpool_standard_error(hdl
, error
, desc
);
2281 (void) zpool_standard_error(hdl
, error
, desc
);
2285 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2286 "one or more devices are already in use\n"));
2287 (void) zfs_error(hdl
, EZFS_BADDEV
, desc
);
2290 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2291 "new name of at least one dataset is longer than "
2292 "the maximum allowable length"));
2293 (void) zfs_error(hdl
, EZFS_NAMETOOLONG
, desc
);
2296 (void) zpool_standard_error(hdl
, error
, desc
);
2297 zpool_explain_recover(hdl
,
2298 newname
? origname
: thename
, -error
, nv
);
2305 zpool_handle_t
*zhp
;
2308 * This should never fail, but play it safe anyway.
2310 if (zpool_open_silent(hdl
, thename
, &zhp
) != 0)
2312 else if (zhp
!= NULL
)
2314 if (policy
.zlp_rewind
&
2315 (ZPOOL_DO_REWIND
| ZPOOL_TRY_REWIND
)) {
2316 zpool_rewind_exclaim(hdl
, newname
? origname
: thename
,
2317 ((policy
.zlp_rewind
& ZPOOL_TRY_REWIND
) != 0), nv
);
2326 * Translate vdev names to guids. If a vdev_path is determined to be
2327 * unsuitable then a vd_errlist is allocated and the vdev path and errno
2331 zpool_translate_vdev_guids(zpool_handle_t
*zhp
, nvlist_t
*vds
,
2332 nvlist_t
*vdev_guids
, nvlist_t
*guids_to_paths
, nvlist_t
**vd_errlist
)
2334 nvlist_t
*errlist
= NULL
;
2337 for (nvpair_t
*elem
= nvlist_next_nvpair(vds
, NULL
); elem
!= NULL
;
2338 elem
= nvlist_next_nvpair(vds
, elem
)) {
2339 boolean_t spare
, cache
;
2341 const char *vd_path
= nvpair_name(elem
);
2342 nvlist_t
*tgt
= zpool_find_vdev(zhp
, vd_path
, &spare
, &cache
,
2345 if ((tgt
== NULL
) || cache
|| spare
) {
2346 if (errlist
== NULL
) {
2347 errlist
= fnvlist_alloc();
2351 uint64_t err
= (tgt
== NULL
) ? EZFS_NODEVICE
:
2352 (spare
? EZFS_ISSPARE
: EZFS_ISL2CACHE
);
2353 fnvlist_add_int64(errlist
, vd_path
, err
);
2357 uint64_t guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
2358 fnvlist_add_uint64(vdev_guids
, vd_path
, guid
);
2360 char msg
[MAXNAMELEN
];
2361 (void) snprintf(msg
, sizeof (msg
), "%llu", (u_longlong_t
)guid
);
2362 fnvlist_add_string(guids_to_paths
, msg
, vd_path
);
2366 verify(errlist
!= NULL
);
2367 if (vd_errlist
!= NULL
)
2368 *vd_errlist
= errlist
;
2370 fnvlist_free(errlist
);
2377 xlate_init_err(int err
)
2381 return (EZFS_NODEVICE
);
2384 return (EZFS_BADDEV
);
2386 return (EZFS_INITIALIZING
);
2388 return (EZFS_NO_INITIALIZE
);
2394 * Begin, suspend, cancel, or uninit (clear) the initialization (initializing
2395 * of all free blocks) for the given vdevs in the given pool.
2398 zpool_initialize_impl(zpool_handle_t
*zhp
, pool_initialize_func_t cmd_type
,
2399 nvlist_t
*vds
, boolean_t wait
)
2403 nvlist_t
*vdev_guids
= fnvlist_alloc();
2404 nvlist_t
*guids_to_paths
= fnvlist_alloc();
2405 nvlist_t
*vd_errlist
= NULL
;
2409 err
= zpool_translate_vdev_guids(zhp
, vds
, vdev_guids
,
2410 guids_to_paths
, &vd_errlist
);
2413 verify(vd_errlist
!= NULL
);
2417 err
= lzc_initialize(zhp
->zpool_name
, cmd_type
,
2418 vdev_guids
, &errlist
);
2421 if (errlist
!= NULL
&& nvlist_lookup_nvlist(errlist
,
2422 ZPOOL_INITIALIZE_VDEVS
, &vd_errlist
) == 0) {
2426 if (err
== EINVAL
&& cmd_type
== POOL_INITIALIZE_UNINIT
) {
2427 zfs_error_aux(zhp
->zpool_hdl
, dgettext(TEXT_DOMAIN
,
2428 "uninitialize is not supported by kernel"));
2431 (void) zpool_standard_error(zhp
->zpool_hdl
, err
,
2432 dgettext(TEXT_DOMAIN
, "operation failed"));
2437 for (elem
= nvlist_next_nvpair(vdev_guids
, NULL
); elem
!= NULL
;
2438 elem
= nvlist_next_nvpair(vdev_guids
, elem
)) {
2440 uint64_t guid
= fnvpair_value_uint64(elem
);
2442 err
= lzc_wait_tag(zhp
->zpool_name
,
2443 ZPOOL_WAIT_INITIALIZE
, guid
, NULL
);
2445 (void) zpool_standard_error_fmt(zhp
->zpool_hdl
,
2446 err
, dgettext(TEXT_DOMAIN
, "error "
2447 "waiting for '%s' to initialize"),
2457 for (elem
= nvlist_next_nvpair(vd_errlist
, NULL
); elem
!= NULL
;
2458 elem
= nvlist_next_nvpair(vd_errlist
, elem
)) {
2459 int64_t vd_error
= xlate_init_err(fnvpair_value_int64(elem
));
2462 if (nvlist_lookup_string(guids_to_paths
, nvpair_name(elem
),
2464 path
= nvpair_name(elem
);
2466 (void) zfs_error_fmt(zhp
->zpool_hdl
, vd_error
,
2467 "cannot initialize '%s'", path
);
2471 fnvlist_free(vdev_guids
);
2472 fnvlist_free(guids_to_paths
);
2474 if (vd_errlist
!= NULL
)
2475 fnvlist_free(vd_errlist
);
2477 return (err
== 0 ? 0 : -1);
2481 zpool_initialize(zpool_handle_t
*zhp
, pool_initialize_func_t cmd_type
,
2484 return (zpool_initialize_impl(zhp
, cmd_type
, vds
, B_FALSE
));
2488 zpool_initialize_wait(zpool_handle_t
*zhp
, pool_initialize_func_t cmd_type
,
2491 return (zpool_initialize_impl(zhp
, cmd_type
, vds
, B_TRUE
));
2495 xlate_trim_err(int err
)
2499 return (EZFS_NODEVICE
);
2502 return (EZFS_BADDEV
);
2504 return (EZFS_TRIMMING
);
2506 return (EZFS_NO_TRIM
);
2508 return (EZFS_TRIM_NOTSUP
);
2514 zpool_trim_wait(zpool_handle_t
*zhp
, nvlist_t
*vdev_guids
)
2519 for (elem
= nvlist_next_nvpair(vdev_guids
, NULL
); elem
!= NULL
;
2520 elem
= nvlist_next_nvpair(vdev_guids
, elem
)) {
2522 uint64_t guid
= fnvpair_value_uint64(elem
);
2524 err
= lzc_wait_tag(zhp
->zpool_name
,
2525 ZPOOL_WAIT_TRIM
, guid
, NULL
);
2527 (void) zpool_standard_error_fmt(zhp
->zpool_hdl
,
2528 err
, dgettext(TEXT_DOMAIN
, "error "
2529 "waiting to trim '%s'"), nvpair_name(elem
));
2538 * Check errlist and report any errors, omitting ones which should be
2539 * suppressed. Returns B_TRUE if any errors were reported.
2542 check_trim_errs(zpool_handle_t
*zhp
, trimflags_t
*trim_flags
,
2543 nvlist_t
*guids_to_paths
, nvlist_t
*vds
, nvlist_t
*errlist
)
2546 boolean_t reported_errs
= B_FALSE
;
2548 int num_suppressed_errs
= 0;
2550 for (elem
= nvlist_next_nvpair(vds
, NULL
);
2551 elem
!= NULL
; elem
= nvlist_next_nvpair(vds
, elem
)) {
2555 for (elem
= nvlist_next_nvpair(errlist
, NULL
);
2556 elem
!= NULL
; elem
= nvlist_next_nvpair(errlist
, elem
)) {
2557 int64_t vd_error
= xlate_trim_err(fnvpair_value_int64(elem
));
2561 * If only the pool was specified, and it was not a secure
2562 * trim then suppress warnings for individual vdevs which
2563 * do not support trimming.
2565 if (vd_error
== EZFS_TRIM_NOTSUP
&&
2566 trim_flags
->fullpool
&&
2567 !trim_flags
->secure
) {
2568 num_suppressed_errs
++;
2572 reported_errs
= B_TRUE
;
2573 if (nvlist_lookup_string(guids_to_paths
, nvpair_name(elem
),
2575 path
= nvpair_name(elem
);
2577 (void) zfs_error_fmt(zhp
->zpool_hdl
, vd_error
,
2578 "cannot trim '%s'", path
);
2581 if (num_suppressed_errs
== num_vds
) {
2582 (void) zfs_error_aux(zhp
->zpool_hdl
, dgettext(TEXT_DOMAIN
,
2583 "no devices in pool support trim operations"));
2584 (void) (zfs_error(zhp
->zpool_hdl
, EZFS_TRIM_NOTSUP
,
2585 dgettext(TEXT_DOMAIN
, "cannot trim")));
2586 reported_errs
= B_TRUE
;
2589 return (reported_errs
);
2593 * Begin, suspend, or cancel the TRIM (discarding of all free blocks) for
2594 * the given vdevs in the given pool.
2597 zpool_trim(zpool_handle_t
*zhp
, pool_trim_func_t cmd_type
, nvlist_t
*vds
,
2598 trimflags_t
*trim_flags
)
2603 nvlist_t
*vdev_guids
= fnvlist_alloc();
2604 nvlist_t
*guids_to_paths
= fnvlist_alloc();
2605 nvlist_t
*errlist
= NULL
;
2607 err
= zpool_translate_vdev_guids(zhp
, vds
, vdev_guids
,
2608 guids_to_paths
, &errlist
);
2610 check_trim_errs(zhp
, trim_flags
, guids_to_paths
, vds
, errlist
);
2615 err
= lzc_trim(zhp
->zpool_name
, cmd_type
, trim_flags
->rate
,
2616 trim_flags
->secure
, vdev_guids
, &errlist
);
2618 nvlist_t
*vd_errlist
;
2619 if (errlist
!= NULL
&& nvlist_lookup_nvlist(errlist
,
2620 ZPOOL_TRIM_VDEVS
, &vd_errlist
) == 0) {
2621 if (check_trim_errs(zhp
, trim_flags
, guids_to_paths
,
2627 char errbuf
[ERRBUFLEN
];
2629 (void) snprintf(errbuf
, sizeof (errbuf
),
2630 dgettext(TEXT_DOMAIN
, "operation failed"));
2631 zpool_standard_error(zhp
->zpool_hdl
, err
, errbuf
);
2638 if (trim_flags
->wait
)
2639 retval
= zpool_trim_wait(zhp
, vdev_guids
);
2642 if (errlist
!= NULL
)
2643 fnvlist_free(errlist
);
2644 fnvlist_free(vdev_guids
);
2645 fnvlist_free(guids_to_paths
);
2653 zpool_scan(zpool_handle_t
*zhp
, pool_scan_func_t func
, pool_scrub_cmd_t cmd
)
2655 char errbuf
[ERRBUFLEN
];
2657 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
2659 nvlist_t
*args
= fnvlist_alloc();
2660 fnvlist_add_uint64(args
, "scan_type", (uint64_t)func
);
2661 fnvlist_add_uint64(args
, "scan_command", (uint64_t)cmd
);
2663 err
= lzc_scrub(ZFS_IOC_POOL_SCRUB
, zhp
->zpool_name
, args
, NULL
);
2668 } else if (err
== ZFS_ERR_IOC_CMD_UNAVAIL
) {
2669 zfs_cmd_t zc
= {"\0"};
2670 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
,
2671 sizeof (zc
.zc_name
));
2672 zc
.zc_cookie
= func
;
2675 if (zfs_ioctl(hdl
, ZFS_IOC_POOL_SCAN
, &zc
) == 0)
2680 * An ECANCELED on a scrub means one of the following:
2681 * 1. we resumed a paused scrub.
2682 * 2. we resumed a paused error scrub.
2683 * 3. Error scrub is not run because of no error log.
2685 if (err
== ECANCELED
&& (func
== POOL_SCAN_SCRUB
||
2686 func
== POOL_SCAN_ERRORSCRUB
) && cmd
== POOL_SCRUB_NORMAL
)
2689 * The following cases have been handled here:
2690 * 1. Paused a scrub/error scrub if there is none in progress.
2692 if (err
== ENOENT
&& func
!= POOL_SCAN_NONE
&& cmd
==
2697 ASSERT3U(func
, >=, POOL_SCAN_NONE
);
2698 ASSERT3U(func
, <, POOL_SCAN_FUNCS
);
2700 if (func
== POOL_SCAN_SCRUB
|| func
== POOL_SCAN_ERRORSCRUB
) {
2701 if (cmd
== POOL_SCRUB_PAUSE
) {
2702 (void) snprintf(errbuf
, sizeof (errbuf
),
2703 dgettext(TEXT_DOMAIN
, "cannot pause scrubbing %s"),
2706 assert(cmd
== POOL_SCRUB_NORMAL
);
2707 (void) snprintf(errbuf
, sizeof (errbuf
),
2708 dgettext(TEXT_DOMAIN
, "cannot scrub %s"),
2711 } else if (func
== POOL_SCAN_RESILVER
) {
2712 assert(cmd
== POOL_SCRUB_NORMAL
);
2713 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
2714 "cannot restart resilver on %s"), zhp
->zpool_name
);
2715 } else if (func
== POOL_SCAN_NONE
) {
2716 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
2717 "cannot cancel scrubbing %s"), zhp
->zpool_name
);
2719 assert(!"unexpected result");
2723 * With EBUSY, five cases are possible:
2725 * Current state Requested
2726 * 1. Normal Scrub Running Normal Scrub or Error Scrub
2727 * 2. Normal Scrub Paused Error Scrub
2728 * 3. Normal Scrub Paused Pause Normal Scrub
2729 * 4. Error Scrub Running Normal Scrub or Error Scrub
2730 * 5. Error Scrub Paused Pause Error Scrub
2731 * 6. Resilvering Anything else
2735 pool_scan_stat_t
*ps
= NULL
;
2738 nvroot
= fnvlist_lookup_nvlist(zhp
->zpool_config
,
2739 ZPOOL_CONFIG_VDEV_TREE
);
2740 (void) nvlist_lookup_uint64_array(nvroot
,
2741 ZPOOL_CONFIG_SCAN_STATS
, (uint64_t **)&ps
, &psc
);
2742 if (ps
&& ps
->pss_func
== POOL_SCAN_SCRUB
&&
2743 ps
->pss_state
== DSS_SCANNING
) {
2744 if (ps
->pss_pass_scrub_pause
== 0) {
2745 /* handles case 1 */
2746 assert(cmd
== POOL_SCRUB_NORMAL
);
2747 return (zfs_error(hdl
, EZFS_SCRUBBING
,
2750 if (func
== POOL_SCAN_ERRORSCRUB
) {
2751 /* handles case 2 */
2752 ASSERT3U(cmd
, ==, POOL_SCRUB_NORMAL
);
2753 return (zfs_error(hdl
,
2754 EZFS_SCRUB_PAUSED_TO_CANCEL
,
2757 /* handles case 3 */
2758 ASSERT3U(func
, ==, POOL_SCAN_SCRUB
);
2759 ASSERT3U(cmd
, ==, POOL_SCRUB_PAUSE
);
2760 return (zfs_error(hdl
,
2761 EZFS_SCRUB_PAUSED
, errbuf
));
2765 ps
->pss_error_scrub_func
== POOL_SCAN_ERRORSCRUB
&&
2766 ps
->pss_error_scrub_state
== DSS_ERRORSCRUBBING
) {
2767 if (ps
->pss_pass_error_scrub_pause
== 0) {
2768 /* handles case 4 */
2769 ASSERT3U(cmd
, ==, POOL_SCRUB_NORMAL
);
2770 return (zfs_error(hdl
, EZFS_ERRORSCRUBBING
,
2773 /* handles case 5 */
2774 ASSERT3U(func
, ==, POOL_SCAN_ERRORSCRUB
);
2775 ASSERT3U(cmd
, ==, POOL_SCRUB_PAUSE
);
2776 return (zfs_error(hdl
, EZFS_ERRORSCRUB_PAUSED
,
2780 /* handles case 6 */
2781 return (zfs_error(hdl
, EZFS_RESILVERING
, errbuf
));
2783 } else if (err
== ENOENT
) {
2784 return (zfs_error(hdl
, EZFS_NO_SCRUB
, errbuf
));
2785 } else if (err
== ENOTSUP
&& func
== POOL_SCAN_RESILVER
) {
2786 return (zfs_error(hdl
, EZFS_NO_RESILVER_DEFER
, errbuf
));
2788 return (zpool_standard_error(hdl
, err
, errbuf
));
2793 * Find a vdev that matches the search criteria specified. We use the
2794 * the nvpair name to determine how we should look for the device.
2795 * 'avail_spare' is set to TRUE if the provided guid refers to an AVAIL
2796 * spare; but FALSE if its an INUSE spare.
2799 vdev_to_nvlist_iter(nvlist_t
*nv
, nvlist_t
*search
, boolean_t
*avail_spare
,
2800 boolean_t
*l2cache
, boolean_t
*log
)
2806 const char *srchkey
;
2807 nvpair_t
*pair
= nvlist_next_nvpair(search
, NULL
);
2809 /* Nothing to look for */
2810 if (search
== NULL
|| pair
== NULL
)
2813 /* Obtain the key we will use to search */
2814 srchkey
= nvpair_name(pair
);
2816 switch (nvpair_type(pair
)) {
2817 case DATA_TYPE_UINT64
:
2818 if (strcmp(srchkey
, ZPOOL_CONFIG_GUID
) == 0) {
2819 uint64_t srchval
= fnvpair_value_uint64(pair
);
2820 uint64_t theguid
= fnvlist_lookup_uint64(nv
,
2822 if (theguid
== srchval
)
2827 case DATA_TYPE_STRING
: {
2828 const char *srchval
, *val
;
2830 srchval
= fnvpair_value_string(pair
);
2831 if (nvlist_lookup_string(nv
, srchkey
, &val
) != 0)
2835 * Search for the requested value. Special cases:
2837 * - ZPOOL_CONFIG_PATH for whole disk entries. These end in
2838 * "-part1", or "p1". The suffix is hidden from the user,
2839 * but included in the string, so this matches around it.
2840 * - ZPOOL_CONFIG_PATH for short names zfs_strcmp_shortname()
2841 * is used to check all possible expanded paths.
2842 * - looking for a top-level vdev name (i.e. ZPOOL_CONFIG_TYPE).
2844 * Otherwise, all other searches are simple string compares.
2846 if (strcmp(srchkey
, ZPOOL_CONFIG_PATH
) == 0) {
2847 uint64_t wholedisk
= 0;
2849 (void) nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_WHOLE_DISK
,
2851 if (zfs_strcmp_pathname(srchval
, val
, wholedisk
) == 0)
2854 } else if (strcmp(srchkey
, ZPOOL_CONFIG_TYPE
) == 0) {
2855 char *type
, *idx
, *end
, *p
;
2856 uint64_t id
, vdev_id
;
2859 * Determine our vdev type, keeping in mind
2860 * that the srchval is composed of a type and
2861 * vdev id pair (i.e. mirror-4).
2863 if ((type
= strdup(srchval
)) == NULL
)
2866 if ((p
= strrchr(type
, '-')) == NULL
) {
2874 * If the types don't match then keep looking.
2876 if (strncmp(val
, type
, strlen(val
)) != 0) {
2881 verify(zpool_vdev_is_interior(type
));
2883 id
= fnvlist_lookup_uint64(nv
, ZPOOL_CONFIG_ID
);
2885 vdev_id
= strtoull(idx
, &end
, 10);
2888 * If we are looking for a raidz and a parity is
2889 * specified, make sure it matches.
2891 int rzlen
= strlen(VDEV_TYPE_RAIDZ
);
2892 assert(rzlen
== strlen(VDEV_TYPE_DRAID
));
2893 int typlen
= strlen(type
);
2894 if ((strncmp(type
, VDEV_TYPE_RAIDZ
, rzlen
) == 0 ||
2895 strncmp(type
, VDEV_TYPE_DRAID
, rzlen
) == 0) &&
2897 uint64_t vdev_parity
;
2898 int parity
= *(type
+ rzlen
) - '0';
2900 if (parity
<= 0 || parity
> 3 ||
2901 (typlen
- rzlen
) != 1) {
2903 * Nonsense parity specified, can
2909 vdev_parity
= fnvlist_lookup_uint64(nv
,
2910 ZPOOL_CONFIG_NPARITY
);
2911 if ((int)vdev_parity
!= parity
) {
2922 * Now verify that we have the correct vdev id.
2931 if (strcmp(srchval
, val
) == 0)
2940 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
2941 &child
, &children
) != 0)
2944 for (c
= 0; c
< children
; c
++) {
2945 if ((ret
= vdev_to_nvlist_iter(child
[c
], search
,
2946 avail_spare
, l2cache
, NULL
)) != NULL
) {
2948 * The 'is_log' value is only set for the toplevel
2949 * vdev, not the leaf vdevs. So we always lookup the
2950 * log device from the root of the vdev tree (where
2951 * 'log' is non-NULL).
2954 nvlist_lookup_uint64(child
[c
],
2955 ZPOOL_CONFIG_IS_LOG
, &is_log
) == 0 &&
2963 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_SPARES
,
2964 &child
, &children
) == 0) {
2965 for (c
= 0; c
< children
; c
++) {
2966 if ((ret
= vdev_to_nvlist_iter(child
[c
], search
,
2967 avail_spare
, l2cache
, NULL
)) != NULL
) {
2968 *avail_spare
= B_TRUE
;
2974 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_L2CACHE
,
2975 &child
, &children
) == 0) {
2976 for (c
= 0; c
< children
; c
++) {
2977 if ((ret
= vdev_to_nvlist_iter(child
[c
], search
,
2978 avail_spare
, l2cache
, NULL
)) != NULL
) {
2989 * Given a physical path or guid, find the associated vdev.
2992 zpool_find_vdev_by_physpath(zpool_handle_t
*zhp
, const char *ppath
,
2993 boolean_t
*avail_spare
, boolean_t
*l2cache
, boolean_t
*log
)
2995 nvlist_t
*search
, *nvroot
, *ret
;
2999 search
= fnvlist_alloc();
3001 guid
= strtoull(ppath
, &end
, 0);
3002 if (guid
!= 0 && *end
== '\0') {
3003 fnvlist_add_uint64(search
, ZPOOL_CONFIG_GUID
, guid
);
3005 fnvlist_add_string(search
, ZPOOL_CONFIG_PHYS_PATH
, ppath
);
3008 nvroot
= fnvlist_lookup_nvlist(zhp
->zpool_config
,
3009 ZPOOL_CONFIG_VDEV_TREE
);
3011 *avail_spare
= B_FALSE
;
3015 ret
= vdev_to_nvlist_iter(nvroot
, search
, avail_spare
, l2cache
, log
);
3016 fnvlist_free(search
);
3022 * Determine if we have an "interior" top-level vdev (i.e mirror/raidz).
3025 zpool_vdev_is_interior(const char *name
)
3027 if (strncmp(name
, VDEV_TYPE_RAIDZ
, strlen(VDEV_TYPE_RAIDZ
)) == 0 ||
3028 strncmp(name
, VDEV_TYPE_SPARE
, strlen(VDEV_TYPE_SPARE
)) == 0 ||
3030 VDEV_TYPE_REPLACING
, strlen(VDEV_TYPE_REPLACING
)) == 0 ||
3031 strncmp(name
, VDEV_TYPE_ROOT
, strlen(VDEV_TYPE_ROOT
)) == 0 ||
3032 strncmp(name
, VDEV_TYPE_MIRROR
, strlen(VDEV_TYPE_MIRROR
)) == 0)
3035 if (strncmp(name
, VDEV_TYPE_DRAID
, strlen(VDEV_TYPE_DRAID
)) == 0 &&
3036 !zpool_is_draid_spare(name
))
3043 * Lookup the nvlist for a given vdev.
3046 zpool_find_vdev(zpool_handle_t
*zhp
, const char *path
, boolean_t
*avail_spare
,
3047 boolean_t
*l2cache
, boolean_t
*log
)
3050 nvlist_t
*nvroot
, *search
, *ret
;
3052 boolean_t __avail_spare
, __l2cache
, __log
;
3054 search
= fnvlist_alloc();
3056 guid
= strtoull(path
, &end
, 0);
3057 if (guid
!= 0 && *end
== '\0') {
3058 fnvlist_add_uint64(search
, ZPOOL_CONFIG_GUID
, guid
);
3059 } else if (zpool_vdev_is_interior(path
)) {
3060 fnvlist_add_string(search
, ZPOOL_CONFIG_TYPE
, path
);
3062 fnvlist_add_string(search
, ZPOOL_CONFIG_PATH
, path
);
3065 nvroot
= fnvlist_lookup_nvlist(zhp
->zpool_config
,
3066 ZPOOL_CONFIG_VDEV_TREE
);
3069 * User can pass NULL for avail_spare, l2cache, and log, but
3070 * we still need to provide variables to vdev_to_nvlist_iter(), so
3071 * just point them to junk variables here.
3074 avail_spare
= &__avail_spare
;
3076 l2cache
= &__l2cache
;
3080 *avail_spare
= B_FALSE
;
3084 ret
= vdev_to_nvlist_iter(nvroot
, search
, avail_spare
, l2cache
, log
);
3085 fnvlist_free(search
);
3091 * Convert a vdev path to a GUID. Returns GUID or 0 on error.
3093 * If is_spare, is_l2cache, or is_log is non-NULL, then store within it
3094 * if the VDEV is a spare, l2cache, or log device. If they're NULL then
3098 zpool_vdev_path_to_guid_impl(zpool_handle_t
*zhp
, const char *path
,
3099 boolean_t
*is_spare
, boolean_t
*is_l2cache
, boolean_t
*is_log
)
3101 boolean_t spare
= B_FALSE
, l2cache
= B_FALSE
, log
= B_FALSE
;
3104 if ((tgt
= zpool_find_vdev(zhp
, path
, &spare
, &l2cache
,
3108 if (is_spare
!= NULL
)
3110 if (is_l2cache
!= NULL
)
3111 *is_l2cache
= l2cache
;
3115 return (fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
));
3118 /* Convert a vdev path to a GUID. Returns GUID or 0 on error. */
3120 zpool_vdev_path_to_guid(zpool_handle_t
*zhp
, const char *path
)
3122 return (zpool_vdev_path_to_guid_impl(zhp
, path
, NULL
, NULL
, NULL
));
3126 * Bring the specified vdev online. The 'flags' parameter is a set of the
3127 * ZFS_ONLINE_* flags.
3130 zpool_vdev_online(zpool_handle_t
*zhp
, const char *path
, int flags
,
3131 vdev_state_t
*newstate
)
3133 zfs_cmd_t zc
= {"\0"};
3134 char errbuf
[ERRBUFLEN
];
3136 boolean_t avail_spare
, l2cache
, islog
;
3137 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3139 if (flags
& ZFS_ONLINE_EXPAND
) {
3140 (void) snprintf(errbuf
, sizeof (errbuf
),
3141 dgettext(TEXT_DOMAIN
, "cannot expand %s"), path
);
3143 (void) snprintf(errbuf
, sizeof (errbuf
),
3144 dgettext(TEXT_DOMAIN
, "cannot online %s"), path
);
3147 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3148 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
3150 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3152 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
3154 if (!(flags
& ZFS_ONLINE_SPARE
) && avail_spare
)
3155 return (zfs_error(hdl
, EZFS_ISSPARE
, errbuf
));
3158 const char *pathname
;
3159 if ((flags
& ZFS_ONLINE_EXPAND
||
3160 zpool_get_prop_int(zhp
, ZPOOL_PROP_AUTOEXPAND
, NULL
)) &&
3161 nvlist_lookup_string(tgt
, ZPOOL_CONFIG_PATH
, &pathname
) == 0) {
3162 uint64_t wholedisk
= 0;
3164 (void) nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_WHOLE_DISK
,
3168 * XXX - L2ARC 1.0 devices can't support expansion.
3171 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3172 "cannot expand cache devices"));
3173 return (zfs_error(hdl
, EZFS_VDEVNOTSUP
, errbuf
));
3177 const char *fullpath
= path
;
3178 char buf
[MAXPATHLEN
];
3181 if (path
[0] != '/') {
3182 error
= zfs_resolve_shortname(path
, buf
,
3185 return (zfs_error(hdl
, EZFS_NODEVICE
,
3191 error
= zpool_relabel_disk(hdl
, fullpath
, errbuf
);
3198 zc
.zc_cookie
= VDEV_STATE_ONLINE
;
3201 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SET_STATE
, &zc
) != 0) {
3202 if (errno
== EINVAL
) {
3203 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "was split "
3204 "from this pool into a new one. Use '%s' "
3205 "instead"), "zpool detach");
3206 return (zfs_error(hdl
, EZFS_POSTSPLIT_ONLINE
, errbuf
));
3208 return (zpool_standard_error(hdl
, errno
, errbuf
));
3211 *newstate
= zc
.zc_cookie
;
3216 * Take the specified vdev offline
3219 zpool_vdev_offline(zpool_handle_t
*zhp
, const char *path
, boolean_t istmp
)
3221 zfs_cmd_t zc
= {"\0"};
3222 char errbuf
[ERRBUFLEN
];
3224 boolean_t avail_spare
, l2cache
;
3225 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3227 (void) snprintf(errbuf
, sizeof (errbuf
),
3228 dgettext(TEXT_DOMAIN
, "cannot offline %s"), path
);
3230 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3231 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
3233 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3235 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
3238 return (zfs_error(hdl
, EZFS_ISSPARE
, errbuf
));
3240 zc
.zc_cookie
= VDEV_STATE_OFFLINE
;
3241 zc
.zc_obj
= istmp
? ZFS_OFFLINE_TEMPORARY
: 0;
3243 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SET_STATE
, &zc
) == 0)
3250 * There are no other replicas of this device.
3252 return (zfs_error(hdl
, EZFS_NOREPLICAS
, errbuf
));
3256 * The log device has unplayed logs
3258 return (zfs_error(hdl
, EZFS_UNPLAYED_LOGS
, errbuf
));
3261 return (zpool_standard_error(hdl
, errno
, errbuf
));
3266 * Remove the specified vdev asynchronously from the configuration, so
3267 * that it may come ONLINE if reinserted. This is called from zed on
3268 * Udev remove event.
3269 * Note: We also have a similar function zpool_vdev_remove() that
3270 * removes the vdev from the pool.
3273 zpool_vdev_remove_wanted(zpool_handle_t
*zhp
, const char *path
)
3275 zfs_cmd_t zc
= {"\0"};
3276 char errbuf
[ERRBUFLEN
];
3278 boolean_t avail_spare
, l2cache
;
3279 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3281 (void) snprintf(errbuf
, sizeof (errbuf
),
3282 dgettext(TEXT_DOMAIN
, "cannot remove %s"), path
);
3284 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3285 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
3287 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3289 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
3291 zc
.zc_cookie
= VDEV_STATE_REMOVED
;
3293 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SET_STATE
, &zc
) == 0)
3296 return (zpool_standard_error(hdl
, errno
, errbuf
));
3300 * Mark the given vdev faulted.
3303 zpool_vdev_fault(zpool_handle_t
*zhp
, uint64_t guid
, vdev_aux_t aux
)
3305 zfs_cmd_t zc
= {"\0"};
3306 char errbuf
[ERRBUFLEN
];
3307 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3309 (void) snprintf(errbuf
, sizeof (errbuf
),
3310 dgettext(TEXT_DOMAIN
, "cannot fault %llu"), (u_longlong_t
)guid
);
3312 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3314 zc
.zc_cookie
= VDEV_STATE_FAULTED
;
3317 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SET_STATE
, &zc
) == 0)
3324 * There are no other replicas of this device.
3326 return (zfs_error(hdl
, EZFS_NOREPLICAS
, errbuf
));
3329 return (zpool_standard_error(hdl
, errno
, errbuf
));
3335 * Generic set vdev state function
3338 zpool_vdev_set_state(zpool_handle_t
*zhp
, uint64_t guid
, vdev_aux_t aux
,
3341 zfs_cmd_t zc
= {"\0"};
3342 char errbuf
[ERRBUFLEN
];
3343 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3345 (void) snprintf(errbuf
, sizeof (errbuf
),
3346 dgettext(TEXT_DOMAIN
, "cannot set %s %llu"),
3347 zpool_state_to_name(state
, aux
), (u_longlong_t
)guid
);
3349 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3351 zc
.zc_cookie
= state
;
3354 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SET_STATE
, &zc
) == 0)
3357 return (zpool_standard_error(hdl
, errno
, errbuf
));
3361 * Mark the given vdev degraded.
3364 zpool_vdev_degrade(zpool_handle_t
*zhp
, uint64_t guid
, vdev_aux_t aux
)
3366 return (zpool_vdev_set_state(zhp
, guid
, aux
, VDEV_STATE_DEGRADED
));
3370 * Mark the given vdev as in a removed state (as if the device does not exist).
3372 * This is different than zpool_vdev_remove() which does a removal of a device
3373 * from the pool (but the device does exist).
3376 zpool_vdev_set_removed_state(zpool_handle_t
*zhp
, uint64_t guid
, vdev_aux_t aux
)
3378 return (zpool_vdev_set_state(zhp
, guid
, aux
, VDEV_STATE_REMOVED
));
3382 * Returns TRUE if the given nvlist is a vdev that was originally swapped in as
3386 is_replacing_spare(nvlist_t
*search
, nvlist_t
*tgt
, int which
)
3391 if (nvlist_lookup_nvlist_array(search
, ZPOOL_CONFIG_CHILDREN
, &child
,
3393 const char *type
= fnvlist_lookup_string(search
,
3395 if ((strcmp(type
, VDEV_TYPE_SPARE
) == 0 ||
3396 strcmp(type
, VDEV_TYPE_DRAID_SPARE
) == 0) &&
3397 children
== 2 && child
[which
] == tgt
)
3400 for (c
= 0; c
< children
; c
++)
3401 if (is_replacing_spare(child
[c
], tgt
, which
))
3409 * Attach new_disk (fully described by nvroot) to old_disk.
3410 * If 'replacing' is specified, the new disk will replace the old one.
3413 zpool_vdev_attach(zpool_handle_t
*zhp
, const char *old_disk
,
3414 const char *new_disk
, nvlist_t
*nvroot
, int replacing
, boolean_t rebuild
)
3416 zfs_cmd_t zc
= {"\0"};
3417 char errbuf
[ERRBUFLEN
];
3420 boolean_t avail_spare
, l2cache
, islog
;
3426 nvlist_t
*config_root
;
3427 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3430 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3431 "cannot replace %s with %s"), old_disk
, new_disk
);
3433 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3434 "cannot attach %s to %s"), new_disk
, old_disk
);
3436 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3437 if ((tgt
= zpool_find_vdev(zhp
, old_disk
, &avail_spare
, &l2cache
,
3439 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3442 return (zfs_error(hdl
, EZFS_ISSPARE
, errbuf
));
3445 return (zfs_error(hdl
, EZFS_ISL2CACHE
, errbuf
));
3447 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
3448 zc
.zc_cookie
= replacing
;
3449 zc
.zc_simple
= rebuild
;
3452 zfeature_lookup_guid("org.openzfs:device_rebuild", NULL
) != 0) {
3453 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3454 "the loaded zfs module doesn't support device rebuilds"));
3455 return (zfs_error(hdl
, EZFS_POOL_NOTSUP
, errbuf
));
3458 type
= fnvlist_lookup_string(tgt
, ZPOOL_CONFIG_TYPE
);
3459 if (strcmp(type
, VDEV_TYPE_RAIDZ
) == 0 &&
3460 zfeature_lookup_guid("org.openzfs:raidz_expansion", NULL
) != 0) {
3461 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3462 "the loaded zfs module doesn't support raidz expansion"));
3463 return (zfs_error(hdl
, EZFS_POOL_NOTSUP
, errbuf
));
3466 if (nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_CHILDREN
,
3467 &child
, &children
) != 0 || children
!= 1) {
3468 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3469 "new device must be a single disk"));
3470 return (zfs_error(hdl
, EZFS_INVALCONFIG
, errbuf
));
3473 config_root
= fnvlist_lookup_nvlist(zpool_get_config(zhp
, NULL
),
3474 ZPOOL_CONFIG_VDEV_TREE
);
3476 if ((newname
= zpool_vdev_name(NULL
, NULL
, child
[0], 0)) == NULL
)
3480 * If the target is a hot spare that has been swapped in, we can only
3481 * replace it with another hot spare.
3484 nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_IS_SPARE
, &val
) == 0 &&
3485 (zpool_find_vdev(zhp
, newname
, &avail_spare
, &l2cache
,
3486 NULL
) == NULL
|| !avail_spare
) &&
3487 is_replacing_spare(config_root
, tgt
, 1)) {
3488 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3489 "can only be replaced by another hot spare"));
3491 return (zfs_error(hdl
, EZFS_BADTARGET
, errbuf
));
3496 zcmd_write_conf_nvlist(hdl
, &zc
, nvroot
);
3498 ret
= zfs_ioctl(hdl
, ZFS_IOC_VDEV_ATTACH
, &zc
);
3500 zcmd_free_nvlists(&zc
);
3508 * Can't attach to or replace this type of vdev.
3511 uint64_t version
= zpool_get_prop_int(zhp
,
3512 ZPOOL_PROP_VERSION
, NULL
);
3515 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3516 "cannot replace a log with a spare"));
3517 } else if (rebuild
) {
3518 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3519 "only mirror and dRAID vdevs support "
3520 "sequential reconstruction"));
3521 } else if (zpool_is_draid_spare(new_disk
)) {
3522 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3523 "dRAID spares can only replace child "
3524 "devices in their parent's dRAID vdev"));
3525 } else if (version
>= SPA_VERSION_MULTI_REPLACE
) {
3526 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3527 "already in replacing/spare config; wait "
3528 "for completion or use 'zpool detach'"));
3530 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3531 "cannot replace a replacing device"));
3533 } else if (strcmp(type
, VDEV_TYPE_RAIDZ
) == 0) {
3534 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3535 "raidz_expansion feature must be enabled "
3536 "in order to attach a device to raidz"));
3538 char status
[64] = {0};
3539 zpool_prop_get_feature(zhp
,
3540 "feature@device_rebuild", status
, 63);
3542 strncmp(status
, ZFS_FEATURE_DISABLED
, 64) == 0) {
3543 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3544 "device_rebuild feature must be enabled "
3545 "in order to use sequential "
3548 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3549 "can only attach to mirrors and top-level "
3553 (void) zfs_error(hdl
, EZFS_BADTARGET
, errbuf
);
3558 * The new device must be a single disk.
3560 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3561 "new device must be a single disk"));
3562 (void) zfs_error(hdl
, EZFS_INVALCONFIG
, errbuf
);
3566 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "%s is busy"),
3568 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
3573 * The new device is too small.
3575 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3576 "device is too small"));
3577 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
3582 * The new device has a different optimal sector size.
3584 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3585 "new device has a different optimal sector size; use the "
3586 "option '-o ashift=N' to override the optimal size"));
3587 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
3592 * The resulting top-level vdev spec won't fit in the label.
3594 (void) zfs_error(hdl
, EZFS_DEVOVERFLOW
, errbuf
);
3599 * The existing raidz vdev has offline children
3601 if (strcmp(type
, VDEV_TYPE_RAIDZ
) == 0) {
3602 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3603 "raidz vdev has devices that are are offline or "
3605 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
3608 (void) zpool_standard_error(hdl
, errno
, errbuf
);
3614 * The boot reserved area is already being used (FreeBSD)
3616 if (strcmp(type
, VDEV_TYPE_RAIDZ
) == 0) {
3617 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3618 "the reserved boot area needed for the expansion "
3619 "is already being used by a boot loader"));
3620 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
3622 (void) zpool_standard_error(hdl
, errno
, errbuf
);
3626 (void) zpool_standard_error(hdl
, errno
, errbuf
);
3633 * Detach the specified device.
3636 zpool_vdev_detach(zpool_handle_t
*zhp
, const char *path
)
3638 zfs_cmd_t zc
= {"\0"};
3639 char errbuf
[ERRBUFLEN
];
3641 boolean_t avail_spare
, l2cache
;
3642 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3644 (void) snprintf(errbuf
, sizeof (errbuf
),
3645 dgettext(TEXT_DOMAIN
, "cannot detach %s"), path
);
3647 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3648 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
3650 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3653 return (zfs_error(hdl
, EZFS_ISSPARE
, errbuf
));
3656 return (zfs_error(hdl
, EZFS_ISL2CACHE
, errbuf
));
3658 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
3660 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_DETACH
, &zc
) == 0)
3667 * Can't detach from this type of vdev.
3669 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "only "
3670 "applicable to mirror and replacing vdevs"));
3671 (void) zfs_error(hdl
, EZFS_BADTARGET
, errbuf
);
3676 * There are no other replicas of this device.
3678 (void) zfs_error(hdl
, EZFS_NOREPLICAS
, errbuf
);
3682 (void) zpool_standard_error(hdl
, errno
, errbuf
);
3689 * Find a mirror vdev in the source nvlist.
3691 * The mchild array contains a list of disks in one of the top-level mirrors
3692 * of the source pool. The schild array contains a list of disks that the
3693 * user specified on the command line. We loop over the mchild array to
3694 * see if any entry in the schild array matches.
3696 * If a disk in the mchild array is found in the schild array, we return
3697 * the index of that entry. Otherwise we return -1.
3700 find_vdev_entry(zpool_handle_t
*zhp
, nvlist_t
**mchild
, uint_t mchildren
,
3701 nvlist_t
**schild
, uint_t schildren
)
3705 for (mc
= 0; mc
< mchildren
; mc
++) {
3707 char *mpath
= zpool_vdev_name(zhp
->zpool_hdl
, zhp
,
3710 for (sc
= 0; sc
< schildren
; sc
++) {
3711 char *spath
= zpool_vdev_name(zhp
->zpool_hdl
, zhp
,
3713 boolean_t result
= (strcmp(mpath
, spath
) == 0);
3729 * Split a mirror pool. If newroot points to null, then a new nvlist
3730 * is generated and it is the responsibility of the caller to free it.
3733 zpool_vdev_split(zpool_handle_t
*zhp
, char *newname
, nvlist_t
**newroot
,
3734 nvlist_t
*props
, splitflags_t flags
)
3736 zfs_cmd_t zc
= {"\0"};
3737 char errbuf
[ERRBUFLEN
];
3739 nvlist_t
*tree
, *config
, **child
, **newchild
, *newconfig
= NULL
;
3740 nvlist_t
**varray
= NULL
, *zc_props
= NULL
;
3741 uint_t c
, children
, newchildren
, lastlog
= 0, vcount
, found
= 0;
3742 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3743 uint64_t vers
, readonly
= B_FALSE
;
3744 boolean_t freelist
= B_FALSE
, memory_err
= B_TRUE
;
3747 (void) snprintf(errbuf
, sizeof (errbuf
),
3748 dgettext(TEXT_DOMAIN
, "Unable to split %s"), zhp
->zpool_name
);
3750 if (!zpool_name_valid(hdl
, B_FALSE
, newname
))
3751 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3753 if ((config
= zpool_get_config(zhp
, NULL
)) == NULL
) {
3754 (void) fprintf(stderr
, gettext("Internal error: unable to "
3755 "retrieve pool configuration\n"));
3759 tree
= fnvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
);
3760 vers
= fnvlist_lookup_uint64(config
, ZPOOL_CONFIG_VERSION
);
3763 prop_flags_t flags
= { .create
= B_FALSE
, .import
= B_TRUE
};
3764 if ((zc_props
= zpool_valid_proplist(hdl
, zhp
->zpool_name
,
3765 props
, vers
, flags
, errbuf
)) == NULL
)
3767 (void) nvlist_lookup_uint64(zc_props
,
3768 zpool_prop_to_name(ZPOOL_PROP_READONLY
), &readonly
);
3770 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3771 "property %s can only be set at import time"),
3772 zpool_prop_to_name(ZPOOL_PROP_READONLY
));
3777 if (nvlist_lookup_nvlist_array(tree
, ZPOOL_CONFIG_CHILDREN
, &child
,
3779 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3780 "Source pool is missing vdev tree"));
3781 nvlist_free(zc_props
);
3785 varray
= zfs_alloc(hdl
, children
* sizeof (nvlist_t
*));
3788 if (*newroot
== NULL
||
3789 nvlist_lookup_nvlist_array(*newroot
, ZPOOL_CONFIG_CHILDREN
,
3790 &newchild
, &newchildren
) != 0)
3793 for (c
= 0; c
< children
; c
++) {
3794 uint64_t is_log
= B_FALSE
, is_hole
= B_FALSE
;
3795 boolean_t is_special
= B_FALSE
, is_dedup
= B_FALSE
;
3797 nvlist_t
**mchild
, *vdev
;
3802 * Unlike cache & spares, slogs are stored in the
3803 * ZPOOL_CONFIG_CHILDREN array. We filter them out here.
3805 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_LOG
,
3807 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_HOLE
,
3809 if (is_log
|| is_hole
) {
3811 * Create a hole vdev and put it in the config.
3813 if (nvlist_alloc(&vdev
, NV_UNIQUE_NAME
, 0) != 0)
3815 if (nvlist_add_string(vdev
, ZPOOL_CONFIG_TYPE
,
3816 VDEV_TYPE_HOLE
) != 0)
3818 if (nvlist_add_uint64(vdev
, ZPOOL_CONFIG_IS_HOLE
,
3823 varray
[vcount
++] = vdev
;
3827 type
= fnvlist_lookup_string(child
[c
], ZPOOL_CONFIG_TYPE
);
3829 if (strcmp(type
, VDEV_TYPE_INDIRECT
) == 0) {
3831 if (nvlist_dup(vdev
, &varray
[vcount
++], 0) != 0)
3834 } else if (strcmp(type
, VDEV_TYPE_MIRROR
) != 0) {
3835 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3836 "Source pool must be composed only of mirrors\n"));
3837 retval
= zfs_error(hdl
, EZFS_INVALCONFIG
, errbuf
);
3841 if (nvlist_lookup_string(child
[c
],
3842 ZPOOL_CONFIG_ALLOCATION_BIAS
, &bias
) == 0) {
3843 if (strcmp(bias
, VDEV_ALLOC_BIAS_SPECIAL
) == 0)
3844 is_special
= B_TRUE
;
3845 else if (strcmp(bias
, VDEV_ALLOC_BIAS_DEDUP
) == 0)
3848 verify(nvlist_lookup_nvlist_array(child
[c
],
3849 ZPOOL_CONFIG_CHILDREN
, &mchild
, &mchildren
) == 0);
3851 /* find or add an entry for this top-level vdev */
3852 if (newchildren
> 0 &&
3853 (entry
= find_vdev_entry(zhp
, mchild
, mchildren
,
3854 newchild
, newchildren
)) >= 0) {
3855 /* We found a disk that the user specified. */
3856 vdev
= mchild
[entry
];
3859 /* User didn't specify a disk for this vdev. */
3860 vdev
= mchild
[mchildren
- 1];
3863 if (nvlist_dup(vdev
, &varray
[vcount
++], 0) != 0)
3866 if (flags
.dryrun
!= 0) {
3867 if (is_dedup
== B_TRUE
) {
3868 if (nvlist_add_string(varray
[vcount
- 1],
3869 ZPOOL_CONFIG_ALLOCATION_BIAS
,
3870 VDEV_ALLOC_BIAS_DEDUP
) != 0)
3872 } else if (is_special
== B_TRUE
) {
3873 if (nvlist_add_string(varray
[vcount
- 1],
3874 ZPOOL_CONFIG_ALLOCATION_BIAS
,
3875 VDEV_ALLOC_BIAS_SPECIAL
) != 0)
3881 /* did we find every disk the user specified? */
3882 if (found
!= newchildren
) {
3883 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "Device list must "
3884 "include at most one disk from each mirror"));
3885 retval
= zfs_error(hdl
, EZFS_INVALCONFIG
, errbuf
);
3889 /* Prepare the nvlist for populating. */
3890 if (*newroot
== NULL
) {
3891 if (nvlist_alloc(newroot
, NV_UNIQUE_NAME
, 0) != 0)
3894 if (nvlist_add_string(*newroot
, ZPOOL_CONFIG_TYPE
,
3895 VDEV_TYPE_ROOT
) != 0)
3898 verify(nvlist_remove_all(*newroot
, ZPOOL_CONFIG_CHILDREN
) == 0);
3901 /* Add all the children we found */
3902 if (nvlist_add_nvlist_array(*newroot
, ZPOOL_CONFIG_CHILDREN
,
3903 (const nvlist_t
**)varray
, lastlog
== 0 ? vcount
: lastlog
) != 0)
3907 * If we're just doing a dry run, exit now with success.
3910 memory_err
= B_FALSE
;
3915 /* now build up the config list & call the ioctl */
3916 if (nvlist_alloc(&newconfig
, NV_UNIQUE_NAME
, 0) != 0)
3919 if (nvlist_add_nvlist(newconfig
,
3920 ZPOOL_CONFIG_VDEV_TREE
, *newroot
) != 0 ||
3921 nvlist_add_string(newconfig
,
3922 ZPOOL_CONFIG_POOL_NAME
, newname
) != 0 ||
3923 nvlist_add_uint64(newconfig
, ZPOOL_CONFIG_VERSION
, vers
) != 0)
3927 * The new pool is automatically part of the namespace unless we
3928 * explicitly export it.
3931 zc
.zc_cookie
= ZPOOL_EXPORT_AFTER_SPLIT
;
3932 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3933 (void) strlcpy(zc
.zc_string
, newname
, sizeof (zc
.zc_string
));
3934 zcmd_write_conf_nvlist(hdl
, &zc
, newconfig
);
3935 if (zc_props
!= NULL
)
3936 zcmd_write_src_nvlist(hdl
, &zc
, zc_props
);
3938 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SPLIT
, &zc
) != 0) {
3939 retval
= zpool_standard_error(hdl
, errno
, errbuf
);
3944 memory_err
= B_FALSE
;
3947 if (varray
!= NULL
) {
3950 for (v
= 0; v
< vcount
; v
++)
3951 nvlist_free(varray
[v
]);
3954 zcmd_free_nvlists(&zc
);
3955 nvlist_free(zc_props
);
3956 nvlist_free(newconfig
);
3958 nvlist_free(*newroot
);
3966 return (no_memory(hdl
));
3972 * Remove the given device.
3975 zpool_vdev_remove(zpool_handle_t
*zhp
, const char *path
)
3977 zfs_cmd_t zc
= {"\0"};
3978 char errbuf
[ERRBUFLEN
];
3980 boolean_t avail_spare
, l2cache
, islog
;
3981 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3984 (void) snprintf(errbuf
, sizeof (errbuf
),
3985 dgettext(TEXT_DOMAIN
, "cannot remove %s"), path
);
3987 if (zpool_is_draid_spare(path
)) {
3988 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3989 "dRAID spares cannot be removed"));
3990 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3993 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3994 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
3996 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3998 version
= zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
);
3999 if (islog
&& version
< SPA_VERSION_HOLES
) {
4000 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4001 "pool must be upgraded to support log removal"));
4002 return (zfs_error(hdl
, EZFS_BADVERSION
, errbuf
));
4005 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
4007 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_REMOVE
, &zc
) == 0)
4013 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4014 "removal for this vdev is already in progress."));
4015 (void) zfs_error(hdl
, EZFS_BUSY
, errbuf
);
4019 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4020 "invalid config; all top-level vdevs must "
4021 "have the same sector size and not be raidz."));
4022 (void) zfs_error(hdl
, EZFS_INVALCONFIG
, errbuf
);
4027 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4028 "Mount encrypted datasets to replay logs."));
4030 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4031 "Pool busy; removal may already be in progress"));
4033 (void) zfs_error(hdl
, EZFS_BUSY
, errbuf
);
4038 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4039 "Mount encrypted datasets to replay logs."));
4040 (void) zfs_error(hdl
, EZFS_BUSY
, errbuf
);
4042 (void) zpool_standard_error(hdl
, errno
, errbuf
);
4047 (void) zpool_standard_error(hdl
, errno
, errbuf
);
4053 zpool_vdev_remove_cancel(zpool_handle_t
*zhp
)
4055 zfs_cmd_t zc
= {{0}};
4056 char errbuf
[ERRBUFLEN
];
4057 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4059 (void) snprintf(errbuf
, sizeof (errbuf
),
4060 dgettext(TEXT_DOMAIN
, "cannot cancel removal"));
4062 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
4065 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_REMOVE
, &zc
) == 0)
4068 return (zpool_standard_error(hdl
, errno
, errbuf
));
4072 zpool_vdev_indirect_size(zpool_handle_t
*zhp
, const char *path
,
4075 char errbuf
[ERRBUFLEN
];
4077 boolean_t avail_spare
, l2cache
, islog
;
4078 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4080 (void) snprintf(errbuf
, sizeof (errbuf
),
4081 dgettext(TEXT_DOMAIN
, "cannot determine indirect size of %s"),
4084 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
4086 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
4088 if (avail_spare
|| l2cache
|| islog
) {
4093 if (nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_INDIRECT_SIZE
, sizep
) != 0) {
4094 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4095 "indirect size not available"));
4096 return (zfs_error(hdl
, EINVAL
, errbuf
));
4102 * Clear the errors for the pool, or the particular device if specified.
4105 zpool_clear(zpool_handle_t
*zhp
, const char *path
, nvlist_t
*rewindnvl
)
4107 zfs_cmd_t zc
= {"\0"};
4108 char errbuf
[ERRBUFLEN
];
4110 zpool_load_policy_t policy
;
4111 boolean_t avail_spare
, l2cache
;
4112 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4113 nvlist_t
*nvi
= NULL
;
4117 (void) snprintf(errbuf
, sizeof (errbuf
),
4118 dgettext(TEXT_DOMAIN
, "cannot clear errors for %s"),
4121 (void) snprintf(errbuf
, sizeof (errbuf
),
4122 dgettext(TEXT_DOMAIN
, "cannot clear errors for %s"),
4125 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
4127 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
,
4128 &l2cache
, NULL
)) == NULL
)
4129 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
4132 * Don't allow error clearing for hot spares. Do allow
4133 * error clearing for l2cache devices.
4136 return (zfs_error(hdl
, EZFS_ISSPARE
, errbuf
));
4138 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
4141 zpool_get_load_policy(rewindnvl
, &policy
);
4142 zc
.zc_cookie
= policy
.zlp_rewind
;
4144 zcmd_alloc_dst_nvlist(hdl
, &zc
, zhp
->zpool_config_size
* 2);
4145 zcmd_write_src_nvlist(hdl
, &zc
, rewindnvl
);
4147 while ((error
= zfs_ioctl(hdl
, ZFS_IOC_CLEAR
, &zc
)) != 0 &&
4149 zcmd_expand_dst_nvlist(hdl
, &zc
);
4151 if (!error
|| ((policy
.zlp_rewind
& ZPOOL_TRY_REWIND
) &&
4152 errno
!= EPERM
&& errno
!= EACCES
)) {
4153 if (policy
.zlp_rewind
&
4154 (ZPOOL_DO_REWIND
| ZPOOL_TRY_REWIND
)) {
4155 (void) zcmd_read_dst_nvlist(hdl
, &zc
, &nvi
);
4156 zpool_rewind_exclaim(hdl
, zc
.zc_name
,
4157 ((policy
.zlp_rewind
& ZPOOL_TRY_REWIND
) != 0),
4161 zcmd_free_nvlists(&zc
);
4165 zcmd_free_nvlists(&zc
);
4166 return (zpool_standard_error(hdl
, errno
, errbuf
));
4170 * Similar to zpool_clear(), but takes a GUID (used by fmd).
4173 zpool_vdev_clear(zpool_handle_t
*zhp
, uint64_t guid
)
4175 zfs_cmd_t zc
= {"\0"};
4176 char errbuf
[ERRBUFLEN
];
4177 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4179 (void) snprintf(errbuf
, sizeof (errbuf
),
4180 dgettext(TEXT_DOMAIN
, "cannot clear errors for %llx"),
4181 (u_longlong_t
)guid
);
4183 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
4185 zc
.zc_cookie
= ZPOOL_NO_REWIND
;
4187 if (zfs_ioctl(hdl
, ZFS_IOC_CLEAR
, &zc
) == 0)
4190 return (zpool_standard_error(hdl
, errno
, errbuf
));
4194 * Change the GUID for a pool.
4197 zpool_reguid(zpool_handle_t
*zhp
)
4199 char errbuf
[ERRBUFLEN
];
4200 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4201 zfs_cmd_t zc
= {"\0"};
4203 (void) snprintf(errbuf
, sizeof (errbuf
),
4204 dgettext(TEXT_DOMAIN
, "cannot reguid '%s'"), zhp
->zpool_name
);
4206 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
4207 if (zfs_ioctl(hdl
, ZFS_IOC_POOL_REGUID
, &zc
) == 0)
4210 return (zpool_standard_error(hdl
, errno
, errbuf
));
4217 zpool_reopen_one(zpool_handle_t
*zhp
, void *data
)
4219 libzfs_handle_t
*hdl
= zpool_get_handle(zhp
);
4220 const char *pool_name
= zpool_get_name(zhp
);
4221 boolean_t
*scrub_restart
= data
;
4224 error
= lzc_reopen(pool_name
, *scrub_restart
);
4226 return (zpool_standard_error_fmt(hdl
, error
,
4227 dgettext(TEXT_DOMAIN
, "cannot reopen '%s'"), pool_name
));
4233 /* call into libzfs_core to execute the sync IOCTL per pool */
4235 zpool_sync_one(zpool_handle_t
*zhp
, void *data
)
4238 libzfs_handle_t
*hdl
= zpool_get_handle(zhp
);
4239 const char *pool_name
= zpool_get_name(zhp
);
4240 boolean_t
*force
= data
;
4241 nvlist_t
*innvl
= fnvlist_alloc();
4243 fnvlist_add_boolean_value(innvl
, "force", *force
);
4244 if ((ret
= lzc_sync(pool_name
, innvl
, NULL
)) != 0) {
4246 return (zpool_standard_error_fmt(hdl
, ret
,
4247 dgettext(TEXT_DOMAIN
, "sync '%s' failed"), pool_name
));
4254 #define PATH_BUF_LEN 64
4257 * Given a vdev, return the name to display in iostat. If the vdev has a path,
4258 * we use that, stripping off any leading "/dev/dsk/"; if not, we use the type.
4259 * We also check if this is a whole disk, in which case we strip off the
4260 * trailing 's0' slice name.
4262 * This routine is also responsible for identifying when disks have been
4263 * reconfigured in a new location. The kernel will have opened the device by
4264 * devid, but the path will still refer to the old location. To catch this, we
4265 * first do a path -> devid translation (which is fast for the common case). If
4266 * the devid matches, we're done. If not, we do a reverse devid -> path
4267 * translation and issue the appropriate ioctl() to update the path of the vdev.
4268 * If 'zhp' is NULL, then this is an exported pool, and we don't need to do any
4272 zpool_vdev_name(libzfs_handle_t
*hdl
, zpool_handle_t
*zhp
, nvlist_t
*nv
,
4275 const char *type
, *tpath
;
4278 char buf
[PATH_BUF_LEN
];
4279 char tmpbuf
[PATH_BUF_LEN
* 2];
4282 * vdev_name will be "root"/"root-0" for the root vdev, but it is the
4283 * zpool name that will be displayed to the user.
4285 type
= fnvlist_lookup_string(nv
, ZPOOL_CONFIG_TYPE
);
4286 if (zhp
!= NULL
&& strcmp(type
, "root") == 0)
4287 return (zfs_strdup(hdl
, zpool_get_name(zhp
)));
4289 if (libzfs_envvar_is_set("ZPOOL_VDEV_NAME_PATH"))
4290 name_flags
|= VDEV_NAME_PATH
;
4291 if (libzfs_envvar_is_set("ZPOOL_VDEV_NAME_GUID"))
4292 name_flags
|= VDEV_NAME_GUID
;
4293 if (libzfs_envvar_is_set("ZPOOL_VDEV_NAME_FOLLOW_LINKS"))
4294 name_flags
|= VDEV_NAME_FOLLOW_LINKS
;
4296 if (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_NOT_PRESENT
, &value
) == 0 ||
4297 name_flags
& VDEV_NAME_GUID
) {
4298 (void) nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_GUID
, &value
);
4299 (void) snprintf(buf
, sizeof (buf
), "%llu", (u_longlong_t
)value
);
4301 } else if (nvlist_lookup_string(nv
, ZPOOL_CONFIG_PATH
, &tpath
) == 0) {
4304 if (name_flags
& VDEV_NAME_FOLLOW_LINKS
) {
4305 char *rp
= realpath(path
, NULL
);
4307 strlcpy(buf
, rp
, sizeof (buf
));
4314 * For a block device only use the name.
4316 if ((strcmp(type
, VDEV_TYPE_DISK
) == 0) &&
4317 !(name_flags
& VDEV_NAME_PATH
)) {
4318 path
= zfs_strip_path(path
);
4322 * Remove the partition from the path if this is a whole disk.
4324 if (strcmp(type
, VDEV_TYPE_DRAID_SPARE
) != 0 &&
4325 nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_WHOLE_DISK
, &value
)
4326 == 0 && value
&& !(name_flags
& VDEV_NAME_PATH
)) {
4327 return (zfs_strip_partition(path
));
4333 * If it's a raidz device, we need to stick in the parity level.
4335 if (strcmp(path
, VDEV_TYPE_RAIDZ
) == 0) {
4336 value
= fnvlist_lookup_uint64(nv
, ZPOOL_CONFIG_NPARITY
);
4337 (void) snprintf(buf
, sizeof (buf
), "%s%llu", path
,
4338 (u_longlong_t
)value
);
4343 * If it's a dRAID device, we add parity, groups, and spares.
4345 if (strcmp(path
, VDEV_TYPE_DRAID
) == 0) {
4346 uint64_t ndata
, nparity
, nspares
;
4350 verify(nvlist_lookup_nvlist_array(nv
,
4351 ZPOOL_CONFIG_CHILDREN
, &child
, &children
) == 0);
4352 nparity
= fnvlist_lookup_uint64(nv
,
4353 ZPOOL_CONFIG_NPARITY
);
4354 ndata
= fnvlist_lookup_uint64(nv
,
4355 ZPOOL_CONFIG_DRAID_NDATA
);
4356 nspares
= fnvlist_lookup_uint64(nv
,
4357 ZPOOL_CONFIG_DRAID_NSPARES
);
4359 path
= zpool_draid_name(buf
, sizeof (buf
), ndata
,
4360 nparity
, nspares
, children
);
4364 * We identify each top-level vdev by using a <type-id>
4365 * naming convention.
4367 if (name_flags
& VDEV_NAME_TYPE_ID
) {
4368 uint64_t id
= fnvlist_lookup_uint64(nv
,
4370 (void) snprintf(tmpbuf
, sizeof (tmpbuf
), "%s-%llu",
4371 path
, (u_longlong_t
)id
);
4376 return (zfs_strdup(hdl
, path
));
4380 zbookmark_mem_compare(const void *a
, const void *b
)
4382 return (memcmp(a
, b
, sizeof (zbookmark_phys_t
)));
4386 * Retrieve the persistent error log, uniquify the members, and return to the
4390 zpool_get_errlog(zpool_handle_t
*zhp
, nvlist_t
**nverrlistp
)
4392 zfs_cmd_t zc
= {"\0"};
4393 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4394 zbookmark_phys_t
*buf
;
4395 uint64_t buflen
= 10000; /* approx. 1MB of RAM */
4397 if (fnvlist_lookup_uint64(zhp
->zpool_config
,
4398 ZPOOL_CONFIG_ERRCOUNT
) == 0)
4402 * Retrieve the raw error list from the kernel. If it doesn't fit,
4403 * allocate a larger buffer and retry.
4405 (void) strcpy(zc
.zc_name
, zhp
->zpool_name
);
4407 buf
= zfs_alloc(zhp
->zpool_hdl
,
4408 buflen
* sizeof (zbookmark_phys_t
));
4409 zc
.zc_nvlist_dst
= (uintptr_t)buf
;
4410 zc
.zc_nvlist_dst_size
= buflen
;
4411 if (zfs_ioctl(zhp
->zpool_hdl
, ZFS_IOC_ERROR_LOG
,
4414 if (errno
== ENOMEM
) {
4417 return (zpool_standard_error_fmt(hdl
, errno
,
4418 dgettext(TEXT_DOMAIN
, "errors: List of "
4419 "errors unavailable")));
4427 * Sort the resulting bookmarks. This is a little confusing due to the
4428 * implementation of ZFS_IOC_ERROR_LOG. The bookmarks are copied last
4429 * to first, and 'zc_nvlist_dst_size' indicates the number of bookmarks
4430 * _not_ copied as part of the process. So we point the start of our
4431 * array appropriate and decrement the total number of elements.
4433 zbookmark_phys_t
*zb
= buf
+ zc
.zc_nvlist_dst_size
;
4434 uint64_t zblen
= buflen
- zc
.zc_nvlist_dst_size
;
4436 qsort(zb
, zblen
, sizeof (zbookmark_phys_t
), zbookmark_mem_compare
);
4438 verify(nvlist_alloc(nverrlistp
, 0, KM_SLEEP
) == 0);
4441 * Fill in the nverrlistp with nvlist's of dataset and object numbers.
4443 for (uint64_t i
= 0; i
< zblen
; i
++) {
4446 /* ignoring zb_blkid and zb_level for now */
4447 if (i
> 0 && zb
[i
-1].zb_objset
== zb
[i
].zb_objset
&&
4448 zb
[i
-1].zb_object
== zb
[i
].zb_object
)
4451 if (nvlist_alloc(&nv
, NV_UNIQUE_NAME
, KM_SLEEP
) != 0)
4453 if (nvlist_add_uint64(nv
, ZPOOL_ERR_DATASET
,
4454 zb
[i
].zb_objset
) != 0) {
4458 if (nvlist_add_uint64(nv
, ZPOOL_ERR_OBJECT
,
4459 zb
[i
].zb_object
) != 0) {
4463 if (nvlist_add_nvlist(*nverrlistp
, "ejk", nv
) != 0) {
4475 return (no_memory(zhp
->zpool_hdl
));
4479 * Upgrade a ZFS pool to the latest on-disk version.
4482 zpool_upgrade(zpool_handle_t
*zhp
, uint64_t new_version
)
4484 zfs_cmd_t zc
= {"\0"};
4485 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4487 (void) strcpy(zc
.zc_name
, zhp
->zpool_name
);
4488 zc
.zc_cookie
= new_version
;
4490 if (zfs_ioctl(hdl
, ZFS_IOC_POOL_UPGRADE
, &zc
) != 0)
4491 return (zpool_standard_error_fmt(hdl
, errno
,
4492 dgettext(TEXT_DOMAIN
, "cannot upgrade '%s'"),
4498 zfs_save_arguments(int argc
, char **argv
, char *string
, int len
)
4502 (void) strlcpy(string
, zfs_basename(argv
[0]), len
);
4503 for (i
= 1; i
< argc
; i
++) {
4504 (void) strlcat(string
, " ", len
);
4505 (void) strlcat(string
, argv
[i
], len
);
4510 zpool_log_history(libzfs_handle_t
*hdl
, const char *message
)
4512 zfs_cmd_t zc
= {"\0"};
4515 args
= fnvlist_alloc();
4516 fnvlist_add_string(args
, "message", message
);
4517 zcmd_write_src_nvlist(hdl
, &zc
, args
);
4518 int err
= zfs_ioctl(hdl
, ZFS_IOC_LOG_HISTORY
, &zc
);
4520 zcmd_free_nvlists(&zc
);
4525 * Perform ioctl to get some command history of a pool.
4527 * 'buf' is the buffer to fill up to 'len' bytes. 'off' is the
4528 * logical offset of the history buffer to start reading from.
4530 * Upon return, 'off' is the next logical offset to read from and
4531 * 'len' is the actual amount of bytes read into 'buf'.
4534 get_history(zpool_handle_t
*zhp
, char *buf
, uint64_t *off
, uint64_t *len
)
4536 zfs_cmd_t zc
= {"\0"};
4537 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4539 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
4541 zc
.zc_history
= (uint64_t)(uintptr_t)buf
;
4542 zc
.zc_history_len
= *len
;
4543 zc
.zc_history_offset
= *off
;
4545 if (zfs_ioctl(hdl
, ZFS_IOC_POOL_GET_HISTORY
, &zc
) != 0) {
4548 return (zfs_error_fmt(hdl
, EZFS_PERM
,
4549 dgettext(TEXT_DOMAIN
,
4550 "cannot show history for pool '%s'"),
4553 return (zfs_error_fmt(hdl
, EZFS_NOHISTORY
,
4554 dgettext(TEXT_DOMAIN
, "cannot get history for pool "
4555 "'%s'"), zhp
->zpool_name
));
4557 return (zfs_error_fmt(hdl
, EZFS_BADVERSION
,
4558 dgettext(TEXT_DOMAIN
, "cannot get history for pool "
4559 "'%s', pool must be upgraded"), zhp
->zpool_name
));
4561 return (zpool_standard_error_fmt(hdl
, errno
,
4562 dgettext(TEXT_DOMAIN
,
4563 "cannot get history for '%s'"), zhp
->zpool_name
));
4567 *len
= zc
.zc_history_len
;
4568 *off
= zc
.zc_history_offset
;
4574 * Retrieve the command history of a pool.
4577 zpool_get_history(zpool_handle_t
*zhp
, nvlist_t
**nvhisp
, uint64_t *off
,
4580 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4582 int buflen
= 128 * 1024;
4583 nvlist_t
**records
= NULL
;
4584 uint_t numrecords
= 0;
4586 uint64_t start
= *off
;
4588 buf
= zfs_alloc(hdl
, buflen
);
4590 /* process about 1MiB a time */
4591 while (*off
- start
< 1024 * 1024) {
4592 uint64_t bytes_read
= buflen
;
4595 if ((err
= get_history(zhp
, buf
, off
, &bytes_read
)) != 0)
4598 /* if nothing else was read in, we're at EOF, just return */
4604 if ((err
= zpool_history_unpack(buf
, bytes_read
,
4605 &leftover
, &records
, &numrecords
)) != 0) {
4606 zpool_standard_error_fmt(hdl
, err
,
4607 dgettext(TEXT_DOMAIN
,
4608 "cannot get history for '%s'"), zhp
->zpool_name
);
4612 if (leftover
== bytes_read
) {
4614 * no progress made, because buffer is not big enough
4615 * to hold this record; resize and retry.
4619 buf
= zfs_alloc(hdl
, buflen
);
4626 *nvhisp
= fnvlist_alloc();
4627 fnvlist_add_nvlist_array(*nvhisp
, ZPOOL_HIST_RECORD
,
4628 (const nvlist_t
**)records
, numrecords
);
4630 for (i
= 0; i
< numrecords
; i
++)
4631 nvlist_free(records
[i
]);
4638 * Retrieve the next event given the passed 'zevent_fd' file descriptor.
4639 * If there is a new event available 'nvp' will contain a newly allocated
4640 * nvlist and 'dropped' will be set to the number of missed events since
4641 * the last call to this function. When 'nvp' is set to NULL it indicates
4642 * no new events are available. In either case the function returns 0 and
4643 * it is up to the caller to free 'nvp'. In the case of a fatal error the
4644 * function will return a non-zero value. When the function is called in
4645 * blocking mode (the default, unless the ZEVENT_NONBLOCK flag is passed),
4646 * it will not return until a new event is available.
4649 zpool_events_next(libzfs_handle_t
*hdl
, nvlist_t
**nvp
,
4650 int *dropped
, unsigned flags
, int zevent_fd
)
4652 zfs_cmd_t zc
= {"\0"};
4657 zc
.zc_cleanup_fd
= zevent_fd
;
4659 if (flags
& ZEVENT_NONBLOCK
)
4660 zc
.zc_guid
= ZEVENT_NONBLOCK
;
4662 zcmd_alloc_dst_nvlist(hdl
, &zc
, ZEVENT_SIZE
);
4665 if (zfs_ioctl(hdl
, ZFS_IOC_EVENTS_NEXT
, &zc
) != 0) {
4668 error
= zfs_error_fmt(hdl
, EZFS_POOLUNAVAIL
,
4669 dgettext(TEXT_DOMAIN
, "zfs shutdown"));
4672 /* Blocking error case should not occur */
4673 if (!(flags
& ZEVENT_NONBLOCK
))
4674 error
= zpool_standard_error_fmt(hdl
, errno
,
4675 dgettext(TEXT_DOMAIN
, "cannot get event"));
4679 zcmd_expand_dst_nvlist(hdl
, &zc
);
4682 error
= zpool_standard_error_fmt(hdl
, errno
,
4683 dgettext(TEXT_DOMAIN
, "cannot get event"));
4688 error
= zcmd_read_dst_nvlist(hdl
, &zc
, nvp
);
4692 *dropped
= (int)zc
.zc_cookie
;
4694 zcmd_free_nvlists(&zc
);
4703 zpool_events_clear(libzfs_handle_t
*hdl
, int *count
)
4705 zfs_cmd_t zc
= {"\0"};
4707 if (zfs_ioctl(hdl
, ZFS_IOC_EVENTS_CLEAR
, &zc
) != 0)
4708 return (zpool_standard_error(hdl
, errno
,
4709 dgettext(TEXT_DOMAIN
, "cannot clear events")));
4712 *count
= (int)zc
.zc_cookie
; /* # of events cleared */
4718 * Seek to a specific EID, ZEVENT_SEEK_START, or ZEVENT_SEEK_END for
4719 * the passed zevent_fd file handle. On success zero is returned,
4720 * otherwise -1 is returned and hdl->libzfs_error is set to the errno.
4723 zpool_events_seek(libzfs_handle_t
*hdl
, uint64_t eid
, int zevent_fd
)
4725 zfs_cmd_t zc
= {"\0"};
4729 zc
.zc_cleanup_fd
= zevent_fd
;
4731 if (zfs_ioctl(hdl
, ZFS_IOC_EVENTS_SEEK
, &zc
) != 0) {
4734 error
= zfs_error_fmt(hdl
, EZFS_NOENT
,
4735 dgettext(TEXT_DOMAIN
, "cannot get event"));
4739 error
= zfs_error_fmt(hdl
, EZFS_NOMEM
,
4740 dgettext(TEXT_DOMAIN
, "cannot get event"));
4744 error
= zpool_standard_error_fmt(hdl
, errno
,
4745 dgettext(TEXT_DOMAIN
, "cannot get event"));
4754 zpool_obj_to_path_impl(zpool_handle_t
*zhp
, uint64_t dsobj
, uint64_t obj
,
4755 char *pathname
, size_t len
, boolean_t always_unmounted
)
4757 zfs_cmd_t zc
= {"\0"};
4758 boolean_t mounted
= B_FALSE
;
4759 char *mntpnt
= NULL
;
4760 char dsname
[ZFS_MAX_DATASET_NAME_LEN
];
4763 /* special case for the MOS */
4764 (void) snprintf(pathname
, len
, "<metadata>:<0x%llx>",
4769 /* get the dataset's name */
4770 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
4772 if (zfs_ioctl(zhp
->zpool_hdl
,
4773 ZFS_IOC_DSOBJ_TO_DSNAME
, &zc
) != 0) {
4774 /* just write out a path of two object numbers */
4775 (void) snprintf(pathname
, len
, "<0x%llx>:<0x%llx>",
4776 (longlong_t
)dsobj
, (longlong_t
)obj
);
4779 (void) strlcpy(dsname
, zc
.zc_value
, sizeof (dsname
));
4781 /* find out if the dataset is mounted */
4782 mounted
= !always_unmounted
&& is_mounted(zhp
->zpool_hdl
, dsname
,
4785 /* get the corrupted object's path */
4786 (void) strlcpy(zc
.zc_name
, dsname
, sizeof (zc
.zc_name
));
4788 if (zfs_ioctl(zhp
->zpool_hdl
, ZFS_IOC_OBJ_TO_PATH
,
4791 (void) snprintf(pathname
, len
, "%s%s", mntpnt
,
4794 (void) snprintf(pathname
, len
, "%s:%s",
4795 dsname
, zc
.zc_value
);
4798 (void) snprintf(pathname
, len
, "%s:<0x%llx>", dsname
,
4805 zpool_obj_to_path(zpool_handle_t
*zhp
, uint64_t dsobj
, uint64_t obj
,
4806 char *pathname
, size_t len
)
4808 zpool_obj_to_path_impl(zhp
, dsobj
, obj
, pathname
, len
, B_FALSE
);
4812 zpool_obj_to_path_ds(zpool_handle_t
*zhp
, uint64_t dsobj
, uint64_t obj
,
4813 char *pathname
, size_t len
)
4815 zpool_obj_to_path_impl(zhp
, dsobj
, obj
, pathname
, len
, B_TRUE
);
4818 * Wait while the specified activity is in progress in the pool.
4821 zpool_wait(zpool_handle_t
*zhp
, zpool_wait_activity_t activity
)
4825 int error
= zpool_wait_status(zhp
, activity
, &missing
, NULL
);
4828 (void) zpool_standard_error_fmt(zhp
->zpool_hdl
, ENOENT
,
4829 dgettext(TEXT_DOMAIN
, "error waiting in pool '%s'"),
4838 * Wait for the given activity and return the status of the wait (whether or not
4839 * any waiting was done) in the 'waited' parameter. Non-existent pools are
4840 * reported via the 'missing' parameter, rather than by printing an error
4841 * message. This is convenient when this function is called in a loop over a
4842 * long period of time (as it is, for example, by zpool's wait cmd). In that
4843 * scenario, a pool being exported or destroyed should be considered a normal
4844 * event, so we don't want to print an error when we find that the pool doesn't
4848 zpool_wait_status(zpool_handle_t
*zhp
, zpool_wait_activity_t activity
,
4849 boolean_t
*missing
, boolean_t
*waited
)
4851 int error
= lzc_wait(zhp
->zpool_name
, activity
, waited
);
4852 *missing
= (error
== ENOENT
);
4857 (void) zpool_standard_error_fmt(zhp
->zpool_hdl
, error
,
4858 dgettext(TEXT_DOMAIN
, "error waiting in pool '%s'"),
4866 zpool_set_bootenv(zpool_handle_t
*zhp
, const nvlist_t
*envmap
)
4868 int error
= lzc_set_bootenv(zhp
->zpool_name
, envmap
);
4870 (void) zpool_standard_error_fmt(zhp
->zpool_hdl
, error
,
4871 dgettext(TEXT_DOMAIN
,
4872 "error setting bootenv in pool '%s'"), zhp
->zpool_name
);
4879 zpool_get_bootenv(zpool_handle_t
*zhp
, nvlist_t
**nvlp
)
4885 error
= lzc_get_bootenv(zhp
->zpool_name
, &nvl
);
4887 (void) zpool_standard_error_fmt(zhp
->zpool_hdl
, error
,
4888 dgettext(TEXT_DOMAIN
,
4889 "error getting bootenv in pool '%s'"), zhp
->zpool_name
);
4898 * Attempt to read and parse feature file(s) (from "compatibility" property).
4899 * Files contain zpool feature names, comma or whitespace-separated.
4900 * Comments (# character to next newline) are discarded.
4903 * compatibility : string containing feature filenames
4904 * features : either NULL or pointer to array of boolean
4905 * report : either NULL or pointer to string buffer
4906 * rlen : length of "report" buffer
4908 * compatibility is NULL (unset), "", "off", "legacy", or list of
4909 * comma-separated filenames. filenames should either be absolute,
4911 * 1) ZPOOL_SYSCONF_COMPAT_D (eg: /etc/zfs/compatibility.d) or
4912 * 2) ZPOOL_DATA_COMPAT_D (eg: /usr/share/zfs/compatibility.d).
4913 * (Unset), "" or "off" => enable all features
4914 * "legacy" => disable all features
4916 * Any feature names read from files which match unames in spa_feature_table
4917 * will have the corresponding boolean set in the features array (if non-NULL).
4918 * If more than one feature set specified, only features present in *all* of
4921 * "report" if not NULL will be populated with a suitable status message.
4924 * ZPOOL_COMPATIBILITY_OK : files read and parsed ok
4925 * ZPOOL_COMPATIBILITY_BADFILE : file too big or not a text file
4926 * ZPOOL_COMPATIBILITY_BADTOKEN : SYSCONF file contains invalid feature name
4927 * ZPOOL_COMPATIBILITY_WARNTOKEN : DATA file contains invalid feature name
4928 * ZPOOL_COMPATIBILITY_NOFILES : no feature files found
4930 zpool_compat_status_t
4931 zpool_load_compat(const char *compat
, boolean_t
*features
, char *report
,
4934 int sdirfd
, ddirfd
, featfd
;
4938 char *file
, *line
, *word
;
4940 char l_compat
[ZFS_MAXPROPLEN
];
4942 boolean_t ret_nofiles
= B_TRUE
;
4943 boolean_t ret_badfile
= B_FALSE
;
4944 boolean_t ret_badtoken
= B_FALSE
;
4945 boolean_t ret_warntoken
= B_FALSE
;
4947 /* special cases (unset), "" and "off" => enable all features */
4948 if (compat
== NULL
|| compat
[0] == '\0' ||
4949 strcmp(compat
, ZPOOL_COMPAT_OFF
) == 0) {
4950 if (features
!= NULL
)
4951 for (uint_t i
= 0; i
< SPA_FEATURES
; i
++)
4952 features
[i
] = B_TRUE
;
4954 strlcpy(report
, gettext("all features enabled"), rlen
);
4955 return (ZPOOL_COMPATIBILITY_OK
);
4958 /* Final special case "legacy" => disable all features */
4959 if (strcmp(compat
, ZPOOL_COMPAT_LEGACY
) == 0) {
4960 if (features
!= NULL
)
4961 for (uint_t i
= 0; i
< SPA_FEATURES
; i
++)
4962 features
[i
] = B_FALSE
;
4964 strlcpy(report
, gettext("all features disabled"), rlen
);
4965 return (ZPOOL_COMPATIBILITY_OK
);
4969 * Start with all true; will be ANDed with results from each file
4971 if (features
!= NULL
)
4972 for (uint_t i
= 0; i
< SPA_FEATURES
; i
++)
4973 features
[i
] = B_TRUE
;
4975 char err_badfile
[ZFS_MAXPROPLEN
] = "";
4976 char err_badtoken
[ZFS_MAXPROPLEN
] = "";
4979 * We ignore errors from the directory open()
4980 * as they're only needed if the filename is relative
4981 * which will be checked during the openat().
4984 /* O_PATH safer than O_RDONLY if system allows it */
4986 #define ZC_DIR_FLAGS (O_DIRECTORY | O_CLOEXEC | O_PATH)
4988 #define ZC_DIR_FLAGS (O_DIRECTORY | O_CLOEXEC | O_RDONLY)
4991 sdirfd
= open(ZPOOL_SYSCONF_COMPAT_D
, ZC_DIR_FLAGS
);
4992 ddirfd
= open(ZPOOL_DATA_COMPAT_D
, ZC_DIR_FLAGS
);
4994 (void) strlcpy(l_compat
, compat
, ZFS_MAXPROPLEN
);
4996 for (file
= strtok_r(l_compat
, ",", &ps
);
4998 file
= strtok_r(NULL
, ",", &ps
)) {
5000 boolean_t l_features
[SPA_FEATURES
];
5002 enum { Z_SYSCONF
, Z_DATA
} source
;
5004 /* try sysconfdir first, then datadir */
5006 if ((featfd
= openat(sdirfd
, file
, O_RDONLY
| O_CLOEXEC
)) < 0) {
5007 featfd
= openat(ddirfd
, file
, O_RDONLY
| O_CLOEXEC
);
5011 /* File readable and correct size? */
5013 fstat(featfd
, &fs
) < 0 ||
5015 fs
.st_size
> ZPOOL_COMPAT_MAXSIZE
) {
5016 (void) close(featfd
);
5017 strlcat(err_badfile
, file
, ZFS_MAXPROPLEN
);
5018 strlcat(err_badfile
, " ", ZFS_MAXPROPLEN
);
5019 ret_badfile
= B_TRUE
;
5023 /* Prefault the file if system allows */
5024 #if defined(MAP_POPULATE)
5025 #define ZC_MMAP_FLAGS (MAP_PRIVATE | MAP_POPULATE)
5026 #elif defined(MAP_PREFAULT_READ)
5027 #define ZC_MMAP_FLAGS (MAP_PRIVATE | MAP_PREFAULT_READ)
5029 #define ZC_MMAP_FLAGS (MAP_PRIVATE)
5032 /* private mmap() so we can strtok safely */
5033 fc
= (char *)mmap(NULL
, fs
.st_size
, PROT_READ
| PROT_WRITE
,
5034 ZC_MMAP_FLAGS
, featfd
, 0);
5035 (void) close(featfd
);
5037 /* map ok, and last character == newline? */
5038 if (fc
== MAP_FAILED
|| fc
[fs
.st_size
- 1] != '\n') {
5039 (void) munmap((void *) fc
, fs
.st_size
);
5040 strlcat(err_badfile
, file
, ZFS_MAXPROPLEN
);
5041 strlcat(err_badfile
, " ", ZFS_MAXPROPLEN
);
5042 ret_badfile
= B_TRUE
;
5046 ret_nofiles
= B_FALSE
;
5048 for (uint_t i
= 0; i
< SPA_FEATURES
; i
++)
5049 l_features
[i
] = B_FALSE
;
5051 /* replace final newline with NULL to ensure string ends */
5052 fc
[fs
.st_size
- 1] = '\0';
5054 for (line
= strtok_r(fc
, "\n", &ls
);
5056 line
= strtok_r(NULL
, "\n", &ls
)) {
5057 /* discard comments */
5058 char *r
= strchr(line
, '#');
5062 for (word
= strtok_r(line
, ", \t", &ws
);
5064 word
= strtok_r(NULL
, ", \t", &ws
)) {
5065 /* Find matching feature name */
5067 for (f
= 0; f
< SPA_FEATURES
; f
++) {
5068 zfeature_info_t
*fi
=
5069 &spa_feature_table
[f
];
5070 if (strcmp(word
, fi
->fi_uname
) == 0) {
5071 l_features
[f
] = B_TRUE
;
5075 if (f
< SPA_FEATURES
)
5078 /* found an unrecognized word */
5079 /* lightly sanitize it */
5080 if (strlen(word
) > 32)
5082 for (char *c
= word
; *c
!= '\0'; c
++)
5086 strlcat(err_badtoken
, word
, ZFS_MAXPROPLEN
);
5087 strlcat(err_badtoken
, " ", ZFS_MAXPROPLEN
);
5088 if (source
== Z_SYSCONF
)
5089 ret_badtoken
= B_TRUE
;
5091 ret_warntoken
= B_TRUE
;
5094 (void) munmap((void *) fc
, fs
.st_size
);
5096 if (features
!= NULL
)
5097 for (uint_t i
= 0; i
< SPA_FEATURES
; i
++)
5098 features
[i
] &= l_features
[i
];
5100 (void) close(sdirfd
);
5101 (void) close(ddirfd
);
5103 /* Return the most serious error */
5106 snprintf(report
, rlen
, gettext("could not read/"
5107 "parse feature file(s): %s"), err_badfile
);
5108 return (ZPOOL_COMPATIBILITY_BADFILE
);
5113 gettext("no valid compatibility files specified"),
5115 return (ZPOOL_COMPATIBILITY_NOFILES
);
5119 snprintf(report
, rlen
, gettext("invalid feature "
5120 "name(s) in local compatibility files: %s"),
5122 return (ZPOOL_COMPATIBILITY_BADTOKEN
);
5124 if (ret_warntoken
) {
5126 snprintf(report
, rlen
, gettext("unrecognized feature "
5127 "name(s) in distribution compatibility files: %s"),
5129 return (ZPOOL_COMPATIBILITY_WARNTOKEN
);
5132 strlcpy(report
, gettext("compatibility set ok"), rlen
);
5133 return (ZPOOL_COMPATIBILITY_OK
);
5137 zpool_vdev_guid(zpool_handle_t
*zhp
, const char *vdevname
, uint64_t *vdev_guid
)
5140 boolean_t avail_spare
, l2cache
;
5142 verify(zhp
!= NULL
);
5143 if (zpool_get_state(zhp
) == POOL_STATE_UNAVAIL
) {
5144 char errbuf
[ERRBUFLEN
];
5145 (void) snprintf(errbuf
, sizeof (errbuf
),
5146 dgettext(TEXT_DOMAIN
, "pool is in an unavailable state"));
5147 return (zfs_error(zhp
->zpool_hdl
, EZFS_POOLUNAVAIL
, errbuf
));
5150 if ((tgt
= zpool_find_vdev(zhp
, vdevname
, &avail_spare
, &l2cache
,
5152 char errbuf
[ERRBUFLEN
];
5153 (void) snprintf(errbuf
, sizeof (errbuf
),
5154 dgettext(TEXT_DOMAIN
, "can not find %s in %s"),
5155 vdevname
, zhp
->zpool_name
);
5156 return (zfs_error(zhp
->zpool_hdl
, EZFS_NODEVICE
, errbuf
));
5159 *vdev_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
5164 * Get a vdev property value for 'prop' and return the value in
5165 * a pre-allocated buffer.
5168 zpool_get_vdev_prop_value(nvlist_t
*nvprop
, vdev_prop_t prop
, char *prop_name
,
5169 char *buf
, size_t len
, zprop_source_t
*srctype
, boolean_t literal
)
5174 zprop_source_t src
= ZPROP_SRC_NONE
;
5176 if (prop
== VDEV_PROP_USERPROP
) {
5177 /* user property, prop_name must contain the property name */
5178 assert(prop_name
!= NULL
);
5179 if (nvlist_lookup_nvlist(nvprop
, prop_name
, &nv
) == 0) {
5180 src
= fnvlist_lookup_uint64(nv
, ZPROP_SOURCE
);
5181 strval
= fnvlist_lookup_string(nv
, ZPROP_VALUE
);
5183 /* user prop not found */
5186 (void) strlcpy(buf
, strval
, len
);
5192 if (prop_name
== NULL
)
5193 prop_name
= (char *)vdev_prop_to_name(prop
);
5195 switch (vdev_prop_get_type(prop
)) {
5196 case PROP_TYPE_STRING
:
5197 if (nvlist_lookup_nvlist(nvprop
, prop_name
, &nv
) == 0) {
5198 src
= fnvlist_lookup_uint64(nv
, ZPROP_SOURCE
);
5199 strval
= fnvlist_lookup_string(nv
, ZPROP_VALUE
);
5201 src
= ZPROP_SRC_DEFAULT
;
5202 if ((strval
= vdev_prop_default_string(prop
)) == NULL
)
5205 (void) strlcpy(buf
, strval
, len
);
5208 case PROP_TYPE_NUMBER
:
5209 if (nvlist_lookup_nvlist(nvprop
, prop_name
, &nv
) == 0) {
5210 src
= fnvlist_lookup_uint64(nv
, ZPROP_SOURCE
);
5211 intval
= fnvlist_lookup_uint64(nv
, ZPROP_VALUE
);
5213 src
= ZPROP_SRC_DEFAULT
;
5214 intval
= vdev_prop_default_numeric(prop
);
5218 case VDEV_PROP_ASIZE
:
5219 case VDEV_PROP_PSIZE
:
5220 case VDEV_PROP_SIZE
:
5221 case VDEV_PROP_BOOTSIZE
:
5222 case VDEV_PROP_ALLOCATED
:
5223 case VDEV_PROP_FREE
:
5224 case VDEV_PROP_READ_ERRORS
:
5225 case VDEV_PROP_WRITE_ERRORS
:
5226 case VDEV_PROP_CHECKSUM_ERRORS
:
5227 case VDEV_PROP_INITIALIZE_ERRORS
:
5228 case VDEV_PROP_OPS_NULL
:
5229 case VDEV_PROP_OPS_READ
:
5230 case VDEV_PROP_OPS_WRITE
:
5231 case VDEV_PROP_OPS_FREE
:
5232 case VDEV_PROP_OPS_CLAIM
:
5233 case VDEV_PROP_OPS_TRIM
:
5234 case VDEV_PROP_BYTES_NULL
:
5235 case VDEV_PROP_BYTES_READ
:
5236 case VDEV_PROP_BYTES_WRITE
:
5237 case VDEV_PROP_BYTES_FREE
:
5238 case VDEV_PROP_BYTES_CLAIM
:
5239 case VDEV_PROP_BYTES_TRIM
:
5241 (void) snprintf(buf
, len
, "%llu",
5242 (u_longlong_t
)intval
);
5244 (void) zfs_nicenum(intval
, buf
, len
);
5247 case VDEV_PROP_EXPANDSZ
:
5249 (void) strlcpy(buf
, "-", len
);
5250 } else if (literal
) {
5251 (void) snprintf(buf
, len
, "%llu",
5252 (u_longlong_t
)intval
);
5254 (void) zfs_nicenum(intval
, buf
, len
);
5257 case VDEV_PROP_CAPACITY
:
5259 (void) snprintf(buf
, len
, "%llu",
5260 (u_longlong_t
)intval
);
5262 (void) snprintf(buf
, len
, "%llu%%",
5263 (u_longlong_t
)intval
);
5266 case VDEV_PROP_CHECKSUM_N
:
5267 case VDEV_PROP_CHECKSUM_T
:
5268 case VDEV_PROP_IO_N
:
5269 case VDEV_PROP_IO_T
:
5270 case VDEV_PROP_SLOW_IO_N
:
5271 case VDEV_PROP_SLOW_IO_T
:
5272 if (intval
== UINT64_MAX
) {
5273 (void) strlcpy(buf
, "-", len
);
5275 (void) snprintf(buf
, len
, "%llu",
5276 (u_longlong_t
)intval
);
5279 case VDEV_PROP_FRAGMENTATION
:
5280 if (intval
== UINT64_MAX
) {
5281 (void) strlcpy(buf
, "-", len
);
5283 (void) snprintf(buf
, len
, "%llu%%",
5284 (u_longlong_t
)intval
);
5287 case VDEV_PROP_STATE
:
5289 (void) snprintf(buf
, len
, "%llu",
5290 (u_longlong_t
)intval
);
5292 (void) strlcpy(buf
, zpool_state_to_name(intval
,
5293 VDEV_AUX_NONE
), len
);
5297 (void) snprintf(buf
, len
, "%llu",
5298 (u_longlong_t
)intval
);
5302 case PROP_TYPE_INDEX
:
5303 if (nvlist_lookup_nvlist(nvprop
, prop_name
, &nv
) == 0) {
5304 src
= fnvlist_lookup_uint64(nv
, ZPROP_SOURCE
);
5305 intval
= fnvlist_lookup_uint64(nv
, ZPROP_VALUE
);
5307 src
= ZPROP_SRC_DEFAULT
;
5308 intval
= vdev_prop_default_numeric(prop
);
5309 /* Only use if provided by the RAIDZ VDEV above */
5310 if (prop
== VDEV_PROP_RAIDZ_EXPANDING
)
5313 if (vdev_prop_index_to_string(prop
, intval
,
5314 (const char **)&strval
) != 0)
5316 (void) strlcpy(buf
, strval
, len
);
5330 * Get a vdev property value for 'prop_name' and return the value in
5331 * a pre-allocated buffer.
5334 zpool_get_vdev_prop(zpool_handle_t
*zhp
, const char *vdevname
, vdev_prop_t prop
,
5335 char *prop_name
, char *buf
, size_t len
, zprop_source_t
*srctype
,
5338 nvlist_t
*reqnvl
, *reqprops
;
5339 nvlist_t
*retprops
= NULL
;
5340 uint64_t vdev_guid
= 0;
5343 if ((ret
= zpool_vdev_guid(zhp
, vdevname
, &vdev_guid
)) != 0)
5346 if (nvlist_alloc(&reqnvl
, NV_UNIQUE_NAME
, 0) != 0)
5347 return (no_memory(zhp
->zpool_hdl
));
5348 if (nvlist_alloc(&reqprops
, NV_UNIQUE_NAME
, 0) != 0)
5349 return (no_memory(zhp
->zpool_hdl
));
5351 fnvlist_add_uint64(reqnvl
, ZPOOL_VDEV_PROPS_GET_VDEV
, vdev_guid
);
5353 if (prop
!= VDEV_PROP_USERPROP
) {
5354 /* prop_name overrides prop value */
5355 if (prop_name
!= NULL
)
5356 prop
= vdev_name_to_prop(prop_name
);
5358 prop_name
= (char *)vdev_prop_to_name(prop
);
5359 assert(prop
< VDEV_NUM_PROPS
);
5362 assert(prop_name
!= NULL
);
5363 if (nvlist_add_uint64(reqprops
, prop_name
, prop
) != 0) {
5364 nvlist_free(reqnvl
);
5365 nvlist_free(reqprops
);
5366 return (no_memory(zhp
->zpool_hdl
));
5369 fnvlist_add_nvlist(reqnvl
, ZPOOL_VDEV_PROPS_GET_PROPS
, reqprops
);
5371 ret
= lzc_get_vdev_prop(zhp
->zpool_name
, reqnvl
, &retprops
);
5374 ret
= zpool_get_vdev_prop_value(retprops
, prop
, prop_name
, buf
,
5375 len
, srctype
, literal
);
5377 char errbuf
[ERRBUFLEN
];
5378 (void) snprintf(errbuf
, sizeof (errbuf
),
5379 dgettext(TEXT_DOMAIN
, "cannot get vdev property %s from"
5380 " %s in %s"), prop_name
, vdevname
, zhp
->zpool_name
);
5381 (void) zpool_standard_error(zhp
->zpool_hdl
, ret
, errbuf
);
5384 nvlist_free(reqnvl
);
5385 nvlist_free(reqprops
);
5386 nvlist_free(retprops
);
5392 * Get all vdev properties
5395 zpool_get_all_vdev_props(zpool_handle_t
*zhp
, const char *vdevname
,
5398 nvlist_t
*nvl
= NULL
;
5399 uint64_t vdev_guid
= 0;
5402 if ((ret
= zpool_vdev_guid(zhp
, vdevname
, &vdev_guid
)) != 0)
5405 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0)
5406 return (no_memory(zhp
->zpool_hdl
));
5408 fnvlist_add_uint64(nvl
, ZPOOL_VDEV_PROPS_GET_VDEV
, vdev_guid
);
5410 ret
= lzc_get_vdev_prop(zhp
->zpool_name
, nvl
, outnvl
);
5415 char errbuf
[ERRBUFLEN
];
5416 (void) snprintf(errbuf
, sizeof (errbuf
),
5417 dgettext(TEXT_DOMAIN
, "cannot get vdev properties for"
5418 " %s in %s"), vdevname
, zhp
->zpool_name
);
5419 (void) zpool_standard_error(zhp
->zpool_hdl
, errno
, errbuf
);
5429 zpool_set_vdev_prop(zpool_handle_t
*zhp
, const char *vdevname
,
5430 const char *propname
, const char *propval
)
5433 nvlist_t
*nvl
= NULL
;
5434 nvlist_t
*outnvl
= NULL
;
5436 nvlist_t
*realprops
;
5437 prop_flags_t flags
= { 0 };
5441 if ((ret
= zpool_vdev_guid(zhp
, vdevname
, &vdev_guid
)) != 0)
5444 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0)
5445 return (no_memory(zhp
->zpool_hdl
));
5446 if (nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0) != 0)
5447 return (no_memory(zhp
->zpool_hdl
));
5449 fnvlist_add_uint64(nvl
, ZPOOL_VDEV_PROPS_SET_VDEV
, vdev_guid
);
5451 if (nvlist_add_string(props
, propname
, propval
) != 0) {
5453 return (no_memory(zhp
->zpool_hdl
));
5456 char errbuf
[ERRBUFLEN
];
5457 (void) snprintf(errbuf
, sizeof (errbuf
),
5458 dgettext(TEXT_DOMAIN
, "cannot set property %s for %s on %s"),
5459 propname
, vdevname
, zhp
->zpool_name
);
5462 version
= zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
);
5463 if ((realprops
= zpool_valid_proplist(zhp
->zpool_hdl
,
5464 zhp
->zpool_name
, props
, version
, flags
, errbuf
)) == NULL
) {
5473 fnvlist_add_nvlist(nvl
, ZPOOL_VDEV_PROPS_SET_PROPS
, props
);
5475 ret
= lzc_set_vdev_prop(zhp
->zpool_name
, nvl
, &outnvl
);
5479 nvlist_free(outnvl
);
5482 (void) zpool_standard_error(zhp
->zpool_hdl
, errno
, errbuf
);