xref: /titanic_44/usr/src/lib/libzfs/common/libzfs_import.c (revision e5ba14ff435beeefdaa2e6649e175c74afe02c76)
1 /*
2  * CDDL HEADER START
3  *
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.
7  *
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.
12  *
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]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #pragma ident	"%Z%%M%	%I%	%E% SMI"
27 
28 /*
29  * Pool import support functions.
30  *
31  * To import a pool, we rely on reading the configuration information from the
32  * ZFS label of each device.  If we successfully read the label, then we
33  * organize the configuration information in the following hierarchy:
34  *
35  * 	pool guid -> toplevel vdev guid -> label txg
36  *
37  * Duplicate entries matching this same tuple will be discarded.  Once we have
38  * examined every device, we pick the best label txg config for each toplevel
39  * vdev.  We then arrange these toplevel vdevs into a complete pool config, and
40  * update any paths that have changed.  Finally, we attempt to import the pool
41  * using our derived config, and record the results.
42  */
43 
44 #include <devid.h>
45 #include <dirent.h>
46 #include <errno.h>
47 #include <libintl.h>
48 #include <stdlib.h>
49 #include <string.h>
50 #include <sys/stat.h>
51 #include <unistd.h>
52 #include <fcntl.h>
53 
54 #include <sys/vdev_impl.h>
55 
56 #include "libzfs.h"
57 #include "libzfs_impl.h"
58 
59 /*
60  * Intermediate structures used to gather configuration information.
61  */
62 typedef struct config_entry {
63 	uint64_t		ce_txg;
64 	nvlist_t		*ce_config;
65 	struct config_entry	*ce_next;
66 } config_entry_t;
67 
68 typedef struct vdev_entry {
69 	uint64_t		ve_guid;
70 	config_entry_t		*ve_configs;
71 	struct vdev_entry	*ve_next;
72 } vdev_entry_t;
73 
74 typedef struct pool_entry {
75 	uint64_t		pe_guid;
76 	vdev_entry_t		*pe_vdevs;
77 	struct pool_entry	*pe_next;
78 } pool_entry_t;
79 
80 typedef struct name_entry {
81 	char			*ne_name;
82 	uint64_t		ne_guid;
83 	struct name_entry	*ne_next;
84 } name_entry_t;
85 
86 typedef struct pool_list {
87 	pool_entry_t		*pools;
88 	name_entry_t		*names;
89 } pool_list_t;
90 
91 static char *
92 get_devid(const char *path)
93 {
94 	int fd;
95 	ddi_devid_t devid;
96 	char *minor, *ret;
97 
98 	if ((fd = open(path, O_RDONLY)) < 0)
99 		return (NULL);
100 
101 	minor = NULL;
102 	ret = NULL;
103 	if (devid_get(fd, &devid) == 0) {
104 		if (devid_get_minor_name(fd, &minor) == 0)
105 			ret = devid_str_encode(devid, minor);
106 		if (minor != NULL)
107 			devid_str_free(minor);
108 		devid_free(devid);
109 	}
110 	(void) close(fd);
111 
112 	return (ret);
113 }
114 
115 
116 /*
117  * Go through and fix up any path and/or devid information for the given vdev
118  * configuration.
119  */
120 static int
121 fix_paths(nvlist_t *nv, name_entry_t *names)
122 {
123 	nvlist_t **child;
124 	uint_t c, children;
125 	uint64_t guid;
126 	name_entry_t *ne, *best;
127 	char *path, *devid;
128 	int matched;
129 
130 	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
131 	    &child, &children) == 0) {
132 		for (c = 0; c < children; c++)
133 			if (fix_paths(child[c], names) != 0)
134 				return (-1);
135 		return (0);
136 	}
137 
138 	/*
139 	 * This is a leaf (file or disk) vdev.  In either case, go through
140 	 * the name list and see if we find a matching guid.  If so, replace
141 	 * the path and see if we can calculate a new devid.
142 	 *
143 	 * There may be multiple names associated with a particular guid, in
144 	 * which case we have overlapping slices or multiple paths to the same
145 	 * disk.  If this is the case, then we want to pick the path that is
146 	 * the most similar to the original, where "most similar" is the number
147 	 * of matching characters starting from the end of the path.  This will
148 	 * preserve slice numbers even if the disks have been reorganized, and
149 	 * will also catch preferred disk names if multiple paths exist.
150 	 */
151 	verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &guid) == 0);
152 	if (nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) != 0)
153 		path = NULL;
154 
155 	matched = 0;
156 	best = NULL;
157 	for (ne = names; ne != NULL; ne = ne->ne_next) {
158 		if (ne->ne_guid == guid) {
159 			const char *src, *dst;
160 			int count;
161 
162 			if (path == NULL) {
163 				best = ne;
164 				break;
165 			}
166 
167 			src = ne->ne_name + strlen(ne->ne_name) - 1;
168 			dst = path + strlen(path) - 1;
169 			for (count = 0; src >= ne->ne_name && dst >= path;
170 			    src--, dst--, count++)
171 				if (*src != *dst)
172 					break;
173 
174 			/*
175 			 * At this point, 'count' is the number of characters
176 			 * matched from the end.
177 			 */
178 			if (count > matched || best == NULL) {
179 				best = ne;
180 				matched = count;
181 			}
182 		}
183 	}
184 
185 	if (best == NULL)
186 		return (0);
187 
188 	if (nvlist_add_string(nv, ZPOOL_CONFIG_PATH, best->ne_name) != 0)
189 		return (-1);
190 
191 	if ((devid = get_devid(best->ne_name)) == NULL) {
192 		(void) nvlist_remove_all(nv, ZPOOL_CONFIG_DEVID);
193 	} else {
194 		if (nvlist_add_string(nv, ZPOOL_CONFIG_DEVID, devid) != 0)
195 			return (-1);
196 		devid_str_free(devid);
197 	}
198 
199 	return (0);
200 }
201 
202 /*
203  * Add the given configuration to the list of known devices.
204  */
205 static int
206 add_config(libzfs_handle_t *hdl, pool_list_t *pl, const char *path,
207     nvlist_t *config)
208 {
209 	uint64_t pool_guid, vdev_guid, top_guid, txg, state;
210 	pool_entry_t *pe;
211 	vdev_entry_t *ve;
212 	config_entry_t *ce;
213 	name_entry_t *ne;
214 
215 	/*
216 	 * If this is a hot spare not currently in use, add it to the list of
217 	 * names to translate, but don't do anything else.
218 	 */
219 	if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
220 	    &state) == 0 && state == POOL_STATE_SPARE &&
221 	    nvlist_lookup_uint64(config, ZPOOL_CONFIG_GUID, &vdev_guid) == 0) {
222 		if ((ne = zfs_alloc(hdl, sizeof (name_entry_t))) == NULL)
223 			return (-1);
224 
225 		if ((ne->ne_name = zfs_strdup(hdl, path)) == NULL) {
226 			free(ne);
227 			return (-1);
228 		}
229 		ne->ne_guid = vdev_guid;
230 		ne->ne_next = pl->names;
231 		pl->names = ne;
232 		return (0);
233 	}
234 
235 	/*
236 	 * If we have a valid config but cannot read any of these fields, then
237 	 * it means we have a half-initialized label.  In vdev_label_init()
238 	 * we write a label with txg == 0 so that we can identify the device
239 	 * in case the user refers to the same disk later on.  If we fail to
240 	 * create the pool, we'll be left with a label in this state
241 	 * which should not be considered part of a valid pool.
242 	 */
243 	if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
244 	    &pool_guid) != 0 ||
245 	    nvlist_lookup_uint64(config, ZPOOL_CONFIG_GUID,
246 	    &vdev_guid) != 0 ||
247 	    nvlist_lookup_uint64(config, ZPOOL_CONFIG_TOP_GUID,
248 	    &top_guid) != 0 ||
249 	    nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_TXG,
250 	    &txg) != 0 || txg == 0) {
251 		nvlist_free(config);
252 		return (0);
253 	}
254 
255 	/*
256 	 * First, see if we know about this pool.  If not, then add it to the
257 	 * list of known pools.
258 	 */
259 	for (pe = pl->pools; pe != NULL; pe = pe->pe_next) {
260 		if (pe->pe_guid == pool_guid)
261 			break;
262 	}
263 
264 	if (pe == NULL) {
265 		if ((pe = zfs_alloc(hdl, sizeof (pool_entry_t))) == NULL) {
266 			nvlist_free(config);
267 			return (-1);
268 		}
269 		pe->pe_guid = pool_guid;
270 		pe->pe_next = pl->pools;
271 		pl->pools = pe;
272 	}
273 
274 	/*
275 	 * Second, see if we know about this toplevel vdev.  Add it if its
276 	 * missing.
277 	 */
278 	for (ve = pe->pe_vdevs; ve != NULL; ve = ve->ve_next) {
279 		if (ve->ve_guid == top_guid)
280 			break;
281 	}
282 
283 	if (ve == NULL) {
284 		if ((ve = zfs_alloc(hdl, sizeof (vdev_entry_t))) == NULL) {
285 			nvlist_free(config);
286 			return (-1);
287 		}
288 		ve->ve_guid = top_guid;
289 		ve->ve_next = pe->pe_vdevs;
290 		pe->pe_vdevs = ve;
291 	}
292 
293 	/*
294 	 * Third, see if we have a config with a matching transaction group.  If
295 	 * so, then we do nothing.  Otherwise, add it to the list of known
296 	 * configs.
297 	 */
298 	for (ce = ve->ve_configs; ce != NULL; ce = ce->ce_next) {
299 		if (ce->ce_txg == txg)
300 			break;
301 	}
302 
303 	if (ce == NULL) {
304 		if ((ce = zfs_alloc(hdl, sizeof (config_entry_t))) == NULL) {
305 			nvlist_free(config);
306 			return (-1);
307 		}
308 		ce->ce_txg = txg;
309 		ce->ce_config = config;
310 		ce->ce_next = ve->ve_configs;
311 		ve->ve_configs = ce;
312 	} else {
313 		nvlist_free(config);
314 	}
315 
316 	/*
317 	 * At this point we've successfully added our config to the list of
318 	 * known configs.  The last thing to do is add the vdev guid -> path
319 	 * mappings so that we can fix up the configuration as necessary before
320 	 * doing the import.
321 	 */
322 	if ((ne = zfs_alloc(hdl, sizeof (name_entry_t))) == NULL)
323 		return (-1);
324 
325 	if ((ne->ne_name = zfs_strdup(hdl, path)) == NULL) {
326 		free(ne);
327 		return (-1);
328 	}
329 
330 	ne->ne_guid = vdev_guid;
331 	ne->ne_next = pl->names;
332 	pl->names = ne;
333 
334 	return (0);
335 }
336 
337 /*
338  * Returns true if the named pool matches the given GUID.
339  */
340 static int
341 pool_active(libzfs_handle_t *hdl, const char *name, uint64_t guid,
342     boolean_t *isactive)
343 {
344 	zpool_handle_t *zhp;
345 	uint64_t theguid;
346 
347 	if (zpool_open_silent(hdl, name, &zhp) != 0)
348 		return (-1);
349 
350 	if (zhp == NULL) {
351 		*isactive = B_FALSE;
352 		return (0);
353 	}
354 
355 	verify(nvlist_lookup_uint64(zhp->zpool_config, ZPOOL_CONFIG_POOL_GUID,
356 	    &theguid) == 0);
357 
358 	zpool_close(zhp);
359 
360 	*isactive = (theguid == guid);
361 	return (0);
362 }
363 
364 /*
365  * Convert our list of pools into the definitive set of configurations.  We
366  * start by picking the best config for each toplevel vdev.  Once that's done,
367  * we assemble the toplevel vdevs into a full config for the pool.  We make a
368  * pass to fix up any incorrect paths, and then add it to the main list to
369  * return to the user.
370  */
371 static nvlist_t *
372 get_configs(libzfs_handle_t *hdl, pool_list_t *pl)
373 {
374 	pool_entry_t *pe;
375 	vdev_entry_t *ve;
376 	config_entry_t *ce;
377 	nvlist_t *ret = NULL, *config = NULL, *tmp, *nvtop, *nvroot;
378 	nvlist_t **spares;
379 	uint_t i, nspares;
380 	boolean_t config_seen;
381 	uint64_t best_txg;
382 	char *name, *hostname;
383 	zfs_cmd_t zc = { 0 };
384 	uint64_t version, guid;
385 	int err;
386 	uint_t children = 0;
387 	nvlist_t **child = NULL;
388 	uint_t c;
389 	boolean_t isactive;
390 	uint64_t hostid;
391 
392 	if (nvlist_alloc(&ret, 0, 0) != 0)
393 		goto nomem;
394 
395 	for (pe = pl->pools; pe != NULL; pe = pe->pe_next) {
396 		uint64_t id;
397 
398 		if (nvlist_alloc(&config, NV_UNIQUE_NAME, 0) != 0)
399 			goto nomem;
400 		config_seen = B_FALSE;
401 
402 		/*
403 		 * Iterate over all toplevel vdevs.  Grab the pool configuration
404 		 * from the first one we find, and then go through the rest and
405 		 * add them as necessary to the 'vdevs' member of the config.
406 		 */
407 		for (ve = pe->pe_vdevs; ve != NULL; ve = ve->ve_next) {
408 
409 			/*
410 			 * Determine the best configuration for this vdev by
411 			 * selecting the config with the latest transaction
412 			 * group.
413 			 */
414 			best_txg = 0;
415 			for (ce = ve->ve_configs; ce != NULL;
416 			    ce = ce->ce_next) {
417 
418 				if (ce->ce_txg > best_txg) {
419 					tmp = ce->ce_config;
420 					best_txg = ce->ce_txg;
421 				}
422 			}
423 
424 			if (!config_seen) {
425 				/*
426 				 * Copy the relevant pieces of data to the pool
427 				 * configuration:
428 				 *
429 				 *	version
430 				 * 	pool guid
431 				 * 	name
432 				 * 	pool state
433 				 *	hostid (if available)
434 				 *	hostname (if available)
435 				 */
436 				uint64_t state;
437 
438 				verify(nvlist_lookup_uint64(tmp,
439 				    ZPOOL_CONFIG_VERSION, &version) == 0);
440 				if (nvlist_add_uint64(config,
441 				    ZPOOL_CONFIG_VERSION, version) != 0)
442 					goto nomem;
443 				verify(nvlist_lookup_uint64(tmp,
444 				    ZPOOL_CONFIG_POOL_GUID, &guid) == 0);
445 				if (nvlist_add_uint64(config,
446 				    ZPOOL_CONFIG_POOL_GUID, guid) != 0)
447 					goto nomem;
448 				verify(nvlist_lookup_string(tmp,
449 				    ZPOOL_CONFIG_POOL_NAME, &name) == 0);
450 				if (nvlist_add_string(config,
451 				    ZPOOL_CONFIG_POOL_NAME, name) != 0)
452 					goto nomem;
453 				verify(nvlist_lookup_uint64(tmp,
454 				    ZPOOL_CONFIG_POOL_STATE, &state) == 0);
455 				if (nvlist_add_uint64(config,
456 				    ZPOOL_CONFIG_POOL_STATE, state) != 0)
457 					goto nomem;
458 				hostid = 0;
459 				if (nvlist_lookup_uint64(tmp,
460 				    ZPOOL_CONFIG_HOSTID, &hostid) == 0) {
461 					if (nvlist_add_uint64(config,
462 					    ZPOOL_CONFIG_HOSTID, hostid) != 0)
463 						goto nomem;
464 					verify(nvlist_lookup_string(tmp,
465 					    ZPOOL_CONFIG_HOSTNAME,
466 					    &hostname) == 0);
467 					if (nvlist_add_string(config,
468 					    ZPOOL_CONFIG_HOSTNAME,
469 					    hostname) != 0)
470 						goto nomem;
471 				}
472 
473 				config_seen = B_TRUE;
474 			}
475 
476 			/*
477 			 * Add this top-level vdev to the child array.
478 			 */
479 			verify(nvlist_lookup_nvlist(tmp,
480 			    ZPOOL_CONFIG_VDEV_TREE, &nvtop) == 0);
481 			verify(nvlist_lookup_uint64(nvtop, ZPOOL_CONFIG_ID,
482 			    &id) == 0);
483 			if (id >= children) {
484 				nvlist_t **newchild;
485 
486 				newchild = zfs_alloc(hdl, (id + 1) *
487 				    sizeof (nvlist_t *));
488 				if (newchild == NULL)
489 					goto nomem;
490 
491 				for (c = 0; c < children; c++)
492 					newchild[c] = child[c];
493 
494 				free(child);
495 				child = newchild;
496 				children = id + 1;
497 			}
498 			if (nvlist_dup(nvtop, &child[id], 0) != 0)
499 				goto nomem;
500 
501 		}
502 
503 		verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
504 		    &guid) == 0);
505 
506 		/*
507 		 * Look for any missing top-level vdevs.  If this is the case,
508 		 * create a faked up 'missing' vdev as a placeholder.  We cannot
509 		 * simply compress the child array, because the kernel performs
510 		 * certain checks to make sure the vdev IDs match their location
511 		 * in the configuration.
512 		 */
513 		for (c = 0; c < children; c++)
514 			if (child[c] == NULL) {
515 				nvlist_t *missing;
516 				if (nvlist_alloc(&missing, NV_UNIQUE_NAME,
517 				    0) != 0)
518 					goto nomem;
519 				if (nvlist_add_string(missing,
520 				    ZPOOL_CONFIG_TYPE,
521 				    VDEV_TYPE_MISSING) != 0 ||
522 				    nvlist_add_uint64(missing,
523 				    ZPOOL_CONFIG_ID, c) != 0 ||
524 				    nvlist_add_uint64(missing,
525 				    ZPOOL_CONFIG_GUID, 0ULL) != 0) {
526 					nvlist_free(missing);
527 					goto nomem;
528 				}
529 				child[c] = missing;
530 			}
531 
532 		/*
533 		 * Put all of this pool's top-level vdevs into a root vdev.
534 		 */
535 		if (nvlist_alloc(&nvroot, NV_UNIQUE_NAME, 0) != 0)
536 			goto nomem;
537 		if (nvlist_add_string(nvroot, ZPOOL_CONFIG_TYPE,
538 		    VDEV_TYPE_ROOT) != 0 ||
539 		    nvlist_add_uint64(nvroot, ZPOOL_CONFIG_ID, 0ULL) != 0 ||
540 		    nvlist_add_uint64(nvroot, ZPOOL_CONFIG_GUID, guid) != 0 ||
541 		    nvlist_add_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN,
542 		    child, children) != 0) {
543 			nvlist_free(nvroot);
544 			goto nomem;
545 		}
546 
547 		for (c = 0; c < children; c++)
548 			nvlist_free(child[c]);
549 		free(child);
550 		children = 0;
551 		child = NULL;
552 
553 		/*
554 		 * Go through and fix up any paths and/or devids based on our
555 		 * known list of vdev GUID -> path mappings.
556 		 */
557 		if (fix_paths(nvroot, pl->names) != 0) {
558 			nvlist_free(nvroot);
559 			goto nomem;
560 		}
561 
562 		/*
563 		 * Add the root vdev to this pool's configuration.
564 		 */
565 		if (nvlist_add_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
566 		    nvroot) != 0) {
567 			nvlist_free(nvroot);
568 			goto nomem;
569 		}
570 		nvlist_free(nvroot);
571 
572 		/*
573 		 * Determine if this pool is currently active, in which case we
574 		 * can't actually import it.
575 		 */
576 		verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
577 		    &name) == 0);
578 		verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
579 		    &guid) == 0);
580 
581 		if (pool_active(hdl, name, guid, &isactive) != 0)
582 			goto error;
583 
584 		if (isactive) {
585 			nvlist_free(config);
586 			config = NULL;
587 			continue;
588 		}
589 
590 		/*
591 		 * Try to do the import in order to get vdev state.
592 		 */
593 		if (zcmd_write_conf_nvlist(hdl, &zc, config) != 0)
594 			goto error;
595 
596 		nvlist_free(config);
597 		config = NULL;
598 
599 		if (zcmd_alloc_dst_nvlist(hdl, &zc,
600 		    zc.zc_nvlist_conf_size * 2) != 0) {
601 			zcmd_free_nvlists(&zc);
602 			goto error;
603 		}
604 
605 		while ((err = ioctl(hdl->libzfs_fd, ZFS_IOC_POOL_TRYIMPORT,
606 		    &zc)) != 0 && errno == ENOMEM) {
607 			if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
608 				zcmd_free_nvlists(&zc);
609 				goto error;
610 			}
611 		}
612 
613 		if (err) {
614 			(void) zpool_standard_error(hdl, errno,
615 			    dgettext(TEXT_DOMAIN, "cannot discover pools"));
616 			zcmd_free_nvlists(&zc);
617 			goto error;
618 		}
619 
620 		if (zcmd_read_dst_nvlist(hdl, &zc, &config) != 0) {
621 			zcmd_free_nvlists(&zc);
622 			goto error;
623 		}
624 
625 		zcmd_free_nvlists(&zc);
626 
627 		/*
628 		 * Go through and update the paths for spares, now that we have
629 		 * them.
630 		 */
631 		verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
632 		    &nvroot) == 0);
633 		if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES,
634 		    &spares, &nspares) == 0) {
635 			for (i = 0; i < nspares; i++) {
636 				if (fix_paths(spares[i], pl->names) != 0)
637 					goto nomem;
638 			}
639 		}
640 
641 		/*
642 		 * Restore the original information read from the actual label.
643 		 */
644 		(void) nvlist_remove(config, ZPOOL_CONFIG_HOSTID,
645 		    DATA_TYPE_UINT64);
646 		(void) nvlist_remove(config, ZPOOL_CONFIG_HOSTNAME,
647 		    DATA_TYPE_STRING);
648 		if (hostid != 0) {
649 			verify(nvlist_add_uint64(config, ZPOOL_CONFIG_HOSTID,
650 			    hostid) == 0);
651 			verify(nvlist_add_string(config, ZPOOL_CONFIG_HOSTNAME,
652 			    hostname) == 0);
653 		}
654 
655 		/*
656 		 * Add this pool to the list of configs.
657 		 */
658 		verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
659 		    &name) == 0);
660 		if (nvlist_add_nvlist(ret, name, config) != 0)
661 			goto nomem;
662 
663 		nvlist_free(config);
664 		config = NULL;
665 	}
666 
667 	return (ret);
668 
669 nomem:
670 	(void) no_memory(hdl);
671 error:
672 	nvlist_free(config);
673 	nvlist_free(ret);
674 	for (c = 0; c < children; c++)
675 		nvlist_free(child[c]);
676 	free(child);
677 
678 	return (NULL);
679 }
680 
681 /*
682  * Return the offset of the given label.
683  */
684 static uint64_t
685 label_offset(uint64_t size, int l)
686 {
687 	ASSERT(P2PHASE_TYPED(size, sizeof (vdev_label_t), uint64_t) == 0);
688 	return (l * sizeof (vdev_label_t) + (l < VDEV_LABELS / 2 ?
689 	    0 : size - VDEV_LABELS * sizeof (vdev_label_t)));
690 }
691 
692 /*
693  * Given a file descriptor, read the label information and return an nvlist
694  * describing the configuration, if there is one.
695  */
696 int
697 zpool_read_label(int fd, nvlist_t **config)
698 {
699 	struct stat64 statbuf;
700 	int l;
701 	vdev_label_t *label;
702 	uint64_t state, txg, size;
703 
704 	*config = NULL;
705 
706 	if (fstat64(fd, &statbuf) == -1)
707 		return (0);
708 	size = P2ALIGN_TYPED(statbuf.st_size, sizeof (vdev_label_t), uint64_t);
709 
710 	if ((label = malloc(sizeof (vdev_label_t))) == NULL)
711 		return (-1);
712 
713 	for (l = 0; l < VDEV_LABELS; l++) {
714 		if (pread(fd, label, sizeof (vdev_label_t),
715 		    label_offset(size, l)) != sizeof (vdev_label_t))
716 			continue;
717 
718 		if (nvlist_unpack(label->vl_vdev_phys.vp_nvlist,
719 		    sizeof (label->vl_vdev_phys.vp_nvlist), config, 0) != 0)
720 			continue;
721 
722 		if (nvlist_lookup_uint64(*config, ZPOOL_CONFIG_POOL_STATE,
723 		    &state) != 0 || state > POOL_STATE_SPARE) {
724 			nvlist_free(*config);
725 			continue;
726 		}
727 
728 		if (state != POOL_STATE_SPARE &&
729 		    (nvlist_lookup_uint64(*config, ZPOOL_CONFIG_POOL_TXG,
730 		    &txg) != 0 || txg == 0)) {
731 			nvlist_free(*config);
732 			continue;
733 		}
734 
735 		free(label);
736 		return (0);
737 	}
738 
739 	free(label);
740 	*config = NULL;
741 	return (0);
742 }
743 
744 /*
745  * Given a list of directories to search, find all pools stored on disk.  This
746  * includes partial pools which are not available to import.  If no args are
747  * given (argc is 0), then the default directory (/dev/dsk) is searched.
748  */
749 nvlist_t *
750 zpool_find_import(libzfs_handle_t *hdl, int argc, char **argv)
751 {
752 	int i;
753 	DIR *dirp = NULL;
754 	struct dirent64 *dp;
755 	char path[MAXPATHLEN];
756 	struct stat64 statbuf;
757 	nvlist_t *ret = NULL, *config;
758 	static char *default_dir = "/dev/dsk";
759 	int fd;
760 	pool_list_t pools = { 0 };
761 	pool_entry_t *pe, *penext;
762 	vdev_entry_t *ve, *venext;
763 	config_entry_t *ce, *cenext;
764 	name_entry_t *ne, *nenext;
765 
766 
767 	if (argc == 0) {
768 		argc = 1;
769 		argv = &default_dir;
770 	}
771 
772 	/*
773 	 * Go through and read the label configuration information from every
774 	 * possible device, organizing the information according to pool GUID
775 	 * and toplevel GUID.
776 	 */
777 	for (i = 0; i < argc; i++) {
778 		if (argv[i][0] != '/') {
779 			(void) zfs_error_fmt(hdl, EZFS_BADPATH,
780 			    dgettext(TEXT_DOMAIN, "cannot open '%s'"),
781 			    argv[i]);
782 			goto error;
783 		}
784 
785 		if ((dirp = opendir(argv[i])) == NULL) {
786 			zfs_error_aux(hdl, strerror(errno));
787 			(void) zfs_error_fmt(hdl, EZFS_BADPATH,
788 			    dgettext(TEXT_DOMAIN, "cannot open '%s'"),
789 			    argv[i]);
790 			goto error;
791 		}
792 
793 		/*
794 		 * This is not MT-safe, but we have no MT consumers of libzfs
795 		 */
796 		while ((dp = readdir64(dirp)) != NULL) {
797 
798 			(void) snprintf(path, sizeof (path), "%s/%s",
799 			    argv[i], dp->d_name);
800 
801 			if (stat64(path, &statbuf) != 0)
802 				continue;
803 
804 			/*
805 			 * Ignore directories (which includes "." and "..").
806 			 */
807 			if (S_ISDIR(statbuf.st_mode))
808 				continue;
809 
810 			/*
811 			 * Ignore special (non-character or non-block) files.
812 			 */
813 			if (!S_ISREG(statbuf.st_mode) &&
814 			    !S_ISBLK(statbuf.st_mode))
815 				continue;
816 
817 			if ((fd = open64(path, O_RDONLY)) < 0)
818 				continue;
819 
820 			if ((zpool_read_label(fd, &config)) != 0) {
821 				(void) close(fd);
822 				(void) no_memory(hdl);
823 				goto error;
824 			}
825 
826 			(void) close(fd);
827 
828 			if (config != NULL)
829 				if (add_config(hdl, &pools, path, config) != 0)
830 					goto error;
831 		}
832 
833 		(void) closedir(dirp);
834 		dirp = NULL;
835 	}
836 
837 	ret = get_configs(hdl, &pools);
838 
839 error:
840 	for (pe = pools.pools; pe != NULL; pe = penext) {
841 		penext = pe->pe_next;
842 		for (ve = pe->pe_vdevs; ve != NULL; ve = venext) {
843 			venext = ve->ve_next;
844 			for (ce = ve->ve_configs; ce != NULL; ce = cenext) {
845 				cenext = ce->ce_next;
846 				if (ce->ce_config)
847 					nvlist_free(ce->ce_config);
848 				free(ce);
849 			}
850 			free(ve);
851 		}
852 		free(pe);
853 	}
854 
855 	for (ne = pools.names; ne != NULL; ne = nenext) {
856 		nenext = ne->ne_next;
857 		if (ne->ne_name)
858 			free(ne->ne_name);
859 		free(ne);
860 	}
861 
862 	if (dirp)
863 		(void) closedir(dirp);
864 
865 	return (ret);
866 }
867 
868 boolean_t
869 find_guid(nvlist_t *nv, uint64_t guid)
870 {
871 	uint64_t tmp;
872 	nvlist_t **child;
873 	uint_t c, children;
874 
875 	verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &tmp) == 0);
876 	if (tmp == guid)
877 		return (B_TRUE);
878 
879 	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
880 	    &child, &children) == 0) {
881 		for (c = 0; c < children; c++)
882 			if (find_guid(child[c], guid))
883 				return (B_TRUE);
884 	}
885 
886 	return (B_FALSE);
887 }
888 
889 typedef struct spare_cbdata {
890 	uint64_t	cb_guid;
891 	zpool_handle_t	*cb_zhp;
892 } spare_cbdata_t;
893 
894 static int
895 find_spare(zpool_handle_t *zhp, void *data)
896 {
897 	spare_cbdata_t *cbp = data;
898 	nvlist_t **spares;
899 	uint_t i, nspares;
900 	uint64_t guid;
901 	nvlist_t *nvroot;
902 
903 	verify(nvlist_lookup_nvlist(zhp->zpool_config, ZPOOL_CONFIG_VDEV_TREE,
904 	    &nvroot) == 0);
905 
906 	if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES,
907 	    &spares, &nspares) == 0) {
908 		for (i = 0; i < nspares; i++) {
909 			verify(nvlist_lookup_uint64(spares[i],
910 			    ZPOOL_CONFIG_GUID, &guid) == 0);
911 			if (guid == cbp->cb_guid) {
912 				cbp->cb_zhp = zhp;
913 				return (1);
914 			}
915 		}
916 	}
917 
918 	zpool_close(zhp);
919 	return (0);
920 }
921 
922 /*
923  * Determines if the pool is in use.  If so, it returns true and the state of
924  * the pool as well as the name of the pool.  Both strings are allocated and
925  * must be freed by the caller.
926  */
927 int
928 zpool_in_use(libzfs_handle_t *hdl, int fd, pool_state_t *state, char **namestr,
929     boolean_t *inuse)
930 {
931 	nvlist_t *config;
932 	char *name;
933 	boolean_t ret;
934 	uint64_t guid, vdev_guid;
935 	zpool_handle_t *zhp;
936 	nvlist_t *pool_config;
937 	uint64_t stateval, isspare;
938 	spare_cbdata_t cb = { 0 };
939 	boolean_t isactive;
940 
941 	*inuse = B_FALSE;
942 
943 	if (zpool_read_label(fd, &config) != 0) {
944 		(void) no_memory(hdl);
945 		return (-1);
946 	}
947 
948 	if (config == NULL)
949 		return (0);
950 
951 	verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
952 	    &stateval) == 0);
953 	verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_GUID,
954 	    &vdev_guid) == 0);
955 
956 	if (stateval != POOL_STATE_SPARE) {
957 		verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
958 		    &name) == 0);
959 		verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
960 		    &guid) == 0);
961 	}
962 
963 	switch (stateval) {
964 	case POOL_STATE_EXPORTED:
965 		ret = B_TRUE;
966 		break;
967 
968 	case POOL_STATE_ACTIVE:
969 		/*
970 		 * For an active pool, we have to determine if it's really part
971 		 * of a currently active pool (in which case the pool will exist
972 		 * and the guid will be the same), or whether it's part of an
973 		 * active pool that was disconnected without being explicitly
974 		 * exported.
975 		 */
976 		if (pool_active(hdl, name, guid, &isactive) != 0) {
977 			nvlist_free(config);
978 			return (-1);
979 		}
980 
981 		if (isactive) {
982 			/*
983 			 * Because the device may have been removed while
984 			 * offlined, we only report it as active if the vdev is
985 			 * still present in the config.  Otherwise, pretend like
986 			 * it's not in use.
987 			 */
988 			if ((zhp = zpool_open_canfail(hdl, name)) != NULL &&
989 			    (pool_config = zpool_get_config(zhp, NULL))
990 			    != NULL) {
991 				nvlist_t *nvroot;
992 
993 				verify(nvlist_lookup_nvlist(pool_config,
994 				    ZPOOL_CONFIG_VDEV_TREE, &nvroot) == 0);
995 				ret = find_guid(nvroot, vdev_guid);
996 			} else {
997 				ret = B_FALSE;
998 			}
999 
1000 			/*
1001 			 * If this is an active spare within another pool, we
1002 			 * treat it like an unused hot spare.  This allows the
1003 			 * user to create a pool with a hot spare that currently
1004 			 * in use within another pool.  Since we return B_TRUE,
1005 			 * libdiskmgt will continue to prevent generic consumers
1006 			 * from using the device.
1007 			 */
1008 			if (ret && nvlist_lookup_uint64(config,
1009 			    ZPOOL_CONFIG_IS_SPARE, &isspare) == 0 && isspare)
1010 				stateval = POOL_STATE_SPARE;
1011 
1012 			if (zhp != NULL)
1013 				zpool_close(zhp);
1014 		} else {
1015 			stateval = POOL_STATE_POTENTIALLY_ACTIVE;
1016 			ret = B_TRUE;
1017 		}
1018 		break;
1019 
1020 	case POOL_STATE_SPARE:
1021 		/*
1022 		 * For a hot spare, it can be either definitively in use, or
1023 		 * potentially active.  To determine if it's in use, we iterate
1024 		 * over all pools in the system and search for one with a spare
1025 		 * with a matching guid.
1026 		 *
1027 		 * Due to the shared nature of spares, we don't actually report
1028 		 * the potentially active case as in use.  This means the user
1029 		 * can freely create pools on the hot spares of exported pools,
1030 		 * but to do otherwise makes the resulting code complicated, and
1031 		 * we end up having to deal with this case anyway.
1032 		 */
1033 		cb.cb_zhp = NULL;
1034 		cb.cb_guid = vdev_guid;
1035 		if (zpool_iter(hdl, find_spare, &cb) == 1) {
1036 			name = (char *)zpool_get_name(cb.cb_zhp);
1037 			ret = TRUE;
1038 		} else {
1039 			ret = FALSE;
1040 		}
1041 		break;
1042 
1043 	default:
1044 		ret = B_FALSE;
1045 	}
1046 
1047 
1048 	if (ret) {
1049 		if ((*namestr = zfs_strdup(hdl, name)) == NULL) {
1050 			nvlist_free(config);
1051 			return (-1);
1052 		}
1053 		*state = (pool_state_t)stateval;
1054 	}
1055 
1056 	if (cb.cb_zhp)
1057 		zpool_close(cb.cb_zhp);
1058 
1059 	nvlist_free(config);
1060 	*inuse = ret;
1061 	return (0);
1062 }
1063