From 6dbfbec8fffd30fe09517c1b4a8e0a82f359fbcf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20Storsj=C3=B6?= <martin@martin.st>
Date: Wed, 14 Sep 2022 23:09:35 +0300
Subject: [PATCH] test: Add a script for running smoke tests of lldb

---
 run-lldb-tests.sh | 130 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 130 insertions(+)
 create mode 100755 run-lldb-tests.sh

diff --git a/run-lldb-tests.sh b/run-lldb-tests.sh
new file mode 100755
index 0000000..72d6cf7
--- /dev/null
+++ b/run-lldb-tests.sh
@@ -0,0 +1,130 @@
+#!/bin/sh
+#
+# Copyright (c) 2022 Martin Storsjo
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+set -ex
+
+if [ $# -lt 1 ]; then
+    echo $0 dest
+    exit 1
+fi
+PREFIX="$1"
+PREFIX="$(cd "$PREFIX" && pwd)"
+export PATH=$PREFIX/bin:$PATH
+
+TARGET=$(clang.exe --version | grep Target: | awk '{print $2}')
+ARCH="${TARGET%%-*}"
+
+cd test
+
+TEST_DIR="$ARCH"
+[ -z "$CLEAN" ] || rm -rf $TEST_DIR
+
+mkdir -p $TEST_DIR
+
+# Build an executable with DWARF debug info
+clang++.exe hello-exception.cpp -o $TEST_DIR/hello-exception-dwarf.exe -g
+
+# Build an executable with PDB debug info
+clang++.exe hello-exception.cpp -o $TEST_DIR/hello-exception-pdb.exe -g -gcodeview -Wl,-pdb=
+# Strip the executable that uses pdb; the crt startup files and mingw static
+# library object files have dwarf debug info, so the binary has got a bit of
+# both, and lldb would choose to use the dwarf parts unless we strip it.
+strip.exe $TEST_DIR/hello-exception-pdb.exe
+
+# Make a DWARF split debug info file with gnu debuglink.
+cp $TEST_DIR/hello-exception-dwarf.exe $TEST_DIR/hello-exception-split.exe
+objcopy.exe --only-keep-debug $TEST_DIR/hello-exception-split.exe $TEST_DIR/hello-exception-split.dbg
+objcopy.exe --strip-all $TEST_DIR/hello-exception-split.exe
+objcopy.exe --add-gnu-debuglink=$TEST_DIR/hello-exception-split.dbg $TEST_DIR/hello-exception-split.exe
+
+for i in libc++ libunwind; do
+    if [ -f $PREFIX/$ARCH-w64-mingw32/bin/$i.dll ]; then
+        cp $PREFIX/$ARCH-w64-mingw32/bin/$i.dll $TEST_DIR
+    fi
+done
+
+
+# Test debugging a crashing executable, and check the backtrace of
+# the crash.
+OUT=lldb-test-out
+SCRIPT=lldb-test-script
+cat > $SCRIPT <<EOF
+run
+bt
+EOF
+for exe in hello-exception-dwarf.exe hello-exception-pdb.exe hello-exception-split.exe; do
+    lldb.exe -b -s $SCRIPT -- $TEST_DIR/$exe -crash < /dev/null > $OUT 2>/dev/null
+    cat $OUT
+    grep -q "Access violation" $OUT
+    if [ "$ARCH" != "armv7" ] || [ "$exe" = "hello-exception-pdb.exe" ]; then
+        grep -q "volatile int.*NULL.*0x42" $OUT
+    fi
+    if [ "$ARCH" != "armv7" ]; then
+        # armv7 pdb gives "val=<unavailable>"
+        grep -q "frame #0: .*hello-exception.*.exe.recurse(val=0) at hello-exception.cpp:" $OUT
+        grep -q "hello-exception.*.exe.recurse(val=10) at hello-exception.cpp:" $OUT
+    fi
+done
+
+exe=hello-exception-dwarf.exe
+if [ "$ARCH" = "armv7" ]; then
+    # LLDB works better on ARM with PDB than with DWARF.
+    exe=hello-exception-pdb.exe
+fi
+
+
+# Test running into a programmatic breakpoint (__debugbreak), check the
+# backtrace from there, and check that we can continue from it.
+cat > $SCRIPT <<EOF
+run
+bt
+cont
+EOF
+lldb.exe -b -s $SCRIPT -- $TEST_DIR/$exe -breakpoint < /dev/null > $OUT 2>/dev/null
+cat $OUT
+grep -q "stop reason = Exception 0x80000003" $OUT
+# Not checking that __debugbreak is "frame #0"; on arm/aarch64, the program
+# counter points into the __debugbreak function, while on x86, it points to
+# the calling recurse function.
+grep -q "__debugbreak" $OUT
+if [ "$ARCH" != "armv7" ]; then
+    grep -q "hello-exception.*.exe.recurse(val=10) at hello-exception.cpp:" $OUT
+fi
+grep -q "exited with status = 0" $OUT
+
+
+# Test setting a breakpoint in LLDB, checking the backtrace when we hit it,
+# stepping from the breakpoint, and running to completion.
+cat > $SCRIPT <<EOF
+b done
+run
+bt
+finish
+cont
+EOF
+lldb.exe -b -s $SCRIPT -- $TEST_DIR/$exe -noop < /dev/null > $OUT 2>/dev/null
+cat $OUT
+grep -q "Breakpoint 1: where = hello-exception.*.exe.done.* at hello-exception.cpp:" $OUT
+grep -q "stop reason = breakpoint" $OUT
+grep -q "frame #0: .*hello-exception.*.exe.done.* at hello-exception.cpp:" $OUT
+if [ "$ARCH" != "armv7" ]; then
+    grep -q "frame #0: .*hello-exception.*.exe.recurse(val=0) at hello-exception.cpp:" $OUT
+    grep -q "hello-exception.*.exe.recurse(val=10) at hello-exception.cpp:" $OUT
+fi
+grep -q "exited with status = 0" $OUT
+
+rm -f $OUT $SCRIPT
+echo All tests succeeded