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 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
use super::externals::{wasm_extern_t, wasm_extern_vec_t};
use super::module::wasm_module_t;
use super::store::{wasm_store_t, StoreRef};
use super::trap::wasm_trap_t;
use wasmer_api::{Extern, Instance, InstantiationError};
/// Opaque type representing a WebAssembly instance.
#[allow(non_camel_case_types)]
pub struct wasm_instance_t {
pub(crate) store: StoreRef,
pub(crate) inner: Instance,
}
/// Creates a new instance from a WebAssembly module and a
/// set of imports.
///
/// ## Errors
///
/// The function can fail in 2 ways:
///
/// 1. Link errors that happen when plugging the imports into the
/// instance,
/// 2. Runtime errors that happen when running the module `start`
/// function.
///
/// The failure is stored in the `trap` argument; the program doesn't
/// panic.
///
/// # Notes
///
/// The `store` argument is ignored. The store from the given module
/// will be used.
///
/// # Example
///
/// See the module's documentation.
#[no_mangle]
pub unsafe extern "C" fn wasm_instance_new(
store: Option<&mut wasm_store_t>,
module: Option<&wasm_module_t>,
imports: Option<&wasm_extern_vec_t>,
trap: Option<&mut *mut wasm_trap_t>,
) -> Option<Box<wasm_instance_t>> {
let store = store?;
let mut store_mut = store.inner.store_mut();
let module = module?;
let imports = imports?;
let wasm_module = &module.inner;
let module_imports = wasm_module.imports();
let module_import_count = module_imports.len();
let externs = imports
.as_slice()
.iter()
.map(|imp| Extern::from(imp.as_ref().unwrap().as_ref().clone()))
.take(module_import_count)
.collect::<Vec<Extern>>();
let instance = match Instance::new_by_index(&mut store_mut, wasm_module, &externs) {
Ok(instance) => instance,
Err(InstantiationError::Link(link_error)) => {
crate::error::update_last_error(link_error);
return None;
}
Err(InstantiationError::Start(runtime_error)) => {
if let Some(trap) = trap {
let this_trap: Box<wasm_trap_t> = Box::new(runtime_error.into());
*trap = Box::into_raw(this_trap);
}
return None;
}
Err(e @ InstantiationError::CpuFeature(_)) => {
crate::error::update_last_error(e);
return None;
}
Err(e @ InstantiationError::DifferentStores) => {
crate::error::update_last_error(e);
return None;
}
Err(e @ InstantiationError::DifferentArchOS) => {
crate::error::update_last_error(e);
return None;
}
};
Some(Box::new(wasm_instance_t {
store: store.inner.clone(),
inner: instance,
}))
}
/// Deletes an instance.
///
/// # Example
///
/// See [`wasm_instance_new`].
#[no_mangle]
pub unsafe extern "C" fn wasm_instance_delete(_instance: Option<Box<wasm_instance_t>>) {}
/// Gets the exports of the instance.
///
/// # Example
///
/// ```rust
/// # use wasmer_inline_c::assert_c;
/// # fn main() {
/// # (assert_c! {
/// # #include "tests/wasmer.h"
/// #
/// int main() {
/// // Create the engine and the store.
/// wasm_engine_t* engine = wasm_engine_new();
/// wasm_store_t* store = wasm_store_new(engine);
///
/// // Create a WebAssembly module from a WAT definition.
/// wasm_byte_vec_t wat;
/// wasmer_byte_vec_new_from_string(
/// &wat,
/// "(module\n"
/// " (func (export \"function\") (param i32 i64))\n"
/// " (global (export \"global\") i32 (i32.const 7))\n"
/// " (table (export \"table\") 0 funcref)\n"
/// " (memory (export \"memory\") 1))"
/// );
/// wasm_byte_vec_t wasm;
/// wat2wasm(&wat, &wasm);
///
/// // Create the module.
/// wasm_module_t* module = wasm_module_new(store, &wasm);
///
/// // Instantiate the module.
/// wasm_extern_vec_t imports = WASM_EMPTY_VEC;
/// wasm_trap_t* trap = NULL;
///
/// wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &trap);
/// assert(instance);
///
/// // Read the exports.
/// wasm_extern_vec_t exports;
/// wasm_instance_exports(instance, &exports);
///
/// // We have 4 of them.
/// assert(exports.size == 4);
///
/// // The first one is a function. Use `wasm_extern_as_func`
/// // to go further.
/// assert(wasm_extern_kind(exports.data[0]) == WASM_EXTERN_FUNC);
///
/// // The second one is a global. Use `wasm_extern_as_global` to
/// // go further.
/// assert(wasm_extern_kind(exports.data[1]) == WASM_EXTERN_GLOBAL);
///
/// // The third one is a table. Use `wasm_extern_as_table` to
/// // go further.
/// assert(wasm_extern_kind(exports.data[2]) == WASM_EXTERN_TABLE);
///
/// // The fourth one is a memory. Use `wasm_extern_as_memory` to
/// // go further.
/// assert(wasm_extern_kind(exports.data[3]) == WASM_EXTERN_MEMORY);
///
/// // Free everything.
/// wasm_extern_vec_delete(&exports);
/// wasm_instance_delete(instance);
/// wasm_module_delete(module);
/// wasm_byte_vec_delete(&wasm);
/// wasm_byte_vec_delete(&wat);
/// wasm_store_delete(store);
/// wasm_engine_delete(engine);
///
/// return 0;
/// }
/// # })
/// # .success();
/// # }
/// ```
///
/// To go further:
///
/// * [`wasm_extern_as_func`][super::externals::wasm_extern_as_func],
/// * [`wasm_extern_as_global`][super::externals::wasm_extern_as_global],
/// * [`wasm_extern_as_table`][super::externals::wasm_extern_as_table],
/// * [`wasm_extern_as_memory`][super::externals::wasm_extern_as_memory].
#[no_mangle]
pub unsafe extern "C" fn wasm_instance_exports(
instance: &wasm_instance_t,
// own
out: &mut wasm_extern_vec_t,
) {
let original_instance = instance;
let instance = &instance.inner;
let extern_vec: Vec<Option<Box<wasm_extern_t>>> = instance
.exports
.iter()
.map(|(_name, r#extern)| {
Some(Box::new(wasm_extern_t::new(
original_instance.store.clone(),
r#extern.clone(),
)))
})
.collect();
out.set_buffer(extern_vec);
}
#[cfg(test)]
mod tests {
#[cfg(not(target_os = "windows"))]
use inline_c::assert_c;
#[cfg(target_os = "windows")]
use wasmer_inline_c::assert_c;
#[cfg_attr(coverage, ignore)]
#[test]
fn test_instance_new() {
(assert_c! {
#include "tests/wasmer.h"
// The `sum` host function implementation.
wasm_trap_t* sum_callback(
const wasm_val_vec_t* arguments,
wasm_val_vec_t* results
) {
wasm_val_t sum = {
.kind = WASM_I32,
.of = { arguments->data[0].of.i32 + arguments->data[1].of.i32 },
};
results->data[0] = sum;
return NULL;
}
int main() {
// Create the engine and the store.
wasm_engine_t* engine = wasm_engine_new();
wasm_store_t* store = wasm_store_new(engine);
// Create a WebAssembly module from a WAT definition.
wasm_byte_vec_t wat;
wasmer_byte_vec_new_from_string(
&wat,
"(module\n"
" (import \"math\" \"sum\" (func $sum (param i32 i32) (result i32)))\n"
" (func (export \"add_one\") (param i32) (result i32)\n"
" local.get 0\n"
" i32.const 1\n"
" call $sum))"
);
wasm_byte_vec_t wasm;
wat2wasm(&wat, &wasm);
// Create the module.
wasm_module_t* module = wasm_module_new(store, &wasm);
assert(module);
// Prepare the imports.
wasm_functype_t* sum_type = wasm_functype_new_2_1(
wasm_valtype_new_i32(),
wasm_valtype_new_i32(),
wasm_valtype_new_i32()
);
wasm_func_t* sum_function = wasm_func_new(store, sum_type, sum_callback);
wasm_extern_t* externs[] = { wasm_func_as_extern(sum_function) };
wasm_extern_vec_t imports = WASM_ARRAY_VEC(externs);
// Instantiate the module.
wasm_trap_t* trap = NULL;
wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &trap);
assert(instance);
// Run the exported function.
wasm_extern_vec_t exports;
wasm_instance_exports(instance, &exports);
assert(exports.size == 1);
const wasm_func_t* run_function = wasm_extern_as_func(exports.data[0]);
assert(run_function);
wasm_val_t arguments[1] = { WASM_I32_VAL(1) };
wasm_val_t results[1] = { WASM_INIT_VAL };
wasm_val_vec_t arguments_as_array = WASM_ARRAY_VEC(arguments);
wasm_val_vec_t results_as_array = WASM_ARRAY_VEC(results);
trap = wasm_func_call(run_function, &arguments_as_array, &results_as_array);
assert(trap == NULL);
assert(results[0].of.i32 == 2);
// Free everything.
wasm_extern_vec_delete(&exports);
wasm_instance_delete(instance);
wasm_func_delete(sum_function);
wasm_functype_delete(sum_type);
wasm_module_delete(module);
wasm_byte_vec_delete(&wasm);
wasm_byte_vec_delete(&wat);
wasm_store_delete(store);
wasm_engine_delete(engine);
return 0;
}
})
.success();
}
}