1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
pub(crate) use self::builder::InstanceEntityBuilder;
pub use self::exports::{Export, ExportsIter, Extern, ExternType};
use super::{
engine::DedupFuncType,
AsContext,
Func,
Global,
Memory,
Module,
StoreContext,
Stored,
Table,
};
use crate::{
func::FuncError,
memory::DataSegment,
ElementSegment,
Error,
TypedFunc,
WasmParams,
WasmResults,
};
use alloc::{boxed::Box, collections::BTreeMap, sync::Arc};
use wasmi_arena::ArenaIndex;
mod builder;
mod exports;
/// A raw index to a module instance entity.
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct InstanceIdx(u32);
impl ArenaIndex for InstanceIdx {
fn into_usize(self) -> usize {
self.0 as usize
}
fn from_usize(value: usize) -> Self {
let value = value.try_into().unwrap_or_else(|error| {
panic!("index {value} is out of bounds as instance index: {error}")
});
Self(value)
}
}
/// A module instance entity.
#[derive(Debug)]
pub struct InstanceEntity {
initialized: bool,
func_types: Arc<[DedupFuncType]>,
tables: Box<[Table]>,
funcs: Box<[Func]>,
memories: Box<[Memory]>,
globals: Box<[Global]>,
exports: BTreeMap<Box<str>, Extern>,
data_segments: Box<[DataSegment]>,
elem_segments: Box<[ElementSegment]>,
}
impl InstanceEntity {
/// Creates an uninitialized [`InstanceEntity`].
pub fn uninitialized() -> InstanceEntity {
Self {
initialized: false,
func_types: Arc::new([]),
tables: [].into(),
funcs: [].into(),
memories: [].into(),
globals: [].into(),
exports: BTreeMap::new(),
data_segments: [].into(),
elem_segments: [].into(),
}
}
/// Creates a new [`InstanceEntityBuilder`].
pub fn build(module: &Module) -> InstanceEntityBuilder {
InstanceEntityBuilder::new(module)
}
/// Returns `true` if the [`InstanceEntity`] has been fully initialized.
pub fn is_initialized(&self) -> bool {
self.initialized
}
/// Returns the linear memory at the `index` if any.
pub fn get_memory(&self, index: u32) -> Option<Memory> {
self.memories.get(index as usize).copied()
}
/// Returns the table at the `index` if any.
pub fn get_table(&self, index: u32) -> Option<Table> {
self.tables.get(index as usize).copied()
}
/// Returns the global variable at the `index` if any.
pub fn get_global(&self, index: u32) -> Option<Global> {
self.globals.get(index as usize).copied()
}
/// Returns the function at the `index` if any.
pub fn get_func(&self, index: u32) -> Option<Func> {
self.funcs.get(index as usize).copied()
}
/// Returns the signature at the `index` if any.
pub fn get_signature(&self, index: u32) -> Option<&DedupFuncType> {
self.func_types.get(index as usize)
}
/// Returns the [`DataSegment`] at the `index` if any.
pub fn get_data_segment(&self, index: u32) -> Option<DataSegment> {
self.data_segments.get(index as usize).copied()
}
/// Returns the [`ElementSegment`] at the `index` if any.
pub fn get_element_segment(&self, index: u32) -> Option<ElementSegment> {
self.elem_segments.get(index as usize).copied()
}
/// Returns the value exported to the given `name` if any.
pub fn get_export(&self, name: &str) -> Option<Extern> {
self.exports.get(name).copied()
}
/// Returns an iterator over the exports of the [`Instance`].
///
/// The order of the yielded exports is not specified.
pub fn exports(&self) -> ExportsIter {
ExportsIter::new(self.exports.iter())
}
}
/// An instantiated WebAssembly [`Module`].
///
/// This type represents an instantiation of a [`Module`].
/// It primarily allows to access its [`exports`](Instance::exports)
/// to call functions, get or set globals, read or write memory, etc.
///
/// When interacting with any Wasm code you will want to create an
/// [`Instance`] in order to execute anything.
///
/// Instances are owned by a [`Store`](crate::Store).
/// Create new instances using [`Linker::instantiate`](crate::Linker::instantiate).
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[repr(transparent)]
pub struct Instance(Stored<InstanceIdx>);
impl Instance {
/// Creates a new stored instance reference.
///
/// # Note
///
/// This API is primarily used by the [`Store`] itself.
///
/// [`Store`]: [`crate::Store`]
pub(super) fn from_inner(stored: Stored<InstanceIdx>) -> Self {
Self(stored)
}
/// Returns the underlying stored representation.
pub(super) fn as_inner(&self) -> &Stored<InstanceIdx> {
&self.0
}
/// Returns the function at the `index` if any.
///
/// # Panics
///
/// Panics if `store` does not own this [`Instance`].
pub(crate) fn get_func_by_index(&self, store: impl AsContext, index: u32) -> Option<Func> {
store
.as_context()
.store
.inner
.resolve_instance(self)
.get_func(index)
}
/// Returns the value exported to the given `name` if any.
///
/// # Panics
///
/// Panics if `store` does not own this [`Instance`].
pub fn get_export(&self, store: impl AsContext, name: &str) -> Option<Extern> {
store
.as_context()
.store
.inner
.resolve_instance(self)
.get_export(name)
}
/// Looks up an exported [`Func`] value by `name`.
///
/// Returns `None` if there was no export named `name`,
/// or if there was but it wasn’t a function.
///
/// # Panics
///
/// If `store` does not own this [`Instance`].
pub fn get_func(&self, store: impl AsContext, name: &str) -> Option<Func> {
self.get_export(store, name)?.into_func()
}
/// Looks up an exported [`Func`] value by `name`.
///
/// Returns `None` if there was no export named `name`,
/// or if there was but it wasn’t a function.
///
/// # Errors
///
/// - If there is no export named `name`.
/// - If there is no exported function named `name`.
/// - If `Params` or `Results` do not match the exported function type.
///
/// # Panics
///
/// If `store` does not own this [`Instance`].
pub fn get_typed_func<Params, Results>(
&self,
store: impl AsContext,
name: &str,
) -> Result<TypedFunc<Params, Results>, Error>
where
Params: WasmParams,
Results: WasmResults,
{
self.get_export(&store, name)
.and_then(Extern::into_func)
.ok_or_else(|| Error::Func(FuncError::ExportedFuncNotFound))?
.typed::<Params, Results>(store)
}
/// Looks up an exported [`Global`] value by `name`.
///
/// Returns `None` if there was no export named `name`,
/// or if there was but it wasn’t a global variable.
///
/// # Panics
///
/// If `store` does not own this [`Instance`].
pub fn get_global(&self, store: impl AsContext, name: &str) -> Option<Global> {
self.get_export(store, name)?.into_global()
}
/// Looks up an exported [`Table`] value by `name`.
///
/// Returns `None` if there was no export named `name`,
/// or if there was but it wasn’t a table.
///
/// # Panics
///
/// If `store` does not own this [`Instance`].
pub fn get_table(&self, store: impl AsContext, name: &str) -> Option<Table> {
self.get_export(store, name)?.into_table()
}
/// Looks up an exported [`Memory`] value by `name`.
///
/// Returns `None` if there was no export named `name`,
/// or if there was but it wasn’t a table.
///
/// # Panics
///
/// If `store` does not own this [`Instance`].
pub fn get_memory(&self, store: impl AsContext, name: &str) -> Option<Memory> {
self.get_export(store, name)?.into_memory()
}
/// Returns an iterator over the exports of the [`Instance`].
///
/// The order of the yielded exports is not specified.
///
/// # Panics
///
/// Panics if `store` does not own this [`Instance`].
pub fn exports<'ctx, T: 'ctx>(
&self,
store: impl Into<StoreContext<'ctx, T>>,
) -> ExportsIter<'ctx> {
store.into().store.inner.resolve_instance(self).exports()
}
}