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 https://opensource.org/licenses/CDDL-1.0.
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 * Copyright 2017 Jason King
25 * Copyright (c) 2017, Intel Corporation.
26 */
27
28#include <assert.h>
29#include <sys/zfs_context.h>
30#include <sys/avl.h>
31#include <string.h>
32#include <stdio.h>
33#include <stdlib.h>
34#include <sys/spa.h>
35#include <sys/fs/zfs.h>
36#include <sys/zfs_refcount.h>
37#include <sys/zfs_ioctl.h>
38#include <dlfcn.h>
39#include <libzutil.h>
40
41/*
42 * Routines needed by more than one client of libzpool.
43 */
44
45static void
46show_vdev_stats(const char *desc, const char *ctype, nvlist_t *nv, int indent)
47{
48	vdev_stat_t *vs;
49	vdev_stat_t *v0 = { 0 };
50	uint64_t sec;
51	uint64_t is_log = 0;
52	nvlist_t **child;
53	uint_t c, children;
54	char used[6], avail[6];
55	char rops[6], wops[6], rbytes[6], wbytes[6], rerr[6], werr[6], cerr[6];
56
57	v0 = umem_zalloc(sizeof (*v0), UMEM_NOFAIL);
58
59	if (indent == 0 && desc != NULL) {
60		(void) printf("                           "
61		    " capacity   operations   bandwidth  ---- errors ----\n");
62		(void) printf("description                "
63		    "used avail  read write  read write  read write cksum\n");
64	}
65
66	if (desc != NULL) {
67		const char *suffix = "";
68		const char *bias = NULL;
69		char bias_suffix[32];
70
71		(void) nvlist_lookup_uint64(nv, ZPOOL_CONFIG_IS_LOG, &is_log);
72		(void) nvlist_lookup_string(nv, ZPOOL_CONFIG_ALLOCATION_BIAS,
73		    &bias);
74		if (nvlist_lookup_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
75		    (uint64_t **)&vs, &c) != 0)
76			vs = v0;
77
78		if (bias != NULL) {
79			(void) snprintf(bias_suffix, sizeof (bias_suffix),
80			    " (%s)", bias);
81			suffix = bias_suffix;
82		} else if (is_log) {
83			suffix = " (log)";
84		}
85
86		sec = MAX(1, vs->vs_timestamp / NANOSEC);
87
88		nicenum(vs->vs_alloc, used, sizeof (used));
89		nicenum(vs->vs_space - vs->vs_alloc, avail, sizeof (avail));
90		nicenum(vs->vs_ops[ZIO_TYPE_READ] / sec, rops, sizeof (rops));
91		nicenum(vs->vs_ops[ZIO_TYPE_WRITE] / sec, wops, sizeof (wops));
92		nicenum(vs->vs_bytes[ZIO_TYPE_READ] / sec, rbytes,
93		    sizeof (rbytes));
94		nicenum(vs->vs_bytes[ZIO_TYPE_WRITE] / sec, wbytes,
95		    sizeof (wbytes));
96		nicenum(vs->vs_read_errors, rerr, sizeof (rerr));
97		nicenum(vs->vs_write_errors, werr, sizeof (werr));
98		nicenum(vs->vs_checksum_errors, cerr, sizeof (cerr));
99
100		(void) printf("%*s%s%*s%*s%*s %5s %5s %5s %5s %5s %5s %5s\n",
101		    indent, "",
102		    desc,
103		    (int)(indent+strlen(desc)-25-(vs->vs_space ? 0 : 12)),
104		    suffix,
105		    vs->vs_space ? 6 : 0, vs->vs_space ? used : "",
106		    vs->vs_space ? 6 : 0, vs->vs_space ? avail : "",
107		    rops, wops, rbytes, wbytes, rerr, werr, cerr);
108	}
109	umem_free(v0, sizeof (*v0));
110
111	if (nvlist_lookup_nvlist_array(nv, ctype, &child, &children) != 0)
112		return;
113
114	for (c = 0; c < children; c++) {
115		nvlist_t *cnv = child[c];
116		const char *cname = NULL;
117		char *tname;
118		uint64_t np;
119		int len;
120		if (nvlist_lookup_string(cnv, ZPOOL_CONFIG_PATH, &cname) &&
121		    nvlist_lookup_string(cnv, ZPOOL_CONFIG_TYPE, &cname))
122			cname = "<unknown>";
123		len = strlen(cname) + 2;
124		tname = umem_zalloc(len, UMEM_NOFAIL);
125		(void) strlcpy(tname, cname, len);
126		if (nvlist_lookup_uint64(cnv, ZPOOL_CONFIG_NPARITY, &np) == 0)
127			tname[strlen(tname)] = '0' + np;
128		show_vdev_stats(tname, ctype, cnv, indent + 2);
129		umem_free(tname, len);
130	}
131}
132
133void
134show_pool_stats(spa_t *spa)
135{
136	nvlist_t *config, *nvroot;
137	const char *name;
138
139	VERIFY(spa_get_stats(spa_name(spa), &config, NULL, 0) == 0);
140
141	VERIFY(nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
142	    &nvroot) == 0);
143	VERIFY(nvlist_lookup_string(config, ZPOOL_CONFIG_POOL_NAME,
144	    &name) == 0);
145
146	show_vdev_stats(name, ZPOOL_CONFIG_CHILDREN, nvroot, 0);
147	show_vdev_stats(NULL, ZPOOL_CONFIG_L2CACHE, nvroot, 0);
148	show_vdev_stats(NULL, ZPOOL_CONFIG_SPARES, nvroot, 0);
149
150	nvlist_free(config);
151}
152
153/* *k_out must be freed by the caller */
154static int
155set_global_var_parse_kv(const char *arg, char **k_out, u_longlong_t *v_out)
156{
157	int err;
158	VERIFY(arg);
159	char *d = strdup(arg);
160
161	char *save = NULL;
162	char *k = strtok_r(d, "=", &save);
163	char *v_str = strtok_r(NULL, "=", &save);
164	char *follow = strtok_r(NULL, "=", &save);
165	if (k == NULL || v_str == NULL || follow != NULL) {
166		err = EINVAL;
167		goto err_free;
168	}
169
170	u_longlong_t val = strtoull(v_str, NULL, 0);
171	if (val > UINT32_MAX) {
172		fprintf(stderr, "Value for global variable '%s' must "
173		    "be a 32-bit unsigned integer, got '%s'\n", k, v_str);
174		err = EOVERFLOW;
175		goto err_free;
176	}
177
178	*k_out = strdup(k);
179	*v_out = val;
180	free(d);
181	return (0);
182
183err_free:
184	free(d);
185
186	return (err);
187}
188
189/*
190 * Sets given global variable in libzpool to given unsigned 32-bit value.
191 * arg: "<variable>=<value>"
192 */
193int
194set_global_var(char const *arg)
195{
196	void *zpoolhdl;
197	char *varname;
198	u_longlong_t val;
199	int ret;
200
201#ifndef _ZFS_LITTLE_ENDIAN
202	/*
203	 * On big endian systems changing a 64-bit variable would set the high
204	 * 32 bits instead of the low 32 bits, which could cause unexpected
205	 * results.
206	 */
207	fprintf(stderr, "Setting global variables is only supported on "
208	    "little-endian systems\n");
209	ret = ENOTSUP;
210	goto out_ret;
211#endif
212
213	if ((ret = set_global_var_parse_kv(arg, &varname, &val)) != 0) {
214		goto out_ret;
215	}
216
217	zpoolhdl = dlopen("libzpool.so", RTLD_LAZY);
218	if (zpoolhdl != NULL) {
219		uint32_t *var;
220		var = dlsym(zpoolhdl, varname);
221		if (var == NULL) {
222			fprintf(stderr, "Global variable '%s' does not exist "
223			    "in libzpool.so\n", varname);
224			ret = EINVAL;
225			goto out_dlclose;
226		}
227		*var = (uint32_t)val;
228
229	} else {
230		fprintf(stderr, "Failed to open libzpool.so to set global "
231		    "variable\n");
232		ret = EIO;
233		goto out_free;
234	}
235
236	ret = 0;
237
238out_dlclose:
239	dlclose(zpoolhdl);
240out_free:
241	free(varname);
242out_ret:
243	return (ret);
244}
245
246static nvlist_t *
247refresh_config(void *unused, nvlist_t *tryconfig)
248{
249	(void) unused;
250	return (spa_tryimport(tryconfig));
251}
252
253#if defined(__FreeBSD__)
254
255#include <sys/param.h>
256#include <sys/sysctl.h>
257#include <os/freebsd/zfs/sys/zfs_ioctl_compat.h>
258
259static int
260pool_active(void *unused, const char *name, uint64_t guid, boolean_t *isactive)
261{
262	(void) unused, (void) guid;
263	zfs_iocparm_t zp;
264	zfs_cmd_t *zc = NULL;
265#ifdef ZFS_LEGACY_SUPPORT
266	zfs_cmd_legacy_t *zcl = NULL;
267#endif
268	unsigned long request;
269	int ret;
270
271	int fd = open(ZFS_DEV, O_RDWR | O_CLOEXEC);
272	if (fd < 0)
273		return (-1);
274
275	/*
276	 * Use ZFS_IOC_POOL_STATS to check if the pool is active.  We want to
277	 * avoid adding a dependency on libzfs_core solely for this ioctl(),
278	 * therefore we manually craft the stats command.  Note that the command
279	 * ID is identical between the openzfs and legacy ioctl() formats.
280	 */
281	int ver = ZFS_IOCVER_NONE;
282	size_t ver_size = sizeof (ver);
283
284	sysctlbyname("vfs.zfs.version.ioctl", &ver, &ver_size, NULL, 0);
285
286	switch (ver) {
287	case ZFS_IOCVER_OZFS:
288		zc = umem_zalloc(sizeof (zfs_cmd_t), UMEM_NOFAIL);
289
290		(void) strlcpy(zc->zc_name, name, sizeof (zc->zc_name));
291		zp.zfs_cmd = (uint64_t)(uintptr_t)zc;
292		zp.zfs_cmd_size = sizeof (zfs_cmd_t);
293		zp.zfs_ioctl_version = ZFS_IOCVER_OZFS;
294
295		request = _IOWR('Z', ZFS_IOC_POOL_STATS, zfs_iocparm_t);
296		ret = ioctl(fd, request, &zp);
297
298		free((void *)(uintptr_t)zc->zc_nvlist_dst);
299		umem_free(zc, sizeof (zfs_cmd_t));
300
301		break;
302#ifdef ZFS_LEGACY_SUPPORT
303	case ZFS_IOCVER_LEGACY:
304		zcl = umem_zalloc(sizeof (zfs_cmd_legacy_t), UMEM_NOFAIL);
305
306		(void) strlcpy(zcl->zc_name, name, sizeof (zcl->zc_name));
307		zp.zfs_cmd = (uint64_t)(uintptr_t)zcl;
308		zp.zfs_cmd_size = sizeof (zfs_cmd_legacy_t);
309		zp.zfs_ioctl_version = ZFS_IOCVER_LEGACY;
310
311		request = _IOWR('Z', ZFS_IOC_POOL_STATS, zfs_iocparm_t);
312		ret = ioctl(fd, request, &zp);
313
314		free((void *)(uintptr_t)zcl->zc_nvlist_dst);
315		umem_free(zcl, sizeof (zfs_cmd_legacy_t));
316
317		break;
318#endif
319	default:
320		fprintf(stderr, "unrecognized zfs ioctl version %d", ver);
321		exit(1);
322	}
323
324	(void) close(fd);
325
326	*isactive = (ret == 0);
327
328	return (0);
329}
330#else
331static int
332pool_active(void *unused, const char *name, uint64_t guid,
333    boolean_t *isactive)
334{
335	(void) unused, (void) guid;
336	int fd = open(ZFS_DEV, O_RDWR | O_CLOEXEC);
337	if (fd < 0)
338		return (-1);
339
340	/*
341	 * Use ZFS_IOC_POOL_STATS to check if a pool is active.
342	 */
343	zfs_cmd_t *zcp = umem_zalloc(sizeof (zfs_cmd_t), UMEM_NOFAIL);
344	(void) strlcpy(zcp->zc_name, name, sizeof (zcp->zc_name));
345
346	int ret = ioctl(fd, ZFS_IOC_POOL_STATS, zcp);
347
348	free((void *)(uintptr_t)zcp->zc_nvlist_dst);
349	umem_free(zcp, sizeof (zfs_cmd_t));
350
351	(void) close(fd);
352
353	*isactive = (ret == 0);
354
355	return (0);
356}
357#endif
358
359pool_config_ops_t libzpool_config_ops = {
360	.pco_refresh_config = refresh_config,
361	.pco_pool_active = pool_active,
362};
363