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