libzfs/common/libzfs_pool.c

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#pragma ident	"%Z%%M%	%I%	%E% SMI"

#include <assert.h>
#include <ctype.h>
#include <errno.h>
#include <devid.h>
#include <fcntl.h>
#include <libintl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <sys/zfs_ioctl.h>
#include <sys/zio.h>

#include "zfs_namecheck.h"
#include "libzfs_impl.h"

/*
 * Validate the given pool name, optionally putting an extended error message in
 * 'buf'.
 */
static int
zpool_name_valid(const char *pool, boolean_t isopen, char *buf, size_t buflen)
{
	namecheck_err_t why;
	char what;
	int ret;

	ret = pool_namecheck(pool, &why, &what);

	/*
	 * The rules for reserved pool names were extended at a later point.
	 * But we need to support users with existing pools that may now be
	 * invalid.  So we only check for this expanded set of names during a
	 * create (or import), and only in userland.
	 */
	if (ret == 0 && !isopen &&
	    (strncmp(pool, "mirror", 6) == 0 ||
	    strncmp(pool, "raidz", 5) == 0 ||
	    strncmp(pool, "spare", 5) == 0)) {
		ret = -1;
		why = NAME_ERR_RESERVED;
	}


	if (ret != 0) {
		if (buf != NULL) {
			switch (why) {
			case NAME_ERR_TOOLONG:
				(void) snprintf(buf, buflen,
				    dgettext(TEXT_DOMAIN, "name is too long"));
				break;

			case NAME_ERR_INVALCHAR:
				(void) snprintf(buf, buflen,
				    dgettext(TEXT_DOMAIN, "invalid character "
				    "'%c' in pool name"), what);
				break;

			case NAME_ERR_NOLETTER:
				(void) strlcpy(buf, dgettext(TEXT_DOMAIN,
				    "name must begin with a letter"), buflen);
				break;

			case NAME_ERR_RESERVED:
				(void) strlcpy(buf, dgettext(TEXT_DOMAIN,
				    "name is reserved\n"
				    "pool name may have been omitted"), buflen);
				break;

			case NAME_ERR_DISKLIKE:
				(void) strlcpy(buf, dgettext(TEXT_DOMAIN,
				    "pool name is reserved\n"
				    "pool name may have been omitted"), buflen);
				break;
			}
		}
		return (FALSE);
	}

	return (TRUE);
}

/*
 * Set the pool-wide health based on the vdev state of the root vdev.
 */
void
set_pool_health(nvlist_t *config)
{
	nvlist_t *nvroot;
	vdev_stat_t *vs;
	uint_t vsc;
	char *health;

	verify(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
	    &nvroot) == 0);
	verify(nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_STATS,
	    (uint64_t **)&vs, &vsc) == 0);

	switch (vs->vs_state) {

	case VDEV_STATE_CLOSED:
	case VDEV_STATE_CANT_OPEN:
	case VDEV_STATE_OFFLINE:
		health = dgettext(TEXT_DOMAIN, "FAULTED");
		break;

	case VDEV_STATE_DEGRADED:
		health = dgettext(TEXT_DOMAIN, "DEGRADED");
		break;

	case VDEV_STATE_HEALTHY:
		health = dgettext(TEXT_DOMAIN, "ONLINE");
		break;

	default:
		zfs_baderror(vs->vs_state);
	}

	verify(nvlist_add_string(config, ZPOOL_CONFIG_POOL_HEALTH,
	    health) == 0);
}

/*
 * Open a handle to the given pool, even if the pool is currently in the FAULTED
 * state.
 */
zpool_handle_t *
zpool_open_canfail(const char *pool)
{
	zpool_handle_t *zhp;
	int error;

	/*
	 * Make sure the pool name is valid.
	 */
	if (!zpool_name_valid(pool, B_TRUE, NULL, 0)) {
		zfs_error(dgettext(TEXT_DOMAIN, "cannot open '%s': invalid "
		    "pool name"), pool);
		return (NULL);
	}

	zhp = zfs_malloc(sizeof (zpool_handle_t));

	(void) strlcpy(zhp->zpool_name, pool, sizeof (zhp->zpool_name));

	if ((error = zpool_refresh_stats(zhp)) != 0) {
		if (error == ENOENT || error == EINVAL) {
			zfs_error(dgettext(TEXT_DOMAIN, "cannot open '%s': no "
			    "such pool"), pool);
			free(zhp);
			return (NULL);
		} else {
			zhp->zpool_state = POOL_STATE_UNAVAIL;
		}
	} else {
		zhp->zpool_state = POOL_STATE_ACTIVE;
	}

	return (zhp);
}

/*
 * Like the above, but silent on error.  Used when iterating over pools (because
 * the configuration cache may be out of date).
 */
zpool_handle_t *
zpool_open_silent(const char *pool)
{
	zpool_handle_t *zhp;
	int error;

	zhp = zfs_malloc(sizeof (zpool_handle_t));

	(void) strlcpy(zhp->zpool_name, pool, sizeof (zhp->zpool_name));

	if ((error = zpool_refresh_stats(zhp)) != 0) {
		if (error == ENOENT || error == EINVAL) {
			free(zhp);
			return (NULL);
		} else {
			zhp->zpool_state = POOL_STATE_UNAVAIL;
		}
	} else {
		zhp->zpool_state = POOL_STATE_ACTIVE;
	}

	return (zhp);
}

/*
 * Similar to zpool_open_canfail(), but refuses to open pools in the faulted
 * state.
 */
zpool_handle_t *
zpool_open(const char *pool)
{
	zpool_handle_t *zhp;

	if ((zhp = zpool_open_canfail(pool)) == NULL)
		return (NULL);

	if (zhp->zpool_state == POOL_STATE_UNAVAIL) {
		zfs_error(dgettext(TEXT_DOMAIN, "cannot open '%s': pool is "
		    "currently unavailable"), zhp->zpool_name);
		zfs_error(dgettext(TEXT_DOMAIN, "run 'zpool status %s' for "
		    "detailed information"), zhp->zpool_name);
		zpool_close(zhp);
		return (NULL);
	}

	return (zhp);
}

/*
 * Close the handle.  Simply frees the memory associated with the handle.
 */
void
zpool_close(zpool_handle_t *zhp)
{
	if (zhp->zpool_config)
		nvlist_free(zhp->zpool_config);
	if (zhp->zpool_old_config)
		nvlist_free(zhp->zpool_old_config);
	if (zhp->zpool_error_log) {
		int i;
		for (i = 0; i < zhp->zpool_error_count; i++)
			free(zhp->zpool_error_log[i]);
		free(zhp->zpool_error_log);
	}
	free(zhp);
}

/*
 * Return the name of the pool.
 */
const char *
zpool_get_name(zpool_handle_t *zhp)
{
	return (zhp->zpool_name);
}

/*
 * Return the GUID of the pool.
 */
uint64_t
zpool_get_guid(zpool_handle_t *zhp)
{
	uint64_t guid;

	verify(nvlist_lookup_uint64(zhp->zpool_config, ZPOOL_CONFIG_POOL_GUID,
	    &guid) == 0);
	return (guid);
}

/*
 * Return the amount of space currently consumed by the pool.
 */
uint64_t
zpool_get_space_used(zpool_handle_t *zhp)
{
	nvlist_t *nvroot;
	vdev_stat_t *vs;
	uint_t vsc;

	verify(nvlist_lookup_nvlist(zhp->zpool_config, ZPOOL_CONFIG_VDEV_TREE,
	    &nvroot) == 0);
	verify(nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_STATS,
	    (uint64_t **)&vs, &vsc) == 0);

	return (vs->vs_alloc);
}

/*
 * Return the total space in the pool.
 */
uint64_t
zpool_get_space_total(zpool_handle_t *zhp)
{
	nvlist_t *nvroot;
	vdev_stat_t *vs;
	uint_t vsc;

	verify(nvlist_lookup_nvlist(zhp->zpool_config, ZPOOL_CONFIG_VDEV_TREE,
	    &nvroot) == 0);
	verify(nvlist_lookup_uint64_array(nvroot, ZPOOL_CONFIG_STATS,
	    (uint64_t **)&vs, &vsc) == 0);

	return (vs->vs_space);
}

/*
 * Return the alternate root for this pool, if any.
 */
int
zpool_get_root(zpool_handle_t *zhp, char *buf, size_t buflen)
{
	zfs_cmd_t zc = { 0 };

	(void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
	if (zfs_ioctl(ZFS_IOC_OBJSET_STATS, &zc) != 0 ||
	    zc.zc_root[0] == '\0')
		return (-1);

	(void) strlcpy(buf, zc.zc_root, buflen);

	return (0);
}

/*
 * Return the state of the pool (ACTIVE or UNAVAILABLE)
 */
int
zpool_get_state(zpool_handle_t *zhp)
{
	return (zhp->zpool_state);
}

/*
 * Create the named pool, using the provided vdev list.  It is assumed
 * that the consumer has already validated the contents of the nvlist, so we
 * don't have to worry about error semantics.
 */
int
zpool_create(const char *pool, nvlist_t *nvroot, const char *altroot)
{
	zfs_cmd_t zc = { 0 };
	char *packed;
	size_t len;
	int err;
	char reason[64];

	if (!zpool_name_valid(pool, B_FALSE, reason, sizeof (reason))) {
		zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': %s"),
		    pool, reason);
		return (-1);
	}

	if (altroot != NULL && altroot[0] != '/') {
		zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': alternate "
		    "root '%s' must be a complete path"), pool, altroot);
		return (-1);
	}

	if ((err = nvlist_size(nvroot, &len, NV_ENCODE_NATIVE)) != 0)
		zfs_baderror(err);

	packed = zfs_malloc(len);

	if ((err = nvlist_pack(nvroot, &packed, &len,
	    NV_ENCODE_NATIVE, 0)) != 0)
		zfs_baderror(err);

	(void) strlcpy(zc.zc_name, pool, sizeof (zc.zc_name));
	zc.zc_config_src = (uint64_t)(uintptr_t)packed;
	zc.zc_config_src_size = len;

	if (altroot != NULL)
		(void) strlcpy(zc.zc_root, altroot, sizeof (zc.zc_root));

	if (zfs_ioctl(ZFS_IOC_POOL_CREATE, &zc) != 0) {
		switch (errno) {
		case EEXIST:
			zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': "
			    "pool exists"), pool);
			break;

		case EPERM:
			zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': "
			    "permission denied"), pool);
			break;

		case EBUSY:
			/*
			 * This can happen if the user has specified the same
			 * device multiple times.  We can't reliably detect this
			 * until we try to add it and see we already have a
			 * label.
			 */
			zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': "
			    "one or more vdevs refer to the same device"),
			    pool);
			break;

		case EOVERFLOW:
			/*
			 * This occurrs when one of the devices is below
			 * SPA_MINDEVSIZE.  Unfortunately, we can't detect which
			 * device was the problem device since there's no
			 * reliable way to determine device size from userland.
			 */
			{
				char buf[64];

				zfs_nicenum(SPA_MINDEVSIZE, buf, sizeof (buf));

				zfs_error(dgettext(TEXT_DOMAIN, "cannot "
				    "create '%s': one or more devices is less "
				    "than the minimum size (%s)"), pool,
				    buf);
			}
			break;

		case ENAMETOOLONG:
			/*
			 * One of the vdevs has exceeded VDEV_SPEC_MAX length in
			 * its plaintext representation.
			 */
			zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': "
			    "too many devices in a single vdev"), pool);
			break;

		case EIO:
			zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': "
			    "I/O error on one or more devices"), pool);
			break;

		case ENXIO:
			/*
			 * This is unlikely to happen since we've verified that
			 * all the devices can be opened from userland, but it's
			 * still possible in some circumstances.
			 */
			zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': "
			    "one or more devices is unavailable"), pool);
			break;

		case ENOSPC:
			/*
			 * This can occur if we were incapable of writing to a
			 * file vdev because the underlying filesystem is out of
			 * space.  This is very similar to EOVERFLOW, but we'll
			 * produce a slightly different message.
			 */
			zfs_error(dgettext(TEXT_DOMAIN, "cannot create '%s': "
			    "one or more devices is out of space"), pool);
			break;

		default:
			zfs_baderror(errno);
		}

		return (-1);
	}

	free(packed);

	/*
	 * If this is an alternate root pool, then we automatically set the
	 * moutnpoint of the root dataset to be '/'.
	 */
	if (altroot != NULL) {
		zfs_handle_t *zhp;

		verify((zhp = zfs_open(pool, ZFS_TYPE_ANY)) != NULL);
		verify(zfs_prop_set(zhp, ZFS_PROP_MOUNTPOINT, "/") == 0);

		zfs_close(zhp);
	}

	return (0);
}

/*
 * Destroy the given pool.  It is up to the caller to ensure that there are no
 * datasets left in the pool.
 */
int
zpool_destroy(zpool_handle_t *zhp)
{
	zfs_cmd_t zc = { 0 };
	zfs_handle_t *zfp = NULL;

	if (zhp->zpool_state == POOL_STATE_ACTIVE &&
	    (zfp = zfs_open(zhp->zpool_name, ZFS_TYPE_FILESYSTEM)) == NULL)
		return (-1);

	if (zpool_remove_zvol_links(zhp) != NULL)
		return (-1);

	(void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));

	if (zfs_ioctl(ZFS_IOC_POOL_DESTROY, &zc) != 0) {
		switch (errno) {
		case EPERM:
			zfs_error(dgettext(TEXT_DOMAIN,
			    "cannot destroy '%s': permission denied"),
			    zhp->zpool_name);
			break;

		case EBUSY:
			zfs_error(dgettext(TEXT_DOMAIN,
			    "cannot destroy '%s': pool busy"),
			    zhp->zpool_name);
			break;

		case ENOENT:
			zfs_error(dgettext(TEXT_DOMAIN,
			    "cannot destroy '%s': no such pool"),
			    zhp->zpool_name);
			break;

		case EROFS:
			zfs_error(dgettext(TEXT_DOMAIN,
			    "cannot destroy '%s': one or more devices is "
			    "read only, or '/' is mounted read only"),
			    zhp->zpool_name);
			break;

		default:
			zfs_baderror(errno);
		}

		if (zfp)
			zfs_close(zfp);
		return (-1);
	}

	if (zfp) {
		remove_mountpoint(zfp);
		zfs_close(zfp);
	}

	return (0);
}

/*
 * Add the given vdevs to the pool.  The caller must have already performed the
 * necessary verification to ensure that the vdev specification is well-formed.
 */
int
zpool_add(zpool_handle_t *zhp, nvlist_t *nvroot)
{
	char *packed;
	size_t len;
	zfs_cmd_t zc;

	verify(nvlist_size(nvroot, &len, NV_ENCODE_NATIVE) == 0);

	packed = zfs_malloc(len);

	verify(nvlist_pack(nvroot, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);

	(void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
	zc.zc_config_src = (uint64_t)(uintptr_t)packed;
	zc.zc_config_src_size = len;

	if (zfs_ioctl(ZFS_IOC_VDEV_ADD, &zc) != 0) {
		switch (errno) {
		case EPERM:
			zfs_error(dgettext(TEXT_DOMAIN, "cannot add to '%s': "
			    "permission denied"), zhp->zpool_name);
			break;

		case EBUSY:
			/*
			 * This can happen if the user has specified the same
			 * device multiple times.  We can't reliably detect this
			 * until we try to add it and see we already have a
			 * label.
			 */
			zfs_error(dgettext(TEXT_DOMAIN, "cannot add to '%s': "
			    "one or more vdevs refer to the same device"),
			    zhp->zpool_name);
			break;

		case ENAMETOOLONG:
			/*
			 * One of the vdevs has exceeded VDEV_SPEC_MAX length in
			 * its plaintext representation.
			 */
			zfs_error(dgettext(TEXT_DOMAIN, "cannot add to '%s': "
			    "too many devices in a single vdev"),
			    zhp->zpool_name);
			break;

		case ENXIO:
			/*
			 * This is unlikely to happen since we've verified that
			 * all the devices can be opened from userland, but it's
			 * still possible in some circumstances.
			 */
			zfs_error(dgettext(TEXT_DOMAIN, "cannot add to '%s': "
			    "one or more devices is unavailable"),
			    zhp->zpool_name);
			break;

		case EOVERFLOW:
			/*
			 * This occurrs when one of the devices is below
			 * SPA_MINDEVSIZE.  Unfortunately, we can't detect which
			 * device was the problem device since there's no
			 * reliable way to determine device size from userland.
			 */
			{
				char buf[64];

				zfs_nicenum(SPA_MINDEVSIZE, buf, sizeof (buf));

				zfs_error(dgettext(TEXT_DOMAIN, "cannot "
				    "add to '%s': one or more devices is less "
				    "than the minimum size (%s)"),
				    zhp->zpool_name, buf);
			}
			break;

		default:
			zfs_baderror(errno);
		}

		return (-1);
	}

	free(packed);

	return (0);
}

/*
 * Exports the pool from the system.  The caller must ensure that there are no
 * mounted datasets in the pool.
 */
int
zpool_export(zpool_handle_t *zhp)
{
	zfs_cmd_t zc = { 0 };

	if (zpool_remove_zvol_links(zhp) != 0)
		return (-1);

	(void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));

	if (zfs_ioctl(ZFS_IOC_POOL_EXPORT, &zc) != 0) {
		switch (errno) {
		case EPERM:
			zfs_error(dgettext(TEXT_DOMAIN,
			    "cannot export '%s': permission denied"),
			    zhp->zpool_name);
			break;

		case EBUSY:
			zfs_error(dgettext(TEXT_DOMAIN,
			    "cannot export '%s': pool is in use"),
			    zhp->zpool_name);
			break;

		case ENOENT:
			zfs_error(dgettext(TEXT_DOMAIN,
			    "cannot export '%s': no such pool"),
			    zhp->zpool_name);
			break;

		default:
			zfs_baderror(errno);
		}

		return (-1);
	}

	return (0);
}

/*
 * Import the given pool using the known configuration.  The configuration
 * should have come from zpool_find_import().  The 'newname' and 'altroot'
 * parameters control whether the pool is imported with a different name or with
 * an alternate root, respectively.
 */
int
zpool_import(nvlist_t *config, const char *newname, const char *altroot)
{
	zfs_cmd_t zc;
	char *packed;
	size_t len;
	char *thename;
	char *origname;
	int ret;

	verify(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
	    &origname) == 0);

	if (newname != NULL) {
		if (!zpool_name_valid(newname, B_FALSE, NULL, 0)) {
			zfs_error(dgettext(TEXT_DOMAIN, "cannot import '%s': "
			    "invalid pool name"), newname);
			return (-1);
		}
		thename = (char *)newname;
	} else {
		thename = origname;
	}

	if (altroot != NULL && altroot[0] != '/') {
		zfs_error(dgettext(TEXT_DOMAIN, "cannot import '%s': alternate "
		    "root '%s' must be a complete path"), thename,
		    altroot);
		return (-1);
	}

	(void) strlcpy(zc.zc_name, thename, sizeof (zc.zc_name));

	if (altroot != NULL)
		(void) strlcpy(zc.zc_root, altroot, sizeof (zc.zc_root));
	else
		zc.zc_root[0] = '\0';

	verify(nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
	    &zc.zc_guid) == 0);

	verify(nvlist_size(config, &len, NV_ENCODE_NATIVE) == 0);

	packed = zfs_malloc(len);

	verify(nvlist_pack(config, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);

	zc.zc_config_src = (uint64_t)(uintptr_t)packed;
	zc.zc_config_src_size = len;

	ret = 0;
	if (zfs_ioctl(ZFS_IOC_POOL_IMPORT, &zc) != 0) {
		char desc[1024];
		if (newname == NULL)
			(void) snprintf(desc, sizeof (desc),
			    dgettext(TEXT_DOMAIN, "cannot import '%s'"),
			    thename);
		else
			(void) snprintf(desc, sizeof (desc),
			    dgettext(TEXT_DOMAIN, "cannot import '%s' as '%s'"),
			    origname, thename);

		switch (errno) {
		case EEXIST:
			/*
			 * A pool with that name already exists.
			 */
			zfs_error(dgettext(TEXT_DOMAIN, "%s: pool exists"),
			    desc);
			break;

		case EPERM:
			/*
			 * The user doesn't have permission to create pools.
			 */
			zfs_error(dgettext(TEXT_DOMAIN, "%s: permission "
			    "denied"), desc);
			break;

		case ENXIO:
		case EDOM:
			/*
			 * Device is unavailable, or vdev sum didn't match.
			 */
			zfs_error(dgettext(TEXT_DOMAIN, "%s: one or more "
			    "devices is unavailable"),
			    desc);
			break;

		case ENOTSUP:
			/*
			 * Unsupported version.
			 */
			zfs_error(dgettext(TEXT_DOMAIN,
			    "%s: unsupported version"), desc);
			break;

		default:
			zfs_baderror(errno);
		}

		ret = -1;
	} else {
		zpool_handle_t *zhp;
		/*
		 * This should never fail, but play it safe anyway.
		 */
		if ((zhp = zpool_open_silent(thename)) != NULL) {
			ret = zpool_create_zvol_links(zhp);
			zpool_close(zhp);
		}
	}

	free(packed);
	return (ret);
}

/*
 * Scrub the pool.
 */
int
zpool_scrub(zpool_handle_t *zhp, pool_scrub_type_t type)
{
	zfs_cmd_t zc = { 0 };
	char msg[1024];

	(void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
	zc.zc_cookie = type;

	if (zfs_ioctl(ZFS_IOC_POOL_SCRUB, &zc) == 0)
		return (0);

	(void) snprintf(msg, sizeof (msg),
	    dgettext(TEXT_DOMAIN, "cannot scrub %s"), zc.zc_name);

	switch (errno) {
	    case EPERM:
		/*
		 * No permission to scrub this pool.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: permission denied"), msg);
		break;

	    case EBUSY:
		/*
		 * Resilver in progress.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: currently resilvering"),
		    msg);
		break;

	    default:
		zfs_baderror(errno);
	}
	return (-1);
}

static uint64_t
vdev_to_guid(nvlist_t *nv, const char *search, uint64_t guid)
{
	uint_t c, children;
	nvlist_t **child;
	uint64_t ret, present;
	char *path;
	uint64_t wholedisk = 0;

	verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID, &ret) == 0);

	if (search == NULL &&
	    nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NOT_PRESENT, &present) == 0) {
		/*
		 * If the device has never been present since import, the only
		 * reliable way to match the vdev is by GUID.
		 */
		if (ret == guid)
			return (ret);
	} else if (search != NULL &&
	    nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0) {
		(void) nvlist_lookup_uint64(nv, ZPOOL_CONFIG_WHOLE_DISK,
		    &wholedisk);
		if (wholedisk) {
			/*
			 * For whole disks, the internal path has 's0', but the
			 * path passed in by the user doesn't.
			 */
			if (strlen(search) == strlen(path) - 2 &&
			    strncmp(search, path, strlen(search)) == 0)
				return (ret);
		} else if (strcmp(search, path) == 0) {
			return (ret);
		}
	}

	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
	    &child, &children) != 0)
		return (0);

	for (c = 0; c < children; c++)
		if ((ret = vdev_to_guid(child[c], search, guid)) != 0)
			return (ret);

	return (0);
}

/*
 * Given a string describing a vdev, returns the matching GUID, or 0 if none.
 */
uint64_t
zpool_vdev_to_guid(zpool_handle_t *zhp, const char *path)
{
	char buf[MAXPATHLEN];
	const char *search;
	char *end;
	nvlist_t *nvroot;
	uint64_t guid;

	guid = strtoull(path, &end, 10);
	if (guid != 0 && *end == '\0') {
		search = NULL;
	} else if (path[0] != '/') {
		(void) snprintf(buf, sizeof (buf), "%s%s", "/dev/dsk/", path);
		search = buf;
	} else {
		search = path;
	}

	verify(nvlist_lookup_nvlist(zhp->zpool_config, ZPOOL_CONFIG_VDEV_TREE,
	    &nvroot) == 0);

	return (vdev_to_guid(nvroot, search, guid));
}

/*
 * Bring the specified vdev online
 */
int
zpool_vdev_online(zpool_handle_t *zhp, const char *path)
{
	zfs_cmd_t zc = { 0 };
	char msg[1024];

	(void) snprintf(msg, sizeof (msg),
	    dgettext(TEXT_DOMAIN, "cannot online %s"), path);

	(void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
	if ((zc.zc_guid = zpool_vdev_to_guid(zhp, path)) == 0) {
		zfs_error(dgettext(TEXT_DOMAIN, "%s: no such device in pool"),
		    msg);
		return (-1);
	}

	if (zfs_ioctl(ZFS_IOC_VDEV_ONLINE, &zc) == 0)
		return (0);

	switch (errno) {
	    case ENODEV:
		/*
		 * Device doesn't exist
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: device not in pool"), msg);
		break;

	    case EPERM:
		/*
		 * No permission to bring this vdev online.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: permission denied"), msg);
		break;

	    default:
		zfs_baderror(errno);
	}
	return (-1);
}

/*
 * Take the specified vdev offline
 */
int
zpool_vdev_offline(zpool_handle_t *zhp, const char *path, int istmp)
{
	zfs_cmd_t zc = { 0 };
	char msg[1024];

	(void) snprintf(msg, sizeof (msg),
	    dgettext(TEXT_DOMAIN, "cannot offline %s"), path);

	(void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
	if ((zc.zc_guid = zpool_vdev_to_guid(zhp, path)) == 0) {
		zfs_error(dgettext(TEXT_DOMAIN, "%s: no such device in pool"),
		    msg);
		return (-1);
	}

	zc.zc_cookie = istmp;

	if (zfs_ioctl(ZFS_IOC_VDEV_OFFLINE, &zc) == 0)
		return (0);

	switch (errno) {
	    case ENODEV:
		/*
		 * Device doesn't exist
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: device not in pool"), msg);
		break;

	    case EPERM:
		/*
		 * No permission to take this vdev offline.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: permission denied"), msg);
		break;

	    case EBUSY:
		/*
		 * There are no other replicas of this device.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: no valid replicas"), msg);
		break;

	    default:
		zfs_baderror(errno);
	}
	return (-1);
}

/*
 * Attach new_disk (fully described by nvroot) to old_disk.
 * If 'replacing' is specified, tne new disk will replace the old one.
 */
int
zpool_vdev_attach(zpool_handle_t *zhp,
    const char *old_disk, const char *new_disk, nvlist_t *nvroot, int replacing)
{
	zfs_cmd_t zc = { 0 };
	char msg[1024];
	char *packed;
	int ret;
	size_t len;

	if (replacing)
		(void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
		    "cannot replace %s with %s"), old_disk, new_disk);
	else
		(void) snprintf(msg, sizeof (msg), dgettext(TEXT_DOMAIN,
		    "cannot attach %s to %s"), new_disk, old_disk);

	(void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
	if ((zc.zc_guid = zpool_vdev_to_guid(zhp, old_disk)) == 0) {
		zfs_error(dgettext(TEXT_DOMAIN, "%s: no such device in pool"),
		    msg);
		return (-1);
	}
	zc.zc_cookie = replacing;

	verify(nvlist_size(nvroot, &len, NV_ENCODE_NATIVE) == 0);

	packed = zfs_malloc(len);

	verify(nvlist_pack(nvroot, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);

	zc.zc_config_src = (uint64_t)(uintptr_t)packed;
	zc.zc_config_src_size = len;

	ret = zfs_ioctl(ZFS_IOC_VDEV_ATTACH, &zc);

	free(packed);

	if (ret == 0)
		return (0);

	switch (errno) {
	case EPERM:
		/*
		 * No permission to mess with the config.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: permission denied"), msg);
		break;

	case ENODEV:
		/*
		 * Device doesn't exist.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: %s not in pool"),
		    msg, old_disk);
		break;

	case ENOTSUP:
		/*
		 * Can't attach to or replace this type of vdev.
		 */
		if (replacing)
			zfs_error(dgettext(TEXT_DOMAIN,
			    "%s: cannot replace a replacing device"), msg);
		else
			zfs_error(dgettext(TEXT_DOMAIN,
			    "%s: attach is only applicable to mirrors"), msg);
		break;

	case EINVAL:
		/*
		 * The new device must be a single disk.
		 */
		zfs_error(dgettext(TEXT_DOMAIN,
		    "%s: <new_device> must be a single disk"), msg);
		break;

	case ENXIO:
		/*
		 * This is unlikely to happen since we've verified that
		 * all the devices can be opened from userland, but it's
		 * still possible in some circumstances.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: %s is unavailable"),
		    msg, new_disk);
		break;

	case EBUSY:
		/*
		 * The new device is is use.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: %s busy"), msg, new_disk);
		break;

	case EOVERFLOW:
		/*
		 * The new device is too small.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: %s is too small"),
		    msg, new_disk);
		break;

	case EDOM:
		/*
		 * The new device has a different alignment requirement.
		 */
		zfs_error(dgettext(TEXT_DOMAIN,
		    "%s: devices have different sector alignment"), msg);
		break;

	case ENAMETOOLONG:
		/*
		 * The resulting top-level vdev spec won't fit in the label.
		 */
		zfs_error(dgettext(TEXT_DOMAIN,
		    "%s: too many devices in a single vdev"), msg);
		break;

	default:
		zfs_baderror(errno);
	}

	return (1);
}

/*
 * Detach the specified device.
 */
int
zpool_vdev_detach(zpool_handle_t *zhp, const char *path)
{
	zfs_cmd_t zc = { 0 };
	char msg[1024];

	(void) snprintf(msg, sizeof (msg),
	    dgettext(TEXT_DOMAIN, "cannot detach %s"), path);

	(void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
	if ((zc.zc_guid = zpool_vdev_to_guid(zhp, path)) == 0) {
		zfs_error(dgettext(TEXT_DOMAIN, "%s: no such device in pool"),
		    msg);
		return (-1);
	}

	if (zfs_ioctl(ZFS_IOC_VDEV_DETACH, &zc) == 0)
		return (0);

	switch (errno) {
	case EPERM:
		/*
		 * No permission to mess with the config.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: permission denied"), msg);
		break;

	case ENODEV:
		/*
		 * Device doesn't exist.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: device not in pool"), msg);
		break;

	case ENOTSUP:
		/*
		 * Can't detach from this type of vdev.
		 */
		zfs_error(dgettext(TEXT_DOMAIN,
		    "%s: only applicable to mirror and replacing vdevs"), msg);
		break;

	case EBUSY:
		/*
		 * There are no other replicas of this device.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: no valid replicas"), msg);
		break;

	default:
		zfs_baderror(errno);
	}

	return (1);
}

/*
 * Clear the errors for the pool, or the particular device if specified.
 */
int
zpool_clear(zpool_handle_t *zhp, const char *path)
{
	zfs_cmd_t zc = { 0 };
	char msg[1024];

	if (path)
		(void) snprintf(msg, sizeof (msg),
		    dgettext(TEXT_DOMAIN, "cannot clear errors for %s"),
		    zc.zc_prop_value);
	else
		(void) snprintf(msg, sizeof (msg),
		    dgettext(TEXT_DOMAIN, "cannot clear errors for %s"),
		    zhp->zpool_name);

	(void) strlcpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
	if (path && (zc.zc_guid = zpool_vdev_to_guid(zhp, path)) == 0) {
		zfs_error(dgettext(TEXT_DOMAIN, "%s: no such device in pool"),
		    msg);
		return (-1);
	}

	if (zfs_ioctl(ZFS_IOC_CLEAR, &zc) == 0)
		return (0);

	switch (errno) {
	case EPERM:
		/*
		 * No permission to mess with the config.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: permission denied"), msg);
		break;

	case ENODEV:
		/*
		 * Device doesn't exist.
		 */
		zfs_error(dgettext(TEXT_DOMAIN, "%s: device not in pool"), msg);
		break;

	default:
		zfs_baderror(errno);
	}

	return (1);
}

static int
do_zvol(zfs_handle_t *zhp, void *data)
{
	int linktype = (int)(uintptr_t)data;
	int ret;

	/*
	 * We check for volblocksize intead of ZFS_TYPE_VOLUME so that we
	 * correctly handle snapshots of volumes.
	 */
	if (zhp->zfs_volblocksize != 0) {
		if (linktype)
			ret = zvol_create_link(zhp->zfs_name);
		else
			ret = zvol_remove_link(zhp->zfs_name);
	}

	ret = zfs_iter_children(zhp, do_zvol, data);

	zfs_close(zhp);
	return (ret);
}

/*
 * Iterate over all zvols in the pool and make any necessary minor nodes.
 */
int
zpool_create_zvol_links(zpool_handle_t *zhp)
{
	zfs_handle_t *zfp;
	int ret;

	/*
	 * If the pool is unavailable, just return success.
	 */
	if ((zfp = make_dataset_handle(zhp->zpool_name)) == NULL)
		return (0);

	ret = zfs_iter_children(zfp, do_zvol, (void *)TRUE);

	zfs_close(zfp);
	return (ret);
}

/*
 * Iterate over all zvols in the poool and remove any minor nodes.
 */
int
zpool_remove_zvol_links(zpool_handle_t *zhp)
{
	zfs_handle_t *zfp;
	int ret;

	/*
	 * If the pool is unavailable, just return success.
	 */
	if ((zfp = make_dataset_handle(zhp->zpool_name)) == NULL)
		return (0);

	ret = zfs_iter_children(zfp, do_zvol, (void *)FALSE);

	zfs_close(zfp);
	return (ret);
}

/*
 * Convert from a devid string to a path.
 */
static char *
devid_to_path(char *devid_str)
{
	ddi_devid_t devid;
	char *minor;
	char *path;
	devid_nmlist_t *list = NULL;
	int ret;

	if (devid_str_decode(devid_str, &devid, &minor) != 0)
		return (NULL);

	ret = devid_deviceid_to_nmlist("/dev", devid, minor, &list);

	devid_str_free(minor);
	devid_free(devid);

	if (ret != 0)
		return (NULL);

	path = zfs_strdup(list[0].devname);
	devid_free_nmlist(list);

	return (path);
}

/*
 * Convert from a path to a devid string.
 */
static char *
path_to_devid(const char *path)
{
	int fd;
	ddi_devid_t devid;
	char *minor, *ret;

	if ((fd = open(path, O_RDONLY)) < 0)
		return (NULL);

	minor = NULL;
	ret = NULL;
	if (devid_get(fd, &devid) == 0) {
		if (devid_get_minor_name(fd, &minor) == 0)
			ret = devid_str_encode(devid, minor);
		if (minor != NULL)
			devid_str_free(minor);
		devid_free(devid);
	}
	(void) close(fd);

	return (ret);
}

/*
 * Issue the necessary ioctl() to update the stored path value for the vdev.  We
 * ignore any failure here, since a common case is for an unprivileged user to
 * type 'zpool status', and we'll display the correct information anyway.
 */
static void
set_path(zpool_handle_t *zhp, nvlist_t *nv, const char *path)
{
	zfs_cmd_t zc = { 0 };

	(void) strncpy(zc.zc_name, zhp->zpool_name, sizeof (zc.zc_name));
	(void) strncpy(zc.zc_prop_value, path, sizeof (zc.zc_prop_value));
	verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID,
	    &zc.zc_guid) == 0);

	(void) zfs_ioctl(ZFS_IOC_VDEV_SETPATH, &zc);
}

/*
 * Given a vdev, return the name to display in iostat.  If the vdev has a path,
 * we use that, stripping off any leading "/dev/dsk/"; if not, we use the type.
 * We also check if this is a whole disk, in which case we strip off the
 * trailing 's0' slice name.
 *
 * This routine is also responsible for identifying when disks have been
 * reconfigured in a new location.  The kernel will have opened the device by
 * devid, but the path will still refer to the old location.  To catch this, we
 * first do a path -> devid translation (which is fast for the common case).  If
 * the devid matches, we're done.  If not, we do a reverse devid -> path
 * translation and issue the appropriate ioctl() to update the path of the vdev.
 * If 'zhp' is NULL, then this is an exported pool, and we don't need to do any
 * of these checks.
 */
char *
zpool_vdev_name(zpool_handle_t *zhp, nvlist_t *nv)
{
	char *path, *devid;
	uint64_t value;
	char buf[64];

	if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_NOT_PRESENT,
	    &value) == 0) {
		verify(nvlist_lookup_uint64(nv, ZPOOL_CONFIG_GUID,
		    &value) == 0);
		(void) snprintf(buf, sizeof (buf), "%llu", value);
		path = buf;
	} else if (nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path) == 0) {

		if (zhp != NULL &&
		    nvlist_lookup_string(nv, ZPOOL_CONFIG_DEVID, &devid) == 0) {
			/*
			 * Determine if the current path is correct.
			 */
			char *newdevid = path_to_devid(path);

			if (newdevid == NULL ||
			    strcmp(devid, newdevid) != 0) {
				char *newpath;

				if ((newpath = devid_to_path(devid)) != NULL) {
					/*
					 * Update the path appropriately.
					 */
					set_path(zhp, nv, newpath);
					verify(nvlist_add_string(nv,
					    ZPOOL_CONFIG_PATH, newpath) == 0);
					free(newpath);
					verify(nvlist_lookup_string(nv,
					    ZPOOL_CONFIG_PATH, &path) == 0);
				}

				if (newdevid)
					devid_str_free(newdevid);
			}

		}

		if (strncmp(path, "/dev/dsk/", 9) == 0)
			path += 9;

		if (nvlist_lookup_uint64(nv, ZPOOL_CONFIG_WHOLE_DISK,
		    &value) == 0 && value) {
			char *tmp = zfs_strdup(path);
			tmp[strlen(path) - 2] = '\0';
			return (tmp);
		}
	} else {
		verify(nvlist_lookup_string(nv, ZPOOL_CONFIG_TYPE, &path) == 0);
	}

	return (zfs_strdup(path));
}

static int
zbookmark_compare(const void *a, const void *b)
{
	return (memcmp(a, b, sizeof (zbookmark_t)));
}

/*
 * Retrieve the persistent error log, uniquify the members, and return to the
 * caller.
 */
int
zpool_get_errlog(zpool_handle_t *zhp, nvlist_t ***list, size_t *nelem)
{
	zfs_cmd_t zc = { 0 };
	uint64_t count;
	zbookmark_t *zb;
	int i, j;

	if (zhp->zpool_error_log != NULL) {
		*list = zhp->zpool_error_log;
		*nelem = zhp->zpool_error_count;
		return (0);
	}

	/*
	 * Retrieve the raw error list from the kernel.  If the number of errors
	 * has increased, allocate more space and continue until we get the
	 * entire list.
	 */
	verify(nvlist_lookup_uint64(zhp->zpool_config, ZPOOL_CONFIG_ERRCOUNT,
	    &count) == 0);
	zc.zc_config_dst = (uintptr_t)zfs_malloc(count * sizeof (zbookmark_t));
	zc.zc_config_dst_size = count;
	(void) strcpy(zc.zc_name, zhp->zpool_name);
	for (;;) {
		if (zfs_ioctl(ZFS_IOC_ERROR_LOG, &zc) != 0) {
			if (errno == ENOMEM) {
				free((void *)(uintptr_t)zc.zc_config_dst);
				zc.zc_config_dst = (uintptr_t)
				    zfs_malloc(zc.zc_config_dst_size);
			} else {
				return (-1);
			}
		} else {
			break;
		}
	}

	/*
	 * Sort the resulting bookmarks.  This is a little confusing due to the
	 * implementation of ZFS_IOC_ERROR_LOG.  The bookmarks are copied last
	 * to first, and 'zc_config_dst_size' indicates the number of boomarks
	 * _not_ copied as part of the process.  So we point the start of our
	 * array appropriate and decrement the total number of elements.
	 */
	zb = ((zbookmark_t *)(uintptr_t)zc.zc_config_dst) +
	    zc.zc_config_dst_size;
	count -= zc.zc_config_dst_size;

	qsort(zb, count, sizeof (zbookmark_t), zbookmark_compare);

	/*
	 * Count the number of unique elements
	 */
	j = 0;
	for (i = 0; i < count; i++) {
		if (i > 0 && memcmp(&zb[i - 1], &zb[i],
		    sizeof (zbookmark_t)) == 0)
			continue;
		j++;
	}

	/*
	 * If the user has only requested the number of items, return it now
	 * without bothering with the extra work.
	 */
	if (list == NULL) {
		*nelem = j;
		return (0);
	}

	zhp->zpool_error_count = j;

	/*
	 * Allocate an array of nvlists to hold the results
	 */
	zhp->zpool_error_log = zfs_malloc(j * sizeof (nvlist_t *));

	/*
	 * Fill in the results with names from the kernel.
	 */
	j = 0;
	for (i = 0; i < count; i++) {
		char buf[64];
		nvlist_t *nv;

		if (i > 0 && memcmp(&zb[i - 1], &zb[i],
		    sizeof (zbookmark_t)) == 0)
			continue;

		verify(nvlist_alloc(&nv, NV_UNIQUE_NAME,
		    0) == 0);
		zhp->zpool_error_log[j] = nv;

		zc.zc_bookmark = zb[i];
		if (zfs_ioctl(ZFS_IOC_BOOKMARK_NAME, &zc) == 0) {
			verify(nvlist_add_string(nv, ZPOOL_ERR_DATASET,
			    zc.zc_prop_name) == 0);
			verify(nvlist_add_string(nv, ZPOOL_ERR_OBJECT,
			    zc.zc_prop_value) == 0);
			verify(nvlist_add_string(nv, ZPOOL_ERR_RANGE,
			    zc.zc_filename) == 0);
		} else {
			(void) snprintf(buf, sizeof (buf), "%llx",
			    zb[i].zb_objset);
			verify(nvlist_add_string(nv,
			    ZPOOL_ERR_DATASET, buf) == 0);
			(void) snprintf(buf, sizeof (buf), "%llx",
			    zb[i].zb_object);
			verify(nvlist_add_string(nv, ZPOOL_ERR_OBJECT,
			    buf) == 0);
			(void) snprintf(buf, sizeof (buf), "lvl=%u blkid=%llu",
			    (int)zb[i].zb_level, (long long)zb[i].zb_blkid);
			verify(nvlist_add_string(nv, ZPOOL_ERR_RANGE,
			    buf) == 0);
		}

		j++;
	}

	*list = zhp->zpool_error_log;
	*nelem = zhp->zpool_error_count;

	free((void *)(uintptr_t)zc.zc_config_dst);

	return (0);
}

/*
 * Upgrade a ZFS pool to the latest on-disk version.
 */
int
zpool_upgrade(zpool_handle_t *zhp)
{
	zfs_cmd_t zc = { 0 };

	(void) strcpy(zc.zc_name, zhp->zpool_name);
	if (zfs_ioctl(ZFS_IOC_POOL_UPGRADE, &zc) != 0) {
		switch (errno) {
		case EPERM:
			zfs_error(dgettext(TEXT_DOMAIN, "cannot upgrade '%s': "
			    "permission denied"), zhp->zpool_name);
			break;
		default:
			zfs_baderror(errno);
		}

		return (-1);
	}

	return (0);
}