Refactor Tests and Makefile

- Carve out common files for tests - Add boot tests starting tutorial 3 - Overhaul the Makefile for more structure
rust-embedded · Jul 12, 2021 · de3ba3e · de3ba3e
1 parent 15a1e71
commit de3ba3e
Show file tree

Hide file tree

Showing 93 changed files with 3,558 additions and 2,190 deletions.
diff --git a/.githooks/pre-commit b/.githooks/pre-commit
@@ -5,15 +5,14 @@
 #
 # Copyright (c) 2018-2021 Andre Richter <[email protected]>
 
-require 'rubygems'
-require 'bundler/setup'
 require_relative '../utils/devtool/copyright'
 
 def copyright_check(staged_files)
     source_files_exts = ['.S', '.rs', '.rb']
 
     staged_files = staged_files.select do |f|
         next if f.include?('build.rs')
+        next if f.include?('boot_test_string.rb')
 
         f.include?('Makefile') ||
             f.include?('Dockerfile') ||

diff --git a/01_wait_forever/Makefile b/01_wait_forever/Makefile
@@ -2,12 +2,22 @@
 ##
 ## Copyright (c) 2018-2021 Andre Richter <[email protected]>
 
-include ../utils/color.mk.in
+include ../common/color.mk.in
 
-# Default to the RPi3
+##--------------------------------------------------------------------------------------------------
+## Optional, user-provided configuration values
+##--------------------------------------------------------------------------------------------------
+
+# Default to the RPi3.
 BSP ?= rpi3
 
-# BSP-specific arguments
+
+
+##--------------------------------------------------------------------------------------------------
+## Hardcoded configuration values
+##--------------------------------------------------------------------------------------------------
+
+# BSP-specific arguments.
 ifeq ($(BSP),rpi3)
     TARGET            = aarch64-unknown-none-softfloat
     KERNEL_BIN        = kernel8.img
@@ -32,11 +42,18 @@ else ifeq ($(BSP),rpi4)
     RUSTC_MISC_ARGS   = -C target-cpu=cortex-a72
 endif
 
-# Export for build.rs
+QEMU_MISSING_STRING = "This board is not yet supported for QEMU."
+
+# Export for build.rs.
 export LINKER_FILE
 
-QEMU_MISSING_STRING = "This board is not yet supported for QEMU."
+KERNEL_ELF = target/$(TARGET)/release/kernel
+
 
+
+##--------------------------------------------------------------------------------------------------
+## Command building blocks
+##--------------------------------------------------------------------------------------------------
 RUSTFLAGS          = -C link-arg=-T$(LINKER_FILE) $(RUSTC_MISC_ARGS)
 RUSTFLAGS_PEDANTIC = $(RUSTFLAGS) -D warnings -D missing_docs
 
@@ -53,61 +70,99 @@ OBJCOPY_CMD = rust-objcopy \
     --strip-all            \
     -O binary
 
-KERNEL_ELF = target/$(TARGET)/release/kernel
+EXEC_QEMU = $(QEMU_BINARY) -M $(QEMU_MACHINE_TYPE)
 
-DOCKER_IMAGE         = rustembedded/osdev-utils
-DOCKER_CMD           = docker run --rm -v $(shell pwd):/work/tutorial -w /work/tutorial
-DOCKER_CMD_INTERACT  = $(DOCKER_CMD) -i -t
+##------------------------------------------------------------------------------
+## Dockerization
+##------------------------------------------------------------------------------
+DOCKER_IMAGE        = rustembedded/osdev-utils
+DOCKER_CMD          = docker run -t --rm -v $(shell pwd):/work/tutorial -w /work/tutorial
+DOCKER_CMD_INTERACT = $(DOCKER_CMD) -i
 
 DOCKER_QEMU  = $(DOCKER_CMD_INTERACT) $(DOCKER_IMAGE)
 DOCKER_TOOLS = $(DOCKER_CMD) $(DOCKER_IMAGE)
 
-EXEC_QEMU = $(QEMU_BINARY) -M $(QEMU_MACHINE_TYPE)
 
+
+##--------------------------------------------------------------------------------------------------
+## Targets
+##--------------------------------------------------------------------------------------------------
 .PHONY: all $(KERNEL_ELF) $(KERNEL_BIN) doc qemu clippy clean readelf objdump nm check
 
 all: $(KERNEL_BIN)
 
+##------------------------------------------------------------------------------
+## Build the kernel ELF
+##------------------------------------------------------------------------------
 $(KERNEL_ELF):
 	$(call colorecho, "\nCompiling kernel - $(BSP)")
 	@RUSTFLAGS="$(RUSTFLAGS_PEDANTIC)" $(RUSTC_CMD)
 
+##------------------------------------------------------------------------------
+## Build the stripped kernel binary
+##------------------------------------------------------------------------------
 $(KERNEL_BIN): $(KERNEL_ELF)
 	@$(OBJCOPY_CMD) $(KERNEL_ELF) $(KERNEL_BIN)
 
+##------------------------------------------------------------------------------
+## Build the documentation
+##------------------------------------------------------------------------------
 doc:
 	$(call colorecho, "\nGenerating docs")
 	@$(DOC_CMD) --document-private-items --open
 
-ifeq ($(QEMU_MACHINE_TYPE),)
+##------------------------------------------------------------------------------
+## Run the kernel in QEMU
+##------------------------------------------------------------------------------
+ifeq ($(QEMU_MACHINE_TYPE),) # QEMU is not supported for the board.
+
 qemu:
 	$(call colorecho, "\n$(QEMU_MISSING_STRING)")
-else
+
+else # QEMU is supported.
+
 qemu: $(KERNEL_BIN)
 	$(call colorecho, "\nLaunching QEMU")
 	@$(DOCKER_QEMU) $(EXEC_QEMU) $(QEMU_RELEASE_ARGS) -kernel $(KERNEL_BIN)
 endif
 
+##------------------------------------------------------------------------------
+## Run clippy
+##------------------------------------------------------------------------------
 clippy:
 	@RUSTFLAGS="$(RUSTFLAGS_PEDANTIC)" $(CLIPPY_CMD)
 
+##------------------------------------------------------------------------------
+## Clean
+##------------------------------------------------------------------------------
 clean:
 	rm -rf target $(KERNEL_BIN)
 
+##------------------------------------------------------------------------------
+## Run readelf
+##------------------------------------------------------------------------------
 readelf: $(KERNEL_ELF)
 	$(call colorecho, "\nLaunching readelf")
 	@$(DOCKER_TOOLS) $(READELF_BINARY) --headers $(KERNEL_ELF)
 
+##------------------------------------------------------------------------------
+## Run objdump
+##------------------------------------------------------------------------------
 objdump: $(KERNEL_ELF)
 	$(call colorecho, "\nLaunching objdump")
 	@$(DOCKER_TOOLS) $(OBJDUMP_BINARY) --disassemble --demangle \
                 --section .text   \
                 $(KERNEL_ELF) | rustfilt
 
+##------------------------------------------------------------------------------
+## Run nm
+##------------------------------------------------------------------------------
 nm: $(KERNEL_ELF)
 	$(call colorecho, "\nLaunching nm")
 	@$(DOCKER_TOOLS) $(NM_BINARY) --demangle --print-size $(KERNEL_ELF) | sort | rustfilt
 
-# For rust-analyzer
+##------------------------------------------------------------------------------
+## Helper target for rust-analyzer
+##------------------------------------------------------------------------------
 check:
 	@RUSTFLAGS="$(RUSTFLAGS)" $(CHECK_CMD) --message-format=json
diff --git a/02_runtime_init/Makefile b/02_runtime_init/Makefile
@@ -2,12 +2,22 @@
 ##
 ## Copyright (c) 2018-2021 Andre Richter <[email protected]>
 
-include ../utils/color.mk.in
+include ../common/color.mk.in
 
-# Default to the RPi3
+##--------------------------------------------------------------------------------------------------
+## Optional, user-provided configuration values
+##--------------------------------------------------------------------------------------------------
+
+# Default to the RPi3.
 BSP ?= rpi3
 
-# BSP-specific arguments
+
+
+##--------------------------------------------------------------------------------------------------
+## Hardcoded configuration values
+##--------------------------------------------------------------------------------------------------
+
+# BSP-specific arguments.
 ifeq ($(BSP),rpi3)
     TARGET            = aarch64-unknown-none-softfloat
     KERNEL_BIN        = kernel8.img
@@ -32,11 +42,18 @@ else ifeq ($(BSP),rpi4)
     RUSTC_MISC_ARGS   = -C target-cpu=cortex-a72
 endif
 
-# Export for build.rs
+QEMU_MISSING_STRING = "This board is not yet supported for QEMU."
+
+# Export for build.rs.
 export LINKER_FILE
 
-QEMU_MISSING_STRING = "This board is not yet supported for QEMU."
+KERNEL_ELF = target/$(TARGET)/release/kernel
+
 
+
+##--------------------------------------------------------------------------------------------------
+## Command building blocks
+##--------------------------------------------------------------------------------------------------
 RUSTFLAGS          = -C link-arg=-T$(LINKER_FILE) $(RUSTC_MISC_ARGS)
 RUSTFLAGS_PEDANTIC = $(RUSTFLAGS) -D warnings -D missing_docs
 
@@ -53,51 +70,84 @@ OBJCOPY_CMD = rust-objcopy \
     --strip-all            \
     -O binary
 
-KERNEL_ELF = target/$(TARGET)/release/kernel
+EXEC_QEMU = $(QEMU_BINARY) -M $(QEMU_MACHINE_TYPE)
 
-DOCKER_IMAGE         = rustembedded/osdev-utils
-DOCKER_CMD           = docker run --rm -v $(shell pwd):/work/tutorial -w /work/tutorial
-DOCKER_CMD_INTERACT  = $(DOCKER_CMD) -i -t
+##------------------------------------------------------------------------------
+## Dockerization
+##------------------------------------------------------------------------------
+DOCKER_IMAGE        = rustembedded/osdev-utils
+DOCKER_CMD          = docker run -t --rm -v $(shell pwd):/work/tutorial -w /work/tutorial
+DOCKER_CMD_INTERACT = $(DOCKER_CMD) -i
 
 DOCKER_QEMU  = $(DOCKER_CMD_INTERACT) $(DOCKER_IMAGE)
 DOCKER_TOOLS = $(DOCKER_CMD) $(DOCKER_IMAGE)
 
-EXEC_QEMU = $(QEMU_BINARY) -M $(QEMU_MACHINE_TYPE)
 
+
+##--------------------------------------------------------------------------------------------------
+## Targets
+##--------------------------------------------------------------------------------------------------
 .PHONY: all $(KERNEL_ELF) $(KERNEL_BIN) doc qemu clippy clean readelf objdump nm check
 
 all: $(KERNEL_BIN)
 
+##------------------------------------------------------------------------------
+## Build the kernel ELF
+##------------------------------------------------------------------------------
 $(KERNEL_ELF):
 	$(call colorecho, "\nCompiling kernel - $(BSP)")
 	@RUSTFLAGS="$(RUSTFLAGS_PEDANTIC)" $(RUSTC_CMD)
 
+##------------------------------------------------------------------------------
+## Build the stripped kernel binary
+##------------------------------------------------------------------------------
 $(KERNEL_BIN): $(KERNEL_ELF)
 	@$(OBJCOPY_CMD) $(KERNEL_ELF) $(KERNEL_BIN)
 
+##------------------------------------------------------------------------------
+## Build the documentation
+##------------------------------------------------------------------------------
 doc:
 	$(call colorecho, "\nGenerating docs")
 	@$(DOC_CMD) --document-private-items --open
 
-ifeq ($(QEMU_MACHINE_TYPE),)
+##------------------------------------------------------------------------------
+## Run the kernel in QEMU
+##------------------------------------------------------------------------------
+ifeq ($(QEMU_MACHINE_TYPE),) # QEMU is not supported for the board.
+
 qemu:
 	$(call colorecho, "\n$(QEMU_MISSING_STRING)")
-else
+
+else # QEMU is supported.
+
 qemu: $(KERNEL_BIN)
 	$(call colorecho, "\nLaunching QEMU")
 	@$(DOCKER_QEMU) $(EXEC_QEMU) $(QEMU_RELEASE_ARGS) -kernel $(KERNEL_BIN)
 endif
 
+##------------------------------------------------------------------------------
+## Run clippy
+##------------------------------------------------------------------------------
 clippy:
 	@RUSTFLAGS="$(RUSTFLAGS_PEDANTIC)" $(CLIPPY_CMD)
 
+##------------------------------------------------------------------------------
+## Clean
+##------------------------------------------------------------------------------
 clean:
 	rm -rf target $(KERNEL_BIN)
 
+##------------------------------------------------------------------------------
+## Run readelf
+##------------------------------------------------------------------------------
 readelf: $(KERNEL_ELF)
 	$(call colorecho, "\nLaunching readelf")
 	@$(DOCKER_TOOLS) $(READELF_BINARY) --headers $(KERNEL_ELF)
 
+##------------------------------------------------------------------------------
+## Run objdump
+##------------------------------------------------------------------------------
 objdump: $(KERNEL_ELF)
 	$(call colorecho, "\nLaunching objdump")
 	@$(DOCKER_TOOLS) $(OBJDUMP_BINARY) --disassemble --demangle \
@@ -106,10 +156,15 @@ objdump: $(KERNEL_ELF)
                 --section .got    \
                 $(KERNEL_ELF) | rustfilt
 
+##------------------------------------------------------------------------------
+## Run nm
+##------------------------------------------------------------------------------
 nm: $(KERNEL_ELF)
 	$(call colorecho, "\nLaunching nm")
 	@$(DOCKER_TOOLS) $(NM_BINARY) --demangle --print-size $(KERNEL_ELF) | sort | rustfilt
 
-# For rust-analyzer
+##------------------------------------------------------------------------------
+## Helper target for rust-analyzer
+##------------------------------------------------------------------------------
 check:
 	@RUSTFLAGS="$(RUSTFLAGS)" $(CHECK_CMD) --message-format=json
diff --git a/02_runtime_init/README.md b/02_runtime_init/README.md
@@ -53,15 +53,15 @@ diff -uNr 01_wait_forever/Cargo.toml 02_runtime_init/Cargo.toml
 diff -uNr 01_wait_forever/Makefile 02_runtime_init/Makefile
 --- 01_wait_forever/Makefile
 +++ 02_runtime_init/Makefile
-@@ -102,6 +102,8 @@
+@@ -152,6 +152,8 @@
  	$(call colorecho, "\nLaunching objdump")
  	@$(DOCKER_TOOLS) $(OBJDUMP_BINARY) --disassemble --demangle \
                  --section .text   \
 +                --section .rodata \
 +                --section .got    \
                  $(KERNEL_ELF) | rustfilt
 
- nm: $(KERNEL_ELF)
+ ##------------------------------------------------------------------------------
 
 diff -uNr 01_wait_forever/src/_arch/aarch64/cpu/boot.rs 02_runtime_init/src/_arch/aarch64/cpu/boot.rs
 --- 01_wait_forever/src/_arch/aarch64/cpu/boot.rs