-
Notifications
You must be signed in to change notification settings - Fork 85
docs: add exception handling toolchain compatibility guide #310
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
shubham5080
wants to merge
4
commits into
WasmEdge:main
Choose a base branch
from
shubham5080:docs/exception-handling
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+60
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
d2a7b4c
docs: add exception handling toolchain compatibility guide
shubham5080 7135b5a
docs: list toolchain versions in EH compatibility table
shubham5080 a2e805e
docs: move EH example into WasmEdge Book page
shubham5080 f070383
docs: drop unverified wasi-sdk row from EH table
shubham5080 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| sidebar_position: 6 | ||
| --- | ||
|
|
||
| # Exception Handling | ||
|
|
||
| WasmEdge implements the [latest exception-handling proposal](https://github.com/WebAssembly/exception-handling) (post Oct 2023). Legacy EH instructions such as `delegate` are rejected at load time. | ||
|
|
||
| Enable the proposal when running or compiling: | ||
|
|
||
| ```bash | ||
| wasmedge --enable-exception-handling module.wasm | ||
| wasmedge compile --enable-exception-handling module.wasm module.aot.wasm | ||
| ``` | ||
|
|
||
| ## Toolchain compatibility | ||
|
|
||
| | Toolchain | Version | Compatible | Notes | | ||
| |-----------|---------|------------|-------| | ||
| | WasmEdge (runtime) | 0.17.x | Yes | Latest EH proposal; use `--enable-exception-handling` | | ||
| | Emscripten (`-fwasm-exceptions`) | 3.1.64, 6.0.0 | No | Emits legacy EH (e.g. opcode `0x117` / `delegate`) | | ||
| | `wasm-3.0-exceptions` spec tests | wasmedge-spectest | Yes | Official test inputs used by WasmEdge CI | | ||
|
|
||
| WasmEdge does not plan to support legacy EH. Use modules built for the current proposal only. | ||
|
|
||
| ## How WasmEdge tests EH | ||
|
|
||
| CI runs the `wasm-3.0-exceptions` suite from [wasmedge-spectest](https://github.com/WasmEdge/wasmedge-spectest). See `test/spec/CMakeLists.txt` in the [WasmEdge](https://github.com/WasmEdge/WasmEdge) repository. | ||
|
|
||
| To run a spec test locally after building tests, or fetch a `.wasm` from that repository: | ||
|
|
||
| ```bash | ||
| wasmedge --enable-exception-handling path/to/test.wasm | ||
| ``` | ||
|
|
||
| ## Emscripten repro (expected failure today) | ||
|
|
||
| `a.cpp`: | ||
|
|
||
| ```cpp | ||
| #include <stdio.h> | ||
|
|
||
| int main() { | ||
| try { | ||
| puts("throw..."); | ||
| throw 1; | ||
| puts("(never reached)"); | ||
| } catch (...) { | ||
| puts("catch!"); | ||
| } | ||
| return 0; | ||
| } | ||
| ``` | ||
|
|
||
| ```bash | ||
| emcc -O1 -fwasm-exceptions -sSTANDALONE_WASM a.cpp -o a.wasm | ||
| wasmedge --enable-exception-handling a.wasm | ||
| ``` | ||
|
|
||
| Typical error: `loading failed: illegal opcode, Code: 0x117` (`Deprecated delegate instruction`). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just want to confirm: is there currently no toolchain supporting the final EH proposal?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hydai Based on what we verified for this page:
-fwasm-exceptionsstill emit legacy EH (e.g.delegate/ opcode0x117) and fail to load on WasmEdge 0.17.x.wasm-3.0-exceptionssuite in wasmedge-spectest, not via a C/C++ toolchain.So for the toolchains listed here: we have not verified a public C/C++ toolchain that emits the final EH proposal and runs successfully on WasmEdge.
There may be opt-in flags (e.g. Emscripten
-sWASM_LEGACY_EXCEPTIONS=0, or wasi-sdk with-mllvm -wasm-use-legacy-eh=false) that emit the final proposal, but those were not tested in this PR. Happy to add a short “not verified / opt-in flags may exist” note if you prefer, or to test a specific toolchain/version you recommend.