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
use crate::{
Extern, error::InstantiationError, exports::Exports, imports::Imports,
macros::backend::gen_rt_ty, module::Module, store::AsStoreMut,
};
/// A WebAssembly Instance is a stateful, executable
/// instance of a WebAssembly [`Module`].
///
/// Instance objects contain all the exported WebAssembly
/// functions, memories, tables and globals that allow
/// interacting with WebAssembly.
///
/// Spec: <https://webassembly.github.io/spec/core/exec/runtime.html#module-instances>
#[derive(Clone, PartialEq, Eq)]
pub struct Instance {
pub(crate) _inner: BackendInstance,
pub(crate) module: Module,
/// The exports for an instance.
pub exports: Exports,
}
impl Instance {
/// Creates a new `Instance` from a WebAssembly [`Module`] and a
/// set of imports using [`Imports`] or the [`imports!`] macro helper.
///
/// [`imports!`]: crate::imports!
/// [`Imports!`]: crate::Imports!
///
/// ```
/// # use wasmer::{imports, Store, Module, Global, Value, Instance};
/// # use wasmer::FunctionEnv;
/// # fn main() -> anyhow::Result<()> {
/// let mut store = Store::default();
/// let env = FunctionEnv::new(&mut store, ());
/// let module = Module::new(&store, "(module)")?;
/// let imports = imports!{
/// "host" => {
/// "var" => Global::new(&mut store, Value::I32(2))
/// }
/// };
/// let instance = Instance::new(&mut store, &module, &imports)?;
/// # Ok(())
/// # }
/// ```
///
/// ## Errors
///
/// The function can return [`InstantiationError`]s.
///
/// Those are, as defined by the spec:
/// * Link errors that happen when plugging the imports into the instance
/// * Runtime errors that happen when running the module `start` function.
#[allow(clippy::result_large_err)]
pub fn new(
store: &mut impl AsStoreMut,
module: &Module,
imports: &Imports,
) -> Result<Self, InstantiationError> {
let (_inner, exports) = match &store.as_store_mut().inner.store {
#[cfg(feature = "sys")]
crate::BackendStore::Sys(_) => {
let (i, e) = crate::backend::sys::instance::Instance::new(store, module, imports)?;
(crate::BackendInstance::Sys(i), e)
}
#[cfg(feature = "wamr")]
crate::BackendStore::Wamr(_) => {
let (i, e) = crate::backend::wamr::instance::Instance::new(store, module, imports)?;
(crate::BackendInstance::Wamr(i), e)
}
#[cfg(feature = "wasmi")]
crate::BackendStore::Wasmi(_) => {
let (i, e) =
crate::backend::wasmi::instance::Instance::new(store, module, imports)?;
(crate::BackendInstance::Wasmi(i), e)
}
#[cfg(feature = "v8")]
crate::BackendStore::V8(_) => {
let (i, e) = crate::backend::v8::instance::Instance::new(store, module, imports)?;
(crate::BackendInstance::V8(i), e)
}
#[cfg(feature = "js")]
crate::BackendStore::Js(_) => {
let (i, e) = crate::backend::js::instance::Instance::new(store, module, imports)?;
(crate::BackendInstance::Js(i), e)
}
#[cfg(feature = "jsc")]
crate::BackendStore::Jsc(_) => {
let (i, e) = crate::backend::jsc::instance::Instance::new(store, module, imports)?;
(crate::BackendInstance::Jsc(i), e)
}
};
Ok(Self {
_inner,
module: module.clone(),
exports,
})
}
/// Creates a new `Instance` from a WebAssembly [`Module`] and a
/// vector of imports.
///
/// ## Errors
///
/// The function can return [`InstantiationError`]s.
///
/// Those are, as defined by the spec:
/// * Link errors that happen when plugging the imports into the instance
/// * Runtime errors that happen when running the module `start` function.
#[allow(clippy::result_large_err)]
pub fn new_by_index(
store: &mut impl AsStoreMut,
module: &Module,
externs: &[Extern],
) -> Result<Self, InstantiationError> {
let (_inner, exports) = match &store.as_store_mut().inner.store {
#[cfg(feature = "sys")]
crate::BackendStore::Sys(_) => {
let (i, e) =
crate::backend::sys::instance::Instance::new_by_index(store, module, externs)?;
(crate::BackendInstance::Sys(i), e)
}
#[cfg(feature = "wamr")]
crate::BackendStore::Wamr(_) => {
let (i, e) =
crate::backend::wamr::instance::Instance::new_by_index(store, module, externs)?;
(crate::BackendInstance::Wamr(i), e)
}
#[cfg(feature = "wasmi")]
crate::BackendStore::Wasmi(_) => {
let (i, e) = crate::backend::wasmi::instance::Instance::new_by_index(
store, module, externs,
)?;
(crate::BackendInstance::Wasmi(i), e)
}
#[cfg(feature = "v8")]
crate::BackendStore::V8(_) => {
let (i, e) =
crate::backend::v8::instance::Instance::new_by_index(store, module, externs)?;
(crate::BackendInstance::V8(i), e)
}
#[cfg(feature = "js")]
crate::BackendStore::Js(_) => {
let (i, e) =
crate::backend::js::instance::Instance::new_by_index(store, module, externs)?;
(crate::BackendInstance::Js(i), e)
}
#[cfg(feature = "jsc")]
crate::BackendStore::Jsc(_) => {
let (i, e) =
crate::backend::jsc::instance::Instance::new_by_index(store, module, externs)?;
(crate::BackendInstance::Jsc(i), e)
}
};
Ok(Self {
_inner,
module: module.clone(),
exports,
})
}
/// Gets the [`Module`] associated with this instance.
pub fn module(&self) -> &Module {
&self.module
}
}
impl std::fmt::Debug for Instance {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
f.debug_struct("Instance")
.field("exports", &self.exports)
.finish()
}
}
/// An enumeration of all the possible instances kind supported by the runtimes.
gen_rt_ty!(Instance @derives Clone, PartialEq, Eq);