Wasmtime
memory.h File Reference
#include <wasm.h>
#include <wasmtime/extern.h>
#include <wasmtime/store.h>
#include <wasmtime/error.h>

Go to the source code of this file.

Functions

wasm_memorytype_twasmtime_memorytype_new (uint64_t min, bool max_present, uint64_t max, bool is_64)
 Creates a new memory type from the specified parameters. More...
 
uint64_t wasmtime_memorytype_minimum (const wasm_memorytype_t *ty)
 Returns the minimum size, in pages, of the specified memory type. More...
 
bool wasmtime_memorytype_maximum (const wasm_memorytype_t *ty, uint64_t *max)
 Returns the maximum size, in pages, of the specified memory type. More...
 
bool wasmtime_memorytype_is64 (const wasm_memorytype_t *ty)
 Returns whether this type of memory represents a 64-bit memory.
 
wasmtime_error_twasmtime_memory_new (wasmtime_context_t *store, const wasm_memorytype_t *ty, wasmtime_memory_t *ret)
 Creates a new WebAssembly linear memory. More...
 
wasm_memorytype_twasmtime_memory_type (const wasmtime_context_t *store, const wasmtime_memory_t *memory)
 Returns the tyep of the memory specified.
 
uint8_t * wasmtime_memory_data (const wasmtime_context_t *store, const wasmtime_memory_t *memory)
 Returns the base pointer in memory where the linear memory starts.
 
size_t wasmtime_memory_data_size (const wasmtime_context_t *store, const wasmtime_memory_t *memory)
 Returns the byte length of this linear memory.
 
uint64_t wasmtime_memory_size (const wasmtime_context_t *store, const wasmtime_memory_t *memory)
 Returns the length, in WebAssembly pages, of this linear memory.
 
wasmtime_error_twasmtime_memory_grow (wasmtime_context_t *store, const wasmtime_memory_t *memory, uint64_t delta, uint64_t *prev_size)
 Attempts to grow the specified memory by delta pages. More...
 

Detailed Description

Wasmtime API for interacting with wasm memories.

Function Documentation

◆ wasmtime_memory_grow()

wasmtime_error_t * wasmtime_memory_grow ( wasmtime_context_t store,
const wasmtime_memory_t memory,
uint64_t  delta,
uint64_t *  prev_size 
)

Attempts to grow the specified memory by delta pages.

Parameters
storethe store that owns memory
memorythe memory to grow
deltathe number of pages to grow by
prev_sizewhere to store the previous size of memory

If memory cannot be grown then prev_size is left unchanged and an error is returned. Otherwise prev_size is set to the previous size of the memory, in WebAssembly pages, and NULL is returned.

◆ wasmtime_memory_new()

wasmtime_error_t * wasmtime_memory_new ( wasmtime_context_t store,
const wasm_memorytype_t ty,
wasmtime_memory_t ret 
)

Creates a new WebAssembly linear memory.

Parameters
storethe store to create the memory within
tythe type of the memory to create
retwhere to store the returned memory

If an error happens when creating the memory it's returned and owned by the caller. If an error happens then ret is not filled in.

◆ wasmtime_memorytype_maximum()

bool wasmtime_memorytype_maximum ( const wasm_memorytype_t ty,
uint64_t *  max 
)

Returns the maximum size, in pages, of the specified memory type.

If this memory type doesn't have a maximum size listed then false is returned. Otherwise true is returned and the max pointer is filled in with the specified maximum size, in pages.

Note that this function is preferred over wasm_memorytype_limits for compatibility with the memory64 proposal.

◆ wasmtime_memorytype_minimum()

uint64_t wasmtime_memorytype_minimum ( const wasm_memorytype_t ty)

Returns the minimum size, in pages, of the specified memory type.

Note that this function is preferred over wasm_memorytype_limits for compatibility with the memory64 proposal.

◆ wasmtime_memorytype_new()

wasm_memorytype_t * wasmtime_memorytype_new ( uint64_t  min,
bool  max_present,
uint64_t  max,
bool  is_64 
)

Creates a new memory type from the specified parameters.

Note that this function is preferred over wasm_memorytype_new for compatibility with the memory64 proposal.