multiboot2: cleanup

Author: phip1611

multiboot2/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "multiboot2"
 description = """
-Library that helps you to parse the multiboot information structure (mbi) from
+Library that assists parsing the Multiboot2 Information Structure (MBI) from
 Multiboot2-compliant bootloaders, like GRUB. It supports all tags from the specification
 including full support for the sections of ELF-64. This library is `no_std` and can be
 used in a Multiboot2-kernel.

multiboot2/README.md

@@ -3,7 +3,7 @@
 [![crates.io](https://img.shields.io/crates/v/multiboot2.svg)](https://crates.io/crates/multiboot2)
 [![docs](https://docs.rs/multiboot2/badge.svg)](https://docs.rs/multiboot2/)
 
-Rust library that helps you to parse the multiboot information structure (mbi) from
+Rust library that assists parsing the Multiboot2 Information Structure (MBI) from
 Multiboot2-compliant bootloaders, like GRUB. It supports all tags from the specification
 including full support for the sections of ELF-64 files. This library is `no_std` and can be
 used in a Multiboot2-kernel.

multiboot2/src/lib.rs

@@ -9,7 +9,7 @@
 #![allow(rustdoc::private_doc_tests)]
 // --- END STYLE CHECKS ---
 
-//! Library that helps you to parse the multiboot information structure (mbi) from
+//! Library that assists parsing the Multiboot2 Information Structure (MBI) from
 //! Multiboot2-compliant bootloaders, like GRUB. It supports all tags from the specification
 //! including full support for the sections of ELF-64. This library is `no_std` and can be
 //! used in a Multiboot2-kernel.
@@ -98,12 +98,16 @@ pub mod builder;
 /// that the Rust compiler output changes `eax` before you can access it.
 pub const MAGIC: u32 = 0x36d76289;
 
+/// # Safety
+/// Deprecated. Please use BootInformation::load() instead.
 #[deprecated = "Please use BootInformation::load() instead."]
 pub unsafe fn load<'a>(address: usize) -> Result<BootInformation<'a>, MbiLoadError> {
     let ptr = address as *const u8;
     BootInformation::load(ptr)
 }
 
+/// # Safety
+/// Deprecated. Please use BootInformation::load() instead.
 #[deprecated = "Please use BootInformation::load() instead."]
 pub unsafe fn load_with_offset<'a>(
     address: usize,
@@ -135,6 +139,42 @@ pub enum MbiLoadError {
 #[cfg(feature = "unstable")]
 impl core::error::Error for MbiLoadError {}
 
+#[repr(C, align(8))]
+struct BootInformationInner {
+    total_size: u32,
+    _reserved: u32,
+    // followed by various, dynamically sized multiboot2 tags
+    tags: [Tag; 0],
+}
+
+impl BootInformationInner {
+    #[cfg(feature = "builder")]
+    fn new(total_size: u32) -> Self {
+        Self {
+            total_size,
+            _reserved: 0,
+            tags: [],
+        }
+    }
+
+    fn has_valid_end_tag(&self) -> bool {
+        let end_tag_prototype = EndTag::default();
+
+        let self_ptr = self as *const _;
+        let end_tag_addr = self_ptr as usize + (self.total_size - end_tag_prototype.size) as usize;
+        let end_tag = unsafe { &*(end_tag_addr as *const Tag) };
+
+        end_tag.typ == end_tag_prototype.typ && end_tag.size == end_tag_prototype.size
+    }
+}
+
+#[cfg(feature = "builder")]
+impl StructAsBytes for BootInformationInner {
+    fn byte_size(&self) -> usize {
+        core::mem::size_of::<Self>()
+    }
+}
+
 /// A Multiboot 2 Boot Information (MBI) accessor.
 #[repr(transparent)]
 pub struct BootInformation<'a>(&'a BootInformationInner);
@@ -185,35 +225,7 @@ impl BootInformation<'_> {
 
         Ok(Self(mbi))
     }
-}
-
-#[repr(C, align(8))]
-struct BootInformationInner {
-    total_size: u32,
-    _reserved: u32,
-    // followed by various, dynamically sized multiboot2 tags
-    tags: [Tag; 0],
-}
-
-impl BootInformationInner {
-    #[cfg(feature = "builder")]
-    fn new(total_size: u32) -> Self {
-        Self {
-            total_size,
-            _reserved: 0,
-            tags: [],
-        }
-    }
-}
-
-#[cfg(feature = "builder")]
-impl StructAsBytes for BootInformationInner {
-    fn byte_size(&self) -> usize {
-        core::mem::size_of::<Self>()
-    }
-}
 
-impl BootInformation<'_> {
     /// Get the start address of the boot info.
     pub fn start_address(&self) -> usize {
         core::ptr::addr_of!(*self.0) as usize
@@ -427,18 +439,6 @@ impl BootInformation<'_> {
     }
 }
 
-impl BootInformationInner {
-    fn has_valid_end_tag(&self) -> bool {
-        let end_tag_prototype = EndTag::default();
-
-        let self_ptr = self as *const _;
-        let end_tag_addr = self_ptr as usize + (self.total_size - end_tag_prototype.size) as usize;
-        let end_tag = unsafe { &*(end_tag_addr as *const Tag) };
-
-        end_tag.typ == end_tag_prototype.typ && end_tag.size == end_tag_prototype.size
-    }
-}
-
 // SAFETY: BootInformation contains a const ptr to memory that is never mutated.
 // Sending this pointer to other threads is sound.
 unsafe impl Send for BootInformation<'_> {}

multiboot2/src/tag_type.rs

@@ -287,7 +287,7 @@ mod partial_eq_impls {
 }
 
 /// Common base structure for all tags that can be passed via the Multiboot2
-/// information structure (MBI) to a Multiboot2 payload/program/kernel.
+/// Information Structure (MBI) to a Multiboot2 payload/program/kernel.
 ///
 /// Can be transformed to any other tag (sized or unsized/DST) via
 /// [`Tag::cast_tag`].