Struct vm_memory::atomic::GuestMemoryAtomic

pub struct GuestMemoryAtomic<M: GuestMemory> { /* private fields */ }

A fast implementation of a mutable collection of memory regions.

This implementation uses ArcSwap to provide RCU-like snapshotting of the memory map: every update of the memory map creates a completely new GuestMemory object, and readers will not be blocked because the copies they retrieved will be collected once no one can access them anymore. Under the assumption that updates to the memory map are rare, this allows a very efficient implementation of the memory() method.

Implementations

impl<M: GuestMemory> GuestMemoryAtomic<M>

pub fn new(map: M) -> Self

create a new GuestMemoryAtomic object whose initial contents come from the map GuestMemory.

pub fn lock(&self) -> LockResult<GuestMemoryExclusiveGuard<'_, M>>

Acquires the update mutex for the GuestMemoryAtomic, blocking the current thread until it is able to do so. The returned RAII guard allows for scoped unlock of the mutex (that is, the mutex will be unlocked when the guard goes out of scope), and optionally also for replacing the contents of the GuestMemoryAtomic when the lock is dropped.

Trait Implementations

impl<M: Clone + GuestMemory> Clone for GuestMemoryAtomic<M>

fn clone(&self) -> GuestMemoryAtomic<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug + GuestMemory> Debug for GuestMemoryAtomic<M>

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

Formats the value using the given formatter.

impl<M: GuestMemory> From<Arc<M>> for GuestMemoryAtomic<M>

fn from(map: Arc<M>) -> Self

create a new GuestMemoryAtomic object whose initial contents come from the map reference counted GuestMemory.

impl<M: GuestMemory> GuestAddressSpace for GuestMemoryAtomic<M>

type T = GuestMemoryLoadGuard<M>

A type that provides access to the memory.

type M = M

The type that will be used to access guest memory.

fn memory(&self) -> Self::T

Return an object (e.g. a reference or guard) that can be used to access memory through this address space. The object provides a consistent snapshot of the memory map.