1 // SPDX-License-Identifier: CDDL-1.0
2 /*
3 * CDDL HEADER START
4 *
5 * The contents of this file are subject to the terms of the
6 * Common Development and Distribution License (the "License").
7 * You may not use this file except in compliance with the License.
8 *
9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 * or https://opensource.org/licenses/CDDL-1.0.
11 * See the License for the specific language governing permissions
12 * and limitations under the License.
13 *
14 * When distributing Covered Code, include this CDDL HEADER in each
15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 * If applicable, add the following below this CDDL HEADER, with the
17 * fields enclosed by brackets "[]" replaced with your own identifying
18 * information: Portions Copyright [yyyy] [name of copyright owner]
19 *
20 * CDDL HEADER END
21 */
22
23 /*
24 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
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/zfs_file.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 #ifdef _KERNEL
75
76 #define ZEVENT_SHUTDOWN 0x1
77
78 typedef void zevent_cb_t(nvlist_t *, nvlist_t *);
79
80 typedef struct zevent_s {
81 nvlist_t *ev_nvl; /* protected by the zevent_lock */
82 nvlist_t *ev_detector; /* " */
83 list_t ev_ze_list; /* " */
84 list_node_t ev_node; /* " */
85 zevent_cb_t *ev_cb; /* " */
86 uint64_t ev_eid;
87 } zevent_t;
88
89 typedef struct zfs_zevent {
90 zevent_t *ze_zevent; /* protected by the zevent_lock */
91 list_node_t ze_node; /* " */
92 uint64_t ze_dropped; /* " */
93 } zfs_zevent_t;
94
95 extern void fm_init(void);
96 extern void fm_fini(void);
97 extern void zfs_zevent_post_cb(nvlist_t *nvl, nvlist_t *detector);
98 extern int zfs_zevent_post(nvlist_t *, nvlist_t *, zevent_cb_t *);
99 extern void zfs_zevent_drain_all(uint_t *);
100 extern zfs_file_t *zfs_zevent_fd_hold(int, minor_t *, zfs_zevent_t **);
101 extern void zfs_zevent_fd_rele(zfs_file_t *);
102 extern int zfs_zevent_next(zfs_zevent_t *, nvlist_t **, uint64_t *, uint64_t *);
103 extern int zfs_zevent_wait(zfs_zevent_t *);
104 extern int zfs_zevent_seek(zfs_zevent_t *, uint64_t);
105 extern void zfs_zevent_init(zfs_zevent_t **);
106 extern void zfs_zevent_destroy(zfs_zevent_t *);
107
108 extern void zfs_zevent_track_duplicate(void);
109 extern void zfs_ereport_init(void);
110 extern void zfs_ereport_fini(void);
111 #else
112
fm_init(void)113 static inline void fm_init(void) { }
fm_fini(void)114 static inline void fm_fini(void) { }
115
116 #endif /* _KERNEL */
117
118 #ifdef __cplusplus
119 }
120 #endif
121
122 #endif /* _SYS_FM_UTIL_H */
123