share/man/man4/ktr.4

   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
  62 The
  63 .Nm
  64 facility allows kernel events to be logged while the kernel executes so that
  65 they can be examined later when debugging.
  66 The only mandatory option to enable
  67 .Nm
  68 is
  69 .Cd options KTR .
  70 .Pp
  71 The
  72 .Dv KTR_ENTRIES
  73 option sets the size of the buffer of events.
  74 It must be a power of two.
  75 The size of the buffer in the currently running kernel can be found via the
  76 read-only sysctl
  77 .Va debug.ktr.entries .
  78 By default the buffer contains 2048 entries.
  79 .Pp
  80 For debugging purposes, the following
  81 .Nm
  82 related kernel options exist:
  83 .Bl -tag -width ".Dv KTR_SPIN_CONTENTION"
  84 .It Dv KTR_ALL
  85 turns on all options
  86 .It Dv KTR_ACPI_EC
  87 ACPI Embedded Controller related data
  88 .It Dv KTR_CTXSW
  89 context switches
  90 .It Dv KTR_DMCRYPT
  91 read and write strategy paths of
  92 .Xr dm 4 Ap s
  93 .Pa crypt
  94 target
  95 .It Dv KTR_ETHERNET
  96 cost of
  97 .Fn ether_input
  98 and
  99 .Fn ether_dispatch
 100 .It Dv KTR_IF_BGE
 101 .Xr bge 4
 102 interrupts and sent/received packets
 103 .It Dv KTR_IF_EM
 104 .Xr em 4
 105 interrupts and sent/received packets
 106 .It Dv KTR_IF_EMX
 107 .Xr emx 4
 108 interrupts and sent/received packets
 109 .It Dv KTR_IFQ
 110 classic ifq dequeue/enqueue operation
 111 .It Dv KTR_IF_POLL
 112 .Xr polling 4
 113 operation
 114 .It Dv KTR_IF_START
 115 running/avoiding/scheduling ifnet.if_start
 116 .It Dv KTR_IPIQ
 117 IPI related data (IPI requests, CPU synchronization etc.)
 118 .It Dv KTR_LAPIC
 119 Track LAPIC operation, for example EOI writes.
 120 .It Dv KTR_KERNENTRY
 121 entry of the kernel from userland (faults, syscalls)
 122 .It Dv KTR_MEMORY
 123 .Xr kmalloc 9
 124 and
 125 .Xr kfree 9
 126 events
 127 .It Dv KTR_SERIALIZER
 128 .Xr serializer 9
 129 related events
 130 .It Dv KTR_SPIN_CONTENTION
 131 .Xr spinlock 9
 132 contention
 133 .It Dv KTR_TESTLOG
 134 IPI performance testing
 135 .It Dv KTR_TOKENS
 136 LWKT token related events
 137 .It Dv KTR_TSLEEP
 138 .Xr tsleep 9
 139 and
 140 .Xr wakeup 9
 141 .It Dv KTR_USCHED_BSD4
 142 usched_bsd4 scheduling decisions
 143 .It Dv KTR_USCHED_DFLY
 144 usched_dfly scheduling decisions
 145 .El
 146 .Ss Verbose Mode
 147 By default, events are only logged to the internal buffer for examination
 148 later, but if the verbose flag is set then they are dumped to the kernel
 149 console as well.
 150 This flag can also be set from the loader via the
 151 .Va debug.ktr.verbose
 152 environment variable, or it can be examined and set after booting via the
 153 .Va debug.ktr.verbose
 154 sysctl.
 155 If the flag is set to zero, which is the default, then verbose output is
 156 disabled.
 157 If the flag is set to one, then the contents of the log message and the CPU
 158 number are printed to the kernel console.
 159 If the flag is greater than one, then the filename and line number of the
 160 event are output to the console in addition to the log message and the CPU
 161 number.
 162 The
 163 .Dv KTR_VERBOSE
 164 option enables verbose mode and sets the flag to one.
 165 .Ss Examining the Events
 166 The KTR buffer can be examined with
 167 .Xr ktrdump 8 ,
 168 .Xr gdb 1
 169 or from within
 170 .Xr ddb 4
 171 via the
 172 .Ic show ktr Op Cm /v
 173 command.
 174 This command displays the contents of the trace buffer one page at a time.
 175 At the
 176 .Dq Li --more--
 177 prompt, the Enter key displays one more entry and prompts again.
 178 The spacebar displays another page of entries.
 179 Any other key quits.
 180 By default the timestamp, filename, and line number are not displayed with
 181 each log entry.
 182 If the
 183 .Cm /v
 184 modifier is specified, then they are displayed in addition to the normal
 185 output.
 186 Note that the events are displayed in reverse chronological order.
 187 That 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
 191 A 32 bit mask used to control event logging.
 192 Each bit corresponds to one or more events depending on the values of the
 193 .Fa maskbit
 194 parameters that were passed to the
 195 .Xr KTR_INFO 9
 196 calls which declared the events.
 197 .Pp
 198 Unless
 199 .Dv KTR_ALL
 200 is specified in the kernel configuration, the default is to turn on logging
 201 for all corresponding events (i.e.\& setting the sysctl to -1).
 202 .It Va debug.ktr.*_mask
 203 Read only sysctls (one per event) that show the
 204 .Va debug.ktr.*_enable
 205 values corresponding to the events.
 206 .It Va debug.ktr.resynchronize
 207 Resynchronize the TSC across all CPUs 10 times per second in an attempt to
 208 reduce drift errors.
 209 Note 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
 217 The KTR kernel tracing facility first appeared in
 218 .Bsx 3.0
 219 and was imported into
 220 .Fx 5.0
 221 and
 222 .Dx 1.1 .
 223 It was completely rewritten by Matthew Dillon in
 224 .Dx 1.3 .