ci: add miri

Author: phip1611

.github/workflows/_build-rust.yml

@@ -50,6 +50,11 @@ on:
         required: false
         default: true
         description: Execute tests.
+      do-miri:
+        type: boolean
+        required: false
+        default: false
+        description: Execute unit tests with miri.
 
 jobs:
   rust:
@@ -104,3 +109,10 @@ jobs:
           Expand-Archive .\cargo-nextest.zip
           cp .\cargo-nextest/cargo-nextest.exe .
           .\cargo-nextest.exe nextest run --features ${{ inputs.features }} --no-default-features
+      - name: Unit Test with Miri
+        if: inputs.do-miri
+        # "--tests" so that the doctests are skipped. Currently, the doctest
+        # in miri fails.
+        run: |
+          rustup component add miri
+          cargo miri test --tests

.github/workflows/rust.yml

@@ -161,3 +161,14 @@ jobs:
       - run: cd integration-test && nix-shell --run "echo OK" && cd ..
       # Now, run the actual test.
       - run: cd integration-test && nix-shell --run ./run.sh && cd ..
+
+  miri:
+    name: tests with miri (nightly)
+    needs: build_nightly
+    uses: ./.github/workflows/_build-rust.yml
+    with:
+      rust-version: nightly
+      do-style-check: false
+      do-test: false
+      do-miri: true
+      features: builder,unstable

Cargo.lock

@@ -9,6 +9,7 @@ exclude = [
 ]
 
 [workspace.dependencies]
+aligned-vec = { version = "0.5", default-features = false }
 bitflags = "2"
 derive_more = { version = "0.99", default-features = false, features = ["display"] }
 log = { version = "0.4", default-features = false }

Cargo.toml

@@ -48,3 +48,6 @@ derive_more.workspace = true
 
 # used for MBI tags
 multiboot2 = "0.16.0"
+
+[dev-dependencies]
+aligned-vec.workspace = true

multiboot2-header/Cargo.toml

@@ -356,6 +356,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_builder() {
         // Step 1/2: Build Header
         let mb2_hdr_data = create_builder().build();

multiboot2-header/src/builder/header.rs

@@ -98,6 +98,7 @@ mod tests {
     use crate::{HeaderTagFlag, InformationRequestHeaderTag, MbiTagType, MbiTagTypeId};
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_builder() {
         let builder = InformationRequestHeaderTagBuilder::new(HeaderTagFlag::Required)
             .add_ir(MbiTagType::EfiMmap)

multiboot2-header/src/builder/information_request.rs

@@ -51,6 +51,7 @@ mod tests {
     use super::*;
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_as_bytes() {
         struct Foobar {
             a: u32,

multiboot2-header/src/builder/traits.rs

@@ -47,3 +47,6 @@ log.workspace = true
 
 uefi-raw = { version = "0.3", default-features = false }
 ptr_meta = { version = "0.2", default-features = false }
+
+[dev-dependencies]
+aligned-vec.workspace = true

multiboot2/Cargo.toml

@@ -82,7 +82,7 @@ mod tests {
 
     const MSG: &str = "hello";
 
-    /// Returns the tag structure in bytes in native endian format.
+    /// Returns the tag structure in bytes in little endian format.
     fn get_bytes() -> std::vec::Vec<u8> {
         // size is: 4 bytes for tag + 4 bytes for size + length of null-terminated string
         let size = (4 + 4 + MSG.as_bytes().len() + 1) as u32;
@@ -101,6 +101,7 @@ mod tests {
 
     /// Tests to parse a string with a terminating null byte from the tag (as the spec defines).
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_parse_str() {
         let tag = get_bytes();
         let tag = unsafe { &*tag.as_ptr().cast::<Tag>() };

multiboot2/src/boot_loader_name.rs

@@ -408,6 +408,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_builder() {
         // Step 1/2: Build MBI
         let mb2i_data = create_builder().build();

multiboot2/src/builder/information.rs

@@ -91,7 +91,7 @@ mod tests {
 
     const MSG: &str = "hello";
 
-    /// Returns the tag structure in bytes in native endian format.
+    /// Returns the tag structure in bytes in little endian format.
     fn get_bytes() -> std::vec::Vec<u8> {
         // size is: 4 bytes for tag + 4 bytes for size + length of null-terminated string
         let size = (4 + 4 + MSG.as_bytes().len() + 1) as u32;
@@ -110,6 +110,7 @@ mod tests {
 
     /// Tests to parse a string with a terminating null byte from the tag (as the spec defines).
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_parse_str() {
         let tag = get_bytes();
         let tag = unsafe { &*tag.as_ptr().cast::<Tag>() };

multiboot2/src/command_line.rs

@@ -661,6 +661,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn name_tag() {
         #[repr(C, align(8))]
         struct Bytes([u8; 32]);
@@ -695,6 +696,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn framebuffer_tag_rgb() {
         // direct RGB mode test:
         // taken from GRUB2 running in QEMU at
@@ -755,6 +757,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn framebuffer_tag_indexed() {
         // indexed mode test:
         // this is synthetic, as I can't get QEMU
@@ -826,6 +829,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn vbe_info_tag() {
         //Taken from GRUB2 running in QEMU.
         #[repr(C, align(8))]
@@ -996,6 +1000,7 @@ mod tests {
     /// Tests to parse a MBI that was statically extracted from a test run with
     /// GRUB as bootloader.
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn grub2() {
         #[repr(C, align(8))]
         struct Bytes([u8; 960]);
@@ -1411,6 +1416,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn elf_sections() {
         #[repr(C, align(8))]
         struct Bytes([u8; 168]);
@@ -1487,6 +1493,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn efi_memory_map() {
         #[repr(C, align(8))]
         struct Bytes([u8; 72]);
@@ -1565,6 +1572,7 @@ mod tests {
 
     /// Example for a custom tag.
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn get_custom_tag_from_mbi() {
         const CUSTOM_TAG_ID: u32 = 0x1337;
 
@@ -1626,6 +1634,7 @@ mod tests {
 
     /// Example for a custom DST tag.
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn get_custom_dst_tag_from_mbi() {
         const CUSTOM_TAG_ID: u32 = 0x1337;
 
@@ -1703,6 +1712,7 @@ mod tests {
 
     /// Tests that `get_tag` can consume multiple types that implement `Into<TagTypeId>`
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn get_tag_into_variants() {
         #[repr(C, align(8))]
         struct Bytes([u8; 32]);

multiboot2/src/lib.rs

@@ -128,10 +128,11 @@ impl<'a> Debug for ModuleIter<'a> {
 #[cfg(test)]
 mod tests {
     use crate::{ModuleTag, Tag, TagType};
+    use aligned_vec::AVec;
 
     const MSG: &str = "hello";
 
-    /// Returns the tag structure in bytes in native endian format.
+    /// Returns the tag structure in bytes in little endian format.
     fn get_bytes() -> std::vec::Vec<u8> {
         // size is: 4 bytes for tag + 4 bytes for size + length of null-terminated string
         //          4 bytes mod_start + 4 bytes mod_end
@@ -153,6 +154,7 @@ mod tests {
 
     /// Tests to parse a string with a terminating null byte from the tag (as the spec defines).
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_parse_str() {
         let tag = get_bytes();
         let tag = unsafe { &*tag.as_ptr().cast::<Tag>() };

multiboot2/src/module.rs

@@ -77,6 +77,7 @@ mod tests {
 
     /// Test to parse a given tag.
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_parse() {
         let tag = get_bytes();
         let tag = unsafe { &*tag.as_ptr().cast::<Tag>() };