multiboot2: Support setting the image load address

Author: YtvwlD

multiboot2/src/builder/information.rs

@@ -3,8 +3,8 @@ use crate::builder::traits::StructAsBytes;
 use crate::{
     BasicMemoryInfoTag, BootInformationInner, BootLoaderNameTag, CommandLineTag,
     EFIBootServicesNotExited, EFIImageHandle32, EFIImageHandle64, EFIMemoryMapTag, EFISdt32,
-    EFISdt64, ElfSectionsTag, EndTag, FramebufferTag, MemoryMapTag, ModuleTag, RsdpV1Tag,
-    RsdpV2Tag, SmbiosTag,
+    EFISdt64, ElfSectionsTag, EndTag, FramebufferTag, ImageLoadPhysAddr, MemoryMapTag, ModuleTag,
+    RsdpV1Tag, RsdpV2Tag, SmbiosTag,
 };
 
 use alloc::boxed::Box;
@@ -25,6 +25,7 @@ pub struct Multiboot2InformationBuilder {
     efi_memory_map_tag: Option<Box<EFIMemoryMapTag>>,
     elf_sections_tag: Option<Box<ElfSectionsTag>>,
     framebuffer_tag: Option<Box<FramebufferTag>>,
+    image_load_addr: Option<ImageLoadPhysAddr>,
     memory_map_tag: Option<Box<MemoryMapTag>>,
     module_tags: Vec<Box<ModuleTag>>,
     efisdt32: Option<EFISdt32>,
@@ -48,6 +49,7 @@ impl Multiboot2InformationBuilder {
             efi_memory_map_tag: None,
             elf_sections_tag: None,
             framebuffer_tag: None,
+            image_load_addr: None,
             memory_map_tag: None,
             module_tags: Vec::new(),
             rsdp_v1_tag: None,
@@ -110,6 +112,9 @@ impl Multiboot2InformationBuilder {
         if let Some(tag) = &self.framebuffer_tag {
             len += Self::size_or_up_aligned(tag.byte_size())
         }
+        if let Some(tag) = &self.image_load_addr {
+            len += Self::size_or_up_aligned(tag.byte_size())
+        }
         if let Some(tag) = &self.memory_map_tag {
             len += Self::size_or_up_aligned(tag.byte_size())
         }
@@ -188,6 +193,9 @@ impl Multiboot2InformationBuilder {
         if let Some(tag) = self.framebuffer_tag.as_ref() {
             Self::build_add_bytes(&mut data, &tag.struct_as_bytes(), false)
         }
+        if let Some(tag) = self.image_load_addr.as_ref() {
+            Self::build_add_bytes(&mut data, &tag.struct_as_bytes(), false)
+        }
         if let Some(tag) = self.memory_map_tag.as_ref() {
             Self::build_add_bytes(&mut data, &tag.struct_as_bytes(), false)
         }
@@ -253,6 +261,10 @@ impl Multiboot2InformationBuilder {
         self.framebuffer_tag = Some(framebuffer_tag);
     }
 
+    pub fn image_load_addr(&mut self, image_load_addr: ImageLoadPhysAddr) {
+        self.image_load_addr = Some(image_load_addr);
+    }
+
     pub fn memory_map_tag(&mut self, memory_map_tag: Box<MemoryMapTag>) {
         self.memory_map_tag = Some(memory_map_tag);
     }

multiboot2/src/image_load_addr.rs

@@ -1,4 +1,9 @@
-use crate::TagTypeId;
+use core::convert::TryInto;
+use core::mem::size_of;
+
+#[cfg(feature = "builder")]
+use crate::builder::traits::StructAsBytes;
+use crate::tag_type::{TagType, TagTypeId};
 
 /// If the image has relocatable header tag, this tag contains the image's
 /// base physical address.
@@ -11,8 +16,37 @@ pub struct ImageLoadPhysAddr {
 }
 
 impl ImageLoadPhysAddr {
+    #[cfg(feature = "builder")]
+    pub fn new(load_base_addr: u32) -> Self {
+        Self {
+            typ: TagType::LoadBaseAddr.into(),
+            size: size_of::<Self>().try_into().unwrap(),
+            load_base_addr,
+        }
+    }
+
     /// Returns the load base address.
     pub fn load_base_addr(&self) -> u32 {
         self.load_base_addr
     }
 }
+
+#[cfg(feature = "builder")]
+impl StructAsBytes for ImageLoadPhysAddr {
+    fn byte_size(&self) -> usize {
+        size_of::<Self>()
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::ImageLoadPhysAddr;
+
+    const ADDR: u32 = 0xABCDEF;
+
+    #[test]
+    fn test_build_load_addr() {
+        let tag = ImageLoadPhysAddr::new(ADDR);
+        assert_eq!(tag.load_base_addr(), ADDR);
+    }
+}

multiboot2/src/module.rs

@@ -159,4 +159,15 @@ mod tests {
         assert_eq!({ tag.typ }, TagType::Module);
         assert_eq!(tag.cmdline().expect("must be valid UTF-8"), MSG);
     }
+
+    /// Test to generate a tag from a given string.
+    #[test]
+    #[cfg(feature = "builder")]
+    fn test_build_str() {
+        use crate::builder::traits::StructAsBytes;
+
+        let tag = ModuleTag::new(0, 0, MSG);
+        let bytes = tag.struct_as_bytes();
+        assert_eq!(bytes, get_bytes());
+    }
 }