Setup test framework for loader and update OVMF.

Author: hikalium

Makefile

@@ -6,6 +6,20 @@ OVMF=ovmf/bios64.bin
 QEMU=qemu-system-x86_64
 OSNAME=${shell uname -s}
 
+QEMU_ARGS_LOADER_TEST=\
+		  -device qemu-xhci -device usb-mouse \
+		  -bios $(OVMF) \
+		  -machine q35,nvdimm -cpu qemu64 -smp 4 \
+		  -m 2G,slots=2,maxmem=4G \
+		  -drive format=raw,file=fat:rw:mnt -net none \
+		  -rtc base=localtime \
+			-device isa-debug-exit,iobase=0xf4,iosize=0x01 \
+			-chardev stdio,id=char0,mux=on \
+			-monitor none \
+			-serial chardev:char0 \
+			-serial chardev:char0 \
+			-nographic
+
 QEMU_ARGS_COMMON=\
 		  -device qemu-xhci -device usb-mouse \
 		  -bios $(OVMF) \
@@ -15,7 +29,6 @@ QEMU_ARGS_COMMON=\
 		  -m 2G,slots=2,maxmem=4G \
 		  -drive format=raw,file=fat:rw:mnt -net none \
 		  -rtc base=localtime \
-		  -d cpu_reset \
 		  -serial tcp::1234,server,nowait \
 		  -serial tcp::1235,server,nowait
 
@@ -98,6 +111,24 @@ files : src/BOOTX64.EFI src/LIUMOS.ELF .FORCE
 	mkdir -p mnt/EFI/EFI/
 	echo 'FS0:\\EFI\\BOOT\\BOOTX64.EFI' > mnt/startup.nsh
 
+.PHONY : internal_run_loader_test
+
+internal_run_loader_test :
+	@echo Using ${LOADER_TEST_EFI} as a loader...
+	mkdir -p mnt/
+	-rm -rf mnt/*
+	mkdir -p mnt/EFI/BOOT
+	cp ${LOADER_TEST_EFI} mnt/EFI/BOOT/BOOTX64.EFI
+	$(QEMU) $(QEMU_ARGS_LOADER_TEST) ; \
+		RETCODE=$$? ; \
+		if [ $$RETCODE -eq 3 ]; then \
+			echo "\nPASS" ; \
+			exit 0 ; \
+		else \
+			echo "\nFAIL: QEMU returned $$RETCODE" ; \
+			exit 1 ; \
+		fi
+
 run_nopmem : files .FORCE
 	$(QEMU) $(QEMU_ARGS)
 
@@ -189,6 +220,7 @@ test :
 	make spellcheck
 	make -C src test
 	make -C app/liumlib test
+	make -C loader test
 
 e2etest_root :
 	make -C e2etest test

loader/.cargo/config.toml

@@ -0,0 +1,9 @@
+[unstable]
+build-std = ["core", "compiler_builtins"]
+build-std-features = ["compiler-builtins-mem"]
+
+[build]
+target = "x86_64-none-efi.json"
+
+[target.'cfg(target_os = "uefi")']
+runner = "scripts/test_runner.sh"

loader/Cargo.toml

@@ -7,7 +7,5 @@ edition = "2018"
 [dependencies]
 
 [profile.dev]
-panic = "abort"
 
 [profile.release]
-panic = "abort"

loader/Makefile

@@ -5,9 +5,8 @@ include ../common.mk
 .PHONY: build clean
 
 build :
-	cargo build -vv --target=x86_64-none-efi.json --release \
-		-Z build-std=core,alloc \
-		-Z build-std-features=compiler-builtins-mem
+	cargo build -vv --release
+
 clean:
 	-rm -r target
 
@@ -16,3 +15,6 @@ install:
 
 check:
 	cargo clippy
+
+test:
+	cargo test

loader/scripts/test_runner.sh

@@ -0,0 +1,5 @@
+#!/bin/bash -xe
+LOADER_TEST_EFI="$1"
+cd `dirname $0`
+cd ../..
+LOADER_TEST_EFI="${LOADER_TEST_EFI}" make internal_run_loader_test

loader/src/main.rs

@@ -1,6 +1,9 @@
 #![no_std]
 #![no_main]
 #![feature(asm)]
+#![feature(custom_test_frameworks)]
+#![test_runner(crate::test_runner)]
+#![reexport_test_harness_main = "test_main"]
 
 use core::convert::TryInto;
 use core::fmt;
@@ -73,8 +76,23 @@ impl fmt::Write for Writer {
     }
 }
 
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+#[repr(u32)]
+pub enum QemuExitCode {
+    Success = 0x1, // QEMU will exit with status 3
+    Failed = 0x2,  // QEMU will exit with status 5
+}
+
+pub fn exit_qemu(exit_code: QemuExitCode) {
+    // https://github.com/qemu/qemu/blob/master/hw/misc/debugexit.c
+    write_io_port(0xf4, exit_code as u8)
+}
+
 #[no_mangle]
 pub extern "C" fn efi_entry() -> ! {
+    #[cfg(test)]
+    test_main();
+
     use core::fmt::Write;
     com_initialize(IO_ADDR_COM2);
     let mut writer = Writer {};
@@ -84,3 +102,21 @@ pub extern "C" fn efi_entry() -> ! {
         n += 1;
     }
 }
+
+#[cfg(test)]
+fn test_runner(tests: &[&dyn Fn()]) {
+    use core::fmt::Write;
+    com_initialize(IO_ADDR_COM2);
+    let mut writer = Writer {};
+    write!(writer, "Running {} tests...", tests.len());
+    for test in tests {
+        test();
+    }
+    write!(writer, "Done!");
+    exit_qemu(QemuExitCode::Success)
+}
+
+#[test_case]
+fn trivial_assertion() {
+    assert_eq!(1, 1);
+}