2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2000 John Baldwin <jhb@FreeBSD.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * This module holds the global variables used by KTR and the ktr_tracepoint()
30 * function that does the actual tracing.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
40 #include <sys/param.h>
41 #include <sys/queue.h>
44 #include <sys/cpuset.h>
46 #include <sys/kernel.h>
48 #include <sys/libkern.h>
50 #include <sys/malloc.h>
51 #include <sys/mutex.h>
54 #include <sys/sysctl.h>
55 #include <sys/systm.h>
58 #include <machine/cpu.h>
62 #include <ddb/db_output.h>
65 #ifndef KTR_BOOT_ENTRIES
66 #define KTR_BOOT_ENTRIES 1024
70 #define KTR_ENTRIES 1024
73 /* Limit the allocations to something manageable. */
74 #define KTR_ENTRIES_MAX (8 * 1024 * 1024)
81 #define KTR_CPUMASK CPUSET_FSET
85 #define KTR_TIME get_cyclecount()
89 #define KTR_CPU PCPU_GET(cpuid)
92 static MALLOC_DEFINE(M_KTR, "KTR", "KTR");
94 FEATURE(ktr, "Kernel support for KTR kernel tracing facility");
96 volatile int ktr_idx = 0;
97 uint64_t ktr_mask = KTR_MASK;
98 uint64_t ktr_compile = KTR_COMPILE;
99 int ktr_entries = KTR_BOOT_ENTRIES;
100 int ktr_version = KTR_VERSION;
101 struct ktr_entry ktr_buf_init[KTR_BOOT_ENTRIES];
102 struct ktr_entry *ktr_buf = ktr_buf_init;
103 cpuset_t ktr_cpumask = CPUSET_T_INITIALIZER(KTR_CPUMASK);
105 static SYSCTL_NODE(_debug, OID_AUTO, ktr, CTLFLAG_RD, 0, "KTR options");
107 SYSCTL_INT(_debug_ktr, OID_AUTO, version, CTLFLAG_RD,
108 &ktr_version, 0, "Version of the KTR interface");
110 SYSCTL_UQUAD(_debug_ktr, OID_AUTO, compile, CTLFLAG_RD,
111 &ktr_compile, 0, "Bitmask of KTR event classes compiled into the kernel");
114 sysctl_debug_ktr_cpumask(SYSCTL_HANDLER_ARGS)
116 char lktr_cpumask_str[CPUSETBUFSIZ];
120 cpusetobj_strprint(lktr_cpumask_str, &ktr_cpumask);
121 error = sysctl_handle_string(oidp, lktr_cpumask_str,
122 sizeof(lktr_cpumask_str), req);
123 if (error != 0 || req->newptr == NULL)
125 if (cpusetobj_strscan(&imask, lktr_cpumask_str) == -1)
127 CPU_COPY(&imask, &ktr_cpumask);
131 SYSCTL_PROC(_debug_ktr, OID_AUTO, cpumask,
132 CTLFLAG_RWTUN | CTLFLAG_MPSAFE | CTLTYPE_STRING, NULL, 0,
133 sysctl_debug_ktr_cpumask, "S",
134 "Bitmask of CPUs on which KTR logging is enabled");
137 sysctl_debug_ktr_clear(SYSCTL_HANDLER_ARGS)
142 error = sysctl_handle_int(oidp, &clear, 0, req);
143 if (error || !req->newptr)
147 bzero(ktr_buf, sizeof(*ktr_buf) * ktr_entries);
153 SYSCTL_PROC(_debug_ktr, OID_AUTO, clear, CTLTYPE_INT|CTLFLAG_RW, 0, 0,
154 sysctl_debug_ktr_clear, "I", "Clear KTR Buffer");
157 * This is a sysctl proc so that it is serialized as !MPSAFE along with
158 * the other ktr sysctl procs.
161 sysctl_debug_ktr_mask(SYSCTL_HANDLER_ARGS)
167 error = sysctl_handle_64(oidp, &mask, 0, req);
168 if (error || !req->newptr)
174 SYSCTL_PROC(_debug_ktr, OID_AUTO, mask, CTLTYPE_U64 | CTLFLAG_RWTUN, 0, 0,
175 sysctl_debug_ktr_mask, "QU",
176 "Bitmask of KTR event classes for which logging is enabled");
178 #if KTR_ENTRIES > KTR_BOOT_ENTRIES
180 * A simplified version of sysctl_debug_ktr_entries.
181 * No need to care about SMP, scheduling, etc.
184 ktr_entries_initializer(void *dummy __unused)
188 /* Temporarily disable ktr in case malloc() is being traced. */
191 ktr_buf = malloc(sizeof(*ktr_buf) * KTR_ENTRIES, M_KTR,
193 memcpy(ktr_buf, ktr_buf_init + ktr_idx,
194 (KTR_BOOT_ENTRIES - ktr_idx) * sizeof(*ktr_buf));
196 memcpy(ktr_buf + KTR_BOOT_ENTRIES - ktr_idx, ktr_buf_init,
197 ktr_idx * sizeof(*ktr_buf));
198 ktr_idx = KTR_BOOT_ENTRIES;
200 ktr_entries = KTR_ENTRIES;
203 SYSINIT(ktr_entries_initializer, SI_SUB_KMEM, SI_ORDER_ANY,
204 ktr_entries_initializer, NULL);
208 sysctl_debug_ktr_entries(SYSCTL_HANDLER_ARGS)
212 struct ktr_entry *buf, *oldbuf;
214 entries = ktr_entries;
215 error = sysctl_handle_int(oidp, &entries, 0, req);
216 if (error || !req->newptr)
218 if (entries > KTR_ENTRIES_MAX)
220 /* Disable ktr temporarily. */
223 /* Wait for threads to go idle. */
224 if ((error = quiesce_all_cpus("ktrent", PCATCH)) != 0) {
228 if (ktr_buf != ktr_buf_init)
232 /* Allocate a new buffer. */
233 buf = malloc(sizeof(*buf) * entries, M_KTR, M_WAITOK | M_ZERO);
234 /* Install the new buffer and restart ktr. */
236 ktr_entries = entries;
245 SYSCTL_PROC(_debug_ktr, OID_AUTO, entries, CTLTYPE_INT|CTLFLAG_RW, 0, 0,
246 sysctl_debug_ktr_entries, "I", "Number of entries in the KTR buffer");
249 int ktr_verbose = KTR_VERBOSE;
250 TUNABLE_INT("debug.ktr.verbose", &ktr_verbose);
251 SYSCTL_INT(_debug_ktr, OID_AUTO, verbose, CTLFLAG_RW, &ktr_verbose, 0, "");
256 char ktr_alq_file[MAXPATHLEN] = "/tmp/ktr.out";
258 int ktr_alq_depth = KTR_ENTRIES;
259 int ktr_alq_enabled = 0;
260 int ktr_alq_failed = 0;
263 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_max, CTLFLAG_RW, &ktr_alq_max, 0,
264 "Maximum number of entries to write");
265 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_cnt, CTLFLAG_RD, &ktr_alq_cnt, 0,
266 "Current number of written entries");
267 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_failed, CTLFLAG_RD, &ktr_alq_failed, 0,
268 "Number of times we overran the buffer");
269 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_depth, CTLFLAG_RW, &ktr_alq_depth, 0,
270 "Number of items in the write buffer");
271 SYSCTL_STRING(_debug_ktr, OID_AUTO, alq_file, CTLFLAG_RW, ktr_alq_file,
272 sizeof(ktr_alq_file), "KTR logging file");
275 sysctl_debug_ktr_alq_enable(SYSCTL_HANDLER_ARGS)
280 enable = ktr_alq_enabled;
282 error = sysctl_handle_int(oidp, &enable, 0, req);
283 if (error || !req->newptr)
289 error = alq_open(&ktr_alq, (const char *)ktr_alq_file,
290 req->td->td_ucred, ALQ_DEFAULT_CMODE,
291 sizeof(struct ktr_entry), ktr_alq_depth);
298 if (ktr_alq_enabled == 0)
307 SYSCTL_PROC(_debug_ktr, OID_AUTO, alq_enable,
308 CTLTYPE_INT|CTLFLAG_RW, 0, 0, sysctl_debug_ktr_alq_enable,
309 "I", "Enable KTR logging");
313 ktr_tracepoint(uint64_t mask, const char *file, int line, const char *format,
314 u_long arg1, u_long arg2, u_long arg3, u_long arg4, u_long arg5,
317 struct ktr_entry *entry;
319 struct ale *ale = NULL;
321 int newindex, saveindex;
322 #if defined(KTR_VERBOSE) || defined(KTR_ALQ)
327 if (panicstr || kdb_active)
329 if ((ktr_mask & mask) == 0 || ktr_buf == NULL)
332 if (!CPU_ISSET(cpu, &ktr_cpumask))
334 #if defined(KTR_VERBOSE) || defined(KTR_ALQ)
336 if (td->td_pflags & TDP_INKTR)
338 td->td_pflags |= TDP_INKTR;
341 if (ktr_alq_enabled) {
342 if (td->td_critnest == 0 &&
343 (TD_IS_IDLETHREAD(td)) == 0 &&
345 if (ktr_alq_max && ktr_alq_cnt > ktr_alq_max)
347 if ((ale = alq_get(ktr_alq, ALQ_NOWAIT)) == NULL) {
352 entry = (struct ktr_entry *)ale->ae_data;
361 newindex = (saveindex + 1) % ktr_entries;
362 } while (atomic_cmpset_rel_int(&ktr_idx, saveindex, newindex) == 0);
363 entry = &ktr_buf[saveindex];
365 entry->ktr_timestamp = KTR_TIME;
366 entry->ktr_cpu = cpu;
367 entry->ktr_thread = curthread;
369 while (strncmp(file, "../", 3) == 0)
371 entry->ktr_file = file;
372 entry->ktr_line = line;
376 printf("cpu%d ", cpu);
378 if (ktr_verbose > 1) {
379 printf("%s.%d\t", entry->ktr_file,
382 printf(format, arg1, arg2, arg3, arg4, arg5, arg6);
386 entry->ktr_desc = format;
387 entry->ktr_parms[0] = arg1;
388 entry->ktr_parms[1] = arg2;
389 entry->ktr_parms[2] = arg3;
390 entry->ktr_parms[3] = arg4;
391 entry->ktr_parms[4] = arg5;
392 entry->ktr_parms[5] = arg6;
394 if (ktr_alq_enabled && ale)
395 alq_post(ktr_alq, ale);
398 #if defined(KTR_VERBOSE) || defined(KTR_ALQ)
399 td->td_pflags &= ~TDP_INKTR;
409 static struct tstate tstate;
410 static int db_ktr_verbose;
411 static int db_mach_vtrace(void);
413 DB_SHOW_COMMAND(ktr, db_ktr_all)
416 tstate.cur = (ktr_idx - 1) % ktr_entries;
419 db_ktr_verbose |= (strchr(modif, 'v') != NULL) ? 2 : 0;
420 db_ktr_verbose |= (strchr(modif, 'V') != NULL) ? 1 : 0; /* just timestamp please */
421 if (strchr(modif, 'a') != NULL) {
423 while (cncheckc() == -1)
424 if (db_mach_vtrace() == 0)
427 while (!db_pager_quit)
428 if (db_mach_vtrace() == 0)
436 struct ktr_entry *kp;
438 if (tstate.cur == tstate.first || ktr_buf == NULL) {
439 db_printf("--- End of trace buffer ---\n");
442 kp = &ktr_buf[tstate.cur];
444 /* Skip over unused entries. */
445 if (kp->ktr_desc == NULL) {
446 db_printf("--- End of trace buffer ---\n");
449 db_printf("%d (%p", tstate.cur, kp->ktr_thread);
451 db_printf(":cpu%d", kp->ktr_cpu);
454 if (db_ktr_verbose >= 1) {
455 db_printf(" %10.10lld", (long long)kp->ktr_timestamp);
457 if (db_ktr_verbose >= 2) {
458 db_printf(" %s.%d", kp->ktr_file, kp->ktr_line);
461 db_printf(kp->ktr_desc, kp->ktr_parms[0], kp->ktr_parms[1],
462 kp->ktr_parms[2], kp->ktr_parms[3], kp->ktr_parms[4],
466 if (tstate.first == -1)
467 tstate.first = tstate.cur;
469 if (--tstate.cur < 0)
470 tstate.cur = ktr_entries - 1;