2 * Copyright (c) 2000 John Baldwin <jhb@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the author nor the names of any co-contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * This module holds the global variables used by KTR and the ktr_tracepoint()
32 * function that does the actual tracing.
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
42 #include <sys/param.h>
45 #include <sys/kernel.h>
47 #include <sys/libkern.h>
49 #include <sys/sysctl.h>
50 #include <sys/systm.h>
53 #include <machine/cpu.h>
55 #include <machine/ktr.h>
62 #define KTR_ENTRIES 1024
66 #define KTR_MASK (KTR_GEN)
70 #define KTR_CPUMASK (~0)
74 #define KTR_TIME get_cyclecount()
78 #define KTR_CPU PCPU_GET(cpuid)
81 SYSCTL_NODE(_debug, OID_AUTO, ktr, CTLFLAG_RD, 0, "KTR options");
83 int ktr_cpumask = KTR_CPUMASK;
84 TUNABLE_INT("debug.ktr.cpumask", &ktr_cpumask);
85 SYSCTL_INT(_debug_ktr, OID_AUTO, cpumask, CTLFLAG_RW, &ktr_cpumask, 0, "");
87 int ktr_mask = KTR_MASK;
88 TUNABLE_INT("debug.ktr.mask", &ktr_mask);
89 SYSCTL_INT(_debug_ktr, OID_AUTO, mask, CTLFLAG_RW, &ktr_mask, 0, "");
91 int ktr_entries = KTR_ENTRIES;
92 SYSCTL_INT(_debug_ktr, OID_AUTO, entries, CTLFLAG_RD, &ktr_entries, 0, "");
94 int ktr_version = KTR_VERSION;
95 SYSCTL_INT(_debug_ktr, OID_AUTO, version, CTLFLAG_RD, &ktr_version, 0, "");
97 volatile int ktr_idx = 0;
98 struct ktr_entry ktr_buf[KTR_ENTRIES];
101 int ktr_verbose = KTR_VERBOSE;
102 TUNABLE_INT("debug.ktr.verbose", &ktr_verbose);
103 SYSCTL_INT(_debug_ktr, OID_AUTO, verbose, CTLFLAG_RW, &ktr_verbose, 0, "");
108 char ktr_alq_file[MAXPATHLEN] = "/tmp/ktr.out";
110 int ktr_alq_depth = KTR_ENTRIES;
111 int ktr_alq_enabled = 0;
112 int ktr_alq_failed = 0;
115 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_max, CTLFLAG_RW, &ktr_alq_max, 0,
116 "Maximum number of entries to write");
117 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_cnt, CTLFLAG_RD, &ktr_alq_cnt, 0,
118 "Current number of written entries");
119 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_failed, CTLFLAG_RD, &ktr_alq_failed, 0,
120 "Number of times we overran the buffer");
121 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_depth, CTLFLAG_RW, &ktr_alq_depth, 0,
122 "Number of items in the write buffer");
123 SYSCTL_STRING(_debug_ktr, OID_AUTO, alq_file, CTLFLAG_RW, ktr_alq_file,
124 sizeof(ktr_alq_file), "KTR logging file");
127 sysctl_debug_ktr_alq_enable(SYSCTL_HANDLER_ARGS)
132 enable = ktr_alq_enabled;
134 error = sysctl_handle_int(oidp, &enable, 0, req);
135 if (error || !req->newptr)
141 error = suser(curthread);
144 error = alq_open(&ktr_alq, (const char *)ktr_alq_file,
145 req->td->td_ucred, sizeof(struct ktr_entry),
148 ktr_mask &= ~KTR_ALQ_MASK;
154 if (ktr_alq_enabled == 0)
163 SYSCTL_PROC(_debug_ktr, OID_AUTO, alq_enable,
164 CTLTYPE_INT|CTLFLAG_RW, 0, 0, sysctl_debug_ktr_alq_enable,
165 "I", "Enable KTR logging");
169 ktr_tracepoint(u_int mask, const char *file, int line, const char *format,
170 u_long arg1, u_long arg2, u_long arg3, u_long arg4, u_long arg5,
173 struct ktr_entry *entry;
175 struct ale *ale = NULL;
177 int newindex, saveindex;
179 #if defined(KTR_VERBOSE) || defined(KTR_ALQ)
186 if ((ktr_mask & mask) == 0)
189 if (((1 << cpu) & ktr_cpumask) == 0)
191 #if defined(KTR_VERBOSE) || defined(KTR_ALQ)
193 if (td->td_pflags & TDP_INKTR)
195 td->td_pflags |= TDP_INKTR;
198 if (ktr_alq_enabled &&
199 td->td_critnest == 0 &&
200 (td->td_flags & TDF_IDLETD) == 0 &&
202 if (ktr_alq_max && ktr_alq_cnt > ktr_alq_max)
204 if ((ale = alq_get(ktr_alq, ALQ_NOWAIT)) == NULL) {
209 entry = (struct ktr_entry *)ale->ae_data;
215 newindex = (saveindex + 1) & (KTR_ENTRIES - 1);
216 } while (atomic_cmpset_rel_int(&ktr_idx, saveindex, newindex) == 0);
217 entry = &ktr_buf[saveindex];
219 entry->ktr_timestamp = KTR_TIME;
220 entry->ktr_cpu = cpu;
222 while (strncmp(file, "../", 3) == 0)
224 entry->ktr_file = file;
225 entry->ktr_line = line;
229 printf("cpu%d ", cpu);
231 if (ktr_verbose > 1) {
232 printf("%s.%d\t", entry->ktr_file,
235 printf(format, arg1, arg2, arg3, arg4, arg5, arg6);
239 entry->ktr_desc = format;
240 entry->ktr_parms[0] = arg1;
241 entry->ktr_parms[1] = arg2;
242 entry->ktr_parms[2] = arg3;
243 entry->ktr_parms[3] = arg4;
244 entry->ktr_parms[4] = arg5;
245 entry->ktr_parms[5] = arg6;
248 alq_post(ktr_alq, ale);
251 #if defined(KTR_VERBOSE) || defined(KTR_ALQ)
252 td->td_pflags &= ~TDP_INKTR;
262 static struct tstate tstate;
263 static int db_ktr_verbose;
264 static int db_mach_vtrace(void);
266 #define NUM_LINES_PER_PAGE 18
268 DB_SHOW_COMMAND(ktr, db_ktr_all)
273 tstate.cur = (ktr_idx - 1) & (KTR_ENTRIES - 1);
275 if (strcmp(modif, "v") == 0)
279 if (strcmp(modif, "a") == 0) {
280 while (cncheckc() != -1)
281 if (db_mach_vtrace() == 0)
284 db_setup_paging(db_simple_pager, &quit, DB_LINES_PER_PAGE);
286 if (db_mach_vtrace() == 0)
294 struct ktr_entry *kp;
296 if (tstate.cur == tstate.first) {
297 db_printf("--- End of trace buffer ---\n");
300 kp = &ktr_buf[tstate.cur];
302 /* Skip over unused entries. */
303 if (kp->ktr_desc == NULL) {
304 db_printf("--- End of trace buffer ---\n");
307 db_printf("%d: ", tstate.cur);
309 db_printf("cpu%d ", kp->ktr_cpu);
311 if (db_ktr_verbose) {
312 db_printf("%10.10lld %s.%d\t", (long long)kp->ktr_timestamp,
313 kp->ktr_file, kp->ktr_line);
315 db_printf(kp->ktr_desc, kp->ktr_parms[0], kp->ktr_parms[1],
316 kp->ktr_parms[2], kp->ktr_parms[3], kp->ktr_parms[4],
320 if (tstate.first == -1)
321 tstate.first = tstate.cur;
323 if (--tstate.cur < 0)
324 tstate.cur = KTR_ENTRIES - 1;