xref: /dflybsd-src/usr.sbin/crashinfo/crashinfo.8 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\" Copyright (c) 2008 Yahoo!, Inc.
286d7f5d3SJohn Marino.\" All rights reserved.
386d7f5d3SJohn Marino.\"
486d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
586d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
686d7f5d3SJohn Marino.\" are met:
786d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
886d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
986d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
1086d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
1186d7f5d3SJohn Marino.\"    documentation and/or other materials provided with the distribution.
1286d7f5d3SJohn Marino.\" 3. Neither the name of the author nor the names of any co-contributors
1386d7f5d3SJohn Marino.\"    may be used to endorse or promote products derived from this software
1486d7f5d3SJohn Marino.\"    without specific prior written permission.
1586d7f5d3SJohn Marino.\"
1686d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1786d7f5d3SJohn Marino.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1886d7f5d3SJohn Marino.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1986d7f5d3SJohn Marino.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
2086d7f5d3SJohn Marino.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2186d7f5d3SJohn Marino.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2286d7f5d3SJohn Marino.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2386d7f5d3SJohn Marino.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2486d7f5d3SJohn Marino.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2586d7f5d3SJohn Marino.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2686d7f5d3SJohn Marino.\" SUCH DAMAGE.
2786d7f5d3SJohn Marino.\"
2886d7f5d3SJohn Marino.Dd June 28, 2008
2986d7f5d3SJohn Marino.Dt CRASHINFO 8
3086d7f5d3SJohn Marino.Os
3186d7f5d3SJohn Marino.Sh NAME
3286d7f5d3SJohn Marino.Nm crashinfo
3386d7f5d3SJohn Marino.Nd "analyze a core dump of the operating system"
3486d7f5d3SJohn Marino.Sh SYNOPSIS
3586d7f5d3SJohn Marino.Nm
3686d7f5d3SJohn Marino.Op Fl d Ar crashdir
3786d7f5d3SJohn Marino.Op Fl n Ar dumpnr
3886d7f5d3SJohn Marino.Op Fl k Ar kernel
3986d7f5d3SJohn Marino.Op Ar core
4086d7f5d3SJohn Marino.Sh DESCRIPTION
4186d7f5d3SJohn MarinoThe
4286d7f5d3SJohn Marino.Nm
4386d7f5d3SJohn Marinoutility analyzes a core dump saved by
4486d7f5d3SJohn Marino.Xr savecore 8 .
4586d7f5d3SJohn MarinoIt generates a text file containing the analysis in the same directory as
4686d7f5d3SJohn Marinothe core dump.
4786d7f5d3SJohn MarinoFor a given core dump file named
4886d7f5d3SJohn Marino.Pa vmcore.XX
4986d7f5d3SJohn Marinothe generated text file will be named
5086d7f5d3SJohn Marino.Pa core.txt.XX .
5186d7f5d3SJohn Marino.Pp
5286d7f5d3SJohn MarinoBy default,
5386d7f5d3SJohn Marino.Nm
5486d7f5d3SJohn Marinoanalyzes the most recent core dump in the core dump directory.
5586d7f5d3SJohn MarinoA specific core dump may be specified via either the
5686d7f5d3SJohn Marino.Ar core
5786d7f5d3SJohn Marinoor
5886d7f5d3SJohn Marino.Ar dumpnr
5986d7f5d3SJohn Marinoarguments.
6086d7f5d3SJohn MarinoOnce
6186d7f5d3SJohn Marino.Nm
6286d7f5d3SJohn Marinohas located a core dump,
6386d7f5d3SJohn Marinoit analyzes the core dump to determine the exact version of the kernel
6486d7f5d3SJohn Marinothat generated the core.
6586d7f5d3SJohn MarinoIt then looks for a matching kernel file under each of the subdirectories in
6686d7f5d3SJohn Marino.Pa /boot .
6786d7f5d3SJohn MarinoThe location of the kernel file can also be explicitly provided via the
6886d7f5d3SJohn Marino.Ar kernel
6986d7f5d3SJohn Marinoargument.
7086d7f5d3SJohn Marino.Pp
7186d7f5d3SJohn MarinoOnce
7286d7f5d3SJohn Marino.Nm
7386d7f5d3SJohn Marinohas located a core dump and kernel,
7486d7f5d3SJohn Marinoit uses several utilities to analyze the core including
7586d7f5d3SJohn Marino.Xr dmesg 8 ,
7686d7f5d3SJohn Marino.Xr fstat 1 ,
7786d7f5d3SJohn Marino.Xr iostat 8 ,
7886d7f5d3SJohn Marino.Xr ipcs 1 ,
7986d7f5d3SJohn Marino.Xr kgdb 1 ,
8086d7f5d3SJohn Marino.Xr netstat 1 ,
8186d7f5d3SJohn Marino.Xr nfsstat 1 ,
8286d7f5d3SJohn Marino.Xr ps 1 ,
8386d7f5d3SJohn Marino.Xr pstat 8 ,
8486d7f5d3SJohn Marinoand
8586d7f5d3SJohn Marino.Xr vmstat 8 .
8686d7f5d3SJohn Marino.Pp
8786d7f5d3SJohn MarinoThe options are as follows:
8886d7f5d3SJohn Marino.Bl -tag -width indent
8986d7f5d3SJohn Marino.It Fl d Ar crashdir
9086d7f5d3SJohn MarinoSpecify an alternate core dump directory.
9186d7f5d3SJohn MarinoThe default crash dump directory is
9286d7f5d3SJohn Marino.Pa /var/crash .
9386d7f5d3SJohn Marino.It Fl n Ar dumpnr
9486d7f5d3SJohn MarinoUse the core dump saved in
9586d7f5d3SJohn Marino.Pa vmcore. Ns Ar dumpnr
9686d7f5d3SJohn Marinoinstead of the latest core in the core dump directory.
9786d7f5d3SJohn Marino.It Fl k Ar kernel
9886d7f5d3SJohn MarinoSpecify an explicit kernel file.
9986d7f5d3SJohn Marino.El
10086d7f5d3SJohn Marino.Sh SEE ALSO
10186d7f5d3SJohn Marino.Xr savecore 8
10286d7f5d3SJohn Marino.Sh HISTORY
10386d7f5d3SJohn MarinoThe
10486d7f5d3SJohn Marino.Nm
10586d7f5d3SJohn Marinoutility appeared in
10686d7f5d3SJohn Marino.Dx 2.7 .
107