usr.bin/kdump/kdump.1

   1 .\" Copyright (c) 1990, 1993
   2 .\"     The Regents of the University of California.  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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)kdump.1     8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd January 28, 2005
  36 .Dt KDUMP 1
  37 .Os
  38 .Sh NAME
  39 .Nm kdump
  40 .Nd display kernel trace data
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl dEnlHRT
  44 .Op Fl f Ar trfile
  45 .Op Fl m Ar maxdata
  46 .Op Fl p Ar pid
  47 .Op Fl t Op cnisuw
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 command displays the kernel trace files produced with
  52 .Xr ktrace 1
  53 in human readable format.
  54 By default, the file
  55 .Pa ktrace.out
  56 in the current directory is displayed.
  57 .Pp
  58 The options are as follows:
  59 .Bl -tag -width Fl
  60 .It Fl d
  61 Display all numbers in decimal.
  62 .It Fl E
  63 Display elapsed timestamps (time since beginning of trace).
  64 .It Fl f Ar trfile
  65 Display the specified file instead of
  66 .Pa ktrace.out .
  67 .It Fl H
  68 List the thread id (tid) of the thread with each trace record, if available.
  69 If no thread id is available, 0 will be printed.
  70 .It Fl l
  71 Loop reading the trace file, once the end-of-file is reached, waiting for
  72 more data.
  73 .It Fl m Ar maxdata
  74 Display at most
  75 .Ar maxdata
  76 bytes when decoding
  77 .Tn I/O .
  78 .It Fl n
  79 Suppress ad hoc translations.
  80 Normally
  81 .Nm
  82 tries to decode many system calls into a more human readable format.
  83 For example,
  84 .Xr ioctl 2
  85 values are replaced with the macro name and
  86 .Va errno
  87 values are replaced with the
  88 .Xr strerror 3
  89 string.
  90 Suppressing this feature yields a more consistent output format and is
  91 easily amenable to further processing.
  92 .It Fl p Ar pid
  93 Display only trace events that correspond to the process
  94 .Ar pid .
  95 This may be useful when there are multiple processes recorded in the
  96 same trace file.
  97 .It Fl R
  98 Display relative timestamps (time since previous entry).
  99 .It Fl T
 100 Display absolute timestamps for each entry (seconds since epoch).
 101 .It Fl t Ar cnisuw
 102 See the
 103 .Fl t
 104 option of
 105 .Xr ktrace 1 .
 106 .El
 107 .Pp
 108 The output format of
 109 .Nm
 110 is line oriented with several fields.
 111 The example below shows a section of a kdump generated by the following
 112 commands:
 113 .Bd -literal -offset indent
 114 ?> ktrace echo "ktrace"
 115
 116 ?> kdump
 117
 118  85045 echo     CALL  writev(0x1,0x804b030,0x2)
 119  85045 echo     GIO   fd 1 wrote 7 bytes
 120        "ktrace
 121        "
 122  85045 echo     RET   writev 7
 123 .Ed
 124 .Pp
 125 The first field is the PID of the process being traced.
 126 The second field is the name of the program being traced.
 127 The third field is the operation that the kernel performed
 128 on behalf of the process.
 129 If thread IDs are being printed, then an additional thread ID column will be
 130 added to the output between the PId field and program name field.
 131 .Pp
 132 In the first line above, the kernel executes the
 133 .Xr writev 2
 134 system call on behalf of the process so this is a
 135 .Li CALL
 136 operation.
 137 The fourth field shows the system call that was executed,
 138 including its arguments.
 139 The
 140 .Xr writev 2
 141 system call takes a file descriptor, in this case 1, or standard
 142 output, then a pointer to the iovector to write, and the number of
 143 iovectors that are to be written.
 144 In the second line we see the operation was
 145 .Li GIO ,
 146 for general I/O, and that file descriptor 1 had
 147 seven bytes written to it.
 148 This is followed by the seven bytes that were written, the string
 149 .Qq Li ktrace
 150 with a carriage return and line feed.
 151 The last line is the
 152 .Li RET
 153 operation, showing a return from the kernel, what system call we are
 154 returning from, and the return value that the process received.
 155 Seven bytes were written by the
 156 .Xr writev 2
 157 system call, so 7 is the return value.
 158 .Pp
 159 The possible operations are:
 160 .Bl -column -offset indent ".Li GENIO" ".No data from user process"
 161 .It Sy Name Ta Sy Operation Ta Sy Fourth field
 162 .It Li CALL Ta enter syscall Ta syscall name and arguments
 163 .It Li RET Ta return from syscall Ta syscall name and return value
 164 .It Li NAMI Ta file name lookup Ta path to file
 165 .It Li GENIO Ta general I/O Ta fd, read/write, number of bytes
 166 .It Li SIG Ta signal Ta signal name, handler, mask, code
 167 .It Li CSW Ta context switch Ta stop/resume user/kernel
 168 .It Li USER Ta data from user process Ta the data
 169 .El
 170 .Sh SEE ALSO
 171 .Xr ktrace 1
 172 .Sh HISTORY
 173 The
 174 .Nm
 175 command appeared in
 176 .Bx 4.4 .