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) 2013 by Delphix. All rights reserved.
26 * Copyright (c) 2012 by Frederik Wessels. All rights reserved.
27 * Copyright (c) 2012 Martin Matuska <mm@FreeBSD.org>. All rights reserved.
28 * Copyright (c) 2013 by Prasad Joshi (sTec). All rights reserved.
51 #include <sys/fs/zfs.h>
56 #include "zpool_util.h"
57 #include "zfs_comutil.h"
58 #include "zfeature_common.h"
60 #include "statcommon.h"
62 static int zpool_do_create(int, char **);
63 static int zpool_do_destroy(int, char **);
65 static int zpool_do_add(int, char **);
66 static int zpool_do_remove(int, char **);
67 static int zpool_do_labelclear(int, char **);
69 static int zpool_do_list(int, char **);
70 static int zpool_do_iostat(int, char **);
71 static int zpool_do_status(int, char **);
73 static int zpool_do_online(int, char **);
74 static int zpool_do_offline(int, char **);
75 static int zpool_do_clear(int, char **);
76 static int zpool_do_reopen(int, char **);
78 static int zpool_do_reguid(int, char **);
80 static int zpool_do_attach(int, char **);
81 static int zpool_do_detach(int, char **);
82 static int zpool_do_replace(int, char **);
83 static int zpool_do_split(int, char **);
85 static int zpool_do_scrub(int, char **);
87 static int zpool_do_import(int, char **);
88 static int zpool_do_export(int, char **);
90 static int zpool_do_upgrade(int, char **);
92 static int zpool_do_history(int, char **);
94 static int zpool_do_get(int, char **);
95 static int zpool_do_set(int, char **);
98 * These libumem hooks provide a reasonable set of defaults for the allocator's
99 * debugging facilities.
104 _umem_debug_init(void)
106 return ("default,verbose"); /* $UMEM_DEBUG setting */
110 _umem_logging_init(void)
112 return ("fail,contents"); /* $UMEM_LOGGING setting */
144 typedef struct zpool_command {
146 int (*func)(int, char **);
151 * Master command table. Each ZFS command has a name, associated function, and
152 * usage message. The usage messages need to be internationalized, so we have
153 * to have a function to return the usage message based on a command index.
155 * These commands are organized according to how they are displayed in the usage
156 * message. An empty command (one with a NULL name) indicates an empty line in
157 * the generic usage message.
159 static zpool_command_t command_table[] = {
160 { "create", zpool_do_create, HELP_CREATE },
161 { "destroy", zpool_do_destroy, HELP_DESTROY },
163 { "add", zpool_do_add, HELP_ADD },
164 { "remove", zpool_do_remove, HELP_REMOVE },
166 { "labelclear", zpool_do_labelclear, HELP_LABELCLEAR },
168 { "list", zpool_do_list, HELP_LIST },
169 { "iostat", zpool_do_iostat, HELP_IOSTAT },
170 { "status", zpool_do_status, HELP_STATUS },
172 { "online", zpool_do_online, HELP_ONLINE },
173 { "offline", zpool_do_offline, HELP_OFFLINE },
174 { "clear", zpool_do_clear, HELP_CLEAR },
175 { "reopen", zpool_do_reopen, HELP_REOPEN },
177 { "attach", zpool_do_attach, HELP_ATTACH },
178 { "detach", zpool_do_detach, HELP_DETACH },
179 { "replace", zpool_do_replace, HELP_REPLACE },
180 { "split", zpool_do_split, HELP_SPLIT },
182 { "scrub", zpool_do_scrub, HELP_SCRUB },
184 { "import", zpool_do_import, HELP_IMPORT },
185 { "export", zpool_do_export, HELP_EXPORT },
186 { "upgrade", zpool_do_upgrade, HELP_UPGRADE },
187 { "reguid", zpool_do_reguid, HELP_REGUID },
189 { "history", zpool_do_history, HELP_HISTORY },
190 { "get", zpool_do_get, HELP_GET },
191 { "set", zpool_do_set, HELP_SET },
194 #define NCOMMAND (sizeof (command_table) / sizeof (command_table[0]))
196 static zpool_command_t *current_command;
197 static char history_str[HIS_MAX_RECORD_LEN];
198 static boolean_t log_history = B_TRUE;
199 static uint_t timestamp_fmt = NODATE;
202 get_usage(zpool_help_t idx) {
205 return (gettext("\tadd [-fn] <pool> <vdev> ...\n"));
207 return (gettext("\tattach [-f] <pool> <device> "
210 return (gettext("\tclear [-nF] <pool> [device]\n"));
212 return (gettext("\tcreate [-fnd] [-o property=value] ... \n"
213 "\t [-O file-system-property=value] ... \n"
214 "\t [-m mountpoint] [-R root] <pool> <vdev> ...\n"));
216 return (gettext("\tdestroy [-f] <pool>\n"));
218 return (gettext("\tdetach <pool> <device>\n"));
220 return (gettext("\texport [-f] <pool> ...\n"));
222 return (gettext("\thistory [-il] [<pool>] ...\n"));
224 return (gettext("\timport [-d dir] [-D]\n"
225 "\timport [-d dir | -c cachefile] [-F [-n]] <pool | id>\n"
226 "\timport [-o mntopts] [-o property=value] ... \n"
227 "\t [-d dir | -c cachefile] [-D] [-f] [-m] [-N] "
228 "[-R root] [-F [-n]] -a\n"
229 "\timport [-o mntopts] [-o property=value] ... \n"
230 "\t [-d dir | -c cachefile] [-D] [-f] [-m] [-N] "
231 "[-R root] [-F [-n]]\n"
232 "\t <pool | id> [newpool]\n"));
234 return (gettext("\tiostat [-v] [-T d|u] [pool] ... [interval "
236 case HELP_LABELCLEAR:
237 return (gettext("\tlabelclear [-f] <vdev>\n"));
239 return (gettext("\tlist [-Hv] [-o property[,...]] "
240 "[-T d|u] [pool] ... [interval [count]]\n"));
242 return (gettext("\toffline [-t] <pool> <device> ...\n"));
244 return (gettext("\tonline [-e] <pool> <device> ...\n"));
246 return (gettext("\treplace [-f] <pool> <device> "
249 return (gettext("\tremove <pool> <device> ...\n"));
251 return (gettext("\treopen <pool>\n"));
253 return (gettext("\tscrub [-s] <pool> ...\n"));
255 return (gettext("\tstatus [-vx] [-T d|u] [pool] ... [interval "
258 return (gettext("\tupgrade [-v]\n"
259 "\tupgrade [-V version] <-a | pool ...>\n"));
261 return (gettext("\tget <\"all\" | property[,...]> "
264 return (gettext("\tset <property=value> <pool> \n"));
266 return (gettext("\tsplit [-n] [-R altroot] [-o mntopts]\n"
267 "\t [-o property=value] <pool> <newpool> "
268 "[<device> ...]\n"));
270 return (gettext("\treguid <pool>\n"));
279 * Callback routine that will print out a pool property value.
282 print_prop_cb(int prop, void *cb)
286 (void) fprintf(fp, "\t%-15s ", zpool_prop_to_name(prop));
288 if (zpool_prop_readonly(prop))
289 (void) fprintf(fp, " NO ");
291 (void) fprintf(fp, " YES ");
293 if (zpool_prop_values(prop) == NULL)
294 (void) fprintf(fp, "-\n");
296 (void) fprintf(fp, "%s\n", zpool_prop_values(prop));
302 * Display usage message. If we're inside a command, display only the usage for
303 * that command. Otherwise, iterate over the entire command table and display
304 * a complete usage message.
307 usage(boolean_t requested)
309 FILE *fp = requested ? stdout : stderr;
311 if (current_command == NULL) {
314 (void) fprintf(fp, gettext("usage: zpool command args ...\n"));
316 gettext("where 'command' is one of the following:\n\n"));
318 for (i = 0; i < NCOMMAND; i++) {
319 if (command_table[i].name == NULL)
320 (void) fprintf(fp, "\n");
322 (void) fprintf(fp, "%s",
323 get_usage(command_table[i].usage));
326 (void) fprintf(fp, gettext("usage:\n"));
327 (void) fprintf(fp, "%s", get_usage(current_command->usage));
330 if (current_command != NULL &&
331 ((strcmp(current_command->name, "set") == 0) ||
332 (strcmp(current_command->name, "get") == 0) ||
333 (strcmp(current_command->name, "list") == 0))) {
336 gettext("\nthe following properties are supported:\n"));
338 (void) fprintf(fp, "\n\t%-15s %s %s\n\n",
339 "PROPERTY", "EDIT", "VALUES");
341 /* Iterate over all properties */
342 (void) zprop_iter(print_prop_cb, fp, B_FALSE, B_TRUE,
345 (void) fprintf(fp, "\t%-15s ", "feature@...");
346 (void) fprintf(fp, "YES disabled | enabled | active\n");
348 (void) fprintf(fp, gettext("\nThe feature@ properties must be "
349 "appended with a feature name.\nSee zpool-features(7).\n"));
353 * See comments at end of main().
355 if (getenv("ZFS_ABORT") != NULL) {
356 (void) printf("dumping core by request\n");
360 exit(requested ? 0 : 2);
364 print_vdev_tree(zpool_handle_t *zhp, const char *name, nvlist_t *nv, int indent,
365 boolean_t print_logs)
372 (void) printf("\t%*s%s\n", indent, "", name);
374 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
375 &child, &children) != 0)
378 for (c = 0; c < children; c++) {
379 uint64_t is_log = B_FALSE;
381 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
383 if ((is_log && !print_logs) || (!is_log && print_logs))
386 vname = zpool_vdev_name(g_zfs, zhp, child[c], B_FALSE);
387 print_vdev_tree(zhp, vname, child[c], indent + 2,
394 prop_list_contains_feature(nvlist_t *proplist)
397 for (nvp = nvlist_next_nvpair(proplist, NULL); NULL != nvp;
398 nvp = nvlist_next_nvpair(proplist, nvp)) {
399 if (zpool_prop_feature(nvpair_name(nvp)))
406 * Add a property pair (name, string-value) into a property nvlist.
409 add_prop_list(const char *propname, char *propval, nvlist_t **props,
412 zpool_prop_t prop = ZPROP_INVAL;
418 if (*props == NULL &&
419 nvlist_alloc(props, NV_UNIQUE_NAME, 0) != 0) {
420 (void) fprintf(stderr,
421 gettext("internal error: out of memory\n"));
428 const char *vname = zpool_prop_to_name(ZPOOL_PROP_VERSION);
430 if ((prop = zpool_name_to_prop(propname)) == ZPROP_INVAL &&
431 !zpool_prop_feature(propname)) {
432 (void) fprintf(stderr, gettext("property '%s' is "
433 "not a valid pool property\n"), propname);
438 * feature@ properties and version should not be specified
441 if ((prop == ZPROP_INVAL && zpool_prop_feature(propname) &&
442 nvlist_exists(proplist, vname)) ||
443 (prop == ZPOOL_PROP_VERSION &&
444 prop_list_contains_feature(proplist))) {
445 (void) fprintf(stderr, gettext("'feature@' and "
446 "'version' properties cannot be specified "
452 if (zpool_prop_feature(propname))
455 normnm = zpool_prop_to_name(prop);
457 if ((fprop = zfs_name_to_prop(propname)) != ZPROP_INVAL) {
458 normnm = zfs_prop_to_name(fprop);
464 if (nvlist_lookup_string(proplist, normnm, &strval) == 0 &&
465 prop != ZPOOL_PROP_CACHEFILE) {
466 (void) fprintf(stderr, gettext("property '%s' "
467 "specified multiple times\n"), propname);
471 if (nvlist_add_string(proplist, normnm, propval) != 0) {
472 (void) fprintf(stderr, gettext("internal "
473 "error: out of memory\n"));
481 * zpool add [-fn] <pool> <vdev> ...
483 * -f Force addition of devices, even if they appear in use
484 * -n Do not add the devices, but display the resulting layout if
485 * they were to be added.
487 * Adds the given vdevs to 'pool'. As with create, the bulk of this work is
488 * handled by get_vdev_spec(), which constructs the nvlist needed to pass to
492 zpool_do_add(int argc, char **argv)
494 boolean_t force = B_FALSE;
495 boolean_t dryrun = B_FALSE;
504 while ((c = getopt(argc, argv, "fn")) != -1) {
513 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
522 /* get pool name and check number of arguments */
524 (void) fprintf(stderr, gettext("missing pool name argument\n"));
528 (void) fprintf(stderr, gettext("missing vdev specification\n"));
537 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
540 if ((config = zpool_get_config(zhp, NULL)) == NULL) {
541 (void) fprintf(stderr, gettext("pool '%s' is unavailable\n"),
547 /* pass off to get_vdev_spec for processing */
548 nvroot = make_root_vdev(zhp, force, !force, B_FALSE, dryrun,
550 if (nvroot == NULL) {
556 nvlist_t *poolnvroot;
558 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
561 (void) printf(gettext("would update '%s' to the following "
562 "configuration:\n"), zpool_get_name(zhp));
564 /* print original main pool and new tree */
565 print_vdev_tree(zhp, poolname, poolnvroot, 0, B_FALSE);
566 print_vdev_tree(zhp, NULL, nvroot, 0, B_FALSE);
568 /* Do the same for the logs */
569 if (num_logs(poolnvroot) > 0) {
570 print_vdev_tree(zhp, "logs", poolnvroot, 0, B_TRUE);
571 print_vdev_tree(zhp, NULL, nvroot, 0, B_TRUE);
572 } else if (num_logs(nvroot) > 0) {
573 print_vdev_tree(zhp, "logs", nvroot, 0, B_TRUE);
578 ret = (zpool_add(zhp, nvroot) != 0);
588 * zpool remove <pool> <vdev> ...
590 * Removes the given vdev from the pool. Currently, this supports removing
591 * spares, cache, and log devices from the pool.
594 zpool_do_remove(int argc, char **argv)
603 /* get pool name and check number of arguments */
605 (void) fprintf(stderr, gettext("missing pool name argument\n"));
609 (void) fprintf(stderr, gettext("missing device\n"));
615 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
618 for (i = 1; i < argc; i++) {
619 if (zpool_vdev_remove(zhp, argv[i]) != 0)
627 * zpool labelclear <vdev>
629 * Verifies that the vdev is not active and zeros out the label information
633 zpool_do_labelclear(int argc, char **argv)
636 int c, fd = -1, ret = 0;
638 boolean_t inuse = B_FALSE;
639 boolean_t force = B_FALSE;
642 while ((c = getopt(argc, argv, "f")) != -1) {
648 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
659 (void) fprintf(stderr, gettext("missing vdev device name\n"));
664 if ((fd = open(vdev, O_RDWR)) < 0) {
665 (void) fprintf(stderr, gettext("Unable to open %s\n"), vdev);
670 if (zpool_in_use(g_zfs, fd, &state, &name, &inuse) != 0) {
674 (void) fprintf(stderr,
675 gettext("Unable to determine pool state for %s\n"
676 "Use -f to force the clearing any label data\n"), vdev);
684 case POOL_STATE_ACTIVE:
685 case POOL_STATE_SPARE:
686 case POOL_STATE_L2CACHE:
687 (void) fprintf(stderr,
688 gettext("labelclear operation failed.\n"
689 "\tVdev %s is a member (%s), of pool \"%s\".\n"
690 "\tTo remove label information from this device, export or destroy\n"
691 "\tthe pool, or remove %s from the configuration of this pool\n"
692 "\tand retry the labelclear operation\n"),
693 vdev, zpool_pool_state_to_name(state), name, vdev);
697 case POOL_STATE_EXPORTED:
701 (void) fprintf(stderr,
702 gettext("labelclear operation failed.\n"
703 "\tVdev %s is a member of the exported pool \"%s\".\n"
704 "\tUse \"zpool labelclear -f %s\" to force the removal of label\n"
710 case POOL_STATE_POTENTIALLY_ACTIVE:
714 (void) fprintf(stderr,
715 gettext("labelclear operation failed.\n"
716 "\tVdev %s is a member of the pool \"%s\".\n"
717 "\tThis pool is unknown to this system, but may be active on\n"
718 "\tanother system. Use \'zpool labelclear -f %s\' to force the\n"
719 "\tremoval of label information.\n"),
724 case POOL_STATE_DESTROYED:
725 /* inuse should never be set for a destoryed pool... */
731 if (zpool_clear_label(fd) != 0) {
732 (void) fprintf(stderr,
733 gettext("Label clear failed on vdev %s\n"), vdev);
746 * zpool create [-fnd] [-o property=value] ...
747 * [-O file-system-property=value] ...
748 * [-R root] [-m mountpoint] <pool> <dev> ...
750 * -f Force creation, even if devices appear in use
751 * -n Do not create the pool, but display the resulting layout if it
752 * were to be created.
753 * -R Create a pool under an alternate root
754 * -m Set default mountpoint for the root dataset. By default it's
756 * -o Set property=value.
757 * -d Don't automatically enable all supported pool features
758 * (individual features can be enabled with -o).
759 * -O Set fsproperty=value in the pool's root file system
761 * Creates the named pool according to the given vdev specification. The
762 * bulk of the vdev processing is done in get_vdev_spec() in zpool_vdev.c. Once
763 * we get the nvlist back from get_vdev_spec(), we either print out the contents
764 * (if '-n' was specified), or pass it to libzfs to do the creation.
767 zpool_do_create(int argc, char **argv)
769 boolean_t force = B_FALSE;
770 boolean_t dryrun = B_FALSE;
771 boolean_t enable_all_pool_feat = B_TRUE;
773 nvlist_t *nvroot = NULL;
776 char *altroot = NULL;
777 char *mountpoint = NULL;
778 nvlist_t *fsprops = NULL;
779 nvlist_t *props = NULL;
783 while ((c = getopt(argc, argv, ":fndR:m:o:O:")) != -1) {
792 enable_all_pool_feat = B_FALSE;
796 if (add_prop_list(zpool_prop_to_name(
797 ZPOOL_PROP_ALTROOT), optarg, &props, B_TRUE))
799 if (nvlist_lookup_string(props,
800 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE),
803 if (add_prop_list(zpool_prop_to_name(
804 ZPOOL_PROP_CACHEFILE), "none", &props, B_TRUE))
808 /* Equivalent to -O mountpoint=optarg */
812 if ((propval = strchr(optarg, '=')) == NULL) {
813 (void) fprintf(stderr, gettext("missing "
814 "'=' for -o option\n"));
820 if (add_prop_list(optarg, propval, &props, B_TRUE))
824 * If the user is creating a pool that doesn't support
825 * feature flags, don't enable any features.
827 if (zpool_name_to_prop(optarg) == ZPOOL_PROP_VERSION) {
831 ver = strtoull(propval, &end, 10);
833 ver < SPA_VERSION_FEATURES) {
834 enable_all_pool_feat = B_FALSE;
839 if ((propval = strchr(optarg, '=')) == NULL) {
840 (void) fprintf(stderr, gettext("missing "
841 "'=' for -O option\n"));
848 * Mountpoints are checked and then added later.
849 * Uniquely among properties, they can be specified
850 * more than once, to avoid conflict with -m.
852 if (0 == strcmp(optarg,
853 zfs_prop_to_name(ZFS_PROP_MOUNTPOINT))) {
854 mountpoint = propval;
855 } else if (add_prop_list(optarg, propval, &fsprops,
861 (void) fprintf(stderr, gettext("missing argument for "
862 "'%c' option\n"), optopt);
865 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
874 /* get pool name and check number of arguments */
876 (void) fprintf(stderr, gettext("missing pool name argument\n"));
880 (void) fprintf(stderr, gettext("missing vdev specification\n"));
887 * As a special case, check for use of '/' in the name, and direct the
888 * user to use 'zfs create' instead.
890 if (strchr(poolname, '/') != NULL) {
891 (void) fprintf(stderr, gettext("cannot create '%s': invalid "
892 "character '/' in pool name\n"), poolname);
893 (void) fprintf(stderr, gettext("use 'zfs create' to "
894 "create a dataset\n"));
898 /* pass off to get_vdev_spec for bulk processing */
899 nvroot = make_root_vdev(NULL, force, !force, B_FALSE, dryrun,
904 /* make_root_vdev() allows 0 toplevel children if there are spares */
905 if (!zfs_allocatable_devs(nvroot)) {
906 (void) fprintf(stderr, gettext("invalid vdev "
907 "specification: at least one toplevel vdev must be "
912 if (altroot != NULL && altroot[0] != '/') {
913 (void) fprintf(stderr, gettext("invalid alternate root '%s': "
914 "must be an absolute path\n"), altroot);
919 * Check the validity of the mountpoint and direct the user to use the
920 * '-m' mountpoint option if it looks like its in use.
921 * Ignore the checks if the '-f' option is given.
923 if (!force && (mountpoint == NULL ||
924 (strcmp(mountpoint, ZFS_MOUNTPOINT_LEGACY) != 0 &&
925 strcmp(mountpoint, ZFS_MOUNTPOINT_NONE) != 0))) {
926 char buf[MAXPATHLEN];
929 if (mountpoint && mountpoint[0] != '/') {
930 (void) fprintf(stderr, gettext("invalid mountpoint "
931 "'%s': must be an absolute path, 'legacy', or "
932 "'none'\n"), mountpoint);
936 if (mountpoint == NULL) {
938 (void) snprintf(buf, sizeof (buf), "%s/%s",
941 (void) snprintf(buf, sizeof (buf), "/%s",
945 (void) snprintf(buf, sizeof (buf), "%s%s",
946 altroot, mountpoint);
948 (void) snprintf(buf, sizeof (buf), "%s",
952 if ((dirp = opendir(buf)) == NULL && errno != ENOENT) {
953 (void) fprintf(stderr, gettext("mountpoint '%s' : "
954 "%s\n"), buf, strerror(errno));
955 (void) fprintf(stderr, gettext("use '-m' "
956 "option to provide a different default\n"));
961 while (count < 3 && readdir(dirp) != NULL)
963 (void) closedir(dirp);
966 (void) fprintf(stderr, gettext("mountpoint "
967 "'%s' exists and is not empty\n"), buf);
968 (void) fprintf(stderr, gettext("use '-m' "
969 "option to provide a "
970 "different default\n"));
977 * Now that the mountpoint's validity has been checked, ensure that
978 * the property is set appropriately prior to creating the pool.
980 if (mountpoint != NULL) {
981 ret = add_prop_list(zfs_prop_to_name(ZFS_PROP_MOUNTPOINT),
982 mountpoint, &fsprops, B_FALSE);
990 * For a dry run invocation, print out a basic message and run
991 * through all the vdevs in the list and print out in an
992 * appropriate hierarchy.
994 (void) printf(gettext("would create '%s' with the "
995 "following layout:\n\n"), poolname);
997 print_vdev_tree(NULL, poolname, nvroot, 0, B_FALSE);
998 if (num_logs(nvroot) > 0)
999 print_vdev_tree(NULL, "logs", nvroot, 0, B_TRUE);
1004 * Hand off to libzfs.
1006 if (enable_all_pool_feat) {
1008 for (i = 0; i < SPA_FEATURES; i++) {
1009 char propname[MAXPATHLEN];
1010 zfeature_info_t *feat = &spa_feature_table[i];
1012 (void) snprintf(propname, sizeof (propname),
1013 "feature@%s", feat->fi_uname);
1016 * Skip feature if user specified it manually
1017 * on the command line.
1019 if (nvlist_exists(props, propname))
1022 ret = add_prop_list(propname,
1023 ZFS_FEATURE_ENABLED, &props, B_TRUE);
1030 if (zpool_create(g_zfs, poolname,
1031 nvroot, props, fsprops) == 0) {
1032 zfs_handle_t *pool = zfs_open(g_zfs, poolname,
1033 ZFS_TYPE_FILESYSTEM);
1035 if (zfs_mount(pool, NULL, 0) == 0)
1036 ret = zfs_shareall(pool);
1039 } else if (libzfs_errno(g_zfs) == EZFS_INVALIDNAME) {
1040 (void) fprintf(stderr, gettext("pool name may have "
1046 nvlist_free(nvroot);
1047 nvlist_free(fsprops);
1051 nvlist_free(fsprops);
1058 * zpool destroy <pool>
1060 * -f Forcefully unmount any datasets
1062 * Destroy the given pool. Automatically unmounts any datasets in the pool.
1065 zpool_do_destroy(int argc, char **argv)
1067 boolean_t force = B_FALSE;
1070 zpool_handle_t *zhp;
1074 while ((c = getopt(argc, argv, "f")) != -1) {
1080 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1089 /* check arguments */
1091 (void) fprintf(stderr, gettext("missing pool argument\n"));
1095 (void) fprintf(stderr, gettext("too many arguments\n"));
1101 if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL) {
1103 * As a special case, check for use of '/' in the name, and
1104 * direct the user to use 'zfs destroy' instead.
1106 if (strchr(pool, '/') != NULL)
1107 (void) fprintf(stderr, gettext("use 'zfs destroy' to "
1108 "destroy a dataset\n"));
1112 if (zpool_disable_datasets(zhp, force) != 0) {
1113 (void) fprintf(stderr, gettext("could not destroy '%s': "
1114 "could not unmount datasets\n"), zpool_get_name(zhp));
1118 /* The history must be logged as part of the export */
1119 log_history = B_FALSE;
1121 ret = (zpool_destroy(zhp, history_str) != 0);
1129 * zpool export [-f] <pool> ...
1131 * -f Forcefully unmount datasets
1133 * Export the given pools. By default, the command will attempt to cleanly
1134 * unmount any active datasets within the pool. If the '-f' flag is specified,
1135 * then the datasets will be forcefully unmounted.
1138 zpool_do_export(int argc, char **argv)
1140 boolean_t force = B_FALSE;
1141 boolean_t hardforce = B_FALSE;
1143 zpool_handle_t *zhp;
1148 while ((c = getopt(argc, argv, "fF")) != -1) {
1157 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
1166 /* check arguments */
1168 (void) fprintf(stderr, gettext("missing pool argument\n"));
1173 for (i = 0; i < argc; i++) {
1174 if ((zhp = zpool_open_canfail(g_zfs, argv[i])) == NULL) {
1179 if (zpool_disable_datasets(zhp, force) != 0) {
1185 /* The history must be logged as part of the export */
1186 log_history = B_FALSE;
1189 if (zpool_export_force(zhp, history_str) != 0)
1191 } else if (zpool_export(zhp, force, history_str) != 0) {
1202 * Given a vdev configuration, determine the maximum width needed for the device
1206 max_width(zpool_handle_t *zhp, nvlist_t *nv, int depth, int max)
1208 char *name = zpool_vdev_name(g_zfs, zhp, nv, B_TRUE);
1213 if (strlen(name) + depth > max)
1214 max = strlen(name) + depth;
1218 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_SPARES,
1219 &child, &children) == 0) {
1220 for (c = 0; c < children; c++)
1221 if ((ret = max_width(zhp, child[c], depth + 2,
1226 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE,
1227 &child, &children) == 0) {
1228 for (c = 0; c < children; c++)
1229 if ((ret = max_width(zhp, child[c], depth + 2,
1234 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1235 &child, &children) == 0) {
1236 for (c = 0; c < children; c++)
1237 if ((ret = max_width(zhp, child[c], depth + 2,
1246 typedef struct spare_cbdata {
1248 zpool_handle_t *cb_zhp;
1252 find_vdev(nvlist_t *nv, uint64_t search)
1258 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &guid) == 0 &&
1262 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1263 &child, &children) == 0) {
1264 for (c = 0; c < children; c++)
1265 if (find_vdev(child[c], search))
1273 find_spare(zpool_handle_t *zhp, void *data)
1275 spare_cbdata_t *cbp = data;
1276 nvlist_t *config, *nvroot;
1278 config = zpool_get_config(zhp, NULL);
1279 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
1282 if (find_vdev(nvroot, cbp->cb_guid)) {
1292 * Print out configuration state as requested by status_callback.
1295 print_status_config(zpool_handle_t *zhp, const char *name, nvlist_t *nv,
1296 int namewidth, int depth, boolean_t isspare)
1299 uint_t c, vsc, children;
1300 pool_scan_stat_t *ps = NULL;
1302 char rbuf[6], wbuf[6], cbuf[6];
1304 uint64_t notpresent;
1309 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1310 &child, &children) != 0)
1313 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
1314 (uint64_t **)&vs, &vsc) == 0);
1316 state = zpool_state_to_name(vs->vs_state, vs->vs_aux);
1319 * For hot spares, we use the terms 'INUSE' and 'AVAILABLE' for
1322 if (vs->vs_aux == VDEV_AUX_SPARED)
1324 else if (vs->vs_state == VDEV_STATE_HEALTHY)
1328 (void) printf("\t%*s%-*s %-8s", depth, "", namewidth - depth,
1332 zfs_nicenum(vs->vs_read_errors, rbuf, sizeof (rbuf));
1333 zfs_nicenum(vs->vs_write_errors, wbuf, sizeof (wbuf));
1334 zfs_nicenum(vs->vs_checksum_errors, cbuf, sizeof (cbuf));
1335 (void) printf(" %5s %5s %5s", rbuf, wbuf, cbuf);
1338 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NOT_PRESENT,
1339 ¬present) == 0 ||
1340 vs->vs_state <= VDEV_STATE_CANT_OPEN) {
1342 if (nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0)
1343 (void) printf(" was %s", path);
1344 } else if (vs->vs_aux != 0) {
1347 switch (vs->vs_aux) {
1348 case VDEV_AUX_OPEN_FAILED:
1349 (void) printf(gettext("cannot open"));
1352 case VDEV_AUX_BAD_GUID_SUM:
1353 (void) printf(gettext("missing device"));
1356 case VDEV_AUX_NO_REPLICAS:
1357 (void) printf(gettext("insufficient replicas"));
1360 case VDEV_AUX_VERSION_NEWER:
1361 (void) printf(gettext("newer version"));
1364 case VDEV_AUX_UNSUP_FEAT:
1365 (void) printf(gettext("unsupported feature(s)"));
1368 case VDEV_AUX_ASHIFT_TOO_BIG:
1369 (void) printf(gettext("unsupported minimum blocksize"));
1372 case VDEV_AUX_SPARED:
1373 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID,
1375 if (zpool_iter(g_zfs, find_spare, &cb) == 1) {
1376 if (strcmp(zpool_get_name(cb.cb_zhp),
1377 zpool_get_name(zhp)) == 0)
1378 (void) printf(gettext("currently in "
1381 (void) printf(gettext("in use by "
1383 zpool_get_name(cb.cb_zhp));
1384 zpool_close(cb.cb_zhp);
1386 (void) printf(gettext("currently in use"));
1390 case VDEV_AUX_ERR_EXCEEDED:
1391 (void) printf(gettext("too many errors"));
1394 case VDEV_AUX_IO_FAILURE:
1395 (void) printf(gettext("experienced I/O failures"));
1398 case VDEV_AUX_BAD_LOG:
1399 (void) printf(gettext("bad intent log"));
1402 case VDEV_AUX_EXTERNAL:
1403 (void) printf(gettext("external device fault"));
1406 case VDEV_AUX_SPLIT_POOL:
1407 (void) printf(gettext("split into new pool"));
1411 (void) printf(gettext("corrupted data"));
1414 } else if (children == 0 && !isspare &&
1415 VDEV_STAT_VALID(vs_physical_ashift, vsc) &&
1416 vs->vs_configured_ashift < vs->vs_physical_ashift) {
1418 gettext(" block size: %dB configured, %dB native"),
1419 1 << vs->vs_configured_ashift, 1 << vs->vs_physical_ashift);
1422 (void) nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_SCAN_STATS,
1423 (uint64_t **)&ps, &c);
1425 if (ps && ps->pss_state == DSS_SCANNING &&
1426 vs->vs_scan_processed != 0 && children == 0) {
1427 (void) printf(gettext(" (%s)"),
1428 (ps->pss_func == POOL_SCAN_RESILVER) ?
1429 "resilvering" : "repairing");
1432 (void) printf("\n");
1434 for (c = 0; c < children; c++) {
1435 uint64_t islog = B_FALSE, ishole = B_FALSE;
1437 /* Don't print logs or holes here */
1438 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
1440 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_HOLE,
1442 if (islog || ishole)
1444 vname = zpool_vdev_name(g_zfs, zhp, child[c], B_TRUE);
1445 print_status_config(zhp, vname, child[c],
1446 namewidth, depth + 2, isspare);
1453 * Print the configuration of an exported pool. Iterate over all vdevs in the
1454 * pool, printing out the name and status for each one.
1457 print_import_config(const char *name, nvlist_t *nv, int namewidth, int depth)
1464 verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE, &type) == 0);
1465 if (strcmp(type, VDEV_TYPE_MISSING) == 0 ||
1466 strcmp(type, VDEV_TYPE_HOLE) == 0)
1469 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
1470 (uint64_t **)&vs, &c) == 0);
1472 (void) printf("\t%*s%-*s", depth, "", namewidth - depth, name);
1473 (void) printf(" %s", zpool_state_to_name(vs->vs_state, vs->vs_aux));
1475 if (vs->vs_aux != 0) {
1478 switch (vs->vs_aux) {
1479 case VDEV_AUX_OPEN_FAILED:
1480 (void) printf(gettext("cannot open"));
1483 case VDEV_AUX_BAD_GUID_SUM:
1484 (void) printf(gettext("missing device"));
1487 case VDEV_AUX_NO_REPLICAS:
1488 (void) printf(gettext("insufficient replicas"));
1491 case VDEV_AUX_VERSION_NEWER:
1492 (void) printf(gettext("newer version"));
1495 case VDEV_AUX_UNSUP_FEAT:
1496 (void) printf(gettext("unsupported feature(s)"));
1499 case VDEV_AUX_ERR_EXCEEDED:
1500 (void) printf(gettext("too many errors"));
1504 (void) printf(gettext("corrupted data"));
1508 (void) printf("\n");
1510 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1511 &child, &children) != 0)
1514 for (c = 0; c < children; c++) {
1515 uint64_t is_log = B_FALSE;
1517 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
1522 vname = zpool_vdev_name(g_zfs, NULL, child[c], B_TRUE);
1523 print_import_config(vname, child[c], namewidth, depth + 2);
1527 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE,
1528 &child, &children) == 0) {
1529 (void) printf(gettext("\tcache\n"));
1530 for (c = 0; c < children; c++) {
1531 vname = zpool_vdev_name(g_zfs, NULL, child[c], B_FALSE);
1532 (void) printf("\t %s\n", vname);
1537 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_SPARES,
1538 &child, &children) == 0) {
1539 (void) printf(gettext("\tspares\n"));
1540 for (c = 0; c < children; c++) {
1541 vname = zpool_vdev_name(g_zfs, NULL, child[c], B_FALSE);
1542 (void) printf("\t %s\n", vname);
1550 * Logs are recorded as top level vdevs in the main pool child array
1551 * but with "is_log" set to 1. We use either print_status_config() or
1552 * print_import_config() to print the top level logs then any log
1553 * children (eg mirrored slogs) are printed recursively - which
1554 * works because only the top level vdev is marked "is_log"
1557 print_logs(zpool_handle_t *zhp, nvlist_t *nv, int namewidth, boolean_t verbose)
1562 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN, &child,
1566 (void) printf(gettext("\tlogs\n"));
1568 for (c = 0; c < children; c++) {
1569 uint64_t is_log = B_FALSE;
1572 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
1576 name = zpool_vdev_name(g_zfs, zhp, child[c], B_TRUE);
1578 print_status_config(zhp, name, child[c], namewidth,
1581 print_import_config(name, child[c], namewidth, 2);
1587 * Display the status for the given pool.
1590 show_import(nvlist_t *config)
1592 uint64_t pool_state;
1604 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
1606 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
1608 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
1610 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
1613 verify(nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_VDEV_STATS,
1614 (uint64_t **)&vs, &vsc) == 0);
1615 health = zpool_state_to_name(vs->vs_state, vs->vs_aux);
1617 reason = zpool_import_status(config, &msgid);
1619 (void) printf(gettext(" pool: %s\n"), name);
1620 (void) printf(gettext(" id: %llu\n"), (u_longlong_t)guid);
1621 (void) printf(gettext(" state: %s"), health);
1622 if (pool_state == POOL_STATE_DESTROYED)
1623 (void) printf(gettext(" (DESTROYED)"));
1624 (void) printf("\n");
1627 case ZPOOL_STATUS_MISSING_DEV_R:
1628 case ZPOOL_STATUS_MISSING_DEV_NR:
1629 case ZPOOL_STATUS_BAD_GUID_SUM:
1630 (void) printf(gettext(" status: One or more devices are "
1631 "missing from the system.\n"));
1634 case ZPOOL_STATUS_CORRUPT_LABEL_R:
1635 case ZPOOL_STATUS_CORRUPT_LABEL_NR:
1636 (void) printf(gettext(" status: One or more devices contains "
1637 "corrupted data.\n"));
1640 case ZPOOL_STATUS_CORRUPT_DATA:
1642 gettext(" status: The pool data is corrupted.\n"));
1645 case ZPOOL_STATUS_OFFLINE_DEV:
1646 (void) printf(gettext(" status: One or more devices "
1647 "are offlined.\n"));
1650 case ZPOOL_STATUS_CORRUPT_POOL:
1651 (void) printf(gettext(" status: The pool metadata is "
1655 case ZPOOL_STATUS_VERSION_OLDER:
1656 (void) printf(gettext(" status: The pool is formatted using a "
1657 "legacy on-disk version.\n"));
1660 case ZPOOL_STATUS_VERSION_NEWER:
1661 (void) printf(gettext(" status: The pool is formatted using an "
1662 "incompatible version.\n"));
1665 case ZPOOL_STATUS_FEAT_DISABLED:
1666 (void) printf(gettext(" status: Some supported features are "
1667 "not enabled on the pool.\n"));
1670 case ZPOOL_STATUS_UNSUP_FEAT_READ:
1671 (void) printf(gettext("status: The pool uses the following "
1672 "feature(s) not supported on this sytem:\n"));
1673 zpool_print_unsup_feat(config);
1676 case ZPOOL_STATUS_UNSUP_FEAT_WRITE:
1677 (void) printf(gettext("status: The pool can only be accessed "
1678 "in read-only mode on this system. It\n\tcannot be "
1679 "accessed in read-write mode because it uses the "
1680 "following\n\tfeature(s) not supported on this system:\n"));
1681 zpool_print_unsup_feat(config);
1684 case ZPOOL_STATUS_HOSTID_MISMATCH:
1685 (void) printf(gettext(" status: The pool was last accessed by "
1686 "another system.\n"));
1689 case ZPOOL_STATUS_FAULTED_DEV_R:
1690 case ZPOOL_STATUS_FAULTED_DEV_NR:
1691 (void) printf(gettext(" status: One or more devices are "
1695 case ZPOOL_STATUS_BAD_LOG:
1696 (void) printf(gettext(" status: An intent log record cannot be "
1700 case ZPOOL_STATUS_RESILVERING:
1701 (void) printf(gettext(" status: One or more devices were being "
1705 case ZPOOL_STATUS_NON_NATIVE_ASHIFT:
1706 (void) printf(gettext("status: One or more devices were "
1707 "configured to use a non-native block size.\n"
1708 "\tExpect reduced performance.\n"));
1713 * No other status can be seen when importing pools.
1715 assert(reason == ZPOOL_STATUS_OK);
1719 * Print out an action according to the overall state of the pool.
1721 if (vs->vs_state == VDEV_STATE_HEALTHY) {
1722 if (reason == ZPOOL_STATUS_VERSION_OLDER ||
1723 reason == ZPOOL_STATUS_FEAT_DISABLED) {
1724 (void) printf(gettext(" action: The pool can be "
1725 "imported using its name or numeric identifier, "
1726 "though\n\tsome features will not be available "
1727 "without an explicit 'zpool upgrade'.\n"));
1728 } else if (reason == ZPOOL_STATUS_HOSTID_MISMATCH) {
1729 (void) printf(gettext(" action: The pool can be "
1730 "imported using its name or numeric "
1731 "identifier and\n\tthe '-f' flag.\n"));
1733 (void) printf(gettext(" action: The pool can be "
1734 "imported using its name or numeric "
1737 } else if (vs->vs_state == VDEV_STATE_DEGRADED) {
1738 (void) printf(gettext(" action: The pool can be imported "
1739 "despite missing or damaged devices. The\n\tfault "
1740 "tolerance of the pool may be compromised if imported.\n"));
1743 case ZPOOL_STATUS_VERSION_NEWER:
1744 (void) printf(gettext(" action: The pool cannot be "
1745 "imported. Access the pool on a system running "
1746 "newer\n\tsoftware, or recreate the pool from "
1749 case ZPOOL_STATUS_UNSUP_FEAT_READ:
1750 (void) printf(gettext("action: The pool cannot be "
1751 "imported. Access the pool on a system that "
1752 "supports\n\tthe required feature(s), or recreate "
1753 "the pool from backup.\n"));
1755 case ZPOOL_STATUS_UNSUP_FEAT_WRITE:
1756 (void) printf(gettext("action: The pool cannot be "
1757 "imported in read-write mode. Import the pool "
1759 "\t\"-o readonly=on\", access the pool on a system "
1760 "that supports the\n\trequired feature(s), or "
1761 "recreate the pool from backup.\n"));
1763 case ZPOOL_STATUS_MISSING_DEV_R:
1764 case ZPOOL_STATUS_MISSING_DEV_NR:
1765 case ZPOOL_STATUS_BAD_GUID_SUM:
1766 (void) printf(gettext(" action: The pool cannot be "
1767 "imported. Attach the missing\n\tdevices and try "
1771 (void) printf(gettext(" action: The pool cannot be "
1772 "imported due to damaged devices or data.\n"));
1776 /* Print the comment attached to the pool. */
1777 if (nvlist_lookup_string(config, ZPOOL_CONFIG_COMMENT, &comment) == 0)
1778 (void) printf(gettext("comment: %s\n"), comment);
1781 * If the state is "closed" or "can't open", and the aux state
1782 * is "corrupt data":
1784 if (((vs->vs_state == VDEV_STATE_CLOSED) ||
1785 (vs->vs_state == VDEV_STATE_CANT_OPEN)) &&
1786 (vs->vs_aux == VDEV_AUX_CORRUPT_DATA)) {
1787 if (pool_state == POOL_STATE_DESTROYED)
1788 (void) printf(gettext("\tThe pool was destroyed, "
1789 "but can be imported using the '-Df' flags.\n"));
1790 else if (pool_state != POOL_STATE_EXPORTED)
1791 (void) printf(gettext("\tThe pool may be active on "
1792 "another system, but can be imported using\n\t"
1793 "the '-f' flag.\n"));
1797 (void) printf(gettext(" see: http://illumos.org/msg/%s\n"),
1800 (void) printf(gettext(" config:\n\n"));
1802 namewidth = max_width(NULL, nvroot, 0, 0);
1806 print_import_config(name, nvroot, namewidth, 0);
1807 if (num_logs(nvroot) > 0)
1808 print_logs(NULL, nvroot, namewidth, B_FALSE);
1810 if (reason == ZPOOL_STATUS_BAD_GUID_SUM) {
1811 (void) printf(gettext("\n\tAdditional devices are known to "
1812 "be part of this pool, though their\n\texact "
1813 "configuration cannot be determined.\n"));
1818 * Perform the import for the given configuration. This passes the heavy
1819 * lifting off to zpool_import_props(), and then mounts the datasets contained
1823 do_import(nvlist_t *config, const char *newname, const char *mntopts,
1824 nvlist_t *props, int flags)
1826 zpool_handle_t *zhp;
1831 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
1834 verify(nvlist_lookup_uint64(config,
1835 ZPOOL_CONFIG_POOL_STATE, &state) == 0);
1836 verify(nvlist_lookup_uint64(config,
1837 ZPOOL_CONFIG_VERSION, &version) == 0);
1838 if (!SPA_VERSION_IS_SUPPORTED(version)) {
1839 (void) fprintf(stderr, gettext("cannot import '%s': pool "
1840 "is formatted using an unsupported ZFS version\n"), name);
1842 } else if (state != POOL_STATE_EXPORTED &&
1843 !(flags & ZFS_IMPORT_ANY_HOST)) {
1846 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_HOSTID,
1848 if ((unsigned long)hostid != gethostid()) {
1853 verify(nvlist_lookup_string(config,
1854 ZPOOL_CONFIG_HOSTNAME, &hostname) == 0);
1855 verify(nvlist_lookup_uint64(config,
1856 ZPOOL_CONFIG_TIMESTAMP, ×tamp) == 0);
1858 (void) fprintf(stderr, gettext("cannot import "
1859 "'%s': pool may be in use from other "
1860 "system, it was last accessed by %s "
1861 "(hostid: 0x%lx) on %s"), name, hostname,
1862 (unsigned long)hostid,
1863 asctime(localtime(&t)));
1864 (void) fprintf(stderr, gettext("use '-f' to "
1865 "import anyway\n"));
1869 (void) fprintf(stderr, gettext("cannot import '%s': "
1870 "pool may be in use from other system\n"), name);
1871 (void) fprintf(stderr, gettext("use '-f' to import "
1877 if (zpool_import_props(g_zfs, config, newname, props, flags) != 0)
1880 if (newname != NULL)
1881 name = (char *)newname;
1883 if ((zhp = zpool_open_canfail(g_zfs, name)) == NULL)
1886 if (zpool_get_state(zhp) != POOL_STATE_UNAVAIL &&
1887 !(flags & ZFS_IMPORT_ONLY) &&
1888 zpool_enable_datasets(zhp, mntopts, 0) != 0) {
1898 * zpool import [-d dir] [-D]
1899 * import [-o mntopts] [-o prop=value] ... [-R root] [-D]
1900 * [-d dir | -c cachefile] [-f] -a
1901 * import [-o mntopts] [-o prop=value] ... [-R root] [-D]
1902 * [-d dir | -c cachefile] [-f] [-n] [-F] <pool | id> [newpool]
1904 * -c Read pool information from a cachefile instead of searching
1907 * -d Scan in a specific directory, other than /dev/dsk. More than
1908 * one directory can be specified using multiple '-d' options.
1910 * -D Scan for previously destroyed pools or import all or only
1911 * specified destroyed pools.
1913 * -R Temporarily import the pool, with all mountpoints relative to
1914 * the given root. The pool will remain exported when the machine
1917 * -V Import even in the presence of faulted vdevs. This is an
1918 * intentionally undocumented option for testing purposes, and
1919 * treats the pool configuration as complete, leaving any bad
1920 * vdevs in the FAULTED state. In other words, it does verbatim
1923 * -f Force import, even if it appears that the pool is active.
1925 * -F Attempt rewind if necessary.
1927 * -n See if rewind would work, but don't actually rewind.
1929 * -N Import the pool but don't mount datasets.
1931 * -T Specify a starting txg to use for import. This option is
1932 * intentionally undocumented option for testing purposes.
1934 * -a Import all pools found.
1936 * -o Set property=value and/or temporary mount options (without '=').
1938 * The import command scans for pools to import, and import pools based on pool
1939 * name and GUID. The pool can also be renamed as part of the import process.
1942 zpool_do_import(int argc, char **argv)
1944 char **searchdirs = NULL;
1948 nvlist_t *pools = NULL;
1949 boolean_t do_all = B_FALSE;
1950 boolean_t do_destroyed = B_FALSE;
1951 char *mntopts = NULL;
1954 uint64_t searchguid = 0;
1955 char *searchname = NULL;
1957 nvlist_t *found_config;
1958 nvlist_t *policy = NULL;
1959 nvlist_t *props = NULL;
1961 int flags = ZFS_IMPORT_NORMAL;
1962 uint32_t rewind_policy = ZPOOL_NO_REWIND;
1963 boolean_t dryrun = B_FALSE;
1964 boolean_t do_rewind = B_FALSE;
1965 boolean_t xtreme_rewind = B_FALSE;
1966 uint64_t pool_state, txg = -1ULL;
1967 char *cachefile = NULL;
1968 importargs_t idata = { 0 };
1972 while ((c = getopt(argc, argv, ":aCc:d:DEfFmnNo:rR:T:VX")) != -1) {
1981 if (searchdirs == NULL) {
1982 searchdirs = safe_malloc(sizeof (char *));
1984 char **tmp = safe_malloc((nsearch + 1) *
1986 bcopy(searchdirs, tmp, nsearch *
1991 searchdirs[nsearch++] = optarg;
1994 do_destroyed = B_TRUE;
1997 flags |= ZFS_IMPORT_ANY_HOST;
2003 flags |= ZFS_IMPORT_MISSING_LOG;
2009 flags |= ZFS_IMPORT_ONLY;
2012 if ((propval = strchr(optarg, '=')) != NULL) {
2015 if (add_prop_list(optarg, propval,
2023 if (add_prop_list(zpool_prop_to_name(
2024 ZPOOL_PROP_ALTROOT), optarg, &props, B_TRUE))
2026 if (nvlist_lookup_string(props,
2027 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE),
2030 if (add_prop_list(zpool_prop_to_name(
2031 ZPOOL_PROP_CACHEFILE), "none", &props, B_TRUE))
2036 txg = strtoull(optarg, &endptr, 10);
2037 if (errno != 0 || *endptr != '\0') {
2038 (void) fprintf(stderr,
2039 gettext("invalid txg value\n"));
2042 rewind_policy = ZPOOL_DO_REWIND | ZPOOL_EXTREME_REWIND;
2045 flags |= ZFS_IMPORT_VERBATIM;
2048 xtreme_rewind = B_TRUE;
2051 (void) fprintf(stderr, gettext("missing argument for "
2052 "'%c' option\n"), optopt);
2056 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2065 if (cachefile && nsearch != 0) {
2066 (void) fprintf(stderr, gettext("-c is incompatible with -d\n"));
2070 if ((dryrun || xtreme_rewind) && !do_rewind) {
2071 (void) fprintf(stderr,
2072 gettext("-n or -X only meaningful with -F\n"));
2076 rewind_policy = ZPOOL_TRY_REWIND;
2078 rewind_policy = ZPOOL_DO_REWIND;
2080 rewind_policy |= ZPOOL_EXTREME_REWIND;
2082 /* In the future, we can capture further policy and include it here */
2083 if (nvlist_alloc(&policy, NV_UNIQUE_NAME, 0) != 0 ||
2084 nvlist_add_uint64(policy, ZPOOL_REWIND_REQUEST_TXG, txg) != 0 ||
2085 nvlist_add_uint32(policy, ZPOOL_REWIND_REQUEST, rewind_policy) != 0)
2088 if (searchdirs == NULL) {
2089 searchdirs = safe_malloc(sizeof (char *));
2090 searchdirs[0] = "/dev";
2094 /* check argument count */
2097 (void) fprintf(stderr, gettext("too many arguments\n"));
2102 (void) fprintf(stderr, gettext("too many arguments\n"));
2107 * Check for the SYS_CONFIG privilege. We do this explicitly
2108 * here because otherwise any attempt to discover pools will
2111 if (argc == 0 && !priv_ineffect(PRIV_SYS_CONFIG)) {
2112 (void) fprintf(stderr, gettext("cannot "
2113 "discover pools: permission denied\n"));
2115 nvlist_free(policy);
2121 * Depending on the arguments given, we do one of the following:
2123 * <none> Iterate through all pools and display information about
2126 * -a Iterate through all pools and try to import each one.
2128 * <id> Find the pool that corresponds to the given GUID/pool
2129 * name and import that one.
2131 * -D Above options applies only to destroyed pools.
2137 searchguid = strtoull(argv[0], &endptr, 10);
2138 if (errno != 0 || *endptr != '\0') {
2139 searchname = argv[0];
2142 found_config = NULL;
2145 * User specified a name or guid. Ensure it's unique.
2147 idata.unique = B_TRUE;
2151 idata.path = searchdirs;
2152 idata.paths = nsearch;
2153 idata.poolname = searchname;
2154 idata.guid = searchguid;
2155 idata.cachefile = cachefile;
2157 pools = zpool_search_import(g_zfs, &idata);
2159 if (pools != NULL && idata.exists &&
2160 (argc == 1 || strcmp(argv[0], argv[1]) == 0)) {
2161 (void) fprintf(stderr, gettext("cannot import '%s': "
2162 "a pool with that name already exists\n"),
2164 (void) fprintf(stderr, gettext("use the form '%s "
2165 "<pool | id> <newpool>' to give it a new name\n"),
2168 } else if (pools == NULL && idata.exists) {
2169 (void) fprintf(stderr, gettext("cannot import '%s': "
2170 "a pool with that name is already created/imported,\n"),
2172 (void) fprintf(stderr, gettext("and no additional pools "
2173 "with that name were found\n"));
2175 } else if (pools == NULL) {
2177 (void) fprintf(stderr, gettext("cannot import '%s': "
2178 "no such pool available\n"), argv[0]);
2185 nvlist_free(policy);
2190 * At this point we have a list of import candidate configs. Even if
2191 * we were searching by pool name or guid, we still need to
2192 * post-process the list to deal with pool state and possible
2198 while ((elem = nvlist_next_nvpair(pools, elem)) != NULL) {
2200 verify(nvpair_value_nvlist(elem, &config) == 0);
2202 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_STATE,
2204 if (!do_destroyed && pool_state == POOL_STATE_DESTROYED)
2206 if (do_destroyed && pool_state != POOL_STATE_DESTROYED)
2209 verify(nvlist_add_nvlist(config, ZPOOL_REWIND_POLICY,
2216 (void) printf("\n");
2219 err |= do_import(config, NULL, mntopts,
2222 show_import(config);
2224 } else if (searchname != NULL) {
2228 * We are searching for a pool based on name.
2230 verify(nvlist_lookup_string(config,
2231 ZPOOL_CONFIG_POOL_NAME, &name) == 0);
2233 if (strcmp(name, searchname) == 0) {
2234 if (found_config != NULL) {
2235 (void) fprintf(stderr, gettext(
2236 "cannot import '%s': more than "
2237 "one matching pool\n"), searchname);
2238 (void) fprintf(stderr, gettext(
2239 "import by numeric ID instead\n"));
2242 found_config = config;
2248 * Search for a pool by guid.
2250 verify(nvlist_lookup_uint64(config,
2251 ZPOOL_CONFIG_POOL_GUID, &guid) == 0);
2253 if (guid == searchguid)
2254 found_config = config;
2259 * If we were searching for a specific pool, verify that we found a
2260 * pool, and then do the import.
2262 if (argc != 0 && err == 0) {
2263 if (found_config == NULL) {
2264 (void) fprintf(stderr, gettext("cannot import '%s': "
2265 "no such pool available\n"), argv[0]);
2268 err |= do_import(found_config, argc == 1 ? NULL :
2269 argv[1], mntopts, props, flags);
2274 * If we were just looking for pools, report an error if none were
2277 if (argc == 0 && first)
2278 (void) fprintf(stderr,
2279 gettext("no pools available to import\n"));
2284 nvlist_free(policy);
2287 return (err ? 1 : 0);
2290 typedef struct iostat_cbdata {
2291 boolean_t cb_verbose;
2294 zpool_list_t *cb_list;
2298 print_iostat_separator(iostat_cbdata_t *cb)
2302 for (i = 0; i < cb->cb_namewidth; i++)
2304 (void) printf(" ----- ----- ----- ----- ----- -----\n");
2308 print_iostat_header(iostat_cbdata_t *cb)
2310 (void) printf("%*s capacity operations bandwidth\n",
2311 cb->cb_namewidth, "");
2312 (void) printf("%-*s alloc free read write read write\n",
2313 cb->cb_namewidth, "pool");
2314 print_iostat_separator(cb);
2318 * Display a single statistic.
2321 print_one_stat(uint64_t value)
2325 zfs_nicenum(value, buf, sizeof (buf));
2326 (void) printf(" %5s", buf);
2330 * Print out all the statistics for the given vdev. This can either be the
2331 * toplevel configuration, or called recursively. If 'name' is NULL, then this
2332 * is a verbose output, and we don't want to display the toplevel pool stats.
2335 print_vdev_stats(zpool_handle_t *zhp, const char *name, nvlist_t *oldnv,
2336 nvlist_t *newnv, iostat_cbdata_t *cb, int depth)
2338 nvlist_t **oldchild, **newchild;
2340 vdev_stat_t *oldvs, *newvs;
2341 vdev_stat_t zerovs = { 0 };
2346 if (oldnv != NULL) {
2347 verify(nvlist_lookup_uint64_array(oldnv,
2348 ZPOOL_CONFIG_VDEV_STATS, (uint64_t **)&oldvs, &c) == 0);
2353 verify(nvlist_lookup_uint64_array(newnv, ZPOOL_CONFIG_VDEV_STATS,
2354 (uint64_t **)&newvs, &c) == 0);
2356 if (strlen(name) + depth > cb->cb_namewidth)
2357 (void) printf("%*s%s", depth, "", name);
2359 (void) printf("%*s%s%*s", depth, "", name,
2360 (int)(cb->cb_namewidth - strlen(name) - depth), "");
2362 tdelta = newvs->vs_timestamp - oldvs->vs_timestamp;
2367 scale = (double)NANOSEC / tdelta;
2369 /* only toplevel vdevs have capacity stats */
2370 if (newvs->vs_space == 0) {
2371 (void) printf(" - -");
2373 print_one_stat(newvs->vs_alloc);
2374 print_one_stat(newvs->vs_space - newvs->vs_alloc);
2377 print_one_stat((uint64_t)(scale * (newvs->vs_ops[ZIO_TYPE_READ] -
2378 oldvs->vs_ops[ZIO_TYPE_READ])));
2380 print_one_stat((uint64_t)(scale * (newvs->vs_ops[ZIO_TYPE_WRITE] -
2381 oldvs->vs_ops[ZIO_TYPE_WRITE])));
2383 print_one_stat((uint64_t)(scale * (newvs->vs_bytes[ZIO_TYPE_READ] -
2384 oldvs->vs_bytes[ZIO_TYPE_READ])));
2386 print_one_stat((uint64_t)(scale * (newvs->vs_bytes[ZIO_TYPE_WRITE] -
2387 oldvs->vs_bytes[ZIO_TYPE_WRITE])));
2389 (void) printf("\n");
2391 if (!cb->cb_verbose)
2394 if (nvlist_lookup_nvlist_array(newnv, ZPOOL_CONFIG_CHILDREN,
2395 &newchild, &children) != 0)
2398 if (oldnv && nvlist_lookup_nvlist_array(oldnv, ZPOOL_CONFIG_CHILDREN,
2399 &oldchild, &c) != 0)
2402 for (c = 0; c < children; c++) {
2403 uint64_t ishole = B_FALSE, islog = B_FALSE;
2405 (void) nvlist_lookup_uint64(newchild[c], ZPOOL_CONFIG_IS_HOLE,
2408 (void) nvlist_lookup_uint64(newchild[c], ZPOOL_CONFIG_IS_LOG,
2411 if (ishole || islog)
2414 vname = zpool_vdev_name(g_zfs, zhp, newchild[c], B_FALSE);
2415 print_vdev_stats(zhp, vname, oldnv ? oldchild[c] : NULL,
2416 newchild[c], cb, depth + 2);
2421 * Log device section
2424 if (num_logs(newnv) > 0) {
2425 (void) printf("%-*s - - - - - "
2426 "-\n", cb->cb_namewidth, "logs");
2428 for (c = 0; c < children; c++) {
2429 uint64_t islog = B_FALSE;
2430 (void) nvlist_lookup_uint64(newchild[c],
2431 ZPOOL_CONFIG_IS_LOG, &islog);
2434 vname = zpool_vdev_name(g_zfs, zhp, newchild[c],
2436 print_vdev_stats(zhp, vname, oldnv ?
2437 oldchild[c] : NULL, newchild[c],
2446 * Include level 2 ARC devices in iostat output
2448 if (nvlist_lookup_nvlist_array(newnv, ZPOOL_CONFIG_L2CACHE,
2449 &newchild, &children) != 0)
2452 if (oldnv && nvlist_lookup_nvlist_array(oldnv, ZPOOL_CONFIG_L2CACHE,
2453 &oldchild, &c) != 0)
2457 (void) printf("%-*s - - - - - "
2458 "-\n", cb->cb_namewidth, "cache");
2459 for (c = 0; c < children; c++) {
2460 vname = zpool_vdev_name(g_zfs, zhp, newchild[c],
2462 print_vdev_stats(zhp, vname, oldnv ? oldchild[c] : NULL,
2463 newchild[c], cb, depth + 2);
2470 refresh_iostat(zpool_handle_t *zhp, void *data)
2472 iostat_cbdata_t *cb = data;
2476 * If the pool has disappeared, remove it from the list and continue.
2478 if (zpool_refresh_stats(zhp, &missing) != 0)
2482 pool_list_remove(cb->cb_list, zhp);
2488 * Callback to print out the iostats for the given pool.
2491 print_iostat(zpool_handle_t *zhp, void *data)
2493 iostat_cbdata_t *cb = data;
2494 nvlist_t *oldconfig, *newconfig;
2495 nvlist_t *oldnvroot, *newnvroot;
2497 newconfig = zpool_get_config(zhp, &oldconfig);
2499 if (cb->cb_iteration == 1)
2502 verify(nvlist_lookup_nvlist(newconfig, ZPOOL_CONFIG_VDEV_TREE,
2505 if (oldconfig == NULL)
2508 verify(nvlist_lookup_nvlist(oldconfig, ZPOOL_CONFIG_VDEV_TREE,
2512 * Print out the statistics for the pool.
2514 print_vdev_stats(zhp, zpool_get_name(zhp), oldnvroot, newnvroot, cb, 0);
2517 print_iostat_separator(cb);
2523 get_namewidth(zpool_handle_t *zhp, void *data)
2525 iostat_cbdata_t *cb = data;
2526 nvlist_t *config, *nvroot;
2528 if ((config = zpool_get_config(zhp, NULL)) != NULL) {
2529 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
2531 if (!cb->cb_verbose)
2532 cb->cb_namewidth = strlen(zpool_get_name(zhp));
2534 cb->cb_namewidth = max_width(zhp, nvroot, 0,
2539 * The width must fall into the range [10,38]. The upper limit is the
2540 * maximum we can have and still fit in 80 columns.
2542 if (cb->cb_namewidth < 10)
2543 cb->cb_namewidth = 10;
2544 if (cb->cb_namewidth > 38)
2545 cb->cb_namewidth = 38;
2551 * Parse the input string, get the 'interval' and 'count' value if there is one.
2554 get_interval_count(int *argcp, char **argv, unsigned long *iv,
2557 unsigned long interval = 0, count = 0;
2558 int argc = *argcp, errno;
2561 * Determine if the last argument is an integer or a pool name
2563 if (argc > 0 && isdigit(argv[argc - 1][0])) {
2567 interval = strtoul(argv[argc - 1], &end, 10);
2569 if (*end == '\0' && errno == 0) {
2570 if (interval == 0) {
2571 (void) fprintf(stderr, gettext("interval "
2572 "cannot be zero\n"));
2576 * Ignore the last parameter
2581 * If this is not a valid number, just plow on. The
2582 * user will get a more informative error message later
2590 * If the last argument is also an integer, then we have both a count
2593 if (argc > 0 && isdigit(argv[argc - 1][0])) {
2598 interval = strtoul(argv[argc - 1], &end, 10);
2600 if (*end == '\0' && errno == 0) {
2601 if (interval == 0) {
2602 (void) fprintf(stderr, gettext("interval "
2603 "cannot be zero\n"));
2608 * Ignore the last parameter
2622 get_timestamp_arg(char c)
2625 timestamp_fmt = UDATE;
2627 timestamp_fmt = DDATE;
2633 * zpool iostat [-v] [-T d|u] [pool] ... [interval [count]]
2635 * -v Display statistics for individual vdevs
2636 * -T Display a timestamp in date(1) or Unix format
2638 * This command can be tricky because we want to be able to deal with pool
2639 * creation/destruction as well as vdev configuration changes. The bulk of this
2640 * processing is handled by the pool_list_* routines in zpool_iter.c. We rely
2641 * on pool_list_update() to detect the addition of new pools. Configuration
2642 * changes are all handled within libzfs.
2645 zpool_do_iostat(int argc, char **argv)
2650 unsigned long interval = 0, count = 0;
2652 boolean_t verbose = B_FALSE;
2656 while ((c = getopt(argc, argv, "T:v")) != -1) {
2659 get_timestamp_arg(*optarg);
2665 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
2674 get_interval_count(&argc, argv, &interval, &count);
2677 * Construct the list of all interesting pools.
2680 if ((list = pool_list_get(argc, argv, NULL, &ret)) == NULL)
2683 if (pool_list_count(list) == 0 && argc != 0) {
2684 pool_list_free(list);
2688 if (pool_list_count(list) == 0 && interval == 0) {
2689 pool_list_free(list);
2690 (void) fprintf(stderr, gettext("no pools available\n"));
2695 * Enter the main iostat loop.
2698 cb.cb_verbose = verbose;
2699 cb.cb_iteration = 0;
2700 cb.cb_namewidth = 0;
2703 pool_list_update(list);
2705 if ((npools = pool_list_count(list)) == 0)
2709 * Refresh all statistics. This is done as an explicit step
2710 * before calculating the maximum name width, so that any
2711 * configuration changes are properly accounted for.
2713 (void) pool_list_iter(list, B_FALSE, refresh_iostat, &cb);
2716 * Iterate over all pools to determine the maximum width
2717 * for the pool / device name column across all pools.
2719 cb.cb_namewidth = 0;
2720 (void) pool_list_iter(list, B_FALSE, get_namewidth, &cb);
2722 if (timestamp_fmt != NODATE)
2723 print_timestamp(timestamp_fmt);
2726 * If it's the first time, or verbose mode, print the header.
2728 if (++cb.cb_iteration == 1 || verbose)
2729 print_iostat_header(&cb);
2731 (void) pool_list_iter(list, B_FALSE, print_iostat, &cb);
2734 * If there's more than one pool, and we're not in verbose mode
2735 * (which prints a separator for us), then print a separator.
2737 if (npools > 1 && !verbose)
2738 print_iostat_separator(&cb);
2741 (void) printf("\n");
2744 * Flush the output so that redirection to a file isn't buffered
2747 (void) fflush(stdout);
2752 if (count != 0 && --count == 0)
2755 (void) sleep(interval);
2758 pool_list_free(list);
2763 typedef struct list_cbdata {
2764 boolean_t cb_verbose;
2766 boolean_t cb_scripted;
2767 zprop_list_t *cb_proplist;
2771 * Given a list of columns to display, output appropriate headers for each one.
2774 print_header(list_cbdata_t *cb)
2776 zprop_list_t *pl = cb->cb_proplist;
2777 char headerbuf[ZPOOL_MAXPROPLEN];
2779 boolean_t first = B_TRUE;
2780 boolean_t right_justify;
2783 for (; pl != NULL; pl = pl->pl_next) {
2784 width = pl->pl_width;
2785 if (first && cb->cb_verbose) {
2787 * Reset the width to accommodate the verbose listing
2790 width = cb->cb_namewidth;
2798 right_justify = B_FALSE;
2799 if (pl->pl_prop != ZPROP_INVAL) {
2800 header = zpool_prop_column_name(pl->pl_prop);
2801 right_justify = zpool_prop_align_right(pl->pl_prop);
2805 for (i = 0; pl->pl_user_prop[i] != '\0'; i++)
2806 headerbuf[i] = toupper(pl->pl_user_prop[i]);
2807 headerbuf[i] = '\0';
2811 if (pl->pl_next == NULL && !right_justify)
2812 (void) printf("%s", header);
2813 else if (right_justify)
2814 (void) printf("%*s", width, header);
2816 (void) printf("%-*s", width, header);
2820 (void) printf("\n");
2824 * Given a pool and a list of properties, print out all the properties according
2825 * to the described layout.
2828 print_pool(zpool_handle_t *zhp, list_cbdata_t *cb)
2830 zprop_list_t *pl = cb->cb_proplist;
2831 boolean_t first = B_TRUE;
2832 char property[ZPOOL_MAXPROPLEN];
2834 boolean_t right_justify;
2837 for (; pl != NULL; pl = pl->pl_next) {
2839 width = pl->pl_width;
2840 if (first && cb->cb_verbose) {
2842 * Reset the width to accommodate the verbose listing
2845 width = cb->cb_namewidth;
2849 if (cb->cb_scripted)
2850 (void) printf("\t");
2857 right_justify = B_FALSE;
2858 if (pl->pl_prop != ZPROP_INVAL) {
2859 if (pl->pl_prop == ZPOOL_PROP_EXPANDSZ &&
2860 zpool_get_prop_int(zhp, pl->pl_prop, NULL) == 0)
2862 else if (zpool_get_prop(zhp, pl->pl_prop, property,
2863 sizeof (property), NULL) != 0)
2868 right_justify = zpool_prop_align_right(pl->pl_prop);
2869 } else if ((zpool_prop_feature(pl->pl_user_prop) ||
2870 zpool_prop_unsupported(pl->pl_user_prop)) &&
2871 zpool_prop_get_feature(zhp, pl->pl_user_prop, property,
2872 sizeof (property)) == 0) {
2880 * If this is being called in scripted mode, or if this is the
2881 * last column and it is left-justified, don't include a width
2884 if (cb->cb_scripted || (pl->pl_next == NULL && !right_justify))
2885 (void) printf("%s", propstr);
2886 else if (right_justify)
2887 (void) printf("%*s", width, propstr);
2889 (void) printf("%-*s", width, propstr);
2892 (void) printf("\n");
2896 print_one_column(zpool_prop_t prop, uint64_t value, boolean_t scripted)
2900 size_t width = zprop_width(prop, &fixed, ZFS_TYPE_POOL);
2902 zfs_nicenum(value, propval, sizeof (propval));
2904 if (prop == ZPOOL_PROP_EXPANDSZ && value == 0)
2905 (void) strlcpy(propval, "-", sizeof (propval));
2908 (void) printf("\t%s", propval);
2910 (void) printf(" %*s", width, propval);
2914 print_list_stats(zpool_handle_t *zhp, const char *name, nvlist_t *nv,
2915 list_cbdata_t *cb, int depth)
2921 boolean_t scripted = cb->cb_scripted;
2923 verify(nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
2924 (uint64_t **)&vs, &c) == 0);
2928 (void) printf("\t%s", name);
2929 else if (strlen(name) + depth > cb->cb_namewidth)
2930 (void) printf("%*s%s", depth, "", name);
2932 (void) printf("%*s%s%*s", depth, "", name,
2933 (int)(cb->cb_namewidth - strlen(name) - depth), "");
2935 /* only toplevel vdevs have capacity stats */
2936 if (vs->vs_space == 0) {
2938 (void) printf("\t-\t-\t-");
2940 (void) printf(" - - -");
2942 print_one_column(ZPOOL_PROP_SIZE, vs->vs_space,
2944 print_one_column(ZPOOL_PROP_CAPACITY, vs->vs_alloc,
2946 print_one_column(ZPOOL_PROP_FREE,
2947 vs->vs_space - vs->vs_alloc, scripted);
2949 print_one_column(ZPOOL_PROP_EXPANDSZ, vs->vs_esize,
2951 (void) printf("\n");
2954 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
2955 &child, &children) != 0)
2958 for (c = 0; c < children; c++) {
2959 uint64_t ishole = B_FALSE;
2961 if (nvlist_lookup_uint64(child[c],
2962 ZPOOL_CONFIG_IS_HOLE, &ishole) == 0 && ishole)
2965 vname = zpool_vdev_name(g_zfs, zhp, child[c], B_FALSE);
2966 print_list_stats(zhp, vname, child[c], cb, depth + 2);
2971 * Include level 2 ARC devices in iostat output
2973 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE,
2974 &child, &children) != 0)
2978 (void) printf("%-*s - - - - - "
2979 "-\n", cb->cb_namewidth, "cache");
2980 for (c = 0; c < children; c++) {
2981 vname = zpool_vdev_name(g_zfs, zhp, child[c],
2983 print_list_stats(zhp, vname, child[c], cb, depth + 2);
2991 * Generic callback function to list a pool.
2994 list_callback(zpool_handle_t *zhp, void *data)
2996 list_cbdata_t *cbp = data;
3000 config = zpool_get_config(zhp, NULL);
3002 print_pool(zhp, cbp);
3003 if (!cbp->cb_verbose)
3006 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
3008 print_list_stats(zhp, NULL, nvroot, cbp, 0);
3014 * zpool list [-H] [-o prop[,prop]*] [-T d|u] [pool] ... [interval [count]]
3016 * -H Scripted mode. Don't display headers, and separate properties
3018 * -o List of properties to display. Defaults to
3019 * "name,size,allocated,free,capacity,health,altroot"
3020 * -T Display a timestamp in date(1) or Unix format
3022 * List all pools in the system, whether or not they're healthy. Output space
3023 * statistics for each one, as well as health status summary.
3026 zpool_do_list(int argc, char **argv)
3030 list_cbdata_t cb = { 0 };
3031 static char default_props[] =
3032 "name,size,allocated,free,capacity,dedupratio,"
3034 char *props = default_props;
3035 unsigned long interval = 0, count = 0;
3037 boolean_t first = B_TRUE;
3040 while ((c = getopt(argc, argv, ":Ho:T:v")) != -1) {
3043 cb.cb_scripted = B_TRUE;
3049 get_timestamp_arg(*optarg);
3052 cb.cb_verbose = B_TRUE;
3055 (void) fprintf(stderr, gettext("missing argument for "
3056 "'%c' option\n"), optopt);
3060 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3069 get_interval_count(&argc, argv, &interval, &count);
3071 if (zprop_get_list(g_zfs, props, &cb.cb_proplist, ZFS_TYPE_POOL) != 0)
3074 if ((list = pool_list_get(argc, argv, &cb.cb_proplist, &ret)) == NULL)
3077 if (argc == 0 && !cb.cb_scripted && pool_list_count(list) == 0) {
3078 (void) printf(gettext("no pools available\n"));
3079 zprop_free_list(cb.cb_proplist);
3084 pool_list_update(list);
3086 if (pool_list_count(list) == 0)
3089 cb.cb_namewidth = 0;
3090 (void) pool_list_iter(list, B_FALSE, get_namewidth, &cb);
3092 if (timestamp_fmt != NODATE)
3093 print_timestamp(timestamp_fmt);
3095 if (!cb.cb_scripted && (first || cb.cb_verbose)) {
3099 ret = pool_list_iter(list, B_TRUE, list_callback, &cb);
3104 if (count != 0 && --count == 0)
3107 (void) sleep(interval);
3110 zprop_free_list(cb.cb_proplist);
3115 zpool_get_vdev_by_name(nvlist_t *nv, char *name)
3122 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
3123 &child, &children) != 0) {
3124 verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0);
3125 if (strncmp(name, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
3126 name += sizeof(_PATH_DEV) - 1;
3127 if (strncmp(path, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
3128 path += sizeof(_PATH_DEV) - 1;
3129 if (strcmp(name, path) == 0)
3134 for (c = 0; c < children; c++)
3135 if ((match = zpool_get_vdev_by_name(child[c], name)) != NULL)
3142 zpool_do_attach_or_replace(int argc, char **argv, int replacing)
3144 boolean_t force = B_FALSE;
3147 char *poolname, *old_disk, *new_disk;
3148 zpool_handle_t *zhp;
3152 while ((c = getopt(argc, argv, "f")) != -1) {
3158 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3167 /* get pool name and check number of arguments */
3169 (void) fprintf(stderr, gettext("missing pool name argument\n"));
3176 (void) fprintf(stderr,
3177 gettext("missing <device> specification\n"));
3185 (void) fprintf(stderr,
3186 gettext("missing <new_device> specification\n"));
3189 new_disk = old_disk;
3199 (void) fprintf(stderr, gettext("too many arguments\n"));
3203 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3206 if (zpool_get_config(zhp, NULL) == NULL) {
3207 (void) fprintf(stderr, gettext("pool '%s' is unavailable\n"),
3213 nvroot = make_root_vdev(zhp, force, B_FALSE, replacing, B_FALSE,
3215 if (nvroot == NULL) {
3220 ret = zpool_vdev_attach(zhp, old_disk, new_disk, nvroot, replacing);
3222 nvlist_free(nvroot);
3229 * zpool replace [-f] <pool> <device> <new_device>
3231 * -f Force attach, even if <new_device> appears to be in use.
3233 * Replace <device> with <new_device>.
3237 zpool_do_replace(int argc, char **argv)
3239 return (zpool_do_attach_or_replace(argc, argv, B_TRUE));
3243 * zpool attach [-f] <pool> <device> <new_device>
3245 * -f Force attach, even if <new_device> appears to be in use.
3247 * Attach <new_device> to the mirror containing <device>. If <device> is not
3248 * part of a mirror, then <device> will be transformed into a mirror of
3249 * <device> and <new_device>. In either case, <new_device> will begin life
3250 * with a DTL of [0, now], and will immediately begin to resilver itself.
3253 zpool_do_attach(int argc, char **argv)
3255 return (zpool_do_attach_or_replace(argc, argv, B_FALSE));
3259 * zpool detach [-f] <pool> <device>
3261 * -f Force detach of <device>, even if DTLs argue against it
3262 * (not supported yet)
3264 * Detach a device from a mirror. The operation will be refused if <device>
3265 * is the last device in the mirror, or if the DTLs indicate that this device
3266 * has the only valid copy of some data.
3270 zpool_do_detach(int argc, char **argv)
3273 char *poolname, *path;
3274 zpool_handle_t *zhp;
3278 while ((c = getopt(argc, argv, "f")) != -1) {
3282 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3291 /* get pool name and check number of arguments */
3293 (void) fprintf(stderr, gettext("missing pool name argument\n"));
3298 (void) fprintf(stderr,
3299 gettext("missing <device> specification\n"));
3306 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3309 ret = zpool_vdev_detach(zhp, path);
3317 * zpool split [-n] [-o prop=val] ...
3319 * [-R altroot] <pool> <newpool> [<device> ...]
3321 * -n Do not split the pool, but display the resulting layout if
3322 * it were to be split.
3323 * -o Set property=value, or set mount options.
3324 * -R Mount the split-off pool under an alternate root.
3326 * Splits the named pool and gives it the new pool name. Devices to be split
3327 * off may be listed, provided that no more than one device is specified
3328 * per top-level vdev mirror. The newly split pool is left in an exported
3329 * state unless -R is specified.
3331 * Restrictions: the top-level of the pool pool must only be made up of
3332 * mirrors; all devices in the pool must be healthy; no device may be
3333 * undergoing a resilvering operation.
3336 zpool_do_split(int argc, char **argv)
3338 char *srcpool, *newpool, *propval;
3339 char *mntopts = NULL;
3342 zpool_handle_t *zhp;
3343 nvlist_t *config, *props = NULL;
3345 flags.dryrun = B_FALSE;
3346 flags.import = B_FALSE;
3349 while ((c = getopt(argc, argv, ":R:no:")) != -1) {
3352 flags.import = B_TRUE;
3354 zpool_prop_to_name(ZPOOL_PROP_ALTROOT), optarg,
3355 &props, B_TRUE) != 0) {
3362 flags.dryrun = B_TRUE;
3365 if ((propval = strchr(optarg, '=')) != NULL) {
3368 if (add_prop_list(optarg, propval,
3369 &props, B_TRUE) != 0) {
3379 (void) fprintf(stderr, gettext("missing argument for "
3380 "'%c' option\n"), optopt);
3384 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3391 if (!flags.import && mntopts != NULL) {
3392 (void) fprintf(stderr, gettext("setting mntopts is only "
3393 "valid when importing the pool\n"));
3401 (void) fprintf(stderr, gettext("Missing pool name\n"));
3405 (void) fprintf(stderr, gettext("Missing new pool name\n"));
3415 if ((zhp = zpool_open(g_zfs, srcpool)) == NULL)
3418 config = split_mirror_vdev(zhp, newpool, props, flags, argc, argv);
3419 if (config == NULL) {
3423 (void) printf(gettext("would create '%s' with the "
3424 "following layout:\n\n"), newpool);
3425 print_vdev_tree(NULL, newpool, config, 0, B_FALSE);
3427 nvlist_free(config);
3432 if (ret != 0 || flags.dryrun || !flags.import)
3436 * The split was successful. Now we need to open the new
3437 * pool and import it.
3439 if ((zhp = zpool_open_canfail(g_zfs, newpool)) == NULL)
3441 if (zpool_get_state(zhp) != POOL_STATE_UNAVAIL &&
3442 zpool_enable_datasets(zhp, mntopts, 0) != 0) {
3444 (void) fprintf(stderr, gettext("Split was successful, but "
3445 "the datasets could not all be mounted\n"));
3446 (void) fprintf(stderr, gettext("Try doing '%s' with a "
3447 "different altroot\n"), "zpool import");
3457 * zpool online <pool> <device> ...
3460 zpool_do_online(int argc, char **argv)
3464 zpool_handle_t *zhp;
3466 vdev_state_t newstate;
3470 while ((c = getopt(argc, argv, "et")) != -1) {
3473 flags |= ZFS_ONLINE_EXPAND;
3477 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3486 /* get pool name and check number of arguments */
3488 (void) fprintf(stderr, gettext("missing pool name\n"));
3492 (void) fprintf(stderr, gettext("missing device name\n"));
3498 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3501 for (i = 1; i < argc; i++) {
3502 if (zpool_vdev_online(zhp, argv[i], flags, &newstate) == 0) {
3503 if (newstate != VDEV_STATE_HEALTHY) {
3504 (void) printf(gettext("warning: device '%s' "
3505 "onlined, but remains in faulted state\n"),
3507 if (newstate == VDEV_STATE_FAULTED)
3508 (void) printf(gettext("use 'zpool "
3509 "clear' to restore a faulted "
3512 (void) printf(gettext("use 'zpool "
3513 "replace' to replace devices "
3514 "that are no longer present\n"));
3527 * zpool offline [-ft] <pool> <device> ...
3529 * -f Force the device into the offline state, even if doing
3530 * so would appear to compromise pool availability.
3531 * (not supported yet)
3533 * -t Only take the device off-line temporarily. The offline
3534 * state will not be persistent across reboots.
3538 zpool_do_offline(int argc, char **argv)
3542 zpool_handle_t *zhp;
3544 boolean_t istmp = B_FALSE;
3547 while ((c = getopt(argc, argv, "ft")) != -1) {
3554 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3563 /* get pool name and check number of arguments */
3565 (void) fprintf(stderr, gettext("missing pool name\n"));
3569 (void) fprintf(stderr, gettext("missing device name\n"));
3575 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3578 for (i = 1; i < argc; i++) {
3579 if (zpool_vdev_offline(zhp, argv[i], istmp) != 0)
3589 * zpool clear <pool> [device]
3591 * Clear all errors associated with a pool or a particular device.
3594 zpool_do_clear(int argc, char **argv)
3598 boolean_t dryrun = B_FALSE;
3599 boolean_t do_rewind = B_FALSE;
3600 boolean_t xtreme_rewind = B_FALSE;
3601 uint32_t rewind_policy = ZPOOL_NO_REWIND;
3602 nvlist_t *policy = NULL;
3603 zpool_handle_t *zhp;
3604 char *pool, *device;
3607 while ((c = getopt(argc, argv, "FnX")) != -1) {
3616 xtreme_rewind = B_TRUE;
3619 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3629 (void) fprintf(stderr, gettext("missing pool name\n"));
3634 (void) fprintf(stderr, gettext("too many arguments\n"));
3638 if ((dryrun || xtreme_rewind) && !do_rewind) {
3639 (void) fprintf(stderr,
3640 gettext("-n or -X only meaningful with -F\n"));
3644 rewind_policy = ZPOOL_TRY_REWIND;
3646 rewind_policy = ZPOOL_DO_REWIND;
3648 rewind_policy |= ZPOOL_EXTREME_REWIND;
3650 /* In future, further rewind policy choices can be passed along here */
3651 if (nvlist_alloc(&policy, NV_UNIQUE_NAME, 0) != 0 ||
3652 nvlist_add_uint32(policy, ZPOOL_REWIND_REQUEST, rewind_policy) != 0)
3656 device = argc == 2 ? argv[1] : NULL;
3658 if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL) {
3659 nvlist_free(policy);
3663 if (zpool_clear(zhp, device, policy) != 0)
3668 nvlist_free(policy);
3674 * zpool reguid <pool>
3677 zpool_do_reguid(int argc, char **argv)
3681 zpool_handle_t *zhp;
3685 while ((c = getopt(argc, argv, "")) != -1) {
3688 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3697 /* get pool name and check number of arguments */
3699 (void) fprintf(stderr, gettext("missing pool name\n"));
3704 (void) fprintf(stderr, gettext("too many arguments\n"));
3709 if ((zhp = zpool_open(g_zfs, poolname)) == NULL)
3712 ret = zpool_reguid(zhp);
3720 * zpool reopen <pool>
3722 * Reopen the pool so that the kernel can update the sizes of all vdevs.
3725 zpool_do_reopen(int argc, char **argv)
3729 zpool_handle_t *zhp;
3733 while ((c = getopt(argc, argv, "")) != -1) {
3736 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3746 (void) fprintf(stderr, gettext("missing pool name\n"));
3751 (void) fprintf(stderr, gettext("too many arguments\n"));
3756 if ((zhp = zpool_open_canfail(g_zfs, pool)) == NULL)
3759 ret = zpool_reopen(zhp);
3764 typedef struct scrub_cbdata {
3771 scrub_callback(zpool_handle_t *zhp, void *data)
3773 scrub_cbdata_t *cb = data;
3777 * Ignore faulted pools.
3779 if (zpool_get_state(zhp) == POOL_STATE_UNAVAIL) {
3780 (void) fprintf(stderr, gettext("cannot scrub '%s': pool is "
3781 "currently unavailable\n"), zpool_get_name(zhp));
3785 err = zpool_scan(zhp, cb->cb_type);
3791 * zpool scrub [-s] <pool> ...
3793 * -s Stop. Stops any in-progress scrub.
3796 zpool_do_scrub(int argc, char **argv)
3801 cb.cb_type = POOL_SCAN_SCRUB;
3804 while ((c = getopt(argc, argv, "s")) != -1) {
3807 cb.cb_type = POOL_SCAN_NONE;
3810 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
3822 (void) fprintf(stderr, gettext("missing pool name argument\n"));
3826 return (for_each_pool(argc, argv, B_TRUE, NULL, scrub_callback, &cb));
3829 typedef struct status_cbdata {
3831 boolean_t cb_allpools;
3832 boolean_t cb_verbose;
3833 boolean_t cb_explain;
3835 boolean_t cb_dedup_stats;
3839 * Print out detailed scrub status.
3842 print_scan_status(pool_scan_stat_t *ps)
3845 uint64_t elapsed, mins_left, hours_left;
3846 uint64_t pass_exam, examined, total;
3848 double fraction_done;
3849 char processed_buf[7], examined_buf[7], total_buf[7], rate_buf[7];
3851 (void) printf(gettext(" scan: "));
3853 /* If there's never been a scan, there's not much to say. */
3854 if (ps == NULL || ps->pss_func == POOL_SCAN_NONE ||
3855 ps->pss_func >= POOL_SCAN_FUNCS) {
3856 (void) printf(gettext("none requested\n"));
3860 start = ps->pss_start_time;
3861 end = ps->pss_end_time;
3862 zfs_nicenum(ps->pss_processed, processed_buf, sizeof (processed_buf));
3864 assert(ps->pss_func == POOL_SCAN_SCRUB ||
3865 ps->pss_func == POOL_SCAN_RESILVER);
3867 * Scan is finished or canceled.
3869 if (ps->pss_state == DSS_FINISHED) {
3870 uint64_t minutes_taken = (end - start) / 60;
3873 if (ps->pss_func == POOL_SCAN_SCRUB) {
3874 fmt = gettext("scrub repaired %s in %lluh%um with "
3875 "%llu errors on %s");
3876 } else if (ps->pss_func == POOL_SCAN_RESILVER) {
3877 fmt = gettext("resilvered %s in %lluh%um with "
3878 "%llu errors on %s");
3881 (void) printf(fmt, processed_buf,
3882 (u_longlong_t)(minutes_taken / 60),
3883 (uint_t)(minutes_taken % 60),
3884 (u_longlong_t)ps->pss_errors,
3885 ctime((time_t *)&end));
3887 } else if (ps->pss_state == DSS_CANCELED) {
3888 if (ps->pss_func == POOL_SCAN_SCRUB) {
3889 (void) printf(gettext("scrub canceled on %s"),
3891 } else if (ps->pss_func == POOL_SCAN_RESILVER) {
3892 (void) printf(gettext("resilver canceled on %s"),
3898 assert(ps->pss_state == DSS_SCANNING);
3901 * Scan is in progress.
3903 if (ps->pss_func == POOL_SCAN_SCRUB) {
3904 (void) printf(gettext("scrub in progress since %s"),
3906 } else if (ps->pss_func == POOL_SCAN_RESILVER) {
3907 (void) printf(gettext("resilver in progress since %s"),
3911 examined = ps->pss_examined ? ps->pss_examined : 1;
3912 total = ps->pss_to_examine;
3913 fraction_done = (double)examined / total;
3915 /* elapsed time for this pass */
3916 elapsed = time(NULL) - ps->pss_pass_start;
3917 elapsed = elapsed ? elapsed : 1;
3918 pass_exam = ps->pss_pass_exam ? ps->pss_pass_exam : 1;
3919 rate = pass_exam / elapsed;
3920 rate = rate ? rate : 1;
3921 mins_left = ((total - examined) / rate) / 60;
3922 hours_left = mins_left / 60;
3924 zfs_nicenum(examined, examined_buf, sizeof (examined_buf));
3925 zfs_nicenum(total, total_buf, sizeof (total_buf));
3926 zfs_nicenum(rate, rate_buf, sizeof (rate_buf));
3929 * do not print estimated time if hours_left is more than 30 days
3931 (void) printf(gettext(" %s scanned out of %s at %s/s"),
3932 examined_buf, total_buf, rate_buf);
3933 if (hours_left < (30 * 24)) {
3934 (void) printf(gettext(", %lluh%um to go\n"),
3935 (u_longlong_t)hours_left, (uint_t)(mins_left % 60));
3937 (void) printf(gettext(
3938 ", (scan is slow, no estimated time)\n"));
3941 if (ps->pss_func == POOL_SCAN_RESILVER) {
3942 (void) printf(gettext(" %s resilvered, %.2f%% done\n"),
3943 processed_buf, 100 * fraction_done);
3944 } else if (ps->pss_func == POOL_SCAN_SCRUB) {
3945 (void) printf(gettext(" %s repaired, %.2f%% done\n"),
3946 processed_buf, 100 * fraction_done);
3951 print_error_log(zpool_handle_t *zhp)
3953 nvlist_t *nverrlist = NULL;
3956 size_t len = MAXPATHLEN * 2;
3958 if (zpool_get_errlog(zhp, &nverrlist) != 0) {
3959 (void) printf("errors: List of errors unavailable "
3960 "(insufficient privileges)\n");
3964 (void) printf("errors: Permanent errors have been "
3965 "detected in the following files:\n\n");
3967 pathname = safe_malloc(len);
3969 while ((elem = nvlist_next_nvpair(nverrlist, elem)) != NULL) {
3971 uint64_t dsobj, obj;
3973 verify(nvpair_value_nvlist(elem, &nv) == 0);
3974 verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_DATASET,
3976 verify(nvlist_lookup_uint64(nv, ZPOOL_ERR_OBJECT,
3978 zpool_obj_to_path(zhp, dsobj, obj, pathname, len);
3979 (void) printf("%7s %s\n", "", pathname);
3982 nvlist_free(nverrlist);
3986 print_spares(zpool_handle_t *zhp, nvlist_t **spares, uint_t nspares,
3995 (void) printf(gettext("\tspares\n"));
3997 for (i = 0; i < nspares; i++) {
3998 name = zpool_vdev_name(g_zfs, zhp, spares[i], B_FALSE);
3999 print_status_config(zhp, name, spares[i],
4000 namewidth, 2, B_TRUE);
4006 print_l2cache(zpool_handle_t *zhp, nvlist_t **l2cache, uint_t nl2cache,
4015 (void) printf(gettext("\tcache\n"));
4017 for (i = 0; i < nl2cache; i++) {
4018 name = zpool_vdev_name(g_zfs, zhp, l2cache[i], B_FALSE);
4019 print_status_config(zhp, name, l2cache[i],
4020 namewidth, 2, B_FALSE);
4026 print_dedup_stats(nvlist_t *config)
4028 ddt_histogram_t *ddh;
4034 * If the pool was faulted then we may not have been able to
4035 * obtain the config. Otherwise, if we have anything in the dedup
4036 * table continue processing the stats.
4038 if (nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_OBJ_STATS,
4039 (uint64_t **)&ddo, &c) != 0)
4042 (void) printf("\n");
4043 (void) printf(gettext(" dedup: "));
4044 if (ddo->ddo_count == 0) {
4045 (void) printf(gettext("no DDT entries\n"));
4049 (void) printf("DDT entries %llu, size %llu on disk, %llu in core\n",
4050 (u_longlong_t)ddo->ddo_count,
4051 (u_longlong_t)ddo->ddo_dspace,
4052 (u_longlong_t)ddo->ddo_mspace);
4054 verify(nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_STATS,
4055 (uint64_t **)&dds, &c) == 0);
4056 verify(nvlist_lookup_uint64_array(config, ZPOOL_CONFIG_DDT_HISTOGRAM,
4057 (uint64_t **)&ddh, &c) == 0);
4058 zpool_dump_ddt(dds, ddh);
4062 * Display a summary of pool status. Displays a summary such as:
4066 * reason: One or more devices ...
4067 * see: http://illumos.org/msg/ZFS-xxxx-01
4073 * When given the '-v' option, we print out the complete config. If the '-e'
4074 * option is specified, then we print out error rate information as well.
4077 status_callback(zpool_handle_t *zhp, void *data)
4079 status_cbdata_t *cbp = data;
4080 nvlist_t *config, *nvroot;
4087 config = zpool_get_config(zhp, NULL);
4088 reason = zpool_get_status(zhp, &msgid);
4093 * If we were given 'zpool status -x', only report those pools with
4096 if (cbp->cb_explain &&
4097 (reason == ZPOOL_STATUS_OK ||
4098 reason == ZPOOL_STATUS_VERSION_OLDER ||
4099 reason == ZPOOL_STATUS_FEAT_DISABLED)) {
4100 if (!cbp->cb_allpools) {
4101 (void) printf(gettext("pool '%s' is healthy\n"),
4102 zpool_get_name(zhp));
4104 cbp->cb_first = B_FALSE;
4110 cbp->cb_first = B_FALSE;
4112 (void) printf("\n");
4114 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
4116 verify(nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_VDEV_STATS,
4117 (uint64_t **)&vs, &c) == 0);
4118 health = zpool_state_to_name(vs->vs_state, vs->vs_aux);
4120 (void) printf(gettext(" pool: %s\n"), zpool_get_name(zhp));
4121 (void) printf(gettext(" state: %s\n"), health);
4124 case ZPOOL_STATUS_MISSING_DEV_R:
4125 (void) printf(gettext("status: One or more devices could not "
4126 "be opened. Sufficient replicas exist for\n\tthe pool to "
4127 "continue functioning in a degraded state.\n"));
4128 (void) printf(gettext("action: Attach the missing device and "
4129 "online it using 'zpool online'.\n"));
4132 case ZPOOL_STATUS_MISSING_DEV_NR:
4133 (void) printf(gettext("status: One or more devices could not "
4134 "be opened. There are insufficient\n\treplicas for the "
4135 "pool to continue functioning.\n"));
4136 (void) printf(gettext("action: Attach the missing device and "
4137 "online it using 'zpool online'.\n"));
4140 case ZPOOL_STATUS_CORRUPT_LABEL_R:
4141 (void) printf(gettext("status: One or more devices could not "
4142 "be used because the label is missing or\n\tinvalid. "
4143 "Sufficient replicas exist for the pool to continue\n\t"
4144 "functioning in a degraded state.\n"));
4145 (void) printf(gettext("action: Replace the device using "
4146 "'zpool replace'.\n"));
4149 case ZPOOL_STATUS_CORRUPT_LABEL_NR:
4150 (void) printf(gettext("status: One or more devices could not "
4151 "be used because the label is missing \n\tor invalid. "
4152 "There are insufficient replicas for the pool to "
4153 "continue\n\tfunctioning.\n"));
4154 zpool_explain_recover(zpool_get_handle(zhp),
4155 zpool_get_name(zhp), reason, config);
4158 case ZPOOL_STATUS_FAILING_DEV:
4159 (void) printf(gettext("status: One or more devices has "
4160 "experienced an unrecoverable error. An\n\tattempt was "
4161 "made to correct the error. Applications are "
4163 (void) printf(gettext("action: Determine if the device needs "
4164 "to be replaced, and clear the errors\n\tusing "
4165 "'zpool clear' or replace the device with 'zpool "
4169 case ZPOOL_STATUS_OFFLINE_DEV:
4170 (void) printf(gettext("status: One or more devices has "
4171 "been taken offline by the administrator.\n\tSufficient "
4172 "replicas exist for the pool to continue functioning in "
4173 "a\n\tdegraded state.\n"));
4174 (void) printf(gettext("action: Online the device using "
4175 "'zpool online' or replace the device with\n\t'zpool "
4179 case ZPOOL_STATUS_REMOVED_DEV:
4180 (void) printf(gettext("status: One or more devices has "
4181 "been removed by the administrator.\n\tSufficient "
4182 "replicas exist for the pool to continue functioning in "
4183 "a\n\tdegraded state.\n"));
4184 (void) printf(gettext("action: Online the device using "
4185 "'zpool online' or replace the device with\n\t'zpool "
4189 case ZPOOL_STATUS_RESILVERING:
4190 (void) printf(gettext("status: One or more devices is "
4191 "currently being resilvered. The pool will\n\tcontinue "
4192 "to function, possibly in a degraded state.\n"));
4193 (void) printf(gettext("action: Wait for the resilver to "
4197 case ZPOOL_STATUS_CORRUPT_DATA:
4198 (void) printf(gettext("status: One or more devices has "
4199 "experienced an error resulting in data\n\tcorruption. "
4200 "Applications may be affected.\n"));
4201 (void) printf(gettext("action: Restore the file in question "
4202 "if possible. Otherwise restore the\n\tentire pool from "
4206 case ZPOOL_STATUS_CORRUPT_POOL:
4207 (void) printf(gettext("status: The pool metadata is corrupted "
4208 "and the pool cannot be opened.\n"));
4209 zpool_explain_recover(zpool_get_handle(zhp),
4210 zpool_get_name(zhp), reason, config);
4213 case ZPOOL_STATUS_VERSION_OLDER:
4214 (void) printf(gettext("status: The pool is formatted using a "
4215 "legacy on-disk format. The pool can\n\tstill be used, "
4216 "but some features are unavailable.\n"));
4217 (void) printf(gettext("action: Upgrade the pool using 'zpool "
4218 "upgrade'. Once this is done, the\n\tpool will no longer "
4219 "be accessible on software that does not support feature\n"
4223 case ZPOOL_STATUS_VERSION_NEWER:
4224 (void) printf(gettext("status: The pool has been upgraded to a "
4225 "newer, incompatible on-disk version.\n\tThe pool cannot "
4226 "be accessed on this system.\n"));
4227 (void) printf(gettext("action: Access the pool from a system "
4228 "running more recent software, or\n\trestore the pool from "
4232 case ZPOOL_STATUS_FEAT_DISABLED:
4233 (void) printf(gettext("status: Some supported features are not "
4234 "enabled on the pool. The pool can\n\tstill be used, but "
4235 "some features are unavailable.\n"));
4236 (void) printf(gettext("action: Enable all features using "
4237 "'zpool upgrade'. Once this is done,\n\tthe pool may no "
4238 "longer be accessible by software that does not support\n\t"
4239 "the features. See zpool-features(7) for details.\n"));
4242 case ZPOOL_STATUS_UNSUP_FEAT_READ:
4243 (void) printf(gettext("status: The pool cannot be accessed on "
4244 "this system because it uses the\n\tfollowing feature(s) "
4245 "not supported on this system:\n"));
4246 zpool_print_unsup_feat(config);
4247 (void) printf("\n");
4248 (void) printf(gettext("action: Access the pool from a system "
4249 "that supports the required feature(s),\n\tor restore the "
4250 "pool from backup.\n"));
4253 case ZPOOL_STATUS_UNSUP_FEAT_WRITE:
4254 (void) printf(gettext("status: The pool can only be accessed "
4255 "in read-only mode on this system. It\n\tcannot be "
4256 "accessed in read-write mode because it uses the "
4257 "following\n\tfeature(s) not supported on this system:\n"));
4258 zpool_print_unsup_feat(config);
4259 (void) printf("\n");
4260 (void) printf(gettext("action: The pool cannot be accessed in "
4261 "read-write mode. Import the pool with\n"
4262 "\t\"-o readonly=on\", access the pool from a system that "
4263 "supports the\n\trequired feature(s), or restore the "
4264 "pool from backup.\n"));
4267 case ZPOOL_STATUS_FAULTED_DEV_R:
4268 (void) printf(gettext("status: One or more devices are "
4269 "faulted in response to persistent errors.\n\tSufficient "
4270 "replicas exist for the pool to continue functioning "
4271 "in a\n\tdegraded state.\n"));
4272 (void) printf(gettext("action: Replace the faulted device, "
4273 "or use 'zpool clear' to mark the device\n\trepaired.\n"));
4276 case ZPOOL_STATUS_FAULTED_DEV_NR:
4277 (void) printf(gettext("status: One or more devices are "
4278 "faulted in response to persistent errors. There are "
4279 "insufficient replicas for the pool to\n\tcontinue "
4281 (void) printf(gettext("action: Destroy and re-create the pool "
4282 "from a backup source. Manually marking the device\n"
4283 "\trepaired using 'zpool clear' may allow some data "
4284 "to be recovered.\n"));
4287 case ZPOOL_STATUS_IO_FAILURE_WAIT:
4288 case ZPOOL_STATUS_IO_FAILURE_CONTINUE:
4289 (void) printf(gettext("status: One or more devices are "
4290 "faulted in response to IO failures.\n"));
4291 (void) printf(gettext("action: Make sure the affected devices "
4292 "are connected, then run 'zpool clear'.\n"));
4295 case ZPOOL_STATUS_BAD_LOG:
4296 (void) printf(gettext("status: An intent log record "
4297 "could not be read.\n"
4298 "\tWaiting for adminstrator intervention to fix the "
4299 "faulted pool.\n"));
4300 (void) printf(gettext("action: Either restore the affected "
4301 "device(s) and run 'zpool online',\n"
4302 "\tor ignore the intent log records by running "
4303 "'zpool clear'.\n"));
4306 case ZPOOL_STATUS_NON_NATIVE_ASHIFT:
4307 (void) printf(gettext("status: One or more devices are "
4308 "configured to use a non-native block size.\n"
4309 "\tExpect reduced performance.\n"));
4310 (void) printf(gettext("action: Replace affected devices with "
4311 "devices that support the\n\tconfigured block size, or "
4312 "migrate data to a properly configured\n\tpool.\n"));
4317 * The remaining errors can't actually be generated, yet.
4319 assert(reason == ZPOOL_STATUS_OK);
4323 (void) printf(gettext(" see: http://illumos.org/msg/%s\n"),
4326 if (config != NULL) {
4329 nvlist_t **spares, **l2cache;
4330 uint_t nspares, nl2cache;
4331 pool_scan_stat_t *ps = NULL;
4333 (void) nvlist_lookup_uint64_array(nvroot,
4334 ZPOOL_CONFIG_SCAN_STATS, (uint64_t **)&ps, &c);
4335 print_scan_status(ps);
4337 namewidth = max_width(zhp, nvroot, 0, 0);
4341 (void) printf(gettext("config:\n\n"));
4342 (void) printf(gettext("\t%-*s %-8s %5s %5s %5s\n"), namewidth,
4343 "NAME", "STATE", "READ", "WRITE", "CKSUM");
4344 print_status_config(zhp, zpool_get_name(zhp), nvroot,
4345 namewidth, 0, B_FALSE);
4347 if (num_logs(nvroot) > 0)
4348 print_logs(zhp, nvroot, namewidth, B_TRUE);
4349 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_L2CACHE,
4350 &l2cache, &nl2cache) == 0)
4351 print_l2cache(zhp, l2cache, nl2cache, namewidth);
4353 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES,
4354 &spares, &nspares) == 0)
4355 print_spares(zhp, spares, nspares, namewidth);
4357 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_ERRCOUNT,
4359 nvlist_t *nverrlist = NULL;
4362 * If the approximate error count is small, get a
4363 * precise count by fetching the entire log and
4364 * uniquifying the results.
4366 if (nerr > 0 && nerr < 100 && !cbp->cb_verbose &&
4367 zpool_get_errlog(zhp, &nverrlist) == 0) {
4372 while ((elem = nvlist_next_nvpair(nverrlist,
4377 nvlist_free(nverrlist);
4379 (void) printf("\n");
4382 (void) printf(gettext("errors: No known data "
4384 else if (!cbp->cb_verbose)
4385 (void) printf(gettext("errors: %llu data "
4386 "errors, use '-v' for a list\n"),
4387 (u_longlong_t)nerr);
4389 print_error_log(zhp);
4392 if (cbp->cb_dedup_stats)
4393 print_dedup_stats(config);
4395 (void) printf(gettext("config: The configuration cannot be "
4403 * zpool status [-vx] [-T d|u] [pool] ... [interval [count]]
4405 * -v Display complete error logs
4406 * -x Display only pools with potential problems
4407 * -D Display dedup status (undocumented)
4408 * -T Display a timestamp in date(1) or Unix format
4410 * Describes the health status of all pools or some subset.
4413 zpool_do_status(int argc, char **argv)
4417 unsigned long interval = 0, count = 0;
4418 status_cbdata_t cb = { 0 };
4421 while ((c = getopt(argc, argv, "vxDT:")) != -1) {
4424 cb.cb_verbose = B_TRUE;
4427 cb.cb_explain = B_TRUE;
4430 cb.cb_dedup_stats = B_TRUE;
4433 get_timestamp_arg(*optarg);
4436 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
4445 get_interval_count(&argc, argv, &interval, &count);
4448 cb.cb_allpools = B_TRUE;
4450 cb.cb_first = B_TRUE;
4453 if (timestamp_fmt != NODATE)
4454 print_timestamp(timestamp_fmt);
4456 ret = for_each_pool(argc, argv, B_TRUE, NULL,
4457 status_callback, &cb);
4459 if (argc == 0 && cb.cb_count == 0)
4460 (void) printf(gettext("no pools available\n"));
4461 else if (cb.cb_explain && cb.cb_first && cb.cb_allpools)
4462 (void) printf(gettext("all pools are healthy\n"));
4470 if (count != 0 && --count == 0)
4473 (void) sleep(interval);
4479 typedef struct upgrade_cbdata {
4481 char cb_poolname[ZPOOL_MAXNAMELEN];
4483 uint64_t cb_version;
4489 is_root_pool(zpool_handle_t *zhp)
4491 static struct statfs sfs;
4492 static char *poolname = NULL;
4493 static boolean_t stated = B_FALSE;
4498 if (statfs("/", &sfs) == -1) {
4499 (void) fprintf(stderr,
4500 "Unable to stat root file system: %s.\n",
4504 if (strcmp(sfs.f_fstypename, "zfs") != 0)
4506 poolname = sfs.f_mntfromname;
4507 if ((slash = strchr(poolname, '/')) != NULL)
4510 return (poolname != NULL && strcmp(poolname, zpool_get_name(zhp)) == 0);
4514 root_pool_upgrade_check(zpool_handle_t *zhp, char *poolname, int size) {
4516 if (poolname[0] == '\0' && is_root_pool(zhp))
4517 (void) strlcpy(poolname, zpool_get_name(zhp), size);
4519 #endif /* FreeBSD */
4522 upgrade_version(zpool_handle_t *zhp, uint64_t version)
4526 uint64_t oldversion;
4528 config = zpool_get_config(zhp, NULL);
4529 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
4532 assert(SPA_VERSION_IS_SUPPORTED(oldversion));
4533 assert(oldversion < version);
4535 ret = zpool_upgrade(zhp, version);
4539 if (version >= SPA_VERSION_FEATURES) {
4540 (void) printf(gettext("Successfully upgraded "
4541 "'%s' from version %llu to feature flags.\n"),
4542 zpool_get_name(zhp), oldversion);
4544 (void) printf(gettext("Successfully upgraded "
4545 "'%s' from version %llu to version %llu.\n"),
4546 zpool_get_name(zhp), oldversion, version);
4553 upgrade_enable_all(zpool_handle_t *zhp, int *countp)
4556 boolean_t firstff = B_TRUE;
4557 nvlist_t *enabled = zpool_get_features(zhp);
4560 for (i = 0; i < SPA_FEATURES; i++) {
4561 const char *fname = spa_feature_table[i].fi_uname;
4562 const char *fguid = spa_feature_table[i].fi_guid;
4563 if (!nvlist_exists(enabled, fguid)) {
4565 verify(-1 != asprintf(&propname, "feature@%s", fname));
4566 ret = zpool_set_prop(zhp, propname,
4567 ZFS_FEATURE_ENABLED);
4575 (void) printf(gettext("Enabled the "
4576 "following features on '%s':\n"),
4577 zpool_get_name(zhp));
4580 (void) printf(gettext(" %s\n"), fname);
4591 upgrade_cb(zpool_handle_t *zhp, void *arg)
4593 upgrade_cbdata_t *cbp = arg;
4596 boolean_t printnl = B_FALSE;
4599 config = zpool_get_config(zhp, NULL);
4600 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
4603 assert(SPA_VERSION_IS_SUPPORTED(version));
4605 if (version < cbp->cb_version) {
4606 cbp->cb_first = B_FALSE;
4607 ret = upgrade_version(zhp, cbp->cb_version);
4611 root_pool_upgrade_check(zhp, cbp->cb_poolname,
4612 sizeof(cbp->cb_poolname));
4613 #endif /* ___FreeBSD__ */
4618 * If they did "zpool upgrade -a", then we could
4619 * be doing ioctls to different pools. We need
4620 * to log this history once to each pool, and bypass
4621 * the normal history logging that happens in main().
4623 (void) zpool_log_history(g_zfs, history_str);
4624 log_history = B_FALSE;
4628 if (cbp->cb_version >= SPA_VERSION_FEATURES) {
4630 ret = upgrade_enable_all(zhp, &count);
4635 cbp->cb_first = B_FALSE;
4638 * If they did "zpool upgrade -a", then we could
4639 * be doing ioctls to different pools. We need
4640 * to log this history once to each pool, and bypass
4641 * the normal history logging that happens in main().
4643 (void) zpool_log_history(g_zfs, history_str);
4644 log_history = B_FALSE;
4649 (void) printf(gettext("\n"));
4656 upgrade_list_older_cb(zpool_handle_t *zhp, void *arg)
4658 upgrade_cbdata_t *cbp = arg;
4662 config = zpool_get_config(zhp, NULL);
4663 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
4666 assert(SPA_VERSION_IS_SUPPORTED(version));
4668 if (version < SPA_VERSION_FEATURES) {
4669 if (cbp->cb_first) {
4670 (void) printf(gettext("The following pools are "
4671 "formatted with legacy version numbers and can\n"
4672 "be upgraded to use feature flags. After "
4673 "being upgraded, these pools\nwill no "
4674 "longer be accessible by software that does not "
4675 "support feature\nflags.\n\n"));
4676 (void) printf(gettext("VER POOL\n"));
4677 (void) printf(gettext("--- ------------\n"));
4678 cbp->cb_first = B_FALSE;
4681 (void) printf("%2llu %s\n", (u_longlong_t)version,
4682 zpool_get_name(zhp));
4689 upgrade_list_disabled_cb(zpool_handle_t *zhp, void *arg)
4691 upgrade_cbdata_t *cbp = arg;
4695 config = zpool_get_config(zhp, NULL);
4696 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
4699 if (version >= SPA_VERSION_FEATURES) {
4701 boolean_t poolfirst = B_TRUE;
4702 nvlist_t *enabled = zpool_get_features(zhp);
4704 for (i = 0; i < SPA_FEATURES; i++) {
4705 const char *fguid = spa_feature_table[i].fi_guid;
4706 const char *fname = spa_feature_table[i].fi_uname;
4707 if (!nvlist_exists(enabled, fguid)) {
4708 if (cbp->cb_first) {
4709 (void) printf(gettext("\nSome "
4710 "supported features are not "
4711 "enabled on the following pools. "
4712 "Once a\nfeature is enabled the "
4713 "pool may become incompatible with "
4714 "software\nthat does not support "
4716 "zpool-features(7) for "
4718 (void) printf(gettext("POOL "
4720 (void) printf(gettext("------"
4722 cbp->cb_first = B_FALSE;
4726 (void) printf(gettext("%s\n"),
4727 zpool_get_name(zhp));
4728 poolfirst = B_FALSE;
4731 (void) printf(gettext(" %s\n"), fname);
4741 upgrade_one(zpool_handle_t *zhp, void *data)
4743 boolean_t printnl = B_FALSE;
4744 upgrade_cbdata_t *cbp = data;
4745 uint64_t cur_version;
4748 if (strcmp("log", zpool_get_name(zhp)) == 0) {
4749 (void) printf(gettext("'log' is now a reserved word\n"
4750 "Pool 'log' must be renamed using export and import"
4755 cur_version = zpool_get_prop_int(zhp, ZPOOL_PROP_VERSION, NULL);
4756 if (cur_version > cbp->cb_version) {
4757 (void) printf(gettext("Pool '%s' is already formatted "
4758 "using more current version '%llu'.\n\n"),
4759 zpool_get_name(zhp), cur_version);
4763 if (cbp->cb_version != SPA_VERSION && cur_version == cbp->cb_version) {
4764 (void) printf(gettext("Pool '%s' is already formatted "
4765 "using version %llu.\n\n"), zpool_get_name(zhp),
4770 if (cur_version != cbp->cb_version) {
4772 ret = upgrade_version(zhp, cbp->cb_version);
4776 root_pool_upgrade_check(zhp, cbp->cb_poolname,
4777 sizeof(cbp->cb_poolname));
4778 #endif /* ___FreeBSD__ */
4781 if (cbp->cb_version >= SPA_VERSION_FEATURES) {
4783 ret = upgrade_enable_all(zhp, &count);
4790 root_pool_upgrade_check(zhp, cbp->cb_poolname,
4791 sizeof(cbp->cb_poolname));
4792 #endif /* __FreeBSD __*/
4793 } else if (cur_version == SPA_VERSION) {
4794 (void) printf(gettext("Pool '%s' already has all "
4795 "supported features enabled.\n"),
4796 zpool_get_name(zhp));
4801 (void) printf(gettext("\n"));
4810 * zpool upgrade [-V version] <-a | pool ...>
4812 * With no arguments, display downrev'd ZFS pool available for upgrade.
4813 * Individual pools can be upgraded by specifying the pool, and '-a' will
4814 * upgrade all pools.
4817 zpool_do_upgrade(int argc, char **argv)
4820 upgrade_cbdata_t cb = { 0 };
4822 boolean_t showversions = B_FALSE;
4823 boolean_t upgradeall = B_FALSE;
4828 while ((c = getopt(argc, argv, ":avV:")) != -1) {
4831 upgradeall = B_TRUE;
4834 showversions = B_TRUE;
4837 cb.cb_version = strtoll(optarg, &end, 10);
4839 !SPA_VERSION_IS_SUPPORTED(cb.cb_version)) {
4840 (void) fprintf(stderr,
4841 gettext("invalid version '%s'\n"), optarg);
4846 (void) fprintf(stderr, gettext("missing argument for "
4847 "'%c' option\n"), optopt);
4851 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
4862 if (cb.cb_version == 0) {
4863 cb.cb_version = SPA_VERSION;
4864 } else if (!upgradeall && argc == 0) {
4865 (void) fprintf(stderr, gettext("-V option is "
4866 "incompatible with other arguments\n"));
4871 if (upgradeall || argc != 0) {
4872 (void) fprintf(stderr, gettext("-v option is "
4873 "incompatible with other arguments\n"));
4876 } else if (upgradeall) {
4878 (void) fprintf(stderr, gettext("-a option should not "
4879 "be used along with a pool name\n"));
4884 (void) printf(gettext("This system supports ZFS pool feature "
4889 (void) printf(gettext("The following features are "
4891 (void) printf(gettext("FEAT DESCRIPTION\n"));
4892 (void) printf("----------------------------------------------"
4893 "---------------\n");
4894 for (i = 0; i < SPA_FEATURES; i++) {
4895 zfeature_info_t *fi = &spa_feature_table[i];
4896 const char *ro = fi->fi_can_readonly ?
4897 " (read-only compatible)" : "";
4899 (void) printf("%-37s%s\n", fi->fi_uname, ro);
4900 (void) printf(" %s\n", fi->fi_desc);
4902 (void) printf("\n");
4904 (void) printf(gettext("The following legacy versions are also "
4906 (void) printf(gettext("VER DESCRIPTION\n"));
4907 (void) printf("--- -----------------------------------------"
4908 "---------------\n");
4909 (void) printf(gettext(" 1 Initial ZFS version\n"));
4910 (void) printf(gettext(" 2 Ditto blocks "
4911 "(replicated metadata)\n"));
4912 (void) printf(gettext(" 3 Hot spares and double parity "
4914 (void) printf(gettext(" 4 zpool history\n"));
4915 (void) printf(gettext(" 5 Compression using the gzip "
4917 (void) printf(gettext(" 6 bootfs pool property\n"));
4918 (void) printf(gettext(" 7 Separate intent log devices\n"));
4919 (void) printf(gettext(" 8 Delegated administration\n"));
4920 (void) printf(gettext(" 9 refquota and refreservation "
4922 (void) printf(gettext(" 10 Cache devices\n"));
4923 (void) printf(gettext(" 11 Improved scrub performance\n"));
4924 (void) printf(gettext(" 12 Snapshot properties\n"));
4925 (void) printf(gettext(" 13 snapused property\n"));
4926 (void) printf(gettext(" 14 passthrough-x aclinherit\n"));
4927 (void) printf(gettext(" 15 user/group space accounting\n"));
4928 (void) printf(gettext(" 16 stmf property support\n"));
4929 (void) printf(gettext(" 17 Triple-parity RAID-Z\n"));
4930 (void) printf(gettext(" 18 Snapshot user holds\n"));
4931 (void) printf(gettext(" 19 Log device removal\n"));
4932 (void) printf(gettext(" 20 Compression using zle "
4933 "(zero-length encoding)\n"));
4934 (void) printf(gettext(" 21 Deduplication\n"));
4935 (void) printf(gettext(" 22 Received properties\n"));
4936 (void) printf(gettext(" 23 Slim ZIL\n"));
4937 (void) printf(gettext(" 24 System attributes\n"));
4938 (void) printf(gettext(" 25 Improved scrub stats\n"));
4939 (void) printf(gettext(" 26 Improved snapshot deletion "
4941 (void) printf(gettext(" 27 Improved snapshot creation "
4943 (void) printf(gettext(" 28 Multiple vdev replacements\n"));
4944 (void) printf(gettext("\nFor more information on a particular "
4945 "version, including supported releases,\n"));
4946 (void) printf(gettext("see the ZFS Administration Guide.\n\n"));
4947 } else if (argc == 0 && upgradeall) {
4948 cb.cb_first = B_TRUE;
4949 ret = zpool_iter(g_zfs, upgrade_cb, &cb);
4950 if (ret == 0 && cb.cb_first) {
4951 if (cb.cb_version == SPA_VERSION) {
4952 (void) printf(gettext("All pools are already "
4953 "formatted using feature flags.\n\n"));
4954 (void) printf(gettext("Every feature flags "
4955 "pool already has all supported features "
4958 (void) printf(gettext("All pools are already "
4959 "formatted with version %llu or higher.\n"),
4963 } else if (argc == 0) {
4964 cb.cb_first = B_TRUE;
4965 ret = zpool_iter(g_zfs, upgrade_list_older_cb, &cb);
4969 (void) printf(gettext("All pools are formatted "
4970 "using feature flags.\n\n"));
4972 (void) printf(gettext("\nUse 'zpool upgrade -v' "
4973 "for a list of available legacy versions.\n"));
4976 cb.cb_first = B_TRUE;
4977 ret = zpool_iter(g_zfs, upgrade_list_disabled_cb, &cb);
4981 (void) printf(gettext("Every feature flags pool has "
4982 "all supported features enabled.\n"));
4984 (void) printf(gettext("\n"));
4987 ret = for_each_pool(argc, argv, B_FALSE, NULL,
4991 if (cb.cb_poolname[0] != '\0') {
4993 "If you boot from pool '%s', don't forget to update boot code.\n"
4994 "Assuming you use GPT partitioning and da0 is your boot disk\n"
4995 "the following command will do it:\n"
4997 "\tgpart bootcode -b /boot/pmbr -p /boot/gptzfsboot -i 1 da0\n\n",
5004 typedef struct hist_cbdata {
5011 * Print out the command history for a specific pool.
5014 get_history_one(zpool_handle_t *zhp, void *data)
5020 hist_cbdata_t *cb = (hist_cbdata_t *)data;
5022 cb->first = B_FALSE;
5024 (void) printf(gettext("History for '%s':\n"), zpool_get_name(zhp));
5026 if ((ret = zpool_get_history(zhp, &nvhis)) != 0)
5029 verify(nvlist_lookup_nvlist_array(nvhis, ZPOOL_HIST_RECORD,
5030 &records, &numrecords) == 0);
5031 for (i = 0; i < numrecords; i++) {
5032 nvlist_t *rec = records[i];
5035 if (nvlist_exists(rec, ZPOOL_HIST_TIME)) {
5039 tsec = fnvlist_lookup_uint64(records[i],
5041 (void) localtime_r(&tsec, &t);
5042 (void) strftime(tbuf, sizeof (tbuf), "%F.%T", &t);
5045 if (nvlist_exists(rec, ZPOOL_HIST_CMD)) {
5046 (void) printf("%s %s", tbuf,
5047 fnvlist_lookup_string(rec, ZPOOL_HIST_CMD));
5048 } else if (nvlist_exists(rec, ZPOOL_HIST_INT_EVENT)) {
5050 fnvlist_lookup_uint64(rec, ZPOOL_HIST_INT_EVENT);
5053 if (ievent >= ZFS_NUM_LEGACY_HISTORY_EVENTS) {
5054 (void) printf("%s unrecognized record:\n",
5056 dump_nvlist(rec, 4);
5059 (void) printf("%s [internal %s txg:%lld] %s", tbuf,
5060 zfs_history_event_names[ievent],
5061 fnvlist_lookup_uint64(rec, ZPOOL_HIST_TXG),
5062 fnvlist_lookup_string(rec, ZPOOL_HIST_INT_STR));
5063 } else if (nvlist_exists(rec, ZPOOL_HIST_INT_NAME)) {
5066 (void) printf("%s [txg:%lld] %s", tbuf,
5067 fnvlist_lookup_uint64(rec, ZPOOL_HIST_TXG),
5068 fnvlist_lookup_string(rec, ZPOOL_HIST_INT_NAME));
5069 if (nvlist_exists(rec, ZPOOL_HIST_DSNAME)) {
5070 (void) printf(" %s (%llu)",
5071 fnvlist_lookup_string(rec,
5073 fnvlist_lookup_uint64(rec,
5076 (void) printf(" %s", fnvlist_lookup_string(rec,
5077 ZPOOL_HIST_INT_STR));
5078 } else if (nvlist_exists(rec, ZPOOL_HIST_IOCTL)) {
5081 (void) printf("%s ioctl %s\n", tbuf,
5082 fnvlist_lookup_string(rec, ZPOOL_HIST_IOCTL));
5083 if (nvlist_exists(rec, ZPOOL_HIST_INPUT_NVL)) {
5084 (void) printf(" input:\n");
5085 dump_nvlist(fnvlist_lookup_nvlist(rec,
5086 ZPOOL_HIST_INPUT_NVL), 8);
5088 if (nvlist_exists(rec, ZPOOL_HIST_OUTPUT_NVL)) {
5089 (void) printf(" output:\n");
5090 dump_nvlist(fnvlist_lookup_nvlist(rec,
5091 ZPOOL_HIST_OUTPUT_NVL), 8);
5096 (void) printf("%s unrecognized record:\n", tbuf);
5097 dump_nvlist(rec, 4);
5101 (void) printf("\n");
5104 (void) printf(" [");
5105 if (nvlist_exists(rec, ZPOOL_HIST_WHO)) {
5106 uid_t who = fnvlist_lookup_uint64(rec, ZPOOL_HIST_WHO);
5107 struct passwd *pwd = getpwuid(who);
5108 (void) printf("user %d ", (int)who);
5110 (void) printf("(%s) ", pwd->pw_name);
5112 if (nvlist_exists(rec, ZPOOL_HIST_HOST)) {
5113 (void) printf("on %s",
5114 fnvlist_lookup_string(rec, ZPOOL_HIST_HOST));
5116 if (nvlist_exists(rec, ZPOOL_HIST_ZONE)) {
5117 (void) printf(":%s",
5118 fnvlist_lookup_string(rec, ZPOOL_HIST_ZONE));
5121 (void) printf("\n");
5123 (void) printf("\n");
5130 * zpool history <pool>
5132 * Displays the history of commands that modified pools.
5135 zpool_do_history(int argc, char **argv)
5137 hist_cbdata_t cbdata = { 0 };
5141 cbdata.first = B_TRUE;
5143 while ((c = getopt(argc, argv, "li")) != -1) {
5146 cbdata.longfmt = B_TRUE;
5149 cbdata.internal = B_TRUE;
5152 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
5160 ret = for_each_pool(argc, argv, B_FALSE, NULL, get_history_one,
5163 if (argc == 0 && cbdata.first == B_TRUE) {
5164 (void) printf(gettext("no pools available\n"));
5172 get_callback(zpool_handle_t *zhp, void *data)
5174 zprop_get_cbdata_t *cbp = (zprop_get_cbdata_t *)data;
5175 char value[MAXNAMELEN];
5176 zprop_source_t srctype;
5179 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
5182 * Skip the special fake placeholder. This will also skip
5183 * over the name property when 'all' is specified.
5185 if (pl->pl_prop == ZPOOL_PROP_NAME &&
5186 pl == cbp->cb_proplist)
5189 if (pl->pl_prop == ZPROP_INVAL &&
5190 (zpool_prop_feature(pl->pl_user_prop) ||
5191 zpool_prop_unsupported(pl->pl_user_prop))) {
5192 srctype = ZPROP_SRC_LOCAL;
5194 if (zpool_prop_get_feature(zhp, pl->pl_user_prop,
5195 value, sizeof (value)) == 0) {
5196 zprop_print_one_property(zpool_get_name(zhp),
5197 cbp, pl->pl_user_prop, value, srctype,
5201 if (zpool_get_prop(zhp, pl->pl_prop, value,
5202 sizeof (value), &srctype) != 0)
5205 zprop_print_one_property(zpool_get_name(zhp), cbp,
5206 zpool_prop_to_name(pl->pl_prop), value, srctype,
5214 zpool_do_get(int argc, char **argv)
5216 zprop_get_cbdata_t cb = { 0 };
5217 zprop_list_t fake_name = { 0 };
5221 (void) fprintf(stderr, gettext("missing property "
5226 cb.cb_first = B_TRUE;
5227 cb.cb_sources = ZPROP_SRC_ALL;
5228 cb.cb_columns[0] = GET_COL_NAME;
5229 cb.cb_columns[1] = GET_COL_PROPERTY;
5230 cb.cb_columns[2] = GET_COL_VALUE;
5231 cb.cb_columns[3] = GET_COL_SOURCE;
5232 cb.cb_type = ZFS_TYPE_POOL;
5234 if (zprop_get_list(g_zfs, argv[1], &cb.cb_proplist,
5235 ZFS_TYPE_POOL) != 0)
5238 if (cb.cb_proplist != NULL) {
5239 fake_name.pl_prop = ZPOOL_PROP_NAME;
5240 fake_name.pl_width = strlen(gettext("NAME"));
5241 fake_name.pl_next = cb.cb_proplist;
5242 cb.cb_proplist = &fake_name;
5245 ret = for_each_pool(argc - 2, argv + 2, B_TRUE, &cb.cb_proplist,
5248 if (cb.cb_proplist == &fake_name)
5249 zprop_free_list(fake_name.pl_next);
5251 zprop_free_list(cb.cb_proplist);
5256 typedef struct set_cbdata {
5259 boolean_t cb_any_successful;
5263 set_callback(zpool_handle_t *zhp, void *data)
5266 set_cbdata_t *cb = (set_cbdata_t *)data;
5268 error = zpool_set_prop(zhp, cb->cb_propname, cb->cb_value);
5271 cb->cb_any_successful = B_TRUE;
5277 zpool_do_set(int argc, char **argv)
5279 set_cbdata_t cb = { 0 };
5282 if (argc > 1 && argv[1][0] == '-') {
5283 (void) fprintf(stderr, gettext("invalid option '%c'\n"),
5289 (void) fprintf(stderr, gettext("missing property=value "
5295 (void) fprintf(stderr, gettext("missing pool name\n"));
5300 (void) fprintf(stderr, gettext("too many pool names\n"));
5304 cb.cb_propname = argv[1];
5305 cb.cb_value = strchr(cb.cb_propname, '=');
5306 if (cb.cb_value == NULL) {
5307 (void) fprintf(stderr, gettext("missing value in "
5308 "property=value argument\n"));
5312 *(cb.cb_value) = '\0';
5315 error = for_each_pool(argc - 2, argv + 2, B_TRUE, NULL,
5322 find_command_idx(char *command, int *idx)
5326 for (i = 0; i < NCOMMAND; i++) {
5327 if (command_table[i].name == NULL)
5330 if (strcmp(command, command_table[i].name) == 0) {
5339 main(int argc, char **argv)
5345 (void) setlocale(LC_ALL, "");
5346 (void) textdomain(TEXT_DOMAIN);
5348 if ((g_zfs = libzfs_init()) == NULL) {
5349 (void) fprintf(stderr, gettext("internal error: failed to "
5350 "initialize ZFS library\n"));
5354 libzfs_print_on_error(g_zfs, B_TRUE);
5359 * Make sure the user has specified some command.
5362 (void) fprintf(stderr, gettext("missing command\n"));
5371 if (strcmp(cmdname, "-?") == 0)
5374 zfs_save_arguments(argc, argv, history_str, sizeof (history_str));
5377 * Run the appropriate command.
5379 if (find_command_idx(cmdname, &i) == 0) {
5380 current_command = &command_table[i];
5381 ret = command_table[i].func(argc - 1, argv + 1);
5382 } else if (strchr(cmdname, '=')) {
5383 verify(find_command_idx("set", &i) == 0);
5384 current_command = &command_table[i];
5385 ret = command_table[i].func(argc, argv);
5386 } else if (strcmp(cmdname, "freeze") == 0 && argc == 3) {
5388 * 'freeze' is a vile debugging abomination, so we treat
5391 zfs_cmd_t zc = { 0 };
5392 (void) strlcpy(zc.zc_name, argv[2], sizeof (zc.zc_name));
5393 return (!!zfs_ioctl(g_zfs, ZFS_IOC_POOL_FREEZE, &zc));
5395 (void) fprintf(stderr, gettext("unrecognized "
5396 "command '%s'\n"), cmdname);
5400 if (ret == 0 && log_history)
5401 (void) zpool_log_history(g_zfs, history_str);
5406 * The 'ZFS_ABORT' environment variable causes us to dump core on exit
5407 * for the purposes of running ::findleaks.
5409 if (getenv("ZFS_ABORT") != NULL) {
5410 (void) printf("dumping core by request\n");