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 July 16, 2011
  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_CTXSW
  39 .Cd options KTR_ETHERNET
  40 .\".Cd options KTR_HAMMER
  41 .Cd options KTR_IF_BGE
  42 .Cd options KTR_IF_EM
  43 .Cd options KTR_IF_EMX
  44 .Cd options KTR_IF_START
  45 .Cd options KTR_IFQ
  46 .Cd options KTR_IPIQ
  47 .Cd options KTR_KERNENTRY
  48 .Cd options KTR_MEMORY
  49 .Cd options KTR_POLLING
  50 .Cd options KTR_SERIALIZER
  51 .Cd options KTR_SPIN_CONTENTION
  52 .\".Cd options KTR_TCP
  53 .Cd options KTR_TESTLOG
  54 .Cd options KTR_TOKENS
  55 .\".Cd options KTR_TSLEEP
  56 .Cd options KTR_USB_MEMORY
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 facility allows kernel events to be logged while the kernel executes so that
  61 they can be examined later when debugging.
  62 The only mandatory option to enable
  63 .Nm
  64 is
  65 .Cd options KTR .
  66 .Pp
  67 The
  68 .Dv KTR_ENTRIES
  69 option sets the size of the buffer of events.
  70 It must be a power of two.
  71 The size of the buffer in the currently running kernel can be found via the
  72 read-only sysctl
  73 .Va debug.ktr.entries .
  74 By default the buffer contains 2048 entries.
  75 .Pp
  76 For debugging purposes, the following
  77 .Nm
  78 related kernel options exist:
  79 .Bl -tag -width ".Dv KTR_SPIN_CONTENTION"
  80 .It Dv KTR_ALL
  81 turns on all options
  82 .It Dv KTR_CTXSW
  83 context switches
  84 .It Dv KTR_ETHERNET
  85 cost of
  86 .Fn ether_input_chain
  87 and
  88 .Fn ether_input_dispatch
  89 .It Dv KTR_IF_BGE
  90 .Xr bge 4
  91 interrupts and sent/received packets
  92 .It Dv KTR_IF_EM
  93 .Xr em 4
  94 interrupts and sent/received packets
  95 .It Dv KTR_IF_EMX
  96 .Xr emx 4
  97 interrupts and sent/received packets
  98 .It Dv KTR_IFQ
  99 classic ifq dequeue/enqueue operation
 100 .It Dv KTR_IF_START
 101 running/avoiding/scheduling ifnet.if_start
 102 .It Dv KTR_IPIQ
 103 IPI related data (IPI requests, CPU synchronization etc.)
 104 .It Dv KTR_KERNENTRY
 105 entry of the kernel from userland (faults, syscalls)
 106 .It Dv KTR_MEMORY
 107 .Xr kmalloc 9
 108 and
 109 .Xr kfree 9
 110 events
 111 .It Dv KTR_POLLING
 112 .Xr polling 4
 113 begins and ends
 114 .It Dv KTR_SERIALIZER
 115 .Xr serializer 9
 116 related events
 117 .It Dv KTR_SPIN_CONTENTION
 118 .Xr spinlock 9
 119 contention
 120 .It Dv KTR_TESTLOG
 121 IPI performance testing
 122 .It Dv KTR_TOKENS
 123 LWKT token related events
 124 .It Dv KTR_USB_MEMORY
 125 USB memory allocation
 126 .El
 127 .Ss Verbose Mode
 128 By default, events are only logged to the internal buffer for examination
 129 later, but if the verbose flag is set then they are dumped to the kernel
 130 console as well.
 131 This flag can also be set from the loader via the
 132 .Va debug.ktr.verbose
 133 environment variable, or it can be examined and set after booting via the
 134 .Va debug.ktr.verbose
 135 sysctl.
 136 If the flag is set to zero, which is the default, then verbose output is
 137 disabled.
 138 If the flag is set to one, then the contents of the log message and the CPU
 139 number are printed to the kernel console.
 140 If the flag is greater than one, then the filename and line number of the
 141 event are output to the console in addition to the log message and the CPU
 142 number.
 143 The
 144 .Dv KTR_VERBOSE
 145 option enables verbose mode and sets the flag to one.
 146 .Ss Examining the Events
 147 The KTR buffer can be examined with
 148 .Xr ktrdump 8 ,
 149 .Xr gdb 1
 150 or from within
 151 .Xr ddb 4
 152 via the
 153 .Ic show ktr Op Cm /v
 154 command.
 155 This command displays the contents of the trace buffer one page at a time.
 156 At the
 157 .Dq Li --more--
 158 prompt, the Enter key displays one more entry and prompts again.
 159 The spacebar displays another page of entries.
 160 Any other key quits.
 161 By default the timestamp, filename, and line number are not displayed with
 162 each log entry.
 163 If the
 164 .Cm /v
 165 modifier is specified, then they are displayed in addition to the normal
 166 output.
 167 Note that the events are displayed in reverse chronological order.
 168 That is, the most recent events are displayed first.
 169 .Sh SYSCTL VARIABLES
 170 .Bl -tag -width ".Va debug.ktr.*_enable"
 171 .It Va debug.ktr.*_enable
 172 A 32 bit mask used to control event logging.
 173 Each bit corresponds to one or more events depending on the values of the
 174 .Fa maskbit
 175 parameters that were passed to the
 176 .Xr KTR_INFO 9
 177 calls which declared the events.
 178 .Pp
 179 Unless
 180 .Dv KTR_ALL
 181 is specified in the kernel configuration, the default is to turn on logging
 182 for all corresponding events (i.e.\& setting the sysctl to -1).
 183 .It Va debug.ktr.*_mask
 184 Read only sysctls (one per event) that show the
 185 .Va debug.ktr.*_enable
 186 values corresponding to the events.
 187 .El
 188 .Sh SEE ALSO
 189 .Xr gdb 1 ,
 190 .Xr ddb 4 ,
 191 .Xr ktrdump 8 ,
 192 .Xr ktr 9
 193 .Sh HISTORY
 194 The KTR kernel tracing facility first appeared in
 195 .Bsx 3.0
 196 and was imported into
 197 .Fx 5.0
 198 and
 199 .Dx 1.1 .
 200 It was completely rewritten by Matthew Dillon in
 201 .Dx 1.3 .