8641 "zpool clear" and "zinject" don't work on "spare" or "replacing" vdevs
[unleashed.git] / usr / src / lib / libzfs / common / libzfs_pool.c
blobec9fd723d5f147972a193421e81ab0938ce1ddf6
1 /*
2 * CDDL HEADER START
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]
19 * CDDL HEADER END
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2011, 2017 by Delphix. All rights reserved.
25 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
26 * Copyright 2016 Nexenta Systems, Inc.
27 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
28 * Copyright (c) 2017 Datto Inc.
31 #include <ctype.h>
32 #include <errno.h>
33 #include <devid.h>
34 #include <fcntl.h>
35 #include <libintl.h>
36 #include <stdio.h>
37 #include <stdlib.h>
38 #include <strings.h>
39 #include <unistd.h>
40 #include <libgen.h>
41 #include <sys/efi_partition.h>
42 #include <sys/vtoc.h>
43 #include <sys/zfs_ioctl.h>
44 #include <dlfcn.h>
46 #include "zfs_namecheck.h"
47 #include "zfs_prop.h"
48 #include "libzfs_impl.h"
49 #include "zfs_comutil.h"
50 #include "zfeature_common.h"
52 static int read_efi_label(nvlist_t *, diskaddr_t *, boolean_t *);
53 static boolean_t zpool_vdev_is_interior(const char *name);
55 #define BACKUP_SLICE "s2"
57 typedef struct prop_flags {
58 int create:1; /* Validate property on creation */
59 int import:1; /* Validate property on import */
60 } prop_flags_t;
63 * ====================================================================
64 * zpool property functions
65 * ====================================================================
68 static int
69 zpool_get_all_props(zpool_handle_t *zhp)
71 zfs_cmd_t zc = { 0 };
72 libzfs_handle_t *hdl = zhp->zpool_hdl;
74 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
76 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
77 return (-1);
79 while (ioctl(hdl->libzfs_fd, ZFS_IOC_POOL_GET_PROPS, &zc) != 0) {
80 if (errno == ENOMEM) {
81 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
82 zcmd_free_nvlists(&zc);
83 return (-1);
85 } else {
86 zcmd_free_nvlists(&zc);
87 return (-1);
91 if (zcmd_read_dst_nvlist(hdl, &zc, &zhp->zpool_props) != 0) {
92 zcmd_free_nvlists(&zc);
93 return (-1);
96 zcmd_free_nvlists(&zc);
98 return (0);
101 static int
102 zpool_props_refresh(zpool_handle_t *zhp)
104 nvlist_t *old_props;
106 old_props = zhp->zpool_props;
108 if (zpool_get_all_props(zhp) != 0)
109 return (-1);
111 nvlist_free(old_props);
112 return (0);
115 static char *
116 zpool_get_prop_string(zpool_handle_t *zhp, zpool_prop_t prop,
117 zprop_source_t *src)
119 nvlist_t *nv, *nvl;
120 uint64_t ival;
121 char *value;
122 zprop_source_t source;
124 nvl = zhp->zpool_props;
125 if (nvlist_lookup_nvlist(nvl, zpool_prop_to_name(prop), &nv) == 0) {
126 verify(nvlist_lookup_uint64(nv, ZPROP_SOURCE, &ival) == 0);
127 source = ival;
128 verify(nvlist_lookup_string(nv, ZPROP_VALUE, &value) == 0);
129 } else {
130 source = ZPROP_SRC_DEFAULT;
131 if ((value = (char *)zpool_prop_default_string(prop)) == NULL)
132 value = "-";
135 if (src)
136 *src = source;
138 return (value);
141 uint64_t
142 zpool_get_prop_int(zpool_handle_t *zhp, zpool_prop_t prop, zprop_source_t *src)
144 nvlist_t *nv, *nvl;
145 uint64_t value;
146 zprop_source_t source;
148 if (zhp->zpool_props == NULL && zpool_get_all_props(zhp)) {
150 * zpool_get_all_props() has most likely failed because
151 * the pool is faulted, but if all we need is the top level
152 * vdev's guid then get it from the zhp config nvlist.
154 if ((prop == ZPOOL_PROP_GUID) &&
155 (nvlist_lookup_nvlist(zhp->zpool_config,
156 ZPOOL_CONFIG_VDEV_TREE, &nv) == 0) &&
157 (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &value)
158 == 0)) {
159 return (value);
161 return (zpool_prop_default_numeric(prop));
164 nvl = zhp->zpool_props;
165 if (nvlist_lookup_nvlist(nvl, zpool_prop_to_name(prop), &nv) == 0) {
166 verify(nvlist_lookup_uint64(nv, ZPROP_SOURCE, &value) == 0);
167 source = value;
168 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
169 } else {
170 source = ZPROP_SRC_DEFAULT;
171 value = zpool_prop_default_numeric(prop);
174 if (src)
175 *src = source;
177 return (value);
181 * Map VDEV STATE to printed strings.
183 const char *
184 zpool_state_to_name(vdev_state_t state, vdev_aux_t aux)
186 switch (state) {
187 case VDEV_STATE_CLOSED:
188 case VDEV_STATE_OFFLINE:
189 return (gettext("OFFLINE"));
190 case VDEV_STATE_REMOVED:
191 return (gettext("REMOVED"));
192 case VDEV_STATE_CANT_OPEN:
193 if (aux == VDEV_AUX_CORRUPT_DATA || aux == VDEV_AUX_BAD_LOG)
194 return (gettext("FAULTED"));
195 else if (aux == VDEV_AUX_SPLIT_POOL)
196 return (gettext("SPLIT"));
197 else
198 return (gettext("UNAVAIL"));
199 case VDEV_STATE_FAULTED:
200 return (gettext("FAULTED"));
201 case VDEV_STATE_DEGRADED:
202 return (gettext("DEGRADED"));
203 case VDEV_STATE_HEALTHY:
204 return (gettext("ONLINE"));
206 default:
207 break;
210 return (gettext("UNKNOWN"));
214 * Map POOL STATE to printed strings.
216 const char *
217 zpool_pool_state_to_name(pool_state_t state)
219 switch (state) {
220 case POOL_STATE_ACTIVE:
221 return (gettext("ACTIVE"));
222 case POOL_STATE_EXPORTED:
223 return (gettext("EXPORTED"));
224 case POOL_STATE_DESTROYED:
225 return (gettext("DESTROYED"));
226 case POOL_STATE_SPARE:
227 return (gettext("SPARE"));
228 case POOL_STATE_L2CACHE:
229 return (gettext("L2CACHE"));
230 case POOL_STATE_UNINITIALIZED:
231 return (gettext("UNINITIALIZED"));
232 case POOL_STATE_UNAVAIL:
233 return (gettext("UNAVAIL"));
234 case POOL_STATE_POTENTIALLY_ACTIVE:
235 return (gettext("POTENTIALLY_ACTIVE"));
238 return (gettext("UNKNOWN"));
242 * Get a zpool property value for 'prop' and return the value in
243 * a pre-allocated buffer.
246 zpool_get_prop(zpool_handle_t *zhp, zpool_prop_t prop, char *buf, size_t len,
247 zprop_source_t *srctype, boolean_t literal)
249 uint64_t intval;
250 const char *strval;
251 zprop_source_t src = ZPROP_SRC_NONE;
252 nvlist_t *nvroot;
253 vdev_stat_t *vs;
254 uint_t vsc;
256 if (zpool_get_state(zhp) == POOL_STATE_UNAVAIL) {
257 switch (prop) {
258 case ZPOOL_PROP_NAME:
259 (void) strlcpy(buf, zpool_get_name(zhp), len);
260 break;
262 case ZPOOL_PROP_HEALTH:
263 (void) strlcpy(buf, "FAULTED", len);
264 break;
266 case ZPOOL_PROP_GUID:
267 intval = zpool_get_prop_int(zhp, prop, &src);
268 (void) snprintf(buf, len, "%llu", intval);
269 break;
271 case ZPOOL_PROP_ALTROOT:
272 case ZPOOL_PROP_CACHEFILE:
273 case ZPOOL_PROP_COMMENT:
274 if (zhp->zpool_props != NULL ||
275 zpool_get_all_props(zhp) == 0) {
276 (void) strlcpy(buf,
277 zpool_get_prop_string(zhp, prop, &src),
278 len);
279 break;
281 /* FALLTHROUGH */
282 default:
283 (void) strlcpy(buf, "-", len);
284 break;
287 if (srctype != NULL)
288 *srctype = src;
289 return (0);
292 if (zhp->zpool_props == NULL && zpool_get_all_props(zhp) &&
293 prop != ZPOOL_PROP_NAME)
294 return (-1);
296 switch (zpool_prop_get_type(prop)) {
297 case PROP_TYPE_STRING:
298 (void) strlcpy(buf, zpool_get_prop_string(zhp, prop, &src),
299 len);
300 break;
302 case PROP_TYPE_NUMBER:
303 intval = zpool_get_prop_int(zhp, prop, &src);
305 switch (prop) {
306 case ZPOOL_PROP_SIZE:
307 case ZPOOL_PROP_ALLOCATED:
308 case ZPOOL_PROP_FREE:
309 case ZPOOL_PROP_FREEING:
310 case ZPOOL_PROP_LEAKED:
311 if (literal) {
312 (void) snprintf(buf, len, "%llu",
313 (u_longlong_t)intval);
314 } else {
315 (void) zfs_nicenum(intval, buf, len);
317 break;
318 case ZPOOL_PROP_BOOTSIZE:
319 case ZPOOL_PROP_EXPANDSZ:
320 if (intval == 0) {
321 (void) strlcpy(buf, "-", len);
322 } else if (literal) {
323 (void) snprintf(buf, len, "%llu",
324 (u_longlong_t)intval);
325 } else {
326 (void) zfs_nicenum(intval, buf, len);
328 break;
329 case ZPOOL_PROP_CAPACITY:
330 if (literal) {
331 (void) snprintf(buf, len, "%llu",
332 (u_longlong_t)intval);
333 } else {
334 (void) snprintf(buf, len, "%llu%%",
335 (u_longlong_t)intval);
337 break;
338 case ZPOOL_PROP_FRAGMENTATION:
339 if (intval == UINT64_MAX) {
340 (void) strlcpy(buf, "-", len);
341 } else {
342 (void) snprintf(buf, len, "%llu%%",
343 (u_longlong_t)intval);
345 break;
346 case ZPOOL_PROP_DEDUPRATIO:
347 (void) snprintf(buf, len, "%llu.%02llux",
348 (u_longlong_t)(intval / 100),
349 (u_longlong_t)(intval % 100));
350 break;
351 case ZPOOL_PROP_HEALTH:
352 verify(nvlist_lookup_nvlist(zpool_get_config(zhp, NULL),
353 ZPOOL_CONFIG_VDEV_TREE, &nvroot) == 0);
354 verify(nvlist_lookup_uint64_array(nvroot,
355 ZPOOL_CONFIG_VDEV_STATS, (uint64_t **)&vs, &vsc)
356 == 0);
358 (void) strlcpy(buf, zpool_state_to_name(intval,
359 vs->vs_aux), len);
360 break;
361 case ZPOOL_PROP_VERSION:
362 if (intval >= SPA_VERSION_FEATURES) {
363 (void) snprintf(buf, len, "-");
364 break;
366 /* FALLTHROUGH */
367 default:
368 (void) snprintf(buf, len, "%llu", intval);
370 break;
372 case PROP_TYPE_INDEX:
373 intval = zpool_get_prop_int(zhp, prop, &src);
374 if (zpool_prop_index_to_string(prop, intval, &strval)
375 != 0)
376 return (-1);
377 (void) strlcpy(buf, strval, len);
378 break;
380 default:
381 abort();
384 if (srctype)
385 *srctype = src;
387 return (0);
391 * Check if the bootfs name has the same pool name as it is set to.
392 * Assuming bootfs is a valid dataset name.
394 static boolean_t
395 bootfs_name_valid(const char *pool, char *bootfs)
397 int len = strlen(pool);
399 if (!zfs_name_valid(bootfs, ZFS_TYPE_FILESYSTEM|ZFS_TYPE_SNAPSHOT))
400 return (B_FALSE);
402 if (strncmp(pool, bootfs, len) == 0 &&
403 (bootfs[len] == '/' || bootfs[len] == '\0'))
404 return (B_TRUE);
406 return (B_FALSE);
409 boolean_t
410 zpool_is_bootable(zpool_handle_t *zhp)
412 char bootfs[ZFS_MAX_DATASET_NAME_LEN];
414 return (zpool_get_prop(zhp, ZPOOL_PROP_BOOTFS, bootfs,
415 sizeof (bootfs), NULL, B_FALSE) == 0 && strncmp(bootfs, "-",
416 sizeof (bootfs)) != 0);
421 * Given an nvlist of zpool properties to be set, validate that they are
422 * correct, and parse any numeric properties (index, boolean, etc) if they are
423 * specified as strings.
425 static nvlist_t *
426 zpool_valid_proplist(libzfs_handle_t *hdl, const char *poolname,
427 nvlist_t *props, uint64_t version, prop_flags_t flags, char *errbuf)
429 nvpair_t *elem;
430 nvlist_t *retprops;
431 zpool_prop_t prop;
432 char *strval;
433 uint64_t intval;
434 char *slash, *check;
435 struct stat64 statbuf;
436 zpool_handle_t *zhp;
438 if (nvlist_alloc(&retprops, NV_UNIQUE_NAME, 0) != 0) {
439 (void) no_memory(hdl);
440 return (NULL);
443 elem = NULL;
444 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
445 const char *propname = nvpair_name(elem);
447 prop = zpool_name_to_prop(propname);
448 if (prop == ZPROP_INVAL && zpool_prop_feature(propname)) {
449 int err;
450 char *fname = strchr(propname, '@') + 1;
452 err = zfeature_lookup_name(fname, NULL);
453 if (err != 0) {
454 ASSERT3U(err, ==, ENOENT);
455 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
456 "invalid feature '%s'"), fname);
457 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
458 goto error;
461 if (nvpair_type(elem) != DATA_TYPE_STRING) {
462 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
463 "'%s' must be a string"), propname);
464 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
465 goto error;
468 (void) nvpair_value_string(elem, &strval);
469 if (strcmp(strval, ZFS_FEATURE_ENABLED) != 0) {
470 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
471 "property '%s' can only be set to "
472 "'enabled'"), propname);
473 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
474 goto error;
477 if (nvlist_add_uint64(retprops, propname, 0) != 0) {
478 (void) no_memory(hdl);
479 goto error;
481 continue;
485 * Make sure this property is valid and applies to this type.
487 if (prop == ZPROP_INVAL) {
488 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
489 "invalid property '%s'"), propname);
490 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
491 goto error;
494 if (zpool_prop_readonly(prop)) {
495 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "'%s' "
496 "is readonly"), propname);
497 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
498 goto error;
501 if (zprop_parse_value(hdl, elem, prop, ZFS_TYPE_POOL, retprops,
502 &strval, &intval, errbuf) != 0)
503 goto error;
506 * Perform additional checking for specific properties.
508 switch (prop) {
509 case ZPOOL_PROP_VERSION:
510 if (intval < version ||
511 !SPA_VERSION_IS_SUPPORTED(intval)) {
512 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
513 "property '%s' number %d is invalid."),
514 propname, intval);
515 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
516 goto error;
518 break;
520 case ZPOOL_PROP_BOOTSIZE:
521 if (!flags.create) {
522 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
523 "property '%s' can only be set during pool "
524 "creation"), propname);
525 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
526 goto error;
528 break;
530 case ZPOOL_PROP_BOOTFS:
531 if (flags.create || flags.import) {
532 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
533 "property '%s' cannot be set at creation "
534 "or import time"), propname);
535 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
536 goto error;
539 if (version < SPA_VERSION_BOOTFS) {
540 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
541 "pool must be upgraded to support "
542 "'%s' property"), propname);
543 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
544 goto error;
548 * bootfs property value has to be a dataset name and
549 * the dataset has to be in the same pool as it sets to.
551 if (strval[0] != '\0' && !bootfs_name_valid(poolname,
552 strval)) {
553 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "'%s' "
554 "is an invalid name"), strval);
555 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
556 goto error;
559 if ((zhp = zpool_open_canfail(hdl, poolname)) == NULL) {
560 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
561 "could not open pool '%s'"), poolname);
562 (void) zfs_error(hdl, EZFS_OPENFAILED, errbuf);
563 goto error;
565 zpool_close(zhp);
566 break;
568 case ZPOOL_PROP_ALTROOT:
569 if (!flags.create && !flags.import) {
570 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
571 "property '%s' can only be set during pool "
572 "creation or import"), propname);
573 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
574 goto error;
577 if (strval[0] != '/') {
578 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
579 "bad alternate root '%s'"), strval);
580 (void) zfs_error(hdl, EZFS_BADPATH, errbuf);
581 goto error;
583 break;
585 case ZPOOL_PROP_CACHEFILE:
586 if (strval[0] == '\0')
587 break;
589 if (strcmp(strval, "none") == 0)
590 break;
592 if (strval[0] != '/') {
593 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
594 "property '%s' must be empty, an "
595 "absolute path, or 'none'"), propname);
596 (void) zfs_error(hdl, EZFS_BADPATH, errbuf);
597 goto error;
600 slash = strrchr(strval, '/');
602 if (slash[1] == '\0' || strcmp(slash, "/.") == 0 ||
603 strcmp(slash, "/..") == 0) {
604 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
605 "'%s' is not a valid file"), strval);
606 (void) zfs_error(hdl, EZFS_BADPATH, errbuf);
607 goto error;
610 *slash = '\0';
612 if (strval[0] != '\0' &&
613 (stat64(strval, &statbuf) != 0 ||
614 !S_ISDIR(statbuf.st_mode))) {
615 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
616 "'%s' is not a valid directory"),
617 strval);
618 (void) zfs_error(hdl, EZFS_BADPATH, errbuf);
619 goto error;
622 *slash = '/';
623 break;
625 case ZPOOL_PROP_COMMENT:
626 for (check = strval; *check != '\0'; check++) {
627 if (!isprint(*check)) {
628 zfs_error_aux(hdl,
629 dgettext(TEXT_DOMAIN,
630 "comment may only have printable "
631 "characters"));
632 (void) zfs_error(hdl, EZFS_BADPROP,
633 errbuf);
634 goto error;
637 if (strlen(strval) > ZPROP_MAX_COMMENT) {
638 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
639 "comment must not exceed %d characters"),
640 ZPROP_MAX_COMMENT);
641 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
642 goto error;
644 break;
645 case ZPOOL_PROP_READONLY:
646 if (!flags.import) {
647 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
648 "property '%s' can only be set at "
649 "import time"), propname);
650 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
651 goto error;
653 break;
655 default:
656 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
657 "property '%s'(%d) not defined"), propname, prop);
658 break;
662 return (retprops);
663 error:
664 nvlist_free(retprops);
665 return (NULL);
669 * Set zpool property : propname=propval.
672 zpool_set_prop(zpool_handle_t *zhp, const char *propname, const char *propval)
674 zfs_cmd_t zc = { 0 };
675 int ret = -1;
676 char errbuf[1024];
677 nvlist_t *nvl = NULL;
678 nvlist_t *realprops;
679 uint64_t version;
680 prop_flags_t flags = { 0 };
682 (void) snprintf(errbuf, sizeof (errbuf),
683 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
684 zhp->zpool_name);
686 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
687 return (no_memory(zhp->zpool_hdl));
689 if (nvlist_add_string(nvl, propname, propval) != 0) {
690 nvlist_free(nvl);
691 return (no_memory(zhp->zpool_hdl));
694 version = zpool_get_prop_int(zhp, ZPOOL_PROP_VERSION, NULL);
695 if ((realprops = zpool_valid_proplist(zhp->zpool_hdl,
696 zhp->zpool_name, nvl, version, flags, errbuf)) == NULL) {
697 nvlist_free(nvl);
698 return (-1);
701 nvlist_free(nvl);
702 nvl = realprops;
705 * Execute the corresponding ioctl() to set this property.
707 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
709 if (zcmd_write_src_nvlist(zhp->zpool_hdl, &zc, nvl) != 0) {
710 nvlist_free(nvl);
711 return (-1);
714 ret = zfs_ioctl(zhp->zpool_hdl, ZFS_IOC_POOL_SET_PROPS, &zc);
716 zcmd_free_nvlists(&zc);
717 nvlist_free(nvl);
719 if (ret)
720 (void) zpool_standard_error(zhp->zpool_hdl, errno, errbuf);
721 else
722 (void) zpool_props_refresh(zhp);
724 return (ret);
728 zpool_expand_proplist(zpool_handle_t *zhp, zprop_list_t **plp)
730 libzfs_handle_t *hdl = zhp->zpool_hdl;
731 zprop_list_t *entry;
732 char buf[ZFS_MAXPROPLEN];
733 nvlist_t *features = NULL;
734 zprop_list_t **last;
735 boolean_t firstexpand = (NULL == *plp);
737 if (zprop_expand_list(hdl, plp, ZFS_TYPE_POOL) != 0)
738 return (-1);
740 last = plp;
741 while (*last != NULL)
742 last = &(*last)->pl_next;
744 if ((*plp)->pl_all)
745 features = zpool_get_features(zhp);
747 if ((*plp)->pl_all && firstexpand) {
748 for (int i = 0; i < SPA_FEATURES; i++) {
749 zprop_list_t *entry = zfs_alloc(hdl,
750 sizeof (zprop_list_t));
751 entry->pl_prop = ZPROP_INVAL;
752 entry->pl_user_prop = zfs_asprintf(hdl, "feature@%s",
753 spa_feature_table[i].fi_uname);
754 entry->pl_width = strlen(entry->pl_user_prop);
755 entry->pl_all = B_TRUE;
757 *last = entry;
758 last = &entry->pl_next;
762 /* add any unsupported features */
763 for (nvpair_t *nvp = nvlist_next_nvpair(features, NULL);
764 nvp != NULL; nvp = nvlist_next_nvpair(features, nvp)) {
765 char *propname;
766 boolean_t found;
767 zprop_list_t *entry;
769 if (zfeature_is_supported(nvpair_name(nvp)))
770 continue;
772 propname = zfs_asprintf(hdl, "unsupported@%s",
773 nvpair_name(nvp));
776 * Before adding the property to the list make sure that no
777 * other pool already added the same property.
779 found = B_FALSE;
780 entry = *plp;
781 while (entry != NULL) {
782 if (entry->pl_user_prop != NULL &&
783 strcmp(propname, entry->pl_user_prop) == 0) {
784 found = B_TRUE;
785 break;
787 entry = entry->pl_next;
789 if (found) {
790 free(propname);
791 continue;
794 entry = zfs_alloc(hdl, sizeof (zprop_list_t));
795 entry->pl_prop = ZPROP_INVAL;
796 entry->pl_user_prop = propname;
797 entry->pl_width = strlen(entry->pl_user_prop);
798 entry->pl_all = B_TRUE;
800 *last = entry;
801 last = &entry->pl_next;
804 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
806 if (entry->pl_fixed)
807 continue;
809 if (entry->pl_prop != ZPROP_INVAL &&
810 zpool_get_prop(zhp, entry->pl_prop, buf, sizeof (buf),
811 NULL, B_FALSE) == 0) {
812 if (strlen(buf) > entry->pl_width)
813 entry->pl_width = strlen(buf);
817 return (0);
821 * Get the state for the given feature on the given ZFS pool.
824 zpool_prop_get_feature(zpool_handle_t *zhp, const char *propname, char *buf,
825 size_t len)
827 uint64_t refcount;
828 boolean_t found = B_FALSE;
829 nvlist_t *features = zpool_get_features(zhp);
830 boolean_t supported;
831 const char *feature = strchr(propname, '@') + 1;
833 supported = zpool_prop_feature(propname);
834 ASSERT(supported || zpool_prop_unsupported(propname));
837 * Convert from feature name to feature guid. This conversion is
838 * unecessary for unsupported@... properties because they already
839 * use guids.
841 if (supported) {
842 int ret;
843 spa_feature_t fid;
845 ret = zfeature_lookup_name(feature, &fid);
846 if (ret != 0) {
847 (void) strlcpy(buf, "-", len);
848 return (ENOTSUP);
850 feature = spa_feature_table[fid].fi_guid;
853 if (nvlist_lookup_uint64(features, feature, &refcount) == 0)
854 found = B_TRUE;
856 if (supported) {
857 if (!found) {
858 (void) strlcpy(buf, ZFS_FEATURE_DISABLED, len);
859 } else {
860 if (refcount == 0)
861 (void) strlcpy(buf, ZFS_FEATURE_ENABLED, len);
862 else
863 (void) strlcpy(buf, ZFS_FEATURE_ACTIVE, len);
865 } else {
866 if (found) {
867 if (refcount == 0) {
868 (void) strcpy(buf, ZFS_UNSUPPORTED_INACTIVE);
869 } else {
870 (void) strcpy(buf, ZFS_UNSUPPORTED_READONLY);
872 } else {
873 (void) strlcpy(buf, "-", len);
874 return (ENOTSUP);
878 return (0);
882 * Don't start the slice at the default block of 34; many storage
883 * devices will use a stripe width of 128k, so start there instead.
885 #define NEW_START_BLOCK 256
888 * Validate the given pool name, optionally putting an extended error message in
889 * 'buf'.
891 boolean_t
892 zpool_name_valid(libzfs_handle_t *hdl, boolean_t isopen, const char *pool)
894 namecheck_err_t why;
895 char what;
896 int ret;
898 ret = pool_namecheck(pool, &why, &what);
901 * The rules for reserved pool names were extended at a later point.
902 * But we need to support users with existing pools that may now be
903 * invalid. So we only check for this expanded set of names during a
904 * create (or import), and only in userland.
906 if (ret == 0 && !isopen &&
907 (strncmp(pool, "mirror", 6) == 0 ||
908 strncmp(pool, "raidz", 5) == 0 ||
909 strncmp(pool, "spare", 5) == 0 ||
910 strcmp(pool, "log") == 0)) {
911 if (hdl != NULL)
912 zfs_error_aux(hdl,
913 dgettext(TEXT_DOMAIN, "name is reserved"));
914 return (B_FALSE);
918 if (ret != 0) {
919 if (hdl != NULL) {
920 switch (why) {
921 case NAME_ERR_TOOLONG:
922 zfs_error_aux(hdl,
923 dgettext(TEXT_DOMAIN, "name is too long"));
924 break;
926 case NAME_ERR_INVALCHAR:
927 zfs_error_aux(hdl,
928 dgettext(TEXT_DOMAIN, "invalid character "
929 "'%c' in pool name"), what);
930 break;
932 case NAME_ERR_NOLETTER:
933 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
934 "name must begin with a letter"));
935 break;
937 case NAME_ERR_RESERVED:
938 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
939 "name is reserved"));
940 break;
942 case NAME_ERR_DISKLIKE:
943 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
944 "pool name is reserved"));
945 break;
947 case NAME_ERR_LEADING_SLASH:
948 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
949 "leading slash in name"));
950 break;
952 case NAME_ERR_EMPTY_COMPONENT:
953 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
954 "empty component in name"));
955 break;
957 case NAME_ERR_TRAILING_SLASH:
958 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
959 "trailing slash in name"));
960 break;
962 case NAME_ERR_MULTIPLE_DELIMITERS:
963 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
964 "multiple '@' and/or '#' delimiters in "
965 "name"));
966 break;
968 default:
969 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
970 "(%d) not defined"), why);
971 break;
974 return (B_FALSE);
977 return (B_TRUE);
981 * Open a handle to the given pool, even if the pool is currently in the FAULTED
982 * state.
984 zpool_handle_t *
985 zpool_open_canfail(libzfs_handle_t *hdl, const char *pool)
987 zpool_handle_t *zhp;
988 boolean_t missing;
991 * Make sure the pool name is valid.
993 if (!zpool_name_valid(hdl, B_TRUE, pool)) {
994 (void) zfs_error_fmt(hdl, EZFS_INVALIDNAME,
995 dgettext(TEXT_DOMAIN, "cannot open '%s'"),
996 pool);
997 return (NULL);
1000 if ((zhp = zfs_alloc(hdl, sizeof (zpool_handle_t))) == NULL)
1001 return (NULL);
1003 zhp->zpool_hdl = hdl;
1004 (void) strlcpy(zhp->zpool_name, pool, sizeof (zhp->zpool_name));
1006 if (zpool_refresh_stats(zhp, &missing) != 0) {
1007 zpool_close(zhp);
1008 return (NULL);
1011 if (missing) {
1012 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "no such pool"));
1013 (void) zfs_error_fmt(hdl, EZFS_NOENT,
1014 dgettext(TEXT_DOMAIN, "cannot open '%s'"), pool);
1015 zpool_close(zhp);
1016 return (NULL);
1019 return (zhp);
1023 * Like the above, but silent on error. Used when iterating over pools (because
1024 * the configuration cache may be out of date).
1027 zpool_open_silent(libzfs_handle_t *hdl, const char *pool, zpool_handle_t **ret)
1029 zpool_handle_t *zhp;
1030 boolean_t missing;
1032 if ((zhp = zfs_alloc(hdl, sizeof (zpool_handle_t))) == NULL)
1033 return (-1);
1035 zhp->zpool_hdl = hdl;
1036 (void) strlcpy(zhp->zpool_name, pool, sizeof (zhp->zpool_name));
1038 if (zpool_refresh_stats(zhp, &missing) != 0) {
1039 zpool_close(zhp);
1040 return (-1);
1043 if (missing) {
1044 zpool_close(zhp);
1045 *ret = NULL;
1046 return (0);
1049 *ret = zhp;
1050 return (0);
1054 * Similar to zpool_open_canfail(), but refuses to open pools in the faulted
1055 * state.
1057 zpool_handle_t *
1058 zpool_open(libzfs_handle_t *hdl, const char *pool)
1060 zpool_handle_t *zhp;
1062 if ((zhp = zpool_open_canfail(hdl, pool)) == NULL)
1063 return (NULL);
1065 if (zhp->zpool_state == POOL_STATE_UNAVAIL) {
1066 (void) zfs_error_fmt(hdl, EZFS_POOLUNAVAIL,
1067 dgettext(TEXT_DOMAIN, "cannot open '%s'"), zhp->zpool_name);
1068 zpool_close(zhp);
1069 return (NULL);
1072 return (zhp);
1076 * Close the handle. Simply frees the memory associated with the handle.
1078 void
1079 zpool_close(zpool_handle_t *zhp)
1081 nvlist_free(zhp->zpool_config);
1082 nvlist_free(zhp->zpool_old_config);
1083 nvlist_free(zhp->zpool_props);
1084 free(zhp);
1088 * Return the name of the pool.
1090 const char *
1091 zpool_get_name(zpool_handle_t *zhp)
1093 return (zhp->zpool_name);
1098 * Return the state of the pool (ACTIVE or UNAVAILABLE)
1101 zpool_get_state(zpool_handle_t *zhp)
1103 return (zhp->zpool_state);
1107 * Create the named pool, using the provided vdev list. It is assumed
1108 * that the consumer has already validated the contents of the nvlist, so we
1109 * don't have to worry about error semantics.
1112 zpool_create(libzfs_handle_t *hdl, const char *pool, nvlist_t *nvroot,
1113 nvlist_t *props, nvlist_t *fsprops)
1115 zfs_cmd_t zc = { 0 };
1116 nvlist_t *zc_fsprops = NULL;
1117 nvlist_t *zc_props = NULL;
1118 char msg[1024];
1119 int ret = -1;
1121 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
1122 "cannot create '%s'"), pool);
1124 if (!zpool_name_valid(hdl, B_FALSE, pool))
1125 return (zfs_error(hdl, EZFS_INVALIDNAME, msg));
1127 if (zcmd_write_conf_nvlist(hdl, &zc, nvroot) != 0)
1128 return (-1);
1130 if (props) {
1131 prop_flags_t flags = { .create = B_TRUE, .import = B_FALSE };
1133 if ((zc_props = zpool_valid_proplist(hdl, pool, props,
1134 SPA_VERSION_1, flags, msg)) == NULL) {
1135 goto create_failed;
1139 if (fsprops) {
1140 uint64_t zoned;
1141 char *zonestr;
1143 zoned = ((nvlist_lookup_string(fsprops,
1144 zfs_prop_to_name(ZFS_PROP_ZONED), &zonestr) == 0) &&
1145 strcmp(zonestr, "on") == 0);
1147 if ((zc_fsprops = zfs_valid_proplist(hdl, ZFS_TYPE_FILESYSTEM,
1148 fsprops, zoned, NULL, NULL, msg)) == NULL) {
1149 goto create_failed;
1151 if (!zc_props &&
1152 (nvlist_alloc(&zc_props, NV_UNIQUE_NAME, 0) != 0)) {
1153 goto create_failed;
1155 if (nvlist_add_nvlist(zc_props,
1156 ZPOOL_ROOTFS_PROPS, zc_fsprops) != 0) {
1157 goto create_failed;
1161 if (zc_props && zcmd_write_src_nvlist(hdl, &zc, zc_props) != 0)
1162 goto create_failed;
1164 (void) strlcpy(zc.zc_name, pool, sizeof (zc.zc_name));
1166 if ((ret = zfs_ioctl(hdl, ZFS_IOC_POOL_CREATE, &zc)) != 0) {
1168 zcmd_free_nvlists(&zc);
1169 nvlist_free(zc_props);
1170 nvlist_free(zc_fsprops);
1172 switch (errno) {
1173 case EBUSY:
1175 * This can happen if the user has specified the same
1176 * device multiple times. We can't reliably detect this
1177 * until we try to add it and see we already have a
1178 * label.
1180 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1181 "one or more vdevs refer to the same device"));
1182 return (zfs_error(hdl, EZFS_BADDEV, msg));
1184 case ERANGE:
1186 * This happens if the record size is smaller or larger
1187 * than the allowed size range, or not a power of 2.
1189 * NOTE: although zfs_valid_proplist is called earlier,
1190 * this case may have slipped through since the
1191 * pool does not exist yet and it is therefore
1192 * impossible to read properties e.g. max blocksize
1193 * from the pool.
1195 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1196 "record size invalid"));
1197 return (zfs_error(hdl, EZFS_BADPROP, msg));
1199 case EOVERFLOW:
1201 * This occurs when one of the devices is below
1202 * SPA_MINDEVSIZE. Unfortunately, we can't detect which
1203 * device was the problem device since there's no
1204 * reliable way to determine device size from userland.
1207 char buf[64];
1209 zfs_nicenum(SPA_MINDEVSIZE, buf, sizeof (buf));
1211 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1212 "one or more devices is less than the "
1213 "minimum size (%s)"), buf);
1215 return (zfs_error(hdl, EZFS_BADDEV, msg));
1217 case ENOSPC:
1218 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1219 "one or more devices is out of space"));
1220 return (zfs_error(hdl, EZFS_BADDEV, msg));
1222 case ENOTBLK:
1223 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1224 "cache device must be a disk or disk slice"));
1225 return (zfs_error(hdl, EZFS_BADDEV, msg));
1227 default:
1228 return (zpool_standard_error(hdl, errno, msg));
1232 create_failed:
1233 zcmd_free_nvlists(&zc);
1234 nvlist_free(zc_props);
1235 nvlist_free(zc_fsprops);
1236 return (ret);
1240 * Destroy the given pool. It is up to the caller to ensure that there are no
1241 * datasets left in the pool.
1244 zpool_destroy(zpool_handle_t *zhp, const char *log_str)
1246 zfs_cmd_t zc = { 0 };
1247 zfs_handle_t *zfp = NULL;
1248 libzfs_handle_t *hdl = zhp->zpool_hdl;
1249 char msg[1024];
1251 if (zhp->zpool_state == POOL_STATE_ACTIVE &&
1252 (zfp = zfs_open(hdl, zhp->zpool_name, ZFS_TYPE_FILESYSTEM)) == NULL)
1253 return (-1);
1255 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
1256 zc.zc_history = (uint64_t)(uintptr_t)log_str;
1258 if (zfs_ioctl(hdl, ZFS_IOC_POOL_DESTROY, &zc) != 0) {
1259 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
1260 "cannot destroy '%s'"), zhp->zpool_name);
1262 if (errno == EROFS) {
1263 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1264 "one or more devices is read only"));
1265 (void) zfs_error(hdl, EZFS_BADDEV, msg);
1266 } else {
1267 (void) zpool_standard_error(hdl, errno, msg);
1270 if (zfp)
1271 zfs_close(zfp);
1272 return (-1);
1275 if (zfp) {
1276 remove_mountpoint(zfp);
1277 zfs_close(zfp);
1280 return (0);
1284 * Add the given vdevs to the pool. The caller must have already performed the
1285 * necessary verification to ensure that the vdev specification is well-formed.
1288 zpool_add(zpool_handle_t *zhp, nvlist_t *nvroot)
1290 zfs_cmd_t zc = { 0 };
1291 int ret;
1292 libzfs_handle_t *hdl = zhp->zpool_hdl;
1293 char msg[1024];
1294 nvlist_t **spares, **l2cache;
1295 uint_t nspares, nl2cache;
1297 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
1298 "cannot add to '%s'"), zhp->zpool_name);
1300 if (zpool_get_prop_int(zhp, ZPOOL_PROP_VERSION, NULL) <
1301 SPA_VERSION_SPARES &&
1302 nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES,
1303 &spares, &nspares) == 0) {
1304 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool must be "
1305 "upgraded to add hot spares"));
1306 return (zfs_error(hdl, EZFS_BADVERSION, msg));
1309 if (zpool_get_prop_int(zhp, ZPOOL_PROP_VERSION, NULL) <
1310 SPA_VERSION_L2CACHE &&
1311 nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_L2CACHE,
1312 &l2cache, &nl2cache) == 0) {
1313 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool must be "
1314 "upgraded to add cache devices"));
1315 return (zfs_error(hdl, EZFS_BADVERSION, msg));
1318 if (zcmd_write_conf_nvlist(hdl, &zc, nvroot) != 0)
1319 return (-1);
1320 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
1322 if (zfs_ioctl(hdl, ZFS_IOC_VDEV_ADD, &zc) != 0) {
1323 switch (errno) {
1324 case EBUSY:
1326 * This can happen if the user has specified the same
1327 * device multiple times. We can't reliably detect this
1328 * until we try to add it and see we already have a
1329 * label.
1331 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1332 "one or more vdevs refer to the same device"));
1333 (void) zfs_error(hdl, EZFS_BADDEV, msg);
1334 break;
1336 case EINVAL:
1337 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1338 "invalid config; a pool with removing/removed "
1339 "vdevs does not support adding raidz vdevs"));
1340 (void) zfs_error(hdl, EZFS_BADDEV, msg);
1341 break;
1343 case EOVERFLOW:
1345 * This occurrs when one of the devices is below
1346 * SPA_MINDEVSIZE. Unfortunately, we can't detect which
1347 * device was the problem device since there's no
1348 * reliable way to determine device size from userland.
1351 char buf[64];
1353 zfs_nicenum(SPA_MINDEVSIZE, buf, sizeof (buf));
1355 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1356 "device is less than the minimum "
1357 "size (%s)"), buf);
1359 (void) zfs_error(hdl, EZFS_BADDEV, msg);
1360 break;
1362 case ENOTSUP:
1363 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1364 "pool must be upgraded to add these vdevs"));
1365 (void) zfs_error(hdl, EZFS_BADVERSION, msg);
1366 break;
1368 case EDOM:
1369 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1370 "root pool can not have multiple vdevs"
1371 " or separate logs"));
1372 (void) zfs_error(hdl, EZFS_POOL_NOTSUP, msg);
1373 break;
1375 case ENOTBLK:
1376 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1377 "cache device must be a disk or disk slice"));
1378 (void) zfs_error(hdl, EZFS_BADDEV, msg);
1379 break;
1381 default:
1382 (void) zpool_standard_error(hdl, errno, msg);
1385 ret = -1;
1386 } else {
1387 ret = 0;
1390 zcmd_free_nvlists(&zc);
1392 return (ret);
1396 * Exports the pool from the system. The caller must ensure that there are no
1397 * mounted datasets in the pool.
1399 static int
1400 zpool_export_common(zpool_handle_t *zhp, boolean_t force, boolean_t hardforce,
1401 const char *log_str)
1403 zfs_cmd_t zc = { 0 };
1404 char msg[1024];
1406 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
1407 "cannot export '%s'"), zhp->zpool_name);
1409 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
1410 zc.zc_cookie = force;
1411 zc.zc_guid = hardforce;
1412 zc.zc_history = (uint64_t)(uintptr_t)log_str;
1414 if (zfs_ioctl(zhp->zpool_hdl, ZFS_IOC_POOL_EXPORT, &zc) != 0) {
1415 switch (errno) {
1416 case EXDEV:
1417 zfs_error_aux(zhp->zpool_hdl, dgettext(TEXT_DOMAIN,
1418 "use '-f' to override the following errors:\n"
1419 "'%s' has an active shared spare which could be"
1420 " used by other pools once '%s' is exported."),
1421 zhp->zpool_name, zhp->zpool_name);
1422 return (zfs_error(zhp->zpool_hdl, EZFS_ACTIVE_SPARE,
1423 msg));
1424 default:
1425 return (zpool_standard_error_fmt(zhp->zpool_hdl, errno,
1426 msg));
1430 return (0);
1434 zpool_export(zpool_handle_t *zhp, boolean_t force, const char *log_str)
1436 return (zpool_export_common(zhp, force, B_FALSE, log_str));
1440 zpool_export_force(zpool_handle_t *zhp, const char *log_str)
1442 return (zpool_export_common(zhp, B_TRUE, B_TRUE, log_str));
1445 static void
1446 zpool_rewind_exclaim(libzfs_handle_t *hdl, const char *name, boolean_t dryrun,
1447 nvlist_t *config)
1449 nvlist_t *nv = NULL;
1450 uint64_t rewindto;
1451 int64_t loss = -1;
1452 struct tm t;
1453 char timestr[128];
1455 if (!hdl->libzfs_printerr || config == NULL)
1456 return;
1458 if (nvlist_lookup_nvlist(config, ZPOOL_CONFIG_LOAD_INFO, &nv) != 0 ||
1459 nvlist_lookup_nvlist(nv, ZPOOL_CONFIG_REWIND_INFO, &nv) != 0) {
1460 return;
1463 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_LOAD_TIME, &rewindto) != 0)
1464 return;
1465 (void) nvlist_lookup_int64(nv, ZPOOL_CONFIG_REWIND_TIME, &loss);
1467 if (localtime_r((time_t *)&rewindto, &t) != NULL &&
1468 strftime(timestr, 128, 0, &t) != 0) {
1469 if (dryrun) {
1470 (void) printf(dgettext(TEXT_DOMAIN,
1471 "Would be able to return %s "
1472 "to its state as of %s.\n"),
1473 name, timestr);
1474 } else {
1475 (void) printf(dgettext(TEXT_DOMAIN,
1476 "Pool %s returned to its state as of %s.\n"),
1477 name, timestr);
1479 if (loss > 120) {
1480 (void) printf(dgettext(TEXT_DOMAIN,
1481 "%s approximately %lld "),
1482 dryrun ? "Would discard" : "Discarded",
1483 (loss + 30) / 60);
1484 (void) printf(dgettext(TEXT_DOMAIN,
1485 "minutes of transactions.\n"));
1486 } else if (loss > 0) {
1487 (void) printf(dgettext(TEXT_DOMAIN,
1488 "%s approximately %lld "),
1489 dryrun ? "Would discard" : "Discarded", loss);
1490 (void) printf(dgettext(TEXT_DOMAIN,
1491 "seconds of transactions.\n"));
1496 void
1497 zpool_explain_recover(libzfs_handle_t *hdl, const char *name, int reason,
1498 nvlist_t *config)
1500 nvlist_t *nv = NULL;
1501 int64_t loss = -1;
1502 uint64_t edata = UINT64_MAX;
1503 uint64_t rewindto;
1504 struct tm t;
1505 char timestr[128];
1507 if (!hdl->libzfs_printerr)
1508 return;
1510 if (reason >= 0)
1511 (void) printf(dgettext(TEXT_DOMAIN, "action: "));
1512 else
1513 (void) printf(dgettext(TEXT_DOMAIN, "\t"));
1515 /* All attempted rewinds failed if ZPOOL_CONFIG_LOAD_TIME missing */
1516 if (nvlist_lookup_nvlist(config, ZPOOL_CONFIG_LOAD_INFO, &nv) != 0 ||
1517 nvlist_lookup_nvlist(nv, ZPOOL_CONFIG_REWIND_INFO, &nv) != 0 ||
1518 nvlist_lookup_uint64(nv, ZPOOL_CONFIG_LOAD_TIME, &rewindto) != 0)
1519 goto no_info;
1521 (void) nvlist_lookup_int64(nv, ZPOOL_CONFIG_REWIND_TIME, &loss);
1522 (void) nvlist_lookup_uint64(nv, ZPOOL_CONFIG_LOAD_DATA_ERRORS,
1523 &edata);
1525 (void) printf(dgettext(TEXT_DOMAIN,
1526 "Recovery is possible, but will result in some data loss.\n"));
1528 if (localtime_r((time_t *)&rewindto, &t) != NULL &&
1529 strftime(timestr, 128, 0, &t) != 0) {
1530 (void) printf(dgettext(TEXT_DOMAIN,
1531 "\tReturning the pool to its state as of %s\n"
1532 "\tshould correct the problem. "),
1533 timestr);
1534 } else {
1535 (void) printf(dgettext(TEXT_DOMAIN,
1536 "\tReverting the pool to an earlier state "
1537 "should correct the problem.\n\t"));
1540 if (loss > 120) {
1541 (void) printf(dgettext(TEXT_DOMAIN,
1542 "Approximately %lld minutes of data\n"
1543 "\tmust be discarded, irreversibly. "), (loss + 30) / 60);
1544 } else if (loss > 0) {
1545 (void) printf(dgettext(TEXT_DOMAIN,
1546 "Approximately %lld seconds of data\n"
1547 "\tmust be discarded, irreversibly. "), loss);
1549 if (edata != 0 && edata != UINT64_MAX) {
1550 if (edata == 1) {
1551 (void) printf(dgettext(TEXT_DOMAIN,
1552 "After rewind, at least\n"
1553 "\tone persistent user-data error will remain. "));
1554 } else {
1555 (void) printf(dgettext(TEXT_DOMAIN,
1556 "After rewind, several\n"
1557 "\tpersistent user-data errors will remain. "));
1560 (void) printf(dgettext(TEXT_DOMAIN,
1561 "Recovery can be attempted\n\tby executing 'zpool %s -F %s'. "),
1562 reason >= 0 ? "clear" : "import", name);
1564 (void) printf(dgettext(TEXT_DOMAIN,
1565 "A scrub of the pool\n"
1566 "\tis strongly recommended after recovery.\n"));
1567 return;
1569 no_info:
1570 (void) printf(dgettext(TEXT_DOMAIN,
1571 "Destroy and re-create the pool from\n\ta backup source.\n"));
1575 * zpool_import() is a contracted interface. Should be kept the same
1576 * if possible.
1578 * Applications should use zpool_import_props() to import a pool with
1579 * new properties value to be set.
1582 zpool_import(libzfs_handle_t *hdl, nvlist_t *config, const char *newname,
1583 char *altroot)
1585 nvlist_t *props = NULL;
1586 int ret;
1588 if (altroot != NULL) {
1589 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0) {
1590 return (zfs_error_fmt(hdl, EZFS_NOMEM,
1591 dgettext(TEXT_DOMAIN, "cannot import '%s'"),
1592 newname));
1595 if (nvlist_add_string(props,
1596 zpool_prop_to_name(ZPOOL_PROP_ALTROOT), altroot) != 0 ||
1597 nvlist_add_string(props,
1598 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE), "none") != 0) {
1599 nvlist_free(props);
1600 return (zfs_error_fmt(hdl, EZFS_NOMEM,
1601 dgettext(TEXT_DOMAIN, "cannot import '%s'"),
1602 newname));
1606 ret = zpool_import_props(hdl, config, newname, props,
1607 ZFS_IMPORT_NORMAL);
1608 nvlist_free(props);
1609 return (ret);
1612 static void
1613 print_vdev_tree(libzfs_handle_t *hdl, const char *name, nvlist_t *nv,
1614 int indent)
1616 nvlist_t **child;
1617 uint_t c, children;
1618 char *vname;
1619 uint64_t is_log = 0;
1621 (void) nvlist_lookup_uint64(nv, ZPOOL_CONFIG_IS_LOG,
1622 &is_log);
1624 if (name != NULL)
1625 (void) printf("\t%*s%s%s\n", indent, "", name,
1626 is_log ? " [log]" : "");
1628 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1629 &child, &children) != 0)
1630 return;
1632 for (c = 0; c < children; c++) {
1633 vname = zpool_vdev_name(hdl, NULL, child[c], B_TRUE);
1634 print_vdev_tree(hdl, vname, child[c], indent + 2);
1635 free(vname);
1639 void
1640 zpool_print_unsup_feat(nvlist_t *config)
1642 nvlist_t *nvinfo, *unsup_feat;
1644 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_LOAD_INFO, &nvinfo) ==
1646 verify(nvlist_lookup_nvlist(nvinfo, ZPOOL_CONFIG_UNSUP_FEAT,
1647 &unsup_feat) == 0);
1649 for (nvpair_t *nvp = nvlist_next_nvpair(unsup_feat, NULL); nvp != NULL;
1650 nvp = nvlist_next_nvpair(unsup_feat, nvp)) {
1651 char *desc;
1653 verify(nvpair_type(nvp) == DATA_TYPE_STRING);
1654 verify(nvpair_value_string(nvp, &desc) == 0);
1656 if (strlen(desc) > 0)
1657 (void) printf("\t%s (%s)\n", nvpair_name(nvp), desc);
1658 else
1659 (void) printf("\t%s\n", nvpair_name(nvp));
1664 * Import the given pool using the known configuration and a list of
1665 * properties to be set. The configuration should have come from
1666 * zpool_find_import(). The 'newname' parameters control whether the pool
1667 * is imported with a different name.
1670 zpool_import_props(libzfs_handle_t *hdl, nvlist_t *config, const char *newname,
1671 nvlist_t *props, int flags)
1673 zfs_cmd_t zc = { 0 };
1674 zpool_rewind_policy_t policy;
1675 nvlist_t *nv = NULL;
1676 nvlist_t *nvinfo = NULL;
1677 nvlist_t *missing = NULL;
1678 char *thename;
1679 char *origname;
1680 int ret;
1681 int error = 0;
1682 char errbuf[1024];
1684 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
1685 &origname) == 0);
1687 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1688 "cannot import pool '%s'"), origname);
1690 if (newname != NULL) {
1691 if (!zpool_name_valid(hdl, B_FALSE, newname))
1692 return (zfs_error_fmt(hdl, EZFS_INVALIDNAME,
1693 dgettext(TEXT_DOMAIN, "cannot import '%s'"),
1694 newname));
1695 thename = (char *)newname;
1696 } else {
1697 thename = origname;
1700 if (props != NULL) {
1701 uint64_t version;
1702 prop_flags_t flags = { .create = B_FALSE, .import = B_TRUE };
1704 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
1705 &version) == 0);
1707 if ((props = zpool_valid_proplist(hdl, origname,
1708 props, version, flags, errbuf)) == NULL)
1709 return (-1);
1710 if (zcmd_write_src_nvlist(hdl, &zc, props) != 0) {
1711 nvlist_free(props);
1712 return (-1);
1714 nvlist_free(props);
1717 (void) strlcpy(zc.zc_name, thename, sizeof (zc.zc_name));
1719 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
1720 &zc.zc_guid) == 0);
1722 if (zcmd_write_conf_nvlist(hdl, &zc, config) != 0) {
1723 zcmd_free_nvlists(&zc);
1724 return (-1);
1726 if (zcmd_alloc_dst_nvlist(hdl, &zc, zc.zc_nvlist_conf_size * 2) != 0) {
1727 zcmd_free_nvlists(&zc);
1728 return (-1);
1731 zc.zc_cookie = flags;
1732 while ((ret = zfs_ioctl(hdl, ZFS_IOC_POOL_IMPORT, &zc)) != 0 &&
1733 errno == ENOMEM) {
1734 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
1735 zcmd_free_nvlists(&zc);
1736 return (-1);
1739 if (ret != 0)
1740 error = errno;
1742 (void) zcmd_read_dst_nvlist(hdl, &zc, &nv);
1744 zcmd_free_nvlists(&zc);
1746 zpool_get_rewind_policy(config, &policy);
1748 if (error) {
1749 char desc[1024];
1752 * Dry-run failed, but we print out what success
1753 * looks like if we found a best txg
1755 if (policy.zrp_request & ZPOOL_TRY_REWIND) {
1756 zpool_rewind_exclaim(hdl, newname ? origname : thename,
1757 B_TRUE, nv);
1758 nvlist_free(nv);
1759 return (-1);
1762 if (newname == NULL)
1763 (void) snprintf(desc, sizeof (desc),
1764 dgettext(TEXT_DOMAIN, "cannot import '%s'"),
1765 thename);
1766 else
1767 (void) snprintf(desc, sizeof (desc),
1768 dgettext(TEXT_DOMAIN, "cannot import '%s' as '%s'"),
1769 origname, thename);
1771 switch (error) {
1772 case ENOTSUP:
1773 if (nv != NULL && nvlist_lookup_nvlist(nv,
1774 ZPOOL_CONFIG_LOAD_INFO, &nvinfo) == 0 &&
1775 nvlist_exists(nvinfo, ZPOOL_CONFIG_UNSUP_FEAT)) {
1776 (void) printf(dgettext(TEXT_DOMAIN, "This "
1777 "pool uses the following feature(s) not "
1778 "supported by this system:\n"));
1779 zpool_print_unsup_feat(nv);
1780 if (nvlist_exists(nvinfo,
1781 ZPOOL_CONFIG_CAN_RDONLY)) {
1782 (void) printf(dgettext(TEXT_DOMAIN,
1783 "All unsupported features are only "
1784 "required for writing to the pool."
1785 "\nThe pool can be imported using "
1786 "'-o readonly=on'.\n"));
1790 * Unsupported version.
1792 (void) zfs_error(hdl, EZFS_BADVERSION, desc);
1793 break;
1795 case EINVAL:
1796 (void) zfs_error(hdl, EZFS_INVALCONFIG, desc);
1797 break;
1799 case EROFS:
1800 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1801 "one or more devices is read only"));
1802 (void) zfs_error(hdl, EZFS_BADDEV, desc);
1803 break;
1805 case ENXIO:
1806 if (nv && nvlist_lookup_nvlist(nv,
1807 ZPOOL_CONFIG_LOAD_INFO, &nvinfo) == 0 &&
1808 nvlist_lookup_nvlist(nvinfo,
1809 ZPOOL_CONFIG_MISSING_DEVICES, &missing) == 0) {
1810 (void) printf(dgettext(TEXT_DOMAIN,
1811 "The devices below are missing, use "
1812 "'-m' to import the pool anyway:\n"));
1813 print_vdev_tree(hdl, NULL, missing, 2);
1814 (void) printf("\n");
1816 (void) zpool_standard_error(hdl, error, desc);
1817 break;
1819 case EEXIST:
1820 (void) zpool_standard_error(hdl, error, desc);
1821 break;
1822 case ENAMETOOLONG:
1823 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1824 "new name of at least one dataset is longer than "
1825 "the maximum allowable length"));
1826 (void) zfs_error(hdl, EZFS_NAMETOOLONG, desc);
1827 break;
1828 default:
1829 (void) zpool_standard_error(hdl, error, desc);
1830 zpool_explain_recover(hdl,
1831 newname ? origname : thename, -error, nv);
1832 break;
1835 nvlist_free(nv);
1836 ret = -1;
1837 } else {
1838 zpool_handle_t *zhp;
1841 * This should never fail, but play it safe anyway.
1843 if (zpool_open_silent(hdl, thename, &zhp) != 0)
1844 ret = -1;
1845 else if (zhp != NULL)
1846 zpool_close(zhp);
1847 if (policy.zrp_request &
1848 (ZPOOL_DO_REWIND | ZPOOL_TRY_REWIND)) {
1849 zpool_rewind_exclaim(hdl, newname ? origname : thename,
1850 ((policy.zrp_request & ZPOOL_TRY_REWIND) != 0), nv);
1852 nvlist_free(nv);
1853 return (0);
1856 return (ret);
1860 * Scan the pool.
1863 zpool_scan(zpool_handle_t *zhp, pool_scan_func_t func, pool_scrub_cmd_t cmd)
1865 zfs_cmd_t zc = { 0 };
1866 char msg[1024];
1867 int err;
1868 libzfs_handle_t *hdl = zhp->zpool_hdl;
1870 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
1871 zc.zc_cookie = func;
1872 zc.zc_flags = cmd;
1874 if (zfs_ioctl(hdl, ZFS_IOC_POOL_SCAN, &zc) == 0)
1875 return (0);
1877 err = errno;
1879 /* ECANCELED on a scrub means we resumed a paused scrub */
1880 if (err == ECANCELED && func == POOL_SCAN_SCRUB &&
1881 cmd == POOL_SCRUB_NORMAL)
1882 return (0);
1884 if (err == ENOENT && func != POOL_SCAN_NONE && cmd == POOL_SCRUB_NORMAL)
1885 return (0);
1887 if (func == POOL_SCAN_SCRUB) {
1888 if (cmd == POOL_SCRUB_PAUSE) {
1889 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
1890 "cannot pause scrubbing %s"), zc.zc_name);
1891 } else {
1892 assert(cmd == POOL_SCRUB_NORMAL);
1893 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
1894 "cannot scrub %s"), zc.zc_name);
1896 } else if (func == POOL_SCAN_NONE) {
1897 (void) snprintf(msg, sizeof (msg),
1898 dgettext(TEXT_DOMAIN, "cannot cancel scrubbing %s"),
1899 zc.zc_name);
1900 } else {
1901 assert(!"unexpected result");
1904 if (err == EBUSY) {
1905 nvlist_t *nvroot;
1906 pool_scan_stat_t *ps = NULL;
1907 uint_t psc;
1909 verify(nvlist_lookup_nvlist(zhp->zpool_config,
1910 ZPOOL_CONFIG_VDEV_TREE, &nvroot) == 0);
1911 (void) nvlist_lookup_uint64_array(nvroot,
1912 ZPOOL_CONFIG_SCAN_STATS, (uint64_t **)&ps, &psc);
1913 if (ps && ps->pss_func == POOL_SCAN_SCRUB) {
1914 if (cmd == POOL_SCRUB_PAUSE)
1915 return (zfs_error(hdl, EZFS_SCRUB_PAUSED, msg));
1916 else
1917 return (zfs_error(hdl, EZFS_SCRUBBING, msg));
1918 } else {
1919 return (zfs_error(hdl, EZFS_RESILVERING, msg));
1921 } else if (err == ENOENT) {
1922 return (zfs_error(hdl, EZFS_NO_SCRUB, msg));
1923 } else {
1924 return (zpool_standard_error(hdl, err, msg));
1929 * This provides a very minimal check whether a given string is likely a
1930 * c#t#d# style string. Users of this are expected to do their own
1931 * verification of the s# part.
1933 #define CTD_CHECK(str) (str && str[0] == 'c' && isdigit(str[1]))
1936 * More elaborate version for ones which may start with "/dev/dsk/"
1937 * and the like.
1939 static int
1940 ctd_check_path(char *str)
1943 * If it starts with a slash, check the last component.
1945 if (str && str[0] == '/') {
1946 char *tmp = strrchr(str, '/');
1949 * If it ends in "/old", check the second-to-last
1950 * component of the string instead.
1952 if (tmp != str && strcmp(tmp, "/old") == 0) {
1953 for (tmp--; *tmp != '/'; tmp--)
1956 str = tmp + 1;
1958 return (CTD_CHECK(str));
1962 * Find a vdev that matches the search criteria specified. We use the
1963 * the nvpair name to determine how we should look for the device.
1964 * 'avail_spare' is set to TRUE if the provided guid refers to an AVAIL
1965 * spare; but FALSE if its an INUSE spare.
1967 static nvlist_t *
1968 vdev_to_nvlist_iter(nvlist_t *nv, nvlist_t *search, boolean_t *avail_spare,
1969 boolean_t *l2cache, boolean_t *log)
1971 uint_t c, children;
1972 nvlist_t **child;
1973 nvlist_t *ret;
1974 uint64_t is_log;
1975 char *srchkey;
1976 nvpair_t *pair = nvlist_next_nvpair(search, NULL);
1978 /* Nothing to look for */
1979 if (search == NULL || pair == NULL)
1980 return (NULL);
1982 /* Obtain the key we will use to search */
1983 srchkey = nvpair_name(pair);
1985 switch (nvpair_type(pair)) {
1986 case DATA_TYPE_UINT64:
1987 if (strcmp(srchkey, ZPOOL_CONFIG_GUID) == 0) {
1988 uint64_t srchval, theguid;
1990 verify(nvpair_value_uint64(pair, &srchval) == 0);
1991 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID,
1992 &theguid) == 0);
1993 if (theguid == srchval)
1994 return (nv);
1996 break;
1998 case DATA_TYPE_STRING: {
1999 char *srchval, *val;
2001 verify(nvpair_value_string(pair, &srchval) == 0);
2002 if (nvlist_lookup_string(nv, srchkey, &val) != 0)
2003 break;
2006 * Search for the requested value. Special cases:
2008 * - ZPOOL_CONFIG_PATH for whole disk entries. To support
2009 * UEFI boot, these end in "s0" or "s0/old" or "s1" or
2010 * "s1/old". The "s0" or "s1" part is hidden from the user,
2011 * but included in the string, so this matches around it.
2012 * - looking for a top-level vdev name (i.e. ZPOOL_CONFIG_TYPE).
2014 * Otherwise, all other searches are simple string compares.
2016 if (strcmp(srchkey, ZPOOL_CONFIG_PATH) == 0 &&
2017 ctd_check_path(val)) {
2018 uint64_t wholedisk = 0;
2020 (void) nvlist_lookup_uint64(nv, ZPOOL_CONFIG_WHOLE_DISK,
2021 &wholedisk);
2022 if (wholedisk) {
2023 int slen = strlen(srchval);
2024 int vlen = strlen(val);
2026 if (slen != vlen - 2)
2027 break;
2030 * make_leaf_vdev() should only set
2031 * wholedisk for ZPOOL_CONFIG_PATHs which
2032 * will include "/dev/dsk/", giving plenty of
2033 * room for the indices used next.
2035 ASSERT(vlen >= 6);
2038 * strings identical except trailing "s0"
2040 if ((strcmp(&val[vlen - 2], "s0") == 0 ||
2041 strcmp(&val[vlen - 2], "s1") == 0) &&
2042 strncmp(srchval, val, slen) == 0)
2043 return (nv);
2046 * strings identical except trailing "s0/old"
2048 if ((strcmp(&val[vlen - 6], "s0/old") == 0 ||
2049 strcmp(&val[vlen - 6], "s1/old") == 0) &&
2050 strcmp(&srchval[slen - 4], "/old") == 0 &&
2051 strncmp(srchval, val, slen - 4) == 0)
2052 return (nv);
2054 break;
2056 } else if (strcmp(srchkey, ZPOOL_CONFIG_TYPE) == 0 && val) {
2057 char *type, *idx, *end, *p;
2058 uint64_t id, vdev_id;
2061 * Determine our vdev type, keeping in mind
2062 * that the srchval is composed of a type and
2063 * vdev id pair (i.e. mirror-4).
2065 if ((type = strdup(srchval)) == NULL)
2066 return (NULL);
2068 if ((p = strrchr(type, '-')) == NULL) {
2069 free(type);
2070 break;
2072 idx = p + 1;
2073 *p = '\0';
2076 * If the types don't match then keep looking.
2078 if (strncmp(val, type, strlen(val)) != 0) {
2079 free(type);
2080 break;
2083 verify(zpool_vdev_is_interior(type));
2084 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_ID,
2085 &id) == 0);
2087 errno = 0;
2088 vdev_id = strtoull(idx, &end, 10);
2090 free(type);
2091 if (errno != 0)
2092 return (NULL);
2095 * Now verify that we have the correct vdev id.
2097 if (vdev_id == id)
2098 return (nv);
2102 * Common case
2104 if (strcmp(srchval, val) == 0)
2105 return (nv);
2106 break;
2109 default:
2110 break;
2113 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
2114 &child, &children) != 0)
2115 return (NULL);
2117 for (c = 0; c < children; c++) {
2118 if ((ret = vdev_to_nvlist_iter(child[c], search,
2119 avail_spare, l2cache, NULL)) != NULL) {
2121 * The 'is_log' value is only set for the toplevel
2122 * vdev, not the leaf vdevs. So we always lookup the
2123 * log device from the root of the vdev tree (where
2124 * 'log' is non-NULL).
2126 if (log != NULL &&
2127 nvlist_lookup_uint64(child[c],
2128 ZPOOL_CONFIG_IS_LOG, &is_log) == 0 &&
2129 is_log) {
2130 *log = B_TRUE;
2132 return (ret);
2136 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_SPARES,
2137 &child, &children) == 0) {
2138 for (c = 0; c < children; c++) {
2139 if ((ret = vdev_to_nvlist_iter(child[c], search,
2140 avail_spare, l2cache, NULL)) != NULL) {
2141 *avail_spare = B_TRUE;
2142 return (ret);
2147 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE,
2148 &child, &children) == 0) {
2149 for (c = 0; c < children; c++) {
2150 if ((ret = vdev_to_nvlist_iter(child[c], search,
2151 avail_spare, l2cache, NULL)) != NULL) {
2152 *l2cache = B_TRUE;
2153 return (ret);
2158 return (NULL);
2162 * Given a physical path (minus the "/devices" prefix), find the
2163 * associated vdev.
2165 nvlist_t *
2166 zpool_find_vdev_by_physpath(zpool_handle_t *zhp, const char *ppath,
2167 boolean_t *avail_spare, boolean_t *l2cache, boolean_t *log)
2169 nvlist_t *search, *nvroot, *ret;
2171 verify(nvlist_alloc(&search, NV_UNIQUE_NAME, KM_SLEEP) == 0);
2172 verify(nvlist_add_string(search, ZPOOL_CONFIG_PHYS_PATH, ppath) == 0);
2174 verify(nvlist_lookup_nvlist(zhp->zpool_config, ZPOOL_CONFIG_VDEV_TREE,
2175 &nvroot) == 0);
2177 *avail_spare = B_FALSE;
2178 *l2cache = B_FALSE;
2179 if (log != NULL)
2180 *log = B_FALSE;
2181 ret = vdev_to_nvlist_iter(nvroot, search, avail_spare, l2cache, log);
2182 nvlist_free(search);
2184 return (ret);
2188 * Determine if we have an "interior" top-level vdev (i.e mirror/raidz).
2190 static boolean_t
2191 zpool_vdev_is_interior(const char *name)
2193 if (strncmp(name, VDEV_TYPE_RAIDZ, strlen(VDEV_TYPE_RAIDZ)) == 0 ||
2194 strncmp(name, VDEV_TYPE_SPARE, strlen(VDEV_TYPE_SPARE)) == 0 ||
2195 strncmp(name,
2196 VDEV_TYPE_REPLACING, strlen(VDEV_TYPE_REPLACING)) == 0 ||
2197 strncmp(name, VDEV_TYPE_MIRROR, strlen(VDEV_TYPE_MIRROR)) == 0)
2198 return (B_TRUE);
2199 return (B_FALSE);
2202 nvlist_t *
2203 zpool_find_vdev(zpool_handle_t *zhp, const char *path, boolean_t *avail_spare,
2204 boolean_t *l2cache, boolean_t *log)
2206 char buf[MAXPATHLEN];
2207 char *end;
2208 nvlist_t *nvroot, *search, *ret;
2209 uint64_t guid;
2211 verify(nvlist_alloc(&search, NV_UNIQUE_NAME, KM_SLEEP) == 0);
2213 guid = strtoull(path, &end, 10);
2214 if (guid != 0 && *end == '\0') {
2215 verify(nvlist_add_uint64(search, ZPOOL_CONFIG_GUID, guid) == 0);
2216 } else if (zpool_vdev_is_interior(path)) {
2217 verify(nvlist_add_string(search, ZPOOL_CONFIG_TYPE, path) == 0);
2218 } else if (path[0] != '/') {
2219 (void) snprintf(buf, sizeof (buf), "%s/%s", ZFS_DISK_ROOT,
2220 path);
2221 verify(nvlist_add_string(search, ZPOOL_CONFIG_PATH, buf) == 0);
2222 } else {
2223 verify(nvlist_add_string(search, ZPOOL_CONFIG_PATH, path) == 0);
2226 verify(nvlist_lookup_nvlist(zhp->zpool_config, ZPOOL_CONFIG_VDEV_TREE,
2227 &nvroot) == 0);
2229 *avail_spare = B_FALSE;
2230 *l2cache = B_FALSE;
2231 if (log != NULL)
2232 *log = B_FALSE;
2233 ret = vdev_to_nvlist_iter(nvroot, search, avail_spare, l2cache, log);
2234 nvlist_free(search);
2236 return (ret);
2239 static int
2240 vdev_online(nvlist_t *nv)
2242 uint64_t ival;
2244 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_OFFLINE, &ival) == 0 ||
2245 nvlist_lookup_uint64(nv, ZPOOL_CONFIG_FAULTED, &ival) == 0 ||
2246 nvlist_lookup_uint64(nv, ZPOOL_CONFIG_REMOVED, &ival) == 0)
2247 return (0);
2249 return (1);
2253 * Helper function for zpool_get_physpaths().
2255 static int
2256 vdev_get_one_physpath(nvlist_t *config, char *physpath, size_t physpath_size,
2257 size_t *bytes_written)
2259 size_t bytes_left, pos, rsz;
2260 char *tmppath;
2261 const char *format;
2263 if (nvlist_lookup_string(config, ZPOOL_CONFIG_PHYS_PATH,
2264 &tmppath) != 0)
2265 return (EZFS_NODEVICE);
2267 pos = *bytes_written;
2268 bytes_left = physpath_size - pos;
2269 format = (pos == 0) ? "%s" : " %s";
2271 rsz = snprintf(physpath + pos, bytes_left, format, tmppath);
2272 *bytes_written += rsz;
2274 if (rsz >= bytes_left) {
2275 /* if physpath was not copied properly, clear it */
2276 if (bytes_left != 0) {
2277 physpath[pos] = 0;
2279 return (EZFS_NOSPC);
2281 return (0);
2284 static int
2285 vdev_get_physpaths(nvlist_t *nv, char *physpath, size_t phypath_size,
2286 size_t *rsz, boolean_t is_spare)
2288 char *type;
2289 int ret;
2291 if (nvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE, &type) != 0)
2292 return (EZFS_INVALCONFIG);
2294 if (strcmp(type, VDEV_TYPE_DISK) == 0) {
2296 * An active spare device has ZPOOL_CONFIG_IS_SPARE set.
2297 * For a spare vdev, we only want to boot from the active
2298 * spare device.
2300 if (is_spare) {
2301 uint64_t spare = 0;
2302 (void) nvlist_lookup_uint64(nv, ZPOOL_CONFIG_IS_SPARE,
2303 &spare);
2304 if (!spare)
2305 return (EZFS_INVALCONFIG);
2308 if (vdev_online(nv)) {
2309 if ((ret = vdev_get_one_physpath(nv, physpath,
2310 phypath_size, rsz)) != 0)
2311 return (ret);
2313 } else if (strcmp(type, VDEV_TYPE_MIRROR) == 0 ||
2314 strcmp(type, VDEV_TYPE_RAIDZ) == 0 ||
2315 strcmp(type, VDEV_TYPE_REPLACING) == 0 ||
2316 (is_spare = (strcmp(type, VDEV_TYPE_SPARE) == 0))) {
2317 nvlist_t **child;
2318 uint_t count;
2319 int i, ret;
2321 if (nvlist_lookup_nvlist_array(nv,
2322 ZPOOL_CONFIG_CHILDREN, &child, &count) != 0)
2323 return (EZFS_INVALCONFIG);
2325 for (i = 0; i < count; i++) {
2326 ret = vdev_get_physpaths(child[i], physpath,
2327 phypath_size, rsz, is_spare);
2328 if (ret == EZFS_NOSPC)
2329 return (ret);
2333 return (EZFS_POOL_INVALARG);
2337 * Get phys_path for a root pool config.
2338 * Return 0 on success; non-zero on failure.
2340 static int
2341 zpool_get_config_physpath(nvlist_t *config, char *physpath, size_t phypath_size)
2343 size_t rsz;
2344 nvlist_t *vdev_root;
2345 nvlist_t **child;
2346 uint_t count;
2347 char *type;
2349 rsz = 0;
2351 if (nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
2352 &vdev_root) != 0)
2353 return (EZFS_INVALCONFIG);
2355 if (nvlist_lookup_string(vdev_root, ZPOOL_CONFIG_TYPE, &type) != 0 ||
2356 nvlist_lookup_nvlist_array(vdev_root, ZPOOL_CONFIG_CHILDREN,
2357 &child, &count) != 0)
2358 return (EZFS_INVALCONFIG);
2361 * root pool can only have a single top-level vdev.
2363 if (strcmp(type, VDEV_TYPE_ROOT) != 0 || count != 1)
2364 return (EZFS_POOL_INVALARG);
2366 (void) vdev_get_physpaths(child[0], physpath, phypath_size, &rsz,
2367 B_FALSE);
2369 /* No online devices */
2370 if (rsz == 0)
2371 return (EZFS_NODEVICE);
2373 return (0);
2377 * Get phys_path for a root pool
2378 * Return 0 on success; non-zero on failure.
2381 zpool_get_physpath(zpool_handle_t *zhp, char *physpath, size_t phypath_size)
2383 return (zpool_get_config_physpath(zhp->zpool_config, physpath,
2384 phypath_size));
2388 * If the device has being dynamically expanded then we need to relabel
2389 * the disk to use the new unallocated space.
2391 static int
2392 zpool_relabel_disk(libzfs_handle_t *hdl, const char *name)
2394 char path[MAXPATHLEN];
2395 char errbuf[1024];
2396 int fd, error;
2397 int (*_efi_use_whole_disk)(int);
2399 if ((_efi_use_whole_disk = (int (*)(int))dlsym(RTLD_DEFAULT,
2400 "efi_use_whole_disk")) == NULL)
2401 return (-1);
2403 (void) snprintf(path, sizeof (path), "%s/%s", ZFS_RDISK_ROOT, name);
2405 if ((fd = open(path, O_RDWR | O_NDELAY)) < 0) {
2406 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "cannot "
2407 "relabel '%s': unable to open device"), name);
2408 return (zfs_error(hdl, EZFS_OPENFAILED, errbuf));
2412 * It's possible that we might encounter an error if the device
2413 * does not have any unallocated space left. If so, we simply
2414 * ignore that error and continue on.
2416 error = _efi_use_whole_disk(fd);
2417 (void) close(fd);
2418 if (error && error != VT_ENOSPC) {
2419 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "cannot "
2420 "relabel '%s': unable to read disk capacity"), name);
2421 return (zfs_error(hdl, EZFS_NOCAP, errbuf));
2423 return (0);
2427 * Bring the specified vdev online. The 'flags' parameter is a set of the
2428 * ZFS_ONLINE_* flags.
2431 zpool_vdev_online(zpool_handle_t *zhp, const char *path, int flags,
2432 vdev_state_t *newstate)
2434 zfs_cmd_t zc = { 0 };
2435 char msg[1024];
2436 char *pathname;
2437 nvlist_t *tgt;
2438 boolean_t avail_spare, l2cache, islog;
2439 libzfs_handle_t *hdl = zhp->zpool_hdl;
2441 if (flags & ZFS_ONLINE_EXPAND) {
2442 (void) snprintf(msg, sizeof (msg),
2443 dgettext(TEXT_DOMAIN, "cannot expand %s"), path);
2444 } else {
2445 (void) snprintf(msg, sizeof (msg),
2446 dgettext(TEXT_DOMAIN, "cannot online %s"), path);
2449 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
2450 if ((tgt = zpool_find_vdev(zhp, path, &avail_spare, &l2cache,
2451 &islog)) == NULL)
2452 return (zfs_error(hdl, EZFS_NODEVICE, msg));
2454 verify(nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_GUID, &zc.zc_guid) == 0);
2456 if (avail_spare)
2457 return (zfs_error(hdl, EZFS_ISSPARE, msg));
2459 if ((flags & ZFS_ONLINE_EXPAND ||
2460 zpool_get_prop_int(zhp, ZPOOL_PROP_AUTOEXPAND, NULL)) &&
2461 nvlist_lookup_string(tgt, ZPOOL_CONFIG_PATH, &pathname) == 0) {
2462 uint64_t wholedisk = 0;
2464 (void) nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_WHOLE_DISK,
2465 &wholedisk);
2468 * XXX - L2ARC 1.0 devices can't support expansion.
2470 if (l2cache) {
2471 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2472 "cannot expand cache devices"));
2473 return (zfs_error(hdl, EZFS_VDEVNOTSUP, msg));
2476 if (wholedisk) {
2477 pathname += strlen(ZFS_DISK_ROOT) + 1;
2478 (void) zpool_relabel_disk(hdl, pathname);
2482 zc.zc_cookie = VDEV_STATE_ONLINE;
2483 zc.zc_obj = flags;
2485 if (zfs_ioctl(hdl, ZFS_IOC_VDEV_SET_STATE, &zc) != 0) {
2486 if (errno == EINVAL) {
2487 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "was split "
2488 "from this pool into a new one. Use '%s' "
2489 "instead"), "zpool detach");
2490 return (zfs_error(hdl, EZFS_POSTSPLIT_ONLINE, msg));
2492 return (zpool_standard_error(hdl, errno, msg));
2495 *newstate = zc.zc_cookie;
2496 return (0);
2500 * Take the specified vdev offline
2503 zpool_vdev_offline(zpool_handle_t *zhp, const char *path, boolean_t istmp)
2505 zfs_cmd_t zc = { 0 };
2506 char msg[1024];
2507 nvlist_t *tgt;
2508 boolean_t avail_spare, l2cache;
2509 libzfs_handle_t *hdl = zhp->zpool_hdl;
2511 (void) snprintf(msg, sizeof (msg),
2512 dgettext(TEXT_DOMAIN, "cannot offline %s"), path);
2514 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
2515 if ((tgt = zpool_find_vdev(zhp, path, &avail_spare, &l2cache,
2516 NULL)) == NULL)
2517 return (zfs_error(hdl, EZFS_NODEVICE, msg));
2519 verify(nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_GUID, &zc.zc_guid) == 0);
2521 if (avail_spare)
2522 return (zfs_error(hdl, EZFS_ISSPARE, msg));
2524 zc.zc_cookie = VDEV_STATE_OFFLINE;
2525 zc.zc_obj = istmp ? ZFS_OFFLINE_TEMPORARY : 0;
2527 if (zfs_ioctl(hdl, ZFS_IOC_VDEV_SET_STATE, &zc) == 0)
2528 return (0);
2530 switch (errno) {
2531 case EBUSY:
2534 * There are no other replicas of this device.
2536 return (zfs_error(hdl, EZFS_NOREPLICAS, msg));
2538 case EEXIST:
2540 * The log device has unplayed logs
2542 return (zfs_error(hdl, EZFS_UNPLAYED_LOGS, msg));
2544 default:
2545 return (zpool_standard_error(hdl, errno, msg));
2550 * Mark the given vdev faulted.
2553 zpool_vdev_fault(zpool_handle_t *zhp, uint64_t guid, vdev_aux_t aux)
2555 zfs_cmd_t zc = { 0 };
2556 char msg[1024];
2557 libzfs_handle_t *hdl = zhp->zpool_hdl;
2559 (void) snprintf(msg, sizeof (msg),
2560 dgettext(TEXT_DOMAIN, "cannot fault %llu"), guid);
2562 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
2563 zc.zc_guid = guid;
2564 zc.zc_cookie = VDEV_STATE_FAULTED;
2565 zc.zc_obj = aux;
2567 if (ioctl(hdl->libzfs_fd, ZFS_IOC_VDEV_SET_STATE, &zc) == 0)
2568 return (0);
2570 switch (errno) {
2571 case EBUSY:
2574 * There are no other replicas of this device.
2576 return (zfs_error(hdl, EZFS_NOREPLICAS, msg));
2578 default:
2579 return (zpool_standard_error(hdl, errno, msg));
2585 * Mark the given vdev degraded.
2588 zpool_vdev_degrade(zpool_handle_t *zhp, uint64_t guid, vdev_aux_t aux)
2590 zfs_cmd_t zc = { 0 };
2591 char msg[1024];
2592 libzfs_handle_t *hdl = zhp->zpool_hdl;
2594 (void) snprintf(msg, sizeof (msg),
2595 dgettext(TEXT_DOMAIN, "cannot degrade %llu"), guid);
2597 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
2598 zc.zc_guid = guid;
2599 zc.zc_cookie = VDEV_STATE_DEGRADED;
2600 zc.zc_obj = aux;
2602 if (ioctl(hdl->libzfs_fd, ZFS_IOC_VDEV_SET_STATE, &zc) == 0)
2603 return (0);
2605 return (zpool_standard_error(hdl, errno, msg));
2609 * Returns TRUE if the given nvlist is a vdev that was originally swapped in as
2610 * a hot spare.
2612 static boolean_t
2613 is_replacing_spare(nvlist_t *search, nvlist_t *tgt, int which)
2615 nvlist_t **child;
2616 uint_t c, children;
2617 char *type;
2619 if (nvlist_lookup_nvlist_array(search, ZPOOL_CONFIG_CHILDREN, &child,
2620 &children) == 0) {
2621 verify(nvlist_lookup_string(search, ZPOOL_CONFIG_TYPE,
2622 &type) == 0);
2624 if (strcmp(type, VDEV_TYPE_SPARE) == 0 &&
2625 children == 2 && child[which] == tgt)
2626 return (B_TRUE);
2628 for (c = 0; c < children; c++)
2629 if (is_replacing_spare(child[c], tgt, which))
2630 return (B_TRUE);
2633 return (B_FALSE);
2637 * Attach new_disk (fully described by nvroot) to old_disk.
2638 * If 'replacing' is specified, the new disk will replace the old one.
2641 zpool_vdev_attach(zpool_handle_t *zhp,
2642 const char *old_disk, const char *new_disk, nvlist_t *nvroot, int replacing)
2644 zfs_cmd_t zc = { 0 };
2645 char msg[1024];
2646 int ret;
2647 nvlist_t *tgt;
2648 boolean_t avail_spare, l2cache, islog;
2649 uint64_t val;
2650 char *newname;
2651 nvlist_t **child;
2652 uint_t children;
2653 nvlist_t *config_root;
2654 libzfs_handle_t *hdl = zhp->zpool_hdl;
2655 boolean_t rootpool = zpool_is_bootable(zhp);
2657 if (replacing)
2658 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
2659 "cannot replace %s with %s"), old_disk, new_disk);
2660 else
2661 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
2662 "cannot attach %s to %s"), new_disk, old_disk);
2664 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
2665 if ((tgt = zpool_find_vdev(zhp, old_disk, &avail_spare, &l2cache,
2666 &islog)) == NULL)
2667 return (zfs_error(hdl, EZFS_NODEVICE, msg));
2669 if (avail_spare)
2670 return (zfs_error(hdl, EZFS_ISSPARE, msg));
2672 if (l2cache)
2673 return (zfs_error(hdl, EZFS_ISL2CACHE, msg));
2675 verify(nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_GUID, &zc.zc_guid) == 0);
2676 zc.zc_cookie = replacing;
2678 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN,
2679 &child, &children) != 0 || children != 1) {
2680 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2681 "new device must be a single disk"));
2682 return (zfs_error(hdl, EZFS_INVALCONFIG, msg));
2685 verify(nvlist_lookup_nvlist(zpool_get_config(zhp, NULL),
2686 ZPOOL_CONFIG_VDEV_TREE, &config_root) == 0);
2688 if ((newname = zpool_vdev_name(NULL, NULL, child[0], B_FALSE)) == NULL)
2689 return (-1);
2692 * If the target is a hot spare that has been swapped in, we can only
2693 * replace it with another hot spare.
2695 if (replacing &&
2696 nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_IS_SPARE, &val) == 0 &&
2697 (zpool_find_vdev(zhp, newname, &avail_spare, &l2cache,
2698 NULL) == NULL || !avail_spare) &&
2699 is_replacing_spare(config_root, tgt, 1)) {
2700 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2701 "can only be replaced by another hot spare"));
2702 free(newname);
2703 return (zfs_error(hdl, EZFS_BADTARGET, msg));
2706 free(newname);
2708 if (zcmd_write_conf_nvlist(hdl, &zc, nvroot) != 0)
2709 return (-1);
2711 ret = zfs_ioctl(hdl, ZFS_IOC_VDEV_ATTACH, &zc);
2713 zcmd_free_nvlists(&zc);
2715 if (ret == 0) {
2716 if (rootpool) {
2718 * XXX need a better way to prevent user from
2719 * booting up a half-baked vdev.
2721 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "Make "
2722 "sure to wait until resilver is done "
2723 "before rebooting.\n"));
2725 return (0);
2728 switch (errno) {
2729 case ENOTSUP:
2731 * Can't attach to or replace this type of vdev.
2733 if (replacing) {
2734 uint64_t version = zpool_get_prop_int(zhp,
2735 ZPOOL_PROP_VERSION, NULL);
2737 if (islog)
2738 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2739 "cannot replace a log with a spare"));
2740 else if (version >= SPA_VERSION_MULTI_REPLACE)
2741 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2742 "already in replacing/spare config; wait "
2743 "for completion or use 'zpool detach'"));
2744 else
2745 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2746 "cannot replace a replacing device"));
2747 } else {
2748 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2749 "can only attach to mirrors and top-level "
2750 "disks"));
2752 (void) zfs_error(hdl, EZFS_BADTARGET, msg);
2753 break;
2755 case EINVAL:
2757 * The new device must be a single disk.
2759 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2760 "new device must be a single disk"));
2761 (void) zfs_error(hdl, EZFS_INVALCONFIG, msg);
2762 break;
2764 case EBUSY:
2765 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "%s is busy, "
2766 "or pool has removing/removed vdevs"),
2767 new_disk);
2768 (void) zfs_error(hdl, EZFS_BADDEV, msg);
2769 break;
2771 case EOVERFLOW:
2773 * The new device is too small.
2775 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2776 "device is too small"));
2777 (void) zfs_error(hdl, EZFS_BADDEV, msg);
2778 break;
2780 case EDOM:
2782 * The new device has a different alignment requirement.
2784 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2785 "devices have different sector alignment"));
2786 (void) zfs_error(hdl, EZFS_BADDEV, msg);
2787 break;
2789 case ENAMETOOLONG:
2791 * The resulting top-level vdev spec won't fit in the label.
2793 (void) zfs_error(hdl, EZFS_DEVOVERFLOW, msg);
2794 break;
2796 default:
2797 (void) zpool_standard_error(hdl, errno, msg);
2800 return (-1);
2804 * Detach the specified device.
2807 zpool_vdev_detach(zpool_handle_t *zhp, const char *path)
2809 zfs_cmd_t zc = { 0 };
2810 char msg[1024];
2811 nvlist_t *tgt;
2812 boolean_t avail_spare, l2cache;
2813 libzfs_handle_t *hdl = zhp->zpool_hdl;
2815 (void) snprintf(msg, sizeof (msg),
2816 dgettext(TEXT_DOMAIN, "cannot detach %s"), path);
2818 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
2819 if ((tgt = zpool_find_vdev(zhp, path, &avail_spare, &l2cache,
2820 NULL)) == NULL)
2821 return (zfs_error(hdl, EZFS_NODEVICE, msg));
2823 if (avail_spare)
2824 return (zfs_error(hdl, EZFS_ISSPARE, msg));
2826 if (l2cache)
2827 return (zfs_error(hdl, EZFS_ISL2CACHE, msg));
2829 verify(nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_GUID, &zc.zc_guid) == 0);
2831 if (zfs_ioctl(hdl, ZFS_IOC_VDEV_DETACH, &zc) == 0)
2832 return (0);
2834 switch (errno) {
2836 case ENOTSUP:
2838 * Can't detach from this type of vdev.
2840 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "only "
2841 "applicable to mirror and replacing vdevs"));
2842 (void) zfs_error(hdl, EZFS_BADTARGET, msg);
2843 break;
2845 case EBUSY:
2847 * There are no other replicas of this device.
2849 (void) zfs_error(hdl, EZFS_NOREPLICAS, msg);
2850 break;
2852 default:
2853 (void) zpool_standard_error(hdl, errno, msg);
2856 return (-1);
2860 * Find a mirror vdev in the source nvlist.
2862 * The mchild array contains a list of disks in one of the top-level mirrors
2863 * of the source pool. The schild array contains a list of disks that the
2864 * user specified on the command line. We loop over the mchild array to
2865 * see if any entry in the schild array matches.
2867 * If a disk in the mchild array is found in the schild array, we return
2868 * the index of that entry. Otherwise we return -1.
2870 static int
2871 find_vdev_entry(zpool_handle_t *zhp, nvlist_t **mchild, uint_t mchildren,
2872 nvlist_t **schild, uint_t schildren)
2874 uint_t mc;
2876 for (mc = 0; mc < mchildren; mc++) {
2877 uint_t sc;
2878 char *mpath = zpool_vdev_name(zhp->zpool_hdl, zhp,
2879 mchild[mc], B_FALSE);
2881 for (sc = 0; sc < schildren; sc++) {
2882 char *spath = zpool_vdev_name(zhp->zpool_hdl, zhp,
2883 schild[sc], B_FALSE);
2884 boolean_t result = (strcmp(mpath, spath) == 0);
2886 free(spath);
2887 if (result) {
2888 free(mpath);
2889 return (mc);
2893 free(mpath);
2896 return (-1);
2900 * Split a mirror pool. If newroot points to null, then a new nvlist
2901 * is generated and it is the responsibility of the caller to free it.
2904 zpool_vdev_split(zpool_handle_t *zhp, char *newname, nvlist_t **newroot,
2905 nvlist_t *props, splitflags_t flags)
2907 zfs_cmd_t zc = { 0 };
2908 char msg[1024];
2909 nvlist_t *tree, *config, **child, **newchild, *newconfig = NULL;
2910 nvlist_t **varray = NULL, *zc_props = NULL;
2911 uint_t c, children, newchildren, lastlog = 0, vcount, found = 0;
2912 libzfs_handle_t *hdl = zhp->zpool_hdl;
2913 uint64_t vers;
2914 boolean_t freelist = B_FALSE, memory_err = B_TRUE;
2915 int retval = 0;
2917 (void) snprintf(msg, sizeof (msg),
2918 dgettext(TEXT_DOMAIN, "Unable to split %s"), zhp->zpool_name);
2920 if (!zpool_name_valid(hdl, B_FALSE, newname))
2921 return (zfs_error(hdl, EZFS_INVALIDNAME, msg));
2923 if ((config = zpool_get_config(zhp, NULL)) == NULL) {
2924 (void) fprintf(stderr, gettext("Internal error: unable to "
2925 "retrieve pool configuration\n"));
2926 return (-1);
2929 verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE, &tree)
2930 == 0);
2931 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION, &vers) == 0);
2933 if (props) {
2934 prop_flags_t flags = { .create = B_FALSE, .import = B_TRUE };
2935 if ((zc_props = zpool_valid_proplist(hdl, zhp->zpool_name,
2936 props, vers, flags, msg)) == NULL)
2937 return (-1);
2940 if (nvlist_lookup_nvlist_array(tree, ZPOOL_CONFIG_CHILDREN, &child,
2941 &children) != 0) {
2942 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2943 "Source pool is missing vdev tree"));
2944 nvlist_free(zc_props);
2945 return (-1);
2948 varray = zfs_alloc(hdl, children * sizeof (nvlist_t *));
2949 vcount = 0;
2951 if (*newroot == NULL ||
2952 nvlist_lookup_nvlist_array(*newroot, ZPOOL_CONFIG_CHILDREN,
2953 &newchild, &newchildren) != 0)
2954 newchildren = 0;
2956 for (c = 0; c < children; c++) {
2957 uint64_t is_log = B_FALSE, is_hole = B_FALSE;
2958 char *type;
2959 nvlist_t **mchild, *vdev;
2960 uint_t mchildren;
2961 int entry;
2964 * Unlike cache & spares, slogs are stored in the
2965 * ZPOOL_CONFIG_CHILDREN array. We filter them out here.
2967 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
2968 &is_log);
2969 (void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_HOLE,
2970 &is_hole);
2971 if (is_log || is_hole) {
2973 * Create a hole vdev and put it in the config.
2975 if (nvlist_alloc(&vdev, NV_UNIQUE_NAME, 0) != 0)
2976 goto out;
2977 if (nvlist_add_string(vdev, ZPOOL_CONFIG_TYPE,
2978 VDEV_TYPE_HOLE) != 0)
2979 goto out;
2980 if (nvlist_add_uint64(vdev, ZPOOL_CONFIG_IS_HOLE,
2981 1) != 0)
2982 goto out;
2983 if (lastlog == 0)
2984 lastlog = vcount;
2985 varray[vcount++] = vdev;
2986 continue;
2988 lastlog = 0;
2989 verify(nvlist_lookup_string(child[c], ZPOOL_CONFIG_TYPE, &type)
2990 == 0);
2991 if (strcmp(type, VDEV_TYPE_MIRROR) != 0) {
2992 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2993 "Source pool must be composed only of mirrors\n"));
2994 retval = zfs_error(hdl, EZFS_INVALCONFIG, msg);
2995 goto out;
2998 verify(nvlist_lookup_nvlist_array(child[c],
2999 ZPOOL_CONFIG_CHILDREN, &mchild, &mchildren) == 0);
3001 /* find or add an entry for this top-level vdev */
3002 if (newchildren > 0 &&
3003 (entry = find_vdev_entry(zhp, mchild, mchildren,
3004 newchild, newchildren)) >= 0) {
3005 /* We found a disk that the user specified. */
3006 vdev = mchild[entry];
3007 ++found;
3008 } else {
3009 /* User didn't specify a disk for this vdev. */
3010 vdev = mchild[mchildren - 1];
3013 if (nvlist_dup(vdev, &varray[vcount++], 0) != 0)
3014 goto out;
3017 /* did we find every disk the user specified? */
3018 if (found != newchildren) {
3019 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "Device list must "
3020 "include at most one disk from each mirror"));
3021 retval = zfs_error(hdl, EZFS_INVALCONFIG, msg);
3022 goto out;
3025 /* Prepare the nvlist for populating. */
3026 if (*newroot == NULL) {
3027 if (nvlist_alloc(newroot, NV_UNIQUE_NAME, 0) != 0)
3028 goto out;
3029 freelist = B_TRUE;
3030 if (nvlist_add_string(*newroot, ZPOOL_CONFIG_TYPE,
3031 VDEV_TYPE_ROOT) != 0)
3032 goto out;
3033 } else {
3034 verify(nvlist_remove_all(*newroot, ZPOOL_CONFIG_CHILDREN) == 0);
3037 /* Add all the children we found */
3038 if (nvlist_add_nvlist_array(*newroot, ZPOOL_CONFIG_CHILDREN, varray,
3039 lastlog == 0 ? vcount : lastlog) != 0)
3040 goto out;
3043 * If we're just doing a dry run, exit now with success.
3045 if (flags.dryrun) {
3046 memory_err = B_FALSE;
3047 freelist = B_FALSE;
3048 goto out;
3051 /* now build up the config list & call the ioctl */
3052 if (nvlist_alloc(&newconfig, NV_UNIQUE_NAME, 0) != 0)
3053 goto out;
3055 if (nvlist_add_nvlist(newconfig,
3056 ZPOOL_CONFIG_VDEV_TREE, *newroot) != 0 ||
3057 nvlist_add_string(newconfig,
3058 ZPOOL_CONFIG_POOL_NAME, newname) != 0 ||
3059 nvlist_add_uint64(newconfig, ZPOOL_CONFIG_VERSION, vers) != 0)
3060 goto out;
3063 * The new pool is automatically part of the namespace unless we
3064 * explicitly export it.
3066 if (!flags.import)
3067 zc.zc_cookie = ZPOOL_EXPORT_AFTER_SPLIT;
3068 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
3069 (void) strlcpy(zc.zc_string, newname, sizeof (zc.zc_string));
3070 if (zcmd_write_conf_nvlist(hdl, &zc, newconfig) != 0)
3071 goto out;
3072 if (zc_props != NULL && zcmd_write_src_nvlist(hdl, &zc, zc_props) != 0)
3073 goto out;
3075 if (zfs_ioctl(hdl, ZFS_IOC_VDEV_SPLIT, &zc) != 0) {
3076 retval = zpool_standard_error(hdl, errno, msg);
3077 goto out;
3080 freelist = B_FALSE;
3081 memory_err = B_FALSE;
3083 out:
3084 if (varray != NULL) {
3085 int v;
3087 for (v = 0; v < vcount; v++)
3088 nvlist_free(varray[v]);
3089 free(varray);
3091 zcmd_free_nvlists(&zc);
3092 nvlist_free(zc_props);
3093 nvlist_free(newconfig);
3094 if (freelist) {
3095 nvlist_free(*newroot);
3096 *newroot = NULL;
3099 if (retval != 0)
3100 return (retval);
3102 if (memory_err)
3103 return (no_memory(hdl));
3105 return (0);
3109 * Remove the given device.
3112 zpool_vdev_remove(zpool_handle_t *zhp, const char *path)
3114 zfs_cmd_t zc = { 0 };
3115 char msg[1024];
3116 nvlist_t *tgt;
3117 boolean_t avail_spare, l2cache, islog;
3118 libzfs_handle_t *hdl = zhp->zpool_hdl;
3119 uint64_t version;
3121 (void) snprintf(msg, sizeof (msg),
3122 dgettext(TEXT_DOMAIN, "cannot remove %s"), path);
3124 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
3125 if ((tgt = zpool_find_vdev(zhp, path, &avail_spare, &l2cache,
3126 &islog)) == NULL)
3127 return (zfs_error(hdl, EZFS_NODEVICE, msg));
3129 version = zpool_get_prop_int(zhp, ZPOOL_PROP_VERSION, NULL);
3130 if (islog && version < SPA_VERSION_HOLES) {
3131 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3132 "pool must be upgraded to support log removal"));
3133 return (zfs_error(hdl, EZFS_BADVERSION, msg));
3136 if (!islog && !avail_spare && !l2cache && zpool_is_bootable(zhp)) {
3137 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3138 "root pool can not have removed devices, "
3139 "because GRUB does not understand them"));
3140 return (zfs_error(hdl, EINVAL, msg));
3143 zc.zc_guid = fnvlist_lookup_uint64(tgt, ZPOOL_CONFIG_GUID);
3145 if (zfs_ioctl(hdl, ZFS_IOC_VDEV_REMOVE, &zc) == 0)
3146 return (0);
3148 switch (errno) {
3150 case EINVAL:
3151 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3152 "invalid config; all top-level vdevs must "
3153 "have the same sector size and not be raidz."));
3154 (void) zfs_error(hdl, EZFS_INVALCONFIG, msg);
3155 break;
3157 case EBUSY:
3158 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3159 "Pool busy; removal may already be in progress"));
3160 (void) zfs_error(hdl, EZFS_BUSY, msg);
3161 break;
3163 default:
3164 (void) zpool_standard_error(hdl, errno, msg);
3166 return (-1);
3170 zpool_vdev_remove_cancel(zpool_handle_t *zhp)
3172 zfs_cmd_t zc = { 0 };
3173 char msg[1024];
3174 libzfs_handle_t *hdl = zhp->zpool_hdl;
3176 (void) snprintf(msg, sizeof (msg),
3177 dgettext(TEXT_DOMAIN, "cannot cancel removal"));
3179 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
3180 zc.zc_cookie = 1;
3182 if (zfs_ioctl(hdl, ZFS_IOC_VDEV_REMOVE, &zc) == 0)
3183 return (0);
3185 return (zpool_standard_error(hdl, errno, msg));
3189 zpool_vdev_indirect_size(zpool_handle_t *zhp, const char *path,
3190 uint64_t *sizep)
3192 char msg[1024];
3193 nvlist_t *tgt;
3194 boolean_t avail_spare, l2cache, islog;
3195 libzfs_handle_t *hdl = zhp->zpool_hdl;
3197 (void) snprintf(msg, sizeof (msg),
3198 dgettext(TEXT_DOMAIN, "cannot determine indirect size of %s"),
3199 path);
3201 if ((tgt = zpool_find_vdev(zhp, path, &avail_spare, &l2cache,
3202 &islog)) == NULL)
3203 return (zfs_error(hdl, EZFS_NODEVICE, msg));
3205 if (avail_spare || l2cache || islog) {
3206 *sizep = 0;
3207 return (0);
3210 if (nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_INDIRECT_SIZE, sizep) != 0) {
3211 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3212 "indirect size not available"));
3213 return (zfs_error(hdl, EINVAL, msg));
3215 return (0);
3219 * Clear the errors for the pool, or the particular device if specified.
3222 zpool_clear(zpool_handle_t *zhp, const char *path, nvlist_t *rewindnvl)
3224 zfs_cmd_t zc = { 0 };
3225 char msg[1024];
3226 nvlist_t *tgt;
3227 zpool_rewind_policy_t policy;
3228 boolean_t avail_spare, l2cache;
3229 libzfs_handle_t *hdl = zhp->zpool_hdl;
3230 nvlist_t *nvi = NULL;
3231 int error;
3233 if (path)
3234 (void) snprintf(msg, sizeof (msg),
3235 dgettext(TEXT_DOMAIN, "cannot clear errors for %s"),
3236 path);
3237 else
3238 (void) snprintf(msg, sizeof (msg),
3239 dgettext(TEXT_DOMAIN, "cannot clear errors for %s"),
3240 zhp->zpool_name);
3242 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
3243 if (path) {
3244 if ((tgt = zpool_find_vdev(zhp, path, &avail_spare,
3245 &l2cache, NULL)) == NULL)
3246 return (zfs_error(hdl, EZFS_NODEVICE, msg));
3249 * Don't allow error clearing for hot spares. Do allow
3250 * error clearing for l2cache devices.
3252 if (avail_spare)
3253 return (zfs_error(hdl, EZFS_ISSPARE, msg));
3255 verify(nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_GUID,
3256 &zc.zc_guid) == 0);
3259 zpool_get_rewind_policy(rewindnvl, &policy);
3260 zc.zc_cookie = policy.zrp_request;
3262 if (zcmd_alloc_dst_nvlist(hdl, &zc, zhp->zpool_config_size * 2) != 0)
3263 return (-1);
3265 if (zcmd_write_src_nvlist(hdl, &zc, rewindnvl) != 0)
3266 return (-1);
3268 while ((error = zfs_ioctl(hdl, ZFS_IOC_CLEAR, &zc)) != 0 &&
3269 errno == ENOMEM) {
3270 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
3271 zcmd_free_nvlists(&zc);
3272 return (-1);
3276 if (!error || ((policy.zrp_request & ZPOOL_TRY_REWIND) &&
3277 errno != EPERM && errno != EACCES)) {
3278 if (policy.zrp_request &
3279 (ZPOOL_DO_REWIND | ZPOOL_TRY_REWIND)) {
3280 (void) zcmd_read_dst_nvlist(hdl, &zc, &nvi);
3281 zpool_rewind_exclaim(hdl, zc.zc_name,
3282 ((policy.zrp_request & ZPOOL_TRY_REWIND) != 0),
3283 nvi);
3284 nvlist_free(nvi);
3286 zcmd_free_nvlists(&zc);
3287 return (0);
3290 zcmd_free_nvlists(&zc);
3291 return (zpool_standard_error(hdl, errno, msg));
3295 * Similar to zpool_clear(), but takes a GUID (used by fmd).
3298 zpool_vdev_clear(zpool_handle_t *zhp, uint64_t guid)
3300 zfs_cmd_t zc = { 0 };
3301 char msg[1024];
3302 libzfs_handle_t *hdl = zhp->zpool_hdl;
3304 (void) snprintf(msg, sizeof (msg),
3305 dgettext(TEXT_DOMAIN, "cannot clear errors for %llx"),
3306 guid);
3308 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
3309 zc.zc_guid = guid;
3310 zc.zc_cookie = ZPOOL_NO_REWIND;
3312 if (ioctl(hdl->libzfs_fd, ZFS_IOC_CLEAR, &zc) == 0)
3313 return (0);
3315 return (zpool_standard_error(hdl, errno, msg));
3319 * Change the GUID for a pool.
3322 zpool_reguid(zpool_handle_t *zhp)
3324 char msg[1024];
3325 libzfs_handle_t *hdl = zhp->zpool_hdl;
3326 zfs_cmd_t zc = { 0 };
3328 (void) snprintf(msg, sizeof (msg),
3329 dgettext(TEXT_DOMAIN, "cannot reguid '%s'"), zhp->zpool_name);
3331 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
3332 if (zfs_ioctl(hdl, ZFS_IOC_POOL_REGUID, &zc) == 0)
3333 return (0);
3335 return (zpool_standard_error(hdl, errno, msg));
3339 * Reopen the pool.
3342 zpool_reopen(zpool_handle_t *zhp)
3344 zfs_cmd_t zc = { 0 };
3345 char msg[1024];
3346 libzfs_handle_t *hdl = zhp->zpool_hdl;
3348 (void) snprintf(msg, sizeof (msg),
3349 dgettext(TEXT_DOMAIN, "cannot reopen '%s'"),
3350 zhp->zpool_name);
3352 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
3353 if (zfs_ioctl(hdl, ZFS_IOC_POOL_REOPEN, &zc) == 0)
3354 return (0);
3355 return (zpool_standard_error(hdl, errno, msg));
3359 * Convert from a devid string to a path.
3361 static char *
3362 devid_to_path(char *devid_str)
3364 ddi_devid_t devid;
3365 char *minor;
3366 char *path;
3367 devid_nmlist_t *list = NULL;
3368 int ret;
3370 if (devid_str_decode(devid_str, &devid, &minor) != 0)
3371 return (NULL);
3373 ret = devid_deviceid_to_nmlist("/dev", devid, minor, &list);
3375 devid_str_free(minor);
3376 devid_free(devid);
3378 if (ret != 0)
3379 return (NULL);
3382 * In a case the strdup() fails, we will just return NULL below.
3384 path = strdup(list[0].devname);
3386 devid_free_nmlist(list);
3388 return (path);
3392 * Convert from a path to a devid string.
3394 static char *
3395 path_to_devid(const char *path)
3397 int fd;
3398 ddi_devid_t devid;
3399 char *minor, *ret;
3401 if ((fd = open(path, O_RDONLY)) < 0)
3402 return (NULL);
3404 minor = NULL;
3405 ret = NULL;
3406 if (devid_get(fd, &devid) == 0) {
3407 if (devid_get_minor_name(fd, &minor) == 0)
3408 ret = devid_str_encode(devid, minor);
3409 if (minor != NULL)
3410 devid_str_free(minor);
3411 devid_free(devid);
3413 (void) close(fd);
3415 return (ret);
3419 * Issue the necessary ioctl() to update the stored path value for the vdev. We
3420 * ignore any failure here, since a common case is for an unprivileged user to
3421 * type 'zpool status', and we'll display the correct information anyway.
3423 static void
3424 set_path(zpool_handle_t *zhp, nvlist_t *nv, const char *path)
3426 zfs_cmd_t zc = { 0 };
3428 (void) strncpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
3429 (void) strncpy(zc.zc_value, path, sizeof (zc.zc_value));
3430 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID,
3431 &zc.zc_guid) == 0);
3433 (void) ioctl(zhp->zpool_hdl->libzfs_fd, ZFS_IOC_VDEV_SETPATH, &zc);
3437 * Given a vdev, return the name to display in iostat. If the vdev has a path,
3438 * we use that, stripping off any leading "/dev/dsk/"; if not, we use the type.
3439 * We also check if this is a whole disk, in which case we strip off the
3440 * trailing 's0' slice name.
3442 * This routine is also responsible for identifying when disks have been
3443 * reconfigured in a new location. The kernel will have opened the device by
3444 * devid, but the path will still refer to the old location. To catch this, we
3445 * first do a path -> devid translation (which is fast for the common case). If
3446 * the devid matches, we're done. If not, we do a reverse devid -> path
3447 * translation and issue the appropriate ioctl() to update the path of the vdev.
3448 * If 'zhp' is NULL, then this is an exported pool, and we don't need to do any
3449 * of these checks.
3451 char *
3452 zpool_vdev_name(libzfs_handle_t *hdl, zpool_handle_t *zhp, nvlist_t *nv,
3453 boolean_t verbose)
3455 char *path, *devid;
3456 uint64_t value;
3457 char buf[64];
3458 vdev_stat_t *vs;
3459 uint_t vsc;
3461 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NOT_PRESENT,
3462 &value) == 0) {
3463 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID,
3464 &value) == 0);
3465 (void) snprintf(buf, sizeof (buf), "%llu",
3466 (u_longlong_t)value);
3467 path = buf;
3468 } else if (nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0) {
3471 * If the device is dead (faulted, offline, etc) then don't
3472 * bother opening it. Otherwise we may be forcing the user to
3473 * open a misbehaving device, which can have undesirable
3474 * effects.
3476 if ((nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
3477 (uint64_t **)&vs, &vsc) != 0 ||
3478 vs->vs_state >= VDEV_STATE_DEGRADED) &&
3479 zhp != NULL &&
3480 nvlist_lookup_string(nv, ZPOOL_CONFIG_DEVID, &devid) == 0) {
3482 * Determine if the current path is correct.
3484 char *newdevid = path_to_devid(path);
3486 if (newdevid == NULL ||
3487 strcmp(devid, newdevid) != 0) {
3488 char *newpath;
3490 if ((newpath = devid_to_path(devid)) != NULL) {
3492 * Update the path appropriately.
3494 set_path(zhp, nv, newpath);
3495 if (nvlist_add_string(nv,
3496 ZPOOL_CONFIG_PATH, newpath) == 0)
3497 verify(nvlist_lookup_string(nv,
3498 ZPOOL_CONFIG_PATH,
3499 &path) == 0);
3500 free(newpath);
3504 if (newdevid)
3505 devid_str_free(newdevid);
3508 if (strncmp(path, ZFS_DISK_ROOTD, strlen(ZFS_DISK_ROOTD)) == 0)
3509 path += strlen(ZFS_DISK_ROOTD);
3511 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_WHOLE_DISK,
3512 &value) == 0 && value) {
3513 int pathlen = strlen(path);
3514 char *tmp = zfs_strdup(hdl, path);
3517 * If it starts with c#, and ends with "s0" or "s1",
3518 * chop the slice off, or if it ends with "s0/old" or
3519 * "s1/old", remove the slice from the middle.
3521 if (CTD_CHECK(tmp)) {
3522 if (strcmp(&tmp[pathlen - 2], "s0") == 0 ||
3523 strcmp(&tmp[pathlen - 2], "s1") == 0) {
3524 tmp[pathlen - 2] = '\0';
3525 } else if (pathlen > 6 &&
3526 (strcmp(&tmp[pathlen - 6], "s0/old") == 0 ||
3527 strcmp(&tmp[pathlen - 6], "s1/old") == 0)) {
3528 (void) strcpy(&tmp[pathlen - 6],
3529 "/old");
3532 return (tmp);
3534 } else {
3535 verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE, &path) == 0);
3538 * If it's a raidz device, we need to stick in the parity level.
3540 if (strcmp(path, VDEV_TYPE_RAIDZ) == 0) {
3541 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NPARITY,
3542 &value) == 0);
3543 (void) snprintf(buf, sizeof (buf), "%s%llu", path,
3544 (u_longlong_t)value);
3545 path = buf;
3549 * We identify each top-level vdev by using a <type-id>
3550 * naming convention.
3552 if (verbose) {
3553 uint64_t id;
3555 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_ID,
3556 &id) == 0);
3557 (void) snprintf(buf, sizeof (buf), "%s-%llu", path,
3558 (u_longlong_t)id);
3559 path = buf;
3563 return (zfs_strdup(hdl, path));
3566 static int
3567 zbookmark_mem_compare(const void *a, const void *b)
3569 return (memcmp(a, b, sizeof (zbookmark_phys_t)));
3573 * Retrieve the persistent error log, uniquify the members, and return to the
3574 * caller.
3577 zpool_get_errlog(zpool_handle_t *zhp, nvlist_t **nverrlistp)
3579 zfs_cmd_t zc = { 0 };
3580 uint64_t count;
3581 zbookmark_phys_t *zb = NULL;
3582 int i;
3585 * Retrieve the raw error list from the kernel. If the number of errors
3586 * has increased, allocate more space and continue until we get the
3587 * entire list.
3589 verify(nvlist_lookup_uint64(zhp->zpool_config, ZPOOL_CONFIG_ERRCOUNT,
3590 &count) == 0);
3591 if (count == 0)
3592 return (0);
3593 if ((zc.zc_nvlist_dst = (uintptr_t)zfs_alloc(zhp->zpool_hdl,
3594 count * sizeof (zbookmark_phys_t))) == (uintptr_t)NULL)
3595 return (-1);
3596 zc.zc_nvlist_dst_size = count;
3597 (void) strcpy(zc.zc_name, zhp->zpool_name);
3598 for (;;) {
3599 if (ioctl(zhp->zpool_hdl->libzfs_fd, ZFS_IOC_ERROR_LOG,
3600 &zc) != 0) {
3601 free((void *)(uintptr_t)zc.zc_nvlist_dst);
3602 if (errno == ENOMEM) {
3603 void *dst;
3605 count = zc.zc_nvlist_dst_size;
3606 dst = zfs_alloc(zhp->zpool_hdl, count *
3607 sizeof (zbookmark_phys_t));
3608 if (dst == NULL)
3609 return (-1);
3610 zc.zc_nvlist_dst = (uintptr_t)dst;
3611 } else {
3612 return (-1);
3614 } else {
3615 break;
3620 * Sort the resulting bookmarks. This is a little confusing due to the
3621 * implementation of ZFS_IOC_ERROR_LOG. The bookmarks are copied last
3622 * to first, and 'zc_nvlist_dst_size' indicates the number of boomarks
3623 * _not_ copied as part of the process. So we point the start of our
3624 * array appropriate and decrement the total number of elements.
3626 zb = ((zbookmark_phys_t *)(uintptr_t)zc.zc_nvlist_dst) +
3627 zc.zc_nvlist_dst_size;
3628 count -= zc.zc_nvlist_dst_size;
3630 qsort(zb, count, sizeof (zbookmark_phys_t), zbookmark_mem_compare);
3632 verify(nvlist_alloc(nverrlistp, 0, KM_SLEEP) == 0);
3635 * Fill in the nverrlistp with nvlist's of dataset and object numbers.
3637 for (i = 0; i < count; i++) {
3638 nvlist_t *nv;
3640 /* ignoring zb_blkid and zb_level for now */
3641 if (i > 0 && zb[i-1].zb_objset == zb[i].zb_objset &&
3642 zb[i-1].zb_object == zb[i].zb_object)
3643 continue;
3645 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, KM_SLEEP) != 0)
3646 goto nomem;
3647 if (nvlist_add_uint64(nv, ZPOOL_ERR_DATASET,
3648 zb[i].zb_objset) != 0) {
3649 nvlist_free(nv);
3650 goto nomem;
3652 if (nvlist_add_uint64(nv, ZPOOL_ERR_OBJECT,
3653 zb[i].zb_object) != 0) {
3654 nvlist_free(nv);
3655 goto nomem;
3657 if (nvlist_add_nvlist(*nverrlistp, "ejk", nv) != 0) {
3658 nvlist_free(nv);
3659 goto nomem;
3661 nvlist_free(nv);
3664 free((void *)(uintptr_t)zc.zc_nvlist_dst);
3665 return (0);
3667 nomem:
3668 free((void *)(uintptr_t)zc.zc_nvlist_dst);
3669 return (no_memory(zhp->zpool_hdl));
3673 * Upgrade a ZFS pool to the latest on-disk version.
3676 zpool_upgrade(zpool_handle_t *zhp, uint64_t new_version)
3678 zfs_cmd_t zc = { 0 };
3679 libzfs_handle_t *hdl = zhp->zpool_hdl;
3681 (void) strcpy(zc.zc_name, zhp->zpool_name);
3682 zc.zc_cookie = new_version;
3684 if (zfs_ioctl(hdl, ZFS_IOC_POOL_UPGRADE, &zc) != 0)
3685 return (zpool_standard_error_fmt(hdl, errno,
3686 dgettext(TEXT_DOMAIN, "cannot upgrade '%s'"),
3687 zhp->zpool_name));
3688 return (0);
3691 void
3692 zfs_save_arguments(int argc, char **argv, char *string, int len)
3694 (void) strlcpy(string, basename(argv[0]), len);
3695 for (int i = 1; i < argc; i++) {
3696 (void) strlcat(string, " ", len);
3697 (void) strlcat(string, argv[i], len);
3702 zpool_log_history(libzfs_handle_t *hdl, const char *message)
3704 zfs_cmd_t zc = { 0 };
3705 nvlist_t *args;
3706 int err;
3708 args = fnvlist_alloc();
3709 fnvlist_add_string(args, "message", message);
3710 err = zcmd_write_src_nvlist(hdl, &zc, args);
3711 if (err == 0)
3712 err = ioctl(hdl->libzfs_fd, ZFS_IOC_LOG_HISTORY, &zc);
3713 nvlist_free(args);
3714 zcmd_free_nvlists(&zc);
3715 return (err);
3719 * Perform ioctl to get some command history of a pool.
3721 * 'buf' is the buffer to fill up to 'len' bytes. 'off' is the
3722 * logical offset of the history buffer to start reading from.
3724 * Upon return, 'off' is the next logical offset to read from and
3725 * 'len' is the actual amount of bytes read into 'buf'.
3727 static int
3728 get_history(zpool_handle_t *zhp, char *buf, uint64_t *off, uint64_t *len)
3730 zfs_cmd_t zc = { 0 };
3731 libzfs_handle_t *hdl = zhp->zpool_hdl;
3733 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
3735 zc.zc_history = (uint64_t)(uintptr_t)buf;
3736 zc.zc_history_len = *len;
3737 zc.zc_history_offset = *off;
3739 if (ioctl(hdl->libzfs_fd, ZFS_IOC_POOL_GET_HISTORY, &zc) != 0) {
3740 switch (errno) {
3741 case EPERM:
3742 return (zfs_error_fmt(hdl, EZFS_PERM,
3743 dgettext(TEXT_DOMAIN,
3744 "cannot show history for pool '%s'"),
3745 zhp->zpool_name));
3746 case ENOENT:
3747 return (zfs_error_fmt(hdl, EZFS_NOHISTORY,
3748 dgettext(TEXT_DOMAIN, "cannot get history for pool "
3749 "'%s'"), zhp->zpool_name));
3750 case ENOTSUP:
3751 return (zfs_error_fmt(hdl, EZFS_BADVERSION,
3752 dgettext(TEXT_DOMAIN, "cannot get history for pool "
3753 "'%s', pool must be upgraded"), zhp->zpool_name));
3754 default:
3755 return (zpool_standard_error_fmt(hdl, errno,
3756 dgettext(TEXT_DOMAIN,
3757 "cannot get history for '%s'"), zhp->zpool_name));
3761 *len = zc.zc_history_len;
3762 *off = zc.zc_history_offset;
3764 return (0);
3768 * Process the buffer of nvlists, unpacking and storing each nvlist record
3769 * into 'records'. 'leftover' is set to the number of bytes that weren't
3770 * processed as there wasn't a complete record.
3773 zpool_history_unpack(char *buf, uint64_t bytes_read, uint64_t *leftover,
3774 nvlist_t ***records, uint_t *numrecords)
3776 uint64_t reclen;
3777 nvlist_t *nv;
3778 int i;
3780 while (bytes_read > sizeof (reclen)) {
3782 /* get length of packed record (stored as little endian) */
3783 for (i = 0, reclen = 0; i < sizeof (reclen); i++)
3784 reclen += (uint64_t)(((uchar_t *)buf)[i]) << (8*i);
3786 if (bytes_read < sizeof (reclen) + reclen)
3787 break;
3789 /* unpack record */
3790 if (nvlist_unpack(buf + sizeof (reclen), reclen, &nv, 0) != 0)
3791 return (ENOMEM);
3792 bytes_read -= sizeof (reclen) + reclen;
3793 buf += sizeof (reclen) + reclen;
3795 /* add record to nvlist array */
3796 (*numrecords)++;
3797 if (ISP2(*numrecords + 1)) {
3798 *records = realloc(*records,
3799 *numrecords * 2 * sizeof (nvlist_t *));
3801 (*records)[*numrecords - 1] = nv;
3804 *leftover = bytes_read;
3805 return (0);
3809 * Retrieve the command history of a pool.
3812 zpool_get_history(zpool_handle_t *zhp, nvlist_t **nvhisp)
3814 char *buf;
3815 int buflen = 128 * 1024;
3816 uint64_t off = 0;
3817 nvlist_t **records = NULL;
3818 uint_t numrecords = 0;
3819 int err, i;
3821 buf = malloc(buflen);
3822 if (buf == NULL)
3823 return (ENOMEM);
3824 do {
3825 uint64_t bytes_read = buflen;
3826 uint64_t leftover;
3828 if ((err = get_history(zhp, buf, &off, &bytes_read)) != 0)
3829 break;
3831 /* if nothing else was read in, we're at EOF, just return */
3832 if (!bytes_read)
3833 break;
3835 if ((err = zpool_history_unpack(buf, bytes_read,
3836 &leftover, &records, &numrecords)) != 0)
3837 break;
3838 off -= leftover;
3839 if (leftover == bytes_read) {
3841 * no progress made, because buffer is not big enough
3842 * to hold this record; resize and retry.
3844 buflen *= 2;
3845 free(buf);
3846 buf = malloc(buflen);
3847 if (buf == NULL)
3848 return (ENOMEM);
3851 /* CONSTCOND */
3852 } while (1);
3854 free(buf);
3856 if (!err) {
3857 verify(nvlist_alloc(nvhisp, NV_UNIQUE_NAME, 0) == 0);
3858 verify(nvlist_add_nvlist_array(*nvhisp, ZPOOL_HIST_RECORD,
3859 records, numrecords) == 0);
3861 for (i = 0; i < numrecords; i++)
3862 nvlist_free(records[i]);
3863 free(records);
3865 return (err);
3868 void
3869 zpool_obj_to_path(zpool_handle_t *zhp, uint64_t dsobj, uint64_t obj,
3870 char *pathname, size_t len)
3872 zfs_cmd_t zc = { 0 };
3873 boolean_t mounted = B_FALSE;
3874 char *mntpnt = NULL;
3875 char dsname[ZFS_MAX_DATASET_NAME_LEN];
3877 if (dsobj == 0) {
3878 /* special case for the MOS */
3879 (void) snprintf(pathname, len, "<metadata>:<0x%llx>", obj);
3880 return;
3883 /* get the dataset's name */
3884 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
3885 zc.zc_obj = dsobj;
3886 if (ioctl(zhp->zpool_hdl->libzfs_fd,
3887 ZFS_IOC_DSOBJ_TO_DSNAME, &zc) != 0) {
3888 /* just write out a path of two object numbers */
3889 (void) snprintf(pathname, len, "<0x%llx>:<0x%llx>",
3890 dsobj, obj);
3891 return;
3893 (void) strlcpy(dsname, zc.zc_value, sizeof (dsname));
3895 /* find out if the dataset is mounted */
3896 mounted = is_mounted(zhp->zpool_hdl, dsname, &mntpnt);
3898 /* get the corrupted object's path */
3899 (void) strlcpy(zc.zc_name, dsname, sizeof (zc.zc_name));
3900 zc.zc_obj = obj;
3901 if (ioctl(zhp->zpool_hdl->libzfs_fd, ZFS_IOC_OBJ_TO_PATH,
3902 &zc) == 0) {
3903 if (mounted) {
3904 (void) snprintf(pathname, len, "%s%s", mntpnt,
3905 zc.zc_value);
3906 } else {
3907 (void) snprintf(pathname, len, "%s:%s",
3908 dsname, zc.zc_value);
3910 } else {
3911 (void) snprintf(pathname, len, "%s:<0x%llx>", dsname, obj);
3913 free(mntpnt);
3917 * Read the EFI label from the config, if a label does not exist then
3918 * pass back the error to the caller. If the caller has passed a non-NULL
3919 * diskaddr argument then we set it to the starting address of the EFI
3920 * partition. If the caller has passed a non-NULL boolean argument, then
3921 * we set it to indicate if the disk does have efi system partition.
3923 static int
3924 read_efi_label(nvlist_t *config, diskaddr_t *sb, boolean_t *system)
3926 char *path;
3927 int fd;
3928 char diskname[MAXPATHLEN];
3929 boolean_t boot = B_FALSE;
3930 int err = -1;
3931 int slice;
3933 if (nvlist_lookup_string(config, ZPOOL_CONFIG_PATH, &path) != 0)
3934 return (err);
3936 (void) snprintf(diskname, sizeof (diskname), "%s%s", ZFS_RDISK_ROOT,
3937 strrchr(path, '/'));
3938 if ((fd = open(diskname, O_RDONLY|O_NDELAY)) >= 0) {
3939 struct dk_gpt *vtoc;
3941 if ((err = efi_alloc_and_read(fd, &vtoc)) >= 0) {
3942 for (slice = 0; slice < vtoc->efi_nparts; slice++) {
3943 if (vtoc->efi_parts[slice].p_tag == V_SYSTEM)
3944 boot = B_TRUE;
3945 if (vtoc->efi_parts[slice].p_tag == V_USR)
3946 break;
3948 if (sb != NULL && vtoc->efi_parts[slice].p_tag == V_USR)
3949 *sb = vtoc->efi_parts[slice].p_start;
3950 if (system != NULL)
3951 *system = boot;
3952 efi_free(vtoc);
3954 (void) close(fd);
3956 return (err);
3960 * determine where a partition starts on a disk in the current
3961 * configuration
3963 static diskaddr_t
3964 find_start_block(nvlist_t *config)
3966 nvlist_t **child;
3967 uint_t c, children;
3968 diskaddr_t sb = MAXOFFSET_T;
3969 uint64_t wholedisk;
3971 if (nvlist_lookup_nvlist_array(config,
3972 ZPOOL_CONFIG_CHILDREN, &child, &children) != 0) {
3973 if (nvlist_lookup_uint64(config,
3974 ZPOOL_CONFIG_WHOLE_DISK,
3975 &wholedisk) != 0 || !wholedisk) {
3976 return (MAXOFFSET_T);
3978 if (read_efi_label(config, &sb, NULL) < 0)
3979 sb = MAXOFFSET_T;
3980 return (sb);
3983 for (c = 0; c < children; c++) {
3984 sb = find_start_block(child[c]);
3985 if (sb != MAXOFFSET_T) {
3986 return (sb);
3989 return (MAXOFFSET_T);
3993 * Label an individual disk. The name provided is the short name,
3994 * stripped of any leading /dev path.
3997 zpool_label_disk(libzfs_handle_t *hdl, zpool_handle_t *zhp, const char *name,
3998 zpool_boot_label_t boot_type, uint64_t boot_size, int *slice)
4000 char path[MAXPATHLEN];
4001 struct dk_gpt *vtoc;
4002 int fd;
4003 size_t resv = EFI_MIN_RESV_SIZE;
4004 uint64_t slice_size;
4005 diskaddr_t start_block;
4006 char errbuf[1024];
4008 /* prepare an error message just in case */
4009 (void) snprintf(errbuf, sizeof (errbuf),
4010 dgettext(TEXT_DOMAIN, "cannot label '%s'"), name);
4012 if (zhp) {
4013 nvlist_t *nvroot;
4015 verify(nvlist_lookup_nvlist(zhp->zpool_config,
4016 ZPOOL_CONFIG_VDEV_TREE, &nvroot) == 0);
4018 if (zhp->zpool_start_block == 0)
4019 start_block = find_start_block(nvroot);
4020 else
4021 start_block = zhp->zpool_start_block;
4022 zhp->zpool_start_block = start_block;
4023 } else {
4024 /* new pool */
4025 start_block = NEW_START_BLOCK;
4028 (void) snprintf(path, sizeof (path), "%s/%s%s", ZFS_RDISK_ROOT, name,
4029 BACKUP_SLICE);
4031 if ((fd = open(path, O_RDWR | O_NDELAY)) < 0) {
4033 * This shouldn't happen. We've long since verified that this
4034 * is a valid device.
4036 zfs_error_aux(hdl,
4037 dgettext(TEXT_DOMAIN, "unable to open device"));
4038 return (zfs_error(hdl, EZFS_OPENFAILED, errbuf));
4041 if (efi_alloc_and_init(fd, EFI_NUMPAR, &vtoc) != 0) {
4043 * The only way this can fail is if we run out of memory, or we
4044 * were unable to read the disk's capacity
4046 if (errno == ENOMEM)
4047 (void) no_memory(hdl);
4049 (void) close(fd);
4050 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4051 "unable to read disk capacity"), name);
4053 return (zfs_error(hdl, EZFS_NOCAP, errbuf));
4057 * Why we use V_USR: V_BACKUP confuses users, and is considered
4058 * disposable by some EFI utilities (since EFI doesn't have a backup
4059 * slice). V_UNASSIGNED is supposed to be used only for zero size
4060 * partitions, and efi_write() will fail if we use it. V_ROOT, V_BOOT,
4061 * etc. were all pretty specific. V_USR is as close to reality as we
4062 * can get, in the absence of V_OTHER.
4064 /* first fix the partition start block */
4065 if (start_block == MAXOFFSET_T)
4066 start_block = NEW_START_BLOCK;
4069 * EFI System partition is using slice 0.
4070 * ZFS is on slice 1 and slice 8 is reserved.
4071 * We assume the GPT partition table without system
4072 * partition has zfs p_start == NEW_START_BLOCK.
4073 * If start_block != NEW_START_BLOCK, it means we have
4074 * system partition. Correct solution would be to query/cache vtoc
4075 * from existing vdev member.
4077 if (boot_type == ZPOOL_CREATE_BOOT_LABEL) {
4078 if (boot_size % vtoc->efi_lbasize != 0) {
4079 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4080 "boot partition size must be a multiple of %d"),
4081 vtoc->efi_lbasize);
4082 (void) close(fd);
4083 efi_free(vtoc);
4084 return (zfs_error(hdl, EZFS_LABELFAILED, errbuf));
4087 * System partition size checks.
4088 * Note the 1MB is quite arbitrary value, since we
4089 * are creating dedicated pool, it should be enough
4090 * to hold fat + efi bootloader. May need to be
4091 * adjusted if the bootloader size will grow.
4093 if (boot_size < 1024 * 1024) {
4094 char buf[64];
4095 zfs_nicenum(boot_size, buf, sizeof (buf));
4096 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4097 "Specified size %s for EFI System partition is too "
4098 "small, the minimum size is 1MB."), buf);
4099 (void) close(fd);
4100 efi_free(vtoc);
4101 return (zfs_error(hdl, EZFS_LABELFAILED, errbuf));
4103 /* 33MB is tested with mkfs -F pcfs */
4104 if (hdl->libzfs_printerr &&
4105 ((vtoc->efi_lbasize == 512 &&
4106 boot_size < 33 * 1024 * 1024) ||
4107 (vtoc->efi_lbasize == 4096 &&
4108 boot_size < 256 * 1024 * 1024))) {
4109 char buf[64];
4110 zfs_nicenum(boot_size, buf, sizeof (buf));
4111 (void) fprintf(stderr, dgettext(TEXT_DOMAIN,
4112 "Warning: EFI System partition size %s is "
4113 "not allowing to create FAT32 file\nsystem, which "
4114 "may result in unbootable system.\n"), buf);
4116 /* Adjust zfs partition start by size of system partition. */
4117 start_block += boot_size / vtoc->efi_lbasize;
4120 if (start_block == NEW_START_BLOCK) {
4122 * Use default layout.
4123 * ZFS is on slice 0 and slice 8 is reserved.
4125 slice_size = vtoc->efi_last_u_lba + 1;
4126 slice_size -= EFI_MIN_RESV_SIZE;
4127 slice_size -= start_block;
4128 if (slice != NULL)
4129 *slice = 0;
4131 vtoc->efi_parts[0].p_start = start_block;
4132 vtoc->efi_parts[0].p_size = slice_size;
4134 vtoc->efi_parts[0].p_tag = V_USR;
4135 (void) strcpy(vtoc->efi_parts[0].p_name, "zfs");
4137 vtoc->efi_parts[8].p_start = slice_size + start_block;
4138 vtoc->efi_parts[8].p_size = resv;
4139 vtoc->efi_parts[8].p_tag = V_RESERVED;
4140 } else {
4141 slice_size = start_block - NEW_START_BLOCK;
4142 vtoc->efi_parts[0].p_start = NEW_START_BLOCK;
4143 vtoc->efi_parts[0].p_size = slice_size;
4144 vtoc->efi_parts[0].p_tag = V_SYSTEM;
4145 (void) strcpy(vtoc->efi_parts[0].p_name, "loader");
4146 if (slice != NULL)
4147 *slice = 1;
4148 /* prepare slice 1 */
4149 slice_size = vtoc->efi_last_u_lba + 1 - slice_size;
4150 slice_size -= resv;
4151 slice_size -= NEW_START_BLOCK;
4152 vtoc->efi_parts[1].p_start = start_block;
4153 vtoc->efi_parts[1].p_size = slice_size;
4154 vtoc->efi_parts[1].p_tag = V_USR;
4155 (void) strcpy(vtoc->efi_parts[1].p_name, "zfs");
4157 vtoc->efi_parts[8].p_start = slice_size + start_block;
4158 vtoc->efi_parts[8].p_size = resv;
4159 vtoc->efi_parts[8].p_tag = V_RESERVED;
4162 if (efi_write(fd, vtoc) != 0) {
4164 * Some block drivers (like pcata) may not support EFI
4165 * GPT labels. Print out a helpful error message dir-
4166 * ecting the user to manually label the disk and give
4167 * a specific slice.
4169 (void) close(fd);
4170 efi_free(vtoc);
4172 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4173 "try using fdisk(1M) and then provide a specific slice"));
4174 return (zfs_error(hdl, EZFS_LABELFAILED, errbuf));
4177 (void) close(fd);
4178 efi_free(vtoc);
4179 return (0);
4182 static boolean_t
4183 supported_dump_vdev_type(libzfs_handle_t *hdl, nvlist_t *config, char *errbuf)
4185 char *type;
4186 nvlist_t **child;
4187 uint_t children, c;
4189 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_TYPE, &type) == 0);
4190 if (strcmp(type, VDEV_TYPE_FILE) == 0 ||
4191 strcmp(type, VDEV_TYPE_HOLE) == 0 ||
4192 strcmp(type, VDEV_TYPE_MISSING) == 0) {
4193 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4194 "vdev type '%s' is not supported"), type);
4195 (void) zfs_error(hdl, EZFS_VDEVNOTSUP, errbuf);
4196 return (B_FALSE);
4198 if (nvlist_lookup_nvlist_array(config, ZPOOL_CONFIG_CHILDREN,
4199 &child, &children) == 0) {
4200 for (c = 0; c < children; c++) {
4201 if (!supported_dump_vdev_type(hdl, child[c], errbuf))
4202 return (B_FALSE);
4205 return (B_TRUE);
4209 * Check if this zvol is allowable for use as a dump device; zero if
4210 * it is, > 0 if it isn't, < 0 if it isn't a zvol.
4212 * Allowable storage configurations include mirrors, all raidz variants, and
4213 * pools with log, cache, and spare devices. Pools which are backed by files or
4214 * have missing/hole vdevs are not suitable.
4217 zvol_check_dump_config(char *arg)
4219 zpool_handle_t *zhp = NULL;
4220 nvlist_t *config, *nvroot;
4221 char *p, *volname;
4222 nvlist_t **top;
4223 uint_t toplevels;
4224 libzfs_handle_t *hdl;
4225 char errbuf[1024];
4226 char poolname[ZFS_MAX_DATASET_NAME_LEN];
4227 int pathlen = strlen(ZVOL_FULL_DEV_DIR);
4228 int ret = 1;
4230 if (strncmp(arg, ZVOL_FULL_DEV_DIR, pathlen)) {
4231 return (-1);
4234 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4235 "dump is not supported on device '%s'"), arg);
4237 if ((hdl = libzfs_init()) == NULL)
4238 return (1);
4239 libzfs_print_on_error(hdl, B_TRUE);
4241 volname = arg + pathlen;
4243 /* check the configuration of the pool */
4244 if ((p = strchr(volname, '/')) == NULL) {
4245 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4246 "malformed dataset name"));
4247 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
4248 return (1);
4249 } else if (p - volname >= ZFS_MAX_DATASET_NAME_LEN) {
4250 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4251 "dataset name is too long"));
4252 (void) zfs_error(hdl, EZFS_NAMETOOLONG, errbuf);
4253 return (1);
4254 } else {
4255 (void) strncpy(poolname, volname, p - volname);
4256 poolname[p - volname] = '\0';
4259 if ((zhp = zpool_open(hdl, poolname)) == NULL) {
4260 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4261 "could not open pool '%s'"), poolname);
4262 (void) zfs_error(hdl, EZFS_OPENFAILED, errbuf);
4263 goto out;
4265 config = zpool_get_config(zhp, NULL);
4266 if (nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
4267 &nvroot) != 0) {
4268 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4269 "could not obtain vdev configuration for '%s'"), poolname);
4270 (void) zfs_error(hdl, EZFS_INVALCONFIG, errbuf);
4271 goto out;
4274 verify(nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN,
4275 &top, &toplevels) == 0);
4277 if (!supported_dump_vdev_type(hdl, top[0], errbuf)) {
4278 goto out;
4280 ret = 0;
4282 out:
4283 if (zhp)
4284 zpool_close(zhp);
4285 libzfs_fini(hdl);
4286 return (ret);