Struct vm_memory::guest_memory::GuestAddress

pub struct GuestAddress(pub u64);

Represents a guest physical address (GPA).

Notes:

On ARM64, a 32-bit hypervisor may be used to support a 64-bit guest. For simplicity, u64 is used to store the the raw value no matter if the guest a 32-bit or 64-bit virtual machine.

Trait Implementations

impl Address for GuestAddress

fn new(value: u64) -> GuestAddress

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: GuestAddress) -> Option<u64>

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

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

Computes self + other, returning None if overflow occurred.

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

Computes self + other.

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

Computes self + offset.

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

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

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

Computes self - other.

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

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 GuestAddress

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 GuestAddress

type Output = GuestAddress

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr<u64> for GuestAddress

type Output = GuestAddress

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T: GuestMemory> Bytes<GuestAddress> for T

type E = Error

Associated error codes

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

Writes a slice into the container at addr.

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

Reads data from the container at addr into a slice.

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

Examples

• Write a slice at guestaddress 0x200.

    let start_addr = GuestAddress(0x1000);
    let mut gm =
            GuestMemoryMmap::from_ranges(&vec![(start_addr, 0x400)])
            .expect("Could not create guest memory");
    let res = gm.write_slice(&[1, 2, 3, 4, 5], start_addr);
    assert!(res.is_ok());

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

Examples

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

    let start_addr = GuestAddress(0x1000);
    let mut gm =
            GuestMemoryMmap::from_ranges(&vec![(start_addr, 0x400)])
            .expect("Could not create guest memory");
    let buf = &mut [0u8; 16];
    let res = gm.read_slice(buf, start_addr);
    assert!(res.is_ok());

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

Examples

• Read bytes from /dev/urandom

    let start_addr = GuestAddress(0x1000);
    let gm =
        GuestMemoryMmap::from_ranges(&vec![(start_addr, 0x400)])
        .expect("Could not create guest memory");
    let mut file = File::open(Path::new("/dev/urandom"))
        .expect("could not open /dev/urandom");
    let addr = GuestAddress(0x1010);
    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: GuestAddress,
    src: &mut F,
    count: usize
) -> Result<()> where
    F: Read, 

Reads exactly count bytes from an object and writes them into the container at addr.

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

Examples

• Write 128 bytes to /dev/null

    let start_addr = GuestAddress(0x1000);
    let gm =
        GuestMemoryMmap::from_ranges(&vec![(start_addr, 1024)])
        .expect("Could not create guest memory");
    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 128 bytes to the provided address");

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

Reads exactly count bytes from the container at addr and writes them into an object.

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 GuestAddress

fn clone(&self) -> GuestAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for GuestAddress

impl Debug for GuestAddress

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

Formats the value using the given formatter.

impl Default for GuestAddress

fn default() -> GuestAddress

Returns the "default value" for a type.

impl Eq for GuestAddress

impl Ord for GuestAddress

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

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

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<GuestAddress> for GuestAddress

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

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

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

This method tests for !=.

impl PartialOrd<GuestAddress> for GuestAddress

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for GuestAddress

impl StructuralPartialEq for GuestAddress