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 https://opensource.org/licenses/CDDL-1.0. 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, 2024 by Delphix. All rights reserved. 26 * Copyright (c) 2012 by Frederik Wessels. All rights reserved. 27 * Copyright (c) 2012 by Cyril Plisko. All rights reserved. 28 * Copyright (c) 2013 by Prasad Joshi (sTec). All rights reserved. 29 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>. 30 * Copyright (c) 2017 Datto Inc. 31 * Copyright (c) 2017 Open-E, Inc. All Rights Reserved. 32 * Copyright (c) 2017, Intel Corporation. 33 * Copyright (c) 2019, loli10K <ezomori.nozomu@gmail.com> 34 * Copyright (c) 2021, Colm Buckley <colm@tuatha.org> 35 * Copyright (c) 2021, 2023, Klara Inc. 36 * Copyright [2021] Hewlett Packard Enterprise Development LP 37 */ 38 39 #include <assert.h> 40 #include <ctype.h> 41 #include <dirent.h> 42 #include <errno.h> 43 #include <fcntl.h> 44 #include <getopt.h> 45 #include <libgen.h> 46 #include <libintl.h> 47 #include <libuutil.h> 48 #include <locale.h> 49 #include <pthread.h> 50 #include <stdio.h> 51 #include <stdlib.h> 52 #include <string.h> 53 #include <thread_pool.h> 54 #include <time.h> 55 #include <unistd.h> 56 #include <pwd.h> 57 #include <zone.h> 58 #include <sys/wait.h> 59 #include <zfs_prop.h> 60 #include <sys/fs/zfs.h> 61 #include <sys/stat.h> 62 #include <sys/systeminfo.h> 63 #include <sys/fm/fs/zfs.h> 64 #include <sys/fm/util.h> 65 #include <sys/fm/protocol.h> 66 #include <sys/zfs_ioctl.h> 67 #include <sys/mount.h> 68 #include <sys/sysmacros.h> 69 #include <string.h> 70 #include <math.h> 71 72 #include <libzfs.h> 73 #include <libzutil.h> 74 75 #include "zpool_util.h" 76 #include "zfs_comutil.h" 77 #include "zfeature_common.h" 78 #include "zfs_valstr.h" 79 80 #include "statcommon.h" 81 82 libzfs_handle_t *g_zfs; 83 84 static int mount_tp_nthr = 512; /* tpool threads for multi-threaded mounting */ 85 86 static int zpool_do_create(int, char **); 87 static int zpool_do_destroy(int, char **); 88 89 static int zpool_do_add(int, char **); 90 static int zpool_do_remove(int, char **); 91 static int zpool_do_labelclear(int, char **); 92 93 static int zpool_do_checkpoint(int, char **); 94 static int zpool_do_prefetch(int, char **); 95 96 static int zpool_do_list(int, char **); 97 static int zpool_do_iostat(int, char **); 98 static int zpool_do_status(int, char **); 99 100 static int zpool_do_online(int, char **); 101 static int zpool_do_offline(int, char **); 102 static int zpool_do_clear(int, char **); 103 static int zpool_do_reopen(int, char **); 104 105 static int zpool_do_reguid(int, char **); 106 107 static int zpool_do_attach(int, char **); 108 static int zpool_do_detach(int, char **); 109 static int zpool_do_replace(int, char **); 110 static int zpool_do_split(int, char **); 111 112 static int zpool_do_initialize(int, char **); 113 static int zpool_do_scrub(int, char **); 114 static int zpool_do_resilver(int, char **); 115 static int zpool_do_trim(int, char **); 116 117 static int zpool_do_import(int, char **); 118 static int zpool_do_export(int, char **); 119 120 static int zpool_do_upgrade(int, char **); 121 122 static int zpool_do_history(int, char **); 123 static int zpool_do_events(int, char **); 124 125 static int zpool_do_get(int, char **); 126 static int zpool_do_set(int, char **); 127 128 static int zpool_do_sync(int, char **); 129 130 static int zpool_do_version(int, char **); 131 132 static int zpool_do_wait(int, char **); 133 134 static int zpool_do_ddt_prune(int, char **); 135 136 static int zpool_do_help(int argc, char **argv); 137 138 static zpool_compat_status_t zpool_do_load_compat( 139 const char *, boolean_t *); 140 141 enum zpool_options { 142 ZPOOL_OPTION_POWER = 1024, 143 ZPOOL_OPTION_ALLOW_INUSE, 144 ZPOOL_OPTION_ALLOW_REPLICATION_MISMATCH, 145 ZPOOL_OPTION_ALLOW_ASHIFT_MISMATCH, 146 ZPOOL_OPTION_POOL_KEY_GUID, 147 ZPOOL_OPTION_JSON_NUMS_AS_INT, 148 ZPOOL_OPTION_JSON_FLAT_VDEVS 149 }; 150 151 /* 152 * These libumem hooks provide a reasonable set of defaults for the allocator's 153 * debugging facilities. 154 */ 155 156 #ifdef DEBUG 157 const char * 158 _umem_debug_init(void) 159 { 160 return ("default,verbose"); /* $UMEM_DEBUG setting */ 161 } 162 163 const char * 164 _umem_logging_init(void) 165 { 166 return ("fail,contents"); /* $UMEM_LOGGING setting */ 167 } 168 #endif 169 170 typedef enum { 171 HELP_ADD, 172 HELP_ATTACH, 173 HELP_CLEAR, 174 HELP_CREATE, 175 HELP_CHECKPOINT, 176 HELP_DDT_PRUNE, 177 HELP_DESTROY, 178 HELP_DETACH, 179 HELP_EXPORT, 180 HELP_HISTORY, 181 HELP_IMPORT, 182 HELP_IOSTAT, 183 HELP_LABELCLEAR, 184 HELP_LIST, 185 HELP_OFFLINE, 186 HELP_ONLINE, 187 HELP_PREFETCH, 188 HELP_REPLACE, 189 HELP_REMOVE, 190 HELP_INITIALIZE, 191 HELP_SCRUB, 192 HELP_RESILVER, 193 HELP_TRIM, 194 HELP_STATUS, 195 HELP_UPGRADE, 196 HELP_EVENTS, 197 HELP_GET, 198 HELP_SET, 199 HELP_SPLIT, 200 HELP_SYNC, 201 HELP_REGUID, 202 HELP_REOPEN, 203 HELP_VERSION, 204 HELP_WAIT 205 } zpool_help_t; 206 207 208 /* 209 * Flags for stats to display with "zpool iostats" 210 */ 211 enum iostat_type { 212 IOS_DEFAULT = 0, 213 IOS_LATENCY = 1, 214 IOS_QUEUES = 2, 215 IOS_L_HISTO = 3, 216 IOS_RQ_HISTO = 4, 217 IOS_COUNT, /* always last element */ 218 }; 219 220 /* iostat_type entries as bitmasks */ 221 #define IOS_DEFAULT_M (1ULL << IOS_DEFAULT) 222 #define IOS_LATENCY_M (1ULL << IOS_LATENCY) 223 #define IOS_QUEUES_M (1ULL << IOS_QUEUES) 224 #define IOS_L_HISTO_M (1ULL << IOS_L_HISTO) 225 #define IOS_RQ_HISTO_M (1ULL << IOS_RQ_HISTO) 226 227 /* Mask of all the histo bits */ 228 #define IOS_ANYHISTO_M (IOS_L_HISTO_M | IOS_RQ_HISTO_M) 229 230 /* 231 * Lookup table for iostat flags to nvlist names. Basically a list 232 * of all the nvlists a flag requires. Also specifies the order in 233 * which data gets printed in zpool iostat. 234 */ 235 static const char *vsx_type_to_nvlist[IOS_COUNT][15] = { 236 [IOS_L_HISTO] = { 237 ZPOOL_CONFIG_VDEV_TOT_R_LAT_HISTO, 238 ZPOOL_CONFIG_VDEV_TOT_W_LAT_HISTO, 239 ZPOOL_CONFIG_VDEV_DISK_R_LAT_HISTO, 240 ZPOOL_CONFIG_VDEV_DISK_W_LAT_HISTO, 241 ZPOOL_CONFIG_VDEV_SYNC_R_LAT_HISTO, 242 ZPOOL_CONFIG_VDEV_SYNC_W_LAT_HISTO, 243 ZPOOL_CONFIG_VDEV_ASYNC_R_LAT_HISTO, 244 ZPOOL_CONFIG_VDEV_ASYNC_W_LAT_HISTO, 245 ZPOOL_CONFIG_VDEV_SCRUB_LAT_HISTO, 246 ZPOOL_CONFIG_VDEV_TRIM_LAT_HISTO, 247 ZPOOL_CONFIG_VDEV_REBUILD_LAT_HISTO, 248 NULL}, 249 [IOS_LATENCY] = { 250 ZPOOL_CONFIG_VDEV_TOT_R_LAT_HISTO, 251 ZPOOL_CONFIG_VDEV_TOT_W_LAT_HISTO, 252 ZPOOL_CONFIG_VDEV_DISK_R_LAT_HISTO, 253 ZPOOL_CONFIG_VDEV_DISK_W_LAT_HISTO, 254 ZPOOL_CONFIG_VDEV_TRIM_LAT_HISTO, 255 ZPOOL_CONFIG_VDEV_REBUILD_LAT_HISTO, 256 NULL}, 257 [IOS_QUEUES] = { 258 ZPOOL_CONFIG_VDEV_SYNC_R_ACTIVE_QUEUE, 259 ZPOOL_CONFIG_VDEV_SYNC_W_ACTIVE_QUEUE, 260 ZPOOL_CONFIG_VDEV_ASYNC_R_ACTIVE_QUEUE, 261 ZPOOL_CONFIG_VDEV_ASYNC_W_ACTIVE_QUEUE, 262 ZPOOL_CONFIG_VDEV_SCRUB_ACTIVE_QUEUE, 263 ZPOOL_CONFIG_VDEV_TRIM_ACTIVE_QUEUE, 264 ZPOOL_CONFIG_VDEV_REBUILD_ACTIVE_QUEUE, 265 NULL}, 266 [IOS_RQ_HISTO] = { 267 ZPOOL_CONFIG_VDEV_SYNC_IND_R_HISTO, 268 ZPOOL_CONFIG_VDEV_SYNC_AGG_R_HISTO, 269 ZPOOL_CONFIG_VDEV_SYNC_IND_W_HISTO, 270 ZPOOL_CONFIG_VDEV_SYNC_AGG_W_HISTO, 271 ZPOOL_CONFIG_VDEV_ASYNC_IND_R_HISTO, 272 ZPOOL_CONFIG_VDEV_ASYNC_AGG_R_HISTO, 273 ZPOOL_CONFIG_VDEV_ASYNC_IND_W_HISTO, 274 ZPOOL_CONFIG_VDEV_ASYNC_AGG_W_HISTO, 275 ZPOOL_CONFIG_VDEV_IND_SCRUB_HISTO, 276 ZPOOL_CONFIG_VDEV_AGG_SCRUB_HISTO, 277 ZPOOL_CONFIG_VDEV_IND_TRIM_HISTO, 278 ZPOOL_CONFIG_VDEV_AGG_TRIM_HISTO, 279 ZPOOL_CONFIG_VDEV_IND_REBUILD_HISTO, 280 ZPOOL_CONFIG_VDEV_AGG_REBUILD_HISTO, 281 NULL}, 282 }; 283 284 static const char *pool_scan_func_str[] = { 285 "NONE", 286 "SCRUB", 287 "RESILVER", 288 "ERRORSCRUB" 289 }; 290 291 static const char *pool_scan_state_str[] = { 292 "NONE", 293 "SCANNING", 294 "FINISHED", 295 "CANCELED", 296 "ERRORSCRUBBING" 297 }; 298 299 static const char *vdev_rebuild_state_str[] = { 300 "NONE", 301 "ACTIVE", 302 "CANCELED", 303 "COMPLETE" 304 }; 305 306 static const char *checkpoint_state_str[] = { 307 "NONE", 308 "EXISTS", 309 "DISCARDING" 310 }; 311 312 static const char *vdev_state_str[] = { 313 "UNKNOWN", 314 "CLOSED", 315 "OFFLINE", 316 "REMOVED", 317 "CANT_OPEN", 318 "FAULTED", 319 "DEGRADED", 320 "ONLINE" 321 }; 322 323 static const char *vdev_aux_str[] = { 324 "NONE", 325 "OPEN_FAILED", 326 "CORRUPT_DATA", 327 "NO_REPLICAS", 328 "BAD_GUID_SUM", 329 "TOO_SMALL", 330 "BAD_LABEL", 331 "VERSION_NEWER", 332 "VERSION_OLDER", 333 "UNSUP_FEAT", 334 "SPARED", 335 "ERR_EXCEEDED", 336 "IO_FAILURE", 337 "BAD_LOG", 338 "EXTERNAL", 339 "SPLIT_POOL", 340 "BAD_ASHIFT", 341 "EXTERNAL_PERSIST", 342 "ACTIVE", 343 "CHILDREN_OFFLINE", 344 "ASHIFT_TOO_BIG" 345 }; 346 347 static const char *vdev_init_state_str[] = { 348 "NONE", 349 "ACTIVE", 350 "CANCELED", 351 "SUSPENDED", 352 "COMPLETE" 353 }; 354 355 static const char *vdev_trim_state_str[] = { 356 "NONE", 357 "ACTIVE", 358 "CANCELED", 359 "SUSPENDED", 360 "COMPLETE" 361 }; 362 363 #define ZFS_NICE_TIMESTAMP 100 364 365 /* 366 * Given a cb->cb_flags with a histogram bit set, return the iostat_type. 367 * Right now, only one histo bit is ever set at one time, so we can 368 * just do a highbit64(a) 369 */ 370 #define IOS_HISTO_IDX(a) (highbit64(a & IOS_ANYHISTO_M) - 1) 371 372 typedef struct zpool_command { 373 const char *name; 374 int (*func)(int, char **); 375 zpool_help_t usage; 376 } zpool_command_t; 377 378 /* 379 * Master command table. Each ZFS command has a name, associated function, and 380 * usage message. The usage messages need to be internationalized, so we have 381 * to have a function to return the usage message based on a command index. 382 * 383 * These commands are organized according to how they are displayed in the usage 384 * message. An empty command (one with a NULL name) indicates an empty line in 385 * the generic usage message. 386 */ 387 static zpool_command_t command_table[] = { 388 { "version", zpool_do_version, HELP_VERSION }, 389 { NULL }, 390 { "create", zpool_do_create, HELP_CREATE }, 391 { "destroy", zpool_do_destroy, HELP_DESTROY }, 392 { NULL }, 393 { "add", zpool_do_add, HELP_ADD }, 394 { "remove", zpool_do_remove, HELP_REMOVE }, 395 { NULL }, 396 { "labelclear", zpool_do_labelclear, HELP_LABELCLEAR }, 397 { NULL }, 398 { "checkpoint", zpool_do_checkpoint, HELP_CHECKPOINT }, 399 { "prefetch", zpool_do_prefetch, HELP_PREFETCH }, 400 { NULL }, 401 { "list", zpool_do_list, HELP_LIST }, 402 { "iostat", zpool_do_iostat, HELP_IOSTAT }, 403 { "status", zpool_do_status, HELP_STATUS }, 404 { NULL }, 405 { "online", zpool_do_online, HELP_ONLINE }, 406 { "offline", zpool_do_offline, HELP_OFFLINE }, 407 { "clear", zpool_do_clear, HELP_CLEAR }, 408 { "reopen", zpool_do_reopen, HELP_REOPEN }, 409 { NULL }, 410 { "attach", zpool_do_attach, HELP_ATTACH }, 411 { "detach", zpool_do_detach, HELP_DETACH }, 412 { "replace", zpool_do_replace, HELP_REPLACE }, 413 { "split", zpool_do_split, HELP_SPLIT }, 414 { NULL }, 415 { "initialize", zpool_do_initialize, HELP_INITIALIZE }, 416 { "resilver", zpool_do_resilver, HELP_RESILVER }, 417 { "scrub", zpool_do_scrub, HELP_SCRUB }, 418 { "trim", zpool_do_trim, HELP_TRIM }, 419 { NULL }, 420 { "import", zpool_do_import, HELP_IMPORT }, 421 { "export", zpool_do_export, HELP_EXPORT }, 422 { "upgrade", zpool_do_upgrade, HELP_UPGRADE }, 423 { "reguid", zpool_do_reguid, HELP_REGUID }, 424 { NULL }, 425 { "history", zpool_do_history, HELP_HISTORY }, 426 { "events", zpool_do_events, HELP_EVENTS }, 427 { NULL }, 428 { "get", zpool_do_get, HELP_GET }, 429 { "set", zpool_do_set, HELP_SET }, 430 { "sync", zpool_do_sync, HELP_SYNC }, 431 { NULL }, 432 { "wait", zpool_do_wait, HELP_WAIT }, 433 { NULL }, 434 { "ddtprune", zpool_do_ddt_prune, HELP_DDT_PRUNE }, 435 }; 436 437 #define NCOMMAND (ARRAY_SIZE(command_table)) 438 439 #define VDEV_ALLOC_CLASS_LOGS "logs" 440 441 #define MAX_CMD_LEN 256 442 443 static zpool_command_t *current_command; 444 static zfs_type_t current_prop_type = (ZFS_TYPE_POOL | ZFS_TYPE_VDEV); 445 static char history_str[HIS_MAX_RECORD_LEN]; 446 static boolean_t log_history = B_TRUE; 447 static uint_t timestamp_fmt = NODATE; 448 449 static const char * 450 get_usage(zpool_help_t idx) 451 { 452 switch (idx) { 453 case HELP_ADD: 454 return (gettext("\tadd [-afgLnP] [-o property=value] " 455 "<pool> <vdev> ...\n")); 456 case HELP_ATTACH: 457 return (gettext("\tattach [-fsw] [-o property=value] " 458 "<pool> <device> <new-device>\n")); 459 case HELP_CLEAR: 460 return (gettext("\tclear [[--power]|[-nF]] <pool> [device]\n")); 461 case HELP_CREATE: 462 return (gettext("\tcreate [-fnd] [-o property=value] ... \n" 463 "\t [-O file-system-property=value] ... \n" 464 "\t [-m mountpoint] [-R root] <pool> <vdev> ...\n")); 465 case HELP_CHECKPOINT: 466 return (gettext("\tcheckpoint [-d [-w]] <pool> ...\n")); 467 case HELP_DESTROY: 468 return (gettext("\tdestroy [-f] <pool>\n")); 469 case HELP_DETACH: 470 return (gettext("\tdetach <pool> <device>\n")); 471 case HELP_EXPORT: 472 return (gettext("\texport [-af] <pool> ...\n")); 473 case HELP_HISTORY: 474 return (gettext("\thistory [-il] [<pool>] ...\n")); 475 case HELP_IMPORT: 476 return (gettext("\timport [-d dir] [-D]\n" 477 "\timport [-o mntopts] [-o property=value] ... \n" 478 "\t [-d dir | -c cachefile] [-D] [-l] [-f] [-m] [-N] " 479 "[-R root] [-F [-n]] -a\n" 480 "\timport [-o mntopts] [-o property=value] ... \n" 481 "\t [-d dir | -c cachefile] [-D] [-l] [-f] [-m] [-N] " 482 "[-R root] [-F [-n]]\n" 483 "\t [--rewind-to-checkpoint] <pool | id> [newpool]\n")); 484 case HELP_IOSTAT: 485 return (gettext("\tiostat [[[-c [script1,script2,...]" 486 "[-lq]]|[-rw]] [-T d | u] [-ghHLpPvy]\n" 487 "\t [[pool ...]|[pool vdev ...]|[vdev ...]]" 488 " [[-n] interval [count]]\n")); 489 case HELP_LABELCLEAR: 490 return (gettext("\tlabelclear [-f] <vdev>\n")); 491 case HELP_LIST: 492 return (gettext("\tlist [-gHLpPv] [-o property[,...]] [-j " 493 "[--json-int, --json-pool-key-guid]] ...\n" 494 "\t [-T d|u] [pool] [interval [count]]\n")); 495 case HELP_PREFETCH: 496 return (gettext("\tprefetch -t <type> [<type opts>] <pool>\n" 497 "\t -t ddt <pool>\n")); 498 case HELP_OFFLINE: 499 return (gettext("\toffline [--power]|[[-f][-t]] <pool> " 500 "<device> ...\n")); 501 case HELP_ONLINE: 502 return (gettext("\tonline [--power][-e] <pool> <device> " 503 "...\n")); 504 case HELP_REPLACE: 505 return (gettext("\treplace [-fsw] [-o property=value] " 506 "<pool> <device> [new-device]\n")); 507 case HELP_REMOVE: 508 return (gettext("\tremove [-npsw] <pool> <device> ...\n")); 509 case HELP_REOPEN: 510 return (gettext("\treopen [-n] <pool>\n")); 511 case HELP_INITIALIZE: 512 return (gettext("\tinitialize [-c | -s | -u] [-w] <pool> " 513 "[<device> ...]\n")); 514 case HELP_SCRUB: 515 return (gettext("\tscrub [-s | -p] [-w] [-e] <pool> ...\n")); 516 case HELP_RESILVER: 517 return (gettext("\tresilver <pool> ...\n")); 518 case HELP_TRIM: 519 return (gettext("\ttrim [-dw] [-r <rate>] [-c | -s] <pool> " 520 "[<device> ...]\n")); 521 case HELP_STATUS: 522 return (gettext("\tstatus [--power] [-j [--json-int, " 523 "--json-flat-vdevs, ...\n" 524 "\t --json-pool-key-guid]] [-c [script1,script2,...]] " 525 "[-dDegiLpPstvx] ...\n" 526 "\t [-T d|u] [pool] [interval [count]]\n")); 527 case HELP_UPGRADE: 528 return (gettext("\tupgrade\n" 529 "\tupgrade -v\n" 530 "\tupgrade [-V version] <-a | pool ...>\n")); 531 case HELP_EVENTS: 532 return (gettext("\tevents [-vHf [pool] | -c]\n")); 533 case HELP_GET: 534 return (gettext("\tget [-Hp] [-j [--json-int, " 535 "--json-pool-key-guid]] ...\n" 536 "\t [-o \"all\" | field[,...]] " 537 "<\"all\" | property[,...]> <pool> ...\n")); 538 case HELP_SET: 539 return (gettext("\tset <property=value> <pool>\n" 540 "\tset <vdev_property=value> <pool> <vdev>\n")); 541 case HELP_SPLIT: 542 return (gettext("\tsplit [-gLnPl] [-R altroot] [-o mntopts]\n" 543 "\t [-o property=value] <pool> <newpool> " 544 "[<device> ...]\n")); 545 case HELP_REGUID: 546 return (gettext("\treguid [-g guid] <pool>\n")); 547 case HELP_SYNC: 548 return (gettext("\tsync [pool] ...\n")); 549 case HELP_VERSION: 550 return (gettext("\tversion [-j]\n")); 551 case HELP_WAIT: 552 return (gettext("\twait [-Hp] [-T d|u] [-t <activity>[,...]] " 553 "<pool> [interval]\n")); 554 case HELP_DDT_PRUNE: 555 return (gettext("\tddtprune -d|-p <amount> <pool>\n")); 556 default: 557 __builtin_unreachable(); 558 } 559 } 560 561 static void 562 zpool_collect_leaves(zpool_handle_t *zhp, nvlist_t *nvroot, nvlist_t *res) 563 { 564 uint_t children = 0; 565 nvlist_t **child; 566 uint_t i; 567 568 (void) nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN, 569 &child, &children); 570 571 if (children == 0) { 572 char *path = zpool_vdev_name(g_zfs, zhp, nvroot, 573 VDEV_NAME_PATH); 574 575 if (strcmp(path, VDEV_TYPE_INDIRECT) != 0 && 576 strcmp(path, VDEV_TYPE_HOLE) != 0) 577 fnvlist_add_boolean(res, path); 578 579 free(path); 580 return; 581 } 582 583 for (i = 0; i < children; i++) { 584 zpool_collect_leaves(zhp, child[i], res); 585 } 586 } 587 588 /* 589 * Callback routine that will print out a pool property value. 590 */ 591 static int 592 print_pool_prop_cb(int prop, void *cb) 593 { 594 FILE *fp = cb; 595 596 (void) fprintf(fp, "\t%-19s ", zpool_prop_to_name(prop)); 597 598 if (zpool_prop_readonly(prop)) 599 (void) fprintf(fp, " NO "); 600 else 601 (void) fprintf(fp, " YES "); 602 603 if (zpool_prop_values(prop) == NULL) 604 (void) fprintf(fp, "-\n"); 605 else 606 (void) fprintf(fp, "%s\n", zpool_prop_values(prop)); 607 608 return (ZPROP_CONT); 609 } 610 611 /* 612 * Callback routine that will print out a vdev property value. 613 */ 614 static int 615 print_vdev_prop_cb(int prop, void *cb) 616 { 617 FILE *fp = cb; 618 619 (void) fprintf(fp, "\t%-19s ", vdev_prop_to_name(prop)); 620 621 if (vdev_prop_readonly(prop)) 622 (void) fprintf(fp, " NO "); 623 else 624 (void) fprintf(fp, " YES "); 625 626 if (vdev_prop_values(prop) == NULL) 627 (void) fprintf(fp, "-\n"); 628 else 629 (void) fprintf(fp, "%s\n", vdev_prop_values(prop)); 630 631 return (ZPROP_CONT); 632 } 633 634 /* 635 * Given a leaf vdev name like 'L5' return its VDEV_CONFIG_PATH like 636 * '/dev/disk/by-vdev/L5'. 637 */ 638 static const char * 639 vdev_name_to_path(zpool_handle_t *zhp, char *vdev) 640 { 641 nvlist_t *vdev_nv = zpool_find_vdev(zhp, vdev, NULL, NULL, NULL); 642 if (vdev_nv == NULL) { 643 return (NULL); 644 } 645 return (fnvlist_lookup_string(vdev_nv, ZPOOL_CONFIG_PATH)); 646 } 647 648 static int 649 zpool_power_on(zpool_handle_t *zhp, char *vdev) 650 { 651 return (zpool_power(zhp, vdev, B_TRUE)); 652 } 653 654 static int 655 zpool_power_on_and_disk_wait(zpool_handle_t *zhp, char *vdev) 656 { 657 int rc; 658 659 rc = zpool_power_on(zhp, vdev); 660 if (rc != 0) 661 return (rc); 662 663 zpool_disk_wait(vdev_name_to_path(zhp, vdev)); 664 665 return (0); 666 } 667 668 static int 669 zpool_power_on_pool_and_wait_for_devices(zpool_handle_t *zhp) 670 { 671 nvlist_t *nv; 672 const char *path = NULL; 673 int rc; 674 675 /* Power up all the devices first */ 676 FOR_EACH_REAL_LEAF_VDEV(zhp, nv) { 677 path = fnvlist_lookup_string(nv, ZPOOL_CONFIG_PATH); 678 if (path != NULL) { 679 rc = zpool_power_on(zhp, (char *)path); 680 if (rc != 0) { 681 return (rc); 682 } 683 } 684 } 685 686 /* 687 * Wait for their devices to show up. Since we powered them on 688 * at roughly the same time, they should all come online around 689 * the same time. 690 */ 691 FOR_EACH_REAL_LEAF_VDEV(zhp, nv) { 692 path = fnvlist_lookup_string(nv, ZPOOL_CONFIG_PATH); 693 zpool_disk_wait(path); 694 } 695 696 return (0); 697 } 698 699 static int 700 zpool_power_off(zpool_handle_t *zhp, char *vdev) 701 { 702 return (zpool_power(zhp, vdev, B_FALSE)); 703 } 704 705 /* 706 * Display usage message. If we're inside a command, display only the usage for 707 * that command. Otherwise, iterate over the entire command table and display 708 * a complete usage message. 709 */ 710 static __attribute__((noreturn)) void 711 usage(boolean_t requested) 712 { 713 FILE *fp = requested ? stdout : stderr; 714 715 if (current_command == NULL) { 716 int i; 717 718 (void) fprintf(fp, gettext("usage: zpool command args ...\n")); 719 (void) fprintf(fp, 720 gettext("where 'command' is one of the following:\n\n")); 721 722 for (i = 0; i < NCOMMAND; i++) { 723 if (command_table[i].name == NULL) 724 (void) fprintf(fp, "\n"); 725 else 726 (void) fprintf(fp, "%s", 727 get_usage(command_table[i].usage)); 728 } 729 730 (void) fprintf(fp, 731 gettext("\nFor further help on a command or topic, " 732 "run: %s\n"), "zpool help [<topic>]"); 733 } else { 734 (void) fprintf(fp, gettext("usage:\n")); 735 (void) fprintf(fp, "%s", get_usage(current_command->usage)); 736 } 737 738 if (current_command != NULL && 739 current_prop_type != (ZFS_TYPE_POOL | ZFS_TYPE_VDEV) && 740 ((strcmp(current_command->name, "set") == 0) || 741 (strcmp(current_command->name, "get") == 0) || 742 (strcmp(current_command->name, "list") == 0))) { 743 744 (void) fprintf(fp, "%s", 745 gettext("\nthe following properties are supported:\n")); 746 747 (void) fprintf(fp, "\n\t%-19s %s %s\n\n", 748 "PROPERTY", "EDIT", "VALUES"); 749 750 /* Iterate over all properties */ 751 if (current_prop_type == ZFS_TYPE_POOL) { 752 (void) zprop_iter(print_pool_prop_cb, fp, B_FALSE, 753 B_TRUE, current_prop_type); 754 755 (void) fprintf(fp, "\t%-19s ", "feature@..."); 756 (void) fprintf(fp, "YES " 757 "disabled | enabled | active\n"); 758 759 (void) fprintf(fp, gettext("\nThe feature@ properties " 760 "must be appended with a feature name.\n" 761 "See zpool-features(7).\n")); 762 } else if (current_prop_type == ZFS_TYPE_VDEV) { 763 (void) zprop_iter(print_vdev_prop_cb, fp, B_FALSE, 764 B_TRUE, current_prop_type); 765 } 766 } 767 768 /* 769 * See comments at end of main(). 770 */ 771 if (getenv("ZFS_ABORT") != NULL) { 772 (void) printf("dumping core by request\n"); 773 abort(); 774 } 775 776 exit(requested ? 0 : 2); 777 } 778 779 /* 780 * zpool initialize [-c | -s | -u] [-w] <pool> [<vdev> ...] 781 * Initialize all unused blocks in the specified vdevs, or all vdevs in the pool 782 * if none specified. 783 * 784 * -c Cancel. Ends active initializing. 785 * -s Suspend. Initializing can then be restarted with no flags. 786 * -u Uninitialize. Clears initialization state. 787 * -w Wait. Blocks until initializing has completed. 788 */ 789 int 790 zpool_do_initialize(int argc, char **argv) 791 { 792 int c; 793 char *poolname; 794 zpool_handle_t *zhp; 795 nvlist_t *vdevs; 796 int err = 0; 797 boolean_t wait = B_FALSE; 798 799 struct option long_options[] = { 800 {"cancel", no_argument, NULL, 'c'}, 801 {"suspend", no_argument, NULL, 's'}, 802 {"uninit", no_argument, NULL, 'u'}, 803 {"wait", no_argument, NULL, 'w'}, 804 {0, 0, 0, 0} 805 }; 806 807 pool_initialize_func_t cmd_type = POOL_INITIALIZE_START; 808 while ((c = getopt_long(argc, argv, "csuw", long_options, 809 NULL)) != -1) { 810 switch (c) { 811 case 'c': 812 if (cmd_type != POOL_INITIALIZE_START && 813 cmd_type != POOL_INITIALIZE_CANCEL) { 814 (void) fprintf(stderr, gettext("-c cannot be " 815 "combined with other options\n")); 816 usage(B_FALSE); 817 } 818 cmd_type = POOL_INITIALIZE_CANCEL; 819 break; 820 case 's': 821 if (cmd_type != POOL_INITIALIZE_START && 822 cmd_type != POOL_INITIALIZE_SUSPEND) { 823 (void) fprintf(stderr, gettext("-s cannot be " 824 "combined with other options\n")); 825 usage(B_FALSE); 826 } 827 cmd_type = POOL_INITIALIZE_SUSPEND; 828 break; 829 case 'u': 830 if (cmd_type != POOL_INITIALIZE_START && 831 cmd_type != POOL_INITIALIZE_UNINIT) { 832 (void) fprintf(stderr, gettext("-u cannot be " 833 "combined with other options\n")); 834 usage(B_FALSE); 835 } 836 cmd_type = POOL_INITIALIZE_UNINIT; 837 break; 838 case 'w': 839 wait = B_TRUE; 840 break; 841 case '?': 842 if (optopt != 0) { 843 (void) fprintf(stderr, 844 gettext("invalid option '%c'\n"), optopt); 845 } else { 846 (void) fprintf(stderr, 847 gettext("invalid option '%s'\n"), 848 argv[optind - 1]); 849 } 850 usage(B_FALSE); 851 } 852 } 853 854 argc -= optind; 855 argv += optind; 856 857 if (argc < 1) { 858 (void) fprintf(stderr, gettext("missing pool name argument\n")); 859 usage(B_FALSE); 860 return (-1); 861 } 862 863 if (wait && (cmd_type != POOL_INITIALIZE_START)) { 864 (void) fprintf(stderr, gettext("-w cannot be used with -c, -s" 865 "or -u\n")); 866 usage(B_FALSE); 867 } 868 869 poolname = argv[0]; 870 zhp = zpool_open(g_zfs, poolname); 871 if (zhp == NULL) 872 return (-1); 873 874 vdevs = fnvlist_alloc(); 875 if (argc == 1) { 876 /* no individual leaf vdevs specified, so add them all */ 877 nvlist_t *config = zpool_get_config(zhp, NULL); 878 nvlist_t *nvroot = fnvlist_lookup_nvlist(config, 879 ZPOOL_CONFIG_VDEV_TREE); 880 zpool_collect_leaves(zhp, nvroot, vdevs); 881 } else { 882 for (int i = 1; i < argc; i++) { 883 fnvlist_add_boolean(vdevs, argv[i]); 884 } 885 } 886 887 if (wait) 888 err = zpool_initialize_wait(zhp, cmd_type, vdevs); 889 else 890 err = zpool_initialize(zhp, cmd_type, vdevs); 891 892 fnvlist_free(vdevs); 893 zpool_close(zhp); 894 895 return (err); 896 } 897 898 /* 899 * print a pool vdev config for dry runs 900 */ 901 static void 902 print_vdev_tree(zpool_handle_t *zhp, const char *name, nvlist_t *nv, int indent, 903 const char *match, int name_flags) 904 { 905 nvlist_t **child; 906 uint_t c, children; 907 char *vname; 908 boolean_t printed = B_FALSE; 909 910 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, 911 &child, &children) != 0) { 912 if (name != NULL) 913 (void) printf("\t%*s%s\n", indent, "", name); 914 return; 915 } 916 917 for (c = 0; c < children; c++) { 918 uint64_t is_log = B_FALSE, is_hole = B_FALSE; 919 const char *class = ""; 920 921 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_HOLE, 922 &is_hole); 923 924 if (is_hole == B_TRUE) { 925 continue; 926 } 927 928 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG, 929 &is_log); 930 if (is_log) 931 class = VDEV_ALLOC_BIAS_LOG; 932 (void) nvlist_lookup_string(child[c], 933 ZPOOL_CONFIG_ALLOCATION_BIAS, &class); 934 if (strcmp(match, class) != 0) 935 continue; 936 937 if (!printed && name != NULL) { 938 (void) printf("\t%*s%s\n", indent, "", name); 939 printed = B_TRUE; 940 } 941 vname = zpool_vdev_name(g_zfs, zhp, child[c], name_flags); 942 print_vdev_tree(zhp, vname, child[c], indent + 2, "", 943 name_flags); 944 free(vname); 945 } 946 } 947 948 /* 949 * Print the list of l2cache devices for dry runs. 950 */ 951 static void 952 print_cache_list(nvlist_t *nv, int indent) 953 { 954 nvlist_t **child; 955 uint_t c, children; 956 957 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE, 958 &child, &children) == 0 && children > 0) { 959 (void) printf("\t%*s%s\n", indent, "", "cache"); 960 } else { 961 return; 962 } 963 for (c = 0; c < children; c++) { 964 char *vname; 965 966 vname = zpool_vdev_name(g_zfs, NULL, child[c], 0); 967 (void) printf("\t%*s%s\n", indent + 2, "", vname); 968 free(vname); 969 } 970 } 971 972 /* 973 * Print the list of spares for dry runs. 974 */ 975 static void 976 print_spare_list(nvlist_t *nv, int indent) 977 { 978 nvlist_t **child; 979 uint_t c, children; 980 981 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_SPARES, 982 &child, &children) == 0 && children > 0) { 983 (void) printf("\t%*s%s\n", indent, "", "spares"); 984 } else { 985 return; 986 } 987 for (c = 0; c < children; c++) { 988 char *vname; 989 990 vname = zpool_vdev_name(g_zfs, NULL, child[c], 0); 991 (void) printf("\t%*s%s\n", indent + 2, "", vname); 992 free(vname); 993 } 994 } 995 996 typedef struct spare_cbdata { 997 uint64_t cb_guid; 998 zpool_handle_t *cb_zhp; 999 } spare_cbdata_t; 1000 1001 static boolean_t 1002 find_vdev(nvlist_t *nv, uint64_t search) 1003 { 1004 uint64_t guid; 1005 nvlist_t **child; 1006 uint_t c, children; 1007 1008 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &guid) == 0 && 1009 search == guid) 1010 return (B_TRUE); 1011 1012 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, 1013 &child, &children) == 0) { 1014 for (c = 0; c < children; c++) 1015 if (find_vdev(child[c], search)) 1016 return (B_TRUE); 1017 } 1018 1019 return (B_FALSE); 1020 } 1021 1022 static int 1023 find_spare(zpool_handle_t *zhp, void *data) 1024 { 1025 spare_cbdata_t *cbp = data; 1026 nvlist_t *config, *nvroot; 1027 1028 config = zpool_get_config(zhp, NULL); 1029 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE, 1030 &nvroot) == 0); 1031 1032 if (find_vdev(nvroot, cbp->cb_guid)) { 1033 cbp->cb_zhp = zhp; 1034 return (1); 1035 } 1036 1037 zpool_close(zhp); 1038 return (0); 1039 } 1040 1041 static void 1042 nice_num_str_nvlist(nvlist_t *item, const char *key, uint64_t value, 1043 boolean_t literal, boolean_t as_int, int format) 1044 { 1045 char buf[256]; 1046 if (literal) { 1047 if (!as_int) 1048 snprintf(buf, 256, "%llu", (u_longlong_t)value); 1049 } else { 1050 switch (format) { 1051 case ZFS_NICENUM_1024: 1052 zfs_nicenum_format(value, buf, 256, ZFS_NICENUM_1024); 1053 break; 1054 case ZFS_NICENUM_BYTES: 1055 zfs_nicenum_format(value, buf, 256, ZFS_NICENUM_BYTES); 1056 break; 1057 case ZFS_NICENUM_TIME: 1058 zfs_nicenum_format(value, buf, 256, ZFS_NICENUM_TIME); 1059 break; 1060 case ZFS_NICE_TIMESTAMP: 1061 format_timestamp(value, buf, 256); 1062 break; 1063 default: 1064 fprintf(stderr, "Invalid number format"); 1065 exit(1); 1066 } 1067 } 1068 if (as_int) 1069 fnvlist_add_uint64(item, key, value); 1070 else 1071 fnvlist_add_string(item, key, buf); 1072 } 1073 1074 /* 1075 * Generates an nvlist with output version for every command based on params. 1076 * Purpose of this is to add a version of JSON output, considering the schema 1077 * format might be updated for each command in future. 1078 * 1079 * Schema: 1080 * 1081 * "output_version": { 1082 * "command": string, 1083 * "vers_major": integer, 1084 * "vers_minor": integer, 1085 * } 1086 */ 1087 static nvlist_t * 1088 zpool_json_schema(int maj_v, int min_v) 1089 { 1090 char cmd[MAX_CMD_LEN]; 1091 nvlist_t *sch = fnvlist_alloc(); 1092 nvlist_t *ov = fnvlist_alloc(); 1093 1094 snprintf(cmd, MAX_CMD_LEN, "zpool %s", current_command->name); 1095 fnvlist_add_string(ov, "command", cmd); 1096 fnvlist_add_uint32(ov, "vers_major", maj_v); 1097 fnvlist_add_uint32(ov, "vers_minor", min_v); 1098 fnvlist_add_nvlist(sch, "output_version", ov); 1099 fnvlist_free(ov); 1100 return (sch); 1101 } 1102 1103 static void 1104 fill_pool_info(nvlist_t *list, zpool_handle_t *zhp, boolean_t addtype, 1105 boolean_t as_int) 1106 { 1107 nvlist_t *config = zpool_get_config(zhp, NULL); 1108 uint64_t guid = fnvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID); 1109 uint64_t txg = fnvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_TXG); 1110 1111 fnvlist_add_string(list, "name", zpool_get_name(zhp)); 1112 if (addtype) 1113 fnvlist_add_string(list, "type", "POOL"); 1114 fnvlist_add_string(list, "state", zpool_get_state_str(zhp)); 1115 if (as_int) { 1116 if (guid) 1117 fnvlist_add_uint64(list, ZPOOL_CONFIG_POOL_GUID, guid); 1118 if (txg) 1119 fnvlist_add_uint64(list, ZPOOL_CONFIG_POOL_TXG, txg); 1120 fnvlist_add_uint64(list, "spa_version", SPA_VERSION); 1121 fnvlist_add_uint64(list, "zpl_version", ZPL_VERSION); 1122 } else { 1123 char value[ZFS_MAXPROPLEN]; 1124 if (guid) { 1125 snprintf(value, ZFS_MAXPROPLEN, "%llu", 1126 (u_longlong_t)guid); 1127 fnvlist_add_string(list, ZPOOL_CONFIG_POOL_GUID, value); 1128 } 1129 if (txg) { 1130 snprintf(value, ZFS_MAXPROPLEN, "%llu", 1131 (u_longlong_t)txg); 1132 fnvlist_add_string(list, ZPOOL_CONFIG_POOL_TXG, value); 1133 } 1134 fnvlist_add_string(list, "spa_version", SPA_VERSION_STRING); 1135 fnvlist_add_string(list, "zpl_version", ZPL_VERSION_STRING); 1136 } 1137 } 1138 1139 static void 1140 used_by_other(zpool_handle_t *zhp, nvlist_t *nvdev, nvlist_t *list) 1141 { 1142 spare_cbdata_t spare_cb; 1143 verify(nvlist_lookup_uint64(nvdev, ZPOOL_CONFIG_GUID, 1144 &spare_cb.cb_guid) == 0); 1145 if (zpool_iter(g_zfs, find_spare, &spare_cb) == 1) { 1146 if (strcmp(zpool_get_name(spare_cb.cb_zhp), 1147 zpool_get_name(zhp)) != 0) { 1148 fnvlist_add_string(list, "used_by", 1149 zpool_get_name(spare_cb.cb_zhp)); 1150 } 1151 zpool_close(spare_cb.cb_zhp); 1152 } 1153 } 1154 1155 static void 1156 fill_vdev_info(nvlist_t *list, zpool_handle_t *zhp, char *name, 1157 boolean_t addtype, boolean_t as_int) 1158 { 1159 boolean_t l2c = B_FALSE; 1160 const char *path, *phys, *devid, *bias = NULL; 1161 uint64_t hole = 0, log = 0, spare = 0; 1162 vdev_stat_t *vs; 1163 uint_t c; 1164 nvlist_t *nvdev; 1165 nvlist_t *nvdev_parent = NULL; 1166 char *_name; 1167 1168 if (strcmp(name, zpool_get_name(zhp)) != 0) 1169 _name = name; 1170 else 1171 _name = (char *)"root-0"; 1172 1173 nvdev = zpool_find_vdev(zhp, _name, NULL, &l2c, NULL); 1174 1175 fnvlist_add_string(list, "name", name); 1176 if (addtype) 1177 fnvlist_add_string(list, "type", "VDEV"); 1178 if (nvdev) { 1179 const char *type = fnvlist_lookup_string(nvdev, 1180 ZPOOL_CONFIG_TYPE); 1181 if (type) 1182 fnvlist_add_string(list, "vdev_type", type); 1183 uint64_t guid = fnvlist_lookup_uint64(nvdev, ZPOOL_CONFIG_GUID); 1184 if (guid) { 1185 if (as_int) { 1186 fnvlist_add_uint64(list, "guid", guid); 1187 } else { 1188 char buf[ZFS_MAXPROPLEN]; 1189 snprintf(buf, ZFS_MAXPROPLEN, "%llu", 1190 (u_longlong_t)guid); 1191 fnvlist_add_string(list, "guid", buf); 1192 } 1193 } 1194 if (nvlist_lookup_string(nvdev, ZPOOL_CONFIG_PATH, &path) == 0) 1195 fnvlist_add_string(list, "path", path); 1196 if (nvlist_lookup_string(nvdev, ZPOOL_CONFIG_PHYS_PATH, 1197 &phys) == 0) 1198 fnvlist_add_string(list, "phys_path", phys); 1199 if (nvlist_lookup_string(nvdev, ZPOOL_CONFIG_DEVID, 1200 &devid) == 0) 1201 fnvlist_add_string(list, "devid", devid); 1202 (void) nvlist_lookup_uint64(nvdev, ZPOOL_CONFIG_IS_LOG, &log); 1203 (void) nvlist_lookup_uint64(nvdev, ZPOOL_CONFIG_IS_SPARE, 1204 &spare); 1205 (void) nvlist_lookup_uint64(nvdev, ZPOOL_CONFIG_IS_HOLE, &hole); 1206 if (hole) 1207 fnvlist_add_string(list, "class", VDEV_TYPE_HOLE); 1208 else if (l2c) 1209 fnvlist_add_string(list, "class", VDEV_TYPE_L2CACHE); 1210 else if (spare) 1211 fnvlist_add_string(list, "class", VDEV_TYPE_SPARE); 1212 else if (log) 1213 fnvlist_add_string(list, "class", VDEV_TYPE_LOG); 1214 else { 1215 (void) nvlist_lookup_string(nvdev, 1216 ZPOOL_CONFIG_ALLOCATION_BIAS, &bias); 1217 if (bias != NULL) 1218 fnvlist_add_string(list, "class", bias); 1219 else { 1220 nvdev_parent = NULL; 1221 nvdev_parent = zpool_find_parent_vdev(zhp, 1222 _name, NULL, NULL, NULL); 1223 1224 /* 1225 * With a mirrored special device, the parent 1226 * "mirror" vdev will have 1227 * ZPOOL_CONFIG_ALLOCATION_BIAS set to "special" 1228 * not the leaf vdevs. If we're a leaf vdev 1229 * in that case we need to look at our parent 1230 * to see if they're "special" to know if we 1231 * are "special" too. 1232 */ 1233 if (nvdev_parent) { 1234 (void) nvlist_lookup_string( 1235 nvdev_parent, 1236 ZPOOL_CONFIG_ALLOCATION_BIAS, 1237 &bias); 1238 } 1239 if (bias != NULL) 1240 fnvlist_add_string(list, "class", bias); 1241 else 1242 fnvlist_add_string(list, "class", 1243 "normal"); 1244 } 1245 } 1246 if (nvlist_lookup_uint64_array(nvdev, ZPOOL_CONFIG_VDEV_STATS, 1247 (uint64_t **)&vs, &c) == 0) { 1248 fnvlist_add_string(list, "state", 1249 vdev_state_str[vs->vs_state]); 1250 } 1251 } 1252 } 1253 1254 static boolean_t 1255 prop_list_contains_feature(nvlist_t *proplist) 1256 { 1257 nvpair_t *nvp; 1258 for (nvp = nvlist_next_nvpair(proplist, NULL); NULL != nvp; 1259 nvp = nvlist_next_nvpair(proplist, nvp)) { 1260 if (zpool_prop_feature(nvpair_name(nvp))) 1261 return (B_TRUE); 1262 } 1263 return (B_FALSE); 1264 } 1265 1266 /* 1267 * Add a property pair (name, string-value) into a property nvlist. 1268 */ 1269 static int 1270 add_prop_list(const char *propname, const char *propval, nvlist_t **props, 1271 boolean_t poolprop) 1272 { 1273 zpool_prop_t prop = ZPOOL_PROP_INVAL; 1274 nvlist_t *proplist; 1275 const char *normnm; 1276 const char *strval; 1277 1278 if (*props == NULL && 1279 nvlist_alloc(props, NV_UNIQUE_NAME, 0) != 0) { 1280 (void) fprintf(stderr, 1281 gettext("internal error: out of memory\n")); 1282 return (1); 1283 } 1284 1285 proplist = *props; 1286 1287 if (poolprop) { 1288 const char *vname = zpool_prop_to_name(ZPOOL_PROP_VERSION); 1289 const char *cname = 1290 zpool_prop_to_name(ZPOOL_PROP_COMPATIBILITY); 1291 1292 if ((prop = zpool_name_to_prop(propname)) == ZPOOL_PROP_INVAL && 1293 (!zpool_prop_feature(propname) && 1294 !zpool_prop_vdev(propname))) { 1295 (void) fprintf(stderr, gettext("property '%s' is " 1296 "not a valid pool or vdev property\n"), propname); 1297 return (2); 1298 } 1299 1300 /* 1301 * feature@ properties and version should not be specified 1302 * at the same time. 1303 */ 1304 if ((prop == ZPOOL_PROP_INVAL && zpool_prop_feature(propname) && 1305 nvlist_exists(proplist, vname)) || 1306 (prop == ZPOOL_PROP_VERSION && 1307 prop_list_contains_feature(proplist))) { 1308 (void) fprintf(stderr, gettext("'feature@' and " 1309 "'version' properties cannot be specified " 1310 "together\n")); 1311 return (2); 1312 } 1313 1314 /* 1315 * if version is specified, only "legacy" compatibility 1316 * may be requested 1317 */ 1318 if ((prop == ZPOOL_PROP_COMPATIBILITY && 1319 strcmp(propval, ZPOOL_COMPAT_LEGACY) != 0 && 1320 nvlist_exists(proplist, vname)) || 1321 (prop == ZPOOL_PROP_VERSION && 1322 nvlist_exists(proplist, cname) && 1323 strcmp(fnvlist_lookup_string(proplist, cname), 1324 ZPOOL_COMPAT_LEGACY) != 0)) { 1325 (void) fprintf(stderr, gettext("when 'version' is " 1326 "specified, the 'compatibility' feature may only " 1327 "be set to '" ZPOOL_COMPAT_LEGACY "'\n")); 1328 return (2); 1329 } 1330 1331 if (zpool_prop_feature(propname) || zpool_prop_vdev(propname)) 1332 normnm = propname; 1333 else 1334 normnm = zpool_prop_to_name(prop); 1335 } else { 1336 zfs_prop_t fsprop = zfs_name_to_prop(propname); 1337 1338 if (zfs_prop_valid_for_type(fsprop, ZFS_TYPE_FILESYSTEM, 1339 B_FALSE)) { 1340 normnm = zfs_prop_to_name(fsprop); 1341 } else if (zfs_prop_user(propname) || 1342 zfs_prop_userquota(propname)) { 1343 normnm = propname; 1344 } else { 1345 (void) fprintf(stderr, gettext("property '%s' is " 1346 "not a valid filesystem property\n"), propname); 1347 return (2); 1348 } 1349 } 1350 1351 if (nvlist_lookup_string(proplist, normnm, &strval) == 0 && 1352 prop != ZPOOL_PROP_CACHEFILE) { 1353 (void) fprintf(stderr, gettext("property '%s' " 1354 "specified multiple times\n"), propname); 1355 return (2); 1356 } 1357 1358 if (nvlist_add_string(proplist, normnm, propval) != 0) { 1359 (void) fprintf(stderr, gettext("internal " 1360 "error: out of memory\n")); 1361 return (1); 1362 } 1363 1364 return (0); 1365 } 1366 1367 /* 1368 * Set a default property pair (name, string-value) in a property nvlist 1369 */ 1370 static int 1371 add_prop_list_default(const char *propname, const char *propval, 1372 nvlist_t **props) 1373 { 1374 const char *pval; 1375 1376 if (nvlist_lookup_string(*props, propname, &pval) == 0) 1377 return (0); 1378 1379 return (add_prop_list(propname, propval, props, B_TRUE)); 1380 } 1381 1382 /* 1383 * zpool add [-afgLnP] [-o property=value] <pool> <vdev> ... 1384 * 1385 * -a Disable the ashift validation checks 1386 * -f Force addition of devices, even if they appear in use 1387 * -g Display guid for individual vdev name. 1388 * -L Follow links when resolving vdev path name. 1389 * -n Do not add the devices, but display the resulting layout if 1390 * they were to be added. 1391 * -o Set property=value. 1392 * -P Display full path for vdev name. 1393 * 1394 * Adds the given vdevs to 'pool'. As with create, the bulk of this work is 1395 * handled by make_root_vdev(), which constructs the nvlist needed to pass to 1396 * libzfs. 1397 */ 1398 int 1399 zpool_do_add(int argc, char **argv) 1400 { 1401 boolean_t check_replication = B_TRUE; 1402 boolean_t check_inuse = B_TRUE; 1403 boolean_t dryrun = B_FALSE; 1404 boolean_t check_ashift = B_TRUE; 1405 boolean_t force = B_FALSE; 1406 int name_flags = 0; 1407 int c; 1408 nvlist_t *nvroot; 1409 char *poolname; 1410 int ret; 1411 zpool_handle_t *zhp; 1412 nvlist_t *config; 1413 nvlist_t *props = NULL; 1414 char *propval; 1415 1416 struct option long_options[] = { 1417 {"allow-in-use", no_argument, NULL, ZPOOL_OPTION_ALLOW_INUSE}, 1418 {"allow-replication-mismatch", no_argument, NULL, 1419 ZPOOL_OPTION_ALLOW_REPLICATION_MISMATCH}, 1420 {"allow-ashift-mismatch", no_argument, NULL, 1421 ZPOOL_OPTION_ALLOW_ASHIFT_MISMATCH}, 1422 {0, 0, 0, 0} 1423 }; 1424 1425 /* check options */ 1426 while ((c = getopt_long(argc, argv, "fgLno:P", long_options, NULL)) 1427 != -1) { 1428 switch (c) { 1429 case 'f': 1430 force = B_TRUE; 1431 break; 1432 case 'g': 1433 name_flags |= VDEV_NAME_GUID; 1434 break; 1435 case 'L': 1436 name_flags |= VDEV_NAME_FOLLOW_LINKS; 1437 break; 1438 case 'n': 1439 dryrun = B_TRUE; 1440 break; 1441 case 'o': 1442 if ((propval = strchr(optarg, '=')) == NULL) { 1443 (void) fprintf(stderr, gettext("missing " 1444 "'=' for -o option\n")); 1445 usage(B_FALSE); 1446 } 1447 *propval = '\0'; 1448 propval++; 1449 1450 if ((strcmp(optarg, ZPOOL_CONFIG_ASHIFT) != 0) || 1451 (add_prop_list(optarg, propval, &props, B_TRUE))) 1452 usage(B_FALSE); 1453 break; 1454 case 'P': 1455 name_flags |= VDEV_NAME_PATH; 1456 break; 1457 case ZPOOL_OPTION_ALLOW_INUSE: 1458 check_inuse = B_FALSE; 1459 break; 1460 case ZPOOL_OPTION_ALLOW_REPLICATION_MISMATCH: 1461 check_replication = B_FALSE; 1462 break; 1463 case ZPOOL_OPTION_ALLOW_ASHIFT_MISMATCH: 1464 check_ashift = B_FALSE; 1465 break; 1466 case '?': 1467 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1468 optopt); 1469 usage(B_FALSE); 1470 } 1471 } 1472 1473 argc -= optind; 1474 argv += optind; 1475 1476 /* get pool name and check number of arguments */ 1477 if (argc < 1) { 1478 (void) fprintf(stderr, gettext("missing pool name argument\n")); 1479 usage(B_FALSE); 1480 } 1481 if (argc < 2) { 1482 (void) fprintf(stderr, gettext("missing vdev specification\n")); 1483 usage(B_FALSE); 1484 } 1485 1486 if (force) { 1487 if (!check_inuse || !check_replication || !check_ashift) { 1488 (void) fprintf(stderr, gettext("'-f' option is not " 1489 "allowed with '--allow-replication-mismatch', " 1490 "'--allow-ashift-mismatch', or " 1491 "'--allow-in-use'\n")); 1492 usage(B_FALSE); 1493 } 1494 check_inuse = B_FALSE; 1495 check_replication = B_FALSE; 1496 check_ashift = B_FALSE; 1497 } 1498 1499 poolname = argv[0]; 1500 1501 argc--; 1502 argv++; 1503 1504 if ((zhp = zpool_open(g_zfs, poolname)) == NULL) 1505 return (1); 1506 1507 if ((config = zpool_get_config(zhp, NULL)) == NULL) { 1508 (void) fprintf(stderr, gettext("pool '%s' is unavailable\n"), 1509 poolname); 1510 zpool_close(zhp); 1511 return (1); 1512 } 1513 1514 /* unless manually specified use "ashift" pool property (if set) */ 1515 if (!nvlist_exists(props, ZPOOL_CONFIG_ASHIFT)) { 1516 int intval; 1517 zprop_source_t src; 1518 char strval[ZPOOL_MAXPROPLEN]; 1519 1520 intval = zpool_get_prop_int(zhp, ZPOOL_PROP_ASHIFT, &src); 1521 if (src != ZPROP_SRC_DEFAULT) { 1522 (void) sprintf(strval, "%" PRId32, intval); 1523 verify(add_prop_list(ZPOOL_CONFIG_ASHIFT, strval, 1524 &props, B_TRUE) == 0); 1525 } 1526 } 1527 1528 /* pass off to make_root_vdev for processing */ 1529 nvroot = make_root_vdev(zhp, props, !check_inuse, 1530 check_replication, B_FALSE, dryrun, argc, argv); 1531 if (nvroot == NULL) { 1532 zpool_close(zhp); 1533 return (1); 1534 } 1535 1536 if (dryrun) { 1537 nvlist_t *poolnvroot; 1538 nvlist_t **l2child, **sparechild; 1539 uint_t l2children, sparechildren, c; 1540 char *vname; 1541 boolean_t hadcache = B_FALSE, hadspare = B_FALSE; 1542 1543 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE, 1544 &poolnvroot) == 0); 1545 1546 (void) printf(gettext("would update '%s' to the following " 1547 "configuration:\n\n"), zpool_get_name(zhp)); 1548 1549 /* print original main pool and new tree */ 1550 print_vdev_tree(zhp, poolname, poolnvroot, 0, "", 1551 name_flags | VDEV_NAME_TYPE_ID); 1552 print_vdev_tree(zhp, NULL, nvroot, 0, "", name_flags); 1553 1554 /* print other classes: 'dedup', 'special', and 'log' */ 1555 if (zfs_special_devs(poolnvroot, VDEV_ALLOC_BIAS_DEDUP)) { 1556 print_vdev_tree(zhp, "dedup", poolnvroot, 0, 1557 VDEV_ALLOC_BIAS_DEDUP, name_flags); 1558 print_vdev_tree(zhp, NULL, nvroot, 0, 1559 VDEV_ALLOC_BIAS_DEDUP, name_flags); 1560 } else if (zfs_special_devs(nvroot, VDEV_ALLOC_BIAS_DEDUP)) { 1561 print_vdev_tree(zhp, "dedup", nvroot, 0, 1562 VDEV_ALLOC_BIAS_DEDUP, name_flags); 1563 } 1564 1565 if (zfs_special_devs(poolnvroot, VDEV_ALLOC_BIAS_SPECIAL)) { 1566 print_vdev_tree(zhp, "special", poolnvroot, 0, 1567 VDEV_ALLOC_BIAS_SPECIAL, name_flags); 1568 print_vdev_tree(zhp, NULL, nvroot, 0, 1569 VDEV_ALLOC_BIAS_SPECIAL, name_flags); 1570 } else if (zfs_special_devs(nvroot, VDEV_ALLOC_BIAS_SPECIAL)) { 1571 print_vdev_tree(zhp, "special", nvroot, 0, 1572 VDEV_ALLOC_BIAS_SPECIAL, name_flags); 1573 } 1574 1575 if (num_logs(poolnvroot) > 0) { 1576 print_vdev_tree(zhp, "logs", poolnvroot, 0, 1577 VDEV_ALLOC_BIAS_LOG, name_flags); 1578 print_vdev_tree(zhp, NULL, nvroot, 0, 1579 VDEV_ALLOC_BIAS_LOG, name_flags); 1580 } else if (num_logs(nvroot) > 0) { 1581 print_vdev_tree(zhp, "logs", nvroot, 0, 1582 VDEV_ALLOC_BIAS_LOG, name_flags); 1583 } 1584 1585 /* Do the same for the caches */ 1586 if (nvlist_lookup_nvlist_array(poolnvroot, ZPOOL_CONFIG_L2CACHE, 1587 &l2child, &l2children) == 0 && l2children) { 1588 hadcache = B_TRUE; 1589 (void) printf(gettext("\tcache\n")); 1590 for (c = 0; c < l2children; c++) { 1591 vname = zpool_vdev_name(g_zfs, NULL, 1592 l2child[c], name_flags); 1593 (void) printf("\t %s\n", vname); 1594 free(vname); 1595 } 1596 } 1597 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_L2CACHE, 1598 &l2child, &l2children) == 0 && l2children) { 1599 if (!hadcache) 1600 (void) printf(gettext("\tcache\n")); 1601 for (c = 0; c < l2children; c++) { 1602 vname = zpool_vdev_name(g_zfs, NULL, 1603 l2child[c], name_flags); 1604 (void) printf("\t %s\n", vname); 1605 free(vname); 1606 } 1607 } 1608 /* And finally the spares */ 1609 if (nvlist_lookup_nvlist_array(poolnvroot, ZPOOL_CONFIG_SPARES, 1610 &sparechild, &sparechildren) == 0 && sparechildren > 0) { 1611 hadspare = B_TRUE; 1612 (void) printf(gettext("\tspares\n")); 1613 for (c = 0; c < sparechildren; c++) { 1614 vname = zpool_vdev_name(g_zfs, NULL, 1615 sparechild[c], name_flags); 1616 (void) printf("\t %s\n", vname); 1617 free(vname); 1618 } 1619 } 1620 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES, 1621 &sparechild, &sparechildren) == 0 && sparechildren > 0) { 1622 if (!hadspare) 1623 (void) printf(gettext("\tspares\n")); 1624 for (c = 0; c < sparechildren; c++) { 1625 vname = zpool_vdev_name(g_zfs, NULL, 1626 sparechild[c], name_flags); 1627 (void) printf("\t %s\n", vname); 1628 free(vname); 1629 } 1630 } 1631 1632 ret = 0; 1633 } else { 1634 ret = (zpool_add(zhp, nvroot, check_ashift) != 0); 1635 } 1636 1637 nvlist_free(props); 1638 nvlist_free(nvroot); 1639 zpool_close(zhp); 1640 1641 return (ret); 1642 } 1643 1644 /* 1645 * zpool remove [-npsw] <pool> <vdev> ... 1646 * 1647 * Removes the given vdev from the pool. 1648 */ 1649 int 1650 zpool_do_remove(int argc, char **argv) 1651 { 1652 char *poolname; 1653 int i, ret = 0; 1654 zpool_handle_t *zhp = NULL; 1655 boolean_t stop = B_FALSE; 1656 int c; 1657 boolean_t noop = B_FALSE; 1658 boolean_t parsable = B_FALSE; 1659 boolean_t wait = B_FALSE; 1660 1661 /* check options */ 1662 while ((c = getopt(argc, argv, "npsw")) != -1) { 1663 switch (c) { 1664 case 'n': 1665 noop = B_TRUE; 1666 break; 1667 case 'p': 1668 parsable = B_TRUE; 1669 break; 1670 case 's': 1671 stop = B_TRUE; 1672 break; 1673 case 'w': 1674 wait = B_TRUE; 1675 break; 1676 case '?': 1677 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1678 optopt); 1679 usage(B_FALSE); 1680 } 1681 } 1682 1683 argc -= optind; 1684 argv += optind; 1685 1686 /* get pool name and check number of arguments */ 1687 if (argc < 1) { 1688 (void) fprintf(stderr, gettext("missing pool name argument\n")); 1689 usage(B_FALSE); 1690 } 1691 1692 poolname = argv[0]; 1693 1694 if ((zhp = zpool_open(g_zfs, poolname)) == NULL) 1695 return (1); 1696 1697 if (stop && noop) { 1698 zpool_close(zhp); 1699 (void) fprintf(stderr, gettext("stop request ignored\n")); 1700 return (0); 1701 } 1702 1703 if (stop) { 1704 if (argc > 1) { 1705 (void) fprintf(stderr, gettext("too many arguments\n")); 1706 usage(B_FALSE); 1707 } 1708 if (zpool_vdev_remove_cancel(zhp) != 0) 1709 ret = 1; 1710 if (wait) { 1711 (void) fprintf(stderr, gettext("invalid option " 1712 "combination: -w cannot be used with -s\n")); 1713 usage(B_FALSE); 1714 } 1715 } else { 1716 if (argc < 2) { 1717 (void) fprintf(stderr, gettext("missing device\n")); 1718 usage(B_FALSE); 1719 } 1720 1721 for (i = 1; i < argc; i++) { 1722 if (noop) { 1723 uint64_t size; 1724 1725 if (zpool_vdev_indirect_size(zhp, argv[i], 1726 &size) != 0) { 1727 ret = 1; 1728 break; 1729 } 1730 if (parsable) { 1731 (void) printf("%s %llu\n", 1732 argv[i], (unsigned long long)size); 1733 } else { 1734 char valstr[32]; 1735 zfs_nicenum(size, valstr, 1736 sizeof (valstr)); 1737 (void) printf("Memory that will be " 1738 "used after removing %s: %s\n", 1739 argv[i], valstr); 1740 } 1741 } else { 1742 if (zpool_vdev_remove(zhp, argv[i]) != 0) 1743 ret = 1; 1744 } 1745 } 1746 1747 if (ret == 0 && wait) 1748 ret = zpool_wait(zhp, ZPOOL_WAIT_REMOVE); 1749 } 1750 zpool_close(zhp); 1751 1752 return (ret); 1753 } 1754 1755 /* 1756 * Return 1 if a vdev is active (being used in a pool) 1757 * Return 0 if a vdev is inactive (offlined or faulted, or not in active pool) 1758 * 1759 * This is useful for checking if a disk in an active pool is offlined or 1760 * faulted. 1761 */ 1762 static int 1763 vdev_is_active(char *vdev_path) 1764 { 1765 int fd; 1766 fd = open(vdev_path, O_EXCL); 1767 if (fd < 0) { 1768 return (1); /* cant open O_EXCL - disk is active */ 1769 } 1770 1771 close(fd); 1772 return (0); /* disk is inactive in the pool */ 1773 } 1774 1775 /* 1776 * zpool labelclear [-f] <vdev> 1777 * 1778 * -f Force clearing the label for the vdevs which are members of 1779 * the exported or foreign pools. 1780 * 1781 * Verifies that the vdev is not active and zeros out the label information 1782 * on the device. 1783 */ 1784 int 1785 zpool_do_labelclear(int argc, char **argv) 1786 { 1787 char vdev[MAXPATHLEN]; 1788 char *name = NULL; 1789 int c, fd = -1, ret = 0; 1790 nvlist_t *config; 1791 pool_state_t state; 1792 boolean_t inuse = B_FALSE; 1793 boolean_t force = B_FALSE; 1794 1795 /* check options */ 1796 while ((c = getopt(argc, argv, "f")) != -1) { 1797 switch (c) { 1798 case 'f': 1799 force = B_TRUE; 1800 break; 1801 default: 1802 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1803 optopt); 1804 usage(B_FALSE); 1805 } 1806 } 1807 1808 argc -= optind; 1809 argv += optind; 1810 1811 /* get vdev name */ 1812 if (argc < 1) { 1813 (void) fprintf(stderr, gettext("missing vdev name\n")); 1814 usage(B_FALSE); 1815 } 1816 if (argc > 1) { 1817 (void) fprintf(stderr, gettext("too many arguments\n")); 1818 usage(B_FALSE); 1819 } 1820 1821 (void) strlcpy(vdev, argv[0], sizeof (vdev)); 1822 1823 /* 1824 * If we cannot open an absolute path, we quit. 1825 * Otherwise if the provided vdev name doesn't point to a file, 1826 * try prepending expected disk paths and partition numbers. 1827 */ 1828 if ((fd = open(vdev, O_RDWR)) < 0) { 1829 int error; 1830 if (vdev[0] == '/') { 1831 (void) fprintf(stderr, gettext("failed to open " 1832 "%s: %s\n"), vdev, strerror(errno)); 1833 return (1); 1834 } 1835 1836 error = zfs_resolve_shortname(argv[0], vdev, MAXPATHLEN); 1837 if (error == 0 && zfs_dev_is_whole_disk(vdev)) { 1838 if (zfs_append_partition(vdev, MAXPATHLEN) == -1) 1839 error = ENOENT; 1840 } 1841 1842 if (error || ((fd = open(vdev, O_RDWR)) < 0)) { 1843 if (errno == ENOENT) { 1844 (void) fprintf(stderr, gettext( 1845 "failed to find device %s, try " 1846 "specifying absolute path instead\n"), 1847 argv[0]); 1848 return (1); 1849 } 1850 1851 (void) fprintf(stderr, gettext("failed to open %s:" 1852 " %s\n"), vdev, strerror(errno)); 1853 return (1); 1854 } 1855 } 1856 1857 /* 1858 * Flush all dirty pages for the block device. This should not be 1859 * fatal when the device does not support BLKFLSBUF as would be the 1860 * case for a file vdev. 1861 */ 1862 if ((zfs_dev_flush(fd) != 0) && (errno != ENOTTY)) 1863 (void) fprintf(stderr, gettext("failed to invalidate " 1864 "cache for %s: %s\n"), vdev, strerror(errno)); 1865 1866 if (zpool_read_label(fd, &config, NULL) != 0) { 1867 (void) fprintf(stderr, 1868 gettext("failed to read label from %s\n"), vdev); 1869 ret = 1; 1870 goto errout; 1871 } 1872 nvlist_free(config); 1873 1874 ret = zpool_in_use(g_zfs, fd, &state, &name, &inuse); 1875 if (ret != 0) { 1876 (void) fprintf(stderr, 1877 gettext("failed to check state for %s\n"), vdev); 1878 ret = 1; 1879 goto errout; 1880 } 1881 1882 if (!inuse) 1883 goto wipe_label; 1884 1885 switch (state) { 1886 default: 1887 case POOL_STATE_ACTIVE: 1888 case POOL_STATE_SPARE: 1889 case POOL_STATE_L2CACHE: 1890 /* 1891 * We allow the user to call 'zpool offline -f' 1892 * on an offlined disk in an active pool. We can check if 1893 * the disk is online by calling vdev_is_active(). 1894 */ 1895 if (force && !vdev_is_active(vdev)) 1896 break; 1897 1898 (void) fprintf(stderr, gettext( 1899 "%s is a member (%s) of pool \"%s\""), 1900 vdev, zpool_pool_state_to_name(state), name); 1901 1902 if (force) { 1903 (void) fprintf(stderr, gettext( 1904 ". Offline the disk first to clear its label.")); 1905 } 1906 printf("\n"); 1907 ret = 1; 1908 goto errout; 1909 1910 case POOL_STATE_EXPORTED: 1911 if (force) 1912 break; 1913 (void) fprintf(stderr, gettext( 1914 "use '-f' to override the following error:\n" 1915 "%s is a member of exported pool \"%s\"\n"), 1916 vdev, name); 1917 ret = 1; 1918 goto errout; 1919 1920 case POOL_STATE_POTENTIALLY_ACTIVE: 1921 if (force) 1922 break; 1923 (void) fprintf(stderr, gettext( 1924 "use '-f' to override the following error:\n" 1925 "%s is a member of potentially active pool \"%s\"\n"), 1926 vdev, name); 1927 ret = 1; 1928 goto errout; 1929 1930 case POOL_STATE_DESTROYED: 1931 /* inuse should never be set for a destroyed pool */ 1932 assert(0); 1933 break; 1934 } 1935 1936 wipe_label: 1937 ret = zpool_clear_label(fd); 1938 if (ret != 0) { 1939 (void) fprintf(stderr, 1940 gettext("failed to clear label for %s\n"), vdev); 1941 } 1942 1943 errout: 1944 free(name); 1945 (void) close(fd); 1946 1947 return (ret); 1948 } 1949 1950 /* 1951 * zpool create [-fnd] [-o property=value] ... 1952 * [-O file-system-property=value] ... 1953 * [-R root] [-m mountpoint] <pool> <dev> ... 1954 * 1955 * -f Force creation, even if devices appear in use 1956 * -n Do not create the pool, but display the resulting layout if it 1957 * were to be created. 1958 * -R Create a pool under an alternate root 1959 * -m Set default mountpoint for the root dataset. By default it's 1960 * '/<pool>' 1961 * -o Set property=value. 1962 * -o Set feature@feature=enabled|disabled. 1963 * -d Don't automatically enable all supported pool features 1964 * (individual features can be enabled with -o). 1965 * -O Set fsproperty=value in the pool's root file system 1966 * 1967 * Creates the named pool according to the given vdev specification. The 1968 * bulk of the vdev processing is done in make_root_vdev() in zpool_vdev.c. 1969 * Once we get the nvlist back from make_root_vdev(), we either print out the 1970 * contents (if '-n' was specified), or pass it to libzfs to do the creation. 1971 */ 1972 int 1973 zpool_do_create(int argc, char **argv) 1974 { 1975 boolean_t force = B_FALSE; 1976 boolean_t dryrun = B_FALSE; 1977 boolean_t enable_pool_features = B_TRUE; 1978 1979 int c; 1980 nvlist_t *nvroot = NULL; 1981 char *poolname; 1982 char *tname = NULL; 1983 int ret = 1; 1984 char *altroot = NULL; 1985 char *compat = NULL; 1986 char *mountpoint = NULL; 1987 nvlist_t *fsprops = NULL; 1988 nvlist_t *props = NULL; 1989 char *propval; 1990 1991 /* check options */ 1992 while ((c = getopt(argc, argv, ":fndR:m:o:O:t:")) != -1) { 1993 switch (c) { 1994 case 'f': 1995 force = B_TRUE; 1996 break; 1997 case 'n': 1998 dryrun = B_TRUE; 1999 break; 2000 case 'd': 2001 enable_pool_features = B_FALSE; 2002 break; 2003 case 'R': 2004 altroot = optarg; 2005 if (add_prop_list(zpool_prop_to_name( 2006 ZPOOL_PROP_ALTROOT), optarg, &props, B_TRUE)) 2007 goto errout; 2008 if (add_prop_list_default(zpool_prop_to_name( 2009 ZPOOL_PROP_CACHEFILE), "none", &props)) 2010 goto errout; 2011 break; 2012 case 'm': 2013 /* Equivalent to -O mountpoint=optarg */ 2014 mountpoint = optarg; 2015 break; 2016 case 'o': 2017 if ((propval = strchr(optarg, '=')) == NULL) { 2018 (void) fprintf(stderr, gettext("missing " 2019 "'=' for -o option\n")); 2020 goto errout; 2021 } 2022 *propval = '\0'; 2023 propval++; 2024 2025 if (add_prop_list(optarg, propval, &props, B_TRUE)) 2026 goto errout; 2027 2028 /* 2029 * If the user is creating a pool that doesn't support 2030 * feature flags, don't enable any features. 2031 */ 2032 if (zpool_name_to_prop(optarg) == ZPOOL_PROP_VERSION) { 2033 char *end; 2034 u_longlong_t ver; 2035 2036 ver = strtoull(propval, &end, 0); 2037 if (*end == '\0' && 2038 ver < SPA_VERSION_FEATURES) { 2039 enable_pool_features = B_FALSE; 2040 } 2041 } 2042 if (zpool_name_to_prop(optarg) == ZPOOL_PROP_ALTROOT) 2043 altroot = propval; 2044 if (zpool_name_to_prop(optarg) == 2045 ZPOOL_PROP_COMPATIBILITY) 2046 compat = propval; 2047 break; 2048 case 'O': 2049 if ((propval = strchr(optarg, '=')) == NULL) { 2050 (void) fprintf(stderr, gettext("missing " 2051 "'=' for -O option\n")); 2052 goto errout; 2053 } 2054 *propval = '\0'; 2055 propval++; 2056 2057 /* 2058 * Mountpoints are checked and then added later. 2059 * Uniquely among properties, they can be specified 2060 * more than once, to avoid conflict with -m. 2061 */ 2062 if (0 == strcmp(optarg, 2063 zfs_prop_to_name(ZFS_PROP_MOUNTPOINT))) { 2064 mountpoint = propval; 2065 } else if (add_prop_list(optarg, propval, &fsprops, 2066 B_FALSE)) { 2067 goto errout; 2068 } 2069 break; 2070 case 't': 2071 /* 2072 * Sanity check temporary pool name. 2073 */ 2074 if (strchr(optarg, '/') != NULL) { 2075 (void) fprintf(stderr, gettext("cannot create " 2076 "'%s': invalid character '/' in temporary " 2077 "name\n"), optarg); 2078 (void) fprintf(stderr, gettext("use 'zfs " 2079 "create' to create a dataset\n")); 2080 goto errout; 2081 } 2082 2083 if (add_prop_list(zpool_prop_to_name( 2084 ZPOOL_PROP_TNAME), optarg, &props, B_TRUE)) 2085 goto errout; 2086 if (add_prop_list_default(zpool_prop_to_name( 2087 ZPOOL_PROP_CACHEFILE), "none", &props)) 2088 goto errout; 2089 tname = optarg; 2090 break; 2091 case ':': 2092 (void) fprintf(stderr, gettext("missing argument for " 2093 "'%c' option\n"), optopt); 2094 goto badusage; 2095 case '?': 2096 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2097 optopt); 2098 goto badusage; 2099 } 2100 } 2101 2102 argc -= optind; 2103 argv += optind; 2104 2105 /* get pool name and check number of arguments */ 2106 if (argc < 1) { 2107 (void) fprintf(stderr, gettext("missing pool name argument\n")); 2108 goto badusage; 2109 } 2110 if (argc < 2) { 2111 (void) fprintf(stderr, gettext("missing vdev specification\n")); 2112 goto badusage; 2113 } 2114 2115 poolname = argv[0]; 2116 2117 /* 2118 * As a special case, check for use of '/' in the name, and direct the 2119 * user to use 'zfs create' instead. 2120 */ 2121 if (strchr(poolname, '/') != NULL) { 2122 (void) fprintf(stderr, gettext("cannot create '%s': invalid " 2123 "character '/' in pool name\n"), poolname); 2124 (void) fprintf(stderr, gettext("use 'zfs create' to " 2125 "create a dataset\n")); 2126 goto errout; 2127 } 2128 2129 /* pass off to make_root_vdev for bulk processing */ 2130 nvroot = make_root_vdev(NULL, props, force, !force, B_FALSE, dryrun, 2131 argc - 1, argv + 1); 2132 if (nvroot == NULL) 2133 goto errout; 2134 2135 /* make_root_vdev() allows 0 toplevel children if there are spares */ 2136 if (!zfs_allocatable_devs(nvroot)) { 2137 (void) fprintf(stderr, gettext("invalid vdev " 2138 "specification: at least one toplevel vdev must be " 2139 "specified\n")); 2140 goto errout; 2141 } 2142 2143 if (altroot != NULL && altroot[0] != '/') { 2144 (void) fprintf(stderr, gettext("invalid alternate root '%s': " 2145 "must be an absolute path\n"), altroot); 2146 goto errout; 2147 } 2148 2149 /* 2150 * Check the validity of the mountpoint and direct the user to use the 2151 * '-m' mountpoint option if it looks like its in use. 2152 */ 2153 if (mountpoint == NULL || 2154 (strcmp(mountpoint, ZFS_MOUNTPOINT_LEGACY) != 0 && 2155 strcmp(mountpoint, ZFS_MOUNTPOINT_NONE) != 0)) { 2156 char buf[MAXPATHLEN]; 2157 DIR *dirp; 2158 2159 if (mountpoint && mountpoint[0] != '/') { 2160 (void) fprintf(stderr, gettext("invalid mountpoint " 2161 "'%s': must be an absolute path, 'legacy', or " 2162 "'none'\n"), mountpoint); 2163 goto errout; 2164 } 2165 2166 if (mountpoint == NULL) { 2167 if (altroot != NULL) 2168 (void) snprintf(buf, sizeof (buf), "%s/%s", 2169 altroot, poolname); 2170 else 2171 (void) snprintf(buf, sizeof (buf), "/%s", 2172 poolname); 2173 } else { 2174 if (altroot != NULL) 2175 (void) snprintf(buf, sizeof (buf), "%s%s", 2176 altroot, mountpoint); 2177 else 2178 (void) snprintf(buf, sizeof (buf), "%s", 2179 mountpoint); 2180 } 2181 2182 if ((dirp = opendir(buf)) == NULL && errno != ENOENT) { 2183 (void) fprintf(stderr, gettext("mountpoint '%s' : " 2184 "%s\n"), buf, strerror(errno)); 2185 (void) fprintf(stderr, gettext("use '-m' " 2186 "option to provide a different default\n")); 2187 goto errout; 2188 } else if (dirp) { 2189 int count = 0; 2190 2191 while (count < 3 && readdir(dirp) != NULL) 2192 count++; 2193 (void) closedir(dirp); 2194 2195 if (count > 2) { 2196 (void) fprintf(stderr, gettext("mountpoint " 2197 "'%s' exists and is not empty\n"), buf); 2198 (void) fprintf(stderr, gettext("use '-m' " 2199 "option to provide a " 2200 "different default\n")); 2201 goto errout; 2202 } 2203 } 2204 } 2205 2206 /* 2207 * Now that the mountpoint's validity has been checked, ensure that 2208 * the property is set appropriately prior to creating the pool. 2209 */ 2210 if (mountpoint != NULL) { 2211 ret = add_prop_list(zfs_prop_to_name(ZFS_PROP_MOUNTPOINT), 2212 mountpoint, &fsprops, B_FALSE); 2213 if (ret != 0) 2214 goto errout; 2215 } 2216 2217 ret = 1; 2218 if (dryrun) { 2219 /* 2220 * For a dry run invocation, print out a basic message and run 2221 * through all the vdevs in the list and print out in an 2222 * appropriate hierarchy. 2223 */ 2224 (void) printf(gettext("would create '%s' with the " 2225 "following layout:\n\n"), poolname); 2226 2227 print_vdev_tree(NULL, poolname, nvroot, 0, "", 0); 2228 print_vdev_tree(NULL, "dedup", nvroot, 0, 2229 VDEV_ALLOC_BIAS_DEDUP, 0); 2230 print_vdev_tree(NULL, "special", nvroot, 0, 2231 VDEV_ALLOC_BIAS_SPECIAL, 0); 2232 print_vdev_tree(NULL, "logs", nvroot, 0, 2233 VDEV_ALLOC_BIAS_LOG, 0); 2234 print_cache_list(nvroot, 0); 2235 print_spare_list(nvroot, 0); 2236 2237 ret = 0; 2238 } else { 2239 /* 2240 * Load in feature set. 2241 * Note: if compatibility property not given, we'll have 2242 * NULL, which means 'all features'. 2243 */ 2244 boolean_t requested_features[SPA_FEATURES]; 2245 if (zpool_do_load_compat(compat, requested_features) != 2246 ZPOOL_COMPATIBILITY_OK) 2247 goto errout; 2248 2249 /* 2250 * props contains list of features to enable. 2251 * For each feature: 2252 * - remove it if feature@name=disabled 2253 * - leave it there if feature@name=enabled 2254 * - add it if: 2255 * - enable_pool_features (ie: no '-d' or '-o version') 2256 * - it's supported by the kernel module 2257 * - it's in the requested feature set 2258 * - warn if it's enabled but not in compat 2259 */ 2260 for (spa_feature_t i = 0; i < SPA_FEATURES; i++) { 2261 char propname[MAXPATHLEN]; 2262 const char *propval; 2263 zfeature_info_t *feat = &spa_feature_table[i]; 2264 2265 (void) snprintf(propname, sizeof (propname), 2266 "feature@%s", feat->fi_uname); 2267 2268 if (!nvlist_lookup_string(props, propname, &propval)) { 2269 if (strcmp(propval, 2270 ZFS_FEATURE_DISABLED) == 0) { 2271 (void) nvlist_remove_all(props, 2272 propname); 2273 } else if (strcmp(propval, 2274 ZFS_FEATURE_ENABLED) == 0 && 2275 !requested_features[i]) { 2276 (void) fprintf(stderr, gettext( 2277 "Warning: feature \"%s\" enabled " 2278 "but is not in specified " 2279 "'compatibility' feature set.\n"), 2280 feat->fi_uname); 2281 } 2282 } else if ( 2283 enable_pool_features && 2284 feat->fi_zfs_mod_supported && 2285 requested_features[i]) { 2286 ret = add_prop_list(propname, 2287 ZFS_FEATURE_ENABLED, &props, B_TRUE); 2288 if (ret != 0) 2289 goto errout; 2290 } 2291 } 2292 2293 ret = 1; 2294 if (zpool_create(g_zfs, poolname, 2295 nvroot, props, fsprops) == 0) { 2296 zfs_handle_t *pool = zfs_open(g_zfs, 2297 tname ? tname : poolname, ZFS_TYPE_FILESYSTEM); 2298 if (pool != NULL) { 2299 if (zfs_mount(pool, NULL, 0) == 0) { 2300 ret = zfs_share(pool, NULL); 2301 zfs_commit_shares(NULL); 2302 } 2303 zfs_close(pool); 2304 } 2305 } else if (libzfs_errno(g_zfs) == EZFS_INVALIDNAME) { 2306 (void) fprintf(stderr, gettext("pool name may have " 2307 "been omitted\n")); 2308 } 2309 } 2310 2311 errout: 2312 nvlist_free(nvroot); 2313 nvlist_free(fsprops); 2314 nvlist_free(props); 2315 return (ret); 2316 badusage: 2317 nvlist_free(fsprops); 2318 nvlist_free(props); 2319 usage(B_FALSE); 2320 return (2); 2321 } 2322 2323 /* 2324 * zpool destroy <pool> 2325 * 2326 * -f Forcefully unmount any datasets 2327 * 2328 * Destroy the given pool. Automatically unmounts any datasets in the pool. 2329 */ 2330 int 2331 zpool_do_destroy(int argc, char **argv) 2332 { 2333 boolean_t force = B_FALSE; 2334 int c; 2335 char *pool; 2336 zpool_handle_t *zhp; 2337 int ret; 2338 2339 /* check options */ 2340 while ((c = getopt(argc, argv, "f")) != -1) { 2341 switch (c) { 2342 case 'f': 2343 force = B_TRUE; 2344 break; 2345 case '?': 2346 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2347 optopt); 2348 usage(B_FALSE); 2349 } 2350 } 2351 2352 argc -= optind; 2353 argv += optind; 2354 2355 /* check arguments */ 2356 if (argc < 1) { 2357 (void) fprintf(stderr, gettext("missing pool argument\n")); 2358 usage(B_FALSE); 2359 } 2360 if (argc > 1) { 2361 (void) fprintf(stderr, gettext("too many arguments\n")); 2362 usage(B_FALSE); 2363 } 2364 2365 pool = argv[0]; 2366 2367 if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL) { 2368 /* 2369 * As a special case, check for use of '/' in the name, and 2370 * direct the user to use 'zfs destroy' instead. 2371 */ 2372 if (strchr(pool, '/') != NULL) 2373 (void) fprintf(stderr, gettext("use 'zfs destroy' to " 2374 "destroy a dataset\n")); 2375 return (1); 2376 } 2377 2378 if (zpool_disable_datasets(zhp, force) != 0) { 2379 (void) fprintf(stderr, gettext("could not destroy '%s': " 2380 "could not unmount datasets\n"), zpool_get_name(zhp)); 2381 zpool_close(zhp); 2382 return (1); 2383 } 2384 2385 /* The history must be logged as part of the export */ 2386 log_history = B_FALSE; 2387 2388 ret = (zpool_destroy(zhp, history_str) != 0); 2389 2390 zpool_close(zhp); 2391 2392 return (ret); 2393 } 2394 2395 typedef struct export_cbdata { 2396 tpool_t *tpool; 2397 pthread_mutex_t mnttab_lock; 2398 boolean_t force; 2399 boolean_t hardforce; 2400 int retval; 2401 } export_cbdata_t; 2402 2403 2404 typedef struct { 2405 char *aea_poolname; 2406 export_cbdata_t *aea_cbdata; 2407 } async_export_args_t; 2408 2409 /* 2410 * Export one pool 2411 */ 2412 static int 2413 zpool_export_one(zpool_handle_t *zhp, void *data) 2414 { 2415 export_cbdata_t *cb = data; 2416 2417 /* 2418 * zpool_disable_datasets() is not thread-safe for mnttab access. 2419 * So we serialize access here for 'zpool export -a' parallel case. 2420 */ 2421 if (cb->tpool != NULL) 2422 pthread_mutex_lock(&cb->mnttab_lock); 2423 2424 int retval = zpool_disable_datasets(zhp, cb->force); 2425 2426 if (cb->tpool != NULL) 2427 pthread_mutex_unlock(&cb->mnttab_lock); 2428 2429 if (retval) 2430 return (1); 2431 2432 if (cb->hardforce) { 2433 if (zpool_export_force(zhp, history_str) != 0) 2434 return (1); 2435 } else if (zpool_export(zhp, cb->force, history_str) != 0) { 2436 return (1); 2437 } 2438 2439 return (0); 2440 } 2441 2442 /* 2443 * Asynchronous export request 2444 */ 2445 static void 2446 zpool_export_task(void *arg) 2447 { 2448 async_export_args_t *aea = arg; 2449 2450 zpool_handle_t *zhp = zpool_open(g_zfs, aea->aea_poolname); 2451 if (zhp != NULL) { 2452 int ret = zpool_export_one(zhp, aea->aea_cbdata); 2453 if (ret != 0) 2454 aea->aea_cbdata->retval = ret; 2455 zpool_close(zhp); 2456 } else { 2457 aea->aea_cbdata->retval = 1; 2458 } 2459 2460 free(aea->aea_poolname); 2461 free(aea); 2462 } 2463 2464 /* 2465 * Process an export request in parallel 2466 */ 2467 static int 2468 zpool_export_one_async(zpool_handle_t *zhp, void *data) 2469 { 2470 tpool_t *tpool = ((export_cbdata_t *)data)->tpool; 2471 async_export_args_t *aea = safe_malloc(sizeof (async_export_args_t)); 2472 2473 /* save pool name since zhp will go out of scope */ 2474 aea->aea_poolname = strdup(zpool_get_name(zhp)); 2475 aea->aea_cbdata = data; 2476 2477 /* ship off actual export to another thread */ 2478 if (tpool_dispatch(tpool, zpool_export_task, (void *)aea) != 0) 2479 return (errno); /* unlikely */ 2480 else 2481 return (0); 2482 } 2483 2484 /* 2485 * zpool export [-f] <pool> ... 2486 * 2487 * -a Export all pools 2488 * -f Forcefully unmount datasets 2489 * 2490 * Export the given pools. By default, the command will attempt to cleanly 2491 * unmount any active datasets within the pool. If the '-f' flag is specified, 2492 * then the datasets will be forcefully unmounted. 2493 */ 2494 int 2495 zpool_do_export(int argc, char **argv) 2496 { 2497 export_cbdata_t cb; 2498 boolean_t do_all = B_FALSE; 2499 boolean_t force = B_FALSE; 2500 boolean_t hardforce = B_FALSE; 2501 int c, ret; 2502 2503 /* check options */ 2504 while ((c = getopt(argc, argv, "afF")) != -1) { 2505 switch (c) { 2506 case 'a': 2507 do_all = B_TRUE; 2508 break; 2509 case 'f': 2510 force = B_TRUE; 2511 break; 2512 case 'F': 2513 hardforce = B_TRUE; 2514 break; 2515 case '?': 2516 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2517 optopt); 2518 usage(B_FALSE); 2519 } 2520 } 2521 2522 cb.force = force; 2523 cb.hardforce = hardforce; 2524 cb.tpool = NULL; 2525 cb.retval = 0; 2526 argc -= optind; 2527 argv += optind; 2528 2529 /* The history will be logged as part of the export itself */ 2530 log_history = B_FALSE; 2531 2532 if (do_all) { 2533 if (argc != 0) { 2534 (void) fprintf(stderr, gettext("too many arguments\n")); 2535 usage(B_FALSE); 2536 } 2537 2538 cb.tpool = tpool_create(1, 5 * sysconf(_SC_NPROCESSORS_ONLN), 2539 0, NULL); 2540 pthread_mutex_init(&cb.mnttab_lock, NULL); 2541 2542 /* Asynchronously call zpool_export_one using thread pool */ 2543 ret = for_each_pool(argc, argv, B_TRUE, NULL, ZFS_TYPE_POOL, 2544 B_FALSE, zpool_export_one_async, &cb); 2545 2546 tpool_wait(cb.tpool); 2547 tpool_destroy(cb.tpool); 2548 (void) pthread_mutex_destroy(&cb.mnttab_lock); 2549 2550 return (ret | cb.retval); 2551 } 2552 2553 /* check arguments */ 2554 if (argc < 1) { 2555 (void) fprintf(stderr, gettext("missing pool argument\n")); 2556 usage(B_FALSE); 2557 } 2558 2559 ret = for_each_pool(argc, argv, B_TRUE, NULL, ZFS_TYPE_POOL, 2560 B_FALSE, zpool_export_one, &cb); 2561 2562 return (ret); 2563 } 2564 2565 /* 2566 * Given a vdev configuration, determine the maximum width needed for the device 2567 * name column. 2568 */ 2569 static int 2570 max_width(zpool_handle_t *zhp, nvlist_t *nv, int depth, int max, 2571 int name_flags) 2572 { 2573 static const char *const subtypes[] = 2574 {ZPOOL_CONFIG_SPARES, ZPOOL_CONFIG_L2CACHE, ZPOOL_CONFIG_CHILDREN}; 2575 2576 char *name = zpool_vdev_name(g_zfs, zhp, nv, name_flags); 2577 max = MAX(strlen(name) + depth, max); 2578 free(name); 2579 2580 nvlist_t **child; 2581 uint_t children; 2582 for (size_t i = 0; i < ARRAY_SIZE(subtypes); ++i) 2583 if (nvlist_lookup_nvlist_array(nv, subtypes[i], 2584 &child, &children) == 0) 2585 for (uint_t c = 0; c < children; ++c) 2586 max = MAX(max_width(zhp, child[c], depth + 2, 2587 max, name_flags), max); 2588 2589 return (max); 2590 } 2591 2592 typedef struct status_cbdata { 2593 int cb_count; 2594 int cb_name_flags; 2595 int cb_namewidth; 2596 boolean_t cb_allpools; 2597 boolean_t cb_verbose; 2598 boolean_t cb_literal; 2599 boolean_t cb_explain; 2600 boolean_t cb_first; 2601 boolean_t cb_dedup_stats; 2602 boolean_t cb_print_unhealthy; 2603 boolean_t cb_print_status; 2604 boolean_t cb_print_slow_ios; 2605 boolean_t cb_print_dio_verify; 2606 boolean_t cb_print_vdev_init; 2607 boolean_t cb_print_vdev_trim; 2608 vdev_cmd_data_list_t *vcdl; 2609 boolean_t cb_print_power; 2610 boolean_t cb_json; 2611 boolean_t cb_flat_vdevs; 2612 nvlist_t *cb_jsobj; 2613 boolean_t cb_json_as_int; 2614 boolean_t cb_json_pool_key_guid; 2615 } status_cbdata_t; 2616 2617 /* Return 1 if string is NULL, empty, or whitespace; return 0 otherwise. */ 2618 static boolean_t 2619 is_blank_str(const char *str) 2620 { 2621 for (; str != NULL && *str != '\0'; ++str) 2622 if (!isblank(*str)) 2623 return (B_FALSE); 2624 return (B_TRUE); 2625 } 2626 2627 static void 2628 zpool_nvlist_cmd(vdev_cmd_data_list_t *vcdl, const char *pool, const char *path, 2629 nvlist_t *item) 2630 { 2631 vdev_cmd_data_t *data; 2632 int i, j, k = 1; 2633 char tmp[256]; 2634 const char *val; 2635 2636 for (i = 0; i < vcdl->count; i++) { 2637 if ((strcmp(vcdl->data[i].path, path) != 0) || 2638 (strcmp(vcdl->data[i].pool, pool) != 0)) 2639 continue; 2640 2641 data = &vcdl->data[i]; 2642 for (j = 0; j < vcdl->uniq_cols_cnt; j++) { 2643 val = NULL; 2644 for (int k = 0; k < data->cols_cnt; k++) { 2645 if (strcmp(data->cols[k], 2646 vcdl->uniq_cols[j]) == 0) { 2647 val = data->lines[k]; 2648 break; 2649 } 2650 } 2651 if (val == NULL || is_blank_str(val)) 2652 val = "-"; 2653 fnvlist_add_string(item, vcdl->uniq_cols[j], val); 2654 } 2655 2656 for (j = data->cols_cnt; j < data->lines_cnt; j++) { 2657 if (data->lines[j]) { 2658 snprintf(tmp, 256, "extra_%d", k++); 2659 fnvlist_add_string(item, tmp, 2660 data->lines[j]); 2661 } 2662 } 2663 break; 2664 } 2665 } 2666 2667 /* Print command output lines for specific vdev in a specific pool */ 2668 static void 2669 zpool_print_cmd(vdev_cmd_data_list_t *vcdl, const char *pool, const char *path) 2670 { 2671 vdev_cmd_data_t *data; 2672 int i, j; 2673 const char *val; 2674 2675 for (i = 0; i < vcdl->count; i++) { 2676 if ((strcmp(vcdl->data[i].path, path) != 0) || 2677 (strcmp(vcdl->data[i].pool, pool) != 0)) { 2678 /* Not the vdev we're looking for */ 2679 continue; 2680 } 2681 2682 data = &vcdl->data[i]; 2683 /* Print out all the output values for this vdev */ 2684 for (j = 0; j < vcdl->uniq_cols_cnt; j++) { 2685 val = NULL; 2686 /* Does this vdev have values for this column? */ 2687 for (int k = 0; k < data->cols_cnt; k++) { 2688 if (strcmp(data->cols[k], 2689 vcdl->uniq_cols[j]) == 0) { 2690 /* yes it does, record the value */ 2691 val = data->lines[k]; 2692 break; 2693 } 2694 } 2695 /* 2696 * Mark empty values with dashes to make output 2697 * awk-able. 2698 */ 2699 if (val == NULL || is_blank_str(val)) 2700 val = "-"; 2701 2702 printf("%*s", vcdl->uniq_cols_width[j], val); 2703 if (j < vcdl->uniq_cols_cnt - 1) 2704 fputs(" ", stdout); 2705 } 2706 2707 /* Print out any values that aren't in a column at the end */ 2708 for (j = data->cols_cnt; j < data->lines_cnt; j++) { 2709 /* Did we have any columns? If so print a spacer. */ 2710 if (vcdl->uniq_cols_cnt > 0) 2711 fputs(" ", stdout); 2712 2713 val = data->lines[j]; 2714 fputs(val ?: "", stdout); 2715 } 2716 break; 2717 } 2718 } 2719 2720 /* 2721 * Print vdev initialization status for leaves 2722 */ 2723 static void 2724 print_status_initialize(vdev_stat_t *vs, boolean_t verbose) 2725 { 2726 if (verbose) { 2727 if ((vs->vs_initialize_state == VDEV_INITIALIZE_ACTIVE || 2728 vs->vs_initialize_state == VDEV_INITIALIZE_SUSPENDED || 2729 vs->vs_initialize_state == VDEV_INITIALIZE_COMPLETE) && 2730 !vs->vs_scan_removing) { 2731 char zbuf[1024]; 2732 char tbuf[256]; 2733 2734 time_t t = vs->vs_initialize_action_time; 2735 int initialize_pct = 100; 2736 if (vs->vs_initialize_state != 2737 VDEV_INITIALIZE_COMPLETE) { 2738 initialize_pct = (vs->vs_initialize_bytes_done * 2739 100 / (vs->vs_initialize_bytes_est + 1)); 2740 } 2741 2742 (void) ctime_r(&t, tbuf); 2743 tbuf[24] = 0; 2744 2745 switch (vs->vs_initialize_state) { 2746 case VDEV_INITIALIZE_SUSPENDED: 2747 (void) snprintf(zbuf, sizeof (zbuf), ", %s %s", 2748 gettext("suspended, started at"), tbuf); 2749 break; 2750 case VDEV_INITIALIZE_ACTIVE: 2751 (void) snprintf(zbuf, sizeof (zbuf), ", %s %s", 2752 gettext("started at"), tbuf); 2753 break; 2754 case VDEV_INITIALIZE_COMPLETE: 2755 (void) snprintf(zbuf, sizeof (zbuf), ", %s %s", 2756 gettext("completed at"), tbuf); 2757 break; 2758 } 2759 2760 (void) printf(gettext(" (%d%% initialized%s)"), 2761 initialize_pct, zbuf); 2762 } else { 2763 (void) printf(gettext(" (uninitialized)")); 2764 } 2765 } else if (vs->vs_initialize_state == VDEV_INITIALIZE_ACTIVE) { 2766 (void) printf(gettext(" (initializing)")); 2767 } 2768 } 2769 2770 /* 2771 * Print vdev TRIM status for leaves 2772 */ 2773 static void 2774 print_status_trim(vdev_stat_t *vs, boolean_t verbose) 2775 { 2776 if (verbose) { 2777 if ((vs->vs_trim_state == VDEV_TRIM_ACTIVE || 2778 vs->vs_trim_state == VDEV_TRIM_SUSPENDED || 2779 vs->vs_trim_state == VDEV_TRIM_COMPLETE) && 2780 !vs->vs_scan_removing) { 2781 char zbuf[1024]; 2782 char tbuf[256]; 2783 2784 time_t t = vs->vs_trim_action_time; 2785 int trim_pct = 100; 2786 if (vs->vs_trim_state != VDEV_TRIM_COMPLETE) { 2787 trim_pct = (vs->vs_trim_bytes_done * 2788 100 / (vs->vs_trim_bytes_est + 1)); 2789 } 2790 2791 (void) ctime_r(&t, tbuf); 2792 tbuf[24] = 0; 2793 2794 switch (vs->vs_trim_state) { 2795 case VDEV_TRIM_SUSPENDED: 2796 (void) snprintf(zbuf, sizeof (zbuf), ", %s %s", 2797 gettext("suspended, started at"), tbuf); 2798 break; 2799 case VDEV_TRIM_ACTIVE: 2800 (void) snprintf(zbuf, sizeof (zbuf), ", %s %s", 2801 gettext("started at"), tbuf); 2802 break; 2803 case VDEV_TRIM_COMPLETE: 2804 (void) snprintf(zbuf, sizeof (zbuf), ", %s %s", 2805 gettext("completed at"), tbuf); 2806 break; 2807 } 2808 2809 (void) printf(gettext(" (%d%% trimmed%s)"), 2810 trim_pct, zbuf); 2811 } else if (vs->vs_trim_notsup) { 2812 (void) printf(gettext(" (trim unsupported)")); 2813 } else { 2814 (void) printf(gettext(" (untrimmed)")); 2815 } 2816 } else if (vs->vs_trim_state == VDEV_TRIM_ACTIVE) { 2817 (void) printf(gettext(" (trimming)")); 2818 } 2819 } 2820 2821 /* 2822 * Return the color associated with a health string. This includes returning 2823 * NULL for no color change. 2824 */ 2825 static const char * 2826 health_str_to_color(const char *health) 2827 { 2828 if (strcmp(health, gettext("FAULTED")) == 0 || 2829 strcmp(health, gettext("SUSPENDED")) == 0 || 2830 strcmp(health, gettext("UNAVAIL")) == 0) { 2831 return (ANSI_RED); 2832 } 2833 2834 if (strcmp(health, gettext("OFFLINE")) == 0 || 2835 strcmp(health, gettext("DEGRADED")) == 0 || 2836 strcmp(health, gettext("REMOVED")) == 0) { 2837 return (ANSI_YELLOW); 2838 } 2839 2840 return (NULL); 2841 } 2842 2843 /* 2844 * Called for each leaf vdev. Returns 0 if the vdev is healthy. 2845 * A vdev is unhealthy if any of the following are true: 2846 * 1) there are read, write, or checksum errors, 2847 * 2) its state is not ONLINE, or 2848 * 3) slow IO reporting was requested (-s) and there are slow IOs. 2849 */ 2850 static int 2851 vdev_health_check_cb(void *hdl_data, nvlist_t *nv, void *data) 2852 { 2853 status_cbdata_t *cb = data; 2854 vdev_stat_t *vs; 2855 uint_t vsc; 2856 (void) hdl_data; 2857 2858 if (nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS, 2859 (uint64_t **)&vs, &vsc) != 0) 2860 return (1); 2861 2862 if (vs->vs_checksum_errors || vs->vs_read_errors || 2863 vs->vs_write_errors || vs->vs_state != VDEV_STATE_HEALTHY) 2864 return (1); 2865 2866 if (cb->cb_print_slow_ios && vs->vs_slow_ios) 2867 return (1); 2868 2869 return (0); 2870 } 2871 2872 /* 2873 * Print out configuration state as requested by status_callback. 2874 */ 2875 static void 2876 print_status_config(zpool_handle_t *zhp, status_cbdata_t *cb, const char *name, 2877 nvlist_t *nv, int depth, boolean_t isspare, vdev_rebuild_stat_t *vrs) 2878 { 2879 nvlist_t **child, *root; 2880 uint_t c, i, vsc, children; 2881 pool_scan_stat_t *ps = NULL; 2882 vdev_stat_t *vs; 2883 char rbuf[6], wbuf[6], cbuf[6], dbuf[6]; 2884 char *vname; 2885 uint64_t notpresent; 2886 spare_cbdata_t spare_cb; 2887 const char *state; 2888 const char *type; 2889 const char *path = NULL; 2890 const char *rcolor = NULL, *wcolor = NULL, *ccolor = NULL, 2891 *scolor = NULL; 2892 2893 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, 2894 &child, &children) != 0) 2895 children = 0; 2896 2897 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS, 2898 (uint64_t **)&vs, &vsc) == 0); 2899 2900 verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE, &type) == 0); 2901 2902 if (strcmp(type, VDEV_TYPE_INDIRECT) == 0) 2903 return; 2904 2905 state = zpool_state_to_name(vs->vs_state, vs->vs_aux); 2906 2907 if (isspare) { 2908 /* 2909 * For hot spares, we use the terms 'INUSE' and 'AVAILABLE' for 2910 * online drives. 2911 */ 2912 if (vs->vs_aux == VDEV_AUX_SPARED) 2913 state = gettext("INUSE"); 2914 else if (vs->vs_state == VDEV_STATE_HEALTHY) 2915 state = gettext("AVAIL"); 2916 } 2917 2918 /* 2919 * If '-e' is specified then top-level vdevs and their children 2920 * can be pruned if all of their leaves are healthy. 2921 */ 2922 if (cb->cb_print_unhealthy && depth > 0 && 2923 for_each_vdev_in_nvlist(nv, vdev_health_check_cb, cb) == 0) { 2924 return; 2925 } 2926 2927 printf_color(health_str_to_color(state), 2928 "\t%*s%-*s %-8s", depth, "", cb->cb_namewidth - depth, 2929 name, state); 2930 2931 if (!isspare) { 2932 if (vs->vs_read_errors) 2933 rcolor = ANSI_RED; 2934 2935 if (vs->vs_write_errors) 2936 wcolor = ANSI_RED; 2937 2938 if (vs->vs_checksum_errors) 2939 ccolor = ANSI_RED; 2940 2941 if (vs->vs_slow_ios) 2942 scolor = ANSI_BLUE; 2943 2944 if (cb->cb_literal) { 2945 fputc(' ', stdout); 2946 printf_color(rcolor, "%5llu", 2947 (u_longlong_t)vs->vs_read_errors); 2948 fputc(' ', stdout); 2949 printf_color(wcolor, "%5llu", 2950 (u_longlong_t)vs->vs_write_errors); 2951 fputc(' ', stdout); 2952 printf_color(ccolor, "%5llu", 2953 (u_longlong_t)vs->vs_checksum_errors); 2954 } else { 2955 zfs_nicenum(vs->vs_read_errors, rbuf, sizeof (rbuf)); 2956 zfs_nicenum(vs->vs_write_errors, wbuf, sizeof (wbuf)); 2957 zfs_nicenum(vs->vs_checksum_errors, cbuf, 2958 sizeof (cbuf)); 2959 fputc(' ', stdout); 2960 printf_color(rcolor, "%5s", rbuf); 2961 fputc(' ', stdout); 2962 printf_color(wcolor, "%5s", wbuf); 2963 fputc(' ', stdout); 2964 printf_color(ccolor, "%5s", cbuf); 2965 } 2966 if (cb->cb_print_slow_ios) { 2967 if (children == 0) { 2968 /* Only leafs vdevs have slow IOs */ 2969 zfs_nicenum(vs->vs_slow_ios, rbuf, 2970 sizeof (rbuf)); 2971 } else { 2972 snprintf(rbuf, sizeof (rbuf), "-"); 2973 } 2974 2975 if (cb->cb_literal) 2976 printf_color(scolor, " %5llu", 2977 (u_longlong_t)vs->vs_slow_ios); 2978 else 2979 printf_color(scolor, " %5s", rbuf); 2980 } 2981 if (cb->cb_print_power) { 2982 if (children == 0) { 2983 /* Only leaf vdevs have physical slots */ 2984 switch (zpool_power_current_state(zhp, (char *) 2985 fnvlist_lookup_string(nv, 2986 ZPOOL_CONFIG_PATH))) { 2987 case 0: 2988 printf_color(ANSI_RED, " %5s", 2989 gettext("off")); 2990 break; 2991 case 1: 2992 printf(" %5s", gettext("on")); 2993 break; 2994 default: 2995 printf(" %5s", "-"); 2996 } 2997 } else { 2998 printf(" %5s", "-"); 2999 } 3000 } 3001 if (VDEV_STAT_VALID(vs_dio_verify_errors, vsc) && 3002 cb->cb_print_dio_verify) { 3003 zfs_nicenum(vs->vs_dio_verify_errors, dbuf, 3004 sizeof (dbuf)); 3005 3006 if (cb->cb_literal) 3007 printf(" %5llu", 3008 (u_longlong_t)vs->vs_dio_verify_errors); 3009 else 3010 printf(" %5s", dbuf); 3011 } 3012 } 3013 3014 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NOT_PRESENT, 3015 ¬present) == 0) { 3016 verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0); 3017 (void) printf(" %s %s", gettext("was"), path); 3018 } else if (vs->vs_aux != 0) { 3019 (void) printf(" "); 3020 color_start(ANSI_RED); 3021 switch (vs->vs_aux) { 3022 case VDEV_AUX_OPEN_FAILED: 3023 (void) printf(gettext("cannot open")); 3024 break; 3025 3026 case VDEV_AUX_BAD_GUID_SUM: 3027 (void) printf(gettext("missing device")); 3028 break; 3029 3030 case VDEV_AUX_NO_REPLICAS: 3031 (void) printf(gettext("insufficient replicas")); 3032 break; 3033 3034 case VDEV_AUX_VERSION_NEWER: 3035 (void) printf(gettext("newer version")); 3036 break; 3037 3038 case VDEV_AUX_UNSUP_FEAT: 3039 (void) printf(gettext("unsupported feature(s)")); 3040 break; 3041 3042 case VDEV_AUX_ASHIFT_TOO_BIG: 3043 (void) printf(gettext("unsupported minimum blocksize")); 3044 break; 3045 3046 case VDEV_AUX_SPARED: 3047 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, 3048 &spare_cb.cb_guid) == 0); 3049 if (zpool_iter(g_zfs, find_spare, &spare_cb) == 1) { 3050 if (strcmp(zpool_get_name(spare_cb.cb_zhp), 3051 zpool_get_name(zhp)) == 0) 3052 (void) printf(gettext("currently in " 3053 "use")); 3054 else 3055 (void) printf(gettext("in use by " 3056 "pool '%s'"), 3057 zpool_get_name(spare_cb.cb_zhp)); 3058 zpool_close(spare_cb.cb_zhp); 3059 } else { 3060 (void) printf(gettext("currently in use")); 3061 } 3062 break; 3063 3064 case VDEV_AUX_ERR_EXCEEDED: 3065 if (vs->vs_read_errors + vs->vs_write_errors + 3066 vs->vs_checksum_errors == 0 && children == 0 && 3067 vs->vs_slow_ios > 0) { 3068 (void) printf(gettext("too many slow I/Os")); 3069 } else { 3070 (void) printf(gettext("too many errors")); 3071 } 3072 break; 3073 3074 case VDEV_AUX_IO_FAILURE: 3075 (void) printf(gettext("experienced I/O failures")); 3076 break; 3077 3078 case VDEV_AUX_BAD_LOG: 3079 (void) printf(gettext("bad intent log")); 3080 break; 3081 3082 case VDEV_AUX_EXTERNAL: 3083 (void) printf(gettext("external device fault")); 3084 break; 3085 3086 case VDEV_AUX_SPLIT_POOL: 3087 (void) printf(gettext("split into new pool")); 3088 break; 3089 3090 case VDEV_AUX_ACTIVE: 3091 (void) printf(gettext("currently in use")); 3092 break; 3093 3094 case VDEV_AUX_CHILDREN_OFFLINE: 3095 (void) printf(gettext("all children offline")); 3096 break; 3097 3098 case VDEV_AUX_BAD_LABEL: 3099 (void) printf(gettext("invalid label")); 3100 break; 3101 3102 default: 3103 (void) printf(gettext("corrupted data")); 3104 break; 3105 } 3106 color_end(); 3107 } else if (children == 0 && !isspare && 3108 getenv("ZPOOL_STATUS_NON_NATIVE_ASHIFT_IGNORE") == NULL && 3109 VDEV_STAT_VALID(vs_physical_ashift, vsc) && 3110 vs->vs_configured_ashift < vs->vs_physical_ashift) { 3111 (void) printf( 3112 gettext(" block size: %dB configured, %dB native"), 3113 1 << vs->vs_configured_ashift, 1 << vs->vs_physical_ashift); 3114 } 3115 3116 if (vs->vs_scan_removing != 0) { 3117 (void) printf(gettext(" (removing)")); 3118 } else if (VDEV_STAT_VALID(vs_noalloc, vsc) && vs->vs_noalloc != 0) { 3119 (void) printf(gettext(" (non-allocating)")); 3120 } 3121 3122 /* The root vdev has the scrub/resilver stats */ 3123 root = fnvlist_lookup_nvlist(zpool_get_config(zhp, NULL), 3124 ZPOOL_CONFIG_VDEV_TREE); 3125 (void) nvlist_lookup_uint64_array(root, ZPOOL_CONFIG_SCAN_STATS, 3126 (uint64_t **)&ps, &c); 3127 3128 /* 3129 * If you force fault a drive that's resilvering, its scan stats can 3130 * get frozen in time, giving the false impression that it's 3131 * being resilvered. That's why we check the state to see if the vdev 3132 * is healthy before reporting "resilvering" or "repairing". 3133 */ 3134 if (ps != NULL && ps->pss_state == DSS_SCANNING && children == 0 && 3135 vs->vs_state == VDEV_STATE_HEALTHY) { 3136 if (vs->vs_scan_processed != 0) { 3137 (void) printf(gettext(" (%s)"), 3138 (ps->pss_func == POOL_SCAN_RESILVER) ? 3139 "resilvering" : "repairing"); 3140 } else if (vs->vs_resilver_deferred) { 3141 (void) printf(gettext(" (awaiting resilver)")); 3142 } 3143 } 3144 3145 /* The top-level vdevs have the rebuild stats */ 3146 if (vrs != NULL && vrs->vrs_state == VDEV_REBUILD_ACTIVE && 3147 children == 0 && vs->vs_state == VDEV_STATE_HEALTHY) { 3148 if (vs->vs_rebuild_processed != 0) { 3149 (void) printf(gettext(" (resilvering)")); 3150 } 3151 } 3152 3153 if (cb->vcdl != NULL) { 3154 if (nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0) { 3155 printf(" "); 3156 zpool_print_cmd(cb->vcdl, zpool_get_name(zhp), path); 3157 } 3158 } 3159 3160 /* Display vdev initialization and trim status for leaves. */ 3161 if (children == 0) { 3162 print_status_initialize(vs, cb->cb_print_vdev_init); 3163 print_status_trim(vs, cb->cb_print_vdev_trim); 3164 } 3165 3166 (void) printf("\n"); 3167 3168 for (c = 0; c < children; c++) { 3169 uint64_t islog = B_FALSE, ishole = B_FALSE; 3170 3171 /* Don't print logs or holes here */ 3172 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG, 3173 &islog); 3174 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_HOLE, 3175 &ishole); 3176 if (islog || ishole) 3177 continue; 3178 /* Only print normal classes here */ 3179 if (nvlist_exists(child[c], ZPOOL_CONFIG_ALLOCATION_BIAS)) 3180 continue; 3181 3182 /* Provide vdev_rebuild_stats to children if available */ 3183 if (vrs == NULL) { 3184 (void) nvlist_lookup_uint64_array(nv, 3185 ZPOOL_CONFIG_REBUILD_STATS, 3186 (uint64_t **)&vrs, &i); 3187 } 3188 3189 vname = zpool_vdev_name(g_zfs, zhp, child[c], 3190 cb->cb_name_flags | VDEV_NAME_TYPE_ID); 3191 print_status_config(zhp, cb, vname, child[c], depth + 2, 3192 isspare, vrs); 3193 free(vname); 3194 } 3195 } 3196 3197 /* 3198 * Print the configuration of an exported pool. Iterate over all vdevs in the 3199 * pool, printing out the name and status for each one. 3200 */ 3201 static void 3202 print_import_config(status_cbdata_t *cb, const char *name, nvlist_t *nv, 3203 int depth) 3204 { 3205 nvlist_t **child; 3206 uint_t c, children; 3207 vdev_stat_t *vs; 3208 const char *type; 3209 char *vname; 3210 3211 verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE, &type) == 0); 3212 if (strcmp(type, VDEV_TYPE_MISSING) == 0 || 3213 strcmp(type, VDEV_TYPE_HOLE) == 0) 3214 return; 3215 3216 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS, 3217 (uint64_t **)&vs, &c) == 0); 3218 3219 (void) printf("\t%*s%-*s", depth, "", cb->cb_namewidth - depth, name); 3220 (void) printf(" %s", zpool_state_to_name(vs->vs_state, vs->vs_aux)); 3221 3222 if (vs->vs_aux != 0) { 3223 (void) printf(" "); 3224 3225 switch (vs->vs_aux) { 3226 case VDEV_AUX_OPEN_FAILED: 3227 (void) printf(gettext("cannot open")); 3228 break; 3229 3230 case VDEV_AUX_BAD_GUID_SUM: 3231 (void) printf(gettext("missing device")); 3232 break; 3233 3234 case VDEV_AUX_NO_REPLICAS: 3235 (void) printf(gettext("insufficient replicas")); 3236 break; 3237 3238 case VDEV_AUX_VERSION_NEWER: 3239 (void) printf(gettext("newer version")); 3240 break; 3241 3242 case VDEV_AUX_UNSUP_FEAT: 3243 (void) printf(gettext("unsupported feature(s)")); 3244 break; 3245 3246 case VDEV_AUX_ERR_EXCEEDED: 3247 (void) printf(gettext("too many errors")); 3248 break; 3249 3250 case VDEV_AUX_ACTIVE: 3251 (void) printf(gettext("currently in use")); 3252 break; 3253 3254 case VDEV_AUX_CHILDREN_OFFLINE: 3255 (void) printf(gettext("all children offline")); 3256 break; 3257 3258 case VDEV_AUX_BAD_LABEL: 3259 (void) printf(gettext("invalid label")); 3260 break; 3261 3262 default: 3263 (void) printf(gettext("corrupted data")); 3264 break; 3265 } 3266 } 3267 (void) printf("\n"); 3268 3269 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, 3270 &child, &children) != 0) 3271 return; 3272 3273 for (c = 0; c < children; c++) { 3274 uint64_t is_log = B_FALSE; 3275 3276 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG, 3277 &is_log); 3278 if (is_log) 3279 continue; 3280 if (nvlist_exists(child[c], ZPOOL_CONFIG_ALLOCATION_BIAS)) 3281 continue; 3282 3283 vname = zpool_vdev_name(g_zfs, NULL, child[c], 3284 cb->cb_name_flags | VDEV_NAME_TYPE_ID); 3285 print_import_config(cb, vname, child[c], depth + 2); 3286 free(vname); 3287 } 3288 3289 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE, 3290 &child, &children) == 0) { 3291 (void) printf(gettext("\tcache\n")); 3292 for (c = 0; c < children; c++) { 3293 vname = zpool_vdev_name(g_zfs, NULL, child[c], 3294 cb->cb_name_flags); 3295 (void) printf("\t %s\n", vname); 3296 free(vname); 3297 } 3298 } 3299 3300 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_SPARES, 3301 &child, &children) == 0) { 3302 (void) printf(gettext("\tspares\n")); 3303 for (c = 0; c < children; c++) { 3304 vname = zpool_vdev_name(g_zfs, NULL, child[c], 3305 cb->cb_name_flags); 3306 (void) printf("\t %s\n", vname); 3307 free(vname); 3308 } 3309 } 3310 } 3311 3312 /* 3313 * Print specialized class vdevs. 3314 * 3315 * These are recorded as top level vdevs in the main pool child array 3316 * but with "is_log" set to 1 or an "alloc_bias" string. We use either 3317 * print_status_config() or print_import_config() to print the top level 3318 * class vdevs then any of their children (eg mirrored slogs) are printed 3319 * recursively - which works because only the top level vdev is marked. 3320 */ 3321 static void 3322 print_class_vdevs(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t *nv, 3323 const char *class) 3324 { 3325 uint_t c, children; 3326 nvlist_t **child; 3327 boolean_t printed = B_FALSE; 3328 3329 assert(zhp != NULL || !cb->cb_verbose); 3330 3331 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, &child, 3332 &children) != 0) 3333 return; 3334 3335 for (c = 0; c < children; c++) { 3336 uint64_t is_log = B_FALSE; 3337 const char *bias = NULL; 3338 const char *type = NULL; 3339 3340 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG, 3341 &is_log); 3342 3343 if (is_log) { 3344 bias = (char *)VDEV_ALLOC_CLASS_LOGS; 3345 } else { 3346 (void) nvlist_lookup_string(child[c], 3347 ZPOOL_CONFIG_ALLOCATION_BIAS, &bias); 3348 (void) nvlist_lookup_string(child[c], 3349 ZPOOL_CONFIG_TYPE, &type); 3350 } 3351 3352 if (bias == NULL || strcmp(bias, class) != 0) 3353 continue; 3354 if (!is_log && strcmp(type, VDEV_TYPE_INDIRECT) == 0) 3355 continue; 3356 3357 if (!printed) { 3358 (void) printf("\t%s\t\n", gettext(class)); 3359 printed = B_TRUE; 3360 } 3361 3362 char *name = zpool_vdev_name(g_zfs, zhp, child[c], 3363 cb->cb_name_flags | VDEV_NAME_TYPE_ID); 3364 if (cb->cb_print_status) 3365 print_status_config(zhp, cb, name, child[c], 2, 3366 B_FALSE, NULL); 3367 else 3368 print_import_config(cb, name, child[c], 2); 3369 free(name); 3370 } 3371 } 3372 3373 /* 3374 * Display the status for the given pool. 3375 */ 3376 static int 3377 show_import(nvlist_t *config, boolean_t report_error) 3378 { 3379 uint64_t pool_state; 3380 vdev_stat_t *vs; 3381 const char *name; 3382 uint64_t guid; 3383 uint64_t hostid = 0; 3384 const char *msgid; 3385 const char *hostname = "unknown"; 3386 nvlist_t *nvroot, *nvinfo; 3387 zpool_status_t reason; 3388 zpool_errata_t errata; 3389 const char *health; 3390 uint_t vsc; 3391 const char *comment; 3392 const char *indent; 3393 char buf[2048]; 3394 status_cbdata_t cb = { 0 }; 3395 3396 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME, 3397 &name) == 0); 3398 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID, 3399 &guid) == 0); 3400 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE, 3401 &pool_state) == 0); 3402 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE, 3403 &nvroot) == 0); 3404 3405 verify(nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_VDEV_STATS, 3406 (uint64_t **)&vs, &vsc) == 0); 3407 health = zpool_state_to_name(vs->vs_state, vs->vs_aux); 3408 3409 reason = zpool_import_status(config, &msgid, &errata); 3410 3411 /* 3412 * If we're importing using a cachefile, then we won't report any 3413 * errors unless we are in the scan phase of the import. 3414 */ 3415 if (reason != ZPOOL_STATUS_OK && !report_error) 3416 return (reason); 3417 3418 if (nvlist_lookup_string(config, ZPOOL_CONFIG_COMMENT, &comment) == 0) { 3419 indent = " "; 3420 } else { 3421 comment = NULL; 3422 indent = ""; 3423 } 3424 3425 (void) printf(gettext("%s pool: %s\n"), indent, name); 3426 (void) printf(gettext("%s id: %llu\n"), indent, (u_longlong_t)guid); 3427 (void) printf(gettext("%s state: %s"), indent, health); 3428 if (pool_state == POOL_STATE_DESTROYED) 3429 (void) printf(gettext(" (DESTROYED)")); 3430 (void) printf("\n"); 3431 3432 if (reason != ZPOOL_STATUS_OK) { 3433 (void) printf("%s", indent); 3434 printf_color(ANSI_BOLD, gettext("status: ")); 3435 } 3436 switch (reason) { 3437 case ZPOOL_STATUS_MISSING_DEV_R: 3438 case ZPOOL_STATUS_MISSING_DEV_NR: 3439 case ZPOOL_STATUS_BAD_GUID_SUM: 3440 printf_color(ANSI_YELLOW, gettext("One or more devices are " 3441 "missing from the system.\n")); 3442 break; 3443 3444 case ZPOOL_STATUS_CORRUPT_LABEL_R: 3445 case ZPOOL_STATUS_CORRUPT_LABEL_NR: 3446 printf_color(ANSI_YELLOW, gettext("One or more devices " 3447 "contains corrupted data.\n")); 3448 break; 3449 3450 case ZPOOL_STATUS_CORRUPT_DATA: 3451 printf_color(ANSI_YELLOW, gettext("The pool data is " 3452 "corrupted.\n")); 3453 break; 3454 3455 case ZPOOL_STATUS_OFFLINE_DEV: 3456 printf_color(ANSI_YELLOW, gettext("One or more devices " 3457 "are offlined.\n")); 3458 break; 3459 3460 case ZPOOL_STATUS_CORRUPT_POOL: 3461 printf_color(ANSI_YELLOW, gettext("The pool metadata is " 3462 "corrupted.\n")); 3463 break; 3464 3465 case ZPOOL_STATUS_VERSION_OLDER: 3466 printf_color(ANSI_YELLOW, gettext("The pool is formatted using " 3467 "a legacy on-disk version.\n")); 3468 break; 3469 3470 case ZPOOL_STATUS_VERSION_NEWER: 3471 printf_color(ANSI_YELLOW, gettext("The pool is formatted using " 3472 "an incompatible version.\n")); 3473 break; 3474 3475 case ZPOOL_STATUS_FEAT_DISABLED: 3476 printf_color(ANSI_YELLOW, gettext("Some supported " 3477 "features are not enabled on the pool.\n" 3478 "\t%s(Note that they may be intentionally disabled if the\n" 3479 "\t%s'compatibility' property is set.)\n"), indent, indent); 3480 break; 3481 3482 case ZPOOL_STATUS_COMPATIBILITY_ERR: 3483 printf_color(ANSI_YELLOW, gettext("Error reading or parsing " 3484 "the file(s) indicated by the 'compatibility'\n" 3485 "\t%sproperty.\n"), indent); 3486 break; 3487 3488 case ZPOOL_STATUS_INCOMPATIBLE_FEAT: 3489 printf_color(ANSI_YELLOW, gettext("One or more features " 3490 "are enabled on the pool despite not being\n" 3491 "\t%srequested by the 'compatibility' property.\n"), 3492 indent); 3493 break; 3494 3495 case ZPOOL_STATUS_UNSUP_FEAT_READ: 3496 printf_color(ANSI_YELLOW, gettext("The pool uses the following " 3497 "feature(s) not supported on this system:\n")); 3498 color_start(ANSI_YELLOW); 3499 zpool_collect_unsup_feat(config, buf, 2048); 3500 (void) printf("%s", buf); 3501 color_end(); 3502 break; 3503 3504 case ZPOOL_STATUS_UNSUP_FEAT_WRITE: 3505 printf_color(ANSI_YELLOW, gettext("The pool can only be " 3506 "accessed in read-only mode on this system. It\n" 3507 "\t%scannot be accessed in read-write mode because it uses " 3508 "the following\n" 3509 "\t%sfeature(s) not supported on this system:\n"), 3510 indent, indent); 3511 color_start(ANSI_YELLOW); 3512 zpool_collect_unsup_feat(config, buf, 2048); 3513 (void) printf("%s", buf); 3514 color_end(); 3515 break; 3516 3517 case ZPOOL_STATUS_HOSTID_ACTIVE: 3518 printf_color(ANSI_YELLOW, gettext("The pool is currently " 3519 "imported by another system.\n")); 3520 break; 3521 3522 case ZPOOL_STATUS_HOSTID_REQUIRED: 3523 printf_color(ANSI_YELLOW, gettext("The pool has the " 3524 "multihost property on. It cannot\n" 3525 "\t%sbe safely imported when the system hostid is not " 3526 "set.\n"), indent); 3527 break; 3528 3529 case ZPOOL_STATUS_HOSTID_MISMATCH: 3530 printf_color(ANSI_YELLOW, gettext("The pool was last accessed " 3531 "by another system.\n")); 3532 break; 3533 3534 case ZPOOL_STATUS_FAULTED_DEV_R: 3535 case ZPOOL_STATUS_FAULTED_DEV_NR: 3536 printf_color(ANSI_YELLOW, gettext("One or more devices are " 3537 "faulted.\n")); 3538 break; 3539 3540 case ZPOOL_STATUS_BAD_LOG: 3541 printf_color(ANSI_YELLOW, gettext("An intent log record cannot " 3542 "be read.\n")); 3543 break; 3544 3545 case ZPOOL_STATUS_RESILVERING: 3546 case ZPOOL_STATUS_REBUILDING: 3547 printf_color(ANSI_YELLOW, gettext("One or more devices were " 3548 "being resilvered.\n")); 3549 break; 3550 3551 case ZPOOL_STATUS_ERRATA: 3552 printf_color(ANSI_YELLOW, gettext("Errata #%d detected.\n"), 3553 errata); 3554 break; 3555 3556 case ZPOOL_STATUS_NON_NATIVE_ASHIFT: 3557 printf_color(ANSI_YELLOW, gettext("One or more devices are " 3558 "configured to use a non-native block size.\n" 3559 "\t%sExpect reduced performance.\n"), indent); 3560 break; 3561 3562 default: 3563 /* 3564 * No other status can be seen when importing pools. 3565 */ 3566 assert(reason == ZPOOL_STATUS_OK); 3567 } 3568 3569 /* 3570 * Print out an action according to the overall state of the pool. 3571 */ 3572 if (vs->vs_state != VDEV_STATE_HEALTHY || 3573 reason != ZPOOL_STATUS_ERRATA || errata != ZPOOL_ERRATA_NONE) { 3574 (void) printf("%s", indent); 3575 (void) printf(gettext("action: ")); 3576 } 3577 if (vs->vs_state == VDEV_STATE_HEALTHY) { 3578 if (reason == ZPOOL_STATUS_VERSION_OLDER || 3579 reason == ZPOOL_STATUS_FEAT_DISABLED) { 3580 (void) printf(gettext("The pool can be imported using " 3581 "its name or numeric identifier, though\n" 3582 "\t%ssome features will not be available without " 3583 "an explicit 'zpool upgrade'.\n"), indent); 3584 } else if (reason == ZPOOL_STATUS_COMPATIBILITY_ERR) { 3585 (void) printf(gettext("The pool can be imported using " 3586 "its name or numeric\n" 3587 "\t%sidentifier, though the file(s) indicated by " 3588 "its 'compatibility'\n" 3589 "\t%sproperty cannot be parsed at this time.\n"), 3590 indent, indent); 3591 } else if (reason == ZPOOL_STATUS_HOSTID_MISMATCH) { 3592 (void) printf(gettext("The pool can be imported using " 3593 "its name or numeric identifier and\n" 3594 "\t%sthe '-f' flag.\n"), indent); 3595 } else if (reason == ZPOOL_STATUS_ERRATA) { 3596 switch (errata) { 3597 case ZPOOL_ERRATA_ZOL_2094_SCRUB: 3598 (void) printf(gettext("The pool can be " 3599 "imported using its name or numeric " 3600 "identifier,\n" 3601 "\t%showever there is a compatibility " 3602 "issue which should be corrected\n" 3603 "\t%sby running 'zpool scrub'\n"), 3604 indent, indent); 3605 break; 3606 3607 case ZPOOL_ERRATA_ZOL_2094_ASYNC_DESTROY: 3608 (void) printf(gettext("The pool cannot be " 3609 "imported with this version of ZFS due to\n" 3610 "\t%san active asynchronous destroy. " 3611 "Revert to an earlier version\n" 3612 "\t%sand allow the destroy to complete " 3613 "before updating.\n"), indent, indent); 3614 break; 3615 3616 case ZPOOL_ERRATA_ZOL_6845_ENCRYPTION: 3617 (void) printf(gettext("Existing encrypted " 3618 "datasets contain an on-disk " 3619 "incompatibility, which\n" 3620 "\t%sneeds to be corrected. Backup these " 3621 "datasets to new encrypted datasets\n" 3622 "\t%sand destroy the old ones.\n"), 3623 indent, indent); 3624 break; 3625 3626 case ZPOOL_ERRATA_ZOL_8308_ENCRYPTION: 3627 (void) printf(gettext("Existing encrypted " 3628 "snapshots and bookmarks contain an " 3629 "on-disk\n" 3630 "\t%sincompatibility. This may cause " 3631 "on-disk corruption if they are used\n" 3632 "\t%swith 'zfs recv'. To correct the " 3633 "issue, enable the bookmark_v2 feature.\n" 3634 "\t%sNo additional action is needed if " 3635 "there are no encrypted snapshots or\n" 3636 "\t%sbookmarks. If preserving the " 3637 "encrypted snapshots and bookmarks is\n" 3638 "\t%srequired, use a non-raw send to " 3639 "backup and restore them. Alternately,\n" 3640 "\t%sthey may be removed to resolve the " 3641 "incompatibility.\n"), indent, indent, 3642 indent, indent, indent, indent); 3643 break; 3644 default: 3645 /* 3646 * All errata must contain an action message. 3647 */ 3648 assert(errata == ZPOOL_ERRATA_NONE); 3649 } 3650 } else { 3651 (void) printf(gettext("The pool can be imported using " 3652 "its name or numeric identifier.\n")); 3653 } 3654 } else if (vs->vs_state == VDEV_STATE_DEGRADED) { 3655 (void) printf(gettext("The pool can be imported despite " 3656 "missing or damaged devices. The\n" 3657 "\t%sfault tolerance of the pool may be compromised if " 3658 "imported.\n"), indent); 3659 } else { 3660 switch (reason) { 3661 case ZPOOL_STATUS_VERSION_NEWER: 3662 (void) printf(gettext("The pool cannot be imported. " 3663 "Access the pool on a system running newer\n" 3664 "\t%ssoftware, or recreate the pool from " 3665 "backup.\n"), indent); 3666 break; 3667 case ZPOOL_STATUS_UNSUP_FEAT_READ: 3668 (void) printf(gettext("The pool cannot be imported. " 3669 "Access the pool on a system that supports\n" 3670 "\t%sthe required feature(s), or recreate the pool " 3671 "from backup.\n"), indent); 3672 break; 3673 case ZPOOL_STATUS_UNSUP_FEAT_WRITE: 3674 (void) printf(gettext("The pool cannot be imported in " 3675 "read-write mode. Import the pool with\n" 3676 "\t%s'-o readonly=on', access the pool on a system " 3677 "that supports the\n" 3678 "\t%srequired feature(s), or recreate the pool " 3679 "from backup.\n"), indent, indent); 3680 break; 3681 case ZPOOL_STATUS_MISSING_DEV_R: 3682 case ZPOOL_STATUS_MISSING_DEV_NR: 3683 case ZPOOL_STATUS_BAD_GUID_SUM: 3684 (void) printf(gettext("The pool cannot be imported. " 3685 "Attach the missing\n" 3686 "\t%sdevices and try again.\n"), indent); 3687 break; 3688 case ZPOOL_STATUS_HOSTID_ACTIVE: 3689 VERIFY0(nvlist_lookup_nvlist(config, 3690 ZPOOL_CONFIG_LOAD_INFO, &nvinfo)); 3691 3692 if (nvlist_exists(nvinfo, ZPOOL_CONFIG_MMP_HOSTNAME)) 3693 hostname = fnvlist_lookup_string(nvinfo, 3694 ZPOOL_CONFIG_MMP_HOSTNAME); 3695 3696 if (nvlist_exists(nvinfo, ZPOOL_CONFIG_MMP_HOSTID)) 3697 hostid = fnvlist_lookup_uint64(nvinfo, 3698 ZPOOL_CONFIG_MMP_HOSTID); 3699 3700 (void) printf(gettext("The pool must be exported from " 3701 "%s (hostid=%"PRIx64")\n" 3702 "\t%sbefore it can be safely imported.\n"), 3703 hostname, hostid, indent); 3704 break; 3705 case ZPOOL_STATUS_HOSTID_REQUIRED: 3706 (void) printf(gettext("Set a unique system hostid with " 3707 "the zgenhostid(8) command.\n")); 3708 break; 3709 default: 3710 (void) printf(gettext("The pool cannot be imported due " 3711 "to damaged devices or data.\n")); 3712 } 3713 } 3714 3715 /* Print the comment attached to the pool. */ 3716 if (comment != NULL) 3717 (void) printf(gettext("comment: %s\n"), comment); 3718 3719 /* 3720 * If the state is "closed" or "can't open", and the aux state 3721 * is "corrupt data": 3722 */ 3723 if ((vs->vs_state == VDEV_STATE_CLOSED || 3724 vs->vs_state == VDEV_STATE_CANT_OPEN) && 3725 vs->vs_aux == VDEV_AUX_CORRUPT_DATA) { 3726 if (pool_state == POOL_STATE_DESTROYED) 3727 (void) printf(gettext("\t%sThe pool was destroyed, " 3728 "but can be imported using the '-Df' flags.\n"), 3729 indent); 3730 else if (pool_state != POOL_STATE_EXPORTED) 3731 (void) printf(gettext("\t%sThe pool may be active on " 3732 "another system, but can be imported using\n" 3733 "\t%sthe '-f' flag.\n"), indent, indent); 3734 } 3735 3736 if (msgid != NULL) { 3737 (void) printf(gettext("%s see: " 3738 "https://openzfs.github.io/openzfs-docs/msg/%s\n"), 3739 indent, msgid); 3740 } 3741 3742 (void) printf(gettext("%sconfig:\n\n"), indent); 3743 3744 cb.cb_namewidth = max_width(NULL, nvroot, 0, strlen(name), 3745 VDEV_NAME_TYPE_ID); 3746 if (cb.cb_namewidth < 10) 3747 cb.cb_namewidth = 10; 3748 3749 print_import_config(&cb, name, nvroot, 0); 3750 3751 print_class_vdevs(NULL, &cb, nvroot, VDEV_ALLOC_BIAS_DEDUP); 3752 print_class_vdevs(NULL, &cb, nvroot, VDEV_ALLOC_BIAS_SPECIAL); 3753 print_class_vdevs(NULL, &cb, nvroot, VDEV_ALLOC_CLASS_LOGS); 3754 3755 if (reason == ZPOOL_STATUS_BAD_GUID_SUM) { 3756 (void) printf(gettext("\n\t%sAdditional devices are known to " 3757 "be part of this pool, though their\n" 3758 "\t%sexact configuration cannot be determined.\n"), 3759 indent, indent); 3760 } 3761 return (0); 3762 } 3763 3764 static boolean_t 3765 zfs_force_import_required(nvlist_t *config) 3766 { 3767 uint64_t state; 3768 uint64_t hostid = 0; 3769 nvlist_t *nvinfo; 3770 3771 state = fnvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE); 3772 nvinfo = fnvlist_lookup_nvlist(config, ZPOOL_CONFIG_LOAD_INFO); 3773 3774 /* 3775 * The hostid on LOAD_INFO comes from the MOS label via 3776 * spa_tryimport(). If its not there then we're likely talking to an 3777 * older kernel, so use the top one, which will be from the label 3778 * discovered in zpool_find_import(), or if a cachefile is in use, the 3779 * local hostid. 3780 */ 3781 if (nvlist_lookup_uint64(nvinfo, ZPOOL_CONFIG_HOSTID, &hostid) != 0) 3782 (void) nvlist_lookup_uint64(config, ZPOOL_CONFIG_HOSTID, 3783 &hostid); 3784 3785 if (state != POOL_STATE_EXPORTED && hostid != get_system_hostid()) 3786 return (B_TRUE); 3787 3788 if (nvlist_exists(nvinfo, ZPOOL_CONFIG_MMP_STATE)) { 3789 mmp_state_t mmp_state = fnvlist_lookup_uint64(nvinfo, 3790 ZPOOL_CONFIG_MMP_STATE); 3791 3792 if (mmp_state != MMP_STATE_INACTIVE) 3793 return (B_TRUE); 3794 } 3795 3796 return (B_FALSE); 3797 } 3798 3799 /* 3800 * Perform the import for the given configuration. This passes the heavy 3801 * lifting off to zpool_import_props(), and then mounts the datasets contained 3802 * within the pool. 3803 */ 3804 static int 3805 do_import(nvlist_t *config, const char *newname, const char *mntopts, 3806 nvlist_t *props, int flags, uint_t mntthreads) 3807 { 3808 int ret = 0; 3809 int ms_status = 0; 3810 zpool_handle_t *zhp; 3811 const char *name; 3812 uint64_t version; 3813 3814 name = fnvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME); 3815 version = fnvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION); 3816 3817 if (!SPA_VERSION_IS_SUPPORTED(version)) { 3818 (void) fprintf(stderr, gettext("cannot import '%s': pool " 3819 "is formatted using an unsupported ZFS version\n"), name); 3820 return (1); 3821 } else if (zfs_force_import_required(config) && 3822 !(flags & ZFS_IMPORT_ANY_HOST)) { 3823 mmp_state_t mmp_state = MMP_STATE_INACTIVE; 3824 nvlist_t *nvinfo; 3825 3826 nvinfo = fnvlist_lookup_nvlist(config, ZPOOL_CONFIG_LOAD_INFO); 3827 if (nvlist_exists(nvinfo, ZPOOL_CONFIG_MMP_STATE)) 3828 mmp_state = fnvlist_lookup_uint64(nvinfo, 3829 ZPOOL_CONFIG_MMP_STATE); 3830 3831 if (mmp_state == MMP_STATE_ACTIVE) { 3832 const char *hostname = "<unknown>"; 3833 uint64_t hostid = 0; 3834 3835 if (nvlist_exists(nvinfo, ZPOOL_CONFIG_MMP_HOSTNAME)) 3836 hostname = fnvlist_lookup_string(nvinfo, 3837 ZPOOL_CONFIG_MMP_HOSTNAME); 3838 3839 if (nvlist_exists(nvinfo, ZPOOL_CONFIG_MMP_HOSTID)) 3840 hostid = fnvlist_lookup_uint64(nvinfo, 3841 ZPOOL_CONFIG_MMP_HOSTID); 3842 3843 (void) fprintf(stderr, gettext("cannot import '%s': " 3844 "pool is imported on %s (hostid: " 3845 "0x%"PRIx64")\nExport the pool on the other " 3846 "system, then run 'zpool import'.\n"), 3847 name, hostname, hostid); 3848 } else if (mmp_state == MMP_STATE_NO_HOSTID) { 3849 (void) fprintf(stderr, gettext("Cannot import '%s': " 3850 "pool has the multihost property on and the\n" 3851 "system's hostid is not set. Set a unique hostid " 3852 "with the zgenhostid(8) command.\n"), name); 3853 } else { 3854 const char *hostname = "<unknown>"; 3855 time_t timestamp = 0; 3856 uint64_t hostid = 0; 3857 3858 if (nvlist_exists(nvinfo, ZPOOL_CONFIG_HOSTNAME)) 3859 hostname = fnvlist_lookup_string(nvinfo, 3860 ZPOOL_CONFIG_HOSTNAME); 3861 else if (nvlist_exists(config, ZPOOL_CONFIG_HOSTNAME)) 3862 hostname = fnvlist_lookup_string(config, 3863 ZPOOL_CONFIG_HOSTNAME); 3864 3865 if (nvlist_exists(config, ZPOOL_CONFIG_TIMESTAMP)) 3866 timestamp = fnvlist_lookup_uint64(config, 3867 ZPOOL_CONFIG_TIMESTAMP); 3868 3869 if (nvlist_exists(nvinfo, ZPOOL_CONFIG_HOSTID)) 3870 hostid = fnvlist_lookup_uint64(nvinfo, 3871 ZPOOL_CONFIG_HOSTID); 3872 else if (nvlist_exists(config, ZPOOL_CONFIG_HOSTID)) 3873 hostid = fnvlist_lookup_uint64(config, 3874 ZPOOL_CONFIG_HOSTID); 3875 3876 (void) fprintf(stderr, gettext("cannot import '%s': " 3877 "pool was previously in use from another system.\n" 3878 "Last accessed by %s (hostid=%"PRIx64") at %s" 3879 "The pool can be imported, use 'zpool import -f' " 3880 "to import the pool.\n"), name, hostname, 3881 hostid, ctime(×tamp)); 3882 } 3883 3884 return (1); 3885 } 3886 3887 if (zpool_import_props(g_zfs, config, newname, props, flags) != 0) 3888 return (1); 3889 3890 if (newname != NULL) 3891 name = newname; 3892 3893 if ((zhp = zpool_open_canfail(g_zfs, name)) == NULL) 3894 return (1); 3895 3896 /* 3897 * Loading keys is best effort. We don't want to return immediately 3898 * if it fails but we do want to give the error to the caller. 3899 */ 3900 if (flags & ZFS_IMPORT_LOAD_KEYS && 3901 zfs_crypto_attempt_load_keys(g_zfs, name) != 0) 3902 ret = 1; 3903 3904 if (zpool_get_state(zhp) != POOL_STATE_UNAVAIL && 3905 !(flags & ZFS_IMPORT_ONLY)) { 3906 ms_status = zpool_enable_datasets(zhp, mntopts, 0, mntthreads); 3907 if (ms_status == EZFS_SHAREFAILED) { 3908 (void) fprintf(stderr, gettext("Import was " 3909 "successful, but unable to share some datasets\n")); 3910 } else if (ms_status == EZFS_MOUNTFAILED) { 3911 (void) fprintf(stderr, gettext("Import was " 3912 "successful, but unable to mount some datasets\n")); 3913 } 3914 } 3915 3916 zpool_close(zhp); 3917 return (ret); 3918 } 3919 3920 typedef struct import_parameters { 3921 nvlist_t *ip_config; 3922 const char *ip_mntopts; 3923 nvlist_t *ip_props; 3924 int ip_flags; 3925 uint_t ip_mntthreads; 3926 int *ip_err; 3927 } import_parameters_t; 3928 3929 static void 3930 do_import_task(void *arg) 3931 { 3932 import_parameters_t *ip = arg; 3933 *ip->ip_err |= do_import(ip->ip_config, NULL, ip->ip_mntopts, 3934 ip->ip_props, ip->ip_flags, ip->ip_mntthreads); 3935 free(ip); 3936 } 3937 3938 3939 static int 3940 import_pools(nvlist_t *pools, nvlist_t *props, char *mntopts, int flags, 3941 char *orig_name, char *new_name, importargs_t *import) 3942 { 3943 nvlist_t *config = NULL; 3944 nvlist_t *found_config = NULL; 3945 uint64_t pool_state; 3946 boolean_t pool_specified = (import->poolname != NULL || 3947 import->guid != 0); 3948 uint_t npools = 0; 3949 3950 3951 tpool_t *tp = NULL; 3952 if (import->do_all) { 3953 tp = tpool_create(1, 5 * sysconf(_SC_NPROCESSORS_ONLN), 3954 0, NULL); 3955 } 3956 3957 /* 3958 * At this point we have a list of import candidate configs. Even if 3959 * we were searching by pool name or guid, we still need to 3960 * post-process the list to deal with pool state and possible 3961 * duplicate names. 3962 */ 3963 int err = 0; 3964 nvpair_t *elem = NULL; 3965 boolean_t first = B_TRUE; 3966 if (!pool_specified && import->do_all) { 3967 while ((elem = nvlist_next_nvpair(pools, elem)) != NULL) 3968 npools++; 3969 } 3970 while ((elem = nvlist_next_nvpair(pools, elem)) != NULL) { 3971 3972 verify(nvpair_value_nvlist(elem, &config) == 0); 3973 3974 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE, 3975 &pool_state) == 0); 3976 if (!import->do_destroyed && 3977 pool_state == POOL_STATE_DESTROYED) 3978 continue; 3979 if (import->do_destroyed && 3980 pool_state != POOL_STATE_DESTROYED) 3981 continue; 3982 3983 verify(nvlist_add_nvlist(config, ZPOOL_LOAD_POLICY, 3984 import->policy) == 0); 3985 3986 if (!pool_specified) { 3987 if (first) 3988 first = B_FALSE; 3989 else if (!import->do_all) 3990 (void) fputc('\n', stdout); 3991 3992 if (import->do_all) { 3993 import_parameters_t *ip = safe_malloc( 3994 sizeof (import_parameters_t)); 3995 3996 ip->ip_config = config; 3997 ip->ip_mntopts = mntopts; 3998 ip->ip_props = props; 3999 ip->ip_flags = flags; 4000 ip->ip_mntthreads = mount_tp_nthr / npools; 4001 ip->ip_err = &err; 4002 4003 (void) tpool_dispatch(tp, do_import_task, 4004 (void *)ip); 4005 } else { 4006 /* 4007 * If we're importing from cachefile, then 4008 * we don't want to report errors until we 4009 * are in the scan phase of the import. If 4010 * we get an error, then we return that error 4011 * to invoke the scan phase. 4012 */ 4013 if (import->cachefile && !import->scan) 4014 err = show_import(config, B_FALSE); 4015 else 4016 (void) show_import(config, B_TRUE); 4017 } 4018 } else if (import->poolname != NULL) { 4019 const char *name; 4020 4021 /* 4022 * We are searching for a pool based on name. 4023 */ 4024 verify(nvlist_lookup_string(config, 4025 ZPOOL_CONFIG_POOL_NAME, &name) == 0); 4026 4027 if (strcmp(name, import->poolname) == 0) { 4028 if (found_config != NULL) { 4029 (void) fprintf(stderr, gettext( 4030 "cannot import '%s': more than " 4031 "one matching pool\n"), 4032 import->poolname); 4033 (void) fprintf(stderr, gettext( 4034 "import by numeric ID instead\n")); 4035 err = B_TRUE; 4036 } 4037 found_config = config; 4038 } 4039 } else { 4040 uint64_t guid; 4041 4042 /* 4043 * Search for a pool by guid. 4044 */ 4045 verify(nvlist_lookup_uint64(config, 4046 ZPOOL_CONFIG_POOL_GUID, &guid) == 0); 4047 4048 if (guid == import->guid) 4049 found_config = config; 4050 } 4051 } 4052 if (import->do_all) { 4053 tpool_wait(tp); 4054 tpool_destroy(tp); 4055 } 4056 4057 /* 4058 * If we were searching for a specific pool, verify that we found a 4059 * pool, and then do the import. 4060 */ 4061 if (pool_specified && err == 0) { 4062 if (found_config == NULL) { 4063 (void) fprintf(stderr, gettext("cannot import '%s': " 4064 "no such pool available\n"), orig_name); 4065 err = B_TRUE; 4066 } else { 4067 err |= do_import(found_config, new_name, 4068 mntopts, props, flags, mount_tp_nthr); 4069 } 4070 } 4071 4072 /* 4073 * If we were just looking for pools, report an error if none were 4074 * found. 4075 */ 4076 if (!pool_specified && first) 4077 (void) fprintf(stderr, 4078 gettext("no pools available to import\n")); 4079 return (err); 4080 } 4081 4082 typedef struct target_exists_args { 4083 const char *poolname; 4084 uint64_t poolguid; 4085 } target_exists_args_t; 4086 4087 static int 4088 name_or_guid_exists(zpool_handle_t *zhp, void *data) 4089 { 4090 target_exists_args_t *args = data; 4091 nvlist_t *config = zpool_get_config(zhp, NULL); 4092 int found = 0; 4093 4094 if (config == NULL) 4095 return (0); 4096 4097 if (args->poolname != NULL) { 4098 const char *pool_name; 4099 4100 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME, 4101 &pool_name) == 0); 4102 if (strcmp(pool_name, args->poolname) == 0) 4103 found = 1; 4104 } else { 4105 uint64_t pool_guid; 4106 4107 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID, 4108 &pool_guid) == 0); 4109 if (pool_guid == args->poolguid) 4110 found = 1; 4111 } 4112 zpool_close(zhp); 4113 4114 return (found); 4115 } 4116 /* 4117 * zpool checkpoint <pool> 4118 * checkpoint --discard <pool> 4119 * 4120 * -d Discard the checkpoint from a checkpointed 4121 * --discard pool. 4122 * 4123 * -w Wait for discarding a checkpoint to complete. 4124 * --wait 4125 * 4126 * Checkpoints the specified pool, by taking a "snapshot" of its 4127 * current state. A pool can only have one checkpoint at a time. 4128 */ 4129 int 4130 zpool_do_checkpoint(int argc, char **argv) 4131 { 4132 boolean_t discard, wait; 4133 char *pool; 4134 zpool_handle_t *zhp; 4135 int c, err; 4136 4137 struct option long_options[] = { 4138 {"discard", no_argument, NULL, 'd'}, 4139 {"wait", no_argument, NULL, 'w'}, 4140 {0, 0, 0, 0} 4141 }; 4142 4143 discard = B_FALSE; 4144 wait = B_FALSE; 4145 while ((c = getopt_long(argc, argv, ":dw", long_options, NULL)) != -1) { 4146 switch (c) { 4147 case 'd': 4148 discard = B_TRUE; 4149 break; 4150 case 'w': 4151 wait = B_TRUE; 4152 break; 4153 case '?': 4154 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 4155 optopt); 4156 usage(B_FALSE); 4157 } 4158 } 4159 4160 if (wait && !discard) { 4161 (void) fprintf(stderr, gettext("--wait only valid when " 4162 "--discard also specified\n")); 4163 usage(B_FALSE); 4164 } 4165 4166 argc -= optind; 4167 argv += optind; 4168 4169 if (argc < 1) { 4170 (void) fprintf(stderr, gettext("missing pool argument\n")); 4171 usage(B_FALSE); 4172 } 4173 4174 if (argc > 1) { 4175 (void) fprintf(stderr, gettext("too many arguments\n")); 4176 usage(B_FALSE); 4177 } 4178 4179 pool = argv[0]; 4180 4181 if ((zhp = zpool_open(g_zfs, pool)) == NULL) { 4182 /* As a special case, check for use of '/' in the name */ 4183 if (strchr(pool, '/') != NULL) 4184 (void) fprintf(stderr, gettext("'zpool checkpoint' " 4185 "doesn't work on datasets. To save the state " 4186 "of a dataset from a specific point in time " 4187 "please use 'zfs snapshot'\n")); 4188 return (1); 4189 } 4190 4191 if (discard) { 4192 err = (zpool_discard_checkpoint(zhp) != 0); 4193 if (err == 0 && wait) 4194 err = zpool_wait(zhp, ZPOOL_WAIT_CKPT_DISCARD); 4195 } else { 4196 err = (zpool_checkpoint(zhp) != 0); 4197 } 4198 4199 zpool_close(zhp); 4200 4201 return (err); 4202 } 4203 4204 #define CHECKPOINT_OPT 1024 4205 4206 /* 4207 * zpool prefetch <type> [<type opts>] <pool> 4208 * 4209 * Prefetchs a particular type of data in the specified pool. 4210 */ 4211 int 4212 zpool_do_prefetch(int argc, char **argv) 4213 { 4214 int c; 4215 char *poolname; 4216 char *typestr = NULL; 4217 zpool_prefetch_type_t type; 4218 zpool_handle_t *zhp; 4219 int err = 0; 4220 4221 while ((c = getopt(argc, argv, "t:")) != -1) { 4222 switch (c) { 4223 case 't': 4224 typestr = optarg; 4225 break; 4226 case ':': 4227 (void) fprintf(stderr, gettext("missing argument for " 4228 "'%c' option\n"), optopt); 4229 usage(B_FALSE); 4230 break; 4231 case '?': 4232 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 4233 optopt); 4234 usage(B_FALSE); 4235 } 4236 } 4237 argc -= optind; 4238 argv += optind; 4239 4240 if (argc < 1) { 4241 (void) fprintf(stderr, gettext("missing pool name argument\n")); 4242 usage(B_FALSE); 4243 } 4244 4245 if (argc > 1) { 4246 (void) fprintf(stderr, gettext("too many arguments\n")); 4247 usage(B_FALSE); 4248 } 4249 4250 poolname = argv[0]; 4251 4252 argc--; 4253 argv++; 4254 4255 if (strcmp(typestr, "ddt") == 0) { 4256 type = ZPOOL_PREFETCH_DDT; 4257 } else { 4258 (void) fprintf(stderr, gettext("unsupported prefetch type\n")); 4259 usage(B_FALSE); 4260 } 4261 4262 if ((zhp = zpool_open(g_zfs, poolname)) == NULL) 4263 return (1); 4264 4265 err = zpool_prefetch(zhp, type); 4266 4267 zpool_close(zhp); 4268 4269 return (err); 4270 } 4271 4272 /* 4273 * zpool import [-d dir] [-D] 4274 * import [-o mntopts] [-o prop=value] ... [-R root] [-D] [-l] 4275 * [-d dir | -c cachefile | -s] [-f] -a 4276 * import [-o mntopts] [-o prop=value] ... [-R root] [-D] [-l] 4277 * [-d dir | -c cachefile | -s] [-f] [-n] [-F] <pool | id> 4278 * [newpool] 4279 * 4280 * -c Read pool information from a cachefile instead of searching 4281 * devices. If importing from a cachefile config fails, then 4282 * fallback to searching for devices only in the directories that 4283 * exist in the cachefile. 4284 * 4285 * -d Scan in a specific directory, other than /dev/. More than 4286 * one directory can be specified using multiple '-d' options. 4287 * 4288 * -D Scan for previously destroyed pools or import all or only 4289 * specified destroyed pools. 4290 * 4291 * -R Temporarily import the pool, with all mountpoints relative to 4292 * the given root. The pool will remain exported when the machine 4293 * is rebooted. 4294 * 4295 * -V Import even in the presence of faulted vdevs. This is an 4296 * intentionally undocumented option for testing purposes, and 4297 * treats the pool configuration as complete, leaving any bad 4298 * vdevs in the FAULTED state. In other words, it does verbatim 4299 * import. 4300 * 4301 * -f Force import, even if it appears that the pool is active. 4302 * 4303 * -F Attempt rewind if necessary. 4304 * 4305 * -n See if rewind would work, but don't actually rewind. 4306 * 4307 * -N Import the pool but don't mount datasets. 4308 * 4309 * -T Specify a starting txg to use for import. This option is 4310 * intentionally undocumented option for testing purposes. 4311 * 4312 * -a Import all pools found. 4313 * 4314 * -l Load encryption keys while importing. 4315 * 4316 * -o Set property=value and/or temporary mount options (without '='). 4317 * 4318 * -s Scan using the default search path, the libblkid cache will 4319 * not be consulted. 4320 * 4321 * --rewind-to-checkpoint 4322 * Import the pool and revert back to the checkpoint. 4323 * 4324 * The import command scans for pools to import, and import pools based on pool 4325 * name and GUID. The pool can also be renamed as part of the import process. 4326 */ 4327 int 4328 zpool_do_import(int argc, char **argv) 4329 { 4330 char **searchdirs = NULL; 4331 char *env, *envdup = NULL; 4332 int nsearch = 0; 4333 int c; 4334 int err = 0; 4335 nvlist_t *pools = NULL; 4336 boolean_t do_all = B_FALSE; 4337 boolean_t do_destroyed = B_FALSE; 4338 char *mntopts = NULL; 4339 uint64_t searchguid = 0; 4340 char *searchname = NULL; 4341 char *propval; 4342 nvlist_t *policy = NULL; 4343 nvlist_t *props = NULL; 4344 int flags = ZFS_IMPORT_NORMAL; 4345 uint32_t rewind_policy = ZPOOL_NO_REWIND; 4346 boolean_t dryrun = B_FALSE; 4347 boolean_t do_rewind = B_FALSE; 4348 boolean_t xtreme_rewind = B_FALSE; 4349 boolean_t do_scan = B_FALSE; 4350 boolean_t pool_exists = B_FALSE; 4351 uint64_t txg = -1ULL; 4352 char *cachefile = NULL; 4353 importargs_t idata = { 0 }; 4354 char *endptr; 4355 4356 struct option long_options[] = { 4357 {"rewind-to-checkpoint", no_argument, NULL, CHECKPOINT_OPT}, 4358 {0, 0, 0, 0} 4359 }; 4360 4361 /* check options */ 4362 while ((c = getopt_long(argc, argv, ":aCc:d:DEfFlmnNo:R:stT:VX", 4363 long_options, NULL)) != -1) { 4364 switch (c) { 4365 case 'a': 4366 do_all = B_TRUE; 4367 break; 4368 case 'c': 4369 cachefile = optarg; 4370 break; 4371 case 'd': 4372 searchdirs = safe_realloc(searchdirs, 4373 (nsearch + 1) * sizeof (char *)); 4374 searchdirs[nsearch++] = optarg; 4375 break; 4376 case 'D': 4377 do_destroyed = B_TRUE; 4378 break; 4379 case 'f': 4380 flags |= ZFS_IMPORT_ANY_HOST; 4381 break; 4382 case 'F': 4383 do_rewind = B_TRUE; 4384 break; 4385 case 'l': 4386 flags |= ZFS_IMPORT_LOAD_KEYS; 4387 break; 4388 case 'm': 4389 flags |= ZFS_IMPORT_MISSING_LOG; 4390 break; 4391 case 'n': 4392 dryrun = B_TRUE; 4393 break; 4394 case 'N': 4395 flags |= ZFS_IMPORT_ONLY; 4396 break; 4397 case 'o': 4398 if ((propval = strchr(optarg, '=')) != NULL) { 4399 *propval = '\0'; 4400 propval++; 4401 if (add_prop_list(optarg, propval, 4402 &props, B_TRUE)) 4403 goto error; 4404 } else { 4405 mntopts = optarg; 4406 } 4407 break; 4408 case 'R': 4409 if (add_prop_list(zpool_prop_to_name( 4410 ZPOOL_PROP_ALTROOT), optarg, &props, B_TRUE)) 4411 goto error; 4412 if (add_prop_list_default(zpool_prop_to_name( 4413 ZPOOL_PROP_CACHEFILE), "none", &props)) 4414 goto error; 4415 break; 4416 case 's': 4417 do_scan = B_TRUE; 4418 break; 4419 case 't': 4420 flags |= ZFS_IMPORT_TEMP_NAME; 4421 if (add_prop_list_default(zpool_prop_to_name( 4422 ZPOOL_PROP_CACHEFILE), "none", &props)) 4423 goto error; 4424 break; 4425 4426 case 'T': 4427 errno = 0; 4428 txg = strtoull(optarg, &endptr, 0); 4429 if (errno != 0 || *endptr != '\0') { 4430 (void) fprintf(stderr, 4431 gettext("invalid txg value\n")); 4432 usage(B_FALSE); 4433 } 4434 rewind_policy = ZPOOL_DO_REWIND | ZPOOL_EXTREME_REWIND; 4435 break; 4436 case 'V': 4437 flags |= ZFS_IMPORT_VERBATIM; 4438 break; 4439 case 'X': 4440 xtreme_rewind = B_TRUE; 4441 break; 4442 case CHECKPOINT_OPT: 4443 flags |= ZFS_IMPORT_CHECKPOINT; 4444 break; 4445 case ':': 4446 (void) fprintf(stderr, gettext("missing argument for " 4447 "'%c' option\n"), optopt); 4448 usage(B_FALSE); 4449 break; 4450 case '?': 4451 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 4452 optopt); 4453 usage(B_FALSE); 4454 } 4455 } 4456 4457 argc -= optind; 4458 argv += optind; 4459 4460 if (cachefile && nsearch != 0) { 4461 (void) fprintf(stderr, gettext("-c is incompatible with -d\n")); 4462 usage(B_FALSE); 4463 } 4464 4465 if (cachefile && do_scan) { 4466 (void) fprintf(stderr, gettext("-c is incompatible with -s\n")); 4467 usage(B_FALSE); 4468 } 4469 4470 if ((flags & ZFS_IMPORT_LOAD_KEYS) && (flags & ZFS_IMPORT_ONLY)) { 4471 (void) fprintf(stderr, gettext("-l is incompatible with -N\n")); 4472 usage(B_FALSE); 4473 } 4474 4475 if ((flags & ZFS_IMPORT_LOAD_KEYS) && !do_all && argc == 0) { 4476 (void) fprintf(stderr, gettext("-l is only meaningful during " 4477 "an import\n")); 4478 usage(B_FALSE); 4479 } 4480 4481 if ((dryrun || xtreme_rewind) && !do_rewind) { 4482 (void) fprintf(stderr, 4483 gettext("-n or -X only meaningful with -F\n")); 4484 usage(B_FALSE); 4485 } 4486 if (dryrun) 4487 rewind_policy = ZPOOL_TRY_REWIND; 4488 else if (do_rewind) 4489 rewind_policy = ZPOOL_DO_REWIND; 4490 if (xtreme_rewind) 4491 rewind_policy |= ZPOOL_EXTREME_REWIND; 4492 4493 /* In the future, we can capture further policy and include it here */ 4494 if (nvlist_alloc(&policy, NV_UNIQUE_NAME, 0) != 0 || 4495 nvlist_add_uint64(policy, ZPOOL_LOAD_REQUEST_TXG, txg) != 0 || 4496 nvlist_add_uint32(policy, ZPOOL_LOAD_REWIND_POLICY, 4497 rewind_policy) != 0) 4498 goto error; 4499 4500 /* check argument count */ 4501 if (do_all) { 4502 if (argc != 0) { 4503 (void) fprintf(stderr, gettext("too many arguments\n")); 4504 usage(B_FALSE); 4505 } 4506 } else { 4507 if (argc > 2) { 4508 (void) fprintf(stderr, gettext("too many arguments\n")); 4509 usage(B_FALSE); 4510 } 4511 } 4512 4513 /* 4514 * Check for the effective uid. We do this explicitly here because 4515 * otherwise any attempt to discover pools will silently fail. 4516 */ 4517 if (argc == 0 && geteuid() != 0) { 4518 (void) fprintf(stderr, gettext("cannot " 4519 "discover pools: permission denied\n")); 4520 4521 free(searchdirs); 4522 nvlist_free(props); 4523 nvlist_free(policy); 4524 return (1); 4525 } 4526 4527 /* 4528 * Depending on the arguments given, we do one of the following: 4529 * 4530 * <none> Iterate through all pools and display information about 4531 * each one. 4532 * 4533 * -a Iterate through all pools and try to import each one. 4534 * 4535 * <id> Find the pool that corresponds to the given GUID/pool 4536 * name and import that one. 4537 * 4538 * -D Above options applies only to destroyed pools. 4539 */ 4540 if (argc != 0) { 4541 char *endptr; 4542 4543 errno = 0; 4544 searchguid = strtoull(argv[0], &endptr, 10); 4545 if (errno != 0 || *endptr != '\0') { 4546 searchname = argv[0]; 4547 searchguid = 0; 4548 } 4549 4550 /* 4551 * User specified a name or guid. Ensure it's unique. 4552 */ 4553 target_exists_args_t search = {searchname, searchguid}; 4554 pool_exists = zpool_iter(g_zfs, name_or_guid_exists, &search); 4555 } 4556 4557 /* 4558 * Check the environment for the preferred search path. 4559 */ 4560 if ((searchdirs == NULL) && (env = getenv("ZPOOL_IMPORT_PATH"))) { 4561 char *dir, *tmp = NULL; 4562 4563 envdup = strdup(env); 4564 4565 for (dir = strtok_r(envdup, ":", &tmp); 4566 dir != NULL; 4567 dir = strtok_r(NULL, ":", &tmp)) { 4568 searchdirs = safe_realloc(searchdirs, 4569 (nsearch + 1) * sizeof (char *)); 4570 searchdirs[nsearch++] = dir; 4571 } 4572 } 4573 4574 idata.path = searchdirs; 4575 idata.paths = nsearch; 4576 idata.poolname = searchname; 4577 idata.guid = searchguid; 4578 idata.cachefile = cachefile; 4579 idata.scan = do_scan; 4580 idata.policy = policy; 4581 idata.do_destroyed = do_destroyed; 4582 idata.do_all = do_all; 4583 4584 libpc_handle_t lpch = { 4585 .lpc_lib_handle = g_zfs, 4586 .lpc_ops = &libzfs_config_ops, 4587 .lpc_printerr = B_TRUE 4588 }; 4589 pools = zpool_search_import(&lpch, &idata); 4590 4591 if (pools != NULL && pool_exists && 4592 (argc == 1 || strcmp(argv[0], argv[1]) == 0)) { 4593 (void) fprintf(stderr, gettext("cannot import '%s': " 4594 "a pool with that name already exists\n"), 4595 argv[0]); 4596 (void) fprintf(stderr, gettext("use the form '%s " 4597 "<pool | id> <newpool>' to give it a new name\n"), 4598 "zpool import"); 4599 err = 1; 4600 } else if (pools == NULL && pool_exists) { 4601 (void) fprintf(stderr, gettext("cannot import '%s': " 4602 "a pool with that name is already created/imported,\n"), 4603 argv[0]); 4604 (void) fprintf(stderr, gettext("and no additional pools " 4605 "with that name were found\n")); 4606 err = 1; 4607 } else if (pools == NULL) { 4608 if (argc != 0) { 4609 (void) fprintf(stderr, gettext("cannot import '%s': " 4610 "no such pool available\n"), argv[0]); 4611 } 4612 err = 1; 4613 } 4614 4615 if (err == 1) { 4616 free(searchdirs); 4617 free(envdup); 4618 nvlist_free(policy); 4619 nvlist_free(pools); 4620 nvlist_free(props); 4621 return (1); 4622 } 4623 4624 err = import_pools(pools, props, mntopts, flags, 4625 argc >= 1 ? argv[0] : NULL, argc >= 2 ? argv[1] : NULL, &idata); 4626 4627 /* 4628 * If we're using the cachefile and we failed to import, then 4629 * fallback to scanning the directory for pools that match 4630 * those in the cachefile. 4631 */ 4632 if (err != 0 && cachefile != NULL) { 4633 (void) printf(gettext("cachefile import failed, retrying\n")); 4634 4635 /* 4636 * We use the scan flag to gather the directories that exist 4637 * in the cachefile. If we need to fallback to searching for 4638 * the pool config, we will only search devices in these 4639 * directories. 4640 */ 4641 idata.scan = B_TRUE; 4642 nvlist_free(pools); 4643 pools = zpool_search_import(&lpch, &idata); 4644 4645 err = import_pools(pools, props, mntopts, flags, 4646 argc >= 1 ? argv[0] : NULL, argc >= 2 ? argv[1] : NULL, 4647 &idata); 4648 } 4649 4650 error: 4651 nvlist_free(props); 4652 nvlist_free(pools); 4653 nvlist_free(policy); 4654 free(searchdirs); 4655 free(envdup); 4656 4657 return (err ? 1 : 0); 4658 } 4659 4660 /* 4661 * zpool sync [-f] [pool] ... 4662 * 4663 * -f (undocumented) force uberblock (and config including zpool cache file) 4664 * update. 4665 * 4666 * Sync the specified pool(s). 4667 * Without arguments "zpool sync" will sync all pools. 4668 * This command initiates TXG sync(s) and will return after the TXG(s) commit. 4669 * 4670 */ 4671 static int 4672 zpool_do_sync(int argc, char **argv) 4673 { 4674 int ret; 4675 boolean_t force = B_FALSE; 4676 4677 /* check options */ 4678 while ((ret = getopt(argc, argv, "f")) != -1) { 4679 switch (ret) { 4680 case 'f': 4681 force = B_TRUE; 4682 break; 4683 case '?': 4684 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 4685 optopt); 4686 usage(B_FALSE); 4687 } 4688 } 4689 4690 argc -= optind; 4691 argv += optind; 4692 4693 /* if argc == 0 we will execute zpool_sync_one on all pools */ 4694 ret = for_each_pool(argc, argv, B_FALSE, NULL, ZFS_TYPE_POOL, 4695 B_FALSE, zpool_sync_one, &force); 4696 4697 return (ret); 4698 } 4699 4700 typedef struct iostat_cbdata { 4701 uint64_t cb_flags; 4702 int cb_namewidth; 4703 int cb_iteration; 4704 boolean_t cb_verbose; 4705 boolean_t cb_literal; 4706 boolean_t cb_scripted; 4707 zpool_list_t *cb_list; 4708 vdev_cmd_data_list_t *vcdl; 4709 vdev_cbdata_t cb_vdevs; 4710 } iostat_cbdata_t; 4711 4712 /* iostat labels */ 4713 typedef struct name_and_columns { 4714 const char *name; /* Column name */ 4715 unsigned int columns; /* Center name to this number of columns */ 4716 } name_and_columns_t; 4717 4718 #define IOSTAT_MAX_LABELS 15 /* Max number of labels on one line */ 4719 4720 static const name_and_columns_t iostat_top_labels[][IOSTAT_MAX_LABELS] = 4721 { 4722 [IOS_DEFAULT] = {{"capacity", 2}, {"operations", 2}, {"bandwidth", 2}, 4723 {NULL}}, 4724 [IOS_LATENCY] = {{"total_wait", 2}, {"disk_wait", 2}, {"syncq_wait", 2}, 4725 {"asyncq_wait", 2}, {"scrub", 1}, {"trim", 1}, {"rebuild", 1}, 4726 {NULL}}, 4727 [IOS_QUEUES] = {{"syncq_read", 2}, {"syncq_write", 2}, 4728 {"asyncq_read", 2}, {"asyncq_write", 2}, {"scrubq_read", 2}, 4729 {"trimq_write", 2}, {"rebuildq_write", 2}, {NULL}}, 4730 [IOS_L_HISTO] = {{"total_wait", 2}, {"disk_wait", 2}, {"syncq_wait", 2}, 4731 {"asyncq_wait", 2}, {NULL}}, 4732 [IOS_RQ_HISTO] = {{"sync_read", 2}, {"sync_write", 2}, 4733 {"async_read", 2}, {"async_write", 2}, {"scrub", 2}, 4734 {"trim", 2}, {"rebuild", 2}, {NULL}}, 4735 }; 4736 4737 /* Shorthand - if "columns" field not set, default to 1 column */ 4738 static const name_and_columns_t iostat_bottom_labels[][IOSTAT_MAX_LABELS] = 4739 { 4740 [IOS_DEFAULT] = {{"alloc"}, {"free"}, {"read"}, {"write"}, {"read"}, 4741 {"write"}, {NULL}}, 4742 [IOS_LATENCY] = {{"read"}, {"write"}, {"read"}, {"write"}, {"read"}, 4743 {"write"}, {"read"}, {"write"}, {"wait"}, {"wait"}, {"wait"}, 4744 {NULL}}, 4745 [IOS_QUEUES] = {{"pend"}, {"activ"}, {"pend"}, {"activ"}, {"pend"}, 4746 {"activ"}, {"pend"}, {"activ"}, {"pend"}, {"activ"}, 4747 {"pend"}, {"activ"}, {"pend"}, {"activ"}, {NULL}}, 4748 [IOS_L_HISTO] = {{"read"}, {"write"}, {"read"}, {"write"}, {"read"}, 4749 {"write"}, {"read"}, {"write"}, {"scrub"}, {"trim"}, {"rebuild"}, 4750 {NULL}}, 4751 [IOS_RQ_HISTO] = {{"ind"}, {"agg"}, {"ind"}, {"agg"}, {"ind"}, {"agg"}, 4752 {"ind"}, {"agg"}, {"ind"}, {"agg"}, {"ind"}, {"agg"}, 4753 {"ind"}, {"agg"}, {NULL}}, 4754 }; 4755 4756 static const char *histo_to_title[] = { 4757 [IOS_L_HISTO] = "latency", 4758 [IOS_RQ_HISTO] = "req_size", 4759 }; 4760 4761 /* 4762 * Return the number of labels in a null-terminated name_and_columns_t 4763 * array. 4764 * 4765 */ 4766 static unsigned int 4767 label_array_len(const name_and_columns_t *labels) 4768 { 4769 int i = 0; 4770 4771 while (labels[i].name) 4772 i++; 4773 4774 return (i); 4775 } 4776 4777 /* 4778 * Return the number of strings in a null-terminated string array. 4779 * For example: 4780 * 4781 * const char foo[] = {"bar", "baz", NULL} 4782 * 4783 * returns 2 4784 */ 4785 static uint64_t 4786 str_array_len(const char *array[]) 4787 { 4788 uint64_t i = 0; 4789 while (array[i]) 4790 i++; 4791 4792 return (i); 4793 } 4794 4795 4796 /* 4797 * Return a default column width for default/latency/queue columns. This does 4798 * not include histograms, which have their columns autosized. 4799 */ 4800 static unsigned int 4801 default_column_width(iostat_cbdata_t *cb, enum iostat_type type) 4802 { 4803 unsigned long column_width = 5; /* Normal niceprint */ 4804 static unsigned long widths[] = { 4805 /* 4806 * Choose some sane default column sizes for printing the 4807 * raw numbers. 4808 */ 4809 [IOS_DEFAULT] = 15, /* 1PB capacity */ 4810 [IOS_LATENCY] = 10, /* 1B ns = 10sec */ 4811 [IOS_QUEUES] = 6, /* 1M queue entries */ 4812 [IOS_L_HISTO] = 10, /* 1B ns = 10sec */ 4813 [IOS_RQ_HISTO] = 6, /* 1M queue entries */ 4814 }; 4815 4816 if (cb->cb_literal) 4817 column_width = widths[type]; 4818 4819 return (column_width); 4820 } 4821 4822 /* 4823 * Print the column labels, i.e: 4824 * 4825 * capacity operations bandwidth 4826 * alloc free read write read write ... 4827 * 4828 * If force_column_width is set, use it for the column width. If not set, use 4829 * the default column width. 4830 */ 4831 static void 4832 print_iostat_labels(iostat_cbdata_t *cb, unsigned int force_column_width, 4833 const name_and_columns_t labels[][IOSTAT_MAX_LABELS]) 4834 { 4835 int i, idx, s; 4836 int text_start, rw_column_width, spaces_to_end; 4837 uint64_t flags = cb->cb_flags; 4838 uint64_t f; 4839 unsigned int column_width = force_column_width; 4840 4841 /* For each bit set in flags */ 4842 for (f = flags; f; f &= ~(1ULL << idx)) { 4843 idx = lowbit64(f) - 1; 4844 if (!force_column_width) 4845 column_width = default_column_width(cb, idx); 4846 /* Print our top labels centered over "read write" label. */ 4847 for (i = 0; i < label_array_len(labels[idx]); i++) { 4848 const char *name = labels[idx][i].name; 4849 /* 4850 * We treat labels[][].columns == 0 as shorthand 4851 * for one column. It makes writing out the label 4852 * tables more concise. 4853 */ 4854 unsigned int columns = MAX(1, labels[idx][i].columns); 4855 unsigned int slen = strlen(name); 4856 4857 rw_column_width = (column_width * columns) + 4858 (2 * (columns - 1)); 4859 4860 text_start = (int)((rw_column_width) / columns - 4861 slen / columns); 4862 if (text_start < 0) 4863 text_start = 0; 4864 4865 printf(" "); /* Two spaces between columns */ 4866 4867 /* Space from beginning of column to label */ 4868 for (s = 0; s < text_start; s++) 4869 printf(" "); 4870 4871 printf("%s", name); 4872 4873 /* Print space after label to end of column */ 4874 spaces_to_end = rw_column_width - text_start - slen; 4875 if (spaces_to_end < 0) 4876 spaces_to_end = 0; 4877 4878 for (s = 0; s < spaces_to_end; s++) 4879 printf(" "); 4880 } 4881 } 4882 } 4883 4884 4885 /* 4886 * print_cmd_columns - Print custom column titles from -c 4887 * 4888 * If the user specified the "zpool status|iostat -c" then print their custom 4889 * column titles in the header. For example, print_cmd_columns() would print 4890 * the " col1 col2" part of this: 4891 * 4892 * $ zpool iostat -vc 'echo col1=val1; echo col2=val2' 4893 * ... 4894 * capacity operations bandwidth 4895 * pool alloc free read write read write col1 col2 4896 * ---------- ----- ----- ----- ----- ----- ----- ---- ---- 4897 * mypool 269K 1008M 0 0 107 946 4898 * mirror 269K 1008M 0 0 107 946 4899 * sdb - - 0 0 102 473 val1 val2 4900 * sdc - - 0 0 5 473 val1 val2 4901 * ---------- ----- ----- ----- ----- ----- ----- ---- ---- 4902 */ 4903 static void 4904 print_cmd_columns(vdev_cmd_data_list_t *vcdl, int use_dashes) 4905 { 4906 int i, j; 4907 vdev_cmd_data_t *data = &vcdl->data[0]; 4908 4909 if (vcdl->count == 0 || data == NULL) 4910 return; 4911 4912 /* 4913 * Each vdev cmd should have the same column names unless the user did 4914 * something weird with their cmd. Just take the column names from the 4915 * first vdev and assume it works for all of them. 4916 */ 4917 for (i = 0; i < vcdl->uniq_cols_cnt; i++) { 4918 printf(" "); 4919 if (use_dashes) { 4920 for (j = 0; j < vcdl->uniq_cols_width[i]; j++) 4921 printf("-"); 4922 } else { 4923 printf_color(ANSI_BOLD, "%*s", vcdl->uniq_cols_width[i], 4924 vcdl->uniq_cols[i]); 4925 } 4926 } 4927 } 4928 4929 4930 /* 4931 * Utility function to print out a line of dashes like: 4932 * 4933 * -------------------------------- ----- ----- ----- ----- ----- 4934 * 4935 * ...or a dashed named-row line like: 4936 * 4937 * logs - - - - - 4938 * 4939 * @cb: iostat data 4940 * 4941 * @force_column_width If non-zero, use the value as the column width. 4942 * Otherwise use the default column widths. 4943 * 4944 * @name: Print a dashed named-row line starting 4945 * with @name. Otherwise, print a regular 4946 * dashed line. 4947 */ 4948 static void 4949 print_iostat_dashes(iostat_cbdata_t *cb, unsigned int force_column_width, 4950 const char *name) 4951 { 4952 int i; 4953 unsigned int namewidth; 4954 uint64_t flags = cb->cb_flags; 4955 uint64_t f; 4956 int idx; 4957 const name_and_columns_t *labels; 4958 const char *title; 4959 4960 4961 if (cb->cb_flags & IOS_ANYHISTO_M) { 4962 title = histo_to_title[IOS_HISTO_IDX(cb->cb_flags)]; 4963 } else if (cb->cb_vdevs.cb_names_count) { 4964 title = "vdev"; 4965 } else { 4966 title = "pool"; 4967 } 4968 4969 namewidth = MAX(MAX(strlen(title), cb->cb_namewidth), 4970 name ? strlen(name) : 0); 4971 4972 4973 if (name) { 4974 printf("%-*s", namewidth, name); 4975 } else { 4976 for (i = 0; i < namewidth; i++) 4977 (void) printf("-"); 4978 } 4979 4980 /* For each bit in flags */ 4981 for (f = flags; f; f &= ~(1ULL << idx)) { 4982 unsigned int column_width; 4983 idx = lowbit64(f) - 1; 4984 if (force_column_width) 4985 column_width = force_column_width; 4986 else 4987 column_width = default_column_width(cb, idx); 4988 4989 labels = iostat_bottom_labels[idx]; 4990 for (i = 0; i < label_array_len(labels); i++) { 4991 if (name) 4992 printf(" %*s-", column_width - 1, " "); 4993 else 4994 printf(" %.*s", column_width, 4995 "--------------------"); 4996 } 4997 } 4998 } 4999 5000 5001 static void 5002 print_iostat_separator_impl(iostat_cbdata_t *cb, 5003 unsigned int force_column_width) 5004 { 5005 print_iostat_dashes(cb, force_column_width, NULL); 5006 } 5007 5008 static void 5009 print_iostat_separator(iostat_cbdata_t *cb) 5010 { 5011 print_iostat_separator_impl(cb, 0); 5012 } 5013 5014 static void 5015 print_iostat_header_impl(iostat_cbdata_t *cb, unsigned int force_column_width, 5016 const char *histo_vdev_name) 5017 { 5018 unsigned int namewidth; 5019 const char *title; 5020 5021 color_start(ANSI_BOLD); 5022 5023 if (cb->cb_flags & IOS_ANYHISTO_M) { 5024 title = histo_to_title[IOS_HISTO_IDX(cb->cb_flags)]; 5025 } else if (cb->cb_vdevs.cb_names_count) { 5026 title = "vdev"; 5027 } else { 5028 title = "pool"; 5029 } 5030 5031 namewidth = MAX(MAX(strlen(title), cb->cb_namewidth), 5032 histo_vdev_name ? strlen(histo_vdev_name) : 0); 5033 5034 if (histo_vdev_name) 5035 printf("%-*s", namewidth, histo_vdev_name); 5036 else 5037 printf("%*s", namewidth, ""); 5038 5039 5040 print_iostat_labels(cb, force_column_width, iostat_top_labels); 5041 printf("\n"); 5042 5043 printf("%-*s", namewidth, title); 5044 5045 print_iostat_labels(cb, force_column_width, iostat_bottom_labels); 5046 if (cb->vcdl != NULL) 5047 print_cmd_columns(cb->vcdl, 0); 5048 5049 printf("\n"); 5050 5051 print_iostat_separator_impl(cb, force_column_width); 5052 5053 if (cb->vcdl != NULL) 5054 print_cmd_columns(cb->vcdl, 1); 5055 5056 color_end(); 5057 5058 printf("\n"); 5059 } 5060 5061 static void 5062 print_iostat_header(iostat_cbdata_t *cb) 5063 { 5064 print_iostat_header_impl(cb, 0, NULL); 5065 } 5066 5067 /* 5068 * Prints a size string (i.e. 120M) with the suffix ("M") colored 5069 * by order of magnitude. Uses column_size to add padding. 5070 */ 5071 static void 5072 print_stat_color(const char *statbuf, unsigned int column_size) 5073 { 5074 fputs(" ", stdout); 5075 size_t len = strlen(statbuf); 5076 while (len < column_size) { 5077 fputc(' ', stdout); 5078 column_size--; 5079 } 5080 if (*statbuf == '0') { 5081 color_start(ANSI_GRAY); 5082 fputc('0', stdout); 5083 } else { 5084 for (; *statbuf; statbuf++) { 5085 if (*statbuf == 'K') color_start(ANSI_GREEN); 5086 else if (*statbuf == 'M') color_start(ANSI_YELLOW); 5087 else if (*statbuf == 'G') color_start(ANSI_RED); 5088 else if (*statbuf == 'T') color_start(ANSI_BOLD_BLUE); 5089 else if (*statbuf == 'P') color_start(ANSI_MAGENTA); 5090 else if (*statbuf == 'E') color_start(ANSI_CYAN); 5091 fputc(*statbuf, stdout); 5092 if (--column_size <= 0) 5093 break; 5094 } 5095 } 5096 color_end(); 5097 } 5098 5099 /* 5100 * Display a single statistic. 5101 */ 5102 static void 5103 print_one_stat(uint64_t value, enum zfs_nicenum_format format, 5104 unsigned int column_size, boolean_t scripted) 5105 { 5106 char buf[64]; 5107 5108 zfs_nicenum_format(value, buf, sizeof (buf), format); 5109 5110 if (scripted) 5111 printf("\t%s", buf); 5112 else 5113 print_stat_color(buf, column_size); 5114 } 5115 5116 /* 5117 * Calculate the default vdev stats 5118 * 5119 * Subtract oldvs from newvs, apply a scaling factor, and save the resulting 5120 * stats into calcvs. 5121 */ 5122 static void 5123 calc_default_iostats(vdev_stat_t *oldvs, vdev_stat_t *newvs, 5124 vdev_stat_t *calcvs) 5125 { 5126 int i; 5127 5128 memcpy(calcvs, newvs, sizeof (*calcvs)); 5129 for (i = 0; i < ARRAY_SIZE(calcvs->vs_ops); i++) 5130 calcvs->vs_ops[i] = (newvs->vs_ops[i] - oldvs->vs_ops[i]); 5131 5132 for (i = 0; i < ARRAY_SIZE(calcvs->vs_bytes); i++) 5133 calcvs->vs_bytes[i] = (newvs->vs_bytes[i] - oldvs->vs_bytes[i]); 5134 } 5135 5136 /* 5137 * Internal representation of the extended iostats data. 5138 * 5139 * The extended iostat stats are exported in nvlists as either uint64_t arrays 5140 * or single uint64_t's. We make both look like arrays to make them easier 5141 * to process. In order to make single uint64_t's look like arrays, we set 5142 * __data to the stat data, and then set *data = &__data with count = 1. Then, 5143 * we can just use *data and count. 5144 */ 5145 struct stat_array { 5146 uint64_t *data; 5147 uint_t count; /* Number of entries in data[] */ 5148 uint64_t __data; /* Only used when data is a single uint64_t */ 5149 }; 5150 5151 static uint64_t 5152 stat_histo_max(struct stat_array *nva, unsigned int len) 5153 { 5154 uint64_t max = 0; 5155 int i; 5156 for (i = 0; i < len; i++) 5157 max = MAX(max, array64_max(nva[i].data, nva[i].count)); 5158 5159 return (max); 5160 } 5161 5162 /* 5163 * Helper function to lookup a uint64_t array or uint64_t value and store its 5164 * data as a stat_array. If the nvpair is a single uint64_t value, then we make 5165 * it look like a one element array to make it easier to process. 5166 */ 5167 static int 5168 nvpair64_to_stat_array(nvlist_t *nvl, const char *name, 5169 struct stat_array *nva) 5170 { 5171 nvpair_t *tmp; 5172 int ret; 5173 5174 verify(nvlist_lookup_nvpair(nvl, name, &tmp) == 0); 5175 switch (nvpair_type(tmp)) { 5176 case DATA_TYPE_UINT64_ARRAY: 5177 ret = nvpair_value_uint64_array(tmp, &nva->data, &nva->count); 5178 break; 5179 case DATA_TYPE_UINT64: 5180 ret = nvpair_value_uint64(tmp, &nva->__data); 5181 nva->data = &nva->__data; 5182 nva->count = 1; 5183 break; 5184 default: 5185 /* Not a uint64_t */ 5186 ret = EINVAL; 5187 break; 5188 } 5189 5190 return (ret); 5191 } 5192 5193 /* 5194 * Given a list of nvlist names, look up the extended stats in newnv and oldnv, 5195 * subtract them, and return the results in a newly allocated stat_array. 5196 * You must free the returned array after you are done with it with 5197 * free_calc_stats(). 5198 * 5199 * Additionally, you can set "oldnv" to NULL if you simply want the newnv 5200 * values. 5201 */ 5202 static struct stat_array * 5203 calc_and_alloc_stats_ex(const char **names, unsigned int len, nvlist_t *oldnv, 5204 nvlist_t *newnv) 5205 { 5206 nvlist_t *oldnvx = NULL, *newnvx; 5207 struct stat_array *oldnva, *newnva, *calcnva; 5208 int i, j; 5209 unsigned int alloc_size = (sizeof (struct stat_array)) * len; 5210 5211 /* Extract our extended stats nvlist from the main list */ 5212 verify(nvlist_lookup_nvlist(newnv, ZPOOL_CONFIG_VDEV_STATS_EX, 5213 &newnvx) == 0); 5214 if (oldnv) { 5215 verify(nvlist_lookup_nvlist(oldnv, ZPOOL_CONFIG_VDEV_STATS_EX, 5216 &oldnvx) == 0); 5217 } 5218 5219 newnva = safe_malloc(alloc_size); 5220 oldnva = safe_malloc(alloc_size); 5221 calcnva = safe_malloc(alloc_size); 5222 5223 for (j = 0; j < len; j++) { 5224 verify(nvpair64_to_stat_array(newnvx, names[j], 5225 &newnva[j]) == 0); 5226 calcnva[j].count = newnva[j].count; 5227 alloc_size = calcnva[j].count * sizeof (calcnva[j].data[0]); 5228 calcnva[j].data = safe_malloc(alloc_size); 5229 memcpy(calcnva[j].data, newnva[j].data, alloc_size); 5230 5231 if (oldnvx) { 5232 verify(nvpair64_to_stat_array(oldnvx, names[j], 5233 &oldnva[j]) == 0); 5234 for (i = 0; i < oldnva[j].count; i++) 5235 calcnva[j].data[i] -= oldnva[j].data[i]; 5236 } 5237 } 5238 free(newnva); 5239 free(oldnva); 5240 return (calcnva); 5241 } 5242 5243 static void 5244 free_calc_stats(struct stat_array *nva, unsigned int len) 5245 { 5246 int i; 5247 for (i = 0; i < len; i++) 5248 free(nva[i].data); 5249 5250 free(nva); 5251 } 5252 5253 static void 5254 print_iostat_histo(struct stat_array *nva, unsigned int len, 5255 iostat_cbdata_t *cb, unsigned int column_width, unsigned int namewidth, 5256 double scale) 5257 { 5258 int i, j; 5259 char buf[6]; 5260 uint64_t val; 5261 enum zfs_nicenum_format format; 5262 unsigned int buckets; 5263 unsigned int start_bucket; 5264 5265 if (cb->cb_literal) 5266 format = ZFS_NICENUM_RAW; 5267 else 5268 format = ZFS_NICENUM_1024; 5269 5270 /* All these histos are the same size, so just use nva[0].count */ 5271 buckets = nva[0].count; 5272 5273 if (cb->cb_flags & IOS_RQ_HISTO_M) { 5274 /* Start at 512 - req size should never be lower than this */ 5275 start_bucket = 9; 5276 } else { 5277 start_bucket = 0; 5278 } 5279 5280 for (j = start_bucket; j < buckets; j++) { 5281 /* Print histogram bucket label */ 5282 if (cb->cb_flags & IOS_L_HISTO_M) { 5283 /* Ending range of this bucket */ 5284 val = (1UL << (j + 1)) - 1; 5285 zfs_nicetime(val, buf, sizeof (buf)); 5286 } else { 5287 /* Request size (starting range of bucket) */ 5288 val = (1UL << j); 5289 zfs_nicenum(val, buf, sizeof (buf)); 5290 } 5291 5292 if (cb->cb_scripted) 5293 printf("%llu", (u_longlong_t)val); 5294 else 5295 printf("%-*s", namewidth, buf); 5296 5297 /* Print the values on the line */ 5298 for (i = 0; i < len; i++) { 5299 print_one_stat(nva[i].data[j] * scale, format, 5300 column_width, cb->cb_scripted); 5301 } 5302 printf("\n"); 5303 } 5304 } 5305 5306 static void 5307 print_solid_separator(unsigned int length) 5308 { 5309 while (length--) 5310 printf("-"); 5311 printf("\n"); 5312 } 5313 5314 static void 5315 print_iostat_histos(iostat_cbdata_t *cb, nvlist_t *oldnv, 5316 nvlist_t *newnv, double scale, const char *name) 5317 { 5318 unsigned int column_width; 5319 unsigned int namewidth; 5320 unsigned int entire_width; 5321 enum iostat_type type; 5322 struct stat_array *nva; 5323 const char **names; 5324 unsigned int names_len; 5325 5326 /* What type of histo are we? */ 5327 type = IOS_HISTO_IDX(cb->cb_flags); 5328 5329 /* Get NULL-terminated array of nvlist names for our histo */ 5330 names = vsx_type_to_nvlist[type]; 5331 names_len = str_array_len(names); /* num of names */ 5332 5333 nva = calc_and_alloc_stats_ex(names, names_len, oldnv, newnv); 5334 5335 if (cb->cb_literal) { 5336 column_width = MAX(5, 5337 (unsigned int) log10(stat_histo_max(nva, names_len)) + 1); 5338 } else { 5339 column_width = 5; 5340 } 5341 5342 namewidth = MAX(cb->cb_namewidth, 5343 strlen(histo_to_title[IOS_HISTO_IDX(cb->cb_flags)])); 5344 5345 /* 5346 * Calculate the entire line width of what we're printing. The 5347 * +2 is for the two spaces between columns: 5348 */ 5349 /* read write */ 5350 /* ----- ----- */ 5351 /* |___| <---------- column_width */ 5352 /* */ 5353 /* |__________| <--- entire_width */ 5354 /* */ 5355 entire_width = namewidth + (column_width + 2) * 5356 label_array_len(iostat_bottom_labels[type]); 5357 5358 if (cb->cb_scripted) 5359 printf("%s\n", name); 5360 else 5361 print_iostat_header_impl(cb, column_width, name); 5362 5363 print_iostat_histo(nva, names_len, cb, column_width, 5364 namewidth, scale); 5365 5366 free_calc_stats(nva, names_len); 5367 if (!cb->cb_scripted) 5368 print_solid_separator(entire_width); 5369 } 5370 5371 /* 5372 * Calculate the average latency of a power-of-two latency histogram 5373 */ 5374 static uint64_t 5375 single_histo_average(uint64_t *histo, unsigned int buckets) 5376 { 5377 int i; 5378 uint64_t count = 0, total = 0; 5379 5380 for (i = 0; i < buckets; i++) { 5381 /* 5382 * Our buckets are power-of-two latency ranges. Use the 5383 * midpoint latency of each bucket to calculate the average. 5384 * For example: 5385 * 5386 * Bucket Midpoint 5387 * 8ns-15ns: 12ns 5388 * 16ns-31ns: 24ns 5389 * ... 5390 */ 5391 if (histo[i] != 0) { 5392 total += histo[i] * (((1UL << i) + ((1UL << i)/2))); 5393 count += histo[i]; 5394 } 5395 } 5396 5397 /* Prevent divide by zero */ 5398 return (count == 0 ? 0 : total / count); 5399 } 5400 5401 static void 5402 print_iostat_queues(iostat_cbdata_t *cb, nvlist_t *newnv) 5403 { 5404 const char *names[] = { 5405 ZPOOL_CONFIG_VDEV_SYNC_R_PEND_QUEUE, 5406 ZPOOL_CONFIG_VDEV_SYNC_R_ACTIVE_QUEUE, 5407 ZPOOL_CONFIG_VDEV_SYNC_W_PEND_QUEUE, 5408 ZPOOL_CONFIG_VDEV_SYNC_W_ACTIVE_QUEUE, 5409 ZPOOL_CONFIG_VDEV_ASYNC_R_PEND_QUEUE, 5410 ZPOOL_CONFIG_VDEV_ASYNC_R_ACTIVE_QUEUE, 5411 ZPOOL_CONFIG_VDEV_ASYNC_W_PEND_QUEUE, 5412 ZPOOL_CONFIG_VDEV_ASYNC_W_ACTIVE_QUEUE, 5413 ZPOOL_CONFIG_VDEV_SCRUB_PEND_QUEUE, 5414 ZPOOL_CONFIG_VDEV_SCRUB_ACTIVE_QUEUE, 5415 ZPOOL_CONFIG_VDEV_TRIM_PEND_QUEUE, 5416 ZPOOL_CONFIG_VDEV_TRIM_ACTIVE_QUEUE, 5417 ZPOOL_CONFIG_VDEV_REBUILD_PEND_QUEUE, 5418 ZPOOL_CONFIG_VDEV_REBUILD_ACTIVE_QUEUE, 5419 }; 5420 5421 struct stat_array *nva; 5422 5423 unsigned int column_width = default_column_width(cb, IOS_QUEUES); 5424 enum zfs_nicenum_format format; 5425 5426 nva = calc_and_alloc_stats_ex(names, ARRAY_SIZE(names), NULL, newnv); 5427 5428 if (cb->cb_literal) 5429 format = ZFS_NICENUM_RAW; 5430 else 5431 format = ZFS_NICENUM_1024; 5432 5433 for (int i = 0; i < ARRAY_SIZE(names); i++) { 5434 uint64_t val = nva[i].data[0]; 5435 print_one_stat(val, format, column_width, cb->cb_scripted); 5436 } 5437 5438 free_calc_stats(nva, ARRAY_SIZE(names)); 5439 } 5440 5441 static void 5442 print_iostat_latency(iostat_cbdata_t *cb, nvlist_t *oldnv, 5443 nvlist_t *newnv) 5444 { 5445 int i; 5446 uint64_t val; 5447 const char *names[] = { 5448 ZPOOL_CONFIG_VDEV_TOT_R_LAT_HISTO, 5449 ZPOOL_CONFIG_VDEV_TOT_W_LAT_HISTO, 5450 ZPOOL_CONFIG_VDEV_DISK_R_LAT_HISTO, 5451 ZPOOL_CONFIG_VDEV_DISK_W_LAT_HISTO, 5452 ZPOOL_CONFIG_VDEV_SYNC_R_LAT_HISTO, 5453 ZPOOL_CONFIG_VDEV_SYNC_W_LAT_HISTO, 5454 ZPOOL_CONFIG_VDEV_ASYNC_R_LAT_HISTO, 5455 ZPOOL_CONFIG_VDEV_ASYNC_W_LAT_HISTO, 5456 ZPOOL_CONFIG_VDEV_SCRUB_LAT_HISTO, 5457 ZPOOL_CONFIG_VDEV_TRIM_LAT_HISTO, 5458 ZPOOL_CONFIG_VDEV_REBUILD_LAT_HISTO, 5459 }; 5460 struct stat_array *nva; 5461 5462 unsigned int column_width = default_column_width(cb, IOS_LATENCY); 5463 enum zfs_nicenum_format format; 5464 5465 nva = calc_and_alloc_stats_ex(names, ARRAY_SIZE(names), oldnv, newnv); 5466 5467 if (cb->cb_literal) 5468 format = ZFS_NICENUM_RAWTIME; 5469 else 5470 format = ZFS_NICENUM_TIME; 5471 5472 /* Print our avg latencies on the line */ 5473 for (i = 0; i < ARRAY_SIZE(names); i++) { 5474 /* Compute average latency for a latency histo */ 5475 val = single_histo_average(nva[i].data, nva[i].count); 5476 print_one_stat(val, format, column_width, cb->cb_scripted); 5477 } 5478 free_calc_stats(nva, ARRAY_SIZE(names)); 5479 } 5480 5481 /* 5482 * Print default statistics (capacity/operations/bandwidth) 5483 */ 5484 static void 5485 print_iostat_default(vdev_stat_t *vs, iostat_cbdata_t *cb, double scale) 5486 { 5487 unsigned int column_width = default_column_width(cb, IOS_DEFAULT); 5488 enum zfs_nicenum_format format; 5489 char na; /* char to print for "not applicable" values */ 5490 5491 if (cb->cb_literal) { 5492 format = ZFS_NICENUM_RAW; 5493 na = '0'; 5494 } else { 5495 format = ZFS_NICENUM_1024; 5496 na = '-'; 5497 } 5498 5499 /* only toplevel vdevs have capacity stats */ 5500 if (vs->vs_space == 0) { 5501 if (cb->cb_scripted) 5502 printf("\t%c\t%c", na, na); 5503 else 5504 printf(" %*c %*c", column_width, na, column_width, 5505 na); 5506 } else { 5507 print_one_stat(vs->vs_alloc, format, column_width, 5508 cb->cb_scripted); 5509 print_one_stat(vs->vs_space - vs->vs_alloc, format, 5510 column_width, cb->cb_scripted); 5511 } 5512 5513 print_one_stat((uint64_t)(vs->vs_ops[ZIO_TYPE_READ] * scale), 5514 format, column_width, cb->cb_scripted); 5515 print_one_stat((uint64_t)(vs->vs_ops[ZIO_TYPE_WRITE] * scale), 5516 format, column_width, cb->cb_scripted); 5517 print_one_stat((uint64_t)(vs->vs_bytes[ZIO_TYPE_READ] * scale), 5518 format, column_width, cb->cb_scripted); 5519 print_one_stat((uint64_t)(vs->vs_bytes[ZIO_TYPE_WRITE] * scale), 5520 format, column_width, cb->cb_scripted); 5521 } 5522 5523 static const char *const class_name[] = { 5524 VDEV_ALLOC_BIAS_DEDUP, 5525 VDEV_ALLOC_BIAS_SPECIAL, 5526 VDEV_ALLOC_CLASS_LOGS 5527 }; 5528 5529 /* 5530 * Print out all the statistics for the given vdev. This can either be the 5531 * toplevel configuration, or called recursively. If 'name' is NULL, then this 5532 * is a verbose output, and we don't want to display the toplevel pool stats. 5533 * 5534 * Returns the number of stat lines printed. 5535 */ 5536 static unsigned int 5537 print_vdev_stats(zpool_handle_t *zhp, const char *name, nvlist_t *oldnv, 5538 nvlist_t *newnv, iostat_cbdata_t *cb, int depth) 5539 { 5540 nvlist_t **oldchild, **newchild; 5541 uint_t c, children, oldchildren; 5542 vdev_stat_t *oldvs, *newvs, *calcvs; 5543 vdev_stat_t zerovs = { 0 }; 5544 char *vname; 5545 int i; 5546 int ret = 0; 5547 uint64_t tdelta; 5548 double scale; 5549 5550 if (strcmp(name, VDEV_TYPE_INDIRECT) == 0) 5551 return (ret); 5552 5553 calcvs = safe_malloc(sizeof (*calcvs)); 5554 5555 if (oldnv != NULL) { 5556 verify(nvlist_lookup_uint64_array(oldnv, 5557 ZPOOL_CONFIG_VDEV_STATS, (uint64_t **)&oldvs, &c) == 0); 5558 } else { 5559 oldvs = &zerovs; 5560 } 5561 5562 /* Do we only want to see a specific vdev? */ 5563 for (i = 0; i < cb->cb_vdevs.cb_names_count; i++) { 5564 /* Yes we do. Is this the vdev? */ 5565 if (strcmp(name, cb->cb_vdevs.cb_names[i]) == 0) { 5566 /* 5567 * This is our vdev. Since it is the only vdev we 5568 * will be displaying, make depth = 0 so that it 5569 * doesn't get indented. 5570 */ 5571 depth = 0; 5572 break; 5573 } 5574 } 5575 5576 if (cb->cb_vdevs.cb_names_count && (i == cb->cb_vdevs.cb_names_count)) { 5577 /* Couldn't match the name */ 5578 goto children; 5579 } 5580 5581 5582 verify(nvlist_lookup_uint64_array(newnv, ZPOOL_CONFIG_VDEV_STATS, 5583 (uint64_t **)&newvs, &c) == 0); 5584 5585 /* 5586 * Print the vdev name unless it's is a histogram. Histograms 5587 * display the vdev name in the header itself. 5588 */ 5589 if (!(cb->cb_flags & IOS_ANYHISTO_M)) { 5590 if (cb->cb_scripted) { 5591 printf("%s", name); 5592 } else { 5593 if (strlen(name) + depth > cb->cb_namewidth) 5594 (void) printf("%*s%s", depth, "", name); 5595 else 5596 (void) printf("%*s%s%*s", depth, "", name, 5597 (int)(cb->cb_namewidth - strlen(name) - 5598 depth), ""); 5599 } 5600 } 5601 5602 /* Calculate our scaling factor */ 5603 tdelta = newvs->vs_timestamp - oldvs->vs_timestamp; 5604 if ((oldvs->vs_timestamp == 0) && (cb->cb_flags & IOS_ANYHISTO_M)) { 5605 /* 5606 * If we specify printing histograms with no time interval, then 5607 * print the histogram numbers over the entire lifetime of the 5608 * vdev. 5609 */ 5610 scale = 1; 5611 } else { 5612 if (tdelta == 0) 5613 scale = 1.0; 5614 else 5615 scale = (double)NANOSEC / tdelta; 5616 } 5617 5618 if (cb->cb_flags & IOS_DEFAULT_M) { 5619 calc_default_iostats(oldvs, newvs, calcvs); 5620 print_iostat_default(calcvs, cb, scale); 5621 } 5622 if (cb->cb_flags & IOS_LATENCY_M) 5623 print_iostat_latency(cb, oldnv, newnv); 5624 if (cb->cb_flags & IOS_QUEUES_M) 5625 print_iostat_queues(cb, newnv); 5626 if (cb->cb_flags & IOS_ANYHISTO_M) { 5627 printf("\n"); 5628 print_iostat_histos(cb, oldnv, newnv, scale, name); 5629 } 5630 5631 if (cb->vcdl != NULL) { 5632 const char *path; 5633 if (nvlist_lookup_string(newnv, ZPOOL_CONFIG_PATH, 5634 &path) == 0) { 5635 printf(" "); 5636 zpool_print_cmd(cb->vcdl, zpool_get_name(zhp), path); 5637 } 5638 } 5639 5640 if (!(cb->cb_flags & IOS_ANYHISTO_M)) 5641 printf("\n"); 5642 5643 ret++; 5644 5645 children: 5646 5647 free(calcvs); 5648 5649 if (!cb->cb_verbose) 5650 return (ret); 5651 5652 if (nvlist_lookup_nvlist_array(newnv, ZPOOL_CONFIG_CHILDREN, 5653 &newchild, &children) != 0) 5654 return (ret); 5655 5656 if (oldnv) { 5657 if (nvlist_lookup_nvlist_array(oldnv, ZPOOL_CONFIG_CHILDREN, 5658 &oldchild, &oldchildren) != 0) 5659 return (ret); 5660 5661 children = MIN(oldchildren, children); 5662 } 5663 5664 /* 5665 * print normal top-level devices 5666 */ 5667 for (c = 0; c < children; c++) { 5668 uint64_t ishole = B_FALSE, islog = B_FALSE; 5669 5670 (void) nvlist_lookup_uint64(newchild[c], ZPOOL_CONFIG_IS_HOLE, 5671 &ishole); 5672 5673 (void) nvlist_lookup_uint64(newchild[c], ZPOOL_CONFIG_IS_LOG, 5674 &islog); 5675 5676 if (ishole || islog) 5677 continue; 5678 5679 if (nvlist_exists(newchild[c], ZPOOL_CONFIG_ALLOCATION_BIAS)) 5680 continue; 5681 5682 vname = zpool_vdev_name(g_zfs, zhp, newchild[c], 5683 cb->cb_vdevs.cb_name_flags | VDEV_NAME_TYPE_ID); 5684 ret += print_vdev_stats(zhp, vname, oldnv ? oldchild[c] : NULL, 5685 newchild[c], cb, depth + 2); 5686 free(vname); 5687 } 5688 5689 /* 5690 * print all other top-level devices 5691 */ 5692 for (uint_t n = 0; n < ARRAY_SIZE(class_name); n++) { 5693 boolean_t printed = B_FALSE; 5694 5695 for (c = 0; c < children; c++) { 5696 uint64_t islog = B_FALSE; 5697 const char *bias = NULL; 5698 const char *type = NULL; 5699 5700 (void) nvlist_lookup_uint64(newchild[c], 5701 ZPOOL_CONFIG_IS_LOG, &islog); 5702 if (islog) { 5703 bias = VDEV_ALLOC_CLASS_LOGS; 5704 } else { 5705 (void) nvlist_lookup_string(newchild[c], 5706 ZPOOL_CONFIG_ALLOCATION_BIAS, &bias); 5707 (void) nvlist_lookup_string(newchild[c], 5708 ZPOOL_CONFIG_TYPE, &type); 5709 } 5710 if (bias == NULL || strcmp(bias, class_name[n]) != 0) 5711 continue; 5712 if (!islog && strcmp(type, VDEV_TYPE_INDIRECT) == 0) 5713 continue; 5714 5715 if (!printed) { 5716 if ((!(cb->cb_flags & IOS_ANYHISTO_M)) && 5717 !cb->cb_scripted && 5718 !cb->cb_vdevs.cb_names) { 5719 print_iostat_dashes(cb, 0, 5720 class_name[n]); 5721 } 5722 printf("\n"); 5723 printed = B_TRUE; 5724 } 5725 5726 vname = zpool_vdev_name(g_zfs, zhp, newchild[c], 5727 cb->cb_vdevs.cb_name_flags | VDEV_NAME_TYPE_ID); 5728 ret += print_vdev_stats(zhp, vname, oldnv ? 5729 oldchild[c] : NULL, newchild[c], cb, depth + 2); 5730 free(vname); 5731 } 5732 } 5733 5734 /* 5735 * Include level 2 ARC devices in iostat output 5736 */ 5737 if (nvlist_lookup_nvlist_array(newnv, ZPOOL_CONFIG_L2CACHE, 5738 &newchild, &children) != 0) 5739 return (ret); 5740 5741 if (oldnv) { 5742 if (nvlist_lookup_nvlist_array(oldnv, ZPOOL_CONFIG_L2CACHE, 5743 &oldchild, &oldchildren) != 0) 5744 return (ret); 5745 5746 children = MIN(oldchildren, children); 5747 } 5748 5749 if (children > 0) { 5750 if ((!(cb->cb_flags & IOS_ANYHISTO_M)) && !cb->cb_scripted && 5751 !cb->cb_vdevs.cb_names) { 5752 print_iostat_dashes(cb, 0, "cache"); 5753 } 5754 printf("\n"); 5755 5756 for (c = 0; c < children; c++) { 5757 vname = zpool_vdev_name(g_zfs, zhp, newchild[c], 5758 cb->cb_vdevs.cb_name_flags); 5759 ret += print_vdev_stats(zhp, vname, oldnv ? oldchild[c] 5760 : NULL, newchild[c], cb, depth + 2); 5761 free(vname); 5762 } 5763 } 5764 5765 return (ret); 5766 } 5767 5768 static int 5769 refresh_iostat(zpool_handle_t *zhp, void *data) 5770 { 5771 iostat_cbdata_t *cb = data; 5772 boolean_t missing; 5773 5774 /* 5775 * If the pool has disappeared, remove it from the list and continue. 5776 */ 5777 if (zpool_refresh_stats(zhp, &missing) != 0) 5778 return (-1); 5779 5780 if (missing) 5781 pool_list_remove(cb->cb_list, zhp); 5782 5783 return (0); 5784 } 5785 5786 /* 5787 * Callback to print out the iostats for the given pool. 5788 */ 5789 static int 5790 print_iostat(zpool_handle_t *zhp, void *data) 5791 { 5792 iostat_cbdata_t *cb = data; 5793 nvlist_t *oldconfig, *newconfig; 5794 nvlist_t *oldnvroot, *newnvroot; 5795 int ret; 5796 5797 newconfig = zpool_get_config(zhp, &oldconfig); 5798 5799 if (cb->cb_iteration == 1) 5800 oldconfig = NULL; 5801 5802 verify(nvlist_lookup_nvlist(newconfig, ZPOOL_CONFIG_VDEV_TREE, 5803 &newnvroot) == 0); 5804 5805 if (oldconfig == NULL) 5806 oldnvroot = NULL; 5807 else 5808 verify(nvlist_lookup_nvlist(oldconfig, ZPOOL_CONFIG_VDEV_TREE, 5809 &oldnvroot) == 0); 5810 5811 ret = print_vdev_stats(zhp, zpool_get_name(zhp), oldnvroot, newnvroot, 5812 cb, 0); 5813 if ((ret != 0) && !(cb->cb_flags & IOS_ANYHISTO_M) && 5814 !cb->cb_scripted && cb->cb_verbose && 5815 !cb->cb_vdevs.cb_names_count) { 5816 print_iostat_separator(cb); 5817 if (cb->vcdl != NULL) { 5818 print_cmd_columns(cb->vcdl, 1); 5819 } 5820 printf("\n"); 5821 } 5822 5823 return (ret); 5824 } 5825 5826 static int 5827 get_columns(void) 5828 { 5829 struct winsize ws; 5830 int columns = 80; 5831 int error; 5832 5833 if (isatty(STDOUT_FILENO)) { 5834 error = ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws); 5835 if (error == 0) 5836 columns = ws.ws_col; 5837 } else { 5838 columns = 999; 5839 } 5840 5841 return (columns); 5842 } 5843 5844 /* 5845 * Return the required length of the pool/vdev name column. The minimum 5846 * allowed width and output formatting flags must be provided. 5847 */ 5848 static int 5849 get_namewidth(zpool_handle_t *zhp, int min_width, int flags, boolean_t verbose) 5850 { 5851 nvlist_t *config, *nvroot; 5852 int width = min_width; 5853 5854 if ((config = zpool_get_config(zhp, NULL)) != NULL) { 5855 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE, 5856 &nvroot) == 0); 5857 size_t poolname_len = strlen(zpool_get_name(zhp)); 5858 if (verbose == B_FALSE) { 5859 width = MAX(poolname_len, min_width); 5860 } else { 5861 width = MAX(poolname_len, 5862 max_width(zhp, nvroot, 0, min_width, flags)); 5863 } 5864 } 5865 5866 return (width); 5867 } 5868 5869 /* 5870 * Parse the input string, get the 'interval' and 'count' value if there is one. 5871 */ 5872 static void 5873 get_interval_count(int *argcp, char **argv, float *iv, 5874 unsigned long *cnt) 5875 { 5876 float interval = 0; 5877 unsigned long count = 0; 5878 int argc = *argcp; 5879 5880 /* 5881 * Determine if the last argument is an integer or a pool name 5882 */ 5883 if (argc > 0 && zfs_isnumber(argv[argc - 1])) { 5884 char *end; 5885 5886 errno = 0; 5887 interval = strtof(argv[argc - 1], &end); 5888 5889 if (*end == '\0' && errno == 0) { 5890 if (interval == 0) { 5891 (void) fprintf(stderr, gettext( 5892 "interval cannot be zero\n")); 5893 usage(B_FALSE); 5894 } 5895 /* 5896 * Ignore the last parameter 5897 */ 5898 argc--; 5899 } else { 5900 /* 5901 * If this is not a valid number, just plow on. The 5902 * user will get a more informative error message later 5903 * on. 5904 */ 5905 interval = 0; 5906 } 5907 } 5908 5909 /* 5910 * If the last argument is also an integer, then we have both a count 5911 * and an interval. 5912 */ 5913 if (argc > 0 && zfs_isnumber(argv[argc - 1])) { 5914 char *end; 5915 5916 errno = 0; 5917 count = interval; 5918 interval = strtof(argv[argc - 1], &end); 5919 5920 if (*end == '\0' && errno == 0) { 5921 if (interval == 0) { 5922 (void) fprintf(stderr, gettext( 5923 "interval cannot be zero\n")); 5924 usage(B_FALSE); 5925 } 5926 5927 /* 5928 * Ignore the last parameter 5929 */ 5930 argc--; 5931 } else { 5932 interval = 0; 5933 } 5934 } 5935 5936 *iv = interval; 5937 *cnt = count; 5938 *argcp = argc; 5939 } 5940 5941 static void 5942 get_timestamp_arg(char c) 5943 { 5944 if (c == 'u') 5945 timestamp_fmt = UDATE; 5946 else if (c == 'd') 5947 timestamp_fmt = DDATE; 5948 else 5949 usage(B_FALSE); 5950 } 5951 5952 /* 5953 * Return stat flags that are supported by all pools by both the module and 5954 * zpool iostat. "*data" should be initialized to all 0xFFs before running. 5955 * It will get ANDed down until only the flags that are supported on all pools 5956 * remain. 5957 */ 5958 static int 5959 get_stat_flags_cb(zpool_handle_t *zhp, void *data) 5960 { 5961 uint64_t *mask = data; 5962 nvlist_t *config, *nvroot, *nvx; 5963 uint64_t flags = 0; 5964 int i, j; 5965 5966 config = zpool_get_config(zhp, NULL); 5967 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE, 5968 &nvroot) == 0); 5969 5970 /* Default stats are always supported, but for completeness.. */ 5971 if (nvlist_exists(nvroot, ZPOOL_CONFIG_VDEV_STATS)) 5972 flags |= IOS_DEFAULT_M; 5973 5974 /* Get our extended stats nvlist from the main list */ 5975 if (nvlist_lookup_nvlist(nvroot, ZPOOL_CONFIG_VDEV_STATS_EX, 5976 &nvx) != 0) { 5977 /* 5978 * No extended stats; they're probably running an older 5979 * module. No big deal, we support that too. 5980 */ 5981 goto end; 5982 } 5983 5984 /* For each extended stat, make sure all its nvpairs are supported */ 5985 for (j = 0; j < ARRAY_SIZE(vsx_type_to_nvlist); j++) { 5986 if (!vsx_type_to_nvlist[j][0]) 5987 continue; 5988 5989 /* Start off by assuming the flag is supported, then check */ 5990 flags |= (1ULL << j); 5991 for (i = 0; vsx_type_to_nvlist[j][i]; i++) { 5992 if (!nvlist_exists(nvx, vsx_type_to_nvlist[j][i])) { 5993 /* flag isn't supported */ 5994 flags = flags & ~(1ULL << j); 5995 break; 5996 } 5997 } 5998 } 5999 end: 6000 *mask = *mask & flags; 6001 return (0); 6002 } 6003 6004 /* 6005 * Return a bitmask of stats that are supported on all pools by both the module 6006 * and zpool iostat. 6007 */ 6008 static uint64_t 6009 get_stat_flags(zpool_list_t *list) 6010 { 6011 uint64_t mask = -1; 6012 6013 /* 6014 * get_stat_flags_cb() will lop off bits from "mask" until only the 6015 * flags that are supported on all pools remain. 6016 */ 6017 pool_list_iter(list, B_FALSE, get_stat_flags_cb, &mask); 6018 return (mask); 6019 } 6020 6021 /* 6022 * Return 1 if cb_data->cb_names[0] is this vdev's name, 0 otherwise. 6023 */ 6024 static int 6025 is_vdev_cb(void *zhp_data, nvlist_t *nv, void *cb_data) 6026 { 6027 uint64_t guid; 6028 vdev_cbdata_t *cb = cb_data; 6029 zpool_handle_t *zhp = zhp_data; 6030 6031 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &guid) != 0) 6032 return (0); 6033 6034 return (guid == zpool_vdev_path_to_guid(zhp, cb->cb_names[0])); 6035 } 6036 6037 /* 6038 * Returns 1 if cb_data->cb_names[0] is a vdev name, 0 otherwise. 6039 */ 6040 static int 6041 is_vdev(zpool_handle_t *zhp, void *cb_data) 6042 { 6043 return (for_each_vdev(zhp, is_vdev_cb, cb_data)); 6044 } 6045 6046 /* 6047 * Check if vdevs are in a pool 6048 * 6049 * Return 1 if all argv[] strings are vdev names in pool "pool_name". Otherwise 6050 * return 0. If pool_name is NULL, then search all pools. 6051 */ 6052 static int 6053 are_vdevs_in_pool(int argc, char **argv, char *pool_name, 6054 vdev_cbdata_t *cb) 6055 { 6056 char **tmp_name; 6057 int ret = 0; 6058 int i; 6059 int pool_count = 0; 6060 6061 if ((argc == 0) || !*argv) 6062 return (0); 6063 6064 if (pool_name) 6065 pool_count = 1; 6066 6067 /* Temporarily hijack cb_names for a second... */ 6068 tmp_name = cb->cb_names; 6069 6070 /* Go though our list of prospective vdev names */ 6071 for (i = 0; i < argc; i++) { 6072 cb->cb_names = argv + i; 6073 6074 /* Is this name a vdev in our pools? */ 6075 ret = for_each_pool(pool_count, &pool_name, B_TRUE, NULL, 6076 ZFS_TYPE_POOL, B_FALSE, is_vdev, cb); 6077 if (!ret) { 6078 /* No match */ 6079 break; 6080 } 6081 } 6082 6083 cb->cb_names = tmp_name; 6084 6085 return (ret); 6086 } 6087 6088 static int 6089 is_pool_cb(zpool_handle_t *zhp, void *data) 6090 { 6091 char *name = data; 6092 if (strcmp(name, zpool_get_name(zhp)) == 0) 6093 return (1); 6094 6095 return (0); 6096 } 6097 6098 /* 6099 * Do we have a pool named *name? If so, return 1, otherwise 0. 6100 */ 6101 static int 6102 is_pool(char *name) 6103 { 6104 return (for_each_pool(0, NULL, B_TRUE, NULL, ZFS_TYPE_POOL, B_FALSE, 6105 is_pool_cb, name)); 6106 } 6107 6108 /* Are all our argv[] strings pool names? If so return 1, 0 otherwise. */ 6109 static int 6110 are_all_pools(int argc, char **argv) 6111 { 6112 if ((argc == 0) || !*argv) 6113 return (0); 6114 6115 while (--argc >= 0) 6116 if (!is_pool(argv[argc])) 6117 return (0); 6118 6119 return (1); 6120 } 6121 6122 /* 6123 * Helper function to print out vdev/pool names we can't resolve. Used for an 6124 * error message. 6125 */ 6126 static void 6127 error_list_unresolved_vdevs(int argc, char **argv, char *pool_name, 6128 vdev_cbdata_t *cb) 6129 { 6130 int i; 6131 char *name; 6132 char *str; 6133 for (i = 0; i < argc; i++) { 6134 name = argv[i]; 6135 6136 if (is_pool(name)) 6137 str = gettext("pool"); 6138 else if (are_vdevs_in_pool(1, &name, pool_name, cb)) 6139 str = gettext("vdev in this pool"); 6140 else if (are_vdevs_in_pool(1, &name, NULL, cb)) 6141 str = gettext("vdev in another pool"); 6142 else 6143 str = gettext("unknown"); 6144 6145 fprintf(stderr, "\t%s (%s)\n", name, str); 6146 } 6147 } 6148 6149 /* 6150 * Same as get_interval_count(), but with additional checks to not misinterpret 6151 * guids as interval/count values. Assumes VDEV_NAME_GUID is set in 6152 * cb.cb_vdevs.cb_name_flags. 6153 */ 6154 static void 6155 get_interval_count_filter_guids(int *argc, char **argv, float *interval, 6156 unsigned long *count, iostat_cbdata_t *cb) 6157 { 6158 char **tmpargv = argv; 6159 int argc_for_interval = 0; 6160 6161 /* Is the last arg an interval value? Or a guid? */ 6162 if (*argc >= 1 && !are_vdevs_in_pool(1, &argv[*argc - 1], NULL, 6163 &cb->cb_vdevs)) { 6164 /* 6165 * The last arg is not a guid, so it's probably an 6166 * interval value. 6167 */ 6168 argc_for_interval++; 6169 6170 if (*argc >= 2 && 6171 !are_vdevs_in_pool(1, &argv[*argc - 2], NULL, 6172 &cb->cb_vdevs)) { 6173 /* 6174 * The 2nd to last arg is not a guid, so it's probably 6175 * an interval value. 6176 */ 6177 argc_for_interval++; 6178 } 6179 } 6180 6181 /* Point to our list of possible intervals */ 6182 tmpargv = &argv[*argc - argc_for_interval]; 6183 6184 *argc = *argc - argc_for_interval; 6185 get_interval_count(&argc_for_interval, tmpargv, 6186 interval, count); 6187 } 6188 6189 /* 6190 * Terminal height, in rows. Returns -1 if stdout is not connected to a TTY or 6191 * if we were unable to determine its size. 6192 */ 6193 static int 6194 terminal_height(void) 6195 { 6196 struct winsize win; 6197 6198 if (isatty(STDOUT_FILENO) == 0) 6199 return (-1); 6200 6201 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &win) != -1 && win.ws_row > 0) 6202 return (win.ws_row); 6203 6204 return (-1); 6205 } 6206 6207 /* 6208 * Run one of the zpool status/iostat -c scripts with the help (-h) option and 6209 * print the result. 6210 * 6211 * name: Short name of the script ('iostat'). 6212 * path: Full path to the script ('/usr/local/etc/zfs/zpool.d/iostat'); 6213 */ 6214 static void 6215 print_zpool_script_help(char *name, char *path) 6216 { 6217 char *argv[] = {path, (char *)"-h", NULL}; 6218 char **lines = NULL; 6219 int lines_cnt = 0; 6220 int rc; 6221 6222 rc = libzfs_run_process_get_stdout_nopath(path, argv, NULL, &lines, 6223 &lines_cnt); 6224 if (rc != 0 || lines == NULL || lines_cnt <= 0) { 6225 if (lines != NULL) 6226 libzfs_free_str_array(lines, lines_cnt); 6227 return; 6228 } 6229 6230 for (int i = 0; i < lines_cnt; i++) 6231 if (!is_blank_str(lines[i])) 6232 printf(" %-14s %s\n", name, lines[i]); 6233 6234 libzfs_free_str_array(lines, lines_cnt); 6235 } 6236 6237 /* 6238 * Go though the zpool status/iostat -c scripts in the user's path, run their 6239 * help option (-h), and print out the results. 6240 */ 6241 static void 6242 print_zpool_dir_scripts(char *dirpath) 6243 { 6244 DIR *dir; 6245 struct dirent *ent; 6246 char fullpath[MAXPATHLEN]; 6247 struct stat dir_stat; 6248 6249 if ((dir = opendir(dirpath)) != NULL) { 6250 /* print all the files and directories within directory */ 6251 while ((ent = readdir(dir)) != NULL) { 6252 if (snprintf(fullpath, sizeof (fullpath), "%s/%s", 6253 dirpath, ent->d_name) >= sizeof (fullpath)) { 6254 (void) fprintf(stderr, 6255 gettext("internal error: " 6256 "ZPOOL_SCRIPTS_PATH too large.\n")); 6257 exit(1); 6258 } 6259 6260 /* Print the scripts */ 6261 if (stat(fullpath, &dir_stat) == 0) 6262 if (dir_stat.st_mode & S_IXUSR && 6263 S_ISREG(dir_stat.st_mode)) 6264 print_zpool_script_help(ent->d_name, 6265 fullpath); 6266 } 6267 closedir(dir); 6268 } 6269 } 6270 6271 /* 6272 * Print out help text for all zpool status/iostat -c scripts. 6273 */ 6274 static void 6275 print_zpool_script_list(const char *subcommand) 6276 { 6277 char *dir, *sp, *tmp; 6278 6279 printf(gettext("Available 'zpool %s -c' commands:\n"), subcommand); 6280 6281 sp = zpool_get_cmd_search_path(); 6282 if (sp == NULL) 6283 return; 6284 6285 for (dir = strtok_r(sp, ":", &tmp); 6286 dir != NULL; 6287 dir = strtok_r(NULL, ":", &tmp)) 6288 print_zpool_dir_scripts(dir); 6289 6290 free(sp); 6291 } 6292 6293 /* 6294 * Set the minimum pool/vdev name column width. The width must be at least 10, 6295 * but may be as large as the column width - 42 so it still fits on one line. 6296 * NOTE: 42 is the width of the default capacity/operations/bandwidth output 6297 */ 6298 static int 6299 get_namewidth_iostat(zpool_handle_t *zhp, void *data) 6300 { 6301 iostat_cbdata_t *cb = data; 6302 int width, available_width; 6303 6304 /* 6305 * get_namewidth() returns the maximum width of any name in that column 6306 * for any pool/vdev/device line that will be output. 6307 */ 6308 width = get_namewidth(zhp, cb->cb_namewidth, 6309 cb->cb_vdevs.cb_name_flags | VDEV_NAME_TYPE_ID, cb->cb_verbose); 6310 6311 /* 6312 * The width we are calculating is the width of the header and also the 6313 * padding width for names that are less than maximum width. The stats 6314 * take up 42 characters, so the width available for names is: 6315 */ 6316 available_width = get_columns() - 42; 6317 6318 /* 6319 * If the maximum width fits on a screen, then great! Make everything 6320 * line up by justifying all lines to the same width. If that max 6321 * width is larger than what's available, the name plus stats won't fit 6322 * on one line, and justifying to that width would cause every line to 6323 * wrap on the screen. We only want lines with long names to wrap. 6324 * Limit the padding to what won't wrap. 6325 */ 6326 if (width > available_width) 6327 width = available_width; 6328 6329 /* 6330 * And regardless of whatever the screen width is (get_columns can 6331 * return 0 if the width is not known or less than 42 for a narrow 6332 * terminal) have the width be a minimum of 10. 6333 */ 6334 if (width < 10) 6335 width = 10; 6336 6337 /* Save the calculated width */ 6338 cb->cb_namewidth = width; 6339 6340 return (0); 6341 } 6342 6343 /* 6344 * zpool iostat [[-c [script1,script2,...]] [-lq]|[-rw]] [-ghHLpPvy] [-n name] 6345 * [-T d|u] [[ pool ...]|[pool vdev ...]|[vdev ...]] 6346 * [interval [count]] 6347 * 6348 * -c CMD For each vdev, run command CMD 6349 * -g Display guid for individual vdev name. 6350 * -L Follow links when resolving vdev path name. 6351 * -P Display full path for vdev name. 6352 * -v Display statistics for individual vdevs 6353 * -h Display help 6354 * -p Display values in parsable (exact) format. 6355 * -H Scripted mode. Don't display headers, and separate properties 6356 * by a single tab. 6357 * -l Display average latency 6358 * -q Display queue depths 6359 * -w Display latency histograms 6360 * -r Display request size histogram 6361 * -T Display a timestamp in date(1) or Unix format 6362 * -n Only print headers once 6363 * 6364 * This command can be tricky because we want to be able to deal with pool 6365 * creation/destruction as well as vdev configuration changes. The bulk of this 6366 * processing is handled by the pool_list_* routines in zpool_iter.c. We rely 6367 * on pool_list_update() to detect the addition of new pools. Configuration 6368 * changes are all handled within libzfs. 6369 */ 6370 int 6371 zpool_do_iostat(int argc, char **argv) 6372 { 6373 int c; 6374 int ret; 6375 int npools; 6376 float interval = 0; 6377 unsigned long count = 0; 6378 int winheight = 24; 6379 zpool_list_t *list; 6380 boolean_t verbose = B_FALSE; 6381 boolean_t latency = B_FALSE, l_histo = B_FALSE, rq_histo = B_FALSE; 6382 boolean_t queues = B_FALSE, parsable = B_FALSE, scripted = B_FALSE; 6383 boolean_t omit_since_boot = B_FALSE; 6384 boolean_t guid = B_FALSE; 6385 boolean_t follow_links = B_FALSE; 6386 boolean_t full_name = B_FALSE; 6387 boolean_t headers_once = B_FALSE; 6388 iostat_cbdata_t cb = { 0 }; 6389 char *cmd = NULL; 6390 6391 /* Used for printing error message */ 6392 const char flag_to_arg[] = {[IOS_LATENCY] = 'l', [IOS_QUEUES] = 'q', 6393 [IOS_L_HISTO] = 'w', [IOS_RQ_HISTO] = 'r'}; 6394 6395 uint64_t unsupported_flags; 6396 6397 /* check options */ 6398 while ((c = getopt(argc, argv, "c:gLPT:vyhplqrwnH")) != -1) { 6399 switch (c) { 6400 case 'c': 6401 if (cmd != NULL) { 6402 fprintf(stderr, 6403 gettext("Can't set -c flag twice\n")); 6404 exit(1); 6405 } 6406 6407 if (getenv("ZPOOL_SCRIPTS_ENABLED") != NULL && 6408 !libzfs_envvar_is_set("ZPOOL_SCRIPTS_ENABLED")) { 6409 fprintf(stderr, gettext( 6410 "Can't run -c, disabled by " 6411 "ZPOOL_SCRIPTS_ENABLED.\n")); 6412 exit(1); 6413 } 6414 6415 if ((getuid() <= 0 || geteuid() <= 0) && 6416 !libzfs_envvar_is_set("ZPOOL_SCRIPTS_AS_ROOT")) { 6417 fprintf(stderr, gettext( 6418 "Can't run -c with root privileges " 6419 "unless ZPOOL_SCRIPTS_AS_ROOT is set.\n")); 6420 exit(1); 6421 } 6422 cmd = optarg; 6423 verbose = B_TRUE; 6424 break; 6425 case 'g': 6426 guid = B_TRUE; 6427 break; 6428 case 'L': 6429 follow_links = B_TRUE; 6430 break; 6431 case 'P': 6432 full_name = B_TRUE; 6433 break; 6434 case 'T': 6435 get_timestamp_arg(*optarg); 6436 break; 6437 case 'v': 6438 verbose = B_TRUE; 6439 break; 6440 case 'p': 6441 parsable = B_TRUE; 6442 break; 6443 case 'l': 6444 latency = B_TRUE; 6445 break; 6446 case 'q': 6447 queues = B_TRUE; 6448 break; 6449 case 'H': 6450 scripted = B_TRUE; 6451 break; 6452 case 'w': 6453 l_histo = B_TRUE; 6454 break; 6455 case 'r': 6456 rq_histo = B_TRUE; 6457 break; 6458 case 'y': 6459 omit_since_boot = B_TRUE; 6460 break; 6461 case 'n': 6462 headers_once = B_TRUE; 6463 break; 6464 case 'h': 6465 usage(B_FALSE); 6466 break; 6467 case '?': 6468 if (optopt == 'c') { 6469 print_zpool_script_list("iostat"); 6470 exit(0); 6471 } else { 6472 fprintf(stderr, 6473 gettext("invalid option '%c'\n"), optopt); 6474 } 6475 usage(B_FALSE); 6476 } 6477 } 6478 6479 argc -= optind; 6480 argv += optind; 6481 6482 cb.cb_literal = parsable; 6483 cb.cb_scripted = scripted; 6484 6485 if (guid) 6486 cb.cb_vdevs.cb_name_flags |= VDEV_NAME_GUID; 6487 if (follow_links) 6488 cb.cb_vdevs.cb_name_flags |= VDEV_NAME_FOLLOW_LINKS; 6489 if (full_name) 6490 cb.cb_vdevs.cb_name_flags |= VDEV_NAME_PATH; 6491 cb.cb_iteration = 0; 6492 cb.cb_namewidth = 0; 6493 cb.cb_verbose = verbose; 6494 6495 /* Get our interval and count values (if any) */ 6496 if (guid) { 6497 get_interval_count_filter_guids(&argc, argv, &interval, 6498 &count, &cb); 6499 } else { 6500 get_interval_count(&argc, argv, &interval, &count); 6501 } 6502 6503 if (argc == 0) { 6504 /* No args, so just print the defaults. */ 6505 } else if (are_all_pools(argc, argv)) { 6506 /* All the args are pool names */ 6507 } else if (are_vdevs_in_pool(argc, argv, NULL, &cb.cb_vdevs)) { 6508 /* All the args are vdevs */ 6509 cb.cb_vdevs.cb_names = argv; 6510 cb.cb_vdevs.cb_names_count = argc; 6511 argc = 0; /* No pools to process */ 6512 } else if (are_all_pools(1, argv)) { 6513 /* The first arg is a pool name */ 6514 if (are_vdevs_in_pool(argc - 1, argv + 1, argv[0], 6515 &cb.cb_vdevs)) { 6516 /* ...and the rest are vdev names */ 6517 cb.cb_vdevs.cb_names = argv + 1; 6518 cb.cb_vdevs.cb_names_count = argc - 1; 6519 argc = 1; /* One pool to process */ 6520 } else { 6521 fprintf(stderr, gettext("Expected either a list of ")); 6522 fprintf(stderr, gettext("pools, or list of vdevs in")); 6523 fprintf(stderr, " \"%s\", ", argv[0]); 6524 fprintf(stderr, gettext("but got:\n")); 6525 error_list_unresolved_vdevs(argc - 1, argv + 1, 6526 argv[0], &cb.cb_vdevs); 6527 fprintf(stderr, "\n"); 6528 usage(B_FALSE); 6529 return (1); 6530 } 6531 } else { 6532 /* 6533 * The args don't make sense. The first arg isn't a pool name, 6534 * nor are all the args vdevs. 6535 */ 6536 fprintf(stderr, gettext("Unable to parse pools/vdevs list.\n")); 6537 fprintf(stderr, "\n"); 6538 return (1); 6539 } 6540 6541 if (cb.cb_vdevs.cb_names_count != 0) { 6542 /* 6543 * If user specified vdevs, it implies verbose. 6544 */ 6545 cb.cb_verbose = B_TRUE; 6546 } 6547 6548 /* 6549 * Construct the list of all interesting pools. 6550 */ 6551 ret = 0; 6552 if ((list = pool_list_get(argc, argv, NULL, ZFS_TYPE_POOL, parsable, 6553 &ret)) == NULL) 6554 return (1); 6555 6556 if (pool_list_count(list) == 0 && argc != 0) { 6557 pool_list_free(list); 6558 return (1); 6559 } 6560 6561 if (pool_list_count(list) == 0 && interval == 0) { 6562 pool_list_free(list); 6563 (void) fprintf(stderr, gettext("no pools available\n")); 6564 return (1); 6565 } 6566 6567 if ((l_histo || rq_histo) && (cmd != NULL || latency || queues)) { 6568 pool_list_free(list); 6569 (void) fprintf(stderr, 6570 gettext("[-r|-w] isn't allowed with [-c|-l|-q]\n")); 6571 usage(B_FALSE); 6572 return (1); 6573 } 6574 6575 if (l_histo && rq_histo) { 6576 pool_list_free(list); 6577 (void) fprintf(stderr, 6578 gettext("Only one of [-r|-w] can be passed at a time\n")); 6579 usage(B_FALSE); 6580 return (1); 6581 } 6582 6583 /* 6584 * Enter the main iostat loop. 6585 */ 6586 cb.cb_list = list; 6587 6588 if (l_histo) { 6589 /* 6590 * Histograms tables look out of place when you try to display 6591 * them with the other stats, so make a rule that you can only 6592 * print histograms by themselves. 6593 */ 6594 cb.cb_flags = IOS_L_HISTO_M; 6595 } else if (rq_histo) { 6596 cb.cb_flags = IOS_RQ_HISTO_M; 6597 } else { 6598 cb.cb_flags = IOS_DEFAULT_M; 6599 if (latency) 6600 cb.cb_flags |= IOS_LATENCY_M; 6601 if (queues) 6602 cb.cb_flags |= IOS_QUEUES_M; 6603 } 6604 6605 /* 6606 * See if the module supports all the stats we want to display. 6607 */ 6608 unsupported_flags = cb.cb_flags & ~get_stat_flags(list); 6609 if (unsupported_flags) { 6610 uint64_t f; 6611 int idx; 6612 fprintf(stderr, 6613 gettext("The loaded zfs module doesn't support:")); 6614 6615 /* for each bit set in unsupported_flags */ 6616 for (f = unsupported_flags; f; f &= ~(1ULL << idx)) { 6617 idx = lowbit64(f) - 1; 6618 fprintf(stderr, " -%c", flag_to_arg[idx]); 6619 } 6620 6621 fprintf(stderr, ". Try running a newer module.\n"); 6622 pool_list_free(list); 6623 6624 return (1); 6625 } 6626 6627 for (;;) { 6628 if ((npools = pool_list_count(list)) == 0) 6629 (void) fprintf(stderr, gettext("no pools available\n")); 6630 else { 6631 /* 6632 * If this is the first iteration and -y was supplied 6633 * we skip any printing. 6634 */ 6635 boolean_t skip = (omit_since_boot && 6636 cb.cb_iteration == 0); 6637 6638 /* 6639 * Refresh all statistics. This is done as an 6640 * explicit step before calculating the maximum name 6641 * width, so that any * configuration changes are 6642 * properly accounted for. 6643 */ 6644 (void) pool_list_iter(list, B_FALSE, refresh_iostat, 6645 &cb); 6646 6647 /* 6648 * Iterate over all pools to determine the maximum width 6649 * for the pool / device name column across all pools. 6650 */ 6651 cb.cb_namewidth = 0; 6652 (void) pool_list_iter(list, B_FALSE, 6653 get_namewidth_iostat, &cb); 6654 6655 if (timestamp_fmt != NODATE) 6656 print_timestamp(timestamp_fmt); 6657 6658 if (cmd != NULL && cb.cb_verbose && 6659 !(cb.cb_flags & IOS_ANYHISTO_M)) { 6660 cb.vcdl = all_pools_for_each_vdev_run(argc, 6661 argv, cmd, g_zfs, cb.cb_vdevs.cb_names, 6662 cb.cb_vdevs.cb_names_count, 6663 cb.cb_vdevs.cb_name_flags); 6664 } else { 6665 cb.vcdl = NULL; 6666 } 6667 6668 6669 /* 6670 * Check terminal size so we can print headers 6671 * even when terminal window has its height 6672 * changed. 6673 */ 6674 winheight = terminal_height(); 6675 /* 6676 * Are we connected to TTY? If not, headers_once 6677 * should be true, to avoid breaking scripts. 6678 */ 6679 if (winheight < 0) 6680 headers_once = B_TRUE; 6681 6682 /* 6683 * If it's the first time and we're not skipping it, 6684 * or either skip or verbose mode, print the header. 6685 * 6686 * The histogram code explicitly prints its header on 6687 * every vdev, so skip this for histograms. 6688 */ 6689 if (((++cb.cb_iteration == 1 && !skip) || 6690 (skip != verbose) || 6691 (!headers_once && 6692 (cb.cb_iteration % winheight) == 0)) && 6693 (!(cb.cb_flags & IOS_ANYHISTO_M)) && 6694 !cb.cb_scripted) 6695 print_iostat_header(&cb); 6696 6697 if (skip) { 6698 (void) fflush(stdout); 6699 (void) fsleep(interval); 6700 continue; 6701 } 6702 6703 pool_list_iter(list, B_FALSE, print_iostat, &cb); 6704 6705 /* 6706 * If there's more than one pool, and we're not in 6707 * verbose mode (which prints a separator for us), 6708 * then print a separator. 6709 * 6710 * In addition, if we're printing specific vdevs then 6711 * we also want an ending separator. 6712 */ 6713 if (((npools > 1 && !verbose && 6714 !(cb.cb_flags & IOS_ANYHISTO_M)) || 6715 (!(cb.cb_flags & IOS_ANYHISTO_M) && 6716 cb.cb_vdevs.cb_names_count)) && 6717 !cb.cb_scripted) { 6718 print_iostat_separator(&cb); 6719 if (cb.vcdl != NULL) 6720 print_cmd_columns(cb.vcdl, 1); 6721 printf("\n"); 6722 } 6723 6724 if (cb.vcdl != NULL) 6725 free_vdev_cmd_data_list(cb.vcdl); 6726 6727 } 6728 6729 if (interval == 0) 6730 break; 6731 6732 if (count != 0 && --count == 0) 6733 break; 6734 6735 (void) fflush(stdout); 6736 (void) fsleep(interval); 6737 } 6738 6739 pool_list_free(list); 6740 6741 return (ret); 6742 } 6743 6744 typedef struct list_cbdata { 6745 boolean_t cb_verbose; 6746 int cb_name_flags; 6747 int cb_namewidth; 6748 boolean_t cb_json; 6749 boolean_t cb_scripted; 6750 zprop_list_t *cb_proplist; 6751 boolean_t cb_literal; 6752 nvlist_t *cb_jsobj; 6753 boolean_t cb_json_as_int; 6754 boolean_t cb_json_pool_key_guid; 6755 } list_cbdata_t; 6756 6757 6758 /* 6759 * Given a list of columns to display, output appropriate headers for each one. 6760 */ 6761 static void 6762 print_header(list_cbdata_t *cb) 6763 { 6764 zprop_list_t *pl = cb->cb_proplist; 6765 char headerbuf[ZPOOL_MAXPROPLEN]; 6766 const char *header; 6767 boolean_t first = B_TRUE; 6768 boolean_t right_justify; 6769 size_t width = 0; 6770 6771 for (; pl != NULL; pl = pl->pl_next) { 6772 width = pl->pl_width; 6773 if (first && cb->cb_verbose) { 6774 /* 6775 * Reset the width to accommodate the verbose listing 6776 * of devices. 6777 */ 6778 width = cb->cb_namewidth; 6779 } 6780 6781 if (!first) 6782 (void) fputs(" ", stdout); 6783 else 6784 first = B_FALSE; 6785 6786 right_justify = B_FALSE; 6787 if (pl->pl_prop != ZPROP_USERPROP) { 6788 header = zpool_prop_column_name(pl->pl_prop); 6789 right_justify = zpool_prop_align_right(pl->pl_prop); 6790 } else { 6791 int i; 6792 6793 for (i = 0; pl->pl_user_prop[i] != '\0'; i++) 6794 headerbuf[i] = toupper(pl->pl_user_prop[i]); 6795 headerbuf[i] = '\0'; 6796 header = headerbuf; 6797 } 6798 6799 if (pl->pl_next == NULL && !right_justify) 6800 (void) fputs(header, stdout); 6801 else if (right_justify) 6802 (void) printf("%*s", (int)width, header); 6803 else 6804 (void) printf("%-*s", (int)width, header); 6805 } 6806 6807 (void) fputc('\n', stdout); 6808 } 6809 6810 /* 6811 * Given a pool and a list of properties, print out all the properties according 6812 * to the described layout. Used by zpool_do_list(). 6813 */ 6814 static void 6815 collect_pool(zpool_handle_t *zhp, list_cbdata_t *cb) 6816 { 6817 zprop_list_t *pl = cb->cb_proplist; 6818 boolean_t first = B_TRUE; 6819 char property[ZPOOL_MAXPROPLEN]; 6820 const char *propstr; 6821 boolean_t right_justify; 6822 size_t width; 6823 zprop_source_t sourcetype = ZPROP_SRC_NONE; 6824 nvlist_t *item, *d, *props; 6825 item = d = props = NULL; 6826 6827 if (cb->cb_json) { 6828 item = fnvlist_alloc(); 6829 props = fnvlist_alloc(); 6830 d = fnvlist_lookup_nvlist(cb->cb_jsobj, "pools"); 6831 if (d == NULL) { 6832 fprintf(stderr, "pools obj not found.\n"); 6833 exit(1); 6834 } 6835 fill_pool_info(item, zhp, B_TRUE, cb->cb_json_as_int); 6836 } 6837 6838 for (; pl != NULL; pl = pl->pl_next) { 6839 6840 width = pl->pl_width; 6841 if (first && cb->cb_verbose) { 6842 /* 6843 * Reset the width to accommodate the verbose listing 6844 * of devices. 6845 */ 6846 width = cb->cb_namewidth; 6847 } 6848 6849 if (!cb->cb_json && !first) { 6850 if (cb->cb_scripted) 6851 (void) fputc('\t', stdout); 6852 else 6853 (void) fputs(" ", stdout); 6854 } else { 6855 first = B_FALSE; 6856 } 6857 6858 right_justify = B_FALSE; 6859 if (pl->pl_prop != ZPROP_USERPROP) { 6860 if (zpool_get_prop(zhp, pl->pl_prop, property, 6861 sizeof (property), &sourcetype, 6862 cb->cb_literal) != 0) 6863 propstr = "-"; 6864 else 6865 propstr = property; 6866 6867 right_justify = zpool_prop_align_right(pl->pl_prop); 6868 } else if ((zpool_prop_feature(pl->pl_user_prop) || 6869 zpool_prop_unsupported(pl->pl_user_prop)) && 6870 zpool_prop_get_feature(zhp, pl->pl_user_prop, property, 6871 sizeof (property)) == 0) { 6872 propstr = property; 6873 sourcetype = ZPROP_SRC_LOCAL; 6874 } else if (zfs_prop_user(pl->pl_user_prop) && 6875 zpool_get_userprop(zhp, pl->pl_user_prop, property, 6876 sizeof (property), &sourcetype) == 0) { 6877 propstr = property; 6878 } else { 6879 propstr = "-"; 6880 } 6881 6882 if (cb->cb_json) { 6883 if (pl->pl_prop == ZPOOL_PROP_NAME) 6884 continue; 6885 (void) zprop_nvlist_one_property( 6886 zpool_prop_to_name(pl->pl_prop), propstr, 6887 sourcetype, NULL, NULL, props, cb->cb_json_as_int); 6888 } else { 6889 /* 6890 * If this is being called in scripted mode, or if this 6891 * is the last column and it is left-justified, don't 6892 * include a width format specifier. 6893 */ 6894 if (cb->cb_scripted || (pl->pl_next == NULL && 6895 !right_justify)) 6896 (void) fputs(propstr, stdout); 6897 else if (right_justify) 6898 (void) printf("%*s", (int)width, propstr); 6899 else 6900 (void) printf("%-*s", (int)width, propstr); 6901 } 6902 } 6903 6904 if (cb->cb_json) { 6905 fnvlist_add_nvlist(item, "properties", props); 6906 if (cb->cb_json_pool_key_guid) { 6907 char pool_guid[256]; 6908 uint64_t guid = fnvlist_lookup_uint64( 6909 zpool_get_config(zhp, NULL), 6910 ZPOOL_CONFIG_POOL_GUID); 6911 snprintf(pool_guid, 256, "%llu", 6912 (u_longlong_t)guid); 6913 fnvlist_add_nvlist(d, pool_guid, item); 6914 } else { 6915 fnvlist_add_nvlist(d, zpool_get_name(zhp), 6916 item); 6917 } 6918 fnvlist_free(props); 6919 fnvlist_free(item); 6920 } else 6921 (void) fputc('\n', stdout); 6922 } 6923 6924 static void 6925 collect_vdev_prop(zpool_prop_t prop, uint64_t value, const char *str, 6926 boolean_t scripted, boolean_t valid, enum zfs_nicenum_format format, 6927 boolean_t json, nvlist_t *nvl, boolean_t as_int) 6928 { 6929 char propval[64]; 6930 boolean_t fixed; 6931 size_t width = zprop_width(prop, &fixed, ZFS_TYPE_POOL); 6932 6933 switch (prop) { 6934 case ZPOOL_PROP_SIZE: 6935 case ZPOOL_PROP_EXPANDSZ: 6936 case ZPOOL_PROP_CHECKPOINT: 6937 case ZPOOL_PROP_DEDUPRATIO: 6938 case ZPOOL_PROP_DEDUPCACHED: 6939 if (value == 0) 6940 (void) strlcpy(propval, "-", sizeof (propval)); 6941 else 6942 zfs_nicenum_format(value, propval, sizeof (propval), 6943 format); 6944 break; 6945 case ZPOOL_PROP_FRAGMENTATION: 6946 if (value == ZFS_FRAG_INVALID) { 6947 (void) strlcpy(propval, "-", sizeof (propval)); 6948 } else if (format == ZFS_NICENUM_RAW) { 6949 (void) snprintf(propval, sizeof (propval), "%llu", 6950 (unsigned long long)value); 6951 } else { 6952 (void) snprintf(propval, sizeof (propval), "%llu%%", 6953 (unsigned long long)value); 6954 } 6955 break; 6956 case ZPOOL_PROP_CAPACITY: 6957 /* capacity value is in parts-per-10,000 (aka permyriad) */ 6958 if (format == ZFS_NICENUM_RAW) 6959 (void) snprintf(propval, sizeof (propval), "%llu", 6960 (unsigned long long)value / 100); 6961 else 6962 (void) snprintf(propval, sizeof (propval), 6963 value < 1000 ? "%1.2f%%" : value < 10000 ? 6964 "%2.1f%%" : "%3.0f%%", value / 100.0); 6965 break; 6966 case ZPOOL_PROP_HEALTH: 6967 width = 8; 6968 (void) strlcpy(propval, str, sizeof (propval)); 6969 break; 6970 default: 6971 zfs_nicenum_format(value, propval, sizeof (propval), format); 6972 } 6973 6974 if (!valid) 6975 (void) strlcpy(propval, "-", sizeof (propval)); 6976 6977 if (json) { 6978 zprop_nvlist_one_property(zpool_prop_to_name(prop), propval, 6979 ZPROP_SRC_NONE, NULL, NULL, nvl, as_int); 6980 } else { 6981 if (scripted) 6982 (void) printf("\t%s", propval); 6983 else 6984 (void) printf(" %*s", (int)width, propval); 6985 } 6986 } 6987 6988 /* 6989 * print static default line per vdev 6990 * not compatible with '-o' <proplist> option 6991 */ 6992 static void 6993 collect_list_stats(zpool_handle_t *zhp, const char *name, nvlist_t *nv, 6994 list_cbdata_t *cb, int depth, boolean_t isspare, nvlist_t *item) 6995 { 6996 nvlist_t **child; 6997 vdev_stat_t *vs; 6998 uint_t c, children = 0; 6999 char *vname; 7000 boolean_t scripted = cb->cb_scripted; 7001 uint64_t islog = B_FALSE; 7002 nvlist_t *props, *ent, *ch, *obj, *l2c, *sp; 7003 props = ent = ch = obj = sp = l2c = NULL; 7004 const char *dashes = "%-*s - - - - " 7005 "- - - - -\n"; 7006 7007 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS, 7008 (uint64_t **)&vs, &c) == 0); 7009 7010 if (name != NULL) { 7011 boolean_t toplevel = (vs->vs_space != 0); 7012 uint64_t cap; 7013 enum zfs_nicenum_format format; 7014 const char *state; 7015 7016 if (cb->cb_literal) 7017 format = ZFS_NICENUM_RAW; 7018 else 7019 format = ZFS_NICENUM_1024; 7020 7021 if (strcmp(name, VDEV_TYPE_INDIRECT) == 0) 7022 return; 7023 7024 if (cb->cb_json) { 7025 props = fnvlist_alloc(); 7026 ent = fnvlist_alloc(); 7027 fill_vdev_info(ent, zhp, (char *)name, B_FALSE, 7028 cb->cb_json_as_int); 7029 } else { 7030 if (scripted) 7031 (void) printf("\t%s", name); 7032 else if (strlen(name) + depth > cb->cb_namewidth) 7033 (void) printf("%*s%s", depth, "", name); 7034 else 7035 (void) printf("%*s%s%*s", depth, "", name, 7036 (int)(cb->cb_namewidth - strlen(name) - 7037 depth), ""); 7038 } 7039 7040 /* 7041 * Print the properties for the individual vdevs. Some 7042 * properties are only applicable to toplevel vdevs. The 7043 * 'toplevel' boolean value is passed to the print_one_column() 7044 * to indicate that the value is valid. 7045 */ 7046 if (VDEV_STAT_VALID(vs_pspace, c) && vs->vs_pspace) { 7047 collect_vdev_prop(ZPOOL_PROP_SIZE, vs->vs_pspace, NULL, 7048 scripted, B_TRUE, format, cb->cb_json, props, 7049 cb->cb_json_as_int); 7050 } else { 7051 collect_vdev_prop(ZPOOL_PROP_SIZE, vs->vs_space, NULL, 7052 scripted, toplevel, format, cb->cb_json, props, 7053 cb->cb_json_as_int); 7054 } 7055 collect_vdev_prop(ZPOOL_PROP_ALLOCATED, vs->vs_alloc, NULL, 7056 scripted, toplevel, format, cb->cb_json, props, 7057 cb->cb_json_as_int); 7058 collect_vdev_prop(ZPOOL_PROP_FREE, vs->vs_space - vs->vs_alloc, 7059 NULL, scripted, toplevel, format, cb->cb_json, props, 7060 cb->cb_json_as_int); 7061 collect_vdev_prop(ZPOOL_PROP_CHECKPOINT, 7062 vs->vs_checkpoint_space, NULL, scripted, toplevel, format, 7063 cb->cb_json, props, cb->cb_json_as_int); 7064 collect_vdev_prop(ZPOOL_PROP_EXPANDSZ, vs->vs_esize, NULL, 7065 scripted, B_TRUE, format, cb->cb_json, props, 7066 cb->cb_json_as_int); 7067 collect_vdev_prop(ZPOOL_PROP_FRAGMENTATION, 7068 vs->vs_fragmentation, NULL, scripted, 7069 (vs->vs_fragmentation != ZFS_FRAG_INVALID && toplevel), 7070 format, cb->cb_json, props, cb->cb_json_as_int); 7071 cap = (vs->vs_space == 0) ? 0 : 7072 (vs->vs_alloc * 10000 / vs->vs_space); 7073 collect_vdev_prop(ZPOOL_PROP_CAPACITY, cap, NULL, 7074 scripted, toplevel, format, cb->cb_json, props, 7075 cb->cb_json_as_int); 7076 collect_vdev_prop(ZPOOL_PROP_DEDUPRATIO, 0, NULL, 7077 scripted, toplevel, format, cb->cb_json, props, 7078 cb->cb_json_as_int); 7079 state = zpool_state_to_name(vs->vs_state, vs->vs_aux); 7080 if (isspare) { 7081 if (vs->vs_aux == VDEV_AUX_SPARED) 7082 state = "INUSE"; 7083 else if (vs->vs_state == VDEV_STATE_HEALTHY) 7084 state = "AVAIL"; 7085 } 7086 collect_vdev_prop(ZPOOL_PROP_HEALTH, 0, state, scripted, 7087 B_TRUE, format, cb->cb_json, props, cb->cb_json_as_int); 7088 7089 if (cb->cb_json) { 7090 fnvlist_add_nvlist(ent, "properties", props); 7091 fnvlist_free(props); 7092 } else 7093 (void) fputc('\n', stdout); 7094 } 7095 7096 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, 7097 &child, &children) != 0) { 7098 if (cb->cb_json) { 7099 fnvlist_add_nvlist(item, name, ent); 7100 fnvlist_free(ent); 7101 } 7102 return; 7103 } 7104 7105 if (cb->cb_json) { 7106 ch = fnvlist_alloc(); 7107 } 7108 7109 /* list the normal vdevs first */ 7110 for (c = 0; c < children; c++) { 7111 uint64_t ishole = B_FALSE; 7112 7113 if (nvlist_lookup_uint64(child[c], 7114 ZPOOL_CONFIG_IS_HOLE, &ishole) == 0 && ishole) 7115 continue; 7116 7117 if (nvlist_lookup_uint64(child[c], 7118 ZPOOL_CONFIG_IS_LOG, &islog) == 0 && islog) 7119 continue; 7120 7121 if (nvlist_exists(child[c], ZPOOL_CONFIG_ALLOCATION_BIAS)) 7122 continue; 7123 7124 vname = zpool_vdev_name(g_zfs, zhp, child[c], 7125 cb->cb_name_flags | VDEV_NAME_TYPE_ID); 7126 7127 if (name == NULL || cb->cb_json != B_TRUE) 7128 collect_list_stats(zhp, vname, child[c], cb, depth + 2, 7129 B_FALSE, item); 7130 else if (cb->cb_json) { 7131 collect_list_stats(zhp, vname, child[c], cb, depth + 2, 7132 B_FALSE, ch); 7133 } 7134 free(vname); 7135 } 7136 7137 if (cb->cb_json) { 7138 if (!nvlist_empty(ch)) 7139 fnvlist_add_nvlist(ent, "vdevs", ch); 7140 fnvlist_free(ch); 7141 } 7142 7143 /* list the classes: 'logs', 'dedup', and 'special' */ 7144 for (uint_t n = 0; n < ARRAY_SIZE(class_name); n++) { 7145 boolean_t printed = B_FALSE; 7146 if (cb->cb_json) 7147 obj = fnvlist_alloc(); 7148 for (c = 0; c < children; c++) { 7149 const char *bias = NULL; 7150 const char *type = NULL; 7151 7152 if (nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG, 7153 &islog) == 0 && islog) { 7154 bias = VDEV_ALLOC_CLASS_LOGS; 7155 } else { 7156 (void) nvlist_lookup_string(child[c], 7157 ZPOOL_CONFIG_ALLOCATION_BIAS, &bias); 7158 (void) nvlist_lookup_string(child[c], 7159 ZPOOL_CONFIG_TYPE, &type); 7160 } 7161 if (bias == NULL || strcmp(bias, class_name[n]) != 0) 7162 continue; 7163 if (!islog && strcmp(type, VDEV_TYPE_INDIRECT) == 0) 7164 continue; 7165 7166 if (!printed && !cb->cb_json) { 7167 /* LINTED E_SEC_PRINTF_VAR_FMT */ 7168 (void) printf(dashes, cb->cb_namewidth, 7169 class_name[n]); 7170 printed = B_TRUE; 7171 } 7172 vname = zpool_vdev_name(g_zfs, zhp, child[c], 7173 cb->cb_name_flags | VDEV_NAME_TYPE_ID); 7174 collect_list_stats(zhp, vname, child[c], cb, depth + 2, 7175 B_FALSE, obj); 7176 free(vname); 7177 } 7178 if (cb->cb_json) { 7179 if (!nvlist_empty(obj)) 7180 fnvlist_add_nvlist(item, class_name[n], obj); 7181 fnvlist_free(obj); 7182 } 7183 } 7184 7185 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE, 7186 &child, &children) == 0 && children > 0) { 7187 if (cb->cb_json) { 7188 l2c = fnvlist_alloc(); 7189 } else { 7190 /* LINTED E_SEC_PRINTF_VAR_FMT */ 7191 (void) printf(dashes, cb->cb_namewidth, "cache"); 7192 } 7193 for (c = 0; c < children; c++) { 7194 vname = zpool_vdev_name(g_zfs, zhp, child[c], 7195 cb->cb_name_flags); 7196 collect_list_stats(zhp, vname, child[c], cb, depth + 2, 7197 B_FALSE, l2c); 7198 free(vname); 7199 } 7200 if (cb->cb_json) { 7201 if (!nvlist_empty(l2c)) 7202 fnvlist_add_nvlist(item, "l2cache", l2c); 7203 fnvlist_free(l2c); 7204 } 7205 } 7206 7207 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_SPARES, &child, 7208 &children) == 0 && children > 0) { 7209 if (cb->cb_json) { 7210 sp = fnvlist_alloc(); 7211 } else { 7212 /* LINTED E_SEC_PRINTF_VAR_FMT */ 7213 (void) printf(dashes, cb->cb_namewidth, "spare"); 7214 } 7215 for (c = 0; c < children; c++) { 7216 vname = zpool_vdev_name(g_zfs, zhp, child[c], 7217 cb->cb_name_flags); 7218 collect_list_stats(zhp, vname, child[c], cb, depth + 2, 7219 B_TRUE, sp); 7220 free(vname); 7221 } 7222 if (cb->cb_json) { 7223 if (!nvlist_empty(sp)) 7224 fnvlist_add_nvlist(item, "spares", sp); 7225 fnvlist_free(sp); 7226 } 7227 } 7228 7229 if (name != NULL && cb->cb_json) { 7230 fnvlist_add_nvlist(item, name, ent); 7231 fnvlist_free(ent); 7232 } 7233 } 7234 7235 /* 7236 * Generic callback function to list a pool. 7237 */ 7238 static int 7239 list_callback(zpool_handle_t *zhp, void *data) 7240 { 7241 nvlist_t *p, *d, *nvdevs; 7242 uint64_t guid; 7243 char pool_guid[256]; 7244 const char *pool_name = zpool_get_name(zhp); 7245 list_cbdata_t *cbp = data; 7246 p = d = nvdevs = NULL; 7247 7248 collect_pool(zhp, cbp); 7249 7250 if (cbp->cb_verbose) { 7251 nvlist_t *config, *nvroot; 7252 config = zpool_get_config(zhp, NULL); 7253 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE, 7254 &nvroot) == 0); 7255 if (cbp->cb_json) { 7256 d = fnvlist_lookup_nvlist(cbp->cb_jsobj, 7257 "pools"); 7258 if (cbp->cb_json_pool_key_guid) { 7259 guid = fnvlist_lookup_uint64(config, 7260 ZPOOL_CONFIG_POOL_GUID); 7261 snprintf(pool_guid, 256, "%llu", 7262 (u_longlong_t)guid); 7263 p = fnvlist_lookup_nvlist(d, pool_guid); 7264 } else { 7265 p = fnvlist_lookup_nvlist(d, pool_name); 7266 } 7267 nvdevs = fnvlist_alloc(); 7268 } 7269 collect_list_stats(zhp, NULL, nvroot, cbp, 0, B_FALSE, nvdevs); 7270 if (cbp->cb_json) { 7271 fnvlist_add_nvlist(p, "vdevs", nvdevs); 7272 if (cbp->cb_json_pool_key_guid) 7273 fnvlist_add_nvlist(d, pool_guid, p); 7274 else 7275 fnvlist_add_nvlist(d, pool_name, p); 7276 fnvlist_add_nvlist(cbp->cb_jsobj, "pools", d); 7277 fnvlist_free(nvdevs); 7278 } 7279 } 7280 7281 return (0); 7282 } 7283 7284 /* 7285 * Set the minimum pool/vdev name column width. The width must be at least 9, 7286 * but may be as large as needed. 7287 */ 7288 static int 7289 get_namewidth_list(zpool_handle_t *zhp, void *data) 7290 { 7291 list_cbdata_t *cb = data; 7292 int width; 7293 7294 width = get_namewidth(zhp, cb->cb_namewidth, 7295 cb->cb_name_flags | VDEV_NAME_TYPE_ID, cb->cb_verbose); 7296 7297 if (width < 9) 7298 width = 9; 7299 7300 cb->cb_namewidth = width; 7301 7302 return (0); 7303 } 7304 7305 /* 7306 * zpool list [-gHLpP] [-o prop[,prop]*] [-T d|u] [pool] ... [interval [count]] 7307 * 7308 * -g Display guid for individual vdev name. 7309 * -H Scripted mode. Don't display headers, and separate properties 7310 * by a single tab. 7311 * -L Follow links when resolving vdev path name. 7312 * -o List of properties to display. Defaults to 7313 * "name,size,allocated,free,expandsize,fragmentation,capacity," 7314 * "dedupratio,health,altroot" 7315 * -p Display values in parsable (exact) format. 7316 * -P Display full path for vdev name. 7317 * -T Display a timestamp in date(1) or Unix format 7318 * -j Display the output in JSON format 7319 * --json-int Display the numbers as integer instead of strings. 7320 * --json-pool-key-guid Set pool GUID as key for pool objects. 7321 * 7322 * List all pools in the system, whether or not they're healthy. Output space 7323 * statistics for each one, as well as health status summary. 7324 */ 7325 int 7326 zpool_do_list(int argc, char **argv) 7327 { 7328 int c; 7329 int ret = 0; 7330 list_cbdata_t cb = { 0 }; 7331 static char default_props[] = 7332 "name,size,allocated,free,checkpoint,expandsize,fragmentation," 7333 "capacity,dedupratio,health,altroot"; 7334 char *props = default_props; 7335 float interval = 0; 7336 unsigned long count = 0; 7337 zpool_list_t *list; 7338 boolean_t first = B_TRUE; 7339 nvlist_t *data = NULL; 7340 current_prop_type = ZFS_TYPE_POOL; 7341 7342 struct option long_options[] = { 7343 {"json", no_argument, NULL, 'j'}, 7344 {"json-int", no_argument, NULL, ZPOOL_OPTION_JSON_NUMS_AS_INT}, 7345 {"json-pool-key-guid", no_argument, NULL, 7346 ZPOOL_OPTION_POOL_KEY_GUID}, 7347 {0, 0, 0, 0} 7348 }; 7349 7350 /* check options */ 7351 while ((c = getopt_long(argc, argv, ":gjHLo:pPT:v", long_options, 7352 NULL)) != -1) { 7353 switch (c) { 7354 case 'g': 7355 cb.cb_name_flags |= VDEV_NAME_GUID; 7356 break; 7357 case 'H': 7358 cb.cb_scripted = B_TRUE; 7359 break; 7360 case 'L': 7361 cb.cb_name_flags |= VDEV_NAME_FOLLOW_LINKS; 7362 break; 7363 case 'o': 7364 props = optarg; 7365 break; 7366 case 'P': 7367 cb.cb_name_flags |= VDEV_NAME_PATH; 7368 break; 7369 case 'p': 7370 cb.cb_literal = B_TRUE; 7371 break; 7372 case 'j': 7373 cb.cb_json = B_TRUE; 7374 break; 7375 case ZPOOL_OPTION_JSON_NUMS_AS_INT: 7376 cb.cb_json_as_int = B_TRUE; 7377 cb.cb_literal = B_TRUE; 7378 break; 7379 case ZPOOL_OPTION_POOL_KEY_GUID: 7380 cb.cb_json_pool_key_guid = B_TRUE; 7381 break; 7382 case 'T': 7383 get_timestamp_arg(*optarg); 7384 break; 7385 case 'v': 7386 cb.cb_verbose = B_TRUE; 7387 cb.cb_namewidth = 8; /* 8 until precalc is avail */ 7388 break; 7389 case ':': 7390 (void) fprintf(stderr, gettext("missing argument for " 7391 "'%c' option\n"), optopt); 7392 usage(B_FALSE); 7393 break; 7394 case '?': 7395 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 7396 optopt); 7397 usage(B_FALSE); 7398 } 7399 } 7400 7401 argc -= optind; 7402 argv += optind; 7403 7404 if (!cb.cb_json && cb.cb_json_as_int) { 7405 (void) fprintf(stderr, gettext("'--json-int' only works with" 7406 " '-j' option\n")); 7407 usage(B_FALSE); 7408 } 7409 7410 if (!cb.cb_json && cb.cb_json_pool_key_guid) { 7411 (void) fprintf(stderr, gettext("'json-pool-key-guid' only" 7412 " works with '-j' option\n")); 7413 usage(B_FALSE); 7414 } 7415 7416 get_interval_count(&argc, argv, &interval, &count); 7417 7418 if (zprop_get_list(g_zfs, props, &cb.cb_proplist, ZFS_TYPE_POOL) != 0) 7419 usage(B_FALSE); 7420 7421 for (;;) { 7422 if ((list = pool_list_get(argc, argv, &cb.cb_proplist, 7423 ZFS_TYPE_POOL, cb.cb_literal, &ret)) == NULL) 7424 return (1); 7425 7426 if (pool_list_count(list) == 0) 7427 break; 7428 7429 if (cb.cb_json) { 7430 cb.cb_jsobj = zpool_json_schema(0, 1); 7431 data = fnvlist_alloc(); 7432 fnvlist_add_nvlist(cb.cb_jsobj, "pools", data); 7433 fnvlist_free(data); 7434 } 7435 7436 cb.cb_namewidth = 0; 7437 (void) pool_list_iter(list, B_FALSE, get_namewidth_list, &cb); 7438 7439 if (timestamp_fmt != NODATE) { 7440 if (cb.cb_json) { 7441 if (cb.cb_json_as_int) { 7442 fnvlist_add_uint64(cb.cb_jsobj, "time", 7443 time(NULL)); 7444 } else { 7445 char ts[128]; 7446 get_timestamp(timestamp_fmt, ts, 128); 7447 fnvlist_add_string(cb.cb_jsobj, "time", 7448 ts); 7449 } 7450 } else 7451 print_timestamp(timestamp_fmt); 7452 } 7453 7454 if (!cb.cb_scripted && (first || cb.cb_verbose) && 7455 !cb.cb_json) { 7456 print_header(&cb); 7457 first = B_FALSE; 7458 } 7459 ret = pool_list_iter(list, B_TRUE, list_callback, &cb); 7460 7461 if (ret == 0 && cb.cb_json) 7462 zcmd_print_json(cb.cb_jsobj); 7463 else if (ret != 0 && cb.cb_json) 7464 nvlist_free(cb.cb_jsobj); 7465 7466 if (interval == 0) 7467 break; 7468 7469 if (count != 0 && --count == 0) 7470 break; 7471 7472 pool_list_free(list); 7473 7474 (void) fflush(stdout); 7475 (void) fsleep(interval); 7476 } 7477 7478 if (argc == 0 && !cb.cb_scripted && !cb.cb_json && 7479 pool_list_count(list) == 0) { 7480 (void) printf(gettext("no pools available\n")); 7481 ret = 0; 7482 } 7483 7484 pool_list_free(list); 7485 zprop_free_list(cb.cb_proplist); 7486 return (ret); 7487 } 7488 7489 static int 7490 zpool_do_attach_or_replace(int argc, char **argv, int replacing) 7491 { 7492 boolean_t force = B_FALSE; 7493 boolean_t rebuild = B_FALSE; 7494 boolean_t wait = B_FALSE; 7495 int c; 7496 nvlist_t *nvroot; 7497 char *poolname, *old_disk, *new_disk; 7498 zpool_handle_t *zhp; 7499 nvlist_t *props = NULL; 7500 char *propval; 7501 int ret; 7502 7503 /* check options */ 7504 while ((c = getopt(argc, argv, "fo:sw")) != -1) { 7505 switch (c) { 7506 case 'f': 7507 force = B_TRUE; 7508 break; 7509 case 'o': 7510 if ((propval = strchr(optarg, '=')) == NULL) { 7511 (void) fprintf(stderr, gettext("missing " 7512 "'=' for -o option\n")); 7513 usage(B_FALSE); 7514 } 7515 *propval = '\0'; 7516 propval++; 7517 7518 if ((strcmp(optarg, ZPOOL_CONFIG_ASHIFT) != 0) || 7519 (add_prop_list(optarg, propval, &props, B_TRUE))) 7520 usage(B_FALSE); 7521 break; 7522 case 's': 7523 rebuild = B_TRUE; 7524 break; 7525 case 'w': 7526 wait = B_TRUE; 7527 break; 7528 case '?': 7529 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 7530 optopt); 7531 usage(B_FALSE); 7532 } 7533 } 7534 7535 argc -= optind; 7536 argv += optind; 7537 7538 /* get pool name and check number of arguments */ 7539 if (argc < 1) { 7540 (void) fprintf(stderr, gettext("missing pool name argument\n")); 7541 usage(B_FALSE); 7542 } 7543 7544 poolname = argv[0]; 7545 7546 if (argc < 2) { 7547 (void) fprintf(stderr, 7548 gettext("missing <device> specification\n")); 7549 usage(B_FALSE); 7550 } 7551 7552 old_disk = argv[1]; 7553 7554 if (argc < 3) { 7555 if (!replacing) { 7556 (void) fprintf(stderr, 7557 gettext("missing <new_device> specification\n")); 7558 usage(B_FALSE); 7559 } 7560 new_disk = old_disk; 7561 argc -= 1; 7562 argv += 1; 7563 } else { 7564 new_disk = argv[2]; 7565 argc -= 2; 7566 argv += 2; 7567 } 7568 7569 if (argc > 1) { 7570 (void) fprintf(stderr, gettext("too many arguments\n")); 7571 usage(B_FALSE); 7572 } 7573 7574 if ((zhp = zpool_open(g_zfs, poolname)) == NULL) { 7575 nvlist_free(props); 7576 return (1); 7577 } 7578 7579 if (zpool_get_config(zhp, NULL) == NULL) { 7580 (void) fprintf(stderr, gettext("pool '%s' is unavailable\n"), 7581 poolname); 7582 zpool_close(zhp); 7583 nvlist_free(props); 7584 return (1); 7585 } 7586 7587 /* unless manually specified use "ashift" pool property (if set) */ 7588 if (!nvlist_exists(props, ZPOOL_CONFIG_ASHIFT)) { 7589 int intval; 7590 zprop_source_t src; 7591 char strval[ZPOOL_MAXPROPLEN]; 7592 7593 intval = zpool_get_prop_int(zhp, ZPOOL_PROP_ASHIFT, &src); 7594 if (src != ZPROP_SRC_DEFAULT) { 7595 (void) sprintf(strval, "%" PRId32, intval); 7596 verify(add_prop_list(ZPOOL_CONFIG_ASHIFT, strval, 7597 &props, B_TRUE) == 0); 7598 } 7599 } 7600 7601 nvroot = make_root_vdev(zhp, props, force, B_FALSE, replacing, B_FALSE, 7602 argc, argv); 7603 if (nvroot == NULL) { 7604 zpool_close(zhp); 7605 nvlist_free(props); 7606 return (1); 7607 } 7608 7609 ret = zpool_vdev_attach(zhp, old_disk, new_disk, nvroot, replacing, 7610 rebuild); 7611 7612 if (ret == 0 && wait) { 7613 zpool_wait_activity_t activity = ZPOOL_WAIT_RESILVER; 7614 char raidz_prefix[] = "raidz"; 7615 if (replacing) { 7616 activity = ZPOOL_WAIT_REPLACE; 7617 } else if (strncmp(old_disk, 7618 raidz_prefix, strlen(raidz_prefix)) == 0) { 7619 activity = ZPOOL_WAIT_RAIDZ_EXPAND; 7620 } 7621 ret = zpool_wait(zhp, activity); 7622 } 7623 7624 nvlist_free(props); 7625 nvlist_free(nvroot); 7626 zpool_close(zhp); 7627 7628 return (ret); 7629 } 7630 7631 /* 7632 * zpool replace [-fsw] [-o property=value] <pool> <device> <new_device> 7633 * 7634 * -f Force attach, even if <new_device> appears to be in use. 7635 * -s Use sequential instead of healing reconstruction for resilver. 7636 * -o Set property=value. 7637 * -w Wait for replacing to complete before returning 7638 * 7639 * Replace <device> with <new_device>. 7640 */ 7641 int 7642 zpool_do_replace(int argc, char **argv) 7643 { 7644 return (zpool_do_attach_or_replace(argc, argv, B_TRUE)); 7645 } 7646 7647 /* 7648 * zpool attach [-fsw] [-o property=value] <pool> <device>|<vdev> <new_device> 7649 * 7650 * -f Force attach, even if <new_device> appears to be in use. 7651 * -s Use sequential instead of healing reconstruction for resilver. 7652 * -o Set property=value. 7653 * -w Wait for resilvering (mirror) or expansion (raidz) to complete 7654 * before returning. 7655 * 7656 * Attach <new_device> to a <device> or <vdev>, where the vdev can be of type 7657 * mirror or raidz. If <device> is not part of a mirror, then <device> will 7658 * be transformed into a mirror of <device> and <new_device>. When a mirror 7659 * is involved, <new_device> will begin life with a DTL of [0, now], and will 7660 * immediately begin to resilver itself. For the raidz case, a expansion will 7661 * commence and reflow the raidz data across all the disks including the 7662 * <new_device>. 7663 */ 7664 int 7665 zpool_do_attach(int argc, char **argv) 7666 { 7667 return (zpool_do_attach_or_replace(argc, argv, B_FALSE)); 7668 } 7669 7670 /* 7671 * zpool detach [-f] <pool> <device> 7672 * 7673 * -f Force detach of <device>, even if DTLs argue against it 7674 * (not supported yet) 7675 * 7676 * Detach a device from a mirror. The operation will be refused if <device> 7677 * is the last device in the mirror, or if the DTLs indicate that this device 7678 * has the only valid copy of some data. 7679 */ 7680 int 7681 zpool_do_detach(int argc, char **argv) 7682 { 7683 int c; 7684 char *poolname, *path; 7685 zpool_handle_t *zhp; 7686 int ret; 7687 7688 /* check options */ 7689 while ((c = getopt(argc, argv, "")) != -1) { 7690 switch (c) { 7691 case '?': 7692 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 7693 optopt); 7694 usage(B_FALSE); 7695 } 7696 } 7697 7698 argc -= optind; 7699 argv += optind; 7700 7701 /* get pool name and check number of arguments */ 7702 if (argc < 1) { 7703 (void) fprintf(stderr, gettext("missing pool name argument\n")); 7704 usage(B_FALSE); 7705 } 7706 7707 if (argc < 2) { 7708 (void) fprintf(stderr, 7709 gettext("missing <device> specification\n")); 7710 usage(B_FALSE); 7711 } 7712 7713 poolname = argv[0]; 7714 path = argv[1]; 7715 7716 if ((zhp = zpool_open(g_zfs, poolname)) == NULL) 7717 return (1); 7718 7719 ret = zpool_vdev_detach(zhp, path); 7720 7721 zpool_close(zhp); 7722 7723 return (ret); 7724 } 7725 7726 /* 7727 * zpool split [-gLnP] [-o prop=val] ... 7728 * [-o mntopt] ... 7729 * [-R altroot] <pool> <newpool> [<device> ...] 7730 * 7731 * -g Display guid for individual vdev name. 7732 * -L Follow links when resolving vdev path name. 7733 * -n Do not split the pool, but display the resulting layout if 7734 * it were to be split. 7735 * -o Set property=value, or set mount options. 7736 * -P Display full path for vdev name. 7737 * -R Mount the split-off pool under an alternate root. 7738 * -l Load encryption keys while importing. 7739 * 7740 * Splits the named pool and gives it the new pool name. Devices to be split 7741 * off may be listed, provided that no more than one device is specified 7742 * per top-level vdev mirror. The newly split pool is left in an exported 7743 * state unless -R is specified. 7744 * 7745 * Restrictions: the top-level of the pool pool must only be made up of 7746 * mirrors; all devices in the pool must be healthy; no device may be 7747 * undergoing a resilvering operation. 7748 */ 7749 int 7750 zpool_do_split(int argc, char **argv) 7751 { 7752 char *srcpool, *newpool, *propval; 7753 char *mntopts = NULL; 7754 splitflags_t flags; 7755 int c, ret = 0; 7756 int ms_status = 0; 7757 boolean_t loadkeys = B_FALSE; 7758 zpool_handle_t *zhp; 7759 nvlist_t *config, *props = NULL; 7760 7761 flags.dryrun = B_FALSE; 7762 flags.import = B_FALSE; 7763 flags.name_flags = 0; 7764 7765 /* check options */ 7766 while ((c = getopt(argc, argv, ":gLR:lno:P")) != -1) { 7767 switch (c) { 7768 case 'g': 7769 flags.name_flags |= VDEV_NAME_GUID; 7770 break; 7771 case 'L': 7772 flags.name_flags |= VDEV_NAME_FOLLOW_LINKS; 7773 break; 7774 case 'R': 7775 flags.import = B_TRUE; 7776 if (add_prop_list( 7777 zpool_prop_to_name(ZPOOL_PROP_ALTROOT), optarg, 7778 &props, B_TRUE) != 0) { 7779 nvlist_free(props); 7780 usage(B_FALSE); 7781 } 7782 break; 7783 case 'l': 7784 loadkeys = B_TRUE; 7785 break; 7786 case 'n': 7787 flags.dryrun = B_TRUE; 7788 break; 7789 case 'o': 7790 if ((propval = strchr(optarg, '=')) != NULL) { 7791 *propval = '\0'; 7792 propval++; 7793 if (add_prop_list(optarg, propval, 7794 &props, B_TRUE) != 0) { 7795 nvlist_free(props); 7796 usage(B_FALSE); 7797 } 7798 } else { 7799 mntopts = optarg; 7800 } 7801 break; 7802 case 'P': 7803 flags.name_flags |= VDEV_NAME_PATH; 7804 break; 7805 case ':': 7806 (void) fprintf(stderr, gettext("missing argument for " 7807 "'%c' option\n"), optopt); 7808 usage(B_FALSE); 7809 break; 7810 case '?': 7811 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 7812 optopt); 7813 usage(B_FALSE); 7814 break; 7815 } 7816 } 7817 7818 if (!flags.import && mntopts != NULL) { 7819 (void) fprintf(stderr, gettext("setting mntopts is only " 7820 "valid when importing the pool\n")); 7821 usage(B_FALSE); 7822 } 7823 7824 if (!flags.import && loadkeys) { 7825 (void) fprintf(stderr, gettext("loading keys is only " 7826 "valid when importing the pool\n")); 7827 usage(B_FALSE); 7828 } 7829 7830 argc -= optind; 7831 argv += optind; 7832 7833 if (argc < 1) { 7834 (void) fprintf(stderr, gettext("Missing pool name\n")); 7835 usage(B_FALSE); 7836 } 7837 if (argc < 2) { 7838 (void) fprintf(stderr, gettext("Missing new pool name\n")); 7839 usage(B_FALSE); 7840 } 7841 7842 srcpool = argv[0]; 7843 newpool = argv[1]; 7844 7845 argc -= 2; 7846 argv += 2; 7847 7848 if ((zhp = zpool_open(g_zfs, srcpool)) == NULL) { 7849 nvlist_free(props); 7850 return (1); 7851 } 7852 7853 config = split_mirror_vdev(zhp, newpool, props, flags, argc, argv); 7854 if (config == NULL) { 7855 ret = 1; 7856 } else { 7857 if (flags.dryrun) { 7858 (void) printf(gettext("would create '%s' with the " 7859 "following layout:\n\n"), newpool); 7860 print_vdev_tree(NULL, newpool, config, 0, "", 7861 flags.name_flags); 7862 print_vdev_tree(NULL, "dedup", config, 0, 7863 VDEV_ALLOC_BIAS_DEDUP, 0); 7864 print_vdev_tree(NULL, "special", config, 0, 7865 VDEV_ALLOC_BIAS_SPECIAL, 0); 7866 } 7867 } 7868 7869 zpool_close(zhp); 7870 7871 if (ret != 0 || flags.dryrun || !flags.import) { 7872 nvlist_free(config); 7873 nvlist_free(props); 7874 return (ret); 7875 } 7876 7877 /* 7878 * The split was successful. Now we need to open the new 7879 * pool and import it. 7880 */ 7881 if ((zhp = zpool_open_canfail(g_zfs, newpool)) == NULL) { 7882 nvlist_free(config); 7883 nvlist_free(props); 7884 return (1); 7885 } 7886 7887 if (loadkeys) { 7888 ret = zfs_crypto_attempt_load_keys(g_zfs, newpool); 7889 if (ret != 0) 7890 ret = 1; 7891 } 7892 7893 if (zpool_get_state(zhp) != POOL_STATE_UNAVAIL) { 7894 ms_status = zpool_enable_datasets(zhp, mntopts, 0, 7895 mount_tp_nthr); 7896 if (ms_status == EZFS_SHAREFAILED) { 7897 (void) fprintf(stderr, gettext("Split was successful, " 7898 "datasets are mounted but sharing of some datasets " 7899 "has failed\n")); 7900 } else if (ms_status == EZFS_MOUNTFAILED) { 7901 (void) fprintf(stderr, gettext("Split was successful" 7902 ", but some datasets could not be mounted\n")); 7903 (void) fprintf(stderr, gettext("Try doing '%s' with a " 7904 "different altroot\n"), "zpool import"); 7905 } 7906 } 7907 zpool_close(zhp); 7908 nvlist_free(config); 7909 nvlist_free(props); 7910 7911 return (ret); 7912 } 7913 7914 7915 /* 7916 * zpool online [--power] <pool> <device> ... 7917 * 7918 * --power: Power on the enclosure slot to the drive (if possible) 7919 */ 7920 int 7921 zpool_do_online(int argc, char **argv) 7922 { 7923 int c, i; 7924 char *poolname; 7925 zpool_handle_t *zhp; 7926 int ret = 0; 7927 vdev_state_t newstate; 7928 int flags = 0; 7929 boolean_t is_power_on = B_FALSE; 7930 struct option long_options[] = { 7931 {"power", no_argument, NULL, ZPOOL_OPTION_POWER}, 7932 {0, 0, 0, 0} 7933 }; 7934 7935 /* check options */ 7936 while ((c = getopt_long(argc, argv, "e", long_options, NULL)) != -1) { 7937 switch (c) { 7938 case 'e': 7939 flags |= ZFS_ONLINE_EXPAND; 7940 break; 7941 case ZPOOL_OPTION_POWER: 7942 is_power_on = B_TRUE; 7943 break; 7944 case '?': 7945 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 7946 optopt); 7947 usage(B_FALSE); 7948 } 7949 } 7950 7951 if (libzfs_envvar_is_set("ZPOOL_AUTO_POWER_ON_SLOT")) 7952 is_power_on = B_TRUE; 7953 7954 argc -= optind; 7955 argv += optind; 7956 7957 /* get pool name and check number of arguments */ 7958 if (argc < 1) { 7959 (void) fprintf(stderr, gettext("missing pool name\n")); 7960 usage(B_FALSE); 7961 } 7962 if (argc < 2) { 7963 (void) fprintf(stderr, gettext("missing device name\n")); 7964 usage(B_FALSE); 7965 } 7966 7967 poolname = argv[0]; 7968 7969 if ((zhp = zpool_open(g_zfs, poolname)) == NULL) 7970 return (1); 7971 7972 for (i = 1; i < argc; i++) { 7973 vdev_state_t oldstate; 7974 boolean_t avail_spare, l2cache; 7975 int rc; 7976 7977 if (is_power_on) { 7978 rc = zpool_power_on_and_disk_wait(zhp, argv[i]); 7979 if (rc == ENOTSUP) { 7980 (void) fprintf(stderr, 7981 gettext("Power control not supported\n")); 7982 } 7983 if (rc != 0) 7984 return (rc); 7985 } 7986 7987 nvlist_t *tgt = zpool_find_vdev(zhp, argv[i], &avail_spare, 7988 &l2cache, NULL); 7989 if (tgt == NULL) { 7990 ret = 1; 7991 continue; 7992 } 7993 uint_t vsc; 7994 oldstate = ((vdev_stat_t *)fnvlist_lookup_uint64_array(tgt, 7995 ZPOOL_CONFIG_VDEV_STATS, &vsc))->vs_state; 7996 if (zpool_vdev_online(zhp, argv[i], flags, &newstate) == 0) { 7997 if (newstate != VDEV_STATE_HEALTHY) { 7998 (void) printf(gettext("warning: device '%s' " 7999 "onlined, but remains in faulted state\n"), 8000 argv[i]); 8001 if (newstate == VDEV_STATE_FAULTED) 8002 (void) printf(gettext("use 'zpool " 8003 "clear' to restore a faulted " 8004 "device\n")); 8005 else 8006 (void) printf(gettext("use 'zpool " 8007 "replace' to replace devices " 8008 "that are no longer present\n")); 8009 if ((flags & ZFS_ONLINE_EXPAND)) { 8010 (void) printf(gettext("%s: failed " 8011 "to expand usable space on " 8012 "unhealthy device '%s'\n"), 8013 (oldstate >= VDEV_STATE_DEGRADED ? 8014 "error" : "warning"), argv[i]); 8015 if (oldstate >= VDEV_STATE_DEGRADED) { 8016 ret = 1; 8017 break; 8018 } 8019 } 8020 } 8021 } else { 8022 ret = 1; 8023 } 8024 } 8025 8026 zpool_close(zhp); 8027 8028 return (ret); 8029 } 8030 8031 /* 8032 * zpool offline [-ft]|[--power] <pool> <device> ... 8033 * 8034 * 8035 * -f Force the device into a faulted state. 8036 * 8037 * -t Only take the device off-line temporarily. The offline/faulted 8038 * state will not be persistent across reboots. 8039 * 8040 * --power Power off the enclosure slot to the drive (if possible) 8041 */ 8042 int 8043 zpool_do_offline(int argc, char **argv) 8044 { 8045 int c, i; 8046 char *poolname; 8047 zpool_handle_t *zhp; 8048 int ret = 0; 8049 boolean_t istmp = B_FALSE; 8050 boolean_t fault = B_FALSE; 8051 boolean_t is_power_off = B_FALSE; 8052 8053 struct option long_options[] = { 8054 {"power", no_argument, NULL, ZPOOL_OPTION_POWER}, 8055 {0, 0, 0, 0} 8056 }; 8057 8058 /* check options */ 8059 while ((c = getopt_long(argc, argv, "ft", long_options, NULL)) != -1) { 8060 switch (c) { 8061 case 'f': 8062 fault = B_TRUE; 8063 break; 8064 case 't': 8065 istmp = B_TRUE; 8066 break; 8067 case ZPOOL_OPTION_POWER: 8068 is_power_off = B_TRUE; 8069 break; 8070 case '?': 8071 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 8072 optopt); 8073 usage(B_FALSE); 8074 } 8075 } 8076 8077 if (is_power_off && fault) { 8078 (void) fprintf(stderr, 8079 gettext("-0 and -f cannot be used together\n")); 8080 usage(B_FALSE); 8081 return (1); 8082 } 8083 8084 if (is_power_off && istmp) { 8085 (void) fprintf(stderr, 8086 gettext("-0 and -t cannot be used together\n")); 8087 usage(B_FALSE); 8088 return (1); 8089 } 8090 8091 argc -= optind; 8092 argv += optind; 8093 8094 /* get pool name and check number of arguments */ 8095 if (argc < 1) { 8096 (void) fprintf(stderr, gettext("missing pool name\n")); 8097 usage(B_FALSE); 8098 } 8099 if (argc < 2) { 8100 (void) fprintf(stderr, gettext("missing device name\n")); 8101 usage(B_FALSE); 8102 } 8103 8104 poolname = argv[0]; 8105 8106 if ((zhp = zpool_open(g_zfs, poolname)) == NULL) 8107 return (1); 8108 8109 for (i = 1; i < argc; i++) { 8110 uint64_t guid = zpool_vdev_path_to_guid(zhp, argv[i]); 8111 if (is_power_off) { 8112 /* 8113 * Note: we have to power off first, then set REMOVED, 8114 * or else zpool_vdev_set_removed_state() returns 8115 * EAGAIN. 8116 */ 8117 ret = zpool_power_off(zhp, argv[i]); 8118 if (ret != 0) { 8119 (void) fprintf(stderr, "%s %s %d\n", 8120 gettext("unable to power off slot for"), 8121 argv[i], ret); 8122 } 8123 zpool_vdev_set_removed_state(zhp, guid, VDEV_AUX_NONE); 8124 8125 } else if (fault) { 8126 vdev_aux_t aux; 8127 if (istmp == B_FALSE) { 8128 /* Force the fault to persist across imports */ 8129 aux = VDEV_AUX_EXTERNAL_PERSIST; 8130 } else { 8131 aux = VDEV_AUX_EXTERNAL; 8132 } 8133 8134 if (guid == 0 || zpool_vdev_fault(zhp, guid, aux) != 0) 8135 ret = 1; 8136 } else { 8137 if (zpool_vdev_offline(zhp, argv[i], istmp) != 0) 8138 ret = 1; 8139 } 8140 } 8141 8142 zpool_close(zhp); 8143 8144 return (ret); 8145 } 8146 8147 /* 8148 * zpool clear [-nF]|[--power] <pool> [device] 8149 * 8150 * Clear all errors associated with a pool or a particular device. 8151 */ 8152 int 8153 zpool_do_clear(int argc, char **argv) 8154 { 8155 int c; 8156 int ret = 0; 8157 boolean_t dryrun = B_FALSE; 8158 boolean_t do_rewind = B_FALSE; 8159 boolean_t xtreme_rewind = B_FALSE; 8160 boolean_t is_power_on = B_FALSE; 8161 uint32_t rewind_policy = ZPOOL_NO_REWIND; 8162 nvlist_t *policy = NULL; 8163 zpool_handle_t *zhp; 8164 char *pool, *device; 8165 8166 struct option long_options[] = { 8167 {"power", no_argument, NULL, ZPOOL_OPTION_POWER}, 8168 {0, 0, 0, 0} 8169 }; 8170 8171 /* check options */ 8172 while ((c = getopt_long(argc, argv, "FnX", long_options, 8173 NULL)) != -1) { 8174 switch (c) { 8175 case 'F': 8176 do_rewind = B_TRUE; 8177 break; 8178 case 'n': 8179 dryrun = B_TRUE; 8180 break; 8181 case 'X': 8182 xtreme_rewind = B_TRUE; 8183 break; 8184 case ZPOOL_OPTION_POWER: 8185 is_power_on = B_TRUE; 8186 break; 8187 case '?': 8188 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 8189 optopt); 8190 usage(B_FALSE); 8191 } 8192 } 8193 8194 if (libzfs_envvar_is_set("ZPOOL_AUTO_POWER_ON_SLOT")) 8195 is_power_on = B_TRUE; 8196 8197 argc -= optind; 8198 argv += optind; 8199 8200 if (argc < 1) { 8201 (void) fprintf(stderr, gettext("missing pool name\n")); 8202 usage(B_FALSE); 8203 } 8204 8205 if (argc > 2) { 8206 (void) fprintf(stderr, gettext("too many arguments\n")); 8207 usage(B_FALSE); 8208 } 8209 8210 if ((dryrun || xtreme_rewind) && !do_rewind) { 8211 (void) fprintf(stderr, 8212 gettext("-n or -X only meaningful with -F\n")); 8213 usage(B_FALSE); 8214 } 8215 if (dryrun) 8216 rewind_policy = ZPOOL_TRY_REWIND; 8217 else if (do_rewind) 8218 rewind_policy = ZPOOL_DO_REWIND; 8219 if (xtreme_rewind) 8220 rewind_policy |= ZPOOL_EXTREME_REWIND; 8221 8222 /* In future, further rewind policy choices can be passed along here */ 8223 if (nvlist_alloc(&policy, NV_UNIQUE_NAME, 0) != 0 || 8224 nvlist_add_uint32(policy, ZPOOL_LOAD_REWIND_POLICY, 8225 rewind_policy) != 0) { 8226 return (1); 8227 } 8228 8229 pool = argv[0]; 8230 device = argc == 2 ? argv[1] : NULL; 8231 8232 if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL) { 8233 nvlist_free(policy); 8234 return (1); 8235 } 8236 8237 if (is_power_on) { 8238 if (device == NULL) { 8239 zpool_power_on_pool_and_wait_for_devices(zhp); 8240 } else { 8241 zpool_power_on_and_disk_wait(zhp, device); 8242 } 8243 } 8244 8245 if (zpool_clear(zhp, device, policy) != 0) 8246 ret = 1; 8247 8248 zpool_close(zhp); 8249 8250 nvlist_free(policy); 8251 8252 return (ret); 8253 } 8254 8255 /* 8256 * zpool reguid [-g <guid>] <pool> 8257 */ 8258 int 8259 zpool_do_reguid(int argc, char **argv) 8260 { 8261 uint64_t guid; 8262 uint64_t *guidp = NULL; 8263 int c; 8264 char *endptr; 8265 char *poolname; 8266 zpool_handle_t *zhp; 8267 int ret = 0; 8268 8269 /* check options */ 8270 while ((c = getopt(argc, argv, "g:")) != -1) { 8271 switch (c) { 8272 case 'g': 8273 errno = 0; 8274 guid = strtoull(optarg, &endptr, 10); 8275 if (errno != 0 || *endptr != '\0') { 8276 (void) fprintf(stderr, 8277 gettext("invalid GUID: %s\n"), optarg); 8278 usage(B_FALSE); 8279 } 8280 guidp = &guid; 8281 break; 8282 case '?': 8283 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 8284 optopt); 8285 usage(B_FALSE); 8286 } 8287 } 8288 8289 argc -= optind; 8290 argv += optind; 8291 8292 /* get pool name and check number of arguments */ 8293 if (argc < 1) { 8294 (void) fprintf(stderr, gettext("missing pool name\n")); 8295 usage(B_FALSE); 8296 } 8297 8298 if (argc > 1) { 8299 (void) fprintf(stderr, gettext("too many arguments\n")); 8300 usage(B_FALSE); 8301 } 8302 8303 poolname = argv[0]; 8304 if ((zhp = zpool_open(g_zfs, poolname)) == NULL) 8305 return (1); 8306 8307 ret = zpool_set_guid(zhp, guidp); 8308 8309 zpool_close(zhp); 8310 return (ret); 8311 } 8312 8313 8314 /* 8315 * zpool reopen <pool> 8316 * 8317 * Reopen the pool so that the kernel can update the sizes of all vdevs. 8318 */ 8319 int 8320 zpool_do_reopen(int argc, char **argv) 8321 { 8322 int c; 8323 int ret = 0; 8324 boolean_t scrub_restart = B_TRUE; 8325 8326 /* check options */ 8327 while ((c = getopt(argc, argv, "n")) != -1) { 8328 switch (c) { 8329 case 'n': 8330 scrub_restart = B_FALSE; 8331 break; 8332 case '?': 8333 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 8334 optopt); 8335 usage(B_FALSE); 8336 } 8337 } 8338 8339 argc -= optind; 8340 argv += optind; 8341 8342 /* if argc == 0 we will execute zpool_reopen_one on all pools */ 8343 ret = for_each_pool(argc, argv, B_TRUE, NULL, ZFS_TYPE_POOL, 8344 B_FALSE, zpool_reopen_one, &scrub_restart); 8345 8346 return (ret); 8347 } 8348 8349 typedef struct scrub_cbdata { 8350 int cb_type; 8351 pool_scrub_cmd_t cb_scrub_cmd; 8352 } scrub_cbdata_t; 8353 8354 static boolean_t 8355 zpool_has_checkpoint(zpool_handle_t *zhp) 8356 { 8357 nvlist_t *config, *nvroot; 8358 8359 config = zpool_get_config(zhp, NULL); 8360 8361 if (config != NULL) { 8362 pool_checkpoint_stat_t *pcs = NULL; 8363 uint_t c; 8364 8365 nvroot = fnvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE); 8366 (void) nvlist_lookup_uint64_array(nvroot, 8367 ZPOOL_CONFIG_CHECKPOINT_STATS, (uint64_t **)&pcs, &c); 8368 8369 if (pcs == NULL || pcs->pcs_state == CS_NONE) 8370 return (B_FALSE); 8371 8372 assert(pcs->pcs_state == CS_CHECKPOINT_EXISTS || 8373 pcs->pcs_state == CS_CHECKPOINT_DISCARDING); 8374 return (B_TRUE); 8375 } 8376 8377 return (B_FALSE); 8378 } 8379 8380 static int 8381 scrub_callback(zpool_handle_t *zhp, void *data) 8382 { 8383 scrub_cbdata_t *cb = data; 8384 int err; 8385 8386 /* 8387 * Ignore faulted pools. 8388 */ 8389 if (zpool_get_state(zhp) == POOL_STATE_UNAVAIL) { 8390 (void) fprintf(stderr, gettext("cannot scan '%s': pool is " 8391 "currently unavailable\n"), zpool_get_name(zhp)); 8392 return (1); 8393 } 8394 8395 err = zpool_scan(zhp, cb->cb_type, cb->cb_scrub_cmd); 8396 8397 if (err == 0 && zpool_has_checkpoint(zhp) && 8398 cb->cb_type == POOL_SCAN_SCRUB) { 8399 (void) printf(gettext("warning: will not scrub state that " 8400 "belongs to the checkpoint of pool '%s'\n"), 8401 zpool_get_name(zhp)); 8402 } 8403 8404 return (err != 0); 8405 } 8406 8407 static int 8408 wait_callback(zpool_handle_t *zhp, void *data) 8409 { 8410 zpool_wait_activity_t *act = data; 8411 return (zpool_wait(zhp, *act)); 8412 } 8413 8414 /* 8415 * zpool scrub [-s | -p] [-w] [-e] <pool> ... 8416 * 8417 * -e Only scrub blocks in the error log. 8418 * -s Stop. Stops any in-progress scrub. 8419 * -p Pause. Pause in-progress scrub. 8420 * -w Wait. Blocks until scrub has completed. 8421 */ 8422 int 8423 zpool_do_scrub(int argc, char **argv) 8424 { 8425 int c; 8426 scrub_cbdata_t cb; 8427 boolean_t wait = B_FALSE; 8428 int error; 8429 8430 cb.cb_type = POOL_SCAN_SCRUB; 8431 cb.cb_scrub_cmd = POOL_SCRUB_NORMAL; 8432 8433 boolean_t is_error_scrub = B_FALSE; 8434 boolean_t is_pause = B_FALSE; 8435 boolean_t is_stop = B_FALSE; 8436 8437 /* check options */ 8438 while ((c = getopt(argc, argv, "spwe")) != -1) { 8439 switch (c) { 8440 case 'e': 8441 is_error_scrub = B_TRUE; 8442 break; 8443 case 's': 8444 is_stop = B_TRUE; 8445 break; 8446 case 'p': 8447 is_pause = B_TRUE; 8448 break; 8449 case 'w': 8450 wait = B_TRUE; 8451 break; 8452 case '?': 8453 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 8454 optopt); 8455 usage(B_FALSE); 8456 } 8457 } 8458 8459 if (is_pause && is_stop) { 8460 (void) fprintf(stderr, gettext("invalid option " 8461 "combination :-s and -p are mutually exclusive\n")); 8462 usage(B_FALSE); 8463 } else { 8464 if (is_error_scrub) 8465 cb.cb_type = POOL_SCAN_ERRORSCRUB; 8466 8467 if (is_pause) { 8468 cb.cb_scrub_cmd = POOL_SCRUB_PAUSE; 8469 } else if (is_stop) { 8470 cb.cb_type = POOL_SCAN_NONE; 8471 } else { 8472 cb.cb_scrub_cmd = POOL_SCRUB_NORMAL; 8473 } 8474 } 8475 8476 if (wait && (cb.cb_type == POOL_SCAN_NONE || 8477 cb.cb_scrub_cmd == POOL_SCRUB_PAUSE)) { 8478 (void) fprintf(stderr, gettext("invalid option combination: " 8479 "-w cannot be used with -p or -s\n")); 8480 usage(B_FALSE); 8481 } 8482 8483 argc -= optind; 8484 argv += optind; 8485 8486 if (argc < 1) { 8487 (void) fprintf(stderr, gettext("missing pool name argument\n")); 8488 usage(B_FALSE); 8489 } 8490 8491 error = for_each_pool(argc, argv, B_TRUE, NULL, ZFS_TYPE_POOL, 8492 B_FALSE, scrub_callback, &cb); 8493 8494 if (wait && !error) { 8495 zpool_wait_activity_t act = ZPOOL_WAIT_SCRUB; 8496 error = for_each_pool(argc, argv, B_TRUE, NULL, ZFS_TYPE_POOL, 8497 B_FALSE, wait_callback, &act); 8498 } 8499 8500 return (error); 8501 } 8502 8503 /* 8504 * zpool resilver <pool> ... 8505 * 8506 * Restarts any in-progress resilver 8507 */ 8508 int 8509 zpool_do_resilver(int argc, char **argv) 8510 { 8511 int c; 8512 scrub_cbdata_t cb; 8513 8514 cb.cb_type = POOL_SCAN_RESILVER; 8515 cb.cb_scrub_cmd = POOL_SCRUB_NORMAL; 8516 8517 /* check options */ 8518 while ((c = getopt(argc, argv, "")) != -1) { 8519 switch (c) { 8520 case '?': 8521 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 8522 optopt); 8523 usage(B_FALSE); 8524 } 8525 } 8526 8527 argc -= optind; 8528 argv += optind; 8529 8530 if (argc < 1) { 8531 (void) fprintf(stderr, gettext("missing pool name argument\n")); 8532 usage(B_FALSE); 8533 } 8534 8535 return (for_each_pool(argc, argv, B_TRUE, NULL, ZFS_TYPE_POOL, 8536 B_FALSE, scrub_callback, &cb)); 8537 } 8538 8539 /* 8540 * zpool trim [-d] [-r <rate>] [-c | -s] <pool> [<device> ...] 8541 * 8542 * -c Cancel. Ends any in-progress trim. 8543 * -d Secure trim. Requires kernel and device support. 8544 * -r <rate> Sets the TRIM rate in bytes (per second). Supports 8545 * adding a multiplier suffix such as 'k' or 'm'. 8546 * -s Suspend. TRIM can then be restarted with no flags. 8547 * -w Wait. Blocks until trimming has completed. 8548 */ 8549 int 8550 zpool_do_trim(int argc, char **argv) 8551 { 8552 struct option long_options[] = { 8553 {"cancel", no_argument, NULL, 'c'}, 8554 {"secure", no_argument, NULL, 'd'}, 8555 {"rate", required_argument, NULL, 'r'}, 8556 {"suspend", no_argument, NULL, 's'}, 8557 {"wait", no_argument, NULL, 'w'}, 8558 {0, 0, 0, 0} 8559 }; 8560 8561 pool_trim_func_t cmd_type = POOL_TRIM_START; 8562 uint64_t rate = 0; 8563 boolean_t secure = B_FALSE; 8564 boolean_t wait = B_FALSE; 8565 8566 int c; 8567 while ((c = getopt_long(argc, argv, "cdr:sw", long_options, NULL)) 8568 != -1) { 8569 switch (c) { 8570 case 'c': 8571 if (cmd_type != POOL_TRIM_START && 8572 cmd_type != POOL_TRIM_CANCEL) { 8573 (void) fprintf(stderr, gettext("-c cannot be " 8574 "combined with other options\n")); 8575 usage(B_FALSE); 8576 } 8577 cmd_type = POOL_TRIM_CANCEL; 8578 break; 8579 case 'd': 8580 if (cmd_type != POOL_TRIM_START) { 8581 (void) fprintf(stderr, gettext("-d cannot be " 8582 "combined with the -c or -s options\n")); 8583 usage(B_FALSE); 8584 } 8585 secure = B_TRUE; 8586 break; 8587 case 'r': 8588 if (cmd_type != POOL_TRIM_START) { 8589 (void) fprintf(stderr, gettext("-r cannot be " 8590 "combined with the -c or -s options\n")); 8591 usage(B_FALSE); 8592 } 8593 if (zfs_nicestrtonum(g_zfs, optarg, &rate) == -1) { 8594 (void) fprintf(stderr, "%s: %s\n", 8595 gettext("invalid value for rate"), 8596 libzfs_error_description(g_zfs)); 8597 usage(B_FALSE); 8598 } 8599 break; 8600 case 's': 8601 if (cmd_type != POOL_TRIM_START && 8602 cmd_type != POOL_TRIM_SUSPEND) { 8603 (void) fprintf(stderr, gettext("-s cannot be " 8604 "combined with other options\n")); 8605 usage(B_FALSE); 8606 } 8607 cmd_type = POOL_TRIM_SUSPEND; 8608 break; 8609 case 'w': 8610 wait = B_TRUE; 8611 break; 8612 case '?': 8613 if (optopt != 0) { 8614 (void) fprintf(stderr, 8615 gettext("invalid option '%c'\n"), optopt); 8616 } else { 8617 (void) fprintf(stderr, 8618 gettext("invalid option '%s'\n"), 8619 argv[optind - 1]); 8620 } 8621 usage(B_FALSE); 8622 } 8623 } 8624 8625 argc -= optind; 8626 argv += optind; 8627 8628 if (argc < 1) { 8629 (void) fprintf(stderr, gettext("missing pool name argument\n")); 8630 usage(B_FALSE); 8631 return (-1); 8632 } 8633 8634 if (wait && (cmd_type != POOL_TRIM_START)) { 8635 (void) fprintf(stderr, gettext("-w cannot be used with -c or " 8636 "-s\n")); 8637 usage(B_FALSE); 8638 } 8639 8640 char *poolname = argv[0]; 8641 zpool_handle_t *zhp = zpool_open(g_zfs, poolname); 8642 if (zhp == NULL) 8643 return (-1); 8644 8645 trimflags_t trim_flags = { 8646 .secure = secure, 8647 .rate = rate, 8648 .wait = wait, 8649 }; 8650 8651 nvlist_t *vdevs = fnvlist_alloc(); 8652 if (argc == 1) { 8653 /* no individual leaf vdevs specified, so add them all */ 8654 nvlist_t *config = zpool_get_config(zhp, NULL); 8655 nvlist_t *nvroot = fnvlist_lookup_nvlist(config, 8656 ZPOOL_CONFIG_VDEV_TREE); 8657 zpool_collect_leaves(zhp, nvroot, vdevs); 8658 trim_flags.fullpool = B_TRUE; 8659 } else { 8660 trim_flags.fullpool = B_FALSE; 8661 for (int i = 1; i < argc; i++) { 8662 fnvlist_add_boolean(vdevs, argv[i]); 8663 } 8664 } 8665 8666 int error = zpool_trim(zhp, cmd_type, vdevs, &trim_flags); 8667 8668 fnvlist_free(vdevs); 8669 zpool_close(zhp); 8670 8671 return (error); 8672 } 8673 8674 /* 8675 * Converts a total number of seconds to a human readable string broken 8676 * down in to days/hours/minutes/seconds. 8677 */ 8678 static void 8679 secs_to_dhms(uint64_t total, char *buf) 8680 { 8681 uint64_t days = total / 60 / 60 / 24; 8682 uint64_t hours = (total / 60 / 60) % 24; 8683 uint64_t mins = (total / 60) % 60; 8684 uint64_t secs = (total % 60); 8685 8686 if (days > 0) { 8687 (void) sprintf(buf, "%llu days %02llu:%02llu:%02llu", 8688 (u_longlong_t)days, (u_longlong_t)hours, 8689 (u_longlong_t)mins, (u_longlong_t)secs); 8690 } else { 8691 (void) sprintf(buf, "%02llu:%02llu:%02llu", 8692 (u_longlong_t)hours, (u_longlong_t)mins, 8693 (u_longlong_t)secs); 8694 } 8695 } 8696 8697 /* 8698 * Print out detailed error scrub status. 8699 */ 8700 static void 8701 print_err_scrub_status(pool_scan_stat_t *ps) 8702 { 8703 time_t start, end, pause; 8704 uint64_t total_secs_left; 8705 uint64_t secs_left, mins_left, hours_left, days_left; 8706 uint64_t examined, to_be_examined; 8707 8708 if (ps == NULL || ps->pss_error_scrub_func != POOL_SCAN_ERRORSCRUB) { 8709 return; 8710 } 8711 8712 (void) printf(gettext(" scrub: ")); 8713 8714 start = ps->pss_error_scrub_start; 8715 end = ps->pss_error_scrub_end; 8716 pause = ps->pss_pass_error_scrub_pause; 8717 examined = ps->pss_error_scrub_examined; 8718 to_be_examined = ps->pss_error_scrub_to_be_examined; 8719 8720 assert(ps->pss_error_scrub_func == POOL_SCAN_ERRORSCRUB); 8721 8722 if (ps->pss_error_scrub_state == DSS_FINISHED) { 8723 total_secs_left = end - start; 8724 days_left = total_secs_left / 60 / 60 / 24; 8725 hours_left = (total_secs_left / 60 / 60) % 24; 8726 mins_left = (total_secs_left / 60) % 60; 8727 secs_left = (total_secs_left % 60); 8728 8729 (void) printf(gettext("scrubbed %llu error blocks in %llu days " 8730 "%02llu:%02llu:%02llu on %s"), (u_longlong_t)examined, 8731 (u_longlong_t)days_left, (u_longlong_t)hours_left, 8732 (u_longlong_t)mins_left, (u_longlong_t)secs_left, 8733 ctime(&end)); 8734 8735 return; 8736 } else if (ps->pss_error_scrub_state == DSS_CANCELED) { 8737 (void) printf(gettext("error scrub canceled on %s"), 8738 ctime(&end)); 8739 return; 8740 } 8741 assert(ps->pss_error_scrub_state == DSS_ERRORSCRUBBING); 8742 8743 /* Error scrub is in progress. */ 8744 if (pause == 0) { 8745 (void) printf(gettext("error scrub in progress since %s"), 8746 ctime(&start)); 8747 } else { 8748 (void) printf(gettext("error scrub paused since %s"), 8749 ctime(&pause)); 8750 (void) printf(gettext("\terror scrub started on %s"), 8751 ctime(&start)); 8752 } 8753 8754 double fraction_done = (double)examined / (to_be_examined + examined); 8755 (void) printf(gettext("\t%.2f%% done, issued I/O for %llu error" 8756 " blocks"), 100 * fraction_done, (u_longlong_t)examined); 8757 8758 (void) printf("\n"); 8759 } 8760 8761 /* 8762 * Print out detailed scrub status. 8763 */ 8764 static void 8765 print_scan_scrub_resilver_status(pool_scan_stat_t *ps) 8766 { 8767 time_t start, end, pause; 8768 uint64_t pass_scanned, scanned, pass_issued, issued, total_s, total_i; 8769 uint64_t elapsed, scan_rate, issue_rate; 8770 double fraction_done; 8771 char processed_buf[7], scanned_buf[7], issued_buf[7], total_s_buf[7]; 8772 char total_i_buf[7], srate_buf[7], irate_buf[7], time_buf[32]; 8773 8774 printf(" "); 8775 printf_color(ANSI_BOLD, gettext("scan:")); 8776 printf(" "); 8777 8778 /* If there's never been a scan, there's not much to say. */ 8779 if (ps == NULL || ps->pss_func == POOL_SCAN_NONE || 8780 ps->pss_func >= POOL_SCAN_FUNCS) { 8781 (void) printf(gettext("none requested\n")); 8782 return; 8783 } 8784 8785 start = ps->pss_start_time; 8786 end = ps->pss_end_time; 8787 pause = ps->pss_pass_scrub_pause; 8788 8789 zfs_nicebytes(ps->pss_processed, processed_buf, sizeof (processed_buf)); 8790 8791 int is_resilver = ps->pss_func == POOL_SCAN_RESILVER; 8792 int is_scrub = ps->pss_func == POOL_SCAN_SCRUB; 8793 assert(is_resilver || is_scrub); 8794 8795 /* Scan is finished or canceled. */ 8796 if (ps->pss_state == DSS_FINISHED) { 8797 secs_to_dhms(end - start, time_buf); 8798 8799 if (is_scrub) { 8800 (void) printf(gettext("scrub repaired %s " 8801 "in %s with %llu errors on %s"), processed_buf, 8802 time_buf, (u_longlong_t)ps->pss_errors, 8803 ctime(&end)); 8804 } else if (is_resilver) { 8805 (void) printf(gettext("resilvered %s " 8806 "in %s with %llu errors on %s"), processed_buf, 8807 time_buf, (u_longlong_t)ps->pss_errors, 8808 ctime(&end)); 8809 } 8810 return; 8811 } else if (ps->pss_state == DSS_CANCELED) { 8812 if (is_scrub) { 8813 (void) printf(gettext("scrub canceled on %s"), 8814 ctime(&end)); 8815 } else if (is_resilver) { 8816 (void) printf(gettext("resilver canceled on %s"), 8817 ctime(&end)); 8818 } 8819 return; 8820 } 8821 8822 assert(ps->pss_state == DSS_SCANNING); 8823 8824 /* Scan is in progress. Resilvers can't be paused. */ 8825 if (is_scrub) { 8826 if (pause == 0) { 8827 (void) printf(gettext("scrub in progress since %s"), 8828 ctime(&start)); 8829 } else { 8830 (void) printf(gettext("scrub paused since %s"), 8831 ctime(&pause)); 8832 (void) printf(gettext("\tscrub started on %s"), 8833 ctime(&start)); 8834 } 8835 } else if (is_resilver) { 8836 (void) printf(gettext("resilver in progress since %s"), 8837 ctime(&start)); 8838 } 8839 8840 scanned = ps->pss_examined; 8841 pass_scanned = ps->pss_pass_exam; 8842 issued = ps->pss_issued; 8843 pass_issued = ps->pss_pass_issued; 8844 total_s = ps->pss_to_examine; 8845 total_i = ps->pss_to_examine - ps->pss_skipped; 8846 8847 /* we are only done with a block once we have issued the IO for it */ 8848 fraction_done = (double)issued / total_i; 8849 8850 /* elapsed time for this pass, rounding up to 1 if it's 0 */ 8851 elapsed = time(NULL) - ps->pss_pass_start; 8852 elapsed -= ps->pss_pass_scrub_spent_paused; 8853 elapsed = (elapsed != 0) ? elapsed : 1; 8854 8855 scan_rate = pass_scanned / elapsed; 8856 issue_rate = pass_issued / elapsed; 8857 8858 /* format all of the numbers we will be reporting */ 8859 zfs_nicebytes(scanned, scanned_buf, sizeof (scanned_buf)); 8860 zfs_nicebytes(issued, issued_buf, sizeof (issued_buf)); 8861 zfs_nicebytes(total_s, total_s_buf, sizeof (total_s_buf)); 8862 zfs_nicebytes(total_i, total_i_buf, sizeof (total_i_buf)); 8863 8864 /* do not print estimated time if we have a paused scrub */ 8865 (void) printf(gettext("\t%s / %s scanned"), scanned_buf, total_s_buf); 8866 if (pause == 0 && scan_rate > 0) { 8867 zfs_nicebytes(scan_rate, srate_buf, sizeof (srate_buf)); 8868 (void) printf(gettext(" at %s/s"), srate_buf); 8869 } 8870 (void) printf(gettext(", %s / %s issued"), issued_buf, total_i_buf); 8871 if (pause == 0 && issue_rate > 0) { 8872 zfs_nicebytes(issue_rate, irate_buf, sizeof (irate_buf)); 8873 (void) printf(gettext(" at %s/s"), irate_buf); 8874 } 8875 (void) printf(gettext("\n")); 8876 8877 if (is_resilver) { 8878 (void) printf(gettext("\t%s resilvered, %.2f%% done"), 8879 processed_buf, 100 * fraction_done); 8880 } else if (is_scrub) { 8881 (void) printf(gettext("\t%s repaired, %.2f%% done"), 8882 processed_buf, 100 * fraction_done); 8883 } 8884 8885 if (pause == 0) { 8886 /* 8887 * Only provide an estimate iff: 8888 * 1) we haven't yet issued all we expected, and 8889 * 2) the issue rate exceeds 10 MB/s, and 8890 * 3) it's either: 8891 * a) a resilver which has started repairs, or 8892 * b) a scrub which has entered the issue phase. 8893 */ 8894 if (total_i >= issued && issue_rate >= 10 * 1024 * 1024 && 8895 ((is_resilver && ps->pss_processed > 0) || 8896 (is_scrub && issued > 0))) { 8897 secs_to_dhms((total_i - issued) / issue_rate, time_buf); 8898 (void) printf(gettext(", %s to go\n"), time_buf); 8899 } else { 8900 (void) printf(gettext(", no estimated " 8901 "completion time\n")); 8902 } 8903 } else { 8904 (void) printf(gettext("\n")); 8905 } 8906 } 8907 8908 static void 8909 print_rebuild_status_impl(vdev_rebuild_stat_t *vrs, uint_t c, char *vdev_name) 8910 { 8911 if (vrs == NULL || vrs->vrs_state == VDEV_REBUILD_NONE) 8912 return; 8913 8914 printf(" "); 8915 printf_color(ANSI_BOLD, gettext("scan:")); 8916 printf(" "); 8917 8918 uint64_t bytes_scanned = vrs->vrs_bytes_scanned; 8919 uint64_t bytes_issued = vrs->vrs_bytes_issued; 8920 uint64_t bytes_rebuilt = vrs->vrs_bytes_rebuilt; 8921 uint64_t bytes_est_s = vrs->vrs_bytes_est; 8922 uint64_t bytes_est_i = vrs->vrs_bytes_est; 8923 if (c > offsetof(vdev_rebuild_stat_t, vrs_pass_bytes_skipped) / 8) 8924 bytes_est_i -= vrs->vrs_pass_bytes_skipped; 8925 uint64_t scan_rate = (vrs->vrs_pass_bytes_scanned / 8926 (vrs->vrs_pass_time_ms + 1)) * 1000; 8927 uint64_t issue_rate = (vrs->vrs_pass_bytes_issued / 8928 (vrs->vrs_pass_time_ms + 1)) * 1000; 8929 double scan_pct = MIN((double)bytes_scanned * 100 / 8930 (bytes_est_s + 1), 100); 8931 8932 /* Format all of the numbers we will be reporting */ 8933 char bytes_scanned_buf[7], bytes_issued_buf[7]; 8934 char bytes_rebuilt_buf[7], bytes_est_s_buf[7], bytes_est_i_buf[7]; 8935 char scan_rate_buf[7], issue_rate_buf[7], time_buf[32]; 8936 zfs_nicebytes(bytes_scanned, bytes_scanned_buf, 8937 sizeof (bytes_scanned_buf)); 8938 zfs_nicebytes(bytes_issued, bytes_issued_buf, 8939 sizeof (bytes_issued_buf)); 8940 zfs_nicebytes(bytes_rebuilt, bytes_rebuilt_buf, 8941 sizeof (bytes_rebuilt_buf)); 8942 zfs_nicebytes(bytes_est_s, bytes_est_s_buf, sizeof (bytes_est_s_buf)); 8943 zfs_nicebytes(bytes_est_i, bytes_est_i_buf, sizeof (bytes_est_i_buf)); 8944 8945 time_t start = vrs->vrs_start_time; 8946 time_t end = vrs->vrs_end_time; 8947 8948 /* Rebuild is finished or canceled. */ 8949 if (vrs->vrs_state == VDEV_REBUILD_COMPLETE) { 8950 secs_to_dhms(vrs->vrs_scan_time_ms / 1000, time_buf); 8951 (void) printf(gettext("resilvered (%s) %s in %s " 8952 "with %llu errors on %s"), vdev_name, bytes_rebuilt_buf, 8953 time_buf, (u_longlong_t)vrs->vrs_errors, ctime(&end)); 8954 return; 8955 } else if (vrs->vrs_state == VDEV_REBUILD_CANCELED) { 8956 (void) printf(gettext("resilver (%s) canceled on %s"), 8957 vdev_name, ctime(&end)); 8958 return; 8959 } else if (vrs->vrs_state == VDEV_REBUILD_ACTIVE) { 8960 (void) printf(gettext("resilver (%s) in progress since %s"), 8961 vdev_name, ctime(&start)); 8962 } 8963 8964 assert(vrs->vrs_state == VDEV_REBUILD_ACTIVE); 8965 8966 (void) printf(gettext("\t%s / %s scanned"), bytes_scanned_buf, 8967 bytes_est_s_buf); 8968 if (scan_rate > 0) { 8969 zfs_nicebytes(scan_rate, scan_rate_buf, sizeof (scan_rate_buf)); 8970 (void) printf(gettext(" at %s/s"), scan_rate_buf); 8971 } 8972 (void) printf(gettext(", %s / %s issued"), bytes_issued_buf, 8973 bytes_est_i_buf); 8974 if (issue_rate > 0) { 8975 zfs_nicebytes(issue_rate, issue_rate_buf, 8976 sizeof (issue_rate_buf)); 8977 (void) printf(gettext(" at %s/s"), issue_rate_buf); 8978 } 8979 (void) printf(gettext("\n")); 8980 8981 (void) printf(gettext("\t%s resilvered, %.2f%% done"), 8982 bytes_rebuilt_buf, scan_pct); 8983 8984 if (vrs->vrs_state == VDEV_REBUILD_ACTIVE) { 8985 if (bytes_est_s >= bytes_scanned && 8986 scan_rate >= 10 * 1024 * 1024) { 8987 secs_to_dhms((bytes_est_s - bytes_scanned) / scan_rate, 8988 time_buf); 8989 (void) printf(gettext(", %s to go\n"), time_buf); 8990 } else { 8991 (void) printf(gettext(", no estimated " 8992 "completion time\n")); 8993 } 8994 } else { 8995 (void) printf(gettext("\n")); 8996 } 8997 } 8998 8999 /* 9000 * Print rebuild status for top-level vdevs. 9001 */ 9002 static void 9003 print_rebuild_status(zpool_handle_t *zhp, nvlist_t *nvroot) 9004 { 9005 nvlist_t **child; 9006 uint_t children; 9007 9008 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN, 9009 &child, &children) != 0) 9010 children = 0; 9011 9012 for (uint_t c = 0; c < children; c++) { 9013 vdev_rebuild_stat_t *vrs; 9014 uint_t i; 9015 9016 if (nvlist_lookup_uint64_array(child[c], 9017 ZPOOL_CONFIG_REBUILD_STATS, (uint64_t **)&vrs, &i) == 0) { 9018 char *name = zpool_vdev_name(g_zfs, zhp, 9019 child[c], VDEV_NAME_TYPE_ID); 9020 print_rebuild_status_impl(vrs, i, name); 9021 free(name); 9022 } 9023 } 9024 } 9025 9026 /* 9027 * As we don't scrub checkpointed blocks, we want to warn the user that we 9028 * skipped scanning some blocks if a checkpoint exists or existed at any 9029 * time during the scan. If a sequential instead of healing reconstruction 9030 * was performed then the blocks were reconstructed. However, their checksums 9031 * have not been verified so we still print the warning. 9032 */ 9033 static void 9034 print_checkpoint_scan_warning(pool_scan_stat_t *ps, pool_checkpoint_stat_t *pcs) 9035 { 9036 if (ps == NULL || pcs == NULL) 9037 return; 9038 9039 if (pcs->pcs_state == CS_NONE || 9040 pcs->pcs_state == CS_CHECKPOINT_DISCARDING) 9041 return; 9042 9043 assert(pcs->pcs_state == CS_CHECKPOINT_EXISTS); 9044 9045 if (ps->pss_state == DSS_NONE) 9046 return; 9047 9048 if ((ps->pss_state == DSS_FINISHED || ps->pss_state == DSS_CANCELED) && 9049 ps->pss_end_time < pcs->pcs_start_time) 9050 return; 9051 9052 if (ps->pss_state == DSS_FINISHED || ps->pss_state == DSS_CANCELED) { 9053 (void) printf(gettext(" scan warning: skipped blocks " 9054 "that are only referenced by the checkpoint.\n")); 9055 } else { 9056 assert(ps->pss_state == DSS_SCANNING); 9057 (void) printf(gettext(" scan warning: skipping blocks " 9058 "that are only referenced by the checkpoint.\n")); 9059 } 9060 } 9061 9062 /* 9063 * Returns B_TRUE if there is an active rebuild in progress. Otherwise, 9064 * B_FALSE is returned and 'rebuild_end_time' is set to the end time for 9065 * the last completed (or cancelled) rebuild. 9066 */ 9067 static boolean_t 9068 check_rebuilding(nvlist_t *nvroot, uint64_t *rebuild_end_time) 9069 { 9070 nvlist_t **child; 9071 uint_t children; 9072 boolean_t rebuilding = B_FALSE; 9073 uint64_t end_time = 0; 9074 9075 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN, 9076 &child, &children) != 0) 9077 children = 0; 9078 9079 for (uint_t c = 0; c < children; c++) { 9080 vdev_rebuild_stat_t *vrs; 9081 uint_t i; 9082 9083 if (nvlist_lookup_uint64_array(child[c], 9084 ZPOOL_CONFIG_REBUILD_STATS, (uint64_t **)&vrs, &i) == 0) { 9085 9086 if (vrs->vrs_end_time > end_time) 9087 end_time = vrs->vrs_end_time; 9088 9089 if (vrs->vrs_state == VDEV_REBUILD_ACTIVE) { 9090 rebuilding = B_TRUE; 9091 end_time = 0; 9092 break; 9093 } 9094 } 9095 } 9096 9097 if (rebuild_end_time != NULL) 9098 *rebuild_end_time = end_time; 9099 9100 return (rebuilding); 9101 } 9102 9103 static void 9104 vdev_stats_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t *nv, 9105 int depth, boolean_t isspare, char *parent, nvlist_t *item) 9106 { 9107 nvlist_t *vds, **child, *ch = NULL; 9108 uint_t vsc, children; 9109 vdev_stat_t *vs; 9110 char *vname; 9111 uint64_t notpresent; 9112 const char *type, *path; 9113 9114 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, 9115 &child, &children) != 0) 9116 children = 0; 9117 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS, 9118 (uint64_t **)&vs, &vsc) == 0); 9119 verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE, &type) == 0); 9120 if (strcmp(type, VDEV_TYPE_INDIRECT) == 0) 9121 return; 9122 9123 if (cb->cb_print_unhealthy && depth > 0 && 9124 for_each_vdev_in_nvlist(nv, vdev_health_check_cb, cb) == 0) { 9125 return; 9126 } 9127 vname = zpool_vdev_name(g_zfs, zhp, nv, 9128 cb->cb_name_flags | VDEV_NAME_TYPE_ID); 9129 vds = fnvlist_alloc(); 9130 fill_vdev_info(vds, zhp, vname, B_FALSE, cb->cb_json_as_int); 9131 if (cb->cb_flat_vdevs && parent != NULL) { 9132 fnvlist_add_string(vds, "parent", parent); 9133 } 9134 9135 if (isspare) { 9136 if (vs->vs_aux == VDEV_AUX_SPARED) { 9137 fnvlist_add_string(vds, "state", "INUSE"); 9138 used_by_other(zhp, nv, vds); 9139 } else if (vs->vs_state == VDEV_STATE_HEALTHY) 9140 fnvlist_add_string(vds, "state", "AVAIL"); 9141 } else { 9142 if (vs->vs_alloc) { 9143 nice_num_str_nvlist(vds, "alloc_space", vs->vs_alloc, 9144 cb->cb_literal, cb->cb_json_as_int, 9145 ZFS_NICENUM_BYTES); 9146 } 9147 if (vs->vs_space) { 9148 nice_num_str_nvlist(vds, "total_space", vs->vs_space, 9149 cb->cb_literal, cb->cb_json_as_int, 9150 ZFS_NICENUM_BYTES); 9151 } 9152 if (vs->vs_dspace) { 9153 nice_num_str_nvlist(vds, "def_space", vs->vs_dspace, 9154 cb->cb_literal, cb->cb_json_as_int, 9155 ZFS_NICENUM_BYTES); 9156 } 9157 if (vs->vs_rsize) { 9158 nice_num_str_nvlist(vds, "rep_dev_size", vs->vs_rsize, 9159 cb->cb_literal, cb->cb_json_as_int, 9160 ZFS_NICENUM_BYTES); 9161 } 9162 if (vs->vs_esize) { 9163 nice_num_str_nvlist(vds, "ex_dev_size", vs->vs_esize, 9164 cb->cb_literal, cb->cb_json_as_int, 9165 ZFS_NICENUM_BYTES); 9166 } 9167 if (vs->vs_self_healed) { 9168 nice_num_str_nvlist(vds, "self_healed", 9169 vs->vs_self_healed, cb->cb_literal, 9170 cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9171 } 9172 if (vs->vs_pspace) { 9173 nice_num_str_nvlist(vds, "phys_space", vs->vs_pspace, 9174 cb->cb_literal, cb->cb_json_as_int, 9175 ZFS_NICENUM_BYTES); 9176 } 9177 nice_num_str_nvlist(vds, "read_errors", vs->vs_read_errors, 9178 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9179 nice_num_str_nvlist(vds, "write_errors", vs->vs_write_errors, 9180 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9181 nice_num_str_nvlist(vds, "checksum_errors", 9182 vs->vs_checksum_errors, cb->cb_literal, 9183 cb->cb_json_as_int, ZFS_NICENUM_1024); 9184 if (vs->vs_scan_processed) { 9185 nice_num_str_nvlist(vds, "scan_processed", 9186 vs->vs_scan_processed, cb->cb_literal, 9187 cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9188 } 9189 if (vs->vs_checkpoint_space) { 9190 nice_num_str_nvlist(vds, "checkpoint_space", 9191 vs->vs_checkpoint_space, cb->cb_literal, 9192 cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9193 } 9194 if (vs->vs_resilver_deferred) { 9195 nice_num_str_nvlist(vds, "resilver_deferred", 9196 vs->vs_resilver_deferred, B_TRUE, 9197 cb->cb_json_as_int, ZFS_NICENUM_1024); 9198 } 9199 if (children == 0) { 9200 nice_num_str_nvlist(vds, "slow_ios", vs->vs_slow_ios, 9201 cb->cb_literal, cb->cb_json_as_int, 9202 ZFS_NICENUM_1024); 9203 } 9204 if (cb->cb_print_power) { 9205 if (children == 0) { 9206 /* Only leaf vdevs have physical slots */ 9207 switch (zpool_power_current_state(zhp, (char *) 9208 fnvlist_lookup_string(nv, 9209 ZPOOL_CONFIG_PATH))) { 9210 case 0: 9211 fnvlist_add_string(vds, "power_state", 9212 "off"); 9213 break; 9214 case 1: 9215 fnvlist_add_string(vds, "power_state", 9216 "on"); 9217 break; 9218 default: 9219 fnvlist_add_string(vds, "power_state", 9220 "-"); 9221 } 9222 } else { 9223 fnvlist_add_string(vds, "power_state", "-"); 9224 } 9225 } 9226 } 9227 9228 if (cb->cb_print_dio_verify) { 9229 nice_num_str_nvlist(vds, "dio_verify_errors", 9230 vs->vs_dio_verify_errors, cb->cb_literal, 9231 cb->cb_json_as_int, ZFS_NICENUM_1024); 9232 } 9233 9234 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NOT_PRESENT, 9235 ¬present) == 0) { 9236 nice_num_str_nvlist(vds, ZPOOL_CONFIG_NOT_PRESENT, 9237 1, B_TRUE, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9238 fnvlist_add_string(vds, "was", 9239 fnvlist_lookup_string(nv, ZPOOL_CONFIG_PATH)); 9240 } else if (vs->vs_aux != VDEV_AUX_NONE) { 9241 fnvlist_add_string(vds, "aux", vdev_aux_str[vs->vs_aux]); 9242 } else if (children == 0 && !isspare && 9243 getenv("ZPOOL_STATUS_NON_NATIVE_ASHIFT_IGNORE") == NULL && 9244 VDEV_STAT_VALID(vs_physical_ashift, vsc) && 9245 vs->vs_configured_ashift < vs->vs_physical_ashift) { 9246 nice_num_str_nvlist(vds, "configured_ashift", 9247 vs->vs_configured_ashift, B_TRUE, cb->cb_json_as_int, 9248 ZFS_NICENUM_1024); 9249 nice_num_str_nvlist(vds, "physical_ashift", 9250 vs->vs_physical_ashift, B_TRUE, cb->cb_json_as_int, 9251 ZFS_NICENUM_1024); 9252 } 9253 if (vs->vs_scan_removing != 0) { 9254 nice_num_str_nvlist(vds, "removing", vs->vs_scan_removing, 9255 B_TRUE, cb->cb_json_as_int, ZFS_NICENUM_1024); 9256 } else if (VDEV_STAT_VALID(vs_noalloc, vsc) && vs->vs_noalloc != 0) { 9257 nice_num_str_nvlist(vds, "noalloc", vs->vs_noalloc, 9258 B_TRUE, cb->cb_json_as_int, ZFS_NICENUM_1024); 9259 } 9260 9261 if (cb->vcdl != NULL) { 9262 if (nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0) { 9263 zpool_nvlist_cmd(cb->vcdl, zpool_get_name(zhp), 9264 path, vds); 9265 } 9266 } 9267 9268 if (children == 0) { 9269 if (cb->cb_print_vdev_init) { 9270 if (vs->vs_initialize_state != 0) { 9271 uint64_t st = vs->vs_initialize_state; 9272 fnvlist_add_string(vds, "init_state", 9273 vdev_init_state_str[st]); 9274 nice_num_str_nvlist(vds, "initialized", 9275 vs->vs_initialize_bytes_done, 9276 cb->cb_literal, cb->cb_json_as_int, 9277 ZFS_NICENUM_BYTES); 9278 nice_num_str_nvlist(vds, "to_initialize", 9279 vs->vs_initialize_bytes_est, 9280 cb->cb_literal, cb->cb_json_as_int, 9281 ZFS_NICENUM_BYTES); 9282 nice_num_str_nvlist(vds, "init_time", 9283 vs->vs_initialize_action_time, 9284 cb->cb_literal, cb->cb_json_as_int, 9285 ZFS_NICE_TIMESTAMP); 9286 nice_num_str_nvlist(vds, "init_errors", 9287 vs->vs_initialize_errors, 9288 cb->cb_literal, cb->cb_json_as_int, 9289 ZFS_NICENUM_1024); 9290 } else { 9291 fnvlist_add_string(vds, "init_state", 9292 "UNINITIALIZED"); 9293 } 9294 } 9295 if (cb->cb_print_vdev_trim) { 9296 if (vs->vs_trim_notsup == 0) { 9297 if (vs->vs_trim_state != 0) { 9298 uint64_t st = vs->vs_trim_state; 9299 fnvlist_add_string(vds, "trim_state", 9300 vdev_trim_state_str[st]); 9301 nice_num_str_nvlist(vds, "trimmed", 9302 vs->vs_trim_bytes_done, 9303 cb->cb_literal, cb->cb_json_as_int, 9304 ZFS_NICENUM_BYTES); 9305 nice_num_str_nvlist(vds, "to_trim", 9306 vs->vs_trim_bytes_est, 9307 cb->cb_literal, cb->cb_json_as_int, 9308 ZFS_NICENUM_BYTES); 9309 nice_num_str_nvlist(vds, "trim_time", 9310 vs->vs_trim_action_time, 9311 cb->cb_literal, cb->cb_json_as_int, 9312 ZFS_NICE_TIMESTAMP); 9313 nice_num_str_nvlist(vds, "trim_errors", 9314 vs->vs_trim_errors, 9315 cb->cb_literal, cb->cb_json_as_int, 9316 ZFS_NICENUM_1024); 9317 } else 9318 fnvlist_add_string(vds, "trim_state", 9319 "UNTRIMMED"); 9320 } 9321 nice_num_str_nvlist(vds, "trim_notsup", 9322 vs->vs_trim_notsup, B_TRUE, 9323 cb->cb_json_as_int, ZFS_NICENUM_1024); 9324 } 9325 } else { 9326 ch = fnvlist_alloc(); 9327 } 9328 9329 if (cb->cb_flat_vdevs && children == 0) { 9330 fnvlist_add_nvlist(item, vname, vds); 9331 } 9332 9333 for (int c = 0; c < children; c++) { 9334 uint64_t islog = B_FALSE, ishole = B_FALSE; 9335 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG, 9336 &islog); 9337 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_HOLE, 9338 &ishole); 9339 if (islog || ishole) 9340 continue; 9341 if (nvlist_exists(child[c], ZPOOL_CONFIG_ALLOCATION_BIAS)) 9342 continue; 9343 if (cb->cb_flat_vdevs) { 9344 vdev_stats_nvlist(zhp, cb, child[c], depth + 2, isspare, 9345 vname, item); 9346 } 9347 vdev_stats_nvlist(zhp, cb, child[c], depth + 2, isspare, 9348 vname, ch); 9349 } 9350 9351 if (ch != NULL) { 9352 if (!nvlist_empty(ch)) 9353 fnvlist_add_nvlist(vds, "vdevs", ch); 9354 fnvlist_free(ch); 9355 } 9356 fnvlist_add_nvlist(item, vname, vds); 9357 fnvlist_free(vds); 9358 free(vname); 9359 } 9360 9361 static void 9362 class_vdevs_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t *nv, 9363 const char *class, nvlist_t *item) 9364 { 9365 uint_t c, children; 9366 nvlist_t **child; 9367 nvlist_t *class_obj = NULL; 9368 9369 if (!cb->cb_flat_vdevs) 9370 class_obj = fnvlist_alloc(); 9371 9372 assert(zhp != NULL || !cb->cb_verbose); 9373 9374 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, &child, 9375 &children) != 0) 9376 return; 9377 9378 for (c = 0; c < children; c++) { 9379 uint64_t is_log = B_FALSE; 9380 const char *bias = NULL; 9381 const char *type = NULL; 9382 char *name = zpool_vdev_name(g_zfs, zhp, child[c], 9383 cb->cb_name_flags | VDEV_NAME_TYPE_ID); 9384 9385 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG, 9386 &is_log); 9387 9388 if (is_log) { 9389 bias = (char *)VDEV_ALLOC_CLASS_LOGS; 9390 } else { 9391 (void) nvlist_lookup_string(child[c], 9392 ZPOOL_CONFIG_ALLOCATION_BIAS, &bias); 9393 (void) nvlist_lookup_string(child[c], 9394 ZPOOL_CONFIG_TYPE, &type); 9395 } 9396 9397 if (bias == NULL || strcmp(bias, class) != 0) 9398 continue; 9399 if (!is_log && strcmp(type, VDEV_TYPE_INDIRECT) == 0) 9400 continue; 9401 9402 if (cb->cb_flat_vdevs) { 9403 vdev_stats_nvlist(zhp, cb, child[c], 2, B_FALSE, 9404 NULL, item); 9405 } else { 9406 vdev_stats_nvlist(zhp, cb, child[c], 2, B_FALSE, 9407 NULL, class_obj); 9408 } 9409 free(name); 9410 } 9411 if (!cb->cb_flat_vdevs) { 9412 if (!nvlist_empty(class_obj)) 9413 fnvlist_add_nvlist(item, class, class_obj); 9414 fnvlist_free(class_obj); 9415 } 9416 } 9417 9418 static void 9419 l2cache_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t *nv, 9420 nvlist_t *item) 9421 { 9422 nvlist_t *l2c = NULL, **l2cache; 9423 uint_t nl2cache; 9424 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE, 9425 &l2cache, &nl2cache) == 0) { 9426 if (nl2cache == 0) 9427 return; 9428 if (!cb->cb_flat_vdevs) 9429 l2c = fnvlist_alloc(); 9430 for (int i = 0; i < nl2cache; i++) { 9431 if (cb->cb_flat_vdevs) { 9432 vdev_stats_nvlist(zhp, cb, l2cache[i], 2, 9433 B_FALSE, NULL, item); 9434 } else { 9435 vdev_stats_nvlist(zhp, cb, l2cache[i], 2, 9436 B_FALSE, NULL, l2c); 9437 } 9438 } 9439 } 9440 if (!cb->cb_flat_vdevs) { 9441 if (!nvlist_empty(l2c)) 9442 fnvlist_add_nvlist(item, "l2cache", l2c); 9443 fnvlist_free(l2c); 9444 } 9445 } 9446 9447 static void 9448 spares_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t *nv, 9449 nvlist_t *item) 9450 { 9451 nvlist_t *sp = NULL, **spares; 9452 uint_t nspares; 9453 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_SPARES, 9454 &spares, &nspares) == 0) { 9455 if (nspares == 0) 9456 return; 9457 if (!cb->cb_flat_vdevs) 9458 sp = fnvlist_alloc(); 9459 for (int i = 0; i < nspares; i++) { 9460 if (cb->cb_flat_vdevs) { 9461 vdev_stats_nvlist(zhp, cb, spares[i], 2, B_TRUE, 9462 NULL, item); 9463 } else { 9464 vdev_stats_nvlist(zhp, cb, spares[i], 2, B_TRUE, 9465 NULL, sp); 9466 } 9467 } 9468 } 9469 if (!cb->cb_flat_vdevs) { 9470 if (!nvlist_empty(sp)) 9471 fnvlist_add_nvlist(item, "spares", sp); 9472 fnvlist_free(sp); 9473 } 9474 } 9475 9476 static void 9477 errors_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t *item) 9478 { 9479 uint64_t nerr; 9480 nvlist_t *config = zpool_get_config(zhp, NULL); 9481 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_ERRCOUNT, 9482 &nerr) == 0) { 9483 nice_num_str_nvlist(item, ZPOOL_CONFIG_ERRCOUNT, nerr, 9484 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9485 if (nerr != 0 && cb->cb_verbose) { 9486 nvlist_t *nverrlist = NULL; 9487 if (zpool_get_errlog(zhp, &nverrlist) == 0) { 9488 int i = 0; 9489 int count = 0; 9490 size_t len = MAXPATHLEN * 2; 9491 nvpair_t *elem = NULL; 9492 9493 for (nvpair_t *pair = 9494 nvlist_next_nvpair(nverrlist, NULL); 9495 pair != NULL; 9496 pair = nvlist_next_nvpair(nverrlist, pair)) 9497 count++; 9498 char **errl = (char **)malloc( 9499 count * sizeof (char *)); 9500 9501 while ((elem = nvlist_next_nvpair(nverrlist, 9502 elem)) != NULL) { 9503 nvlist_t *nv; 9504 uint64_t dsobj, obj; 9505 9506 verify(nvpair_value_nvlist(elem, 9507 &nv) == 0); 9508 verify(nvlist_lookup_uint64(nv, 9509 ZPOOL_ERR_DATASET, &dsobj) == 0); 9510 verify(nvlist_lookup_uint64(nv, 9511 ZPOOL_ERR_OBJECT, &obj) == 0); 9512 errl[i] = safe_malloc(len); 9513 zpool_obj_to_path(zhp, dsobj, obj, 9514 errl[i++], len); 9515 } 9516 nvlist_free(nverrlist); 9517 fnvlist_add_string_array(item, "errlist", 9518 (const char **)errl, count); 9519 for (int i = 0; i < count; ++i) 9520 free(errl[i]); 9521 free(errl); 9522 } else 9523 fnvlist_add_string(item, "errlist", 9524 strerror(errno)); 9525 } 9526 } 9527 } 9528 9529 static void 9530 ddt_stats_nvlist(ddt_stat_t *dds, status_cbdata_t *cb, nvlist_t *item) 9531 { 9532 nice_num_str_nvlist(item, "blocks", dds->dds_blocks, 9533 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9534 nice_num_str_nvlist(item, "logical_size", dds->dds_lsize, 9535 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9536 nice_num_str_nvlist(item, "physical_size", dds->dds_psize, 9537 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9538 nice_num_str_nvlist(item, "deflated_size", dds->dds_dsize, 9539 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9540 nice_num_str_nvlist(item, "ref_blocks", dds->dds_ref_blocks, 9541 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9542 nice_num_str_nvlist(item, "ref_lsize", dds->dds_ref_lsize, 9543 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9544 nice_num_str_nvlist(item, "ref_psize", dds->dds_ref_psize, 9545 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9546 nice_num_str_nvlist(item, "ref_dsize", dds->dds_ref_dsize, 9547 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9548 } 9549 9550 static void 9551 dedup_stats_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t *item) 9552 { 9553 nvlist_t *config; 9554 if (cb->cb_dedup_stats) { 9555 ddt_histogram_t *ddh; 9556 ddt_stat_t *dds; 9557 ddt_object_t *ddo; 9558 nvlist_t *ddt_stat, *ddt_obj, *dedup; 9559 uint_t c; 9560 uint64_t cspace_prop; 9561 9562 config = zpool_get_config(zhp, NULL); 9563 if (nvlist_lookup_uint64_array(config, 9564 ZPOOL_CONFIG_DDT_OBJ_STATS, (uint64_t **)&ddo, &c) != 0) 9565 return; 9566 9567 dedup = fnvlist_alloc(); 9568 ddt_obj = fnvlist_alloc(); 9569 nice_num_str_nvlist(dedup, "obj_count", ddo->ddo_count, 9570 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9571 if (ddo->ddo_count == 0) { 9572 fnvlist_add_nvlist(dedup, ZPOOL_CONFIG_DDT_OBJ_STATS, 9573 ddt_obj); 9574 fnvlist_add_nvlist(item, "dedup_stats", dedup); 9575 fnvlist_free(ddt_obj); 9576 fnvlist_free(dedup); 9577 return; 9578 } else { 9579 nice_num_str_nvlist(dedup, "dspace", ddo->ddo_dspace, 9580 cb->cb_literal, cb->cb_json_as_int, 9581 ZFS_NICENUM_1024); 9582 nice_num_str_nvlist(dedup, "mspace", ddo->ddo_mspace, 9583 cb->cb_literal, cb->cb_json_as_int, 9584 ZFS_NICENUM_1024); 9585 /* 9586 * Squash cached size into in-core size to handle race. 9587 * Only include cached size if it is available. 9588 */ 9589 cspace_prop = zpool_get_prop_int(zhp, 9590 ZPOOL_PROP_DEDUPCACHED, NULL); 9591 cspace_prop = MIN(cspace_prop, ddo->ddo_mspace); 9592 nice_num_str_nvlist(dedup, "cspace", cspace_prop, 9593 cb->cb_literal, cb->cb_json_as_int, 9594 ZFS_NICENUM_1024); 9595 } 9596 9597 ddt_stat = fnvlist_alloc(); 9598 if (nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_STATS, 9599 (uint64_t **)&dds, &c) == 0) { 9600 nvlist_t *total = fnvlist_alloc(); 9601 if (dds->dds_blocks == 0) 9602 fnvlist_add_string(total, "blocks", "0"); 9603 else 9604 ddt_stats_nvlist(dds, cb, total); 9605 fnvlist_add_nvlist(ddt_stat, "total", total); 9606 fnvlist_free(total); 9607 } 9608 if (nvlist_lookup_uint64_array(config, 9609 ZPOOL_CONFIG_DDT_HISTOGRAM, (uint64_t **)&ddh, &c) == 0) { 9610 nvlist_t *hist = fnvlist_alloc(); 9611 nvlist_t *entry = NULL; 9612 char buf[16]; 9613 for (int h = 0; h < 64; h++) { 9614 if (ddh->ddh_stat[h].dds_blocks != 0) { 9615 entry = fnvlist_alloc(); 9616 ddt_stats_nvlist(&ddh->ddh_stat[h], cb, 9617 entry); 9618 snprintf(buf, 16, "%d", h); 9619 fnvlist_add_nvlist(hist, buf, entry); 9620 fnvlist_free(entry); 9621 } 9622 } 9623 if (!nvlist_empty(hist)) 9624 fnvlist_add_nvlist(ddt_stat, "histogram", hist); 9625 fnvlist_free(hist); 9626 } 9627 9628 if (!nvlist_empty(ddt_obj)) { 9629 fnvlist_add_nvlist(dedup, ZPOOL_CONFIG_DDT_OBJ_STATS, 9630 ddt_obj); 9631 } 9632 fnvlist_free(ddt_obj); 9633 if (!nvlist_empty(ddt_stat)) { 9634 fnvlist_add_nvlist(dedup, ZPOOL_CONFIG_DDT_STATS, 9635 ddt_stat); 9636 } 9637 fnvlist_free(ddt_stat); 9638 if (!nvlist_empty(dedup)) 9639 fnvlist_add_nvlist(item, "dedup_stats", dedup); 9640 fnvlist_free(dedup); 9641 } 9642 } 9643 9644 static void 9645 raidz_expand_status_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, 9646 nvlist_t *nvroot, nvlist_t *item) 9647 { 9648 uint_t c; 9649 pool_raidz_expand_stat_t *pres = NULL; 9650 if (nvlist_lookup_uint64_array(nvroot, 9651 ZPOOL_CONFIG_RAIDZ_EXPAND_STATS, (uint64_t **)&pres, &c) == 0) { 9652 nvlist_t **child; 9653 uint_t children; 9654 nvlist_t *nv = fnvlist_alloc(); 9655 verify(nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN, 9656 &child, &children) == 0); 9657 assert(pres->pres_expanding_vdev < children); 9658 char *name = 9659 zpool_vdev_name(g_zfs, zhp, 9660 child[pres->pres_expanding_vdev], 0); 9661 fill_vdev_info(nv, zhp, name, B_FALSE, cb->cb_json_as_int); 9662 fnvlist_add_string(nv, "state", 9663 pool_scan_state_str[pres->pres_state]); 9664 nice_num_str_nvlist(nv, "expanding_vdev", 9665 pres->pres_expanding_vdev, B_TRUE, cb->cb_json_as_int, 9666 ZFS_NICENUM_1024); 9667 nice_num_str_nvlist(nv, "start_time", pres->pres_start_time, 9668 cb->cb_literal, cb->cb_json_as_int, ZFS_NICE_TIMESTAMP); 9669 nice_num_str_nvlist(nv, "end_time", pres->pres_end_time, 9670 cb->cb_literal, cb->cb_json_as_int, ZFS_NICE_TIMESTAMP); 9671 nice_num_str_nvlist(nv, "to_reflow", pres->pres_to_reflow, 9672 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9673 nice_num_str_nvlist(nv, "reflowed", pres->pres_reflowed, 9674 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9675 nice_num_str_nvlist(nv, "waiting_for_resilver", 9676 pres->pres_waiting_for_resilver, B_TRUE, 9677 cb->cb_json_as_int, ZFS_NICENUM_1024); 9678 fnvlist_add_nvlist(item, ZPOOL_CONFIG_RAIDZ_EXPAND_STATS, nv); 9679 fnvlist_free(nv); 9680 free(name); 9681 } 9682 } 9683 9684 static void 9685 checkpoint_status_nvlist(nvlist_t *nvroot, status_cbdata_t *cb, 9686 nvlist_t *item) 9687 { 9688 uint_t c; 9689 pool_checkpoint_stat_t *pcs = NULL; 9690 if (nvlist_lookup_uint64_array(nvroot, 9691 ZPOOL_CONFIG_CHECKPOINT_STATS, (uint64_t **)&pcs, &c) == 0) { 9692 nvlist_t *nv = fnvlist_alloc(); 9693 fnvlist_add_string(nv, "state", 9694 checkpoint_state_str[pcs->pcs_state]); 9695 nice_num_str_nvlist(nv, "start_time", 9696 pcs->pcs_start_time, cb->cb_literal, cb->cb_json_as_int, 9697 ZFS_NICE_TIMESTAMP); 9698 nice_num_str_nvlist(nv, "space", 9699 pcs->pcs_space, cb->cb_literal, cb->cb_json_as_int, 9700 ZFS_NICENUM_BYTES); 9701 fnvlist_add_nvlist(item, ZPOOL_CONFIG_CHECKPOINT_STATS, nv); 9702 fnvlist_free(nv); 9703 } 9704 } 9705 9706 static void 9707 removal_status_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, 9708 nvlist_t *nvroot, nvlist_t *item) 9709 { 9710 uint_t c; 9711 pool_removal_stat_t *prs = NULL; 9712 if (nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_REMOVAL_STATS, 9713 (uint64_t **)&prs, &c) == 0) { 9714 if (prs->prs_state != DSS_NONE) { 9715 nvlist_t **child; 9716 uint_t children; 9717 verify(nvlist_lookup_nvlist_array(nvroot, 9718 ZPOOL_CONFIG_CHILDREN, &child, &children) == 0); 9719 assert(prs->prs_removing_vdev < children); 9720 char *vdev_name = zpool_vdev_name(g_zfs, zhp, 9721 child[prs->prs_removing_vdev], B_TRUE); 9722 nvlist_t *nv = fnvlist_alloc(); 9723 fill_vdev_info(nv, zhp, vdev_name, B_FALSE, 9724 cb->cb_json_as_int); 9725 fnvlist_add_string(nv, "state", 9726 pool_scan_state_str[prs->prs_state]); 9727 nice_num_str_nvlist(nv, "removing_vdev", 9728 prs->prs_removing_vdev, B_TRUE, cb->cb_json_as_int, 9729 ZFS_NICENUM_1024); 9730 nice_num_str_nvlist(nv, "start_time", 9731 prs->prs_start_time, cb->cb_literal, 9732 cb->cb_json_as_int, ZFS_NICE_TIMESTAMP); 9733 nice_num_str_nvlist(nv, "end_time", prs->prs_end_time, 9734 cb->cb_literal, cb->cb_json_as_int, 9735 ZFS_NICE_TIMESTAMP); 9736 nice_num_str_nvlist(nv, "to_copy", prs->prs_to_copy, 9737 cb->cb_literal, cb->cb_json_as_int, 9738 ZFS_NICENUM_BYTES); 9739 nice_num_str_nvlist(nv, "copied", prs->prs_copied, 9740 cb->cb_literal, cb->cb_json_as_int, 9741 ZFS_NICENUM_BYTES); 9742 nice_num_str_nvlist(nv, "mapping_memory", 9743 prs->prs_mapping_memory, cb->cb_literal, 9744 cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9745 fnvlist_add_nvlist(item, 9746 ZPOOL_CONFIG_REMOVAL_STATS, nv); 9747 fnvlist_free(nv); 9748 free(vdev_name); 9749 } 9750 } 9751 } 9752 9753 static void 9754 scan_status_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, 9755 nvlist_t *nvroot, nvlist_t *item) 9756 { 9757 pool_scan_stat_t *ps = NULL; 9758 uint_t c; 9759 nvlist_t *scan = fnvlist_alloc(); 9760 nvlist_t **child; 9761 uint_t children; 9762 9763 if (nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_SCAN_STATS, 9764 (uint64_t **)&ps, &c) == 0) { 9765 fnvlist_add_string(scan, "function", 9766 pool_scan_func_str[ps->pss_func]); 9767 fnvlist_add_string(scan, "state", 9768 pool_scan_state_str[ps->pss_state]); 9769 nice_num_str_nvlist(scan, "start_time", ps->pss_start_time, 9770 cb->cb_literal, cb->cb_json_as_int, ZFS_NICE_TIMESTAMP); 9771 nice_num_str_nvlist(scan, "end_time", ps->pss_end_time, 9772 cb->cb_literal, cb->cb_json_as_int, ZFS_NICE_TIMESTAMP); 9773 nice_num_str_nvlist(scan, "to_examine", ps->pss_to_examine, 9774 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9775 nice_num_str_nvlist(scan, "examined", ps->pss_examined, 9776 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9777 nice_num_str_nvlist(scan, "skipped", ps->pss_skipped, 9778 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9779 nice_num_str_nvlist(scan, "processed", ps->pss_processed, 9780 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9781 nice_num_str_nvlist(scan, "errors", ps->pss_errors, 9782 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9783 nice_num_str_nvlist(scan, "bytes_per_scan", ps->pss_pass_exam, 9784 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9785 nice_num_str_nvlist(scan, "pass_start", ps->pss_pass_start, 9786 B_TRUE, cb->cb_json_as_int, ZFS_NICENUM_1024); 9787 nice_num_str_nvlist(scan, "scrub_pause", 9788 ps->pss_pass_scrub_pause, cb->cb_literal, 9789 cb->cb_json_as_int, ZFS_NICE_TIMESTAMP); 9790 nice_num_str_nvlist(scan, "scrub_spent_paused", 9791 ps->pss_pass_scrub_spent_paused, 9792 B_TRUE, cb->cb_json_as_int, ZFS_NICENUM_1024); 9793 nice_num_str_nvlist(scan, "issued_bytes_per_scan", 9794 ps->pss_pass_issued, cb->cb_literal, 9795 cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9796 nice_num_str_nvlist(scan, "issued", ps->pss_issued, 9797 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9798 if (ps->pss_error_scrub_func == POOL_SCAN_ERRORSCRUB && 9799 ps->pss_error_scrub_start > ps->pss_start_time) { 9800 fnvlist_add_string(scan, "err_scrub_func", 9801 pool_scan_func_str[ps->pss_error_scrub_func]); 9802 fnvlist_add_string(scan, "err_scrub_state", 9803 pool_scan_state_str[ps->pss_error_scrub_state]); 9804 nice_num_str_nvlist(scan, "err_scrub_start_time", 9805 ps->pss_error_scrub_start, 9806 cb->cb_literal, cb->cb_json_as_int, 9807 ZFS_NICE_TIMESTAMP); 9808 nice_num_str_nvlist(scan, "err_scrub_end_time", 9809 ps->pss_error_scrub_end, 9810 cb->cb_literal, cb->cb_json_as_int, 9811 ZFS_NICE_TIMESTAMP); 9812 nice_num_str_nvlist(scan, "err_scrub_examined", 9813 ps->pss_error_scrub_examined, 9814 cb->cb_literal, cb->cb_json_as_int, 9815 ZFS_NICENUM_1024); 9816 nice_num_str_nvlist(scan, "err_scrub_to_examine", 9817 ps->pss_error_scrub_to_be_examined, 9818 cb->cb_literal, cb->cb_json_as_int, 9819 ZFS_NICENUM_1024); 9820 nice_num_str_nvlist(scan, "err_scrub_pause", 9821 ps->pss_pass_error_scrub_pause, 9822 B_TRUE, cb->cb_json_as_int, ZFS_NICENUM_1024); 9823 } 9824 } 9825 9826 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN, 9827 &child, &children) == 0) { 9828 vdev_rebuild_stat_t *vrs; 9829 uint_t i; 9830 char *name; 9831 nvlist_t *nv; 9832 nvlist_t *rebuild = fnvlist_alloc(); 9833 uint64_t st; 9834 for (uint_t c = 0; c < children; c++) { 9835 if (nvlist_lookup_uint64_array(child[c], 9836 ZPOOL_CONFIG_REBUILD_STATS, (uint64_t **)&vrs, 9837 &i) == 0) { 9838 if (vrs->vrs_state != VDEV_REBUILD_NONE) { 9839 nv = fnvlist_alloc(); 9840 name = zpool_vdev_name(g_zfs, zhp, 9841 child[c], VDEV_NAME_TYPE_ID); 9842 fill_vdev_info(nv, zhp, name, B_FALSE, 9843 cb->cb_json_as_int); 9844 st = vrs->vrs_state; 9845 fnvlist_add_string(nv, "state", 9846 vdev_rebuild_state_str[st]); 9847 nice_num_str_nvlist(nv, "start_time", 9848 vrs->vrs_start_time, cb->cb_literal, 9849 cb->cb_json_as_int, 9850 ZFS_NICE_TIMESTAMP); 9851 nice_num_str_nvlist(nv, "end_time", 9852 vrs->vrs_end_time, cb->cb_literal, 9853 cb->cb_json_as_int, 9854 ZFS_NICE_TIMESTAMP); 9855 nice_num_str_nvlist(nv, "scan_time", 9856 vrs->vrs_scan_time_ms * 1000000, 9857 cb->cb_literal, cb->cb_json_as_int, 9858 ZFS_NICENUM_TIME); 9859 nice_num_str_nvlist(nv, "scanned", 9860 vrs->vrs_bytes_scanned, 9861 cb->cb_literal, cb->cb_json_as_int, 9862 ZFS_NICENUM_BYTES); 9863 nice_num_str_nvlist(nv, "issued", 9864 vrs->vrs_bytes_issued, 9865 cb->cb_literal, cb->cb_json_as_int, 9866 ZFS_NICENUM_BYTES); 9867 nice_num_str_nvlist(nv, "rebuilt", 9868 vrs->vrs_bytes_rebuilt, 9869 cb->cb_literal, cb->cb_json_as_int, 9870 ZFS_NICENUM_BYTES); 9871 nice_num_str_nvlist(nv, "to_scan", 9872 vrs->vrs_bytes_est, cb->cb_literal, 9873 cb->cb_json_as_int, 9874 ZFS_NICENUM_BYTES); 9875 nice_num_str_nvlist(nv, "errors", 9876 vrs->vrs_errors, cb->cb_literal, 9877 cb->cb_json_as_int, 9878 ZFS_NICENUM_1024); 9879 nice_num_str_nvlist(nv, "pass_time", 9880 vrs->vrs_pass_time_ms * 1000000, 9881 cb->cb_literal, cb->cb_json_as_int, 9882 ZFS_NICENUM_TIME); 9883 nice_num_str_nvlist(nv, "pass_scanned", 9884 vrs->vrs_pass_bytes_scanned, 9885 cb->cb_literal, cb->cb_json_as_int, 9886 ZFS_NICENUM_BYTES); 9887 nice_num_str_nvlist(nv, "pass_issued", 9888 vrs->vrs_pass_bytes_issued, 9889 cb->cb_literal, cb->cb_json_as_int, 9890 ZFS_NICENUM_BYTES); 9891 nice_num_str_nvlist(nv, "pass_skipped", 9892 vrs->vrs_pass_bytes_skipped, 9893 cb->cb_literal, cb->cb_json_as_int, 9894 ZFS_NICENUM_BYTES); 9895 fnvlist_add_nvlist(rebuild, name, nv); 9896 free(name); 9897 } 9898 } 9899 } 9900 if (!nvlist_empty(rebuild)) 9901 fnvlist_add_nvlist(scan, "rebuild_stats", rebuild); 9902 fnvlist_free(rebuild); 9903 } 9904 9905 if (!nvlist_empty(scan)) 9906 fnvlist_add_nvlist(item, ZPOOL_CONFIG_SCAN_STATS, scan); 9907 fnvlist_free(scan); 9908 } 9909 9910 /* 9911 * Print the scan status. 9912 */ 9913 static void 9914 print_scan_status(zpool_handle_t *zhp, nvlist_t *nvroot) 9915 { 9916 uint64_t rebuild_end_time = 0, resilver_end_time = 0; 9917 boolean_t have_resilver = B_FALSE, have_scrub = B_FALSE; 9918 boolean_t have_errorscrub = B_FALSE; 9919 boolean_t active_resilver = B_FALSE; 9920 pool_checkpoint_stat_t *pcs = NULL; 9921 pool_scan_stat_t *ps = NULL; 9922 uint_t c; 9923 time_t scrub_start = 0, errorscrub_start = 0; 9924 9925 if (nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_SCAN_STATS, 9926 (uint64_t **)&ps, &c) == 0) { 9927 if (ps->pss_func == POOL_SCAN_RESILVER) { 9928 resilver_end_time = ps->pss_end_time; 9929 active_resilver = (ps->pss_state == DSS_SCANNING); 9930 } 9931 9932 have_resilver = (ps->pss_func == POOL_SCAN_RESILVER); 9933 have_scrub = (ps->pss_func == POOL_SCAN_SCRUB); 9934 scrub_start = ps->pss_start_time; 9935 if (c > offsetof(pool_scan_stat_t, 9936 pss_pass_error_scrub_pause) / 8) { 9937 have_errorscrub = (ps->pss_error_scrub_func == 9938 POOL_SCAN_ERRORSCRUB); 9939 errorscrub_start = ps->pss_error_scrub_start; 9940 } 9941 } 9942 9943 boolean_t active_rebuild = check_rebuilding(nvroot, &rebuild_end_time); 9944 boolean_t have_rebuild = (active_rebuild || (rebuild_end_time > 0)); 9945 9946 /* Always print the scrub status when available. */ 9947 if (have_scrub && scrub_start > errorscrub_start) 9948 print_scan_scrub_resilver_status(ps); 9949 else if (have_errorscrub && errorscrub_start >= scrub_start) 9950 print_err_scrub_status(ps); 9951 9952 /* 9953 * When there is an active resilver or rebuild print its status. 9954 * Otherwise print the status of the last resilver or rebuild. 9955 */ 9956 if (active_resilver || (!active_rebuild && have_resilver && 9957 resilver_end_time && resilver_end_time > rebuild_end_time)) { 9958 print_scan_scrub_resilver_status(ps); 9959 } else if (active_rebuild || (!active_resilver && have_rebuild && 9960 rebuild_end_time && rebuild_end_time > resilver_end_time)) { 9961 print_rebuild_status(zhp, nvroot); 9962 } 9963 9964 (void) nvlist_lookup_uint64_array(nvroot, 9965 ZPOOL_CONFIG_CHECKPOINT_STATS, (uint64_t **)&pcs, &c); 9966 print_checkpoint_scan_warning(ps, pcs); 9967 } 9968 9969 /* 9970 * Print out detailed removal status. 9971 */ 9972 static void 9973 print_removal_status(zpool_handle_t *zhp, pool_removal_stat_t *prs) 9974 { 9975 char copied_buf[7], examined_buf[7], total_buf[7], rate_buf[7]; 9976 time_t start, end; 9977 nvlist_t *config, *nvroot; 9978 nvlist_t **child; 9979 uint_t children; 9980 char *vdev_name; 9981 9982 if (prs == NULL || prs->prs_state == DSS_NONE) 9983 return; 9984 9985 /* 9986 * Determine name of vdev. 9987 */ 9988 config = zpool_get_config(zhp, NULL); 9989 nvroot = fnvlist_lookup_nvlist(config, 9990 ZPOOL_CONFIG_VDEV_TREE); 9991 verify(nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN, 9992 &child, &children) == 0); 9993 assert(prs->prs_removing_vdev < children); 9994 vdev_name = zpool_vdev_name(g_zfs, zhp, 9995 child[prs->prs_removing_vdev], B_TRUE); 9996 9997 printf_color(ANSI_BOLD, gettext("remove: ")); 9998 9999 start = prs->prs_start_time; 10000 end = prs->prs_end_time; 10001 zfs_nicenum(prs->prs_copied, copied_buf, sizeof (copied_buf)); 10002 10003 /* 10004 * Removal is finished or canceled. 10005 */ 10006 if (prs->prs_state == DSS_FINISHED) { 10007 uint64_t minutes_taken = (end - start) / 60; 10008 10009 (void) printf(gettext("Removal of vdev %llu copied %s " 10010 "in %lluh%um, completed on %s"), 10011 (longlong_t)prs->prs_removing_vdev, 10012 copied_buf, 10013 (u_longlong_t)(minutes_taken / 60), 10014 (uint_t)(minutes_taken % 60), 10015 ctime((time_t *)&end)); 10016 } else if (prs->prs_state == DSS_CANCELED) { 10017 (void) printf(gettext("Removal of %s canceled on %s"), 10018 vdev_name, ctime(&end)); 10019 } else { 10020 uint64_t copied, total, elapsed, mins_left, hours_left; 10021 double fraction_done; 10022 uint_t rate; 10023 10024 assert(prs->prs_state == DSS_SCANNING); 10025 10026 /* 10027 * Removal is in progress. 10028 */ 10029 (void) printf(gettext( 10030 "Evacuation of %s in progress since %s"), 10031 vdev_name, ctime(&start)); 10032 10033 copied = prs->prs_copied > 0 ? prs->prs_copied : 1; 10034 total = prs->prs_to_copy; 10035 fraction_done = (double)copied / total; 10036 10037 /* elapsed time for this pass */ 10038 elapsed = time(NULL) - prs->prs_start_time; 10039 elapsed = elapsed > 0 ? elapsed : 1; 10040 rate = copied / elapsed; 10041 rate = rate > 0 ? rate : 1; 10042 mins_left = ((total - copied) / rate) / 60; 10043 hours_left = mins_left / 60; 10044 10045 zfs_nicenum(copied, examined_buf, sizeof (examined_buf)); 10046 zfs_nicenum(total, total_buf, sizeof (total_buf)); 10047 zfs_nicenum(rate, rate_buf, sizeof (rate_buf)); 10048 10049 /* 10050 * do not print estimated time if hours_left is more than 10051 * 30 days 10052 */ 10053 (void) printf(gettext( 10054 "\t%s copied out of %s at %s/s, %.2f%% done"), 10055 examined_buf, total_buf, rate_buf, 100 * fraction_done); 10056 if (hours_left < (30 * 24)) { 10057 (void) printf(gettext(", %lluh%um to go\n"), 10058 (u_longlong_t)hours_left, (uint_t)(mins_left % 60)); 10059 } else { 10060 (void) printf(gettext( 10061 ", (copy is slow, no estimated time)\n")); 10062 } 10063 } 10064 free(vdev_name); 10065 10066 if (prs->prs_mapping_memory > 0) { 10067 char mem_buf[7]; 10068 zfs_nicenum(prs->prs_mapping_memory, mem_buf, sizeof (mem_buf)); 10069 (void) printf(gettext( 10070 "\t%s memory used for removed device mappings\n"), 10071 mem_buf); 10072 } 10073 } 10074 10075 /* 10076 * Print out detailed raidz expansion status. 10077 */ 10078 static void 10079 print_raidz_expand_status(zpool_handle_t *zhp, pool_raidz_expand_stat_t *pres) 10080 { 10081 char copied_buf[7]; 10082 10083 if (pres == NULL || pres->pres_state == DSS_NONE) 10084 return; 10085 10086 /* 10087 * Determine name of vdev. 10088 */ 10089 nvlist_t *config = zpool_get_config(zhp, NULL); 10090 nvlist_t *nvroot = fnvlist_lookup_nvlist(config, 10091 ZPOOL_CONFIG_VDEV_TREE); 10092 nvlist_t **child; 10093 uint_t children; 10094 verify(nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN, 10095 &child, &children) == 0); 10096 assert(pres->pres_expanding_vdev < children); 10097 10098 printf_color(ANSI_BOLD, gettext("expand: ")); 10099 10100 time_t start = pres->pres_start_time; 10101 time_t end = pres->pres_end_time; 10102 char *vname = 10103 zpool_vdev_name(g_zfs, zhp, child[pres->pres_expanding_vdev], 0); 10104 zfs_nicenum(pres->pres_reflowed, copied_buf, sizeof (copied_buf)); 10105 10106 /* 10107 * Expansion is finished or canceled. 10108 */ 10109 if (pres->pres_state == DSS_FINISHED) { 10110 char time_buf[32]; 10111 secs_to_dhms(end - start, time_buf); 10112 10113 (void) printf(gettext("expanded %s-%u copied %s in %s, " 10114 "on %s"), vname, (int)pres->pres_expanding_vdev, 10115 copied_buf, time_buf, ctime((time_t *)&end)); 10116 } else { 10117 char examined_buf[7], total_buf[7], rate_buf[7]; 10118 uint64_t copied, total, elapsed, secs_left; 10119 double fraction_done; 10120 uint_t rate; 10121 10122 assert(pres->pres_state == DSS_SCANNING); 10123 10124 /* 10125 * Expansion is in progress. 10126 */ 10127 (void) printf(gettext( 10128 "expansion of %s-%u in progress since %s"), 10129 vname, (int)pres->pres_expanding_vdev, ctime(&start)); 10130 10131 copied = pres->pres_reflowed > 0 ? pres->pres_reflowed : 1; 10132 total = pres->pres_to_reflow; 10133 fraction_done = (double)copied / total; 10134 10135 /* elapsed time for this pass */ 10136 elapsed = time(NULL) - pres->pres_start_time; 10137 elapsed = elapsed > 0 ? elapsed : 1; 10138 rate = copied / elapsed; 10139 rate = rate > 0 ? rate : 1; 10140 secs_left = (total - copied) / rate; 10141 10142 zfs_nicenum(copied, examined_buf, sizeof (examined_buf)); 10143 zfs_nicenum(total, total_buf, sizeof (total_buf)); 10144 zfs_nicenum(rate, rate_buf, sizeof (rate_buf)); 10145 10146 /* 10147 * do not print estimated time if hours_left is more than 10148 * 30 days 10149 */ 10150 (void) printf(gettext("\t%s / %s copied at %s/s, %.2f%% done"), 10151 examined_buf, total_buf, rate_buf, 100 * fraction_done); 10152 if (pres->pres_waiting_for_resilver) { 10153 (void) printf(gettext(", paused for resilver or " 10154 "clear\n")); 10155 } else if (secs_left < (30 * 24 * 3600)) { 10156 char time_buf[32]; 10157 secs_to_dhms(secs_left, time_buf); 10158 (void) printf(gettext(", %s to go\n"), time_buf); 10159 } else { 10160 (void) printf(gettext( 10161 ", (copy is slow, no estimated time)\n")); 10162 } 10163 } 10164 free(vname); 10165 } 10166 static void 10167 print_checkpoint_status(pool_checkpoint_stat_t *pcs) 10168 { 10169 time_t start; 10170 char space_buf[7]; 10171 10172 if (pcs == NULL || pcs->pcs_state == CS_NONE) 10173 return; 10174 10175 (void) printf(gettext("checkpoint: ")); 10176 10177 start = pcs->pcs_start_time; 10178 zfs_nicenum(pcs->pcs_space, space_buf, sizeof (space_buf)); 10179 10180 if (pcs->pcs_state == CS_CHECKPOINT_EXISTS) { 10181 char *date = ctime(&start); 10182 10183 /* 10184 * ctime() adds a newline at the end of the generated 10185 * string, thus the weird format specifier and the 10186 * strlen() call used to chop it off from the output. 10187 */ 10188 (void) printf(gettext("created %.*s, consumes %s\n"), 10189 (int)(strlen(date) - 1), date, space_buf); 10190 return; 10191 } 10192 10193 assert(pcs->pcs_state == CS_CHECKPOINT_DISCARDING); 10194 10195 (void) printf(gettext("discarding, %s remaining.\n"), 10196 space_buf); 10197 } 10198 10199 static void 10200 print_error_log(zpool_handle_t *zhp) 10201 { 10202 nvlist_t *nverrlist = NULL; 10203 nvpair_t *elem; 10204 char *pathname; 10205 size_t len = MAXPATHLEN * 2; 10206 10207 if (zpool_get_errlog(zhp, &nverrlist) != 0) 10208 return; 10209 10210 (void) printf("errors: Permanent errors have been " 10211 "detected in the following files:\n\n"); 10212 10213 pathname = safe_malloc(len); 10214 elem = NULL; 10215 while ((elem = nvlist_next_nvpair(nverrlist, elem)) != NULL) { 10216 nvlist_t *nv; 10217 uint64_t dsobj, obj; 10218 10219 verify(nvpair_value_nvlist(elem, &nv) == 0); 10220 verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_DATASET, 10221 &dsobj) == 0); 10222 verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_OBJECT, 10223 &obj) == 0); 10224 zpool_obj_to_path(zhp, dsobj, obj, pathname, len); 10225 (void) printf("%7s %s\n", "", pathname); 10226 } 10227 free(pathname); 10228 nvlist_free(nverrlist); 10229 } 10230 10231 static void 10232 print_spares(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t **spares, 10233 uint_t nspares) 10234 { 10235 uint_t i; 10236 char *name; 10237 10238 if (nspares == 0) 10239 return; 10240 10241 (void) printf(gettext("\tspares\n")); 10242 10243 for (i = 0; i < nspares; i++) { 10244 name = zpool_vdev_name(g_zfs, zhp, spares[i], 10245 cb->cb_name_flags); 10246 print_status_config(zhp, cb, name, spares[i], 2, B_TRUE, NULL); 10247 free(name); 10248 } 10249 } 10250 10251 static void 10252 print_l2cache(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t **l2cache, 10253 uint_t nl2cache) 10254 { 10255 uint_t i; 10256 char *name; 10257 10258 if (nl2cache == 0) 10259 return; 10260 10261 (void) printf(gettext("\tcache\n")); 10262 10263 for (i = 0; i < nl2cache; i++) { 10264 name = zpool_vdev_name(g_zfs, zhp, l2cache[i], 10265 cb->cb_name_flags); 10266 print_status_config(zhp, cb, name, l2cache[i], 2, 10267 B_FALSE, NULL); 10268 free(name); 10269 } 10270 } 10271 10272 static void 10273 print_dedup_stats(zpool_handle_t *zhp, nvlist_t *config, boolean_t literal) 10274 { 10275 ddt_histogram_t *ddh; 10276 ddt_stat_t *dds; 10277 ddt_object_t *ddo; 10278 uint_t c; 10279 /* Extra space provided for literal display */ 10280 char dspace[32], mspace[32], cspace[32]; 10281 uint64_t cspace_prop; 10282 enum zfs_nicenum_format format; 10283 zprop_source_t src; 10284 10285 /* 10286 * If the pool was faulted then we may not have been able to 10287 * obtain the config. Otherwise, if we have anything in the dedup 10288 * table continue processing the stats. 10289 */ 10290 if (nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_OBJ_STATS, 10291 (uint64_t **)&ddo, &c) != 0) 10292 return; 10293 10294 (void) printf("\n"); 10295 (void) printf(gettext(" dedup: ")); 10296 if (ddo->ddo_count == 0) { 10297 (void) printf(gettext("no DDT entries\n")); 10298 return; 10299 } 10300 10301 /* 10302 * Squash cached size into in-core size to handle race. 10303 * Only include cached size if it is available. 10304 */ 10305 cspace_prop = zpool_get_prop_int(zhp, ZPOOL_PROP_DEDUPCACHED, &src); 10306 cspace_prop = MIN(cspace_prop, ddo->ddo_mspace); 10307 format = literal ? ZFS_NICENUM_RAW : ZFS_NICENUM_1024; 10308 zfs_nicenum_format(cspace_prop, cspace, sizeof (cspace), format); 10309 zfs_nicenum_format(ddo->ddo_dspace, dspace, sizeof (dspace), format); 10310 zfs_nicenum_format(ddo->ddo_mspace, mspace, sizeof (mspace), format); 10311 (void) printf("DDT entries %llu, size %s on disk, %s in core", 10312 (u_longlong_t)ddo->ddo_count, 10313 dspace, 10314 mspace); 10315 if (src != ZPROP_SRC_DEFAULT) { 10316 (void) printf(", %s cached (%.02f%%)", 10317 cspace, 10318 (double)cspace_prop / (double)ddo->ddo_mspace * 100.0); 10319 } 10320 (void) printf("\n"); 10321 10322 verify(nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_STATS, 10323 (uint64_t **)&dds, &c) == 0); 10324 verify(nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_HISTOGRAM, 10325 (uint64_t **)&ddh, &c) == 0); 10326 zpool_dump_ddt(dds, ddh); 10327 } 10328 10329 #define ST_SIZE 4096 10330 #define AC_SIZE 2048 10331 10332 static void 10333 print_status_reason(zpool_handle_t *zhp, status_cbdata_t *cbp, 10334 zpool_status_t reason, zpool_errata_t errata, nvlist_t *item) 10335 { 10336 char status[ST_SIZE]; 10337 char action[AC_SIZE]; 10338 memset(status, 0, ST_SIZE); 10339 memset(action, 0, AC_SIZE); 10340 10341 switch (reason) { 10342 case ZPOOL_STATUS_MISSING_DEV_R: 10343 snprintf(status, ST_SIZE, gettext("One or more devices could " 10344 "not be opened. Sufficient replicas exist for\n\tthe pool " 10345 "to continue functioning in a degraded state.\n")); 10346 snprintf(action, AC_SIZE, gettext("Attach the missing device " 10347 "and online it using 'zpool online'.\n")); 10348 break; 10349 10350 case ZPOOL_STATUS_MISSING_DEV_NR: 10351 snprintf(status, ST_SIZE, gettext("One or more devices could " 10352 "not be opened. There are insufficient\n\treplicas for the" 10353 " pool to continue functioning.\n")); 10354 snprintf(action, AC_SIZE, gettext("Attach the missing device " 10355 "and online it using 'zpool online'.\n")); 10356 break; 10357 10358 case ZPOOL_STATUS_CORRUPT_LABEL_R: 10359 snprintf(status, ST_SIZE, gettext("One or more devices could " 10360 "not be used because the label is missing or\n\tinvalid. " 10361 "Sufficient replicas exist for the pool to continue\n\t" 10362 "functioning in a degraded state.\n")); 10363 snprintf(action, AC_SIZE, gettext("Replace the device using " 10364 "'zpool replace'.\n")); 10365 break; 10366 10367 case ZPOOL_STATUS_CORRUPT_LABEL_NR: 10368 snprintf(status, ST_SIZE, gettext("One or more devices could " 10369 "not be used because the label is missing \n\tor invalid. " 10370 "There are insufficient replicas for the pool to " 10371 "continue\n\tfunctioning.\n")); 10372 zpool_explain_recover(zpool_get_handle(zhp), 10373 zpool_get_name(zhp), reason, zpool_get_config(zhp, NULL), 10374 action, AC_SIZE); 10375 break; 10376 10377 case ZPOOL_STATUS_FAILING_DEV: 10378 snprintf(status, ST_SIZE, gettext("One or more devices has " 10379 "experienced an unrecoverable error. An\n\tattempt was " 10380 "made to correct the error. Applications are " 10381 "unaffected.\n")); 10382 snprintf(action, AC_SIZE, gettext("Determine if the " 10383 "device needs to be replaced, and clear the errors\n\tusing" 10384 " 'zpool clear' or replace the device with 'zpool " 10385 "replace'.\n")); 10386 break; 10387 10388 case ZPOOL_STATUS_OFFLINE_DEV: 10389 snprintf(status, ST_SIZE, gettext("One or more devices has " 10390 "been taken offline by the administrator.\n\tSufficient " 10391 "replicas exist for the pool to continue functioning in " 10392 "a\n\tdegraded state.\n")); 10393 snprintf(action, AC_SIZE, gettext("Online the device " 10394 "using 'zpool online' or replace the device with\n\t'zpool " 10395 "replace'.\n")); 10396 break; 10397 10398 case ZPOOL_STATUS_REMOVED_DEV: 10399 snprintf(status, ST_SIZE, gettext("One or more devices has " 10400 "been removed by the administrator.\n\tSufficient " 10401 "replicas exist for the pool to continue functioning in " 10402 "a\n\tdegraded state.\n")); 10403 snprintf(action, AC_SIZE, gettext("Online the device " 10404 "using zpool online' or replace the device with\n\t'zpool " 10405 "replace'.\n")); 10406 break; 10407 10408 case ZPOOL_STATUS_RESILVERING: 10409 case ZPOOL_STATUS_REBUILDING: 10410 snprintf(status, ST_SIZE, gettext("One or more devices is " 10411 "currently being resilvered. The pool will\n\tcontinue " 10412 "to function, possibly in a degraded state.\n")); 10413 snprintf(action, AC_SIZE, gettext("Wait for the resilver to " 10414 "complete.\n")); 10415 break; 10416 10417 case ZPOOL_STATUS_REBUILD_SCRUB: 10418 snprintf(status, ST_SIZE, gettext("One or more devices have " 10419 "been sequentially resilvered, scrubbing\n\tthe pool " 10420 "is recommended.\n")); 10421 snprintf(action, AC_SIZE, gettext("Use 'zpool scrub' to " 10422 "verify all data checksums.\n")); 10423 break; 10424 10425 case ZPOOL_STATUS_CORRUPT_DATA: 10426 snprintf(status, ST_SIZE, gettext("One or more devices has " 10427 "experienced an error resulting in data\n\tcorruption. " 10428 "Applications may be affected.\n")); 10429 snprintf(action, AC_SIZE, gettext("Restore the file in question" 10430 " if possible. Otherwise restore the\n\tentire pool from " 10431 "backup.\n")); 10432 break; 10433 10434 case ZPOOL_STATUS_CORRUPT_POOL: 10435 snprintf(status, ST_SIZE, gettext("The pool metadata is " 10436 "corrupted and the pool cannot be opened.\n")); 10437 zpool_explain_recover(zpool_get_handle(zhp), 10438 zpool_get_name(zhp), reason, zpool_get_config(zhp, NULL), 10439 action, AC_SIZE); 10440 break; 10441 10442 case ZPOOL_STATUS_VERSION_OLDER: 10443 snprintf(status, ST_SIZE, gettext("The pool is formatted using " 10444 "a legacy on-disk format. The pool can\n\tstill be used, " 10445 "but some features are unavailable.\n")); 10446 snprintf(action, AC_SIZE, gettext("Upgrade the pool using " 10447 "'zpool upgrade'. Once this is done, the\n\tpool will no " 10448 "longer be accessible on software that does not support\n\t" 10449 "feature flags.\n")); 10450 break; 10451 10452 case ZPOOL_STATUS_VERSION_NEWER: 10453 snprintf(status, ST_SIZE, gettext("The pool has been upgraded " 10454 "to a newer, incompatible on-disk version.\n\tThe pool " 10455 "cannot be accessed on this system.\n")); 10456 snprintf(action, AC_SIZE, gettext("Access the pool from a " 10457 "system running more recent software, or\n\trestore the " 10458 "pool from backup.\n")); 10459 break; 10460 10461 case ZPOOL_STATUS_FEAT_DISABLED: 10462 snprintf(status, ST_SIZE, gettext("Some supported and " 10463 "requested features are not enabled on the pool.\n\t" 10464 "The pool can still be used, but some features are " 10465 "unavailable.\n")); 10466 snprintf(action, AC_SIZE, gettext("Enable all features using " 10467 "'zpool upgrade'. Once this is done,\n\tthe pool may no " 10468 "longer be accessible by software that does not support\n\t" 10469 "the features. See zpool-features(7) for details.\n")); 10470 break; 10471 10472 case ZPOOL_STATUS_COMPATIBILITY_ERR: 10473 snprintf(status, ST_SIZE, gettext("This pool has a " 10474 "compatibility list specified, but it could not be\n\t" 10475 "read/parsed at this time. The pool can still be used, " 10476 "but this\n\tshould be investigated.\n")); 10477 snprintf(action, AC_SIZE, gettext("Check the value of the " 10478 "'compatibility' property against the\n\t" 10479 "appropriate file in " ZPOOL_SYSCONF_COMPAT_D " or " 10480 ZPOOL_DATA_COMPAT_D ".\n")); 10481 break; 10482 10483 case ZPOOL_STATUS_INCOMPATIBLE_FEAT: 10484 snprintf(status, ST_SIZE, gettext("One or more features " 10485 "are enabled on the pool despite not being\n\t" 10486 "requested by the 'compatibility' property.\n")); 10487 snprintf(action, AC_SIZE, gettext("Consider setting " 10488 "'compatibility' to an appropriate value, or\n\t" 10489 "adding needed features to the relevant file in\n\t" 10490 ZPOOL_SYSCONF_COMPAT_D " or " ZPOOL_DATA_COMPAT_D ".\n")); 10491 break; 10492 10493 case ZPOOL_STATUS_UNSUP_FEAT_READ: 10494 snprintf(status, ST_SIZE, gettext("The pool cannot be accessed " 10495 "on this system because it uses the\n\tfollowing feature(s)" 10496 " not supported on this system:\n")); 10497 zpool_collect_unsup_feat(zpool_get_config(zhp, NULL), status, 10498 1024); 10499 snprintf(action, AC_SIZE, gettext("Access the pool from a " 10500 "system that supports the required feature(s),\n\tor " 10501 "restore the pool from backup.\n")); 10502 break; 10503 10504 case ZPOOL_STATUS_UNSUP_FEAT_WRITE: 10505 snprintf(status, ST_SIZE, gettext("The pool can only be " 10506 "accessed in read-only mode on this system. It\n\tcannot be" 10507 " accessed in read-write mode because it uses the " 10508 "following\n\tfeature(s) not supported on this system:\n")); 10509 zpool_collect_unsup_feat(zpool_get_config(zhp, NULL), status, 10510 1024); 10511 snprintf(action, AC_SIZE, gettext("The pool cannot be accessed " 10512 "in read-write mode. Import the pool with\n" 10513 "\t\"-o readonly=on\", access the pool from a system that " 10514 "supports the\n\trequired feature(s), or restore the " 10515 "pool from backup.\n")); 10516 break; 10517 10518 case ZPOOL_STATUS_FAULTED_DEV_R: 10519 snprintf(status, ST_SIZE, gettext("One or more devices are " 10520 "faulted in response to persistent errors.\n\tSufficient " 10521 "replicas exist for the pool to continue functioning " 10522 "in a\n\tdegraded state.\n")); 10523 snprintf(action, AC_SIZE, gettext("Replace the faulted device, " 10524 "or use 'zpool clear' to mark the device\n\trepaired.\n")); 10525 break; 10526 10527 case ZPOOL_STATUS_FAULTED_DEV_NR: 10528 snprintf(status, ST_SIZE, gettext("One or more devices are " 10529 "faulted in response to persistent errors. There are " 10530 "insufficient replicas for the pool to\n\tcontinue " 10531 "functioning.\n")); 10532 snprintf(action, AC_SIZE, gettext("Destroy and re-create the " 10533 "pool from a backup source. Manually marking the device\n" 10534 "\trepaired using 'zpool clear' may allow some data " 10535 "to be recovered.\n")); 10536 break; 10537 10538 case ZPOOL_STATUS_IO_FAILURE_MMP: 10539 snprintf(status, ST_SIZE, gettext("The pool is suspended " 10540 "because multihost writes failed or were delayed;\n\t" 10541 "another system could import the pool undetected.\n")); 10542 snprintf(action, AC_SIZE, gettext("Make sure the pool's devices" 10543 " are connected, then reboot your system and\n\timport the " 10544 "pool or run 'zpool clear' to resume the pool.\n")); 10545 break; 10546 10547 case ZPOOL_STATUS_IO_FAILURE_WAIT: 10548 case ZPOOL_STATUS_IO_FAILURE_CONTINUE: 10549 snprintf(status, ST_SIZE, gettext("One or more devices are " 10550 "faulted in response to IO failures.\n")); 10551 snprintf(action, AC_SIZE, gettext("Make sure the affected " 10552 "devices are connected, then run 'zpool clear'.\n")); 10553 break; 10554 10555 case ZPOOL_STATUS_BAD_LOG: 10556 snprintf(status, ST_SIZE, gettext("An intent log record " 10557 "could not be read.\n" 10558 "\tWaiting for administrator intervention to fix the " 10559 "faulted pool.\n")); 10560 snprintf(action, AC_SIZE, gettext("Either restore the affected " 10561 "device(s) and run 'zpool online',\n" 10562 "\tor ignore the intent log records by running " 10563 "'zpool clear'.\n")); 10564 break; 10565 10566 case ZPOOL_STATUS_NON_NATIVE_ASHIFT: 10567 snprintf(status, ST_SIZE, gettext("One or more devices are " 10568 "configured to use a non-native block size.\n" 10569 "\tExpect reduced performance.\n")); 10570 snprintf(action, AC_SIZE, gettext("Replace affected devices " 10571 "with devices that support the\n\tconfigured block size, " 10572 "or migrate data to a properly configured\n\tpool.\n")); 10573 break; 10574 10575 case ZPOOL_STATUS_HOSTID_MISMATCH: 10576 snprintf(status, ST_SIZE, gettext("Mismatch between pool hostid" 10577 " and system hostid on imported pool.\n\tThis pool was " 10578 "previously imported into a system with a different " 10579 "hostid,\n\tand then was verbatim imported into this " 10580 "system.\n")); 10581 snprintf(action, AC_SIZE, gettext("Export this pool on all " 10582 "systems on which it is imported.\n" 10583 "\tThen import it to correct the mismatch.\n")); 10584 break; 10585 10586 case ZPOOL_STATUS_ERRATA: 10587 snprintf(status, ST_SIZE, gettext("Errata #%d detected.\n"), 10588 errata); 10589 switch (errata) { 10590 case ZPOOL_ERRATA_NONE: 10591 break; 10592 10593 case ZPOOL_ERRATA_ZOL_2094_SCRUB: 10594 snprintf(action, AC_SIZE, gettext("To correct the issue" 10595 " run 'zpool scrub'.\n")); 10596 break; 10597 10598 case ZPOOL_ERRATA_ZOL_6845_ENCRYPTION: 10599 (void) strlcat(status, gettext("\tExisting encrypted " 10600 "datasets contain an on-disk incompatibility\n\t " 10601 "which needs to be corrected.\n"), ST_SIZE); 10602 snprintf(action, AC_SIZE, gettext("To correct the issue" 10603 " backup existing encrypted datasets to new\n\t" 10604 "encrypted datasets and destroy the old ones. " 10605 "'zfs mount -o ro' can\n\tbe used to temporarily " 10606 "mount existing encrypted datasets readonly.\n")); 10607 break; 10608 10609 case ZPOOL_ERRATA_ZOL_8308_ENCRYPTION: 10610 (void) strlcat(status, gettext("\tExisting encrypted " 10611 "snapshots and bookmarks contain an on-disk\n\t" 10612 "incompatibility. This may cause on-disk " 10613 "corruption if they are used\n\twith " 10614 "'zfs recv'.\n"), ST_SIZE); 10615 snprintf(action, AC_SIZE, gettext("To correct the" 10616 "issue, enable the bookmark_v2 feature. No " 10617 "additional\n\taction is needed if there are no " 10618 "encrypted snapshots or bookmarks.\n\tIf preserving" 10619 "the encrypted snapshots and bookmarks is required," 10620 " use\n\ta non-raw send to backup and restore them." 10621 " Alternately, they may be\n\tremoved to resolve " 10622 "the incompatibility.\n")); 10623 break; 10624 10625 default: 10626 /* 10627 * All errata which allow the pool to be imported 10628 * must contain an action message. 10629 */ 10630 assert(0); 10631 } 10632 break; 10633 10634 default: 10635 /* 10636 * The remaining errors can't actually be generated, yet. 10637 */ 10638 assert(reason == ZPOOL_STATUS_OK); 10639 } 10640 10641 if (status[0] != 0) { 10642 if (cbp->cb_json) 10643 fnvlist_add_string(item, "status", status); 10644 else { 10645 printf_color(ANSI_BOLD, gettext("status: ")); 10646 printf_color(ANSI_YELLOW, status); 10647 } 10648 } 10649 10650 if (action[0] != 0) { 10651 if (cbp->cb_json) 10652 fnvlist_add_string(item, "action", action); 10653 else { 10654 printf_color(ANSI_BOLD, gettext("action: ")); 10655 printf_color(ANSI_YELLOW, action); 10656 } 10657 } 10658 } 10659 10660 static int 10661 status_callback_json(zpool_handle_t *zhp, void *data) 10662 { 10663 status_cbdata_t *cbp = data; 10664 nvlist_t *config, *nvroot; 10665 const char *msgid; 10666 char pool_guid[256]; 10667 char msgbuf[256]; 10668 uint64_t guid; 10669 zpool_status_t reason; 10670 zpool_errata_t errata; 10671 uint_t c; 10672 vdev_stat_t *vs; 10673 nvlist_t *item, *d, *load_info, *vds; 10674 item = d = NULL; 10675 10676 /* If dedup stats were requested, also fetch dedupcached. */ 10677 if (cbp->cb_dedup_stats > 1) 10678 zpool_add_propname(zhp, ZPOOL_DEDUPCACHED_PROP_NAME); 10679 reason = zpool_get_status(zhp, &msgid, &errata); 10680 /* 10681 * If we were given 'zpool status -x', only report those pools with 10682 * problems. 10683 */ 10684 if (cbp->cb_explain && 10685 (reason == ZPOOL_STATUS_OK || 10686 reason == ZPOOL_STATUS_VERSION_OLDER || 10687 reason == ZPOOL_STATUS_FEAT_DISABLED || 10688 reason == ZPOOL_STATUS_COMPATIBILITY_ERR || 10689 reason == ZPOOL_STATUS_INCOMPATIBLE_FEAT)) { 10690 return (0); 10691 } 10692 10693 d = fnvlist_lookup_nvlist(cbp->cb_jsobj, "pools"); 10694 item = fnvlist_alloc(); 10695 vds = fnvlist_alloc(); 10696 fill_pool_info(item, zhp, B_FALSE, cbp->cb_json_as_int); 10697 config = zpool_get_config(zhp, NULL); 10698 10699 if (config != NULL) { 10700 nvroot = fnvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE); 10701 verify(nvlist_lookup_uint64_array(nvroot, 10702 ZPOOL_CONFIG_VDEV_STATS, (uint64_t **)&vs, &c) == 0); 10703 if (cbp->cb_json_pool_key_guid) { 10704 guid = fnvlist_lookup_uint64(config, 10705 ZPOOL_CONFIG_POOL_GUID); 10706 snprintf(pool_guid, 256, "%llu", (u_longlong_t)guid); 10707 } 10708 cbp->cb_count++; 10709 10710 print_status_reason(zhp, cbp, reason, errata, item); 10711 if (msgid != NULL) { 10712 snprintf(msgbuf, 256, 10713 "https://openzfs.github.io/openzfs-docs/msg/%s", 10714 msgid); 10715 fnvlist_add_string(item, "msgid", msgid); 10716 fnvlist_add_string(item, "moreinfo", msgbuf); 10717 } 10718 10719 if (nvlist_lookup_nvlist(config, ZPOOL_CONFIG_LOAD_INFO, 10720 &load_info) == 0) { 10721 fnvlist_add_nvlist(item, ZPOOL_CONFIG_LOAD_INFO, 10722 load_info); 10723 } 10724 10725 scan_status_nvlist(zhp, cbp, nvroot, item); 10726 removal_status_nvlist(zhp, cbp, nvroot, item); 10727 checkpoint_status_nvlist(nvroot, cbp, item); 10728 raidz_expand_status_nvlist(zhp, cbp, nvroot, item); 10729 vdev_stats_nvlist(zhp, cbp, nvroot, 0, B_FALSE, NULL, vds); 10730 if (cbp->cb_flat_vdevs) { 10731 class_vdevs_nvlist(zhp, cbp, nvroot, 10732 VDEV_ALLOC_BIAS_DEDUP, vds); 10733 class_vdevs_nvlist(zhp, cbp, nvroot, 10734 VDEV_ALLOC_BIAS_SPECIAL, vds); 10735 class_vdevs_nvlist(zhp, cbp, nvroot, 10736 VDEV_ALLOC_CLASS_LOGS, vds); 10737 l2cache_nvlist(zhp, cbp, nvroot, vds); 10738 spares_nvlist(zhp, cbp, nvroot, vds); 10739 10740 fnvlist_add_nvlist(item, "vdevs", vds); 10741 fnvlist_free(vds); 10742 } else { 10743 fnvlist_add_nvlist(item, "vdevs", vds); 10744 fnvlist_free(vds); 10745 10746 class_vdevs_nvlist(zhp, cbp, nvroot, 10747 VDEV_ALLOC_BIAS_DEDUP, item); 10748 class_vdevs_nvlist(zhp, cbp, nvroot, 10749 VDEV_ALLOC_BIAS_SPECIAL, item); 10750 class_vdevs_nvlist(zhp, cbp, nvroot, 10751 VDEV_ALLOC_CLASS_LOGS, item); 10752 l2cache_nvlist(zhp, cbp, nvroot, item); 10753 spares_nvlist(zhp, cbp, nvroot, item); 10754 } 10755 dedup_stats_nvlist(zhp, cbp, item); 10756 errors_nvlist(zhp, cbp, item); 10757 } 10758 if (cbp->cb_json_pool_key_guid) { 10759 fnvlist_add_nvlist(d, pool_guid, item); 10760 } else { 10761 fnvlist_add_nvlist(d, zpool_get_name(zhp), 10762 item); 10763 } 10764 fnvlist_free(item); 10765 return (0); 10766 } 10767 10768 /* 10769 * Display a summary of pool status. Displays a summary such as: 10770 * 10771 * pool: tank 10772 * status: DEGRADED 10773 * reason: One or more devices ... 10774 * see: https://openzfs.github.io/openzfs-docs/msg/ZFS-xxxx-01 10775 * config: 10776 * mirror DEGRADED 10777 * c1t0d0 OK 10778 * c2t0d0 UNAVAIL 10779 * 10780 * When given the '-v' option, we print out the complete config. If the '-e' 10781 * option is specified, then we print out error rate information as well. 10782 */ 10783 static int 10784 status_callback(zpool_handle_t *zhp, void *data) 10785 { 10786 status_cbdata_t *cbp = data; 10787 nvlist_t *config, *nvroot; 10788 const char *msgid; 10789 zpool_status_t reason; 10790 zpool_errata_t errata; 10791 const char *health; 10792 uint_t c; 10793 vdev_stat_t *vs; 10794 10795 /* If dedup stats were requested, also fetch dedupcached. */ 10796 if (cbp->cb_dedup_stats > 1) 10797 zpool_add_propname(zhp, ZPOOL_DEDUPCACHED_PROP_NAME); 10798 10799 config = zpool_get_config(zhp, NULL); 10800 reason = zpool_get_status(zhp, &msgid, &errata); 10801 10802 cbp->cb_count++; 10803 10804 /* 10805 * If we were given 'zpool status -x', only report those pools with 10806 * problems. 10807 */ 10808 if (cbp->cb_explain && 10809 (reason == ZPOOL_STATUS_OK || 10810 reason == ZPOOL_STATUS_VERSION_OLDER || 10811 reason == ZPOOL_STATUS_FEAT_DISABLED || 10812 reason == ZPOOL_STATUS_COMPATIBILITY_ERR || 10813 reason == ZPOOL_STATUS_INCOMPATIBLE_FEAT)) { 10814 if (!cbp->cb_allpools) { 10815 (void) printf(gettext("pool '%s' is healthy\n"), 10816 zpool_get_name(zhp)); 10817 if (cbp->cb_first) 10818 cbp->cb_first = B_FALSE; 10819 } 10820 return (0); 10821 } 10822 10823 if (cbp->cb_first) 10824 cbp->cb_first = B_FALSE; 10825 else 10826 (void) printf("\n"); 10827 10828 nvroot = fnvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE); 10829 verify(nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_VDEV_STATS, 10830 (uint64_t **)&vs, &c) == 0); 10831 10832 health = zpool_get_state_str(zhp); 10833 10834 printf(" "); 10835 printf_color(ANSI_BOLD, gettext("pool:")); 10836 printf(" %s\n", zpool_get_name(zhp)); 10837 fputc(' ', stdout); 10838 printf_color(ANSI_BOLD, gettext("state: ")); 10839 10840 printf_color(health_str_to_color(health), "%s", health); 10841 10842 fputc('\n', stdout); 10843 print_status_reason(zhp, cbp, reason, errata, NULL); 10844 10845 if (msgid != NULL) { 10846 printf(" "); 10847 printf_color(ANSI_BOLD, gettext("see:")); 10848 printf(gettext( 10849 " https://openzfs.github.io/openzfs-docs/msg/%s\n"), 10850 msgid); 10851 } 10852 10853 if (config != NULL) { 10854 uint64_t nerr; 10855 nvlist_t **spares, **l2cache; 10856 uint_t nspares, nl2cache; 10857 10858 print_scan_status(zhp, nvroot); 10859 10860 pool_removal_stat_t *prs = NULL; 10861 (void) nvlist_lookup_uint64_array(nvroot, 10862 ZPOOL_CONFIG_REMOVAL_STATS, (uint64_t **)&prs, &c); 10863 print_removal_status(zhp, prs); 10864 10865 pool_checkpoint_stat_t *pcs = NULL; 10866 (void) nvlist_lookup_uint64_array(nvroot, 10867 ZPOOL_CONFIG_CHECKPOINT_STATS, (uint64_t **)&pcs, &c); 10868 print_checkpoint_status(pcs); 10869 10870 pool_raidz_expand_stat_t *pres = NULL; 10871 (void) nvlist_lookup_uint64_array(nvroot, 10872 ZPOOL_CONFIG_RAIDZ_EXPAND_STATS, (uint64_t **)&pres, &c); 10873 print_raidz_expand_status(zhp, pres); 10874 10875 cbp->cb_namewidth = max_width(zhp, nvroot, 0, 0, 10876 cbp->cb_name_flags | VDEV_NAME_TYPE_ID); 10877 if (cbp->cb_namewidth < 10) 10878 cbp->cb_namewidth = 10; 10879 10880 color_start(ANSI_BOLD); 10881 (void) printf(gettext("config:\n\n")); 10882 (void) printf(gettext("\t%-*s %-8s %5s %5s %5s"), 10883 cbp->cb_namewidth, "NAME", "STATE", "READ", "WRITE", 10884 "CKSUM"); 10885 color_end(); 10886 10887 if (cbp->cb_print_slow_ios) { 10888 printf_color(ANSI_BOLD, " %5s", gettext("SLOW")); 10889 } 10890 10891 if (cbp->cb_print_power) { 10892 printf_color(ANSI_BOLD, " %5s", gettext("POWER")); 10893 } 10894 10895 if (cbp->cb_print_dio_verify) { 10896 printf_color(ANSI_BOLD, " %5s", gettext("DIO")); 10897 } 10898 10899 if (cbp->vcdl != NULL) 10900 print_cmd_columns(cbp->vcdl, 0); 10901 10902 printf("\n"); 10903 10904 print_status_config(zhp, cbp, zpool_get_name(zhp), nvroot, 0, 10905 B_FALSE, NULL); 10906 10907 print_class_vdevs(zhp, cbp, nvroot, VDEV_ALLOC_BIAS_DEDUP); 10908 print_class_vdevs(zhp, cbp, nvroot, VDEV_ALLOC_BIAS_SPECIAL); 10909 print_class_vdevs(zhp, cbp, nvroot, VDEV_ALLOC_CLASS_LOGS); 10910 10911 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_L2CACHE, 10912 &l2cache, &nl2cache) == 0) 10913 print_l2cache(zhp, cbp, l2cache, nl2cache); 10914 10915 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES, 10916 &spares, &nspares) == 0) 10917 print_spares(zhp, cbp, spares, nspares); 10918 10919 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_ERRCOUNT, 10920 &nerr) == 0) { 10921 (void) printf("\n"); 10922 if (nerr == 0) { 10923 (void) printf(gettext( 10924 "errors: No known data errors\n")); 10925 } else if (!cbp->cb_verbose) { 10926 color_start(ANSI_RED); 10927 (void) printf(gettext("errors: %llu data " 10928 "errors, use '-v' for a list\n"), 10929 (u_longlong_t)nerr); 10930 color_end(); 10931 } else { 10932 print_error_log(zhp); 10933 } 10934 } 10935 10936 if (cbp->cb_dedup_stats) 10937 print_dedup_stats(zhp, config, cbp->cb_literal); 10938 } else { 10939 (void) printf(gettext("config: The configuration cannot be " 10940 "determined.\n")); 10941 } 10942 10943 return (0); 10944 } 10945 10946 /* 10947 * zpool status [-c [script1,script2,...]] [-dDegiLpPstvx] [--power] ... 10948 * [-T d|u] [pool] [interval [count]] 10949 * 10950 * -c CMD For each vdev, run command CMD 10951 * -d Display Direct I/O write verify errors 10952 * -D Display dedup status (undocumented) 10953 * -e Display only unhealthy vdevs 10954 * -g Display guid for individual vdev name. 10955 * -i Display vdev initialization status. 10956 * -L Follow links when resolving vdev path name. 10957 * -p Display values in parsable (exact) format. 10958 * -P Display full path for vdev name. 10959 * -s Display slow IOs column. 10960 * -t Display vdev TRIM status. 10961 * -T Display a timestamp in date(1) or Unix format 10962 * -v Display complete error logs 10963 * -x Display only pools with potential problems 10964 * -j Display output in JSON format 10965 * --power Display vdev enclosure slot power status 10966 * --json-int Display numbers in inteeger format instead of string 10967 * --json-flat-vdevs Display vdevs in flat hierarchy 10968 * --json-pool-key-guid Use pool GUID as key for pool objects 10969 * 10970 * Describes the health status of all pools or some subset. 10971 */ 10972 int 10973 zpool_do_status(int argc, char **argv) 10974 { 10975 int c; 10976 int ret; 10977 float interval = 0; 10978 unsigned long count = 0; 10979 status_cbdata_t cb = { 0 }; 10980 nvlist_t *data; 10981 char *cmd = NULL; 10982 10983 struct option long_options[] = { 10984 {"power", no_argument, NULL, ZPOOL_OPTION_POWER}, 10985 {"json", no_argument, NULL, 'j'}, 10986 {"json-int", no_argument, NULL, ZPOOL_OPTION_JSON_NUMS_AS_INT}, 10987 {"json-flat-vdevs", no_argument, NULL, 10988 ZPOOL_OPTION_JSON_FLAT_VDEVS}, 10989 {"json-pool-key-guid", no_argument, NULL, 10990 ZPOOL_OPTION_POOL_KEY_GUID}, 10991 {0, 0, 0, 0} 10992 }; 10993 10994 /* check options */ 10995 while ((c = getopt_long(argc, argv, "c:jdDegiLpPstT:vx", long_options, 10996 NULL)) != -1) { 10997 switch (c) { 10998 case 'c': 10999 if (cmd != NULL) { 11000 fprintf(stderr, 11001 gettext("Can't set -c flag twice\n")); 11002 exit(1); 11003 } 11004 11005 if (getenv("ZPOOL_SCRIPTS_ENABLED") != NULL && 11006 !libzfs_envvar_is_set("ZPOOL_SCRIPTS_ENABLED")) { 11007 fprintf(stderr, gettext( 11008 "Can't run -c, disabled by " 11009 "ZPOOL_SCRIPTS_ENABLED.\n")); 11010 exit(1); 11011 } 11012 11013 if ((getuid() <= 0 || geteuid() <= 0) && 11014 !libzfs_envvar_is_set("ZPOOL_SCRIPTS_AS_ROOT")) { 11015 fprintf(stderr, gettext( 11016 "Can't run -c with root privileges " 11017 "unless ZPOOL_SCRIPTS_AS_ROOT is set.\n")); 11018 exit(1); 11019 } 11020 cmd = optarg; 11021 break; 11022 case 'd': 11023 cb.cb_print_dio_verify = B_TRUE; 11024 break; 11025 case 'D': 11026 if (++cb.cb_dedup_stats > 2) 11027 cb.cb_dedup_stats = 2; 11028 break; 11029 case 'e': 11030 cb.cb_print_unhealthy = B_TRUE; 11031 break; 11032 case 'g': 11033 cb.cb_name_flags |= VDEV_NAME_GUID; 11034 break; 11035 case 'i': 11036 cb.cb_print_vdev_init = B_TRUE; 11037 break; 11038 case 'L': 11039 cb.cb_name_flags |= VDEV_NAME_FOLLOW_LINKS; 11040 break; 11041 case 'p': 11042 cb.cb_literal = B_TRUE; 11043 break; 11044 case 'P': 11045 cb.cb_name_flags |= VDEV_NAME_PATH; 11046 break; 11047 case 's': 11048 cb.cb_print_slow_ios = B_TRUE; 11049 break; 11050 case 't': 11051 cb.cb_print_vdev_trim = B_TRUE; 11052 break; 11053 case 'T': 11054 get_timestamp_arg(*optarg); 11055 break; 11056 case 'v': 11057 cb.cb_verbose = B_TRUE; 11058 break; 11059 case 'j': 11060 cb.cb_json = B_TRUE; 11061 break; 11062 case 'x': 11063 cb.cb_explain = B_TRUE; 11064 break; 11065 case ZPOOL_OPTION_POWER: 11066 cb.cb_print_power = B_TRUE; 11067 break; 11068 case ZPOOL_OPTION_JSON_FLAT_VDEVS: 11069 cb.cb_flat_vdevs = B_TRUE; 11070 break; 11071 case ZPOOL_OPTION_JSON_NUMS_AS_INT: 11072 cb.cb_json_as_int = B_TRUE; 11073 cb.cb_literal = B_TRUE; 11074 break; 11075 case ZPOOL_OPTION_POOL_KEY_GUID: 11076 cb.cb_json_pool_key_guid = B_TRUE; 11077 break; 11078 case '?': 11079 if (optopt == 'c') { 11080 print_zpool_script_list("status"); 11081 exit(0); 11082 } else { 11083 fprintf(stderr, 11084 gettext("invalid option '%c'\n"), optopt); 11085 } 11086 usage(B_FALSE); 11087 } 11088 } 11089 11090 argc -= optind; 11091 argv += optind; 11092 11093 get_interval_count(&argc, argv, &interval, &count); 11094 11095 if (argc == 0) 11096 cb.cb_allpools = B_TRUE; 11097 11098 cb.cb_first = B_TRUE; 11099 cb.cb_print_status = B_TRUE; 11100 11101 if (cb.cb_flat_vdevs && !cb.cb_json) { 11102 fprintf(stderr, gettext("'--json-flat-vdevs' only works with" 11103 " '-j' option\n")); 11104 usage(B_FALSE); 11105 } 11106 11107 if (cb.cb_json_as_int && !cb.cb_json) { 11108 (void) fprintf(stderr, gettext("'--json-int' only works with" 11109 " '-j' option\n")); 11110 usage(B_FALSE); 11111 } 11112 11113 if (!cb.cb_json && cb.cb_json_pool_key_guid) { 11114 (void) fprintf(stderr, gettext("'json-pool-key-guid' only" 11115 " works with '-j' option\n")); 11116 usage(B_FALSE); 11117 } 11118 11119 for (;;) { 11120 if (cb.cb_json) { 11121 cb.cb_jsobj = zpool_json_schema(0, 1); 11122 data = fnvlist_alloc(); 11123 fnvlist_add_nvlist(cb.cb_jsobj, "pools", data); 11124 fnvlist_free(data); 11125 } 11126 11127 if (timestamp_fmt != NODATE) { 11128 if (cb.cb_json) { 11129 if (cb.cb_json_as_int) { 11130 fnvlist_add_uint64(cb.cb_jsobj, "time", 11131 time(NULL)); 11132 } else { 11133 char ts[128]; 11134 get_timestamp(timestamp_fmt, ts, 128); 11135 fnvlist_add_string(cb.cb_jsobj, "time", 11136 ts); 11137 } 11138 } else 11139 print_timestamp(timestamp_fmt); 11140 } 11141 11142 if (cmd != NULL) 11143 cb.vcdl = all_pools_for_each_vdev_run(argc, argv, cmd, 11144 NULL, NULL, 0, 0); 11145 11146 if (cb.cb_json) { 11147 ret = for_each_pool(argc, argv, B_TRUE, NULL, 11148 ZFS_TYPE_POOL, cb.cb_literal, 11149 status_callback_json, &cb); 11150 } else { 11151 ret = for_each_pool(argc, argv, B_TRUE, NULL, 11152 ZFS_TYPE_POOL, cb.cb_literal, 11153 status_callback, &cb); 11154 } 11155 11156 if (cb.vcdl != NULL) 11157 free_vdev_cmd_data_list(cb.vcdl); 11158 11159 if (cb.cb_json) { 11160 if (ret == 0) 11161 zcmd_print_json(cb.cb_jsobj); 11162 else 11163 nvlist_free(cb.cb_jsobj); 11164 } else { 11165 if (argc == 0 && cb.cb_count == 0) { 11166 (void) fprintf(stderr, "%s", 11167 gettext("no pools available\n")); 11168 } else if (cb.cb_explain && cb.cb_first && 11169 cb.cb_allpools) { 11170 (void) printf("%s", 11171 gettext("all pools are healthy\n")); 11172 } 11173 } 11174 11175 if (ret != 0) 11176 return (ret); 11177 11178 if (interval == 0) 11179 break; 11180 11181 if (count != 0 && --count == 0) 11182 break; 11183 11184 (void) fflush(stdout); 11185 (void) fsleep(interval); 11186 } 11187 11188 return (0); 11189 } 11190 11191 typedef struct upgrade_cbdata { 11192 int cb_first; 11193 int cb_argc; 11194 uint64_t cb_version; 11195 char **cb_argv; 11196 } upgrade_cbdata_t; 11197 11198 static int 11199 check_unsupp_fs(zfs_handle_t *zhp, void *unsupp_fs) 11200 { 11201 int zfs_version = (int)zfs_prop_get_int(zhp, ZFS_PROP_VERSION); 11202 int *count = (int *)unsupp_fs; 11203 11204 if (zfs_version > ZPL_VERSION) { 11205 (void) printf(gettext("%s (v%d) is not supported by this " 11206 "implementation of ZFS.\n"), 11207 zfs_get_name(zhp), zfs_version); 11208 (*count)++; 11209 } 11210 11211 zfs_iter_filesystems_v2(zhp, 0, check_unsupp_fs, unsupp_fs); 11212 11213 zfs_close(zhp); 11214 11215 return (0); 11216 } 11217 11218 static int 11219 upgrade_version(zpool_handle_t *zhp, uint64_t version) 11220 { 11221 int ret; 11222 nvlist_t *config; 11223 uint64_t oldversion; 11224 int unsupp_fs = 0; 11225 11226 config = zpool_get_config(zhp, NULL); 11227 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION, 11228 &oldversion) == 0); 11229 11230 char compat[ZFS_MAXPROPLEN]; 11231 if (zpool_get_prop(zhp, ZPOOL_PROP_COMPATIBILITY, compat, 11232 ZFS_MAXPROPLEN, NULL, B_FALSE) != 0) 11233 compat[0] = '\0'; 11234 11235 assert(SPA_VERSION_IS_SUPPORTED(oldversion)); 11236 assert(oldversion < version); 11237 11238 ret = zfs_iter_root(zpool_get_handle(zhp), check_unsupp_fs, &unsupp_fs); 11239 if (ret != 0) 11240 return (ret); 11241 11242 if (unsupp_fs) { 11243 (void) fprintf(stderr, gettext("Upgrade not performed due " 11244 "to %d unsupported filesystems (max v%d).\n"), 11245 unsupp_fs, (int)ZPL_VERSION); 11246 return (1); 11247 } 11248 11249 if (strcmp(compat, ZPOOL_COMPAT_LEGACY) == 0) { 11250 (void) fprintf(stderr, gettext("Upgrade not performed because " 11251 "'compatibility' property set to '" 11252 ZPOOL_COMPAT_LEGACY "'.\n")); 11253 return (1); 11254 } 11255 11256 ret = zpool_upgrade(zhp, version); 11257 if (ret != 0) 11258 return (ret); 11259 11260 if (version >= SPA_VERSION_FEATURES) { 11261 (void) printf(gettext("Successfully upgraded " 11262 "'%s' from version %llu to feature flags.\n"), 11263 zpool_get_name(zhp), (u_longlong_t)oldversion); 11264 } else { 11265 (void) printf(gettext("Successfully upgraded " 11266 "'%s' from version %llu to version %llu.\n"), 11267 zpool_get_name(zhp), (u_longlong_t)oldversion, 11268 (u_longlong_t)version); 11269 } 11270 11271 return (0); 11272 } 11273 11274 static int 11275 upgrade_enable_all(zpool_handle_t *zhp, int *countp) 11276 { 11277 int i, ret, count; 11278 boolean_t firstff = B_TRUE; 11279 nvlist_t *enabled = zpool_get_features(zhp); 11280 11281 char compat[ZFS_MAXPROPLEN]; 11282 if (zpool_get_prop(zhp, ZPOOL_PROP_COMPATIBILITY, compat, 11283 ZFS_MAXPROPLEN, NULL, B_FALSE) != 0) 11284 compat[0] = '\0'; 11285 11286 boolean_t requested_features[SPA_FEATURES]; 11287 if (zpool_do_load_compat(compat, requested_features) != 11288 ZPOOL_COMPATIBILITY_OK) 11289 return (-1); 11290 11291 count = 0; 11292 for (i = 0; i < SPA_FEATURES; i++) { 11293 const char *fname = spa_feature_table[i].fi_uname; 11294 const char *fguid = spa_feature_table[i].fi_guid; 11295 11296 if (!spa_feature_table[i].fi_zfs_mod_supported) 11297 continue; 11298 11299 if (!nvlist_exists(enabled, fguid) && requested_features[i]) { 11300 char *propname; 11301 verify(-1 != asprintf(&propname, "feature@%s", fname)); 11302 ret = zpool_set_prop(zhp, propname, 11303 ZFS_FEATURE_ENABLED); 11304 if (ret != 0) { 11305 free(propname); 11306 return (ret); 11307 } 11308 count++; 11309 11310 if (firstff) { 11311 (void) printf(gettext("Enabled the " 11312 "following features on '%s':\n"), 11313 zpool_get_name(zhp)); 11314 firstff = B_FALSE; 11315 } 11316 (void) printf(gettext(" %s\n"), fname); 11317 free(propname); 11318 } 11319 } 11320 11321 if (countp != NULL) 11322 *countp = count; 11323 return (0); 11324 } 11325 11326 static int 11327 upgrade_cb(zpool_handle_t *zhp, void *arg) 11328 { 11329 upgrade_cbdata_t *cbp = arg; 11330 nvlist_t *config; 11331 uint64_t version; 11332 boolean_t modified_pool = B_FALSE; 11333 int ret; 11334 11335 config = zpool_get_config(zhp, NULL); 11336 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION, 11337 &version) == 0); 11338 11339 assert(SPA_VERSION_IS_SUPPORTED(version)); 11340 11341 if (version < cbp->cb_version) { 11342 cbp->cb_first = B_FALSE; 11343 ret = upgrade_version(zhp, cbp->cb_version); 11344 if (ret != 0) 11345 return (ret); 11346 modified_pool = B_TRUE; 11347 11348 /* 11349 * If they did "zpool upgrade -a", then we could 11350 * be doing ioctls to different pools. We need 11351 * to log this history once to each pool, and bypass 11352 * the normal history logging that happens in main(). 11353 */ 11354 (void) zpool_log_history(g_zfs, history_str); 11355 log_history = B_FALSE; 11356 } 11357 11358 if (cbp->cb_version >= SPA_VERSION_FEATURES) { 11359 int count; 11360 ret = upgrade_enable_all(zhp, &count); 11361 if (ret != 0) 11362 return (ret); 11363 11364 if (count > 0) { 11365 cbp->cb_first = B_FALSE; 11366 modified_pool = B_TRUE; 11367 } 11368 } 11369 11370 if (modified_pool) { 11371 (void) printf("\n"); 11372 (void) after_zpool_upgrade(zhp); 11373 } 11374 11375 return (0); 11376 } 11377 11378 static int 11379 upgrade_list_older_cb(zpool_handle_t *zhp, void *arg) 11380 { 11381 upgrade_cbdata_t *cbp = arg; 11382 nvlist_t *config; 11383 uint64_t version; 11384 11385 config = zpool_get_config(zhp, NULL); 11386 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION, 11387 &version) == 0); 11388 11389 assert(SPA_VERSION_IS_SUPPORTED(version)); 11390 11391 if (version < SPA_VERSION_FEATURES) { 11392 if (cbp->cb_first) { 11393 (void) printf(gettext("The following pools are " 11394 "formatted with legacy version numbers and can\n" 11395 "be upgraded to use feature flags. After " 11396 "being upgraded, these pools\nwill no " 11397 "longer be accessible by software that does not " 11398 "support feature\nflags.\n\n" 11399 "Note that setting a pool's 'compatibility' " 11400 "feature to '" ZPOOL_COMPAT_LEGACY "' will\n" 11401 "inhibit upgrades.\n\n")); 11402 (void) printf(gettext("VER POOL\n")); 11403 (void) printf(gettext("--- ------------\n")); 11404 cbp->cb_first = B_FALSE; 11405 } 11406 11407 (void) printf("%2llu %s\n", (u_longlong_t)version, 11408 zpool_get_name(zhp)); 11409 } 11410 11411 return (0); 11412 } 11413 11414 static int 11415 upgrade_list_disabled_cb(zpool_handle_t *zhp, void *arg) 11416 { 11417 upgrade_cbdata_t *cbp = arg; 11418 nvlist_t *config; 11419 uint64_t version; 11420 11421 config = zpool_get_config(zhp, NULL); 11422 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION, 11423 &version) == 0); 11424 11425 if (version >= SPA_VERSION_FEATURES) { 11426 int i; 11427 boolean_t poolfirst = B_TRUE; 11428 nvlist_t *enabled = zpool_get_features(zhp); 11429 11430 for (i = 0; i < SPA_FEATURES; i++) { 11431 const char *fguid = spa_feature_table[i].fi_guid; 11432 const char *fname = spa_feature_table[i].fi_uname; 11433 11434 if (!spa_feature_table[i].fi_zfs_mod_supported) 11435 continue; 11436 11437 if (!nvlist_exists(enabled, fguid)) { 11438 if (cbp->cb_first) { 11439 (void) printf(gettext("\nSome " 11440 "supported features are not " 11441 "enabled on the following pools. " 11442 "Once a\nfeature is enabled the " 11443 "pool may become incompatible with " 11444 "software\nthat does not support " 11445 "the feature. See " 11446 "zpool-features(7) for " 11447 "details.\n\n" 11448 "Note that the pool " 11449 "'compatibility' feature can be " 11450 "used to inhibit\nfeature " 11451 "upgrades.\n\n")); 11452 (void) printf(gettext("POOL " 11453 "FEATURE\n")); 11454 (void) printf(gettext("------" 11455 "---------\n")); 11456 cbp->cb_first = B_FALSE; 11457 } 11458 11459 if (poolfirst) { 11460 (void) printf(gettext("%s\n"), 11461 zpool_get_name(zhp)); 11462 poolfirst = B_FALSE; 11463 } 11464 11465 (void) printf(gettext(" %s\n"), fname); 11466 } 11467 /* 11468 * If they did "zpool upgrade -a", then we could 11469 * be doing ioctls to different pools. We need 11470 * to log this history once to each pool, and bypass 11471 * the normal history logging that happens in main(). 11472 */ 11473 (void) zpool_log_history(g_zfs, history_str); 11474 log_history = B_FALSE; 11475 } 11476 } 11477 11478 return (0); 11479 } 11480 11481 static int 11482 upgrade_one(zpool_handle_t *zhp, void *data) 11483 { 11484 boolean_t modified_pool = B_FALSE; 11485 upgrade_cbdata_t *cbp = data; 11486 uint64_t cur_version; 11487 int ret; 11488 11489 if (strcmp("log", zpool_get_name(zhp)) == 0) { 11490 (void) fprintf(stderr, gettext("'log' is now a reserved word\n" 11491 "Pool 'log' must be renamed using export and import" 11492 " to upgrade.\n")); 11493 return (1); 11494 } 11495 11496 cur_version = zpool_get_prop_int(zhp, ZPOOL_PROP_VERSION, NULL); 11497 if (cur_version > cbp->cb_version) { 11498 (void) printf(gettext("Pool '%s' is already formatted " 11499 "using more current version '%llu'.\n\n"), 11500 zpool_get_name(zhp), (u_longlong_t)cur_version); 11501 return (0); 11502 } 11503 11504 if (cbp->cb_version != SPA_VERSION && cur_version == cbp->cb_version) { 11505 (void) printf(gettext("Pool '%s' is already formatted " 11506 "using version %llu.\n\n"), zpool_get_name(zhp), 11507 (u_longlong_t)cbp->cb_version); 11508 return (0); 11509 } 11510 11511 if (cur_version != cbp->cb_version) { 11512 modified_pool = B_TRUE; 11513 ret = upgrade_version(zhp, cbp->cb_version); 11514 if (ret != 0) 11515 return (ret); 11516 } 11517 11518 if (cbp->cb_version >= SPA_VERSION_FEATURES) { 11519 int count = 0; 11520 ret = upgrade_enable_all(zhp, &count); 11521 if (ret != 0) 11522 return (ret); 11523 11524 if (count != 0) { 11525 modified_pool = B_TRUE; 11526 } else if (cur_version == SPA_VERSION) { 11527 (void) printf(gettext("Pool '%s' already has all " 11528 "supported and requested features enabled.\n"), 11529 zpool_get_name(zhp)); 11530 } 11531 } 11532 11533 if (modified_pool) { 11534 (void) printf("\n"); 11535 (void) after_zpool_upgrade(zhp); 11536 } 11537 11538 return (0); 11539 } 11540 11541 /* 11542 * zpool upgrade 11543 * zpool upgrade -v 11544 * zpool upgrade [-V version] <-a | pool ...> 11545 * 11546 * With no arguments, display downrev'd ZFS pool available for upgrade. 11547 * Individual pools can be upgraded by specifying the pool, and '-a' will 11548 * upgrade all pools. 11549 */ 11550 int 11551 zpool_do_upgrade(int argc, char **argv) 11552 { 11553 int c; 11554 upgrade_cbdata_t cb = { 0 }; 11555 int ret = 0; 11556 boolean_t showversions = B_FALSE; 11557 boolean_t upgradeall = B_FALSE; 11558 char *end; 11559 11560 11561 /* check options */ 11562 while ((c = getopt(argc, argv, ":avV:")) != -1) { 11563 switch (c) { 11564 case 'a': 11565 upgradeall = B_TRUE; 11566 break; 11567 case 'v': 11568 showversions = B_TRUE; 11569 break; 11570 case 'V': 11571 cb.cb_version = strtoll(optarg, &end, 10); 11572 if (*end != '\0' || 11573 !SPA_VERSION_IS_SUPPORTED(cb.cb_version)) { 11574 (void) fprintf(stderr, 11575 gettext("invalid version '%s'\n"), optarg); 11576 usage(B_FALSE); 11577 } 11578 break; 11579 case ':': 11580 (void) fprintf(stderr, gettext("missing argument for " 11581 "'%c' option\n"), optopt); 11582 usage(B_FALSE); 11583 break; 11584 case '?': 11585 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 11586 optopt); 11587 usage(B_FALSE); 11588 } 11589 } 11590 11591 cb.cb_argc = argc; 11592 cb.cb_argv = argv; 11593 argc -= optind; 11594 argv += optind; 11595 11596 if (cb.cb_version == 0) { 11597 cb.cb_version = SPA_VERSION; 11598 } else if (!upgradeall && argc == 0) { 11599 (void) fprintf(stderr, gettext("-V option is " 11600 "incompatible with other arguments\n")); 11601 usage(B_FALSE); 11602 } 11603 11604 if (showversions) { 11605 if (upgradeall || argc != 0) { 11606 (void) fprintf(stderr, gettext("-v option is " 11607 "incompatible with other arguments\n")); 11608 usage(B_FALSE); 11609 } 11610 } else if (upgradeall) { 11611 if (argc != 0) { 11612 (void) fprintf(stderr, gettext("-a option should not " 11613 "be used along with a pool name\n")); 11614 usage(B_FALSE); 11615 } 11616 } 11617 11618 (void) printf("%s", gettext("This system supports ZFS pool feature " 11619 "flags.\n\n")); 11620 if (showversions) { 11621 int i; 11622 11623 (void) printf(gettext("The following features are " 11624 "supported:\n\n")); 11625 (void) printf(gettext("FEAT DESCRIPTION\n")); 11626 (void) printf("----------------------------------------------" 11627 "---------------\n"); 11628 for (i = 0; i < SPA_FEATURES; i++) { 11629 zfeature_info_t *fi = &spa_feature_table[i]; 11630 if (!fi->fi_zfs_mod_supported) 11631 continue; 11632 const char *ro = 11633 (fi->fi_flags & ZFEATURE_FLAG_READONLY_COMPAT) ? 11634 " (read-only compatible)" : ""; 11635 11636 (void) printf("%-37s%s\n", fi->fi_uname, ro); 11637 (void) printf(" %s\n", fi->fi_desc); 11638 } 11639 (void) printf("\n"); 11640 11641 (void) printf(gettext("The following legacy versions are also " 11642 "supported:\n\n")); 11643 (void) printf(gettext("VER DESCRIPTION\n")); 11644 (void) printf("--- -----------------------------------------" 11645 "---------------\n"); 11646 (void) printf(gettext(" 1 Initial ZFS version\n")); 11647 (void) printf(gettext(" 2 Ditto blocks " 11648 "(replicated metadata)\n")); 11649 (void) printf(gettext(" 3 Hot spares and double parity " 11650 "RAID-Z\n")); 11651 (void) printf(gettext(" 4 zpool history\n")); 11652 (void) printf(gettext(" 5 Compression using the gzip " 11653 "algorithm\n")); 11654 (void) printf(gettext(" 6 bootfs pool property\n")); 11655 (void) printf(gettext(" 7 Separate intent log devices\n")); 11656 (void) printf(gettext(" 8 Delegated administration\n")); 11657 (void) printf(gettext(" 9 refquota and refreservation " 11658 "properties\n")); 11659 (void) printf(gettext(" 10 Cache devices\n")); 11660 (void) printf(gettext(" 11 Improved scrub performance\n")); 11661 (void) printf(gettext(" 12 Snapshot properties\n")); 11662 (void) printf(gettext(" 13 snapused property\n")); 11663 (void) printf(gettext(" 14 passthrough-x aclinherit\n")); 11664 (void) printf(gettext(" 15 user/group space accounting\n")); 11665 (void) printf(gettext(" 16 stmf property support\n")); 11666 (void) printf(gettext(" 17 Triple-parity RAID-Z\n")); 11667 (void) printf(gettext(" 18 Snapshot user holds\n")); 11668 (void) printf(gettext(" 19 Log device removal\n")); 11669 (void) printf(gettext(" 20 Compression using zle " 11670 "(zero-length encoding)\n")); 11671 (void) printf(gettext(" 21 Deduplication\n")); 11672 (void) printf(gettext(" 22 Received properties\n")); 11673 (void) printf(gettext(" 23 Slim ZIL\n")); 11674 (void) printf(gettext(" 24 System attributes\n")); 11675 (void) printf(gettext(" 25 Improved scrub stats\n")); 11676 (void) printf(gettext(" 26 Improved snapshot deletion " 11677 "performance\n")); 11678 (void) printf(gettext(" 27 Improved snapshot creation " 11679 "performance\n")); 11680 (void) printf(gettext(" 28 Multiple vdev replacements\n")); 11681 (void) printf(gettext("\nFor more information on a particular " 11682 "version, including supported releases,\n")); 11683 (void) printf(gettext("see the ZFS Administration Guide.\n\n")); 11684 } else if (argc == 0 && upgradeall) { 11685 cb.cb_first = B_TRUE; 11686 ret = zpool_iter(g_zfs, upgrade_cb, &cb); 11687 if (ret == 0 && cb.cb_first) { 11688 if (cb.cb_version == SPA_VERSION) { 11689 (void) printf(gettext("All pools are already " 11690 "formatted using feature flags.\n\n")); 11691 (void) printf(gettext("Every feature flags " 11692 "pool already has all supported and " 11693 "requested features enabled.\n")); 11694 } else { 11695 (void) printf(gettext("All pools are already " 11696 "formatted with version %llu or higher.\n"), 11697 (u_longlong_t)cb.cb_version); 11698 } 11699 } 11700 } else if (argc == 0) { 11701 cb.cb_first = B_TRUE; 11702 ret = zpool_iter(g_zfs, upgrade_list_older_cb, &cb); 11703 assert(ret == 0); 11704 11705 if (cb.cb_first) { 11706 (void) printf(gettext("All pools are formatted " 11707 "using feature flags.\n\n")); 11708 } else { 11709 (void) printf(gettext("\nUse 'zpool upgrade -v' " 11710 "for a list of available legacy versions.\n")); 11711 } 11712 11713 cb.cb_first = B_TRUE; 11714 ret = zpool_iter(g_zfs, upgrade_list_disabled_cb, &cb); 11715 assert(ret == 0); 11716 11717 if (cb.cb_first) { 11718 (void) printf(gettext("Every feature flags pool has " 11719 "all supported and requested features enabled.\n")); 11720 } else { 11721 (void) printf(gettext("\n")); 11722 } 11723 } else { 11724 ret = for_each_pool(argc, argv, B_FALSE, NULL, ZFS_TYPE_POOL, 11725 B_FALSE, upgrade_one, &cb); 11726 } 11727 11728 return (ret); 11729 } 11730 11731 typedef struct hist_cbdata { 11732 boolean_t first; 11733 boolean_t longfmt; 11734 boolean_t internal; 11735 } hist_cbdata_t; 11736 11737 static void 11738 print_history_records(nvlist_t *nvhis, hist_cbdata_t *cb) 11739 { 11740 nvlist_t **records; 11741 uint_t numrecords; 11742 int i; 11743 11744 verify(nvlist_lookup_nvlist_array(nvhis, ZPOOL_HIST_RECORD, 11745 &records, &numrecords) == 0); 11746 for (i = 0; i < numrecords; i++) { 11747 nvlist_t *rec = records[i]; 11748 char tbuf[64] = ""; 11749 11750 if (nvlist_exists(rec, ZPOOL_HIST_TIME)) { 11751 time_t tsec; 11752 struct tm t; 11753 11754 tsec = fnvlist_lookup_uint64(records[i], 11755 ZPOOL_HIST_TIME); 11756 (void) localtime_r(&tsec, &t); 11757 (void) strftime(tbuf, sizeof (tbuf), "%F.%T", &t); 11758 } 11759 11760 if (nvlist_exists(rec, ZPOOL_HIST_ELAPSED_NS)) { 11761 uint64_t elapsed_ns = fnvlist_lookup_int64(records[i], 11762 ZPOOL_HIST_ELAPSED_NS); 11763 (void) snprintf(tbuf + strlen(tbuf), 11764 sizeof (tbuf) - strlen(tbuf), 11765 " (%lldms)", (long long)elapsed_ns / 1000 / 1000); 11766 } 11767 11768 if (nvlist_exists(rec, ZPOOL_HIST_CMD)) { 11769 (void) printf("%s %s", tbuf, 11770 fnvlist_lookup_string(rec, ZPOOL_HIST_CMD)); 11771 } else if (nvlist_exists(rec, ZPOOL_HIST_INT_EVENT)) { 11772 int ievent = 11773 fnvlist_lookup_uint64(rec, ZPOOL_HIST_INT_EVENT); 11774 if (!cb->internal) 11775 continue; 11776 if (ievent >= ZFS_NUM_LEGACY_HISTORY_EVENTS) { 11777 (void) printf("%s unrecognized record:\n", 11778 tbuf); 11779 dump_nvlist(rec, 4); 11780 continue; 11781 } 11782 (void) printf("%s [internal %s txg:%lld] %s", tbuf, 11783 zfs_history_event_names[ievent], 11784 (longlong_t)fnvlist_lookup_uint64( 11785 rec, ZPOOL_HIST_TXG), 11786 fnvlist_lookup_string(rec, ZPOOL_HIST_INT_STR)); 11787 } else if (nvlist_exists(rec, ZPOOL_HIST_INT_NAME)) { 11788 if (!cb->internal) 11789 continue; 11790 (void) printf("%s [txg:%lld] %s", tbuf, 11791 (longlong_t)fnvlist_lookup_uint64( 11792 rec, ZPOOL_HIST_TXG), 11793 fnvlist_lookup_string(rec, ZPOOL_HIST_INT_NAME)); 11794 if (nvlist_exists(rec, ZPOOL_HIST_DSNAME)) { 11795 (void) printf(" %s (%llu)", 11796 fnvlist_lookup_string(rec, 11797 ZPOOL_HIST_DSNAME), 11798 (u_longlong_t)fnvlist_lookup_uint64(rec, 11799 ZPOOL_HIST_DSID)); 11800 } 11801 (void) printf(" %s", fnvlist_lookup_string(rec, 11802 ZPOOL_HIST_INT_STR)); 11803 } else if (nvlist_exists(rec, ZPOOL_HIST_IOCTL)) { 11804 if (!cb->internal) 11805 continue; 11806 (void) printf("%s ioctl %s\n", tbuf, 11807 fnvlist_lookup_string(rec, ZPOOL_HIST_IOCTL)); 11808 if (nvlist_exists(rec, ZPOOL_HIST_INPUT_NVL)) { 11809 (void) printf(" input:\n"); 11810 dump_nvlist(fnvlist_lookup_nvlist(rec, 11811 ZPOOL_HIST_INPUT_NVL), 8); 11812 } 11813 if (nvlist_exists(rec, ZPOOL_HIST_OUTPUT_NVL)) { 11814 (void) printf(" output:\n"); 11815 dump_nvlist(fnvlist_lookup_nvlist(rec, 11816 ZPOOL_HIST_OUTPUT_NVL), 8); 11817 } 11818 if (nvlist_exists(rec, ZPOOL_HIST_OUTPUT_SIZE)) { 11819 (void) printf(" output nvlist omitted; " 11820 "original size: %lldKB\n", 11821 (longlong_t)fnvlist_lookup_int64(rec, 11822 ZPOOL_HIST_OUTPUT_SIZE) / 1024); 11823 } 11824 if (nvlist_exists(rec, ZPOOL_HIST_ERRNO)) { 11825 (void) printf(" errno: %lld\n", 11826 (longlong_t)fnvlist_lookup_int64(rec, 11827 ZPOOL_HIST_ERRNO)); 11828 } 11829 } else { 11830 if (!cb->internal) 11831 continue; 11832 (void) printf("%s unrecognized record:\n", tbuf); 11833 dump_nvlist(rec, 4); 11834 } 11835 11836 if (!cb->longfmt) { 11837 (void) printf("\n"); 11838 continue; 11839 } 11840 (void) printf(" ["); 11841 if (nvlist_exists(rec, ZPOOL_HIST_WHO)) { 11842 uid_t who = fnvlist_lookup_uint64(rec, ZPOOL_HIST_WHO); 11843 struct passwd *pwd = getpwuid(who); 11844 (void) printf("user %d ", (int)who); 11845 if (pwd != NULL) 11846 (void) printf("(%s) ", pwd->pw_name); 11847 } 11848 if (nvlist_exists(rec, ZPOOL_HIST_HOST)) { 11849 (void) printf("on %s", 11850 fnvlist_lookup_string(rec, ZPOOL_HIST_HOST)); 11851 } 11852 if (nvlist_exists(rec, ZPOOL_HIST_ZONE)) { 11853 (void) printf(":%s", 11854 fnvlist_lookup_string(rec, ZPOOL_HIST_ZONE)); 11855 } 11856 11857 (void) printf("]"); 11858 (void) printf("\n"); 11859 } 11860 } 11861 11862 /* 11863 * Print out the command history for a specific pool. 11864 */ 11865 static int 11866 get_history_one(zpool_handle_t *zhp, void *data) 11867 { 11868 nvlist_t *nvhis; 11869 int ret; 11870 hist_cbdata_t *cb = (hist_cbdata_t *)data; 11871 uint64_t off = 0; 11872 boolean_t eof = B_FALSE; 11873 11874 cb->first = B_FALSE; 11875 11876 (void) printf(gettext("History for '%s':\n"), zpool_get_name(zhp)); 11877 11878 while (!eof) { 11879 if ((ret = zpool_get_history(zhp, &nvhis, &off, &eof)) != 0) 11880 return (ret); 11881 11882 print_history_records(nvhis, cb); 11883 nvlist_free(nvhis); 11884 } 11885 (void) printf("\n"); 11886 11887 return (ret); 11888 } 11889 11890 /* 11891 * zpool history <pool> 11892 * 11893 * Displays the history of commands that modified pools. 11894 */ 11895 int 11896 zpool_do_history(int argc, char **argv) 11897 { 11898 hist_cbdata_t cbdata = { 0 }; 11899 int ret; 11900 int c; 11901 11902 cbdata.first = B_TRUE; 11903 /* check options */ 11904 while ((c = getopt(argc, argv, "li")) != -1) { 11905 switch (c) { 11906 case 'l': 11907 cbdata.longfmt = B_TRUE; 11908 break; 11909 case 'i': 11910 cbdata.internal = B_TRUE; 11911 break; 11912 case '?': 11913 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 11914 optopt); 11915 usage(B_FALSE); 11916 } 11917 } 11918 argc -= optind; 11919 argv += optind; 11920 11921 ret = for_each_pool(argc, argv, B_FALSE, NULL, ZFS_TYPE_POOL, 11922 B_FALSE, get_history_one, &cbdata); 11923 11924 if (argc == 0 && cbdata.first == B_TRUE) { 11925 (void) fprintf(stderr, gettext("no pools available\n")); 11926 return (0); 11927 } 11928 11929 return (ret); 11930 } 11931 11932 typedef struct ev_opts { 11933 int verbose; 11934 int scripted; 11935 int follow; 11936 int clear; 11937 char poolname[ZFS_MAX_DATASET_NAME_LEN]; 11938 } ev_opts_t; 11939 11940 static void 11941 zpool_do_events_short(nvlist_t *nvl, ev_opts_t *opts) 11942 { 11943 char ctime_str[26], str[32]; 11944 const char *ptr; 11945 int64_t *tv; 11946 uint_t n; 11947 11948 verify(nvlist_lookup_int64_array(nvl, FM_EREPORT_TIME, &tv, &n) == 0); 11949 memset(str, ' ', 32); 11950 (void) ctime_r((const time_t *)&tv[0], ctime_str); 11951 (void) memcpy(str, ctime_str+4, 6); /* 'Jun 30' */ 11952 (void) memcpy(str+7, ctime_str+20, 4); /* '1993' */ 11953 (void) memcpy(str+12, ctime_str+11, 8); /* '21:49:08' */ 11954 (void) sprintf(str+20, ".%09lld", (longlong_t)tv[1]); /* '.123456789' */ 11955 if (opts->scripted) 11956 (void) printf(gettext("%s\t"), str); 11957 else 11958 (void) printf(gettext("%s "), str); 11959 11960 verify(nvlist_lookup_string(nvl, FM_CLASS, &ptr) == 0); 11961 (void) printf(gettext("%s\n"), ptr); 11962 } 11963 11964 static void 11965 zpool_do_events_nvprint(nvlist_t *nvl, int depth) 11966 { 11967 nvpair_t *nvp; 11968 static char flagstr[256]; 11969 11970 for (nvp = nvlist_next_nvpair(nvl, NULL); 11971 nvp != NULL; nvp = nvlist_next_nvpair(nvl, nvp)) { 11972 11973 data_type_t type = nvpair_type(nvp); 11974 const char *name = nvpair_name(nvp); 11975 11976 boolean_t b; 11977 uint8_t i8; 11978 uint16_t i16; 11979 uint32_t i32; 11980 uint64_t i64; 11981 const char *str; 11982 nvlist_t *cnv; 11983 11984 printf(gettext("%*s%s = "), depth, "", name); 11985 11986 switch (type) { 11987 case DATA_TYPE_BOOLEAN: 11988 printf(gettext("%s"), "1"); 11989 break; 11990 11991 case DATA_TYPE_BOOLEAN_VALUE: 11992 (void) nvpair_value_boolean_value(nvp, &b); 11993 printf(gettext("%s"), b ? "1" : "0"); 11994 break; 11995 11996 case DATA_TYPE_BYTE: 11997 (void) nvpair_value_byte(nvp, &i8); 11998 printf(gettext("0x%x"), i8); 11999 break; 12000 12001 case DATA_TYPE_INT8: 12002 (void) nvpair_value_int8(nvp, (void *)&i8); 12003 printf(gettext("0x%x"), i8); 12004 break; 12005 12006 case DATA_TYPE_UINT8: 12007 (void) nvpair_value_uint8(nvp, &i8); 12008 printf(gettext("0x%x"), i8); 12009 break; 12010 12011 case DATA_TYPE_INT16: 12012 (void) nvpair_value_int16(nvp, (void *)&i16); 12013 printf(gettext("0x%x"), i16); 12014 break; 12015 12016 case DATA_TYPE_UINT16: 12017 (void) nvpair_value_uint16(nvp, &i16); 12018 printf(gettext("0x%x"), i16); 12019 break; 12020 12021 case DATA_TYPE_INT32: 12022 (void) nvpair_value_int32(nvp, (void *)&i32); 12023 printf(gettext("0x%x"), i32); 12024 break; 12025 12026 case DATA_TYPE_UINT32: 12027 (void) nvpair_value_uint32(nvp, &i32); 12028 if (strcmp(name, 12029 FM_EREPORT_PAYLOAD_ZFS_ZIO_STAGE) == 0 || 12030 strcmp(name, 12031 FM_EREPORT_PAYLOAD_ZFS_ZIO_PIPELINE) == 0) { 12032 zfs_valstr_zio_stage(i32, flagstr, 12033 sizeof (flagstr)); 12034 printf(gettext("0x%x [%s]"), i32, flagstr); 12035 } else if (strcmp(name, 12036 FM_EREPORT_PAYLOAD_ZFS_ZIO_PRIORITY) == 0) { 12037 zfs_valstr_zio_priority(i32, flagstr, 12038 sizeof (flagstr)); 12039 printf(gettext("0x%x [%s]"), i32, flagstr); 12040 } else { 12041 printf(gettext("0x%x"), i32); 12042 } 12043 break; 12044 12045 case DATA_TYPE_INT64: 12046 (void) nvpair_value_int64(nvp, (void *)&i64); 12047 printf(gettext("0x%llx"), (u_longlong_t)i64); 12048 break; 12049 12050 case DATA_TYPE_UINT64: 12051 (void) nvpair_value_uint64(nvp, &i64); 12052 /* 12053 * translate vdev state values to readable 12054 * strings to aide zpool events consumers 12055 */ 12056 if (strcmp(name, 12057 FM_EREPORT_PAYLOAD_ZFS_VDEV_STATE) == 0 || 12058 strcmp(name, 12059 FM_EREPORT_PAYLOAD_ZFS_VDEV_LASTSTATE) == 0) { 12060 printf(gettext("\"%s\" (0x%llx)"), 12061 zpool_state_to_name(i64, VDEV_AUX_NONE), 12062 (u_longlong_t)i64); 12063 } else if (strcmp(name, 12064 FM_EREPORT_PAYLOAD_ZFS_ZIO_FLAGS) == 0) { 12065 zfs_valstr_zio_flag(i64, flagstr, 12066 sizeof (flagstr)); 12067 printf(gettext("0x%llx [%s]"), 12068 (u_longlong_t)i64, flagstr); 12069 } else { 12070 printf(gettext("0x%llx"), (u_longlong_t)i64); 12071 } 12072 break; 12073 12074 case DATA_TYPE_HRTIME: 12075 (void) nvpair_value_hrtime(nvp, (void *)&i64); 12076 printf(gettext("0x%llx"), (u_longlong_t)i64); 12077 break; 12078 12079 case DATA_TYPE_STRING: 12080 (void) nvpair_value_string(nvp, &str); 12081 printf(gettext("\"%s\""), str ? str : "<NULL>"); 12082 break; 12083 12084 case DATA_TYPE_NVLIST: 12085 printf(gettext("(embedded nvlist)\n")); 12086 (void) nvpair_value_nvlist(nvp, &cnv); 12087 zpool_do_events_nvprint(cnv, depth + 8); 12088 printf(gettext("%*s(end %s)"), depth, "", name); 12089 break; 12090 12091 case DATA_TYPE_NVLIST_ARRAY: { 12092 nvlist_t **val; 12093 uint_t i, nelem; 12094 12095 (void) nvpair_value_nvlist_array(nvp, &val, &nelem); 12096 printf(gettext("(%d embedded nvlists)\n"), nelem); 12097 for (i = 0; i < nelem; i++) { 12098 printf(gettext("%*s%s[%d] = %s\n"), 12099 depth, "", name, i, "(embedded nvlist)"); 12100 zpool_do_events_nvprint(val[i], depth + 8); 12101 printf(gettext("%*s(end %s[%i])\n"), 12102 depth, "", name, i); 12103 } 12104 printf(gettext("%*s(end %s)\n"), depth, "", name); 12105 } 12106 break; 12107 12108 case DATA_TYPE_INT8_ARRAY: { 12109 int8_t *val; 12110 uint_t i, nelem; 12111 12112 (void) nvpair_value_int8_array(nvp, &val, &nelem); 12113 for (i = 0; i < nelem; i++) 12114 printf(gettext("0x%x "), val[i]); 12115 12116 break; 12117 } 12118 12119 case DATA_TYPE_UINT8_ARRAY: { 12120 uint8_t *val; 12121 uint_t i, nelem; 12122 12123 (void) nvpair_value_uint8_array(nvp, &val, &nelem); 12124 for (i = 0; i < nelem; i++) 12125 printf(gettext("0x%x "), val[i]); 12126 12127 break; 12128 } 12129 12130 case DATA_TYPE_INT16_ARRAY: { 12131 int16_t *val; 12132 uint_t i, nelem; 12133 12134 (void) nvpair_value_int16_array(nvp, &val, &nelem); 12135 for (i = 0; i < nelem; i++) 12136 printf(gettext("0x%x "), val[i]); 12137 12138 break; 12139 } 12140 12141 case DATA_TYPE_UINT16_ARRAY: { 12142 uint16_t *val; 12143 uint_t i, nelem; 12144 12145 (void) nvpair_value_uint16_array(nvp, &val, &nelem); 12146 for (i = 0; i < nelem; i++) 12147 printf(gettext("0x%x "), val[i]); 12148 12149 break; 12150 } 12151 12152 case DATA_TYPE_INT32_ARRAY: { 12153 int32_t *val; 12154 uint_t i, nelem; 12155 12156 (void) nvpair_value_int32_array(nvp, &val, &nelem); 12157 for (i = 0; i < nelem; i++) 12158 printf(gettext("0x%x "), val[i]); 12159 12160 break; 12161 } 12162 12163 case DATA_TYPE_UINT32_ARRAY: { 12164 uint32_t *val; 12165 uint_t i, nelem; 12166 12167 (void) nvpair_value_uint32_array(nvp, &val, &nelem); 12168 for (i = 0; i < nelem; i++) 12169 printf(gettext("0x%x "), val[i]); 12170 12171 break; 12172 } 12173 12174 case DATA_TYPE_INT64_ARRAY: { 12175 int64_t *val; 12176 uint_t i, nelem; 12177 12178 (void) nvpair_value_int64_array(nvp, &val, &nelem); 12179 for (i = 0; i < nelem; i++) 12180 printf(gettext("0x%llx "), 12181 (u_longlong_t)val[i]); 12182 12183 break; 12184 } 12185 12186 case DATA_TYPE_UINT64_ARRAY: { 12187 uint64_t *val; 12188 uint_t i, nelem; 12189 12190 (void) nvpair_value_uint64_array(nvp, &val, &nelem); 12191 for (i = 0; i < nelem; i++) 12192 printf(gettext("0x%llx "), 12193 (u_longlong_t)val[i]); 12194 12195 break; 12196 } 12197 12198 case DATA_TYPE_STRING_ARRAY: { 12199 const char **str; 12200 uint_t i, nelem; 12201 12202 (void) nvpair_value_string_array(nvp, &str, &nelem); 12203 for (i = 0; i < nelem; i++) 12204 printf(gettext("\"%s\" "), 12205 str[i] ? str[i] : "<NULL>"); 12206 12207 break; 12208 } 12209 12210 case DATA_TYPE_BOOLEAN_ARRAY: 12211 case DATA_TYPE_BYTE_ARRAY: 12212 case DATA_TYPE_DOUBLE: 12213 case DATA_TYPE_DONTCARE: 12214 case DATA_TYPE_UNKNOWN: 12215 printf(gettext("<unknown>")); 12216 break; 12217 } 12218 12219 printf(gettext("\n")); 12220 } 12221 } 12222 12223 static int 12224 zpool_do_events_next(ev_opts_t *opts) 12225 { 12226 nvlist_t *nvl; 12227 int zevent_fd, ret, dropped; 12228 const char *pool; 12229 12230 zevent_fd = open(ZFS_DEV, O_RDWR); 12231 VERIFY(zevent_fd >= 0); 12232 12233 if (!opts->scripted) 12234 (void) printf(gettext("%-30s %s\n"), "TIME", "CLASS"); 12235 12236 while (1) { 12237 ret = zpool_events_next(g_zfs, &nvl, &dropped, 12238 (opts->follow ? ZEVENT_NONE : ZEVENT_NONBLOCK), zevent_fd); 12239 if (ret || nvl == NULL) 12240 break; 12241 12242 if (dropped > 0) 12243 (void) printf(gettext("dropped %d events\n"), dropped); 12244 12245 if (strlen(opts->poolname) > 0 && 12246 nvlist_lookup_string(nvl, FM_FMRI_ZFS_POOL, &pool) == 0 && 12247 strcmp(opts->poolname, pool) != 0) 12248 continue; 12249 12250 zpool_do_events_short(nvl, opts); 12251 12252 if (opts->verbose) { 12253 zpool_do_events_nvprint(nvl, 8); 12254 printf(gettext("\n")); 12255 } 12256 (void) fflush(stdout); 12257 12258 nvlist_free(nvl); 12259 } 12260 12261 VERIFY(0 == close(zevent_fd)); 12262 12263 return (ret); 12264 } 12265 12266 static int 12267 zpool_do_events_clear(void) 12268 { 12269 int count, ret; 12270 12271 ret = zpool_events_clear(g_zfs, &count); 12272 if (!ret) 12273 (void) printf(gettext("cleared %d events\n"), count); 12274 12275 return (ret); 12276 } 12277 12278 /* 12279 * zpool events [-vHf [pool] | -c] 12280 * 12281 * Displays events logs by ZFS. 12282 */ 12283 int 12284 zpool_do_events(int argc, char **argv) 12285 { 12286 ev_opts_t opts = { 0 }; 12287 int ret; 12288 int c; 12289 12290 /* check options */ 12291 while ((c = getopt(argc, argv, "vHfc")) != -1) { 12292 switch (c) { 12293 case 'v': 12294 opts.verbose = 1; 12295 break; 12296 case 'H': 12297 opts.scripted = 1; 12298 break; 12299 case 'f': 12300 opts.follow = 1; 12301 break; 12302 case 'c': 12303 opts.clear = 1; 12304 break; 12305 case '?': 12306 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 12307 optopt); 12308 usage(B_FALSE); 12309 } 12310 } 12311 argc -= optind; 12312 argv += optind; 12313 12314 if (argc > 1) { 12315 (void) fprintf(stderr, gettext("too many arguments\n")); 12316 usage(B_FALSE); 12317 } else if (argc == 1) { 12318 (void) strlcpy(opts.poolname, argv[0], sizeof (opts.poolname)); 12319 if (!zfs_name_valid(opts.poolname, ZFS_TYPE_POOL)) { 12320 (void) fprintf(stderr, 12321 gettext("invalid pool name '%s'\n"), opts.poolname); 12322 usage(B_FALSE); 12323 } 12324 } 12325 12326 if ((argc == 1 || opts.verbose || opts.scripted || opts.follow) && 12327 opts.clear) { 12328 (void) fprintf(stderr, 12329 gettext("invalid options combined with -c\n")); 12330 usage(B_FALSE); 12331 } 12332 12333 if (opts.clear) 12334 ret = zpool_do_events_clear(); 12335 else 12336 ret = zpool_do_events_next(&opts); 12337 12338 return (ret); 12339 } 12340 12341 static int 12342 get_callback_vdev(zpool_handle_t *zhp, char *vdevname, void *data) 12343 { 12344 zprop_get_cbdata_t *cbp = (zprop_get_cbdata_t *)data; 12345 char value[ZFS_MAXPROPLEN]; 12346 zprop_source_t srctype; 12347 nvlist_t *props, *item, *d; 12348 props = item = d = NULL; 12349 12350 if (cbp->cb_json) { 12351 d = fnvlist_lookup_nvlist(cbp->cb_jsobj, "vdevs"); 12352 if (d == NULL) { 12353 fprintf(stderr, "vdevs obj not found.\n"); 12354 exit(1); 12355 } 12356 props = fnvlist_alloc(); 12357 } 12358 12359 for (zprop_list_t *pl = cbp->cb_proplist; pl != NULL; 12360 pl = pl->pl_next) { 12361 char *prop_name; 12362 /* 12363 * If the first property is pool name, it is a special 12364 * placeholder that we can skip. This will also skip 12365 * over the name property when 'all' is specified. 12366 */ 12367 if (pl->pl_prop == ZPOOL_PROP_NAME && 12368 pl == cbp->cb_proplist) 12369 continue; 12370 12371 if (pl->pl_prop == ZPROP_INVAL) { 12372 prop_name = pl->pl_user_prop; 12373 } else { 12374 prop_name = (char *)vdev_prop_to_name(pl->pl_prop); 12375 } 12376 if (zpool_get_vdev_prop(zhp, vdevname, pl->pl_prop, 12377 prop_name, value, sizeof (value), &srctype, 12378 cbp->cb_literal) == 0) { 12379 zprop_collect_property(vdevname, cbp, prop_name, 12380 value, srctype, NULL, NULL, props); 12381 } 12382 } 12383 12384 if (cbp->cb_json) { 12385 if (!nvlist_empty(props)) { 12386 item = fnvlist_alloc(); 12387 fill_vdev_info(item, zhp, vdevname, B_TRUE, 12388 cbp->cb_json_as_int); 12389 fnvlist_add_nvlist(item, "properties", props); 12390 fnvlist_add_nvlist(d, vdevname, item); 12391 fnvlist_add_nvlist(cbp->cb_jsobj, "vdevs", d); 12392 fnvlist_free(item); 12393 } 12394 fnvlist_free(props); 12395 } 12396 12397 return (0); 12398 } 12399 12400 static int 12401 get_callback_vdev_cb(void *zhp_data, nvlist_t *nv, void *data) 12402 { 12403 zpool_handle_t *zhp = zhp_data; 12404 zprop_get_cbdata_t *cbp = (zprop_get_cbdata_t *)data; 12405 char *vdevname; 12406 const char *type; 12407 int ret; 12408 12409 /* 12410 * zpool_vdev_name() transforms the root vdev name (i.e., root-0) to the 12411 * pool name for display purposes, which is not desired. Fallback to 12412 * zpool_vdev_name() when not dealing with the root vdev. 12413 */ 12414 type = fnvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE); 12415 if (zhp != NULL && strcmp(type, "root") == 0) 12416 vdevname = strdup("root-0"); 12417 else 12418 vdevname = zpool_vdev_name(g_zfs, zhp, nv, 12419 cbp->cb_vdevs.cb_name_flags); 12420 12421 (void) vdev_expand_proplist(zhp, vdevname, &cbp->cb_proplist); 12422 12423 ret = get_callback_vdev(zhp, vdevname, data); 12424 12425 free(vdevname); 12426 12427 return (ret); 12428 } 12429 12430 static int 12431 get_callback(zpool_handle_t *zhp, void *data) 12432 { 12433 zprop_get_cbdata_t *cbp = (zprop_get_cbdata_t *)data; 12434 char value[ZFS_MAXPROPLEN]; 12435 zprop_source_t srctype; 12436 zprop_list_t *pl; 12437 int vid; 12438 int err = 0; 12439 nvlist_t *props, *item, *d; 12440 props = item = d = NULL; 12441 12442 if (cbp->cb_type == ZFS_TYPE_VDEV) { 12443 if (cbp->cb_json) { 12444 nvlist_t *pool = fnvlist_alloc(); 12445 fill_pool_info(pool, zhp, B_FALSE, cbp->cb_json_as_int); 12446 fnvlist_add_nvlist(cbp->cb_jsobj, "pool", pool); 12447 fnvlist_free(pool); 12448 } 12449 12450 if (strcmp(cbp->cb_vdevs.cb_names[0], "all-vdevs") == 0) { 12451 for_each_vdev(zhp, get_callback_vdev_cb, data); 12452 } else { 12453 /* Adjust column widths for vdev properties */ 12454 for (vid = 0; vid < cbp->cb_vdevs.cb_names_count; 12455 vid++) { 12456 vdev_expand_proplist(zhp, 12457 cbp->cb_vdevs.cb_names[vid], 12458 &cbp->cb_proplist); 12459 } 12460 /* Display the properties */ 12461 for (vid = 0; vid < cbp->cb_vdevs.cb_names_count; 12462 vid++) { 12463 get_callback_vdev(zhp, 12464 cbp->cb_vdevs.cb_names[vid], data); 12465 } 12466 } 12467 } else { 12468 assert(cbp->cb_type == ZFS_TYPE_POOL); 12469 if (cbp->cb_json) { 12470 d = fnvlist_lookup_nvlist(cbp->cb_jsobj, "pools"); 12471 if (d == NULL) { 12472 fprintf(stderr, "pools obj not found.\n"); 12473 exit(1); 12474 } 12475 props = fnvlist_alloc(); 12476 } 12477 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) { 12478 /* 12479 * Skip the special fake placeholder. This will also 12480 * skip over the name property when 'all' is specified. 12481 */ 12482 if (pl->pl_prop == ZPOOL_PROP_NAME && 12483 pl == cbp->cb_proplist) 12484 continue; 12485 12486 if (pl->pl_prop == ZPROP_INVAL && 12487 zfs_prop_user(pl->pl_user_prop)) { 12488 srctype = ZPROP_SRC_LOCAL; 12489 12490 if (zpool_get_userprop(zhp, pl->pl_user_prop, 12491 value, sizeof (value), &srctype) != 0) 12492 continue; 12493 12494 err = zprop_collect_property( 12495 zpool_get_name(zhp), cbp, pl->pl_user_prop, 12496 value, srctype, NULL, NULL, props); 12497 } else if (pl->pl_prop == ZPROP_INVAL && 12498 (zpool_prop_feature(pl->pl_user_prop) || 12499 zpool_prop_unsupported(pl->pl_user_prop))) { 12500 srctype = ZPROP_SRC_LOCAL; 12501 12502 if (zpool_prop_get_feature(zhp, 12503 pl->pl_user_prop, value, 12504 sizeof (value)) == 0) { 12505 err = zprop_collect_property( 12506 zpool_get_name(zhp), cbp, 12507 pl->pl_user_prop, value, srctype, 12508 NULL, NULL, props); 12509 } 12510 } else { 12511 if (zpool_get_prop(zhp, pl->pl_prop, value, 12512 sizeof (value), &srctype, 12513 cbp->cb_literal) != 0) 12514 continue; 12515 12516 err = zprop_collect_property( 12517 zpool_get_name(zhp), cbp, 12518 zpool_prop_to_name(pl->pl_prop), 12519 value, srctype, NULL, NULL, props); 12520 } 12521 if (err != 0) 12522 return (err); 12523 } 12524 12525 if (cbp->cb_json) { 12526 if (!nvlist_empty(props)) { 12527 item = fnvlist_alloc(); 12528 fill_pool_info(item, zhp, B_TRUE, 12529 cbp->cb_json_as_int); 12530 fnvlist_add_nvlist(item, "properties", props); 12531 if (cbp->cb_json_pool_key_guid) { 12532 char buf[256]; 12533 uint64_t guid = fnvlist_lookup_uint64( 12534 zpool_get_config(zhp, NULL), 12535 ZPOOL_CONFIG_POOL_GUID); 12536 snprintf(buf, 256, "%llu", 12537 (u_longlong_t)guid); 12538 fnvlist_add_nvlist(d, buf, item); 12539 } else { 12540 const char *name = zpool_get_name(zhp); 12541 fnvlist_add_nvlist(d, name, item); 12542 } 12543 fnvlist_add_nvlist(cbp->cb_jsobj, "pools", d); 12544 fnvlist_free(item); 12545 } 12546 fnvlist_free(props); 12547 } 12548 } 12549 12550 return (0); 12551 } 12552 12553 /* 12554 * zpool get [-Hp] [-o "all" | field[,...]] <"all" | property[,...]> <pool> ... 12555 * 12556 * -H Scripted mode. Don't display headers, and separate properties 12557 * by a single tab. 12558 * -o List of columns to display. Defaults to 12559 * "name,property,value,source". 12560 * -p Display values in parsable (exact) format. 12561 * -j Display output in JSON format. 12562 * --json-int Display numbers as integers instead of strings. 12563 * --json-pool-key-guid Set pool GUID as key for pool objects. 12564 * 12565 * Get properties of pools in the system. Output space statistics 12566 * for each one as well as other attributes. 12567 */ 12568 int 12569 zpool_do_get(int argc, char **argv) 12570 { 12571 zprop_get_cbdata_t cb = { 0 }; 12572 zprop_list_t fake_name = { 0 }; 12573 int ret; 12574 int c, i; 12575 char *propstr = NULL; 12576 char *vdev = NULL; 12577 nvlist_t *data = NULL; 12578 12579 cb.cb_first = B_TRUE; 12580 12581 /* 12582 * Set up default columns and sources. 12583 */ 12584 cb.cb_sources = ZPROP_SRC_ALL; 12585 cb.cb_columns[0] = GET_COL_NAME; 12586 cb.cb_columns[1] = GET_COL_PROPERTY; 12587 cb.cb_columns[2] = GET_COL_VALUE; 12588 cb.cb_columns[3] = GET_COL_SOURCE; 12589 cb.cb_type = ZFS_TYPE_POOL; 12590 cb.cb_vdevs.cb_name_flags |= VDEV_NAME_TYPE_ID; 12591 current_prop_type = cb.cb_type; 12592 12593 struct option long_options[] = { 12594 {"json", no_argument, NULL, 'j'}, 12595 {"json-int", no_argument, NULL, ZPOOL_OPTION_JSON_NUMS_AS_INT}, 12596 {"json-pool-key-guid", no_argument, NULL, 12597 ZPOOL_OPTION_POOL_KEY_GUID}, 12598 {0, 0, 0, 0} 12599 }; 12600 12601 /* check options */ 12602 while ((c = getopt_long(argc, argv, ":jHpo:", long_options, 12603 NULL)) != -1) { 12604 switch (c) { 12605 case 'p': 12606 cb.cb_literal = B_TRUE; 12607 break; 12608 case 'H': 12609 cb.cb_scripted = B_TRUE; 12610 break; 12611 case 'j': 12612 cb.cb_json = B_TRUE; 12613 cb.cb_jsobj = zpool_json_schema(0, 1); 12614 data = fnvlist_alloc(); 12615 break; 12616 case ZPOOL_OPTION_POOL_KEY_GUID: 12617 cb.cb_json_pool_key_guid = B_TRUE; 12618 break; 12619 case ZPOOL_OPTION_JSON_NUMS_AS_INT: 12620 cb.cb_json_as_int = B_TRUE; 12621 cb.cb_literal = B_TRUE; 12622 break; 12623 case 'o': 12624 memset(&cb.cb_columns, 0, sizeof (cb.cb_columns)); 12625 i = 0; 12626 12627 for (char *tok; (tok = strsep(&optarg, ",")); ) { 12628 static const char *const col_opts[] = 12629 { "name", "property", "value", "source", 12630 "all" }; 12631 static const zfs_get_column_t col_cols[] = 12632 { GET_COL_NAME, GET_COL_PROPERTY, GET_COL_VALUE, 12633 GET_COL_SOURCE }; 12634 12635 if (i == ZFS_GET_NCOLS - 1) { 12636 (void) fprintf(stderr, gettext("too " 12637 "many fields given to -o " 12638 "option\n")); 12639 usage(B_FALSE); 12640 } 12641 12642 for (c = 0; c < ARRAY_SIZE(col_opts); ++c) 12643 if (strcmp(tok, col_opts[c]) == 0) 12644 goto found; 12645 12646 (void) fprintf(stderr, 12647 gettext("invalid column name '%s'\n"), tok); 12648 usage(B_FALSE); 12649 12650 found: 12651 if (c >= 4) { 12652 if (i > 0) { 12653 (void) fprintf(stderr, 12654 gettext("\"all\" conflicts " 12655 "with specific fields " 12656 "given to -o option\n")); 12657 usage(B_FALSE); 12658 } 12659 12660 memcpy(cb.cb_columns, col_cols, 12661 sizeof (col_cols)); 12662 i = ZFS_GET_NCOLS - 1; 12663 } else 12664 cb.cb_columns[i++] = col_cols[c]; 12665 } 12666 break; 12667 case '?': 12668 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 12669 optopt); 12670 usage(B_FALSE); 12671 } 12672 } 12673 12674 argc -= optind; 12675 argv += optind; 12676 12677 if (!cb.cb_json && cb.cb_json_as_int) { 12678 (void) fprintf(stderr, gettext("'--json-int' only works with" 12679 " '-j' option\n")); 12680 usage(B_FALSE); 12681 } 12682 12683 if (!cb.cb_json && cb.cb_json_pool_key_guid) { 12684 (void) fprintf(stderr, gettext("'json-pool-key-guid' only" 12685 " works with '-j' option\n")); 12686 usage(B_FALSE); 12687 } 12688 12689 if (argc < 1) { 12690 (void) fprintf(stderr, gettext("missing property " 12691 "argument\n")); 12692 usage(B_FALSE); 12693 } 12694 12695 /* Properties list is needed later by zprop_get_list() */ 12696 propstr = argv[0]; 12697 12698 argc--; 12699 argv++; 12700 12701 if (argc == 0) { 12702 /* No args, so just print the defaults. */ 12703 } else if (are_all_pools(argc, argv)) { 12704 /* All the args are pool names */ 12705 } else if (are_all_pools(1, argv)) { 12706 /* The first arg is a pool name */ 12707 if ((argc == 2 && strcmp(argv[1], "all-vdevs") == 0) || 12708 (argc == 2 && strcmp(argv[1], "root") == 0) || 12709 are_vdevs_in_pool(argc - 1, argv + 1, argv[0], 12710 &cb.cb_vdevs)) { 12711 12712 if (strcmp(argv[1], "root") == 0) 12713 vdev = strdup("root-0"); 12714 else 12715 vdev = strdup(argv[1]); 12716 12717 /* ... and the rest are vdev names */ 12718 cb.cb_vdevs.cb_names = &vdev; 12719 cb.cb_vdevs.cb_names_count = argc - 1; 12720 cb.cb_type = ZFS_TYPE_VDEV; 12721 argc = 1; /* One pool to process */ 12722 } else { 12723 if (cb.cb_json) { 12724 nvlist_free(cb.cb_jsobj); 12725 nvlist_free(data); 12726 } 12727 fprintf(stderr, gettext("Expected a list of vdevs in" 12728 " \"%s\", but got:\n"), argv[0]); 12729 error_list_unresolved_vdevs(argc - 1, argv + 1, 12730 argv[0], &cb.cb_vdevs); 12731 fprintf(stderr, "\n"); 12732 usage(B_FALSE); 12733 return (1); 12734 } 12735 } else { 12736 if (cb.cb_json) { 12737 nvlist_free(cb.cb_jsobj); 12738 nvlist_free(data); 12739 } 12740 /* 12741 * The first arg isn't the name of a valid pool. 12742 */ 12743 fprintf(stderr, gettext("Cannot get properties of %s: " 12744 "no such pool available.\n"), argv[0]); 12745 return (1); 12746 } 12747 12748 if (zprop_get_list(g_zfs, propstr, &cb.cb_proplist, 12749 cb.cb_type) != 0) { 12750 /* Use correct list of valid properties (pool or vdev) */ 12751 current_prop_type = cb.cb_type; 12752 usage(B_FALSE); 12753 } 12754 12755 if (cb.cb_proplist != NULL) { 12756 fake_name.pl_prop = ZPOOL_PROP_NAME; 12757 fake_name.pl_width = strlen(gettext("NAME")); 12758 fake_name.pl_next = cb.cb_proplist; 12759 cb.cb_proplist = &fake_name; 12760 } 12761 12762 if (cb.cb_json) { 12763 if (cb.cb_type == ZFS_TYPE_VDEV) 12764 fnvlist_add_nvlist(cb.cb_jsobj, "vdevs", data); 12765 else 12766 fnvlist_add_nvlist(cb.cb_jsobj, "pools", data); 12767 fnvlist_free(data); 12768 } 12769 12770 ret = for_each_pool(argc, argv, B_TRUE, &cb.cb_proplist, cb.cb_type, 12771 cb.cb_literal, get_callback, &cb); 12772 12773 if (ret == 0 && cb.cb_json) 12774 zcmd_print_json(cb.cb_jsobj); 12775 else if (ret != 0 && cb.cb_json) 12776 nvlist_free(cb.cb_jsobj); 12777 12778 if (cb.cb_proplist == &fake_name) 12779 zprop_free_list(fake_name.pl_next); 12780 else 12781 zprop_free_list(cb.cb_proplist); 12782 12783 if (vdev != NULL) 12784 free(vdev); 12785 12786 return (ret); 12787 } 12788 12789 typedef struct set_cbdata { 12790 char *cb_propname; 12791 char *cb_value; 12792 zfs_type_t cb_type; 12793 vdev_cbdata_t cb_vdevs; 12794 boolean_t cb_any_successful; 12795 } set_cbdata_t; 12796 12797 static int 12798 set_pool_callback(zpool_handle_t *zhp, set_cbdata_t *cb) 12799 { 12800 int error; 12801 12802 /* Check if we have out-of-bounds features */ 12803 if (strcmp(cb->cb_propname, ZPOOL_CONFIG_COMPATIBILITY) == 0) { 12804 boolean_t features[SPA_FEATURES]; 12805 if (zpool_do_load_compat(cb->cb_value, features) != 12806 ZPOOL_COMPATIBILITY_OK) 12807 return (-1); 12808 12809 nvlist_t *enabled = zpool_get_features(zhp); 12810 spa_feature_t i; 12811 for (i = 0; i < SPA_FEATURES; i++) { 12812 const char *fguid = spa_feature_table[i].fi_guid; 12813 if (nvlist_exists(enabled, fguid) && !features[i]) 12814 break; 12815 } 12816 if (i < SPA_FEATURES) 12817 (void) fprintf(stderr, gettext("Warning: one or " 12818 "more features already enabled on pool '%s'\n" 12819 "are not present in this compatibility set.\n"), 12820 zpool_get_name(zhp)); 12821 } 12822 12823 /* if we're setting a feature, check it's in compatibility set */ 12824 if (zpool_prop_feature(cb->cb_propname) && 12825 strcmp(cb->cb_value, ZFS_FEATURE_ENABLED) == 0) { 12826 char *fname = strchr(cb->cb_propname, '@') + 1; 12827 spa_feature_t f; 12828 12829 if (zfeature_lookup_name(fname, &f) == 0) { 12830 char compat[ZFS_MAXPROPLEN]; 12831 if (zpool_get_prop(zhp, ZPOOL_PROP_COMPATIBILITY, 12832 compat, ZFS_MAXPROPLEN, NULL, B_FALSE) != 0) 12833 compat[0] = '\0'; 12834 12835 boolean_t features[SPA_FEATURES]; 12836 if (zpool_do_load_compat(compat, features) != 12837 ZPOOL_COMPATIBILITY_OK) { 12838 (void) fprintf(stderr, gettext("Error: " 12839 "cannot enable feature '%s' on pool '%s'\n" 12840 "because the pool's 'compatibility' " 12841 "property cannot be parsed.\n"), 12842 fname, zpool_get_name(zhp)); 12843 return (-1); 12844 } 12845 12846 if (!features[f]) { 12847 (void) fprintf(stderr, gettext("Error: " 12848 "cannot enable feature '%s' on pool '%s'\n" 12849 "as it is not specified in this pool's " 12850 "current compatibility set.\n" 12851 "Consider setting 'compatibility' to a " 12852 "less restrictive set, or to 'off'.\n"), 12853 fname, zpool_get_name(zhp)); 12854 return (-1); 12855 } 12856 } 12857 } 12858 12859 error = zpool_set_prop(zhp, cb->cb_propname, cb->cb_value); 12860 12861 return (error); 12862 } 12863 12864 static int 12865 set_callback(zpool_handle_t *zhp, void *data) 12866 { 12867 int error; 12868 set_cbdata_t *cb = (set_cbdata_t *)data; 12869 12870 if (cb->cb_type == ZFS_TYPE_VDEV) { 12871 error = zpool_set_vdev_prop(zhp, *cb->cb_vdevs.cb_names, 12872 cb->cb_propname, cb->cb_value); 12873 } else { 12874 assert(cb->cb_type == ZFS_TYPE_POOL); 12875 error = set_pool_callback(zhp, cb); 12876 } 12877 12878 cb->cb_any_successful = !error; 12879 return (error); 12880 } 12881 12882 int 12883 zpool_do_set(int argc, char **argv) 12884 { 12885 set_cbdata_t cb = { 0 }; 12886 int error; 12887 char *vdev = NULL; 12888 12889 current_prop_type = ZFS_TYPE_POOL; 12890 if (argc > 1 && argv[1][0] == '-') { 12891 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 12892 argv[1][1]); 12893 usage(B_FALSE); 12894 } 12895 12896 if (argc < 2) { 12897 (void) fprintf(stderr, gettext("missing property=value " 12898 "argument\n")); 12899 usage(B_FALSE); 12900 } 12901 12902 if (argc < 3) { 12903 (void) fprintf(stderr, gettext("missing pool name\n")); 12904 usage(B_FALSE); 12905 } 12906 12907 if (argc > 4) { 12908 (void) fprintf(stderr, gettext("too many pool names\n")); 12909 usage(B_FALSE); 12910 } 12911 12912 cb.cb_propname = argv[1]; 12913 cb.cb_type = ZFS_TYPE_POOL; 12914 cb.cb_vdevs.cb_name_flags |= VDEV_NAME_TYPE_ID; 12915 cb.cb_value = strchr(cb.cb_propname, '='); 12916 if (cb.cb_value == NULL) { 12917 (void) fprintf(stderr, gettext("missing value in " 12918 "property=value argument\n")); 12919 usage(B_FALSE); 12920 } 12921 12922 *(cb.cb_value) = '\0'; 12923 cb.cb_value++; 12924 argc -= 2; 12925 argv += 2; 12926 12927 /* argv[0] is pool name */ 12928 if (!is_pool(argv[0])) { 12929 (void) fprintf(stderr, 12930 gettext("cannot open '%s': is not a pool\n"), argv[0]); 12931 return (EINVAL); 12932 } 12933 12934 /* argv[1], when supplied, is vdev name */ 12935 if (argc == 2) { 12936 12937 if (strcmp(argv[1], "root") == 0) 12938 vdev = strdup("root-0"); 12939 else 12940 vdev = strdup(argv[1]); 12941 12942 if (!are_vdevs_in_pool(1, &vdev, argv[0], &cb.cb_vdevs)) { 12943 (void) fprintf(stderr, gettext( 12944 "cannot find '%s' in '%s': device not in pool\n"), 12945 vdev, argv[0]); 12946 free(vdev); 12947 return (EINVAL); 12948 } 12949 cb.cb_vdevs.cb_names = &vdev; 12950 cb.cb_vdevs.cb_names_count = 1; 12951 cb.cb_type = ZFS_TYPE_VDEV; 12952 } 12953 12954 error = for_each_pool(1, argv, B_TRUE, NULL, ZFS_TYPE_POOL, 12955 B_FALSE, set_callback, &cb); 12956 12957 if (vdev != NULL) 12958 free(vdev); 12959 12960 return (error); 12961 } 12962 12963 /* Add up the total number of bytes left to initialize/trim across all vdevs */ 12964 static uint64_t 12965 vdev_activity_remaining(nvlist_t *nv, zpool_wait_activity_t activity) 12966 { 12967 uint64_t bytes_remaining; 12968 nvlist_t **child; 12969 uint_t c, children; 12970 vdev_stat_t *vs; 12971 12972 assert(activity == ZPOOL_WAIT_INITIALIZE || 12973 activity == ZPOOL_WAIT_TRIM); 12974 12975 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS, 12976 (uint64_t **)&vs, &c) == 0); 12977 12978 if (activity == ZPOOL_WAIT_INITIALIZE && 12979 vs->vs_initialize_state == VDEV_INITIALIZE_ACTIVE) 12980 bytes_remaining = vs->vs_initialize_bytes_est - 12981 vs->vs_initialize_bytes_done; 12982 else if (activity == ZPOOL_WAIT_TRIM && 12983 vs->vs_trim_state == VDEV_TRIM_ACTIVE) 12984 bytes_remaining = vs->vs_trim_bytes_est - 12985 vs->vs_trim_bytes_done; 12986 else 12987 bytes_remaining = 0; 12988 12989 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, 12990 &child, &children) != 0) 12991 children = 0; 12992 12993 for (c = 0; c < children; c++) 12994 bytes_remaining += vdev_activity_remaining(child[c], activity); 12995 12996 return (bytes_remaining); 12997 } 12998 12999 /* Add up the total number of bytes left to rebuild across top-level vdevs */ 13000 static uint64_t 13001 vdev_activity_top_remaining(nvlist_t *nv) 13002 { 13003 uint64_t bytes_remaining = 0; 13004 nvlist_t **child; 13005 uint_t children; 13006 int error; 13007 13008 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, 13009 &child, &children) != 0) 13010 children = 0; 13011 13012 for (uint_t c = 0; c < children; c++) { 13013 vdev_rebuild_stat_t *vrs; 13014 uint_t i; 13015 13016 error = nvlist_lookup_uint64_array(child[c], 13017 ZPOOL_CONFIG_REBUILD_STATS, (uint64_t **)&vrs, &i); 13018 if (error == 0) { 13019 if (vrs->vrs_state == VDEV_REBUILD_ACTIVE) { 13020 bytes_remaining += (vrs->vrs_bytes_est - 13021 vrs->vrs_bytes_rebuilt); 13022 } 13023 } 13024 } 13025 13026 return (bytes_remaining); 13027 } 13028 13029 /* Whether any vdevs are 'spare' or 'replacing' vdevs */ 13030 static boolean_t 13031 vdev_any_spare_replacing(nvlist_t *nv) 13032 { 13033 nvlist_t **child; 13034 uint_t c, children; 13035 const char *vdev_type; 13036 13037 (void) nvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE, &vdev_type); 13038 13039 if (strcmp(vdev_type, VDEV_TYPE_REPLACING) == 0 || 13040 strcmp(vdev_type, VDEV_TYPE_SPARE) == 0 || 13041 strcmp(vdev_type, VDEV_TYPE_DRAID_SPARE) == 0) { 13042 return (B_TRUE); 13043 } 13044 13045 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, 13046 &child, &children) != 0) 13047 children = 0; 13048 13049 for (c = 0; c < children; c++) { 13050 if (vdev_any_spare_replacing(child[c])) 13051 return (B_TRUE); 13052 } 13053 13054 return (B_FALSE); 13055 } 13056 13057 typedef struct wait_data { 13058 char *wd_poolname; 13059 boolean_t wd_scripted; 13060 boolean_t wd_exact; 13061 boolean_t wd_headers_once; 13062 boolean_t wd_should_exit; 13063 /* Which activities to wait for */ 13064 boolean_t wd_enabled[ZPOOL_WAIT_NUM_ACTIVITIES]; 13065 float wd_interval; 13066 pthread_cond_t wd_cv; 13067 pthread_mutex_t wd_mutex; 13068 } wait_data_t; 13069 13070 /* 13071 * Print to stdout a single line, containing one column for each activity that 13072 * we are waiting for specifying how many bytes of work are left for that 13073 * activity. 13074 */ 13075 static void 13076 print_wait_status_row(wait_data_t *wd, zpool_handle_t *zhp, int row) 13077 { 13078 nvlist_t *config, *nvroot; 13079 uint_t c; 13080 int i; 13081 pool_checkpoint_stat_t *pcs = NULL; 13082 pool_scan_stat_t *pss = NULL; 13083 pool_removal_stat_t *prs = NULL; 13084 pool_raidz_expand_stat_t *pres = NULL; 13085 const char *const headers[] = {"DISCARD", "FREE", "INITIALIZE", 13086 "REPLACE", "REMOVE", "RESILVER", "SCRUB", "TRIM", "RAIDZ_EXPAND"}; 13087 int col_widths[ZPOOL_WAIT_NUM_ACTIVITIES]; 13088 13089 /* Calculate the width of each column */ 13090 for (i = 0; i < ZPOOL_WAIT_NUM_ACTIVITIES; i++) { 13091 /* 13092 * Make sure we have enough space in the col for pretty-printed 13093 * numbers and for the column header, and then leave a couple 13094 * spaces between cols for readability. 13095 */ 13096 col_widths[i] = MAX(strlen(headers[i]), 6) + 2; 13097 } 13098 13099 if (timestamp_fmt != NODATE) 13100 print_timestamp(timestamp_fmt); 13101 13102 /* Print header if appropriate */ 13103 int term_height = terminal_height(); 13104 boolean_t reprint_header = (!wd->wd_headers_once && term_height > 0 && 13105 row % (term_height-1) == 0); 13106 if (!wd->wd_scripted && (row == 0 || reprint_header)) { 13107 for (i = 0; i < ZPOOL_WAIT_NUM_ACTIVITIES; i++) { 13108 if (wd->wd_enabled[i]) 13109 (void) printf("%*s", col_widths[i], headers[i]); 13110 } 13111 (void) fputc('\n', stdout); 13112 } 13113 13114 /* Bytes of work remaining in each activity */ 13115 int64_t bytes_rem[ZPOOL_WAIT_NUM_ACTIVITIES] = {0}; 13116 13117 bytes_rem[ZPOOL_WAIT_FREE] = 13118 zpool_get_prop_int(zhp, ZPOOL_PROP_FREEING, NULL); 13119 13120 config = zpool_get_config(zhp, NULL); 13121 nvroot = fnvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE); 13122 13123 (void) nvlist_lookup_uint64_array(nvroot, 13124 ZPOOL_CONFIG_CHECKPOINT_STATS, (uint64_t **)&pcs, &c); 13125 if (pcs != NULL && pcs->pcs_state == CS_CHECKPOINT_DISCARDING) 13126 bytes_rem[ZPOOL_WAIT_CKPT_DISCARD] = pcs->pcs_space; 13127 13128 (void) nvlist_lookup_uint64_array(nvroot, 13129 ZPOOL_CONFIG_REMOVAL_STATS, (uint64_t **)&prs, &c); 13130 if (prs != NULL && prs->prs_state == DSS_SCANNING) 13131 bytes_rem[ZPOOL_WAIT_REMOVE] = prs->prs_to_copy - 13132 prs->prs_copied; 13133 13134 (void) nvlist_lookup_uint64_array(nvroot, 13135 ZPOOL_CONFIG_SCAN_STATS, (uint64_t **)&pss, &c); 13136 if (pss != NULL && pss->pss_state == DSS_SCANNING && 13137 pss->pss_pass_scrub_pause == 0) { 13138 int64_t rem = pss->pss_to_examine - pss->pss_issued; 13139 if (pss->pss_func == POOL_SCAN_SCRUB) 13140 bytes_rem[ZPOOL_WAIT_SCRUB] = rem; 13141 else 13142 bytes_rem[ZPOOL_WAIT_RESILVER] = rem; 13143 } else if (check_rebuilding(nvroot, NULL)) { 13144 bytes_rem[ZPOOL_WAIT_RESILVER] = 13145 vdev_activity_top_remaining(nvroot); 13146 } 13147 13148 (void) nvlist_lookup_uint64_array(nvroot, 13149 ZPOOL_CONFIG_RAIDZ_EXPAND_STATS, (uint64_t **)&pres, &c); 13150 if (pres != NULL && pres->pres_state == DSS_SCANNING) { 13151 int64_t rem = pres->pres_to_reflow - pres->pres_reflowed; 13152 bytes_rem[ZPOOL_WAIT_RAIDZ_EXPAND] = rem; 13153 } 13154 13155 bytes_rem[ZPOOL_WAIT_INITIALIZE] = 13156 vdev_activity_remaining(nvroot, ZPOOL_WAIT_INITIALIZE); 13157 bytes_rem[ZPOOL_WAIT_TRIM] = 13158 vdev_activity_remaining(nvroot, ZPOOL_WAIT_TRIM); 13159 13160 /* 13161 * A replace finishes after resilvering finishes, so the amount of work 13162 * left for a replace is the same as for resilvering. 13163 * 13164 * It isn't quite correct to say that if we have any 'spare' or 13165 * 'replacing' vdevs and a resilver is happening, then a replace is in 13166 * progress, like we do here. When a hot spare is used, the faulted vdev 13167 * is not removed after the hot spare is resilvered, so parent 'spare' 13168 * vdev is not removed either. So we could have a 'spare' vdev, but be 13169 * resilvering for a different reason. However, we use it as a heuristic 13170 * because we don't have access to the DTLs, which could tell us whether 13171 * or not we have really finished resilvering a hot spare. 13172 */ 13173 if (vdev_any_spare_replacing(nvroot)) 13174 bytes_rem[ZPOOL_WAIT_REPLACE] = bytes_rem[ZPOOL_WAIT_RESILVER]; 13175 13176 for (i = 0; i < ZPOOL_WAIT_NUM_ACTIVITIES; i++) { 13177 char buf[64]; 13178 if (!wd->wd_enabled[i]) 13179 continue; 13180 13181 if (wd->wd_exact) { 13182 (void) snprintf(buf, sizeof (buf), "%" PRIi64, 13183 bytes_rem[i]); 13184 } else { 13185 zfs_nicenum(bytes_rem[i], buf, sizeof (buf)); 13186 } 13187 13188 if (wd->wd_scripted) 13189 (void) printf(i == 0 ? "%s" : "\t%s", buf); 13190 else 13191 (void) printf(" %*s", col_widths[i] - 1, buf); 13192 } 13193 (void) printf("\n"); 13194 (void) fflush(stdout); 13195 } 13196 13197 static void * 13198 wait_status_thread(void *arg) 13199 { 13200 wait_data_t *wd = (wait_data_t *)arg; 13201 zpool_handle_t *zhp; 13202 13203 if ((zhp = zpool_open(g_zfs, wd->wd_poolname)) == NULL) 13204 return (void *)(1); 13205 13206 for (int row = 0; ; row++) { 13207 boolean_t missing; 13208 struct timespec timeout; 13209 int ret = 0; 13210 (void) clock_gettime(CLOCK_REALTIME, &timeout); 13211 13212 if (zpool_refresh_stats(zhp, &missing) != 0 || missing || 13213 zpool_props_refresh(zhp) != 0) { 13214 zpool_close(zhp); 13215 return (void *)(uintptr_t)(missing ? 0 : 1); 13216 } 13217 13218 print_wait_status_row(wd, zhp, row); 13219 13220 timeout.tv_sec += floor(wd->wd_interval); 13221 long nanos = timeout.tv_nsec + 13222 (wd->wd_interval - floor(wd->wd_interval)) * NANOSEC; 13223 if (nanos >= NANOSEC) { 13224 timeout.tv_sec++; 13225 timeout.tv_nsec = nanos - NANOSEC; 13226 } else { 13227 timeout.tv_nsec = nanos; 13228 } 13229 pthread_mutex_lock(&wd->wd_mutex); 13230 if (!wd->wd_should_exit) 13231 ret = pthread_cond_timedwait(&wd->wd_cv, &wd->wd_mutex, 13232 &timeout); 13233 pthread_mutex_unlock(&wd->wd_mutex); 13234 if (ret == 0) { 13235 break; /* signaled by main thread */ 13236 } else if (ret != ETIMEDOUT) { 13237 (void) fprintf(stderr, gettext("pthread_cond_timedwait " 13238 "failed: %s\n"), strerror(ret)); 13239 zpool_close(zhp); 13240 return (void *)(uintptr_t)(1); 13241 } 13242 } 13243 13244 zpool_close(zhp); 13245 return (void *)(0); 13246 } 13247 13248 int 13249 zpool_do_wait(int argc, char **argv) 13250 { 13251 boolean_t verbose = B_FALSE; 13252 int c, i; 13253 unsigned long count; 13254 pthread_t status_thr; 13255 int error = 0; 13256 zpool_handle_t *zhp; 13257 13258 wait_data_t wd; 13259 wd.wd_scripted = B_FALSE; 13260 wd.wd_exact = B_FALSE; 13261 wd.wd_headers_once = B_FALSE; 13262 wd.wd_should_exit = B_FALSE; 13263 13264 pthread_mutex_init(&wd.wd_mutex, NULL); 13265 pthread_cond_init(&wd.wd_cv, NULL); 13266 13267 /* By default, wait for all types of activity. */ 13268 for (i = 0; i < ZPOOL_WAIT_NUM_ACTIVITIES; i++) 13269 wd.wd_enabled[i] = B_TRUE; 13270 13271 while ((c = getopt(argc, argv, "HpT:t:")) != -1) { 13272 switch (c) { 13273 case 'H': 13274 wd.wd_scripted = B_TRUE; 13275 break; 13276 case 'n': 13277 wd.wd_headers_once = B_TRUE; 13278 break; 13279 case 'p': 13280 wd.wd_exact = B_TRUE; 13281 break; 13282 case 'T': 13283 get_timestamp_arg(*optarg); 13284 break; 13285 case 't': 13286 /* Reset activities array */ 13287 memset(&wd.wd_enabled, 0, sizeof (wd.wd_enabled)); 13288 13289 for (char *tok; (tok = strsep(&optarg, ",")); ) { 13290 static const char *const col_opts[] = { 13291 "discard", "free", "initialize", "replace", 13292 "remove", "resilver", "scrub", "trim", 13293 "raidz_expand" }; 13294 13295 for (i = 0; i < ARRAY_SIZE(col_opts); ++i) 13296 if (strcmp(tok, col_opts[i]) == 0) { 13297 wd.wd_enabled[i] = B_TRUE; 13298 goto found; 13299 } 13300 13301 (void) fprintf(stderr, 13302 gettext("invalid activity '%s'\n"), tok); 13303 usage(B_FALSE); 13304 found:; 13305 } 13306 break; 13307 case '?': 13308 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 13309 optopt); 13310 usage(B_FALSE); 13311 } 13312 } 13313 13314 argc -= optind; 13315 argv += optind; 13316 13317 get_interval_count(&argc, argv, &wd.wd_interval, &count); 13318 if (count != 0) { 13319 /* This subcmd only accepts an interval, not a count */ 13320 (void) fprintf(stderr, gettext("too many arguments\n")); 13321 usage(B_FALSE); 13322 } 13323 13324 if (wd.wd_interval != 0) 13325 verbose = B_TRUE; 13326 13327 if (argc < 1) { 13328 (void) fprintf(stderr, gettext("missing 'pool' argument\n")); 13329 usage(B_FALSE); 13330 } 13331 if (argc > 1) { 13332 (void) fprintf(stderr, gettext("too many arguments\n")); 13333 usage(B_FALSE); 13334 } 13335 13336 wd.wd_poolname = argv[0]; 13337 13338 if ((zhp = zpool_open(g_zfs, wd.wd_poolname)) == NULL) 13339 return (1); 13340 13341 if (verbose) { 13342 /* 13343 * We use a separate thread for printing status updates because 13344 * the main thread will call lzc_wait(), which blocks as long 13345 * as an activity is in progress, which can be a long time. 13346 */ 13347 if (pthread_create(&status_thr, NULL, wait_status_thread, &wd) 13348 != 0) { 13349 (void) fprintf(stderr, gettext("failed to create status" 13350 "thread: %s\n"), strerror(errno)); 13351 zpool_close(zhp); 13352 return (1); 13353 } 13354 } 13355 13356 /* 13357 * Loop over all activities that we are supposed to wait for until none 13358 * of them are in progress. Note that this means we can end up waiting 13359 * for more activities to complete than just those that were in progress 13360 * when we began waiting; if an activity we are interested in begins 13361 * while we are waiting for another activity, we will wait for both to 13362 * complete before exiting. 13363 */ 13364 for (;;) { 13365 boolean_t missing = B_FALSE; 13366 boolean_t any_waited = B_FALSE; 13367 13368 for (i = 0; i < ZPOOL_WAIT_NUM_ACTIVITIES; i++) { 13369 boolean_t waited; 13370 13371 if (!wd.wd_enabled[i]) 13372 continue; 13373 13374 error = zpool_wait_status(zhp, i, &missing, &waited); 13375 if (error != 0 || missing) 13376 break; 13377 13378 any_waited = (any_waited || waited); 13379 } 13380 13381 if (error != 0 || missing || !any_waited) 13382 break; 13383 } 13384 13385 zpool_close(zhp); 13386 13387 if (verbose) { 13388 uintptr_t status; 13389 pthread_mutex_lock(&wd.wd_mutex); 13390 wd.wd_should_exit = B_TRUE; 13391 pthread_cond_signal(&wd.wd_cv); 13392 pthread_mutex_unlock(&wd.wd_mutex); 13393 (void) pthread_join(status_thr, (void *)&status); 13394 if (status != 0) 13395 error = status; 13396 } 13397 13398 pthread_mutex_destroy(&wd.wd_mutex); 13399 pthread_cond_destroy(&wd.wd_cv); 13400 return (error); 13401 } 13402 13403 /* 13404 * zpool ddtprune -d|-p <amount> <pool> 13405 * 13406 * -d <days> Prune entries <days> old and older 13407 * -p <percent> Prune <percent> amount of entries 13408 * 13409 * Prune single reference entries from DDT to satisfy the amount specified. 13410 */ 13411 int 13412 zpool_do_ddt_prune(int argc, char **argv) 13413 { 13414 zpool_ddt_prune_unit_t unit = ZPOOL_DDT_PRUNE_NONE; 13415 uint64_t amount = 0; 13416 zpool_handle_t *zhp; 13417 char *endptr; 13418 int c; 13419 13420 while ((c = getopt(argc, argv, "d:p:")) != -1) { 13421 switch (c) { 13422 case 'd': 13423 if (unit == ZPOOL_DDT_PRUNE_PERCENTAGE) { 13424 (void) fprintf(stderr, gettext("-d cannot be " 13425 "combined with -p option\n")); 13426 usage(B_FALSE); 13427 } 13428 errno = 0; 13429 amount = strtoull(optarg, &endptr, 0); 13430 if (errno != 0 || *endptr != '\0' || amount == 0) { 13431 (void) fprintf(stderr, 13432 gettext("invalid days value\n")); 13433 usage(B_FALSE); 13434 } 13435 amount *= 86400; /* convert days to seconds */ 13436 unit = ZPOOL_DDT_PRUNE_AGE; 13437 break; 13438 case 'p': 13439 if (unit == ZPOOL_DDT_PRUNE_AGE) { 13440 (void) fprintf(stderr, gettext("-p cannot be " 13441 "combined with -d option\n")); 13442 usage(B_FALSE); 13443 } 13444 errno = 0; 13445 amount = strtoull(optarg, &endptr, 0); 13446 if (errno != 0 || *endptr != '\0' || 13447 amount == 0 || amount > 100) { 13448 (void) fprintf(stderr, 13449 gettext("invalid percentage value\n")); 13450 usage(B_FALSE); 13451 } 13452 unit = ZPOOL_DDT_PRUNE_PERCENTAGE; 13453 break; 13454 case '?': 13455 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 13456 optopt); 13457 usage(B_FALSE); 13458 } 13459 } 13460 argc -= optind; 13461 argv += optind; 13462 13463 if (unit == ZPOOL_DDT_PRUNE_NONE) { 13464 (void) fprintf(stderr, 13465 gettext("missing amount option (-d|-p <value>)\n")); 13466 usage(B_FALSE); 13467 } else if (argc < 1) { 13468 (void) fprintf(stderr, gettext("missing pool argument\n")); 13469 usage(B_FALSE); 13470 } else if (argc > 1) { 13471 (void) fprintf(stderr, gettext("too many arguments\n")); 13472 usage(B_FALSE); 13473 } 13474 zhp = zpool_open(g_zfs, argv[0]); 13475 if (zhp == NULL) 13476 return (-1); 13477 13478 int error = zpool_ddt_prune(zhp, unit, amount); 13479 13480 zpool_close(zhp); 13481 13482 return (error); 13483 } 13484 13485 static int 13486 find_command_idx(const char *command, int *idx) 13487 { 13488 for (int i = 0; i < NCOMMAND; ++i) { 13489 if (command_table[i].name == NULL) 13490 continue; 13491 13492 if (strcmp(command, command_table[i].name) == 0) { 13493 *idx = i; 13494 return (0); 13495 } 13496 } 13497 return (1); 13498 } 13499 13500 /* 13501 * Display version message 13502 */ 13503 static int 13504 zpool_do_version(int argc, char **argv) 13505 { 13506 int c; 13507 nvlist_t *jsobj = NULL, *zfs_ver = NULL; 13508 boolean_t json = B_FALSE; 13509 13510 struct option long_options[] = { 13511 {"json", no_argument, NULL, 'j'}, 13512 }; 13513 13514 while ((c = getopt_long(argc, argv, "j", long_options, NULL)) != -1) { 13515 switch (c) { 13516 case 'j': 13517 json = B_TRUE; 13518 jsobj = zpool_json_schema(0, 1); 13519 break; 13520 case '?': 13521 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 13522 optopt); 13523 usage(B_FALSE); 13524 } 13525 } 13526 13527 argc -= optind; 13528 if (argc != 0) { 13529 (void) fprintf(stderr, "too many arguments\n"); 13530 usage(B_FALSE); 13531 } 13532 13533 if (json) { 13534 zfs_ver = zfs_version_nvlist(); 13535 if (zfs_ver) { 13536 fnvlist_add_nvlist(jsobj, "zfs_version", zfs_ver); 13537 zcmd_print_json(jsobj); 13538 fnvlist_free(zfs_ver); 13539 return (0); 13540 } else 13541 return (-1); 13542 } else 13543 return (zfs_version_print() != 0); 13544 } 13545 13546 /* Display documentation */ 13547 static int 13548 zpool_do_help(int argc, char **argv) 13549 { 13550 char page[MAXNAMELEN]; 13551 if (argc < 3 || strcmp(argv[2], "zpool") == 0) 13552 strcpy(page, "zpool"); 13553 else if (strcmp(argv[2], "concepts") == 0 || 13554 strcmp(argv[2], "props") == 0) 13555 snprintf(page, sizeof (page), "zpool%s", argv[2]); 13556 else 13557 snprintf(page, sizeof (page), "zpool-%s", argv[2]); 13558 13559 execlp("man", "man", page, NULL); 13560 13561 fprintf(stderr, "couldn't run man program: %s", strerror(errno)); 13562 return (-1); 13563 } 13564 13565 /* 13566 * Do zpool_load_compat() and print error message on failure 13567 */ 13568 static zpool_compat_status_t 13569 zpool_do_load_compat(const char *compat, boolean_t *list) 13570 { 13571 char report[1024]; 13572 13573 zpool_compat_status_t ret; 13574 13575 ret = zpool_load_compat(compat, list, report, 1024); 13576 switch (ret) { 13577 13578 case ZPOOL_COMPATIBILITY_OK: 13579 break; 13580 13581 case ZPOOL_COMPATIBILITY_NOFILES: 13582 case ZPOOL_COMPATIBILITY_BADFILE: 13583 case ZPOOL_COMPATIBILITY_BADTOKEN: 13584 (void) fprintf(stderr, "Error: %s\n", report); 13585 break; 13586 13587 case ZPOOL_COMPATIBILITY_WARNTOKEN: 13588 (void) fprintf(stderr, "Warning: %s\n", report); 13589 ret = ZPOOL_COMPATIBILITY_OK; 13590 break; 13591 } 13592 return (ret); 13593 } 13594 13595 int 13596 main(int argc, char **argv) 13597 { 13598 int ret = 0; 13599 int i = 0; 13600 char *cmdname; 13601 char **newargv; 13602 13603 (void) setlocale(LC_ALL, ""); 13604 (void) setlocale(LC_NUMERIC, "C"); 13605 (void) textdomain(TEXT_DOMAIN); 13606 srand(time(NULL)); 13607 13608 opterr = 0; 13609 13610 /* 13611 * Make sure the user has specified some command. 13612 */ 13613 if (argc < 2) { 13614 (void) fprintf(stderr, gettext("missing command\n")); 13615 usage(B_FALSE); 13616 } 13617 13618 cmdname = argv[1]; 13619 13620 /* 13621 * Special case '-?' 13622 */ 13623 if ((strcmp(cmdname, "-?") == 0) || strcmp(cmdname, "--help") == 0) 13624 usage(B_TRUE); 13625 13626 /* 13627 * Special case '-V|--version' 13628 */ 13629 if ((strcmp(cmdname, "-V") == 0) || (strcmp(cmdname, "--version") == 0)) 13630 return (zfs_version_print() != 0); 13631 13632 /* 13633 * Special case 'help' 13634 */ 13635 if (strcmp(cmdname, "help") == 0) 13636 return (zpool_do_help(argc, argv)); 13637 13638 if ((g_zfs = libzfs_init()) == NULL) { 13639 (void) fprintf(stderr, "%s\n", libzfs_error_init(errno)); 13640 return (1); 13641 } 13642 13643 libzfs_print_on_error(g_zfs, B_TRUE); 13644 13645 zfs_save_arguments(argc, argv, history_str, sizeof (history_str)); 13646 13647 /* 13648 * Many commands modify input strings for string parsing reasons. 13649 * We create a copy to protect the original argv. 13650 */ 13651 newargv = safe_malloc((argc + 1) * sizeof (newargv[0])); 13652 for (i = 0; i < argc; i++) 13653 newargv[i] = strdup(argv[i]); 13654 newargv[argc] = NULL; 13655 13656 /* 13657 * Run the appropriate command. 13658 */ 13659 if (find_command_idx(cmdname, &i) == 0) { 13660 current_command = &command_table[i]; 13661 ret = command_table[i].func(argc - 1, newargv + 1); 13662 } else if (strchr(cmdname, '=')) { 13663 verify(find_command_idx("set", &i) == 0); 13664 current_command = &command_table[i]; 13665 ret = command_table[i].func(argc, newargv); 13666 } else if (strcmp(cmdname, "freeze") == 0 && argc == 3) { 13667 /* 13668 * 'freeze' is a vile debugging abomination, so we treat 13669 * it as such. 13670 */ 13671 zfs_cmd_t zc = {"\0"}; 13672 13673 (void) strlcpy(zc.zc_name, argv[2], sizeof (zc.zc_name)); 13674 ret = zfs_ioctl(g_zfs, ZFS_IOC_POOL_FREEZE, &zc); 13675 if (ret != 0) { 13676 (void) fprintf(stderr, 13677 gettext("failed to freeze pool: %d\n"), errno); 13678 ret = 1; 13679 } 13680 13681 log_history = 0; 13682 } else { 13683 (void) fprintf(stderr, gettext("unrecognized " 13684 "command '%s'\n"), cmdname); 13685 usage(B_FALSE); 13686 ret = 1; 13687 } 13688 13689 for (i = 0; i < argc; i++) 13690 free(newargv[i]); 13691 free(newargv); 13692 13693 if (ret == 0 && log_history) 13694 (void) zpool_log_history(g_zfs, history_str); 13695 13696 libzfs_fini(g_zfs); 13697 13698 /* 13699 * The 'ZFS_ABORT' environment variable causes us to dump core on exit 13700 * for the purposes of running ::findleaks. 13701 */ 13702 if (getenv("ZFS_ABORT") != NULL) { 13703 (void) printf("dumping core by request\n"); 13704 abort(); 13705 } 13706 13707 return (ret); 13708 } 13709