wasmer 7.2.0

High-performance WebAssembly runtime
Documentation
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
use macro_wasmer_engine_test::engine_test;
#[cfg(feature = "js")]
use wasm_bindgen_test::*;

use wasmer::*;

#[cfg(unix)]
use std::ffi::OsStr;
#[cfg(unix)]
use std::os::unix::ffi::OsStrExt;

#[engine_test]
fn module_get_name() -> Result<(), String> {
    let store = Store::default();
    let wat = r#"(module)"#;
    let module = Module::new(&store, wat).map_err(|e| format!("{e:?}"))?;
    assert_eq!(module.name(), None);

    Ok(())
}

#[engine_test]
fn module_set_name() -> Result<(), String> {
    let store = Store::default();
    let wat = r#"(module $name)"#;
    let mut module = Module::new(&store, wat).map_err(|e| format!("{e:?}"))?;
    assert_eq!(module.name(), Some("name"));

    module.set_name("new_name");
    assert_eq!(module.name(), Some("new_name"));

    Ok(())
}

#[engine_test]
fn imports() -> Result<(), String> {
    let store = Store::default();
    let wat = r#"(module
(import "host" "func" (func))
(import "host" "memory" (memory 1))
(import "host" "table" (table 1 funcref))
(import "host" "global" (global i32))
)"#;
    let module = Module::new(&store, wat).map_err(|e| format!("{e:?}"))?;
    assert_eq!(
        module.imports().collect::<Vec<_>>(),
        vec![
            ImportType::new(
                "host",
                "func",
                ExternType::Function(FunctionType::new(vec![], vec![]))
            ),
            ImportType::new(
                "host",
                "memory",
                ExternType::Memory(MemoryType::new(Pages(1), None, false))
            ),
            ImportType::new(
                "host",
                "table",
                ExternType::Table(TableType::new(Type::FuncRef, 1, None))
            ),
            ImportType::new(
                "host",
                "global",
                ExternType::Global(GlobalType::new(Type::I32, Mutability::Const))
            )
        ]
    );

    // Now we test the iterators
    assert_eq!(
        module.imports().functions().collect::<Vec<_>>(),
        vec![ImportType::new(
            "host",
            "func",
            FunctionType::new(vec![], vec![])
        ),]
    );
    assert_eq!(
        module.imports().memories().collect::<Vec<_>>(),
        vec![ImportType::new(
            "host",
            "memory",
            MemoryType::new(Pages(1), None, false)
        ),]
    );
    assert_eq!(
        module.imports().tables().collect::<Vec<_>>(),
        vec![ImportType::new(
            "host",
            "table",
            TableType::new(Type::FuncRef, 1, None)
        ),]
    );
    assert_eq!(
        module.imports().globals().collect::<Vec<_>>(),
        vec![ImportType::new(
            "host",
            "global",
            GlobalType::new(Type::I32, Mutability::Const)
        ),]
    );
    Ok(())
}

#[test]
fn exports() -> Result<(), String> {
    let store = Store::default();
    let wat = r#"(module
(func (export "func") nop)
(memory (export "memory") 1)
(table (export "table") 1 funcref)
(global (export "global") i32 (i32.const 0))
)"#;
    let module = Module::new(&store, wat).map_err(|e| format!("{e:?}"))?;
    assert_eq!(
        module.exports().collect::<Vec<_>>(),
        vec![
            ExportType::new(
                "func",
                ExternType::Function(FunctionType::new(vec![], vec![]))
            ),
            ExportType::new(
                "memory",
                ExternType::Memory(MemoryType::new(Pages(1), None, false))
            ),
            ExportType::new(
                "table",
                ExternType::Table(TableType::new(Type::FuncRef, 1, None))
            ),
            ExportType::new(
                "global",
                ExternType::Global(GlobalType::new(Type::I32, Mutability::Const))
            )
        ]
    );

    // Now we test the iterators
    assert_eq!(
        module.exports().functions().collect::<Vec<_>>(),
        vec![ExportType::new("func", FunctionType::new(vec![], vec![])),]
    );
    assert_eq!(
        module.exports().memories().collect::<Vec<_>>(),
        vec![ExportType::new(
            "memory",
            MemoryType::new(Pages(1), None, false)
        ),]
    );
    assert_eq!(
        module.exports().tables().collect::<Vec<_>>(),
        vec![ExportType::new(
            "table",
            TableType::new(Type::FuncRef, 1, None)
        ),]
    );
    assert_eq!(
        module.exports().globals().collect::<Vec<_>>(),
        vec![ExportType::new(
            "global",
            GlobalType::new(Type::I32, Mutability::Const)
        ),]
    );
    Ok(())
}

#[engine_test]
fn calling_host_functions_with_negative_values_works() -> Result<(), String> {
    let mut store = Store::default();
    let wat = r#"(module
(import "host" "host_func1" (func (param i64)))
(import "host" "host_func2" (func (param i32)))
(import "host" "host_func3" (func (param i64)))
(import "host" "host_func4" (func (param i32)))
(import "host" "host_func5" (func (param i32)))
(import "host" "host_func6" (func (param i32)))
(import "host" "host_func7" (func (param i32)))
(import "host" "host_func8" (func (param i32)))

(func (export "call_host_func1")
      (call 0 (i64.const -1)))
(func (export "call_host_func2")
      (call 1 (i32.const -1)))
(func (export "call_host_func3")
      (call 2 (i64.const -1)))
(func (export "call_host_func4")
      (call 3 (i32.const -1)))
(func (export "call_host_func5")
      (call 4 (i32.const -1)))
(func (export "call_host_func6")
      (call 5 (i32.const -1)))
(func (export "call_host_func7")
      (call 6 (i32.const -1)))
(func (export "call_host_func8")
      (call 7 (i32.const -1)))
)"#;
    let module = Module::new(&store, wat).map_err(|e| format!("{e:?}"))?;
    let imports = imports! {
        "host" => {
            "host_func1" => Function::new_typed(&mut store, |p: u64| {
                println!("host_func1: Found number {p}");
                assert_eq!(p, u64::MAX);
            }),
            "host_func2" => Function::new_typed(&mut store, |p: u32| {
                println!("host_func2: Found number {p}");
                assert_eq!(p, u32::MAX);
            }),
            "host_func3" => Function::new_typed(&mut store, |p: i64| {
                println!("host_func3: Found number {p}");
                assert_eq!(p, -1);
            }),
            "host_func4" => Function::new_typed(&mut store, |p: i32| {
                println!("host_func4: Found number {p}");
                assert_eq!(p, -1);
            }),
            "host_func5" => Function::new_typed(&mut store, |p: i16| {
                println!("host_func5: Found number {p}");
                assert_eq!(p, -1);
            }),
            "host_func6" => Function::new_typed(&mut store, |p: u16| {
                println!("host_func6: Found number {p}");
                assert_eq!(p, u16::MAX);
            }),
            "host_func7" => Function::new_typed(&mut store, |p: i8| {
                println!("host_func7: Found number {p}");
                assert_eq!(p, -1);
            }),
            "host_func8" => Function::new_typed(&mut store, |p: u8| {
                println!("host_func8: Found number {p}");
                assert_eq!(p, u8::MAX);
            }),
        }
    };
    let instance = Instance::new(&mut store, &module, &imports).map_err(|e| format!("{e:?}"))?;

    let f1: TypedFunction<(), ()> = instance
        .exports
        .get_typed_function(&store, "call_host_func1")
        .map_err(|e| format!("{e:?}"))?;
    let f2: TypedFunction<(), ()> = instance
        .exports
        .get_typed_function(&store, "call_host_func2")
        .map_err(|e| format!("{e:?}"))?;
    let f3: TypedFunction<(), ()> = instance
        .exports
        .get_typed_function(&store, "call_host_func3")
        .map_err(|e| format!("{e:?}"))?;
    let f4: TypedFunction<(), ()> = instance
        .exports
        .get_typed_function(&store, "call_host_func4")
        .map_err(|e| format!("{e:?}"))?;
    let f5: TypedFunction<(), ()> = instance
        .exports
        .get_typed_function(&store, "call_host_func5")
        .map_err(|e| format!("{e:?}"))?;
    let f6: TypedFunction<(), ()> = instance
        .exports
        .get_typed_function(&store, "call_host_func6")
        .map_err(|e| format!("{e:?}"))?;
    let f7: TypedFunction<(), ()> = instance
        .exports
        .get_typed_function(&store, "call_host_func7")
        .map_err(|e| format!("{e:?}"))?;
    let f8: TypedFunction<(), ()> = instance
        .exports
        .get_typed_function(&store, "call_host_func8")
        .map_err(|e| format!("{e:?}"))?;

    f1.call(&mut store).map_err(|e| format!("{e:?}"))?;
    f2.call(&mut store).map_err(|e| format!("{e:?}"))?;
    f3.call(&mut store).map_err(|e| format!("{e:?}"))?;
    f4.call(&mut store).map_err(|e| format!("{e:?}"))?;
    f5.call(&mut store).map_err(|e| format!("{e:?}"))?;
    f6.call(&mut store).map_err(|e| format!("{e:?}"))?;
    f7.call(&mut store).map_err(|e| format!("{e:?}"))?;
    f8.call(&mut store).map_err(|e| format!("{e:?}"))?;

    Ok(())
}

#[engine_test]
#[allow(unused_attributes)]
fn module_custom_sections() -> Result<(), String> {
    let store = Store::default();
    let custom_section_wasm_bytes = include_bytes!("simple-name-section.wasm");
    let module = Module::new(&store, custom_section_wasm_bytes).map_err(|e| format!("{e:?}"))?;
    let sections = module.custom_sections("name");
    let sections_vec: Vec<Box<[u8]>> = sections.collect();
    assert_eq!(sections_vec.len(), 1);
    assert_eq!(
        sections_vec[0],
        vec![2, 2, 36, 105, 1, 0, 0, 0].into_boxed_slice()
    );
    Ok(())
}

#[cfg(all(
    not(target_arch = "wasm32"),
    any(feature = "cranelift", feature = "llvm", feature = "singlepass")
))]
mod function_extents_tests {
    use super::*;

    /// Returns a [`Store`] backed by the sys engine using whatever compiler is
    /// available. Cranelift is preferred, then Singlepass, then LLVM.
    fn sys_store() -> Store {
        #[cfg(feature = "cranelift")]
        let engine: Engine = wasmer::sys::EngineBuilder::new(wasmer::sys::Cranelift::default())
            .engine()
            .into();
        #[cfg(all(not(feature = "cranelift"), feature = "singlepass"))]
        let engine: Engine = wasmer::sys::EngineBuilder::new(wasmer::sys::Singlepass::default())
            .engine()
            .into();
        #[cfg(all(
            not(feature = "cranelift"),
            not(feature = "singlepass"),
            feature = "llvm"
        ))]
        let engine: Engine = wasmer::sys::EngineBuilder::new(wasmer::sys::LLVM::default())
            .engine()
            .into();
        Store::new(engine)
    }

    #[test]
    fn returns_one_entry_per_local_function() -> Result<(), String> {
        let store = sys_store();
        let wat = r#"(module
            (func $f1 (result i32) i32.const 1)
            (func $f2 (result i32) i32.const 2)
            (func $f3 (param i32) (result i32) local.get 0)
        )"#;
        let module = Module::new(&store, wat).map_err(|e| format!("{e:?}"))?;
        let extents = module
            .sys_artifact()
            .expect("expected sys-backend module artifact")
            .finished_function_extents()
            .expect("JIT-compiled artifact must have function extents");

        assert_eq!(extents.len(), 3, "expected one extent per local function");
        let indices: Vec<u32> = extents.iter().map(|(i, _)| i.as_u32()).collect();
        assert_eq!(
            indices,
            vec![0, 1, 2],
            "indices must be sequential starting from 0"
        );
        for (index, extent) in &extents {
            assert!(
                !extent.ptr.0.is_null(),
                "function {} has null address",
                index.as_u32()
            );
            assert_ne!(
                extent.length,
                0,
                "function {} has zero length",
                index.as_u32()
            );
        }

        Ok(())
    }

    #[test]
    fn excludes_imported_functions() -> Result<(), String> {
        let store = sys_store();
        let wat = r#"(module
            (import "env" "f" (func (param i32)))
            (func $local1 (result i32) i32.const 42)
            (func $local2 (param i32) (result i32) local.get 0)
        )"#;
        let module = Module::new(&store, wat).map_err(|e| format!("{e:?}"))?;
        let extents = module
            .sys_artifact()
            .expect("expected sys-backend module artifact")
            .finished_function_extents()
            .expect("JIT-compiled artifact must have function extents");

        assert_eq!(
            extents.len(),
            2,
            "imported functions must not appear in extents"
        );
        let indices: Vec<u32> = extents.iter().map(|(i, _)| i.as_u32()).collect();
        assert_eq!(
            indices,
            vec![0, 1],
            "indices must be local (0-based), not global function indices"
        );

        Ok(())
    }
}

#[test]
#[cfg(unix)]
fn module_from_file_non_utf8_path() -> Result<(), String> {
    let store = Store::default();
    let wasm_bytes = wat2wasm(b"(module)").map_err(|e| format!("{e:?}"))?;

    let dir = tempfile::tempdir().map_err(|e| format!("{e:?}"))?;
    let non_utf8_name = OsStr::from_bytes(b"module_\xff\xfe.wasm");
    let path = dir.path().join(non_utf8_name);

    // Some platforms and file systems do not support non-UTF-8 paths, so skip them.
    if std::fs::write(&path, &wasm_bytes).is_err() {
        return Ok(());
    }

    let module = Module::from_file(&store, &path).map_err(|e| format!("{e:?}"))?;
    let canonical = path.canonicalize().map_err(|e| format!("{e:?}"))?;
    assert_eq!(module.name(), Some(canonical.to_string_lossy().as_ref()),);
    Ok(())
}