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.
24 * Copyright (c) 2012, 2016 by Delphix. All rights reserved.
25 * Copyright 2015 RackTop Systems.
26 * Copyright 2017 Nexenta Systems, Inc.
30 * Pool import support functions.
32 * To import a pool, we rely on reading the configuration information from the
33 * ZFS label of each device. If we successfully read the label, then we
34 * organize the configuration information in the following hierarchy:
36 * pool guid -> toplevel vdev guid -> label txg
38 * Duplicate entries matching this same tuple will be discarded. Once we have
39 * examined every device, we pick the best label txg config for each toplevel
40 * vdev. We then arrange these toplevel vdevs into a complete pool config, and
41 * update any paths that have changed. Finally, we attempt to import the pool
42 * using our derived config, and record the results.
57 #include <sys/dktp/fdisk.h>
58 #include <sys/efi_partition.h>
59 #include <thread_pool.h>
61 #include <sys/vdev_impl.h>
64 #include "libzfs_impl.h"
67 * Intermediate structures used to gather configuration information.
69 typedef struct config_entry
{
72 struct config_entry
*ce_next
;
75 typedef struct vdev_entry
{
77 config_entry_t
*ve_configs
;
78 struct vdev_entry
*ve_next
;
81 typedef struct pool_entry
{
83 vdev_entry_t
*pe_vdevs
;
84 struct pool_entry
*pe_next
;
87 typedef struct name_entry
{
90 struct name_entry
*ne_next
;
93 typedef struct pool_list
{
99 * Go through and fix up any path and/or devid information for the given vdev
103 fix_paths(nvlist_t
*nv
, name_entry_t
*names
)
108 name_entry_t
*ne
, *best
;
112 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
113 &child
, &children
) == 0) {
114 for (c
= 0; c
< children
; c
++)
115 if (fix_paths(child
[c
], names
) != 0)
121 * This is a leaf (file or disk) vdev. In either case, go through
122 * the name list and see if we find a matching guid. If so, replace
123 * the path and see if we can calculate a new devid.
125 * There may be multiple names associated with a particular guid, in
126 * which case we have overlapping slices or multiple paths to the same
127 * disk. If this is the case, then we want to pick the path that is
128 * the most similar to the original, where "most similar" is the number
129 * of matching characters starting from the end of the path. This will
130 * preserve slice numbers even if the disks have been reorganized, and
131 * will also catch preferred disk names if multiple paths exist.
133 verify(nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_GUID
, &guid
) == 0);
134 if (nvlist_lookup_string(nv
, ZPOOL_CONFIG_PATH
, &path
) != 0)
139 for (ne
= names
; ne
!= NULL
; ne
= ne
->ne_next
) {
140 if (ne
->ne_guid
== guid
) {
141 const char *src
, *dst
;
149 src
= ne
->ne_name
+ strlen(ne
->ne_name
) - 1;
150 dst
= path
+ strlen(path
) - 1;
151 for (count
= 0; src
>= ne
->ne_name
&& dst
>= path
;
152 src
--, dst
--, count
++)
157 * At this point, 'count' is the number of characters
158 * matched from the end.
160 if (count
> matched
|| best
== NULL
) {
170 if (nvlist_add_string(nv
, ZPOOL_CONFIG_PATH
, best
->ne_name
) != 0)
173 if ((devid
= devid_str_from_path(best
->ne_name
)) == NULL
) {
174 (void) nvlist_remove_all(nv
, ZPOOL_CONFIG_DEVID
);
176 if (nvlist_add_string(nv
, ZPOOL_CONFIG_DEVID
, devid
) != 0) {
177 devid_str_free(devid
);
180 devid_str_free(devid
);
187 * Add the given configuration to the list of known devices.
190 add_config(libzfs_handle_t
*hdl
, pool_list_t
*pl
, const char *path
,
193 uint64_t pool_guid
, vdev_guid
, top_guid
, txg
, state
;
200 * If this is a hot spare not currently in use or level 2 cache
201 * device, add it to the list of names to translate, but don't do
204 if (nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_STATE
,
206 (state
== POOL_STATE_SPARE
|| state
== POOL_STATE_L2CACHE
) &&
207 nvlist_lookup_uint64(config
, ZPOOL_CONFIG_GUID
, &vdev_guid
) == 0) {
208 if ((ne
= zfs_alloc(hdl
, sizeof (name_entry_t
))) == NULL
)
211 if ((ne
->ne_name
= zfs_strdup(hdl
, path
)) == NULL
) {
216 ne
->ne_guid
= vdev_guid
;
217 ne
->ne_next
= pl
->names
;
225 * If we have a valid config but cannot read any of these fields, then
226 * it means we have a half-initialized label. In vdev_label_init()
227 * we write a label with txg == 0 so that we can identify the device
228 * in case the user refers to the same disk later on. If we fail to
229 * create the pool, we'll be left with a label in this state
230 * which should not be considered part of a valid pool.
232 if (nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_GUID
,
234 nvlist_lookup_uint64(config
, ZPOOL_CONFIG_GUID
,
236 nvlist_lookup_uint64(config
, ZPOOL_CONFIG_TOP_GUID
,
238 nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_TXG
,
239 &txg
) != 0 || txg
== 0) {
245 * First, see if we know about this pool. If not, then add it to the
246 * list of known pools.
248 for (pe
= pl
->pools
; pe
!= NULL
; pe
= pe
->pe_next
) {
249 if (pe
->pe_guid
== pool_guid
)
254 if ((pe
= zfs_alloc(hdl
, sizeof (pool_entry_t
))) == NULL
) {
258 pe
->pe_guid
= pool_guid
;
259 pe
->pe_next
= pl
->pools
;
264 * Second, see if we know about this toplevel vdev. Add it if its
267 for (ve
= pe
->pe_vdevs
; ve
!= NULL
; ve
= ve
->ve_next
) {
268 if (ve
->ve_guid
== top_guid
)
273 if ((ve
= zfs_alloc(hdl
, sizeof (vdev_entry_t
))) == NULL
) {
277 ve
->ve_guid
= top_guid
;
278 ve
->ve_next
= pe
->pe_vdevs
;
283 * Third, see if we have a config with a matching transaction group. If
284 * so, then we do nothing. Otherwise, add it to the list of known
287 for (ce
= ve
->ve_configs
; ce
!= NULL
; ce
= ce
->ce_next
) {
288 if (ce
->ce_txg
== txg
)
293 if ((ce
= zfs_alloc(hdl
, sizeof (config_entry_t
))) == NULL
) {
298 ce
->ce_config
= config
;
299 ce
->ce_next
= ve
->ve_configs
;
306 * At this point we've successfully added our config to the list of
307 * known configs. The last thing to do is add the vdev guid -> path
308 * mappings so that we can fix up the configuration as necessary before
311 if ((ne
= zfs_alloc(hdl
, sizeof (name_entry_t
))) == NULL
)
314 if ((ne
->ne_name
= zfs_strdup(hdl
, path
)) == NULL
) {
319 ne
->ne_guid
= vdev_guid
;
320 ne
->ne_next
= pl
->names
;
327 * Returns true if the named pool matches the given GUID.
330 pool_active(libzfs_handle_t
*hdl
, const char *name
, uint64_t guid
,
336 if (zpool_open_silent(hdl
, name
, &zhp
) != 0)
344 verify(nvlist_lookup_uint64(zhp
->zpool_config
, ZPOOL_CONFIG_POOL_GUID
,
349 *isactive
= (theguid
== guid
);
354 refresh_config(libzfs_handle_t
*hdl
, nvlist_t
*config
)
357 zfs_cmd_t zc
= { 0 };
358 int err
, dstbuf_size
;
360 if (zcmd_write_conf_nvlist(hdl
, &zc
, config
) != 0)
363 dstbuf_size
= MAX(CONFIG_BUF_MINSIZE
, zc
.zc_nvlist_conf_size
* 4);
365 if (zcmd_alloc_dst_nvlist(hdl
, &zc
, dstbuf_size
) != 0) {
366 zcmd_free_nvlists(&zc
);
370 while ((err
= ioctl(hdl
->libzfs_fd
, ZFS_IOC_POOL_TRYIMPORT
,
371 &zc
)) != 0 && errno
== ENOMEM
) {
372 if (zcmd_expand_dst_nvlist(hdl
, &zc
) != 0) {
373 zcmd_free_nvlists(&zc
);
379 zcmd_free_nvlists(&zc
);
383 if (zcmd_read_dst_nvlist(hdl
, &zc
, &nvl
) != 0) {
384 zcmd_free_nvlists(&zc
);
388 zcmd_free_nvlists(&zc
);
393 * Determine if the vdev id is a hole in the namespace.
396 vdev_is_hole(uint64_t *hole_array
, uint_t holes
, uint_t id
)
398 for (int c
= 0; c
< holes
; c
++) {
400 /* Top-level is a hole */
401 if (hole_array
[c
] == id
)
408 * Convert our list of pools into the definitive set of configurations. We
409 * start by picking the best config for each toplevel vdev. Once that's done,
410 * we assemble the toplevel vdevs into a full config for the pool. We make a
411 * pass to fix up any incorrect paths, and then add it to the main list to
412 * return to the user.
415 get_configs(libzfs_handle_t
*hdl
, pool_list_t
*pl
, boolean_t active_ok
)
420 nvlist_t
*ret
= NULL
, *config
= NULL
, *tmp
= NULL
, *nvtop
, *nvroot
;
421 nvlist_t
**spares
, **l2cache
;
422 uint_t i
, nspares
, nl2cache
;
423 boolean_t config_seen
;
425 char *name
, *hostname
= NULL
;
428 nvlist_t
**child
= NULL
;
430 uint64_t *hole_array
, max_id
;
435 boolean_t found_one
= B_FALSE
;
436 boolean_t valid_top_config
= B_FALSE
;
438 if (nvlist_alloc(&ret
, 0, 0) != 0)
441 for (pe
= pl
->pools
; pe
!= NULL
; pe
= pe
->pe_next
) {
442 uint64_t id
, max_txg
= 0;
444 if (nvlist_alloc(&config
, NV_UNIQUE_NAME
, 0) != 0)
446 config_seen
= B_FALSE
;
449 * Iterate over all toplevel vdevs. Grab the pool configuration
450 * from the first one we find, and then go through the rest and
451 * add them as necessary to the 'vdevs' member of the config.
453 for (ve
= pe
->pe_vdevs
; ve
!= NULL
; ve
= ve
->ve_next
) {
456 * Determine the best configuration for this vdev by
457 * selecting the config with the latest transaction
461 for (ce
= ve
->ve_configs
; ce
!= NULL
;
464 if (ce
->ce_txg
> best_txg
) {
466 best_txg
= ce
->ce_txg
;
471 * We rely on the fact that the max txg for the
472 * pool will contain the most up-to-date information
473 * about the valid top-levels in the vdev namespace.
475 if (best_txg
> max_txg
) {
476 (void) nvlist_remove(config
,
477 ZPOOL_CONFIG_VDEV_CHILDREN
,
479 (void) nvlist_remove(config
,
480 ZPOOL_CONFIG_HOLE_ARRAY
,
481 DATA_TYPE_UINT64_ARRAY
);
487 valid_top_config
= B_FALSE
;
489 if (nvlist_lookup_uint64(tmp
,
490 ZPOOL_CONFIG_VDEV_CHILDREN
, &max_id
) == 0) {
491 verify(nvlist_add_uint64(config
,
492 ZPOOL_CONFIG_VDEV_CHILDREN
,
494 valid_top_config
= B_TRUE
;
497 if (nvlist_lookup_uint64_array(tmp
,
498 ZPOOL_CONFIG_HOLE_ARRAY
, &hole_array
,
500 verify(nvlist_add_uint64_array(config
,
501 ZPOOL_CONFIG_HOLE_ARRAY
,
502 hole_array
, holes
) == 0);
508 * Copy the relevant pieces of data to the pool
514 * comment (if available)
516 * hostid (if available)
517 * hostname (if available)
519 uint64_t state
, version
;
520 char *comment
= NULL
;
522 version
= fnvlist_lookup_uint64(tmp
,
523 ZPOOL_CONFIG_VERSION
);
524 fnvlist_add_uint64(config
,
525 ZPOOL_CONFIG_VERSION
, version
);
526 guid
= fnvlist_lookup_uint64(tmp
,
527 ZPOOL_CONFIG_POOL_GUID
);
528 fnvlist_add_uint64(config
,
529 ZPOOL_CONFIG_POOL_GUID
, guid
);
530 name
= fnvlist_lookup_string(tmp
,
531 ZPOOL_CONFIG_POOL_NAME
);
532 fnvlist_add_string(config
,
533 ZPOOL_CONFIG_POOL_NAME
, name
);
535 if (nvlist_lookup_string(tmp
,
536 ZPOOL_CONFIG_COMMENT
, &comment
) == 0)
537 fnvlist_add_string(config
,
538 ZPOOL_CONFIG_COMMENT
, comment
);
540 state
= fnvlist_lookup_uint64(tmp
,
541 ZPOOL_CONFIG_POOL_STATE
);
542 fnvlist_add_uint64(config
,
543 ZPOOL_CONFIG_POOL_STATE
, state
);
546 if (nvlist_lookup_uint64(tmp
,
547 ZPOOL_CONFIG_HOSTID
, &hostid
) == 0) {
548 fnvlist_add_uint64(config
,
549 ZPOOL_CONFIG_HOSTID
, hostid
);
550 hostname
= fnvlist_lookup_string(tmp
,
551 ZPOOL_CONFIG_HOSTNAME
);
552 fnvlist_add_string(config
,
553 ZPOOL_CONFIG_HOSTNAME
, hostname
);
556 config_seen
= B_TRUE
;
560 * Add this top-level vdev to the child array.
562 verify(nvlist_lookup_nvlist(tmp
,
563 ZPOOL_CONFIG_VDEV_TREE
, &nvtop
) == 0);
564 verify(nvlist_lookup_uint64(nvtop
, ZPOOL_CONFIG_ID
,
567 if (id
>= children
) {
570 newchild
= zfs_alloc(hdl
, (id
+ 1) *
571 sizeof (nvlist_t
*));
572 if (newchild
== NULL
)
575 for (c
= 0; c
< children
; c
++)
576 newchild
[c
] = child
[c
];
582 if (nvlist_dup(nvtop
, &child
[id
], 0) != 0)
588 * If we have information about all the top-levels then
589 * clean up the nvlist which we've constructed. This
590 * means removing any extraneous devices that are
591 * beyond the valid range or adding devices to the end
592 * of our array which appear to be missing.
594 if (valid_top_config
) {
595 if (max_id
< children
) {
596 for (c
= max_id
; c
< children
; c
++)
597 nvlist_free(child
[c
]);
599 } else if (max_id
> children
) {
602 newchild
= zfs_alloc(hdl
, (max_id
) *
603 sizeof (nvlist_t
*));
604 if (newchild
== NULL
)
607 for (c
= 0; c
< children
; c
++)
608 newchild
[c
] = child
[c
];
616 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_GUID
,
620 * The vdev namespace may contain holes as a result of
621 * device removal. We must add them back into the vdev
622 * tree before we process any missing devices.
625 ASSERT(valid_top_config
);
627 for (c
= 0; c
< children
; c
++) {
630 if (child
[c
] != NULL
||
631 !vdev_is_hole(hole_array
, holes
, c
))
634 if (nvlist_alloc(&holey
, NV_UNIQUE_NAME
,
639 * Holes in the namespace are treated as
640 * "hole" top-level vdevs and have a
641 * special flag set on them.
643 if (nvlist_add_string(holey
,
645 VDEV_TYPE_HOLE
) != 0 ||
646 nvlist_add_uint64(holey
,
647 ZPOOL_CONFIG_ID
, c
) != 0 ||
648 nvlist_add_uint64(holey
,
649 ZPOOL_CONFIG_GUID
, 0ULL) != 0) {
658 * Look for any missing top-level vdevs. If this is the case,
659 * create a faked up 'missing' vdev as a placeholder. We cannot
660 * simply compress the child array, because the kernel performs
661 * certain checks to make sure the vdev IDs match their location
662 * in the configuration.
664 for (c
= 0; c
< children
; c
++) {
665 if (child
[c
] == NULL
) {
667 if (nvlist_alloc(&missing
, NV_UNIQUE_NAME
,
670 if (nvlist_add_string(missing
,
672 VDEV_TYPE_MISSING
) != 0 ||
673 nvlist_add_uint64(missing
,
674 ZPOOL_CONFIG_ID
, c
) != 0 ||
675 nvlist_add_uint64(missing
,
676 ZPOOL_CONFIG_GUID
, 0ULL) != 0) {
677 nvlist_free(missing
);
685 * Put all of this pool's top-level vdevs into a root vdev.
687 if (nvlist_alloc(&nvroot
, NV_UNIQUE_NAME
, 0) != 0)
689 if (nvlist_add_string(nvroot
, ZPOOL_CONFIG_TYPE
,
690 VDEV_TYPE_ROOT
) != 0 ||
691 nvlist_add_uint64(nvroot
, ZPOOL_CONFIG_ID
, 0ULL) != 0 ||
692 nvlist_add_uint64(nvroot
, ZPOOL_CONFIG_GUID
, guid
) != 0 ||
693 nvlist_add_nvlist_array(nvroot
, ZPOOL_CONFIG_CHILDREN
,
694 child
, children
) != 0) {
699 for (c
= 0; c
< children
; c
++)
700 nvlist_free(child
[c
]);
706 * Go through and fix up any paths and/or devids based on our
707 * known list of vdev GUID -> path mappings.
709 if (fix_paths(nvroot
, pl
->names
) != 0) {
715 * Add the root vdev to this pool's configuration.
717 if (nvlist_add_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
725 * zdb uses this path to report on active pools that were
726 * imported or created using -R.
732 * Determine if this pool is currently active, in which case we
733 * can't actually import it.
735 verify(nvlist_lookup_string(config
, ZPOOL_CONFIG_POOL_NAME
,
737 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_GUID
,
740 if (pool_active(hdl
, name
, guid
, &isactive
) != 0)
749 if ((nvl
= refresh_config(hdl
, config
)) == NULL
) {
759 * Go through and update the paths for spares, now that we have
762 verify(nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
764 if (nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_SPARES
,
765 &spares
, &nspares
) == 0) {
766 for (i
= 0; i
< nspares
; i
++) {
767 if (fix_paths(spares
[i
], pl
->names
) != 0)
773 * Update the paths for l2cache devices.
775 if (nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_L2CACHE
,
776 &l2cache
, &nl2cache
) == 0) {
777 for (i
= 0; i
< nl2cache
; i
++) {
778 if (fix_paths(l2cache
[i
], pl
->names
) != 0)
784 * Restore the original information read from the actual label.
786 (void) nvlist_remove(config
, ZPOOL_CONFIG_HOSTID
,
788 (void) nvlist_remove(config
, ZPOOL_CONFIG_HOSTNAME
,
791 verify(nvlist_add_uint64(config
, ZPOOL_CONFIG_HOSTID
,
793 verify(nvlist_add_string(config
, ZPOOL_CONFIG_HOSTNAME
,
799 * Add this pool to the list of configs.
801 verify(nvlist_lookup_string(config
, ZPOOL_CONFIG_POOL_NAME
,
803 if (nvlist_add_nvlist(ret
, name
, config
) != 0)
819 (void) no_memory(hdl
);
823 for (c
= 0; c
< children
; c
++)
824 nvlist_free(child
[c
]);
831 * Return the offset of the given label.
834 label_offset(uint64_t size
, int l
)
836 ASSERT(P2PHASE_TYPED(size
, sizeof (vdev_label_t
), uint64_t) == 0);
837 return (l
* sizeof (vdev_label_t
) + (l
< VDEV_LABELS
/ 2 ?
838 0 : size
- VDEV_LABELS
* sizeof (vdev_label_t
)));
842 * Given a file descriptor, read the label information and return an nvlist
843 * describing the configuration, if there is one.
846 zpool_read_label(int fd
, nvlist_t
**config
)
848 struct stat64 statbuf
;
851 uint64_t state
, txg
, size
;
855 if (fstat64(fd
, &statbuf
) == -1)
857 size
= P2ALIGN_TYPED(statbuf
.st_size
, sizeof (vdev_label_t
), uint64_t);
859 if ((label
= malloc(sizeof (vdev_label_t
))) == NULL
)
862 for (l
= 0; l
< VDEV_LABELS
; l
++) {
863 if (pread64(fd
, label
, sizeof (vdev_label_t
),
864 label_offset(size
, l
)) != sizeof (vdev_label_t
))
867 if (nvlist_unpack(label
->vl_vdev_phys
.vp_nvlist
,
868 sizeof (label
->vl_vdev_phys
.vp_nvlist
), config
, 0) != 0)
871 if (nvlist_lookup_uint64(*config
, ZPOOL_CONFIG_POOL_STATE
,
872 &state
) != 0 || state
> POOL_STATE_L2CACHE
) {
873 nvlist_free(*config
);
877 if (state
!= POOL_STATE_SPARE
&& state
!= POOL_STATE_L2CACHE
&&
878 (nvlist_lookup_uint64(*config
, ZPOOL_CONFIG_POOL_TXG
,
879 &txg
) != 0 || txg
== 0)) {
880 nvlist_free(*config
);
893 typedef struct rdsk_node
{
896 libzfs_handle_t
*rn_hdl
;
900 boolean_t rn_nozpool
;
904 slice_cache_compare(const void *arg1
, const void *arg2
)
906 const char *nm1
= ((rdsk_node_t
*)arg1
)->rn_name
;
907 const char *nm2
= ((rdsk_node_t
*)arg2
)->rn_name
;
908 char *nm1slice
, *nm2slice
;
912 * slices zero and two are the most likely to provide results,
915 nm1slice
= strstr(nm1
, "s0");
916 nm2slice
= strstr(nm2
, "s0");
917 if (nm1slice
&& !nm2slice
) {
920 if (!nm1slice
&& nm2slice
) {
923 nm1slice
= strstr(nm1
, "s2");
924 nm2slice
= strstr(nm2
, "s2");
925 if (nm1slice
&& !nm2slice
) {
928 if (!nm1slice
&& nm2slice
) {
932 rv
= strcmp(nm1
, nm2
);
935 return (rv
> 0 ? 1 : -1);
939 check_one_slice(avl_tree_t
*r
, char *diskname
, uint_t partno
,
940 diskaddr_t size
, uint_t blksz
)
944 char sname
[MAXNAMELEN
];
946 tmpnode
.rn_name
= &sname
[0];
947 (void) snprintf(tmpnode
.rn_name
, MAXNAMELEN
, "%s%u",
950 * protect against division by zero for disk labels that
951 * contain a bogus sector size
955 /* too small to contain a zpool? */
956 if ((size
< (SPA_MINDEVSIZE
/ blksz
)) &&
957 (node
= avl_find(r
, &tmpnode
, NULL
)))
958 node
->rn_nozpool
= B_TRUE
;
962 nozpool_all_slices(avl_tree_t
*r
, const char *sname
)
964 char diskname
[MAXNAMELEN
];
968 (void) strncpy(diskname
, sname
, MAXNAMELEN
);
969 if (((ptr
= strrchr(diskname
, 's')) == NULL
) &&
970 ((ptr
= strrchr(diskname
, 'p')) == NULL
))
974 for (i
= 0; i
< NDKMAP
; i
++)
975 check_one_slice(r
, diskname
, i
, 0, 1);
977 for (i
= 0; i
<= FD_NUMPART
; i
++)
978 check_one_slice(r
, diskname
, i
, 0, 1);
982 check_slices(avl_tree_t
*r
, int fd
, const char *sname
)
986 char diskname
[MAXNAMELEN
];
990 (void) strncpy(diskname
, sname
, MAXNAMELEN
);
991 if ((ptr
= strrchr(diskname
, 's')) == NULL
|| !isdigit(ptr
[1]))
995 if (read_extvtoc(fd
, &vtoc
) >= 0) {
996 for (i
= 0; i
< NDKMAP
; i
++)
997 check_one_slice(r
, diskname
, i
,
998 vtoc
.v_part
[i
].p_size
, vtoc
.v_sectorsz
);
999 } else if (efi_alloc_and_read(fd
, &gpt
) >= 0) {
1001 * on x86 we'll still have leftover links that point
1002 * to slices s[9-15], so use NDKMAP instead
1004 for (i
= 0; i
< NDKMAP
; i
++)
1005 check_one_slice(r
, diskname
, i
,
1006 gpt
->efi_parts
[i
].p_size
, gpt
->efi_lbasize
);
1007 /* nodes p[1-4] are never used with EFI labels */
1009 for (i
= 1; i
<= FD_NUMPART
; i
++)
1010 check_one_slice(r
, diskname
, i
, 0, 1);
1016 zpool_open_func(void *arg
)
1018 rdsk_node_t
*rn
= arg
;
1019 struct stat64 statbuf
;
1025 if ((fd
= openat64(rn
->rn_dfd
, rn
->rn_name
, O_RDONLY
)) < 0) {
1026 /* symlink to a device that's no longer there */
1027 if (errno
== ENOENT
)
1028 nozpool_all_slices(rn
->rn_avl
, rn
->rn_name
);
1032 * Ignore failed stats. We only want regular
1033 * files, character devs and block devs.
1035 if (fstat64(fd
, &statbuf
) != 0 ||
1036 (!S_ISREG(statbuf
.st_mode
) &&
1037 !S_ISCHR(statbuf
.st_mode
) &&
1038 !S_ISBLK(statbuf
.st_mode
))) {
1042 /* this file is too small to hold a zpool */
1043 if (S_ISREG(statbuf
.st_mode
) &&
1044 statbuf
.st_size
< SPA_MINDEVSIZE
) {
1047 } else if (!S_ISREG(statbuf
.st_mode
)) {
1049 * Try to read the disk label first so we don't have to
1050 * open a bunch of minor nodes that can't have a zpool.
1052 check_slices(rn
->rn_avl
, fd
, rn
->rn_name
);
1055 if ((zpool_read_label(fd
, &config
)) != 0) {
1057 (void) no_memory(rn
->rn_hdl
);
1062 rn
->rn_config
= config
;
1066 * Given a file descriptor, clear (zero) the label information.
1069 zpool_clear_label(int fd
)
1071 struct stat64 statbuf
;
1073 vdev_label_t
*label
;
1076 if (fstat64(fd
, &statbuf
) == -1)
1078 size
= P2ALIGN_TYPED(statbuf
.st_size
, sizeof (vdev_label_t
), uint64_t);
1080 if ((label
= calloc(sizeof (vdev_label_t
), 1)) == NULL
)
1083 for (l
= 0; l
< VDEV_LABELS
; l
++) {
1084 if (pwrite64(fd
, label
, sizeof (vdev_label_t
),
1085 label_offset(size
, l
)) != sizeof (vdev_label_t
)) {
1096 * Given a list of directories to search, find all pools stored on disk. This
1097 * includes partial pools which are not available to import. If no args are
1098 * given (argc is 0), then the default directory (/dev/dsk) is searched.
1099 * poolname or guid (but not both) are provided by the caller when trying
1100 * to import a specific pool.
1103 zpool_find_import_impl(libzfs_handle_t
*hdl
, importargs_t
*iarg
)
1105 int i
, dirs
= iarg
->paths
;
1106 struct dirent64
*dp
;
1107 char path
[MAXPATHLEN
];
1108 char *end
, **dir
= iarg
->path
;
1110 nvlist_t
*ret
= NULL
;
1111 static char *default_dir
= ZFS_DISK_ROOT
;
1112 pool_list_t pools
= { 0 };
1113 pool_entry_t
*pe
, *penext
;
1114 vdev_entry_t
*ve
, *venext
;
1115 config_entry_t
*ce
, *cenext
;
1116 name_entry_t
*ne
, *nenext
;
1117 avl_tree_t slice_cache
;
1127 * Go through and read the label configuration information from every
1128 * possible device, organizing the information according to pool GUID
1129 * and toplevel GUID.
1131 for (i
= 0; i
< dirs
; i
++) {
1133 char rdsk
[MAXPATHLEN
];
1135 boolean_t config_failed
= B_FALSE
;
1138 /* use realpath to normalize the path */
1139 if (realpath(dir
[i
], path
) == 0) {
1140 (void) zfs_error_fmt(hdl
, EZFS_BADPATH
,
1141 dgettext(TEXT_DOMAIN
, "cannot open '%s'"), dir
[i
]);
1144 end
= &path
[strlen(path
)];
1147 pathleft
= &path
[sizeof (path
)] - end
;
1150 * Using raw devices instead of block devices when we're
1151 * reading the labels skips a bunch of slow operations during
1152 * close(2) processing, so we replace /dev/dsk with /dev/rdsk.
1154 if (strcmp(path
, ZFS_DISK_ROOTD
) == 0)
1155 (void) strlcpy(rdsk
, ZFS_RDISK_ROOTD
, sizeof (rdsk
));
1157 (void) strlcpy(rdsk
, path
, sizeof (rdsk
));
1159 if ((dfd
= open64(rdsk
, O_RDONLY
)) < 0 ||
1160 (dirp
= fdopendir(dfd
)) == NULL
) {
1163 zfs_error_aux(hdl
, strerror(errno
));
1164 (void) zfs_error_fmt(hdl
, EZFS_BADPATH
,
1165 dgettext(TEXT_DOMAIN
, "cannot open '%s'"),
1170 avl_create(&slice_cache
, slice_cache_compare
,
1171 sizeof (rdsk_node_t
), offsetof(rdsk_node_t
, rn_node
));
1173 * This is not MT-safe, but we have no MT consumers of libzfs
1175 while ((dp
= readdir64(dirp
)) != NULL
) {
1176 const char *name
= dp
->d_name
;
1177 if (name
[0] == '.' &&
1178 (name
[1] == 0 || (name
[1] == '.' && name
[2] == 0)))
1181 slice
= zfs_alloc(hdl
, sizeof (rdsk_node_t
));
1182 slice
->rn_name
= zfs_strdup(hdl
, name
);
1183 slice
->rn_avl
= &slice_cache
;
1184 slice
->rn_dfd
= dfd
;
1185 slice
->rn_hdl
= hdl
;
1186 slice
->rn_nozpool
= B_FALSE
;
1187 avl_add(&slice_cache
, slice
);
1190 * create a thread pool to do all of this in parallel;
1191 * rn_nozpool is not protected, so this is racy in that
1192 * multiple tasks could decide that the same slice can
1193 * not hold a zpool, which is benign. Also choose
1194 * double the number of processors; we hold a lot of
1195 * locks in the kernel, so going beyond this doesn't
1198 t
= tpool_create(1, 2 * sysconf(_SC_NPROCESSORS_ONLN
),
1200 for (slice
= avl_first(&slice_cache
); slice
;
1201 (slice
= avl_walk(&slice_cache
, slice
,
1203 (void) tpool_dispatch(t
, zpool_open_func
, slice
);
1208 while ((slice
= avl_destroy_nodes(&slice_cache
,
1209 &cookie
)) != NULL
) {
1210 if (slice
->rn_config
!= NULL
&& !config_failed
) {
1211 nvlist_t
*config
= slice
->rn_config
;
1212 boolean_t matched
= B_TRUE
;
1214 if (iarg
->poolname
!= NULL
) {
1217 matched
= nvlist_lookup_string(config
,
1218 ZPOOL_CONFIG_POOL_NAME
,
1220 strcmp(iarg
->poolname
, pname
) == 0;
1221 } else if (iarg
->guid
!= 0) {
1224 matched
= nvlist_lookup_uint64(config
,
1225 ZPOOL_CONFIG_POOL_GUID
,
1227 iarg
->guid
== this_guid
;
1230 nvlist_free(config
);
1233 * use the non-raw path for the config
1235 (void) strlcpy(end
, slice
->rn_name
,
1237 if (add_config(hdl
, &pools
, path
,
1239 config_failed
= B_TRUE
;
1242 free(slice
->rn_name
);
1245 avl_destroy(&slice_cache
);
1247 (void) closedir(dirp
);
1253 ret
= get_configs(hdl
, &pools
, iarg
->can_be_active
);
1256 for (pe
= pools
.pools
; pe
!= NULL
; pe
= penext
) {
1257 penext
= pe
->pe_next
;
1258 for (ve
= pe
->pe_vdevs
; ve
!= NULL
; ve
= venext
) {
1259 venext
= ve
->ve_next
;
1260 for (ce
= ve
->ve_configs
; ce
!= NULL
; ce
= cenext
) {
1261 cenext
= ce
->ce_next
;
1262 nvlist_free(ce
->ce_config
);
1270 for (ne
= pools
.names
; ne
!= NULL
; ne
= nenext
) {
1271 nenext
= ne
->ne_next
;
1280 zpool_find_import(libzfs_handle_t
*hdl
, int argc
, char **argv
)
1282 importargs_t iarg
= { 0 };
1287 return (zpool_find_import_impl(hdl
, &iarg
));
1291 * Given a cache file, return the contents as a list of importable pools.
1292 * poolname or guid (but not both) are provided by the caller when trying
1293 * to import a specific pool.
1296 zpool_find_import_cached(libzfs_handle_t
*hdl
, const char *cachefile
,
1297 char *poolname
, uint64_t guid
)
1301 struct stat64 statbuf
;
1302 nvlist_t
*raw
, *src
, *dst
;
1309 verify(poolname
== NULL
|| guid
== 0);
1311 if ((fd
= open(cachefile
, O_RDONLY
)) < 0) {
1312 zfs_error_aux(hdl
, "%s", strerror(errno
));
1313 (void) zfs_error(hdl
, EZFS_BADCACHE
,
1314 dgettext(TEXT_DOMAIN
, "failed to open cache file"));
1318 if (fstat64(fd
, &statbuf
) != 0) {
1319 zfs_error_aux(hdl
, "%s", strerror(errno
));
1321 (void) zfs_error(hdl
, EZFS_BADCACHE
,
1322 dgettext(TEXT_DOMAIN
, "failed to get size of cache file"));
1326 if ((buf
= zfs_alloc(hdl
, statbuf
.st_size
)) == NULL
) {
1331 if (read(fd
, buf
, statbuf
.st_size
) != statbuf
.st_size
) {
1334 (void) zfs_error(hdl
, EZFS_BADCACHE
,
1335 dgettext(TEXT_DOMAIN
,
1336 "failed to read cache file contents"));
1342 if (nvlist_unpack(buf
, statbuf
.st_size
, &raw
, 0) != 0) {
1344 (void) zfs_error(hdl
, EZFS_BADCACHE
,
1345 dgettext(TEXT_DOMAIN
,
1346 "invalid or corrupt cache file contents"));
1353 * Go through and get the current state of the pools and refresh their
1356 if (nvlist_alloc(&pools
, 0, 0) != 0) {
1357 (void) no_memory(hdl
);
1363 while ((elem
= nvlist_next_nvpair(raw
, elem
)) != NULL
) {
1364 src
= fnvpair_value_nvlist(elem
);
1366 name
= fnvlist_lookup_string(src
, ZPOOL_CONFIG_POOL_NAME
);
1367 if (poolname
!= NULL
&& strcmp(poolname
, name
) != 0)
1370 this_guid
= fnvlist_lookup_uint64(src
, ZPOOL_CONFIG_POOL_GUID
);
1371 if (guid
!= 0 && guid
!= this_guid
)
1374 if (pool_active(hdl
, name
, this_guid
, &active
) != 0) {
1383 if ((dst
= refresh_config(hdl
, src
)) == NULL
) {
1389 if (nvlist_add_nvlist(pools
, nvpair_name(elem
), dst
) != 0) {
1390 (void) no_memory(hdl
);
1404 name_or_guid_exists(zpool_handle_t
*zhp
, void *data
)
1406 importargs_t
*import
= data
;
1409 if (import
->poolname
!= NULL
) {
1412 verify(nvlist_lookup_string(zhp
->zpool_config
,
1413 ZPOOL_CONFIG_POOL_NAME
, &pool_name
) == 0);
1414 if (strcmp(pool_name
, import
->poolname
) == 0)
1419 verify(nvlist_lookup_uint64(zhp
->zpool_config
,
1420 ZPOOL_CONFIG_POOL_GUID
, &pool_guid
) == 0);
1421 if (pool_guid
== import
->guid
)
1430 zpool_search_import(libzfs_handle_t
*hdl
, importargs_t
*import
)
1432 verify(import
->poolname
== NULL
|| import
->guid
== 0);
1435 import
->exists
= zpool_iter(hdl
, name_or_guid_exists
, import
);
1437 if (import
->cachefile
!= NULL
)
1438 return (zpool_find_import_cached(hdl
, import
->cachefile
,
1439 import
->poolname
, import
->guid
));
1441 return (zpool_find_import_impl(hdl
, import
));
1445 find_guid(nvlist_t
*nv
, uint64_t guid
)
1451 verify(nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_GUID
, &tmp
) == 0);
1455 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
1456 &child
, &children
) == 0) {
1457 for (c
= 0; c
< children
; c
++)
1458 if (find_guid(child
[c
], guid
))
1465 typedef struct aux_cbdata
{
1466 const char *cb_type
;
1468 zpool_handle_t
*cb_zhp
;
1472 find_aux(zpool_handle_t
*zhp
, void *data
)
1474 aux_cbdata_t
*cbp
= data
;
1480 verify(nvlist_lookup_nvlist(zhp
->zpool_config
, ZPOOL_CONFIG_VDEV_TREE
,
1483 if (nvlist_lookup_nvlist_array(nvroot
, cbp
->cb_type
,
1484 &list
, &count
) == 0) {
1485 for (i
= 0; i
< count
; i
++) {
1486 verify(nvlist_lookup_uint64(list
[i
],
1487 ZPOOL_CONFIG_GUID
, &guid
) == 0);
1488 if (guid
== cbp
->cb_guid
) {
1500 * Determines if the pool is in use. If so, it returns true and the state of
1501 * the pool as well as the name of the pool. Both strings are allocated and
1502 * must be freed by the caller.
1505 zpool_in_use(libzfs_handle_t
*hdl
, int fd
, pool_state_t
*state
, char **namestr
,
1511 uint64_t guid
, vdev_guid
;
1512 zpool_handle_t
*zhp
;
1513 nvlist_t
*pool_config
;
1514 uint64_t stateval
, isspare
;
1515 aux_cbdata_t cb
= { 0 };
1520 if (zpool_read_label(fd
, &config
) != 0) {
1521 (void) no_memory(hdl
);
1528 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_STATE
,
1530 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_GUID
,
1533 if (stateval
!= POOL_STATE_SPARE
&& stateval
!= POOL_STATE_L2CACHE
) {
1534 verify(nvlist_lookup_string(config
, ZPOOL_CONFIG_POOL_NAME
,
1536 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_GUID
,
1541 case POOL_STATE_EXPORTED
:
1543 * A pool with an exported state may in fact be imported
1544 * read-only, so check the in-core state to see if it's
1545 * active and imported read-only. If it is, set
1546 * its state to active.
1548 if (pool_active(hdl
, name
, guid
, &isactive
) == 0 && isactive
&&
1549 (zhp
= zpool_open_canfail(hdl
, name
)) != NULL
) {
1550 if (zpool_get_prop_int(zhp
, ZPOOL_PROP_READONLY
, NULL
))
1551 stateval
= POOL_STATE_ACTIVE
;
1554 * All we needed the zpool handle for is the
1555 * readonly prop check.
1563 case POOL_STATE_ACTIVE
:
1565 * For an active pool, we have to determine if it's really part
1566 * of a currently active pool (in which case the pool will exist
1567 * and the guid will be the same), or whether it's part of an
1568 * active pool that was disconnected without being explicitly
1571 if (pool_active(hdl
, name
, guid
, &isactive
) != 0) {
1572 nvlist_free(config
);
1578 * Because the device may have been removed while
1579 * offlined, we only report it as active if the vdev is
1580 * still present in the config. Otherwise, pretend like
1583 if ((zhp
= zpool_open_canfail(hdl
, name
)) != NULL
&&
1584 (pool_config
= zpool_get_config(zhp
, NULL
))
1588 verify(nvlist_lookup_nvlist(pool_config
,
1589 ZPOOL_CONFIG_VDEV_TREE
, &nvroot
) == 0);
1590 ret
= find_guid(nvroot
, vdev_guid
);
1596 * If this is an active spare within another pool, we
1597 * treat it like an unused hot spare. This allows the
1598 * user to create a pool with a hot spare that currently
1599 * in use within another pool. Since we return B_TRUE,
1600 * libdiskmgt will continue to prevent generic consumers
1601 * from using the device.
1603 if (ret
&& nvlist_lookup_uint64(config
,
1604 ZPOOL_CONFIG_IS_SPARE
, &isspare
) == 0 && isspare
)
1605 stateval
= POOL_STATE_SPARE
;
1610 stateval
= POOL_STATE_POTENTIALLY_ACTIVE
;
1615 case POOL_STATE_SPARE
:
1617 * For a hot spare, it can be either definitively in use, or
1618 * potentially active. To determine if it's in use, we iterate
1619 * over all pools in the system and search for one with a spare
1620 * with a matching guid.
1622 * Due to the shared nature of spares, we don't actually report
1623 * the potentially active case as in use. This means the user
1624 * can freely create pools on the hot spares of exported pools,
1625 * but to do otherwise makes the resulting code complicated, and
1626 * we end up having to deal with this case anyway.
1629 cb
.cb_guid
= vdev_guid
;
1630 cb
.cb_type
= ZPOOL_CONFIG_SPARES
;
1631 if (zpool_iter(hdl
, find_aux
, &cb
) == 1) {
1632 name
= (char *)zpool_get_name(cb
.cb_zhp
);
1639 case POOL_STATE_L2CACHE
:
1642 * Check if any pool is currently using this l2cache device.
1645 cb
.cb_guid
= vdev_guid
;
1646 cb
.cb_type
= ZPOOL_CONFIG_L2CACHE
;
1647 if (zpool_iter(hdl
, find_aux
, &cb
) == 1) {
1648 name
= (char *)zpool_get_name(cb
.cb_zhp
);
1661 if ((*namestr
= zfs_strdup(hdl
, name
)) == NULL
) {
1663 zpool_close(cb
.cb_zhp
);
1664 nvlist_free(config
);
1667 *state
= (pool_state_t
)stateval
;
1671 zpool_close(cb
.cb_zhp
);
1673 nvlist_free(config
);