xref: /freebsd/usr.sbin/crashinfo/crashinfo.8 (revision 4d846d260e2b9a3d4d0a701462568268cbfe7a5b)
1.\" Copyright (c) 2008 Yahoo!, Inc.
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.\" 3. Neither the name of the author nor the names of any co-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 AUTHOR 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 AUTHOR 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.\" $FreeBSD$
29.\"
30.Dd December 2, 2020
31.Dt CRASHINFO 8
32.Os
33.Sh NAME
34.Nm crashinfo
35.Nd "analyze a core dump of the operating system"
36.Sh SYNOPSIS
37.Nm
38.Op Fl d Ar crashdir
39.Op Fl n Ar dumpnr
40.Op Fl k Ar kernel
41.Op Ar core
42.Sh DESCRIPTION
43The
44.Nm
45utility analyzes a core dump saved by
46.Xr savecore 8 .
47It generates a text file containing the analysis in the same directory as
48the core dump.
49For a given core dump file named
50.Pa vmcore.XX
51the generated text file will be named
52.Pa core.txt.XX .
53.Pp
54By default,
55.Nm
56analyzes the most recent core dump in the core dump directory.
57A specific core dump may be specified via either the
58.Ar core
59or
60.Ar dumpnr
61arguments.
62Once
63.Nm
64has located a core dump,
65it analyzes the core dump to determine the exact version of the kernel
66that generated the core.
67It then looks for a matching kernel file under each of the subdirectories in
68.Pa /boot .
69The location of the kernel file can also be explicitly provided via the
70.Ar kernel
71argument.
72.Pp
73Once
74.Nm
75has located a core dump and kernel,
76it uses several utilities to analyze the core including
77.Xr dmesg 8 ,
78.Xr fstat 1 ,
79.Xr iostat 8 ,
80.Xr ipcs 1 ,
81.Xr kgdb 1 Pq Pa ports/devel/gdb ,
82.Xr netstat 1 ,
83.Xr nfsstat 1 ,
84.Xr ps 1 ,
85.Xr pstat 8 ,
86and
87.Xr vmstat 8 .
88Note that kgdb must be installed from the devel/gdb port or gdb package.
89.Pp
90The options are as follows:
91.Bl -tag -width indent
92.It Fl b
93Run in batch mode.
94Write most messages to the
95.Pa core.txt.XX
96file instead of the terminal.
97This flag is used when
98.Nm
99is run during boot.
100.It Fl d Ar crashdir
101Specify an alternate core dump directory.
102The default crash dump directory is
103.Pa /var/crash .
104.It Fl n Ar dumpnr
105Use the core dump saved in
106.Pa vmcore. Ns Ar dumpnr
107instead of the latest core in the core dump directory.
108.It Fl k Ar kernel
109Specify an explicit kernel file.
110.El
111.Sh SEE ALSO
112.Xr textdump 4 ,
113.Xr savecore 8
114.Sh HISTORY
115The
116.Nm
117utility appeared in
118.Fx 6.4 .
119