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