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.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * This module holds the global variables used by KTR and the ktr_tracepoint()
29 * function that does the actual tracing.
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
39 #include <sys/param.h>
40 #include <sys/queue.h>
43 #include <sys/cpuset.h>
45 #include <sys/kernel.h>
47 #include <sys/libkern.h>
49 #include <sys/malloc.h>
50 #include <sys/mutex.h>
53 #include <sys/sysctl.h>
54 #include <sys/systm.h>
57 #include <machine/cpu.h>
61 #include <ddb/db_output.h>
64 #ifndef KTR_BOOT_ENTRIES
65 #define KTR_BOOT_ENTRIES 1024
69 #define KTR_ENTRIES 1024
72 /* Limit the allocations to something manageable. */
73 #define KTR_ENTRIES_MAX (8 * 1024 * 1024)
80 #define KTR_CPUMASK CPUSET_FSET
84 #define KTR_TIME get_cyclecount()
88 #define KTR_CPU PCPU_GET(cpuid)
91 static MALLOC_DEFINE(M_KTR, "KTR", "KTR");
93 FEATURE(ktr, "Kernel support for KTR kernel tracing facility");
95 volatile int ktr_idx = 0;
96 uint64_t ktr_mask = KTR_MASK;
97 uint64_t ktr_compile = KTR_COMPILE;
98 int ktr_entries = KTR_BOOT_ENTRIES;
99 int ktr_version = KTR_VERSION;
100 struct ktr_entry ktr_buf_init[KTR_BOOT_ENTRIES];
101 struct ktr_entry *ktr_buf = ktr_buf_init;
102 cpuset_t ktr_cpumask = CPUSET_T_INITIALIZER(KTR_CPUMASK);
104 static SYSCTL_NODE(_debug, OID_AUTO, ktr, CTLFLAG_RD, 0, "KTR options");
106 SYSCTL_INT(_debug_ktr, OID_AUTO, version, CTLFLAG_RD,
107 &ktr_version, 0, "Version of the KTR interface");
109 SYSCTL_UQUAD(_debug_ktr, OID_AUTO, compile, CTLFLAG_RD,
110 &ktr_compile, 0, "Bitmask of KTR event classes compiled into the kernel");
113 sysctl_debug_ktr_cpumask(SYSCTL_HANDLER_ARGS)
115 char lktr_cpumask_str[CPUSETBUFSIZ];
119 cpusetobj_strprint(lktr_cpumask_str, &ktr_cpumask);
120 error = sysctl_handle_string(oidp, lktr_cpumask_str,
121 sizeof(lktr_cpumask_str), req);
122 if (error != 0 || req->newptr == NULL)
124 if (cpusetobj_strscan(&imask, lktr_cpumask_str) == -1)
126 CPU_COPY(&imask, &ktr_cpumask);
130 SYSCTL_PROC(_debug_ktr, OID_AUTO, cpumask,
131 CTLFLAG_RWTUN | CTLFLAG_MPSAFE | CTLTYPE_STRING, NULL, 0,
132 sysctl_debug_ktr_cpumask, "S",
133 "Bitmask of CPUs on which KTR logging is enabled");
136 sysctl_debug_ktr_clear(SYSCTL_HANDLER_ARGS)
141 error = sysctl_handle_int(oidp, &clear, 0, req);
142 if (error || !req->newptr)
146 bzero(ktr_buf, sizeof(*ktr_buf) * ktr_entries);
152 SYSCTL_PROC(_debug_ktr, OID_AUTO, clear, CTLTYPE_INT|CTLFLAG_RW, 0, 0,
153 sysctl_debug_ktr_clear, "I", "Clear KTR Buffer");
156 * This is a sysctl proc so that it is serialized as !MPSAFE along with
157 * the other ktr sysctl procs.
160 sysctl_debug_ktr_mask(SYSCTL_HANDLER_ARGS)
166 error = sysctl_handle_64(oidp, &mask, 0, req);
167 if (error || !req->newptr)
173 SYSCTL_PROC(_debug_ktr, OID_AUTO, mask, CTLTYPE_U64 | CTLFLAG_RWTUN, 0, 0,
174 sysctl_debug_ktr_mask, "QU",
175 "Bitmask of KTR event classes for which logging is enabled");
177 #if KTR_ENTRIES > KTR_BOOT_ENTRIES
179 * A simplified version of sysctl_debug_ktr_entries.
180 * No need to care about SMP, scheduling, etc.
183 ktr_entries_initializer(void *dummy __unused)
187 /* Temporarily disable ktr in case malloc() is being traced. */
190 ktr_buf = malloc(sizeof(*ktr_buf) * KTR_ENTRIES, M_KTR,
192 memcpy(ktr_buf, ktr_buf_init + ktr_idx,
193 (KTR_BOOT_ENTRIES - ktr_idx) * sizeof(*ktr_buf));
195 memcpy(ktr_buf + KTR_BOOT_ENTRIES - ktr_idx, ktr_buf_init,
196 ktr_idx * sizeof(*ktr_buf));
197 ktr_idx = KTR_BOOT_ENTRIES;
199 ktr_entries = KTR_ENTRIES;
202 SYSINIT(ktr_entries_initializer, SI_SUB_KMEM, SI_ORDER_ANY,
203 ktr_entries_initializer, NULL);
207 sysctl_debug_ktr_entries(SYSCTL_HANDLER_ARGS)
211 struct ktr_entry *buf, *oldbuf;
213 entries = ktr_entries;
214 error = sysctl_handle_int(oidp, &entries, 0, req);
215 if (error || !req->newptr)
217 if (entries > KTR_ENTRIES_MAX)
219 /* Disable ktr temporarily. */
222 /* Wait for threads to go idle. */
223 if ((error = quiesce_all_cpus("ktrent", PCATCH)) != 0) {
227 if (ktr_buf != ktr_buf_init)
231 /* Allocate a new buffer. */
232 buf = malloc(sizeof(*buf) * entries, M_KTR, M_WAITOK | M_ZERO);
233 /* Install the new buffer and restart ktr. */
235 ktr_entries = entries;
244 SYSCTL_PROC(_debug_ktr, OID_AUTO, entries, CTLTYPE_INT|CTLFLAG_RW, 0, 0,
245 sysctl_debug_ktr_entries, "I", "Number of entries in the KTR buffer");
248 int ktr_verbose = KTR_VERBOSE;
249 TUNABLE_INT("debug.ktr.verbose", &ktr_verbose);
250 SYSCTL_INT(_debug_ktr, OID_AUTO, verbose, CTLFLAG_RW, &ktr_verbose, 0, "");
255 char ktr_alq_file[MAXPATHLEN] = "/tmp/ktr.out";
257 int ktr_alq_depth = KTR_ENTRIES;
258 int ktr_alq_enabled = 0;
259 int ktr_alq_failed = 0;
262 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_max, CTLFLAG_RW, &ktr_alq_max, 0,
263 "Maximum number of entries to write");
264 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_cnt, CTLFLAG_RD, &ktr_alq_cnt, 0,
265 "Current number of written entries");
266 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_failed, CTLFLAG_RD, &ktr_alq_failed, 0,
267 "Number of times we overran the buffer");
268 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_depth, CTLFLAG_RW, &ktr_alq_depth, 0,
269 "Number of items in the write buffer");
270 SYSCTL_STRING(_debug_ktr, OID_AUTO, alq_file, CTLFLAG_RW, ktr_alq_file,
271 sizeof(ktr_alq_file), "KTR logging file");
274 sysctl_debug_ktr_alq_enable(SYSCTL_HANDLER_ARGS)
279 enable = ktr_alq_enabled;
281 error = sysctl_handle_int(oidp, &enable, 0, req);
282 if (error || !req->newptr)
288 error = alq_open(&ktr_alq, (const char *)ktr_alq_file,
289 req->td->td_ucred, ALQ_DEFAULT_CMODE,
290 sizeof(struct ktr_entry), ktr_alq_depth);
297 if (ktr_alq_enabled == 0)
306 SYSCTL_PROC(_debug_ktr, OID_AUTO, alq_enable,
307 CTLTYPE_INT|CTLFLAG_RW, 0, 0, sysctl_debug_ktr_alq_enable,
308 "I", "Enable KTR logging");
312 ktr_tracepoint(uint64_t mask, const char *file, int line, const char *format,
313 u_long arg1, u_long arg2, u_long arg3, u_long arg4, u_long arg5,
316 struct ktr_entry *entry;
318 struct ale *ale = NULL;
320 int newindex, saveindex;
321 #if defined(KTR_VERBOSE) || defined(KTR_ALQ)
326 if (panicstr || kdb_active)
328 if ((ktr_mask & mask) == 0 || ktr_buf == NULL)
331 if (!CPU_ISSET(cpu, &ktr_cpumask))
333 #if defined(KTR_VERBOSE) || defined(KTR_ALQ)
335 if (td->td_pflags & TDP_INKTR)
337 td->td_pflags |= TDP_INKTR;
340 if (ktr_alq_enabled) {
341 if (td->td_critnest == 0 &&
342 (td->td_flags & TDF_IDLETD) == 0 &&
344 if (ktr_alq_max && ktr_alq_cnt > ktr_alq_max)
346 if ((ale = alq_get(ktr_alq, ALQ_NOWAIT)) == NULL) {
351 entry = (struct ktr_entry *)ale->ae_data;
360 newindex = (saveindex + 1) % ktr_entries;
361 } while (atomic_cmpset_rel_int(&ktr_idx, saveindex, newindex) == 0);
362 entry = &ktr_buf[saveindex];
364 entry->ktr_timestamp = KTR_TIME;
365 entry->ktr_cpu = cpu;
366 entry->ktr_thread = curthread;
368 while (strncmp(file, "../", 3) == 0)
370 entry->ktr_file = file;
371 entry->ktr_line = line;
375 printf("cpu%d ", cpu);
377 if (ktr_verbose > 1) {
378 printf("%s.%d\t", entry->ktr_file,
381 printf(format, arg1, arg2, arg3, arg4, arg5, arg6);
385 entry->ktr_desc = format;
386 entry->ktr_parms[0] = arg1;
387 entry->ktr_parms[1] = arg2;
388 entry->ktr_parms[2] = arg3;
389 entry->ktr_parms[3] = arg4;
390 entry->ktr_parms[4] = arg5;
391 entry->ktr_parms[5] = arg6;
393 if (ktr_alq_enabled && ale)
394 alq_post(ktr_alq, ale);
397 #if defined(KTR_VERBOSE) || defined(KTR_ALQ)
398 td->td_pflags &= ~TDP_INKTR;
408 static struct tstate tstate;
409 static int db_ktr_verbose;
410 static int db_mach_vtrace(void);
412 DB_SHOW_COMMAND(ktr, db_ktr_all)
415 tstate.cur = (ktr_idx - 1) % ktr_entries;
418 db_ktr_verbose |= (strchr(modif, 'v') != NULL) ? 2 : 0;
419 db_ktr_verbose |= (strchr(modif, 'V') != NULL) ? 1 : 0; /* just timestap please */
420 if (strchr(modif, 'a') != NULL) {
422 while (cncheckc() == -1)
423 if (db_mach_vtrace() == 0)
426 while (!db_pager_quit)
427 if (db_mach_vtrace() == 0)
435 struct ktr_entry *kp;
437 if (tstate.cur == tstate.first || ktr_buf == NULL) {
438 db_printf("--- End of trace buffer ---\n");
441 kp = &ktr_buf[tstate.cur];
443 /* Skip over unused entries. */
444 if (kp->ktr_desc == NULL) {
445 db_printf("--- End of trace buffer ---\n");
448 db_printf("%d (%p", tstate.cur, kp->ktr_thread);
450 db_printf(":cpu%d", kp->ktr_cpu);
453 if (db_ktr_verbose >= 1) {
454 db_printf(" %10.10lld", (long long)kp->ktr_timestamp);
456 if (db_ktr_verbose >= 2) {
457 db_printf(" %s.%d", kp->ktr_file, kp->ktr_line);
460 db_printf(kp->ktr_desc, kp->ktr_parms[0], kp->ktr_parms[1],
461 kp->ktr_parms[2], kp->ktr_parms[3], kp->ktr_parms[4],
465 if (tstate.first == -1)
466 tstate.first = tstate.cur;
468 if (--tstate.cur < 0)
469 tstate.cur = ktr_entries - 1;