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