cmd/zpool/zpool_main.c

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