xref: /titanic_41/usr/src/cmd/fm/fmd/common/fmd.c (revision 3db86aab554edbb4244c8d1a1c90f152eee768af)
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 #pragma ident	"%Z%%M%	%I%	%E% SMI"
28 
29 #include <sys/types.h>
30 #include <sys/utsname.h>
31 #include <sys/param.h>
32 #include <sys/systeminfo.h>
33 #include <sys/fm/util.h>
34 #include <fm/libtopo.h>
35 
36 #include <smbios.h>
37 #include <limits.h>
38 #include <unistd.h>
39 #include <signal.h>
40 #include <stdlib.h>
41 #include <stdio.h>
42 #include <door.h>
43 
44 #include <fmd_conf.h>
45 #include <fmd_dispq.h>
46 #include <fmd_timerq.h>
47 #include <fmd_subr.h>
48 #include <fmd_error.h>
49 #include <fmd_module.h>
50 #include <fmd_thread.h>
51 #include <fmd_alloc.h>
52 #include <fmd_string.h>
53 #include <fmd_builtin.h>
54 #include <fmd_ustat.h>
55 #include <fmd_protocol.h>
56 #include <fmd_scheme.h>
57 #include <fmd_asru.h>
58 #include <fmd_case.h>
59 #include <fmd_log.h>
60 #include <fmd_idspace.h>
61 #include <fmd_rpc.h>
62 #include <fmd_dr.h>
63 #include <fmd_xprt.h>
64 #include <fmd_ctl.h>
65 #include <sys/openpromio.h>
66 #include <libdevinfo.h>
67 
68 #include <fmd.h>
69 
70 extern const nv_alloc_ops_t fmd_nv_alloc_ops;	/* see fmd_nv.c */
71 
72 const char _fmd_version[] = "1.1";		/* daemon version string */
73 static char _fmd_plat[MAXNAMELEN];		/* native platform string */
74 static char _fmd_isa[MAXNAMELEN];		/* native instruction set */
75 static struct utsname _fmd_uts;			/* native uname(2) info */
76 static char _fmd_csn[MAXNAMELEN];		/* chassis serial number */
77 static char _fmd_prod[MAXNAMELEN];		/* product name string */
78 
79 /*
80  * Note: the configuration file path is ordered from most common to most host-
81  * specific because new conf files are merged/override previous ones.  The
82  * module paths are in the opposite order, from most specific to most common,
83  * because once a module is loaded fmd will not try to load over the same name.
84  */
85 
86 static const char _fmd_conf_path[] =
87 	"%r/usr/lib/fm/fmd:"
88 	"%r/usr/platform/%m/lib/fm/fmd:"
89 	"%r/usr/platform/%i/lib/fm/fmd:"
90 	"%r/etc/fm/fmd";
91 
92 static const char _fmd_agent_path[] =
93 	"%r/usr/platform/%i/lib/fm/fmd/agents:"
94 	"%r/usr/platform/%m/lib/fm/fmd/agents:"
95 	"%r/usr/lib/fm/fmd/agents";
96 
97 static const char _fmd_plugin_path[] =
98 	"%r/usr/platform/%i/lib/fm/fmd/plugins:"
99 	"%r/usr/platform/%m/lib/fm/fmd/plugins:"
100 	"%r/usr/lib/fm/fmd/plugins";
101 
102 static const char _fmd_scheme_path[] =
103 	"usr/lib/fm/fmd/schemes";
104 
105 static const fmd_conf_mode_t _fmd_cerror_modes[] = {
106 	{ "unload", "unload offending client module", FMD_CERROR_UNLOAD },
107 	{ "stop", "stop daemon for debugger attach", FMD_CERROR_STOP },
108 	{ "abort", "abort daemon and force core dump", FMD_CERROR_ABORT },
109 	{ NULL, NULL, 0 }
110 };
111 
112 static const fmd_conf_mode_t _fmd_dbout_modes[] = {
113 	{ "stderr", "send debug messages to stderr", FMD_DBOUT_STDERR },
114 	{ "syslog", "send debug messages to syslog", FMD_DBOUT_SYSLOG },
115 	{ NULL, NULL, 0 }
116 };
117 
118 static const fmd_conf_mode_t _fmd_debug_modes[] = {
119 	{ "help", "display debugging modes and exit", FMD_DBG_HELP },
120 	{ "mod", "debug module load/unload/locking", FMD_DBG_MOD },
121 	{ "disp", "debug dispatch queue processing", FMD_DBG_DISP },
122 	{ "xprt", "debug transport-specific routines", FMD_DBG_XPRT },
123 	{ "evt", "debug event subsystem routines", FMD_DBG_EVT },
124 	{ "log", "debug log subsystem routines", FMD_DBG_LOG },
125 	{ "tmr", "debug timer subsystem routines", FMD_DBG_TMR },
126 	{ "fmri", "debug fmri subsystem routines", FMD_DBG_FMRI },
127 	{ "asru", "debug asru subsystem routines", FMD_DBG_ASRU },
128 	{ "case", "debug case subsystem routines", FMD_DBG_CASE },
129 	{ "ckpt", "debug checkpoint routines", FMD_DBG_CKPT },
130 	{ "rpc", "debug rpc service routines", FMD_DBG_RPC },
131 	{ "trace", "display matching trace calls", FMD_DBG_TRACE },
132 	{ "all", "enable all available debug modes", FMD_DBG_ALL },
133 	{ NULL, NULL, 0 }
134 };
135 
136 static int
137 fmd_cerror_set(fmd_conf_param_t *pp, const char *value)
138 {
139 	return (fmd_conf_mode_set(_fmd_cerror_modes, pp, value));
140 }
141 
142 static int
143 fmd_dbout_set(fmd_conf_param_t *pp, const char *value)
144 {
145 	return (fmd_conf_mode_set(_fmd_dbout_modes, pp, value));
146 }
147 
148 static int
149 fmd_debug_set(fmd_conf_param_t *pp, const char *value)
150 {
151 	int err = fmd_conf_mode_set(_fmd_debug_modes, pp, value);
152 
153 	if (err == 0)
154 		fmd.d_fmd_debug = pp->cp_value.cpv_num;
155 
156 	return (err);
157 }
158 
159 static int
160 fmd_trmode_set(fmd_conf_param_t *pp, const char *value)
161 {
162 	fmd_tracebuf_f *func;
163 
164 	if (strcasecmp(value, "none") == 0)
165 		func = fmd_trace_none;
166 	else if (strcasecmp(value, "lite") == 0)
167 		func = fmd_trace_lite;
168 	else if (strcasecmp(value, "full") == 0)
169 		func = fmd_trace_full;
170 	else
171 		return (fmd_set_errno(EFMD_CONF_INVAL));
172 
173 	fmd.d_thr_trace = (void (*)())func;
174 	pp->cp_value.cpv_ptr = (void *)func;
175 	return (0);
176 }
177 
178 static void
179 fmd_trmode_get(const fmd_conf_param_t *pp, void *ptr)
180 {
181 	*((void **)ptr) = pp->cp_value.cpv_ptr;
182 }
183 
184 static int
185 fmd_clkmode_set(fmd_conf_param_t *pp, const char *value)
186 {
187 	const fmd_timeops_t *ops;
188 
189 	if (strcasecmp(value, "native") == 0)
190 		ops = &fmd_timeops_native;
191 	else if (strcasecmp(value, "simulated") == 0)
192 		ops = &fmd_timeops_simulated;
193 	else
194 		return (fmd_set_errno(EFMD_CONF_INVAL));
195 
196 	fmd.d_clockops = ops;
197 	pp->cp_value.cpv_ptr = (void *)ops;
198 	return (0);
199 }
200 
201 static void
202 fmd_clkmode_get(const fmd_conf_param_t *pp, void *ptr)
203 {
204 	*((void **)ptr) = pp->cp_value.cpv_ptr;
205 }
206 
207 static const fmd_conf_ops_t fmd_cerror_ops = {
208 	fmd_cerror_set, fmd_conf_mode_get, fmd_conf_notsup, fmd_conf_nop
209 };
210 
211 static const fmd_conf_ops_t fmd_dbout_ops = {
212 	fmd_dbout_set, fmd_conf_mode_get, fmd_conf_notsup, fmd_conf_nop
213 };
214 
215 static const fmd_conf_ops_t fmd_debug_ops = {
216 	fmd_debug_set, fmd_conf_mode_get, fmd_conf_notsup, fmd_conf_nop
217 };
218 
219 static const fmd_conf_ops_t fmd_trmode_ops = {
220 	fmd_trmode_set, fmd_trmode_get, fmd_conf_notsup, fmd_conf_nop
221 };
222 
223 static const fmd_conf_ops_t fmd_clkmode_ops = {
224 	fmd_clkmode_set, fmd_clkmode_get, fmd_conf_notsup, fmd_conf_nop
225 };
226 
227 static const fmd_conf_formal_t _fmd_conf[] = {
228 { "agent.path", &fmd_conf_path, _fmd_agent_path }, /* path for agents */
229 { "alloc_msecs", &fmd_conf_uint32, "10" },	/* msecs before alloc retry */
230 { "alloc_tries", &fmd_conf_uint32, "3" },	/* max # of alloc retries */
231 { "chassis", &fmd_conf_string, _fmd_csn },	/* chassis serial number */
232 { "ckpt.dir", &fmd_conf_string, "var/fm/fmd/ckpt" }, /* ckpt directory path */
233 { "ckpt.dirmode", &fmd_conf_int32, "0700" },	/* ckpt directory perm mode */
234 { "ckpt.mode", &fmd_conf_int32, "0400" },	/* ckpt file perm mode */
235 { "ckpt.restore", &fmd_conf_bool, "true" },	/* restore checkpoints? */
236 { "ckpt.save", &fmd_conf_bool, "true" },	/* save checkpoints? */
237 { "ckpt.zero", &fmd_conf_bool, "false" },	/* zero checkpoints on start? */
238 { "client.buflim", &fmd_conf_size, "10m" },	/* client buffer space limit */
239 { "client.dbout", &fmd_dbout_ops, NULL },	/* client debug output sinks */
240 { "client.debug", &fmd_conf_bool, NULL },	/* client debug enable */
241 { "client.error", &fmd_cerror_ops, "unload" },	/* client error policy */
242 { "client.memlim", &fmd_conf_size, "10m" },	/* client allocation limit */
243 { "client.evqlim", &fmd_conf_uint32, "256" },	/* client event queue limit */
244 { "client.thrlim", &fmd_conf_uint32, "8" },	/* client aux thread limit */
245 { "client.thrsig", &fmd_conf_signal, "SIGUSR1" }, /* fmd_thr_signal() value */
246 { "client.tmrlim", &fmd_conf_uint32, "1024" },	/* client pending timer limit */
247 { "client.xprtlim", &fmd_conf_uint32, "256" },	/* client transport limit */
248 { "client.xprtlog", &fmd_conf_bool, NULL },	/* client transport logging? */
249 { "client.xprtqlim", &fmd_conf_uint32, "256" }, /* client transport queue lim */
250 { "clock", &fmd_clkmode_ops, "native" },	/* clock operation mode */
251 { "conf_path", &fmd_conf_path, _fmd_conf_path }, /* root config file path */
252 { "conf_file", &fmd_conf_string, "fmd.conf" },	/* root config file name */
253 { "core", &fmd_conf_bool, "false" },		/* force core dump on quit */
254 { "dbout", &fmd_dbout_ops, NULL },		/* daemon debug output sinks */
255 { "debug", &fmd_debug_ops, NULL },		/* daemon debugging flags */
256 { "dictdir", &fmd_conf_string, "usr/lib/fm/dict" }, /* default diagcode dir */
257 { "domain", &fmd_conf_string, NULL },		/* domain id for de auth */
258 { "fg", &fmd_conf_bool, "false" },		/* run daemon in foreground */
259 { "gc_interval", &fmd_conf_time, "1d" },	/* garbage collection intvl */
260 { "ids.avg", &fmd_conf_uint32, "4" },		/* desired idspace chain len */
261 { "ids.max", &fmd_conf_uint32, "1024" },	/* maximum idspace buckets */
262 { "isaname", &fmd_conf_string, _fmd_isa },	/* instruction set (uname -p) */
263 { "log.creator", &fmd_conf_string, "fmd" },	/* exacct log creator string */
264 { "log.error", &fmd_conf_string, "var/fm/fmd/errlog" }, /* error log path */
265 { "log.fault", &fmd_conf_string, "var/fm/fmd/fltlog" }, /* fault log path */
266 { "log.minfree", &fmd_conf_size, "2m" },	/* min log fsys free space */
267 { "log.rsrc", &fmd_conf_string, "var/fm/fmd/rsrc" }, /* asru log dir path */
268 { "log.tryrotate", &fmd_conf_uint32, "10" },	/* max log rotation attempts */
269 { "log.waitrotate", &fmd_conf_time, "200ms" },	/* log rotation retry delay */
270 { "log.xprt", &fmd_conf_string, "var/fm/fmd/xprt" }, /* transport log dir */
271 { "machine", &fmd_conf_string, _fmd_uts.machine }, /* machine name (uname -m) */
272 { "nodiagcode", &fmd_conf_string, "-" },	/* diagcode to use if error */
273 { "osrelease", &fmd_conf_string, _fmd_uts.release }, /* release (uname -r) */
274 { "osversion", &fmd_conf_string, _fmd_uts.version }, /* version (uname -v) */
275 { "platform", &fmd_conf_string, _fmd_plat },	/* platform string (uname -i) */
276 { "plugin.close", &fmd_conf_bool, "true" },	/* dlclose plugins on fini */
277 { "plugin.path", &fmd_conf_path, _fmd_plugin_path }, /* path for plugin mods */
278 { "product", &fmd_conf_string, _fmd_prod },	/* product name string */
279 { "rootdir", &fmd_conf_string, "" },		/* root directory for paths */
280 { "rpc.adm.path", &fmd_conf_string, NULL },	/* FMD_ADM rendezvous file */
281 { "rpc.adm.prog", &fmd_conf_uint32, "100169" },	/* FMD_ADM rpc program num */
282 { "rpc.api.path", &fmd_conf_string, NULL },	/* FMD_API rendezvous file */
283 { "rpc.api.prog", &fmd_conf_uint32, "100170" },	/* FMD_API rpc program num */
284 { "rpc.rcvsize", &fmd_conf_size, "128k" },	/* rpc receive buffer size */
285 { "rpc.sndsize", &fmd_conf_size, "128k" },	/* rpc send buffer size */
286 { "rsrc.age", &fmd_conf_time, "30d" },		/* max age of old rsrc log */
287 { "rsrc.zero", &fmd_conf_bool, "false" },	/* zero rsrc cache on start? */
288 { "schemedir", &fmd_conf_string, _fmd_scheme_path }, /* path for scheme mods */
289 { "self.name", &fmd_conf_string, "fmd-self-diagnosis" }, /* self-diag module */
290 { "self.dict", &fmd_conf_list, "FMD.dict" },	/* self-diag dictionary list */
291 { "server", &fmd_conf_string, _fmd_uts.nodename }, /* server id for de auth */
292 { "strbuckets", &fmd_conf_uint32, "211" },	/* size of string hashes */
293 #ifdef DEBUG
294 { "trace.mode", &fmd_trmode_ops, "full" },	/* trace mode: none/lite/full */
295 #else
296 { "trace.mode", &fmd_trmode_ops, "lite" },	/* trace mode: none/lite/full */
297 #endif
298 { "trace.recs", &fmd_conf_uint32, "128" },	/* trace records per thread */
299 { "trace.frames", &fmd_conf_uint32, "16" },	/* max trace rec stack frames */
300 { "uuidlen", &fmd_conf_uint32, "36" },		/* UUID ASCII string length */
301 { "xprt.ttl", &fmd_conf_uint8, "1" },		/* default event time-to-live */
302 };
303 
304 /*
305  * Statistics maintained by fmd itself on behalf of various global subsystems.
306  * NOTE: FMD_TYPE_STRING statistics should not be used here.  If they are
307  * required in the future, the FMD_ADM_MODGSTAT service routine must change.
308  */
309 static fmd_statistics_t _fmd_stats = {
310 { "errlog.replayed", FMD_TYPE_UINT64, "total events replayed from errlog" },
311 { "errlog.partials", FMD_TYPE_UINT64, "events partially committed in errlog" },
312 { "errlog.enospc", FMD_TYPE_UINT64, "events not appended to errlog (ENOSPC)" },
313 { "fltlog.enospc", FMD_TYPE_UINT64, "events not appended to fltlog (ENOSPC)" },
314 { "log.enospc", FMD_TYPE_UINT64, "events not appended to other logs (ENOSPC)" },
315 { "dr.gen", FMD_TYPE_UINT64, "dynamic reconfiguration generation" },
316 };
317 
318 void
319 fmd_create(fmd_t *dp, const char *arg0, const char *root, const char *conf)
320 {
321 	fmd_conf_path_t *pap;
322 	char file[PATH_MAX];
323 	const char *name;
324 	fmd_stat_t *sp;
325 	int i;
326 
327 	smbios_hdl_t *shp;
328 	smbios_system_t s1;
329 	smbios_info_t s2;
330 	id_t id;
331 
332 	di_prom_handle_t promh = DI_PROM_HANDLE_NIL;
333 	di_node_t rooth = DI_NODE_NIL;
334 	char *bufp;
335 
336 	(void) sysinfo(SI_PLATFORM, _fmd_plat, sizeof (_fmd_plat));
337 	(void) sysinfo(SI_ARCHITECTURE, _fmd_isa, sizeof (_fmd_isa));
338 	(void) uname(&_fmd_uts);
339 
340 	if ((shp = smbios_open(NULL, SMB_VERSION, 0, NULL)) != NULL) {
341 		if ((id = smbios_info_system(shp, &s1)) != SMB_ERR &&
342 		    smbios_info_common(shp, id, &s2) != SMB_ERR) {
343 			(void) strlcpy(_fmd_prod, s2.smbi_product, MAXNAMELEN);
344 			(void) strlcpy(_fmd_csn, s2.smbi_serial, MAXNAMELEN);
345 		}
346 		smbios_close(shp);
347 	} else if ((rooth = di_init("/", DINFOCPYALL)) != DI_NODE_NIL &&
348 	    (promh = di_prom_init()) != DI_PROM_HANDLE_NIL) {
349 		if (di_prom_prop_lookup_bytes(promh, rooth, "chassis-sn",
350 		    (unsigned char **)&bufp) != -1) {
351 			(void) strlcpy(_fmd_csn, bufp, MAXNAMELEN);
352 		}
353 	}
354 
355 	if (promh != DI_PROM_HANDLE_NIL)
356 		di_prom_fini(promh);
357 	if (rooth != DI_NODE_NIL)
358 		di_fini(rooth);
359 
360 	bzero(dp, sizeof (fmd_t));
361 
362 	dp->d_version = _fmd_version;
363 	dp->d_pname = fmd_strbasename(arg0);
364 	dp->d_pid = getpid();
365 
366 	if (pthread_key_create(&dp->d_key, NULL) != 0)
367 		fmd_error(EFMD_EXIT, "failed to create pthread key");
368 
369 	(void) pthread_mutex_init(&dp->d_xprt_lock, NULL);
370 	(void) pthread_mutex_init(&dp->d_err_lock, NULL);
371 	(void) pthread_mutex_init(&dp->d_thr_lock, NULL);
372 	(void) pthread_mutex_init(&dp->d_mod_lock, NULL);
373 	(void) pthread_mutex_init(&dp->d_stats_lock, NULL);
374 	(void) pthread_rwlock_init(&dp->d_log_lock, NULL);
375 
376 	/*
377 	 * A small number of properties must be set manually before we open
378 	 * the root configuration file.  These include any settings for our
379 	 * memory allocator and path expansion token values, because these
380 	 * values are needed by the routines in fmd_conf.c itself.  After
381 	 * the root configuration file is processed, we reset these properties
382 	 * based upon the latest values from the configuration file.
383 	 */
384 	dp->d_alloc_msecs = 10;
385 	dp->d_alloc_tries = 3;
386 	dp->d_str_buckets = 211;
387 
388 	dp->d_rootdir = root ? root : "";
389 	dp->d_platform = _fmd_plat;
390 	dp->d_machine = _fmd_uts.machine;
391 	dp->d_isaname = _fmd_isa;
392 
393 	dp->d_conf = fmd_conf_open(conf, sizeof (_fmd_conf) /
394 	    sizeof (_fmd_conf[0]), _fmd_conf, FMD_CONF_DEFER);
395 
396 	if (dp->d_conf == NULL) {
397 		fmd_error(EFMD_EXIT,
398 		    "failed to load required configuration properties\n");
399 	}
400 
401 	(void) fmd_conf_getprop(dp->d_conf, "alloc.msecs", &dp->d_alloc_msecs);
402 	(void) fmd_conf_getprop(dp->d_conf, "alloc.tries", &dp->d_alloc_tries);
403 	(void) fmd_conf_getprop(dp->d_conf, "strbuckets", &dp->d_str_buckets);
404 
405 	(void) fmd_conf_getprop(dp->d_conf, "platform", &dp->d_platform);
406 	(void) fmd_conf_getprop(dp->d_conf, "machine", &dp->d_machine);
407 	(void) fmd_conf_getprop(dp->d_conf, "isaname", &dp->d_isaname);
408 
409 	/*
410 	 * Manually specified rootdirs override config files, so only update
411 	 * d_rootdir based on the config files we parsed if no 'root' was set.
412 	 */
413 	if (root == NULL)
414 		(void) fmd_conf_getprop(dp->d_conf, "rootdir", &dp->d_rootdir);
415 	else
416 		(void) fmd_conf_setprop(dp->d_conf, "rootdir", dp->d_rootdir);
417 
418 	/*
419 	 * Once the base conf file properties are loaded, lookup the values
420 	 * of $conf_path and $conf_file and merge in any other conf files.
421 	 */
422 	(void) fmd_conf_getprop(dp->d_conf, "conf_path", &pap);
423 	(void) fmd_conf_getprop(dp->d_conf, "conf_file", &name);
424 
425 	for (i = 0; i < pap->cpa_argc; i++) {
426 		(void) snprintf(file, sizeof (file),
427 		    "%s/%s", pap->cpa_argv[i], name);
428 		if (access(file, F_OK) == 0)
429 			fmd_conf_merge(dp->d_conf, file);
430 	}
431 
432 	/*
433 	 * Update the value of fmd.d_fg based on "fg".  We cache this property
434 	 * because it must be accessed deep within fmd at fmd_verror() time.
435 	 * Update any other properties that must be cached for performance.
436 	 */
437 	(void) fmd_conf_getprop(fmd.d_conf, "fg", &fmd.d_fg);
438 	(void) fmd_conf_getprop(fmd.d_conf, "xprt.ttl", &fmd.d_xprt_ttl);
439 
440 	/*
441 	 * Initialize our custom libnvpair allocator and create an nvlist for
442 	 * authority elements corresponding to this instance of the daemon.
443 	 */
444 	(void) nv_alloc_init(&dp->d_nva, &fmd_nv_alloc_ops);
445 	dp->d_auth = fmd_protocol_authority();
446 
447 	/*
448 	 * The fmd_module_t for the root module must be created manually.  Most
449 	 * of it remains unused and zero, except for the few things we fill in.
450 	 */
451 	dp->d_rmod = fmd_zalloc(sizeof (fmd_module_t), FMD_SLEEP);
452 	dp->d_rmod->mod_name = fmd_strdup(dp->d_pname, FMD_SLEEP);
453 	dp->d_rmod->mod_fmri = fmd_protocol_fmri_module(dp->d_rmod);
454 
455 	fmd_list_append(&dp->d_mod_list, dp->d_rmod);
456 	fmd_module_hold(dp->d_rmod);
457 
458 	(void) pthread_mutex_init(&dp->d_rmod->mod_lock, NULL);
459 	(void) pthread_cond_init(&dp->d_rmod->mod_cv, NULL);
460 	(void) pthread_mutex_init(&dp->d_rmod->mod_stats_lock, NULL);
461 
462 	dp->d_rmod->mod_thread = fmd_thread_xcreate(dp->d_rmod, pthread_self());
463 	dp->d_rmod->mod_stats = fmd_zalloc(sizeof (fmd_modstat_t), FMD_SLEEP);
464 	dp->d_rmod->mod_ustat = fmd_ustat_create();
465 
466 	if (pthread_setspecific(dp->d_key, dp->d_rmod->mod_thread) != 0)
467 		fmd_error(EFMD_EXIT, "failed to attach main thread key");
468 
469 	if ((dp->d_stats = (fmd_statistics_t *)fmd_ustat_insert(
470 	    dp->d_rmod->mod_ustat, FMD_USTAT_NOALLOC, sizeof (_fmd_stats) /
471 	    sizeof (fmd_stat_t), (fmd_stat_t *)&_fmd_stats, NULL)) == NULL)
472 		fmd_error(EFMD_EXIT, "failed to initialize statistics");
473 
474 	(void) pthread_mutex_lock(&dp->d_rmod->mod_lock);
475 	dp->d_rmod->mod_flags |= FMD_MOD_INIT;
476 	(void) pthread_mutex_unlock(&dp->d_rmod->mod_lock);
477 
478 	/*
479 	 * In addition to inserting the _fmd_stats collection of program-wide
480 	 * statistics, we also insert a statistic named after each of our
481 	 * errors and update these counts in fmd_verror() (see fmd_subr.c).
482 	 */
483 	dp->d_errstats = sp = fmd_zalloc(sizeof (fmd_stat_t) *
484 	    (EFMD_END - EFMD_UNKNOWN), FMD_SLEEP);
485 
486 	for (i = 0; i < EFMD_END - EFMD_UNKNOWN; i++, sp++) {
487 		(void) snprintf(sp->fmds_name, sizeof (sp->fmds_name), "err.%s",
488 		    strrchr(fmd_errclass(EFMD_UNKNOWN + i), '.') + 1);
489 		sp->fmds_type = FMD_TYPE_UINT64;
490 	}
491 
492 	(void) fmd_ustat_insert(dp->d_rmod->mod_ustat, FMD_USTAT_NOALLOC,
493 	    EFMD_END - EFMD_UNKNOWN, dp->d_errstats, NULL);
494 }
495 
496 void
497 fmd_destroy(fmd_t *dp)
498 {
499 	fmd_module_t *mp;
500 	fmd_case_t *cp;
501 	int core;
502 
503 	(void) fmd_conf_getprop(fmd.d_conf, "core", &core);
504 
505 	fmd_rpc_fini();
506 	fmd_dr_fini();
507 
508 	if (dp->d_xprt_ids != NULL)
509 		fmd_xprt_suspend_all();
510 
511 	/*
512 	 * Unload the self-diagnosis module first.  This ensures that it does
513 	 * not get confused as we start unloading other modules, etc.  We must
514 	 * hold the dispq lock as a writer while doing so since it uses d_self.
515 	 */
516 	if (dp->d_self != NULL) {
517 		(void) pthread_rwlock_wrlock(&dp->d_disp->dq_lock);
518 		fmd_module_unload(dp->d_self);
519 		fmd_module_rele(dp->d_self);
520 		dp->d_self = NULL;
521 		(void) pthread_rwlock_unlock(&dp->d_disp->dq_lock);
522 	}
523 
524 	/*
525 	 * Unload modules in reverse order *except* for the root module, which
526 	 * is first in the list.  This allows it to keep its thread and trace.
527 	 */
528 	for (mp = fmd_list_prev(&dp->d_mod_list); mp != dp->d_rmod; ) {
529 		fmd_module_unload(mp);
530 		mp = fmd_list_prev(mp);
531 	}
532 
533 	if (dp->d_mod_hash != NULL) {
534 		fmd_modhash_destroy(dp->d_mod_hash);
535 		dp->d_mod_hash = NULL;
536 	}
537 
538 	/*
539 	 * Close both log files now that modules are no longer active.  We must
540 	 * set these pointers to NULL in case any subsequent errors occur.
541 	 */
542 	if (dp->d_errlog != NULL) {
543 		fmd_log_rele(dp->d_errlog);
544 		dp->d_errlog = NULL;
545 	}
546 
547 	if (dp->d_fltlog != NULL) {
548 		fmd_log_rele(dp->d_fltlog);
549 		dp->d_fltlog = NULL;
550 	}
551 
552 	/*
553 	 * Now destroy the resource cache: each ASRU contains a case reference,
554 	 * which may in turn contain a pointer to a referenced owning module.
555 	 */
556 	if (dp->d_asrus != NULL) {
557 		fmd_asru_hash_destroy(dp->d_asrus);
558 		dp->d_asrus = NULL;
559 	}
560 
561 	/*
562 	 * Now that all data structures that refer to modules are torn down,
563 	 * no modules should be remaining on the module list except for d_rmod.
564 	 * If we trip one of these assertions, we're missing a rele somewhere.
565 	 */
566 	ASSERT(fmd_list_prev(&dp->d_mod_list) == dp->d_rmod);
567 	ASSERT(fmd_list_next(&dp->d_mod_list) == dp->d_rmod);
568 
569 	/*
570 	 * Now destroy the root module.  We clear its thread key first so any
571 	 * calls to fmd_trace() inside of the module code will be ignored.
572 	 */
573 	(void) pthread_setspecific(dp->d_key, NULL);
574 	fmd_module_lock(dp->d_rmod);
575 
576 	while ((cp = fmd_list_next(&dp->d_rmod->mod_cases)) != NULL)
577 		fmd_case_discard(cp);
578 
579 	fmd_module_unlock(dp->d_rmod);
580 	fmd_free(dp->d_rmod->mod_stats, sizeof (fmd_modstat_t));
581 	dp->d_rmod->mod_stats = NULL;
582 
583 	(void) pthread_mutex_lock(&dp->d_rmod->mod_lock);
584 	dp->d_rmod->mod_flags |= FMD_MOD_FINI;
585 	(void) pthread_mutex_unlock(&dp->d_rmod->mod_lock);
586 
587 	fmd_module_rele(dp->d_rmod);
588 	ASSERT(fmd_list_next(&dp->d_mod_list) == NULL);
589 
590 	/*
591 	 * Now destroy the remaining global data structures.  If 'core' was
592 	 * set to true, force a core dump so we can check for memory leaks.
593 	 */
594 	if (dp->d_cases != NULL)
595 		fmd_case_hash_destroy(dp->d_cases);
596 	if (dp->d_disp != NULL)
597 		fmd_dispq_destroy(dp->d_disp);
598 	if (dp->d_timers != NULL)
599 		fmd_timerq_destroy(dp->d_timers);
600 	if (dp->d_schemes != NULL)
601 		fmd_scheme_hash_destroy(dp->d_schemes);
602 	if (dp->d_xprt_ids != NULL)
603 		fmd_idspace_destroy(dp->d_xprt_ids);
604 
605 	if (dp->d_errstats != NULL) {
606 		fmd_free(dp->d_errstats,
607 		    sizeof (fmd_stat_t) * (EFMD_END - EFMD_UNKNOWN));
608 	}
609 
610 	if (dp->d_conf != NULL)
611 		fmd_conf_close(dp->d_conf);
612 
613 	if (dp->d_topo != NULL)
614 		topo_close(dp->d_topo);
615 
616 	nvlist_free(dp->d_auth);
617 	(void) nv_alloc_fini(&dp->d_nva);
618 	dp->d_clockops->fto_fini(dp->d_clockptr);
619 
620 	(void) pthread_key_delete(dp->d_key);
621 	bzero(dp, sizeof (fmd_t));
622 
623 	if (core)
624 		fmd_panic("forcing core dump at user request\n");
625 }
626 
627 /*ARGSUSED*/
628 static void
629 fmd_gc(fmd_t *dp, id_t id, hrtime_t hrt)
630 {
631 	hrtime_t delta;
632 
633 	if (id != 0) {
634 		TRACE((FMD_DBG_MOD, "garbage collect start"));
635 		fmd_modhash_apply(dp->d_mod_hash, fmd_module_gc);
636 		TRACE((FMD_DBG_MOD, "garbage collect end"));
637 
638 		(void) pthread_rwlock_rdlock(&dp->d_log_lock);
639 		fmd_log_update(dp->d_errlog);
640 		(void) pthread_rwlock_unlock(&dp->d_log_lock);
641 	}
642 
643 	(void) fmd_conf_getprop(dp->d_conf, "gc_interval", &delta);
644 	(void) fmd_timerq_install(dp->d_timers, dp->d_rmod->mod_timerids,
645 	    (fmd_timer_f *)fmd_gc, dp, NULL, delta);
646 }
647 
648 /*
649  * Events are committed to the errlog after cases are checkpointed.  If fmd
650  * crashes before an event is ever associated with a module, this function will
651  * be called to replay it to all subscribers.  If fmd crashes in between the
652  * subscriber checkpointing and committing the event in the error log, the
653  * module will have seen the event and we don't want to replay it.  So we look
654  * for the event in all modules and transition it to the proper state.  If
655  * it is found, we commit it to the error log and do not replay it.  The in-
656  * memory case search used by fmd_module_contains() et al isn't particularly
657  * efficient, but it is faster than doing read i/o's on every case event to
658  * check their status or write i/o's on every event to replay to update states.
659  * We can improve the efficiency of this lookup algorithm later if necessary.
660  */
661 /*ARGSUSED*/
662 static void
663 fmd_err_replay(fmd_log_t *lp, fmd_event_t *ep, fmd_t *dp)
664 {
665 	fmd_module_t *mp;
666 	fmd_stat_t *sp;
667 
668 	(void) pthread_mutex_lock(&dp->d_mod_lock);
669 
670 	for (mp = fmd_list_next(&dp->d_mod_list);
671 	    mp != NULL; mp = fmd_list_next(mp)) {
672 		if (fmd_module_contains(mp, ep)) {
673 			fmd_module_hold(mp);
674 			break;
675 		}
676 	}
677 
678 	(void) pthread_mutex_unlock(&dp->d_mod_lock);
679 
680 	if (mp != NULL) {
681 		fmd_event_commit(ep);
682 		fmd_module_rele(mp);
683 		sp = &dp->d_stats->ds_log_partials;
684 	} else {
685 		fmd_dispq_dispatch(dp->d_disp, ep, FMD_EVENT_DATA(ep));
686 		sp = &dp->d_stats->ds_log_replayed;
687 	}
688 
689 	(void) pthread_mutex_lock(&dp->d_stats_lock);
690 	sp->fmds_value.ui64++;
691 	(void) pthread_mutex_unlock(&dp->d_stats_lock);
692 }
693 
694 void
695 fmd_door_server(void *dip)
696 {
697 	fmd_dprintf(FMD_DBG_XPRT, "door server starting for %p\n", dip);
698 	(void) pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
699 	(void) door_return(NULL, 0, NULL, 0);
700 }
701 
702 /*
703  * Custom door server create callback.  Any fmd services that use doors will
704  * require those threads to have their fmd-specific TSD initialized, etc.
705  */
706 static void
707 fmd_door(door_info_t *dip)
708 {
709 	if (fmd_thread_create(fmd.d_rmod, fmd_door_server, dip) == NULL)
710 		fmd_panic("failed to create server for door %p", (void *)dip);
711 }
712 
713 /*
714  * This signal handler is installed for the client.thrsig signal to be used to
715  * force an auxiliary thread to wake up from a system call and return EINTR in
716  * response to a module's use of fmd_thr_signal().  We also trace the event.
717  */
718 static void
719 fmd_signal(int sig)
720 {
721 	TRACE((FMD_DBG_MOD, "module thread received sig #%d", sig));
722 }
723 
724 void
725 fmd_run(fmd_t *dp, int pfd)
726 {
727 	char *nodc_key[] = { FMD_FLT_NODC, NULL };
728 	char nodc_str[128];
729 	struct sigaction act;
730 
731 	int status = FMD_EXIT_SUCCESS;
732 	const char *name;
733 	fmd_conf_path_t *pap;
734 	fmd_event_t *e;
735 	int dbout, err;
736 
737 	/*
738 	 * Cache all the current debug property settings in d_fmd_debug,
739 	 * d_fmd_dbout, d_hdl_debug, and d_hdl_dbout.  If a given debug mask
740 	 * is non-zero and the corresponding dbout mask is zero, set dbout
741 	 * to a sensible default value based on whether we have daemonized.
742 	 */
743 	(void) fmd_conf_getprop(dp->d_conf, "dbout", &dbout);
744 
745 	if (dp->d_fmd_debug != 0 && dbout == 0)
746 		dp->d_fmd_dbout = dp->d_fg? FMD_DBOUT_STDERR : FMD_DBOUT_SYSLOG;
747 	else
748 		dp->d_fmd_dbout = dbout;
749 
750 	(void) fmd_conf_getprop(dp->d_conf, "client.debug", &dp->d_hdl_debug);
751 	(void) fmd_conf_getprop(dp->d_conf, "client.dbout", &dbout);
752 
753 	if (dp->d_hdl_debug != 0 && dbout == 0)
754 		dp->d_hdl_dbout = dp->d_fg? FMD_DBOUT_STDERR : FMD_DBOUT_SYSLOG;
755 	else
756 		dp->d_hdl_dbout = dbout;
757 
758 	/*
759 	 * Initialize remaining major program data structures such as the
760 	 * clock, dispatch queues, log files, module hash collections, etc.
761 	 * This work is done here rather than in fmd_create() to permit the -o
762 	 * command-line option to modify properties after fmd_create() is done.
763 	 */
764 	name = dp->d_rootdir != NULL &&
765 	    *dp->d_rootdir != '\0' ? dp->d_rootdir : NULL;
766 
767 	if ((dp->d_topo = topo_open(TOPO_VERSION, name, &err)) == NULL) {
768 		fmd_error(EFMD_EXIT, "failed to initialize "
769 		    "topology library: %s\n", topo_strerror(err));
770 	}
771 
772 	dp->d_clockptr = dp->d_clockops->fto_init();
773 	dp->d_xprt_ids = fmd_idspace_create("xprt_ids", 1, INT_MAX);
774 	fmd_xprt_suspend_all();
775 
776 	(void) door_server_create(fmd_door);
777 	fmd_dr_init();
778 
779 	dp->d_rmod->mod_timerids = fmd_idspace_create(dp->d_pname, 1, 16);
780 	dp->d_timers = fmd_timerq_create();
781 	dp->d_disp = fmd_dispq_create();
782 	dp->d_cases = fmd_case_hash_create();
783 
784 	/*
785 	 * The root module's mod_queue is created with limit zero, making it
786 	 * act like /dev/null; anything inserted here is simply ignored.
787 	 */
788 	dp->d_rmod->mod_queue = fmd_eventq_create(dp->d_rmod,
789 	    &dp->d_rmod->mod_stats->ms_evqstat, &dp->d_rmod->mod_stats_lock, 0);
790 
791 	/*
792 	 * Once our subsystems that use signals have been set up, install the
793 	 * signal handler for the fmd_thr_signal() API.  Verify that the signal
794 	 * being used for this purpose doesn't conflict with something else.
795 	 */
796 	(void) fmd_conf_getprop(dp->d_conf, "client.thrsig", &dp->d_thr_sig);
797 
798 	if (sigaction(dp->d_thr_sig, NULL, &act) != 0) {
799 		fmd_error(EFMD_EXIT, "invalid signal selected for "
800 		    "client.thrsig property: %d\n", dp->d_thr_sig);
801 	}
802 
803 	if (act.sa_handler != SIG_IGN && act.sa_handler != SIG_DFL) {
804 		fmd_error(EFMD_EXIT, "signal selected for client.thrsig "
805 		    "property is already in use: %d\n", dp->d_thr_sig);
806 	}
807 
808 	act.sa_handler = fmd_signal;
809 	act.sa_flags = 0;
810 
811 	(void) sigemptyset(&act.sa_mask);
812 	(void) sigaction(dp->d_thr_sig, &act, NULL);
813 
814 	(void) fmd_conf_getprop(dp->d_conf, "schemedir", &name);
815 	dp->d_schemes = fmd_scheme_hash_create(dp->d_rootdir, name);
816 
817 	(void) fmd_conf_getprop(dp->d_conf, "log.rsrc", &name);
818 	dp->d_asrus = fmd_asru_hash_create(dp->d_rootdir, name);
819 
820 	(void) fmd_conf_getprop(dp->d_conf, "log.error", &name);
821 	dp->d_errlog = fmd_log_open(dp->d_rootdir, name, FMD_LOG_ERROR);
822 
823 	(void) fmd_conf_getprop(dp->d_conf, "log.fault", &name);
824 	dp->d_fltlog = fmd_log_open(dp->d_rootdir, name, FMD_LOG_FAULT);
825 
826 	if (dp->d_asrus == NULL || dp->d_errlog == NULL || dp->d_fltlog == NULL)
827 		fmd_error(EFMD_EXIT, "failed to initialize log files\n");
828 
829 	/*
830 	 * Before loading modules, create an empty control event which will act
831 	 * as a global barrier for module event processing.  Each module we
832 	 * load successfully will insert it at their head of their event queue,
833 	 * and then pause inside of fmd_ctl_rele() after dequeuing the event.
834 	 * This module barrier is required for two reasons:
835 	 *
836 	 * (a) During module loading, the restoration of case checkpoints may
837 	 *    result in a list.* event being recreated for which the intended
838 	 *    subscriber has not yet loaded depending on the load order. Such
839 	 *    events could then result in spurious "no subscriber" errors.
840 	 *
841 	 * (b) During errlog replay, a sequence of errors from a long time ago
842 	 *    may be replayed, and the module may attempt to install relative
843 	 *    timers associated with one or more of these events.  If errlog
844 	 *    replay were "racing" with active module threads, an event E1
845 	 *    that resulted in a relative timer T at time E1 + N nsec could
846 	 *    fire prior to an event E2 being enqueued, even if the relative
847 	 *    time ordering was E1 < E2 < E1 + N, causing mis-diagnosis.
848 	 */
849 	dp->d_mod_event = e = fmd_event_create(FMD_EVT_CTL,
850 	    FMD_HRT_NOW, NULL, fmd_ctl_init(NULL));
851 
852 	fmd_event_hold(e);
853 
854 	/*
855 	 * Once all data structures are initialized, we load all of our modules
856 	 * in order according to class in order to load up any subscriptions.
857 	 * Once built-in modules are loaded, we detach from our waiting parent.
858 	 */
859 	dp->d_mod_hash = fmd_modhash_create();
860 
861 	if (fmd_builtin_loadall(dp->d_mod_hash) != 0 && !dp->d_fg)
862 		fmd_error(EFMD_EXIT, "failed to initialize fault manager\n");
863 
864 	(void) fmd_conf_getprop(dp->d_conf, "self.name", &name);
865 	dp->d_self = fmd_modhash_lookup(dp->d_mod_hash, name);
866 
867 	if (dp->d_self != NULL && fmd_module_dc_key2code(dp->d_self,
868 	    nodc_key, nodc_str, sizeof (nodc_str)) == 0)
869 		(void) fmd_conf_setprop(dp->d_conf, "nodiagcode", nodc_str);
870 
871 	fmd_rpc_init();
872 	dp->d_running = 1; /* we are now officially an active fmd */
873 
874 	/*
875 	 * Now that we're running, if a pipe fd was specified, write an exit
876 	 * status to it to indicate that our parent process can safely detach.
877 	 * Then proceed to loading the remaining non-built-in modules.
878 	 */
879 	if (pfd >= 0)
880 		(void) write(pfd, &status, sizeof (status));
881 
882 	/*
883 	 * Before loading all modules, repopulate the ASRU cache from its
884 	 * persistent repository on disk.  Then during module loading, the
885 	 * restoration of checkpoint files will reparent any active cases.
886 	 */
887 	fmd_asru_hash_refresh(dp->d_asrus);
888 
889 	(void) fmd_conf_getprop(dp->d_conf, "plugin.path", &pap);
890 	fmd_modhash_loadall(dp->d_mod_hash, pap, &fmd_rtld_ops, ".so");
891 
892 	(void) fmd_conf_getprop(dp->d_conf, "agent.path", &pap);
893 	fmd_modhash_loadall(dp->d_mod_hash, pap, &fmd_proc_ops, NULL);
894 
895 	/*
896 	 * With all modules loaded, replay fault events from the ASRU cache for
897 	 * any ASRUs that must be retired, replay error events from the errlog
898 	 * that did not finish processing the last time ran, and then release
899 	 * the global module barrier by executing a final rele on d_mod_event.
900 	 */
901 	fmd_asru_hash_replay(dp->d_asrus);
902 
903 	(void) pthread_rwlock_rdlock(&dp->d_log_lock);
904 	fmd_log_replay(dp->d_errlog, (fmd_log_f *)fmd_err_replay, dp);
905 	fmd_log_update(dp->d_errlog);
906 	(void) pthread_rwlock_unlock(&dp->d_log_lock);
907 
908 	dp->d_mod_event = NULL;
909 	fmd_event_rele(e);
910 
911 	/*
912 	 * Finally, awaken any threads associated with receiving events from
913 	 * open transports and tell them to proceed with fmd_xprt_recv().
914 	 */
915 	fmd_xprt_resume_all();
916 	fmd_gc(dp, 0, 0);
917 
918 	dp->d_booted = 1;
919 }
920 
921 void
922 fmd_help(fmd_t *dp)
923 {
924 	const fmd_conf_mode_t *cmp;
925 
926 	(void) printf("Usage: %s -o debug=mode[,mode]\n", dp->d_pname);
927 
928 	for (cmp = _fmd_debug_modes; cmp->cm_name != NULL; cmp++)
929 		(void) printf("\t%s\t%s\n", cmp->cm_name, cmp->cm_desc);
930 }
931