Skip to content

docs: Add LLVM pass-params optimization documentation #126

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.

Sign up for GitHub

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

Closed
promptless wants to merge 1 commit into from
Closed

docs: Add LLVM pass-params optimization documentation #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion pages/runtime/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,10 @@ Options:

Only available for the LLVM compiler.

--enable-pass-params-opt
Only available for the LLVM compiler. Enable the "pass-params" optimization, where the first (#0)
global and the first (#0) memory passed between guest functions as explicit parameters.

--enable-simd
Enable support for the SIMD proposal

Expand Down Expand Up @@ -277,4 +281,4 @@ Options:

-h, --help
Print help (see a summary with '-h')
```
```
12 changes: 7 additions & 5 deletions pages/runtime/features.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Each of this backends support different features, and have different support for
### Wasmer features
- **Caching**: compiled WebAssembly modules can be reused so subsequent runs of a Wasm file will have very little start up time;
- **Metering**: computation time and other resources can be monitored and limits set to control how the Wasm code runs. This is also known as "gas metering";
- **LLVM Pass-Params Optimization**: an LLVM-specific optimization that passes the first global (#0) and the first memory (#0) as explicit parameters between guest functions, which can significantly improve performance for certain workloads by reducing pointer dereferencing overhead;

## Support of features by backend

Expand All @@ -54,10 +55,11 @@ WebAssembly features:

Wasmer features:

| Features | Singlepass | Cranelift | LLVM | V8 | Wasmi | JavascriptCore | Browser |
| -------- | ---------- | --------- | ---- | -- | ----- | -------------- | ------- |
| Caching | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
| Metering | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
| Features | Singlepass | Cranelift | LLVM | V8 | Wasmi | JavascriptCore | Browser |
| -------------------------- | ---------- | --------- | ---- | -- | ----- | -------------- | ------- |
| Caching | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
| Metering | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
| Pass-Params Optimization | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ |


## Backend support by Operating System
Expand All @@ -82,4 +84,4 @@ Wasmer features:
| V8 | ✅ | ✅ | ✅ | ✅ |
| Wasmi | ✅ | ✅ | ✅ | ✅ |
| JavascriptCore | ✅ | ✅ | ✅ | ❌ |
| Browser | ✅ | ✅ | ✅ | ✅ |
| Browser | ✅ | ✅ | ✅ | ✅ |