xref: /titanic_51/usr/src/lib/fm/libfmd_snmp/common/module.c (revision 545758327e65fa2c3d514152f4c010e8faddfa6d)
1749f21d3Swesolows /*
2749f21d3Swesolows  * CDDL HEADER START
3749f21d3Swesolows  *
4749f21d3Swesolows  * The contents of this file are subject to the terms of the
5749f21d3Swesolows  * Common Development and Distribution License (the "License").
6749f21d3Swesolows  * You may not use this file except in compliance with the License.
7749f21d3Swesolows  *
8749f21d3Swesolows  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9749f21d3Swesolows  * or http://www.opensolaris.org/os/licensing.
10749f21d3Swesolows  * See the License for the specific language governing permissions
11749f21d3Swesolows  * and limitations under the License.
12749f21d3Swesolows  *
13749f21d3Swesolows  * When distributing Covered Code, include this CDDL HEADER in each
14749f21d3Swesolows  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15749f21d3Swesolows  * If applicable, add the following below this CDDL HEADER, with the
16749f21d3Swesolows  * fields enclosed by brackets "[]" replaced with your own identifying
17749f21d3Swesolows  * information: Portions Copyright [yyyy] [name of copyright owner]
18749f21d3Swesolows  *
19749f21d3Swesolows  * CDDL HEADER END
20749f21d3Swesolows  */
21749f21d3Swesolows 
22749f21d3Swesolows /*
23888e0559SRobert Johnston  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
24749f21d3Swesolows  * Use is subject to license terms.
25749f21d3Swesolows  */
26749f21d3Swesolows 
27749f21d3Swesolows #include <fm/fmd_adm.h>
28749f21d3Swesolows #include <fm/fmd_snmp.h>
29749f21d3Swesolows #include <net-snmp/net-snmp-config.h>
30749f21d3Swesolows #include <net-snmp/net-snmp-includes.h>
31749f21d3Swesolows #include <net-snmp/agent/net-snmp-agent-includes.h>
32749f21d3Swesolows #include <pthread.h>
33749f21d3Swesolows #include <stddef.h>
34749f21d3Swesolows #include <errno.h>
35749f21d3Swesolows #include <libuutil.h>
36749f21d3Swesolows #include "sunFM_impl.h"
37749f21d3Swesolows #include "module.h"
38749f21d3Swesolows 
39749f21d3Swesolows static uu_avl_pool_t	*mod_name_avl_pool;
40749f21d3Swesolows static uu_avl_pool_t	*mod_index_avl_pool;
41749f21d3Swesolows static uu_avl_t		*mod_name_avl;
42749f21d3Swesolows static uu_avl_t		*mod_index_avl;
43749f21d3Swesolows 
44749f21d3Swesolows #define	VALID_AVL_STATE	(mod_name_avl_pool != NULL &&		\
45749f21d3Swesolows 	mod_index_avl_pool != NULL && mod_name_avl != NULL &&	\
46749f21d3Swesolows 	mod_index_avl != NULL)
47749f21d3Swesolows 
48749f21d3Swesolows #define	UPDATE_WAIT_MILLIS	10	/* poll interval in milliseconds */
49749f21d3Swesolows 
50749f21d3Swesolows /*
51749f21d3Swesolows  * Update types.  Single-index and all are mutually exclusive.
52749f21d3Swesolows  */
53749f21d3Swesolows #define	UCT_INDEX	0x1
54749f21d3Swesolows #define	UCT_ALL		0x2
55749f21d3Swesolows #define	UCT_FLAGS	0x3
56749f21d3Swesolows 
57749f21d3Swesolows #define	MODULE_DATA_VALID(d)	((d)->d_valid == valid_stamp)
58749f21d3Swesolows 
59749f21d3Swesolows /*
60749f21d3Swesolows  * Locking rules are straightforward.  There is only one updater thread
61749f21d3Swesolows  * for each table, and requests for update that are received while
62749f21d3Swesolows  * another update is in progress are ignored.  The single per-table lock
63749f21d3Swesolows  * protects all the data for the table, the valid_stamp and max_index
64749f21d3Swesolows  * tags for new data, and - importantly - all the hidden static data
65749f21d3Swesolows  * used by the Net-SNMP library.  The result return callbacks are always
66749f21d3Swesolows  * called in the master agent thread; holding the table lock is
67749f21d3Swesolows  * therefore sufficient since only one table's callback can be run at
68749f21d3Swesolows  * any one time.  Finer-grained locking is possible here but
69749f21d3Swesolows  * substantially more difficult because nearly all Net-SNMP functions
70749f21d3Swesolows  * are unsafe.
71749f21d3Swesolows  *
72749f21d3Swesolows  * In practice this is more than adequate, since the purpose of
73749f21d3Swesolows  * threading out the update is to prevent excessively time-consuming
74749f21d3Swesolows  * data collection from bottlenecking the entire agent, not to improve
75749f21d3Swesolows  * result throughput (SNMP is not intended to be used for applications
76749f21d3Swesolows  * requiring high throughput anyway).  If the agent itself ever becomes
77749f21d3Swesolows  * multithreaded, locking requirements become limited to our local
78749f21d3Swesolows  * per-table data (the tree, max_index, and valid_stamp), and the
79749f21d3Swesolows  * implementation could be revisited for better performance.
80749f21d3Swesolows  */
81749f21d3Swesolows 
82749f21d3Swesolows static ulong_t		max_index;
83749f21d3Swesolows static int		valid_stamp;
84749f21d3Swesolows static pthread_mutex_t	update_lock;
85749f21d3Swesolows static pthread_cond_t	update_cv;
86749f21d3Swesolows static volatile enum { US_QUIET, US_NEEDED, US_INPROGRESS } update_status;
87749f21d3Swesolows 
88749f21d3Swesolows static Netsnmp_Node_Handler	sunFmModuleTable_handler;
89749f21d3Swesolows 
90749f21d3Swesolows static sunFmModule_data_t *
91749f21d3Swesolows key_build(const char *name, const ulong_t index)
92749f21d3Swesolows {
93749f21d3Swesolows 	static sunFmModule_data_t	key;
94749f21d3Swesolows 
95749f21d3Swesolows 	key.d_index = index;
96749f21d3Swesolows 	if (name)
9730698f33Swesolows 		(void) strlcpy(key.d_ami_name, name, sizeof (key.d_ami_name));
98749f21d3Swesolows 	else
99749f21d3Swesolows 		key.d_ami_name[0] = '\0';
100749f21d3Swesolows 
101749f21d3Swesolows 	return (&key);
102749f21d3Swesolows }
103749f21d3Swesolows 
104749f21d3Swesolows /*
105749f21d3Swesolows  * If name is the name of a module we have previously seen and indexed, return
106749f21d3Swesolows  * data for it.  Otherwise, return NULL.  Note that the module may not be
107749f21d3Swesolows  * valid; that is, it may have been removed from the fault manager since its
108749f21d3Swesolows  * information was last updated.
109749f21d3Swesolows  */
110749f21d3Swesolows static sunFmModule_data_t *
111749f21d3Swesolows module_lookup_name(const char *name)
112749f21d3Swesolows {
113749f21d3Swesolows 	sunFmModule_data_t	*key;
114749f21d3Swesolows 
115749f21d3Swesolows 	key = key_build(name, 0);
116749f21d3Swesolows 	return (uu_avl_find(mod_name_avl, key, NULL, NULL));
117749f21d3Swesolows }
118749f21d3Swesolows 
119749f21d3Swesolows /*
120749f21d3Swesolows  * If index corresponds to a module we have previously seen and indexed, return
121749f21d3Swesolows  * data for it.  Otherwise, return NULL.  Note that the module may not be
122749f21d3Swesolows  * valid; that is, it may have been removed from the fault manager since its
123749f21d3Swesolows  * information was last updated.
124749f21d3Swesolows  */
125749f21d3Swesolows static sunFmModule_data_t *
126749f21d3Swesolows module_lookup_index_exact(const ulong_t index)
127749f21d3Swesolows {
128749f21d3Swesolows 	sunFmModule_data_t	*key;
129749f21d3Swesolows 
130749f21d3Swesolows 	key = key_build(NULL, index);
131749f21d3Swesolows 	return (uu_avl_find(mod_index_avl, key, NULL, NULL));
132749f21d3Swesolows }
133749f21d3Swesolows 
134749f21d3Swesolows /*
135749f21d3Swesolows  * If index corresponds to a valid (that is, extant as of latest information
136749f21d3Swesolows  * from the fault manager) fmd module, return the data for that module.
137749f21d3Swesolows  * Otherwise, return the data for the valid module whose index is as close as
138749f21d3Swesolows  * possible to index but not lower.  This preserves the lexicographical
139749f21d3Swesolows  * ordering required for GETNEXT processing.
140749f21d3Swesolows  */
141749f21d3Swesolows static sunFmModule_data_t *
142749f21d3Swesolows module_lookup_index_nextvalid(const ulong_t index)
143749f21d3Swesolows {
144749f21d3Swesolows 	sunFmModule_data_t	*key, *data;
145749f21d3Swesolows 	uu_avl_index_t		idx;
146749f21d3Swesolows 
147749f21d3Swesolows 	key = key_build(NULL, index);
148749f21d3Swesolows 
149749f21d3Swesolows 	if ((data = uu_avl_find(mod_index_avl, key, NULL, &idx)) != NULL &&
150749f21d3Swesolows 	    MODULE_DATA_VALID(data))
151749f21d3Swesolows 		return (data);
152749f21d3Swesolows 
153749f21d3Swesolows 	data = uu_avl_nearest_next(mod_index_avl, idx);
154749f21d3Swesolows 
1551fe76c0bSwesolows 	while (data != NULL && !MODULE_DATA_VALID(data))
1561fe76c0bSwesolows 		data = uu_avl_next(mod_index_avl, data);
157749f21d3Swesolows 
158749f21d3Swesolows 	return (data);
159749f21d3Swesolows }
160749f21d3Swesolows 
161749f21d3Swesolows /*
162749f21d3Swesolows  * Possible update the contents of a single module within the cache.  This
163749f21d3Swesolows  * is our callback from fmd_module_iter.
164749f21d3Swesolows  */
165749f21d3Swesolows static int
166749f21d3Swesolows modinfo_update_one(const fmd_adm_modinfo_t *modinfo, void *arg)
167749f21d3Swesolows {
168749f21d3Swesolows 	const sunFmModule_update_ctx_t *update_ctx =
169749f21d3Swesolows 	    (sunFmModule_update_ctx_t *)arg;
170749f21d3Swesolows 	sunFmModule_data_t *data = module_lookup_name(modinfo->ami_name);
171749f21d3Swesolows 
172749f21d3Swesolows 	/*
173749f21d3Swesolows 	 * An fmd module we haven't seen before.  We're obligated to index
174749f21d3Swesolows 	 * it and link it into our cache so that we can find it, but we're
175749f21d3Swesolows 	 * not obligated to fill it in completely unless we're doing a
176749f21d3Swesolows 	 * thorough update or this is the module we were asked for.  This
177749f21d3Swesolows 	 * avoids unnecessary iteration and memory manipulation for data
178749f21d3Swesolows 	 * we're not going to return for this request.
179749f21d3Swesolows 	 */
180749f21d3Swesolows 	if (data == NULL) {
181749f21d3Swesolows 		uu_avl_index_t idx;
182749f21d3Swesolows 
183749f21d3Swesolows 		DEBUGMSGTL((MODNAME_STR, "found new fmd module %s\n",
184749f21d3Swesolows 		    modinfo->ami_name));
185749f21d3Swesolows 		if ((data = SNMP_MALLOC_TYPEDEF(sunFmModule_data_t)) == NULL) {
186888e0559SRobert Johnston 			(void) snmp_log(LOG_ERR, MODNAME_STR ": Out of memory "
187888e0559SRobert Johnston 			    "for new module data at %s:%d\n", __FILE__,
188888e0559SRobert Johnston 			    __LINE__);
189749f21d3Swesolows 			return (1);
190749f21d3Swesolows 		}
191749f21d3Swesolows 		/*
192749f21d3Swesolows 		 * We allocate indices sequentially and never reuse them.
193749f21d3Swesolows 		 * This ensures we can always return valid GETNEXT responses
194749f21d3Swesolows 		 * without having to reindex, and it provides the user a
195749f21d3Swesolows 		 * more consistent view of the fault manager.
196749f21d3Swesolows 		 */
197749f21d3Swesolows 		data->d_index = ++max_index;
198749f21d3Swesolows 		DEBUGMSGTL((MODNAME_STR, "index %lu is %s@%p\n", data->d_index,
199749f21d3Swesolows 		    modinfo->ami_name, data));
200749f21d3Swesolows 
20130698f33Swesolows 		(void) strlcpy(data->d_ami_name, modinfo->ami_name,
202749f21d3Swesolows 		    sizeof (data->d_ami_name));
203749f21d3Swesolows 
204749f21d3Swesolows 		uu_avl_node_init(data, &data->d_name_avl, mod_name_avl_pool);
205749f21d3Swesolows 		(void) uu_avl_find(mod_name_avl, data, NULL, &idx);
206749f21d3Swesolows 		uu_avl_insert(mod_name_avl, data, idx);
207749f21d3Swesolows 
208749f21d3Swesolows 		uu_avl_node_init(data, &data->d_index_avl, mod_index_avl_pool);
209749f21d3Swesolows 		(void) uu_avl_find(mod_index_avl, data, NULL, &idx);
210749f21d3Swesolows 		uu_avl_insert(mod_index_avl, data, idx);
211749f21d3Swesolows 
212749f21d3Swesolows 		DEBUGMSGTL((MODNAME_STR, "completed new module %lu/%s@%p\n",
213749f21d3Swesolows 		    data->d_index, data->d_ami_name, data));
214749f21d3Swesolows 	}
215749f21d3Swesolows 
216749f21d3Swesolows 	data->d_valid = valid_stamp;
217749f21d3Swesolows 
218*54575832SDan McDonald 	DEBUGMSGTL((MODNAME_STR, "timestamp updated for %lu/%s@%p: %d\n",
219749f21d3Swesolows 	    data->d_index, data->d_ami_name, data, data->d_valid));
220749f21d3Swesolows 
221749f21d3Swesolows 	if ((update_ctx->uc_type & UCT_ALL) ||
222749f21d3Swesolows 	    update_ctx->uc_index == data->d_index) {
22330698f33Swesolows 		(void) strlcpy(data->d_ami_vers, modinfo->ami_vers,
224749f21d3Swesolows 		    sizeof (data->d_ami_vers));
22530698f33Swesolows 		(void) strlcpy(data->d_ami_desc, modinfo->ami_desc,
226749f21d3Swesolows 		    sizeof (data->d_ami_desc));
227749f21d3Swesolows 		data->d_ami_flags = modinfo->ami_flags;
228749f21d3Swesolows 	}
229749f21d3Swesolows 
230749f21d3Swesolows 	return (!(update_ctx->uc_type & UCT_ALL) &&
231749f21d3Swesolows 	    update_ctx->uc_index == data->d_index);
232749f21d3Swesolows }
233749f21d3Swesolows 
234749f21d3Swesolows /*
235749f21d3Swesolows  * Update some or all module data from fmd.  If thorough is set, all modules
236749f21d3Swesolows  * will be indexed and their data cached.  Otherwise, updates will stop once
237749f21d3Swesolows  * the module matching index has been updated.
238749f21d3Swesolows  *
239749f21d3Swesolows  * Returns appropriate SNMP error codes.
240749f21d3Swesolows  */
241749f21d3Swesolows static int
242749f21d3Swesolows modinfo_update(sunFmModule_update_ctx_t *update_ctx)
243749f21d3Swesolows {
244749f21d3Swesolows 	fmd_adm_t *adm;
245749f21d3Swesolows 
246749f21d3Swesolows 	ASSERT(update_ctx != NULL);
247749f21d3Swesolows 	ASSERT((update_ctx->uc_type & (UCT_INDEX|UCT_ALL)) !=
248749f21d3Swesolows 	    (UCT_INDEX|UCT_ALL));
249749f21d3Swesolows 	ASSERT((update_ctx->uc_type & ~UCT_FLAGS) == 0);
250749f21d3Swesolows 	ASSERT(VALID_AVL_STATE);
251749f21d3Swesolows 
252749f21d3Swesolows 	if ((adm = fmd_adm_open(update_ctx->uc_host, update_ctx->uc_prog,
253749f21d3Swesolows 	    update_ctx->uc_version)) == NULL) {
254888e0559SRobert Johnston 		(void) snmp_log(LOG_ERR, MODNAME_STR ": Communication with fmd "
255749f21d3Swesolows 		    "failed: %s\n", strerror(errno));
256749f21d3Swesolows 		return (SNMP_ERR_RESOURCEUNAVAILABLE);
257749f21d3Swesolows 	}
258749f21d3Swesolows 
259749f21d3Swesolows 	++valid_stamp;
260749f21d3Swesolows 	if (fmd_adm_module_iter(adm, modinfo_update_one, update_ctx) != 0) {
261888e0559SRobert Johnston 		(void) snmp_log(LOG_ERR, MODNAME_STR ": fmd module information "
262888e0559SRobert Johnston 		    "update failed: %s\n", fmd_adm_errmsg(adm));
263749f21d3Swesolows 		fmd_adm_close(adm);
264749f21d3Swesolows 		return (SNMP_ERR_RESOURCEUNAVAILABLE);
265749f21d3Swesolows 	}
266749f21d3Swesolows 
267749f21d3Swesolows 	DEBUGMSGTL((MODNAME_STR, "module iteration completed\n"));
268749f21d3Swesolows 
269749f21d3Swesolows 	fmd_adm_close(adm);
270749f21d3Swesolows 	return (SNMP_ERR_NOERROR);
271749f21d3Swesolows }
272749f21d3Swesolows 
273749f21d3Swesolows /*ARGSUSED*/
274749f21d3Swesolows static void
275749f21d3Swesolows update_thread(void *arg)
276749f21d3Swesolows {
277749f21d3Swesolows 	/*
278749f21d3Swesolows 	 * The current modinfo_update implementation offers minimal savings
279749f21d3Swesolows 	 * for the use of index-only updates; therefore we always do a full
280749f21d3Swesolows 	 * update.  If it becomes advantageous to limit updates to a single
281749f21d3Swesolows 	 * index, the contexts can be queued by the handler instead.
282749f21d3Swesolows 	 */
283749f21d3Swesolows 	sunFmModule_update_ctx_t	uc;
284749f21d3Swesolows 
285749f21d3Swesolows 	uc.uc_host = NULL;
286749f21d3Swesolows 	uc.uc_prog = FMD_ADM_PROGRAM;
287749f21d3Swesolows 	uc.uc_version = FMD_ADM_VERSION;
288749f21d3Swesolows 
289749f21d3Swesolows 	uc.uc_index = 0;
290749f21d3Swesolows 	uc.uc_type = UCT_ALL;
291749f21d3Swesolows 
292749f21d3Swesolows 	for (;;) {
293749f21d3Swesolows 		(void) pthread_mutex_lock(&update_lock);
294749f21d3Swesolows 		update_status = US_QUIET;
295749f21d3Swesolows 		while (update_status == US_QUIET)
296749f21d3Swesolows 			(void) pthread_cond_wait(&update_cv, &update_lock);
297749f21d3Swesolows 		update_status = US_INPROGRESS;
298749f21d3Swesolows 		(void) pthread_mutex_unlock(&update_lock);
299749f21d3Swesolows 		(void) modinfo_update(&uc);
300749f21d3Swesolows 	}
301749f21d3Swesolows }
302749f21d3Swesolows 
303749f21d3Swesolows static void
304749f21d3Swesolows request_update(void)
305749f21d3Swesolows {
306749f21d3Swesolows 	(void) pthread_mutex_lock(&update_lock);
307749f21d3Swesolows 	if (update_status != US_QUIET) {
308749f21d3Swesolows 		(void) pthread_mutex_unlock(&update_lock);
309749f21d3Swesolows 		return;
310749f21d3Swesolows 	}
311749f21d3Swesolows 	update_status = US_NEEDED;
312749f21d3Swesolows 	(void) pthread_cond_signal(&update_cv);
313749f21d3Swesolows 	(void) pthread_mutex_unlock(&update_lock);
314749f21d3Swesolows }
315749f21d3Swesolows 
316749f21d3Swesolows /*ARGSUSED*/
317749f21d3Swesolows static int
318749f21d3Swesolows module_compare_name(const void *l, const void *r, void *private)
319749f21d3Swesolows {
320749f21d3Swesolows 	sunFmModule_data_t	*l_data = (sunFmModule_data_t *)l;
321749f21d3Swesolows 	sunFmModule_data_t	*r_data = (sunFmModule_data_t *)r;
322749f21d3Swesolows 
323749f21d3Swesolows 	ASSERT(l_data != NULL && r_data != NULL);
324749f21d3Swesolows 
325749f21d3Swesolows 	return (strcmp(l_data->d_ami_name, r_data->d_ami_name));
326749f21d3Swesolows }
327749f21d3Swesolows 
328749f21d3Swesolows /*ARGSUSED*/
329749f21d3Swesolows static int
330749f21d3Swesolows module_compare_index(const void *l, const void *r, void *private)
331749f21d3Swesolows {
332749f21d3Swesolows 	sunFmModule_data_t	*l_data = (sunFmModule_data_t *)l;
333749f21d3Swesolows 	sunFmModule_data_t	*r_data = (sunFmModule_data_t *)r;
334749f21d3Swesolows 
335749f21d3Swesolows 	ASSERT(l_data != NULL && r_data != NULL);
336749f21d3Swesolows 
337749f21d3Swesolows 	return (l_data->d_index < r_data->d_index ? -1 :
338749f21d3Swesolows 	    l_data->d_index > r_data->d_index ? 1 : 0);
339749f21d3Swesolows }
340749f21d3Swesolows 
341749f21d3Swesolows int
342749f21d3Swesolows sunFmModuleTable_init(void)
343749f21d3Swesolows {
344749f21d3Swesolows 	static oid sunFmModuleTable_oid[] = { SUNFMMODULETABLE_OID };
345749f21d3Swesolows 	netsnmp_table_registration_info *table_info;
346749f21d3Swesolows 	netsnmp_handler_registration *handler;
347749f21d3Swesolows 	int err;
348749f21d3Swesolows 
349749f21d3Swesolows 	if ((err = pthread_mutex_init(&update_lock, NULL)) != 0) {
350888e0559SRobert Johnston 		(void) snmp_log(LOG_ERR, MODNAME_STR ": mutex_init failure: "
351888e0559SRobert Johnston 		    "%s\n", strerror(err));
352749f21d3Swesolows 		return (MIB_REGISTRATION_FAILED);
353749f21d3Swesolows 	}
354749f21d3Swesolows 	if ((err = pthread_cond_init(&update_cv, NULL)) != 0) {
355888e0559SRobert Johnston 		(void) snmp_log(LOG_ERR, MODNAME_STR ": cond_init failure: "
356888e0559SRobert Johnston 		    "%s\n", strerror(err));
357749f21d3Swesolows 		return (MIB_REGISTRATION_FAILED);
358749f21d3Swesolows 	}
359749f21d3Swesolows 
360749f21d3Swesolows 	if ((err = pthread_create(NULL, NULL, (void *(*)(void *))update_thread,
361749f21d3Swesolows 	    NULL)) != 0) {
362888e0559SRobert Johnston 		(void) snmp_log(LOG_ERR, MODNAME_STR ": error creating update "
363749f21d3Swesolows 		    "thread: %s\n", strerror(err));
364749f21d3Swesolows 		return (MIB_REGISTRATION_FAILED);
365749f21d3Swesolows 	}
366749f21d3Swesolows 
367749f21d3Swesolows 	if ((table_info =
368749f21d3Swesolows 	    SNMP_MALLOC_TYPEDEF(netsnmp_table_registration_info)) == NULL)
369749f21d3Swesolows 		return (MIB_REGISTRATION_FAILED);
370749f21d3Swesolows 
371749f21d3Swesolows 	if ((handler = netsnmp_create_handler_registration("sunFmModuleTable",
372749f21d3Swesolows 	    sunFmModuleTable_handler, sunFmModuleTable_oid,
373749f21d3Swesolows 	    OID_LENGTH(sunFmModuleTable_oid), HANDLER_CAN_RONLY)) == NULL) {
374749f21d3Swesolows 		SNMP_FREE(table_info);
375749f21d3Swesolows 		return (MIB_REGISTRATION_FAILED);
376749f21d3Swesolows 	}
377749f21d3Swesolows 
378749f21d3Swesolows 	/*
379749f21d3Swesolows 	 * The Net-SNMP template uses add_indexes here, but that
380749f21d3Swesolows 	 * function is unsafe because it does not check for failure.
381749f21d3Swesolows 	 */
382749f21d3Swesolows 	if (netsnmp_table_helper_add_index(table_info, ASN_UNSIGNED) == NULL) {
383749f21d3Swesolows 		SNMP_FREE(table_info);
384749f21d3Swesolows 		SNMP_FREE(handler);
385749f21d3Swesolows 		return (MIB_REGISTRATION_FAILED);
386749f21d3Swesolows 	}
387749f21d3Swesolows 
388749f21d3Swesolows 	table_info->min_column = SUNFMMODULE_COLMIN;
389749f21d3Swesolows 	table_info->max_column = SUNFMMODULE_COLMAX;
390749f21d3Swesolows 
391749f21d3Swesolows 	if ((mod_name_avl_pool = uu_avl_pool_create("mod_name",
392749f21d3Swesolows 	    sizeof (sunFmModule_data_t),
393749f21d3Swesolows 	    offsetof(sunFmModule_data_t, d_name_avl), module_compare_name,
394749f21d3Swesolows 	    UU_AVL_DEBUG)) == NULL) {
395749f21d3Swesolows 		snmp_free_varbind(table_info->indexes);
396749f21d3Swesolows 		SNMP_FREE(table_info);
397749f21d3Swesolows 		SNMP_FREE(handler);
398749f21d3Swesolows 	}
399749f21d3Swesolows 
400749f21d3Swesolows 	if ((mod_name_avl = uu_avl_create(mod_name_avl_pool, NULL,
401749f21d3Swesolows 	    UU_AVL_DEBUG)) == NULL) {
402888e0559SRobert Johnston 		(void) snmp_log(LOG_ERR, MODNAME_STR ": mod_name_avl creation "
403749f21d3Swesolows 		    "failed: %s\n", uu_strerror(uu_error()));
404749f21d3Swesolows 		snmp_free_varbind(table_info->indexes);
405749f21d3Swesolows 		SNMP_FREE(table_info);
406749f21d3Swesolows 		SNMP_FREE(handler);
407749f21d3Swesolows 		uu_avl_pool_destroy(mod_name_avl_pool);
408749f21d3Swesolows 		return (MIB_REGISTRATION_FAILED);
409749f21d3Swesolows 	}
410749f21d3Swesolows 
411749f21d3Swesolows 	if ((mod_index_avl_pool = uu_avl_pool_create("mod_index",
412749f21d3Swesolows 	    sizeof (sunFmModule_data_t),
413749f21d3Swesolows 	    offsetof(sunFmModule_data_t, d_index_avl),
414749f21d3Swesolows 	    module_compare_index, UU_AVL_DEBUG)) == NULL) {
415749f21d3Swesolows 		snmp_free_varbind(table_info->indexes);
416749f21d3Swesolows 		SNMP_FREE(table_info);
417749f21d3Swesolows 		SNMP_FREE(handler);
418749f21d3Swesolows 		uu_avl_destroy(mod_name_avl);
419749f21d3Swesolows 		uu_avl_pool_destroy(mod_name_avl_pool);
420749f21d3Swesolows 	}
421749f21d3Swesolows 
422749f21d3Swesolows 	if ((mod_index_avl = uu_avl_create(mod_index_avl_pool, NULL,
423749f21d3Swesolows 	    UU_AVL_DEBUG)) == NULL) {
424888e0559SRobert Johnston 		(void) snmp_log(LOG_ERR, MODNAME_STR ": mod_index_avl creation "
425749f21d3Swesolows 		    "failed: %s\n", uu_strerror(uu_error()));
426749f21d3Swesolows 		snmp_free_varbind(table_info->indexes);
427749f21d3Swesolows 		SNMP_FREE(table_info);
428749f21d3Swesolows 		SNMP_FREE(handler);
429749f21d3Swesolows 		uu_avl_destroy(mod_name_avl);
430749f21d3Swesolows 		uu_avl_pool_destroy(mod_name_avl_pool);
431749f21d3Swesolows 		uu_avl_pool_destroy(mod_index_avl_pool);
432749f21d3Swesolows 		return (MIB_REGISTRATION_FAILED);
433749f21d3Swesolows 	}
434749f21d3Swesolows 
435749f21d3Swesolows 	if ((err = netsnmp_register_table(handler, table_info)) !=
436749f21d3Swesolows 	    MIB_REGISTERED_OK) {
437749f21d3Swesolows 		snmp_free_varbind(table_info->indexes);
438749f21d3Swesolows 		SNMP_FREE(table_info);
439749f21d3Swesolows 		SNMP_FREE(handler);
440749f21d3Swesolows 		uu_avl_destroy(mod_name_avl);
441749f21d3Swesolows 		uu_avl_pool_destroy(mod_name_avl_pool);
442749f21d3Swesolows 		uu_avl_destroy(mod_index_avl);
443749f21d3Swesolows 		uu_avl_pool_destroy(mod_index_avl_pool);
444749f21d3Swesolows 		return (err);
445749f21d3Swesolows 	}
446749f21d3Swesolows 
447749f21d3Swesolows 	return (MIB_REGISTERED_OK);
448749f21d3Swesolows }
449749f21d3Swesolows 
450749f21d3Swesolows /*
451749f21d3Swesolows  * These two functions form the core of GET/GETNEXT/GETBULK handling (the
452749f21d3Swesolows  * only kind we do).  They perform two functions:
453749f21d3Swesolows  *
454749f21d3Swesolows  * - First, frob the request to set all the index variables to correspond
455749f21d3Swesolows  *   to the value that's going to be returned.  For GET, this is a nop;
456749f21d3Swesolows  *   for GETNEXT/GETBULK it always requires some work.
457749f21d3Swesolows  * - Second, find and return the fmd module information corresponding to
458749f21d3Swesolows  *   the (possibly updated) indices.
459749f21d3Swesolows  *
460749f21d3Swesolows  * These should be as fast as possible; they run in the agent thread.
461749f21d3Swesolows  */
462749f21d3Swesolows static sunFmModule_data_t *
463749f21d3Swesolows sunFmModuleTable_nextmod(netsnmp_handler_registration *reginfo,
464749f21d3Swesolows     netsnmp_table_request_info *table_info)
465749f21d3Swesolows {
466749f21d3Swesolows 	sunFmModule_data_t	*data;
467749f21d3Swesolows 	netsnmp_variable_list	*var;
468749f21d3Swesolows 	ulong_t index;
469749f21d3Swesolows 
470749f21d3Swesolows 	/*
471749f21d3Swesolows 	 * If we have no index, we must make one.
472749f21d3Swesolows 	 */
473749f21d3Swesolows 	if (table_info->number_indexes < 1) {
474749f21d3Swesolows 		oid tmpoid[MAX_OID_LEN];
475749f21d3Swesolows 		index = 1;
476749f21d3Swesolows 
477749f21d3Swesolows 		DEBUGMSGTL((MODNAME_STR, "nextmod: no indexes given\n"));
478749f21d3Swesolows 		var = SNMP_MALLOC_TYPEDEF(netsnmp_variable_list);
479888e0559SRobert Johnston 		(void) snmp_set_var_typed_value(var, ASN_UNSIGNED,
480888e0559SRobert Johnston 		    (uchar_t *)&index, sizeof (index));
48130698f33Swesolows 		(void) memcpy(tmpoid, reginfo->rootoid,
482749f21d3Swesolows 		    reginfo->rootoid_len * sizeof (oid));
483749f21d3Swesolows 		tmpoid[reginfo->rootoid_len] = 1;	/* Entry is .1 */
484749f21d3Swesolows 		tmpoid[reginfo->rootoid_len + 1] = table_info->colnum;
485749f21d3Swesolows 		if (build_oid(&var->name, &var->name_length, tmpoid,
48630698f33Swesolows 		    reginfo->rootoid_len + 2, var) != SNMPERR_SUCCESS) {
48730698f33Swesolows 			snmp_free_varbind(var);
488749f21d3Swesolows 			return (NULL);
48930698f33Swesolows 		}
490749f21d3Swesolows 		DEBUGMSGTL((MODNAME_STR, "nextmod: built fake index:\n"));
491749f21d3Swesolows 		DEBUGMSGVAR((MODNAME_STR, var));
492749f21d3Swesolows 		DEBUGMSG((MODNAME_STR, "\n"));
493749f21d3Swesolows 	} else {
49430698f33Swesolows 		var = snmp_clone_varbind(table_info->indexes);
495749f21d3Swesolows 		index = *var->val.integer;
496749f21d3Swesolows 		DEBUGMSGTL((MODNAME_STR, "nextmod: received index:\n"));
497749f21d3Swesolows 		DEBUGMSGVAR((MODNAME_STR, var));
498749f21d3Swesolows 		DEBUGMSG((MODNAME_STR, "\n"));
499749f21d3Swesolows 		index++;
500749f21d3Swesolows 	}
501749f21d3Swesolows 
50230698f33Swesolows 	snmp_free_varbind(table_info->indexes);
50330698f33Swesolows 	table_info->indexes = NULL;
50430698f33Swesolows 	table_info->number_indexes = 0;
50530698f33Swesolows 
506749f21d3Swesolows 	if ((data = module_lookup_index_nextvalid(index)) == NULL) {
507749f21d3Swesolows 		DEBUGMSGTL((MODNAME_STR, "nextmod: exact match not found for "
508749f21d3Swesolows 		    "index %lu; trying next column\n", index));
50930698f33Swesolows 		if (table_info->colnum >=
51030698f33Swesolows 		    netsnmp_find_table_registration_info(reginfo)->max_column) {
511749f21d3Swesolows 			snmp_free_varbind(var);
512749f21d3Swesolows 			DEBUGMSGTL((MODNAME_STR, "nextmod: out of columns\n"));
513749f21d3Swesolows 			return (NULL);
514749f21d3Swesolows 		}
515749f21d3Swesolows 		table_info->colnum++;
516749f21d3Swesolows 		index = 1;
517749f21d3Swesolows 
518749f21d3Swesolows 		data = module_lookup_index_nextvalid(index);
519749f21d3Swesolows 	}
520749f21d3Swesolows 
521749f21d3Swesolows 	if (data == NULL) {
522749f21d3Swesolows 		DEBUGMSGTL((MODNAME_STR, "nextmod: exact match not found for "
523749f21d3Swesolows 		    "index %lu; stopping\n", index));
524749f21d3Swesolows 		snmp_free_varbind(var);
525749f21d3Swesolows 		return (NULL);
526749f21d3Swesolows 	}
527749f21d3Swesolows 
5281fe76c0bSwesolows 	*var->val.integer = data->d_index;
529749f21d3Swesolows 	table_info->indexes = var;
53030698f33Swesolows 	table_info->number_indexes = 1;
531749f21d3Swesolows 
532749f21d3Swesolows 	DEBUGMSGTL((MODNAME_STR, "matching data is %lu/%s@%p\n", data->d_index,
533749f21d3Swesolows 	    data->d_ami_name, data));
534749f21d3Swesolows 
535749f21d3Swesolows 	return (data);
536749f21d3Swesolows }
537749f21d3Swesolows 
538749f21d3Swesolows /*ARGSUSED*/
539749f21d3Swesolows static sunFmModule_data_t *
540749f21d3Swesolows sunFmModuleTable_mod(netsnmp_handler_registration *reginfo,
541749f21d3Swesolows     netsnmp_table_request_info *table_info)
542749f21d3Swesolows {
543749f21d3Swesolows 	ASSERT(table_info->number_indexes == 1);
544749f21d3Swesolows 
545749f21d3Swesolows 	return (module_lookup_index_exact(table_info->index_oid[0]));
546749f21d3Swesolows }
547749f21d3Swesolows 
54830698f33Swesolows /*ARGSUSED*/
549749f21d3Swesolows static void
550749f21d3Swesolows sunFmModuleTable_return(unsigned int reg, void *arg)
551749f21d3Swesolows {
552749f21d3Swesolows 	netsnmp_delegated_cache		*cache = (netsnmp_delegated_cache *)arg;
553749f21d3Swesolows 	netsnmp_request_info		*request;
554749f21d3Swesolows 	netsnmp_agent_request_info	*reqinfo;
555749f21d3Swesolows 	netsnmp_handler_registration	*reginfo;
556749f21d3Swesolows 	netsnmp_table_request_info	*table_info;
557749f21d3Swesolows 	sunFmModule_data_t		*data;
558749f21d3Swesolows 	ulong_t				modstate;
559749f21d3Swesolows 
560749f21d3Swesolows 	ASSERT(netsnmp_handler_check_cache(cache) != NULL);
561749f21d3Swesolows 
562749f21d3Swesolows 	(void) pthread_mutex_lock(&update_lock);
563749f21d3Swesolows 	if (update_status != US_QUIET) {
564749f21d3Swesolows 		struct timeval			tv;
565749f21d3Swesolows 
566749f21d3Swesolows 		tv.tv_sec = UPDATE_WAIT_MILLIS / 1000;
567749f21d3Swesolows 		tv.tv_usec = (UPDATE_WAIT_MILLIS % 1000) * 1000;
568749f21d3Swesolows 
569749f21d3Swesolows 		(void) snmp_alarm_register_hr(tv, 0, sunFmModuleTable_return,
570749f21d3Swesolows 		    cache);
571749f21d3Swesolows 		(void) pthread_mutex_unlock(&update_lock);
572749f21d3Swesolows 		return;
573749f21d3Swesolows 	}
574749f21d3Swesolows 
575749f21d3Swesolows 	request = cache->requests;
576749f21d3Swesolows 	reqinfo = cache->reqinfo;
577749f21d3Swesolows 	reginfo = cache->reginfo;
578749f21d3Swesolows 
579749f21d3Swesolows 	table_info = netsnmp_extract_table_info(request);
580749f21d3Swesolows 	request->delegated = 0;
581749f21d3Swesolows 
582749f21d3Swesolows 	ASSERT(table_info->colnum >= SUNFMMODULE_COLMIN);
583749f21d3Swesolows 	ASSERT(table_info->colnum <= SUNFMMODULE_COLMAX);
584749f21d3Swesolows 
585749f21d3Swesolows 	/*
586749f21d3Swesolows 	 * table_info->colnum contains the column number requested.
587749f21d3Swesolows 	 * table_info->indexes contains a linked list of snmp variable
588749f21d3Swesolows 	 * bindings for the indexes of the table.  Values in the list
589749f21d3Swesolows 	 * have been set corresponding to the indexes of the
590749f21d3Swesolows 	 * request.  We have other guarantees as well:
591749f21d3Swesolows 	 *
592749f21d3Swesolows 	 * - The column number is always within range.
593749f21d3Swesolows 	 * - If we have no index data, table_info->index_oid_len is 0.
594749f21d3Swesolows 	 * - We will never receive requests outside our table nor
595749f21d3Swesolows 	 *   those with the first subid anything other than 1 (Entry)
596749f21d3Swesolows 	 *   nor those without a column number.  This is true even
597749f21d3Swesolows 	 *   for GETNEXT requests.
598749f21d3Swesolows 	 */
599749f21d3Swesolows 
600749f21d3Swesolows 	switch (reqinfo->mode) {
601749f21d3Swesolows 	case MODE_GET:
602749f21d3Swesolows 		if ((data = sunFmModuleTable_mod(reginfo, table_info)) ==
603749f21d3Swesolows 		    NULL) {
604749f21d3Swesolows 			netsnmp_free_delegated_cache(cache);
605749f21d3Swesolows 			(void) pthread_mutex_unlock(&update_lock);
606749f21d3Swesolows 			return;
607749f21d3Swesolows 		}
608749f21d3Swesolows 		break;
609749f21d3Swesolows 	case MODE_GETNEXT:
610749f21d3Swesolows 	case MODE_GETBULK:
611749f21d3Swesolows 		if ((data = sunFmModuleTable_nextmod(reginfo, table_info)) ==
612749f21d3Swesolows 		    NULL) {
613749f21d3Swesolows 			netsnmp_free_delegated_cache(cache);
614749f21d3Swesolows 			(void) pthread_mutex_unlock(&update_lock);
615749f21d3Swesolows 			return;
616749f21d3Swesolows 		}
617749f21d3Swesolows 		break;
618749f21d3Swesolows 	default:
619888e0559SRobert Johnston 		(void) snmp_log(LOG_ERR, MODNAME_STR ": Unsupported request "
620749f21d3Swesolows 		    "mode %d\n", reqinfo->mode);
621749f21d3Swesolows 		netsnmp_free_delegated_cache(cache);
622749f21d3Swesolows 		(void) pthread_mutex_unlock(&update_lock);
623749f21d3Swesolows 		return;
624749f21d3Swesolows 	}
625749f21d3Swesolows 
626749f21d3Swesolows 	switch (table_info->colnum) {
627749f21d3Swesolows 	case SUNFMMODULE_COL_NAME:
628888e0559SRobert Johnston 		(void) netsnmp_table_build_result(reginfo, request, table_info,
629749f21d3Swesolows 		    ASN_OCTET_STR, (uchar_t *)data->d_ami_name,
630749f21d3Swesolows 		    strlen(data->d_ami_name));
631749f21d3Swesolows 		break;
632749f21d3Swesolows 	case SUNFMMODULE_COL_VERSION:
633888e0559SRobert Johnston 		(void) netsnmp_table_build_result(reginfo, request, table_info,
634749f21d3Swesolows 		    ASN_OCTET_STR, (uchar_t *)data->d_ami_vers,
635749f21d3Swesolows 		    strlen(data->d_ami_vers));
636749f21d3Swesolows 		break;
637749f21d3Swesolows 	case SUNFMMODULE_COL_STATUS:
638749f21d3Swesolows 		modstate = (data->d_ami_flags & FMD_ADM_MOD_FAILED) ?
639749f21d3Swesolows 		    SUNFMMODULE_STATE_FAILED : SUNFMMODULE_STATE_ACTIVE;
640888e0559SRobert Johnston 		(void) netsnmp_table_build_result(reginfo, request, table_info,
641749f21d3Swesolows 		    ASN_INTEGER, (uchar_t *)&modstate,
642749f21d3Swesolows 		    sizeof (modstate));
643749f21d3Swesolows 		break;
644749f21d3Swesolows 	case SUNFMMODULE_COL_DESCRIPTION:
645888e0559SRobert Johnston 		(void) netsnmp_table_build_result(reginfo, request, table_info,
646749f21d3Swesolows 		    ASN_OCTET_STR, (uchar_t *)data->d_ami_desc,
647749f21d3Swesolows 		    strlen(data->d_ami_desc));
648749f21d3Swesolows 		break;
649749f21d3Swesolows 	default:
650749f21d3Swesolows 		break;
651749f21d3Swesolows 	}
652749f21d3Swesolows 	netsnmp_free_delegated_cache(cache);
653749f21d3Swesolows 	(void) pthread_mutex_unlock(&update_lock);
654749f21d3Swesolows }
655749f21d3Swesolows 
656749f21d3Swesolows static int
657749f21d3Swesolows sunFmModuleTable_handler(netsnmp_mib_handler *handler,
658749f21d3Swesolows     netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo,
659749f21d3Swesolows     netsnmp_request_info *requests)
660749f21d3Swesolows {
661749f21d3Swesolows 	netsnmp_request_info		*request;
662749f21d3Swesolows 	struct timeval			tv;
663749f21d3Swesolows 
664749f21d3Swesolows 	tv.tv_sec = UPDATE_WAIT_MILLIS / 1000;
665749f21d3Swesolows 	tv.tv_usec = (UPDATE_WAIT_MILLIS % 1000) * 1000;
666749f21d3Swesolows 
667749f21d3Swesolows 	request_update();
668749f21d3Swesolows 
669749f21d3Swesolows 	for (request = requests; request; request = request->next) {
670749f21d3Swesolows 		if (request->processed != 0)
671749f21d3Swesolows 			continue;
672749f21d3Swesolows 
673749f21d3Swesolows 		if (netsnmp_extract_table_info(request) == NULL)
674749f21d3Swesolows 			continue;
675749f21d3Swesolows 
676749f21d3Swesolows 		request->delegated = 1;
677749f21d3Swesolows 		(void) snmp_alarm_register_hr(tv, 0, sunFmModuleTable_return,
678749f21d3Swesolows 		    (void *) netsnmp_create_delegated_cache(handler, reginfo,
679749f21d3Swesolows 		    reqinfo, request, NULL));
680749f21d3Swesolows 	}
681749f21d3Swesolows 
682749f21d3Swesolows 	return (SNMP_ERR_NOERROR);
683749f21d3Swesolows }
684