wasmi 1.0.0

WebAssembly interpreter
Documentation 
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


| Continuous Integration |     Test Coverage    |  Documentation   |      Crates.io       |
|:----------------------:|:--------------------:|:----------------:|:--------------------:|
| [![ci][1]][2]          | [![codecov][3]][4]   | [![docs][5]][6] | [![crates][7]][8]  |

[1]: https://github.com/wasmi-labs/wasmi/actions/workflows/rust.yml/badge.svg
[2]: https://github.com/wasmi-labs/wasmi/actions/workflows/rust.yml
[3]: https://codecov.io/gh/wasmi-labs/wasmi/branch/main/badge.svg
[4]: https://codecov.io/gh/wasmi-labs/wasmi/branch/main
[5]: https://docs.rs/wasmi/badge.svg
[6]: https://docs.rs/wasmi
[7]: https://img.shields.io/crates/v/wasmi.svg
[8]: https://crates.io/crates/wasmi

[license-mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license-apache-badge]: https://img.shields.io/badge/license-APACHE-orange.svg

# Wasmi - WebAssembly (Wasm) Interpreter

<p align="center">
  <img src="./resources/wasmi-logo.png" width="100" height="100">
</p>

Wasmi is an efficient and lightweight WebAssembly interpreter with a focus on constrained and embedded systems.

## Distinct Features

- Simple, correct and deterministic execution of WebAssembly.
- Efficient and cross-platform WebAssembly runtime for [`no_std` embedded environments](https://doc.rust-lang.org/stable/rustc/platform-support.html).
- Compiler/JIT bomb resisting translation.
- Loosely mirrors the [Wasmtime API](https://docs.rs/wasmtime/) to act as drop-in replacement.
- 100% WebAssembly spec testsuite compliance.
- Built-in support for fuel metering.
- Supports the official [Wasm C-API](https://github.com/WebAssembly/wasm-c-api).

## Security Audits

Wasmi is suitable for safety critical use cases and has been audited twice.

| Wasmi Version(s) | Auditor | Contractor | Report |
|--:|:--|:--|:--|
| `0.36.0`-`0.38.0` | [Runtime Verification Inc.] | [Stellar Development Foundation] | [PDF](./resources/audit-2024-11-27.pdf) |
| `0.31.0` | [SRLabs] | [Parity Technologies] | [PDF](./resources/audit-2023-12-20.pdf) |

[Wasmtime]: https://github.com/bytecodealliance/wasmtime
[SRLabs]: https://www.srlabs.de/
[Runtime Verification Inc.]: https://runtimeverification.com/
[Stellar Development Foundation]: https://stellar.org/foundation
[Parity Technologies]: https://www.parity.io/

## Docs

- 📖 [Usage Guide](./docs/usage.md): learn how to use the [Wasmi API](https://crates.io/crates/wasmi) properly.
- 🛠️ [Development Guide](./docs/developement.md): learn how to develop for Wasmi.
- ✨ [Crate Features](https://docs.rs/wasmi/latest/wasmi/#crate-features): learn about `wasmi` crate features.

## WebAssembly Features

| | WebAssembly Proposal | | | | WebAssembly Proposal | |
|:-:|:--|:--|:-:|:--|:--|:--|
| ✅ | [`mutable-global`] | ≥ `0.14.0` | | ✅ | [`custom-page-sizes`] | [≥ `0.41.0`][(#1197)] |
| ✅ | [`saturating-float-to-int`] | ≥ `0.14.0` | | ✅ | [`memory64`] | [≥ `0.41.0`][(#1357)] |
| ✅ | [`sign-extension`] | ≥ `0.14.0` | | ✅ | [`wide-arithmetic`] | [≥ `0.42.0`][(#1369)] |
| ✅ | [`multi-value`] | ≥ `0.14.0` | | ✅ | [`simd`] | [≥ `0.43.0`][(#1364)] |
| ✅ | [`bulk-memory`] | [≥ `0.24.0`][(#628)] | | ✅ | [`relaxed-simd`] | [≥ `0.44.0`][(#1443)] |
| ✅ | [`reference-types`] | [≥ `0.24.0`][(#635)] | | 📅 | [`function-references`] | [Tracking Issue][(#774)] |
| ✅ | [`tail-calls`] | [≥ `0.28.0`][(#683)] | | 📅 | [`gc`] | [Tracking Issue][(#775)] |
| ✅ | [`extended-const`] | [≥ `0.29.0`][(#707)] | | 📅 | [`threads`] | [Tracking Issue][(#777)] |
| ✅ | [`multi-memory`] | [≥ `0.37.0`][(#1191)] | | 📅 | [`exception-handling`] | [Tracking Issue][(#1037)] |

| | Embeddings | |
|:-:|:--|:--|
| ✅ | [WASI] | WASI (`wasip1`) support via the [`wasmi_wasi` crate]. |
| ✅ | [C-API] | Official Wasm C-API support via the [`wasmi_c_api_impl` crate]. |

[`mutable-global`]: https://github.com/WebAssembly/mutable-global
[`saturating-float-to-int`]: https://github.com/WebAssembly/nontrapping-float-to-int-conversions
[`sign-extension`]: https://github.com/WebAssembly/sign-extension-ops
[`multi-value`]: https://github.com/WebAssembly/multi-value
[`reference-types`]: https://github.com/WebAssembly/reference-types
[`bulk-memory`]: https://github.com/WebAssembly/bulk-memory-operations
[`simd` ]: https://github.com/webassembly/simd
[`tail-calls`]: https://github.com/WebAssembly/tail-call
[`extended-const`]: https://github.com/WebAssembly/extended-const
[`function-references`]: https://github.com/WebAssembly/function-references
[`gc`]: https://github.com/WebAssembly/gc
[`multi-memory`]: https://github.com/WebAssembly/multi-memory
[`threads`]: https://github.com/WebAssembly/threads
[`relaxed-simd`]: https://github.com/WebAssembly/relaxed-simd
[`exception-handling`]: https://github.com/WebAssembly/exception-handling
[`custom-page-sizes`]: https://github.com/WebAssembly/custom-page-sizes
[`memory64`]: https://github.com/WebAssembly/memory64
[`wide-arithmetic`]: https://github.com/WebAssembly/wide-arithmetic

[WASI]: https://github.com/WebAssembly/WASI
[C-API]: https://github.com/WebAssembly/wasm-c-api
[`wasmi_wasi` crate]: ./crates/wasi
[`wasmi_c_api_impl` crate]: ./crates/c_api

[(#363)]: https://github.com/wasmi-labs/wasmi/issues/363
[(#364)]: https://github.com/wasmi-labs/wasmi/issues/364
[(#496)]: https://github.com/wasmi-labs/wasmi/issues/496
[(#628)]: https://github.com/wasmi-labs/wasmi/pull/628
[(#635)]: https://github.com/wasmi-labs/wasmi/pull/635
[(#638)]: https://github.com/wasmi-labs/wasmi/pull/638
[(#683)]: https://github.com/wasmi-labs/wasmi/pull/683
[(#707)]: https://github.com/wasmi-labs/wasmi/pull/707
[(#774)]: https://github.com/wasmi-labs/wasmi/pull/774
[(#775)]: https://github.com/wasmi-labs/wasmi/pull/775
[(#776)]: https://github.com/wasmi-labs/wasmi/pull/776
[(#777)]: https://github.com/wasmi-labs/wasmi/pull/777
[(#1037)]: https://github.com/wasmi-labs/wasmi/issues/1137
[(#1197)]: https://github.com/wasmi-labs/wasmi/issues/1197
[(#1191)]: https://github.com/wasmi-labs/wasmi/issues/1191
[(#1357)]: https://github.com/wasmi-labs/wasmi/issues/1357
[(#1364)]: https://github.com/wasmi-labs/wasmi/issues/1364
[(#1369)]: https://github.com/wasmi-labs/wasmi/issues/1369
[(#1443)]: https://github.com/wasmi-labs/wasmi/pull/1443

## Used by

If you want your project on this list [please inform me](mailto:robin.freyler@gmail.com) about you project and how Wasmi is used.

<a href="https://stellar.org/soroban">
  <picture>
    <source srcset="./resources/logos/users/soroban-white.svg" media="(prefers-color-scheme: dark)">
    <source srcset="./resources/logos/users/soroban-black.svg" media="(prefers-color-scheme: light)">
    <img
      src="./resources/logos/users/soroban-black.svg"
      height="32"
      style="vertical-align: middle;"
      alt="Stellar Soroban"
    />
  </picture>
</a>&nbsp;
<a href="https://wasmer.io">
  <img
    src="./resources/logos/users/wasmer.svg"
    height="32" style="vertical-align: middle;" alt="Wasmer"
  />
</a>&nbsp;
<a href="https://fireflyzero.com">
  <img
    src="./resources/logos/users/firefly-zero.png"
    height="32" style="vertical-align: middle;" alt="Firefly Zero"
  />
</a>&nbsp;
<a href="https://typst.app">
  <img
    src="./resources/logos/users/typst.png"
    height="32" style="vertical-align: middle;" alt="Typst"
  />
</a>&nbsp;
<a href="https://orbitinghail.dev">
  <picture>
    <source srcset="./resources/logos/users/orbitinghail-white.png" media="(prefers-color-scheme: dark)">
    <source srcset="./resources/logos/users/orbitinghail-black.png" media="(prefers-color-scheme: light)">
    <img
      src="./resources/logos/users/orbitinghail-black.svg"
      height="32"
      style="vertical-align: middle;"
      alt="Orbitinghail"
    />
  </picture>
</a>&nbsp;
<a href="https://github.com/smol-dot/smoldot">
  <img
    src="./resources/logos/users/smoldot.png"
    height="32" style="vertical-align: middle;" alt="Smoldot"
  />
</a>&nbsp;
<a href="https://github.com/Askannz/munal-os">
  <img
    src="./resources/logos/users/munal-os.png"
    height="32" style="vertical-align: middle;" alt="Munal OS"
  />
</a>&nbsp;
<a href="https://github.com/unicode-org/icu4x">
  <img
    src="./resources/logos/users/icu4x.png"
    height="32" style="vertical-align: middle;" alt="icu4x"
  />
</a>&nbsp;
<a href="https://github.com/Uni-Gal/Ayaka">
  <img
    src="./resources/logos/users/ayaka.png"
    height="32" style="vertical-align: middle;" alt="Ayaka"
  />
</a>&nbsp;
<a href="https://github.com/project-oak/oak">
  <picture>
    <source srcset="./resources/logos/users/project-oak-dark.svg" media="(prefers-color-scheme: dark)">
    <source srcset="./resources/logos/users/project-oak-light.svg" media="(prefers-color-scheme: light)">
    <img
      src="./resources/logos/users/project-oak-light.svg"
      height="32"
      style="vertical-align: middle;"
      alt="Project Oak"
    />
  </picture>
</a>&nbsp;

## Sponsors

Special thanks to the past and present sponsors of the Wasmi project.

<table>
  <tr>
    <td align="center" style="padding: 10px; width: 200px;">
      <div style="height: 50px; display: flex; flex-direction: column; justify-content: flex-end;">
        <a href="https://stellar.org/foundation">
          <picture>
            <source srcset="./resources/logos/sponsors/sdf-white.svg" media="(prefers-color-scheme: dark)">
            <source srcset="./resources/logos/sponsors/sdf-black.svg" media="(prefers-color-scheme: light)">
            <img
              src="./resources/logos/sponsors/sdf-black.svg"
              height="64"
              alt="Stellar Development Foundation"
              style="display: inline-block"
            />
          </picture>
        </a>
      </div>
      <div><sub>Sponsoring since Oct. 2024</sub></div>
    </td>
    <td align="center" style="padding: 10px; width: 200px;">
      <div style="height: 50px; display: flex; flex-direction: column; justify-content: flex-end;">
        <a href="https://parity.io">
          <img
            src="./resources/logos/sponsors/parity.svg"
            height="32"
            alt="Parity Technologies"
          />
        </a>
      </div>
      <div><sub>Sponsored until Oct. 2024</sub></div>
    </td>
  </tr>
</table>

## License

Licensed under either of

  * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
  * MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.