uefi: mem: unit test cleanup and streamlining

Author: phip1611

uefi/src/mem/memory_map/mod.rs

@@ -99,19 +99,20 @@ impl MemoryMapMeta {
     }
 }
 
+/// Comprehensive unit test of the memory map functionality with the simplified
+/// data. Here, `desc_size` equals `size_of::<MemoryDescriptor`.
 #[cfg(test)]
 mod tests_mmap_artificial {
     use super::*;
     use core::mem::{size_of, size_of_val};
 
-    fn buffer_to_map(buffer: &mut [MemoryDescriptor]) -> MemoryMapOwned {
+    fn buffer_to_map(buffer: &mut [MemoryDescriptor]) -> MemoryMapRefMut {
         let mmap_len = size_of_val(buffer);
         let mmap = {
             unsafe { core::slice::from_raw_parts_mut(buffer.as_mut_ptr() as *mut u8, mmap_len) }
         };
 
-        let mmap = MemoryMapBackingMemory::from_slice(mmap);
-        MemoryMapOwned::from_initialized_mem(
+        MemoryMapRefMut::new(
             mmap,
             MemoryMapMeta {
                 map_size: mmap_len,
@@ -120,6 +121,7 @@ mod tests_mmap_artificial {
                 desc_version: MemoryDescriptor::VERSION,
             },
         )
+        .unwrap()
     }
 
     #[test]
@@ -156,7 +158,7 @@ mod tests_mmap_artificial {
         mem_map.sort();
 
         if !is_sorted(&mem_map.entries()) {
-            panic!("mem_map is not sorted: {}", mem_map);
+            panic!("mem_map is not sorted: {:?}", mem_map);
         }
     }
 
@@ -209,17 +211,6 @@ mod tests_mmap_artificial {
         assert_ne!(*desc, BUFFER[2]);
     }
 
-    // Added for debug purposes on test failure
-    impl core::fmt::Display for MemoryMapOwned {
-        fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
-            writeln!(f)?;
-            for desc in self.entries() {
-                writeln!(f, "{:?}", desc)?;
-            }
-            Ok(())
-        }
-    }
-
     fn is_sorted(iter: &MemoryMapIter) -> bool {
         let mut iter = iter.clone();
         let mut curr_start;
@@ -240,6 +231,9 @@ mod tests_mmap_artificial {
     }
 }
 
+/// Comprehensive unit test of the memory map functionality with the data from a
+/// real UEFI memory map. The important property that we test here is that
+/// the reported `desc_size` doesn't equal `size_of::<MemoryDescriptor`.
 #[cfg(test)]
 mod tests_mmap_real {
     use super::*;
@@ -266,9 +260,11 @@ mod tests_mmap_real {
         let mut buf = MMAP_RAW;
         let buf =
             unsafe { slice::from_raw_parts_mut(buf.as_mut_ptr().cast::<u8>(), MMAP_META.map_size) };
-        let buf = MemoryMapBackingMemory::from_slice(buf);
-        let mut mmap = MemoryMapOwned::from_initialized_mem(buf, MMAP_META);
+        let mut mmap = MemoryMapRefMut::new(buf, MMAP_META).unwrap();
+
+        assert!(mmap.is_sorted());
         mmap.sort();
+        assert!(mmap.is_sorted());
 
         let entries = mmap.entries().copied().collect::<Vec<_>>();