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) 2012 by Delphix. All rights reserved.
26 * Copyright (c) 2012 by Frederik Wessels. All rights reserved.
27 * Copyright (c) 2012 by Cyril Plisko. All rights reserved.
48 #include <sys/fs/zfs.h>
50 #include <sys/fm/util.h>
51 #include <sys/fm/protocol.h>
55 #include "zpool_util.h"
56 #include "zfs_comutil.h"
57 #include "zfeature_common.h"
59 #include "statcommon.h"
61 static int zpool_do_create(int, char **);
62 static int zpool_do_destroy(int, char **);
64 static int zpool_do_add(int, char **);
65 static int zpool_do_remove(int, char **);
66 static int zpool_do_labelclear(int, char **);
68 static int zpool_do_list(int, char **);
69 static int zpool_do_iostat(int, char **);
70 static int zpool_do_status(int, char **);
72 static int zpool_do_online(int, char **);
73 static int zpool_do_offline(int, char **);
74 static int zpool_do_clear(int, char **);
75 static int zpool_do_reopen(int, char **);
77 static int zpool_do_reguid(int, char **);
79 static int zpool_do_attach(int, char **);
80 static int zpool_do_detach(int, char **);
81 static int zpool_do_replace(int, char **);
82 static int zpool_do_split(int, char **);
84 static int zpool_do_scrub(int, char **);
86 static int zpool_do_import(int, char **);
87 static int zpool_do_export(int, char **);
89 static int zpool_do_upgrade(int, char **);
91 static int zpool_do_history(int, char **);
92 static int zpool_do_events(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 */
145 typedef struct zpool_command
{
147 int (*func
)(int, char **);
152 * Master command table. Each ZFS command has a name, associated function, and
153 * usage message. The usage messages need to be internationalized, so we have
154 * to have a function to return the usage message based on a command index.
156 * These commands are organized according to how they are displayed in the usage
157 * message. An empty command (one with a NULL name) indicates an empty line in
158 * the generic usage message.
160 static zpool_command_t command_table
[] = {
161 { "create", zpool_do_create
, HELP_CREATE
},
162 { "destroy", zpool_do_destroy
, HELP_DESTROY
},
164 { "add", zpool_do_add
, HELP_ADD
},
165 { "remove", zpool_do_remove
, HELP_REMOVE
},
167 { "labelclear", zpool_do_labelclear
, HELP_LABELCLEAR
},
169 { "list", zpool_do_list
, HELP_LIST
},
170 { "iostat", zpool_do_iostat
, HELP_IOSTAT
},
171 { "status", zpool_do_status
, HELP_STATUS
},
173 { "online", zpool_do_online
, HELP_ONLINE
},
174 { "offline", zpool_do_offline
, HELP_OFFLINE
},
175 { "clear", zpool_do_clear
, HELP_CLEAR
},
176 { "reopen", zpool_do_reopen
, HELP_REOPEN
},
178 { "attach", zpool_do_attach
, HELP_ATTACH
},
179 { "detach", zpool_do_detach
, HELP_DETACH
},
180 { "replace", zpool_do_replace
, HELP_REPLACE
},
181 { "split", zpool_do_split
, HELP_SPLIT
},
183 { "scrub", zpool_do_scrub
, HELP_SCRUB
},
185 { "import", zpool_do_import
, HELP_IMPORT
},
186 { "export", zpool_do_export
, HELP_EXPORT
},
187 { "upgrade", zpool_do_upgrade
, HELP_UPGRADE
},
188 { "reguid", zpool_do_reguid
, HELP_REGUID
},
190 { "history", zpool_do_history
, HELP_HISTORY
},
191 { "events", zpool_do_events
, HELP_EVENTS
},
193 { "get", zpool_do_get
, HELP_GET
},
194 { "set", zpool_do_set
, HELP_SET
},
197 #define NCOMMAND (sizeof (command_table) / sizeof (command_table[0]))
199 static zpool_command_t
*current_command
;
200 static char history_str
[HIS_MAX_RECORD_LEN
];
201 static boolean_t log_history
= B_TRUE
;
202 static uint_t timestamp_fmt
= NODATE
;
205 get_usage(zpool_help_t idx
) {
208 return (gettext("\tadd [-fn] [-o property=value] "
209 "<pool> <vdev> ...\n"));
211 return (gettext("\tattach [-f] [-o property=value] "
212 "<pool> <device> <new-device>\n"));
214 return (gettext("\tclear [-nF] <pool> [device]\n"));
216 return (gettext("\tcreate [-fnd] [-o property=value] ... \n"
217 "\t [-O file-system-property=value] ... \n"
218 "\t [-m mountpoint] [-R root] <pool> <vdev> ...\n"));
220 return (gettext("\tdestroy [-f] <pool>\n"));
222 return (gettext("\tdetach <pool> <device>\n"));
224 return (gettext("\texport [-f] <pool> ...\n"));
226 return (gettext("\thistory [-il] [<pool>] ...\n"));
228 return (gettext("\timport [-d dir] [-D]\n"
229 "\timport [-d dir | -c cachefile] [-F [-n]] <pool | id>\n"
230 "\timport [-o mntopts] [-o property=value] ... \n"
231 "\t [-d dir | -c cachefile] [-D] [-f] [-m] [-N] "
232 "[-R root] [-F [-n]] -a\n"
233 "\timport [-o mntopts] [-o property=value] ... \n"
234 "\t [-d dir | -c cachefile] [-D] [-f] [-m] [-N] "
235 "[-R root] [-F [-n]]\n"
236 "\t <pool | id> [newpool]\n"));
238 return (gettext("\tiostat [-v] [-T d|u] [pool] ... [interval "
240 case HELP_LABELCLEAR
:
241 return (gettext("\tlabelclear [-f] <vdev>\n"));
243 return (gettext("\tlist [-Hv] [-o property[,...]] "
244 "[-T d|u] [pool] ... [interval [count]]\n"));
246 return (gettext("\toffline [-t] <pool> <device> ...\n"));
248 return (gettext("\tonline <pool> <device> ...\n"));
250 return (gettext("\treplace [-f] <pool> <device> "
253 return (gettext("\tremove <pool> <device> ...\n"));
255 return (gettext("\treopen <pool>\n"));
257 return (gettext("\tscrub [-s] <pool> ...\n"));
259 return (gettext("\tstatus [-vxD] [-T d|u] [pool] ... [interval "
262 return (gettext("\tupgrade\n"
264 "\tupgrade [-V version] <-a | pool ...>\n"));
266 return (gettext("\tevents [-vHfc]\n"));
268 return (gettext("\tget [-p] <\"all\" | property[,...]> "
271 return (gettext("\tset <property=value> <pool> \n"));
273 return (gettext("\tsplit [-n] [-R altroot] [-o mntopts]\n"
274 "\t [-o property=value] <pool> <newpool> "
275 "[<device> ...]\n"));
277 return (gettext("\treguid <pool>\n"));
286 * Callback routine that will print out a pool property value.
289 print_prop_cb(int prop
, void *cb
)
293 (void) fprintf(fp
, "\t%-15s ", zpool_prop_to_name(prop
));
295 if (zpool_prop_readonly(prop
))
296 (void) fprintf(fp
, " NO ");
298 (void) fprintf(fp
, " YES ");
300 if (zpool_prop_values(prop
) == NULL
)
301 (void) fprintf(fp
, "-\n");
303 (void) fprintf(fp
, "%s\n", zpool_prop_values(prop
));
309 * Display usage message. If we're inside a command, display only the usage for
310 * that command. Otherwise, iterate over the entire command table and display
311 * a complete usage message.
314 usage(boolean_t requested
)
316 FILE *fp
= requested
? stdout
: stderr
;
318 if (current_command
== NULL
) {
321 (void) fprintf(fp
, gettext("usage: zpool command args ...\n"));
323 gettext("where 'command' is one of the following:\n\n"));
325 for (i
= 0; i
< NCOMMAND
; i
++) {
326 if (command_table
[i
].name
== NULL
)
327 (void) fprintf(fp
, "\n");
329 (void) fprintf(fp
, "%s",
330 get_usage(command_table
[i
].usage
));
333 (void) fprintf(fp
, gettext("usage:\n"));
334 (void) fprintf(fp
, "%s", get_usage(current_command
->usage
));
337 if (current_command
!= NULL
&&
338 ((strcmp(current_command
->name
, "set") == 0) ||
339 (strcmp(current_command
->name
, "get") == 0) ||
340 (strcmp(current_command
->name
, "list") == 0))) {
343 gettext("\nthe following properties are supported:\n"));
345 (void) fprintf(fp
, "\n\t%-15s %s %s\n\n",
346 "PROPERTY", "EDIT", "VALUES");
348 /* Iterate over all properties */
349 (void) zprop_iter(print_prop_cb
, fp
, B_FALSE
, B_TRUE
,
352 (void) fprintf(fp
, "\t%-15s ", "feature@...");
353 (void) fprintf(fp
, "YES disabled | enabled | active\n");
355 (void) fprintf(fp
, gettext("\nThe feature@ properties must be "
356 "appended with a feature name.\nSee zpool-features(5).\n"));
360 * See comments at end of main().
362 if (getenv("ZFS_ABORT") != NULL
) {
363 (void) printf("dumping core by request\n");
367 exit(requested
? 0 : 2);
371 print_vdev_tree(zpool_handle_t
*zhp
, const char *name
, nvlist_t
*nv
, int indent
,
372 boolean_t print_logs
)
379 (void) printf("\t%*s%s\n", indent
, "", name
);
381 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
382 &child
, &children
) != 0)
385 for (c
= 0; c
< children
; c
++) {
386 uint64_t is_log
= B_FALSE
;
388 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_LOG
,
390 if ((is_log
&& !print_logs
) || (!is_log
&& print_logs
))
393 vname
= zpool_vdev_name(g_zfs
, zhp
, child
[c
], B_FALSE
);
394 print_vdev_tree(zhp
, vname
, child
[c
], indent
+ 2,
401 prop_list_contains_feature(nvlist_t
*proplist
)
404 for (nvp
= nvlist_next_nvpair(proplist
, NULL
); NULL
!= nvp
;
405 nvp
= nvlist_next_nvpair(proplist
, nvp
)) {
406 if (zpool_prop_feature(nvpair_name(nvp
)))
413 * Add a property pair (name, string-value) into a property nvlist.
416 add_prop_list(const char *propname
, char *propval
, nvlist_t
**props
,
419 zpool_prop_t prop
= ZPROP_INVAL
;
425 if (*props
== NULL
&&
426 nvlist_alloc(props
, NV_UNIQUE_NAME
, 0) != 0) {
427 (void) fprintf(stderr
,
428 gettext("internal error: out of memory\n"));
435 const char *vname
= zpool_prop_to_name(ZPOOL_PROP_VERSION
);
437 if ((prop
= zpool_name_to_prop(propname
)) == ZPROP_INVAL
&&
438 !zpool_prop_feature(propname
)) {
439 (void) fprintf(stderr
, gettext("property '%s' is "
440 "not a valid pool property\n"), propname
);
445 * feature@ properties and version should not be specified
448 if ((prop
== ZPROP_INVAL
&& zpool_prop_feature(propname
) &&
449 nvlist_exists(proplist
, vname
)) ||
450 (prop
== ZPOOL_PROP_VERSION
&&
451 prop_list_contains_feature(proplist
))) {
452 (void) fprintf(stderr
, gettext("'feature@' and "
453 "'version' properties cannot be specified "
459 if (zpool_prop_feature(propname
))
462 normnm
= zpool_prop_to_name(prop
);
464 if ((fprop
= zfs_name_to_prop(propname
)) != ZPROP_INVAL
) {
465 normnm
= zfs_prop_to_name(fprop
);
471 if (nvlist_lookup_string(proplist
, normnm
, &strval
) == 0 &&
472 prop
!= ZPOOL_PROP_CACHEFILE
) {
473 (void) fprintf(stderr
, gettext("property '%s' "
474 "specified multiple times\n"), propname
);
478 if (nvlist_add_string(proplist
, normnm
, propval
) != 0) {
479 (void) fprintf(stderr
, gettext("internal "
480 "error: out of memory\n"));
488 * zpool add [-fn] [-o property=value] <pool> <vdev> ...
490 * -f Force addition of devices, even if they appear in use
491 * -n Do not add the devices, but display the resulting layout if
492 * they were to be added.
493 * -o Set property=value.
495 * Adds the given vdevs to 'pool'. As with create, the bulk of this work is
496 * handled by get_vdev_spec(), which constructs the nvlist needed to pass to
500 zpool_do_add(int argc
, char **argv
)
502 boolean_t force
= B_FALSE
;
503 boolean_t dryrun
= B_FALSE
;
510 nvlist_t
*props
= NULL
;
514 while ((c
= getopt(argc
, argv
, "fno:")) != -1) {
523 if ((propval
= strchr(optarg
, '=')) == NULL
) {
524 (void) fprintf(stderr
, gettext("missing "
525 "'=' for -o option\n"));
531 if ((strcmp(optarg
, ZPOOL_CONFIG_ASHIFT
) != 0) ||
532 (add_prop_list(optarg
, propval
, &props
, B_TRUE
)))
536 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
545 /* get pool name and check number of arguments */
547 (void) fprintf(stderr
, gettext("missing pool name argument\n"));
551 (void) fprintf(stderr
, gettext("missing vdev specification\n"));
560 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
563 if ((config
= zpool_get_config(zhp
, NULL
)) == NULL
) {
564 (void) fprintf(stderr
, gettext("pool '%s' is unavailable\n"),
570 /* pass off to get_vdev_spec for processing */
571 nvroot
= make_root_vdev(zhp
, props
, force
, !force
, B_FALSE
, dryrun
,
573 if (nvroot
== NULL
) {
579 nvlist_t
*poolnvroot
;
581 verify(nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
584 (void) printf(gettext("would update '%s' to the following "
585 "configuration:\n"), zpool_get_name(zhp
));
587 /* print original main pool and new tree */
588 print_vdev_tree(zhp
, poolname
, poolnvroot
, 0, B_FALSE
);
589 print_vdev_tree(zhp
, NULL
, nvroot
, 0, B_FALSE
);
591 /* Do the same for the logs */
592 if (num_logs(poolnvroot
) > 0) {
593 print_vdev_tree(zhp
, "logs", poolnvroot
, 0, B_TRUE
);
594 print_vdev_tree(zhp
, NULL
, nvroot
, 0, B_TRUE
);
595 } else if (num_logs(nvroot
) > 0) {
596 print_vdev_tree(zhp
, "logs", nvroot
, 0, B_TRUE
);
601 ret
= (zpool_add(zhp
, nvroot
) != 0);
612 * zpool remove <pool> <vdev> ...
614 * Removes the given vdev from the pool. Currently, this supports removing
615 * spares, cache, and log devices from the pool.
618 zpool_do_remove(int argc
, char **argv
)
627 /* get pool name and check number of arguments */
629 (void) fprintf(stderr
, gettext("missing pool name argument\n"));
633 (void) fprintf(stderr
, gettext("missing device\n"));
639 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
642 for (i
= 1; i
< argc
; i
++) {
643 if (zpool_vdev_remove(zhp
, argv
[i
]) != 0)
651 * zpool labelclear <vdev>
653 * Verifies that the vdev is not active and zeros out the label information
657 zpool_do_labelclear(int argc
, char **argv
)
660 int c
, fd
= -1, ret
= 0;
662 boolean_t inuse
= B_FALSE
;
663 boolean_t force
= B_FALSE
;
666 while ((c
= getopt(argc
, argv
, "f")) != -1) {
672 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
683 (void) fprintf(stderr
, gettext("missing vdev device name\n"));
688 if ((fd
= open(vdev
, O_RDWR
)) < 0) {
689 (void) fprintf(stderr
, gettext("Unable to open %s\n"), vdev
);
694 if (zpool_in_use(g_zfs
, fd
, &state
, &name
, &inuse
) != 0) {
698 (void) fprintf(stderr
,
699 gettext("Unable to determine pool state for %s\n"
700 "Use -f to force the clearing any label data\n"), vdev
);
708 case POOL_STATE_ACTIVE
:
709 case POOL_STATE_SPARE
:
710 case POOL_STATE_L2CACHE
:
711 (void) fprintf(stderr
,
712 gettext("labelclear operation failed.\n"
713 "\tVdev %s is a member (%s), of pool \"%s\".\n"
714 "\tTo remove label information from this device, "
715 "export or destroy\n\tthe pool, or remove %s from "
716 "the configuration of this pool\n\tand retry the "
717 "labelclear operation.\n"),
718 vdev
, zpool_pool_state_to_name(state
), name
, vdev
);
722 case POOL_STATE_EXPORTED
:
726 (void) fprintf(stderr
,
727 gettext("labelclear operation failed.\n\tVdev "
728 "%s is a member of the exported pool \"%s\".\n"
729 "\tUse \"zpool labelclear -f %s\" to force the "
730 "removal of label\n\tinformation.\n"),
735 case POOL_STATE_POTENTIALLY_ACTIVE
:
739 (void) fprintf(stderr
,
740 gettext("labelclear operation failed.\n"
741 "\tVdev %s is a member of the pool \"%s\".\n"
742 "\tThis pool is unknown to this system, but may "
743 "be active on\n\tanother system. Use "
744 "\'zpool labelclear -f %s\' to force the\n"
745 "\tremoval of label information.\n"),
750 case POOL_STATE_DESTROYED
:
751 /* inuse should never be set for a destroyed pool... */
757 if (zpool_clear_label(fd
) != 0) {
758 (void) fprintf(stderr
,
759 gettext("Label clear failed on vdev %s\n"), vdev
);
772 * zpool create [-fnd] [-o property=value] ...
773 * [-O file-system-property=value] ...
774 * [-R root] [-m mountpoint] <pool> <dev> ...
776 * -f Force creation, even if devices appear in use
777 * -n Do not create the pool, but display the resulting layout if it
778 * were to be created.
779 * -R Create a pool under an alternate root
780 * -m Set default mountpoint for the root dataset. By default it's
782 * -o Set property=value.
783 * -d Don't automatically enable all supported pool features
784 * (individual features can be enabled with -o).
785 * -O Set fsproperty=value in the pool's root file system
787 * Creates the named pool according to the given vdev specification. The
788 * bulk of the vdev processing is done in get_vdev_spec() in zpool_vdev.c. Once
789 * we get the nvlist back from get_vdev_spec(), we either print out the contents
790 * (if '-n' was specified), or pass it to libzfs to do the creation.
793 zpool_do_create(int argc
, char **argv
)
795 boolean_t force
= B_FALSE
;
796 boolean_t dryrun
= B_FALSE
;
797 boolean_t enable_all_pool_feat
= B_TRUE
;
799 nvlist_t
*nvroot
= NULL
;
802 char *altroot
= NULL
;
803 char *mountpoint
= NULL
;
804 nvlist_t
*fsprops
= NULL
;
805 nvlist_t
*props
= NULL
;
809 while ((c
= getopt(argc
, argv
, ":fndR:m:o:O:")) != -1) {
818 enable_all_pool_feat
= B_FALSE
;
822 if (add_prop_list(zpool_prop_to_name(
823 ZPOOL_PROP_ALTROOT
), optarg
, &props
, B_TRUE
))
825 if (nvlist_lookup_string(props
,
826 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE
),
829 if (add_prop_list(zpool_prop_to_name(
830 ZPOOL_PROP_CACHEFILE
), "none", &props
, B_TRUE
))
834 /* Equivalent to -O mountpoint=optarg */
838 if ((propval
= strchr(optarg
, '=')) == NULL
) {
839 (void) fprintf(stderr
, gettext("missing "
840 "'=' for -o option\n"));
846 if (add_prop_list(optarg
, propval
, &props
, B_TRUE
))
850 * If the user is creating a pool that doesn't support
851 * feature flags, don't enable any features.
853 if (zpool_name_to_prop(optarg
) == ZPOOL_PROP_VERSION
) {
857 ver
= strtoull(propval
, &end
, 10);
859 ver
< SPA_VERSION_FEATURES
) {
860 enable_all_pool_feat
= B_FALSE
;
865 if ((propval
= strchr(optarg
, '=')) == NULL
) {
866 (void) fprintf(stderr
, gettext("missing "
867 "'=' for -O option\n"));
874 * Mountpoints are checked and then added later.
875 * Uniquely among properties, they can be specified
876 * more than once, to avoid conflict with -m.
878 if (0 == strcmp(optarg
,
879 zfs_prop_to_name(ZFS_PROP_MOUNTPOINT
))) {
880 mountpoint
= propval
;
881 } else if (add_prop_list(optarg
, propval
, &fsprops
,
887 (void) fprintf(stderr
, gettext("missing argument for "
888 "'%c' option\n"), optopt
);
891 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
900 /* get pool name and check number of arguments */
902 (void) fprintf(stderr
, gettext("missing pool name argument\n"));
906 (void) fprintf(stderr
, gettext("missing vdev specification\n"));
913 * As a special case, check for use of '/' in the name, and direct the
914 * user to use 'zfs create' instead.
916 if (strchr(poolname
, '/') != NULL
) {
917 (void) fprintf(stderr
, gettext("cannot create '%s': invalid "
918 "character '/' in pool name\n"), poolname
);
919 (void) fprintf(stderr
, gettext("use 'zfs create' to "
920 "create a dataset\n"));
924 /* pass off to get_vdev_spec for bulk processing */
925 nvroot
= make_root_vdev(NULL
, props
, force
, !force
, B_FALSE
, dryrun
,
930 /* make_root_vdev() allows 0 toplevel children if there are spares */
931 if (!zfs_allocatable_devs(nvroot
)) {
932 (void) fprintf(stderr
, gettext("invalid vdev "
933 "specification: at least one toplevel vdev must be "
938 if (altroot
!= NULL
&& altroot
[0] != '/') {
939 (void) fprintf(stderr
, gettext("invalid alternate root '%s': "
940 "must be an absolute path\n"), altroot
);
945 * Check the validity of the mountpoint and direct the user to use the
946 * '-m' mountpoint option if it looks like its in use.
948 if (mountpoint
== NULL
||
949 (strcmp(mountpoint
, ZFS_MOUNTPOINT_LEGACY
) != 0 &&
950 strcmp(mountpoint
, ZFS_MOUNTPOINT_NONE
) != 0)) {
951 char buf
[MAXPATHLEN
];
954 if (mountpoint
&& mountpoint
[0] != '/') {
955 (void) fprintf(stderr
, gettext("invalid mountpoint "
956 "'%s': must be an absolute path, 'legacy', or "
957 "'none'\n"), mountpoint
);
961 if (mountpoint
== NULL
) {
963 (void) snprintf(buf
, sizeof (buf
), "%s/%s",
966 (void) snprintf(buf
, sizeof (buf
), "/%s",
970 (void) snprintf(buf
, sizeof (buf
), "%s%s",
971 altroot
, mountpoint
);
973 (void) snprintf(buf
, sizeof (buf
), "%s",
977 if ((dirp
= opendir(buf
)) == NULL
&& errno
!= ENOENT
) {
978 (void) fprintf(stderr
, gettext("mountpoint '%s' : "
979 "%s\n"), buf
, strerror(errno
));
980 (void) fprintf(stderr
, gettext("use '-m' "
981 "option to provide a different default\n"));
986 while (count
< 3 && readdir(dirp
) != NULL
)
988 (void) closedir(dirp
);
991 (void) fprintf(stderr
, gettext("mountpoint "
992 "'%s' exists and is not empty\n"), buf
);
993 (void) fprintf(stderr
, gettext("use '-m' "
994 "option to provide a "
995 "different default\n"));
1002 * Now that the mountpoint's validity has been checked, ensure that
1003 * the property is set appropriately prior to creating the pool.
1005 if (mountpoint
!= NULL
) {
1006 ret
= add_prop_list(zfs_prop_to_name(ZFS_PROP_MOUNTPOINT
),
1007 mountpoint
, &fsprops
, B_FALSE
);
1015 * For a dry run invocation, print out a basic message and run
1016 * through all the vdevs in the list and print out in an
1017 * appropriate hierarchy.
1019 (void) printf(gettext("would create '%s' with the "
1020 "following layout:\n\n"), poolname
);
1022 print_vdev_tree(NULL
, poolname
, nvroot
, 0, B_FALSE
);
1023 if (num_logs(nvroot
) > 0)
1024 print_vdev_tree(NULL
, "logs", nvroot
, 0, B_TRUE
);
1029 * Hand off to libzfs.
1031 if (enable_all_pool_feat
) {
1033 for (i
= 0; i
< SPA_FEATURES
; i
++) {
1034 char propname
[MAXPATHLEN
];
1035 zfeature_info_t
*feat
= &spa_feature_table
[i
];
1037 (void) snprintf(propname
, sizeof (propname
),
1038 "feature@%s", feat
->fi_uname
);
1041 * Skip feature if user specified it manually
1042 * on the command line.
1044 if (nvlist_exists(props
, propname
))
1047 ret
= add_prop_list(propname
,
1048 ZFS_FEATURE_ENABLED
, &props
, B_TRUE
);
1055 if (zpool_create(g_zfs
, poolname
,
1056 nvroot
, props
, fsprops
) == 0) {
1057 zfs_handle_t
*pool
= zfs_open(g_zfs
, poolname
,
1058 ZFS_TYPE_FILESYSTEM
);
1060 if (zfs_mount(pool
, NULL
, 0) == 0)
1061 ret
= zfs_shareall(pool
);
1064 } else if (libzfs_errno(g_zfs
) == EZFS_INVALIDNAME
) {
1065 (void) fprintf(stderr
, gettext("pool name may have "
1071 nvlist_free(nvroot
);
1072 nvlist_free(fsprops
);
1076 nvlist_free(fsprops
);
1083 * zpool destroy <pool>
1085 * -f Forcefully unmount any datasets
1087 * Destroy the given pool. Automatically unmounts any datasets in the pool.
1090 zpool_do_destroy(int argc
, char **argv
)
1092 boolean_t force
= B_FALSE
;
1095 zpool_handle_t
*zhp
;
1099 while ((c
= getopt(argc
, argv
, "f")) != -1) {
1105 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
1114 /* check arguments */
1116 (void) fprintf(stderr
, gettext("missing pool argument\n"));
1120 (void) fprintf(stderr
, gettext("too many arguments\n"));
1126 if ((zhp
= zpool_open_canfail(g_zfs
, pool
)) == NULL
) {
1128 * As a special case, check for use of '/' in the name, and
1129 * direct the user to use 'zfs destroy' instead.
1131 if (strchr(pool
, '/') != NULL
)
1132 (void) fprintf(stderr
, gettext("use 'zfs destroy' to "
1133 "destroy a dataset\n"));
1137 if (zpool_disable_datasets(zhp
, force
) != 0) {
1138 (void) fprintf(stderr
, gettext("could not destroy '%s': "
1139 "could not unmount datasets\n"), zpool_get_name(zhp
));
1143 /* The history must be logged as part of the export */
1144 log_history
= B_FALSE
;
1146 ret
= (zpool_destroy(zhp
, history_str
) != 0);
1154 * zpool export [-f] <pool> ...
1156 * -f Forcefully unmount datasets
1158 * Export the given pools. By default, the command will attempt to cleanly
1159 * unmount any active datasets within the pool. If the '-f' flag is specified,
1160 * then the datasets will be forcefully unmounted.
1163 zpool_do_export(int argc
, char **argv
)
1165 boolean_t force
= B_FALSE
;
1166 boolean_t hardforce
= B_FALSE
;
1168 zpool_handle_t
*zhp
;
1173 while ((c
= getopt(argc
, argv
, "fF")) != -1) {
1182 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
1191 /* check arguments */
1193 (void) fprintf(stderr
, gettext("missing pool argument\n"));
1198 for (i
= 0; i
< argc
; i
++) {
1199 if ((zhp
= zpool_open_canfail(g_zfs
, argv
[i
])) == NULL
) {
1204 if (zpool_disable_datasets(zhp
, force
) != 0) {
1210 /* The history must be logged as part of the export */
1211 log_history
= B_FALSE
;
1214 if (zpool_export_force(zhp
, history_str
) != 0)
1216 } else if (zpool_export(zhp
, force
, history_str
) != 0) {
1227 * Given a vdev configuration, determine the maximum width needed for the device
1231 max_width(zpool_handle_t
*zhp
, nvlist_t
*nv
, int depth
, int max
)
1233 char *name
= zpool_vdev_name(g_zfs
, zhp
, nv
, B_TRUE
);
1238 if (strlen(name
) + depth
> max
)
1239 max
= strlen(name
) + depth
;
1243 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_SPARES
,
1244 &child
, &children
) == 0) {
1245 for (c
= 0; c
< children
; c
++)
1246 if ((ret
= max_width(zhp
, child
[c
], depth
+ 2,
1251 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_L2CACHE
,
1252 &child
, &children
) == 0) {
1253 for (c
= 0; c
< children
; c
++)
1254 if ((ret
= max_width(zhp
, child
[c
], depth
+ 2,
1259 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
1260 &child
, &children
) == 0) {
1261 for (c
= 0; c
< children
; c
++)
1262 if ((ret
= max_width(zhp
, child
[c
], depth
+ 2,
1271 typedef struct spare_cbdata
{
1273 zpool_handle_t
*cb_zhp
;
1277 find_vdev(nvlist_t
*nv
, uint64_t search
)
1283 if (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_GUID
, &guid
) == 0 &&
1287 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
1288 &child
, &children
) == 0) {
1289 for (c
= 0; c
< children
; c
++)
1290 if (find_vdev(child
[c
], search
))
1298 find_spare(zpool_handle_t
*zhp
, void *data
)
1300 spare_cbdata_t
*cbp
= data
;
1301 nvlist_t
*config
, *nvroot
;
1303 config
= zpool_get_config(zhp
, NULL
);
1304 verify(nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
1307 if (find_vdev(nvroot
, cbp
->cb_guid
)) {
1317 * Print out configuration state as requested by status_callback.
1320 print_status_config(zpool_handle_t
*zhp
, const char *name
, nvlist_t
*nv
,
1321 int namewidth
, int depth
, boolean_t isspare
)
1325 pool_scan_stat_t
*ps
= NULL
;
1327 char rbuf
[6], wbuf
[6], cbuf
[6];
1329 uint64_t notpresent
;
1333 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
1334 &child
, &children
) != 0)
1337 verify(nvlist_lookup_uint64_array(nv
, ZPOOL_CONFIG_VDEV_STATS
,
1338 (uint64_t **)&vs
, &c
) == 0);
1340 state
= zpool_state_to_name(vs
->vs_state
, vs
->vs_aux
);
1343 * For hot spares, we use the terms 'INUSE' and 'AVAILABLE' for
1346 if (vs
->vs_aux
== VDEV_AUX_SPARED
)
1348 else if (vs
->vs_state
== VDEV_STATE_HEALTHY
)
1352 (void) printf("\t%*s%-*s %-8s", depth
, "", namewidth
- depth
,
1356 zfs_nicenum(vs
->vs_read_errors
, rbuf
, sizeof (rbuf
));
1357 zfs_nicenum(vs
->vs_write_errors
, wbuf
, sizeof (wbuf
));
1358 zfs_nicenum(vs
->vs_checksum_errors
, cbuf
, sizeof (cbuf
));
1359 (void) printf(" %5s %5s %5s", rbuf
, wbuf
, cbuf
);
1362 if (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_NOT_PRESENT
,
1363 ¬present
) == 0) {
1365 verify(nvlist_lookup_string(nv
, ZPOOL_CONFIG_PATH
, &path
) == 0);
1366 (void) printf(" was %s", path
);
1367 } else if (vs
->vs_aux
!= 0) {
1370 switch (vs
->vs_aux
) {
1371 case VDEV_AUX_OPEN_FAILED
:
1372 (void) printf(gettext("cannot open"));
1375 case VDEV_AUX_BAD_GUID_SUM
:
1376 (void) printf(gettext("missing device"));
1379 case VDEV_AUX_NO_REPLICAS
:
1380 (void) printf(gettext("insufficient replicas"));
1383 case VDEV_AUX_VERSION_NEWER
:
1384 (void) printf(gettext("newer version"));
1387 case VDEV_AUX_UNSUP_FEAT
:
1388 (void) printf(gettext("unsupported feature(s)"));
1391 case VDEV_AUX_SPARED
:
1392 verify(nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_GUID
,
1394 if (zpool_iter(g_zfs
, find_spare
, &cb
) == 1) {
1395 if (strcmp(zpool_get_name(cb
.cb_zhp
),
1396 zpool_get_name(zhp
)) == 0)
1397 (void) printf(gettext("currently in "
1400 (void) printf(gettext("in use by "
1402 zpool_get_name(cb
.cb_zhp
));
1403 zpool_close(cb
.cb_zhp
);
1405 (void) printf(gettext("currently in use"));
1409 case VDEV_AUX_ERR_EXCEEDED
:
1410 (void) printf(gettext("too many errors"));
1413 case VDEV_AUX_IO_FAILURE
:
1414 (void) printf(gettext("experienced I/O failures"));
1417 case VDEV_AUX_BAD_LOG
:
1418 (void) printf(gettext("bad intent log"));
1421 case VDEV_AUX_EXTERNAL
:
1422 (void) printf(gettext("external device fault"));
1425 case VDEV_AUX_SPLIT_POOL
:
1426 (void) printf(gettext("split into new pool"));
1430 (void) printf(gettext("corrupted data"));
1435 (void) nvlist_lookup_uint64_array(nv
, ZPOOL_CONFIG_SCAN_STATS
,
1436 (uint64_t **)&ps
, &c
);
1438 if (ps
&& ps
->pss_state
== DSS_SCANNING
&&
1439 vs
->vs_scan_processed
!= 0 && children
== 0) {
1440 (void) printf(gettext(" (%s)"),
1441 (ps
->pss_func
== POOL_SCAN_RESILVER
) ?
1442 "resilvering" : "repairing");
1445 (void) printf("\n");
1447 for (c
= 0; c
< children
; c
++) {
1448 uint64_t islog
= B_FALSE
, ishole
= B_FALSE
;
1450 /* Don't print logs or holes here */
1451 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_LOG
,
1453 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_HOLE
,
1455 if (islog
|| ishole
)
1457 vname
= zpool_vdev_name(g_zfs
, zhp
, child
[c
], B_TRUE
);
1458 print_status_config(zhp
, vname
, child
[c
],
1459 namewidth
, depth
+ 2, isspare
);
1466 * Print the configuration of an exported pool. Iterate over all vdevs in the
1467 * pool, printing out the name and status for each one.
1470 print_import_config(const char *name
, nvlist_t
*nv
, int namewidth
, int depth
)
1477 verify(nvlist_lookup_string(nv
, ZPOOL_CONFIG_TYPE
, &type
) == 0);
1478 if (strcmp(type
, VDEV_TYPE_MISSING
) == 0 ||
1479 strcmp(type
, VDEV_TYPE_HOLE
) == 0)
1482 verify(nvlist_lookup_uint64_array(nv
, ZPOOL_CONFIG_VDEV_STATS
,
1483 (uint64_t **)&vs
, &c
) == 0);
1485 (void) printf("\t%*s%-*s", depth
, "", namewidth
- depth
, name
);
1486 (void) printf(" %s", zpool_state_to_name(vs
->vs_state
, vs
->vs_aux
));
1488 if (vs
->vs_aux
!= 0) {
1491 switch (vs
->vs_aux
) {
1492 case VDEV_AUX_OPEN_FAILED
:
1493 (void) printf(gettext("cannot open"));
1496 case VDEV_AUX_BAD_GUID_SUM
:
1497 (void) printf(gettext("missing device"));
1500 case VDEV_AUX_NO_REPLICAS
:
1501 (void) printf(gettext("insufficient replicas"));
1504 case VDEV_AUX_VERSION_NEWER
:
1505 (void) printf(gettext("newer version"));
1508 case VDEV_AUX_UNSUP_FEAT
:
1509 (void) printf(gettext("unsupported feature(s)"));
1512 case VDEV_AUX_ERR_EXCEEDED
:
1513 (void) printf(gettext("too many errors"));
1517 (void) printf(gettext("corrupted data"));
1521 (void) printf("\n");
1523 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
1524 &child
, &children
) != 0)
1527 for (c
= 0; c
< children
; c
++) {
1528 uint64_t is_log
= B_FALSE
;
1530 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_LOG
,
1535 vname
= zpool_vdev_name(g_zfs
, NULL
, child
[c
], B_TRUE
);
1536 print_import_config(vname
, child
[c
], namewidth
, depth
+ 2);
1540 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_L2CACHE
,
1541 &child
, &children
) == 0) {
1542 (void) printf(gettext("\tcache\n"));
1543 for (c
= 0; c
< children
; c
++) {
1544 vname
= zpool_vdev_name(g_zfs
, NULL
, child
[c
], B_FALSE
);
1545 (void) printf("\t %s\n", vname
);
1550 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_SPARES
,
1551 &child
, &children
) == 0) {
1552 (void) printf(gettext("\tspares\n"));
1553 for (c
= 0; c
< children
; c
++) {
1554 vname
= zpool_vdev_name(g_zfs
, NULL
, child
[c
], B_FALSE
);
1555 (void) printf("\t %s\n", vname
);
1563 * Logs are recorded as top level vdevs in the main pool child array
1564 * but with "is_log" set to 1. We use either print_status_config() or
1565 * print_import_config() to print the top level logs then any log
1566 * children (eg mirrored slogs) are printed recursively - which
1567 * works because only the top level vdev is marked "is_log"
1570 print_logs(zpool_handle_t
*zhp
, nvlist_t
*nv
, int namewidth
, boolean_t verbose
)
1575 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
, &child
,
1579 (void) printf(gettext("\tlogs\n"));
1581 for (c
= 0; c
< children
; c
++) {
1582 uint64_t is_log
= B_FALSE
;
1585 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_LOG
,
1589 name
= zpool_vdev_name(g_zfs
, zhp
, child
[c
], B_TRUE
);
1591 print_status_config(zhp
, name
, child
[c
], namewidth
,
1594 print_import_config(name
, child
[c
], namewidth
, 2);
1600 * Display the status for the given pool.
1603 show_import(nvlist_t
*config
)
1605 uint64_t pool_state
;
1611 zpool_status_t reason
;
1612 zpool_errata_t errata
;
1618 verify(nvlist_lookup_string(config
, ZPOOL_CONFIG_POOL_NAME
,
1620 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_GUID
,
1622 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_STATE
,
1624 verify(nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
1627 verify(nvlist_lookup_uint64_array(nvroot
, ZPOOL_CONFIG_VDEV_STATS
,
1628 (uint64_t **)&vs
, &vsc
) == 0);
1629 health
= zpool_state_to_name(vs
->vs_state
, vs
->vs_aux
);
1631 reason
= zpool_import_status(config
, &msgid
, &errata
);
1633 (void) printf(gettext(" pool: %s\n"), name
);
1634 (void) printf(gettext(" id: %llu\n"), (u_longlong_t
)guid
);
1635 (void) printf(gettext(" state: %s"), health
);
1636 if (pool_state
== POOL_STATE_DESTROYED
)
1637 (void) printf(gettext(" (DESTROYED)"));
1638 (void) printf("\n");
1641 case ZPOOL_STATUS_MISSING_DEV_R
:
1642 case ZPOOL_STATUS_MISSING_DEV_NR
:
1643 case ZPOOL_STATUS_BAD_GUID_SUM
:
1644 (void) printf(gettext(" status: One or more devices are "
1645 "missing from the system.\n"));
1648 case ZPOOL_STATUS_CORRUPT_LABEL_R
:
1649 case ZPOOL_STATUS_CORRUPT_LABEL_NR
:
1650 (void) printf(gettext(" status: One or more devices contains "
1651 "corrupted data.\n"));
1654 case ZPOOL_STATUS_CORRUPT_DATA
:
1656 gettext(" status: The pool data is corrupted.\n"));
1659 case ZPOOL_STATUS_OFFLINE_DEV
:
1660 (void) printf(gettext(" status: One or more devices "
1661 "are offlined.\n"));
1664 case ZPOOL_STATUS_CORRUPT_POOL
:
1665 (void) printf(gettext(" status: The pool metadata is "
1669 case ZPOOL_STATUS_VERSION_OLDER
:
1670 (void) printf(gettext(" status: The pool is formatted using a "
1671 "legacy on-disk version.\n"));
1674 case ZPOOL_STATUS_VERSION_NEWER
:
1675 (void) printf(gettext(" status: The pool is formatted using an "
1676 "incompatible version.\n"));
1679 case ZPOOL_STATUS_FEAT_DISABLED
:
1680 (void) printf(gettext(" status: Some supported features are "
1681 "not enabled on the pool.\n"));
1684 case ZPOOL_STATUS_UNSUP_FEAT_READ
:
1685 (void) printf(gettext("status: The pool uses the following "
1686 "feature(s) not supported on this sytem:\n"));
1687 zpool_print_unsup_feat(config
);
1690 case ZPOOL_STATUS_UNSUP_FEAT_WRITE
:
1691 (void) printf(gettext("status: The pool can only be accessed "
1692 "in read-only mode on this system. It\n\tcannot be "
1693 "accessed in read-write mode because it uses the "
1694 "following\n\tfeature(s) not supported on this system:\n"));
1695 zpool_print_unsup_feat(config
);
1698 case ZPOOL_STATUS_HOSTID_MISMATCH
:
1699 (void) printf(gettext(" status: The pool was last accessed by "
1700 "another system.\n"));
1703 case ZPOOL_STATUS_FAULTED_DEV_R
:
1704 case ZPOOL_STATUS_FAULTED_DEV_NR
:
1705 (void) printf(gettext(" status: One or more devices are "
1709 case ZPOOL_STATUS_BAD_LOG
:
1710 (void) printf(gettext(" status: An intent log record cannot be "
1714 case ZPOOL_STATUS_RESILVERING
:
1715 (void) printf(gettext(" status: One or more devices were being "
1719 case ZPOOL_STATUS_ERRATA
:
1720 (void) printf(gettext(" status: Errata #%d detected.\n"),
1726 * No other status can be seen when importing pools.
1728 assert(reason
== ZPOOL_STATUS_OK
);
1732 * Print out an action according to the overall state of the pool.
1734 if (vs
->vs_state
== VDEV_STATE_HEALTHY
) {
1735 if (reason
== ZPOOL_STATUS_VERSION_OLDER
||
1736 reason
== ZPOOL_STATUS_FEAT_DISABLED
) {
1737 (void) printf(gettext(" action: The pool can be "
1738 "imported using its name or numeric identifier, "
1739 "though\n\tsome features will not be available "
1740 "without an explicit 'zpool upgrade'.\n"));
1741 } else if (reason
== ZPOOL_STATUS_HOSTID_MISMATCH
) {
1742 (void) printf(gettext(" action: The pool can be "
1743 "imported using its name or numeric "
1744 "identifier and\n\tthe '-f' flag.\n"));
1745 } else if (reason
== ZPOOL_STATUS_ERRATA
) {
1747 case ZPOOL_ERRATA_NONE
:
1750 case ZPOOL_ERRATA_ZOL_2094_SCRUB
:
1751 (void) printf(gettext(" action: The pool can "
1752 "be imported using its name or numeric "
1753 "identifier,\n\thowever there is a compat"
1754 "ibility issue which should be corrected"
1755 "\n\tby running 'zpool scrub'\n"));
1758 case ZPOOL_ERRATA_ZOL_2094_ASYNC_DESTROY
:
1759 (void) printf(gettext(" action: The pool can"
1760 "not be imported with this version of ZFS "
1761 "due to\n\tan active asynchronous destroy. "
1762 "Revert to an earlier version\n\tand "
1763 "allow the destroy to complete before "
1769 * All errata must contain an action message.
1774 (void) printf(gettext(" action: The pool can be "
1775 "imported using its name or numeric "
1778 } else if (vs
->vs_state
== VDEV_STATE_DEGRADED
) {
1779 (void) printf(gettext(" action: The pool can be imported "
1780 "despite missing or damaged devices. The\n\tfault "
1781 "tolerance of the pool may be compromised if imported.\n"));
1784 case ZPOOL_STATUS_VERSION_NEWER
:
1785 (void) printf(gettext(" action: The pool cannot be "
1786 "imported. Access the pool on a system running "
1787 "newer\n\tsoftware, or recreate the pool from "
1790 case ZPOOL_STATUS_UNSUP_FEAT_READ
:
1791 (void) printf(gettext("action: The pool cannot be "
1792 "imported. Access the pool on a system that "
1793 "supports\n\tthe required feature(s), or recreate "
1794 "the pool from backup.\n"));
1796 case ZPOOL_STATUS_UNSUP_FEAT_WRITE
:
1797 (void) printf(gettext("action: The pool cannot be "
1798 "imported in read-write mode. Import the pool "
1800 "\t\"-o readonly=on\", access the pool on a system "
1801 "that supports the\n\trequired feature(s), or "
1802 "recreate the pool from backup.\n"));
1804 case ZPOOL_STATUS_MISSING_DEV_R
:
1805 case ZPOOL_STATUS_MISSING_DEV_NR
:
1806 case ZPOOL_STATUS_BAD_GUID_SUM
:
1807 (void) printf(gettext(" action: The pool cannot be "
1808 "imported. Attach the missing\n\tdevices and try "
1812 (void) printf(gettext(" action: The pool cannot be "
1813 "imported due to damaged devices or data.\n"));
1817 /* Print the comment attached to the pool. */
1818 if (nvlist_lookup_string(config
, ZPOOL_CONFIG_COMMENT
, &comment
) == 0)
1819 (void) printf(gettext("comment: %s\n"), comment
);
1822 * If the state is "closed" or "can't open", and the aux state
1823 * is "corrupt data":
1825 if (((vs
->vs_state
== VDEV_STATE_CLOSED
) ||
1826 (vs
->vs_state
== VDEV_STATE_CANT_OPEN
)) &&
1827 (vs
->vs_aux
== VDEV_AUX_CORRUPT_DATA
)) {
1828 if (pool_state
== POOL_STATE_DESTROYED
)
1829 (void) printf(gettext("\tThe pool was destroyed, "
1830 "but can be imported using the '-Df' flags.\n"));
1831 else if (pool_state
!= POOL_STATE_EXPORTED
)
1832 (void) printf(gettext("\tThe pool may be active on "
1833 "another system, but can be imported using\n\t"
1834 "the '-f' flag.\n"));
1838 (void) printf(gettext(" see: http://zfsonlinux.org/msg/%s\n"),
1841 (void) printf(gettext(" config:\n\n"));
1843 namewidth
= max_width(NULL
, nvroot
, 0, 0);
1847 print_import_config(name
, nvroot
, namewidth
, 0);
1848 if (num_logs(nvroot
) > 0)
1849 print_logs(NULL
, nvroot
, namewidth
, B_FALSE
);
1851 if (reason
== ZPOOL_STATUS_BAD_GUID_SUM
) {
1852 (void) printf(gettext("\n\tAdditional devices are known to "
1853 "be part of this pool, though their\n\texact "
1854 "configuration cannot be determined.\n"));
1859 * Perform the import for the given configuration. This passes the heavy
1860 * lifting off to zpool_import_props(), and then mounts the datasets contained
1864 do_import(nvlist_t
*config
, const char *newname
, const char *mntopts
,
1865 nvlist_t
*props
, int flags
)
1867 zpool_handle_t
*zhp
;
1872 verify(nvlist_lookup_string(config
, ZPOOL_CONFIG_POOL_NAME
,
1875 verify(nvlist_lookup_uint64(config
,
1876 ZPOOL_CONFIG_POOL_STATE
, &state
) == 0);
1877 verify(nvlist_lookup_uint64(config
,
1878 ZPOOL_CONFIG_VERSION
, &version
) == 0);
1879 if (!SPA_VERSION_IS_SUPPORTED(version
)) {
1880 (void) fprintf(stderr
, gettext("cannot import '%s': pool "
1881 "is formatted using an unsupported ZFS version\n"), name
);
1883 } else if (state
!= POOL_STATE_EXPORTED
&&
1884 !(flags
& ZFS_IMPORT_ANY_HOST
)) {
1887 if (nvlist_lookup_uint64(config
, ZPOOL_CONFIG_HOSTID
,
1889 unsigned long system_hostid
= gethostid() & 0xffffffff;
1891 if ((unsigned long)hostid
!= system_hostid
) {
1896 verify(nvlist_lookup_string(config
,
1897 ZPOOL_CONFIG_HOSTNAME
, &hostname
) == 0);
1898 verify(nvlist_lookup_uint64(config
,
1899 ZPOOL_CONFIG_TIMESTAMP
, ×tamp
) == 0);
1901 (void) fprintf(stderr
, gettext("cannot import "
1902 "'%s': pool may be in use from other "
1903 "system, it was last accessed by %s "
1904 "(hostid: 0x%lx) on %s"), name
, hostname
,
1905 (unsigned long)hostid
,
1906 asctime(localtime(&t
)));
1907 (void) fprintf(stderr
, gettext("use '-f' to "
1908 "import anyway\n"));
1912 (void) fprintf(stderr
, gettext("cannot import '%s': "
1913 "pool may be in use from other system\n"), name
);
1914 (void) fprintf(stderr
, gettext("use '-f' to import "
1920 if (zpool_import_props(g_zfs
, config
, newname
, props
, flags
) != 0)
1923 if (newname
!= NULL
)
1924 name
= (char *)newname
;
1926 if ((zhp
= zpool_open_canfail(g_zfs
, name
)) == NULL
)
1929 if (zpool_get_state(zhp
) != POOL_STATE_UNAVAIL
&&
1930 !(flags
& ZFS_IMPORT_ONLY
) &&
1931 zpool_enable_datasets(zhp
, mntopts
, 0) != 0) {
1941 * zpool import [-d dir] [-D]
1942 * import [-o mntopts] [-o prop=value] ... [-R root] [-D]
1943 * [-d dir | -c cachefile] [-f] -a
1944 * import [-o mntopts] [-o prop=value] ... [-R root] [-D]
1945 * [-d dir | -c cachefile] [-f] [-n] [-F] <pool | id> [newpool]
1947 * -c Read pool information from a cachefile instead of searching
1950 * -d Scan in a specific directory, other than /dev/. More than
1951 * one directory can be specified using multiple '-d' options.
1953 * -D Scan for previously destroyed pools or import all or only
1954 * specified destroyed pools.
1956 * -R Temporarily import the pool, with all mountpoints relative to
1957 * the given root. The pool will remain exported when the machine
1960 * -V Import even in the presence of faulted vdevs. This is an
1961 * intentionally undocumented option for testing purposes, and
1962 * treats the pool configuration as complete, leaving any bad
1963 * vdevs in the FAULTED state. In other words, it does verbatim
1966 * -f Force import, even if it appears that the pool is active.
1968 * -F Attempt rewind if necessary.
1970 * -n See if rewind would work, but don't actually rewind.
1972 * -N Import the pool but don't mount datasets.
1974 * -T Specify a starting txg to use for import. This option is
1975 * intentionally undocumented option for testing purposes.
1977 * -a Import all pools found.
1979 * -o Set property=value and/or temporary mount options (without '=').
1981 * The import command scans for pools to import, and import pools based on pool
1982 * name and GUID. The pool can also be renamed as part of the import process.
1985 zpool_do_import(int argc
, char **argv
)
1987 char **searchdirs
= NULL
;
1988 char *env
, *envdup
= NULL
;
1992 nvlist_t
*pools
= NULL
;
1993 boolean_t do_all
= B_FALSE
;
1994 boolean_t do_destroyed
= B_FALSE
;
1995 char *mntopts
= NULL
;
1998 uint64_t searchguid
= 0;
1999 char *searchname
= NULL
;
2001 nvlist_t
*found_config
;
2002 nvlist_t
*policy
= NULL
;
2003 nvlist_t
*props
= NULL
;
2005 int flags
= ZFS_IMPORT_NORMAL
;
2006 uint32_t rewind_policy
= ZPOOL_NO_REWIND
;
2007 boolean_t dryrun
= B_FALSE
;
2008 boolean_t do_rewind
= B_FALSE
;
2009 boolean_t xtreme_rewind
= B_FALSE
;
2010 uint64_t pool_state
, txg
= -1ULL;
2011 char *cachefile
= NULL
;
2012 importargs_t idata
= { 0 };
2016 while ((c
= getopt(argc
, argv
, ":aCc:d:DEfFmnNo:R:tT:VX")) != -1) {
2025 if (searchdirs
== NULL
) {
2026 searchdirs
= safe_malloc(sizeof (char *));
2028 char **tmp
= safe_malloc((nsearch
+ 1) *
2030 bcopy(searchdirs
, tmp
, nsearch
*
2035 searchdirs
[nsearch
++] = optarg
;
2038 do_destroyed
= B_TRUE
;
2041 flags
|= ZFS_IMPORT_ANY_HOST
;
2047 flags
|= ZFS_IMPORT_MISSING_LOG
;
2053 flags
|= ZFS_IMPORT_ONLY
;
2056 if ((propval
= strchr(optarg
, '=')) != NULL
) {
2059 if (add_prop_list(optarg
, propval
,
2067 if (add_prop_list(zpool_prop_to_name(
2068 ZPOOL_PROP_ALTROOT
), optarg
, &props
, B_TRUE
))
2070 if (nvlist_lookup_string(props
,
2071 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE
),
2074 if (add_prop_list(zpool_prop_to_name(
2075 ZPOOL_PROP_CACHEFILE
), "none", &props
, B_TRUE
))
2079 flags
|= ZFS_IMPORT_TEMP_NAME
;
2084 txg
= strtoull(optarg
, &endptr
, 10);
2085 if (errno
!= 0 || *endptr
!= '\0') {
2086 (void) fprintf(stderr
,
2087 gettext("invalid txg value\n"));
2090 rewind_policy
= ZPOOL_DO_REWIND
| ZPOOL_EXTREME_REWIND
;
2093 flags
|= ZFS_IMPORT_VERBATIM
;
2096 xtreme_rewind
= B_TRUE
;
2099 (void) fprintf(stderr
, gettext("missing argument for "
2100 "'%c' option\n"), optopt
);
2104 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
2113 if (cachefile
&& nsearch
!= 0) {
2114 (void) fprintf(stderr
, gettext("-c is incompatible with -d\n"));
2118 if ((dryrun
|| xtreme_rewind
) && !do_rewind
) {
2119 (void) fprintf(stderr
,
2120 gettext("-n or -X only meaningful with -F\n"));
2124 rewind_policy
= ZPOOL_TRY_REWIND
;
2126 rewind_policy
= ZPOOL_DO_REWIND
;
2128 rewind_policy
|= ZPOOL_EXTREME_REWIND
;
2130 /* In the future, we can capture further policy and include it here */
2131 if (nvlist_alloc(&policy
, NV_UNIQUE_NAME
, 0) != 0 ||
2132 nvlist_add_uint64(policy
, ZPOOL_REWIND_REQUEST_TXG
, txg
) != 0 ||
2133 nvlist_add_uint32(policy
, ZPOOL_REWIND_REQUEST
, rewind_policy
) != 0)
2136 /* check argument count */
2139 (void) fprintf(stderr
, gettext("too many arguments\n"));
2144 (void) fprintf(stderr
, gettext("too many arguments\n"));
2149 * Check for the SYS_CONFIG privilege. We do this explicitly
2150 * here because otherwise any attempt to discover pools will
2153 if (argc
== 0 && !priv_ineffect(PRIV_SYS_CONFIG
)) {
2154 (void) fprintf(stderr
, gettext("cannot "
2155 "discover pools: permission denied\n"));
2156 if (searchdirs
!= NULL
)
2159 nvlist_free(policy
);
2165 * Depending on the arguments given, we do one of the following:
2167 * <none> Iterate through all pools and display information about
2170 * -a Iterate through all pools and try to import each one.
2172 * <id> Find the pool that corresponds to the given GUID/pool
2173 * name and import that one.
2175 * -D Above options applies only to destroyed pools.
2181 searchguid
= strtoull(argv
[0], &endptr
, 10);
2182 if (errno
!= 0 || *endptr
!= '\0')
2183 searchname
= argv
[0];
2184 found_config
= NULL
;
2187 * User specified a name or guid. Ensure it's unique.
2189 idata
.unique
= B_TRUE
;
2193 * Check the environment for the preferred search path.
2195 if ((searchdirs
== NULL
) && (env
= getenv("ZPOOL_IMPORT_PATH"))) {
2198 envdup
= strdup(env
);
2200 dir
= strtok(envdup
, ":");
2201 while (dir
!= NULL
) {
2202 if (searchdirs
== NULL
) {
2203 searchdirs
= safe_malloc(sizeof (char *));
2205 char **tmp
= safe_malloc((nsearch
+ 1) *
2207 bcopy(searchdirs
, tmp
, nsearch
*
2212 searchdirs
[nsearch
++] = dir
;
2213 dir
= strtok(NULL
, ":");
2217 idata
.path
= searchdirs
;
2218 idata
.paths
= nsearch
;
2219 idata
.poolname
= searchname
;
2220 idata
.guid
= searchguid
;
2221 idata
.cachefile
= cachefile
;
2223 pools
= zpool_search_import(g_zfs
, &idata
);
2225 if (pools
!= NULL
&& idata
.exists
&&
2226 (argc
== 1 || strcmp(argv
[0], argv
[1]) == 0)) {
2227 (void) fprintf(stderr
, gettext("cannot import '%s': "
2228 "a pool with that name already exists\n"),
2230 (void) fprintf(stderr
, gettext("use the form '%s "
2231 "<pool | id> <newpool>' to give it a new name\n"),
2234 } else if (pools
== NULL
&& idata
.exists
) {
2235 (void) fprintf(stderr
, gettext("cannot import '%s': "
2236 "a pool with that name is already created/imported,\n"),
2238 (void) fprintf(stderr
, gettext("and no additional pools "
2239 "with that name were found\n"));
2241 } else if (pools
== NULL
) {
2243 (void) fprintf(stderr
, gettext("cannot import '%s': "
2244 "no such pool available\n"), argv
[0]);
2250 if (searchdirs
!= NULL
)
2254 nvlist_free(policy
);
2259 * At this point we have a list of import candidate configs. Even if
2260 * we were searching by pool name or guid, we still need to
2261 * post-process the list to deal with pool state and possible
2267 while ((elem
= nvlist_next_nvpair(pools
, elem
)) != NULL
) {
2269 verify(nvpair_value_nvlist(elem
, &config
) == 0);
2271 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_STATE
,
2273 if (!do_destroyed
&& pool_state
== POOL_STATE_DESTROYED
)
2275 if (do_destroyed
&& pool_state
!= POOL_STATE_DESTROYED
)
2278 verify(nvlist_add_nvlist(config
, ZPOOL_REWIND_POLICY
,
2285 (void) printf("\n");
2288 err
|= do_import(config
, NULL
, mntopts
,
2291 show_import(config
);
2293 } else if (searchname
!= NULL
) {
2297 * We are searching for a pool based on name.
2299 verify(nvlist_lookup_string(config
,
2300 ZPOOL_CONFIG_POOL_NAME
, &name
) == 0);
2302 if (strcmp(name
, searchname
) == 0) {
2303 if (found_config
!= NULL
) {
2304 (void) fprintf(stderr
, gettext(
2305 "cannot import '%s': more than "
2306 "one matching pool\n"), searchname
);
2307 (void) fprintf(stderr
, gettext(
2308 "import by numeric ID instead\n"));
2311 found_config
= config
;
2317 * Search for a pool by guid.
2319 verify(nvlist_lookup_uint64(config
,
2320 ZPOOL_CONFIG_POOL_GUID
, &guid
) == 0);
2322 if (guid
== searchguid
)
2323 found_config
= config
;
2328 * If we were searching for a specific pool, verify that we found a
2329 * pool, and then do the import.
2331 if (argc
!= 0 && err
== 0) {
2332 if (found_config
== NULL
) {
2333 (void) fprintf(stderr
, gettext("cannot import '%s': "
2334 "no such pool available\n"), argv
[0]);
2337 err
|= do_import(found_config
, argc
== 1 ? NULL
:
2338 argv
[1], mntopts
, props
, flags
);
2343 * If we were just looking for pools, report an error if none were
2346 if (argc
== 0 && first
)
2347 (void) fprintf(stderr
,
2348 gettext("no pools available to import\n"));
2353 nvlist_free(policy
);
2354 if (searchdirs
!= NULL
)
2359 return (err
? 1 : 0);
2362 typedef struct iostat_cbdata
{
2363 boolean_t cb_verbose
;
2366 zpool_list_t
*cb_list
;
2370 print_iostat_separator(iostat_cbdata_t
*cb
)
2374 for (i
= 0; i
< cb
->cb_namewidth
; i
++)
2376 (void) printf(" ----- ----- ----- ----- ----- -----\n");
2380 print_iostat_header(iostat_cbdata_t
*cb
)
2382 (void) printf("%*s capacity operations bandwidth\n",
2383 cb
->cb_namewidth
, "");
2384 (void) printf("%-*s alloc free read write read write\n",
2385 cb
->cb_namewidth
, "pool");
2386 print_iostat_separator(cb
);
2390 * Display a single statistic.
2393 print_one_stat(uint64_t value
)
2397 zfs_nicenum(value
, buf
, sizeof (buf
));
2398 (void) printf(" %5s", buf
);
2402 * Print out all the statistics for the given vdev. This can either be the
2403 * toplevel configuration, or called recursively. If 'name' is NULL, then this
2404 * is a verbose output, and we don't want to display the toplevel pool stats.
2407 print_vdev_stats(zpool_handle_t
*zhp
, const char *name
, nvlist_t
*oldnv
,
2408 nvlist_t
*newnv
, iostat_cbdata_t
*cb
, int depth
)
2410 nvlist_t
**oldchild
, **newchild
;
2412 vdev_stat_t
*oldvs
, *newvs
;
2413 vdev_stat_t zerovs
= { 0 };
2418 if (oldnv
!= NULL
) {
2419 verify(nvlist_lookup_uint64_array(oldnv
,
2420 ZPOOL_CONFIG_VDEV_STATS
, (uint64_t **)&oldvs
, &c
) == 0);
2425 verify(nvlist_lookup_uint64_array(newnv
, ZPOOL_CONFIG_VDEV_STATS
,
2426 (uint64_t **)&newvs
, &c
) == 0);
2428 if (strlen(name
) + depth
> cb
->cb_namewidth
)
2429 (void) printf("%*s%s", depth
, "", name
);
2431 (void) printf("%*s%s%*s", depth
, "", name
,
2432 (int)(cb
->cb_namewidth
- strlen(name
) - depth
), "");
2434 tdelta
= newvs
->vs_timestamp
- oldvs
->vs_timestamp
;
2439 scale
= (double)NANOSEC
/ tdelta
;
2441 /* only toplevel vdevs have capacity stats */
2442 if (newvs
->vs_space
== 0) {
2443 (void) printf(" - -");
2445 print_one_stat(newvs
->vs_alloc
);
2446 print_one_stat(newvs
->vs_space
- newvs
->vs_alloc
);
2449 print_one_stat((uint64_t)(scale
* (newvs
->vs_ops
[ZIO_TYPE_READ
] -
2450 oldvs
->vs_ops
[ZIO_TYPE_READ
])));
2452 print_one_stat((uint64_t)(scale
* (newvs
->vs_ops
[ZIO_TYPE_WRITE
] -
2453 oldvs
->vs_ops
[ZIO_TYPE_WRITE
])));
2455 print_one_stat((uint64_t)(scale
* (newvs
->vs_bytes
[ZIO_TYPE_READ
] -
2456 oldvs
->vs_bytes
[ZIO_TYPE_READ
])));
2458 print_one_stat((uint64_t)(scale
* (newvs
->vs_bytes
[ZIO_TYPE_WRITE
] -
2459 oldvs
->vs_bytes
[ZIO_TYPE_WRITE
])));
2461 (void) printf("\n");
2463 if (!cb
->cb_verbose
)
2466 if (nvlist_lookup_nvlist_array(newnv
, ZPOOL_CONFIG_CHILDREN
,
2467 &newchild
, &children
) != 0)
2470 if (oldnv
&& nvlist_lookup_nvlist_array(oldnv
, ZPOOL_CONFIG_CHILDREN
,
2471 &oldchild
, &c
) != 0)
2474 for (c
= 0; c
< children
; c
++) {
2475 uint64_t ishole
= B_FALSE
, islog
= B_FALSE
;
2477 (void) nvlist_lookup_uint64(newchild
[c
], ZPOOL_CONFIG_IS_HOLE
,
2480 (void) nvlist_lookup_uint64(newchild
[c
], ZPOOL_CONFIG_IS_LOG
,
2483 if (ishole
|| islog
)
2486 vname
= zpool_vdev_name(g_zfs
, zhp
, newchild
[c
], B_FALSE
);
2487 print_vdev_stats(zhp
, vname
, oldnv
? oldchild
[c
] : NULL
,
2488 newchild
[c
], cb
, depth
+ 2);
2493 * Log device section
2496 if (num_logs(newnv
) > 0) {
2497 (void) printf("%-*s - - - - - "
2498 "-\n", cb
->cb_namewidth
, "logs");
2500 for (c
= 0; c
< children
; c
++) {
2501 uint64_t islog
= B_FALSE
;
2502 (void) nvlist_lookup_uint64(newchild
[c
],
2503 ZPOOL_CONFIG_IS_LOG
, &islog
);
2506 vname
= zpool_vdev_name(g_zfs
, zhp
, newchild
[c
],
2508 print_vdev_stats(zhp
, vname
, oldnv
?
2509 oldchild
[c
] : NULL
, newchild
[c
],
2518 * Include level 2 ARC devices in iostat output
2520 if (nvlist_lookup_nvlist_array(newnv
, ZPOOL_CONFIG_L2CACHE
,
2521 &newchild
, &children
) != 0)
2524 if (oldnv
&& nvlist_lookup_nvlist_array(oldnv
, ZPOOL_CONFIG_L2CACHE
,
2525 &oldchild
, &c
) != 0)
2529 (void) printf("%-*s - - - - - "
2530 "-\n", cb
->cb_namewidth
, "cache");
2531 for (c
= 0; c
< children
; c
++) {
2532 vname
= zpool_vdev_name(g_zfs
, zhp
, newchild
[c
],
2534 print_vdev_stats(zhp
, vname
, oldnv
? oldchild
[c
] : NULL
,
2535 newchild
[c
], cb
, depth
+ 2);
2542 refresh_iostat(zpool_handle_t
*zhp
, void *data
)
2544 iostat_cbdata_t
*cb
= data
;
2548 * If the pool has disappeared, remove it from the list and continue.
2550 if (zpool_refresh_stats(zhp
, &missing
) != 0)
2554 pool_list_remove(cb
->cb_list
, zhp
);
2560 * Callback to print out the iostats for the given pool.
2563 print_iostat(zpool_handle_t
*zhp
, void *data
)
2565 iostat_cbdata_t
*cb
= data
;
2566 nvlist_t
*oldconfig
, *newconfig
;
2567 nvlist_t
*oldnvroot
, *newnvroot
;
2569 newconfig
= zpool_get_config(zhp
, &oldconfig
);
2571 if (cb
->cb_iteration
== 1)
2574 verify(nvlist_lookup_nvlist(newconfig
, ZPOOL_CONFIG_VDEV_TREE
,
2577 if (oldconfig
== NULL
)
2580 verify(nvlist_lookup_nvlist(oldconfig
, ZPOOL_CONFIG_VDEV_TREE
,
2584 * Print out the statistics for the pool.
2586 print_vdev_stats(zhp
, zpool_get_name(zhp
), oldnvroot
, newnvroot
, cb
, 0);
2589 print_iostat_separator(cb
);
2601 if (isatty(STDOUT_FILENO
)) {
2602 error
= ioctl(STDOUT_FILENO
, TIOCGWINSZ
, &ws
);
2604 columns
= ws
.ws_col
;
2613 get_namewidth(zpool_handle_t
*zhp
, void *data
)
2615 iostat_cbdata_t
*cb
= data
;
2616 nvlist_t
*config
, *nvroot
;
2619 if ((config
= zpool_get_config(zhp
, NULL
)) != NULL
) {
2620 verify(nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
2622 if (!cb
->cb_verbose
)
2623 cb
->cb_namewidth
= strlen(zpool_get_name(zhp
));
2625 cb
->cb_namewidth
= max_width(zhp
, nvroot
, 0,
2630 * The width must be at least 10, but may be as large as the
2631 * column width - 42 so that we can still fit in one line.
2633 columns
= get_columns();
2635 if (cb
->cb_namewidth
< 10)
2636 cb
->cb_namewidth
= 10;
2637 if (cb
->cb_namewidth
> columns
- 42)
2638 cb
->cb_namewidth
= columns
- 42;
2644 * Parse the input string, get the 'interval' and 'count' value if there is one.
2647 get_interval_count(int *argcp
, char **argv
, unsigned long *iv
,
2650 unsigned long interval
= 0, count
= 0;
2654 * Determine if the last argument is an integer or a pool name
2656 if (argc
> 0 && isdigit(argv
[argc
- 1][0])) {
2660 interval
= strtoul(argv
[argc
- 1], &end
, 10);
2662 if (*end
== '\0' && errno
== 0) {
2663 if (interval
== 0) {
2664 (void) fprintf(stderr
, gettext("interval "
2665 "cannot be zero\n"));
2669 * Ignore the last parameter
2674 * If this is not a valid number, just plow on. The
2675 * user will get a more informative error message later
2683 * If the last argument is also an integer, then we have both a count
2686 if (argc
> 0 && isdigit(argv
[argc
- 1][0])) {
2691 interval
= strtoul(argv
[argc
- 1], &end
, 10);
2693 if (*end
== '\0' && errno
== 0) {
2694 if (interval
== 0) {
2695 (void) fprintf(stderr
, gettext("interval "
2696 "cannot be zero\n"));
2701 * Ignore the last parameter
2715 get_timestamp_arg(char c
)
2718 timestamp_fmt
= UDATE
;
2720 timestamp_fmt
= DDATE
;
2726 * zpool iostat [-v] [-T d|u] [pool] ... [interval [count]]
2728 * -v Display statistics for individual vdevs
2729 * -T Display a timestamp in date(1) or Unix format
2731 * This command can be tricky because we want to be able to deal with pool
2732 * creation/destruction as well as vdev configuration changes. The bulk of this
2733 * processing is handled by the pool_list_* routines in zpool_iter.c. We rely
2734 * on pool_list_update() to detect the addition of new pools. Configuration
2735 * changes are all handled within libzfs.
2738 zpool_do_iostat(int argc
, char **argv
)
2743 unsigned long interval
= 0, count
= 0;
2745 boolean_t verbose
= B_FALSE
;
2749 while ((c
= getopt(argc
, argv
, "T:v")) != -1) {
2752 get_timestamp_arg(*optarg
);
2758 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
2767 get_interval_count(&argc
, argv
, &interval
, &count
);
2770 * Construct the list of all interesting pools.
2773 if ((list
= pool_list_get(argc
, argv
, NULL
, &ret
)) == NULL
)
2776 if (pool_list_count(list
) == 0 && argc
!= 0) {
2777 pool_list_free(list
);
2781 if (pool_list_count(list
) == 0 && interval
== 0) {
2782 pool_list_free(list
);
2783 (void) fprintf(stderr
, gettext("no pools available\n"));
2788 * Enter the main iostat loop.
2791 cb
.cb_verbose
= verbose
;
2792 cb
.cb_iteration
= 0;
2793 cb
.cb_namewidth
= 0;
2796 pool_list_update(list
);
2798 if ((npools
= pool_list_count(list
)) == 0)
2799 (void) fprintf(stderr
, gettext("no pools available\n"));
2802 * Refresh all statistics. This is done as an
2803 * explicit step before calculating the maximum name
2804 * width, so that any * configuration changes are
2805 * properly accounted for.
2807 (void) pool_list_iter(list
, B_FALSE
, refresh_iostat
,
2811 * Iterate over all pools to determine the maximum width
2812 * for the pool / device name column across all pools.
2814 cb
.cb_namewidth
= 0;
2815 (void) pool_list_iter(list
, B_FALSE
, get_namewidth
,
2818 if (timestamp_fmt
!= NODATE
)
2819 print_timestamp(timestamp_fmt
);
2822 * If it's the first time, or verbose mode, print the
2825 if (++cb
.cb_iteration
== 1 || verbose
)
2826 print_iostat_header(&cb
);
2828 (void) pool_list_iter(list
, B_FALSE
, print_iostat
, &cb
);
2831 * If there's more than one pool, and we're not in
2832 * verbose mode (which prints a separator for us),
2833 * then print a separator.
2835 if (npools
> 1 && !verbose
)
2836 print_iostat_separator(&cb
);
2839 (void) printf("\n");
2843 * Flush the output so that redirection to a file isn't buffered
2846 (void) fflush(stdout
);
2851 if (count
!= 0 && --count
== 0)
2854 (void) sleep(interval
);
2857 pool_list_free(list
);
2862 typedef struct list_cbdata
{
2863 boolean_t cb_verbose
;
2865 boolean_t cb_scripted
;
2866 zprop_list_t
*cb_proplist
;
2870 * Given a list of columns to display, output appropriate headers for each one.
2873 print_header(list_cbdata_t
*cb
)
2875 zprop_list_t
*pl
= cb
->cb_proplist
;
2876 char headerbuf
[ZPOOL_MAXPROPLEN
];
2878 boolean_t first
= B_TRUE
;
2879 boolean_t right_justify
;
2882 for (; pl
!= NULL
; pl
= pl
->pl_next
) {
2883 width
= pl
->pl_width
;
2884 if (first
&& cb
->cb_verbose
) {
2886 * Reset the width to accommodate the verbose listing
2889 width
= cb
->cb_namewidth
;
2897 right_justify
= B_FALSE
;
2898 if (pl
->pl_prop
!= ZPROP_INVAL
) {
2899 header
= zpool_prop_column_name(pl
->pl_prop
);
2900 right_justify
= zpool_prop_align_right(pl
->pl_prop
);
2904 for (i
= 0; pl
->pl_user_prop
[i
] != '\0'; i
++)
2905 headerbuf
[i
] = toupper(pl
->pl_user_prop
[i
]);
2906 headerbuf
[i
] = '\0';
2910 if (pl
->pl_next
== NULL
&& !right_justify
)
2911 (void) printf("%s", header
);
2912 else if (right_justify
)
2913 (void) printf("%*s", (int)width
, header
);
2915 (void) printf("%-*s", (int)width
, header
);
2918 (void) printf("\n");
2922 * Given a pool and a list of properties, print out all the properties according
2923 * to the described layout.
2926 print_pool(zpool_handle_t
*zhp
, list_cbdata_t
*cb
)
2928 zprop_list_t
*pl
= cb
->cb_proplist
;
2929 boolean_t first
= B_TRUE
;
2930 char property
[ZPOOL_MAXPROPLEN
];
2932 boolean_t right_justify
;
2935 for (; pl
!= NULL
; pl
= pl
->pl_next
) {
2937 width
= pl
->pl_width
;
2938 if (first
&& cb
->cb_verbose
) {
2940 * Reset the width to accommodate the verbose listing
2943 width
= cb
->cb_namewidth
;
2947 if (cb
->cb_scripted
)
2948 (void) printf("\t");
2955 right_justify
= B_FALSE
;
2956 if (pl
->pl_prop
!= ZPROP_INVAL
) {
2957 if (pl
->pl_prop
== ZPOOL_PROP_EXPANDSZ
&&
2958 zpool_get_prop_int(zhp
, pl
->pl_prop
, NULL
) == 0)
2960 else if (zpool_get_prop(zhp
, pl
->pl_prop
, property
,
2961 sizeof (property
), NULL
) != 0)
2966 right_justify
= zpool_prop_align_right(pl
->pl_prop
);
2967 } else if ((zpool_prop_feature(pl
->pl_user_prop
) ||
2968 zpool_prop_unsupported(pl
->pl_user_prop
)) &&
2969 zpool_prop_get_feature(zhp
, pl
->pl_user_prop
, property
,
2970 sizeof (property
)) == 0) {
2978 * If this is being called in scripted mode, or if this is the
2979 * last column and it is left-justified, don't include a width
2982 if (cb
->cb_scripted
|| (pl
->pl_next
== NULL
&& !right_justify
))
2983 (void) printf("%s", propstr
);
2984 else if (right_justify
)
2985 (void) printf("%*s", (int)width
, propstr
);
2987 (void) printf("%-*s", (int)width
, propstr
);
2990 (void) printf("\n");
2994 print_one_column(zpool_prop_t prop
, uint64_t value
, boolean_t scripted
)
2998 size_t width
= zprop_width(prop
, &fixed
, ZFS_TYPE_POOL
);
3000 zfs_nicenum(value
, propval
, sizeof (propval
));
3002 if (prop
== ZPOOL_PROP_EXPANDSZ
&& value
== 0)
3003 (void) strlcpy(propval
, "-", sizeof (propval
));
3006 (void) printf("\t%s", propval
);
3008 (void) printf(" %*s", (int)width
, propval
);
3012 print_list_stats(zpool_handle_t
*zhp
, const char *name
, nvlist_t
*nv
,
3013 list_cbdata_t
*cb
, int depth
)
3019 boolean_t scripted
= cb
->cb_scripted
;
3021 verify(nvlist_lookup_uint64_array(nv
, ZPOOL_CONFIG_VDEV_STATS
,
3022 (uint64_t **)&vs
, &c
) == 0);
3026 (void) printf("\t%s", name
);
3027 else if (strlen(name
) + depth
> cb
->cb_namewidth
)
3028 (void) printf("%*s%s", depth
, "", name
);
3030 (void) printf("%*s%s%*s", depth
, "", name
,
3031 (int)(cb
->cb_namewidth
- strlen(name
) - depth
), "");
3033 /* only toplevel vdevs have capacity stats */
3034 if (vs
->vs_space
== 0) {
3036 (void) printf("\t-\t-\t-");
3038 (void) printf(" - - -");
3040 print_one_column(ZPOOL_PROP_SIZE
, vs
->vs_space
,
3042 print_one_column(ZPOOL_PROP_CAPACITY
, vs
->vs_alloc
,
3044 print_one_column(ZPOOL_PROP_FREE
,
3045 vs
->vs_space
- vs
->vs_alloc
, scripted
);
3047 print_one_column(ZPOOL_PROP_EXPANDSZ
, vs
->vs_esize
,
3049 (void) printf("\n");
3052 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
3053 &child
, &children
) != 0)
3056 for (c
= 0; c
< children
; c
++) {
3057 uint64_t ishole
= B_FALSE
;
3059 if (nvlist_lookup_uint64(child
[c
],
3060 ZPOOL_CONFIG_IS_HOLE
, &ishole
) == 0 && ishole
)
3063 vname
= zpool_vdev_name(g_zfs
, zhp
, child
[c
], B_FALSE
);
3064 print_list_stats(zhp
, vname
, child
[c
], cb
, depth
+ 2);
3069 * Include level 2 ARC devices in iostat output
3071 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_L2CACHE
,
3072 &child
, &children
) != 0)
3076 (void) printf("%-*s - - - - - "
3077 "-\n", cb
->cb_namewidth
, "cache");
3078 for (c
= 0; c
< children
; c
++) {
3079 vname
= zpool_vdev_name(g_zfs
, zhp
, child
[c
],
3081 print_list_stats(zhp
, vname
, child
[c
], cb
, depth
+ 2);
3089 * Generic callback function to list a pool.
3092 list_callback(zpool_handle_t
*zhp
, void *data
)
3094 list_cbdata_t
*cbp
= data
;
3098 config
= zpool_get_config(zhp
, NULL
);
3100 print_pool(zhp
, cbp
);
3101 if (!cbp
->cb_verbose
)
3104 verify(nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
3106 print_list_stats(zhp
, NULL
, nvroot
, cbp
, 0);
3112 * zpool list [-H] [-o prop[,prop]*] [-T d|u] [pool] ... [interval [count]]
3114 * -H Scripted mode. Don't display headers, and separate properties
3116 * -o List of properties to display. Defaults to
3117 * "name,size,allocated,free,capacity,health,altroot"
3118 * -T Display a timestamp in date(1) or Unix format
3120 * List all pools in the system, whether or not they're healthy. Output space
3121 * statistics for each one, as well as health status summary.
3124 zpool_do_list(int argc
, char **argv
)
3128 list_cbdata_t cb
= { 0 };
3129 static char default_props
[] =
3130 "name,size,allocated,free,capacity,dedupratio,"
3132 char *props
= default_props
;
3133 unsigned long interval
= 0, count
= 0;
3135 boolean_t first
= B_TRUE
;
3138 while ((c
= getopt(argc
, argv
, ":Ho:T:v")) != -1) {
3141 cb
.cb_scripted
= B_TRUE
;
3147 get_timestamp_arg(*optarg
);
3150 cb
.cb_verbose
= B_TRUE
;
3153 (void) fprintf(stderr
, gettext("missing argument for "
3154 "'%c' option\n"), optopt
);
3158 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3167 get_interval_count(&argc
, argv
, &interval
, &count
);
3169 if (zprop_get_list(g_zfs
, props
, &cb
.cb_proplist
, ZFS_TYPE_POOL
) != 0)
3172 if ((list
= pool_list_get(argc
, argv
, &cb
.cb_proplist
, &ret
)) == NULL
)
3175 if (argc
== 0 && !cb
.cb_scripted
&& pool_list_count(list
) == 0) {
3176 (void) printf(gettext("no pools available\n"));
3177 zprop_free_list(cb
.cb_proplist
);
3182 pool_list_update(list
);
3184 if (pool_list_count(list
) == 0)
3187 if (timestamp_fmt
!= NODATE
)
3188 print_timestamp(timestamp_fmt
);
3190 if (!cb
.cb_scripted
&& (first
|| cb
.cb_verbose
)) {
3194 ret
= pool_list_iter(list
, B_TRUE
, list_callback
, &cb
);
3199 if (count
!= 0 && --count
== 0)
3202 (void) sleep(interval
);
3205 zprop_free_list(cb
.cb_proplist
);
3210 zpool_do_attach_or_replace(int argc
, char **argv
, int replacing
)
3212 boolean_t force
= B_FALSE
;
3215 char *poolname
, *old_disk
, *new_disk
;
3216 zpool_handle_t
*zhp
;
3217 nvlist_t
*props
= NULL
;
3222 while ((c
= getopt(argc
, argv
, "fo:")) != -1) {
3228 if ((propval
= strchr(optarg
, '=')) == NULL
) {
3229 (void) fprintf(stderr
, gettext("missing "
3230 "'=' for -o option\n"));
3236 if ((strcmp(optarg
, ZPOOL_CONFIG_ASHIFT
) != 0) ||
3237 (add_prop_list(optarg
, propval
, &props
, B_TRUE
)))
3241 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3250 /* get pool name and check number of arguments */
3252 (void) fprintf(stderr
, gettext("missing pool name argument\n"));
3259 (void) fprintf(stderr
,
3260 gettext("missing <device> specification\n"));
3268 (void) fprintf(stderr
,
3269 gettext("missing <new_device> specification\n"));
3272 new_disk
= old_disk
;
3282 (void) fprintf(stderr
, gettext("too many arguments\n"));
3286 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
3289 if (zpool_get_config(zhp
, NULL
) == NULL
) {
3290 (void) fprintf(stderr
, gettext("pool '%s' is unavailable\n"),
3296 nvroot
= make_root_vdev(zhp
, props
, force
, B_FALSE
, replacing
, B_FALSE
,
3298 if (nvroot
== NULL
) {
3303 ret
= zpool_vdev_attach(zhp
, old_disk
, new_disk
, nvroot
, replacing
);
3305 nvlist_free(nvroot
);
3312 * zpool replace [-f] <pool> <device> <new_device>
3314 * -f Force attach, even if <new_device> appears to be in use.
3316 * Replace <device> with <new_device>.
3320 zpool_do_replace(int argc
, char **argv
)
3322 return (zpool_do_attach_or_replace(argc
, argv
, B_TRUE
));
3326 * zpool attach [-f] [-o property=value] <pool> <device> <new_device>
3328 * -f Force attach, even if <new_device> appears to be in use.
3329 * -o Set property=value.
3331 * Attach <new_device> to the mirror containing <device>. If <device> is not
3332 * part of a mirror, then <device> will be transformed into a mirror of
3333 * <device> and <new_device>. In either case, <new_device> will begin life
3334 * with a DTL of [0, now], and will immediately begin to resilver itself.
3337 zpool_do_attach(int argc
, char **argv
)
3339 return (zpool_do_attach_or_replace(argc
, argv
, B_FALSE
));
3343 * zpool detach [-f] <pool> <device>
3345 * -f Force detach of <device>, even if DTLs argue against it
3346 * (not supported yet)
3348 * Detach a device from a mirror. The operation will be refused if <device>
3349 * is the last device in the mirror, or if the DTLs indicate that this device
3350 * has the only valid copy of some data.
3354 zpool_do_detach(int argc
, char **argv
)
3357 char *poolname
, *path
;
3358 zpool_handle_t
*zhp
;
3362 while ((c
= getopt(argc
, argv
, "f")) != -1) {
3366 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3375 /* get pool name and check number of arguments */
3377 (void) fprintf(stderr
, gettext("missing pool name argument\n"));
3382 (void) fprintf(stderr
,
3383 gettext("missing <device> specification\n"));
3390 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
3393 ret
= zpool_vdev_detach(zhp
, path
);
3401 * zpool split [-n] [-o prop=val] ...
3403 * [-R altroot] <pool> <newpool> [<device> ...]
3405 * -n Do not split the pool, but display the resulting layout if
3406 * it were to be split.
3407 * -o Set property=value, or set mount options.
3408 * -R Mount the split-off pool under an alternate root.
3410 * Splits the named pool and gives it the new pool name. Devices to be split
3411 * off may be listed, provided that no more than one device is specified
3412 * per top-level vdev mirror. The newly split pool is left in an exported
3413 * state unless -R is specified.
3415 * Restrictions: the top-level of the pool pool must only be made up of
3416 * mirrors; all devices in the pool must be healthy; no device may be
3417 * undergoing a resilvering operation.
3420 zpool_do_split(int argc
, char **argv
)
3422 char *srcpool
, *newpool
, *propval
;
3423 char *mntopts
= NULL
;
3426 zpool_handle_t
*zhp
;
3427 nvlist_t
*config
, *props
= NULL
;
3429 flags
.dryrun
= B_FALSE
;
3430 flags
.import
= B_FALSE
;
3433 while ((c
= getopt(argc
, argv
, ":R:no:")) != -1) {
3436 flags
.import
= B_TRUE
;
3438 zpool_prop_to_name(ZPOOL_PROP_ALTROOT
), optarg
,
3439 &props
, B_TRUE
) != 0) {
3446 flags
.dryrun
= B_TRUE
;
3449 if ((propval
= strchr(optarg
, '=')) != NULL
) {
3452 if (add_prop_list(optarg
, propval
,
3453 &props
, B_TRUE
) != 0) {
3463 (void) fprintf(stderr
, gettext("missing argument for "
3464 "'%c' option\n"), optopt
);
3468 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3475 if (!flags
.import
&& mntopts
!= NULL
) {
3476 (void) fprintf(stderr
, gettext("setting mntopts is only "
3477 "valid when importing the pool\n"));
3485 (void) fprintf(stderr
, gettext("Missing pool name\n"));
3489 (void) fprintf(stderr
, gettext("Missing new pool name\n"));
3499 if ((zhp
= zpool_open(g_zfs
, srcpool
)) == NULL
)
3502 config
= split_mirror_vdev(zhp
, newpool
, props
, flags
, argc
, argv
);
3503 if (config
== NULL
) {
3507 (void) printf(gettext("would create '%s' with the "
3508 "following layout:\n\n"), newpool
);
3509 print_vdev_tree(NULL
, newpool
, config
, 0, B_FALSE
);
3511 nvlist_free(config
);
3516 if (ret
!= 0 || flags
.dryrun
|| !flags
.import
)
3520 * The split was successful. Now we need to open the new
3521 * pool and import it.
3523 if ((zhp
= zpool_open_canfail(g_zfs
, newpool
)) == NULL
)
3525 if (zpool_get_state(zhp
) != POOL_STATE_UNAVAIL
&&
3526 zpool_enable_datasets(zhp
, mntopts
, 0) != 0) {
3528 (void) fprintf(stderr
, gettext("Split was successful, but "
3529 "the datasets could not all be mounted\n"));
3530 (void) fprintf(stderr
, gettext("Try doing '%s' with a "
3531 "different altroot\n"), "zpool import");
3541 * zpool online <pool> <device> ...
3544 zpool_do_online(int argc
, char **argv
)
3548 zpool_handle_t
*zhp
;
3550 vdev_state_t newstate
;
3554 while ((c
= getopt(argc
, argv
, "et")) != -1) {
3557 flags
|= ZFS_ONLINE_EXPAND
;
3561 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3570 /* get pool name and check number of arguments */
3572 (void) fprintf(stderr
, gettext("missing pool name\n"));
3576 (void) fprintf(stderr
, gettext("missing device name\n"));
3582 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
3585 for (i
= 1; i
< argc
; i
++) {
3586 if (zpool_vdev_online(zhp
, argv
[i
], flags
, &newstate
) == 0) {
3587 if (newstate
!= VDEV_STATE_HEALTHY
) {
3588 (void) printf(gettext("warning: device '%s' "
3589 "onlined, but remains in faulted state\n"),
3591 if (newstate
== VDEV_STATE_FAULTED
)
3592 (void) printf(gettext("use 'zpool "
3593 "clear' to restore a faulted "
3596 (void) printf(gettext("use 'zpool "
3597 "replace' to replace devices "
3598 "that are no longer present\n"));
3611 * zpool offline [-ft] <pool> <device> ...
3613 * -f Force the device into the offline state, even if doing
3614 * so would appear to compromise pool availability.
3615 * (not supported yet)
3617 * -t Only take the device off-line temporarily. The offline
3618 * state will not be persistent across reboots.
3622 zpool_do_offline(int argc
, char **argv
)
3626 zpool_handle_t
*zhp
;
3628 boolean_t istmp
= B_FALSE
;
3631 while ((c
= getopt(argc
, argv
, "ft")) != -1) {
3638 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3647 /* get pool name and check number of arguments */
3649 (void) fprintf(stderr
, gettext("missing pool name\n"));
3653 (void) fprintf(stderr
, gettext("missing device name\n"));
3659 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
3662 for (i
= 1; i
< argc
; i
++) {
3663 if (zpool_vdev_offline(zhp
, argv
[i
], istmp
) != 0)
3673 * zpool clear <pool> [device]
3675 * Clear all errors associated with a pool or a particular device.
3678 zpool_do_clear(int argc
, char **argv
)
3682 boolean_t dryrun
= B_FALSE
;
3683 boolean_t do_rewind
= B_FALSE
;
3684 boolean_t xtreme_rewind
= B_FALSE
;
3685 uint32_t rewind_policy
= ZPOOL_NO_REWIND
;
3686 nvlist_t
*policy
= NULL
;
3687 zpool_handle_t
*zhp
;
3688 char *pool
, *device
;
3691 while ((c
= getopt(argc
, argv
, "FnX")) != -1) {
3700 xtreme_rewind
= B_TRUE
;
3703 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3713 (void) fprintf(stderr
, gettext("missing pool name\n"));
3718 (void) fprintf(stderr
, gettext("too many arguments\n"));
3722 if ((dryrun
|| xtreme_rewind
) && !do_rewind
) {
3723 (void) fprintf(stderr
,
3724 gettext("-n or -X only meaningful with -F\n"));
3728 rewind_policy
= ZPOOL_TRY_REWIND
;
3730 rewind_policy
= ZPOOL_DO_REWIND
;
3732 rewind_policy
|= ZPOOL_EXTREME_REWIND
;
3734 /* In future, further rewind policy choices can be passed along here */
3735 if (nvlist_alloc(&policy
, NV_UNIQUE_NAME
, 0) != 0 ||
3736 nvlist_add_uint32(policy
, ZPOOL_REWIND_REQUEST
, rewind_policy
) != 0)
3740 device
= argc
== 2 ? argv
[1] : NULL
;
3742 if ((zhp
= zpool_open_canfail(g_zfs
, pool
)) == NULL
) {
3743 nvlist_free(policy
);
3747 if (zpool_clear(zhp
, device
, policy
) != 0)
3752 nvlist_free(policy
);
3758 * zpool reguid <pool>
3761 zpool_do_reguid(int argc
, char **argv
)
3765 zpool_handle_t
*zhp
;
3769 while ((c
= getopt(argc
, argv
, "")) != -1) {
3772 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3781 /* get pool name and check number of arguments */
3783 (void) fprintf(stderr
, gettext("missing pool name\n"));
3788 (void) fprintf(stderr
, gettext("too many arguments\n"));
3793 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
3796 ret
= zpool_reguid(zhp
);
3804 * zpool reopen <pool>
3806 * Reopen the pool so that the kernel can update the sizes of all vdevs.
3809 zpool_do_reopen(int argc
, char **argv
)
3813 zpool_handle_t
*zhp
;
3817 while ((c
= getopt(argc
, argv
, "")) != -1) {
3820 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3830 (void) fprintf(stderr
, gettext("missing pool name\n"));
3835 (void) fprintf(stderr
, gettext("too many arguments\n"));
3840 if ((zhp
= zpool_open_canfail(g_zfs
, pool
)) == NULL
)
3843 ret
= zpool_reopen(zhp
);
3848 typedef struct scrub_cbdata
{
3855 scrub_callback(zpool_handle_t
*zhp
, void *data
)
3857 scrub_cbdata_t
*cb
= data
;
3861 * Ignore faulted pools.
3863 if (zpool_get_state(zhp
) == POOL_STATE_UNAVAIL
) {
3864 (void) fprintf(stderr
, gettext("cannot scrub '%s': pool is "
3865 "currently unavailable\n"), zpool_get_name(zhp
));
3869 err
= zpool_scan(zhp
, cb
->cb_type
);
3875 * zpool scrub [-s] <pool> ...
3877 * -s Stop. Stops any in-progress scrub.
3880 zpool_do_scrub(int argc
, char **argv
)
3885 cb
.cb_type
= POOL_SCAN_SCRUB
;
3888 while ((c
= getopt(argc
, argv
, "s")) != -1) {
3891 cb
.cb_type
= POOL_SCAN_NONE
;
3894 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3906 (void) fprintf(stderr
, gettext("missing pool name argument\n"));
3910 return (for_each_pool(argc
, argv
, B_TRUE
, NULL
, scrub_callback
, &cb
));
3913 typedef struct status_cbdata
{
3915 boolean_t cb_allpools
;
3916 boolean_t cb_verbose
;
3917 boolean_t cb_explain
;
3919 boolean_t cb_dedup_stats
;
3923 * Print out detailed scrub status.
3926 print_scan_status(pool_scan_stat_t
*ps
)
3929 uint64_t elapsed
, mins_left
, hours_left
;
3930 uint64_t pass_exam
, examined
, total
;
3932 double fraction_done
;
3933 char processed_buf
[7], examined_buf
[7], total_buf
[7], rate_buf
[7];
3935 (void) printf(gettext(" scan: "));
3937 /* If there's never been a scan, there's not much to say. */
3938 if (ps
== NULL
|| ps
->pss_func
== POOL_SCAN_NONE
||
3939 ps
->pss_func
>= POOL_SCAN_FUNCS
) {
3940 (void) printf(gettext("none requested\n"));
3944 start
= ps
->pss_start_time
;
3945 end
= ps
->pss_end_time
;
3946 zfs_nicenum(ps
->pss_processed
, processed_buf
, sizeof (processed_buf
));
3948 assert(ps
->pss_func
== POOL_SCAN_SCRUB
||
3949 ps
->pss_func
== POOL_SCAN_RESILVER
);
3951 * Scan is finished or canceled.
3953 if (ps
->pss_state
== DSS_FINISHED
) {
3954 uint64_t minutes_taken
= (end
- start
) / 60;
3957 if (ps
->pss_func
== POOL_SCAN_SCRUB
) {
3958 fmt
= gettext("scrub repaired %s in %lluh%um with "
3959 "%llu errors on %s");
3960 } else if (ps
->pss_func
== POOL_SCAN_RESILVER
) {
3961 fmt
= gettext("resilvered %s in %lluh%um with "
3962 "%llu errors on %s");
3965 (void) printf(fmt
, processed_buf
,
3966 (u_longlong_t
)(minutes_taken
/ 60),
3967 (uint_t
)(minutes_taken
% 60),
3968 (u_longlong_t
)ps
->pss_errors
,
3969 ctime((time_t *)&end
));
3971 } else if (ps
->pss_state
== DSS_CANCELED
) {
3972 if (ps
->pss_func
== POOL_SCAN_SCRUB
) {
3973 (void) printf(gettext("scrub canceled on %s"),
3975 } else if (ps
->pss_func
== POOL_SCAN_RESILVER
) {
3976 (void) printf(gettext("resilver canceled on %s"),
3982 assert(ps
->pss_state
== DSS_SCANNING
);
3985 * Scan is in progress.
3987 if (ps
->pss_func
== POOL_SCAN_SCRUB
) {
3988 (void) printf(gettext("scrub in progress since %s"),
3990 } else if (ps
->pss_func
== POOL_SCAN_RESILVER
) {
3991 (void) printf(gettext("resilver in progress since %s"),
3995 examined
= ps
->pss_examined
? ps
->pss_examined
: 1;
3996 total
= ps
->pss_to_examine
;
3997 fraction_done
= (double)examined
/ total
;
3999 /* elapsed time for this pass */
4000 elapsed
= time(NULL
) - ps
->pss_pass_start
;
4001 elapsed
= elapsed
? elapsed
: 1;
4002 pass_exam
= ps
->pss_pass_exam
? ps
->pss_pass_exam
: 1;
4003 rate
= pass_exam
/ elapsed
;
4004 rate
= rate
? rate
: 1;
4005 mins_left
= ((total
- examined
) / rate
) / 60;
4006 hours_left
= mins_left
/ 60;
4008 zfs_nicenum(examined
, examined_buf
, sizeof (examined_buf
));
4009 zfs_nicenum(total
, total_buf
, sizeof (total_buf
));
4010 zfs_nicenum(rate
, rate_buf
, sizeof (rate_buf
));
4013 * do not print estimated time if hours_left is more than 30 days
4015 (void) printf(gettext(" %s scanned out of %s at %s/s"),
4016 examined_buf
, total_buf
, rate_buf
);
4017 if (hours_left
< (30 * 24)) {
4018 (void) printf(gettext(", %lluh%um to go\n"),
4019 (u_longlong_t
)hours_left
, (uint_t
)(mins_left
% 60));
4021 (void) printf(gettext(
4022 ", (scan is slow, no estimated time)\n"));
4025 if (ps
->pss_func
== POOL_SCAN_RESILVER
) {
4026 (void) printf(gettext(" %s resilvered, %.2f%% done\n"),
4027 processed_buf
, 100 * fraction_done
);
4028 } else if (ps
->pss_func
== POOL_SCAN_SCRUB
) {
4029 (void) printf(gettext(" %s repaired, %.2f%% done\n"),
4030 processed_buf
, 100 * fraction_done
);
4035 print_error_log(zpool_handle_t
*zhp
)
4037 nvlist_t
*nverrlist
= NULL
;
4040 size_t len
= MAXPATHLEN
* 2;
4042 if (zpool_get_errlog(zhp
, &nverrlist
) != 0) {
4043 (void) printf("errors: List of errors unavailable "
4044 "(insufficient privileges)\n");
4048 (void) printf("errors: Permanent errors have been "
4049 "detected in the following files:\n\n");
4051 pathname
= safe_malloc(len
);
4053 while ((elem
= nvlist_next_nvpair(nverrlist
, elem
)) != NULL
) {
4055 uint64_t dsobj
, obj
;
4057 verify(nvpair_value_nvlist(elem
, &nv
) == 0);
4058 verify(nvlist_lookup_uint64(nv
, ZPOOL_ERR_DATASET
,
4060 verify(nvlist_lookup_uint64(nv
, ZPOOL_ERR_OBJECT
,
4062 zpool_obj_to_path(zhp
, dsobj
, obj
, pathname
, len
);
4063 (void) printf("%7s %s\n", "", pathname
);
4066 nvlist_free(nverrlist
);
4070 print_spares(zpool_handle_t
*zhp
, nvlist_t
**spares
, uint_t nspares
,
4079 (void) printf(gettext("\tspares\n"));
4081 for (i
= 0; i
< nspares
; i
++) {
4082 name
= zpool_vdev_name(g_zfs
, zhp
, spares
[i
], B_FALSE
);
4083 print_status_config(zhp
, name
, spares
[i
],
4084 namewidth
, 2, B_TRUE
);
4090 print_l2cache(zpool_handle_t
*zhp
, nvlist_t
**l2cache
, uint_t nl2cache
,
4099 (void) printf(gettext("\tcache\n"));
4101 for (i
= 0; i
< nl2cache
; i
++) {
4102 name
= zpool_vdev_name(g_zfs
, zhp
, l2cache
[i
], B_FALSE
);
4103 print_status_config(zhp
, name
, l2cache
[i
],
4104 namewidth
, 2, B_FALSE
);
4110 print_dedup_stats(nvlist_t
*config
)
4112 ddt_histogram_t
*ddh
;
4118 * If the pool was faulted then we may not have been able to
4119 * obtain the config. Otherwise, if we have anything in the dedup
4120 * table continue processing the stats.
4122 if (nvlist_lookup_uint64_array(config
, ZPOOL_CONFIG_DDT_OBJ_STATS
,
4123 (uint64_t **)&ddo
, &c
) != 0)
4126 (void) printf("\n");
4127 (void) printf(gettext(" dedup: "));
4128 if (ddo
->ddo_count
== 0) {
4129 (void) printf(gettext("no DDT entries\n"));
4133 (void) printf("DDT entries %llu, size %llu on disk, %llu in core\n",
4134 (u_longlong_t
)ddo
->ddo_count
,
4135 (u_longlong_t
)ddo
->ddo_dspace
,
4136 (u_longlong_t
)ddo
->ddo_mspace
);
4138 verify(nvlist_lookup_uint64_array(config
, ZPOOL_CONFIG_DDT_STATS
,
4139 (uint64_t **)&dds
, &c
) == 0);
4140 verify(nvlist_lookup_uint64_array(config
, ZPOOL_CONFIG_DDT_HISTOGRAM
,
4141 (uint64_t **)&ddh
, &c
) == 0);
4142 zpool_dump_ddt(dds
, ddh
);
4146 * Display a summary of pool status. Displays a summary such as:
4150 * reason: One or more devices ...
4151 * see: http://zfsonlinux.org/msg/ZFS-xxxx-01
4157 * When given the '-v' option, we print out the complete config. If the '-e'
4158 * option is specified, then we print out error rate information as well.
4161 status_callback(zpool_handle_t
*zhp
, void *data
)
4163 status_cbdata_t
*cbp
= data
;
4164 nvlist_t
*config
, *nvroot
;
4166 zpool_status_t reason
;
4167 zpool_errata_t errata
;
4172 config
= zpool_get_config(zhp
, NULL
);
4173 reason
= zpool_get_status(zhp
, &msgid
, &errata
);
4178 * If we were given 'zpool status -x', only report those pools with
4181 if (cbp
->cb_explain
&&
4182 (reason
== ZPOOL_STATUS_OK
||
4183 reason
== ZPOOL_STATUS_VERSION_OLDER
||
4184 reason
== ZPOOL_STATUS_FEAT_DISABLED
)) {
4185 if (!cbp
->cb_allpools
) {
4186 (void) printf(gettext("pool '%s' is healthy\n"),
4187 zpool_get_name(zhp
));
4189 cbp
->cb_first
= B_FALSE
;
4195 cbp
->cb_first
= B_FALSE
;
4197 (void) printf("\n");
4199 verify(nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
4201 verify(nvlist_lookup_uint64_array(nvroot
, ZPOOL_CONFIG_VDEV_STATS
,
4202 (uint64_t **)&vs
, &c
) == 0);
4203 health
= zpool_state_to_name(vs
->vs_state
, vs
->vs_aux
);
4205 (void) printf(gettext(" pool: %s\n"), zpool_get_name(zhp
));
4206 (void) printf(gettext(" state: %s\n"), health
);
4209 case ZPOOL_STATUS_MISSING_DEV_R
:
4210 (void) printf(gettext("status: One or more devices could not "
4211 "be opened. Sufficient replicas exist for\n\tthe pool to "
4212 "continue functioning in a degraded state.\n"));
4213 (void) printf(gettext("action: Attach the missing device and "
4214 "online it using 'zpool online'.\n"));
4217 case ZPOOL_STATUS_MISSING_DEV_NR
:
4218 (void) printf(gettext("status: One or more devices could not "
4219 "be opened. There are insufficient\n\treplicas for the "
4220 "pool to continue functioning.\n"));
4221 (void) printf(gettext("action: Attach the missing device and "
4222 "online it using 'zpool online'.\n"));
4225 case ZPOOL_STATUS_CORRUPT_LABEL_R
:
4226 (void) printf(gettext("status: One or more devices could not "
4227 "be used because the label is missing or\n\tinvalid. "
4228 "Sufficient replicas exist for the pool to continue\n\t"
4229 "functioning in a degraded state.\n"));
4230 (void) printf(gettext("action: Replace the device using "
4231 "'zpool replace'.\n"));
4234 case ZPOOL_STATUS_CORRUPT_LABEL_NR
:
4235 (void) printf(gettext("status: One or more devices could not "
4236 "be used because the label is missing \n\tor invalid. "
4237 "There are insufficient replicas for the pool to "
4238 "continue\n\tfunctioning.\n"));
4239 zpool_explain_recover(zpool_get_handle(zhp
),
4240 zpool_get_name(zhp
), reason
, config
);
4243 case ZPOOL_STATUS_FAILING_DEV
:
4244 (void) printf(gettext("status: One or more devices has "
4245 "experienced an unrecoverable error. An\n\tattempt was "
4246 "made to correct the error. Applications are "
4248 (void) printf(gettext("action: Determine if the device needs "
4249 "to be replaced, and clear the errors\n\tusing "
4250 "'zpool clear' or replace the device with 'zpool "
4254 case ZPOOL_STATUS_OFFLINE_DEV
:
4255 (void) printf(gettext("status: One or more devices has "
4256 "been taken offline by the administrator.\n\tSufficient "
4257 "replicas exist for the pool to continue functioning in "
4258 "a\n\tdegraded state.\n"));
4259 (void) printf(gettext("action: Online the device using "
4260 "'zpool online' or replace the device with\n\t'zpool "
4264 case ZPOOL_STATUS_REMOVED_DEV
:
4265 (void) printf(gettext("status: One or more devices has "
4266 "been removed by the administrator.\n\tSufficient "
4267 "replicas exist for the pool to continue functioning in "
4268 "a\n\tdegraded state.\n"));
4269 (void) printf(gettext("action: Online the device using "
4270 "'zpool online' or replace the device with\n\t'zpool "
4274 case ZPOOL_STATUS_RESILVERING
:
4275 (void) printf(gettext("status: One or more devices is "
4276 "currently being resilvered. The pool will\n\tcontinue "
4277 "to function, possibly in a degraded state.\n"));
4278 (void) printf(gettext("action: Wait for the resilver to "
4282 case ZPOOL_STATUS_CORRUPT_DATA
:
4283 (void) printf(gettext("status: One or more devices has "
4284 "experienced an error resulting in data\n\tcorruption. "
4285 "Applications may be affected.\n"));
4286 (void) printf(gettext("action: Restore the file in question "
4287 "if possible. Otherwise restore the\n\tentire pool from "
4291 case ZPOOL_STATUS_CORRUPT_POOL
:
4292 (void) printf(gettext("status: The pool metadata is corrupted "
4293 "and the pool cannot be opened.\n"));
4294 zpool_explain_recover(zpool_get_handle(zhp
),
4295 zpool_get_name(zhp
), reason
, config
);
4298 case ZPOOL_STATUS_VERSION_OLDER
:
4299 (void) printf(gettext("status: The pool is formatted using a "
4300 "legacy on-disk format. The pool can\n\tstill be used, "
4301 "but some features are unavailable.\n"));
4302 (void) printf(gettext("action: Upgrade the pool using 'zpool "
4303 "upgrade'. Once this is done, the\n\tpool will no longer "
4304 "be accessible on software that does not support\n\t"
4305 "feature flags.\n"));
4308 case ZPOOL_STATUS_VERSION_NEWER
:
4309 (void) printf(gettext("status: The pool has been upgraded to a "
4310 "newer, incompatible on-disk version.\n\tThe pool cannot "
4311 "be accessed on this system.\n"));
4312 (void) printf(gettext("action: Access the pool from a system "
4313 "running more recent software, or\n\trestore the pool from "
4317 case ZPOOL_STATUS_FEAT_DISABLED
:
4318 (void) printf(gettext("status: Some supported features are not "
4319 "enabled on the pool. The pool can\n\tstill be used, but "
4320 "some features are unavailable.\n"));
4321 (void) printf(gettext("action: Enable all features using "
4322 "'zpool upgrade'. Once this is done,\n\tthe pool may no "
4323 "longer be accessible by software that does not support\n\t"
4324 "the features. See zpool-features(5) for details.\n"));
4327 case ZPOOL_STATUS_UNSUP_FEAT_READ
:
4328 (void) printf(gettext("status: The pool cannot be accessed on "
4329 "this system because it uses the\n\tfollowing feature(s) "
4330 "not supported on this system:\n"));
4331 zpool_print_unsup_feat(config
);
4332 (void) printf("\n");
4333 (void) printf(gettext("action: Access the pool from a system "
4334 "that supports the required feature(s),\n\tor restore the "
4335 "pool from backup.\n"));
4338 case ZPOOL_STATUS_UNSUP_FEAT_WRITE
:
4339 (void) printf(gettext("status: The pool can only be accessed "
4340 "in read-only mode on this system. It\n\tcannot be "
4341 "accessed in read-write mode because it uses the "
4342 "following\n\tfeature(s) not supported on this system:\n"));
4343 zpool_print_unsup_feat(config
);
4344 (void) printf("\n");
4345 (void) printf(gettext("action: The pool cannot be accessed in "
4346 "read-write mode. Import the pool with\n"
4347 "\t\"-o readonly=on\", access the pool from a system that "
4348 "supports the\n\trequired feature(s), or restore the "
4349 "pool from backup.\n"));
4352 case ZPOOL_STATUS_FAULTED_DEV_R
:
4353 (void) printf(gettext("status: One or more devices are "
4354 "faulted in response to persistent errors.\n\tSufficient "
4355 "replicas exist for the pool to continue functioning "
4356 "in a\n\tdegraded state.\n"));
4357 (void) printf(gettext("action: Replace the faulted device, "
4358 "or use 'zpool clear' to mark the device\n\trepaired.\n"));
4361 case ZPOOL_STATUS_FAULTED_DEV_NR
:
4362 (void) printf(gettext("status: One or more devices are "
4363 "faulted in response to persistent errors. There are "
4364 "insufficient replicas for the pool to\n\tcontinue "
4366 (void) printf(gettext("action: Destroy and re-create the pool "
4367 "from a backup source. Manually marking the device\n"
4368 "\trepaired using 'zpool clear' may allow some data "
4369 "to be recovered.\n"));
4372 case ZPOOL_STATUS_IO_FAILURE_WAIT
:
4373 case ZPOOL_STATUS_IO_FAILURE_CONTINUE
:
4374 (void) printf(gettext("status: One or more devices are "
4375 "faulted in response to IO failures.\n"));
4376 (void) printf(gettext("action: Make sure the affected devices "
4377 "are connected, then run 'zpool clear'.\n"));
4380 case ZPOOL_STATUS_BAD_LOG
:
4381 (void) printf(gettext("status: An intent log record "
4382 "could not be read.\n"
4383 "\tWaiting for adminstrator intervention to fix the "
4384 "faulted pool.\n"));
4385 (void) printf(gettext("action: Either restore the affected "
4386 "device(s) and run 'zpool online',\n"
4387 "\tor ignore the intent log records by running "
4388 "'zpool clear'.\n"));
4391 case ZPOOL_STATUS_ERRATA
:
4392 (void) printf(gettext("status: Errata #%d detected.\n"),
4396 case ZPOOL_ERRATA_NONE
:
4399 case ZPOOL_ERRATA_ZOL_2094_SCRUB
:
4400 (void) printf(gettext("action: To correct the issue "
4401 "run 'zpool scrub'.\n"));
4406 * All errata which allow the pool to be imported
4407 * must contain an action message.
4415 * The remaining errors can't actually be generated, yet.
4417 assert(reason
== ZPOOL_STATUS_OK
);
4421 (void) printf(gettext(" see: http://zfsonlinux.org/msg/%s\n"),
4424 if (config
!= NULL
) {
4427 nvlist_t
**spares
, **l2cache
;
4428 uint_t nspares
, nl2cache
;
4429 pool_scan_stat_t
*ps
= NULL
;
4431 (void) nvlist_lookup_uint64_array(nvroot
,
4432 ZPOOL_CONFIG_SCAN_STATS
, (uint64_t **)&ps
, &c
);
4433 print_scan_status(ps
);
4435 namewidth
= max_width(zhp
, nvroot
, 0, 0);
4439 (void) printf(gettext("config:\n\n"));
4440 (void) printf(gettext("\t%-*s %-8s %5s %5s %5s\n"), namewidth
,
4441 "NAME", "STATE", "READ", "WRITE", "CKSUM");
4442 print_status_config(zhp
, zpool_get_name(zhp
), nvroot
,
4443 namewidth
, 0, B_FALSE
);
4445 if (num_logs(nvroot
) > 0)
4446 print_logs(zhp
, nvroot
, namewidth
, B_TRUE
);
4447 if (nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_L2CACHE
,
4448 &l2cache
, &nl2cache
) == 0)
4449 print_l2cache(zhp
, l2cache
, nl2cache
, namewidth
);
4451 if (nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_SPARES
,
4452 &spares
, &nspares
) == 0)
4453 print_spares(zhp
, spares
, nspares
, namewidth
);
4455 if (nvlist_lookup_uint64(config
, ZPOOL_CONFIG_ERRCOUNT
,
4457 nvlist_t
*nverrlist
= NULL
;
4460 * If the approximate error count is small, get a
4461 * precise count by fetching the entire log and
4462 * uniquifying the results.
4464 if (nerr
> 0 && nerr
< 100 && !cbp
->cb_verbose
&&
4465 zpool_get_errlog(zhp
, &nverrlist
) == 0) {
4470 while ((elem
= nvlist_next_nvpair(nverrlist
,
4475 nvlist_free(nverrlist
);
4477 (void) printf("\n");
4480 (void) printf(gettext("errors: No known data "
4482 else if (!cbp
->cb_verbose
)
4483 (void) printf(gettext("errors: %llu data "
4484 "errors, use '-v' for a list\n"),
4485 (u_longlong_t
)nerr
);
4487 print_error_log(zhp
);
4490 if (cbp
->cb_dedup_stats
)
4491 print_dedup_stats(config
);
4493 (void) printf(gettext("config: The configuration cannot be "
4501 * zpool status [-vx] [-T d|u] [pool] ... [interval [count]]
4503 * -v Display complete error logs
4504 * -x Display only pools with potential problems
4505 * -D Display dedup status (undocumented)
4506 * -T Display a timestamp in date(1) or Unix format
4508 * Describes the health status of all pools or some subset.
4511 zpool_do_status(int argc
, char **argv
)
4515 unsigned long interval
= 0, count
= 0;
4516 status_cbdata_t cb
= { 0 };
4519 while ((c
= getopt(argc
, argv
, "vxDT:")) != -1) {
4522 cb
.cb_verbose
= B_TRUE
;
4525 cb
.cb_explain
= B_TRUE
;
4528 cb
.cb_dedup_stats
= B_TRUE
;
4531 get_timestamp_arg(*optarg
);
4534 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
4543 get_interval_count(&argc
, argv
, &interval
, &count
);
4546 cb
.cb_allpools
= B_TRUE
;
4548 cb
.cb_first
= B_TRUE
;
4551 if (timestamp_fmt
!= NODATE
)
4552 print_timestamp(timestamp_fmt
);
4554 ret
= for_each_pool(argc
, argv
, B_TRUE
, NULL
,
4555 status_callback
, &cb
);
4557 if (argc
== 0 && cb
.cb_count
== 0)
4558 (void) fprintf(stderr
, gettext("no pools available\n"));
4559 else if (cb
.cb_explain
&& cb
.cb_first
&& cb
.cb_allpools
)
4560 (void) printf(gettext("all pools are healthy\n"));
4568 if (count
!= 0 && --count
== 0)
4571 (void) sleep(interval
);
4577 typedef struct upgrade_cbdata
{
4580 uint64_t cb_version
;
4585 upgrade_version(zpool_handle_t
*zhp
, uint64_t version
)
4589 uint64_t oldversion
;
4591 config
= zpool_get_config(zhp
, NULL
);
4592 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_VERSION
,
4595 assert(SPA_VERSION_IS_SUPPORTED(oldversion
));
4596 assert(oldversion
< version
);
4598 ret
= zpool_upgrade(zhp
, version
);
4602 if (version
>= SPA_VERSION_FEATURES
) {
4603 (void) printf(gettext("Successfully upgraded "
4604 "'%s' from version %llu to feature flags.\n"),
4605 zpool_get_name(zhp
), (u_longlong_t
) oldversion
);
4607 (void) printf(gettext("Successfully upgraded "
4608 "'%s' from version %llu to version %llu.\n"),
4609 zpool_get_name(zhp
), (u_longlong_t
) oldversion
,
4610 (u_longlong_t
) version
);
4617 upgrade_enable_all(zpool_handle_t
*zhp
, int *countp
)
4620 boolean_t firstff
= B_TRUE
;
4621 nvlist_t
*enabled
= zpool_get_features(zhp
);
4624 for (i
= 0; i
< SPA_FEATURES
; i
++) {
4625 const char *fname
= spa_feature_table
[i
].fi_uname
;
4626 const char *fguid
= spa_feature_table
[i
].fi_guid
;
4627 if (!nvlist_exists(enabled
, fguid
)) {
4629 verify(-1 != asprintf(&propname
, "feature@%s", fname
));
4630 ret
= zpool_set_prop(zhp
, propname
,
4631 ZFS_FEATURE_ENABLED
);
4639 (void) printf(gettext("Enabled the "
4640 "following features on '%s':\n"),
4641 zpool_get_name(zhp
));
4644 (void) printf(gettext(" %s\n"), fname
);
4655 upgrade_cb(zpool_handle_t
*zhp
, void *arg
)
4657 upgrade_cbdata_t
*cbp
= arg
;
4660 boolean_t printnl
= B_FALSE
;
4663 config
= zpool_get_config(zhp
, NULL
);
4664 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_VERSION
,
4667 assert(SPA_VERSION_IS_SUPPORTED(version
));
4669 if (version
< cbp
->cb_version
) {
4670 cbp
->cb_first
= B_FALSE
;
4671 ret
= upgrade_version(zhp
, cbp
->cb_version
);
4677 * If they did "zpool upgrade -a", then we could
4678 * be doing ioctls to different pools. We need
4679 * to log this history once to each pool, and bypass
4680 * the normal history logging that happens in main().
4682 (void) zpool_log_history(g_zfs
, history_str
);
4683 log_history
= B_FALSE
;
4686 if (cbp
->cb_version
>= SPA_VERSION_FEATURES
) {
4688 ret
= upgrade_enable_all(zhp
, &count
);
4693 cbp
->cb_first
= B_FALSE
;
4699 (void) printf(gettext("\n"));
4706 upgrade_list_older_cb(zpool_handle_t
*zhp
, void *arg
)
4708 upgrade_cbdata_t
*cbp
= arg
;
4712 config
= zpool_get_config(zhp
, NULL
);
4713 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_VERSION
,
4716 assert(SPA_VERSION_IS_SUPPORTED(version
));
4718 if (version
< SPA_VERSION_FEATURES
) {
4719 if (cbp
->cb_first
) {
4720 (void) printf(gettext("The following pools are "
4721 "formatted with legacy version numbers and can\n"
4722 "be upgraded to use feature flags. After "
4723 "being upgraded, these pools\nwill no "
4724 "longer be accessible by software that does not "
4725 "support feature\nflags.\n\n"));
4726 (void) printf(gettext("VER POOL\n"));
4727 (void) printf(gettext("--- ------------\n"));
4728 cbp
->cb_first
= B_FALSE
;
4731 (void) printf("%2llu %s\n", (u_longlong_t
)version
,
4732 zpool_get_name(zhp
));
4739 upgrade_list_disabled_cb(zpool_handle_t
*zhp
, void *arg
)
4741 upgrade_cbdata_t
*cbp
= arg
;
4745 config
= zpool_get_config(zhp
, NULL
);
4746 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_VERSION
,
4749 if (version
>= SPA_VERSION_FEATURES
) {
4751 boolean_t poolfirst
= B_TRUE
;
4752 nvlist_t
*enabled
= zpool_get_features(zhp
);
4754 for (i
= 0; i
< SPA_FEATURES
; i
++) {
4755 const char *fguid
= spa_feature_table
[i
].fi_guid
;
4756 const char *fname
= spa_feature_table
[i
].fi_uname
;
4757 if (!nvlist_exists(enabled
, fguid
)) {
4758 if (cbp
->cb_first
) {
4759 (void) printf(gettext("\nSome "
4760 "supported features are not "
4761 "enabled on the following pools. "
4762 "Once a\nfeature is enabled the "
4763 "pool may become incompatible with "
4764 "software\nthat does not support "
4766 "zpool-features(5) for "
4768 (void) printf(gettext("POOL "
4770 (void) printf(gettext("------"
4772 cbp
->cb_first
= B_FALSE
;
4776 (void) printf(gettext("%s\n"),
4777 zpool_get_name(zhp
));
4778 poolfirst
= B_FALSE
;
4781 (void) printf(gettext(" %s\n"), fname
);
4784 * If they did "zpool upgrade -a", then we could
4785 * be doing ioctls to different pools. We need
4786 * to log this history once to each pool, and bypass
4787 * the normal history logging that happens in main().
4789 (void) zpool_log_history(g_zfs
, history_str
);
4790 log_history
= B_FALSE
;
4799 upgrade_one(zpool_handle_t
*zhp
, void *data
)
4801 boolean_t printnl
= B_FALSE
;
4802 upgrade_cbdata_t
*cbp
= data
;
4803 uint64_t cur_version
;
4806 if (strcmp("log", zpool_get_name(zhp
)) == 0) {
4807 (void) printf(gettext("'log' is now a reserved word\n"
4808 "Pool 'log' must be renamed using export and import"
4813 cur_version
= zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
);
4814 if (cur_version
> cbp
->cb_version
) {
4815 (void) printf(gettext("Pool '%s' is already formatted "
4816 "using more current version '%llu'.\n\n"),
4817 zpool_get_name(zhp
), (u_longlong_t
) cur_version
);
4821 if (cbp
->cb_version
!= SPA_VERSION
&& cur_version
== cbp
->cb_version
) {
4822 (void) printf(gettext("Pool '%s' is already formatted "
4823 "using version %llu.\n\n"), zpool_get_name(zhp
),
4824 (u_longlong_t
) cbp
->cb_version
);
4828 if (cur_version
!= cbp
->cb_version
) {
4830 ret
= upgrade_version(zhp
, cbp
->cb_version
);
4835 if (cbp
->cb_version
>= SPA_VERSION_FEATURES
) {
4837 ret
= upgrade_enable_all(zhp
, &count
);
4843 } else if (cur_version
== SPA_VERSION
) {
4844 (void) printf(gettext("Pool '%s' already has all "
4845 "supported features enabled.\n"),
4846 zpool_get_name(zhp
));
4851 (void) printf(gettext("\n"));
4860 * zpool upgrade [-V version] <-a | pool ...>
4862 * With no arguments, display downrev'd ZFS pool available for upgrade.
4863 * Individual pools can be upgraded by specifying the pool, and '-a' will
4864 * upgrade all pools.
4867 zpool_do_upgrade(int argc
, char **argv
)
4870 upgrade_cbdata_t cb
= { 0 };
4872 boolean_t showversions
= B_FALSE
;
4873 boolean_t upgradeall
= B_FALSE
;
4878 while ((c
= getopt(argc
, argv
, ":avV:")) != -1) {
4881 upgradeall
= B_TRUE
;
4884 showversions
= B_TRUE
;
4887 cb
.cb_version
= strtoll(optarg
, &end
, 10);
4889 !SPA_VERSION_IS_SUPPORTED(cb
.cb_version
)) {
4890 (void) fprintf(stderr
,
4891 gettext("invalid version '%s'\n"), optarg
);
4896 (void) fprintf(stderr
, gettext("missing argument for "
4897 "'%c' option\n"), optopt
);
4901 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
4912 if (cb
.cb_version
== 0) {
4913 cb
.cb_version
= SPA_VERSION
;
4914 } else if (!upgradeall
&& argc
== 0) {
4915 (void) fprintf(stderr
, gettext("-V option is "
4916 "incompatible with other arguments\n"));
4921 if (upgradeall
|| argc
!= 0) {
4922 (void) fprintf(stderr
, gettext("-v option is "
4923 "incompatible with other arguments\n"));
4926 } else if (upgradeall
) {
4928 (void) fprintf(stderr
, gettext("-a option should not "
4929 "be used along with a pool name\n"));
4934 (void) printf(gettext("This system supports ZFS pool feature "
4939 (void) printf(gettext("The following features are "
4941 (void) printf(gettext("FEAT DESCRIPTION\n"));
4942 (void) printf("----------------------------------------------"
4943 "---------------\n");
4944 for (i
= 0; i
< SPA_FEATURES
; i
++) {
4945 zfeature_info_t
*fi
= &spa_feature_table
[i
];
4946 const char *ro
= fi
->fi_can_readonly
?
4947 " (read-only compatible)" : "";
4949 (void) printf("%-37s%s\n", fi
->fi_uname
, ro
);
4950 (void) printf(" %s\n", fi
->fi_desc
);
4952 (void) printf("\n");
4954 (void) printf(gettext("The following legacy versions are also "
4956 (void) printf(gettext("VER DESCRIPTION\n"));
4957 (void) printf("--- -----------------------------------------"
4958 "---------------\n");
4959 (void) printf(gettext(" 1 Initial ZFS version\n"));
4960 (void) printf(gettext(" 2 Ditto blocks "
4961 "(replicated metadata)\n"));
4962 (void) printf(gettext(" 3 Hot spares and double parity "
4964 (void) printf(gettext(" 4 zpool history\n"));
4965 (void) printf(gettext(" 5 Compression using the gzip "
4967 (void) printf(gettext(" 6 bootfs pool property\n"));
4968 (void) printf(gettext(" 7 Separate intent log devices\n"));
4969 (void) printf(gettext(" 8 Delegated administration\n"));
4970 (void) printf(gettext(" 9 refquota and refreservation "
4972 (void) printf(gettext(" 10 Cache devices\n"));
4973 (void) printf(gettext(" 11 Improved scrub performance\n"));
4974 (void) printf(gettext(" 12 Snapshot properties\n"));
4975 (void) printf(gettext(" 13 snapused property\n"));
4976 (void) printf(gettext(" 14 passthrough-x aclinherit\n"));
4977 (void) printf(gettext(" 15 user/group space accounting\n"));
4978 (void) printf(gettext(" 16 stmf property support\n"));
4979 (void) printf(gettext(" 17 Triple-parity RAID-Z\n"));
4980 (void) printf(gettext(" 18 Snapshot user holds\n"));
4981 (void) printf(gettext(" 19 Log device removal\n"));
4982 (void) printf(gettext(" 20 Compression using zle "
4983 "(zero-length encoding)\n"));
4984 (void) printf(gettext(" 21 Deduplication\n"));
4985 (void) printf(gettext(" 22 Received properties\n"));
4986 (void) printf(gettext(" 23 Slim ZIL\n"));
4987 (void) printf(gettext(" 24 System attributes\n"));
4988 (void) printf(gettext(" 25 Improved scrub stats\n"));
4989 (void) printf(gettext(" 26 Improved snapshot deletion "
4991 (void) printf(gettext(" 27 Improved snapshot creation "
4993 (void) printf(gettext(" 28 Multiple vdev replacements\n"));
4994 (void) printf(gettext("\nFor more information on a particular "
4995 "version, including supported releases,\n"));
4996 (void) printf(gettext("see the ZFS Administration Guide.\n\n"));
4997 } else if (argc
== 0 && upgradeall
) {
4998 cb
.cb_first
= B_TRUE
;
4999 ret
= zpool_iter(g_zfs
, upgrade_cb
, &cb
);
5000 if (ret
== 0 && cb
.cb_first
) {
5001 if (cb
.cb_version
== SPA_VERSION
) {
5002 (void) printf(gettext("All pools are already "
5003 "formatted using feature flags.\n\n"));
5004 (void) printf(gettext("Every feature flags "
5005 "pool already has all supported features "
5008 (void) printf(gettext("All pools are already "
5009 "formatted with version %llu or higher.\n"),
5010 (u_longlong_t
) cb
.cb_version
);
5013 } else if (argc
== 0) {
5014 cb
.cb_first
= B_TRUE
;
5015 ret
= zpool_iter(g_zfs
, upgrade_list_older_cb
, &cb
);
5019 (void) printf(gettext("All pools are formatted "
5020 "using feature flags.\n\n"));
5022 (void) printf(gettext("\nUse 'zpool upgrade -v' "
5023 "for a list of available legacy versions.\n"));
5026 cb
.cb_first
= B_TRUE
;
5027 ret
= zpool_iter(g_zfs
, upgrade_list_disabled_cb
, &cb
);
5031 (void) printf(gettext("Every feature flags pool has "
5032 "all supported features enabled.\n"));
5034 (void) printf(gettext("\n"));
5037 ret
= for_each_pool(argc
, argv
, B_FALSE
, NULL
,
5044 typedef struct hist_cbdata
{
5051 * Print out the command history for a specific pool.
5054 get_history_one(zpool_handle_t
*zhp
, void *data
)
5060 hist_cbdata_t
*cb
= (hist_cbdata_t
*)data
;
5062 cb
->first
= B_FALSE
;
5064 (void) printf(gettext("History for '%s':\n"), zpool_get_name(zhp
));
5066 if ((ret
= zpool_get_history(zhp
, &nvhis
)) != 0)
5069 verify(nvlist_lookup_nvlist_array(nvhis
, ZPOOL_HIST_RECORD
,
5070 &records
, &numrecords
) == 0);
5071 for (i
= 0; i
< numrecords
; i
++) {
5072 nvlist_t
*rec
= records
[i
];
5075 if (nvlist_exists(rec
, ZPOOL_HIST_TIME
)) {
5079 tsec
= fnvlist_lookup_uint64(records
[i
],
5081 (void) localtime_r(&tsec
, &t
);
5082 (void) strftime(tbuf
, sizeof (tbuf
), "%F.%T", &t
);
5085 if (nvlist_exists(rec
, ZPOOL_HIST_CMD
)) {
5086 (void) printf("%s %s", tbuf
,
5087 fnvlist_lookup_string(rec
, ZPOOL_HIST_CMD
));
5088 } else if (nvlist_exists(rec
, ZPOOL_HIST_INT_EVENT
)) {
5090 fnvlist_lookup_uint64(rec
, ZPOOL_HIST_INT_EVENT
);
5093 if (ievent
>= ZFS_NUM_LEGACY_HISTORY_EVENTS
) {
5094 (void) printf("%s unrecognized record:\n",
5096 dump_nvlist(rec
, 4);
5099 (void) printf("%s [internal %s txg:%lld] %s", tbuf
,
5100 zfs_history_event_names
[ievent
],
5101 (longlong_t
) fnvlist_lookup_uint64(
5102 rec
, ZPOOL_HIST_TXG
),
5103 fnvlist_lookup_string(rec
, ZPOOL_HIST_INT_STR
));
5104 } else if (nvlist_exists(rec
, ZPOOL_HIST_INT_NAME
)) {
5107 (void) printf("%s [txg:%lld] %s", tbuf
,
5108 (longlong_t
) fnvlist_lookup_uint64(
5109 rec
, ZPOOL_HIST_TXG
),
5110 fnvlist_lookup_string(rec
, ZPOOL_HIST_INT_NAME
));
5111 if (nvlist_exists(rec
, ZPOOL_HIST_DSNAME
)) {
5112 (void) printf(" %s (%llu)",
5113 fnvlist_lookup_string(rec
,
5115 (u_longlong_t
)fnvlist_lookup_uint64(rec
,
5118 (void) printf(" %s", fnvlist_lookup_string(rec
,
5119 ZPOOL_HIST_INT_STR
));
5120 } else if (nvlist_exists(rec
, ZPOOL_HIST_IOCTL
)) {
5123 (void) printf("%s ioctl %s\n", tbuf
,
5124 fnvlist_lookup_string(rec
, ZPOOL_HIST_IOCTL
));
5125 if (nvlist_exists(rec
, ZPOOL_HIST_INPUT_NVL
)) {
5126 (void) printf(" input:\n");
5127 dump_nvlist(fnvlist_lookup_nvlist(rec
,
5128 ZPOOL_HIST_INPUT_NVL
), 8);
5130 if (nvlist_exists(rec
, ZPOOL_HIST_OUTPUT_NVL
)) {
5131 (void) printf(" output:\n");
5132 dump_nvlist(fnvlist_lookup_nvlist(rec
,
5133 ZPOOL_HIST_OUTPUT_NVL
), 8);
5138 (void) printf("%s unrecognized record:\n", tbuf
);
5139 dump_nvlist(rec
, 4);
5143 (void) printf("\n");
5146 (void) printf(" [");
5147 if (nvlist_exists(rec
, ZPOOL_HIST_WHO
)) {
5148 uid_t who
= fnvlist_lookup_uint64(rec
, ZPOOL_HIST_WHO
);
5149 struct passwd
*pwd
= getpwuid(who
);
5150 (void) printf("user %d ", (int)who
);
5152 (void) printf("(%s) ", pwd
->pw_name
);
5154 if (nvlist_exists(rec
, ZPOOL_HIST_HOST
)) {
5155 (void) printf("on %s",
5156 fnvlist_lookup_string(rec
, ZPOOL_HIST_HOST
));
5158 if (nvlist_exists(rec
, ZPOOL_HIST_ZONE
)) {
5159 (void) printf(":%s",
5160 fnvlist_lookup_string(rec
, ZPOOL_HIST_ZONE
));
5164 (void) printf("\n");
5166 (void) printf("\n");
5173 * zpool history <pool>
5175 * Displays the history of commands that modified pools.
5178 zpool_do_history(int argc
, char **argv
)
5180 hist_cbdata_t cbdata
= { 0 };
5184 cbdata
.first
= B_TRUE
;
5186 while ((c
= getopt(argc
, argv
, "li")) != -1) {
5189 cbdata
.longfmt
= B_TRUE
;
5192 cbdata
.internal
= B_TRUE
;
5195 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
5203 ret
= for_each_pool(argc
, argv
, B_FALSE
, NULL
, get_history_one
,
5206 if (argc
== 0 && cbdata
.first
== B_TRUE
) {
5207 (void) fprintf(stderr
, gettext("no pools available\n"));
5214 typedef struct ev_opts
{
5222 zpool_do_events_short(nvlist_t
*nvl
)
5224 char ctime_str
[26], str
[32], *ptr
;
5228 verify(nvlist_lookup_int64_array(nvl
, FM_EREPORT_TIME
, &tv
, &n
) == 0);
5229 memset(str
, ' ', 32);
5230 (void) ctime_r((const time_t *)&tv
[0], ctime_str
);
5231 (void) strncpy(str
, ctime_str
+4, 6); /* 'Jun 30' */
5232 (void) strncpy(str
+7, ctime_str
+20, 4); /* '1993' */
5233 (void) strncpy(str
+12, ctime_str
+11, 8); /* '21:49:08' */
5234 (void) sprintf(str
+20, ".%09lld", (longlong_t
)tv
[1]); /* '.123456789' */
5235 (void) printf(gettext("%s "), str
);
5237 verify(nvlist_lookup_string(nvl
, FM_CLASS
, &ptr
) == 0);
5238 (void) printf(gettext("%s\n"), ptr
);
5242 zpool_do_events_nvprint(nvlist_t
*nvl
, int depth
)
5246 for (nvp
= nvlist_next_nvpair(nvl
, NULL
);
5247 nvp
!= NULL
; nvp
= nvlist_next_nvpair(nvl
, nvp
)) {
5249 data_type_t type
= nvpair_type(nvp
);
5250 const char *name
= nvpair_name(nvp
);
5260 printf(gettext("%*s%s = "), depth
, "", name
);
5263 case DATA_TYPE_BOOLEAN
:
5264 printf(gettext("%s"), "1");
5267 case DATA_TYPE_BOOLEAN_VALUE
:
5268 (void) nvpair_value_boolean_value(nvp
, &b
);
5269 printf(gettext("%s"), b
? "1" : "0");
5272 case DATA_TYPE_BYTE
:
5273 (void) nvpair_value_byte(nvp
, &i8
);
5274 printf(gettext("0x%x"), i8
);
5277 case DATA_TYPE_INT8
:
5278 (void) nvpair_value_int8(nvp
, (void *)&i8
);
5279 printf(gettext("0x%x"), i8
);
5282 case DATA_TYPE_UINT8
:
5283 (void) nvpair_value_uint8(nvp
, &i8
);
5284 printf(gettext("0x%x"), i8
);
5287 case DATA_TYPE_INT16
:
5288 (void) nvpair_value_int16(nvp
, (void *)&i16
);
5289 printf(gettext("0x%x"), i16
);
5292 case DATA_TYPE_UINT16
:
5293 (void) nvpair_value_uint16(nvp
, &i16
);
5294 printf(gettext("0x%x"), i16
);
5297 case DATA_TYPE_INT32
:
5298 (void) nvpair_value_int32(nvp
, (void *)&i32
);
5299 printf(gettext("0x%x"), i32
);
5302 case DATA_TYPE_UINT32
:
5303 (void) nvpair_value_uint32(nvp
, &i32
);
5304 printf(gettext("0x%x"), i32
);
5307 case DATA_TYPE_INT64
:
5308 (void) nvpair_value_int64(nvp
, (void *)&i64
);
5309 printf(gettext("0x%llx"), (u_longlong_t
)i64
);
5312 case DATA_TYPE_UINT64
:
5313 (void) nvpair_value_uint64(nvp
, &i64
);
5314 printf(gettext("0x%llx"), (u_longlong_t
)i64
);
5317 case DATA_TYPE_HRTIME
:
5318 (void) nvpair_value_hrtime(nvp
, (void *)&i64
);
5319 printf(gettext("0x%llx"), (u_longlong_t
)i64
);
5322 case DATA_TYPE_STRING
:
5323 (void) nvpair_value_string(nvp
, &str
);
5324 printf(gettext("\"%s\""), str
? str
: "<NULL>");
5327 case DATA_TYPE_NVLIST
:
5328 printf(gettext("(embedded nvlist)\n"));
5329 (void) nvpair_value_nvlist(nvp
, &cnv
);
5330 zpool_do_events_nvprint(cnv
, depth
+ 8);
5331 printf(gettext("%*s(end %s)"), depth
, "", name
);
5334 case DATA_TYPE_NVLIST_ARRAY
: {
5338 (void) nvpair_value_nvlist_array(nvp
, &val
, &nelem
);
5339 printf(gettext("(%d embedded nvlists)\n"), nelem
);
5340 for (i
= 0; i
< nelem
; i
++) {
5341 printf(gettext("%*s%s[%d] = %s\n"),
5342 depth
, "", name
, i
, "(embedded nvlist)");
5343 zpool_do_events_nvprint(val
[i
], depth
+ 8);
5344 printf(gettext("%*s(end %s[%i])\n"),
5345 depth
, "", name
, i
);
5347 printf(gettext("%*s(end %s)\n"), depth
, "", name
);
5351 case DATA_TYPE_INT8_ARRAY
: {
5355 (void) nvpair_value_int8_array(nvp
, &val
, &nelem
);
5356 for (i
= 0; i
< nelem
; i
++)
5357 printf(gettext("0x%x "), val
[i
]);
5362 case DATA_TYPE_UINT8_ARRAY
: {
5366 (void) nvpair_value_uint8_array(nvp
, &val
, &nelem
);
5367 for (i
= 0; i
< nelem
; i
++)
5368 printf(gettext("0x%x "), val
[i
]);
5373 case DATA_TYPE_INT16_ARRAY
: {
5377 (void) nvpair_value_int16_array(nvp
, &val
, &nelem
);
5378 for (i
= 0; i
< nelem
; i
++)
5379 printf(gettext("0x%x "), val
[i
]);
5384 case DATA_TYPE_UINT16_ARRAY
: {
5388 (void) nvpair_value_uint16_array(nvp
, &val
, &nelem
);
5389 for (i
= 0; i
< nelem
; i
++)
5390 printf(gettext("0x%x "), val
[i
]);
5395 case DATA_TYPE_INT32_ARRAY
: {
5399 (void) nvpair_value_int32_array(nvp
, &val
, &nelem
);
5400 for (i
= 0; i
< nelem
; i
++)
5401 printf(gettext("0x%x "), val
[i
]);
5406 case DATA_TYPE_UINT32_ARRAY
: {
5410 (void) nvpair_value_uint32_array(nvp
, &val
, &nelem
);
5411 for (i
= 0; i
< nelem
; i
++)
5412 printf(gettext("0x%x "), val
[i
]);
5417 case DATA_TYPE_INT64_ARRAY
: {
5421 (void) nvpair_value_int64_array(nvp
, &val
, &nelem
);
5422 for (i
= 0; i
< nelem
; i
++)
5423 printf(gettext("0x%llx "),
5424 (u_longlong_t
)val
[i
]);
5429 case DATA_TYPE_UINT64_ARRAY
: {
5433 (void) nvpair_value_uint64_array(nvp
, &val
, &nelem
);
5434 for (i
= 0; i
< nelem
; i
++)
5435 printf(gettext("0x%llx "),
5436 (u_longlong_t
)val
[i
]);
5441 case DATA_TYPE_STRING_ARRAY
:
5442 case DATA_TYPE_BOOLEAN_ARRAY
:
5443 case DATA_TYPE_BYTE_ARRAY
:
5444 case DATA_TYPE_DOUBLE
:
5445 case DATA_TYPE_UNKNOWN
:
5446 printf(gettext("<unknown>"));
5450 printf(gettext("\n"));
5455 zpool_do_events_next(ev_opts_t
*opts
)
5458 int zevent_fd
, ret
, dropped
;
5460 zevent_fd
= open(ZFS_DEV
, O_RDWR
);
5461 VERIFY(zevent_fd
>= 0);
5463 if (!opts
->scripted
)
5464 (void) printf(gettext("%-30s %s\n"), "TIME", "CLASS");
5467 ret
= zpool_events_next(g_zfs
, &nvl
, &dropped
,
5468 !!opts
->follow
, zevent_fd
);
5469 if (ret
|| nvl
== NULL
)
5473 (void) printf(gettext("dropped %d events\n"), dropped
);
5475 zpool_do_events_short(nvl
);
5477 if (opts
->verbose
) {
5478 zpool_do_events_nvprint(nvl
, 8);
5479 printf(gettext("\n"));
5481 (void) fflush(stdout
);
5486 VERIFY(0 == close(zevent_fd
));
5492 zpool_do_events_clear(ev_opts_t
*opts
)
5496 ret
= zpool_events_clear(g_zfs
, &count
);
5498 (void) printf(gettext("cleared %d events\n"), count
);
5504 * zpool events [-vfc]
5506 * Displays events logs by ZFS.
5509 zpool_do_events(int argc
, char **argv
)
5511 ev_opts_t opts
= { 0 };
5516 while ((c
= getopt(argc
, argv
, "vHfc")) != -1) {
5531 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
5540 ret
= zpool_do_events_clear(&opts
);
5542 ret
= zpool_do_events_next(&opts
);
5548 get_callback(zpool_handle_t
*zhp
, void *data
)
5550 zprop_get_cbdata_t
*cbp
= (zprop_get_cbdata_t
*)data
;
5551 char value
[MAXNAMELEN
];
5552 zprop_source_t srctype
;
5555 for (pl
= cbp
->cb_proplist
; pl
!= NULL
; pl
= pl
->pl_next
) {
5558 * Skip the special fake placeholder. This will also skip
5559 * over the name property when 'all' is specified.
5561 if (pl
->pl_prop
== ZPOOL_PROP_NAME
&&
5562 pl
== cbp
->cb_proplist
)
5565 if (pl
->pl_prop
== ZPROP_INVAL
&&
5566 (zpool_prop_feature(pl
->pl_user_prop
) ||
5567 zpool_prop_unsupported(pl
->pl_user_prop
))) {
5568 srctype
= ZPROP_SRC_LOCAL
;
5570 if (zpool_prop_get_feature(zhp
, pl
->pl_user_prop
,
5571 value
, sizeof (value
)) == 0) {
5572 zprop_print_one_property(zpool_get_name(zhp
),
5573 cbp
, pl
->pl_user_prop
, value
, srctype
,
5577 if (zpool_get_prop_literal(zhp
, pl
->pl_prop
, value
,
5578 sizeof (value
), &srctype
, cbp
->cb_literal
) != 0)
5581 zprop_print_one_property(zpool_get_name(zhp
), cbp
,
5582 zpool_prop_to_name(pl
->pl_prop
), value
, srctype
,
5590 zpool_do_get(int argc
, char **argv
)
5592 zprop_get_cbdata_t cb
= { 0 };
5593 zprop_list_t fake_name
= { 0 };
5597 while ((c
= getopt(argc
, argv
, "p")) != -1) {
5600 cb
.cb_literal
= B_TRUE
;
5604 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
5614 (void) fprintf(stderr
, gettext("missing property "
5619 cb
.cb_first
= B_TRUE
;
5620 cb
.cb_sources
= ZPROP_SRC_ALL
;
5621 cb
.cb_columns
[0] = GET_COL_NAME
;
5622 cb
.cb_columns
[1] = GET_COL_PROPERTY
;
5623 cb
.cb_columns
[2] = GET_COL_VALUE
;
5624 cb
.cb_columns
[3] = GET_COL_SOURCE
;
5625 cb
.cb_type
= ZFS_TYPE_POOL
;
5627 if (zprop_get_list(g_zfs
, argv
[0], &cb
.cb_proplist
, ZFS_TYPE_POOL
) != 0)
5633 if (cb
.cb_proplist
!= NULL
) {
5634 fake_name
.pl_prop
= ZPOOL_PROP_NAME
;
5635 fake_name
.pl_width
= strlen(gettext("NAME"));
5636 fake_name
.pl_next
= cb
.cb_proplist
;
5637 cb
.cb_proplist
= &fake_name
;
5640 ret
= for_each_pool(argc
, argv
, B_TRUE
, &cb
.cb_proplist
,
5643 if (cb
.cb_proplist
== &fake_name
)
5644 zprop_free_list(fake_name
.pl_next
);
5646 zprop_free_list(cb
.cb_proplist
);
5651 typedef struct set_cbdata
{
5654 boolean_t cb_any_successful
;
5658 set_callback(zpool_handle_t
*zhp
, void *data
)
5661 set_cbdata_t
*cb
= (set_cbdata_t
*)data
;
5663 error
= zpool_set_prop(zhp
, cb
->cb_propname
, cb
->cb_value
);
5666 cb
->cb_any_successful
= B_TRUE
;
5672 zpool_do_set(int argc
, char **argv
)
5674 set_cbdata_t cb
= { 0 };
5677 if (argc
> 1 && argv
[1][0] == '-') {
5678 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
5684 (void) fprintf(stderr
, gettext("missing property=value "
5690 (void) fprintf(stderr
, gettext("missing pool name\n"));
5695 (void) fprintf(stderr
, gettext("too many pool names\n"));
5699 cb
.cb_propname
= argv
[1];
5700 cb
.cb_value
= strchr(cb
.cb_propname
, '=');
5701 if (cb
.cb_value
== NULL
) {
5702 (void) fprintf(stderr
, gettext("missing value in "
5703 "property=value argument\n"));
5707 *(cb
.cb_value
) = '\0';
5710 error
= for_each_pool(argc
- 2, argv
+ 2, B_TRUE
, NULL
,
5717 find_command_idx(char *command
, int *idx
)
5721 for (i
= 0; i
< NCOMMAND
; i
++) {
5722 if (command_table
[i
].name
== NULL
)
5725 if (strcmp(command
, command_table
[i
].name
) == 0) {
5734 main(int argc
, char **argv
)
5740 (void) setlocale(LC_ALL
, "");
5741 (void) textdomain(TEXT_DOMAIN
);
5746 * Make sure the user has specified some command.
5749 (void) fprintf(stderr
, gettext("missing command\n"));
5758 if ((strcmp(cmdname
, "-?") == 0) || strcmp(cmdname
, "--help") == 0)
5761 if ((g_zfs
= libzfs_init()) == NULL
)
5764 libzfs_print_on_error(g_zfs
, B_TRUE
);
5766 zfs_save_arguments(argc
, argv
, history_str
, sizeof (history_str
));
5769 * Run the appropriate command.
5771 if (find_command_idx(cmdname
, &i
) == 0) {
5772 current_command
= &command_table
[i
];
5773 ret
= command_table
[i
].func(argc
- 1, argv
+ 1);
5774 } else if (strchr(cmdname
, '=')) {
5775 verify(find_command_idx("set", &i
) == 0);
5776 current_command
= &command_table
[i
];
5777 ret
= command_table
[i
].func(argc
, argv
);
5778 } else if (strcmp(cmdname
, "freeze") == 0 && argc
== 3) {
5780 * 'freeze' is a vile debugging abomination, so we treat
5784 int fd
= open(ZFS_DEV
, O_RDWR
);
5785 (void) strcpy((void *)buf
, argv
[2]);
5786 return (!!ioctl(fd
, ZFS_IOC_POOL_FREEZE
, buf
));
5788 (void) fprintf(stderr
, gettext("unrecognized "
5789 "command '%s'\n"), cmdname
);
5794 if (ret
== 0 && log_history
)
5795 (void) zpool_log_history(g_zfs
, history_str
);
5800 * The 'ZFS_ABORT' environment variable causes us to dump core on exit
5801 * for the purposes of running ::findleaks.
5803 if (getenv("ZFS_ABORT") != NULL
) {
5804 (void) printf("dumping core by request\n");