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