xref: /illumos-gate/usr/src/lib/libzpool/common/util.c (revision 8c69cc8fbe729fa7b091e901c4b50508ccc6bb33)
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 /*
22  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright (c) 2016 by Delphix. All rights reserved.
24  */
25 
26 #include <assert.h>
27 #include <sys/zfs_context.h>
28 #include <sys/avl.h>
29 #include <string.h>
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <sys/spa.h>
33 #include <sys/fs/zfs.h>
34 #include <sys/refcount.h>
35 #include <dlfcn.h>
36 
37 /*
38  * Routines needed by more than one client of libzpool.
39  */
40 
41 static void
42 show_vdev_stats(const char *desc, const char *ctype, nvlist_t *nv, int indent)
43 {
44 	vdev_stat_t *vs;
45 	vdev_stat_t v0 = { 0 };
46 	uint64_t sec;
47 	uint64_t is_log = 0;
48 	nvlist_t **child;
49 	uint_t c, children;
50 	char used[6], avail[6];
51 	char rops[6], wops[6], rbytes[6], wbytes[6], rerr[6], werr[6], cerr[6];
52 	char *prefix = "";
53 
54 	if (indent == 0 && desc != NULL) {
55 		(void) printf("                           "
56 		    " capacity   operations   bandwidth  ---- errors ----\n");
57 		(void) printf("description                "
58 		    "used avail  read write  read write  read write cksum\n");
59 	}
60 
61 	if (desc != NULL) {
62 		(void) nvlist_lookup_uint64(nv, ZPOOL_CONFIG_IS_LOG, &is_log);
63 
64 		if (is_log)
65 			prefix = "log ";
66 
67 		if (nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
68 		    (uint64_t **)&vs, &c) != 0)
69 			vs = &v0;
70 
71 		sec = MAX(1, vs->vs_timestamp / NANOSEC);
72 
73 		nicenum(vs->vs_alloc, used, sizeof (used));
74 		nicenum(vs->vs_space - vs->vs_alloc, avail, sizeof (avail));
75 		nicenum(vs->vs_ops[ZIO_TYPE_READ] / sec, rops, sizeof (rops));
76 		nicenum(vs->vs_ops[ZIO_TYPE_WRITE] / sec, wops, sizeof (wops));
77 		nicenum(vs->vs_bytes[ZIO_TYPE_READ] / sec, rbytes,
78 		    sizeof (rbytes));
79 		nicenum(vs->vs_bytes[ZIO_TYPE_WRITE] / sec, wbytes,
80 		    sizeof (wbytes));
81 		nicenum(vs->vs_read_errors, rerr, sizeof (rerr));
82 		nicenum(vs->vs_write_errors, werr, sizeof (werr));
83 		nicenum(vs->vs_checksum_errors, cerr, sizeof (cerr));
84 
85 		(void) printf("%*s%s%*s%*s%*s %5s %5s %5s %5s %5s %5s %5s\n",
86 		    indent, "",
87 		    prefix,
88 		    indent + strlen(prefix) - 25 - (vs->vs_space ? 0 : 12),
89 		    desc,
90 		    vs->vs_space ? 6 : 0, vs->vs_space ? used : "",
91 		    vs->vs_space ? 6 : 0, vs->vs_space ? avail : "",
92 		    rops, wops, rbytes, wbytes, rerr, werr, cerr);
93 	}
94 
95 	if (nvlist_lookup_nvlist_array(nv, ctype, &child, &children) != 0)
96 		return;
97 
98 	for (c = 0; c < children; c++) {
99 		nvlist_t *cnv = child[c];
100 		char *cname, *tname;
101 		uint64_t np;
102 		if (nvlist_lookup_string(cnv, ZPOOL_CONFIG_PATH, &cname) &&
103 		    nvlist_lookup_string(cnv, ZPOOL_CONFIG_TYPE, &cname))
104 			cname = "<unknown>";
105 		tname = calloc(1, strlen(cname) + 2);
106 		(void) strcpy(tname, cname);
107 		if (nvlist_lookup_uint64(cnv, ZPOOL_CONFIG_NPARITY, &np) == 0)
108 			tname[strlen(tname)] = '0' + np;
109 		show_vdev_stats(tname, ctype, cnv, indent + 2);
110 		free(tname);
111 	}
112 }
113 
114 void
115 show_pool_stats(spa_t *spa)
116 {
117 	nvlist_t *config, *nvroot;
118 	char *name;
119 
120 	VERIFY(spa_get_stats(spa_name(spa), &config, NULL, 0) == 0);
121 
122 	VERIFY(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
123 	    &nvroot) == 0);
124 	VERIFY(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
125 	    &name) == 0);
126 
127 	show_vdev_stats(name, ZPOOL_CONFIG_CHILDREN, nvroot, 0);
128 	show_vdev_stats(NULL, ZPOOL_CONFIG_L2CACHE, nvroot, 0);
129 	show_vdev_stats(NULL, ZPOOL_CONFIG_SPARES, nvroot, 0);
130 
131 	nvlist_free(config);
132 }
133 
134 /*
135  * Sets given global variable in libzpool to given unsigned 32-bit value.
136  * arg: "<variable>=<value>"
137  */
138 int
139 set_global_var(char *arg)
140 {
141 	void *zpoolhdl;
142 	char *varname = arg, *varval;
143 	u_longlong_t val;
144 
145 #ifndef _LITTLE_ENDIAN
146 	/*
147 	 * On big endian systems changing a 64-bit variable would set the high
148 	 * 32 bits instead of the low 32 bits, which could cause unexpected
149 	 * results.
150 	 */
151 	fprintf(stderr, "Setting global variables is only supported on "
152 	    "little-endian systems\n", varname);
153 	return (ENOTSUP);
154 #endif
155 	if ((varval = strchr(arg, '=')) != NULL) {
156 		*varval = '\0';
157 		varval++;
158 		val = strtoull(varval, NULL, 0);
159 		if (val > UINT32_MAX) {
160 			fprintf(stderr, "Value for global variable '%s' must "
161 			    "be a 32-bit unsigned integer\n", varname);
162 			return (EOVERFLOW);
163 		}
164 	} else {
165 		return (EINVAL);
166 	}
167 
168 	zpoolhdl = dlopen("libzpool.so", RTLD_LAZY);
169 	if (zpoolhdl != NULL) {
170 		uint32_t *var;
171 		var = dlsym(zpoolhdl, varname);
172 		if (var == NULL) {
173 			fprintf(stderr, "Global variable '%s' does not exist "
174 			    "in libzpool.so\n", varname);
175 			return (EINVAL);
176 		}
177 		*var = (uint32_t)val;
178 
179 		dlclose(zpoolhdl);
180 	} else {
181 		fprintf(stderr, "Failed to open libzpool.so to set global "
182 		    "variable\n");
183 		return (EIO);
184 	}
185 
186 	return (0);
187 }
188