uefi-raw: add convenience for type IpAddress

This tightly integrates the type with the Rust standard IpAddr type.
It allows the convenient usage in `uefi` in a later commit.

Author: phip1611

uefi-raw/CHANGELOG.md

@@ -15,6 +15,8 @@
 - Added `UsbIoProtocol`.
 - Added `Usb2HostControllerProtocol`.
 - Added  `DevicePathProtocol::length()` properly constructing the `u16` value
+- Type `IpAddress` is now tightly integrated with `core::net::IpAddr`, e.g.,
+  various `From` implementations are available.
 
 ## Changed
 - **Breaking:** Types `Ipv4Address` and `Ipv6Address` have been removed. They

uefi-raw/src/lib.rs

@@ -113,6 +113,12 @@ impl From<Boolean> for bool {
 /// type is defined in the same way as edk2 for compatibility with C code. Note
 /// that this is an **untagged union**, so there's no way to tell which type of
 /// address an `IpAddress` value contains without additional context.
+///
+/// For convenience, this type is tightly integrated with the Rust standard
+/// library types [`IpAddr`], [`Ipv4Addr`], and [`Ipv6Addr`].
+///
+/// The constructors ensure that all unused bytes of these type are always
+/// initialized to zero.
 #[derive(Clone, Copy)]
 #[repr(C)]
 pub union IpAddress {
@@ -132,9 +138,10 @@ impl IpAddress {
     /// Construct a new IPv4 address.
     #[must_use]
     pub fn new_v4(ip_addr: [u8; 4]) -> Self {
-        Self {
-            v4: Ipv4Addr::from(ip_addr),
-        }
+        // Initialize all bytes to zero first.
+        let mut obj = Self::default();
+        obj.v4 = Ipv4Addr::from(ip_addr);
+        obj
     }
 
     /// Construct a new IPv6 address.
@@ -144,20 +151,73 @@ impl IpAddress {
             v6: Ipv6Addr::from(ip_addr),
         }
     }
+
+    /// Returns the octets of the union. Without additional context, it is not
+    /// clear whether the octets represent an IPv4 or IPv6 address.
+    pub const fn octets(&self) -> [u8; 16] {
+        unsafe { self.v6.octets() }
+    }
+
+    /// Returns a raw pointer to the IP address.
+    #[must_use]
+    pub const fn as_ptr(&self) -> *const Self {
+        core::ptr::addr_of!(*self)
+    }
+
+    /// Returns a raw mutable pointer to the IP address.
+    #[must_use]
+    pub fn as_ptr_mut(&mut self) -> *mut Self {
+        core::ptr::addr_of_mut!(*self)
+    }
+
+    /// Transforms this EFI type to the Rust standard libraries type.
+    ///
+    /// # Arguments
+    /// - `is_ipv6`: Whether the internal data should be interpreted as IPv6 or
+    ///   IPv4 address.
+    pub fn to_ip_addr(self, is_ipv6: bool) -> IpAddr {
+        if is_ipv6 {
+            IpAddr::V6(Ipv6Addr::from(unsafe { self.v6.octets() }))
+        } else {
+            IpAddr::V4(Ipv4Addr::from(unsafe { self.v4.octets() }))
+        }
+    }
+
+    /// Returns the underlying data as [`Ipv4Addr`], if only the first four
+    /// octets are used.
+    ///
+    /// # Safety
+    /// This function is not unsafe memory-wise but callers need to ensure with
+    /// additional context that the IP is indeed an IPv4 address.
+    pub unsafe fn as_ipv4(&self) -> Result<Ipv4Addr, Ipv6Addr> {
+        let extra = self.octets()[4..].iter().any(|&x| x != 0);
+        if !extra {
+            Ok(Ipv4Addr::from(unsafe { self.v4.octets() }))
+        } else {
+            Err(Ipv6Addr::from(unsafe { self.v6.octets() }))
+        }
+    }
+
+    /// Returns the underlying data as [`Ipv6Addr`].
+    ///
+    /// # Safety
+    /// This function is not unsafe memory-wise but callers need to ensure with
+    /// additional context that the IP is indeed an IPv6 address.
+    pub unsafe fn as_ipv6(&self) -> Ipv6Addr {
+        Ipv6Addr::from(unsafe { self.v6.octets() })
+    }
 }
 
 impl Debug for IpAddress {
     fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
-        // The type is an untagged union, so we don't know whether it contains
-        // an IPv4 or IPv6 address. It's also not safe to just print the whole
-        // 16 bytes, since they might not all be initialized.
-        f.debug_struct("IpAddress").finish()
+        f.debug_tuple("IpAddress").field(&self.octets()).finish()
     }
 }
 
 impl Default for IpAddress {
     fn default() -> Self {
         Self {
+            // Initialize all fields to zero
             _align_helper: [0u32; 4],
         }
     }
@@ -166,16 +226,51 @@ impl Default for IpAddress {
 impl From<IpAddr> for IpAddress {
     fn from(t: IpAddr) -> Self {
         match t {
-            IpAddr::V4(ip) => Self {
-                v4: Ipv4Addr::from(ip),
-            },
-            IpAddr::V6(ip) => Self {
-                v6: Ipv6Addr::from(ip),
-            },
+            IpAddr::V4(ip) => Self::new_v4(ip.octets()),
+            IpAddr::V6(ip) => Self::new_v6(ip.octets()),
+        }
+    }
+}
+
+impl From<&IpAddr> for IpAddress {
+    fn from(t: &IpAddr) -> Self {
+        match t {
+            IpAddr::V4(ip) => Self::new_v4(ip.octets()),
+            IpAddr::V6(ip) => Self::new_v6(ip.octets()),
         }
     }
 }
 
+impl From<[u8; 4]> for IpAddress {
+    fn from(octets: [u8; 4]) -> Self {
+        Self::new_v4(octets)
+    }
+}
+
+impl From<[u8; 16]> for IpAddress {
+    fn from(octets: [u8; 16]) -> Self {
+        Self::new_v6(octets)
+    }
+}
+
+impl From<IpAddress> for [u8; 16] {
+    fn from(value: IpAddress) -> Self {
+        value.octets()
+    }
+}
+
+impl From<Ipv4Addr> for IpAddress {
+    fn from(value: Ipv4Addr) -> Self {
+        Self::new_v4(value.octets())
+    }
+}
+
+impl From<Ipv6Addr> for IpAddress {
+    fn from(value: Ipv6Addr) -> Self {
+        Self::new_v6(value.octets())
+    }
+}
+
 /// UEFI Media Access Control (MAC) address.
 ///
 /// UEFI supports multiple network protocols and hardware types, not just
@@ -240,17 +335,55 @@ mod tests {
         assert_eq!(size_of::<Ipv6Addr>(), 16);
         assert_eq!(align_of::<Ipv6Addr>(), 1);
     }
-    /// Test conversion from `core::net::IpAddr` to `IpvAddress`.
-    ///
-    /// Note that conversion in the other direction is not possible.
+
+    #[test]
+    fn ip_ptr() {
+        let mut ip = IpAddress::new_v4([0; 4]);
+        let ptr = ip.as_ptr_mut().cast::<u8>();
+        unsafe {
+            core::ptr::write(ptr, 192);
+            core::ptr::write(ptr.add(1), 168);
+            core::ptr::write(ptr.add(2), 42);
+            core::ptr::write(ptr.add(3), 73);
+        }
+        unsafe { assert_eq!(ip.v4.octets(), [192, 168, 42, 73]) }
+    }
+
+    /// Test conversion from [`IpAddr`] to [`IpAddress`].
     #[test]
     fn test_ip_addr_conversion() {
-        let core_addr = IpAddr::V4(core::net::Ipv4Addr::from(TEST_IPV4));
-        let uefi_addr = IpAddress::from(core_addr);
-        assert_eq!(unsafe { uefi_addr.v4.octets() }, TEST_IPV4);
+        // Reference: std types
+        let core_ipv4_v4 = Ipv4Addr::from(TEST_IPV4);
+        let core_ipv4 = IpAddr::from(core_ipv4_v4);
+        let core_ipv6_v6 = Ipv6Addr::from(TEST_IPV6);
+        let core_ipv6 = IpAddr::from(core_ipv6_v6);
+
+        // Test From [u8; N] constructors
+        assert_eq!(IpAddress::from(TEST_IPV4).octets()[0..4], TEST_IPV4);
+        assert_eq!(IpAddress::from(TEST_IPV6).octets(), TEST_IPV6);
+        {
+            let bytes: [u8; 16] = IpAddress::from(TEST_IPV6).into();
+            assert_eq!(bytes, TEST_IPV6);
+        }
 
-        let core_addr = IpAddr::V6(core::net::Ipv6Addr::from(TEST_IPV6));
-        let uefi_addr = IpAddress::from(core_addr);
-        assert_eq!(unsafe { uefi_addr.v6.octets() }, TEST_IPV6);
+        // Test From::from std type constructors
+        let efi_ipv4 = IpAddress::from(core_ipv4);
+        assert_eq!(efi_ipv4.octets()[0..4], TEST_IPV4);
+        assert_eq!(unsafe { efi_ipv4.as_ipv4().unwrap() }, core_ipv4);
+
+        let efi_ipv6 = IpAddress::from(core_ipv6);
+        assert_eq!(efi_ipv6.octets(), TEST_IPV6);
+        assert_eq!(unsafe { efi_ipv6.as_ipv4().unwrap_err() }, core_ipv6);
+        assert_eq!(unsafe { efi_ipv6.as_ipv6() }, core_ipv6);
+
+        // Test From::from std type constructors
+        let efi_ipv4 = IpAddress::from(core_ipv4_v4);
+        assert_eq!(efi_ipv4.octets()[0..4], TEST_IPV4);
+        assert_eq!(unsafe { efi_ipv4.as_ipv4().unwrap() }, core_ipv4);
+
+        let efi_ipv6 = IpAddress::from(core_ipv6_v6);
+        assert_eq!(efi_ipv6.octets(), TEST_IPV6);
+        assert_eq!(unsafe { efi_ipv6.as_ipv4().unwrap_err() }, core_ipv6);
+        assert_eq!(unsafe { efi_ipv6.as_ipv6() }, core_ipv6);
     }
 }

uefi/CHANGELOG.md

@@ -41,7 +41,7 @@
 - The `Display` impl for `CStr8` now excludes the trailing null character.
 - `VariableKeys` initializes with a larger name buffer to work around firmware
   bugs on some devices.
-- The UEFI `allocator::Allocator` has been optimized for page-aligned 
+- The UEFI `allocator::Allocator` has been optimized for page-aligned
   allocations.