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 /* 23 * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _FMD_MODULE_H 28 #define _FMD_MODULE_H 29 30 #pragma ident "%Z%%M% %I% %E% SMI" 31 32 #include <sys/types.h> 33 #include <fm/diagcode.h> 34 #include <pthread.h> 35 #include <setjmp.h> 36 37 #ifdef __cplusplus 38 extern "C" { 39 #endif 40 41 #include <fmd_conf.h> 42 #include <fmd_list.h> 43 #include <fmd_serd.h> 44 #include <fmd_buf.h> 45 #include <fmd_api.h> 46 #include <fmd_eventq.h> 47 48 struct fmd_module; /* see below */ 49 struct fmd_thread; /* see <fmd_thread.h> */ 50 struct fmd_idspace; /* see <fmd_idspace.h> */ 51 struct fmd_ustat; /* see <fmd_ustat.h> */ 52 struct fmd_ustat_snap; /* see <fmd_ustat.h> */ 53 54 typedef struct fmd_modops { 55 int (*mop_init)(struct fmd_module *); 56 int (*mop_fini)(struct fmd_module *); 57 void (*mop_dispatch)(struct fmd_module *, struct fmd_event *); 58 int (*mop_transport)(struct fmd_module *, 59 fmd_xprt_t *, struct fmd_event *); 60 } fmd_modops_t; 61 62 typedef struct fmd_modhash { 63 pthread_rwlock_t mh_lock; /* r/w lock to protect hash */ 64 struct fmd_module **mh_hash; /* hash bucket array */ 65 uint_t mh_hashlen; /* size of hash bucket array */ 66 uint_t mh_nelems; /* number of modules in hash */ 67 } fmd_modhash_t; 68 69 /* 70 * Statistics maintained by fmd itself on behalf of all modules for fmstat(1M). 71 * NOTE: FMD_TYPE_STRING statistics should not be used here. If they are 72 * required in the future, the FMD_ADM_MODDSTAT service routine must change. 73 */ 74 typedef struct fmd_modstat { 75 fmd_eventqstat_t ms_evqstat; /* stats for main module event queue */ 76 fmd_stat_t ms_loadtime; /* hrtime at which module was loaded */ 77 fmd_stat_t ms_snaptime; /* hrtime of recent stats snapshot */ 78 fmd_stat_t ms_accepted; /* total events accepted by module */ 79 fmd_stat_t ms_debugdrop; /* dropped debug messages */ 80 fmd_stat_t ms_memtotal; /* total space allocated by module */ 81 fmd_stat_t ms_memlimit; /* limit on space allocated by module */ 82 fmd_stat_t ms_buftotal; /* total space consumed by buffers */ 83 fmd_stat_t ms_buflimit; /* limit on space consumed by buffers */ 84 fmd_stat_t ms_thrtotal; /* total number of auxiliary threads */ 85 fmd_stat_t ms_thrlimit; /* limit on auxiliary threads */ 86 fmd_stat_t ms_caseopen; /* cases currently open */ 87 fmd_stat_t ms_casesolved; /* total cases solved by module */ 88 fmd_stat_t ms_caseclosed; /* total cases closed by module */ 89 fmd_stat_t ms_ckpt_save; /* save checkpoints for module */ 90 fmd_stat_t ms_ckpt_restore; /* restore checkpoints for module */ 91 fmd_stat_t ms_ckpt_zeroed; /* checkpoint was zeroed at startup */ 92 fmd_stat_t ms_ckpt_cnt; /* number of checkpoints taken */ 93 fmd_stat_t ms_ckpt_time; /* total checkpoint time */ 94 fmd_stat_t ms_xprtopen; /* total number of open transports */ 95 fmd_stat_t ms_xprtlimit; /* limit on number of open transports */ 96 fmd_stat_t ms_xprtqlimit; /* limit on transport eventq length */ 97 } fmd_modstat_t; 98 99 typedef struct fmd_module { 100 fmd_list_t mod_list; /* linked list next/prev pointers */ 101 pthread_mutex_t mod_lock; /* lock for mod_cv/owner/flags/refs */ 102 pthread_cond_t mod_cv; /* condition variable for waiters */ 103 pthread_t mod_owner; /* tid of thread that set MOD_LOCK */ 104 uint_t mod_refs; /* module reference count */ 105 uint_t mod_flags; /* miscellaneous flags (see below) */ 106 uint64_t mod_gen; /* module checkpoint generation */ 107 int mod_error; /* error return from module thread */ 108 jmp_buf mod_jmpbuf; /* setjmp data for fmd_module_enter() */ 109 fmd_modhash_t *mod_hash; /* containing namespace (ro) */ 110 struct fmd_module *mod_next; /* next module in fmd_modhash chain */ 111 char *mod_name; /* basename of module (ro) */ 112 char *mod_path; /* full pathname of module file (ro) */ 113 char *mod_ckpt; /* pathname of checkpoint dir (ro) */ 114 nvlist_t *mod_fmri; /* fmri for this module */ 115 const fmd_modops_t *mod_ops; /* module class ops vector (ro) */ 116 void *mod_data; /* data private to module ops vector */ 117 fmd_hdl_info_t *mod_info; /* module info registered with handle */ 118 void *mod_spec; /* fmd_hdl_get/setspecific data value */ 119 int mod_argc; /* size of mod_argv formals array */ 120 fmd_conf_formal_t *mod_argv; /* array of conf file formals */ 121 fmd_conf_t *mod_conf; /* configuration properties (ro) */ 122 struct fm_dc_handle **mod_dictv; /* libdiagcode dictionaries */ 123 int mod_dictc; /* size of mod_dictv array */ 124 size_t mod_codelen; /* libdiagcode maximum string length */ 125 struct fmd_eventq *mod_queue; /* eventq associated with module (ro) */ 126 struct fmd_ustat *mod_ustat; /* collection of custom statistics */ 127 pthread_mutex_t mod_stats_lock; /* lock protecting mod_stats data */ 128 fmd_modstat_t *mod_stats; /* fmd built-in per-module statistics */ 129 struct fmd_thread *mod_thread; /* thread associated with module (ro) */ 130 struct fmd_idspace *mod_threads; /* idspace for alternate thread ids */ 131 struct fmd_idspace *mod_timerids; /* idspace for timer identifiers */ 132 fmd_list_t mod_cases; /* list of cases owned by this module */ 133 fmd_buf_hash_t mod_bufs; /* hash of bufs owned by this module */ 134 fmd_serd_hash_t mod_serds; /* hash of serd engs owned by module */ 135 fmd_list_t mod_transports; /* list of transports owned by module */ 136 } fmd_module_t; 137 138 #define FMD_MOD_INIT 0x001 /* mod_ops->mop_init() has completed */ 139 #define FMD_MOD_FINI 0x002 /* mod_ops->mop_fini() has completed */ 140 #define FMD_MOD_QUIT 0x004 /* module has been requested to quit */ 141 #define FMD_MOD_FAIL 0x008 /* unrecoverable error has occurred */ 142 #define FMD_MOD_LOCK 0x010 /* lock bit for fmd_module_lock() */ 143 #define FMD_MOD_BUSY 0x020 /* module is busy executing a call */ 144 #define FMD_MOD_MDIRTY 0x040 /* module meta state needs checkpoint */ 145 #define FMD_MOD_CDIRTY 0x080 /* module case state needs checkpoint */ 146 #define FMD_MOD_STSUB 0x100 /* stats subscriber is waiting */ 147 #define FMD_MOD_STPUB 0x200 /* stats publisher is waiting */ 148 149 typedef struct fmd_modtimer { 150 fmd_module_t *mt_mod; /* module that installed this timer */ 151 void *mt_arg; /* module private timer argument */ 152 id_t mt_id; /* timer ID (or -1 if still pending) */ 153 } fmd_modtimer_t; 154 155 extern const fmd_modops_t fmd_bltin_ops; /* see fmd/common/fmd_builtin.c */ 156 extern const fmd_modops_t fmd_rtld_ops; /* see fmd/common/fmd_rtld.c */ 157 extern const fmd_modops_t fmd_proc_ops; /* see fmd/common/fmd_proc.c */ 158 159 extern fmd_module_t *fmd_module_create(const char *, const fmd_modops_t *); 160 extern void fmd_module_unload(fmd_module_t *); 161 extern void fmd_module_destroy(fmd_module_t *); 162 163 extern void fmd_module_dispatch(fmd_module_t *, fmd_event_t *); 164 extern int fmd_module_transport(fmd_module_t *, fmd_xprt_t *, fmd_event_t *); 165 extern void fmd_module_timeout(fmd_modtimer_t *, id_t, hrtime_t); 166 extern void fmd_module_gc(fmd_module_t *); 167 extern void fmd_module_trygc(fmd_module_t *); 168 169 extern int fmd_module_contains(fmd_module_t *, fmd_event_t *); 170 extern void fmd_module_setdirty(fmd_module_t *); 171 extern void fmd_module_setcdirty(fmd_module_t *); 172 extern void fmd_module_clrdirty(fmd_module_t *); 173 extern void fmd_module_commit(fmd_module_t *); 174 175 extern void fmd_module_lock(fmd_module_t *); 176 extern void fmd_module_unlock(fmd_module_t *); 177 extern int fmd_module_trylock(fmd_module_t *); 178 extern int fmd_module_locked(fmd_module_t *); 179 180 extern void fmd_module_unregister(fmd_module_t *); 181 extern int fmd_module_enter(fmd_module_t *, void (*)(fmd_hdl_t *)); 182 extern void fmd_module_exit(fmd_module_t *); 183 extern void fmd_module_abort(fmd_module_t *, int) __NORETURN; 184 185 extern void fmd_module_hold(fmd_module_t *); 186 extern void fmd_module_rele(fmd_module_t *); 187 188 extern int fmd_module_dc_opendict(fmd_module_t *, const char *); 189 extern int fmd_module_dc_key2code(fmd_module_t *, 190 char *const [], char *, size_t); 191 192 extern fmd_modhash_t *fmd_modhash_create(void); 193 extern void fmd_modhash_destroy(fmd_modhash_t *); 194 195 extern fmd_module_t *fmd_modhash_load(fmd_modhash_t *, 196 const char *, const fmd_modops_t *); 197 198 extern void fmd_modhash_loadall(fmd_modhash_t *, 199 const fmd_conf_path_t *, const fmd_modops_t *, const char *); 200 201 extern fmd_module_t *fmd_modhash_lookup(fmd_modhash_t *, const char *); 202 extern int fmd_modhash_unload(fmd_modhash_t *, const char *); 203 204 extern void fmd_modhash_apply(fmd_modhash_t *, void (*)(fmd_module_t *)); 205 extern void fmd_modhash_tryapply(fmd_modhash_t *, void (*)(fmd_module_t *)); 206 extern void fmd_modhash_dispatch(fmd_modhash_t *, fmd_event_t *); 207 208 extern void fmd_modstat_publish(fmd_module_t *); 209 extern int fmd_modstat_snapshot(fmd_module_t *, struct fmd_ustat_snap *); 210 211 #ifdef __cplusplus 212 } 213 #endif 214 215 #endif /* _FMD_MODULE_H */ 216