xref: /onnv-gate/usr/src/lib/fm/libfmd_snmp/common/resource.c (revision 11050:be69f645ce17)
11303Swesolows /*
21303Swesolows  * CDDL HEADER START
31303Swesolows  *
41303Swesolows  * The contents of this file are subject to the terms of the
51303Swesolows  * Common Development and Distribution License (the "License").
61303Swesolows  * You may not use this file except in compliance with the License.
71303Swesolows  *
81303Swesolows  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
91303Swesolows  * or http://www.opensolaris.org/os/licensing.
101303Swesolows  * See the License for the specific language governing permissions
111303Swesolows  * and limitations under the License.
121303Swesolows  *
131303Swesolows  * When distributing Covered Code, include this CDDL HEADER in each
141303Swesolows  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
151303Swesolows  * If applicable, add the following below this CDDL HEADER, with the
161303Swesolows  * fields enclosed by brackets "[]" replaced with your own identifying
171303Swesolows  * information: Portions Copyright [yyyy] [name of copyright owner]
181303Swesolows  *
191303Swesolows  * CDDL HEADER END
201303Swesolows  */
211303Swesolows 
221303Swesolows /*
23*11050SRobert.Johnston@Sun.COM  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
241303Swesolows  * Use is subject to license terms.
251303Swesolows  */
261303Swesolows 
271303Swesolows #include <fm/fmd_adm.h>
281303Swesolows #include <fm/fmd_snmp.h>
291303Swesolows #include <net-snmp/net-snmp-config.h>
301303Swesolows #include <net-snmp/net-snmp-includes.h>
311303Swesolows #include <net-snmp/agent/net-snmp-agent-includes.h>
321303Swesolows #include <pthread.h>
331303Swesolows #include <stddef.h>
341303Swesolows #include <errno.h>
351303Swesolows #include <libuutil.h>
361303Swesolows #include "sunFM_impl.h"
371303Swesolows #include "resource.h"
381303Swesolows 
391303Swesolows static uu_avl_pool_t	*rsrc_fmri_avl_pool;
401303Swesolows static uu_avl_pool_t	*rsrc_index_avl_pool;
411303Swesolows static uu_avl_t		*rsrc_fmri_avl;
421303Swesolows static uu_avl_t		*rsrc_index_avl;
431303Swesolows 
441303Swesolows #define	VALID_AVL_STATE	(rsrc_fmri_avl_pool != NULL &&		\
451303Swesolows 	rsrc_index_avl_pool != NULL && rsrc_fmri_avl != NULL &&	\
461303Swesolows 	rsrc_index_avl != NULL)
471303Swesolows 
481303Swesolows #define	UPDATE_WAIT_MILLIS	10	/* poll interval in milliseconds */
491303Swesolows 
501303Swesolows /*
511303Swesolows  * Update types: single-index and all are mutually exclusive; a count
521303Swesolows  * update is optional.
531303Swesolows  */
541303Swesolows #define	UCT_INDEX	0x1
551303Swesolows #define	UCT_ALL		0x2
561303Swesolows #define	UCT_COUNT	0x4
571303Swesolows #define	UCT_FLAGS	0x7
581303Swesolows 
591303Swesolows #define	RESOURCE_DATA_VALID(d)	((d)->d_valid == valid_stamp)
601303Swesolows 
611303Swesolows /*
621303Swesolows  * Locking strategy is described in module.c.
631303Swesolows  */
641303Swesolows static ulong_t		max_index;
651303Swesolows static int		valid_stamp;
661303Swesolows static uint32_t		rsrc_count;
671303Swesolows static pthread_mutex_t	update_lock;
681303Swesolows static pthread_cond_t	update_cv;
691303Swesolows static volatile enum { US_QUIET, US_NEEDED, US_INPROGRESS } update_status;
701303Swesolows 
711303Swesolows static Netsnmp_Node_Handler	sunFmResourceTable_handler;
721303Swesolows static Netsnmp_Node_Handler	sunFmResourceCount_handler;
731303Swesolows 
741303Swesolows static sunFmResource_data_t *
key_build(const char * fmri,const ulong_t index)751303Swesolows key_build(const char *fmri, const ulong_t index)
761303Swesolows {
771303Swesolows 	static sunFmResource_data_t	key;
781303Swesolows 
791303Swesolows 	key.d_index = index;
801303Swesolows 	if (fmri)
812134Swesolows 		(void) strlcpy(key.d_ari_fmri, fmri, sizeof (key.d_ari_fmri));
821303Swesolows 	else
831303Swesolows 		key.d_ari_fmri[0] = '\0';
841303Swesolows 
851303Swesolows 	return (&key);
861303Swesolows }
871303Swesolows 
881303Swesolows /*
891303Swesolows  * If fmri is the fmri of a resource we have previously seen and indexed, return
901303Swesolows  * data for it.  Otherwise, return NULL.  Note that the resource may not be
911303Swesolows  * valid; that is, it may have been removed from the fault manager since its
921303Swesolows  * information was last updated.
931303Swesolows  */
941303Swesolows static sunFmResource_data_t *
resource_lookup_fmri(const char * fmri)951303Swesolows resource_lookup_fmri(const char *fmri)
961303Swesolows {
971303Swesolows 	sunFmResource_data_t	*key;
981303Swesolows 
991303Swesolows 	key = key_build(fmri, 0);
1001303Swesolows 	return (uu_avl_find(rsrc_fmri_avl, key, NULL, NULL));
1011303Swesolows }
1021303Swesolows 
1031303Swesolows /*
1041303Swesolows  * If index corresponds to a resource we have previously seen and indexed,
1051303Swesolows  * return data for it.  Otherwise, return NULL.  Note that the resource may
1061303Swesolows  * not be valid; that is, it may have been expired from the fault manager
1071303Swesolows  * since its information was last updated.
1081303Swesolows  */
1091303Swesolows static sunFmResource_data_t *
resource_lookup_index_exact(const ulong_t index)1101303Swesolows resource_lookup_index_exact(const ulong_t index)
1111303Swesolows {
1121303Swesolows 	sunFmResource_data_t	*key;
1131303Swesolows 
1141303Swesolows 	key = key_build(NULL, index);
1151303Swesolows 	return (uu_avl_find(rsrc_index_avl, key, NULL, NULL));
1161303Swesolows }
1171303Swesolows 
1181303Swesolows /*
1191303Swesolows  * If index corresponds to a valid (that is, extant as of latest information
1201303Swesolows  * from the fault manager) resource, return the data for that resource.
1211303Swesolows  * Otherwise, return the data for the valid resource whose index is as close as
1221303Swesolows  * possible to index but not lower.  This preserves the lexicographical
1231303Swesolows  * ordering required for GETNEXT processing.
1241303Swesolows  */
1251303Swesolows static sunFmResource_data_t *
resource_lookup_index_nextvalid(const ulong_t index)1261303Swesolows resource_lookup_index_nextvalid(const ulong_t index)
1271303Swesolows {
1281303Swesolows 	sunFmResource_data_t	*key, *data;
1291303Swesolows 	uu_avl_index_t		idx;
1301303Swesolows 
1311303Swesolows 	key = key_build(NULL, index);
1321303Swesolows 
1331303Swesolows 	if ((data = uu_avl_find(rsrc_index_avl, key, NULL, &idx)) != NULL &&
1341303Swesolows 	    RESOURCE_DATA_VALID(data))
1353955Swesolows 		return (data);
1361303Swesolows 
1371303Swesolows 	data = uu_avl_nearest_next(rsrc_index_avl, idx);
1381303Swesolows 
1393955Swesolows 	while (data != NULL && !RESOURCE_DATA_VALID(data))
1403955Swesolows 		data = uu_avl_next(rsrc_index_avl, data);
1411303Swesolows 
1421303Swesolows 	return (data);
1431303Swesolows }
1441303Swesolows 
1451303Swesolows /*
1461303Swesolows  * Possible update the contents of a single resource within the cache.  This
1471303Swesolows  * is our callback from fmd_rsrc_iter.
1481303Swesolows  */
1491303Swesolows static int
rsrcinfo_update_one(const fmd_adm_rsrcinfo_t * rsrcinfo,void * arg)1501303Swesolows rsrcinfo_update_one(const fmd_adm_rsrcinfo_t *rsrcinfo, void *arg)
1511303Swesolows {
1521303Swesolows 	const sunFmResource_update_ctx_t *update_ctx =
1531303Swesolows 	    (sunFmResource_update_ctx_t *)arg;
1541303Swesolows 	sunFmResource_data_t *data = resource_lookup_fmri(rsrcinfo->ari_fmri);
1551303Swesolows 
1561303Swesolows 	++rsrc_count;
1571303Swesolows 
1581303Swesolows 	/*
1591303Swesolows 	 * A resource we haven't seen before.  We're obligated to index
1601303Swesolows 	 * it and link it into our cache so that we can find it, but we're
1611303Swesolows 	 * not obligated to fill it in completely unless we're doing a
1621303Swesolows 	 * full update or this is the resource we were asked for.  This
1631303Swesolows 	 * avoids unnecessary iteration and memory manipulation for data
1641303Swesolows 	 * we're not going to return for this request.
1651303Swesolows 	 */
1661303Swesolows 	if (data == NULL) {
1671303Swesolows 		uu_avl_index_t idx;
1681303Swesolows 
1691303Swesolows 		DEBUGMSGTL((MODNAME_STR, "found new resource %s\n",
1701303Swesolows 		    rsrcinfo->ari_fmri));
1711303Swesolows 		if ((data = SNMP_MALLOC_TYPEDEF(sunFmResource_data_t)) ==
1721303Swesolows 		    NULL) {
173*11050SRobert.Johnston@Sun.COM 			(void) snmp_log(LOG_ERR, MODNAME_STR ": Out of memory "
174*11050SRobert.Johnston@Sun.COM 			    "for new resource data at %s:%d\n", __FILE__,
175*11050SRobert.Johnston@Sun.COM 			    __LINE__);
1761303Swesolows 			return (1);
1771303Swesolows 		}
1781303Swesolows 		/*
1791303Swesolows 		 * We allocate indices sequentially and never reuse them.
1801303Swesolows 		 * This ensures we can always return valid GETNEXT responses
1811303Swesolows 		 * without having to reindex, and it provides the user a
1821303Swesolows 		 * more consistent view of the fault manager.
1831303Swesolows 		 */
1841303Swesolows 		data->d_index = ++max_index;
1851303Swesolows 		DEBUGMSGTL((MODNAME_STR, "index %lu is %s@%p\n", data->d_index,
1861303Swesolows 		    rsrcinfo->ari_fmri, data));
1871303Swesolows 
1882134Swesolows 		(void) strlcpy(data->d_ari_fmri, rsrcinfo->ari_fmri,
1891303Swesolows 		    sizeof (data->d_ari_fmri));
1901303Swesolows 
1911303Swesolows 		uu_avl_node_init(data, &data->d_fmri_avl, rsrc_fmri_avl_pool);
1921303Swesolows 		(void) uu_avl_find(rsrc_fmri_avl, data, NULL, &idx);
1931303Swesolows 		uu_avl_insert(rsrc_fmri_avl, data, idx);
1941303Swesolows 
1951303Swesolows 		uu_avl_node_init(data, &data->d_index_avl, rsrc_index_avl_pool);
1961303Swesolows 		(void) uu_avl_find(rsrc_index_avl, data, NULL, &idx);
1971303Swesolows 		uu_avl_insert(rsrc_index_avl, data, idx);
1981303Swesolows 
1991303Swesolows 		DEBUGMSGTL((MODNAME_STR, "completed new resource %lu/%s@%p\n",
2001303Swesolows 		    data->d_index, data->d_ari_fmri, data));
2011303Swesolows 	}
2021303Swesolows 
2031303Swesolows 	data->d_valid = valid_stamp;
2041303Swesolows 
2051303Swesolows 	DEBUGMSGTL((MODNAME_STR, "timestamp updated for %lu/%s@%p: %lu\n",
2061303Swesolows 	    data->d_index, data->d_ari_fmri, data, data->d_valid));
2071303Swesolows 
2081303Swesolows 	if ((update_ctx->uc_type & UCT_ALL) ||
2091303Swesolows 	    update_ctx->uc_index == data->d_index) {
2102134Swesolows 		(void) strlcpy(data->d_ari_case, rsrcinfo->ari_case,
2111303Swesolows 		    sizeof (data->d_ari_case));
2121303Swesolows 		data->d_ari_flags = rsrcinfo->ari_flags;
2131303Swesolows 	}
2141303Swesolows 
2151303Swesolows 	return (!(update_ctx->uc_type & UCT_ALL) &&
2161303Swesolows 	    update_ctx->uc_index == data->d_index);
2171303Swesolows }
2181303Swesolows 
2191303Swesolows /*
2201303Swesolows  * Update some or all resource data from fmd.  If type includes UCT_ALL, all
2211303Swesolows  * resources will be indexed and their data cached.  If type includes
2221303Swesolows  * UCT_INDEX, updates will stop once the resource matching index has been
2231303Swesolows  * updated.  If UCT_COUNT is set, the number of faulted resources will be
2241303Swesolows  * set.
2251303Swesolows  *
2261303Swesolows  * Returns appropriate SNMP error codes.
2271303Swesolows  */
2281303Swesolows static int
rsrcinfo_update(sunFmResource_update_ctx_t * update_ctx)2291303Swesolows rsrcinfo_update(sunFmResource_update_ctx_t *update_ctx)
2301303Swesolows {
2311303Swesolows 	fmd_adm_t *adm;
2321303Swesolows 	int err;
2331303Swesolows 
2341303Swesolows 	ASSERT(update_ctx != NULL);
2351303Swesolows 	ASSERT((update_ctx->uc_type & (UCT_ALL|UCT_INDEX)) !=
2361303Swesolows 	    (UCT_ALL|UCT_INDEX));
2371303Swesolows 	ASSERT((update_ctx->uc_type & ~UCT_FLAGS) == 0);
2381303Swesolows 	ASSERT(VALID_AVL_STATE);
2391303Swesolows 
2401303Swesolows 	if ((adm = fmd_adm_open(update_ctx->uc_host, update_ctx->uc_prog,
2411303Swesolows 	    update_ctx->uc_version)) == NULL) {
242*11050SRobert.Johnston@Sun.COM 		(void) snmp_log(LOG_ERR, MODNAME_STR ": Communication with fmd "
2431303Swesolows 		    "failed: %s\n", strerror(errno));
2441303Swesolows 		return (SNMP_ERR_RESOURCEUNAVAILABLE);
2451303Swesolows 	}
2461303Swesolows 
2471303Swesolows 	if (update_ctx->uc_type == UCT_COUNT) {
2481303Swesolows 		err = fmd_adm_rsrc_count(adm, update_ctx->uc_all, &rsrc_count);
2491303Swesolows 	} else {
2501303Swesolows 		++valid_stamp;
2511303Swesolows 		rsrc_count = 0;
2521303Swesolows 		err = fmd_adm_rsrc_iter(adm, update_ctx->uc_all,
2531303Swesolows 		    rsrcinfo_update_one, update_ctx);
2541303Swesolows 		DEBUGMSGTL((MODNAME_STR, "resource iteration completed\n"));
2551303Swesolows 	}
2561303Swesolows 
2571303Swesolows 	fmd_adm_close(adm);
2581303Swesolows 
2591303Swesolows 	if (err != 0) {
260*11050SRobert.Johnston@Sun.COM 		(void) snmp_log(LOG_ERR, MODNAME_STR ": fmd resource "
261*11050SRobert.Johnston@Sun.COM 		    "information update failed: %s\n", fmd_adm_errmsg(adm));
2621303Swesolows 		return (SNMP_ERR_RESOURCEUNAVAILABLE);
2631303Swesolows 	}
2641303Swesolows 
2651303Swesolows 	return (SNMP_ERR_NOERROR);
2661303Swesolows }
2671303Swesolows 
2681303Swesolows /*ARGSUSED*/
2691303Swesolows static void
update_thread(void * arg)2701303Swesolows update_thread(void *arg)
2711303Swesolows {
2721303Swesolows 	/*
2731303Swesolows 	 * The current rsrcinfo_update implementation offers minimal savings
2741303Swesolows 	 * for the use of index-only updates; therefore we always do a full
2751303Swesolows 	 * update.  If it becomes advantageous to limit updates to a single
2761303Swesolows 	 * index, the contexts can be queued by the handler instead.
2771303Swesolows 	 */
2781303Swesolows 	sunFmResource_update_ctx_t	uc;
2791303Swesolows 
2801303Swesolows 	uc.uc_host = NULL;
2811303Swesolows 	uc.uc_prog = FMD_ADM_PROGRAM;
2821303Swesolows 	uc.uc_version = FMD_ADM_VERSION;
2831303Swesolows 
2842134Swesolows 	uc.uc_all = 0;
2851303Swesolows 	uc.uc_index = 0;
2861303Swesolows 	uc.uc_type = UCT_ALL;
2871303Swesolows 
2881303Swesolows 	for (;;) {
2891303Swesolows 		(void) pthread_mutex_lock(&update_lock);
2901303Swesolows 		update_status = US_QUIET;
2911303Swesolows 		while (update_status == US_QUIET)
2921303Swesolows 			(void) pthread_cond_wait(&update_cv, &update_lock);
2931303Swesolows 		update_status = US_INPROGRESS;
2941303Swesolows 		(void) pthread_mutex_unlock(&update_lock);
2951303Swesolows 		(void) rsrcinfo_update(&uc);
2961303Swesolows 	}
2971303Swesolows }
2981303Swesolows 
2991303Swesolows static void
request_update(void)3001303Swesolows request_update(void)
3011303Swesolows {
3021303Swesolows 	(void) pthread_mutex_lock(&update_lock);
3031303Swesolows 	if (update_status != US_QUIET) {
3041303Swesolows 		(void) pthread_mutex_unlock(&update_lock);
3051303Swesolows 		return;
3061303Swesolows 	}
3071303Swesolows 	update_status = US_NEEDED;
3081303Swesolows 	(void) pthread_cond_signal(&update_cv);
3091303Swesolows 	(void) pthread_mutex_unlock(&update_lock);
3101303Swesolows }
3111303Swesolows 
3121303Swesolows /*ARGSUSED*/
3131303Swesolows static int
resource_compare_fmri(const void * l,const void * r,void * private)3141303Swesolows resource_compare_fmri(const void *l, const void *r, void *private)
3151303Swesolows {
3161303Swesolows 	sunFmResource_data_t	*l_data = (sunFmResource_data_t *)l;
3171303Swesolows 	sunFmResource_data_t	*r_data = (sunFmResource_data_t *)r;
3181303Swesolows 
3191303Swesolows 	ASSERT(l_data != NULL && r_data != NULL);
3201303Swesolows 
3211303Swesolows 	return (strcmp(l_data->d_ari_fmri, r_data->d_ari_fmri));
3221303Swesolows }
3231303Swesolows 
3241303Swesolows /*ARGSUSED*/
3251303Swesolows static int
resource_compare_index(const void * l,const void * r,void * private)3261303Swesolows resource_compare_index(const void *l, const void *r, void *private)
3271303Swesolows {
3281303Swesolows 	sunFmResource_data_t	*l_data = (sunFmResource_data_t *)l;
3291303Swesolows 	sunFmResource_data_t	*r_data = (sunFmResource_data_t *)r;
3301303Swesolows 
3311303Swesolows 	ASSERT(l_data != NULL && r_data != NULL);
3321303Swesolows 
3331303Swesolows 	return (l_data->d_index < r_data->d_index ? -1 :
3341303Swesolows 	    l_data->d_index > r_data->d_index ? 1 : 0);
3351303Swesolows }
3361303Swesolows 
3371303Swesolows int
sunFmResourceTable_init(void)3381303Swesolows sunFmResourceTable_init(void)
3391303Swesolows {
3401303Swesolows 	static oid sunFmResourceTable_oid[] = { SUNFMRESOURCETABLE_OID };
3411303Swesolows 	static oid sunFmResourceCount_oid[] = { SUNFMRESOURCECOUNT_OID, 0 };
3421303Swesolows 	netsnmp_table_registration_info *table_info;
3431303Swesolows 	netsnmp_handler_registration *handler;
3441303Swesolows 	int err;
3451303Swesolows 
3461303Swesolows 	if ((err = pthread_mutex_init(&update_lock, NULL)) != 0) {
347*11050SRobert.Johnston@Sun.COM 		(void) snmp_log(LOG_ERR, MODNAME_STR ": mutex_init failure: "
348*11050SRobert.Johnston@Sun.COM 		    "%s\n", strerror(err));
3491303Swesolows 		return (MIB_REGISTRATION_FAILED);
3501303Swesolows 	}
3511303Swesolows 	if ((err = pthread_cond_init(&update_cv, NULL)) != 0) {
352*11050SRobert.Johnston@Sun.COM 		(void) snmp_log(LOG_ERR, MODNAME_STR ": cond_init failure: "
353*11050SRobert.Johnston@Sun.COM 		    "%s\n", strerror(err));
3541303Swesolows 		return (MIB_REGISTRATION_FAILED);
3551303Swesolows 	}
3561303Swesolows 
3571303Swesolows 	if ((err = pthread_create(NULL, NULL, (void *(*)(void *))update_thread,
3581303Swesolows 	    NULL)) != 0) {
359*11050SRobert.Johnston@Sun.COM 		(void) snmp_log(LOG_ERR, MODNAME_STR ": error creating update "
3601303Swesolows 		    "thread: %s\n", strerror(err));
3611303Swesolows 		return (MIB_REGISTRATION_FAILED);
3621303Swesolows 	}
3631303Swesolows 
3641303Swesolows 	if ((table_info =
3651303Swesolows 	    SNMP_MALLOC_TYPEDEF(netsnmp_table_registration_info)) == NULL)
3661303Swesolows 		return (MIB_REGISTRATION_FAILED);
3671303Swesolows 
3681303Swesolows 	if ((handler = netsnmp_create_handler_registration("sunFmResourceTable",
3691303Swesolows 	    sunFmResourceTable_handler, sunFmResourceTable_oid,
3701303Swesolows 	    OID_LENGTH(sunFmResourceTable_oid), HANDLER_CAN_RONLY)) == NULL) {
3711303Swesolows 		SNMP_FREE(table_info);
3721303Swesolows 		return (MIB_REGISTRATION_FAILED);
3731303Swesolows 	}
3741303Swesolows 
3751303Swesolows 	/*
3761303Swesolows 	 * The Net-SNMP template uses add_indexes here, but that
3771303Swesolows 	 * function is unsafe because it does not check for failure.
3781303Swesolows 	 */
3791303Swesolows 	if (netsnmp_table_helper_add_index(table_info, ASN_UNSIGNED) == NULL) {
3801303Swesolows 		SNMP_FREE(table_info);
3811303Swesolows 		SNMP_FREE(handler);
3821303Swesolows 		return (MIB_REGISTRATION_FAILED);
3831303Swesolows 	}
3841303Swesolows 
3851303Swesolows 	table_info->min_column = SUNFMRESOURCE_COLMIN;
3861303Swesolows 	table_info->max_column = SUNFMRESOURCE_COLMAX;
3871303Swesolows 
3881303Swesolows 	if ((rsrc_fmri_avl_pool = uu_avl_pool_create("rsrc_fmri",
3891303Swesolows 	    sizeof (sunFmResource_data_t),
3901303Swesolows 	    offsetof(sunFmResource_data_t, d_fmri_avl), resource_compare_fmri,
3911303Swesolows 	    UU_AVL_DEBUG)) == NULL) {
392*11050SRobert.Johnston@Sun.COM 		(void) snmp_log(LOG_ERR, MODNAME_STR ": rsrc_fmri avl pool "
393*11050SRobert.Johnston@Sun.COM 		    "creation failed: %s\n", uu_strerror(uu_error()));
3941303Swesolows 		snmp_free_varbind(table_info->indexes);
3951303Swesolows 		SNMP_FREE(table_info);
3961303Swesolows 		SNMP_FREE(handler);
3971303Swesolows 	}
3981303Swesolows 
3991303Swesolows 	if ((rsrc_fmri_avl = uu_avl_create(rsrc_fmri_avl_pool, NULL,
4001303Swesolows 	    UU_AVL_DEBUG)) == NULL) {
401*11050SRobert.Johnston@Sun.COM 		(void) snmp_log(LOG_ERR, MODNAME_STR ": rsrc_fmri avl creation "
4021303Swesolows 		    "failed: %s\n", uu_strerror(uu_error()));
4031303Swesolows 		snmp_free_varbind(table_info->indexes);
4041303Swesolows 		SNMP_FREE(table_info);
4051303Swesolows 		SNMP_FREE(handler);
4061303Swesolows 		uu_avl_pool_destroy(rsrc_fmri_avl_pool);
4071303Swesolows 		return (MIB_REGISTRATION_FAILED);
4081303Swesolows 	}
4091303Swesolows 
4101303Swesolows 	if ((rsrc_index_avl_pool = uu_avl_pool_create("rsrc_index",
4111303Swesolows 	    sizeof (sunFmResource_data_t),
4121303Swesolows 	    offsetof(sunFmResource_data_t, d_index_avl),
4131303Swesolows 	    resource_compare_index, UU_AVL_DEBUG)) == NULL) {
414*11050SRobert.Johnston@Sun.COM 		(void) snmp_log(LOG_ERR, MODNAME_STR ": rsrc_index avl pool "
415*11050SRobert.Johnston@Sun.COM 		    "creation failed: %s\n", uu_strerror(uu_error()));
4161303Swesolows 		snmp_free_varbind(table_info->indexes);
4171303Swesolows 		SNMP_FREE(table_info);
4181303Swesolows 		SNMP_FREE(handler);
4191303Swesolows 		uu_avl_destroy(rsrc_fmri_avl);
4201303Swesolows 		uu_avl_pool_destroy(rsrc_fmri_avl_pool);
4211303Swesolows 	}
4221303Swesolows 
4231303Swesolows 	if ((rsrc_index_avl = uu_avl_create(rsrc_index_avl_pool, NULL,
4241303Swesolows 	    UU_AVL_DEBUG)) == NULL) {
425*11050SRobert.Johnston@Sun.COM 		(void) snmp_log(LOG_ERR, MODNAME_STR ": rsrc_index avl "
426*11050SRobert.Johnston@Sun.COM 		    "creation failed: %s\n", uu_strerror(uu_error()));
4271303Swesolows 		snmp_free_varbind(table_info->indexes);
4281303Swesolows 		SNMP_FREE(table_info);
4291303Swesolows 		SNMP_FREE(handler);
4301303Swesolows 		uu_avl_destroy(rsrc_fmri_avl);
4311303Swesolows 		uu_avl_pool_destroy(rsrc_fmri_avl_pool);
4321303Swesolows 		uu_avl_pool_destroy(rsrc_index_avl_pool);
4331303Swesolows 		return (MIB_REGISTRATION_FAILED);
4341303Swesolows 	}
4351303Swesolows 
4361303Swesolows 	if ((err = netsnmp_register_table(handler, table_info)) !=
4371303Swesolows 	    MIB_REGISTERED_OK) {
4381303Swesolows 		snmp_free_varbind(table_info->indexes);
4391303Swesolows 		SNMP_FREE(table_info);
4401303Swesolows 		SNMP_FREE(handler);
4411303Swesolows 		uu_avl_destroy(rsrc_fmri_avl);
4421303Swesolows 		uu_avl_pool_destroy(rsrc_fmri_avl_pool);
4431303Swesolows 		uu_avl_destroy(rsrc_index_avl);
4441303Swesolows 		uu_avl_pool_destroy(rsrc_index_avl_pool);
4451303Swesolows 		return (err);
4461303Swesolows 	}
4471303Swesolows 
4481303Swesolows 	if ((err = netsnmp_register_read_only_instance(
4491303Swesolows 	    netsnmp_create_handler_registration("sunFmResourceCount",
450*11050SRobert.Johnston@Sun.COM 	    sunFmResourceCount_handler, sunFmResourceCount_oid,
451*11050SRobert.Johnston@Sun.COM 	    OID_LENGTH(sunFmResourceCount_oid), HANDLER_CAN_RONLY))) !=
4521303Swesolows 	    MIB_REGISTERED_OK) {
4531303Swesolows 		/*
4541303Swesolows 		 * There's no way to unregister the table handler, so we
4551303Swesolows 		 * can't free any of the data, either.
4561303Swesolows 		 */
4571303Swesolows 		return (err);
4581303Swesolows 	}
4591303Swesolows 
4601303Swesolows 	return (MIB_REGISTERED_OK);
4611303Swesolows }
4621303Swesolows 
4631303Swesolows /*
4641303Swesolows  * These two functions form the core of GET/GETNEXT/GETBULK handling (the
4651303Swesolows  * only kind we do).  They perform two functions:
4661303Swesolows  *
4671303Swesolows  * - First, frob the request to set all the index variables to correspond
4681303Swesolows  *   to the value that's going to be returned.  For GET, this is a nop;
4691303Swesolows  *   for GETNEXT/GETBULK it always requires some work.
4701303Swesolows  * - Second, find and return the fmd resource information corresponding to
4711303Swesolows  *   the (possibly updated) indices.
4721303Swesolows  *
4731303Swesolows  * These should be as fast as possible; they run in the agent thread.
4741303Swesolows  */
4751303Swesolows static sunFmResource_data_t *
sunFmResourceTable_nextrsrc(netsnmp_handler_registration * reginfo,netsnmp_table_request_info * table_info)4761303Swesolows sunFmResourceTable_nextrsrc(netsnmp_handler_registration *reginfo,
4771303Swesolows     netsnmp_table_request_info *table_info)
4781303Swesolows {
4791303Swesolows 	sunFmResource_data_t	*data;
4801303Swesolows 	netsnmp_variable_list	*var;
4811303Swesolows 	ulong_t index;
4821303Swesolows 
4831303Swesolows 	/*
4841303Swesolows 	 * If we have no index, we must make one.
4851303Swesolows 	 */
4861303Swesolows 	if (table_info->number_indexes < 1) {
4871303Swesolows 		oid tmpoid[MAX_OID_LEN];
4881303Swesolows 		index = 1;
4891303Swesolows 
4901303Swesolows 		DEBUGMSGTL((MODNAME_STR, "nextrsrc: no indexes given\n"));
4911303Swesolows 		var = SNMP_MALLOC_TYPEDEF(netsnmp_variable_list);
492*11050SRobert.Johnston@Sun.COM 		(void) snmp_set_var_typed_value(var, ASN_UNSIGNED,
493*11050SRobert.Johnston@Sun.COM 		    (uchar_t *)&index, sizeof (index));
4942134Swesolows 		(void) memcpy(tmpoid, reginfo->rootoid,
4951303Swesolows 		    reginfo->rootoid_len * sizeof (oid));
4961303Swesolows 		tmpoid[reginfo->rootoid_len] = 1;
4971303Swesolows 		tmpoid[reginfo->rootoid_len + 1] = table_info->colnum;
4981303Swesolows 		if (build_oid(&var->name, &var->name_length, tmpoid,
4991303Swesolows 		    reginfo->rootoid_len + 2, var) != SNMPERR_SUCCESS) {
5001303Swesolows 			snmp_free_varbind(var);
5011303Swesolows 			return (NULL);
5021303Swesolows 		}
5031303Swesolows 		DEBUGMSGTL((MODNAME_STR, "nextrsrc: built fake index:\n"));
5041303Swesolows 		DEBUGMSGVAR((MODNAME_STR, var));
5051303Swesolows 		DEBUGMSG((MODNAME_STR, "\n"));
5061303Swesolows 	} else {
5072134Swesolows 		var = snmp_clone_varbind(table_info->indexes);
5081303Swesolows 		index = *var->val.integer;
5091303Swesolows 		DEBUGMSGTL((MODNAME_STR, "nextrsrc: received index:\n"));
5101303Swesolows 		DEBUGMSGVAR((MODNAME_STR, var));
5111303Swesolows 		DEBUGMSG((MODNAME_STR, "\n"));
5121303Swesolows 		index++;
5131303Swesolows 	}
5141303Swesolows 
5152134Swesolows 	snmp_free_varbind(table_info->indexes);
5162134Swesolows 	table_info->indexes = NULL;
5172134Swesolows 	table_info->number_indexes = 0;
5182134Swesolows 
5191303Swesolows 	if ((data = resource_lookup_index_nextvalid(index)) == NULL) {
5201303Swesolows 		DEBUGMSGTL((MODNAME_STR, "nextrsrc: exact match not found for "
5211303Swesolows 		    "index %lu; trying next column\n", index));
5222134Swesolows 		if (table_info->colnum >=
5232134Swesolows 		    netsnmp_find_table_registration_info(reginfo)->max_column) {
5241303Swesolows 			snmp_free_varbind(var);
5251303Swesolows 			DEBUGMSGTL((MODNAME_STR, "nextrsrc: out of columns\n"));
5261303Swesolows 			return (NULL);
5271303Swesolows 		}
5281303Swesolows 		table_info->colnum++;
5291303Swesolows 		index = 1;
5301303Swesolows 
5311303Swesolows 		data = resource_lookup_index_nextvalid(index);
5321303Swesolows 	}
5331303Swesolows 
5341303Swesolows 	if (data == NULL) {
5351303Swesolows 		DEBUGMSGTL((MODNAME_STR, "nextrsrc: exact match not found for "
5361303Swesolows 		    "index %lu; stopping\n", index));
5371303Swesolows 		snmp_free_varbind(var);
5381303Swesolows 		return (NULL);
5391303Swesolows 	}
5401303Swesolows 
5413955Swesolows 	*var->val.integer = data->d_index;
5421303Swesolows 	table_info->indexes = var;
5432134Swesolows 	table_info->number_indexes = 1;
5441303Swesolows 
5451303Swesolows 	DEBUGMSGTL((MODNAME_STR, "matching data is %lu/%s@%p\n", data->d_index,
5461303Swesolows 	    data->d_ari_fmri, data));
5471303Swesolows 
5481303Swesolows 	return (data);
5491303Swesolows }
5501303Swesolows 
5511303Swesolows /*ARGSUSED*/
5521303Swesolows static sunFmResource_data_t *
sunFmResourceTable_rsrc(netsnmp_handler_registration * reginfo,netsnmp_table_request_info * table_info)5531303Swesolows sunFmResourceTable_rsrc(netsnmp_handler_registration *reginfo,
5541303Swesolows     netsnmp_table_request_info *table_info)
5551303Swesolows {
5561303Swesolows 	ASSERT(table_info->number_indexes == 1);
5571303Swesolows 
5581303Swesolows 	return (resource_lookup_index_exact(table_info->index_oid[0]));
5591303Swesolows }
5601303Swesolows 
5612134Swesolows /*ARGSUSED*/
5621303Swesolows static void
sunFmResourceTable_return(unsigned int reg,void * arg)5631303Swesolows sunFmResourceTable_return(unsigned int reg, void *arg)
5641303Swesolows {
5651303Swesolows 	netsnmp_delegated_cache		*cache = (netsnmp_delegated_cache *)arg;
5661303Swesolows 	netsnmp_request_info		*request;
5671303Swesolows 	netsnmp_agent_request_info	*reqinfo;
5681303Swesolows 	netsnmp_handler_registration	*reginfo;
5691303Swesolows 	netsnmp_table_request_info	*table_info;
5701303Swesolows 	sunFmResource_data_t		*data;
5711303Swesolows 	ulong_t				rsrcstate;
5721303Swesolows 
5731303Swesolows 	ASSERT(netsnmp_handler_check_cache(cache) != NULL);
5741303Swesolows 
5751303Swesolows 	(void) pthread_mutex_lock(&update_lock);
5761303Swesolows 	if (update_status != US_QUIET) {
5771303Swesolows 		struct timeval			tv;
5781303Swesolows 
5791303Swesolows 		tv.tv_sec = UPDATE_WAIT_MILLIS / 1000;
5801303Swesolows 		tv.tv_usec = (UPDATE_WAIT_MILLIS % 1000) * 1000;
5811303Swesolows 
5821303Swesolows 		(void) snmp_alarm_register_hr(tv, 0, sunFmResourceTable_return,
5831303Swesolows 		    cache);
5841303Swesolows 		(void) pthread_mutex_unlock(&update_lock);
5851303Swesolows 		return;
5861303Swesolows 	}
5871303Swesolows 
5881303Swesolows 	request = cache->requests;
5891303Swesolows 	reqinfo = cache->reqinfo;
5901303Swesolows 	reginfo = cache->reginfo;
5911303Swesolows 
5921303Swesolows 	table_info = netsnmp_extract_table_info(request);
5931303Swesolows 	request->delegated = 0;
5941303Swesolows 
5951303Swesolows 	ASSERT(table_info->colnum >= SUNFMRESOURCE_COLMIN);
5961303Swesolows 	ASSERT(table_info->colnum <= SUNFMRESOURCE_COLMAX);
5971303Swesolows 
5981303Swesolows 	/*
5991303Swesolows 	 * table_info->colnum contains the column number requested.
6001303Swesolows 	 * table_info->indexes contains a linked list of snmp variable
6011303Swesolows 	 * bindings for the indexes of the table.  Values in the list
6021303Swesolows 	 * have been set corresponding to the indexes of the
6031303Swesolows 	 * request.  We have other guarantees as well:
6041303Swesolows 	 *
6051303Swesolows 	 * - The column number is always within range.
6061303Swesolows 	 * - If we have no index data, table_info->index_oid_len is 0.
6071303Swesolows 	 * - We will never receive requests outside our table nor
6081303Swesolows 	 *   those with the first subid anything other than 1 (Entry)
6091303Swesolows 	 *   nor those without a column number.  This is true even
6101303Swesolows 	 *   for GETNEXT requests.
6111303Swesolows 	 */
6121303Swesolows 
6131303Swesolows 	switch (reqinfo->mode) {
6141303Swesolows 	case MODE_GET:
6151303Swesolows 		if ((data = sunFmResourceTable_rsrc(reginfo, table_info)) ==
6161303Swesolows 		    NULL) {
6171303Swesolows 			netsnmp_free_delegated_cache(cache);
6181303Swesolows 			(void) pthread_mutex_unlock(&update_lock);
6191303Swesolows 			return;
6201303Swesolows 		}
6211303Swesolows 		break;
6221303Swesolows 	case MODE_GETNEXT:
6231303Swesolows 	case MODE_GETBULK:
6241303Swesolows 		if ((data = sunFmResourceTable_nextrsrc(reginfo, table_info)) ==
6251303Swesolows 		    NULL) {
6261303Swesolows 			netsnmp_free_delegated_cache(cache);
6271303Swesolows 			(void) pthread_mutex_unlock(&update_lock);
6281303Swesolows 			return;
6291303Swesolows 		}
6301303Swesolows 		break;
6311303Swesolows 	default:
632*11050SRobert.Johnston@Sun.COM 		(void) snmp_log(LOG_ERR, MODNAME_STR ": Unsupported request "
633*11050SRobert.Johnston@Sun.COM 		    "mode %d\n", reqinfo->mode);
6341303Swesolows 		netsnmp_free_delegated_cache(cache);
6351303Swesolows 		(void) pthread_mutex_unlock(&update_lock);
6361303Swesolows 		return;
6371303Swesolows 	}
6381303Swesolows 
6391303Swesolows 	switch (table_info->colnum) {
6401303Swesolows 	case SUNFMRESOURCE_COL_FMRI:
641*11050SRobert.Johnston@Sun.COM 		(void) netsnmp_table_build_result(reginfo, request, table_info,
6421303Swesolows 		    ASN_OCTET_STR, (uchar_t *)data->d_ari_fmri,
6431303Swesolows 		    strlen(data->d_ari_fmri));
6441303Swesolows 		break;
6451303Swesolows 	case SUNFMRESOURCE_COL_STATUS:
6461303Swesolows 		switch (data->d_ari_flags &
6471303Swesolows 		    (FMD_ADM_RSRC_FAULTY|FMD_ADM_RSRC_UNUSABLE)) {
6481303Swesolows 		default:
6491303Swesolows 			rsrcstate = SUNFMRESOURCE_STATE_OK;
6501303Swesolows 			break;
6511303Swesolows 		case FMD_ADM_RSRC_FAULTY:
6521303Swesolows 			rsrcstate = SUNFMRESOURCE_STATE_DEGRADED;
6531303Swesolows 			break;
6541303Swesolows 		case FMD_ADM_RSRC_UNUSABLE:
6551303Swesolows 			rsrcstate = SUNFMRESOURCE_STATE_UNKNOWN;
6561303Swesolows 			break;
6571303Swesolows 		case FMD_ADM_RSRC_FAULTY | FMD_ADM_RSRC_UNUSABLE:
6581303Swesolows 			rsrcstate = SUNFMRESOURCE_STATE_FAULTED;
6591303Swesolows 			break;
6601303Swesolows 		}
661*11050SRobert.Johnston@Sun.COM 		(void) netsnmp_table_build_result(reginfo, request, table_info,
6621303Swesolows 		    ASN_INTEGER, (uchar_t *)&rsrcstate,
6631303Swesolows 		    sizeof (rsrcstate));
6641303Swesolows 		break;
6651303Swesolows 	case SUNFMRESOURCE_COL_DIAGNOSISUUID:
666*11050SRobert.Johnston@Sun.COM 		(void) netsnmp_table_build_result(reginfo, request, table_info,
6671303Swesolows 		    ASN_OCTET_STR, (uchar_t *)data->d_ari_case,
6681303Swesolows 		    strlen(data->d_ari_case));
6691303Swesolows 		break;
6701303Swesolows 	default:
6711303Swesolows 		break;
6721303Swesolows 	}
6731303Swesolows 	netsnmp_free_delegated_cache(cache);
6741303Swesolows 	(void) pthread_mutex_unlock(&update_lock);
6751303Swesolows }
6761303Swesolows 
6771303Swesolows static int
sunFmResourceTable_handler(netsnmp_mib_handler * handler,netsnmp_handler_registration * reginfo,netsnmp_agent_request_info * reqinfo,netsnmp_request_info * requests)6781303Swesolows sunFmResourceTable_handler(netsnmp_mib_handler *handler,
6791303Swesolows     netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo,
6801303Swesolows     netsnmp_request_info *requests)
6811303Swesolows {
6821303Swesolows 	netsnmp_request_info		*request;
6831303Swesolows 	struct timeval			tv;
6841303Swesolows 
6851303Swesolows 	tv.tv_sec = UPDATE_WAIT_MILLIS / 1000;
6861303Swesolows 	tv.tv_usec = (UPDATE_WAIT_MILLIS % 1000) * 1000;
6871303Swesolows 
6881303Swesolows 	request_update();
6891303Swesolows 
6901303Swesolows 	for (request = requests; request; request = request->next) {
6911303Swesolows 		if (request->processed != 0)
6921303Swesolows 			continue;
6931303Swesolows 
6941303Swesolows 		if (netsnmp_extract_table_info(request) == NULL)
6951303Swesolows 			continue;
6961303Swesolows 
6971303Swesolows 		request->delegated = 1;
6981303Swesolows 		(void) snmp_alarm_register_hr(tv, 0, sunFmResourceTable_return,
6991303Swesolows 		    (void *) netsnmp_create_delegated_cache(handler, reginfo,
7001303Swesolows 		    reqinfo, request, NULL));
7011303Swesolows 	}
7021303Swesolows 
7031303Swesolows 	return (SNMP_ERR_NOERROR);
7041303Swesolows }
7051303Swesolows 
7062134Swesolows /*ARGSUSED*/
7071303Swesolows static void
sunFmResourceCount_return(unsigned int reg,void * arg)7081303Swesolows sunFmResourceCount_return(unsigned int reg, void *arg)
7091303Swesolows {
7101303Swesolows 	netsnmp_delegated_cache		*cache = (netsnmp_delegated_cache *)arg;
7111303Swesolows 	netsnmp_request_info		*request;
7121303Swesolows 	netsnmp_agent_request_info	*reqinfo;
7131303Swesolows 	ulong_t				rsrc_count_long;
7141303Swesolows 
7151303Swesolows 	ASSERT(netsnmp_handler_check_cache(cache) != NULL);
7161303Swesolows 
7171303Swesolows 	(void) pthread_mutex_lock(&update_lock);
7181303Swesolows 	if (update_status != US_QUIET) {
7191303Swesolows 		struct timeval	tv;
7201303Swesolows 
7211303Swesolows 		tv.tv_sec = UPDATE_WAIT_MILLIS / 1000;
7221303Swesolows 		tv.tv_usec = (UPDATE_WAIT_MILLIS % 1000) * 1000;
7231303Swesolows 
7241303Swesolows 		(void) snmp_alarm_register_hr(tv, 0, sunFmResourceCount_return,
7251303Swesolows 		    cache);
7261303Swesolows 		(void) pthread_mutex_unlock(&update_lock);
7271303Swesolows 		return;
7281303Swesolows 	}
7291303Swesolows 
7301303Swesolows 	request = cache->requests;
7311303Swesolows 	reqinfo = cache->reqinfo;
7321303Swesolows 
7331303Swesolows 	request->delegated = 0;
7341303Swesolows 
7351303Swesolows 	switch (reqinfo->mode) {
7362134Swesolows 	/*
7372134Swesolows 	 * According to the documentation, it's not possible for us ever to
7382134Swesolows 	 * be called with MODE_GETNEXT.  However, Net-SNMP does the following:
7392134Swesolows 	 * - set reqinfo->mode to MODE_GET
7402134Swesolows 	 * - invoke the handler
7412134Swesolows 	 * - set reqinfo->mode to MODE_GETNEXT (even if the request was not
7422134Swesolows 	 *   actually processed; i.e. it's been delegated)
7432134Swesolows 	 * Since we're called back later with the same reqinfo, we see
7442134Swesolows 	 * GETNEXT.  Therefore this case is needed to work around the
7452134Swesolows 	 * Net-SNMP bug.
7462134Swesolows 	 */
7471303Swesolows 	case MODE_GET:
7482134Swesolows 	case MODE_GETNEXT:
7491303Swesolows 		DEBUGMSGTL((MODNAME_STR, "resource count is %u\n", rsrc_count));
7501303Swesolows 		rsrc_count_long = (ulong_t)rsrc_count;
751*11050SRobert.Johnston@Sun.COM 		(void) snmp_set_var_typed_value(request->requestvb, ASN_GAUGE,
7521303Swesolows 		    (uchar_t *)&rsrc_count_long, sizeof (rsrc_count_long));
7531303Swesolows 		break;
7541303Swesolows 	default:
755*11050SRobert.Johnston@Sun.COM 		(void) snmp_log(LOG_ERR, MODNAME_STR ": Unsupported request "
756*11050SRobert.Johnston@Sun.COM 		    "mode %d\n", reqinfo->mode);
7571303Swesolows 	}
7581303Swesolows 
7591303Swesolows 	netsnmp_free_delegated_cache(cache);
7601303Swesolows 	(void) pthread_mutex_unlock(&update_lock);
7611303Swesolows }
7621303Swesolows 
7631303Swesolows static int
sunFmResourceCount_handler(netsnmp_mib_handler * handler,netsnmp_handler_registration * reginfo,netsnmp_agent_request_info * reqinfo,netsnmp_request_info * requests)7641303Swesolows sunFmResourceCount_handler(netsnmp_mib_handler *handler,
7651303Swesolows     netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo,
7661303Swesolows     netsnmp_request_info *requests)
7671303Swesolows {
7681303Swesolows 	struct timeval	tv;
7691303Swesolows 
7701303Swesolows 	tv.tv_sec = UPDATE_WAIT_MILLIS / 1000;
7711303Swesolows 	tv.tv_usec = (UPDATE_WAIT_MILLIS % 1000) * 1000;
7721303Swesolows 
7731303Swesolows 	request_update();
7741303Swesolows 
7751303Swesolows 	/*
7761303Swesolows 	 * We are never called for a GETNEXT when registered as an
7771303Swesolows 	 * instance; it's handled for us and converted to a GET.
7781303Swesolows 	 * Also, an instance handler is given only one request at a time, so
7791303Swesolows 	 * we don't need to loop over a list of requests.
7801303Swesolows 	 */
7811303Swesolows 
7821303Swesolows 	if (requests->processed != 0)
7831303Swesolows 		return (SNMP_ERR_NOERROR);
7841303Swesolows 
7851303Swesolows 	requests->delegated = 1;
7861303Swesolows 	(void) snmp_alarm_register_hr(tv, 0, sunFmResourceCount_return,
7871303Swesolows 	    (void *) netsnmp_create_delegated_cache(handler, reginfo,
7881303Swesolows 	    reqinfo, requests, NULL));
7891303Swesolows 
7901303Swesolows 	return (SNMP_ERR_NOERROR);
7911303Swesolows }
792