1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1996 Berkeley Software Design, Inc. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. Berkeley Software Design Inc's name may not be used to endorse or 15 * promote products derived from this software without specific prior 16 * written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN INC ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL BERKELEY SOFTWARE DESIGN INC BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 * from BSDI $Id: ktr.h,v 1.10.2.7 2000/03/16 21:44:42 cp Exp $ 31 * $FreeBSD$ 32 */ 33 34 /* 35 * Wraparound kernel trace buffer support. 36 */ 37 38 #ifndef _SYS_KTR_H_ 39 #define _SYS_KTR_H_ 40 41 #include <sys/ktr_class.h> 42 43 /* 44 * Version number for ktr_entry struct. Increment this when you break binary 45 * compatibility. 46 */ 47 #define KTR_VERSION 2 48 49 #define KTR_PARMS 6 50 51 #ifndef LOCORE 52 53 #include <sys/param.h> 54 #include <sys/_cpuset.h> 55 56 struct ktr_entry { 57 u_int64_t ktr_timestamp; 58 int ktr_cpu; 59 int ktr_line; 60 const char *ktr_file; 61 const char *ktr_desc; 62 struct thread *ktr_thread; 63 u_long ktr_parms[KTR_PARMS]; 64 }; 65 66 extern cpuset_t ktr_cpumask; 67 extern uint64_t ktr_mask; 68 extern int ktr_entries; 69 extern int ktr_verbose; 70 71 extern volatile int ktr_idx; 72 extern struct ktr_entry *ktr_buf; 73 74 #ifdef KTR 75 76 void ktr_tracepoint(uint64_t mask, const char *file, int line, 77 const char *format, u_long arg1, u_long arg2, u_long arg3, 78 u_long arg4, u_long arg5, u_long arg6); 79 80 #define CTR6(m, format, p1, p2, p3, p4, p5, p6) do { \ 81 if (KTR_COMPILE & (m)) \ 82 ktr_tracepoint((m), __FILE__, __LINE__, format, \ 83 (u_long)(p1), (u_long)(p2), (u_long)(p3), \ 84 (u_long)(p4), (u_long)(p5), (u_long)(p6)); \ 85 } while (0) 86 #define CTR0(m, format) CTR6(m, format, 0, 0, 0, 0, 0, 0) 87 #define CTR1(m, format, p1) CTR6(m, format, p1, 0, 0, 0, 0, 0) 88 #define CTR2(m, format, p1, p2) CTR6(m, format, p1, p2, 0, 0, 0, 0) 89 #define CTR3(m, format, p1, p2, p3) CTR6(m, format, p1, p2, p3, 0, 0, 0) 90 #define CTR4(m, format, p1, p2, p3, p4) CTR6(m, format, p1, p2, p3, p4, 0, 0) 91 #define CTR5(m, format, p1, p2, p3, p4, p5) CTR6(m, format, p1, p2, p3, p4, p5, 0) 92 #else /* KTR */ 93 #define CTR0(m, d) (void)0 94 #define CTR1(m, d, p1) (void)0 95 #define CTR2(m, d, p1, p2) (void)0 96 #define CTR3(m, d, p1, p2, p3) (void)0 97 #define CTR4(m, d, p1, p2, p3, p4) (void)0 98 #define CTR5(m, d, p1, p2, p3, p4, p5) (void)0 99 #define CTR6(m, d, p1, p2, p3, p4, p5, p6) (void)0 100 #endif /* KTR */ 101 102 #define TR0(d) CTR0(KTR_GEN, d) 103 #define TR1(d, p1) CTR1(KTR_GEN, d, p1) 104 #define TR2(d, p1, p2) CTR2(KTR_GEN, d, p1, p2) 105 #define TR3(d, p1, p2, p3) CTR3(KTR_GEN, d, p1, p2, p3) 106 #define TR4(d, p1, p2, p3, p4) CTR4(KTR_GEN, d, p1, p2, p3, p4) 107 #define TR5(d, p1, p2, p3, p4, p5) CTR5(KTR_GEN, d, p1, p2, p3, p4, p5) 108 #define TR6(d, p1, p2, p3, p4, p5, p6) CTR6(KTR_GEN, d, p1, p2, p3, p4, p5, p6) 109 110 #define _KTR_MACRO(m, format, _1, _2, _3, _4, _5, _6, NAME, ...) \ 111 NAME 112 #define CTR(...) \ 113 _KTR_MACRO(__VA_ARGS__, CTR6, CTR5, CTR4, CTR3, CTR2, CTR1, \ 114 CTR0)(__VA_ARGS__) 115 #define TR(...) CTR(KTR_GEN, __VA_ARGS__) 116 117 /* 118 * The event macros implement KTR graphic plotting facilities provided 119 * by src/tools/sched/schedgraph.py. Three generic types of events are 120 * supported: states, counters, and points. 121 * 122 * m is the ktr class for ktr_mask. 123 * ident is the string identifier that owns the event (ie: "thread 10001") 124 * etype is the type of event to plot (state, counter, point) 125 * edat is the event specific data (state name, counter value, point name) 126 * up to four attributes may be supplied as a name, value pair of arguments. 127 * 128 * etype and attribute names must be string constants. This minimizes the 129 * number of ktr slots required by construction the final format strings 130 * at compile time. Both must also include a colon and format specifier 131 * (ie. "prio:%d", prio). It is recommended that string arguments be 132 * contained within escaped quotes if they may contain ',' or ':' characters. 133 * 134 * The special attribute (KTR_ATTR_LINKED, ident) creates a reference to another 135 * id on the graph for easy traversal of related graph elements. 136 */ 137 138 #define KTR_ATTR_LINKED "linkedto:\"%s\"" 139 #define KTR_EFMT(egroup, ident, etype) \ 140 "KTRGRAPH group:\"" egroup "\", id:\"%s\", " etype ", attributes: " 141 142 #define KTR_EVENT0(m, egroup, ident, etype, edat) \ 143 CTR2(m, KTR_EFMT(egroup, ident, etype) "none", ident, edat) 144 #define KTR_EVENT1(m, egroup, ident, etype, edat, a0, v0) \ 145 CTR3(m, KTR_EFMT(egroup, ident, etype) a0, ident, edat, (v0)) 146 #define KTR_EVENT2(m, egroup, ident, etype, edat, a0, v0, a1, v1) \ 147 CTR4(m, KTR_EFMT(egroup, ident, etype) a0 ", " a1, \ 148 ident, edat, (v0), (v1)) 149 #define KTR_EVENT3(m, egroup, ident, etype, edat, a0, v0, a1, v1, a2, v2)\ 150 CTR5(m,KTR_EFMT(egroup, ident, etype) a0 ", " a1 ", " a2, \ 151 ident, edat, (v0), (v1), (v2)) 152 #define KTR_EVENT4(m, egroup, ident, etype, edat, \ 153 a0, v0, a1, v1, a2, v2, a3, v3) \ 154 CTR6(m,KTR_EFMT(egroup, ident, etype) a0 ", " a1 ", " a2 ", " a3,\ 155 ident, edat, (v0), (v1), (v2), (v3)) 156 157 /* 158 * State functions graph state changes on an ident. 159 */ 160 #define KTR_STATE0(m, egroup, ident, state) \ 161 KTR_EVENT0(m, egroup, ident, "state:\"%s\"", state) 162 #define KTR_STATE1(m, egroup, ident, state, a0, v0) \ 163 KTR_EVENT1(m, egroup, ident, "state:\"%s\"", state, a0, (v0)) 164 #define KTR_STATE2(m, egroup, ident, state, a0, v0, a1, v1) \ 165 KTR_EVENT2(m, egroup, ident, "state:\"%s\"", state, a0, (v0), a1, (v1)) 166 #define KTR_STATE3(m, egroup, ident, state, a0, v0, a1, v1, a2, v2) \ 167 KTR_EVENT3(m, egroup, ident, "state:\"%s\"", \ 168 state, a0, (v0), a1, (v1), a2, (v2)) 169 #define KTR_STATE4(m, egroup, ident, state, a0, v0, a1, v1, a2, v2, a3, v3)\ 170 KTR_EVENT4(m, egroup, ident, "state:\"%s\"", \ 171 state, a0, (v0), a1, (v1), a2, (v2), a3, (v3)) 172 173 /* 174 * Counter functions graph counter values. The counter id 175 * must not be intermixed with a state id. 176 */ 177 #define KTR_COUNTER0(m, egroup, ident, counter) \ 178 KTR_EVENT0(m, egroup, ident, "counter:%d", counter) 179 #define KTR_COUNTER1(m, egroup, ident, edat, a0, v0) \ 180 KTR_EVENT1(m, egroup, ident, "counter:%d", counter, a0, (v0)) 181 #define KTR_COUNTER2(m, egroup, ident, counter, a0, v0, a1, v1) \ 182 KTR_EVENT2(m, egroup, ident, "counter:%d", counter, a0, (v0), a1, (v1)) 183 #define KTR_COUNTER3(m, egroup, ident, counter, a0, v0, a1, v1, a2, v2) \ 184 KTR_EVENT3(m, egroup, ident, "counter:%d", \ 185 counter, a0, (v0), a1, (v1), a2, (v2)) 186 #define KTR_COUNTER4(m, egroup, ident, counter, a0, v0, a1, v1, a2, v2, a3, v3)\ 187 KTR_EVENT4(m, egroup, ident, "counter:%d", \ 188 counter, a0, (v0), a1, (v1), a2, (v2), a3, (v3)) 189 190 /* 191 * Point functions plot points of interest on counter or state graphs. 192 */ 193 #define KTR_POINT0(m, egroup, ident, point) \ 194 KTR_EVENT0(m, egroup, ident, "point:\"%s\"", point) 195 #define KTR_POINT1(m, egroup, ident, point, a0, v0) \ 196 KTR_EVENT1(m, egroup, ident, "point:\"%s\"", point, a0, (v0)) 197 #define KTR_POINT2(m, egroup, ident, point, a0, v0, a1, v1) \ 198 KTR_EVENT2(m, egroup, ident, "point:\"%s\"", point, a0, (v0), a1, (v1)) 199 #define KTR_POINT3(m, egroup, ident, point, a0, v0, a1, v1, a2, v2) \ 200 KTR_EVENT3(m, egroup, ident, "point:\"%s\"", point, \ 201 a0, (v0), a1, (v1), a2, (v2)) 202 #define KTR_POINT4(m, egroup, ident, point, a0, v0, a1, v1, a2, v2, a3, v3)\ 203 KTR_EVENT4(m, egroup, ident, "point:\"%s\"", \ 204 point, a0, (v0), a1, (v1), a2, (v2), a3, (v3)) 205 206 /* 207 * Start functions denote the start of a region of code or operation 208 * and should be paired with stop functions for timing of nested 209 * sequences. 210 * 211 * Specifying extra attributes with the name "key" will result in 212 * multi-part keys. For example a block device and offset pair 213 * might be used to describe a buf undergoing I/O. 214 */ 215 #define KTR_START0(m, egroup, ident, key) \ 216 KTR_EVENT0(m, egroup, ident, "start:0x%jX", (uintmax_t)key) 217 #define KTR_START1(m, egroup, ident, key, a0, v0) \ 218 KTR_EVENT1(m, egroup, ident, "start:0x%jX", (uintmax_t)key, a0, (v0)) 219 #define KTR_START2(m, egroup, ident, key, a0, v0, a1, v1) \ 220 KTR_EVENT2(m, egroup, ident, "start:0x%jX", (uintmax_t)key, \ 221 a0, (v0), a1, (v1)) 222 #define KTR_START3(m, egroup, ident, key, a0, v0, a1, v1, a2, v2)\ 223 KTR_EVENT3(m, egroup, ident, "start:0x%jX", (uintmax_t)key, \ 224 a0, (v0), a1, (v1), a2, (v2)) 225 #define KTR_START4(m, egroup, ident, key, \ 226 a0, v0, a1, v1, a2, v2, a3, v3) \ 227 KTR_EVENT4(m, egroup, ident, "start:0x%jX", (uintmax_t)key, \ 228 a0, (v0), a1, (v1), a2, (v2), a3, (v3)) 229 230 /* 231 * Stop functions denote the end of a region of code or operation 232 * and should be paired with start functions for timing of nested 233 * sequences. 234 */ 235 #define KTR_STOP0(m, egroup, ident, key) \ 236 KTR_EVENT0(m, egroup, ident, "stop:0x%jX", (uintmax_t)key) 237 #define KTR_STOP1(m, egroup, ident, key, a0, v0) \ 238 KTR_EVENT1(m, egroup, ident, "stop:0x%jX", (uintmax_t)key, a0, (v0)) 239 #define KTR_STOP2(m, egroup, ident, key, a0, v0, a1, v1) \ 240 KTR_EVENT2(m, egroup, ident, "stop:0x%jX", (uintmax_t)key, \ 241 a0, (v0), a1, (v1)) 242 #define KTR_STOP3(m, egroup, ident, key, a0, v0, a1, v1, a2, v2)\ 243 KTR_EVENT3(m, egroup, ident, "stop:0x%jX", (uintmax_t)key, \ 244 a0, (v0), a1, (v1), a2, (v2)) 245 #define KTR_STOP4(m, egroup, ident, \ 246 key, a0, v0, a1, v1, a2, v2, a3, v3) \ 247 KTR_EVENT4(m, egroup, ident, "stop:0x%jX", (uintmax_t)key, \ 248 a0, (v0), a1, (v1), a2, (v2), a3, (v3)) 249 250 /* 251 * Trace initialization events, similar to CTR with KTR_INIT, but 252 * completely ifdef'ed out if KTR_INIT isn't in KTR_COMPILE (to 253 * save string space, the compiler doesn't optimize out strings 254 * for the conditional ones above). 255 */ 256 #if (KTR_COMPILE & KTR_INIT) != 0 257 #define ITR0(d) CTR0(KTR_INIT, d) 258 #define ITR1(d, p1) CTR1(KTR_INIT, d, p1) 259 #define ITR2(d, p1, p2) CTR2(KTR_INIT, d, p1, p2) 260 #define ITR3(d, p1, p2, p3) CTR3(KTR_INIT, d, p1, p2, p3) 261 #define ITR4(d, p1, p2, p3, p4) CTR4(KTR_INIT, d, p1, p2, p3, p4) 262 #define ITR5(d, p1, p2, p3, p4, p5) CTR5(KTR_INIT, d, p1, p2, p3, p4, p5) 263 #define ITR6(d, p1, p2, p3, p4, p5, p6) CTR6(KTR_INIT, d, p1, p2, p3, p4, p5, p6) 264 #else 265 #define ITR0(d) 266 #define ITR1(d, p1) 267 #define ITR2(d, p1, p2) 268 #define ITR3(d, p1, p2, p3) 269 #define ITR4(d, p1, p2, p3, p4) 270 #define ITR5(d, p1, p2, p3, p4, p5) 271 #define ITR6(d, p1, p2, p3, p4, p5, p6) 272 #endif 273 274 #endif /* !LOCORE */ 275 276 #endif /* !_SYS_KTR_H_ */ 277