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