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.
43 #include <sys/types.h>
45 #ifndef _SYS_SYSCTL_H_
46 #include <sys/sysctl.h>
54 * Conveniently auto-enable KTRs when particular KTRs are specified
55 * in kernel options. This way we can get logging during boot.
56 * However, if KTR_ALL is optioned, just disable everything by default.
57 * The user can enable individual masks via sysctl.
60 #define KTR_AUTO_ENABLE 0
63 #define KTR_AUTO_ENABLE -1
66 #define KTR_BUFSIZE 192
69 #define KTR_VERSION_WITH_FREQ 3
70 #define KTR_VERSION_KTR_CPU 4
75 const char *kf_name; /* human-interpreted subsystem name */
76 int32_t *kf_master_enable; /* the master enable variable */
77 const char *kf_format; /* data format */
78 int kf_data_size; /* relevance of the data buffer */
82 u_int64_t ktr_timestamp;
83 struct ktr_info *ktr_info;
89 int32_t ktr_data[KTR_BUFSIZE / sizeof(int32_t)];
93 struct ktr_entry *ktr_buf;
98 struct ktr_cpu_core core;
99 char pad[__VM_CACHELINE_ALIGN(sizeof(struct ktr_cpu_core))];
104 void ktr_log(struct ktr_info *info, const char *file, int line, ...);
105 void cpu_ktr_caller(struct ktr_entry *ktr);
110 * Take advantage of constant integer optimizations by the compiler
111 * to optimize-out disabled code at compile-time. If KTR_ENABLE_<name>
112 * is 0, the compiler avoids generating all related code when KTR is enabled.
117 SYSCTL_DECL(_debug_ktr);
119 #define KTR_INFO_MASTER(master) \
120 SYSCTL_NODE(_debug_ktr, OID_AUTO, master, CTLFLAG_RW, 0, ""); \
121 int ktr_ ## master ## _enable = KTR_AUTO_ENABLE; \
122 SYSCTL_INT(_debug_ktr, OID_AUTO, master ## _enable, CTLFLAG_RW, \
123 &ktr_ ## master ## _enable, 0, \
124 "Bit mask to control " __XSTRING(master) "'s event logging")
126 #define KTR_INFO_MASTER_EXTERN(master) \
127 SYSCTL_DECL(_debug_ktr_ ## master); \
128 extern int ktr_ ## master ## _enable \
131 * This creates a read-only sysctl so the user knows what the mask
132 * definitions are and a number of static const int's which are used
133 * by the compiler to optimize the trace logging at compile-time and
136 #define KTR_INFO(compile, master, name, maskbit, format, datasize) \
137 static const int ktr_ ## master ## _ ## name ## _mask = \
139 static const int ktr_ ## master ## _ ## name ## _enable = \
141 static int ktr_ ## master ## _ ## name ## _mask_ro = \
143 SYSCTL_INT(_debug_ktr_ ## master, OID_AUTO, name ## _mask, \
144 CTLFLAG_RD, &ktr_ ## master ## _ ## name ## _mask_ro, \
145 0, "Value of the " __XSTRING(name) " event in " __XSTRING(master) "'s mask"); \
146 static struct ktr_info ktr_info_ ## master ## _ ## name = { \
148 &ktr_ ## master ## _enable, \
152 #define KTR_LOG(name, args...) \
153 if (ktr_ ## name ## _enable && \
154 (ktr_ ## name ## _mask & *ktr_info_ ## name .kf_master_enable)) \
155 ktr_log(&ktr_info_ ## name, __FILE__, __LINE__, ##args)
159 #define KTR_INFO_MASTER(master) \
160 const static int ktr_ ## master ## _enable = 0
162 #define KTR_INFO_MASTER_EXTERN(master) \
163 const static int ktr_ ## master ## _enable
165 #define KTR_INFO(compile, master, name, maskbit, format, datasize) \
166 static const int ktr_ ## master ## _ ## name ## _mask = \
169 #define KTR_LOG(info, args...)
174 #endif /* !_SYS_KTR_H_ */