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