#!/bin/sh
#
# 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.
#
# $FreeBSD: stable/11/usr.sbin/crashinfo/crashinfo.sh 321569 2017-07-26 17:36:58Z markj $

proc usage
{
	echo "usage: crashinfo [-d crashdir] [-n dumpnr] [-k kernel] [core]"
	exit 1
}

# 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.
proc gdb_command
{
	local k

	setglobal k = $1 ; shift

	if test -x /usr/local/bin/gdb {
		/usr/local/bin/gdb -batch -ex @ARGV $k
	} else {
		echo -e @ARGV | /usr/bin/gdb -x /dev/stdin -batch $k
	}
}

proc find_kernel
{
	local ivers k kvers

	setglobal 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]] {
		setglobal kvers = $[gdb_command $k 'printf "  Version String: %s", version' | \
		    awk "{line=line\$0\"\n\"} END{print substr(line,1,$(#ivers))}]
		if test $ivers = $kvers {
			setglobal KERNEL = $k
			break
		}
	}
}

setglobal CRASHDIR = '/var/crash'
setglobal DUMPNR = ''
setglobal KERNEL = ''

while getopts "d:n:k:" opt {
	match $opt {
	with d
		setglobal CRASHDIR = $OPTARG
		
	with n
		setglobal DUMPNR = $OPTARG
		
	with k
		setglobal KERNEL = $OPTARG
		
	with \?
		usage
		
	}
}

shift $shExpr('OPTIND - 1')

if test $Argc -eq 1 {
	if test -n $DUMPNR {
		echo "-n and an explicit vmcore are mutually exclusive"
		usage
	}

	# Figure out the crash directory and number from the vmcore name.
	setglobal CRASHDIR = $[dirname $1]
	setglobal DUMPNR = $[expr $[basename $1] : 'vmcore\.\([0-9]*\)$]
	if test -z $DUMPNR {
		echo "Unable to determine dump number from vmcore file $1."
		exit 1
	}
} elif test $Argc -gt 1 {
	usage
} else {
	# If we don't have an explicit dump number, operate on the most
	# recent dump.
	if test -z $DUMPNR {
		if ! test -r $CRASHDIR/bounds {
			echo "No crash dumps in $CRASHDIR."
			exit 1
		}			
		setglobal next = $[cat $CRASHDIR/bounds]
		if test -z $next || test $next -eq 0 {
			echo "No crash dumps in $CRASHDIR."
			exit 1
		}
		setglobal DUMPNR = $shExpr('$next - 1')
	}
}

setglobal VMCORE = "$CRASHDIR/vmcore.$DUMPNR"
setglobal INFO = "$CRASHDIR/info.$DUMPNR"
setglobal FILE = "$CRASHDIR/core.txt.$DUMPNR"
setglobal HOSTNAME = $[hostname]

if test ! -e $VMCORE {
	echo "$VMCORE not found"
	exit 1
}

if test ! -e $INFO {
	echo "$INFO not found"
	exit 1
}

# If the user didn't specify a kernel, then try to find one.
if test -z $KERNEL {
	find_kernel
	if test -z $KERNEL {
		echo "Unable to find matching kernel for $VMCORE"
		exit 1
	}
} elif test ! -e $KERNEL {
	echo "$KERNEL not found"
	exit 1
}

echo "Writing crash summary to $FILE."

umask 077

# Simulate uname
setglobal ostype = $[gdb_command $KERNEL 'printf "%s", ostype]
setglobal osrelease = $[gdb_command $KERNEL 'printf "%s", osrelease]
setglobal version = $[gdb_command $KERNEL 'printf "%s", version' | tr '\t\n' '  ]
setglobal machine = $[gdb_command $KERNEL 'printf "%s", machine]

exec > $FILE 2>&1

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

# XXX: /bin/sh on 7.0+ is broken so we can't simply pipe the commands to
# kgdb via stdin and have to use a temporary file instead.
setglobal file = $[mktemp /tmp/crashinfo.XXXXXX]
if test $Status -eq 0 {
	echo "bt" >> $file
	echo "quit" >> $file
	if test -x /usr/local/bin/kgdb {
		/usr/local/bin/kgdb $KERNEL $VMCORE < $file
	} else {
		kgdb $KERNEL $VMCORE < $file
	}
	rm -f $file
	echo
}
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 {
echo "------------------------------------------------------------------------"
echo "w -dn"
echo
w -M $VMCORE -N $KERNEL -dn
echo
}

echo "------------------------------------------------------------------------"
echo "nfsstat"
echo
nfsstat -M $VMCORE -N $KERNEL
echo

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