Struct wasmer_vm::memory::VMOwnedMemory

pub struct VMOwnedMemory {
    mmap: WasmMmap,
    config: VMMemoryConfig,
}

A linear memory instance.

Fields

mmap: WasmMmap

config: VMMemoryConfig

Implementations

impl VMOwnedMemory

pub fn new( memory: &MemoryType, style: &MemoryStyle, ) -> Result<Self, MemoryError>

Create a new linear memory instance with specified minimum and maximum number of wasm pages.

This creates a Memory with owned metadata: this can be used to create a memory that will be imported into Wasm modules.

pub fn new_with_file( memory: &MemoryType, style: &MemoryStyle, backing_file: PathBuf, memory_type: MmapType, ) -> Result<Self, MemoryError>

Create a new linear memory instance with specified minimum and maximum number of wasm pages that is backed by a memory file. When set to private the file will be remaing in memory and never flush to disk, when set to shared the memory will be flushed to disk.

This creates a Memory with owned metadata: this can be used to create a memory that will be imported into Wasm modules.

pub unsafe fn from_definition( memory: &MemoryType, style: &MemoryStyle, vm_memory_location: NonNull<VMMemoryDefinition>, ) -> Result<Self, MemoryError>

Create a new linear memory instance with specified minimum and maximum number of wasm pages.

This creates a Memory with metadata owned by a VM, pointed to by vm_memory_location: this can be used to create a local memory.

Safety

• vm_memory_location must point to a valid location in VM memory.

pub unsafe fn from_definition_with_file( memory: &MemoryType, style: &MemoryStyle, vm_memory_location: NonNull<VMMemoryDefinition>, backing_file: Option<PathBuf>, memory_type: MmapType, ) -> Result<Self, MemoryError>

Create a new linear memory instance with specified minimum and maximum number of wasm pages that is backed by a file. When set to private the file will be remaing in memory and never flush to disk, when set to shared the memory will be flushed to disk.

This creates a Memory with metadata owned by a VM, pointed to by vm_memory_location: this can be used to create a local memory.

Safety

• vm_memory_location must point to a valid location in VM memory.

unsafe fn new_internal( memory: &MemoryType, style: &MemoryStyle, vm_memory_location: Option<NonNull<VMMemoryDefinition>>, backing_file: Option<PathBuf>, memory_type: MmapType, ) -> Result<Self, MemoryError>

Build a Memory with either self-owned or VM owned metadata.

pub fn to_shared(self) -> VMSharedMemory

Converts this owned memory into shared memory

pub fn copy(&mut self) -> Result<Self, MemoryError>

Copies this memory to a new memory

Trait Implementations

impl Debug for VMOwnedMemory

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

Formats the value using the given formatter.

impl From<VMOwnedMemory> for VMMemory

fn from(mem: VMOwnedMemory) -> Self

Converts to this type from the input type.

impl LinearMemory for VMOwnedMemory

fn ty(&self) -> MemoryType

Returns the type for this memory.

fn size(&self) -> Pages

Returns the size of hte memory in pages

fn style(&self) -> MemoryStyle

Returns the memory style for this memory.

fn grow(&mut self, delta: Pages) -> Result<Pages, MemoryError>

Grow memory by the specified amount of wasm pages.

Returns None if memory can’t be grown by the specified amount of wasm pages.

fn grow_at_least(&mut self, min_size: u64) -> Result<(), MemoryError>

Grows the memory to at least a minimum size. If the memory is already big enough for the min size then this function does nothing

fn reset(&mut self) -> Result<(), MemoryError>

Resets the memory down to a zero size

fn vmmemory(&self) -> NonNull<VMMemoryDefinition>

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

fn try_clone(&self) -> Result<Box<dyn LinearMemory + 'static>, MemoryError>

Owned memory can not be cloned (this will always return None)

fn copy(&mut self) -> Result<Box<dyn LinearMemory + 'static>, MemoryError>

Copies this memory to a new memory

fn do_wait( &mut self, _dst: NotifyLocation, _timeout: Option<Duration>, ) -> Result<u32, WaiterError>

Add current thread to the waiter hash, and wait until notified or timout. Return 0 if the waiter has been notified, 2 if the timeout occured, or None if en error happened

fn do_notify(&mut self, _dst: NotifyLocation, _count: u32) -> u32

Notify waiters from the wait list. Return the number of waiters notified

fn thread_conditions(&self) -> Option<&ThreadConditions>

Access the internal atomics handler.

impl Send for VMOwnedMemory

impl Sync for VMOwnedMemory