4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
25 * Copyright (c) 2011 by Delphix. All rights reserved.
26 * Copyright (c) 2012 by Frederik Wessels. All rights reserved.
46 #include <sys/fs/zfs.h>
48 #include <sys/fm/util.h>
49 #include <sys/fm/protocol.h>
53 #include "zpool_util.h"
54 #include "zfs_comutil.h"
56 #include "statcommon.h"
58 static int zpool_do_create(int, char **);
59 static int zpool_do_destroy(int, char **);
61 static int zpool_do_add(int, char **);
62 static int zpool_do_remove(int, char **);
64 static int zpool_do_list(int, char **);
65 static int zpool_do_iostat(int, char **);
66 static int zpool_do_status(int, char **);
68 static int zpool_do_online(int, char **);
69 static int zpool_do_offline(int, char **);
70 static int zpool_do_clear(int, char **);
72 static int zpool_do_reguid(int, char **);
74 static int zpool_do_attach(int, char **);
75 static int zpool_do_detach(int, char **);
76 static int zpool_do_replace(int, char **);
77 static int zpool_do_split(int, char **);
79 static int zpool_do_scrub(int, char **);
81 static int zpool_do_import(int, char **);
82 static int zpool_do_export(int, char **);
84 static int zpool_do_upgrade(int, char **);
86 static int zpool_do_history(int, char **);
87 static int zpool_do_events(int, char **);
89 static int zpool_do_get(int, char **);
90 static int zpool_do_set(int, char **);
93 * These libumem hooks provide a reasonable set of defaults for the allocator's
94 * debugging facilities.
99 _umem_debug_init(void)
101 return ("default,verbose"); /* $UMEM_DEBUG setting */
105 _umem_logging_init(void)
107 return ("fail,contents"); /* $UMEM_LOGGING setting */
138 typedef struct zpool_command
{
140 int (*func
)(int, char **);
145 * Master command table. Each ZFS command has a name, associated function, and
146 * usage message. The usage messages need to be internationalized, so we have
147 * to have a function to return the usage message based on a command index.
149 * These commands are organized according to how they are displayed in the usage
150 * message. An empty command (one with a NULL name) indicates an empty line in
151 * the generic usage message.
153 static zpool_command_t command_table
[] = {
154 { "create", zpool_do_create
, HELP_CREATE
},
155 { "destroy", zpool_do_destroy
, HELP_DESTROY
},
157 { "add", zpool_do_add
, HELP_ADD
},
158 { "remove", zpool_do_remove
, HELP_REMOVE
},
160 { "list", zpool_do_list
, HELP_LIST
},
161 { "iostat", zpool_do_iostat
, HELP_IOSTAT
},
162 { "status", zpool_do_status
, HELP_STATUS
},
164 { "online", zpool_do_online
, HELP_ONLINE
},
165 { "offline", zpool_do_offline
, HELP_OFFLINE
},
166 { "clear", zpool_do_clear
, HELP_CLEAR
},
168 { "attach", zpool_do_attach
, HELP_ATTACH
},
169 { "detach", zpool_do_detach
, HELP_DETACH
},
170 { "replace", zpool_do_replace
, HELP_REPLACE
},
171 { "split", zpool_do_split
, HELP_SPLIT
},
173 { "scrub", zpool_do_scrub
, HELP_SCRUB
},
175 { "import", zpool_do_import
, HELP_IMPORT
},
176 { "export", zpool_do_export
, HELP_EXPORT
},
177 { "upgrade", zpool_do_upgrade
, HELP_UPGRADE
},
178 { "reguid", zpool_do_reguid
, HELP_REGUID
},
180 { "history", zpool_do_history
, HELP_HISTORY
},
181 { "events", zpool_do_events
, HELP_EVENTS
},
183 { "get", zpool_do_get
, HELP_GET
},
184 { "set", zpool_do_set
, HELP_SET
},
187 #define NCOMMAND (sizeof (command_table) / sizeof (command_table[0]))
189 zpool_command_t
*current_command
;
190 static char history_str
[HIS_MAX_RECORD_LEN
];
192 static uint_t timestamp_fmt
= NODATE
;
195 get_usage(zpool_help_t idx
) {
198 return (gettext("\tadd [-fn] <pool> <vdev> ...\n"));
200 return (gettext("\tattach [-f] <pool> <device> "
203 return (gettext("\tclear [-nF] <pool> [device]\n"));
205 return (gettext("\tcreate [-fn] [-o property=value] ... \n"
206 "\t [-O file-system-property=value] ... \n"
207 "\t [-m mountpoint] [-R root] <pool> <vdev> ...\n"));
209 return (gettext("\tdestroy [-f] <pool>\n"));
211 return (gettext("\tdetach <pool> <device>\n"));
213 return (gettext("\texport [-f] <pool> ...\n"));
215 return (gettext("\thistory [-il] [<pool>] ...\n"));
217 return (gettext("\timport [-d dir] [-D]\n"
218 "\timport [-d dir | -c cachefile] [-F [-n]] <pool | id>\n"
219 "\timport [-o mntopts] [-o property=value] ... \n"
220 "\t [-d dir | -c cachefile] [-D] [-f] [-m] [-N] "
221 "[-R root] [-F [-n]] -a\n"
222 "\timport [-o mntopts] [-o property=value] ... \n"
223 "\t [-d dir | -c cachefile] [-D] [-f] [-m] [-N] "
224 "[-R root] [-F [-n]]\n"
225 "\t <pool | id> [newpool]\n"));
227 return (gettext("\tiostat [-v] [-T d|u] [pool] ... [interval "
230 return (gettext("\tlist [-H] [-o property[,...]] "
231 "[-T d|u] [pool] ... [interval [count]]\n"));
233 return (gettext("\toffline [-t] <pool> <device> ...\n"));
235 return (gettext("\tonline <pool> <device> ...\n"));
237 return (gettext("\treplace [-f] <pool> <device> "
240 return (gettext("\tremove <pool> <device> ...\n"));
242 return (gettext("\tscrub [-s] <pool> ...\n"));
244 return (gettext("\tstatus [-vx] [-T d|u] [pool] ... [interval "
247 return (gettext("\tupgrade\n"
249 "\tupgrade [-V version] <-a | pool ...>\n"));
251 return (gettext("\tevents [-vHfc]\n"));
253 return (gettext("\tget <\"all\" | property[,...]> "
256 return (gettext("\tset <property=value> <pool> \n"));
258 return (gettext("\tsplit [-n] [-R altroot] [-o mntopts]\n"
259 "\t [-o property=value] <pool> <newpool> "
260 "[<device> ...]\n"));
262 return (gettext("\treguid <pool>\n"));
271 * Callback routine that will print out a pool property value.
274 print_prop_cb(int prop
, void *cb
)
278 (void) fprintf(fp
, "\t%-15s ", zpool_prop_to_name(prop
));
280 if (zpool_prop_readonly(prop
))
281 (void) fprintf(fp
, " NO ");
283 (void) fprintf(fp
, " YES ");
285 if (zpool_prop_values(prop
) == NULL
)
286 (void) fprintf(fp
, "-\n");
288 (void) fprintf(fp
, "%s\n", zpool_prop_values(prop
));
294 * Display usage message. If we're inside a command, display only the usage for
295 * that command. Otherwise, iterate over the entire command table and display
296 * a complete usage message.
299 usage(boolean_t requested
)
301 FILE *fp
= requested
? stdout
: stderr
;
303 if (current_command
== NULL
) {
306 (void) fprintf(fp
, gettext("usage: zpool command args ...\n"));
308 gettext("where 'command' is one of the following:\n\n"));
310 for (i
= 0; i
< NCOMMAND
; i
++) {
311 if (command_table
[i
].name
== NULL
)
312 (void) fprintf(fp
, "\n");
314 (void) fprintf(fp
, "%s",
315 get_usage(command_table
[i
].usage
));
318 (void) fprintf(fp
, gettext("usage:\n"));
319 (void) fprintf(fp
, "%s", get_usage(current_command
->usage
));
322 if (current_command
!= NULL
&&
323 ((strcmp(current_command
->name
, "set") == 0) ||
324 (strcmp(current_command
->name
, "get") == 0) ||
325 (strcmp(current_command
->name
, "list") == 0))) {
328 gettext("\nthe following properties are supported:\n"));
330 (void) fprintf(fp
, "\n\t%-15s %s %s\n\n",
331 "PROPERTY", "EDIT", "VALUES");
333 /* Iterate over all properties */
334 (void) zprop_iter(print_prop_cb
, fp
, B_FALSE
, B_TRUE
,
339 * See comments at end of main().
341 if (getenv("ZFS_ABORT") != NULL
) {
342 (void) printf("dumping core by request\n");
346 exit(requested
? 0 : 2);
350 print_vdev_tree(zpool_handle_t
*zhp
, const char *name
, nvlist_t
*nv
, int indent
,
351 boolean_t print_logs
)
358 (void) printf("\t%*s%s\n", indent
, "", name
);
360 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
361 &child
, &children
) != 0)
364 for (c
= 0; c
< children
; c
++) {
365 uint64_t is_log
= B_FALSE
;
367 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_LOG
,
369 if ((is_log
&& !print_logs
) || (!is_log
&& print_logs
))
372 vname
= zpool_vdev_name(g_zfs
, zhp
, child
[c
], B_FALSE
);
373 print_vdev_tree(zhp
, vname
, child
[c
], indent
+ 2,
380 * Add a property pair (name, string-value) into a property nvlist.
383 add_prop_list(const char *propname
, char *propval
, nvlist_t
**props
,
386 zpool_prop_t prop
= ZPROP_INVAL
;
392 if (*props
== NULL
&&
393 nvlist_alloc(props
, NV_UNIQUE_NAME
, 0) != 0) {
394 (void) fprintf(stderr
,
395 gettext("internal error: out of memory\n"));
402 if ((prop
= zpool_name_to_prop(propname
)) == ZPROP_INVAL
) {
403 (void) fprintf(stderr
, gettext("property '%s' is "
404 "not a valid pool property\n"), propname
);
407 normnm
= zpool_prop_to_name(prop
);
409 if ((fprop
= zfs_name_to_prop(propname
)) != ZPROP_INVAL
) {
410 normnm
= zfs_prop_to_name(fprop
);
416 if (nvlist_lookup_string(proplist
, normnm
, &strval
) == 0 &&
417 prop
!= ZPOOL_PROP_CACHEFILE
) {
418 (void) fprintf(stderr
, gettext("property '%s' "
419 "specified multiple times\n"), propname
);
423 if (nvlist_add_string(proplist
, normnm
, propval
) != 0) {
424 (void) fprintf(stderr
, gettext("internal "
425 "error: out of memory\n"));
433 * zpool add [-fn] <pool> <vdev> ...
435 * -f Force addition of devices, even if they appear in use
436 * -n Do not add the devices, but display the resulting layout if
437 * they were to be added.
439 * Adds the given vdevs to 'pool'. As with create, the bulk of this work is
440 * handled by get_vdev_spec(), which constructs the nvlist needed to pass to
444 zpool_do_add(int argc
, char **argv
)
446 boolean_t force
= B_FALSE
;
447 boolean_t dryrun
= B_FALSE
;
456 while ((c
= getopt(argc
, argv
, "fn")) != -1) {
465 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
474 /* get pool name and check number of arguments */
476 (void) fprintf(stderr
, gettext("missing pool name argument\n"));
480 (void) fprintf(stderr
, gettext("missing vdev specification\n"));
489 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
492 if ((config
= zpool_get_config(zhp
, NULL
)) == NULL
) {
493 (void) fprintf(stderr
, gettext("pool '%s' is unavailable\n"),
499 /* pass off to get_vdev_spec for processing */
500 nvroot
= make_root_vdev(zhp
, NULL
, force
, !force
, B_FALSE
, dryrun
,
502 if (nvroot
== NULL
) {
508 nvlist_t
*poolnvroot
;
510 verify(nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
513 (void) printf(gettext("would update '%s' to the following "
514 "configuration:\n"), zpool_get_name(zhp
));
516 /* print original main pool and new tree */
517 print_vdev_tree(zhp
, poolname
, poolnvroot
, 0, B_FALSE
);
518 print_vdev_tree(zhp
, NULL
, nvroot
, 0, B_FALSE
);
520 /* Do the same for the logs */
521 if (num_logs(poolnvroot
) > 0) {
522 print_vdev_tree(zhp
, "logs", poolnvroot
, 0, B_TRUE
);
523 print_vdev_tree(zhp
, NULL
, nvroot
, 0, B_TRUE
);
524 } else if (num_logs(nvroot
) > 0) {
525 print_vdev_tree(zhp
, "logs", nvroot
, 0, B_TRUE
);
530 ret
= (zpool_add(zhp
, nvroot
) != 0);
540 * zpool remove <pool> <vdev> ...
542 * Removes the given vdev from the pool. Currently, this supports removing
543 * spares, cache, and log devices from the pool.
546 zpool_do_remove(int argc
, char **argv
)
555 /* get pool name and check number of arguments */
557 (void) fprintf(stderr
, gettext("missing pool name argument\n"));
561 (void) fprintf(stderr
, gettext("missing device\n"));
567 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
570 for (i
= 1; i
< argc
; i
++) {
571 if (zpool_vdev_remove(zhp
, argv
[i
]) != 0)
579 * zpool create [-fn] [-o property=value] ...
580 * [-O file-system-property=value] ...
581 * [-R root] [-m mountpoint] <pool> <dev> ...
583 * -f Force creation, even if devices appear in use
584 * -n Do not create the pool, but display the resulting layout if it
585 * were to be created.
586 * -R Create a pool under an alternate root
587 * -m Set default mountpoint for the root dataset. By default it's
589 * -o Set property=value.
590 * -O Set fsproperty=value in the pool's root file system
592 * Creates the named pool according to the given vdev specification. The
593 * bulk of the vdev processing is done in get_vdev_spec() in zpool_vdev.c. Once
594 * we get the nvlist back from get_vdev_spec(), we either print out the contents
595 * (if '-n' was specified), or pass it to libzfs to do the creation.
598 zpool_do_create(int argc
, char **argv
)
600 boolean_t force
= B_FALSE
;
601 boolean_t dryrun
= B_FALSE
;
603 nvlist_t
*nvroot
= NULL
;
606 char *altroot
= NULL
;
607 char *mountpoint
= NULL
;
608 nvlist_t
*fsprops
= NULL
;
609 nvlist_t
*props
= NULL
;
613 while ((c
= getopt(argc
, argv
, ":fnR:m:o:O:")) != -1) {
623 if (add_prop_list(zpool_prop_to_name(
624 ZPOOL_PROP_ALTROOT
), optarg
, &props
, B_TRUE
))
626 if (nvlist_lookup_string(props
,
627 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE
),
630 if (add_prop_list(zpool_prop_to_name(
631 ZPOOL_PROP_CACHEFILE
), "none", &props
, B_TRUE
))
638 if ((propval
= strchr(optarg
, '=')) == NULL
) {
639 (void) fprintf(stderr
, gettext("missing "
640 "'=' for -o option\n"));
646 if (add_prop_list(optarg
, propval
, &props
, B_TRUE
))
650 if ((propval
= strchr(optarg
, '=')) == NULL
) {
651 (void) fprintf(stderr
, gettext("missing "
652 "'=' for -O option\n"));
658 if (add_prop_list(optarg
, propval
, &fsprops
, B_FALSE
))
662 (void) fprintf(stderr
, gettext("missing argument for "
663 "'%c' option\n"), optopt
);
666 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
675 /* get pool name and check number of arguments */
677 (void) fprintf(stderr
, gettext("missing pool name argument\n"));
681 (void) fprintf(stderr
, gettext("missing vdev specification\n"));
688 * As a special case, check for use of '/' in the name, and direct the
689 * user to use 'zfs create' instead.
691 if (strchr(poolname
, '/') != NULL
) {
692 (void) fprintf(stderr
, gettext("cannot create '%s': invalid "
693 "character '/' in pool name\n"), poolname
);
694 (void) fprintf(stderr
, gettext("use 'zfs create' to "
695 "create a dataset\n"));
699 /* pass off to get_vdev_spec for bulk processing */
700 nvroot
= make_root_vdev(NULL
, props
, force
, !force
, B_FALSE
, dryrun
,
705 /* make_root_vdev() allows 0 toplevel children if there are spares */
706 if (!zfs_allocatable_devs(nvroot
)) {
707 (void) fprintf(stderr
, gettext("invalid vdev "
708 "specification: at least one toplevel vdev must be "
714 if (altroot
!= NULL
&& altroot
[0] != '/') {
715 (void) fprintf(stderr
, gettext("invalid alternate root '%s': "
716 "must be an absolute path\n"), altroot
);
721 * Check the validity of the mountpoint and direct the user to use the
722 * '-m' mountpoint option if it looks like its in use.
724 if (mountpoint
== NULL
||
725 (strcmp(mountpoint
, ZFS_MOUNTPOINT_LEGACY
) != 0 &&
726 strcmp(mountpoint
, ZFS_MOUNTPOINT_NONE
) != 0)) {
727 char buf
[MAXPATHLEN
];
730 if (mountpoint
&& mountpoint
[0] != '/') {
731 (void) fprintf(stderr
, gettext("invalid mountpoint "
732 "'%s': must be an absolute path, 'legacy', or "
733 "'none'\n"), mountpoint
);
737 if (mountpoint
== NULL
) {
739 (void) snprintf(buf
, sizeof (buf
), "%s/%s",
742 (void) snprintf(buf
, sizeof (buf
), "/%s",
746 (void) snprintf(buf
, sizeof (buf
), "%s%s",
747 altroot
, mountpoint
);
749 (void) snprintf(buf
, sizeof (buf
), "%s",
753 if ((dirp
= opendir(buf
)) == NULL
&& errno
!= ENOENT
) {
754 (void) fprintf(stderr
, gettext("mountpoint '%s' : "
755 "%s\n"), buf
, strerror(errno
));
756 (void) fprintf(stderr
, gettext("use '-m' "
757 "option to provide a different default\n"));
762 while (count
< 3 && readdir(dirp
) != NULL
)
764 (void) closedir(dirp
);
767 (void) fprintf(stderr
, gettext("mountpoint "
768 "'%s' exists and is not empty\n"), buf
);
769 (void) fprintf(stderr
, gettext("use '-m' "
770 "option to provide a "
771 "different default\n"));
779 * For a dry run invocation, print out a basic message and run
780 * through all the vdevs in the list and print out in an
781 * appropriate hierarchy.
783 (void) printf(gettext("would create '%s' with the "
784 "following layout:\n\n"), poolname
);
786 print_vdev_tree(NULL
, poolname
, nvroot
, 0, B_FALSE
);
787 if (num_logs(nvroot
) > 0)
788 print_vdev_tree(NULL
, "logs", nvroot
, 0, B_TRUE
);
793 * Hand off to libzfs.
795 if (zpool_create(g_zfs
, poolname
,
796 nvroot
, props
, fsprops
) == 0) {
797 zfs_handle_t
*pool
= zfs_open(g_zfs
, poolname
,
798 ZFS_TYPE_FILESYSTEM
);
800 if (mountpoint
!= NULL
)
801 verify(zfs_prop_set(pool
,
803 ZFS_PROP_MOUNTPOINT
),
805 if (zfs_mount(pool
, NULL
, 0) == 0)
806 ret
= zfs_shareall(pool
);
809 } else if (libzfs_errno(g_zfs
) == EZFS_INVALIDNAME
) {
810 (void) fprintf(stderr
, gettext("pool name may have "
817 nvlist_free(fsprops
);
821 nvlist_free(fsprops
);
828 * zpool destroy <pool>
830 * -f Forcefully unmount any datasets
832 * Destroy the given pool. Automatically unmounts any datasets in the pool.
835 zpool_do_destroy(int argc
, char **argv
)
837 boolean_t force
= B_FALSE
;
844 while ((c
= getopt(argc
, argv
, "f")) != -1) {
850 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
859 /* check arguments */
861 (void) fprintf(stderr
, gettext("missing pool argument\n"));
865 (void) fprintf(stderr
, gettext("too many arguments\n"));
871 if ((zhp
= zpool_open_canfail(g_zfs
, pool
)) == NULL
) {
873 * As a special case, check for use of '/' in the name, and
874 * direct the user to use 'zfs destroy' instead.
876 if (strchr(pool
, '/') != NULL
)
877 (void) fprintf(stderr
, gettext("use 'zfs destroy' to "
878 "destroy a dataset\n"));
882 if (zpool_disable_datasets(zhp
, force
) != 0) {
883 (void) fprintf(stderr
, gettext("could not destroy '%s': "
884 "could not unmount datasets\n"), zpool_get_name(zhp
));
888 ret
= (zpool_destroy(zhp
) != 0);
896 * zpool export [-f] <pool> ...
898 * -f Forcefully unmount datasets
900 * Export the given pools. By default, the command will attempt to cleanly
901 * unmount any active datasets within the pool. If the '-f' flag is specified,
902 * then the datasets will be forcefully unmounted.
905 zpool_do_export(int argc
, char **argv
)
907 boolean_t force
= B_FALSE
;
908 boolean_t hardforce
= B_FALSE
;
915 while ((c
= getopt(argc
, argv
, "fF")) != -1) {
924 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
933 /* check arguments */
935 (void) fprintf(stderr
, gettext("missing pool argument\n"));
940 for (i
= 0; i
< argc
; i
++) {
941 if ((zhp
= zpool_open_canfail(g_zfs
, argv
[i
])) == NULL
) {
946 if (zpool_disable_datasets(zhp
, force
) != 0) {
953 if (zpool_export_force(zhp
) != 0)
955 } else if (zpool_export(zhp
, force
) != 0) {
966 * Given a vdev configuration, determine the maximum width needed for the device
970 max_width(zpool_handle_t
*zhp
, nvlist_t
*nv
, int depth
, int max
)
972 char *name
= zpool_vdev_name(g_zfs
, zhp
, nv
, B_TRUE
);
977 if (strlen(name
) + depth
> max
)
978 max
= strlen(name
) + depth
;
982 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_SPARES
,
983 &child
, &children
) == 0) {
984 for (c
= 0; c
< children
; c
++)
985 if ((ret
= max_width(zhp
, child
[c
], depth
+ 2,
990 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_L2CACHE
,
991 &child
, &children
) == 0) {
992 for (c
= 0; c
< children
; c
++)
993 if ((ret
= max_width(zhp
, child
[c
], depth
+ 2,
998 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
999 &child
, &children
) == 0) {
1000 for (c
= 0; c
< children
; c
++)
1001 if ((ret
= max_width(zhp
, child
[c
], depth
+ 2,
1010 typedef struct spare_cbdata
{
1012 zpool_handle_t
*cb_zhp
;
1016 find_vdev(nvlist_t
*nv
, uint64_t search
)
1022 if (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_GUID
, &guid
) == 0 &&
1026 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
1027 &child
, &children
) == 0) {
1028 for (c
= 0; c
< children
; c
++)
1029 if (find_vdev(child
[c
], search
))
1037 find_spare(zpool_handle_t
*zhp
, void *data
)
1039 spare_cbdata_t
*cbp
= data
;
1040 nvlist_t
*config
, *nvroot
;
1042 config
= zpool_get_config(zhp
, NULL
);
1043 verify(nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
1046 if (find_vdev(nvroot
, cbp
->cb_guid
)) {
1056 * Print out configuration state as requested by status_callback.
1059 print_status_config(zpool_handle_t
*zhp
, const char *name
, nvlist_t
*nv
,
1060 int namewidth
, int depth
, boolean_t isspare
)
1064 pool_scan_stat_t
*ps
= NULL
;
1066 char rbuf
[6], wbuf
[6], cbuf
[6];
1068 uint64_t notpresent
;
1072 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
1073 &child
, &children
) != 0)
1076 verify(nvlist_lookup_uint64_array(nv
, ZPOOL_CONFIG_VDEV_STATS
,
1077 (uint64_t **)&vs
, &c
) == 0);
1079 state
= zpool_state_to_name(vs
->vs_state
, vs
->vs_aux
);
1082 * For hot spares, we use the terms 'INUSE' and 'AVAILABLE' for
1085 if (vs
->vs_aux
== VDEV_AUX_SPARED
)
1087 else if (vs
->vs_state
== VDEV_STATE_HEALTHY
)
1091 (void) printf("\t%*s%-*s %-8s", depth
, "", namewidth
- depth
,
1095 zfs_nicenum(vs
->vs_read_errors
, rbuf
, sizeof (rbuf
));
1096 zfs_nicenum(vs
->vs_write_errors
, wbuf
, sizeof (wbuf
));
1097 zfs_nicenum(vs
->vs_checksum_errors
, cbuf
, sizeof (cbuf
));
1098 (void) printf(" %5s %5s %5s", rbuf
, wbuf
, cbuf
);
1101 if (nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_NOT_PRESENT
,
1102 ¬present
) == 0) {
1104 verify(nvlist_lookup_string(nv
, ZPOOL_CONFIG_PATH
, &path
) == 0);
1105 (void) printf(" was %s", path
);
1106 } else if (vs
->vs_aux
!= 0) {
1109 switch (vs
->vs_aux
) {
1110 case VDEV_AUX_OPEN_FAILED
:
1111 (void) printf(gettext("cannot open"));
1114 case VDEV_AUX_BAD_GUID_SUM
:
1115 (void) printf(gettext("missing device"));
1118 case VDEV_AUX_NO_REPLICAS
:
1119 (void) printf(gettext("insufficient replicas"));
1122 case VDEV_AUX_VERSION_NEWER
:
1123 (void) printf(gettext("newer version"));
1126 case VDEV_AUX_SPARED
:
1127 verify(nvlist_lookup_uint64(nv
, ZPOOL_CONFIG_GUID
,
1129 if (zpool_iter(g_zfs
, find_spare
, &cb
) == 1) {
1130 if (strcmp(zpool_get_name(cb
.cb_zhp
),
1131 zpool_get_name(zhp
)) == 0)
1132 (void) printf(gettext("currently in "
1135 (void) printf(gettext("in use by "
1137 zpool_get_name(cb
.cb_zhp
));
1138 zpool_close(cb
.cb_zhp
);
1140 (void) printf(gettext("currently in use"));
1144 case VDEV_AUX_ERR_EXCEEDED
:
1145 (void) printf(gettext("too many errors"));
1148 case VDEV_AUX_IO_FAILURE
:
1149 (void) printf(gettext("experienced I/O failures"));
1152 case VDEV_AUX_BAD_LOG
:
1153 (void) printf(gettext("bad intent log"));
1156 case VDEV_AUX_EXTERNAL
:
1157 (void) printf(gettext("external device fault"));
1160 case VDEV_AUX_SPLIT_POOL
:
1161 (void) printf(gettext("split into new pool"));
1165 (void) printf(gettext("corrupted data"));
1170 (void) nvlist_lookup_uint64_array(nv
, ZPOOL_CONFIG_SCAN_STATS
,
1171 (uint64_t **)&ps
, &c
);
1173 if (ps
&& ps
->pss_state
== DSS_SCANNING
&&
1174 vs
->vs_scan_processed
!= 0 && children
== 0) {
1175 (void) printf(gettext(" (%s)"),
1176 (ps
->pss_func
== POOL_SCAN_RESILVER
) ?
1177 "resilvering" : "repairing");
1180 (void) printf("\n");
1182 for (c
= 0; c
< children
; c
++) {
1183 uint64_t islog
= B_FALSE
, ishole
= B_FALSE
;
1185 /* Don't print logs or holes here */
1186 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_LOG
,
1188 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_HOLE
,
1190 if (islog
|| ishole
)
1192 vname
= zpool_vdev_name(g_zfs
, zhp
, child
[c
], B_TRUE
);
1193 print_status_config(zhp
, vname
, child
[c
],
1194 namewidth
, depth
+ 2, isspare
);
1201 * Print the configuration of an exported pool. Iterate over all vdevs in the
1202 * pool, printing out the name and status for each one.
1205 print_import_config(const char *name
, nvlist_t
*nv
, int namewidth
, int depth
)
1212 verify(nvlist_lookup_string(nv
, ZPOOL_CONFIG_TYPE
, &type
) == 0);
1213 if (strcmp(type
, VDEV_TYPE_MISSING
) == 0 ||
1214 strcmp(type
, VDEV_TYPE_HOLE
) == 0)
1217 verify(nvlist_lookup_uint64_array(nv
, ZPOOL_CONFIG_VDEV_STATS
,
1218 (uint64_t **)&vs
, &c
) == 0);
1220 (void) printf("\t%*s%-*s", depth
, "", namewidth
- depth
, name
);
1221 (void) printf(" %s", zpool_state_to_name(vs
->vs_state
, vs
->vs_aux
));
1223 if (vs
->vs_aux
!= 0) {
1226 switch (vs
->vs_aux
) {
1227 case VDEV_AUX_OPEN_FAILED
:
1228 (void) printf(gettext("cannot open"));
1231 case VDEV_AUX_BAD_GUID_SUM
:
1232 (void) printf(gettext("missing device"));
1235 case VDEV_AUX_NO_REPLICAS
:
1236 (void) printf(gettext("insufficient replicas"));
1239 case VDEV_AUX_VERSION_NEWER
:
1240 (void) printf(gettext("newer version"));
1243 case VDEV_AUX_ERR_EXCEEDED
:
1244 (void) printf(gettext("too many errors"));
1248 (void) printf(gettext("corrupted data"));
1252 (void) printf("\n");
1254 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
,
1255 &child
, &children
) != 0)
1258 for (c
= 0; c
< children
; c
++) {
1259 uint64_t is_log
= B_FALSE
;
1261 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_LOG
,
1266 vname
= zpool_vdev_name(g_zfs
, NULL
, child
[c
], B_TRUE
);
1267 print_import_config(vname
, child
[c
], namewidth
, depth
+ 2);
1271 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_L2CACHE
,
1272 &child
, &children
) == 0) {
1273 (void) printf(gettext("\tcache\n"));
1274 for (c
= 0; c
< children
; c
++) {
1275 vname
= zpool_vdev_name(g_zfs
, NULL
, child
[c
], B_FALSE
);
1276 (void) printf("\t %s\n", vname
);
1281 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_SPARES
,
1282 &child
, &children
) == 0) {
1283 (void) printf(gettext("\tspares\n"));
1284 for (c
= 0; c
< children
; c
++) {
1285 vname
= zpool_vdev_name(g_zfs
, NULL
, child
[c
], B_FALSE
);
1286 (void) printf("\t %s\n", vname
);
1294 * Logs are recorded as top level vdevs in the main pool child array
1295 * but with "is_log" set to 1. We use either print_status_config() or
1296 * print_import_config() to print the top level logs then any log
1297 * children (eg mirrored slogs) are printed recursively - which
1298 * works because only the top level vdev is marked "is_log"
1301 print_logs(zpool_handle_t
*zhp
, nvlist_t
*nv
, int namewidth
, boolean_t verbose
)
1306 if (nvlist_lookup_nvlist_array(nv
, ZPOOL_CONFIG_CHILDREN
, &child
,
1310 (void) printf(gettext("\tlogs\n"));
1312 for (c
= 0; c
< children
; c
++) {
1313 uint64_t is_log
= B_FALSE
;
1316 (void) nvlist_lookup_uint64(child
[c
], ZPOOL_CONFIG_IS_LOG
,
1320 name
= zpool_vdev_name(g_zfs
, zhp
, child
[c
], B_TRUE
);
1322 print_status_config(zhp
, name
, child
[c
], namewidth
,
1325 print_import_config(name
, child
[c
], namewidth
, 2);
1331 * Display the status for the given pool.
1334 show_import(nvlist_t
*config
)
1336 uint64_t pool_state
;
1348 verify(nvlist_lookup_string(config
, ZPOOL_CONFIG_POOL_NAME
,
1350 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_GUID
,
1352 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_STATE
,
1354 verify(nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
1357 verify(nvlist_lookup_uint64_array(nvroot
, ZPOOL_CONFIG_VDEV_STATS
,
1358 (uint64_t **)&vs
, &vsc
) == 0);
1359 health
= zpool_state_to_name(vs
->vs_state
, vs
->vs_aux
);
1361 reason
= zpool_import_status(config
, &msgid
);
1363 (void) printf(gettext(" pool: %s\n"), name
);
1364 (void) printf(gettext(" id: %llu\n"), (u_longlong_t
)guid
);
1365 (void) printf(gettext(" state: %s"), health
);
1366 if (pool_state
== POOL_STATE_DESTROYED
)
1367 (void) printf(gettext(" (DESTROYED)"));
1368 (void) printf("\n");
1371 case ZPOOL_STATUS_MISSING_DEV_R
:
1372 case ZPOOL_STATUS_MISSING_DEV_NR
:
1373 case ZPOOL_STATUS_BAD_GUID_SUM
:
1374 (void) printf(gettext(" status: One or more devices are "
1375 "missing from the system.\n"));
1378 case ZPOOL_STATUS_CORRUPT_LABEL_R
:
1379 case ZPOOL_STATUS_CORRUPT_LABEL_NR
:
1380 (void) printf(gettext(" status: One or more devices contains "
1381 "corrupted data.\n"));
1384 case ZPOOL_STATUS_CORRUPT_DATA
:
1386 gettext(" status: The pool data is corrupted.\n"));
1389 case ZPOOL_STATUS_OFFLINE_DEV
:
1390 (void) printf(gettext(" status: One or more devices "
1391 "are offlined.\n"));
1394 case ZPOOL_STATUS_CORRUPT_POOL
:
1395 (void) printf(gettext(" status: The pool metadata is "
1399 case ZPOOL_STATUS_VERSION_OLDER
:
1400 (void) printf(gettext(" status: The pool is formatted using an "
1401 "older on-disk version.\n"));
1404 case ZPOOL_STATUS_VERSION_NEWER
:
1405 (void) printf(gettext(" status: The pool is formatted using an "
1406 "incompatible version.\n"));
1409 case ZPOOL_STATUS_HOSTID_MISMATCH
:
1410 (void) printf(gettext(" status: The pool was last accessed by "
1411 "another system.\n"));
1414 case ZPOOL_STATUS_FAULTED_DEV_R
:
1415 case ZPOOL_STATUS_FAULTED_DEV_NR
:
1416 (void) printf(gettext(" status: One or more devices are "
1420 case ZPOOL_STATUS_BAD_LOG
:
1421 (void) printf(gettext(" status: An intent log record cannot be "
1425 case ZPOOL_STATUS_RESILVERING
:
1426 (void) printf(gettext(" status: One or more devices were being "
1432 * No other status can be seen when importing pools.
1434 assert(reason
== ZPOOL_STATUS_OK
);
1438 * Print out an action according to the overall state of the pool.
1440 if (vs
->vs_state
== VDEV_STATE_HEALTHY
) {
1441 if (reason
== ZPOOL_STATUS_VERSION_OLDER
)
1442 (void) printf(gettext(" action: The pool can be "
1443 "imported using its name or numeric identifier, "
1444 "though\n\tsome features will not be available "
1445 "without an explicit 'zpool upgrade'.\n"));
1446 else if (reason
== ZPOOL_STATUS_HOSTID_MISMATCH
)
1447 (void) printf(gettext(" action: The pool can be "
1448 "imported using its name or numeric "
1449 "identifier and\n\tthe '-f' flag.\n"));
1451 (void) printf(gettext(" action: The pool can be "
1452 "imported using its name or numeric "
1454 } else if (vs
->vs_state
== VDEV_STATE_DEGRADED
) {
1455 (void) printf(gettext(" action: The pool can be imported "
1456 "despite missing or damaged devices. The\n\tfault "
1457 "tolerance of the pool may be compromised if imported.\n"));
1460 case ZPOOL_STATUS_VERSION_NEWER
:
1461 (void) printf(gettext(" action: The pool cannot be "
1462 "imported. Access the pool on a system running "
1463 "newer\n\tsoftware, or recreate the pool from "
1466 case ZPOOL_STATUS_MISSING_DEV_R
:
1467 case ZPOOL_STATUS_MISSING_DEV_NR
:
1468 case ZPOOL_STATUS_BAD_GUID_SUM
:
1469 (void) printf(gettext(" action: The pool cannot be "
1470 "imported. Attach the missing\n\tdevices and try "
1474 (void) printf(gettext(" action: The pool cannot be "
1475 "imported due to damaged devices or data.\n"));
1479 /* Print the comment attached to the pool. */
1480 if (nvlist_lookup_string(config
, ZPOOL_CONFIG_COMMENT
, &comment
) == 0)
1481 (void) printf(gettext("comment: %s\n"), comment
);
1484 * If the state is "closed" or "can't open", and the aux state
1485 * is "corrupt data":
1487 if (((vs
->vs_state
== VDEV_STATE_CLOSED
) ||
1488 (vs
->vs_state
== VDEV_STATE_CANT_OPEN
)) &&
1489 (vs
->vs_aux
== VDEV_AUX_CORRUPT_DATA
)) {
1490 if (pool_state
== POOL_STATE_DESTROYED
)
1491 (void) printf(gettext("\tThe pool was destroyed, "
1492 "but can be imported using the '-Df' flags.\n"));
1493 else if (pool_state
!= POOL_STATE_EXPORTED
)
1494 (void) printf(gettext("\tThe pool may be active on "
1495 "another system, but can be imported using\n\t"
1496 "the '-f' flag.\n"));
1500 (void) printf(gettext(" see: http://zfsonlinux.org/msg/%s\n"),
1503 (void) printf(gettext(" config:\n\n"));
1505 namewidth
= max_width(NULL
, nvroot
, 0, 0);
1509 print_import_config(name
, nvroot
, namewidth
, 0);
1510 if (num_logs(nvroot
) > 0)
1511 print_logs(NULL
, nvroot
, namewidth
, B_FALSE
);
1513 if (reason
== ZPOOL_STATUS_BAD_GUID_SUM
) {
1514 (void) printf(gettext("\n\tAdditional devices are known to "
1515 "be part of this pool, though their\n\texact "
1516 "configuration cannot be determined.\n"));
1521 * Perform the import for the given configuration. This passes the heavy
1522 * lifting off to zpool_import_props(), and then mounts the datasets contained
1526 do_import(nvlist_t
*config
, const char *newname
, const char *mntopts
,
1527 nvlist_t
*props
, int flags
)
1529 zpool_handle_t
*zhp
;
1534 verify(nvlist_lookup_string(config
, ZPOOL_CONFIG_POOL_NAME
,
1537 verify(nvlist_lookup_uint64(config
,
1538 ZPOOL_CONFIG_POOL_STATE
, &state
) == 0);
1539 verify(nvlist_lookup_uint64(config
,
1540 ZPOOL_CONFIG_VERSION
, &version
) == 0);
1541 if (version
> SPA_VERSION
) {
1542 (void) fprintf(stderr
, gettext("cannot import '%s': pool "
1543 "is formatted using a newer ZFS version\n"), name
);
1545 } else if (state
!= POOL_STATE_EXPORTED
&&
1546 !(flags
& ZFS_IMPORT_ANY_HOST
)) {
1549 if (nvlist_lookup_uint64(config
, ZPOOL_CONFIG_HOSTID
,
1551 unsigned long system_hostid
= gethostid() & 0xffffffff;
1553 if ((unsigned long)hostid
!= system_hostid
) {
1558 verify(nvlist_lookup_string(config
,
1559 ZPOOL_CONFIG_HOSTNAME
, &hostname
) == 0);
1560 verify(nvlist_lookup_uint64(config
,
1561 ZPOOL_CONFIG_TIMESTAMP
, ×tamp
) == 0);
1563 (void) fprintf(stderr
, gettext("cannot import "
1564 "'%s': pool may be in use from other "
1565 "system, it was last accessed by %s "
1566 "(hostid: 0x%lx) on %s"), name
, hostname
,
1567 (unsigned long)hostid
,
1568 asctime(localtime(&t
)));
1569 (void) fprintf(stderr
, gettext("use '-f' to "
1570 "import anyway\n"));
1574 (void) fprintf(stderr
, gettext("cannot import '%s': "
1575 "pool may be in use from other system\n"), name
);
1576 (void) fprintf(stderr
, gettext("use '-f' to import "
1582 if (zpool_import_props(g_zfs
, config
, newname
, props
, flags
) != 0)
1585 if (newname
!= NULL
)
1586 name
= (char *)newname
;
1588 if ((zhp
= zpool_open_canfail(g_zfs
, name
)) == NULL
)
1591 if (zpool_get_state(zhp
) != POOL_STATE_UNAVAIL
&&
1592 !(flags
& ZFS_IMPORT_ONLY
) &&
1593 zpool_enable_datasets(zhp
, mntopts
, 0) != 0) {
1603 * zpool import [-d dir] [-D]
1604 * import [-o mntopts] [-o prop=value] ... [-R root] [-D]
1605 * [-d dir | -c cachefile] [-f] -a
1606 * import [-o mntopts] [-o prop=value] ... [-R root] [-D]
1607 * [-d dir | -c cachefile] [-f] [-n] [-F] <pool | id> [newpool]
1609 * -c Read pool information from a cachefile instead of searching
1612 * -d Scan in a specific directory, other than /dev/. More than
1613 * one directory can be specified using multiple '-d' options.
1615 * -D Scan for previously destroyed pools or import all or only
1616 * specified destroyed pools.
1618 * -R Temporarily import the pool, with all mountpoints relative to
1619 * the given root. The pool will remain exported when the machine
1622 * -V Import even in the presence of faulted vdevs. This is an
1623 * intentionally undocumented option for testing purposes, and
1624 * treats the pool configuration as complete, leaving any bad
1625 * vdevs in the FAULTED state. In other words, it does verbatim
1628 * -f Force import, even if it appears that the pool is active.
1630 * -F Attempt rewind if necessary.
1632 * -n See if rewind would work, but don't actually rewind.
1634 * -N Import the pool but don't mount datasets.
1636 * -T Specify a starting txg to use for import. This option is
1637 * intentionally undocumented option for testing purposes.
1639 * -a Import all pools found.
1641 * -o Set property=value and/or temporary mount options (without '=').
1643 * The import command scans for pools to import, and import pools based on pool
1644 * name and GUID. The pool can also be renamed as part of the import process.
1647 zpool_do_import(int argc
, char **argv
)
1649 char **searchdirs
= NULL
;
1650 char *env
, *envdup
= NULL
;
1654 nvlist_t
*pools
= NULL
;
1655 boolean_t do_all
= B_FALSE
;
1656 boolean_t do_destroyed
= B_FALSE
;
1657 char *mntopts
= NULL
;
1660 uint64_t searchguid
= 0;
1661 char *searchname
= NULL
;
1663 nvlist_t
*found_config
;
1664 nvlist_t
*policy
= NULL
;
1665 nvlist_t
*props
= NULL
;
1667 int flags
= ZFS_IMPORT_NORMAL
;
1668 uint32_t rewind_policy
= ZPOOL_NO_REWIND
;
1669 boolean_t dryrun
= B_FALSE
;
1670 boolean_t do_rewind
= B_FALSE
;
1671 boolean_t xtreme_rewind
= B_FALSE
;
1672 uint64_t pool_state
, txg
= -1ULL;
1673 char *cachefile
= NULL
;
1674 importargs_t idata
= { 0 };
1678 while ((c
= getopt(argc
, argv
, ":aCc:d:DEfFmnNo:rR:T:VX")) != -1) {
1687 if (searchdirs
== NULL
) {
1688 searchdirs
= safe_malloc(sizeof (char *));
1690 char **tmp
= safe_malloc((nsearch
+ 1) *
1692 bcopy(searchdirs
, tmp
, nsearch
*
1697 searchdirs
[nsearch
++] = optarg
;
1700 do_destroyed
= B_TRUE
;
1703 flags
|= ZFS_IMPORT_ANY_HOST
;
1709 flags
|= ZFS_IMPORT_MISSING_LOG
;
1715 flags
|= ZFS_IMPORT_ONLY
;
1718 if ((propval
= strchr(optarg
, '=')) != NULL
) {
1721 if (add_prop_list(optarg
, propval
,
1729 if (add_prop_list(zpool_prop_to_name(
1730 ZPOOL_PROP_ALTROOT
), optarg
, &props
, B_TRUE
))
1732 if (nvlist_lookup_string(props
,
1733 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE
),
1736 if (add_prop_list(zpool_prop_to_name(
1737 ZPOOL_PROP_CACHEFILE
), "none", &props
, B_TRUE
))
1742 txg
= strtoull(optarg
, &endptr
, 10);
1743 if (errno
!= 0 || *endptr
!= '\0') {
1744 (void) fprintf(stderr
,
1745 gettext("invalid txg value\n"));
1748 rewind_policy
= ZPOOL_DO_REWIND
| ZPOOL_EXTREME_REWIND
;
1751 flags
|= ZFS_IMPORT_VERBATIM
;
1754 xtreme_rewind
= B_TRUE
;
1757 (void) fprintf(stderr
, gettext("missing argument for "
1758 "'%c' option\n"), optopt
);
1762 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
1771 if (cachefile
&& nsearch
!= 0) {
1772 (void) fprintf(stderr
, gettext("-c is incompatible with -d\n"));
1776 if ((dryrun
|| xtreme_rewind
) && !do_rewind
) {
1777 (void) fprintf(stderr
,
1778 gettext("-n or -X only meaningful with -F\n"));
1782 rewind_policy
= ZPOOL_TRY_REWIND
;
1784 rewind_policy
= ZPOOL_DO_REWIND
;
1786 rewind_policy
|= ZPOOL_EXTREME_REWIND
;
1788 /* In the future, we can capture further policy and include it here */
1789 if (nvlist_alloc(&policy
, NV_UNIQUE_NAME
, 0) != 0 ||
1790 nvlist_add_uint64(policy
, ZPOOL_REWIND_REQUEST_TXG
, txg
) != 0 ||
1791 nvlist_add_uint32(policy
, ZPOOL_REWIND_REQUEST
, rewind_policy
) != 0)
1794 /* check argument count */
1797 (void) fprintf(stderr
, gettext("too many arguments\n"));
1802 (void) fprintf(stderr
, gettext("too many arguments\n"));
1807 * Check for the SYS_CONFIG privilege. We do this explicitly
1808 * here because otherwise any attempt to discover pools will
1811 if (argc
== 0 && !priv_ineffect(PRIV_SYS_CONFIG
)) {
1812 (void) fprintf(stderr
, gettext("cannot "
1813 "discover pools: permission denied\n"));
1814 if (searchdirs
!= NULL
)
1817 nvlist_free(policy
);
1823 * Depending on the arguments given, we do one of the following:
1825 * <none> Iterate through all pools and display information about
1828 * -a Iterate through all pools and try to import each one.
1830 * <id> Find the pool that corresponds to the given GUID/pool
1831 * name and import that one.
1833 * -D Above options applies only to destroyed pools.
1839 searchguid
= strtoull(argv
[0], &endptr
, 10);
1840 if (errno
!= 0 || *endptr
!= '\0')
1841 searchname
= argv
[0];
1842 found_config
= NULL
;
1845 * User specified a name or guid. Ensure it's unique.
1847 idata
.unique
= B_TRUE
;
1851 * Check the environment for the preferred search path.
1853 if ((searchdirs
== NULL
) && (env
= getenv("ZPOOL_IMPORT_PATH"))) {
1856 envdup
= strdup(env
);
1858 dir
= strtok(envdup
, ":");
1859 while (dir
!= NULL
) {
1860 if (searchdirs
== NULL
) {
1861 searchdirs
= safe_malloc(sizeof (char *));
1863 char **tmp
= safe_malloc((nsearch
+ 1) *
1865 bcopy(searchdirs
, tmp
, nsearch
*
1870 searchdirs
[nsearch
++] = dir
;
1871 dir
= strtok(NULL
, ":");
1875 idata
.path
= searchdirs
;
1876 idata
.paths
= nsearch
;
1877 idata
.poolname
= searchname
;
1878 idata
.guid
= searchguid
;
1879 idata
.cachefile
= cachefile
;
1881 pools
= zpool_search_import(g_zfs
, &idata
);
1883 if (pools
!= NULL
&& idata
.exists
&&
1884 (argc
== 1 || strcmp(argv
[0], argv
[1]) == 0)) {
1885 (void) fprintf(stderr
, gettext("cannot import '%s': "
1886 "a pool with that name already exists\n"),
1888 (void) fprintf(stderr
, gettext("use the form '%s "
1889 "<pool | id> <newpool>' to give it a new name\n"),
1892 } else if (pools
== NULL
&& idata
.exists
) {
1893 (void) fprintf(stderr
, gettext("cannot import '%s': "
1894 "a pool with that name is already created/imported,\n"),
1896 (void) fprintf(stderr
, gettext("and no additional pools "
1897 "with that name were found\n"));
1899 } else if (pools
== NULL
) {
1901 (void) fprintf(stderr
, gettext("cannot import '%s': "
1902 "no such pool available\n"), argv
[0]);
1908 if (searchdirs
!= NULL
)
1912 nvlist_free(policy
);
1917 * At this point we have a list of import candidate configs. Even if
1918 * we were searching by pool name or guid, we still need to
1919 * post-process the list to deal with pool state and possible
1925 while ((elem
= nvlist_next_nvpair(pools
, elem
)) != NULL
) {
1927 verify(nvpair_value_nvlist(elem
, &config
) == 0);
1929 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_STATE
,
1931 if (!do_destroyed
&& pool_state
== POOL_STATE_DESTROYED
)
1933 if (do_destroyed
&& pool_state
!= POOL_STATE_DESTROYED
)
1936 verify(nvlist_add_nvlist(config
, ZPOOL_REWIND_POLICY
,
1943 (void) printf("\n");
1946 err
|= do_import(config
, NULL
, mntopts
,
1949 show_import(config
);
1951 } else if (searchname
!= NULL
) {
1955 * We are searching for a pool based on name.
1957 verify(nvlist_lookup_string(config
,
1958 ZPOOL_CONFIG_POOL_NAME
, &name
) == 0);
1960 if (strcmp(name
, searchname
) == 0) {
1961 if (found_config
!= NULL
) {
1962 (void) fprintf(stderr
, gettext(
1963 "cannot import '%s': more than "
1964 "one matching pool\n"), searchname
);
1965 (void) fprintf(stderr
, gettext(
1966 "import by numeric ID instead\n"));
1969 found_config
= config
;
1975 * Search for a pool by guid.
1977 verify(nvlist_lookup_uint64(config
,
1978 ZPOOL_CONFIG_POOL_GUID
, &guid
) == 0);
1980 if (guid
== searchguid
)
1981 found_config
= config
;
1986 * If we were searching for a specific pool, verify that we found a
1987 * pool, and then do the import.
1989 if (argc
!= 0 && err
== 0) {
1990 if (found_config
== NULL
) {
1991 (void) fprintf(stderr
, gettext("cannot import '%s': "
1992 "no such pool available\n"), argv
[0]);
1995 err
|= do_import(found_config
, argc
== 1 ? NULL
:
1996 argv
[1], mntopts
, props
, flags
);
2001 * If we were just looking for pools, report an error if none were
2004 if (argc
== 0 && first
)
2005 (void) fprintf(stderr
,
2006 gettext("no pools available to import\n"));
2011 nvlist_free(policy
);
2012 if (searchdirs
!= NULL
)
2017 return (err
? 1 : 0);
2020 typedef struct iostat_cbdata
{
2021 zpool_list_t
*cb_list
;
2028 print_iostat_separator(iostat_cbdata_t
*cb
)
2032 for (i
= 0; i
< cb
->cb_namewidth
; i
++)
2034 (void) printf(" ----- ----- ----- ----- ----- -----\n");
2038 print_iostat_header(iostat_cbdata_t
*cb
)
2040 (void) printf("%*s capacity operations bandwidth\n",
2041 cb
->cb_namewidth
, "");
2042 (void) printf("%-*s alloc free read write read write\n",
2043 cb
->cb_namewidth
, "pool");
2044 print_iostat_separator(cb
);
2048 * Display a single statistic.
2051 print_one_stat(uint64_t value
)
2055 zfs_nicenum(value
, buf
, sizeof (buf
));
2056 (void) printf(" %5s", buf
);
2060 * Print out all the statistics for the given vdev. This can either be the
2061 * toplevel configuration, or called recursively. If 'name' is NULL, then this
2062 * is a verbose output, and we don't want to display the toplevel pool stats.
2065 print_vdev_stats(zpool_handle_t
*zhp
, const char *name
, nvlist_t
*oldnv
,
2066 nvlist_t
*newnv
, iostat_cbdata_t
*cb
, int depth
)
2068 nvlist_t
**oldchild
, **newchild
;
2070 vdev_stat_t
*oldvs
, *newvs
;
2071 vdev_stat_t zerovs
= { 0 };
2076 if (oldnv
!= NULL
) {
2077 verify(nvlist_lookup_uint64_array(oldnv
,
2078 ZPOOL_CONFIG_VDEV_STATS
, (uint64_t **)&oldvs
, &c
) == 0);
2083 verify(nvlist_lookup_uint64_array(newnv
, ZPOOL_CONFIG_VDEV_STATS
,
2084 (uint64_t **)&newvs
, &c
) == 0);
2086 if (strlen(name
) + depth
> cb
->cb_namewidth
)
2087 (void) printf("%*s%s", depth
, "", name
);
2089 (void) printf("%*s%s%*s", depth
, "", name
,
2090 (int)(cb
->cb_namewidth
- strlen(name
) - depth
), "");
2092 tdelta
= newvs
->vs_timestamp
- oldvs
->vs_timestamp
;
2097 scale
= (double)NANOSEC
/ tdelta
;
2099 /* only toplevel vdevs have capacity stats */
2100 if (newvs
->vs_space
== 0) {
2101 (void) printf(" - -");
2103 print_one_stat(newvs
->vs_alloc
);
2104 print_one_stat(newvs
->vs_space
- newvs
->vs_alloc
);
2107 print_one_stat((uint64_t)(scale
* (newvs
->vs_ops
[ZIO_TYPE_READ
] -
2108 oldvs
->vs_ops
[ZIO_TYPE_READ
])));
2110 print_one_stat((uint64_t)(scale
* (newvs
->vs_ops
[ZIO_TYPE_WRITE
] -
2111 oldvs
->vs_ops
[ZIO_TYPE_WRITE
])));
2113 print_one_stat((uint64_t)(scale
* (newvs
->vs_bytes
[ZIO_TYPE_READ
] -
2114 oldvs
->vs_bytes
[ZIO_TYPE_READ
])));
2116 print_one_stat((uint64_t)(scale
* (newvs
->vs_bytes
[ZIO_TYPE_WRITE
] -
2117 oldvs
->vs_bytes
[ZIO_TYPE_WRITE
])));
2119 (void) printf("\n");
2121 if (!cb
->cb_verbose
)
2124 if (nvlist_lookup_nvlist_array(newnv
, ZPOOL_CONFIG_CHILDREN
,
2125 &newchild
, &children
) != 0)
2128 if (oldnv
&& nvlist_lookup_nvlist_array(oldnv
, ZPOOL_CONFIG_CHILDREN
,
2129 &oldchild
, &c
) != 0)
2132 for (c
= 0; c
< children
; c
++) {
2133 uint64_t ishole
= B_FALSE
, islog
= B_FALSE
;
2135 (void) nvlist_lookup_uint64(newchild
[c
], ZPOOL_CONFIG_IS_HOLE
,
2138 (void) nvlist_lookup_uint64(newchild
[c
], ZPOOL_CONFIG_IS_LOG
,
2141 if (ishole
|| islog
)
2144 vname
= zpool_vdev_name(g_zfs
, zhp
, newchild
[c
], B_FALSE
);
2145 print_vdev_stats(zhp
, vname
, oldnv
? oldchild
[c
] : NULL
,
2146 newchild
[c
], cb
, depth
+ 2);
2151 * Log device section
2154 if (num_logs(newnv
) > 0) {
2155 (void) printf("%-*s - - - - - "
2156 "-\n", cb
->cb_namewidth
, "logs");
2158 for (c
= 0; c
< children
; c
++) {
2159 uint64_t islog
= B_FALSE
;
2160 (void) nvlist_lookup_uint64(newchild
[c
],
2161 ZPOOL_CONFIG_IS_LOG
, &islog
);
2164 vname
= zpool_vdev_name(g_zfs
, zhp
, newchild
[c
],
2166 print_vdev_stats(zhp
, vname
, oldnv
?
2167 oldchild
[c
] : NULL
, newchild
[c
],
2176 * Include level 2 ARC devices in iostat output
2178 if (nvlist_lookup_nvlist_array(newnv
, ZPOOL_CONFIG_L2CACHE
,
2179 &newchild
, &children
) != 0)
2182 if (oldnv
&& nvlist_lookup_nvlist_array(oldnv
, ZPOOL_CONFIG_L2CACHE
,
2183 &oldchild
, &c
) != 0)
2187 (void) printf("%-*s - - - - - "
2188 "-\n", cb
->cb_namewidth
, "cache");
2189 for (c
= 0; c
< children
; c
++) {
2190 vname
= zpool_vdev_name(g_zfs
, zhp
, newchild
[c
],
2192 print_vdev_stats(zhp
, vname
, oldnv
? oldchild
[c
] : NULL
,
2193 newchild
[c
], cb
, depth
+ 2);
2200 refresh_iostat(zpool_handle_t
*zhp
, void *data
)
2202 iostat_cbdata_t
*cb
= data
;
2206 * If the pool has disappeared, remove it from the list and continue.
2208 if (zpool_refresh_stats(zhp
, &missing
) != 0)
2212 pool_list_remove(cb
->cb_list
, zhp
);
2218 * Callback to print out the iostats for the given pool.
2221 print_iostat(zpool_handle_t
*zhp
, void *data
)
2223 iostat_cbdata_t
*cb
= data
;
2224 nvlist_t
*oldconfig
, *newconfig
;
2225 nvlist_t
*oldnvroot
, *newnvroot
;
2227 newconfig
= zpool_get_config(zhp
, &oldconfig
);
2229 if (cb
->cb_iteration
== 1)
2232 verify(nvlist_lookup_nvlist(newconfig
, ZPOOL_CONFIG_VDEV_TREE
,
2235 if (oldconfig
== NULL
)
2238 verify(nvlist_lookup_nvlist(oldconfig
, ZPOOL_CONFIG_VDEV_TREE
,
2242 * Print out the statistics for the pool.
2244 print_vdev_stats(zhp
, zpool_get_name(zhp
), oldnvroot
, newnvroot
, cb
, 0);
2247 print_iostat_separator(cb
);
2259 if (isatty(STDOUT_FILENO
)) {
2260 error
= ioctl(STDOUT_FILENO
, TIOCGWINSZ
, &ws
);
2262 columns
= ws
.ws_col
;
2271 get_namewidth(zpool_handle_t
*zhp
, void *data
)
2273 iostat_cbdata_t
*cb
= data
;
2274 nvlist_t
*config
, *nvroot
;
2277 if ((config
= zpool_get_config(zhp
, NULL
)) != NULL
) {
2278 verify(nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
2280 if (!cb
->cb_verbose
)
2281 cb
->cb_namewidth
= strlen(zpool_get_name(zhp
));
2283 cb
->cb_namewidth
= max_width(zhp
, nvroot
, 0,
2288 * The width must be at least 10, but may be as large as the
2289 * column width - 42 so that we can still fit in one line.
2291 columns
= get_columns();
2293 if (cb
->cb_namewidth
< 10)
2294 cb
->cb_namewidth
= 10;
2295 if (cb
->cb_namewidth
> columns
- 42)
2296 cb
->cb_namewidth
= columns
- 42;
2302 * Parse the input string, get the 'interval' and 'count' value if there is one.
2305 get_interval_count(int *argcp
, char **argv
, unsigned long *iv
,
2308 unsigned long interval
= 0, count
= 0;
2312 * Determine if the last argument is an integer or a pool name
2314 if (argc
> 0 && isdigit(argv
[argc
- 1][0])) {
2318 interval
= strtoul(argv
[argc
- 1], &end
, 10);
2320 if (*end
== '\0' && errno
== 0) {
2321 if (interval
== 0) {
2322 (void) fprintf(stderr
, gettext("interval "
2323 "cannot be zero\n"));
2327 * Ignore the last parameter
2332 * If this is not a valid number, just plow on. The
2333 * user will get a more informative error message later
2341 * If the last argument is also an integer, then we have both a count
2344 if (argc
> 0 && isdigit(argv
[argc
- 1][0])) {
2349 interval
= strtoul(argv
[argc
- 1], &end
, 10);
2351 if (*end
== '\0' && errno
== 0) {
2352 if (interval
== 0) {
2353 (void) fprintf(stderr
, gettext("interval "
2354 "cannot be zero\n"));
2359 * Ignore the last parameter
2373 get_timestamp_arg(char c
)
2376 timestamp_fmt
= UDATE
;
2378 timestamp_fmt
= DDATE
;
2384 * zpool iostat [-v] [-T d|u] [pool] ... [interval [count]]
2386 * -v Display statistics for individual vdevs
2387 * -T Display a timestamp in date(1) or Unix format
2389 * This command can be tricky because we want to be able to deal with pool
2390 * creation/destruction as well as vdev configuration changes. The bulk of this
2391 * processing is handled by the pool_list_* routines in zpool_iter.c. We rely
2392 * on pool_list_update() to detect the addition of new pools. Configuration
2393 * changes are all handled within libzfs.
2396 zpool_do_iostat(int argc
, char **argv
)
2401 unsigned long interval
= 0, count
= 0;
2403 boolean_t verbose
= B_FALSE
;
2407 while ((c
= getopt(argc
, argv
, "T:v")) != -1) {
2410 get_timestamp_arg(*optarg
);
2416 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
2425 get_interval_count(&argc
, argv
, &interval
, &count
);
2428 * Construct the list of all interesting pools.
2431 if ((list
= pool_list_get(argc
, argv
, NULL
, &ret
)) == NULL
)
2434 if (pool_list_count(list
) == 0 && argc
!= 0) {
2435 pool_list_free(list
);
2439 if (pool_list_count(list
) == 0 && interval
== 0) {
2440 pool_list_free(list
);
2441 (void) fprintf(stderr
, gettext("no pools available\n"));
2446 * Enter the main iostat loop.
2449 cb
.cb_verbose
= verbose
;
2450 cb
.cb_iteration
= 0;
2451 cb
.cb_namewidth
= 0;
2454 pool_list_update(list
);
2456 if ((npools
= pool_list_count(list
)) == 0)
2457 (void) fprintf(stderr
, gettext("no pools available\n"));
2460 * Refresh all statistics. This is done as an
2461 * explicit step before calculating the maximum name
2462 * width, so that any * configuration changes are
2463 * properly accounted for.
2465 (void) pool_list_iter(list
, B_FALSE
, refresh_iostat
,
2469 * Iterate over all pools to determine the maximum width
2470 * for the pool / device name column across all pools.
2472 cb
.cb_namewidth
= 0;
2473 (void) pool_list_iter(list
, B_FALSE
, get_namewidth
,
2476 if (timestamp_fmt
!= NODATE
)
2477 print_timestamp(timestamp_fmt
);
2480 * If it's the first time, or verbose mode, print the
2483 if (++cb
.cb_iteration
== 1 || verbose
)
2484 print_iostat_header(&cb
);
2486 (void) pool_list_iter(list
, B_FALSE
, print_iostat
, &cb
);
2489 * If there's more than one pool, and we're not in
2490 * verbose mode (which prints a separator for us),
2491 * then print a separator.
2493 if (npools
> 1 && !verbose
)
2494 print_iostat_separator(&cb
);
2497 (void) printf("\n");
2501 * Flush the output so that redirection to a file isn't buffered
2504 (void) fflush(stdout
);
2509 if (count
!= 0 && --count
== 0)
2512 (void) sleep(interval
);
2515 pool_list_free(list
);
2520 typedef struct list_cbdata
{
2521 boolean_t cb_scripted
;
2523 zprop_list_t
*cb_proplist
;
2527 * Given a list of columns to display, output appropriate headers for each one.
2530 print_header(zprop_list_t
*pl
)
2533 boolean_t first
= B_TRUE
;
2534 boolean_t right_justify
;
2536 for (; pl
!= NULL
; pl
= pl
->pl_next
) {
2537 if (pl
->pl_prop
== ZPROP_INVAL
)
2545 header
= zpool_prop_column_name(pl
->pl_prop
);
2546 right_justify
= zpool_prop_align_right(pl
->pl_prop
);
2548 if (pl
->pl_next
== NULL
&& !right_justify
)
2549 (void) printf("%s", header
);
2550 else if (right_justify
)
2551 (void) printf("%*s", (int)pl
->pl_width
, header
);
2553 (void) printf("%-*s", (int)pl
->pl_width
, header
);
2556 (void) printf("\n");
2560 * Given a pool and a list of properties, print out all the properties according
2561 * to the described layout.
2564 print_pool(zpool_handle_t
*zhp
, zprop_list_t
*pl
, int scripted
)
2566 boolean_t first
= B_TRUE
;
2567 char property
[ZPOOL_MAXPROPLEN
];
2569 boolean_t right_justify
;
2572 for (; pl
!= NULL
; pl
= pl
->pl_next
) {
2575 (void) printf("\t");
2582 right_justify
= B_FALSE
;
2583 if (pl
->pl_prop
!= ZPROP_INVAL
) {
2584 if (zpool_get_prop(zhp
, pl
->pl_prop
, property
,
2585 sizeof (property
), NULL
) != 0)
2590 right_justify
= zpool_prop_align_right(pl
->pl_prop
);
2595 width
= pl
->pl_width
;
2598 * If this is being called in scripted mode, or if this is the
2599 * last column and it is left-justified, don't include a width
2602 if (scripted
|| (pl
->pl_next
== NULL
&& !right_justify
))
2603 (void) printf("%s", propstr
);
2604 else if (right_justify
)
2605 (void) printf("%*s", width
, propstr
);
2607 (void) printf("%-*s", width
, propstr
);
2610 (void) printf("\n");
2614 * Generic callback function to list a pool.
2617 list_callback(zpool_handle_t
*zhp
, void *data
)
2619 list_cbdata_t
*cbp
= data
;
2621 if (cbp
->cb_first
) {
2622 if (!cbp
->cb_scripted
)
2623 print_header(cbp
->cb_proplist
);
2624 cbp
->cb_first
= B_FALSE
;
2627 print_pool(zhp
, cbp
->cb_proplist
, cbp
->cb_scripted
);
2633 * zpool list [-H] [-o prop[,prop]*] [-T d|u] [pool] ... [interval [count]]
2635 * -H Scripted mode. Don't display headers, and separate properties
2637 * -o List of properties to display. Defaults to
2638 * "name,size,allocated,free,capacity,health,altroot"
2639 * -T Display a timestamp in date(1) or Unix format
2641 * List all pools in the system, whether or not they're healthy. Output space
2642 * statistics for each one, as well as health status summary.
2645 zpool_do_list(int argc
, char **argv
)
2649 list_cbdata_t cb
= { 0 };
2650 static char default_props
[] =
2651 "name,size,allocated,free,capacity,dedupratio,health,altroot";
2652 char *props
= default_props
;
2653 unsigned long interval
= 0, count
= 0;
2656 while ((c
= getopt(argc
, argv
, ":Ho:T:")) != -1) {
2659 cb
.cb_scripted
= B_TRUE
;
2665 get_timestamp_arg(*optarg
);
2668 (void) fprintf(stderr
, gettext("missing argument for "
2669 "'%c' option\n"), optopt
);
2673 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
2682 get_interval_count(&argc
, argv
, &interval
, &count
);
2684 if (zprop_get_list(g_zfs
, props
, &cb
.cb_proplist
, ZFS_TYPE_POOL
) != 0)
2687 cb
.cb_first
= B_TRUE
;
2691 if (timestamp_fmt
!= NODATE
)
2692 print_timestamp(timestamp_fmt
);
2694 ret
= for_each_pool(argc
, argv
, B_TRUE
, &cb
.cb_proplist
,
2695 list_callback
, &cb
);
2697 if (argc
== 0 && cb
.cb_first
)
2698 (void) fprintf(stderr
, gettext("no pools available\n"));
2699 else if (argc
&& cb
.cb_first
) {
2700 /* cannot open the given pool */
2701 zprop_free_list(cb
.cb_proplist
);
2708 if (count
!= 0 && --count
== 0)
2711 (void) sleep(interval
);
2714 zprop_free_list(cb
.cb_proplist
);
2719 zpool_do_attach_or_replace(int argc
, char **argv
, int replacing
)
2721 boolean_t force
= B_FALSE
;
2724 char *poolname
, *old_disk
, *new_disk
;
2725 zpool_handle_t
*zhp
;
2729 while ((c
= getopt(argc
, argv
, "f")) != -1) {
2735 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
2744 /* get pool name and check number of arguments */
2746 (void) fprintf(stderr
, gettext("missing pool name argument\n"));
2753 (void) fprintf(stderr
,
2754 gettext("missing <device> specification\n"));
2762 (void) fprintf(stderr
,
2763 gettext("missing <new_device> specification\n"));
2766 new_disk
= old_disk
;
2776 (void) fprintf(stderr
, gettext("too many arguments\n"));
2780 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
2783 if (zpool_get_config(zhp
, NULL
) == NULL
) {
2784 (void) fprintf(stderr
, gettext("pool '%s' is unavailable\n"),
2790 nvroot
= make_root_vdev(zhp
, NULL
, force
, B_FALSE
, replacing
, B_FALSE
,
2792 if (nvroot
== NULL
) {
2797 ret
= zpool_vdev_attach(zhp
, old_disk
, new_disk
, nvroot
, replacing
);
2799 nvlist_free(nvroot
);
2806 * zpool replace [-f] <pool> <device> <new_device>
2808 * -f Force attach, even if <new_device> appears to be in use.
2810 * Replace <device> with <new_device>.
2814 zpool_do_replace(int argc
, char **argv
)
2816 return (zpool_do_attach_or_replace(argc
, argv
, B_TRUE
));
2820 * zpool attach [-f] <pool> <device> <new_device>
2822 * -f Force attach, even if <new_device> appears to be in use.
2824 * Attach <new_device> to the mirror containing <device>. If <device> is not
2825 * part of a mirror, then <device> will be transformed into a mirror of
2826 * <device> and <new_device>. In either case, <new_device> will begin life
2827 * with a DTL of [0, now], and will immediately begin to resilver itself.
2830 zpool_do_attach(int argc
, char **argv
)
2832 return (zpool_do_attach_or_replace(argc
, argv
, B_FALSE
));
2836 * zpool detach [-f] <pool> <device>
2838 * -f Force detach of <device>, even if DTLs argue against it
2839 * (not supported yet)
2841 * Detach a device from a mirror. The operation will be refused if <device>
2842 * is the last device in the mirror, or if the DTLs indicate that this device
2843 * has the only valid copy of some data.
2847 zpool_do_detach(int argc
, char **argv
)
2850 char *poolname
, *path
;
2851 zpool_handle_t
*zhp
;
2855 while ((c
= getopt(argc
, argv
, "f")) != -1) {
2859 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
2868 /* get pool name and check number of arguments */
2870 (void) fprintf(stderr
, gettext("missing pool name argument\n"));
2875 (void) fprintf(stderr
,
2876 gettext("missing <device> specification\n"));
2883 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
2886 ret
= zpool_vdev_detach(zhp
, path
);
2894 * zpool split [-n] [-o prop=val] ...
2896 * [-R altroot] <pool> <newpool> [<device> ...]
2898 * -n Do not split the pool, but display the resulting layout if
2899 * it were to be split.
2900 * -o Set property=value, or set mount options.
2901 * -R Mount the split-off pool under an alternate root.
2903 * Splits the named pool and gives it the new pool name. Devices to be split
2904 * off may be listed, provided that no more than one device is specified
2905 * per top-level vdev mirror. The newly split pool is left in an exported
2906 * state unless -R is specified.
2908 * Restrictions: the top-level of the pool pool must only be made up of
2909 * mirrors; all devices in the pool must be healthy; no device may be
2910 * undergoing a resilvering operation.
2913 zpool_do_split(int argc
, char **argv
)
2915 char *srcpool
, *newpool
, *propval
;
2916 char *mntopts
= NULL
;
2919 zpool_handle_t
*zhp
;
2920 nvlist_t
*config
, *props
= NULL
;
2922 flags
.dryrun
= B_FALSE
;
2923 flags
.import
= B_FALSE
;
2926 while ((c
= getopt(argc
, argv
, ":R:no:")) != -1) {
2929 flags
.import
= B_TRUE
;
2931 zpool_prop_to_name(ZPOOL_PROP_ALTROOT
), optarg
,
2932 &props
, B_TRUE
) != 0) {
2939 flags
.dryrun
= B_TRUE
;
2942 if ((propval
= strchr(optarg
, '=')) != NULL
) {
2945 if (add_prop_list(optarg
, propval
,
2946 &props
, B_TRUE
) != 0) {
2956 (void) fprintf(stderr
, gettext("missing argument for "
2957 "'%c' option\n"), optopt
);
2961 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
2968 if (!flags
.import
&& mntopts
!= NULL
) {
2969 (void) fprintf(stderr
, gettext("setting mntopts is only "
2970 "valid when importing the pool\n"));
2978 (void) fprintf(stderr
, gettext("Missing pool name\n"));
2982 (void) fprintf(stderr
, gettext("Missing new pool name\n"));
2992 if ((zhp
= zpool_open(g_zfs
, srcpool
)) == NULL
)
2995 config
= split_mirror_vdev(zhp
, newpool
, props
, flags
, argc
, argv
);
2996 if (config
== NULL
) {
3000 (void) printf(gettext("would create '%s' with the "
3001 "following layout:\n\n"), newpool
);
3002 print_vdev_tree(NULL
, newpool
, config
, 0, B_FALSE
);
3004 nvlist_free(config
);
3009 if (ret
!= 0 || flags
.dryrun
|| !flags
.import
)
3013 * The split was successful. Now we need to open the new
3014 * pool and import it.
3016 if ((zhp
= zpool_open_canfail(g_zfs
, newpool
)) == NULL
)
3018 if (zpool_get_state(zhp
) != POOL_STATE_UNAVAIL
&&
3019 zpool_enable_datasets(zhp
, mntopts
, 0) != 0) {
3021 (void) fprintf(stderr
, gettext("Split was successful, but "
3022 "the datasets could not all be mounted\n"));
3023 (void) fprintf(stderr
, gettext("Try doing '%s' with a "
3024 "different altroot\n"), "zpool import");
3034 * zpool online <pool> <device> ...
3037 zpool_do_online(int argc
, char **argv
)
3041 zpool_handle_t
*zhp
;
3043 vdev_state_t newstate
;
3047 while ((c
= getopt(argc
, argv
, "et")) != -1) {
3050 flags
|= ZFS_ONLINE_EXPAND
;
3054 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3063 /* get pool name and check number of arguments */
3065 (void) fprintf(stderr
, gettext("missing pool name\n"));
3069 (void) fprintf(stderr
, gettext("missing device name\n"));
3075 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
3078 for (i
= 1; i
< argc
; i
++) {
3079 if (zpool_vdev_online(zhp
, argv
[i
], flags
, &newstate
) == 0) {
3080 if (newstate
!= VDEV_STATE_HEALTHY
) {
3081 (void) printf(gettext("warning: device '%s' "
3082 "onlined, but remains in faulted state\n"),
3084 if (newstate
== VDEV_STATE_FAULTED
)
3085 (void) printf(gettext("use 'zpool "
3086 "clear' to restore a faulted "
3089 (void) printf(gettext("use 'zpool "
3090 "replace' to replace devices "
3091 "that are no longer present\n"));
3104 * zpool offline [-ft] <pool> <device> ...
3106 * -f Force the device into the offline state, even if doing
3107 * so would appear to compromise pool availability.
3108 * (not supported yet)
3110 * -t Only take the device off-line temporarily. The offline
3111 * state will not be persistent across reboots.
3115 zpool_do_offline(int argc
, char **argv
)
3119 zpool_handle_t
*zhp
;
3121 boolean_t istmp
= B_FALSE
;
3124 while ((c
= getopt(argc
, argv
, "ft")) != -1) {
3131 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3140 /* get pool name and check number of arguments */
3142 (void) fprintf(stderr
, gettext("missing pool name\n"));
3146 (void) fprintf(stderr
, gettext("missing device name\n"));
3152 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
3155 for (i
= 1; i
< argc
; i
++) {
3156 if (zpool_vdev_offline(zhp
, argv
[i
], istmp
) != 0)
3166 * zpool clear <pool> [device]
3168 * Clear all errors associated with a pool or a particular device.
3171 zpool_do_clear(int argc
, char **argv
)
3175 boolean_t dryrun
= B_FALSE
;
3176 boolean_t do_rewind
= B_FALSE
;
3177 boolean_t xtreme_rewind
= B_FALSE
;
3178 uint32_t rewind_policy
= ZPOOL_NO_REWIND
;
3179 nvlist_t
*policy
= NULL
;
3180 zpool_handle_t
*zhp
;
3181 char *pool
, *device
;
3184 while ((c
= getopt(argc
, argv
, "FnX")) != -1) {
3193 xtreme_rewind
= B_TRUE
;
3196 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3206 (void) fprintf(stderr
, gettext("missing pool name\n"));
3211 (void) fprintf(stderr
, gettext("too many arguments\n"));
3215 if ((dryrun
|| xtreme_rewind
) && !do_rewind
) {
3216 (void) fprintf(stderr
,
3217 gettext("-n or -X only meaningful with -F\n"));
3221 rewind_policy
= ZPOOL_TRY_REWIND
;
3223 rewind_policy
= ZPOOL_DO_REWIND
;
3225 rewind_policy
|= ZPOOL_EXTREME_REWIND
;
3227 /* In future, further rewind policy choices can be passed along here */
3228 if (nvlist_alloc(&policy
, NV_UNIQUE_NAME
, 0) != 0 ||
3229 nvlist_add_uint32(policy
, ZPOOL_REWIND_REQUEST
, rewind_policy
) != 0)
3233 device
= argc
== 2 ? argv
[1] : NULL
;
3235 if ((zhp
= zpool_open_canfail(g_zfs
, pool
)) == NULL
) {
3236 nvlist_free(policy
);
3240 if (zpool_clear(zhp
, device
, policy
) != 0)
3245 nvlist_free(policy
);
3251 * zpool reguid <pool>
3254 zpool_do_reguid(int argc
, char **argv
)
3258 zpool_handle_t
*zhp
;
3262 while ((c
= getopt(argc
, argv
, "")) != -1) {
3265 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3274 /* get pool name and check number of arguments */
3276 (void) fprintf(stderr
, gettext("missing pool name\n"));
3281 (void) fprintf(stderr
, gettext("too many arguments\n"));
3286 if ((zhp
= zpool_open(g_zfs
, poolname
)) == NULL
)
3289 ret
= zpool_reguid(zhp
);
3296 typedef struct scrub_cbdata
{
3303 scrub_callback(zpool_handle_t
*zhp
, void *data
)
3305 scrub_cbdata_t
*cb
= data
;
3309 * Ignore faulted pools.
3311 if (zpool_get_state(zhp
) == POOL_STATE_UNAVAIL
) {
3312 (void) fprintf(stderr
, gettext("cannot scrub '%s': pool is "
3313 "currently unavailable\n"), zpool_get_name(zhp
));
3317 err
= zpool_scan(zhp
, cb
->cb_type
);
3323 * zpool scrub [-s] <pool> ...
3325 * -s Stop. Stops any in-progress scrub.
3328 zpool_do_scrub(int argc
, char **argv
)
3333 cb
.cb_type
= POOL_SCAN_SCRUB
;
3336 while ((c
= getopt(argc
, argv
, "s")) != -1) {
3339 cb
.cb_type
= POOL_SCAN_NONE
;
3342 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3354 (void) fprintf(stderr
, gettext("missing pool name argument\n"));
3358 return (for_each_pool(argc
, argv
, B_TRUE
, NULL
, scrub_callback
, &cb
));
3361 typedef struct status_cbdata
{
3363 boolean_t cb_allpools
;
3364 boolean_t cb_verbose
;
3365 boolean_t cb_explain
;
3367 boolean_t cb_dedup_stats
;
3371 * Print out detailed scrub status.
3374 print_scan_status(pool_scan_stat_t
*ps
)
3377 uint64_t elapsed
, mins_left
, hours_left
;
3378 uint64_t pass_exam
, examined
, total
;
3380 double fraction_done
;
3381 char processed_buf
[7], examined_buf
[7], total_buf
[7], rate_buf
[7];
3383 (void) printf(gettext(" scan: "));
3385 /* If there's never been a scan, there's not much to say. */
3386 if (ps
== NULL
|| ps
->pss_func
== POOL_SCAN_NONE
||
3387 ps
->pss_func
>= POOL_SCAN_FUNCS
) {
3388 (void) printf(gettext("none requested\n"));
3392 start
= ps
->pss_start_time
;
3393 end
= ps
->pss_end_time
;
3394 zfs_nicenum(ps
->pss_processed
, processed_buf
, sizeof (processed_buf
));
3396 assert(ps
->pss_func
== POOL_SCAN_SCRUB
||
3397 ps
->pss_func
== POOL_SCAN_RESILVER
);
3399 * Scan is finished or canceled.
3401 if (ps
->pss_state
== DSS_FINISHED
) {
3402 uint64_t minutes_taken
= (end
- start
) / 60;
3405 if (ps
->pss_func
== POOL_SCAN_SCRUB
) {
3406 fmt
= gettext("scrub repaired %s in %lluh%um with "
3407 "%llu errors on %s");
3408 } else if (ps
->pss_func
== POOL_SCAN_RESILVER
) {
3409 fmt
= gettext("resilvered %s in %lluh%um with "
3410 "%llu errors on %s");
3413 (void) printf(fmt
, processed_buf
,
3414 (u_longlong_t
)(minutes_taken
/ 60),
3415 (uint_t
)(minutes_taken
% 60),
3416 (u_longlong_t
)ps
->pss_errors
,
3417 ctime((time_t *)&end
));
3419 } else if (ps
->pss_state
== DSS_CANCELED
) {
3420 if (ps
->pss_func
== POOL_SCAN_SCRUB
) {
3421 (void) printf(gettext("scrub canceled on %s"),
3423 } else if (ps
->pss_func
== POOL_SCAN_RESILVER
) {
3424 (void) printf(gettext("resilver canceled on %s"),
3430 assert(ps
->pss_state
== DSS_SCANNING
);
3433 * Scan is in progress.
3435 if (ps
->pss_func
== POOL_SCAN_SCRUB
) {
3436 (void) printf(gettext("scrub in progress since %s"),
3438 } else if (ps
->pss_func
== POOL_SCAN_RESILVER
) {
3439 (void) printf(gettext("resilver in progress since %s"),
3443 examined
= ps
->pss_examined
? ps
->pss_examined
: 1;
3444 total
= ps
->pss_to_examine
;
3445 fraction_done
= (double)examined
/ total
;
3447 /* elapsed time for this pass */
3448 elapsed
= time(NULL
) - ps
->pss_pass_start
;
3449 elapsed
= elapsed
? elapsed
: 1;
3450 pass_exam
= ps
->pss_pass_exam
? ps
->pss_pass_exam
: 1;
3451 rate
= pass_exam
/ elapsed
;
3452 rate
= rate
? rate
: 1;
3453 mins_left
= ((total
- examined
) / rate
) / 60;
3454 hours_left
= mins_left
/ 60;
3456 zfs_nicenum(examined
, examined_buf
, sizeof (examined_buf
));
3457 zfs_nicenum(total
, total_buf
, sizeof (total_buf
));
3458 zfs_nicenum(rate
, rate_buf
, sizeof (rate_buf
));
3461 * do not print estimated time if hours_left is more than 30 days
3463 (void) printf(gettext(" %s scanned out of %s at %s/s"),
3464 examined_buf
, total_buf
, rate_buf
);
3465 if (hours_left
< (30 * 24)) {
3466 (void) printf(gettext(", %lluh%um to go\n"),
3467 (u_longlong_t
)hours_left
, (uint_t
)(mins_left
% 60));
3469 (void) printf(gettext(
3470 ", (scan is slow, no estimated time)\n"));
3473 if (ps
->pss_func
== POOL_SCAN_RESILVER
) {
3474 (void) printf(gettext(" %s resilvered, %.2f%% done\n"),
3475 processed_buf
, 100 * fraction_done
);
3476 } else if (ps
->pss_func
== POOL_SCAN_SCRUB
) {
3477 (void) printf(gettext(" %s repaired, %.2f%% done\n"),
3478 processed_buf
, 100 * fraction_done
);
3483 print_error_log(zpool_handle_t
*zhp
)
3485 nvlist_t
*nverrlist
= NULL
;
3488 size_t len
= MAXPATHLEN
* 2;
3490 if (zpool_get_errlog(zhp
, &nverrlist
) != 0) {
3491 (void) printf("errors: List of errors unavailable "
3492 "(insufficient privileges)\n");
3496 (void) printf("errors: Permanent errors have been "
3497 "detected in the following files:\n\n");
3499 pathname
= safe_malloc(len
);
3501 while ((elem
= nvlist_next_nvpair(nverrlist
, elem
)) != NULL
) {
3503 uint64_t dsobj
, obj
;
3505 verify(nvpair_value_nvlist(elem
, &nv
) == 0);
3506 verify(nvlist_lookup_uint64(nv
, ZPOOL_ERR_DATASET
,
3508 verify(nvlist_lookup_uint64(nv
, ZPOOL_ERR_OBJECT
,
3510 zpool_obj_to_path(zhp
, dsobj
, obj
, pathname
, len
);
3511 (void) printf("%7s %s\n", "", pathname
);
3514 nvlist_free(nverrlist
);
3518 print_spares(zpool_handle_t
*zhp
, nvlist_t
**spares
, uint_t nspares
,
3527 (void) printf(gettext("\tspares\n"));
3529 for (i
= 0; i
< nspares
; i
++) {
3530 name
= zpool_vdev_name(g_zfs
, zhp
, spares
[i
], B_FALSE
);
3531 print_status_config(zhp
, name
, spares
[i
],
3532 namewidth
, 2, B_TRUE
);
3538 print_l2cache(zpool_handle_t
*zhp
, nvlist_t
**l2cache
, uint_t nl2cache
,
3547 (void) printf(gettext("\tcache\n"));
3549 for (i
= 0; i
< nl2cache
; i
++) {
3550 name
= zpool_vdev_name(g_zfs
, zhp
, l2cache
[i
], B_FALSE
);
3551 print_status_config(zhp
, name
, l2cache
[i
],
3552 namewidth
, 2, B_FALSE
);
3558 print_dedup_stats(nvlist_t
*config
)
3560 ddt_histogram_t
*ddh
;
3566 * If the pool was faulted then we may not have been able to
3567 * obtain the config. Otherwise, if have anything in the dedup
3568 * table continue processing the stats.
3570 if (nvlist_lookup_uint64_array(config
, ZPOOL_CONFIG_DDT_OBJ_STATS
,
3571 (uint64_t **)&ddo
, &c
) != 0 || ddo
->ddo_count
== 0)
3574 (void) printf("\n");
3575 (void) printf("DDT entries %llu, size %llu on disk, %llu in core\n",
3576 (u_longlong_t
)ddo
->ddo_count
,
3577 (u_longlong_t
)ddo
->ddo_dspace
,
3578 (u_longlong_t
)ddo
->ddo_mspace
);
3580 verify(nvlist_lookup_uint64_array(config
, ZPOOL_CONFIG_DDT_STATS
,
3581 (uint64_t **)&dds
, &c
) == 0);
3582 verify(nvlist_lookup_uint64_array(config
, ZPOOL_CONFIG_DDT_HISTOGRAM
,
3583 (uint64_t **)&ddh
, &c
) == 0);
3584 zpool_dump_ddt(dds
, ddh
);
3588 * Display a summary of pool status. Displays a summary such as:
3592 * reason: One or more devices ...
3593 * see: http://zfsonlinux.org/msg/ZFS-xxxx-01
3599 * When given the '-v' option, we print out the complete config. If the '-e'
3600 * option is specified, then we print out error rate information as well.
3603 status_callback(zpool_handle_t
*zhp
, void *data
)
3605 status_cbdata_t
*cbp
= data
;
3606 nvlist_t
*config
, *nvroot
;
3613 config
= zpool_get_config(zhp
, NULL
);
3614 reason
= zpool_get_status(zhp
, &msgid
);
3619 * If we were given 'zpool status -x', only report those pools with
3622 if (reason
== ZPOOL_STATUS_OK
&& cbp
->cb_explain
) {
3623 if (!cbp
->cb_allpools
) {
3624 (void) printf(gettext("pool '%s' is healthy\n"),
3625 zpool_get_name(zhp
));
3627 cbp
->cb_first
= B_FALSE
;
3633 cbp
->cb_first
= B_FALSE
;
3635 (void) printf("\n");
3637 verify(nvlist_lookup_nvlist(config
, ZPOOL_CONFIG_VDEV_TREE
,
3639 verify(nvlist_lookup_uint64_array(nvroot
, ZPOOL_CONFIG_VDEV_STATS
,
3640 (uint64_t **)&vs
, &c
) == 0);
3641 health
= zpool_state_to_name(vs
->vs_state
, vs
->vs_aux
);
3643 (void) printf(gettext(" pool: %s\n"), zpool_get_name(zhp
));
3644 (void) printf(gettext(" state: %s\n"), health
);
3647 case ZPOOL_STATUS_MISSING_DEV_R
:
3648 (void) printf(gettext("status: One or more devices could not "
3649 "be opened. Sufficient replicas exist for\n\tthe pool to "
3650 "continue functioning in a degraded state.\n"));
3651 (void) printf(gettext("action: Attach the missing device and "
3652 "online it using 'zpool online'.\n"));
3655 case ZPOOL_STATUS_MISSING_DEV_NR
:
3656 (void) printf(gettext("status: One or more devices could not "
3657 "be opened. There are insufficient\n\treplicas for the "
3658 "pool to continue functioning.\n"));
3659 (void) printf(gettext("action: Attach the missing device and "
3660 "online it using 'zpool online'.\n"));
3663 case ZPOOL_STATUS_CORRUPT_LABEL_R
:
3664 (void) printf(gettext("status: One or more devices could not "
3665 "be used because the label is missing or\n\tinvalid. "
3666 "Sufficient replicas exist for the pool to continue\n\t"
3667 "functioning in a degraded state.\n"));
3668 (void) printf(gettext("action: Replace the device using "
3669 "'zpool replace'.\n"));
3672 case ZPOOL_STATUS_CORRUPT_LABEL_NR
:
3673 (void) printf(gettext("status: One or more devices could not "
3674 "be used because the label is missing \n\tor invalid. "
3675 "There are insufficient replicas for the pool to "
3676 "continue\n\tfunctioning.\n"));
3677 zpool_explain_recover(zpool_get_handle(zhp
),
3678 zpool_get_name(zhp
), reason
, config
);
3681 case ZPOOL_STATUS_FAILING_DEV
:
3682 (void) printf(gettext("status: One or more devices has "
3683 "experienced an unrecoverable error. An\n\tattempt was "
3684 "made to correct the error. Applications are "
3686 (void) printf(gettext("action: Determine if the device needs "
3687 "to be replaced, and clear the errors\n\tusing "
3688 "'zpool clear' or replace the device with 'zpool "
3692 case ZPOOL_STATUS_OFFLINE_DEV
:
3693 (void) printf(gettext("status: One or more devices has "
3694 "been taken offline by the administrator.\n\tSufficient "
3695 "replicas exist for the pool to continue functioning in "
3696 "a\n\tdegraded state.\n"));
3697 (void) printf(gettext("action: Online the device using "
3698 "'zpool online' or replace the device with\n\t'zpool "
3702 case ZPOOL_STATUS_REMOVED_DEV
:
3703 (void) printf(gettext("status: One or more devices has "
3704 "been removed by the administrator.\n\tSufficient "
3705 "replicas exist for the pool to continue functioning in "
3706 "a\n\tdegraded state.\n"));
3707 (void) printf(gettext("action: Online the device using "
3708 "'zpool online' or replace the device with\n\t'zpool "
3712 case ZPOOL_STATUS_RESILVERING
:
3713 (void) printf(gettext("status: One or more devices is "
3714 "currently being resilvered. The pool will\n\tcontinue "
3715 "to function, possibly in a degraded state.\n"));
3716 (void) printf(gettext("action: Wait for the resilver to "
3720 case ZPOOL_STATUS_CORRUPT_DATA
:
3721 (void) printf(gettext("status: One or more devices has "
3722 "experienced an error resulting in data\n\tcorruption. "
3723 "Applications may be affected.\n"));
3724 (void) printf(gettext("action: Restore the file in question "
3725 "if possible. Otherwise restore the\n\tentire pool from "
3729 case ZPOOL_STATUS_CORRUPT_POOL
:
3730 (void) printf(gettext("status: The pool metadata is corrupted "
3731 "and the pool cannot be opened.\n"));
3732 zpool_explain_recover(zpool_get_handle(zhp
),
3733 zpool_get_name(zhp
), reason
, config
);
3736 case ZPOOL_STATUS_VERSION_OLDER
:
3737 (void) printf(gettext("status: The pool is formatted using an "
3738 "older on-disk format. The pool can\n\tstill be used, but "
3739 "some features are unavailable.\n"));
3740 (void) printf(gettext("action: Upgrade the pool using 'zpool "
3741 "upgrade'. Once this is done, the\n\tpool will no longer "
3742 "be accessible on older software versions.\n"));
3745 case ZPOOL_STATUS_VERSION_NEWER
:
3746 (void) printf(gettext("status: The pool has been upgraded to a "
3747 "newer, incompatible on-disk version.\n\tThe pool cannot "
3748 "be accessed on this system.\n"));
3749 (void) printf(gettext("action: Access the pool from a system "
3750 "running more recent software, or\n\trestore the pool from "
3754 case ZPOOL_STATUS_FAULTED_DEV_R
:
3755 (void) printf(gettext("status: One or more devices are "
3756 "faulted in response to persistent errors.\n\tSufficient "
3757 "replicas exist for the pool to continue functioning "
3758 "in a\n\tdegraded state.\n"));
3759 (void) printf(gettext("action: Replace the faulted device, "
3760 "or use 'zpool clear' to mark the device\n\trepaired.\n"));
3763 case ZPOOL_STATUS_FAULTED_DEV_NR
:
3764 (void) printf(gettext("status: One or more devices are "
3765 "faulted in response to persistent errors. There are "
3766 "insufficient replicas for the pool to\n\tcontinue "
3768 (void) printf(gettext("action: Destroy and re-create the pool "
3769 "from a backup source. Manually marking the device\n"
3770 "\trepaired using 'zpool clear' may allow some data "
3771 "to be recovered.\n"));
3774 case ZPOOL_STATUS_IO_FAILURE_WAIT
:
3775 case ZPOOL_STATUS_IO_FAILURE_CONTINUE
:
3776 (void) printf(gettext("status: One or more devices are "
3777 "faulted in response to IO failures.\n"));
3778 (void) printf(gettext("action: Make sure the affected devices "
3779 "are connected, then run 'zpool clear'.\n"));
3782 case ZPOOL_STATUS_BAD_LOG
:
3783 (void) printf(gettext("status: An intent log record "
3784 "could not be read.\n"
3785 "\tWaiting for adminstrator intervention to fix the "
3786 "faulted pool.\n"));
3787 (void) printf(gettext("action: Either restore the affected "
3788 "device(s) and run 'zpool online',\n"
3789 "\tor ignore the intent log records by running "
3790 "'zpool clear'.\n"));
3795 * The remaining errors can't actually be generated, yet.
3797 assert(reason
== ZPOOL_STATUS_OK
);
3801 (void) printf(gettext(" see: http://zfsonlinux.org/msg/%s\n"),
3804 if (config
!= NULL
) {
3807 nvlist_t
**spares
, **l2cache
;
3808 uint_t nspares
, nl2cache
;
3809 pool_scan_stat_t
*ps
= NULL
;
3811 (void) nvlist_lookup_uint64_array(nvroot
,
3812 ZPOOL_CONFIG_SCAN_STATS
, (uint64_t **)&ps
, &c
);
3813 print_scan_status(ps
);
3815 namewidth
= max_width(zhp
, nvroot
, 0, 0);
3819 (void) printf(gettext("config:\n\n"));
3820 (void) printf(gettext("\t%-*s %-8s %5s %5s %5s\n"), namewidth
,
3821 "NAME", "STATE", "READ", "WRITE", "CKSUM");
3822 print_status_config(zhp
, zpool_get_name(zhp
), nvroot
,
3823 namewidth
, 0, B_FALSE
);
3825 if (num_logs(nvroot
) > 0)
3826 print_logs(zhp
, nvroot
, namewidth
, B_TRUE
);
3827 if (nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_L2CACHE
,
3828 &l2cache
, &nl2cache
) == 0)
3829 print_l2cache(zhp
, l2cache
, nl2cache
, namewidth
);
3831 if (nvlist_lookup_nvlist_array(nvroot
, ZPOOL_CONFIG_SPARES
,
3832 &spares
, &nspares
) == 0)
3833 print_spares(zhp
, spares
, nspares
, namewidth
);
3835 if (nvlist_lookup_uint64(config
, ZPOOL_CONFIG_ERRCOUNT
,
3837 nvlist_t
*nverrlist
= NULL
;
3840 * If the approximate error count is small, get a
3841 * precise count by fetching the entire log and
3842 * uniquifying the results.
3844 if (nerr
> 0 && nerr
< 100 && !cbp
->cb_verbose
&&
3845 zpool_get_errlog(zhp
, &nverrlist
) == 0) {
3850 while ((elem
= nvlist_next_nvpair(nverrlist
,
3855 nvlist_free(nverrlist
);
3857 (void) printf("\n");
3860 (void) printf(gettext("errors: No known data "
3862 else if (!cbp
->cb_verbose
)
3863 (void) printf(gettext("errors: %llu data "
3864 "errors, use '-v' for a list\n"),
3865 (u_longlong_t
)nerr
);
3867 print_error_log(zhp
);
3870 if (cbp
->cb_dedup_stats
)
3871 print_dedup_stats(config
);
3873 (void) printf(gettext("config: The configuration cannot be "
3881 * zpool status [-vx] [-T d|u] [pool] ... [interval [count]]
3883 * -v Display complete error logs
3884 * -x Display only pools with potential problems
3885 * -D Display dedup status (undocumented)
3886 * -T Display a timestamp in date(1) or Unix format
3888 * Describes the health status of all pools or some subset.
3891 zpool_do_status(int argc
, char **argv
)
3895 unsigned long interval
= 0, count
= 0;
3896 status_cbdata_t cb
= { 0 };
3899 while ((c
= getopt(argc
, argv
, "vxDT:")) != -1) {
3902 cb
.cb_verbose
= B_TRUE
;
3905 cb
.cb_explain
= B_TRUE
;
3908 cb
.cb_dedup_stats
= B_TRUE
;
3911 get_timestamp_arg(*optarg
);
3914 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
3923 get_interval_count(&argc
, argv
, &interval
, &count
);
3926 cb
.cb_allpools
= B_TRUE
;
3928 cb
.cb_first
= B_TRUE
;
3931 if (timestamp_fmt
!= NODATE
)
3932 print_timestamp(timestamp_fmt
);
3934 ret
= for_each_pool(argc
, argv
, B_TRUE
, NULL
,
3935 status_callback
, &cb
);
3937 if (argc
== 0 && cb
.cb_count
== 0)
3938 (void) fprintf(stderr
, gettext("no pools available\n"));
3939 else if (cb
.cb_explain
&& cb
.cb_first
&& cb
.cb_allpools
)
3940 (void) printf(gettext("all pools are healthy\n"));
3948 if (count
!= 0 && --count
== 0)
3951 (void) sleep(interval
);
3957 typedef struct upgrade_cbdata
{
3962 uint64_t cb_version
;
3967 upgrade_cb(zpool_handle_t
*zhp
, void *arg
)
3969 upgrade_cbdata_t
*cbp
= arg
;
3974 config
= zpool_get_config(zhp
, NULL
);
3975 verify(nvlist_lookup_uint64(config
, ZPOOL_CONFIG_VERSION
,
3978 if (!cbp
->cb_newer
&& version
< SPA_VERSION
) {
3980 if (cbp
->cb_first
) {
3981 (void) printf(gettext("The following pools are "
3982 "out of date, and can be upgraded. After "
3983 "being\nupgraded, these pools will no "
3984 "longer be accessible by older software "
3986 (void) printf(gettext("VER POOL\n"));
3987 (void) printf(gettext("--- ------------\n"));
3988 cbp
->cb_first
= B_FALSE
;
3991 (void) printf("%2llu %s\n", (u_longlong_t
)version
,
3992 zpool_get_name(zhp
));
3994 cbp
->cb_first
= B_FALSE
;
3995 ret
= zpool_upgrade(zhp
, cbp
->cb_version
);
3997 (void) printf(gettext("Successfully upgraded "
3998 "'%s'\n\n"), zpool_get_name(zhp
));
4001 } else if (cbp
->cb_newer
&& version
> SPA_VERSION
) {
4002 assert(!cbp
->cb_all
);
4004 if (cbp
->cb_first
) {
4005 (void) printf(gettext("The following pools are "
4006 "formatted using a newer software version and\n"
4007 "cannot be accessed on the current system.\n\n"));
4008 (void) printf(gettext("VER POOL\n"));
4009 (void) printf(gettext("--- ------------\n"));
4010 cbp
->cb_first
= B_FALSE
;
4013 (void) printf("%2llu %s\n", (u_longlong_t
)version
,
4014 zpool_get_name(zhp
));
4023 upgrade_one(zpool_handle_t
*zhp
, void *data
)
4025 upgrade_cbdata_t
*cbp
= data
;
4026 uint64_t cur_version
;
4029 if (strcmp("log", zpool_get_name(zhp
)) == 0) {
4030 (void) printf(gettext("'log' is now a reserved word\n"
4031 "Pool 'log' must be renamed using export and import"
4036 cur_version
= zpool_get_prop_int(zhp
, ZPOOL_PROP_VERSION
, NULL
);
4037 if (cur_version
> cbp
->cb_version
) {
4038 (void) printf(gettext("Pool '%s' is already formatted "
4039 "using more current version '%llu'.\n"),
4040 zpool_get_name(zhp
), (u_longlong_t
) cur_version
);
4043 if (cur_version
== cbp
->cb_version
) {
4044 (void) printf(gettext("Pool '%s' is already formatted "
4045 "using the current version.\n"), zpool_get_name(zhp
));
4049 ret
= zpool_upgrade(zhp
, cbp
->cb_version
);
4052 (void) printf(gettext("Successfully upgraded '%s' "
4053 "from version %llu to version %llu\n\n"),
4054 zpool_get_name(zhp
), (u_longlong_t
)cur_version
,
4055 (u_longlong_t
)cbp
->cb_version
);
4064 * zpool upgrade [-V version] <-a | pool ...>
4066 * With no arguments, display downrev'd ZFS pool available for upgrade.
4067 * Individual pools can be upgraded by specifying the pool, and '-a' will
4068 * upgrade all pools.
4071 zpool_do_upgrade(int argc
, char **argv
)
4074 upgrade_cbdata_t cb
= { 0 };
4076 boolean_t showversions
= B_FALSE
;
4081 while ((c
= getopt(argc
, argv
, ":avV:")) != -1) {
4087 showversions
= B_TRUE
;
4090 cb
.cb_version
= strtoll(optarg
, &end
, 10);
4091 if (*end
!= '\0' || cb
.cb_version
> SPA_VERSION
||
4092 cb
.cb_version
< SPA_VERSION_1
) {
4093 (void) fprintf(stderr
,
4094 gettext("invalid version '%s'\n"), optarg
);
4099 (void) fprintf(stderr
, gettext("missing argument for "
4100 "'%c' option\n"), optopt
);
4104 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
4115 if (cb
.cb_version
== 0) {
4116 cb
.cb_version
= SPA_VERSION
;
4117 } else if (!cb
.cb_all
&& argc
== 0) {
4118 (void) fprintf(stderr
, gettext("-V option is "
4119 "incompatible with other arguments\n"));
4124 if (cb
.cb_all
|| argc
!= 0) {
4125 (void) fprintf(stderr
, gettext("-v option is "
4126 "incompatible with other arguments\n"));
4129 } else if (cb
.cb_all
) {
4131 (void) fprintf(stderr
, gettext("-a option should not "
4132 "be used along with a pool name\n"));
4137 (void) printf(gettext("This system is currently running "
4138 "ZFS pool version %llu.\n\n"), SPA_VERSION
);
4139 cb
.cb_first
= B_TRUE
;
4141 (void) printf(gettext("The following versions are "
4143 (void) printf(gettext("VER DESCRIPTION\n"));
4144 (void) printf("--- -----------------------------------------"
4145 "---------------\n");
4146 (void) printf(gettext(" 1 Initial ZFS version\n"));
4147 (void) printf(gettext(" 2 Ditto blocks "
4148 "(replicated metadata)\n"));
4149 (void) printf(gettext(" 3 Hot spares and double parity "
4151 (void) printf(gettext(" 4 zpool history\n"));
4152 (void) printf(gettext(" 5 Compression using the gzip "
4154 (void) printf(gettext(" 6 bootfs pool property\n"));
4155 (void) printf(gettext(" 7 Separate intent log devices\n"));
4156 (void) printf(gettext(" 8 Delegated administration\n"));
4157 (void) printf(gettext(" 9 refquota and refreservation "
4159 (void) printf(gettext(" 10 Cache devices\n"));
4160 (void) printf(gettext(" 11 Improved scrub performance\n"));
4161 (void) printf(gettext(" 12 Snapshot properties\n"));
4162 (void) printf(gettext(" 13 snapused property\n"));
4163 (void) printf(gettext(" 14 passthrough-x aclinherit\n"));
4164 (void) printf(gettext(" 15 user/group space accounting\n"));
4165 (void) printf(gettext(" 16 stmf property support\n"));
4166 (void) printf(gettext(" 17 Triple-parity RAID-Z\n"));
4167 (void) printf(gettext(" 18 Snapshot user holds\n"));
4168 (void) printf(gettext(" 19 Log device removal\n"));
4169 (void) printf(gettext(" 20 Compression using zle "
4170 "(zero-length encoding)\n"));
4171 (void) printf(gettext(" 21 Deduplication\n"));
4172 (void) printf(gettext(" 22 Received properties\n"));
4173 (void) printf(gettext(" 23 Slim ZIL\n"));
4174 (void) printf(gettext(" 24 System attributes\n"));
4175 (void) printf(gettext(" 25 Improved scrub stats\n"));
4176 (void) printf(gettext(" 26 Improved snapshot deletion "
4178 (void) printf(gettext(" 27 Improved snapshot creation "
4180 (void) printf(gettext(" 28 Multiple vdev replacements\n"));
4181 (void) printf(gettext("\nFor more information on a particular "
4182 "version, including supported releases,\n"));
4183 (void) printf(gettext("see the ZFS Administration Guide.\n\n"));
4184 } else if (argc
== 0) {
4187 ret
= zpool_iter(g_zfs
, upgrade_cb
, &cb
);
4188 notfound
= cb
.cb_first
;
4190 if (!cb
.cb_all
&& ret
== 0) {
4192 (void) printf("\n");
4193 cb
.cb_first
= B_TRUE
;
4194 cb
.cb_newer
= B_TRUE
;
4195 ret
= zpool_iter(g_zfs
, upgrade_cb
, &cb
);
4198 (void) printf("\n");
4204 (void) printf(gettext("All pools are formatted "
4205 "using this version.\n"));
4206 else if (!cb
.cb_all
)
4207 (void) printf(gettext("Use 'zpool upgrade -v' "
4208 "for a list of available versions and "
4209 "their associated\nfeatures.\n"));
4212 ret
= for_each_pool(argc
, argv
, B_FALSE
, NULL
,
4219 typedef struct hist_cbdata
{
4226 * Print out the command history for a specific pool.
4229 get_history_one(zpool_handle_t
*zhp
, void *data
)
4245 char internalstr
[MAXPATHLEN
];
4246 hist_cbdata_t
*cb
= (hist_cbdata_t
*)data
;
4250 cb
->first
= B_FALSE
;
4252 (void) printf(gettext("History for '%s':\n"), zpool_get_name(zhp
));
4254 if ((ret
= zpool_get_history(zhp
, &nvhis
)) != 0)
4257 verify(nvlist_lookup_nvlist_array(nvhis
, ZPOOL_HIST_RECORD
,
4258 &records
, &numrecords
) == 0);
4259 for (i
= 0; i
< numrecords
; i
++) {
4260 if (nvlist_lookup_uint64(records
[i
], ZPOOL_HIST_TIME
,
4264 /* is it an internal event or a standard event? */
4265 if (nvlist_lookup_string(records
[i
], ZPOOL_HIST_CMD
,
4267 if (cb
->internal
== 0)
4270 if (nvlist_lookup_uint64(records
[i
],
4271 ZPOOL_HIST_INT_EVENT
, &ievent
) != 0)
4273 verify(nvlist_lookup_uint64(records
[i
],
4274 ZPOOL_HIST_TXG
, &txg
) == 0);
4275 verify(nvlist_lookup_string(records
[i
],
4276 ZPOOL_HIST_INT_STR
, &pathstr
) == 0);
4277 if (ievent
>= LOG_END
)
4279 (void) snprintf(internalstr
,
4280 sizeof (internalstr
),
4281 "[internal %s txg:%llu] %s",
4282 zfs_history_event_names
[ievent
], (u_longlong_t
)txg
,
4284 cmdstr
= internalstr
;
4287 (void) localtime_r(&tsec
, &t
);
4288 (void) strftime(tbuf
, sizeof (tbuf
), "%F.%T", &t
);
4289 (void) printf("%s %s", tbuf
, cmdstr
);
4292 (void) printf("\n");
4295 (void) printf(" [");
4296 if (nvlist_lookup_uint64(records
[i
],
4297 ZPOOL_HIST_WHO
, &who
) == 0) {
4298 pwd
= getpwuid((uid_t
)who
);
4300 (void) printf("user %s on",
4303 (void) printf("user %d on",
4306 (void) printf(gettext("no info]\n"));
4309 if (nvlist_lookup_string(records
[i
],
4310 ZPOOL_HIST_HOST
, &hostname
) == 0) {
4311 (void) printf(" %s", hostname
);
4313 if (nvlist_lookup_string(records
[i
],
4314 ZPOOL_HIST_ZONE
, &zonename
) == 0) {
4315 (void) printf(":%s", zonename
);
4319 (void) printf("\n");
4321 (void) printf("\n");
4328 * zpool history <pool>
4330 * Displays the history of commands that modified pools.
4335 zpool_do_history(int argc
, char **argv
)
4337 hist_cbdata_t cbdata
= { 0 };
4341 cbdata
.first
= B_TRUE
;
4343 while ((c
= getopt(argc
, argv
, "li")) != -1) {
4349 cbdata
.internal
= 1;
4352 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
4360 ret
= for_each_pool(argc
, argv
, B_FALSE
, NULL
, get_history_one
,
4363 if (argc
== 0 && cbdata
.first
== B_TRUE
) {
4364 (void) fprintf(stderr
, gettext("no pools available\n"));
4371 typedef struct ev_opts
{
4379 zpool_do_events_short(nvlist_t
*nvl
)
4381 char ctime_str
[26], str
[32], *ptr
;
4385 verify(nvlist_lookup_int64_array(nvl
, FM_EREPORT_TIME
, &tv
, &n
) == 0);
4386 memset(str
, ' ', 32);
4387 (void) ctime_r((const time_t *)&tv
[0], ctime_str
);
4388 (void) strncpy(str
, ctime_str
+4, 6); /* 'Jun 30' */
4389 (void) strncpy(str
+7, ctime_str
+20, 4); /* '1993' */
4390 (void) strncpy(str
+12, ctime_str
+11, 8); /* '21:49:08' */
4391 (void) sprintf(str
+20, ".%09lld", (longlong_t
)tv
[1]);/* '.123456789' */
4392 (void) printf(gettext("%s "), str
);
4394 verify(nvlist_lookup_string(nvl
, FM_CLASS
, &ptr
) == 0);
4395 (void) printf(gettext("%s\n"), ptr
);
4399 zpool_do_events_nvprint(nvlist_t
*nvl
, int depth
)
4403 for (nvp
= nvlist_next_nvpair(nvl
, NULL
);
4404 nvp
!= NULL
; nvp
= nvlist_next_nvpair(nvl
, nvp
)) {
4406 data_type_t type
= nvpair_type(nvp
);
4407 const char *name
= nvpair_name(nvp
);
4417 printf(gettext("%*s%s = "), depth
, "", name
);
4420 case DATA_TYPE_BOOLEAN
:
4421 printf(gettext("%s"), "1");
4424 case DATA_TYPE_BOOLEAN_VALUE
:
4425 (void) nvpair_value_boolean_value(nvp
, &b
);
4426 printf(gettext("%s"), b
? "1" : "0");
4429 case DATA_TYPE_BYTE
:
4430 (void) nvpair_value_byte(nvp
, &i8
);
4431 printf(gettext("0x%x"), i8
);
4434 case DATA_TYPE_INT8
:
4435 (void) nvpair_value_int8(nvp
, (void *)&i8
);
4436 printf(gettext("0x%x"), i8
);
4439 case DATA_TYPE_UINT8
:
4440 (void) nvpair_value_uint8(nvp
, &i8
);
4441 printf(gettext("0x%x"), i8
);
4444 case DATA_TYPE_INT16
:
4445 (void) nvpair_value_int16(nvp
, (void *)&i16
);
4446 printf(gettext("0x%x"), i16
);
4449 case DATA_TYPE_UINT16
:
4450 (void) nvpair_value_uint16(nvp
, &i16
);
4451 printf(gettext("0x%x"), i16
);
4454 case DATA_TYPE_INT32
:
4455 (void) nvpair_value_int32(nvp
, (void *)&i32
);
4456 printf(gettext("0x%x"), i32
);
4459 case DATA_TYPE_UINT32
:
4460 (void) nvpair_value_uint32(nvp
, &i32
);
4461 printf(gettext("0x%x"), i32
);
4464 case DATA_TYPE_INT64
:
4465 (void) nvpair_value_int64(nvp
, (void *)&i64
);
4466 printf(gettext("0x%llx"), (u_longlong_t
)i64
);
4469 case DATA_TYPE_UINT64
:
4470 (void) nvpair_value_uint64(nvp
, &i64
);
4471 printf(gettext("0x%llx"), (u_longlong_t
)i64
);
4474 case DATA_TYPE_HRTIME
:
4475 (void) nvpair_value_hrtime(nvp
, (void *)&i64
);
4476 printf(gettext("0x%llx"), (u_longlong_t
)i64
);
4479 case DATA_TYPE_STRING
:
4480 (void) nvpair_value_string(nvp
, &str
);
4481 printf(gettext("\"%s\""), str
? str
: "<NULL>");
4484 case DATA_TYPE_NVLIST
:
4485 printf(gettext("(embedded nvlist)\n"));
4486 (void) nvpair_value_nvlist(nvp
, &cnv
);
4487 zpool_do_events_nvprint(cnv
, depth
+ 8);
4488 printf(gettext("%*s(end %s)"), depth
, "", name
);
4491 case DATA_TYPE_NVLIST_ARRAY
: {
4495 (void) nvpair_value_nvlist_array(nvp
, &val
, &nelem
);
4496 printf(gettext("(%d embedded nvlists)\n"), nelem
);
4497 for (i
= 0; i
< nelem
; i
++) {
4498 printf(gettext("%*s%s[%d] = %s\n"),
4499 depth
, "", name
, i
, "(embedded nvlist)");
4500 zpool_do_events_nvprint(val
[i
], depth
+ 8);
4501 printf(gettext("%*s(end %s[%i])\n"),
4502 depth
, "", name
, i
);
4504 printf(gettext("%*s(end %s)\n"), depth
, "", name
);
4508 case DATA_TYPE_INT8_ARRAY
: {
4512 (void) nvpair_value_int8_array(nvp
, &val
, &nelem
);
4513 for (i
= 0; i
< nelem
; i
++)
4514 printf(gettext("0x%x "), val
[i
]);
4519 case DATA_TYPE_UINT8_ARRAY
: {
4523 (void) nvpair_value_uint8_array(nvp
, &val
, &nelem
);
4524 for (i
= 0; i
< nelem
; i
++)
4525 printf(gettext("0x%x "), val
[i
]);
4530 case DATA_TYPE_INT16_ARRAY
: {
4534 (void) nvpair_value_int16_array(nvp
, &val
, &nelem
);
4535 for (i
= 0; i
< nelem
; i
++)
4536 printf(gettext("0x%x "), val
[i
]);
4541 case DATA_TYPE_UINT16_ARRAY
: {
4545 (void) nvpair_value_uint16_array(nvp
, &val
, &nelem
);
4546 for (i
= 0; i
< nelem
; i
++)
4547 printf(gettext("0x%x "), val
[i
]);
4552 case DATA_TYPE_INT32_ARRAY
: {
4556 (void) nvpair_value_int32_array(nvp
, &val
, &nelem
);
4557 for (i
= 0; i
< nelem
; i
++)
4558 printf(gettext("0x%x "), val
[i
]);
4563 case DATA_TYPE_UINT32_ARRAY
: {
4567 (void) nvpair_value_uint32_array(nvp
, &val
, &nelem
);
4568 for (i
= 0; i
< nelem
; i
++)
4569 printf(gettext("0x%x "), val
[i
]);
4574 case DATA_TYPE_INT64_ARRAY
: {
4578 (void) nvpair_value_int64_array(nvp
, &val
, &nelem
);
4579 for (i
= 0; i
< nelem
; i
++)
4580 printf(gettext("0x%llx "), (u_longlong_t
)val
[i
]);
4585 case DATA_TYPE_UINT64_ARRAY
: {
4589 (void) nvpair_value_uint64_array(nvp
, &val
, &nelem
);
4590 for (i
= 0; i
< nelem
; i
++)
4591 printf(gettext("0x%llx "), (u_longlong_t
)val
[i
]);
4596 case DATA_TYPE_STRING_ARRAY
:
4597 case DATA_TYPE_BOOLEAN_ARRAY
:
4598 case DATA_TYPE_BYTE_ARRAY
:
4599 case DATA_TYPE_DOUBLE
:
4600 case DATA_TYPE_UNKNOWN
:
4601 printf(gettext("<unknown>"));
4605 printf(gettext("\n"));
4610 zpool_do_events_next(ev_opts_t
*opts
)
4613 int cleanup_fd
, ret
, dropped
;
4615 cleanup_fd
= open(ZFS_DEV
, O_RDWR
);
4616 VERIFY(cleanup_fd
>= 0);
4618 if (!opts
->scripted
)
4619 (void) printf(gettext("%-30s %s\n"), "TIME", "CLASS");
4622 ret
= zpool_events_next(g_zfs
, &nvl
, &dropped
,
4623 !!opts
->follow
, cleanup_fd
);
4624 if (ret
|| nvl
== NULL
)
4628 (void) printf(gettext("dropped %d events\n"), dropped
);
4630 zpool_do_events_short(nvl
);
4632 if (opts
->verbose
) {
4633 zpool_do_events_nvprint(nvl
, 8);
4634 printf(gettext("\n"));
4640 VERIFY(0 == close(cleanup_fd
));
4646 zpool_do_events_clear(ev_opts_t
*opts
)
4650 ret
= zpool_events_clear(g_zfs
, &count
);
4652 (void) printf(gettext("cleared %d events\n"), count
);
4658 * zpool events [-vfc]
4660 * Displays events logs by ZFS.
4663 zpool_do_events(int argc
, char **argv
)
4665 ev_opts_t opts
= { 0 };
4670 while ((c
= getopt(argc
, argv
, "vHfc")) != -1) {
4685 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
4694 ret
= zpool_do_events_clear(&opts
);
4696 ret
= zpool_do_events_next(&opts
);
4702 get_callback(zpool_handle_t
*zhp
, void *data
)
4704 zprop_get_cbdata_t
*cbp
= (zprop_get_cbdata_t
*)data
;
4705 char value
[MAXNAMELEN
];
4706 zprop_source_t srctype
;
4709 for (pl
= cbp
->cb_proplist
; pl
!= NULL
; pl
= pl
->pl_next
) {
4712 * Skip the special fake placeholder. This will also skip
4713 * over the name property when 'all' is specified.
4715 if (pl
->pl_prop
== ZPOOL_PROP_NAME
&&
4716 pl
== cbp
->cb_proplist
)
4719 if (zpool_get_prop(zhp
, pl
->pl_prop
,
4720 value
, sizeof (value
), &srctype
) != 0)
4723 zprop_print_one_property(zpool_get_name(zhp
), cbp
,
4724 zpool_prop_to_name(pl
->pl_prop
), value
, srctype
, NULL
,
4731 zpool_do_get(int argc
, char **argv
)
4733 zprop_get_cbdata_t cb
= { 0 };
4734 zprop_list_t fake_name
= { 0 };
4740 cb
.cb_first
= B_TRUE
;
4741 cb
.cb_sources
= ZPROP_SRC_ALL
;
4742 cb
.cb_columns
[0] = GET_COL_NAME
;
4743 cb
.cb_columns
[1] = GET_COL_PROPERTY
;
4744 cb
.cb_columns
[2] = GET_COL_VALUE
;
4745 cb
.cb_columns
[3] = GET_COL_SOURCE
;
4746 cb
.cb_type
= ZFS_TYPE_POOL
;
4748 if (zprop_get_list(g_zfs
, argv
[1], &cb
.cb_proplist
,
4749 ZFS_TYPE_POOL
) != 0)
4752 if (cb
.cb_proplist
!= NULL
) {
4753 fake_name
.pl_prop
= ZPOOL_PROP_NAME
;
4754 fake_name
.pl_width
= strlen(gettext("NAME"));
4755 fake_name
.pl_next
= cb
.cb_proplist
;
4756 cb
.cb_proplist
= &fake_name
;
4759 ret
= for_each_pool(argc
- 2, argv
+ 2, B_TRUE
, &cb
.cb_proplist
,
4762 if (cb
.cb_proplist
== &fake_name
)
4763 zprop_free_list(fake_name
.pl_next
);
4765 zprop_free_list(cb
.cb_proplist
);
4770 typedef struct set_cbdata
{
4773 boolean_t cb_any_successful
;
4777 set_callback(zpool_handle_t
*zhp
, void *data
)
4780 set_cbdata_t
*cb
= (set_cbdata_t
*)data
;
4782 error
= zpool_set_prop(zhp
, cb
->cb_propname
, cb
->cb_value
);
4785 cb
->cb_any_successful
= B_TRUE
;
4791 zpool_do_set(int argc
, char **argv
)
4793 set_cbdata_t cb
= { 0 };
4796 if (argc
> 1 && argv
[1][0] == '-') {
4797 (void) fprintf(stderr
, gettext("invalid option '%c'\n"),
4803 (void) fprintf(stderr
, gettext("missing property=value "
4809 (void) fprintf(stderr
, gettext("missing pool name\n"));
4814 (void) fprintf(stderr
, gettext("too many pool names\n"));
4818 cb
.cb_propname
= argv
[1];
4819 cb
.cb_value
= strchr(cb
.cb_propname
, '=');
4820 if (cb
.cb_value
== NULL
) {
4821 (void) fprintf(stderr
, gettext("missing value in "
4822 "property=value argument\n"));
4826 *(cb
.cb_value
) = '\0';
4829 error
= for_each_pool(argc
- 2, argv
+ 2, B_TRUE
, NULL
,
4836 find_command_idx(char *command
, int *idx
)
4840 for (i
= 0; i
< NCOMMAND
; i
++) {
4841 if (command_table
[i
].name
== NULL
)
4844 if (strcmp(command
, command_table
[i
].name
) == 0) {
4853 main(int argc
, char **argv
)
4859 (void) setlocale(LC_ALL
, "");
4860 (void) textdomain(TEXT_DOMAIN
);
4865 * Make sure the user has specified some command.
4868 (void) fprintf(stderr
, gettext("missing command\n"));
4877 if ((strcmp(cmdname
, "-?") == 0) ||
4878 strcmp(cmdname
, "--help") == 0)
4881 if ((g_zfs
= libzfs_init()) == NULL
)
4884 libzfs_print_on_error(g_zfs
, B_TRUE
);
4886 zpool_set_history_str("zpool", argc
, argv
, history_str
);
4887 verify(zpool_stage_history(g_zfs
, history_str
) == 0);
4890 * Run the appropriate command.
4892 if (find_command_idx(cmdname
, &i
) == 0) {
4893 current_command
= &command_table
[i
];
4894 ret
= command_table
[i
].func(argc
- 1, argv
+ 1);
4895 } else if (strchr(cmdname
, '=')) {
4896 verify(find_command_idx("set", &i
) == 0);
4897 current_command
= &command_table
[i
];
4898 ret
= command_table
[i
].func(argc
, argv
);
4899 } else if (strcmp(cmdname
, "freeze") == 0 && argc
== 3) {
4901 * 'freeze' is a vile debugging abomination, so we treat
4905 int fd
= open(ZFS_DEV
, O_RDWR
);
4906 (void) strcpy((void *)buf
, argv
[2]);
4907 return (!!ioctl(fd
, ZFS_IOC_POOL_FREEZE
, buf
));
4909 (void) fprintf(stderr
, gettext("unrecognized "
4910 "command '%s'\n"), cmdname
);
4918 * The 'ZFS_ABORT' environment variable causes us to dump core on exit
4919 * for the purposes of running ::findleaks.
4921 if (getenv("ZFS_ABORT") != NULL
) {
4922 (void) printf("dumping core by request\n");