2 * Copyright (c) 2005 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * Generic Kernel trace buffer support.
42 #include <sys/types.h>
43 #include <sys/sysctl.h>
44 #include <sys/cpputil.h>
51 * Conveniently auto-enable KTRs when particular KTRs are specified
52 * in kernel options. This way we can get logging during boot.
53 * However, if KTR_ALL is optioned, just disable everything by default.
54 * The user can enable individual masks via sysctl.
57 #define KTR_AUTO_ENABLE 0
60 #define KTR_AUTO_ENABLE -1
63 #define KTR_BUFSIZE 192
66 #define KTR_VERSION_WITH_FREQ 3
67 #define KTR_VERSION_KTR_CPU 4
72 const char *kf_name; /* human-interpreted subsystem name */
73 int32_t *kf_master_enable; /* the master enable variable */
74 const char * const kf_format; /* data format */
75 int kf_data_size; /* relevance of the data buffer */
79 u_int64_t ktr_timestamp;
80 struct ktr_info *ktr_info;
86 int32_t ktr_data[KTR_BUFSIZE / sizeof(int32_t)];
90 struct ktr_entry *ktr_buf;
95 struct ktr_cpu_core core;
100 struct ktr_entry * ktr_begin_write_entry(struct ktr_info *,
102 int ktr_finish_write_entry(struct ktr_info *, struct ktr_entry *);
103 void cpu_ktr_caller(struct ktr_entry *ktr);
108 * Take advantage of constant integer optimizations by the compiler
109 * to optimize-out disabled code at compile-time. If KTR_ENABLE_<name>
110 * is 0, the compiler avoids generating all related code when KTR is enabled.
115 SYSCTL_DECL(_debug_ktr);
117 #define KTR_INFO_MASTER(master) \
118 SYSCTL_NODE(_debug_ktr, OID_AUTO, master, CTLFLAG_RW, 0, ""); \
119 int ktr_ ## master ## _enable = KTR_AUTO_ENABLE; \
120 SYSCTL_INT(_debug_ktr, OID_AUTO, master ## _enable, CTLFLAG_RW, \
121 &ktr_ ## master ## _enable, 0, \
122 "Bit mask to control " __XSTRING(master) "'s event logging")
124 #define KTR_INFO_MASTER_EXTERN(master) \
125 SYSCTL_DECL(_debug_ktr_ ## master); \
126 extern int ktr_ ## master ## _enable \
129 * This creates a read-only sysctl so the user knows what the mask
130 * definitions are and a number of static const int's which are used
131 * by the compiler to optimize the trace logging at compile-time and
133 * You're supposed to specify any arguments to the format as you would in
134 * a function prototype.
135 * We automagically create a struct for the arguments and a throwaway
136 * function that will be called with the format and the actual arguments
137 * at the KTR_LOG site. This makes sure that the compiler will typecheck
138 * the arguments against the format string. On gcc, this requires -Wformat
139 * (which is included in -Wall) and -O1 at least. Note that using
140 * ktr_info.kf_format will not work, hence we need to define another
141 * throwaway const wariable for the format.
143 #define KTR_INFO(compile, master, name, maskbit, format, ...) \
144 static const int ktr_ ## master ## _ ## name ## _mask = \
146 static const int ktr_ ## master ## _ ##name ## _enable = \
148 static int ktr_ ## master ## _ ## name ## _mask_ro = \
150 SYSCTL_INT(_debug_ktr_ ## master, OID_AUTO, name ## _mask, \
151 CTLFLAG_RD, &ktr_ ## master ## _ ## name ## _mask_ro, \
152 0, "Value of the " __XSTRING(name) " event in " __XSTRING(master) "'s mask"); \
153 __GENSTRUCT(ktr_info_ ## master ## _ ## name ## _args, __VA_ARGS__) \
155 CTASSERT(sizeof(struct ktr_info_ ## master ## _ ## name ## _args) <= KTR_BUFSIZE); \
157 __ktr_info_ ## master ## _ ## name ## _fmtcheck(const char *fmt, \
158 ...) __printf0like(1, 2); \
160 __ktr_info_ ## master ## _ ## name ## _fmtcheck(const char *fmt __unused, \
163 static const char * const __ktr_ ## master ## _ ## name ## _fmt = format; \
164 static struct ktr_info ktr_info_ ## master ## _ ## name = { \
165 .kf_name = #master "_" #name, \
166 .kf_master_enable = &ktr_ ## master ## _enable, \
167 .kf_format = format, \
168 .kf_data_size = sizeof(struct ktr_info_ ## master ## _ ## name ## _args), \
175 * Call ktr_begin_write_entry() that sets up the entry for us; use
176 * a struct copy to give as max flexibility as possible to the compiler.
177 * In higher optimization levels, it will copy the arguments directly from
178 * registers to the destination buffer. Call our dummy function that will
179 * typecheck the arguments against the format string.
181 #define KTR_LOG(name, ...) \
183 __ktr_info_ ## name ## _fmtcheck (__ktr_ ## name ## _fmt, ##__VA_ARGS__); \
184 if (ktr_ ## name ## _enable && \
185 (ktr_ ## name ## _mask & *ktr_info_ ## name .kf_master_enable)) { \
186 struct ktr_entry *entry; \
187 entry = ktr_begin_write_entry(&ktr_info_ ## name, __FILE__, __LINE__); \
190 *(struct ktr_info_ ## name ## _args *)&entry->ktr_data[0] = \
191 (struct ktr_info_ ## name ## _args){ __VA_ARGS__}; \
192 if (ktr_finish_write_entry(&ktr_info_ ## name, entry)) { \
193 kprintf(ktr_info_ ## name .kf_format, ##__VA_ARGS__); \
199 #define KTR_COND_LOG(name, cond, ...) \
201 __ktr_info_ ## name ## _fmtcheck (__ktr_ ## name ## _fmt, ##__VA_ARGS__); \
203 ktr_ ## name ## _enable && \
204 (ktr_ ## name ## _mask & *ktr_info_ ## name .kf_master_enable)) { \
205 struct ktr_entry *entry; \
206 entry = ktr_begin_write_entry(&ktr_info_ ## name, __FILE__, __LINE__); \
209 *(struct ktr_info_ ## name ## _args *)&entry->ktr_data[0] = \
210 (struct ktr_info_ ## name ## _args){ __VA_ARGS__}; \
211 if (ktr_finish_write_entry(&ktr_info_ ## name, entry)) { \
212 kprintf(ktr_info_ ## name .kf_format, ##__VA_ARGS__); \
220 #define KTR_INFO_MASTER(master) \
221 static const int ktr_ ## master ## _enable = 0
223 #define KTR_INFO_MASTER_EXTERN(master) \
224 static const int ktr_ ## master ## _enable
226 #define KTR_INFO(compile, master, name, maskbit, format, ...) \
227 static const int ktr_ ## master ## _ ## name ## _mask = \
230 #define KTR_LOG(info, args...)
232 #define KTR_COND_LOG(info, args...)
237 #endif /* !_SYS_KTR_H_ */