4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
40 #include <sys/efi_partition.h>
42 #include <sys/zfs_ioctl.h>
46 #include "zfs_namecheck.h"
48 #include "libzfs_impl.h"
50 static int read_efi_label(nvlist_t *config, diskaddr_t *sb);
52 #if defined(__i386) || defined(__amd64)
53 #define BOOTCMD "installgrub(1M)"
55 #define BOOTCMD "installboot(1M)"
59 * ====================================================================
60 * zpool property functions
61 * ====================================================================
65 zpool_get_all_props(zpool_handle_t *zhp)
68 libzfs_handle_t *hdl = zhp->zpool_hdl;
70 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
72 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
75 while (ioctl(hdl->libzfs_fd, ZFS_IOC_POOL_GET_PROPS, &zc) != 0) {
76 if (errno == ENOMEM) {
77 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
78 zcmd_free_nvlists(&zc);
82 zcmd_free_nvlists(&zc);
87 if (zcmd_read_dst_nvlist(hdl, &zc, &zhp->zpool_props) != 0) {
88 zcmd_free_nvlists(&zc);
92 zcmd_free_nvlists(&zc);
98 zpool_props_refresh(zpool_handle_t *zhp)
102 old_props = zhp->zpool_props;
104 if (zpool_get_all_props(zhp) != 0)
107 nvlist_free(old_props);
112 zpool_get_prop_string(zpool_handle_t *zhp, zpool_prop_t prop,
118 zprop_source_t source;
120 nvl = zhp->zpool_props;
121 if (nvlist_lookup_nvlist(nvl, zpool_prop_to_name(prop), &nv) == 0) {
122 verify(nvlist_lookup_uint64(nv, ZPROP_SOURCE, &ival) == 0);
124 verify(nvlist_lookup_string(nv, ZPROP_VALUE, &value) == 0);
126 source = ZPROP_SRC_DEFAULT;
127 if ((value = (char *)zpool_prop_default_string(prop)) == NULL)
138 zpool_get_prop_int(zpool_handle_t *zhp, zpool_prop_t prop, zprop_source_t *src)
142 zprop_source_t source;
144 if (zhp->zpool_props == NULL && zpool_get_all_props(zhp)) {
146 * zpool_get_all_props() has most likely failed because
147 * the pool is faulted, but if all we need is the top level
148 * vdev's guid then get it from the zhp config nvlist.
150 if ((prop == ZPOOL_PROP_GUID) &&
151 (nvlist_lookup_nvlist(zhp->zpool_config,
152 ZPOOL_CONFIG_VDEV_TREE, &nv) == 0) &&
153 (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &value)
157 return (zpool_prop_default_numeric(prop));
160 nvl = zhp->zpool_props;
161 if (nvlist_lookup_nvlist(nvl, zpool_prop_to_name(prop), &nv) == 0) {
162 verify(nvlist_lookup_uint64(nv, ZPROP_SOURCE, &value) == 0);
164 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
166 source = ZPROP_SRC_DEFAULT;
167 value = zpool_prop_default_numeric(prop);
177 * Map VDEV STATE to printed strings.
180 zpool_state_to_name(vdev_state_t state, vdev_aux_t aux)
183 case VDEV_STATE_CLOSED:
184 case VDEV_STATE_OFFLINE:
185 return (gettext("OFFLINE"));
186 case VDEV_STATE_REMOVED:
187 return (gettext("REMOVED"));
188 case VDEV_STATE_CANT_OPEN:
189 if (aux == VDEV_AUX_CORRUPT_DATA || aux == VDEV_AUX_BAD_LOG)
190 return (gettext("FAULTED"));
192 return (gettext("UNAVAIL"));
193 case VDEV_STATE_FAULTED:
194 return (gettext("FAULTED"));
195 case VDEV_STATE_DEGRADED:
196 return (gettext("DEGRADED"));
197 case VDEV_STATE_HEALTHY:
198 return (gettext("ONLINE"));
201 return (gettext("UNKNOWN"));
205 * Get a zpool property value for 'prop' and return the value in
206 * a pre-allocated buffer.
209 zpool_get_prop(zpool_handle_t *zhp, zpool_prop_t prop, char *buf, size_t len,
210 zprop_source_t *srctype)
214 zprop_source_t src = ZPROP_SRC_NONE;
219 if (zpool_get_state(zhp) == POOL_STATE_UNAVAIL) {
220 if (prop == ZPOOL_PROP_NAME)
221 (void) strlcpy(buf, zpool_get_name(zhp), len);
222 else if (prop == ZPOOL_PROP_HEALTH)
223 (void) strlcpy(buf, "FAULTED", len);
225 (void) strlcpy(buf, "-", len);
229 if (zhp->zpool_props == NULL && zpool_get_all_props(zhp) &&
230 prop != ZPOOL_PROP_NAME)
233 switch (zpool_prop_get_type(prop)) {
234 case PROP_TYPE_STRING:
235 (void) strlcpy(buf, zpool_get_prop_string(zhp, prop, &src),
239 case PROP_TYPE_NUMBER:
240 intval = zpool_get_prop_int(zhp, prop, &src);
243 case ZPOOL_PROP_SIZE:
244 case ZPOOL_PROP_USED:
245 case ZPOOL_PROP_AVAILABLE:
246 (void) zfs_nicenum(intval, buf, len);
249 case ZPOOL_PROP_CAPACITY:
250 (void) snprintf(buf, len, "%llu%%",
251 (u_longlong_t)intval);
254 case ZPOOL_PROP_HEALTH:
255 verify(nvlist_lookup_nvlist(zpool_get_config(zhp, NULL),
256 ZPOOL_CONFIG_VDEV_TREE, &nvroot) == 0);
257 verify(nvlist_lookup_uint64_array(nvroot,
258 ZPOOL_CONFIG_STATS, (uint64_t **)&vs, &vsc) == 0);
260 (void) strlcpy(buf, zpool_state_to_name(intval,
264 (void) snprintf(buf, len, "%llu", intval);
268 case PROP_TYPE_INDEX:
269 intval = zpool_get_prop_int(zhp, prop, &src);
270 if (zpool_prop_index_to_string(prop, intval, &strval)
273 (void) strlcpy(buf, strval, len);
287 * Check if the bootfs name has the same pool name as it is set to.
288 * Assuming bootfs is a valid dataset name.
291 bootfs_name_valid(const char *pool, char *bootfs)
293 int len = strlen(pool);
295 if (!zfs_name_valid(bootfs, ZFS_TYPE_FILESYSTEM|ZFS_TYPE_SNAPSHOT))
298 if (strncmp(pool, bootfs, len) == 0 &&
299 (bootfs[len] == '/' || bootfs[len] == '\0'))
306 * Inspect the configuration to determine if any of the devices contain
310 pool_uses_efi(nvlist_t *config)
315 if (nvlist_lookup_nvlist_array(config, ZPOOL_CONFIG_CHILDREN,
316 &child, &children) != 0)
317 return (read_efi_label(config, NULL) >= 0);
319 for (c = 0; c < children; c++) {
320 if (pool_uses_efi(child[c]))
327 pool_is_bootable(zpool_handle_t *zhp)
329 char bootfs[ZPOOL_MAXNAMELEN];
331 return (zpool_get_prop(zhp, ZPOOL_PROP_BOOTFS, bootfs,
332 sizeof (bootfs), NULL) == 0 && strncmp(bootfs, "-",
333 sizeof (bootfs)) != 0);
338 * Given an nvlist of zpool properties to be set, validate that they are
339 * correct, and parse any numeric properties (index, boolean, etc) if they are
340 * specified as strings.
343 zpool_valid_proplist(libzfs_handle_t *hdl, const char *poolname,
344 nvlist_t *props, uint64_t version, boolean_t create_or_import, char *errbuf)
352 struct stat64 statbuf;
356 if (nvlist_alloc(&retprops, NV_UNIQUE_NAME, 0) != 0) {
357 (void) no_memory(hdl);
362 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
363 const char *propname = nvpair_name(elem);
366 * Make sure this property is valid and applies to this type.
368 if ((prop = zpool_name_to_prop(propname)) == ZPROP_INVAL) {
369 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
370 "invalid property '%s'"), propname);
371 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
375 if (zpool_prop_readonly(prop)) {
376 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "'%s' "
377 "is readonly"), propname);
378 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
382 if (zprop_parse_value(hdl, elem, prop, ZFS_TYPE_POOL, retprops,
383 &strval, &intval, errbuf) != 0)
387 * Perform additional checking for specific properties.
390 case ZPOOL_PROP_VERSION:
391 if (intval < version || intval > SPA_VERSION) {
392 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
393 "property '%s' number %d is invalid."),
395 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
400 case ZPOOL_PROP_BOOTFS:
401 if (create_or_import) {
402 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
403 "property '%s' cannot be set at creation "
404 "or import time"), propname);
405 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
409 if (version < SPA_VERSION_BOOTFS) {
410 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
411 "pool must be upgraded to support "
412 "'%s' property"), propname);
413 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
418 * bootfs property value has to be a dataset name and
419 * the dataset has to be in the same pool as it sets to.
421 if (strval[0] != '\0' && !bootfs_name_valid(poolname,
423 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "'%s' "
424 "is an invalid name"), strval);
425 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
429 if ((zhp = zpool_open_canfail(hdl, poolname)) == NULL) {
430 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
431 "could not open pool '%s'"), poolname);
432 (void) zfs_error(hdl, EZFS_OPENFAILED, errbuf);
435 verify(nvlist_lookup_nvlist(zpool_get_config(zhp, NULL),
436 ZPOOL_CONFIG_VDEV_TREE, &nvroot) == 0);
439 * bootfs property cannot be set on a disk which has
442 if (pool_uses_efi(nvroot)) {
443 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
444 "property '%s' not supported on "
445 "EFI labeled devices"), propname);
446 (void) zfs_error(hdl, EZFS_POOL_NOTSUP, errbuf);
453 case ZPOOL_PROP_ALTROOT:
454 if (!create_or_import) {
455 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
456 "property '%s' can only be set during pool "
457 "creation or import"), propname);
458 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
462 if (strval[0] != '/') {
463 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
464 "bad alternate root '%s'"), strval);
465 (void) zfs_error(hdl, EZFS_BADPATH, errbuf);
470 case ZPOOL_PROP_CACHEFILE:
471 if (strval[0] == '\0')
474 if (strcmp(strval, "none") == 0)
477 if (strval[0] != '/') {
478 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
479 "property '%s' must be empty, an "
480 "absolute path, or 'none'"), propname);
481 (void) zfs_error(hdl, EZFS_BADPATH, errbuf);
485 slash = strrchr(strval, '/');
487 if (slash[1] == '\0' || strcmp(slash, "/.") == 0 ||
488 strcmp(slash, "/..") == 0) {
489 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
490 "'%s' is not a valid file"), strval);
491 (void) zfs_error(hdl, EZFS_BADPATH, errbuf);
497 if (strval[0] != '\0' &&
498 (stat64(strval, &statbuf) != 0 ||
499 !S_ISDIR(statbuf.st_mode))) {
500 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
501 "'%s' is not a valid directory"),
503 (void) zfs_error(hdl, EZFS_BADPATH, errbuf);
514 nvlist_free(retprops);
519 * Set zpool property : propname=propval.
522 zpool_set_prop(zpool_handle_t *zhp, const char *propname, const char *propval)
524 zfs_cmd_t zc = { 0 };
527 nvlist_t *nvl = NULL;
531 (void) snprintf(errbuf, sizeof (errbuf),
532 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
535 if (zhp->zpool_props == NULL && zpool_get_all_props(zhp))
536 return (zfs_error(zhp->zpool_hdl, EZFS_POOLPROPS, errbuf));
538 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
539 return (no_memory(zhp->zpool_hdl));
541 if (nvlist_add_string(nvl, propname, propval) != 0) {
543 return (no_memory(zhp->zpool_hdl));
546 version = zpool_get_prop_int(zhp, ZPOOL_PROP_VERSION, NULL);
547 if ((realprops = zpool_valid_proplist(zhp->zpool_hdl,
548 zhp->zpool_name, nvl, version, B_FALSE, errbuf)) == NULL) {
557 * Execute the corresponding ioctl() to set this property.
559 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
561 if (zcmd_write_src_nvlist(zhp->zpool_hdl, &zc, nvl) != 0) {
566 ret = zfs_ioctl(zhp->zpool_hdl, ZFS_IOC_POOL_SET_PROPS, &zc);
568 zcmd_free_nvlists(&zc);
572 (void) zpool_standard_error(zhp->zpool_hdl, errno, errbuf);
574 (void) zpool_props_refresh(zhp);
580 zpool_expand_proplist(zpool_handle_t *zhp, zprop_list_t **plp)
582 libzfs_handle_t *hdl = zhp->zpool_hdl;
584 char buf[ZFS_MAXPROPLEN];
586 if (zprop_expand_list(hdl, plp, ZFS_TYPE_POOL) != 0)
589 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
594 if (entry->pl_prop != ZPROP_INVAL &&
595 zpool_get_prop(zhp, entry->pl_prop, buf, sizeof (buf),
597 if (strlen(buf) > entry->pl_width)
598 entry->pl_width = strlen(buf);
607 * Validate the given pool name, optionally putting an extended error message in
611 zpool_name_valid(libzfs_handle_t *hdl, boolean_t isopen, const char *pool)
617 ret = pool_namecheck(pool, &why, &what);
620 * The rules for reserved pool names were extended at a later point.
621 * But we need to support users with existing pools that may now be
622 * invalid. So we only check for this expanded set of names during a
623 * create (or import), and only in userland.
625 if (ret == 0 && !isopen &&
626 (strncmp(pool, "mirror", 6) == 0 ||
627 strncmp(pool, "raidz", 5) == 0 ||
628 strncmp(pool, "spare", 5) == 0 ||
629 strcmp(pool, "log") == 0)) {
632 dgettext(TEXT_DOMAIN, "name is reserved"));
640 case NAME_ERR_TOOLONG:
642 dgettext(TEXT_DOMAIN, "name is too long"));
645 case NAME_ERR_INVALCHAR:
647 dgettext(TEXT_DOMAIN, "invalid character "
648 "'%c' in pool name"), what);
651 case NAME_ERR_NOLETTER:
652 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
653 "name must begin with a letter"));
656 case NAME_ERR_RESERVED:
657 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
658 "name is reserved"));
661 case NAME_ERR_DISKLIKE:
662 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
663 "pool name is reserved"));
666 case NAME_ERR_LEADING_SLASH:
667 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
668 "leading slash in name"));
671 case NAME_ERR_EMPTY_COMPONENT:
672 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
673 "empty component in name"));
676 case NAME_ERR_TRAILING_SLASH:
677 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
678 "trailing slash in name"));
681 case NAME_ERR_MULTIPLE_AT:
682 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
683 "multiple '@' delimiters in name"));
695 * Open a handle to the given pool, even if the pool is currently in the FAULTED
699 zpool_open_canfail(libzfs_handle_t *hdl, const char *pool)
705 * Make sure the pool name is valid.
707 if (!zpool_name_valid(hdl, B_TRUE, pool)) {
708 (void) zfs_error_fmt(hdl, EZFS_INVALIDNAME,
709 dgettext(TEXT_DOMAIN, "cannot open '%s'"),
714 if ((zhp = zfs_alloc(hdl, sizeof (zpool_handle_t))) == NULL)
717 zhp->zpool_hdl = hdl;
718 (void) strlcpy(zhp->zpool_name, pool, sizeof (zhp->zpool_name));
720 if (zpool_refresh_stats(zhp, &missing) != 0) {
726 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "no such pool"));
727 (void) zfs_error_fmt(hdl, EZFS_NOENT,
728 dgettext(TEXT_DOMAIN, "cannot open '%s'"), pool);
737 * Like the above, but silent on error. Used when iterating over pools (because
738 * the configuration cache may be out of date).
741 zpool_open_silent(libzfs_handle_t *hdl, const char *pool, zpool_handle_t **ret)
746 if ((zhp = zfs_alloc(hdl, sizeof (zpool_handle_t))) == NULL)
749 zhp->zpool_hdl = hdl;
750 (void) strlcpy(zhp->zpool_name, pool, sizeof (zhp->zpool_name));
752 if (zpool_refresh_stats(zhp, &missing) != 0) {
768 * Similar to zpool_open_canfail(), but refuses to open pools in the faulted
772 zpool_open(libzfs_handle_t *hdl, const char *pool)
776 if ((zhp = zpool_open_canfail(hdl, pool)) == NULL)
779 if (zhp->zpool_state == POOL_STATE_UNAVAIL) {
780 (void) zfs_error_fmt(hdl, EZFS_POOLUNAVAIL,
781 dgettext(TEXT_DOMAIN, "cannot open '%s'"), zhp->zpool_name);
790 * Close the handle. Simply frees the memory associated with the handle.
793 zpool_close(zpool_handle_t *zhp)
795 if (zhp->zpool_config)
796 nvlist_free(zhp->zpool_config);
797 if (zhp->zpool_old_config)
798 nvlist_free(zhp->zpool_old_config);
799 if (zhp->zpool_props)
800 nvlist_free(zhp->zpool_props);
805 * Return the name of the pool.
808 zpool_get_name(zpool_handle_t *zhp)
810 return (zhp->zpool_name);
815 * Return the state of the pool (ACTIVE or UNAVAILABLE)
818 zpool_get_state(zpool_handle_t *zhp)
820 return (zhp->zpool_state);
824 * Create the named pool, using the provided vdev list. It is assumed
825 * that the consumer has already validated the contents of the nvlist, so we
826 * don't have to worry about error semantics.
829 zpool_create(libzfs_handle_t *hdl, const char *pool, nvlist_t *nvroot,
830 nvlist_t *props, nvlist_t *fsprops)
832 zfs_cmd_t zc = { 0 };
833 nvlist_t *zc_fsprops = NULL;
834 nvlist_t *zc_props = NULL;
839 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
840 "cannot create '%s'"), pool);
842 if (!zpool_name_valid(hdl, B_FALSE, pool))
843 return (zfs_error(hdl, EZFS_INVALIDNAME, msg));
845 if (zcmd_write_conf_nvlist(hdl, &zc, nvroot) != 0)
849 if ((zc_props = zpool_valid_proplist(hdl, pool, props,
850 SPA_VERSION_1, B_TRUE, msg)) == NULL) {
859 zoned = ((nvlist_lookup_string(fsprops,
860 zfs_prop_to_name(ZFS_PROP_ZONED), &zonestr) == 0) &&
861 strcmp(zonestr, "on") == 0);
863 if ((zc_fsprops = zfs_valid_proplist(hdl,
864 ZFS_TYPE_FILESYSTEM, fsprops, zoned, NULL, msg)) == NULL) {
868 (nvlist_alloc(&zc_props, NV_UNIQUE_NAME, 0) != 0)) {
871 if (nvlist_add_nvlist(zc_props,
872 ZPOOL_ROOTFS_PROPS, zc_fsprops) != 0) {
877 if (zc_props && zcmd_write_src_nvlist(hdl, &zc, zc_props) != 0)
880 (void) strlcpy(zc.zc_name, pool, sizeof (zc.zc_name));
882 if ((ret = zfs_ioctl(hdl, ZFS_IOC_POOL_CREATE, &zc)) != 0) {
884 zcmd_free_nvlists(&zc);
885 nvlist_free(zc_props);
886 nvlist_free(zc_fsprops);
891 * This can happen if the user has specified the same
892 * device multiple times. We can't reliably detect this
893 * until we try to add it and see we already have a
896 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
897 "one or more vdevs refer to the same device"));
898 return (zfs_error(hdl, EZFS_BADDEV, msg));
902 * This occurs when one of the devices is below
903 * SPA_MINDEVSIZE. Unfortunately, we can't detect which
904 * device was the problem device since there's no
905 * reliable way to determine device size from userland.
910 zfs_nicenum(SPA_MINDEVSIZE, buf, sizeof (buf));
912 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
913 "one or more devices is less than the "
914 "minimum size (%s)"), buf);
916 return (zfs_error(hdl, EZFS_BADDEV, msg));
919 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
920 "one or more devices is out of space"));
921 return (zfs_error(hdl, EZFS_BADDEV, msg));
924 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
925 "cache device must be a disk or disk slice"));
926 return (zfs_error(hdl, EZFS_BADDEV, msg));
929 return (zpool_standard_error(hdl, errno, msg));
934 * If this is an alternate root pool, then we automatically set the
935 * mountpoint of the root dataset to be '/'.
937 if (nvlist_lookup_string(props, zpool_prop_to_name(ZPOOL_PROP_ALTROOT),
941 verify((zhp = zfs_open(hdl, pool, ZFS_TYPE_DATASET)) != NULL);
942 verify(zfs_prop_set(zhp, zfs_prop_to_name(ZFS_PROP_MOUNTPOINT),
949 zcmd_free_nvlists(&zc);
950 nvlist_free(zc_props);
951 nvlist_free(zc_fsprops);
956 * Destroy the given pool. It is up to the caller to ensure that there are no
957 * datasets left in the pool.
960 zpool_destroy(zpool_handle_t *zhp)
962 zfs_cmd_t zc = { 0 };
963 zfs_handle_t *zfp = NULL;
964 libzfs_handle_t *hdl = zhp->zpool_hdl;
967 if (zhp->zpool_state == POOL_STATE_ACTIVE &&
968 (zfp = zfs_open(zhp->zpool_hdl, zhp->zpool_name,
969 ZFS_TYPE_FILESYSTEM)) == NULL)
972 if (zpool_remove_zvol_links(zhp) != 0)
975 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
977 if (zfs_ioctl(zhp->zpool_hdl, ZFS_IOC_POOL_DESTROY, &zc) != 0) {
978 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
979 "cannot destroy '%s'"), zhp->zpool_name);
981 if (errno == EROFS) {
982 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
983 "one or more devices is read only"));
984 (void) zfs_error(hdl, EZFS_BADDEV, msg);
986 (void) zpool_standard_error(hdl, errno, msg);
995 remove_mountpoint(zfp);
1003 * Add the given vdevs to the pool. The caller must have already performed the
1004 * necessary verification to ensure that the vdev specification is well-formed.
1007 zpool_add(zpool_handle_t *zhp, nvlist_t *nvroot)
1009 zfs_cmd_t zc = { 0 };
1011 libzfs_handle_t *hdl = zhp->zpool_hdl;
1013 nvlist_t **spares, **l2cache;
1014 uint_t nspares, nl2cache;
1016 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
1017 "cannot add to '%s'"), zhp->zpool_name);
1019 if (zpool_get_prop_int(zhp, ZPOOL_PROP_VERSION, NULL) <
1020 SPA_VERSION_SPARES &&
1021 nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_SPARES,
1022 &spares, &nspares) == 0) {
1023 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool must be "
1024 "upgraded to add hot spares"));
1025 return (zfs_error(hdl, EZFS_BADVERSION, msg));
1028 if (pool_is_bootable(zhp) && nvlist_lookup_nvlist_array(nvroot,
1029 ZPOOL_CONFIG_SPARES, &spares, &nspares) == 0) {
1032 for (s = 0; s < nspares; s++) {
1035 if (nvlist_lookup_string(spares[s], ZPOOL_CONFIG_PATH,
1036 &path) == 0 && pool_uses_efi(spares[s])) {
1037 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1038 "device '%s' contains an EFI label and "
1039 "cannot be used on root pools."),
1040 zpool_vdev_name(hdl, NULL, spares[s]));
1041 return (zfs_error(hdl, EZFS_POOL_NOTSUP, msg));
1046 if (zpool_get_prop_int(zhp, ZPOOL_PROP_VERSION, NULL) <
1047 SPA_VERSION_L2CACHE &&
1048 nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_L2CACHE,
1049 &l2cache, &nl2cache) == 0) {
1050 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool must be "
1051 "upgraded to add cache devices"));
1052 return (zfs_error(hdl, EZFS_BADVERSION, msg));
1055 if (zcmd_write_conf_nvlist(hdl, &zc, nvroot) != 0)
1057 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
1059 if (zfs_ioctl(zhp->zpool_hdl, ZFS_IOC_VDEV_ADD, &zc) != 0) {
1063 * This can happen if the user has specified the same
1064 * device multiple times. We can't reliably detect this
1065 * until we try to add it and see we already have a
1068 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1069 "one or more vdevs refer to the same device"));
1070 (void) zfs_error(hdl, EZFS_BADDEV, msg);
1075 * This occurrs when one of the devices is below
1076 * SPA_MINDEVSIZE. Unfortunately, we can't detect which
1077 * device was the problem device since there's no
1078 * reliable way to determine device size from userland.
1083 zfs_nicenum(SPA_MINDEVSIZE, buf, sizeof (buf));
1085 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1086 "device is less than the minimum "
1089 (void) zfs_error(hdl, EZFS_BADDEV, msg);
1093 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1094 "pool must be upgraded to add these vdevs"));
1095 (void) zfs_error(hdl, EZFS_BADVERSION, msg);
1099 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1100 "root pool can not have multiple vdevs"
1101 " or separate logs"));
1102 (void) zfs_error(hdl, EZFS_POOL_NOTSUP, msg);
1106 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1107 "cache device must be a disk or disk slice"));
1108 (void) zfs_error(hdl, EZFS_BADDEV, msg);
1112 (void) zpool_standard_error(hdl, errno, msg);
1120 zcmd_free_nvlists(&zc);
1126 * Exports the pool from the system. The caller must ensure that there are no
1127 * mounted datasets in the pool.
1130 zpool_export_common(zpool_handle_t *zhp, boolean_t force, boolean_t hardforce)
1132 zfs_cmd_t zc = { 0 };
1135 if (zpool_remove_zvol_links(zhp) != 0)
1138 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
1139 "cannot export '%s'"), zhp->zpool_name);
1141 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
1142 zc.zc_cookie = force;
1143 zc.zc_guid = hardforce;
1145 if (zfs_ioctl(zhp->zpool_hdl, ZFS_IOC_POOL_EXPORT, &zc) != 0) {
1148 zfs_error_aux(zhp->zpool_hdl, dgettext(TEXT_DOMAIN,
1149 "use '-f' to override the following errors:\n"
1150 "'%s' has an active shared spare which could be"
1151 " used by other pools once '%s' is exported."),
1152 zhp->zpool_name, zhp->zpool_name);
1153 return (zfs_error(zhp->zpool_hdl, EZFS_ACTIVE_SPARE,
1156 return (zpool_standard_error_fmt(zhp->zpool_hdl, errno,
1165 zpool_export(zpool_handle_t *zhp, boolean_t force)
1167 return (zpool_export_common(zhp, force, B_FALSE));
1171 zpool_export_force(zpool_handle_t *zhp)
1173 return (zpool_export_common(zhp, B_TRUE, B_TRUE));
1177 * zpool_import() is a contracted interface. Should be kept the same
1180 * Applications should use zpool_import_props() to import a pool with
1181 * new properties value to be set.
1184 zpool_import(libzfs_handle_t *hdl, nvlist_t *config, const char *newname,
1187 nvlist_t *props = NULL;
1190 if (altroot != NULL) {
1191 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0) {
1192 return (zfs_error_fmt(hdl, EZFS_NOMEM,
1193 dgettext(TEXT_DOMAIN, "cannot import '%s'"),
1197 if (nvlist_add_string(props,
1198 zpool_prop_to_name(ZPOOL_PROP_ALTROOT), altroot) != 0 ||
1199 nvlist_add_string(props,
1200 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE), "none") != 0) {
1202 return (zfs_error_fmt(hdl, EZFS_NOMEM,
1203 dgettext(TEXT_DOMAIN, "cannot import '%s'"),
1208 ret = zpool_import_props(hdl, config, newname, props, B_FALSE);
1215 * Import the given pool using the known configuration and a list of
1216 * properties to be set. The configuration should have come from
1217 * zpool_find_import(). The 'newname' parameters control whether the pool
1218 * is imported with a different name.
1221 zpool_import_props(libzfs_handle_t *hdl, nvlist_t *config, const char *newname,
1222 nvlist_t *props, boolean_t importfaulted)
1224 zfs_cmd_t zc = { 0 };
1230 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
1233 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1234 "cannot import pool '%s'"), origname);
1236 if (newname != NULL) {
1237 if (!zpool_name_valid(hdl, B_FALSE, newname))
1238 return (zfs_error_fmt(hdl, EZFS_INVALIDNAME,
1239 dgettext(TEXT_DOMAIN, "cannot import '%s'"),
1241 thename = (char *)newname;
1249 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_VERSION,
1252 if ((props = zpool_valid_proplist(hdl, origname,
1253 props, version, B_TRUE, errbuf)) == NULL) {
1255 } else if (zcmd_write_src_nvlist(hdl, &zc, props) != 0) {
1261 (void) strlcpy(zc.zc_name, thename, sizeof (zc.zc_name));
1263 verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
1266 if (zcmd_write_conf_nvlist(hdl, &zc, config) != 0) {
1271 zc.zc_cookie = (uint64_t)importfaulted;
1273 if (zfs_ioctl(hdl, ZFS_IOC_POOL_IMPORT, &zc) != 0) {
1275 if (newname == NULL)
1276 (void) snprintf(desc, sizeof (desc),
1277 dgettext(TEXT_DOMAIN, "cannot import '%s'"),
1280 (void) snprintf(desc, sizeof (desc),
1281 dgettext(TEXT_DOMAIN, "cannot import '%s' as '%s'"),
1287 * Unsupported version.
1289 (void) zfs_error(hdl, EZFS_BADVERSION, desc);
1293 (void) zfs_error(hdl, EZFS_INVALCONFIG, desc);
1297 (void) zpool_standard_error(hdl, errno, desc);
1302 zpool_handle_t *zhp;
1305 * This should never fail, but play it safe anyway.
1307 if (zpool_open_silent(hdl, thename, &zhp) != 0) {
1309 } else if (zhp != NULL) {
1310 ret = zpool_create_zvol_links(zhp);
1316 zcmd_free_nvlists(&zc);
1326 zpool_scrub(zpool_handle_t *zhp, pool_scrub_type_t type)
1328 zfs_cmd_t zc = { 0 };
1330 libzfs_handle_t *hdl = zhp->zpool_hdl;
1332 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
1333 zc.zc_cookie = type;
1335 if (zfs_ioctl(zhp->zpool_hdl, ZFS_IOC_POOL_SCRUB, &zc) == 0)
1338 (void) snprintf(msg, sizeof (msg),
1339 dgettext(TEXT_DOMAIN, "cannot scrub %s"), zc.zc_name);
1342 return (zfs_error(hdl, EZFS_RESILVERING, msg));
1344 return (zpool_standard_error(hdl, errno, msg));
1348 * 'avail_spare' is set to TRUE if the provided guid refers to an AVAIL
1349 * spare; but FALSE if its an INUSE spare.
1352 vdev_to_nvlist_iter(nvlist_t *nv, const char *search, uint64_t guid,
1353 boolean_t *avail_spare, boolean_t *l2cache, boolean_t *log)
1357 uint64_t theguid, present;
1359 uint64_t wholedisk = 0;
1363 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &theguid) == 0);
1365 if (search == NULL &&
1366 nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NOT_PRESENT, &present) == 0) {
1368 * If the device has never been present since import, the only
1369 * reliable way to match the vdev is by GUID.
1371 if (theguid == guid)
1373 } else if (search != NULL &&
1374 nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0) {
1375 (void) nvlist_lookup_uint64(nv, ZPOOL_CONFIG_WHOLE_DISK,
1379 * For whole disks, the internal path has 's0', but the
1380 * path passed in by the user doesn't.
1382 if (strlen(search) == strlen(path) - 2 &&
1383 strncmp(search, path, strlen(search)) == 0)
1385 } else if (strcmp(search, path) == 0) {
1390 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
1391 &child, &children) != 0)
1394 for (c = 0; c < children; c++) {
1395 if ((ret = vdev_to_nvlist_iter(child[c], search, guid,
1396 avail_spare, l2cache, NULL)) != NULL) {
1398 * The 'is_log' value is only set for the toplevel
1399 * vdev, not the leaf vdevs. So we always lookup the
1400 * log device from the root of the vdev tree (where
1401 * 'log' is non-NULL).
1404 nvlist_lookup_uint64(child[c],
1405 ZPOOL_CONFIG_IS_LOG, &is_log) == 0 &&
1413 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_SPARES,
1414 &child, &children) == 0) {
1415 for (c = 0; c < children; c++) {
1416 if ((ret = vdev_to_nvlist_iter(child[c], search, guid,
1417 avail_spare, l2cache, NULL)) != NULL) {
1418 *avail_spare = B_TRUE;
1424 if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_L2CACHE,
1425 &child, &children) == 0) {
1426 for (c = 0; c < children; c++) {
1427 if ((ret = vdev_to_nvlist_iter(child[c], search, guid,
1428 avail_spare, l2cache, NULL)) != NULL) {
1439 zpool_find_vdev(zpool_handle_t *zhp, const char *path, boolean_t *avail_spare,
1440 boolean_t *l2cache, boolean_t *log)
1442 char buf[MAXPATHLEN];
1448 guid = strtoull(path, &end, 10);
1449 if (guid != 0 && *end == '\0') {
1451 } else if (path[0] != '/') {
1452 (void) snprintf(buf, sizeof (buf), "%s%s", "/dev/dsk/", path);
1458 verify(nvlist_lookup_nvlist(zhp->zpool_config, ZPOOL_CONFIG_VDEV_TREE,
1461 *avail_spare = B_FALSE;
1465 return (vdev_to_nvlist_iter(nvroot, search, guid, avail_spare,
1470 vdev_online(nvlist_t *nv)
1474 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_OFFLINE, &ival) == 0 ||
1475 nvlist_lookup_uint64(nv, ZPOOL_CONFIG_FAULTED, &ival) == 0 ||
1476 nvlist_lookup_uint64(nv, ZPOOL_CONFIG_REMOVED, &ival) == 0)
1483 * Get phys_path for a root pool
1484 * Return 0 on success; non-zeron on failure.
1487 zpool_get_physpath(zpool_handle_t *zhp, char *physpath)
1489 nvlist_t *vdev_root;
1495 * Make sure this is a root pool, as phys_path doesn't mean
1496 * anything to a non-root pool.
1498 if (!pool_is_bootable(zhp))
1501 verify(nvlist_lookup_nvlist(zhp->zpool_config,
1502 ZPOOL_CONFIG_VDEV_TREE, &vdev_root) == 0);
1504 if (nvlist_lookup_nvlist_array(vdev_root, ZPOOL_CONFIG_CHILDREN,
1505 &child, &count) != 0)
1508 for (i = 0; i < count; i++) {
1515 if (nvlist_lookup_string(child[i], ZPOOL_CONFIG_TYPE, &type)
1519 if (strcmp(type, VDEV_TYPE_DISK) == 0) {
1520 if (!vdev_online(child[i]))
1522 verify(nvlist_lookup_string(child[i],
1523 ZPOOL_CONFIG_PHYS_PATH, &tmppath) == 0);
1524 (void) strncpy(physpath, tmppath, strlen(tmppath));
1525 } else if (strcmp(type, VDEV_TYPE_MIRROR) == 0) {
1526 if (nvlist_lookup_nvlist_array(child[i],
1527 ZPOOL_CONFIG_CHILDREN, &child2, &count2) != 0)
1530 for (j = 0; j < count2; j++) {
1531 if (!vdev_online(child2[j]))
1533 if (nvlist_lookup_string(child2[j],
1534 ZPOOL_CONFIG_PHYS_PATH, &tmppath) != 0)
1537 if ((strlen(physpath) + strlen(tmppath)) >
1541 if (strlen(physpath) == 0) {
1542 (void) strncpy(physpath, tmppath,
1545 (void) strcat(physpath, " ");
1546 (void) strcat(physpath, tmppath);
1558 * Returns TRUE if the given guid corresponds to the given type.
1559 * This is used to check for hot spares (INUSE or not), and level 2 cache
1563 is_guid_type(zpool_handle_t *zhp, uint64_t guid, const char *type)
1565 uint64_t target_guid;
1571 verify(nvlist_lookup_nvlist(zhp->zpool_config, ZPOOL_CONFIG_VDEV_TREE,
1573 if (nvlist_lookup_nvlist_array(nvroot, type, &list, &count) == 0) {
1574 for (i = 0; i < count; i++) {
1575 verify(nvlist_lookup_uint64(list[i], ZPOOL_CONFIG_GUID,
1576 &target_guid) == 0);
1577 if (guid == target_guid)
1586 * Bring the specified vdev online. The 'flags' parameter is a set of the
1587 * ZFS_ONLINE_* flags.
1590 zpool_vdev_online(zpool_handle_t *zhp, const char *path, int flags,
1591 vdev_state_t *newstate)
1593 zfs_cmd_t zc = { 0 };
1596 boolean_t avail_spare, l2cache;
1597 libzfs_handle_t *hdl = zhp->zpool_hdl;
1599 (void) snprintf(msg, sizeof (msg),
1600 dgettext(TEXT_DOMAIN, "cannot online %s"), path);
1602 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
1603 if ((tgt = zpool_find_vdev(zhp, path, &avail_spare, &l2cache,
1605 return (zfs_error(hdl, EZFS_NODEVICE, msg));
1607 verify(nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_GUID, &zc.zc_guid) == 0);
1610 is_guid_type(zhp, zc.zc_guid, ZPOOL_CONFIG_SPARES) == B_TRUE)
1611 return (zfs_error(hdl, EZFS_ISSPARE, msg));
1613 zc.zc_cookie = VDEV_STATE_ONLINE;
1616 if (zfs_ioctl(zhp->zpool_hdl, ZFS_IOC_VDEV_SET_STATE, &zc) != 0)
1617 return (zpool_standard_error(hdl, errno, msg));
1619 *newstate = zc.zc_cookie;
1624 * Take the specified vdev offline
1627 zpool_vdev_offline(zpool_handle_t *zhp, const char *path, boolean_t istmp)
1629 zfs_cmd_t zc = { 0 };
1632 boolean_t avail_spare, l2cache;
1633 libzfs_handle_t *hdl = zhp->zpool_hdl;
1635 (void) snprintf(msg, sizeof (msg),
1636 dgettext(TEXT_DOMAIN, "cannot offline %s"), path);
1638 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
1639 if ((tgt = zpool_find_vdev(zhp, path, &avail_spare, &l2cache,
1641 return (zfs_error(hdl, EZFS_NODEVICE, msg));
1643 verify(nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_GUID, &zc.zc_guid) == 0);
1646 is_guid_type(zhp, zc.zc_guid, ZPOOL_CONFIG_SPARES) == B_TRUE)
1647 return (zfs_error(hdl, EZFS_ISSPARE, msg));
1649 zc.zc_cookie = VDEV_STATE_OFFLINE;
1650 zc.zc_obj = istmp ? ZFS_OFFLINE_TEMPORARY : 0;
1652 if (zfs_ioctl(zhp->zpool_hdl, ZFS_IOC_VDEV_SET_STATE, &zc) == 0)
1659 * There are no other replicas of this device.
1661 return (zfs_error(hdl, EZFS_NOREPLICAS, msg));
1664 return (zpool_standard_error(hdl, errno, msg));
1669 * Mark the given vdev faulted.
1672 zpool_vdev_fault(zpool_handle_t *zhp, uint64_t guid)
1674 zfs_cmd_t zc = { 0 };
1676 libzfs_handle_t *hdl = zhp->zpool_hdl;
1678 (void) snprintf(msg, sizeof (msg),
1679 dgettext(TEXT_DOMAIN, "cannot fault %llu"), guid);
1681 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
1683 zc.zc_cookie = VDEV_STATE_FAULTED;
1685 if (ioctl(zhp->zpool_hdl->libzfs_fd, ZFS_IOC_VDEV_SET_STATE, &zc) == 0)
1692 * There are no other replicas of this device.
1694 return (zfs_error(hdl, EZFS_NOREPLICAS, msg));
1697 return (zpool_standard_error(hdl, errno, msg));
1703 * Mark the given vdev degraded.
1706 zpool_vdev_degrade(zpool_handle_t *zhp, uint64_t guid)
1708 zfs_cmd_t zc = { 0 };
1710 libzfs_handle_t *hdl = zhp->zpool_hdl;
1712 (void) snprintf(msg, sizeof (msg),
1713 dgettext(TEXT_DOMAIN, "cannot degrade %llu"), guid);
1715 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
1717 zc.zc_cookie = VDEV_STATE_DEGRADED;
1719 if (ioctl(zhp->zpool_hdl->libzfs_fd, ZFS_IOC_VDEV_SET_STATE, &zc) == 0)
1722 return (zpool_standard_error(hdl, errno, msg));
1726 * Returns TRUE if the given nvlist is a vdev that was originally swapped in as
1730 is_replacing_spare(nvlist_t *search, nvlist_t *tgt, int which)
1736 if (nvlist_lookup_nvlist_array(search, ZPOOL_CONFIG_CHILDREN, &child,
1738 verify(nvlist_lookup_string(search, ZPOOL_CONFIG_TYPE,
1741 if (strcmp(type, VDEV_TYPE_SPARE) == 0 &&
1742 children == 2 && child[which] == tgt)
1745 for (c = 0; c < children; c++)
1746 if (is_replacing_spare(child[c], tgt, which))
1754 * Attach new_disk (fully described by nvroot) to old_disk.
1755 * If 'replacing' is specified, the new disk will replace the old one.
1758 zpool_vdev_attach(zpool_handle_t *zhp,
1759 const char *old_disk, const char *new_disk, nvlist_t *nvroot, int replacing)
1761 zfs_cmd_t zc = { 0 };
1765 boolean_t avail_spare, l2cache, islog;
1767 char *path, *newname;
1770 nvlist_t *config_root;
1771 libzfs_handle_t *hdl = zhp->zpool_hdl;
1772 boolean_t rootpool = pool_is_bootable(zhp);
1775 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
1776 "cannot replace %s with %s"), old_disk, new_disk);
1778 (void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
1779 "cannot attach %s to %s"), new_disk, old_disk);
1782 * If this is a root pool, make sure that we're not attaching an
1783 * EFI labeled device.
1785 if (rootpool && pool_uses_efi(nvroot)) {
1786 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1787 "EFI labeled devices are not supported on root pools."));
1788 return (zfs_error(hdl, EZFS_POOL_NOTSUP, msg));
1791 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
1792 if ((tgt = zpool_find_vdev(zhp, old_disk, &avail_spare, &l2cache,
1794 return (zfs_error(hdl, EZFS_NODEVICE, msg));
1797 return (zfs_error(hdl, EZFS_ISSPARE, msg));
1800 return (zfs_error(hdl, EZFS_ISL2CACHE, msg));
1802 verify(nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_GUID, &zc.zc_guid) == 0);
1803 zc.zc_cookie = replacing;
1805 if (nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN,
1806 &child, &children) != 0 || children != 1) {
1807 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1808 "new device must be a single disk"));
1809 return (zfs_error(hdl, EZFS_INVALCONFIG, msg));
1812 verify(nvlist_lookup_nvlist(zpool_get_config(zhp, NULL),
1813 ZPOOL_CONFIG_VDEV_TREE, &config_root) == 0);
1815 if ((newname = zpool_vdev_name(NULL, NULL, child[0])) == NULL)
1819 * If the target is a hot spare that has been swapped in, we can only
1820 * replace it with another hot spare.
1823 nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_IS_SPARE, &val) == 0 &&
1824 (zpool_find_vdev(zhp, newname, &avail_spare, &l2cache,
1825 NULL) == NULL || !avail_spare) &&
1826 is_replacing_spare(config_root, tgt, 1)) {
1827 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1828 "can only be replaced by another hot spare"));
1830 return (zfs_error(hdl, EZFS_BADTARGET, msg));
1834 * If we are attempting to replace a spare, it canot be applied to an
1835 * already spared device.
1838 nvlist_lookup_string(child[0], ZPOOL_CONFIG_PATH, &path) == 0 &&
1839 zpool_find_vdev(zhp, newname, &avail_spare,
1840 &l2cache, NULL) != NULL && avail_spare &&
1841 is_replacing_spare(config_root, tgt, 0)) {
1842 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1843 "device has already been replaced with a spare"));
1845 return (zfs_error(hdl, EZFS_BADTARGET, msg));
1850 if (zcmd_write_conf_nvlist(hdl, &zc, nvroot) != 0)
1853 ret = zfs_ioctl(zhp->zpool_hdl, ZFS_IOC_VDEV_ATTACH, &zc);
1855 zcmd_free_nvlists(&zc);
1860 * XXX - This should be removed once we can
1861 * automatically install the bootblocks on the
1862 * newly attached disk.
1864 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "Please "
1865 "be sure to invoke %s to make '%s' bootable.\n"),
1874 * Can't attach to or replace this type of vdev.
1878 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1879 "cannot replace a log with a spare"));
1881 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1882 "cannot replace a replacing device"));
1884 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1885 "can only attach to mirrors and top-level "
1888 (void) zfs_error(hdl, EZFS_BADTARGET, msg);
1893 * The new device must be a single disk.
1895 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1896 "new device must be a single disk"));
1897 (void) zfs_error(hdl, EZFS_INVALCONFIG, msg);
1901 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "%s is busy"),
1903 (void) zfs_error(hdl, EZFS_BADDEV, msg);
1908 * The new device is too small.
1910 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1911 "device is too small"));
1912 (void) zfs_error(hdl, EZFS_BADDEV, msg);
1917 * The new device has a different alignment requirement.
1919 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1920 "devices have different sector alignment"));
1921 (void) zfs_error(hdl, EZFS_BADDEV, msg);
1926 * The resulting top-level vdev spec won't fit in the label.
1928 (void) zfs_error(hdl, EZFS_DEVOVERFLOW, msg);
1932 (void) zpool_standard_error(hdl, errno, msg);
1939 * Detach the specified device.
1942 zpool_vdev_detach(zpool_handle_t *zhp, const char *path)
1944 zfs_cmd_t zc = { 0 };
1947 boolean_t avail_spare, l2cache;
1948 libzfs_handle_t *hdl = zhp->zpool_hdl;
1950 (void) snprintf(msg, sizeof (msg),
1951 dgettext(TEXT_DOMAIN, "cannot detach %s"), path);
1953 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
1954 if ((tgt = zpool_find_vdev(zhp, path, &avail_spare, &l2cache,
1956 return (zfs_error(hdl, EZFS_NODEVICE, msg));
1959 return (zfs_error(hdl, EZFS_ISSPARE, msg));
1962 return (zfs_error(hdl, EZFS_ISL2CACHE, msg));
1964 verify(nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_GUID, &zc.zc_guid) == 0);
1966 if (zfs_ioctl(hdl, ZFS_IOC_VDEV_DETACH, &zc) == 0)
1973 * Can't detach from this type of vdev.
1975 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "only "
1976 "applicable to mirror and replacing vdevs"));
1977 (void) zfs_error(zhp->zpool_hdl, EZFS_BADTARGET, msg);
1982 * There are no other replicas of this device.
1984 (void) zfs_error(hdl, EZFS_NOREPLICAS, msg);
1988 (void) zpool_standard_error(hdl, errno, msg);
1995 * Remove the given device. Currently, this is supported only for hot spares
1996 * and level 2 cache devices.
1999 zpool_vdev_remove(zpool_handle_t *zhp, const char *path)
2001 zfs_cmd_t zc = { 0 };
2004 boolean_t avail_spare, l2cache;
2005 libzfs_handle_t *hdl = zhp->zpool_hdl;
2007 (void) snprintf(msg, sizeof (msg),
2008 dgettext(TEXT_DOMAIN, "cannot remove %s"), path);
2010 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
2011 if ((tgt = zpool_find_vdev(zhp, path, &avail_spare, &l2cache,
2013 return (zfs_error(hdl, EZFS_NODEVICE, msg));
2015 if (!avail_spare && !l2cache) {
2016 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2017 "only inactive hot spares or cache devices "
2019 return (zfs_error(hdl, EZFS_NODEVICE, msg));
2022 verify(nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_GUID, &zc.zc_guid) == 0);
2024 if (zfs_ioctl(hdl, ZFS_IOC_VDEV_REMOVE, &zc) == 0)
2027 return (zpool_standard_error(hdl, errno, msg));
2031 * Clear the errors for the pool, or the particular device if specified.
2034 zpool_clear(zpool_handle_t *zhp, const char *path)
2036 zfs_cmd_t zc = { 0 };
2039 boolean_t avail_spare, l2cache;
2040 libzfs_handle_t *hdl = zhp->zpool_hdl;
2043 (void) snprintf(msg, sizeof (msg),
2044 dgettext(TEXT_DOMAIN, "cannot clear errors for %s"),
2047 (void) snprintf(msg, sizeof (msg),
2048 dgettext(TEXT_DOMAIN, "cannot clear errors for %s"),
2051 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
2053 if ((tgt = zpool_find_vdev(zhp, path, &avail_spare,
2054 &l2cache, NULL)) == 0)
2055 return (zfs_error(hdl, EZFS_NODEVICE, msg));
2058 * Don't allow error clearing for hot spares. Do allow
2059 * error clearing for l2cache devices.
2062 return (zfs_error(hdl, EZFS_ISSPARE, msg));
2064 verify(nvlist_lookup_uint64(tgt, ZPOOL_CONFIG_GUID,
2068 if (zfs_ioctl(hdl, ZFS_IOC_CLEAR, &zc) == 0)
2071 return (zpool_standard_error(hdl, errno, msg));
2075 * Similar to zpool_clear(), but takes a GUID (used by fmd).
2078 zpool_vdev_clear(zpool_handle_t *zhp, uint64_t guid)
2080 zfs_cmd_t zc = { 0 };
2082 libzfs_handle_t *hdl = zhp->zpool_hdl;
2084 (void) snprintf(msg, sizeof (msg),
2085 dgettext(TEXT_DOMAIN, "cannot clear errors for %llx"),
2088 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
2091 if (ioctl(hdl->libzfs_fd, ZFS_IOC_CLEAR, &zc) == 0)
2094 return (zpool_standard_error(hdl, errno, msg));
2098 * Iterate over all zvols in a given pool by walking the /dev/zvol/dsk/<pool>
2102 zpool_iter_zvol(zpool_handle_t *zhp, int (*cb)(const char *, void *),
2105 libzfs_handle_t *hdl = zhp->zpool_hdl;
2106 char (*paths)[MAXPATHLEN];
2108 int curr, fd, base, ret = 0;
2113 if ((base = open("/dev/zvol/dsk", O_RDONLY)) < 0)
2114 return (errno == ENOENT ? 0 : -1);
2116 if (fstatat(base, zhp->zpool_name, &st, 0) != 0) {
2119 return (err == ENOENT ? 0 : -1);
2123 * Oddly this wasn't a directory -- ignore that failure since we
2124 * know there are no links lower in the (non-existant) hierarchy.
2126 if (!S_ISDIR(st.st_mode)) {
2131 if ((paths = zfs_alloc(hdl, size * sizeof (paths[0]))) == NULL) {
2136 (void) strlcpy(paths[0], zhp->zpool_name, sizeof (paths[0]));
2140 if (fstatat(base, paths[curr], &st, AT_SYMLINK_NOFOLLOW) != 0)
2143 if (S_ISDIR(st.st_mode)) {
2144 if ((fd = openat(base, paths[curr], O_RDONLY)) < 0)
2147 if ((dirp = fdopendir(fd)) == NULL) {
2152 while ((dp = readdir(dirp)) != NULL) {
2153 if (dp->d_name[0] == '.')
2156 if (curr + 1 == size) {
2157 paths = zfs_realloc(hdl, paths,
2158 size * sizeof (paths[0]),
2159 size * 2 * sizeof (paths[0]));
2160 if (paths == NULL) {
2161 (void) closedir(dirp);
2169 (void) strlcpy(paths[curr + 1], paths[curr],
2170 sizeof (paths[curr + 1]));
2171 (void) strlcat(paths[curr], "/",
2172 sizeof (paths[curr]));
2173 (void) strlcat(paths[curr], dp->d_name,
2174 sizeof (paths[curr]));
2178 (void) closedir(dirp);
2181 if ((ret = cb(paths[curr], data)) != 0)
2199 typedef struct zvol_cb {
2200 zpool_handle_t *zcb_pool;
2201 boolean_t zcb_create;
2206 do_zvol_create(zfs_handle_t *zhp, void *data)
2210 if (ZFS_IS_VOLUME(zhp)) {
2211 (void) zvol_create_link(zhp->zfs_hdl, zhp->zfs_name);
2212 ret = zfs_iter_snapshots(zhp, do_zvol_create, NULL);
2216 ret = zfs_iter_filesystems(zhp, do_zvol_create, NULL);
2224 * Iterate over all zvols in the pool and make any necessary minor nodes.
2227 zpool_create_zvol_links(zpool_handle_t *zhp)
2233 * If the pool is unavailable, just return success.
2235 if ((zfp = make_dataset_handle(zhp->zpool_hdl,
2236 zhp->zpool_name)) == NULL)
2239 ret = zfs_iter_filesystems(zfp, do_zvol_create, NULL);
2246 do_zvol_remove(const char *dataset, void *data)
2248 zpool_handle_t *zhp = data;
2250 return (zvol_remove_link(zhp->zpool_hdl, dataset));
2254 * Iterate over all zvols in the pool and remove any minor nodes. We iterate
2255 * by examining the /dev links so that a corrupted pool doesn't impede this
2259 zpool_remove_zvol_links(zpool_handle_t *zhp)
2261 return (zpool_iter_zvol(zhp, do_zvol_remove, zhp));
2265 * Convert from a devid string to a path.
2268 devid_to_path(char *devid_str)
2273 devid_nmlist_t *list = NULL;
2276 if (devid_str_decode(devid_str, &devid, &minor) != 0)
2279 ret = devid_deviceid_to_nmlist("/dev", devid, minor, &list);
2281 devid_str_free(minor);
2287 if ((path = strdup(list[0].devname)) == NULL)
2290 devid_free_nmlist(list);
2296 * Convert from a path to a devid string.
2299 path_to_devid(const char *path)
2305 if ((fd = open(path, O_RDONLY)) < 0)
2310 if (devid_get(fd, &devid) == 0) {
2311 if (devid_get_minor_name(fd, &minor) == 0)
2312 ret = devid_str_encode(devid, minor);
2314 devid_str_free(minor);
2323 * Issue the necessary ioctl() to update the stored path value for the vdev. We
2324 * ignore any failure here, since a common case is for an unprivileged user to
2325 * type 'zpool status', and we'll display the correct information anyway.
2328 set_path(zpool_handle_t *zhp, nvlist_t *nv, const char *path)
2330 zfs_cmd_t zc = { 0 };
2332 (void) strncpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
2333 (void) strncpy(zc.zc_value, path, sizeof (zc.zc_value));
2334 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID,
2337 (void) ioctl(zhp->zpool_hdl->libzfs_fd, ZFS_IOC_VDEV_SETPATH, &zc);
2341 * Given a vdev, return the name to display in iostat. If the vdev has a path,
2342 * we use that, stripping off any leading "/dev/dsk/"; if not, we use the type.
2343 * We also check if this is a whole disk, in which case we strip off the
2344 * trailing 's0' slice name.
2346 * This routine is also responsible for identifying when disks have been
2347 * reconfigured in a new location. The kernel will have opened the device by
2348 * devid, but the path will still refer to the old location. To catch this, we
2349 * first do a path -> devid translation (which is fast for the common case). If
2350 * the devid matches, we're done. If not, we do a reverse devid -> path
2351 * translation and issue the appropriate ioctl() to update the path of the vdev.
2352 * If 'zhp' is NULL, then this is an exported pool, and we don't need to do any
2356 zpool_vdev_name(libzfs_handle_t *hdl, zpool_handle_t *zhp, nvlist_t *nv)
2364 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NOT_PRESENT,
2366 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID,
2368 (void) snprintf(buf, sizeof (buf), "%llu",
2369 (u_longlong_t)value);
2371 } else if (nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0) {
2374 * If the device is dead (faulted, offline, etc) then don't
2375 * bother opening it. Otherwise we may be forcing the user to
2376 * open a misbehaving device, which can have undesirable
2379 if ((nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_STATS,
2380 (uint64_t **)&vs, &vsc) != 0 ||
2381 vs->vs_state >= VDEV_STATE_DEGRADED) &&
2383 nvlist_lookup_string(nv, ZPOOL_CONFIG_DEVID, &devid) == 0) {
2385 * Determine if the current path is correct.
2387 char *newdevid = path_to_devid(path);
2389 if (newdevid == NULL ||
2390 strcmp(devid, newdevid) != 0) {
2393 if ((newpath = devid_to_path(devid)) != NULL) {
2395 * Update the path appropriately.
2397 set_path(zhp, nv, newpath);
2398 if (nvlist_add_string(nv,
2399 ZPOOL_CONFIG_PATH, newpath) == 0)
2400 verify(nvlist_lookup_string(nv,
2408 devid_str_free(newdevid);
2411 if (strncmp(path, "/dev/dsk/", 9) == 0)
2414 if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_WHOLE_DISK,
2415 &value) == 0 && value) {
2416 char *tmp = zfs_strdup(hdl, path);
2419 tmp[strlen(path) - 2] = '\0';
2423 verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE, &path) == 0);
2426 * If it's a raidz device, we need to stick in the parity level.
2428 if (strcmp(path, VDEV_TYPE_RAIDZ) == 0) {
2429 verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NPARITY,
2431 (void) snprintf(buf, sizeof (buf), "%s%llu", path,
2432 (u_longlong_t)value);
2437 return (zfs_strdup(hdl, path));
2441 zbookmark_compare(const void *a, const void *b)
2443 return (memcmp(a, b, sizeof (zbookmark_t)));
2447 * Retrieve the persistent error log, uniquify the members, and return to the
2451 zpool_get_errlog(zpool_handle_t *zhp, nvlist_t **nverrlistp)
2453 zfs_cmd_t zc = { 0 };
2455 zbookmark_t *zb = NULL;
2459 * Retrieve the raw error list from the kernel. If the number of errors
2460 * has increased, allocate more space and continue until we get the
2463 verify(nvlist_lookup_uint64(zhp->zpool_config, ZPOOL_CONFIG_ERRCOUNT,
2467 if ((zc.zc_nvlist_dst = (uintptr_t)zfs_alloc(zhp->zpool_hdl,
2468 count * sizeof (zbookmark_t))) == (uintptr_t)NULL)
2470 zc.zc_nvlist_dst_size = count;
2471 (void) strcpy(zc.zc_name, zhp->zpool_name);
2473 if (ioctl(zhp->zpool_hdl->libzfs_fd, ZFS_IOC_ERROR_LOG,
2475 free((void *)(uintptr_t)zc.zc_nvlist_dst);
2476 if (errno == ENOMEM) {
2477 count = zc.zc_nvlist_dst_size;
2478 if ((zc.zc_nvlist_dst = (uintptr_t)
2479 zfs_alloc(zhp->zpool_hdl, count *
2480 sizeof (zbookmark_t))) == (uintptr_t)NULL)
2491 * Sort the resulting bookmarks. This is a little confusing due to the
2492 * implementation of ZFS_IOC_ERROR_LOG. The bookmarks are copied last
2493 * to first, and 'zc_nvlist_dst_size' indicates the number of boomarks
2494 * _not_ copied as part of the process. So we point the start of our
2495 * array appropriate and decrement the total number of elements.
2497 zb = ((zbookmark_t *)(uintptr_t)zc.zc_nvlist_dst) +
2498 zc.zc_nvlist_dst_size;
2499 count -= zc.zc_nvlist_dst_size;
2501 qsort(zb, count, sizeof (zbookmark_t), zbookmark_compare);
2503 verify(nvlist_alloc(nverrlistp, 0, KM_SLEEP) == 0);
2506 * Fill in the nverrlistp with nvlist's of dataset and object numbers.
2508 for (i = 0; i < count; i++) {
2511 /* ignoring zb_blkid and zb_level for now */
2512 if (i > 0 && zb[i-1].zb_objset == zb[i].zb_objset &&
2513 zb[i-1].zb_object == zb[i].zb_object)
2516 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, KM_SLEEP) != 0)
2518 if (nvlist_add_uint64(nv, ZPOOL_ERR_DATASET,
2519 zb[i].zb_objset) != 0) {
2523 if (nvlist_add_uint64(nv, ZPOOL_ERR_OBJECT,
2524 zb[i].zb_object) != 0) {
2528 if (nvlist_add_nvlist(*nverrlistp, "ejk", nv) != 0) {
2535 free((void *)(uintptr_t)zc.zc_nvlist_dst);
2539 free((void *)(uintptr_t)zc.zc_nvlist_dst);
2540 return (no_memory(zhp->zpool_hdl));
2544 * Upgrade a ZFS pool to the latest on-disk version.
2547 zpool_upgrade(zpool_handle_t *zhp, uint64_t new_version)
2549 zfs_cmd_t zc = { 0 };
2550 libzfs_handle_t *hdl = zhp->zpool_hdl;
2552 (void) strcpy(zc.zc_name, zhp->zpool_name);
2553 zc.zc_cookie = new_version;
2555 if (zfs_ioctl(hdl, ZFS_IOC_POOL_UPGRADE, &zc) != 0)
2556 return (zpool_standard_error_fmt(hdl, errno,
2557 dgettext(TEXT_DOMAIN, "cannot upgrade '%s'"),
2563 zpool_set_history_str(const char *subcommand, int argc, char **argv,
2568 (void) strlcpy(history_str, subcommand, HIS_MAX_RECORD_LEN);
2569 for (i = 1; i < argc; i++) {
2570 if (strlen(history_str) + 1 + strlen(argv[i]) >
2573 (void) strlcat(history_str, " ", HIS_MAX_RECORD_LEN);
2574 (void) strlcat(history_str, argv[i], HIS_MAX_RECORD_LEN);
2579 * Stage command history for logging.
2582 zpool_stage_history(libzfs_handle_t *hdl, const char *history_str)
2584 if (history_str == NULL)
2587 if (strlen(history_str) > HIS_MAX_RECORD_LEN)
2590 if (hdl->libzfs_log_str != NULL)
2591 free(hdl->libzfs_log_str);
2593 if ((hdl->libzfs_log_str = strdup(history_str)) == NULL)
2594 return (no_memory(hdl));
2600 * Perform ioctl to get some command history of a pool.
2602 * 'buf' is the buffer to fill up to 'len' bytes. 'off' is the
2603 * logical offset of the history buffer to start reading from.
2605 * Upon return, 'off' is the next logical offset to read from and
2606 * 'len' is the actual amount of bytes read into 'buf'.
2609 get_history(zpool_handle_t *zhp, char *buf, uint64_t *off, uint64_t *len)
2611 zfs_cmd_t zc = { 0 };
2612 libzfs_handle_t *hdl = zhp->zpool_hdl;
2614 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
2616 zc.zc_history = (uint64_t)(uintptr_t)buf;
2617 zc.zc_history_len = *len;
2618 zc.zc_history_offset = *off;
2620 if (ioctl(hdl->libzfs_fd, ZFS_IOC_POOL_GET_HISTORY, &zc) != 0) {
2623 return (zfs_error_fmt(hdl, EZFS_PERM,
2624 dgettext(TEXT_DOMAIN,
2625 "cannot show history for pool '%s'"),
2628 return (zfs_error_fmt(hdl, EZFS_NOHISTORY,
2629 dgettext(TEXT_DOMAIN, "cannot get history for pool "
2630 "'%s'"), zhp->zpool_name));
2632 return (zfs_error_fmt(hdl, EZFS_BADVERSION,
2633 dgettext(TEXT_DOMAIN, "cannot get history for pool "
2634 "'%s', pool must be upgraded"), zhp->zpool_name));
2636 return (zpool_standard_error_fmt(hdl, errno,
2637 dgettext(TEXT_DOMAIN,
2638 "cannot get history for '%s'"), zhp->zpool_name));
2642 *len = zc.zc_history_len;
2643 *off = zc.zc_history_offset;
2649 * Process the buffer of nvlists, unpacking and storing each nvlist record
2650 * into 'records'. 'leftover' is set to the number of bytes that weren't
2651 * processed as there wasn't a complete record.
2654 zpool_history_unpack(char *buf, uint64_t bytes_read, uint64_t *leftover,
2655 nvlist_t ***records, uint_t *numrecords)
2661 while (bytes_read > sizeof (reclen)) {
2663 /* get length of packed record (stored as little endian) */
2664 for (i = 0, reclen = 0; i < sizeof (reclen); i++)
2665 reclen += (uint64_t)(((uchar_t *)buf)[i]) << (8*i);
2667 if (bytes_read < sizeof (reclen) + reclen)
2671 if (nvlist_unpack(buf + sizeof (reclen), reclen, &nv, 0) != 0)
2673 bytes_read -= sizeof (reclen) + reclen;
2674 buf += sizeof (reclen) + reclen;
2676 /* add record to nvlist array */
2678 if (ISP2(*numrecords + 1)) {
2679 *records = realloc(*records,
2680 *numrecords * 2 * sizeof (nvlist_t *));
2682 (*records)[*numrecords - 1] = nv;
2685 *leftover = bytes_read;
2689 #define HIS_BUF_LEN (128*1024)
2692 * Retrieve the command history of a pool.
2695 zpool_get_history(zpool_handle_t *zhp, nvlist_t **nvhisp)
2697 char buf[HIS_BUF_LEN];
2699 nvlist_t **records = NULL;
2700 uint_t numrecords = 0;
2704 uint64_t bytes_read = sizeof (buf);
2707 if ((err = get_history(zhp, buf, &off, &bytes_read)) != 0)
2710 /* if nothing else was read in, we're at EOF, just return */
2714 if ((err = zpool_history_unpack(buf, bytes_read,
2715 &leftover, &records, &numrecords)) != 0)
2723 verify(nvlist_alloc(nvhisp, NV_UNIQUE_NAME, 0) == 0);
2724 verify(nvlist_add_nvlist_array(*nvhisp, ZPOOL_HIST_RECORD,
2725 records, numrecords) == 0);
2727 for (i = 0; i < numrecords; i++)
2728 nvlist_free(records[i]);
2735 zpool_obj_to_path(zpool_handle_t *zhp, uint64_t dsobj, uint64_t obj,
2736 char *pathname, size_t len)
2738 zfs_cmd_t zc = { 0 };
2739 boolean_t mounted = B_FALSE;
2740 char *mntpnt = NULL;
2741 char dsname[MAXNAMELEN];
2744 /* special case for the MOS */
2745 (void) snprintf(pathname, len, "<metadata>:<0x%llx>", obj);
2749 /* get the dataset's name */
2750 (void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
2752 if (ioctl(zhp->zpool_hdl->libzfs_fd,
2753 ZFS_IOC_DSOBJ_TO_DSNAME, &zc) != 0) {
2754 /* just write out a path of two object numbers */
2755 (void) snprintf(pathname, len, "<0x%llx>:<0x%llx>",
2759 (void) strlcpy(dsname, zc.zc_value, sizeof (dsname));
2761 /* find out if the dataset is mounted */
2762 mounted = is_mounted(zhp->zpool_hdl, dsname, &mntpnt);
2764 /* get the corrupted object's path */
2765 (void) strlcpy(zc.zc_name, dsname, sizeof (zc.zc_name));
2767 if (ioctl(zhp->zpool_hdl->libzfs_fd, ZFS_IOC_OBJ_TO_PATH,
2770 (void) snprintf(pathname, len, "%s%s", mntpnt,
2773 (void) snprintf(pathname, len, "%s:%s",
2774 dsname, zc.zc_value);
2777 (void) snprintf(pathname, len, "%s:<0x%llx>", dsname, obj);
2782 #define RDISK_ROOT "/dev/rdsk"
2783 #define BACKUP_SLICE "s2"
2785 * Don't start the slice at the default block of 34; many storage
2786 * devices will use a stripe width of 128k, so start there instead.
2788 #define NEW_START_BLOCK 256
2791 * Read the EFI label from the config, if a label does not exist then
2792 * pass back the error to the caller. If the caller has passed a non-NULL
2793 * diskaddr argument then we set it to the starting address of the EFI
2797 read_efi_label(nvlist_t *config, diskaddr_t *sb)
2801 char diskname[MAXPATHLEN];
2804 if (nvlist_lookup_string(config, ZPOOL_CONFIG_PATH, &path) != 0)
2807 (void) snprintf(diskname, sizeof (diskname), "%s%s", RDISK_ROOT,
2808 strrchr(path, '/'));
2809 if ((fd = open(diskname, O_RDONLY|O_NDELAY)) >= 0) {
2810 struct dk_gpt *vtoc;
2812 if ((err = efi_alloc_and_read(fd, &vtoc)) >= 0) {
2814 *sb = vtoc->efi_parts[0].p_start;
2823 * determine where a partition starts on a disk in the current
2827 find_start_block(nvlist_t *config)
2831 diskaddr_t sb = MAXOFFSET_T;
2834 if (nvlist_lookup_nvlist_array(config,
2835 ZPOOL_CONFIG_CHILDREN, &child, &children) != 0) {
2836 if (nvlist_lookup_uint64(config,
2837 ZPOOL_CONFIG_WHOLE_DISK,
2838 &wholedisk) != 0 || !wholedisk) {
2839 return (MAXOFFSET_T);
2841 if (read_efi_label(config, &sb) < 0)
2846 for (c = 0; c < children; c++) {
2847 sb = find_start_block(child[c]);
2848 if (sb != MAXOFFSET_T) {
2852 return (MAXOFFSET_T);
2856 * Label an individual disk. The name provided is the short name,
2857 * stripped of any leading /dev path.
2860 zpool_label_disk(libzfs_handle_t *hdl, zpool_handle_t *zhp, char *name)
2862 char path[MAXPATHLEN];
2863 struct dk_gpt *vtoc;
2865 size_t resv = EFI_MIN_RESV_SIZE;
2866 uint64_t slice_size;
2867 diskaddr_t start_block;
2870 /* prepare an error message just in case */
2871 (void) snprintf(errbuf, sizeof (errbuf),
2872 dgettext(TEXT_DOMAIN, "cannot label '%s'"), name);
2877 if (pool_is_bootable(zhp)) {
2878 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2879 "EFI labeled devices are not supported on root "
2881 return (zfs_error(hdl, EZFS_POOL_NOTSUP, errbuf));
2884 verify(nvlist_lookup_nvlist(zhp->zpool_config,
2885 ZPOOL_CONFIG_VDEV_TREE, &nvroot) == 0);
2887 if (zhp->zpool_start_block == 0)
2888 start_block = find_start_block(nvroot);
2890 start_block = zhp->zpool_start_block;
2891 zhp->zpool_start_block = start_block;
2894 start_block = NEW_START_BLOCK;
2897 (void) snprintf(path, sizeof (path), "%s/%s%s", RDISK_ROOT, name,
2900 if ((fd = open(path, O_RDWR | O_NDELAY)) < 0) {
2902 * This shouldn't happen. We've long since verified that this
2903 * is a valid device.
2906 dgettext(TEXT_DOMAIN, "unable to open device"));
2907 return (zfs_error(hdl, EZFS_OPENFAILED, errbuf));
2910 if (efi_alloc_and_init(fd, EFI_NUMPAR, &vtoc) != 0) {
2912 * The only way this can fail is if we run out of memory, or we
2913 * were unable to read the disk's capacity
2915 if (errno == ENOMEM)
2916 (void) no_memory(hdl);
2919 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2920 "unable to read disk capacity"), name);
2922 return (zfs_error(hdl, EZFS_NOCAP, errbuf));
2925 slice_size = vtoc->efi_last_u_lba + 1;
2926 slice_size -= EFI_MIN_RESV_SIZE;
2927 if (start_block == MAXOFFSET_T)
2928 start_block = NEW_START_BLOCK;
2929 slice_size -= start_block;
2931 vtoc->efi_parts[0].p_start = start_block;
2932 vtoc->efi_parts[0].p_size = slice_size;
2935 * Why we use V_USR: V_BACKUP confuses users, and is considered
2936 * disposable by some EFI utilities (since EFI doesn't have a backup
2937 * slice). V_UNASSIGNED is supposed to be used only for zero size
2938 * partitions, and efi_write() will fail if we use it. V_ROOT, V_BOOT,
2939 * etc. were all pretty specific. V_USR is as close to reality as we
2940 * can get, in the absence of V_OTHER.
2942 vtoc->efi_parts[0].p_tag = V_USR;
2943 (void) strcpy(vtoc->efi_parts[0].p_name, "zfs");
2945 vtoc->efi_parts[8].p_start = slice_size + start_block;
2946 vtoc->efi_parts[8].p_size = resv;
2947 vtoc->efi_parts[8].p_tag = V_RESERVED;
2949 if (efi_write(fd, vtoc) != 0) {
2951 * Some block drivers (like pcata) may not support EFI
2952 * GPT labels. Print out a helpful error message dir-
2953 * ecting the user to manually label the disk and give
2959 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2960 "try using fdisk(1M) and then provide a specific slice"));
2961 return (zfs_error(hdl, EZFS_LABELFAILED, errbuf));
2970 supported_dump_vdev_type(libzfs_handle_t *hdl, nvlist_t *config, char *errbuf)
2976 verify(nvlist_lookup_string(config, ZPOOL_CONFIG_TYPE, &type) == 0);
2977 if (strcmp(type, VDEV_TYPE_RAIDZ) == 0 ||
2978 strcmp(type, VDEV_TYPE_FILE) == 0 ||
2979 strcmp(type, VDEV_TYPE_LOG) == 0 ||
2980 strcmp(type, VDEV_TYPE_MISSING) == 0) {
2981 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2982 "vdev type '%s' is not supported"), type);
2983 (void) zfs_error(hdl, EZFS_VDEVNOTSUP, errbuf);
2986 if (nvlist_lookup_nvlist_array(config, ZPOOL_CONFIG_CHILDREN,
2987 &child, &children) == 0) {
2988 for (c = 0; c < children; c++) {
2989 if (!supported_dump_vdev_type(hdl, child[c], errbuf))
2997 * check if this zvol is allowable for use as a dump device; zero if
2998 * it is, > 0 if it isn't, < 0 if it isn't a zvol
3001 zvol_check_dump_config(char *arg)
3003 zpool_handle_t *zhp = NULL;
3004 nvlist_t *config, *nvroot;
3008 libzfs_handle_t *hdl;
3010 char poolname[ZPOOL_MAXNAMELEN];
3011 int pathlen = strlen(ZVOL_FULL_DEV_DIR);
3014 if (strncmp(arg, ZVOL_FULL_DEV_DIR, pathlen)) {
3018 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3019 "dump is not supported on device '%s'"), arg);
3021 if ((hdl = libzfs_init()) == NULL)
3023 libzfs_print_on_error(hdl, B_TRUE);
3025 volname = arg + pathlen;
3027 /* check the configuration of the pool */
3028 if ((p = strchr(volname, '/')) == NULL) {
3029 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3030 "malformed dataset name"));
3031 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
3033 } else if (p - volname >= ZFS_MAXNAMELEN) {
3034 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3035 "dataset name is too long"));
3036 (void) zfs_error(hdl, EZFS_NAMETOOLONG, errbuf);
3039 (void) strncpy(poolname, volname, p - volname);
3040 poolname[p - volname] = '\0';
3043 if ((zhp = zpool_open(hdl, poolname)) == NULL) {
3044 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3045 "could not open pool '%s'"), poolname);
3046 (void) zfs_error(hdl, EZFS_OPENFAILED, errbuf);
3049 config = zpool_get_config(zhp, NULL);
3050 if (nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
3052 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3053 "could not obtain vdev configuration for '%s'"), poolname);
3054 (void) zfs_error(hdl, EZFS_INVALCONFIG, errbuf);
3058 verify(nvlist_lookup_nvlist_array(nvroot, ZPOOL_CONFIG_CHILDREN,
3059 &top, &toplevels) == 0);
3060 if (toplevels != 1) {
3061 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3062 "'%s' has multiple top level vdevs"), poolname);
3063 (void) zfs_error(hdl, EZFS_DEVOVERFLOW, errbuf);
3067 if (!supported_dump_vdev_type(hdl, top[0], errbuf)) {