zpool_main.c revision 263393
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/*
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
25 * Copyright (c) 2013 by Delphix. All rights reserved.
26 * Copyright (c) 2012 by Frederik Wessels. All rights reserved.
27 * Copyright (c) 2012 Martin Matuska <mm@FreeBSD.org>. All rights reserved.
28 * Copyright (c) 2013 by Prasad Joshi (sTec). All rights reserved.
29 */
30
31#include <solaris.h>
32#include <assert.h>
33#include <ctype.h>
34#include <dirent.h>
35#include <errno.h>
36#include <fcntl.h>
37#include <libgen.h>
38#include <libintl.h>
39#include <libuutil.h>
40#include <locale.h>
41#include <stdio.h>
42#include <stdlib.h>
43#include <string.h>
44#include <strings.h>
45#include <unistd.h>
46#include <priv.h>
47#include <pwd.h>
48#include <zone.h>
49#include <sys/time.h>
50#include <zfs_prop.h>
51#include <sys/fs/zfs.h>
52#include <sys/stat.h>
53
54#include <libzfs.h>
55
56#include "zpool_util.h"
57#include "zfs_comutil.h"
58#include "zfeature_common.h"
59
60#include "statcommon.h"
61
62static int zpool_do_create(int, char **);
63static int zpool_do_destroy(int, char **);
64
65static int zpool_do_add(int, char **);
66static int zpool_do_remove(int, char **);
67static int zpool_do_labelclear(int, char **);
68
69static int zpool_do_list(int, char **);
70static int zpool_do_iostat(int, char **);
71static int zpool_do_status(int, char **);
72
73static int zpool_do_online(int, char **);
74static int zpool_do_offline(int, char **);
75static int zpool_do_clear(int, char **);
76static int zpool_do_reopen(int, char **);
77
78static int zpool_do_reguid(int, char **);
79
80static int zpool_do_attach(int, char **);
81static int zpool_do_detach(int, char **);
82static int zpool_do_replace(int, char **);
83static int zpool_do_split(int, char **);
84
85static int zpool_do_scrub(int, char **);
86
87static int zpool_do_import(int, char **);
88static int zpool_do_export(int, char **);
89
90static int zpool_do_upgrade(int, char **);
91
92static int zpool_do_history(int, char **);
93
94static int zpool_do_get(int, char **);
95static int zpool_do_set(int, char **);
96
97/*
98 * These libumem hooks provide a reasonable set of defaults for the allocator's
99 * debugging facilities.
100 */
101
102#ifdef DEBUG
103const char *
104_umem_debug_init(void)
105{
106	return ("default,verbose"); /* $UMEM_DEBUG setting */
107}
108
109const char *
110_umem_logging_init(void)
111{
112	return ("fail,contents"); /* $UMEM_LOGGING setting */
113}
114#endif
115
116typedef enum {
117	HELP_ADD,
118	HELP_ATTACH,
119	HELP_CLEAR,
120	HELP_CREATE,
121	HELP_DESTROY,
122	HELP_DETACH,
123	HELP_EXPORT,
124	HELP_HISTORY,
125	HELP_IMPORT,
126	HELP_IOSTAT,
127	HELP_LABELCLEAR,
128	HELP_LIST,
129	HELP_OFFLINE,
130	HELP_ONLINE,
131	HELP_REPLACE,
132	HELP_REMOVE,
133	HELP_SCRUB,
134	HELP_STATUS,
135	HELP_UPGRADE,
136	HELP_GET,
137	HELP_SET,
138	HELP_SPLIT,
139	HELP_REGUID,
140	HELP_REOPEN
141} zpool_help_t;
142
143
144typedef struct zpool_command {
145	const char	*name;
146	int		(*func)(int, char **);
147	zpool_help_t	usage;
148} zpool_command_t;
149
150/*
151 * Master command table.  Each ZFS command has a name, associated function, and
152 * usage message.  The usage messages need to be internationalized, so we have
153 * to have a function to return the usage message based on a command index.
154 *
155 * These commands are organized according to how they are displayed in the usage
156 * message.  An empty command (one with a NULL name) indicates an empty line in
157 * the generic usage message.
158 */
159static zpool_command_t command_table[] = {
160	{ "create",	zpool_do_create,	HELP_CREATE		},
161	{ "destroy",	zpool_do_destroy,	HELP_DESTROY		},
162	{ NULL },
163	{ "add",	zpool_do_add,		HELP_ADD		},
164	{ "remove",	zpool_do_remove,	HELP_REMOVE		},
165	{ NULL },
166	{ "labelclear",	zpool_do_labelclear,	HELP_LABELCLEAR		},
167	{ NULL },
168	{ "list",	zpool_do_list,		HELP_LIST		},
169	{ "iostat",	zpool_do_iostat,	HELP_IOSTAT		},
170	{ "status",	zpool_do_status,	HELP_STATUS		},
171	{ NULL },
172	{ "online",	zpool_do_online,	HELP_ONLINE		},
173	{ "offline",	zpool_do_offline,	HELP_OFFLINE		},
174	{ "clear",	zpool_do_clear,		HELP_CLEAR		},
175	{ "reopen",	zpool_do_reopen,	HELP_REOPEN		},
176	{ NULL },
177	{ "attach",	zpool_do_attach,	HELP_ATTACH		},
178	{ "detach",	zpool_do_detach,	HELP_DETACH		},
179	{ "replace",	zpool_do_replace,	HELP_REPLACE		},
180	{ "split",	zpool_do_split,		HELP_SPLIT		},
181	{ NULL },
182	{ "scrub",	zpool_do_scrub,		HELP_SCRUB		},
183	{ NULL },
184	{ "import",	zpool_do_import,	HELP_IMPORT		},
185	{ "export",	zpool_do_export,	HELP_EXPORT		},
186	{ "upgrade",	zpool_do_upgrade,	HELP_UPGRADE		},
187	{ "reguid",	zpool_do_reguid,	HELP_REGUID		},
188	{ NULL },
189	{ "history",	zpool_do_history,	HELP_HISTORY		},
190	{ "get",	zpool_do_get,		HELP_GET		},
191	{ "set",	zpool_do_set,		HELP_SET		},
192};
193
194#define	NCOMMAND	(sizeof (command_table) / sizeof (command_table[0]))
195
196static zpool_command_t *current_command;
197static char history_str[HIS_MAX_RECORD_LEN];
198static boolean_t log_history = B_TRUE;
199static uint_t timestamp_fmt = NODATE;
200
201static const char *
202get_usage(zpool_help_t idx) {
203	switch (idx) {
204	case HELP_ADD:
205		return (gettext("\tadd [-fn] <pool> <vdev> ...\n"));
206	case HELP_ATTACH:
207		return (gettext("\tattach [-f] <pool> <device> "
208		    "<new-device>\n"));
209	case HELP_CLEAR:
210		return (gettext("\tclear [-nF] <pool> [device]\n"));
211	case HELP_CREATE:
212		return (gettext("\tcreate [-fnd] [-o property=value] ... \n"
213		    "\t    [-O file-system-property=value] ... \n"
214		    "\t    [-m mountpoint] [-R root] <pool> <vdev> ...\n"));
215	case HELP_DESTROY:
216		return (gettext("\tdestroy [-f] <pool>\n"));
217	case HELP_DETACH:
218		return (gettext("\tdetach <pool> <device>\n"));
219	case HELP_EXPORT:
220		return (gettext("\texport [-f] <pool> ...\n"));
221	case HELP_HISTORY:
222		return (gettext("\thistory [-il] [<pool>] ...\n"));
223	case HELP_IMPORT:
224		return (gettext("\timport [-d dir] [-D]\n"
225		    "\timport [-d dir | -c cachefile] [-F [-n]] <pool | id>\n"
226		    "\timport [-o mntopts] [-o property=value] ... \n"
227		    "\t    [-d dir | -c cachefile] [-D] [-f] [-m] [-N] "
228		    "[-R root] [-F [-n]] -a\n"
229		    "\timport [-o mntopts] [-o property=value] ... \n"
230		    "\t    [-d dir | -c cachefile] [-D] [-f] [-m] [-N] "
231		    "[-R root] [-F [-n]]\n"
232		    "\t    <pool | id> [newpool]\n"));
233	case HELP_IOSTAT:
234		return (gettext("\tiostat [-v] [-T d|u] [pool] ... [interval "
235		    "[count]]\n"));
236	case HELP_LABELCLEAR:
237		return (gettext("\tlabelclear [-f] <vdev>\n"));
238	case HELP_LIST:
239		return (gettext("\tlist [-Hv] [-o property[,...]] "
240		    "[-T d|u] [pool] ... [interval [count]]\n"));
241	case HELP_OFFLINE:
242		return (gettext("\toffline [-t] <pool> <device> ...\n"));
243	case HELP_ONLINE:
244		return (gettext("\tonline [-e] <pool> <device> ...\n"));
245	case HELP_REPLACE:
246		return (gettext("\treplace [-f] <pool> <device> "
247		    "[new-device]\n"));
248	case HELP_REMOVE:
249		return (gettext("\tremove <pool> <device> ...\n"));
250	case HELP_REOPEN:
251		return (gettext("\treopen <pool>\n"));
252	case HELP_SCRUB:
253		return (gettext("\tscrub [-s] <pool> ...\n"));
254	case HELP_STATUS:
255		return (gettext("\tstatus [-vx] [-T d|u] [pool] ... [interval "
256		    "[count]]\n"));
257	case HELP_UPGRADE:
258		return (gettext("\tupgrade [-v]\n"
259		    "\tupgrade [-V version] <-a | pool ...>\n"));
260	case HELP_GET:
261		return (gettext("\tget <\"all\" | property[,...]> "
262		    "<pool> ...\n"));
263	case HELP_SET:
264		return (gettext("\tset <property=value> <pool> \n"));
265	case HELP_SPLIT:
266		return (gettext("\tsplit [-n] [-R altroot] [-o mntopts]\n"
267		    "\t    [-o property=value] <pool> <newpool> "
268		    "[<device> ...]\n"));
269	case HELP_REGUID:
270		return (gettext("\treguid <pool>\n"));
271	}
272
273	abort();
274	/* NOTREACHED */
275}
276
277
278/*
279 * Callback routine that will print out a pool property value.
280 */
281static int
282print_prop_cb(int prop, void *cb)
283{
284	FILE *fp = cb;
285
286	(void) fprintf(fp, "\t%-15s  ", zpool_prop_to_name(prop));
287
288	if (zpool_prop_readonly(prop))
289		(void) fprintf(fp, "  NO   ");
290	else
291		(void) fprintf(fp, " YES   ");
292
293	if (zpool_prop_values(prop) == NULL)
294		(void) fprintf(fp, "-\n");
295	else
296		(void) fprintf(fp, "%s\n", zpool_prop_values(prop));
297
298	return (ZPROP_CONT);
299}
300
301/*
302 * Display usage message.  If we're inside a command, display only the usage for
303 * that command.  Otherwise, iterate over the entire command table and display
304 * a complete usage message.
305 */
306void
307usage(boolean_t requested)
308{
309	FILE *fp = requested ? stdout : stderr;
310
311	if (current_command == NULL) {
312		int i;
313
314		(void) fprintf(fp, gettext("usage: zpool command args ...\n"));
315		(void) fprintf(fp,
316		    gettext("where 'command' is one of the following:\n\n"));
317
318		for (i = 0; i < NCOMMAND; i++) {
319			if (command_table[i].name == NULL)
320				(void) fprintf(fp, "\n");
321			else
322				(void) fprintf(fp, "%s",
323				    get_usage(command_table[i].usage));
324		}
325	} else {
326		(void) fprintf(fp, gettext("usage:\n"));
327		(void) fprintf(fp, "%s", get_usage(current_command->usage));
328	}
329
330	if (current_command != NULL &&
331	    ((strcmp(current_command->name, "set") == 0) ||
332	    (strcmp(current_command->name, "get") == 0) ||
333	    (strcmp(current_command->name, "list") == 0))) {
334
335		(void) fprintf(fp,
336		    gettext("\nthe following properties are supported:\n"));
337
338		(void) fprintf(fp, "\n\t%-15s  %s   %s\n\n",
339		    "PROPERTY", "EDIT", "VALUES");
340
341		/* Iterate over all properties */
342		(void) zprop_iter(print_prop_cb, fp, B_FALSE, B_TRUE,
343		    ZFS_TYPE_POOL);
344
345		(void) fprintf(fp, "\t%-15s   ", "feature@...");
346		(void) fprintf(fp, "YES   disabled | enabled | active\n");
347
348		(void) fprintf(fp, gettext("\nThe feature@ properties must be "
349		    "appended with a feature name.\nSee zpool-features(7).\n"));
350	}
351
352	/*
353	 * See comments at end of main().
354	 */
355	if (getenv("ZFS_ABORT") != NULL) {
356		(void) printf("dumping core by request\n");
357		abort();
358	}
359
360	exit(requested ? 0 : 2);
361}
362
363void
364print_vdev_tree(zpool_handle_t *zhp, const char *name, nvlist_t *nv, int indent,
365    boolean_t print_logs)
366{
367	nvlist_t **child;
368	uint_t c, children;
369	char *vname;
370
371	if (name != NULL)
372		(void) printf("\t%*s%s\n", indent, "", name);
373
374	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
375	    &child, &children) != 0)
376		return;
377
378	for (c = 0; c < children; c++) {
379		uint64_t is_log = B_FALSE;
380
381		(void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
382		    &is_log);
383		if ((is_log && !print_logs) || (!is_log && print_logs))
384			continue;
385
386		vname = zpool_vdev_name(g_zfs, zhp, child[c], B_FALSE);
387		print_vdev_tree(zhp, vname, child[c], indent + 2,
388		    B_FALSE);
389		free(vname);
390	}
391}
392
393static boolean_t
394prop_list_contains_feature(nvlist_t *proplist)
395{
396	nvpair_t *nvp;
397	for (nvp = nvlist_next_nvpair(proplist, NULL); NULL != nvp;
398	    nvp = nvlist_next_nvpair(proplist, nvp)) {
399		if (zpool_prop_feature(nvpair_name(nvp)))
400			return (B_TRUE);
401	}
402	return (B_FALSE);
403}
404
405/*
406 * Add a property pair (name, string-value) into a property nvlist.
407 */
408static int
409add_prop_list(const char *propname, char *propval, nvlist_t **props,
410    boolean_t poolprop)
411{
412	zpool_prop_t prop = ZPROP_INVAL;
413	zfs_prop_t fprop;
414	nvlist_t *proplist;
415	const char *normnm;
416	char *strval;
417
418	if (*props == NULL &&
419	    nvlist_alloc(props, NV_UNIQUE_NAME, 0) != 0) {
420		(void) fprintf(stderr,
421		    gettext("internal error: out of memory\n"));
422		return (1);
423	}
424
425	proplist = *props;
426
427	if (poolprop) {
428		const char *vname = zpool_prop_to_name(ZPOOL_PROP_VERSION);
429
430		if ((prop = zpool_name_to_prop(propname)) == ZPROP_INVAL &&
431		    !zpool_prop_feature(propname)) {
432			(void) fprintf(stderr, gettext("property '%s' is "
433			    "not a valid pool property\n"), propname);
434			return (2);
435		}
436
437		/*
438		 * feature@ properties and version should not be specified
439		 * at the same time.
440		 */
441		if ((prop == ZPROP_INVAL && zpool_prop_feature(propname) &&
442		    nvlist_exists(proplist, vname)) ||
443		    (prop == ZPOOL_PROP_VERSION &&
444		    prop_list_contains_feature(proplist))) {
445			(void) fprintf(stderr, gettext("'feature@' and "
446			    "'version' properties cannot be specified "
447			    "together\n"));
448			return (2);
449		}
450
451
452		if (zpool_prop_feature(propname))
453			normnm = propname;
454		else
455			normnm = zpool_prop_to_name(prop);
456	} else {
457		if ((fprop = zfs_name_to_prop(propname)) != ZPROP_INVAL) {
458			normnm = zfs_prop_to_name(fprop);
459		} else {
460			normnm = propname;
461		}
462	}
463
464	if (nvlist_lookup_string(proplist, normnm, &strval) == 0 &&
465	    prop != ZPOOL_PROP_CACHEFILE) {
466		(void) fprintf(stderr, gettext("property '%s' "
467		    "specified multiple times\n"), propname);
468		return (2);
469	}
470
471	if (nvlist_add_string(proplist, normnm, propval) != 0) {
472		(void) fprintf(stderr, gettext("internal "
473		    "error: out of memory\n"));
474		return (1);
475	}
476
477	return (0);
478}
479
480/*
481 * zpool add [-fn] <pool> <vdev> ...
482 *
483 *	-f	Force addition of devices, even if they appear in use
484 *	-n	Do not add the devices, but display the resulting layout if
485 *		they were to be added.
486 *
487 * Adds the given vdevs to 'pool'.  As with create, the bulk of this work is
488 * handled by get_vdev_spec(), which constructs the nvlist needed to pass to
489 * libzfs.
490 */
491int
492zpool_do_add(int argc, char **argv)
493{
494	boolean_t force = B_FALSE;
495	boolean_t dryrun = B_FALSE;
496	int c;
497	nvlist_t *nvroot;
498	char *poolname;
499	int ret;
500	zpool_handle_t *zhp;
501	nvlist_t *config;
502
503	/* check options */
504	while ((c = getopt(argc, argv, "fn")) != -1) {
505		switch (c) {
506		case 'f':
507			force = B_TRUE;
508			break;
509		case 'n':
510			dryrun = B_TRUE;
511			break;
512		case '?':
513			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
514			    optopt);
515			usage(B_FALSE);
516		}
517	}
518
519	argc -= optind;
520	argv += optind;
521
522	/* get pool name and check number of arguments */
523	if (argc < 1) {
524		(void) fprintf(stderr, gettext("missing pool name argument\n"));
525		usage(B_FALSE);
526	}
527	if (argc < 2) {
528		(void) fprintf(stderr, gettext("missing vdev specification\n"));
529		usage(B_FALSE);
530	}
531
532	poolname = argv[0];
533
534	argc--;
535	argv++;
536
537	if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
538		return (1);
539
540	if ((config = zpool_get_config(zhp, NULL)) == NULL) {
541		(void) fprintf(stderr, gettext("pool '%s' is unavailable\n"),
542		    poolname);
543		zpool_close(zhp);
544		return (1);
545	}
546
547	/* pass off to get_vdev_spec for processing */
548	nvroot = make_root_vdev(zhp, force, !force, B_FALSE, dryrun,
549	    argc, argv);
550	if (nvroot == NULL) {
551		zpool_close(zhp);
552		return (1);
553	}
554
555	if (dryrun) {
556		nvlist_t *poolnvroot;
557
558		verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
559		    &poolnvroot) == 0);
560
561		(void) printf(gettext("would update '%s' to the following "
562		    "configuration:\n"), zpool_get_name(zhp));
563
564		/* print original main pool and new tree */
565		print_vdev_tree(zhp, poolname, poolnvroot, 0, B_FALSE);
566		print_vdev_tree(zhp, NULL, nvroot, 0, B_FALSE);
567
568		/* Do the same for the logs */
569		if (num_logs(poolnvroot) > 0) {
570			print_vdev_tree(zhp, "logs", poolnvroot, 0, B_TRUE);
571			print_vdev_tree(zhp, NULL, nvroot, 0, B_TRUE);
572		} else if (num_logs(nvroot) > 0) {
573			print_vdev_tree(zhp, "logs", nvroot, 0, B_TRUE);
574		}
575
576		ret = 0;
577	} else {
578		ret = (zpool_add(zhp, nvroot) != 0);
579	}
580
581	nvlist_free(nvroot);
582	zpool_close(zhp);
583
584	return (ret);
585}
586
587/*
588 * zpool remove  <pool> <vdev> ...
589 *
590 * Removes the given vdev from the pool.  Currently, this supports removing
591 * spares, cache, and log devices from the pool.
592 */
593int
594zpool_do_remove(int argc, char **argv)
595{
596	char *poolname;
597	int i, ret = 0;
598	zpool_handle_t *zhp;
599
600	argc--;
601	argv++;
602
603	/* get pool name and check number of arguments */
604	if (argc < 1) {
605		(void) fprintf(stderr, gettext("missing pool name argument\n"));
606		usage(B_FALSE);
607	}
608	if (argc < 2) {
609		(void) fprintf(stderr, gettext("missing device\n"));
610		usage(B_FALSE);
611	}
612
613	poolname = argv[0];
614
615	if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
616		return (1);
617
618	for (i = 1; i < argc; i++) {
619		if (zpool_vdev_remove(zhp, argv[i]) != 0)
620			ret = 1;
621	}
622
623	return (ret);
624}
625
626/*
627 * zpool labelclear <vdev>
628 *
629 * Verifies that the vdev is not active and zeros out the label information
630 * on the device.
631 */
632int
633zpool_do_labelclear(int argc, char **argv)
634{
635	char *vdev, *name;
636	int c, fd = -1, ret = 0;
637	pool_state_t state;
638	boolean_t inuse = B_FALSE;
639	boolean_t force = B_FALSE;
640
641	/* check options */
642	while ((c = getopt(argc, argv, "f")) != -1) {
643		switch (c) {
644		case 'f':
645			force = B_TRUE;
646			break;
647		default:
648			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
649			    optopt);
650			usage(B_FALSE);
651		}
652	}
653
654	argc -= optind;
655	argv += optind;
656
657	/* get vdev name */
658	if (argc < 1) {
659		(void) fprintf(stderr, gettext("missing vdev device name\n"));
660		usage(B_FALSE);
661	}
662
663	vdev = argv[0];
664	if ((fd = open(vdev, O_RDWR)) < 0) {
665		(void) fprintf(stderr, gettext("Unable to open %s\n"), vdev);
666		return (B_FALSE);
667	}
668
669	name = NULL;
670	if (zpool_in_use(g_zfs, fd, &state, &name, &inuse) != 0) {
671		if (force)
672			goto wipe_label;
673
674		(void) fprintf(stderr,
675		    gettext("Unable to determine pool state for %s\n"
676		    "Use -f to force the clearing any label data\n"), vdev);
677
678		return (1);
679	}
680
681	if (inuse) {
682		switch (state) {
683		default:
684		case POOL_STATE_ACTIVE:
685		case POOL_STATE_SPARE:
686		case POOL_STATE_L2CACHE:
687			(void) fprintf(stderr,
688gettext("labelclear operation failed.\n"
689	"\tVdev %s is a member (%s), of pool \"%s\".\n"
690	"\tTo remove label information from this device, export or destroy\n"
691	"\tthe pool, or remove %s from the configuration of this pool\n"
692	"\tand retry the labelclear operation\n"),
693			    vdev, zpool_pool_state_to_name(state), name, vdev);
694			ret = 1;
695			goto errout;
696
697		case POOL_STATE_EXPORTED:
698			if (force)
699				break;
700
701			(void) fprintf(stderr,
702gettext("labelclear operation failed.\n"
703	"\tVdev %s is a member of the exported pool \"%s\".\n"
704	"\tUse \"zpool labelclear -f %s\" to force the removal of label\n"
705	"\tinformation.\n"),
706			    vdev, name, vdev);
707			ret = 1;
708			goto errout;
709
710		case POOL_STATE_POTENTIALLY_ACTIVE:
711			if (force)
712				break;
713
714			(void) fprintf(stderr,
715gettext("labelclear operation failed.\n"
716	"\tVdev %s is a member of the pool \"%s\".\n"
717	"\tThis pool is unknown to this system, but may be active on\n"
718	"\tanother system. Use \'zpool labelclear -f %s\' to force the\n"
719	"\tremoval of label information.\n"),
720			    vdev, name, vdev);
721			ret = 1;
722			goto errout;
723
724		case POOL_STATE_DESTROYED:
725			/* inuse should never be set for a destoryed pool... */
726			break;
727		}
728	}
729
730wipe_label:
731	if (zpool_clear_label(fd) != 0) {
732		(void) fprintf(stderr,
733		    gettext("Label clear failed on vdev %s\n"), vdev);
734		ret = 1;
735	}
736
737errout:
738	close(fd);
739	if (name != NULL)
740		free(name);
741
742	return (ret);
743}
744
745/*
746 * zpool create [-fnd] [-o property=value] ...
747 *		[-O file-system-property=value] ...
748 *		[-R root] [-m mountpoint] <pool> <dev> ...
749 *
750 *	-f	Force creation, even if devices appear in use
751 *	-n	Do not create the pool, but display the resulting layout if it
752 *		were to be created.
753 *      -R	Create a pool under an alternate root
754 *      -m	Set default mountpoint for the root dataset.  By default it's
755 *		'/<pool>'
756 *	-o	Set property=value.
757 *	-d	Don't automatically enable all supported pool features
758 *		(individual features can be enabled with -o).
759 *	-O	Set fsproperty=value in the pool's root file system
760 *
761 * Creates the named pool according to the given vdev specification.  The
762 * bulk of the vdev processing is done in get_vdev_spec() in zpool_vdev.c.  Once
763 * we get the nvlist back from get_vdev_spec(), we either print out the contents
764 * (if '-n' was specified), or pass it to libzfs to do the creation.
765 */
766int
767zpool_do_create(int argc, char **argv)
768{
769	boolean_t force = B_FALSE;
770	boolean_t dryrun = B_FALSE;
771	boolean_t enable_all_pool_feat = B_TRUE;
772	int c;
773	nvlist_t *nvroot = NULL;
774	char *poolname;
775	int ret = 1;
776	char *altroot = NULL;
777	char *mountpoint = NULL;
778	nvlist_t *fsprops = NULL;
779	nvlist_t *props = NULL;
780	char *propval;
781
782	/* check options */
783	while ((c = getopt(argc, argv, ":fndR:m:o:O:")) != -1) {
784		switch (c) {
785		case 'f':
786			force = B_TRUE;
787			break;
788		case 'n':
789			dryrun = B_TRUE;
790			break;
791		case 'd':
792			enable_all_pool_feat = B_FALSE;
793			break;
794		case 'R':
795			altroot = optarg;
796			if (add_prop_list(zpool_prop_to_name(
797			    ZPOOL_PROP_ALTROOT), optarg, &props, B_TRUE))
798				goto errout;
799			if (nvlist_lookup_string(props,
800			    zpool_prop_to_name(ZPOOL_PROP_CACHEFILE),
801			    &propval) == 0)
802				break;
803			if (add_prop_list(zpool_prop_to_name(
804			    ZPOOL_PROP_CACHEFILE), "none", &props, B_TRUE))
805				goto errout;
806			break;
807		case 'm':
808			/* Equivalent to -O mountpoint=optarg */
809			mountpoint = optarg;
810			break;
811		case 'o':
812			if ((propval = strchr(optarg, '=')) == NULL) {
813				(void) fprintf(stderr, gettext("missing "
814				    "'=' for -o option\n"));
815				goto errout;
816			}
817			*propval = '\0';
818			propval++;
819
820			if (add_prop_list(optarg, propval, &props, B_TRUE))
821				goto errout;
822
823			/*
824			 * If the user is creating a pool that doesn't support
825			 * feature flags, don't enable any features.
826			 */
827			if (zpool_name_to_prop(optarg) == ZPOOL_PROP_VERSION) {
828				char *end;
829				u_longlong_t ver;
830
831				ver = strtoull(propval, &end, 10);
832				if (*end == '\0' &&
833				    ver < SPA_VERSION_FEATURES) {
834					enable_all_pool_feat = B_FALSE;
835				}
836			}
837			break;
838		case 'O':
839			if ((propval = strchr(optarg, '=')) == NULL) {
840				(void) fprintf(stderr, gettext("missing "
841				    "'=' for -O option\n"));
842				goto errout;
843			}
844			*propval = '\0';
845			propval++;
846
847			/*
848			 * Mountpoints are checked and then added later.
849			 * Uniquely among properties, they can be specified
850			 * more than once, to avoid conflict with -m.
851			 */
852			if (0 == strcmp(optarg,
853			    zfs_prop_to_name(ZFS_PROP_MOUNTPOINT))) {
854				mountpoint = propval;
855			} else if (add_prop_list(optarg, propval, &fsprops,
856			    B_FALSE)) {
857				goto errout;
858			}
859			break;
860		case ':':
861			(void) fprintf(stderr, gettext("missing argument for "
862			    "'%c' option\n"), optopt);
863			goto badusage;
864		case '?':
865			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
866			    optopt);
867			goto badusage;
868		}
869	}
870
871	argc -= optind;
872	argv += optind;
873
874	/* get pool name and check number of arguments */
875	if (argc < 1) {
876		(void) fprintf(stderr, gettext("missing pool name argument\n"));
877		goto badusage;
878	}
879	if (argc < 2) {
880		(void) fprintf(stderr, gettext("missing vdev specification\n"));
881		goto badusage;
882	}
883
884	poolname = argv[0];
885
886	/*
887	 * As a special case, check for use of '/' in the name, and direct the
888	 * user to use 'zfs create' instead.
889	 */
890	if (strchr(poolname, '/') != NULL) {
891		(void) fprintf(stderr, gettext("cannot create '%s': invalid "
892		    "character '/' in pool name\n"), poolname);
893		(void) fprintf(stderr, gettext("use 'zfs create' to "
894		    "create a dataset\n"));
895		goto errout;
896	}
897
898	/* pass off to get_vdev_spec for bulk processing */
899	nvroot = make_root_vdev(NULL, force, !force, B_FALSE, dryrun,
900	    argc - 1, argv + 1);
901	if (nvroot == NULL)
902		goto errout;
903
904	/* make_root_vdev() allows 0 toplevel children if there are spares */
905	if (!zfs_allocatable_devs(nvroot)) {
906		(void) fprintf(stderr, gettext("invalid vdev "
907		    "specification: at least one toplevel vdev must be "
908		    "specified\n"));
909		goto errout;
910	}
911
912	if (altroot != NULL && altroot[0] != '/') {
913		(void) fprintf(stderr, gettext("invalid alternate root '%s': "
914		    "must be an absolute path\n"), altroot);
915		goto errout;
916	}
917
918	/*
919	 * Check the validity of the mountpoint and direct the user to use the
920	 * '-m' mountpoint option if it looks like its in use.
921	 * Ignore the checks if the '-f' option is given.
922	 */
923	if (!force && (mountpoint == NULL ||
924	    (strcmp(mountpoint, ZFS_MOUNTPOINT_LEGACY) != 0 &&
925	    strcmp(mountpoint, ZFS_MOUNTPOINT_NONE) != 0))) {
926		char buf[MAXPATHLEN];
927		DIR *dirp;
928
929		if (mountpoint && mountpoint[0] != '/') {
930			(void) fprintf(stderr, gettext("invalid mountpoint "
931			    "'%s': must be an absolute path, 'legacy', or "
932			    "'none'\n"), mountpoint);
933			goto errout;
934		}
935
936		if (mountpoint == NULL) {
937			if (altroot != NULL)
938				(void) snprintf(buf, sizeof (buf), "%s/%s",
939				    altroot, poolname);
940			else
941				(void) snprintf(buf, sizeof (buf), "/%s",
942				    poolname);
943		} else {
944			if (altroot != NULL)
945				(void) snprintf(buf, sizeof (buf), "%s%s",
946				    altroot, mountpoint);
947			else
948				(void) snprintf(buf, sizeof (buf), "%s",
949				    mountpoint);
950		}
951
952		if ((dirp = opendir(buf)) == NULL && errno != ENOENT) {
953			(void) fprintf(stderr, gettext("mountpoint '%s' : "
954			    "%s\n"), buf, strerror(errno));
955			(void) fprintf(stderr, gettext("use '-m' "
956			    "option to provide a different default\n"));
957			goto errout;
958		} else if (dirp) {
959			int count = 0;
960
961			while (count < 3 && readdir(dirp) != NULL)
962				count++;
963			(void) closedir(dirp);
964
965			if (count > 2) {
966				(void) fprintf(stderr, gettext("mountpoint "
967				    "'%s' exists and is not empty\n"), buf);
968				(void) fprintf(stderr, gettext("use '-m' "
969				    "option to provide a "
970				    "different default\n"));
971				goto errout;
972			}
973		}
974	}
975
976	/*
977	 * Now that the mountpoint's validity has been checked, ensure that
978	 * the property is set appropriately prior to creating the pool.
979	 */
980	if (mountpoint != NULL) {
981		ret = add_prop_list(zfs_prop_to_name(ZFS_PROP_MOUNTPOINT),
982		    mountpoint, &fsprops, B_FALSE);
983		if (ret != 0)
984			goto errout;
985	}
986
987	ret = 1;
988	if (dryrun) {
989		/*
990		 * For a dry run invocation, print out a basic message and run
991		 * through all the vdevs in the list and print out in an
992		 * appropriate hierarchy.
993		 */
994		(void) printf(gettext("would create '%s' with the "
995		    "following layout:\n\n"), poolname);
996
997		print_vdev_tree(NULL, poolname, nvroot, 0, B_FALSE);
998		if (num_logs(nvroot) > 0)
999			print_vdev_tree(NULL, "logs", nvroot, 0, B_TRUE);
1000
1001		ret = 0;
1002	} else {
1003		/*
1004		 * Hand off to libzfs.
1005		 */
1006		if (enable_all_pool_feat) {
1007			spa_feature_t i;
1008			for (i = 0; i < SPA_FEATURES; i++) {
1009				char propname[MAXPATHLEN];
1010				zfeature_info_t *feat = &spa_feature_table[i];
1011
1012				(void) snprintf(propname, sizeof (propname),
1013				    "feature@%s", feat->fi_uname);
1014
1015				/*
1016				 * Skip feature if user specified it manually
1017				 * on the command line.
1018				 */
1019				if (nvlist_exists(props, propname))
1020					continue;
1021
1022				ret = add_prop_list(propname,
1023				    ZFS_FEATURE_ENABLED, &props, B_TRUE);
1024				if (ret != 0)
1025					goto errout;
1026			}
1027		}
1028
1029		ret = 1;
1030		if (zpool_create(g_zfs, poolname,
1031		    nvroot, props, fsprops) == 0) {
1032			zfs_handle_t *pool = zfs_open(g_zfs, poolname,
1033			    ZFS_TYPE_FILESYSTEM);
1034			if (pool != NULL) {
1035				if (zfs_mount(pool, NULL, 0) == 0)
1036					ret = zfs_shareall(pool);
1037				zfs_close(pool);
1038			}
1039		} else if (libzfs_errno(g_zfs) == EZFS_INVALIDNAME) {
1040			(void) fprintf(stderr, gettext("pool name may have "
1041			    "been omitted\n"));
1042		}
1043	}
1044
1045errout:
1046	nvlist_free(nvroot);
1047	nvlist_free(fsprops);
1048	nvlist_free(props);
1049	return (ret);
1050badusage:
1051	nvlist_free(fsprops);
1052	nvlist_free(props);
1053	usage(B_FALSE);
1054	return (2);
1055}
1056
1057/*
1058 * zpool destroy <pool>
1059 *
1060 * 	-f	Forcefully unmount any datasets
1061 *
1062 * Destroy the given pool.  Automatically unmounts any datasets in the pool.
1063 */
1064int
1065zpool_do_destroy(int argc, char **argv)
1066{
1067	boolean_t force = B_FALSE;
1068	int c;
1069	char *pool;
1070	zpool_handle_t *zhp;
1071	int ret;
1072
1073	/* check options */
1074	while ((c = getopt(argc, argv, "f")) != -1) {
1075		switch (c) {
1076		case 'f':
1077			force = B_TRUE;
1078			break;
1079		case '?':
1080			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
1081			    optopt);
1082			usage(B_FALSE);
1083		}
1084	}
1085
1086	argc -= optind;
1087	argv += optind;
1088
1089	/* check arguments */
1090	if (argc < 1) {
1091		(void) fprintf(stderr, gettext("missing pool argument\n"));
1092		usage(B_FALSE);
1093	}
1094	if (argc > 1) {
1095		(void) fprintf(stderr, gettext("too many arguments\n"));
1096		usage(B_FALSE);
1097	}
1098
1099	pool = argv[0];
1100
1101	if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL) {
1102		/*
1103		 * As a special case, check for use of '/' in the name, and
1104		 * direct the user to use 'zfs destroy' instead.
1105		 */
1106		if (strchr(pool, '/') != NULL)
1107			(void) fprintf(stderr, gettext("use 'zfs destroy' to "
1108			    "destroy a dataset\n"));
1109		return (1);
1110	}
1111
1112	if (zpool_disable_datasets(zhp, force) != 0) {
1113		(void) fprintf(stderr, gettext("could not destroy '%s': "
1114		    "could not unmount datasets\n"), zpool_get_name(zhp));
1115		return (1);
1116	}
1117
1118	/* The history must be logged as part of the export */
1119	log_history = B_FALSE;
1120
1121	ret = (zpool_destroy(zhp, history_str) != 0);
1122
1123	zpool_close(zhp);
1124
1125	return (ret);
1126}
1127
1128/*
1129 * zpool export [-f] <pool> ...
1130 *
1131 *	-f	Forcefully unmount datasets
1132 *
1133 * Export the given pools.  By default, the command will attempt to cleanly
1134 * unmount any active datasets within the pool.  If the '-f' flag is specified,
1135 * then the datasets will be forcefully unmounted.
1136 */
1137int
1138zpool_do_export(int argc, char **argv)
1139{
1140	boolean_t force = B_FALSE;
1141	boolean_t hardforce = B_FALSE;
1142	int c;
1143	zpool_handle_t *zhp;
1144	int ret;
1145	int i;
1146
1147	/* check options */
1148	while ((c = getopt(argc, argv, "fF")) != -1) {
1149		switch (c) {
1150		case 'f':
1151			force = B_TRUE;
1152			break;
1153		case 'F':
1154			hardforce = B_TRUE;
1155			break;
1156		case '?':
1157			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
1158			    optopt);
1159			usage(B_FALSE);
1160		}
1161	}
1162
1163	argc -= optind;
1164	argv += optind;
1165
1166	/* check arguments */
1167	if (argc < 1) {
1168		(void) fprintf(stderr, gettext("missing pool argument\n"));
1169		usage(B_FALSE);
1170	}
1171
1172	ret = 0;
1173	for (i = 0; i < argc; i++) {
1174		if ((zhp = zpool_open_canfail(g_zfs, argv[i])) == NULL) {
1175			ret = 1;
1176			continue;
1177		}
1178
1179		if (zpool_disable_datasets(zhp, force) != 0) {
1180			ret = 1;
1181			zpool_close(zhp);
1182			continue;
1183		}
1184
1185		/* The history must be logged as part of the export */
1186		log_history = B_FALSE;
1187
1188		if (hardforce) {
1189			if (zpool_export_force(zhp, history_str) != 0)
1190				ret = 1;
1191		} else if (zpool_export(zhp, force, history_str) != 0) {
1192			ret = 1;
1193		}
1194
1195		zpool_close(zhp);
1196	}
1197
1198	return (ret);
1199}
1200
1201/*
1202 * Given a vdev configuration, determine the maximum width needed for the device
1203 * name column.
1204 */
1205static int
1206max_width(zpool_handle_t *zhp, nvlist_t *nv, int depth, int max)
1207{
1208	char *name = zpool_vdev_name(g_zfs, zhp, nv, B_TRUE);
1209	nvlist_t **child;
1210	uint_t c, children;
1211	int ret;
1212
1213	if (strlen(name) + depth > max)
1214		max = strlen(name) + depth;
1215
1216	free(name);
1217
1218	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_SPARES,
1219	    &child, &children) == 0) {
1220		for (c = 0; c < children; c++)
1221			if ((ret = max_width(zhp, child[c], depth + 2,
1222			    max)) > max)
1223				max = ret;
1224	}
1225
1226	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE,
1227	    &child, &children) == 0) {
1228		for (c = 0; c < children; c++)
1229			if ((ret = max_width(zhp, child[c], depth + 2,
1230			    max)) > max)
1231				max = ret;
1232	}
1233
1234	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1235	    &child, &children) == 0) {
1236		for (c = 0; c < children; c++)
1237			if ((ret = max_width(zhp, child[c], depth + 2,
1238			    max)) > max)
1239				max = ret;
1240	}
1241
1242
1243	return (max);
1244}
1245
1246typedef struct spare_cbdata {
1247	uint64_t	cb_guid;
1248	zpool_handle_t	*cb_zhp;
1249} spare_cbdata_t;
1250
1251static boolean_t
1252find_vdev(nvlist_t *nv, uint64_t search)
1253{
1254	uint64_t guid;
1255	nvlist_t **child;
1256	uint_t c, children;
1257
1258	if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &guid) == 0 &&
1259	    search == guid)
1260		return (B_TRUE);
1261
1262	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1263	    &child, &children) == 0) {
1264		for (c = 0; c < children; c++)
1265			if (find_vdev(child[c], search))
1266				return (B_TRUE);
1267	}
1268
1269	return (B_FALSE);
1270}
1271
1272static int
1273find_spare(zpool_handle_t *zhp, void *data)
1274{
1275	spare_cbdata_t *cbp = data;
1276	nvlist_t *config, *nvroot;
1277
1278	config = zpool_get_config(zhp, NULL);
1279	verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
1280	    &nvroot) == 0);
1281
1282	if (find_vdev(nvroot, cbp->cb_guid)) {
1283		cbp->cb_zhp = zhp;
1284		return (1);
1285	}
1286
1287	zpool_close(zhp);
1288	return (0);
1289}
1290
1291/*
1292 * Print out configuration state as requested by status_callback.
1293 */
1294void
1295print_status_config(zpool_handle_t *zhp, const char *name, nvlist_t *nv,
1296    int namewidth, int depth, boolean_t isspare)
1297{
1298	nvlist_t **child;
1299	uint_t c, vsc, children;
1300	pool_scan_stat_t *ps = NULL;
1301	vdev_stat_t *vs;
1302	char rbuf[6], wbuf[6], cbuf[6];
1303	char *vname;
1304	uint64_t notpresent;
1305	uint64_t ashift;
1306	spare_cbdata_t cb;
1307	const char *state;
1308
1309	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1310	    &child, &children) != 0)
1311		children = 0;
1312
1313	verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
1314	    (uint64_t **)&vs, &vsc) == 0);
1315
1316	state = zpool_state_to_name(vs->vs_state, vs->vs_aux);
1317	if (isspare) {
1318		/*
1319		 * For hot spares, we use the terms 'INUSE' and 'AVAILABLE' for
1320		 * online drives.
1321		 */
1322		if (vs->vs_aux == VDEV_AUX_SPARED)
1323			state = "INUSE";
1324		else if (vs->vs_state == VDEV_STATE_HEALTHY)
1325			state = "AVAIL";
1326	}
1327
1328	(void) printf("\t%*s%-*s  %-8s", depth, "", namewidth - depth,
1329	    name, state);
1330
1331	if (!isspare) {
1332		zfs_nicenum(vs->vs_read_errors, rbuf, sizeof (rbuf));
1333		zfs_nicenum(vs->vs_write_errors, wbuf, sizeof (wbuf));
1334		zfs_nicenum(vs->vs_checksum_errors, cbuf, sizeof (cbuf));
1335		(void) printf(" %5s %5s %5s", rbuf, wbuf, cbuf);
1336	}
1337
1338	if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NOT_PRESENT,
1339	    &notpresent) == 0 ||
1340	    vs->vs_state <= VDEV_STATE_CANT_OPEN) {
1341		char *path;
1342		if (nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0)
1343			(void) printf("  was %s", path);
1344	} else if (vs->vs_aux != 0) {
1345		(void) printf("  ");
1346
1347		switch (vs->vs_aux) {
1348		case VDEV_AUX_OPEN_FAILED:
1349			(void) printf(gettext("cannot open"));
1350			break;
1351
1352		case VDEV_AUX_BAD_GUID_SUM:
1353			(void) printf(gettext("missing device"));
1354			break;
1355
1356		case VDEV_AUX_NO_REPLICAS:
1357			(void) printf(gettext("insufficient replicas"));
1358			break;
1359
1360		case VDEV_AUX_VERSION_NEWER:
1361			(void) printf(gettext("newer version"));
1362			break;
1363
1364		case VDEV_AUX_UNSUP_FEAT:
1365			(void) printf(gettext("unsupported feature(s)"));
1366			break;
1367
1368		case VDEV_AUX_ASHIFT_TOO_BIG:
1369			(void) printf(gettext("unsupported minimum blocksize"));
1370			break;
1371
1372		case VDEV_AUX_SPARED:
1373			verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID,
1374			    &cb.cb_guid) == 0);
1375			if (zpool_iter(g_zfs, find_spare, &cb) == 1) {
1376				if (strcmp(zpool_get_name(cb.cb_zhp),
1377				    zpool_get_name(zhp)) == 0)
1378					(void) printf(gettext("currently in "
1379					    "use"));
1380				else
1381					(void) printf(gettext("in use by "
1382					    "pool '%s'"),
1383					    zpool_get_name(cb.cb_zhp));
1384				zpool_close(cb.cb_zhp);
1385			} else {
1386				(void) printf(gettext("currently in use"));
1387			}
1388			break;
1389
1390		case VDEV_AUX_ERR_EXCEEDED:
1391			(void) printf(gettext("too many errors"));
1392			break;
1393
1394		case VDEV_AUX_IO_FAILURE:
1395			(void) printf(gettext("experienced I/O failures"));
1396			break;
1397
1398		case VDEV_AUX_BAD_LOG:
1399			(void) printf(gettext("bad intent log"));
1400			break;
1401
1402		case VDEV_AUX_EXTERNAL:
1403			(void) printf(gettext("external device fault"));
1404			break;
1405
1406		case VDEV_AUX_SPLIT_POOL:
1407			(void) printf(gettext("split into new pool"));
1408			break;
1409
1410		default:
1411			(void) printf(gettext("corrupted data"));
1412			break;
1413		}
1414	} else if (children == 0 && !isspare &&
1415	    VDEV_STAT_VALID(vs_physical_ashift, vsc) &&
1416	    vs->vs_configured_ashift < vs->vs_physical_ashift) {
1417		(void) printf(
1418		    gettext("  block size: %dB configured, %dB native"),
1419		    1 << vs->vs_configured_ashift, 1 << vs->vs_physical_ashift);
1420	}
1421
1422	(void) nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_SCAN_STATS,
1423	    (uint64_t **)&ps, &c);
1424
1425	if (ps && ps->pss_state == DSS_SCANNING &&
1426	    vs->vs_scan_processed != 0 && children == 0) {
1427		(void) printf(gettext("  (%s)"),
1428		    (ps->pss_func == POOL_SCAN_RESILVER) ?
1429		    "resilvering" : "repairing");
1430	}
1431
1432	(void) printf("\n");
1433
1434	for (c = 0; c < children; c++) {
1435		uint64_t islog = B_FALSE, ishole = B_FALSE;
1436
1437		/* Don't print logs or holes here */
1438		(void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
1439		    &islog);
1440		(void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_HOLE,
1441		    &ishole);
1442		if (islog || ishole)
1443			continue;
1444		vname = zpool_vdev_name(g_zfs, zhp, child[c], B_TRUE);
1445		print_status_config(zhp, vname, child[c],
1446		    namewidth, depth + 2, isspare);
1447		free(vname);
1448	}
1449}
1450
1451
1452/*
1453 * Print the configuration of an exported pool.  Iterate over all vdevs in the
1454 * pool, printing out the name and status for each one.
1455 */
1456void
1457print_import_config(const char *name, nvlist_t *nv, int namewidth, int depth)
1458{
1459	nvlist_t **child;
1460	uint_t c, children;
1461	vdev_stat_t *vs;
1462	char *type, *vname;
1463
1464	verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE, &type) == 0);
1465	if (strcmp(type, VDEV_TYPE_MISSING) == 0 ||
1466	    strcmp(type, VDEV_TYPE_HOLE) == 0)
1467		return;
1468
1469	verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
1470	    (uint64_t **)&vs, &c) == 0);
1471
1472	(void) printf("\t%*s%-*s", depth, "", namewidth - depth, name);
1473	(void) printf("  %s", zpool_state_to_name(vs->vs_state, vs->vs_aux));
1474
1475	if (vs->vs_aux != 0) {
1476		(void) printf("  ");
1477
1478		switch (vs->vs_aux) {
1479		case VDEV_AUX_OPEN_FAILED:
1480			(void) printf(gettext("cannot open"));
1481			break;
1482
1483		case VDEV_AUX_BAD_GUID_SUM:
1484			(void) printf(gettext("missing device"));
1485			break;
1486
1487		case VDEV_AUX_NO_REPLICAS:
1488			(void) printf(gettext("insufficient replicas"));
1489			break;
1490
1491		case VDEV_AUX_VERSION_NEWER:
1492			(void) printf(gettext("newer version"));
1493			break;
1494
1495		case VDEV_AUX_UNSUP_FEAT:
1496			(void) printf(gettext("unsupported feature(s)"));
1497			break;
1498
1499		case VDEV_AUX_ERR_EXCEEDED:
1500			(void) printf(gettext("too many errors"));
1501			break;
1502
1503		default:
1504			(void) printf(gettext("corrupted data"));
1505			break;
1506		}
1507	}
1508	(void) printf("\n");
1509
1510	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1511	    &child, &children) != 0)
1512		return;
1513
1514	for (c = 0; c < children; c++) {
1515		uint64_t is_log = B_FALSE;
1516
1517		(void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
1518		    &is_log);
1519		if (is_log)
1520			continue;
1521
1522		vname = zpool_vdev_name(g_zfs, NULL, child[c], B_TRUE);
1523		print_import_config(vname, child[c], namewidth, depth + 2);
1524		free(vname);
1525	}
1526
1527	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE,
1528	    &child, &children) == 0) {
1529		(void) printf(gettext("\tcache\n"));
1530		for (c = 0; c < children; c++) {
1531			vname = zpool_vdev_name(g_zfs, NULL, child[c], B_FALSE);
1532			(void) printf("\t  %s\n", vname);
1533			free(vname);
1534		}
1535	}
1536
1537	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_SPARES,
1538	    &child, &children) == 0) {
1539		(void) printf(gettext("\tspares\n"));
1540		for (c = 0; c < children; c++) {
1541			vname = zpool_vdev_name(g_zfs, NULL, child[c], B_FALSE);
1542			(void) printf("\t  %s\n", vname);
1543			free(vname);
1544		}
1545	}
1546}
1547
1548/*
1549 * Print log vdevs.
1550 * Logs are recorded as top level vdevs in the main pool child array
1551 * but with "is_log" set to 1. We use either print_status_config() or
1552 * print_import_config() to print the top level logs then any log
1553 * children (eg mirrored slogs) are printed recursively - which
1554 * works because only the top level vdev is marked "is_log"
1555 */
1556static void
1557print_logs(zpool_handle_t *zhp, nvlist_t *nv, int namewidth, boolean_t verbose)
1558{
1559	uint_t c, children;
1560	nvlist_t **child;
1561
1562	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, &child,
1563	    &children) != 0)
1564		return;
1565
1566	(void) printf(gettext("\tlogs\n"));
1567
1568	for (c = 0; c < children; c++) {
1569		uint64_t is_log = B_FALSE;
1570		char *name;
1571
1572		(void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
1573		    &is_log);
1574		if (!is_log)
1575			continue;
1576		name = zpool_vdev_name(g_zfs, zhp, child[c], B_TRUE);
1577		if (verbose)
1578			print_status_config(zhp, name, child[c], namewidth,
1579			    2, B_FALSE);
1580		else
1581			print_import_config(name, child[c], namewidth, 2);
1582		free(name);
1583	}
1584}
1585
1586/*
1587 * Display the status for the given pool.
1588 */
1589static void
1590show_import(nvlist_t *config)
1591{
1592	uint64_t pool_state;
1593	vdev_stat_t *vs;
1594	char *name;
1595	uint64_t guid;
1596	char *msgid;
1597	nvlist_t *nvroot;
1598	int reason;
1599	const char *health;
1600	uint_t vsc;
1601	int namewidth;
1602	char *comment;
1603
1604	verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
1605	    &name) == 0);
1606	verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
1607	    &guid) == 0);
1608	verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
1609	    &pool_state) == 0);
1610	verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
1611	    &nvroot) == 0);
1612
1613	verify(nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_VDEV_STATS,
1614	    (uint64_t **)&vs, &vsc) == 0);
1615	health = zpool_state_to_name(vs->vs_state, vs->vs_aux);
1616
1617	reason = zpool_import_status(config, &msgid);
1618
1619	(void) printf(gettext("   pool: %s\n"), name);
1620	(void) printf(gettext("     id: %llu\n"), (u_longlong_t)guid);
1621	(void) printf(gettext("  state: %s"), health);
1622	if (pool_state == POOL_STATE_DESTROYED)
1623		(void) printf(gettext(" (DESTROYED)"));
1624	(void) printf("\n");
1625
1626	switch (reason) {
1627	case ZPOOL_STATUS_MISSING_DEV_R:
1628	case ZPOOL_STATUS_MISSING_DEV_NR:
1629	case ZPOOL_STATUS_BAD_GUID_SUM:
1630		(void) printf(gettext(" status: One or more devices are "
1631		    "missing from the system.\n"));
1632		break;
1633
1634	case ZPOOL_STATUS_CORRUPT_LABEL_R:
1635	case ZPOOL_STATUS_CORRUPT_LABEL_NR:
1636		(void) printf(gettext(" status: One or more devices contains "
1637		    "corrupted data.\n"));
1638		break;
1639
1640	case ZPOOL_STATUS_CORRUPT_DATA:
1641		(void) printf(
1642		    gettext(" status: The pool data is corrupted.\n"));
1643		break;
1644
1645	case ZPOOL_STATUS_OFFLINE_DEV:
1646		(void) printf(gettext(" status: One or more devices "
1647		    "are offlined.\n"));
1648		break;
1649
1650	case ZPOOL_STATUS_CORRUPT_POOL:
1651		(void) printf(gettext(" status: The pool metadata is "
1652		    "corrupted.\n"));
1653		break;
1654
1655	case ZPOOL_STATUS_VERSION_OLDER:
1656		(void) printf(gettext(" status: The pool is formatted using a "
1657		    "legacy on-disk version.\n"));
1658		break;
1659
1660	case ZPOOL_STATUS_VERSION_NEWER:
1661		(void) printf(gettext(" status: The pool is formatted using an "
1662		    "incompatible version.\n"));
1663		break;
1664
1665	case ZPOOL_STATUS_FEAT_DISABLED:
1666		(void) printf(gettext(" status: Some supported features are "
1667		    "not enabled on the pool.\n"));
1668		break;
1669
1670	case ZPOOL_STATUS_UNSUP_FEAT_READ:
1671		(void) printf(gettext("status: The pool uses the following "
1672		    "feature(s) not supported on this sytem:\n"));
1673		zpool_print_unsup_feat(config);
1674		break;
1675
1676	case ZPOOL_STATUS_UNSUP_FEAT_WRITE:
1677		(void) printf(gettext("status: The pool can only be accessed "
1678		    "in read-only mode on this system. It\n\tcannot be "
1679		    "accessed in read-write mode because it uses the "
1680		    "following\n\tfeature(s) not supported on this system:\n"));
1681		zpool_print_unsup_feat(config);
1682		break;
1683
1684	case ZPOOL_STATUS_HOSTID_MISMATCH:
1685		(void) printf(gettext(" status: The pool was last accessed by "
1686		    "another system.\n"));
1687		break;
1688
1689	case ZPOOL_STATUS_FAULTED_DEV_R:
1690	case ZPOOL_STATUS_FAULTED_DEV_NR:
1691		(void) printf(gettext(" status: One or more devices are "
1692		    "faulted.\n"));
1693		break;
1694
1695	case ZPOOL_STATUS_BAD_LOG:
1696		(void) printf(gettext(" status: An intent log record cannot be "
1697		    "read.\n"));
1698		break;
1699
1700	case ZPOOL_STATUS_RESILVERING:
1701		(void) printf(gettext(" status: One or more devices were being "
1702		    "resilvered.\n"));
1703		break;
1704
1705	case ZPOOL_STATUS_NON_NATIVE_ASHIFT:
1706		(void) printf(gettext("status: One or more devices were "
1707		    "configured to use a non-native block size.\n"
1708		    "\tExpect reduced performance.\n"));
1709		break;
1710
1711	default:
1712		/*
1713		 * No other status can be seen when importing pools.
1714		 */
1715		assert(reason == ZPOOL_STATUS_OK);
1716	}
1717
1718	/*
1719	 * Print out an action according to the overall state of the pool.
1720	 */
1721	if (vs->vs_state == VDEV_STATE_HEALTHY) {
1722		if (reason == ZPOOL_STATUS_VERSION_OLDER ||
1723		    reason == ZPOOL_STATUS_FEAT_DISABLED) {
1724			(void) printf(gettext(" action: The pool can be "
1725			    "imported using its name or numeric identifier, "
1726			    "though\n\tsome features will not be available "
1727			    "without an explicit 'zpool upgrade'.\n"));
1728		} else if (reason == ZPOOL_STATUS_HOSTID_MISMATCH) {
1729			(void) printf(gettext(" action: The pool can be "
1730			    "imported using its name or numeric "
1731			    "identifier and\n\tthe '-f' flag.\n"));
1732		} else {
1733			(void) printf(gettext(" action: The pool can be "
1734			    "imported using its name or numeric "
1735			    "identifier.\n"));
1736		}
1737	} else if (vs->vs_state == VDEV_STATE_DEGRADED) {
1738		(void) printf(gettext(" action: The pool can be imported "
1739		    "despite missing or damaged devices.  The\n\tfault "
1740		    "tolerance of the pool may be compromised if imported.\n"));
1741	} else {
1742		switch (reason) {
1743		case ZPOOL_STATUS_VERSION_NEWER:
1744			(void) printf(gettext(" action: The pool cannot be "
1745			    "imported.  Access the pool on a system running "
1746			    "newer\n\tsoftware, or recreate the pool from "
1747			    "backup.\n"));
1748			break;
1749		case ZPOOL_STATUS_UNSUP_FEAT_READ:
1750			(void) printf(gettext("action: The pool cannot be "
1751			    "imported. Access the pool on a system that "
1752			    "supports\n\tthe required feature(s), or recreate "
1753			    "the pool from backup.\n"));
1754			break;
1755		case ZPOOL_STATUS_UNSUP_FEAT_WRITE:
1756			(void) printf(gettext("action: The pool cannot be "
1757			    "imported in read-write mode. Import the pool "
1758			    "with\n"
1759			    "\t\"-o readonly=on\", access the pool on a system "
1760			    "that supports the\n\trequired feature(s), or "
1761			    "recreate the pool from backup.\n"));
1762			break;
1763		case ZPOOL_STATUS_MISSING_DEV_R:
1764		case ZPOOL_STATUS_MISSING_DEV_NR:
1765		case ZPOOL_STATUS_BAD_GUID_SUM:
1766			(void) printf(gettext(" action: The pool cannot be "
1767			    "imported. Attach the missing\n\tdevices and try "
1768			    "again.\n"));
1769			break;
1770		default:
1771			(void) printf(gettext(" action: The pool cannot be "
1772			    "imported due to damaged devices or data.\n"));
1773		}
1774	}
1775
1776	/* Print the comment attached to the pool. */
1777	if (nvlist_lookup_string(config, ZPOOL_CONFIG_COMMENT, &comment) == 0)
1778		(void) printf(gettext("comment: %s\n"), comment);
1779
1780	/*
1781	 * If the state is "closed" or "can't open", and the aux state
1782	 * is "corrupt data":
1783	 */
1784	if (((vs->vs_state == VDEV_STATE_CLOSED) ||
1785	    (vs->vs_state == VDEV_STATE_CANT_OPEN)) &&
1786	    (vs->vs_aux == VDEV_AUX_CORRUPT_DATA)) {
1787		if (pool_state == POOL_STATE_DESTROYED)
1788			(void) printf(gettext("\tThe pool was destroyed, "
1789			    "but can be imported using the '-Df' flags.\n"));
1790		else if (pool_state != POOL_STATE_EXPORTED)
1791			(void) printf(gettext("\tThe pool may be active on "
1792			    "another system, but can be imported using\n\t"
1793			    "the '-f' flag.\n"));
1794	}
1795
1796	if (msgid != NULL)
1797		(void) printf(gettext("   see: http://illumos.org/msg/%s\n"),
1798		    msgid);
1799
1800	(void) printf(gettext(" config:\n\n"));
1801
1802	namewidth = max_width(NULL, nvroot, 0, 0);
1803	if (namewidth < 10)
1804		namewidth = 10;
1805
1806	print_import_config(name, nvroot, namewidth, 0);
1807	if (num_logs(nvroot) > 0)
1808		print_logs(NULL, nvroot, namewidth, B_FALSE);
1809
1810	if (reason == ZPOOL_STATUS_BAD_GUID_SUM) {
1811		(void) printf(gettext("\n\tAdditional devices are known to "
1812		    "be part of this pool, though their\n\texact "
1813		    "configuration cannot be determined.\n"));
1814	}
1815}
1816
1817/*
1818 * Perform the import for the given configuration.  This passes the heavy
1819 * lifting off to zpool_import_props(), and then mounts the datasets contained
1820 * within the pool.
1821 */
1822static int
1823do_import(nvlist_t *config, const char *newname, const char *mntopts,
1824    nvlist_t *props, int flags)
1825{
1826	zpool_handle_t *zhp;
1827	char *name;
1828	uint64_t state;
1829	uint64_t version;
1830
1831	verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
1832	    &name) == 0);
1833
1834	verify(nvlist_lookup_uint64(config,
1835	    ZPOOL_CONFIG_POOL_STATE, &state) == 0);
1836	verify(nvlist_lookup_uint64(config,
1837	    ZPOOL_CONFIG_VERSION, &version) == 0);
1838	if (!SPA_VERSION_IS_SUPPORTED(version)) {
1839		(void) fprintf(stderr, gettext("cannot import '%s': pool "
1840		    "is formatted using an unsupported ZFS version\n"), name);
1841		return (1);
1842	} else if (state != POOL_STATE_EXPORTED &&
1843	    !(flags & ZFS_IMPORT_ANY_HOST)) {
1844		uint64_t hostid;
1845
1846		if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_HOSTID,
1847		    &hostid) == 0) {
1848			if ((unsigned long)hostid != gethostid()) {
1849				char *hostname;
1850				uint64_t timestamp;
1851				time_t t;
1852
1853				verify(nvlist_lookup_string(config,
1854				    ZPOOL_CONFIG_HOSTNAME, &hostname) == 0);
1855				verify(nvlist_lookup_uint64(config,
1856				    ZPOOL_CONFIG_TIMESTAMP, &timestamp) == 0);
1857				t = timestamp;
1858				(void) fprintf(stderr, gettext("cannot import "
1859				    "'%s': pool may be in use from other "
1860				    "system, it was last accessed by %s "
1861				    "(hostid: 0x%lx) on %s"), name, hostname,
1862				    (unsigned long)hostid,
1863				    asctime(localtime(&t)));
1864				(void) fprintf(stderr, gettext("use '-f' to "
1865				    "import anyway\n"));
1866				return (1);
1867			}
1868		} else {
1869			(void) fprintf(stderr, gettext("cannot import '%s': "
1870			    "pool may be in use from other system\n"), name);
1871			(void) fprintf(stderr, gettext("use '-f' to import "
1872			    "anyway\n"));
1873			return (1);
1874		}
1875	}
1876
1877	if (zpool_import_props(g_zfs, config, newname, props, flags) != 0)
1878		return (1);
1879
1880	if (newname != NULL)
1881		name = (char *)newname;
1882
1883	if ((zhp = zpool_open_canfail(g_zfs, name)) == NULL)
1884		return (1);
1885
1886	if (zpool_get_state(zhp) != POOL_STATE_UNAVAIL &&
1887	    !(flags & ZFS_IMPORT_ONLY) &&
1888	    zpool_enable_datasets(zhp, mntopts, 0) != 0) {
1889		zpool_close(zhp);
1890		return (1);
1891	}
1892
1893	zpool_close(zhp);
1894	return (0);
1895}
1896
1897/*
1898 * zpool import [-d dir] [-D]
1899 *       import [-o mntopts] [-o prop=value] ... [-R root] [-D]
1900 *              [-d dir | -c cachefile] [-f] -a
1901 *       import [-o mntopts] [-o prop=value] ... [-R root] [-D]
1902 *              [-d dir | -c cachefile] [-f] [-n] [-F] <pool | id> [newpool]
1903 *
1904 *	 -c	Read pool information from a cachefile instead of searching
1905 *		devices.
1906 *
1907 *       -d	Scan in a specific directory, other than /dev/dsk.  More than
1908 *		one directory can be specified using multiple '-d' options.
1909 *
1910 *       -D     Scan for previously destroyed pools or import all or only
1911 *              specified destroyed pools.
1912 *
1913 *       -R	Temporarily import the pool, with all mountpoints relative to
1914 *		the given root.  The pool will remain exported when the machine
1915 *		is rebooted.
1916 *
1917 *       -V	Import even in the presence of faulted vdevs.  This is an
1918 *       	intentionally undocumented option for testing purposes, and
1919 *       	treats the pool configuration as complete, leaving any bad
1920 *		vdevs in the FAULTED state. In other words, it does verbatim
1921 *		import.
1922 *
1923 *       -f	Force import, even if it appears that the pool is active.
1924 *
1925 *       -F     Attempt rewind if necessary.
1926 *
1927 *       -n     See if rewind would work, but don't actually rewind.
1928 *
1929 *       -N     Import the pool but don't mount datasets.
1930 *
1931 *       -T     Specify a starting txg to use for import. This option is
1932 *       	intentionally undocumented option for testing purposes.
1933 *
1934 *       -a	Import all pools found.
1935 *
1936 *       -o	Set property=value and/or temporary mount options (without '=').
1937 *
1938 * The import command scans for pools to import, and import pools based on pool
1939 * name and GUID.  The pool can also be renamed as part of the import process.
1940 */
1941int
1942zpool_do_import(int argc, char **argv)
1943{
1944	char **searchdirs = NULL;
1945	int nsearch = 0;
1946	int c;
1947	int err = 0;
1948	nvlist_t *pools = NULL;
1949	boolean_t do_all = B_FALSE;
1950	boolean_t do_destroyed = B_FALSE;
1951	char *mntopts = NULL;
1952	nvpair_t *elem;
1953	nvlist_t *config;
1954	uint64_t searchguid = 0;
1955	char *searchname = NULL;
1956	char *propval;
1957	nvlist_t *found_config;
1958	nvlist_t *policy = NULL;
1959	nvlist_t *props = NULL;
1960	boolean_t first;
1961	int flags = ZFS_IMPORT_NORMAL;
1962	uint32_t rewind_policy = ZPOOL_NO_REWIND;
1963	boolean_t dryrun = B_FALSE;
1964	boolean_t do_rewind = B_FALSE;
1965	boolean_t xtreme_rewind = B_FALSE;
1966	uint64_t pool_state, txg = -1ULL;
1967	char *cachefile = NULL;
1968	importargs_t idata = { 0 };
1969	char *endptr;
1970
1971	/* check options */
1972	while ((c = getopt(argc, argv, ":aCc:d:DEfFmnNo:rR:T:VX")) != -1) {
1973		switch (c) {
1974		case 'a':
1975			do_all = B_TRUE;
1976			break;
1977		case 'c':
1978			cachefile = optarg;
1979			break;
1980		case 'd':
1981			if (searchdirs == NULL) {
1982				searchdirs = safe_malloc(sizeof (char *));
1983			} else {
1984				char **tmp = safe_malloc((nsearch + 1) *
1985				    sizeof (char *));
1986				bcopy(searchdirs, tmp, nsearch *
1987				    sizeof (char *));
1988				free(searchdirs);
1989				searchdirs = tmp;
1990			}
1991			searchdirs[nsearch++] = optarg;
1992			break;
1993		case 'D':
1994			do_destroyed = B_TRUE;
1995			break;
1996		case 'f':
1997			flags |= ZFS_IMPORT_ANY_HOST;
1998			break;
1999		case 'F':
2000			do_rewind = B_TRUE;
2001			break;
2002		case 'm':
2003			flags |= ZFS_IMPORT_MISSING_LOG;
2004			break;
2005		case 'n':
2006			dryrun = B_TRUE;
2007			break;
2008		case 'N':
2009			flags |= ZFS_IMPORT_ONLY;
2010			break;
2011		case 'o':
2012			if ((propval = strchr(optarg, '=')) != NULL) {
2013				*propval = '\0';
2014				propval++;
2015				if (add_prop_list(optarg, propval,
2016				    &props, B_TRUE))
2017					goto error;
2018			} else {
2019				mntopts = optarg;
2020			}
2021			break;
2022		case 'R':
2023			if (add_prop_list(zpool_prop_to_name(
2024			    ZPOOL_PROP_ALTROOT), optarg, &props, B_TRUE))
2025				goto error;
2026			if (nvlist_lookup_string(props,
2027			    zpool_prop_to_name(ZPOOL_PROP_CACHEFILE),
2028			    &propval) == 0)
2029				break;
2030			if (add_prop_list(zpool_prop_to_name(
2031			    ZPOOL_PROP_CACHEFILE), "none", &props, B_TRUE))
2032				goto error;
2033			break;
2034		case 'T':
2035			errno = 0;
2036			txg = strtoull(optarg, &endptr, 10);
2037			if (errno != 0 || *endptr != '\0') {
2038				(void) fprintf(stderr,
2039				    gettext("invalid txg value\n"));
2040				usage(B_FALSE);
2041			}
2042			rewind_policy = ZPOOL_DO_REWIND | ZPOOL_EXTREME_REWIND;
2043			break;
2044		case 'V':
2045			flags |= ZFS_IMPORT_VERBATIM;
2046			break;
2047		case 'X':
2048			xtreme_rewind = B_TRUE;
2049			break;
2050		case ':':
2051			(void) fprintf(stderr, gettext("missing argument for "
2052			    "'%c' option\n"), optopt);
2053			usage(B_FALSE);
2054			break;
2055		case '?':
2056			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
2057			    optopt);
2058			usage(B_FALSE);
2059		}
2060	}
2061
2062	argc -= optind;
2063	argv += optind;
2064
2065	if (cachefile && nsearch != 0) {
2066		(void) fprintf(stderr, gettext("-c is incompatible with -d\n"));
2067		usage(B_FALSE);
2068	}
2069
2070	if ((dryrun || xtreme_rewind) && !do_rewind) {
2071		(void) fprintf(stderr,
2072		    gettext("-n or -X only meaningful with -F\n"));
2073		usage(B_FALSE);
2074	}
2075	if (dryrun)
2076		rewind_policy = ZPOOL_TRY_REWIND;
2077	else if (do_rewind)
2078		rewind_policy = ZPOOL_DO_REWIND;
2079	if (xtreme_rewind)
2080		rewind_policy |= ZPOOL_EXTREME_REWIND;
2081
2082	/* In the future, we can capture further policy and include it here */
2083	if (nvlist_alloc(&policy, NV_UNIQUE_NAME, 0) != 0 ||
2084	    nvlist_add_uint64(policy, ZPOOL_REWIND_REQUEST_TXG, txg) != 0 ||
2085	    nvlist_add_uint32(policy, ZPOOL_REWIND_REQUEST, rewind_policy) != 0)
2086		goto error;
2087
2088	if (searchdirs == NULL) {
2089		searchdirs = safe_malloc(sizeof (char *));
2090		searchdirs[0] = "/dev";
2091		nsearch = 1;
2092	}
2093
2094	/* check argument count */
2095	if (do_all) {
2096		if (argc != 0) {
2097			(void) fprintf(stderr, gettext("too many arguments\n"));
2098			usage(B_FALSE);
2099		}
2100	} else {
2101		if (argc > 2) {
2102			(void) fprintf(stderr, gettext("too many arguments\n"));
2103			usage(B_FALSE);
2104		}
2105
2106		/*
2107		 * Check for the SYS_CONFIG privilege.  We do this explicitly
2108		 * here because otherwise any attempt to discover pools will
2109		 * silently fail.
2110		 */
2111		if (argc == 0 && !priv_ineffect(PRIV_SYS_CONFIG)) {
2112			(void) fprintf(stderr, gettext("cannot "
2113			    "discover pools: permission denied\n"));
2114			free(searchdirs);
2115			nvlist_free(policy);
2116			return (1);
2117		}
2118	}
2119
2120	/*
2121	 * Depending on the arguments given, we do one of the following:
2122	 *
2123	 *	<none>	Iterate through all pools and display information about
2124	 *		each one.
2125	 *
2126	 *	-a	Iterate through all pools and try to import each one.
2127	 *
2128	 *	<id>	Find the pool that corresponds to the given GUID/pool
2129	 *		name and import that one.
2130	 *
2131	 *	-D	Above options applies only to destroyed pools.
2132	 */
2133	if (argc != 0) {
2134		char *endptr;
2135
2136		errno = 0;
2137		searchguid = strtoull(argv[0], &endptr, 10);
2138		if (errno != 0 || *endptr != '\0') {
2139			searchname = argv[0];
2140			searchguid = 0;
2141		}
2142		found_config = NULL;
2143
2144		/*
2145		 * User specified a name or guid.  Ensure it's unique.
2146		 */
2147		idata.unique = B_TRUE;
2148	}
2149
2150
2151	idata.path = searchdirs;
2152	idata.paths = nsearch;
2153	idata.poolname = searchname;
2154	idata.guid = searchguid;
2155	idata.cachefile = cachefile;
2156
2157	pools = zpool_search_import(g_zfs, &idata);
2158
2159	if (pools != NULL && idata.exists &&
2160	    (argc == 1 || strcmp(argv[0], argv[1]) == 0)) {
2161		(void) fprintf(stderr, gettext("cannot import '%s': "
2162		    "a pool with that name already exists\n"),
2163		    argv[0]);
2164		(void) fprintf(stderr, gettext("use the form '%s "
2165		    "<pool | id> <newpool>' to give it a new name\n"),
2166		    "zpool import");
2167		err = 1;
2168	} else if (pools == NULL && idata.exists) {
2169		(void) fprintf(stderr, gettext("cannot import '%s': "
2170		    "a pool with that name is already created/imported,\n"),
2171		    argv[0]);
2172		(void) fprintf(stderr, gettext("and no additional pools "
2173		    "with that name were found\n"));
2174		err = 1;
2175	} else if (pools == NULL) {
2176		if (argc != 0) {
2177			(void) fprintf(stderr, gettext("cannot import '%s': "
2178			    "no such pool available\n"), argv[0]);
2179		}
2180		err = 1;
2181	}
2182
2183	if (err == 1) {
2184		free(searchdirs);
2185		nvlist_free(policy);
2186		return (1);
2187	}
2188
2189	/*
2190	 * At this point we have a list of import candidate configs. Even if
2191	 * we were searching by pool name or guid, we still need to
2192	 * post-process the list to deal with pool state and possible
2193	 * duplicate names.
2194	 */
2195	err = 0;
2196	elem = NULL;
2197	first = B_TRUE;
2198	while ((elem = nvlist_next_nvpair(pools, elem)) != NULL) {
2199
2200		verify(nvpair_value_nvlist(elem, &config) == 0);
2201
2202		verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
2203		    &pool_state) == 0);
2204		if (!do_destroyed && pool_state == POOL_STATE_DESTROYED)
2205			continue;
2206		if (do_destroyed && pool_state != POOL_STATE_DESTROYED)
2207			continue;
2208
2209		verify(nvlist_add_nvlist(config, ZPOOL_REWIND_POLICY,
2210		    policy) == 0);
2211
2212		if (argc == 0) {
2213			if (first)
2214				first = B_FALSE;
2215			else if (!do_all)
2216				(void) printf("\n");
2217
2218			if (do_all) {
2219				err |= do_import(config, NULL, mntopts,
2220				    props, flags);
2221			} else {
2222				show_import(config);
2223			}
2224		} else if (searchname != NULL) {
2225			char *name;
2226
2227			/*
2228			 * We are searching for a pool based on name.
2229			 */
2230			verify(nvlist_lookup_string(config,
2231			    ZPOOL_CONFIG_POOL_NAME, &name) == 0);
2232
2233			if (strcmp(name, searchname) == 0) {
2234				if (found_config != NULL) {
2235					(void) fprintf(stderr, gettext(
2236					    "cannot import '%s': more than "
2237					    "one matching pool\n"), searchname);
2238					(void) fprintf(stderr, gettext(
2239					    "import by numeric ID instead\n"));
2240					err = B_TRUE;
2241				}
2242				found_config = config;
2243			}
2244		} else {
2245			uint64_t guid;
2246
2247			/*
2248			 * Search for a pool by guid.
2249			 */
2250			verify(nvlist_lookup_uint64(config,
2251			    ZPOOL_CONFIG_POOL_GUID, &guid) == 0);
2252
2253			if (guid == searchguid)
2254				found_config = config;
2255		}
2256	}
2257
2258	/*
2259	 * If we were searching for a specific pool, verify that we found a
2260	 * pool, and then do the import.
2261	 */
2262	if (argc != 0 && err == 0) {
2263		if (found_config == NULL) {
2264			(void) fprintf(stderr, gettext("cannot import '%s': "
2265			    "no such pool available\n"), argv[0]);
2266			err = B_TRUE;
2267		} else {
2268			err |= do_import(found_config, argc == 1 ? NULL :
2269			    argv[1], mntopts, props, flags);
2270		}
2271	}
2272
2273	/*
2274	 * If we were just looking for pools, report an error if none were
2275	 * found.
2276	 */
2277	if (argc == 0 && first)
2278		(void) fprintf(stderr,
2279		    gettext("no pools available to import\n"));
2280
2281error:
2282	nvlist_free(props);
2283	nvlist_free(pools);
2284	nvlist_free(policy);
2285	free(searchdirs);
2286
2287	return (err ? 1 : 0);
2288}
2289
2290typedef struct iostat_cbdata {
2291	boolean_t cb_verbose;
2292	int cb_namewidth;
2293	int cb_iteration;
2294	zpool_list_t *cb_list;
2295} iostat_cbdata_t;
2296
2297static void
2298print_iostat_separator(iostat_cbdata_t *cb)
2299{
2300	int i = 0;
2301
2302	for (i = 0; i < cb->cb_namewidth; i++)
2303		(void) printf("-");
2304	(void) printf("  -----  -----  -----  -----  -----  -----\n");
2305}
2306
2307static void
2308print_iostat_header(iostat_cbdata_t *cb)
2309{
2310	(void) printf("%*s     capacity     operations    bandwidth\n",
2311	    cb->cb_namewidth, "");
2312	(void) printf("%-*s  alloc   free   read  write   read  write\n",
2313	    cb->cb_namewidth, "pool");
2314	print_iostat_separator(cb);
2315}
2316
2317/*
2318 * Display a single statistic.
2319 */
2320static void
2321print_one_stat(uint64_t value)
2322{
2323	char buf[64];
2324
2325	zfs_nicenum(value, buf, sizeof (buf));
2326	(void) printf("  %5s", buf);
2327}
2328
2329/*
2330 * Print out all the statistics for the given vdev.  This can either be the
2331 * toplevel configuration, or called recursively.  If 'name' is NULL, then this
2332 * is a verbose output, and we don't want to display the toplevel pool stats.
2333 */
2334void
2335print_vdev_stats(zpool_handle_t *zhp, const char *name, nvlist_t *oldnv,
2336    nvlist_t *newnv, iostat_cbdata_t *cb, int depth)
2337{
2338	nvlist_t **oldchild, **newchild;
2339	uint_t c, children;
2340	vdev_stat_t *oldvs, *newvs;
2341	vdev_stat_t zerovs = { 0 };
2342	uint64_t tdelta;
2343	double scale;
2344	char *vname;
2345
2346	if (oldnv != NULL) {
2347		verify(nvlist_lookup_uint64_array(oldnv,
2348		    ZPOOL_CONFIG_VDEV_STATS, (uint64_t **)&oldvs, &c) == 0);
2349	} else {
2350		oldvs = &zerovs;
2351	}
2352
2353	verify(nvlist_lookup_uint64_array(newnv, ZPOOL_CONFIG_VDEV_STATS,
2354	    (uint64_t **)&newvs, &c) == 0);
2355
2356	if (strlen(name) + depth > cb->cb_namewidth)
2357		(void) printf("%*s%s", depth, "", name);
2358	else
2359		(void) printf("%*s%s%*s", depth, "", name,
2360		    (int)(cb->cb_namewidth - strlen(name) - depth), "");
2361
2362	tdelta = newvs->vs_timestamp - oldvs->vs_timestamp;
2363
2364	if (tdelta == 0)
2365		scale = 1.0;
2366	else
2367		scale = (double)NANOSEC / tdelta;
2368
2369	/* only toplevel vdevs have capacity stats */
2370	if (newvs->vs_space == 0) {
2371		(void) printf("      -      -");
2372	} else {
2373		print_one_stat(newvs->vs_alloc);
2374		print_one_stat(newvs->vs_space - newvs->vs_alloc);
2375	}
2376
2377	print_one_stat((uint64_t)(scale * (newvs->vs_ops[ZIO_TYPE_READ] -
2378	    oldvs->vs_ops[ZIO_TYPE_READ])));
2379
2380	print_one_stat((uint64_t)(scale * (newvs->vs_ops[ZIO_TYPE_WRITE] -
2381	    oldvs->vs_ops[ZIO_TYPE_WRITE])));
2382
2383	print_one_stat((uint64_t)(scale * (newvs->vs_bytes[ZIO_TYPE_READ] -
2384	    oldvs->vs_bytes[ZIO_TYPE_READ])));
2385
2386	print_one_stat((uint64_t)(scale * (newvs->vs_bytes[ZIO_TYPE_WRITE] -
2387	    oldvs->vs_bytes[ZIO_TYPE_WRITE])));
2388
2389	(void) printf("\n");
2390
2391	if (!cb->cb_verbose)
2392		return;
2393
2394	if (nvlist_lookup_nvlist_array(newnv, ZPOOL_CONFIG_CHILDREN,
2395	    &newchild, &children) != 0)
2396		return;
2397
2398	if (oldnv && nvlist_lookup_nvlist_array(oldnv, ZPOOL_CONFIG_CHILDREN,
2399	    &oldchild, &c) != 0)
2400		return;
2401
2402	for (c = 0; c < children; c++) {
2403		uint64_t ishole = B_FALSE, islog = B_FALSE;
2404
2405		(void) nvlist_lookup_uint64(newchild[c], ZPOOL_CONFIG_IS_HOLE,
2406		    &ishole);
2407
2408		(void) nvlist_lookup_uint64(newchild[c], ZPOOL_CONFIG_IS_LOG,
2409		    &islog);
2410
2411		if (ishole || islog)
2412			continue;
2413
2414		vname = zpool_vdev_name(g_zfs, zhp, newchild[c], B_FALSE);
2415		print_vdev_stats(zhp, vname, oldnv ? oldchild[c] : NULL,
2416		    newchild[c], cb, depth + 2);
2417		free(vname);
2418	}
2419
2420	/*
2421	 * Log device section
2422	 */
2423
2424	if (num_logs(newnv) > 0) {
2425		(void) printf("%-*s      -      -      -      -      -      "
2426		    "-\n", cb->cb_namewidth, "logs");
2427
2428		for (c = 0; c < children; c++) {
2429			uint64_t islog = B_FALSE;
2430			(void) nvlist_lookup_uint64(newchild[c],
2431			    ZPOOL_CONFIG_IS_LOG, &islog);
2432
2433			if (islog) {
2434				vname = zpool_vdev_name(g_zfs, zhp, newchild[c],
2435				    B_FALSE);
2436				print_vdev_stats(zhp, vname, oldnv ?
2437				    oldchild[c] : NULL, newchild[c],
2438				    cb, depth + 2);
2439				free(vname);
2440			}
2441		}
2442
2443	}
2444
2445	/*
2446	 * Include level 2 ARC devices in iostat output
2447	 */
2448	if (nvlist_lookup_nvlist_array(newnv, ZPOOL_CONFIG_L2CACHE,
2449	    &newchild, &children) != 0)
2450		return;
2451
2452	if (oldnv && nvlist_lookup_nvlist_array(oldnv, ZPOOL_CONFIG_L2CACHE,
2453	    &oldchild, &c) != 0)
2454		return;
2455
2456	if (children > 0) {
2457		(void) printf("%-*s      -      -      -      -      -      "
2458		    "-\n", cb->cb_namewidth, "cache");
2459		for (c = 0; c < children; c++) {
2460			vname = zpool_vdev_name(g_zfs, zhp, newchild[c],
2461			    B_FALSE);
2462			print_vdev_stats(zhp, vname, oldnv ? oldchild[c] : NULL,
2463			    newchild[c], cb, depth + 2);
2464			free(vname);
2465		}
2466	}
2467}
2468
2469static int
2470refresh_iostat(zpool_handle_t *zhp, void *data)
2471{
2472	iostat_cbdata_t *cb = data;
2473	boolean_t missing;
2474
2475	/*
2476	 * If the pool has disappeared, remove it from the list and continue.
2477	 */
2478	if (zpool_refresh_stats(zhp, &missing) != 0)
2479		return (-1);
2480
2481	if (missing)
2482		pool_list_remove(cb->cb_list, zhp);
2483
2484	return (0);
2485}
2486
2487/*
2488 * Callback to print out the iostats for the given pool.
2489 */
2490int
2491print_iostat(zpool_handle_t *zhp, void *data)
2492{
2493	iostat_cbdata_t *cb = data;
2494	nvlist_t *oldconfig, *newconfig;
2495	nvlist_t *oldnvroot, *newnvroot;
2496
2497	newconfig = zpool_get_config(zhp, &oldconfig);
2498
2499	if (cb->cb_iteration == 1)
2500		oldconfig = NULL;
2501
2502	verify(nvlist_lookup_nvlist(newconfig, ZPOOL_CONFIG_VDEV_TREE,
2503	    &newnvroot) == 0);
2504
2505	if (oldconfig == NULL)
2506		oldnvroot = NULL;
2507	else
2508		verify(nvlist_lookup_nvlist(oldconfig, ZPOOL_CONFIG_VDEV_TREE,
2509		    &oldnvroot) == 0);
2510
2511	/*
2512	 * Print out the statistics for the pool.
2513	 */
2514	print_vdev_stats(zhp, zpool_get_name(zhp), oldnvroot, newnvroot, cb, 0);
2515
2516	if (cb->cb_verbose)
2517		print_iostat_separator(cb);
2518
2519	return (0);
2520}
2521
2522int
2523get_namewidth(zpool_handle_t *zhp, void *data)
2524{
2525	iostat_cbdata_t *cb = data;
2526	nvlist_t *config, *nvroot;
2527
2528	if ((config = zpool_get_config(zhp, NULL)) != NULL) {
2529		verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
2530		    &nvroot) == 0);
2531		if (!cb->cb_verbose)
2532			cb->cb_namewidth = strlen(zpool_get_name(zhp));
2533		else
2534			cb->cb_namewidth = max_width(zhp, nvroot, 0,
2535			    cb->cb_namewidth);
2536	}
2537
2538	/*
2539	 * The width must fall into the range [10,38].  The upper limit is the
2540	 * maximum we can have and still fit in 80 columns.
2541	 */
2542	if (cb->cb_namewidth < 10)
2543		cb->cb_namewidth = 10;
2544	if (cb->cb_namewidth > 38)
2545		cb->cb_namewidth = 38;
2546
2547	return (0);
2548}
2549
2550/*
2551 * Parse the input string, get the 'interval' and 'count' value if there is one.
2552 */
2553static void
2554get_interval_count(int *argcp, char **argv, unsigned long *iv,
2555    unsigned long *cnt)
2556{
2557	unsigned long interval = 0, count = 0;
2558	int argc = *argcp, errno;
2559
2560	/*
2561	 * Determine if the last argument is an integer or a pool name
2562	 */
2563	if (argc > 0 && isdigit(argv[argc - 1][0])) {
2564		char *end;
2565
2566		errno = 0;
2567		interval = strtoul(argv[argc - 1], &end, 10);
2568
2569		if (*end == '\0' && errno == 0) {
2570			if (interval == 0) {
2571				(void) fprintf(stderr, gettext("interval "
2572				    "cannot be zero\n"));
2573				usage(B_FALSE);
2574			}
2575			/*
2576			 * Ignore the last parameter
2577			 */
2578			argc--;
2579		} else {
2580			/*
2581			 * If this is not a valid number, just plow on.  The
2582			 * user will get a more informative error message later
2583			 * on.
2584			 */
2585			interval = 0;
2586		}
2587	}
2588
2589	/*
2590	 * If the last argument is also an integer, then we have both a count
2591	 * and an interval.
2592	 */
2593	if (argc > 0 && isdigit(argv[argc - 1][0])) {
2594		char *end;
2595
2596		errno = 0;
2597		count = interval;
2598		interval = strtoul(argv[argc - 1], &end, 10);
2599
2600		if (*end == '\0' && errno == 0) {
2601			if (interval == 0) {
2602				(void) fprintf(stderr, gettext("interval "
2603				    "cannot be zero\n"));
2604				usage(B_FALSE);
2605			}
2606
2607			/*
2608			 * Ignore the last parameter
2609			 */
2610			argc--;
2611		} else {
2612			interval = 0;
2613		}
2614	}
2615
2616	*iv = interval;
2617	*cnt = count;
2618	*argcp = argc;
2619}
2620
2621static void
2622get_timestamp_arg(char c)
2623{
2624	if (c == 'u')
2625		timestamp_fmt = UDATE;
2626	else if (c == 'd')
2627		timestamp_fmt = DDATE;
2628	else
2629		usage(B_FALSE);
2630}
2631
2632/*
2633 * zpool iostat [-v] [-T d|u] [pool] ... [interval [count]]
2634 *
2635 *	-v	Display statistics for individual vdevs
2636 *	-T	Display a timestamp in date(1) or Unix format
2637 *
2638 * This command can be tricky because we want to be able to deal with pool
2639 * creation/destruction as well as vdev configuration changes.  The bulk of this
2640 * processing is handled by the pool_list_* routines in zpool_iter.c.  We rely
2641 * on pool_list_update() to detect the addition of new pools.  Configuration
2642 * changes are all handled within libzfs.
2643 */
2644int
2645zpool_do_iostat(int argc, char **argv)
2646{
2647	int c;
2648	int ret;
2649	int npools;
2650	unsigned long interval = 0, count = 0;
2651	zpool_list_t *list;
2652	boolean_t verbose = B_FALSE;
2653	iostat_cbdata_t cb;
2654
2655	/* check options */
2656	while ((c = getopt(argc, argv, "T:v")) != -1) {
2657		switch (c) {
2658		case 'T':
2659			get_timestamp_arg(*optarg);
2660			break;
2661		case 'v':
2662			verbose = B_TRUE;
2663			break;
2664		case '?':
2665			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
2666			    optopt);
2667			usage(B_FALSE);
2668		}
2669	}
2670
2671	argc -= optind;
2672	argv += optind;
2673
2674	get_interval_count(&argc, argv, &interval, &count);
2675
2676	/*
2677	 * Construct the list of all interesting pools.
2678	 */
2679	ret = 0;
2680	if ((list = pool_list_get(argc, argv, NULL, &ret)) == NULL)
2681		return (1);
2682
2683	if (pool_list_count(list) == 0 && argc != 0) {
2684		pool_list_free(list);
2685		return (1);
2686	}
2687
2688	if (pool_list_count(list) == 0 && interval == 0) {
2689		pool_list_free(list);
2690		(void) fprintf(stderr, gettext("no pools available\n"));
2691		return (1);
2692	}
2693
2694	/*
2695	 * Enter the main iostat loop.
2696	 */
2697	cb.cb_list = list;
2698	cb.cb_verbose = verbose;
2699	cb.cb_iteration = 0;
2700	cb.cb_namewidth = 0;
2701
2702	for (;;) {
2703		pool_list_update(list);
2704
2705		if ((npools = pool_list_count(list)) == 0)
2706			break;
2707
2708		/*
2709		 * Refresh all statistics.  This is done as an explicit step
2710		 * before calculating the maximum name width, so that any
2711		 * configuration changes are properly accounted for.
2712		 */
2713		(void) pool_list_iter(list, B_FALSE, refresh_iostat, &cb);
2714
2715		/*
2716		 * Iterate over all pools to determine the maximum width
2717		 * for the pool / device name column across all pools.
2718		 */
2719		cb.cb_namewidth = 0;
2720		(void) pool_list_iter(list, B_FALSE, get_namewidth, &cb);
2721
2722		if (timestamp_fmt != NODATE)
2723			print_timestamp(timestamp_fmt);
2724
2725		/*
2726		 * If it's the first time, or verbose mode, print the header.
2727		 */
2728		if (++cb.cb_iteration == 1 || verbose)
2729			print_iostat_header(&cb);
2730
2731		(void) pool_list_iter(list, B_FALSE, print_iostat, &cb);
2732
2733		/*
2734		 * If there's more than one pool, and we're not in verbose mode
2735		 * (which prints a separator for us), then print a separator.
2736		 */
2737		if (npools > 1 && !verbose)
2738			print_iostat_separator(&cb);
2739
2740		if (verbose)
2741			(void) printf("\n");
2742
2743		/*
2744		 * Flush the output so that redirection to a file isn't buffered
2745		 * indefinitely.
2746		 */
2747		(void) fflush(stdout);
2748
2749		if (interval == 0)
2750			break;
2751
2752		if (count != 0 && --count == 0)
2753			break;
2754
2755		(void) sleep(interval);
2756	}
2757
2758	pool_list_free(list);
2759
2760	return (ret);
2761}
2762
2763typedef struct list_cbdata {
2764	boolean_t	cb_verbose;
2765	int		cb_namewidth;
2766	boolean_t	cb_scripted;
2767	zprop_list_t	*cb_proplist;
2768} list_cbdata_t;
2769
2770/*
2771 * Given a list of columns to display, output appropriate headers for each one.
2772 */
2773static void
2774print_header(list_cbdata_t *cb)
2775{
2776	zprop_list_t *pl = cb->cb_proplist;
2777	char headerbuf[ZPOOL_MAXPROPLEN];
2778	const char *header;
2779	boolean_t first = B_TRUE;
2780	boolean_t right_justify;
2781	size_t width = 0;
2782
2783	for (; pl != NULL; pl = pl->pl_next) {
2784		width = pl->pl_width;
2785		if (first && cb->cb_verbose) {
2786			/*
2787			 * Reset the width to accommodate the verbose listing
2788			 * of devices.
2789			 */
2790			width = cb->cb_namewidth;
2791		}
2792
2793		if (!first)
2794			(void) printf("  ");
2795		else
2796			first = B_FALSE;
2797
2798		right_justify = B_FALSE;
2799		if (pl->pl_prop != ZPROP_INVAL) {
2800			header = zpool_prop_column_name(pl->pl_prop);
2801			right_justify = zpool_prop_align_right(pl->pl_prop);
2802		} else {
2803			int i;
2804
2805			for (i = 0; pl->pl_user_prop[i] != '\0'; i++)
2806				headerbuf[i] = toupper(pl->pl_user_prop[i]);
2807			headerbuf[i] = '\0';
2808			header = headerbuf;
2809		}
2810
2811		if (pl->pl_next == NULL && !right_justify)
2812			(void) printf("%s", header);
2813		else if (right_justify)
2814			(void) printf("%*s", width, header);
2815		else
2816			(void) printf("%-*s", width, header);
2817
2818	}
2819
2820	(void) printf("\n");
2821}
2822
2823/*
2824 * Given a pool and a list of properties, print out all the properties according
2825 * to the described layout.
2826 */
2827static void
2828print_pool(zpool_handle_t *zhp, list_cbdata_t *cb)
2829{
2830	zprop_list_t *pl = cb->cb_proplist;
2831	boolean_t first = B_TRUE;
2832	char property[ZPOOL_MAXPROPLEN];
2833	char *propstr;
2834	boolean_t right_justify;
2835	size_t width;
2836
2837	for (; pl != NULL; pl = pl->pl_next) {
2838
2839		width = pl->pl_width;
2840		if (first && cb->cb_verbose) {
2841			/*
2842			 * Reset the width to accommodate the verbose listing
2843			 * of devices.
2844			 */
2845			width = cb->cb_namewidth;
2846		}
2847
2848		if (!first) {
2849			if (cb->cb_scripted)
2850				(void) printf("\t");
2851			else
2852				(void) printf("  ");
2853		} else {
2854			first = B_FALSE;
2855		}
2856
2857		right_justify = B_FALSE;
2858		if (pl->pl_prop != ZPROP_INVAL) {
2859			if (pl->pl_prop == ZPOOL_PROP_EXPANDSZ &&
2860			    zpool_get_prop_int(zhp, pl->pl_prop, NULL) == 0)
2861				propstr = "-";
2862			else if (zpool_get_prop(zhp, pl->pl_prop, property,
2863			    sizeof (property), NULL) != 0)
2864				propstr = "-";
2865			else
2866				propstr = property;
2867
2868			right_justify = zpool_prop_align_right(pl->pl_prop);
2869		} else if ((zpool_prop_feature(pl->pl_user_prop) ||
2870		    zpool_prop_unsupported(pl->pl_user_prop)) &&
2871		    zpool_prop_get_feature(zhp, pl->pl_user_prop, property,
2872		    sizeof (property)) == 0) {
2873			propstr = property;
2874		} else {
2875			propstr = "-";
2876		}
2877
2878
2879		/*
2880		 * If this is being called in scripted mode, or if this is the
2881		 * last column and it is left-justified, don't include a width
2882		 * format specifier.
2883		 */
2884		if (cb->cb_scripted || (pl->pl_next == NULL && !right_justify))
2885			(void) printf("%s", propstr);
2886		else if (right_justify)
2887			(void) printf("%*s", width, propstr);
2888		else
2889			(void) printf("%-*s", width, propstr);
2890	}
2891
2892	(void) printf("\n");
2893}
2894
2895static void
2896print_one_column(zpool_prop_t prop, uint64_t value, boolean_t scripted)
2897{
2898	char propval[64];
2899	boolean_t fixed;
2900	size_t width = zprop_width(prop, &fixed, ZFS_TYPE_POOL);
2901
2902	zfs_nicenum(value, propval, sizeof (propval));
2903
2904	if (prop == ZPOOL_PROP_EXPANDSZ && value == 0)
2905		(void) strlcpy(propval, "-", sizeof (propval));
2906
2907	if (scripted)
2908		(void) printf("\t%s", propval);
2909	else
2910		(void) printf("  %*s", width, propval);
2911}
2912
2913void
2914print_list_stats(zpool_handle_t *zhp, const char *name, nvlist_t *nv,
2915    list_cbdata_t *cb, int depth)
2916{
2917	nvlist_t **child;
2918	vdev_stat_t *vs;
2919	uint_t c, children;
2920	char *vname;
2921	boolean_t scripted = cb->cb_scripted;
2922
2923	verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
2924	    (uint64_t **)&vs, &c) == 0);
2925
2926	if (name != NULL) {
2927		if (scripted)
2928			(void) printf("\t%s", name);
2929		else if (strlen(name) + depth > cb->cb_namewidth)
2930			(void) printf("%*s%s", depth, "", name);
2931		else
2932			(void) printf("%*s%s%*s", depth, "", name,
2933			    (int)(cb->cb_namewidth - strlen(name) - depth), "");
2934
2935		/* only toplevel vdevs have capacity stats */
2936		if (vs->vs_space == 0) {
2937			if (scripted)
2938				(void) printf("\t-\t-\t-");
2939			else
2940				(void) printf("      -      -      -");
2941		} else {
2942			print_one_column(ZPOOL_PROP_SIZE, vs->vs_space,
2943			    scripted);
2944			print_one_column(ZPOOL_PROP_CAPACITY, vs->vs_alloc,
2945			    scripted);
2946			print_one_column(ZPOOL_PROP_FREE,
2947			    vs->vs_space - vs->vs_alloc, scripted);
2948		}
2949		print_one_column(ZPOOL_PROP_EXPANDSZ, vs->vs_esize,
2950		    scripted);
2951		(void) printf("\n");
2952	}
2953
2954	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
2955	    &child, &children) != 0)
2956		return;
2957
2958	for (c = 0; c < children; c++) {
2959		uint64_t ishole = B_FALSE;
2960
2961		if (nvlist_lookup_uint64(child[c],
2962		    ZPOOL_CONFIG_IS_HOLE, &ishole) == 0 && ishole)
2963			continue;
2964
2965		vname = zpool_vdev_name(g_zfs, zhp, child[c], B_FALSE);
2966		print_list_stats(zhp, vname, child[c], cb, depth + 2);
2967		free(vname);
2968	}
2969
2970	/*
2971	 * Include level 2 ARC devices in iostat output
2972	 */
2973	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE,
2974	    &child, &children) != 0)
2975		return;
2976
2977	if (children > 0) {
2978		(void) printf("%-*s      -      -      -      -      -      "
2979		    "-\n", cb->cb_namewidth, "cache");
2980		for (c = 0; c < children; c++) {
2981			vname = zpool_vdev_name(g_zfs, zhp, child[c],
2982			    B_FALSE);
2983			print_list_stats(zhp, vname, child[c], cb, depth + 2);
2984			free(vname);
2985		}
2986	}
2987}
2988
2989
2990/*
2991 * Generic callback function to list a pool.
2992 */
2993int
2994list_callback(zpool_handle_t *zhp, void *data)
2995{
2996	list_cbdata_t *cbp = data;
2997	nvlist_t *config;
2998	nvlist_t *nvroot;
2999
3000	config = zpool_get_config(zhp, NULL);
3001
3002	print_pool(zhp, cbp);
3003	if (!cbp->cb_verbose)
3004		return (0);
3005
3006	verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
3007	    &nvroot) == 0);
3008	print_list_stats(zhp, NULL, nvroot, cbp, 0);
3009
3010	return (0);
3011}
3012
3013/*
3014 * zpool list [-H] [-o prop[,prop]*] [-T d|u] [pool] ... [interval [count]]
3015 *
3016 *	-H	Scripted mode.  Don't display headers, and separate properties
3017 *		by a single tab.
3018 *	-o	List of properties to display.  Defaults to
3019 *		"name,size,allocated,free,capacity,health,altroot"
3020 *	-T	Display a timestamp in date(1) or Unix format
3021 *
3022 * List all pools in the system, whether or not they're healthy.  Output space
3023 * statistics for each one, as well as health status summary.
3024 */
3025int
3026zpool_do_list(int argc, char **argv)
3027{
3028	int c;
3029	int ret;
3030	list_cbdata_t cb = { 0 };
3031	static char default_props[] =
3032	    "name,size,allocated,free,capacity,dedupratio,"
3033	    "health,altroot";
3034	char *props = default_props;
3035	unsigned long interval = 0, count = 0;
3036	zpool_list_t *list;
3037	boolean_t first = B_TRUE;
3038
3039	/* check options */
3040	while ((c = getopt(argc, argv, ":Ho:T:v")) != -1) {
3041		switch (c) {
3042		case 'H':
3043			cb.cb_scripted = B_TRUE;
3044			break;
3045		case 'o':
3046			props = optarg;
3047			break;
3048		case 'T':
3049			get_timestamp_arg(*optarg);
3050			break;
3051		case 'v':
3052			cb.cb_verbose = B_TRUE;
3053			break;
3054		case ':':
3055			(void) fprintf(stderr, gettext("missing argument for "
3056			    "'%c' option\n"), optopt);
3057			usage(B_FALSE);
3058			break;
3059		case '?':
3060			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3061			    optopt);
3062			usage(B_FALSE);
3063		}
3064	}
3065
3066	argc -= optind;
3067	argv += optind;
3068
3069	get_interval_count(&argc, argv, &interval, &count);
3070
3071	if (zprop_get_list(g_zfs, props, &cb.cb_proplist, ZFS_TYPE_POOL) != 0)
3072		usage(B_FALSE);
3073
3074	if ((list = pool_list_get(argc, argv, &cb.cb_proplist, &ret)) == NULL)
3075		return (1);
3076
3077	if (argc == 0 && !cb.cb_scripted && pool_list_count(list) == 0) {
3078		(void) printf(gettext("no pools available\n"));
3079		zprop_free_list(cb.cb_proplist);
3080		return (0);
3081	}
3082
3083	for (;;) {
3084		pool_list_update(list);
3085
3086		if (pool_list_count(list) == 0)
3087			break;
3088
3089		cb.cb_namewidth = 0;
3090		(void) pool_list_iter(list, B_FALSE, get_namewidth, &cb);
3091
3092		if (timestamp_fmt != NODATE)
3093			print_timestamp(timestamp_fmt);
3094
3095		if (!cb.cb_scripted && (first || cb.cb_verbose)) {
3096			print_header(&cb);
3097			first = B_FALSE;
3098		}
3099		ret = pool_list_iter(list, B_TRUE, list_callback, &cb);
3100
3101		if (interval == 0)
3102			break;
3103
3104		if (count != 0 && --count == 0)
3105			break;
3106
3107		(void) sleep(interval);
3108	}
3109
3110	zprop_free_list(cb.cb_proplist);
3111	return (ret);
3112}
3113
3114static nvlist_t *
3115zpool_get_vdev_by_name(nvlist_t *nv, char *name)
3116{
3117	nvlist_t **child;
3118	uint_t c, children;
3119	nvlist_t *match;
3120	char *path;
3121
3122	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
3123	    &child, &children) != 0) {
3124		verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0);
3125		if (strncmp(name, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
3126			name += sizeof(_PATH_DEV) - 1;
3127		if (strncmp(path, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
3128			path += sizeof(_PATH_DEV) - 1;
3129		if (strcmp(name, path) == 0)
3130			return (nv);
3131		return (NULL);
3132	}
3133
3134	for (c = 0; c < children; c++)
3135		if ((match = zpool_get_vdev_by_name(child[c], name)) != NULL)
3136			return (match);
3137
3138	return (NULL);
3139}
3140
3141static int
3142zpool_do_attach_or_replace(int argc, char **argv, int replacing)
3143{
3144	boolean_t force = B_FALSE;
3145	int c;
3146	nvlist_t *nvroot;
3147	char *poolname, *old_disk, *new_disk;
3148	zpool_handle_t *zhp;
3149	int ret;
3150
3151	/* check options */
3152	while ((c = getopt(argc, argv, "f")) != -1) {
3153		switch (c) {
3154		case 'f':
3155			force = B_TRUE;
3156			break;
3157		case '?':
3158			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3159			    optopt);
3160			usage(B_FALSE);
3161		}
3162	}
3163
3164	argc -= optind;
3165	argv += optind;
3166
3167	/* get pool name and check number of arguments */
3168	if (argc < 1) {
3169		(void) fprintf(stderr, gettext("missing pool name argument\n"));
3170		usage(B_FALSE);
3171	}
3172
3173	poolname = argv[0];
3174
3175	if (argc < 2) {
3176		(void) fprintf(stderr,
3177		    gettext("missing <device> specification\n"));
3178		usage(B_FALSE);
3179	}
3180
3181	old_disk = argv[1];
3182
3183	if (argc < 3) {
3184		if (!replacing) {
3185			(void) fprintf(stderr,
3186			    gettext("missing <new_device> specification\n"));
3187			usage(B_FALSE);
3188		}
3189		new_disk = old_disk;
3190		argc -= 1;
3191		argv += 1;
3192	} else {
3193		new_disk = argv[2];
3194		argc -= 2;
3195		argv += 2;
3196	}
3197
3198	if (argc > 1) {
3199		(void) fprintf(stderr, gettext("too many arguments\n"));
3200		usage(B_FALSE);
3201	}
3202
3203	if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3204		return (1);
3205
3206	if (zpool_get_config(zhp, NULL) == NULL) {
3207		(void) fprintf(stderr, gettext("pool '%s' is unavailable\n"),
3208		    poolname);
3209		zpool_close(zhp);
3210		return (1);
3211	}
3212
3213	nvroot = make_root_vdev(zhp, force, B_FALSE, replacing, B_FALSE,
3214	    argc, argv);
3215	if (nvroot == NULL) {
3216		zpool_close(zhp);
3217		return (1);
3218	}
3219
3220	ret = zpool_vdev_attach(zhp, old_disk, new_disk, nvroot, replacing);
3221
3222	nvlist_free(nvroot);
3223	zpool_close(zhp);
3224
3225	return (ret);
3226}
3227
3228/*
3229 * zpool replace [-f] <pool> <device> <new_device>
3230 *
3231 *	-f	Force attach, even if <new_device> appears to be in use.
3232 *
3233 * Replace <device> with <new_device>.
3234 */
3235/* ARGSUSED */
3236int
3237zpool_do_replace(int argc, char **argv)
3238{
3239	return (zpool_do_attach_or_replace(argc, argv, B_TRUE));
3240}
3241
3242/*
3243 * zpool attach [-f] <pool> <device> <new_device>
3244 *
3245 *	-f	Force attach, even if <new_device> appears to be in use.
3246 *
3247 * Attach <new_device> to the mirror containing <device>.  If <device> is not
3248 * part of a mirror, then <device> will be transformed into a mirror of
3249 * <device> and <new_device>.  In either case, <new_device> will begin life
3250 * with a DTL of [0, now], and will immediately begin to resilver itself.
3251 */
3252int
3253zpool_do_attach(int argc, char **argv)
3254{
3255	return (zpool_do_attach_or_replace(argc, argv, B_FALSE));
3256}
3257
3258/*
3259 * zpool detach [-f] <pool> <device>
3260 *
3261 *	-f	Force detach of <device>, even if DTLs argue against it
3262 *		(not supported yet)
3263 *
3264 * Detach a device from a mirror.  The operation will be refused if <device>
3265 * is the last device in the mirror, or if the DTLs indicate that this device
3266 * has the only valid copy of some data.
3267 */
3268/* ARGSUSED */
3269int
3270zpool_do_detach(int argc, char **argv)
3271{
3272	int c;
3273	char *poolname, *path;
3274	zpool_handle_t *zhp;
3275	int ret;
3276
3277	/* check options */
3278	while ((c = getopt(argc, argv, "f")) != -1) {
3279		switch (c) {
3280		case 'f':
3281		case '?':
3282			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3283			    optopt);
3284			usage(B_FALSE);
3285		}
3286	}
3287
3288	argc -= optind;
3289	argv += optind;
3290
3291	/* get pool name and check number of arguments */
3292	if (argc < 1) {
3293		(void) fprintf(stderr, gettext("missing pool name argument\n"));
3294		usage(B_FALSE);
3295	}
3296
3297	if (argc < 2) {
3298		(void) fprintf(stderr,
3299		    gettext("missing <device> specification\n"));
3300		usage(B_FALSE);
3301	}
3302
3303	poolname = argv[0];
3304	path = argv[1];
3305
3306	if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3307		return (1);
3308
3309	ret = zpool_vdev_detach(zhp, path);
3310
3311	zpool_close(zhp);
3312
3313	return (ret);
3314}
3315
3316/*
3317 * zpool split [-n] [-o prop=val] ...
3318 *		[-o mntopt] ...
3319 *		[-R altroot] <pool> <newpool> [<device> ...]
3320 *
3321 *	-n	Do not split the pool, but display the resulting layout if
3322 *		it were to be split.
3323 *	-o	Set property=value, or set mount options.
3324 *	-R	Mount the split-off pool under an alternate root.
3325 *
3326 * Splits the named pool and gives it the new pool name.  Devices to be split
3327 * off may be listed, provided that no more than one device is specified
3328 * per top-level vdev mirror.  The newly split pool is left in an exported
3329 * state unless -R is specified.
3330 *
3331 * Restrictions: the top-level of the pool pool must only be made up of
3332 * mirrors; all devices in the pool must be healthy; no device may be
3333 * undergoing a resilvering operation.
3334 */
3335int
3336zpool_do_split(int argc, char **argv)
3337{
3338	char *srcpool, *newpool, *propval;
3339	char *mntopts = NULL;
3340	splitflags_t flags;
3341	int c, ret = 0;
3342	zpool_handle_t *zhp;
3343	nvlist_t *config, *props = NULL;
3344
3345	flags.dryrun = B_FALSE;
3346	flags.import = B_FALSE;
3347
3348	/* check options */
3349	while ((c = getopt(argc, argv, ":R:no:")) != -1) {
3350		switch (c) {
3351		case 'R':
3352			flags.import = B_TRUE;
3353			if (add_prop_list(
3354			    zpool_prop_to_name(ZPOOL_PROP_ALTROOT), optarg,
3355			    &props, B_TRUE) != 0) {
3356				if (props)
3357					nvlist_free(props);
3358				usage(B_FALSE);
3359			}
3360			break;
3361		case 'n':
3362			flags.dryrun = B_TRUE;
3363			break;
3364		case 'o':
3365			if ((propval = strchr(optarg, '=')) != NULL) {
3366				*propval = '\0';
3367				propval++;
3368				if (add_prop_list(optarg, propval,
3369				    &props, B_TRUE) != 0) {
3370					if (props)
3371						nvlist_free(props);
3372					usage(B_FALSE);
3373				}
3374			} else {
3375				mntopts = optarg;
3376			}
3377			break;
3378		case ':':
3379			(void) fprintf(stderr, gettext("missing argument for "
3380			    "'%c' option\n"), optopt);
3381			usage(B_FALSE);
3382			break;
3383		case '?':
3384			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3385			    optopt);
3386			usage(B_FALSE);
3387			break;
3388		}
3389	}
3390
3391	if (!flags.import && mntopts != NULL) {
3392		(void) fprintf(stderr, gettext("setting mntopts is only "
3393		    "valid when importing the pool\n"));
3394		usage(B_FALSE);
3395	}
3396
3397	argc -= optind;
3398	argv += optind;
3399
3400	if (argc < 1) {
3401		(void) fprintf(stderr, gettext("Missing pool name\n"));
3402		usage(B_FALSE);
3403	}
3404	if (argc < 2) {
3405		(void) fprintf(stderr, gettext("Missing new pool name\n"));
3406		usage(B_FALSE);
3407	}
3408
3409	srcpool = argv[0];
3410	newpool = argv[1];
3411
3412	argc -= 2;
3413	argv += 2;
3414
3415	if ((zhp = zpool_open(g_zfs, srcpool)) == NULL)
3416		return (1);
3417
3418	config = split_mirror_vdev(zhp, newpool, props, flags, argc, argv);
3419	if (config == NULL) {
3420		ret = 1;
3421	} else {
3422		if (flags.dryrun) {
3423			(void) printf(gettext("would create '%s' with the "
3424			    "following layout:\n\n"), newpool);
3425			print_vdev_tree(NULL, newpool, config, 0, B_FALSE);
3426		}
3427		nvlist_free(config);
3428	}
3429
3430	zpool_close(zhp);
3431
3432	if (ret != 0 || flags.dryrun || !flags.import)
3433		return (ret);
3434
3435	/*
3436	 * The split was successful. Now we need to open the new
3437	 * pool and import it.
3438	 */
3439	if ((zhp = zpool_open_canfail(g_zfs, newpool)) == NULL)
3440		return (1);
3441	if (zpool_get_state(zhp) != POOL_STATE_UNAVAIL &&
3442	    zpool_enable_datasets(zhp, mntopts, 0) != 0) {
3443		ret = 1;
3444		(void) fprintf(stderr, gettext("Split was successful, but "
3445		    "the datasets could not all be mounted\n"));
3446		(void) fprintf(stderr, gettext("Try doing '%s' with a "
3447		    "different altroot\n"), "zpool import");
3448	}
3449	zpool_close(zhp);
3450
3451	return (ret);
3452}
3453
3454
3455
3456/*
3457 * zpool online <pool> <device> ...
3458 */
3459int
3460zpool_do_online(int argc, char **argv)
3461{
3462	int c, i;
3463	char *poolname;
3464	zpool_handle_t *zhp;
3465	int ret = 0;
3466	vdev_state_t newstate;
3467	int flags = 0;
3468
3469	/* check options */
3470	while ((c = getopt(argc, argv, "et")) != -1) {
3471		switch (c) {
3472		case 'e':
3473			flags |= ZFS_ONLINE_EXPAND;
3474			break;
3475		case 't':
3476		case '?':
3477			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3478			    optopt);
3479			usage(B_FALSE);
3480		}
3481	}
3482
3483	argc -= optind;
3484	argv += optind;
3485
3486	/* get pool name and check number of arguments */
3487	if (argc < 1) {
3488		(void) fprintf(stderr, gettext("missing pool name\n"));
3489		usage(B_FALSE);
3490	}
3491	if (argc < 2) {
3492		(void) fprintf(stderr, gettext("missing device name\n"));
3493		usage(B_FALSE);
3494	}
3495
3496	poolname = argv[0];
3497
3498	if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3499		return (1);
3500
3501	for (i = 1; i < argc; i++) {
3502		if (zpool_vdev_online(zhp, argv[i], flags, &newstate) == 0) {
3503			if (newstate != VDEV_STATE_HEALTHY) {
3504				(void) printf(gettext("warning: device '%s' "
3505				    "onlined, but remains in faulted state\n"),
3506				    argv[i]);
3507				if (newstate == VDEV_STATE_FAULTED)
3508					(void) printf(gettext("use 'zpool "
3509					    "clear' to restore a faulted "
3510					    "device\n"));
3511				else
3512					(void) printf(gettext("use 'zpool "
3513					    "replace' to replace devices "
3514					    "that are no longer present\n"));
3515			}
3516		} else {
3517			ret = 1;
3518		}
3519	}
3520
3521	zpool_close(zhp);
3522
3523	return (ret);
3524}
3525
3526/*
3527 * zpool offline [-ft] <pool> <device> ...
3528 *
3529 *	-f	Force the device into the offline state, even if doing
3530 *		so would appear to compromise pool availability.
3531 *		(not supported yet)
3532 *
3533 *	-t	Only take the device off-line temporarily.  The offline
3534 *		state will not be persistent across reboots.
3535 */
3536/* ARGSUSED */
3537int
3538zpool_do_offline(int argc, char **argv)
3539{
3540	int c, i;
3541	char *poolname;
3542	zpool_handle_t *zhp;
3543	int ret = 0;
3544	boolean_t istmp = B_FALSE;
3545
3546	/* check options */
3547	while ((c = getopt(argc, argv, "ft")) != -1) {
3548		switch (c) {
3549		case 't':
3550			istmp = B_TRUE;
3551			break;
3552		case 'f':
3553		case '?':
3554			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3555			    optopt);
3556			usage(B_FALSE);
3557		}
3558	}
3559
3560	argc -= optind;
3561	argv += optind;
3562
3563	/* get pool name and check number of arguments */
3564	if (argc < 1) {
3565		(void) fprintf(stderr, gettext("missing pool name\n"));
3566		usage(B_FALSE);
3567	}
3568	if (argc < 2) {
3569		(void) fprintf(stderr, gettext("missing device name\n"));
3570		usage(B_FALSE);
3571	}
3572
3573	poolname = argv[0];
3574
3575	if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3576		return (1);
3577
3578	for (i = 1; i < argc; i++) {
3579		if (zpool_vdev_offline(zhp, argv[i], istmp) != 0)
3580			ret = 1;
3581	}
3582
3583	zpool_close(zhp);
3584
3585	return (ret);
3586}
3587
3588/*
3589 * zpool clear <pool> [device]
3590 *
3591 * Clear all errors associated with a pool or a particular device.
3592 */
3593int
3594zpool_do_clear(int argc, char **argv)
3595{
3596	int c;
3597	int ret = 0;
3598	boolean_t dryrun = B_FALSE;
3599	boolean_t do_rewind = B_FALSE;
3600	boolean_t xtreme_rewind = B_FALSE;
3601	uint32_t rewind_policy = ZPOOL_NO_REWIND;
3602	nvlist_t *policy = NULL;
3603	zpool_handle_t *zhp;
3604	char *pool, *device;
3605
3606	/* check options */
3607	while ((c = getopt(argc, argv, "FnX")) != -1) {
3608		switch (c) {
3609		case 'F':
3610			do_rewind = B_TRUE;
3611			break;
3612		case 'n':
3613			dryrun = B_TRUE;
3614			break;
3615		case 'X':
3616			xtreme_rewind = B_TRUE;
3617			break;
3618		case '?':
3619			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3620			    optopt);
3621			usage(B_FALSE);
3622		}
3623	}
3624
3625	argc -= optind;
3626	argv += optind;
3627
3628	if (argc < 1) {
3629		(void) fprintf(stderr, gettext("missing pool name\n"));
3630		usage(B_FALSE);
3631	}
3632
3633	if (argc > 2) {
3634		(void) fprintf(stderr, gettext("too many arguments\n"));
3635		usage(B_FALSE);
3636	}
3637
3638	if ((dryrun || xtreme_rewind) && !do_rewind) {
3639		(void) fprintf(stderr,
3640		    gettext("-n or -X only meaningful with -F\n"));
3641		usage(B_FALSE);
3642	}
3643	if (dryrun)
3644		rewind_policy = ZPOOL_TRY_REWIND;
3645	else if (do_rewind)
3646		rewind_policy = ZPOOL_DO_REWIND;
3647	if (xtreme_rewind)
3648		rewind_policy |= ZPOOL_EXTREME_REWIND;
3649
3650	/* In future, further rewind policy choices can be passed along here */
3651	if (nvlist_alloc(&policy, NV_UNIQUE_NAME, 0) != 0 ||
3652	    nvlist_add_uint32(policy, ZPOOL_REWIND_REQUEST, rewind_policy) != 0)
3653		return (1);
3654
3655	pool = argv[0];
3656	device = argc == 2 ? argv[1] : NULL;
3657
3658	if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL) {
3659		nvlist_free(policy);
3660		return (1);
3661	}
3662
3663	if (zpool_clear(zhp, device, policy) != 0)
3664		ret = 1;
3665
3666	zpool_close(zhp);
3667
3668	nvlist_free(policy);
3669
3670	return (ret);
3671}
3672
3673/*
3674 * zpool reguid <pool>
3675 */
3676int
3677zpool_do_reguid(int argc, char **argv)
3678{
3679	int c;
3680	char *poolname;
3681	zpool_handle_t *zhp;
3682	int ret = 0;
3683
3684	/* check options */
3685	while ((c = getopt(argc, argv, "")) != -1) {
3686		switch (c) {
3687		case '?':
3688			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3689			    optopt);
3690			usage(B_FALSE);
3691		}
3692	}
3693
3694	argc -= optind;
3695	argv += optind;
3696
3697	/* get pool name and check number of arguments */
3698	if (argc < 1) {
3699		(void) fprintf(stderr, gettext("missing pool name\n"));
3700		usage(B_FALSE);
3701	}
3702
3703	if (argc > 1) {
3704		(void) fprintf(stderr, gettext("too many arguments\n"));
3705		usage(B_FALSE);
3706	}
3707
3708	poolname = argv[0];
3709	if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3710		return (1);
3711
3712	ret = zpool_reguid(zhp);
3713
3714	zpool_close(zhp);
3715	return (ret);
3716}
3717
3718
3719/*
3720 * zpool reopen <pool>
3721 *
3722 * Reopen the pool so that the kernel can update the sizes of all vdevs.
3723 */
3724int
3725zpool_do_reopen(int argc, char **argv)
3726{
3727	int c;
3728	int ret = 0;
3729	zpool_handle_t *zhp;
3730	char *pool;
3731
3732	/* check options */
3733	while ((c = getopt(argc, argv, "")) != -1) {
3734		switch (c) {
3735		case '?':
3736			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3737			    optopt);
3738			usage(B_FALSE);
3739		}
3740	}
3741
3742	argc--;
3743	argv++;
3744
3745	if (argc < 1) {
3746		(void) fprintf(stderr, gettext("missing pool name\n"));
3747		usage(B_FALSE);
3748	}
3749
3750	if (argc > 1) {
3751		(void) fprintf(stderr, gettext("too many arguments\n"));
3752		usage(B_FALSE);
3753	}
3754
3755	pool = argv[0];
3756	if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL)
3757		return (1);
3758
3759	ret = zpool_reopen(zhp);
3760	zpool_close(zhp);
3761	return (ret);
3762}
3763
3764typedef struct scrub_cbdata {
3765	int	cb_type;
3766	int	cb_argc;
3767	char	**cb_argv;
3768} scrub_cbdata_t;
3769
3770int
3771scrub_callback(zpool_handle_t *zhp, void *data)
3772{
3773	scrub_cbdata_t *cb = data;
3774	int err;
3775
3776	/*
3777	 * Ignore faulted pools.
3778	 */
3779	if (zpool_get_state(zhp) == POOL_STATE_UNAVAIL) {
3780		(void) fprintf(stderr, gettext("cannot scrub '%s': pool is "
3781		    "currently unavailable\n"), zpool_get_name(zhp));
3782		return (1);
3783	}
3784
3785	err = zpool_scan(zhp, cb->cb_type);
3786
3787	return (err != 0);
3788}
3789
3790/*
3791 * zpool scrub [-s] <pool> ...
3792 *
3793 *	-s	Stop.  Stops any in-progress scrub.
3794 */
3795int
3796zpool_do_scrub(int argc, char **argv)
3797{
3798	int c;
3799	scrub_cbdata_t cb;
3800
3801	cb.cb_type = POOL_SCAN_SCRUB;
3802
3803	/* check options */
3804	while ((c = getopt(argc, argv, "s")) != -1) {
3805		switch (c) {
3806		case 's':
3807			cb.cb_type = POOL_SCAN_NONE;
3808			break;
3809		case '?':
3810			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3811			    optopt);
3812			usage(B_FALSE);
3813		}
3814	}
3815
3816	cb.cb_argc = argc;
3817	cb.cb_argv = argv;
3818	argc -= optind;
3819	argv += optind;
3820
3821	if (argc < 1) {
3822		(void) fprintf(stderr, gettext("missing pool name argument\n"));
3823		usage(B_FALSE);
3824	}
3825
3826	return (for_each_pool(argc, argv, B_TRUE, NULL, scrub_callback, &cb));
3827}
3828
3829typedef struct status_cbdata {
3830	int		cb_count;
3831	boolean_t	cb_allpools;
3832	boolean_t	cb_verbose;
3833	boolean_t	cb_explain;
3834	boolean_t	cb_first;
3835	boolean_t	cb_dedup_stats;
3836} status_cbdata_t;
3837
3838/*
3839 * Print out detailed scrub status.
3840 */
3841void
3842print_scan_status(pool_scan_stat_t *ps)
3843{
3844	time_t start, end;
3845	uint64_t elapsed, mins_left, hours_left;
3846	uint64_t pass_exam, examined, total;
3847	uint_t rate;
3848	double fraction_done;
3849	char processed_buf[7], examined_buf[7], total_buf[7], rate_buf[7];
3850
3851	(void) printf(gettext("  scan: "));
3852
3853	/* If there's never been a scan, there's not much to say. */
3854	if (ps == NULL || ps->pss_func == POOL_SCAN_NONE ||
3855	    ps->pss_func >= POOL_SCAN_FUNCS) {
3856		(void) printf(gettext("none requested\n"));
3857		return;
3858	}
3859
3860	start = ps->pss_start_time;
3861	end = ps->pss_end_time;
3862	zfs_nicenum(ps->pss_processed, processed_buf, sizeof (processed_buf));
3863
3864	assert(ps->pss_func == POOL_SCAN_SCRUB ||
3865	    ps->pss_func == POOL_SCAN_RESILVER);
3866	/*
3867	 * Scan is finished or canceled.
3868	 */
3869	if (ps->pss_state == DSS_FINISHED) {
3870		uint64_t minutes_taken = (end - start) / 60;
3871		char *fmt;
3872
3873		if (ps->pss_func == POOL_SCAN_SCRUB) {
3874			fmt = gettext("scrub repaired %s in %lluh%um with "
3875			    "%llu errors on %s");
3876		} else if (ps->pss_func == POOL_SCAN_RESILVER) {
3877			fmt = gettext("resilvered %s in %lluh%um with "
3878			    "%llu errors on %s");
3879		}
3880		/* LINTED */
3881		(void) printf(fmt, processed_buf,
3882		    (u_longlong_t)(minutes_taken / 60),
3883		    (uint_t)(minutes_taken % 60),
3884		    (u_longlong_t)ps->pss_errors,
3885		    ctime((time_t *)&end));
3886		return;
3887	} else if (ps->pss_state == DSS_CANCELED) {
3888		if (ps->pss_func == POOL_SCAN_SCRUB) {
3889			(void) printf(gettext("scrub canceled on %s"),
3890			    ctime(&end));
3891		} else if (ps->pss_func == POOL_SCAN_RESILVER) {
3892			(void) printf(gettext("resilver canceled on %s"),
3893			    ctime(&end));
3894		}
3895		return;
3896	}
3897
3898	assert(ps->pss_state == DSS_SCANNING);
3899
3900	/*
3901	 * Scan is in progress.
3902	 */
3903	if (ps->pss_func == POOL_SCAN_SCRUB) {
3904		(void) printf(gettext("scrub in progress since %s"),
3905		    ctime(&start));
3906	} else if (ps->pss_func == POOL_SCAN_RESILVER) {
3907		(void) printf(gettext("resilver in progress since %s"),
3908		    ctime(&start));
3909	}
3910
3911	examined = ps->pss_examined ? ps->pss_examined : 1;
3912	total = ps->pss_to_examine;
3913	fraction_done = (double)examined / total;
3914
3915	/* elapsed time for this pass */
3916	elapsed = time(NULL) - ps->pss_pass_start;
3917	elapsed = elapsed ? elapsed : 1;
3918	pass_exam = ps->pss_pass_exam ? ps->pss_pass_exam : 1;
3919	rate = pass_exam / elapsed;
3920	rate = rate ? rate : 1;
3921	mins_left = ((total - examined) / rate) / 60;
3922	hours_left = mins_left / 60;
3923
3924	zfs_nicenum(examined, examined_buf, sizeof (examined_buf));
3925	zfs_nicenum(total, total_buf, sizeof (total_buf));
3926	zfs_nicenum(rate, rate_buf, sizeof (rate_buf));
3927
3928	/*
3929	 * do not print estimated time if hours_left is more than 30 days
3930	 */
3931	(void) printf(gettext("        %s scanned out of %s at %s/s"),
3932	    examined_buf, total_buf, rate_buf);
3933	if (hours_left < (30 * 24)) {
3934		(void) printf(gettext(", %lluh%um to go\n"),
3935		    (u_longlong_t)hours_left, (uint_t)(mins_left % 60));
3936	} else {
3937		(void) printf(gettext(
3938		    ", (scan is slow, no estimated time)\n"));
3939	}
3940
3941	if (ps->pss_func == POOL_SCAN_RESILVER) {
3942		(void) printf(gettext("        %s resilvered, %.2f%% done\n"),
3943		    processed_buf, 100 * fraction_done);
3944	} else if (ps->pss_func == POOL_SCAN_SCRUB) {
3945		(void) printf(gettext("        %s repaired, %.2f%% done\n"),
3946		    processed_buf, 100 * fraction_done);
3947	}
3948}
3949
3950static void
3951print_error_log(zpool_handle_t *zhp)
3952{
3953	nvlist_t *nverrlist = NULL;
3954	nvpair_t *elem;
3955	char *pathname;
3956	size_t len = MAXPATHLEN * 2;
3957
3958	if (zpool_get_errlog(zhp, &nverrlist) != 0) {
3959		(void) printf("errors: List of errors unavailable "
3960		    "(insufficient privileges)\n");
3961		return;
3962	}
3963
3964	(void) printf("errors: Permanent errors have been "
3965	    "detected in the following files:\n\n");
3966
3967	pathname = safe_malloc(len);
3968	elem = NULL;
3969	while ((elem = nvlist_next_nvpair(nverrlist, elem)) != NULL) {
3970		nvlist_t *nv;
3971		uint64_t dsobj, obj;
3972
3973		verify(nvpair_value_nvlist(elem, &nv) == 0);
3974		verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_DATASET,
3975		    &dsobj) == 0);
3976		verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_OBJECT,
3977		    &obj) == 0);
3978		zpool_obj_to_path(zhp, dsobj, obj, pathname, len);
3979		(void) printf("%7s %s\n", "", pathname);
3980	}
3981	free(pathname);
3982	nvlist_free(nverrlist);
3983}
3984
3985static void
3986print_spares(zpool_handle_t *zhp, nvlist_t **spares, uint_t nspares,
3987    int namewidth)
3988{
3989	uint_t i;
3990	char *name;
3991
3992	if (nspares == 0)
3993		return;
3994
3995	(void) printf(gettext("\tspares\n"));
3996
3997	for (i = 0; i < nspares; i++) {
3998		name = zpool_vdev_name(g_zfs, zhp, spares[i], B_FALSE);
3999		print_status_config(zhp, name, spares[i],
4000		    namewidth, 2, B_TRUE);
4001		free(name);
4002	}
4003}
4004
4005static void
4006print_l2cache(zpool_handle_t *zhp, nvlist_t **l2cache, uint_t nl2cache,
4007    int namewidth)
4008{
4009	uint_t i;
4010	char *name;
4011
4012	if (nl2cache == 0)
4013		return;
4014
4015	(void) printf(gettext("\tcache\n"));
4016
4017	for (i = 0; i < nl2cache; i++) {
4018		name = zpool_vdev_name(g_zfs, zhp, l2cache[i], B_FALSE);
4019		print_status_config(zhp, name, l2cache[i],
4020		    namewidth, 2, B_FALSE);
4021		free(name);
4022	}
4023}
4024
4025static void
4026print_dedup_stats(nvlist_t *config)
4027{
4028	ddt_histogram_t *ddh;
4029	ddt_stat_t *dds;
4030	ddt_object_t *ddo;
4031	uint_t c;
4032
4033	/*
4034	 * If the pool was faulted then we may not have been able to
4035	 * obtain the config. Otherwise, if we have anything in the dedup
4036	 * table continue processing the stats.
4037	 */
4038	if (nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_OBJ_STATS,
4039	    (uint64_t **)&ddo, &c) != 0)
4040		return;
4041
4042	(void) printf("\n");
4043	(void) printf(gettext(" dedup: "));
4044	if (ddo->ddo_count == 0) {
4045		(void) printf(gettext("no DDT entries\n"));
4046		return;
4047	}
4048
4049	(void) printf("DDT entries %llu, size %llu on disk, %llu in core\n",
4050	    (u_longlong_t)ddo->ddo_count,
4051	    (u_longlong_t)ddo->ddo_dspace,
4052	    (u_longlong_t)ddo->ddo_mspace);
4053
4054	verify(nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_STATS,
4055	    (uint64_t **)&dds, &c) == 0);
4056	verify(nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_HISTOGRAM,
4057	    (uint64_t **)&ddh, &c) == 0);
4058	zpool_dump_ddt(dds, ddh);
4059}
4060
4061/*
4062 * Display a summary of pool status.  Displays a summary such as:
4063 *
4064 *        pool: tank
4065 *	status: DEGRADED
4066 *	reason: One or more devices ...
4067 *         see: http://illumos.org/msg/ZFS-xxxx-01
4068 *	config:
4069 *		mirror		DEGRADED
4070 *                c1t0d0	OK
4071 *                c2t0d0	UNAVAIL
4072 *
4073 * When given the '-v' option, we print out the complete config.  If the '-e'
4074 * option is specified, then we print out error rate information as well.
4075 */
4076int
4077status_callback(zpool_handle_t *zhp, void *data)
4078{
4079	status_cbdata_t *cbp = data;
4080	nvlist_t *config, *nvroot;
4081	char *msgid;
4082	int reason;
4083	const char *health;
4084	uint_t c;
4085	vdev_stat_t *vs;
4086
4087	config = zpool_get_config(zhp, NULL);
4088	reason = zpool_get_status(zhp, &msgid);
4089
4090	cbp->cb_count++;
4091
4092	/*
4093	 * If we were given 'zpool status -x', only report those pools with
4094	 * problems.
4095	 */
4096	if (cbp->cb_explain &&
4097	    (reason == ZPOOL_STATUS_OK ||
4098	    reason == ZPOOL_STATUS_VERSION_OLDER ||
4099	    reason == ZPOOL_STATUS_FEAT_DISABLED)) {
4100		if (!cbp->cb_allpools) {
4101			(void) printf(gettext("pool '%s' is healthy\n"),
4102			    zpool_get_name(zhp));
4103			if (cbp->cb_first)
4104				cbp->cb_first = B_FALSE;
4105		}
4106		return (0);
4107	}
4108
4109	if (cbp->cb_first)
4110		cbp->cb_first = B_FALSE;
4111	else
4112		(void) printf("\n");
4113
4114	verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
4115	    &nvroot) == 0);
4116	verify(nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_VDEV_STATS,
4117	    (uint64_t **)&vs, &c) == 0);
4118	health = zpool_state_to_name(vs->vs_state, vs->vs_aux);
4119
4120	(void) printf(gettext("  pool: %s\n"), zpool_get_name(zhp));
4121	(void) printf(gettext(" state: %s\n"), health);
4122
4123	switch (reason) {
4124	case ZPOOL_STATUS_MISSING_DEV_R:
4125		(void) printf(gettext("status: One or more devices could not "
4126		    "be opened.  Sufficient replicas exist for\n\tthe pool to "
4127		    "continue functioning in a degraded state.\n"));
4128		(void) printf(gettext("action: Attach the missing device and "
4129		    "online it using 'zpool online'.\n"));
4130		break;
4131
4132	case ZPOOL_STATUS_MISSING_DEV_NR:
4133		(void) printf(gettext("status: One or more devices could not "
4134		    "be opened.  There are insufficient\n\treplicas for the "
4135		    "pool to continue functioning.\n"));
4136		(void) printf(gettext("action: Attach the missing device and "
4137		    "online it using 'zpool online'.\n"));
4138		break;
4139
4140	case ZPOOL_STATUS_CORRUPT_LABEL_R:
4141		(void) printf(gettext("status: One or more devices could not "
4142		    "be used because the label is missing or\n\tinvalid.  "
4143		    "Sufficient replicas exist for the pool to continue\n\t"
4144		    "functioning in a degraded state.\n"));
4145		(void) printf(gettext("action: Replace the device using "
4146		    "'zpool replace'.\n"));
4147		break;
4148
4149	case ZPOOL_STATUS_CORRUPT_LABEL_NR:
4150		(void) printf(gettext("status: One or more devices could not "
4151		    "be used because the label is missing \n\tor invalid.  "
4152		    "There are insufficient replicas for the pool to "
4153		    "continue\n\tfunctioning.\n"));
4154		zpool_explain_recover(zpool_get_handle(zhp),
4155		    zpool_get_name(zhp), reason, config);
4156		break;
4157
4158	case ZPOOL_STATUS_FAILING_DEV:
4159		(void) printf(gettext("status: One or more devices has "
4160		    "experienced an unrecoverable error.  An\n\tattempt was "
4161		    "made to correct the error.  Applications are "
4162		    "unaffected.\n"));
4163		(void) printf(gettext("action: Determine if the device needs "
4164		    "to be replaced, and clear the errors\n\tusing "
4165		    "'zpool clear' or replace the device with 'zpool "
4166		    "replace'.\n"));
4167		break;
4168
4169	case ZPOOL_STATUS_OFFLINE_DEV:
4170		(void) printf(gettext("status: One or more devices has "
4171		    "been taken offline by the administrator.\n\tSufficient "
4172		    "replicas exist for the pool to continue functioning in "
4173		    "a\n\tdegraded state.\n"));
4174		(void) printf(gettext("action: Online the device using "
4175		    "'zpool online' or replace the device with\n\t'zpool "
4176		    "replace'.\n"));
4177		break;
4178
4179	case ZPOOL_STATUS_REMOVED_DEV:
4180		(void) printf(gettext("status: One or more devices has "
4181		    "been removed by the administrator.\n\tSufficient "
4182		    "replicas exist for the pool to continue functioning in "
4183		    "a\n\tdegraded state.\n"));
4184		(void) printf(gettext("action: Online the device using "
4185		    "'zpool online' or replace the device with\n\t'zpool "
4186		    "replace'.\n"));
4187		break;
4188
4189	case ZPOOL_STATUS_RESILVERING:
4190		(void) printf(gettext("status: One or more devices is "
4191		    "currently being resilvered.  The pool will\n\tcontinue "
4192		    "to function, possibly in a degraded state.\n"));
4193		(void) printf(gettext("action: Wait for the resilver to "
4194		    "complete.\n"));
4195		break;
4196
4197	case ZPOOL_STATUS_CORRUPT_DATA:
4198		(void) printf(gettext("status: One or more devices has "
4199		    "experienced an error resulting in data\n\tcorruption.  "
4200		    "Applications may be affected.\n"));
4201		(void) printf(gettext("action: Restore the file in question "
4202		    "if possible.  Otherwise restore the\n\tentire pool from "
4203		    "backup.\n"));
4204		break;
4205
4206	case ZPOOL_STATUS_CORRUPT_POOL:
4207		(void) printf(gettext("status: The pool metadata is corrupted "
4208		    "and the pool cannot be opened.\n"));
4209		zpool_explain_recover(zpool_get_handle(zhp),
4210		    zpool_get_name(zhp), reason, config);
4211		break;
4212
4213	case ZPOOL_STATUS_VERSION_OLDER:
4214		(void) printf(gettext("status: The pool is formatted using a "
4215		    "legacy on-disk format.  The pool can\n\tstill be used, "
4216		    "but some features are unavailable.\n"));
4217		(void) printf(gettext("action: Upgrade the pool using 'zpool "
4218		    "upgrade'.  Once this is done, the\n\tpool will no longer "
4219		    "be accessible on software that does not support feature\n"
4220		    "\tflags.\n"));
4221		break;
4222
4223	case ZPOOL_STATUS_VERSION_NEWER:
4224		(void) printf(gettext("status: The pool has been upgraded to a "
4225		    "newer, incompatible on-disk version.\n\tThe pool cannot "
4226		    "be accessed on this system.\n"));
4227		(void) printf(gettext("action: Access the pool from a system "
4228		    "running more recent software, or\n\trestore the pool from "
4229		    "backup.\n"));
4230		break;
4231
4232	case ZPOOL_STATUS_FEAT_DISABLED:
4233		(void) printf(gettext("status: Some supported features are not "
4234		    "enabled on the pool. The pool can\n\tstill be used, but "
4235		    "some features are unavailable.\n"));
4236		(void) printf(gettext("action: Enable all features using "
4237		    "'zpool upgrade'. Once this is done,\n\tthe pool may no "
4238		    "longer be accessible by software that does not support\n\t"
4239		    "the features. See zpool-features(7) for details.\n"));
4240		break;
4241
4242	case ZPOOL_STATUS_UNSUP_FEAT_READ:
4243		(void) printf(gettext("status: The pool cannot be accessed on "
4244		    "this system because it uses the\n\tfollowing feature(s) "
4245		    "not supported on this system:\n"));
4246		zpool_print_unsup_feat(config);
4247		(void) printf("\n");
4248		(void) printf(gettext("action: Access the pool from a system "
4249		    "that supports the required feature(s),\n\tor restore the "
4250		    "pool from backup.\n"));
4251		break;
4252
4253	case ZPOOL_STATUS_UNSUP_FEAT_WRITE:
4254		(void) printf(gettext("status: The pool can only be accessed "
4255		    "in read-only mode on this system. It\n\tcannot be "
4256		    "accessed in read-write mode because it uses the "
4257		    "following\n\tfeature(s) not supported on this system:\n"));
4258		zpool_print_unsup_feat(config);
4259		(void) printf("\n");
4260		(void) printf(gettext("action: The pool cannot be accessed in "
4261		    "read-write mode. Import the pool with\n"
4262		    "\t\"-o readonly=on\", access the pool from a system that "
4263		    "supports the\n\trequired feature(s), or restore the "
4264		    "pool from backup.\n"));
4265		break;
4266
4267	case ZPOOL_STATUS_FAULTED_DEV_R:
4268		(void) printf(gettext("status: One or more devices are "
4269		    "faulted in response to persistent errors.\n\tSufficient "
4270		    "replicas exist for the pool to continue functioning "
4271		    "in a\n\tdegraded state.\n"));
4272		(void) printf(gettext("action: Replace the faulted device, "
4273		    "or use 'zpool clear' to mark the device\n\trepaired.\n"));
4274		break;
4275
4276	case ZPOOL_STATUS_FAULTED_DEV_NR:
4277		(void) printf(gettext("status: One or more devices are "
4278		    "faulted in response to persistent errors.  There are "
4279		    "insufficient replicas for the pool to\n\tcontinue "
4280		    "functioning.\n"));
4281		(void) printf(gettext("action: Destroy and re-create the pool "
4282		    "from a backup source.  Manually marking the device\n"
4283		    "\trepaired using 'zpool clear' may allow some data "
4284		    "to be recovered.\n"));
4285		break;
4286
4287	case ZPOOL_STATUS_IO_FAILURE_WAIT:
4288	case ZPOOL_STATUS_IO_FAILURE_CONTINUE:
4289		(void) printf(gettext("status: One or more devices are "
4290		    "faulted in response to IO failures.\n"));
4291		(void) printf(gettext("action: Make sure the affected devices "
4292		    "are connected, then run 'zpool clear'.\n"));
4293		break;
4294
4295	case ZPOOL_STATUS_BAD_LOG:
4296		(void) printf(gettext("status: An intent log record "
4297		    "could not be read.\n"
4298		    "\tWaiting for adminstrator intervention to fix the "
4299		    "faulted pool.\n"));
4300		(void) printf(gettext("action: Either restore the affected "
4301		    "device(s) and run 'zpool online',\n"
4302		    "\tor ignore the intent log records by running "
4303		    "'zpool clear'.\n"));
4304		break;
4305
4306	case ZPOOL_STATUS_NON_NATIVE_ASHIFT:
4307		(void) printf(gettext("status: One or more devices are "
4308		    "configured to use a non-native block size.\n"
4309		    "\tExpect reduced performance.\n"));
4310		(void) printf(gettext("action: Replace affected devices with "
4311		    "devices that support the\n\tconfigured block size, or "
4312		    "migrate data to a properly configured\n\tpool.\n"));
4313		break;
4314
4315	default:
4316		/*
4317		 * The remaining errors can't actually be generated, yet.
4318		 */
4319		assert(reason == ZPOOL_STATUS_OK);
4320	}
4321
4322	if (msgid != NULL)
4323		(void) printf(gettext("   see: http://illumos.org/msg/%s\n"),
4324		    msgid);
4325
4326	if (config != NULL) {
4327		int namewidth;
4328		uint64_t nerr;
4329		nvlist_t **spares, **l2cache;
4330		uint_t nspares, nl2cache;
4331		pool_scan_stat_t *ps = NULL;
4332
4333		(void) nvlist_lookup_uint64_array(nvroot,
4334		    ZPOOL_CONFIG_SCAN_STATS, (uint64_t **)&ps, &c);
4335		print_scan_status(ps);
4336
4337		namewidth = max_width(zhp, nvroot, 0, 0);
4338		if (namewidth < 10)
4339			namewidth = 10;
4340
4341		(void) printf(gettext("config:\n\n"));
4342		(void) printf(gettext("\t%-*s  %-8s %5s %5s %5s\n"), namewidth,
4343		    "NAME", "STATE", "READ", "WRITE", "CKSUM");
4344		print_status_config(zhp, zpool_get_name(zhp), nvroot,
4345		    namewidth, 0, B_FALSE);
4346
4347		if (num_logs(nvroot) > 0)
4348			print_logs(zhp, nvroot, namewidth, B_TRUE);
4349		if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_L2CACHE,
4350		    &l2cache, &nl2cache) == 0)
4351			print_l2cache(zhp, l2cache, nl2cache, namewidth);
4352
4353		if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES,
4354		    &spares, &nspares) == 0)
4355			print_spares(zhp, spares, nspares, namewidth);
4356
4357		if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_ERRCOUNT,
4358		    &nerr) == 0) {
4359			nvlist_t *nverrlist = NULL;
4360
4361			/*
4362			 * If the approximate error count is small, get a
4363			 * precise count by fetching the entire log and
4364			 * uniquifying the results.
4365			 */
4366			if (nerr > 0 && nerr < 100 && !cbp->cb_verbose &&
4367			    zpool_get_errlog(zhp, &nverrlist) == 0) {
4368				nvpair_t *elem;
4369
4370				elem = NULL;
4371				nerr = 0;
4372				while ((elem = nvlist_next_nvpair(nverrlist,
4373				    elem)) != NULL) {
4374					nerr++;
4375				}
4376			}
4377			nvlist_free(nverrlist);
4378
4379			(void) printf("\n");
4380
4381			if (nerr == 0)
4382				(void) printf(gettext("errors: No known data "
4383				    "errors\n"));
4384			else if (!cbp->cb_verbose)
4385				(void) printf(gettext("errors: %llu data "
4386				    "errors, use '-v' for a list\n"),
4387				    (u_longlong_t)nerr);
4388			else
4389				print_error_log(zhp);
4390		}
4391
4392		if (cbp->cb_dedup_stats)
4393			print_dedup_stats(config);
4394	} else {
4395		(void) printf(gettext("config: The configuration cannot be "
4396		    "determined.\n"));
4397	}
4398
4399	return (0);
4400}
4401
4402/*
4403 * zpool status [-vx] [-T d|u] [pool] ... [interval [count]]
4404 *
4405 *	-v	Display complete error logs
4406 *	-x	Display only pools with potential problems
4407 *	-D	Display dedup status (undocumented)
4408 *	-T	Display a timestamp in date(1) or Unix format
4409 *
4410 * Describes the health status of all pools or some subset.
4411 */
4412int
4413zpool_do_status(int argc, char **argv)
4414{
4415	int c;
4416	int ret;
4417	unsigned long interval = 0, count = 0;
4418	status_cbdata_t cb = { 0 };
4419
4420	/* check options */
4421	while ((c = getopt(argc, argv, "vxDT:")) != -1) {
4422		switch (c) {
4423		case 'v':
4424			cb.cb_verbose = B_TRUE;
4425			break;
4426		case 'x':
4427			cb.cb_explain = B_TRUE;
4428			break;
4429		case 'D':
4430			cb.cb_dedup_stats = B_TRUE;
4431			break;
4432		case 'T':
4433			get_timestamp_arg(*optarg);
4434			break;
4435		case '?':
4436			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
4437			    optopt);
4438			usage(B_FALSE);
4439		}
4440	}
4441
4442	argc -= optind;
4443	argv += optind;
4444
4445	get_interval_count(&argc, argv, &interval, &count);
4446
4447	if (argc == 0)
4448		cb.cb_allpools = B_TRUE;
4449
4450	cb.cb_first = B_TRUE;
4451
4452	for (;;) {
4453		if (timestamp_fmt != NODATE)
4454			print_timestamp(timestamp_fmt);
4455
4456		ret = for_each_pool(argc, argv, B_TRUE, NULL,
4457		    status_callback, &cb);
4458
4459		if (argc == 0 && cb.cb_count == 0)
4460			(void) printf(gettext("no pools available\n"));
4461		else if (cb.cb_explain && cb.cb_first && cb.cb_allpools)
4462			(void) printf(gettext("all pools are healthy\n"));
4463
4464		if (ret != 0)
4465			return (ret);
4466
4467		if (interval == 0)
4468			break;
4469
4470		if (count != 0 && --count == 0)
4471			break;
4472
4473		(void) sleep(interval);
4474	}
4475
4476	return (0);
4477}
4478
4479typedef struct upgrade_cbdata {
4480	int	cb_first;
4481	char	cb_poolname[ZPOOL_MAXNAMELEN];
4482	int	cb_argc;
4483	uint64_t cb_version;
4484	char	**cb_argv;
4485} upgrade_cbdata_t;
4486
4487#ifdef __FreeBSD__
4488static int
4489is_root_pool(zpool_handle_t *zhp)
4490{
4491	static struct statfs sfs;
4492	static char *poolname = NULL;
4493	static boolean_t stated = B_FALSE;
4494	char *slash;
4495
4496	if (!stated) {
4497		stated = B_TRUE;
4498		if (statfs("/", &sfs) == -1) {
4499			(void) fprintf(stderr,
4500			    "Unable to stat root file system: %s.\n",
4501			    strerror(errno));
4502			return (0);
4503		}
4504		if (strcmp(sfs.f_fstypename, "zfs") != 0)
4505			return (0);
4506		poolname = sfs.f_mntfromname;
4507		if ((slash = strchr(poolname, '/')) != NULL)
4508			*slash = '\0';
4509	}
4510	return (poolname != NULL && strcmp(poolname, zpool_get_name(zhp)) == 0);
4511}
4512
4513static void
4514root_pool_upgrade_check(zpool_handle_t *zhp, char *poolname, int size) {
4515
4516	if (poolname[0] == '\0' && is_root_pool(zhp))
4517		(void) strlcpy(poolname, zpool_get_name(zhp), size);
4518}
4519#endif	/* FreeBSD */
4520
4521static int
4522upgrade_version(zpool_handle_t *zhp, uint64_t version)
4523{
4524	int ret;
4525	nvlist_t *config;
4526	uint64_t oldversion;
4527
4528	config = zpool_get_config(zhp, NULL);
4529	verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
4530	    &oldversion) == 0);
4531
4532	assert(SPA_VERSION_IS_SUPPORTED(oldversion));
4533	assert(oldversion < version);
4534
4535	ret = zpool_upgrade(zhp, version);
4536	if (ret != 0)
4537		return (ret);
4538
4539	if (version >= SPA_VERSION_FEATURES) {
4540		(void) printf(gettext("Successfully upgraded "
4541		    "'%s' from version %llu to feature flags.\n"),
4542		    zpool_get_name(zhp), oldversion);
4543	} else {
4544		(void) printf(gettext("Successfully upgraded "
4545		    "'%s' from version %llu to version %llu.\n"),
4546		    zpool_get_name(zhp), oldversion, version);
4547	}
4548
4549	return (0);
4550}
4551
4552static int
4553upgrade_enable_all(zpool_handle_t *zhp, int *countp)
4554{
4555	int i, ret, count;
4556	boolean_t firstff = B_TRUE;
4557	nvlist_t *enabled = zpool_get_features(zhp);
4558
4559	count = 0;
4560	for (i = 0; i < SPA_FEATURES; i++) {
4561		const char *fname = spa_feature_table[i].fi_uname;
4562		const char *fguid = spa_feature_table[i].fi_guid;
4563		if (!nvlist_exists(enabled, fguid)) {
4564			char *propname;
4565			verify(-1 != asprintf(&propname, "feature@%s", fname));
4566			ret = zpool_set_prop(zhp, propname,
4567			    ZFS_FEATURE_ENABLED);
4568			if (ret != 0) {
4569				free(propname);
4570				return (ret);
4571			}
4572			count++;
4573
4574			if (firstff) {
4575				(void) printf(gettext("Enabled the "
4576				    "following features on '%s':\n"),
4577				    zpool_get_name(zhp));
4578				firstff = B_FALSE;
4579			}
4580			(void) printf(gettext("  %s\n"), fname);
4581			free(propname);
4582		}
4583	}
4584
4585	if (countp != NULL)
4586		*countp = count;
4587	return (0);
4588}
4589
4590static int
4591upgrade_cb(zpool_handle_t *zhp, void *arg)
4592{
4593	upgrade_cbdata_t *cbp = arg;
4594	nvlist_t *config;
4595	uint64_t version;
4596	boolean_t printnl = B_FALSE;
4597	int ret;
4598
4599	config = zpool_get_config(zhp, NULL);
4600	verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
4601	    &version) == 0);
4602
4603	assert(SPA_VERSION_IS_SUPPORTED(version));
4604
4605	if (version < cbp->cb_version) {
4606		cbp->cb_first = B_FALSE;
4607		ret = upgrade_version(zhp, cbp->cb_version);
4608		if (ret != 0)
4609			return (ret);
4610#ifdef __FreeBSD__
4611		root_pool_upgrade_check(zhp, cbp->cb_poolname,
4612		    sizeof(cbp->cb_poolname));
4613#endif	/* ___FreeBSD__ */
4614		printnl = B_TRUE;
4615
4616#ifdef illumos
4617		/*
4618		 * If they did "zpool upgrade -a", then we could
4619		 * be doing ioctls to different pools.  We need
4620		 * to log this history once to each pool, and bypass
4621		 * the normal history logging that happens in main().
4622		 */
4623		(void) zpool_log_history(g_zfs, history_str);
4624		log_history = B_FALSE;
4625#endif
4626	}
4627
4628	if (cbp->cb_version >= SPA_VERSION_FEATURES) {
4629		int count;
4630		ret = upgrade_enable_all(zhp, &count);
4631		if (ret != 0)
4632			return (ret);
4633
4634		if (count > 0) {
4635			cbp->cb_first = B_FALSE;
4636			printnl = B_TRUE;
4637			/*
4638			 * If they did "zpool upgrade -a", then we could
4639			 * be doing ioctls to different pools.  We need
4640			 * to log this history once to each pool, and bypass
4641			 * the normal history logging that happens in main().
4642			 */
4643			(void) zpool_log_history(g_zfs, history_str);
4644			log_history = B_FALSE;
4645		}
4646	}
4647
4648	if (printnl) {
4649		(void) printf(gettext("\n"));
4650	}
4651
4652	return (0);
4653}
4654
4655static int
4656upgrade_list_older_cb(zpool_handle_t *zhp, void *arg)
4657{
4658	upgrade_cbdata_t *cbp = arg;
4659	nvlist_t *config;
4660	uint64_t version;
4661
4662	config = zpool_get_config(zhp, NULL);
4663	verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
4664	    &version) == 0);
4665
4666	assert(SPA_VERSION_IS_SUPPORTED(version));
4667
4668	if (version < SPA_VERSION_FEATURES) {
4669		if (cbp->cb_first) {
4670			(void) printf(gettext("The following pools are "
4671			    "formatted with legacy version numbers and can\n"
4672			    "be upgraded to use feature flags.  After "
4673			    "being upgraded, these pools\nwill no "
4674			    "longer be accessible by software that does not "
4675			    "support feature\nflags.\n\n"));
4676			(void) printf(gettext("VER  POOL\n"));
4677			(void) printf(gettext("---  ------------\n"));
4678			cbp->cb_first = B_FALSE;
4679		}
4680
4681		(void) printf("%2llu   %s\n", (u_longlong_t)version,
4682		    zpool_get_name(zhp));
4683	}
4684
4685	return (0);
4686}
4687
4688static int
4689upgrade_list_disabled_cb(zpool_handle_t *zhp, void *arg)
4690{
4691	upgrade_cbdata_t *cbp = arg;
4692	nvlist_t *config;
4693	uint64_t version;
4694
4695	config = zpool_get_config(zhp, NULL);
4696	verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
4697	    &version) == 0);
4698
4699	if (version >= SPA_VERSION_FEATURES) {
4700		int i;
4701		boolean_t poolfirst = B_TRUE;
4702		nvlist_t *enabled = zpool_get_features(zhp);
4703
4704		for (i = 0; i < SPA_FEATURES; i++) {
4705			const char *fguid = spa_feature_table[i].fi_guid;
4706			const char *fname = spa_feature_table[i].fi_uname;
4707			if (!nvlist_exists(enabled, fguid)) {
4708				if (cbp->cb_first) {
4709					(void) printf(gettext("\nSome "
4710					    "supported features are not "
4711					    "enabled on the following pools. "
4712					    "Once a\nfeature is enabled the "
4713					    "pool may become incompatible with "
4714					    "software\nthat does not support "
4715					    "the feature. See "
4716					    "zpool-features(7) for "
4717					    "details.\n\n"));
4718					(void) printf(gettext("POOL  "
4719					    "FEATURE\n"));
4720					(void) printf(gettext("------"
4721					    "---------\n"));
4722					cbp->cb_first = B_FALSE;
4723				}
4724
4725				if (poolfirst) {
4726					(void) printf(gettext("%s\n"),
4727					    zpool_get_name(zhp));
4728					poolfirst = B_FALSE;
4729				}
4730
4731				(void) printf(gettext("      %s\n"), fname);
4732			}
4733		}
4734	}
4735
4736	return (0);
4737}
4738
4739/* ARGSUSED */
4740static int
4741upgrade_one(zpool_handle_t *zhp, void *data)
4742{
4743	boolean_t printnl = B_FALSE;
4744	upgrade_cbdata_t *cbp = data;
4745	uint64_t cur_version;
4746	int ret;
4747
4748	if (strcmp("log", zpool_get_name(zhp)) == 0) {
4749		(void) printf(gettext("'log' is now a reserved word\n"
4750		    "Pool 'log' must be renamed using export and import"
4751		    " to upgrade.\n"));
4752		return (1);
4753	}
4754
4755	cur_version = zpool_get_prop_int(zhp, ZPOOL_PROP_VERSION, NULL);
4756	if (cur_version > cbp->cb_version) {
4757		(void) printf(gettext("Pool '%s' is already formatted "
4758		    "using more current version '%llu'.\n\n"),
4759		    zpool_get_name(zhp), cur_version);
4760		return (0);
4761	}
4762
4763	if (cbp->cb_version != SPA_VERSION && cur_version == cbp->cb_version) {
4764		(void) printf(gettext("Pool '%s' is already formatted "
4765		    "using version %llu.\n\n"), zpool_get_name(zhp),
4766		    cbp->cb_version);
4767		return (0);
4768	}
4769
4770	if (cur_version != cbp->cb_version) {
4771		printnl = B_TRUE;
4772		ret = upgrade_version(zhp, cbp->cb_version);
4773		if (ret != 0)
4774			return (ret);
4775#ifdef __FreeBSD__
4776		root_pool_upgrade_check(zhp, cbp->cb_poolname,
4777		    sizeof(cbp->cb_poolname));
4778#endif	/* ___FreeBSD__ */
4779	}
4780
4781	if (cbp->cb_version >= SPA_VERSION_FEATURES) {
4782		int count = 0;
4783		ret = upgrade_enable_all(zhp, &count);
4784		if (ret != 0)
4785			return (ret);
4786
4787		if (count != 0) {
4788			printnl = B_TRUE;
4789#ifdef __FreeBSD__
4790			root_pool_upgrade_check(zhp, cbp->cb_poolname,
4791			    sizeof(cbp->cb_poolname));
4792#endif	/* __FreeBSD __*/
4793		} else if (cur_version == SPA_VERSION) {
4794			(void) printf(gettext("Pool '%s' already has all "
4795			    "supported features enabled.\n"),
4796			    zpool_get_name(zhp));
4797		}
4798	}
4799
4800	if (printnl) {
4801		(void) printf(gettext("\n"));
4802	}
4803
4804	return (0);
4805}
4806
4807/*
4808 * zpool upgrade
4809 * zpool upgrade -v
4810 * zpool upgrade [-V version] <-a | pool ...>
4811 *
4812 * With no arguments, display downrev'd ZFS pool available for upgrade.
4813 * Individual pools can be upgraded by specifying the pool, and '-a' will
4814 * upgrade all pools.
4815 */
4816int
4817zpool_do_upgrade(int argc, char **argv)
4818{
4819	int c;
4820	upgrade_cbdata_t cb = { 0 };
4821	int ret = 0;
4822	boolean_t showversions = B_FALSE;
4823	boolean_t upgradeall = B_FALSE;
4824	char *end;
4825
4826
4827	/* check options */
4828	while ((c = getopt(argc, argv, ":avV:")) != -1) {
4829		switch (c) {
4830		case 'a':
4831			upgradeall = B_TRUE;
4832			break;
4833		case 'v':
4834			showversions = B_TRUE;
4835			break;
4836		case 'V':
4837			cb.cb_version = strtoll(optarg, &end, 10);
4838			if (*end != '\0' ||
4839			    !SPA_VERSION_IS_SUPPORTED(cb.cb_version)) {
4840				(void) fprintf(stderr,
4841				    gettext("invalid version '%s'\n"), optarg);
4842				usage(B_FALSE);
4843			}
4844			break;
4845		case ':':
4846			(void) fprintf(stderr, gettext("missing argument for "
4847			    "'%c' option\n"), optopt);
4848			usage(B_FALSE);
4849			break;
4850		case '?':
4851			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
4852			    optopt);
4853			usage(B_FALSE);
4854		}
4855	}
4856
4857	cb.cb_argc = argc;
4858	cb.cb_argv = argv;
4859	argc -= optind;
4860	argv += optind;
4861
4862	if (cb.cb_version == 0) {
4863		cb.cb_version = SPA_VERSION;
4864	} else if (!upgradeall && argc == 0) {
4865		(void) fprintf(stderr, gettext("-V option is "
4866		    "incompatible with other arguments\n"));
4867		usage(B_FALSE);
4868	}
4869
4870	if (showversions) {
4871		if (upgradeall || argc != 0) {
4872			(void) fprintf(stderr, gettext("-v option is "
4873			    "incompatible with other arguments\n"));
4874			usage(B_FALSE);
4875		}
4876	} else if (upgradeall) {
4877		if (argc != 0) {
4878			(void) fprintf(stderr, gettext("-a option should not "
4879			    "be used along with a pool name\n"));
4880			usage(B_FALSE);
4881		}
4882	}
4883
4884	(void) printf(gettext("This system supports ZFS pool feature "
4885	    "flags.\n\n"));
4886	if (showversions) {
4887		int i;
4888
4889		(void) printf(gettext("The following features are "
4890		    "supported:\n\n"));
4891		(void) printf(gettext("FEAT DESCRIPTION\n"));
4892		(void) printf("----------------------------------------------"
4893		    "---------------\n");
4894		for (i = 0; i < SPA_FEATURES; i++) {
4895			zfeature_info_t *fi = &spa_feature_table[i];
4896			const char *ro = fi->fi_can_readonly ?
4897			    " (read-only compatible)" : "";
4898
4899			(void) printf("%-37s%s\n", fi->fi_uname, ro);
4900			(void) printf("     %s\n", fi->fi_desc);
4901		}
4902		(void) printf("\n");
4903
4904		(void) printf(gettext("The following legacy versions are also "
4905		    "supported:\n\n"));
4906		(void) printf(gettext("VER  DESCRIPTION\n"));
4907		(void) printf("---  -----------------------------------------"
4908		    "---------------\n");
4909		(void) printf(gettext(" 1   Initial ZFS version\n"));
4910		(void) printf(gettext(" 2   Ditto blocks "
4911		    "(replicated metadata)\n"));
4912		(void) printf(gettext(" 3   Hot spares and double parity "
4913		    "RAID-Z\n"));
4914		(void) printf(gettext(" 4   zpool history\n"));
4915		(void) printf(gettext(" 5   Compression using the gzip "
4916		    "algorithm\n"));
4917		(void) printf(gettext(" 6   bootfs pool property\n"));
4918		(void) printf(gettext(" 7   Separate intent log devices\n"));
4919		(void) printf(gettext(" 8   Delegated administration\n"));
4920		(void) printf(gettext(" 9   refquota and refreservation "
4921		    "properties\n"));
4922		(void) printf(gettext(" 10  Cache devices\n"));
4923		(void) printf(gettext(" 11  Improved scrub performance\n"));
4924		(void) printf(gettext(" 12  Snapshot properties\n"));
4925		(void) printf(gettext(" 13  snapused property\n"));
4926		(void) printf(gettext(" 14  passthrough-x aclinherit\n"));
4927		(void) printf(gettext(" 15  user/group space accounting\n"));
4928		(void) printf(gettext(" 16  stmf property support\n"));
4929		(void) printf(gettext(" 17  Triple-parity RAID-Z\n"));
4930		(void) printf(gettext(" 18  Snapshot user holds\n"));
4931		(void) printf(gettext(" 19  Log device removal\n"));
4932		(void) printf(gettext(" 20  Compression using zle "
4933		    "(zero-length encoding)\n"));
4934		(void) printf(gettext(" 21  Deduplication\n"));
4935		(void) printf(gettext(" 22  Received properties\n"));
4936		(void) printf(gettext(" 23  Slim ZIL\n"));
4937		(void) printf(gettext(" 24  System attributes\n"));
4938		(void) printf(gettext(" 25  Improved scrub stats\n"));
4939		(void) printf(gettext(" 26  Improved snapshot deletion "
4940		    "performance\n"));
4941		(void) printf(gettext(" 27  Improved snapshot creation "
4942		    "performance\n"));
4943		(void) printf(gettext(" 28  Multiple vdev replacements\n"));
4944		(void) printf(gettext("\nFor more information on a particular "
4945		    "version, including supported releases,\n"));
4946		(void) printf(gettext("see the ZFS Administration Guide.\n\n"));
4947	} else if (argc == 0 && upgradeall) {
4948		cb.cb_first = B_TRUE;
4949		ret = zpool_iter(g_zfs, upgrade_cb, &cb);
4950		if (ret == 0 && cb.cb_first) {
4951			if (cb.cb_version == SPA_VERSION) {
4952				(void) printf(gettext("All pools are already "
4953				    "formatted using feature flags.\n\n"));
4954				(void) printf(gettext("Every feature flags "
4955				    "pool already has all supported features "
4956				    "enabled.\n"));
4957			} else {
4958				(void) printf(gettext("All pools are already "
4959				    "formatted with version %llu or higher.\n"),
4960				    cb.cb_version);
4961			}
4962		}
4963	} else if (argc == 0) {
4964		cb.cb_first = B_TRUE;
4965		ret = zpool_iter(g_zfs, upgrade_list_older_cb, &cb);
4966		assert(ret == 0);
4967
4968		if (cb.cb_first) {
4969			(void) printf(gettext("All pools are formatted "
4970			    "using feature flags.\n\n"));
4971		} else {
4972			(void) printf(gettext("\nUse 'zpool upgrade -v' "
4973			    "for a list of available legacy versions.\n"));
4974		}
4975
4976		cb.cb_first = B_TRUE;
4977		ret = zpool_iter(g_zfs, upgrade_list_disabled_cb, &cb);
4978		assert(ret == 0);
4979
4980		if (cb.cb_first) {
4981			(void) printf(gettext("Every feature flags pool has "
4982			    "all supported features enabled.\n"));
4983		} else {
4984			(void) printf(gettext("\n"));
4985		}
4986	} else {
4987		ret = for_each_pool(argc, argv, B_FALSE, NULL,
4988		    upgrade_one, &cb);
4989	}
4990
4991	if (cb.cb_poolname[0] != '\0') {
4992		(void) printf(
4993		    "If you boot from pool '%s', don't forget to update boot code.\n"
4994		    "Assuming you use GPT partitioning and da0 is your boot disk\n"
4995		    "the following command will do it:\n"
4996		    "\n"
4997		    "\tgpart bootcode -b /boot/pmbr -p /boot/gptzfsboot -i 1 da0\n\n",
4998		    cb.cb_poolname);
4999	}
5000
5001	return (ret);
5002}
5003
5004typedef struct hist_cbdata {
5005	boolean_t first;
5006	boolean_t longfmt;
5007	boolean_t internal;
5008} hist_cbdata_t;
5009
5010/*
5011 * Print out the command history for a specific pool.
5012 */
5013static int
5014get_history_one(zpool_handle_t *zhp, void *data)
5015{
5016	nvlist_t *nvhis;
5017	nvlist_t **records;
5018	uint_t numrecords;
5019	int ret, i;
5020	hist_cbdata_t *cb = (hist_cbdata_t *)data;
5021
5022	cb->first = B_FALSE;
5023
5024	(void) printf(gettext("History for '%s':\n"), zpool_get_name(zhp));
5025
5026	if ((ret = zpool_get_history(zhp, &nvhis)) != 0)
5027		return (ret);
5028
5029	verify(nvlist_lookup_nvlist_array(nvhis, ZPOOL_HIST_RECORD,
5030	    &records, &numrecords) == 0);
5031	for (i = 0; i < numrecords; i++) {
5032		nvlist_t *rec = records[i];
5033		char tbuf[30] = "";
5034
5035		if (nvlist_exists(rec, ZPOOL_HIST_TIME)) {
5036			time_t tsec;
5037			struct tm t;
5038
5039			tsec = fnvlist_lookup_uint64(records[i],
5040			    ZPOOL_HIST_TIME);
5041			(void) localtime_r(&tsec, &t);
5042			(void) strftime(tbuf, sizeof (tbuf), "%F.%T", &t);
5043		}
5044
5045		if (nvlist_exists(rec, ZPOOL_HIST_CMD)) {
5046			(void) printf("%s %s", tbuf,
5047			    fnvlist_lookup_string(rec, ZPOOL_HIST_CMD));
5048		} else if (nvlist_exists(rec, ZPOOL_HIST_INT_EVENT)) {
5049			int ievent =
5050			    fnvlist_lookup_uint64(rec, ZPOOL_HIST_INT_EVENT);
5051			if (!cb->internal)
5052				continue;
5053			if (ievent >= ZFS_NUM_LEGACY_HISTORY_EVENTS) {
5054				(void) printf("%s unrecognized record:\n",
5055				    tbuf);
5056				dump_nvlist(rec, 4);
5057				continue;
5058			}
5059			(void) printf("%s [internal %s txg:%lld] %s", tbuf,
5060			    zfs_history_event_names[ievent],
5061			    fnvlist_lookup_uint64(rec, ZPOOL_HIST_TXG),
5062			    fnvlist_lookup_string(rec, ZPOOL_HIST_INT_STR));
5063		} else if (nvlist_exists(rec, ZPOOL_HIST_INT_NAME)) {
5064			if (!cb->internal)
5065				continue;
5066			(void) printf("%s [txg:%lld] %s", tbuf,
5067			    fnvlist_lookup_uint64(rec, ZPOOL_HIST_TXG),
5068			    fnvlist_lookup_string(rec, ZPOOL_HIST_INT_NAME));
5069			if (nvlist_exists(rec, ZPOOL_HIST_DSNAME)) {
5070				(void) printf(" %s (%llu)",
5071				    fnvlist_lookup_string(rec,
5072				    ZPOOL_HIST_DSNAME),
5073				    fnvlist_lookup_uint64(rec,
5074				    ZPOOL_HIST_DSID));
5075			}
5076			(void) printf(" %s", fnvlist_lookup_string(rec,
5077			    ZPOOL_HIST_INT_STR));
5078		} else if (nvlist_exists(rec, ZPOOL_HIST_IOCTL)) {
5079			if (!cb->internal)
5080				continue;
5081			(void) printf("%s ioctl %s\n", tbuf,
5082			    fnvlist_lookup_string(rec, ZPOOL_HIST_IOCTL));
5083			if (nvlist_exists(rec, ZPOOL_HIST_INPUT_NVL)) {
5084				(void) printf("    input:\n");
5085				dump_nvlist(fnvlist_lookup_nvlist(rec,
5086				    ZPOOL_HIST_INPUT_NVL), 8);
5087			}
5088			if (nvlist_exists(rec, ZPOOL_HIST_OUTPUT_NVL)) {
5089				(void) printf("    output:\n");
5090				dump_nvlist(fnvlist_lookup_nvlist(rec,
5091				    ZPOOL_HIST_OUTPUT_NVL), 8);
5092			}
5093		} else {
5094			if (!cb->internal)
5095				continue;
5096			(void) printf("%s unrecognized record:\n", tbuf);
5097			dump_nvlist(rec, 4);
5098		}
5099
5100		if (!cb->longfmt) {
5101			(void) printf("\n");
5102			continue;
5103		}
5104		(void) printf(" [");
5105		if (nvlist_exists(rec, ZPOOL_HIST_WHO)) {
5106			uid_t who = fnvlist_lookup_uint64(rec, ZPOOL_HIST_WHO);
5107			struct passwd *pwd = getpwuid(who);
5108			(void) printf("user %d ", (int)who);
5109			if (pwd != NULL)
5110				(void) printf("(%s) ", pwd->pw_name);
5111		}
5112		if (nvlist_exists(rec, ZPOOL_HIST_HOST)) {
5113			(void) printf("on %s",
5114			    fnvlist_lookup_string(rec, ZPOOL_HIST_HOST));
5115		}
5116		if (nvlist_exists(rec, ZPOOL_HIST_ZONE)) {
5117			(void) printf(":%s",
5118			    fnvlist_lookup_string(rec, ZPOOL_HIST_ZONE));
5119		}
5120		(void) printf("]");
5121		(void) printf("\n");
5122	}
5123	(void) printf("\n");
5124	nvlist_free(nvhis);
5125
5126	return (ret);
5127}
5128
5129/*
5130 * zpool history <pool>
5131 *
5132 * Displays the history of commands that modified pools.
5133 */
5134int
5135zpool_do_history(int argc, char **argv)
5136{
5137	hist_cbdata_t cbdata = { 0 };
5138	int ret;
5139	int c;
5140
5141	cbdata.first = B_TRUE;
5142	/* check options */
5143	while ((c = getopt(argc, argv, "li")) != -1) {
5144		switch (c) {
5145		case 'l':
5146			cbdata.longfmt = B_TRUE;
5147			break;
5148		case 'i':
5149			cbdata.internal = B_TRUE;
5150			break;
5151		case '?':
5152			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
5153			    optopt);
5154			usage(B_FALSE);
5155		}
5156	}
5157	argc -= optind;
5158	argv += optind;
5159
5160	ret = for_each_pool(argc, argv, B_FALSE,  NULL, get_history_one,
5161	    &cbdata);
5162
5163	if (argc == 0 && cbdata.first == B_TRUE) {
5164		(void) printf(gettext("no pools available\n"));
5165		return (0);
5166	}
5167
5168	return (ret);
5169}
5170
5171static int
5172get_callback(zpool_handle_t *zhp, void *data)
5173{
5174	zprop_get_cbdata_t *cbp = (zprop_get_cbdata_t *)data;
5175	char value[MAXNAMELEN];
5176	zprop_source_t srctype;
5177	zprop_list_t *pl;
5178
5179	for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
5180
5181		/*
5182		 * Skip the special fake placeholder. This will also skip
5183		 * over the name property when 'all' is specified.
5184		 */
5185		if (pl->pl_prop == ZPOOL_PROP_NAME &&
5186		    pl == cbp->cb_proplist)
5187			continue;
5188
5189		if (pl->pl_prop == ZPROP_INVAL &&
5190		    (zpool_prop_feature(pl->pl_user_prop) ||
5191		    zpool_prop_unsupported(pl->pl_user_prop))) {
5192			srctype = ZPROP_SRC_LOCAL;
5193
5194			if (zpool_prop_get_feature(zhp, pl->pl_user_prop,
5195			    value, sizeof (value)) == 0) {
5196				zprop_print_one_property(zpool_get_name(zhp),
5197				    cbp, pl->pl_user_prop, value, srctype,
5198				    NULL, NULL);
5199			}
5200		} else {
5201			if (zpool_get_prop(zhp, pl->pl_prop, value,
5202			    sizeof (value), &srctype) != 0)
5203				continue;
5204
5205			zprop_print_one_property(zpool_get_name(zhp), cbp,
5206			    zpool_prop_to_name(pl->pl_prop), value, srctype,
5207			    NULL, NULL);
5208		}
5209	}
5210	return (0);
5211}
5212
5213int
5214zpool_do_get(int argc, char **argv)
5215{
5216	zprop_get_cbdata_t cb = { 0 };
5217	zprop_list_t fake_name = { 0 };
5218	int ret;
5219
5220	if (argc < 2) {
5221		(void) fprintf(stderr, gettext("missing property "
5222		    "argument\n"));
5223		usage(B_FALSE);
5224	}
5225
5226	cb.cb_first = B_TRUE;
5227	cb.cb_sources = ZPROP_SRC_ALL;
5228	cb.cb_columns[0] = GET_COL_NAME;
5229	cb.cb_columns[1] = GET_COL_PROPERTY;
5230	cb.cb_columns[2] = GET_COL_VALUE;
5231	cb.cb_columns[3] = GET_COL_SOURCE;
5232	cb.cb_type = ZFS_TYPE_POOL;
5233
5234	if (zprop_get_list(g_zfs, argv[1], &cb.cb_proplist,
5235	    ZFS_TYPE_POOL) != 0)
5236		usage(B_FALSE);
5237
5238	if (cb.cb_proplist != NULL) {
5239		fake_name.pl_prop = ZPOOL_PROP_NAME;
5240		fake_name.pl_width = strlen(gettext("NAME"));
5241		fake_name.pl_next = cb.cb_proplist;
5242		cb.cb_proplist = &fake_name;
5243	}
5244
5245	ret = for_each_pool(argc - 2, argv + 2, B_TRUE, &cb.cb_proplist,
5246	    get_callback, &cb);
5247
5248	if (cb.cb_proplist == &fake_name)
5249		zprop_free_list(fake_name.pl_next);
5250	else
5251		zprop_free_list(cb.cb_proplist);
5252
5253	return (ret);
5254}
5255
5256typedef struct set_cbdata {
5257	char *cb_propname;
5258	char *cb_value;
5259	boolean_t cb_any_successful;
5260} set_cbdata_t;
5261
5262int
5263set_callback(zpool_handle_t *zhp, void *data)
5264{
5265	int error;
5266	set_cbdata_t *cb = (set_cbdata_t *)data;
5267
5268	error = zpool_set_prop(zhp, cb->cb_propname, cb->cb_value);
5269
5270	if (!error)
5271		cb->cb_any_successful = B_TRUE;
5272
5273	return (error);
5274}
5275
5276int
5277zpool_do_set(int argc, char **argv)
5278{
5279	set_cbdata_t cb = { 0 };
5280	int error;
5281
5282	if (argc > 1 && argv[1][0] == '-') {
5283		(void) fprintf(stderr, gettext("invalid option '%c'\n"),
5284		    argv[1][1]);
5285		usage(B_FALSE);
5286	}
5287
5288	if (argc < 2) {
5289		(void) fprintf(stderr, gettext("missing property=value "
5290		    "argument\n"));
5291		usage(B_FALSE);
5292	}
5293
5294	if (argc < 3) {
5295		(void) fprintf(stderr, gettext("missing pool name\n"));
5296		usage(B_FALSE);
5297	}
5298
5299	if (argc > 3) {
5300		(void) fprintf(stderr, gettext("too many pool names\n"));
5301		usage(B_FALSE);
5302	}
5303
5304	cb.cb_propname = argv[1];
5305	cb.cb_value = strchr(cb.cb_propname, '=');
5306	if (cb.cb_value == NULL) {
5307		(void) fprintf(stderr, gettext("missing value in "
5308		    "property=value argument\n"));
5309		usage(B_FALSE);
5310	}
5311
5312	*(cb.cb_value) = '\0';
5313	cb.cb_value++;
5314
5315	error = for_each_pool(argc - 2, argv + 2, B_TRUE, NULL,
5316	    set_callback, &cb);
5317
5318	return (error);
5319}
5320
5321static int
5322find_command_idx(char *command, int *idx)
5323{
5324	int i;
5325
5326	for (i = 0; i < NCOMMAND; i++) {
5327		if (command_table[i].name == NULL)
5328			continue;
5329
5330		if (strcmp(command, command_table[i].name) == 0) {
5331			*idx = i;
5332			return (0);
5333		}
5334	}
5335	return (1);
5336}
5337
5338int
5339main(int argc, char **argv)
5340{
5341	int ret;
5342	int i;
5343	char *cmdname;
5344
5345	(void) setlocale(LC_ALL, "");
5346	(void) textdomain(TEXT_DOMAIN);
5347
5348	if ((g_zfs = libzfs_init()) == NULL) {
5349		(void) fprintf(stderr, gettext("internal error: failed to "
5350		    "initialize ZFS library\n"));
5351		return (1);
5352	}
5353
5354	libzfs_print_on_error(g_zfs, B_TRUE);
5355
5356	opterr = 0;
5357
5358	/*
5359	 * Make sure the user has specified some command.
5360	 */
5361	if (argc < 2) {
5362		(void) fprintf(stderr, gettext("missing command\n"));
5363		usage(B_FALSE);
5364	}
5365
5366	cmdname = argv[1];
5367
5368	/*
5369	 * Special case '-?'
5370	 */
5371	if (strcmp(cmdname, "-?") == 0)
5372		usage(B_TRUE);
5373
5374	zfs_save_arguments(argc, argv, history_str, sizeof (history_str));
5375
5376	/*
5377	 * Run the appropriate command.
5378	 */
5379	if (find_command_idx(cmdname, &i) == 0) {
5380		current_command = &command_table[i];
5381		ret = command_table[i].func(argc - 1, argv + 1);
5382	} else if (strchr(cmdname, '=')) {
5383		verify(find_command_idx("set", &i) == 0);
5384		current_command = &command_table[i];
5385		ret = command_table[i].func(argc, argv);
5386	} else if (strcmp(cmdname, "freeze") == 0 && argc == 3) {
5387		/*
5388		 * 'freeze' is a vile debugging abomination, so we treat
5389		 * it as such.
5390		 */
5391		zfs_cmd_t zc = { 0 };
5392		(void) strlcpy(zc.zc_name, argv[2], sizeof (zc.zc_name));
5393		return (!!zfs_ioctl(g_zfs, ZFS_IOC_POOL_FREEZE, &zc));
5394	} else {
5395		(void) fprintf(stderr, gettext("unrecognized "
5396		    "command '%s'\n"), cmdname);
5397		usage(B_FALSE);
5398	}
5399
5400	if (ret == 0 && log_history)
5401		(void) zpool_log_history(g_zfs, history_str);
5402
5403	libzfs_fini(g_zfs);
5404
5405	/*
5406	 * The 'ZFS_ABORT' environment variable causes us to dump core on exit
5407	 * for the purposes of running ::findleaks.
5408	 */
5409	if (getenv("ZFS_ABORT") != NULL) {
5410		(void) printf("dumping core by request\n");
5411		abort();
5412	}
5413
5414	return (ret);
5415}
5416