Test that boot config is actually loaded (through a sentinel value)

Author: phil-opp

api/src/info.rs

@@ -56,6 +56,9 @@ pub struct BootInfo {
     pub ramdisk_addr: Optional<u64>,
     /// Ramdisk image size, set to 0 if addr is None
     pub ramdisk_len: u64,
+
+    #[doc(hidden)]
+    pub _test_sentinel: u64,
 }
 
 impl BootInfo {
@@ -73,6 +76,7 @@ impl BootInfo {
             tls_template: Optional::None,
             ramdisk_addr: Optional::None,
             ramdisk_len: 0,
+            _test_sentinel: 0,
         }
     }
 }

bios/stage-4/src/main.rs

@@ -173,7 +173,7 @@ pub extern "C" fn _start(info: &mut BiosInfo) -> ! {
         ramdisk_len: info.ramdisk.len,
     };
 
-    load_and_switch_to_kernel(kernel, frame_allocator, page_tables, system_info);
+    load_and_switch_to_kernel(kernel, config, frame_allocator, page_tables, system_info);
 }
 
 fn init_logger(

common/config/src/lib.rs

@@ -22,6 +22,8 @@ pub struct BootConfig {
     ///
     /// Enabled by default.
     pub serial_logging: bool,
+
+    pub _test_sentinel: u64,
 }
 
 impl Default for BootConfig {
@@ -31,6 +33,7 @@ impl Default for BootConfig {
             log_level: Default::default(),
             frame_buffer_logging: true,
             serial_logging: true,
+            _test_sentinel: 0,
         }
     }
 }

common/src/lib.rs

@@ -8,7 +8,7 @@ use bootloader_api::{
     info::{FrameBuffer, FrameBufferInfo, MemoryRegion, TlsTemplate},
     BootInfo, BootloaderConfig,
 };
-use bootloader_boot_config::LevelFilter;
+use bootloader_boot_config::{BootConfig, LevelFilter};
 use core::{alloc::Layout, arch::asm, mem::MaybeUninit, slice};
 use level_4_entries::UsedLevel4Entries;
 use usize_conversions::FromUsize;
@@ -125,6 +125,7 @@ impl<'a> Kernel<'a> {
 /// directly to these functions, so see their docs for more info.
 pub fn load_and_switch_to_kernel<I, D>(
     kernel: Kernel,
+    boot_config: BootConfig,
     mut frame_allocator: LegacyFrameAllocator<I, D>,
     mut page_tables: PageTables,
     system_info: SystemInfo,
@@ -144,6 +145,7 @@ where
     );
     let boot_info = create_boot_info(
         &config,
+        &boot_config,
         frame_allocator,
         &mut page_tables,
         &mut mappings,
@@ -435,6 +437,7 @@ pub struct Mappings {
 /// are taken from the given `frame_allocator`.
 pub fn create_boot_info<I, D>(
     config: &BootloaderConfig,
+    boot_config: &BootConfig,
     mut frame_allocator: LegacyFrameAllocator<I, D>,
     page_tables: &mut PageTables,
     mappings: &mut Mappings,
@@ -539,6 +542,7 @@ where
             .map(|addr| addr.as_u64())
             .into();
         info.ramdisk_len = mappings.ramdisk_slice_len;
+        info._test_sentinel = boot_config._test_sentinel;
         info
     });
 

tests/config_file.rs

@@ -3,25 +3,25 @@ use bootloader_test_runner::run_test_kernel_internal;
 use bootloader::BootConfig;
 
 #[test]
-fn basic_boot() {
-    let config: BootConfig = Default::default();
+fn default_config() {
     run_test_kernel_internal(
-        env!("CARGO_BIN_FILE_TEST_KERNEL_CONFIG_FILE_basic_boot"),
+        env!("CARGO_BIN_FILE_TEST_KERNEL_CONFIG_FILE_no_config"),
+        None,
         None,
-        Some(&config),
     );
 }
 
 #[test]
-fn custom_options_boot() {
+fn custom_boot_config() {
     let config = BootConfig {
         frame_buffer: Default::default(),
         log_level: Default::default(),
         frame_buffer_logging: false,
         serial_logging: true,
+        _test_sentinel: 0xb001b001b001,
     };
     run_test_kernel_internal(
-        env!("CARGO_BIN_FILE_TEST_KERNEL_CONFIG_FILE_basic_boot_broken_config_file"),
+        env!("CARGO_BIN_FILE_TEST_KERNEL_CONFIG_FILE_custom_config"),
         None,
         Some(&config),
     );

tests/test_kernels/config_file/src/bin/basic_boot_broken_config_file.rs renamed to tests/test_kernels/config_file/src/bin/custom_config.rs

@@ -9,6 +9,7 @@ entry_point!(kernel_main);
 
 fn kernel_main(boot_info: &'static mut BootInfo) -> ! {
     writeln!(serial(), "Entered kernel with boot info: {boot_info:?}").unwrap();
+    assert_eq!(boot_info._test_sentinel, 0xb001b001b001);
     exit_qemu(QemuExitCode::Success);
 }
 

tests/test_kernels/config_file/src/bin/basic_boot.rs renamed to tests/test_kernels/config_file/src/bin/no_config.rs

@@ -9,6 +9,7 @@ entry_point!(kernel_main);
 
 fn kernel_main(boot_info: &'static mut BootInfo) -> ! {
     writeln!(serial(), "Entered kernel with boot info: {boot_info:?}").unwrap();
+    assert_eq!(boot_info._test_sentinel, 0);
     exit_qemu(QemuExitCode::Success);
 }
 

uefi/src/main.rs

@@ -105,7 +105,7 @@ fn main_inner(image: Handle, mut st: SystemTable<Boot>) -> Status {
         config.frame_buffer.minimum_framebuffer_width =
             kernel.config.frame_buffer.minimum_framebuffer_width;
     }
-    let framebuffer = init_logger(image, &st, config);
+    let framebuffer = init_logger(image, &st, &config);
 
     unsafe {
         *SYSTEM_TABLE.get() = None;
@@ -193,6 +193,7 @@ fn main_inner(image: Handle, mut st: SystemTable<Boot>) -> Status {
 
     bootloader_x86_64_common::load_and_switch_to_kernel(
         kernel,
+        config,
         frame_allocator,
         page_tables,
         system_info,
@@ -473,7 +474,7 @@ fn create_page_tables(
 fn init_logger(
     image_handle: Handle,
     st: &SystemTable<Boot>,
-    config: BootConfig,
+    config: &BootConfig,
 ) -> Option<RawFrameBufferInfo> {
     let gop_handle = st
         .boot_services()