Home | History | Annotate | Download | only in fm
      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 2007 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 #pragma ident	"@(#)protocol.h	1.14	07/10/12 SMI"
     31 
     32 #ifdef	__cplusplus
     33 extern "C" {
     34 #endif
     35 
     36 #ifdef _KERNEL
     37 #include <sys/varargs.h>
     38 #include <sys/nvpair.h>
     39 #else
     40 #include <libnvpair.h>
     41 #include <stdarg.h>
     42 #endif
     43 #include <sys/processor.h>
     44 
     45 /* FM common member names */
     46 #define	FM_CLASS			"class"
     47 #define	FM_VERSION			"version"
     48 
     49 /* FM event class values */
     50 #define	FM_EREPORT_CLASS		"ereport"
     51 #define	FM_FAULT_CLASS			"fault"
     52 #define	FM_RSRC_CLASS			"resource"
     53 #define	FM_LIST_EVENT			"list"
     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 
     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 /* list.suspect, isolated, and repaired versions and payload member names */
     76 #define	FM_SUSPECT_UUID			"uuid"
     77 #define	FM_SUSPECT_DIAG_CODE		"code"
     78 #define	FM_SUSPECT_DIAG_TIME		"diag-time"
     79 #define	FM_SUSPECT_DE			"de"
     80 #define	FM_SUSPECT_FAULT_LIST		"fault-list"
     81 #define	FM_SUSPECT_FAULT_SZ		"fault-list-sz"
     82 #define	FM_SUSPECT_FAULT_STATUS		"fault-status"
     83 #define	FM_SUSPECT_MESSAGE		"message"
     84 
     85 #define	FM_SUSPECT_VERS0		0
     86 #define	FM_SUSPECT_VERSION		FM_SUSPECT_VERS0
     87 
     88 #define	FM_SUSPECT_FAULTY		0x1
     89 #define	FM_SUSPECT_UNUSABLE		0x2
     90 #define	FM_SUSPECT_NOT_PRESENT		0x4
     91 
     92 /* fault event versions and payload member names */
     93 #define	FM_FAULT_VERS0			0
     94 #define	FM_FAULT_VERSION		FM_FAULT_VERS0
     95 
     96 #define	FM_FAULT_ASRU			"asru"
     97 #define	FM_FAULT_FRU			"fru"
     98 #define	FM_FAULT_FRU_LABEL		"fru-label"
     99 #define	FM_FAULT_CERTAINTY		"certainty"
    100 #define	FM_FAULT_RESOURCE		"resource"
    101 #define	FM_FAULT_LOCATION		"location"
    102 
    103 /* resource event versions and payload member names */
    104 #define	FM_RSRC_VERS0			0
    105 #define	FM_RSRC_VERSION			FM_RSRC_VERS0
    106 #define	FM_RSRC_RESOURCE		"resource"
    107 
    108 /* resource.fm.asru.* payload member names */
    109 #define	FM_RSRC_ASRU_UUID		"uuid"
    110 #define	FM_RSRC_ASRU_CODE		"code"
    111 #define	FM_RSRC_ASRU_FAULTY		"faulty"
    112 #define	FM_RSRC_ASRU_UNUSABLE		"unusable"
    113 #define	FM_RSRC_ASRU_EVENT		"event"
    114 
    115 /* resource.fm.xprt.* versions and payload member names */
    116 #define	FM_RSRC_XPRT_VERS0		0
    117 #define	FM_RSRC_XPRT_VERSION		FM_RSRC_XPRT_VERS0
    118 #define	FM_RSRC_XPRT_UUID		"uuid"
    119 #define	FM_RSRC_XPRT_SUBCLASS		"subclass"
    120 
    121 /*
    122  * FM ENA Format Macros
    123  */
    124 #define	ENA_FORMAT_MASK			0x3
    125 #define	ENA_FORMAT(ena)			((ena) & ENA_FORMAT_MASK)
    126 
    127 /* ENA format types */
    128 #define	FM_ENA_FMT0			0
    129 #define	FM_ENA_FMT1			1
    130 #define	FM_ENA_FMT2			2
    131 
    132 /* Format 1 */
    133 #define	ENA_FMT1_GEN_MASK		0x00000000000003FCull
    134 #define	ENA_FMT1_ID_MASK		0xFFFFFFFFFFFFFC00ull
    135 #define	ENA_FMT1_CPUID_MASK		0x00000000000FFC00ull
    136 #define	ENA_FMT1_TIME_MASK		0xFFFFFFFFFFF00000ull
    137 #define	ENA_FMT1_GEN_SHFT		2
    138 #define	ENA_FMT1_ID_SHFT		10
    139 #define	ENA_FMT1_CPUID_SHFT		ENA_FMT1_ID_SHFT
    140 #define	ENA_FMT1_TIME_SHFT		20
    141 
    142 /* Format 2 */
    143 #define	ENA_FMT2_GEN_MASK		0x00000000000003FCull
    144 #define	ENA_FMT2_ID_MASK		0xFFFFFFFFFFFFFC00ull
    145 #define	ENA_FMT2_TIME_MASK		ENA_FMT2_ID_MASK
    146 #define	ENA_FMT2_GEN_SHFT		2
    147 #define	ENA_FMT2_ID_SHFT		10
    148 #define	ENA_FMT2_TIME_SHFT		ENA_FMT2_ID_SHFT
    149 
    150 /* Common FMRI type names */
    151 #define	FM_FMRI_AUTHORITY		"authority"
    152 #define	FM_FMRI_SCHEME			"scheme"
    153 #define	FM_FMRI_SVC_AUTHORITY		"svc-authority"
    154 
    155 /* FMRI authority-type member names */
    156 #define	FM_FMRI_AUTH_CHASSIS		"chassis-id"
    157 #define	FM_FMRI_AUTH_PRODUCT		"product-id"
    158 #define	FM_FMRI_AUTH_DOMAIN		"domain-id"
    159 #define	FM_FMRI_AUTH_SERVER		"server-id"
    160 #define	FM_FMRI_AUTH_HOST		"host-id"
    161 
    162 #define	FM_AUTH_VERS0			0
    163 #define	FM_FMRI_AUTH_VERSION		FM_AUTH_VERS0
    164 
    165 /* scheme name values */
    166 #define	FM_FMRI_SCHEME_FMD		"fmd"
    167 #define	FM_FMRI_SCHEME_DEV		"dev"
    168 #define	FM_FMRI_SCHEME_HC		"hc"
    169 #define	FM_FMRI_SCHEME_SVC		"svc"
    170 #define	FM_FMRI_SCHEME_CPU		"cpu"
    171 #define	FM_FMRI_SCHEME_MEM		"mem"
    172 #define	FM_FMRI_SCHEME_MOD		"mod"
    173 #define	FM_FMRI_SCHEME_PKG		"pkg"
    174 #define	FM_FMRI_SCHEME_LEGACY		"legacy-hc"
    175 #define	FM_FMRI_SCHEME_ZFS		"zfs"
    176 
    177 /* Scheme versions */
    178 #define	FMD_SCHEME_VERSION0		0
    179 #define	FM_FMD_SCHEME_VERSION		FMD_SCHEME_VERSION0
    180 #define	DEV_SCHEME_VERSION0		0
    181 #define	FM_DEV_SCHEME_VERSION		DEV_SCHEME_VERSION0
    182 #define	FM_HC_VERS0			0
    183 #define	FM_HC_SCHEME_VERSION		FM_HC_VERS0
    184 #define	CPU_SCHEME_VERSION0		0
    185 #define	CPU_SCHEME_VERSION1		1
    186 #define	FM_CPU_SCHEME_VERSION		CPU_SCHEME_VERSION1
    187 #define	MEM_SCHEME_VERSION0		0
    188 #define	FM_MEM_SCHEME_VERSION		MEM_SCHEME_VERSION0
    189 #define	MOD_SCHEME_VERSION0		0
    190 #define	FM_MOD_SCHEME_VERSION		MOD_SCHEME_VERSION0
    191 #define	PKG_SCHEME_VERSION0		0
    192 #define	FM_PKG_SCHEME_VERSION		PKG_SCHEME_VERSION0
    193 #define	LEGACY_SCHEME_VERSION0		0
    194 #define	FM_LEGACY_SCHEME_VERSION	LEGACY_SCHEME_VERSION0
    195 #define	ZFS_SCHEME_VERSION0		0
    196 #define	FM_ZFS_SCHEME_VERSION		ZFS_SCHEME_VERSION0
    197 
    198 /* hc scheme member names */
    199 #define	FM_FMRI_HC_SERIAL_ID		"serial"
    200 #define	FM_FMRI_HC_PART			"part"
    201 #define	FM_FMRI_HC_REVISION		"revision"
    202 #define	FM_FMRI_HC_ROOT			"hc-root"
    203 #define	FM_FMRI_HC_LIST_SZ		"hc-list-sz"
    204 #define	FM_FMRI_HC_LIST			"hc-list"
    205 #define	FM_FMRI_HC_SPECIFIC		"hc-specific"
    206 
    207 /* hc-list version and member names */
    208 #define	FM_FMRI_HC_NAME			"hc-name"
    209 #define	FM_FMRI_HC_ID			"hc-id"
    210 
    211 #define	HC_LIST_VERSION0		0
    212 #define	FM_HC_LIST_VERSION		HC_LIST_VERSION0
    213 
    214 /* hc-specific member names */
    215 #define	FM_FMRI_HC_SPECIFIC_OFFSET	"offset"
    216 
    217 /* fmd module scheme member names */
    218 #define	FM_FMRI_FMD_NAME		"mod-name"
    219 #define	FM_FMRI_FMD_VERSION		"mod-version"
    220 
    221 /* dev scheme member names */
    222 #define	FM_FMRI_DEV_ID			"devid"
    223 #define	FM_FMRI_DEV_PATH		"device-path"
    224 
    225 /* pkg scheme member names */
    226 #define	FM_FMRI_PKG_BASEDIR		"pkg-basedir"
    227 #define	FM_FMRI_PKG_INST		"pkg-inst"
    228 #define	FM_FMRI_PKG_VERSION		"pkg-version"
    229 
    230 /* svc scheme member names */
    231 #define	FM_FMRI_SVC_NAME		"service-name"
    232 #define	FM_FMRI_SVC_VERSION		"service-version"
    233 #define	FM_FMRI_SVC_INSTANCE		"instance"
    234 #define	FM_FMRI_SVC_CONTRACT_ID		"contract-id"
    235 
    236 /* svc-authority member names */
    237 #define	FM_FMRI_SVC_AUTH_SCOPE		"scope"
    238 #define	FM_FMRI_SVC_AUTH_SYSTEM_FQN	"system-FQN"
    239 
    240 /* cpu scheme member names */
    241 #define	FM_FMRI_CPU_ID			"cpuid"
    242 #define	FM_FMRI_CPU_SERIAL_ID		"serial"
    243 #define	FM_FMRI_CPU_MASK		"cpumask"
    244 #define	FM_FMRI_CPU_VID			"cpuvid"
    245 #define	FM_FMRI_CPU_CPUFRU		"cpufru"
    246 
    247 /* legacy-hc scheme member names */
    248 #define	FM_FMRI_LEGACY_HC		"component"
    249 #define	FM_FMRI_LEGACY_HC_PREFIX	FM_FMRI_SCHEME_HC":///" \
    250     FM_FMRI_LEGACY_HC"="
    251 
    252 /* mem scheme member names */
    253 #define	FM_FMRI_MEM_UNUM		"unum"
    254 #define	FM_FMRI_MEM_SERIAL_ID		"serial"
    255 #define	FM_FMRI_MEM_PHYSADDR		"physaddr"
    256 #define	FM_FMRI_MEM_MEMCONFIG		"memconfig"
    257 #define	FM_FMRI_MEM_OFFSET		"offset"
    258 
    259 /* mod scheme member names */
    260 #define	FM_FMRI_MOD_PKG			"mod-pkg"
    261 #define	FM_FMRI_MOD_NAME		"mod-name"
    262 #define	FM_FMRI_MOD_ID			"mod-id"
    263 #define	FM_FMRI_MOD_DESC		"mod-desc"
    264 
    265 /* zfs scheme member names */
    266 #define	FM_FMRI_ZFS_POOL		"pool"
    267 #define	FM_FMRI_ZFS_VDEV		"vdev"
    268 
    269 extern nv_alloc_t *fm_nva_xcreate(char *, size_t);
    270 extern void fm_nva_xdestroy(nv_alloc_t *);
    271 
    272 extern nvlist_t *fm_nvlist_create(nv_alloc_t *);
    273 extern void fm_nvlist_destroy(nvlist_t *, int);
    274 
    275 #define	FM_NVA_FREE	0		/* free allocator on nvlist_destroy */
    276 #define	FM_NVA_RETAIN	1		/* keep allocator on nvlist_destroy */
    277 
    278 extern void fm_ereport_set(nvlist_t *, int, const char *, uint64_t,
    279     const nvlist_t *, ...);
    280 extern void fm_payload_set(nvlist_t *, ...);
    281 extern int i_fm_payload_set(nvlist_t *, const char *, va_list);
    282 extern void fm_fmri_hc_set(nvlist_t *, int, const nvlist_t *, nvlist_t *,
    283     int, ...);
    284 extern void fm_fmri_dev_set(nvlist_t *, int, const nvlist_t *, const char *,
    285     const char *);
    286 extern void fm_fmri_de_set(nvlist_t *, int, const nvlist_t *, const char *);
    287 extern void fm_fmri_cpu_set(nvlist_t *, int, const nvlist_t *, uint32_t,
    288     uint8_t *, const char *);
    289 extern void fm_fmri_mem_set(nvlist_t *, int, const nvlist_t *, const char *,
    290     const char *, uint64_t);
    291 extern void fm_authority_set(nvlist_t *, int, const char *, const char *,
    292     const char *, const char *);
    293 extern void fm_fmri_zfs_set(nvlist_t *, int, uint64_t, uint64_t);
    294 
    295 extern uint64_t fm_ena_increment(uint64_t);
    296 extern uint64_t fm_ena_generate(uint64_t, uchar_t);
    297 extern uint64_t fm_ena_generate_cpu(uint64_t, processorid_t, uchar_t);
    298 extern uint64_t fm_ena_generation_get(uint64_t);
    299 extern uchar_t fm_ena_format_get(uint64_t);
    300 extern uint64_t fm_ena_id_get(uint64_t);
    301 extern uint64_t fm_ena_time_get(uint64_t);
    302 
    303 #ifdef	__cplusplus
    304 }
    305 #endif
    306 
    307 #endif /* _SYS_FM_PROTOCOL_H */
    308