uefi: mem: memory-map: break API

As deprecated re-exports are unsupported [0], we go the hard way and
just make it a breaking change.

Along the way, I reordered some statements in some files to follow our typical
order of:
- pub mod
- private mod
- pub use
- private use

Author: phip1611

uefi-test-runner/src/boot/memory.rs

@@ -1,7 +1,7 @@
-use uefi::boot;
-use uefi::table::boot::{AllocateType, BootServices, MemoryMap, MemoryMapMut, MemoryType};
-
 use alloc::vec::Vec;
+use uefi::boot;
+use uefi::mem::memory_map::{MemoryMap, MemoryMapMut, MemoryType};
+use uefi::table::boot::{AllocateType, BootServices};
 
 pub fn test(bt: &BootServices) {
     info!("Testing memory functions");

uefi-test-runner/src/boot/misc.rs

@@ -2,10 +2,11 @@ use core::ffi::c_void;
 use core::ptr::{self, NonNull};
 
 use core::mem;
+use uefi::mem::memory_map::MemoryType;
 use uefi::proto::unsafe_protocol;
 use uefi::table::boot::{
-    BootServices, EventType, MemoryType, OpenProtocolAttributes, OpenProtocolParams, SearchType,
-    TimerTrigger, Tpl,
+    BootServices, EventType, OpenProtocolAttributes, OpenProtocolParams, SearchType, TimerTrigger,
+    Tpl,
 };
 use uefi::table::{Boot, SystemTable};
 use uefi::{guid, Event, Guid, Identify};

uefi-test-runner/src/main.rs

@@ -8,11 +8,11 @@ extern crate alloc;
 
 use alloc::string::ToString;
 use alloc::vec::Vec;
+use uefi::mem::memory_map::{MemoryMap, MemoryType};
 use uefi::prelude::*;
 use uefi::proto::console::serial::Serial;
 use uefi::proto::device_path::build::{self, DevicePathBuilder};
 use uefi::proto::device_path::messaging::Vendor;
-use uefi::table::boot::{MemoryMap, MemoryType};
 use uefi::{print, println, system, Result};
 
 mod boot;

uefi/CHANGELOG.md

@@ -24,9 +24,16 @@
 - **Breaking:** `PcrEvent::new_in_buffer` and `PcrEventInputs::new_in_buffer`
   now take an initialized buffer (`[u8`] instead of `[MaybeUninit<u8>]`), and if
   the buffer is too small the required size is returned in the error data.
-- Exports of Memory Map-related types from `uefi::table::boot` are now
-  deprecated. Use `uefi::mem::memory_map` instead.
-
+- **Breaking** Exports of Memory Map-related types from `uefi::table::boot` are
+  now removed. Use `uefi::mem::memory_map` instead. The patch you have to apply
+  to the `use` statements of your code might look as follows:
+  ```diff
+  1c1,2
+  < use uefi::table::boot::{BootServices, MemoryMap, MemoryMapMut, MemoryType};
+  ---
+  > use uefi::mem::memory_map::{MemoryMap, MemoryMapMut, MemoryType};
+  > use uefi::table::boot::BootServices;
+  ```
 
 # uefi - 0.29.0 (2024-07-02)
 

uefi/src/allocator.rs

@@ -16,8 +16,9 @@ use core::ffi::c_void;
 use core::ptr;
 use core::sync::atomic::{AtomicPtr, AtomicU32, Ordering};
 
+use crate::mem::memory_map::MemoryType;
 use crate::proto::loaded_image::LoadedImage;
-use crate::table::boot::{BootServices, MemoryType};
+use crate::table::boot::BootServices;
 use crate::table::{Boot, SystemTable};
 
 /// Reference to the system table, used to call the boot services pool memory

uefi/src/mem/memory_map/mod.rs

@@ -9,7 +9,7 @@
 //! # Usecase: Obtain UEFI Memory Map
 //!
 //! You can use [`SystemTable::exit_boot_services`] or
-//! [`BootServices::memory_map`], which returns an properly initialized 
+//! [`BootServices::memory_map`], which returns an properly initialized
 //! [`MemoryMapOwned`].
 //!
 //! # Usecase: Parse Memory Slice as UEFI Memory Map
@@ -70,7 +70,7 @@ pub struct MemoryMapMeta {
     /// and never `size_of::<MemoryDescriptor>()`!
     pub desc_size: usize,
     /// A unique memory key bound to a specific memory map version/state.
-    pub map_key: crate::table::boot::MemoryMapKey,
+    pub map_key: MemoryMapKey,
     /// The version of the descriptor struct.
     pub desc_version: u32,
 }

uefi/src/proto/device_path/device_path_gen.rs

@@ -6,12 +6,12 @@
 // See `/xtask/src/device_path/README.md` for more details.
 
 use crate::data_types::UnalignedSlice;
+use crate::mem::memory_map::MemoryType;
 use crate::polyfill::maybe_uninit_slice_as_mut_ptr;
 use crate::proto::device_path::{
     DevicePathHeader, DevicePathNode, DeviceSubType, DeviceType, NodeConversionError,
 };
 use crate::proto::network::IpAddress;
-use crate::table::boot::MemoryType;
 use crate::{guid, Guid};
 use bitflags::bitflags;
 use core::mem::{size_of, size_of_val};

uefi/src/proto/loaded_image.rs

@@ -1,9 +1,9 @@
 //! `LoadedImage` protocol.
 
 use crate::data_types::FromSliceWithNulError;
+use crate::mem::memory_map::MemoryType;
 use crate::proto::device_path::DevicePath;
 use crate::proto::unsafe_protocol;
-use crate::table::boot::MemoryType;
 use crate::util::usize_from_u32;
 use crate::{CStr16, Handle, Status};
 use core::ffi::c_void;

uefi/src/proto/security/memory_protection.rs

@@ -1,6 +1,6 @@
 use crate::data_types::PhysicalAddress;
+use crate::mem::memory_map::MemoryAttribute;
 use crate::proto::unsafe_protocol;
-use crate::table::boot::MemoryAttribute;
 use crate::{Result, StatusExt};
 use core::ops::Range;
 use uefi_raw::protocol::memory_protection::MemoryAttributeProtocol;

uefi/src/table/boot.rs

@@ -1,29 +1,27 @@
 //! UEFI services available during boot.
 
+pub use uefi_raw::table::boot::{EventType, InterfaceType, Tpl};
+
 use super::Revision;
 use crate::data_types::PhysicalAddress;
+use crate::mem::memory_map::*;
 use crate::proto::device_path::DevicePath;
 use crate::proto::loaded_image::LoadedImage;
 use crate::proto::media::fs::SimpleFileSystem;
 use crate::proto::{Protocol, ProtocolPointer};
 use crate::util::opt_nonnull_to_ptr;
 use crate::{Char16, Error, Event, Guid, Handle, Result, Status, StatusExt};
+#[cfg(feature = "alloc")]
+use alloc::vec::Vec;
 use core::cell::UnsafeCell;
 use core::ffi::c_void;
+use core::fmt::Debug;
 use core::mem::{self, MaybeUninit};
 use core::ops::{Deref, DerefMut};
 use core::ptr::NonNull;
 use core::sync::atomic::{AtomicPtr, Ordering};
 use core::{ptr, slice};
 
-#[cfg(feature = "alloc")]
-use alloc::vec::Vec;
-use core::fmt::Debug;
-
-#[deprecated = "Use the `uefi::mem::memory_map` module."]
-pub use crate::mem::memory_map::*;
-pub use uefi_raw::table::boot::{EventType, InterfaceType, Tpl};
-
 /// Global image handle. This is only set by `BootServices::set_image_handle`,
 /// and it is only read by `BootServices::image_handle`.
 static IMAGE_HANDLE: AtomicPtr<c_void> = AtomicPtr::new(ptr::null_mut());

uefi/src/table/runtime.rs

@@ -1,19 +1,17 @@
 //! UEFI services available at runtime, even after the OS boots.
 
-use super::Revision;
-use crate::table::boot::MemoryDescriptor;
-use crate::{CStr16, Error, Result, Status, StatusExt};
-use core::fmt::{self, Debug, Display, Formatter};
-use core::mem::{size_of, MaybeUninit};
-use core::ptr;
-
 pub use uefi_raw::capsule::{CapsuleBlockDescriptor, CapsuleFlags, CapsuleHeader};
 pub use uefi_raw::table::runtime::{
     ResetType, TimeCapabilities, VariableAttributes, VariableVendor,
 };
 pub use uefi_raw::time::Daylight;
 pub use uefi_raw::PhysicalAddress;
 
+use super::Revision;
+use crate::{CStr16, Error, Result, Status, StatusExt};
+use core::fmt::{self, Debug, Display, Formatter};
+use core::mem::{size_of, MaybeUninit};
+use core::ptr;
 #[cfg(feature = "alloc")]
 use {
     crate::data_types::FromSliceWithNulError,
@@ -288,7 +286,7 @@ impl RuntimeServices {
         map_size: usize,
         desc_size: usize,
         desc_version: u32,
-        virtual_map: *mut MemoryDescriptor,
+        virtual_map: *mut crate::mem::memory_map::MemoryDescriptor,
     ) -> Status {
         (self.0.set_virtual_address_map)(map_size, desc_size, desc_version, virtual_map)
     }
@@ -372,7 +370,7 @@ pub struct TimeParams {
 }
 
 /// Error returned by [`Time`] methods. A bool value of `true` means
-/// the specified field is outside of its valid range.
+/// the specified field is outside its valid range.
 #[allow(missing_docs)]
 #[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
 pub struct TimeError {

uefi/src/table/system.rs

@@ -1,15 +1,15 @@
+use super::boot::BootServices;
+use super::runtime::{ResetType, RuntimeServices};
+use super::{cfg, Revision};
+use crate::proto::console::text;
+use crate::{CStr16, Result, Status, StatusExt};
 use core::ffi::c_void;
 use core::marker::PhantomData;
 use core::ptr::NonNull;
 use core::slice;
-use uefi::table::boot::{MemoryMapBackingMemory, MemoryMapMeta};
-
-use crate::proto::console::text;
-use crate::{CStr16, Result, Status, StatusExt};
-
-use super::boot::{BootServices, MemoryDescriptor, MemoryMapOwned, MemoryType};
-use super::runtime::{ResetType, RuntimeServices};
-use super::{cfg, Revision};
+use uefi::mem::memory_map::{
+    MemoryDescriptor, MemoryMapBackingMemory, MemoryMapMeta, MemoryMapOwned, MemoryType,
+};
 
 /// Marker trait used to provide different views of the UEFI System Table.
 pub trait SystemTableView {}

xtask/src/device_path/mod.rs

@@ -29,7 +29,7 @@ fn gen_code_as_string(groups: &[NodeGroup]) -> Result<String> {
             NodeConversionError,
         };
         use crate::proto::network::IpAddress;
-        use crate::table::boot::MemoryType;
+        use crate::mem::memory_map::MemoryType;
         use core::mem::{size_of, size_of_val};
         use core::ptr::addr_of;
         use core::{fmt, slice};