Struct MemoryDescriptor

#[repr(C)]
pub struct MemoryDescriptor {
    pub ty: MemoryType,
    pub phys_start: PhysicalAddress,
    pub virt_start: VirtualAddress,
    pub page_count: u64,
    pub att: MemoryAttribute,
}

A structure describing a region of memory. This type corresponds to version of this struct in the UEFI spec and is always bound to a corresponding UEFI memory map.

UEFI pitfalls

As of May 2024: The memory descriptor struct might be extended in the future by a new UEFI spec revision, which will be reflected in another version of that descriptor. The version is reported when using get_memory_map of BootServices.

Also note that you must never work with size_of::<MemoryDescriptor> but always with desc_size, which is reported when using get_memory_map as well [0]. For example, although the actual size is of version 1 descriptors is 40, the reported desc_size is 48.

Fields

ty: MemoryType

Type of memory occupying this range.

phys_start: PhysicalAddress

Starting physical address.

virt_start: VirtualAddress

Starting virtual address.

page_count: u64

Number of 4 KiB pages contained in this range.

att: MemoryAttribute

The capability attributes of this memory range.

Implementations

impl MemoryDescriptor

pub const VERSION: u32 = 1u32

Memory descriptor version number.

Trait Implementations

impl Clone for MemoryDescriptor

fn clone(&self) -> MemoryDescriptor

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MemoryDescriptor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MemoryDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl Hash for MemoryDescriptor

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher].

impl Ord for MemoryDescriptor

fn cmp(&self, other: &MemoryDescriptor) -> Ordering

This method returns an [Ordering] between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MemoryDescriptor

fn eq(&self, other: &MemoryDescriptor) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MemoryDescriptor

fn partial_cmp(&self, other: &MemoryDescriptor) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for MemoryDescriptor

impl Eq for MemoryDescriptor

impl StructuralPartialEq for MemoryDescriptor