xref: /haiku/src/libs/compat/freebsd_network/compat/sys/ktr.h (revision dba28784c21beab5d397068303881fe024a76859)
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: src/sys/sys/ktr.h,v 1.32.2.2 2006/01/23 14:56:33 marius Exp $
30  */
31 
32 /*
33  *	Wraparound kernel trace buffer support.
34  */
35 #ifndef _SYS_KTR_H_
36 #define _SYS_KTR_H_
37 
38 /*
39  * Trace classes
40  */
41 #define	KTR_GEN		0x00000001		/* General (TR) */
42 #define	KTR_NET		0x00000002		/* Network */
43 #define	KTR_DEV		0x00000004		/* Device driver */
44 #define	KTR_LOCK	0x00000008		/* MP locking */
45 #define	KTR_SMP		0x00000010		/* MP general */
46 #define	KTR_FS		0x00000020		/* Filesystem */
47 #define KTR_PMAP	0x00000040		/* Pmap tracing */
48 #define KTR_MALLOC	0x00000080		/* Malloc tracing */
49 #define	KTR_TRAP	0x00000100		/* Trap processing */
50 #define	KTR_INTR	0x00000200		/* Interrupt tracing */
51 #define KTR_SIG		0x00000400		/* Signal processing */
52 #define	KTR_CLK		0x00000800		/* hardclock verbose */
53 #define	KTR_PROC	0x00001000		/* Process scheduling */
54 #define	KTR_SYSC	0x00002000		/* System call */
55 #define	KTR_INIT	0x00004000		/* System initialization */
56 #define KTR_KGDB	0x00008000		/* Trace kgdb internals */
57 #define	KTR_IO		0x00010000		/* Upper I/O  */
58 #define	KTR_EVH		0x00020000		/* Eventhandler */
59 #define KTR_VFS		0x00040000		/* VFS events */
60 #define KTR_VOP		0x00080000		/* Auto-generated vop events */
61 #define KTR_VM		0x00100000		/* The virtual memory system */
62 #define KTR_WITNESS	0x00200000
63 #define	KTR_RUNQ	0x00400000		/* Run queue */
64 #define	KTR_CONTENTION	0x00800000		/* Lock contention */
65 #define	KTR_UMA		0x01000000		/* UMA slab allocator */
66 #define	KTR_CALLOUT	0x02000000		/* Callouts and timeouts */
67 #define	KTR_GEOM	0x04000000		/* GEOM I/O events */
68 #define	KTR_BUSDMA	0x08000000		/* busdma(9) events */
69 #define	KTR_CRITICAL	0x10000000		/* Critical sections */
70 #define	KTR_SCHED	0x20000000		/* Machine parsed sched info. */
71 #define	KTR_BUF		0x40000000		/* Buffer cache */
72 #define	KTR_ALL		0x7fffffff
73 
74 /*
75  * Trace classes which can be assigned to particular use at compile time
76  * These must remain in high 22 as some assembly code counts on it
77  */
78 #define KTR_CT1		0x01000000
79 #define KTR_CT2		0x02000000
80 #define KTR_CT3		0x04000000
81 #define KTR_CT4		0x08000000
82 #define KTR_CT5		0x10000000
83 #define KTR_CT6		0x20000000
84 #define KTR_CT7		0x40000000
85 #define KTR_CT8		0x80000000
86 
87 /* Trace classes to compile in */
88 #ifdef KTR
89 #ifndef KTR_COMPILE
90 #define	KTR_COMPILE	(KTR_ALL)
91 #endif
92 #else	/* !KTR */
93 #undef KTR_COMPILE
94 #define KTR_COMPILE 0
95 #endif	/* KTR */
96 
97 /* Trace classes that can not be used with KTR_ALQ */
98 #define	KTR_ALQ_MASK	(KTR_WITNESS)
99 
100 /*
101  * Version number for ktr_entry struct.  Increment this when you break binary
102  * compatibility.
103  */
104 #define	KTR_VERSION	2
105 
106 #define	KTR_PARMS	6
107 
108 #ifndef LOCORE
109 
110 struct ktr_entry {
111 	u_int64_t ktr_timestamp;
112 	int	ktr_cpu;
113 	int	ktr_line;
114 	const	char *ktr_file;
115 	const	char *ktr_desc;
116 	struct	thread *ktr_thread;
117 	u_long	ktr_parms[KTR_PARMS];
118 };
119 
120 extern int ktr_cpumask;
121 extern int ktr_mask;
122 extern int ktr_entries;
123 extern int ktr_verbose;
124 
125 extern volatile int ktr_idx;
126 extern struct ktr_entry ktr_buf[];
127 
128 #ifdef KTR
129 
130 #if 0
131 void	ktr_tracepoint(u_int mask, const char *file, int line,
132 	    const char *format, u_long arg1, u_long arg2, u_long arg3,
133 	    u_long arg4, u_long arg5, u_long arg6);
134 #else
135 extern void driver_printf(const char *format, ...);
136 #define ktr_tracepoint(mask, file, line, format, arg1, arg2, arg3, arg4, arg5, arg6) \
137 	driver_printf("(%s:%i) " format "\n", file, line, arg1, arg2, arg3, arg4, arg5, arg6)
138 #endif
139 
140 #define CTR6(m, format, p1, p2, p3, p4, p5, p6) do {			\
141 	if (KTR_COMPILE & (m))						\
142 		ktr_tracepoint((m), __FILE__, __LINE__, format,		\
143 		    (u_long)(p1), (u_long)(p2), (u_long)(p3),		\
144 		    (u_long)(p4), (u_long)(p5), (u_long)(p6));		\
145 	} while(0)
146 #define CTR0(m, format)			CTR6(m, format, 0, 0, 0, 0, 0, 0)
147 #define CTR1(m, format, p1)		CTR6(m, format, p1, 0, 0, 0, 0, 0)
148 #define	CTR2(m, format, p1, p2)		CTR6(m, format, p1, p2, 0, 0, 0, 0)
149 #define	CTR3(m, format, p1, p2, p3)	CTR6(m, format, p1, p2, p3, 0, 0, 0)
150 #define	CTR4(m, format, p1, p2, p3, p4)	CTR6(m, format, p1, p2, p3, p4, 0, 0)
151 #define	CTR5(m, format, p1, p2, p3, p4, p5)	CTR6(m, format, p1, p2, p3, p4, p5, 0)
152 #else	/* KTR */
153 #define	CTR0(m, d)
154 #define	CTR1(m, d, p1)
155 #define	CTR2(m, d, p1, p2)
156 #define	CTR3(m, d, p1, p2, p3)
157 #define	CTR4(m, d, p1, p2, p3, p4)
158 #define	CTR5(m, d, p1, p2, p3, p4, p5)
159 #define	CTR6(m, d, p1, p2, p3, p4, p5, p6)
160 #endif	/* KTR */
161 
162 #define	TR0(d)				CTR0(KTR_GEN, d)
163 #define	TR1(d, p1)			CTR1(KTR_GEN, d, p1)
164 #define	TR2(d, p1, p2)			CTR2(KTR_GEN, d, p1, p2)
165 #define	TR3(d, p1, p2, p3)		CTR3(KTR_GEN, d, p1, p2, p3)
166 #define	TR4(d, p1, p2, p3, p4)		CTR4(KTR_GEN, d, p1, p2, p3, p4)
167 #define	TR5(d, p1, p2, p3, p4, p5)	CTR5(KTR_GEN, d, p1, p2, p3, p4, p5)
168 #define	TR6(d, p1, p2, p3, p4, p5, p6)	CTR6(KTR_GEN, d, p1, p2, p3, p4, p5, p6)
169 
170 /*
171  * Trace initialization events, similar to CTR with KTR_INIT, but
172  * completely ifdef'ed out if KTR_INIT isn't in KTR_COMPILE (to
173  * save string space, the compiler doesn't optimize out strings
174  * for the conditional ones above).
175  */
176 #if (KTR_COMPILE & KTR_INIT) != 0
177 #define	ITR0(d)				CTR0(KTR_INIT, d)
178 #define	ITR1(d, p1)			CTR1(KTR_INIT, d, p1)
179 #define	ITR2(d, p1, p2)			CTR2(KTR_INIT, d, p1, p2)
180 #define	ITR3(d, p1, p2, p3)		CTR3(KTR_INIT, d, p1, p2, p3)
181 #define	ITR4(d, p1, p2, p3, p4)		CTR4(KTR_INIT, d, p1, p2, p3, p4)
182 #define	ITR5(d, p1, p2, p3, p4, p5)	CTR5(KTR_INIT, d, p1, p2, p3, p4, p5)
183 #define	ITR6(d, p1, p2, p3, p4, p5, p6)	CTR6(KTR_INIT, d, p1, p2, p3, p4, p5, p6)
184 #else
185 #define	ITR0(d)
186 #define	ITR1(d, p1)
187 #define	ITR2(d, p1, p2)
188 #define	ITR3(d, p1, p2, p3)
189 #define	ITR4(d, p1, p2, p3, p4)
190 #define	ITR5(d, p1, p2, p3, p4, p5)
191 #define	ITR6(d, p1, p2, p3, p4, p5, p6)
192 #endif
193 
194 #endif /* !LOCORE */
195 
196 #endif /* !_SYS_KTR_H_ */
197