[mirror_zfs.git] / lib / libzpool / util.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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2016 by Delphix. All rights reserved.
 * Copyright 2017 Jason King
 */

#include <assert.h>
#include <sys/zfs_context.h>
#include <sys/avl.h>
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/spa.h>
#include <sys/fs/zfs.h>
#include <sys/refcount.h>
#include <dlfcn.h>

/*
 * Routines needed by more than one client of libzpool.
 */

/* The largest suffix that can fit, aka an exabyte (2^60 / 10^18) */
#define	INDEX_MAX	(6)

/* Verify INDEX_MAX fits */
CTASSERT_GLOBAL(INDEX_MAX * 10 < sizeof (uint64_t) * 8);

void
nicenum_scale(uint64_t n, size_t units, char *buf, size_t buflen,
    uint32_t flags)
{
	uint64_t divamt = 1024;
	uint64_t divisor = 1;
	int index = 0;
	int rc = 0;
	char u;

	if (units == 0)
		units = 1;

	if (n > 0) {
		n *= units;
		if (n < units)
			goto overflow;
	}

	if (flags & NN_DIVISOR_1000)
		divamt = 1000;

	/*
	 * This tries to find the suffix S(n) such that
	 * S(n) <= n < S(n+1), where S(n) = 2^(n*10) | 10^(3*n)
	 * (i.e. 1024/1000, 1,048,576/1,000,000, etc).  Stop once S(n)
	 * is the largest prefix supported (i.e. don't bother computing
	 * and checking S(n+1).  Since INDEX_MAX should be the largest
	 * suffix that fits (currently an exabyte), S(INDEX_MAX + 1) is
	 * never checked as it would overflow.
	 */
	while (index < INDEX_MAX) {
		uint64_t newdiv = divisor * divamt;

		/* CTASSERT() guarantee these never trip */
		VERIFY3U(newdiv, >=, divamt);
		VERIFY3U(newdiv, >=, divisor);

		if (n < newdiv)
			break;

		divisor = newdiv;
		index++;
	}

	u = " KMGTPE"[index];

	if (index == 0) {
		rc = snprintf(buf, buflen, "%llu", (u_longlong_t)n);
	} else if (n % divisor == 0) {
		/*
		 * If this is an even multiple of the base, always display
		 * without any decimal precision.
		 */
		rc = snprintf(buf, buflen, "%llu%c",
		    (u_longlong_t)(n / divisor), u);
	} else {
		/*
		 * We want to choose a precision that reflects the best choice
		 * for fitting in 5 characters.  This can get rather tricky
		 * when we have numbers that are very close to an order of
		 * magnitude.  For example, when displaying 10239 (which is
		 * really 9.999K), we want only a single place of precision
		 * for 10.0K.  We could develop some complex heuristics for
		 * this, but it's much easier just to try each combination
		 * in turn.
		 */
		int i;
		for (i = 2; i >= 0; i--) {
			if ((rc = snprintf(buf, buflen, "%.*f%c", i,
			    (double)n / divisor, u)) <= 5)
				break;
		}
	}

	if (rc + 1 > buflen || rc < 0)
		goto overflow;

	return;

overflow:
	/* prefer a more verbose message if possible */
	if (buflen > 10)
		(void) strlcpy(buf, "<overflow>", buflen);
	else
		(void) strlcpy(buf, "??", buflen);
}

void
nicenum(uint64_t num, char *buf, size_t buflen)
{
	nicenum_scale(num, 1, buf, buflen, 0);
}

static void
show_vdev_stats(const char *desc, const char *ctype, nvlist_t *nv, int indent)
{
	vdev_stat_t *vs;
	vdev_stat_t *v0 = { 0 };
	uint64_t sec;
	uint64_t is_log = 0;
	nvlist_t **child;
	uint_t c, children;
	char used[6], avail[6];
	char rops[6], wops[6], rbytes[6], wbytes[6], rerr[6], werr[6], cerr[6];
	char *prefix = "";

	v0 = umem_zalloc(sizeof (*v0), UMEM_NOFAIL);

	if (indent == 0 && desc != NULL) {
		(void) printf("                           "
		    " capacity   operations   bandwidth  ---- errors ----\n");
		(void) printf("description                "
		    "used avail  read write  read write  read write cksum\n");
	}

	if (desc != NULL) {
		(void) nvlist_lookup_uint64(nv, ZPOOL_CONFIG_IS_LOG, &is_log);

		if (is_log)
			prefix = "log ";

		if (nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
		    (uint64_t **)&vs, &c) != 0)
			vs = v0;

		sec = MAX(1, vs->vs_timestamp / NANOSEC);

		nicenum(vs->vs_alloc, used, sizeof (used));
		nicenum(vs->vs_space - vs->vs_alloc, avail, sizeof (avail));
		nicenum(vs->vs_ops[ZIO_TYPE_READ] / sec, rops, sizeof (rops));
		nicenum(vs->vs_ops[ZIO_TYPE_WRITE] / sec, wops, sizeof (wops));
		nicenum(vs->vs_bytes[ZIO_TYPE_READ] / sec, rbytes,
		    sizeof (rbytes));
		nicenum(vs->vs_bytes[ZIO_TYPE_WRITE] / sec, wbytes,
		    sizeof (wbytes));
		nicenum(vs->vs_read_errors, rerr, sizeof (rerr));
		nicenum(vs->vs_write_errors, werr, sizeof (werr));
		nicenum(vs->vs_checksum_errors, cerr, sizeof (cerr));

		(void) printf("%*s%s%*s%*s%*s %5s %5s %5s %5s %5s %5s %5s\n",
		    indent, "",
		    prefix,
		    (int)(indent+strlen(prefix)-25-(vs->vs_space ? 0 : 12)),
		    desc,
		    vs->vs_space ? 6 : 0, vs->vs_space ? used : "",
		    vs->vs_space ? 6 : 0, vs->vs_space ? avail : "",
		    rops, wops, rbytes, wbytes, rerr, werr, cerr);
	}
	free(v0);

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

	for (c = 0; c < children; c++) {
		nvlist_t *cnv = child[c];
		char *cname = NULL, *tname;
		uint64_t np;
		int len;
		if (nvlist_lookup_string(cnv, ZPOOL_CONFIG_PATH, &cname) &&
		    nvlist_lookup_string(cnv, ZPOOL_CONFIG_TYPE, &cname))
			cname = "<unknown>";
		len = strlen(cname) + 2;
		tname = umem_zalloc(len, UMEM_NOFAIL);
		(void) strlcpy(tname, cname, len);
		if (nvlist_lookup_uint64(cnv, ZPOOL_CONFIG_NPARITY, &np) == 0)
			tname[strlen(tname)] = '0' + np;
		show_vdev_stats(tname, ctype, cnv, indent + 2);
		free(tname);
	}
}

void
show_pool_stats(spa_t *spa)
{
	nvlist_t *config, *nvroot;
	char *name;

	VERIFY(spa_get_stats(spa_name(spa), &config, NULL, 0) == 0);

	VERIFY(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
	    &nvroot) == 0);
	VERIFY(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
	    &name) == 0);

	show_vdev_stats(name, ZPOOL_CONFIG_CHILDREN, nvroot, 0);
	show_vdev_stats(NULL, ZPOOL_CONFIG_L2CACHE, nvroot, 0);
	show_vdev_stats(NULL, ZPOOL_CONFIG_SPARES, nvroot, 0);

	nvlist_free(config);
}

/*
 * Sets given global variable in libzpool to given unsigned 32-bit value.
 * arg: "<variable>=<value>"
 */
int
set_global_var(char *arg)
{
	void *zpoolhdl;
	char *varname = arg, *varval;
	u_longlong_t val;

#ifndef _LITTLE_ENDIAN
	/*
	 * On big endian systems changing a 64-bit variable would set the high
	 * 32 bits instead of the low 32 bits, which could cause unexpected
	 * results.
	 */
	fprintf(stderr, "Setting global variables is only supported on "
	    "little-endian systems\n");
	return (ENOTSUP);
#endif
	if (arg != NULL && (varval = strchr(arg, '=')) != NULL) {
		*varval = '\0';
		varval++;
		val = strtoull(varval, NULL, 0);
		if (val > UINT32_MAX) {
			fprintf(stderr, "Value for global variable '%s' must "
			    "be a 32-bit unsigned integer\n", varname);
			return (EOVERFLOW);
		}
	} else {
		return (EINVAL);
	}

	zpoolhdl = dlopen("libzpool.so", RTLD_LAZY);
	if (zpoolhdl != NULL) {
		uint32_t *var;
		var = dlsym(zpoolhdl, varname);
		if (var == NULL) {
			fprintf(stderr, "Global variable '%s' does not exist "
			    "in libzpool.so\n", varname);
			return (EINVAL);
		}
		*var = (uint32_t)val;

		dlclose(zpoolhdl);
	} else {
		fprintf(stderr, "Failed to open libzpool.so to set global "
		    "variable\n");
		return (EIO);
	}

	return (0);
}
Commit	Line	Data
34dc7c2f BB	1	/*
	2	* CDDL HEADER START
	3	*
	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.
	7	*
	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.
	12	*
	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]
	18	*
	19	* CDDL HEADER END
	20	*/
	21	/*
428870ff	22	* Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
ed828c0c	23	* Copyright (c) 2016 by Delphix. All rights reserved.
f3c8c9e6	24	* Copyright 2017 Jason King
34dc7c2f BB	25	*/
34dc7c2f BB	26
34dc7c2f BB	27	#include <assert.h>
	28	#include <sys/zfs_context.h>
	29	#include <sys/avl.h>
	30	#include <string.h>
	31	#include <stdio.h>
	32	#include <stdlib.h>
	33	#include <sys/spa.h>
	34	#include <sys/fs/zfs.h>
	35	#include <sys/refcount.h>
ed828c0c	36	#include <dlfcn.h>
34dc7c2f BB	37
	38	/*
	39	* Routines needed by more than one client of libzpool.
	40	*/
	41
f3c8c9e6 JK	42	/* The largest suffix that can fit, aka an exabyte (2^60 / 10^18) */
	43	#define INDEX_MAX (6)
	44
	45	/* Verify INDEX_MAX fits */
	46	CTASSERT_GLOBAL(INDEX_MAX * 10 < sizeof (uint64_t) * 8);
	47
34dc7c2f	48	void
f3c8c9e6 JK	49	nicenum_scale(uint64_t n, size_t units, char *buf, size_t buflen,
f3c8c9e6 JK	50	uint32_t flags)
34dc7c2f	51	{
f3c8c9e6 JK	52	uint64_t divamt = 1024;
f3c8c9e6 JK	53	uint64_t divisor = 1;
34dc7c2f	54	int index = 0;
f3c8c9e6	55	int rc = 0;
34dc7c2f BB	56	char u;
34dc7c2f BB	57
f3c8c9e6 JK	58	if (units == 0)
	59	units = 1;
	60
	61	if (n > 0) {
	62	n *= units;
	63	if (n < units)
	64	goto overflow;
	65	}
	66
	67	if (flags & NN_DIVISOR_1000)
	68	divamt = 1000;
	69
	70	/*
	71	* This tries to find the suffix S(n) such that
	72	* S(n) <= n < S(n+1), where S(n) = 2^(n10) \| 10^(3n)
	73	* (i.e. 1024/1000, 1,048,576/1,000,000, etc). Stop once S(n)
	74	* is the largest prefix supported (i.e. don't bother computing
	75	* and checking S(n+1). Since INDEX_MAX should be the largest
	76	* suffix that fits (currently an exabyte), S(INDEX_MAX + 1) is
	77	* never checked as it would overflow.
	78	*/
	79	while (index < INDEX_MAX) {
	80	uint64_t newdiv = divisor * divamt;
	81
	82	/* CTASSERT() guarantee these never trip */
	83	VERIFY3U(newdiv, >=, divamt);
	84	VERIFY3U(newdiv, >=, divisor);
	85
	86	if (n < newdiv)
	87	break;
	88
	89	divisor = newdiv;
34dc7c2f BB	90	index++;
	91	}
	92
	93	u = " KMGTPE"[index];
	94
	95	if (index == 0) {
f3c8c9e6 JK	96	rc = snprintf(buf, buflen, "%llu", (u_longlong_t)n);
	97	} else if (n % divisor == 0) {
	98	/*
	99	* If this is an even multiple of the base, always display
	100	* without any decimal precision.
	101	*/
	102	rc = snprintf(buf, buflen, "%llu%c",
	103	(u_longlong_t)(n / divisor), u);
34dc7c2f	104	} else {
f3c8c9e6 JK	105	/*
	106	* We want to choose a precision that reflects the best choice
	107	* for fitting in 5 characters. This can get rather tricky
	108	* when we have numbers that are very close to an order of
	109	* magnitude. For example, when displaying 10239 (which is
	110	* really 9.999K), we want only a single place of precision
	111	* for 10.0K. We could develop some complex heuristics for
	112	* this, but it's much easier just to try each combination
	113	* in turn.
	114	*/
	115	int i;
	116	for (i = 2; i >= 0; i--) {
	117	if ((rc = snprintf(buf, buflen, "%.*f%c", i,
	118	(double)n / divisor, u)) <= 5)
	119	break;
	120	}
34dc7c2f	121	}
f3c8c9e6 JK	122
	123	if (rc + 1 > buflen \|\| rc < 0)
	124	goto overflow;
	125
	126	return;
	127
	128	overflow:
	129	/* prefer a more verbose message if possible */
	130	if (buflen > 10)
	131	(void) strlcpy(buf, "<overflow>", buflen);
	132	else
	133	(void) strlcpy(buf, "??", buflen);
	134	}
	135
	136	void
	137	nicenum(uint64_t num, char *buf, size_t buflen)
	138	{
	139	nicenum_scale(num, 1, buf, buflen, 0);
34dc7c2f BB	140	}
	141
	142	static void
b128c09f	143	show_vdev_stats(const char desc, const char ctype, nvlist_t *nv, int indent)
34dc7c2f	144	{
34dc7c2f	145	vdev_stat_t *vs;
193a37cb	146	vdev_stat_t *v0 = { 0 };
34dc7c2f BB	147	uint64_t sec;
34dc7c2f BB	148	uint64_t is_log = 0;
b128c09f BB	149	nvlist_t **child;
b128c09f BB	150	uint_t c, children;
34dc7c2f BB	151	char used[6], avail[6];
	152	char rops[6], wops[6], rbytes[6], wbytes[6], rerr[6], werr[6], cerr[6];
	153	char *prefix = "";
	154
193a37cb TH	155	v0 = umem_zalloc(sizeof (*v0), UMEM_NOFAIL);
193a37cb TH	156
b128c09f BB	157	if (indent == 0 && desc != NULL) {
b128c09f BB	158	(void) printf(" "
34dc7c2f	159	" capacity operations bandwidth ---- errors ----\n");
b128c09f	160	(void) printf("description "
34dc7c2f BB	161	"used avail read write read write read write cksum\n");
	162	}
	163
b128c09f BB	164	if (desc != NULL) {
	165	(void) nvlist_lookup_uint64(nv, ZPOOL_CONFIG_IS_LOG, &is_log);
	166
	167	if (is_log)
	168	prefix = "log ";
	169
428870ff	170	if (nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
b128c09f	171	(uint64_t **)&vs, &c) != 0)
193a37cb	172	vs = v0;
b128c09f BB	173
	174	sec = MAX(1, vs->vs_timestamp / NANOSEC);
	175
f3c8c9e6 JK	176	nicenum(vs->vs_alloc, used, sizeof (used));
	177	nicenum(vs->vs_space - vs->vs_alloc, avail, sizeof (avail));
	178	nicenum(vs->vs_ops[ZIO_TYPE_READ] / sec, rops, sizeof (rops));
	179	nicenum(vs->vs_ops[ZIO_TYPE_WRITE] / sec, wops, sizeof (wops));
	180	nicenum(vs->vs_bytes[ZIO_TYPE_READ] / sec, rbytes,
	181	sizeof (rbytes));
	182	nicenum(vs->vs_bytes[ZIO_TYPE_WRITE] / sec, wbytes,
	183	sizeof (wbytes));
	184	nicenum(vs->vs_read_errors, rerr, sizeof (rerr));
	185	nicenum(vs->vs_write_errors, werr, sizeof (werr));
	186	nicenum(vs->vs_checksum_errors, cerr, sizeof (cerr));
b128c09f BB	187
	188	(void) printf("%s%s%s%s%s %5s %5s %5s %5s %5s %5s %5s\n",
	189	indent, "",
	190	prefix,
b8864a23	191	(int)(indent+strlen(prefix)-25-(vs->vs_space ? 0 : 12)),
b128c09f BB	192	desc,
	193	vs->vs_space ? 6 : 0, vs->vs_space ? used : "",
	194	vs->vs_space ? 6 : 0, vs->vs_space ? avail : "",
	195	rops, wops, rbytes, wbytes, rerr, werr, cerr);
	196	}
193a37cb	197	free(v0);
b128c09f BB	198
b128c09f BB	199	if (nvlist_lookup_nvlist_array(nv, ctype, &child, &children) != 0)
34dc7c2f BB	200	return;
	201
	202	for (c = 0; c < children; c++) {
	203	nvlist_t *cnv = child[c];
ccc92611	204	char cname = NULL, tname;
34dc7c2f	205	uint64_t np;
ccc92611	206	int len;
34dc7c2f BB	207	if (nvlist_lookup_string(cnv, ZPOOL_CONFIG_PATH, &cname) &&
	208	nvlist_lookup_string(cnv, ZPOOL_CONFIG_TYPE, &cname))
	209	cname = "<unknown>";
ccc92611	210	len = strlen(cname) + 2;
	211	tname = umem_zalloc(len, UMEM_NOFAIL);
	212	(void) strlcpy(tname, cname, len);
34dc7c2f BB	213	if (nvlist_lookup_uint64(cnv, ZPOOL_CONFIG_NPARITY, &np) == 0)
34dc7c2f BB	214	tname[strlen(tname)] = '0' + np;
b128c09f	215	show_vdev_stats(tname, ctype, cnv, indent + 2);
34dc7c2f BB	216	free(tname);
	217	}
	218	}
	219
	220	void
	221	show_pool_stats(spa_t *spa)
	222	{
	223	nvlist_t config, nvroot;
	224	char *name;
	225
b128c09f	226	VERIFY(spa_get_stats(spa_name(spa), &config, NULL, 0) == 0);
34dc7c2f BB	227
	228	VERIFY(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
	229	&nvroot) == 0);
	230	VERIFY(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
	231	&name) == 0);
	232
b128c09f BB	233	show_vdev_stats(name, ZPOOL_CONFIG_CHILDREN, nvroot, 0);
	234	show_vdev_stats(NULL, ZPOOL_CONFIG_L2CACHE, nvroot, 0);
	235	show_vdev_stats(NULL, ZPOOL_CONFIG_SPARES, nvroot, 0);
	236
	237	nvlist_free(config);
34dc7c2f	238	}
ed828c0c GM	239
	240	/*
	241	* Sets given global variable in libzpool to given unsigned 32-bit value.
	242	* arg: "<variable>=<value>"
	243	*/
	244	int
	245	set_global_var(char *arg)
	246	{
	247	void *zpoolhdl;
	248	char varname = arg, varval;
	249	u_longlong_t val;
	250
	251	#ifndef _LITTLE_ENDIAN
	252	/*
	253	* On big endian systems changing a 64-bit variable would set the high
	254	* 32 bits instead of the low 32 bits, which could cause unexpected
	255	* results.
	256	*/
	257	fprintf(stderr, "Setting global variables is only supported on "
	258	"little-endian systems\n");
	259	return (ENOTSUP);
	260	#endif
7b0dc2a3	261	if (arg != NULL && (varval = strchr(arg, '=')) != NULL) {
ed828c0c GM	262	*varval = '\0';
	263	varval++;
	264	val = strtoull(varval, NULL, 0);
	265	if (val > UINT32_MAX) {
	266	fprintf(stderr, "Value for global variable '%s' must "
	267	"be a 32-bit unsigned integer\n", varname);
	268	return (EOVERFLOW);
	269	}
	270	} else {
	271	return (EINVAL);
	272	}
	273
	274	zpoolhdl = dlopen("libzpool.so", RTLD_LAZY);
	275	if (zpoolhdl != NULL) {
	276	uint32_t *var;
	277	var = dlsym(zpoolhdl, varname);
	278	if (var == NULL) {
	279	fprintf(stderr, "Global variable '%s' does not exist "
	280	"in libzpool.so\n", varname);
	281	return (EINVAL);
	282	}
	283	*var = (uint32_t)val;
	284
	285	dlclose(zpoolhdl);
	286	} else {
	287	fprintf(stderr, "Failed to open libzpool.so to set global "
	288	"variable\n");
	289	return (EIO);
	290	}
	291
	292	return (0);
	293	}