2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2000 John Baldwin <jhb@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 THE AUTHOR OR CONTRIBUTORS 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
30 * This module holds the global variables used by KTR and the ktr_tracepoint()
31 * function that does the actual tracing.
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
41 #include <sys/param.h>
42 #include <sys/queue.h>
45 #include <sys/cpuset.h>
47 #include <sys/kernel.h>
49 #include <sys/libkern.h>
51 #include <sys/malloc.h>
52 #include <sys/mutex.h>
55 #include <sys/sysctl.h>
56 #include <sys/systm.h>
59 #include <machine/cpu.h>
63 #include <ddb/db_output.h>
66 #ifndef KTR_BOOT_ENTRIES
67 #define KTR_BOOT_ENTRIES 1024
71 #define KTR_ENTRIES 1024
74 /* Limit the allocations to something manageable. */
75 #define KTR_ENTRIES_MAX (8 * 1024 * 1024)
82 #define KTR_CPUMASK CPUSET_FSET
86 #define KTR_TIME get_cyclecount()
90 #define KTR_CPU PCPU_GET(cpuid)
93 static MALLOC_DEFINE(M_KTR, "KTR", "KTR");
95 FEATURE(ktr, "Kernel support for KTR kernel tracing facility");
97 volatile int ktr_idx = 0;
98 uint64_t ktr_mask = KTR_MASK;
99 uint64_t ktr_compile = KTR_COMPILE;
100 int ktr_entries = KTR_BOOT_ENTRIES;
101 int ktr_version = KTR_VERSION;
102 struct ktr_entry ktr_buf_init[KTR_BOOT_ENTRIES];
103 struct ktr_entry *ktr_buf = ktr_buf_init;
104 cpuset_t ktr_cpumask = CPUSET_T_INITIALIZER(KTR_CPUMASK);
106 static SYSCTL_NODE(_debug, OID_AUTO, ktr, CTLFLAG_RD, 0, "KTR options");
108 SYSCTL_INT(_debug_ktr, OID_AUTO, version, CTLFLAG_RD,
109 &ktr_version, 0, "Version of the KTR interface");
111 SYSCTL_UQUAD(_debug_ktr, OID_AUTO, compile, CTLFLAG_RD,
112 &ktr_compile, 0, "Bitmask of KTR event classes compiled into the kernel");
115 sysctl_debug_ktr_cpumask(SYSCTL_HANDLER_ARGS)
117 char lktr_cpumask_str[CPUSETBUFSIZ];
121 cpusetobj_strprint(lktr_cpumask_str, &ktr_cpumask);
122 error = sysctl_handle_string(oidp, lktr_cpumask_str,
123 sizeof(lktr_cpumask_str), req);
124 if (error != 0 || req->newptr == NULL)
126 if (cpusetobj_strscan(&imask, lktr_cpumask_str) == -1)
128 CPU_COPY(&imask, &ktr_cpumask);
132 SYSCTL_PROC(_debug_ktr, OID_AUTO, cpumask,
133 CTLFLAG_RWTUN | CTLFLAG_MPSAFE | CTLTYPE_STRING, NULL, 0,
134 sysctl_debug_ktr_cpumask, "S",
135 "Bitmask of CPUs on which KTR logging is enabled");
138 sysctl_debug_ktr_clear(SYSCTL_HANDLER_ARGS)
143 error = sysctl_handle_int(oidp, &clear, 0, req);
144 if (error || !req->newptr)
148 bzero(ktr_buf, sizeof(*ktr_buf) * ktr_entries);
154 SYSCTL_PROC(_debug_ktr, OID_AUTO, clear, CTLTYPE_INT|CTLFLAG_RW, 0, 0,
155 sysctl_debug_ktr_clear, "I", "Clear KTR Buffer");
158 * This is a sysctl proc so that it is serialized as !MPSAFE along with
159 * the other ktr sysctl procs.
162 sysctl_debug_ktr_mask(SYSCTL_HANDLER_ARGS)
168 error = sysctl_handle_64(oidp, &mask, 0, req);
169 if (error || !req->newptr)
175 SYSCTL_PROC(_debug_ktr, OID_AUTO, mask, CTLTYPE_U64 | CTLFLAG_RWTUN, 0, 0,
176 sysctl_debug_ktr_mask, "QU",
177 "Bitmask of KTR event classes for which logging is enabled");
179 #if KTR_ENTRIES > KTR_BOOT_ENTRIES
181 * A simplified version of sysctl_debug_ktr_entries.
182 * No need to care about SMP, scheduling, etc.
185 ktr_entries_initializer(void *dummy __unused)
189 /* Temporarily disable ktr in case malloc() is being traced. */
192 ktr_buf = malloc(sizeof(*ktr_buf) * KTR_ENTRIES, M_KTR,
194 memcpy(ktr_buf, ktr_buf_init + ktr_idx,
195 (KTR_BOOT_ENTRIES - ktr_idx) * sizeof(*ktr_buf));
197 memcpy(ktr_buf + KTR_BOOT_ENTRIES - ktr_idx, ktr_buf_init,
198 ktr_idx * sizeof(*ktr_buf));
199 ktr_idx = KTR_BOOT_ENTRIES;
201 ktr_entries = KTR_ENTRIES;
204 SYSINIT(ktr_entries_initializer, SI_SUB_KMEM, SI_ORDER_ANY,
205 ktr_entries_initializer, NULL);
209 sysctl_debug_ktr_entries(SYSCTL_HANDLER_ARGS)
213 struct ktr_entry *buf, *oldbuf;
215 entries = ktr_entries;
216 error = sysctl_handle_int(oidp, &entries, 0, req);
217 if (error || !req->newptr)
219 if (entries > KTR_ENTRIES_MAX)
221 /* Disable ktr temporarily. */
224 /* Wait for threads to go idle. */
225 if ((error = quiesce_all_cpus("ktrent", PCATCH)) != 0) {
229 if (ktr_buf != ktr_buf_init)
233 /* Allocate a new buffer. */
234 buf = malloc(sizeof(*buf) * entries, M_KTR, M_WAITOK | M_ZERO);
235 /* Install the new buffer and restart ktr. */
237 ktr_entries = entries;
246 SYSCTL_PROC(_debug_ktr, OID_AUTO, entries, CTLTYPE_INT|CTLFLAG_RW, 0, 0,
247 sysctl_debug_ktr_entries, "I", "Number of entries in the KTR buffer");
250 int ktr_verbose = KTR_VERBOSE;
251 TUNABLE_INT("debug.ktr.verbose", &ktr_verbose);
252 SYSCTL_INT(_debug_ktr, OID_AUTO, verbose, CTLFLAG_RW, &ktr_verbose, 0, "");
257 char ktr_alq_file[MAXPATHLEN] = "/tmp/ktr.out";
259 int ktr_alq_depth = KTR_ENTRIES;
260 int ktr_alq_enabled = 0;
261 int ktr_alq_failed = 0;
264 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_max, CTLFLAG_RW, &ktr_alq_max, 0,
265 "Maximum number of entries to write");
266 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_cnt, CTLFLAG_RD, &ktr_alq_cnt, 0,
267 "Current number of written entries");
268 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_failed, CTLFLAG_RD, &ktr_alq_failed, 0,
269 "Number of times we overran the buffer");
270 SYSCTL_INT(_debug_ktr, OID_AUTO, alq_depth, CTLFLAG_RW, &ktr_alq_depth, 0,
271 "Number of items in the write buffer");
272 SYSCTL_STRING(_debug_ktr, OID_AUTO, alq_file, CTLFLAG_RW, ktr_alq_file,
273 sizeof(ktr_alq_file), "KTR logging file");
276 sysctl_debug_ktr_alq_enable(SYSCTL_HANDLER_ARGS)
281 enable = ktr_alq_enabled;
283 error = sysctl_handle_int(oidp, &enable, 0, req);
284 if (error || !req->newptr)
290 error = alq_open(&ktr_alq, (const char *)ktr_alq_file,
291 req->td->td_ucred, ALQ_DEFAULT_CMODE,
292 sizeof(struct ktr_entry), ktr_alq_depth);
299 if (ktr_alq_enabled == 0)
308 SYSCTL_PROC(_debug_ktr, OID_AUTO, alq_enable,
309 CTLTYPE_INT|CTLFLAG_RW, 0, 0, sysctl_debug_ktr_alq_enable,
310 "I", "Enable KTR logging");
314 ktr_tracepoint(uint64_t mask, const char *file, int line, const char *format,
315 u_long arg1, u_long arg2, u_long arg3, u_long arg4, u_long arg5,
318 struct ktr_entry *entry;
320 struct ale *ale = NULL;
322 int newindex, saveindex;
323 #if defined(KTR_VERBOSE) || defined(KTR_ALQ)
328 if (panicstr || kdb_active)
330 if ((ktr_mask & mask) == 0 || ktr_buf == NULL)
333 if (!CPU_ISSET(cpu, &ktr_cpumask))
335 #if defined(KTR_VERBOSE) || defined(KTR_ALQ)
337 if (td->td_pflags & TDP_INKTR)
339 td->td_pflags |= TDP_INKTR;
342 if (ktr_alq_enabled) {
343 if (td->td_critnest == 0 &&
344 (td->td_flags & TDF_IDLETD) == 0 &&
346 if (ktr_alq_max && ktr_alq_cnt > ktr_alq_max)
348 if ((ale = alq_get(ktr_alq, ALQ_NOWAIT)) == NULL) {
353 entry = (struct ktr_entry *)ale->ae_data;
362 newindex = (saveindex + 1) % ktr_entries;
363 } while (atomic_cmpset_rel_int(&ktr_idx, saveindex, newindex) == 0);
364 entry = &ktr_buf[saveindex];
366 entry->ktr_timestamp = KTR_TIME;
367 entry->ktr_cpu = cpu;
368 entry->ktr_thread = curthread;
370 while (strncmp(file, "../", 3) == 0)
372 entry->ktr_file = file;
373 entry->ktr_line = line;
377 printf("cpu%d ", cpu);
379 if (ktr_verbose > 1) {
380 printf("%s.%d\t", entry->ktr_file,
383 printf(format, arg1, arg2, arg3, arg4, arg5, arg6);
387 entry->ktr_desc = format;
388 entry->ktr_parms[0] = arg1;
389 entry->ktr_parms[1] = arg2;
390 entry->ktr_parms[2] = arg3;
391 entry->ktr_parms[3] = arg4;
392 entry->ktr_parms[4] = arg5;
393 entry->ktr_parms[5] = arg6;
395 if (ktr_alq_enabled && ale)
396 alq_post(ktr_alq, ale);
399 #if defined(KTR_VERBOSE) || defined(KTR_ALQ)
400 td->td_pflags &= ~TDP_INKTR;
410 static struct tstate tstate;
411 static int db_ktr_verbose;
412 static int db_mach_vtrace(void);
414 DB_SHOW_COMMAND(ktr, db_ktr_all)
417 tstate.cur = (ktr_idx - 1) % ktr_entries;
420 db_ktr_verbose |= (strchr(modif, 'v') != NULL) ? 2 : 0;
421 db_ktr_verbose |= (strchr(modif, 'V') != NULL) ? 1 : 0; /* just timestamp please */
422 if (strchr(modif, 'a') != NULL) {
424 while (cncheckc() == -1)
425 if (db_mach_vtrace() == 0)
428 while (!db_pager_quit)
429 if (db_mach_vtrace() == 0)
437 struct ktr_entry *kp;
439 if (tstate.cur == tstate.first || ktr_buf == NULL) {
440 db_printf("--- End of trace buffer ---\n");
443 kp = &ktr_buf[tstate.cur];
445 /* Skip over unused entries. */
446 if (kp->ktr_desc == NULL) {
447 db_printf("--- End of trace buffer ---\n");
450 db_printf("%d (%p", tstate.cur, kp->ktr_thread);
452 db_printf(":cpu%d", kp->ktr_cpu);
455 if (db_ktr_verbose >= 1) {
456 db_printf(" %10.10lld", (long long)kp->ktr_timestamp);
458 if (db_ktr_verbose >= 2) {
459 db_printf(" %s.%d", kp->ktr_file, kp->ktr_line);
462 db_printf(kp->ktr_desc, kp->ktr_parms[0], kp->ktr_parms[1],
463 kp->ktr_parms[2], kp->ktr_parms[3], kp->ktr_parms[4],
467 if (tstate.first == -1)
468 tstate.first = tstate.cur;
470 if (--tstate.cur < 0)
471 tstate.cur = ktr_entries - 1;