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.
24 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
25 * Copyright (c) 2011 by Delphix. All rights reserved.
26 * Copyright (c) 2012 by Frederik Wessels. All rights reserved.
46 #include <sys/fs/zfs.h>
48 #include <sys/fm/util.h>
49 #include <sys/fm/protocol.h>
53 #include "zpool_util.h"
54 #include "zfs_comutil.h"
56 #include "statcommon.h"
58 static int zpool_do_create(int, char **);
59 static int zpool_do_destroy(int, char **);
61 static int zpool_do_add(int, char **);
62 static int zpool_do_remove(int, char **);
64 static int zpool_do_list(int, char **);
65 static int zpool_do_iostat(int, char **);
66 static int zpool_do_status(int, char **);
68 static int zpool_do_online(int, char **);
69 static int zpool_do_offline(int, char **);
70 static int zpool_do_clear(int, char **);
72 static int zpool_do_reguid(int, char **);
74 static int zpool_do_attach(int, char **);
75 static int zpool_do_detach(int, char **);
76 static int zpool_do_replace(int, char **);
77 static int zpool_do_split(int, char **);
79 static int zpool_do_scrub(int, char **);
81 static int zpool_do_import(int, char **);
82 static int zpool_do_export(int, char **);
84 static int zpool_do_upgrade(int, char **);
86 static int zpool_do_history(int, char **);
87 static int zpool_do_events(int, char **);
89 static int zpool_do_get(int, char **);
90 static int zpool_do_set(int, char **);
93 * These libumem hooks provide a reasonable set of defaults for the allocator's
94 * debugging facilities.
99 _umem_debug_init(void)
101 return ("default,verbose"); /* $UMEM_DEBUG setting */
105 _umem_logging_init(void)
107 return ("fail,contents"); /* $UMEM_LOGGING setting */
138 typedef struct zpool_command {
140 int (*func)(int, char **);
145 * Master command table. Each ZFS command has a name, associated function, and
146 * usage message. The usage messages need to be internationalized, so we have
147 * to have a function to return the usage message based on a command index.
149 * These commands are organized according to how they are displayed in the usage
150 * message. An empty command (one with a NULL name) indicates an empty line in
151 * the generic usage message.
153 static zpool_command_t command_table[] = {
154 { "create", zpool_do_create, HELP_CREATE },
155 { "destroy", zpool_do_destroy, HELP_DESTROY },
157 { "add", zpool_do_add, HELP_ADD },
158 { "remove", zpool_do_remove, HELP_REMOVE },
160 { "list", zpool_do_list, HELP_LIST },
161 { "iostat", zpool_do_iostat, HELP_IOSTAT },
162 { "status", zpool_do_status, HELP_STATUS },
164 { "online", zpool_do_online, HELP_ONLINE },
165 { "offline", zpool_do_offline, HELP_OFFLINE },
166 { "clear", zpool_do_clear, HELP_CLEAR },
168 { "attach", zpool_do_attach, HELP_ATTACH },
169 { "detach", zpool_do_detach, HELP_DETACH },
170 { "replace", zpool_do_replace, HELP_REPLACE },
171 { "split", zpool_do_split, HELP_SPLIT },
173 { "scrub", zpool_do_scrub, HELP_SCRUB },
175 { "import", zpool_do_import, HELP_IMPORT },
176 { "export", zpool_do_export, HELP_EXPORT },
177 { "upgrade", zpool_do_upgrade, HELP_UPGRADE },
178 { "reguid", zpool_do_reguid, HELP_REGUID },
180 { "history", zpool_do_history, HELP_HISTORY },
181 { "events", zpool_do_events, HELP_EVENTS },
183 { "get", zpool_do_get, HELP_GET },
184 { "set", zpool_do_set, HELP_SET },
187 #define NCOMMAND (sizeof (command_table) / sizeof (command_table[0]))
189 zpool_command_t *current_command;
190 static char history_str[HIS_MAX_RECORD_LEN];
192 static uint_t timestamp_fmt = NODATE;
195 get_usage(zpool_help_t idx) {
198 return (gettext("\tadd [-fn] <pool> <vdev> ...\n"));
200 return (gettext("\tattach [-f] <pool> <device> "
203 return (gettext("\tclear [-nF] <pool> [device]\n"));
205 return (gettext("\tcreate [-fn] [-o property=value] ... \n"
206 "\t [-O file-system-property=value] ... \n"
207 "\t [-m mountpoint] [-R root] <pool> <vdev> ...\n"));
209 return (gettext("\tdestroy [-f] <pool>\n"));
211 return (gettext("\tdetach <pool> <device>\n"));
213 return (gettext("\texport [-f] <pool> ...\n"));
215 return (gettext("\thistory [-il] [<pool>] ...\n"));
217 return (gettext("\timport [-d dir] [-D]\n"
218 "\timport [-d dir | -c cachefile] [-F [-n]] <pool | id>\n"
219 "\timport [-o mntopts] [-o property=value] ... \n"
220 "\t [-d dir | -c cachefile] [-D] [-f] [-m] [-N] "
221 "[-R root] [-F [-n]] -a\n"
222 "\timport [-o mntopts] [-o property=value] ... \n"
223 "\t [-d dir | -c cachefile] [-D] [-f] [-m] [-N] "
224 "[-R root] [-F [-n]]\n"
225 "\t <pool | id> [newpool]\n"));
227 return (gettext("\tiostat [-v] [-T d|u] [pool] ... [interval "
230 return (gettext("\tlist [-H] [-o property[,...]] "
231 "[-T d|u] [pool] ... [interval [count]]\n"));
233 return (gettext("\toffline [-t] <pool> <device> ...\n"));
235 return (gettext("\tonline <pool> <device> ...\n"));
237 return (gettext("\treplace [-f] <pool> <device> "
240 return (gettext("\tremove <pool> <device> ...\n"));
242 return (gettext("\tscrub [-s] <pool> ...\n"));
244 return (gettext("\tstatus [-vx] [-T d|u] [pool] ... [interval "
247 return (gettext("\tupgrade\n"
249 "\tupgrade [-V version] <-a | pool ...>\n"));
251 return (gettext("\tevents [-vHfc]\n"));
253 return (gettext("\tget <\"all\" | property[,...]> "
256 return (gettext("\tset <property=value> <pool> \n"));
258 return (gettext("\tsplit [-n] [-R altroot] [-o mntopts]\n"
259 "\t [-o property=value] <pool> <newpool> "
260 "[<device> ...]\n"));
262 return (gettext("\treguid <pool>\n"));
271 * Callback routine that will print out a pool property value.
274 print_prop_cb(int prop, void *cb)
278 (void) fprintf(fp, "\t%-15s ", zpool_prop_to_name(prop));
280 if (zpool_prop_readonly(prop))
281 (void) fprintf(fp, " NO ");
283 (void) fprintf(fp, " YES ");
285 if (zpool_prop_values(prop) == NULL)
286 (void) fprintf(fp, "-\n");
288 (void) fprintf(fp, "%s\n", zpool_prop_values(prop));
294 * Display usage message. If we're inside a command, display only the usage for
295 * that command. Otherwise, iterate over the entire command table and display
296 * a complete usage message.
299 usage(boolean_t requested)
301 FILE *fp = requested ? stdout : stderr;
303 if (current_command == NULL) {
306 (void) fprintf(fp, gettext("usage: zpool command args ...\n"));
308 gettext("where 'command' is one of the following:\n\n"));
310 for (i = 0; i < NCOMMAND; i++) {
311 if (command_table[i].name == NULL)
312 (void) fprintf(fp, "\n");
314 (void) fprintf(fp, "%s",
315 get_usage(command_table[i].usage));
318 (void) fprintf(fp, gettext("usage:\n"));
319 (void) fprintf(fp, "%s", get_usage(current_command->usage));
322 if (current_command != NULL &&
323 ((strcmp(current_command->name, "set") == 0) ||
324 (strcmp(current_command->name, "get") == 0) ||
325 (strcmp(current_command->name, "list") == 0))) {
328 gettext("\nthe following properties are supported:\n"));
330 (void) fprintf(fp, "\n\t%-15s %s %s\n\n",
331 "PROPERTY", "EDIT", "VALUES");
333 /* Iterate over all properties */
334 (void) zprop_iter(print_prop_cb, fp, B_FALSE, B_TRUE,
339 * See comments at end of main().
341 if (getenv("ZFS_ABORT") != NULL) {
342 (void) printf("dumping core by request\n");
346 exit(requested ? 0 : 2);
350 print_vdev_tree(zpool_handle_t *zhp, const char *name, nvlist_t *nv, int indent,
351 boolean_t print_logs)
358 (void) printf("\t%*s%s\n", indent, "", name);
360 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
361 &child, &children) != 0)
364 for (c = 0; c < children; c++) {
365 uint64_t is_log = B_FALSE;
367 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
369 if ((is_log && !print_logs) || (!is_log && print_logs))
372 vname = zpool_vdev_name(g_zfs, zhp, child[c], B_FALSE);
373 print_vdev_tree(zhp, vname, child[c], indent + 2,
380 * Add a property pair (name, string-value) into a property nvlist.
383 add_prop_list(const char *propname, char *propval, nvlist_t **props,
386 zpool_prop_t prop = ZPROP_INVAL;
392 if (*props == NULL &&
393 nvlist_alloc(props, NV_UNIQUE_NAME, 0) != 0) {
394 (void) fprintf(stderr,
395 gettext("internal error: out of memory\n"));
402 if ((prop = zpool_name_to_prop(propname)) == ZPROP_INVAL) {
403 (void) fprintf(stderr, gettext("property '%s' is "
404 "not a valid pool property\n"), propname);
407 normnm = zpool_prop_to_name(prop);
409 if ((fprop = zfs_name_to_prop(propname)) != ZPROP_INVAL) {
410 normnm = zfs_prop_to_name(fprop);
416 if (nvlist_lookup_string(proplist, normnm, &strval) == 0 &&
417 prop != ZPOOL_PROP_CACHEFILE) {
418 (void) fprintf(stderr, gettext("property '%s' "
419 "specified multiple times\n"), propname);
423 if (nvlist_add_string(proplist, normnm, propval) != 0) {
424 (void) fprintf(stderr, gettext("internal "
425 "error: out of memory\n"));
433 * zpool add [-fn] <pool> <vdev> ...
435 * -f Force addition of devices, even if they appear in use
436 * -n Do not add the devices, but display the resulting layout if
437 * they were to be added.
439 * Adds the given vdevs to 'pool'. As with create, the bulk of this work is
440 * handled by get_vdev_spec(), which constructs the nvlist needed to pass to
444 zpool_do_add(int argc, char **argv)
446 boolean_t force = B_FALSE;
447 boolean_t dryrun = B_FALSE;
456 while ((c = getopt(argc, argv, "fn")) != -1) {
465 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
474 /* get pool name and check number of arguments */
476 (void) fprintf(stderr, gettext("missing pool name argument\n"));
480 (void) fprintf(stderr, gettext("missing vdev specification\n"));
489 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
492 if ((config = zpool_get_config(zhp, NULL)) == NULL) {
493 (void) fprintf(stderr, gettext("pool '%s' is unavailable\n"),
499 /* pass off to get_vdev_spec for processing */
500 nvroot = make_root_vdev(zhp, NULL, force, !force, B_FALSE, dryrun,
502 if (nvroot == NULL) {
508 nvlist_t *poolnvroot;
510 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
513 (void) printf(gettext("would update '%s' to the following "
514 "configuration:\n"), zpool_get_name(zhp));
516 /* print original main pool and new tree */
517 print_vdev_tree(zhp, poolname, poolnvroot, 0, B_FALSE);
518 print_vdev_tree(zhp, NULL, nvroot, 0, B_FALSE);
520 /* Do the same for the logs */
521 if (num_logs(poolnvroot) > 0) {
522 print_vdev_tree(zhp, "logs", poolnvroot, 0, B_TRUE);
523 print_vdev_tree(zhp, NULL, nvroot, 0, B_TRUE);
524 } else if (num_logs(nvroot) > 0) {
525 print_vdev_tree(zhp, "logs", nvroot, 0, B_TRUE);
530 ret = (zpool_add(zhp, nvroot) != 0);
540 * zpool remove <pool> <vdev> ...
542 * Removes the given vdev from the pool. Currently, this supports removing
543 * spares, cache, and log devices from the pool.
546 zpool_do_remove(int argc, char **argv)
555 /* get pool name and check number of arguments */
557 (void) fprintf(stderr, gettext("missing pool name argument\n"));
561 (void) fprintf(stderr, gettext("missing device\n"));
567 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
570 for (i = 1; i < argc; i++) {
571 if (zpool_vdev_remove(zhp, argv[i]) != 0)
579 * zpool create [-fn] [-o property=value] ...
580 * [-O file-system-property=value] ...
581 * [-R root] [-m mountpoint] <pool> <dev> ...
583 * -f Force creation, even if devices appear in use
584 * -n Do not create the pool, but display the resulting layout if it
585 * were to be created.
586 * -R Create a pool under an alternate root
587 * -m Set default mountpoint for the root dataset. By default it's
589 * -o Set property=value.
590 * -O Set fsproperty=value in the pool's root file system
592 * Creates the named pool according to the given vdev specification. The
593 * bulk of the vdev processing is done in get_vdev_spec() in zpool_vdev.c. Once
594 * we get the nvlist back from get_vdev_spec(), we either print out the contents
595 * (if '-n' was specified), or pass it to libzfs to do the creation.
598 zpool_do_create(int argc, char **argv)
600 boolean_t force = B_FALSE;
601 boolean_t dryrun = B_FALSE;
603 nvlist_t *nvroot = NULL;
606 char *altroot = NULL;
607 char *mountpoint = NULL;
608 nvlist_t *fsprops = NULL;
609 nvlist_t *props = NULL;
613 while ((c = getopt(argc, argv, ":fnR:m:o:O:")) != -1) {
623 if (add_prop_list(zpool_prop_to_name(
624 ZPOOL_PROP_ALTROOT), optarg, &props, B_TRUE))
626 if (nvlist_lookup_string(props,
627 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE),
630 if (add_prop_list(zpool_prop_to_name(
631 ZPOOL_PROP_CACHEFILE), "none", &props, B_TRUE))
638 if ((propval = strchr(optarg, '=')) == NULL) {
639 (void) fprintf(stderr, gettext("missing "
640 "'=' for -o option\n"));
646 if (add_prop_list(optarg, propval, &props, B_TRUE))
650 if ((propval = strchr(optarg, '=')) == NULL) {
651 (void) fprintf(stderr, gettext("missing "
652 "'=' for -O option\n"));
658 if (add_prop_list(optarg, propval, &fsprops, B_FALSE))
662 (void) fprintf(stderr, gettext("missing argument for "
663 "'%c' option\n"), optopt);
666 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
675 /* get pool name and check number of arguments */
677 (void) fprintf(stderr, gettext("missing pool name argument\n"));
681 (void) fprintf(stderr, gettext("missing vdev specification\n"));
688 * As a special case, check for use of '/' in the name, and direct the
689 * user to use 'zfs create' instead.
691 if (strchr(poolname, '/') != NULL) {
692 (void) fprintf(stderr, gettext("cannot create '%s': invalid "
693 "character '/' in pool name\n"), poolname);
694 (void) fprintf(stderr, gettext("use 'zfs create' to "
695 "create a dataset\n"));
699 /* pass off to get_vdev_spec for bulk processing */
700 nvroot = make_root_vdev(NULL, props, force, !force, B_FALSE, dryrun,
705 /* make_root_vdev() allows 0 toplevel children if there are spares */
706 if (!zfs_allocatable_devs(nvroot)) {
707 (void) fprintf(stderr, gettext("invalid vdev "
708 "specification: at least one toplevel vdev must be "
714 if (altroot != NULL && altroot[0] != '/') {
715 (void) fprintf(stderr, gettext("invalid alternate root '%s': "
716 "must be an absolute path\n"), altroot);
721 * Check the validity of the mountpoint and direct the user to use the
722 * '-m' mountpoint option if it looks like its in use.
724 if (mountpoint == NULL ||
725 (strcmp(mountpoint, ZFS_MOUNTPOINT_LEGACY) != 0 &&
726 strcmp(mountpoint, ZFS_MOUNTPOINT_NONE) != 0)) {
727 char buf[MAXPATHLEN];
730 if (mountpoint && mountpoint[0] != '/') {
731 (void) fprintf(stderr, gettext("invalid mountpoint "
732 "'%s': must be an absolute path, 'legacy', or "
733 "'none'\n"), mountpoint);
737 if (mountpoint == NULL) {
739 (void) snprintf(buf, sizeof (buf), "%s/%s",
742 (void) snprintf(buf, sizeof (buf), "/%s",
746 (void) snprintf(buf, sizeof (buf), "%s%s",
747 altroot, mountpoint);
749 (void) snprintf(buf, sizeof (buf), "%s",
753 if ((dirp = opendir(buf)) == NULL && errno != ENOENT) {
754 (void) fprintf(stderr, gettext("mountpoint '%s' : "
755 "%s\n"), buf, strerror(errno));
756 (void) fprintf(stderr, gettext("use '-m' "
757 "option to provide a different default\n"));
762 while (count < 3 && readdir(dirp) != NULL)
764 (void) closedir(dirp);
767 (void) fprintf(stderr, gettext("mountpoint "
768 "'%s' exists and is not empty\n"), buf);
769 (void) fprintf(stderr, gettext("use '-m' "
770 "option to provide a "
771 "different default\n"));
779 * For a dry run invocation, print out a basic message and run
780 * through all the vdevs in the list and print out in an
781 * appropriate hierarchy.
783 (void) printf(gettext("would create '%s' with the "
784 "following layout:\n\n"), poolname);
786 print_vdev_tree(NULL, poolname, nvroot, 0, B_FALSE);
787 if (num_logs(nvroot) > 0)
788 print_vdev_tree(NULL, "logs", nvroot, 0, B_TRUE);
793 * Hand off to libzfs.
795 if (zpool_create(g_zfs, poolname,
796 nvroot, props, fsprops) == 0) {
797 zfs_handle_t *pool = zfs_open(g_zfs, poolname,
798 ZFS_TYPE_FILESYSTEM);
800 if (mountpoint != NULL)
801 verify(zfs_prop_set(pool,
803 ZFS_PROP_MOUNTPOINT),
805 if (zfs_mount(pool, NULL, 0) == 0)
806 ret = zfs_shareall(pool);
809 } else if (libzfs_errno(g_zfs) == EZFS_INVALIDNAME) {
810 (void) fprintf(stderr, gettext("pool name may have "
817 nvlist_free(fsprops);
821 nvlist_free(fsprops);
828 * zpool destroy <pool>
830 * -f Forcefully unmount any datasets
832 * Destroy the given pool. Automatically unmounts any datasets in the pool.
835 zpool_do_destroy(int argc, char **argv)
837 boolean_t force = B_FALSE;
844 while ((c = getopt(argc, argv, "f")) != -1) {
850 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
859 /* check arguments */
861 (void) fprintf(stderr, gettext("missing pool argument\n"));
865 (void) fprintf(stderr, gettext("too many arguments\n"));
871 if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL) {
873 * As a special case, check for use of '/' in the name, and
874 * direct the user to use 'zfs destroy' instead.
876 if (strchr(pool, '/') != NULL)
877 (void) fprintf(stderr, gettext("use 'zfs destroy' to "
878 "destroy a dataset\n"));
882 if (zpool_disable_datasets(zhp, force) != 0) {
883 (void) fprintf(stderr, gettext("could not destroy '%s': "
884 "could not unmount datasets\n"), zpool_get_name(zhp));
888 ret = (zpool_destroy(zhp) != 0);
896 * zpool export [-f] <pool> ...
898 * -f Forcefully unmount datasets
900 * Export the given pools. By default, the command will attempt to cleanly
901 * unmount any active datasets within the pool. If the '-f' flag is specified,
902 * then the datasets will be forcefully unmounted.
905 zpool_do_export(int argc, char **argv)
907 boolean_t force = B_FALSE;
908 boolean_t hardforce = B_FALSE;
915 while ((c = getopt(argc, argv, "fF")) != -1) {
924 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
933 /* check arguments */
935 (void) fprintf(stderr, gettext("missing pool argument\n"));
940 for (i = 0; i < argc; i++) {
941 if ((zhp = zpool_open_canfail(g_zfs, argv[i])) == NULL) {
946 if (zpool_disable_datasets(zhp, force) != 0) {
953 if (zpool_export_force(zhp) != 0)
955 } else if (zpool_export(zhp, force) != 0) {
966 * Given a vdev configuration, determine the maximum width needed for the device
970 max_width(zpool_handle_t *zhp, nvlist_t *nv, int depth, int max)
972 char *name = zpool_vdev_name(g_zfs, zhp, nv, B_TRUE);
977 if (strlen(name) + depth > max)
978 max = strlen(name) + depth;
982 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_SPARES,
983 &child, &children) == 0) {
984 for (c = 0; c < children; c++)
985 if ((ret = max_width(zhp, child[c], depth + 2,
990 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE,
991 &child, &children) == 0) {
992 for (c = 0; c < children; c++)
993 if ((ret = max_width(zhp, child[c], depth + 2,
998 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
999 &child, &children) == 0) {
1000 for (c = 0; c < children; c++)
1001 if ((ret = max_width(zhp, child[c], depth + 2,
1010 typedef struct spare_cbdata {
1012 zpool_handle_t *cb_zhp;
1016 find_vdev(nvlist_t *nv, uint64_t search)
1022 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &guid) == 0 &&
1026 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1027 &child, &children) == 0) {
1028 for (c = 0; c < children; c++)
1029 if (find_vdev(child[c], search))
1037 find_spare(zpool_handle_t *zhp, void *data)
1039 spare_cbdata_t *cbp = data;
1040 nvlist_t *config, *nvroot;
1042 config = zpool_get_config(zhp, NULL);
1043 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
1046 if (find_vdev(nvroot, cbp->cb_guid)) {
1056 * Print out configuration state as requested by status_callback.
1059 print_status_config(zpool_handle_t *zhp, const char *name, nvlist_t *nv,
1060 int namewidth, int depth, boolean_t isspare)
1064 pool_scan_stat_t *ps = NULL;
1066 char rbuf[6], wbuf[6], cbuf[6];
1068 uint64_t notpresent;
1072 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1073 &child, &children) != 0)
1076 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
1077 (uint64_t **)&vs, &c) == 0);
1079 state = zpool_state_to_name(vs->vs_state, vs->vs_aux);
1082 * For hot spares, we use the terms 'INUSE' and 'AVAILABLE' for
1085 if (vs->vs_aux == VDEV_AUX_SPARED)
1087 else if (vs->vs_state == VDEV_STATE_HEALTHY)
1091 (void) printf("\t%*s%-*s %-8s", depth, "", namewidth - depth,
1095 zfs_nicenum(vs->vs_read_errors, rbuf, sizeof (rbuf));
1096 zfs_nicenum(vs->vs_write_errors, wbuf, sizeof (wbuf));
1097 zfs_nicenum(vs->vs_checksum_errors, cbuf, sizeof (cbuf));
1098 (void) printf(" %5s %5s %5s", rbuf, wbuf, cbuf);
1101 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NOT_PRESENT,
1102 ¬present) == 0) {
1104 verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0);
1105 (void) printf(" was %s", path);
1106 } else if (vs->vs_aux != 0) {
1109 switch (vs->vs_aux) {
1110 case VDEV_AUX_OPEN_FAILED:
1111 (void) printf(gettext("cannot open"));
1114 case VDEV_AUX_BAD_GUID_SUM:
1115 (void) printf(gettext("missing device"));
1118 case VDEV_AUX_NO_REPLICAS:
1119 (void) printf(gettext("insufficient replicas"));
1122 case VDEV_AUX_VERSION_NEWER:
1123 (void) printf(gettext("newer version"));
1126 case VDEV_AUX_SPARED:
1127 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID,
1129 if (zpool_iter(g_zfs, find_spare, &cb) == 1) {
1130 if (strcmp(zpool_get_name(cb.cb_zhp),
1131 zpool_get_name(zhp)) == 0)
1132 (void) printf(gettext("currently in "
1135 (void) printf(gettext("in use by "
1137 zpool_get_name(cb.cb_zhp));
1138 zpool_close(cb.cb_zhp);
1140 (void) printf(gettext("currently in use"));
1144 case VDEV_AUX_ERR_EXCEEDED:
1145 (void) printf(gettext("too many errors"));
1148 case VDEV_AUX_IO_FAILURE:
1149 (void) printf(gettext("experienced I/O failures"));
1152 case VDEV_AUX_BAD_LOG:
1153 (void) printf(gettext("bad intent log"));
1156 case VDEV_AUX_EXTERNAL:
1157 (void) printf(gettext("external device fault"));
1160 case VDEV_AUX_SPLIT_POOL:
1161 (void) printf(gettext("split into new pool"));
1165 (void) printf(gettext("corrupted data"));
1170 (void) nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_SCAN_STATS,
1171 (uint64_t **)&ps, &c);
1173 if (ps && ps->pss_state == DSS_SCANNING &&
1174 vs->vs_scan_processed != 0 && children == 0) {
1175 (void) printf(gettext(" (%s)"),
1176 (ps->pss_func == POOL_SCAN_RESILVER) ?
1177 "resilvering" : "repairing");
1180 (void) printf("\n");
1182 for (c = 0; c < children; c++) {
1183 uint64_t islog = B_FALSE, ishole = B_FALSE;
1185 /* Don't print logs or holes here */
1186 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
1188 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_HOLE,
1190 if (islog || ishole)
1192 vname = zpool_vdev_name(g_zfs, zhp, child[c], B_TRUE);
1193 print_status_config(zhp, vname, child[c],
1194 namewidth, depth + 2, isspare);
1201 * Print the configuration of an exported pool. Iterate over all vdevs in the
1202 * pool, printing out the name and status for each one.
1205 print_import_config(const char *name, nvlist_t *nv, int namewidth, int depth)
1212 verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE, &type) == 0);
1213 if (strcmp(type, VDEV_TYPE_MISSING) == 0 ||
1214 strcmp(type, VDEV_TYPE_HOLE) == 0)
1217 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
1218 (uint64_t **)&vs, &c) == 0);
1220 (void) printf("\t%*s%-*s", depth, "", namewidth - depth, name);
1221 (void) printf(" %s", zpool_state_to_name(vs->vs_state, vs->vs_aux));
1223 if (vs->vs_aux != 0) {
1226 switch (vs->vs_aux) {
1227 case VDEV_AUX_OPEN_FAILED:
1228 (void) printf(gettext("cannot open"));
1231 case VDEV_AUX_BAD_GUID_SUM:
1232 (void) printf(gettext("missing device"));
1235 case VDEV_AUX_NO_REPLICAS:
1236 (void) printf(gettext("insufficient replicas"));
1239 case VDEV_AUX_VERSION_NEWER:
1240 (void) printf(gettext("newer version"));
1243 case VDEV_AUX_ERR_EXCEEDED:
1244 (void) printf(gettext("too many errors"));
1248 (void) printf(gettext("corrupted data"));
1252 (void) printf("\n");
1254 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1255 &child, &children) != 0)
1258 for (c = 0; c < children; c++) {
1259 uint64_t is_log = B_FALSE;
1261 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
1266 vname = zpool_vdev_name(g_zfs, NULL, child[c], B_TRUE);
1267 print_import_config(vname, child[c], namewidth, depth + 2);
1271 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE,
1272 &child, &children) == 0) {
1273 (void) printf(gettext("\tcache\n"));
1274 for (c = 0; c < children; c++) {
1275 vname = zpool_vdev_name(g_zfs, NULL, child[c], B_FALSE);
1276 (void) printf("\t %s\n", vname);
1281 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_SPARES,
1282 &child, &children) == 0) {
1283 (void) printf(gettext("\tspares\n"));
1284 for (c = 0; c < children; c++) {
1285 vname = zpool_vdev_name(g_zfs, NULL, child[c], B_FALSE);
1286 (void) printf("\t %s\n", vname);
1294 * Logs are recorded as top level vdevs in the main pool child array
1295 * but with "is_log" set to 1. We use either print_status_config() or
1296 * print_import_config() to print the top level logs then any log
1297 * children (eg mirrored slogs) are printed recursively - which
1298 * works because only the top level vdev is marked "is_log"
1301 print_logs(zpool_handle_t *zhp, nvlist_t *nv, int namewidth, boolean_t verbose)
1306 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, &child,
1310 (void) printf(gettext("\tlogs\n"));
1312 for (c = 0; c < children; c++) {
1313 uint64_t is_log = B_FALSE;
1316 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
1320 name = zpool_vdev_name(g_zfs, zhp, child[c], B_TRUE);
1322 print_status_config(zhp, name, child[c], namewidth,
1325 print_import_config(name, child[c], namewidth, 2);
1331 * Display the status for the given pool.
1334 show_import(nvlist_t *config)
1336 uint64_t pool_state;
1348 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
1350 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
1352 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
1354 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
1357 verify(nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_VDEV_STATS,
1358 (uint64_t **)&vs, &vsc) == 0);
1359 health = zpool_state_to_name(vs->vs_state, vs->vs_aux);
1361 reason = zpool_import_status(config, &msgid);
1363 (void) printf(gettext(" pool: %s\n"), name);
1364 (void) printf(gettext(" id: %llu\n"), (u_longlong_t)guid);
1365 (void) printf(gettext(" state: %s"), health);
1366 if (pool_state == POOL_STATE_DESTROYED)
1367 (void) printf(gettext(" (DESTROYED)"));
1368 (void) printf("\n");
1371 case ZPOOL_STATUS_MISSING_DEV_R:
1372 case ZPOOL_STATUS_MISSING_DEV_NR:
1373 case ZPOOL_STATUS_BAD_GUID_SUM:
1374 (void) printf(gettext(" status: One or more devices are "
1375 "missing from the system.\n"));
1378 case ZPOOL_STATUS_CORRUPT_LABEL_R:
1379 case ZPOOL_STATUS_CORRUPT_LABEL_NR:
1380 (void) printf(gettext(" status: One or more devices contains "
1381 "corrupted data.\n"));
1384 case ZPOOL_STATUS_CORRUPT_DATA:
1386 gettext(" status: The pool data is corrupted.\n"));
1389 case ZPOOL_STATUS_OFFLINE_DEV:
1390 (void) printf(gettext(" status: One or more devices "
1391 "are offlined.\n"));
1394 case ZPOOL_STATUS_CORRUPT_POOL:
1395 (void) printf(gettext(" status: The pool metadata is "
1399 case ZPOOL_STATUS_VERSION_OLDER:
1400 (void) printf(gettext(" status: The pool is formatted using an "
1401 "older on-disk version.\n"));
1404 case ZPOOL_STATUS_VERSION_NEWER:
1405 (void) printf(gettext(" status: The pool is formatted using an "
1406 "incompatible version.\n"));
1409 case ZPOOL_STATUS_HOSTID_MISMATCH:
1410 (void) printf(gettext(" status: The pool was last accessed by "
1411 "another system.\n"));
1414 case ZPOOL_STATUS_FAULTED_DEV_R:
1415 case ZPOOL_STATUS_FAULTED_DEV_NR:
1416 (void) printf(gettext(" status: One or more devices are "
1420 case ZPOOL_STATUS_BAD_LOG:
1421 (void) printf(gettext(" status: An intent log record cannot be "
1425 case ZPOOL_STATUS_RESILVERING:
1426 (void) printf(gettext(" status: One or more devices were being "
1432 * No other status can be seen when importing pools.
1434 assert(reason == ZPOOL_STATUS_OK);
1438 * Print out an action according to the overall state of the pool.
1440 if (vs->vs_state == VDEV_STATE_HEALTHY) {
1441 if (reason == ZPOOL_STATUS_VERSION_OLDER)
1442 (void) printf(gettext(" action: The pool can be "
1443 "imported using its name or numeric identifier, "
1444 "though\n\tsome features will not be available "
1445 "without an explicit 'zpool upgrade'.\n"));
1446 else if (reason == ZPOOL_STATUS_HOSTID_MISMATCH)
1447 (void) printf(gettext(" action: The pool can be "
1448 "imported using its name or numeric "
1449 "identifier and\n\tthe '-f' flag.\n"));
1451 (void) printf(gettext(" action: The pool can be "
1452 "imported using its name or numeric "
1454 } else if (vs->vs_state == VDEV_STATE_DEGRADED) {
1455 (void) printf(gettext(" action: The pool can be imported "
1456 "despite missing or damaged devices. The\n\tfault "
1457 "tolerance of the pool may be compromised if imported.\n"));
1460 case ZPOOL_STATUS_VERSION_NEWER:
1461 (void) printf(gettext(" action: The pool cannot be "
1462 "imported. Access the pool on a system running "
1463 "newer\n\tsoftware, or recreate the pool from "
1466 case ZPOOL_STATUS_MISSING_DEV_R:
1467 case ZPOOL_STATUS_MISSING_DEV_NR:
1468 case ZPOOL_STATUS_BAD_GUID_SUM:
1469 (void) printf(gettext(" action: The pool cannot be "
1470 "imported. Attach the missing\n\tdevices and try "
1474 (void) printf(gettext(" action: The pool cannot be "
1475 "imported due to damaged devices or data.\n"));
1479 /* Print the comment attached to the pool. */
1480 if (nvlist_lookup_string(config, ZPOOL_CONFIG_COMMENT, &comment) == 0)
1481 (void) printf(gettext("comment: %s\n"), comment);
1484 * If the state is "closed" or "can't open", and the aux state
1485 * is "corrupt data":
1487 if (((vs->vs_state == VDEV_STATE_CLOSED) ||
1488 (vs->vs_state == VDEV_STATE_CANT_OPEN)) &&
1489 (vs->vs_aux == VDEV_AUX_CORRUPT_DATA)) {
1490 if (pool_state == POOL_STATE_DESTROYED)
1491 (void) printf(gettext("\tThe pool was destroyed, "
1492 "but can be imported using the '-Df' flags.\n"));
1493 else if (pool_state != POOL_STATE_EXPORTED)
1494 (void) printf(gettext("\tThe pool may be active on "
1495 "another system, but can be imported using\n\t"
1496 "the '-f' flag.\n"));
1500 (void) printf(gettext(" see: http://zfsonlinux.org/msg/%s\n"),
1503 (void) printf(gettext(" config:\n\n"));
1505 namewidth = max_width(NULL, nvroot, 0, 0);
1509 print_import_config(name, nvroot, namewidth, 0);
1510 if (num_logs(nvroot) > 0)
1511 print_logs(NULL, nvroot, namewidth, B_FALSE);
1513 if (reason == ZPOOL_STATUS_BAD_GUID_SUM) {
1514 (void) printf(gettext("\n\tAdditional devices are known to "
1515 "be part of this pool, though their\n\texact "
1516 "configuration cannot be determined.\n"));
1521 * Perform the import for the given configuration. This passes the heavy
1522 * lifting off to zpool_import_props(), and then mounts the datasets contained
1526 do_import(nvlist_t *config, const char *newname, const char *mntopts,
1527 nvlist_t *props, int flags)
1529 zpool_handle_t *zhp;
1534 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
1537 verify(nvlist_lookup_uint64(config,
1538 ZPOOL_CONFIG_POOL_STATE, &state) == 0);
1539 verify(nvlist_lookup_uint64(config,
1540 ZPOOL_CONFIG_VERSION, &version) == 0);
1541 if (version > SPA_VERSION) {
1542 (void) fprintf(stderr, gettext("cannot import '%s': pool "
1543 "is formatted using a newer ZFS version\n"), name);
1545 } else if (state != POOL_STATE_EXPORTED &&
1546 !(flags & ZFS_IMPORT_ANY_HOST)) {
1549 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_HOSTID,
1551 unsigned long system_hostid = gethostid() & 0xffffffff;
1553 if ((unsigned long)hostid != system_hostid) {
1558 verify(nvlist_lookup_string(config,
1559 ZPOOL_CONFIG_HOSTNAME, &hostname) == 0);
1560 verify(nvlist_lookup_uint64(config,
1561 ZPOOL_CONFIG_TIMESTAMP, ×tamp) == 0);
1563 (void) fprintf(stderr, gettext("cannot import "
1564 "'%s': pool may be in use from other "
1565 "system, it was last accessed by %s "
1566 "(hostid: 0x%lx) on %s"), name, hostname,
1567 (unsigned long)hostid,
1568 asctime(localtime(&t)));
1569 (void) fprintf(stderr, gettext("use '-f' to "
1570 "import anyway\n"));
1574 (void) fprintf(stderr, gettext("cannot import '%s': "
1575 "pool may be in use from other system\n"), name);
1576 (void) fprintf(stderr, gettext("use '-f' to import "
1582 if (zpool_import_props(g_zfs, config, newname, props, flags) != 0)
1585 if (newname != NULL)
1586 name = (char *)newname;
1588 if ((zhp = zpool_open_canfail(g_zfs, name)) == NULL)
1591 if (zpool_get_state(zhp) != POOL_STATE_UNAVAIL &&
1592 !(flags & ZFS_IMPORT_ONLY) &&
1593 zpool_enable_datasets(zhp, mntopts, 0) != 0) {
1603 * zpool import [-d dir] [-D]
1604 * import [-o mntopts] [-o prop=value] ... [-R root] [-D]
1605 * [-d dir | -c cachefile] [-f] -a
1606 * import [-o mntopts] [-o prop=value] ... [-R root] [-D]
1607 * [-d dir | -c cachefile] [-f] [-n] [-F] <pool | id> [newpool]
1609 * -c Read pool information from a cachefile instead of searching
1612 * -d Scan in a specific directory, other than /dev/. More than
1613 * one directory can be specified using multiple '-d' options.
1615 * -D Scan for previously destroyed pools or import all or only
1616 * specified destroyed pools.
1618 * -R Temporarily import the pool, with all mountpoints relative to
1619 * the given root. The pool will remain exported when the machine
1622 * -V Import even in the presence of faulted vdevs. This is an
1623 * intentionally undocumented option for testing purposes, and
1624 * treats the pool configuration as complete, leaving any bad
1625 * vdevs in the FAULTED state. In other words, it does verbatim
1628 * -f Force import, even if it appears that the pool is active.
1630 * -F Attempt rewind if necessary.
1632 * -n See if rewind would work, but don't actually rewind.
1634 * -N Import the pool but don't mount datasets.
1636 * -T Specify a starting txg to use for import. This option is
1637 * intentionally undocumented option for testing purposes.
1639 * -a Import all pools found.
1641 * -o Set property=value and/or temporary mount options (without '=').
1643 * The import command scans for pools to import, and import pools based on pool
1644 * name and GUID. The pool can also be renamed as part of the import process.
1647 zpool_do_import(int argc, char **argv)
1649 char **searchdirs = NULL;
1653 nvlist_t *pools = NULL;
1654 boolean_t do_all = B_FALSE;
1655 boolean_t do_destroyed = B_FALSE;
1656 char *mntopts = NULL;
1659 uint64_t searchguid = 0;
1660 char *searchname = NULL;
1662 nvlist_t *found_config;
1663 nvlist_t *policy = NULL;
1664 nvlist_t *props = NULL;
1666 int flags = ZFS_IMPORT_NORMAL;
1667 uint32_t rewind_policy = ZPOOL_NO_REWIND;
1668 boolean_t dryrun = B_FALSE;
1669 boolean_t do_rewind = B_FALSE;
1670 boolean_t xtreme_rewind = B_FALSE;
1671 uint64_t pool_state, txg = -1ULL;
1672 char *cachefile = NULL;
1673 importargs_t idata = { 0 };
1677 while ((c = getopt(argc, argv, ":aCc:d:DEfFmnNo:rR:T:VX")) != -1) {
1686 if (searchdirs == NULL) {
1687 searchdirs = safe_malloc(sizeof (char *));
1689 char **tmp = safe_malloc((nsearch + 1) *
1691 bcopy(searchdirs, tmp, nsearch *
1696 searchdirs[nsearch++] = optarg;
1699 do_destroyed = B_TRUE;
1702 flags |= ZFS_IMPORT_ANY_HOST;
1708 flags |= ZFS_IMPORT_MISSING_LOG;
1714 flags |= ZFS_IMPORT_ONLY;
1717 if ((propval = strchr(optarg, '=')) != NULL) {
1720 if (add_prop_list(optarg, propval,
1728 if (add_prop_list(zpool_prop_to_name(
1729 ZPOOL_PROP_ALTROOT), optarg, &props, B_TRUE))
1731 if (nvlist_lookup_string(props,
1732 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE),
1735 if (add_prop_list(zpool_prop_to_name(
1736 ZPOOL_PROP_CACHEFILE), "none", &props, B_TRUE))
1741 txg = strtoull(optarg, &endptr, 10);
1742 if (errno != 0 || *endptr != '\0') {
1743 (void) fprintf(stderr,
1744 gettext("invalid txg value\n"));
1747 rewind_policy = ZPOOL_DO_REWIND | ZPOOL_EXTREME_REWIND;
1750 flags |= ZFS_IMPORT_VERBATIM;
1753 xtreme_rewind = B_TRUE;
1756 (void) fprintf(stderr, gettext("missing argument for "
1757 "'%c' option\n"), optopt);
1761 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1770 if (cachefile && nsearch != 0) {
1771 (void) fprintf(stderr, gettext("-c is incompatible with -d\n"));
1775 if ((dryrun || xtreme_rewind) && !do_rewind) {
1776 (void) fprintf(stderr,
1777 gettext("-n or -X only meaningful with -F\n"));
1781 rewind_policy = ZPOOL_TRY_REWIND;
1783 rewind_policy = ZPOOL_DO_REWIND;
1785 rewind_policy |= ZPOOL_EXTREME_REWIND;
1787 /* In the future, we can capture further policy and include it here */
1788 if (nvlist_alloc(&policy, NV_UNIQUE_NAME, 0) != 0 ||
1789 nvlist_add_uint64(policy, ZPOOL_REWIND_REQUEST_TXG, txg) != 0 ||
1790 nvlist_add_uint32(policy, ZPOOL_REWIND_REQUEST, rewind_policy) != 0)
1793 /* check argument count */
1796 (void) fprintf(stderr, gettext("too many arguments\n"));
1801 (void) fprintf(stderr, gettext("too many arguments\n"));
1806 * Check for the SYS_CONFIG privilege. We do this explicitly
1807 * here because otherwise any attempt to discover pools will
1810 if (argc == 0 && !priv_ineffect(PRIV_SYS_CONFIG)) {
1811 (void) fprintf(stderr, gettext("cannot "
1812 "discover pools: permission denied\n"));
1813 if (searchdirs != NULL)
1816 nvlist_free(policy);
1822 * Depending on the arguments given, we do one of the following:
1824 * <none> Iterate through all pools and display information about
1827 * -a Iterate through all pools and try to import each one.
1829 * <id> Find the pool that corresponds to the given GUID/pool
1830 * name and import that one.
1832 * -D Above options applies only to destroyed pools.
1838 searchguid = strtoull(argv[0], &endptr, 10);
1839 if (errno != 0 || *endptr != '\0')
1840 searchname = argv[0];
1841 found_config = NULL;
1844 * User specified a name or guid. Ensure it's unique.
1846 idata.unique = B_TRUE;
1850 idata.path = searchdirs;
1851 idata.paths = nsearch;
1852 idata.poolname = searchname;
1853 idata.guid = searchguid;
1854 idata.cachefile = cachefile;
1856 pools = zpool_search_import(g_zfs, &idata);
1858 if (pools != NULL && idata.exists &&
1859 (argc == 1 || strcmp(argv[0], argv[1]) == 0)) {
1860 (void) fprintf(stderr, gettext("cannot import '%s': "
1861 "a pool with that name already exists\n"),
1863 (void) fprintf(stderr, gettext("use the form '%s "
1864 "<pool | id> <newpool>' to give it a new name\n"),
1867 } else if (pools == NULL && idata.exists) {
1868 (void) fprintf(stderr, gettext("cannot import '%s': "
1869 "a pool with that name is already created/imported,\n"),
1871 (void) fprintf(stderr, gettext("and no additional pools "
1872 "with that name were found\n"));
1874 } else if (pools == NULL) {
1876 (void) fprintf(stderr, gettext("cannot import '%s': "
1877 "no such pool available\n"), argv[0]);
1883 if (searchdirs != NULL)
1885 nvlist_free(policy);
1890 * At this point we have a list of import candidate configs. Even if
1891 * we were searching by pool name or guid, we still need to
1892 * post-process the list to deal with pool state and possible
1898 while ((elem = nvlist_next_nvpair(pools, elem)) != NULL) {
1900 verify(nvpair_value_nvlist(elem, &config) == 0);
1902 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
1904 if (!do_destroyed && pool_state == POOL_STATE_DESTROYED)
1906 if (do_destroyed && pool_state != POOL_STATE_DESTROYED)
1909 verify(nvlist_add_nvlist(config, ZPOOL_REWIND_POLICY,
1916 (void) printf("\n");
1919 err |= do_import(config, NULL, mntopts,
1922 show_import(config);
1924 } else if (searchname != NULL) {
1928 * We are searching for a pool based on name.
1930 verify(nvlist_lookup_string(config,
1931 ZPOOL_CONFIG_POOL_NAME, &name) == 0);
1933 if (strcmp(name, searchname) == 0) {
1934 if (found_config != NULL) {
1935 (void) fprintf(stderr, gettext(
1936 "cannot import '%s': more than "
1937 "one matching pool\n"), searchname);
1938 (void) fprintf(stderr, gettext(
1939 "import by numeric ID instead\n"));
1942 found_config = config;
1948 * Search for a pool by guid.
1950 verify(nvlist_lookup_uint64(config,
1951 ZPOOL_CONFIG_POOL_GUID, &guid) == 0);
1953 if (guid == searchguid)
1954 found_config = config;
1959 * If we were searching for a specific pool, verify that we found a
1960 * pool, and then do the import.
1962 if (argc != 0 && err == 0) {
1963 if (found_config == NULL) {
1964 (void) fprintf(stderr, gettext("cannot import '%s': "
1965 "no such pool available\n"), argv[0]);
1968 err |= do_import(found_config, argc == 1 ? NULL :
1969 argv[1], mntopts, props, flags);
1974 * If we were just looking for pools, report an error if none were
1977 if (argc == 0 && first)
1978 (void) fprintf(stderr,
1979 gettext("no pools available to import\n"));
1984 nvlist_free(policy);
1985 if (searchdirs != NULL)
1988 return (err ? 1 : 0);
1991 typedef struct iostat_cbdata {
1992 zpool_list_t *cb_list;
1999 print_iostat_separator(iostat_cbdata_t *cb)
2003 for (i = 0; i < cb->cb_namewidth; i++)
2005 (void) printf(" ----- ----- ----- ----- ----- -----\n");
2009 print_iostat_header(iostat_cbdata_t *cb)
2011 (void) printf("%*s capacity operations bandwidth\n",
2012 cb->cb_namewidth, "");
2013 (void) printf("%-*s alloc free read write read write\n",
2014 cb->cb_namewidth, "pool");
2015 print_iostat_separator(cb);
2019 * Display a single statistic.
2022 print_one_stat(uint64_t value)
2026 zfs_nicenum(value, buf, sizeof (buf));
2027 (void) printf(" %5s", buf);
2031 * Print out all the statistics for the given vdev. This can either be the
2032 * toplevel configuration, or called recursively. If 'name' is NULL, then this
2033 * is a verbose output, and we don't want to display the toplevel pool stats.
2036 print_vdev_stats(zpool_handle_t *zhp, const char *name, nvlist_t *oldnv,
2037 nvlist_t *newnv, iostat_cbdata_t *cb, int depth)
2039 nvlist_t **oldchild, **newchild;
2041 vdev_stat_t *oldvs, *newvs;
2042 vdev_stat_t zerovs = { 0 };
2047 if (oldnv != NULL) {
2048 verify(nvlist_lookup_uint64_array(oldnv,
2049 ZPOOL_CONFIG_VDEV_STATS, (uint64_t **)&oldvs, &c) == 0);
2054 verify(nvlist_lookup_uint64_array(newnv, ZPOOL_CONFIG_VDEV_STATS,
2055 (uint64_t **)&newvs, &c) == 0);
2057 if (strlen(name) + depth > cb->cb_namewidth)
2058 (void) printf("%*s%s", depth, "", name);
2060 (void) printf("%*s%s%*s", depth, "", name,
2061 (int)(cb->cb_namewidth - strlen(name) - depth), "");
2063 tdelta = newvs->vs_timestamp - oldvs->vs_timestamp;
2068 scale = (double)NANOSEC / tdelta;
2070 /* only toplevel vdevs have capacity stats */
2071 if (newvs->vs_space == 0) {
2072 (void) printf(" - -");
2074 print_one_stat(newvs->vs_alloc);
2075 print_one_stat(newvs->vs_space - newvs->vs_alloc);
2078 print_one_stat((uint64_t)(scale * (newvs->vs_ops[ZIO_TYPE_READ] -
2079 oldvs->vs_ops[ZIO_TYPE_READ])));
2081 print_one_stat((uint64_t)(scale * (newvs->vs_ops[ZIO_TYPE_WRITE] -
2082 oldvs->vs_ops[ZIO_TYPE_WRITE])));
2084 print_one_stat((uint64_t)(scale * (newvs->vs_bytes[ZIO_TYPE_READ] -
2085 oldvs->vs_bytes[ZIO_TYPE_READ])));
2087 print_one_stat((uint64_t)(scale * (newvs->vs_bytes[ZIO_TYPE_WRITE] -
2088 oldvs->vs_bytes[ZIO_TYPE_WRITE])));
2090 (void) printf("\n");
2092 if (!cb->cb_verbose)
2095 if (nvlist_lookup_nvlist_array(newnv, ZPOOL_CONFIG_CHILDREN,
2096 &newchild, &children) != 0)
2099 if (oldnv && nvlist_lookup_nvlist_array(oldnv, ZPOOL_CONFIG_CHILDREN,
2100 &oldchild, &c) != 0)
2103 for (c = 0; c < children; c++) {
2104 uint64_t ishole = B_FALSE, islog = B_FALSE;
2106 (void) nvlist_lookup_uint64(newchild[c], ZPOOL_CONFIG_IS_HOLE,
2109 (void) nvlist_lookup_uint64(newchild[c], ZPOOL_CONFIG_IS_LOG,
2112 if (ishole || islog)
2115 vname = zpool_vdev_name(g_zfs, zhp, newchild[c], B_FALSE);
2116 print_vdev_stats(zhp, vname, oldnv ? oldchild[c] : NULL,
2117 newchild[c], cb, depth + 2);
2122 * Log device section
2125 if (num_logs(newnv) > 0) {
2126 (void) printf("%-*s - - - - - "
2127 "-\n", cb->cb_namewidth, "logs");
2129 for (c = 0; c < children; c++) {
2130 uint64_t islog = B_FALSE;
2131 (void) nvlist_lookup_uint64(newchild[c],
2132 ZPOOL_CONFIG_IS_LOG, &islog);
2135 vname = zpool_vdev_name(g_zfs, zhp, newchild[c],
2137 print_vdev_stats(zhp, vname, oldnv ?
2138 oldchild[c] : NULL, newchild[c],
2147 * Include level 2 ARC devices in iostat output
2149 if (nvlist_lookup_nvlist_array(newnv, ZPOOL_CONFIG_L2CACHE,
2150 &newchild, &children) != 0)
2153 if (oldnv && nvlist_lookup_nvlist_array(oldnv, ZPOOL_CONFIG_L2CACHE,
2154 &oldchild, &c) != 0)
2158 (void) printf("%-*s - - - - - "
2159 "-\n", cb->cb_namewidth, "cache");
2160 for (c = 0; c < children; c++) {
2161 vname = zpool_vdev_name(g_zfs, zhp, newchild[c],
2163 print_vdev_stats(zhp, vname, oldnv ? oldchild[c] : NULL,
2164 newchild[c], cb, depth + 2);
2171 refresh_iostat(zpool_handle_t *zhp, void *data)
2173 iostat_cbdata_t *cb = data;
2177 * If the pool has disappeared, remove it from the list and continue.
2179 if (zpool_refresh_stats(zhp, &missing) != 0)
2183 pool_list_remove(cb->cb_list, zhp);
2189 * Callback to print out the iostats for the given pool.
2192 print_iostat(zpool_handle_t *zhp, void *data)
2194 iostat_cbdata_t *cb = data;
2195 nvlist_t *oldconfig, *newconfig;
2196 nvlist_t *oldnvroot, *newnvroot;
2198 newconfig = zpool_get_config(zhp, &oldconfig);
2200 if (cb->cb_iteration == 1)
2203 verify(nvlist_lookup_nvlist(newconfig, ZPOOL_CONFIG_VDEV_TREE,
2206 if (oldconfig == NULL)
2209 verify(nvlist_lookup_nvlist(oldconfig, ZPOOL_CONFIG_VDEV_TREE,
2213 * Print out the statistics for the pool.
2215 print_vdev_stats(zhp, zpool_get_name(zhp), oldnvroot, newnvroot, cb, 0);
2218 print_iostat_separator(cb);
2230 if (isatty(STDOUT_FILENO)) {
2231 error = ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws);
2233 columns = ws.ws_col;
2242 get_namewidth(zpool_handle_t *zhp, void *data)
2244 iostat_cbdata_t *cb = data;
2245 nvlist_t *config, *nvroot;
2248 if ((config = zpool_get_config(zhp, NULL)) != NULL) {
2249 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
2251 if (!cb->cb_verbose)
2252 cb->cb_namewidth = strlen(zpool_get_name(zhp));
2254 cb->cb_namewidth = max_width(zhp, nvroot, 0,
2259 * The width must be at least 10, but may be as large as the
2260 * column width - 42 so that we can still fit in one line.
2262 columns = get_columns();
2264 if (cb->cb_namewidth < 10)
2265 cb->cb_namewidth = 10;
2266 if (cb->cb_namewidth > columns - 42)
2267 cb->cb_namewidth = columns - 42;
2273 * Parse the input string, get the 'interval' and 'count' value if there is one.
2276 get_interval_count(int *argcp, char **argv, unsigned long *iv,
2279 unsigned long interval = 0, count = 0;
2283 * Determine if the last argument is an integer or a pool name
2285 if (argc > 0 && isdigit(argv[argc - 1][0])) {
2289 interval = strtoul(argv[argc - 1], &end, 10);
2291 if (*end == '\0' && errno == 0) {
2292 if (interval == 0) {
2293 (void) fprintf(stderr, gettext("interval "
2294 "cannot be zero\n"));
2298 * Ignore the last parameter
2303 * If this is not a valid number, just plow on. The
2304 * user will get a more informative error message later
2312 * If the last argument is also an integer, then we have both a count
2315 if (argc > 0 && isdigit(argv[argc - 1][0])) {
2320 interval = strtoul(argv[argc - 1], &end, 10);
2322 if (*end == '\0' && errno == 0) {
2323 if (interval == 0) {
2324 (void) fprintf(stderr, gettext("interval "
2325 "cannot be zero\n"));
2330 * Ignore the last parameter
2344 get_timestamp_arg(char c)
2347 timestamp_fmt = UDATE;
2349 timestamp_fmt = DDATE;
2355 * zpool iostat [-v] [-T d|u] [pool] ... [interval [count]]
2357 * -v Display statistics for individual vdevs
2358 * -T Display a timestamp in date(1) or Unix format
2360 * This command can be tricky because we want to be able to deal with pool
2361 * creation/destruction as well as vdev configuration changes. The bulk of this
2362 * processing is handled by the pool_list_* routines in zpool_iter.c. We rely
2363 * on pool_list_update() to detect the addition of new pools. Configuration
2364 * changes are all handled within libzfs.
2367 zpool_do_iostat(int argc, char **argv)
2372 unsigned long interval = 0, count = 0;
2374 boolean_t verbose = B_FALSE;
2378 while ((c = getopt(argc, argv, "T:v")) != -1) {
2381 get_timestamp_arg(*optarg);
2387 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2396 get_interval_count(&argc, argv, &interval, &count);
2399 * Construct the list of all interesting pools.
2402 if ((list = pool_list_get(argc, argv, NULL, &ret)) == NULL)
2405 if (pool_list_count(list) == 0 && argc != 0) {
2406 pool_list_free(list);
2410 if (pool_list_count(list) == 0 && interval == 0) {
2411 pool_list_free(list);
2412 (void) fprintf(stderr, gettext("no pools available\n"));
2417 * Enter the main iostat loop.
2420 cb.cb_verbose = verbose;
2421 cb.cb_iteration = 0;
2422 cb.cb_namewidth = 0;
2425 pool_list_update(list);
2427 if ((npools = pool_list_count(list)) == 0)
2428 (void) fprintf(stderr, gettext("no pools available\n"));
2431 * Refresh all statistics. This is done as an
2432 * explicit step before calculating the maximum name
2433 * width, so that any * configuration changes are
2434 * properly accounted for.
2436 (void) pool_list_iter(list, B_FALSE, refresh_iostat,
2440 * Iterate over all pools to determine the maximum width
2441 * for the pool / device name column across all pools.
2443 cb.cb_namewidth = 0;
2444 (void) pool_list_iter(list, B_FALSE, get_namewidth,
2447 if (timestamp_fmt != NODATE)
2448 print_timestamp(timestamp_fmt);
2451 * If it's the first time, or verbose mode, print the
2454 if (++cb.cb_iteration == 1 || verbose)
2455 print_iostat_header(&cb);
2457 (void) pool_list_iter(list, B_FALSE, print_iostat, &cb);
2460 * If there's more than one pool, and we're not in
2461 * verbose mode (which prints a separator for us),
2462 * then print a separator.
2464 if (npools > 1 && !verbose)
2465 print_iostat_separator(&cb);
2468 (void) printf("\n");
2472 * Flush the output so that redirection to a file isn't buffered
2475 (void) fflush(stdout);
2480 if (count != 0 && --count == 0)
2483 (void) sleep(interval);
2486 pool_list_free(list);
2491 typedef struct list_cbdata {
2492 boolean_t cb_scripted;
2494 zprop_list_t *cb_proplist;
2498 * Given a list of columns to display, output appropriate headers for each one.
2501 print_header(zprop_list_t *pl)
2504 boolean_t first = B_TRUE;
2505 boolean_t right_justify;
2507 for (; pl != NULL; pl = pl->pl_next) {
2508 if (pl->pl_prop == ZPROP_INVAL)
2516 header = zpool_prop_column_name(pl->pl_prop);
2517 right_justify = zpool_prop_align_right(pl->pl_prop);
2519 if (pl->pl_next == NULL && !right_justify)
2520 (void) printf("%s", header);
2521 else if (right_justify)
2522 (void) printf("%*s", (int)pl->pl_width, header);
2524 (void) printf("%-*s", (int)pl->pl_width, header);
2527 (void) printf("\n");
2531 * Given a pool and a list of properties, print out all the properties according
2532 * to the described layout.
2535 print_pool(zpool_handle_t *zhp, zprop_list_t *pl, int scripted)
2537 boolean_t first = B_TRUE;
2538 char property[ZPOOL_MAXPROPLEN];
2540 boolean_t right_justify;
2543 for (; pl != NULL; pl = pl->pl_next) {
2546 (void) printf("\t");
2553 right_justify = B_FALSE;
2554 if (pl->pl_prop != ZPROP_INVAL) {
2555 if (zpool_get_prop(zhp, pl->pl_prop, property,
2556 sizeof (property), NULL) != 0)
2561 right_justify = zpool_prop_align_right(pl->pl_prop);
2566 width = pl->pl_width;
2569 * If this is being called in scripted mode, or if this is the
2570 * last column and it is left-justified, don't include a width
2573 if (scripted || (pl->pl_next == NULL && !right_justify))
2574 (void) printf("%s", propstr);
2575 else if (right_justify)
2576 (void) printf("%*s", width, propstr);
2578 (void) printf("%-*s", width, propstr);
2581 (void) printf("\n");
2585 * Generic callback function to list a pool.
2588 list_callback(zpool_handle_t *zhp, void *data)
2590 list_cbdata_t *cbp = data;
2592 if (cbp->cb_first) {
2593 if (!cbp->cb_scripted)
2594 print_header(cbp->cb_proplist);
2595 cbp->cb_first = B_FALSE;
2598 print_pool(zhp, cbp->cb_proplist, cbp->cb_scripted);
2604 * zpool list [-H] [-o prop[,prop]*] [-T d|u] [pool] ... [interval [count]]
2606 * -H Scripted mode. Don't display headers, and separate properties
2608 * -o List of properties to display. Defaults to
2609 * "name,size,allocated,free,capacity,health,altroot"
2610 * -T Display a timestamp in date(1) or Unix format
2612 * List all pools in the system, whether or not they're healthy. Output space
2613 * statistics for each one, as well as health status summary.
2616 zpool_do_list(int argc, char **argv)
2620 list_cbdata_t cb = { 0 };
2621 static char default_props[] =
2622 "name,size,allocated,free,capacity,dedupratio,health,altroot";
2623 char *props = default_props;
2624 unsigned long interval = 0, count = 0;
2627 while ((c = getopt(argc, argv, ":Ho:T:")) != -1) {
2630 cb.cb_scripted = B_TRUE;
2636 get_timestamp_arg(*optarg);
2639 (void) fprintf(stderr, gettext("missing argument for "
2640 "'%c' option\n"), optopt);
2644 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2653 get_interval_count(&argc, argv, &interval, &count);
2655 if (zprop_get_list(g_zfs, props, &cb.cb_proplist, ZFS_TYPE_POOL) != 0)
2658 cb.cb_first = B_TRUE;
2662 if (timestamp_fmt != NODATE)
2663 print_timestamp(timestamp_fmt);
2665 ret = for_each_pool(argc, argv, B_TRUE, &cb.cb_proplist,
2666 list_callback, &cb);
2668 if (argc == 0 && cb.cb_first)
2669 (void) fprintf(stderr, gettext("no pools available\n"));
2670 else if (argc && cb.cb_first) {
2671 /* cannot open the given pool */
2672 zprop_free_list(cb.cb_proplist);
2679 if (count != 0 && --count == 0)
2682 (void) sleep(interval);
2685 zprop_free_list(cb.cb_proplist);
2690 zpool_do_attach_or_replace(int argc, char **argv, int replacing)
2692 boolean_t force = B_FALSE;
2695 char *poolname, *old_disk, *new_disk;
2696 zpool_handle_t *zhp;
2700 while ((c = getopt(argc, argv, "f")) != -1) {
2706 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2715 /* get pool name and check number of arguments */
2717 (void) fprintf(stderr, gettext("missing pool name argument\n"));
2724 (void) fprintf(stderr,
2725 gettext("missing <device> specification\n"));
2733 (void) fprintf(stderr,
2734 gettext("missing <new_device> specification\n"));
2737 new_disk = old_disk;
2747 (void) fprintf(stderr, gettext("too many arguments\n"));
2751 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
2754 if (zpool_get_config(zhp, NULL) == NULL) {
2755 (void) fprintf(stderr, gettext("pool '%s' is unavailable\n"),
2761 nvroot = make_root_vdev(zhp, NULL, force, B_FALSE, replacing, B_FALSE,
2763 if (nvroot == NULL) {
2768 ret = zpool_vdev_attach(zhp, old_disk, new_disk, nvroot, replacing);
2770 nvlist_free(nvroot);
2777 * zpool replace [-f] <pool> <device> <new_device>
2779 * -f Force attach, even if <new_device> appears to be in use.
2781 * Replace <device> with <new_device>.
2785 zpool_do_replace(int argc, char **argv)
2787 return (zpool_do_attach_or_replace(argc, argv, B_TRUE));
2791 * zpool attach [-f] <pool> <device> <new_device>
2793 * -f Force attach, even if <new_device> appears to be in use.
2795 * Attach <new_device> to the mirror containing <device>. If <device> is not
2796 * part of a mirror, then <device> will be transformed into a mirror of
2797 * <device> and <new_device>. In either case, <new_device> will begin life
2798 * with a DTL of [0, now], and will immediately begin to resilver itself.
2801 zpool_do_attach(int argc, char **argv)
2803 return (zpool_do_attach_or_replace(argc, argv, B_FALSE));
2807 * zpool detach [-f] <pool> <device>
2809 * -f Force detach of <device>, even if DTLs argue against it
2810 * (not supported yet)
2812 * Detach a device from a mirror. The operation will be refused if <device>
2813 * is the last device in the mirror, or if the DTLs indicate that this device
2814 * has the only valid copy of some data.
2818 zpool_do_detach(int argc, char **argv)
2821 char *poolname, *path;
2822 zpool_handle_t *zhp;
2826 while ((c = getopt(argc, argv, "f")) != -1) {
2830 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2839 /* get pool name and check number of arguments */
2841 (void) fprintf(stderr, gettext("missing pool name argument\n"));
2846 (void) fprintf(stderr,
2847 gettext("missing <device> specification\n"));
2854 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
2857 ret = zpool_vdev_detach(zhp, path);
2865 * zpool split [-n] [-o prop=val] ...
2867 * [-R altroot] <pool> <newpool> [<device> ...]
2869 * -n Do not split the pool, but display the resulting layout if
2870 * it were to be split.
2871 * -o Set property=value, or set mount options.
2872 * -R Mount the split-off pool under an alternate root.
2874 * Splits the named pool and gives it the new pool name. Devices to be split
2875 * off may be listed, provided that no more than one device is specified
2876 * per top-level vdev mirror. The newly split pool is left in an exported
2877 * state unless -R is specified.
2879 * Restrictions: the top-level of the pool pool must only be made up of
2880 * mirrors; all devices in the pool must be healthy; no device may be
2881 * undergoing a resilvering operation.
2884 zpool_do_split(int argc, char **argv)
2886 char *srcpool, *newpool, *propval;
2887 char *mntopts = NULL;
2890 zpool_handle_t *zhp;
2891 nvlist_t *config, *props = NULL;
2893 flags.dryrun = B_FALSE;
2894 flags.import = B_FALSE;
2897 while ((c = getopt(argc, argv, ":R:no:")) != -1) {
2900 flags.import = B_TRUE;
2902 zpool_prop_to_name(ZPOOL_PROP_ALTROOT), optarg,
2903 &props, B_TRUE) != 0) {
2910 flags.dryrun = B_TRUE;
2913 if ((propval = strchr(optarg, '=')) != NULL) {
2916 if (add_prop_list(optarg, propval,
2917 &props, B_TRUE) != 0) {
2927 (void) fprintf(stderr, gettext("missing argument for "
2928 "'%c' option\n"), optopt);
2932 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2939 if (!flags.import && mntopts != NULL) {
2940 (void) fprintf(stderr, gettext("setting mntopts is only "
2941 "valid when importing the pool\n"));
2949 (void) fprintf(stderr, gettext("Missing pool name\n"));
2953 (void) fprintf(stderr, gettext("Missing new pool name\n"));
2963 if ((zhp = zpool_open(g_zfs, srcpool)) == NULL)
2966 config = split_mirror_vdev(zhp, newpool, props, flags, argc, argv);
2967 if (config == NULL) {
2971 (void) printf(gettext("would create '%s' with the "
2972 "following layout:\n\n"), newpool);
2973 print_vdev_tree(NULL, newpool, config, 0, B_FALSE);
2975 nvlist_free(config);
2980 if (ret != 0 || flags.dryrun || !flags.import)
2984 * The split was successful. Now we need to open the new
2985 * pool and import it.
2987 if ((zhp = zpool_open_canfail(g_zfs, newpool)) == NULL)
2989 if (zpool_get_state(zhp) != POOL_STATE_UNAVAIL &&
2990 zpool_enable_datasets(zhp, mntopts, 0) != 0) {
2992 (void) fprintf(stderr, gettext("Split was succssful, but "
2993 "the datasets could not all be mounted\n"));
2994 (void) fprintf(stderr, gettext("Try doing '%s' with a "
2995 "different altroot\n"), "zpool import");
3005 * zpool online <pool> <device> ...
3008 zpool_do_online(int argc, char **argv)
3012 zpool_handle_t *zhp;
3014 vdev_state_t newstate;
3018 while ((c = getopt(argc, argv, "et")) != -1) {
3021 flags |= ZFS_ONLINE_EXPAND;
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_online(zhp, argv[i], flags, &newstate) == 0) {
3051 if (newstate != VDEV_STATE_HEALTHY) {
3052 (void) printf(gettext("warning: device '%s' "
3053 "onlined, but remains in faulted state\n"),
3055 if (newstate == VDEV_STATE_FAULTED)
3056 (void) printf(gettext("use 'zpool "
3057 "clear' to restore a faulted "
3060 (void) printf(gettext("use 'zpool "
3061 "replace' to replace devices "
3062 "that are no longer present\n"));
3075 * zpool offline [-ft] <pool> <device> ...
3077 * -f Force the device into the offline state, even if doing
3078 * so would appear to compromise pool availability.
3079 * (not supported yet)
3081 * -t Only take the device off-line temporarily. The offline
3082 * state will not be persistent across reboots.
3086 zpool_do_offline(int argc, char **argv)
3090 zpool_handle_t *zhp;
3092 boolean_t istmp = B_FALSE;
3095 while ((c = getopt(argc, argv, "ft")) != -1) {
3102 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3111 /* get pool name and check number of arguments */
3113 (void) fprintf(stderr, gettext("missing pool name\n"));
3117 (void) fprintf(stderr, gettext("missing device name\n"));
3123 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3126 for (i = 1; i < argc; i++) {
3127 if (zpool_vdev_offline(zhp, argv[i], istmp) != 0)
3137 * zpool clear <pool> [device]
3139 * Clear all errors associated with a pool or a particular device.
3142 zpool_do_clear(int argc, char **argv)
3146 boolean_t dryrun = B_FALSE;
3147 boolean_t do_rewind = B_FALSE;
3148 boolean_t xtreme_rewind = B_FALSE;
3149 uint32_t rewind_policy = ZPOOL_NO_REWIND;
3150 nvlist_t *policy = NULL;
3151 zpool_handle_t *zhp;
3152 char *pool, *device;
3155 while ((c = getopt(argc, argv, "FnX")) != -1) {
3164 xtreme_rewind = B_TRUE;
3167 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3177 (void) fprintf(stderr, gettext("missing pool name\n"));
3182 (void) fprintf(stderr, gettext("too many arguments\n"));
3186 if ((dryrun || xtreme_rewind) && !do_rewind) {
3187 (void) fprintf(stderr,
3188 gettext("-n or -X only meaningful with -F\n"));
3192 rewind_policy = ZPOOL_TRY_REWIND;
3194 rewind_policy = ZPOOL_DO_REWIND;
3196 rewind_policy |= ZPOOL_EXTREME_REWIND;
3198 /* In future, further rewind policy choices can be passed along here */
3199 if (nvlist_alloc(&policy, NV_UNIQUE_NAME, 0) != 0 ||
3200 nvlist_add_uint32(policy, ZPOOL_REWIND_REQUEST, rewind_policy) != 0)
3204 device = argc == 2 ? argv[1] : NULL;
3206 if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL) {
3207 nvlist_free(policy);
3211 if (zpool_clear(zhp, device, policy) != 0)
3216 nvlist_free(policy);
3222 * zpool reguid <pool>
3225 zpool_do_reguid(int argc, char **argv)
3229 zpool_handle_t *zhp;
3233 while ((c = getopt(argc, argv, "")) != -1) {
3236 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3245 /* get pool name and check number of arguments */
3247 (void) fprintf(stderr, gettext("missing pool name\n"));
3252 (void) fprintf(stderr, gettext("too many arguments\n"));
3257 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3260 ret = zpool_reguid(zhp);
3267 typedef struct scrub_cbdata {
3274 scrub_callback(zpool_handle_t *zhp, void *data)
3276 scrub_cbdata_t *cb = data;
3280 * Ignore faulted pools.
3282 if (zpool_get_state(zhp) == POOL_STATE_UNAVAIL) {
3283 (void) fprintf(stderr, gettext("cannot scrub '%s': pool is "
3284 "currently unavailable\n"), zpool_get_name(zhp));
3288 err = zpool_scan(zhp, cb->cb_type);
3294 * zpool scrub [-s] <pool> ...
3296 * -s Stop. Stops any in-progress scrub.
3299 zpool_do_scrub(int argc, char **argv)
3304 cb.cb_type = POOL_SCAN_SCRUB;
3307 while ((c = getopt(argc, argv, "s")) != -1) {
3310 cb.cb_type = POOL_SCAN_NONE;
3313 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3325 (void) fprintf(stderr, gettext("missing pool name argument\n"));
3329 return (for_each_pool(argc, argv, B_TRUE, NULL, scrub_callback, &cb));
3332 typedef struct status_cbdata {
3334 boolean_t cb_allpools;
3335 boolean_t cb_verbose;
3336 boolean_t cb_explain;
3338 boolean_t cb_dedup_stats;
3342 * Print out detailed scrub status.
3345 print_scan_status(pool_scan_stat_t *ps)
3348 uint64_t elapsed, mins_left, hours_left;
3349 uint64_t pass_exam, examined, total;
3351 double fraction_done;
3352 char processed_buf[7], examined_buf[7], total_buf[7], rate_buf[7];
3354 (void) printf(gettext(" scan: "));
3356 /* If there's never been a scan, there's not much to say. */
3357 if (ps == NULL || ps->pss_func == POOL_SCAN_NONE ||
3358 ps->pss_func >= POOL_SCAN_FUNCS) {
3359 (void) printf(gettext("none requested\n"));
3363 start = ps->pss_start_time;
3364 end = ps->pss_end_time;
3365 zfs_nicenum(ps->pss_processed, processed_buf, sizeof (processed_buf));
3367 assert(ps->pss_func == POOL_SCAN_SCRUB ||
3368 ps->pss_func == POOL_SCAN_RESILVER);
3370 * Scan is finished or canceled.
3372 if (ps->pss_state == DSS_FINISHED) {
3373 uint64_t minutes_taken = (end - start) / 60;
3376 if (ps->pss_func == POOL_SCAN_SCRUB) {
3377 fmt = gettext("scrub repaired %s in %lluh%um with "
3378 "%llu errors on %s");
3379 } else if (ps->pss_func == POOL_SCAN_RESILVER) {
3380 fmt = gettext("resilvered %s in %lluh%um with "
3381 "%llu errors on %s");
3384 (void) printf(fmt, processed_buf,
3385 (u_longlong_t)(minutes_taken / 60),
3386 (uint_t)(minutes_taken % 60),
3387 (u_longlong_t)ps->pss_errors,
3388 ctime((time_t *)&end));
3390 } else if (ps->pss_state == DSS_CANCELED) {
3391 if (ps->pss_func == POOL_SCAN_SCRUB) {
3392 (void) printf(gettext("scrub canceled on %s"),
3394 } else if (ps->pss_func == POOL_SCAN_RESILVER) {
3395 (void) printf(gettext("resilver canceled on %s"),
3401 assert(ps->pss_state == DSS_SCANNING);
3404 * Scan is in progress.
3406 if (ps->pss_func == POOL_SCAN_SCRUB) {
3407 (void) printf(gettext("scrub in progress since %s"),
3409 } else if (ps->pss_func == POOL_SCAN_RESILVER) {
3410 (void) printf(gettext("resilver in progress since %s"),
3414 examined = ps->pss_examined ? ps->pss_examined : 1;
3415 total = ps->pss_to_examine;
3416 fraction_done = (double)examined / total;
3418 /* elapsed time for this pass */
3419 elapsed = time(NULL) - ps->pss_pass_start;
3420 elapsed = elapsed ? elapsed : 1;
3421 pass_exam = ps->pss_pass_exam ? ps->pss_pass_exam : 1;
3422 rate = pass_exam / elapsed;
3423 rate = rate ? rate : 1;
3424 mins_left = ((total - examined) / rate) / 60;
3425 hours_left = mins_left / 60;
3427 zfs_nicenum(examined, examined_buf, sizeof (examined_buf));
3428 zfs_nicenum(total, total_buf, sizeof (total_buf));
3429 zfs_nicenum(rate, rate_buf, sizeof (rate_buf));
3432 * do not print estimated time if hours_left is more than 30 days
3434 (void) printf(gettext(" %s scanned out of %s at %s/s"),
3435 examined_buf, total_buf, rate_buf);
3436 if (hours_left < (30 * 24)) {
3437 (void) printf(gettext(", %lluh%um to go\n"),
3438 (u_longlong_t)hours_left, (uint_t)(mins_left % 60));
3440 (void) printf(gettext(
3441 ", (scan is slow, no estimated time)\n"));
3444 if (ps->pss_func == POOL_SCAN_RESILVER) {
3445 (void) printf(gettext(" %s resilvered, %.2f%% done\n"),
3446 processed_buf, 100 * fraction_done);
3447 } else if (ps->pss_func == POOL_SCAN_SCRUB) {
3448 (void) printf(gettext(" %s repaired, %.2f%% done\n"),
3449 processed_buf, 100 * fraction_done);
3454 print_error_log(zpool_handle_t *zhp)
3456 nvlist_t *nverrlist = NULL;
3459 size_t len = MAXPATHLEN * 2;
3461 if (zpool_get_errlog(zhp, &nverrlist) != 0) {
3462 (void) printf("errors: List of errors unavailable "
3463 "(insufficient privileges)\n");
3467 (void) printf("errors: Permanent errors have been "
3468 "detected in the following files:\n\n");
3470 pathname = safe_malloc(len);
3472 while ((elem = nvlist_next_nvpair(nverrlist, elem)) != NULL) {
3474 uint64_t dsobj, obj;
3476 verify(nvpair_value_nvlist(elem, &nv) == 0);
3477 verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_DATASET,
3479 verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_OBJECT,
3481 zpool_obj_to_path(zhp, dsobj, obj, pathname, len);
3482 (void) printf("%7s %s\n", "", pathname);
3485 nvlist_free(nverrlist);
3489 print_spares(zpool_handle_t *zhp, nvlist_t **spares, uint_t nspares,
3498 (void) printf(gettext("\tspares\n"));
3500 for (i = 0; i < nspares; i++) {
3501 name = zpool_vdev_name(g_zfs, zhp, spares[i], B_FALSE);
3502 print_status_config(zhp, name, spares[i],
3503 namewidth, 2, B_TRUE);
3509 print_l2cache(zpool_handle_t *zhp, nvlist_t **l2cache, uint_t nl2cache,
3518 (void) printf(gettext("\tcache\n"));
3520 for (i = 0; i < nl2cache; i++) {
3521 name = zpool_vdev_name(g_zfs, zhp, l2cache[i], B_FALSE);
3522 print_status_config(zhp, name, l2cache[i],
3523 namewidth, 2, B_FALSE);
3529 print_dedup_stats(nvlist_t *config)
3531 ddt_histogram_t *ddh;
3537 * If the pool was faulted then we may not have been able to
3538 * obtain the config. Otherwise, if have anything in the dedup
3539 * table continue processing the stats.
3541 if (nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_OBJ_STATS,
3542 (uint64_t **)&ddo, &c) != 0 || ddo->ddo_count == 0)
3545 (void) printf("\n");
3546 (void) printf("DDT entries %llu, size %llu on disk, %llu in core\n",
3547 (u_longlong_t)ddo->ddo_count,
3548 (u_longlong_t)ddo->ddo_dspace,
3549 (u_longlong_t)ddo->ddo_mspace);
3551 verify(nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_STATS,
3552 (uint64_t **)&dds, &c) == 0);
3553 verify(nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_HISTOGRAM,
3554 (uint64_t **)&ddh, &c) == 0);
3555 zpool_dump_ddt(dds, ddh);
3559 * Display a summary of pool status. Displays a summary such as:
3563 * reason: One or more devices ...
3564 * see: http://zfsonlinux.org/msg/ZFS-xxxx-01
3570 * When given the '-v' option, we print out the complete config. If the '-e'
3571 * option is specified, then we print out error rate information as well.
3574 status_callback(zpool_handle_t *zhp, void *data)
3576 status_cbdata_t *cbp = data;
3577 nvlist_t *config, *nvroot;
3584 config = zpool_get_config(zhp, NULL);
3585 reason = zpool_get_status(zhp, &msgid);
3590 * If we were given 'zpool status -x', only report those pools with
3593 if (reason == ZPOOL_STATUS_OK && cbp->cb_explain) {
3594 if (!cbp->cb_allpools) {
3595 (void) printf(gettext("pool '%s' is healthy\n"),
3596 zpool_get_name(zhp));
3598 cbp->cb_first = B_FALSE;
3604 cbp->cb_first = B_FALSE;
3606 (void) printf("\n");
3608 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
3610 verify(nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_VDEV_STATS,
3611 (uint64_t **)&vs, &c) == 0);
3612 health = zpool_state_to_name(vs->vs_state, vs->vs_aux);
3614 (void) printf(gettext(" pool: %s\n"), zpool_get_name(zhp));
3615 (void) printf(gettext(" state: %s\n"), health);
3618 case ZPOOL_STATUS_MISSING_DEV_R:
3619 (void) printf(gettext("status: One or more devices could not "
3620 "be opened. Sufficient replicas exist for\n\tthe pool to "
3621 "continue functioning in a degraded state.\n"));
3622 (void) printf(gettext("action: Attach the missing device and "
3623 "online it using 'zpool online'.\n"));
3626 case ZPOOL_STATUS_MISSING_DEV_NR:
3627 (void) printf(gettext("status: One or more devices could not "
3628 "be opened. There are insufficient\n\treplicas for the "
3629 "pool to continue functioning.\n"));
3630 (void) printf(gettext("action: Attach the missing device and "
3631 "online it using 'zpool online'.\n"));
3634 case ZPOOL_STATUS_CORRUPT_LABEL_R:
3635 (void) printf(gettext("status: One or more devices could not "
3636 "be used because the label is missing or\n\tinvalid. "
3637 "Sufficient replicas exist for the pool to continue\n\t"
3638 "functioning in a degraded state.\n"));
3639 (void) printf(gettext("action: Replace the device using "
3640 "'zpool replace'.\n"));
3643 case ZPOOL_STATUS_CORRUPT_LABEL_NR:
3644 (void) printf(gettext("status: One or more devices could not "
3645 "be used because the label is missing \n\tor invalid. "
3646 "There are insufficient replicas for the pool to "
3647 "continue\n\tfunctioning.\n"));
3648 zpool_explain_recover(zpool_get_handle(zhp),
3649 zpool_get_name(zhp), reason, config);
3652 case ZPOOL_STATUS_FAILING_DEV:
3653 (void) printf(gettext("status: One or more devices has "
3654 "experienced an unrecoverable error. An\n\tattempt was "
3655 "made to correct the error. Applications are "
3657 (void) printf(gettext("action: Determine if the device needs "
3658 "to be replaced, and clear the errors\n\tusing "
3659 "'zpool clear' or replace the device with 'zpool "
3663 case ZPOOL_STATUS_OFFLINE_DEV:
3664 (void) printf(gettext("status: One or more devices has "
3665 "been taken offline by the administrator.\n\tSufficient "
3666 "replicas exist for the pool to continue functioning in "
3667 "a\n\tdegraded state.\n"));
3668 (void) printf(gettext("action: Online the device using "
3669 "'zpool online' or replace the device with\n\t'zpool "
3673 case ZPOOL_STATUS_REMOVED_DEV:
3674 (void) printf(gettext("status: One or more devices has "
3675 "been removed by the administrator.\n\tSufficient "
3676 "replicas exist for the pool to continue functioning in "
3677 "a\n\tdegraded state.\n"));
3678 (void) printf(gettext("action: Online the device using "
3679 "'zpool online' or replace the device with\n\t'zpool "
3683 case ZPOOL_STATUS_RESILVERING:
3684 (void) printf(gettext("status: One or more devices is "
3685 "currently being resilvered. The pool will\n\tcontinue "
3686 "to function, possibly in a degraded state.\n"));
3687 (void) printf(gettext("action: Wait for the resilver to "
3691 case ZPOOL_STATUS_CORRUPT_DATA:
3692 (void) printf(gettext("status: One or more devices has "
3693 "experienced an error resulting in data\n\tcorruption. "
3694 "Applications may be affected.\n"));
3695 (void) printf(gettext("action: Restore the file in question "
3696 "if possible. Otherwise restore the\n\tentire pool from "
3700 case ZPOOL_STATUS_CORRUPT_POOL:
3701 (void) printf(gettext("status: The pool metadata is corrupted "
3702 "and the pool cannot be opened.\n"));
3703 zpool_explain_recover(zpool_get_handle(zhp),
3704 zpool_get_name(zhp), reason, config);
3707 case ZPOOL_STATUS_VERSION_OLDER:
3708 (void) printf(gettext("status: The pool is formatted using an "
3709 "older on-disk format. The pool can\n\tstill be used, but "
3710 "some features are unavailable.\n"));
3711 (void) printf(gettext("action: Upgrade the pool using 'zpool "
3712 "upgrade'. Once this is done, the\n\tpool will no longer "
3713 "be accessible on older software versions.\n"));
3716 case ZPOOL_STATUS_VERSION_NEWER:
3717 (void) printf(gettext("status: The pool has been upgraded to a "
3718 "newer, incompatible on-disk version.\n\tThe pool cannot "
3719 "be accessed on this system.\n"));
3720 (void) printf(gettext("action: Access the pool from a system "
3721 "running more recent software, or\n\trestore the pool from "
3725 case ZPOOL_STATUS_FAULTED_DEV_R:
3726 (void) printf(gettext("status: One or more devices are "
3727 "faulted in response to persistent errors.\n\tSufficient "
3728 "replicas exist for the pool to continue functioning "
3729 "in a\n\tdegraded state.\n"));
3730 (void) printf(gettext("action: Replace the faulted device, "
3731 "or use 'zpool clear' to mark the device\n\trepaired.\n"));
3734 case ZPOOL_STATUS_FAULTED_DEV_NR:
3735 (void) printf(gettext("status: One or more devices are "
3736 "faulted in response to persistent errors. There are "
3737 "insufficient replicas for the pool to\n\tcontinue "
3739 (void) printf(gettext("action: Destroy and re-create the pool "
3740 "from a backup source. Manually marking the device\n"
3741 "\trepaired using 'zpool clear' may allow some data "
3742 "to be recovered.\n"));
3745 case ZPOOL_STATUS_IO_FAILURE_WAIT:
3746 case ZPOOL_STATUS_IO_FAILURE_CONTINUE:
3747 (void) printf(gettext("status: One or more devices are "
3748 "faulted in response to IO failures.\n"));
3749 (void) printf(gettext("action: Make sure the affected devices "
3750 "are connected, then run 'zpool clear'.\n"));
3753 case ZPOOL_STATUS_BAD_LOG:
3754 (void) printf(gettext("status: An intent log record "
3755 "could not be read.\n"
3756 "\tWaiting for adminstrator intervention to fix the "
3757 "faulted pool.\n"));
3758 (void) printf(gettext("action: Either restore the affected "
3759 "device(s) and run 'zpool online',\n"
3760 "\tor ignore the intent log records by running "
3761 "'zpool clear'.\n"));
3766 * The remaining errors can't actually be generated, yet.
3768 assert(reason == ZPOOL_STATUS_OK);
3772 (void) printf(gettext(" see: http://zfsonlinux.org/msg/%s\n"),
3775 if (config != NULL) {
3778 nvlist_t **spares, **l2cache;
3779 uint_t nspares, nl2cache;
3780 pool_scan_stat_t *ps = NULL;
3782 (void) nvlist_lookup_uint64_array(nvroot,
3783 ZPOOL_CONFIG_SCAN_STATS, (uint64_t **)&ps, &c);
3784 print_scan_status(ps);
3786 namewidth = max_width(zhp, nvroot, 0, 0);
3790 (void) printf(gettext("config:\n\n"));
3791 (void) printf(gettext("\t%-*s %-8s %5s %5s %5s\n"), namewidth,
3792 "NAME", "STATE", "READ", "WRITE", "CKSUM");
3793 print_status_config(zhp, zpool_get_name(zhp), nvroot,
3794 namewidth, 0, B_FALSE);
3796 if (num_logs(nvroot) > 0)
3797 print_logs(zhp, nvroot, namewidth, B_TRUE);
3798 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_L2CACHE,
3799 &l2cache, &nl2cache) == 0)
3800 print_l2cache(zhp, l2cache, nl2cache, namewidth);
3802 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES,
3803 &spares, &nspares) == 0)
3804 print_spares(zhp, spares, nspares, namewidth);
3806 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_ERRCOUNT,
3808 nvlist_t *nverrlist = NULL;
3811 * If the approximate error count is small, get a
3812 * precise count by fetching the entire log and
3813 * uniquifying the results.
3815 if (nerr > 0 && nerr < 100 && !cbp->cb_verbose &&
3816 zpool_get_errlog(zhp, &nverrlist) == 0) {
3821 while ((elem = nvlist_next_nvpair(nverrlist,
3826 nvlist_free(nverrlist);
3828 (void) printf("\n");
3831 (void) printf(gettext("errors: No known data "
3833 else if (!cbp->cb_verbose)
3834 (void) printf(gettext("errors: %llu data "
3835 "errors, use '-v' for a list\n"),
3836 (u_longlong_t)nerr);
3838 print_error_log(zhp);
3841 if (cbp->cb_dedup_stats)
3842 print_dedup_stats(config);
3844 (void) printf(gettext("config: The configuration cannot be "
3852 * zpool status [-vx] [-T d|u] [pool] ... [interval [count]]
3854 * -v Display complete error logs
3855 * -x Display only pools with potential problems
3856 * -D Display dedup status (undocumented)
3857 * -T Display a timestamp in date(1) or Unix format
3859 * Describes the health status of all pools or some subset.
3862 zpool_do_status(int argc, char **argv)
3866 unsigned long interval = 0, count = 0;
3867 status_cbdata_t cb = { 0 };
3870 while ((c = getopt(argc, argv, "vxDT:")) != -1) {
3873 cb.cb_verbose = B_TRUE;
3876 cb.cb_explain = B_TRUE;
3879 cb.cb_dedup_stats = B_TRUE;
3882 get_timestamp_arg(*optarg);
3885 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3894 get_interval_count(&argc, argv, &interval, &count);
3897 cb.cb_allpools = B_TRUE;
3899 cb.cb_first = B_TRUE;
3902 if (timestamp_fmt != NODATE)
3903 print_timestamp(timestamp_fmt);
3905 ret = for_each_pool(argc, argv, B_TRUE, NULL,
3906 status_callback, &cb);
3908 if (argc == 0 && cb.cb_count == 0)
3909 (void) fprintf(stderr, gettext("no pools available\n"));
3910 else if (cb.cb_explain && cb.cb_first && cb.cb_allpools)
3911 (void) printf(gettext("all pools are healthy\n"));
3919 if (count != 0 && --count == 0)
3922 (void) sleep(interval);
3928 typedef struct upgrade_cbdata {
3933 uint64_t cb_version;
3938 upgrade_cb(zpool_handle_t *zhp, void *arg)
3940 upgrade_cbdata_t *cbp = arg;
3945 config = zpool_get_config(zhp, NULL);
3946 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
3949 if (!cbp->cb_newer && version < SPA_VERSION) {
3951 if (cbp->cb_first) {
3952 (void) printf(gettext("The following pools are "
3953 "out of date, and can be upgraded. After "
3954 "being\nupgraded, these pools will no "
3955 "longer be accessible by older software "
3957 (void) printf(gettext("VER POOL\n"));
3958 (void) printf(gettext("--- ------------\n"));
3959 cbp->cb_first = B_FALSE;
3962 (void) printf("%2llu %s\n", (u_longlong_t)version,
3963 zpool_get_name(zhp));
3965 cbp->cb_first = B_FALSE;
3966 ret = zpool_upgrade(zhp, cbp->cb_version);
3968 (void) printf(gettext("Successfully upgraded "
3969 "'%s'\n\n"), zpool_get_name(zhp));
3972 } else if (cbp->cb_newer && version > SPA_VERSION) {
3973 assert(!cbp->cb_all);
3975 if (cbp->cb_first) {
3976 (void) printf(gettext("The following pools are "
3977 "formatted using a newer software version and\n"
3978 "cannot be accessed on the current system.\n\n"));
3979 (void) printf(gettext("VER POOL\n"));
3980 (void) printf(gettext("--- ------------\n"));
3981 cbp->cb_first = B_FALSE;
3984 (void) printf("%2llu %s\n", (u_longlong_t)version,
3985 zpool_get_name(zhp));
3994 upgrade_one(zpool_handle_t *zhp, void *data)
3996 upgrade_cbdata_t *cbp = data;
3997 uint64_t cur_version;
4000 if (strcmp("log", zpool_get_name(zhp)) == 0) {
4001 (void) printf(gettext("'log' is now a reserved word\n"
4002 "Pool 'log' must be renamed using export and import"
4007 cur_version = zpool_get_prop_int(zhp, ZPOOL_PROP_VERSION, NULL);
4008 if (cur_version > cbp->cb_version) {
4009 (void) printf(gettext("Pool '%s' is already formatted "
4010 "using more current version '%llu'.\n"),
4011 zpool_get_name(zhp), (u_longlong_t) cur_version);
4014 if (cur_version == cbp->cb_version) {
4015 (void) printf(gettext("Pool '%s' is already formatted "
4016 "using the current version.\n"), zpool_get_name(zhp));
4020 ret = zpool_upgrade(zhp, cbp->cb_version);
4023 (void) printf(gettext("Successfully upgraded '%s' "
4024 "from version %llu to version %llu\n\n"),
4025 zpool_get_name(zhp), (u_longlong_t)cur_version,
4026 (u_longlong_t)cbp->cb_version);
4035 * zpool upgrade [-V version] <-a | pool ...>
4037 * With no arguments, display downrev'd ZFS pool available for upgrade.
4038 * Individual pools can be upgraded by specifying the pool, and '-a' will
4039 * upgrade all pools.
4042 zpool_do_upgrade(int argc, char **argv)
4045 upgrade_cbdata_t cb = { 0 };
4047 boolean_t showversions = B_FALSE;
4052 while ((c = getopt(argc, argv, ":avV:")) != -1) {
4058 showversions = B_TRUE;
4061 cb.cb_version = strtoll(optarg, &end, 10);
4062 if (*end != '\0' || cb.cb_version > SPA_VERSION ||
4063 cb.cb_version < SPA_VERSION_1) {
4064 (void) fprintf(stderr,
4065 gettext("invalid version '%s'\n"), optarg);
4070 (void) fprintf(stderr, gettext("missing argument for "
4071 "'%c' option\n"), optopt);
4075 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
4086 if (cb.cb_version == 0) {
4087 cb.cb_version = SPA_VERSION;
4088 } else if (!cb.cb_all && argc == 0) {
4089 (void) fprintf(stderr, gettext("-V option is "
4090 "incompatible with other arguments\n"));
4095 if (cb.cb_all || argc != 0) {
4096 (void) fprintf(stderr, gettext("-v option is "
4097 "incompatible with other arguments\n"));
4100 } else if (cb.cb_all) {
4102 (void) fprintf(stderr, gettext("-a option should not "
4103 "be used along with a pool name\n"));
4108 (void) printf(gettext("This system is currently running "
4109 "ZFS pool version %llu.\n\n"), SPA_VERSION);
4110 cb.cb_first = B_TRUE;
4112 (void) printf(gettext("The following versions are "
4114 (void) printf(gettext("VER DESCRIPTION\n"));
4115 (void) printf("--- -----------------------------------------"
4116 "---------------\n");
4117 (void) printf(gettext(" 1 Initial ZFS version\n"));
4118 (void) printf(gettext(" 2 Ditto blocks "
4119 "(replicated metadata)\n"));
4120 (void) printf(gettext(" 3 Hot spares and double parity "
4122 (void) printf(gettext(" 4 zpool history\n"));
4123 (void) printf(gettext(" 5 Compression using the gzip "
4125 (void) printf(gettext(" 6 bootfs pool property\n"));
4126 (void) printf(gettext(" 7 Separate intent log devices\n"));
4127 (void) printf(gettext(" 8 Delegated administration\n"));
4128 (void) printf(gettext(" 9 refquota and refreservation "
4130 (void) printf(gettext(" 10 Cache devices\n"));
4131 (void) printf(gettext(" 11 Improved scrub performance\n"));
4132 (void) printf(gettext(" 12 Snapshot properties\n"));
4133 (void) printf(gettext(" 13 snapused property\n"));
4134 (void) printf(gettext(" 14 passthrough-x aclinherit\n"));
4135 (void) printf(gettext(" 15 user/group space accounting\n"));
4136 (void) printf(gettext(" 16 stmf property support\n"));
4137 (void) printf(gettext(" 17 Triple-parity RAID-Z\n"));
4138 (void) printf(gettext(" 18 Snapshot user holds\n"));
4139 (void) printf(gettext(" 19 Log device removal\n"));
4140 (void) printf(gettext(" 20 Compression using zle "
4141 "(zero-length encoding)\n"));
4142 (void) printf(gettext(" 21 Deduplication\n"));
4143 (void) printf(gettext(" 22 Received properties\n"));
4144 (void) printf(gettext(" 23 Slim ZIL\n"));
4145 (void) printf(gettext(" 24 System attributes\n"));
4146 (void) printf(gettext(" 25 Improved scrub stats\n"));
4147 (void) printf(gettext(" 26 Improved snapshot deletion "
4149 (void) printf(gettext(" 27 Improved snapshot creation "
4151 (void) printf(gettext(" 28 Multiple vdev replacements\n"));
4152 (void) printf(gettext("\nFor more information on a particular "
4153 "version, including supported releases,\n"));
4154 (void) printf(gettext("see the ZFS Administration Guide.\n\n"));
4155 } else if (argc == 0) {
4158 ret = zpool_iter(g_zfs, upgrade_cb, &cb);
4159 notfound = cb.cb_first;
4161 if (!cb.cb_all && ret == 0) {
4163 (void) printf("\n");
4164 cb.cb_first = B_TRUE;
4165 cb.cb_newer = B_TRUE;
4166 ret = zpool_iter(g_zfs, upgrade_cb, &cb);
4169 (void) printf("\n");
4175 (void) printf(gettext("All pools are formatted "
4176 "using this version.\n"));
4177 else if (!cb.cb_all)
4178 (void) printf(gettext("Use 'zpool upgrade -v' "
4179 "for a list of available versions and "
4180 "their associated\nfeatures.\n"));
4183 ret = for_each_pool(argc, argv, B_FALSE, NULL,
4190 typedef struct hist_cbdata {
4197 * Print out the command history for a specific pool.
4200 get_history_one(zpool_handle_t *zhp, void *data)
4216 char internalstr[MAXPATHLEN];
4217 hist_cbdata_t *cb = (hist_cbdata_t *)data;
4221 cb->first = B_FALSE;
4223 (void) printf(gettext("History for '%s':\n"), zpool_get_name(zhp));
4225 if ((ret = zpool_get_history(zhp, &nvhis)) != 0)
4228 verify(nvlist_lookup_nvlist_array(nvhis, ZPOOL_HIST_RECORD,
4229 &records, &numrecords) == 0);
4230 for (i = 0; i < numrecords; i++) {
4231 if (nvlist_lookup_uint64(records[i], ZPOOL_HIST_TIME,
4235 /* is it an internal event or a standard event? */
4236 if (nvlist_lookup_string(records[i], ZPOOL_HIST_CMD,
4238 if (cb->internal == 0)
4241 if (nvlist_lookup_uint64(records[i],
4242 ZPOOL_HIST_INT_EVENT, &ievent) != 0)
4244 verify(nvlist_lookup_uint64(records[i],
4245 ZPOOL_HIST_TXG, &txg) == 0);
4246 verify(nvlist_lookup_string(records[i],
4247 ZPOOL_HIST_INT_STR, &pathstr) == 0);
4248 if (ievent >= LOG_END)
4250 (void) snprintf(internalstr,
4251 sizeof (internalstr),
4252 "[internal %s txg:%llu] %s",
4253 zfs_history_event_names[ievent], (u_longlong_t)txg,
4255 cmdstr = internalstr;
4258 (void) localtime_r(&tsec, &t);
4259 (void) strftime(tbuf, sizeof (tbuf), "%F.%T", &t);
4260 (void) printf("%s %s", tbuf, cmdstr);
4263 (void) printf("\n");
4266 (void) printf(" [");
4267 if (nvlist_lookup_uint64(records[i],
4268 ZPOOL_HIST_WHO, &who) == 0) {
4269 pwd = getpwuid((uid_t)who);
4271 (void) printf("user %s on",
4274 (void) printf("user %d on",
4277 (void) printf(gettext("no info]\n"));
4280 if (nvlist_lookup_string(records[i],
4281 ZPOOL_HIST_HOST, &hostname) == 0) {
4282 (void) printf(" %s", hostname);
4284 if (nvlist_lookup_string(records[i],
4285 ZPOOL_HIST_ZONE, &zonename) == 0) {
4286 (void) printf(":%s", zonename);
4290 (void) printf("\n");
4292 (void) printf("\n");
4299 * zpool history <pool>
4301 * Displays the history of commands that modified pools.
4306 zpool_do_history(int argc, char **argv)
4308 hist_cbdata_t cbdata = { 0 };
4312 cbdata.first = B_TRUE;
4314 while ((c = getopt(argc, argv, "li")) != -1) {
4320 cbdata.internal = 1;
4323 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
4331 ret = for_each_pool(argc, argv, B_FALSE, NULL, get_history_one,
4334 if (argc == 0 && cbdata.first == B_TRUE) {
4335 (void) fprintf(stderr, gettext("no pools available\n"));
4342 typedef struct ev_opts {
4350 zpool_do_events_short(nvlist_t *nvl)
4352 char ctime_str[26], str[32], *ptr;
4356 verify(nvlist_lookup_int64_array(nvl, FM_EREPORT_TIME, &tv, &n) == 0);
4357 memset(str, ' ', 32);
4358 (void) ctime_r((const time_t *)&tv[0], ctime_str);
4359 (void) strncpy(str, ctime_str+4, 6); /* 'Jun 30' */
4360 (void) strncpy(str+7, ctime_str+20, 4); /* '1993' */
4361 (void) strncpy(str+12, ctime_str+11, 8); /* '21:49:08' */
4362 (void) sprintf(str+20, ".%09lld", (longlong_t)tv[1]);/* '.123456789' */
4363 (void) printf(gettext("%s "), str);
4365 verify(nvlist_lookup_string(nvl, FM_CLASS, &ptr) == 0);
4366 (void) printf(gettext("%s\n"), ptr);
4370 zpool_do_events_nvprint(nvlist_t *nvl, int depth)
4374 for (nvp = nvlist_next_nvpair(nvl, NULL);
4375 nvp != NULL; nvp = nvlist_next_nvpair(nvl, nvp)) {
4377 data_type_t type = nvpair_type(nvp);
4378 const char *name = nvpair_name(nvp);
4388 printf(gettext("%*s%s = "), depth, "", name);
4391 case DATA_TYPE_BOOLEAN:
4392 printf(gettext("%s"), "1");
4395 case DATA_TYPE_BOOLEAN_VALUE:
4396 (void) nvpair_value_boolean_value(nvp, &b);
4397 printf(gettext("%s"), b ? "1" : "0");
4400 case DATA_TYPE_BYTE:
4401 (void) nvpair_value_byte(nvp, &i8);
4402 printf(gettext("0x%x"), i8);
4405 case DATA_TYPE_INT8:
4406 (void) nvpair_value_int8(nvp, (void *)&i8);
4407 printf(gettext("0x%x"), i8);
4410 case DATA_TYPE_UINT8:
4411 (void) nvpair_value_uint8(nvp, &i8);
4412 printf(gettext("0x%x"), i8);
4415 case DATA_TYPE_INT16:
4416 (void) nvpair_value_int16(nvp, (void *)&i16);
4417 printf(gettext("0x%x"), i16);
4420 case DATA_TYPE_UINT16:
4421 (void) nvpair_value_uint16(nvp, &i16);
4422 printf(gettext("0x%x"), i16);
4425 case DATA_TYPE_INT32:
4426 (void) nvpair_value_int32(nvp, (void *)&i32);
4427 printf(gettext("0x%x"), i32);
4430 case DATA_TYPE_UINT32:
4431 (void) nvpair_value_uint32(nvp, &i32);
4432 printf(gettext("0x%x"), i32);
4435 case DATA_TYPE_INT64:
4436 (void) nvpair_value_int64(nvp, (void *)&i64);
4437 printf(gettext("0x%llx"), (u_longlong_t)i64);
4440 case DATA_TYPE_UINT64:
4441 (void) nvpair_value_uint64(nvp, &i64);
4442 printf(gettext("0x%llx"), (u_longlong_t)i64);
4445 case DATA_TYPE_HRTIME:
4446 (void) nvpair_value_hrtime(nvp, (void *)&i64);
4447 printf(gettext("0x%llx"), (u_longlong_t)i64);
4450 case DATA_TYPE_STRING:
4451 (void) nvpair_value_string(nvp, &str);
4452 printf(gettext("\"%s\""), str ? str : "<NULL>");
4455 case DATA_TYPE_NVLIST:
4456 printf(gettext("(embedded nvlist)\n"));
4457 (void) nvpair_value_nvlist(nvp, &cnv);
4458 zpool_do_events_nvprint(cnv, depth + 8);
4459 printf(gettext("%*s(end %s)"), depth, "", name);
4462 case DATA_TYPE_NVLIST_ARRAY: {
4466 (void) nvpair_value_nvlist_array(nvp, &val, &nelem);
4467 printf(gettext("(%d embedded nvlists)\n"), nelem);
4468 for (i = 0; i < nelem; i++) {
4469 printf(gettext("%*s%s[%d] = %s\n"),
4470 depth, "", name, i, "(embedded nvlist)");
4471 zpool_do_events_nvprint(val[i], depth + 8);
4472 printf(gettext("%*s(end %s[%i])\n"),
4473 depth, "", name, i);
4475 printf(gettext("%*s(end %s)\n"), depth, "", name);
4479 case DATA_TYPE_INT8_ARRAY: {
4483 (void) nvpair_value_int8_array(nvp, &val, &nelem);
4484 for (i = 0; i < nelem; i++)
4485 printf(gettext("0x%x "), val[i]);
4490 case DATA_TYPE_UINT8_ARRAY: {
4494 (void) nvpair_value_uint8_array(nvp, &val, &nelem);
4495 for (i = 0; i < nelem; i++)
4496 printf(gettext("0x%x "), val[i]);
4501 case DATA_TYPE_INT16_ARRAY: {
4505 (void) nvpair_value_int16_array(nvp, &val, &nelem);
4506 for (i = 0; i < nelem; i++)
4507 printf(gettext("0x%x "), val[i]);
4512 case DATA_TYPE_UINT16_ARRAY: {
4516 (void) nvpair_value_uint16_array(nvp, &val, &nelem);
4517 for (i = 0; i < nelem; i++)
4518 printf(gettext("0x%x "), val[i]);
4523 case DATA_TYPE_INT32_ARRAY: {
4527 (void) nvpair_value_int32_array(nvp, &val, &nelem);
4528 for (i = 0; i < nelem; i++)
4529 printf(gettext("0x%x "), val[i]);
4534 case DATA_TYPE_UINT32_ARRAY: {
4538 (void) nvpair_value_uint32_array(nvp, &val, &nelem);
4539 for (i = 0; i < nelem; i++)
4540 printf(gettext("0x%x "), val[i]);
4545 case DATA_TYPE_INT64_ARRAY: {
4549 (void) nvpair_value_int64_array(nvp, &val, &nelem);
4550 for (i = 0; i < nelem; i++)
4551 printf(gettext("0x%llx "), (u_longlong_t)val[i]);
4556 case DATA_TYPE_UINT64_ARRAY: {
4560 (void) nvpair_value_uint64_array(nvp, &val, &nelem);
4561 for (i = 0; i < nelem; i++)
4562 printf(gettext("0x%llx "), (u_longlong_t)val[i]);
4567 case DATA_TYPE_STRING_ARRAY:
4568 case DATA_TYPE_BOOLEAN_ARRAY:
4569 case DATA_TYPE_BYTE_ARRAY:
4570 case DATA_TYPE_DOUBLE:
4571 case DATA_TYPE_UNKNOWN:
4572 printf(gettext("<unknown>"));
4576 printf(gettext("\n"));
4581 zpool_do_events_next(ev_opts_t *opts)
4584 int cleanup_fd, ret, dropped;
4586 cleanup_fd = open(ZFS_DEV, O_RDWR);
4587 VERIFY(cleanup_fd >= 0);
4589 if (!opts->scripted)
4590 (void) printf(gettext("%-30s %s\n"), "TIME", "CLASS");
4593 ret = zpool_events_next(g_zfs, &nvl, &dropped,
4594 !!opts->follow, cleanup_fd);
4595 if (ret || nvl == NULL)
4599 (void) printf(gettext("dropped %d events\n"), dropped);
4601 zpool_do_events_short(nvl);
4603 if (opts->verbose) {
4604 zpool_do_events_nvprint(nvl, 8);
4605 printf(gettext("\n"));
4611 VERIFY(0 == close(cleanup_fd));
4617 zpool_do_events_clear(ev_opts_t *opts)
4621 ret = zpool_events_clear(g_zfs, &count);
4623 (void) printf(gettext("cleared %d events\n"), count);
4629 * zpool events [-vfc]
4631 * Displays events logs by ZFS.
4634 zpool_do_events(int argc, char **argv)
4636 ev_opts_t opts = { 0 };
4641 while ((c = getopt(argc, argv, "vHfc")) != -1) {
4656 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
4665 ret = zpool_do_events_clear(&opts);
4667 ret = zpool_do_events_next(&opts);
4673 get_callback(zpool_handle_t *zhp, void *data)
4675 zprop_get_cbdata_t *cbp = (zprop_get_cbdata_t *)data;
4676 char value[MAXNAMELEN];
4677 zprop_source_t srctype;
4680 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
4683 * Skip the special fake placeholder. This will also skip
4684 * over the name property when 'all' is specified.
4686 if (pl->pl_prop == ZPOOL_PROP_NAME &&
4687 pl == cbp->cb_proplist)
4690 if (zpool_get_prop(zhp, pl->pl_prop,
4691 value, sizeof (value), &srctype) != 0)
4694 zprop_print_one_property(zpool_get_name(zhp), cbp,
4695 zpool_prop_to_name(pl->pl_prop), value, srctype, NULL,
4702 zpool_do_get(int argc, char **argv)
4704 zprop_get_cbdata_t cb = { 0 };
4705 zprop_list_t fake_name = { 0 };
4711 cb.cb_first = B_TRUE;
4712 cb.cb_sources = ZPROP_SRC_ALL;
4713 cb.cb_columns[0] = GET_COL_NAME;
4714 cb.cb_columns[1] = GET_COL_PROPERTY;
4715 cb.cb_columns[2] = GET_COL_VALUE;
4716 cb.cb_columns[3] = GET_COL_SOURCE;
4717 cb.cb_type = ZFS_TYPE_POOL;
4719 if (zprop_get_list(g_zfs, argv[1], &cb.cb_proplist,
4720 ZFS_TYPE_POOL) != 0)
4723 if (cb.cb_proplist != NULL) {
4724 fake_name.pl_prop = ZPOOL_PROP_NAME;
4725 fake_name.pl_width = strlen(gettext("NAME"));
4726 fake_name.pl_next = cb.cb_proplist;
4727 cb.cb_proplist = &fake_name;
4730 ret = for_each_pool(argc - 2, argv + 2, B_TRUE, &cb.cb_proplist,
4733 if (cb.cb_proplist == &fake_name)
4734 zprop_free_list(fake_name.pl_next);
4736 zprop_free_list(cb.cb_proplist);
4741 typedef struct set_cbdata {
4744 boolean_t cb_any_successful;
4748 set_callback(zpool_handle_t *zhp, void *data)
4751 set_cbdata_t *cb = (set_cbdata_t *)data;
4753 error = zpool_set_prop(zhp, cb->cb_propname, cb->cb_value);
4756 cb->cb_any_successful = B_TRUE;
4762 zpool_do_set(int argc, char **argv)
4764 set_cbdata_t cb = { 0 };
4767 if (argc > 1 && argv[1][0] == '-') {
4768 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
4774 (void) fprintf(stderr, gettext("missing property=value "
4780 (void) fprintf(stderr, gettext("missing pool name\n"));
4785 (void) fprintf(stderr, gettext("too many pool names\n"));
4789 cb.cb_propname = argv[1];
4790 cb.cb_value = strchr(cb.cb_propname, '=');
4791 if (cb.cb_value == NULL) {
4792 (void) fprintf(stderr, gettext("missing value in "
4793 "property=value argument\n"));
4797 *(cb.cb_value) = '\0';
4800 error = for_each_pool(argc - 2, argv + 2, B_TRUE, NULL,
4807 find_command_idx(char *command, int *idx)
4811 for (i = 0; i < NCOMMAND; i++) {
4812 if (command_table[i].name == NULL)
4815 if (strcmp(command, command_table[i].name) == 0) {
4824 main(int argc, char **argv)
4830 (void) setlocale(LC_ALL, "");
4831 (void) textdomain(TEXT_DOMAIN);
4836 * Make sure the user has specified some command.
4839 (void) fprintf(stderr, gettext("missing command\n"));
4848 if ((strcmp(cmdname, "-?") == 0) ||
4849 strcmp(cmdname, "--help") == 0)
4852 if ((g_zfs = libzfs_init()) == NULL)
4855 libzfs_print_on_error(g_zfs, B_TRUE);
4857 zpool_set_history_str("zpool", argc, argv, history_str);
4858 verify(zpool_stage_history(g_zfs, history_str) == 0);
4861 * Run the appropriate command.
4863 if (find_command_idx(cmdname, &i) == 0) {
4864 current_command = &command_table[i];
4865 ret = command_table[i].func(argc - 1, argv + 1);
4866 } else if (strchr(cmdname, '=')) {
4867 verify(find_command_idx("set", &i) == 0);
4868 current_command = &command_table[i];
4869 ret = command_table[i].func(argc, argv);
4870 } else if (strcmp(cmdname, "freeze") == 0 && argc == 3) {
4872 * 'freeze' is a vile debugging abomination, so we treat
4876 int fd = open(ZFS_DEV, O_RDWR);
4877 (void) strcpy((void *)buf, argv[2]);
4878 return (!!ioctl(fd, ZFS_IOC_POOL_FREEZE, buf));
4880 (void) fprintf(stderr, gettext("unrecognized "
4881 "command '%s'\n"), cmdname);
4889 * The 'ZFS_ABORT' environment variable causes us to dump core on exit
4890 * for the purposes of running ::findleaks.
4892 if (getenv("ZFS_ABORT") != NULL) {
4893 (void) printf("dumping core by request\n");