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]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
24 * Copyright (c) 2012 by Delphix. All rights reserved.
28 * Pool import support functions.
30 * To import a pool, we rely on reading the configuration information from the
31 * ZFS label of each device. If we successfully read the label, then we
32 * organize the configuration information in the following hierarchy:
34 * pool guid -> toplevel vdev guid -> label txg
36 * Duplicate entries matching this same tuple will be discarded. Once we have
37 * examined every device, we pick the best label txg config for each toplevel
38 * vdev. We then arrange these toplevel vdevs into a complete pool config, and
39 * update any paths that have changed. Finally, we attempt to import the pool
40 * using our derived config, and record the results.
54 #include <thread_pool.h>
57 #include <sys/vdev_impl.h>
60 #include "libzfs_impl.h"
63 * Intermediate structures used to gather configuration information.
65 typedef struct config_entry {
68 struct config_entry *ce_next;
71 typedef struct vdev_entry {
73 config_entry_t *ve_configs;
74 struct vdev_entry *ve_next;
77 typedef struct pool_entry {
79 vdev_entry_t *pe_vdevs;
80 struct pool_entry *pe_next;
83 typedef struct name_entry {
86 struct name_entry *ne_next;
89 typedef struct pool_list {
95 get_devid(const char *path)
101 if ((fd = open(path, O_RDONLY)) < 0)
106 if (devid_get(fd, &devid) == 0) {
107 if (devid_get_minor_name(fd, &minor) == 0)
108 ret = devid_str_encode(devid, minor);
110 devid_str_free(minor);
120 * Go through and fix up any path and/or devid information for the given vdev
124 fix_paths(nvlist_t *nv, name_entry_t *names)
129 name_entry_t *ne, *best;
133 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
134 &child, &children) == 0) {
135 for (c = 0; c < children; c++)
136 if (fix_paths(child[c], names) != 0)
142 * This is a leaf (file or disk) vdev. In either case, go through
143 * the name list and see if we find a matching guid. If so, replace
144 * the path and see if we can calculate a new devid.
146 * There may be multiple names associated with a particular guid, in
147 * which case we have overlapping slices or multiple paths to the same
148 * disk. If this is the case, then we want to pick the path that is
149 * the most similar to the original, where "most similar" is the number
150 * of matching characters starting from the end of the path. This will
151 * preserve slice numbers even if the disks have been reorganized, and
152 * will also catch preferred disk names if multiple paths exist.
154 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &guid) == 0);
155 if (nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) != 0)
160 for (ne = names; ne != NULL; ne = ne->ne_next) {
161 if (ne->ne_guid == guid) {
162 const char *src, *dst;
170 src = ne->ne_name + strlen(ne->ne_name) - 1;
171 dst = path + strlen(path) - 1;
172 for (count = 0; src >= ne->ne_name && dst >= path;
173 src--, dst--, count++)
178 * At this point, 'count' is the number of characters
179 * matched from the end.
181 if (count > matched || best == NULL) {
191 if (nvlist_add_string(nv, ZPOOL_CONFIG_PATH, best->ne_name) != 0)
194 if ((devid = get_devid(best->ne_name)) == NULL) {
195 (void) nvlist_remove_all(nv, ZPOOL_CONFIG_DEVID);
197 if (nvlist_add_string(nv, ZPOOL_CONFIG_DEVID, devid) != 0)
199 devid_str_free(devid);
206 * Add the given configuration to the list of known devices.
209 add_config(libzfs_handle_t *hdl, pool_list_t *pl, const char *path,
212 uint64_t pool_guid, vdev_guid, top_guid, txg, state;
219 * If this is a hot spare not currently in use or level 2 cache
220 * device, add it to the list of names to translate, but don't do
223 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
225 (state == POOL_STATE_SPARE || state == POOL_STATE_L2CACHE) &&
226 nvlist_lookup_uint64(config, ZPOOL_CONFIG_GUID, &vdev_guid) == 0) {
227 if ((ne = zfs_alloc(hdl, sizeof (name_entry_t))) == NULL)
230 if ((ne->ne_name = zfs_strdup(hdl, path)) == NULL) {
234 ne->ne_guid = vdev_guid;
235 ne->ne_next = pl->names;
241 * If we have a valid config but cannot read any of these fields, then
242 * it means we have a half-initialized label. In vdev_label_init()
243 * we write a label with txg == 0 so that we can identify the device
244 * in case the user refers to the same disk later on. If we fail to
245 * create the pool, we'll be left with a label in this state
246 * which should not be considered part of a valid pool.
248 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
250 nvlist_lookup_uint64(config, ZPOOL_CONFIG_GUID,
252 nvlist_lookup_uint64(config, ZPOOL_CONFIG_TOP_GUID,
254 nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_TXG,
255 &txg) != 0 || txg == 0) {
261 * First, see if we know about this pool. If not, then add it to the
262 * list of known pools.
264 for (pe = pl->pools; pe != NULL; pe = pe->pe_next) {
265 if (pe->pe_guid == pool_guid)
270 if ((pe = zfs_alloc(hdl, sizeof (pool_entry_t))) == NULL) {
274 pe->pe_guid = pool_guid;
275 pe->pe_next = pl->pools;
280 * Second, see if we know about this toplevel vdev. Add it if its
283 for (ve = pe->pe_vdevs; ve != NULL; ve = ve->ve_next) {
284 if (ve->ve_guid == top_guid)
289 if ((ve = zfs_alloc(hdl, sizeof (vdev_entry_t))) == NULL) {
293 ve->ve_guid = top_guid;
294 ve->ve_next = pe->pe_vdevs;
299 * Third, see if we have a config with a matching transaction group. If
300 * so, then we do nothing. Otherwise, add it to the list of known
303 for (ce = ve->ve_configs; ce != NULL; ce = ce->ce_next) {
304 if (ce->ce_txg == txg)
309 if ((ce = zfs_alloc(hdl, sizeof (config_entry_t))) == NULL) {
314 ce->ce_config = config;
315 ce->ce_next = ve->ve_configs;
322 * At this point we've successfully added our config to the list of
323 * known configs. The last thing to do is add the vdev guid -> path
324 * mappings so that we can fix up the configuration as necessary before
327 if ((ne = zfs_alloc(hdl, sizeof (name_entry_t))) == NULL)
330 if ((ne->ne_name = zfs_strdup(hdl, path)) == NULL) {
335 ne->ne_guid = vdev_guid;
336 ne->ne_next = pl->names;
343 * Returns true if the named pool matches the given GUID.
346 pool_active(libzfs_handle_t *hdl, const char *name, uint64_t guid,
352 if (zpool_open_silent(hdl, name, &zhp) != 0)
360 verify(nvlist_lookup_uint64(zhp->zpool_config, ZPOOL_CONFIG_POOL_GUID,
365 *isactive = (theguid == guid);
370 refresh_config(libzfs_handle_t *hdl, nvlist_t *config)
373 zfs_cmd_t zc = { 0 };
376 if (zcmd_write_conf_nvlist(hdl, &zc, config) != 0)
379 if (zcmd_alloc_dst_nvlist(hdl, &zc,
380 zc.zc_nvlist_conf_size * 2) != 0) {
381 zcmd_free_nvlists(&zc);
385 while ((err = ioctl(hdl->libzfs_fd, ZFS_IOC_POOL_TRYIMPORT,
386 &zc)) != 0 && errno == ENOMEM) {
387 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
388 zcmd_free_nvlists(&zc);
394 zcmd_free_nvlists(&zc);
398 if (zcmd_read_dst_nvlist(hdl, &zc, &nvl) != 0) {
399 zcmd_free_nvlists(&zc);
403 zcmd_free_nvlists(&zc);
408 * Determine if the vdev id is a hole in the namespace.
411 vdev_is_hole(uint64_t *hole_array, uint_t holes, uint_t id)
413 for (int c = 0; c < holes; c++) {
415 /* Top-level is a hole */
416 if (hole_array[c] == id)
423 * Convert our list of pools into the definitive set of configurations. We
424 * start by picking the best config for each toplevel vdev. Once that's done,
425 * we assemble the toplevel vdevs into a full config for the pool. We make a
426 * pass to fix up any incorrect paths, and then add it to the main list to
427 * return to the user.
430 get_configs(libzfs_handle_t *hdl, pool_list_t *pl, boolean_t active_ok)
435 nvlist_t *ret = NULL, *config = NULL, *tmp, *nvtop, *nvroot;
436 nvlist_t **spares, **l2cache;
437 uint_t i, nspares, nl2cache;
438 boolean_t config_seen;
440 char *name, *hostname;
443 nvlist_t **child = NULL;
445 uint64_t *hole_array, max_id;
450 boolean_t found_one = B_FALSE;
451 boolean_t valid_top_config = B_FALSE;
453 if (nvlist_alloc(&ret, 0, 0) != 0)
456 for (pe = pl->pools; pe != NULL; pe = pe->pe_next) {
457 uint64_t id, max_txg = 0;
459 if (nvlist_alloc(&config, NV_UNIQUE_NAME, 0) != 0)
461 config_seen = B_FALSE;
464 * Iterate over all toplevel vdevs. Grab the pool configuration
465 * from the first one we find, and then go through the rest and
466 * add them as necessary to the 'vdevs' member of the config.
468 for (ve = pe->pe_vdevs; ve != NULL; ve = ve->ve_next) {
471 * Determine the best configuration for this vdev by
472 * selecting the config with the latest transaction
476 for (ce = ve->ve_configs; ce != NULL;
479 if (ce->ce_txg > best_txg) {
481 best_txg = ce->ce_txg;
486 * We rely on the fact that the max txg for the
487 * pool will contain the most up-to-date information
488 * about the valid top-levels in the vdev namespace.
490 if (best_txg > max_txg) {
491 (void) nvlist_remove(config,
492 ZPOOL_CONFIG_VDEV_CHILDREN,
494 (void) nvlist_remove(config,
495 ZPOOL_CONFIG_HOLE_ARRAY,
496 DATA_TYPE_UINT64_ARRAY);
502 valid_top_config = B_FALSE;
504 if (nvlist_lookup_uint64(tmp,
505 ZPOOL_CONFIG_VDEV_CHILDREN, &max_id) == 0) {
506 verify(nvlist_add_uint64(config,
507 ZPOOL_CONFIG_VDEV_CHILDREN,
509 valid_top_config = B_TRUE;
512 if (nvlist_lookup_uint64_array(tmp,
513 ZPOOL_CONFIG_HOLE_ARRAY, &hole_array,
515 verify(nvlist_add_uint64_array(config,
516 ZPOOL_CONFIG_HOLE_ARRAY,
517 hole_array, holes) == 0);
523 * Copy the relevant pieces of data to the pool
529 * comment (if available)
531 * hostid (if available)
532 * hostname (if available)
534 uint64_t state, version;
535 char *comment = NULL;
537 version = fnvlist_lookup_uint64(tmp,
538 ZPOOL_CONFIG_VERSION);
539 fnvlist_add_uint64(config,
540 ZPOOL_CONFIG_VERSION, version);
541 guid = fnvlist_lookup_uint64(tmp,
542 ZPOOL_CONFIG_POOL_GUID);
543 fnvlist_add_uint64(config,
544 ZPOOL_CONFIG_POOL_GUID, guid);
545 name = fnvlist_lookup_string(tmp,
546 ZPOOL_CONFIG_POOL_NAME);
547 fnvlist_add_string(config,
548 ZPOOL_CONFIG_POOL_NAME, name);
550 if (nvlist_lookup_string(tmp,
551 ZPOOL_CONFIG_COMMENT, &comment) == 0)
552 fnvlist_add_string(config,
553 ZPOOL_CONFIG_COMMENT, comment);
555 state = fnvlist_lookup_uint64(tmp,
556 ZPOOL_CONFIG_POOL_STATE);
557 fnvlist_add_uint64(config,
558 ZPOOL_CONFIG_POOL_STATE, state);
561 if (nvlist_lookup_uint64(tmp,
562 ZPOOL_CONFIG_HOSTID, &hostid) == 0) {
563 fnvlist_add_uint64(config,
564 ZPOOL_CONFIG_HOSTID, hostid);
565 hostname = fnvlist_lookup_string(tmp,
566 ZPOOL_CONFIG_HOSTNAME);
567 fnvlist_add_string(config,
568 ZPOOL_CONFIG_HOSTNAME, hostname);
571 config_seen = B_TRUE;
575 * Add this top-level vdev to the child array.
577 verify(nvlist_lookup_nvlist(tmp,
578 ZPOOL_CONFIG_VDEV_TREE, &nvtop) == 0);
579 verify(nvlist_lookup_uint64(nvtop, ZPOOL_CONFIG_ID,
582 if (id >= children) {
585 newchild = zfs_alloc(hdl, (id + 1) *
586 sizeof (nvlist_t *));
587 if (newchild == NULL)
590 for (c = 0; c < children; c++)
591 newchild[c] = child[c];
597 if (nvlist_dup(nvtop, &child[id], 0) != 0)
603 * If we have information about all the top-levels then
604 * clean up the nvlist which we've constructed. This
605 * means removing any extraneous devices that are
606 * beyond the valid range or adding devices to the end
607 * of our array which appear to be missing.
609 if (valid_top_config) {
610 if (max_id < children) {
611 for (c = max_id; c < children; c++)
612 nvlist_free(child[c]);
614 } else if (max_id > children) {
617 newchild = zfs_alloc(hdl, (max_id) *
618 sizeof (nvlist_t *));
619 if (newchild == NULL)
622 for (c = 0; c < children; c++)
623 newchild[c] = child[c];
631 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
635 * The vdev namespace may contain holes as a result of
636 * device removal. We must add them back into the vdev
637 * tree before we process any missing devices.
640 ASSERT(valid_top_config);
642 for (c = 0; c < children; c++) {
645 if (child[c] != NULL ||
646 !vdev_is_hole(hole_array, holes, c))
649 if (nvlist_alloc(&holey, NV_UNIQUE_NAME,
654 * Holes in the namespace are treated as
655 * "hole" top-level vdevs and have a
656 * special flag set on them.
658 if (nvlist_add_string(holey,
660 VDEV_TYPE_HOLE) != 0 ||
661 nvlist_add_uint64(holey,
662 ZPOOL_CONFIG_ID, c) != 0 ||
663 nvlist_add_uint64(holey,
664 ZPOOL_CONFIG_GUID, 0ULL) != 0)
671 * Look for any missing top-level vdevs. If this is the case,
672 * create a faked up 'missing' vdev as a placeholder. We cannot
673 * simply compress the child array, because the kernel performs
674 * certain checks to make sure the vdev IDs match their location
675 * in the configuration.
677 for (c = 0; c < children; c++) {
678 if (child[c] == NULL) {
680 if (nvlist_alloc(&missing, NV_UNIQUE_NAME,
683 if (nvlist_add_string(missing,
685 VDEV_TYPE_MISSING) != 0 ||
686 nvlist_add_uint64(missing,
687 ZPOOL_CONFIG_ID, c) != 0 ||
688 nvlist_add_uint64(missing,
689 ZPOOL_CONFIG_GUID, 0ULL) != 0) {
690 nvlist_free(missing);
698 * Put all of this pool's top-level vdevs into a root vdev.
700 if (nvlist_alloc(&nvroot, NV_UNIQUE_NAME, 0) != 0)
702 if (nvlist_add_string(nvroot, ZPOOL_CONFIG_TYPE,
703 VDEV_TYPE_ROOT) != 0 ||
704 nvlist_add_uint64(nvroot, ZPOOL_CONFIG_ID, 0ULL) != 0 ||
705 nvlist_add_uint64(nvroot, ZPOOL_CONFIG_GUID, guid) != 0 ||
706 nvlist_add_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN,
707 child, children) != 0) {
712 for (c = 0; c < children; c++)
713 nvlist_free(child[c]);
719 * Go through and fix up any paths and/or devids based on our
720 * known list of vdev GUID -> path mappings.
722 if (fix_paths(nvroot, pl->names) != 0) {
728 * Add the root vdev to this pool's configuration.
730 if (nvlist_add_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
738 * zdb uses this path to report on active pools that were
739 * imported or created using -R.
745 * Determine if this pool is currently active, in which case we
746 * can't actually import it.
748 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
750 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
753 if (pool_active(hdl, name, guid, &isactive) != 0)
762 if ((nvl = refresh_config(hdl, config)) == NULL) {
772 * Go through and update the paths for spares, now that we have
775 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
777 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES,
778 &spares, &nspares) == 0) {
779 for (i = 0; i < nspares; i++) {
780 if (fix_paths(spares[i], pl->names) != 0)
786 * Update the paths for l2cache devices.
788 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_L2CACHE,
789 &l2cache, &nl2cache) == 0) {
790 for (i = 0; i < nl2cache; i++) {
791 if (fix_paths(l2cache[i], pl->names) != 0)
797 * Restore the original information read from the actual label.
799 (void) nvlist_remove(config, ZPOOL_CONFIG_HOSTID,
801 (void) nvlist_remove(config, ZPOOL_CONFIG_HOSTNAME,
804 verify(nvlist_add_uint64(config, ZPOOL_CONFIG_HOSTID,
806 verify(nvlist_add_string(config, ZPOOL_CONFIG_HOSTNAME,
812 * Add this pool to the list of configs.
814 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
816 if (nvlist_add_nvlist(ret, name, config) != 0)
832 (void) no_memory(hdl);
836 for (c = 0; c < children; c++)
837 nvlist_free(child[c]);
844 * Return the offset of the given label.
847 label_offset(uint64_t size, int l)
849 ASSERT(P2PHASE_TYPED(size, sizeof (vdev_label_t), uint64_t) == 0);
850 return (l * sizeof (vdev_label_t) + (l < VDEV_LABELS / 2 ?
851 0 : size - VDEV_LABELS * sizeof (vdev_label_t)));
855 * Given a file descriptor, read the label information and return an nvlist
856 * describing the configuration, if there is one.
859 zpool_read_label(int fd, nvlist_t **config)
861 struct stat64 statbuf;
864 uint64_t state, txg, size;
868 if (fstat64(fd, &statbuf) == -1)
870 size = P2ALIGN_TYPED(statbuf.st_size, sizeof (vdev_label_t), uint64_t);
872 if ((label = malloc(sizeof (vdev_label_t))) == NULL)
875 for (l = 0; l < VDEV_LABELS; l++) {
876 if (pread64(fd, label, sizeof (vdev_label_t),
877 label_offset(size, l)) != sizeof (vdev_label_t))
880 if (nvlist_unpack(label->vl_vdev_phys.vp_nvlist,
881 sizeof (label->vl_vdev_phys.vp_nvlist), config, 0) != 0)
884 if (nvlist_lookup_uint64(*config, ZPOOL_CONFIG_POOL_STATE,
885 &state) != 0 || state > POOL_STATE_L2CACHE) {
886 nvlist_free(*config);
890 if (state != POOL_STATE_SPARE && state != POOL_STATE_L2CACHE &&
891 (nvlist_lookup_uint64(*config, ZPOOL_CONFIG_POOL_TXG,
892 &txg) != 0 || txg == 0)) {
893 nvlist_free(*config);
906 typedef struct rdsk_node {
909 libzfs_handle_t *rn_hdl;
913 boolean_t rn_nozpool;
917 slice_cache_compare(const void *arg1, const void *arg2)
919 const char *nm1 = ((rdsk_node_t *)arg1)->rn_name;
920 const char *nm2 = ((rdsk_node_t *)arg2)->rn_name;
921 char *nm1slice, *nm2slice;
925 * slices zero and two are the most likely to provide results,
928 nm1slice = strstr(nm1, "s0");
929 nm2slice = strstr(nm2, "s0");
930 if (nm1slice && !nm2slice) {
933 if (!nm1slice && nm2slice) {
936 nm1slice = strstr(nm1, "s2");
937 nm2slice = strstr(nm2, "s2");
938 if (nm1slice && !nm2slice) {
941 if (!nm1slice && nm2slice) {
945 rv = strcmp(nm1, nm2);
948 return (rv > 0 ? 1 : -1);
953 check_one_slice(avl_tree_t *r, char *diskname, uint_t partno,
954 diskaddr_t size, uint_t blksz)
958 char sname[MAXNAMELEN];
960 tmpnode.rn_name = &sname[0];
961 (void) snprintf(tmpnode.rn_name, MAXNAMELEN, "%s%u",
964 * protect against division by zero for disk labels that
965 * contain a bogus sector size
969 /* too small to contain a zpool? */
970 if ((size < (SPA_MINDEVSIZE / blksz)) &&
971 (node = avl_find(r, &tmpnode, NULL)))
972 node->rn_nozpool = B_TRUE;
977 nozpool_all_slices(avl_tree_t *r, const char *sname)
980 char diskname[MAXNAMELEN];
984 (void) strncpy(diskname, sname, MAXNAMELEN);
985 if (((ptr = strrchr(diskname, 's')) == NULL) &&
986 ((ptr = strrchr(diskname, 'p')) == NULL))
990 for (i = 0; i < NDKMAP; i++)
991 check_one_slice(r, diskname, i, 0, 1);
993 for (i = 0; i <= FD_NUMPART; i++)
994 check_one_slice(r, diskname, i, 0, 1);
999 check_slices(avl_tree_t *r, int fd, const char *sname)
1002 struct extvtoc vtoc;
1004 char diskname[MAXNAMELEN];
1008 (void) strncpy(diskname, sname, MAXNAMELEN);
1009 if ((ptr = strrchr(diskname, 's')) == NULL || !isdigit(ptr[1]))
1013 if (read_extvtoc(fd, &vtoc) >= 0) {
1014 for (i = 0; i < NDKMAP; i++)
1015 check_one_slice(r, diskname, i,
1016 vtoc.v_part[i].p_size, vtoc.v_sectorsz);
1017 } else if (efi_alloc_and_read(fd, &gpt) >= 0) {
1019 * on x86 we'll still have leftover links that point
1020 * to slices s[9-15], so use NDKMAP instead
1022 for (i = 0; i < NDKMAP; i++)
1023 check_one_slice(r, diskname, i,
1024 gpt->efi_parts[i].p_size, gpt->efi_lbasize);
1025 /* nodes p[1-4] are never used with EFI labels */
1027 for (i = 1; i <= FD_NUMPART; i++)
1028 check_one_slice(r, diskname, i, 0, 1);
1035 zpool_open_func(void *arg)
1037 rdsk_node_t *rn = arg;
1038 struct stat64 statbuf;
1044 if ((fd = openat64(rn->rn_dfd, rn->rn_name, O_RDONLY)) < 0) {
1045 /* symlink to a device that's no longer there */
1046 if (errno == ENOENT)
1047 nozpool_all_slices(rn->rn_avl, rn->rn_name);
1051 * Ignore failed stats. We only want regular
1052 * files, character devs and block devs.
1054 if (fstat64(fd, &statbuf) != 0 ||
1055 (!S_ISREG(statbuf.st_mode) &&
1056 !S_ISCHR(statbuf.st_mode) &&
1057 !S_ISBLK(statbuf.st_mode))) {
1061 /* this file is too small to hold a zpool */
1062 if (S_ISREG(statbuf.st_mode) &&
1063 statbuf.st_size < SPA_MINDEVSIZE) {
1066 } else if (!S_ISREG(statbuf.st_mode)) {
1068 * Try to read the disk label first so we don't have to
1069 * open a bunch of minor nodes that can't have a zpool.
1071 check_slices(rn->rn_avl, fd, rn->rn_name);
1074 if ((zpool_read_label(fd, &config)) != 0) {
1076 (void) no_memory(rn->rn_hdl);
1082 rn->rn_config = config;
1083 if (config != NULL) {
1084 assert(rn->rn_nozpool == B_FALSE);
1089 * Given a file descriptor, clear (zero) the label information. This function
1090 * is used in the appliance stack as part of the ZFS sysevent module and
1091 * to implement the "zpool labelclear" command.
1094 zpool_clear_label(int fd)
1096 struct stat64 statbuf;
1098 vdev_label_t *label;
1101 if (fstat64(fd, &statbuf) == -1)
1103 size = P2ALIGN_TYPED(statbuf.st_size, sizeof (vdev_label_t), uint64_t);
1105 if ((label = calloc(sizeof (vdev_label_t), 1)) == NULL)
1108 for (l = 0; l < VDEV_LABELS; l++) {
1109 if (pwrite64(fd, label, sizeof (vdev_label_t),
1110 label_offset(size, l)) != sizeof (vdev_label_t))
1119 * Given a list of directories to search, find all pools stored on disk. This
1120 * includes partial pools which are not available to import. If no args are
1121 * given (argc is 0), then the default directory (/dev/dsk) is searched.
1122 * poolname or guid (but not both) are provided by the caller when trying
1123 * to import a specific pool.
1126 zpool_find_import_impl(libzfs_handle_t *hdl, importargs_t *iarg)
1128 int i, dirs = iarg->paths;
1130 struct dirent64 *dp;
1131 char path[MAXPATHLEN];
1132 char *end, **dir = iarg->path;
1134 nvlist_t *ret = NULL;
1135 static char *default_dir = "/dev";
1136 pool_list_t pools = { 0 };
1137 pool_entry_t *pe, *penext;
1138 vdev_entry_t *ve, *venext;
1139 config_entry_t *ce, *cenext;
1140 name_entry_t *ne, *nenext;
1141 avl_tree_t slice_cache;
1151 * Go through and read the label configuration information from every
1152 * possible device, organizing the information according to pool GUID
1153 * and toplevel GUID.
1155 for (i = 0; i < dirs; i++) {
1160 /* use realpath to normalize the path */
1161 if (realpath(dir[i], path) == 0) {
1162 (void) zfs_error_fmt(hdl, EZFS_BADPATH,
1163 dgettext(TEXT_DOMAIN, "cannot open '%s'"), dir[i]);
1166 end = &path[strlen(path)];
1169 pathleft = &path[sizeof (path)] - end;
1172 * Using raw devices instead of block devices when we're
1173 * reading the labels skips a bunch of slow operations during
1174 * close(2) processing, so we replace /dev/dsk with /dev/rdsk.
1176 if (strcmp(path, "/dev/dsk/") == 0)
1181 if ((dfd = open64(rdsk, O_RDONLY)) < 0 ||
1182 (dirp = fdopendir(dfd)) == NULL) {
1183 zfs_error_aux(hdl, strerror(errno));
1184 (void) zfs_error_fmt(hdl, EZFS_BADPATH,
1185 dgettext(TEXT_DOMAIN, "cannot open '%s'"),
1190 avl_create(&slice_cache, slice_cache_compare,
1191 sizeof (rdsk_node_t), offsetof(rdsk_node_t, rn_node));
1193 if (strcmp(rdsk, "/dev/") == 0) {
1197 struct gprovider *pp;
1199 errno = geom_gettree(&mesh);
1201 zfs_error_aux(hdl, strerror(errno));
1202 (void) zfs_error_fmt(hdl, EZFS_BADPATH,
1203 dgettext(TEXT_DOMAIN, "cannot get GEOM tree"));
1207 LIST_FOREACH(mp, &mesh.lg_class, lg_class) {
1208 LIST_FOREACH(gp, &mp->lg_geom, lg_geom) {
1209 LIST_FOREACH(pp, &gp->lg_provider, lg_provider) {
1210 slice = zfs_alloc(hdl, sizeof (rdsk_node_t));
1211 slice->rn_name = zfs_strdup(hdl, pp->lg_name);
1212 slice->rn_avl = &slice_cache;
1213 slice->rn_dfd = dfd;
1214 slice->rn_hdl = hdl;
1215 slice->rn_nozpool = B_FALSE;
1216 avl_add(&slice_cache, slice);
1221 geom_deletetree(&mesh);
1226 * This is not MT-safe, but we have no MT consumers of libzfs
1228 while ((dp = readdir64(dirp)) != NULL) {
1229 const char *name = dp->d_name;
1230 if (name[0] == '.' &&
1231 (name[1] == 0 || (name[1] == '.' && name[2] == 0)))
1234 slice = zfs_alloc(hdl, sizeof (rdsk_node_t));
1235 slice->rn_name = zfs_strdup(hdl, name);
1236 slice->rn_avl = &slice_cache;
1237 slice->rn_dfd = dfd;
1238 slice->rn_hdl = hdl;
1239 slice->rn_nozpool = B_FALSE;
1240 avl_add(&slice_cache, slice);
1244 * create a thread pool to do all of this in parallel;
1245 * rn_nozpool is not protected, so this is racy in that
1246 * multiple tasks could decide that the same slice can
1247 * not hold a zpool, which is benign. Also choose
1248 * double the number of processors; we hold a lot of
1249 * locks in the kernel, so going beyond this doesn't
1252 t = tpool_create(1, 2 * sysconf(_SC_NPROCESSORS_ONLN),
1254 for (slice = avl_first(&slice_cache); slice;
1255 (slice = avl_walk(&slice_cache, slice,
1257 (void) tpool_dispatch(t, zpool_open_func, slice);
1262 while ((slice = avl_destroy_nodes(&slice_cache,
1263 &cookie)) != NULL) {
1264 if (slice->rn_config != NULL) {
1265 nvlist_t *config = slice->rn_config;
1266 boolean_t matched = B_TRUE;
1268 if (iarg->poolname != NULL) {
1271 matched = nvlist_lookup_string(config,
1272 ZPOOL_CONFIG_POOL_NAME,
1274 strcmp(iarg->poolname, pname) == 0;
1275 } else if (iarg->guid != 0) {
1278 matched = nvlist_lookup_uint64(config,
1279 ZPOOL_CONFIG_POOL_GUID,
1281 iarg->guid == this_guid;
1284 nvlist_free(config);
1288 /* use the non-raw path for the config */
1289 (void) strlcpy(end, slice->rn_name, pathleft);
1290 if (add_config(hdl, &pools, path, config) != 0)
1293 free(slice->rn_name);
1296 avl_destroy(&slice_cache);
1298 (void) closedir(dirp);
1302 ret = get_configs(hdl, &pools, iarg->can_be_active);
1305 for (pe = pools.pools; pe != NULL; pe = penext) {
1306 penext = pe->pe_next;
1307 for (ve = pe->pe_vdevs; ve != NULL; ve = venext) {
1308 venext = ve->ve_next;
1309 for (ce = ve->ve_configs; ce != NULL; ce = cenext) {
1310 cenext = ce->ce_next;
1312 nvlist_free(ce->ce_config);
1320 for (ne = pools.names; ne != NULL; ne = nenext) {
1321 nenext = ne->ne_next;
1328 (void) closedir(dirp);
1334 zpool_find_import(libzfs_handle_t *hdl, int argc, char **argv)
1336 importargs_t iarg = { 0 };
1341 return (zpool_find_import_impl(hdl, &iarg));
1345 * Given a cache file, return the contents as a list of importable pools.
1346 * poolname or guid (but not both) are provided by the caller when trying
1347 * to import a specific pool.
1350 zpool_find_import_cached(libzfs_handle_t *hdl, const char *cachefile,
1351 char *poolname, uint64_t guid)
1355 struct stat64 statbuf;
1356 nvlist_t *raw, *src, *dst;
1363 verify(poolname == NULL || guid == 0);
1365 if ((fd = open(cachefile, O_RDONLY)) < 0) {
1366 zfs_error_aux(hdl, "%s", strerror(errno));
1367 (void) zfs_error(hdl, EZFS_BADCACHE,
1368 dgettext(TEXT_DOMAIN, "failed to open cache file"));
1372 if (fstat64(fd, &statbuf) != 0) {
1373 zfs_error_aux(hdl, "%s", strerror(errno));
1375 (void) zfs_error(hdl, EZFS_BADCACHE,
1376 dgettext(TEXT_DOMAIN, "failed to get size of cache file"));
1380 if ((buf = zfs_alloc(hdl, statbuf.st_size)) == NULL) {
1385 if (read(fd, buf, statbuf.st_size) != statbuf.st_size) {
1388 (void) zfs_error(hdl, EZFS_BADCACHE,
1389 dgettext(TEXT_DOMAIN,
1390 "failed to read cache file contents"));
1396 if (nvlist_unpack(buf, statbuf.st_size, &raw, 0) != 0) {
1398 (void) zfs_error(hdl, EZFS_BADCACHE,
1399 dgettext(TEXT_DOMAIN,
1400 "invalid or corrupt cache file contents"));
1407 * Go through and get the current state of the pools and refresh their
1410 if (nvlist_alloc(&pools, 0, 0) != 0) {
1411 (void) no_memory(hdl);
1417 while ((elem = nvlist_next_nvpair(raw, elem)) != NULL) {
1418 verify(nvpair_value_nvlist(elem, &src) == 0);
1420 verify(nvlist_lookup_string(src, ZPOOL_CONFIG_POOL_NAME,
1422 if (poolname != NULL && strcmp(poolname, name) != 0)
1425 verify(nvlist_lookup_uint64(src, ZPOOL_CONFIG_POOL_GUID,
1428 verify(nvlist_lookup_uint64(src, ZPOOL_CONFIG_POOL_GUID,
1430 if (guid != this_guid)
1434 if (pool_active(hdl, name, this_guid, &active) != 0) {
1443 if ((dst = refresh_config(hdl, src)) == NULL) {
1449 if (nvlist_add_nvlist(pools, nvpair_name(elem), dst) != 0) {
1450 (void) no_memory(hdl);
1464 name_or_guid_exists(zpool_handle_t *zhp, void *data)
1466 importargs_t *import = data;
1469 if (import->poolname != NULL) {
1472 verify(nvlist_lookup_string(zhp->zpool_config,
1473 ZPOOL_CONFIG_POOL_NAME, &pool_name) == 0);
1474 if (strcmp(pool_name, import->poolname) == 0)
1479 verify(nvlist_lookup_uint64(zhp->zpool_config,
1480 ZPOOL_CONFIG_POOL_GUID, &pool_guid) == 0);
1481 if (pool_guid == import->guid)
1490 zpool_search_import(libzfs_handle_t *hdl, importargs_t *import)
1492 verify(import->poolname == NULL || import->guid == 0);
1495 import->exists = zpool_iter(hdl, name_or_guid_exists, import);
1497 if (import->cachefile != NULL)
1498 return (zpool_find_import_cached(hdl, import->cachefile,
1499 import->poolname, import->guid));
1501 return (zpool_find_import_impl(hdl, import));
1505 find_guid(nvlist_t *nv, uint64_t guid)
1511 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &tmp) == 0);
1515 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1516 &child, &children) == 0) {
1517 for (c = 0; c < children; c++)
1518 if (find_guid(child[c], guid))
1525 typedef struct aux_cbdata {
1526 const char *cb_type;
1528 zpool_handle_t *cb_zhp;
1532 find_aux(zpool_handle_t *zhp, void *data)
1534 aux_cbdata_t *cbp = data;
1540 verify(nvlist_lookup_nvlist(zhp->zpool_config, ZPOOL_CONFIG_VDEV_TREE,
1543 if (nvlist_lookup_nvlist_array(nvroot, cbp->cb_type,
1544 &list, &count) == 0) {
1545 for (i = 0; i < count; i++) {
1546 verify(nvlist_lookup_uint64(list[i],
1547 ZPOOL_CONFIG_GUID, &guid) == 0);
1548 if (guid == cbp->cb_guid) {
1560 * Determines if the pool is in use. If so, it returns true and the state of
1561 * the pool as well as the name of the pool. Both strings are allocated and
1562 * must be freed by the caller.
1565 zpool_in_use(libzfs_handle_t *hdl, int fd, pool_state_t *state, char **namestr,
1571 uint64_t guid, vdev_guid;
1572 zpool_handle_t *zhp;
1573 nvlist_t *pool_config;
1574 uint64_t stateval, isspare;
1575 aux_cbdata_t cb = { 0 };
1580 if (zpool_read_label(fd, &config) != 0) {
1581 (void) no_memory(hdl);
1588 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
1590 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_GUID,
1593 if (stateval != POOL_STATE_SPARE && stateval != POOL_STATE_L2CACHE) {
1594 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
1596 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
1601 case POOL_STATE_EXPORTED:
1603 * A pool with an exported state may in fact be imported
1604 * read-only, so check the in-core state to see if it's
1605 * active and imported read-only. If it is, set
1606 * its state to active.
1608 if (pool_active(hdl, name, guid, &isactive) == 0 && isactive &&
1609 (zhp = zpool_open_canfail(hdl, name)) != NULL &&
1610 zpool_get_prop_int(zhp, ZPOOL_PROP_READONLY, NULL))
1611 stateval = POOL_STATE_ACTIVE;
1616 case POOL_STATE_ACTIVE:
1618 * For an active pool, we have to determine if it's really part
1619 * of a currently active pool (in which case the pool will exist
1620 * and the guid will be the same), or whether it's part of an
1621 * active pool that was disconnected without being explicitly
1624 if (pool_active(hdl, name, guid, &isactive) != 0) {
1625 nvlist_free(config);
1631 * Because the device may have been removed while
1632 * offlined, we only report it as active if the vdev is
1633 * still present in the config. Otherwise, pretend like
1636 if ((zhp = zpool_open_canfail(hdl, name)) != NULL &&
1637 (pool_config = zpool_get_config(zhp, NULL))
1641 verify(nvlist_lookup_nvlist(pool_config,
1642 ZPOOL_CONFIG_VDEV_TREE, &nvroot) == 0);
1643 ret = find_guid(nvroot, vdev_guid);
1649 * If this is an active spare within another pool, we
1650 * treat it like an unused hot spare. This allows the
1651 * user to create a pool with a hot spare that currently
1652 * in use within another pool. Since we return B_TRUE,
1653 * libdiskmgt will continue to prevent generic consumers
1654 * from using the device.
1656 if (ret && nvlist_lookup_uint64(config,
1657 ZPOOL_CONFIG_IS_SPARE, &isspare) == 0 && isspare)
1658 stateval = POOL_STATE_SPARE;
1663 stateval = POOL_STATE_POTENTIALLY_ACTIVE;
1668 case POOL_STATE_SPARE:
1670 * For a hot spare, it can be either definitively in use, or
1671 * potentially active. To determine if it's in use, we iterate
1672 * over all pools in the system and search for one with a spare
1673 * with a matching guid.
1675 * Due to the shared nature of spares, we don't actually report
1676 * the potentially active case as in use. This means the user
1677 * can freely create pools on the hot spares of exported pools,
1678 * but to do otherwise makes the resulting code complicated, and
1679 * we end up having to deal with this case anyway.
1682 cb.cb_guid = vdev_guid;
1683 cb.cb_type = ZPOOL_CONFIG_SPARES;
1684 if (zpool_iter(hdl, find_aux, &cb) == 1) {
1685 name = (char *)zpool_get_name(cb.cb_zhp);
1692 case POOL_STATE_L2CACHE:
1695 * Check if any pool is currently using this l2cache device.
1698 cb.cb_guid = vdev_guid;
1699 cb.cb_type = ZPOOL_CONFIG_L2CACHE;
1700 if (zpool_iter(hdl, find_aux, &cb) == 1) {
1701 name = (char *)zpool_get_name(cb.cb_zhp);
1714 if ((*namestr = zfs_strdup(hdl, name)) == NULL) {
1716 zpool_close(cb.cb_zhp);
1717 nvlist_free(config);
1720 *state = (pool_state_t)stateval;
1724 zpool_close(cb.cb_zhp);
1726 nvlist_free(config);