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, 2020 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, 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_MMP
) {
259 str
= gettext("SUSPENDED");
261 nvlist_t
*nvroot
= fnvlist_lookup_nvlist(
262 zpool_get_config(zhp
, NULL
), ZPOOL_CONFIG_VDEV_TREE
);
264 vdev_stat_t
*vs
= (vdev_stat_t
*)fnvlist_lookup_uint64_array(
265 nvroot
, ZPOOL_CONFIG_VDEV_STATS
, &vsc
);
266 str
= zpool_state_to_name(vs
->vs_state
, vs
->vs_aux
);
272 * Get a zpool property value for 'prop' and return the value in
273 * a pre-allocated buffer.
276 zpool_get_prop(zpool_handle_t
*zhp
, zpool_prop_t prop
, char *buf
,
277 size_t len
, zprop_source_t
*srctype
, boolean_t literal
)
281 zprop_source_t src
= ZPROP_SRC_NONE
;
283 if (zpool_get_state(zhp
) == POOL_STATE_UNAVAIL
) {
285 case ZPOOL_PROP_NAME
:
286 (void) strlcpy(buf
, zpool_get_name(zhp
), len
);
289 case ZPOOL_PROP_HEALTH
:
290 (void) strlcpy(buf
, zpool_get_state_str(zhp
), len
);
293 case ZPOOL_PROP_GUID
:
294 intval
= zpool_get_prop_int(zhp
, prop
, &src
);
295 (void) snprintf(buf
, len
, "%llu", (u_longlong_t
)intval
);
298 case ZPOOL_PROP_ALTROOT
:
299 case ZPOOL_PROP_CACHEFILE
:
300 case ZPOOL_PROP_COMMENT
:
301 case ZPOOL_PROP_COMPATIBILITY
:
302 if (zhp
->zpool_props
!= NULL
||
303 zpool_get_all_props(zhp
) == 0) {
305 zpool_get_prop_string(zhp
, prop
, &src
),
311 (void) strlcpy(buf
, "-", len
);
320 if (zhp
->zpool_props
== NULL
&& zpool_get_all_props(zhp
) &&
321 prop
!= ZPOOL_PROP_NAME
)
324 switch (zpool_prop_get_type(prop
)) {
325 case PROP_TYPE_STRING
:
326 (void) strlcpy(buf
, zpool_get_prop_string(zhp
, prop
, &src
),
330 case PROP_TYPE_NUMBER
:
331 intval
= zpool_get_prop_int(zhp
, prop
, &src
);
334 case ZPOOL_PROP_SIZE
:
335 case ZPOOL_PROP_ALLOCATED
:
336 case ZPOOL_PROP_FREE
:
337 case ZPOOL_PROP_FREEING
:
338 case ZPOOL_PROP_LEAKED
:
339 case ZPOOL_PROP_ASHIFT
:
340 case ZPOOL_PROP_MAXBLOCKSIZE
:
341 case ZPOOL_PROP_MAXDNODESIZE
:
342 case ZPOOL_PROP_BCLONESAVED
:
343 case ZPOOL_PROP_BCLONEUSED
:
345 (void) snprintf(buf
, len
, "%llu",
346 (u_longlong_t
)intval
);
348 (void) zfs_nicenum(intval
, buf
, len
);
351 case ZPOOL_PROP_EXPANDSZ
:
352 case ZPOOL_PROP_CHECKPOINT
:
354 (void) strlcpy(buf
, "-", len
);
355 } else if (literal
) {
356 (void) snprintf(buf
, len
, "%llu",
357 (u_longlong_t
)intval
);
359 (void) zfs_nicebytes(intval
, buf
, len
);
363 case ZPOOL_PROP_CAPACITY
:
365 (void) snprintf(buf
, len
, "%llu",
366 (u_longlong_t
)intval
);
368 (void) snprintf(buf
, len
, "%llu%%",
369 (u_longlong_t
)intval
);
373 case ZPOOL_PROP_FRAGMENTATION
:
374 if (intval
== UINT64_MAX
) {
375 (void) strlcpy(buf
, "-", len
);
376 } else if (literal
) {
377 (void) snprintf(buf
, len
, "%llu",
378 (u_longlong_t
)intval
);
380 (void) snprintf(buf
, len
, "%llu%%",
381 (u_longlong_t
)intval
);
385 case ZPOOL_PROP_BCLONERATIO
:
386 case ZPOOL_PROP_DEDUPRATIO
:
388 (void) snprintf(buf
, len
, "%llu.%02llu",
389 (u_longlong_t
)(intval
/ 100),
390 (u_longlong_t
)(intval
% 100));
392 (void) snprintf(buf
, len
, "%llu.%02llux",
393 (u_longlong_t
)(intval
/ 100),
394 (u_longlong_t
)(intval
% 100));
397 case ZPOOL_PROP_HEALTH
:
398 (void) strlcpy(buf
, zpool_get_state_str(zhp
), len
);
400 case ZPOOL_PROP_VERSION
:
401 if (intval
>= SPA_VERSION_FEATURES
) {
402 (void) snprintf(buf
, len
, "-");
407 (void) snprintf(buf
, len
, "%llu", (u_longlong_t
)intval
);
411 case PROP_TYPE_INDEX
:
412 intval
= zpool_get_prop_int(zhp
, prop
, &src
);
413 if (zpool_prop_index_to_string(prop
, intval
, &strval
)
416 (void) strlcpy(buf
, strval
, len
);
430 * Get a zpool property value for 'propname' and return the value in
431 * a pre-allocated buffer.
434 zpool_get_userprop(zpool_handle_t
*zhp
, const char *propname
, char *buf
,
435 size_t len
, zprop_source_t
*srctype
)
440 zprop_source_t source
= ZPROP_SRC_LOCAL
;
442 nvl
= zhp
->zpool_props
;
443 if (nvlist_lookup_nvlist(nvl
, propname
, &nv
) == 0) {
444 if (nvlist_lookup_uint64(nv
, ZPROP_SOURCE
, &ival
) == 0)
446 verify(nvlist_lookup_string(nv
, ZPROP_VALUE
, &value
) == 0);
448 source
= ZPROP_SRC_DEFAULT
;
455 (void) strlcpy(buf
, value
, len
);
461 * Check if the bootfs name has the same pool name as it is set to.
462 * Assuming bootfs is a valid dataset name.
465 bootfs_name_valid(const char *pool
, const char *bootfs
)
467 int len
= strlen(pool
);
468 if (bootfs
[0] == '\0')
471 if (!zfs_name_valid(bootfs
, ZFS_TYPE_FILESYSTEM
|ZFS_TYPE_SNAPSHOT
))
474 if (strncmp(pool
, bootfs
, len
) == 0 &&
475 (bootfs
[len
] == '/' || bootfs
[len
] == '\0'))
482 * Given an nvlist of zpool properties to be set, validate that they are
483 * correct, and parse any numeric properties (index, boolean, etc) if they are
484 * specified as strings.
487 zpool_valid_proplist(libzfs_handle_t
*hdl
, const char *poolname
,
488 nvlist_t
*props
, uint64_t version
, prop_flags_t flags
, char *errbuf
)
495 const char *slash
, *check
;
496 struct stat64 statbuf
;
500 if (nvlist_alloc(&retprops
, NV_UNIQUE_NAME
, 0) != 0) {
501 (void) no_memory(hdl
);
506 while ((elem
= nvlist_next_nvpair(props
, elem
)) != NULL
) {
507 const char *propname
= nvpair_name(elem
);
509 if (flags
.vdevprop
&& zpool_prop_vdev(propname
)) {
510 vdev_prop_t vprop
= vdev_name_to_prop(propname
);
512 if (vdev_prop_readonly(vprop
)) {
513 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "'%s' "
514 "is readonly"), propname
);
515 (void) zfs_error(hdl
, EZFS_PROPREADONLY
,
520 if (zprop_parse_value(hdl
, elem
, vprop
, ZFS_TYPE_VDEV
,
521 retprops
, &strval
, &intval
, errbuf
) != 0)
525 } else if (flags
.vdevprop
&& vdev_prop_user(propname
)) {
526 if (nvlist_add_nvpair(retprops
, elem
) != 0) {
527 (void) no_memory(hdl
);
531 } else if (flags
.vdevprop
) {
532 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
533 "invalid property: '%s'"), propname
);
534 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
538 prop
= zpool_name_to_prop(propname
);
539 if (prop
== ZPOOL_PROP_INVAL
&& zpool_prop_feature(propname
)) {
541 char *fname
= strchr(propname
, '@') + 1;
543 err
= zfeature_lookup_name(fname
, NULL
);
545 ASSERT3U(err
, ==, ENOENT
);
546 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
547 "feature '%s' unsupported by kernel"),
549 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
553 if (nvpair_type(elem
) != DATA_TYPE_STRING
) {
554 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
555 "'%s' must be a string"), propname
);
556 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
560 (void) nvpair_value_string(elem
, &strval
);
561 if (strcmp(strval
, ZFS_FEATURE_ENABLED
) != 0 &&
562 strcmp(strval
, ZFS_FEATURE_DISABLED
) != 0) {
563 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
564 "property '%s' can only be set to "
565 "'enabled' or 'disabled'"), propname
);
566 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
571 strcmp(strval
, ZFS_FEATURE_DISABLED
) == 0) {
572 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
573 "property '%s' can only be set to "
574 "'disabled' at creation time"), propname
);
575 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
579 if (nvlist_add_uint64(retprops
, propname
, 0) != 0) {
580 (void) no_memory(hdl
);
584 } else if (prop
== ZPOOL_PROP_INVAL
&&
585 zfs_prop_user(propname
)) {
587 * This is a user property: make sure it's a
588 * string, and that it's less than ZAP_MAXNAMELEN.
590 if (nvpair_type(elem
) != DATA_TYPE_STRING
) {
591 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
592 "'%s' must be a string"), propname
);
593 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
597 if (strlen(nvpair_name(elem
)) >= ZAP_MAXNAMELEN
) {
598 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
599 "property name '%s' is too long"),
601 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
605 (void) nvpair_value_string(elem
, &strval
);
607 if (strlen(strval
) >= ZFS_MAXPROPLEN
) {
608 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
609 "property value '%s' is too long"),
611 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
615 if (nvlist_add_string(retprops
, propname
,
617 (void) no_memory(hdl
);
625 * Make sure this property is valid and applies to this type.
627 if (prop
== ZPOOL_PROP_INVAL
) {
628 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
629 "invalid property '%s'"), propname
);
630 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
634 if (zpool_prop_readonly(prop
)) {
635 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "'%s' "
636 "is readonly"), propname
);
637 (void) zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
);
641 if (!flags
.create
&& zpool_prop_setonce(prop
)) {
642 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
643 "property '%s' can only be set at "
644 "creation time"), propname
);
645 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
649 if (zprop_parse_value(hdl
, elem
, prop
, ZFS_TYPE_POOL
, retprops
,
650 &strval
, &intval
, errbuf
) != 0)
654 * Perform additional checking for specific properties.
657 case ZPOOL_PROP_VERSION
:
658 if (intval
< version
||
659 !SPA_VERSION_IS_SUPPORTED(intval
)) {
660 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
661 "property '%s' number %llu is invalid."),
662 propname
, (unsigned long long)intval
);
663 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
668 case ZPOOL_PROP_ASHIFT
:
670 (intval
< ASHIFT_MIN
|| intval
> ASHIFT_MAX
)) {
671 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
672 "property '%s' number %llu is invalid, "
673 "only values between %" PRId32
" and %"
674 PRId32
" are allowed."),
675 propname
, (unsigned long long)intval
,
676 ASHIFT_MIN
, ASHIFT_MAX
);
677 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
682 case ZPOOL_PROP_BOOTFS
:
683 if (flags
.create
|| flags
.import
) {
684 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
685 "property '%s' cannot be set at creation "
686 "or import time"), propname
);
687 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
691 if (version
< SPA_VERSION_BOOTFS
) {
692 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
693 "pool must be upgraded to support "
694 "'%s' property"), propname
);
695 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
700 * bootfs property value has to be a dataset name and
701 * the dataset has to be in the same pool as it sets to.
703 if (!bootfs_name_valid(poolname
, strval
)) {
704 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "'%s' "
705 "is an invalid name"), strval
);
706 (void) zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
710 if ((zhp
= zpool_open_canfail(hdl
, poolname
)) == NULL
) {
711 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
712 "could not open pool '%s'"), poolname
);
713 (void) zfs_error(hdl
, EZFS_OPENFAILED
, errbuf
);
719 case ZPOOL_PROP_ALTROOT
:
720 if (!flags
.create
&& !flags
.import
) {
721 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
722 "property '%s' can only be set during pool "
723 "creation or import"), propname
);
724 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
728 if (strval
[0] != '/') {
729 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
730 "bad alternate root '%s'"), strval
);
731 (void) zfs_error(hdl
, EZFS_BADPATH
, errbuf
);
736 case ZPOOL_PROP_CACHEFILE
:
737 if (strval
[0] == '\0')
740 if (strcmp(strval
, "none") == 0)
743 if (strval
[0] != '/') {
744 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
745 "property '%s' must be empty, an "
746 "absolute path, or 'none'"), propname
);
747 (void) zfs_error(hdl
, EZFS_BADPATH
, errbuf
);
751 slash
= strrchr(strval
, '/');
753 if (slash
[1] == '\0' || strcmp(slash
, "/.") == 0 ||
754 strcmp(slash
, "/..") == 0) {
755 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
756 "'%s' is not a valid file"), strval
);
757 (void) zfs_error(hdl
, EZFS_BADPATH
, errbuf
);
761 *(char *)slash
= '\0';
763 if (strval
[0] != '\0' &&
764 (stat64(strval
, &statbuf
) != 0 ||
765 !S_ISDIR(statbuf
.st_mode
))) {
766 *(char *)slash
= '/';
767 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
768 "'%s' is not a valid directory"),
770 (void) zfs_error(hdl
, EZFS_BADPATH
, errbuf
);
774 *(char *)slash
= '/';
777 case ZPOOL_PROP_COMPATIBILITY
:
778 switch (zpool_load_compat(strval
, NULL
, report
, 1024)) {
779 case ZPOOL_COMPATIBILITY_OK
:
780 case ZPOOL_COMPATIBILITY_WARNTOKEN
:
782 case ZPOOL_COMPATIBILITY_BADFILE
:
783 case ZPOOL_COMPATIBILITY_BADTOKEN
:
784 case ZPOOL_COMPATIBILITY_NOFILES
:
785 zfs_error_aux(hdl
, "%s", report
);
786 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
791 case ZPOOL_PROP_COMMENT
:
792 for (check
= strval
; *check
!= '\0'; check
++) {
793 if (!isprint(*check
)) {
795 dgettext(TEXT_DOMAIN
,
796 "comment may only have printable "
798 (void) zfs_error(hdl
, EZFS_BADPROP
,
803 if (strlen(strval
) > ZPROP_MAX_COMMENT
) {
804 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
805 "comment must not exceed %d characters"),
807 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
811 case ZPOOL_PROP_READONLY
:
813 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
814 "property '%s' can only be set at "
815 "import time"), propname
);
816 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
820 case ZPOOL_PROP_MULTIHOST
:
821 if (get_system_hostid() == 0) {
822 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
823 "requires a non-zero system hostid"));
824 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
828 case ZPOOL_PROP_DEDUPDITTO
:
829 printf("Note: property '%s' no longer has "
830 "any effect\n", propname
);
840 nvlist_free(retprops
);
845 * Set zpool property : propname=propval.
848 zpool_set_prop(zpool_handle_t
*zhp
, const char *propname
, const char *propval
)
850 zfs_cmd_t zc
= {"\0"};
852 char errbuf
[ERRBUFLEN
];
853 nvlist_t
*nvl
= NULL
;
856 prop_flags_t flags
= { 0 };
858 (void) snprintf(errbuf
, sizeof (errbuf
),
859 dgettext(TEXT_DOMAIN
, "cannot set property for '%s'"),
862 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0)
863 return (no_memory(zhp
->zpool_hdl
));
865 if (nvlist_add_string(nvl
, propname
, propval
) != 0) {
867 return (no_memory(zhp
->zpool_hdl
));
870 version
= zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
);
871 if ((realprops
= zpool_valid_proplist(zhp
->zpool_hdl
,
872 zhp
->zpool_name
, nvl
, version
, flags
, errbuf
)) == NULL
) {
881 * Execute the corresponding ioctl() to set this property.
883 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
885 zcmd_write_src_nvlist(zhp
->zpool_hdl
, &zc
, nvl
);
887 ret
= zfs_ioctl(zhp
->zpool_hdl
, ZFS_IOC_POOL_SET_PROPS
, &zc
);
889 zcmd_free_nvlists(&zc
);
893 (void) zpool_standard_error(zhp
->zpool_hdl
, errno
, errbuf
);
895 (void) zpool_props_refresh(zhp
);
901 zpool_expand_proplist(zpool_handle_t
*zhp
, zprop_list_t
**plp
,
902 zfs_type_t type
, boolean_t literal
)
904 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
906 char buf
[ZFS_MAXPROPLEN
];
907 nvlist_t
*features
= NULL
;
910 boolean_t firstexpand
= (NULL
== *plp
);
913 if (zprop_expand_list(hdl
, plp
, type
) != 0)
916 if (type
== ZFS_TYPE_VDEV
)
920 while (*last
!= NULL
)
921 last
= &(*last
)->pl_next
;
924 features
= zpool_get_features(zhp
);
926 if ((*plp
)->pl_all
&& firstexpand
) {
927 /* Handle userprops in the all properties case */
928 if (zhp
->zpool_props
== NULL
&& zpool_props_refresh(zhp
))
932 while ((nvp
= nvlist_next_nvpair(zhp
->zpool_props
, nvp
)) !=
934 const char *propname
= nvpair_name(nvp
);
936 if (!zfs_prop_user(propname
))
939 entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
));
940 entry
->pl_prop
= ZPROP_USERPROP
;
941 entry
->pl_user_prop
= zfs_strdup(hdl
, propname
);
942 entry
->pl_width
= strlen(entry
->pl_user_prop
);
943 entry
->pl_all
= B_TRUE
;
946 last
= &entry
->pl_next
;
949 for (i
= 0; i
< SPA_FEATURES
; i
++) {
950 entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
));
951 entry
->pl_prop
= ZPROP_USERPROP
;
952 entry
->pl_user_prop
= zfs_asprintf(hdl
, "feature@%s",
953 spa_feature_table
[i
].fi_uname
);
954 entry
->pl_width
= strlen(entry
->pl_user_prop
);
955 entry
->pl_all
= B_TRUE
;
958 last
= &entry
->pl_next
;
962 /* add any unsupported features */
963 for (nvp
= nvlist_next_nvpair(features
, NULL
);
964 nvp
!= NULL
; nvp
= nvlist_next_nvpair(features
, nvp
)) {
968 if (zfeature_is_supported(nvpair_name(nvp
)))
971 propname
= zfs_asprintf(hdl
, "unsupported@%s",
975 * Before adding the property to the list make sure that no
976 * other pool already added the same property.
980 while (entry
!= NULL
) {
981 if (entry
->pl_user_prop
!= NULL
&&
982 strcmp(propname
, entry
->pl_user_prop
) == 0) {
986 entry
= entry
->pl_next
;
993 entry
= zfs_alloc(hdl
, sizeof (zprop_list_t
));
994 entry
->pl_prop
= ZPROP_USERPROP
;
995 entry
->pl_user_prop
= propname
;
996 entry
->pl_width
= strlen(entry
->pl_user_prop
);
997 entry
->pl_all
= B_TRUE
;
1000 last
= &entry
->pl_next
;
1003 for (entry
= *plp
; entry
!= NULL
; entry
= entry
->pl_next
) {
1004 if (entry
->pl_fixed
&& !literal
)
1007 if (entry
->pl_prop
!= ZPROP_USERPROP
&&
1008 zpool_get_prop(zhp
, entry
->pl_prop
, buf
, sizeof (buf
),
1009 NULL
, literal
) == 0) {
1010 if (strlen(buf
) > entry
->pl_width
)
1011 entry
->pl_width
= strlen(buf
);
1012 } else if (entry
->pl_prop
== ZPROP_INVAL
&&
1013 zfs_prop_user(entry
->pl_user_prop
) &&
1014 zpool_get_userprop(zhp
, entry
->pl_user_prop
, buf
,
1015 sizeof (buf
), NULL
) == 0) {
1016 if (strlen(buf
) > entry
->pl_width
)
1017 entry
->pl_width
= strlen(buf
);
1025 vdev_expand_proplist(zpool_handle_t
*zhp
, const char *vdevname
,
1028 zprop_list_t
*entry
;
1029 char buf
[ZFS_MAXPROPLEN
];
1030 const char *strval
= NULL
;
1032 nvpair_t
*elem
= NULL
;
1033 nvlist_t
*vprops
= NULL
;
1034 nvlist_t
*propval
= NULL
;
1035 const char *propname
;
1037 zprop_list_t
**last
;
1039 for (entry
= *plp
; entry
!= NULL
; entry
= entry
->pl_next
) {
1040 if (entry
->pl_fixed
)
1043 if (zpool_get_vdev_prop(zhp
, vdevname
, entry
->pl_prop
,
1044 entry
->pl_user_prop
, buf
, sizeof (buf
), NULL
,
1046 if (strlen(buf
) > entry
->pl_width
)
1047 entry
->pl_width
= strlen(buf
);
1049 if (entry
->pl_prop
== VDEV_PROP_NAME
&&
1050 strlen(vdevname
) > entry
->pl_width
)
1051 entry
->pl_width
= strlen(vdevname
);
1054 /* Handle the all properties case */
1056 if (*last
!= NULL
&& (*last
)->pl_all
== B_TRUE
) {
1057 while (*last
!= NULL
)
1058 last
= &(*last
)->pl_next
;
1060 err
= zpool_get_all_vdev_props(zhp
, vdevname
, &vprops
);
1064 while ((elem
= nvlist_next_nvpair(vprops
, elem
)) != NULL
) {
1065 propname
= nvpair_name(elem
);
1067 /* Skip properties that are not user defined */
1068 if ((prop
= vdev_name_to_prop(propname
)) !=
1072 if (nvpair_value_nvlist(elem
, &propval
) != 0)
1075 strval
= fnvlist_lookup_string(propval
, ZPROP_VALUE
);
1077 entry
= zfs_alloc(zhp
->zpool_hdl
,
1078 sizeof (zprop_list_t
));
1079 entry
->pl_prop
= prop
;
1080 entry
->pl_user_prop
= zfs_strdup(zhp
->zpool_hdl
,
1082 entry
->pl_width
= strlen(strval
);
1083 entry
->pl_all
= B_TRUE
;
1085 last
= &entry
->pl_next
;
1093 * Get the state for the given feature on the given ZFS pool.
1096 zpool_prop_get_feature(zpool_handle_t
*zhp
, const char *propname
, char *buf
,
1100 boolean_t found
= B_FALSE
;
1101 nvlist_t
*features
= zpool_get_features(zhp
);
1102 boolean_t supported
;
1103 const char *feature
= strchr(propname
, '@') + 1;
1105 supported
= zpool_prop_feature(propname
);
1106 ASSERT(supported
|| zpool_prop_unsupported(propname
));
1109 * Convert from feature name to feature guid. This conversion is
1110 * unnecessary for unsupported@... properties because they already
1117 ret
= zfeature_lookup_name(feature
, &fid
);
1119 (void) strlcpy(buf
, "-", len
);
1122 feature
= spa_feature_table
[fid
].fi_guid
;
1125 if (nvlist_lookup_uint64(features
, feature
, &refcount
) == 0)
1130 (void) strlcpy(buf
, ZFS_FEATURE_DISABLED
, len
);
1133 (void) strlcpy(buf
, ZFS_FEATURE_ENABLED
, len
);
1135 (void) strlcpy(buf
, ZFS_FEATURE_ACTIVE
, len
);
1139 if (refcount
== 0) {
1140 (void) strcpy(buf
, ZFS_UNSUPPORTED_INACTIVE
);
1142 (void) strcpy(buf
, ZFS_UNSUPPORTED_READONLY
);
1145 (void) strlcpy(buf
, "-", len
);
1154 * Validate the given pool name, optionally putting an extended error message in
1158 zpool_name_valid(libzfs_handle_t
*hdl
, boolean_t isopen
, const char *pool
)
1160 namecheck_err_t why
;
1164 ret
= pool_namecheck(pool
, &why
, &what
);
1167 * The rules for reserved pool names were extended at a later point.
1168 * But we need to support users with existing pools that may now be
1169 * invalid. So we only check for this expanded set of names during a
1170 * create (or import), and only in userland.
1172 if (ret
== 0 && !isopen
&&
1173 (strncmp(pool
, "mirror", 6) == 0 ||
1174 strncmp(pool
, "raidz", 5) == 0 ||
1175 strncmp(pool
, "draid", 5) == 0 ||
1176 strncmp(pool
, "spare", 5) == 0 ||
1177 strcmp(pool
, "log") == 0)) {
1180 dgettext(TEXT_DOMAIN
, "name is reserved"));
1188 case NAME_ERR_TOOLONG
:
1190 dgettext(TEXT_DOMAIN
, "name is too long"));
1193 case NAME_ERR_INVALCHAR
:
1195 dgettext(TEXT_DOMAIN
, "invalid character "
1196 "'%c' in pool name"), what
);
1199 case NAME_ERR_NOLETTER
:
1200 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1201 "name must begin with a letter"));
1204 case NAME_ERR_RESERVED
:
1205 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1206 "name is reserved"));
1209 case NAME_ERR_DISKLIKE
:
1210 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1211 "pool name is reserved"));
1214 case NAME_ERR_LEADING_SLASH
:
1215 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1216 "leading slash in name"));
1219 case NAME_ERR_EMPTY_COMPONENT
:
1220 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1221 "empty component in name"));
1224 case NAME_ERR_TRAILING_SLASH
:
1225 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1226 "trailing slash in name"));
1229 case NAME_ERR_MULTIPLE_DELIMITERS
:
1230 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1231 "multiple '@' and/or '#' delimiters in "
1235 case NAME_ERR_NO_AT
:
1236 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1237 "permission set is missing '@'"));
1241 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1242 "(%d) not defined"), why
);
1253 * Open a handle to the given pool, even if the pool is currently in the FAULTED
1257 zpool_open_canfail(libzfs_handle_t
*hdl
, const char *pool
)
1259 zpool_handle_t
*zhp
;
1263 * Make sure the pool name is valid.
1265 if (!zpool_name_valid(hdl
, B_TRUE
, pool
)) {
1266 (void) zfs_error_fmt(hdl
, EZFS_INVALIDNAME
,
1267 dgettext(TEXT_DOMAIN
, "cannot open '%s'"),
1272 zhp
= zfs_alloc(hdl
, sizeof (zpool_handle_t
));
1274 zhp
->zpool_hdl
= hdl
;
1275 (void) strlcpy(zhp
->zpool_name
, pool
, sizeof (zhp
->zpool_name
));
1277 if (zpool_refresh_stats(zhp
, &missing
) != 0) {
1283 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "no such pool"));
1284 (void) zfs_error_fmt(hdl
, EZFS_NOENT
,
1285 dgettext(TEXT_DOMAIN
, "cannot open '%s'"), pool
);
1294 * Like the above, but silent on error. Used when iterating over pools (because
1295 * the configuration cache may be out of date).
1298 zpool_open_silent(libzfs_handle_t
*hdl
, const char *pool
, zpool_handle_t
**ret
)
1300 zpool_handle_t
*zhp
;
1303 zhp
= zfs_alloc(hdl
, sizeof (zpool_handle_t
));
1305 zhp
->zpool_hdl
= hdl
;
1306 (void) strlcpy(zhp
->zpool_name
, pool
, sizeof (zhp
->zpool_name
));
1308 if (zpool_refresh_stats(zhp
, &missing
) != 0) {
1324 * Similar to zpool_open_canfail(), but refuses to open pools in the faulted
1328 zpool_open(libzfs_handle_t
*hdl
, const char *pool
)
1330 zpool_handle_t
*zhp
;
1332 if ((zhp
= zpool_open_canfail(hdl
, pool
)) == NULL
)
1335 if (zhp
->zpool_state
== POOL_STATE_UNAVAIL
) {
1336 (void) zfs_error_fmt(hdl
, EZFS_POOLUNAVAIL
,
1337 dgettext(TEXT_DOMAIN
, "cannot open '%s'"), zhp
->zpool_name
);
1346 * Close the handle. Simply frees the memory associated with the handle.
1349 zpool_close(zpool_handle_t
*zhp
)
1351 nvlist_free(zhp
->zpool_config
);
1352 nvlist_free(zhp
->zpool_old_config
);
1353 nvlist_free(zhp
->zpool_props
);
1358 * Return the name of the pool.
1361 zpool_get_name(zpool_handle_t
*zhp
)
1363 return (zhp
->zpool_name
);
1368 * Return the state of the pool (ACTIVE or UNAVAILABLE)
1371 zpool_get_state(zpool_handle_t
*zhp
)
1373 return (zhp
->zpool_state
);
1377 * Check if vdev list contains a special vdev
1380 zpool_has_special_vdev(nvlist_t
*nvroot
)
1385 if (nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_CHILDREN
, &child
,
1387 for (uint_t c
= 0; c
< children
; c
++) {
1390 if (nvlist_lookup_string(child
[c
],
1391 ZPOOL_CONFIG_ALLOCATION_BIAS
, &bias
) == 0 &&
1392 strcmp(bias
, VDEV_ALLOC_BIAS_SPECIAL
) == 0) {
1401 * Check if vdev list contains a dRAID vdev
1404 zpool_has_draid_vdev(nvlist_t
*nvroot
)
1409 if (nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_CHILDREN
,
1410 &child
, &children
) == 0) {
1411 for (uint_t c
= 0; c
< children
; c
++) {
1414 if (nvlist_lookup_string(child
[c
],
1415 ZPOOL_CONFIG_TYPE
, &type
) == 0 &&
1416 strcmp(type
, VDEV_TYPE_DRAID
) == 0) {
1425 * Output a dRAID top-level vdev name in to the provided buffer.
1428 zpool_draid_name(char *name
, int len
, uint64_t data
, uint64_t parity
,
1429 uint64_t spares
, uint64_t children
)
1431 snprintf(name
, len
, "%s%llu:%llud:%lluc:%llus",
1432 VDEV_TYPE_DRAID
, (u_longlong_t
)parity
, (u_longlong_t
)data
,
1433 (u_longlong_t
)children
, (u_longlong_t
)spares
);
1439 * Return B_TRUE if the provided name is a dRAID spare name.
1442 zpool_is_draid_spare(const char *name
)
1444 uint64_t spare_id
, parity
, vdev_id
;
1446 if (sscanf(name
, VDEV_TYPE_DRAID
"%llu-%llu-%llu",
1447 (u_longlong_t
*)&parity
, (u_longlong_t
*)&vdev_id
,
1448 (u_longlong_t
*)&spare_id
) == 3) {
1456 * Create the named pool, using the provided vdev list. It is assumed
1457 * that the consumer has already validated the contents of the nvlist, so we
1458 * don't have to worry about error semantics.
1461 zpool_create(libzfs_handle_t
*hdl
, const char *pool
, nvlist_t
*nvroot
,
1462 nvlist_t
*props
, nvlist_t
*fsprops
)
1464 zfs_cmd_t zc
= {"\0"};
1465 nvlist_t
*zc_fsprops
= NULL
;
1466 nvlist_t
*zc_props
= NULL
;
1467 nvlist_t
*hidden_args
= NULL
;
1468 uint8_t *wkeydata
= NULL
;
1470 char errbuf
[ERRBUFLEN
];
1473 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1474 "cannot create '%s'"), pool
);
1476 if (!zpool_name_valid(hdl
, B_FALSE
, pool
))
1477 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
1479 zcmd_write_conf_nvlist(hdl
, &zc
, nvroot
);
1482 prop_flags_t flags
= { .create
= B_TRUE
, .import
= B_FALSE
};
1484 if ((zc_props
= zpool_valid_proplist(hdl
, pool
, props
,
1485 SPA_VERSION_1
, flags
, errbuf
)) == NULL
) {
1492 const char *zonestr
;
1494 zoned
= ((nvlist_lookup_string(fsprops
,
1495 zfs_prop_to_name(ZFS_PROP_ZONED
), &zonestr
) == 0) &&
1496 strcmp(zonestr
, "on") == 0);
1498 if ((zc_fsprops
= zfs_valid_proplist(hdl
, ZFS_TYPE_FILESYSTEM
,
1499 fsprops
, zoned
, NULL
, NULL
, B_TRUE
, errbuf
)) == NULL
) {
1503 if (nvlist_exists(zc_fsprops
,
1504 zfs_prop_to_name(ZFS_PROP_SPECIAL_SMALL_BLOCKS
)) &&
1505 !zpool_has_special_vdev(nvroot
)) {
1506 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1507 "%s property requires a special vdev"),
1508 zfs_prop_to_name(ZFS_PROP_SPECIAL_SMALL_BLOCKS
));
1509 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
1514 (nvlist_alloc(&zc_props
, NV_UNIQUE_NAME
, 0) != 0)) {
1517 if (zfs_crypto_create(hdl
, NULL
, zc_fsprops
, props
, B_TRUE
,
1518 &wkeydata
, &wkeylen
) != 0) {
1519 zfs_error(hdl
, EZFS_CRYPTOFAILED
, errbuf
);
1522 if (nvlist_add_nvlist(zc_props
,
1523 ZPOOL_ROOTFS_PROPS
, zc_fsprops
) != 0) {
1526 if (wkeydata
!= NULL
) {
1527 if (nvlist_alloc(&hidden_args
, NV_UNIQUE_NAME
, 0) != 0)
1530 if (nvlist_add_uint8_array(hidden_args
, "wkeydata",
1531 wkeydata
, wkeylen
) != 0)
1534 if (nvlist_add_nvlist(zc_props
, ZPOOL_HIDDEN_ARGS
,
1541 zcmd_write_src_nvlist(hdl
, &zc
, zc_props
);
1543 (void) strlcpy(zc
.zc_name
, pool
, sizeof (zc
.zc_name
));
1545 if ((ret
= zfs_ioctl(hdl
, ZFS_IOC_POOL_CREATE
, &zc
)) != 0) {
1547 zcmd_free_nvlists(&zc
);
1548 nvlist_free(zc_props
);
1549 nvlist_free(zc_fsprops
);
1550 nvlist_free(hidden_args
);
1551 if (wkeydata
!= NULL
)
1557 * This can happen if the user has specified the same
1558 * device multiple times. We can't reliably detect this
1559 * until we try to add it and see we already have a
1560 * label. This can also happen under if the device is
1561 * part of an active md or lvm device.
1563 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1564 "one or more vdevs refer to the same device, or "
1565 "one of\nthe devices is part of an active md or "
1567 return (zfs_error(hdl
, EZFS_BADDEV
, errbuf
));
1571 * This happens if the record size is smaller or larger
1572 * than the allowed size range, or not a power of 2.
1574 * NOTE: although zfs_valid_proplist is called earlier,
1575 * this case may have slipped through since the
1576 * pool does not exist yet and it is therefore
1577 * impossible to read properties e.g. max blocksize
1580 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1581 "record size invalid"));
1582 return (zfs_error(hdl
, EZFS_BADPROP
, errbuf
));
1586 * This occurs when one of the devices is below
1587 * SPA_MINDEVSIZE. Unfortunately, we can't detect which
1588 * device was the problem device since there's no
1589 * reliable way to determine device size from userland.
1594 zfs_nicebytes(SPA_MINDEVSIZE
, buf
,
1597 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1598 "one or more devices is less than the "
1599 "minimum size (%s)"), buf
);
1601 return (zfs_error(hdl
, EZFS_BADDEV
, errbuf
));
1604 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1605 "one or more devices is out of space"));
1606 return (zfs_error(hdl
, EZFS_BADDEV
, errbuf
));
1609 if (zpool_has_draid_vdev(nvroot
) &&
1610 zfeature_lookup_name("draid", NULL
) != 0) {
1611 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1612 "dRAID vdevs are unsupported by the "
1614 return (zfs_error(hdl
, EZFS_BADDEV
, errbuf
));
1616 return (zpool_standard_error(hdl
, errno
,
1621 return (zpool_standard_error(hdl
, errno
, errbuf
));
1626 zcmd_free_nvlists(&zc
);
1627 nvlist_free(zc_props
);
1628 nvlist_free(zc_fsprops
);
1629 nvlist_free(hidden_args
);
1630 if (wkeydata
!= NULL
)
1636 * Destroy the given pool. It is up to the caller to ensure that there are no
1637 * datasets left in the pool.
1640 zpool_destroy(zpool_handle_t
*zhp
, const char *log_str
)
1642 zfs_cmd_t zc
= {"\0"};
1643 zfs_handle_t
*zfp
= NULL
;
1644 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1645 char errbuf
[ERRBUFLEN
];
1647 if (zhp
->zpool_state
== POOL_STATE_ACTIVE
&&
1648 (zfp
= zfs_open(hdl
, zhp
->zpool_name
, ZFS_TYPE_FILESYSTEM
)) == NULL
)
1651 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
1652 zc
.zc_history
= (uint64_t)(uintptr_t)log_str
;
1654 if (zfs_ioctl(hdl
, ZFS_IOC_POOL_DESTROY
, &zc
) != 0) {
1655 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1656 "cannot destroy '%s'"), zhp
->zpool_name
);
1658 if (errno
== EROFS
) {
1659 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1660 "one or more devices is read only"));
1661 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
1663 (void) zpool_standard_error(hdl
, errno
, errbuf
);
1672 remove_mountpoint(zfp
);
1680 * Create a checkpoint in the given pool.
1683 zpool_checkpoint(zpool_handle_t
*zhp
)
1685 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1686 char errbuf
[ERRBUFLEN
];
1689 error
= lzc_pool_checkpoint(zhp
->zpool_name
);
1691 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1692 "cannot checkpoint '%s'"), zhp
->zpool_name
);
1693 (void) zpool_standard_error(hdl
, error
, errbuf
);
1701 * Discard the checkpoint from the given pool.
1704 zpool_discard_checkpoint(zpool_handle_t
*zhp
)
1706 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1707 char errbuf
[ERRBUFLEN
];
1710 error
= lzc_pool_checkpoint_discard(zhp
->zpool_name
);
1712 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1713 "cannot discard checkpoint in '%s'"), zhp
->zpool_name
);
1714 (void) zpool_standard_error(hdl
, error
, errbuf
);
1722 * Add the given vdevs to the pool. The caller must have already performed the
1723 * necessary verification to ensure that the vdev specification is well-formed.
1726 zpool_add(zpool_handle_t
*zhp
, nvlist_t
*nvroot
)
1728 zfs_cmd_t zc
= {"\0"};
1730 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1731 char errbuf
[ERRBUFLEN
];
1732 nvlist_t
**spares
, **l2cache
;
1733 uint_t nspares
, nl2cache
;
1735 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1736 "cannot add to '%s'"), zhp
->zpool_name
);
1738 if (zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
) <
1739 SPA_VERSION_SPARES
&&
1740 nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_SPARES
,
1741 &spares
, &nspares
) == 0) {
1742 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "pool must be "
1743 "upgraded to add hot spares"));
1744 return (zfs_error(hdl
, EZFS_BADVERSION
, errbuf
));
1747 if (zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
) <
1748 SPA_VERSION_L2CACHE
&&
1749 nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_L2CACHE
,
1750 &l2cache
, &nl2cache
) == 0) {
1751 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "pool must be "
1752 "upgraded to add cache devices"));
1753 return (zfs_error(hdl
, EZFS_BADVERSION
, errbuf
));
1756 zcmd_write_conf_nvlist(hdl
, &zc
, nvroot
);
1757 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
1759 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_ADD
, &zc
) != 0) {
1763 * This can happen if the user has specified the same
1764 * device multiple times. We can't reliably detect this
1765 * until we try to add it and see we already have a
1768 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1769 "one or more vdevs refer to the same device"));
1770 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
1775 if (zpool_has_draid_vdev(nvroot
) &&
1776 zfeature_lookup_name("draid", NULL
) != 0) {
1777 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1778 "dRAID vdevs are unsupported by the "
1781 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1782 "invalid config; a pool with removing/"
1783 "removed vdevs does not support adding "
1784 "raidz or dRAID vdevs"));
1787 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
1792 * This occurs when one of the devices is below
1793 * SPA_MINDEVSIZE. Unfortunately, we can't detect which
1794 * device was the problem device since there's no
1795 * reliable way to determine device size from userland.
1800 zfs_nicebytes(SPA_MINDEVSIZE
, buf
,
1803 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1804 "device is less than the minimum "
1807 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
1811 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1812 "pool must be upgraded to add these vdevs"));
1813 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
1817 (void) zpool_standard_error(hdl
, errno
, errbuf
);
1825 zcmd_free_nvlists(&zc
);
1831 * Exports the pool from the system. The caller must ensure that there are no
1832 * mounted datasets in the pool.
1835 zpool_export_common(zpool_handle_t
*zhp
, boolean_t force
, boolean_t hardforce
,
1836 const char *log_str
)
1838 zfs_cmd_t zc
= {"\0"};
1840 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
1841 zc
.zc_cookie
= force
;
1842 zc
.zc_guid
= hardforce
;
1843 zc
.zc_history
= (uint64_t)(uintptr_t)log_str
;
1845 if (zfs_ioctl(zhp
->zpool_hdl
, ZFS_IOC_POOL_EXPORT
, &zc
) != 0) {
1848 zfs_error_aux(zhp
->zpool_hdl
, dgettext(TEXT_DOMAIN
,
1849 "use '-f' to override the following errors:\n"
1850 "'%s' has an active shared spare which could be"
1851 " used by other pools once '%s' is exported."),
1852 zhp
->zpool_name
, zhp
->zpool_name
);
1853 return (zfs_error_fmt(zhp
->zpool_hdl
, EZFS_ACTIVE_SPARE
,
1854 dgettext(TEXT_DOMAIN
, "cannot export '%s'"),
1857 return (zpool_standard_error_fmt(zhp
->zpool_hdl
, errno
,
1858 dgettext(TEXT_DOMAIN
, "cannot export '%s'"),
1867 zpool_export(zpool_handle_t
*zhp
, boolean_t force
, const char *log_str
)
1869 return (zpool_export_common(zhp
, force
, B_FALSE
, log_str
));
1873 zpool_export_force(zpool_handle_t
*zhp
, const char *log_str
)
1875 return (zpool_export_common(zhp
, B_TRUE
, B_TRUE
, log_str
));
1879 zpool_rewind_exclaim(libzfs_handle_t
*hdl
, const char *name
, boolean_t dryrun
,
1882 nvlist_t
*nv
= NULL
;
1888 if (!hdl
->libzfs_printerr
|| config
== NULL
)
1891 if (nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_LOAD_INFO
, &nv
) != 0 ||
1892 nvlist_lookup_nvlist(nv
, ZPOOL_CONFIG_REWIND_INFO
, &nv
) != 0) {
1896 if (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_LOAD_TIME
, &rewindto
) != 0)
1898 (void) nvlist_lookup_int64(nv
, ZPOOL_CONFIG_REWIND_TIME
, &loss
);
1900 if (localtime_r((time_t *)&rewindto
, &t
) != NULL
&&
1901 strftime(timestr
, 128, "%c", &t
) != 0) {
1903 (void) printf(dgettext(TEXT_DOMAIN
,
1904 "Would be able to return %s "
1905 "to its state as of %s.\n"),
1908 (void) printf(dgettext(TEXT_DOMAIN
,
1909 "Pool %s returned to its state as of %s.\n"),
1913 (void) printf(dgettext(TEXT_DOMAIN
,
1914 "%s approximately %lld "),
1915 dryrun
? "Would discard" : "Discarded",
1916 ((longlong_t
)loss
+ 30) / 60);
1917 (void) printf(dgettext(TEXT_DOMAIN
,
1918 "minutes of transactions.\n"));
1919 } else if (loss
> 0) {
1920 (void) printf(dgettext(TEXT_DOMAIN
,
1921 "%s approximately %lld "),
1922 dryrun
? "Would discard" : "Discarded",
1924 (void) printf(dgettext(TEXT_DOMAIN
,
1925 "seconds of transactions.\n"));
1931 zpool_explain_recover(libzfs_handle_t
*hdl
, const char *name
, int reason
,
1934 nvlist_t
*nv
= NULL
;
1936 uint64_t edata
= UINT64_MAX
;
1941 if (!hdl
->libzfs_printerr
)
1945 (void) printf(dgettext(TEXT_DOMAIN
, "action: "));
1947 (void) printf(dgettext(TEXT_DOMAIN
, "\t"));
1949 /* All attempted rewinds failed if ZPOOL_CONFIG_LOAD_TIME missing */
1950 if (nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_LOAD_INFO
, &nv
) != 0 ||
1951 nvlist_lookup_nvlist(nv
, ZPOOL_CONFIG_REWIND_INFO
, &nv
) != 0 ||
1952 nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_LOAD_TIME
, &rewindto
) != 0)
1955 (void) nvlist_lookup_int64(nv
, ZPOOL_CONFIG_REWIND_TIME
, &loss
);
1956 (void) nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_LOAD_DATA_ERRORS
,
1959 (void) printf(dgettext(TEXT_DOMAIN
,
1960 "Recovery is possible, but will result in some data loss.\n"));
1962 if (localtime_r((time_t *)&rewindto
, &t
) != NULL
&&
1963 strftime(timestr
, 128, "%c", &t
) != 0) {
1964 (void) printf(dgettext(TEXT_DOMAIN
,
1965 "\tReturning the pool to its state as of %s\n"
1966 "\tshould correct the problem. "),
1969 (void) printf(dgettext(TEXT_DOMAIN
,
1970 "\tReverting the pool to an earlier state "
1971 "should correct the problem.\n\t"));
1975 (void) printf(dgettext(TEXT_DOMAIN
,
1976 "Approximately %lld minutes of data\n"
1977 "\tmust be discarded, irreversibly. "),
1978 ((longlong_t
)loss
+ 30) / 60);
1979 } else if (loss
> 0) {
1980 (void) printf(dgettext(TEXT_DOMAIN
,
1981 "Approximately %lld seconds of data\n"
1982 "\tmust be discarded, irreversibly. "),
1985 if (edata
!= 0 && edata
!= UINT64_MAX
) {
1987 (void) printf(dgettext(TEXT_DOMAIN
,
1988 "After rewind, at least\n"
1989 "\tone persistent user-data error will remain. "));
1991 (void) printf(dgettext(TEXT_DOMAIN
,
1992 "After rewind, several\n"
1993 "\tpersistent user-data errors will remain. "));
1996 (void) printf(dgettext(TEXT_DOMAIN
,
1997 "Recovery can be attempted\n\tby executing 'zpool %s -F %s'. "),
1998 reason
>= 0 ? "clear" : "import", name
);
2000 (void) printf(dgettext(TEXT_DOMAIN
,
2001 "A scrub of the pool\n"
2002 "\tis strongly recommended after recovery.\n"));
2006 (void) printf(dgettext(TEXT_DOMAIN
,
2007 "Destroy and re-create the pool from\n\ta backup source.\n"));
2011 * zpool_import() is a contracted interface. Should be kept the same
2014 * Applications should use zpool_import_props() to import a pool with
2015 * new properties value to be set.
2018 zpool_import(libzfs_handle_t
*hdl
, nvlist_t
*config
, const char *newname
,
2021 nvlist_t
*props
= NULL
;
2024 if (altroot
!= NULL
) {
2025 if (nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0) != 0) {
2026 return (zfs_error_fmt(hdl
, EZFS_NOMEM
,
2027 dgettext(TEXT_DOMAIN
, "cannot import '%s'"),
2031 if (nvlist_add_string(props
,
2032 zpool_prop_to_name(ZPOOL_PROP_ALTROOT
), altroot
) != 0 ||
2033 nvlist_add_string(props
,
2034 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE
), "none") != 0) {
2036 return (zfs_error_fmt(hdl
, EZFS_NOMEM
,
2037 dgettext(TEXT_DOMAIN
, "cannot import '%s'"),
2042 ret
= zpool_import_props(hdl
, config
, newname
, props
,
2049 print_vdev_tree(libzfs_handle_t
*hdl
, const char *name
, nvlist_t
*nv
,
2055 uint64_t is_log
= 0;
2057 (void) nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_IS_LOG
,
2061 (void) printf("\t%*s%s%s\n", indent
, "", name
,
2062 is_log
? " [log]" : "");
2064 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
2065 &child
, &children
) != 0)
2068 for (c
= 0; c
< children
; c
++) {
2069 vname
= zpool_vdev_name(hdl
, NULL
, child
[c
], VDEV_NAME_TYPE_ID
);
2070 print_vdev_tree(hdl
, vname
, child
[c
], indent
+ 2);
2076 zpool_print_unsup_feat(nvlist_t
*config
)
2078 nvlist_t
*nvinfo
, *unsup_feat
;
2080 nvinfo
= fnvlist_lookup_nvlist(config
, ZPOOL_CONFIG_LOAD_INFO
);
2081 unsup_feat
= fnvlist_lookup_nvlist(nvinfo
, ZPOOL_CONFIG_UNSUP_FEAT
);
2083 for (nvpair_t
*nvp
= nvlist_next_nvpair(unsup_feat
, NULL
);
2084 nvp
!= NULL
; nvp
= nvlist_next_nvpair(unsup_feat
, nvp
)) {
2085 const char *desc
= fnvpair_value_string(nvp
);
2086 if (strlen(desc
) > 0)
2087 (void) printf("\t%s (%s)\n", nvpair_name(nvp
), desc
);
2089 (void) printf("\t%s\n", nvpair_name(nvp
));
2094 * Import the given pool using the known configuration and a list of
2095 * properties to be set. The configuration should have come from
2096 * zpool_find_import(). The 'newname' parameters control whether the pool
2097 * is imported with a different name.
2100 zpool_import_props(libzfs_handle_t
*hdl
, nvlist_t
*config
, const char *newname
,
2101 nvlist_t
*props
, int flags
)
2103 zfs_cmd_t zc
= {"\0"};
2104 zpool_load_policy_t policy
;
2105 nvlist_t
*nv
= NULL
;
2106 nvlist_t
*nvinfo
= NULL
;
2107 nvlist_t
*missing
= NULL
;
2108 const char *thename
;
2109 const char *origname
;
2112 char errbuf
[ERRBUFLEN
];
2114 origname
= fnvlist_lookup_string(config
, ZPOOL_CONFIG_POOL_NAME
);
2116 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
2117 "cannot import pool '%s'"), origname
);
2119 if (newname
!= NULL
) {
2120 if (!zpool_name_valid(hdl
, B_FALSE
, newname
))
2121 return (zfs_error_fmt(hdl
, EZFS_INVALIDNAME
,
2122 dgettext(TEXT_DOMAIN
, "cannot import '%s'"),
2129 if (props
!= NULL
) {
2131 prop_flags_t flags
= { .create
= B_FALSE
, .import
= B_TRUE
};
2133 version
= fnvlist_lookup_uint64(config
, ZPOOL_CONFIG_VERSION
);
2135 if ((props
= zpool_valid_proplist(hdl
, origname
,
2136 props
, version
, flags
, errbuf
)) == NULL
)
2138 zcmd_write_src_nvlist(hdl
, &zc
, props
);
2142 (void) strlcpy(zc
.zc_name
, thename
, sizeof (zc
.zc_name
));
2144 zc
.zc_guid
= fnvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_GUID
);
2146 zcmd_write_conf_nvlist(hdl
, &zc
, config
);
2147 zcmd_alloc_dst_nvlist(hdl
, &zc
, zc
.zc_nvlist_conf_size
* 2);
2149 zc
.zc_cookie
= flags
;
2150 while ((ret
= zfs_ioctl(hdl
, ZFS_IOC_POOL_IMPORT
, &zc
)) != 0 &&
2152 zcmd_expand_dst_nvlist(hdl
, &zc
);
2156 (void) zcmd_read_dst_nvlist(hdl
, &zc
, &nv
);
2158 zcmd_free_nvlists(&zc
);
2160 zpool_get_load_policy(config
, &policy
);
2167 * Dry-run failed, but we print out what success
2168 * looks like if we found a best txg
2170 if (policy
.zlp_rewind
& ZPOOL_TRY_REWIND
) {
2171 zpool_rewind_exclaim(hdl
, newname
? origname
: thename
,
2177 if (newname
== NULL
)
2178 (void) snprintf(desc
, sizeof (desc
),
2179 dgettext(TEXT_DOMAIN
, "cannot import '%s'"),
2182 (void) snprintf(desc
, sizeof (desc
),
2183 dgettext(TEXT_DOMAIN
, "cannot import '%s' as '%s'"),
2188 if (nv
!= NULL
&& nvlist_lookup_nvlist(nv
,
2189 ZPOOL_CONFIG_LOAD_INFO
, &nvinfo
) == 0 &&
2190 nvlist_exists(nvinfo
, ZPOOL_CONFIG_UNSUP_FEAT
)) {
2191 (void) printf(dgettext(TEXT_DOMAIN
, "This "
2192 "pool uses the following feature(s) not "
2193 "supported by this system:\n"));
2194 zpool_print_unsup_feat(nv
);
2195 if (nvlist_exists(nvinfo
,
2196 ZPOOL_CONFIG_CAN_RDONLY
)) {
2197 (void) printf(dgettext(TEXT_DOMAIN
,
2198 "All unsupported features are only "
2199 "required for writing to the pool."
2200 "\nThe pool can be imported using "
2201 "'-o readonly=on'.\n"));
2205 * Unsupported version.
2207 (void) zfs_error(hdl
, EZFS_BADVERSION
, desc
);
2211 if (nv
!= NULL
&& nvlist_lookup_nvlist(nv
,
2212 ZPOOL_CONFIG_LOAD_INFO
, &nvinfo
) == 0) {
2213 const char *hostname
= "<unknown>";
2214 uint64_t hostid
= 0;
2215 mmp_state_t mmp_state
;
2217 mmp_state
= fnvlist_lookup_uint64(nvinfo
,
2218 ZPOOL_CONFIG_MMP_STATE
);
2220 if (nvlist_exists(nvinfo
,
2221 ZPOOL_CONFIG_MMP_HOSTNAME
))
2222 hostname
= fnvlist_lookup_string(nvinfo
,
2223 ZPOOL_CONFIG_MMP_HOSTNAME
);
2225 if (nvlist_exists(nvinfo
,
2226 ZPOOL_CONFIG_MMP_HOSTID
))
2227 hostid
= fnvlist_lookup_uint64(nvinfo
,
2228 ZPOOL_CONFIG_MMP_HOSTID
);
2230 if (mmp_state
== MMP_STATE_ACTIVE
) {
2231 (void) snprintf(aux
, sizeof (aux
),
2232 dgettext(TEXT_DOMAIN
, "pool is imp"
2233 "orted on host '%s' (hostid=%lx).\n"
2234 "Export the pool on the other "
2235 "system, then run 'zpool import'."),
2236 hostname
, (unsigned long) hostid
);
2237 } else if (mmp_state
== MMP_STATE_NO_HOSTID
) {
2238 (void) snprintf(aux
, sizeof (aux
),
2239 dgettext(TEXT_DOMAIN
, "pool has "
2240 "the multihost property on and "
2241 "the\nsystem's hostid is not set. "
2242 "Set a unique system hostid with "
2243 "the zgenhostid(8) command.\n"));
2246 (void) zfs_error_aux(hdl
, "%s", aux
);
2248 (void) zfs_error(hdl
, EZFS_ACTIVE_POOL
, desc
);
2252 (void) zfs_error(hdl
, EZFS_INVALCONFIG
, desc
);
2256 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2257 "one or more devices is read only"));
2258 (void) zfs_error(hdl
, EZFS_BADDEV
, desc
);
2262 if (nv
&& nvlist_lookup_nvlist(nv
,
2263 ZPOOL_CONFIG_LOAD_INFO
, &nvinfo
) == 0 &&
2264 nvlist_lookup_nvlist(nvinfo
,
2265 ZPOOL_CONFIG_MISSING_DEVICES
, &missing
) == 0) {
2266 (void) printf(dgettext(TEXT_DOMAIN
,
2267 "The devices below are missing or "
2268 "corrupted, use '-m' to import the pool "
2270 print_vdev_tree(hdl
, NULL
, missing
, 2);
2271 (void) printf("\n");
2273 (void) zpool_standard_error(hdl
, error
, desc
);
2277 (void) zpool_standard_error(hdl
, error
, desc
);
2281 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2282 "one or more devices are already in use\n"));
2283 (void) zfs_error(hdl
, EZFS_BADDEV
, desc
);
2286 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2287 "new name of at least one dataset is longer than "
2288 "the maximum allowable length"));
2289 (void) zfs_error(hdl
, EZFS_NAMETOOLONG
, desc
);
2292 (void) zpool_standard_error(hdl
, error
, desc
);
2293 zpool_explain_recover(hdl
,
2294 newname
? origname
: thename
, -error
, nv
);
2301 zpool_handle_t
*zhp
;
2304 * This should never fail, but play it safe anyway.
2306 if (zpool_open_silent(hdl
, thename
, &zhp
) != 0)
2308 else if (zhp
!= NULL
)
2310 if (policy
.zlp_rewind
&
2311 (ZPOOL_DO_REWIND
| ZPOOL_TRY_REWIND
)) {
2312 zpool_rewind_exclaim(hdl
, newname
? origname
: thename
,
2313 ((policy
.zlp_rewind
& ZPOOL_TRY_REWIND
) != 0), nv
);
2322 * Translate vdev names to guids. If a vdev_path is determined to be
2323 * unsuitable then a vd_errlist is allocated and the vdev path and errno
2327 zpool_translate_vdev_guids(zpool_handle_t
*zhp
, nvlist_t
*vds
,
2328 nvlist_t
*vdev_guids
, nvlist_t
*guids_to_paths
, nvlist_t
**vd_errlist
)
2330 nvlist_t
*errlist
= NULL
;
2333 for (nvpair_t
*elem
= nvlist_next_nvpair(vds
, NULL
); elem
!= NULL
;
2334 elem
= nvlist_next_nvpair(vds
, elem
)) {
2335 boolean_t spare
, cache
;
2337 const char *vd_path
= nvpair_name(elem
);
2338 nvlist_t
*tgt
= zpool_find_vdev(zhp
, vd_path
, &spare
, &cache
,
2341 if ((tgt
== NULL
) || cache
|| spare
) {
2342 if (errlist
== NULL
) {
2343 errlist
= fnvlist_alloc();
2347 uint64_t err
= (tgt
== NULL
) ? EZFS_NODEVICE
:
2348 (spare
? EZFS_ISSPARE
: EZFS_ISL2CACHE
);
2349 fnvlist_add_int64(errlist
, vd_path
, err
);
2353 uint64_t guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
2354 fnvlist_add_uint64(vdev_guids
, vd_path
, guid
);
2356 char msg
[MAXNAMELEN
];
2357 (void) snprintf(msg
, sizeof (msg
), "%llu", (u_longlong_t
)guid
);
2358 fnvlist_add_string(guids_to_paths
, msg
, vd_path
);
2362 verify(errlist
!= NULL
);
2363 if (vd_errlist
!= NULL
)
2364 *vd_errlist
= errlist
;
2366 fnvlist_free(errlist
);
2373 xlate_init_err(int err
)
2377 return (EZFS_NODEVICE
);
2380 return (EZFS_BADDEV
);
2382 return (EZFS_INITIALIZING
);
2384 return (EZFS_NO_INITIALIZE
);
2390 * Begin, suspend, cancel, or uninit (clear) the initialization (initializing
2391 * of all free blocks) for the given vdevs in the given pool.
2394 zpool_initialize_impl(zpool_handle_t
*zhp
, pool_initialize_func_t cmd_type
,
2395 nvlist_t
*vds
, boolean_t wait
)
2399 nvlist_t
*vdev_guids
= fnvlist_alloc();
2400 nvlist_t
*guids_to_paths
= fnvlist_alloc();
2401 nvlist_t
*vd_errlist
= NULL
;
2405 err
= zpool_translate_vdev_guids(zhp
, vds
, vdev_guids
,
2406 guids_to_paths
, &vd_errlist
);
2409 verify(vd_errlist
!= NULL
);
2413 err
= lzc_initialize(zhp
->zpool_name
, cmd_type
,
2414 vdev_guids
, &errlist
);
2417 if (errlist
!= NULL
&& nvlist_lookup_nvlist(errlist
,
2418 ZPOOL_INITIALIZE_VDEVS
, &vd_errlist
) == 0) {
2422 if (err
== EINVAL
&& cmd_type
== POOL_INITIALIZE_UNINIT
) {
2423 zfs_error_aux(zhp
->zpool_hdl
, dgettext(TEXT_DOMAIN
,
2424 "uninitialize is not supported by kernel"));
2427 (void) zpool_standard_error(zhp
->zpool_hdl
, err
,
2428 dgettext(TEXT_DOMAIN
, "operation failed"));
2433 for (elem
= nvlist_next_nvpair(vdev_guids
, NULL
); elem
!= NULL
;
2434 elem
= nvlist_next_nvpair(vdev_guids
, elem
)) {
2436 uint64_t guid
= fnvpair_value_uint64(elem
);
2438 err
= lzc_wait_tag(zhp
->zpool_name
,
2439 ZPOOL_WAIT_INITIALIZE
, guid
, NULL
);
2441 (void) zpool_standard_error_fmt(zhp
->zpool_hdl
,
2442 err
, dgettext(TEXT_DOMAIN
, "error "
2443 "waiting for '%s' to initialize"),
2453 for (elem
= nvlist_next_nvpair(vd_errlist
, NULL
); elem
!= NULL
;
2454 elem
= nvlist_next_nvpair(vd_errlist
, elem
)) {
2455 int64_t vd_error
= xlate_init_err(fnvpair_value_int64(elem
));
2458 if (nvlist_lookup_string(guids_to_paths
, nvpair_name(elem
),
2460 path
= nvpair_name(elem
);
2462 (void) zfs_error_fmt(zhp
->zpool_hdl
, vd_error
,
2463 "cannot initialize '%s'", path
);
2467 fnvlist_free(vdev_guids
);
2468 fnvlist_free(guids_to_paths
);
2470 if (vd_errlist
!= NULL
)
2471 fnvlist_free(vd_errlist
);
2473 return (err
== 0 ? 0 : -1);
2477 zpool_initialize(zpool_handle_t
*zhp
, pool_initialize_func_t cmd_type
,
2480 return (zpool_initialize_impl(zhp
, cmd_type
, vds
, B_FALSE
));
2484 zpool_initialize_wait(zpool_handle_t
*zhp
, pool_initialize_func_t cmd_type
,
2487 return (zpool_initialize_impl(zhp
, cmd_type
, vds
, B_TRUE
));
2491 xlate_trim_err(int err
)
2495 return (EZFS_NODEVICE
);
2498 return (EZFS_BADDEV
);
2500 return (EZFS_TRIMMING
);
2502 return (EZFS_NO_TRIM
);
2504 return (EZFS_TRIM_NOTSUP
);
2510 zpool_trim_wait(zpool_handle_t
*zhp
, nvlist_t
*vdev_guids
)
2515 for (elem
= nvlist_next_nvpair(vdev_guids
, NULL
); elem
!= NULL
;
2516 elem
= nvlist_next_nvpair(vdev_guids
, elem
)) {
2518 uint64_t guid
= fnvpair_value_uint64(elem
);
2520 err
= lzc_wait_tag(zhp
->zpool_name
,
2521 ZPOOL_WAIT_TRIM
, guid
, NULL
);
2523 (void) zpool_standard_error_fmt(zhp
->zpool_hdl
,
2524 err
, dgettext(TEXT_DOMAIN
, "error "
2525 "waiting to trim '%s'"), nvpair_name(elem
));
2534 * Check errlist and report any errors, omitting ones which should be
2535 * suppressed. Returns B_TRUE if any errors were reported.
2538 check_trim_errs(zpool_handle_t
*zhp
, trimflags_t
*trim_flags
,
2539 nvlist_t
*guids_to_paths
, nvlist_t
*vds
, nvlist_t
*errlist
)
2542 boolean_t reported_errs
= B_FALSE
;
2544 int num_suppressed_errs
= 0;
2546 for (elem
= nvlist_next_nvpair(vds
, NULL
);
2547 elem
!= NULL
; elem
= nvlist_next_nvpair(vds
, elem
)) {
2551 for (elem
= nvlist_next_nvpair(errlist
, NULL
);
2552 elem
!= NULL
; elem
= nvlist_next_nvpair(errlist
, elem
)) {
2553 int64_t vd_error
= xlate_trim_err(fnvpair_value_int64(elem
));
2557 * If only the pool was specified, and it was not a secure
2558 * trim then suppress warnings for individual vdevs which
2559 * do not support trimming.
2561 if (vd_error
== EZFS_TRIM_NOTSUP
&&
2562 trim_flags
->fullpool
&&
2563 !trim_flags
->secure
) {
2564 num_suppressed_errs
++;
2568 reported_errs
= B_TRUE
;
2569 if (nvlist_lookup_string(guids_to_paths
, nvpair_name(elem
),
2571 path
= nvpair_name(elem
);
2573 (void) zfs_error_fmt(zhp
->zpool_hdl
, vd_error
,
2574 "cannot trim '%s'", path
);
2577 if (num_suppressed_errs
== num_vds
) {
2578 (void) zfs_error_aux(zhp
->zpool_hdl
, dgettext(TEXT_DOMAIN
,
2579 "no devices in pool support trim operations"));
2580 (void) (zfs_error(zhp
->zpool_hdl
, EZFS_TRIM_NOTSUP
,
2581 dgettext(TEXT_DOMAIN
, "cannot trim")));
2582 reported_errs
= B_TRUE
;
2585 return (reported_errs
);
2589 * Begin, suspend, or cancel the TRIM (discarding of all free blocks) for
2590 * the given vdevs in the given pool.
2593 zpool_trim(zpool_handle_t
*zhp
, pool_trim_func_t cmd_type
, nvlist_t
*vds
,
2594 trimflags_t
*trim_flags
)
2599 nvlist_t
*vdev_guids
= fnvlist_alloc();
2600 nvlist_t
*guids_to_paths
= fnvlist_alloc();
2601 nvlist_t
*errlist
= NULL
;
2603 err
= zpool_translate_vdev_guids(zhp
, vds
, vdev_guids
,
2604 guids_to_paths
, &errlist
);
2606 check_trim_errs(zhp
, trim_flags
, guids_to_paths
, vds
, errlist
);
2611 err
= lzc_trim(zhp
->zpool_name
, cmd_type
, trim_flags
->rate
,
2612 trim_flags
->secure
, vdev_guids
, &errlist
);
2614 nvlist_t
*vd_errlist
;
2615 if (errlist
!= NULL
&& nvlist_lookup_nvlist(errlist
,
2616 ZPOOL_TRIM_VDEVS
, &vd_errlist
) == 0) {
2617 if (check_trim_errs(zhp
, trim_flags
, guids_to_paths
,
2623 char errbuf
[ERRBUFLEN
];
2625 (void) snprintf(errbuf
, sizeof (errbuf
),
2626 dgettext(TEXT_DOMAIN
, "operation failed"));
2627 zpool_standard_error(zhp
->zpool_hdl
, err
, errbuf
);
2634 if (trim_flags
->wait
)
2635 retval
= zpool_trim_wait(zhp
, vdev_guids
);
2638 if (errlist
!= NULL
)
2639 fnvlist_free(errlist
);
2640 fnvlist_free(vdev_guids
);
2641 fnvlist_free(guids_to_paths
);
2649 zpool_scan(zpool_handle_t
*zhp
, pool_scan_func_t func
, pool_scrub_cmd_t cmd
)
2651 char errbuf
[ERRBUFLEN
];
2653 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
2655 nvlist_t
*args
= fnvlist_alloc();
2656 fnvlist_add_uint64(args
, "scan_type", (uint64_t)func
);
2657 fnvlist_add_uint64(args
, "scan_command", (uint64_t)cmd
);
2659 err
= lzc_scrub(ZFS_IOC_POOL_SCRUB
, zhp
->zpool_name
, args
, NULL
);
2664 } else if (err
== ZFS_ERR_IOC_CMD_UNAVAIL
) {
2665 zfs_cmd_t zc
= {"\0"};
2666 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
,
2667 sizeof (zc
.zc_name
));
2668 zc
.zc_cookie
= func
;
2671 if (zfs_ioctl(hdl
, ZFS_IOC_POOL_SCAN
, &zc
) == 0)
2676 * An ECANCELED on a scrub means one of the following:
2677 * 1. we resumed a paused scrub.
2678 * 2. we resumed a paused error scrub.
2679 * 3. Error scrub is not run because of no error log.
2681 if (err
== ECANCELED
&& (func
== POOL_SCAN_SCRUB
||
2682 func
== POOL_SCAN_ERRORSCRUB
) && cmd
== POOL_SCRUB_NORMAL
)
2685 * The following cases have been handled here:
2686 * 1. Paused a scrub/error scrub if there is none in progress.
2688 if (err
== ENOENT
&& func
!= POOL_SCAN_NONE
&& cmd
==
2693 ASSERT3U(func
, >=, POOL_SCAN_NONE
);
2694 ASSERT3U(func
, <, POOL_SCAN_FUNCS
);
2696 if (func
== POOL_SCAN_SCRUB
|| func
== POOL_SCAN_ERRORSCRUB
) {
2697 if (cmd
== POOL_SCRUB_PAUSE
) {
2698 (void) snprintf(errbuf
, sizeof (errbuf
),
2699 dgettext(TEXT_DOMAIN
, "cannot pause scrubbing %s"),
2702 assert(cmd
== POOL_SCRUB_NORMAL
);
2703 (void) snprintf(errbuf
, sizeof (errbuf
),
2704 dgettext(TEXT_DOMAIN
, "cannot scrub %s"),
2707 } else if (func
== POOL_SCAN_RESILVER
) {
2708 assert(cmd
== POOL_SCRUB_NORMAL
);
2709 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
2710 "cannot restart resilver on %s"), zhp
->zpool_name
);
2711 } else if (func
== POOL_SCAN_NONE
) {
2712 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
2713 "cannot cancel scrubbing %s"), zhp
->zpool_name
);
2715 assert(!"unexpected result");
2719 * With EBUSY, five cases are possible:
2721 * Current state Requested
2722 * 1. Normal Scrub Running Normal Scrub or Error Scrub
2723 * 2. Normal Scrub Paused Error Scrub
2724 * 3. Normal Scrub Paused Pause Normal Scrub
2725 * 4. Error Scrub Running Normal Scrub or Error Scrub
2726 * 5. Error Scrub Paused Pause Error Scrub
2727 * 6. Resilvering Anything else
2731 pool_scan_stat_t
*ps
= NULL
;
2734 nvroot
= fnvlist_lookup_nvlist(zhp
->zpool_config
,
2735 ZPOOL_CONFIG_VDEV_TREE
);
2736 (void) nvlist_lookup_uint64_array(nvroot
,
2737 ZPOOL_CONFIG_SCAN_STATS
, (uint64_t **)&ps
, &psc
);
2738 if (ps
&& ps
->pss_func
== POOL_SCAN_SCRUB
&&
2739 ps
->pss_state
== DSS_SCANNING
) {
2740 if (ps
->pss_pass_scrub_pause
== 0) {
2741 /* handles case 1 */
2742 assert(cmd
== POOL_SCRUB_NORMAL
);
2743 return (zfs_error(hdl
, EZFS_SCRUBBING
,
2746 if (func
== POOL_SCAN_ERRORSCRUB
) {
2747 /* handles case 2 */
2748 ASSERT3U(cmd
, ==, POOL_SCRUB_NORMAL
);
2749 return (zfs_error(hdl
,
2750 EZFS_SCRUB_PAUSED_TO_CANCEL
,
2753 /* handles case 3 */
2754 ASSERT3U(func
, ==, POOL_SCAN_SCRUB
);
2755 ASSERT3U(cmd
, ==, POOL_SCRUB_PAUSE
);
2756 return (zfs_error(hdl
,
2757 EZFS_SCRUB_PAUSED
, errbuf
));
2761 ps
->pss_error_scrub_func
== POOL_SCAN_ERRORSCRUB
&&
2762 ps
->pss_error_scrub_state
== DSS_ERRORSCRUBBING
) {
2763 if (ps
->pss_pass_error_scrub_pause
== 0) {
2764 /* handles case 4 */
2765 ASSERT3U(cmd
, ==, POOL_SCRUB_NORMAL
);
2766 return (zfs_error(hdl
, EZFS_ERRORSCRUBBING
,
2769 /* handles case 5 */
2770 ASSERT3U(func
, ==, POOL_SCAN_ERRORSCRUB
);
2771 ASSERT3U(cmd
, ==, POOL_SCRUB_PAUSE
);
2772 return (zfs_error(hdl
, EZFS_ERRORSCRUB_PAUSED
,
2776 /* handles case 6 */
2777 return (zfs_error(hdl
, EZFS_RESILVERING
, errbuf
));
2779 } else if (err
== ENOENT
) {
2780 return (zfs_error(hdl
, EZFS_NO_SCRUB
, errbuf
));
2781 } else if (err
== ENOTSUP
&& func
== POOL_SCAN_RESILVER
) {
2782 return (zfs_error(hdl
, EZFS_NO_RESILVER_DEFER
, errbuf
));
2784 return (zpool_standard_error(hdl
, err
, errbuf
));
2789 * Find a vdev that matches the search criteria specified. We use the
2790 * the nvpair name to determine how we should look for the device.
2791 * 'avail_spare' is set to TRUE if the provided guid refers to an AVAIL
2792 * spare; but FALSE if its an INUSE spare.
2795 vdev_to_nvlist_iter(nvlist_t
*nv
, nvlist_t
*search
, boolean_t
*avail_spare
,
2796 boolean_t
*l2cache
, boolean_t
*log
)
2802 const char *srchkey
;
2803 nvpair_t
*pair
= nvlist_next_nvpair(search
, NULL
);
2805 /* Nothing to look for */
2806 if (search
== NULL
|| pair
== NULL
)
2809 /* Obtain the key we will use to search */
2810 srchkey
= nvpair_name(pair
);
2812 switch (nvpair_type(pair
)) {
2813 case DATA_TYPE_UINT64
:
2814 if (strcmp(srchkey
, ZPOOL_CONFIG_GUID
) == 0) {
2815 uint64_t srchval
= fnvpair_value_uint64(pair
);
2816 uint64_t theguid
= fnvlist_lookup_uint64(nv
,
2818 if (theguid
== srchval
)
2823 case DATA_TYPE_STRING
: {
2824 const char *srchval
, *val
;
2826 srchval
= fnvpair_value_string(pair
);
2827 if (nvlist_lookup_string(nv
, srchkey
, &val
) != 0)
2831 * Search for the requested value. Special cases:
2833 * - ZPOOL_CONFIG_PATH for whole disk entries. These end in
2834 * "-part1", or "p1". The suffix is hidden from the user,
2835 * but included in the string, so this matches around it.
2836 * - ZPOOL_CONFIG_PATH for short names zfs_strcmp_shortname()
2837 * is used to check all possible expanded paths.
2838 * - looking for a top-level vdev name (i.e. ZPOOL_CONFIG_TYPE).
2840 * Otherwise, all other searches are simple string compares.
2842 if (strcmp(srchkey
, ZPOOL_CONFIG_PATH
) == 0) {
2843 uint64_t wholedisk
= 0;
2845 (void) nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_WHOLE_DISK
,
2847 if (zfs_strcmp_pathname(srchval
, val
, wholedisk
) == 0)
2850 } else if (strcmp(srchkey
, ZPOOL_CONFIG_TYPE
) == 0) {
2851 char *type
, *idx
, *end
, *p
;
2852 uint64_t id
, vdev_id
;
2855 * Determine our vdev type, keeping in mind
2856 * that the srchval is composed of a type and
2857 * vdev id pair (i.e. mirror-4).
2859 if ((type
= strdup(srchval
)) == NULL
)
2862 if ((p
= strrchr(type
, '-')) == NULL
) {
2870 * If the types don't match then keep looking.
2872 if (strncmp(val
, type
, strlen(val
)) != 0) {
2877 verify(zpool_vdev_is_interior(type
));
2879 id
= fnvlist_lookup_uint64(nv
, ZPOOL_CONFIG_ID
);
2881 vdev_id
= strtoull(idx
, &end
, 10);
2884 * If we are looking for a raidz and a parity is
2885 * specified, make sure it matches.
2887 int rzlen
= strlen(VDEV_TYPE_RAIDZ
);
2888 assert(rzlen
== strlen(VDEV_TYPE_DRAID
));
2889 int typlen
= strlen(type
);
2890 if ((strncmp(type
, VDEV_TYPE_RAIDZ
, rzlen
) == 0 ||
2891 strncmp(type
, VDEV_TYPE_DRAID
, rzlen
) == 0) &&
2893 uint64_t vdev_parity
;
2894 int parity
= *(type
+ rzlen
) - '0';
2896 if (parity
<= 0 || parity
> 3 ||
2897 (typlen
- rzlen
) != 1) {
2899 * Nonsense parity specified, can
2905 vdev_parity
= fnvlist_lookup_uint64(nv
,
2906 ZPOOL_CONFIG_NPARITY
);
2907 if ((int)vdev_parity
!= parity
) {
2918 * Now verify that we have the correct vdev id.
2927 if (strcmp(srchval
, val
) == 0)
2936 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
2937 &child
, &children
) != 0)
2940 for (c
= 0; c
< children
; c
++) {
2941 if ((ret
= vdev_to_nvlist_iter(child
[c
], search
,
2942 avail_spare
, l2cache
, NULL
)) != NULL
) {
2944 * The 'is_log' value is only set for the toplevel
2945 * vdev, not the leaf vdevs. So we always lookup the
2946 * log device from the root of the vdev tree (where
2947 * 'log' is non-NULL).
2950 nvlist_lookup_uint64(child
[c
],
2951 ZPOOL_CONFIG_IS_LOG
, &is_log
) == 0 &&
2959 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_SPARES
,
2960 &child
, &children
) == 0) {
2961 for (c
= 0; c
< children
; c
++) {
2962 if ((ret
= vdev_to_nvlist_iter(child
[c
], search
,
2963 avail_spare
, l2cache
, NULL
)) != NULL
) {
2964 *avail_spare
= B_TRUE
;
2970 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_L2CACHE
,
2971 &child
, &children
) == 0) {
2972 for (c
= 0; c
< children
; c
++) {
2973 if ((ret
= vdev_to_nvlist_iter(child
[c
], search
,
2974 avail_spare
, l2cache
, NULL
)) != NULL
) {
2985 * Given a physical path or guid, find the associated vdev.
2988 zpool_find_vdev_by_physpath(zpool_handle_t
*zhp
, const char *ppath
,
2989 boolean_t
*avail_spare
, boolean_t
*l2cache
, boolean_t
*log
)
2991 nvlist_t
*search
, *nvroot
, *ret
;
2995 search
= fnvlist_alloc();
2997 guid
= strtoull(ppath
, &end
, 0);
2998 if (guid
!= 0 && *end
== '\0') {
2999 fnvlist_add_uint64(search
, ZPOOL_CONFIG_GUID
, guid
);
3001 fnvlist_add_string(search
, ZPOOL_CONFIG_PHYS_PATH
, ppath
);
3004 nvroot
= fnvlist_lookup_nvlist(zhp
->zpool_config
,
3005 ZPOOL_CONFIG_VDEV_TREE
);
3007 *avail_spare
= B_FALSE
;
3011 ret
= vdev_to_nvlist_iter(nvroot
, search
, avail_spare
, l2cache
, log
);
3012 fnvlist_free(search
);
3018 * Determine if we have an "interior" top-level vdev (i.e mirror/raidz).
3021 zpool_vdev_is_interior(const char *name
)
3023 if (strncmp(name
, VDEV_TYPE_RAIDZ
, strlen(VDEV_TYPE_RAIDZ
)) == 0 ||
3024 strncmp(name
, VDEV_TYPE_SPARE
, strlen(VDEV_TYPE_SPARE
)) == 0 ||
3026 VDEV_TYPE_REPLACING
, strlen(VDEV_TYPE_REPLACING
)) == 0 ||
3027 strncmp(name
, VDEV_TYPE_ROOT
, strlen(VDEV_TYPE_ROOT
)) == 0 ||
3028 strncmp(name
, VDEV_TYPE_MIRROR
, strlen(VDEV_TYPE_MIRROR
)) == 0)
3031 if (strncmp(name
, VDEV_TYPE_DRAID
, strlen(VDEV_TYPE_DRAID
)) == 0 &&
3032 !zpool_is_draid_spare(name
))
3039 zpool_find_vdev(zpool_handle_t
*zhp
, const char *path
, boolean_t
*avail_spare
,
3040 boolean_t
*l2cache
, boolean_t
*log
)
3043 nvlist_t
*nvroot
, *search
, *ret
;
3046 search
= fnvlist_alloc();
3048 guid
= strtoull(path
, &end
, 0);
3049 if (guid
!= 0 && *end
== '\0') {
3050 fnvlist_add_uint64(search
, ZPOOL_CONFIG_GUID
, guid
);
3051 } else if (zpool_vdev_is_interior(path
)) {
3052 fnvlist_add_string(search
, ZPOOL_CONFIG_TYPE
, path
);
3054 fnvlist_add_string(search
, ZPOOL_CONFIG_PATH
, path
);
3057 nvroot
= fnvlist_lookup_nvlist(zhp
->zpool_config
,
3058 ZPOOL_CONFIG_VDEV_TREE
);
3060 *avail_spare
= B_FALSE
;
3064 ret
= vdev_to_nvlist_iter(nvroot
, search
, avail_spare
, l2cache
, log
);
3065 fnvlist_free(search
);
3071 * Convert a vdev path to a GUID. Returns GUID or 0 on error.
3073 * If is_spare, is_l2cache, or is_log is non-NULL, then store within it
3074 * if the VDEV is a spare, l2cache, or log device. If they're NULL then
3078 zpool_vdev_path_to_guid_impl(zpool_handle_t
*zhp
, const char *path
,
3079 boolean_t
*is_spare
, boolean_t
*is_l2cache
, boolean_t
*is_log
)
3081 boolean_t spare
= B_FALSE
, l2cache
= B_FALSE
, log
= B_FALSE
;
3084 if ((tgt
= zpool_find_vdev(zhp
, path
, &spare
, &l2cache
,
3088 if (is_spare
!= NULL
)
3090 if (is_l2cache
!= NULL
)
3091 *is_l2cache
= l2cache
;
3095 return (fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
));
3098 /* Convert a vdev path to a GUID. Returns GUID or 0 on error. */
3100 zpool_vdev_path_to_guid(zpool_handle_t
*zhp
, const char *path
)
3102 return (zpool_vdev_path_to_guid_impl(zhp
, path
, NULL
, NULL
, NULL
));
3106 * Bring the specified vdev online. The 'flags' parameter is a set of the
3107 * ZFS_ONLINE_* flags.
3110 zpool_vdev_online(zpool_handle_t
*zhp
, const char *path
, int flags
,
3111 vdev_state_t
*newstate
)
3113 zfs_cmd_t zc
= {"\0"};
3114 char errbuf
[ERRBUFLEN
];
3116 boolean_t avail_spare
, l2cache
, islog
;
3117 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3119 if (flags
& ZFS_ONLINE_EXPAND
) {
3120 (void) snprintf(errbuf
, sizeof (errbuf
),
3121 dgettext(TEXT_DOMAIN
, "cannot expand %s"), path
);
3123 (void) snprintf(errbuf
, sizeof (errbuf
),
3124 dgettext(TEXT_DOMAIN
, "cannot online %s"), path
);
3127 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3128 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
3130 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3132 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
3134 if (!(flags
& ZFS_ONLINE_SPARE
) && avail_spare
)
3135 return (zfs_error(hdl
, EZFS_ISSPARE
, errbuf
));
3138 const char *pathname
;
3139 if ((flags
& ZFS_ONLINE_EXPAND
||
3140 zpool_get_prop_int(zhp
, ZPOOL_PROP_AUTOEXPAND
, NULL
)) &&
3141 nvlist_lookup_string(tgt
, ZPOOL_CONFIG_PATH
, &pathname
) == 0) {
3142 uint64_t wholedisk
= 0;
3144 (void) nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_WHOLE_DISK
,
3148 * XXX - L2ARC 1.0 devices can't support expansion.
3151 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3152 "cannot expand cache devices"));
3153 return (zfs_error(hdl
, EZFS_VDEVNOTSUP
, errbuf
));
3157 const char *fullpath
= path
;
3158 char buf
[MAXPATHLEN
];
3161 if (path
[0] != '/') {
3162 error
= zfs_resolve_shortname(path
, buf
,
3165 return (zfs_error(hdl
, EZFS_NODEVICE
,
3171 error
= zpool_relabel_disk(hdl
, fullpath
, errbuf
);
3178 zc
.zc_cookie
= VDEV_STATE_ONLINE
;
3181 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SET_STATE
, &zc
) != 0) {
3182 if (errno
== EINVAL
) {
3183 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "was split "
3184 "from this pool into a new one. Use '%s' "
3185 "instead"), "zpool detach");
3186 return (zfs_error(hdl
, EZFS_POSTSPLIT_ONLINE
, errbuf
));
3188 return (zpool_standard_error(hdl
, errno
, errbuf
));
3191 *newstate
= zc
.zc_cookie
;
3196 * Take the specified vdev offline
3199 zpool_vdev_offline(zpool_handle_t
*zhp
, const char *path
, boolean_t istmp
)
3201 zfs_cmd_t zc
= {"\0"};
3202 char errbuf
[ERRBUFLEN
];
3204 boolean_t avail_spare
, l2cache
;
3205 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3207 (void) snprintf(errbuf
, sizeof (errbuf
),
3208 dgettext(TEXT_DOMAIN
, "cannot offline %s"), path
);
3210 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3211 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
3213 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3215 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
3218 return (zfs_error(hdl
, EZFS_ISSPARE
, errbuf
));
3220 zc
.zc_cookie
= VDEV_STATE_OFFLINE
;
3221 zc
.zc_obj
= istmp
? ZFS_OFFLINE_TEMPORARY
: 0;
3223 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SET_STATE
, &zc
) == 0)
3230 * There are no other replicas of this device.
3232 return (zfs_error(hdl
, EZFS_NOREPLICAS
, errbuf
));
3236 * The log device has unplayed logs
3238 return (zfs_error(hdl
, EZFS_UNPLAYED_LOGS
, errbuf
));
3241 return (zpool_standard_error(hdl
, errno
, errbuf
));
3246 * Remove the specified vdev asynchronously from the configuration, so
3247 * that it may come ONLINE if reinserted. This is called from zed on
3248 * Udev remove event.
3249 * Note: We also have a similar function zpool_vdev_remove() that
3250 * removes the vdev from the pool.
3253 zpool_vdev_remove_wanted(zpool_handle_t
*zhp
, const char *path
)
3255 zfs_cmd_t zc
= {"\0"};
3256 char errbuf
[ERRBUFLEN
];
3258 boolean_t avail_spare
, l2cache
;
3259 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3261 (void) snprintf(errbuf
, sizeof (errbuf
),
3262 dgettext(TEXT_DOMAIN
, "cannot remove %s"), path
);
3264 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3265 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
3267 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3269 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
3271 zc
.zc_cookie
= VDEV_STATE_REMOVED
;
3273 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SET_STATE
, &zc
) == 0)
3276 return (zpool_standard_error(hdl
, errno
, errbuf
));
3280 * Mark the given vdev faulted.
3283 zpool_vdev_fault(zpool_handle_t
*zhp
, uint64_t guid
, vdev_aux_t aux
)
3285 zfs_cmd_t zc
= {"\0"};
3286 char errbuf
[ERRBUFLEN
];
3287 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3289 (void) snprintf(errbuf
, sizeof (errbuf
),
3290 dgettext(TEXT_DOMAIN
, "cannot fault %llu"), (u_longlong_t
)guid
);
3292 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3294 zc
.zc_cookie
= VDEV_STATE_FAULTED
;
3297 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SET_STATE
, &zc
) == 0)
3304 * There are no other replicas of this device.
3306 return (zfs_error(hdl
, EZFS_NOREPLICAS
, errbuf
));
3309 return (zpool_standard_error(hdl
, errno
, errbuf
));
3315 * Mark the given vdev degraded.
3318 zpool_vdev_degrade(zpool_handle_t
*zhp
, uint64_t guid
, vdev_aux_t aux
)
3320 zfs_cmd_t zc
= {"\0"};
3321 char errbuf
[ERRBUFLEN
];
3322 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3324 (void) snprintf(errbuf
, sizeof (errbuf
),
3325 dgettext(TEXT_DOMAIN
, "cannot degrade %llu"), (u_longlong_t
)guid
);
3327 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3329 zc
.zc_cookie
= VDEV_STATE_DEGRADED
;
3332 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SET_STATE
, &zc
) == 0)
3335 return (zpool_standard_error(hdl
, errno
, errbuf
));
3339 * Returns TRUE if the given nvlist is a vdev that was originally swapped in as
3343 is_replacing_spare(nvlist_t
*search
, nvlist_t
*tgt
, int which
)
3348 if (nvlist_lookup_nvlist_array(search
, ZPOOL_CONFIG_CHILDREN
, &child
,
3350 const char *type
= fnvlist_lookup_string(search
,
3352 if ((strcmp(type
, VDEV_TYPE_SPARE
) == 0 ||
3353 strcmp(type
, VDEV_TYPE_DRAID_SPARE
) == 0) &&
3354 children
== 2 && child
[which
] == tgt
)
3357 for (c
= 0; c
< children
; c
++)
3358 if (is_replacing_spare(child
[c
], tgt
, which
))
3366 * Attach new_disk (fully described by nvroot) to old_disk.
3367 * If 'replacing' is specified, the new disk will replace the old one.
3370 zpool_vdev_attach(zpool_handle_t
*zhp
, const char *old_disk
,
3371 const char *new_disk
, nvlist_t
*nvroot
, int replacing
, boolean_t rebuild
)
3373 zfs_cmd_t zc
= {"\0"};
3374 char errbuf
[ERRBUFLEN
];
3377 boolean_t avail_spare
, l2cache
, islog
;
3382 nvlist_t
*config_root
;
3383 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3386 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3387 "cannot replace %s with %s"), old_disk
, new_disk
);
3389 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
3390 "cannot attach %s to %s"), new_disk
, old_disk
);
3392 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3393 if ((tgt
= zpool_find_vdev(zhp
, old_disk
, &avail_spare
, &l2cache
,
3395 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3398 return (zfs_error(hdl
, EZFS_ISSPARE
, errbuf
));
3401 return (zfs_error(hdl
, EZFS_ISL2CACHE
, errbuf
));
3403 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
3404 zc
.zc_cookie
= replacing
;
3405 zc
.zc_simple
= rebuild
;
3408 zfeature_lookup_guid("org.openzfs:device_rebuild", NULL
) != 0) {
3409 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3410 "the loaded zfs module doesn't support device rebuilds"));
3411 return (zfs_error(hdl
, EZFS_POOL_NOTSUP
, errbuf
));
3414 if (nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_CHILDREN
,
3415 &child
, &children
) != 0 || children
!= 1) {
3416 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3417 "new device must be a single disk"));
3418 return (zfs_error(hdl
, EZFS_INVALCONFIG
, errbuf
));
3421 config_root
= fnvlist_lookup_nvlist(zpool_get_config(zhp
, NULL
),
3422 ZPOOL_CONFIG_VDEV_TREE
);
3424 if ((newname
= zpool_vdev_name(NULL
, NULL
, child
[0], 0)) == NULL
)
3428 * If the target is a hot spare that has been swapped in, we can only
3429 * replace it with another hot spare.
3432 nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_IS_SPARE
, &val
) == 0 &&
3433 (zpool_find_vdev(zhp
, newname
, &avail_spare
, &l2cache
,
3434 NULL
) == NULL
|| !avail_spare
) &&
3435 is_replacing_spare(config_root
, tgt
, 1)) {
3436 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3437 "can only be replaced by another hot spare"));
3439 return (zfs_error(hdl
, EZFS_BADTARGET
, errbuf
));
3444 zcmd_write_conf_nvlist(hdl
, &zc
, nvroot
);
3446 ret
= zfs_ioctl(hdl
, ZFS_IOC_VDEV_ATTACH
, &zc
);
3448 zcmd_free_nvlists(&zc
);
3456 * Can't attach to or replace this type of vdev.
3459 uint64_t version
= zpool_get_prop_int(zhp
,
3460 ZPOOL_PROP_VERSION
, NULL
);
3463 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3464 "cannot replace a log with a spare"));
3465 } else if (rebuild
) {
3466 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3467 "only mirror and dRAID vdevs support "
3468 "sequential reconstruction"));
3469 } else if (zpool_is_draid_spare(new_disk
)) {
3470 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3471 "dRAID spares can only replace child "
3472 "devices in their parent's dRAID vdev"));
3473 } else if (version
>= SPA_VERSION_MULTI_REPLACE
) {
3474 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3475 "already in replacing/spare config; wait "
3476 "for completion or use 'zpool detach'"));
3478 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3479 "cannot replace a replacing device"));
3482 char status
[64] = {0};
3483 zpool_prop_get_feature(zhp
,
3484 "feature@device_rebuild", status
, 63);
3486 strncmp(status
, ZFS_FEATURE_DISABLED
, 64) == 0) {
3487 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3488 "device_rebuild feature must be enabled "
3489 "in order to use sequential "
3492 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3493 "can only attach to mirrors and top-level "
3497 (void) zfs_error(hdl
, EZFS_BADTARGET
, errbuf
);
3502 * The new device must be a single disk.
3504 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3505 "new device must be a single disk"));
3506 (void) zfs_error(hdl
, EZFS_INVALCONFIG
, errbuf
);
3510 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "%s is busy, "
3511 "or device removal is in progress"),
3513 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
3518 * The new device is too small.
3520 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3521 "device is too small"));
3522 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
3527 * The new device has a different optimal sector size.
3529 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3530 "new device has a different optimal sector size; use the "
3531 "option '-o ashift=N' to override the optimal size"));
3532 (void) zfs_error(hdl
, EZFS_BADDEV
, errbuf
);
3537 * The resulting top-level vdev spec won't fit in the label.
3539 (void) zfs_error(hdl
, EZFS_DEVOVERFLOW
, errbuf
);
3543 (void) zpool_standard_error(hdl
, errno
, errbuf
);
3550 * Detach the specified device.
3553 zpool_vdev_detach(zpool_handle_t
*zhp
, const char *path
)
3555 zfs_cmd_t zc
= {"\0"};
3556 char errbuf
[ERRBUFLEN
];
3558 boolean_t avail_spare
, l2cache
;
3559 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3561 (void) snprintf(errbuf
, sizeof (errbuf
),
3562 dgettext(TEXT_DOMAIN
, "cannot detach %s"), path
);
3564 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3565 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
3567 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3570 return (zfs_error(hdl
, EZFS_ISSPARE
, errbuf
));
3573 return (zfs_error(hdl
, EZFS_ISL2CACHE
, errbuf
));
3575 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
3577 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_DETACH
, &zc
) == 0)
3584 * Can't detach from this type of vdev.
3586 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "only "
3587 "applicable to mirror and replacing vdevs"));
3588 (void) zfs_error(hdl
, EZFS_BADTARGET
, errbuf
);
3593 * There are no other replicas of this device.
3595 (void) zfs_error(hdl
, EZFS_NOREPLICAS
, errbuf
);
3599 (void) zpool_standard_error(hdl
, errno
, errbuf
);
3606 * Find a mirror vdev in the source nvlist.
3608 * The mchild array contains a list of disks in one of the top-level mirrors
3609 * of the source pool. The schild array contains a list of disks that the
3610 * user specified on the command line. We loop over the mchild array to
3611 * see if any entry in the schild array matches.
3613 * If a disk in the mchild array is found in the schild array, we return
3614 * the index of that entry. Otherwise we return -1.
3617 find_vdev_entry(zpool_handle_t
*zhp
, nvlist_t
**mchild
, uint_t mchildren
,
3618 nvlist_t
**schild
, uint_t schildren
)
3622 for (mc
= 0; mc
< mchildren
; mc
++) {
3624 char *mpath
= zpool_vdev_name(zhp
->zpool_hdl
, zhp
,
3627 for (sc
= 0; sc
< schildren
; sc
++) {
3628 char *spath
= zpool_vdev_name(zhp
->zpool_hdl
, zhp
,
3630 boolean_t result
= (strcmp(mpath
, spath
) == 0);
3646 * Split a mirror pool. If newroot points to null, then a new nvlist
3647 * is generated and it is the responsibility of the caller to free it.
3650 zpool_vdev_split(zpool_handle_t
*zhp
, char *newname
, nvlist_t
**newroot
,
3651 nvlist_t
*props
, splitflags_t flags
)
3653 zfs_cmd_t zc
= {"\0"};
3654 char errbuf
[ERRBUFLEN
];
3656 nvlist_t
*tree
, *config
, **child
, **newchild
, *newconfig
= NULL
;
3657 nvlist_t
**varray
= NULL
, *zc_props
= NULL
;
3658 uint_t c
, children
, newchildren
, lastlog
= 0, vcount
, found
= 0;
3659 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3660 uint64_t vers
, readonly
= B_FALSE
;
3661 boolean_t freelist
= B_FALSE
, memory_err
= B_TRUE
;
3664 (void) snprintf(errbuf
, sizeof (errbuf
),
3665 dgettext(TEXT_DOMAIN
, "Unable to split %s"), zhp
->zpool_name
);
3667 if (!zpool_name_valid(hdl
, B_FALSE
, newname
))
3668 return (zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
));
3670 if ((config
= zpool_get_config(zhp
, NULL
)) == NULL
) {
3671 (void) fprintf(stderr
, gettext("Internal error: unable to "
3672 "retrieve pool configuration\n"));
3676 tree
= fnvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
);
3677 vers
= fnvlist_lookup_uint64(config
, ZPOOL_CONFIG_VERSION
);
3680 prop_flags_t flags
= { .create
= B_FALSE
, .import
= B_TRUE
};
3681 if ((zc_props
= zpool_valid_proplist(hdl
, zhp
->zpool_name
,
3682 props
, vers
, flags
, errbuf
)) == NULL
)
3684 (void) nvlist_lookup_uint64(zc_props
,
3685 zpool_prop_to_name(ZPOOL_PROP_READONLY
), &readonly
);
3687 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3688 "property %s can only be set at import time"),
3689 zpool_prop_to_name(ZPOOL_PROP_READONLY
));
3694 if (nvlist_lookup_nvlist_array(tree
, ZPOOL_CONFIG_CHILDREN
, &child
,
3696 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3697 "Source pool is missing vdev tree"));
3698 nvlist_free(zc_props
);
3702 varray
= zfs_alloc(hdl
, children
* sizeof (nvlist_t
*));
3705 if (*newroot
== NULL
||
3706 nvlist_lookup_nvlist_array(*newroot
, ZPOOL_CONFIG_CHILDREN
,
3707 &newchild
, &newchildren
) != 0)
3710 for (c
= 0; c
< children
; c
++) {
3711 uint64_t is_log
= B_FALSE
, is_hole
= B_FALSE
;
3712 boolean_t is_special
= B_FALSE
, is_dedup
= B_FALSE
;
3714 nvlist_t
**mchild
, *vdev
;
3719 * Unlike cache & spares, slogs are stored in the
3720 * ZPOOL_CONFIG_CHILDREN array. We filter them out here.
3722 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_LOG
,
3724 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_HOLE
,
3726 if (is_log
|| is_hole
) {
3728 * Create a hole vdev and put it in the config.
3730 if (nvlist_alloc(&vdev
, NV_UNIQUE_NAME
, 0) != 0)
3732 if (nvlist_add_string(vdev
, ZPOOL_CONFIG_TYPE
,
3733 VDEV_TYPE_HOLE
) != 0)
3735 if (nvlist_add_uint64(vdev
, ZPOOL_CONFIG_IS_HOLE
,
3740 varray
[vcount
++] = vdev
;
3744 type
= fnvlist_lookup_string(child
[c
], ZPOOL_CONFIG_TYPE
);
3746 if (strcmp(type
, VDEV_TYPE_INDIRECT
) == 0) {
3748 if (nvlist_dup(vdev
, &varray
[vcount
++], 0) != 0)
3751 } else if (strcmp(type
, VDEV_TYPE_MIRROR
) != 0) {
3752 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3753 "Source pool must be composed only of mirrors\n"));
3754 retval
= zfs_error(hdl
, EZFS_INVALCONFIG
, errbuf
);
3758 if (nvlist_lookup_string(child
[c
],
3759 ZPOOL_CONFIG_ALLOCATION_BIAS
, &bias
) == 0) {
3760 if (strcmp(bias
, VDEV_ALLOC_BIAS_SPECIAL
) == 0)
3761 is_special
= B_TRUE
;
3762 else if (strcmp(bias
, VDEV_ALLOC_BIAS_DEDUP
) == 0)
3765 verify(nvlist_lookup_nvlist_array(child
[c
],
3766 ZPOOL_CONFIG_CHILDREN
, &mchild
, &mchildren
) == 0);
3768 /* find or add an entry for this top-level vdev */
3769 if (newchildren
> 0 &&
3770 (entry
= find_vdev_entry(zhp
, mchild
, mchildren
,
3771 newchild
, newchildren
)) >= 0) {
3772 /* We found a disk that the user specified. */
3773 vdev
= mchild
[entry
];
3776 /* User didn't specify a disk for this vdev. */
3777 vdev
= mchild
[mchildren
- 1];
3780 if (nvlist_dup(vdev
, &varray
[vcount
++], 0) != 0)
3783 if (flags
.dryrun
!= 0) {
3784 if (is_dedup
== B_TRUE
) {
3785 if (nvlist_add_string(varray
[vcount
- 1],
3786 ZPOOL_CONFIG_ALLOCATION_BIAS
,
3787 VDEV_ALLOC_BIAS_DEDUP
) != 0)
3789 } else if (is_special
== B_TRUE
) {
3790 if (nvlist_add_string(varray
[vcount
- 1],
3791 ZPOOL_CONFIG_ALLOCATION_BIAS
,
3792 VDEV_ALLOC_BIAS_SPECIAL
) != 0)
3798 /* did we find every disk the user specified? */
3799 if (found
!= newchildren
) {
3800 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "Device list must "
3801 "include at most one disk from each mirror"));
3802 retval
= zfs_error(hdl
, EZFS_INVALCONFIG
, errbuf
);
3806 /* Prepare the nvlist for populating. */
3807 if (*newroot
== NULL
) {
3808 if (nvlist_alloc(newroot
, NV_UNIQUE_NAME
, 0) != 0)
3811 if (nvlist_add_string(*newroot
, ZPOOL_CONFIG_TYPE
,
3812 VDEV_TYPE_ROOT
) != 0)
3815 verify(nvlist_remove_all(*newroot
, ZPOOL_CONFIG_CHILDREN
) == 0);
3818 /* Add all the children we found */
3819 if (nvlist_add_nvlist_array(*newroot
, ZPOOL_CONFIG_CHILDREN
,
3820 (const nvlist_t
**)varray
, lastlog
== 0 ? vcount
: lastlog
) != 0)
3824 * If we're just doing a dry run, exit now with success.
3827 memory_err
= B_FALSE
;
3832 /* now build up the config list & call the ioctl */
3833 if (nvlist_alloc(&newconfig
, NV_UNIQUE_NAME
, 0) != 0)
3836 if (nvlist_add_nvlist(newconfig
,
3837 ZPOOL_CONFIG_VDEV_TREE
, *newroot
) != 0 ||
3838 nvlist_add_string(newconfig
,
3839 ZPOOL_CONFIG_POOL_NAME
, newname
) != 0 ||
3840 nvlist_add_uint64(newconfig
, ZPOOL_CONFIG_VERSION
, vers
) != 0)
3844 * The new pool is automatically part of the namespace unless we
3845 * explicitly export it.
3848 zc
.zc_cookie
= ZPOOL_EXPORT_AFTER_SPLIT
;
3849 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3850 (void) strlcpy(zc
.zc_string
, newname
, sizeof (zc
.zc_string
));
3851 zcmd_write_conf_nvlist(hdl
, &zc
, newconfig
);
3852 if (zc_props
!= NULL
)
3853 zcmd_write_src_nvlist(hdl
, &zc
, zc_props
);
3855 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SPLIT
, &zc
) != 0) {
3856 retval
= zpool_standard_error(hdl
, errno
, errbuf
);
3861 memory_err
= B_FALSE
;
3864 if (varray
!= NULL
) {
3867 for (v
= 0; v
< vcount
; v
++)
3868 nvlist_free(varray
[v
]);
3871 zcmd_free_nvlists(&zc
);
3872 nvlist_free(zc_props
);
3873 nvlist_free(newconfig
);
3875 nvlist_free(*newroot
);
3883 return (no_memory(hdl
));
3889 * Remove the given device.
3892 zpool_vdev_remove(zpool_handle_t
*zhp
, const char *path
)
3894 zfs_cmd_t zc
= {"\0"};
3895 char errbuf
[ERRBUFLEN
];
3897 boolean_t avail_spare
, l2cache
, islog
;
3898 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3901 (void) snprintf(errbuf
, sizeof (errbuf
),
3902 dgettext(TEXT_DOMAIN
, "cannot remove %s"), path
);
3904 if (zpool_is_draid_spare(path
)) {
3905 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3906 "dRAID spares cannot be removed"));
3907 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3910 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3911 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
3913 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3915 version
= zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
);
3916 if (islog
&& version
< SPA_VERSION_HOLES
) {
3917 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3918 "pool must be upgraded to support log removal"));
3919 return (zfs_error(hdl
, EZFS_BADVERSION
, errbuf
));
3922 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
3924 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_REMOVE
, &zc
) == 0)
3930 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3931 "invalid config; all top-level vdevs must "
3932 "have the same sector size and not be raidz."));
3933 (void) zfs_error(hdl
, EZFS_INVALCONFIG
, errbuf
);
3938 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3939 "Mount encrypted datasets to replay logs."));
3941 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3942 "Pool busy; removal may already be in progress"));
3944 (void) zfs_error(hdl
, EZFS_BUSY
, errbuf
);
3949 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3950 "Mount encrypted datasets to replay logs."));
3951 (void) zfs_error(hdl
, EZFS_BUSY
, errbuf
);
3953 (void) zpool_standard_error(hdl
, errno
, errbuf
);
3958 (void) zpool_standard_error(hdl
, errno
, errbuf
);
3964 zpool_vdev_remove_cancel(zpool_handle_t
*zhp
)
3966 zfs_cmd_t zc
= {{0}};
3967 char errbuf
[ERRBUFLEN
];
3968 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3970 (void) snprintf(errbuf
, sizeof (errbuf
),
3971 dgettext(TEXT_DOMAIN
, "cannot cancel removal"));
3973 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3976 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_REMOVE
, &zc
) == 0)
3979 return (zpool_standard_error(hdl
, errno
, errbuf
));
3983 zpool_vdev_indirect_size(zpool_handle_t
*zhp
, const char *path
,
3986 char errbuf
[ERRBUFLEN
];
3988 boolean_t avail_spare
, l2cache
, islog
;
3989 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3991 (void) snprintf(errbuf
, sizeof (errbuf
),
3992 dgettext(TEXT_DOMAIN
, "cannot determine indirect size of %s"),
3995 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
3997 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
3999 if (avail_spare
|| l2cache
|| islog
) {
4004 if (nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_INDIRECT_SIZE
, sizep
) != 0) {
4005 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
4006 "indirect size not available"));
4007 return (zfs_error(hdl
, EINVAL
, errbuf
));
4013 * Clear the errors for the pool, or the particular device if specified.
4016 zpool_clear(zpool_handle_t
*zhp
, const char *path
, nvlist_t
*rewindnvl
)
4018 zfs_cmd_t zc
= {"\0"};
4019 char errbuf
[ERRBUFLEN
];
4021 zpool_load_policy_t policy
;
4022 boolean_t avail_spare
, l2cache
;
4023 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4024 nvlist_t
*nvi
= NULL
;
4028 (void) snprintf(errbuf
, sizeof (errbuf
),
4029 dgettext(TEXT_DOMAIN
, "cannot clear errors for %s"),
4032 (void) snprintf(errbuf
, sizeof (errbuf
),
4033 dgettext(TEXT_DOMAIN
, "cannot clear errors for %s"),
4036 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
4038 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
,
4039 &l2cache
, NULL
)) == NULL
)
4040 return (zfs_error(hdl
, EZFS_NODEVICE
, errbuf
));
4043 * Don't allow error clearing for hot spares. Do allow
4044 * error clearing for l2cache devices.
4047 return (zfs_error(hdl
, EZFS_ISSPARE
, errbuf
));
4049 zc
.zc_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
4052 zpool_get_load_policy(rewindnvl
, &policy
);
4053 zc
.zc_cookie
= policy
.zlp_rewind
;
4055 zcmd_alloc_dst_nvlist(hdl
, &zc
, zhp
->zpool_config_size
* 2);
4056 zcmd_write_src_nvlist(hdl
, &zc
, rewindnvl
);
4058 while ((error
= zfs_ioctl(hdl
, ZFS_IOC_CLEAR
, &zc
)) != 0 &&
4060 zcmd_expand_dst_nvlist(hdl
, &zc
);
4062 if (!error
|| ((policy
.zlp_rewind
& ZPOOL_TRY_REWIND
) &&
4063 errno
!= EPERM
&& errno
!= EACCES
)) {
4064 if (policy
.zlp_rewind
&
4065 (ZPOOL_DO_REWIND
| ZPOOL_TRY_REWIND
)) {
4066 (void) zcmd_read_dst_nvlist(hdl
, &zc
, &nvi
);
4067 zpool_rewind_exclaim(hdl
, zc
.zc_name
,
4068 ((policy
.zlp_rewind
& ZPOOL_TRY_REWIND
) != 0),
4072 zcmd_free_nvlists(&zc
);
4076 zcmd_free_nvlists(&zc
);
4077 return (zpool_standard_error(hdl
, errno
, errbuf
));
4081 * Similar to zpool_clear(), but takes a GUID (used by fmd).
4084 zpool_vdev_clear(zpool_handle_t
*zhp
, uint64_t guid
)
4086 zfs_cmd_t zc
= {"\0"};
4087 char errbuf
[ERRBUFLEN
];
4088 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4090 (void) snprintf(errbuf
, sizeof (errbuf
),
4091 dgettext(TEXT_DOMAIN
, "cannot clear errors for %llx"),
4092 (u_longlong_t
)guid
);
4094 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
4096 zc
.zc_cookie
= ZPOOL_NO_REWIND
;
4098 if (zfs_ioctl(hdl
, ZFS_IOC_CLEAR
, &zc
) == 0)
4101 return (zpool_standard_error(hdl
, errno
, errbuf
));
4105 * Change the GUID for a pool.
4108 zpool_reguid(zpool_handle_t
*zhp
)
4110 char errbuf
[ERRBUFLEN
];
4111 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4112 zfs_cmd_t zc
= {"\0"};
4114 (void) snprintf(errbuf
, sizeof (errbuf
),
4115 dgettext(TEXT_DOMAIN
, "cannot reguid '%s'"), zhp
->zpool_name
);
4117 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
4118 if (zfs_ioctl(hdl
, ZFS_IOC_POOL_REGUID
, &zc
) == 0)
4121 return (zpool_standard_error(hdl
, errno
, errbuf
));
4128 zpool_reopen_one(zpool_handle_t
*zhp
, void *data
)
4130 libzfs_handle_t
*hdl
= zpool_get_handle(zhp
);
4131 const char *pool_name
= zpool_get_name(zhp
);
4132 boolean_t
*scrub_restart
= data
;
4135 error
= lzc_reopen(pool_name
, *scrub_restart
);
4137 return (zpool_standard_error_fmt(hdl
, error
,
4138 dgettext(TEXT_DOMAIN
, "cannot reopen '%s'"), pool_name
));
4144 /* call into libzfs_core to execute the sync IOCTL per pool */
4146 zpool_sync_one(zpool_handle_t
*zhp
, void *data
)
4149 libzfs_handle_t
*hdl
= zpool_get_handle(zhp
);
4150 const char *pool_name
= zpool_get_name(zhp
);
4151 boolean_t
*force
= data
;
4152 nvlist_t
*innvl
= fnvlist_alloc();
4154 fnvlist_add_boolean_value(innvl
, "force", *force
);
4155 if ((ret
= lzc_sync(pool_name
, innvl
, NULL
)) != 0) {
4157 return (zpool_standard_error_fmt(hdl
, ret
,
4158 dgettext(TEXT_DOMAIN
, "sync '%s' failed"), pool_name
));
4165 #define PATH_BUF_LEN 64
4168 * Given a vdev, return the name to display in iostat. If the vdev has a path,
4169 * we use that, stripping off any leading "/dev/dsk/"; if not, we use the type.
4170 * We also check if this is a whole disk, in which case we strip off the
4171 * trailing 's0' slice name.
4173 * This routine is also responsible for identifying when disks have been
4174 * reconfigured in a new location. The kernel will have opened the device by
4175 * devid, but the path will still refer to the old location. To catch this, we
4176 * first do a path -> devid translation (which is fast for the common case). If
4177 * the devid matches, we're done. If not, we do a reverse devid -> path
4178 * translation and issue the appropriate ioctl() to update the path of the vdev.
4179 * If 'zhp' is NULL, then this is an exported pool, and we don't need to do any
4183 zpool_vdev_name(libzfs_handle_t
*hdl
, zpool_handle_t
*zhp
, nvlist_t
*nv
,
4186 const char *type
, *tpath
;
4189 char buf
[PATH_BUF_LEN
];
4190 char tmpbuf
[PATH_BUF_LEN
* 2];
4193 * vdev_name will be "root"/"root-0" for the root vdev, but it is the
4194 * zpool name that will be displayed to the user.
4196 type
= fnvlist_lookup_string(nv
, ZPOOL_CONFIG_TYPE
);
4197 if (zhp
!= NULL
&& strcmp(type
, "root") == 0)
4198 return (zfs_strdup(hdl
, zpool_get_name(zhp
)));
4200 if (libzfs_envvar_is_set("ZPOOL_VDEV_NAME_PATH"))
4201 name_flags
|= VDEV_NAME_PATH
;
4202 if (libzfs_envvar_is_set("ZPOOL_VDEV_NAME_GUID"))
4203 name_flags
|= VDEV_NAME_GUID
;
4204 if (libzfs_envvar_is_set("ZPOOL_VDEV_NAME_FOLLOW_LINKS"))
4205 name_flags
|= VDEV_NAME_FOLLOW_LINKS
;
4207 if (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_NOT_PRESENT
, &value
) == 0 ||
4208 name_flags
& VDEV_NAME_GUID
) {
4209 (void) nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_GUID
, &value
);
4210 (void) snprintf(buf
, sizeof (buf
), "%llu", (u_longlong_t
)value
);
4212 } else if (nvlist_lookup_string(nv
, ZPOOL_CONFIG_PATH
, &tpath
) == 0) {
4215 if (name_flags
& VDEV_NAME_FOLLOW_LINKS
) {
4216 char *rp
= realpath(path
, NULL
);
4218 strlcpy(buf
, rp
, sizeof (buf
));
4225 * For a block device only use the name.
4227 if ((strcmp(type
, VDEV_TYPE_DISK
) == 0) &&
4228 !(name_flags
& VDEV_NAME_PATH
)) {
4229 path
= zfs_strip_path(path
);
4233 * Remove the partition from the path if this is a whole disk.
4235 if (strcmp(type
, VDEV_TYPE_DRAID_SPARE
) != 0 &&
4236 nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_WHOLE_DISK
, &value
)
4237 == 0 && value
&& !(name_flags
& VDEV_NAME_PATH
)) {
4238 return (zfs_strip_partition(path
));
4244 * If it's a raidz device, we need to stick in the parity level.
4246 if (strcmp(path
, VDEV_TYPE_RAIDZ
) == 0) {
4247 value
= fnvlist_lookup_uint64(nv
, ZPOOL_CONFIG_NPARITY
);
4248 (void) snprintf(buf
, sizeof (buf
), "%s%llu", path
,
4249 (u_longlong_t
)value
);
4254 * If it's a dRAID device, we add parity, groups, and spares.
4256 if (strcmp(path
, VDEV_TYPE_DRAID
) == 0) {
4257 uint64_t ndata
, nparity
, nspares
;
4261 verify(nvlist_lookup_nvlist_array(nv
,
4262 ZPOOL_CONFIG_CHILDREN
, &child
, &children
) == 0);
4263 nparity
= fnvlist_lookup_uint64(nv
,
4264 ZPOOL_CONFIG_NPARITY
);
4265 ndata
= fnvlist_lookup_uint64(nv
,
4266 ZPOOL_CONFIG_DRAID_NDATA
);
4267 nspares
= fnvlist_lookup_uint64(nv
,
4268 ZPOOL_CONFIG_DRAID_NSPARES
);
4270 path
= zpool_draid_name(buf
, sizeof (buf
), ndata
,
4271 nparity
, nspares
, children
);
4275 * We identify each top-level vdev by using a <type-id>
4276 * naming convention.
4278 if (name_flags
& VDEV_NAME_TYPE_ID
) {
4279 uint64_t id
= fnvlist_lookup_uint64(nv
,
4281 (void) snprintf(tmpbuf
, sizeof (tmpbuf
), "%s-%llu",
4282 path
, (u_longlong_t
)id
);
4287 return (zfs_strdup(hdl
, path
));
4291 zbookmark_mem_compare(const void *a
, const void *b
)
4293 return (memcmp(a
, b
, sizeof (zbookmark_phys_t
)));
4297 * Retrieve the persistent error log, uniquify the members, and return to the
4301 zpool_get_errlog(zpool_handle_t
*zhp
, nvlist_t
**nverrlistp
)
4303 zfs_cmd_t zc
= {"\0"};
4304 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4305 zbookmark_phys_t
*buf
;
4306 uint64_t buflen
= 10000; /* approx. 1MB of RAM */
4308 if (fnvlist_lookup_uint64(zhp
->zpool_config
,
4309 ZPOOL_CONFIG_ERRCOUNT
) == 0)
4313 * Retrieve the raw error list from the kernel. If it doesn't fit,
4314 * allocate a larger buffer and retry.
4316 (void) strcpy(zc
.zc_name
, zhp
->zpool_name
);
4318 buf
= zfs_alloc(zhp
->zpool_hdl
,
4319 buflen
* sizeof (zbookmark_phys_t
));
4320 zc
.zc_nvlist_dst
= (uintptr_t)buf
;
4321 zc
.zc_nvlist_dst_size
= buflen
;
4322 if (zfs_ioctl(zhp
->zpool_hdl
, ZFS_IOC_ERROR_LOG
,
4325 if (errno
== ENOMEM
) {
4328 return (zpool_standard_error_fmt(hdl
, errno
,
4329 dgettext(TEXT_DOMAIN
, "errors: List of "
4330 "errors unavailable")));
4338 * Sort the resulting bookmarks. This is a little confusing due to the
4339 * implementation of ZFS_IOC_ERROR_LOG. The bookmarks are copied last
4340 * to first, and 'zc_nvlist_dst_size' indicates the number of bookmarks
4341 * _not_ copied as part of the process. So we point the start of our
4342 * array appropriate and decrement the total number of elements.
4344 zbookmark_phys_t
*zb
= buf
+ zc
.zc_nvlist_dst_size
;
4345 uint64_t zblen
= buflen
- zc
.zc_nvlist_dst_size
;
4347 qsort(zb
, zblen
, sizeof (zbookmark_phys_t
), zbookmark_mem_compare
);
4349 verify(nvlist_alloc(nverrlistp
, 0, KM_SLEEP
) == 0);
4352 * Fill in the nverrlistp with nvlist's of dataset and object numbers.
4354 for (uint64_t i
= 0; i
< zblen
; i
++) {
4357 /* ignoring zb_blkid and zb_level for now */
4358 if (i
> 0 && zb
[i
-1].zb_objset
== zb
[i
].zb_objset
&&
4359 zb
[i
-1].zb_object
== zb
[i
].zb_object
)
4362 if (nvlist_alloc(&nv
, NV_UNIQUE_NAME
, KM_SLEEP
) != 0)
4364 if (nvlist_add_uint64(nv
, ZPOOL_ERR_DATASET
,
4365 zb
[i
].zb_objset
) != 0) {
4369 if (nvlist_add_uint64(nv
, ZPOOL_ERR_OBJECT
,
4370 zb
[i
].zb_object
) != 0) {
4374 if (nvlist_add_nvlist(*nverrlistp
, "ejk", nv
) != 0) {
4386 return (no_memory(zhp
->zpool_hdl
));
4390 * Upgrade a ZFS pool to the latest on-disk version.
4393 zpool_upgrade(zpool_handle_t
*zhp
, uint64_t new_version
)
4395 zfs_cmd_t zc
= {"\0"};
4396 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4398 (void) strcpy(zc
.zc_name
, zhp
->zpool_name
);
4399 zc
.zc_cookie
= new_version
;
4401 if (zfs_ioctl(hdl
, ZFS_IOC_POOL_UPGRADE
, &zc
) != 0)
4402 return (zpool_standard_error_fmt(hdl
, errno
,
4403 dgettext(TEXT_DOMAIN
, "cannot upgrade '%s'"),
4409 zfs_save_arguments(int argc
, char **argv
, char *string
, int len
)
4413 (void) strlcpy(string
, zfs_basename(argv
[0]), len
);
4414 for (i
= 1; i
< argc
; i
++) {
4415 (void) strlcat(string
, " ", len
);
4416 (void) strlcat(string
, argv
[i
], len
);
4421 zpool_log_history(libzfs_handle_t
*hdl
, const char *message
)
4423 zfs_cmd_t zc
= {"\0"};
4426 args
= fnvlist_alloc();
4427 fnvlist_add_string(args
, "message", message
);
4428 zcmd_write_src_nvlist(hdl
, &zc
, args
);
4429 int err
= zfs_ioctl(hdl
, ZFS_IOC_LOG_HISTORY
, &zc
);
4431 zcmd_free_nvlists(&zc
);
4436 * Perform ioctl to get some command history of a pool.
4438 * 'buf' is the buffer to fill up to 'len' bytes. 'off' is the
4439 * logical offset of the history buffer to start reading from.
4441 * Upon return, 'off' is the next logical offset to read from and
4442 * 'len' is the actual amount of bytes read into 'buf'.
4445 get_history(zpool_handle_t
*zhp
, char *buf
, uint64_t *off
, uint64_t *len
)
4447 zfs_cmd_t zc
= {"\0"};
4448 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4450 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
4452 zc
.zc_history
= (uint64_t)(uintptr_t)buf
;
4453 zc
.zc_history_len
= *len
;
4454 zc
.zc_history_offset
= *off
;
4456 if (zfs_ioctl(hdl
, ZFS_IOC_POOL_GET_HISTORY
, &zc
) != 0) {
4459 return (zfs_error_fmt(hdl
, EZFS_PERM
,
4460 dgettext(TEXT_DOMAIN
,
4461 "cannot show history for pool '%s'"),
4464 return (zfs_error_fmt(hdl
, EZFS_NOHISTORY
,
4465 dgettext(TEXT_DOMAIN
, "cannot get history for pool "
4466 "'%s'"), zhp
->zpool_name
));
4468 return (zfs_error_fmt(hdl
, EZFS_BADVERSION
,
4469 dgettext(TEXT_DOMAIN
, "cannot get history for pool "
4470 "'%s', pool must be upgraded"), zhp
->zpool_name
));
4472 return (zpool_standard_error_fmt(hdl
, errno
,
4473 dgettext(TEXT_DOMAIN
,
4474 "cannot get history for '%s'"), zhp
->zpool_name
));
4478 *len
= zc
.zc_history_len
;
4479 *off
= zc
.zc_history_offset
;
4485 * Retrieve the command history of a pool.
4488 zpool_get_history(zpool_handle_t
*zhp
, nvlist_t
**nvhisp
, uint64_t *off
,
4491 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
4493 int buflen
= 128 * 1024;
4494 nvlist_t
**records
= NULL
;
4495 uint_t numrecords
= 0;
4497 uint64_t start
= *off
;
4499 buf
= zfs_alloc(hdl
, buflen
);
4501 /* process about 1MiB a time */
4502 while (*off
- start
< 1024 * 1024) {
4503 uint64_t bytes_read
= buflen
;
4506 if ((err
= get_history(zhp
, buf
, off
, &bytes_read
)) != 0)
4509 /* if nothing else was read in, we're at EOF, just return */
4515 if ((err
= zpool_history_unpack(buf
, bytes_read
,
4516 &leftover
, &records
, &numrecords
)) != 0) {
4517 zpool_standard_error_fmt(hdl
, err
,
4518 dgettext(TEXT_DOMAIN
,
4519 "cannot get history for '%s'"), zhp
->zpool_name
);
4523 if (leftover
== bytes_read
) {
4525 * no progress made, because buffer is not big enough
4526 * to hold this record; resize and retry.
4530 buf
= zfs_alloc(hdl
, buflen
);
4537 *nvhisp
= fnvlist_alloc();
4538 fnvlist_add_nvlist_array(*nvhisp
, ZPOOL_HIST_RECORD
,
4539 (const nvlist_t
**)records
, numrecords
);
4541 for (i
= 0; i
< numrecords
; i
++)
4542 nvlist_free(records
[i
]);
4549 * Retrieve the next event given the passed 'zevent_fd' file descriptor.
4550 * If there is a new event available 'nvp' will contain a newly allocated
4551 * nvlist and 'dropped' will be set to the number of missed events since
4552 * the last call to this function. When 'nvp' is set to NULL it indicates
4553 * no new events are available. In either case the function returns 0 and
4554 * it is up to the caller to free 'nvp'. In the case of a fatal error the
4555 * function will return a non-zero value. When the function is called in
4556 * blocking mode (the default, unless the ZEVENT_NONBLOCK flag is passed),
4557 * it will not return until a new event is available.
4560 zpool_events_next(libzfs_handle_t
*hdl
, nvlist_t
**nvp
,
4561 int *dropped
, unsigned flags
, int zevent_fd
)
4563 zfs_cmd_t zc
= {"\0"};
4568 zc
.zc_cleanup_fd
= zevent_fd
;
4570 if (flags
& ZEVENT_NONBLOCK
)
4571 zc
.zc_guid
= ZEVENT_NONBLOCK
;
4573 zcmd_alloc_dst_nvlist(hdl
, &zc
, ZEVENT_SIZE
);
4576 if (zfs_ioctl(hdl
, ZFS_IOC_EVENTS_NEXT
, &zc
) != 0) {
4579 error
= zfs_error_fmt(hdl
, EZFS_POOLUNAVAIL
,
4580 dgettext(TEXT_DOMAIN
, "zfs shutdown"));
4583 /* Blocking error case should not occur */
4584 if (!(flags
& ZEVENT_NONBLOCK
))
4585 error
= zpool_standard_error_fmt(hdl
, errno
,
4586 dgettext(TEXT_DOMAIN
, "cannot get event"));
4590 zcmd_expand_dst_nvlist(hdl
, &zc
);
4593 error
= zpool_standard_error_fmt(hdl
, errno
,
4594 dgettext(TEXT_DOMAIN
, "cannot get event"));
4599 error
= zcmd_read_dst_nvlist(hdl
, &zc
, nvp
);
4603 *dropped
= (int)zc
.zc_cookie
;
4605 zcmd_free_nvlists(&zc
);
4614 zpool_events_clear(libzfs_handle_t
*hdl
, int *count
)
4616 zfs_cmd_t zc
= {"\0"};
4618 if (zfs_ioctl(hdl
, ZFS_IOC_EVENTS_CLEAR
, &zc
) != 0)
4619 return (zpool_standard_error(hdl
, errno
,
4620 dgettext(TEXT_DOMAIN
, "cannot clear events")));
4623 *count
= (int)zc
.zc_cookie
; /* # of events cleared */
4629 * Seek to a specific EID, ZEVENT_SEEK_START, or ZEVENT_SEEK_END for
4630 * the passed zevent_fd file handle. On success zero is returned,
4631 * otherwise -1 is returned and hdl->libzfs_error is set to the errno.
4634 zpool_events_seek(libzfs_handle_t
*hdl
, uint64_t eid
, int zevent_fd
)
4636 zfs_cmd_t zc
= {"\0"};
4640 zc
.zc_cleanup_fd
= zevent_fd
;
4642 if (zfs_ioctl(hdl
, ZFS_IOC_EVENTS_SEEK
, &zc
) != 0) {
4645 error
= zfs_error_fmt(hdl
, EZFS_NOENT
,
4646 dgettext(TEXT_DOMAIN
, "cannot get event"));
4650 error
= zfs_error_fmt(hdl
, EZFS_NOMEM
,
4651 dgettext(TEXT_DOMAIN
, "cannot get event"));
4655 error
= zpool_standard_error_fmt(hdl
, errno
,
4656 dgettext(TEXT_DOMAIN
, "cannot get event"));
4665 zpool_obj_to_path_impl(zpool_handle_t
*zhp
, uint64_t dsobj
, uint64_t obj
,
4666 char *pathname
, size_t len
, boolean_t always_unmounted
)
4668 zfs_cmd_t zc
= {"\0"};
4669 boolean_t mounted
= B_FALSE
;
4670 char *mntpnt
= NULL
;
4671 char dsname
[ZFS_MAX_DATASET_NAME_LEN
];
4674 /* special case for the MOS */
4675 (void) snprintf(pathname
, len
, "<metadata>:<0x%llx>",
4680 /* get the dataset's name */
4681 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
4683 if (zfs_ioctl(zhp
->zpool_hdl
,
4684 ZFS_IOC_DSOBJ_TO_DSNAME
, &zc
) != 0) {
4685 /* just write out a path of two object numbers */
4686 (void) snprintf(pathname
, len
, "<0x%llx>:<0x%llx>",
4687 (longlong_t
)dsobj
, (longlong_t
)obj
);
4690 (void) strlcpy(dsname
, zc
.zc_value
, sizeof (dsname
));
4692 /* find out if the dataset is mounted */
4693 mounted
= !always_unmounted
&& is_mounted(zhp
->zpool_hdl
, dsname
,
4696 /* get the corrupted object's path */
4697 (void) strlcpy(zc
.zc_name
, dsname
, sizeof (zc
.zc_name
));
4699 if (zfs_ioctl(zhp
->zpool_hdl
, ZFS_IOC_OBJ_TO_PATH
,
4702 (void) snprintf(pathname
, len
, "%s%s", mntpnt
,
4705 (void) snprintf(pathname
, len
, "%s:%s",
4706 dsname
, zc
.zc_value
);
4709 (void) snprintf(pathname
, len
, "%s:<0x%llx>", dsname
,
4716 zpool_obj_to_path(zpool_handle_t
*zhp
, uint64_t dsobj
, uint64_t obj
,
4717 char *pathname
, size_t len
)
4719 zpool_obj_to_path_impl(zhp
, dsobj
, obj
, pathname
, len
, B_FALSE
);
4723 zpool_obj_to_path_ds(zpool_handle_t
*zhp
, uint64_t dsobj
, uint64_t obj
,
4724 char *pathname
, size_t len
)
4726 zpool_obj_to_path_impl(zhp
, dsobj
, obj
, pathname
, len
, B_TRUE
);
4729 * Wait while the specified activity is in progress in the pool.
4732 zpool_wait(zpool_handle_t
*zhp
, zpool_wait_activity_t activity
)
4736 int error
= zpool_wait_status(zhp
, activity
, &missing
, NULL
);
4739 (void) zpool_standard_error_fmt(zhp
->zpool_hdl
, ENOENT
,
4740 dgettext(TEXT_DOMAIN
, "error waiting in pool '%s'"),
4749 * Wait for the given activity and return the status of the wait (whether or not
4750 * any waiting was done) in the 'waited' parameter. Non-existent pools are
4751 * reported via the 'missing' parameter, rather than by printing an error
4752 * message. This is convenient when this function is called in a loop over a
4753 * long period of time (as it is, for example, by zpool's wait cmd). In that
4754 * scenario, a pool being exported or destroyed should be considered a normal
4755 * event, so we don't want to print an error when we find that the pool doesn't
4759 zpool_wait_status(zpool_handle_t
*zhp
, zpool_wait_activity_t activity
,
4760 boolean_t
*missing
, boolean_t
*waited
)
4762 int error
= lzc_wait(zhp
->zpool_name
, activity
, waited
);
4763 *missing
= (error
== ENOENT
);
4768 (void) zpool_standard_error_fmt(zhp
->zpool_hdl
, error
,
4769 dgettext(TEXT_DOMAIN
, "error waiting in pool '%s'"),
4777 zpool_set_bootenv(zpool_handle_t
*zhp
, const nvlist_t
*envmap
)
4779 int error
= lzc_set_bootenv(zhp
->zpool_name
, envmap
);
4781 (void) zpool_standard_error_fmt(zhp
->zpool_hdl
, error
,
4782 dgettext(TEXT_DOMAIN
,
4783 "error setting bootenv in pool '%s'"), zhp
->zpool_name
);
4790 zpool_get_bootenv(zpool_handle_t
*zhp
, nvlist_t
**nvlp
)
4796 error
= lzc_get_bootenv(zhp
->zpool_name
, &nvl
);
4798 (void) zpool_standard_error_fmt(zhp
->zpool_hdl
, error
,
4799 dgettext(TEXT_DOMAIN
,
4800 "error getting bootenv in pool '%s'"), zhp
->zpool_name
);
4809 * Attempt to read and parse feature file(s) (from "compatibility" property).
4810 * Files contain zpool feature names, comma or whitespace-separated.
4811 * Comments (# character to next newline) are discarded.
4814 * compatibility : string containing feature filenames
4815 * features : either NULL or pointer to array of boolean
4816 * report : either NULL or pointer to string buffer
4817 * rlen : length of "report" buffer
4819 * compatibility is NULL (unset), "", "off", "legacy", or list of
4820 * comma-separated filenames. filenames should either be absolute,
4822 * 1) ZPOOL_SYSCONF_COMPAT_D (eg: /etc/zfs/compatibility.d) or
4823 * 2) ZPOOL_DATA_COMPAT_D (eg: /usr/share/zfs/compatibility.d).
4824 * (Unset), "" or "off" => enable all features
4825 * "legacy" => disable all features
4827 * Any feature names read from files which match unames in spa_feature_table
4828 * will have the corresponding boolean set in the features array (if non-NULL).
4829 * If more than one feature set specified, only features present in *all* of
4832 * "report" if not NULL will be populated with a suitable status message.
4835 * ZPOOL_COMPATIBILITY_OK : files read and parsed ok
4836 * ZPOOL_COMPATIBILITY_BADFILE : file too big or not a text file
4837 * ZPOOL_COMPATIBILITY_BADTOKEN : SYSCONF file contains invalid feature name
4838 * ZPOOL_COMPATIBILITY_WARNTOKEN : DATA file contains invalid feature name
4839 * ZPOOL_COMPATIBILITY_NOFILES : no feature files found
4841 zpool_compat_status_t
4842 zpool_load_compat(const char *compat
, boolean_t
*features
, char *report
,
4845 int sdirfd
, ddirfd
, featfd
;
4849 char *file
, *line
, *word
;
4851 char l_compat
[ZFS_MAXPROPLEN
];
4853 boolean_t ret_nofiles
= B_TRUE
;
4854 boolean_t ret_badfile
= B_FALSE
;
4855 boolean_t ret_badtoken
= B_FALSE
;
4856 boolean_t ret_warntoken
= B_FALSE
;
4858 /* special cases (unset), "" and "off" => enable all features */
4859 if (compat
== NULL
|| compat
[0] == '\0' ||
4860 strcmp(compat
, ZPOOL_COMPAT_OFF
) == 0) {
4861 if (features
!= NULL
)
4862 for (uint_t i
= 0; i
< SPA_FEATURES
; i
++)
4863 features
[i
] = B_TRUE
;
4865 strlcpy(report
, gettext("all features enabled"), rlen
);
4866 return (ZPOOL_COMPATIBILITY_OK
);
4869 /* Final special case "legacy" => disable all features */
4870 if (strcmp(compat
, ZPOOL_COMPAT_LEGACY
) == 0) {
4871 if (features
!= NULL
)
4872 for (uint_t i
= 0; i
< SPA_FEATURES
; i
++)
4873 features
[i
] = B_FALSE
;
4875 strlcpy(report
, gettext("all features disabled"), rlen
);
4876 return (ZPOOL_COMPATIBILITY_OK
);
4880 * Start with all true; will be ANDed with results from each file
4882 if (features
!= NULL
)
4883 for (uint_t i
= 0; i
< SPA_FEATURES
; i
++)
4884 features
[i
] = B_TRUE
;
4886 char err_badfile
[ZFS_MAXPROPLEN
] = "";
4887 char err_badtoken
[ZFS_MAXPROPLEN
] = "";
4890 * We ignore errors from the directory open()
4891 * as they're only needed if the filename is relative
4892 * which will be checked during the openat().
4895 /* O_PATH safer than O_RDONLY if system allows it */
4897 #define ZC_DIR_FLAGS (O_DIRECTORY | O_CLOEXEC | O_PATH)
4899 #define ZC_DIR_FLAGS (O_DIRECTORY | O_CLOEXEC | O_RDONLY)
4902 sdirfd
= open(ZPOOL_SYSCONF_COMPAT_D
, ZC_DIR_FLAGS
);
4903 ddirfd
= open(ZPOOL_DATA_COMPAT_D
, ZC_DIR_FLAGS
);
4905 (void) strlcpy(l_compat
, compat
, ZFS_MAXPROPLEN
);
4907 for (file
= strtok_r(l_compat
, ",", &ps
);
4909 file
= strtok_r(NULL
, ",", &ps
)) {
4911 boolean_t l_features
[SPA_FEATURES
];
4913 enum { Z_SYSCONF
, Z_DATA
} source
;
4915 /* try sysconfdir first, then datadir */
4917 if ((featfd
= openat(sdirfd
, file
, O_RDONLY
| O_CLOEXEC
)) < 0) {
4918 featfd
= openat(ddirfd
, file
, O_RDONLY
| O_CLOEXEC
);
4922 /* File readable and correct size? */
4924 fstat(featfd
, &fs
) < 0 ||
4926 fs
.st_size
> ZPOOL_COMPAT_MAXSIZE
) {
4927 (void) close(featfd
);
4928 strlcat(err_badfile
, file
, ZFS_MAXPROPLEN
);
4929 strlcat(err_badfile
, " ", ZFS_MAXPROPLEN
);
4930 ret_badfile
= B_TRUE
;
4934 /* Prefault the file if system allows */
4935 #if defined(MAP_POPULATE)
4936 #define ZC_MMAP_FLAGS (MAP_PRIVATE | MAP_POPULATE)
4937 #elif defined(MAP_PREFAULT_READ)
4938 #define ZC_MMAP_FLAGS (MAP_PRIVATE | MAP_PREFAULT_READ)
4940 #define ZC_MMAP_FLAGS (MAP_PRIVATE)
4943 /* private mmap() so we can strtok safely */
4944 fc
= (char *)mmap(NULL
, fs
.st_size
, PROT_READ
| PROT_WRITE
,
4945 ZC_MMAP_FLAGS
, featfd
, 0);
4946 (void) close(featfd
);
4948 /* map ok, and last character == newline? */
4949 if (fc
== MAP_FAILED
|| fc
[fs
.st_size
- 1] != '\n') {
4950 (void) munmap((void *) fc
, fs
.st_size
);
4951 strlcat(err_badfile
, file
, ZFS_MAXPROPLEN
);
4952 strlcat(err_badfile
, " ", ZFS_MAXPROPLEN
);
4953 ret_badfile
= B_TRUE
;
4957 ret_nofiles
= B_FALSE
;
4959 for (uint_t i
= 0; i
< SPA_FEATURES
; i
++)
4960 l_features
[i
] = B_FALSE
;
4962 /* replace final newline with NULL to ensure string ends */
4963 fc
[fs
.st_size
- 1] = '\0';
4965 for (line
= strtok_r(fc
, "\n", &ls
);
4967 line
= strtok_r(NULL
, "\n", &ls
)) {
4968 /* discard comments */
4969 char *r
= strchr(line
, '#');
4973 for (word
= strtok_r(line
, ", \t", &ws
);
4975 word
= strtok_r(NULL
, ", \t", &ws
)) {
4976 /* Find matching feature name */
4978 for (f
= 0; f
< SPA_FEATURES
; f
++) {
4979 zfeature_info_t
*fi
=
4980 &spa_feature_table
[f
];
4981 if (strcmp(word
, fi
->fi_uname
) == 0) {
4982 l_features
[f
] = B_TRUE
;
4986 if (f
< SPA_FEATURES
)
4989 /* found an unrecognized word */
4990 /* lightly sanitize it */
4991 if (strlen(word
) > 32)
4993 for (char *c
= word
; *c
!= '\0'; c
++)
4997 strlcat(err_badtoken
, word
, ZFS_MAXPROPLEN
);
4998 strlcat(err_badtoken
, " ", ZFS_MAXPROPLEN
);
4999 if (source
== Z_SYSCONF
)
5000 ret_badtoken
= B_TRUE
;
5002 ret_warntoken
= B_TRUE
;
5005 (void) munmap((void *) fc
, fs
.st_size
);
5007 if (features
!= NULL
)
5008 for (uint_t i
= 0; i
< SPA_FEATURES
; i
++)
5009 features
[i
] &= l_features
[i
];
5011 (void) close(sdirfd
);
5012 (void) close(ddirfd
);
5014 /* Return the most serious error */
5017 snprintf(report
, rlen
, gettext("could not read/"
5018 "parse feature file(s): %s"), err_badfile
);
5019 return (ZPOOL_COMPATIBILITY_BADFILE
);
5024 gettext("no valid compatibility files specified"),
5026 return (ZPOOL_COMPATIBILITY_NOFILES
);
5030 snprintf(report
, rlen
, gettext("invalid feature "
5031 "name(s) in local compatibility files: %s"),
5033 return (ZPOOL_COMPATIBILITY_BADTOKEN
);
5035 if (ret_warntoken
) {
5037 snprintf(report
, rlen
, gettext("unrecognized feature "
5038 "name(s) in distribution compatibility files: %s"),
5040 return (ZPOOL_COMPATIBILITY_WARNTOKEN
);
5043 strlcpy(report
, gettext("compatibility set ok"), rlen
);
5044 return (ZPOOL_COMPATIBILITY_OK
);
5048 zpool_vdev_guid(zpool_handle_t
*zhp
, const char *vdevname
, uint64_t *vdev_guid
)
5051 boolean_t avail_spare
, l2cache
;
5053 verify(zhp
!= NULL
);
5054 if (zpool_get_state(zhp
) == POOL_STATE_UNAVAIL
) {
5055 char errbuf
[ERRBUFLEN
];
5056 (void) snprintf(errbuf
, sizeof (errbuf
),
5057 dgettext(TEXT_DOMAIN
, "pool is in an unavailable state"));
5058 return (zfs_error(zhp
->zpool_hdl
, EZFS_POOLUNAVAIL
, errbuf
));
5061 if ((tgt
= zpool_find_vdev(zhp
, vdevname
, &avail_spare
, &l2cache
,
5063 char errbuf
[ERRBUFLEN
];
5064 (void) snprintf(errbuf
, sizeof (errbuf
),
5065 dgettext(TEXT_DOMAIN
, "can not find %s in %s"),
5066 vdevname
, zhp
->zpool_name
);
5067 return (zfs_error(zhp
->zpool_hdl
, EZFS_NODEVICE
, errbuf
));
5070 *vdev_guid
= fnvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
);
5075 * Get a vdev property value for 'prop' and return the value in
5076 * a pre-allocated buffer.
5079 zpool_get_vdev_prop_value(nvlist_t
*nvprop
, vdev_prop_t prop
, char *prop_name
,
5080 char *buf
, size_t len
, zprop_source_t
*srctype
, boolean_t literal
)
5085 zprop_source_t src
= ZPROP_SRC_NONE
;
5087 if (prop
== VDEV_PROP_USERPROP
) {
5088 /* user property, prop_name must contain the property name */
5089 assert(prop_name
!= NULL
);
5090 if (nvlist_lookup_nvlist(nvprop
, prop_name
, &nv
) == 0) {
5091 src
= fnvlist_lookup_uint64(nv
, ZPROP_SOURCE
);
5092 strval
= fnvlist_lookup_string(nv
, ZPROP_VALUE
);
5094 /* user prop not found */
5097 (void) strlcpy(buf
, strval
, len
);
5103 if (prop_name
== NULL
)
5104 prop_name
= (char *)vdev_prop_to_name(prop
);
5106 switch (vdev_prop_get_type(prop
)) {
5107 case PROP_TYPE_STRING
:
5108 if (nvlist_lookup_nvlist(nvprop
, prop_name
, &nv
) == 0) {
5109 src
= fnvlist_lookup_uint64(nv
, ZPROP_SOURCE
);
5110 strval
= fnvlist_lookup_string(nv
, ZPROP_VALUE
);
5112 src
= ZPROP_SRC_DEFAULT
;
5113 if ((strval
= vdev_prop_default_string(prop
)) == NULL
)
5116 (void) strlcpy(buf
, strval
, len
);
5119 case PROP_TYPE_NUMBER
:
5120 if (nvlist_lookup_nvlist(nvprop
, prop_name
, &nv
) == 0) {
5121 src
= fnvlist_lookup_uint64(nv
, ZPROP_SOURCE
);
5122 intval
= fnvlist_lookup_uint64(nv
, ZPROP_VALUE
);
5124 src
= ZPROP_SRC_DEFAULT
;
5125 intval
= vdev_prop_default_numeric(prop
);
5129 case VDEV_PROP_ASIZE
:
5130 case VDEV_PROP_PSIZE
:
5131 case VDEV_PROP_SIZE
:
5132 case VDEV_PROP_BOOTSIZE
:
5133 case VDEV_PROP_ALLOCATED
:
5134 case VDEV_PROP_FREE
:
5135 case VDEV_PROP_READ_ERRORS
:
5136 case VDEV_PROP_WRITE_ERRORS
:
5137 case VDEV_PROP_CHECKSUM_ERRORS
:
5138 case VDEV_PROP_INITIALIZE_ERRORS
:
5139 case VDEV_PROP_OPS_NULL
:
5140 case VDEV_PROP_OPS_READ
:
5141 case VDEV_PROP_OPS_WRITE
:
5142 case VDEV_PROP_OPS_FREE
:
5143 case VDEV_PROP_OPS_CLAIM
:
5144 case VDEV_PROP_OPS_TRIM
:
5145 case VDEV_PROP_BYTES_NULL
:
5146 case VDEV_PROP_BYTES_READ
:
5147 case VDEV_PROP_BYTES_WRITE
:
5148 case VDEV_PROP_BYTES_FREE
:
5149 case VDEV_PROP_BYTES_CLAIM
:
5150 case VDEV_PROP_BYTES_TRIM
:
5152 (void) snprintf(buf
, len
, "%llu",
5153 (u_longlong_t
)intval
);
5155 (void) zfs_nicenum(intval
, buf
, len
);
5158 case VDEV_PROP_EXPANDSZ
:
5160 (void) strlcpy(buf
, "-", len
);
5161 } else if (literal
) {
5162 (void) snprintf(buf
, len
, "%llu",
5163 (u_longlong_t
)intval
);
5165 (void) zfs_nicenum(intval
, buf
, len
);
5168 case VDEV_PROP_CAPACITY
:
5170 (void) snprintf(buf
, len
, "%llu",
5171 (u_longlong_t
)intval
);
5173 (void) snprintf(buf
, len
, "%llu%%",
5174 (u_longlong_t
)intval
);
5177 case VDEV_PROP_CHECKSUM_N
:
5178 case VDEV_PROP_CHECKSUM_T
:
5179 case VDEV_PROP_IO_N
:
5180 case VDEV_PROP_IO_T
:
5181 if (intval
== UINT64_MAX
) {
5182 (void) strlcpy(buf
, "-", len
);
5184 (void) snprintf(buf
, len
, "%llu",
5185 (u_longlong_t
)intval
);
5188 case VDEV_PROP_FRAGMENTATION
:
5189 if (intval
== UINT64_MAX
) {
5190 (void) strlcpy(buf
, "-", len
);
5192 (void) snprintf(buf
, len
, "%llu%%",
5193 (u_longlong_t
)intval
);
5196 case VDEV_PROP_STATE
:
5198 (void) snprintf(buf
, len
, "%llu",
5199 (u_longlong_t
)intval
);
5201 (void) strlcpy(buf
, zpool_state_to_name(intval
,
5202 VDEV_AUX_NONE
), len
);
5206 (void) snprintf(buf
, len
, "%llu",
5207 (u_longlong_t
)intval
);
5211 case PROP_TYPE_INDEX
:
5212 if (nvlist_lookup_nvlist(nvprop
, prop_name
, &nv
) == 0) {
5213 src
= fnvlist_lookup_uint64(nv
, ZPROP_SOURCE
);
5214 intval
= fnvlist_lookup_uint64(nv
, ZPROP_VALUE
);
5216 src
= ZPROP_SRC_DEFAULT
;
5217 intval
= vdev_prop_default_numeric(prop
);
5219 if (vdev_prop_index_to_string(prop
, intval
,
5220 (const char **)&strval
) != 0)
5222 (void) strlcpy(buf
, strval
, len
);
5236 * Get a vdev property value for 'prop_name' and return the value in
5237 * a pre-allocated buffer.
5240 zpool_get_vdev_prop(zpool_handle_t
*zhp
, const char *vdevname
, vdev_prop_t prop
,
5241 char *prop_name
, char *buf
, size_t len
, zprop_source_t
*srctype
,
5244 nvlist_t
*reqnvl
, *reqprops
;
5245 nvlist_t
*retprops
= NULL
;
5246 uint64_t vdev_guid
= 0;
5249 if ((ret
= zpool_vdev_guid(zhp
, vdevname
, &vdev_guid
)) != 0)
5252 if (nvlist_alloc(&reqnvl
, NV_UNIQUE_NAME
, 0) != 0)
5253 return (no_memory(zhp
->zpool_hdl
));
5254 if (nvlist_alloc(&reqprops
, NV_UNIQUE_NAME
, 0) != 0)
5255 return (no_memory(zhp
->zpool_hdl
));
5257 fnvlist_add_uint64(reqnvl
, ZPOOL_VDEV_PROPS_GET_VDEV
, vdev_guid
);
5259 if (prop
!= VDEV_PROP_USERPROP
) {
5260 /* prop_name overrides prop value */
5261 if (prop_name
!= NULL
)
5262 prop
= vdev_name_to_prop(prop_name
);
5264 prop_name
= (char *)vdev_prop_to_name(prop
);
5265 assert(prop
< VDEV_NUM_PROPS
);
5268 assert(prop_name
!= NULL
);
5269 if (nvlist_add_uint64(reqprops
, prop_name
, prop
) != 0) {
5270 nvlist_free(reqnvl
);
5271 nvlist_free(reqprops
);
5272 return (no_memory(zhp
->zpool_hdl
));
5275 fnvlist_add_nvlist(reqnvl
, ZPOOL_VDEV_PROPS_GET_PROPS
, reqprops
);
5277 ret
= lzc_get_vdev_prop(zhp
->zpool_name
, reqnvl
, &retprops
);
5280 ret
= zpool_get_vdev_prop_value(retprops
, prop
, prop_name
, buf
,
5281 len
, srctype
, literal
);
5283 char errbuf
[ERRBUFLEN
];
5284 (void) snprintf(errbuf
, sizeof (errbuf
),
5285 dgettext(TEXT_DOMAIN
, "cannot get vdev property %s from"
5286 " %s in %s"), prop_name
, vdevname
, zhp
->zpool_name
);
5287 (void) zpool_standard_error(zhp
->zpool_hdl
, ret
, errbuf
);
5290 nvlist_free(reqnvl
);
5291 nvlist_free(reqprops
);
5292 nvlist_free(retprops
);
5298 * Get all vdev properties
5301 zpool_get_all_vdev_props(zpool_handle_t
*zhp
, const char *vdevname
,
5304 nvlist_t
*nvl
= NULL
;
5305 uint64_t vdev_guid
= 0;
5308 if ((ret
= zpool_vdev_guid(zhp
, vdevname
, &vdev_guid
)) != 0)
5311 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0)
5312 return (no_memory(zhp
->zpool_hdl
));
5314 fnvlist_add_uint64(nvl
, ZPOOL_VDEV_PROPS_GET_VDEV
, vdev_guid
);
5316 ret
= lzc_get_vdev_prop(zhp
->zpool_name
, nvl
, outnvl
);
5321 char errbuf
[ERRBUFLEN
];
5322 (void) snprintf(errbuf
, sizeof (errbuf
),
5323 dgettext(TEXT_DOMAIN
, "cannot get vdev properties for"
5324 " %s in %s"), vdevname
, zhp
->zpool_name
);
5325 (void) zpool_standard_error(zhp
->zpool_hdl
, errno
, errbuf
);
5335 zpool_set_vdev_prop(zpool_handle_t
*zhp
, const char *vdevname
,
5336 const char *propname
, const char *propval
)
5339 nvlist_t
*nvl
= NULL
;
5340 nvlist_t
*outnvl
= NULL
;
5342 nvlist_t
*realprops
;
5343 prop_flags_t flags
= { 0 };
5347 if ((ret
= zpool_vdev_guid(zhp
, vdevname
, &vdev_guid
)) != 0)
5350 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0)
5351 return (no_memory(zhp
->zpool_hdl
));
5352 if (nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0) != 0)
5353 return (no_memory(zhp
->zpool_hdl
));
5355 fnvlist_add_uint64(nvl
, ZPOOL_VDEV_PROPS_SET_VDEV
, vdev_guid
);
5357 if (nvlist_add_string(props
, propname
, propval
) != 0) {
5359 return (no_memory(zhp
->zpool_hdl
));
5362 char errbuf
[ERRBUFLEN
];
5363 (void) snprintf(errbuf
, sizeof (errbuf
),
5364 dgettext(TEXT_DOMAIN
, "cannot set property %s for %s on %s"),
5365 propname
, vdevname
, zhp
->zpool_name
);
5368 version
= zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
);
5369 if ((realprops
= zpool_valid_proplist(zhp
->zpool_hdl
,
5370 zhp
->zpool_name
, props
, version
, flags
, errbuf
)) == NULL
) {
5379 fnvlist_add_nvlist(nvl
, ZPOOL_VDEV_PROPS_SET_PROPS
, props
);
5381 ret
= lzc_set_vdev_prop(zhp
->zpool_name
, nvl
, &outnvl
);
5385 nvlist_free(outnvl
);
5388 (void) zpool_standard_error(zhp
->zpool_hdl
, errno
, errbuf
);