xref: /freebsd/sys/contrib/openzfs/include/sys/fm/util.h (revision 16038816)
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  */
25 
26 #ifndef	_SYS_FM_UTIL_H
27 #define	_SYS_FM_UTIL_H
28 
29 #ifdef	__cplusplus
30 extern "C" {
31 #endif
32 
33 #include <sys/nvpair.h>
34 
35 /*
36  * Shared user/kernel definitions for class length, error channel name,
37  * and kernel event publisher string.
38  */
39 #define	FM_MAX_CLASS 100
40 #define	FM_ERROR_CHAN	"com.sun:fm:error"
41 #define	FM_PUB		"fm"
42 
43 /*
44  * ereport dump device transport support
45  *
46  * Ereports are written out to the dump device at a proscribed offset from the
47  * end, similar to in-transit log messages.  The ereports are represented as a
48  * erpt_dump_t header followed by ed_size bytes of packed native nvlist data.
49  *
50  * NOTE: All of these constants and the header must be defined so they have the
51  * same representation for *both* 32-bit and 64-bit producers and consumers.
52  */
53 #define	ERPT_MAGIC	0xf00d4eddU
54 #define	ERPT_MAX_ERRS	16
55 #define	ERPT_DATA_SZ	(6 * 1024)
56 #define	ERPT_EVCH_MAX	256
57 #define	ERPT_HIWAT	64
58 
59 typedef struct erpt_dump {
60 	uint32_t ed_magic;	/* ERPT_MAGIC or zero to indicate end */
61 	uint32_t ed_chksum;	/* checksum32() of packed nvlist data */
62 	uint32_t ed_size;	/* ereport (nvl) fixed buf size */
63 	uint32_t ed_pad;	/* reserved for future use */
64 	hrtime_t ed_hrt_nsec;	/* hrtime of this ereport */
65 	hrtime_t ed_hrt_base;	/* hrtime sample corresponding to ed_tod_base */
66 	struct {
67 		uint64_t sec;	/* seconds since gettimeofday() Epoch */
68 		uint64_t nsec;	/* nanoseconds past ed_tod_base.sec */
69 	} ed_tod_base;
70 } erpt_dump_t;
71 
72 #ifdef _KERNEL
73 
74 #define	ZEVENT_SHUTDOWN		0x1
75 
76 typedef void zevent_cb_t(nvlist_t *, nvlist_t *);
77 
78 typedef struct zevent_s {
79 	nvlist_t	*ev_nvl;	/* protected by the zevent_lock */
80 	nvlist_t	*ev_detector;	/* " */
81 	list_t		ev_ze_list;	/* " */
82 	list_node_t	ev_node;	/* " */
83 	zevent_cb_t	*ev_cb;		/* " */
84 	uint64_t	ev_eid;
85 } zevent_t;
86 
87 typedef struct zfs_zevent {
88 	zevent_t	*ze_zevent;	/* protected by the zevent_lock */
89 	list_node_t	ze_node;	/* " */
90 	uint64_t	ze_dropped;	/* " */
91 } zfs_zevent_t;
92 
93 extern void fm_init(void);
94 extern void fm_fini(void);
95 extern void zfs_zevent_post_cb(nvlist_t *nvl, nvlist_t *detector);
96 extern int zfs_zevent_post(nvlist_t *, nvlist_t *, zevent_cb_t *);
97 extern void zfs_zevent_drain_all(int *);
98 extern int zfs_zevent_fd_hold(int, minor_t *, zfs_zevent_t **);
99 extern void zfs_zevent_fd_rele(int);
100 extern int zfs_zevent_next(zfs_zevent_t *, nvlist_t **, uint64_t *, uint64_t *);
101 extern int zfs_zevent_wait(zfs_zevent_t *);
102 extern int zfs_zevent_seek(zfs_zevent_t *, uint64_t);
103 extern void zfs_zevent_init(zfs_zevent_t **);
104 extern void zfs_zevent_destroy(zfs_zevent_t *);
105 
106 extern void zfs_zevent_track_duplicate(void);
107 extern void zfs_ereport_init(void);
108 extern void zfs_ereport_fini(void);
109 #else
110 
111 static inline void fm_init(void) { }
112 static inline void fm_fini(void) { }
113 
114 #endif  /* _KERNEL */
115 
116 #ifdef	__cplusplus
117 }
118 #endif
119 
120 #endif /* _SYS_FM_UTIL_H */
121