ktr.h revision 87621
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 87621 2001-12-10 20:09:49Z obrien $ 30 */ 31 32/* 33 * Wraparound kernel trace buffer support. 34 */ 35 36#ifndef _SYS_KTR_H_ 37#define _SYS_KTR_H_ 38 39/* Requires sys/types.h, sys/time.h, machine/atomic.h, and machine/cpufunc.h */ 40 41#include <machine/atomic.h> 42#include <machine/cpufunc.h> 43 44/* 45 * Hack around due to egcs-1.1.2 not knowing what __func__ is. 46 */ 47#ifdef __GNUC__ 48#if __GNUC__ == 2 && __GNUC_MINOR__ == 91 /* egcs 1.1.2 */ 49#define __func__ __FUNCTION__ 50#endif 51#endif 52 53/* 54 * Trace classes 55 */ 56#define KTR_GEN 0x00000001 /* General (TR) */ 57#define KTR_NET 0x00000002 /* Network */ 58#define KTR_DEV 0x00000004 /* Device driver */ 59#define KTR_LOCK 0x00000008 /* MP locking */ 60#define KTR_SMP 0x00000010 /* MP general */ 61#define KTR_FS 0x00000020 /* Filesystem */ 62#define KTR_PMAP 0x00000040 /* Pmap tracing */ 63#define KTR_MALLOC 0x00000080 /* Malloc tracing */ 64#define KTR_TRAP 0x00000100 /* Trap processing */ 65#define KTR_INTR 0x00000200 /* Interrupt tracing */ 66#define KTR_SIG 0x00000400 /* Signal processing */ 67#define KTR_CLK 0x00000800 /* hardclock verbose */ 68#define KTR_PROC 0x00001000 /* Process scheduling */ 69#define KTR_SYSC 0x00002000 /* System call */ 70#define KTR_INIT 0x00004000 /* System initialization */ 71#define KTR_KGDB 0x00008000 /* Trace kgdb internals */ 72#define KTR_IO 0x00010000 /* Upper I/O */ 73#define KTR_LOCKMGR 0x00020000 74#define KTR_NFS 0x00040000 /* The obvious */ 75#define KTR_VOP 0x00080000 /* The obvious */ 76#define KTR_VM 0x00100000 /* The virtual memory system */ 77#define KTR_WITNESS 0x00200000 78#define KTR_RUNQ 0x00400000 /* Run queue */ 79#define KTR_ALL 0x007fffff 80 81/* 82 * Trace classes which can be assigned to particular use at compile time 83 * These must remain in high 22 as some assembly code counts on it 84 */ 85#define KTR_CT1 0x010000000 86#define KTR_CT2 0x020000000 87#define KTR_CT3 0x040000000 88#define KTR_CT4 0x080000000 89#define KTR_CT5 0x100000000 90#define KTR_CT6 0x200000000 91#define KTR_CT7 0x400000000 92#define KTR_CT8 0x800000000 93 94/* Trace classes to compile in */ 95#ifndef KTR_COMPILE 96#define KTR_COMPILE (KTR_GEN) 97#endif 98 99#ifndef LOCORE 100 101#include <sys/time.h> 102 103#ifndef KTRDESCSIZE 104#define KTRDESCSIZE 80 105#endif 106 107struct ktr_entry { 108 struct timespec ktr_tv; 109 int ktr_cpu; 110#ifdef KTR_EXTEND 111 char ktr_desc[KTRDESCSIZE]; 112 const char *ktr_filename; 113 int ktr_line; 114#else 115 const char *ktr_desc; 116 u_long ktr_parm1; 117 u_long ktr_parm2; 118 u_long ktr_parm3; 119 u_long ktr_parm4; 120 u_long ktr_parm5; 121 u_long ktr_parm6; 122#endif 123}; 124 125/* These variables are used by gdb to analyse the output */ 126extern int ktr_extend; 127 128extern int ktr_cpumask; 129extern int ktr_mask; 130extern int ktr_entries; 131extern int ktr_verbose; 132 133extern volatile int ktr_idx; 134extern struct ktr_entry ktr_buf[]; 135 136#endif /* !LOCORE */ 137#ifdef KTR 138 139#ifdef KTR_EXTEND 140void ktr_tracepoint(u_int mask, const char *filename, u_int line, 141 const char *format, ...) __printflike(4, 5); 142#else 143void ktr_tracepoint(u_int mask, const char *format, u_long arg1, u_long arg2, 144 u_long arg3, u_long arg4, u_long arg5, u_long arg6); 145#endif 146 147#ifdef KTR_EXTEND 148#define CTR(m, format, args...) do { \ 149 if (KTR_COMPILE & (m)) \ 150 ktr_tracepoint((m), __FILE__, __LINE__, format , ##args); \ 151 } while(0) 152 153#define CTR0(m, format) CTR(m, format) 154#define CTR1(m, format, p1) CTR(m, format, p1) 155#define CTR2(m, format, p1, p2) CTR(m, format, p1, p2) 156#define CTR3(m, format, p1, p2, p3) CTR(m, format, p1, p2, p3) 157#define CTR4(m, format, p1, p2, p3, p4) CTR(m, format, p1, p2, p3, p4) 158#define CTR5(m, format, p1, p2, p3, p4, p5) \ 159 CTR(m, format, p1, p2, p3, p4, p5) 160#define CTR6(m, format, p1, p2, p3, p4, p5, p6) \ 161 CTR(m, format, p1, p2, p3, p4, p5, p6) 162#else /* not extended */ 163#define CTR6(m, format, p1, p2, p3, p4, p5, p6) do { \ 164 if (KTR_COMPILE & (m)) \ 165 ktr_tracepoint((m), format, (u_long)p1, (u_long)p2, \ 166 (u_long)p3, (u_long)p4, (u_long)p5, (u_long)p6); \ 167 } while(0) 168#define CTR0(m, format) CTR6(m, format, 0, 0, 0, 0, 0, 0) 169#define CTR1(m, format, p1) CTR6(m, format, p1, 0, 0, 0, 0, 0) 170#define CTR2(m, format, p1, p2) CTR6(m, format, p1, p2, 0, 0, 0, 0) 171#define CTR3(m, format, p1, p2, p3) CTR6(m, format, p1, p2, p3, 0, 0, 0) 172#define CTR4(m, format, p1, p2, p3, p4) CTR6(m, format, p1, p2, p3, p4, 0, 0) 173#define CTR5(m, format, p1, p2, p3, p4, p5) CTR6(m, format, p1, p2, p3, p4, p5, 0) 174#endif /* KTR_EXTEND */ 175#else /* KTR */ 176#undef KTR_COMPILE 177#define KTR_COMPILE 0 178#define CTR0(m, d) 179#define CTR1(m, d, p1) 180#define CTR2(m, d, p1, p2) 181#define CTR3(m, d, p1, p2, p3) 182#define CTR4(m, d, p1, p2, p3, p4) 183#define CTR5(m, d, p1, p2, p3, p4, p5) 184#define CTR6(m, d, p1, p2, p3, p4, p5, p6) 185#endif /* KTR */ 186 187#define TR0(d) CTR0(KTR_GEN, d) 188#define TR1(d, p1) CTR1(KTR_GEN, d, p1) 189#define TR2(d, p1, p2) CTR2(KTR_GEN, d, p1, p2) 190#define TR3(d, p1, p2, p3) CTR3(KTR_GEN, d, p1, p2, p3) 191#define TR4(d, p1, p2, p3, p4) CTR4(KTR_GEN, d, p1, p2, p3, p4) 192#define TR5(d, p1, p2, p3, p4, p5) CTR5(KTR_GEN, d, p1, p2, p3, p4, p5) 193#define TR6(d, p1, p2, p3, p4, p5, p6) CTR5(KTR_GEN, d, p1, p2, p3, p4, p5, p6) 194 195/* 196 * Trace initialization events, similar to CTR with KTR_INIT, but 197 * completely ifdef'ed out if KTR_INIT isn't in KTR_COMPILE (to 198 * save string space, the compiler doesn't optimize out strings 199 * for the conditional ones above). 200 */ 201#if (KTR_COMPILE & KTR_INIT) != 0 202#define ITR0(d) CTR0(KTR_INIT, d) 203#define ITR1(d, p1) CTR1(KTR_INIT, d, p1) 204#define ITR2(d, p1, p2) CTR2(KTR_INIT, d, p1, p2) 205#define ITR3(d, p1, p2, p3) CTR3(KTR_INIT, d, p1, p2, p3) 206#define ITR4(d, p1, p2, p3, p4) CTR4(KTR_INIT, d, p1, p2, p3, p4) 207#define ITR5(d, p1, p2, p3, p4, p5) CTR5(KTR_INIT, d, p1, p2, p3, p4, p5) 208#define ITR6(d, p1, p2, p3, p4, p5, p6) CTR5(KTR_INIT, d, p1, p2, p3, p4, p5, p6) 209#else 210#define ITR0(d) 211#define ITR1(d, p1) 212#define ITR2(d, p1, p2) 213#define ITR3(d, p1, p2, p3) 214#define ITR4(d, p1, p2, p3, p4) 215#define ITR5(d, p1, p2, p3, p4, p5) 216#define ITR6(d, p1, p2, p3, p4, p5, p6) 217#endif 218 219#endif /* !_SYS_KTR_H_ */ 220