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.
55 #include <sys/dktp/fdisk.h>
56 #include <sys/efi_partition.h>
58 #include <sys/vdev_impl.h>
60 #include <blkid/blkid.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 {
91 struct name_entry *ne_next;
94 typedef struct pool_list {
100 get_devid(const char *path)
106 if ((fd = open(path, O_RDONLY)) < 0)
111 if (devid_get(fd, &devid) == 0) {
112 if (devid_get_minor_name(fd, &minor) == 0)
113 ret = devid_str_encode(devid, minor);
115 devid_str_free(minor);
125 * Go through and fix up any path and/or devid information for the given vdev
129 fix_paths(nvlist_t *nv, name_entry_t *names)
134 name_entry_t *ne, *best;
137 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
138 &child, &children) == 0) {
139 for (c = 0; c < children; c++)
140 if (fix_paths(child[c], names) != 0)
146 * This is a leaf (file or disk) vdev. In either case, go through
147 * the name list and see if we find a matching guid. If so, replace
148 * the path and see if we can calculate a new devid.
150 * There may be multiple names associated with a particular guid, in
151 * which case we have overlapping partitions or multiple paths to the
152 * same disk. In this case we prefer to use the path name which
153 * matches the ZPOOL_CONFIG_PATH. If no matching entry is found we
154 * use the lowest order device which corresponds to the first match
155 * while traversing the ZPOOL_IMPORT_PATH search path.
157 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &guid) == 0);
158 if (nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) != 0)
162 for (ne = names; ne != NULL; ne = ne->ne_next) {
163 if (ne->ne_guid == guid) {
170 if ((strlen(path) == strlen(ne->ne_name)) &&
171 !strncmp(path, ne->ne_name, strlen(path))) {
176 if (best == NULL || ne->ne_order < best->ne_order)
184 if (nvlist_add_string(nv, ZPOOL_CONFIG_PATH, best->ne_name) != 0)
187 if ((devid = get_devid(best->ne_name)) == NULL) {
188 (void) nvlist_remove_all(nv, ZPOOL_CONFIG_DEVID);
190 if (nvlist_add_string(nv, ZPOOL_CONFIG_DEVID, devid) != 0)
192 devid_str_free(devid);
199 * Add the given configuration to the list of known devices.
202 add_config(libzfs_handle_t *hdl, pool_list_t *pl, const char *path,
203 int order, nvlist_t *config)
205 uint64_t pool_guid, vdev_guid, top_guid, txg, state;
212 * If this is a hot spare not currently in use or level 2 cache
213 * device, add it to the list of names to translate, but don't do
216 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
218 (state == POOL_STATE_SPARE || state == POOL_STATE_L2CACHE) &&
219 nvlist_lookup_uint64(config, ZPOOL_CONFIG_GUID, &vdev_guid) == 0) {
220 if ((ne = zfs_alloc(hdl, sizeof (name_entry_t))) == NULL)
223 if ((ne->ne_name = zfs_strdup(hdl, path)) == NULL) {
227 ne->ne_guid = vdev_guid;
228 ne->ne_order = order;
229 ne->ne_next = pl->names;
235 * If we have a valid config but cannot read any of these fields, then
236 * it means we have a half-initialized label. In vdev_label_init()
237 * we write a label with txg == 0 so that we can identify the device
238 * in case the user refers to the same disk later on. If we fail to
239 * create the pool, we'll be left with a label in this state
240 * which should not be considered part of a valid pool.
242 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
244 nvlist_lookup_uint64(config, ZPOOL_CONFIG_GUID,
246 nvlist_lookup_uint64(config, ZPOOL_CONFIG_TOP_GUID,
248 nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_TXG,
249 &txg) != 0 || txg == 0) {
255 * First, see if we know about this pool. If not, then add it to the
256 * list of known pools.
258 for (pe = pl->pools; pe != NULL; pe = pe->pe_next) {
259 if (pe->pe_guid == pool_guid)
264 if ((pe = zfs_alloc(hdl, sizeof (pool_entry_t))) == NULL) {
268 pe->pe_guid = pool_guid;
269 pe->pe_next = pl->pools;
274 * Second, see if we know about this toplevel vdev. Add it if its
277 for (ve = pe->pe_vdevs; ve != NULL; ve = ve->ve_next) {
278 if (ve->ve_guid == top_guid)
283 if ((ve = zfs_alloc(hdl, sizeof (vdev_entry_t))) == NULL) {
287 ve->ve_guid = top_guid;
288 ve->ve_next = pe->pe_vdevs;
293 * Third, see if we have a config with a matching transaction group. If
294 * so, then we do nothing. Otherwise, add it to the list of known
297 for (ce = ve->ve_configs; ce != NULL; ce = ce->ce_next) {
298 if (ce->ce_txg == txg)
303 if ((ce = zfs_alloc(hdl, sizeof (config_entry_t))) == NULL) {
308 ce->ce_config = config;
309 ce->ce_next = ve->ve_configs;
316 * At this point we've successfully added our config to the list of
317 * known configs. The last thing to do is add the vdev guid -> path
318 * mappings so that we can fix up the configuration as necessary before
321 if ((ne = zfs_alloc(hdl, sizeof (name_entry_t))) == NULL)
324 if ((ne->ne_name = zfs_strdup(hdl, path)) == NULL) {
329 ne->ne_guid = vdev_guid;
330 ne->ne_order = order;
331 ne->ne_next = pl->names;
338 * Returns true if the named pool matches the given GUID.
341 pool_active(libzfs_handle_t *hdl, const char *name, uint64_t guid,
347 if (zpool_open_silent(hdl, name, &zhp) != 0)
355 verify(nvlist_lookup_uint64(zhp->zpool_config, ZPOOL_CONFIG_POOL_GUID,
360 *isactive = (theguid == guid);
365 refresh_config(libzfs_handle_t *hdl, nvlist_t *config)
368 zfs_cmd_t zc = {"\0"};
371 if (zcmd_write_conf_nvlist(hdl, &zc, config) != 0)
374 if (zcmd_alloc_dst_nvlist(hdl, &zc,
375 zc.zc_nvlist_conf_size * 2) != 0) {
376 zcmd_free_nvlists(&zc);
380 while ((err = ioctl(hdl->libzfs_fd, ZFS_IOC_POOL_TRYIMPORT,
381 &zc)) != 0 && errno == ENOMEM) {
382 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
383 zcmd_free_nvlists(&zc);
389 zcmd_free_nvlists(&zc);
393 if (zcmd_read_dst_nvlist(hdl, &zc, &nvl) != 0) {
394 zcmd_free_nvlists(&zc);
398 zcmd_free_nvlists(&zc);
403 * Determine if the vdev id is a hole in the namespace.
406 vdev_is_hole(uint64_t *hole_array, uint_t holes, uint_t id)
410 for (c = 0; c < holes; c++) {
412 /* Top-level is a hole */
413 if (hole_array[c] == id)
420 * Convert our list of pools into the definitive set of configurations. We
421 * start by picking the best config for each toplevel vdev. Once that's done,
422 * we assemble the toplevel vdevs into a full config for the pool. We make a
423 * pass to fix up any incorrect paths, and then add it to the main list to
424 * return to the user.
427 get_configs(libzfs_handle_t *hdl, pool_list_t *pl, boolean_t active_ok)
432 nvlist_t *ret = NULL, *config = NULL, *tmp = NULL, *nvtop, *nvroot;
433 nvlist_t **spares, **l2cache;
434 uint_t i, nspares, nl2cache;
435 boolean_t config_seen;
437 char *name, *hostname = NULL;
440 nvlist_t **child = NULL;
442 uint64_t *hole_array, max_id;
447 boolean_t found_one = B_FALSE;
448 boolean_t valid_top_config = B_FALSE;
450 if (nvlist_alloc(&ret, 0, 0) != 0)
453 for (pe = pl->pools; pe != NULL; pe = pe->pe_next) {
454 uint64_t id, max_txg = 0;
456 if (nvlist_alloc(&config, NV_UNIQUE_NAME, 0) != 0)
458 config_seen = B_FALSE;
461 * Iterate over all toplevel vdevs. Grab the pool configuration
462 * from the first one we find, and then go through the rest and
463 * add them as necessary to the 'vdevs' member of the config.
465 for (ve = pe->pe_vdevs; ve != NULL; ve = ve->ve_next) {
468 * Determine the best configuration for this vdev by
469 * selecting the config with the latest transaction
473 for (ce = ve->ve_configs; ce != NULL;
476 if (ce->ce_txg > best_txg) {
478 best_txg = ce->ce_txg;
483 * We rely on the fact that the max txg for the
484 * pool will contain the most up-to-date information
485 * about the valid top-levels in the vdev namespace.
487 if (best_txg > max_txg) {
488 (void) nvlist_remove(config,
489 ZPOOL_CONFIG_VDEV_CHILDREN,
491 (void) nvlist_remove(config,
492 ZPOOL_CONFIG_HOLE_ARRAY,
493 DATA_TYPE_UINT64_ARRAY);
499 valid_top_config = B_FALSE;
501 if (nvlist_lookup_uint64(tmp,
502 ZPOOL_CONFIG_VDEV_CHILDREN, &max_id) == 0) {
503 verify(nvlist_add_uint64(config,
504 ZPOOL_CONFIG_VDEV_CHILDREN,
506 valid_top_config = B_TRUE;
509 if (nvlist_lookup_uint64_array(tmp,
510 ZPOOL_CONFIG_HOLE_ARRAY, &hole_array,
512 verify(nvlist_add_uint64_array(config,
513 ZPOOL_CONFIG_HOLE_ARRAY,
514 hole_array, holes) == 0);
520 * Copy the relevant pieces of data to the pool
526 * comment (if available)
528 * hostid (if available)
529 * hostname (if available)
531 uint64_t state, version;
532 char *comment = NULL;
534 version = fnvlist_lookup_uint64(tmp,
535 ZPOOL_CONFIG_VERSION);
536 fnvlist_add_uint64(config,
537 ZPOOL_CONFIG_VERSION, version);
538 guid = fnvlist_lookup_uint64(tmp,
539 ZPOOL_CONFIG_POOL_GUID);
540 fnvlist_add_uint64(config,
541 ZPOOL_CONFIG_POOL_GUID, guid);
542 name = fnvlist_lookup_string(tmp,
543 ZPOOL_CONFIG_POOL_NAME);
544 fnvlist_add_string(config,
545 ZPOOL_CONFIG_POOL_NAME, name);
547 if (nvlist_lookup_string(tmp,
548 ZPOOL_CONFIG_COMMENT, &comment) == 0)
549 fnvlist_add_string(config,
550 ZPOOL_CONFIG_COMMENT, comment);
552 state = fnvlist_lookup_uint64(tmp,
553 ZPOOL_CONFIG_POOL_STATE);
554 fnvlist_add_uint64(config,
555 ZPOOL_CONFIG_POOL_STATE, state);
558 if (nvlist_lookup_uint64(tmp,
559 ZPOOL_CONFIG_HOSTID, &hostid) == 0) {
560 fnvlist_add_uint64(config,
561 ZPOOL_CONFIG_HOSTID, hostid);
562 hostname = fnvlist_lookup_string(tmp,
563 ZPOOL_CONFIG_HOSTNAME);
564 fnvlist_add_string(config,
565 ZPOOL_CONFIG_HOSTNAME, hostname);
568 config_seen = B_TRUE;
572 * Add this top-level vdev to the child array.
574 verify(nvlist_lookup_nvlist(tmp,
575 ZPOOL_CONFIG_VDEV_TREE, &nvtop) == 0);
576 verify(nvlist_lookup_uint64(nvtop, ZPOOL_CONFIG_ID,
579 if (id >= children) {
582 newchild = zfs_alloc(hdl, (id + 1) *
583 sizeof (nvlist_t *));
584 if (newchild == NULL)
587 for (c = 0; c < children; c++)
588 newchild[c] = child[c];
594 if (nvlist_dup(nvtop, &child[id], 0) != 0)
600 * If we have information about all the top-levels then
601 * clean up the nvlist which we've constructed. This
602 * means removing any extraneous devices that are
603 * beyond the valid range or adding devices to the end
604 * of our array which appear to be missing.
606 if (valid_top_config) {
607 if (max_id < children) {
608 for (c = max_id; c < children; c++)
609 nvlist_free(child[c]);
611 } else if (max_id > children) {
614 newchild = zfs_alloc(hdl, (max_id) *
615 sizeof (nvlist_t *));
616 if (newchild == NULL)
619 for (c = 0; c < children; c++)
620 newchild[c] = child[c];
628 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
632 * The vdev namespace may contain holes as a result of
633 * device removal. We must add them back into the vdev
634 * tree before we process any missing devices.
637 ASSERT(valid_top_config);
639 for (c = 0; c < children; c++) {
642 if (child[c] != NULL ||
643 !vdev_is_hole(hole_array, holes, c))
646 if (nvlist_alloc(&holey, NV_UNIQUE_NAME,
651 * Holes in the namespace are treated as
652 * "hole" top-level vdevs and have a
653 * special flag set on them.
655 if (nvlist_add_string(holey,
657 VDEV_TYPE_HOLE) != 0 ||
658 nvlist_add_uint64(holey,
659 ZPOOL_CONFIG_ID, c) != 0 ||
660 nvlist_add_uint64(holey,
661 ZPOOL_CONFIG_GUID, 0ULL) != 0)
668 * Look for any missing top-level vdevs. If this is the case,
669 * create a faked up 'missing' vdev as a placeholder. We cannot
670 * simply compress the child array, because the kernel performs
671 * certain checks to make sure the vdev IDs match their location
672 * in the configuration.
674 for (c = 0; c < children; c++) {
675 if (child[c] == NULL) {
677 if (nvlist_alloc(&missing, NV_UNIQUE_NAME,
680 if (nvlist_add_string(missing,
682 VDEV_TYPE_MISSING) != 0 ||
683 nvlist_add_uint64(missing,
684 ZPOOL_CONFIG_ID, c) != 0 ||
685 nvlist_add_uint64(missing,
686 ZPOOL_CONFIG_GUID, 0ULL) != 0) {
687 nvlist_free(missing);
695 * Put all of this pool's top-level vdevs into a root vdev.
697 if (nvlist_alloc(&nvroot, NV_UNIQUE_NAME, 0) != 0)
699 if (nvlist_add_string(nvroot, ZPOOL_CONFIG_TYPE,
700 VDEV_TYPE_ROOT) != 0 ||
701 nvlist_add_uint64(nvroot, ZPOOL_CONFIG_ID, 0ULL) != 0 ||
702 nvlist_add_uint64(nvroot, ZPOOL_CONFIG_GUID, guid) != 0 ||
703 nvlist_add_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN,
704 child, children) != 0) {
709 for (c = 0; c < children; c++)
710 nvlist_free(child[c]);
716 * Go through and fix up any paths and/or devids based on our
717 * known list of vdev GUID -> path mappings.
719 if (fix_paths(nvroot, pl->names) != 0) {
725 * Add the root vdev to this pool's configuration.
727 if (nvlist_add_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
735 * zdb uses this path to report on active pools that were
736 * imported or created using -R.
742 * Determine if this pool is currently active, in which case we
743 * can't actually import it.
745 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
747 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
750 if (pool_active(hdl, name, guid, &isactive) != 0)
759 if ((nvl = refresh_config(hdl, config)) == NULL) {
769 * Go through and update the paths for spares, now that we have
772 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
774 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES,
775 &spares, &nspares) == 0) {
776 for (i = 0; i < nspares; i++) {
777 if (fix_paths(spares[i], pl->names) != 0)
783 * Update the paths for l2cache devices.
785 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_L2CACHE,
786 &l2cache, &nl2cache) == 0) {
787 for (i = 0; i < nl2cache; i++) {
788 if (fix_paths(l2cache[i], pl->names) != 0)
794 * Restore the original information read from the actual label.
796 (void) nvlist_remove(config, ZPOOL_CONFIG_HOSTID,
798 (void) nvlist_remove(config, ZPOOL_CONFIG_HOSTNAME,
801 verify(nvlist_add_uint64(config, ZPOOL_CONFIG_HOSTID,
803 verify(nvlist_add_string(config, ZPOOL_CONFIG_HOSTNAME,
809 * Add this pool to the list of configs.
811 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
813 if (nvlist_add_nvlist(ret, name, config) != 0)
829 (void) no_memory(hdl);
833 for (c = 0; c < children; c++)
834 nvlist_free(child[c]);
841 * Return the offset of the given label.
844 label_offset(uint64_t size, int l)
846 ASSERT(P2PHASE_TYPED(size, sizeof (vdev_label_t), uint64_t) == 0);
847 return (l * sizeof (vdev_label_t) + (l < VDEV_LABELS / 2 ?
848 0 : size - VDEV_LABELS * sizeof (vdev_label_t)));
852 * Given a file descriptor, read the label information and return an nvlist
853 * describing the configuration, if there is one.
856 zpool_read_label(int fd, nvlist_t **config)
858 struct stat64 statbuf;
861 uint64_t state, txg, size;
865 if (fstat64_blk(fd, &statbuf) == -1)
867 size = P2ALIGN_TYPED(statbuf.st_size, sizeof (vdev_label_t), uint64_t);
869 if ((label = malloc(sizeof (vdev_label_t))) == NULL)
872 for (l = 0; l < VDEV_LABELS; l++) {
873 if (pread64(fd, label, sizeof (vdev_label_t),
874 label_offset(size, l)) != sizeof (vdev_label_t))
877 if (nvlist_unpack(label->vl_vdev_phys.vp_nvlist,
878 sizeof (label->vl_vdev_phys.vp_nvlist), config, 0) != 0)
881 if (nvlist_lookup_uint64(*config, ZPOOL_CONFIG_POOL_STATE,
882 &state) != 0 || state > POOL_STATE_L2CACHE) {
883 nvlist_free(*config);
887 if (state != POOL_STATE_SPARE && state != POOL_STATE_L2CACHE &&
888 (nvlist_lookup_uint64(*config, ZPOOL_CONFIG_POOL_TXG,
889 &txg) != 0 || txg == 0)) {
890 nvlist_free(*config);
904 * Given a file descriptor, clear (zero) the label information. This function
905 * is used in the appliance stack as part of the ZFS sysevent module and
906 * to implement the "zpool labelclear" command.
909 zpool_clear_label(int fd)
911 struct stat64 statbuf;
916 if (fstat64_blk(fd, &statbuf) == -1)
918 size = P2ALIGN_TYPED(statbuf.st_size, sizeof (vdev_label_t), uint64_t);
920 if ((label = calloc(sizeof (vdev_label_t), 1)) == NULL)
923 for (l = 0; l < VDEV_LABELS; l++) {
924 if (pwrite64(fd, label, sizeof (vdev_label_t),
925 label_offset(size, l)) != sizeof (vdev_label_t))
935 * Use libblkid to quickly search for zfs devices
938 zpool_find_import_blkid(libzfs_handle_t *hdl, pool_list_t *pools)
941 blkid_dev_iterate iter;
947 err = blkid_get_cache(&cache, NULL);
949 (void) zfs_error_fmt(hdl, EZFS_BADCACHE,
950 dgettext(TEXT_DOMAIN, "blkid_get_cache() %d"), err);
954 err = blkid_probe_all(cache);
956 (void) zfs_error_fmt(hdl, EZFS_BADCACHE,
957 dgettext(TEXT_DOMAIN, "blkid_probe_all() %d"), err);
961 iter = blkid_dev_iterate_begin(cache);
963 (void) zfs_error_fmt(hdl, EZFS_BADCACHE,
964 dgettext(TEXT_DOMAIN, "blkid_dev_iterate_begin()"));
968 err = blkid_dev_set_search(iter, "TYPE", "zfs_member");
970 (void) zfs_error_fmt(hdl, EZFS_BADCACHE,
971 dgettext(TEXT_DOMAIN, "blkid_dev_set_search() %d"), err);
975 while (blkid_dev_next(iter, &dev) == 0) {
976 devname = blkid_dev_devname(dev);
977 if ((fd = open64(devname, O_RDONLY)) < 0)
980 err = zpool_read_label(fd, &config);
984 (void) no_memory(hdl);
988 if (config != NULL) {
989 err = add_config(hdl, pools, devname, 0, config);
996 blkid_dev_iterate_end(iter);
998 blkid_put_cache(cache);
1002 #endif /* HAVE_LIBBLKID */
1005 zpool_default_import_path[DEFAULT_IMPORT_PATH_SIZE] = {
1006 "/dev/disk/by-vdev", /* Custom rules, use first if they exist */
1007 "/dev/mapper", /* Use multipath devices before components */
1008 "/dev/disk/by-uuid", /* Single unique entry and persistent */
1009 "/dev/disk/by-id", /* May be multiple entries and persistent */
1010 "/dev/disk/by-path", /* Encodes physical location and persistent */
1011 "/dev/disk/by-label", /* Custom persistent labels */
1012 "/dev" /* UNSAFE device names will change */
1016 * Given a list of directories to search, find all pools stored on disk. This
1017 * includes partial pools which are not available to import. If no args are
1018 * given (argc is 0), then the default directory (/dev/dsk) is searched.
1019 * poolname or guid (but not both) are provided by the caller when trying
1020 * to import a specific pool.
1023 zpool_find_import_impl(libzfs_handle_t *hdl, importargs_t *iarg)
1025 int i, dirs = iarg->paths;
1027 struct dirent64 *dp;
1028 char path[MAXPATHLEN];
1029 char *end, **dir = iarg->path;
1031 struct stat64 statbuf;
1032 nvlist_t *ret = NULL, *config;
1034 pool_list_t pools = { 0 };
1035 pool_entry_t *pe, *penext;
1036 vdev_entry_t *ve, *venext;
1037 config_entry_t *ce, *cenext;
1038 name_entry_t *ne, *nenext;
1040 verify(iarg->poolname == NULL || iarg->guid == 0);
1043 #ifdef HAVE_LIBBLKID
1044 /* Use libblkid to scan all device for their type */
1045 if (zpool_find_import_blkid(hdl, &pools) == 0)
1048 (void) zfs_error_fmt(hdl, EZFS_BADCACHE,
1049 dgettext(TEXT_DOMAIN, "blkid failure falling back "
1050 "to manual probing"));
1051 #endif /* HAVE_LIBBLKID */
1053 dir = zpool_default_import_path;
1054 dirs = DEFAULT_IMPORT_PATH_SIZE;
1058 * Go through and read the label configuration information from every
1059 * possible device, organizing the information according to pool GUID
1060 * and toplevel GUID.
1062 for (i = 0; i < dirs; i++) {
1066 /* use realpath to normalize the path */
1067 if (realpath(dir[i], path) == 0) {
1069 /* it is safe to skip missing search paths */
1070 if (errno == ENOENT)
1073 zfs_error_aux(hdl, strerror(errno));
1074 (void) zfs_error_fmt(hdl, EZFS_BADPATH,
1075 dgettext(TEXT_DOMAIN, "cannot open '%s'"), dir[i]);
1078 end = &path[strlen(path)];
1081 pathleft = &path[sizeof (path)] - end;
1084 * Using raw devices instead of block devices when we're
1085 * reading the labels skips a bunch of slow operations during
1086 * close(2) processing, so we replace /dev/dsk with /dev/rdsk.
1088 if (strcmp(path, "/dev/dsk/") == 0)
1089 rdsk = "/dev/rdsk/";
1093 if ((dfd = open64(rdsk, O_RDONLY)) < 0 ||
1094 (dirp = fdopendir(dfd)) == NULL) {
1095 zfs_error_aux(hdl, strerror(errno));
1096 (void) zfs_error_fmt(hdl, EZFS_BADPATH,
1097 dgettext(TEXT_DOMAIN, "cannot open '%s'"),
1103 * This is not MT-safe, but we have no MT consumers of libzfs
1105 while ((dp = readdir64(dirp)) != NULL) {
1106 const char *name = dp->d_name;
1107 if (name[0] == '.' &&
1108 (name[1] == 0 || (name[1] == '.' && name[2] == 0)))
1112 * Skip checking devices with well known prefixes:
1113 * watchdog - A special close is required to avoid
1114 * triggering it and resetting the system.
1115 * fuse - Fuse control device.
1116 * ppp - Generic PPP driver.
1117 * tty* - Generic serial interface.
1118 * vcs* - Virtual console memory.
1119 * parport* - Parallel port interface.
1120 * lp* - Printer interface.
1121 * fd* - Floppy interface.
1122 * hpet - High Precision Event Timer, crashes qemu
1123 * when accessed from a virtual machine.
1124 * core - Symlink to /proc/kcore, causes a crash
1125 * when access from Xen dom0.
1127 if ((strncmp(name, "watchdog", 8) == 0) ||
1128 (strncmp(name, "fuse", 4) == 0) ||
1129 (strncmp(name, "ppp", 3) == 0) ||
1130 (strncmp(name, "tty", 3) == 0) ||
1131 (strncmp(name, "vcs", 3) == 0) ||
1132 (strncmp(name, "parport", 7) == 0) ||
1133 (strncmp(name, "lp", 2) == 0) ||
1134 (strncmp(name, "fd", 2) == 0) ||
1135 (strncmp(name, "hpet", 4) == 0) ||
1136 (strncmp(name, "core", 4) == 0))
1140 * Ignore failed stats. We only want regular
1141 * files and block devices.
1143 if ((fstatat64(dfd, name, &statbuf, 0) != 0) ||
1144 (!S_ISREG(statbuf.st_mode) &&
1145 !S_ISBLK(statbuf.st_mode)))
1148 if ((fd = openat64(dfd, name, O_RDONLY)) < 0)
1151 if ((zpool_read_label(fd, &config)) != 0) {
1153 (void) no_memory(hdl);
1159 if (config != NULL) {
1160 boolean_t matched = B_TRUE;
1163 if ((iarg->poolname != NULL) &&
1164 (nvlist_lookup_string(config,
1165 ZPOOL_CONFIG_POOL_NAME, &pname) == 0)) {
1167 if (strcmp(iarg->poolname, pname))
1170 } else if (iarg->guid != 0) {
1173 matched = nvlist_lookup_uint64(config,
1174 ZPOOL_CONFIG_POOL_GUID,
1176 iarg->guid == this_guid;
1179 nvlist_free(config);
1183 /* use the non-raw path for the config */
1184 (void) strlcpy(end, name, pathleft);
1185 if (add_config(hdl, &pools, path, i+1, config))
1190 (void) closedir(dirp);
1194 #ifdef HAVE_LIBBLKID
1197 ret = get_configs(hdl, &pools, iarg->can_be_active);
1200 for (pe = pools.pools; pe != NULL; pe = penext) {
1201 penext = pe->pe_next;
1202 for (ve = pe->pe_vdevs; ve != NULL; ve = venext) {
1203 venext = ve->ve_next;
1204 for (ce = ve->ve_configs; ce != NULL; ce = cenext) {
1205 cenext = ce->ce_next;
1207 nvlist_free(ce->ce_config);
1215 for (ne = pools.names; ne != NULL; ne = nenext) {
1216 nenext = ne->ne_next;
1223 (void) closedir(dirp);
1229 zpool_find_import(libzfs_handle_t *hdl, int argc, char **argv)
1231 importargs_t iarg = { 0 };
1236 return (zpool_find_import_impl(hdl, &iarg));
1240 * Given a cache file, return the contents as a list of importable pools.
1241 * poolname or guid (but not both) are provided by the caller when trying
1242 * to import a specific pool.
1245 zpool_find_import_cached(libzfs_handle_t *hdl, const char *cachefile,
1246 char *poolname, uint64_t guid)
1250 struct stat64 statbuf;
1251 nvlist_t *raw, *src, *dst;
1258 verify(poolname == NULL || guid == 0);
1260 if ((fd = open(cachefile, O_RDONLY)) < 0) {
1261 zfs_error_aux(hdl, "%s", strerror(errno));
1262 (void) zfs_error(hdl, EZFS_BADCACHE,
1263 dgettext(TEXT_DOMAIN, "failed to open cache file"));
1267 if (fstat64(fd, &statbuf) != 0) {
1268 zfs_error_aux(hdl, "%s", strerror(errno));
1270 (void) zfs_error(hdl, EZFS_BADCACHE,
1271 dgettext(TEXT_DOMAIN, "failed to get size of cache file"));
1275 if ((buf = zfs_alloc(hdl, statbuf.st_size)) == NULL) {
1280 if (read(fd, buf, statbuf.st_size) != statbuf.st_size) {
1283 (void) zfs_error(hdl, EZFS_BADCACHE,
1284 dgettext(TEXT_DOMAIN,
1285 "failed to read cache file contents"));
1291 if (nvlist_unpack(buf, statbuf.st_size, &raw, 0) != 0) {
1293 (void) zfs_error(hdl, EZFS_BADCACHE,
1294 dgettext(TEXT_DOMAIN,
1295 "invalid or corrupt cache file contents"));
1302 * Go through and get the current state of the pools and refresh their
1305 if (nvlist_alloc(&pools, 0, 0) != 0) {
1306 (void) no_memory(hdl);
1312 while ((elem = nvlist_next_nvpair(raw, elem)) != NULL) {
1313 verify(nvpair_value_nvlist(elem, &src) == 0);
1315 verify(nvlist_lookup_string(src, ZPOOL_CONFIG_POOL_NAME,
1317 if (poolname != NULL && strcmp(poolname, name) != 0)
1320 verify(nvlist_lookup_uint64(src, ZPOOL_CONFIG_POOL_GUID,
1323 verify(nvlist_lookup_uint64(src, ZPOOL_CONFIG_POOL_GUID,
1325 if (guid != this_guid)
1329 if (pool_active(hdl, name, this_guid, &active) != 0) {
1338 if ((dst = refresh_config(hdl, src)) == NULL) {
1344 if (nvlist_add_nvlist(pools, nvpair_name(elem), dst) != 0) {
1345 (void) no_memory(hdl);
1359 name_or_guid_exists(zpool_handle_t *zhp, void *data)
1361 importargs_t *import = data;
1364 if (import->poolname != NULL) {
1367 verify(nvlist_lookup_string(zhp->zpool_config,
1368 ZPOOL_CONFIG_POOL_NAME, &pool_name) == 0);
1369 if (strcmp(pool_name, import->poolname) == 0)
1374 verify(nvlist_lookup_uint64(zhp->zpool_config,
1375 ZPOOL_CONFIG_POOL_GUID, &pool_guid) == 0);
1376 if (pool_guid == import->guid)
1385 zpool_search_import(libzfs_handle_t *hdl, importargs_t *import)
1387 verify(import->poolname == NULL || import->guid == 0);
1390 import->exists = zpool_iter(hdl, name_or_guid_exists, import);
1392 if (import->cachefile != NULL)
1393 return (zpool_find_import_cached(hdl, import->cachefile,
1394 import->poolname, import->guid));
1396 return (zpool_find_import_impl(hdl, import));
1400 find_guid(nvlist_t *nv, uint64_t guid)
1406 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &tmp) == 0);
1410 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1411 &child, &children) == 0) {
1412 for (c = 0; c < children; c++)
1413 if (find_guid(child[c], guid))
1420 typedef struct aux_cbdata {
1421 const char *cb_type;
1423 zpool_handle_t *cb_zhp;
1427 find_aux(zpool_handle_t *zhp, void *data)
1429 aux_cbdata_t *cbp = data;
1435 verify(nvlist_lookup_nvlist(zhp->zpool_config, ZPOOL_CONFIG_VDEV_TREE,
1438 if (nvlist_lookup_nvlist_array(nvroot, cbp->cb_type,
1439 &list, &count) == 0) {
1440 for (i = 0; i < count; i++) {
1441 verify(nvlist_lookup_uint64(list[i],
1442 ZPOOL_CONFIG_GUID, &guid) == 0);
1443 if (guid == cbp->cb_guid) {
1455 * Determines if the pool is in use. If so, it returns true and the state of
1456 * the pool as well as the name of the pool. Both strings are allocated and
1457 * must be freed by the caller.
1460 zpool_in_use(libzfs_handle_t *hdl, int fd, pool_state_t *state, char **namestr,
1466 uint64_t guid, vdev_guid;
1467 zpool_handle_t *zhp;
1468 nvlist_t *pool_config;
1469 uint64_t stateval, isspare;
1470 aux_cbdata_t cb = { 0 };
1475 if (zpool_read_label(fd, &config) != 0) {
1476 (void) no_memory(hdl);
1483 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
1485 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_GUID,
1488 if (stateval != POOL_STATE_SPARE && stateval != POOL_STATE_L2CACHE) {
1489 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
1491 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
1496 case POOL_STATE_EXPORTED:
1498 * A pool with an exported state may in fact be imported
1499 * read-only, so check the in-core state to see if it's
1500 * active and imported read-only. If it is, set
1501 * its state to active.
1503 if (pool_active(hdl, name, guid, &isactive) == 0 && isactive &&
1504 (zhp = zpool_open_canfail(hdl, name)) != NULL &&
1505 zpool_get_prop_int(zhp, ZPOOL_PROP_READONLY, NULL))
1506 stateval = POOL_STATE_ACTIVE;
1511 case POOL_STATE_ACTIVE:
1513 * For an active pool, we have to determine if it's really part
1514 * of a currently active pool (in which case the pool will exist
1515 * and the guid will be the same), or whether it's part of an
1516 * active pool that was disconnected without being explicitly
1519 if (pool_active(hdl, name, guid, &isactive) != 0) {
1520 nvlist_free(config);
1526 * Because the device may have been removed while
1527 * offlined, we only report it as active if the vdev is
1528 * still present in the config. Otherwise, pretend like
1531 if ((zhp = zpool_open_canfail(hdl, name)) != NULL &&
1532 (pool_config = zpool_get_config(zhp, NULL))
1536 verify(nvlist_lookup_nvlist(pool_config,
1537 ZPOOL_CONFIG_VDEV_TREE, &nvroot) == 0);
1538 ret = find_guid(nvroot, vdev_guid);
1544 * If this is an active spare within another pool, we
1545 * treat it like an unused hot spare. This allows the
1546 * user to create a pool with a hot spare that currently
1547 * in use within another pool. Since we return B_TRUE,
1548 * libdiskmgt will continue to prevent generic consumers
1549 * from using the device.
1551 if (ret && nvlist_lookup_uint64(config,
1552 ZPOOL_CONFIG_IS_SPARE, &isspare) == 0 && isspare)
1553 stateval = POOL_STATE_SPARE;
1558 stateval = POOL_STATE_POTENTIALLY_ACTIVE;
1563 case POOL_STATE_SPARE:
1565 * For a hot spare, it can be either definitively in use, or
1566 * potentially active. To determine if it's in use, we iterate
1567 * over all pools in the system and search for one with a spare
1568 * with a matching guid.
1570 * Due to the shared nature of spares, we don't actually report
1571 * the potentially active case as in use. This means the user
1572 * can freely create pools on the hot spares of exported pools,
1573 * but to do otherwise makes the resulting code complicated, and
1574 * we end up having to deal with this case anyway.
1577 cb.cb_guid = vdev_guid;
1578 cb.cb_type = ZPOOL_CONFIG_SPARES;
1579 if (zpool_iter(hdl, find_aux, &cb) == 1) {
1580 name = (char *)zpool_get_name(cb.cb_zhp);
1587 case POOL_STATE_L2CACHE:
1590 * Check if any pool is currently using this l2cache device.
1593 cb.cb_guid = vdev_guid;
1594 cb.cb_type = ZPOOL_CONFIG_L2CACHE;
1595 if (zpool_iter(hdl, find_aux, &cb) == 1) {
1596 name = (char *)zpool_get_name(cb.cb_zhp);
1609 if ((*namestr = zfs_strdup(hdl, name)) == NULL) {
1611 zpool_close(cb.cb_zhp);
1612 nvlist_free(config);
1615 *state = (pool_state_t)stateval;
1619 zpool_close(cb.cb_zhp);
1621 nvlist_free(config);