add CI gdb test

Signed-off-by: Doru Blânzeanu <[email protected]>

Author: dblnz

.github/workflows/dep_rust.yml

@@ -109,12 +109,19 @@ jobs:
         run: just run-rust-examples ${{ matrix.config }}
 
       - name: Run Rust examples - linux
-        if: ${{ (runner.os != 'Windows') }}
+        if: runner.os == 'Linux' && matrix.hypervisor == 'kvm'
         env:
           CARGO_TERM_COLOR: always
           RUST_LOG: debug
         run: just run-rust-examples-linux ${{ matrix.config }} ${{ matrix.hypervisor == 'mshv3' && 'mshv3' || ''}}
 
+      - name: Run Rust Debugging examples - linux
+        if: ${{ (runner.os != 'Windows') && (matrix.config == 'debug') }}
+        env:
+          CARGO_TERM_COLOR: always
+          RUST_LOG: debug
+        run: ./dev/test-gdb.sh
+
       ### Benchmarks ###
       - name: Install github-cli (Linux mariner)
         if: runner.os == 'Linux' && matrix.hypervisor == 'mshv'

dev/test-gdb.sh

@@ -0,0 +1,98 @@
+#!/usr/bin/env bash
+
+# Tests the gdb feature of hyperlight by running a simple program
+# and adding a breakpoint to it.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+wait_for_pids() {
+  local pids=("$@")
+  local timeout=3
+  local elapsed=0
+  local interval=1
+
+  while true; do
+    all_done=true
+    for pid in "${pids[@]}"; do
+      if ps -p "$pid" 2>/dev/null; then
+        all_done=false
+      fi
+    done
+
+    if [ "$all_done" = true ]; then
+      return 0
+    fi
+
+    sleep "$interval"
+    elapsed=$((elapsed + interval))
+
+    if [ "$elapsed" -ge "$timeout" ]; then
+      return 1
+    fi
+
+  done
+}
+
+# Run the example
+cargo run --example guest-debugging --features gdb &
+TARGET_PID=$!
+
+# Wait for the program to start
+sleep 1
+
+# GDB commands to run
+GDB_COMMANDS=$(cat <<EOF
+file src/tests/rust_guests/bin/debug/simpleguest
+target remote :8080
+
+set pagination off
+set logging file gdb.output
+set logging enabled on
+
+break hyperlight_main
+    commands
+    echo "Stopped at hyperlight_main breakpoint\n"
+    backtrace
+    continue
+end
+
+continue
+
+set logging enabled off
+quit
+EOF
+)
+
+# Write the gdb commands to a file
+echo "$GDB_COMMANDS" > gdb-commands.txt
+
+# Run gdb headless with the commands
+gdb --nw -x ./gdb-commands.txt &
+GDB_PID=$!
+
+sleep 1
+
+echo "Waiting for run to finish"
+if wait_for_pids "$TARGET_PID" "$GDB_PID"; then
+    echo "Run finished successfully"
+else
+    echo "GDB did not finish in time"
+
+    for pid in "$TARGET_PID" "$GDB_PID"; do
+      if ps -p "$pid" 2>/dev/null; then
+        echo "Process $pid did not finish in time, killing it"
+        pkill --parent "$pid"
+        pkill "$pid"
+      fi
+    done
+
+    exit 1
+fi
+
+# Check the output
+if ! grep -q "Stopped at hyperlight_main breakpoint" gdb.output; then
+    echo "GDB did not stop at the breakpoint"
+    exit 1
+fi