Add zloop.sh test script

Add Chris Williamson's "new" zloop script so that it may be
intergated with ZoLs automated testing.  The original script may
be found in the openzfs-build repository on Github.

Minor modifications were made to the script so it can be run
directly from the ZoL source tree or from installed packages.

Additionally it was updated to use gdb instead of mdb to
extact debugging information from a core dump.

References:
  https://github.com/openzfs/openzfs-build/commit/7fb5d8b
  https://github.com/openzfs/openzfs-build/blob/master/ansible/roles/openzfs-jenkins-slave/files/usr/local/zloop.sh

Signed-off-by: Brian Behlendorf <[email protected]>
Closes #4441

3 files changed, 215 insertions, 0 deletions

diff --git a/scripts/Makefile.am b/scripts/Makefile.am
index 32d8911c3..c15207a7a 100644
--- a/scripts/Makefile.am
+++ b/scripts/Makefile.am
@@ -10,6 +10,7 @@ dist_pkgdata_SCRIPTS = \
 	$(top_srcdir)/scripts/zimport.sh \
 	$(top_srcdir)/scripts/zfs.sh \
 	$(top_srcdir)/scripts/zfs-tests.sh \
+	$(top_srcdir)/scripts/zloop.sh \
 	$(top_srcdir)/scripts/zpool-create.sh \
 	$(top_srcdir)/scripts/zpios.sh \
 	$(top_srcdir)/scripts/zpios-sanity.sh \
diff --git a/scripts/common.sh.in b/scripts/common.sh.in
index f6c6d93fe..4ce177e32 100644
--- a/scripts/common.sh.in
+++ b/scripts/common.sh.in
@@ -79,6 +79,7 @@ SCSIRESCAN=${SCSIRESCAN:-/usr/bin/scsi-rescan}
 SYSCTL=${SYSCTL:-/sbin/sysctl}
 UDEVADM=${UDEVADM:-/sbin/udevadm}
 AWK=${AWK:-/usr/bin/awk}
+GDB=${GDB:-/usr/bin/gdb}
 
 ZED_PIDFILE=${ZED_PIDFILE:-${localstatedir}/run/zed.pid}
 
diff --git a/scripts/zloop.sh b/scripts/zloop.sh
new file mode 100755
index 000000000..26ad1780c
--- /dev/null
+++ b/scripts/zloop.sh
@@ -0,0 +1,213 @@
+#!/bin/sh
+
+#
+# CDDL HEADER START
+#
+# This file and its contents are supplied under the terms of the
+# Common Development and Distribution License ("CDDL"), version 1.0.
+# You may only use this file in accordance with the terms of version
+# 1.0 of the CDDL.
+#
+# A full copy of the text of the CDDL should have accompanied this
+# source.  A copy of the CDDL is also available via the Internet at
+# http://www.illumos.org/license/CDDL.
+#
+# CDDL HEADER END
+#
+
+#
+# Copyright (c) 2015 by Delphix. All rights reserved.
+# Copyright (C) 2016 Lawrence Livermore National Security, LLC.
+#
+
+basedir="$(dirname $0)"
+
+SCRIPT_COMMON=common.sh
+if [ -f "${basedir}/${SCRIPT_COMMON}" ]; then
+	. "${basedir}/${SCRIPT_COMMON}"
+else
+	echo "Missing helper script ${SCRIPT_COMMON}" && exit 1
+fi
+
+PROG=zloop.sh
+
+DEFAULTWORKDIR=/var/tmp
+DEFAULTCOREDIR=/var/tmp/zloop
+
+function usage
+{
+	echo -e "\n$0 [-t <timeout>] [-c <dump directory>]" \
+	    "[ -- [extra ztest parameters]]\n" \
+	    "\n" \
+	    "  This script runs ztest repeatedly with randomized arguments.\n" \
+	    "  If a crash is encountered, the ztest logs, any associated\n" \
+	    "  vdev files, and core file (if one exists) are moved to the\n" \
+	    "  output directory ($DEFAULTCOREDIR by default). Any options\n" \
+	    "  after the -- end-of-options marker will be passed to ztest.\n" \
+	    "\n" \
+	    "  Options:\n" \
+	    "    -t  Total time to loop for, in seconds. If not provided,\n" \
+	    "        zloop runs forever.\n" \
+	    "    -f  Specify working directory for ztest vdev files.\n" \
+	    "    -c  Specify a core dump directory to use.\n" \
+	    "    -h  Print this help message.\n" \
+	    "" >&2
+}
+
+function or_die
+{
+	$@
+	if [[ $? -ne 0 ]]; then
+		echo "Command failed: $@"
+		exit 1
+	fi
+}
+
+function store_core
+{
+	if [[ $ztrc -ne 0 ]] || [[ -f core ]]; then
+		coreid=$(date "+zloop-%y%m%d-%H%M%S")
+		foundcrashes=$(($foundcrashes + 1))
+
+		dest=$coredir/$coreid
+		or_die mkdir -p $dest
+		or_die mkdir -p $dest/vdev
+
+		echo "*** ztest crash found - moving logs to $dest"
+
+		or_die mv ztest.history $dest/
+		or_die mv ztest.ddt $dest/
+		or_die mv ztest.out $dest/
+		or_die mv $workdir/ztest* $dest/vdev/
+		or_die mv $workdir/zpool.cache $dest/vdev/
+
+		# check for core
+		if [[ -f core ]]; then
+			corestatus=$($GDB --batch --quiet \
+			    -ex "set print thread-events off" \
+			    -ex "printf \"*\n* Backtrace \n*\n\"" \
+			    -ex "bt" \
+			    -ex "printf \"*\n* Libraries \n*\n\"" \
+			    -ex "info sharedlib" \
+			    -ex "printf \"*\n* Threads (full) \n*\n\"" \
+			    -ex "info threads" \
+			    -ex "printf \"*\n* Backtraces \n*\n\"" \
+			    -ex "thread apply all bt" \
+			    -ex "printf \"*\n* Backtraces (full) \n*\n\"" \
+			    -ex "thread apply all bt full" \
+			    -ex "quit" $ZTEST core | grep -v "New LWP")
+
+			# Dump core + logs to stored directory
+			echo "$corestatus" >>$dest/status
+			or_die mv core $dest/
+
+			# Record info in cores logfile
+			echo "*** core @ $coredir/$coreid/core:" | \
+			    tee -a ztest.cores
+			echo "$corestatus" | tee -a ztest.cores
+			echo "" | tee -a ztest.cores
+		fi
+		echo "continuing..."
+	fi
+}
+
+# parse arguments
+# expected format: zloop [-t timeout] [-c coredir] [-- extra ztest args]
+coredir=$DEFAULTCOREDIR
+workdir=$DEFAULTWORKDIR
+timeout=0
+while getopts ":ht:c:f:" opt; do
+	case $opt in
+		t ) [[ $OPTARG -gt 0 ]] && timeout=$OPTARG ;;
+		c ) [[ $OPTARG ]] && coredir=$OPTARG ;;
+		f ) [[ $OPTARG ]] && workdir=$(readlink -f $OPTARG) ;;
+		h ) usage
+		    exit 2
+		    ;;
+		* ) echo "Invalid argument: -$OPTARG";
+		    usage
+		    exit 1
+	esac
+done
+# pass remaining arguments on to ztest
+shift $((OPTIND - 1))
+
+# enable core dumps
+ulimit -c unlimited
+
+if [[ -f core ]]; then
+	echo "There's a core dump here you might want to look at first."
+	exit 1
+fi
+
+if [[ ! -d $coredir ]]; then
+	echo "core dump directory ($coredir) does not exist, creating it."
+	or_die mkdir -p $coredir
+fi
+
+if [[ ! -w $coredir ]]; then
+	echo "core dump directory ($coredir) is not writable."
+	exit 1
+fi
+
+or_die rm -f ztest.history
+or_die rm -f ztest.ddt
+or_die rm -f ztest.cores
+
+ztrc=0		# ztest return value
+foundcrashes=0	# number of crashes found so far
+starttime=$(date +%s)
+curtime=$starttime
+
+# if no timeout was specified, loop forever.
+while [[ $timeout -eq 0 ]] || [[ $curtime -le $(($starttime + $timeout)) ]]; do
+	zopt="-VVVVV"
+
+	# switch between common arrangements & fully randomized
+	if [[ $((RANDOM % 2)) -eq 0 ]]; then
+		mirrors=2
+		raidz=0
+		parity=1
+		vdevs=2
+	else
+		mirrors=$(((RANDOM % 3) * 1))
+		parity=$(((RANDOM % 3) + 1))
+		raidz=$((((RANDOM % 9) + parity + 1) * (RANDOM % 2)))
+		vdevs=$(((RANDOM % 3) + 3))
+	fi
+	align=$(((RANDOM % 2) * 3 + 9))
+	runtime=$((RANDOM % 100))
+	passtime=$((RANDOM % (runtime / 3 + 1) + 10))
+	size=128m
+
+	zopt="$zopt -m $mirrors"
+	zopt="$zopt -r $raidz"
+	zopt="$zopt -R $parity"
+	zopt="$zopt -v $vdevs"
+	zopt="$zopt -a $align"
+	zopt="$zopt -T $runtime"
+	zopt="$zopt -P $passtime"
+	zopt="$zopt -s $size"
+	zopt="$zopt -f $workdir"
+
+	cmd="$ZTEST $zopt $@"
+	desc="$(date '+%m/%d %T') $cmd"
+	echo "$desc" | tee -a ztest.history
+	echo "$desc" >>ztest.out
+	$cmd >>ztest.out 2>&1
+	ztrc=$?
+	egrep '===|WARNING' ztest.out >>ztest.history
+	$ZDB -U $workdir/zpool.cache -DD ztest >>ztest.ddt
+
+	store_core
+
+	curtime=$(date +%s)
+done
+
+echo "zloop finished, $foundcrashes crashes found"
+
+uptime >>ztest.out
+
+if [[ $foundcrashes -gt 0 ]]; then
+	exit 1
+fi