Merge pull request #2832 from bytecodealliance/pch/wiggle_sync_shimming

wasi-common support for tokio, & wiggle support for async methods containing sync code

.github/workflows/main.yml

@@ -208,6 +208,7 @@ jobs:
     name: Test
     runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
         build: [stable, beta, nightly, windows, macos]
         include:
@@ -382,6 +383,7 @@ jobs:
     name: Build wasmtime
     runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
         include:
         - build: x86_64-linux

Cargo.toml

@@ -54,6 +54,7 @@ tempfile = "3.1.0"
 test-programs = { path = "crates/test-programs" }
 wasmtime-fuzzing = { path = "crates/fuzzing" }
 wasmtime-runtime = { path = "crates/runtime" }
+tokio = { version = "1.5.0", features = ["rt", "time", "macros", "rt-multi-thread"] }
 tracing-subscriber = "0.2.16"
 wast = "35.0.0"
 
@@ -78,8 +79,10 @@ members = [
   "crates/wiggle/wasmtime",
   "crates/wasi-common",
   "crates/wasi-common/cap-std-sync",
+  "crates/wasi-common/tokio",
   "examples/fib-debug/wasm",
   "examples/wasi/wasm",
+  "examples/tokio/wasm",
   "fuzz",
 ]
 
@@ -107,5 +110,9 @@ maintenance = { status = "actively-developed" }
 name = "host_segfault"
 harness = false
 
+[[example]]
+name = "tokio"
+required-features = ["wasmtime-wasi/tokio"]
+
 [profile.dev.package.backtrace]
 debug = false # FIXME(#1813)

crates/bench-api/src/lib.rs

@@ -83,9 +83,8 @@ use std::env;
 use std::os::raw::{c_int, c_void};
 use std::path::Path;
 use std::slice;
-use wasi_cap_std_sync::WasiCtxBuilder;
 use wasmtime::{Config, Engine, Instance, Linker, Module, Store};
-use wasmtime_wasi::Wasi;
+use wasmtime_wasi::sync::{Wasi, WasiCtxBuilder};
 
 pub type ExitCode = c_int;
 pub const OK: ExitCode = 0;

crates/c-api/src/wasi.rs

@@ -12,9 +12,10 @@ use std::slice;
 use std::str;
 use wasmtime::{Extern, Linker, Trap};
 use wasmtime_wasi::{
-    snapshots::preview_0::Wasi as WasiSnapshot0,
-    snapshots::preview_1::Wasi as WasiPreview1,
-    sync::{Dir, WasiCtxBuilder},
+    sync::{
+        snapshots::preview_0::Wasi as WasiSnapshot0, snapshots::preview_1::Wasi as WasiPreview1,
+        Dir, WasiCtxBuilder,
+    },
     WasiCtx,
 };
 

crates/misc/run-examples/src/main.rs

@@ -45,10 +45,13 @@ fn main() -> anyhow::Result<()> {
                 .arg(target))?;
         }
         println!("======== Rust example `{}` ============", example);
-        run(Command::new("cargo")
-            .arg("run")
-            .arg("--example")
-            .arg(&example))?;
+        let mut cargo_cmd = Command::new("cargo");
+        cargo_cmd.arg("run").arg("--example").arg(&example);
+
+        if example.contains("tokio") {
+            cargo_cmd.arg("--features").arg("wasmtime-wasi/tokio");
+        }
+        run(&mut cargo_cmd)?;
 
         println!("======== C/C++ example `{}` ============", example);
         for extension in ["c", "cc"].iter() {

crates/test-programs/Cargo.toml

@@ -14,14 +14,15 @@ cfg-if = "1.0"
 wasi-common = { path = "../wasi-common", version = "0.26.0" }
 wasi-cap-std-sync = { path = "../wasi-common/cap-std-sync", version = "0.26.0" }
 wasmtime = { path = "../wasmtime", version = "0.26.0" }
-wasmtime-wasi = { path = "../wasi", version = "0.26.0" }
+wasmtime-wasi = { path = "../wasi", version = "0.26.0", features = ["tokio"] }
 target-lexicon = "0.12.0"
 pretty_env_logger = "0.4.0"
 tempfile = "3.1.0"
 os_pipe = "0.9"
 anyhow = "1.0.19"
 wat = "1.0.37"
 cap-std = "0.13"
+tokio = { version = "1.5.0", features = ["rt-multi-thread"] }
 
 [features]
 test_programs = []

crates/test-programs/build.rs

@@ -40,7 +40,9 @@ mod wasi_tests {
             File::create(out_dir.join("wasi_tests.rs")).expect("error generating test source file");
         build_tests("wasi-tests", &out_dir).expect("building tests");
         test_directory(&mut out, "wasi-cap-std-sync", "cap_std_sync", &out_dir)
-            .expect("generating tests");
+            .expect("generating wasi-cap-std-sync tests");
+        test_directory(&mut out, "wasi-tokio", "tokio", &out_dir)
+            .expect("generating wasi-tokio tests");
     }
 
     fn build_tests(testsuite: &str, out_dir: &Path) -> io::Result<()> {
@@ -173,6 +175,7 @@ mod wasi_tests {
         match testsuite {
             "wasi-cap-std-sync" => cap_std_sync_ignore(name),
             "wasi-virtfs" => virtfs_ignore(name),
+            "wasi-tokio" => tokio_ignore(name),
             _ => panic!("unknown test suite: {}", testsuite),
         }
     }
@@ -200,6 +203,10 @@ mod wasi_tests {
         .contains(&name)
     }
 
+    /// Tokio should support the same things as cap_std_sync
+    fn tokio_ignore(name: &str) -> bool {
+        cap_std_sync_ignore(name)
+    }
     /// Virtfs barely works at all and is not suitable for any purpose
     fn virtfs_ignore(name: &str) -> bool {
         [
@@ -260,7 +267,7 @@ mod wasi_tests {
     /// Mark tests which require inheriting parent process stdio
     fn inherit_stdio(testsuite: &str, name: &str) -> bool {
         match testsuite {
-            "wasi-cap-std-sync" => match name {
+            "wasi-cap-std-sync" | "wasi-tokio" => match name {
                 "poll_oneoff_stdio" => true,
                 _ => false,
             },