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 2009 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 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 event class values */ 48 #define FM_EREPORT_CLASS "ereport" 49 #define FM_FAULT_CLASS "fault" 50 #define FM_RSRC_CLASS "resource" 51 #define FM_LIST_EVENT "list" 52 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" 59 60 /* ereport class subcategory values */ 61 #define FM_ERROR_CPU "cpu" 62 #define FM_ERROR_IO "io" 63 64 /* ereport version and payload member names */ 65 #define FM_EREPORT_VERS0 0 66 #define FM_EREPORT_VERSION FM_EREPORT_VERS0 67 68 /* ereport payload member names */ 69 #define FM_EREPORT_DETECTOR "detector" 70 #define FM_EREPORT_ENA "ena" 71 72 /* list.* event payload member names */ 73 #define FM_LIST_EVENT_SIZE "list-sz" 74 75 /* 76 * list.suspect, isolated, updated, repaired and resolved 77 * versions/payload member names. 78 */ 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_MESSAGE "message" 87 #define FM_SUSPECT_RETIRE "retire" 88 #define FM_SUSPECT_RESPONSE "response" 89 #define FM_SUSPECT_SEVERITY "severity" 90 91 #define FM_SUSPECT_VERS0 0 92 #define FM_SUSPECT_VERSION FM_SUSPECT_VERS0 93 94 #define FM_SUSPECT_FAULTY 0x1 95 #define FM_SUSPECT_UNUSABLE 0x2 96 #define FM_SUSPECT_NOT_PRESENT 0x4 97 #define FM_SUSPECT_DEGRADED 0x8 98 #define FM_SUSPECT_REPAIRED 0x10 99 #define FM_SUSPECT_REPLACED 0x20 100 #define FM_SUSPECT_ACQUITTED 0x40 101 102 /* fault event versions and payload member names */ 103 #define FM_FAULT_VERS0 0 104 #define FM_FAULT_VERSION FM_FAULT_VERS0 105 106 #define FM_FAULT_ASRU "asru" 107 #define FM_FAULT_FRU "fru" 108 #define FM_FAULT_FRU_LABEL "fru-label" 109 #define FM_FAULT_CERTAINTY "certainty" 110 #define FM_FAULT_RESOURCE "resource" 111 #define FM_FAULT_LOCATION "location" 112 113 /* resource event versions and payload member names */ 114 #define FM_RSRC_VERS0 0 115 #define FM_RSRC_VERSION FM_RSRC_VERS0 116 #define FM_RSRC_RESOURCE "resource" 117 118 /* resource.fm.asru.* payload member names */ 119 #define FM_RSRC_ASRU_UUID "uuid" 120 #define FM_RSRC_ASRU_CODE "code" 121 #define FM_RSRC_ASRU_FAULTY "faulty" 122 #define FM_RSRC_ASRU_REPAIRED "repaired" 123 #define FM_RSRC_ASRU_REPLACED "replaced" 124 #define FM_RSRC_ASRU_ACQUITTED "acquitted" 125 #define FM_RSRC_ASRU_UNUSABLE "unusable" 126 #define FM_RSRC_ASRU_EVENT "event" 127 128 /* resource.fm.xprt.* versions and payload member names */ 129 #define FM_RSRC_XPRT_VERS0 0 130 #define FM_RSRC_XPRT_VERSION FM_RSRC_XPRT_VERS0 131 #define FM_RSRC_XPRT_UUID "uuid" 132 #define FM_RSRC_XPRT_SUBCLASS "subclass" 133 #define FM_RSRC_XPRT_FAULT_STATUS "fault-status" 134 #define FM_RSRC_XPRT_FAULT_HAS_ASRU "fault-has-asru" 135 136 /* 137 * FM ENA Format Macros 138 */ 139 #define ENA_FORMAT_MASK 0x3 140 #define ENA_FORMAT(ena) ((ena) & ENA_FORMAT_MASK) 141 142 /* ENA format types */ 143 #define FM_ENA_FMT0 0 144 #define FM_ENA_FMT1 1 145 #define FM_ENA_FMT2 2 146 147 /* Format 1 */ 148 #define ENA_FMT1_GEN_MASK 0x00000000000003FCull 149 #define ENA_FMT1_ID_MASK 0xFFFFFFFFFFFFFC00ull 150 #define ENA_FMT1_CPUID_MASK 0x00000000000FFC00ull 151 #define ENA_FMT1_TIME_MASK 0xFFFFFFFFFFF00000ull 152 #define ENA_FMT1_GEN_SHFT 2 153 #define ENA_FMT1_ID_SHFT 10 154 #define ENA_FMT1_CPUID_SHFT ENA_FMT1_ID_SHFT 155 #define ENA_FMT1_TIME_SHFT 20 156 157 /* Format 2 */ 158 #define ENA_FMT2_GEN_MASK 0x00000000000003FCull 159 #define ENA_FMT2_ID_MASK 0xFFFFFFFFFFFFFC00ull 160 #define ENA_FMT2_TIME_MASK ENA_FMT2_ID_MASK 161 #define ENA_FMT2_GEN_SHFT 2 162 #define ENA_FMT2_ID_SHFT 10 163 #define ENA_FMT2_TIME_SHFT ENA_FMT2_ID_SHFT 164 165 /* Common FMRI type names */ 166 #define FM_FMRI_AUTHORITY "authority" 167 #define FM_FMRI_SCHEME "scheme" 168 #define FM_FMRI_SVC_AUTHORITY "svc-authority" 169 #define FM_FMRI_FACILITY "facility" 170 171 /* FMRI authority-type member names */ 172 #define FM_FMRI_AUTH_CHASSIS "chassis-id" 173 #define FM_FMRI_AUTH_PRODUCT "product-id" 174 #define FM_FMRI_AUTH_DOMAIN "domain-id" 175 #define FM_FMRI_AUTH_SERVER "server-id" 176 #define FM_FMRI_AUTH_HOST "host-id" 177 178 #define FM_AUTH_VERS0 0 179 #define FM_FMRI_AUTH_VERSION FM_AUTH_VERS0 180 181 /* scheme name values */ 182 #define FM_FMRI_SCHEME_FMD "fmd" 183 #define FM_FMRI_SCHEME_DEV "dev" 184 #define FM_FMRI_SCHEME_HC "hc" 185 #define FM_FMRI_SCHEME_SVC "svc" 186 #define FM_FMRI_SCHEME_CPU "cpu" 187 #define FM_FMRI_SCHEME_MEM "mem" 188 #define FM_FMRI_SCHEME_MOD "mod" 189 #define FM_FMRI_SCHEME_PKG "pkg" 190 #define FM_FMRI_SCHEME_LEGACY "legacy-hc" 191 #define FM_FMRI_SCHEME_ZFS "zfs" 192 193 /* Scheme versions */ 194 #define FMD_SCHEME_VERSION0 0 195 #define FM_FMD_SCHEME_VERSION FMD_SCHEME_VERSION0 196 #define DEV_SCHEME_VERSION0 0 197 #define FM_DEV_SCHEME_VERSION DEV_SCHEME_VERSION0 198 #define FM_HC_VERS0 0 199 #define FM_HC_SCHEME_VERSION FM_HC_VERS0 200 #define CPU_SCHEME_VERSION0 0 201 #define CPU_SCHEME_VERSION1 1 202 #define FM_CPU_SCHEME_VERSION CPU_SCHEME_VERSION1 203 #define MEM_SCHEME_VERSION0 0 204 #define FM_MEM_SCHEME_VERSION MEM_SCHEME_VERSION0 205 #define MOD_SCHEME_VERSION0 0 206 #define FM_MOD_SCHEME_VERSION MOD_SCHEME_VERSION0 207 #define PKG_SCHEME_VERSION0 0 208 #define FM_PKG_SCHEME_VERSION PKG_SCHEME_VERSION0 209 #define LEGACY_SCHEME_VERSION0 0 210 #define FM_LEGACY_SCHEME_VERSION LEGACY_SCHEME_VERSION0 211 #define SVC_SCHEME_VERSION0 0 212 #define FM_SVC_SCHEME_VERSION SVC_SCHEME_VERSION0 213 #define ZFS_SCHEME_VERSION0 0 214 #define FM_ZFS_SCHEME_VERSION ZFS_SCHEME_VERSION0 215 216 /* hc scheme member names */ 217 #define FM_FMRI_HC_SERIAL_ID "serial" 218 #define FM_FMRI_HC_PART "part" 219 #define FM_FMRI_HC_REVISION "revision" 220 #define FM_FMRI_HC_ROOT "hc-root" 221 #define FM_FMRI_HC_LIST_SZ "hc-list-sz" 222 #define FM_FMRI_HC_LIST "hc-list" 223 #define FM_FMRI_HC_SPECIFIC "hc-specific" 224 225 /* facility member names */ 226 #define FM_FMRI_FACILITY_NAME "facility-name" 227 #define FM_FMRI_FACILITY_TYPE "facility-type" 228 229 /* hc-list version and member names */ 230 #define FM_FMRI_HC_NAME "hc-name" 231 #define FM_FMRI_HC_ID "hc-id" 232 233 #define HC_LIST_VERSION0 0 234 #define FM_HC_LIST_VERSION HC_LIST_VERSION0 235 236 /* hc-specific member names */ 237 #define FM_FMRI_HC_SPECIFIC_OFFSET "offset" 238 #define FM_FMRI_HC_SPECIFIC_PHYSADDR "physaddr" 239 240 /* fmd module scheme member names */ 241 #define FM_FMRI_FMD_NAME "mod-name" 242 #define FM_FMRI_FMD_VERSION "mod-version" 243 244 /* dev scheme member names */ 245 #define FM_FMRI_DEV_ID "devid" 246 #define FM_FMRI_DEV_PATH "device-path" 247 248 /* pkg scheme member names */ 249 #define FM_FMRI_PKG_BASEDIR "pkg-basedir" 250 #define FM_FMRI_PKG_INST "pkg-inst" 251 #define FM_FMRI_PKG_VERSION "pkg-version" 252 253 /* svc scheme member names */ 254 #define FM_FMRI_SVC_NAME "svc-name" 255 #define FM_FMRI_SVC_INSTANCE "svc-instance" 256 #define FM_FMRI_SVC_CONTRACT_ID "svc-contract-id" 257 258 /* svc-authority member names */ 259 #define FM_FMRI_SVC_AUTH_SCOPE "scope" 260 #define FM_FMRI_SVC_AUTH_SYSTEM_FQN "system-fqn" 261 262 /* cpu scheme member names */ 263 #define FM_FMRI_CPU_ID "cpuid" 264 #define FM_FMRI_CPU_SERIAL_ID "serial" 265 #define FM_FMRI_CPU_MASK "cpumask" 266 #define FM_FMRI_CPU_VID "cpuvid" 267 #define FM_FMRI_CPU_CPUFRU "cpufru" 268 #define FM_FMRI_CPU_CACHE_INDEX "cacheindex" 269 #define FM_FMRI_CPU_CACHE_WAY "cacheway" 270 #define FM_FMRI_CPU_CACHE_BIT "cachebit" 271 #define FM_FMRI_CPU_CACHE_TYPE "cachetype" 272 273 #define FM_FMRI_CPU_CACHE_TYPE_L2 0 274 #define FM_FMRI_CPU_CACHE_TYPE_L3 1 275 276 /* legacy-hc scheme member names */ 277 #define FM_FMRI_LEGACY_HC "component" 278 #define FM_FMRI_LEGACY_HC_PREFIX FM_FMRI_SCHEME_HC":///" \ 279 FM_FMRI_LEGACY_HC"=" 280 281 /* mem scheme member names */ 282 #define FM_FMRI_MEM_UNUM "unum" 283 #define FM_FMRI_MEM_SERIAL_ID "serial" 284 #define FM_FMRI_MEM_PHYSADDR "physaddr" 285 #define FM_FMRI_MEM_MEMCONFIG "memconfig" 286 #define FM_FMRI_MEM_OFFSET "offset" 287 288 /* mod scheme member names */ 289 #define FM_FMRI_MOD_PKG "mod-pkg" 290 #define FM_FMRI_MOD_NAME "mod-name" 291 #define FM_FMRI_MOD_ID "mod-id" 292 #define FM_FMRI_MOD_DESC "mod-desc" 293 294 /* zfs scheme member names */ 295 #define FM_FMRI_ZFS_POOL "pool" 296 #define FM_FMRI_ZFS_VDEV "vdev" 297 298 extern nv_alloc_t *fm_nva_xcreate(char *, size_t); 299 extern void fm_nva_xdestroy(nv_alloc_t *); 300 301 extern nvlist_t *fm_nvlist_create(nv_alloc_t *); 302 extern void fm_nvlist_destroy(nvlist_t *, int); 303 304 #define FM_NVA_FREE 0 /* free allocator on nvlist_destroy */ 305 #define FM_NVA_RETAIN 1 /* keep allocator on nvlist_destroy */ 306 307 extern void fm_ereport_set(nvlist_t *, int, const char *, uint64_t, 308 const nvlist_t *, ...); 309 extern void fm_payload_set(nvlist_t *, ...); 310 extern int i_fm_payload_set(nvlist_t *, const char *, va_list); 311 extern void fm_fmri_hc_set(nvlist_t *, int, const nvlist_t *, nvlist_t *, 312 int, ...); 313 extern void fm_fmri_dev_set(nvlist_t *, int, const nvlist_t *, const char *, 314 const char *); 315 extern void fm_fmri_de_set(nvlist_t *, int, const nvlist_t *, const char *); 316 extern void fm_fmri_cpu_set(nvlist_t *, int, const nvlist_t *, uint32_t, 317 uint8_t *, const char *); 318 extern void fm_fmri_mem_set(nvlist_t *, int, const nvlist_t *, const char *, 319 const char *, uint64_t); 320 extern void fm_authority_set(nvlist_t *, int, const char *, const char *, 321 const char *, const char *); 322 extern void fm_fmri_zfs_set(nvlist_t *, int, uint64_t, uint64_t); 323 324 extern uint64_t fm_ena_increment(uint64_t); 325 extern uint64_t fm_ena_generate(uint64_t, uchar_t); 326 extern uint64_t fm_ena_generate_cpu(uint64_t, processorid_t, uchar_t); 327 extern uint64_t fm_ena_generation_get(uint64_t); 328 extern uchar_t fm_ena_format_get(uint64_t); 329 extern uint64_t fm_ena_id_get(uint64_t); 330 extern uint64_t fm_ena_time_get(uint64_t); 331 332 #ifdef __cplusplus 333 } 334 #endif 335 336 #endif /* _SYS_FM_PROTOCOL_H */ 337