xref: /illumos-gate/usr/src/uts/common/sys/fm/util.h (revision c7a0678d)
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 2017 RackTop Systems.
25  */
26 
27 #ifndef	_SYS_FM_UTIL_H
28 #define	_SYS_FM_UTIL_H
29 
30 #ifdef	__cplusplus
31 extern "C" {
32 #endif
33 
34 #include <sys/nvpair.h>
35 #include <sys/errorq.h>
36 
37 /*
38  * Shared user/kernel definitions for class length, error channel name,
39  * and kernel event publisher string.
40  */
41 #define	FM_MAX_CLASS 100
42 #define	FM_ERROR_CHAN	"com.sun:fm:error"
43 #define	FM_PUB		"fm"
44 
45 /*
46  * ereport dump device transport support
47  *
48  * Ereports are written out to the dump device at a proscribed offset from the
49  * end, similar to in-transit log messages.  The ereports are represented as a
50  * erpt_dump_t header followed by ed_size bytes of packed native nvlist data.
51  *
52  * NOTE: All of these constants and the header must be defined so they have the
53  * same representation for *both* 32-bit and 64-bit producers and consumers.
54  */
55 #define	ERPT_MAGIC	0xf00d4eddU
56 #define	ERPT_MAX_ERRS	16
57 #define	ERPT_DATA_SZ	(6 * 1024)
58 #define	ERPT_EVCH_MAX	256
59 #define	ERPT_HIWAT	64
60 
61 typedef struct erpt_dump {
62 	uint32_t ed_magic;	/* ERPT_MAGIC or zero to indicate end */
63 	uint32_t ed_chksum;	/* checksum32() of packed nvlist data */
64 	uint32_t ed_size;	/* ereport (nvl) fixed buf size */
65 	uint32_t ed_pad;	/* reserved for future use */
66 	hrtime_t ed_hrt_nsec;	/* hrtime of this ereport */
67 	hrtime_t ed_hrt_base;	/* hrtime sample corresponding to ed_tod_base */
68 	struct {
69 		uint64_t sec;	/* seconds since gettimeofday() Epoch */
70 		uint64_t nsec;	/* nanoseconds past ed_tod_base.sec */
71 	} ed_tod_base;
72 } erpt_dump_t;
73 
74 #if defined(_KERNEL) || defined(_FAKE_KERNEL)
75 #include <sys/systm.h>
76 
77 #define	FM_STK_DEPTH	20	/* maximum stack depth */
78 #define	FM_SYM_SZ	64	/* maximum symbol size */
79 #define	FM_ERR_PIL	2	/* PIL for ereport_errorq drain processing */
80 
81 #define	FM_EREPORT_PAYLOAD_NAME_STACK		"stack"
82 
83 extern errorq_t *ereport_errorq;
84 extern void *ereport_dumpbuf;
85 extern size_t ereport_dumplen;
86 
87 extern void fm_init(void);
88 extern void fm_nvprint(nvlist_t *);
89 extern void fm_panic(const char *, ...);
90 extern void fm_banner(void);
91 
92 extern void fm_ereport_dump(void);
93 extern void fm_ereport_post(nvlist_t *, int);
94 
95 extern void fm_payload_stack_add(nvlist_t *, const pc_t *, int);
96 
97 extern int is_fm_panic();
98 #endif  /* _KERNEL || _FAKE_KERNEL */
99 
100 #ifdef	__cplusplus
101 }
102 #endif
103 
104 #endif /* _SYS_FM_UTIL_H */
105