Struct vm_memory::guest_memory::MemoryRegionAddress

pub struct MemoryRegionAddress(pub u64);

Represents an offset inside a region.

Tuple Fields

0: u64

Trait Implementations

impl Address for MemoryRegionAddress

fn new(value: u64) -> MemoryRegionAddress

Creates an address from a raw address value.

fn raw_value(&self) -> u64

Returns the raw value of the address.

fn checked_offset_from(&self, base: MemoryRegionAddress) -> Option<u64>

Computes the offset from this address to the given base address.

fn checked_add(&self, other: u64) -> Option<MemoryRegionAddress>

Computes self + other, returning None if overflow occurred.

fn overflowing_add(&self, other: u64) -> (MemoryRegionAddress, bool)

Computes self + other.

fn unchecked_add(&self, offset: u64) -> MemoryRegionAddress

Computes self + offset.

fn checked_sub(&self, other: u64) -> Option<MemoryRegionAddress>

Subtracts two addresses, checking for underflow. If underflow happens, None is returned.

fn overflowing_sub(&self, other: u64) -> (MemoryRegionAddress, bool)

Computes self - other.

fn unchecked_sub(&self, other: u64) -> MemoryRegionAddress

Computes self - other.

fn mask(&self, mask: Self::V) -> Self::V

Returns the bitwise and of the address with the given mask.

fn unchecked_offset_from(&self, base: Self) -> Self::V

Computes the offset from this address to the given base address.

fn checked_align_up(&self, power_of_two: Self::V) -> Option<Self>

Returns self, aligned to the given power of two.

fn unchecked_align_up(&self, power_of_two: Self::V) -> Self

Returns self, aligned to the given power of two. Only use this when the result is guaranteed not to overflow.

impl AddressValue for MemoryRegionAddress

type V = u64

Type of the raw address value.

fn zero() -> Self::V

Return the value zero, coerced into the value type Self::V

fn one() -> Self::V

Return the value zero, coerced into the value type Self::V

impl BitAnd<u64> for MemoryRegionAddress

type Output = MemoryRegionAddress

The resulting type after applying the & operator.

fn bitand(self, other: u64) -> MemoryRegionAddress

Performs the & operation.

impl BitOr<u64> for MemoryRegionAddress

type Output = MemoryRegionAddress

The resulting type after applying the | operator.

fn bitor(self, other: u64) -> MemoryRegionAddress

Performs the | operation.

impl<B: Bitmap> Bytes<MemoryRegionAddress> for GuestRegionMmap<B>

fn write(&self, buf: &[u8], addr: MemoryRegionAddress) -> Result<usize>

Examples

• Write a slice at guest address 0x1200.

let res = gm
    .write(&[1, 2, 3, 4, 5], GuestAddress(0x1200))
    .expect("Could not write to guest memory");
assert_eq!(5, res);

fn read(&self, buf: &mut [u8], addr: MemoryRegionAddress) -> Result<usize>

Examples

• Read a slice of length 16 at guestaddress 0x1200.

let buf = &mut [0u8; 16];
let res = gm
    .read(buf, GuestAddress(0x1200))
    .expect("Could not read from guest memory");
assert_eq!(16, res);

fn read_from<F>( &self, addr: MemoryRegionAddress, src: &mut F, count: usize, ) -> Result<usize>

where F: Read,

Examples

• Read bytes from /dev/urandom

let mut file = File::open(Path::new("/dev/urandom")).expect("Could not open /dev/urandom");

gm.read_from(addr, &mut file, 128)
    .expect("Could not read from /dev/urandom into guest memory");

let read_addr = addr.checked_add(8).expect("Could not compute read address");
let rand_val: u32 = gm
    .read_obj(read_addr)
    .expect("Could not read u32 val from /dev/urandom");

fn read_exact_from<F>( &self, addr: MemoryRegionAddress, src: &mut F, count: usize, ) -> Result<()>

where F: Read,

Examples

• Read bytes from /dev/urandom

let mut file = File::open(Path::new("/dev/urandom")).expect("Could not open /dev/urandom");

gm.read_exact_from(addr, &mut file, 128)
    .expect("Could not read from /dev/urandom into guest memory");

let read_addr = addr.checked_add(8).expect("Could not compute read address");
let rand_val: u32 = gm
    .read_obj(read_addr)
    .expect("Could not read u32 val from /dev/urandom");

fn write_to<F>( &self, addr: MemoryRegionAddress, dst: &mut F, count: usize, ) -> Result<usize>

where F: Write,

Writes data from the region to a writable object.

Examples

• Write 128 bytes to a /dev/null file

let mut file = OpenOptions::new()
    .write(true)
    .open("/dev/null")
    .expect("Could not open /dev/null");

gm.write_to(start_addr, &mut file, 128)
    .expect("Could not write to file from guest memory");

fn write_all_to<F>( &self, addr: MemoryRegionAddress, dst: &mut F, count: usize, ) -> Result<()>

where F: Write,

Writes data from the region to a writable object.

Examples

• Write 128 bytes to a /dev/null file

let mut file = OpenOptions::new()
    .write(true)
    .open("/dev/null")
    .expect("Could not open /dev/null");

gm.write_all_to(start_addr, &mut file, 128)
    .expect("Could not write to file from guest memory");

type E = Error

Associated error codes

fn write_slice(&self, buf: &[u8], addr: MemoryRegionAddress) -> Result<()>

Writes the entire content of a slice into the container at addr.

fn read_slice(&self, buf: &mut [u8], addr: MemoryRegionAddress) -> Result<()>

Reads data from the container at addr to fill an entire slice.

fn store<T: AtomicAccess>( &self, val: T, addr: MemoryRegionAddress, order: Ordering, ) -> Result<()>

Atomically store a value at the specified address.

fn load<T: AtomicAccess>( &self, addr: MemoryRegionAddress, order: Ordering, ) -> Result<T>

Atomically load a value from the specified address.

fn write_obj<T: ByteValued>(&self, val: T, addr: A) -> Result<(), Self::E>

Writes an object into the container at addr.

fn read_obj<T: ByteValued>(&self, addr: A) -> Result<T, Self::E>

Reads an object from the container at addr.

impl Clone for MemoryRegionAddress

fn clone(&self) -> MemoryRegionAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryRegionAddress

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

Formats the value using the given formatter.

impl Default for MemoryRegionAddress

fn default() -> MemoryRegionAddress

Returns the “default value” for a type.

impl Ord for MemoryRegionAddress

fn cmp(&self, other: &MemoryRegionAddress) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for MemoryRegionAddress

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for MemoryRegionAddress

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for MemoryRegionAddress

impl Eq for MemoryRegionAddress

impl StructuralPartialEq for MemoryRegionAddress