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
//! Defines Executor struct.
#[cfg(all(feature = "async", target_os = "linux"))]
use crate::executor::sys::r#async::fiber::AsyncState;
use crate::{config::Config, Func, FuncRef, Statistics, WasmEdgeResult, WasmValue};
use wasmedge_sys as sys;
/// Defines an execution environment for both pure WASM and compiled WASM.
#[derive(Debug, Clone)]
pub struct Executor {
pub(crate) inner: sys::Executor,
}
impl Executor {
/// Creates a new [executor](crate::Executor) to be associated with the given [config](crate::config::Config) and [statistics](crate::Statistics).
///
/// # Arguments
///
/// - `config` specifies the configuration of the new [executor](crate::Executor).
///
/// - `stat` specifies the [statistics](crate::Statistics) needed by the new [executor](crate::Executor).
///
/// # Error
///
/// If fail to create a [executor](crate::Executor), then an error is returned.
pub fn new(config: Option<&Config>, stat: Option<&mut Statistics>) -> WasmEdgeResult<Self> {
let inner_executor = match config {
Some(config) => match stat {
Some(stat) => sys::Executor::create(Some(&config.inner), Some(&mut stat.inner))?,
None => sys::Executor::create(Some(&config.inner), None)?,
},
None => match stat {
Some(stat) => sys::Executor::create(None, Some(&mut stat.inner))?,
None => sys::Executor::create(None, None)?,
},
};
Ok(Self {
inner: inner_executor,
})
}
/// Runs a host function instance and returns the results.
///
/// # Arguments
///
/// * `func` - The function instance to run.
///
/// * `params` - The arguments to pass to the function.
///
/// # Errors
///
/// If fail to run the host function, then an error is returned.
pub fn run_func(
&self,
func: &Func,
params: impl IntoIterator<Item = WasmValue>,
) -> WasmEdgeResult<Vec<WasmValue>> {
self.inner.call_func(&func.inner, params)
}
/// Runs a host function instance with a timeout setting.
///
/// # Arguments
///
/// * `func` - The function instance to run.
///
/// * `params` - The arguments to pass to the function.
///
/// * `timeout` - The maximum execution time of the function to be run.
///
/// # Errors
///
/// If fail to run the host function, then an error is returned.
#[cfg(all(target_os = "linux", not(target_env = "musl")))]
#[cfg_attr(docsrs, doc(cfg(all(target_os = "linux", not(target_env = "musl")))))]
pub fn run_func_with_timeout(
&self,
func: &Func,
params: impl IntoIterator<Item = WasmValue>,
timeout: std::time::Duration,
) -> WasmEdgeResult<Vec<WasmValue>> {
self.inner
.call_func_with_timeout(&func.inner, params, timeout)
}
/// Asynchronously runs a host function instance and returns the results.
///
/// # Arguments
///
/// * `func` - The function instance to run.
///
/// * `params` - The arguments to pass to the function.
///
/// # Errors
///
/// If fail to run the host function, then an error is returned.
#[cfg(all(feature = "async", target_os = "linux"))]
#[cfg_attr(docsrs, doc(cfg(all(feature = "async", target_os = "linux"))))]
pub async fn run_func_async(
&self,
async_state: &AsyncState,
func: &Func,
params: impl IntoIterator<Item = WasmValue> + Send,
) -> WasmEdgeResult<Vec<WasmValue>> {
self.inner
.call_func_async(async_state, &func.inner, params)
.await
}
/// Asynchronously runs a host function instance with a timeout setting.
///
/// # Arguments
///
/// * `async_state` - Used to store asynchronous state at run time.
///
/// * `func` - The function instance to run.
///
/// * `params` - The arguments to pass to the function.
///
/// * `timeout` - The maximum execution time of the function to be run.
///
/// # Errors
///
/// If fail to run the host function, then an error is returned.
#[cfg(all(feature = "async", target_os = "linux", not(target_env = "musl")))]
#[cfg_attr(
docsrs,
doc(cfg(all(feature = "async", target_os = "linux", not(target_env = "musl"))))
)]
pub async fn run_func_async_with_timeout(
&self,
async_state: &AsyncState,
func: &Func,
params: impl IntoIterator<Item = WasmValue> + Send,
timeout: std::time::Duration,
) -> WasmEdgeResult<Vec<WasmValue>> {
self.inner
.call_func_async_with_timeout(async_state, &func.inner, params, timeout)
.await
}
/// Runs a host function reference instance and returns the results.
///
/// # Arguments
///
/// * `func_ref` - The function reference instance to run.
///
/// * `params` - The arguments to pass to the function.
///
/// # Errors
///
/// If fail to run the host function reference instance, then an error is returned.
pub fn run_func_ref(
&self,
func_ref: &FuncRef,
params: impl IntoIterator<Item = WasmValue>,
) -> WasmEdgeResult<Vec<WasmValue>> {
self.inner.call_func_ref(&func_ref.inner, params)
}
/// Asynchronously runs a host function reference instance and returns the results.
///
/// # Arguments
///
/// * `func_ref` - The function reference instance to run.
///
/// * `params` - The arguments to pass to the function.
///
/// # Errors
///
/// If fail to run the host function reference instance, then an error is returned.
#[cfg(all(feature = "async", target_os = "linux"))]
#[cfg_attr(docsrs, doc(cfg(all(feature = "async", target_os = "linux"))))]
pub async fn run_func_ref_async(
&self,
async_state: &AsyncState,
func_ref: &FuncRef,
params: impl IntoIterator<Item = WasmValue> + Send,
) -> WasmEdgeResult<Vec<WasmValue>> {
self.inner
.call_func_ref_async(async_state, &func_ref.inner, params)
.await
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{
config::{CommonConfigOptions, ConfigBuilder},
params, wat2wasm, Module, Statistics, Store, WasmVal,
};
#[cfg(all(feature = "async", target_os = "linux"))]
use crate::{error::HostFuncError, CallingFrame};
#[test]
#[allow(clippy::assertions_on_result_states)]
fn test_executor_create() {
{
let result = Executor::new(None, None);
assert!(result.is_ok());
}
{
let result = ConfigBuilder::new(CommonConfigOptions::default()).build();
assert!(result.is_ok());
let config = result.unwrap();
let result = Executor::new(Some(&config), None);
assert!(result.is_ok());
assert!(config.bulk_memory_operations_enabled());
}
{
let result = Statistics::new();
assert!(result.is_ok());
let mut stat = result.unwrap();
let result = Executor::new(None, Some(&mut stat));
assert!(result.is_ok());
assert_eq!(stat.cost(), 0);
}
{
let result = ConfigBuilder::new(CommonConfigOptions::default()).build();
assert!(result.is_ok());
let config = result.unwrap();
let result = Statistics::new();
assert!(result.is_ok());
let mut stat = result.unwrap();
let result = Executor::new(Some(&config), Some(&mut stat));
assert!(result.is_ok());
assert!(config.bulk_memory_operations_enabled());
assert_eq!(stat.cost(), 0);
}
}
#[test]
fn test_executor_run_func() {
// create an executor
let result = ConfigBuilder::new(CommonConfigOptions::default()).build();
assert!(result.is_ok());
let config = result.unwrap();
let result = Statistics::new();
assert!(result.is_ok());
let mut stat = result.unwrap();
let result = Executor::new(Some(&config), Some(&mut stat));
assert!(result.is_ok());
let mut executor = result.unwrap();
// create a store
let result = Store::new();
assert!(result.is_ok());
let mut store = result.unwrap();
// read the wasm bytes of fibonacci.wasm
let result = wat2wasm(
br#"
(module
(export "fib" (func $fib))
(func $fib (param $n i32) (result i32)
(if
(i32.lt_s
(local.get $n)
(i32.const 2)
)
(then
(return (i32.const 1))
)
)
(return
(i32.add
(call $fib
(i32.sub
(local.get $n)
(i32.const 2)
)
)
(call $fib
(i32.sub
(local.get $n)
(i32.const 1)
)
)
)
)
)
)
"#,
);
assert!(result.is_ok());
let wasm_bytes = result.unwrap();
let result = Module::from_bytes(Some(&config), wasm_bytes);
assert!(result.is_ok());
let module = result.unwrap();
// register a module into store as active module
let result = store.register_named_module(&mut executor, "extern", &module);
assert!(result.is_ok());
let extern_instance = result.unwrap();
// get the exported function "fib"
let result = extern_instance.func("fib");
assert!(result.is_ok());
let fib = result.unwrap();
// run the exported host function
let result = executor.run_func(&fib, params!(5));
assert!(result.is_ok());
let returns = result.unwrap();
assert_eq!(returns.len(), 1);
assert_eq!(returns[0].to_i32(), 8);
}
#[cfg(all(feature = "async", target_os = "linux"))]
#[tokio::test]
async fn test_executor_run_async_func() -> Result<(), Box<dyn std::error::Error>> {
fn async_hello(
_frame: CallingFrame,
_inputs: Vec<WasmValue>,
_data: *mut std::os::raw::c_void,
) -> Box<(dyn std::future::Future<Output = Result<Vec<WasmValue>, HostFuncError>> + Send)>
{
Box::new(async move {
for _ in 0..10 {
println!("[async hello] say hello");
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
}
println!("[async hello] Done!");
Ok(vec![])
})
}
#[derive(Debug)]
struct Data<T, S> {
_x: i32,
_y: String,
_v: Vec<T>,
_s: Vec<S>,
}
let data: Data<i32, &str> = Data {
_x: 12,
_y: "hello".to_string(),
_v: vec![1, 2, 3],
_s: vec!["macos", "linux", "windows"],
};
// create an async host function
let result =
Func::wrap_async_func::<(), (), Data<i32, &str>>(async_hello, Some(Box::new(data)));
assert!(result.is_ok());
let func = result.unwrap();
// create an executor
let executor = Executor::new(None, None).unwrap();
// create an async state
let async_state = AsyncState::new();
async fn tick() {
let mut i = 0;
loop {
println!("[tick] i={i}");
tokio::time::sleep(std::time::Duration::from_millis(500)).await;
i += 1;
}
}
tokio::spawn(tick());
// call the async host function
let _ = executor.run_func_async(&async_state, &func, []).await?;
Ok(())
}
}