Struct MappingShared

pub struct MappingShared { /* private fields */ }

Represents a memory range shared among multiple threads.

Note: a memory mapping is available to all vCPU running in a given VM instance, but any vCPU-owning thread with a reference to this mapping can access it.

Trait Implementations

impl Clone for MappingShared

fn clone(&self) -> MappingShared

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MappingShared

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

Formats the value using the given formatter.

impl Drop for MappingShared

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for MappingShared

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 Mappable for MappingShared

fn new(size: usize) -> Result<Self, LayoutError>

Creates a new allocation object.

fn map(&mut self, guest_addr: u64, perms: MemPerms) -> Result<()>

Maps the host allocation in the guest.

fn unmap(&mut self) -> Result<()>

Maps the host allocation in the guest.

fn protect(&mut self, perms: MemPerms) -> Result<()>

Changes the protections of memory mapping in the guest.

fn read(&self, guest_addr: u64, data: &mut [u8]) -> Result<usize>

Reads from a memory mapping in the guest at address guest_addr.

fn write(&mut self, guest_addr: u64, data: &[u8]) -> Result<usize>

Writes to a memory mapping in the guest at address guest_addr.

fn get_host_addr(&self) -> *const u8

Retrieves the memory mapping’s host address.

fn get_guest_addr(&self) -> Option<u64>

Retrieves the memory mapping’s guest address.

fn get_size(&self) -> usize

Retrieves the memory mapping’s size.

fn map_inner( inner: &mut MappingInner, guest_addr: u64, perms: MemPerms, ) -> Result<()>

where Self: Sized,

Underlying memory mapping function.

fn unmap_inner(inner: &mut MappingInner) -> Result<()>

where Self: Sized,

Underlying memory unmapping function.

fn protect_inner(inner: &mut MappingInner, perms: MemPerms) -> Result<()>

where Self: Sized,

Underlying memory protection function.

fn read_inner( inner: &MappingInner, guest_addr: u64, data: &mut [u8], ) -> Result<usize>

where Self: Sized,

Underlying memory read function.

fn read_byte(&self, guest_addr: u64) -> Result<u8>

Reads one byte at address guest_addr.

fn read_word(&self, guest_addr: u64) -> Result<u16>

Reads one word at address guest_addr.

fn read_dword(&self, guest_addr: u64) -> Result<u32>

Reads one dword at address guest_addr.

fn read_qword(&self, guest_addr: u64) -> Result<u64>

Reads one qword at address guest_addr.

fn write_inner( inner: &mut MappingInner, guest_addr: u64, data: &[u8], ) -> Result<usize>

where Self: Sized,

Underlying memory write function.

fn write_byte(&mut self, guest_addr: u64, data: u8) -> Result<usize>

Writes one byte at address guest_addr.

fn write_word(&mut self, guest_addr: u64, data: u16) -> Result<usize>

Writes one word at address guest_addr.

fn write_dword(&mut self, guest_addr: u64, data: u32) -> Result<usize>

Writes one dword at address guest_addr.

fn write_qword(&mut self, guest_addr: u64, data: u64) -> Result<usize>

Writes one qword at address guest_addr.

impl PartialEq for MappingShared

fn eq(&self, other: &Self) -> 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 Send for MappingShared