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 2007 Sun Microsystems, Inc.  All rights reserved.
23 * Use is subject to license terms.
24 */
25
26#pragma ident	"%Z%%M%	%I%	%E% SMI"
27
28#include <solaris.h>
29#include <libintl.h>
30#include <libuutil.h>
31#include <stddef.h>
32#include <stdio.h>
33#include <stdlib.h>
34#include <strings.h>
35
36#include <libzfs.h>
37
38#include "zpool_util.h"
39
40/*
41 * Private interface for iterating over pools specified on the command line.
42 * Most consumers will call for_each_pool, but in order to support iostat, we
43 * allow fined grained control through the zpool_list_t interface.
44 */
45
46typedef struct zpool_node {
47	zpool_handle_t	*zn_handle;
48	uu_avl_node_t	zn_avlnode;
49	int		zn_mark;
50} zpool_node_t;
51
52struct zpool_list {
53	boolean_t	zl_findall;
54	uu_avl_t	*zl_avl;
55	uu_avl_pool_t	*zl_pool;
56	zprop_list_t	**zl_proplist;
57};
58
59/* ARGSUSED */
60static int
61zpool_compare(const void *larg, const void *rarg, void *unused)
62{
63	zpool_handle_t *l = ((zpool_node_t *)larg)->zn_handle;
64	zpool_handle_t *r = ((zpool_node_t *)rarg)->zn_handle;
65	const char *lname = zpool_get_name(l);
66	const char *rname = zpool_get_name(r);
67
68	return (strcmp(lname, rname));
69}
70
71/*
72 * Callback function for pool_list_get().  Adds the given pool to the AVL tree
73 * of known pools.
74 */
75static int
76add_pool(zpool_handle_t *zhp, void *data)
77{
78	zpool_list_t *zlp = data;
79	zpool_node_t *node = safe_malloc(sizeof (zpool_node_t));
80	uu_avl_index_t idx;
81
82	node->zn_handle = zhp;
83	uu_avl_node_init(node, &node->zn_avlnode, zlp->zl_pool);
84	if (uu_avl_find(zlp->zl_avl, node, NULL, &idx) == NULL) {
85		if (zlp->zl_proplist &&
86		    zpool_expand_proplist(zhp, zlp->zl_proplist) != 0) {
87			zpool_close(zhp);
88			free(node);
89			return (-1);
90		}
91		uu_avl_insert(zlp->zl_avl, node, idx);
92	} else {
93		zpool_close(zhp);
94		free(node);
95		return (-1);
96	}
97
98	return (0);
99}
100
101/*
102 * Create a list of pools based on the given arguments.  If we're given no
103 * arguments, then iterate over all pools in the system and add them to the AVL
104 * tree.  Otherwise, add only those pool explicitly specified on the command
105 * line.
106 */
107zpool_list_t *
108pool_list_get(int argc, char **argv, zprop_list_t **proplist, int *err)
109{
110	zpool_list_t *zlp;
111
112	zlp = safe_malloc(sizeof (zpool_list_t));
113
114	zlp->zl_pool = uu_avl_pool_create("zfs_pool", sizeof (zpool_node_t),
115	    offsetof(zpool_node_t, zn_avlnode), zpool_compare, UU_DEFAULT);
116
117	if (zlp->zl_pool == NULL)
118		zpool_no_memory();
119
120	if ((zlp->zl_avl = uu_avl_create(zlp->zl_pool, NULL,
121	    UU_DEFAULT)) == NULL)
122		zpool_no_memory();
123
124	zlp->zl_proplist = proplist;
125
126	if (argc == 0) {
127		(void) zpool_iter(g_zfs, add_pool, zlp);
128		zlp->zl_findall = B_TRUE;
129	} else {
130		int i;
131
132		for (i = 0; i < argc; i++) {
133			zpool_handle_t *zhp;
134
135			if (zhp = zpool_open_canfail(g_zfs, argv[i])) {
136				if (add_pool(zhp, zlp) != 0)
137					*err = B_TRUE;
138			} else {
139				*err = B_TRUE;
140			}
141		}
142	}
143
144	return (zlp);
145}
146
147/*
148 * Search for any new pools, adding them to the list.  We only add pools when no
149 * options were given on the command line.  Otherwise, we keep the list fixed as
150 * those that were explicitly specified.
151 */
152void
153pool_list_update(zpool_list_t *zlp)
154{
155	if (zlp->zl_findall)
156		(void) zpool_iter(g_zfs, add_pool, zlp);
157}
158
159/*
160 * Iterate over all pools in the list, executing the callback for each
161 */
162int
163pool_list_iter(zpool_list_t *zlp, int unavail, zpool_iter_f func,
164    void *data)
165{
166	zpool_node_t *node, *next_node;
167	int ret = 0;
168
169	for (node = uu_avl_first(zlp->zl_avl); node != NULL; node = next_node) {
170		next_node = uu_avl_next(zlp->zl_avl, node);
171		if (zpool_get_state(node->zn_handle) != POOL_STATE_UNAVAIL ||
172		    unavail)
173			ret |= func(node->zn_handle, data);
174	}
175
176	return (ret);
177}
178
179/*
180 * Remove the given pool from the list.  When running iostat, we want to remove
181 * those pools that no longer exist.
182 */
183void
184pool_list_remove(zpool_list_t *zlp, zpool_handle_t *zhp)
185{
186	zpool_node_t search, *node;
187
188	search.zn_handle = zhp;
189	if ((node = uu_avl_find(zlp->zl_avl, &search, NULL, NULL)) != NULL) {
190		uu_avl_remove(zlp->zl_avl, node);
191		zpool_close(node->zn_handle);
192		free(node);
193	}
194}
195
196/*
197 * Free all the handles associated with this list.
198 */
199void
200pool_list_free(zpool_list_t *zlp)
201{
202	uu_avl_walk_t *walk;
203	zpool_node_t *node;
204
205	if ((walk = uu_avl_walk_start(zlp->zl_avl, UU_WALK_ROBUST)) == NULL) {
206		(void) fprintf(stderr,
207		    gettext("internal error: out of memory"));
208		exit(1);
209	}
210
211	while ((node = uu_avl_walk_next(walk)) != NULL) {
212		uu_avl_remove(zlp->zl_avl, node);
213		zpool_close(node->zn_handle);
214		free(node);
215	}
216
217	uu_avl_walk_end(walk);
218	uu_avl_destroy(zlp->zl_avl);
219	uu_avl_pool_destroy(zlp->zl_pool);
220
221	free(zlp);
222}
223
224/*
225 * Returns the number of elements in the pool list.
226 */
227int
228pool_list_count(zpool_list_t *zlp)
229{
230	return (uu_avl_numnodes(zlp->zl_avl));
231}
232
233/*
234 * High level function which iterates over all pools given on the command line,
235 * using the pool_list_* interfaces.
236 */
237int
238for_each_pool(int argc, char **argv, boolean_t unavail,
239    zprop_list_t **proplist, zpool_iter_f func, void *data)
240{
241	zpool_list_t *list;
242	int ret = 0;
243
244	if ((list = pool_list_get(argc, argv, proplist, &ret)) == NULL)
245		return (1);
246
247	if (pool_list_iter(list, unavail, func, data) != 0)
248		ret = 1;
249
250	pool_list_free(list);
251
252	return (ret);
253}
254