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 (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved. 24 */ 25 26 #ifndef _FMD_H 27 #define _FMD_H 28 29 #include <libnvpair.h> 30 #include <pthread.h> 31 32 #ifdef __cplusplus 33 extern "C" { 34 #endif 35 36 #include <fmd_list.h> 37 #include <fmd_time.h> 38 #include <fmd_api.h> 39 #include <fmd_trace.h> 40 41 struct fmd_conf; /* see <fmd_conf.h> */ 42 struct fmd_dispq; /* see <fmd_dispq.h> */ 43 struct fmd_timerq; /* see <fmd_timerq.h> */ 44 struct fmd_asru_hash; /* see <fmd_asru.h> */ 45 struct fmd_scheme_hash; /* see <fmd_fmri.h> */ 46 struct fmd_case_hash; /* see <fmd_case.h> */ 47 struct fmd_modhash; /* see <fmd_module.h> */ 48 struct fmd_module; /* see <fmd_module.h> */ 49 struct fmd_log; /* see <fmd_log.h> */ 50 struct fmd_idspace; /* see <fmd_idspace.h> */ 51 struct topo_hdl; /* see <fm/libtopo.h> */ 52 53 typedef struct fmd_statistics { 54 fmd_stat_t ds_log_replayed; /* number of events replayed from log */ 55 fmd_stat_t ds_log_partials; /* number of events partially commit */ 56 fmd_stat_t ds_err_enospc; /* number of events w/ ENOSPC errlog */ 57 fmd_stat_t ds_flt_enospc; /* number of events w/ ENOSPC fltlog */ 58 fmd_stat_t ds_oth_enospc; /* number of events w/ ENOSPC others */ 59 fmd_stat_t ds_dr_gen; /* dynamic reconfiguration generation */ 60 fmd_stat_t ds_topo_gen; /* topology snapshot generation */ 61 fmd_stat_t ds_topo_drgen; /* topology DR generation */ 62 } fmd_statistics_t; 63 64 typedef struct fmd { 65 const char *d_version; /* version string for fmd (see fmd.c) */ 66 const char *d_pname; /* basename to use for messages */ 67 pid_t d_pid; /* process-ID of current daemon */ 68 pthread_key_t d_key; /* key for fmd's thread-specific data */ 69 volatile int d_signal; /* signal indicating we should quit */ 70 volatile int d_running; /* flag set when fmd_run() succeeds */ 71 volatile int d_loaded; /* flag set when all modules loaded */ 72 volatile int d_booted; /* flag set when fmd_run() completes */ 73 74 uint_t d_fmd_debug; /* mask of fmd active debugging modes */ 75 uint_t d_fmd_dbout; /* fmd debug output sinks (see below) */ 76 uint_t d_hdl_debug; /* bool indicating if hdl debug is on */ 77 uint_t d_hdl_dbout; /* hdl debug output sinks (see below) */ 78 79 char *volatile d_panicstr; /* pointer to formatted panic message */ 80 pthread_t d_panictid; /* tid of thread forcing a panic */ 81 uint_t d_panicrefs; /* number of attempts to panic */ 82 83 pthread_mutex_t d_xprt_lock; /* transport suspend lock */ 84 uint_t d_xprt_suspend; /* transport suspend count */ 85 uint_t d_xprt_ttl; /* transport default time-to-live */ 86 struct fmd_idspace *d_xprt_ids; /* transport id hash */ 87 88 const fmd_timeops_t *d_clockops; /* system clock ops vector */ 89 void *d_clockptr; /* system clock private data */ 90 91 pthread_mutex_t d_thr_lock; /* lock for d_thr_list */ 92 fmd_list_t d_thr_list; /* list of all fmd_thread_t's */ 93 fmd_tracebuf_f *d_thr_trace; /* thread trace buffer function */ 94 int d_thr_sig; /* cached copy of client.thrsig */ 95 96 pthread_mutex_t d_mod_lock; /* lock for d_mod_list */ 97 fmd_list_t d_mod_list; /* list of modules in load order */ 98 struct fmd_modhash *d_mod_hash; /* hash of modules by base name */ 99 fmd_event_t *d_mod_event; /* boot event for module quiesce */ 100 101 uint_t d_alloc_msecs; /* initial delay time for alloc retry */ 102 uint_t d_alloc_tries; /* max # times to retry an allocation */ 103 uint_t d_str_buckets; /* def # of buckets for string hashes */ 104 105 const char *d_rootdir; /* root directory path */ 106 const char *d_platform; /* platform name (uname -i) */ 107 const char *d_machine; /* machine class name (uname -m) */ 108 const char *d_isaname; /* processor ISA name (uname -p) */ 109 110 void *d_sysev_hdl; /* legacy sysevent handle */ 111 nv_alloc_t d_nva; /* libnvpair allocator handle */ 112 nvlist_t *d_auth; /* FMRI authority nvlist */ 113 pthread_mutex_t d_topo_lock; /* lock for topo hdl */ 114 fmd_list_t d_topo_list; /* list of all topology snapshots */ 115 116 struct fmd_conf *d_conf; /* global configuration properties */ 117 uint_t d_fg; /* cached value of "fg" property */ 118 119 fmd_statistics_t *d_stats; /* root module statistics collection */ 120 pthread_mutex_t d_stats_lock; /* root module statistics lock */ 121 122 struct fmd_module *d_rmod; /* root module for fmd's main thread */ 123 struct fmd_module *d_self; /* self module for fmd's diagnosis */ 124 125 pthread_mutex_t d_err_lock; /* lock for stderr and error stats */ 126 fmd_stat_t *d_errstats; /* program-wide error statistics */ 127 128 struct fmd_timerq *d_timers; /* timer queue for module timers */ 129 struct fmd_dispq *d_disp; /* dispatch queue for incoming events */ 130 struct fmd_scheme_hash *d_schemes; /* hash of fmri scheme modules */ 131 struct fmd_asru_hash *d_asrus; /* hash of cached asru objects */ 132 struct fmd_case_hash *d_cases; /* hash of active cases */ 133 134 pthread_rwlock_t d_log_lock; /* log pointer lock (r=use, w=rotate) */ 135 struct fmd_log *d_errlog; /* log file for error events */ 136 struct fmd_log *d_fltlog; /* log file for fault events */ 137 138 pthread_rwlock_t d_hvilog_lock; /* log pointer lock (r=use, w=rotate) */ 139 struct fmd_log *d_hvilog; /* log file for hi value info events */ 140 141 pthread_rwlock_t d_ilog_lock; /* log pointer lock (r=use, w=rotate) */ 142 struct fmd_log *d_ilog; /* log file for info events */ 143 144 pthread_cond_t d_fmd_cv; /* sync startup with rpc */ 145 pthread_mutex_t d_fmd_lock; /* sync startup with rpc */ 146 } fmd_t; 147 148 /* 149 * Exit status values used for the few places within fmd where we exit(2) or 150 * return from main(). fmd only exits if a fatal error occurs during startup; 151 * if anything else happens errors are reported and we just keep trucking. 152 */ 153 #define FMD_EXIT_SUCCESS 0 /* successful execution of daemon */ 154 #define FMD_EXIT_ERROR 1 /* failed to initialize daemon */ 155 #define FMD_EXIT_USAGE 2 /* syntax error on command-line */ 156 157 /* 158 * Values associated with fmd's client.error property, stored as a uint32_t. 159 * By default, we unload bad clients; other values are for use by developers. 160 */ 161 #define FMD_CERROR_UNLOAD 0 /* unload module on error (default) */ 162 #define FMD_CERROR_STOP 1 /* stop fmd for debugger attach */ 163 #define FMD_CERROR_ABORT 2 /* abort fmd and generate core dump */ 164 165 /* 166 * Values associated with any *dbout (debug output sink) property, stored as 167 * a uint32_t. Currently we permit syslog output and stderr output. 168 */ 169 #define FMD_DBOUT_SYSLOG 0x1 /* output to syslog(LOG_DEBUG) */ 170 #define FMD_DBOUT_STDERR 0x2 /* output to stderr */ 171 172 extern const char _fmd_version[]; 173 extern fmd_t fmd; 174 175 extern void fmd_door_server(void *); 176 extern void fmd_create(fmd_t *, const char *, const char *, const char *); 177 extern void fmd_destroy(fmd_t *); 178 extern void fmd_run(fmd_t *, int); 179 extern void fmd_help(fmd_t *); 180 181 #ifdef __cplusplus 182 } 183 #endif 184 185 #endif /* _FMD_H */ 186