2 * Copyright (c) 1996 Berkeley Software Design, Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. Berkeley Software Design Inc's name may not be used to endorse or
13 * promote products derived from this software without specific prior
16 * THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN INC ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL BERKELEY SOFTWARE DESIGN INC BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * from BSDI $Id: ktr.h,v 1.10.2.7 2000/03/16 21:44:42 cp Exp $
33 * Wraparound kernel trace buffer support.
42 * Two of the trace classes (KTR_DEV and KTR_SUBSYS) are special in that
43 * they are really placeholders so that indvidual drivers and subsystems
44 * can map their internal tracing to the general class when they wish to
45 * have tracing enabled and map it to 0 when they don't.
47 #define KTR_GEN 0x00000001 /* General (TR) */
48 #define KTR_NET 0x00000002 /* Network */
49 #define KTR_DEV 0x00000004 /* Device driver */
50 #define KTR_LOCK 0x00000008 /* MP locking */
51 #define KTR_SMP 0x00000010 /* MP general */
52 #define KTR_SUBSYS 0x00000020 /* Subsystem. */
53 #define KTR_PMAP 0x00000040 /* Pmap tracing */
54 #define KTR_MALLOC 0x00000080 /* Malloc tracing */
55 #define KTR_TRAP 0x00000100 /* Trap processing */
56 #define KTR_INTR 0x00000200 /* Interrupt tracing */
57 #define KTR_SIG 0x00000400 /* Signal processing */
58 #define KTR_SPARE2 0x00000800 /* XXX Used by cxgb */
59 #define KTR_PROC 0x00001000 /* Process scheduling */
60 #define KTR_SYSC 0x00002000 /* System call */
61 #define KTR_INIT 0x00004000 /* System initialization */
62 #define KTR_SPARE3 0x00008000 /* XXX Used by cxgb */
63 #define KTR_SPARE4 0x00010000 /* XXX Used by cxgb */
64 #define KTR_EVH 0x00020000 /* Eventhandler */
65 #define KTR_VFS 0x00040000 /* VFS events */
66 #define KTR_VOP 0x00080000 /* Auto-generated vop events */
67 #define KTR_VM 0x00100000 /* The virtual memory system */
68 #define KTR_INET 0x00200000 /* IPv4 stack */
69 #define KTR_RUNQ 0x00400000 /* Run queue */
70 #define KTR_CONTENTION 0x00800000 /* Lock contention */
71 #define KTR_UMA 0x01000000 /* UMA slab allocator */
72 #define KTR_CALLOUT 0x02000000 /* Callouts and timeouts */
73 #define KTR_GEOM 0x04000000 /* GEOM I/O events */
74 #define KTR_BUSDMA 0x08000000 /* busdma(9) events */
75 #define KTR_INET6 0x10000000 /* IPv6 stack */
76 #define KTR_SCHED 0x20000000 /* Machine parsed sched info. */
77 #define KTR_BUF 0x40000000 /* Buffer cache */
78 #define KTR_ALL 0x7fffffff
80 /* Trace classes to compile in */
83 #define KTR_COMPILE (KTR_ALL)
91 * Version number for ktr_entry struct. Increment this when you break binary
100 #include <sys/param.h>
101 #include <sys/_cpuset.h>
104 u_int64_t ktr_timestamp;
107 const char *ktr_file;
108 const char *ktr_desc;
109 struct thread *ktr_thread;
110 u_long ktr_parms[KTR_PARMS];
113 extern cpuset_t ktr_cpumask;
115 extern int ktr_entries;
116 extern int ktr_verbose;
118 extern volatile int ktr_idx;
119 extern struct ktr_entry *ktr_buf;
123 void ktr_tracepoint(u_int mask, const char *file, int line,
124 const char *format, u_long arg1, u_long arg2, u_long arg3,
125 u_long arg4, u_long arg5, u_long arg6);
127 #define CTR6(m, format, p1, p2, p3, p4, p5, p6) do { \
128 if (KTR_COMPILE & (m)) \
129 ktr_tracepoint((m), __FILE__, __LINE__, format, \
130 (u_long)(p1), (u_long)(p2), (u_long)(p3), \
131 (u_long)(p4), (u_long)(p5), (u_long)(p6)); \
133 #define CTR0(m, format) CTR6(m, format, 0, 0, 0, 0, 0, 0)
134 #define CTR1(m, format, p1) CTR6(m, format, p1, 0, 0, 0, 0, 0)
135 #define CTR2(m, format, p1, p2) CTR6(m, format, p1, p2, 0, 0, 0, 0)
136 #define CTR3(m, format, p1, p2, p3) CTR6(m, format, p1, p2, p3, 0, 0, 0)
137 #define CTR4(m, format, p1, p2, p3, p4) CTR6(m, format, p1, p2, p3, p4, 0, 0)
138 #define CTR5(m, format, p1, p2, p3, p4, p5) CTR6(m, format, p1, p2, p3, p4, p5, 0)
140 #define CTR0(m, d) (void)0
141 #define CTR1(m, d, p1) (void)0
142 #define CTR2(m, d, p1, p2) (void)0
143 #define CTR3(m, d, p1, p2, p3) (void)0
144 #define CTR4(m, d, p1, p2, p3, p4) (void)0
145 #define CTR5(m, d, p1, p2, p3, p4, p5) (void)0
146 #define CTR6(m, d, p1, p2, p3, p4, p5, p6) (void)0
149 #define TR0(d) CTR0(KTR_GEN, d)
150 #define TR1(d, p1) CTR1(KTR_GEN, d, p1)
151 #define TR2(d, p1, p2) CTR2(KTR_GEN, d, p1, p2)
152 #define TR3(d, p1, p2, p3) CTR3(KTR_GEN, d, p1, p2, p3)
153 #define TR4(d, p1, p2, p3, p4) CTR4(KTR_GEN, d, p1, p2, p3, p4)
154 #define TR5(d, p1, p2, p3, p4, p5) CTR5(KTR_GEN, d, p1, p2, p3, p4, p5)
155 #define TR6(d, p1, p2, p3, p4, p5, p6) CTR6(KTR_GEN, d, p1, p2, p3, p4, p5, p6)
158 * The event macros implement KTR graphic plotting facilities provided
159 * by src/tools/sched/schedgraph.py. Three generic types of events are
160 * supported: states, counters, and points.
162 * m is the ktr class for ktr_mask.
163 * ident is the string identifier that owns the event (ie: "thread 10001")
164 * etype is the type of event to plot (state, counter, point)
165 * edat is the event specific data (state name, counter value, point name)
166 * up to four attributes may be supplied as a name, value pair of arguments.
168 * etype and attribute names must be string constants. This minimizes the
169 * number of ktr slots required by construction the final format strings
170 * at compile time. Both must also include a colon and format specifier
171 * (ie. "prio:%d", prio). It is recommended that string arguments be
172 * contained within escaped quotes if they may contain ',' or ':' characters.
174 * The special attribute (KTR_ATTR_LINKED, ident) creates a reference to another
175 * id on the graph for easy traversal of related graph elements.
178 #define KTR_ATTR_LINKED "linkedto:\"%s\""
179 #define KTR_EFMT(egroup, ident, etype) \
180 "KTRGRAPH group:\"" egroup "\", id:\"%s\", " etype ", attributes: "
182 #define KTR_EVENT0(m, egroup, ident, etype, edat) \
183 CTR2(m, KTR_EFMT(egroup, ident, etype) "none", ident, edat)
184 #define KTR_EVENT1(m, egroup, ident, etype, edat, a0, v0) \
185 CTR3(m, KTR_EFMT(egroup, ident, etype) a0, ident, edat, (v0))
186 #define KTR_EVENT2(m, egroup, ident, etype, edat, a0, v0, a1, v1) \
187 CTR4(m, KTR_EFMT(egroup, ident, etype) a0 ", " a1, \
188 ident, edat, (v0), (v1))
189 #define KTR_EVENT3(m, egroup, ident, etype, edat, a0, v0, a1, v1, a2, v2)\
190 CTR5(m,KTR_EFMT(egroup, ident, etype) a0 ", " a1 ", " a2, \
191 ident, edat, (v0), (v1), (v2))
192 #define KTR_EVENT4(m, egroup, ident, etype, edat, \
193 a0, v0, a1, v1, a2, v2, a3, v3) \
194 CTR6(m,KTR_EFMT(egroup, ident, etype) a0 ", " a1 ", " a2 ", " a3,\
195 ident, edat, (v0), (v1), (v2), (v3))
198 * State functions graph state changes on an ident.
200 #define KTR_STATE0(m, egroup, ident, state) \
201 KTR_EVENT0(m, egroup, ident, "state:\"%s\"", state)
202 #define KTR_STATE1(m, egroup, ident, state, a0, v0) \
203 KTR_EVENT1(m, egroup, ident, "state:\"%s\"", state, a0, (v0))
204 #define KTR_STATE2(m, egroup, ident, state, a0, v0, a1, v1) \
205 KTR_EVENT2(m, egroup, ident, "state:\"%s\"", state, a0, (v0), a1, (v1))
206 #define KTR_STATE3(m, egroup, ident, state, a0, v0, a1, v1, a2, v2) \
207 KTR_EVENT3(m, egroup, ident, "state:\"%s\"", \
208 state, a0, (v0), a1, (v1), a2, (v2))
209 #define KTR_STATE4(m, egroup, ident, state, a0, v0, a1, v1, a2, v2, a3, v3)\
210 KTR_EVENT4(m, egroup, ident, "state:\"%s\"", \
211 state, a0, (v0), a1, (v1), a2, (v2), a3, (v3))
214 * Counter functions graph counter values. The counter id
215 * must not be intermixed with a state id.
217 #define KTR_COUNTER0(m, egroup, ident, counter) \
218 KTR_EVENT0(m, egroup, ident, "counter:%d", counter)
219 #define KTR_COUNTER1(m, egroup, ident, edat, a0, v0) \
220 KTR_EVENT1(m, egroup, ident, "counter:%d", counter, a0, (v0))
221 #define KTR_COUNTER2(m, egroup, ident, counter, a0, v0, a1, v1) \
222 KTR_EVENT2(m, egroup, ident, "counter:%d", counter, a0, (v0), a1, (v1))
223 #define KTR_COUNTER3(m, egroup, ident, counter, a0, v0, a1, v1, a2, v2) \
224 KTR_EVENT3(m, egroup, ident, "counter:%d", \
225 counter, a0, (v0), a1, (v1), a2, (v2))
226 #define KTR_COUNTER4(m, egroup, ident, counter, a0, v0, a1, v1, a2, v2, a3, v3)\
227 KTR_EVENT4(m, egroup, ident, "counter:%d", \
228 counter, a0, (v0), a1, (v1), a2, (v2), a3, (v3))
231 * Point functions plot points of interest on counter or state graphs.
233 #define KTR_POINT0(m, egroup, ident, point) \
234 KTR_EVENT0(m, egroup, ident, "point:\"%s\"", point)
235 #define KTR_POINT1(m, egroup, ident, point, a0, v0) \
236 KTR_EVENT1(m, egroup, ident, "point:\"%s\"", point, a0, (v0))
237 #define KTR_POINT2(m, egroup, ident, point, a0, v0, a1, v1) \
238 KTR_EVENT2(m, egroup, ident, "point:\"%s\"", point, a0, (v0), a1, (v1))
239 #define KTR_POINT3(m, egroup, ident, point, a0, v0, a1, v1, a2, v2) \
240 KTR_EVENT3(m, egroup, ident, "point:\"%s\"", point, \
241 a0, (v0), a1, (v1), a2, (v2))
242 #define KTR_POINT4(m, egroup, ident, point, a0, v0, a1, v1, a2, v2, a3, v3)\
243 KTR_EVENT4(m, egroup, ident, "point:\"%s\"", \
244 point, a0, (v0), a1, (v1), a2, (v2), a3, (v3))
247 * Start functions denote the start of a region of code or operation
248 * and should be paired with stop functions for timing of nested
251 * Specifying extra attributes with the name "key" will result in
252 * multi-part keys. For example a block device and offset pair
253 * might be used to describe a buf undergoing I/O.
255 #define KTR_START0(m, egroup, ident, key) \
256 KTR_EVENT0(m, egroup, ident, "start:0x%jX", (uintmax_t)key)
257 #define KTR_START1(m, egroup, ident, key, a0, v0) \
258 KTR_EVENT1(m, egroup, ident, "start:0x%jX", (uintmax_t)key, a0, (v0))
259 #define KTR_START2(m, egroup, ident, key, a0, v0, a1, v1) \
260 KTR_EVENT2(m, egroup, ident, "start:0x%jX", (uintmax_t)key, \
262 #define KTR_START3(m, egroup, ident, key, a0, v0, a1, v1, a2, v2)\
263 KTR_EVENT3(m, egroup, ident, "start:0x%jX", (uintmax_t)key, \
264 a0, (v0), a1, (v1), a2, (v2))
265 #define KTR_START4(m, egroup, ident, key, \
266 a0, v0, a1, v1, a2, v2, a3, v3) \
267 KTR_EVENT4(m, egroup, ident, "start:0x%jX", (uintmax_t)key, \
268 a0, (v0), a1, (v1), a2, (v2), a3, (v3))
271 * Stop functions denote the end of a region of code or operation
272 * and should be paired with start functions for timing of nested
275 #define KTR_STOP0(m, egroup, ident, key) \
276 KTR_EVENT0(m, egroup, ident, "stop:0x%jX", (uintmax_t)key)
277 #define KTR_STOP1(m, egroup, ident, key, a0, v0) \
278 KTR_EVENT1(m, egroup, ident, "stop:0x%jX", (uintmax_t)key, a0, (v0))
279 #define KTR_STOP2(m, egroup, ident, key, a0, v0, a1, v1) \
280 KTR_EVENT2(m, egroup, ident, "stop:0x%jX", (uintmax_t)key, \
282 #define KTR_STOP3(m, egroup, ident, key, a0, v0, a1, v1, a2, v2)\
283 KTR_EVENT3(m, egroup, ident, "stop:0x%jX", (uintmax_t)key, \
284 a0, (v0), a1, (v1), a2, (v2))
285 #define KTR_STOP4(m, egroup, ident, \
286 key, a0, v0, a1, v1, a2, v2, a3, v3) \
287 KTR_EVENT4(m, egroup, ident, "stop:0x%jX", (uintmax_t)key, \
288 a0, (v0), a1, (v1), a2, (v2), a3, (v3))
291 * Trace initialization events, similar to CTR with KTR_INIT, but
292 * completely ifdef'ed out if KTR_INIT isn't in KTR_COMPILE (to
293 * save string space, the compiler doesn't optimize out strings
294 * for the conditional ones above).
296 #if (KTR_COMPILE & KTR_INIT) != 0
297 #define ITR0(d) CTR0(KTR_INIT, d)
298 #define ITR1(d, p1) CTR1(KTR_INIT, d, p1)
299 #define ITR2(d, p1, p2) CTR2(KTR_INIT, d, p1, p2)
300 #define ITR3(d, p1, p2, p3) CTR3(KTR_INIT, d, p1, p2, p3)
301 #define ITR4(d, p1, p2, p3, p4) CTR4(KTR_INIT, d, p1, p2, p3, p4)
302 #define ITR5(d, p1, p2, p3, p4, p5) CTR5(KTR_INIT, d, p1, p2, p3, p4, p5)
303 #define ITR6(d, p1, p2, p3, p4, p5, p6) CTR6(KTR_INIT, d, p1, p2, p3, p4, p5, p6)
307 #define ITR2(d, p1, p2)
308 #define ITR3(d, p1, p2, p3)
309 #define ITR4(d, p1, p2, p3, p4)
310 #define ITR5(d, p1, p2, p3, p4, p5)
311 #define ITR6(d, p1, p2, p3, p4, p5, p6)
316 #endif /* !_SYS_KTR_H_ */