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 _SYS_FM_PROTOCOL_H 27 #define _SYS_FM_PROTOCOL_H 28 29 #ifdef __cplusplus 30 extern "C" { 31 #endif 32 33 #ifdef _KERNEL 34 #include <sys/varargs.h> 35 #include <sys/nvpair.h> 36 #else 37 #include <libnvpair.h> 38 #include <stdarg.h> 39 #endif 40 #include <sys/processor.h> 41 42 /* FM common member names */ 43 #define FM_CLASS "class" 44 #define FM_VERSION "version" 45 46 /* FM protocol category 1 class names */ 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" 52 #define FM_IREPORT_CLASS "ireport" 53 54 /* FM list.* event class values */ 55 #define FM_LIST_SUSPECT_CLASS FM_LIST_EVENT ".suspect" 56 #define FM_LIST_ISOLATED_CLASS FM_LIST_EVENT ".isolated" 57 #define FM_LIST_REPAIRED_CLASS FM_LIST_EVENT ".repaired" 58 #define FM_LIST_UPDATED_CLASS FM_LIST_EVENT ".updated" 59 #define FM_LIST_RESOLVED_CLASS FM_LIST_EVENT ".resolved" 60 61 /* ereport class subcategory values */ 62 #define FM_ERROR_CPU "cpu" 63 #define FM_ERROR_IO "io" 64 65 /* ereport version and payload member names */ 66 #define FM_EREPORT_VERS0 0 67 #define FM_EREPORT_VERSION FM_EREPORT_VERS0 68 69 /* ereport payload member names */ 70 #define FM_EREPORT_DETECTOR "detector" 71 #define FM_EREPORT_ENA "ena" 72 73 /* list.* event payload member names */ 74 #define FM_LIST_EVENT_SIZE "list-sz" 75 76 /* ireport.* event payload member names */ 77 #define FM_IREPORT_DETECTOR "detector" 78 #define FM_IREPORT_UUID "uuid" 79 #define FM_IREPORT_PRIORITY "pri" 80 #define FM_IREPORT_ATTRIBUTES "attr" 81 82 /* 83 * list.suspect, isolated, updated, repaired and resolved 84 * versions/payload member names. 85 */ 86 #define FM_SUSPECT_UUID "uuid" 87 #define FM_SUSPECT_DIAG_CODE "code" 88 #define FM_SUSPECT_DIAG_TIME "diag-time" 89 #define FM_SUSPECT_DE "de" 90 #define FM_SUSPECT_FAULT_LIST "fault-list" 91 #define FM_SUSPECT_FAULT_SZ "fault-list-sz" 92 #define FM_SUSPECT_FAULT_STATUS "fault-status" 93 #define FM_SUSPECT_INJECTED "__injected" 94 #define FM_SUSPECT_MESSAGE "message" 95 #define FM_SUSPECT_RETIRE "retire" 96 #define FM_SUSPECT_RESPONSE "response" 97 #define FM_SUSPECT_SEVERITY "severity" 98 99 #define FM_SUSPECT_VERS0 0 100 #define FM_SUSPECT_VERSION FM_SUSPECT_VERS0 101 102 #define FM_SUSPECT_FAULTY 0x1 103 #define FM_SUSPECT_UNUSABLE 0x2 104 #define FM_SUSPECT_NOT_PRESENT 0x4 105 #define FM_SUSPECT_DEGRADED 0x8 106 #define FM_SUSPECT_REPAIRED 0x10 107 #define FM_SUSPECT_REPLACED 0x20 108 #define FM_SUSPECT_ACQUITTED 0x40 109 110 /* fault event versions and payload member names */ 111 #define FM_FAULT_VERS0 0 112 #define FM_FAULT_VERSION FM_FAULT_VERS0 113 114 #define FM_FAULT_ASRU "asru" 115 #define FM_FAULT_FRU "fru" 116 #define FM_FAULT_FRU_LABEL "fru-label" 117 #define FM_FAULT_CERTAINTY "certainty" 118 #define FM_FAULT_RESOURCE "resource" 119 #define FM_FAULT_LOCATION "location" 120 121 /* resource event versions and payload member names */ 122 #define FM_RSRC_VERS0 0 123 #define FM_RSRC_VERSION FM_RSRC_VERS0 124 #define FM_RSRC_RESOURCE "resource" 125 126 /* resource.fm.asru.* payload member names */ 127 #define FM_RSRC_ASRU_UUID "uuid" 128 #define FM_RSRC_ASRU_CODE "code" 129 #define FM_RSRC_ASRU_FAULTY "faulty" 130 #define FM_RSRC_ASRU_REPAIRED "repaired" 131 #define FM_RSRC_ASRU_REPLACED "replaced" 132 #define FM_RSRC_ASRU_ACQUITTED "acquitted" 133 #define FM_RSRC_ASRU_RESOLVED "resolved" 134 #define FM_RSRC_ASRU_UNUSABLE "unusable" 135 #define FM_RSRC_ASRU_EVENT "event" 136 137 /* resource.fm.xprt.* versions and payload member names */ 138 #define FM_RSRC_XPRT_VERS0 0 139 #define FM_RSRC_XPRT_VERSION FM_RSRC_XPRT_VERS0 140 #define FM_RSRC_XPRT_UUID "uuid" 141 #define FM_RSRC_XPRT_SUBCLASS "subclass" 142 #define FM_RSRC_XPRT_FAULT_STATUS "fault-status" 143 #define FM_RSRC_XPRT_FAULT_HAS_ASRU "fault-has-asru" 144 145 /* 146 * FM ENA Format Macros 147 */ 148 #define ENA_FORMAT_MASK 0x3 149 #define ENA_FORMAT(ena) ((ena) & ENA_FORMAT_MASK) 150 151 /* ENA format types */ 152 #define FM_ENA_FMT0 0 153 #define FM_ENA_FMT1 1 154 #define FM_ENA_FMT2 2 155 156 /* Format 1 */ 157 #define ENA_FMT1_GEN_MASK 0x00000000000003FCull 158 #define ENA_FMT1_ID_MASK 0xFFFFFFFFFFFFFC00ull 159 #define ENA_FMT1_CPUID_MASK 0x00000000000FFC00ull 160 #define ENA_FMT1_TIME_MASK 0xFFFFFFFFFFF00000ull 161 #define ENA_FMT1_GEN_SHFT 2 162 #define ENA_FMT1_ID_SHFT 10 163 #define ENA_FMT1_CPUID_SHFT ENA_FMT1_ID_SHFT 164 #define ENA_FMT1_TIME_SHFT 20 165 166 /* Format 2 */ 167 #define ENA_FMT2_GEN_MASK 0x00000000000003FCull 168 #define ENA_FMT2_ID_MASK 0xFFFFFFFFFFFFFC00ull 169 #define ENA_FMT2_TIME_MASK ENA_FMT2_ID_MASK 170 #define ENA_FMT2_GEN_SHFT 2 171 #define ENA_FMT2_ID_SHFT 10 172 #define ENA_FMT2_TIME_SHFT ENA_FMT2_ID_SHFT 173 174 /* Common FMRI type names */ 175 #define FM_FMRI_AUTHORITY "authority" 176 #define FM_FMRI_SCHEME "scheme" 177 #define FM_FMRI_SVC_AUTHORITY "svc-authority" 178 #define FM_FMRI_FACILITY "facility" 179 180 /* FMRI authority-type member names */ 181 #define FM_FMRI_AUTH_CHASSIS "chassis-id" 182 #define FM_FMRI_AUTH_PRODUCT_SN "product-sn" 183 #define FM_FMRI_AUTH_PRODUCT "product-id" 184 #define FM_FMRI_AUTH_DOMAIN "domain-id" 185 #define FM_FMRI_AUTH_SERVER "server-id" 186 #define FM_FMRI_AUTH_HOST "host-id" 187 188 #define FM_AUTH_VERS0 0 189 #define FM_FMRI_AUTH_VERSION FM_AUTH_VERS0 190 191 /* scheme name values */ 192 #define FM_FMRI_SCHEME_FMD "fmd" 193 #define FM_FMRI_SCHEME_DEV "dev" 194 #define FM_FMRI_SCHEME_HC "hc" 195 #define FM_FMRI_SCHEME_SVC "svc" 196 #define FM_FMRI_SCHEME_CPU "cpu" 197 #define FM_FMRI_SCHEME_MEM "mem" 198 #define FM_FMRI_SCHEME_MOD "mod" 199 #define FM_FMRI_SCHEME_PKG "pkg" 200 #define FM_FMRI_SCHEME_LEGACY "legacy-hc" 201 #define FM_FMRI_SCHEME_ZFS "zfs" 202 #define FM_FMRI_SCHEME_SW "sw" 203 204 /* Scheme versions */ 205 #define FMD_SCHEME_VERSION0 0 206 #define FM_FMD_SCHEME_VERSION FMD_SCHEME_VERSION0 207 #define DEV_SCHEME_VERSION0 0 208 #define FM_DEV_SCHEME_VERSION DEV_SCHEME_VERSION0 209 #define FM_HC_VERS0 0 210 #define FM_HC_SCHEME_VERSION FM_HC_VERS0 211 #define CPU_SCHEME_VERSION0 0 212 #define CPU_SCHEME_VERSION1 1 213 #define FM_CPU_SCHEME_VERSION CPU_SCHEME_VERSION1 214 #define MEM_SCHEME_VERSION0 0 215 #define FM_MEM_SCHEME_VERSION MEM_SCHEME_VERSION0 216 #define MOD_SCHEME_VERSION0 0 217 #define FM_MOD_SCHEME_VERSION MOD_SCHEME_VERSION0 218 #define PKG_SCHEME_VERSION0 0 219 #define FM_PKG_SCHEME_VERSION PKG_SCHEME_VERSION0 220 #define LEGACY_SCHEME_VERSION0 0 221 #define FM_LEGACY_SCHEME_VERSION LEGACY_SCHEME_VERSION0 222 #define SVC_SCHEME_VERSION0 0 223 #define FM_SVC_SCHEME_VERSION SVC_SCHEME_VERSION0 224 #define ZFS_SCHEME_VERSION0 0 225 #define FM_ZFS_SCHEME_VERSION ZFS_SCHEME_VERSION0 226 #define SW_SCHEME_VERSION0 0 227 #define FM_SW_SCHEME_VERSION SW_SCHEME_VERSION0 228 229 /* hc scheme member names */ 230 #define FM_FMRI_HC_SERIAL_ID "serial" 231 #define FM_FMRI_HC_PART "part" 232 #define FM_FMRI_HC_REVISION "revision" 233 #define FM_FMRI_HC_ROOT "hc-root" 234 #define FM_FMRI_HC_LIST_SZ "hc-list-sz" 235 #define FM_FMRI_HC_LIST "hc-list" 236 #define FM_FMRI_HC_SPECIFIC "hc-specific" 237 238 /* facility member names */ 239 #define FM_FMRI_FACILITY_NAME "facility-name" 240 #define FM_FMRI_FACILITY_TYPE "facility-type" 241 242 /* hc-list version and member names */ 243 #define FM_FMRI_HC_NAME "hc-name" 244 #define FM_FMRI_HC_ID "hc-id" 245 246 #define HC_LIST_VERSION0 0 247 #define FM_HC_LIST_VERSION HC_LIST_VERSION0 248 249 /* hc-specific member names */ 250 #define FM_FMRI_HC_SPECIFIC_OFFSET "offset" 251 #define FM_FMRI_HC_SPECIFIC_PHYSADDR "physaddr" 252 253 /* fmd module scheme member names */ 254 #define FM_FMRI_FMD_NAME "mod-name" 255 #define FM_FMRI_FMD_VERSION "mod-version" 256 257 /* dev scheme member names */ 258 #define FM_FMRI_DEV_ID "devid" 259 #define FM_FMRI_DEV_TGTPTLUN0 "target-port-l0id" 260 #define FM_FMRI_DEV_PATH "device-path" 261 262 /* pkg scheme member names */ 263 #define FM_FMRI_PKG_BASEDIR "pkg-basedir" 264 #define FM_FMRI_PKG_INST "pkg-inst" 265 #define FM_FMRI_PKG_VERSION "pkg-version" 266 267 /* svc scheme member names */ 268 #define FM_FMRI_SVC_NAME "svc-name" 269 #define FM_FMRI_SVC_INSTANCE "svc-instance" 270 #define FM_FMRI_SVC_CONTRACT_ID "svc-contract-id" 271 272 /* svc-authority member names */ 273 #define FM_FMRI_SVC_AUTH_SCOPE "scope" 274 #define FM_FMRI_SVC_AUTH_SYSTEM_FQN "system-fqn" 275 276 /* cpu scheme member names */ 277 #define FM_FMRI_CPU_ID "cpuid" 278 #define FM_FMRI_CPU_SERIAL_ID "serial" 279 #define FM_FMRI_CPU_MASK "cpumask" 280 #define FM_FMRI_CPU_VID "cpuvid" 281 #define FM_FMRI_CPU_CPUFRU "cpufru" 282 #define FM_FMRI_CPU_CACHE_INDEX "cacheindex" 283 #define FM_FMRI_CPU_CACHE_WAY "cacheway" 284 #define FM_FMRI_CPU_CACHE_BIT "cachebit" 285 #define FM_FMRI_CPU_CACHE_TYPE "cachetype" 286 287 #define FM_FMRI_CPU_CACHE_TYPE_L2 0 288 #define FM_FMRI_CPU_CACHE_TYPE_L3 1 289 290 /* legacy-hc scheme member names */ 291 #define FM_FMRI_LEGACY_HC "component" 292 #define FM_FMRI_LEGACY_HC_PREFIX FM_FMRI_SCHEME_HC":///" \ 293 FM_FMRI_LEGACY_HC"=" 294 295 /* mem scheme member names */ 296 #define FM_FMRI_MEM_UNUM "unum" 297 #define FM_FMRI_MEM_SERIAL_ID "serial" 298 #define FM_FMRI_MEM_PHYSADDR "physaddr" 299 #define FM_FMRI_MEM_MEMCONFIG "memconfig" 300 #define FM_FMRI_MEM_OFFSET "offset" 301 302 /* mod scheme member names */ 303 #define FM_FMRI_MOD_PKG "mod-pkg" 304 #define FM_FMRI_MOD_NAME "mod-name" 305 #define FM_FMRI_MOD_ID "mod-id" 306 #define FM_FMRI_MOD_DESC "mod-desc" 307 308 /* zfs scheme member names */ 309 #define FM_FMRI_ZFS_POOL "pool" 310 #define FM_FMRI_ZFS_VDEV "vdev" 311 312 /* sw scheme member names - extra indentation for members of an nvlist */ 313 #define FM_FMRI_SW_OBJ "object" 314 #define FM_FMRI_SW_OBJ_PATH "path" 315 #define FM_FMRI_SW_OBJ_ROOT "root" 316 #define FM_FMRI_SW_OBJ_PKG "pkg" 317 #define FM_FMRI_SW_SITE "site" 318 #define FM_FMRI_SW_SITE_TOKEN "token" 319 #define FM_FMRI_SW_SITE_MODULE "module" 320 #define FM_FMRI_SW_SITE_FILE "file" 321 #define FM_FMRI_SW_SITE_LINE "line" 322 #define FM_FMRI_SW_SITE_FUNC "func" 323 #define FM_FMRI_SW_CTXT "context" 324 #define FM_FMRI_SW_CTXT_ORIGIN "origin" 325 #define FM_FMRI_SW_CTXT_EXECNAME "execname" 326 #define FM_FMRI_SW_CTXT_PID "pid" 327 #define FM_FMRI_SW_CTXT_ZONE "zone" 328 #define FM_FMRI_SW_CTXT_CTID "ctid" 329 #define FM_FMRI_SW_CTXT_STACK "stack" 330 331 extern nv_alloc_t *fm_nva_xcreate(char *, size_t); 332 extern void fm_nva_xdestroy(nv_alloc_t *); 333 334 extern nvlist_t *fm_nvlist_create(nv_alloc_t *); 335 extern void fm_nvlist_destroy(nvlist_t *, int); 336 337 #define FM_NVA_FREE 0 /* free allocator on nvlist_destroy */ 338 #define FM_NVA_RETAIN 1 /* keep allocator on nvlist_destroy */ 339 340 extern void fm_ereport_set(nvlist_t *, int, const char *, uint64_t, 341 const nvlist_t *, ...); 342 extern void fm_payload_set(nvlist_t *, ...); 343 extern int i_fm_payload_set(nvlist_t *, const char *, va_list); 344 extern void fm_fmri_hc_set(nvlist_t *, int, const nvlist_t *, nvlist_t *, 345 int, ...); 346 extern void fm_fmri_dev_set(nvlist_t *, int, const nvlist_t *, const char *, 347 const char *, const char *); 348 extern void fm_fmri_de_set(nvlist_t *, int, const nvlist_t *, const char *); 349 extern void fm_fmri_cpu_set(nvlist_t *, int, const nvlist_t *, uint32_t, 350 uint8_t *, const char *); 351 extern void fm_fmri_mem_set(nvlist_t *, int, const nvlist_t *, const char *, 352 const char *, uint64_t); 353 extern void fm_authority_set(nvlist_t *, int, const char *, const char *, 354 const char *, const char *); 355 extern void fm_fmri_zfs_set(nvlist_t *, int, uint64_t, uint64_t); 356 extern void fm_fmri_hc_create(nvlist_t *, int, const nvlist_t *, nvlist_t *, 357 nvlist_t *, int, ...); 358 359 extern uint64_t fm_ena_increment(uint64_t); 360 extern uint64_t fm_ena_generate(uint64_t, uchar_t); 361 extern uint64_t fm_ena_generate_cpu(uint64_t, processorid_t, uchar_t); 362 extern uint64_t fm_ena_generation_get(uint64_t); 363 extern uchar_t fm_ena_format_get(uint64_t); 364 extern uint64_t fm_ena_id_get(uint64_t); 365 extern uint64_t fm_ena_time_get(uint64_t); 366 367 #ifdef __cplusplus 368 } 369 #endif 370 371 #endif /* _SYS_FM_PROTOCOL_H */ 372