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, Version 1.0 only 6 * (the "License"). You may not use this file except in compliance 7 * with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or http://www.opensolaris.org/os/licensing. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 /* 23 * Copyright 2005 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 53 typedef struct fmd_statistics { 54 fmd_stat_t ds_received; /* number of events received by xprt */ 55 fmd_stat_t ds_discarded; /* number of events discarded by xprt */ 56 fmd_stat_t ds_retried; /* number of events retried by xprt */ 57 fmd_stat_t ds_replayed; /* number of events replayed by xprt */ 58 fmd_stat_t ds_lost; /* number of events lost by xprt */ 59 fmd_stat_t ds_log_replayed; /* number of events replayed from log */ 60 fmd_stat_t ds_log_partials; /* number of events partially commit */ 61 fmd_stat_t ds_err_enospc; /* number of events w/ ENOSPC errlog */ 62 fmd_stat_t ds_flt_enospc; /* number of events w/ ENOSPC fltlog */ 63 fmd_stat_t ds_oth_enospc; /* number of events w/ ENOSPC others */ 64 fmd_stat_t ds_dr_gen; /* dynamic reconfiguration generation */ 65 } fmd_statistics_t; 66 67 typedef struct fmd { 68 const char *d_version; /* version string for fmd (see fmd.c) */ 69 const char *d_pname; /* basename to use for messages */ 70 pid_t d_pid; /* process-ID of current daemon */ 71 pthread_key_t d_key; /* key for fmd's thread-specific data */ 72 volatile int d_signal; /* signal indicating we should quit */ 73 volatile int d_running; /* flag set when fmd_run() succeeds */ 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 state lock */ 85 pthread_cond_t d_xprt_cv; /* transport state cv */ 86 uint_t d_xprt_wait; /* transport wait flag */ 87 void *d_xprt_chan; /* transport handle */ 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 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_dr_hdl; /* DR event handle (see fmd_dr.c) */ 111 nv_alloc_t d_nva; /* libnvpair allocator handle */ 112 nvlist_t *d_auth; /* FMRI authority nvlist */ 113 114 struct fmd_conf *d_conf; /* global configuration properties */ 115 uint_t d_fg; /* cached value of "fg" property */ 116 117 fmd_statistics_t *d_stats; /* root module statistics collection */ 118 pthread_mutex_t d_stats_lock; /* root module statistics lock */ 119 120 struct fmd_module *d_rmod; /* root module for fmd's main thread */ 121 struct fmd_module *d_self; /* self module for fmd's diagnosis */ 122 123 pthread_mutex_t d_err_lock; /* lock for stderr and error stats */ 124 fmd_stat_t *d_errstats; /* program-wide error statistics */ 125 126 struct fmd_timerq *d_timers; /* timer queue for module timers */ 127 struct fmd_dispq *d_disp; /* dispatch queue for incoming events */ 128 struct fmd_scheme_hash *d_schemes; /* hash of fmri scheme modules */ 129 struct fmd_asru_hash *d_asrus; /* hash of cached asru objects */ 130 struct fmd_case_hash *d_cases; /* hash of active cases */ 131 132 pthread_rwlock_t d_log_lock; /* log pointer lock (r=use, w=rotate) */ 133 struct fmd_log *d_errlog; /* log file for error events */ 134 struct fmd_log *d_fltlog; /* log file for fault events */ 135 } fmd_t; 136 137 /* 138 * Exit status values used for the few places within fmd where we exit(2) or 139 * return from main(). fmd only exits if a fatal error occurs during startup; 140 * if anything else happens errors are reported and we just keep trucking. 141 */ 142 #define FMD_EXIT_SUCCESS 0 /* successful execution of daemon */ 143 #define FMD_EXIT_ERROR 1 /* failed to initialize daemon */ 144 #define FMD_EXIT_USAGE 2 /* syntax error on command-line */ 145 146 /* 147 * Values associated with fmd's client.error property, stored as a uint32_t. 148 * By default, we unload bad clients; other values are for use by developers. 149 */ 150 #define FMD_CERROR_UNLOAD 0 /* unload module on error (default) */ 151 #define FMD_CERROR_STOP 1 /* stop fmd for debugger attach */ 152 #define FMD_CERROR_ABORT 2 /* abort fmd and generate core dump */ 153 154 /* 155 * Values associated with any *dbout (debug output sink) property, stored as 156 * a uint32_t. Currently we permit syslog output and stderr output. 157 */ 158 #define FMD_DBOUT_SYSLOG 0x1 /* output to syslog(LOG_DEBUG) */ 159 #define FMD_DBOUT_STDERR 0x2 /* output to stderr */ 160 161 extern const char _fmd_version[]; 162 extern fmd_t fmd; 163 164 extern void fmd_create(fmd_t *, const char *, const char *, const char *); 165 extern void fmd_destroy(fmd_t *); 166 extern void fmd_run(fmd_t *, int); 167 extern void fmd_help(fmd_t *); 168 169 #ifdef __cplusplus 170 } 171 #endif 172 173 #endif /* _FMD_H */ 174