zpool_main.c revision 269735
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) 2011, 2014 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 [-Hpv] [-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 [-Hp] [-o \"all\" | field[,...]] "
262		    "<\"all\" | property[,...]> <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:R: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, 0);
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	boolean_t	cb_literal;
2769} list_cbdata_t;
2770
2771/*
2772 * Given a list of columns to display, output appropriate headers for each one.
2773 */
2774static void
2775print_header(list_cbdata_t *cb)
2776{
2777	zprop_list_t *pl = cb->cb_proplist;
2778	char headerbuf[ZPOOL_MAXPROPLEN];
2779	const char *header;
2780	boolean_t first = B_TRUE;
2781	boolean_t right_justify;
2782	size_t width = 0;
2783
2784	for (; pl != NULL; pl = pl->pl_next) {
2785		width = pl->pl_width;
2786		if (first && cb->cb_verbose) {
2787			/*
2788			 * Reset the width to accommodate the verbose listing
2789			 * of devices.
2790			 */
2791			width = cb->cb_namewidth;
2792		}
2793
2794		if (!first)
2795			(void) printf("  ");
2796		else
2797			first = B_FALSE;
2798
2799		right_justify = B_FALSE;
2800		if (pl->pl_prop != ZPROP_INVAL) {
2801			header = zpool_prop_column_name(pl->pl_prop);
2802			right_justify = zpool_prop_align_right(pl->pl_prop);
2803		} else {
2804			int i;
2805
2806			for (i = 0; pl->pl_user_prop[i] != '\0'; i++)
2807				headerbuf[i] = toupper(pl->pl_user_prop[i]);
2808			headerbuf[i] = '\0';
2809			header = headerbuf;
2810		}
2811
2812		if (pl->pl_next == NULL && !right_justify)
2813			(void) printf("%s", header);
2814		else if (right_justify)
2815			(void) printf("%*s", width, header);
2816		else
2817			(void) printf("%-*s", width, header);
2818
2819	}
2820
2821	(void) printf("\n");
2822}
2823
2824/*
2825 * Given a pool and a list of properties, print out all the properties according
2826 * to the described layout.
2827 */
2828static void
2829print_pool(zpool_handle_t *zhp, list_cbdata_t *cb)
2830{
2831	zprop_list_t *pl = cb->cb_proplist;
2832	boolean_t first = B_TRUE;
2833	char property[ZPOOL_MAXPROPLEN];
2834	char *propstr;
2835	boolean_t right_justify;
2836	size_t width;
2837
2838	for (; pl != NULL; pl = pl->pl_next) {
2839
2840		width = pl->pl_width;
2841		if (first && cb->cb_verbose) {
2842			/*
2843			 * Reset the width to accommodate the verbose listing
2844			 * of devices.
2845			 */
2846			width = cb->cb_namewidth;
2847		}
2848
2849		if (!first) {
2850			if (cb->cb_scripted)
2851				(void) printf("\t");
2852			else
2853				(void) printf("  ");
2854		} else {
2855			first = B_FALSE;
2856		}
2857
2858		right_justify = B_FALSE;
2859		if (pl->pl_prop != ZPROP_INVAL) {
2860			if (pl->pl_prop == ZPOOL_PROP_EXPANDSZ &&
2861			    zpool_get_prop_int(zhp, pl->pl_prop, NULL) == 0)
2862				propstr = "-";
2863			else if (zpool_get_prop(zhp, pl->pl_prop, property,
2864			    sizeof (property), NULL, cb->cb_literal) != 0)
2865				propstr = "-";
2866			else
2867				propstr = property;
2868
2869			right_justify = zpool_prop_align_right(pl->pl_prop);
2870		} else if ((zpool_prop_feature(pl->pl_user_prop) ||
2871		    zpool_prop_unsupported(pl->pl_user_prop)) &&
2872		    zpool_prop_get_feature(zhp, pl->pl_user_prop, property,
2873		    sizeof (property)) == 0) {
2874			propstr = property;
2875		} else {
2876			propstr = "-";
2877		}
2878
2879
2880		/*
2881		 * If this is being called in scripted mode, or if this is the
2882		 * last column and it is left-justified, don't include a width
2883		 * format specifier.
2884		 */
2885		if (cb->cb_scripted || (pl->pl_next == NULL && !right_justify))
2886			(void) printf("%s", propstr);
2887		else if (right_justify)
2888			(void) printf("%*s", width, propstr);
2889		else
2890			(void) printf("%-*s", width, propstr);
2891	}
2892
2893	(void) printf("\n");
2894}
2895
2896static void
2897print_one_column(zpool_prop_t prop, uint64_t value, boolean_t scripted)
2898{
2899	char propval[64];
2900	boolean_t fixed;
2901	size_t width = zprop_width(prop, &fixed, ZFS_TYPE_POOL);
2902
2903	zfs_nicenum(value, propval, sizeof (propval));
2904
2905	if (prop == ZPOOL_PROP_EXPANDSZ && value == 0)
2906		(void) strlcpy(propval, "-", sizeof (propval));
2907
2908	if (scripted)
2909		(void) printf("\t%s", propval);
2910	else
2911		(void) printf("  %*s", width, propval);
2912}
2913
2914void
2915print_list_stats(zpool_handle_t *zhp, const char *name, nvlist_t *nv,
2916    list_cbdata_t *cb, int depth)
2917{
2918	nvlist_t **child;
2919	vdev_stat_t *vs;
2920	uint_t c, children;
2921	char *vname;
2922	boolean_t scripted = cb->cb_scripted;
2923
2924	verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
2925	    (uint64_t **)&vs, &c) == 0);
2926
2927	if (name != NULL) {
2928		if (scripted)
2929			(void) printf("\t%s", name);
2930		else if (strlen(name) + depth > cb->cb_namewidth)
2931			(void) printf("%*s%s", depth, "", name);
2932		else
2933			(void) printf("%*s%s%*s", depth, "", name,
2934			    (int)(cb->cb_namewidth - strlen(name) - depth), "");
2935
2936		/* only toplevel vdevs have capacity stats */
2937		if (vs->vs_space == 0) {
2938			if (scripted)
2939				(void) printf("\t-\t-\t-");
2940			else
2941				(void) printf("      -      -      -");
2942		} else {
2943			print_one_column(ZPOOL_PROP_SIZE, vs->vs_space,
2944			    scripted);
2945			print_one_column(ZPOOL_PROP_CAPACITY, vs->vs_alloc,
2946			    scripted);
2947			print_one_column(ZPOOL_PROP_FREE,
2948			    vs->vs_space - vs->vs_alloc, scripted);
2949		}
2950		print_one_column(ZPOOL_PROP_EXPANDSZ, vs->vs_esize,
2951		    scripted);
2952		(void) printf("\n");
2953	}
2954
2955	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
2956	    &child, &children) != 0)
2957		return;
2958
2959	for (c = 0; c < children; c++) {
2960		uint64_t ishole = B_FALSE;
2961
2962		if (nvlist_lookup_uint64(child[c],
2963		    ZPOOL_CONFIG_IS_HOLE, &ishole) == 0 && ishole)
2964			continue;
2965
2966		vname = zpool_vdev_name(g_zfs, zhp, child[c], B_FALSE);
2967		print_list_stats(zhp, vname, child[c], cb, depth + 2);
2968		free(vname);
2969	}
2970
2971	/*
2972	 * Include level 2 ARC devices in iostat output
2973	 */
2974	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE,
2975	    &child, &children) != 0)
2976		return;
2977
2978	if (children > 0) {
2979		(void) printf("%-*s      -      -      -      -      -      "
2980		    "-\n", cb->cb_namewidth, "cache");
2981		for (c = 0; c < children; c++) {
2982			vname = zpool_vdev_name(g_zfs, zhp, child[c],
2983			    B_FALSE);
2984			print_list_stats(zhp, vname, child[c], cb, depth + 2);
2985			free(vname);
2986		}
2987	}
2988}
2989
2990
2991/*
2992 * Generic callback function to list a pool.
2993 */
2994int
2995list_callback(zpool_handle_t *zhp, void *data)
2996{
2997	list_cbdata_t *cbp = data;
2998	nvlist_t *config;
2999	nvlist_t *nvroot;
3000
3001	config = zpool_get_config(zhp, NULL);
3002
3003	print_pool(zhp, cbp);
3004	if (!cbp->cb_verbose)
3005		return (0);
3006
3007	verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
3008	    &nvroot) == 0);
3009	print_list_stats(zhp, NULL, nvroot, cbp, 0);
3010
3011	return (0);
3012}
3013
3014/*
3015 * zpool list [-Hp] [-o prop[,prop]*] [-T d|u] [pool] ... [interval [count]]
3016 *
3017 *	-H	Scripted mode.  Don't display headers, and separate properties
3018 *		by a single tab.
3019 *	-o	List of properties to display.  Defaults to
3020 *		"name,size,allocated,free,capacity,health,altroot"
3021 * 	-p	Diplay values in parsable (exact) format.
3022 *	-T	Display a timestamp in date(1) or Unix format
3023 *
3024 * List all pools in the system, whether or not they're healthy.  Output space
3025 * statistics for each one, as well as health status summary.
3026 */
3027int
3028zpool_do_list(int argc, char **argv)
3029{
3030	int c;
3031	int ret;
3032	list_cbdata_t cb = { 0 };
3033	static char default_props[] =
3034	    "name,size,allocated,free,capacity,dedupratio,"
3035	    "health,altroot";
3036	char *props = default_props;
3037	unsigned long interval = 0, count = 0;
3038	zpool_list_t *list;
3039	boolean_t first = B_TRUE;
3040
3041	/* check options */
3042	while ((c = getopt(argc, argv, ":Ho:pT:v")) != -1) {
3043		switch (c) {
3044		case 'H':
3045			cb.cb_scripted = B_TRUE;
3046			break;
3047		case 'o':
3048			props = optarg;
3049			break;
3050		case 'p':
3051			cb.cb_literal = B_TRUE;
3052			break;
3053		case 'T':
3054			get_timestamp_arg(*optarg);
3055			break;
3056		case 'v':
3057			cb.cb_verbose = B_TRUE;
3058			break;
3059		case ':':
3060			(void) fprintf(stderr, gettext("missing argument for "
3061			    "'%c' option\n"), optopt);
3062			usage(B_FALSE);
3063			break;
3064		case '?':
3065			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3066			    optopt);
3067			usage(B_FALSE);
3068		}
3069	}
3070
3071	argc -= optind;
3072	argv += optind;
3073
3074	get_interval_count(&argc, argv, &interval, &count);
3075
3076	if (zprop_get_list(g_zfs, props, &cb.cb_proplist, ZFS_TYPE_POOL) != 0)
3077		usage(B_FALSE);
3078
3079	for (;;) {
3080		if ((list = pool_list_get(argc, argv, &cb.cb_proplist,
3081		    &ret)) == NULL)
3082			return (1);
3083
3084		if (pool_list_count(list) == 0)
3085			break;
3086
3087		cb.cb_namewidth = 0;
3088		(void) pool_list_iter(list, B_FALSE, get_namewidth, &cb);
3089
3090		if (timestamp_fmt != NODATE)
3091			print_timestamp(timestamp_fmt);
3092
3093		if (!cb.cb_scripted && (first || cb.cb_verbose)) {
3094			print_header(&cb);
3095			first = B_FALSE;
3096		}
3097		ret = pool_list_iter(list, B_TRUE, list_callback, &cb);
3098
3099		if (interval == 0)
3100			break;
3101
3102		if (count != 0 && --count == 0)
3103			break;
3104
3105		pool_list_free(list);
3106		(void) sleep(interval);
3107	}
3108
3109	if (argc == 0 && !cb.cb_scripted && pool_list_count(list) == 0) {
3110		(void) printf(gettext("no pools available\n"));
3111		ret = 0;
3112	}
3113
3114	pool_list_free(list);
3115	zprop_free_list(cb.cb_proplist);
3116	return (ret);
3117}
3118
3119static nvlist_t *
3120zpool_get_vdev_by_name(nvlist_t *nv, char *name)
3121{
3122	nvlist_t **child;
3123	uint_t c, children;
3124	nvlist_t *match;
3125	char *path;
3126
3127	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
3128	    &child, &children) != 0) {
3129		verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0);
3130		if (strncmp(name, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
3131			name += sizeof(_PATH_DEV) - 1;
3132		if (strncmp(path, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
3133			path += sizeof(_PATH_DEV) - 1;
3134		if (strcmp(name, path) == 0)
3135			return (nv);
3136		return (NULL);
3137	}
3138
3139	for (c = 0; c < children; c++)
3140		if ((match = zpool_get_vdev_by_name(child[c], name)) != NULL)
3141			return (match);
3142
3143	return (NULL);
3144}
3145
3146static int
3147zpool_do_attach_or_replace(int argc, char **argv, int replacing)
3148{
3149	boolean_t force = B_FALSE;
3150	int c;
3151	nvlist_t *nvroot;
3152	char *poolname, *old_disk, *new_disk;
3153	zpool_handle_t *zhp;
3154	int ret;
3155
3156	/* check options */
3157	while ((c = getopt(argc, argv, "f")) != -1) {
3158		switch (c) {
3159		case 'f':
3160			force = B_TRUE;
3161			break;
3162		case '?':
3163			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3164			    optopt);
3165			usage(B_FALSE);
3166		}
3167	}
3168
3169	argc -= optind;
3170	argv += optind;
3171
3172	/* get pool name and check number of arguments */
3173	if (argc < 1) {
3174		(void) fprintf(stderr, gettext("missing pool name argument\n"));
3175		usage(B_FALSE);
3176	}
3177
3178	poolname = argv[0];
3179
3180	if (argc < 2) {
3181		(void) fprintf(stderr,
3182		    gettext("missing <device> specification\n"));
3183		usage(B_FALSE);
3184	}
3185
3186	old_disk = argv[1];
3187
3188	if (argc < 3) {
3189		if (!replacing) {
3190			(void) fprintf(stderr,
3191			    gettext("missing <new_device> specification\n"));
3192			usage(B_FALSE);
3193		}
3194		new_disk = old_disk;
3195		argc -= 1;
3196		argv += 1;
3197	} else {
3198		new_disk = argv[2];
3199		argc -= 2;
3200		argv += 2;
3201	}
3202
3203	if (argc > 1) {
3204		(void) fprintf(stderr, gettext("too many arguments\n"));
3205		usage(B_FALSE);
3206	}
3207
3208	if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3209		return (1);
3210
3211	if (zpool_get_config(zhp, NULL) == NULL) {
3212		(void) fprintf(stderr, gettext("pool '%s' is unavailable\n"),
3213		    poolname);
3214		zpool_close(zhp);
3215		return (1);
3216	}
3217
3218	nvroot = make_root_vdev(zhp, force, B_FALSE, replacing, B_FALSE,
3219	    argc, argv);
3220	if (nvroot == NULL) {
3221		zpool_close(zhp);
3222		return (1);
3223	}
3224
3225	ret = zpool_vdev_attach(zhp, old_disk, new_disk, nvroot, replacing);
3226
3227	nvlist_free(nvroot);
3228	zpool_close(zhp);
3229
3230	return (ret);
3231}
3232
3233/*
3234 * zpool replace [-f] <pool> <device> <new_device>
3235 *
3236 *	-f	Force attach, even if <new_device> appears to be in use.
3237 *
3238 * Replace <device> with <new_device>.
3239 */
3240/* ARGSUSED */
3241int
3242zpool_do_replace(int argc, char **argv)
3243{
3244	return (zpool_do_attach_or_replace(argc, argv, B_TRUE));
3245}
3246
3247/*
3248 * zpool attach [-f] <pool> <device> <new_device>
3249 *
3250 *	-f	Force attach, even if <new_device> appears to be in use.
3251 *
3252 * Attach <new_device> to the mirror containing <device>.  If <device> is not
3253 * part of a mirror, then <device> will be transformed into a mirror of
3254 * <device> and <new_device>.  In either case, <new_device> will begin life
3255 * with a DTL of [0, now], and will immediately begin to resilver itself.
3256 */
3257int
3258zpool_do_attach(int argc, char **argv)
3259{
3260	return (zpool_do_attach_or_replace(argc, argv, B_FALSE));
3261}
3262
3263/*
3264 * zpool detach [-f] <pool> <device>
3265 *
3266 *	-f	Force detach of <device>, even if DTLs argue against it
3267 *		(not supported yet)
3268 *
3269 * Detach a device from a mirror.  The operation will be refused if <device>
3270 * is the last device in the mirror, or if the DTLs indicate that this device
3271 * has the only valid copy of some data.
3272 */
3273/* ARGSUSED */
3274int
3275zpool_do_detach(int argc, char **argv)
3276{
3277	int c;
3278	char *poolname, *path;
3279	zpool_handle_t *zhp;
3280	int ret;
3281
3282	/* check options */
3283	while ((c = getopt(argc, argv, "f")) != -1) {
3284		switch (c) {
3285		case 'f':
3286		case '?':
3287			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3288			    optopt);
3289			usage(B_FALSE);
3290		}
3291	}
3292
3293	argc -= optind;
3294	argv += optind;
3295
3296	/* get pool name and check number of arguments */
3297	if (argc < 1) {
3298		(void) fprintf(stderr, gettext("missing pool name argument\n"));
3299		usage(B_FALSE);
3300	}
3301
3302	if (argc < 2) {
3303		(void) fprintf(stderr,
3304		    gettext("missing <device> specification\n"));
3305		usage(B_FALSE);
3306	}
3307
3308	poolname = argv[0];
3309	path = argv[1];
3310
3311	if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3312		return (1);
3313
3314	ret = zpool_vdev_detach(zhp, path);
3315
3316	zpool_close(zhp);
3317
3318	return (ret);
3319}
3320
3321/*
3322 * zpool split [-n] [-o prop=val] ...
3323 *		[-o mntopt] ...
3324 *		[-R altroot] <pool> <newpool> [<device> ...]
3325 *
3326 *	-n	Do not split the pool, but display the resulting layout if
3327 *		it were to be split.
3328 *	-o	Set property=value, or set mount options.
3329 *	-R	Mount the split-off pool under an alternate root.
3330 *
3331 * Splits the named pool and gives it the new pool name.  Devices to be split
3332 * off may be listed, provided that no more than one device is specified
3333 * per top-level vdev mirror.  The newly split pool is left in an exported
3334 * state unless -R is specified.
3335 *
3336 * Restrictions: the top-level of the pool pool must only be made up of
3337 * mirrors; all devices in the pool must be healthy; no device may be
3338 * undergoing a resilvering operation.
3339 */
3340int
3341zpool_do_split(int argc, char **argv)
3342{
3343	char *srcpool, *newpool, *propval;
3344	char *mntopts = NULL;
3345	splitflags_t flags;
3346	int c, ret = 0;
3347	zpool_handle_t *zhp;
3348	nvlist_t *config, *props = NULL;
3349
3350	flags.dryrun = B_FALSE;
3351	flags.import = B_FALSE;
3352
3353	/* check options */
3354	while ((c = getopt(argc, argv, ":R:no:")) != -1) {
3355		switch (c) {
3356		case 'R':
3357			flags.import = B_TRUE;
3358			if (add_prop_list(
3359			    zpool_prop_to_name(ZPOOL_PROP_ALTROOT), optarg,
3360			    &props, B_TRUE) != 0) {
3361				if (props)
3362					nvlist_free(props);
3363				usage(B_FALSE);
3364			}
3365			break;
3366		case 'n':
3367			flags.dryrun = B_TRUE;
3368			break;
3369		case 'o':
3370			if ((propval = strchr(optarg, '=')) != NULL) {
3371				*propval = '\0';
3372				propval++;
3373				if (add_prop_list(optarg, propval,
3374				    &props, B_TRUE) != 0) {
3375					if (props)
3376						nvlist_free(props);
3377					usage(B_FALSE);
3378				}
3379			} else {
3380				mntopts = optarg;
3381			}
3382			break;
3383		case ':':
3384			(void) fprintf(stderr, gettext("missing argument for "
3385			    "'%c' option\n"), optopt);
3386			usage(B_FALSE);
3387			break;
3388		case '?':
3389			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3390			    optopt);
3391			usage(B_FALSE);
3392			break;
3393		}
3394	}
3395
3396	if (!flags.import && mntopts != NULL) {
3397		(void) fprintf(stderr, gettext("setting mntopts is only "
3398		    "valid when importing the pool\n"));
3399		usage(B_FALSE);
3400	}
3401
3402	argc -= optind;
3403	argv += optind;
3404
3405	if (argc < 1) {
3406		(void) fprintf(stderr, gettext("Missing pool name\n"));
3407		usage(B_FALSE);
3408	}
3409	if (argc < 2) {
3410		(void) fprintf(stderr, gettext("Missing new pool name\n"));
3411		usage(B_FALSE);
3412	}
3413
3414	srcpool = argv[0];
3415	newpool = argv[1];
3416
3417	argc -= 2;
3418	argv += 2;
3419
3420	if ((zhp = zpool_open(g_zfs, srcpool)) == NULL)
3421		return (1);
3422
3423	config = split_mirror_vdev(zhp, newpool, props, flags, argc, argv);
3424	if (config == NULL) {
3425		ret = 1;
3426	} else {
3427		if (flags.dryrun) {
3428			(void) printf(gettext("would create '%s' with the "
3429			    "following layout:\n\n"), newpool);
3430			print_vdev_tree(NULL, newpool, config, 0, B_FALSE);
3431		}
3432		nvlist_free(config);
3433	}
3434
3435	zpool_close(zhp);
3436
3437	if (ret != 0 || flags.dryrun || !flags.import)
3438		return (ret);
3439
3440	/*
3441	 * The split was successful. Now we need to open the new
3442	 * pool and import it.
3443	 */
3444	if ((zhp = zpool_open_canfail(g_zfs, newpool)) == NULL)
3445		return (1);
3446	if (zpool_get_state(zhp) != POOL_STATE_UNAVAIL &&
3447	    zpool_enable_datasets(zhp, mntopts, 0) != 0) {
3448		ret = 1;
3449		(void) fprintf(stderr, gettext("Split was successful, but "
3450		    "the datasets could not all be mounted\n"));
3451		(void) fprintf(stderr, gettext("Try doing '%s' with a "
3452		    "different altroot\n"), "zpool import");
3453	}
3454	zpool_close(zhp);
3455
3456	return (ret);
3457}
3458
3459
3460
3461/*
3462 * zpool online <pool> <device> ...
3463 */
3464int
3465zpool_do_online(int argc, char **argv)
3466{
3467	int c, i;
3468	char *poolname;
3469	zpool_handle_t *zhp;
3470	int ret = 0;
3471	vdev_state_t newstate;
3472	int flags = 0;
3473
3474	/* check options */
3475	while ((c = getopt(argc, argv, "et")) != -1) {
3476		switch (c) {
3477		case 'e':
3478			flags |= ZFS_ONLINE_EXPAND;
3479			break;
3480		case 't':
3481		case '?':
3482			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3483			    optopt);
3484			usage(B_FALSE);
3485		}
3486	}
3487
3488	argc -= optind;
3489	argv += optind;
3490
3491	/* get pool name and check number of arguments */
3492	if (argc < 1) {
3493		(void) fprintf(stderr, gettext("missing pool name\n"));
3494		usage(B_FALSE);
3495	}
3496	if (argc < 2) {
3497		(void) fprintf(stderr, gettext("missing device name\n"));
3498		usage(B_FALSE);
3499	}
3500
3501	poolname = argv[0];
3502
3503	if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3504		return (1);
3505
3506	for (i = 1; i < argc; i++) {
3507		if (zpool_vdev_online(zhp, argv[i], flags, &newstate) == 0) {
3508			if (newstate != VDEV_STATE_HEALTHY) {
3509				(void) printf(gettext("warning: device '%s' "
3510				    "onlined, but remains in faulted state\n"),
3511				    argv[i]);
3512				if (newstate == VDEV_STATE_FAULTED)
3513					(void) printf(gettext("use 'zpool "
3514					    "clear' to restore a faulted "
3515					    "device\n"));
3516				else
3517					(void) printf(gettext("use 'zpool "
3518					    "replace' to replace devices "
3519					    "that are no longer present\n"));
3520			}
3521		} else {
3522			ret = 1;
3523		}
3524	}
3525
3526	zpool_close(zhp);
3527
3528	return (ret);
3529}
3530
3531/*
3532 * zpool offline [-ft] <pool> <device> ...
3533 *
3534 *	-f	Force the device into the offline state, even if doing
3535 *		so would appear to compromise pool availability.
3536 *		(not supported yet)
3537 *
3538 *	-t	Only take the device off-line temporarily.  The offline
3539 *		state will not be persistent across reboots.
3540 */
3541/* ARGSUSED */
3542int
3543zpool_do_offline(int argc, char **argv)
3544{
3545	int c, i;
3546	char *poolname;
3547	zpool_handle_t *zhp;
3548	int ret = 0;
3549	boolean_t istmp = B_FALSE;
3550
3551	/* check options */
3552	while ((c = getopt(argc, argv, "ft")) != -1) {
3553		switch (c) {
3554		case 't':
3555			istmp = B_TRUE;
3556			break;
3557		case 'f':
3558		case '?':
3559			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3560			    optopt);
3561			usage(B_FALSE);
3562		}
3563	}
3564
3565	argc -= optind;
3566	argv += optind;
3567
3568	/* get pool name and check number of arguments */
3569	if (argc < 1) {
3570		(void) fprintf(stderr, gettext("missing pool name\n"));
3571		usage(B_FALSE);
3572	}
3573	if (argc < 2) {
3574		(void) fprintf(stderr, gettext("missing device name\n"));
3575		usage(B_FALSE);
3576	}
3577
3578	poolname = argv[0];
3579
3580	if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3581		return (1);
3582
3583	for (i = 1; i < argc; i++) {
3584		if (zpool_vdev_offline(zhp, argv[i], istmp) != 0)
3585			ret = 1;
3586	}
3587
3588	zpool_close(zhp);
3589
3590	return (ret);
3591}
3592
3593/*
3594 * zpool clear <pool> [device]
3595 *
3596 * Clear all errors associated with a pool or a particular device.
3597 */
3598int
3599zpool_do_clear(int argc, char **argv)
3600{
3601	int c;
3602	int ret = 0;
3603	boolean_t dryrun = B_FALSE;
3604	boolean_t do_rewind = B_FALSE;
3605	boolean_t xtreme_rewind = B_FALSE;
3606	uint32_t rewind_policy = ZPOOL_NO_REWIND;
3607	nvlist_t *policy = NULL;
3608	zpool_handle_t *zhp;
3609	char *pool, *device;
3610
3611	/* check options */
3612	while ((c = getopt(argc, argv, "FnX")) != -1) {
3613		switch (c) {
3614		case 'F':
3615			do_rewind = B_TRUE;
3616			break;
3617		case 'n':
3618			dryrun = B_TRUE;
3619			break;
3620		case 'X':
3621			xtreme_rewind = B_TRUE;
3622			break;
3623		case '?':
3624			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3625			    optopt);
3626			usage(B_FALSE);
3627		}
3628	}
3629
3630	argc -= optind;
3631	argv += optind;
3632
3633	if (argc < 1) {
3634		(void) fprintf(stderr, gettext("missing pool name\n"));
3635		usage(B_FALSE);
3636	}
3637
3638	if (argc > 2) {
3639		(void) fprintf(stderr, gettext("too many arguments\n"));
3640		usage(B_FALSE);
3641	}
3642
3643	if ((dryrun || xtreme_rewind) && !do_rewind) {
3644		(void) fprintf(stderr,
3645		    gettext("-n or -X only meaningful with -F\n"));
3646		usage(B_FALSE);
3647	}
3648	if (dryrun)
3649		rewind_policy = ZPOOL_TRY_REWIND;
3650	else if (do_rewind)
3651		rewind_policy = ZPOOL_DO_REWIND;
3652	if (xtreme_rewind)
3653		rewind_policy |= ZPOOL_EXTREME_REWIND;
3654
3655	/* In future, further rewind policy choices can be passed along here */
3656	if (nvlist_alloc(&policy, NV_UNIQUE_NAME, 0) != 0 ||
3657	    nvlist_add_uint32(policy, ZPOOL_REWIND_REQUEST, rewind_policy) != 0)
3658		return (1);
3659
3660	pool = argv[0];
3661	device = argc == 2 ? argv[1] : NULL;
3662
3663	if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL) {
3664		nvlist_free(policy);
3665		return (1);
3666	}
3667
3668	if (zpool_clear(zhp, device, policy) != 0)
3669		ret = 1;
3670
3671	zpool_close(zhp);
3672
3673	nvlist_free(policy);
3674
3675	return (ret);
3676}
3677
3678/*
3679 * zpool reguid <pool>
3680 */
3681int
3682zpool_do_reguid(int argc, char **argv)
3683{
3684	int c;
3685	char *poolname;
3686	zpool_handle_t *zhp;
3687	int ret = 0;
3688
3689	/* check options */
3690	while ((c = getopt(argc, argv, "")) != -1) {
3691		switch (c) {
3692		case '?':
3693			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3694			    optopt);
3695			usage(B_FALSE);
3696		}
3697	}
3698
3699	argc -= optind;
3700	argv += optind;
3701
3702	/* get pool name and check number of arguments */
3703	if (argc < 1) {
3704		(void) fprintf(stderr, gettext("missing pool name\n"));
3705		usage(B_FALSE);
3706	}
3707
3708	if (argc > 1) {
3709		(void) fprintf(stderr, gettext("too many arguments\n"));
3710		usage(B_FALSE);
3711	}
3712
3713	poolname = argv[0];
3714	if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3715		return (1);
3716
3717	ret = zpool_reguid(zhp);
3718
3719	zpool_close(zhp);
3720	return (ret);
3721}
3722
3723
3724/*
3725 * zpool reopen <pool>
3726 *
3727 * Reopen the pool so that the kernel can update the sizes of all vdevs.
3728 */
3729int
3730zpool_do_reopen(int argc, char **argv)
3731{
3732	int c;
3733	int ret = 0;
3734	zpool_handle_t *zhp;
3735	char *pool;
3736
3737	/* check options */
3738	while ((c = getopt(argc, argv, "")) != -1) {
3739		switch (c) {
3740		case '?':
3741			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3742			    optopt);
3743			usage(B_FALSE);
3744		}
3745	}
3746
3747	argc--;
3748	argv++;
3749
3750	if (argc < 1) {
3751		(void) fprintf(stderr, gettext("missing pool name\n"));
3752		usage(B_FALSE);
3753	}
3754
3755	if (argc > 1) {
3756		(void) fprintf(stderr, gettext("too many arguments\n"));
3757		usage(B_FALSE);
3758	}
3759
3760	pool = argv[0];
3761	if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL)
3762		return (1);
3763
3764	ret = zpool_reopen(zhp);
3765	zpool_close(zhp);
3766	return (ret);
3767}
3768
3769typedef struct scrub_cbdata {
3770	int	cb_type;
3771	int	cb_argc;
3772	char	**cb_argv;
3773} scrub_cbdata_t;
3774
3775int
3776scrub_callback(zpool_handle_t *zhp, void *data)
3777{
3778	scrub_cbdata_t *cb = data;
3779	int err;
3780
3781	/*
3782	 * Ignore faulted pools.
3783	 */
3784	if (zpool_get_state(zhp) == POOL_STATE_UNAVAIL) {
3785		(void) fprintf(stderr, gettext("cannot scrub '%s': pool is "
3786		    "currently unavailable\n"), zpool_get_name(zhp));
3787		return (1);
3788	}
3789
3790	err = zpool_scan(zhp, cb->cb_type);
3791
3792	return (err != 0);
3793}
3794
3795/*
3796 * zpool scrub [-s] <pool> ...
3797 *
3798 *	-s	Stop.  Stops any in-progress scrub.
3799 */
3800int
3801zpool_do_scrub(int argc, char **argv)
3802{
3803	int c;
3804	scrub_cbdata_t cb;
3805
3806	cb.cb_type = POOL_SCAN_SCRUB;
3807
3808	/* check options */
3809	while ((c = getopt(argc, argv, "s")) != -1) {
3810		switch (c) {
3811		case 's':
3812			cb.cb_type = POOL_SCAN_NONE;
3813			break;
3814		case '?':
3815			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
3816			    optopt);
3817			usage(B_FALSE);
3818		}
3819	}
3820
3821	cb.cb_argc = argc;
3822	cb.cb_argv = argv;
3823	argc -= optind;
3824	argv += optind;
3825
3826	if (argc < 1) {
3827		(void) fprintf(stderr, gettext("missing pool name argument\n"));
3828		usage(B_FALSE);
3829	}
3830
3831	return (for_each_pool(argc, argv, B_TRUE, NULL, scrub_callback, &cb));
3832}
3833
3834typedef struct status_cbdata {
3835	int		cb_count;
3836	boolean_t	cb_allpools;
3837	boolean_t	cb_verbose;
3838	boolean_t	cb_explain;
3839	boolean_t	cb_first;
3840	boolean_t	cb_dedup_stats;
3841} status_cbdata_t;
3842
3843/*
3844 * Print out detailed scrub status.
3845 */
3846void
3847print_scan_status(pool_scan_stat_t *ps)
3848{
3849	time_t start, end;
3850	uint64_t elapsed, mins_left, hours_left;
3851	uint64_t pass_exam, examined, total;
3852	uint_t rate;
3853	double fraction_done;
3854	char processed_buf[7], examined_buf[7], total_buf[7], rate_buf[7];
3855
3856	(void) printf(gettext("  scan: "));
3857
3858	/* If there's never been a scan, there's not much to say. */
3859	if (ps == NULL || ps->pss_func == POOL_SCAN_NONE ||
3860	    ps->pss_func >= POOL_SCAN_FUNCS) {
3861		(void) printf(gettext("none requested\n"));
3862		return;
3863	}
3864
3865	start = ps->pss_start_time;
3866	end = ps->pss_end_time;
3867	zfs_nicenum(ps->pss_processed, processed_buf, sizeof (processed_buf));
3868
3869	assert(ps->pss_func == POOL_SCAN_SCRUB ||
3870	    ps->pss_func == POOL_SCAN_RESILVER);
3871	/*
3872	 * Scan is finished or canceled.
3873	 */
3874	if (ps->pss_state == DSS_FINISHED) {
3875		uint64_t minutes_taken = (end - start) / 60;
3876		char *fmt;
3877
3878		if (ps->pss_func == POOL_SCAN_SCRUB) {
3879			fmt = gettext("scrub repaired %s in %lluh%um with "
3880			    "%llu errors on %s");
3881		} else if (ps->pss_func == POOL_SCAN_RESILVER) {
3882			fmt = gettext("resilvered %s in %lluh%um with "
3883			    "%llu errors on %s");
3884		}
3885		/* LINTED */
3886		(void) printf(fmt, processed_buf,
3887		    (u_longlong_t)(minutes_taken / 60),
3888		    (uint_t)(minutes_taken % 60),
3889		    (u_longlong_t)ps->pss_errors,
3890		    ctime((time_t *)&end));
3891		return;
3892	} else if (ps->pss_state == DSS_CANCELED) {
3893		if (ps->pss_func == POOL_SCAN_SCRUB) {
3894			(void) printf(gettext("scrub canceled on %s"),
3895			    ctime(&end));
3896		} else if (ps->pss_func == POOL_SCAN_RESILVER) {
3897			(void) printf(gettext("resilver canceled on %s"),
3898			    ctime(&end));
3899		}
3900		return;
3901	}
3902
3903	assert(ps->pss_state == DSS_SCANNING);
3904
3905	/*
3906	 * Scan is in progress.
3907	 */
3908	if (ps->pss_func == POOL_SCAN_SCRUB) {
3909		(void) printf(gettext("scrub in progress since %s"),
3910		    ctime(&start));
3911	} else if (ps->pss_func == POOL_SCAN_RESILVER) {
3912		(void) printf(gettext("resilver in progress since %s"),
3913		    ctime(&start));
3914	}
3915
3916	examined = ps->pss_examined ? ps->pss_examined : 1;
3917	total = ps->pss_to_examine;
3918	fraction_done = (double)examined / total;
3919
3920	/* elapsed time for this pass */
3921	elapsed = time(NULL) - ps->pss_pass_start;
3922	elapsed = elapsed ? elapsed : 1;
3923	pass_exam = ps->pss_pass_exam ? ps->pss_pass_exam : 1;
3924	rate = pass_exam / elapsed;
3925	rate = rate ? rate : 1;
3926	mins_left = ((total - examined) / rate) / 60;
3927	hours_left = mins_left / 60;
3928
3929	zfs_nicenum(examined, examined_buf, sizeof (examined_buf));
3930	zfs_nicenum(total, total_buf, sizeof (total_buf));
3931	zfs_nicenum(rate, rate_buf, sizeof (rate_buf));
3932
3933	/*
3934	 * do not print estimated time if hours_left is more than 30 days
3935	 */
3936	(void) printf(gettext("        %s scanned out of %s at %s/s"),
3937	    examined_buf, total_buf, rate_buf);
3938	if (hours_left < (30 * 24)) {
3939		(void) printf(gettext(", %lluh%um to go\n"),
3940		    (u_longlong_t)hours_left, (uint_t)(mins_left % 60));
3941	} else {
3942		(void) printf(gettext(
3943		    ", (scan is slow, no estimated time)\n"));
3944	}
3945
3946	if (ps->pss_func == POOL_SCAN_RESILVER) {
3947		(void) printf(gettext("        %s resilvered, %.2f%% done\n"),
3948		    processed_buf, 100 * fraction_done);
3949	} else if (ps->pss_func == POOL_SCAN_SCRUB) {
3950		(void) printf(gettext("        %s repaired, %.2f%% done\n"),
3951		    processed_buf, 100 * fraction_done);
3952	}
3953}
3954
3955static void
3956print_error_log(zpool_handle_t *zhp)
3957{
3958	nvlist_t *nverrlist = NULL;
3959	nvpair_t *elem;
3960	char *pathname;
3961	size_t len = MAXPATHLEN * 2;
3962
3963	if (zpool_get_errlog(zhp, &nverrlist) != 0) {
3964		(void) printf("errors: List of errors unavailable "
3965		    "(insufficient privileges)\n");
3966		return;
3967	}
3968
3969	(void) printf("errors: Permanent errors have been "
3970	    "detected in the following files:\n\n");
3971
3972	pathname = safe_malloc(len);
3973	elem = NULL;
3974	while ((elem = nvlist_next_nvpair(nverrlist, elem)) != NULL) {
3975		nvlist_t *nv;
3976		uint64_t dsobj, obj;
3977
3978		verify(nvpair_value_nvlist(elem, &nv) == 0);
3979		verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_DATASET,
3980		    &dsobj) == 0);
3981		verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_OBJECT,
3982		    &obj) == 0);
3983		zpool_obj_to_path(zhp, dsobj, obj, pathname, len);
3984		(void) printf("%7s %s\n", "", pathname);
3985	}
3986	free(pathname);
3987	nvlist_free(nverrlist);
3988}
3989
3990static void
3991print_spares(zpool_handle_t *zhp, nvlist_t **spares, uint_t nspares,
3992    int namewidth)
3993{
3994	uint_t i;
3995	char *name;
3996
3997	if (nspares == 0)
3998		return;
3999
4000	(void) printf(gettext("\tspares\n"));
4001
4002	for (i = 0; i < nspares; i++) {
4003		name = zpool_vdev_name(g_zfs, zhp, spares[i], B_FALSE);
4004		print_status_config(zhp, name, spares[i],
4005		    namewidth, 2, B_TRUE);
4006		free(name);
4007	}
4008}
4009
4010static void
4011print_l2cache(zpool_handle_t *zhp, nvlist_t **l2cache, uint_t nl2cache,
4012    int namewidth)
4013{
4014	uint_t i;
4015	char *name;
4016
4017	if (nl2cache == 0)
4018		return;
4019
4020	(void) printf(gettext("\tcache\n"));
4021
4022	for (i = 0; i < nl2cache; i++) {
4023		name = zpool_vdev_name(g_zfs, zhp, l2cache[i], B_FALSE);
4024		print_status_config(zhp, name, l2cache[i],
4025		    namewidth, 2, B_FALSE);
4026		free(name);
4027	}
4028}
4029
4030static void
4031print_dedup_stats(nvlist_t *config)
4032{
4033	ddt_histogram_t *ddh;
4034	ddt_stat_t *dds;
4035	ddt_object_t *ddo;
4036	uint_t c;
4037
4038	/*
4039	 * If the pool was faulted then we may not have been able to
4040	 * obtain the config. Otherwise, if we have anything in the dedup
4041	 * table continue processing the stats.
4042	 */
4043	if (nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_OBJ_STATS,
4044	    (uint64_t **)&ddo, &c) != 0)
4045		return;
4046
4047	(void) printf("\n");
4048	(void) printf(gettext(" dedup: "));
4049	if (ddo->ddo_count == 0) {
4050		(void) printf(gettext("no DDT entries\n"));
4051		return;
4052	}
4053
4054	(void) printf("DDT entries %llu, size %llu on disk, %llu in core\n",
4055	    (u_longlong_t)ddo->ddo_count,
4056	    (u_longlong_t)ddo->ddo_dspace,
4057	    (u_longlong_t)ddo->ddo_mspace);
4058
4059	verify(nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_STATS,
4060	    (uint64_t **)&dds, &c) == 0);
4061	verify(nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_HISTOGRAM,
4062	    (uint64_t **)&ddh, &c) == 0);
4063	zpool_dump_ddt(dds, ddh);
4064}
4065
4066/*
4067 * Display a summary of pool status.  Displays a summary such as:
4068 *
4069 *        pool: tank
4070 *	status: DEGRADED
4071 *	reason: One or more devices ...
4072 *         see: http://illumos.org/msg/ZFS-xxxx-01
4073 *	config:
4074 *		mirror		DEGRADED
4075 *                c1t0d0	OK
4076 *                c2t0d0	UNAVAIL
4077 *
4078 * When given the '-v' option, we print out the complete config.  If the '-e'
4079 * option is specified, then we print out error rate information as well.
4080 */
4081int
4082status_callback(zpool_handle_t *zhp, void *data)
4083{
4084	status_cbdata_t *cbp = data;
4085	nvlist_t *config, *nvroot;
4086	char *msgid;
4087	int reason;
4088	const char *health;
4089	uint_t c;
4090	vdev_stat_t *vs;
4091
4092	config = zpool_get_config(zhp, NULL);
4093	reason = zpool_get_status(zhp, &msgid);
4094
4095	cbp->cb_count++;
4096
4097	/*
4098	 * If we were given 'zpool status -x', only report those pools with
4099	 * problems.
4100	 */
4101	if (cbp->cb_explain &&
4102	    (reason == ZPOOL_STATUS_OK ||
4103	    reason == ZPOOL_STATUS_VERSION_OLDER ||
4104	    reason == ZPOOL_STATUS_NON_NATIVE_ASHIFT ||
4105	    reason == ZPOOL_STATUS_FEAT_DISABLED)) {
4106		if (!cbp->cb_allpools) {
4107			(void) printf(gettext("pool '%s' is healthy\n"),
4108			    zpool_get_name(zhp));
4109			if (cbp->cb_first)
4110				cbp->cb_first = B_FALSE;
4111		}
4112		return (0);
4113	}
4114
4115	if (cbp->cb_first)
4116		cbp->cb_first = B_FALSE;
4117	else
4118		(void) printf("\n");
4119
4120	verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
4121	    &nvroot) == 0);
4122	verify(nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_VDEV_STATS,
4123	    (uint64_t **)&vs, &c) == 0);
4124	health = zpool_state_to_name(vs->vs_state, vs->vs_aux);
4125
4126	(void) printf(gettext("  pool: %s\n"), zpool_get_name(zhp));
4127	(void) printf(gettext(" state: %s\n"), health);
4128
4129	switch (reason) {
4130	case ZPOOL_STATUS_MISSING_DEV_R:
4131		(void) printf(gettext("status: One or more devices could not "
4132		    "be opened.  Sufficient replicas exist for\n\tthe pool to "
4133		    "continue functioning in a degraded state.\n"));
4134		(void) printf(gettext("action: Attach the missing device and "
4135		    "online it using 'zpool online'.\n"));
4136		break;
4137
4138	case ZPOOL_STATUS_MISSING_DEV_NR:
4139		(void) printf(gettext("status: One or more devices could not "
4140		    "be opened.  There are insufficient\n\treplicas for the "
4141		    "pool to continue functioning.\n"));
4142		(void) printf(gettext("action: Attach the missing device and "
4143		    "online it using 'zpool online'.\n"));
4144		break;
4145
4146	case ZPOOL_STATUS_CORRUPT_LABEL_R:
4147		(void) printf(gettext("status: One or more devices could not "
4148		    "be used because the label is missing or\n\tinvalid.  "
4149		    "Sufficient replicas exist for the pool to continue\n\t"
4150		    "functioning in a degraded state.\n"));
4151		(void) printf(gettext("action: Replace the device using "
4152		    "'zpool replace'.\n"));
4153		break;
4154
4155	case ZPOOL_STATUS_CORRUPT_LABEL_NR:
4156		(void) printf(gettext("status: One or more devices could not "
4157		    "be used because the label is missing \n\tor invalid.  "
4158		    "There are insufficient replicas for the pool to "
4159		    "continue\n\tfunctioning.\n"));
4160		zpool_explain_recover(zpool_get_handle(zhp),
4161		    zpool_get_name(zhp), reason, config);
4162		break;
4163
4164	case ZPOOL_STATUS_FAILING_DEV:
4165		(void) printf(gettext("status: One or more devices has "
4166		    "experienced an unrecoverable error.  An\n\tattempt was "
4167		    "made to correct the error.  Applications are "
4168		    "unaffected.\n"));
4169		(void) printf(gettext("action: Determine if the device needs "
4170		    "to be replaced, and clear the errors\n\tusing "
4171		    "'zpool clear' or replace the device with 'zpool "
4172		    "replace'.\n"));
4173		break;
4174
4175	case ZPOOL_STATUS_OFFLINE_DEV:
4176		(void) printf(gettext("status: One or more devices has "
4177		    "been taken offline by the administrator.\n\tSufficient "
4178		    "replicas exist for the pool to continue functioning in "
4179		    "a\n\tdegraded state.\n"));
4180		(void) printf(gettext("action: Online the device using "
4181		    "'zpool online' or replace the device with\n\t'zpool "
4182		    "replace'.\n"));
4183		break;
4184
4185	case ZPOOL_STATUS_REMOVED_DEV:
4186		(void) printf(gettext("status: One or more devices has "
4187		    "been removed by the administrator.\n\tSufficient "
4188		    "replicas exist for the pool to continue functioning in "
4189		    "a\n\tdegraded state.\n"));
4190		(void) printf(gettext("action: Online the device using "
4191		    "'zpool online' or replace the device with\n\t'zpool "
4192		    "replace'.\n"));
4193		break;
4194
4195	case ZPOOL_STATUS_RESILVERING:
4196		(void) printf(gettext("status: One or more devices is "
4197		    "currently being resilvered.  The pool will\n\tcontinue "
4198		    "to function, possibly in a degraded state.\n"));
4199		(void) printf(gettext("action: Wait for the resilver to "
4200		    "complete.\n"));
4201		break;
4202
4203	case ZPOOL_STATUS_CORRUPT_DATA:
4204		(void) printf(gettext("status: One or more devices has "
4205		    "experienced an error resulting in data\n\tcorruption.  "
4206		    "Applications may be affected.\n"));
4207		(void) printf(gettext("action: Restore the file in question "
4208		    "if possible.  Otherwise restore the\n\tentire pool from "
4209		    "backup.\n"));
4210		break;
4211
4212	case ZPOOL_STATUS_CORRUPT_POOL:
4213		(void) printf(gettext("status: The pool metadata is corrupted "
4214		    "and the pool cannot be opened.\n"));
4215		zpool_explain_recover(zpool_get_handle(zhp),
4216		    zpool_get_name(zhp), reason, config);
4217		break;
4218
4219	case ZPOOL_STATUS_VERSION_OLDER:
4220		(void) printf(gettext("status: The pool is formatted using a "
4221		    "legacy on-disk format.  The pool can\n\tstill be used, "
4222		    "but some features are unavailable.\n"));
4223		(void) printf(gettext("action: Upgrade the pool using 'zpool "
4224		    "upgrade'.  Once this is done, the\n\tpool will no longer "
4225		    "be accessible on software that does not support feature\n"
4226		    "\tflags.\n"));
4227		break;
4228
4229	case ZPOOL_STATUS_VERSION_NEWER:
4230		(void) printf(gettext("status: The pool has been upgraded to a "
4231		    "newer, incompatible on-disk version.\n\tThe pool cannot "
4232		    "be accessed on this system.\n"));
4233		(void) printf(gettext("action: Access the pool from a system "
4234		    "running more recent software, or\n\trestore the pool from "
4235		    "backup.\n"));
4236		break;
4237
4238	case ZPOOL_STATUS_FEAT_DISABLED:
4239		(void) printf(gettext("status: Some supported features are not "
4240		    "enabled on the pool. The pool can\n\tstill be used, but "
4241		    "some features are unavailable.\n"));
4242		(void) printf(gettext("action: Enable all features using "
4243		    "'zpool upgrade'. Once this is done,\n\tthe pool may no "
4244		    "longer be accessible by software that does not support\n\t"
4245		    "the features. See zpool-features(7) for details.\n"));
4246		break;
4247
4248	case ZPOOL_STATUS_UNSUP_FEAT_READ:
4249		(void) printf(gettext("status: The pool cannot be accessed on "
4250		    "this system because it uses the\n\tfollowing feature(s) "
4251		    "not supported on this system:\n"));
4252		zpool_print_unsup_feat(config);
4253		(void) printf("\n");
4254		(void) printf(gettext("action: Access the pool from a system "
4255		    "that supports the required feature(s),\n\tor restore the "
4256		    "pool from backup.\n"));
4257		break;
4258
4259	case ZPOOL_STATUS_UNSUP_FEAT_WRITE:
4260		(void) printf(gettext("status: The pool can only be accessed "
4261		    "in read-only mode on this system. It\n\tcannot be "
4262		    "accessed in read-write mode because it uses the "
4263		    "following\n\tfeature(s) not supported on this system:\n"));
4264		zpool_print_unsup_feat(config);
4265		(void) printf("\n");
4266		(void) printf(gettext("action: The pool cannot be accessed in "
4267		    "read-write mode. Import the pool with\n"
4268		    "\t\"-o readonly=on\", access the pool from a system that "
4269		    "supports the\n\trequired feature(s), or restore the "
4270		    "pool from backup.\n"));
4271		break;
4272
4273	case ZPOOL_STATUS_FAULTED_DEV_R:
4274		(void) printf(gettext("status: One or more devices are "
4275		    "faulted in response to persistent errors.\n\tSufficient "
4276		    "replicas exist for the pool to continue functioning "
4277		    "in a\n\tdegraded state.\n"));
4278		(void) printf(gettext("action: Replace the faulted device, "
4279		    "or use 'zpool clear' to mark the device\n\trepaired.\n"));
4280		break;
4281
4282	case ZPOOL_STATUS_FAULTED_DEV_NR:
4283		(void) printf(gettext("status: One or more devices are "
4284		    "faulted in response to persistent errors.  There are "
4285		    "insufficient replicas for the pool to\n\tcontinue "
4286		    "functioning.\n"));
4287		(void) printf(gettext("action: Destroy and re-create the pool "
4288		    "from a backup source.  Manually marking the device\n"
4289		    "\trepaired using 'zpool clear' may allow some data "
4290		    "to be recovered.\n"));
4291		break;
4292
4293	case ZPOOL_STATUS_IO_FAILURE_WAIT:
4294	case ZPOOL_STATUS_IO_FAILURE_CONTINUE:
4295		(void) printf(gettext("status: One or more devices are "
4296		    "faulted in response to IO failures.\n"));
4297		(void) printf(gettext("action: Make sure the affected devices "
4298		    "are connected, then run 'zpool clear'.\n"));
4299		break;
4300
4301	case ZPOOL_STATUS_BAD_LOG:
4302		(void) printf(gettext("status: An intent log record "
4303		    "could not be read.\n"
4304		    "\tWaiting for adminstrator intervention to fix the "
4305		    "faulted pool.\n"));
4306		(void) printf(gettext("action: Either restore the affected "
4307		    "device(s) and run 'zpool online',\n"
4308		    "\tor ignore the intent log records by running "
4309		    "'zpool clear'.\n"));
4310		break;
4311
4312	case ZPOOL_STATUS_NON_NATIVE_ASHIFT:
4313		(void) printf(gettext("status: One or more devices are "
4314		    "configured to use a non-native block size.\n"
4315		    "\tExpect reduced performance.\n"));
4316		(void) printf(gettext("action: Replace affected devices with "
4317		    "devices that support the\n\tconfigured block size, or "
4318		    "migrate data to a properly configured\n\tpool.\n"));
4319		break;
4320
4321	default:
4322		/*
4323		 * The remaining errors can't actually be generated, yet.
4324		 */
4325		assert(reason == ZPOOL_STATUS_OK);
4326	}
4327
4328	if (msgid != NULL)
4329		(void) printf(gettext("   see: http://illumos.org/msg/%s\n"),
4330		    msgid);
4331
4332	if (config != NULL) {
4333		int namewidth;
4334		uint64_t nerr;
4335		nvlist_t **spares, **l2cache;
4336		uint_t nspares, nl2cache;
4337		pool_scan_stat_t *ps = NULL;
4338
4339		(void) nvlist_lookup_uint64_array(nvroot,
4340		    ZPOOL_CONFIG_SCAN_STATS, (uint64_t **)&ps, &c);
4341		print_scan_status(ps);
4342
4343		namewidth = max_width(zhp, nvroot, 0, 0);
4344		if (namewidth < 10)
4345			namewidth = 10;
4346
4347		(void) printf(gettext("config:\n\n"));
4348		(void) printf(gettext("\t%-*s  %-8s %5s %5s %5s\n"), namewidth,
4349		    "NAME", "STATE", "READ", "WRITE", "CKSUM");
4350		print_status_config(zhp, zpool_get_name(zhp), nvroot,
4351		    namewidth, 0, B_FALSE);
4352
4353		if (num_logs(nvroot) > 0)
4354			print_logs(zhp, nvroot, namewidth, B_TRUE);
4355		if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_L2CACHE,
4356		    &l2cache, &nl2cache) == 0)
4357			print_l2cache(zhp, l2cache, nl2cache, namewidth);
4358
4359		if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES,
4360		    &spares, &nspares) == 0)
4361			print_spares(zhp, spares, nspares, namewidth);
4362
4363		if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_ERRCOUNT,
4364		    &nerr) == 0) {
4365			nvlist_t *nverrlist = NULL;
4366
4367			/*
4368			 * If the approximate error count is small, get a
4369			 * precise count by fetching the entire log and
4370			 * uniquifying the results.
4371			 */
4372			if (nerr > 0 && nerr < 100 && !cbp->cb_verbose &&
4373			    zpool_get_errlog(zhp, &nverrlist) == 0) {
4374				nvpair_t *elem;
4375
4376				elem = NULL;
4377				nerr = 0;
4378				while ((elem = nvlist_next_nvpair(nverrlist,
4379				    elem)) != NULL) {
4380					nerr++;
4381				}
4382			}
4383			nvlist_free(nverrlist);
4384
4385			(void) printf("\n");
4386
4387			if (nerr == 0)
4388				(void) printf(gettext("errors: No known data "
4389				    "errors\n"));
4390			else if (!cbp->cb_verbose)
4391				(void) printf(gettext("errors: %llu data "
4392				    "errors, use '-v' for a list\n"),
4393				    (u_longlong_t)nerr);
4394			else
4395				print_error_log(zhp);
4396		}
4397
4398		if (cbp->cb_dedup_stats)
4399			print_dedup_stats(config);
4400	} else {
4401		(void) printf(gettext("config: The configuration cannot be "
4402		    "determined.\n"));
4403	}
4404
4405	return (0);
4406}
4407
4408/*
4409 * zpool status [-vx] [-T d|u] [pool] ... [interval [count]]
4410 *
4411 *	-v	Display complete error logs
4412 *	-x	Display only pools with potential problems
4413 *	-D	Display dedup status (undocumented)
4414 *	-T	Display a timestamp in date(1) or Unix format
4415 *
4416 * Describes the health status of all pools or some subset.
4417 */
4418int
4419zpool_do_status(int argc, char **argv)
4420{
4421	int c;
4422	int ret;
4423	unsigned long interval = 0, count = 0;
4424	status_cbdata_t cb = { 0 };
4425
4426	/* check options */
4427	while ((c = getopt(argc, argv, "vxDT:")) != -1) {
4428		switch (c) {
4429		case 'v':
4430			cb.cb_verbose = B_TRUE;
4431			break;
4432		case 'x':
4433			cb.cb_explain = B_TRUE;
4434			break;
4435		case 'D':
4436			cb.cb_dedup_stats = B_TRUE;
4437			break;
4438		case 'T':
4439			get_timestamp_arg(*optarg);
4440			break;
4441		case '?':
4442			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
4443			    optopt);
4444			usage(B_FALSE);
4445		}
4446	}
4447
4448	argc -= optind;
4449	argv += optind;
4450
4451	get_interval_count(&argc, argv, &interval, &count);
4452
4453	if (argc == 0)
4454		cb.cb_allpools = B_TRUE;
4455
4456	cb.cb_first = B_TRUE;
4457
4458	for (;;) {
4459		if (timestamp_fmt != NODATE)
4460			print_timestamp(timestamp_fmt);
4461
4462		ret = for_each_pool(argc, argv, B_TRUE, NULL,
4463		    status_callback, &cb);
4464
4465		if (argc == 0 && cb.cb_count == 0)
4466			(void) printf(gettext("no pools available\n"));
4467		else if (cb.cb_explain && cb.cb_first && cb.cb_allpools)
4468			(void) printf(gettext("all pools are healthy\n"));
4469
4470		if (ret != 0)
4471			return (ret);
4472
4473		if (interval == 0)
4474			break;
4475
4476		if (count != 0 && --count == 0)
4477			break;
4478
4479		(void) sleep(interval);
4480	}
4481
4482	return (0);
4483}
4484
4485typedef struct upgrade_cbdata {
4486	int	cb_first;
4487	char	cb_poolname[ZPOOL_MAXNAMELEN];
4488	int	cb_argc;
4489	uint64_t cb_version;
4490	char	**cb_argv;
4491} upgrade_cbdata_t;
4492
4493#ifdef __FreeBSD__
4494static int
4495is_root_pool(zpool_handle_t *zhp)
4496{
4497	static struct statfs sfs;
4498	static char *poolname = NULL;
4499	static boolean_t stated = B_FALSE;
4500	char *slash;
4501
4502	if (!stated) {
4503		stated = B_TRUE;
4504		if (statfs("/", &sfs) == -1) {
4505			(void) fprintf(stderr,
4506			    "Unable to stat root file system: %s.\n",
4507			    strerror(errno));
4508			return (0);
4509		}
4510		if (strcmp(sfs.f_fstypename, "zfs") != 0)
4511			return (0);
4512		poolname = sfs.f_mntfromname;
4513		if ((slash = strchr(poolname, '/')) != NULL)
4514			*slash = '\0';
4515	}
4516	return (poolname != NULL && strcmp(poolname, zpool_get_name(zhp)) == 0);
4517}
4518
4519static void
4520root_pool_upgrade_check(zpool_handle_t *zhp, char *poolname, int size) {
4521
4522	if (poolname[0] == '\0' && is_root_pool(zhp))
4523		(void) strlcpy(poolname, zpool_get_name(zhp), size);
4524}
4525#endif	/* FreeBSD */
4526
4527static int
4528upgrade_version(zpool_handle_t *zhp, uint64_t version)
4529{
4530	int ret;
4531	nvlist_t *config;
4532	uint64_t oldversion;
4533
4534	config = zpool_get_config(zhp, NULL);
4535	verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
4536	    &oldversion) == 0);
4537
4538	assert(SPA_VERSION_IS_SUPPORTED(oldversion));
4539	assert(oldversion < version);
4540
4541	ret = zpool_upgrade(zhp, version);
4542	if (ret != 0)
4543		return (ret);
4544
4545	if (version >= SPA_VERSION_FEATURES) {
4546		(void) printf(gettext("Successfully upgraded "
4547		    "'%s' from version %llu to feature flags.\n"),
4548		    zpool_get_name(zhp), oldversion);
4549	} else {
4550		(void) printf(gettext("Successfully upgraded "
4551		    "'%s' from version %llu to version %llu.\n"),
4552		    zpool_get_name(zhp), oldversion, version);
4553	}
4554
4555	return (0);
4556}
4557
4558static int
4559upgrade_enable_all(zpool_handle_t *zhp, int *countp)
4560{
4561	int i, ret, count;
4562	boolean_t firstff = B_TRUE;
4563	nvlist_t *enabled = zpool_get_features(zhp);
4564
4565	count = 0;
4566	for (i = 0; i < SPA_FEATURES; i++) {
4567		const char *fname = spa_feature_table[i].fi_uname;
4568		const char *fguid = spa_feature_table[i].fi_guid;
4569		if (!nvlist_exists(enabled, fguid)) {
4570			char *propname;
4571			verify(-1 != asprintf(&propname, "feature@%s", fname));
4572			ret = zpool_set_prop(zhp, propname,
4573			    ZFS_FEATURE_ENABLED);
4574			if (ret != 0) {
4575				free(propname);
4576				return (ret);
4577			}
4578			count++;
4579
4580			if (firstff) {
4581				(void) printf(gettext("Enabled the "
4582				    "following features on '%s':\n"),
4583				    zpool_get_name(zhp));
4584				firstff = B_FALSE;
4585			}
4586			(void) printf(gettext("  %s\n"), fname);
4587			free(propname);
4588		}
4589	}
4590
4591	if (countp != NULL)
4592		*countp = count;
4593	return (0);
4594}
4595
4596static int
4597upgrade_cb(zpool_handle_t *zhp, void *arg)
4598{
4599	upgrade_cbdata_t *cbp = arg;
4600	nvlist_t *config;
4601	uint64_t version;
4602	boolean_t printnl = B_FALSE;
4603	int ret;
4604
4605	config = zpool_get_config(zhp, NULL);
4606	verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
4607	    &version) == 0);
4608
4609	assert(SPA_VERSION_IS_SUPPORTED(version));
4610
4611	if (version < cbp->cb_version) {
4612		cbp->cb_first = B_FALSE;
4613		ret = upgrade_version(zhp, cbp->cb_version);
4614		if (ret != 0)
4615			return (ret);
4616#ifdef __FreeBSD__
4617		root_pool_upgrade_check(zhp, cbp->cb_poolname,
4618		    sizeof(cbp->cb_poolname));
4619#endif	/* ___FreeBSD__ */
4620		printnl = B_TRUE;
4621
4622#ifdef illumos
4623		/*
4624		 * If they did "zpool upgrade -a", then we could
4625		 * be doing ioctls to different pools.  We need
4626		 * to log this history once to each pool, and bypass
4627		 * the normal history logging that happens in main().
4628		 */
4629		(void) zpool_log_history(g_zfs, history_str);
4630		log_history = B_FALSE;
4631#endif
4632	}
4633
4634	if (cbp->cb_version >= SPA_VERSION_FEATURES) {
4635		int count;
4636		ret = upgrade_enable_all(zhp, &count);
4637		if (ret != 0)
4638			return (ret);
4639
4640		if (count > 0) {
4641			cbp->cb_first = B_FALSE;
4642			printnl = B_TRUE;
4643			/*
4644			 * If they did "zpool upgrade -a", then we could
4645			 * be doing ioctls to different pools.  We need
4646			 * to log this history once to each pool, and bypass
4647			 * the normal history logging that happens in main().
4648			 */
4649			(void) zpool_log_history(g_zfs, history_str);
4650			log_history = B_FALSE;
4651		}
4652	}
4653
4654	if (printnl) {
4655		(void) printf(gettext("\n"));
4656	}
4657
4658	return (0);
4659}
4660
4661static int
4662upgrade_list_older_cb(zpool_handle_t *zhp, void *arg)
4663{
4664	upgrade_cbdata_t *cbp = arg;
4665	nvlist_t *config;
4666	uint64_t version;
4667
4668	config = zpool_get_config(zhp, NULL);
4669	verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
4670	    &version) == 0);
4671
4672	assert(SPA_VERSION_IS_SUPPORTED(version));
4673
4674	if (version < SPA_VERSION_FEATURES) {
4675		if (cbp->cb_first) {
4676			(void) printf(gettext("The following pools are "
4677			    "formatted with legacy version numbers and can\n"
4678			    "be upgraded to use feature flags.  After "
4679			    "being upgraded, these pools\nwill no "
4680			    "longer be accessible by software that does not "
4681			    "support feature\nflags.\n\n"));
4682			(void) printf(gettext("VER  POOL\n"));
4683			(void) printf(gettext("---  ------------\n"));
4684			cbp->cb_first = B_FALSE;
4685		}
4686
4687		(void) printf("%2llu   %s\n", (u_longlong_t)version,
4688		    zpool_get_name(zhp));
4689	}
4690
4691	return (0);
4692}
4693
4694static int
4695upgrade_list_disabled_cb(zpool_handle_t *zhp, void *arg)
4696{
4697	upgrade_cbdata_t *cbp = arg;
4698	nvlist_t *config;
4699	uint64_t version;
4700
4701	config = zpool_get_config(zhp, NULL);
4702	verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
4703	    &version) == 0);
4704
4705	if (version >= SPA_VERSION_FEATURES) {
4706		int i;
4707		boolean_t poolfirst = B_TRUE;
4708		nvlist_t *enabled = zpool_get_features(zhp);
4709
4710		for (i = 0; i < SPA_FEATURES; i++) {
4711			const char *fguid = spa_feature_table[i].fi_guid;
4712			const char *fname = spa_feature_table[i].fi_uname;
4713			if (!nvlist_exists(enabled, fguid)) {
4714				if (cbp->cb_first) {
4715					(void) printf(gettext("\nSome "
4716					    "supported features are not "
4717					    "enabled on the following pools. "
4718					    "Once a\nfeature is enabled the "
4719					    "pool may become incompatible with "
4720					    "software\nthat does not support "
4721					    "the feature. See "
4722					    "zpool-features(7) for "
4723					    "details.\n\n"));
4724					(void) printf(gettext("POOL  "
4725					    "FEATURE\n"));
4726					(void) printf(gettext("------"
4727					    "---------\n"));
4728					cbp->cb_first = B_FALSE;
4729				}
4730
4731				if (poolfirst) {
4732					(void) printf(gettext("%s\n"),
4733					    zpool_get_name(zhp));
4734					poolfirst = B_FALSE;
4735				}
4736
4737				(void) printf(gettext("      %s\n"), fname);
4738			}
4739		}
4740	}
4741
4742	return (0);
4743}
4744
4745/* ARGSUSED */
4746static int
4747upgrade_one(zpool_handle_t *zhp, void *data)
4748{
4749	boolean_t printnl = B_FALSE;
4750	upgrade_cbdata_t *cbp = data;
4751	uint64_t cur_version;
4752	int ret;
4753
4754	if (strcmp("log", zpool_get_name(zhp)) == 0) {
4755		(void) printf(gettext("'log' is now a reserved word\n"
4756		    "Pool 'log' must be renamed using export and import"
4757		    " to upgrade.\n"));
4758		return (1);
4759	}
4760
4761	cur_version = zpool_get_prop_int(zhp, ZPOOL_PROP_VERSION, NULL);
4762	if (cur_version > cbp->cb_version) {
4763		(void) printf(gettext("Pool '%s' is already formatted "
4764		    "using more current version '%llu'.\n\n"),
4765		    zpool_get_name(zhp), cur_version);
4766		return (0);
4767	}
4768
4769	if (cbp->cb_version != SPA_VERSION && cur_version == cbp->cb_version) {
4770		(void) printf(gettext("Pool '%s' is already formatted "
4771		    "using version %llu.\n\n"), zpool_get_name(zhp),
4772		    cbp->cb_version);
4773		return (0);
4774	}
4775
4776	if (cur_version != cbp->cb_version) {
4777		printnl = B_TRUE;
4778		ret = upgrade_version(zhp, cbp->cb_version);
4779		if (ret != 0)
4780			return (ret);
4781#ifdef __FreeBSD__
4782		root_pool_upgrade_check(zhp, cbp->cb_poolname,
4783		    sizeof(cbp->cb_poolname));
4784#endif	/* ___FreeBSD__ */
4785	}
4786
4787	if (cbp->cb_version >= SPA_VERSION_FEATURES) {
4788		int count = 0;
4789		ret = upgrade_enable_all(zhp, &count);
4790		if (ret != 0)
4791			return (ret);
4792
4793		if (count != 0) {
4794			printnl = B_TRUE;
4795#ifdef __FreeBSD__
4796			root_pool_upgrade_check(zhp, cbp->cb_poolname,
4797			    sizeof(cbp->cb_poolname));
4798#endif	/* __FreeBSD __*/
4799		} else if (cur_version == SPA_VERSION) {
4800			(void) printf(gettext("Pool '%s' already has all "
4801			    "supported features enabled.\n"),
4802			    zpool_get_name(zhp));
4803		}
4804	}
4805
4806	if (printnl) {
4807		(void) printf(gettext("\n"));
4808	}
4809
4810	return (0);
4811}
4812
4813/*
4814 * zpool upgrade
4815 * zpool upgrade -v
4816 * zpool upgrade [-V version] <-a | pool ...>
4817 *
4818 * With no arguments, display downrev'd ZFS pool available for upgrade.
4819 * Individual pools can be upgraded by specifying the pool, and '-a' will
4820 * upgrade all pools.
4821 */
4822int
4823zpool_do_upgrade(int argc, char **argv)
4824{
4825	int c;
4826	upgrade_cbdata_t cb = { 0 };
4827	int ret = 0;
4828	boolean_t showversions = B_FALSE;
4829	boolean_t upgradeall = B_FALSE;
4830	char *end;
4831
4832
4833	/* check options */
4834	while ((c = getopt(argc, argv, ":avV:")) != -1) {
4835		switch (c) {
4836		case 'a':
4837			upgradeall = B_TRUE;
4838			break;
4839		case 'v':
4840			showversions = B_TRUE;
4841			break;
4842		case 'V':
4843			cb.cb_version = strtoll(optarg, &end, 10);
4844			if (*end != '\0' ||
4845			    !SPA_VERSION_IS_SUPPORTED(cb.cb_version)) {
4846				(void) fprintf(stderr,
4847				    gettext("invalid version '%s'\n"), optarg);
4848				usage(B_FALSE);
4849			}
4850			break;
4851		case ':':
4852			(void) fprintf(stderr, gettext("missing argument for "
4853			    "'%c' option\n"), optopt);
4854			usage(B_FALSE);
4855			break;
4856		case '?':
4857			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
4858			    optopt);
4859			usage(B_FALSE);
4860		}
4861	}
4862
4863	cb.cb_argc = argc;
4864	cb.cb_argv = argv;
4865	argc -= optind;
4866	argv += optind;
4867
4868	if (cb.cb_version == 0) {
4869		cb.cb_version = SPA_VERSION;
4870	} else if (!upgradeall && argc == 0) {
4871		(void) fprintf(stderr, gettext("-V option is "
4872		    "incompatible with other arguments\n"));
4873		usage(B_FALSE);
4874	}
4875
4876	if (showversions) {
4877		if (upgradeall || argc != 0) {
4878			(void) fprintf(stderr, gettext("-v option is "
4879			    "incompatible with other arguments\n"));
4880			usage(B_FALSE);
4881		}
4882	} else if (upgradeall) {
4883		if (argc != 0) {
4884			(void) fprintf(stderr, gettext("-a option should not "
4885			    "be used along with a pool name\n"));
4886			usage(B_FALSE);
4887		}
4888	}
4889
4890	(void) printf(gettext("This system supports ZFS pool feature "
4891	    "flags.\n\n"));
4892	if (showversions) {
4893		int i;
4894
4895		(void) printf(gettext("The following features are "
4896		    "supported:\n\n"));
4897		(void) printf(gettext("FEAT DESCRIPTION\n"));
4898		(void) printf("----------------------------------------------"
4899		    "---------------\n");
4900		for (i = 0; i < SPA_FEATURES; i++) {
4901			zfeature_info_t *fi = &spa_feature_table[i];
4902			const char *ro = fi->fi_can_readonly ?
4903			    " (read-only compatible)" : "";
4904
4905			(void) printf("%-37s%s\n", fi->fi_uname, ro);
4906			(void) printf("     %s\n", fi->fi_desc);
4907		}
4908		(void) printf("\n");
4909
4910		(void) printf(gettext("The following legacy versions are also "
4911		    "supported:\n\n"));
4912		(void) printf(gettext("VER  DESCRIPTION\n"));
4913		(void) printf("---  -----------------------------------------"
4914		    "---------------\n");
4915		(void) printf(gettext(" 1   Initial ZFS version\n"));
4916		(void) printf(gettext(" 2   Ditto blocks "
4917		    "(replicated metadata)\n"));
4918		(void) printf(gettext(" 3   Hot spares and double parity "
4919		    "RAID-Z\n"));
4920		(void) printf(gettext(" 4   zpool history\n"));
4921		(void) printf(gettext(" 5   Compression using the gzip "
4922		    "algorithm\n"));
4923		(void) printf(gettext(" 6   bootfs pool property\n"));
4924		(void) printf(gettext(" 7   Separate intent log devices\n"));
4925		(void) printf(gettext(" 8   Delegated administration\n"));
4926		(void) printf(gettext(" 9   refquota and refreservation "
4927		    "properties\n"));
4928		(void) printf(gettext(" 10  Cache devices\n"));
4929		(void) printf(gettext(" 11  Improved scrub performance\n"));
4930		(void) printf(gettext(" 12  Snapshot properties\n"));
4931		(void) printf(gettext(" 13  snapused property\n"));
4932		(void) printf(gettext(" 14  passthrough-x aclinherit\n"));
4933		(void) printf(gettext(" 15  user/group space accounting\n"));
4934		(void) printf(gettext(" 16  stmf property support\n"));
4935		(void) printf(gettext(" 17  Triple-parity RAID-Z\n"));
4936		(void) printf(gettext(" 18  Snapshot user holds\n"));
4937		(void) printf(gettext(" 19  Log device removal\n"));
4938		(void) printf(gettext(" 20  Compression using zle "
4939		    "(zero-length encoding)\n"));
4940		(void) printf(gettext(" 21  Deduplication\n"));
4941		(void) printf(gettext(" 22  Received properties\n"));
4942		(void) printf(gettext(" 23  Slim ZIL\n"));
4943		(void) printf(gettext(" 24  System attributes\n"));
4944		(void) printf(gettext(" 25  Improved scrub stats\n"));
4945		(void) printf(gettext(" 26  Improved snapshot deletion "
4946		    "performance\n"));
4947		(void) printf(gettext(" 27  Improved snapshot creation "
4948		    "performance\n"));
4949		(void) printf(gettext(" 28  Multiple vdev replacements\n"));
4950		(void) printf(gettext("\nFor more information on a particular "
4951		    "version, including supported releases,\n"));
4952		(void) printf(gettext("see the ZFS Administration Guide.\n\n"));
4953	} else if (argc == 0 && upgradeall) {
4954		cb.cb_first = B_TRUE;
4955		ret = zpool_iter(g_zfs, upgrade_cb, &cb);
4956		if (ret == 0 && cb.cb_first) {
4957			if (cb.cb_version == SPA_VERSION) {
4958				(void) printf(gettext("All pools are already "
4959				    "formatted using feature flags.\n\n"));
4960				(void) printf(gettext("Every feature flags "
4961				    "pool already has all supported features "
4962				    "enabled.\n"));
4963			} else {
4964				(void) printf(gettext("All pools are already "
4965				    "formatted with version %llu or higher.\n"),
4966				    cb.cb_version);
4967			}
4968		}
4969	} else if (argc == 0) {
4970		cb.cb_first = B_TRUE;
4971		ret = zpool_iter(g_zfs, upgrade_list_older_cb, &cb);
4972		assert(ret == 0);
4973
4974		if (cb.cb_first) {
4975			(void) printf(gettext("All pools are formatted "
4976			    "using feature flags.\n\n"));
4977		} else {
4978			(void) printf(gettext("\nUse 'zpool upgrade -v' "
4979			    "for a list of available legacy versions.\n"));
4980		}
4981
4982		cb.cb_first = B_TRUE;
4983		ret = zpool_iter(g_zfs, upgrade_list_disabled_cb, &cb);
4984		assert(ret == 0);
4985
4986		if (cb.cb_first) {
4987			(void) printf(gettext("Every feature flags pool has "
4988			    "all supported features enabled.\n"));
4989		} else {
4990			(void) printf(gettext("\n"));
4991		}
4992	} else {
4993		ret = for_each_pool(argc, argv, B_FALSE, NULL,
4994		    upgrade_one, &cb);
4995	}
4996
4997	if (cb.cb_poolname[0] != '\0') {
4998		(void) printf(
4999		    "If you boot from pool '%s', don't forget to update boot code.\n"
5000		    "Assuming you use GPT partitioning and da0 is your boot disk\n"
5001		    "the following command will do it:\n"
5002		    "\n"
5003		    "\tgpart bootcode -b /boot/pmbr -p /boot/gptzfsboot -i 1 da0\n\n",
5004		    cb.cb_poolname);
5005	}
5006
5007	return (ret);
5008}
5009
5010typedef struct hist_cbdata {
5011	boolean_t first;
5012	boolean_t longfmt;
5013	boolean_t internal;
5014} hist_cbdata_t;
5015
5016/*
5017 * Print out the command history for a specific pool.
5018 */
5019static int
5020get_history_one(zpool_handle_t *zhp, void *data)
5021{
5022	nvlist_t *nvhis;
5023	nvlist_t **records;
5024	uint_t numrecords;
5025	int ret, i;
5026	hist_cbdata_t *cb = (hist_cbdata_t *)data;
5027
5028	cb->first = B_FALSE;
5029
5030	(void) printf(gettext("History for '%s':\n"), zpool_get_name(zhp));
5031
5032	if ((ret = zpool_get_history(zhp, &nvhis)) != 0)
5033		return (ret);
5034
5035	verify(nvlist_lookup_nvlist_array(nvhis, ZPOOL_HIST_RECORD,
5036	    &records, &numrecords) == 0);
5037	for (i = 0; i < numrecords; i++) {
5038		nvlist_t *rec = records[i];
5039		char tbuf[30] = "";
5040
5041		if (nvlist_exists(rec, ZPOOL_HIST_TIME)) {
5042			time_t tsec;
5043			struct tm t;
5044
5045			tsec = fnvlist_lookup_uint64(records[i],
5046			    ZPOOL_HIST_TIME);
5047			(void) localtime_r(&tsec, &t);
5048			(void) strftime(tbuf, sizeof (tbuf), "%F.%T", &t);
5049		}
5050
5051		if (nvlist_exists(rec, ZPOOL_HIST_CMD)) {
5052			(void) printf("%s %s", tbuf,
5053			    fnvlist_lookup_string(rec, ZPOOL_HIST_CMD));
5054		} else if (nvlist_exists(rec, ZPOOL_HIST_INT_EVENT)) {
5055			int ievent =
5056			    fnvlist_lookup_uint64(rec, ZPOOL_HIST_INT_EVENT);
5057			if (!cb->internal)
5058				continue;
5059			if (ievent >= ZFS_NUM_LEGACY_HISTORY_EVENTS) {
5060				(void) printf("%s unrecognized record:\n",
5061				    tbuf);
5062				dump_nvlist(rec, 4);
5063				continue;
5064			}
5065			(void) printf("%s [internal %s txg:%lld] %s", tbuf,
5066			    zfs_history_event_names[ievent],
5067			    fnvlist_lookup_uint64(rec, ZPOOL_HIST_TXG),
5068			    fnvlist_lookup_string(rec, ZPOOL_HIST_INT_STR));
5069		} else if (nvlist_exists(rec, ZPOOL_HIST_INT_NAME)) {
5070			if (!cb->internal)
5071				continue;
5072			(void) printf("%s [txg:%lld] %s", tbuf,
5073			    fnvlist_lookup_uint64(rec, ZPOOL_HIST_TXG),
5074			    fnvlist_lookup_string(rec, ZPOOL_HIST_INT_NAME));
5075			if (nvlist_exists(rec, ZPOOL_HIST_DSNAME)) {
5076				(void) printf(" %s (%llu)",
5077				    fnvlist_lookup_string(rec,
5078				    ZPOOL_HIST_DSNAME),
5079				    fnvlist_lookup_uint64(rec,
5080				    ZPOOL_HIST_DSID));
5081			}
5082			(void) printf(" %s", fnvlist_lookup_string(rec,
5083			    ZPOOL_HIST_INT_STR));
5084		} else if (nvlist_exists(rec, ZPOOL_HIST_IOCTL)) {
5085			if (!cb->internal)
5086				continue;
5087			(void) printf("%s ioctl %s\n", tbuf,
5088			    fnvlist_lookup_string(rec, ZPOOL_HIST_IOCTL));
5089			if (nvlist_exists(rec, ZPOOL_HIST_INPUT_NVL)) {
5090				(void) printf("    input:\n");
5091				dump_nvlist(fnvlist_lookup_nvlist(rec,
5092				    ZPOOL_HIST_INPUT_NVL), 8);
5093			}
5094			if (nvlist_exists(rec, ZPOOL_HIST_OUTPUT_NVL)) {
5095				(void) printf("    output:\n");
5096				dump_nvlist(fnvlist_lookup_nvlist(rec,
5097				    ZPOOL_HIST_OUTPUT_NVL), 8);
5098			}
5099		} else {
5100			if (!cb->internal)
5101				continue;
5102			(void) printf("%s unrecognized record:\n", tbuf);
5103			dump_nvlist(rec, 4);
5104		}
5105
5106		if (!cb->longfmt) {
5107			(void) printf("\n");
5108			continue;
5109		}
5110		(void) printf(" [");
5111		if (nvlist_exists(rec, ZPOOL_HIST_WHO)) {
5112			uid_t who = fnvlist_lookup_uint64(rec, ZPOOL_HIST_WHO);
5113			struct passwd *pwd = getpwuid(who);
5114			(void) printf("user %d ", (int)who);
5115			if (pwd != NULL)
5116				(void) printf("(%s) ", pwd->pw_name);
5117		}
5118		if (nvlist_exists(rec, ZPOOL_HIST_HOST)) {
5119			(void) printf("on %s",
5120			    fnvlist_lookup_string(rec, ZPOOL_HIST_HOST));
5121		}
5122		if (nvlist_exists(rec, ZPOOL_HIST_ZONE)) {
5123			(void) printf(":%s",
5124			    fnvlist_lookup_string(rec, ZPOOL_HIST_ZONE));
5125		}
5126		(void) printf("]");
5127		(void) printf("\n");
5128	}
5129	(void) printf("\n");
5130	nvlist_free(nvhis);
5131
5132	return (ret);
5133}
5134
5135/*
5136 * zpool history <pool>
5137 *
5138 * Displays the history of commands that modified pools.
5139 */
5140int
5141zpool_do_history(int argc, char **argv)
5142{
5143	hist_cbdata_t cbdata = { 0 };
5144	int ret;
5145	int c;
5146
5147	cbdata.first = B_TRUE;
5148	/* check options */
5149	while ((c = getopt(argc, argv, "li")) != -1) {
5150		switch (c) {
5151		case 'l':
5152			cbdata.longfmt = B_TRUE;
5153			break;
5154		case 'i':
5155			cbdata.internal = B_TRUE;
5156			break;
5157		case '?':
5158			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
5159			    optopt);
5160			usage(B_FALSE);
5161		}
5162	}
5163	argc -= optind;
5164	argv += optind;
5165
5166	ret = for_each_pool(argc, argv, B_FALSE,  NULL, get_history_one,
5167	    &cbdata);
5168
5169	if (argc == 0 && cbdata.first == B_TRUE) {
5170		(void) printf(gettext("no pools available\n"));
5171		return (0);
5172	}
5173
5174	return (ret);
5175}
5176
5177static int
5178get_callback(zpool_handle_t *zhp, void *data)
5179{
5180	zprop_get_cbdata_t *cbp = (zprop_get_cbdata_t *)data;
5181	char value[MAXNAMELEN];
5182	zprop_source_t srctype;
5183	zprop_list_t *pl;
5184
5185	for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
5186
5187		/*
5188		 * Skip the special fake placeholder. This will also skip
5189		 * over the name property when 'all' is specified.
5190		 */
5191		if (pl->pl_prop == ZPOOL_PROP_NAME &&
5192		    pl == cbp->cb_proplist)
5193			continue;
5194
5195		if (pl->pl_prop == ZPROP_INVAL &&
5196		    (zpool_prop_feature(pl->pl_user_prop) ||
5197		    zpool_prop_unsupported(pl->pl_user_prop))) {
5198			srctype = ZPROP_SRC_LOCAL;
5199
5200			if (zpool_prop_get_feature(zhp, pl->pl_user_prop,
5201			    value, sizeof (value)) == 0) {
5202				zprop_print_one_property(zpool_get_name(zhp),
5203				    cbp, pl->pl_user_prop, value, srctype,
5204				    NULL, NULL);
5205			}
5206		} else {
5207			if (zpool_get_prop(zhp, pl->pl_prop, value,
5208			    sizeof (value), &srctype, cbp->cb_literal) != 0)
5209				continue;
5210
5211			zprop_print_one_property(zpool_get_name(zhp), cbp,
5212			    zpool_prop_to_name(pl->pl_prop), value, srctype,
5213			    NULL, NULL);
5214		}
5215	}
5216	return (0);
5217}
5218
5219/*
5220 * zpool get [-Hp] [-o "all" | field[,...]] <"all" | property[,...]> <pool> ...
5221 *
5222 *	-H	Scripted mode.  Don't display headers, and separate properties
5223 *		by a single tab.
5224 *	-o	List of columns to display.  Defaults to
5225 *		"name,property,value,source".
5226 * 	-p	Diplay values in parsable (exact) format.
5227 *
5228 * Get properties of pools in the system. Output space statistics
5229 * for each one as well as other attributes.
5230 */
5231int
5232zpool_do_get(int argc, char **argv)
5233{
5234	zprop_get_cbdata_t cb = { 0 };
5235	zprop_list_t fake_name = { 0 };
5236	int ret;
5237	int c, i;
5238	char *value;
5239
5240	cb.cb_first = B_TRUE;
5241
5242	/*
5243	 * Set up default columns and sources.
5244	 */
5245	cb.cb_sources = ZPROP_SRC_ALL;
5246	cb.cb_columns[0] = GET_COL_NAME;
5247	cb.cb_columns[1] = GET_COL_PROPERTY;
5248	cb.cb_columns[2] = GET_COL_VALUE;
5249	cb.cb_columns[3] = GET_COL_SOURCE;
5250	cb.cb_type = ZFS_TYPE_POOL;
5251
5252	/* check options */
5253	while ((c = getopt(argc, argv, ":Hpo:")) != -1) {
5254		switch (c) {
5255		case 'p':
5256			cb.cb_literal = B_TRUE;
5257			break;
5258		case 'H':
5259			cb.cb_scripted = B_TRUE;
5260			break;
5261		case 'o':
5262			bzero(&cb.cb_columns, sizeof (cb.cb_columns));
5263			i = 0;
5264			while (*optarg != '\0') {
5265				static char *col_subopts[] =
5266				{ "name", "property", "value", "source",
5267				"all", NULL };
5268
5269				if (i == ZFS_GET_NCOLS) {
5270					(void) fprintf(stderr, gettext("too "
5271					"many fields given to -o "
5272					"option\n"));
5273					usage(B_FALSE);
5274				}
5275
5276				switch (getsubopt(&optarg, col_subopts,
5277				    &value)) {
5278				case 0:
5279					cb.cb_columns[i++] = GET_COL_NAME;
5280					break;
5281				case 1:
5282					cb.cb_columns[i++] = GET_COL_PROPERTY;
5283					break;
5284				case 2:
5285					cb.cb_columns[i++] = GET_COL_VALUE;
5286					break;
5287				case 3:
5288					cb.cb_columns[i++] = GET_COL_SOURCE;
5289					break;
5290				case 4:
5291					if (i > 0) {
5292						(void) fprintf(stderr,
5293						    gettext("\"all\" conflicts "
5294						    "with specific fields "
5295						    "given to -o option\n"));
5296						usage(B_FALSE);
5297					}
5298					cb.cb_columns[0] = GET_COL_NAME;
5299					cb.cb_columns[1] = GET_COL_PROPERTY;
5300					cb.cb_columns[2] = GET_COL_VALUE;
5301					cb.cb_columns[3] = GET_COL_SOURCE;
5302					i = ZFS_GET_NCOLS;
5303					break;
5304				default:
5305					(void) fprintf(stderr,
5306					    gettext("invalid column name "
5307					    "'%s'\n"), value);
5308					usage(B_FALSE);
5309				}
5310			}
5311			break;
5312		case '?':
5313			(void) fprintf(stderr, gettext("invalid option '%c'\n"),
5314			    optopt);
5315			usage(B_FALSE);
5316		}
5317	}
5318
5319	argc -= optind;
5320	argv += optind;
5321
5322	if (argc < 1) {
5323		(void) fprintf(stderr, gettext("missing property "
5324		    "argument\n"));
5325		usage(B_FALSE);
5326	}
5327
5328	if (zprop_get_list(g_zfs, argv[0], &cb.cb_proplist,
5329	    ZFS_TYPE_POOL) != 0)
5330		usage(B_FALSE);
5331
5332	argc--;
5333	argv++;
5334
5335	if (cb.cb_proplist != NULL) {
5336		fake_name.pl_prop = ZPOOL_PROP_NAME;
5337		fake_name.pl_width = strlen(gettext("NAME"));
5338		fake_name.pl_next = cb.cb_proplist;
5339		cb.cb_proplist = &fake_name;
5340	}
5341
5342	ret = for_each_pool(argc, argv, B_TRUE, &cb.cb_proplist,
5343	    get_callback, &cb);
5344
5345	if (cb.cb_proplist == &fake_name)
5346		zprop_free_list(fake_name.pl_next);
5347	else
5348		zprop_free_list(cb.cb_proplist);
5349
5350	return (ret);
5351}
5352
5353typedef struct set_cbdata {
5354	char *cb_propname;
5355	char *cb_value;
5356	boolean_t cb_any_successful;
5357} set_cbdata_t;
5358
5359int
5360set_callback(zpool_handle_t *zhp, void *data)
5361{
5362	int error;
5363	set_cbdata_t *cb = (set_cbdata_t *)data;
5364
5365	error = zpool_set_prop(zhp, cb->cb_propname, cb->cb_value);
5366
5367	if (!error)
5368		cb->cb_any_successful = B_TRUE;
5369
5370	return (error);
5371}
5372
5373int
5374zpool_do_set(int argc, char **argv)
5375{
5376	set_cbdata_t cb = { 0 };
5377	int error;
5378
5379	if (argc > 1 && argv[1][0] == '-') {
5380		(void) fprintf(stderr, gettext("invalid option '%c'\n"),
5381		    argv[1][1]);
5382		usage(B_FALSE);
5383	}
5384
5385	if (argc < 2) {
5386		(void) fprintf(stderr, gettext("missing property=value "
5387		    "argument\n"));
5388		usage(B_FALSE);
5389	}
5390
5391	if (argc < 3) {
5392		(void) fprintf(stderr, gettext("missing pool name\n"));
5393		usage(B_FALSE);
5394	}
5395
5396	if (argc > 3) {
5397		(void) fprintf(stderr, gettext("too many pool names\n"));
5398		usage(B_FALSE);
5399	}
5400
5401	cb.cb_propname = argv[1];
5402	cb.cb_value = strchr(cb.cb_propname, '=');
5403	if (cb.cb_value == NULL) {
5404		(void) fprintf(stderr, gettext("missing value in "
5405		    "property=value argument\n"));
5406		usage(B_FALSE);
5407	}
5408
5409	*(cb.cb_value) = '\0';
5410	cb.cb_value++;
5411
5412	error = for_each_pool(argc - 2, argv + 2, B_TRUE, NULL,
5413	    set_callback, &cb);
5414
5415	return (error);
5416}
5417
5418static int
5419find_command_idx(char *command, int *idx)
5420{
5421	int i;
5422
5423	for (i = 0; i < NCOMMAND; i++) {
5424		if (command_table[i].name == NULL)
5425			continue;
5426
5427		if (strcmp(command, command_table[i].name) == 0) {
5428			*idx = i;
5429			return (0);
5430		}
5431	}
5432	return (1);
5433}
5434
5435int
5436main(int argc, char **argv)
5437{
5438	int ret;
5439	int i;
5440	char *cmdname;
5441
5442	(void) setlocale(LC_ALL, "");
5443	(void) textdomain(TEXT_DOMAIN);
5444
5445	if ((g_zfs = libzfs_init()) == NULL) {
5446		(void) fprintf(stderr, gettext("internal error: failed to "
5447		    "initialize ZFS library\n"));
5448		return (1);
5449	}
5450
5451	libzfs_print_on_error(g_zfs, B_TRUE);
5452
5453	opterr = 0;
5454
5455	/*
5456	 * Make sure the user has specified some command.
5457	 */
5458	if (argc < 2) {
5459		(void) fprintf(stderr, gettext("missing command\n"));
5460		usage(B_FALSE);
5461	}
5462
5463	cmdname = argv[1];
5464
5465	/*
5466	 * Special case '-?'
5467	 */
5468	if (strcmp(cmdname, "-?") == 0)
5469		usage(B_TRUE);
5470
5471	zfs_save_arguments(argc, argv, history_str, sizeof (history_str));
5472
5473	/*
5474	 * Run the appropriate command.
5475	 */
5476	if (find_command_idx(cmdname, &i) == 0) {
5477		current_command = &command_table[i];
5478		ret = command_table[i].func(argc - 1, argv + 1);
5479	} else if (strchr(cmdname, '=')) {
5480		verify(find_command_idx("set", &i) == 0);
5481		current_command = &command_table[i];
5482		ret = command_table[i].func(argc, argv);
5483	} else if (strcmp(cmdname, "freeze") == 0 && argc == 3) {
5484		/*
5485		 * 'freeze' is a vile debugging abomination, so we treat
5486		 * it as such.
5487		 */
5488		zfs_cmd_t zc = { 0 };
5489		(void) strlcpy(zc.zc_name, argv[2], sizeof (zc.zc_name));
5490		return (!!zfs_ioctl(g_zfs, ZFS_IOC_POOL_FREEZE, &zc));
5491	} else {
5492		(void) fprintf(stderr, gettext("unrecognized "
5493		    "command '%s'\n"), cmdname);
5494		usage(B_FALSE);
5495	}
5496
5497	if (ret == 0 && log_history)
5498		(void) zpool_log_history(g_zfs, history_str);
5499
5500	libzfs_fini(g_zfs);
5501
5502	/*
5503	 * The 'ZFS_ABORT' environment variable causes us to dump core on exit
5504	 * for the purposes of running ::findleaks.
5505	 */
5506	if (getenv("ZFS_ABORT") != NULL) {
5507		(void) printf("dumping core by request\n");
5508		abort();
5509	}
5510
5511	return (ret);
5512}
5513