Modify ktr(4) to be typesafe
[dragonfly.git] / sys / sys / ktr.h
CommitLineData
d3776285
MD
1/*
2 * Copyright (c) 2005 The DragonFly Project. All rights reserved.
3 *
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
6 *
81540c2d
EN
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
d3776285 10 *
81540c2d
EN
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
d3776285
MD
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
16 * distribution.
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.
20 *
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
81540c2d 32 * SUCH DAMAGE.
81540c2d 33 */
81540c2d 34/*
d3776285
MD
35 * Generic Kernel trace buffer support.
36 *
81540c2d
EN
37 */
38
39#ifndef _SYS_KTR_H_
40#define _SYS_KTR_H_
41
1bd40720 42#include <sys/types.h>
75f59a66 43#include <sys/sysctl.h>
5bf48697 44#include <sys/cpputil.h>
1bd40720 45
282a0149 46#ifdef _KERNEL
81540c2d 47#include "opt_ktr.h"
282a0149 48#endif
81540c2d 49
ade21b34
MD
50/*
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.
55 */
56#if defined(KTR_ALL)
ddca1582 57#define KTR_AUTO_ENABLE 0
ade21b34 58#else
ddca1582
MD
59#define KTR_ALL 0
60#define KTR_AUTO_ENABLE -1
81540c2d
EN
61#endif
62
ddca1582
MD
63#define KTR_BUFSIZE 192
64#define KTR_VERSION 4
65
66#define KTR_VERSION_WITH_FREQ 3
67#define KTR_VERSION_KTR_CPU 4
81540c2d
EN
68
69#ifndef LOCORE
70
d3776285
MD
71struct ktr_info {
72 const char *kf_name; /* human-interpreted subsystem name */
73 int32_t *kf_master_enable; /* the master enable variable */
5bf48697 74 const char * const kf_format; /* data format */
d3776285
MD
75 int kf_data_size; /* relevance of the data buffer */
76};
77
81540c2d
EN
78struct ktr_entry {
79 u_int64_t ktr_timestamp;
d3776285 80 struct ktr_info *ktr_info;
81540c2d 81 const char *ktr_file;
d3776285
MD
82 void *ktr_caller1;
83 void *ktr_caller2;
84 int32_t ktr_line;
85 int32_t ktr_unused;
af6ff89e 86 int32_t ktr_data[KTR_BUFSIZE / sizeof(int32_t)];
81540c2d
EN
87};
88
ddca1582
MD
89struct ktr_cpu_core {
90 struct ktr_entry *ktr_buf;
91 int ktr_idx;
92};
93
94struct ktr_cpu {
95 struct ktr_cpu_core core;
96 char pad[__VM_CACHELINE_ALIGN(sizeof(struct ktr_cpu_core))];
97};
98
99#ifdef _KERNEL
100
5bf48697
AE
101struct ktr_entry * ktr_begin_write_entry(struct ktr_info *,
102 const char *, int);
103int ktr_finish_write_entry(struct ktr_info *, struct ktr_entry *);
af6ff89e 104void cpu_ktr_caller(struct ktr_entry *ktr);
81540c2d 105
ddca1582
MD
106#endif
107
d3776285
MD
108/*
109 * Take advantage of constant integer optimizations by the compiler
110 * to optimize-out disabled code at compile-time. If KTR_ENABLE_<name>
111 * is 0, the compiler avoids generating all related code when KTR is enabled.
112 */
81540c2d
EN
113
114#ifdef KTR
115
d3776285
MD
116SYSCTL_DECL(_debug_ktr);
117
118#define KTR_INFO_MASTER(master) \
119 SYSCTL_NODE(_debug_ktr, OID_AUTO, master, CTLFLAG_RW, 0, ""); \
ade21b34 120 int ktr_ ## master ## _enable = KTR_AUTO_ENABLE; \
d3776285 121 SYSCTL_INT(_debug_ktr, OID_AUTO, master ## _enable, CTLFLAG_RW, \
f22af1e9
SW
122 &ktr_ ## master ## _enable, 0, \
123 "Bit mask to control " __XSTRING(master) "'s event logging")
d3776285
MD
124
125#define KTR_INFO_MASTER_EXTERN(master) \
126 SYSCTL_DECL(_debug_ktr_ ## master); \
127 extern int ktr_ ## master ## _enable \
81540c2d
EN
128
129/*
d3776285
MD
130 * This creates a read-only sysctl so the user knows what the mask
131 * definitions are and a number of static const int's which are used
132 * by the compiler to optimize the trace logging at compile-time and
133 * run-time.
5bf48697
AE
134 * You're supposed to specify any arguments to the format as you would in
135 * a function prototype.
136 * We automagically create a struct for the arguments and a throwaway
137 * function that will be called with the format and the actual arguments
138 * at the KTR_LOG site. This makes sure that the compiler will typecheck
139 * the arguments against the format string. On gcc, this requires -Wformat
140 * (which is included in -Wall) and -O1 at least. Note that using
141 * ktr_info.kf_format will not work, hence we need to define another
142 * throwaway const wariable for the format.
81540c2d 143 */
5bf48697
AE
144#define KTR_INFO(compile, master, name, maskbit, format, ...) \
145 static const int ktr_ ## master ## _ ## name ## _mask = \
146 1 << (maskbit); \
147 static const int ktr_ ## master ## _ ##name ## _enable = \
d3776285 148 compile; \
5bf48697
AE
149 static int ktr_ ## master ## _ ## name ## _mask_ro = \
150 1 << (maskbit); \
151 SYSCTL_INT(_debug_ktr_ ## master, OID_AUTO, name ## _mask, \
152 CTLFLAG_RD, &ktr_ ## master ## _ ## name ## _mask_ro, \
153 0, "Value of the " __XSTRING(name) " event in " __XSTRING(master) "'s mask"); \
154 __GENSTRUCT(ktr_info_ ## master ## _ ## name ## _args, __VA_ARGS__) \
155 __packed; \
156 CTASSERT(sizeof(struct ktr_info_ ## master ## _ ## name ## _args) <= KTR_BUFSIZE); \
157 static inline void \
158 __ktr_info_ ## master ## _ ## name ## _fmtcheck(const char *fmt, \
159 ...) __printf0like(1, 2); \
160 static inline void \
161 __ktr_info_ ## master ## _ ## name ## _fmtcheck(const char *fmt __unused, \
162 ...) \
163 {} \
164 static const char * const __ktr_ ## master ## _ ## name ## _fmt = format; \
165 static struct ktr_info ktr_info_ ## master ## _ ## name = { \
166 .kf_name = #master "_" #name, \
167 .kf_master_enable = &ktr_ ## master ## _enable, \
168 .kf_format = format, \
169 .kf_data_size = sizeof(struct ktr_info_ ## master ## _ ## name ## _args), \
170 }
171
172
173
174
175/*
176 * Call ktr_begin_write_entry() that sets up the entry for us; use
177 * a struct copy to give as max flexibility as possible to the compiler.
178 * In higher optimization levels, it will copy the arguments directly from
179 * registers to the destination buffer. Call our dummy function that will
180 * typecheck the arguments against the format string.
181 */
182#define KTR_LOG(name, ...) \
183 do { \
184 __ktr_info_ ## name ## _fmtcheck (__ktr_ ## name ## _fmt, ##__VA_ARGS__); \
185 if (ktr_ ## name ## _enable && \
186 (ktr_ ## name ## _mask & *ktr_info_ ## name .kf_master_enable)) { \
187 struct ktr_entry *entry; \
188 entry = ktr_begin_write_entry(&ktr_info_ ## name, __FILE__, __LINE__); \
189 if (!entry) \
190 break; \
191 *(struct ktr_info_ ## name ## _args *)&entry->ktr_data[0] = \
192 (struct ktr_info_ ## name ## _args){ __VA_ARGS__}; \
193 if (ktr_finish_write_entry(&ktr_info_ ## name, entry)) { \
194 kprintf(ktr_info_ ## name .kf_format, ##__VA_ARGS__); \
195 kprintf("\n"); \
196 } \
197 } \
198 } while(0)
d3776285 199
81540c2d 200#else
d3776285
MD
201
202#define KTR_INFO_MASTER(master) \
3a052084 203 static const int ktr_ ## master ## _enable = 0
d3776285
MD
204
205#define KTR_INFO_MASTER_EXTERN(master) \
3a052084 206 static const int ktr_ ## master ## _enable
d3776285 207
5bf48697 208#define KTR_INFO(compile, master, name, maskbit, format, ...) \
d3776285 209 static const int ktr_ ## master ## _ ## name ## _mask = \
5bf48697 210 (1 << maskbit)
d3776285
MD
211
212#define KTR_LOG(info, args...)
d3776285 213
81540c2d
EN
214#endif
215
d3776285 216#endif /* !LOCORE */
81540c2d 217#endif /* !_SYS_KTR_H_ */