sys/sys/ktr.h

   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$
  30  */
  31
  32 /*
  33  *      Wraparound kernel trace buffer support.
  34  */
  35
  36 #ifndef _SYS_KTR_H_
  37 #define _SYS_KTR_H_
  38
  39 /*
  40  * Trace classes
  41  *
  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.
  46  */
  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
  79
  80 /*
  81  * Trace classes which can be assigned to particular use at compile time
  82  * These must remain in high 22 as some assembly code counts on it
  83  */
  84 #define KTR_CT1         0x01000000
  85 #define KTR_CT2         0x02000000
  86 #define KTR_CT3         0x04000000
  87 #define KTR_CT4         0x08000000
  88 #define KTR_CT5         0x10000000
  89 #define KTR_CT6         0x20000000
  90 #define KTR_CT7         0x40000000
  91 #define KTR_CT8         0x80000000
  92
  93 /* Trace classes to compile in */
  94 #ifdef KTR
  95 #ifndef KTR_COMPILE
  96 #define KTR_COMPILE     (KTR_ALL)
  97 #endif
  98 #else   /* !KTR */
  99 #undef KTR_COMPILE
 100 #define KTR_COMPILE 0
 101 #endif  /* KTR */
 102
 103 /*
 104  * Version number for ktr_entry struct.  Increment this when you break binary
 105  * compatibility.
 106  */
 107 #define KTR_VERSION     2
 108
 109 #define KTR_PARMS       6
 110
 111 #ifndef LOCORE
 112
 113 struct ktr_entry {
 114         u_int64_t ktr_timestamp;
 115         int     ktr_cpu;
 116         int     ktr_line;
 117         const   char *ktr_file;
 118         const   char *ktr_desc;
 119         struct  thread *ktr_thread;
 120         u_long  ktr_parms[KTR_PARMS];
 121 };
 122
 123 extern int ktr_cpumask;
 124 extern int ktr_mask;
 125 extern int ktr_entries;
 126 extern int ktr_verbose;
 127
 128 extern volatile int ktr_idx;
 129 extern struct ktr_entry ktr_buf[];
 130
 131 #ifdef KTR
 132
 133 void    ktr_tracepoint(u_int mask, const char *file, int line,
 134             const char *format, u_long arg1, u_long arg2, u_long arg3,
 135             u_long arg4, u_long arg5, u_long arg6);
 136
 137 #define CTR6(m, format, p1, p2, p3, p4, p5, p6) do {                    \
 138         if (KTR_COMPILE & (m))                                          \
 139                 ktr_tracepoint((m), __FILE__, __LINE__, format,         \
 140                     (u_long)(p1), (u_long)(p2), (u_long)(p3),           \
 141                     (u_long)(p4), (u_long)(p5), (u_long)(p6));          \
 142         } while(0)
 143 #define CTR0(m, format)                 CTR6(m, format, 0, 0, 0, 0, 0, 0)
 144 #define CTR1(m, format, p1)             CTR6(m, format, p1, 0, 0, 0, 0, 0)
 145 #define CTR2(m, format, p1, p2)         CTR6(m, format, p1, p2, 0, 0, 0, 0)
 146 #define CTR3(m, format, p1, p2, p3)     CTR6(m, format, p1, p2, p3, 0, 0, 0)
 147 #define CTR4(m, format, p1, p2, p3, p4) CTR6(m, format, p1, p2, p3, p4, 0, 0)
 148 #define CTR5(m, format, p1, p2, p3, p4, p5)     CTR6(m, format, p1, p2, p3, p4, p5, 0)
 149 #else   /* KTR */
 150 #define CTR0(m, d)                      (void)0
 151 #define CTR1(m, d, p1)                  (void)0
 152 #define CTR2(m, d, p1, p2)              (void)0
 153 #define CTR3(m, d, p1, p2, p3)          (void)0
 154 #define CTR4(m, d, p1, p2, p3, p4)      (void)0
 155 #define CTR5(m, d, p1, p2, p3, p4, p5)  (void)0
 156 #define CTR6(m, d, p1, p2, p3, p4, p5, p6)      (void)0
 157 #endif  /* KTR */
 158
 159 #define TR0(d)                          CTR0(KTR_GEN, d)
 160 #define TR1(d, p1)                      CTR1(KTR_GEN, d, p1)
 161 #define TR2(d, p1, p2)                  CTR2(KTR_GEN, d, p1, p2)
 162 #define TR3(d, p1, p2, p3)              CTR3(KTR_GEN, d, p1, p2, p3)
 163 #define TR4(d, p1, p2, p3, p4)          CTR4(KTR_GEN, d, p1, p2, p3, p4)
 164 #define TR5(d, p1, p2, p3, p4, p5)      CTR5(KTR_GEN, d, p1, p2, p3, p4, p5)
 165 #define TR6(d, p1, p2, p3, p4, p5, p6)  CTR6(KTR_GEN, d, p1, p2, p3, p4, p5, p6)
 166
 167 /*
 168  * The event macros implement KTR graphic plotting facilities provided
 169  * by src/tools/sched/schedgraph.py.  Three generic types of events are
 170  * supported: states, counters, and points.
 171  *
 172  * m is the ktr class for ktr_mask.
 173  * ident is the string identifier that owns the event (ie: "thread 10001")
 174  * etype is the type of event to plot (state, counter, point)
 175  * edat is the event specific data (state name, counter value, point name)
 176  * up to four attributes may be supplied as a name, value pair of arguments.
 177  *
 178  * etype and attribute names must be string constants.  This minimizes the
 179  * number of ktr slots required by construction the final format strings
 180  * at compile time.  Both must also include a colon and format specifier
 181  * (ie. "prio:%d", prio).  It is recommended that string arguments be
 182  * contained within escaped quotes if they may contain ',' or ':' characters.
 183  *
 184  * The special attribute (KTR_ATTR_LINKED, ident) creates a reference to another
 185  * id on the graph for easy traversal of related graph elements.
 186  */
 187
 188 #define KTR_ATTR_LINKED "linkedto:\"%s\""
 189 #define KTR_EFMT(egroup, ident, etype)                                  \
 190             "KTRGRAPH group:\"" egroup "\", id:\"%s\", " etype ", attributes: "
 191
 192 #define KTR_EVENT0(m, egroup, ident, etype, edat)                       \
 193         CTR2(m, KTR_EFMT(egroup, ident, etype) "none", ident, edat)
 194 #define KTR_EVENT1(m, egroup, ident, etype, edat, a0, v0)               \
 195         CTR3(m, KTR_EFMT(egroup, ident, etype) a0, ident, edat, (v0))
 196 #define KTR_EVENT2(m, egroup, ident, etype, edat, a0, v0, a1, v1)       \
 197         CTR4(m, KTR_EFMT(egroup, ident, etype) a0 ", " a1,              \
 198             ident, edat, (v0), (v1))
 199 #define KTR_EVENT3(m, egroup, ident, etype, edat, a0, v0, a1, v1, a2, v2)\
 200         CTR5(m,KTR_EFMT(egroup, ident, etype) a0 ", " a1 ", " a2,       \
 201             ident, edat, (v0), (v1), (v2))
 202 #define KTR_EVENT4(m, egroup, ident, etype, edat,                       \
 203             a0, v0, a1, v1, a2, v2, a3, v3)                             \
 204         CTR6(m,KTR_EFMT(egroup, ident, etype) a0 ", " a1 ", " a2, ", ", a3,\
 205              ident, edat, (v0), (v1), (v2), (v3))
 206
 207 /*
 208  * State functions graph state changes on an ident.
 209  */
 210 #define KTR_STATE0(m, egroup, ident, state)                             \
 211         KTR_EVENT0(m, egroup, ident, "state:\"%s\"", state)
 212 #define KTR_STATE1(m, egroup, ident, state, a0, v0)                     \
 213         KTR_EVENT1(m, egroup, ident, "state:\"%s\"", state, a0, (v0))
 214 #define KTR_STATE2(m, egroup, ident, state, a0, v0, a1, v1)             \
 215         KTR_EVENT2(m, egroup, ident, "state:\"%s\"", state, a0, (v0), a1, (v1))
 216 #define KTR_STATE3(m, egroup, ident, state, a0, v0, a1, v1, a2, v2)     \
 217         KTR_EVENT3(m, egroup, ident, "state:\"%s\"",                    \
 218             state, a0, (v0), a1, (v1), a2, (v2))
 219 #define KTR_STATE4(m, egroup, ident, state, a0, v0, a1, v1, a2, v2, a3, v3)\
 220         KTR_EVENT4(m, egroup, ident, "state:\"%s\"",                    \
 221             state, a0, (v0), a1, (v1), a2, (v2), a3, (v3))
 222
 223 /*
 224  * Counter functions graph counter values.  The counter id
 225  * must not be intermixed with a state id.
 226  */
 227 #define KTR_COUNTER0(m, egroup, ident, counter)                         \
 228         KTR_EVENT0(m, egroup, ident, "counter:%d", counter)
 229 #define KTR_COUNTER1(m, egroup, ident, edat, a0, v0)                    \
 230         KTR_EVENT1(m, egroup, ident, "counter:%d", counter, a0, (v0))
 231 #define KTR_COUNTER2(m, egroup, ident, counter, a0, v0, a1, v1)         \
 232         KTR_EVENT2(m, egroup, ident, "counter:%d", counter, a0, (v0), a1, (v1))
 233 #define KTR_COUNTER3(m, egroup, ident, counter, a0, v0, a1, v1, a2, v2) \
 234         KTR_EVENT3(m, egroup, ident, "counter:%d",                      \
 235             counter, a0, (v0), a1, (v1), a2, (v2))
 236 #define KTR_COUNTER4(m, egroup, ident, counter, a0, v0, a1, v1, a2, v2, a3, v3)\
 237         KTR_EVENT4(m, egroup, ident, "counter:%d",                      \
 238             counter, a0, (v0), a1, (v1), a2, (v2), a3, (v3))
 239
 240 /*
 241  * Point functions plot points of interest on counter or state graphs.
 242  */
 243 #define KTR_POINT0(m, egroup, ident, point)                             \
 244         KTR_EVENT0(m, egroup, ident, "point:\"%s\"", point)
 245 #define KTR_POINT1(m, egroup, ident, point, a0, v0)                     \
 246         KTR_EVENT1(m, egroup, ident, "point:\"%s\"", point, a0, (v0))
 247 #define KTR_POINT2(m, egroup, ident, point, a0, v0, a1, v1)             \
 248         KTR_EVENT2(m, egroup, ident, "point:\"%s\"", point, a0, (v0), a1, (v1))
 249 #define KTR_POINT3(m, egroup, ident, point, a0, v0, a1, v1, a2, v2)     \
 250         KTR_EVENT3(m, egroup, ident, "point:\"%s\"", point,             \
 251             a0, (v0), a1, (v1), a2, (v2))
 252 #define KTR_POINT4(m, egroup, ident, point, a0, v0, a1, v1, a2, v2, a3, v3)\
 253         KTR_EVENT4(m, egroup, ident, "point:\"%s\"",                    \
 254             point, a0, (v0), a1, (v1), a2, (v2), a3, (v3))
 255
 256 /*
 257  * Trace initialization events, similar to CTR with KTR_INIT, but
 258  * completely ifdef'ed out if KTR_INIT isn't in KTR_COMPILE (to
 259  * save string space, the compiler doesn't optimize out strings
 260  * for the conditional ones above).
 261  */
 262 #if (KTR_COMPILE & KTR_INIT) != 0
 263 #define ITR0(d)                         CTR0(KTR_INIT, d)
 264 #define ITR1(d, p1)                     CTR1(KTR_INIT, d, p1)
 265 #define ITR2(d, p1, p2)                 CTR2(KTR_INIT, d, p1, p2)
 266 #define ITR3(d, p1, p2, p3)             CTR3(KTR_INIT, d, p1, p2, p3)
 267 #define ITR4(d, p1, p2, p3, p4)         CTR4(KTR_INIT, d, p1, p2, p3, p4)
 268 #define ITR5(d, p1, p2, p3, p4, p5)     CTR5(KTR_INIT, d, p1, p2, p3, p4, p5)
 269 #define ITR6(d, p1, p2, p3, p4, p5, p6) CTR6(KTR_INIT, d, p1, p2, p3, p4, p5, p6)
 270 #else
 271 #define ITR0(d)
 272 #define ITR1(d, p1)
 273 #define ITR2(d, p1, p2)
 274 #define ITR3(d, p1, p2, p3)
 275 #define ITR4(d, p1, p2, p3, p4)
 276 #define ITR5(d, p1, p2, p3, p4, p5)
 277 #define ITR6(d, p1, p2, p3, p4, p5, p6)
 278 #endif
 279
 280 #endif /* !LOCORE */
 281
 282 #endif /* !_SYS_KTR_H_ */