ktr.h revision 112109
1/*-
2 * Copyright (c) 1996 Berkeley Software Design, Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
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
14 *    written permission.
15 *
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
26 * SUCH DAMAGE.
27 *
28 *	from BSDI $Id: ktr.h,v 1.10.2.7 2000/03/16 21:44:42 cp Exp $
29 * $FreeBSD: head/sys/sys/ktr.h 112109 2003-03-11 20:07:22Z jhb $
30 */
31
32/*
33 *	Wraparound kernel trace buffer support.
34 */
35
36#ifndef _SYS_KTR_H_
37#define _SYS_KTR_H_
38
39/*
40 * Hack around due to egcs-1.1.2 not knowing what __func__ is.
41 */
42#ifdef __GNUC__
43#if __GNUC__ == 2 && __GNUC_MINOR__ == 91      /* egcs 1.1.2 */
44#define        __func__        __FUNCTION__
45#endif
46#endif
47
48/*
49 * Trace classes
50 */
51#define	KTR_GEN		0x00000001		/* General (TR) */
52#define	KTR_NET		0x00000002		/* Network */
53#define	KTR_DEV		0x00000004		/* Device driver */
54#define	KTR_LOCK	0x00000008		/* MP locking */
55#define	KTR_SMP		0x00000010		/* MP general */
56#define	KTR_FS		0x00000020		/* Filesystem */
57#define KTR_PMAP	0x00000040		/* Pmap tracing */
58#define KTR_MALLOC	0x00000080		/* Malloc tracing */
59#define	KTR_TRAP	0x00000100		/* Trap processing */
60#define	KTR_INTR	0x00000200		/* Interrupt tracing */
61#define KTR_SIG		0x00000400		/* Signal processing */
62#define	KTR_CLK		0x00000800		/* hardclock verbose */
63#define	KTR_PROC	0x00001000		/* Process scheduling */
64#define	KTR_SYSC	0x00002000		/* System call */
65#define	KTR_INIT	0x00004000		/* System initialization */
66#define KTR_KGDB	0x00008000		/* Trace kgdb internals */
67#define	KTR_IO		0x00010000		/* Upper I/O  */
68#define	KTR_EVH		0x00020000		/* Eventhandler */
69#define KTR_NFS		0x00040000		/* The obvious */
70#define KTR_VOP		0x00080000		/* The obvious */
71#define KTR_VM		0x00100000		/* The virtual memory system */
72#define KTR_WITNESS	0x00200000
73#define	KTR_RUNQ	0x00400000		/* Run queue */
74#define	KTR_CONTENTION	0x00800000		/* Lock contention */
75#define	KTR_ALL		0x00ffffff
76
77/*
78 * Trace classes which can be assigned to particular use at compile time
79 * These must remain in high 22 as some assembly code counts on it
80 */
81#define KTR_CT1		0x01000000
82#define KTR_CT2		0x02000000
83#define KTR_CT3		0x04000000
84#define KTR_CT4		0x08000000
85#define KTR_CT5		0x10000000
86#define KTR_CT6		0x20000000
87#define KTR_CT7		0x40000000
88#define KTR_CT8		0x80000000
89
90/* Trace classes to compile in */
91#ifndef KTR_COMPILE
92#define	KTR_COMPILE	(KTR_GEN)
93#endif
94
95/* Trace classes that can not be used with KTR_ALQ */
96#define	KTR_ALQ_MASK	(KTR_WITNESS)
97
98/*
99 * Version number for ktr_entry struct.  Increment this when you break binary
100 * compatibility.
101 */
102#define	KTR_VERSION	1
103
104#define	KTR_PARMS	6
105
106#ifndef LOCORE
107
108struct ktr_entry {
109	u_int64_t ktr_timestamp;
110	int	ktr_cpu;
111	int	ktr_line;
112	const	char *ktr_file;
113	const	char *ktr_desc;
114	u_long	ktr_parms[KTR_PARMS];
115};
116
117extern int ktr_cpumask;
118extern int ktr_mask;
119extern int ktr_entries;
120extern int ktr_verbose;
121
122extern volatile int ktr_idx;
123extern struct ktr_entry ktr_buf[];
124
125#endif /* !LOCORE */
126#ifdef KTR
127
128void	ktr_tracepoint(u_int mask, const char *file, int line,
129	    const char *format, u_long arg1, u_long arg2, u_long arg3,
130	    u_long arg4, u_long arg5, u_long arg6);
131
132#define CTR6(m, format, p1, p2, p3, p4, p5, p6) do {			\
133	if (KTR_COMPILE & (m))						\
134		ktr_tracepoint((m), __FILE__, __LINE__, format,		\
135		    (u_long)(p1), (u_long)(p2), (u_long)(p3),		\
136		    (u_long)(p4), (u_long)(p5), (u_long)(p6));		\
137	} while(0)
138#define CTR0(m, format)			CTR6(m, format, 0, 0, 0, 0, 0, 0)
139#define CTR1(m, format, p1)		CTR6(m, format, p1, 0, 0, 0, 0, 0)
140#define	CTR2(m, format, p1, p2)		CTR6(m, format, p1, p2, 0, 0, 0, 0)
141#define	CTR3(m, format, p1, p2, p3)	CTR6(m, format, p1, p2, p3, 0, 0, 0)
142#define	CTR4(m, format, p1, p2, p3, p4)	CTR6(m, format, p1, p2, p3, p4, 0, 0)
143#define	CTR5(m, format, p1, p2, p3, p4, p5)	CTR6(m, format, p1, p2, p3, p4, p5, 0)
144#else	/* KTR */
145#undef KTR_COMPILE
146#define KTR_COMPILE 0
147#define	CTR0(m, d)
148#define	CTR1(m, d, p1)
149#define	CTR2(m, d, p1, p2)
150#define	CTR3(m, d, p1, p2, p3)
151#define	CTR4(m, d, p1, p2, p3, p4)
152#define	CTR5(m, d, p1, p2, p3, p4, p5)
153#define	CTR6(m, d, p1, p2, p3, p4, p5, p6)
154#endif	/* KTR */
155
156#define	TR0(d)				CTR0(KTR_GEN, d)
157#define	TR1(d, p1)			CTR1(KTR_GEN, d, p1)
158#define	TR2(d, p1, p2)			CTR2(KTR_GEN, d, p1, p2)
159#define	TR3(d, p1, p2, p3)		CTR3(KTR_GEN, d, p1, p2, p3)
160#define	TR4(d, p1, p2, p3, p4)		CTR4(KTR_GEN, d, p1, p2, p3, p4)
161#define	TR5(d, p1, p2, p3, p4, p5)	CTR5(KTR_GEN, d, p1, p2, p3, p4, p5)
162#define	TR6(d, p1, p2, p3, p4, p5, p6)	CTR6(KTR_GEN, d, p1, p2, p3, p4, p5, p6)
163
164/*
165 * Trace initialization events, similar to CTR with KTR_INIT, but
166 * completely ifdef'ed out if KTR_INIT isn't in KTR_COMPILE (to
167 * save string space, the compiler doesn't optimize out strings
168 * for the conditional ones above).
169 */
170#if (KTR_COMPILE & KTR_INIT) != 0
171#define	ITR0(d)				CTR0(KTR_INIT, d)
172#define	ITR1(d, p1)			CTR1(KTR_INIT, d, p1)
173#define	ITR2(d, p1, p2)			CTR2(KTR_INIT, d, p1, p2)
174#define	ITR3(d, p1, p2, p3)		CTR3(KTR_INIT, d, p1, p2, p3)
175#define	ITR4(d, p1, p2, p3, p4)		CTR4(KTR_INIT, d, p1, p2, p3, p4)
176#define	ITR5(d, p1, p2, p3, p4, p5)	CTR5(KTR_INIT, d, p1, p2, p3, p4, p5)
177#define	ITR6(d, p1, p2, p3, p4, p5, p6)	CTR6(KTR_INIT, d, p1, p2, p3, p4, p5, p6)
178#else
179#define	ITR0(d)
180#define	ITR1(d, p1)
181#define	ITR2(d, p1, p2)
182#define	ITR3(d, p1, p2, p3)
183#define	ITR4(d, p1, p2, p3, p4)
184#define	ITR5(d, p1, p2, p3, p4, p5)
185#define	ITR6(d, p1, p2, p3, p4, p5, p6)
186#endif
187
188#endif /* !_SYS_KTR_H_ */
189