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-int", no_argument, NULL, ZPOOL_OPTION_JSON_NUMS_AS_INT}, 7344 {"json-pool-key-guid", no_argument, NULL, 7345 ZPOOL_OPTION_POOL_KEY_GUID}, 7346 {0, 0, 0, 0} 7347 }; 7348 7349 /* check options */ 7350 while ((c = getopt_long(argc, argv, ":gjHLo:pPT:v", long_options, 7351 NULL)) != -1) { 7352 switch (c) { 7353 case 'g': 7354 cb.cb_name_flags |= VDEV_NAME_GUID; 7355 break; 7356 case 'H': 7357 cb.cb_scripted = B_TRUE; 7358 break; 7359 case 'L': 7360 cb.cb_name_flags |= VDEV_NAME_FOLLOW_LINKS; 7361 break; 7362 case 'o': 7363 props = optarg; 7364 break; 7365 case 'P': 7366 cb.cb_name_flags |= VDEV_NAME_PATH; 7367 break; 7368 case 'p': 7369 cb.cb_literal = B_TRUE; 7370 break; 7371 case 'j': 7372 cb.cb_json = B_TRUE; 7373 break; 7374 case ZPOOL_OPTION_JSON_NUMS_AS_INT: 7375 cb.cb_json_as_int = B_TRUE; 7376 cb.cb_literal = B_TRUE; 7377 break; 7378 case ZPOOL_OPTION_POOL_KEY_GUID: 7379 cb.cb_json_pool_key_guid = B_TRUE; 7380 break; 7381 case 'T': 7382 get_timestamp_arg(*optarg); 7383 break; 7384 case 'v': 7385 cb.cb_verbose = B_TRUE; 7386 cb.cb_namewidth = 8; /* 8 until precalc is avail */ 7387 break; 7388 case ':': 7389 (void) fprintf(stderr, gettext("missing argument for " 7390 "'%c' option\n"), optopt); 7391 usage(B_FALSE); 7392 break; 7393 case '?': 7394 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 7395 optopt); 7396 usage(B_FALSE); 7397 } 7398 } 7399 7400 argc -= optind; 7401 argv += optind; 7402 7403 if (!cb.cb_json && cb.cb_json_as_int) { 7404 (void) fprintf(stderr, gettext("'--json-int' only works with" 7405 " '-j' option\n")); 7406 usage(B_FALSE); 7407 } 7408 7409 if (!cb.cb_json && cb.cb_json_pool_key_guid) { 7410 (void) fprintf(stderr, gettext("'json-pool-key-guid' only" 7411 " works with '-j' option\n")); 7412 usage(B_FALSE); 7413 } 7414 7415 get_interval_count(&argc, argv, &interval, &count); 7416 7417 if (zprop_get_list(g_zfs, props, &cb.cb_proplist, ZFS_TYPE_POOL) != 0) 7418 usage(B_FALSE); 7419 7420 for (;;) { 7421 if ((list = pool_list_get(argc, argv, &cb.cb_proplist, 7422 ZFS_TYPE_POOL, cb.cb_literal, &ret)) == NULL) 7423 return (1); 7424 7425 if (pool_list_count(list) == 0) 7426 break; 7427 7428 if (cb.cb_json) { 7429 cb.cb_jsobj = zpool_json_schema(0, 1); 7430 data = fnvlist_alloc(); 7431 fnvlist_add_nvlist(cb.cb_jsobj, "pools", data); 7432 fnvlist_free(data); 7433 } 7434 7435 cb.cb_namewidth = 0; 7436 (void) pool_list_iter(list, B_FALSE, get_namewidth_list, &cb); 7437 7438 if (timestamp_fmt != NODATE) { 7439 if (cb.cb_json) { 7440 if (cb.cb_json_as_int) { 7441 fnvlist_add_uint64(cb.cb_jsobj, "time", 7442 time(NULL)); 7443 } else { 7444 char ts[128]; 7445 get_timestamp(timestamp_fmt, ts, 128); 7446 fnvlist_add_string(cb.cb_jsobj, "time", 7447 ts); 7448 } 7449 } else 7450 print_timestamp(timestamp_fmt); 7451 } 7452 7453 if (!cb.cb_scripted && (first || cb.cb_verbose) && 7454 !cb.cb_json) { 7455 print_header(&cb); 7456 first = B_FALSE; 7457 } 7458 ret = pool_list_iter(list, B_TRUE, list_callback, &cb); 7459 7460 if (ret == 0 && cb.cb_json) 7461 zcmd_print_json(cb.cb_jsobj); 7462 else if (ret != 0 && cb.cb_json) 7463 nvlist_free(cb.cb_jsobj); 7464 7465 if (interval == 0) 7466 break; 7467 7468 if (count != 0 && --count == 0) 7469 break; 7470 7471 pool_list_free(list); 7472 7473 (void) fflush(stdout); 7474 (void) fsleep(interval); 7475 } 7476 7477 if (argc == 0 && !cb.cb_scripted && !cb.cb_json && 7478 pool_list_count(list) == 0) { 7479 (void) printf(gettext("no pools available\n")); 7480 ret = 0; 7481 } 7482 7483 pool_list_free(list); 7484 zprop_free_list(cb.cb_proplist); 7485 return (ret); 7486 } 7487 7488 static int 7489 zpool_do_attach_or_replace(int argc, char **argv, int replacing) 7490 { 7491 boolean_t force = B_FALSE; 7492 boolean_t rebuild = B_FALSE; 7493 boolean_t wait = B_FALSE; 7494 int c; 7495 nvlist_t *nvroot; 7496 char *poolname, *old_disk, *new_disk; 7497 zpool_handle_t *zhp; 7498 nvlist_t *props = NULL; 7499 char *propval; 7500 int ret; 7501 7502 /* check options */ 7503 while ((c = getopt(argc, argv, "fo:sw")) != -1) { 7504 switch (c) { 7505 case 'f': 7506 force = B_TRUE; 7507 break; 7508 case 'o': 7509 if ((propval = strchr(optarg, '=')) == NULL) { 7510 (void) fprintf(stderr, gettext("missing " 7511 "'=' for -o option\n")); 7512 usage(B_FALSE); 7513 } 7514 *propval = '\0'; 7515 propval++; 7516 7517 if ((strcmp(optarg, ZPOOL_CONFIG_ASHIFT) != 0) || 7518 (add_prop_list(optarg, propval, &props, B_TRUE))) 7519 usage(B_FALSE); 7520 break; 7521 case 's': 7522 rebuild = B_TRUE; 7523 break; 7524 case 'w': 7525 wait = B_TRUE; 7526 break; 7527 case '?': 7528 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 7529 optopt); 7530 usage(B_FALSE); 7531 } 7532 } 7533 7534 argc -= optind; 7535 argv += optind; 7536 7537 /* get pool name and check number of arguments */ 7538 if (argc < 1) { 7539 (void) fprintf(stderr, gettext("missing pool name argument\n")); 7540 usage(B_FALSE); 7541 } 7542 7543 poolname = argv[0]; 7544 7545 if (argc < 2) { 7546 (void) fprintf(stderr, 7547 gettext("missing <device> specification\n")); 7548 usage(B_FALSE); 7549 } 7550 7551 old_disk = argv[1]; 7552 7553 if (argc < 3) { 7554 if (!replacing) { 7555 (void) fprintf(stderr, 7556 gettext("missing <new_device> specification\n")); 7557 usage(B_FALSE); 7558 } 7559 new_disk = old_disk; 7560 argc -= 1; 7561 argv += 1; 7562 } else { 7563 new_disk = argv[2]; 7564 argc -= 2; 7565 argv += 2; 7566 } 7567 7568 if (argc > 1) { 7569 (void) fprintf(stderr, gettext("too many arguments\n")); 7570 usage(B_FALSE); 7571 } 7572 7573 if ((zhp = zpool_open(g_zfs, poolname)) == NULL) { 7574 nvlist_free(props); 7575 return (1); 7576 } 7577 7578 if (zpool_get_config(zhp, NULL) == NULL) { 7579 (void) fprintf(stderr, gettext("pool '%s' is unavailable\n"), 7580 poolname); 7581 zpool_close(zhp); 7582 nvlist_free(props); 7583 return (1); 7584 } 7585 7586 /* unless manually specified use "ashift" pool property (if set) */ 7587 if (!nvlist_exists(props, ZPOOL_CONFIG_ASHIFT)) { 7588 int intval; 7589 zprop_source_t src; 7590 char strval[ZPOOL_MAXPROPLEN]; 7591 7592 intval = zpool_get_prop_int(zhp, ZPOOL_PROP_ASHIFT, &src); 7593 if (src != ZPROP_SRC_DEFAULT) { 7594 (void) sprintf(strval, "%" PRId32, intval); 7595 verify(add_prop_list(ZPOOL_CONFIG_ASHIFT, strval, 7596 &props, B_TRUE) == 0); 7597 } 7598 } 7599 7600 nvroot = make_root_vdev(zhp, props, force, B_FALSE, replacing, B_FALSE, 7601 argc, argv); 7602 if (nvroot == NULL) { 7603 zpool_close(zhp); 7604 nvlist_free(props); 7605 return (1); 7606 } 7607 7608 ret = zpool_vdev_attach(zhp, old_disk, new_disk, nvroot, replacing, 7609 rebuild); 7610 7611 if (ret == 0 && wait) { 7612 zpool_wait_activity_t activity = ZPOOL_WAIT_RESILVER; 7613 char raidz_prefix[] = "raidz"; 7614 if (replacing) { 7615 activity = ZPOOL_WAIT_REPLACE; 7616 } else if (strncmp(old_disk, 7617 raidz_prefix, strlen(raidz_prefix)) == 0) { 7618 activity = ZPOOL_WAIT_RAIDZ_EXPAND; 7619 } 7620 ret = zpool_wait(zhp, activity); 7621 } 7622 7623 nvlist_free(props); 7624 nvlist_free(nvroot); 7625 zpool_close(zhp); 7626 7627 return (ret); 7628 } 7629 7630 /* 7631 * zpool replace [-fsw] [-o property=value] <pool> <device> <new_device> 7632 * 7633 * -f Force attach, even if <new_device> appears to be in use. 7634 * -s Use sequential instead of healing reconstruction for resilver. 7635 * -o Set property=value. 7636 * -w Wait for replacing to complete before returning 7637 * 7638 * Replace <device> with <new_device>. 7639 */ 7640 int 7641 zpool_do_replace(int argc, char **argv) 7642 { 7643 return (zpool_do_attach_or_replace(argc, argv, B_TRUE)); 7644 } 7645 7646 /* 7647 * zpool attach [-fsw] [-o property=value] <pool> <device>|<vdev> <new_device> 7648 * 7649 * -f Force attach, even if <new_device> appears to be in use. 7650 * -s Use sequential instead of healing reconstruction for resilver. 7651 * -o Set property=value. 7652 * -w Wait for resilvering (mirror) or expansion (raidz) to complete 7653 * before returning. 7654 * 7655 * Attach <new_device> to a <device> or <vdev>, where the vdev can be of type 7656 * mirror or raidz. If <device> is not part of a mirror, then <device> will 7657 * be transformed into a mirror of <device> and <new_device>. When a mirror 7658 * is involved, <new_device> will begin life with a DTL of [0, now], and will 7659 * immediately begin to resilver itself. For the raidz case, a expansion will 7660 * commence and reflow the raidz data across all the disks including the 7661 * <new_device>. 7662 */ 7663 int 7664 zpool_do_attach(int argc, char **argv) 7665 { 7666 return (zpool_do_attach_or_replace(argc, argv, B_FALSE)); 7667 } 7668 7669 /* 7670 * zpool detach [-f] <pool> <device> 7671 * 7672 * -f Force detach of <device>, even if DTLs argue against it 7673 * (not supported yet) 7674 * 7675 * Detach a device from a mirror. The operation will be refused if <device> 7676 * is the last device in the mirror, or if the DTLs indicate that this device 7677 * has the only valid copy of some data. 7678 */ 7679 int 7680 zpool_do_detach(int argc, char **argv) 7681 { 7682 int c; 7683 char *poolname, *path; 7684 zpool_handle_t *zhp; 7685 int ret; 7686 7687 /* check options */ 7688 while ((c = getopt(argc, argv, "")) != -1) { 7689 switch (c) { 7690 case '?': 7691 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 7692 optopt); 7693 usage(B_FALSE); 7694 } 7695 } 7696 7697 argc -= optind; 7698 argv += optind; 7699 7700 /* get pool name and check number of arguments */ 7701 if (argc < 1) { 7702 (void) fprintf(stderr, gettext("missing pool name argument\n")); 7703 usage(B_FALSE); 7704 } 7705 7706 if (argc < 2) { 7707 (void) fprintf(stderr, 7708 gettext("missing <device> specification\n")); 7709 usage(B_FALSE); 7710 } 7711 7712 poolname = argv[0]; 7713 path = argv[1]; 7714 7715 if ((zhp = zpool_open(g_zfs, poolname)) == NULL) 7716 return (1); 7717 7718 ret = zpool_vdev_detach(zhp, path); 7719 7720 zpool_close(zhp); 7721 7722 return (ret); 7723 } 7724 7725 /* 7726 * zpool split [-gLnP] [-o prop=val] ... 7727 * [-o mntopt] ... 7728 * [-R altroot] <pool> <newpool> [<device> ...] 7729 * 7730 * -g Display guid for individual vdev name. 7731 * -L Follow links when resolving vdev path name. 7732 * -n Do not split the pool, but display the resulting layout if 7733 * it were to be split. 7734 * -o Set property=value, or set mount options. 7735 * -P Display full path for vdev name. 7736 * -R Mount the split-off pool under an alternate root. 7737 * -l Load encryption keys while importing. 7738 * 7739 * Splits the named pool and gives it the new pool name. Devices to be split 7740 * off may be listed, provided that no more than one device is specified 7741 * per top-level vdev mirror. The newly split pool is left in an exported 7742 * state unless -R is specified. 7743 * 7744 * Restrictions: the top-level of the pool pool must only be made up of 7745 * mirrors; all devices in the pool must be healthy; no device may be 7746 * undergoing a resilvering operation. 7747 */ 7748 int 7749 zpool_do_split(int argc, char **argv) 7750 { 7751 char *srcpool, *newpool, *propval; 7752 char *mntopts = NULL; 7753 splitflags_t flags; 7754 int c, ret = 0; 7755 int ms_status = 0; 7756 boolean_t loadkeys = B_FALSE; 7757 zpool_handle_t *zhp; 7758 nvlist_t *config, *props = NULL; 7759 7760 flags.dryrun = B_FALSE; 7761 flags.import = B_FALSE; 7762 flags.name_flags = 0; 7763 7764 /* check options */ 7765 while ((c = getopt(argc, argv, ":gLR:lno:P")) != -1) { 7766 switch (c) { 7767 case 'g': 7768 flags.name_flags |= VDEV_NAME_GUID; 7769 break; 7770 case 'L': 7771 flags.name_flags |= VDEV_NAME_FOLLOW_LINKS; 7772 break; 7773 case 'R': 7774 flags.import = B_TRUE; 7775 if (add_prop_list( 7776 zpool_prop_to_name(ZPOOL_PROP_ALTROOT), optarg, 7777 &props, B_TRUE) != 0) { 7778 nvlist_free(props); 7779 usage(B_FALSE); 7780 } 7781 break; 7782 case 'l': 7783 loadkeys = B_TRUE; 7784 break; 7785 case 'n': 7786 flags.dryrun = B_TRUE; 7787 break; 7788 case 'o': 7789 if ((propval = strchr(optarg, '=')) != NULL) { 7790 *propval = '\0'; 7791 propval++; 7792 if (add_prop_list(optarg, propval, 7793 &props, B_TRUE) != 0) { 7794 nvlist_free(props); 7795 usage(B_FALSE); 7796 } 7797 } else { 7798 mntopts = optarg; 7799 } 7800 break; 7801 case 'P': 7802 flags.name_flags |= VDEV_NAME_PATH; 7803 break; 7804 case ':': 7805 (void) fprintf(stderr, gettext("missing argument for " 7806 "'%c' option\n"), optopt); 7807 usage(B_FALSE); 7808 break; 7809 case '?': 7810 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 7811 optopt); 7812 usage(B_FALSE); 7813 break; 7814 } 7815 } 7816 7817 if (!flags.import && mntopts != NULL) { 7818 (void) fprintf(stderr, gettext("setting mntopts is only " 7819 "valid when importing the pool\n")); 7820 usage(B_FALSE); 7821 } 7822 7823 if (!flags.import && loadkeys) { 7824 (void) fprintf(stderr, gettext("loading keys is only " 7825 "valid when importing the pool\n")); 7826 usage(B_FALSE); 7827 } 7828 7829 argc -= optind; 7830 argv += optind; 7831 7832 if (argc < 1) { 7833 (void) fprintf(stderr, gettext("Missing pool name\n")); 7834 usage(B_FALSE); 7835 } 7836 if (argc < 2) { 7837 (void) fprintf(stderr, gettext("Missing new pool name\n")); 7838 usage(B_FALSE); 7839 } 7840 7841 srcpool = argv[0]; 7842 newpool = argv[1]; 7843 7844 argc -= 2; 7845 argv += 2; 7846 7847 if ((zhp = zpool_open(g_zfs, srcpool)) == NULL) { 7848 nvlist_free(props); 7849 return (1); 7850 } 7851 7852 config = split_mirror_vdev(zhp, newpool, props, flags, argc, argv); 7853 if (config == NULL) { 7854 ret = 1; 7855 } else { 7856 if (flags.dryrun) { 7857 (void) printf(gettext("would create '%s' with the " 7858 "following layout:\n\n"), newpool); 7859 print_vdev_tree(NULL, newpool, config, 0, "", 7860 flags.name_flags); 7861 print_vdev_tree(NULL, "dedup", config, 0, 7862 VDEV_ALLOC_BIAS_DEDUP, 0); 7863 print_vdev_tree(NULL, "special", config, 0, 7864 VDEV_ALLOC_BIAS_SPECIAL, 0); 7865 } 7866 } 7867 7868 zpool_close(zhp); 7869 7870 if (ret != 0 || flags.dryrun || !flags.import) { 7871 nvlist_free(config); 7872 nvlist_free(props); 7873 return (ret); 7874 } 7875 7876 /* 7877 * The split was successful. Now we need to open the new 7878 * pool and import it. 7879 */ 7880 if ((zhp = zpool_open_canfail(g_zfs, newpool)) == NULL) { 7881 nvlist_free(config); 7882 nvlist_free(props); 7883 return (1); 7884 } 7885 7886 if (loadkeys) { 7887 ret = zfs_crypto_attempt_load_keys(g_zfs, newpool); 7888 if (ret != 0) 7889 ret = 1; 7890 } 7891 7892 if (zpool_get_state(zhp) != POOL_STATE_UNAVAIL) { 7893 ms_status = zpool_enable_datasets(zhp, mntopts, 0, 7894 mount_tp_nthr); 7895 if (ms_status == EZFS_SHAREFAILED) { 7896 (void) fprintf(stderr, gettext("Split was successful, " 7897 "datasets are mounted but sharing of some datasets " 7898 "has failed\n")); 7899 } else if (ms_status == EZFS_MOUNTFAILED) { 7900 (void) fprintf(stderr, gettext("Split was successful" 7901 ", but some datasets could not be mounted\n")); 7902 (void) fprintf(stderr, gettext("Try doing '%s' with a " 7903 "different altroot\n"), "zpool import"); 7904 } 7905 } 7906 zpool_close(zhp); 7907 nvlist_free(config); 7908 nvlist_free(props); 7909 7910 return (ret); 7911 } 7912 7913 7914 /* 7915 * zpool online [--power] <pool> <device> ... 7916 * 7917 * --power: Power on the enclosure slot to the drive (if possible) 7918 */ 7919 int 7920 zpool_do_online(int argc, char **argv) 7921 { 7922 int c, i; 7923 char *poolname; 7924 zpool_handle_t *zhp; 7925 int ret = 0; 7926 vdev_state_t newstate; 7927 int flags = 0; 7928 boolean_t is_power_on = B_FALSE; 7929 struct option long_options[] = { 7930 {"power", no_argument, NULL, ZPOOL_OPTION_POWER}, 7931 {0, 0, 0, 0} 7932 }; 7933 7934 /* check options */ 7935 while ((c = getopt_long(argc, argv, "e", long_options, NULL)) != -1) { 7936 switch (c) { 7937 case 'e': 7938 flags |= ZFS_ONLINE_EXPAND; 7939 break; 7940 case ZPOOL_OPTION_POWER: 7941 is_power_on = B_TRUE; 7942 break; 7943 case '?': 7944 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 7945 optopt); 7946 usage(B_FALSE); 7947 } 7948 } 7949 7950 if (libzfs_envvar_is_set("ZPOOL_AUTO_POWER_ON_SLOT")) 7951 is_power_on = B_TRUE; 7952 7953 argc -= optind; 7954 argv += optind; 7955 7956 /* get pool name and check number of arguments */ 7957 if (argc < 1) { 7958 (void) fprintf(stderr, gettext("missing pool name\n")); 7959 usage(B_FALSE); 7960 } 7961 if (argc < 2) { 7962 (void) fprintf(stderr, gettext("missing device name\n")); 7963 usage(B_FALSE); 7964 } 7965 7966 poolname = argv[0]; 7967 7968 if ((zhp = zpool_open(g_zfs, poolname)) == NULL) 7969 return (1); 7970 7971 for (i = 1; i < argc; i++) { 7972 vdev_state_t oldstate; 7973 boolean_t avail_spare, l2cache; 7974 int rc; 7975 7976 if (is_power_on) { 7977 rc = zpool_power_on_and_disk_wait(zhp, argv[i]); 7978 if (rc == ENOTSUP) { 7979 (void) fprintf(stderr, 7980 gettext("Power control not supported\n")); 7981 } 7982 if (rc != 0) 7983 return (rc); 7984 } 7985 7986 nvlist_t *tgt = zpool_find_vdev(zhp, argv[i], &avail_spare, 7987 &l2cache, NULL); 7988 if (tgt == NULL) { 7989 ret = 1; 7990 continue; 7991 } 7992 uint_t vsc; 7993 oldstate = ((vdev_stat_t *)fnvlist_lookup_uint64_array(tgt, 7994 ZPOOL_CONFIG_VDEV_STATS, &vsc))->vs_state; 7995 if (zpool_vdev_online(zhp, argv[i], flags, &newstate) == 0) { 7996 if (newstate != VDEV_STATE_HEALTHY) { 7997 (void) printf(gettext("warning: device '%s' " 7998 "onlined, but remains in faulted state\n"), 7999 argv[i]); 8000 if (newstate == VDEV_STATE_FAULTED) 8001 (void) printf(gettext("use 'zpool " 8002 "clear' to restore a faulted " 8003 "device\n")); 8004 else 8005 (void) printf(gettext("use 'zpool " 8006 "replace' to replace devices " 8007 "that are no longer present\n")); 8008 if ((flags & ZFS_ONLINE_EXPAND)) { 8009 (void) printf(gettext("%s: failed " 8010 "to expand usable space on " 8011 "unhealthy device '%s'\n"), 8012 (oldstate >= VDEV_STATE_DEGRADED ? 8013 "error" : "warning"), argv[i]); 8014 if (oldstate >= VDEV_STATE_DEGRADED) { 8015 ret = 1; 8016 break; 8017 } 8018 } 8019 } 8020 } else { 8021 ret = 1; 8022 } 8023 } 8024 8025 zpool_close(zhp); 8026 8027 return (ret); 8028 } 8029 8030 /* 8031 * zpool offline [-ft]|[--power] <pool> <device> ... 8032 * 8033 * 8034 * -f Force the device into a faulted state. 8035 * 8036 * -t Only take the device off-line temporarily. The offline/faulted 8037 * state will not be persistent across reboots. 8038 * 8039 * --power Power off the enclosure slot to the drive (if possible) 8040 */ 8041 int 8042 zpool_do_offline(int argc, char **argv) 8043 { 8044 int c, i; 8045 char *poolname; 8046 zpool_handle_t *zhp; 8047 int ret = 0; 8048 boolean_t istmp = B_FALSE; 8049 boolean_t fault = B_FALSE; 8050 boolean_t is_power_off = B_FALSE; 8051 8052 struct option long_options[] = { 8053 {"power", no_argument, NULL, ZPOOL_OPTION_POWER}, 8054 {0, 0, 0, 0} 8055 }; 8056 8057 /* check options */ 8058 while ((c = getopt_long(argc, argv, "ft", long_options, NULL)) != -1) { 8059 switch (c) { 8060 case 'f': 8061 fault = B_TRUE; 8062 break; 8063 case 't': 8064 istmp = B_TRUE; 8065 break; 8066 case ZPOOL_OPTION_POWER: 8067 is_power_off = B_TRUE; 8068 break; 8069 case '?': 8070 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 8071 optopt); 8072 usage(B_FALSE); 8073 } 8074 } 8075 8076 if (is_power_off && fault) { 8077 (void) fprintf(stderr, 8078 gettext("-0 and -f cannot be used together\n")); 8079 usage(B_FALSE); 8080 return (1); 8081 } 8082 8083 if (is_power_off && istmp) { 8084 (void) fprintf(stderr, 8085 gettext("-0 and -t cannot be used together\n")); 8086 usage(B_FALSE); 8087 return (1); 8088 } 8089 8090 argc -= optind; 8091 argv += optind; 8092 8093 /* get pool name and check number of arguments */ 8094 if (argc < 1) { 8095 (void) fprintf(stderr, gettext("missing pool name\n")); 8096 usage(B_FALSE); 8097 } 8098 if (argc < 2) { 8099 (void) fprintf(stderr, gettext("missing device name\n")); 8100 usage(B_FALSE); 8101 } 8102 8103 poolname = argv[0]; 8104 8105 if ((zhp = zpool_open(g_zfs, poolname)) == NULL) 8106 return (1); 8107 8108 for (i = 1; i < argc; i++) { 8109 uint64_t guid = zpool_vdev_path_to_guid(zhp, argv[i]); 8110 if (is_power_off) { 8111 /* 8112 * Note: we have to power off first, then set REMOVED, 8113 * or else zpool_vdev_set_removed_state() returns 8114 * EAGAIN. 8115 */ 8116 ret = zpool_power_off(zhp, argv[i]); 8117 if (ret != 0) { 8118 (void) fprintf(stderr, "%s %s %d\n", 8119 gettext("unable to power off slot for"), 8120 argv[i], ret); 8121 } 8122 zpool_vdev_set_removed_state(zhp, guid, VDEV_AUX_NONE); 8123 8124 } else if (fault) { 8125 vdev_aux_t aux; 8126 if (istmp == B_FALSE) { 8127 /* Force the fault to persist across imports */ 8128 aux = VDEV_AUX_EXTERNAL_PERSIST; 8129 } else { 8130 aux = VDEV_AUX_EXTERNAL; 8131 } 8132 8133 if (guid == 0 || zpool_vdev_fault(zhp, guid, aux) != 0) 8134 ret = 1; 8135 } else { 8136 if (zpool_vdev_offline(zhp, argv[i], istmp) != 0) 8137 ret = 1; 8138 } 8139 } 8140 8141 zpool_close(zhp); 8142 8143 return (ret); 8144 } 8145 8146 /* 8147 * zpool clear [-nF]|[--power] <pool> [device] 8148 * 8149 * Clear all errors associated with a pool or a particular device. 8150 */ 8151 int 8152 zpool_do_clear(int argc, char **argv) 8153 { 8154 int c; 8155 int ret = 0; 8156 boolean_t dryrun = B_FALSE; 8157 boolean_t do_rewind = B_FALSE; 8158 boolean_t xtreme_rewind = B_FALSE; 8159 boolean_t is_power_on = B_FALSE; 8160 uint32_t rewind_policy = ZPOOL_NO_REWIND; 8161 nvlist_t *policy = NULL; 8162 zpool_handle_t *zhp; 8163 char *pool, *device; 8164 8165 struct option long_options[] = { 8166 {"power", no_argument, NULL, ZPOOL_OPTION_POWER}, 8167 {0, 0, 0, 0} 8168 }; 8169 8170 /* check options */ 8171 while ((c = getopt_long(argc, argv, "FnX", long_options, 8172 NULL)) != -1) { 8173 switch (c) { 8174 case 'F': 8175 do_rewind = B_TRUE; 8176 break; 8177 case 'n': 8178 dryrun = B_TRUE; 8179 break; 8180 case 'X': 8181 xtreme_rewind = B_TRUE; 8182 break; 8183 case ZPOOL_OPTION_POWER: 8184 is_power_on = B_TRUE; 8185 break; 8186 case '?': 8187 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 8188 optopt); 8189 usage(B_FALSE); 8190 } 8191 } 8192 8193 if (libzfs_envvar_is_set("ZPOOL_AUTO_POWER_ON_SLOT")) 8194 is_power_on = B_TRUE; 8195 8196 argc -= optind; 8197 argv += optind; 8198 8199 if (argc < 1) { 8200 (void) fprintf(stderr, gettext("missing pool name\n")); 8201 usage(B_FALSE); 8202 } 8203 8204 if (argc > 2) { 8205 (void) fprintf(stderr, gettext("too many arguments\n")); 8206 usage(B_FALSE); 8207 } 8208 8209 if ((dryrun || xtreme_rewind) && !do_rewind) { 8210 (void) fprintf(stderr, 8211 gettext("-n or -X only meaningful with -F\n")); 8212 usage(B_FALSE); 8213 } 8214 if (dryrun) 8215 rewind_policy = ZPOOL_TRY_REWIND; 8216 else if (do_rewind) 8217 rewind_policy = ZPOOL_DO_REWIND; 8218 if (xtreme_rewind) 8219 rewind_policy |= ZPOOL_EXTREME_REWIND; 8220 8221 /* In future, further rewind policy choices can be passed along here */ 8222 if (nvlist_alloc(&policy, NV_UNIQUE_NAME, 0) != 0 || 8223 nvlist_add_uint32(policy, ZPOOL_LOAD_REWIND_POLICY, 8224 rewind_policy) != 0) { 8225 return (1); 8226 } 8227 8228 pool = argv[0]; 8229 device = argc == 2 ? argv[1] : NULL; 8230 8231 if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL) { 8232 nvlist_free(policy); 8233 return (1); 8234 } 8235 8236 if (is_power_on) { 8237 if (device == NULL) { 8238 zpool_power_on_pool_and_wait_for_devices(zhp); 8239 } else { 8240 zpool_power_on_and_disk_wait(zhp, device); 8241 } 8242 } 8243 8244 if (zpool_clear(zhp, device, policy) != 0) 8245 ret = 1; 8246 8247 zpool_close(zhp); 8248 8249 nvlist_free(policy); 8250 8251 return (ret); 8252 } 8253 8254 /* 8255 * zpool reguid [-g <guid>] <pool> 8256 */ 8257 int 8258 zpool_do_reguid(int argc, char **argv) 8259 { 8260 uint64_t guid; 8261 uint64_t *guidp = NULL; 8262 int c; 8263 char *endptr; 8264 char *poolname; 8265 zpool_handle_t *zhp; 8266 int ret = 0; 8267 8268 /* check options */ 8269 while ((c = getopt(argc, argv, "g:")) != -1) { 8270 switch (c) { 8271 case 'g': 8272 errno = 0; 8273 guid = strtoull(optarg, &endptr, 10); 8274 if (errno != 0 || *endptr != '\0') { 8275 (void) fprintf(stderr, 8276 gettext("invalid GUID: %s\n"), optarg); 8277 usage(B_FALSE); 8278 } 8279 guidp = &guid; 8280 break; 8281 case '?': 8282 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 8283 optopt); 8284 usage(B_FALSE); 8285 } 8286 } 8287 8288 argc -= optind; 8289 argv += optind; 8290 8291 /* get pool name and check number of arguments */ 8292 if (argc < 1) { 8293 (void) fprintf(stderr, gettext("missing pool name\n")); 8294 usage(B_FALSE); 8295 } 8296 8297 if (argc > 1) { 8298 (void) fprintf(stderr, gettext("too many arguments\n")); 8299 usage(B_FALSE); 8300 } 8301 8302 poolname = argv[0]; 8303 if ((zhp = zpool_open(g_zfs, poolname)) == NULL) 8304 return (1); 8305 8306 ret = zpool_set_guid(zhp, guidp); 8307 8308 zpool_close(zhp); 8309 return (ret); 8310 } 8311 8312 8313 /* 8314 * zpool reopen <pool> 8315 * 8316 * Reopen the pool so that the kernel can update the sizes of all vdevs. 8317 */ 8318 int 8319 zpool_do_reopen(int argc, char **argv) 8320 { 8321 int c; 8322 int ret = 0; 8323 boolean_t scrub_restart = B_TRUE; 8324 8325 /* check options */ 8326 while ((c = getopt(argc, argv, "n")) != -1) { 8327 switch (c) { 8328 case 'n': 8329 scrub_restart = B_FALSE; 8330 break; 8331 case '?': 8332 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 8333 optopt); 8334 usage(B_FALSE); 8335 } 8336 } 8337 8338 argc -= optind; 8339 argv += optind; 8340 8341 /* if argc == 0 we will execute zpool_reopen_one on all pools */ 8342 ret = for_each_pool(argc, argv, B_TRUE, NULL, ZFS_TYPE_POOL, 8343 B_FALSE, zpool_reopen_one, &scrub_restart); 8344 8345 return (ret); 8346 } 8347 8348 typedef struct scrub_cbdata { 8349 int cb_type; 8350 pool_scrub_cmd_t cb_scrub_cmd; 8351 } scrub_cbdata_t; 8352 8353 static boolean_t 8354 zpool_has_checkpoint(zpool_handle_t *zhp) 8355 { 8356 nvlist_t *config, *nvroot; 8357 8358 config = zpool_get_config(zhp, NULL); 8359 8360 if (config != NULL) { 8361 pool_checkpoint_stat_t *pcs = NULL; 8362 uint_t c; 8363 8364 nvroot = fnvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE); 8365 (void) nvlist_lookup_uint64_array(nvroot, 8366 ZPOOL_CONFIG_CHECKPOINT_STATS, (uint64_t **)&pcs, &c); 8367 8368 if (pcs == NULL || pcs->pcs_state == CS_NONE) 8369 return (B_FALSE); 8370 8371 assert(pcs->pcs_state == CS_CHECKPOINT_EXISTS || 8372 pcs->pcs_state == CS_CHECKPOINT_DISCARDING); 8373 return (B_TRUE); 8374 } 8375 8376 return (B_FALSE); 8377 } 8378 8379 static int 8380 scrub_callback(zpool_handle_t *zhp, void *data) 8381 { 8382 scrub_cbdata_t *cb = data; 8383 int err; 8384 8385 /* 8386 * Ignore faulted pools. 8387 */ 8388 if (zpool_get_state(zhp) == POOL_STATE_UNAVAIL) { 8389 (void) fprintf(stderr, gettext("cannot scan '%s': pool is " 8390 "currently unavailable\n"), zpool_get_name(zhp)); 8391 return (1); 8392 } 8393 8394 err = zpool_scan(zhp, cb->cb_type, cb->cb_scrub_cmd); 8395 8396 if (err == 0 && zpool_has_checkpoint(zhp) && 8397 cb->cb_type == POOL_SCAN_SCRUB) { 8398 (void) printf(gettext("warning: will not scrub state that " 8399 "belongs to the checkpoint of pool '%s'\n"), 8400 zpool_get_name(zhp)); 8401 } 8402 8403 return (err != 0); 8404 } 8405 8406 static int 8407 wait_callback(zpool_handle_t *zhp, void *data) 8408 { 8409 zpool_wait_activity_t *act = data; 8410 return (zpool_wait(zhp, *act)); 8411 } 8412 8413 /* 8414 * zpool scrub [-s | -p] [-w] [-e] <pool> ... 8415 * 8416 * -e Only scrub blocks in the error log. 8417 * -s Stop. Stops any in-progress scrub. 8418 * -p Pause. Pause in-progress scrub. 8419 * -w Wait. Blocks until scrub has completed. 8420 */ 8421 int 8422 zpool_do_scrub(int argc, char **argv) 8423 { 8424 int c; 8425 scrub_cbdata_t cb; 8426 boolean_t wait = B_FALSE; 8427 int error; 8428 8429 cb.cb_type = POOL_SCAN_SCRUB; 8430 cb.cb_scrub_cmd = POOL_SCRUB_NORMAL; 8431 8432 boolean_t is_error_scrub = B_FALSE; 8433 boolean_t is_pause = B_FALSE; 8434 boolean_t is_stop = B_FALSE; 8435 8436 /* check options */ 8437 while ((c = getopt(argc, argv, "spwe")) != -1) { 8438 switch (c) { 8439 case 'e': 8440 is_error_scrub = B_TRUE; 8441 break; 8442 case 's': 8443 is_stop = B_TRUE; 8444 break; 8445 case 'p': 8446 is_pause = B_TRUE; 8447 break; 8448 case 'w': 8449 wait = B_TRUE; 8450 break; 8451 case '?': 8452 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 8453 optopt); 8454 usage(B_FALSE); 8455 } 8456 } 8457 8458 if (is_pause && is_stop) { 8459 (void) fprintf(stderr, gettext("invalid option " 8460 "combination :-s and -p are mutually exclusive\n")); 8461 usage(B_FALSE); 8462 } else { 8463 if (is_error_scrub) 8464 cb.cb_type = POOL_SCAN_ERRORSCRUB; 8465 8466 if (is_pause) { 8467 cb.cb_scrub_cmd = POOL_SCRUB_PAUSE; 8468 } else if (is_stop) { 8469 cb.cb_type = POOL_SCAN_NONE; 8470 } else { 8471 cb.cb_scrub_cmd = POOL_SCRUB_NORMAL; 8472 } 8473 } 8474 8475 if (wait && (cb.cb_type == POOL_SCAN_NONE || 8476 cb.cb_scrub_cmd == POOL_SCRUB_PAUSE)) { 8477 (void) fprintf(stderr, gettext("invalid option combination: " 8478 "-w cannot be used with -p or -s\n")); 8479 usage(B_FALSE); 8480 } 8481 8482 argc -= optind; 8483 argv += optind; 8484 8485 if (argc < 1) { 8486 (void) fprintf(stderr, gettext("missing pool name argument\n")); 8487 usage(B_FALSE); 8488 } 8489 8490 error = for_each_pool(argc, argv, B_TRUE, NULL, ZFS_TYPE_POOL, 8491 B_FALSE, scrub_callback, &cb); 8492 8493 if (wait && !error) { 8494 zpool_wait_activity_t act = ZPOOL_WAIT_SCRUB; 8495 error = for_each_pool(argc, argv, B_TRUE, NULL, ZFS_TYPE_POOL, 8496 B_FALSE, wait_callback, &act); 8497 } 8498 8499 return (error); 8500 } 8501 8502 /* 8503 * zpool resilver <pool> ... 8504 * 8505 * Restarts any in-progress resilver 8506 */ 8507 int 8508 zpool_do_resilver(int argc, char **argv) 8509 { 8510 int c; 8511 scrub_cbdata_t cb; 8512 8513 cb.cb_type = POOL_SCAN_RESILVER; 8514 cb.cb_scrub_cmd = POOL_SCRUB_NORMAL; 8515 8516 /* check options */ 8517 while ((c = getopt(argc, argv, "")) != -1) { 8518 switch (c) { 8519 case '?': 8520 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 8521 optopt); 8522 usage(B_FALSE); 8523 } 8524 } 8525 8526 argc -= optind; 8527 argv += optind; 8528 8529 if (argc < 1) { 8530 (void) fprintf(stderr, gettext("missing pool name argument\n")); 8531 usage(B_FALSE); 8532 } 8533 8534 return (for_each_pool(argc, argv, B_TRUE, NULL, ZFS_TYPE_POOL, 8535 B_FALSE, scrub_callback, &cb)); 8536 } 8537 8538 /* 8539 * zpool trim [-d] [-r <rate>] [-c | -s] <pool> [<device> ...] 8540 * 8541 * -c Cancel. Ends any in-progress trim. 8542 * -d Secure trim. Requires kernel and device support. 8543 * -r <rate> Sets the TRIM rate in bytes (per second). Supports 8544 * adding a multiplier suffix such as 'k' or 'm'. 8545 * -s Suspend. TRIM can then be restarted with no flags. 8546 * -w Wait. Blocks until trimming has completed. 8547 */ 8548 int 8549 zpool_do_trim(int argc, char **argv) 8550 { 8551 struct option long_options[] = { 8552 {"cancel", no_argument, NULL, 'c'}, 8553 {"secure", no_argument, NULL, 'd'}, 8554 {"rate", required_argument, NULL, 'r'}, 8555 {"suspend", no_argument, NULL, 's'}, 8556 {"wait", no_argument, NULL, 'w'}, 8557 {0, 0, 0, 0} 8558 }; 8559 8560 pool_trim_func_t cmd_type = POOL_TRIM_START; 8561 uint64_t rate = 0; 8562 boolean_t secure = B_FALSE; 8563 boolean_t wait = B_FALSE; 8564 8565 int c; 8566 while ((c = getopt_long(argc, argv, "cdr:sw", long_options, NULL)) 8567 != -1) { 8568 switch (c) { 8569 case 'c': 8570 if (cmd_type != POOL_TRIM_START && 8571 cmd_type != POOL_TRIM_CANCEL) { 8572 (void) fprintf(stderr, gettext("-c cannot be " 8573 "combined with other options\n")); 8574 usage(B_FALSE); 8575 } 8576 cmd_type = POOL_TRIM_CANCEL; 8577 break; 8578 case 'd': 8579 if (cmd_type != POOL_TRIM_START) { 8580 (void) fprintf(stderr, gettext("-d cannot be " 8581 "combined with the -c or -s options\n")); 8582 usage(B_FALSE); 8583 } 8584 secure = B_TRUE; 8585 break; 8586 case 'r': 8587 if (cmd_type != POOL_TRIM_START) { 8588 (void) fprintf(stderr, gettext("-r cannot be " 8589 "combined with the -c or -s options\n")); 8590 usage(B_FALSE); 8591 } 8592 if (zfs_nicestrtonum(g_zfs, optarg, &rate) == -1) { 8593 (void) fprintf(stderr, "%s: %s\n", 8594 gettext("invalid value for rate"), 8595 libzfs_error_description(g_zfs)); 8596 usage(B_FALSE); 8597 } 8598 break; 8599 case 's': 8600 if (cmd_type != POOL_TRIM_START && 8601 cmd_type != POOL_TRIM_SUSPEND) { 8602 (void) fprintf(stderr, gettext("-s cannot be " 8603 "combined with other options\n")); 8604 usage(B_FALSE); 8605 } 8606 cmd_type = POOL_TRIM_SUSPEND; 8607 break; 8608 case 'w': 8609 wait = B_TRUE; 8610 break; 8611 case '?': 8612 if (optopt != 0) { 8613 (void) fprintf(stderr, 8614 gettext("invalid option '%c'\n"), optopt); 8615 } else { 8616 (void) fprintf(stderr, 8617 gettext("invalid option '%s'\n"), 8618 argv[optind - 1]); 8619 } 8620 usage(B_FALSE); 8621 } 8622 } 8623 8624 argc -= optind; 8625 argv += optind; 8626 8627 if (argc < 1) { 8628 (void) fprintf(stderr, gettext("missing pool name argument\n")); 8629 usage(B_FALSE); 8630 return (-1); 8631 } 8632 8633 if (wait && (cmd_type != POOL_TRIM_START)) { 8634 (void) fprintf(stderr, gettext("-w cannot be used with -c or " 8635 "-s\n")); 8636 usage(B_FALSE); 8637 } 8638 8639 char *poolname = argv[0]; 8640 zpool_handle_t *zhp = zpool_open(g_zfs, poolname); 8641 if (zhp == NULL) 8642 return (-1); 8643 8644 trimflags_t trim_flags = { 8645 .secure = secure, 8646 .rate = rate, 8647 .wait = wait, 8648 }; 8649 8650 nvlist_t *vdevs = fnvlist_alloc(); 8651 if (argc == 1) { 8652 /* no individual leaf vdevs specified, so add them all */ 8653 nvlist_t *config = zpool_get_config(zhp, NULL); 8654 nvlist_t *nvroot = fnvlist_lookup_nvlist(config, 8655 ZPOOL_CONFIG_VDEV_TREE); 8656 zpool_collect_leaves(zhp, nvroot, vdevs); 8657 trim_flags.fullpool = B_TRUE; 8658 } else { 8659 trim_flags.fullpool = B_FALSE; 8660 for (int i = 1; i < argc; i++) { 8661 fnvlist_add_boolean(vdevs, argv[i]); 8662 } 8663 } 8664 8665 int error = zpool_trim(zhp, cmd_type, vdevs, &trim_flags); 8666 8667 fnvlist_free(vdevs); 8668 zpool_close(zhp); 8669 8670 return (error); 8671 } 8672 8673 /* 8674 * Converts a total number of seconds to a human readable string broken 8675 * down in to days/hours/minutes/seconds. 8676 */ 8677 static void 8678 secs_to_dhms(uint64_t total, char *buf) 8679 { 8680 uint64_t days = total / 60 / 60 / 24; 8681 uint64_t hours = (total / 60 / 60) % 24; 8682 uint64_t mins = (total / 60) % 60; 8683 uint64_t secs = (total % 60); 8684 8685 if (days > 0) { 8686 (void) sprintf(buf, "%llu days %02llu:%02llu:%02llu", 8687 (u_longlong_t)days, (u_longlong_t)hours, 8688 (u_longlong_t)mins, (u_longlong_t)secs); 8689 } else { 8690 (void) sprintf(buf, "%02llu:%02llu:%02llu", 8691 (u_longlong_t)hours, (u_longlong_t)mins, 8692 (u_longlong_t)secs); 8693 } 8694 } 8695 8696 /* 8697 * Print out detailed error scrub status. 8698 */ 8699 static void 8700 print_err_scrub_status(pool_scan_stat_t *ps) 8701 { 8702 time_t start, end, pause; 8703 uint64_t total_secs_left; 8704 uint64_t secs_left, mins_left, hours_left, days_left; 8705 uint64_t examined, to_be_examined; 8706 8707 if (ps == NULL || ps->pss_error_scrub_func != POOL_SCAN_ERRORSCRUB) { 8708 return; 8709 } 8710 8711 (void) printf(gettext(" scrub: ")); 8712 8713 start = ps->pss_error_scrub_start; 8714 end = ps->pss_error_scrub_end; 8715 pause = ps->pss_pass_error_scrub_pause; 8716 examined = ps->pss_error_scrub_examined; 8717 to_be_examined = ps->pss_error_scrub_to_be_examined; 8718 8719 assert(ps->pss_error_scrub_func == POOL_SCAN_ERRORSCRUB); 8720 8721 if (ps->pss_error_scrub_state == DSS_FINISHED) { 8722 total_secs_left = end - start; 8723 days_left = total_secs_left / 60 / 60 / 24; 8724 hours_left = (total_secs_left / 60 / 60) % 24; 8725 mins_left = (total_secs_left / 60) % 60; 8726 secs_left = (total_secs_left % 60); 8727 8728 (void) printf(gettext("scrubbed %llu error blocks in %llu days " 8729 "%02llu:%02llu:%02llu on %s"), (u_longlong_t)examined, 8730 (u_longlong_t)days_left, (u_longlong_t)hours_left, 8731 (u_longlong_t)mins_left, (u_longlong_t)secs_left, 8732 ctime(&end)); 8733 8734 return; 8735 } else if (ps->pss_error_scrub_state == DSS_CANCELED) { 8736 (void) printf(gettext("error scrub canceled on %s"), 8737 ctime(&end)); 8738 return; 8739 } 8740 assert(ps->pss_error_scrub_state == DSS_ERRORSCRUBBING); 8741 8742 /* Error scrub is in progress. */ 8743 if (pause == 0) { 8744 (void) printf(gettext("error scrub in progress since %s"), 8745 ctime(&start)); 8746 } else { 8747 (void) printf(gettext("error scrub paused since %s"), 8748 ctime(&pause)); 8749 (void) printf(gettext("\terror scrub started on %s"), 8750 ctime(&start)); 8751 } 8752 8753 double fraction_done = (double)examined / (to_be_examined + examined); 8754 (void) printf(gettext("\t%.2f%% done, issued I/O for %llu error" 8755 " blocks"), 100 * fraction_done, (u_longlong_t)examined); 8756 8757 (void) printf("\n"); 8758 } 8759 8760 /* 8761 * Print out detailed scrub status. 8762 */ 8763 static void 8764 print_scan_scrub_resilver_status(pool_scan_stat_t *ps) 8765 { 8766 time_t start, end, pause; 8767 uint64_t pass_scanned, scanned, pass_issued, issued, total_s, total_i; 8768 uint64_t elapsed, scan_rate, issue_rate; 8769 double fraction_done; 8770 char processed_buf[7], scanned_buf[7], issued_buf[7], total_s_buf[7]; 8771 char total_i_buf[7], srate_buf[7], irate_buf[7], time_buf[32]; 8772 8773 printf(" "); 8774 printf_color(ANSI_BOLD, gettext("scan:")); 8775 printf(" "); 8776 8777 /* If there's never been a scan, there's not much to say. */ 8778 if (ps == NULL || ps->pss_func == POOL_SCAN_NONE || 8779 ps->pss_func >= POOL_SCAN_FUNCS) { 8780 (void) printf(gettext("none requested\n")); 8781 return; 8782 } 8783 8784 start = ps->pss_start_time; 8785 end = ps->pss_end_time; 8786 pause = ps->pss_pass_scrub_pause; 8787 8788 zfs_nicebytes(ps->pss_processed, processed_buf, sizeof (processed_buf)); 8789 8790 int is_resilver = ps->pss_func == POOL_SCAN_RESILVER; 8791 int is_scrub = ps->pss_func == POOL_SCAN_SCRUB; 8792 assert(is_resilver || is_scrub); 8793 8794 /* Scan is finished or canceled. */ 8795 if (ps->pss_state == DSS_FINISHED) { 8796 secs_to_dhms(end - start, time_buf); 8797 8798 if (is_scrub) { 8799 (void) printf(gettext("scrub repaired %s " 8800 "in %s with %llu errors on %s"), processed_buf, 8801 time_buf, (u_longlong_t)ps->pss_errors, 8802 ctime(&end)); 8803 } else if (is_resilver) { 8804 (void) printf(gettext("resilvered %s " 8805 "in %s with %llu errors on %s"), processed_buf, 8806 time_buf, (u_longlong_t)ps->pss_errors, 8807 ctime(&end)); 8808 } 8809 return; 8810 } else if (ps->pss_state == DSS_CANCELED) { 8811 if (is_scrub) { 8812 (void) printf(gettext("scrub canceled on %s"), 8813 ctime(&end)); 8814 } else if (is_resilver) { 8815 (void) printf(gettext("resilver canceled on %s"), 8816 ctime(&end)); 8817 } 8818 return; 8819 } 8820 8821 assert(ps->pss_state == DSS_SCANNING); 8822 8823 /* Scan is in progress. Resilvers can't be paused. */ 8824 if (is_scrub) { 8825 if (pause == 0) { 8826 (void) printf(gettext("scrub in progress since %s"), 8827 ctime(&start)); 8828 } else { 8829 (void) printf(gettext("scrub paused since %s"), 8830 ctime(&pause)); 8831 (void) printf(gettext("\tscrub started on %s"), 8832 ctime(&start)); 8833 } 8834 } else if (is_resilver) { 8835 (void) printf(gettext("resilver in progress since %s"), 8836 ctime(&start)); 8837 } 8838 8839 scanned = ps->pss_examined; 8840 pass_scanned = ps->pss_pass_exam; 8841 issued = ps->pss_issued; 8842 pass_issued = ps->pss_pass_issued; 8843 total_s = ps->pss_to_examine; 8844 total_i = ps->pss_to_examine - ps->pss_skipped; 8845 8846 /* we are only done with a block once we have issued the IO for it */ 8847 fraction_done = (double)issued / total_i; 8848 8849 /* elapsed time for this pass, rounding up to 1 if it's 0 */ 8850 elapsed = time(NULL) - ps->pss_pass_start; 8851 elapsed -= ps->pss_pass_scrub_spent_paused; 8852 elapsed = (elapsed != 0) ? elapsed : 1; 8853 8854 scan_rate = pass_scanned / elapsed; 8855 issue_rate = pass_issued / elapsed; 8856 8857 /* format all of the numbers we will be reporting */ 8858 zfs_nicebytes(scanned, scanned_buf, sizeof (scanned_buf)); 8859 zfs_nicebytes(issued, issued_buf, sizeof (issued_buf)); 8860 zfs_nicebytes(total_s, total_s_buf, sizeof (total_s_buf)); 8861 zfs_nicebytes(total_i, total_i_buf, sizeof (total_i_buf)); 8862 8863 /* do not print estimated time if we have a paused scrub */ 8864 (void) printf(gettext("\t%s / %s scanned"), scanned_buf, total_s_buf); 8865 if (pause == 0 && scan_rate > 0) { 8866 zfs_nicebytes(scan_rate, srate_buf, sizeof (srate_buf)); 8867 (void) printf(gettext(" at %s/s"), srate_buf); 8868 } 8869 (void) printf(gettext(", %s / %s issued"), issued_buf, total_i_buf); 8870 if (pause == 0 && issue_rate > 0) { 8871 zfs_nicebytes(issue_rate, irate_buf, sizeof (irate_buf)); 8872 (void) printf(gettext(" at %s/s"), irate_buf); 8873 } 8874 (void) printf(gettext("\n")); 8875 8876 if (is_resilver) { 8877 (void) printf(gettext("\t%s resilvered, %.2f%% done"), 8878 processed_buf, 100 * fraction_done); 8879 } else if (is_scrub) { 8880 (void) printf(gettext("\t%s repaired, %.2f%% done"), 8881 processed_buf, 100 * fraction_done); 8882 } 8883 8884 if (pause == 0) { 8885 /* 8886 * Only provide an estimate iff: 8887 * 1) we haven't yet issued all we expected, and 8888 * 2) the issue rate exceeds 10 MB/s, and 8889 * 3) it's either: 8890 * a) a resilver which has started repairs, or 8891 * b) a scrub which has entered the issue phase. 8892 */ 8893 if (total_i >= issued && issue_rate >= 10 * 1024 * 1024 && 8894 ((is_resilver && ps->pss_processed > 0) || 8895 (is_scrub && issued > 0))) { 8896 secs_to_dhms((total_i - issued) / issue_rate, time_buf); 8897 (void) printf(gettext(", %s to go\n"), time_buf); 8898 } else { 8899 (void) printf(gettext(", no estimated " 8900 "completion time\n")); 8901 } 8902 } else { 8903 (void) printf(gettext("\n")); 8904 } 8905 } 8906 8907 static void 8908 print_rebuild_status_impl(vdev_rebuild_stat_t *vrs, uint_t c, char *vdev_name) 8909 { 8910 if (vrs == NULL || vrs->vrs_state == VDEV_REBUILD_NONE) 8911 return; 8912 8913 printf(" "); 8914 printf_color(ANSI_BOLD, gettext("scan:")); 8915 printf(" "); 8916 8917 uint64_t bytes_scanned = vrs->vrs_bytes_scanned; 8918 uint64_t bytes_issued = vrs->vrs_bytes_issued; 8919 uint64_t bytes_rebuilt = vrs->vrs_bytes_rebuilt; 8920 uint64_t bytes_est_s = vrs->vrs_bytes_est; 8921 uint64_t bytes_est_i = vrs->vrs_bytes_est; 8922 if (c > offsetof(vdev_rebuild_stat_t, vrs_pass_bytes_skipped) / 8) 8923 bytes_est_i -= vrs->vrs_pass_bytes_skipped; 8924 uint64_t scan_rate = (vrs->vrs_pass_bytes_scanned / 8925 (vrs->vrs_pass_time_ms + 1)) * 1000; 8926 uint64_t issue_rate = (vrs->vrs_pass_bytes_issued / 8927 (vrs->vrs_pass_time_ms + 1)) * 1000; 8928 double scan_pct = MIN((double)bytes_scanned * 100 / 8929 (bytes_est_s + 1), 100); 8930 8931 /* Format all of the numbers we will be reporting */ 8932 char bytes_scanned_buf[7], bytes_issued_buf[7]; 8933 char bytes_rebuilt_buf[7], bytes_est_s_buf[7], bytes_est_i_buf[7]; 8934 char scan_rate_buf[7], issue_rate_buf[7], time_buf[32]; 8935 zfs_nicebytes(bytes_scanned, bytes_scanned_buf, 8936 sizeof (bytes_scanned_buf)); 8937 zfs_nicebytes(bytes_issued, bytes_issued_buf, 8938 sizeof (bytes_issued_buf)); 8939 zfs_nicebytes(bytes_rebuilt, bytes_rebuilt_buf, 8940 sizeof (bytes_rebuilt_buf)); 8941 zfs_nicebytes(bytes_est_s, bytes_est_s_buf, sizeof (bytes_est_s_buf)); 8942 zfs_nicebytes(bytes_est_i, bytes_est_i_buf, sizeof (bytes_est_i_buf)); 8943 8944 time_t start = vrs->vrs_start_time; 8945 time_t end = vrs->vrs_end_time; 8946 8947 /* Rebuild is finished or canceled. */ 8948 if (vrs->vrs_state == VDEV_REBUILD_COMPLETE) { 8949 secs_to_dhms(vrs->vrs_scan_time_ms / 1000, time_buf); 8950 (void) printf(gettext("resilvered (%s) %s in %s " 8951 "with %llu errors on %s"), vdev_name, bytes_rebuilt_buf, 8952 time_buf, (u_longlong_t)vrs->vrs_errors, ctime(&end)); 8953 return; 8954 } else if (vrs->vrs_state == VDEV_REBUILD_CANCELED) { 8955 (void) printf(gettext("resilver (%s) canceled on %s"), 8956 vdev_name, ctime(&end)); 8957 return; 8958 } else if (vrs->vrs_state == VDEV_REBUILD_ACTIVE) { 8959 (void) printf(gettext("resilver (%s) in progress since %s"), 8960 vdev_name, ctime(&start)); 8961 } 8962 8963 assert(vrs->vrs_state == VDEV_REBUILD_ACTIVE); 8964 8965 (void) printf(gettext("\t%s / %s scanned"), bytes_scanned_buf, 8966 bytes_est_s_buf); 8967 if (scan_rate > 0) { 8968 zfs_nicebytes(scan_rate, scan_rate_buf, sizeof (scan_rate_buf)); 8969 (void) printf(gettext(" at %s/s"), scan_rate_buf); 8970 } 8971 (void) printf(gettext(", %s / %s issued"), bytes_issued_buf, 8972 bytes_est_i_buf); 8973 if (issue_rate > 0) { 8974 zfs_nicebytes(issue_rate, issue_rate_buf, 8975 sizeof (issue_rate_buf)); 8976 (void) printf(gettext(" at %s/s"), issue_rate_buf); 8977 } 8978 (void) printf(gettext("\n")); 8979 8980 (void) printf(gettext("\t%s resilvered, %.2f%% done"), 8981 bytes_rebuilt_buf, scan_pct); 8982 8983 if (vrs->vrs_state == VDEV_REBUILD_ACTIVE) { 8984 if (bytes_est_s >= bytes_scanned && 8985 scan_rate >= 10 * 1024 * 1024) { 8986 secs_to_dhms((bytes_est_s - bytes_scanned) / scan_rate, 8987 time_buf); 8988 (void) printf(gettext(", %s to go\n"), time_buf); 8989 } else { 8990 (void) printf(gettext(", no estimated " 8991 "completion time\n")); 8992 } 8993 } else { 8994 (void) printf(gettext("\n")); 8995 } 8996 } 8997 8998 /* 8999 * Print rebuild status for top-level vdevs. 9000 */ 9001 static void 9002 print_rebuild_status(zpool_handle_t *zhp, nvlist_t *nvroot) 9003 { 9004 nvlist_t **child; 9005 uint_t children; 9006 9007 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN, 9008 &child, &children) != 0) 9009 children = 0; 9010 9011 for (uint_t c = 0; c < children; c++) { 9012 vdev_rebuild_stat_t *vrs; 9013 uint_t i; 9014 9015 if (nvlist_lookup_uint64_array(child[c], 9016 ZPOOL_CONFIG_REBUILD_STATS, (uint64_t **)&vrs, &i) == 0) { 9017 char *name = zpool_vdev_name(g_zfs, zhp, 9018 child[c], VDEV_NAME_TYPE_ID); 9019 print_rebuild_status_impl(vrs, i, name); 9020 free(name); 9021 } 9022 } 9023 } 9024 9025 /* 9026 * As we don't scrub checkpointed blocks, we want to warn the user that we 9027 * skipped scanning some blocks if a checkpoint exists or existed at any 9028 * time during the scan. If a sequential instead of healing reconstruction 9029 * was performed then the blocks were reconstructed. However, their checksums 9030 * have not been verified so we still print the warning. 9031 */ 9032 static void 9033 print_checkpoint_scan_warning(pool_scan_stat_t *ps, pool_checkpoint_stat_t *pcs) 9034 { 9035 if (ps == NULL || pcs == NULL) 9036 return; 9037 9038 if (pcs->pcs_state == CS_NONE || 9039 pcs->pcs_state == CS_CHECKPOINT_DISCARDING) 9040 return; 9041 9042 assert(pcs->pcs_state == CS_CHECKPOINT_EXISTS); 9043 9044 if (ps->pss_state == DSS_NONE) 9045 return; 9046 9047 if ((ps->pss_state == DSS_FINISHED || ps->pss_state == DSS_CANCELED) && 9048 ps->pss_end_time < pcs->pcs_start_time) 9049 return; 9050 9051 if (ps->pss_state == DSS_FINISHED || ps->pss_state == DSS_CANCELED) { 9052 (void) printf(gettext(" scan warning: skipped blocks " 9053 "that are only referenced by the checkpoint.\n")); 9054 } else { 9055 assert(ps->pss_state == DSS_SCANNING); 9056 (void) printf(gettext(" scan warning: skipping blocks " 9057 "that are only referenced by the checkpoint.\n")); 9058 } 9059 } 9060 9061 /* 9062 * Returns B_TRUE if there is an active rebuild in progress. Otherwise, 9063 * B_FALSE is returned and 'rebuild_end_time' is set to the end time for 9064 * the last completed (or cancelled) rebuild. 9065 */ 9066 static boolean_t 9067 check_rebuilding(nvlist_t *nvroot, uint64_t *rebuild_end_time) 9068 { 9069 nvlist_t **child; 9070 uint_t children; 9071 boolean_t rebuilding = B_FALSE; 9072 uint64_t end_time = 0; 9073 9074 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN, 9075 &child, &children) != 0) 9076 children = 0; 9077 9078 for (uint_t c = 0; c < children; c++) { 9079 vdev_rebuild_stat_t *vrs; 9080 uint_t i; 9081 9082 if (nvlist_lookup_uint64_array(child[c], 9083 ZPOOL_CONFIG_REBUILD_STATS, (uint64_t **)&vrs, &i) == 0) { 9084 9085 if (vrs->vrs_end_time > end_time) 9086 end_time = vrs->vrs_end_time; 9087 9088 if (vrs->vrs_state == VDEV_REBUILD_ACTIVE) { 9089 rebuilding = B_TRUE; 9090 end_time = 0; 9091 break; 9092 } 9093 } 9094 } 9095 9096 if (rebuild_end_time != NULL) 9097 *rebuild_end_time = end_time; 9098 9099 return (rebuilding); 9100 } 9101 9102 static void 9103 vdev_stats_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t *nv, 9104 int depth, boolean_t isspare, char *parent, nvlist_t *item) 9105 { 9106 nvlist_t *vds, **child, *ch = NULL; 9107 uint_t vsc, children; 9108 vdev_stat_t *vs; 9109 char *vname; 9110 uint64_t notpresent; 9111 const char *type, *path; 9112 9113 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, 9114 &child, &children) != 0) 9115 children = 0; 9116 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS, 9117 (uint64_t **)&vs, &vsc) == 0); 9118 verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE, &type) == 0); 9119 if (strcmp(type, VDEV_TYPE_INDIRECT) == 0) 9120 return; 9121 9122 if (cb->cb_print_unhealthy && depth > 0 && 9123 for_each_vdev_in_nvlist(nv, vdev_health_check_cb, cb) == 0) { 9124 return; 9125 } 9126 vname = zpool_vdev_name(g_zfs, zhp, nv, 9127 cb->cb_name_flags | VDEV_NAME_TYPE_ID); 9128 vds = fnvlist_alloc(); 9129 fill_vdev_info(vds, zhp, vname, B_FALSE, cb->cb_json_as_int); 9130 if (cb->cb_flat_vdevs && parent != NULL) { 9131 fnvlist_add_string(vds, "parent", parent); 9132 } 9133 9134 if (isspare) { 9135 if (vs->vs_aux == VDEV_AUX_SPARED) { 9136 fnvlist_add_string(vds, "state", "INUSE"); 9137 used_by_other(zhp, nv, vds); 9138 } else if (vs->vs_state == VDEV_STATE_HEALTHY) 9139 fnvlist_add_string(vds, "state", "AVAIL"); 9140 } else { 9141 if (vs->vs_alloc) { 9142 nice_num_str_nvlist(vds, "alloc_space", vs->vs_alloc, 9143 cb->cb_literal, cb->cb_json_as_int, 9144 ZFS_NICENUM_BYTES); 9145 } 9146 if (vs->vs_space) { 9147 nice_num_str_nvlist(vds, "total_space", vs->vs_space, 9148 cb->cb_literal, cb->cb_json_as_int, 9149 ZFS_NICENUM_BYTES); 9150 } 9151 if (vs->vs_dspace) { 9152 nice_num_str_nvlist(vds, "def_space", vs->vs_dspace, 9153 cb->cb_literal, cb->cb_json_as_int, 9154 ZFS_NICENUM_BYTES); 9155 } 9156 if (vs->vs_rsize) { 9157 nice_num_str_nvlist(vds, "rep_dev_size", vs->vs_rsize, 9158 cb->cb_literal, cb->cb_json_as_int, 9159 ZFS_NICENUM_BYTES); 9160 } 9161 if (vs->vs_esize) { 9162 nice_num_str_nvlist(vds, "ex_dev_size", vs->vs_esize, 9163 cb->cb_literal, cb->cb_json_as_int, 9164 ZFS_NICENUM_BYTES); 9165 } 9166 if (vs->vs_self_healed) { 9167 nice_num_str_nvlist(vds, "self_healed", 9168 vs->vs_self_healed, cb->cb_literal, 9169 cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9170 } 9171 if (vs->vs_pspace) { 9172 nice_num_str_nvlist(vds, "phys_space", vs->vs_pspace, 9173 cb->cb_literal, cb->cb_json_as_int, 9174 ZFS_NICENUM_BYTES); 9175 } 9176 nice_num_str_nvlist(vds, "read_errors", vs->vs_read_errors, 9177 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9178 nice_num_str_nvlist(vds, "write_errors", vs->vs_write_errors, 9179 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9180 nice_num_str_nvlist(vds, "checksum_errors", 9181 vs->vs_checksum_errors, cb->cb_literal, 9182 cb->cb_json_as_int, ZFS_NICENUM_1024); 9183 if (vs->vs_scan_processed) { 9184 nice_num_str_nvlist(vds, "scan_processed", 9185 vs->vs_scan_processed, cb->cb_literal, 9186 cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9187 } 9188 if (vs->vs_checkpoint_space) { 9189 nice_num_str_nvlist(vds, "checkpoint_space", 9190 vs->vs_checkpoint_space, cb->cb_literal, 9191 cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9192 } 9193 if (vs->vs_resilver_deferred) { 9194 nice_num_str_nvlist(vds, "resilver_deferred", 9195 vs->vs_resilver_deferred, B_TRUE, 9196 cb->cb_json_as_int, ZFS_NICENUM_1024); 9197 } 9198 if (children == 0) { 9199 nice_num_str_nvlist(vds, "slow_ios", vs->vs_slow_ios, 9200 cb->cb_literal, cb->cb_json_as_int, 9201 ZFS_NICENUM_1024); 9202 } 9203 if (cb->cb_print_power) { 9204 if (children == 0) { 9205 /* Only leaf vdevs have physical slots */ 9206 switch (zpool_power_current_state(zhp, (char *) 9207 fnvlist_lookup_string(nv, 9208 ZPOOL_CONFIG_PATH))) { 9209 case 0: 9210 fnvlist_add_string(vds, "power_state", 9211 "off"); 9212 break; 9213 case 1: 9214 fnvlist_add_string(vds, "power_state", 9215 "on"); 9216 break; 9217 default: 9218 fnvlist_add_string(vds, "power_state", 9219 "-"); 9220 } 9221 } else { 9222 fnvlist_add_string(vds, "power_state", "-"); 9223 } 9224 } 9225 } 9226 9227 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NOT_PRESENT, 9228 ¬present) == 0) { 9229 nice_num_str_nvlist(vds, ZPOOL_CONFIG_NOT_PRESENT, 9230 1, B_TRUE, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9231 fnvlist_add_string(vds, "was", 9232 fnvlist_lookup_string(nv, ZPOOL_CONFIG_PATH)); 9233 } else if (vs->vs_aux != VDEV_AUX_NONE) { 9234 fnvlist_add_string(vds, "aux", vdev_aux_str[vs->vs_aux]); 9235 } else if (children == 0 && !isspare && 9236 getenv("ZPOOL_STATUS_NON_NATIVE_ASHIFT_IGNORE") == NULL && 9237 VDEV_STAT_VALID(vs_physical_ashift, vsc) && 9238 vs->vs_configured_ashift < vs->vs_physical_ashift) { 9239 nice_num_str_nvlist(vds, "configured_ashift", 9240 vs->vs_configured_ashift, B_TRUE, cb->cb_json_as_int, 9241 ZFS_NICENUM_1024); 9242 nice_num_str_nvlist(vds, "physical_ashift", 9243 vs->vs_physical_ashift, B_TRUE, cb->cb_json_as_int, 9244 ZFS_NICENUM_1024); 9245 } 9246 if (vs->vs_scan_removing != 0) { 9247 nice_num_str_nvlist(vds, "removing", vs->vs_scan_removing, 9248 B_TRUE, cb->cb_json_as_int, ZFS_NICENUM_1024); 9249 } else if (VDEV_STAT_VALID(vs_noalloc, vsc) && vs->vs_noalloc != 0) { 9250 nice_num_str_nvlist(vds, "noalloc", vs->vs_noalloc, 9251 B_TRUE, cb->cb_json_as_int, ZFS_NICENUM_1024); 9252 } 9253 9254 if (cb->vcdl != NULL) { 9255 if (nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0) { 9256 zpool_nvlist_cmd(cb->vcdl, zpool_get_name(zhp), 9257 path, vds); 9258 } 9259 } 9260 9261 if (children == 0) { 9262 if (cb->cb_print_vdev_init) { 9263 if (vs->vs_initialize_state != 0) { 9264 uint64_t st = vs->vs_initialize_state; 9265 fnvlist_add_string(vds, "init_state", 9266 vdev_init_state_str[st]); 9267 nice_num_str_nvlist(vds, "initialized", 9268 vs->vs_initialize_bytes_done, 9269 cb->cb_literal, cb->cb_json_as_int, 9270 ZFS_NICENUM_BYTES); 9271 nice_num_str_nvlist(vds, "to_initialize", 9272 vs->vs_initialize_bytes_est, 9273 cb->cb_literal, cb->cb_json_as_int, 9274 ZFS_NICENUM_BYTES); 9275 nice_num_str_nvlist(vds, "init_time", 9276 vs->vs_initialize_action_time, 9277 cb->cb_literal, cb->cb_json_as_int, 9278 ZFS_NICE_TIMESTAMP); 9279 nice_num_str_nvlist(vds, "init_errors", 9280 vs->vs_initialize_errors, 9281 cb->cb_literal, cb->cb_json_as_int, 9282 ZFS_NICENUM_1024); 9283 } else { 9284 fnvlist_add_string(vds, "init_state", 9285 "UNINITIALIZED"); 9286 } 9287 } 9288 if (cb->cb_print_vdev_trim) { 9289 if (vs->vs_trim_notsup == 0) { 9290 if (vs->vs_trim_state != 0) { 9291 uint64_t st = vs->vs_trim_state; 9292 fnvlist_add_string(vds, "trim_state", 9293 vdev_trim_state_str[st]); 9294 nice_num_str_nvlist(vds, "trimmed", 9295 vs->vs_trim_bytes_done, 9296 cb->cb_literal, cb->cb_json_as_int, 9297 ZFS_NICENUM_BYTES); 9298 nice_num_str_nvlist(vds, "to_trim", 9299 vs->vs_trim_bytes_est, 9300 cb->cb_literal, cb->cb_json_as_int, 9301 ZFS_NICENUM_BYTES); 9302 nice_num_str_nvlist(vds, "trim_time", 9303 vs->vs_trim_action_time, 9304 cb->cb_literal, cb->cb_json_as_int, 9305 ZFS_NICE_TIMESTAMP); 9306 nice_num_str_nvlist(vds, "trim_errors", 9307 vs->vs_trim_errors, 9308 cb->cb_literal, cb->cb_json_as_int, 9309 ZFS_NICENUM_1024); 9310 } else 9311 fnvlist_add_string(vds, "trim_state", 9312 "UNTRIMMED"); 9313 } 9314 nice_num_str_nvlist(vds, "trim_notsup", 9315 vs->vs_trim_notsup, B_TRUE, 9316 cb->cb_json_as_int, ZFS_NICENUM_1024); 9317 } 9318 } else { 9319 ch = fnvlist_alloc(); 9320 } 9321 9322 if (cb->cb_flat_vdevs && children == 0) { 9323 fnvlist_add_nvlist(item, vname, vds); 9324 } 9325 9326 for (int c = 0; c < children; c++) { 9327 uint64_t islog = B_FALSE, ishole = B_FALSE; 9328 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG, 9329 &islog); 9330 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_HOLE, 9331 &ishole); 9332 if (islog || ishole) 9333 continue; 9334 if (nvlist_exists(child[c], ZPOOL_CONFIG_ALLOCATION_BIAS)) 9335 continue; 9336 if (cb->cb_flat_vdevs) { 9337 vdev_stats_nvlist(zhp, cb, child[c], depth + 2, isspare, 9338 vname, item); 9339 } 9340 vdev_stats_nvlist(zhp, cb, child[c], depth + 2, isspare, 9341 vname, ch); 9342 } 9343 9344 if (ch != NULL) { 9345 if (!nvlist_empty(ch)) 9346 fnvlist_add_nvlist(vds, "vdevs", ch); 9347 fnvlist_free(ch); 9348 } 9349 fnvlist_add_nvlist(item, vname, vds); 9350 fnvlist_free(vds); 9351 free(vname); 9352 } 9353 9354 static void 9355 class_vdevs_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t *nv, 9356 const char *class, nvlist_t *item) 9357 { 9358 uint_t c, children; 9359 nvlist_t **child; 9360 nvlist_t *class_obj = NULL; 9361 9362 if (!cb->cb_flat_vdevs) 9363 class_obj = fnvlist_alloc(); 9364 9365 assert(zhp != NULL || !cb->cb_verbose); 9366 9367 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, &child, 9368 &children) != 0) 9369 return; 9370 9371 for (c = 0; c < children; c++) { 9372 uint64_t is_log = B_FALSE; 9373 const char *bias = NULL; 9374 const char *type = NULL; 9375 char *name = zpool_vdev_name(g_zfs, zhp, child[c], 9376 cb->cb_name_flags | VDEV_NAME_TYPE_ID); 9377 9378 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG, 9379 &is_log); 9380 9381 if (is_log) { 9382 bias = (char *)VDEV_ALLOC_CLASS_LOGS; 9383 } else { 9384 (void) nvlist_lookup_string(child[c], 9385 ZPOOL_CONFIG_ALLOCATION_BIAS, &bias); 9386 (void) nvlist_lookup_string(child[c], 9387 ZPOOL_CONFIG_TYPE, &type); 9388 } 9389 9390 if (bias == NULL || strcmp(bias, class) != 0) 9391 continue; 9392 if (!is_log && strcmp(type, VDEV_TYPE_INDIRECT) == 0) 9393 continue; 9394 9395 if (cb->cb_flat_vdevs) { 9396 vdev_stats_nvlist(zhp, cb, child[c], 2, B_FALSE, 9397 NULL, item); 9398 } else { 9399 vdev_stats_nvlist(zhp, cb, child[c], 2, B_FALSE, 9400 NULL, class_obj); 9401 } 9402 free(name); 9403 } 9404 if (!cb->cb_flat_vdevs) { 9405 if (!nvlist_empty(class_obj)) 9406 fnvlist_add_nvlist(item, class, class_obj); 9407 fnvlist_free(class_obj); 9408 } 9409 } 9410 9411 static void 9412 l2cache_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t *nv, 9413 nvlist_t *item) 9414 { 9415 nvlist_t *l2c = NULL, **l2cache; 9416 uint_t nl2cache; 9417 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE, 9418 &l2cache, &nl2cache) == 0) { 9419 if (nl2cache == 0) 9420 return; 9421 if (!cb->cb_flat_vdevs) 9422 l2c = fnvlist_alloc(); 9423 for (int i = 0; i < nl2cache; i++) { 9424 if (cb->cb_flat_vdevs) { 9425 vdev_stats_nvlist(zhp, cb, l2cache[i], 2, 9426 B_FALSE, NULL, item); 9427 } else { 9428 vdev_stats_nvlist(zhp, cb, l2cache[i], 2, 9429 B_FALSE, NULL, l2c); 9430 } 9431 } 9432 } 9433 if (!cb->cb_flat_vdevs) { 9434 if (!nvlist_empty(l2c)) 9435 fnvlist_add_nvlist(item, "l2cache", l2c); 9436 fnvlist_free(l2c); 9437 } 9438 } 9439 9440 static void 9441 spares_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t *nv, 9442 nvlist_t *item) 9443 { 9444 nvlist_t *sp = NULL, **spares; 9445 uint_t nspares; 9446 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_SPARES, 9447 &spares, &nspares) == 0) { 9448 if (nspares == 0) 9449 return; 9450 if (!cb->cb_flat_vdevs) 9451 sp = fnvlist_alloc(); 9452 for (int i = 0; i < nspares; i++) { 9453 if (cb->cb_flat_vdevs) { 9454 vdev_stats_nvlist(zhp, cb, spares[i], 2, B_TRUE, 9455 NULL, item); 9456 } else { 9457 vdev_stats_nvlist(zhp, cb, spares[i], 2, B_TRUE, 9458 NULL, sp); 9459 } 9460 } 9461 } 9462 if (!cb->cb_flat_vdevs) { 9463 if (!nvlist_empty(sp)) 9464 fnvlist_add_nvlist(item, "spares", sp); 9465 fnvlist_free(sp); 9466 } 9467 } 9468 9469 static void 9470 errors_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t *item) 9471 { 9472 uint64_t nerr; 9473 nvlist_t *config = zpool_get_config(zhp, NULL); 9474 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_ERRCOUNT, 9475 &nerr) == 0) { 9476 nice_num_str_nvlist(item, ZPOOL_CONFIG_ERRCOUNT, nerr, 9477 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9478 if (nerr != 0 && cb->cb_verbose) { 9479 nvlist_t *nverrlist = NULL; 9480 if (zpool_get_errlog(zhp, &nverrlist) == 0) { 9481 int i = 0; 9482 int count = 0; 9483 size_t len = MAXPATHLEN * 2; 9484 nvpair_t *elem = NULL; 9485 9486 for (nvpair_t *pair = 9487 nvlist_next_nvpair(nverrlist, NULL); 9488 pair != NULL; 9489 pair = nvlist_next_nvpair(nverrlist, pair)) 9490 count++; 9491 char **errl = (char **)malloc( 9492 count * sizeof (char *)); 9493 9494 while ((elem = nvlist_next_nvpair(nverrlist, 9495 elem)) != NULL) { 9496 nvlist_t *nv; 9497 uint64_t dsobj, obj; 9498 9499 verify(nvpair_value_nvlist(elem, 9500 &nv) == 0); 9501 verify(nvlist_lookup_uint64(nv, 9502 ZPOOL_ERR_DATASET, &dsobj) == 0); 9503 verify(nvlist_lookup_uint64(nv, 9504 ZPOOL_ERR_OBJECT, &obj) == 0); 9505 errl[i] = safe_malloc(len); 9506 zpool_obj_to_path(zhp, dsobj, obj, 9507 errl[i++], len); 9508 } 9509 nvlist_free(nverrlist); 9510 fnvlist_add_string_array(item, "errlist", 9511 (const char **)errl, count); 9512 for (int i = 0; i < count; ++i) 9513 free(errl[i]); 9514 free(errl); 9515 } else 9516 fnvlist_add_string(item, "errlist", 9517 strerror(errno)); 9518 } 9519 } 9520 } 9521 9522 static void 9523 ddt_stats_nvlist(ddt_stat_t *dds, status_cbdata_t *cb, nvlist_t *item) 9524 { 9525 nice_num_str_nvlist(item, "blocks", dds->dds_blocks, 9526 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9527 nice_num_str_nvlist(item, "logical_size", dds->dds_lsize, 9528 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9529 nice_num_str_nvlist(item, "physical_size", dds->dds_psize, 9530 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9531 nice_num_str_nvlist(item, "deflated_size", dds->dds_dsize, 9532 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9533 nice_num_str_nvlist(item, "ref_blocks", dds->dds_ref_blocks, 9534 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9535 nice_num_str_nvlist(item, "ref_lsize", dds->dds_ref_lsize, 9536 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9537 nice_num_str_nvlist(item, "ref_psize", dds->dds_ref_psize, 9538 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9539 nice_num_str_nvlist(item, "ref_dsize", dds->dds_ref_dsize, 9540 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9541 } 9542 9543 static void 9544 dedup_stats_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t *item) 9545 { 9546 nvlist_t *config; 9547 if (cb->cb_dedup_stats) { 9548 ddt_histogram_t *ddh; 9549 ddt_stat_t *dds; 9550 ddt_object_t *ddo; 9551 nvlist_t *ddt_stat, *ddt_obj, *dedup; 9552 uint_t c; 9553 uint64_t cspace_prop; 9554 9555 config = zpool_get_config(zhp, NULL); 9556 if (nvlist_lookup_uint64_array(config, 9557 ZPOOL_CONFIG_DDT_OBJ_STATS, (uint64_t **)&ddo, &c) != 0) 9558 return; 9559 9560 dedup = fnvlist_alloc(); 9561 ddt_obj = fnvlist_alloc(); 9562 nice_num_str_nvlist(dedup, "obj_count", ddo->ddo_count, 9563 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9564 if (ddo->ddo_count == 0) { 9565 fnvlist_add_nvlist(dedup, ZPOOL_CONFIG_DDT_OBJ_STATS, 9566 ddt_obj); 9567 fnvlist_add_nvlist(item, "dedup_stats", dedup); 9568 fnvlist_free(ddt_obj); 9569 fnvlist_free(dedup); 9570 return; 9571 } else { 9572 nice_num_str_nvlist(dedup, "dspace", ddo->ddo_dspace, 9573 cb->cb_literal, cb->cb_json_as_int, 9574 ZFS_NICENUM_1024); 9575 nice_num_str_nvlist(dedup, "mspace", ddo->ddo_mspace, 9576 cb->cb_literal, cb->cb_json_as_int, 9577 ZFS_NICENUM_1024); 9578 /* 9579 * Squash cached size into in-core size to handle race. 9580 * Only include cached size if it is available. 9581 */ 9582 cspace_prop = zpool_get_prop_int(zhp, 9583 ZPOOL_PROP_DEDUPCACHED, NULL); 9584 cspace_prop = MIN(cspace_prop, ddo->ddo_mspace); 9585 nice_num_str_nvlist(dedup, "cspace", cspace_prop, 9586 cb->cb_literal, cb->cb_json_as_int, 9587 ZFS_NICENUM_1024); 9588 } 9589 9590 ddt_stat = fnvlist_alloc(); 9591 if (nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_STATS, 9592 (uint64_t **)&dds, &c) == 0) { 9593 nvlist_t *total = fnvlist_alloc(); 9594 if (dds->dds_blocks == 0) 9595 fnvlist_add_string(total, "blocks", "0"); 9596 else 9597 ddt_stats_nvlist(dds, cb, total); 9598 fnvlist_add_nvlist(ddt_stat, "total", total); 9599 fnvlist_free(total); 9600 } 9601 if (nvlist_lookup_uint64_array(config, 9602 ZPOOL_CONFIG_DDT_HISTOGRAM, (uint64_t **)&ddh, &c) == 0) { 9603 nvlist_t *hist = fnvlist_alloc(); 9604 nvlist_t *entry = NULL; 9605 char buf[16]; 9606 for (int h = 0; h < 64; h++) { 9607 if (ddh->ddh_stat[h].dds_blocks != 0) { 9608 entry = fnvlist_alloc(); 9609 ddt_stats_nvlist(&ddh->ddh_stat[h], cb, 9610 entry); 9611 snprintf(buf, 16, "%d", h); 9612 fnvlist_add_nvlist(hist, buf, entry); 9613 fnvlist_free(entry); 9614 } 9615 } 9616 if (!nvlist_empty(hist)) 9617 fnvlist_add_nvlist(ddt_stat, "histogram", hist); 9618 fnvlist_free(hist); 9619 } 9620 9621 if (!nvlist_empty(ddt_obj)) { 9622 fnvlist_add_nvlist(dedup, ZPOOL_CONFIG_DDT_OBJ_STATS, 9623 ddt_obj); 9624 } 9625 fnvlist_free(ddt_obj); 9626 if (!nvlist_empty(ddt_stat)) { 9627 fnvlist_add_nvlist(dedup, ZPOOL_CONFIG_DDT_STATS, 9628 ddt_stat); 9629 } 9630 fnvlist_free(ddt_stat); 9631 if (!nvlist_empty(dedup)) 9632 fnvlist_add_nvlist(item, "dedup_stats", dedup); 9633 fnvlist_free(dedup); 9634 } 9635 } 9636 9637 static void 9638 raidz_expand_status_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, 9639 nvlist_t *nvroot, nvlist_t *item) 9640 { 9641 uint_t c; 9642 pool_raidz_expand_stat_t *pres = NULL; 9643 if (nvlist_lookup_uint64_array(nvroot, 9644 ZPOOL_CONFIG_RAIDZ_EXPAND_STATS, (uint64_t **)&pres, &c) == 0) { 9645 nvlist_t **child; 9646 uint_t children; 9647 nvlist_t *nv = fnvlist_alloc(); 9648 verify(nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN, 9649 &child, &children) == 0); 9650 assert(pres->pres_expanding_vdev < children); 9651 char *name = 9652 zpool_vdev_name(g_zfs, zhp, 9653 child[pres->pres_expanding_vdev], 0); 9654 fill_vdev_info(nv, zhp, name, B_FALSE, cb->cb_json_as_int); 9655 fnvlist_add_string(nv, "state", 9656 pool_scan_state_str[pres->pres_state]); 9657 nice_num_str_nvlist(nv, "expanding_vdev", 9658 pres->pres_expanding_vdev, B_TRUE, cb->cb_json_as_int, 9659 ZFS_NICENUM_1024); 9660 nice_num_str_nvlist(nv, "start_time", pres->pres_start_time, 9661 cb->cb_literal, cb->cb_json_as_int, ZFS_NICE_TIMESTAMP); 9662 nice_num_str_nvlist(nv, "end_time", pres->pres_end_time, 9663 cb->cb_literal, cb->cb_json_as_int, ZFS_NICE_TIMESTAMP); 9664 nice_num_str_nvlist(nv, "to_reflow", pres->pres_to_reflow, 9665 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9666 nice_num_str_nvlist(nv, "reflowed", pres->pres_reflowed, 9667 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9668 nice_num_str_nvlist(nv, "waiting_for_resilver", 9669 pres->pres_waiting_for_resilver, B_TRUE, 9670 cb->cb_json_as_int, ZFS_NICENUM_1024); 9671 fnvlist_add_nvlist(item, ZPOOL_CONFIG_RAIDZ_EXPAND_STATS, nv); 9672 fnvlist_free(nv); 9673 free(name); 9674 } 9675 } 9676 9677 static void 9678 checkpoint_status_nvlist(nvlist_t *nvroot, status_cbdata_t *cb, 9679 nvlist_t *item) 9680 { 9681 uint_t c; 9682 pool_checkpoint_stat_t *pcs = NULL; 9683 if (nvlist_lookup_uint64_array(nvroot, 9684 ZPOOL_CONFIG_CHECKPOINT_STATS, (uint64_t **)&pcs, &c) == 0) { 9685 nvlist_t *nv = fnvlist_alloc(); 9686 fnvlist_add_string(nv, "state", 9687 checkpoint_state_str[pcs->pcs_state]); 9688 nice_num_str_nvlist(nv, "start_time", 9689 pcs->pcs_start_time, cb->cb_literal, cb->cb_json_as_int, 9690 ZFS_NICE_TIMESTAMP); 9691 nice_num_str_nvlist(nv, "space", 9692 pcs->pcs_space, cb->cb_literal, cb->cb_json_as_int, 9693 ZFS_NICENUM_BYTES); 9694 fnvlist_add_nvlist(item, ZPOOL_CONFIG_CHECKPOINT_STATS, nv); 9695 fnvlist_free(nv); 9696 } 9697 } 9698 9699 static void 9700 removal_status_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, 9701 nvlist_t *nvroot, nvlist_t *item) 9702 { 9703 uint_t c; 9704 pool_removal_stat_t *prs = NULL; 9705 if (nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_REMOVAL_STATS, 9706 (uint64_t **)&prs, &c) == 0) { 9707 if (prs->prs_state != DSS_NONE) { 9708 nvlist_t **child; 9709 uint_t children; 9710 verify(nvlist_lookup_nvlist_array(nvroot, 9711 ZPOOL_CONFIG_CHILDREN, &child, &children) == 0); 9712 assert(prs->prs_removing_vdev < children); 9713 char *vdev_name = zpool_vdev_name(g_zfs, zhp, 9714 child[prs->prs_removing_vdev], B_TRUE); 9715 nvlist_t *nv = fnvlist_alloc(); 9716 fill_vdev_info(nv, zhp, vdev_name, B_FALSE, 9717 cb->cb_json_as_int); 9718 fnvlist_add_string(nv, "state", 9719 pool_scan_state_str[prs->prs_state]); 9720 nice_num_str_nvlist(nv, "removing_vdev", 9721 prs->prs_removing_vdev, B_TRUE, cb->cb_json_as_int, 9722 ZFS_NICENUM_1024); 9723 nice_num_str_nvlist(nv, "start_time", 9724 prs->prs_start_time, cb->cb_literal, 9725 cb->cb_json_as_int, ZFS_NICE_TIMESTAMP); 9726 nice_num_str_nvlist(nv, "end_time", prs->prs_end_time, 9727 cb->cb_literal, cb->cb_json_as_int, 9728 ZFS_NICE_TIMESTAMP); 9729 nice_num_str_nvlist(nv, "to_copy", prs->prs_to_copy, 9730 cb->cb_literal, cb->cb_json_as_int, 9731 ZFS_NICENUM_BYTES); 9732 nice_num_str_nvlist(nv, "copied", prs->prs_copied, 9733 cb->cb_literal, cb->cb_json_as_int, 9734 ZFS_NICENUM_BYTES); 9735 nice_num_str_nvlist(nv, "mapping_memory", 9736 prs->prs_mapping_memory, cb->cb_literal, 9737 cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9738 fnvlist_add_nvlist(item, 9739 ZPOOL_CONFIG_REMOVAL_STATS, nv); 9740 fnvlist_free(nv); 9741 free(vdev_name); 9742 } 9743 } 9744 } 9745 9746 static void 9747 scan_status_nvlist(zpool_handle_t *zhp, status_cbdata_t *cb, 9748 nvlist_t *nvroot, nvlist_t *item) 9749 { 9750 pool_scan_stat_t *ps = NULL; 9751 uint_t c; 9752 nvlist_t *scan = fnvlist_alloc(); 9753 nvlist_t **child; 9754 uint_t children; 9755 9756 if (nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_SCAN_STATS, 9757 (uint64_t **)&ps, &c) == 0) { 9758 fnvlist_add_string(scan, "function", 9759 pool_scan_func_str[ps->pss_func]); 9760 fnvlist_add_string(scan, "state", 9761 pool_scan_state_str[ps->pss_state]); 9762 nice_num_str_nvlist(scan, "start_time", ps->pss_start_time, 9763 cb->cb_literal, cb->cb_json_as_int, ZFS_NICE_TIMESTAMP); 9764 nice_num_str_nvlist(scan, "end_time", ps->pss_end_time, 9765 cb->cb_literal, cb->cb_json_as_int, ZFS_NICE_TIMESTAMP); 9766 nice_num_str_nvlist(scan, "to_examine", ps->pss_to_examine, 9767 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9768 nice_num_str_nvlist(scan, "examined", ps->pss_examined, 9769 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9770 nice_num_str_nvlist(scan, "skipped", ps->pss_skipped, 9771 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9772 nice_num_str_nvlist(scan, "processed", ps->pss_processed, 9773 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9774 nice_num_str_nvlist(scan, "errors", ps->pss_errors, 9775 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_1024); 9776 nice_num_str_nvlist(scan, "bytes_per_scan", ps->pss_pass_exam, 9777 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9778 nice_num_str_nvlist(scan, "pass_start", ps->pss_pass_start, 9779 B_TRUE, cb->cb_json_as_int, ZFS_NICENUM_1024); 9780 nice_num_str_nvlist(scan, "scrub_pause", 9781 ps->pss_pass_scrub_pause, cb->cb_literal, 9782 cb->cb_json_as_int, ZFS_NICE_TIMESTAMP); 9783 nice_num_str_nvlist(scan, "scrub_spent_paused", 9784 ps->pss_pass_scrub_spent_paused, 9785 B_TRUE, cb->cb_json_as_int, ZFS_NICENUM_1024); 9786 nice_num_str_nvlist(scan, "issued_bytes_per_scan", 9787 ps->pss_pass_issued, cb->cb_literal, 9788 cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9789 nice_num_str_nvlist(scan, "issued", ps->pss_issued, 9790 cb->cb_literal, cb->cb_json_as_int, ZFS_NICENUM_BYTES); 9791 if (ps->pss_error_scrub_func == POOL_SCAN_ERRORSCRUB && 9792 ps->pss_error_scrub_start > ps->pss_start_time) { 9793 fnvlist_add_string(scan, "err_scrub_func", 9794 pool_scan_func_str[ps->pss_error_scrub_func]); 9795 fnvlist_add_string(scan, "err_scrub_state", 9796 pool_scan_state_str[ps->pss_error_scrub_state]); 9797 nice_num_str_nvlist(scan, "err_scrub_start_time", 9798 ps->pss_error_scrub_start, 9799 cb->cb_literal, cb->cb_json_as_int, 9800 ZFS_NICE_TIMESTAMP); 9801 nice_num_str_nvlist(scan, "err_scrub_end_time", 9802 ps->pss_error_scrub_end, 9803 cb->cb_literal, cb->cb_json_as_int, 9804 ZFS_NICE_TIMESTAMP); 9805 nice_num_str_nvlist(scan, "err_scrub_examined", 9806 ps->pss_error_scrub_examined, 9807 cb->cb_literal, cb->cb_json_as_int, 9808 ZFS_NICENUM_1024); 9809 nice_num_str_nvlist(scan, "err_scrub_to_examine", 9810 ps->pss_error_scrub_to_be_examined, 9811 cb->cb_literal, cb->cb_json_as_int, 9812 ZFS_NICENUM_1024); 9813 nice_num_str_nvlist(scan, "err_scrub_pause", 9814 ps->pss_pass_error_scrub_pause, 9815 B_TRUE, cb->cb_json_as_int, ZFS_NICENUM_1024); 9816 } 9817 } 9818 9819 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN, 9820 &child, &children) == 0) { 9821 vdev_rebuild_stat_t *vrs; 9822 uint_t i; 9823 char *name; 9824 nvlist_t *nv; 9825 nvlist_t *rebuild = fnvlist_alloc(); 9826 uint64_t st; 9827 for (uint_t c = 0; c < children; c++) { 9828 if (nvlist_lookup_uint64_array(child[c], 9829 ZPOOL_CONFIG_REBUILD_STATS, (uint64_t **)&vrs, 9830 &i) == 0) { 9831 if (vrs->vrs_state != VDEV_REBUILD_NONE) { 9832 nv = fnvlist_alloc(); 9833 name = zpool_vdev_name(g_zfs, zhp, 9834 child[c], VDEV_NAME_TYPE_ID); 9835 fill_vdev_info(nv, zhp, name, B_FALSE, 9836 cb->cb_json_as_int); 9837 st = vrs->vrs_state; 9838 fnvlist_add_string(nv, "state", 9839 vdev_rebuild_state_str[st]); 9840 nice_num_str_nvlist(nv, "start_time", 9841 vrs->vrs_start_time, cb->cb_literal, 9842 cb->cb_json_as_int, 9843 ZFS_NICE_TIMESTAMP); 9844 nice_num_str_nvlist(nv, "end_time", 9845 vrs->vrs_end_time, cb->cb_literal, 9846 cb->cb_json_as_int, 9847 ZFS_NICE_TIMESTAMP); 9848 nice_num_str_nvlist(nv, "scan_time", 9849 vrs->vrs_scan_time_ms * 1000000, 9850 cb->cb_literal, cb->cb_json_as_int, 9851 ZFS_NICENUM_TIME); 9852 nice_num_str_nvlist(nv, "scanned", 9853 vrs->vrs_bytes_scanned, 9854 cb->cb_literal, cb->cb_json_as_int, 9855 ZFS_NICENUM_BYTES); 9856 nice_num_str_nvlist(nv, "issued", 9857 vrs->vrs_bytes_issued, 9858 cb->cb_literal, cb->cb_json_as_int, 9859 ZFS_NICENUM_BYTES); 9860 nice_num_str_nvlist(nv, "rebuilt", 9861 vrs->vrs_bytes_rebuilt, 9862 cb->cb_literal, cb->cb_json_as_int, 9863 ZFS_NICENUM_BYTES); 9864 nice_num_str_nvlist(nv, "to_scan", 9865 vrs->vrs_bytes_est, cb->cb_literal, 9866 cb->cb_json_as_int, 9867 ZFS_NICENUM_BYTES); 9868 nice_num_str_nvlist(nv, "errors", 9869 vrs->vrs_errors, cb->cb_literal, 9870 cb->cb_json_as_int, 9871 ZFS_NICENUM_1024); 9872 nice_num_str_nvlist(nv, "pass_time", 9873 vrs->vrs_pass_time_ms * 1000000, 9874 cb->cb_literal, cb->cb_json_as_int, 9875 ZFS_NICENUM_TIME); 9876 nice_num_str_nvlist(nv, "pass_scanned", 9877 vrs->vrs_pass_bytes_scanned, 9878 cb->cb_literal, cb->cb_json_as_int, 9879 ZFS_NICENUM_BYTES); 9880 nice_num_str_nvlist(nv, "pass_issued", 9881 vrs->vrs_pass_bytes_issued, 9882 cb->cb_literal, cb->cb_json_as_int, 9883 ZFS_NICENUM_BYTES); 9884 nice_num_str_nvlist(nv, "pass_skipped", 9885 vrs->vrs_pass_bytes_skipped, 9886 cb->cb_literal, cb->cb_json_as_int, 9887 ZFS_NICENUM_BYTES); 9888 fnvlist_add_nvlist(rebuild, name, nv); 9889 free(name); 9890 } 9891 } 9892 } 9893 if (!nvlist_empty(rebuild)) 9894 fnvlist_add_nvlist(scan, "rebuild_stats", rebuild); 9895 fnvlist_free(rebuild); 9896 } 9897 9898 if (!nvlist_empty(scan)) 9899 fnvlist_add_nvlist(item, ZPOOL_CONFIG_SCAN_STATS, scan); 9900 fnvlist_free(scan); 9901 } 9902 9903 /* 9904 * Print the scan status. 9905 */ 9906 static void 9907 print_scan_status(zpool_handle_t *zhp, nvlist_t *nvroot) 9908 { 9909 uint64_t rebuild_end_time = 0, resilver_end_time = 0; 9910 boolean_t have_resilver = B_FALSE, have_scrub = B_FALSE; 9911 boolean_t have_errorscrub = B_FALSE; 9912 boolean_t active_resilver = B_FALSE; 9913 pool_checkpoint_stat_t *pcs = NULL; 9914 pool_scan_stat_t *ps = NULL; 9915 uint_t c; 9916 time_t scrub_start = 0, errorscrub_start = 0; 9917 9918 if (nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_SCAN_STATS, 9919 (uint64_t **)&ps, &c) == 0) { 9920 if (ps->pss_func == POOL_SCAN_RESILVER) { 9921 resilver_end_time = ps->pss_end_time; 9922 active_resilver = (ps->pss_state == DSS_SCANNING); 9923 } 9924 9925 have_resilver = (ps->pss_func == POOL_SCAN_RESILVER); 9926 have_scrub = (ps->pss_func == POOL_SCAN_SCRUB); 9927 scrub_start = ps->pss_start_time; 9928 if (c > offsetof(pool_scan_stat_t, 9929 pss_pass_error_scrub_pause) / 8) { 9930 have_errorscrub = (ps->pss_error_scrub_func == 9931 POOL_SCAN_ERRORSCRUB); 9932 errorscrub_start = ps->pss_error_scrub_start; 9933 } 9934 } 9935 9936 boolean_t active_rebuild = check_rebuilding(nvroot, &rebuild_end_time); 9937 boolean_t have_rebuild = (active_rebuild || (rebuild_end_time > 0)); 9938 9939 /* Always print the scrub status when available. */ 9940 if (have_scrub && scrub_start > errorscrub_start) 9941 print_scan_scrub_resilver_status(ps); 9942 else if (have_errorscrub && errorscrub_start >= scrub_start) 9943 print_err_scrub_status(ps); 9944 9945 /* 9946 * When there is an active resilver or rebuild print its status. 9947 * Otherwise print the status of the last resilver or rebuild. 9948 */ 9949 if (active_resilver || (!active_rebuild && have_resilver && 9950 resilver_end_time && resilver_end_time > rebuild_end_time)) { 9951 print_scan_scrub_resilver_status(ps); 9952 } else if (active_rebuild || (!active_resilver && have_rebuild && 9953 rebuild_end_time && rebuild_end_time > resilver_end_time)) { 9954 print_rebuild_status(zhp, nvroot); 9955 } 9956 9957 (void) nvlist_lookup_uint64_array(nvroot, 9958 ZPOOL_CONFIG_CHECKPOINT_STATS, (uint64_t **)&pcs, &c); 9959 print_checkpoint_scan_warning(ps, pcs); 9960 } 9961 9962 /* 9963 * Print out detailed removal status. 9964 */ 9965 static void 9966 print_removal_status(zpool_handle_t *zhp, pool_removal_stat_t *prs) 9967 { 9968 char copied_buf[7], examined_buf[7], total_buf[7], rate_buf[7]; 9969 time_t start, end; 9970 nvlist_t *config, *nvroot; 9971 nvlist_t **child; 9972 uint_t children; 9973 char *vdev_name; 9974 9975 if (prs == NULL || prs->prs_state == DSS_NONE) 9976 return; 9977 9978 /* 9979 * Determine name of vdev. 9980 */ 9981 config = zpool_get_config(zhp, NULL); 9982 nvroot = fnvlist_lookup_nvlist(config, 9983 ZPOOL_CONFIG_VDEV_TREE); 9984 verify(nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN, 9985 &child, &children) == 0); 9986 assert(prs->prs_removing_vdev < children); 9987 vdev_name = zpool_vdev_name(g_zfs, zhp, 9988 child[prs->prs_removing_vdev], B_TRUE); 9989 9990 printf_color(ANSI_BOLD, gettext("remove: ")); 9991 9992 start = prs->prs_start_time; 9993 end = prs->prs_end_time; 9994 zfs_nicenum(prs->prs_copied, copied_buf, sizeof (copied_buf)); 9995 9996 /* 9997 * Removal is finished or canceled. 9998 */ 9999 if (prs->prs_state == DSS_FINISHED) { 10000 uint64_t minutes_taken = (end - start) / 60; 10001 10002 (void) printf(gettext("Removal of vdev %llu copied %s " 10003 "in %lluh%um, completed on %s"), 10004 (longlong_t)prs->prs_removing_vdev, 10005 copied_buf, 10006 (u_longlong_t)(minutes_taken / 60), 10007 (uint_t)(minutes_taken % 60), 10008 ctime((time_t *)&end)); 10009 } else if (prs->prs_state == DSS_CANCELED) { 10010 (void) printf(gettext("Removal of %s canceled on %s"), 10011 vdev_name, ctime(&end)); 10012 } else { 10013 uint64_t copied, total, elapsed, mins_left, hours_left; 10014 double fraction_done; 10015 uint_t rate; 10016 10017 assert(prs->prs_state == DSS_SCANNING); 10018 10019 /* 10020 * Removal is in progress. 10021 */ 10022 (void) printf(gettext( 10023 "Evacuation of %s in progress since %s"), 10024 vdev_name, ctime(&start)); 10025 10026 copied = prs->prs_copied > 0 ? prs->prs_copied : 1; 10027 total = prs->prs_to_copy; 10028 fraction_done = (double)copied / total; 10029 10030 /* elapsed time for this pass */ 10031 elapsed = time(NULL) - prs->prs_start_time; 10032 elapsed = elapsed > 0 ? elapsed : 1; 10033 rate = copied / elapsed; 10034 rate = rate > 0 ? rate : 1; 10035 mins_left = ((total - copied) / rate) / 60; 10036 hours_left = mins_left / 60; 10037 10038 zfs_nicenum(copied, examined_buf, sizeof (examined_buf)); 10039 zfs_nicenum(total, total_buf, sizeof (total_buf)); 10040 zfs_nicenum(rate, rate_buf, sizeof (rate_buf)); 10041 10042 /* 10043 * do not print estimated time if hours_left is more than 10044 * 30 days 10045 */ 10046 (void) printf(gettext( 10047 "\t%s copied out of %s at %s/s, %.2f%% done"), 10048 examined_buf, total_buf, rate_buf, 100 * fraction_done); 10049 if (hours_left < (30 * 24)) { 10050 (void) printf(gettext(", %lluh%um to go\n"), 10051 (u_longlong_t)hours_left, (uint_t)(mins_left % 60)); 10052 } else { 10053 (void) printf(gettext( 10054 ", (copy is slow, no estimated time)\n")); 10055 } 10056 } 10057 free(vdev_name); 10058 10059 if (prs->prs_mapping_memory > 0) { 10060 char mem_buf[7]; 10061 zfs_nicenum(prs->prs_mapping_memory, mem_buf, sizeof (mem_buf)); 10062 (void) printf(gettext( 10063 "\t%s memory used for removed device mappings\n"), 10064 mem_buf); 10065 } 10066 } 10067 10068 /* 10069 * Print out detailed raidz expansion status. 10070 */ 10071 static void 10072 print_raidz_expand_status(zpool_handle_t *zhp, pool_raidz_expand_stat_t *pres) 10073 { 10074 char copied_buf[7]; 10075 10076 if (pres == NULL || pres->pres_state == DSS_NONE) 10077 return; 10078 10079 /* 10080 * Determine name of vdev. 10081 */ 10082 nvlist_t *config = zpool_get_config(zhp, NULL); 10083 nvlist_t *nvroot = fnvlist_lookup_nvlist(config, 10084 ZPOOL_CONFIG_VDEV_TREE); 10085 nvlist_t **child; 10086 uint_t children; 10087 verify(nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN, 10088 &child, &children) == 0); 10089 assert(pres->pres_expanding_vdev < children); 10090 10091 printf_color(ANSI_BOLD, gettext("expand: ")); 10092 10093 time_t start = pres->pres_start_time; 10094 time_t end = pres->pres_end_time; 10095 char *vname = 10096 zpool_vdev_name(g_zfs, zhp, child[pres->pres_expanding_vdev], 0); 10097 zfs_nicenum(pres->pres_reflowed, copied_buf, sizeof (copied_buf)); 10098 10099 /* 10100 * Expansion is finished or canceled. 10101 */ 10102 if (pres->pres_state == DSS_FINISHED) { 10103 char time_buf[32]; 10104 secs_to_dhms(end - start, time_buf); 10105 10106 (void) printf(gettext("expanded %s-%u copied %s in %s, " 10107 "on %s"), vname, (int)pres->pres_expanding_vdev, 10108 copied_buf, time_buf, ctime((time_t *)&end)); 10109 } else { 10110 char examined_buf[7], total_buf[7], rate_buf[7]; 10111 uint64_t copied, total, elapsed, secs_left; 10112 double fraction_done; 10113 uint_t rate; 10114 10115 assert(pres->pres_state == DSS_SCANNING); 10116 10117 /* 10118 * Expansion is in progress. 10119 */ 10120 (void) printf(gettext( 10121 "expansion of %s-%u in progress since %s"), 10122 vname, (int)pres->pres_expanding_vdev, ctime(&start)); 10123 10124 copied = pres->pres_reflowed > 0 ? pres->pres_reflowed : 1; 10125 total = pres->pres_to_reflow; 10126 fraction_done = (double)copied / total; 10127 10128 /* elapsed time for this pass */ 10129 elapsed = time(NULL) - pres->pres_start_time; 10130 elapsed = elapsed > 0 ? elapsed : 1; 10131 rate = copied / elapsed; 10132 rate = rate > 0 ? rate : 1; 10133 secs_left = (total - copied) / rate; 10134 10135 zfs_nicenum(copied, examined_buf, sizeof (examined_buf)); 10136 zfs_nicenum(total, total_buf, sizeof (total_buf)); 10137 zfs_nicenum(rate, rate_buf, sizeof (rate_buf)); 10138 10139 /* 10140 * do not print estimated time if hours_left is more than 10141 * 30 days 10142 */ 10143 (void) printf(gettext("\t%s / %s copied at %s/s, %.2f%% done"), 10144 examined_buf, total_buf, rate_buf, 100 * fraction_done); 10145 if (pres->pres_waiting_for_resilver) { 10146 (void) printf(gettext(", paused for resilver or " 10147 "clear\n")); 10148 } else if (secs_left < (30 * 24 * 3600)) { 10149 char time_buf[32]; 10150 secs_to_dhms(secs_left, time_buf); 10151 (void) printf(gettext(", %s to go\n"), time_buf); 10152 } else { 10153 (void) printf(gettext( 10154 ", (copy is slow, no estimated time)\n")); 10155 } 10156 } 10157 free(vname); 10158 } 10159 static void 10160 print_checkpoint_status(pool_checkpoint_stat_t *pcs) 10161 { 10162 time_t start; 10163 char space_buf[7]; 10164 10165 if (pcs == NULL || pcs->pcs_state == CS_NONE) 10166 return; 10167 10168 (void) printf(gettext("checkpoint: ")); 10169 10170 start = pcs->pcs_start_time; 10171 zfs_nicenum(pcs->pcs_space, space_buf, sizeof (space_buf)); 10172 10173 if (pcs->pcs_state == CS_CHECKPOINT_EXISTS) { 10174 char *date = ctime(&start); 10175 10176 /* 10177 * ctime() adds a newline at the end of the generated 10178 * string, thus the weird format specifier and the 10179 * strlen() call used to chop it off from the output. 10180 */ 10181 (void) printf(gettext("created %.*s, consumes %s\n"), 10182 (int)(strlen(date) - 1), date, space_buf); 10183 return; 10184 } 10185 10186 assert(pcs->pcs_state == CS_CHECKPOINT_DISCARDING); 10187 10188 (void) printf(gettext("discarding, %s remaining.\n"), 10189 space_buf); 10190 } 10191 10192 static void 10193 print_error_log(zpool_handle_t *zhp) 10194 { 10195 nvlist_t *nverrlist = NULL; 10196 nvpair_t *elem; 10197 char *pathname; 10198 size_t len = MAXPATHLEN * 2; 10199 10200 if (zpool_get_errlog(zhp, &nverrlist) != 0) 10201 return; 10202 10203 (void) printf("errors: Permanent errors have been " 10204 "detected in the following files:\n\n"); 10205 10206 pathname = safe_malloc(len); 10207 elem = NULL; 10208 while ((elem = nvlist_next_nvpair(nverrlist, elem)) != NULL) { 10209 nvlist_t *nv; 10210 uint64_t dsobj, obj; 10211 10212 verify(nvpair_value_nvlist(elem, &nv) == 0); 10213 verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_DATASET, 10214 &dsobj) == 0); 10215 verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_OBJECT, 10216 &obj) == 0); 10217 zpool_obj_to_path(zhp, dsobj, obj, pathname, len); 10218 (void) printf("%7s %s\n", "", pathname); 10219 } 10220 free(pathname); 10221 nvlist_free(nverrlist); 10222 } 10223 10224 static void 10225 print_spares(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t **spares, 10226 uint_t nspares) 10227 { 10228 uint_t i; 10229 char *name; 10230 10231 if (nspares == 0) 10232 return; 10233 10234 (void) printf(gettext("\tspares\n")); 10235 10236 for (i = 0; i < nspares; i++) { 10237 name = zpool_vdev_name(g_zfs, zhp, spares[i], 10238 cb->cb_name_flags); 10239 print_status_config(zhp, cb, name, spares[i], 2, B_TRUE, NULL); 10240 free(name); 10241 } 10242 } 10243 10244 static void 10245 print_l2cache(zpool_handle_t *zhp, status_cbdata_t *cb, nvlist_t **l2cache, 10246 uint_t nl2cache) 10247 { 10248 uint_t i; 10249 char *name; 10250 10251 if (nl2cache == 0) 10252 return; 10253 10254 (void) printf(gettext("\tcache\n")); 10255 10256 for (i = 0; i < nl2cache; i++) { 10257 name = zpool_vdev_name(g_zfs, zhp, l2cache[i], 10258 cb->cb_name_flags); 10259 print_status_config(zhp, cb, name, l2cache[i], 2, 10260 B_FALSE, NULL); 10261 free(name); 10262 } 10263 } 10264 10265 static void 10266 print_dedup_stats(zpool_handle_t *zhp, nvlist_t *config, boolean_t literal) 10267 { 10268 ddt_histogram_t *ddh; 10269 ddt_stat_t *dds; 10270 ddt_object_t *ddo; 10271 uint_t c; 10272 /* Extra space provided for literal display */ 10273 char dspace[32], mspace[32], cspace[32]; 10274 uint64_t cspace_prop; 10275 enum zfs_nicenum_format format; 10276 zprop_source_t src; 10277 10278 /* 10279 * If the pool was faulted then we may not have been able to 10280 * obtain the config. Otherwise, if we have anything in the dedup 10281 * table continue processing the stats. 10282 */ 10283 if (nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_OBJ_STATS, 10284 (uint64_t **)&ddo, &c) != 0) 10285 return; 10286 10287 (void) printf("\n"); 10288 (void) printf(gettext(" dedup: ")); 10289 if (ddo->ddo_count == 0) { 10290 (void) printf(gettext("no DDT entries\n")); 10291 return; 10292 } 10293 10294 /* 10295 * Squash cached size into in-core size to handle race. 10296 * Only include cached size if it is available. 10297 */ 10298 cspace_prop = zpool_get_prop_int(zhp, ZPOOL_PROP_DEDUPCACHED, &src); 10299 cspace_prop = MIN(cspace_prop, ddo->ddo_mspace); 10300 format = literal ? ZFS_NICENUM_RAW : ZFS_NICENUM_1024; 10301 zfs_nicenum_format(cspace_prop, cspace, sizeof (cspace), format); 10302 zfs_nicenum_format(ddo->ddo_dspace, dspace, sizeof (dspace), format); 10303 zfs_nicenum_format(ddo->ddo_mspace, mspace, sizeof (mspace), format); 10304 (void) printf("DDT entries %llu, size %s on disk, %s in core", 10305 (u_longlong_t)ddo->ddo_count, 10306 dspace, 10307 mspace); 10308 if (src != ZPROP_SRC_DEFAULT) { 10309 (void) printf(", %s cached (%.02f%%)", 10310 cspace, 10311 (double)cspace_prop / (double)ddo->ddo_mspace * 100.0); 10312 } 10313 (void) printf("\n"); 10314 10315 verify(nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_STATS, 10316 (uint64_t **)&dds, &c) == 0); 10317 verify(nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_HISTOGRAM, 10318 (uint64_t **)&ddh, &c) == 0); 10319 zpool_dump_ddt(dds, ddh); 10320 } 10321 10322 #define ST_SIZE 4096 10323 #define AC_SIZE 2048 10324 10325 static void 10326 print_status_reason(zpool_handle_t *zhp, status_cbdata_t *cbp, 10327 zpool_status_t reason, zpool_errata_t errata, nvlist_t *item) 10328 { 10329 char status[ST_SIZE]; 10330 char action[AC_SIZE]; 10331 memset(status, 0, ST_SIZE); 10332 memset(action, 0, AC_SIZE); 10333 10334 switch (reason) { 10335 case ZPOOL_STATUS_MISSING_DEV_R: 10336 snprintf(status, ST_SIZE, gettext("One or more devices could " 10337 "not be opened. Sufficient replicas exist for\n\tthe pool " 10338 "to continue functioning in a degraded state.\n")); 10339 snprintf(action, AC_SIZE, gettext("Attach the missing device " 10340 "and online it using 'zpool online'.\n")); 10341 break; 10342 10343 case ZPOOL_STATUS_MISSING_DEV_NR: 10344 snprintf(status, ST_SIZE, gettext("One or more devices could " 10345 "not be opened. There are insufficient\n\treplicas for the" 10346 " pool to continue functioning.\n")); 10347 snprintf(action, AC_SIZE, gettext("Attach the missing device " 10348 "and online it using 'zpool online'.\n")); 10349 break; 10350 10351 case ZPOOL_STATUS_CORRUPT_LABEL_R: 10352 snprintf(status, ST_SIZE, gettext("One or more devices could " 10353 "not be used because the label is missing or\n\tinvalid. " 10354 "Sufficient replicas exist for the pool to continue\n\t" 10355 "functioning in a degraded state.\n")); 10356 snprintf(action, AC_SIZE, gettext("Replace the device using " 10357 "'zpool replace'.\n")); 10358 break; 10359 10360 case ZPOOL_STATUS_CORRUPT_LABEL_NR: 10361 snprintf(status, ST_SIZE, gettext("One or more devices could " 10362 "not be used because the label is missing \n\tor invalid. " 10363 "There are insufficient replicas for the pool to " 10364 "continue\n\tfunctioning.\n")); 10365 zpool_explain_recover(zpool_get_handle(zhp), 10366 zpool_get_name(zhp), reason, zpool_get_config(zhp, NULL), 10367 action, AC_SIZE); 10368 break; 10369 10370 case ZPOOL_STATUS_FAILING_DEV: 10371 snprintf(status, ST_SIZE, gettext("One or more devices has " 10372 "experienced an unrecoverable error. An\n\tattempt was " 10373 "made to correct the error. Applications are " 10374 "unaffected.\n")); 10375 snprintf(action, AC_SIZE, gettext("Determine if the " 10376 "device needs to be replaced, and clear the errors\n\tusing" 10377 " 'zpool clear' or replace the device with 'zpool " 10378 "replace'.\n")); 10379 break; 10380 10381 case ZPOOL_STATUS_OFFLINE_DEV: 10382 snprintf(status, ST_SIZE, gettext("One or more devices has " 10383 "been taken offline by the administrator.\n\tSufficient " 10384 "replicas exist for the pool to continue functioning in " 10385 "a\n\tdegraded state.\n")); 10386 snprintf(action, AC_SIZE, gettext("Online the device " 10387 "using 'zpool online' or replace the device with\n\t'zpool " 10388 "replace'.\n")); 10389 break; 10390 10391 case ZPOOL_STATUS_REMOVED_DEV: 10392 snprintf(status, ST_SIZE, gettext("One or more devices has " 10393 "been removed by the administrator.\n\tSufficient " 10394 "replicas exist for the pool to continue functioning in " 10395 "a\n\tdegraded state.\n")); 10396 snprintf(action, AC_SIZE, gettext("Online the device " 10397 "using zpool online' or replace the device with\n\t'zpool " 10398 "replace'.\n")); 10399 break; 10400 10401 case ZPOOL_STATUS_RESILVERING: 10402 case ZPOOL_STATUS_REBUILDING: 10403 snprintf(status, ST_SIZE, gettext("One or more devices is " 10404 "currently being resilvered. The pool will\n\tcontinue " 10405 "to function, possibly in a degraded state.\n")); 10406 snprintf(action, AC_SIZE, gettext("Wait for the resilver to " 10407 "complete.\n")); 10408 break; 10409 10410 case ZPOOL_STATUS_REBUILD_SCRUB: 10411 snprintf(status, ST_SIZE, gettext("One or more devices have " 10412 "been sequentially resilvered, scrubbing\n\tthe pool " 10413 "is recommended.\n")); 10414 snprintf(action, AC_SIZE, gettext("Use 'zpool scrub' to " 10415 "verify all data checksums.\n")); 10416 break; 10417 10418 case ZPOOL_STATUS_CORRUPT_DATA: 10419 snprintf(status, ST_SIZE, gettext("One or more devices has " 10420 "experienced an error resulting in data\n\tcorruption. " 10421 "Applications may be affected.\n")); 10422 snprintf(action, AC_SIZE, gettext("Restore the file in question" 10423 " if possible. Otherwise restore the\n\tentire pool from " 10424 "backup.\n")); 10425 break; 10426 10427 case ZPOOL_STATUS_CORRUPT_POOL: 10428 snprintf(status, ST_SIZE, gettext("The pool metadata is " 10429 "corrupted and the pool cannot be opened.\n")); 10430 zpool_explain_recover(zpool_get_handle(zhp), 10431 zpool_get_name(zhp), reason, zpool_get_config(zhp, NULL), 10432 action, AC_SIZE); 10433 break; 10434 10435 case ZPOOL_STATUS_VERSION_OLDER: 10436 snprintf(status, ST_SIZE, gettext("The pool is formatted using " 10437 "a legacy on-disk format. The pool can\n\tstill be used, " 10438 "but some features are unavailable.\n")); 10439 snprintf(action, AC_SIZE, gettext("Upgrade the pool using " 10440 "'zpool upgrade'. Once this is done, the\n\tpool will no " 10441 "longer be accessible on software that does not support\n\t" 10442 "feature flags.\n")); 10443 break; 10444 10445 case ZPOOL_STATUS_VERSION_NEWER: 10446 snprintf(status, ST_SIZE, gettext("The pool has been upgraded " 10447 "to a newer, incompatible on-disk version.\n\tThe pool " 10448 "cannot be accessed on this system.\n")); 10449 snprintf(action, AC_SIZE, gettext("Access the pool from a " 10450 "system running more recent software, or\n\trestore the " 10451 "pool from backup.\n")); 10452 break; 10453 10454 case ZPOOL_STATUS_FEAT_DISABLED: 10455 snprintf(status, ST_SIZE, gettext("Some supported and " 10456 "requested features are not enabled on the pool.\n\t" 10457 "The pool can still be used, but some features are " 10458 "unavailable.\n")); 10459 snprintf(action, AC_SIZE, gettext("Enable all features using " 10460 "'zpool upgrade'. Once this is done,\n\tthe pool may no " 10461 "longer be accessible by software that does not support\n\t" 10462 "the features. See zpool-features(7) for details.\n")); 10463 break; 10464 10465 case ZPOOL_STATUS_COMPATIBILITY_ERR: 10466 snprintf(status, ST_SIZE, gettext("This pool has a " 10467 "compatibility list specified, but it could not be\n\t" 10468 "read/parsed at this time. The pool can still be used, " 10469 "but this\n\tshould be investigated.\n")); 10470 snprintf(action, AC_SIZE, gettext("Check the value of the " 10471 "'compatibility' property against the\n\t" 10472 "appropriate file in " ZPOOL_SYSCONF_COMPAT_D " or " 10473 ZPOOL_DATA_COMPAT_D ".\n")); 10474 break; 10475 10476 case ZPOOL_STATUS_INCOMPATIBLE_FEAT: 10477 snprintf(status, ST_SIZE, gettext("One or more features " 10478 "are enabled on the pool despite not being\n\t" 10479 "requested by the 'compatibility' property.\n")); 10480 snprintf(action, AC_SIZE, gettext("Consider setting " 10481 "'compatibility' to an appropriate value, or\n\t" 10482 "adding needed features to the relevant file in\n\t" 10483 ZPOOL_SYSCONF_COMPAT_D " or " ZPOOL_DATA_COMPAT_D ".\n")); 10484 break; 10485 10486 case ZPOOL_STATUS_UNSUP_FEAT_READ: 10487 snprintf(status, ST_SIZE, gettext("The pool cannot be accessed " 10488 "on this system because it uses the\n\tfollowing feature(s)" 10489 " not supported on this system:\n")); 10490 zpool_collect_unsup_feat(zpool_get_config(zhp, NULL), status, 10491 1024); 10492 snprintf(action, AC_SIZE, gettext("Access the pool from a " 10493 "system that supports the required feature(s),\n\tor " 10494 "restore the pool from backup.\n")); 10495 break; 10496 10497 case ZPOOL_STATUS_UNSUP_FEAT_WRITE: 10498 snprintf(status, ST_SIZE, gettext("The pool can only be " 10499 "accessed in read-only mode on this system. It\n\tcannot be" 10500 " accessed in read-write mode because it uses the " 10501 "following\n\tfeature(s) not supported on this system:\n")); 10502 zpool_collect_unsup_feat(zpool_get_config(zhp, NULL), status, 10503 1024); 10504 snprintf(action, AC_SIZE, gettext("The pool cannot be accessed " 10505 "in read-write mode. Import the pool with\n" 10506 "\t\"-o readonly=on\", access the pool from a system that " 10507 "supports the\n\trequired feature(s), or restore the " 10508 "pool from backup.\n")); 10509 break; 10510 10511 case ZPOOL_STATUS_FAULTED_DEV_R: 10512 snprintf(status, ST_SIZE, gettext("One or more devices are " 10513 "faulted in response to persistent errors.\n\tSufficient " 10514 "replicas exist for the pool to continue functioning " 10515 "in a\n\tdegraded state.\n")); 10516 snprintf(action, AC_SIZE, gettext("Replace the faulted device, " 10517 "or use 'zpool clear' to mark the device\n\trepaired.\n")); 10518 break; 10519 10520 case ZPOOL_STATUS_FAULTED_DEV_NR: 10521 snprintf(status, ST_SIZE, gettext("One or more devices are " 10522 "faulted in response to persistent errors. There are " 10523 "insufficient replicas for the pool to\n\tcontinue " 10524 "functioning.\n")); 10525 snprintf(action, AC_SIZE, gettext("Destroy and re-create the " 10526 "pool from a backup source. Manually marking the device\n" 10527 "\trepaired using 'zpool clear' may allow some data " 10528 "to be recovered.\n")); 10529 break; 10530 10531 case ZPOOL_STATUS_IO_FAILURE_MMP: 10532 snprintf(status, ST_SIZE, gettext("The pool is suspended " 10533 "because multihost writes failed or were delayed;\n\t" 10534 "another system could import the pool undetected.\n")); 10535 snprintf(action, AC_SIZE, gettext("Make sure the pool's devices" 10536 " are connected, then reboot your system and\n\timport the " 10537 "pool or run 'zpool clear' to resume the pool.\n")); 10538 break; 10539 10540 case ZPOOL_STATUS_IO_FAILURE_WAIT: 10541 case ZPOOL_STATUS_IO_FAILURE_CONTINUE: 10542 snprintf(status, ST_SIZE, gettext("One or more devices are " 10543 "faulted in response to IO failures.\n")); 10544 snprintf(action, AC_SIZE, gettext("Make sure the affected " 10545 "devices are connected, then run 'zpool clear'.\n")); 10546 break; 10547 10548 case ZPOOL_STATUS_BAD_LOG: 10549 snprintf(status, ST_SIZE, gettext("An intent log record " 10550 "could not be read.\n" 10551 "\tWaiting for administrator intervention to fix the " 10552 "faulted pool.\n")); 10553 snprintf(action, AC_SIZE, gettext("Either restore the affected " 10554 "device(s) and run 'zpool online',\n" 10555 "\tor ignore the intent log records by running " 10556 "'zpool clear'.\n")); 10557 break; 10558 10559 case ZPOOL_STATUS_NON_NATIVE_ASHIFT: 10560 snprintf(status, ST_SIZE, gettext("One or more devices are " 10561 "configured to use a non-native block size.\n" 10562 "\tExpect reduced performance.\n")); 10563 snprintf(action, AC_SIZE, gettext("Replace affected devices " 10564 "with devices that support the\n\tconfigured block size, " 10565 "or migrate data to a properly configured\n\tpool.\n")); 10566 break; 10567 10568 case ZPOOL_STATUS_HOSTID_MISMATCH: 10569 snprintf(status, ST_SIZE, gettext("Mismatch between pool hostid" 10570 " and system hostid on imported pool.\n\tThis pool was " 10571 "previously imported into a system with a different " 10572 "hostid,\n\tand then was verbatim imported into this " 10573 "system.\n")); 10574 snprintf(action, AC_SIZE, gettext("Export this pool on all " 10575 "systems on which it is imported.\n" 10576 "\tThen import it to correct the mismatch.\n")); 10577 break; 10578 10579 case ZPOOL_STATUS_ERRATA: 10580 snprintf(status, ST_SIZE, gettext("Errata #%d detected.\n"), 10581 errata); 10582 switch (errata) { 10583 case ZPOOL_ERRATA_NONE: 10584 break; 10585 10586 case ZPOOL_ERRATA_ZOL_2094_SCRUB: 10587 snprintf(action, AC_SIZE, gettext("To correct the issue" 10588 " run 'zpool scrub'.\n")); 10589 break; 10590 10591 case ZPOOL_ERRATA_ZOL_6845_ENCRYPTION: 10592 (void) strlcat(status, gettext("\tExisting encrypted " 10593 "datasets contain an on-disk incompatibility\n\t " 10594 "which needs to be corrected.\n"), ST_SIZE); 10595 snprintf(action, AC_SIZE, gettext("To correct the issue" 10596 " backup existing encrypted datasets to new\n\t" 10597 "encrypted datasets and destroy the old ones. " 10598 "'zfs mount -o ro' can\n\tbe used to temporarily " 10599 "mount existing encrypted datasets readonly.\n")); 10600 break; 10601 10602 case ZPOOL_ERRATA_ZOL_8308_ENCRYPTION: 10603 (void) strlcat(status, gettext("\tExisting encrypted " 10604 "snapshots and bookmarks contain an on-disk\n\t" 10605 "incompatibility. This may cause on-disk " 10606 "corruption if they are used\n\twith " 10607 "'zfs recv'.\n"), ST_SIZE); 10608 snprintf(action, AC_SIZE, gettext("To correct the" 10609 "issue, enable the bookmark_v2 feature. No " 10610 "additional\n\taction is needed if there are no " 10611 "encrypted snapshots or bookmarks.\n\tIf preserving" 10612 "the encrypted snapshots and bookmarks is required," 10613 " use\n\ta non-raw send to backup and restore them." 10614 " Alternately, they may be\n\tremoved to resolve " 10615 "the incompatibility.\n")); 10616 break; 10617 10618 default: 10619 /* 10620 * All errata which allow the pool to be imported 10621 * must contain an action message. 10622 */ 10623 assert(0); 10624 } 10625 break; 10626 10627 default: 10628 /* 10629 * The remaining errors can't actually be generated, yet. 10630 */ 10631 assert(reason == ZPOOL_STATUS_OK); 10632 } 10633 10634 if (status[0] != 0) { 10635 if (cbp->cb_json) 10636 fnvlist_add_string(item, "status", status); 10637 else { 10638 printf_color(ANSI_BOLD, gettext("status: ")); 10639 printf_color(ANSI_YELLOW, status); 10640 } 10641 } 10642 10643 if (action[0] != 0) { 10644 if (cbp->cb_json) 10645 fnvlist_add_string(item, "action", action); 10646 else { 10647 printf_color(ANSI_BOLD, gettext("action: ")); 10648 printf_color(ANSI_YELLOW, action); 10649 } 10650 } 10651 } 10652 10653 static int 10654 status_callback_json(zpool_handle_t *zhp, void *data) 10655 { 10656 status_cbdata_t *cbp = data; 10657 nvlist_t *config, *nvroot; 10658 const char *msgid; 10659 char pool_guid[256]; 10660 char msgbuf[256]; 10661 uint64_t guid; 10662 zpool_status_t reason; 10663 zpool_errata_t errata; 10664 uint_t c; 10665 vdev_stat_t *vs; 10666 nvlist_t *item, *d, *load_info, *vds; 10667 item = d = NULL; 10668 10669 /* If dedup stats were requested, also fetch dedupcached. */ 10670 if (cbp->cb_dedup_stats > 1) 10671 zpool_add_propname(zhp, ZPOOL_DEDUPCACHED_PROP_NAME); 10672 reason = zpool_get_status(zhp, &msgid, &errata); 10673 /* 10674 * If we were given 'zpool status -x', only report those pools with 10675 * problems. 10676 */ 10677 if (cbp->cb_explain && 10678 (reason == ZPOOL_STATUS_OK || 10679 reason == ZPOOL_STATUS_VERSION_OLDER || 10680 reason == ZPOOL_STATUS_FEAT_DISABLED || 10681 reason == ZPOOL_STATUS_COMPATIBILITY_ERR || 10682 reason == ZPOOL_STATUS_INCOMPATIBLE_FEAT)) { 10683 return (0); 10684 } 10685 10686 d = fnvlist_lookup_nvlist(cbp->cb_jsobj, "pools"); 10687 item = fnvlist_alloc(); 10688 vds = fnvlist_alloc(); 10689 fill_pool_info(item, zhp, B_FALSE, cbp->cb_json_as_int); 10690 config = zpool_get_config(zhp, NULL); 10691 10692 if (config != NULL) { 10693 nvroot = fnvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE); 10694 verify(nvlist_lookup_uint64_array(nvroot, 10695 ZPOOL_CONFIG_VDEV_STATS, (uint64_t **)&vs, &c) == 0); 10696 if (cbp->cb_json_pool_key_guid) { 10697 guid = fnvlist_lookup_uint64(config, 10698 ZPOOL_CONFIG_POOL_GUID); 10699 snprintf(pool_guid, 256, "%llu", (u_longlong_t)guid); 10700 } 10701 cbp->cb_count++; 10702 10703 print_status_reason(zhp, cbp, reason, errata, item); 10704 if (msgid != NULL) { 10705 snprintf(msgbuf, 256, 10706 "https://openzfs.github.io/openzfs-docs/msg/%s", 10707 msgid); 10708 fnvlist_add_string(item, "msgid", msgid); 10709 fnvlist_add_string(item, "moreinfo", msgbuf); 10710 } 10711 10712 if (nvlist_lookup_nvlist(config, ZPOOL_CONFIG_LOAD_INFO, 10713 &load_info) == 0) { 10714 fnvlist_add_nvlist(item, ZPOOL_CONFIG_LOAD_INFO, 10715 load_info); 10716 } 10717 10718 scan_status_nvlist(zhp, cbp, nvroot, item); 10719 removal_status_nvlist(zhp, cbp, nvroot, item); 10720 checkpoint_status_nvlist(nvroot, cbp, item); 10721 raidz_expand_status_nvlist(zhp, cbp, nvroot, item); 10722 vdev_stats_nvlist(zhp, cbp, nvroot, 0, B_FALSE, NULL, vds); 10723 if (cbp->cb_flat_vdevs) { 10724 class_vdevs_nvlist(zhp, cbp, nvroot, 10725 VDEV_ALLOC_BIAS_DEDUP, vds); 10726 class_vdevs_nvlist(zhp, cbp, nvroot, 10727 VDEV_ALLOC_BIAS_SPECIAL, vds); 10728 class_vdevs_nvlist(zhp, cbp, nvroot, 10729 VDEV_ALLOC_CLASS_LOGS, vds); 10730 l2cache_nvlist(zhp, cbp, nvroot, vds); 10731 spares_nvlist(zhp, cbp, nvroot, vds); 10732 10733 fnvlist_add_nvlist(item, "vdevs", vds); 10734 fnvlist_free(vds); 10735 } else { 10736 fnvlist_add_nvlist(item, "vdevs", vds); 10737 fnvlist_free(vds); 10738 10739 class_vdevs_nvlist(zhp, cbp, nvroot, 10740 VDEV_ALLOC_BIAS_DEDUP, item); 10741 class_vdevs_nvlist(zhp, cbp, nvroot, 10742 VDEV_ALLOC_BIAS_SPECIAL, item); 10743 class_vdevs_nvlist(zhp, cbp, nvroot, 10744 VDEV_ALLOC_CLASS_LOGS, item); 10745 l2cache_nvlist(zhp, cbp, nvroot, item); 10746 spares_nvlist(zhp, cbp, nvroot, item); 10747 } 10748 dedup_stats_nvlist(zhp, cbp, item); 10749 errors_nvlist(zhp, cbp, item); 10750 } 10751 if (cbp->cb_json_pool_key_guid) { 10752 fnvlist_add_nvlist(d, pool_guid, item); 10753 } else { 10754 fnvlist_add_nvlist(d, zpool_get_name(zhp), 10755 item); 10756 } 10757 fnvlist_free(item); 10758 return (0); 10759 } 10760 10761 /* 10762 * Display a summary of pool status. Displays a summary such as: 10763 * 10764 * pool: tank 10765 * status: DEGRADED 10766 * reason: One or more devices ... 10767 * see: https://openzfs.github.io/openzfs-docs/msg/ZFS-xxxx-01 10768 * config: 10769 * mirror DEGRADED 10770 * c1t0d0 OK 10771 * c2t0d0 UNAVAIL 10772 * 10773 * When given the '-v' option, we print out the complete config. If the '-e' 10774 * option is specified, then we print out error rate information as well. 10775 */ 10776 static int 10777 status_callback(zpool_handle_t *zhp, void *data) 10778 { 10779 status_cbdata_t *cbp = data; 10780 nvlist_t *config, *nvroot; 10781 const char *msgid; 10782 zpool_status_t reason; 10783 zpool_errata_t errata; 10784 const char *health; 10785 uint_t c; 10786 vdev_stat_t *vs; 10787 10788 /* If dedup stats were requested, also fetch dedupcached. */ 10789 if (cbp->cb_dedup_stats > 1) 10790 zpool_add_propname(zhp, ZPOOL_DEDUPCACHED_PROP_NAME); 10791 10792 config = zpool_get_config(zhp, NULL); 10793 reason = zpool_get_status(zhp, &msgid, &errata); 10794 10795 cbp->cb_count++; 10796 10797 /* 10798 * If we were given 'zpool status -x', only report those pools with 10799 * problems. 10800 */ 10801 if (cbp->cb_explain && 10802 (reason == ZPOOL_STATUS_OK || 10803 reason == ZPOOL_STATUS_VERSION_OLDER || 10804 reason == ZPOOL_STATUS_FEAT_DISABLED || 10805 reason == ZPOOL_STATUS_COMPATIBILITY_ERR || 10806 reason == ZPOOL_STATUS_INCOMPATIBLE_FEAT)) { 10807 if (!cbp->cb_allpools) { 10808 (void) printf(gettext("pool '%s' is healthy\n"), 10809 zpool_get_name(zhp)); 10810 if (cbp->cb_first) 10811 cbp->cb_first = B_FALSE; 10812 } 10813 return (0); 10814 } 10815 10816 if (cbp->cb_first) 10817 cbp->cb_first = B_FALSE; 10818 else 10819 (void) printf("\n"); 10820 10821 nvroot = fnvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE); 10822 verify(nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_VDEV_STATS, 10823 (uint64_t **)&vs, &c) == 0); 10824 10825 health = zpool_get_state_str(zhp); 10826 10827 printf(" "); 10828 printf_color(ANSI_BOLD, gettext("pool:")); 10829 printf(" %s\n", zpool_get_name(zhp)); 10830 fputc(' ', stdout); 10831 printf_color(ANSI_BOLD, gettext("state: ")); 10832 10833 printf_color(health_str_to_color(health), "%s", health); 10834 10835 fputc('\n', stdout); 10836 print_status_reason(zhp, cbp, reason, errata, NULL); 10837 10838 if (msgid != NULL) { 10839 printf(" "); 10840 printf_color(ANSI_BOLD, gettext("see:")); 10841 printf(gettext( 10842 " https://openzfs.github.io/openzfs-docs/msg/%s\n"), 10843 msgid); 10844 } 10845 10846 if (config != NULL) { 10847 uint64_t nerr; 10848 nvlist_t **spares, **l2cache; 10849 uint_t nspares, nl2cache; 10850 10851 print_scan_status(zhp, nvroot); 10852 10853 pool_removal_stat_t *prs = NULL; 10854 (void) nvlist_lookup_uint64_array(nvroot, 10855 ZPOOL_CONFIG_REMOVAL_STATS, (uint64_t **)&prs, &c); 10856 print_removal_status(zhp, prs); 10857 10858 pool_checkpoint_stat_t *pcs = NULL; 10859 (void) nvlist_lookup_uint64_array(nvroot, 10860 ZPOOL_CONFIG_CHECKPOINT_STATS, (uint64_t **)&pcs, &c); 10861 print_checkpoint_status(pcs); 10862 10863 pool_raidz_expand_stat_t *pres = NULL; 10864 (void) nvlist_lookup_uint64_array(nvroot, 10865 ZPOOL_CONFIG_RAIDZ_EXPAND_STATS, (uint64_t **)&pres, &c); 10866 print_raidz_expand_status(zhp, pres); 10867 10868 cbp->cb_namewidth = max_width(zhp, nvroot, 0, 0, 10869 cbp->cb_name_flags | VDEV_NAME_TYPE_ID); 10870 if (cbp->cb_namewidth < 10) 10871 cbp->cb_namewidth = 10; 10872 10873 color_start(ANSI_BOLD); 10874 (void) printf(gettext("config:\n\n")); 10875 (void) printf(gettext("\t%-*s %-8s %5s %5s %5s"), 10876 cbp->cb_namewidth, "NAME", "STATE", "READ", "WRITE", 10877 "CKSUM"); 10878 color_end(); 10879 10880 if (cbp->cb_print_slow_ios) { 10881 printf_color(ANSI_BOLD, " %5s", gettext("SLOW")); 10882 } 10883 10884 if (cbp->cb_print_power) { 10885 printf_color(ANSI_BOLD, " %5s", gettext("POWER")); 10886 } 10887 10888 if (cbp->cb_print_dio_verify) { 10889 printf_color(ANSI_BOLD, " %5s", gettext("DIO")); 10890 } 10891 10892 if (cbp->vcdl != NULL) 10893 print_cmd_columns(cbp->vcdl, 0); 10894 10895 printf("\n"); 10896 10897 print_status_config(zhp, cbp, zpool_get_name(zhp), nvroot, 0, 10898 B_FALSE, NULL); 10899 10900 print_class_vdevs(zhp, cbp, nvroot, VDEV_ALLOC_BIAS_DEDUP); 10901 print_class_vdevs(zhp, cbp, nvroot, VDEV_ALLOC_BIAS_SPECIAL); 10902 print_class_vdevs(zhp, cbp, nvroot, VDEV_ALLOC_CLASS_LOGS); 10903 10904 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_L2CACHE, 10905 &l2cache, &nl2cache) == 0) 10906 print_l2cache(zhp, cbp, l2cache, nl2cache); 10907 10908 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES, 10909 &spares, &nspares) == 0) 10910 print_spares(zhp, cbp, spares, nspares); 10911 10912 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_ERRCOUNT, 10913 &nerr) == 0) { 10914 (void) printf("\n"); 10915 if (nerr == 0) { 10916 (void) printf(gettext( 10917 "errors: No known data errors\n")); 10918 } else if (!cbp->cb_verbose) { 10919 color_start(ANSI_RED); 10920 (void) printf(gettext("errors: %llu data " 10921 "errors, use '-v' for a list\n"), 10922 (u_longlong_t)nerr); 10923 color_end(); 10924 } else { 10925 print_error_log(zhp); 10926 } 10927 } 10928 10929 if (cbp->cb_dedup_stats) 10930 print_dedup_stats(zhp, config, cbp->cb_literal); 10931 } else { 10932 (void) printf(gettext("config: The configuration cannot be " 10933 "determined.\n")); 10934 } 10935 10936 return (0); 10937 } 10938 10939 /* 10940 * zpool status [-c [script1,script2,...]] [-dDegiLpPstvx] [--power] ... 10941 * [-T d|u] [pool] [interval [count]] 10942 * 10943 * -c CMD For each vdev, run command CMD 10944 * -d Display Direct I/O write verify errors 10945 * -D Display dedup status (undocumented) 10946 * -e Display only unhealthy vdevs 10947 * -g Display guid for individual vdev name. 10948 * -i Display vdev initialization status. 10949 * -L Follow links when resolving vdev path name. 10950 * -p Display values in parsable (exact) format. 10951 * -P Display full path for vdev name. 10952 * -s Display slow IOs column. 10953 * -t Display vdev TRIM status. 10954 * -T Display a timestamp in date(1) or Unix format 10955 * -v Display complete error logs 10956 * -x Display only pools with potential problems 10957 * -j Display output in JSON format 10958 * --power Display vdev enclosure slot power status 10959 * --json-int Display numbers in inteeger format instead of string 10960 * --json-flat-vdevs Display vdevs in flat hierarchy 10961 * --json-pool-key-guid Use pool GUID as key for pool objects 10962 * 10963 * Describes the health status of all pools or some subset. 10964 */ 10965 int 10966 zpool_do_status(int argc, char **argv) 10967 { 10968 int c; 10969 int ret; 10970 float interval = 0; 10971 unsigned long count = 0; 10972 status_cbdata_t cb = { 0 }; 10973 nvlist_t *data; 10974 char *cmd = NULL; 10975 10976 struct option long_options[] = { 10977 {"power", no_argument, NULL, ZPOOL_OPTION_POWER}, 10978 {"json-int", no_argument, NULL, ZPOOL_OPTION_JSON_NUMS_AS_INT}, 10979 {"json-flat-vdevs", no_argument, NULL, 10980 ZPOOL_OPTION_JSON_FLAT_VDEVS}, 10981 {"json-pool-key-guid", no_argument, NULL, 10982 ZPOOL_OPTION_POOL_KEY_GUID}, 10983 {0, 0, 0, 0} 10984 }; 10985 10986 /* check options */ 10987 while ((c = getopt_long(argc, argv, "c:jdDegiLpPstT:vx", long_options, 10988 NULL)) != -1) { 10989 switch (c) { 10990 case 'c': 10991 if (cmd != NULL) { 10992 fprintf(stderr, 10993 gettext("Can't set -c flag twice\n")); 10994 exit(1); 10995 } 10996 10997 if (getenv("ZPOOL_SCRIPTS_ENABLED") != NULL && 10998 !libzfs_envvar_is_set("ZPOOL_SCRIPTS_ENABLED")) { 10999 fprintf(stderr, gettext( 11000 "Can't run -c, disabled by " 11001 "ZPOOL_SCRIPTS_ENABLED.\n")); 11002 exit(1); 11003 } 11004 11005 if ((getuid() <= 0 || geteuid() <= 0) && 11006 !libzfs_envvar_is_set("ZPOOL_SCRIPTS_AS_ROOT")) { 11007 fprintf(stderr, gettext( 11008 "Can't run -c with root privileges " 11009 "unless ZPOOL_SCRIPTS_AS_ROOT is set.\n")); 11010 exit(1); 11011 } 11012 cmd = optarg; 11013 break; 11014 case 'd': 11015 cb.cb_print_dio_verify = B_TRUE; 11016 break; 11017 case 'D': 11018 if (++cb.cb_dedup_stats > 2) 11019 cb.cb_dedup_stats = 2; 11020 break; 11021 case 'e': 11022 cb.cb_print_unhealthy = B_TRUE; 11023 break; 11024 case 'g': 11025 cb.cb_name_flags |= VDEV_NAME_GUID; 11026 break; 11027 case 'i': 11028 cb.cb_print_vdev_init = B_TRUE; 11029 break; 11030 case 'L': 11031 cb.cb_name_flags |= VDEV_NAME_FOLLOW_LINKS; 11032 break; 11033 case 'p': 11034 cb.cb_literal = B_TRUE; 11035 break; 11036 case 'P': 11037 cb.cb_name_flags |= VDEV_NAME_PATH; 11038 break; 11039 case 's': 11040 cb.cb_print_slow_ios = B_TRUE; 11041 break; 11042 case 't': 11043 cb.cb_print_vdev_trim = B_TRUE; 11044 break; 11045 case 'T': 11046 get_timestamp_arg(*optarg); 11047 break; 11048 case 'v': 11049 cb.cb_verbose = B_TRUE; 11050 break; 11051 case 'j': 11052 cb.cb_json = B_TRUE; 11053 break; 11054 case 'x': 11055 cb.cb_explain = B_TRUE; 11056 break; 11057 case ZPOOL_OPTION_POWER: 11058 cb.cb_print_power = B_TRUE; 11059 break; 11060 case ZPOOL_OPTION_JSON_FLAT_VDEVS: 11061 cb.cb_flat_vdevs = B_TRUE; 11062 break; 11063 case ZPOOL_OPTION_JSON_NUMS_AS_INT: 11064 cb.cb_json_as_int = B_TRUE; 11065 cb.cb_literal = B_TRUE; 11066 break; 11067 case ZPOOL_OPTION_POOL_KEY_GUID: 11068 cb.cb_json_pool_key_guid = B_TRUE; 11069 break; 11070 case '?': 11071 if (optopt == 'c') { 11072 print_zpool_script_list("status"); 11073 exit(0); 11074 } else { 11075 fprintf(stderr, 11076 gettext("invalid option '%c'\n"), optopt); 11077 } 11078 usage(B_FALSE); 11079 } 11080 } 11081 11082 argc -= optind; 11083 argv += optind; 11084 11085 get_interval_count(&argc, argv, &interval, &count); 11086 11087 if (argc == 0) 11088 cb.cb_allpools = B_TRUE; 11089 11090 cb.cb_first = B_TRUE; 11091 cb.cb_print_status = B_TRUE; 11092 11093 if (cb.cb_flat_vdevs && !cb.cb_json) { 11094 fprintf(stderr, gettext("'--json-flat-vdevs' only works with" 11095 " '-j' option\n")); 11096 usage(B_FALSE); 11097 } 11098 11099 if (cb.cb_json_as_int && !cb.cb_json) { 11100 (void) fprintf(stderr, gettext("'--json-int' only works with" 11101 " '-j' option\n")); 11102 usage(B_FALSE); 11103 } 11104 11105 if (!cb.cb_json && cb.cb_json_pool_key_guid) { 11106 (void) fprintf(stderr, gettext("'json-pool-key-guid' only" 11107 " works with '-j' option\n")); 11108 usage(B_FALSE); 11109 } 11110 11111 for (;;) { 11112 if (cb.cb_json) { 11113 cb.cb_jsobj = zpool_json_schema(0, 1); 11114 data = fnvlist_alloc(); 11115 fnvlist_add_nvlist(cb.cb_jsobj, "pools", data); 11116 fnvlist_free(data); 11117 } 11118 11119 if (timestamp_fmt != NODATE) { 11120 if (cb.cb_json) { 11121 if (cb.cb_json_as_int) { 11122 fnvlist_add_uint64(cb.cb_jsobj, "time", 11123 time(NULL)); 11124 } else { 11125 char ts[128]; 11126 get_timestamp(timestamp_fmt, ts, 128); 11127 fnvlist_add_string(cb.cb_jsobj, "time", 11128 ts); 11129 } 11130 } else 11131 print_timestamp(timestamp_fmt); 11132 } 11133 11134 if (cmd != NULL) 11135 cb.vcdl = all_pools_for_each_vdev_run(argc, argv, cmd, 11136 NULL, NULL, 0, 0); 11137 11138 if (cb.cb_json) { 11139 ret = for_each_pool(argc, argv, B_TRUE, NULL, 11140 ZFS_TYPE_POOL, cb.cb_literal, 11141 status_callback_json, &cb); 11142 } else { 11143 ret = for_each_pool(argc, argv, B_TRUE, NULL, 11144 ZFS_TYPE_POOL, cb.cb_literal, 11145 status_callback, &cb); 11146 } 11147 11148 if (cb.vcdl != NULL) 11149 free_vdev_cmd_data_list(cb.vcdl); 11150 11151 if (cb.cb_json) { 11152 if (ret == 0) 11153 zcmd_print_json(cb.cb_jsobj); 11154 else 11155 nvlist_free(cb.cb_jsobj); 11156 } else { 11157 if (argc == 0 && cb.cb_count == 0) { 11158 (void) fprintf(stderr, "%s", 11159 gettext("no pools available\n")); 11160 } else if (cb.cb_explain && cb.cb_first && 11161 cb.cb_allpools) { 11162 (void) printf("%s", 11163 gettext("all pools are healthy\n")); 11164 } 11165 } 11166 11167 if (ret != 0) 11168 return (ret); 11169 11170 if (interval == 0) 11171 break; 11172 11173 if (count != 0 && --count == 0) 11174 break; 11175 11176 (void) fflush(stdout); 11177 (void) fsleep(interval); 11178 } 11179 11180 return (0); 11181 } 11182 11183 typedef struct upgrade_cbdata { 11184 int cb_first; 11185 int cb_argc; 11186 uint64_t cb_version; 11187 char **cb_argv; 11188 } upgrade_cbdata_t; 11189 11190 static int 11191 check_unsupp_fs(zfs_handle_t *zhp, void *unsupp_fs) 11192 { 11193 int zfs_version = (int)zfs_prop_get_int(zhp, ZFS_PROP_VERSION); 11194 int *count = (int *)unsupp_fs; 11195 11196 if (zfs_version > ZPL_VERSION) { 11197 (void) printf(gettext("%s (v%d) is not supported by this " 11198 "implementation of ZFS.\n"), 11199 zfs_get_name(zhp), zfs_version); 11200 (*count)++; 11201 } 11202 11203 zfs_iter_filesystems_v2(zhp, 0, check_unsupp_fs, unsupp_fs); 11204 11205 zfs_close(zhp); 11206 11207 return (0); 11208 } 11209 11210 static int 11211 upgrade_version(zpool_handle_t *zhp, uint64_t version) 11212 { 11213 int ret; 11214 nvlist_t *config; 11215 uint64_t oldversion; 11216 int unsupp_fs = 0; 11217 11218 config = zpool_get_config(zhp, NULL); 11219 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION, 11220 &oldversion) == 0); 11221 11222 char compat[ZFS_MAXPROPLEN]; 11223 if (zpool_get_prop(zhp, ZPOOL_PROP_COMPATIBILITY, compat, 11224 ZFS_MAXPROPLEN, NULL, B_FALSE) != 0) 11225 compat[0] = '\0'; 11226 11227 assert(SPA_VERSION_IS_SUPPORTED(oldversion)); 11228 assert(oldversion < version); 11229 11230 ret = zfs_iter_root(zpool_get_handle(zhp), check_unsupp_fs, &unsupp_fs); 11231 if (ret != 0) 11232 return (ret); 11233 11234 if (unsupp_fs) { 11235 (void) fprintf(stderr, gettext("Upgrade not performed due " 11236 "to %d unsupported filesystems (max v%d).\n"), 11237 unsupp_fs, (int)ZPL_VERSION); 11238 return (1); 11239 } 11240 11241 if (strcmp(compat, ZPOOL_COMPAT_LEGACY) == 0) { 11242 (void) fprintf(stderr, gettext("Upgrade not performed because " 11243 "'compatibility' property set to '" 11244 ZPOOL_COMPAT_LEGACY "'.\n")); 11245 return (1); 11246 } 11247 11248 ret = zpool_upgrade(zhp, version); 11249 if (ret != 0) 11250 return (ret); 11251 11252 if (version >= SPA_VERSION_FEATURES) { 11253 (void) printf(gettext("Successfully upgraded " 11254 "'%s' from version %llu to feature flags.\n"), 11255 zpool_get_name(zhp), (u_longlong_t)oldversion); 11256 } else { 11257 (void) printf(gettext("Successfully upgraded " 11258 "'%s' from version %llu to version %llu.\n"), 11259 zpool_get_name(zhp), (u_longlong_t)oldversion, 11260 (u_longlong_t)version); 11261 } 11262 11263 return (0); 11264 } 11265 11266 static int 11267 upgrade_enable_all(zpool_handle_t *zhp, int *countp) 11268 { 11269 int i, ret, count; 11270 boolean_t firstff = B_TRUE; 11271 nvlist_t *enabled = zpool_get_features(zhp); 11272 11273 char compat[ZFS_MAXPROPLEN]; 11274 if (zpool_get_prop(zhp, ZPOOL_PROP_COMPATIBILITY, compat, 11275 ZFS_MAXPROPLEN, NULL, B_FALSE) != 0) 11276 compat[0] = '\0'; 11277 11278 boolean_t requested_features[SPA_FEATURES]; 11279 if (zpool_do_load_compat(compat, requested_features) != 11280 ZPOOL_COMPATIBILITY_OK) 11281 return (-1); 11282 11283 count = 0; 11284 for (i = 0; i < SPA_FEATURES; i++) { 11285 const char *fname = spa_feature_table[i].fi_uname; 11286 const char *fguid = spa_feature_table[i].fi_guid; 11287 11288 if (!spa_feature_table[i].fi_zfs_mod_supported) 11289 continue; 11290 11291 if (!nvlist_exists(enabled, fguid) && requested_features[i]) { 11292 char *propname; 11293 verify(-1 != asprintf(&propname, "feature@%s", fname)); 11294 ret = zpool_set_prop(zhp, propname, 11295 ZFS_FEATURE_ENABLED); 11296 if (ret != 0) { 11297 free(propname); 11298 return (ret); 11299 } 11300 count++; 11301 11302 if (firstff) { 11303 (void) printf(gettext("Enabled the " 11304 "following features on '%s':\n"), 11305 zpool_get_name(zhp)); 11306 firstff = B_FALSE; 11307 } 11308 (void) printf(gettext(" %s\n"), fname); 11309 free(propname); 11310 } 11311 } 11312 11313 if (countp != NULL) 11314 *countp = count; 11315 return (0); 11316 } 11317 11318 static int 11319 upgrade_cb(zpool_handle_t *zhp, void *arg) 11320 { 11321 upgrade_cbdata_t *cbp = arg; 11322 nvlist_t *config; 11323 uint64_t version; 11324 boolean_t modified_pool = B_FALSE; 11325 int ret; 11326 11327 config = zpool_get_config(zhp, NULL); 11328 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION, 11329 &version) == 0); 11330 11331 assert(SPA_VERSION_IS_SUPPORTED(version)); 11332 11333 if (version < cbp->cb_version) { 11334 cbp->cb_first = B_FALSE; 11335 ret = upgrade_version(zhp, cbp->cb_version); 11336 if (ret != 0) 11337 return (ret); 11338 modified_pool = B_TRUE; 11339 11340 /* 11341 * If they did "zpool upgrade -a", then we could 11342 * be doing ioctls to different pools. We need 11343 * to log this history once to each pool, and bypass 11344 * the normal history logging that happens in main(). 11345 */ 11346 (void) zpool_log_history(g_zfs, history_str); 11347 log_history = B_FALSE; 11348 } 11349 11350 if (cbp->cb_version >= SPA_VERSION_FEATURES) { 11351 int count; 11352 ret = upgrade_enable_all(zhp, &count); 11353 if (ret != 0) 11354 return (ret); 11355 11356 if (count > 0) { 11357 cbp->cb_first = B_FALSE; 11358 modified_pool = B_TRUE; 11359 } 11360 } 11361 11362 if (modified_pool) { 11363 (void) printf("\n"); 11364 (void) after_zpool_upgrade(zhp); 11365 } 11366 11367 return (0); 11368 } 11369 11370 static int 11371 upgrade_list_older_cb(zpool_handle_t *zhp, void *arg) 11372 { 11373 upgrade_cbdata_t *cbp = arg; 11374 nvlist_t *config; 11375 uint64_t version; 11376 11377 config = zpool_get_config(zhp, NULL); 11378 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION, 11379 &version) == 0); 11380 11381 assert(SPA_VERSION_IS_SUPPORTED(version)); 11382 11383 if (version < SPA_VERSION_FEATURES) { 11384 if (cbp->cb_first) { 11385 (void) printf(gettext("The following pools are " 11386 "formatted with legacy version numbers and can\n" 11387 "be upgraded to use feature flags. After " 11388 "being upgraded, these pools\nwill no " 11389 "longer be accessible by software that does not " 11390 "support feature\nflags.\n\n" 11391 "Note that setting a pool's 'compatibility' " 11392 "feature to '" ZPOOL_COMPAT_LEGACY "' will\n" 11393 "inhibit upgrades.\n\n")); 11394 (void) printf(gettext("VER POOL\n")); 11395 (void) printf(gettext("--- ------------\n")); 11396 cbp->cb_first = B_FALSE; 11397 } 11398 11399 (void) printf("%2llu %s\n", (u_longlong_t)version, 11400 zpool_get_name(zhp)); 11401 } 11402 11403 return (0); 11404 } 11405 11406 static int 11407 upgrade_list_disabled_cb(zpool_handle_t *zhp, void *arg) 11408 { 11409 upgrade_cbdata_t *cbp = arg; 11410 nvlist_t *config; 11411 uint64_t version; 11412 11413 config = zpool_get_config(zhp, NULL); 11414 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION, 11415 &version) == 0); 11416 11417 if (version >= SPA_VERSION_FEATURES) { 11418 int i; 11419 boolean_t poolfirst = B_TRUE; 11420 nvlist_t *enabled = zpool_get_features(zhp); 11421 11422 for (i = 0; i < SPA_FEATURES; i++) { 11423 const char *fguid = spa_feature_table[i].fi_guid; 11424 const char *fname = spa_feature_table[i].fi_uname; 11425 11426 if (!spa_feature_table[i].fi_zfs_mod_supported) 11427 continue; 11428 11429 if (!nvlist_exists(enabled, fguid)) { 11430 if (cbp->cb_first) { 11431 (void) printf(gettext("\nSome " 11432 "supported features are not " 11433 "enabled on the following pools. " 11434 "Once a\nfeature is enabled the " 11435 "pool may become incompatible with " 11436 "software\nthat does not support " 11437 "the feature. See " 11438 "zpool-features(7) for " 11439 "details.\n\n" 11440 "Note that the pool " 11441 "'compatibility' feature can be " 11442 "used to inhibit\nfeature " 11443 "upgrades.\n\n")); 11444 (void) printf(gettext("POOL " 11445 "FEATURE\n")); 11446 (void) printf(gettext("------" 11447 "---------\n")); 11448 cbp->cb_first = B_FALSE; 11449 } 11450 11451 if (poolfirst) { 11452 (void) printf(gettext("%s\n"), 11453 zpool_get_name(zhp)); 11454 poolfirst = B_FALSE; 11455 } 11456 11457 (void) printf(gettext(" %s\n"), fname); 11458 } 11459 /* 11460 * If they did "zpool upgrade -a", then we could 11461 * be doing ioctls to different pools. We need 11462 * to log this history once to each pool, and bypass 11463 * the normal history logging that happens in main(). 11464 */ 11465 (void) zpool_log_history(g_zfs, history_str); 11466 log_history = B_FALSE; 11467 } 11468 } 11469 11470 return (0); 11471 } 11472 11473 static int 11474 upgrade_one(zpool_handle_t *zhp, void *data) 11475 { 11476 boolean_t modified_pool = B_FALSE; 11477 upgrade_cbdata_t *cbp = data; 11478 uint64_t cur_version; 11479 int ret; 11480 11481 if (strcmp("log", zpool_get_name(zhp)) == 0) { 11482 (void) fprintf(stderr, gettext("'log' is now a reserved word\n" 11483 "Pool 'log' must be renamed using export and import" 11484 " to upgrade.\n")); 11485 return (1); 11486 } 11487 11488 cur_version = zpool_get_prop_int(zhp, ZPOOL_PROP_VERSION, NULL); 11489 if (cur_version > cbp->cb_version) { 11490 (void) printf(gettext("Pool '%s' is already formatted " 11491 "using more current version '%llu'.\n\n"), 11492 zpool_get_name(zhp), (u_longlong_t)cur_version); 11493 return (0); 11494 } 11495 11496 if (cbp->cb_version != SPA_VERSION && cur_version == cbp->cb_version) { 11497 (void) printf(gettext("Pool '%s' is already formatted " 11498 "using version %llu.\n\n"), zpool_get_name(zhp), 11499 (u_longlong_t)cbp->cb_version); 11500 return (0); 11501 } 11502 11503 if (cur_version != cbp->cb_version) { 11504 modified_pool = B_TRUE; 11505 ret = upgrade_version(zhp, cbp->cb_version); 11506 if (ret != 0) 11507 return (ret); 11508 } 11509 11510 if (cbp->cb_version >= SPA_VERSION_FEATURES) { 11511 int count = 0; 11512 ret = upgrade_enable_all(zhp, &count); 11513 if (ret != 0) 11514 return (ret); 11515 11516 if (count != 0) { 11517 modified_pool = B_TRUE; 11518 } else if (cur_version == SPA_VERSION) { 11519 (void) printf(gettext("Pool '%s' already has all " 11520 "supported and requested features enabled.\n"), 11521 zpool_get_name(zhp)); 11522 } 11523 } 11524 11525 if (modified_pool) { 11526 (void) printf("\n"); 11527 (void) after_zpool_upgrade(zhp); 11528 } 11529 11530 return (0); 11531 } 11532 11533 /* 11534 * zpool upgrade 11535 * zpool upgrade -v 11536 * zpool upgrade [-V version] <-a | pool ...> 11537 * 11538 * With no arguments, display downrev'd ZFS pool available for upgrade. 11539 * Individual pools can be upgraded by specifying the pool, and '-a' will 11540 * upgrade all pools. 11541 */ 11542 int 11543 zpool_do_upgrade(int argc, char **argv) 11544 { 11545 int c; 11546 upgrade_cbdata_t cb = { 0 }; 11547 int ret = 0; 11548 boolean_t showversions = B_FALSE; 11549 boolean_t upgradeall = B_FALSE; 11550 char *end; 11551 11552 11553 /* check options */ 11554 while ((c = getopt(argc, argv, ":avV:")) != -1) { 11555 switch (c) { 11556 case 'a': 11557 upgradeall = B_TRUE; 11558 break; 11559 case 'v': 11560 showversions = B_TRUE; 11561 break; 11562 case 'V': 11563 cb.cb_version = strtoll(optarg, &end, 10); 11564 if (*end != '\0' || 11565 !SPA_VERSION_IS_SUPPORTED(cb.cb_version)) { 11566 (void) fprintf(stderr, 11567 gettext("invalid version '%s'\n"), optarg); 11568 usage(B_FALSE); 11569 } 11570 break; 11571 case ':': 11572 (void) fprintf(stderr, gettext("missing argument for " 11573 "'%c' option\n"), optopt); 11574 usage(B_FALSE); 11575 break; 11576 case '?': 11577 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 11578 optopt); 11579 usage(B_FALSE); 11580 } 11581 } 11582 11583 cb.cb_argc = argc; 11584 cb.cb_argv = argv; 11585 argc -= optind; 11586 argv += optind; 11587 11588 if (cb.cb_version == 0) { 11589 cb.cb_version = SPA_VERSION; 11590 } else if (!upgradeall && argc == 0) { 11591 (void) fprintf(stderr, gettext("-V option is " 11592 "incompatible with other arguments\n")); 11593 usage(B_FALSE); 11594 } 11595 11596 if (showversions) { 11597 if (upgradeall || argc != 0) { 11598 (void) fprintf(stderr, gettext("-v option is " 11599 "incompatible with other arguments\n")); 11600 usage(B_FALSE); 11601 } 11602 } else if (upgradeall) { 11603 if (argc != 0) { 11604 (void) fprintf(stderr, gettext("-a option should not " 11605 "be used along with a pool name\n")); 11606 usage(B_FALSE); 11607 } 11608 } 11609 11610 (void) printf("%s", gettext("This system supports ZFS pool feature " 11611 "flags.\n\n")); 11612 if (showversions) { 11613 int i; 11614 11615 (void) printf(gettext("The following features are " 11616 "supported:\n\n")); 11617 (void) printf(gettext("FEAT DESCRIPTION\n")); 11618 (void) printf("----------------------------------------------" 11619 "---------------\n"); 11620 for (i = 0; i < SPA_FEATURES; i++) { 11621 zfeature_info_t *fi = &spa_feature_table[i]; 11622 if (!fi->fi_zfs_mod_supported) 11623 continue; 11624 const char *ro = 11625 (fi->fi_flags & ZFEATURE_FLAG_READONLY_COMPAT) ? 11626 " (read-only compatible)" : ""; 11627 11628 (void) printf("%-37s%s\n", fi->fi_uname, ro); 11629 (void) printf(" %s\n", fi->fi_desc); 11630 } 11631 (void) printf("\n"); 11632 11633 (void) printf(gettext("The following legacy versions are also " 11634 "supported:\n\n")); 11635 (void) printf(gettext("VER DESCRIPTION\n")); 11636 (void) printf("--- -----------------------------------------" 11637 "---------------\n"); 11638 (void) printf(gettext(" 1 Initial ZFS version\n")); 11639 (void) printf(gettext(" 2 Ditto blocks " 11640 "(replicated metadata)\n")); 11641 (void) printf(gettext(" 3 Hot spares and double parity " 11642 "RAID-Z\n")); 11643 (void) printf(gettext(" 4 zpool history\n")); 11644 (void) printf(gettext(" 5 Compression using the gzip " 11645 "algorithm\n")); 11646 (void) printf(gettext(" 6 bootfs pool property\n")); 11647 (void) printf(gettext(" 7 Separate intent log devices\n")); 11648 (void) printf(gettext(" 8 Delegated administration\n")); 11649 (void) printf(gettext(" 9 refquota and refreservation " 11650 "properties\n")); 11651 (void) printf(gettext(" 10 Cache devices\n")); 11652 (void) printf(gettext(" 11 Improved scrub performance\n")); 11653 (void) printf(gettext(" 12 Snapshot properties\n")); 11654 (void) printf(gettext(" 13 snapused property\n")); 11655 (void) printf(gettext(" 14 passthrough-x aclinherit\n")); 11656 (void) printf(gettext(" 15 user/group space accounting\n")); 11657 (void) printf(gettext(" 16 stmf property support\n")); 11658 (void) printf(gettext(" 17 Triple-parity RAID-Z\n")); 11659 (void) printf(gettext(" 18 Snapshot user holds\n")); 11660 (void) printf(gettext(" 19 Log device removal\n")); 11661 (void) printf(gettext(" 20 Compression using zle " 11662 "(zero-length encoding)\n")); 11663 (void) printf(gettext(" 21 Deduplication\n")); 11664 (void) printf(gettext(" 22 Received properties\n")); 11665 (void) printf(gettext(" 23 Slim ZIL\n")); 11666 (void) printf(gettext(" 24 System attributes\n")); 11667 (void) printf(gettext(" 25 Improved scrub stats\n")); 11668 (void) printf(gettext(" 26 Improved snapshot deletion " 11669 "performance\n")); 11670 (void) printf(gettext(" 27 Improved snapshot creation " 11671 "performance\n")); 11672 (void) printf(gettext(" 28 Multiple vdev replacements\n")); 11673 (void) printf(gettext("\nFor more information on a particular " 11674 "version, including supported releases,\n")); 11675 (void) printf(gettext("see the ZFS Administration Guide.\n\n")); 11676 } else if (argc == 0 && upgradeall) { 11677 cb.cb_first = B_TRUE; 11678 ret = zpool_iter(g_zfs, upgrade_cb, &cb); 11679 if (ret == 0 && cb.cb_first) { 11680 if (cb.cb_version == SPA_VERSION) { 11681 (void) printf(gettext("All pools are already " 11682 "formatted using feature flags.\n\n")); 11683 (void) printf(gettext("Every feature flags " 11684 "pool already has all supported and " 11685 "requested features enabled.\n")); 11686 } else { 11687 (void) printf(gettext("All pools are already " 11688 "formatted with version %llu or higher.\n"), 11689 (u_longlong_t)cb.cb_version); 11690 } 11691 } 11692 } else if (argc == 0) { 11693 cb.cb_first = B_TRUE; 11694 ret = zpool_iter(g_zfs, upgrade_list_older_cb, &cb); 11695 assert(ret == 0); 11696 11697 if (cb.cb_first) { 11698 (void) printf(gettext("All pools are formatted " 11699 "using feature flags.\n\n")); 11700 } else { 11701 (void) printf(gettext("\nUse 'zpool upgrade -v' " 11702 "for a list of available legacy versions.\n")); 11703 } 11704 11705 cb.cb_first = B_TRUE; 11706 ret = zpool_iter(g_zfs, upgrade_list_disabled_cb, &cb); 11707 assert(ret == 0); 11708 11709 if (cb.cb_first) { 11710 (void) printf(gettext("Every feature flags pool has " 11711 "all supported and requested features enabled.\n")); 11712 } else { 11713 (void) printf(gettext("\n")); 11714 } 11715 } else { 11716 ret = for_each_pool(argc, argv, B_FALSE, NULL, ZFS_TYPE_POOL, 11717 B_FALSE, upgrade_one, &cb); 11718 } 11719 11720 return (ret); 11721 } 11722 11723 typedef struct hist_cbdata { 11724 boolean_t first; 11725 boolean_t longfmt; 11726 boolean_t internal; 11727 } hist_cbdata_t; 11728 11729 static void 11730 print_history_records(nvlist_t *nvhis, hist_cbdata_t *cb) 11731 { 11732 nvlist_t **records; 11733 uint_t numrecords; 11734 int i; 11735 11736 verify(nvlist_lookup_nvlist_array(nvhis, ZPOOL_HIST_RECORD, 11737 &records, &numrecords) == 0); 11738 for (i = 0; i < numrecords; i++) { 11739 nvlist_t *rec = records[i]; 11740 char tbuf[64] = ""; 11741 11742 if (nvlist_exists(rec, ZPOOL_HIST_TIME)) { 11743 time_t tsec; 11744 struct tm t; 11745 11746 tsec = fnvlist_lookup_uint64(records[i], 11747 ZPOOL_HIST_TIME); 11748 (void) localtime_r(&tsec, &t); 11749 (void) strftime(tbuf, sizeof (tbuf), "%F.%T", &t); 11750 } 11751 11752 if (nvlist_exists(rec, ZPOOL_HIST_ELAPSED_NS)) { 11753 uint64_t elapsed_ns = fnvlist_lookup_int64(records[i], 11754 ZPOOL_HIST_ELAPSED_NS); 11755 (void) snprintf(tbuf + strlen(tbuf), 11756 sizeof (tbuf) - strlen(tbuf), 11757 " (%lldms)", (long long)elapsed_ns / 1000 / 1000); 11758 } 11759 11760 if (nvlist_exists(rec, ZPOOL_HIST_CMD)) { 11761 (void) printf("%s %s", tbuf, 11762 fnvlist_lookup_string(rec, ZPOOL_HIST_CMD)); 11763 } else if (nvlist_exists(rec, ZPOOL_HIST_INT_EVENT)) { 11764 int ievent = 11765 fnvlist_lookup_uint64(rec, ZPOOL_HIST_INT_EVENT); 11766 if (!cb->internal) 11767 continue; 11768 if (ievent >= ZFS_NUM_LEGACY_HISTORY_EVENTS) { 11769 (void) printf("%s unrecognized record:\n", 11770 tbuf); 11771 dump_nvlist(rec, 4); 11772 continue; 11773 } 11774 (void) printf("%s [internal %s txg:%lld] %s", tbuf, 11775 zfs_history_event_names[ievent], 11776 (longlong_t)fnvlist_lookup_uint64( 11777 rec, ZPOOL_HIST_TXG), 11778 fnvlist_lookup_string(rec, ZPOOL_HIST_INT_STR)); 11779 } else if (nvlist_exists(rec, ZPOOL_HIST_INT_NAME)) { 11780 if (!cb->internal) 11781 continue; 11782 (void) printf("%s [txg:%lld] %s", tbuf, 11783 (longlong_t)fnvlist_lookup_uint64( 11784 rec, ZPOOL_HIST_TXG), 11785 fnvlist_lookup_string(rec, ZPOOL_HIST_INT_NAME)); 11786 if (nvlist_exists(rec, ZPOOL_HIST_DSNAME)) { 11787 (void) printf(" %s (%llu)", 11788 fnvlist_lookup_string(rec, 11789 ZPOOL_HIST_DSNAME), 11790 (u_longlong_t)fnvlist_lookup_uint64(rec, 11791 ZPOOL_HIST_DSID)); 11792 } 11793 (void) printf(" %s", fnvlist_lookup_string(rec, 11794 ZPOOL_HIST_INT_STR)); 11795 } else if (nvlist_exists(rec, ZPOOL_HIST_IOCTL)) { 11796 if (!cb->internal) 11797 continue; 11798 (void) printf("%s ioctl %s\n", tbuf, 11799 fnvlist_lookup_string(rec, ZPOOL_HIST_IOCTL)); 11800 if (nvlist_exists(rec, ZPOOL_HIST_INPUT_NVL)) { 11801 (void) printf(" input:\n"); 11802 dump_nvlist(fnvlist_lookup_nvlist(rec, 11803 ZPOOL_HIST_INPUT_NVL), 8); 11804 } 11805 if (nvlist_exists(rec, ZPOOL_HIST_OUTPUT_NVL)) { 11806 (void) printf(" output:\n"); 11807 dump_nvlist(fnvlist_lookup_nvlist(rec, 11808 ZPOOL_HIST_OUTPUT_NVL), 8); 11809 } 11810 if (nvlist_exists(rec, ZPOOL_HIST_OUTPUT_SIZE)) { 11811 (void) printf(" output nvlist omitted; " 11812 "original size: %lldKB\n", 11813 (longlong_t)fnvlist_lookup_int64(rec, 11814 ZPOOL_HIST_OUTPUT_SIZE) / 1024); 11815 } 11816 if (nvlist_exists(rec, ZPOOL_HIST_ERRNO)) { 11817 (void) printf(" errno: %lld\n", 11818 (longlong_t)fnvlist_lookup_int64(rec, 11819 ZPOOL_HIST_ERRNO)); 11820 } 11821 } else { 11822 if (!cb->internal) 11823 continue; 11824 (void) printf("%s unrecognized record:\n", tbuf); 11825 dump_nvlist(rec, 4); 11826 } 11827 11828 if (!cb->longfmt) { 11829 (void) printf("\n"); 11830 continue; 11831 } 11832 (void) printf(" ["); 11833 if (nvlist_exists(rec, ZPOOL_HIST_WHO)) { 11834 uid_t who = fnvlist_lookup_uint64(rec, ZPOOL_HIST_WHO); 11835 struct passwd *pwd = getpwuid(who); 11836 (void) printf("user %d ", (int)who); 11837 if (pwd != NULL) 11838 (void) printf("(%s) ", pwd->pw_name); 11839 } 11840 if (nvlist_exists(rec, ZPOOL_HIST_HOST)) { 11841 (void) printf("on %s", 11842 fnvlist_lookup_string(rec, ZPOOL_HIST_HOST)); 11843 } 11844 if (nvlist_exists(rec, ZPOOL_HIST_ZONE)) { 11845 (void) printf(":%s", 11846 fnvlist_lookup_string(rec, ZPOOL_HIST_ZONE)); 11847 } 11848 11849 (void) printf("]"); 11850 (void) printf("\n"); 11851 } 11852 } 11853 11854 /* 11855 * Print out the command history for a specific pool. 11856 */ 11857 static int 11858 get_history_one(zpool_handle_t *zhp, void *data) 11859 { 11860 nvlist_t *nvhis; 11861 int ret; 11862 hist_cbdata_t *cb = (hist_cbdata_t *)data; 11863 uint64_t off = 0; 11864 boolean_t eof = B_FALSE; 11865 11866 cb->first = B_FALSE; 11867 11868 (void) printf(gettext("History for '%s':\n"), zpool_get_name(zhp)); 11869 11870 while (!eof) { 11871 if ((ret = zpool_get_history(zhp, &nvhis, &off, &eof)) != 0) 11872 return (ret); 11873 11874 print_history_records(nvhis, cb); 11875 nvlist_free(nvhis); 11876 } 11877 (void) printf("\n"); 11878 11879 return (ret); 11880 } 11881 11882 /* 11883 * zpool history <pool> 11884 * 11885 * Displays the history of commands that modified pools. 11886 */ 11887 int 11888 zpool_do_history(int argc, char **argv) 11889 { 11890 hist_cbdata_t cbdata = { 0 }; 11891 int ret; 11892 int c; 11893 11894 cbdata.first = B_TRUE; 11895 /* check options */ 11896 while ((c = getopt(argc, argv, "li")) != -1) { 11897 switch (c) { 11898 case 'l': 11899 cbdata.longfmt = B_TRUE; 11900 break; 11901 case 'i': 11902 cbdata.internal = B_TRUE; 11903 break; 11904 case '?': 11905 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 11906 optopt); 11907 usage(B_FALSE); 11908 } 11909 } 11910 argc -= optind; 11911 argv += optind; 11912 11913 ret = for_each_pool(argc, argv, B_FALSE, NULL, ZFS_TYPE_POOL, 11914 B_FALSE, get_history_one, &cbdata); 11915 11916 if (argc == 0 && cbdata.first == B_TRUE) { 11917 (void) fprintf(stderr, gettext("no pools available\n")); 11918 return (0); 11919 } 11920 11921 return (ret); 11922 } 11923 11924 typedef struct ev_opts { 11925 int verbose; 11926 int scripted; 11927 int follow; 11928 int clear; 11929 char poolname[ZFS_MAX_DATASET_NAME_LEN]; 11930 } ev_opts_t; 11931 11932 static void 11933 zpool_do_events_short(nvlist_t *nvl, ev_opts_t *opts) 11934 { 11935 char ctime_str[26], str[32]; 11936 const char *ptr; 11937 int64_t *tv; 11938 uint_t n; 11939 11940 verify(nvlist_lookup_int64_array(nvl, FM_EREPORT_TIME, &tv, &n) == 0); 11941 memset(str, ' ', 32); 11942 (void) ctime_r((const time_t *)&tv[0], ctime_str); 11943 (void) memcpy(str, ctime_str+4, 6); /* 'Jun 30' */ 11944 (void) memcpy(str+7, ctime_str+20, 4); /* '1993' */ 11945 (void) memcpy(str+12, ctime_str+11, 8); /* '21:49:08' */ 11946 (void) sprintf(str+20, ".%09lld", (longlong_t)tv[1]); /* '.123456789' */ 11947 if (opts->scripted) 11948 (void) printf(gettext("%s\t"), str); 11949 else 11950 (void) printf(gettext("%s "), str); 11951 11952 verify(nvlist_lookup_string(nvl, FM_CLASS, &ptr) == 0); 11953 (void) printf(gettext("%s\n"), ptr); 11954 } 11955 11956 static void 11957 zpool_do_events_nvprint(nvlist_t *nvl, int depth) 11958 { 11959 nvpair_t *nvp; 11960 static char flagstr[256]; 11961 11962 for (nvp = nvlist_next_nvpair(nvl, NULL); 11963 nvp != NULL; nvp = nvlist_next_nvpair(nvl, nvp)) { 11964 11965 data_type_t type = nvpair_type(nvp); 11966 const char *name = nvpair_name(nvp); 11967 11968 boolean_t b; 11969 uint8_t i8; 11970 uint16_t i16; 11971 uint32_t i32; 11972 uint64_t i64; 11973 const char *str; 11974 nvlist_t *cnv; 11975 11976 printf(gettext("%*s%s = "), depth, "", name); 11977 11978 switch (type) { 11979 case DATA_TYPE_BOOLEAN: 11980 printf(gettext("%s"), "1"); 11981 break; 11982 11983 case DATA_TYPE_BOOLEAN_VALUE: 11984 (void) nvpair_value_boolean_value(nvp, &b); 11985 printf(gettext("%s"), b ? "1" : "0"); 11986 break; 11987 11988 case DATA_TYPE_BYTE: 11989 (void) nvpair_value_byte(nvp, &i8); 11990 printf(gettext("0x%x"), i8); 11991 break; 11992 11993 case DATA_TYPE_INT8: 11994 (void) nvpair_value_int8(nvp, (void *)&i8); 11995 printf(gettext("0x%x"), i8); 11996 break; 11997 11998 case DATA_TYPE_UINT8: 11999 (void) nvpair_value_uint8(nvp, &i8); 12000 printf(gettext("0x%x"), i8); 12001 break; 12002 12003 case DATA_TYPE_INT16: 12004 (void) nvpair_value_int16(nvp, (void *)&i16); 12005 printf(gettext("0x%x"), i16); 12006 break; 12007 12008 case DATA_TYPE_UINT16: 12009 (void) nvpair_value_uint16(nvp, &i16); 12010 printf(gettext("0x%x"), i16); 12011 break; 12012 12013 case DATA_TYPE_INT32: 12014 (void) nvpair_value_int32(nvp, (void *)&i32); 12015 printf(gettext("0x%x"), i32); 12016 break; 12017 12018 case DATA_TYPE_UINT32: 12019 (void) nvpair_value_uint32(nvp, &i32); 12020 if (strcmp(name, 12021 FM_EREPORT_PAYLOAD_ZFS_ZIO_STAGE) == 0 || 12022 strcmp(name, 12023 FM_EREPORT_PAYLOAD_ZFS_ZIO_PIPELINE) == 0) { 12024 zfs_valstr_zio_stage(i32, flagstr, 12025 sizeof (flagstr)); 12026 printf(gettext("0x%x [%s]"), i32, flagstr); 12027 } else if (strcmp(name, 12028 FM_EREPORT_PAYLOAD_ZFS_ZIO_PRIORITY) == 0) { 12029 zfs_valstr_zio_priority(i32, flagstr, 12030 sizeof (flagstr)); 12031 printf(gettext("0x%x [%s]"), i32, flagstr); 12032 } else { 12033 printf(gettext("0x%x"), i32); 12034 } 12035 break; 12036 12037 case DATA_TYPE_INT64: 12038 (void) nvpair_value_int64(nvp, (void *)&i64); 12039 printf(gettext("0x%llx"), (u_longlong_t)i64); 12040 break; 12041 12042 case DATA_TYPE_UINT64: 12043 (void) nvpair_value_uint64(nvp, &i64); 12044 /* 12045 * translate vdev state values to readable 12046 * strings to aide zpool events consumers 12047 */ 12048 if (strcmp(name, 12049 FM_EREPORT_PAYLOAD_ZFS_VDEV_STATE) == 0 || 12050 strcmp(name, 12051 FM_EREPORT_PAYLOAD_ZFS_VDEV_LASTSTATE) == 0) { 12052 printf(gettext("\"%s\" (0x%llx)"), 12053 zpool_state_to_name(i64, VDEV_AUX_NONE), 12054 (u_longlong_t)i64); 12055 } else if (strcmp(name, 12056 FM_EREPORT_PAYLOAD_ZFS_ZIO_FLAGS) == 0) { 12057 zfs_valstr_zio_flag(i64, flagstr, 12058 sizeof (flagstr)); 12059 printf(gettext("0x%llx [%s]"), 12060 (u_longlong_t)i64, flagstr); 12061 } else { 12062 printf(gettext("0x%llx"), (u_longlong_t)i64); 12063 } 12064 break; 12065 12066 case DATA_TYPE_HRTIME: 12067 (void) nvpair_value_hrtime(nvp, (void *)&i64); 12068 printf(gettext("0x%llx"), (u_longlong_t)i64); 12069 break; 12070 12071 case DATA_TYPE_STRING: 12072 (void) nvpair_value_string(nvp, &str); 12073 printf(gettext("\"%s\""), str ? str : "<NULL>"); 12074 break; 12075 12076 case DATA_TYPE_NVLIST: 12077 printf(gettext("(embedded nvlist)\n")); 12078 (void) nvpair_value_nvlist(nvp, &cnv); 12079 zpool_do_events_nvprint(cnv, depth + 8); 12080 printf(gettext("%*s(end %s)"), depth, "", name); 12081 break; 12082 12083 case DATA_TYPE_NVLIST_ARRAY: { 12084 nvlist_t **val; 12085 uint_t i, nelem; 12086 12087 (void) nvpair_value_nvlist_array(nvp, &val, &nelem); 12088 printf(gettext("(%d embedded nvlists)\n"), nelem); 12089 for (i = 0; i < nelem; i++) { 12090 printf(gettext("%*s%s[%d] = %s\n"), 12091 depth, "", name, i, "(embedded nvlist)"); 12092 zpool_do_events_nvprint(val[i], depth + 8); 12093 printf(gettext("%*s(end %s[%i])\n"), 12094 depth, "", name, i); 12095 } 12096 printf(gettext("%*s(end %s)\n"), depth, "", name); 12097 } 12098 break; 12099 12100 case DATA_TYPE_INT8_ARRAY: { 12101 int8_t *val; 12102 uint_t i, nelem; 12103 12104 (void) nvpair_value_int8_array(nvp, &val, &nelem); 12105 for (i = 0; i < nelem; i++) 12106 printf(gettext("0x%x "), val[i]); 12107 12108 break; 12109 } 12110 12111 case DATA_TYPE_UINT8_ARRAY: { 12112 uint8_t *val; 12113 uint_t i, nelem; 12114 12115 (void) nvpair_value_uint8_array(nvp, &val, &nelem); 12116 for (i = 0; i < nelem; i++) 12117 printf(gettext("0x%x "), val[i]); 12118 12119 break; 12120 } 12121 12122 case DATA_TYPE_INT16_ARRAY: { 12123 int16_t *val; 12124 uint_t i, nelem; 12125 12126 (void) nvpair_value_int16_array(nvp, &val, &nelem); 12127 for (i = 0; i < nelem; i++) 12128 printf(gettext("0x%x "), val[i]); 12129 12130 break; 12131 } 12132 12133 case DATA_TYPE_UINT16_ARRAY: { 12134 uint16_t *val; 12135 uint_t i, nelem; 12136 12137 (void) nvpair_value_uint16_array(nvp, &val, &nelem); 12138 for (i = 0; i < nelem; i++) 12139 printf(gettext("0x%x "), val[i]); 12140 12141 break; 12142 } 12143 12144 case DATA_TYPE_INT32_ARRAY: { 12145 int32_t *val; 12146 uint_t i, nelem; 12147 12148 (void) nvpair_value_int32_array(nvp, &val, &nelem); 12149 for (i = 0; i < nelem; i++) 12150 printf(gettext("0x%x "), val[i]); 12151 12152 break; 12153 } 12154 12155 case DATA_TYPE_UINT32_ARRAY: { 12156 uint32_t *val; 12157 uint_t i, nelem; 12158 12159 (void) nvpair_value_uint32_array(nvp, &val, &nelem); 12160 for (i = 0; i < nelem; i++) 12161 printf(gettext("0x%x "), val[i]); 12162 12163 break; 12164 } 12165 12166 case DATA_TYPE_INT64_ARRAY: { 12167 int64_t *val; 12168 uint_t i, nelem; 12169 12170 (void) nvpair_value_int64_array(nvp, &val, &nelem); 12171 for (i = 0; i < nelem; i++) 12172 printf(gettext("0x%llx "), 12173 (u_longlong_t)val[i]); 12174 12175 break; 12176 } 12177 12178 case DATA_TYPE_UINT64_ARRAY: { 12179 uint64_t *val; 12180 uint_t i, nelem; 12181 12182 (void) nvpair_value_uint64_array(nvp, &val, &nelem); 12183 for (i = 0; i < nelem; i++) 12184 printf(gettext("0x%llx "), 12185 (u_longlong_t)val[i]); 12186 12187 break; 12188 } 12189 12190 case DATA_TYPE_STRING_ARRAY: { 12191 const char **str; 12192 uint_t i, nelem; 12193 12194 (void) nvpair_value_string_array(nvp, &str, &nelem); 12195 for (i = 0; i < nelem; i++) 12196 printf(gettext("\"%s\" "), 12197 str[i] ? str[i] : "<NULL>"); 12198 12199 break; 12200 } 12201 12202 case DATA_TYPE_BOOLEAN_ARRAY: 12203 case DATA_TYPE_BYTE_ARRAY: 12204 case DATA_TYPE_DOUBLE: 12205 case DATA_TYPE_DONTCARE: 12206 case DATA_TYPE_UNKNOWN: 12207 printf(gettext("<unknown>")); 12208 break; 12209 } 12210 12211 printf(gettext("\n")); 12212 } 12213 } 12214 12215 static int 12216 zpool_do_events_next(ev_opts_t *opts) 12217 { 12218 nvlist_t *nvl; 12219 int zevent_fd, ret, dropped; 12220 const char *pool; 12221 12222 zevent_fd = open(ZFS_DEV, O_RDWR); 12223 VERIFY(zevent_fd >= 0); 12224 12225 if (!opts->scripted) 12226 (void) printf(gettext("%-30s %s\n"), "TIME", "CLASS"); 12227 12228 while (1) { 12229 ret = zpool_events_next(g_zfs, &nvl, &dropped, 12230 (opts->follow ? ZEVENT_NONE : ZEVENT_NONBLOCK), zevent_fd); 12231 if (ret || nvl == NULL) 12232 break; 12233 12234 if (dropped > 0) 12235 (void) printf(gettext("dropped %d events\n"), dropped); 12236 12237 if (strlen(opts->poolname) > 0 && 12238 nvlist_lookup_string(nvl, FM_FMRI_ZFS_POOL, &pool) == 0 && 12239 strcmp(opts->poolname, pool) != 0) 12240 continue; 12241 12242 zpool_do_events_short(nvl, opts); 12243 12244 if (opts->verbose) { 12245 zpool_do_events_nvprint(nvl, 8); 12246 printf(gettext("\n")); 12247 } 12248 (void) fflush(stdout); 12249 12250 nvlist_free(nvl); 12251 } 12252 12253 VERIFY(0 == close(zevent_fd)); 12254 12255 return (ret); 12256 } 12257 12258 static int 12259 zpool_do_events_clear(void) 12260 { 12261 int count, ret; 12262 12263 ret = zpool_events_clear(g_zfs, &count); 12264 if (!ret) 12265 (void) printf(gettext("cleared %d events\n"), count); 12266 12267 return (ret); 12268 } 12269 12270 /* 12271 * zpool events [-vHf [pool] | -c] 12272 * 12273 * Displays events logs by ZFS. 12274 */ 12275 int 12276 zpool_do_events(int argc, char **argv) 12277 { 12278 ev_opts_t opts = { 0 }; 12279 int ret; 12280 int c; 12281 12282 /* check options */ 12283 while ((c = getopt(argc, argv, "vHfc")) != -1) { 12284 switch (c) { 12285 case 'v': 12286 opts.verbose = 1; 12287 break; 12288 case 'H': 12289 opts.scripted = 1; 12290 break; 12291 case 'f': 12292 opts.follow = 1; 12293 break; 12294 case 'c': 12295 opts.clear = 1; 12296 break; 12297 case '?': 12298 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 12299 optopt); 12300 usage(B_FALSE); 12301 } 12302 } 12303 argc -= optind; 12304 argv += optind; 12305 12306 if (argc > 1) { 12307 (void) fprintf(stderr, gettext("too many arguments\n")); 12308 usage(B_FALSE); 12309 } else if (argc == 1) { 12310 (void) strlcpy(opts.poolname, argv[0], sizeof (opts.poolname)); 12311 if (!zfs_name_valid(opts.poolname, ZFS_TYPE_POOL)) { 12312 (void) fprintf(stderr, 12313 gettext("invalid pool name '%s'\n"), opts.poolname); 12314 usage(B_FALSE); 12315 } 12316 } 12317 12318 if ((argc == 1 || opts.verbose || opts.scripted || opts.follow) && 12319 opts.clear) { 12320 (void) fprintf(stderr, 12321 gettext("invalid options combined with -c\n")); 12322 usage(B_FALSE); 12323 } 12324 12325 if (opts.clear) 12326 ret = zpool_do_events_clear(); 12327 else 12328 ret = zpool_do_events_next(&opts); 12329 12330 return (ret); 12331 } 12332 12333 static int 12334 get_callback_vdev(zpool_handle_t *zhp, char *vdevname, void *data) 12335 { 12336 zprop_get_cbdata_t *cbp = (zprop_get_cbdata_t *)data; 12337 char value[ZFS_MAXPROPLEN]; 12338 zprop_source_t srctype; 12339 nvlist_t *props, *item, *d; 12340 props = item = d = NULL; 12341 12342 if (cbp->cb_json) { 12343 d = fnvlist_lookup_nvlist(cbp->cb_jsobj, "vdevs"); 12344 if (d == NULL) { 12345 fprintf(stderr, "vdevs obj not found.\n"); 12346 exit(1); 12347 } 12348 props = fnvlist_alloc(); 12349 } 12350 12351 for (zprop_list_t *pl = cbp->cb_proplist; pl != NULL; 12352 pl = pl->pl_next) { 12353 char *prop_name; 12354 /* 12355 * If the first property is pool name, it is a special 12356 * placeholder that we can skip. This will also skip 12357 * over the name property when 'all' is specified. 12358 */ 12359 if (pl->pl_prop == ZPOOL_PROP_NAME && 12360 pl == cbp->cb_proplist) 12361 continue; 12362 12363 if (pl->pl_prop == ZPROP_INVAL) { 12364 prop_name = pl->pl_user_prop; 12365 } else { 12366 prop_name = (char *)vdev_prop_to_name(pl->pl_prop); 12367 } 12368 if (zpool_get_vdev_prop(zhp, vdevname, pl->pl_prop, 12369 prop_name, value, sizeof (value), &srctype, 12370 cbp->cb_literal) == 0) { 12371 zprop_collect_property(vdevname, cbp, prop_name, 12372 value, srctype, NULL, NULL, props); 12373 } 12374 } 12375 12376 if (cbp->cb_json) { 12377 if (!nvlist_empty(props)) { 12378 item = fnvlist_alloc(); 12379 fill_vdev_info(item, zhp, vdevname, B_TRUE, 12380 cbp->cb_json_as_int); 12381 fnvlist_add_nvlist(item, "properties", props); 12382 fnvlist_add_nvlist(d, vdevname, item); 12383 fnvlist_add_nvlist(cbp->cb_jsobj, "vdevs", d); 12384 fnvlist_free(item); 12385 } 12386 fnvlist_free(props); 12387 } 12388 12389 return (0); 12390 } 12391 12392 static int 12393 get_callback_vdev_cb(void *zhp_data, nvlist_t *nv, void *data) 12394 { 12395 zpool_handle_t *zhp = zhp_data; 12396 zprop_get_cbdata_t *cbp = (zprop_get_cbdata_t *)data; 12397 char *vdevname; 12398 const char *type; 12399 int ret; 12400 12401 /* 12402 * zpool_vdev_name() transforms the root vdev name (i.e., root-0) to the 12403 * pool name for display purposes, which is not desired. Fallback to 12404 * zpool_vdev_name() when not dealing with the root vdev. 12405 */ 12406 type = fnvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE); 12407 if (zhp != NULL && strcmp(type, "root") == 0) 12408 vdevname = strdup("root-0"); 12409 else 12410 vdevname = zpool_vdev_name(g_zfs, zhp, nv, 12411 cbp->cb_vdevs.cb_name_flags); 12412 12413 (void) vdev_expand_proplist(zhp, vdevname, &cbp->cb_proplist); 12414 12415 ret = get_callback_vdev(zhp, vdevname, data); 12416 12417 free(vdevname); 12418 12419 return (ret); 12420 } 12421 12422 static int 12423 get_callback(zpool_handle_t *zhp, void *data) 12424 { 12425 zprop_get_cbdata_t *cbp = (zprop_get_cbdata_t *)data; 12426 char value[ZFS_MAXPROPLEN]; 12427 zprop_source_t srctype; 12428 zprop_list_t *pl; 12429 int vid; 12430 int err = 0; 12431 nvlist_t *props, *item, *d; 12432 props = item = d = NULL; 12433 12434 if (cbp->cb_type == ZFS_TYPE_VDEV) { 12435 if (cbp->cb_json) { 12436 nvlist_t *pool = fnvlist_alloc(); 12437 fill_pool_info(pool, zhp, B_FALSE, cbp->cb_json_as_int); 12438 fnvlist_add_nvlist(cbp->cb_jsobj, "pool", pool); 12439 fnvlist_free(pool); 12440 } 12441 12442 if (strcmp(cbp->cb_vdevs.cb_names[0], "all-vdevs") == 0) { 12443 for_each_vdev(zhp, get_callback_vdev_cb, data); 12444 } else { 12445 /* Adjust column widths for vdev properties */ 12446 for (vid = 0; vid < cbp->cb_vdevs.cb_names_count; 12447 vid++) { 12448 vdev_expand_proplist(zhp, 12449 cbp->cb_vdevs.cb_names[vid], 12450 &cbp->cb_proplist); 12451 } 12452 /* Display the properties */ 12453 for (vid = 0; vid < cbp->cb_vdevs.cb_names_count; 12454 vid++) { 12455 get_callback_vdev(zhp, 12456 cbp->cb_vdevs.cb_names[vid], data); 12457 } 12458 } 12459 } else { 12460 assert(cbp->cb_type == ZFS_TYPE_POOL); 12461 if (cbp->cb_json) { 12462 d = fnvlist_lookup_nvlist(cbp->cb_jsobj, "pools"); 12463 if (d == NULL) { 12464 fprintf(stderr, "pools obj not found.\n"); 12465 exit(1); 12466 } 12467 props = fnvlist_alloc(); 12468 } 12469 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) { 12470 /* 12471 * Skip the special fake placeholder. This will also 12472 * skip over the name property when 'all' is specified. 12473 */ 12474 if (pl->pl_prop == ZPOOL_PROP_NAME && 12475 pl == cbp->cb_proplist) 12476 continue; 12477 12478 if (pl->pl_prop == ZPROP_INVAL && 12479 zfs_prop_user(pl->pl_user_prop)) { 12480 srctype = ZPROP_SRC_LOCAL; 12481 12482 if (zpool_get_userprop(zhp, pl->pl_user_prop, 12483 value, sizeof (value), &srctype) != 0) 12484 continue; 12485 12486 err = zprop_collect_property( 12487 zpool_get_name(zhp), cbp, pl->pl_user_prop, 12488 value, srctype, NULL, NULL, props); 12489 } else if (pl->pl_prop == ZPROP_INVAL && 12490 (zpool_prop_feature(pl->pl_user_prop) || 12491 zpool_prop_unsupported(pl->pl_user_prop))) { 12492 srctype = ZPROP_SRC_LOCAL; 12493 12494 if (zpool_prop_get_feature(zhp, 12495 pl->pl_user_prop, value, 12496 sizeof (value)) == 0) { 12497 err = zprop_collect_property( 12498 zpool_get_name(zhp), cbp, 12499 pl->pl_user_prop, value, srctype, 12500 NULL, NULL, props); 12501 } 12502 } else { 12503 if (zpool_get_prop(zhp, pl->pl_prop, value, 12504 sizeof (value), &srctype, 12505 cbp->cb_literal) != 0) 12506 continue; 12507 12508 err = zprop_collect_property( 12509 zpool_get_name(zhp), cbp, 12510 zpool_prop_to_name(pl->pl_prop), 12511 value, srctype, NULL, NULL, props); 12512 } 12513 if (err != 0) 12514 return (err); 12515 } 12516 12517 if (cbp->cb_json) { 12518 if (!nvlist_empty(props)) { 12519 item = fnvlist_alloc(); 12520 fill_pool_info(item, zhp, B_TRUE, 12521 cbp->cb_json_as_int); 12522 fnvlist_add_nvlist(item, "properties", props); 12523 if (cbp->cb_json_pool_key_guid) { 12524 char buf[256]; 12525 uint64_t guid = fnvlist_lookup_uint64( 12526 zpool_get_config(zhp, NULL), 12527 ZPOOL_CONFIG_POOL_GUID); 12528 snprintf(buf, 256, "%llu", 12529 (u_longlong_t)guid); 12530 fnvlist_add_nvlist(d, buf, item); 12531 } else { 12532 const char *name = zpool_get_name(zhp); 12533 fnvlist_add_nvlist(d, name, item); 12534 } 12535 fnvlist_add_nvlist(cbp->cb_jsobj, "pools", d); 12536 fnvlist_free(item); 12537 } 12538 fnvlist_free(props); 12539 } 12540 } 12541 12542 return (0); 12543 } 12544 12545 /* 12546 * zpool get [-Hp] [-o "all" | field[,...]] <"all" | property[,...]> <pool> ... 12547 * 12548 * -H Scripted mode. Don't display headers, and separate properties 12549 * by a single tab. 12550 * -o List of columns to display. Defaults to 12551 * "name,property,value,source". 12552 * -p Display values in parsable (exact) format. 12553 * -j Display output in JSON format. 12554 * --json-int Display numbers as integers instead of strings. 12555 * --json-pool-key-guid Set pool GUID as key for pool objects. 12556 * 12557 * Get properties of pools in the system. Output space statistics 12558 * for each one as well as other attributes. 12559 */ 12560 int 12561 zpool_do_get(int argc, char **argv) 12562 { 12563 zprop_get_cbdata_t cb = { 0 }; 12564 zprop_list_t fake_name = { 0 }; 12565 int ret; 12566 int c, i; 12567 char *propstr = NULL; 12568 char *vdev = NULL; 12569 nvlist_t *data = NULL; 12570 12571 cb.cb_first = B_TRUE; 12572 12573 /* 12574 * Set up default columns and sources. 12575 */ 12576 cb.cb_sources = ZPROP_SRC_ALL; 12577 cb.cb_columns[0] = GET_COL_NAME; 12578 cb.cb_columns[1] = GET_COL_PROPERTY; 12579 cb.cb_columns[2] = GET_COL_VALUE; 12580 cb.cb_columns[3] = GET_COL_SOURCE; 12581 cb.cb_type = ZFS_TYPE_POOL; 12582 cb.cb_vdevs.cb_name_flags |= VDEV_NAME_TYPE_ID; 12583 current_prop_type = cb.cb_type; 12584 12585 struct option long_options[] = { 12586 {"json-int", no_argument, NULL, ZPOOL_OPTION_JSON_NUMS_AS_INT}, 12587 {"json-pool-key-guid", no_argument, NULL, 12588 ZPOOL_OPTION_POOL_KEY_GUID}, 12589 {0, 0, 0, 0} 12590 }; 12591 12592 /* check options */ 12593 while ((c = getopt_long(argc, argv, ":jHpo:", long_options, 12594 NULL)) != -1) { 12595 switch (c) { 12596 case 'p': 12597 cb.cb_literal = B_TRUE; 12598 break; 12599 case 'H': 12600 cb.cb_scripted = B_TRUE; 12601 break; 12602 case 'j': 12603 cb.cb_json = B_TRUE; 12604 cb.cb_jsobj = zpool_json_schema(0, 1); 12605 data = fnvlist_alloc(); 12606 break; 12607 case ZPOOL_OPTION_POOL_KEY_GUID: 12608 cb.cb_json_pool_key_guid = B_TRUE; 12609 break; 12610 case ZPOOL_OPTION_JSON_NUMS_AS_INT: 12611 cb.cb_json_as_int = B_TRUE; 12612 cb.cb_literal = B_TRUE; 12613 break; 12614 case 'o': 12615 memset(&cb.cb_columns, 0, sizeof (cb.cb_columns)); 12616 i = 0; 12617 12618 for (char *tok; (tok = strsep(&optarg, ",")); ) { 12619 static const char *const col_opts[] = 12620 { "name", "property", "value", "source", 12621 "all" }; 12622 static const zfs_get_column_t col_cols[] = 12623 { GET_COL_NAME, GET_COL_PROPERTY, GET_COL_VALUE, 12624 GET_COL_SOURCE }; 12625 12626 if (i == ZFS_GET_NCOLS - 1) { 12627 (void) fprintf(stderr, gettext("too " 12628 "many fields given to -o " 12629 "option\n")); 12630 usage(B_FALSE); 12631 } 12632 12633 for (c = 0; c < ARRAY_SIZE(col_opts); ++c) 12634 if (strcmp(tok, col_opts[c]) == 0) 12635 goto found; 12636 12637 (void) fprintf(stderr, 12638 gettext("invalid column name '%s'\n"), tok); 12639 usage(B_FALSE); 12640 12641 found: 12642 if (c >= 4) { 12643 if (i > 0) { 12644 (void) fprintf(stderr, 12645 gettext("\"all\" conflicts " 12646 "with specific fields " 12647 "given to -o option\n")); 12648 usage(B_FALSE); 12649 } 12650 12651 memcpy(cb.cb_columns, col_cols, 12652 sizeof (col_cols)); 12653 i = ZFS_GET_NCOLS - 1; 12654 } else 12655 cb.cb_columns[i++] = col_cols[c]; 12656 } 12657 break; 12658 case '?': 12659 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 12660 optopt); 12661 usage(B_FALSE); 12662 } 12663 } 12664 12665 argc -= optind; 12666 argv += optind; 12667 12668 if (!cb.cb_json && cb.cb_json_as_int) { 12669 (void) fprintf(stderr, gettext("'--json-int' only works with" 12670 " '-j' option\n")); 12671 usage(B_FALSE); 12672 } 12673 12674 if (!cb.cb_json && cb.cb_json_pool_key_guid) { 12675 (void) fprintf(stderr, gettext("'json-pool-key-guid' only" 12676 " works with '-j' option\n")); 12677 usage(B_FALSE); 12678 } 12679 12680 if (argc < 1) { 12681 (void) fprintf(stderr, gettext("missing property " 12682 "argument\n")); 12683 usage(B_FALSE); 12684 } 12685 12686 /* Properties list is needed later by zprop_get_list() */ 12687 propstr = argv[0]; 12688 12689 argc--; 12690 argv++; 12691 12692 if (argc == 0) { 12693 /* No args, so just print the defaults. */ 12694 } else if (are_all_pools(argc, argv)) { 12695 /* All the args are pool names */ 12696 } else if (are_all_pools(1, argv)) { 12697 /* The first arg is a pool name */ 12698 if ((argc == 2 && strcmp(argv[1], "all-vdevs") == 0) || 12699 (argc == 2 && strcmp(argv[1], "root") == 0) || 12700 are_vdevs_in_pool(argc - 1, argv + 1, argv[0], 12701 &cb.cb_vdevs)) { 12702 12703 if (strcmp(argv[1], "root") == 0) 12704 vdev = strdup("root-0"); 12705 else 12706 vdev = strdup(argv[1]); 12707 12708 /* ... and the rest are vdev names */ 12709 cb.cb_vdevs.cb_names = &vdev; 12710 cb.cb_vdevs.cb_names_count = argc - 1; 12711 cb.cb_type = ZFS_TYPE_VDEV; 12712 argc = 1; /* One pool to process */ 12713 } else { 12714 if (cb.cb_json) { 12715 nvlist_free(cb.cb_jsobj); 12716 nvlist_free(data); 12717 } 12718 fprintf(stderr, gettext("Expected a list of vdevs in" 12719 " \"%s\", but got:\n"), argv[0]); 12720 error_list_unresolved_vdevs(argc - 1, argv + 1, 12721 argv[0], &cb.cb_vdevs); 12722 fprintf(stderr, "\n"); 12723 usage(B_FALSE); 12724 return (1); 12725 } 12726 } else { 12727 if (cb.cb_json) { 12728 nvlist_free(cb.cb_jsobj); 12729 nvlist_free(data); 12730 } 12731 /* 12732 * The first arg isn't the name of a valid pool. 12733 */ 12734 fprintf(stderr, gettext("Cannot get properties of %s: " 12735 "no such pool available.\n"), argv[0]); 12736 return (1); 12737 } 12738 12739 if (zprop_get_list(g_zfs, propstr, &cb.cb_proplist, 12740 cb.cb_type) != 0) { 12741 /* Use correct list of valid properties (pool or vdev) */ 12742 current_prop_type = cb.cb_type; 12743 usage(B_FALSE); 12744 } 12745 12746 if (cb.cb_proplist != NULL) { 12747 fake_name.pl_prop = ZPOOL_PROP_NAME; 12748 fake_name.pl_width = strlen(gettext("NAME")); 12749 fake_name.pl_next = cb.cb_proplist; 12750 cb.cb_proplist = &fake_name; 12751 } 12752 12753 if (cb.cb_json) { 12754 if (cb.cb_type == ZFS_TYPE_VDEV) 12755 fnvlist_add_nvlist(cb.cb_jsobj, "vdevs", data); 12756 else 12757 fnvlist_add_nvlist(cb.cb_jsobj, "pools", data); 12758 fnvlist_free(data); 12759 } 12760 12761 ret = for_each_pool(argc, argv, B_TRUE, &cb.cb_proplist, cb.cb_type, 12762 cb.cb_literal, get_callback, &cb); 12763 12764 if (ret == 0 && cb.cb_json) 12765 zcmd_print_json(cb.cb_jsobj); 12766 else if (ret != 0 && cb.cb_json) 12767 nvlist_free(cb.cb_jsobj); 12768 12769 if (cb.cb_proplist == &fake_name) 12770 zprop_free_list(fake_name.pl_next); 12771 else 12772 zprop_free_list(cb.cb_proplist); 12773 12774 if (vdev != NULL) 12775 free(vdev); 12776 12777 return (ret); 12778 } 12779 12780 typedef struct set_cbdata { 12781 char *cb_propname; 12782 char *cb_value; 12783 zfs_type_t cb_type; 12784 vdev_cbdata_t cb_vdevs; 12785 boolean_t cb_any_successful; 12786 } set_cbdata_t; 12787 12788 static int 12789 set_pool_callback(zpool_handle_t *zhp, set_cbdata_t *cb) 12790 { 12791 int error; 12792 12793 /* Check if we have out-of-bounds features */ 12794 if (strcmp(cb->cb_propname, ZPOOL_CONFIG_COMPATIBILITY) == 0) { 12795 boolean_t features[SPA_FEATURES]; 12796 if (zpool_do_load_compat(cb->cb_value, features) != 12797 ZPOOL_COMPATIBILITY_OK) 12798 return (-1); 12799 12800 nvlist_t *enabled = zpool_get_features(zhp); 12801 spa_feature_t i; 12802 for (i = 0; i < SPA_FEATURES; i++) { 12803 const char *fguid = spa_feature_table[i].fi_guid; 12804 if (nvlist_exists(enabled, fguid) && !features[i]) 12805 break; 12806 } 12807 if (i < SPA_FEATURES) 12808 (void) fprintf(stderr, gettext("Warning: one or " 12809 "more features already enabled on pool '%s'\n" 12810 "are not present in this compatibility set.\n"), 12811 zpool_get_name(zhp)); 12812 } 12813 12814 /* if we're setting a feature, check it's in compatibility set */ 12815 if (zpool_prop_feature(cb->cb_propname) && 12816 strcmp(cb->cb_value, ZFS_FEATURE_ENABLED) == 0) { 12817 char *fname = strchr(cb->cb_propname, '@') + 1; 12818 spa_feature_t f; 12819 12820 if (zfeature_lookup_name(fname, &f) == 0) { 12821 char compat[ZFS_MAXPROPLEN]; 12822 if (zpool_get_prop(zhp, ZPOOL_PROP_COMPATIBILITY, 12823 compat, ZFS_MAXPROPLEN, NULL, B_FALSE) != 0) 12824 compat[0] = '\0'; 12825 12826 boolean_t features[SPA_FEATURES]; 12827 if (zpool_do_load_compat(compat, features) != 12828 ZPOOL_COMPATIBILITY_OK) { 12829 (void) fprintf(stderr, gettext("Error: " 12830 "cannot enable feature '%s' on pool '%s'\n" 12831 "because the pool's 'compatibility' " 12832 "property cannot be parsed.\n"), 12833 fname, zpool_get_name(zhp)); 12834 return (-1); 12835 } 12836 12837 if (!features[f]) { 12838 (void) fprintf(stderr, gettext("Error: " 12839 "cannot enable feature '%s' on pool '%s'\n" 12840 "as it is not specified in this pool's " 12841 "current compatibility set.\n" 12842 "Consider setting 'compatibility' to a " 12843 "less restrictive set, or to 'off'.\n"), 12844 fname, zpool_get_name(zhp)); 12845 return (-1); 12846 } 12847 } 12848 } 12849 12850 error = zpool_set_prop(zhp, cb->cb_propname, cb->cb_value); 12851 12852 return (error); 12853 } 12854 12855 static int 12856 set_callback(zpool_handle_t *zhp, void *data) 12857 { 12858 int error; 12859 set_cbdata_t *cb = (set_cbdata_t *)data; 12860 12861 if (cb->cb_type == ZFS_TYPE_VDEV) { 12862 error = zpool_set_vdev_prop(zhp, *cb->cb_vdevs.cb_names, 12863 cb->cb_propname, cb->cb_value); 12864 } else { 12865 assert(cb->cb_type == ZFS_TYPE_POOL); 12866 error = set_pool_callback(zhp, cb); 12867 } 12868 12869 cb->cb_any_successful = !error; 12870 return (error); 12871 } 12872 12873 int 12874 zpool_do_set(int argc, char **argv) 12875 { 12876 set_cbdata_t cb = { 0 }; 12877 int error; 12878 char *vdev = NULL; 12879 12880 current_prop_type = ZFS_TYPE_POOL; 12881 if (argc > 1 && argv[1][0] == '-') { 12882 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 12883 argv[1][1]); 12884 usage(B_FALSE); 12885 } 12886 12887 if (argc < 2) { 12888 (void) fprintf(stderr, gettext("missing property=value " 12889 "argument\n")); 12890 usage(B_FALSE); 12891 } 12892 12893 if (argc < 3) { 12894 (void) fprintf(stderr, gettext("missing pool name\n")); 12895 usage(B_FALSE); 12896 } 12897 12898 if (argc > 4) { 12899 (void) fprintf(stderr, gettext("too many pool names\n")); 12900 usage(B_FALSE); 12901 } 12902 12903 cb.cb_propname = argv[1]; 12904 cb.cb_type = ZFS_TYPE_POOL; 12905 cb.cb_vdevs.cb_name_flags |= VDEV_NAME_TYPE_ID; 12906 cb.cb_value = strchr(cb.cb_propname, '='); 12907 if (cb.cb_value == NULL) { 12908 (void) fprintf(stderr, gettext("missing value in " 12909 "property=value argument\n")); 12910 usage(B_FALSE); 12911 } 12912 12913 *(cb.cb_value) = '\0'; 12914 cb.cb_value++; 12915 argc -= 2; 12916 argv += 2; 12917 12918 /* argv[0] is pool name */ 12919 if (!is_pool(argv[0])) { 12920 (void) fprintf(stderr, 12921 gettext("cannot open '%s': is not a pool\n"), argv[0]); 12922 return (EINVAL); 12923 } 12924 12925 /* argv[1], when supplied, is vdev name */ 12926 if (argc == 2) { 12927 12928 if (strcmp(argv[1], "root") == 0) 12929 vdev = strdup("root-0"); 12930 else 12931 vdev = strdup(argv[1]); 12932 12933 if (!are_vdevs_in_pool(1, &vdev, argv[0], &cb.cb_vdevs)) { 12934 (void) fprintf(stderr, gettext( 12935 "cannot find '%s' in '%s': device not in pool\n"), 12936 vdev, argv[0]); 12937 free(vdev); 12938 return (EINVAL); 12939 } 12940 cb.cb_vdevs.cb_names = &vdev; 12941 cb.cb_vdevs.cb_names_count = 1; 12942 cb.cb_type = ZFS_TYPE_VDEV; 12943 } 12944 12945 error = for_each_pool(1, argv, B_TRUE, NULL, ZFS_TYPE_POOL, 12946 B_FALSE, set_callback, &cb); 12947 12948 if (vdev != NULL) 12949 free(vdev); 12950 12951 return (error); 12952 } 12953 12954 /* Add up the total number of bytes left to initialize/trim across all vdevs */ 12955 static uint64_t 12956 vdev_activity_remaining(nvlist_t *nv, zpool_wait_activity_t activity) 12957 { 12958 uint64_t bytes_remaining; 12959 nvlist_t **child; 12960 uint_t c, children; 12961 vdev_stat_t *vs; 12962 12963 assert(activity == ZPOOL_WAIT_INITIALIZE || 12964 activity == ZPOOL_WAIT_TRIM); 12965 12966 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS, 12967 (uint64_t **)&vs, &c) == 0); 12968 12969 if (activity == ZPOOL_WAIT_INITIALIZE && 12970 vs->vs_initialize_state == VDEV_INITIALIZE_ACTIVE) 12971 bytes_remaining = vs->vs_initialize_bytes_est - 12972 vs->vs_initialize_bytes_done; 12973 else if (activity == ZPOOL_WAIT_TRIM && 12974 vs->vs_trim_state == VDEV_TRIM_ACTIVE) 12975 bytes_remaining = vs->vs_trim_bytes_est - 12976 vs->vs_trim_bytes_done; 12977 else 12978 bytes_remaining = 0; 12979 12980 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, 12981 &child, &children) != 0) 12982 children = 0; 12983 12984 for (c = 0; c < children; c++) 12985 bytes_remaining += vdev_activity_remaining(child[c], activity); 12986 12987 return (bytes_remaining); 12988 } 12989 12990 /* Add up the total number of bytes left to rebuild across top-level vdevs */ 12991 static uint64_t 12992 vdev_activity_top_remaining(nvlist_t *nv) 12993 { 12994 uint64_t bytes_remaining = 0; 12995 nvlist_t **child; 12996 uint_t children; 12997 int error; 12998 12999 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, 13000 &child, &children) != 0) 13001 children = 0; 13002 13003 for (uint_t c = 0; c < children; c++) { 13004 vdev_rebuild_stat_t *vrs; 13005 uint_t i; 13006 13007 error = nvlist_lookup_uint64_array(child[c], 13008 ZPOOL_CONFIG_REBUILD_STATS, (uint64_t **)&vrs, &i); 13009 if (error == 0) { 13010 if (vrs->vrs_state == VDEV_REBUILD_ACTIVE) { 13011 bytes_remaining += (vrs->vrs_bytes_est - 13012 vrs->vrs_bytes_rebuilt); 13013 } 13014 } 13015 } 13016 13017 return (bytes_remaining); 13018 } 13019 13020 /* Whether any vdevs are 'spare' or 'replacing' vdevs */ 13021 static boolean_t 13022 vdev_any_spare_replacing(nvlist_t *nv) 13023 { 13024 nvlist_t **child; 13025 uint_t c, children; 13026 const char *vdev_type; 13027 13028 (void) nvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE, &vdev_type); 13029 13030 if (strcmp(vdev_type, VDEV_TYPE_REPLACING) == 0 || 13031 strcmp(vdev_type, VDEV_TYPE_SPARE) == 0 || 13032 strcmp(vdev_type, VDEV_TYPE_DRAID_SPARE) == 0) { 13033 return (B_TRUE); 13034 } 13035 13036 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, 13037 &child, &children) != 0) 13038 children = 0; 13039 13040 for (c = 0; c < children; c++) { 13041 if (vdev_any_spare_replacing(child[c])) 13042 return (B_TRUE); 13043 } 13044 13045 return (B_FALSE); 13046 } 13047 13048 typedef struct wait_data { 13049 char *wd_poolname; 13050 boolean_t wd_scripted; 13051 boolean_t wd_exact; 13052 boolean_t wd_headers_once; 13053 boolean_t wd_should_exit; 13054 /* Which activities to wait for */ 13055 boolean_t wd_enabled[ZPOOL_WAIT_NUM_ACTIVITIES]; 13056 float wd_interval; 13057 pthread_cond_t wd_cv; 13058 pthread_mutex_t wd_mutex; 13059 } wait_data_t; 13060 13061 /* 13062 * Print to stdout a single line, containing one column for each activity that 13063 * we are waiting for specifying how many bytes of work are left for that 13064 * activity. 13065 */ 13066 static void 13067 print_wait_status_row(wait_data_t *wd, zpool_handle_t *zhp, int row) 13068 { 13069 nvlist_t *config, *nvroot; 13070 uint_t c; 13071 int i; 13072 pool_checkpoint_stat_t *pcs = NULL; 13073 pool_scan_stat_t *pss = NULL; 13074 pool_removal_stat_t *prs = NULL; 13075 pool_raidz_expand_stat_t *pres = NULL; 13076 const char *const headers[] = {"DISCARD", "FREE", "INITIALIZE", 13077 "REPLACE", "REMOVE", "RESILVER", "SCRUB", "TRIM", "RAIDZ_EXPAND"}; 13078 int col_widths[ZPOOL_WAIT_NUM_ACTIVITIES]; 13079 13080 /* Calculate the width of each column */ 13081 for (i = 0; i < ZPOOL_WAIT_NUM_ACTIVITIES; i++) { 13082 /* 13083 * Make sure we have enough space in the col for pretty-printed 13084 * numbers and for the column header, and then leave a couple 13085 * spaces between cols for readability. 13086 */ 13087 col_widths[i] = MAX(strlen(headers[i]), 6) + 2; 13088 } 13089 13090 if (timestamp_fmt != NODATE) 13091 print_timestamp(timestamp_fmt); 13092 13093 /* Print header if appropriate */ 13094 int term_height = terminal_height(); 13095 boolean_t reprint_header = (!wd->wd_headers_once && term_height > 0 && 13096 row % (term_height-1) == 0); 13097 if (!wd->wd_scripted && (row == 0 || reprint_header)) { 13098 for (i = 0; i < ZPOOL_WAIT_NUM_ACTIVITIES; i++) { 13099 if (wd->wd_enabled[i]) 13100 (void) printf("%*s", col_widths[i], headers[i]); 13101 } 13102 (void) fputc('\n', stdout); 13103 } 13104 13105 /* Bytes of work remaining in each activity */ 13106 int64_t bytes_rem[ZPOOL_WAIT_NUM_ACTIVITIES] = {0}; 13107 13108 bytes_rem[ZPOOL_WAIT_FREE] = 13109 zpool_get_prop_int(zhp, ZPOOL_PROP_FREEING, NULL); 13110 13111 config = zpool_get_config(zhp, NULL); 13112 nvroot = fnvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE); 13113 13114 (void) nvlist_lookup_uint64_array(nvroot, 13115 ZPOOL_CONFIG_CHECKPOINT_STATS, (uint64_t **)&pcs, &c); 13116 if (pcs != NULL && pcs->pcs_state == CS_CHECKPOINT_DISCARDING) 13117 bytes_rem[ZPOOL_WAIT_CKPT_DISCARD] = pcs->pcs_space; 13118 13119 (void) nvlist_lookup_uint64_array(nvroot, 13120 ZPOOL_CONFIG_REMOVAL_STATS, (uint64_t **)&prs, &c); 13121 if (prs != NULL && prs->prs_state == DSS_SCANNING) 13122 bytes_rem[ZPOOL_WAIT_REMOVE] = prs->prs_to_copy - 13123 prs->prs_copied; 13124 13125 (void) nvlist_lookup_uint64_array(nvroot, 13126 ZPOOL_CONFIG_SCAN_STATS, (uint64_t **)&pss, &c); 13127 if (pss != NULL && pss->pss_state == DSS_SCANNING && 13128 pss->pss_pass_scrub_pause == 0) { 13129 int64_t rem = pss->pss_to_examine - pss->pss_issued; 13130 if (pss->pss_func == POOL_SCAN_SCRUB) 13131 bytes_rem[ZPOOL_WAIT_SCRUB] = rem; 13132 else 13133 bytes_rem[ZPOOL_WAIT_RESILVER] = rem; 13134 } else if (check_rebuilding(nvroot, NULL)) { 13135 bytes_rem[ZPOOL_WAIT_RESILVER] = 13136 vdev_activity_top_remaining(nvroot); 13137 } 13138 13139 (void) nvlist_lookup_uint64_array(nvroot, 13140 ZPOOL_CONFIG_RAIDZ_EXPAND_STATS, (uint64_t **)&pres, &c); 13141 if (pres != NULL && pres->pres_state == DSS_SCANNING) { 13142 int64_t rem = pres->pres_to_reflow - pres->pres_reflowed; 13143 bytes_rem[ZPOOL_WAIT_RAIDZ_EXPAND] = rem; 13144 } 13145 13146 bytes_rem[ZPOOL_WAIT_INITIALIZE] = 13147 vdev_activity_remaining(nvroot, ZPOOL_WAIT_INITIALIZE); 13148 bytes_rem[ZPOOL_WAIT_TRIM] = 13149 vdev_activity_remaining(nvroot, ZPOOL_WAIT_TRIM); 13150 13151 /* 13152 * A replace finishes after resilvering finishes, so the amount of work 13153 * left for a replace is the same as for resilvering. 13154 * 13155 * It isn't quite correct to say that if we have any 'spare' or 13156 * 'replacing' vdevs and a resilver is happening, then a replace is in 13157 * progress, like we do here. When a hot spare is used, the faulted vdev 13158 * is not removed after the hot spare is resilvered, so parent 'spare' 13159 * vdev is not removed either. So we could have a 'spare' vdev, but be 13160 * resilvering for a different reason. However, we use it as a heuristic 13161 * because we don't have access to the DTLs, which could tell us whether 13162 * or not we have really finished resilvering a hot spare. 13163 */ 13164 if (vdev_any_spare_replacing(nvroot)) 13165 bytes_rem[ZPOOL_WAIT_REPLACE] = bytes_rem[ZPOOL_WAIT_RESILVER]; 13166 13167 for (i = 0; i < ZPOOL_WAIT_NUM_ACTIVITIES; i++) { 13168 char buf[64]; 13169 if (!wd->wd_enabled[i]) 13170 continue; 13171 13172 if (wd->wd_exact) { 13173 (void) snprintf(buf, sizeof (buf), "%" PRIi64, 13174 bytes_rem[i]); 13175 } else { 13176 zfs_nicenum(bytes_rem[i], buf, sizeof (buf)); 13177 } 13178 13179 if (wd->wd_scripted) 13180 (void) printf(i == 0 ? "%s" : "\t%s", buf); 13181 else 13182 (void) printf(" %*s", col_widths[i] - 1, buf); 13183 } 13184 (void) printf("\n"); 13185 (void) fflush(stdout); 13186 } 13187 13188 static void * 13189 wait_status_thread(void *arg) 13190 { 13191 wait_data_t *wd = (wait_data_t *)arg; 13192 zpool_handle_t *zhp; 13193 13194 if ((zhp = zpool_open(g_zfs, wd->wd_poolname)) == NULL) 13195 return (void *)(1); 13196 13197 for (int row = 0; ; row++) { 13198 boolean_t missing; 13199 struct timespec timeout; 13200 int ret = 0; 13201 (void) clock_gettime(CLOCK_REALTIME, &timeout); 13202 13203 if (zpool_refresh_stats(zhp, &missing) != 0 || missing || 13204 zpool_props_refresh(zhp) != 0) { 13205 zpool_close(zhp); 13206 return (void *)(uintptr_t)(missing ? 0 : 1); 13207 } 13208 13209 print_wait_status_row(wd, zhp, row); 13210 13211 timeout.tv_sec += floor(wd->wd_interval); 13212 long nanos = timeout.tv_nsec + 13213 (wd->wd_interval - floor(wd->wd_interval)) * NANOSEC; 13214 if (nanos >= NANOSEC) { 13215 timeout.tv_sec++; 13216 timeout.tv_nsec = nanos - NANOSEC; 13217 } else { 13218 timeout.tv_nsec = nanos; 13219 } 13220 pthread_mutex_lock(&wd->wd_mutex); 13221 if (!wd->wd_should_exit) 13222 ret = pthread_cond_timedwait(&wd->wd_cv, &wd->wd_mutex, 13223 &timeout); 13224 pthread_mutex_unlock(&wd->wd_mutex); 13225 if (ret == 0) { 13226 break; /* signaled by main thread */ 13227 } else if (ret != ETIMEDOUT) { 13228 (void) fprintf(stderr, gettext("pthread_cond_timedwait " 13229 "failed: %s\n"), strerror(ret)); 13230 zpool_close(zhp); 13231 return (void *)(uintptr_t)(1); 13232 } 13233 } 13234 13235 zpool_close(zhp); 13236 return (void *)(0); 13237 } 13238 13239 int 13240 zpool_do_wait(int argc, char **argv) 13241 { 13242 boolean_t verbose = B_FALSE; 13243 int c, i; 13244 unsigned long count; 13245 pthread_t status_thr; 13246 int error = 0; 13247 zpool_handle_t *zhp; 13248 13249 wait_data_t wd; 13250 wd.wd_scripted = B_FALSE; 13251 wd.wd_exact = B_FALSE; 13252 wd.wd_headers_once = B_FALSE; 13253 wd.wd_should_exit = B_FALSE; 13254 13255 pthread_mutex_init(&wd.wd_mutex, NULL); 13256 pthread_cond_init(&wd.wd_cv, NULL); 13257 13258 /* By default, wait for all types of activity. */ 13259 for (i = 0; i < ZPOOL_WAIT_NUM_ACTIVITIES; i++) 13260 wd.wd_enabled[i] = B_TRUE; 13261 13262 while ((c = getopt(argc, argv, "HpT:t:")) != -1) { 13263 switch (c) { 13264 case 'H': 13265 wd.wd_scripted = B_TRUE; 13266 break; 13267 case 'n': 13268 wd.wd_headers_once = B_TRUE; 13269 break; 13270 case 'p': 13271 wd.wd_exact = B_TRUE; 13272 break; 13273 case 'T': 13274 get_timestamp_arg(*optarg); 13275 break; 13276 case 't': 13277 /* Reset activities array */ 13278 memset(&wd.wd_enabled, 0, sizeof (wd.wd_enabled)); 13279 13280 for (char *tok; (tok = strsep(&optarg, ",")); ) { 13281 static const char *const col_opts[] = { 13282 "discard", "free", "initialize", "replace", 13283 "remove", "resilver", "scrub", "trim", 13284 "raidz_expand" }; 13285 13286 for (i = 0; i < ARRAY_SIZE(col_opts); ++i) 13287 if (strcmp(tok, col_opts[i]) == 0) { 13288 wd.wd_enabled[i] = B_TRUE; 13289 goto found; 13290 } 13291 13292 (void) fprintf(stderr, 13293 gettext("invalid activity '%s'\n"), tok); 13294 usage(B_FALSE); 13295 found:; 13296 } 13297 break; 13298 case '?': 13299 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 13300 optopt); 13301 usage(B_FALSE); 13302 } 13303 } 13304 13305 argc -= optind; 13306 argv += optind; 13307 13308 get_interval_count(&argc, argv, &wd.wd_interval, &count); 13309 if (count != 0) { 13310 /* This subcmd only accepts an interval, not a count */ 13311 (void) fprintf(stderr, gettext("too many arguments\n")); 13312 usage(B_FALSE); 13313 } 13314 13315 if (wd.wd_interval != 0) 13316 verbose = B_TRUE; 13317 13318 if (argc < 1) { 13319 (void) fprintf(stderr, gettext("missing 'pool' argument\n")); 13320 usage(B_FALSE); 13321 } 13322 if (argc > 1) { 13323 (void) fprintf(stderr, gettext("too many arguments\n")); 13324 usage(B_FALSE); 13325 } 13326 13327 wd.wd_poolname = argv[0]; 13328 13329 if ((zhp = zpool_open(g_zfs, wd.wd_poolname)) == NULL) 13330 return (1); 13331 13332 if (verbose) { 13333 /* 13334 * We use a separate thread for printing status updates because 13335 * the main thread will call lzc_wait(), which blocks as long 13336 * as an activity is in progress, which can be a long time. 13337 */ 13338 if (pthread_create(&status_thr, NULL, wait_status_thread, &wd) 13339 != 0) { 13340 (void) fprintf(stderr, gettext("failed to create status" 13341 "thread: %s\n"), strerror(errno)); 13342 zpool_close(zhp); 13343 return (1); 13344 } 13345 } 13346 13347 /* 13348 * Loop over all activities that we are supposed to wait for until none 13349 * of them are in progress. Note that this means we can end up waiting 13350 * for more activities to complete than just those that were in progress 13351 * when we began waiting; if an activity we are interested in begins 13352 * while we are waiting for another activity, we will wait for both to 13353 * complete before exiting. 13354 */ 13355 for (;;) { 13356 boolean_t missing = B_FALSE; 13357 boolean_t any_waited = B_FALSE; 13358 13359 for (i = 0; i < ZPOOL_WAIT_NUM_ACTIVITIES; i++) { 13360 boolean_t waited; 13361 13362 if (!wd.wd_enabled[i]) 13363 continue; 13364 13365 error = zpool_wait_status(zhp, i, &missing, &waited); 13366 if (error != 0 || missing) 13367 break; 13368 13369 any_waited = (any_waited || waited); 13370 } 13371 13372 if (error != 0 || missing || !any_waited) 13373 break; 13374 } 13375 13376 zpool_close(zhp); 13377 13378 if (verbose) { 13379 uintptr_t status; 13380 pthread_mutex_lock(&wd.wd_mutex); 13381 wd.wd_should_exit = B_TRUE; 13382 pthread_cond_signal(&wd.wd_cv); 13383 pthread_mutex_unlock(&wd.wd_mutex); 13384 (void) pthread_join(status_thr, (void *)&status); 13385 if (status != 0) 13386 error = status; 13387 } 13388 13389 pthread_mutex_destroy(&wd.wd_mutex); 13390 pthread_cond_destroy(&wd.wd_cv); 13391 return (error); 13392 } 13393 13394 /* 13395 * zpool ddtprune -d|-p <amount> <pool> 13396 * 13397 * -d <days> Prune entries <days> old and older 13398 * -p <percent> Prune <percent> amount of entries 13399 * 13400 * Prune single reference entries from DDT to satisfy the amount specified. 13401 */ 13402 int 13403 zpool_do_ddt_prune(int argc, char **argv) 13404 { 13405 zpool_ddt_prune_unit_t unit = ZPOOL_DDT_PRUNE_NONE; 13406 uint64_t amount = 0; 13407 zpool_handle_t *zhp; 13408 char *endptr; 13409 int c; 13410 13411 while ((c = getopt(argc, argv, "d:p:")) != -1) { 13412 switch (c) { 13413 case 'd': 13414 if (unit == ZPOOL_DDT_PRUNE_PERCENTAGE) { 13415 (void) fprintf(stderr, gettext("-d cannot be " 13416 "combined with -p option\n")); 13417 usage(B_FALSE); 13418 } 13419 errno = 0; 13420 amount = strtoull(optarg, &endptr, 0); 13421 if (errno != 0 || *endptr != '\0' || amount == 0) { 13422 (void) fprintf(stderr, 13423 gettext("invalid days value\n")); 13424 usage(B_FALSE); 13425 } 13426 amount *= 86400; /* convert days to seconds */ 13427 unit = ZPOOL_DDT_PRUNE_AGE; 13428 break; 13429 case 'p': 13430 if (unit == ZPOOL_DDT_PRUNE_AGE) { 13431 (void) fprintf(stderr, gettext("-p cannot be " 13432 "combined with -d option\n")); 13433 usage(B_FALSE); 13434 } 13435 errno = 0; 13436 amount = strtoull(optarg, &endptr, 0); 13437 if (errno != 0 || *endptr != '\0' || 13438 amount == 0 || amount > 100) { 13439 (void) fprintf(stderr, 13440 gettext("invalid percentage value\n")); 13441 usage(B_FALSE); 13442 } 13443 unit = ZPOOL_DDT_PRUNE_PERCENTAGE; 13444 break; 13445 case '?': 13446 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 13447 optopt); 13448 usage(B_FALSE); 13449 } 13450 } 13451 argc -= optind; 13452 argv += optind; 13453 13454 if (unit == ZPOOL_DDT_PRUNE_NONE) { 13455 (void) fprintf(stderr, 13456 gettext("missing amount option (-d|-p <value>)\n")); 13457 usage(B_FALSE); 13458 } else if (argc < 1) { 13459 (void) fprintf(stderr, gettext("missing pool argument\n")); 13460 usage(B_FALSE); 13461 } else if (argc > 1) { 13462 (void) fprintf(stderr, gettext("too many arguments\n")); 13463 usage(B_FALSE); 13464 } 13465 zhp = zpool_open(g_zfs, argv[0]); 13466 if (zhp == NULL) 13467 return (-1); 13468 13469 int error = zpool_ddt_prune(zhp, unit, amount); 13470 13471 zpool_close(zhp); 13472 13473 return (error); 13474 } 13475 13476 static int 13477 find_command_idx(const char *command, int *idx) 13478 { 13479 for (int i = 0; i < NCOMMAND; ++i) { 13480 if (command_table[i].name == NULL) 13481 continue; 13482 13483 if (strcmp(command, command_table[i].name) == 0) { 13484 *idx = i; 13485 return (0); 13486 } 13487 } 13488 return (1); 13489 } 13490 13491 /* 13492 * Display version message 13493 */ 13494 static int 13495 zpool_do_version(int argc, char **argv) 13496 { 13497 int c; 13498 nvlist_t *jsobj = NULL, *zfs_ver = NULL; 13499 boolean_t json = B_FALSE; 13500 while ((c = getopt(argc, argv, "j")) != -1) { 13501 switch (c) { 13502 case 'j': 13503 json = B_TRUE; 13504 jsobj = zpool_json_schema(0, 1); 13505 break; 13506 case '?': 13507 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 13508 optopt); 13509 usage(B_FALSE); 13510 } 13511 } 13512 13513 argc -= optind; 13514 if (argc != 0) { 13515 (void) fprintf(stderr, "too many arguments\n"); 13516 usage(B_FALSE); 13517 } 13518 13519 if (json) { 13520 zfs_ver = zfs_version_nvlist(); 13521 if (zfs_ver) { 13522 fnvlist_add_nvlist(jsobj, "zfs_version", zfs_ver); 13523 zcmd_print_json(jsobj); 13524 fnvlist_free(zfs_ver); 13525 return (0); 13526 } else 13527 return (-1); 13528 } else 13529 return (zfs_version_print() != 0); 13530 } 13531 13532 /* Display documentation */ 13533 static int 13534 zpool_do_help(int argc, char **argv) 13535 { 13536 char page[MAXNAMELEN]; 13537 if (argc < 3 || strcmp(argv[2], "zpool") == 0) 13538 strcpy(page, "zpool"); 13539 else if (strcmp(argv[2], "concepts") == 0 || 13540 strcmp(argv[2], "props") == 0) 13541 snprintf(page, sizeof (page), "zpool%s", argv[2]); 13542 else 13543 snprintf(page, sizeof (page), "zpool-%s", argv[2]); 13544 13545 execlp("man", "man", page, NULL); 13546 13547 fprintf(stderr, "couldn't run man program: %s", strerror(errno)); 13548 return (-1); 13549 } 13550 13551 /* 13552 * Do zpool_load_compat() and print error message on failure 13553 */ 13554 static zpool_compat_status_t 13555 zpool_do_load_compat(const char *compat, boolean_t *list) 13556 { 13557 char report[1024]; 13558 13559 zpool_compat_status_t ret; 13560 13561 ret = zpool_load_compat(compat, list, report, 1024); 13562 switch (ret) { 13563 13564 case ZPOOL_COMPATIBILITY_OK: 13565 break; 13566 13567 case ZPOOL_COMPATIBILITY_NOFILES: 13568 case ZPOOL_COMPATIBILITY_BADFILE: 13569 case ZPOOL_COMPATIBILITY_BADTOKEN: 13570 (void) fprintf(stderr, "Error: %s\n", report); 13571 break; 13572 13573 case ZPOOL_COMPATIBILITY_WARNTOKEN: 13574 (void) fprintf(stderr, "Warning: %s\n", report); 13575 ret = ZPOOL_COMPATIBILITY_OK; 13576 break; 13577 } 13578 return (ret); 13579 } 13580 13581 int 13582 main(int argc, char **argv) 13583 { 13584 int ret = 0; 13585 int i = 0; 13586 char *cmdname; 13587 char **newargv; 13588 13589 (void) setlocale(LC_ALL, ""); 13590 (void) setlocale(LC_NUMERIC, "C"); 13591 (void) textdomain(TEXT_DOMAIN); 13592 srand(time(NULL)); 13593 13594 opterr = 0; 13595 13596 /* 13597 * Make sure the user has specified some command. 13598 */ 13599 if (argc < 2) { 13600 (void) fprintf(stderr, gettext("missing command\n")); 13601 usage(B_FALSE); 13602 } 13603 13604 cmdname = argv[1]; 13605 13606 /* 13607 * Special case '-?' 13608 */ 13609 if ((strcmp(cmdname, "-?") == 0) || strcmp(cmdname, "--help") == 0) 13610 usage(B_TRUE); 13611 13612 /* 13613 * Special case '-V|--version' 13614 */ 13615 if ((strcmp(cmdname, "-V") == 0) || (strcmp(cmdname, "--version") == 0)) 13616 return (zpool_do_version(argc, argv)); 13617 13618 /* 13619 * Special case 'help' 13620 */ 13621 if (strcmp(cmdname, "help") == 0) 13622 return (zpool_do_help(argc, argv)); 13623 13624 if ((g_zfs = libzfs_init()) == NULL) { 13625 (void) fprintf(stderr, "%s\n", libzfs_error_init(errno)); 13626 return (1); 13627 } 13628 13629 libzfs_print_on_error(g_zfs, B_TRUE); 13630 13631 zfs_save_arguments(argc, argv, history_str, sizeof (history_str)); 13632 13633 /* 13634 * Many commands modify input strings for string parsing reasons. 13635 * We create a copy to protect the original argv. 13636 */ 13637 newargv = safe_malloc((argc + 1) * sizeof (newargv[0])); 13638 for (i = 0; i < argc; i++) 13639 newargv[i] = strdup(argv[i]); 13640 newargv[argc] = NULL; 13641 13642 /* 13643 * Run the appropriate command. 13644 */ 13645 if (find_command_idx(cmdname, &i) == 0) { 13646 current_command = &command_table[i]; 13647 ret = command_table[i].func(argc - 1, newargv + 1); 13648 } else if (strchr(cmdname, '=')) { 13649 verify(find_command_idx("set", &i) == 0); 13650 current_command = &command_table[i]; 13651 ret = command_table[i].func(argc, newargv); 13652 } else if (strcmp(cmdname, "freeze") == 0 && argc == 3) { 13653 /* 13654 * 'freeze' is a vile debugging abomination, so we treat 13655 * it as such. 13656 */ 13657 zfs_cmd_t zc = {"\0"}; 13658 13659 (void) strlcpy(zc.zc_name, argv[2], sizeof (zc.zc_name)); 13660 ret = zfs_ioctl(g_zfs, ZFS_IOC_POOL_FREEZE, &zc); 13661 if (ret != 0) { 13662 (void) fprintf(stderr, 13663 gettext("failed to freeze pool: %d\n"), errno); 13664 ret = 1; 13665 } 13666 13667 log_history = 0; 13668 } else { 13669 (void) fprintf(stderr, gettext("unrecognized " 13670 "command '%s'\n"), cmdname); 13671 usage(B_FALSE); 13672 ret = 1; 13673 } 13674 13675 for (i = 0; i < argc; i++) 13676 free(newargv[i]); 13677 free(newargv); 13678 13679 if (ret == 0 && log_history) 13680 (void) zpool_log_history(g_zfs, history_str); 13681 13682 libzfs_fini(g_zfs); 13683 13684 /* 13685 * The 'ZFS_ABORT' environment variable causes us to dump core on exit 13686 * for the purposes of running ::findleaks. 13687 */ 13688 if (getenv("ZFS_ABORT") != NULL) { 13689 (void) printf("dumping core by request\n"); 13690 abort(); 13691 } 13692 13693 return (ret); 13694 } 13695