xref: /illumos-gate/usr/src/cmd/fm/fmd/common/fmd_api.h (revision 7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fe)
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 /*
24  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
25  * Use is subject to license terms.
26  */
27 
28 #ifndef	_FMD_API_H
29 #define	_FMD_API_H
30 
31 #pragma ident	"%Z%%M%	%I%	%E% SMI"
32 
33 #include <sys/types.h>
34 #include <libnvpair.h>
35 #include <stdarg.h>
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 /*
42  * Fault Management Daemon Client Interfaces
43  *
44  * Note: The contents of this file are private to the implementation of the
45  * Solaris system and FMD subsystem and are subject to change at any time
46  * without notice.  Applications and drivers using these interfaces will fail
47  * to run on future releases.  These interfaces should not be used for any
48  * purpose until they are publicly documented for use outside of Sun.
49  */
50 
51 #define	FMD_API_VERSION_1	1
52 #define	FMD_API_VERSION_2	2
53 #define	FMD_API_VERSION_3	3
54 
55 #define	FMD_API_VERSION		FMD_API_VERSION_3
56 
57 typedef struct fmd_hdl fmd_hdl_t;
58 typedef struct fmd_event fmd_event_t;
59 typedef struct fmd_case fmd_case_t;
60 typedef struct fmd_xprt fmd_xprt_t;
61 
62 struct topo_hdl;
63 
64 #define	FMD_B_FALSE	0		/* false value for booleans as int */
65 #define	FMD_B_TRUE	1		/* true value for booleans as int */
66 
67 #ifndef	MIN
68 #define	MIN(x, y) ((x) < (y) ? (x) : (y))
69 #endif
70 
71 #ifndef	MAX
72 #define	MAX(x, y) ((x) > (y) ? (x) : (y))
73 #endif
74 
75 #define	FMD_TYPE_BOOL	0		/* int */
76 #define	FMD_TYPE_INT32	1		/* int32_t */
77 #define	FMD_TYPE_UINT32	2		/* uint32_t */
78 #define	FMD_TYPE_INT64	3		/* int64_t */
79 #define	FMD_TYPE_UINT64	4		/* uint64_t */
80 #define	FMD_TYPE_STRING	5		/* const char* */
81 #define	FMD_TYPE_TIME	6		/* uint64_t */
82 #define	FMD_TYPE_SIZE	7		/* uint64_t */
83 
84 typedef struct fmd_prop {
85 	const char *fmdp_name;		/* property name */
86 	uint_t fmdp_type;		/* property type (see above) */
87 	const char *fmdp_defv;		/* default value */
88 } fmd_prop_t;
89 
90 typedef struct fmd_stat {
91 	char fmds_name[32];		/* statistic name */
92 	uint_t fmds_type;		/* statistic type (see above) */
93 	char fmds_desc[64];		/* statistic description */
94 	union {
95 		int bool;		/* FMD_TYPE_BOOL */
96 		int32_t i32;		/* FMD_TYPE_INT32 */
97 		uint32_t ui32;		/* FMD_TYPE_UINT32 */
98 		int64_t i64;		/* FMD_TYPE_INT64 */
99 		uint64_t ui64;		/* FMD_TYPE_UINT64, TIME, SIZE */
100 		char *str;		/* FMD_TYPE_STRING */
101 	} fmds_value;
102 } fmd_stat_t;
103 
104 typedef struct fmd_hdl_ops {
105 	void (*fmdo_recv)(fmd_hdl_t *, fmd_event_t *, nvlist_t *, const char *);
106 	void (*fmdo_timeout)(fmd_hdl_t *, id_t, void *);
107 	void (*fmdo_close)(fmd_hdl_t *, fmd_case_t *);
108 	void (*fmdo_stats)(fmd_hdl_t *);
109 	void (*fmdo_gc)(fmd_hdl_t *);
110 	int (*fmdo_send)(fmd_hdl_t *, fmd_xprt_t *, fmd_event_t *, nvlist_t *);
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_topology(fmd_hdl_t *, int);
138 
139 #define	FMD_NOSLEEP		0x0	/* do not sleep or retry on failure */
140 #define	FMD_SLEEP		0x1	/* sleep or retry if alloc fails */
141 
142 extern void *fmd_hdl_alloc(fmd_hdl_t *, size_t, int);
143 extern void *fmd_hdl_zalloc(fmd_hdl_t *, size_t, int);
144 extern void fmd_hdl_free(fmd_hdl_t *, void *, size_t);
145 
146 extern char *fmd_hdl_strdup(fmd_hdl_t *, const char *, int);
147 extern void fmd_hdl_strfree(fmd_hdl_t *, char *);
148 
149 extern void fmd_hdl_vabort(fmd_hdl_t *, const char *, va_list);
150 extern void fmd_hdl_abort(fmd_hdl_t *, const char *, ...);
151 
152 extern void fmd_hdl_verror(fmd_hdl_t *, const char *, va_list);
153 extern void fmd_hdl_error(fmd_hdl_t *, const char *, ...);
154 
155 extern void fmd_hdl_vdebug(fmd_hdl_t *, const char *, va_list);
156 extern void fmd_hdl_debug(fmd_hdl_t *, const char *, ...);
157 
158 extern int32_t fmd_prop_get_int32(fmd_hdl_t *, const char *);
159 extern int64_t fmd_prop_get_int64(fmd_hdl_t *, const char *);
160 extern char *fmd_prop_get_string(fmd_hdl_t *, const char *);
161 extern void fmd_prop_free_string(fmd_hdl_t *, char *);
162 
163 #define	FMD_STAT_NOALLOC	0x0	/* fmd should use caller's memory */
164 #define	FMD_STAT_ALLOC		0x1	/* fmd should allocate stats memory */
165 
166 extern fmd_stat_t *fmd_stat_create(fmd_hdl_t *, uint_t, uint_t, fmd_stat_t *);
167 extern void fmd_stat_destroy(fmd_hdl_t *, uint_t, fmd_stat_t *);
168 extern void fmd_stat_setstr(fmd_hdl_t *, fmd_stat_t *, const char *);
169 
170 extern fmd_case_t *fmd_case_open(fmd_hdl_t *, void *);
171 extern void fmd_case_reset(fmd_hdl_t *, fmd_case_t *);
172 extern void fmd_case_solve(fmd_hdl_t *, fmd_case_t *);
173 extern void fmd_case_close(fmd_hdl_t *, fmd_case_t *);
174 
175 extern const char *fmd_case_uuid(fmd_hdl_t *, fmd_case_t *);
176 extern fmd_case_t *fmd_case_uulookup(fmd_hdl_t *, const char *);
177 extern void fmd_case_uuclose(fmd_hdl_t *, const char *);
178 extern int fmd_case_uuclosed(fmd_hdl_t *, const char *);
179 
180 extern int fmd_case_solved(fmd_hdl_t *, fmd_case_t *);
181 extern int fmd_case_closed(fmd_hdl_t *, fmd_case_t *);
182 
183 extern void fmd_case_add_ereport(fmd_hdl_t *, fmd_case_t *, fmd_event_t *);
184 extern void fmd_case_add_serd(fmd_hdl_t *, fmd_case_t *, const char *);
185 extern void fmd_case_add_suspect(fmd_hdl_t *, fmd_case_t *, nvlist_t *);
186 
187 extern void fmd_case_setspecific(fmd_hdl_t *, fmd_case_t *, void *);
188 extern void *fmd_case_getspecific(fmd_hdl_t *, fmd_case_t *);
189 
190 extern void fmd_case_setprincipal(fmd_hdl_t *, fmd_case_t *, fmd_event_t *);
191 extern fmd_event_t *fmd_case_getprincipal(fmd_hdl_t *, fmd_case_t *);
192 
193 extern fmd_case_t *fmd_case_next(fmd_hdl_t *, fmd_case_t *);
194 extern fmd_case_t *fmd_case_prev(fmd_hdl_t *, fmd_case_t *);
195 
196 extern void fmd_buf_create(fmd_hdl_t *, fmd_case_t *, const char *, size_t);
197 extern void fmd_buf_destroy(fmd_hdl_t *, fmd_case_t *, const char *);
198 extern void fmd_buf_read(fmd_hdl_t *, fmd_case_t *,
199     const char *, void *, size_t);
200 extern void fmd_buf_write(fmd_hdl_t *, fmd_case_t *,
201     const char *, const void *, size_t);
202 extern size_t fmd_buf_size(fmd_hdl_t *, fmd_case_t *, const char *);
203 
204 extern void fmd_serd_create(fmd_hdl_t *, const char *, uint_t, hrtime_t);
205 extern void fmd_serd_destroy(fmd_hdl_t *, const char *);
206 extern int fmd_serd_exists(fmd_hdl_t *, const char *);
207 extern void fmd_serd_reset(fmd_hdl_t *, const char *);
208 extern int fmd_serd_record(fmd_hdl_t *, const char *, fmd_event_t *);
209 extern int fmd_serd_fired(fmd_hdl_t *, const char *);
210 extern int fmd_serd_empty(fmd_hdl_t *, const char *);
211 
212 extern pthread_t fmd_thr_create(fmd_hdl_t *, void (*)(void *), void *);
213 extern void fmd_thr_destroy(fmd_hdl_t *, pthread_t);
214 extern void fmd_thr_signal(fmd_hdl_t *, pthread_t);
215 
216 extern id_t fmd_timer_install(fmd_hdl_t *, void *, fmd_event_t *, hrtime_t);
217 extern void fmd_timer_remove(fmd_hdl_t *, id_t);
218 
219 extern nvlist_t *fmd_nvl_create_fault(fmd_hdl_t *,
220     const char *, uint8_t, nvlist_t *, nvlist_t *, nvlist_t *);
221 
222 extern int fmd_nvl_class_match(fmd_hdl_t *, nvlist_t *, const char *);
223 extern int fmd_nvl_fmri_expand(fmd_hdl_t *, nvlist_t *);
224 extern int fmd_nvl_fmri_present(fmd_hdl_t *, nvlist_t *);
225 extern int fmd_nvl_fmri_unusable(fmd_hdl_t *, nvlist_t *);
226 extern int fmd_nvl_fmri_faulty(fmd_hdl_t *, nvlist_t *);
227 extern int fmd_nvl_fmri_contains(fmd_hdl_t *, nvlist_t *, nvlist_t *);
228 extern nvlist_t *fmd_nvl_fmri_translate(fmd_hdl_t *, nvlist_t *, nvlist_t *);
229 
230 extern int fmd_event_local(fmd_hdl_t *, fmd_event_t *);
231 
232 #define	FMD_XPRT_RDONLY		0x1	/* transport is read-only */
233 #define	FMD_XPRT_RDWR		0x3	/* transport is read-write */
234 #define	FMD_XPRT_ACCEPT		0x4	/* transport is accepting connection */
235 #define	FMD_XPRT_SUSPENDED	0x8	/* transport starts suspended */
236 
237 extern fmd_xprt_t *fmd_xprt_open(fmd_hdl_t *, uint_t, nvlist_t *, void *);
238 extern void fmd_xprt_close(fmd_hdl_t *, fmd_xprt_t *);
239 extern void fmd_xprt_post(fmd_hdl_t *, fmd_xprt_t *, nvlist_t *, hrtime_t);
240 extern void fmd_xprt_suspend(fmd_hdl_t *, fmd_xprt_t *);
241 extern void fmd_xprt_resume(fmd_hdl_t *, fmd_xprt_t *);
242 extern int fmd_xprt_error(fmd_hdl_t *, fmd_xprt_t *);
243 extern nvlist_t *fmd_xprt_translate(fmd_hdl_t *, fmd_xprt_t *, fmd_event_t *);
244 extern void fmd_xprt_setspecific(fmd_hdl_t *, fmd_xprt_t *, void *);
245 extern void *fmd_xprt_getspecific(fmd_hdl_t *, fmd_xprt_t *);
246 
247 #ifdef	__cplusplus
248 }
249 #endif
250 
251 #endif	/* _FMD_API_H */
252