Adding more test payloads (debug, mret, mcause, mepc, mconfigpts, mts…

…elect)

Now we got all the pieces needed to add a new bunch of tests, those are now
enabled by default (including the breakpoint test!).

Co-authored-by: Abel Vexina Wilkinson <abel.vexinawilkinson@epfl.ch>

Cargo.toml

@@ -20,6 +20,11 @@ members = [
     "payloads/perf_monitor",
     "payloads/menv_msec",
     "payloads/breakpoint",
+    "payloads/mepc",
+    "payloads/mcause",
+    "payloads/mconfigptr",
+    "payloads/tselect",
+    "payloads/mret",
 
     # Crates
     "crates/mirage_abi",

justfile

@@ -19,6 +19,12 @@ test:
 	cargo run --package runner -- --max-exits 200 --payload pmp
 	cargo run --package runner -- --max-exits 200 --payload perf_monitor
 	cargo run --package runner -- --max-exits 200 --payload menv_msec
+	cargo run --package runner -- --max-exits 200 --payload breakpoint
+	cargo run --package runner -- --max-exits 200 --payload mepc
+	cargo run --package runner -- --max-exits 200 --payload mcause
+	cargo run --package runner -- --max-exits 200 --payload mconfigptr
+	cargo run --package runner -- --max-exits 200 --payload tselect
+	cargo run --package runner -- --max-exits 200 --payload mret
 
 	# Checking formatting...
 	cargo fmt --all -- --check

payloads/mcause/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+name = "mcause"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+mirage_abi = { path = "../../crates/mirage_abi" }

payloads/mcause/src/main.rs

@@ -0,0 +1,72 @@
+#![no_std]
+#![no_main]
+
+use core::arch::{asm, global_asm};
+use core::panic::PanicInfo;
+use core::usize;
+
+use mirage_abi::{failure, success};
+
+global_asm!(
+    r#"
+.text
+.align 4
+.global _start
+_start:
+    j {entry}
+"#,
+    entry = sym entry,
+);
+
+extern "C" fn entry() -> ! {
+    let secret1: usize = 0x42;
+    let mut res: usize;
+    unsafe {
+        asm!(
+            "li {0}, 0x42",
+            "csrw mcause, {0}",
+            "csrr {1}, mcause",
+            in(reg) secret1,
+            out(reg) res,
+        );
+    }
+
+    read_test(res, 0);
+
+    let secret2: usize = 0x9;
+
+    unsafe {
+        asm!(
+            "li {0}, 0x9",
+            "csrw mcause, {0}",
+            "csrr {1}, mcause",
+            in(reg) secret2,
+            out(reg) res,
+        );
+    }
+
+    read_test(res, secret2);
+
+    unsafe {
+        asm!(
+            "li {0}, 0x8000000000000009",
+            "csrw mcause, {0}",
+            "csrr {1}, mcause",
+            in(reg) secret2,
+            out(reg) res,
+        );
+    }
+
+    read_test(res, secret2);
+
+    success();
+}
+
+fn read_test(out_csr: usize, expected: usize) {
+    assert_eq!(out_csr, expected);
+}
+
+#[panic_handler]
+fn panic(_info: &PanicInfo) -> ! {
+    failure();
+}

payloads/mconfigptr/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+name = "mconfigptr"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+mirage_abi = { path = "../../crates/mirage_abi" }

payloads/mconfigptr/src/main.rs

@@ -0,0 +1,46 @@
+#![no_std]
+#![no_main]
+
+use core::arch::{asm, global_asm};
+use core::panic::PanicInfo;
+use core::usize;
+
+use mirage_abi::{failure, success};
+
+global_asm!(
+    r#"
+.text
+.align 4
+.global _start
+_start:
+    j {entry}
+"#,
+    entry = sym entry,
+);
+
+extern "C" fn entry() -> ! {
+    let secret1: usize = 0x42;
+    let mut res: usize;
+    unsafe {
+        asm!(
+            "li {0}, 0x42",
+            "csrw mcause, {0}",
+            "csrr {1}, mcause",
+            in(reg) secret1,
+            out(reg) res,
+        );
+    }
+
+    read_test(res, 0);
+
+    success();
+}
+
+fn read_test(out_csr: usize, expected: usize) {
+    assert_eq!(out_csr, expected);
+}
+
+#[panic_handler]
+fn panic(_info: &PanicInfo) -> ! {
+    failure();
+}

payloads/mepc/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+name = "mepc"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+mirage_abi = { path = "../../crates/mirage_abi" }

payloads/mepc/src/main.rs

@@ -0,0 +1,44 @@
+#![no_std]
+#![no_main]
+
+use core::arch::{asm, global_asm};
+use core::panic::PanicInfo;
+use core::usize;
+
+use mirage_abi::{failure, success};
+
+global_asm!(
+    r#"
+.text
+.align 4
+.global _start
+_start:
+    j {entry}
+"#,
+    entry = sym entry,
+);
+
+extern "C" fn entry() -> ! {
+    let secret: usize = 0x42;
+    let res: usize;
+    unsafe {
+        asm!(
+            "li {0}, 0x42",
+            "csrw mepc, {0}",
+            "csrr {1}, mepc",
+            in(reg) secret,
+            out(reg) res,
+        );
+    }
+
+    if res == secret {
+        success();
+    }
+
+    panic!();
+}
+
+#[panic_handler]
+fn panic(_info: &PanicInfo) -> ! {
+    failure();
+}

payloads/mret/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+name = "mret"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+mirage_abi = { path = "../../crates/mirage_abi" }

payloads/mret/src/main.rs

@@ -0,0 +1,80 @@
+#![no_std]
+#![no_main]
+
+use core::arch::{asm, global_asm};
+use core::panic::PanicInfo;
+
+use mirage_abi::{failure, success};
+
+global_asm!(
+    r#"
+.text
+.align 4
+.global _start
+_start:
+    j {entry}
+"#,
+    entry = sym entry,
+);
+
+extern "C" fn entry() -> ! {
+    let mut mstatus: usize;
+    let mut t6: usize;
+    unsafe {
+        let handler = _raw_breakpoint_trap_handler as usize;
+        // Let's rise an exception breakpoint directly
+        asm!(
+            "csrw mtvec, {0}",   // Write mtvec
+            "ebreak",            // Cause an exception, we should return right away!
+            "csrr {1}, mstatus", // Read mstatus
+            in(reg) handler,
+            out(reg) mstatus,
+            out("t6") t6,        // The handler writes a secret value in t6
+        );
+    }
+
+    // MPP = 0
+    read_test((mstatus >> 11) & 0b11, 0);
+    // MPIE = 1
+    read_test((mstatus >> 7) & 0b1, 1);
+    // MPRV = 0
+    read_test((mstatus >> 17) & 0b1, 0);
+
+    assert_eq!(
+        t6, 0x42,
+        "Trap handler did not properly update the value in t6"
+    );
+
+    success();
+}
+
+// —————————————————————————————— Trap Handler —————————————————————————————— //
+
+global_asm!(
+    r#"
+.text
+.align 4
+.global _raw_breakpoint_trap_handler
+_raw_breakpoint_trap_handler:
+    csrr t6, mepc  // Read EPC
+    addi t6, t6, 4 // Increment return pointer
+    csrw mepc, t6  // Write it back
+    li t6, 0x42    // And store a secret value in t6 before returning
+    mret
+"#,
+);
+
+extern "C" {
+    fn _raw_breakpoint_trap_handler();
+}
+
+fn read_test(out_csr: usize, expected: usize) {
+    assert_eq!(out_csr, expected);
+}
+
+// ————————————————————————————— Panic Handler —————————————————————————————— //
+
+#[panic_handler]
+fn panic(_info: &PanicInfo) -> ! {
+    failure();
+}

payloads/tselect/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+name = "tselect"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+mirage_abi = { path = "../../crates/mirage_abi" }