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