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 .\" $DragonFly: src/share/man/man4/ktr.4,v 1.10 2008/05/22 04:00:43 swildner Exp $
  27 .\"
  28 .Dd May 22, 2008
  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_IF_START
  43 .Cd options KTR_IFQ
  44 .Cd options KTR_IPIQ
  45 .Cd options KTR_KERNENTRY
  46 .Cd options KTR_MEMORY
  47 .Cd options KTR_POLLING
  48 .Cd options KTR_SERIALIZER
  49 .Cd options KTR_SPIN_CONTENTION
  50 .\".Cd options KTR_TCP
  51 .Cd options KTR_TESTLOG
  52 .Cd options KTR_TOKENS
  53 .\".Cd options KTR_TSLEEP
  54 .Cd options KTR_USB_MEMORY
  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 should 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_GIANT_CONTENTION"
  78 .It Dv KTR_ALL
  79 turns on all options
  80 .It Dv KTR_GIANT_CONTENTION
  81 contention of the giant lock
  82 .It Dv KTR_IF_BGE
  83 .Xr bge 4
  84 interrupts and sent/received packets
  85 .It Dv KTR_IF_EM
  86 .Xr em 4
  87 interrupts, polling and sent/received packets
  88 .It Dv KTR_IFQ
  89 classic ifq dequeue/enqueue operation
  90 .It Dv KTR_IF_START
  91 running/avoiding/scheduling ifnet.if_start
  92 .It Dv KTR_IPIQ
  93 IPI related data (IPI requests, CPU synchronization etc.)
  94 .It Dv KTR_KERNENTRY
  95 entry of the kernel from userland (faults, syscalls)
  96 .It Dv KTR_MEMORY
  97 .Xr kmalloc 9
  98 and
  99 .Xr kfree 9
 100 events
 101 .It Dv KTR_POLLING
 102 .Xr polling 4
 103 begins and ends
 104 .It Dv KTR_SERIALIZER
 105 .Xr serializer 9
 106 related events
 107 .It Dv KTR_SPIN_CONTENTION
 108 .Xr spinlock 9
 109 contention
 110 .It Dv KTR_TESTLOG
 111 IPI performance testing
 112 .It Dv KTR_TOKENS
 113 LWKT token related events
 114 .It Dv KTR_USB_MEMORY
 115 USB memory allocation
 116 .El
 117 .Ss Verbose Mode
 118 By default, events are only logged to the internal buffer for examination
 119 later, but if the verbose flag is set then they are dumped to the kernel
 120 console as well.
 121 This flag can also be set from the loader via the
 122 .Va debug.ktr.verbose
 123 environment variable, or it can be examined and set after booting via the
 124 .Va debug.ktr.verbose
 125 sysctl.
 126 If the flag is set to zero, which is the default, then verbose output is
 127 disabled.
 128 If the flag is set to one, then the contents of the log message and the CPU
 129 number are printed to the kernel console.
 130 If the flag is greater than one, then the filename and line number of the
 131 event are output to the console in addition to the log message and the CPU
 132 number.
 133 The
 134 .Dv KTR_VERBOSE
 135 option enables verbose mode and sets the flag to one.
 136 .Ss Examining the Events
 137 The KTR buffer can be examined with
 138 .Xr ktrdump 8 ,
 139 .Xr gdb 1
 140 or from within
 141 .Xr ddb 4
 142 via the
 143 .Ic show ktr Op Cm /v
 144 command.
 145 This command displays the contents of the trace buffer one page at a time.
 146 At the
 147 .Dq Li --more--
 148 prompt, the Enter key displays one more entry and prompts again.
 149 The spacebar displays another page of entries.
 150 Any other key quits.
 151 By default the timestamp, filename, and line number are not displayed with
 152 each log entry.
 153 If the
 154 .Cm /v
 155 modifier is specified, then they are displayed in addition to the normal
 156 output.
 157 Note that the events are displayed in reverse chronological order.
 158 That is, the most recent events are displayed first.
 159 .Sh SEE ALSO
 160 .Xr gdb 1 ,
 161 .Xr ddb 4 ,
 162 .Xr ktrdump 8 ,
 163 .Xr ktr 9
 164 .Sh HISTORY
 165 The KTR kernel tracing facility first appeared in
 166 .Bsx 3.0
 167 and was imported into
 168 .Fx 5.0
 169 and
 170 .Dx 1.1 .
 171 It was completely rewritten by Matthew Dillon in
 172 .Dx 1.3 .