Struct MemoryMapTag

#[repr(C, align(8))]
pub struct MemoryMapTag { /* private fields */ }

This tag provides an initial host memory map (legacy boot, not UEFI).

The map provided is guaranteed to list all standard RAM that should be available for normal use. This type however includes the regions occupied by kernel, mbi, segments and modules. Kernel must take care not to overwrite these regions.

This tag may not be provided by some boot loaders on EFI platforms if EFI boot services are enabled and available for the loaded image (The EFI boot services tag may exist in the Multiboot2 boot information structure).

Implementations

impl MemoryMapTag

pub fn new(areas: &[MemoryArea]) -> Box<Self>

Constructs a new tag.

pub const fn entry_size(&self) -> u32

Returns the entry size.

pub const fn entry_version(&self) -> u32

Returns the entry version.

pub fn memory_areas(&self) -> &[MemoryArea]

Return the slice of the provided MemoryAreas.

Usually, this should already reflect the memory consumed by the code running this.

Trait Implementations

impl Debug for MemoryMapTag

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

Formats the value using the given formatter.

impl MaybeDynSized for MemoryMapTag

const BASE_SIZE: usize = 16usize

The true base size of the struct without any implicit or additional padding. Note that size_of::<T>() isn’t sufficient, as for example the type could have three u32 fields, which would add an implicit u32 padding. However, this constant must always fulfill BASE_SIZE >= size_of::<Self::Header>().

type Header = TagHeader

The associated Header of this tag.

fn dst_len(header: &TagHeader) -> usize

Returns the amount of items in the dynamically sized portion of the DST. Note that this is not the amount of bytes. So if the dynamically sized portion is 16 bytes in size and each element is 4 bytes big, then this function must return 4.

fn header(&self) -> &Self::Header

Returns the corresponding Header.

fn payload(&self) -> &[u8]

Returns the payload, i.e., all memory that is not occupied by the Header of the type.

fn as_bytes(&self) -> BytesRef<'_, Self::Header>

Returns the whole allocated bytes for this structure encapsulated in BytesRef. This includes padding bytes. To only get the “true” tag data, read the tag size from Self::header and create a sub slice.

fn as_ptr(&self) -> *const Self::Header

Returns a pointer to this structure.

impl PartialEq for MemoryMapTag

fn eq(&self, other: &MemoryMapTag) -> 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 Pointee for MemoryMapTag

where [MemoryArea]: Pointee,

type Metadata = <[MemoryArea] as Pointee>::Metadata

The metadata type for pointers and references to this type.

impl Tag for MemoryMapTag

const ID: TagType = TagType::Mmap

The ID of this tag. This should be unique across all implementors.

type IDType = TagType

The ID type that identifies the tag.

impl Eq for MemoryMapTag

impl StructuralPartialEq for MemoryMapTag