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