Add automated GDB testing to server example

Author: bet4it

.github/workflows/cargo-build.yml

@@ -20,6 +20,11 @@ jobs:
       - name: '🦀 Install Rust Toolchain'
         uses: dtolnay/rust-toolchain@stable
 
+      - name: '📦 Install Dependencies'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y gdb-multiarch
+
       - name: '🔨 Build'
         run: cargo build --verbose --examples
 

examples/server.rs

@@ -1,20 +1,79 @@
 use unicorn_engine::unicorn_const::{Arch, Mode, Prot};
 use unicorn_engine::{RegisterARM, Unicorn};
 
+const PORT: u16 = 1234;
+
+const ARM_CODE32: &[u8] = &[
+    0x0f, 0x00, 0xa0, 0xe1, 0x14, 0x00, 0x80, 0xe2, 0x00, 0x10, 0x90, 0xe5, 0x14, 0x10, 0x81, 0xe2, 0x00, 0x10, 0x80, 0xe5, 0xfb, 0xff, 0xff, 0xea,
+];
+
+#[allow(dead_code)]
 struct CustomData {
-    pub _val: u32,
+    test: [u8; 256],
+    test2: String,
 }
 
 fn main() {
-    let arm_code32: Vec<u8> = vec![
-        0x0f, 0x00, 0xa0, 0xe1, 0x14, 0x00, 0x80, 0xe2, 0x00, 0x10, 0x90, 0xe5, 0x14, 0x10, 0x81, 0xe2, 0x00, 0x10, 0x80, 0xe5, 0xfb, 0xff, 0xff, 0xea,
-    ];
     let mut uc = Unicorn::new(Arch::ARM, Mode::LITTLE_ENDIAN).expect("Failed to initialize Unicorn instance");
     uc.mem_map(0x1000, 0x400, Prot::ALL).expect("Failed to map code page");
-    uc.mem_write(0x1000, &arm_code32).expect("Failed to write instructions");
+    uc.mem_write(0x1000, &ARM_CODE32).expect("Failed to write instructions");
     uc.reg_write(RegisterARM::PC as i32, 0x1000).expect("Failed write PC");
 
-    udbserver::udbserver(&mut uc, 1234, 0x1000).expect("Failed to start udbserver");
+    udbserver::udbserver(&mut uc, PORT, 0x1000).expect("Failed to start udbserver");
+
+    uc.emu_start(0x1000, 0x2000, 0, 1000).expect("Failed to start emu");
+}
+
+#[test]
+fn test_with_data() {
+    use std::process::Command;
+    use std::thread;
+
+    let data = CustomData {
+        test: [0; 256],
+        test2: String::from("ffffffffffffff"),
+    };
+    let mut uc = Unicorn::new_with_data(Arch::ARM, Mode::LITTLE_ENDIAN, data).expect("Failed to initialize Unicorn instance");
+    uc.mem_map(0x1000, 0x400, Prot::ALL).expect("Failed to map code page");
+    uc.mem_write(0x1000, &ARM_CODE32).expect("Failed to write instructions");
+    uc.reg_write(RegisterARM::PC as i32, 0x1000).expect("Failed write PC");
+
+    udbserver::udbserver(&mut uc, PORT, 0x1000).expect("Failed to start udbserver");
+
+    thread::spawn(move || {
+        let gdb_binary = if Command::new("gdb-multiarch").output().is_ok() {
+            "gdb-multiarch"
+        } else {
+            "gdb"
+        };
+
+        let output = Command::new(gdb_binary)
+            .arg("-nx")
+            .arg("-batch")
+            .arg("-ex")
+            .arg(format!("target remote localhost:{}", PORT))
+            .arg("-ex")
+            .arg("set architecture arm")
+            .arg("-ex")
+            .arg("break *0x1004")
+            .arg("-ex")
+            .arg("continue")
+            .arg("-ex")
+            .arg("stepi")
+            .arg("-ex")
+            .arg("quit")
+            .output()
+            .expect("Failed to execute GDB");
+
+        if output.status.success() {
+            println!("GDB interaction success");
+            println!("stdout:\n{}", String::from_utf8_lossy(&output.stdout));
+        } else {
+            eprintln!("GDB interaction failed with exit code: {:?}", output.status.code());
+            eprintln!("stdout:\n{}", String::from_utf8_lossy(&output.stdout));
+            eprintln!("stderr:\n{}", String::from_utf8_lossy(&output.stderr));
+        }
+    });
 
     uc.emu_start(0x1000, 0x2000, 0, 1000).expect("Failed to start emu");
 }

shell.nix

@@ -3,6 +3,7 @@
 pkgs.mkShell {
   buildInputs = with pkgs; [
     git
+    gdb
     cmake
     clang
     cargo