1.\" Copyright (c) 2001 John H. Baldwin <jhb@FreeBSD.org> 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD: src/share/man/man4/ktr.4,v 1.9 2003/09/08 19:57:19 ru Exp $ 26.\" 27.Dd February 18, 2019 28.Dt KTR 4 29.Os 30.Sh NAME 31.Nm ktr 32.Nd kernel tracing facility 33.Sh SYNOPSIS 34.Cd options KTR 35.Cd options KTR_ENTRIES=8192 36.Cd options KTR_VERBOSE=1 37.Cd options KTR_ALL 38.Cd options KTR_ACPI_EC 39.Cd options KTR_CTXSW 40.Cd options KTR_DMCRYPT 41.Cd options KTR_ETHERNET 42.\".Cd options KTR_HAMMER 43.Cd options KTR_IF_BGE 44.Cd options KTR_IF_EM 45.Cd options KTR_IF_EMX 46.Cd options KTR_IF_POLL 47.Cd options KTR_IF_START 48.Cd options KTR_IFQ 49.Cd options KTR_IPIQ 50.Cd options KTR_KERNENTRY 51.Cd options KTR_LAPIC 52.Cd options KTR_MEMORY 53.Cd options KTR_SERIALIZER 54.Cd options KTR_SPIN_CONTENTION 55.\".Cd options KTR_TCP 56.Cd options KTR_TESTLOG 57.Cd options KTR_TOKENS 58.Cd options KTR_TSLEEP 59.Cd options KTR_USCHED_BSD4 60.Cd options KTR_USCHED_DFLY 61.Sh DESCRIPTION 62The 63.Nm 64facility allows kernel events to be logged while the kernel executes so that 65they can be examined later when debugging. 66The only mandatory option to enable 67.Nm 68is 69.Cd options KTR . 70.Pp 71The 72.Dv KTR_ENTRIES 73option sets the size of the buffer of events. 74It must be a power of two. 75The size of the buffer in the currently running kernel can be found via the 76read-only sysctl 77.Va debug.ktr.entries . 78By default the buffer contains 2048 entries. 79.Pp 80For debugging purposes, the following 81.Nm 82related kernel options exist: 83.Bl -tag -width ".Dv KTR_SPIN_CONTENTION" 84.It Dv KTR_ALL 85turns on all options 86.It Dv KTR_ACPI_EC 87ACPI Embedded Controller related data 88.It Dv KTR_CTXSW 89context switches 90.It Dv KTR_DMCRYPT 91read and write strategy paths of 92.Xr dm 4 Ap s 93.Pa crypt 94target 95.It Dv KTR_ETHERNET 96cost of 97.Fn ether_input 98and 99.Fn ether_dispatch 100.It Dv KTR_IF_BGE 101.Xr bge 4 102interrupts and sent/received packets 103.It Dv KTR_IF_EM 104.Xr em 4 105interrupts and sent/received packets 106.It Dv KTR_IF_EMX 107.Xr emx 4 108interrupts and sent/received packets 109.It Dv KTR_IFQ 110classic ifq dequeue/enqueue operation 111.It Dv KTR_IF_POLL 112.Xr polling 4 113operation 114.It Dv KTR_IF_START 115running/avoiding/scheduling ifnet.if_start 116.It Dv KTR_IPIQ 117IPI related data (IPI requests, CPU synchronization etc.) 118.It Dv KTR_LAPIC 119Track LAPIC operation, for example EOI writes. 120.It Dv KTR_KERNENTRY 121entry of the kernel from userland (faults, syscalls) 122.It Dv KTR_MEMORY 123.Xr kmalloc 9 124and 125.Xr kfree 9 126events 127.It Dv KTR_SERIALIZER 128.Xr serializer 9 129related events 130.It Dv KTR_SPIN_CONTENTION 131.Xr spinlock 9 132contention 133.It Dv KTR_TESTLOG 134IPI performance testing 135.It Dv KTR_TOKENS 136LWKT token related events 137.It Dv KTR_TSLEEP 138.Xr tsleep 9 139and 140.Xr wakeup 9 141.It Dv KTR_USCHED_BSD4 142usched_bsd4 scheduling decisions 143.It Dv KTR_USCHED_DFLY 144usched_dfly scheduling decisions 145.El 146.Ss Verbose Mode 147By default, events are only logged to the internal buffer for examination 148later, but if the verbose flag is set then they are dumped to the kernel 149console as well. 150This flag can also be set from the loader via the 151.Va debug.ktr.verbose 152environment variable, or it can be examined and set after booting via the 153.Va debug.ktr.verbose 154sysctl. 155If the flag is set to zero, which is the default, then verbose output is 156disabled. 157If the flag is set to one, then the contents of the log message and the CPU 158number are printed to the kernel console. 159If the flag is greater than one, then the filename and line number of the 160event are output to the console in addition to the log message and the CPU 161number. 162The 163.Dv KTR_VERBOSE 164option enables verbose mode and sets the flag to one. 165.Ss Examining the Events 166The KTR buffer can be examined with 167.Xr ktrdump 8 , 168.Xr gdb 1 169or from within 170.Xr ddb 4 171via the 172.Ic show ktr Op Cm /v 173command. 174This command displays the contents of the trace buffer one page at a time. 175At the 176.Dq Li --more-- 177prompt, the Enter key displays one more entry and prompts again. 178The spacebar displays another page of entries. 179Any other key quits. 180By default the timestamp, filename, and line number are not displayed with 181each log entry. 182If the 183.Cm /v 184modifier is specified, then they are displayed in addition to the normal 185output. 186Note that the events are displayed in reverse chronological order. 187That is, the most recent events are displayed first. 188.Sh SYSCTL VARIABLES 189.Bl -tag -width ".Va debug.ktr.resynchronize" 190.It Va debug.ktr.*_enable 191A 32 bit mask used to control event logging. 192Each bit corresponds to one or more events depending on the values of the 193.Fa maskbit 194parameters that were passed to the 195.Xr KTR_INFO 9 196calls which declared the events. 197.Pp 198Unless 199.Dv KTR_ALL 200is specified in the kernel configuration, the default is to turn on logging 201for all corresponding events (i.e.\& setting the sysctl to -1). 202.It Va debug.ktr.*_mask 203Read only sysctls (one per event) that show the 204.Va debug.ktr.*_enable 205values corresponding to the events. 206.It Va debug.ktr.resynchronize 207Resynchronize the TSC across all CPUs 10 times per second in an attempt to 208reduce drift errors. 209Note that this is very expensive and therefore the default is 0. 210.El 211.Sh SEE ALSO 212.Xr gdb 1 , 213.Xr ddb 4 , 214.Xr ktrdump 8 , 215.Xr ktr 9 216.Sh HISTORY 217The KTR kernel tracing facility first appeared in 218.Bsx 3.0 219and was imported into 220.Fx 5.0 221and 222.Dx 1.1 . 223It was completely rewritten by Matthew Dillon in 224.Dx 1.3 . 225