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