f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * CDDL HEADER START
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * The contents of this file are subject to the terms of the
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * Common Development and Distribution License (the "License").
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * You may not use this file except in compliance with the License.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * See the License for the specific language governing permissions
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * and limitations under the License.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * When distributing Covered Code, include this CDDL HEADER in each
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * If applicable, add the following below this CDDL HEADER, with the
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * fields enclosed by brackets "[]" replaced with your own identifying
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * information: Portions Copyright [yyyy] [name of copyright owner]
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * CDDL HEADER END
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * Code shared by software-diagnosis and software-response modules.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * The fmd module linkage info for the two modules lives in swde_main.c
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * (for software-diagnosis) and swrp_main.c (for software-response).
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * Each subsidiary that is hosted is assigned a unique subsidiary id. These
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * macros convert between the id of a subsidiary and the index used in keeping
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * track of subsidiaries. Outside of this file these ids should remain
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#define ID2IDX(id) ((int)((id) & 0xff0000) >> 16)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#define IDX2ID(i) ((id_t)((i) << 16) | 0x1d000000)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#define SUBIDVALID(msinfo, id) (((int)(id) & 0xff00ffff) == 0x1d000000 && \
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbystatic struct {
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby "total events received" },
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby "events matching some subsidiary" },
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby "callbacks to all subsidiaries" },
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#define BUMPSTAT(stat) sw_stats.stat.fmds_value.ui64++
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#define BUMPSTATN(stat, n) sw_stats.stat.fmds_value.ui64 += (n)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * ========================== Event Receipt =================================
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * The fmdo_recv entry point. See which sub de/response agents have a
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * matching subscription and callback for the first match from each.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * The sub de/response agents should dispatch *all* their subscriptions
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * via their registered dispatch table, including things like list.repaired.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbysw_recv(fmd_hdl_t *hdl, fmd_event_t *ep, nvlist_t *nvl, const char *class)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo = (struct sw_modspecific *)fmd_hdl_getspecific(hdl);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * For each sub module that has a matching class pattern call the
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * registered callback for that sub DE. Only one match per sub module
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * is allowed (the first match in its table, others are not checked).
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby for (mod = 0; mod < msinfo->swms_dispcnt; mod++) {
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby dp != NULL && dp->swd_classpat != NULL; dp++) {
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby if (fmd_nvl_class_match(hdl, nvl, dp->swd_classpat)) {
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * ========================== Timers ========================================
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * A subsidiary can install a timer; it must pass an additional argument
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * identifying itself so that we can hand off to the appropriate
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * swsub_timeout function in the fmdo_timeout entry point when the timer fires.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbysw_timer_install(fmd_hdl_t *hdl, id_t who, void *arg, fmd_event_t *ep,
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo = (struct sw_modspecific *)fmd_hdl_getspecific(hdl);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_abort(hdl, "sw_timer_install: invalid subid %d\n", who);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_abort(hdl, "sw_timer_install: no swsub_timeout\n");
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * Look for a slot. Module entry points are single-threaded
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * in nature, but if someone installs a timer from a door
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * service function we're contended.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby (void) pthread_mutex_lock(&msinfo->swms_timerlock);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby if (msinfo->swms_timers[slot].swt_state != SW_TMR_INUSE) {
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo->swms_timers[chosen].swt_state = SW_TMR_INUSE;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo->swms_timers[chosen].swt_timerid = timerid =
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby (void) pthread_mutex_unlock(&msinfo->swms_timerlock);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * Look for a timer installed by a given subsidiary matching timerid.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbysubtimer_find(struct sw_modspecific *msinfo, id_t who, id_t timerid)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby if (msinfo->swms_timers[slot].swt_state == SW_TMR_INUSE &&
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo->swms_timers[slot].swt_ownerid == who) &&
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo->swms_timers[slot].swt_timerid == timerid)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby return (-1);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbysw_timer_remove(fmd_hdl_t *hdl, id_t who, id_t timerid)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo = (struct sw_modspecific *)fmd_hdl_getspecific(hdl);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_abort(hdl, "sw_timer_remove: invalid subid\n");
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby (void) pthread_mutex_lock(&msinfo->swms_timerlock);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby if ((slot = subtimer_find(msinfo, who, timerid)) == -1)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_abort(hdl, "sw_timer_remove: timerid %d not found "
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo->swms_timers[slot].swt_state = SW_TMR_RMVD;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby (void) pthread_mutex_unlock(&msinfo->swms_timerlock);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * The fmdo_timeout entry point.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbysw_timeout(fmd_hdl_t *hdl, id_t timerid, void *arg)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo = (struct sw_modspecific *)fmd_hdl_getspecific(hdl);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby (void) pthread_mutex_lock(&msinfo->swms_timerlock);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby if ((slot = subtimer_find(msinfo, -1, timerid)) == -1)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_abort(hdl, "sw_timeout: timerid %d not found\n");
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby (void) pthread_mutex_unlock(&msinfo->swms_timerlock);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_abort(hdl, "sw_timeout: invalid subid\n");
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * ========================== sw_subinfo access =============================
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo = (struct sw_modspecific *)fmd_hdl_getspecific(hdl);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_abort(hdl, "sw_id_to_casetype: invalid subid %d\n",
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby if ((sip->swsub_casetype & SW_CASE_NONE) != SW_CASE_NONE)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_abort(hdl, "sw_id_to_casetype: bad case type %d "
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby "for %s\n", sip->swsub_casetype, sip->swsub_name);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * Given a case type lookup the struct sw_subinfo for the subsidiary
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * that opens cases of that type.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbystatic const struct sw_subinfo *
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbysw_subinfo_bycase(fmd_hdl_t *hdl, enum sw_casetype type)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo = (struct sw_modspecific *)fmd_hdl_getspecific(hdl);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby for (i = 0; i < SW_SUB_MAX; i++) {
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * Find the case close function for the given case type; can be NULL.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbysw_sub_case_close_func(fmd_hdl_t *hdl, enum sw_casetype type)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby if ((sip = sw_subinfo_bycase(hdl, type)) == NULL)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_abort(hdl, "sw_sub_case_close_func: case type "
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * Find the case verify function for the given case type; can be NULL.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbysw_sub_case_vrfy_func(fmd_hdl_t *hdl, enum sw_casetype type)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby if ((sip = sw_subinfo_bycase(hdl, type)) == NULL)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_abort(hdl, "sw_sub_case_vrfy_func: case type "
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * ========================== Initialization ================================
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * The two modules - software-diagnosis and software-response - call
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * sw_fmd_init from their _fmd_init entry points.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbysw_add_callbacks(fmd_hdl_t *hdl, const char *who,
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby const struct sw_disp *dp, int nelem, struct sw_modspecific *msinfo)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby (*msinfo->swms_disptbl)[msinfo->swms_dispcnt++] = dp;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby return; /* subsidiary failed init */
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby /* check that the nelem'th entry is the NULL termination */
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby dp[nelem - 1].swd_func != NULL || dp[nelem - 1].swd_arg != NULL)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_abort(hdl, "subsidiary %s dispatch table not NULL-"
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby /* now validate the entries; we allow NULL handlers */
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_abort(hdl, "subsidiary %s dispatch table entry "
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby "%d has a NULL pattern or function\n", who, i);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbysw_fmd_init(fmd_hdl_t *hdl, const fmd_hdl_info_t *hdlinfo,
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby const struct sw_subinfo *(*subsid)[SW_SUB_MAX])
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby if (fmd_hdl_register(hdl, FMD_API_VERSION, hdlinfo) != 0)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby if (fmd_prop_get_int32(hdl, "enable") != B_TRUE) {
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_debug(hdl, "%s disabled though .conf file setting\n",
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo = fmd_hdl_zalloc(hdl, sizeof (*msinfo), FMD_SLEEP);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby SW_SUB_MAX * sizeof (struct sw_disp *), FMD_SLEEP);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby (void) pthread_mutex_init(&msinfo->swms_timerlock, NULL);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby for (i = 0; i < SW_TIMER_MAX; i++)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo->swms_timers[i].swt_state = SW_TMR_UNTOUCHED;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby (void) fmd_stat_create(hdl, FMD_STAT_NOALLOC, sizeof (sw_stats) /
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * Initialize subsidiaries. Each must make any subscription
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * requests it needs and return a pointer to a NULL-terminated
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * callback dispatch table and an indication of the number of
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * entries in that table including the NULL termination entry.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby for (i = 0; i < SW_SUB_MAX; i++) {
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby initrslt = (*sip->swsub_init)(hdl, IDX2ID(i), &dp, &nelem);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby "subsidiary %d (id 0x%lx) '%s'",
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby "table 0x%p and nelem %d\n",
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_debug(hdl, "%s initialized\n", dbgbuf);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby sw_add_callbacks(hdl, sip->swsub_name, dp, nelem,
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_debug(hdl, "%s chose not to initialize\n",
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby sw_add_callbacks(hdl, sip->swsub_name, NULL, -1,
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby sw_add_callbacks(hdl, sip->swsub_name, NULL, -1,
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_hdl_abort(hdl, "%s returned out-of-range result "
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo = (struct sw_modspecific *)fmd_hdl_getspecific(hdl);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby (void) pthread_mutex_lock(&msinfo->swms_timerlock);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby for (i = 0; i < SW_TIMER_MAX; i++) {
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby if (msinfo->swms_timers[i].swt_state != SW_TMR_INUSE)
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby fmd_timer_remove(hdl, msinfo->swms_timers[i].swt_timerid);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby msinfo->swms_timers[i].swt_state = SW_TMR_RMVD;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby (void) pthread_mutex_unlock(&msinfo->swms_timerlock);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby (void) pthread_mutex_destroy(&msinfo->swms_timerlock);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby continue; /* swsub_init did not succeed */