4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
37 #include <sys/efi_partition.h>
39 #include <sys/zfs_ioctl.h>
42 #include "zfs_namecheck.h"
44 #include "libzfs_impl.h"
45 #include "zfs_comutil.h"
47 static int read_efi_label(nvlist_t
*config
, diskaddr_t
*sb
);
49 typedef struct prop_flags
{
50 int create
:1; /* Validate property on creation */
51 int import
:1; /* Validate property on import */
55 * ====================================================================
56 * zpool property functions
57 * ====================================================================
61 zpool_get_all_props(zpool_handle_t
*zhp
)
63 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
64 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
66 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
68 if (zcmd_alloc_dst_nvlist(hdl
, &zc
, 0) != 0)
71 while (ioctl(hdl
->libzfs_fd
, ZFS_IOC_POOL_GET_PROPS
, &zc
) != 0) {
72 if (errno
== ENOMEM
) {
73 if (zcmd_expand_dst_nvlist(hdl
, &zc
) != 0) {
74 zcmd_free_nvlists(&zc
);
78 zcmd_free_nvlists(&zc
);
83 if (zcmd_read_dst_nvlist(hdl
, &zc
, &zhp
->zpool_props
) != 0) {
84 zcmd_free_nvlists(&zc
);
88 zcmd_free_nvlists(&zc
);
94 zpool_props_refresh(zpool_handle_t
*zhp
)
98 old_props
= zhp
->zpool_props
;
100 if (zpool_get_all_props(zhp
) != 0)
103 nvlist_free(old_props
);
108 zpool_get_prop_string(zpool_handle_t
*zhp
, zpool_prop_t prop
,
114 zprop_source_t source
;
116 nvl
= zhp
->zpool_props
;
117 if (nvlist_lookup_nvlist(nvl
, zpool_prop_to_name(prop
), &nv
) == 0) {
118 verify(nvlist_lookup_uint64(nv
, ZPROP_SOURCE
, &ival
) == 0);
120 verify(nvlist_lookup_string(nv
, ZPROP_VALUE
, &value
) == 0);
122 source
= ZPROP_SRC_DEFAULT
;
123 if ((value
= (char *)zpool_prop_default_string(prop
)) == NULL
)
134 zpool_get_prop_int(zpool_handle_t
*zhp
, zpool_prop_t prop
, zprop_source_t
*src
)
138 zprop_source_t source
;
140 if (zhp
->zpool_props
== NULL
&& zpool_get_all_props(zhp
)) {
142 * zpool_get_all_props() has most likely failed because
143 * the pool is faulted, but if all we need is the top level
144 * vdev's guid then get it from the zhp config nvlist.
146 if ((prop
== ZPOOL_PROP_GUID
) &&
147 (nvlist_lookup_nvlist(zhp
->zpool_config
,
148 ZPOOL_CONFIG_VDEV_TREE
, &nv
) == 0) &&
149 (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_GUID
, &value
)
153 return (zpool_prop_default_numeric(prop
));
156 nvl
= zhp
->zpool_props
;
157 if (nvlist_lookup_nvlist(nvl
, zpool_prop_to_name(prop
), &nv
) == 0) {
158 verify(nvlist_lookup_uint64(nv
, ZPROP_SOURCE
, &value
) == 0);
160 verify(nvlist_lookup_uint64(nv
, ZPROP_VALUE
, &value
) == 0);
162 source
= ZPROP_SRC_DEFAULT
;
163 value
= zpool_prop_default_numeric(prop
);
173 * Map VDEV STATE to printed strings.
176 zpool_state_to_name(vdev_state_t state
, vdev_aux_t aux
)
181 case VDEV_STATE_CLOSED
:
182 case VDEV_STATE_OFFLINE
:
183 return (gettext("OFFLINE"));
184 case VDEV_STATE_REMOVED
:
185 return (gettext("REMOVED"));
186 case VDEV_STATE_CANT_OPEN
:
187 if (aux
== VDEV_AUX_CORRUPT_DATA
|| aux
== VDEV_AUX_BAD_LOG
)
188 return (gettext("FAULTED"));
189 else if (aux
== VDEV_AUX_SPLIT_POOL
)
190 return (gettext("SPLIT"));
192 return (gettext("UNAVAIL"));
193 case VDEV_STATE_FAULTED
:
194 return (gettext("FAULTED"));
195 case VDEV_STATE_DEGRADED
:
196 return (gettext("DEGRADED"));
197 case VDEV_STATE_HEALTHY
:
198 return (gettext("ONLINE"));
201 return (gettext("UNKNOWN"));
205 * Get a zpool property value for 'prop' and return the value in
206 * a pre-allocated buffer.
209 zpool_get_prop(zpool_handle_t
*zhp
, zpool_prop_t prop
, char *buf
, size_t len
,
210 zprop_source_t
*srctype
)
214 zprop_source_t src
= ZPROP_SRC_NONE
;
219 if (zpool_get_state(zhp
) == POOL_STATE_UNAVAIL
) {
221 case ZPOOL_PROP_NAME
:
222 (void) strlcpy(buf
, zpool_get_name(zhp
), len
);
225 case ZPOOL_PROP_HEALTH
:
226 (void) strlcpy(buf
, "FAULTED", len
);
229 case ZPOOL_PROP_GUID
:
230 intval
= zpool_get_prop_int(zhp
, prop
, &src
);
231 (void) snprintf(buf
, len
, "%llu", (u_longlong_t
)intval
);
234 case ZPOOL_PROP_ALTROOT
:
235 case ZPOOL_PROP_CACHEFILE
:
236 if (zhp
->zpool_props
!= NULL
||
237 zpool_get_all_props(zhp
) == 0) {
239 zpool_get_prop_string(zhp
, prop
, &src
),
247 (void) strlcpy(buf
, "-", len
);
256 if (zhp
->zpool_props
== NULL
&& zpool_get_all_props(zhp
) &&
257 prop
!= ZPOOL_PROP_NAME
)
260 switch (zpool_prop_get_type(prop
)) {
261 case PROP_TYPE_STRING
:
262 (void) strlcpy(buf
, zpool_get_prop_string(zhp
, prop
, &src
),
266 case PROP_TYPE_NUMBER
:
267 intval
= zpool_get_prop_int(zhp
, prop
, &src
);
270 case ZPOOL_PROP_SIZE
:
271 case ZPOOL_PROP_ALLOCATED
:
272 case ZPOOL_PROP_FREE
:
273 case ZPOOL_PROP_ASHIFT
:
274 (void) zfs_nicenum(intval
, buf
, len
);
277 case ZPOOL_PROP_CAPACITY
:
278 (void) snprintf(buf
, len
, "%llu%%",
279 (u_longlong_t
)intval
);
282 case ZPOOL_PROP_DEDUPRATIO
:
283 (void) snprintf(buf
, len
, "%llu.%02llux",
284 (u_longlong_t
)(intval
/ 100),
285 (u_longlong_t
)(intval
% 100));
288 case ZPOOL_PROP_HEALTH
:
289 verify(nvlist_lookup_nvlist(zpool_get_config(zhp
, NULL
),
290 ZPOOL_CONFIG_VDEV_TREE
, &nvroot
) == 0);
291 verify(nvlist_lookup_uint64_array(nvroot
,
292 ZPOOL_CONFIG_VDEV_STATS
, (uint64_t **)&vs
, &vsc
)
295 (void) strlcpy(buf
, zpool_state_to_name(intval
,
299 (void) snprintf(buf
, len
, "%llu", (u_longlong_t
)intval
);
303 case PROP_TYPE_INDEX
:
304 intval
= zpool_get_prop_int(zhp
, prop
, &src
);
305 if (zpool_prop_index_to_string(prop
, intval
, &strval
)
308 (void) strlcpy(buf
, strval
, len
);
322 * Check if the bootfs name has the same pool name as it is set to.
323 * Assuming bootfs is a valid dataset name.
326 bootfs_name_valid(const char *pool
, char *bootfs
)
328 int len
= strlen(pool
);
330 if (!zfs_name_valid(bootfs
, ZFS_TYPE_FILESYSTEM
|ZFS_TYPE_SNAPSHOT
))
333 if (strncmp(pool
, bootfs
, len
) == 0 &&
334 (bootfs
[len
] == '/' || bootfs
[len
] == '\0'))
341 * Inspect the configuration to determine if any of the devices contain
345 pool_uses_efi(nvlist_t
*config
)
350 if (nvlist_lookup_nvlist_array(config
, ZPOOL_CONFIG_CHILDREN
,
351 &child
, &children
) != 0)
352 return (read_efi_label(config
, NULL
) >= 0);
354 for (c
= 0; c
< children
; c
++) {
355 if (pool_uses_efi(child
[c
]))
362 pool_is_bootable(zpool_handle_t
*zhp
)
364 char bootfs
[ZPOOL_MAXNAMELEN
];
366 return (zpool_get_prop(zhp
, ZPOOL_PROP_BOOTFS
, bootfs
,
367 sizeof (bootfs
), NULL
) == 0 && strncmp(bootfs
, "-",
368 sizeof (bootfs
)) != 0);
373 * Given an nvlist of zpool properties to be set, validate that they are
374 * correct, and parse any numeric properties (index, boolean, etc) if they are
375 * specified as strings.
378 zpool_valid_proplist(libzfs_handle_t
*hdl
, const char *poolname
,
379 nvlist_t
*props
, uint64_t version
, prop_flags_t flags
, char *errbuf
)
387 struct stat64 statbuf
;
391 if (nvlist_alloc(&retprops
, NV_UNIQUE_NAME
, 0) != 0) {
392 (void) no_memory(hdl
);
397 while ((elem
= nvlist_next_nvpair(props
, elem
)) != NULL
) {
398 const char *propname
= nvpair_name(elem
);
401 * Make sure this property is valid and applies to this type.
403 if ((prop
= zpool_name_to_prop(propname
)) == ZPROP_INVAL
) {
404 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
405 "invalid property '%s'"), propname
);
406 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
410 if (zpool_prop_readonly(prop
)) {
411 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "'%s' "
412 "is readonly"), propname
);
413 (void) zfs_error(hdl
, EZFS_PROPREADONLY
, errbuf
);
417 if (zprop_parse_value(hdl
, elem
, prop
, ZFS_TYPE_POOL
, retprops
,
418 &strval
, &intval
, errbuf
) != 0)
422 * Perform additional checking for specific properties.
427 case ZPOOL_PROP_VERSION
:
428 if (intval
< version
|| intval
> SPA_VERSION
) {
429 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
430 "property '%s' number %d is invalid."),
432 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
437 case ZPOOL_PROP_ASHIFT
:
439 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
440 "property '%s' can only be set at "
441 "creation time"), propname
);
442 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
446 if (intval
!= 0 && (intval
< 9 || intval
> 13)) {
447 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
448 "property '%s' number %d is invalid."),
450 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
455 case ZPOOL_PROP_BOOTFS
:
456 if (flags
.create
|| flags
.import
) {
457 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
458 "property '%s' cannot be set at creation "
459 "or import time"), propname
);
460 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
464 if (version
< SPA_VERSION_BOOTFS
) {
465 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
466 "pool must be upgraded to support "
467 "'%s' property"), propname
);
468 (void) zfs_error(hdl
, EZFS_BADVERSION
, errbuf
);
473 * bootfs property value has to be a dataset name and
474 * the dataset has to be in the same pool as it sets to.
476 if (strval
[0] != '\0' && !bootfs_name_valid(poolname
,
478 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "'%s' "
479 "is an invalid name"), strval
);
480 (void) zfs_error(hdl
, EZFS_INVALIDNAME
, errbuf
);
484 if ((zhp
= zpool_open_canfail(hdl
, poolname
)) == NULL
) {
485 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
486 "could not open pool '%s'"), poolname
);
487 (void) zfs_error(hdl
, EZFS_OPENFAILED
, errbuf
);
490 verify(nvlist_lookup_nvlist(zpool_get_config(zhp
, NULL
),
491 ZPOOL_CONFIG_VDEV_TREE
, &nvroot
) == 0);
493 #if defined(__sun__) || defined(__sun)
495 * bootfs property cannot be set on a disk which has
498 if (pool_uses_efi(nvroot
)) {
499 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
500 "property '%s' not supported on "
501 "EFI labeled devices"), propname
);
502 (void) zfs_error(hdl
, EZFS_POOL_NOTSUP
, errbuf
);
510 case ZPOOL_PROP_ALTROOT
:
511 if (!flags
.create
&& !flags
.import
) {
512 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
513 "property '%s' can only be set during pool "
514 "creation or import"), propname
);
515 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
519 if (strval
[0] != '/') {
520 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
521 "bad alternate root '%s'"), strval
);
522 (void) zfs_error(hdl
, EZFS_BADPATH
, errbuf
);
527 case ZPOOL_PROP_CACHEFILE
:
528 if (strval
[0] == '\0')
531 if (strcmp(strval
, "none") == 0)
534 if (strval
[0] != '/') {
535 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
536 "property '%s' must be empty, an "
537 "absolute path, or 'none'"), propname
);
538 (void) zfs_error(hdl
, EZFS_BADPATH
, errbuf
);
542 slash
= strrchr(strval
, '/');
544 if (slash
[1] == '\0' || strcmp(slash
, "/.") == 0 ||
545 strcmp(slash
, "/..") == 0) {
546 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
547 "'%s' is not a valid file"), strval
);
548 (void) zfs_error(hdl
, EZFS_BADPATH
, errbuf
);
554 if (strval
[0] != '\0' &&
555 (stat64(strval
, &statbuf
) != 0 ||
556 !S_ISDIR(statbuf
.st_mode
))) {
557 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
558 "'%s' is not a valid directory"),
560 (void) zfs_error(hdl
, EZFS_BADPATH
, errbuf
);
567 case ZPOOL_PROP_READONLY
:
569 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
570 "property '%s' can only be set at "
571 "import time"), propname
);
572 (void) zfs_error(hdl
, EZFS_BADPROP
, errbuf
);
581 nvlist_free(retprops
);
586 * Set zpool property : propname=propval.
589 zpool_set_prop(zpool_handle_t
*zhp
, const char *propname
, const char *propval
)
591 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
594 nvlist_t
*nvl
= NULL
;
597 prop_flags_t flags
= { 0 };
599 (void) snprintf(errbuf
, sizeof (errbuf
),
600 dgettext(TEXT_DOMAIN
, "cannot set property for '%s'"),
603 if (nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, 0) != 0)
604 return (no_memory(zhp
->zpool_hdl
));
606 if (nvlist_add_string(nvl
, propname
, propval
) != 0) {
608 return (no_memory(zhp
->zpool_hdl
));
611 version
= zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
);
612 if ((realprops
= zpool_valid_proplist(zhp
->zpool_hdl
,
613 zhp
->zpool_name
, nvl
, version
, flags
, errbuf
)) == NULL
) {
622 * Execute the corresponding ioctl() to set this property.
624 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
626 if (zcmd_write_src_nvlist(zhp
->zpool_hdl
, &zc
, nvl
) != 0) {
631 ret
= zfs_ioctl(zhp
->zpool_hdl
, ZFS_IOC_POOL_SET_PROPS
, &zc
);
633 zcmd_free_nvlists(&zc
);
637 (void) zpool_standard_error(zhp
->zpool_hdl
, errno
, errbuf
);
639 (void) zpool_props_refresh(zhp
);
645 zpool_expand_proplist(zpool_handle_t
*zhp
, zprop_list_t
**plp
)
647 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
649 char buf
[ZFS_MAXPROPLEN
];
651 if (zprop_expand_list(hdl
, plp
, ZFS_TYPE_POOL
) != 0)
654 for (entry
= *plp
; entry
!= NULL
; entry
= entry
->pl_next
) {
659 if (entry
->pl_prop
!= ZPROP_INVAL
&&
660 zpool_get_prop(zhp
, entry
->pl_prop
, buf
, sizeof (buf
),
662 if (strlen(buf
) > entry
->pl_width
)
663 entry
->pl_width
= strlen(buf
);
672 * Don't start the slice at the default block of 34; many storage
673 * devices will use a stripe width of 128k, other vendors prefer a 1m
674 * alignment. It is best to play it safe and ensure a 1m alignment
675 * given 512B blocks. When the block size is larger by a power of 2
676 * we will still be 1m aligned. Some devices are sensitive to the
677 * partition ending alignment as well.
679 #define NEW_START_BLOCK 2048
680 #define PARTITION_END_ALIGNMENT 2048
683 * Validate the given pool name, optionally putting an extended error message in
687 zpool_name_valid(libzfs_handle_t
*hdl
, boolean_t isopen
, const char *pool
)
693 ret
= pool_namecheck(pool
, &why
, &what
);
696 * The rules for reserved pool names were extended at a later point.
697 * But we need to support users with existing pools that may now be
698 * invalid. So we only check for this expanded set of names during a
699 * create (or import), and only in userland.
701 if (ret
== 0 && !isopen
&&
702 (strncmp(pool
, "mirror", 6) == 0 ||
703 strncmp(pool
, "raidz", 5) == 0 ||
704 strncmp(pool
, "spare", 5) == 0 ||
705 strcmp(pool
, "log") == 0)) {
708 dgettext(TEXT_DOMAIN
, "name is reserved"));
716 case NAME_ERR_TOOLONG
:
718 dgettext(TEXT_DOMAIN
, "name is too long"));
721 case NAME_ERR_INVALCHAR
:
723 dgettext(TEXT_DOMAIN
, "invalid character "
724 "'%c' in pool name"), what
);
727 case NAME_ERR_NOLETTER
:
728 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
729 "name must begin with a letter"));
732 case NAME_ERR_RESERVED
:
733 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
734 "name is reserved"));
737 case NAME_ERR_DISKLIKE
:
738 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
739 "pool name is reserved"));
742 case NAME_ERR_LEADING_SLASH
:
743 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
744 "leading slash in name"));
747 case NAME_ERR_EMPTY_COMPONENT
:
748 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
749 "empty component in name"));
752 case NAME_ERR_TRAILING_SLASH
:
753 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
754 "trailing slash in name"));
757 case NAME_ERR_MULTIPLE_AT
:
758 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
759 "multiple '@' delimiters in name"));
762 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
763 "permission set is missing '@'"));
774 * Open a handle to the given pool, even if the pool is currently in the FAULTED
778 zpool_open_canfail(libzfs_handle_t
*hdl
, const char *pool
)
784 * Make sure the pool name is valid.
786 if (!zpool_name_valid(hdl
, B_TRUE
, pool
)) {
787 (void) zfs_error_fmt(hdl
, EZFS_INVALIDNAME
,
788 dgettext(TEXT_DOMAIN
, "cannot open '%s'"),
793 if ((zhp
= zfs_alloc(hdl
, sizeof (zpool_handle_t
))) == NULL
)
796 zhp
->zpool_hdl
= hdl
;
797 (void) strlcpy(zhp
->zpool_name
, pool
, sizeof (zhp
->zpool_name
));
799 if (zpool_refresh_stats(zhp
, &missing
) != 0) {
805 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "no such pool"));
806 (void) zfs_error_fmt(hdl
, EZFS_NOENT
,
807 dgettext(TEXT_DOMAIN
, "cannot open '%s'"), pool
);
816 * Like the above, but silent on error. Used when iterating over pools (because
817 * the configuration cache may be out of date).
820 zpool_open_silent(libzfs_handle_t
*hdl
, const char *pool
, zpool_handle_t
**ret
)
825 if ((zhp
= zfs_alloc(hdl
, sizeof (zpool_handle_t
))) == NULL
)
828 zhp
->zpool_hdl
= hdl
;
829 (void) strlcpy(zhp
->zpool_name
, pool
, sizeof (zhp
->zpool_name
));
831 if (zpool_refresh_stats(zhp
, &missing
) != 0) {
847 * Similar to zpool_open_canfail(), but refuses to open pools in the faulted
851 zpool_open(libzfs_handle_t
*hdl
, const char *pool
)
855 if ((zhp
= zpool_open_canfail(hdl
, pool
)) == NULL
)
858 if (zhp
->zpool_state
== POOL_STATE_UNAVAIL
) {
859 (void) zfs_error_fmt(hdl
, EZFS_POOLUNAVAIL
,
860 dgettext(TEXT_DOMAIN
, "cannot open '%s'"), zhp
->zpool_name
);
869 * Close the handle. Simply frees the memory associated with the handle.
872 zpool_close(zpool_handle_t
*zhp
)
874 if (zhp
->zpool_config
)
875 nvlist_free(zhp
->zpool_config
);
876 if (zhp
->zpool_old_config
)
877 nvlist_free(zhp
->zpool_old_config
);
878 if (zhp
->zpool_props
)
879 nvlist_free(zhp
->zpool_props
);
884 * Return the name of the pool.
887 zpool_get_name(zpool_handle_t
*zhp
)
889 return (zhp
->zpool_name
);
894 * Return the state of the pool (ACTIVE or UNAVAILABLE)
897 zpool_get_state(zpool_handle_t
*zhp
)
899 return (zhp
->zpool_state
);
903 * Create the named pool, using the provided vdev list. It is assumed
904 * that the consumer has already validated the contents of the nvlist, so we
905 * don't have to worry about error semantics.
908 zpool_create(libzfs_handle_t
*hdl
, const char *pool
, nvlist_t
*nvroot
,
909 nvlist_t
*props
, nvlist_t
*fsprops
)
911 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
912 nvlist_t
*zc_fsprops
= NULL
;
913 nvlist_t
*zc_props
= NULL
;
918 (void) snprintf(msg
, sizeof (msg
), dgettext(TEXT_DOMAIN
,
919 "cannot create '%s'"), pool
);
921 if (!zpool_name_valid(hdl
, B_FALSE
, pool
))
922 return (zfs_error(hdl
, EZFS_INVALIDNAME
, msg
));
924 if (zcmd_write_conf_nvlist(hdl
, &zc
, nvroot
) != 0)
928 prop_flags_t flags
= { .create
= B_TRUE
, .import
= B_FALSE
};
930 if ((zc_props
= zpool_valid_proplist(hdl
, pool
, props
,
931 SPA_VERSION_1
, flags
, msg
)) == NULL
) {
940 zoned
= ((nvlist_lookup_string(fsprops
,
941 zfs_prop_to_name(ZFS_PROP_ZONED
), &zonestr
) == 0) &&
942 strcmp(zonestr
, "on") == 0);
944 if ((zc_fsprops
= zfs_valid_proplist(hdl
,
945 ZFS_TYPE_FILESYSTEM
, fsprops
, zoned
, NULL
, msg
)) == NULL
) {
949 (nvlist_alloc(&zc_props
, NV_UNIQUE_NAME
, 0) != 0)) {
952 if (nvlist_add_nvlist(zc_props
,
953 ZPOOL_ROOTFS_PROPS
, zc_fsprops
) != 0) {
958 if (zc_props
&& zcmd_write_src_nvlist(hdl
, &zc
, zc_props
) != 0)
961 (void) strlcpy(zc
.zc_name
, pool
, sizeof (zc
.zc_name
));
963 if ((ret
= zfs_ioctl(hdl
, ZFS_IOC_POOL_CREATE
, &zc
)) != 0) {
965 zcmd_free_nvlists(&zc
);
966 nvlist_free(zc_props
);
967 nvlist_free(zc_fsprops
);
972 * This can happen if the user has specified the same
973 * device multiple times. We can't reliably detect this
974 * until we try to add it and see we already have a
975 * label. This can also happen under if the device is
976 * part of an active md or lvm device.
978 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
979 "one or more vdevs refer to the same device, or one of\n"
980 "the devices is part of an active md or lvm device"));
981 return (zfs_error(hdl
, EZFS_BADDEV
, msg
));
985 * This occurs when one of the devices is below
986 * SPA_MINDEVSIZE. Unfortunately, we can't detect which
987 * device was the problem device since there's no
988 * reliable way to determine device size from userland.
993 zfs_nicenum(SPA_MINDEVSIZE
, buf
, sizeof (buf
));
995 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
996 "one or more devices is less than the "
997 "minimum size (%s)"), buf
);
999 return (zfs_error(hdl
, EZFS_BADDEV
, msg
));
1002 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1003 "one or more devices is out of space"));
1004 return (zfs_error(hdl
, EZFS_BADDEV
, msg
));
1007 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1008 "cache device must be a disk or disk slice"));
1009 return (zfs_error(hdl
, EZFS_BADDEV
, msg
));
1012 return (zpool_standard_error(hdl
, errno
, msg
));
1017 * If this is an alternate root pool, then we automatically set the
1018 * mountpoint of the root dataset to be '/'.
1020 if (nvlist_lookup_string(props
, zpool_prop_to_name(ZPOOL_PROP_ALTROOT
),
1024 verify((zhp
= zfs_open(hdl
, pool
, ZFS_TYPE_DATASET
)) != NULL
);
1025 verify(zfs_prop_set(zhp
, zfs_prop_to_name(ZFS_PROP_MOUNTPOINT
),
1032 zcmd_free_nvlists(&zc
);
1033 nvlist_free(zc_props
);
1034 nvlist_free(zc_fsprops
);
1039 * Destroy the given pool. It is up to the caller to ensure that there are no
1040 * datasets left in the pool.
1043 zpool_destroy(zpool_handle_t
*zhp
)
1045 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
1046 zfs_handle_t
*zfp
= NULL
;
1047 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1050 if (zhp
->zpool_state
== POOL_STATE_ACTIVE
&&
1051 (zfp
= zfs_open(hdl
, zhp
->zpool_name
, ZFS_TYPE_FILESYSTEM
)) == NULL
)
1054 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
1056 if (zfs_ioctl(hdl
, ZFS_IOC_POOL_DESTROY
, &zc
) != 0) {
1057 (void) snprintf(msg
, sizeof (msg
), dgettext(TEXT_DOMAIN
,
1058 "cannot destroy '%s'"), zhp
->zpool_name
);
1060 if (errno
== EROFS
) {
1061 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1062 "one or more devices is read only"));
1063 (void) zfs_error(hdl
, EZFS_BADDEV
, msg
);
1065 (void) zpool_standard_error(hdl
, errno
, msg
);
1074 remove_mountpoint(zfp
);
1082 * Add the given vdevs to the pool. The caller must have already performed the
1083 * necessary verification to ensure that the vdev specification is well-formed.
1086 zpool_add(zpool_handle_t
*zhp
, nvlist_t
*nvroot
)
1088 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
1090 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1092 nvlist_t
**spares
, **l2cache
;
1093 uint_t nspares
, nl2cache
;
1095 (void) snprintf(msg
, sizeof (msg
), dgettext(TEXT_DOMAIN
,
1096 "cannot add to '%s'"), zhp
->zpool_name
);
1098 if (zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
) <
1099 SPA_VERSION_SPARES
&&
1100 nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_SPARES
,
1101 &spares
, &nspares
) == 0) {
1102 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "pool must be "
1103 "upgraded to add hot spares"));
1104 return (zfs_error(hdl
, EZFS_BADVERSION
, msg
));
1107 if (pool_is_bootable(zhp
) && nvlist_lookup_nvlist_array(nvroot
,
1108 ZPOOL_CONFIG_SPARES
, &spares
, &nspares
) == 0) {
1111 for (s
= 0; s
< nspares
; s
++) {
1114 if (nvlist_lookup_string(spares
[s
], ZPOOL_CONFIG_PATH
,
1115 &path
) == 0 && pool_uses_efi(spares
[s
])) {
1116 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1117 "device '%s' contains an EFI label and "
1118 "cannot be used on root pools."),
1119 zpool_vdev_name(hdl
, NULL
, spares
[s
],
1121 return (zfs_error(hdl
, EZFS_POOL_NOTSUP
, msg
));
1126 if (zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
) <
1127 SPA_VERSION_L2CACHE
&&
1128 nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_L2CACHE
,
1129 &l2cache
, &nl2cache
) == 0) {
1130 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "pool must be "
1131 "upgraded to add cache devices"));
1132 return (zfs_error(hdl
, EZFS_BADVERSION
, msg
));
1135 if (zcmd_write_conf_nvlist(hdl
, &zc
, nvroot
) != 0)
1137 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
1139 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_ADD
, &zc
) != 0) {
1143 * This can happen if the user has specified the same
1144 * device multiple times. We can't reliably detect this
1145 * until we try to add it and see we already have a
1148 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1149 "one or more vdevs refer to the same device"));
1150 (void) zfs_error(hdl
, EZFS_BADDEV
, msg
);
1155 * This occurrs when one of the devices is below
1156 * SPA_MINDEVSIZE. Unfortunately, we can't detect which
1157 * device was the problem device since there's no
1158 * reliable way to determine device size from userland.
1163 zfs_nicenum(SPA_MINDEVSIZE
, buf
, sizeof (buf
));
1165 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1166 "device is less than the minimum "
1169 (void) zfs_error(hdl
, EZFS_BADDEV
, msg
);
1173 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1174 "pool must be upgraded to add these vdevs"));
1175 (void) zfs_error(hdl
, EZFS_BADVERSION
, msg
);
1179 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1180 "root pool can not have multiple vdevs"
1181 " or separate logs"));
1182 (void) zfs_error(hdl
, EZFS_POOL_NOTSUP
, msg
);
1186 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1187 "cache device must be a disk or disk slice"));
1188 (void) zfs_error(hdl
, EZFS_BADDEV
, msg
);
1192 (void) zpool_standard_error(hdl
, errno
, msg
);
1200 zcmd_free_nvlists(&zc
);
1206 * Exports the pool from the system. The caller must ensure that there are no
1207 * mounted datasets in the pool.
1210 zpool_export_common(zpool_handle_t
*zhp
, boolean_t force
, boolean_t hardforce
)
1212 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
1215 (void) snprintf(msg
, sizeof (msg
), dgettext(TEXT_DOMAIN
,
1216 "cannot export '%s'"), zhp
->zpool_name
);
1218 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
1219 zc
.zc_cookie
= force
;
1220 zc
.zc_guid
= hardforce
;
1222 if (zfs_ioctl(zhp
->zpool_hdl
, ZFS_IOC_POOL_EXPORT
, &zc
) != 0) {
1225 zfs_error_aux(zhp
->zpool_hdl
, dgettext(TEXT_DOMAIN
,
1226 "use '-f' to override the following errors:\n"
1227 "'%s' has an active shared spare which could be"
1228 " used by other pools once '%s' is exported."),
1229 zhp
->zpool_name
, zhp
->zpool_name
);
1230 return (zfs_error(zhp
->zpool_hdl
, EZFS_ACTIVE_SPARE
,
1233 return (zpool_standard_error_fmt(zhp
->zpool_hdl
, errno
,
1242 zpool_export(zpool_handle_t
*zhp
, boolean_t force
)
1244 return (zpool_export_common(zhp
, force
, B_FALSE
));
1248 zpool_export_force(zpool_handle_t
*zhp
)
1250 return (zpool_export_common(zhp
, B_TRUE
, B_TRUE
));
1254 zpool_rewind_exclaim(libzfs_handle_t
*hdl
, const char *name
, boolean_t dryrun
,
1257 nvlist_t
*nv
= NULL
;
1263 if (!hdl
->libzfs_printerr
|| config
== NULL
)
1266 if (nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_LOAD_INFO
, &nv
) != 0)
1269 if (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_LOAD_TIME
, &rewindto
) != 0)
1271 (void) nvlist_lookup_int64(nv
, ZPOOL_CONFIG_REWIND_TIME
, &loss
);
1273 if (localtime_r((time_t *)&rewindto
, &t
) != NULL
&&
1274 strftime(timestr
, 128, "%c", &t
) != 0) {
1276 (void) printf(dgettext(TEXT_DOMAIN
,
1277 "Would be able to return %s "
1278 "to its state as of %s.\n"),
1281 (void) printf(dgettext(TEXT_DOMAIN
,
1282 "Pool %s returned to its state as of %s.\n"),
1286 (void) printf(dgettext(TEXT_DOMAIN
,
1287 "%s approximately %lld "),
1288 dryrun
? "Would discard" : "Discarded",
1289 ((longlong_t
)loss
+ 30) / 60);
1290 (void) printf(dgettext(TEXT_DOMAIN
,
1291 "minutes of transactions.\n"));
1292 } else if (loss
> 0) {
1293 (void) printf(dgettext(TEXT_DOMAIN
,
1294 "%s approximately %lld "),
1295 dryrun
? "Would discard" : "Discarded",
1297 (void) printf(dgettext(TEXT_DOMAIN
,
1298 "seconds of transactions.\n"));
1304 zpool_explain_recover(libzfs_handle_t
*hdl
, const char *name
, int reason
,
1307 nvlist_t
*nv
= NULL
;
1309 uint64_t edata
= UINT64_MAX
;
1314 if (!hdl
->libzfs_printerr
)
1318 (void) printf(dgettext(TEXT_DOMAIN
, "action: "));
1320 (void) printf(dgettext(TEXT_DOMAIN
, "\t"));
1322 /* All attempted rewinds failed if ZPOOL_CONFIG_LOAD_TIME missing */
1323 if (nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_LOAD_INFO
, &nv
) != 0 ||
1324 nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_LOAD_TIME
, &rewindto
) != 0)
1327 (void) nvlist_lookup_int64(nv
, ZPOOL_CONFIG_REWIND_TIME
, &loss
);
1328 (void) nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_LOAD_DATA_ERRORS
,
1331 (void) printf(dgettext(TEXT_DOMAIN
,
1332 "Recovery is possible, but will result in some data loss.\n"));
1334 if (localtime_r((time_t *)&rewindto
, &t
) != NULL
&&
1335 strftime(timestr
, 128, "%c", &t
) != 0) {
1336 (void) printf(dgettext(TEXT_DOMAIN
,
1337 "\tReturning the pool to its state as of %s\n"
1338 "\tshould correct the problem. "),
1341 (void) printf(dgettext(TEXT_DOMAIN
,
1342 "\tReverting the pool to an earlier state "
1343 "should correct the problem.\n\t"));
1347 (void) printf(dgettext(TEXT_DOMAIN
,
1348 "Approximately %lld minutes of data\n"
1349 "\tmust be discarded, irreversibly. "),
1350 ((longlong_t
)loss
+ 30) / 60);
1351 } else if (loss
> 0) {
1352 (void) printf(dgettext(TEXT_DOMAIN
,
1353 "Approximately %lld seconds of data\n"
1354 "\tmust be discarded, irreversibly. "),
1357 if (edata
!= 0 && edata
!= UINT64_MAX
) {
1359 (void) printf(dgettext(TEXT_DOMAIN
,
1360 "After rewind, at least\n"
1361 "\tone persistent user-data error will remain. "));
1363 (void) printf(dgettext(TEXT_DOMAIN
,
1364 "After rewind, several\n"
1365 "\tpersistent user-data errors will remain. "));
1368 (void) printf(dgettext(TEXT_DOMAIN
,
1369 "Recovery can be attempted\n\tby executing 'zpool %s -F %s'. "),
1370 reason
>= 0 ? "clear" : "import", name
);
1372 (void) printf(dgettext(TEXT_DOMAIN
,
1373 "A scrub of the pool\n"
1374 "\tis strongly recommended after recovery.\n"));
1378 (void) printf(dgettext(TEXT_DOMAIN
,
1379 "Destroy and re-create the pool from\n\ta backup source.\n"));
1383 * zpool_import() is a contracted interface. Should be kept the same
1386 * Applications should use zpool_import_props() to import a pool with
1387 * new properties value to be set.
1390 zpool_import(libzfs_handle_t
*hdl
, nvlist_t
*config
, const char *newname
,
1393 nvlist_t
*props
= NULL
;
1396 if (altroot
!= NULL
) {
1397 if (nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0) != 0) {
1398 return (zfs_error_fmt(hdl
, EZFS_NOMEM
,
1399 dgettext(TEXT_DOMAIN
, "cannot import '%s'"),
1403 if (nvlist_add_string(props
,
1404 zpool_prop_to_name(ZPOOL_PROP_ALTROOT
), altroot
) != 0 ||
1405 nvlist_add_string(props
,
1406 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE
), "none") != 0) {
1408 return (zfs_error_fmt(hdl
, EZFS_NOMEM
,
1409 dgettext(TEXT_DOMAIN
, "cannot import '%s'"),
1414 ret
= zpool_import_props(hdl
, config
, newname
, props
,
1422 print_vdev_tree(libzfs_handle_t
*hdl
, const char *name
, nvlist_t
*nv
,
1428 uint64_t is_log
= 0;
1430 (void) nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_IS_LOG
,
1434 (void) printf("\t%*s%s%s\n", indent
, "", name
,
1435 is_log
? " [log]" : "");
1437 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
1438 &child
, &children
) != 0)
1441 for (c
= 0; c
< children
; c
++) {
1442 vname
= zpool_vdev_name(hdl
, NULL
, child
[c
], B_TRUE
);
1443 print_vdev_tree(hdl
, vname
, child
[c
], indent
+ 2);
1449 * Import the given pool using the known configuration and a list of
1450 * properties to be set. The configuration should have come from
1451 * zpool_find_import(). The 'newname' parameters control whether the pool
1452 * is imported with a different name.
1455 zpool_import_props(libzfs_handle_t
*hdl
, nvlist_t
*config
, const char *newname
,
1456 nvlist_t
*props
, int flags
)
1458 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
1459 zpool_rewind_policy_t policy
;
1460 nvlist_t
*nv
= NULL
;
1461 nvlist_t
*nvinfo
= NULL
;
1462 nvlist_t
*missing
= NULL
;
1469 verify(nvlist_lookup_string(config
, ZPOOL_CONFIG_POOL_NAME
,
1472 (void) snprintf(errbuf
, sizeof (errbuf
), dgettext(TEXT_DOMAIN
,
1473 "cannot import pool '%s'"), origname
);
1475 if (newname
!= NULL
) {
1476 if (!zpool_name_valid(hdl
, B_FALSE
, newname
))
1477 return (zfs_error_fmt(hdl
, EZFS_INVALIDNAME
,
1478 dgettext(TEXT_DOMAIN
, "cannot import '%s'"),
1480 thename
= (char *)newname
;
1487 prop_flags_t flags
= { .create
= B_FALSE
, .import
= B_TRUE
};
1489 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_VERSION
,
1492 if ((props
= zpool_valid_proplist(hdl
, origname
,
1493 props
, version
, flags
, errbuf
)) == NULL
) {
1495 } else if (zcmd_write_src_nvlist(hdl
, &zc
, props
) != 0) {
1501 (void) strlcpy(zc
.zc_name
, thename
, sizeof (zc
.zc_name
));
1503 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_GUID
,
1506 if (zcmd_write_conf_nvlist(hdl
, &zc
, config
) != 0) {
1510 if (zcmd_alloc_dst_nvlist(hdl
, &zc
, zc
.zc_nvlist_conf_size
* 2) != 0) {
1515 zc
.zc_cookie
= flags
;
1516 while ((ret
= zfs_ioctl(hdl
, ZFS_IOC_POOL_IMPORT
, &zc
)) != 0 &&
1518 if (zcmd_expand_dst_nvlist(hdl
, &zc
) != 0) {
1519 zcmd_free_nvlists(&zc
);
1526 (void) zcmd_read_dst_nvlist(hdl
, &zc
, &nv
);
1527 zpool_get_rewind_policy(config
, &policy
);
1533 * Dry-run failed, but we print out what success
1534 * looks like if we found a best txg
1536 if (policy
.zrp_request
& ZPOOL_TRY_REWIND
) {
1537 zpool_rewind_exclaim(hdl
, newname
? origname
: thename
,
1543 if (newname
== NULL
)
1544 (void) snprintf(desc
, sizeof (desc
),
1545 dgettext(TEXT_DOMAIN
, "cannot import '%s'"),
1548 (void) snprintf(desc
, sizeof (desc
),
1549 dgettext(TEXT_DOMAIN
, "cannot import '%s' as '%s'"),
1555 * Unsupported version.
1557 (void) zfs_error(hdl
, EZFS_BADVERSION
, desc
);
1561 (void) zfs_error(hdl
, EZFS_INVALCONFIG
, desc
);
1565 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
1566 "one or more devices is read only"));
1567 (void) zfs_error(hdl
, EZFS_BADDEV
, desc
);
1571 if (nv
&& nvlist_lookup_nvlist(nv
,
1572 ZPOOL_CONFIG_LOAD_INFO
, &nvinfo
) == 0 &&
1573 nvlist_lookup_nvlist(nvinfo
,
1574 ZPOOL_CONFIG_MISSING_DEVICES
, &missing
) == 0) {
1575 (void) printf(dgettext(TEXT_DOMAIN
,
1576 "The devices below are missing, use "
1577 "'-m' to import the pool anyway:\n"));
1578 print_vdev_tree(hdl
, NULL
, missing
, 2);
1579 (void) printf("\n");
1581 (void) zpool_standard_error(hdl
, error
, desc
);
1585 (void) zpool_standard_error(hdl
, error
, desc
);
1589 (void) zpool_standard_error(hdl
, error
, desc
);
1590 zpool_explain_recover(hdl
,
1591 newname
? origname
: thename
, -error
, nv
);
1598 zpool_handle_t
*zhp
;
1601 * This should never fail, but play it safe anyway.
1603 if (zpool_open_silent(hdl
, thename
, &zhp
) != 0)
1605 else if (zhp
!= NULL
)
1607 if (policy
.zrp_request
&
1608 (ZPOOL_DO_REWIND
| ZPOOL_TRY_REWIND
)) {
1609 zpool_rewind_exclaim(hdl
, newname
? origname
: thename
,
1610 ((policy
.zrp_request
& ZPOOL_TRY_REWIND
) != 0), nv
);
1616 zcmd_free_nvlists(&zc
);
1626 zpool_scan(zpool_handle_t
*zhp
, pool_scan_func_t func
)
1628 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
1630 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
1632 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
1633 zc
.zc_cookie
= func
;
1635 if (zfs_ioctl(hdl
, ZFS_IOC_POOL_SCAN
, &zc
) == 0 ||
1636 (errno
== ENOENT
&& func
!= POOL_SCAN_NONE
))
1639 if (func
== POOL_SCAN_SCRUB
) {
1640 (void) snprintf(msg
, sizeof (msg
),
1641 dgettext(TEXT_DOMAIN
, "cannot scrub %s"), zc
.zc_name
);
1642 } else if (func
== POOL_SCAN_NONE
) {
1643 (void) snprintf(msg
, sizeof (msg
),
1644 dgettext(TEXT_DOMAIN
, "cannot cancel scrubbing %s"),
1647 assert(!"unexpected result");
1650 if (errno
== EBUSY
) {
1652 pool_scan_stat_t
*ps
= NULL
;
1655 verify(nvlist_lookup_nvlist(zhp
->zpool_config
,
1656 ZPOOL_CONFIG_VDEV_TREE
, &nvroot
) == 0);
1657 (void) nvlist_lookup_uint64_array(nvroot
,
1658 ZPOOL_CONFIG_SCAN_STATS
, (uint64_t **)&ps
, &psc
);
1659 if (ps
&& ps
->pss_func
== POOL_SCAN_SCRUB
)
1660 return (zfs_error(hdl
, EZFS_SCRUBBING
, msg
));
1662 return (zfs_error(hdl
, EZFS_RESILVERING
, msg
));
1663 } else if (errno
== ENOENT
) {
1664 return (zfs_error(hdl
, EZFS_NO_SCRUB
, msg
));
1666 return (zpool_standard_error(hdl
, errno
, msg
));
1671 * Find a vdev that matches the search criteria specified. We use the
1672 * the nvpair name to determine how we should look for the device.
1673 * 'avail_spare' is set to TRUE if the provided guid refers to an AVAIL
1674 * spare; but FALSE if its an INUSE spare.
1677 vdev_to_nvlist_iter(nvlist_t
*nv
, nvlist_t
*search
, boolean_t
*avail_spare
,
1678 boolean_t
*l2cache
, boolean_t
*log
)
1685 nvpair_t
*pair
= nvlist_next_nvpair(search
, NULL
);
1687 /* Nothing to look for */
1688 if (search
== NULL
|| pair
== NULL
)
1691 /* Obtain the key we will use to search */
1692 srchkey
= nvpair_name(pair
);
1694 switch (nvpair_type(pair
)) {
1695 case DATA_TYPE_UINT64
:
1696 if (strcmp(srchkey
, ZPOOL_CONFIG_GUID
) == 0) {
1697 uint64_t srchval
, theguid
;
1699 verify(nvpair_value_uint64(pair
, &srchval
) == 0);
1700 verify(nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_GUID
,
1702 if (theguid
== srchval
)
1707 case DATA_TYPE_STRING
: {
1708 char *srchval
, *val
;
1710 verify(nvpair_value_string(pair
, &srchval
) == 0);
1711 if (nvlist_lookup_string(nv
, srchkey
, &val
) != 0)
1715 * Search for the requested value. Special cases:
1717 * - ZPOOL_CONFIG_PATH for whole disk entries. These end in with a
1718 * partition suffix "1", "-part1", or "p1". The suffix is hidden
1719 * from the user, but included in the string, so this matches around
1721 * - looking for a top-level vdev name (i.e. ZPOOL_CONFIG_TYPE).
1723 * Otherwise, all other searches are simple string compares.
1725 if (strcmp(srchkey
, ZPOOL_CONFIG_PATH
) == 0) {
1726 uint64_t wholedisk
= 0;
1728 (void) nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_WHOLE_DISK
,
1731 char buf
[MAXPATHLEN
];
1733 zfs_append_partition(srchval
, buf
, sizeof (buf
));
1734 if (strcmp(val
, buf
) == 0)
1739 } else if (strcmp(srchkey
, ZPOOL_CONFIG_TYPE
) == 0 && val
) {
1740 char *type
, *idx
, *end
, *p
;
1741 uint64_t id
, vdev_id
;
1744 * Determine our vdev type, keeping in mind
1745 * that the srchval is composed of a type and
1746 * vdev id pair (i.e. mirror-4).
1748 if ((type
= strdup(srchval
)) == NULL
)
1751 if ((p
= strrchr(type
, '-')) == NULL
) {
1759 * If the types don't match then keep looking.
1761 if (strncmp(val
, type
, strlen(val
)) != 0) {
1766 verify(strncmp(type
, VDEV_TYPE_RAIDZ
,
1767 strlen(VDEV_TYPE_RAIDZ
)) == 0 ||
1768 strncmp(type
, VDEV_TYPE_MIRROR
,
1769 strlen(VDEV_TYPE_MIRROR
)) == 0);
1770 verify(nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_ID
,
1774 vdev_id
= strtoull(idx
, &end
, 10);
1781 * Now verify that we have the correct vdev id.
1790 if (strcmp(srchval
, val
) == 0)
1799 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
1800 &child
, &children
) != 0)
1803 for (c
= 0; c
< children
; c
++) {
1804 if ((ret
= vdev_to_nvlist_iter(child
[c
], search
,
1805 avail_spare
, l2cache
, NULL
)) != NULL
) {
1807 * The 'is_log' value is only set for the toplevel
1808 * vdev, not the leaf vdevs. So we always lookup the
1809 * log device from the root of the vdev tree (where
1810 * 'log' is non-NULL).
1813 nvlist_lookup_uint64(child
[c
],
1814 ZPOOL_CONFIG_IS_LOG
, &is_log
) == 0 &&
1822 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_SPARES
,
1823 &child
, &children
) == 0) {
1824 for (c
= 0; c
< children
; c
++) {
1825 if ((ret
= vdev_to_nvlist_iter(child
[c
], search
,
1826 avail_spare
, l2cache
, NULL
)) != NULL
) {
1827 *avail_spare
= B_TRUE
;
1833 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_L2CACHE
,
1834 &child
, &children
) == 0) {
1835 for (c
= 0; c
< children
; c
++) {
1836 if ((ret
= vdev_to_nvlist_iter(child
[c
], search
,
1837 avail_spare
, l2cache
, NULL
)) != NULL
) {
1848 * Given a physical path (minus the "/devices" prefix), find the
1852 zpool_find_vdev_by_physpath(zpool_handle_t
*zhp
, const char *ppath
,
1853 boolean_t
*avail_spare
, boolean_t
*l2cache
, boolean_t
*log
)
1855 nvlist_t
*search
, *nvroot
, *ret
;
1857 verify(nvlist_alloc(&search
, NV_UNIQUE_NAME
, KM_SLEEP
) == 0);
1858 verify(nvlist_add_string(search
, ZPOOL_CONFIG_PHYS_PATH
, ppath
) == 0);
1860 verify(nvlist_lookup_nvlist(zhp
->zpool_config
, ZPOOL_CONFIG_VDEV_TREE
,
1863 *avail_spare
= B_FALSE
;
1867 ret
= vdev_to_nvlist_iter(nvroot
, search
, avail_spare
, l2cache
, log
);
1868 nvlist_free(search
);
1874 * Determine if we have an "interior" top-level vdev (i.e mirror/raidz).
1877 zpool_vdev_is_interior(const char *name
)
1879 if (strncmp(name
, VDEV_TYPE_RAIDZ
, strlen(VDEV_TYPE_RAIDZ
)) == 0 ||
1880 strncmp(name
, VDEV_TYPE_MIRROR
, strlen(VDEV_TYPE_MIRROR
)) == 0)
1886 zpool_find_vdev(zpool_handle_t
*zhp
, const char *path
, boolean_t
*avail_spare
,
1887 boolean_t
*l2cache
, boolean_t
*log
)
1889 char buf
[MAXPATHLEN
];
1891 nvlist_t
*nvroot
, *search
, *ret
;
1894 verify(nvlist_alloc(&search
, NV_UNIQUE_NAME
, KM_SLEEP
) == 0);
1896 guid
= strtoull(path
, &end
, 10);
1897 if (guid
!= 0 && *end
== '\0') {
1898 verify(nvlist_add_uint64(search
, ZPOOL_CONFIG_GUID
, guid
) == 0);
1899 } else if (zpool_vdev_is_interior(path
)) {
1900 verify(nvlist_add_string(search
, ZPOOL_CONFIG_TYPE
, path
) == 0);
1901 } else if (path
[0] != '/') {
1902 if (zfs_resolve_shortname(path
, buf
, sizeof (buf
)) < 0) {
1903 nvlist_free(search
);
1906 verify(nvlist_add_string(search
, ZPOOL_CONFIG_PATH
, buf
) == 0);
1908 verify(nvlist_add_string(search
, ZPOOL_CONFIG_PATH
, path
) == 0);
1911 verify(nvlist_lookup_nvlist(zhp
->zpool_config
, ZPOOL_CONFIG_VDEV_TREE
,
1914 *avail_spare
= B_FALSE
;
1918 ret
= vdev_to_nvlist_iter(nvroot
, search
, avail_spare
, l2cache
, log
);
1919 nvlist_free(search
);
1925 vdev_online(nvlist_t
*nv
)
1929 if (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_OFFLINE
, &ival
) == 0 ||
1930 nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_FAULTED
, &ival
) == 0 ||
1931 nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_REMOVED
, &ival
) == 0)
1938 * Helper function for zpool_get_physpaths().
1941 vdev_get_one_physpath(nvlist_t
*config
, char *physpath
, size_t physpath_size
,
1942 size_t *bytes_written
)
1944 size_t bytes_left
, pos
, rsz
;
1948 if (nvlist_lookup_string(config
, ZPOOL_CONFIG_PHYS_PATH
,
1950 return (EZFS_NODEVICE
);
1952 pos
= *bytes_written
;
1953 bytes_left
= physpath_size
- pos
;
1954 format
= (pos
== 0) ? "%s" : " %s";
1956 rsz
= snprintf(physpath
+ pos
, bytes_left
, format
, tmppath
);
1957 *bytes_written
+= rsz
;
1959 if (rsz
>= bytes_left
) {
1960 /* if physpath was not copied properly, clear it */
1961 if (bytes_left
!= 0) {
1964 return (EZFS_NOSPC
);
1970 vdev_get_physpaths(nvlist_t
*nv
, char *physpath
, size_t phypath_size
,
1971 size_t *rsz
, boolean_t is_spare
)
1976 if (nvlist_lookup_string(nv
, ZPOOL_CONFIG_TYPE
, &type
) != 0)
1977 return (EZFS_INVALCONFIG
);
1979 if (strcmp(type
, VDEV_TYPE_DISK
) == 0) {
1981 * An active spare device has ZPOOL_CONFIG_IS_SPARE set.
1982 * For a spare vdev, we only want to boot from the active
1987 (void) nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_IS_SPARE
,
1990 return (EZFS_INVALCONFIG
);
1993 if (vdev_online(nv
)) {
1994 if ((ret
= vdev_get_one_physpath(nv
, physpath
,
1995 phypath_size
, rsz
)) != 0)
1998 } else if (strcmp(type
, VDEV_TYPE_MIRROR
) == 0 ||
1999 strcmp(type
, VDEV_TYPE_REPLACING
) == 0 ||
2000 (is_spare
= (strcmp(type
, VDEV_TYPE_SPARE
) == 0))) {
2005 if (nvlist_lookup_nvlist_array(nv
,
2006 ZPOOL_CONFIG_CHILDREN
, &child
, &count
) != 0)
2007 return (EZFS_INVALCONFIG
);
2009 for (i
= 0; i
< count
; i
++) {
2010 ret
= vdev_get_physpaths(child
[i
], physpath
,
2011 phypath_size
, rsz
, is_spare
);
2012 if (ret
== EZFS_NOSPC
)
2017 return (EZFS_POOL_INVALARG
);
2021 * Get phys_path for a root pool config.
2022 * Return 0 on success; non-zero on failure.
2025 zpool_get_config_physpath(nvlist_t
*config
, char *physpath
, size_t phypath_size
)
2028 nvlist_t
*vdev_root
;
2035 if (nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
2037 return (EZFS_INVALCONFIG
);
2039 if (nvlist_lookup_string(vdev_root
, ZPOOL_CONFIG_TYPE
, &type
) != 0 ||
2040 nvlist_lookup_nvlist_array(vdev_root
, ZPOOL_CONFIG_CHILDREN
,
2041 &child
, &count
) != 0)
2042 return (EZFS_INVALCONFIG
);
2045 * root pool can not have EFI labeled disks and can only have
2046 * a single top-level vdev.
2048 if (strcmp(type
, VDEV_TYPE_ROOT
) != 0 || count
!= 1 ||
2049 pool_uses_efi(vdev_root
))
2050 return (EZFS_POOL_INVALARG
);
2052 (void) vdev_get_physpaths(child
[0], physpath
, phypath_size
, &rsz
,
2055 /* No online devices */
2057 return (EZFS_NODEVICE
);
2063 * Get phys_path for a root pool
2064 * Return 0 on success; non-zero on failure.
2067 zpool_get_physpath(zpool_handle_t
*zhp
, char *physpath
, size_t phypath_size
)
2069 return (zpool_get_config_physpath(zhp
->zpool_config
, physpath
,
2074 * If the device has being dynamically expanded then we need to relabel
2075 * the disk to use the new unallocated space.
2078 zpool_relabel_disk(libzfs_handle_t
*hdl
, const char *path
)
2083 if ((fd
= open(path
, O_RDWR
|O_DIRECT
)) < 0) {
2084 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "cannot "
2085 "relabel '%s': unable to open device"), path
);
2086 return (zfs_error(hdl
, EZFS_OPENFAILED
, errbuf
));
2090 * It's possible that we might encounter an error if the device
2091 * does not have any unallocated space left. If so, we simply
2092 * ignore that error and continue on.
2094 error
= efi_use_whole_disk(fd
);
2096 if (error
&& error
!= VT_ENOSPC
) {
2097 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "cannot "
2098 "relabel '%s': unable to read disk capacity"), path
);
2099 return (zfs_error(hdl
, EZFS_NOCAP
, errbuf
));
2105 * Bring the specified vdev online. The 'flags' parameter is a set of the
2106 * ZFS_ONLINE_* flags.
2109 zpool_vdev_online(zpool_handle_t
*zhp
, const char *path
, int flags
,
2110 vdev_state_t
*newstate
)
2112 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
2115 boolean_t avail_spare
, l2cache
, islog
;
2116 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
2118 if (flags
& ZFS_ONLINE_EXPAND
) {
2119 (void) snprintf(msg
, sizeof (msg
),
2120 dgettext(TEXT_DOMAIN
, "cannot expand %s"), path
);
2122 (void) snprintf(msg
, sizeof (msg
),
2123 dgettext(TEXT_DOMAIN
, "cannot online %s"), path
);
2126 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
2127 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
2129 return (zfs_error(hdl
, EZFS_NODEVICE
, msg
));
2131 verify(nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
, &zc
.zc_guid
) == 0);
2134 return (zfs_error(hdl
, EZFS_ISSPARE
, msg
));
2136 if (flags
& ZFS_ONLINE_EXPAND
||
2137 zpool_get_prop_int(zhp
, ZPOOL_PROP_AUTOEXPAND
, NULL
)) {
2138 char *pathname
= NULL
;
2139 uint64_t wholedisk
= 0;
2141 (void) nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_WHOLE_DISK
,
2143 verify(nvlist_lookup_string(tgt
, ZPOOL_CONFIG_PATH
,
2147 * XXX - L2ARC 1.0 devices can't support expansion.
2150 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2151 "cannot expand cache devices"));
2152 return (zfs_error(hdl
, EZFS_VDEVNOTSUP
, msg
));
2156 pathname
+= strlen(DISK_ROOT
) + 1;
2157 (void) zpool_relabel_disk(hdl
, pathname
);
2161 zc
.zc_cookie
= VDEV_STATE_ONLINE
;
2164 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SET_STATE
, &zc
) != 0) {
2165 if (errno
== EINVAL
) {
2166 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "was split "
2167 "from this pool into a new one. Use '%s' "
2168 "instead"), "zpool detach");
2169 return (zfs_error(hdl
, EZFS_POSTSPLIT_ONLINE
, msg
));
2171 return (zpool_standard_error(hdl
, errno
, msg
));
2174 *newstate
= zc
.zc_cookie
;
2179 * Take the specified vdev offline
2182 zpool_vdev_offline(zpool_handle_t
*zhp
, const char *path
, boolean_t istmp
)
2184 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
2187 boolean_t avail_spare
, l2cache
;
2188 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
2190 (void) snprintf(msg
, sizeof (msg
),
2191 dgettext(TEXT_DOMAIN
, "cannot offline %s"), path
);
2193 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
2194 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
2196 return (zfs_error(hdl
, EZFS_NODEVICE
, msg
));
2198 verify(nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
, &zc
.zc_guid
) == 0);
2201 return (zfs_error(hdl
, EZFS_ISSPARE
, msg
));
2203 zc
.zc_cookie
= VDEV_STATE_OFFLINE
;
2204 zc
.zc_obj
= istmp
? ZFS_OFFLINE_TEMPORARY
: 0;
2206 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SET_STATE
, &zc
) == 0)
2213 * There are no other replicas of this device.
2215 return (zfs_error(hdl
, EZFS_NOREPLICAS
, msg
));
2219 * The log device has unplayed logs
2221 return (zfs_error(hdl
, EZFS_UNPLAYED_LOGS
, msg
));
2224 return (zpool_standard_error(hdl
, errno
, msg
));
2229 * Mark the given vdev faulted.
2232 zpool_vdev_fault(zpool_handle_t
*zhp
, uint64_t guid
, vdev_aux_t aux
)
2234 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
2236 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
2238 (void) snprintf(msg
, sizeof (msg
),
2239 dgettext(TEXT_DOMAIN
, "cannot fault %llu"), (u_longlong_t
)guid
);
2241 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
2243 zc
.zc_cookie
= VDEV_STATE_FAULTED
;
2246 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_VDEV_SET_STATE
, &zc
) == 0)
2253 * There are no other replicas of this device.
2255 return (zfs_error(hdl
, EZFS_NOREPLICAS
, msg
));
2258 return (zpool_standard_error(hdl
, errno
, msg
));
2264 * Mark the given vdev degraded.
2267 zpool_vdev_degrade(zpool_handle_t
*zhp
, uint64_t guid
, vdev_aux_t aux
)
2269 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
2271 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
2273 (void) snprintf(msg
, sizeof (msg
),
2274 dgettext(TEXT_DOMAIN
, "cannot degrade %llu"), (u_longlong_t
)guid
);
2276 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
2278 zc
.zc_cookie
= VDEV_STATE_DEGRADED
;
2281 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_VDEV_SET_STATE
, &zc
) == 0)
2284 return (zpool_standard_error(hdl
, errno
, msg
));
2288 * Returns TRUE if the given nvlist is a vdev that was originally swapped in as
2292 is_replacing_spare(nvlist_t
*search
, nvlist_t
*tgt
, int which
)
2298 if (nvlist_lookup_nvlist_array(search
, ZPOOL_CONFIG_CHILDREN
, &child
,
2300 verify(nvlist_lookup_string(search
, ZPOOL_CONFIG_TYPE
,
2303 if (strcmp(type
, VDEV_TYPE_SPARE
) == 0 &&
2304 children
== 2 && child
[which
] == tgt
)
2307 for (c
= 0; c
< children
; c
++)
2308 if (is_replacing_spare(child
[c
], tgt
, which
))
2316 * Attach new_disk (fully described by nvroot) to old_disk.
2317 * If 'replacing' is specified, the new disk will replace the old one.
2320 zpool_vdev_attach(zpool_handle_t
*zhp
,
2321 const char *old_disk
, const char *new_disk
, nvlist_t
*nvroot
, int replacing
)
2323 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
2327 boolean_t avail_spare
, l2cache
, islog
;
2332 nvlist_t
*config_root
;
2333 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
2334 boolean_t rootpool
= pool_is_bootable(zhp
);
2337 (void) snprintf(msg
, sizeof (msg
), dgettext(TEXT_DOMAIN
,
2338 "cannot replace %s with %s"), old_disk
, new_disk
);
2340 (void) snprintf(msg
, sizeof (msg
), dgettext(TEXT_DOMAIN
,
2341 "cannot attach %s to %s"), new_disk
, old_disk
);
2344 * If this is a root pool, make sure that we're not attaching an
2345 * EFI labeled device.
2347 if (rootpool
&& pool_uses_efi(nvroot
)) {
2348 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2349 "EFI labeled devices are not supported on root pools."));
2350 return (zfs_error(hdl
, EZFS_POOL_NOTSUP
, msg
));
2353 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
2354 if ((tgt
= zpool_find_vdev(zhp
, old_disk
, &avail_spare
, &l2cache
,
2356 return (zfs_error(hdl
, EZFS_NODEVICE
, msg
));
2359 return (zfs_error(hdl
, EZFS_ISSPARE
, msg
));
2362 return (zfs_error(hdl
, EZFS_ISL2CACHE
, msg
));
2364 verify(nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
, &zc
.zc_guid
) == 0);
2365 zc
.zc_cookie
= replacing
;
2367 if (nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_CHILDREN
,
2368 &child
, &children
) != 0 || children
!= 1) {
2369 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2370 "new device must be a single disk"));
2371 return (zfs_error(hdl
, EZFS_INVALCONFIG
, msg
));
2374 verify(nvlist_lookup_nvlist(zpool_get_config(zhp
, NULL
),
2375 ZPOOL_CONFIG_VDEV_TREE
, &config_root
) == 0);
2377 if ((newname
= zpool_vdev_name(NULL
, NULL
, child
[0], B_FALSE
)) == NULL
)
2381 * If the target is a hot spare that has been swapped in, we can only
2382 * replace it with another hot spare.
2385 nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_IS_SPARE
, &val
) == 0 &&
2386 (zpool_find_vdev(zhp
, newname
, &avail_spare
, &l2cache
,
2387 NULL
) == NULL
|| !avail_spare
) &&
2388 is_replacing_spare(config_root
, tgt
, 1)) {
2389 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2390 "can only be replaced by another hot spare"));
2392 return (zfs_error(hdl
, EZFS_BADTARGET
, msg
));
2397 if (zcmd_write_conf_nvlist(hdl
, &zc
, nvroot
) != 0)
2400 ret
= zfs_ioctl(hdl
, ZFS_IOC_VDEV_ATTACH
, &zc
);
2402 zcmd_free_nvlists(&zc
);
2407 * XXX need a better way to prevent user from
2408 * booting up a half-baked vdev.
2410 (void) fprintf(stderr
, dgettext(TEXT_DOMAIN
, "Make "
2411 "sure to wait until resilver is done "
2412 "before rebooting.\n"));
2420 * Can't attach to or replace this type of vdev.
2423 uint64_t version
= zpool_get_prop_int(zhp
,
2424 ZPOOL_PROP_VERSION
, NULL
);
2427 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2428 "cannot replace a log with a spare"));
2429 else if (version
>= SPA_VERSION_MULTI_REPLACE
)
2430 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2431 "already in replacing/spare config; wait "
2432 "for completion or use 'zpool detach'"));
2434 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2435 "cannot replace a replacing device"));
2437 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2438 "can only attach to mirrors and top-level "
2441 (void) zfs_error(hdl
, EZFS_BADTARGET
, msg
);
2446 * The new device must be a single disk.
2448 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2449 "new device must be a single disk"));
2450 (void) zfs_error(hdl
, EZFS_INVALCONFIG
, msg
);
2454 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "%s is busy"),
2456 (void) zfs_error(hdl
, EZFS_BADDEV
, msg
);
2461 * The new device is too small.
2463 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2464 "device is too small"));
2465 (void) zfs_error(hdl
, EZFS_BADDEV
, msg
);
2470 * The new device has a different alignment requirement.
2472 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2473 "devices have different sector alignment"));
2474 (void) zfs_error(hdl
, EZFS_BADDEV
, msg
);
2479 * The resulting top-level vdev spec won't fit in the label.
2481 (void) zfs_error(hdl
, EZFS_DEVOVERFLOW
, msg
);
2485 (void) zpool_standard_error(hdl
, errno
, msg
);
2492 * Detach the specified device.
2495 zpool_vdev_detach(zpool_handle_t
*zhp
, const char *path
)
2497 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
2500 boolean_t avail_spare
, l2cache
;
2501 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
2503 (void) snprintf(msg
, sizeof (msg
),
2504 dgettext(TEXT_DOMAIN
, "cannot detach %s"), path
);
2506 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
2507 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
2509 return (zfs_error(hdl
, EZFS_NODEVICE
, msg
));
2512 return (zfs_error(hdl
, EZFS_ISSPARE
, msg
));
2515 return (zfs_error(hdl
, EZFS_ISL2CACHE
, msg
));
2517 verify(nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
, &zc
.zc_guid
) == 0);
2519 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_DETACH
, &zc
) == 0)
2526 * Can't detach from this type of vdev.
2528 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "only "
2529 "applicable to mirror and replacing vdevs"));
2530 (void) zfs_error(hdl
, EZFS_BADTARGET
, msg
);
2535 * There are no other replicas of this device.
2537 (void) zfs_error(hdl
, EZFS_NOREPLICAS
, msg
);
2541 (void) zpool_standard_error(hdl
, errno
, msg
);
2548 * Find a mirror vdev in the source nvlist.
2550 * The mchild array contains a list of disks in one of the top-level mirrors
2551 * of the source pool. The schild array contains a list of disks that the
2552 * user specified on the command line. We loop over the mchild array to
2553 * see if any entry in the schild array matches.
2555 * If a disk in the mchild array is found in the schild array, we return
2556 * the index of that entry. Otherwise we return -1.
2559 find_vdev_entry(zpool_handle_t
*zhp
, nvlist_t
**mchild
, uint_t mchildren
,
2560 nvlist_t
**schild
, uint_t schildren
)
2564 for (mc
= 0; mc
< mchildren
; mc
++) {
2566 char *mpath
= zpool_vdev_name(zhp
->zpool_hdl
, zhp
,
2567 mchild
[mc
], B_FALSE
);
2569 for (sc
= 0; sc
< schildren
; sc
++) {
2570 char *spath
= zpool_vdev_name(zhp
->zpool_hdl
, zhp
,
2571 schild
[sc
], B_FALSE
);
2572 boolean_t result
= (strcmp(mpath
, spath
) == 0);
2588 * Split a mirror pool. If newroot points to null, then a new nvlist
2589 * is generated and it is the responsibility of the caller to free it.
2592 zpool_vdev_split(zpool_handle_t
*zhp
, char *newname
, nvlist_t
**newroot
,
2593 nvlist_t
*props
, splitflags_t flags
)
2595 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
2597 nvlist_t
*tree
, *config
, **child
, **newchild
, *newconfig
= NULL
;
2598 nvlist_t
**varray
= NULL
, *zc_props
= NULL
;
2599 uint_t c
, children
, newchildren
, lastlog
= 0, vcount
, found
= 0;
2600 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
2602 boolean_t freelist
= B_FALSE
, memory_err
= B_TRUE
;
2605 (void) snprintf(msg
, sizeof (msg
),
2606 dgettext(TEXT_DOMAIN
, "Unable to split %s"), zhp
->zpool_name
);
2608 if (!zpool_name_valid(hdl
, B_FALSE
, newname
))
2609 return (zfs_error(hdl
, EZFS_INVALIDNAME
, msg
));
2611 if ((config
= zpool_get_config(zhp
, NULL
)) == NULL
) {
2612 (void) fprintf(stderr
, gettext("Internal error: unable to "
2613 "retrieve pool configuration\n"));
2617 verify(nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
, &tree
)
2619 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_VERSION
, &vers
) == 0);
2622 prop_flags_t flags
= { .create
= B_FALSE
, .import
= B_TRUE
};
2623 if ((zc_props
= zpool_valid_proplist(hdl
, zhp
->zpool_name
,
2624 props
, vers
, flags
, msg
)) == NULL
)
2628 if (nvlist_lookup_nvlist_array(tree
, ZPOOL_CONFIG_CHILDREN
, &child
,
2630 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2631 "Source pool is missing vdev tree"));
2633 nvlist_free(zc_props
);
2637 varray
= zfs_alloc(hdl
, children
* sizeof (nvlist_t
*));
2640 if (*newroot
== NULL
||
2641 nvlist_lookup_nvlist_array(*newroot
, ZPOOL_CONFIG_CHILDREN
,
2642 &newchild
, &newchildren
) != 0)
2645 for (c
= 0; c
< children
; c
++) {
2646 uint64_t is_log
= B_FALSE
, is_hole
= B_FALSE
;
2648 nvlist_t
**mchild
, *vdev
;
2653 * Unlike cache & spares, slogs are stored in the
2654 * ZPOOL_CONFIG_CHILDREN array. We filter them out here.
2656 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_LOG
,
2658 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_HOLE
,
2660 if (is_log
|| is_hole
) {
2662 * Create a hole vdev and put it in the config.
2664 if (nvlist_alloc(&vdev
, NV_UNIQUE_NAME
, 0) != 0)
2666 if (nvlist_add_string(vdev
, ZPOOL_CONFIG_TYPE
,
2667 VDEV_TYPE_HOLE
) != 0)
2669 if (nvlist_add_uint64(vdev
, ZPOOL_CONFIG_IS_HOLE
,
2674 varray
[vcount
++] = vdev
;
2678 verify(nvlist_lookup_string(child
[c
], ZPOOL_CONFIG_TYPE
, &type
)
2680 if (strcmp(type
, VDEV_TYPE_MIRROR
) != 0) {
2681 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2682 "Source pool must be composed only of mirrors\n"));
2683 retval
= zfs_error(hdl
, EZFS_INVALCONFIG
, msg
);
2687 verify(nvlist_lookup_nvlist_array(child
[c
],
2688 ZPOOL_CONFIG_CHILDREN
, &mchild
, &mchildren
) == 0);
2690 /* find or add an entry for this top-level vdev */
2691 if (newchildren
> 0 &&
2692 (entry
= find_vdev_entry(zhp
, mchild
, mchildren
,
2693 newchild
, newchildren
)) >= 0) {
2694 /* We found a disk that the user specified. */
2695 vdev
= mchild
[entry
];
2698 /* User didn't specify a disk for this vdev. */
2699 vdev
= mchild
[mchildren
- 1];
2702 if (nvlist_dup(vdev
, &varray
[vcount
++], 0) != 0)
2706 /* did we find every disk the user specified? */
2707 if (found
!= newchildren
) {
2708 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "Device list must "
2709 "include at most one disk from each mirror"));
2710 retval
= zfs_error(hdl
, EZFS_INVALCONFIG
, msg
);
2714 /* Prepare the nvlist for populating. */
2715 if (*newroot
== NULL
) {
2716 if (nvlist_alloc(newroot
, NV_UNIQUE_NAME
, 0) != 0)
2719 if (nvlist_add_string(*newroot
, ZPOOL_CONFIG_TYPE
,
2720 VDEV_TYPE_ROOT
) != 0)
2723 verify(nvlist_remove_all(*newroot
, ZPOOL_CONFIG_CHILDREN
) == 0);
2726 /* Add all the children we found */
2727 if (nvlist_add_nvlist_array(*newroot
, ZPOOL_CONFIG_CHILDREN
, varray
,
2728 lastlog
== 0 ? vcount
: lastlog
) != 0)
2732 * If we're just doing a dry run, exit now with success.
2735 memory_err
= B_FALSE
;
2740 /* now build up the config list & call the ioctl */
2741 if (nvlist_alloc(&newconfig
, NV_UNIQUE_NAME
, 0) != 0)
2744 if (nvlist_add_nvlist(newconfig
,
2745 ZPOOL_CONFIG_VDEV_TREE
, *newroot
) != 0 ||
2746 nvlist_add_string(newconfig
,
2747 ZPOOL_CONFIG_POOL_NAME
, newname
) != 0 ||
2748 nvlist_add_uint64(newconfig
, ZPOOL_CONFIG_VERSION
, vers
) != 0)
2752 * The new pool is automatically part of the namespace unless we
2753 * explicitly export it.
2756 zc
.zc_cookie
= ZPOOL_EXPORT_AFTER_SPLIT
;
2757 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
2758 (void) strlcpy(zc
.zc_string
, newname
, sizeof (zc
.zc_string
));
2759 if (zcmd_write_conf_nvlist(hdl
, &zc
, newconfig
) != 0)
2761 if (zc_props
!= NULL
&& zcmd_write_src_nvlist(hdl
, &zc
, zc_props
) != 0)
2764 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_SPLIT
, &zc
) != 0) {
2765 retval
= zpool_standard_error(hdl
, errno
, msg
);
2770 memory_err
= B_FALSE
;
2773 if (varray
!= NULL
) {
2776 for (v
= 0; v
< vcount
; v
++)
2777 nvlist_free(varray
[v
]);
2780 zcmd_free_nvlists(&zc
);
2782 nvlist_free(zc_props
);
2784 nvlist_free(newconfig
);
2786 nvlist_free(*newroot
);
2794 return (no_memory(hdl
));
2800 * Remove the given device. Currently, this is supported only for hot spares
2801 * and level 2 cache devices.
2804 zpool_vdev_remove(zpool_handle_t
*zhp
, const char *path
)
2806 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
2809 boolean_t avail_spare
, l2cache
, islog
;
2810 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
2813 (void) snprintf(msg
, sizeof (msg
),
2814 dgettext(TEXT_DOMAIN
, "cannot remove %s"), path
);
2816 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
2817 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
, &l2cache
,
2819 return (zfs_error(hdl
, EZFS_NODEVICE
, msg
));
2821 * XXX - this should just go away.
2823 if (!avail_spare
&& !l2cache
&& !islog
) {
2824 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2825 "only inactive hot spares, cache, top-level, "
2826 "or log devices can be removed"));
2827 return (zfs_error(hdl
, EZFS_NODEVICE
, msg
));
2830 version
= zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
);
2831 if (islog
&& version
< SPA_VERSION_HOLES
) {
2832 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
2833 "pool must be upgrade to support log removal"));
2834 return (zfs_error(hdl
, EZFS_BADVERSION
, msg
));
2837 verify(nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
, &zc
.zc_guid
) == 0);
2839 if (zfs_ioctl(hdl
, ZFS_IOC_VDEV_REMOVE
, &zc
) == 0)
2842 return (zpool_standard_error(hdl
, errno
, msg
));
2846 * Clear the errors for the pool, or the particular device if specified.
2849 zpool_clear(zpool_handle_t
*zhp
, const char *path
, nvlist_t
*rewindnvl
)
2851 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
2854 zpool_rewind_policy_t policy
;
2855 boolean_t avail_spare
, l2cache
;
2856 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
2857 nvlist_t
*nvi
= NULL
;
2861 (void) snprintf(msg
, sizeof (msg
),
2862 dgettext(TEXT_DOMAIN
, "cannot clear errors for %s"),
2865 (void) snprintf(msg
, sizeof (msg
),
2866 dgettext(TEXT_DOMAIN
, "cannot clear errors for %s"),
2869 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
2871 if ((tgt
= zpool_find_vdev(zhp
, path
, &avail_spare
,
2872 &l2cache
, NULL
)) == 0)
2873 return (zfs_error(hdl
, EZFS_NODEVICE
, msg
));
2876 * Don't allow error clearing for hot spares. Do allow
2877 * error clearing for l2cache devices.
2880 return (zfs_error(hdl
, EZFS_ISSPARE
, msg
));
2882 verify(nvlist_lookup_uint64(tgt
, ZPOOL_CONFIG_GUID
,
2886 zpool_get_rewind_policy(rewindnvl
, &policy
);
2887 zc
.zc_cookie
= policy
.zrp_request
;
2889 if (zcmd_alloc_dst_nvlist(hdl
, &zc
, zhp
->zpool_config_size
* 2) != 0)
2892 if (zcmd_write_src_nvlist(hdl
, &zc
, rewindnvl
) != 0)
2895 while ((error
= zfs_ioctl(hdl
, ZFS_IOC_CLEAR
, &zc
)) != 0 &&
2897 if (zcmd_expand_dst_nvlist(hdl
, &zc
) != 0) {
2898 zcmd_free_nvlists(&zc
);
2903 if (!error
|| ((policy
.zrp_request
& ZPOOL_TRY_REWIND
) &&
2904 errno
!= EPERM
&& errno
!= EACCES
)) {
2905 if (policy
.zrp_request
&
2906 (ZPOOL_DO_REWIND
| ZPOOL_TRY_REWIND
)) {
2907 (void) zcmd_read_dst_nvlist(hdl
, &zc
, &nvi
);
2908 zpool_rewind_exclaim(hdl
, zc
.zc_name
,
2909 ((policy
.zrp_request
& ZPOOL_TRY_REWIND
) != 0),
2913 zcmd_free_nvlists(&zc
);
2917 zcmd_free_nvlists(&zc
);
2918 return (zpool_standard_error(hdl
, errno
, msg
));
2922 * Similar to zpool_clear(), but takes a GUID (used by fmd).
2925 zpool_vdev_clear(zpool_handle_t
*zhp
, uint64_t guid
)
2927 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
2929 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
2931 (void) snprintf(msg
, sizeof (msg
),
2932 dgettext(TEXT_DOMAIN
, "cannot clear errors for %llx"),
2933 (u_longlong_t
)guid
);
2935 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
2937 zc
.zc_cookie
= ZPOOL_NO_REWIND
;
2939 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_CLEAR
, &zc
) == 0)
2942 return (zpool_standard_error(hdl
, errno
, msg
));
2946 * Convert from a devid string to a path.
2949 devid_to_path(char *devid_str
)
2954 devid_nmlist_t
*list
= NULL
;
2957 if (devid_str_decode(devid_str
, &devid
, &minor
) != 0)
2960 ret
= devid_deviceid_to_nmlist("/dev", devid
, minor
, &list
);
2962 devid_str_free(minor
);
2968 if ((path
= strdup(list
[0].devname
)) == NULL
)
2971 devid_free_nmlist(list
);
2977 * Convert from a path to a devid string.
2980 path_to_devid(const char *path
)
2986 if ((fd
= open(path
, O_RDONLY
)) < 0)
2991 if (devid_get(fd
, &devid
) == 0) {
2992 if (devid_get_minor_name(fd
, &minor
) == 0)
2993 ret
= devid_str_encode(devid
, minor
);
2995 devid_str_free(minor
);
3004 * Issue the necessary ioctl() to update the stored path value for the vdev. We
3005 * ignore any failure here, since a common case is for an unprivileged user to
3006 * type 'zpool status', and we'll display the correct information anyway.
3009 set_path(zpool_handle_t
*zhp
, nvlist_t
*nv
, const char *path
)
3011 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
3013 (void) strncpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3014 (void) strncpy(zc
.zc_value
, path
, sizeof (zc
.zc_value
));
3015 verify(nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_GUID
,
3018 (void) ioctl(zhp
->zpool_hdl
->libzfs_fd
, ZFS_IOC_VDEV_SETPATH
, &zc
);
3022 * Remove partition suffix from a vdev path. Partition suffixes may take three
3023 * forms: "-partX", "pX", or "X", where X is a string of digits. The second
3024 * case only occurs when the suffix is preceded by a digit, i.e. "md0p0" The
3025 * third case only occurs when preceded by a string matching the regular
3026 * expression "^[hs]d[a-z]+", i.e. a scsi or ide disk.
3029 strip_partition(libzfs_handle_t
*hdl
, char *path
)
3031 char *tmp
= zfs_strdup(hdl
, path
);
3032 char *part
= NULL
, *d
= NULL
;
3034 if ((part
= strstr(tmp
, "-part")) && part
!= tmp
) {
3036 } else if ((part
= strrchr(tmp
, 'p')) &&
3037 part
> tmp
+ 1 && isdigit(*(part
-1))) {
3039 } else if ((tmp
[0] == 'h' || tmp
[0] == 's') && tmp
[1] == 'd') {
3040 for (d
= &tmp
[2]; isalpha(*d
); part
= ++d
);
3042 if (part
&& d
&& *d
!= '\0') {
3043 for (; isdigit(*d
); d
++);
3050 #define PATH_BUF_LEN 64
3053 * Given a vdev, return the name to display in iostat. If the vdev has a path,
3054 * we use that, stripping off any leading "/dev/dsk/"; if not, we use the type.
3055 * We also check if this is a whole disk, in which case we strip off the
3056 * trailing 's0' slice name.
3058 * This routine is also responsible for identifying when disks have been
3059 * reconfigured in a new location. The kernel will have opened the device by
3060 * devid, but the path will still refer to the old location. To catch this, we
3061 * first do a path -> devid translation (which is fast for the common case). If
3062 * the devid matches, we're done. If not, we do a reverse devid -> path
3063 * translation and issue the appropriate ioctl() to update the path of the vdev.
3064 * If 'zhp' is NULL, then this is an exported pool, and we don't need to do any
3068 zpool_vdev_name(libzfs_handle_t
*hdl
, zpool_handle_t
*zhp
, nvlist_t
*nv
,
3071 char *path
, *devid
, *type
;
3073 char buf
[PATH_BUF_LEN
];
3077 if (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_NOT_PRESENT
,
3079 verify(nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_GUID
,
3081 (void) snprintf(buf
, sizeof (buf
), "%llu",
3082 (u_longlong_t
)value
);
3084 } else if (nvlist_lookup_string(nv
, ZPOOL_CONFIG_PATH
, &path
) == 0) {
3086 * If the device is dead (faulted, offline, etc) then don't
3087 * bother opening it. Otherwise we may be forcing the user to
3088 * open a misbehaving device, which can have undesirable
3091 if ((nvlist_lookup_uint64_array(nv
, ZPOOL_CONFIG_VDEV_STATS
,
3092 (uint64_t **)&vs
, &vsc
) != 0 ||
3093 vs
->vs_state
>= VDEV_STATE_DEGRADED
) &&
3095 nvlist_lookup_string(nv
, ZPOOL_CONFIG_DEVID
, &devid
) == 0) {
3097 * Determine if the current path is correct.
3099 char *newdevid
= path_to_devid(path
);
3101 if (newdevid
== NULL
||
3102 strcmp(devid
, newdevid
) != 0) {
3105 if ((newpath
= devid_to_path(devid
)) != NULL
) {
3107 * Update the path appropriately.
3109 set_path(zhp
, nv
, newpath
);
3110 if (nvlist_add_string(nv
,
3111 ZPOOL_CONFIG_PATH
, newpath
) == 0)
3112 verify(nvlist_lookup_string(nv
,
3120 devid_str_free(newdevid
);
3124 * For a block device only use the name.
3126 verify(nvlist_lookup_string(nv
, ZPOOL_CONFIG_TYPE
, &type
) == 0);
3127 if (strcmp(type
, VDEV_TYPE_DISK
) == 0) {
3128 path
= strrchr(path
, '/');
3133 * Remove the partition from the path it this is a whole disk.
3135 if (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_WHOLE_DISK
,
3136 &value
) == 0 && value
) {
3137 return strip_partition(hdl
, path
);
3140 verify(nvlist_lookup_string(nv
, ZPOOL_CONFIG_TYPE
, &path
) == 0);
3143 * If it's a raidz device, we need to stick in the parity level.
3145 if (strcmp(path
, VDEV_TYPE_RAIDZ
) == 0) {
3146 char tmpbuf
[PATH_BUF_LEN
];
3148 verify(nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_NPARITY
,
3150 (void) snprintf(tmpbuf
, sizeof (tmpbuf
), "%s%llu", path
,
3151 (u_longlong_t
)value
);
3156 * We identify each top-level vdev by using a <type-id>
3157 * naming convention.
3162 verify(nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_ID
,
3164 (void) snprintf(buf
, sizeof (buf
), "%s-%llu", path
,
3170 return (zfs_strdup(hdl
, path
));
3174 zbookmark_compare(const void *a
, const void *b
)
3176 return (memcmp(a
, b
, sizeof (zbookmark_t
)));
3180 * Retrieve the persistent error log, uniquify the members, and return to the
3184 zpool_get_errlog(zpool_handle_t
*zhp
, nvlist_t
**nverrlistp
)
3186 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
3188 zbookmark_t
*zb
= NULL
;
3192 * Retrieve the raw error list from the kernel. If the number of errors
3193 * has increased, allocate more space and continue until we get the
3196 verify(nvlist_lookup_uint64(zhp
->zpool_config
, ZPOOL_CONFIG_ERRCOUNT
,
3200 if ((zc
.zc_nvlist_dst
= (uintptr_t)zfs_alloc(zhp
->zpool_hdl
,
3201 count
* sizeof (zbookmark_t
))) == (uintptr_t)NULL
)
3203 zc
.zc_nvlist_dst_size
= count
;
3204 (void) strcpy(zc
.zc_name
, zhp
->zpool_name
);
3206 if (ioctl(zhp
->zpool_hdl
->libzfs_fd
, ZFS_IOC_ERROR_LOG
,
3208 free((void *)(uintptr_t)zc
.zc_nvlist_dst
);
3209 if (errno
== ENOMEM
) {
3210 count
= zc
.zc_nvlist_dst_size
;
3211 if ((zc
.zc_nvlist_dst
= (uintptr_t)
3212 zfs_alloc(zhp
->zpool_hdl
, count
*
3213 sizeof (zbookmark_t
))) == (uintptr_t)NULL
)
3224 * Sort the resulting bookmarks. This is a little confusing due to the
3225 * implementation of ZFS_IOC_ERROR_LOG. The bookmarks are copied last
3226 * to first, and 'zc_nvlist_dst_size' indicates the number of boomarks
3227 * _not_ copied as part of the process. So we point the start of our
3228 * array appropriate and decrement the total number of elements.
3230 zb
= ((zbookmark_t
*)(uintptr_t)zc
.zc_nvlist_dst
) +
3231 zc
.zc_nvlist_dst_size
;
3232 count
-= zc
.zc_nvlist_dst_size
;
3234 qsort(zb
, count
, sizeof (zbookmark_t
), zbookmark_compare
);
3236 verify(nvlist_alloc(nverrlistp
, 0, KM_SLEEP
) == 0);
3239 * Fill in the nverrlistp with nvlist's of dataset and object numbers.
3241 for (i
= 0; i
< count
; i
++) {
3244 /* ignoring zb_blkid and zb_level for now */
3245 if (i
> 0 && zb
[i
-1].zb_objset
== zb
[i
].zb_objset
&&
3246 zb
[i
-1].zb_object
== zb
[i
].zb_object
)
3249 if (nvlist_alloc(&nv
, NV_UNIQUE_NAME
, KM_SLEEP
) != 0)
3251 if (nvlist_add_uint64(nv
, ZPOOL_ERR_DATASET
,
3252 zb
[i
].zb_objset
) != 0) {
3256 if (nvlist_add_uint64(nv
, ZPOOL_ERR_OBJECT
,
3257 zb
[i
].zb_object
) != 0) {
3261 if (nvlist_add_nvlist(*nverrlistp
, "ejk", nv
) != 0) {
3268 free((void *)(uintptr_t)zc
.zc_nvlist_dst
);
3272 free((void *)(uintptr_t)zc
.zc_nvlist_dst
);
3273 return (no_memory(zhp
->zpool_hdl
));
3277 * Upgrade a ZFS pool to the latest on-disk version.
3280 zpool_upgrade(zpool_handle_t
*zhp
, uint64_t new_version
)
3282 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
3283 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3285 (void) strcpy(zc
.zc_name
, zhp
->zpool_name
);
3286 zc
.zc_cookie
= new_version
;
3288 if (zfs_ioctl(hdl
, ZFS_IOC_POOL_UPGRADE
, &zc
) != 0)
3289 return (zpool_standard_error_fmt(hdl
, errno
,
3290 dgettext(TEXT_DOMAIN
, "cannot upgrade '%s'"),
3296 zpool_set_history_str(const char *subcommand
, int argc
, char **argv
,
3301 (void) strlcpy(history_str
, subcommand
, HIS_MAX_RECORD_LEN
);
3302 for (i
= 1; i
< argc
; i
++) {
3303 if (strlen(history_str
) + 1 + strlen(argv
[i
]) >
3306 (void) strlcat(history_str
, " ", HIS_MAX_RECORD_LEN
);
3307 (void) strlcat(history_str
, argv
[i
], HIS_MAX_RECORD_LEN
);
3312 * Stage command history for logging.
3315 zpool_stage_history(libzfs_handle_t
*hdl
, const char *history_str
)
3317 if (history_str
== NULL
)
3320 if (strlen(history_str
) > HIS_MAX_RECORD_LEN
)
3323 if (hdl
->libzfs_log_str
!= NULL
)
3324 free(hdl
->libzfs_log_str
);
3326 if ((hdl
->libzfs_log_str
= strdup(history_str
)) == NULL
)
3327 return (no_memory(hdl
));
3333 * Perform ioctl to get some command history of a pool.
3335 * 'buf' is the buffer to fill up to 'len' bytes. 'off' is the
3336 * logical offset of the history buffer to start reading from.
3338 * Upon return, 'off' is the next logical offset to read from and
3339 * 'len' is the actual amount of bytes read into 'buf'.
3342 get_history(zpool_handle_t
*zhp
, char *buf
, uint64_t *off
, uint64_t *len
)
3344 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
3345 libzfs_handle_t
*hdl
= zhp
->zpool_hdl
;
3347 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3349 zc
.zc_history
= (uint64_t)(uintptr_t)buf
;
3350 zc
.zc_history_len
= *len
;
3351 zc
.zc_history_offset
= *off
;
3353 if (ioctl(hdl
->libzfs_fd
, ZFS_IOC_POOL_GET_HISTORY
, &zc
) != 0) {
3356 return (zfs_error_fmt(hdl
, EZFS_PERM
,
3357 dgettext(TEXT_DOMAIN
,
3358 "cannot show history for pool '%s'"),
3361 return (zfs_error_fmt(hdl
, EZFS_NOHISTORY
,
3362 dgettext(TEXT_DOMAIN
, "cannot get history for pool "
3363 "'%s'"), zhp
->zpool_name
));
3365 return (zfs_error_fmt(hdl
, EZFS_BADVERSION
,
3366 dgettext(TEXT_DOMAIN
, "cannot get history for pool "
3367 "'%s', pool must be upgraded"), zhp
->zpool_name
));
3369 return (zpool_standard_error_fmt(hdl
, errno
,
3370 dgettext(TEXT_DOMAIN
,
3371 "cannot get history for '%s'"), zhp
->zpool_name
));
3375 *len
= zc
.zc_history_len
;
3376 *off
= zc
.zc_history_offset
;
3382 * Process the buffer of nvlists, unpacking and storing each nvlist record
3383 * into 'records'. 'leftover' is set to the number of bytes that weren't
3384 * processed as there wasn't a complete record.
3387 zpool_history_unpack(char *buf
, uint64_t bytes_read
, uint64_t *leftover
,
3388 nvlist_t
***records
, uint_t
*numrecords
)
3394 while (bytes_read
> sizeof (reclen
)) {
3396 /* get length of packed record (stored as little endian) */
3397 for (i
= 0, reclen
= 0; i
< sizeof (reclen
); i
++)
3398 reclen
+= (uint64_t)(((uchar_t
*)buf
)[i
]) << (8*i
);
3400 if (bytes_read
< sizeof (reclen
) + reclen
)
3404 if (nvlist_unpack(buf
+ sizeof (reclen
), reclen
, &nv
, 0) != 0)
3406 bytes_read
-= sizeof (reclen
) + reclen
;
3407 buf
+= sizeof (reclen
) + reclen
;
3409 /* add record to nvlist array */
3411 if (ISP2(*numrecords
+ 1)) {
3412 *records
= realloc(*records
,
3413 *numrecords
* 2 * sizeof (nvlist_t
*));
3415 (*records
)[*numrecords
- 1] = nv
;
3418 *leftover
= bytes_read
;
3422 #define HIS_BUF_LEN (128*1024)
3425 * Retrieve the command history of a pool.
3428 zpool_get_history(zpool_handle_t
*zhp
, nvlist_t
**nvhisp
)
3430 char buf
[HIS_BUF_LEN
];
3432 nvlist_t
**records
= NULL
;
3433 uint_t numrecords
= 0;
3437 uint64_t bytes_read
= sizeof (buf
);
3440 if ((err
= get_history(zhp
, buf
, &off
, &bytes_read
)) != 0)
3443 /* if nothing else was read in, we're at EOF, just return */
3447 if ((err
= zpool_history_unpack(buf
, bytes_read
,
3448 &leftover
, &records
, &numrecords
)) != 0)
3456 verify(nvlist_alloc(nvhisp
, NV_UNIQUE_NAME
, 0) == 0);
3457 verify(nvlist_add_nvlist_array(*nvhisp
, ZPOOL_HIST_RECORD
,
3458 records
, numrecords
) == 0);
3460 for (i
= 0; i
< numrecords
; i
++)
3461 nvlist_free(records
[i
]);
3468 * Retrieve the next event. If there is a new event available 'nvp' will
3469 * contain a newly allocated nvlist and 'dropped' will be set to the number
3470 * of missed events since the last call to this function. When 'nvp' is
3471 * set to NULL it indicates no new events are available. In either case
3472 * the function returns 0 and it is up to the caller to free 'nvp'. In
3473 * the case of a fatal error the function will return a non-zero value.
3474 * When the function is called in blocking mode it will not return until
3475 * a new event is available.
3478 zpool_events_next(libzfs_handle_t
*hdl
, nvlist_t
**nvp
,
3479 int *dropped
, int block
, int cleanup_fd
)
3481 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
3486 zc
.zc_cleanup_fd
= cleanup_fd
;
3489 zc
.zc_guid
= ZEVENT_NONBLOCK
;
3491 if (zcmd_alloc_dst_nvlist(hdl
, &zc
, ZEVENT_SIZE
) != 0)
3495 if (zfs_ioctl(hdl
, ZFS_IOC_EVENTS_NEXT
, &zc
) != 0) {
3498 error
= zfs_error_fmt(hdl
, EZFS_POOLUNAVAIL
,
3499 dgettext(TEXT_DOMAIN
, "zfs shutdown"));
3502 /* Blocking error case should not occur */
3504 error
= zpool_standard_error_fmt(hdl
, errno
,
3505 dgettext(TEXT_DOMAIN
, "cannot get event"));
3509 if (zcmd_expand_dst_nvlist(hdl
, &zc
) != 0) {
3510 error
= zfs_error_fmt(hdl
, EZFS_NOMEM
,
3511 dgettext(TEXT_DOMAIN
, "cannot get event"));
3517 error
= zpool_standard_error_fmt(hdl
, errno
,
3518 dgettext(TEXT_DOMAIN
, "cannot get event"));
3523 error
= zcmd_read_dst_nvlist(hdl
, &zc
, nvp
);
3527 *dropped
= (int)zc
.zc_cookie
;
3529 zcmd_free_nvlists(&zc
);
3538 zpool_events_clear(libzfs_handle_t
*hdl
, int *count
)
3540 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
3543 (void) snprintf(msg
, sizeof (msg
), dgettext(TEXT_DOMAIN
,
3544 "cannot clear events"));
3546 if (zfs_ioctl(hdl
, ZFS_IOC_EVENTS_CLEAR
, &zc
) != 0)
3547 return (zpool_standard_error_fmt(hdl
, errno
, msg
));
3550 *count
= (int)zc
.zc_cookie
; /* # of events cleared */
3556 zpool_obj_to_path(zpool_handle_t
*zhp
, uint64_t dsobj
, uint64_t obj
,
3557 char *pathname
, size_t len
)
3559 zfs_cmd_t zc
= { "\0", "\0", "\0", "\0", 0 };
3560 boolean_t mounted
= B_FALSE
;
3561 char *mntpnt
= NULL
;
3562 char dsname
[MAXNAMELEN
];
3565 /* special case for the MOS */
3566 (void) snprintf(pathname
, len
, "<metadata>:<0x%llx>", (longlong_t
)obj
);
3570 /* get the dataset's name */
3571 (void) strlcpy(zc
.zc_name
, zhp
->zpool_name
, sizeof (zc
.zc_name
));
3573 if (ioctl(zhp
->zpool_hdl
->libzfs_fd
,
3574 ZFS_IOC_DSOBJ_TO_DSNAME
, &zc
) != 0) {
3575 /* just write out a path of two object numbers */
3576 (void) snprintf(pathname
, len
, "<0x%llx>:<0x%llx>",
3577 (longlong_t
)dsobj
, (longlong_t
)obj
);
3580 (void) strlcpy(dsname
, zc
.zc_value
, sizeof (dsname
));
3582 /* find out if the dataset is mounted */
3583 mounted
= is_mounted(zhp
->zpool_hdl
, dsname
, &mntpnt
);
3585 /* get the corrupted object's path */
3586 (void) strlcpy(zc
.zc_name
, dsname
, sizeof (zc
.zc_name
));
3588 if (ioctl(zhp
->zpool_hdl
->libzfs_fd
, ZFS_IOC_OBJ_TO_PATH
,
3591 (void) snprintf(pathname
, len
, "%s%s", mntpnt
,
3594 (void) snprintf(pathname
, len
, "%s:%s",
3595 dsname
, zc
.zc_value
);
3598 (void) snprintf(pathname
, len
, "%s:<0x%llx>", dsname
, (longlong_t
)obj
);
3604 * Read the EFI label from the config, if a label does not exist then
3605 * pass back the error to the caller. If the caller has passed a non-NULL
3606 * diskaddr argument then we set it to the starting address of the EFI
3610 read_efi_label(nvlist_t
*config
, diskaddr_t
*sb
)
3614 char diskname
[MAXPATHLEN
];
3617 if (nvlist_lookup_string(config
, ZPOOL_CONFIG_PATH
, &path
) != 0)
3620 (void) snprintf(diskname
, sizeof (diskname
), "%s%s", RDISK_ROOT
,
3621 strrchr(path
, '/'));
3622 if ((fd
= open(diskname
, O_RDWR
|O_DIRECT
)) >= 0) {
3623 struct dk_gpt
*vtoc
;
3625 if ((err
= efi_alloc_and_read(fd
, &vtoc
)) >= 0) {
3627 *sb
= vtoc
->efi_parts
[0].p_start
;
3636 * determine where a partition starts on a disk in the current
3640 find_start_block(nvlist_t
*config
)
3644 diskaddr_t sb
= MAXOFFSET_T
;
3647 if (nvlist_lookup_nvlist_array(config
,
3648 ZPOOL_CONFIG_CHILDREN
, &child
, &children
) != 0) {
3649 if (nvlist_lookup_uint64(config
,
3650 ZPOOL_CONFIG_WHOLE_DISK
,
3651 &wholedisk
) != 0 || !wholedisk
) {
3652 return (MAXOFFSET_T
);
3654 if (read_efi_label(config
, &sb
) < 0)
3659 for (c
= 0; c
< children
; c
++) {
3660 sb
= find_start_block(child
[c
]);
3661 if (sb
!= MAXOFFSET_T
) {
3665 return (MAXOFFSET_T
);
3669 zpool_label_disk_wait(char *path
, int timeout
)
3671 struct stat64 statbuf
;
3675 * Wait timeout miliseconds for a newly created device to be available
3676 * from the given path. There is a small window when a /dev/ device
3677 * will exist and the udev link will not, so we must wait for the
3678 * symlink. Depending on the udev rules this may take a few seconds.
3680 for (i
= 0; i
< timeout
; i
++) {
3684 if ((stat64(path
, &statbuf
) == 0) && (errno
== 0))
3692 zpool_label_disk_check(char *path
)
3694 struct dk_gpt
*vtoc
;
3697 if ((fd
= open(path
, O_RDWR
|O_DIRECT
)) < 0)
3700 if ((err
= efi_alloc_and_read(fd
, &vtoc
)) != 0) {
3705 if (vtoc
->efi_flags
& EFI_GPT_PRIMARY_CORRUPT
) {
3717 * Label an individual disk. The name provided is the short name,
3718 * stripped of any leading /dev path.
3721 zpool_label_disk(libzfs_handle_t
*hdl
, zpool_handle_t
*zhp
, char *name
)
3723 char path
[MAXPATHLEN
];
3724 struct dk_gpt
*vtoc
;
3726 size_t resv
= EFI_MIN_RESV_SIZE
;
3727 uint64_t slice_size
;
3728 diskaddr_t start_block
;
3731 /* prepare an error message just in case */
3732 (void) snprintf(errbuf
, sizeof (errbuf
),
3733 dgettext(TEXT_DOMAIN
, "cannot label '%s'"), name
);
3738 if (pool_is_bootable(zhp
)) {
3739 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3740 "EFI labeled devices are not supported on root "
3742 return (zfs_error(hdl
, EZFS_POOL_NOTSUP
, errbuf
));
3745 verify(nvlist_lookup_nvlist(zhp
->zpool_config
,
3746 ZPOOL_CONFIG_VDEV_TREE
, &nvroot
) == 0);
3748 if (zhp
->zpool_start_block
== 0)
3749 start_block
= find_start_block(nvroot
);
3751 start_block
= zhp
->zpool_start_block
;
3752 zhp
->zpool_start_block
= start_block
;
3755 start_block
= NEW_START_BLOCK
;
3758 (void) snprintf(path
, sizeof (path
), "%s/%s%s", RDISK_ROOT
, name
,
3761 if ((fd
= open(path
, O_RDWR
|O_DIRECT
)) < 0) {
3763 * This shouldn't happen. We've long since verified that this
3764 * is a valid device.
3766 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3767 "unable to open device '%s': %d"), path
, errno
);
3768 return (zfs_error(hdl
, EZFS_OPENFAILED
, errbuf
));
3771 if (efi_alloc_and_init(fd
, EFI_NUMPAR
, &vtoc
) != 0) {
3773 * The only way this can fail is if we run out of memory, or we
3774 * were unable to read the disk's capacity
3776 if (errno
== ENOMEM
)
3777 (void) no_memory(hdl
);
3780 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
,
3781 "unable to read disk capacity"), name
);
3783 return (zfs_error(hdl
, EZFS_NOCAP
, errbuf
));
3786 slice_size
= vtoc
->efi_last_u_lba
+ 1;
3787 slice_size
-= EFI_MIN_RESV_SIZE
;
3788 if (start_block
== MAXOFFSET_T
)
3789 start_block
= NEW_START_BLOCK
;
3790 slice_size
-= start_block
;
3791 slice_size
= P2ALIGN(slice_size
, PARTITION_END_ALIGNMENT
);
3793 vtoc
->efi_parts
[0].p_start
= start_block
;
3794 vtoc
->efi_parts
[0].p_size
= slice_size
;
3797 * Why we use V_USR: V_BACKUP confuses users, and is considered
3798 * disposable by some EFI utilities (since EFI doesn't have a backup
3799 * slice). V_UNASSIGNED is supposed to be used only for zero size
3800 * partitions, and efi_write() will fail if we use it. V_ROOT, V_BOOT,
3801 * etc. were all pretty specific. V_USR is as close to reality as we
3802 * can get, in the absence of V_OTHER.
3804 vtoc
->efi_parts
[0].p_tag
= V_USR
;
3805 (void) strcpy(vtoc
->efi_parts
[0].p_name
, "zfs");
3807 vtoc
->efi_parts
[8].p_start
= slice_size
+ start_block
;
3808 vtoc
->efi_parts
[8].p_size
= resv
;
3809 vtoc
->efi_parts
[8].p_tag
= V_RESERVED
;
3811 if ((rval
= efi_write(fd
, vtoc
)) != 0) {
3813 * Some block drivers (like pcata) may not support EFI
3814 * GPT labels. Print out a helpful error message dir-
3815 * ecting the user to manually label the disk and give
3821 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "try using "
3822 "parted(8) and then provide a specific slice: %d"), rval
);
3823 return (zfs_error(hdl
, EZFS_LABELFAILED
, errbuf
));
3829 /* Wait for the first expected slice to appear. */
3830 (void) snprintf(path
, sizeof (path
), "%s/%s%s%s", DISK_ROOT
, name
,
3831 isdigit(name
[strlen(name
)-1]) ? "p" : "", FIRST_SLICE
);
3832 rval
= zpool_label_disk_wait(path
, 3000);
3834 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "failed to "
3835 "detect device partitions on '%s': %d"), path
, rval
);
3836 return (zfs_error(hdl
, EZFS_LABELFAILED
, errbuf
));
3839 /* We can't be to paranoid. Read the label back and verify it. */
3840 (void) snprintf(path
, sizeof (path
), "%s/%s", DISK_ROOT
, name
);
3841 rval
= zpool_label_disk_check(path
);
3843 zfs_error_aux(hdl
, dgettext(TEXT_DOMAIN
, "freshly written "
3844 "EFI label on '%s' is damaged. Ensure\nthis device "
3845 "is not in in use, and is functioning properly: %d"),
3847 return (zfs_error(hdl
, EZFS_LABELFAILED
, errbuf
));