]>
git.proxmox.com Git - mirror_zfs.git/blob - module/zfs/include/sys/fm/protocol.h
c4103c48a47fac9c76ebe7399fbd155ef5ecff15
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.
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.
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]
23 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
26 #ifndef _SYS_FM_PROTOCOL_H
27 #define _SYS_FM_PROTOCOL_H
34 #include <sys/varargs.h>
35 #include <sys/nvpair.h>
37 #include <libnvpair.h>
40 #include <sys/processor.h>
42 /* FM common member names */
43 #define FM_CLASS "class"
44 #define FM_VERSION "version"
46 /* FM event class values */
47 #define FM_EREPORT_CLASS "ereport"
48 #define FM_FAULT_CLASS "fault"
49 #define FM_DEFECT_CLASS "defect"
50 #define FM_RSRC_CLASS "resource"
51 #define FM_LIST_EVENT "list"
53 /* FM list.* event class values */
54 #define FM_LIST_SUSPECT_CLASS FM_LIST_EVENT ".suspect"
55 #define FM_LIST_ISOLATED_CLASS FM_LIST_EVENT ".isolated"
56 #define FM_LIST_REPAIRED_CLASS FM_LIST_EVENT ".repaired"
57 #define FM_LIST_UPDATED_CLASS FM_LIST_EVENT ".updated"
58 #define FM_LIST_RESOLVED_CLASS FM_LIST_EVENT ".resolved"
60 /* ereport class subcategory values */
61 #define FM_ERROR_CPU "cpu"
62 #define FM_ERROR_IO "io"
64 /* ereport version and payload member names */
65 #define FM_EREPORT_VERS0 0
66 #define FM_EREPORT_VERSION FM_EREPORT_VERS0
68 /* ereport payload member names */
69 #define FM_EREPORT_DETECTOR "detector"
70 #define FM_EREPORT_ENA "ena"
72 /* list.* event payload member names */
73 #define FM_LIST_EVENT_SIZE "list-sz"
76 * list.suspect, isolated, updated, repaired and resolved
77 * versions/payload member names.
79 #define FM_SUSPECT_UUID "uuid"
80 #define FM_SUSPECT_DIAG_CODE "code"
81 #define FM_SUSPECT_DIAG_TIME "diag-time"
82 #define FM_SUSPECT_DE "de"
83 #define FM_SUSPECT_FAULT_LIST "fault-list"
84 #define FM_SUSPECT_FAULT_SZ "fault-list-sz"
85 #define FM_SUSPECT_FAULT_STATUS "fault-status"
86 #define FM_SUSPECT_INJECTED "__injected"
87 #define FM_SUSPECT_MESSAGE "message"
88 #define FM_SUSPECT_RETIRE "retire"
89 #define FM_SUSPECT_RESPONSE "response"
90 #define FM_SUSPECT_SEVERITY "severity"
92 #define FM_SUSPECT_VERS0 0
93 #define FM_SUSPECT_VERSION FM_SUSPECT_VERS0
95 #define FM_SUSPECT_FAULTY 0x1
96 #define FM_SUSPECT_UNUSABLE 0x2
97 #define FM_SUSPECT_NOT_PRESENT 0x4
98 #define FM_SUSPECT_DEGRADED 0x8
99 #define FM_SUSPECT_REPAIRED 0x10
100 #define FM_SUSPECT_REPLACED 0x20
101 #define FM_SUSPECT_ACQUITTED 0x40
103 /* fault event versions and payload member names */
104 #define FM_FAULT_VERS0 0
105 #define FM_FAULT_VERSION FM_FAULT_VERS0
107 #define FM_FAULT_ASRU "asru"
108 #define FM_FAULT_FRU "fru"
109 #define FM_FAULT_FRU_LABEL "fru-label"
110 #define FM_FAULT_CERTAINTY "certainty"
111 #define FM_FAULT_RESOURCE "resource"
112 #define FM_FAULT_LOCATION "location"
114 /* resource event versions and payload member names */
115 #define FM_RSRC_VERS0 0
116 #define FM_RSRC_VERSION FM_RSRC_VERS0
117 #define FM_RSRC_RESOURCE "resource"
119 /* resource.fm.asru.* payload member names */
120 #define FM_RSRC_ASRU_UUID "uuid"
121 #define FM_RSRC_ASRU_CODE "code"
122 #define FM_RSRC_ASRU_FAULTY "faulty"
123 #define FM_RSRC_ASRU_REPAIRED "repaired"
124 #define FM_RSRC_ASRU_REPLACED "replaced"
125 #define FM_RSRC_ASRU_ACQUITTED "acquitted"
126 #define FM_RSRC_ASRU_RESOLVED "resolved"
127 #define FM_RSRC_ASRU_UNUSABLE "unusable"
128 #define FM_RSRC_ASRU_EVENT "event"
130 /* resource.fm.xprt.* versions and payload member names */
131 #define FM_RSRC_XPRT_VERS0 0
132 #define FM_RSRC_XPRT_VERSION FM_RSRC_XPRT_VERS0
133 #define FM_RSRC_XPRT_UUID "uuid"
134 #define FM_RSRC_XPRT_SUBCLASS "subclass"
135 #define FM_RSRC_XPRT_FAULT_STATUS "fault-status"
136 #define FM_RSRC_XPRT_FAULT_HAS_ASRU "fault-has-asru"
139 * FM ENA Format Macros
141 #define ENA_FORMAT_MASK 0x3
142 #define ENA_FORMAT(ena) ((ena) & ENA_FORMAT_MASK)
144 /* ENA format types */
145 #define FM_ENA_FMT0 0
146 #define FM_ENA_FMT1 1
147 #define FM_ENA_FMT2 2
150 #define ENA_FMT1_GEN_MASK 0x00000000000003FCull
151 #define ENA_FMT1_ID_MASK 0xFFFFFFFFFFFFFC00ull
152 #define ENA_FMT1_CPUID_MASK 0x00000000000FFC00ull
153 #define ENA_FMT1_TIME_MASK 0xFFFFFFFFFFF00000ull
154 #define ENA_FMT1_GEN_SHFT 2
155 #define ENA_FMT1_ID_SHFT 10
156 #define ENA_FMT1_CPUID_SHFT ENA_FMT1_ID_SHFT
157 #define ENA_FMT1_TIME_SHFT 20
160 #define ENA_FMT2_GEN_MASK 0x00000000000003FCull
161 #define ENA_FMT2_ID_MASK 0xFFFFFFFFFFFFFC00ull
162 #define ENA_FMT2_TIME_MASK ENA_FMT2_ID_MASK
163 #define ENA_FMT2_GEN_SHFT 2
164 #define ENA_FMT2_ID_SHFT 10
165 #define ENA_FMT2_TIME_SHFT ENA_FMT2_ID_SHFT
167 /* Common FMRI type names */
168 #define FM_FMRI_AUTHORITY "authority"
169 #define FM_FMRI_SCHEME "scheme"
170 #define FM_FMRI_SVC_AUTHORITY "svc-authority"
171 #define FM_FMRI_FACILITY "facility"
173 /* FMRI authority-type member names */
174 #define FM_FMRI_AUTH_CHASSIS "chassis-id"
175 #define FM_FMRI_AUTH_PRODUCT_SN "product-sn"
176 #define FM_FMRI_AUTH_PRODUCT "product-id"
177 #define FM_FMRI_AUTH_DOMAIN "domain-id"
178 #define FM_FMRI_AUTH_SERVER "server-id"
179 #define FM_FMRI_AUTH_HOST "host-id"
181 #define FM_AUTH_VERS0 0
182 #define FM_FMRI_AUTH_VERSION FM_AUTH_VERS0
184 /* scheme name values */
185 #define FM_FMRI_SCHEME_FMD "fmd"
186 #define FM_FMRI_SCHEME_DEV "dev"
187 #define FM_FMRI_SCHEME_HC "hc"
188 #define FM_FMRI_SCHEME_SVC "svc"
189 #define FM_FMRI_SCHEME_CPU "cpu"
190 #define FM_FMRI_SCHEME_MEM "mem"
191 #define FM_FMRI_SCHEME_MOD "mod"
192 #define FM_FMRI_SCHEME_PKG "pkg"
193 #define FM_FMRI_SCHEME_LEGACY "legacy-hc"
194 #define FM_FMRI_SCHEME_ZFS "zfs"
196 /* Scheme versions */
197 #define FMD_SCHEME_VERSION0 0
198 #define FM_FMD_SCHEME_VERSION FMD_SCHEME_VERSION0
199 #define DEV_SCHEME_VERSION0 0
200 #define FM_DEV_SCHEME_VERSION DEV_SCHEME_VERSION0
201 #define FM_HC_VERS0 0
202 #define FM_HC_SCHEME_VERSION FM_HC_VERS0
203 #define CPU_SCHEME_VERSION0 0
204 #define CPU_SCHEME_VERSION1 1
205 #define FM_CPU_SCHEME_VERSION CPU_SCHEME_VERSION1
206 #define MEM_SCHEME_VERSION0 0
207 #define FM_MEM_SCHEME_VERSION MEM_SCHEME_VERSION0
208 #define MOD_SCHEME_VERSION0 0
209 #define FM_MOD_SCHEME_VERSION MOD_SCHEME_VERSION0
210 #define PKG_SCHEME_VERSION0 0
211 #define FM_PKG_SCHEME_VERSION PKG_SCHEME_VERSION0
212 #define LEGACY_SCHEME_VERSION0 0
213 #define FM_LEGACY_SCHEME_VERSION LEGACY_SCHEME_VERSION0
214 #define SVC_SCHEME_VERSION0 0
215 #define FM_SVC_SCHEME_VERSION SVC_SCHEME_VERSION0
216 #define ZFS_SCHEME_VERSION0 0
217 #define FM_ZFS_SCHEME_VERSION ZFS_SCHEME_VERSION0
219 /* hc scheme member names */
220 #define FM_FMRI_HC_SERIAL_ID "serial"
221 #define FM_FMRI_HC_PART "part"
222 #define FM_FMRI_HC_REVISION "revision"
223 #define FM_FMRI_HC_ROOT "hc-root"
224 #define FM_FMRI_HC_LIST_SZ "hc-list-sz"
225 #define FM_FMRI_HC_LIST "hc-list"
226 #define FM_FMRI_HC_SPECIFIC "hc-specific"
228 /* facility member names */
229 #define FM_FMRI_FACILITY_NAME "facility-name"
230 #define FM_FMRI_FACILITY_TYPE "facility-type"
232 /* hc-list version and member names */
233 #define FM_FMRI_HC_NAME "hc-name"
234 #define FM_FMRI_HC_ID "hc-id"
236 #define HC_LIST_VERSION0 0
237 #define FM_HC_LIST_VERSION HC_LIST_VERSION0
239 /* hc-specific member names */
240 #define FM_FMRI_HC_SPECIFIC_OFFSET "offset"
241 #define FM_FMRI_HC_SPECIFIC_PHYSADDR "physaddr"
243 /* fmd module scheme member names */
244 #define FM_FMRI_FMD_NAME "mod-name"
245 #define FM_FMRI_FMD_VERSION "mod-version"
247 /* dev scheme member names */
248 #define FM_FMRI_DEV_ID "devid"
249 #define FM_FMRI_DEV_TGTPTLUN0 "target-port-l0id"
250 #define FM_FMRI_DEV_PATH "device-path"
252 /* pkg scheme member names */
253 #define FM_FMRI_PKG_BASEDIR "pkg-basedir"
254 #define FM_FMRI_PKG_INST "pkg-inst"
255 #define FM_FMRI_PKG_VERSION "pkg-version"
257 /* svc scheme member names */
258 #define FM_FMRI_SVC_NAME "svc-name"
259 #define FM_FMRI_SVC_INSTANCE "svc-instance"
260 #define FM_FMRI_SVC_CONTRACT_ID "svc-contract-id"
262 /* svc-authority member names */
263 #define FM_FMRI_SVC_AUTH_SCOPE "scope"
264 #define FM_FMRI_SVC_AUTH_SYSTEM_FQN "system-fqn"
266 /* cpu scheme member names */
267 #define FM_FMRI_CPU_ID "cpuid"
268 #define FM_FMRI_CPU_SERIAL_ID "serial"
269 #define FM_FMRI_CPU_MASK "cpumask"
270 #define FM_FMRI_CPU_VID "cpuvid"
271 #define FM_FMRI_CPU_CPUFRU "cpufru"
272 #define FM_FMRI_CPU_CACHE_INDEX "cacheindex"
273 #define FM_FMRI_CPU_CACHE_WAY "cacheway"
274 #define FM_FMRI_CPU_CACHE_BIT "cachebit"
275 #define FM_FMRI_CPU_CACHE_TYPE "cachetype"
277 #define FM_FMRI_CPU_CACHE_TYPE_L2 0
278 #define FM_FMRI_CPU_CACHE_TYPE_L3 1
280 /* legacy-hc scheme member names */
281 #define FM_FMRI_LEGACY_HC "component"
282 #define FM_FMRI_LEGACY_HC_PREFIX FM_FMRI_SCHEME_HC":///" \
285 /* mem scheme member names */
286 #define FM_FMRI_MEM_UNUM "unum"
287 #define FM_FMRI_MEM_SERIAL_ID "serial"
288 #define FM_FMRI_MEM_PHYSADDR "physaddr"
289 #define FM_FMRI_MEM_MEMCONFIG "memconfig"
290 #define FM_FMRI_MEM_OFFSET "offset"
292 /* mod scheme member names */
293 #define FM_FMRI_MOD_PKG "mod-pkg"
294 #define FM_FMRI_MOD_NAME "mod-name"
295 #define FM_FMRI_MOD_ID "mod-id"
296 #define FM_FMRI_MOD_DESC "mod-desc"
298 /* zfs scheme member names */
299 #define FM_FMRI_ZFS_POOL "pool"
300 #define FM_FMRI_ZFS_VDEV "vdev"
302 extern nv_alloc_t
*fm_nva_xcreate(char *, size_t);
303 extern void fm_nva_xdestroy(nv_alloc_t
*);
305 extern nvlist_t
*fm_nvlist_create(nv_alloc_t
*);
306 extern void fm_nvlist_destroy(nvlist_t
*, int);
308 #define FM_NVA_FREE 0 /* free allocator on nvlist_destroy */
309 #define FM_NVA_RETAIN 1 /* keep allocator on nvlist_destroy */
311 extern void fm_ereport_set(nvlist_t
*, int, const char *, uint64_t,
312 const nvlist_t
*, ...);
313 extern void fm_payload_set(nvlist_t
*, ...);
314 extern int i_fm_payload_set(nvlist_t
*, const char *, va_list);
315 extern void fm_fmri_hc_set(nvlist_t
*, int, const nvlist_t
*, nvlist_t
*,
317 extern void fm_fmri_dev_set(nvlist_t
*, int, const nvlist_t
*, const char *,
318 const char *, const char *);
319 extern void fm_fmri_de_set(nvlist_t
*, int, const nvlist_t
*, const char *);
320 extern void fm_fmri_cpu_set(nvlist_t
*, int, const nvlist_t
*, uint32_t,
321 uint8_t *, const char *);
322 extern void fm_fmri_mem_set(nvlist_t
*, int, const nvlist_t
*, const char *,
323 const char *, uint64_t);
324 extern void fm_authority_set(nvlist_t
*, int, const char *, const char *,
325 const char *, const char *);
326 extern void fm_fmri_zfs_set(nvlist_t
*, int, uint64_t, uint64_t);
327 extern void fm_fmri_hc_create(nvlist_t
*, int, const nvlist_t
*, nvlist_t
*,
328 nvlist_t
*, int, ...);
330 extern uint64_t fm_ena_increment(uint64_t);
331 extern uint64_t fm_ena_generate(uint64_t, uchar_t
);
332 extern uint64_t fm_ena_generate_cpu(uint64_t, processorid_t
, uchar_t
);
333 extern uint64_t fm_ena_generation_get(uint64_t);
334 extern uchar_t
fm_ena_format_get(uint64_t);
335 extern uint64_t fm_ena_id_get(uint64_t);
336 extern uint64_t fm_ena_time_get(uint64_t);
342 #endif /* _SYS_FM_PROTOCOL_H */