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_API_H
27 #define _FMD_API_H
28
29 #include <sys/types.h>
30 #include <libnvpair.h>
31 #include <stdarg.h>
32 #include <door.h>
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 /*
39 * Fault Management Daemon Client Interfaces
40 *
41 * Note: The contents of this file are private to the implementation of the
42 * Solaris system and FMD subsystem and are subject to change at any time
43 * without notice. Applications and drivers using these interfaces will fail
44 * to run on future releases. These interfaces should not be used for any
45 * purpose until they are publicly documented for use outside of Sun.
46 */
47
48 #define FMD_API_VERSION_1 1
49 #define FMD_API_VERSION_2 2
50 #define FMD_API_VERSION_3 3
51 #define FMD_API_VERSION_4 4
52 #define FMD_API_VERSION_5 5
53
54 #define FMD_API_VERSION FMD_API_VERSION_5
55
56 typedef struct fmd_hdl fmd_hdl_t;
57 typedef struct fmd_event fmd_event_t;
58 typedef struct fmd_case fmd_case_t;
59 typedef struct fmd_xprt fmd_xprt_t;
60
61 struct topo_hdl;
62
63 #define FMD_B_FALSE 0 /* false value for booleans as int */
64 #define FMD_B_TRUE 1 /* true value for booleans as int */
65
66 #ifndef MIN
67 #define MIN(x, y) ((x) < (y) ? (x) : (y))
68 #endif
69
70 #ifndef MAX
71 #define MAX(x, y) ((x) > (y) ? (x) : (y))
72 #endif
73
74 #define FMD_TYPE_BOOL 0 /* int */
75 #define FMD_TYPE_INT32 1 /* int32_t */
76 #define FMD_TYPE_UINT32 2 /* uint32_t */
77 #define FMD_TYPE_INT64 3 /* int64_t */
78 #define FMD_TYPE_UINT64 4 /* uint64_t */
79 #define FMD_TYPE_STRING 5 /* const char* */
80 #define FMD_TYPE_TIME 6 /* uint64_t */
81 #define FMD_TYPE_SIZE 7 /* uint64_t */
82
83 typedef struct fmd_prop {
84 const char *fmdp_name; /* property name */
85 uint_t fmdp_type; /* property type (see above) */
86 const char *fmdp_defv; /* default value */
87 } fmd_prop_t;
88
89 typedef struct fmd_stat {
90 char fmds_name[32]; /* statistic name */
91 uint_t fmds_type; /* statistic type (see above) */
92 char fmds_desc[64]; /* statistic description */
93 union {
94 int bool; /* FMD_TYPE_BOOL */
95 int32_t i32; /* FMD_TYPE_INT32 */
96 uint32_t ui32; /* FMD_TYPE_UINT32 */
97 int64_t i64; /* FMD_TYPE_INT64 */
98 uint64_t ui64; /* FMD_TYPE_UINT64, TIME, SIZE */
99 char *str; /* FMD_TYPE_STRING */
100 } fmds_value;
101 } fmd_stat_t;
102
103 typedef struct fmd_hdl_ops {
104 void (*fmdo_recv)(fmd_hdl_t *, fmd_event_t *, nvlist_t *, const char *);
105 void (*fmdo_timeout)(fmd_hdl_t *, id_t, void *);
106 void (*fmdo_close)(fmd_hdl_t *, fmd_case_t *);
107 void (*fmdo_stats)(fmd_hdl_t *);
108 void (*fmdo_gc)(fmd_hdl_t *);
109 int (*fmdo_send)(fmd_hdl_t *, fmd_xprt_t *, fmd_event_t *, nvlist_t *);
110 void (*fmdo_topo)(fmd_hdl_t *, struct topo_hdl *);
111 } fmd_hdl_ops_t;
112
113 #define FMD_SEND_SUCCESS 0 /* fmdo_send queued event */
114 #define FMD_SEND_FAILED 1 /* fmdo_send unrecoverable error */
115 #define FMD_SEND_RETRY 2 /* fmdo_send requests retry */
116
117 typedef struct fmd_hdl_info {
118 const char *fmdi_desc; /* fmd client description string */
119 const char *fmdi_vers; /* fmd client version string */
120 const fmd_hdl_ops_t *fmdi_ops; /* ops vector for client */
121 const fmd_prop_t *fmdi_props; /* array of configuration props */
122 } fmd_hdl_info_t;
123
124 extern void _fmd_init(fmd_hdl_t *);
125 extern void _fmd_fini(fmd_hdl_t *);
126
127 extern int fmd_hdl_register(fmd_hdl_t *, int, const fmd_hdl_info_t *);
128 extern void fmd_hdl_unregister(fmd_hdl_t *);
129
130 extern void fmd_hdl_subscribe(fmd_hdl_t *, const char *);
131 extern void fmd_hdl_unsubscribe(fmd_hdl_t *, const char *);
132
133 extern void fmd_hdl_setspecific(fmd_hdl_t *, void *);
134 extern void *fmd_hdl_getspecific(fmd_hdl_t *);
135
136 extern void fmd_hdl_opendict(fmd_hdl_t *, const char *);
137 extern struct topo_hdl *fmd_hdl_topo_hold(fmd_hdl_t *, int);
138 extern void fmd_hdl_topo_rele(fmd_hdl_t *, struct topo_hdl *);
139
140 #define FMD_NOSLEEP 0x0 /* do not sleep or retry on failure */
141 #define FMD_SLEEP 0x1 /* sleep or retry if alloc fails */
142
143 extern void *fmd_hdl_alloc(fmd_hdl_t *, size_t, int);
144 extern void *fmd_hdl_zalloc(fmd_hdl_t *, size_t, int);
145 extern void fmd_hdl_free(fmd_hdl_t *, void *, size_t);
146
147 extern char *fmd_hdl_strdup(fmd_hdl_t *, const char *, int);
148 extern void fmd_hdl_strfree(fmd_hdl_t *, char *);
149
150 extern void fmd_hdl_vabort(fmd_hdl_t *, const char *, va_list) __NORETURN;
151 extern void fmd_hdl_abort(fmd_hdl_t *, const char *, ...) __NORETURN;
152
153 extern void fmd_hdl_verror(fmd_hdl_t *, const char *, va_list);
154 extern void fmd_hdl_error(fmd_hdl_t *, const char *, ...);
155
156 extern void fmd_hdl_vdebug(fmd_hdl_t *, const char *, va_list);
157 extern void fmd_hdl_debug(fmd_hdl_t *, const char *, ...);
158
159 extern int32_t fmd_prop_get_int32(fmd_hdl_t *, const char *);
160 extern int64_t fmd_prop_get_int64(fmd_hdl_t *, const char *);
161 extern char *fmd_prop_get_string(fmd_hdl_t *, const char *);
162 extern void fmd_prop_free_string(fmd_hdl_t *, char *);
163
164 #define FMD_STAT_NOALLOC 0x0 /* fmd should use caller's memory */
165 #define FMD_STAT_ALLOC 0x1 /* fmd should allocate stats memory */
166
167 extern fmd_stat_t *fmd_stat_create(fmd_hdl_t *, uint_t, uint_t, fmd_stat_t *);
168 extern void fmd_stat_destroy(fmd_hdl_t *, uint_t, fmd_stat_t *);
169 extern void fmd_stat_setstr(fmd_hdl_t *, fmd_stat_t *, const char *);
170
171 extern fmd_case_t *fmd_case_open(fmd_hdl_t *, void *);
172 extern fmd_case_t *fmd_case_open_uuid(fmd_hdl_t *, const char *, void *);
173 extern void fmd_case_reset(fmd_hdl_t *, fmd_case_t *);
174 extern void fmd_case_solve(fmd_hdl_t *, fmd_case_t *);
175 extern void fmd_case_close(fmd_hdl_t *, fmd_case_t *);
176
177 extern const char *fmd_case_uuid(fmd_hdl_t *, fmd_case_t *);
178 extern fmd_case_t *fmd_case_uulookup(fmd_hdl_t *, const char *);
179 extern void fmd_case_uuclose(fmd_hdl_t *, const char *);
180 extern int fmd_case_uuclosed(fmd_hdl_t *, const char *);
181 extern int fmd_case_uuisresolved(fmd_hdl_t *, const char *);
182 extern void fmd_case_uuresolved(fmd_hdl_t *, const char *);
183
184 extern int fmd_case_solved(fmd_hdl_t *, fmd_case_t *);
185 extern int fmd_case_closed(fmd_hdl_t *, fmd_case_t *);
186
187 extern void fmd_case_add_ereport(fmd_hdl_t *, fmd_case_t *, fmd_event_t *);
188 extern void fmd_case_add_serd(fmd_hdl_t *, fmd_case_t *, const char *);
189 extern void fmd_case_add_suspect(fmd_hdl_t *, fmd_case_t *, nvlist_t *);
190
191 extern void fmd_case_setspecific(fmd_hdl_t *, fmd_case_t *, void *);
192 extern void *fmd_case_getspecific(fmd_hdl_t *, fmd_case_t *);
193
194 extern void fmd_case_setprincipal(fmd_hdl_t *, fmd_case_t *, fmd_event_t *);
195 extern fmd_event_t *fmd_case_getprincipal(fmd_hdl_t *, fmd_case_t *);
196
197 extern fmd_case_t *fmd_case_next(fmd_hdl_t *, fmd_case_t *);
198 extern fmd_case_t *fmd_case_prev(fmd_hdl_t *, fmd_case_t *);
199
200 extern void fmd_buf_create(fmd_hdl_t *, fmd_case_t *, const char *, size_t);
201 extern void fmd_buf_destroy(fmd_hdl_t *, fmd_case_t *, const char *);
202 extern void fmd_buf_read(fmd_hdl_t *, fmd_case_t *,
203 const char *, void *, size_t);
204 extern void fmd_buf_write(fmd_hdl_t *, fmd_case_t *,
205 const char *, const void *, size_t);
206 extern size_t fmd_buf_size(fmd_hdl_t *, fmd_case_t *, const char *);
207
208 extern void fmd_serd_create(fmd_hdl_t *, const char *, uint_t, hrtime_t);
209 extern void fmd_serd_destroy(fmd_hdl_t *, const char *);
210 extern int fmd_serd_exists(fmd_hdl_t *, const char *);
211 extern void fmd_serd_reset(fmd_hdl_t *, const char *);
212 extern int fmd_serd_record(fmd_hdl_t *, const char *, fmd_event_t *);
213 extern int fmd_serd_fired(fmd_hdl_t *, const char *);
214 extern int fmd_serd_empty(fmd_hdl_t *, const char *);
215
216 extern pthread_t fmd_thr_create(fmd_hdl_t *, void (*)(void *), void *);
217 extern void fmd_thr_destroy(fmd_hdl_t *, pthread_t);
218 extern void fmd_thr_signal(fmd_hdl_t *, pthread_t);
219 extern void fmd_thr_checkpoint(fmd_hdl_t *);
220
221 extern door_xcreate_server_func_t fmd_doorthr_create;
222 extern door_xcreate_thrsetup_func_t fmd_doorthr_setup;
223
224 extern id_t fmd_timer_install(fmd_hdl_t *, void *, fmd_event_t *, hrtime_t);
225 extern void fmd_timer_remove(fmd_hdl_t *, id_t);
226
227 extern nvlist_t *fmd_nvl_create_defect(fmd_hdl_t *,
228 const char *, uint8_t, nvlist_t *, nvlist_t *, nvlist_t *);
229 extern nvlist_t *fmd_nvl_create_fault(fmd_hdl_t *,
230 const char *, uint8_t, nvlist_t *, nvlist_t *, nvlist_t *);
231
232 extern const nvlist_t *fmd_hdl_fmauth(fmd_hdl_t *);
233 extern const nvlist_t *fmd_hdl_modauth(fmd_hdl_t *);
234
235 extern int fmd_nvl_class_match(fmd_hdl_t *, nvlist_t *, const char *);
236 extern int fmd_nvl_fmri_expand(fmd_hdl_t *, nvlist_t *);
237 extern int fmd_nvl_fmri_present(fmd_hdl_t *, nvlist_t *);
238 extern int fmd_nvl_fmri_unusable(fmd_hdl_t *, nvlist_t *);
239 extern int fmd_nvl_fmri_retire(fmd_hdl_t *, nvlist_t *);
240 extern int fmd_nvl_fmri_unretire(fmd_hdl_t *, nvlist_t *);
241 extern int fmd_nvl_fmri_replaced(fmd_hdl_t *, nvlist_t *);
242 extern int fmd_nvl_fmri_service_state(fmd_hdl_t *, nvlist_t *);
243 extern int fmd_nvl_fmri_has_fault(fmd_hdl_t *, nvlist_t *, int, char *);
244
245 #define FMD_HAS_FAULT_FRU 0
246 #define FMD_HAS_FAULT_ASRU 1
247 #define FMD_HAS_FAULT_RESOURCE 2
248
249 extern void fmd_repair_fru(fmd_hdl_t *, const char *);
250 extern int fmd_repair_asru(fmd_hdl_t *, const char *);
251
252 extern int fmd_nvl_fmri_contains(fmd_hdl_t *, nvlist_t *, nvlist_t *);
253 extern nvlist_t *fmd_nvl_fmri_translate(fmd_hdl_t *, nvlist_t *, nvlist_t *);
254
255 extern nvlist_t *fmd_nvl_alloc(fmd_hdl_t *, int);
256 extern nvlist_t *fmd_nvl_dup(fmd_hdl_t *, nvlist_t *, int);
257
258 extern int fmd_event_local(fmd_hdl_t *, fmd_event_t *);
259 extern uint64_t fmd_event_ena_create(fmd_hdl_t *);
260
261
262 #define FMD_XPRT_RDONLY 0x1 /* transport is read-only */
263 #define FMD_XPRT_RDWR 0x3 /* transport is read-write */
264 #define FMD_XPRT_ACCEPT 0x4 /* transport is accepting connection */
265 #define FMD_XPRT_SUSPENDED 0x8 /* transport starts suspended */
266 #define FMD_XPRT_EXTERNAL 0x80 /* xprt is external to a chassis */
267 #define FMD_XPRT_NO_REMOTE_REPAIR 0x100 /* xprt does not allow remote repair */
268 #define FMD_XPRT_CACHE_AS_LOCAL 0x200 /* xprt caches fault as if local */
269 #define FMD_XPRT_HCONLY 0x400 /* xprt only proxies hc-scheme faults */
270 #define FMD_XPRT_HC_PRESENT_ONLY 0x800 /* only locally present hc faults */
271
272 extern fmd_xprt_t *fmd_xprt_open(fmd_hdl_t *, uint_t, nvlist_t *, void *);
273 extern void fmd_xprt_close(fmd_hdl_t *, fmd_xprt_t *);
274 extern void fmd_xprt_post(fmd_hdl_t *, fmd_xprt_t *, nvlist_t *, hrtime_t);
275 extern void fmd_xprt_log(fmd_hdl_t *, fmd_xprt_t *, nvlist_t *, hrtime_t);
276 extern void fmd_xprt_suspend(fmd_hdl_t *, fmd_xprt_t *);
277 extern void fmd_xprt_resume(fmd_hdl_t *, fmd_xprt_t *);
278 extern int fmd_xprt_error(fmd_hdl_t *, fmd_xprt_t *);
279 extern nvlist_t *fmd_xprt_translate(fmd_hdl_t *, fmd_xprt_t *, fmd_event_t *);
280 extern void fmd_xprt_add_domain(fmd_hdl_t *, nvlist_t *, char *);
281 extern void fmd_xprt_setspecific(fmd_hdl_t *, fmd_xprt_t *, void *);
282 extern void *fmd_xprt_getspecific(fmd_hdl_t *, fmd_xprt_t *);
283
284 #ifdef __cplusplus
285 }
286 #endif
287
288 #endif /* _FMD_API_H */