Struct wasmtime_runtime::SharedMemory

pub struct SharedMemory(_);

For shared memory (and only for shared memory), this lock-version restricts access when growing the memory or checking its size. This is to conform with the thread proposal: “When IsSharedArrayBuffer(...) is true, the return value should be the result of an atomic read-modify-write of the new size to the internal length slot.”

Implementations

impl SharedMemory

pub fn new(plan: MemoryPlan) -> Result<Self>

Construct a new SharedMemory.

pub fn wrap(
    plan: &MemoryPlan,
    memory: Box<dyn RuntimeLinearMemory>,
    ty: Memory
) -> Result<Self>

Wrap an existing Memory with the locking provided by a SharedMemory.

pub fn ty(&self) -> Memory

Return the memory type for this SharedMemory.

pub fn as_memory(self) -> Memory

Convert this shared memory into a Memory.

pub fn vmmemory_ptr(&self) -> *const VMMemoryDefinition

Return a pointer to the shared memory’s VMMemoryDefinition.

pub fn grow(
    &self,
    delta_pages: u64,
    store: Option<&mut dyn Store>
) -> Result<Option<(usize, usize)>, Error>

Same as RuntimeLinearMemory::grow, except with &self.

pub fn atomic_notify(&self, addr_index: u64, count: u32) -> Result<u32, Trap>

Implementation of memory.atomic.notify for this shared memory.

pub fn atomic_wait32(
    &self,
    addr_index: u64,
    expected: u32,
    timeout: Option<Instant>
) -> Result<WaitResult, Trap>

Implementation of memory.atomic.wait32 for this shared memory.

pub fn atomic_wait64(
    &self,
    addr_index: u64,
    expected: u64,
    timeout: Option<Instant>
) -> Result<WaitResult, Trap>

Implementation of memory.atomic.wait64 for this shared memory.

Trait Implementations

impl Clone for SharedMemory

fn clone(&self) -> SharedMemory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl RuntimeLinearMemory for SharedMemory

Proxy all calls through the RwLock.

fn byte_size(&self) -> usize

Returns the number of allocated bytes.

fn maximum_byte_size(&self) -> Option<usize>

Returns the maximum number of bytes the memory can grow to. Returns None if the memory is unbounded.

fn grow(
    &mut self,
    delta_pages: u64,
    store: Option<&mut dyn Store>
) -> Result<Option<(usize, usize)>, Error>

Grows a memory by delta_pages.

fn grow_to(&mut self, size: usize) -> Result<()>

Grow memory to the specified amount of bytes.

fn vmmemory(&mut self) -> VMMemoryDefinition

Return a VMMemoryDefinition for exposing the memory to compiled wasm code.

fn needs_init(&self) -> bool

Does this memory need initialization? It may not if it already has initial contents courtesy of the MemoryImage passed to RuntimeMemoryCreator::new_memory().

fn as_any_mut(&mut self) -> &mut dyn Any

Used for optional dynamic downcasting.