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