freebsd-src/usr.sbin/crashinfo/crashinfo.sh
Mark Johnston 2524b7dfb0 crashinfo: Print stack traces for all on-CPU threads
Add a python script which implements the bulk of this functionality.
Over time, this would ideally evolve into a library of python routines
which can be used to inspect kernel data structures and automate some
debugging tasks, similar to jhb's out-of-tree scripts, but written in a
somewhat nicer language and with better integration into the kgdb
command prompt.

Note that kgdb currently won't auto-load scripts in this directory.
This should perhaps change in the future.  It probably also makes more
sense to have a crashinfo.py which provides all the kgdb output that we
want to include in core.txt, rather than having crashinfo.sh pipe in
several commands.

Reviewed by:	avg, imp
Discussed with:	jhb
MFC after:	3 weeks
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D33817
2024-01-15 16:36:40 -05:00

348 lines
7.9 KiB
Bash
Executable file

#!/bin/sh
#
# SPDX-License-Identifier: BSD-3-Clause
#
# Copyright (c) 2008 Yahoo!, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# 3. Neither the name of the author nor the names of any co-contributors
# may be used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
usage()
{
echo "usage: crashinfo [-b] [-d crashdir] [-n dumpnr]" \
"[-k kernel] [core]"
exit 1
}
# Remove an uncompressed copy of a dump
cleanup()
{
[ -e $VMCORE ] && rm -f $VMCORE
}
# Run a single gdb command against a kernel file in batch mode.
# The kernel file is specified as the first argument and the command
# is given in the remaining arguments.
gdb_command()
{
local k
k=$1 ; shift
${GDB} -batch -ex "$@" $k
}
find_kernel()
{
local ivers k kvers
ivers=$(awk '
/Version String/ {
print
nextline=1
next
}
nextline==1 {
if ($0 ~ "^ [A-Za-z ]+: ") {
nextline=0
} else {
print
}
}' $INFO)
# Look for a matching kernel version, handling possible truncation
# of the version string recovered from the dump.
for k in `sysctl -n kern.bootfile` $(ls -t /boot/*/kernel); do
kvers=$(gdb_command $k 'printf " Version String: %s", version' | \
awk "{line=line\$0\"\n\"} END{print substr(line,1,${#ivers})}" \
2>/dev/null)
if [ "$ivers" = "$kvers" ]; then
KERNEL=$k
break
fi
done
}
BATCH=false
CRASHDIR=/var/crash
DUMPNR=
KERNEL=
while getopts "bd:n:k:" opt; do
case "$opt" in
b)
BATCH=true
;;
d)
CRASHDIR=$OPTARG
;;
n)
DUMPNR=$OPTARG
;;
k)
KERNEL=$OPTARG
;;
\?)
usage
;;
esac
done
shift $((OPTIND - 1))
if [ $# -eq 1 ]; then
if [ -n "$DUMPNR" ]; then
echo "-n and an explicit vmcore are mutually exclusive"
usage
fi
# Figure out the crash directory and number from the vmcore name.
CRASHDIR=`dirname $1`
DUMPNR=$(expr $(basename $1) : 'vmcore\.\([0-9]*\)')
if [ -z "$DUMPNR" ]; then
echo "Unable to determine dump number from vmcore file $1."
exit 1
fi
elif [ $# -gt 1 ]; then
usage
else
# If we don't have an explicit dump number, operate on the most
# recent dump.
if [ -z "$DUMPNR" ]; then
if ! [ -r $CRASHDIR/bounds ]; then
echo "No crash dumps in $CRASHDIR."
exit 1
fi
next=`cat $CRASHDIR/bounds`
if [ -z "$next" ] || [ "$next" -eq 0 ]; then
echo "No crash dumps in $CRASHDIR."
exit 1
fi
DUMPNR=$(($next - 1))
fi
fi
VMCORE=$CRASHDIR/vmcore.$DUMPNR
INFO=$CRASHDIR/info.$DUMPNR
FILE=$CRASHDIR/core.txt.$DUMPNR
HOSTNAME=`hostname`
if $BATCH; then
echo "Writing crash summary to $FILE."
exec > $FILE 2>&1
fi
GDB=/usr/local/bin/gdb
if [ ! -x "$GDB" ]; then
echo "Unable to find a kernel debugger."
echo "Please install the devel/gdb port or gdb package."
exit 1
fi
if [ ! -e $VMCORE ]; then
if [ -e $VMCORE.gz ]; then
trap cleanup EXIT HUP INT QUIT TERM
gzcat $VMCORE.gz > $VMCORE
elif [ -e $VMCORE.zst ]; then
trap cleanup EXIT HUP INT QUIT TERM
zstdcat $VMCORE.zst > $VMCORE
else
echo "$VMCORE not found"
exit 1
fi
fi
if [ ! -e $INFO ]; then
echo "$INFO not found"
exit 1
fi
# If the user didn't specify a kernel, then try to find one.
if [ -z "$KERNEL" ]; then
find_kernel
if [ -z "$KERNEL" ]; then
echo "Unable to find matching kernel for $VMCORE"
exit 1
fi
elif [ ! -e $KERNEL ]; then
echo "$KERNEL not found"
exit 1
fi
umask 077
# Simulate uname
ostype=$(gdb_command $KERNEL 'printf "%s", ostype')
osrelease=$(gdb_command $KERNEL 'printf "%s", osrelease')
version=$(gdb_command $KERNEL 'printf "%s", version' | tr '\t\n' ' ')
machine=$(gdb_command $KERNEL 'printf "%s", machine')
if ! $BATCH; then
echo "Writing crash summary to $FILE."
exec > $FILE 2>&1
fi
echo "$HOSTNAME dumped core - see $VMCORE"
echo
date
echo
echo "$ostype $HOSTNAME $osrelease $version $machine"
echo
sed -ne '/^ Panic String: /{s//panic: /;p;}' $INFO
echo
file=`mktemp /tmp/crashinfo.XXXXXX`
if [ $? -eq 0 ]; then
scriptdir=/usr/libexec/kgdb
echo "bt -full" >> $file
echo "source ${scriptdir}/acttrace.py" >> $file
echo "acttrace" >> $file
echo "quit" >> $file
${GDB%gdb}kgdb -q $KERNEL $VMCORE < $file
rm -f $file
echo
fi
echo
echo "------------------------------------------------------------------------"
echo "ps -axlww"
echo
ps -M $VMCORE -N $KERNEL -axlww
echo
echo "------------------------------------------------------------------------"
echo "vmstat -s"
echo
vmstat -M $VMCORE -N $KERNEL -s
echo
echo "------------------------------------------------------------------------"
echo "vmstat -m"
echo
vmstat -M $VMCORE -N $KERNEL -m
echo
echo "------------------------------------------------------------------------"
echo "vmstat -z"
echo
vmstat -M $VMCORE -N $KERNEL -z
echo
echo "------------------------------------------------------------------------"
echo "vmstat -i"
echo
vmstat -M $VMCORE -N $KERNEL -i
echo
echo "------------------------------------------------------------------------"
echo "pstat -T"
echo
pstat -M $VMCORE -N $KERNEL -T
echo
echo "------------------------------------------------------------------------"
echo "pstat -s"
echo
pstat -M $VMCORE -N $KERNEL -s
echo
echo "------------------------------------------------------------------------"
echo "iostat"
echo
iostat -M $VMCORE -N $KERNEL
echo
echo "------------------------------------------------------------------------"
echo "ipcs -a"
echo
ipcs -C $VMCORE -N $KERNEL -a
echo
echo "------------------------------------------------------------------------"
echo "ipcs -T"
echo
ipcs -C $VMCORE -N $KERNEL -T
echo
# XXX: This doesn't actually work in 5.x+
if false; then
echo "------------------------------------------------------------------------"
echo "w -dn"
echo
w -M $VMCORE -N $KERNEL -dn
echo
fi
echo "------------------------------------------------------------------------"
echo "netstat -s"
echo
netstat -M $VMCORE -N $KERNEL -s
echo
echo "------------------------------------------------------------------------"
echo "netstat -m"
echo
netstat -M $VMCORE -N $KERNEL -m
echo
echo "------------------------------------------------------------------------"
echo "netstat -anA"
echo
netstat -M $VMCORE -N $KERNEL -anA
echo
echo "------------------------------------------------------------------------"
echo "netstat -aL"
echo
netstat -M $VMCORE -N $KERNEL -aL
echo
echo "------------------------------------------------------------------------"
echo "fstat"
echo
fstat -M $VMCORE -N $KERNEL
echo
echo "------------------------------------------------------------------------"
echo "dmesg"
echo
dmesg -a -M $VMCORE -N $KERNEL
echo
echo "------------------------------------------------------------------------"
echo "kernel config"
echo
config -x $KERNEL
echo
echo "------------------------------------------------------------------------"
echo "ddb capture buffer"
echo
ddb capture -M $VMCORE -N $KERNEL print