Struct MemoryRegion

#[repr(C, align(32))]
pub struct MemoryRegion {
    pub host_addr: Cell<u64>,
    pub vm_addr: u64,
    pub vm_addr_end: u64,
    pub len: u64,
    pub vm_gap_shift: u8,
    pub state: Cell<MemoryState>,
}

Memory region for bounds checking and address translation

Fields

host_addr: Cell<u64>

start host address

vm_addr: u64

start virtual address

vm_addr_end: u64

end virtual address

len: u64

Length in bytes

vm_gap_shift: u8

Size of regular gaps as bit shift (63 means this region is continuous)

state: Cell<MemoryState>

Whether the region is readonly, writable or must be copied before writing

Implementations

impl MemoryRegion

pub fn new_for_testing( slice: &[u8], vm_addr: u64, vm_gap_size: u64, state: MemoryState, ) -> Self

Only to be used in tests and benches

pub fn new_readonly(slice: &[u8], vm_addr: u64) -> Self

Creates a new readonly MemoryRegion from a slice

pub fn new_writable(slice: &mut [u8], vm_addr: u64) -> Self

Creates a new writable MemoryRegion from a mutable slice

pub fn new_cow(slice: &[u8], vm_addr: u64, cow_id: u64) -> Self

Creates a new copy on write MemoryRegion.

The region is made writable

pub fn new_writable_gapped( slice: &mut [u8], vm_addr: u64, vm_gap_size: u64, ) -> Self

Creates a new writable gapped MemoryRegion from a mutable slice

pub fn vm_to_host(&self, vm_addr: u64, len: u64) -> ProgramResult

Convert a virtual machine address into a host address

Trait Implementations

impl Debug for MemoryRegion

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

Formats the value using the given formatter.

impl Default for MemoryRegion

fn default() -> MemoryRegion

Returns the “default value” for a type.

impl Ord for MemoryRegion

fn cmp(&self, other: &Self) -> 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 MemoryRegion

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

fn partial_cmp(&self, other: &Self) -> 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 Eq for MemoryRegion

impl StructuralPartialEq for MemoryRegion