2 * Copyright (c) 2005 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * The following copyright applies to the DDB command code:
37 * Copyright (c) 2000 John Baldwin <jhb@FreeBSD.org>
38 * All rights reserved.
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
43 * 1. Redistributions of source code must retain the above copyright
44 * notice, this list of conditions and the following disclaimer.
45 * 2. Redistributions in binary form must reproduce the above copyright
46 * notice, this list of conditions and the following disclaimer in the
47 * documentation and/or other materials provided with the distribution.
48 * 3. Neither the name of the author nor the names of any co-contributors
49 * may be used to endorse or promote products derived from this software
50 * without specific prior written permission.
52 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
53 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
54 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
55 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
56 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
57 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
58 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
59 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
60 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
61 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
66 * Kernel tracepoint facility.
72 #include <sys/param.h>
74 #include <sys/kernel.h>
75 #include <sys/libkern.h>
77 #include <sys/sysctl.h>
79 #include <sys/systm.h>
81 #include <sys/malloc.h>
82 #include <sys/spinlock.h>
83 #include <sys/thread2.h>
84 #include <sys/spinlock2.h>
85 #include <sys/ctype.h>
87 #include <machine/cpu.h>
88 #include <machine/cpufunc.h>
89 #include <machine/specialreg.h>
90 #include <machine/md_var.h>
95 #define KTR_ENTRIES 2048
96 #elif (KTR_ENTRIES & KTR_ENTRIES - 1)
97 #error KTR_ENTRIES must be a power of two
99 #define KTR_ENTRIES_MASK (KTR_ENTRIES - 1)
102 * test logging support. When ktr_testlogcnt is non-zero each synchronization
103 * interrupt will issue six back-to-back ktr logging messages on cpu 0
104 * so the user can determine KTR logging overheads.
106 #if !defined(KTR_TESTLOG)
107 #define KTR_TESTLOG KTR_ALL
109 KTR_INFO_MASTER(testlog);
111 KTR_INFO(KTR_TESTLOG, testlog, test1, 0, "test1 %d %d %d %d", int dummy1, int dummy2, int dummy3, int dummy4);
112 KTR_INFO(KTR_TESTLOG, testlog, test2, 1, "test2 %d %d %d %d", int dummy1, int dummy2, int dummy3, int dummy4);
113 KTR_INFO(KTR_TESTLOG, testlog, test3, 2, "test3 %d %d %d %d", int dummy1, int dummy2, int dummy3, int dummy4);
114 KTR_INFO(KTR_TESTLOG, testlog, test4, 3, "test4");
115 KTR_INFO(KTR_TESTLOG, testlog, test5, 4, "test5");
116 KTR_INFO(KTR_TESTLOG, testlog, test6, 5, "test6");
118 KTR_INFO(KTR_TESTLOG, testlog, pingpong, 6, "pingpong");
119 KTR_INFO(KTR_TESTLOG, testlog, pipeline, 7, "pipeline");
120 KTR_INFO(KTR_TESTLOG, testlog, crit_beg, 8, "crit_beg");
121 KTR_INFO(KTR_TESTLOG, testlog, crit_end, 9, "crit_end");
122 KTR_INFO(KTR_TESTLOG, testlog, spin_beg, 10, "spin_beg");
123 KTR_INFO(KTR_TESTLOG, testlog, spin_end, 11, "spin_end");
125 #define logtest(name) KTR_LOG(testlog_ ## name, 0, 0, 0, 0)
126 #define logtest_noargs(name) KTR_LOG(testlog_ ## name)
129 MALLOC_DEFINE(M_KTR, "ktr", "ktr buffers");
131 SYSCTL_NODE(_debug, OID_AUTO, ktr, CTLFLAG_RW, 0, "ktr");
133 int ktr_entries = KTR_ENTRIES;
134 SYSCTL_INT(_debug_ktr, OID_AUTO, entries, CTLFLAG_RD, &ktr_entries, 0,
135 "Size of the event buffer");
137 int ktr_version = KTR_VERSION;
138 SYSCTL_INT(_debug_ktr, OID_AUTO, version, CTLFLAG_RD, &ktr_version, 0, "");
140 static int ktr_stacktrace = 1;
141 SYSCTL_INT(_debug_ktr, OID_AUTO, stacktrace, CTLFLAG_RD, &ktr_stacktrace, 0, "");
143 static int ktr_resynchronize = 0;
144 SYSCTL_INT(_debug_ktr, OID_AUTO, resynchronize, CTLFLAG_RW,
145 &ktr_resynchronize, 0, "Resynchronize TSC 10 times a second");
148 static int ktr_testlogcnt = 0;
149 SYSCTL_INT(_debug_ktr, OID_AUTO, testlogcnt, CTLFLAG_RW, &ktr_testlogcnt, 0, "");
150 static int ktr_testipicnt = 0;
152 static int ktr_testipicnt_remainder;
154 SYSCTL_INT(_debug_ktr, OID_AUTO, testipicnt, CTLFLAG_RW, &ktr_testipicnt, 0, "");
155 static int ktr_testcritcnt = 0;
156 SYSCTL_INT(_debug_ktr, OID_AUTO, testcritcnt, CTLFLAG_RW, &ktr_testcritcnt, 0, "");
157 static int ktr_testspincnt = 0;
158 SYSCTL_INT(_debug_ktr, OID_AUTO, testspincnt, CTLFLAG_RW, &ktr_testspincnt, 0, "");
162 * Give cpu0 a static buffer so the tracepoint facility can be used during
163 * early boot (note however that we still use a critical section, XXX).
165 static struct ktr_entry ktr_buf0[KTR_ENTRIES];
167 __cachealign struct ktr_cpu ktr_cpu[MAXCPU] = {
168 { .core.ktr_buf = &ktr_buf0[0] }
172 static int64_t ktr_sync_tsc;
174 struct callout ktr_resync_callout;
177 int ktr_verbose = KTR_VERBOSE;
178 TUNABLE_INT("debug.ktr.verbose", &ktr_verbose);
179 SYSCTL_INT(_debug_ktr, OID_AUTO, verbose, CTLFLAG_RW, &ktr_verbose, 0,
180 "Log events to the console as well");
183 static void ktr_resync_callback(void *dummy __unused);
185 extern int64_t tsc_offsets[];
188 ktr_sysinit(void *dummy)
190 struct ktr_cpu_core *kcpu;
193 for(i = 1; i < ncpus; ++i) {
194 kcpu = &ktr_cpu[i].core;
195 kcpu->ktr_buf = kmalloc(KTR_ENTRIES * sizeof(struct ktr_entry),
196 M_KTR, M_WAITOK | M_ZERO);
198 callout_init_mp(&ktr_resync_callout);
199 callout_reset(&ktr_resync_callout, hz / 10, ktr_resync_callback, NULL);
201 SYSINIT(ktr_sysinit, SI_BOOT2_KLD, SI_ORDER_ANY, ktr_sysinit, NULL);
204 * Try to resynchronize the TSC's for all cpus. This is really, really nasty.
205 * We have to send an IPIQ message to all remote cpus, wait until they
206 * get into their IPIQ processing code loop, then do an even stricter hard
207 * loop to get the cpus as close to synchronized as we can to get the most
210 * This callback occurs on cpu0.
214 static void ktr_pingpong_remote(void *dummy);
215 static void ktr_pipeline_remote(void *dummy);
219 #if defined(SMP) && defined(_RDTSC_SUPPORTED_)
221 static void ktr_resync_remote(void *dummy);
222 extern cpumask_t smp_active_mask;
225 * We use a callout callback instead of a systimer because we cannot afford
226 * to preempt anyone to do this, or we might deadlock a spin-lock or
227 * serializer between two cpus.
231 ktr_resync_callback(void *dummy __unused)
233 struct lwkt_cpusync cs;
238 KKASSERT(mycpu->gd_cpuid == 0);
244 if (ktr_testlogcnt) {
250 logtest_noargs(test4);
251 logtest_noargs(test5);
252 logtest_noargs(test6);
259 if (ktr_testipicnt && ktr_testipicnt_remainder == 0 && ncpus > 1) {
260 ktr_testipicnt_remainder = ktr_testipicnt;
262 lwkt_send_ipiq_bycpu(1, ktr_pingpong_remote, NULL);
266 * Test critical sections
268 if (ktr_testcritcnt) {
271 logtest_noargs(crit_beg);
272 for (count = ktr_testcritcnt; count; --count) {
276 logtest_noargs(crit_end);
281 * Test spinlock sections
283 if (ktr_testspincnt) {
284 struct spinlock spin;
289 logtest_noargs(spin_beg);
290 for (count = ktr_testspincnt; count; --count) {
294 logtest_noargs(spin_end);
300 * Resynchronize the TSC
302 if (ktr_resynchronize == 0)
304 if ((cpu_feature & CPUID_TSC) == 0)
308 lwkt_cpusync_init(&cs, smp_active_mask, ktr_resync_remote,
309 (void *)(intptr_t)mycpu->gd_cpuid);
310 lwkt_cpusync_interlock(&cs);
311 ktr_sync_tsc = rdtsc();
312 lwkt_cpusync_deinterlock(&cs);
315 callout_reset(&ktr_resync_callout, hz / 10, ktr_resync_callback, NULL);
319 * The remote-end of the KTR synchronization protocol runs on all cpus.
320 * The one we run on the controlling cpu updates its tsc continuously
321 * until the others have finished syncing (theoretically), but we don't
324 * This is a bit ad-hoc but we need to avoid livelocking inside an IPI
325 * callback. rdtsc() is a synchronizing instruction (I think).
328 ktr_resync_remote(void *arg)
330 globaldata_t gd = mycpu;
334 if (gd->gd_cpuid == (int)(intptr_t)arg) {
335 for (i = 0; i < 2000; ++i)
336 ktr_sync_tsc = rdtsc();
338 delta = rdtsc() - ktr_sync_tsc;
339 if (tsc_offsets[gd->gd_cpuid] == 0)
340 tsc_offsets[gd->gd_cpuid] = delta;
341 tsc_offsets[gd->gd_cpuid] =
342 (tsc_offsets[gd->gd_cpuid] * 7 + delta) / 8;
350 ktr_pingpong_remote(void *dummy __unused)
354 logtest_noargs(pingpong);
355 other_cpu = 1 - mycpu->gd_cpuid;
356 if (ktr_testipicnt_remainder) {
357 --ktr_testipicnt_remainder;
358 lwkt_send_ipiq_bycpu(other_cpu, ktr_pingpong_remote, NULL);
360 lwkt_send_ipiq_bycpu(other_cpu, ktr_pipeline_remote, NULL);
361 lwkt_send_ipiq_bycpu(other_cpu, ktr_pipeline_remote, NULL);
362 lwkt_send_ipiq_bycpu(other_cpu, ktr_pipeline_remote, NULL);
363 lwkt_send_ipiq_bycpu(other_cpu, ktr_pipeline_remote, NULL);
364 lwkt_send_ipiq_bycpu(other_cpu, ktr_pipeline_remote, NULL);
370 ktr_pipeline_remote(void *dummy __unused)
372 logtest_noargs(pipeline);
380 * The resync callback for UP doesn't do anything other then run the test
381 * log messages. If test logging is not enabled, don't bother resetting
386 ktr_resync_callback(void *dummy __unused)
392 if (ktr_testlogcnt) {
398 logtest_noargs(test4);
399 logtest_noargs(test5);
400 logtest_noargs(test6);
403 callout_reset(&ktr_resync_callout, hz / 10, ktr_resync_callback, NULL);
410 * Setup the next empty slot and return it to the caller to store the data
414 ktr_begin_write_entry(struct ktr_info *info, const char *file, int line)
416 struct ktr_cpu_core *kcpu;
417 struct ktr_entry *entry;
420 cpu = mycpu->gd_cpuid;
421 kcpu = &ktr_cpu[cpu].core;
422 if (kcpu->ktr_buf == NULL)
426 entry = kcpu->ktr_buf + (kcpu->ktr_idx & KTR_ENTRIES_MASK);
428 #ifdef _RDTSC_SUPPORTED_
429 if (cpu_feature & CPUID_TSC) {
431 entry->ktr_timestamp = rdtsc() - tsc_offsets[cpu];
433 entry->ktr_timestamp = rdtsc();
438 entry->ktr_timestamp = get_approximate_time_t();
440 entry->ktr_info = info;
441 entry->ktr_file = file;
442 entry->ktr_line = line;
448 ktr_finish_write_entry(struct ktr_info *info, struct ktr_entry *entry)
451 cpu_ktr_caller(entry);
453 if (ktr_verbose && info->kf_format) {
455 kprintf("cpu%d ", mycpu->gd_cpuid);
457 if (ktr_verbose > 1) {
458 kprintf("%s.%d\t", entry->ktr_file, entry->ktr_line);
468 #define NUM_LINES_PER_PAGE 19
475 static int db_ktr_verbose;
476 static int db_mach_vtrace(int cpu, struct ktr_entry *kp, int idx);
478 DB_SHOW_COMMAND(ktr, db_ktr_all)
480 struct ktr_cpu_core *kcpu;
485 struct tstate tstate[MAXCPU];
488 for(i = 0; i < ncpus; i++) {
489 kcpu = &ktr_cpu[i].core;
490 tstate[i].first = -1;
491 tstate[i].cur = (kcpu->ktr_idx - 1) & KTR_ENTRIES_MASK;
494 while ((c = *(modif++)) != '\0') {
503 while ((c = *(modif++)) != '\0') {
516 if (printcpu > ncpus - 1) {
517 db_printf("Invalid cpu number\n");
521 * Lopp throug all the buffers and print the content of them, sorted
526 u_int64_t highest_ts;
528 struct ktr_entry *kp;
530 if (a_flag == 1 && cncheckc() != -1)
535 * Find the lowest timestamp
537 for (i = 0, counter = 0; i < ncpus; i++) {
538 kcpu = &ktr_cpu[i].core;
539 if (kcpu->ktr_buf == NULL)
541 if (printcpu != -1 && printcpu != i)
543 if (tstate[i].cur == -1) {
545 if (counter == ncpus) {
546 db_printf("--- End of trace buffer ---\n");
551 if (kcpu->ktr_buf[tstate[i].cur].ktr_timestamp > highest_ts) {
552 highest_ts = kcpu->ktr_buf[tstate[i].cur].ktr_timestamp;
556 if (highest_cpu < 0) {
557 db_printf("no KTR data available\n");
561 kcpu = &ktr_cpu[i].core;
562 kp = &kcpu->ktr_buf[tstate[i].cur];
563 if (tstate[i].first == -1)
564 tstate[i].first = tstate[i].cur;
565 if (--tstate[i].cur < 0)
566 tstate[i].cur = KTR_ENTRIES - 1;
567 if (tstate[i].first == tstate[i].cur) {
568 db_mach_vtrace(i, kp, tstate[i].cur + 1);
572 if (kcpu->ktr_buf[tstate[i].cur].ktr_info == NULL)
574 if (db_more(&nl) == -1)
576 if (db_mach_vtrace(i, kp, tstate[i].cur + 1) == 0)
582 db_mach_vtrace(int cpu, struct ktr_entry *kp, int idx)
584 if (kp->ktr_info == NULL)
587 db_printf("cpu%d ", cpu);
589 db_printf("%d: ", idx);
590 if (db_ktr_verbose) {
591 db_printf("%10.10lld %s.%d\t", (long long)kp->ktr_timestamp,
592 kp->ktr_file, kp->ktr_line);
594 db_printf("%s\t", kp->ktr_info->kf_name);
595 db_printf("from(%p,%p) ", kp->ktr_caller1, kp->ktr_caller2);
597 if (kp->ktr_info->kf_format)
598 db_vprintf(kp->ktr_info->kf_format, (__va_list)kp->ktr_data);