chore: new benchmark suite with coremark

Signed-off-by: Henry <mail@henrygressmann.de>

Author: explodingcamera

.cargo/config.toml

@@ -1,12 +1,14 @@
 [alias]
-version-dev="workspaces version --no-git-commit --force tinywasm*"
-test-wasm-1="test --package tinywasm --test test-wasm-1 --release"
-test-wasm-2="test --package tinywasm --test test-wasm-2 --release"
-test-wasm-3="test --package tinywasm --test test-wasm-3 --release"
-test-wast="test --package tinywasm --test test-wast"
-test-wasm-custom="test --package tinywasm --test test-wasm-custom --release"
-cli="run -p tinywasm-cli --bin tinywasm --release --"
-doom="run --manifest-path ./examples/doom/Cargo.toml --release --"
+bench-suite = "bench -p bench --bench suite --"
+cli = "run -p tinywasm-cli --bin tinywasm --release --"
+coremark = "run --release -p bench -- coremark"
+doom = "run --manifest-path ./examples/doom/Cargo.toml --release --"
+test-wasm-1 = "test --package tinywasm --test test-wasm-1 --release"
+test-wasm-2 = "test --package tinywasm --test test-wasm-2 --release"
+test-wasm-3 = "test --package tinywasm --test test-wasm-3 --release"
+test-wasm-custom = "test --package tinywasm --test test-wasm-custom --release"
+test-wast = "test --package tinywasm --test test-wast"
+version-dev = "workspaces version --no-git-commit --force tinywasm*"
 
 [target.x86_64-unknown-linux-gnu]
-rustflags=["-C", "target-cpu=x86-64-v3"]
+rustflags = ["-C", "target-cpu=x86-64-v3"]

.github/workflows/test.yaml

@@ -12,42 +12,7 @@ permissions:
   contents: read
 
 jobs:
-  build-wasm:
-    name: Build wasm
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-        with:
-          submodules: true
-          persist-credentials: false
-      - name: Install Rust toolchain
-        uses: actions-rust-lang/setup-rust-toolchain@ecabd13d1c56bd1345c230e542e9144811ad706f # v2.0.0
-        with:
-          toolchain: nightly
-          components: rust-src
-          rustflags: ""
-          target: wasm32-unknown-unknown
-      - name: Install Binaryen
-        run: |
-          BINARYEN_VERSION=version_129
-          BINARYEN_DIR="binaryen-${BINARYEN_VERSION}"
-          BINARYEN_ARCHIVE="${BINARYEN_DIR}-x86_64-linux.tar.gz"
-          curl -L "https://github.com/WebAssembly/binaryen/releases/download/${BINARYEN_VERSION}/${BINARYEN_ARCHIVE}" -o "/tmp/${BINARYEN_ARCHIVE}"
-          echo "50b9fa62b9abea752da92ec57e0c555fee578760cd237c40107957715d2976ba  /tmp/${BINARYEN_ARCHIVE}" | sha256sum -c -
-          tar -xzf "/tmp/${BINARYEN_ARCHIVE}" -C /tmp
-          sudo install "/tmp/${BINARYEN_DIR}/bin/wasm-opt" /usr/local/bin/wasm-opt
-      - name: Install WABT
-        run: sudo apt-get install -y wabt
-      - name: Build wasm
-        run: ./examples/rust/build.sh
-      - name: Save artifacts
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
-        with:
-          name: wasm
-          path: examples/rust/out
-
   run-tests:
-    needs: build-wasm
     strategy:
       matrix:
         include:
@@ -102,12 +67,6 @@ jobs:
           components: rustfmt, clippy
         if: matrix.target == ''
 
-      - name: Load wasm
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
-        with:
-          name: wasm
-          path: examples/rust/out
-
       - name: Run tests
         run: cargo test --workspace ${{ matrix.args }} && cargo test --workspace ${{ matrix.args }} --examples
         if: matrix.target == ''

.gitignore

@@ -1,4 +1,5 @@
 /target
+/crates/bench/guest/target
 notes.md
 examples/*/out/*
 examples/*/target

CONTRIBUTING.md

@@ -23,7 +23,7 @@ cargo fmt --all -- --check
 cargo clippy --workspace
 cargo test --workspace
 cargo run --example basic
-cargo bench --bench tinywasm
+cargo bench-suite
 ```
 
 WebAssembly test commands:
@@ -38,18 +38,11 @@ cargo test-wast crates/tinywasm/tests/wasm-custom/table-basics.wast
 
 Set `RUST_LOG=debug` when running `cargo test-wast` to see executor debug logs.
 
-The `rust` example requires the `wasm32-unknown-unknown` target, the `rust-src` component, [Binaryen](https://github.com/WebAssembly/binaryen), and [WABT](https://github.com/WebAssembly/wabt):
-
-```bash
-./examples/rust/build.sh
-cargo run --example rust -- hello
-```
-
 You can use [samply](https://github.com/mstange/samply/) for profiling:
 
 ```bash
 cargo install --locked samply
-samply record -- cargo run --profile samply --example rust -- tinywasm
+samply record -- cargo bench-suite execute/nested_tinywasm
 ```
 
 Keep changes focused and external dependencies to a minimum. Update public documentation, the README, and the unreleased changelog when applicable.

Cargo.lock

@@ -45,32 +45,9 @@ unused_dependencies = "allow"  # false-positive on libm
 [workspace.lints.rust]
 unexpected_cfgs = { level = "warn", check-cfg = ["cfg(rust_analyzer)"] }
 
-[[example]]
-name = "rust"
-test = false
-
-[[bench]]
-harness = false
-name = "argon2id"
-
-[[bench]]
-harness = false
-name = "fibonacci"
-
-[[bench]]
-harness = false
-name = "tinywasm"
-
-[[bench]]
-harness = false
-name = "tinywasm_modes"
-
 [dev-dependencies]
 anyhow.workspace = true
-criterion.workspace = true
-pretty_env_logger.workspace = true
 tinywasm = { path = "crates/tinywasm", features = ["state"] }
-tinywasm-parser.workspace = true
 tinywasm-wasi.workspace = true
 wat.workspace = true
 

Cargo.toml

@@ -112,6 +112,10 @@ TinyWasm generally implements non-JavaScript core proposals at [phase 4](https:/
 🚧 -- in development/partially supported\
 🟢 -- fully supported
 
+## Benchmarks
+
+Tinywasm includes a small benchmark suite at [`crates/bench`](crates/bench) that runs a set of WebAssembly modules and measures execution time. For comparisons with other runtimes, check out the great [wasmi-benchmarks](https://github.com/wasmi-labs/wasmi-benchmarks) repository.
+
 ## See Also
 
 If you're looking for a WebAssembly runtime with JIT compilation, better performance or other advanced features, check out these other runtimes: