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.
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.
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]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
43 #include <sys/fs/zfs.h>
45 #include <sys/fm/util.h>
46 #include <sys/fm/protocol.h>
50 #include "zpool_util.h"
51 #include "zfs_comutil.h"
53 #include "statcommon.h"
55 static int zpool_do_create(int, char **);
56 static int zpool_do_destroy(int, char **);
58 static int zpool_do_add(int, char **);
59 static int zpool_do_remove(int, char **);
61 static int zpool_do_list(int, char **);
62 static int zpool_do_iostat(int, char **);
63 static int zpool_do_status(int, char **);
65 static int zpool_do_online(int, char **);
66 static int zpool_do_offline(int, char **);
67 static int zpool_do_clear(int, char **);
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 **);
74 static int zpool_do_scrub(int, char **);
76 static int zpool_do_import(int, char **);
77 static int zpool_do_export(int, char **);
79 static int zpool_do_upgrade(int, char **);
81 static int zpool_do_history(int, char **);
82 static int zpool_do_events(int, char **);
84 static int zpool_do_get(int, char **);
85 static int zpool_do_set(int, char **);
88 * These libumem hooks provide a reasonable set of defaults for the allocator's
89 * debugging facilities.
94 _umem_debug_init(void)
96 return ("default,verbose"); /* $UMEM_DEBUG setting */
100 _umem_logging_init(void)
102 return ("fail,contents"); /* $UMEM_LOGGING setting */
132 typedef struct zpool_command {
134 int (*func)(int, char **);
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.
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.
147 static zpool_command_t command_table[] = {
148 { "create", zpool_do_create, HELP_CREATE },
149 { "destroy", zpool_do_destroy, HELP_DESTROY },
151 { "add", zpool_do_add, HELP_ADD },
152 { "remove", zpool_do_remove, HELP_REMOVE },
154 { "list", zpool_do_list, HELP_LIST },
155 { "iostat", zpool_do_iostat, HELP_IOSTAT },
156 { "status", zpool_do_status, HELP_STATUS },
158 { "online", zpool_do_online, HELP_ONLINE },
159 { "offline", zpool_do_offline, HELP_OFFLINE },
160 { "clear", zpool_do_clear, HELP_CLEAR },
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 },
167 { "scrub", zpool_do_scrub, HELP_SCRUB },
169 { "import", zpool_do_import, HELP_IMPORT },
170 { "export", zpool_do_export, HELP_EXPORT },
171 { "upgrade", zpool_do_upgrade, HELP_UPGRADE },
173 { "history", zpool_do_history, HELP_HISTORY },
174 { "events", zpool_do_events, HELP_EVENTS },
176 { "get", zpool_do_get, HELP_GET },
177 { "set", zpool_do_set, HELP_SET },
180 #define NCOMMAND (sizeof (command_table) / sizeof (command_table[0]))
182 zpool_command_t *current_command;
183 static char history_str[HIS_MAX_RECORD_LEN];
185 static uint_t timestamp_fmt = NODATE;
188 get_usage(zpool_help_t idx) {
191 return (gettext("\tadd [-fn] <pool> <vdev> ...\n"));
193 return (gettext("\tattach [-f] <pool> <device> "
196 return (gettext("\tclear [-nF] <pool> [device]\n"));
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"));
202 return (gettext("\tdestroy [-f] <pool>\n"));
204 return (gettext("\tdetach <pool> <device>\n"));
206 return (gettext("\texport [-f] <pool> ...\n"));
208 return (gettext("\thistory [-il] [<pool>] ...\n"));
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"));
220 return (gettext("\tiostat [-v] [-T d|u] [pool] ... [interval "
223 return (gettext("\tlist [-H] [-o property[,...]] "
224 "[-T d|u] [pool] ... [interval [count]]\n"));
226 return (gettext("\toffline [-t] <pool> <device> ...\n"));
228 return (gettext("\tonline <pool> <device> ...\n"));
230 return (gettext("\treplace [-f] <pool> <device> "
233 return (gettext("\tremove <pool> <device> ...\n"));
235 return (gettext("\tscrub [-s] <pool> ...\n"));
237 return (gettext("\tstatus [-vx] [-T d|u] [pool] ... [interval "
240 return (gettext("\tupgrade\n"
242 "\tupgrade [-V version] <-a | pool ...>\n"));
244 return (gettext("\tevents [-vHfc]\n"));
246 return (gettext("\tget <\"all\" | property[,...]> "
249 return (gettext("\tset <property=value> <pool> \n"));
251 return (gettext("\tsplit [-n] [-R altroot] [-o mntopts]\n"
252 "\t [-o property=value] <pool> <newpool> "
253 "[<device> ...]\n"));
262 * Callback routine that will print out a pool property value.
265 print_prop_cb(int prop, void *cb)
269 (void) fprintf(fp, "\t%-15s ", zpool_prop_to_name(prop));
271 if (zpool_prop_readonly(prop))
272 (void) fprintf(fp, " NO ");
274 (void) fprintf(fp, " YES ");
276 if (zpool_prop_values(prop) == NULL)
277 (void) fprintf(fp, "-\n");
279 (void) fprintf(fp, "%s\n", zpool_prop_values(prop));
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.
290 usage(boolean_t requested)
292 FILE *fp = requested ? stdout : stderr;
294 if (current_command == NULL) {
297 (void) fprintf(fp, gettext("usage: zpool command args ...\n"));
299 gettext("where 'command' is one of the following:\n\n"));
301 for (i = 0; i < NCOMMAND; i++) {
302 if (command_table[i].name == NULL)
303 (void) fprintf(fp, "\n");
305 (void) fprintf(fp, "%s",
306 get_usage(command_table[i].usage));
309 (void) fprintf(fp, gettext("usage:\n"));
310 (void) fprintf(fp, "%s", get_usage(current_command->usage));
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))) {
319 gettext("\nthe following properties are supported:\n"));
321 (void) fprintf(fp, "\n\t%-15s %s %s\n\n",
322 "PROPERTY", "EDIT", "VALUES");
324 /* Iterate over all properties */
325 (void) zprop_iter(print_prop_cb, fp, B_FALSE, B_TRUE,
330 * See comments at end of main().
332 if (getenv("ZFS_ABORT") != NULL) {
333 (void) printf("dumping core by request\n");
337 exit(requested ? 0 : 2);
341 print_vdev_tree(zpool_handle_t *zhp, const char *name, nvlist_t *nv, int indent,
342 boolean_t print_logs)
349 (void) printf("\t%*s%s\n", indent, "", name);
351 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
352 &child, &children) != 0)
355 for (c = 0; c < children; c++) {
356 uint64_t is_log = B_FALSE;
358 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
360 if ((is_log && !print_logs) || (!is_log && print_logs))
363 vname = zpool_vdev_name(g_zfs, zhp, child[c], B_FALSE);
364 print_vdev_tree(zhp, vname, child[c], indent + 2,
371 * Add a property pair (name, string-value) into a property nvlist.
374 add_prop_list(const char *propname, char *propval, nvlist_t **props,
377 zpool_prop_t prop = ZPROP_INVAL;
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"));
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);
398 normnm = zpool_prop_to_name(prop);
400 if ((fprop = zfs_name_to_prop(propname)) != ZPROP_INVAL) {
401 normnm = zfs_prop_to_name(fprop);
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);
414 if (nvlist_add_string(proplist, normnm, propval) != 0) {
415 (void) fprintf(stderr, gettext("internal "
416 "error: out of memory\n"));
424 * zpool add [-fn] <pool> <vdev> ...
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.
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
435 zpool_do_add(int argc, char **argv)
437 boolean_t force = B_FALSE;
438 boolean_t dryrun = B_FALSE;
447 while ((c = getopt(argc, argv, "fn")) != -1) {
456 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
465 /* get pool name and check number of arguments */
467 (void) fprintf(stderr, gettext("missing pool name argument\n"));
471 (void) fprintf(stderr, gettext("missing vdev specification\n"));
480 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
483 if ((config = zpool_get_config(zhp, NULL)) == NULL) {
484 (void) fprintf(stderr, gettext("pool '%s' is unavailable\n"),
490 /* pass off to get_vdev_spec for processing */
491 nvroot = make_root_vdev(zhp, force, !force, B_FALSE, dryrun,
493 if (nvroot == NULL) {
499 nvlist_t *poolnvroot;
501 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
504 (void) printf(gettext("would update '%s' to the following "
505 "configuration:\n"), zpool_get_name(zhp));
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);
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);
521 ret = (zpool_add(zhp, nvroot) != 0);
531 * zpool remove <pool> <vdev> ...
533 * Removes the given vdev from the pool. Currently, this supports removing
534 * spares, cache, and log devices from the pool.
537 zpool_do_remove(int argc, char **argv)
546 /* get pool name and check number of arguments */
548 (void) fprintf(stderr, gettext("missing pool name argument\n"));
552 (void) fprintf(stderr, gettext("missing device\n"));
558 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
561 for (i = 1; i < argc; i++) {
562 if (zpool_vdev_remove(zhp, argv[i]) != 0)
570 * zpool create [-fn] [-o property=value] ...
571 * [-O file-system-property=value] ...
572 * [-R root] [-m mountpoint] <pool> <dev> ...
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
580 * -o Set property=value.
581 * -O Set fsproperty=value in the pool's root file system
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.
589 zpool_do_create(int argc, char **argv)
591 boolean_t force = B_FALSE;
592 boolean_t dryrun = B_FALSE;
594 nvlist_t *nvroot = NULL;
597 char *altroot = NULL;
598 char *mountpoint = NULL;
599 nvlist_t *fsprops = NULL;
600 nvlist_t *props = NULL;
604 while ((c = getopt(argc, argv, ":fnR:m:o:O:")) != -1) {
614 if (add_prop_list(zpool_prop_to_name(
615 ZPOOL_PROP_ALTROOT), optarg, &props, B_TRUE))
617 if (nvlist_lookup_string(props,
618 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE),
621 if (add_prop_list(zpool_prop_to_name(
622 ZPOOL_PROP_CACHEFILE), "none", &props, B_TRUE))
629 if ((propval = strchr(optarg, '=')) == NULL) {
630 (void) fprintf(stderr, gettext("missing "
631 "'=' for -o option\n"));
637 if (add_prop_list(optarg, propval, &props, B_TRUE))
641 if ((propval = strchr(optarg, '=')) == NULL) {
642 (void) fprintf(stderr, gettext("missing "
643 "'=' for -O option\n"));
649 if (add_prop_list(optarg, propval, &fsprops, B_FALSE))
653 (void) fprintf(stderr, gettext("missing argument for "
654 "'%c' option\n"), optopt);
657 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
666 /* get pool name and check number of arguments */
668 (void) fprintf(stderr, gettext("missing pool name argument\n"));
672 (void) fprintf(stderr, gettext("missing vdev specification\n"));
679 * As a special case, check for use of '/' in the name, and direct the
680 * user to use 'zfs create' instead.
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"));
690 /* pass off to get_vdev_spec for bulk processing */
691 nvroot = make_root_vdev(NULL, force, !force, B_FALSE, dryrun,
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 "
705 if (altroot != NULL && altroot[0] != '/') {
706 (void) fprintf(stderr, gettext("invalid alternate root '%s': "
707 "must be an absolute path\n"), altroot);
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.
715 if (mountpoint == NULL ||
716 (strcmp(mountpoint, ZFS_MOUNTPOINT_LEGACY) != 0 &&
717 strcmp(mountpoint, ZFS_MOUNTPOINT_NONE) != 0)) {
718 char buf[MAXPATHLEN];
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);
728 if (mountpoint == NULL) {
730 (void) snprintf(buf, sizeof (buf), "%s/%s",
733 (void) snprintf(buf, sizeof (buf), "/%s",
737 (void) snprintf(buf, sizeof (buf), "%s%s",
738 altroot, mountpoint);
740 (void) snprintf(buf, sizeof (buf), "%s",
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"));
753 while (count < 3 && readdir(dirp) != NULL)
755 (void) closedir(dirp);
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"));
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.
774 (void) printf(gettext("would create '%s' with the "
775 "following layout:\n\n"), poolname);
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);
784 * Hand off to libzfs.
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);
791 if (mountpoint != NULL)
792 verify(zfs_prop_set(pool,
794 ZFS_PROP_MOUNTPOINT),
796 if (zfs_mount(pool, NULL, 0) == 0)
797 ret = zfs_shareall(pool);
800 } else if (libzfs_errno(g_zfs) == EZFS_INVALIDNAME) {
801 (void) fprintf(stderr, gettext("pool name may have "
808 nvlist_free(fsprops);
812 nvlist_free(fsprops);
819 * zpool destroy <pool>
821 * -f Forcefully unmount any datasets
823 * Destroy the given pool. Automatically unmounts any datasets in the pool.
826 zpool_do_destroy(int argc, char **argv)
828 boolean_t force = B_FALSE;
835 while ((c = getopt(argc, argv, "f")) != -1) {
841 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
850 /* check arguments */
852 (void) fprintf(stderr, gettext("missing pool argument\n"));
856 (void) fprintf(stderr, gettext("too many arguments\n"));
862 if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL) {
864 * As a special case, check for use of '/' in the name, and
865 * direct the user to use 'zfs destroy' instead.
867 if (strchr(pool, '/') != NULL)
868 (void) fprintf(stderr, gettext("use 'zfs destroy' to "
869 "destroy a dataset\n"));
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));
879 ret = (zpool_destroy(zhp) != 0);
887 * zpool export [-f] <pool> ...
889 * -f Forcefully unmount datasets
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.
896 zpool_do_export(int argc, char **argv)
898 boolean_t force = B_FALSE;
899 boolean_t hardforce = B_FALSE;
906 while ((c = getopt(argc, argv, "fF")) != -1) {
915 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
924 /* check arguments */
926 (void) fprintf(stderr, gettext("missing pool argument\n"));
931 for (i = 0; i < argc; i++) {
932 if ((zhp = zpool_open_canfail(g_zfs, argv[i])) == NULL) {
937 if (zpool_disable_datasets(zhp, force) != 0) {
944 if (zpool_export_force(zhp) != 0)
946 } else if (zpool_export(zhp, force) != 0) {
957 * Given a vdev configuration, determine the maximum width needed for the device
961 max_width(zpool_handle_t *zhp, nvlist_t *nv, int depth, int max)
963 char *name = zpool_vdev_name(g_zfs, zhp, nv, B_TRUE);
968 if (strlen(name) + depth > max)
969 max = strlen(name) + depth;
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,
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,
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,
1001 typedef struct spare_cbdata {
1003 zpool_handle_t *cb_zhp;
1007 find_vdev(nvlist_t *nv, uint64_t search)
1013 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &guid) == 0 &&
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))
1028 find_spare(zpool_handle_t *zhp, void *data)
1030 spare_cbdata_t *cbp = data;
1031 nvlist_t *config, *nvroot;
1033 config = zpool_get_config(zhp, NULL);
1034 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
1037 if (find_vdev(nvroot, cbp->cb_guid)) {
1047 * Print out configuration state as requested by status_callback.
1050 print_status_config(zpool_handle_t *zhp, const char *name, nvlist_t *nv,
1051 int namewidth, int depth, boolean_t isspare)
1055 pool_scan_stat_t *ps = NULL;
1057 char rbuf[6], wbuf[6], cbuf[6];
1059 uint64_t notpresent;
1063 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1064 &child, &children) != 0)
1067 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
1068 (uint64_t **)&vs, &c) == 0);
1070 state = zpool_state_to_name(vs->vs_state, vs->vs_aux);
1073 * For hot spares, we use the terms 'INUSE' and 'AVAILABLE' for
1076 if (vs->vs_aux == VDEV_AUX_SPARED)
1078 else if (vs->vs_state == VDEV_STATE_HEALTHY)
1082 (void) printf("\t%*s%-*s %-8s", depth, "", namewidth - depth,
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);
1092 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NOT_PRESENT,
1093 ¬present) == 0) {
1095 verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0);
1096 (void) printf(" was %s", path);
1097 } else if (vs->vs_aux != 0) {
1100 switch (vs->vs_aux) {
1101 case VDEV_AUX_OPEN_FAILED:
1102 (void) printf(gettext("cannot open"));
1105 case VDEV_AUX_BAD_GUID_SUM:
1106 (void) printf(gettext("missing device"));
1109 case VDEV_AUX_NO_REPLICAS:
1110 (void) printf(gettext("insufficient replicas"));
1113 case VDEV_AUX_VERSION_NEWER:
1114 (void) printf(gettext("newer version"));
1117 case VDEV_AUX_SPARED:
1118 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID,
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 "
1126 (void) printf(gettext("in use by "
1128 zpool_get_name(cb.cb_zhp));
1129 zpool_close(cb.cb_zhp);
1131 (void) printf(gettext("currently in use"));
1135 case VDEV_AUX_ERR_EXCEEDED:
1136 (void) printf(gettext("too many errors"));
1139 case VDEV_AUX_IO_FAILURE:
1140 (void) printf(gettext("experienced I/O failures"));
1143 case VDEV_AUX_BAD_LOG:
1144 (void) printf(gettext("bad intent log"));
1147 case VDEV_AUX_EXTERNAL:
1148 (void) printf(gettext("external device fault"));
1151 case VDEV_AUX_SPLIT_POOL:
1152 (void) printf(gettext("split into new pool"));
1156 (void) printf(gettext("corrupted data"));
1161 (void) nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_SCAN_STATS,
1162 (uint64_t **)&ps, &c);
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");
1171 (void) printf("\n");
1173 for (c = 0; c < children; c++) {
1174 uint64_t islog = B_FALSE, ishole = B_FALSE;
1176 /* Don't print logs or holes here */
1177 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
1179 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_HOLE,
1181 if (islog || ishole)
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);
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.
1196 print_import_config(const char *name, nvlist_t *nv, int namewidth, int depth)
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)
1208 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
1209 (uint64_t **)&vs, &c) == 0);
1211 (void) printf("\t%*s%-*s", depth, "", namewidth - depth, name);
1212 (void) printf(" %s", zpool_state_to_name(vs->vs_state, vs->vs_aux));
1214 if (vs->vs_aux != 0) {
1217 switch (vs->vs_aux) {
1218 case VDEV_AUX_OPEN_FAILED:
1219 (void) printf(gettext("cannot open"));
1222 case VDEV_AUX_BAD_GUID_SUM:
1223 (void) printf(gettext("missing device"));
1226 case VDEV_AUX_NO_REPLICAS:
1227 (void) printf(gettext("insufficient replicas"));
1230 case VDEV_AUX_VERSION_NEWER:
1231 (void) printf(gettext("newer version"));
1234 case VDEV_AUX_ERR_EXCEEDED:
1235 (void) printf(gettext("too many errors"));
1239 (void) printf(gettext("corrupted data"));
1243 (void) printf("\n");
1245 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1246 &child, &children) != 0)
1249 for (c = 0; c < children; c++) {
1250 uint64_t is_log = B_FALSE;
1252 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
1257 vname = zpool_vdev_name(g_zfs, NULL, child[c], B_TRUE);
1258 print_import_config(vname, child[c], namewidth, depth + 2);
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);
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);
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"
1292 print_logs(zpool_handle_t *zhp, nvlist_t *nv, int namewidth, boolean_t verbose)
1297 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, &child,
1301 (void) printf(gettext("\tlogs\n"));
1303 for (c = 0; c < children; c++) {
1304 uint64_t is_log = B_FALSE;
1307 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
1311 name = zpool_vdev_name(g_zfs, zhp, child[c], B_TRUE);
1313 print_status_config(zhp, name, child[c], namewidth,
1316 print_import_config(name, child[c], namewidth, 2);
1322 * Display the status for the given pool.
1325 show_import(nvlist_t *config)
1327 uint64_t pool_state;
1338 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
1340 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
1342 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
1344 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
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);
1351 reason = zpool_import_status(config, &msgid);
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");
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"));
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"));
1374 case ZPOOL_STATUS_CORRUPT_DATA:
1375 (void) printf(gettext("status: The pool data is corrupted.\n"));
1378 case ZPOOL_STATUS_OFFLINE_DEV:
1379 (void) printf(gettext("status: One or more devices "
1380 "are offlined.\n"));
1383 case ZPOOL_STATUS_CORRUPT_POOL:
1384 (void) printf(gettext("status: The pool metadata is "
1388 case ZPOOL_STATUS_VERSION_OLDER:
1389 (void) printf(gettext("status: The pool is formatted using an "
1390 "older on-disk version.\n"));
1393 case ZPOOL_STATUS_VERSION_NEWER:
1394 (void) printf(gettext("status: The pool is formatted using an "
1395 "incompatible version.\n"));
1398 case ZPOOL_STATUS_HOSTID_MISMATCH:
1399 (void) printf(gettext("status: The pool was last accessed by "
1400 "another system.\n"));
1403 case ZPOOL_STATUS_FAULTED_DEV_R:
1404 case ZPOOL_STATUS_FAULTED_DEV_NR:
1405 (void) printf(gettext("status: One or more devices are "
1409 case ZPOOL_STATUS_BAD_LOG:
1410 (void) printf(gettext("status: An intent log record cannot be "
1414 case ZPOOL_STATUS_RESILVERING:
1415 (void) printf(gettext("status: One or more devices were being "
1421 * No other status can be seen when importing pools.
1423 assert(reason == ZPOOL_STATUS_OK);
1427 * Print out an action according to the overall state of the pool.
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"));
1440 (void) printf(gettext("action: The pool can be "
1441 "imported using its name or numeric "
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"));
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 "
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 "
1463 (void) printf(gettext("action: The pool cannot be "
1464 "imported due to damaged devices or data.\n"));
1469 * If the state is "closed" or "can't open", and the aux state
1470 * is "corrupt data":
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"));
1485 (void) printf(gettext(" see: http://www.sun.com/msg/%s\n"),
1488 (void) printf(gettext("config:\n\n"));
1490 namewidth = max_width(NULL, nvroot, 0, 0);
1494 print_import_config(name, nvroot, namewidth, 0);
1495 if (num_logs(nvroot) > 0)
1496 print_logs(NULL, nvroot, namewidth, B_FALSE);
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"));
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
1511 do_import(nvlist_t *config, const char *newname, const char *mntopts,
1512 nvlist_t *props, int flags)
1514 zpool_handle_t *zhp;
1519 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
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);
1530 } else if (state != POOL_STATE_EXPORTED &&
1531 !(flags & ZFS_IMPORT_ANY_HOST)) {
1534 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_HOSTID,
1536 if ((unsigned long)hostid != gethostid()) {
1541 verify(nvlist_lookup_string(config,
1542 ZPOOL_CONFIG_HOSTNAME, &hostname) == 0);
1543 verify(nvlist_lookup_uint64(config,
1544 ZPOOL_CONFIG_TIMESTAMP, ×tamp) == 0);
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"));
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 "
1565 if (zpool_import_props(g_zfs, config, newname, props, flags) != 0)
1568 if (newname != NULL)
1569 name = (char *)newname;
1571 if ((zhp = zpool_open_canfail(g_zfs, name)) == NULL)
1574 if (zpool_get_state(zhp) != POOL_STATE_UNAVAIL &&
1575 !(flags & ZFS_IMPORT_ONLY) &&
1576 zpool_enable_datasets(zhp, mntopts, 0) != 0) {
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]
1592 * -c Read pool information from a cachefile instead of searching
1595 * -d Scan in a specific directory, other than /dev/. More than
1596 * one directory can be specified using multiple '-d' options.
1598 * -D Scan for previously destroyed pools or import all or only
1599 * specified destroyed pools.
1601 * -R Temporarily import the pool, with all mountpoints relative to
1602 * the given root. The pool will remain exported when the machine
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
1611 * -f Force import, even if it appears that the pool is active.
1613 * -F Attempt rewind if necessary.
1615 * -n See if rewind would work, but don't actually rewind.
1617 * -N Import the pool but don't mount datasets.
1619 * -T Specify a starting txg to use for import. This option is
1620 * intentionally undocumented option for testing purposes.
1622 * -a Import all pools found.
1624 * -o Set property=value and/or temporary mount options (without '=').
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.
1630 zpool_do_import(int argc, char **argv)
1632 char **searchdirs = NULL;
1636 nvlist_t *pools = NULL;
1637 boolean_t do_all = B_FALSE;
1638 boolean_t do_destroyed = B_FALSE;
1639 char *mntopts = NULL;
1642 uint64_t searchguid = 0;
1643 char *searchname = NULL;
1645 nvlist_t *found_config;
1646 nvlist_t *policy = NULL;
1647 nvlist_t *props = NULL;
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 };
1660 while ((c = getopt(argc, argv, ":aCc:d:DEfFmnNo:rR:T:VX")) != -1) {
1669 if (searchdirs == NULL) {
1670 searchdirs = safe_malloc(sizeof (char *));
1672 char **tmp = safe_malloc((nsearch + 1) *
1674 bcopy(searchdirs, tmp, nsearch *
1679 searchdirs[nsearch++] = optarg;
1682 do_destroyed = B_TRUE;
1685 flags |= ZFS_IMPORT_ANY_HOST;
1691 flags |= ZFS_IMPORT_MISSING_LOG;
1697 flags |= ZFS_IMPORT_ONLY;
1700 if ((propval = strchr(optarg, '=')) != NULL) {
1703 if (add_prop_list(optarg, propval,
1711 if (add_prop_list(zpool_prop_to_name(
1712 ZPOOL_PROP_ALTROOT), optarg, &props, B_TRUE))
1714 if (nvlist_lookup_string(props,
1715 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE),
1718 if (add_prop_list(zpool_prop_to_name(
1719 ZPOOL_PROP_CACHEFILE), "none", &props, B_TRUE))
1724 txg = strtoull(optarg, &endptr, 10);
1725 if (errno != 0 || *endptr != '\0') {
1726 (void) fprintf(stderr,
1727 gettext("invalid txg value\n"));
1730 rewind_policy = ZPOOL_DO_REWIND | ZPOOL_EXTREME_REWIND;
1733 flags |= ZFS_IMPORT_VERBATIM;
1736 xtreme_rewind = B_TRUE;
1739 (void) fprintf(stderr, gettext("missing argument for "
1740 "'%c' option\n"), optopt);
1744 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1753 if (cachefile && nsearch != 0) {
1754 (void) fprintf(stderr, gettext("-c is incompatible with -d\n"));
1758 if ((dryrun || xtreme_rewind) && !do_rewind) {
1759 (void) fprintf(stderr,
1760 gettext("-n or -X only meaningful with -F\n"));
1764 rewind_policy = ZPOOL_TRY_REWIND;
1766 rewind_policy = ZPOOL_DO_REWIND;
1768 rewind_policy |= ZPOOL_EXTREME_REWIND;
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)
1776 /* check argument count */
1779 (void) fprintf(stderr, gettext("too many arguments\n"));
1784 (void) fprintf(stderr, gettext("too many arguments\n"));
1789 * Check for the SYS_CONFIG privilege. We do this explicitly
1790 * here because otherwise any attempt to discover pools will
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)
1799 nvlist_free(policy);
1805 * Depending on the arguments given, we do one of the following:
1807 * <none> Iterate through all pools and display information about
1810 * -a Iterate through all pools and try to import each one.
1812 * <id> Find the pool that corresponds to the given GUID/pool
1813 * name and import that one.
1815 * -D Above options applies only to destroyed pools.
1821 searchguid = strtoull(argv[0], &endptr, 10);
1822 if (errno != 0 || *endptr != '\0')
1823 searchname = argv[0];
1824 found_config = NULL;
1827 * User specified a name or guid. Ensure it's unique.
1829 idata.unique = B_TRUE;
1833 idata.path = searchdirs;
1834 idata.paths = nsearch;
1835 idata.poolname = searchname;
1836 idata.guid = searchguid;
1837 idata.cachefile = cachefile;
1839 pools = zpool_search_import(g_zfs, &idata);
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"),
1846 (void) fprintf(stderr, gettext("use the form '%s "
1847 "<pool | id> <newpool>' to give it a new name\n"),
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"),
1854 (void) fprintf(stderr, gettext("and no additional pools "
1855 "with that name were found\n"));
1857 } else if (pools == NULL) {
1859 (void) fprintf(stderr, gettext("cannot import '%s': "
1860 "no such pool available\n"), argv[0]);
1866 if (searchdirs != NULL)
1868 nvlist_free(policy);
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
1881 while ((elem = nvlist_next_nvpair(pools, elem)) != NULL) {
1883 verify(nvpair_value_nvlist(elem, &config) == 0);
1885 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
1887 if (!do_destroyed && pool_state == POOL_STATE_DESTROYED)
1889 if (do_destroyed && pool_state != POOL_STATE_DESTROYED)
1892 verify(nvlist_add_nvlist(config, ZPOOL_REWIND_POLICY,
1899 (void) printf("\n");
1902 err |= do_import(config, NULL, mntopts,
1905 show_import(config);
1907 } else if (searchname != NULL) {
1911 * We are searching for a pool based on name.
1913 verify(nvlist_lookup_string(config,
1914 ZPOOL_CONFIG_POOL_NAME, &name) == 0);
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"));
1925 found_config = config;
1931 * Search for a pool by guid.
1933 verify(nvlist_lookup_uint64(config,
1934 ZPOOL_CONFIG_POOL_GUID, &guid) == 0);
1936 if (guid == searchguid)
1937 found_config = config;
1942 * If we were searching for a specific pool, verify that we found a
1943 * pool, and then do the import.
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]);
1951 err |= do_import(found_config, argc == 1 ? NULL :
1952 argv[1], mntopts, props, flags);
1957 * If we were just looking for pools, report an error if none were
1960 if (argc == 0 && first)
1961 (void) fprintf(stderr,
1962 gettext("no pools available to import\n"));
1967 nvlist_free(policy);
1968 if (searchdirs != NULL)
1971 return (err ? 1 : 0);
1974 typedef struct iostat_cbdata {
1975 zpool_list_t *cb_list;
1982 print_iostat_separator(iostat_cbdata_t *cb)
1986 for (i = 0; i < cb->cb_namewidth; i++)
1988 (void) printf(" ----- ----- ----- ----- ----- -----\n");
1992 print_iostat_header(iostat_cbdata_t *cb)
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);
2002 * Display a single statistic.
2005 print_one_stat(uint64_t value)
2009 zfs_nicenum(value, buf, sizeof (buf));
2010 (void) printf(" %5s", buf);
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.
2019 print_vdev_stats(zpool_handle_t *zhp, const char *name, nvlist_t *oldnv,
2020 nvlist_t *newnv, iostat_cbdata_t *cb, int depth)
2022 nvlist_t **oldchild, **newchild;
2024 vdev_stat_t *oldvs, *newvs;
2025 vdev_stat_t zerovs = { 0 };
2030 if (oldnv != NULL) {
2031 verify(nvlist_lookup_uint64_array(oldnv,
2032 ZPOOL_CONFIG_VDEV_STATS, (uint64_t **)&oldvs, &c) == 0);
2037 verify(nvlist_lookup_uint64_array(newnv, ZPOOL_CONFIG_VDEV_STATS,
2038 (uint64_t **)&newvs, &c) == 0);
2040 if (strlen(name) + depth > cb->cb_namewidth)
2041 (void) printf("%*s%s", depth, "", name);
2043 (void) printf("%*s%s%*s", depth, "", name,
2044 (int)(cb->cb_namewidth - strlen(name) - depth), "");
2046 tdelta = newvs->vs_timestamp - oldvs->vs_timestamp;
2051 scale = (double)NANOSEC / tdelta;
2053 /* only toplevel vdevs have capacity stats */
2054 if (newvs->vs_space == 0) {
2055 (void) printf(" - -");
2057 print_one_stat(newvs->vs_alloc);
2058 print_one_stat(newvs->vs_space - newvs->vs_alloc);
2061 print_one_stat((uint64_t)(scale * (newvs->vs_ops[ZIO_TYPE_READ] -
2062 oldvs->vs_ops[ZIO_TYPE_READ])));
2064 print_one_stat((uint64_t)(scale * (newvs->vs_ops[ZIO_TYPE_WRITE] -
2065 oldvs->vs_ops[ZIO_TYPE_WRITE])));
2067 print_one_stat((uint64_t)(scale * (newvs->vs_bytes[ZIO_TYPE_READ] -
2068 oldvs->vs_bytes[ZIO_TYPE_READ])));
2070 print_one_stat((uint64_t)(scale * (newvs->vs_bytes[ZIO_TYPE_WRITE] -
2071 oldvs->vs_bytes[ZIO_TYPE_WRITE])));
2073 (void) printf("\n");
2075 if (!cb->cb_verbose)
2078 if (nvlist_lookup_nvlist_array(newnv, ZPOOL_CONFIG_CHILDREN,
2079 &newchild, &children) != 0)
2082 if (oldnv && nvlist_lookup_nvlist_array(oldnv, ZPOOL_CONFIG_CHILDREN,
2083 &oldchild, &c) != 0)
2086 for (c = 0; c < children; c++) {
2087 uint64_t ishole = B_FALSE;
2089 if (nvlist_lookup_uint64(newchild[c],
2090 ZPOOL_CONFIG_IS_HOLE, &ishole) == 0 && ishole)
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);
2100 * Include level 2 ARC devices in iostat output
2102 if (nvlist_lookup_nvlist_array(newnv, ZPOOL_CONFIG_L2CACHE,
2103 &newchild, &children) != 0)
2106 if (oldnv && nvlist_lookup_nvlist_array(oldnv, ZPOOL_CONFIG_L2CACHE,
2107 &oldchild, &c) != 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],
2116 print_vdev_stats(zhp, vname, oldnv ? oldchild[c] : NULL,
2117 newchild[c], cb, depth + 2);
2124 refresh_iostat(zpool_handle_t *zhp, void *data)
2126 iostat_cbdata_t *cb = data;
2130 * If the pool has disappeared, remove it from the list and continue.
2132 if (zpool_refresh_stats(zhp, &missing) != 0)
2136 pool_list_remove(cb->cb_list, zhp);
2142 * Callback to print out the iostats for the given pool.
2145 print_iostat(zpool_handle_t *zhp, void *data)
2147 iostat_cbdata_t *cb = data;
2148 nvlist_t *oldconfig, *newconfig;
2149 nvlist_t *oldnvroot, *newnvroot;
2151 newconfig = zpool_get_config(zhp, &oldconfig);
2153 if (cb->cb_iteration == 1)
2156 verify(nvlist_lookup_nvlist(newconfig, ZPOOL_CONFIG_VDEV_TREE,
2159 if (oldconfig == NULL)
2162 verify(nvlist_lookup_nvlist(oldconfig, ZPOOL_CONFIG_VDEV_TREE,
2166 * Print out the statistics for the pool.
2168 print_vdev_stats(zhp, zpool_get_name(zhp), oldnvroot, newnvroot, cb, 0);
2171 print_iostat_separator(cb);
2177 get_namewidth(zpool_handle_t *zhp, void *data)
2179 iostat_cbdata_t *cb = data;
2180 nvlist_t *config, *nvroot;
2182 if ((config = zpool_get_config(zhp, NULL)) != NULL) {
2183 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
2185 if (!cb->cb_verbose)
2186 cb->cb_namewidth = strlen(zpool_get_name(zhp));
2188 cb->cb_namewidth = max_width(zhp, nvroot, 0, 0);
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.
2195 if (cb->cb_namewidth < 10)
2196 cb->cb_namewidth = 10;
2197 if (cb->cb_namewidth > 38)
2198 cb->cb_namewidth = 38;
2204 * Parse the input string, get the 'interval' and 'count' value if there is one.
2207 get_interval_count(int *argcp, char **argv, unsigned long *iv,
2210 unsigned long interval = 0, count = 0;
2214 * Determine if the last argument is an integer or a pool name
2216 if (argc > 0 && isdigit(argv[argc - 1][0])) {
2220 interval = strtoul(argv[argc - 1], &end, 10);
2222 if (*end == '\0' && errno == 0) {
2223 if (interval == 0) {
2224 (void) fprintf(stderr, gettext("interval "
2225 "cannot be zero\n"));
2229 * Ignore the last parameter
2234 * If this is not a valid number, just plow on. The
2235 * user will get a more informative error message later
2243 * If the last argument is also an integer, then we have both a count
2246 if (argc > 0 && isdigit(argv[argc - 1][0])) {
2251 interval = strtoul(argv[argc - 1], &end, 10);
2253 if (*end == '\0' && errno == 0) {
2254 if (interval == 0) {
2255 (void) fprintf(stderr, gettext("interval "
2256 "cannot be zero\n"));
2261 * Ignore the last parameter
2275 get_timestamp_arg(char c)
2278 timestamp_fmt = UDATE;
2280 timestamp_fmt = DDATE;
2286 * zpool iostat [-v] [-T d|u] [pool] ... [interval [count]]
2288 * -v Display statistics for individual vdevs
2289 * -T Display a timestamp in date(1) or Unix format
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.
2298 zpool_do_iostat(int argc, char **argv)
2303 unsigned long interval = 0, count = 0;
2305 boolean_t verbose = B_FALSE;
2309 while ((c = getopt(argc, argv, "T:v")) != -1) {
2312 get_timestamp_arg(*optarg);
2318 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2327 get_interval_count(&argc, argv, &interval, &count);
2330 * Construct the list of all interesting pools.
2333 if ((list = pool_list_get(argc, argv, NULL, &ret)) == NULL)
2336 if (pool_list_count(list) == 0 && argc != 0) {
2337 pool_list_free(list);
2341 if (pool_list_count(list) == 0 && interval == 0) {
2342 pool_list_free(list);
2343 (void) fprintf(stderr, gettext("no pools available\n"));
2348 * Enter the main iostat loop.
2351 cb.cb_verbose = verbose;
2352 cb.cb_iteration = 0;
2353 cb.cb_namewidth = 0;
2356 pool_list_update(list);
2358 if ((npools = pool_list_count(list)) == 0)
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.
2366 (void) pool_list_iter(list, B_FALSE, refresh_iostat, &cb);
2369 * Iterate over all pools to determine the maximum width
2370 * for the pool / device name column across all pools.
2372 cb.cb_namewidth = 0;
2373 (void) pool_list_iter(list, B_FALSE, get_namewidth, &cb);
2375 if (timestamp_fmt != NODATE)
2376 print_timestamp(timestamp_fmt);
2379 * If it's the first time, or verbose mode, print the header.
2381 if (++cb.cb_iteration == 1 || verbose)
2382 print_iostat_header(&cb);
2384 (void) pool_list_iter(list, B_FALSE, print_iostat, &cb);
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.
2390 if (npools > 1 && !verbose)
2391 print_iostat_separator(&cb);
2394 (void) printf("\n");
2397 * Flush the output so that redirection to a file isn't buffered
2400 (void) fflush(stdout);
2405 if (count != 0 && --count == 0)
2408 (void) sleep(interval);
2411 pool_list_free(list);
2416 typedef struct list_cbdata {
2417 boolean_t cb_scripted;
2419 zprop_list_t *cb_proplist;
2423 * Given a list of columns to display, output appropriate headers for each one.
2426 print_header(zprop_list_t *pl)
2429 boolean_t first = B_TRUE;
2430 boolean_t right_justify;
2432 for (; pl != NULL; pl = pl->pl_next) {
2433 if (pl->pl_prop == ZPROP_INVAL)
2441 header = zpool_prop_column_name(pl->pl_prop);
2442 right_justify = zpool_prop_align_right(pl->pl_prop);
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);
2449 (void) printf("%-*s", (int)pl->pl_width, header);
2452 (void) printf("\n");
2456 * Given a pool and a list of properties, print out all the properties according
2457 * to the described layout.
2460 print_pool(zpool_handle_t *zhp, zprop_list_t *pl, int scripted)
2462 boolean_t first = B_TRUE;
2463 char property[ZPOOL_MAXPROPLEN];
2465 boolean_t right_justify;
2468 for (; pl != NULL; pl = pl->pl_next) {
2471 (void) printf("\t");
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)
2486 right_justify = zpool_prop_align_right(pl->pl_prop);
2491 width = pl->pl_width;
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
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);
2503 (void) printf("%-*s", width, propstr);
2506 (void) printf("\n");
2510 * Generic callback function to list a pool.
2513 list_callback(zpool_handle_t *zhp, void *data)
2515 list_cbdata_t *cbp = data;
2517 if (cbp->cb_first) {
2518 if (!cbp->cb_scripted)
2519 print_header(cbp->cb_proplist);
2520 cbp->cb_first = B_FALSE;
2523 print_pool(zhp, cbp->cb_proplist, cbp->cb_scripted);
2529 * zpool list [-H] [-o prop[,prop]*] [-T d|u] [pool] ... [interval [count]]
2531 * -H Scripted mode. Don't display headers, and separate properties
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
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.
2541 zpool_do_list(int argc, char **argv)
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;
2552 while ((c = getopt(argc, argv, ":Ho:T:")) != -1) {
2555 cb.cb_scripted = B_TRUE;
2561 get_timestamp_arg(*optarg);
2564 (void) fprintf(stderr, gettext("missing argument for "
2565 "'%c' option\n"), optopt);
2569 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2578 get_interval_count(&argc, argv, &interval, &count);
2580 if (zprop_get_list(g_zfs, props, &cb.cb_proplist, ZFS_TYPE_POOL) != 0)
2583 cb.cb_first = B_TRUE;
2587 if (timestamp_fmt != NODATE)
2588 print_timestamp(timestamp_fmt);
2590 ret = for_each_pool(argc, argv, B_TRUE, &cb.cb_proplist,
2591 list_callback, &cb);
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);
2602 if (count != 0 && --count == 0)
2605 (void) sleep(interval);
2608 zprop_free_list(cb.cb_proplist);
2613 zpool_do_attach_or_replace(int argc, char **argv, int replacing)
2615 boolean_t force = B_FALSE;
2618 char *poolname, *old_disk, *new_disk;
2619 zpool_handle_t *zhp;
2623 while ((c = getopt(argc, argv, "f")) != -1) {
2629 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2638 /* get pool name and check number of arguments */
2640 (void) fprintf(stderr, gettext("missing pool name argument\n"));
2647 (void) fprintf(stderr,
2648 gettext("missing <device> specification\n"));
2656 (void) fprintf(stderr,
2657 gettext("missing <new_device> specification\n"));
2660 new_disk = old_disk;
2670 (void) fprintf(stderr, gettext("too many arguments\n"));
2674 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
2677 if (zpool_get_config(zhp, NULL) == NULL) {
2678 (void) fprintf(stderr, gettext("pool '%s' is unavailable\n"),
2684 nvroot = make_root_vdev(zhp, force, B_FALSE, replacing, B_FALSE,
2686 if (nvroot == NULL) {
2691 ret = zpool_vdev_attach(zhp, old_disk, new_disk, nvroot, replacing);
2693 nvlist_free(nvroot);
2700 * zpool replace [-f] <pool> <device> <new_device>
2702 * -f Force attach, even if <new_device> appears to be in use.
2704 * Replace <device> with <new_device>.
2708 zpool_do_replace(int argc, char **argv)
2710 return (zpool_do_attach_or_replace(argc, argv, B_TRUE));
2714 * zpool attach [-f] <pool> <device> <new_device>
2716 * -f Force attach, even if <new_device> appears to be in use.
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.
2724 zpool_do_attach(int argc, char **argv)
2726 return (zpool_do_attach_or_replace(argc, argv, B_FALSE));
2730 * zpool detach [-f] <pool> <device>
2732 * -f Force detach of <device>, even if DTLs argue against it
2733 * (not supported yet)
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.
2741 zpool_do_detach(int argc, char **argv)
2744 char *poolname, *path;
2745 zpool_handle_t *zhp;
2749 while ((c = getopt(argc, argv, "f")) != -1) {
2753 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2762 /* get pool name and check number of arguments */
2764 (void) fprintf(stderr, gettext("missing pool name argument\n"));
2769 (void) fprintf(stderr,
2770 gettext("missing <device> specification\n"));
2777 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
2780 ret = zpool_vdev_detach(zhp, path);
2788 * zpool split [-n] [-o prop=val] ...
2790 * [-R altroot] <pool> <newpool> [<device> ...]
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.
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.
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.
2807 zpool_do_split(int argc, char **argv)
2809 char *srcpool, *newpool, *propval;
2810 char *mntopts = NULL;
2813 zpool_handle_t *zhp;
2814 nvlist_t *config, *props = NULL;
2816 flags.dryrun = B_FALSE;
2817 flags.import = B_FALSE;
2820 while ((c = getopt(argc, argv, ":R:no:")) != -1) {
2823 flags.import = B_TRUE;
2825 zpool_prop_to_name(ZPOOL_PROP_ALTROOT), optarg,
2826 &props, B_TRUE) != 0) {
2833 flags.dryrun = B_TRUE;
2836 if ((propval = strchr(optarg, '=')) != NULL) {
2839 if (add_prop_list(optarg, propval,
2840 &props, B_TRUE) != 0) {
2850 (void) fprintf(stderr, gettext("missing argument for "
2851 "'%c' option\n"), optopt);
2855 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2862 if (!flags.import && mntopts != NULL) {
2863 (void) fprintf(stderr, gettext("setting mntopts is only "
2864 "valid when importing the pool\n"));
2872 (void) fprintf(stderr, gettext("Missing pool name\n"));
2876 (void) fprintf(stderr, gettext("Missing new pool name\n"));
2886 if ((zhp = zpool_open(g_zfs, srcpool)) == NULL)
2889 config = split_mirror_vdev(zhp, newpool, props, flags, argc, argv);
2890 if (config == NULL) {
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);
2898 nvlist_free(config);
2903 if (ret != 0 || flags.dryrun || !flags.import)
2907 * The split was successful. Now we need to open the new
2908 * pool and import it.
2910 if ((zhp = zpool_open_canfail(g_zfs, newpool)) == NULL)
2912 if (zpool_get_state(zhp) != POOL_STATE_UNAVAIL &&
2913 zpool_enable_datasets(zhp, mntopts, 0) != 0) {
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");
2928 * zpool online <pool> <device> ...
2931 zpool_do_online(int argc, char **argv)
2935 zpool_handle_t *zhp;
2937 vdev_state_t newstate;
2941 while ((c = getopt(argc, argv, "et")) != -1) {
2944 flags |= ZFS_ONLINE_EXPAND;
2948 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2957 /* get pool name and check number of arguments */
2959 (void) fprintf(stderr, gettext("missing pool name\n"));
2963 (void) fprintf(stderr, gettext("missing device name\n"));
2969 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
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"),
2978 if (newstate == VDEV_STATE_FAULTED)
2979 (void) printf(gettext("use 'zpool "
2980 "clear' to restore a faulted "
2983 (void) printf(gettext("use 'zpool "
2984 "replace' to replace devices "
2985 "that are no longer present\n"));
2998 * zpool offline [-ft] <pool> <device> ...
3000 * -f Force the device into the offline state, even if doing
3001 * so would appear to compromise pool availability.
3002 * (not supported yet)
3004 * -t Only take the device off-line temporarily. The offline
3005 * state will not be persistent across reboots.
3009 zpool_do_offline(int argc, char **argv)
3013 zpool_handle_t *zhp;
3015 boolean_t istmp = B_FALSE;
3018 while ((c = getopt(argc, argv, "ft")) != -1) {
3025 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3034 /* get pool name and check number of arguments */
3036 (void) fprintf(stderr, gettext("missing pool name\n"));
3040 (void) fprintf(stderr, gettext("missing device name\n"));
3046 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3049 for (i = 1; i < argc; i++) {
3050 if (zpool_vdev_offline(zhp, argv[i], istmp) != 0)
3060 * zpool clear <pool> [device]
3062 * Clear all errors associated with a pool or a particular device.
3065 zpool_do_clear(int argc, char **argv)
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;
3078 while ((c = getopt(argc, argv, "FnX")) != -1) {
3087 xtreme_rewind = B_TRUE;
3090 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3100 (void) fprintf(stderr, gettext("missing pool name\n"));
3105 (void) fprintf(stderr, gettext("too many arguments\n"));
3109 if ((dryrun || xtreme_rewind) && !do_rewind) {
3110 (void) fprintf(stderr,
3111 gettext("-n or -X only meaningful with -F\n"));
3115 rewind_policy = ZPOOL_TRY_REWIND;
3117 rewind_policy = ZPOOL_DO_REWIND;
3119 rewind_policy |= ZPOOL_EXTREME_REWIND;
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)
3127 device = argc == 2 ? argv[1] : NULL;
3129 if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL) {
3130 nvlist_free(policy);
3134 if (zpool_clear(zhp, device, policy) != 0)
3139 nvlist_free(policy);
3144 typedef struct scrub_cbdata {
3151 scrub_callback(zpool_handle_t *zhp, void *data)
3153 scrub_cbdata_t *cb = data;
3157 * Ignore faulted pools.
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));
3165 err = zpool_scan(zhp, cb->cb_type);
3171 * zpool scrub [-s] <pool> ...
3173 * -s Stop. Stops any in-progress scrub.
3176 zpool_do_scrub(int argc, char **argv)
3181 cb.cb_type = POOL_SCAN_SCRUB;
3184 while ((c = getopt(argc, argv, "s")) != -1) {
3187 cb.cb_type = POOL_SCAN_NONE;
3190 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3202 (void) fprintf(stderr, gettext("missing pool name argument\n"));
3206 return (for_each_pool(argc, argv, B_TRUE, NULL, scrub_callback, &cb));
3209 typedef struct status_cbdata {
3211 boolean_t cb_allpools;
3212 boolean_t cb_verbose;
3213 boolean_t cb_explain;
3215 boolean_t cb_dedup_stats;
3219 * Print out detailed scrub status.
3222 print_scan_status(pool_scan_stat_t *ps)
3225 uint64_t elapsed, mins_left, hours_left;
3226 uint64_t pass_exam, examined, total;
3228 double fraction_done;
3229 char processed_buf[7], examined_buf[7], total_buf[7], rate_buf[7];
3231 (void) printf(gettext(" scan: "));
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"));
3240 start = ps->pss_start_time;
3241 end = ps->pss_end_time;
3242 zfs_nicenum(ps->pss_processed, processed_buf, sizeof (processed_buf));
3244 assert(ps->pss_func == POOL_SCAN_SCRUB ||
3245 ps->pss_func == POOL_SCAN_RESILVER);
3247 * Scan is finished or canceled.
3249 if (ps->pss_state == DSS_FINISHED) {
3250 uint64_t minutes_taken = (end - start) / 60;
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");
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));
3267 } else if (ps->pss_state == DSS_CANCELED) {
3268 if (ps->pss_func == POOL_SCAN_SCRUB) {
3269 (void) printf(gettext("scrub canceled on %s"),
3271 } else if (ps->pss_func == POOL_SCAN_RESILVER) {
3272 (void) printf(gettext("resilver canceled on %s"),
3278 assert(ps->pss_state == DSS_SCANNING);
3281 * Scan is in progress.
3283 if (ps->pss_func == POOL_SCAN_SCRUB) {
3284 (void) printf(gettext("scrub in progress since %s"),
3286 } else if (ps->pss_func == POOL_SCAN_RESILVER) {
3287 (void) printf(gettext("resilver in progress since %s"),
3291 examined = ps->pss_examined ? ps->pss_examined : 1;
3292 total = ps->pss_to_examine;
3293 fraction_done = (double)examined / total;
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;
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));
3309 * do not print estimated time if hours_left is more than 30 days
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));
3317 (void) printf(gettext(
3318 ", (scan is slow, no estimated time)\n"));
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);
3331 print_error_log(zpool_handle_t *zhp)
3333 nvlist_t *nverrlist = NULL;
3336 size_t len = MAXPATHLEN * 2;
3338 if (zpool_get_errlog(zhp, &nverrlist) != 0) {
3339 (void) printf("errors: List of errors unavailable "
3340 "(insufficient privileges)\n");
3344 (void) printf("errors: Permanent errors have been "
3345 "detected in the following files:\n\n");
3347 pathname = safe_malloc(len);
3349 while ((elem = nvlist_next_nvpair(nverrlist, elem)) != NULL) {
3351 uint64_t dsobj, obj;
3353 verify(nvpair_value_nvlist(elem, &nv) == 0);
3354 verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_DATASET,
3356 verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_OBJECT,
3358 zpool_obj_to_path(zhp, dsobj, obj, pathname, len);
3359 (void) printf("%7s %s\n", "", pathname);
3362 nvlist_free(nverrlist);
3366 print_spares(zpool_handle_t *zhp, nvlist_t **spares, uint_t nspares,
3375 (void) printf(gettext("\tspares\n"));
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);
3386 print_l2cache(zpool_handle_t *zhp, nvlist_t **l2cache, uint_t nl2cache,
3395 (void) printf(gettext("\tcache\n"));
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);
3406 print_dedup_stats(nvlist_t *config)
3408 ddt_histogram_t *ddh;
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.
3418 if (nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_OBJ_STATS,
3419 (uint64_t **)&ddo, &c) != 0 || ddo->ddo_count == 0)
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);
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);
3436 * Display a summary of pool status. Displays a summary such as:
3440 * reason: One or more devices ...
3441 * see: http://www.sun.com/msg/ZFS-xxxx-01
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.
3451 status_callback(zpool_handle_t *zhp, void *data)
3453 status_cbdata_t *cbp = data;
3454 nvlist_t *config, *nvroot;
3461 config = zpool_get_config(zhp, NULL);
3462 reason = zpool_get_status(zhp, &msgid);
3467 * If we were given 'zpool status -x', only report those pools with
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));
3475 cbp->cb_first = B_FALSE;
3481 cbp->cb_first = B_FALSE;
3483 (void) printf("\n");
3485 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
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);
3491 (void) printf(gettext(" pool: %s\n"), zpool_get_name(zhp));
3492 (void) printf(gettext(" state: %s\n"), health);
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"));
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"));
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"));
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);
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 "
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 "
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 "
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 "
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 "
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 "
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);
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"));
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 "
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"));
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 "
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"));
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"));
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"));
3643 * The remaining errors can't actually be generated, yet.
3645 assert(reason == ZPOOL_STATUS_OK);
3649 (void) printf(gettext(" see: http://www.sun.com/msg/%s\n"),
3652 if (config != NULL) {
3655 nvlist_t **spares, **l2cache;
3656 uint_t nspares, nl2cache;
3657 pool_scan_stat_t *ps = NULL;
3659 (void) nvlist_lookup_uint64_array(nvroot,
3660 ZPOOL_CONFIG_SCAN_STATS, (uint64_t **)&ps, &c);
3661 print_scan_status(ps);
3663 namewidth = max_width(zhp, nvroot, 0, 0);
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);
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);
3679 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES,
3680 &spares, &nspares) == 0)
3681 print_spares(zhp, spares, nspares, namewidth);
3683 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_ERRCOUNT,
3685 nvlist_t *nverrlist = NULL;
3688 * If the approximate error count is small, get a
3689 * precise count by fetching the entire log and
3690 * uniquifying the results.
3692 if (nerr > 0 && nerr < 100 && !cbp->cb_verbose &&
3693 zpool_get_errlog(zhp, &nverrlist) == 0) {
3698 while ((elem = nvlist_next_nvpair(nverrlist,
3703 nvlist_free(nverrlist);
3705 (void) printf("\n");
3708 (void) printf(gettext("errors: No known data "
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);
3715 print_error_log(zhp);
3718 if (cbp->cb_dedup_stats)
3719 print_dedup_stats(config);
3721 (void) printf(gettext("config: The configuration cannot be "
3729 * zpool status [-vx] [-T d|u] [pool] ... [interval [count]]
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
3736 * Describes the health status of all pools or some subset.
3739 zpool_do_status(int argc, char **argv)
3743 unsigned long interval = 0, count = 0;
3744 status_cbdata_t cb = { 0 };
3747 while ((c = getopt(argc, argv, "vxDT:")) != -1) {
3750 cb.cb_verbose = B_TRUE;
3753 cb.cb_explain = B_TRUE;
3756 cb.cb_dedup_stats = B_TRUE;
3759 get_timestamp_arg(*optarg);
3762 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3771 get_interval_count(&argc, argv, &interval, &count);
3774 cb.cb_allpools = B_TRUE;
3776 cb.cb_first = B_TRUE;
3779 if (timestamp_fmt != NODATE)
3780 print_timestamp(timestamp_fmt);
3782 ret = for_each_pool(argc, argv, B_TRUE, NULL,
3783 status_callback, &cb);
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"));
3796 if (count != 0 && --count == 0)
3799 (void) sleep(interval);
3805 typedef struct upgrade_cbdata {
3810 uint64_t cb_version;
3815 upgrade_cb(zpool_handle_t *zhp, void *arg)
3817 upgrade_cbdata_t *cbp = arg;
3822 config = zpool_get_config(zhp, NULL);
3823 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
3826 if (!cbp->cb_newer && version < SPA_VERSION) {
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 "
3834 (void) printf(gettext("VER POOL\n"));
3835 (void) printf(gettext("--- ------------\n"));
3836 cbp->cb_first = B_FALSE;
3839 (void) printf("%2llu %s\n", (u_longlong_t)version,
3840 zpool_get_name(zhp));
3842 cbp->cb_first = B_FALSE;
3843 ret = zpool_upgrade(zhp, cbp->cb_version);
3845 (void) printf(gettext("Successfully upgraded "
3846 "'%s'\n\n"), zpool_get_name(zhp));
3849 } else if (cbp->cb_newer && version > SPA_VERSION) {
3850 assert(!cbp->cb_all);
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;
3861 (void) printf("%2llu %s\n", (u_longlong_t)version,
3862 zpool_get_name(zhp));
3871 upgrade_one(zpool_handle_t *zhp, void *data)
3873 upgrade_cbdata_t *cbp = data;
3874 uint64_t cur_version;
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"
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);
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));
3897 ret = zpool_upgrade(zhp, cbp->cb_version);
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);
3912 * zpool upgrade [-V version] <-a | pool ...>
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.
3919 zpool_do_upgrade(int argc, char **argv)
3922 upgrade_cbdata_t cb = { 0 };
3924 boolean_t showversions = B_FALSE;
3929 while ((c = getopt(argc, argv, ":avV:")) != -1) {
3935 showversions = B_TRUE;
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);
3947 (void) fprintf(stderr, gettext("missing argument for "
3948 "'%c' option\n"), optopt);
3952 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
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"));
3972 if (cb.cb_all || argc != 0) {
3973 (void) fprintf(stderr, gettext("-v option is "
3974 "incompatible with other arguments\n"));
3977 } else if (cb.cb_all) {
3979 (void) fprintf(stderr, gettext("-a option should not "
3980 "be used along with a pool name\n"));
3985 (void) printf(gettext("This system is currently running "
3986 "ZFS pool version %llu.\n\n"), SPA_VERSION);
3987 cb.cb_first = B_TRUE;
3989 (void) printf(gettext("The following versions are "
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 "
3999 (void) printf(gettext(" 4 zpool history\n"));
4000 (void) printf(gettext(" 5 Compression using the gzip "
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 "
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 "
4026 (void) printf(gettext(" 27 Improved snapshot creation "
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) {
4035 ret = zpool_iter(g_zfs, upgrade_cb, &cb);
4036 notfound = cb.cb_first;
4038 if (!cb.cb_all && ret == 0) {
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);
4046 (void) printf("\n");
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"));
4060 ret = for_each_pool(argc, argv, B_FALSE, NULL,
4067 typedef struct hist_cbdata {
4074 * Print out the command history for a specific pool.
4077 get_history_one(zpool_handle_t *zhp, void *data)
4093 char internalstr[MAXPATHLEN];
4094 hist_cbdata_t *cb = (hist_cbdata_t *)data;
4098 cb->first = B_FALSE;
4100 (void) printf(gettext("History for '%s':\n"), zpool_get_name(zhp));
4102 if ((ret = zpool_get_history(zhp, &nvhis)) != 0)
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,
4112 /* is it an internal event or a standard event? */
4113 if (nvlist_lookup_string(records[i], ZPOOL_HIST_CMD,
4115 if (cb->internal == 0)
4118 if (nvlist_lookup_uint64(records[i],
4119 ZPOOL_HIST_INT_EVENT, &ievent) != 0)
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)
4127 (void) snprintf(internalstr,
4128 sizeof (internalstr),
4129 "[internal %s txg:%llu] %s",
4130 zfs_history_event_names[ievent], (u_longlong_t)txg,
4132 cmdstr = internalstr;
4135 (void) localtime_r(&tsec, &t);
4136 (void) strftime(tbuf, sizeof (tbuf), "%F.%T", &t);
4137 (void) printf("%s %s", tbuf, cmdstr);
4140 (void) printf("\n");
4143 (void) printf(" [");
4144 if (nvlist_lookup_uint64(records[i],
4145 ZPOOL_HIST_WHO, &who) == 0) {
4146 pwd = getpwuid((uid_t)who);
4148 (void) printf("user %s on",
4151 (void) printf("user %d on",
4154 (void) printf(gettext("no info]\n"));
4157 if (nvlist_lookup_string(records[i],
4158 ZPOOL_HIST_HOST, &hostname) == 0) {
4159 (void) printf(" %s", hostname);
4161 if (nvlist_lookup_string(records[i],
4162 ZPOOL_HIST_ZONE, &zonename) == 0) {
4163 (void) printf(":%s", zonename);
4167 (void) printf("\n");
4169 (void) printf("\n");
4176 * zpool history <pool>
4178 * Displays the history of commands that modified pools.
4183 zpool_do_history(int argc, char **argv)
4185 hist_cbdata_t cbdata = { 0 };
4189 cbdata.first = B_TRUE;
4191 while ((c = getopt(argc, argv, "li")) != -1) {
4197 cbdata.internal = 1;
4200 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
4208 ret = for_each_pool(argc, argv, B_FALSE, NULL, get_history_one,
4211 if (argc == 0 && cbdata.first == B_TRUE) {
4212 (void) printf(gettext("no pools available\n"));
4219 typedef struct ev_opts {
4227 zpool_do_events_short(nvlist_t *nvl)
4229 char ctime_str[26], str[32], *ptr;
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);
4242 verify(nvlist_lookup_string(nvl, FM_CLASS, &ptr) == 0);
4243 (void) printf(gettext("%s\n"), ptr);
4247 zpool_do_events_nvprint(nvlist_t *nvl, int depth)
4251 for (nvp = nvlist_next_nvpair(nvl, NULL);
4252 nvp != NULL; nvp = nvlist_next_nvpair(nvl, nvp)) {
4254 data_type_t type = nvpair_type(nvp);
4255 const char *name = nvpair_name(nvp);
4265 printf(gettext("%*s%s = "), depth, "", name);
4268 case DATA_TYPE_BOOLEAN:
4269 printf(gettext("%s"), "1");
4272 case DATA_TYPE_BOOLEAN_VALUE:
4273 (void) nvpair_value_boolean_value(nvp, &b);
4274 printf(gettext("%s"), b ? "1" : "0");
4277 case DATA_TYPE_BYTE:
4278 (void) nvpair_value_byte(nvp, &i8);
4279 printf(gettext("0x%x"), i8);
4282 case DATA_TYPE_INT8:
4283 (void) nvpair_value_int8(nvp, (void *)&i8);
4284 printf(gettext("0x%x"), i8);
4287 case DATA_TYPE_UINT8:
4288 (void) nvpair_value_uint8(nvp, &i8);
4289 printf(gettext("0x%x"), i8);
4292 case DATA_TYPE_INT16:
4293 (void) nvpair_value_int16(nvp, (void *)&i16);
4294 printf(gettext("0x%x"), i16);
4297 case DATA_TYPE_UINT16:
4298 (void) nvpair_value_uint16(nvp, &i16);
4299 printf(gettext("0x%x"), i16);
4302 case DATA_TYPE_INT32:
4303 (void) nvpair_value_int32(nvp, (void *)&i32);
4304 printf(gettext("0x%x"), i32);
4307 case DATA_TYPE_UINT32:
4308 (void) nvpair_value_uint32(nvp, &i32);
4309 printf(gettext("0x%x"), i32);
4312 case DATA_TYPE_INT64:
4313 (void) nvpair_value_int64(nvp, (void *)&i64);
4314 printf(gettext("0x%llx"), (u_longlong_t)i64);
4317 case DATA_TYPE_UINT64:
4318 (void) nvpair_value_uint64(nvp, &i64);
4319 printf(gettext("0x%llx"), (u_longlong_t)i64);
4322 case DATA_TYPE_HRTIME:
4323 (void) nvpair_value_hrtime(nvp, (void *)&i64);
4324 printf(gettext("0x%llx"), (u_longlong_t)i64);
4327 case DATA_TYPE_STRING:
4328 (void) nvpair_value_string(nvp, &str);
4329 printf(gettext("\"%s\""), str ? str : "<NULL>");
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);
4339 case DATA_TYPE_NVLIST_ARRAY: {
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);
4352 printf(gettext("%*s(end %s)\n"), depth, "", name);
4356 case DATA_TYPE_INT8_ARRAY: {
4360 (void) nvpair_value_int8_array(nvp, &val, &nelem);
4361 for (i = 0; i < nelem; i++)
4362 printf(gettext("0x%x "), val[i]);
4367 case DATA_TYPE_UINT8_ARRAY: {
4371 (void) nvpair_value_uint8_array(nvp, &val, &nelem);
4372 for (i = 0; i < nelem; i++)
4373 printf(gettext("0x%x "), val[i]);
4378 case DATA_TYPE_INT16_ARRAY: {
4382 (void) nvpair_value_int16_array(nvp, &val, &nelem);
4383 for (i = 0; i < nelem; i++)
4384 printf(gettext("0x%x "), val[i]);
4389 case DATA_TYPE_UINT16_ARRAY: {
4393 (void) nvpair_value_uint16_array(nvp, &val, &nelem);
4394 for (i = 0; i < nelem; i++)
4395 printf(gettext("0x%x "), val[i]);
4400 case DATA_TYPE_INT32_ARRAY: {
4404 (void) nvpair_value_int32_array(nvp, &val, &nelem);
4405 for (i = 0; i < nelem; i++)
4406 printf(gettext("0x%x "), val[i]);
4411 case DATA_TYPE_UINT32_ARRAY: {
4415 (void) nvpair_value_uint32_array(nvp, &val, &nelem);
4416 for (i = 0; i < nelem; i++)
4417 printf(gettext("0x%x "), val[i]);
4422 case DATA_TYPE_INT64_ARRAY: {
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]);
4433 case DATA_TYPE_UINT64_ARRAY: {
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]);
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>"));
4453 printf(gettext("\n"));
4458 zpool_do_events_next(ev_opts_t *opts)
4461 int cleanup_fd, ret, dropped;
4463 cleanup_fd = open(ZFS_DEV, O_RDWR);
4464 VERIFY(cleanup_fd >= 0);
4466 if (!opts->scripted)
4467 (void) printf(gettext("%-30s %s\n"), "TIME", "CLASS");
4470 ret = zpool_events_next(g_zfs, &nvl, &dropped,
4471 !!opts->follow, cleanup_fd);
4472 if (ret || nvl == NULL)
4476 (void) printf(gettext("dropped %d events\n"), dropped);
4478 zpool_do_events_short(nvl);
4480 if (opts->verbose) {
4481 zpool_do_events_nvprint(nvl, 8);
4482 printf(gettext("\n"));
4488 VERIFY(0 == close(cleanup_fd));
4494 zpool_do_events_clear(ev_opts_t *opts)
4498 ret = zpool_events_clear(g_zfs, &count);
4500 (void) printf(gettext("cleared %d events\n"), count);
4506 * zpool events [-vfc]
4508 * Displays events logs by ZFS.
4511 zpool_do_events(int argc, char **argv)
4513 ev_opts_t opts = { 0 };
4518 while ((c = getopt(argc, argv, "vHfc")) != -1) {
4533 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
4542 ret = zpool_do_events_clear(&opts);
4544 ret = zpool_do_events_next(&opts);
4550 get_callback(zpool_handle_t *zhp, void *data)
4552 zprop_get_cbdata_t *cbp = (zprop_get_cbdata_t *)data;
4553 char value[MAXNAMELEN];
4554 zprop_source_t srctype;
4557 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
4560 * Skip the special fake placeholder. This will also skip
4561 * over the name property when 'all' is specified.
4563 if (pl->pl_prop == ZPOOL_PROP_NAME &&
4564 pl == cbp->cb_proplist)
4567 if (zpool_get_prop(zhp, pl->pl_prop,
4568 value, sizeof (value), &srctype) != 0)
4571 zprop_print_one_property(zpool_get_name(zhp), cbp,
4572 zpool_prop_to_name(pl->pl_prop), value, srctype, NULL,
4579 zpool_do_get(int argc, char **argv)
4581 zprop_get_cbdata_t cb = { 0 };
4582 zprop_list_t fake_name = { 0 };
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;
4596 if (zprop_get_list(g_zfs, argv[1], &cb.cb_proplist,
4597 ZFS_TYPE_POOL) != 0)
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;
4607 ret = for_each_pool(argc - 2, argv + 2, B_TRUE, &cb.cb_proplist,
4610 if (cb.cb_proplist == &fake_name)
4611 zprop_free_list(fake_name.pl_next);
4613 zprop_free_list(cb.cb_proplist);
4618 typedef struct set_cbdata {
4621 boolean_t cb_any_successful;
4625 set_callback(zpool_handle_t *zhp, void *data)
4628 set_cbdata_t *cb = (set_cbdata_t *)data;
4630 error = zpool_set_prop(zhp, cb->cb_propname, cb->cb_value);
4633 cb->cb_any_successful = B_TRUE;
4639 zpool_do_set(int argc, char **argv)
4641 set_cbdata_t cb = { 0 };
4644 if (argc > 1 && argv[1][0] == '-') {
4645 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
4651 (void) fprintf(stderr, gettext("missing property=value "
4657 (void) fprintf(stderr, gettext("missing pool name\n"));
4662 (void) fprintf(stderr, gettext("too many pool names\n"));
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"));
4674 *(cb.cb_value) = '\0';
4677 error = for_each_pool(argc - 2, argv + 2, B_TRUE, NULL,
4684 find_command_idx(char *command, int *idx)
4688 for (i = 0; i < NCOMMAND; i++) {
4689 if (command_table[i].name == NULL)
4692 if (strcmp(command, command_table[i].name) == 0) {
4701 main(int argc, char **argv)
4707 (void) setlocale(LC_ALL, "");
4708 (void) textdomain(TEXT_DOMAIN);
4713 * Make sure the user has specified some command.
4716 (void) fprintf(stderr, gettext("missing command\n"));
4725 if ((strcmp(cmdname, "-?") == 0) ||
4726 strcmp(cmdname, "--help") == 0)
4729 if ((g_zfs = libzfs_init()) == NULL)
4732 libzfs_print_on_error(g_zfs, B_TRUE);
4734 zpool_set_history_str("zpool", argc, argv, history_str);
4735 verify(zpool_stage_history(g_zfs, history_str) == 0);
4738 * Run the appropriate command.
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) {
4749 * 'freeze' is a vile debugging abomination, so we treat
4753 int fd = open(ZFS_DEV, O_RDWR);
4754 (void) strcpy((void *)buf, argv[2]);
4755 return (!!ioctl(fd, ZFS_IOC_POOL_FREEZE, buf));
4757 (void) fprintf(stderr, gettext("unrecognized "
4758 "command '%s'\n"), cmdname);
4766 * The 'ZFS_ABORT' environment variable causes us to dump core on exit
4767 * for the purposes of running ::findleaks.
4769 if (getenv("ZFS_ABORT") != NULL) {
4770 (void) printf("dumping core by request\n");