usr.bin/ktrdump/ktrdump.8

   1 .\"-
   2 .\" Copyright (c) 2002 Chad David
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/usr.bin/ktrdump/ktrdump.8,v 1.7 2005/03/08 06:58:56 hmp Exp $
  27 .\"
  28 .Dd November 9, 2008
  29 .Dt KTRDUMP 8
  30 .Os
  31 .Sh NAME
  32 .Nm ktrdump
  33 .Nd print kernel ktr trace buffer
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl acdfilnpqrstx
  37 .Op Fl A Ar factor
  38 .Op Fl N Ar execfile
  39 .Op Fl M Ar corefile
  40 .Op Fl o Ar outfile
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 utility is used to dump the contents of the kernel ktr trace buffer.
  45 .Pp
  46 The following options are available:
  47 .Bl -tag -width ".Fl N Ar execfile"
  48 .It Fl a
  49 Print most fields.
  50 Implies
  51 .Fl c
  52 .Fl i
  53 .Fl x
  54 .Fl p
  55 .Fl r ,
  56 and
  57 .Fl s .
  58 Note that
  59 .Fl f
  60 is not included.
  61 .It Fl c
  62 Print the CPU number that each entry was logged from.
  63 .It Fl d
  64 Dump an event stream to the file specified with
  65 .Fl o .
  66 This stream can be examined with
  67 .Xr evtranalyze 1 .
  68 .It Fl f
  69 Print the file and line number that each entry was logged from.
  70 .It Fl i
  71 Print the ID string field, identifying the facility being logged.
  72 .It Fl l
  73 .Nm
  74 will loop waiting for new data rather than exit.
  75 .It Fl n
  76 .Nm
  77 normally tries to translate the caller fields and (when easily parsed)
  78 trace arguments into symbols.
  79 This option forces hex values to be displayed instead.
  80 This option will also cause relative timestamps to
  81 be displayed as TSC timestamps rather than converted to microseconds.
  82 .It Fl p
  83 Print the trace data.
  84 .It Fl q
  85 Quiet mode; do not print the column header.
  86 .It Fl r
  87 Print relative timestamps in microseconds, rather than absolute TSC
  88 timestamps.
  89 .It Fl s
  90 Attempt to merge the KTR logs for all cpus into a single time-sorted
  91 log.
  92 For the numbers to make any sense you probably want to turn on the
  93 .Va debug.ktr.resynchronize
  94 .Xr sysctl 3
  95 variable.
  96 This sysctl causes the kernel to periodically
  97 calculate the drift between each CPU's TSC and apply a correction.
  98 .It Fl t
  99 Print the timestamp for each entry.
 100 .It Fl x
 101 Print the call chain leading up to the procedure which issued
 102 the KTR.
 103 .It Fl A Ar factor
 104 Specify a correction factor to be applied to attempt to remove the
 105 overhead of the KTR logging call itself.
 106 .It Fl N Ar execfile
 107 The kernel image to resolve symbols from.
 108 The default is the value returned via
 109 .Xr getbootfile 3 .
 110 .It Fl M Ar corefile
 111 The core file or memory image to read from.
 112 The default is
 113 .Pa /dev/mem .
 114 .It Fl o Ar outfile
 115 The file to write the output to.
 116 The default is standard output.
 117 .El
 118 .Sh OPERATIONAL NOTES
 119 Users of
 120 .Nm
 121 should keep in mind that the act of trace logging will itself affect
 122 execution overheads.
 123 On a 2Ghz cpu a logging call can take anywhere from 40ns to 150ns to run.
 124 .Pp
 125 The TSC counter is used on cpus equipped with it (which is all modern cpus).
 126 The TSC counters may not be synchronized on SMP systems and may drift even
 127 between cores on multi-core cpus.
 128 Enabling synchronization between cpus via the
 129 .Va debug.ktr.resynchronize
 130 sysctl will impose additional system overheads and will generally only be
 131 accurate to within 100ns or so (and perhaps not even that good).
 132 Resynchronization only occurs 10 times a second and serious drift will
 133 cause a great deal of measurement noise when trying to compare events occurring
 134 on two different cpus.
 135 .Pp
 136 Users using the
 137 .Fl s
 138 option should be aware that events for each cpu are independently logged
 139 and one cpu might have more events logged then another, causing earlier
 140 events to be discarded sooner than other cpus.
 141 The beginning portion of
 142 the sorted output may thus show MP related events for one cpu with no
 143 corresponding events for other cpus.
 144 .Pp
 145 It is possible to somewhat characterize KTR logging overheads by setting
 146 the
 147 .Va debug.ktr.testlogcnt
 148 sysctl and then observing test logging events in the KTR output.
 149 Tests 1-3 log four dummy arguments while tests 4-6 log no arguments.
 150 .Pp
 151 It is possible to characterize IPI messaging latencies by setting the
 152 .Va debug.ktr.testipicnt
 153 sysctl.
 154 A small number between 1 and 1000 is recommended.
 155 This will
 156 cause the system to ping pong a single IPI message between cpu 0 and cpu 1
 157 asynchronously that number of times, as fast as it can.
 158 A
 159 .Nm
 160 should be performed almost immediately after setting the sysctl or you
 161 might miss the logged events.
 162 .Sh SEE ALSO
 163 .Xr ktr 4 ,
 164 .Xr ktr 9
 165 .Sh HISTORY
 166 The
 167 .Nm
 168 utility first appeared in
 169 .Fx 5.0 .
 170 .Sh AUTHORS
 171 .An -nosplit
 172 The
 173 .Nm
 174 utility was originally implemented by
 175 .An Jake Burkholder Aq jake@FreeBSD.org .
 176 This manual page was originally written by
 177 .An Chad David Aq davidc@FreeBSD.org .
 178 The program and manual page were rewritten pretty much from
 179 scratch by
 180 .An Matthew Dillon
 181 for
 182 .Dx .