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 .\" $DragonFly: src/usr.bin/ktrdump/ktrdump.8,v 1.10 2007/06/08 18:24:22 dillon Exp $
  28 .\"
  29 .Dd May 5, 2004
  30 .Dt KTRDUMP 8
  31 .Os
  32 .Sh NAME
  33 .Nm ktrdump
  34 .Nd print kernel ktr trace buffer
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl acfilnpqrstx
  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 all fields.  Implies all print options.
  50 .It Fl c
  51 Print the CPU number that each entry was logged from.
  52 .It Fl f
  53 Print the file and line number that each entry was logged from.
  54 .It Fl i
  55 Print the ID string field, identifying the facility being logged.
  56 .It Fl l
  57 .Nm
  58 will loop waiting for new data rather then exit.
  59 .It Fl n
  60 .Nm
  61 normally tries to translate the caller fields and (when easily parsed)
  62 trace arguments into symbols.  This option forces hex values to be
  63 displayed instead.  This option will also cause relative timestamps to
  64 be displayed as TSC timestamps rather than converted to microseconds.
  65 .It Fl p
  66 Print the trace data.
  67 .It Fl q
  68 Quiet mode; do not print the column header.
  69 .It Fl r
  70 Print relative timestamps in microseconds, rather than absolute TSC
  71 timestamps.
  72 .It Fl s
  73 Attempt to merge the KTR logs for all cpus into a single time-sorted
  74 log.  For the numbers to make any sense you probably want to turn
  75 on the
  76 .Va debug.ktr.resynchronize
  77 sysctl variable.  This sysctl causes the kernel to periodically
  78 calculate the drift between each cpu's TSC and apply a correction.
  79 .It Fl x
  80 Print the call chain leading up to the procedure which issued
  81 the KTR.
  82 .It Fl t
  83 Print the timestamp for each entry.
  84 .Xr ktr 4
  85 manual page.
  86 .It Fl N Ar execfile
  87 The kernel image to resolve symbols from.
  88 The default is the value returned via
  89 .Xr getbootfile 3 .
  90 .It Fl M Ar corefile
  91 The core file or memory image to read from.
  92 The default is
  93 .Pa /dev/mem .
  94 .It Fl o Ar outfile
  95 The file to write the output to.
  96 The default is standard output.
  97 .El
  98 .Sh OPERATIONAL NOTES
  99 Users of
 100 .Nm
 101 should keep in mind that the act of trace logging will itself effect
 102 execution overheads.  On a 2Ghz cpu a logging call can take anywhere
 103 from 40ns to 150ns to run.
 104 .Pp
 105 The TSC counter is used on cpus equipped with it (which is all modern cpus).
 106 The TSC counters may not be synchronized on SMP systems and may drift even
 107 between cores on multi-core cpus.  Enabling synchronization between cpus
 108 via the
 109 .Va debug.ktr.resynchronize
 110 sysctl will impose additional system overheads and will generally only be
 111 accurate to within 100ns or so (and perhaps not even that good).
 112 Resynchronization only occurs 10 times a second and serious drift will
 113 cause a great deal of measurement noise when trying to compare events occurring
 114 on two different cpus.
 115 .Pp
 116 Users using the
 117 .Fl s
 118 option should be aware that events for each cpu are independently logged
 119 and one cpu might have more events logged then another, causing earlier
 120 events to be discarded sooner then other cpus.  The beginning portion of
 121 the sorted output may thus show MP related events for one cpu with no
 122 corresponding events for other cpus.
 123 .Pp
 124 It is possible to somewhat characterize KTR logging overheads by setting
 125 the
 126 .Va debug.ktr.testlogcnt
 127 sysctl and then observing test logging events in the KTR output.  Tests 1-3
 128 log four dummy arguments while tests 4-6 log no arguments.
 129 .Pp
 130 It is possible to characterize IPI messaging latencies by setting the
 131 .Va debug.ktr.testipicnt
 132 sysctl.   A small number between 1 and 1000 is recommended.  This will
 133 cause the system to ping pong a single IPI message between cpu 0 and cpu 1
 134 asynchronously that number of times, as fast as it can.  A
 135 .Nm
 136 should be performed almost immediately after setting the sysctl or you
 137 might miss the logged events.
 138 .Sh SEE ALSO
 139 .Xr ktr 4 ,
 140 .Xr ktr 9
 141 .Sh HISTORY
 142 The
 143 .Nm
 144 utility first appeared in
 145 .Fx 5.0 .
 146 .Sh AUTHORS
 147 .An -nosplit
 148 The
 149 .Nm
 150 utility was originally implemented by
 151 .An Jake Burkholder Aq jake@FreeBSD.org .
 152 This manual page was originally written by
 153 .An Chad David Aq davidc@FreeBSD.org .
 154 The program and manual page were rewritten pretty much from
 155 scratch by
 156 .An Matthew Dillon
 157 for
 158 .Dx .