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.\" $DragonFly: src/share/man/man4/ktr.4,v 1.4 2007/11/03 07:24:52 swildner Exp $ 27.\" 28.Dd November 2, 2007 29.Dt KTR 4 30.Os 31.Sh NAME 32.Nm ktr 33.Nd kernel tracing facility 34.Sh SYNOPSIS 35.Cd options KTR 36.Cd options KTR_ENTRIES=8192 37.Cd options KTR_VERBOSE=1 38.Cd options KTR_ALL 39.Cd options KTR_GIANT_CONTENTION 40.Cd options KTR_IF_BGE 41.Cd options KTR_IF_EM 42.Cd options KTR_IPIQ 43.Cd options KTR_MEMORY 44.Cd options KTR_SPIN_CONTENTION 45.\".Cd options KTR_TCP 46.\".Cd options KTR_TESTLOG 47.Cd options KTR_TOKENS 48.\".Cd options KTR_TSLEEP 49.Cd options KTR_USB_MEMORY 50.Sh DESCRIPTION 51The 52.Nm 53facility allows kernel events to be logged while the kernel executes so that 54they can be examined later when debugging. 55The only mandatory option to enable 56.Nm 57is 58.Cd options KTR . 59.Pp 60The 61.Dv KTR_ENTRIES 62option sets the size of the buffer of events. 63It should be a power of two. 64The size of the buffer in the currently running kernel can be found via the 65read-only sysctl 66.Va debug.ktr.entries . 67By default the buffer contains 2048 entries. 68.Pp 69For debugging purposes, the following 70.Nm 71related kernel options exist: 72.Bl -tag -width ".Dv KTR_GIANT_CONTENTION" 73.It Dv KTR_ALL 74turns on all options 75.It Dv KTR_GIANT_CONTENTION 76contention of the giant lock 77.It Dv KTR_IF_BGE 78.Xr bge 4 79interrupts and sent/received packets 80.It Dv KTR_IF_EM 81.Xr em 4 82interrupts, polling and sent/received packets 83.It Dv KTR_IPIQ 84IPI related data (IPI requests, CPU synchronization etc.) 85.It Dv KTR_MEMORY 86.Xr kmalloc 9 87and 88.Xr kfree 9 89events 90.It Dv KTR_SPIN_CONTENTION 91.Xr spinlock 9 92contention 93.It Dv KTR_TOKENS 94LWKT token related events 95.It Dv KTR_USB_MEMORY 96USB memory allocation 97.El 98.Ss Verbose Mode 99By default, events are only logged to the internal buffer for examination 100later, but if the verbose flag is set then they are dumped to the kernel 101console as well. 102This flag can also be set from the loader via the 103.Va debug.ktr.verbose 104environment variable, or it can be examined and set after booting via the 105.Va debug.ktr.verbose 106sysctl. 107If the flag is set to zero, which is the default, then verbose output is 108disabled. 109If the flag is set to one, then the contents of the log message and the CPU 110number are printed to the kernel console. 111If the flag is greater than one, then the filename and line number of the 112event are output to the console in addition to the log message and the CPU 113number. 114The 115.Dv KTR_VERBOSE 116option sets the flag to one. 117.Ss Examining the Events 118The KTR buffer can be examined with 119.Xr ktrdump 8 , 120.Xr gdb 1 121or from within 122.Xr ddb 4 123via the 124.Ic show ktr Op Cm /v 125command. 126This command displays the contents of the trace buffer one page at a time. 127At the 128.Dq Li --more-- 129prompt, the Enter key displays one more entry and prompts again. 130The spacebar displays another page of entries. 131Any other key quits. 132By default the timestamp, filename, and line number are not displayed with 133each log entry. 134If the 135.Cm /v 136modifier is specified, then they are displayed in addition to the normal 137output. 138Note that the events are displayed in reverse chronological order. 139That is, the most recent events are displayed first. 140.Sh SEE ALSO 141.Xr gdb 1 , 142.Xr ddb 4 , 143.Xr ktrdump 8 , 144.Xr ktr 9 145.Sh HISTORY 146The KTR kernel tracing facility first appeared in 147.Bsx 3.0 148and was imported into 149.Fx 5.0 150and 151.Dx 1.1 . 152It was completely rewritten by Matthew Dillon in 153.Dx 1.3 . 154