Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swiftwasm/WasmKit
WebAssembly Runtime written in Swift
https://github.com/swiftwasm/WasmKit
swift swiftwasm webassembly webassembly-runtime
Last synced: about 2 months ago
JSON representation
WebAssembly Runtime written in Swift
- Host: GitHub
- URL: https://github.com/swiftwasm/WasmKit
- Owner: swiftwasm
- License: mit
- Created: 2017-07-20T15:57:49.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-08-04T16:39:38.000Z (5 months ago)
- Last Synced: 2024-08-06T00:17:26.634Z (5 months ago)
- Topics: swift, swiftwasm, webassembly, webassembly-runtime
- Language: Swift
- Homepage: https://swiftpackageindex.com/swiftwasm/WasmKit/main/documentation/wasmkit
- Size: 1.14 MB
- Stars: 141
- Watchers: 8
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WasmKit
**WasmKit** is a standalone and embeddable WebAssembly runtime implementation written in Swift.
## Usage
The best way to learn how to use WasmKit is to look at the [Examples](./Examples) directory.
### Command Line Tool
WasmKit provides a command line tool to run WebAssembly binaries compliant with WASI.
```sh
$ git clone https://github.com/swiftwasm/WasmKit.git
$ cd WasmKit
$ swift run wasmkit-cli run ./Examples/wasm/hello.wasm
Hello, World!
```
### As a Library
#### Swift Package Manager
You can use WasmKit as a [Swift Package Manager](https://www.swift.org/documentation/package-manager/) dependency by adding the following to your `Package.swift` file:
```swift
dependencies: [
.package(url: "https://github.com/swiftwasm/WasmKit.git", from: "0.1.0"),
],
```
You can find API documentation on the [Swift Package Index](https://swiftpackageindex.com/swiftwasm/WasmKit/main/documentation/wasmkit).
## Features
- [Reasonably fast](./Documentation/RegisterMachine.md#performance-evaluation)
- Minimal dependencies
- The core runtime engine depends only on [swift-system](https://github.com/apple/swift-system).
- No Foundation dependency
- Compact and embeddable
- Debug build complete in 5 seconds[^1]
- Batteries included
- WASI support, WAT parser, etc.
## Supported Platforms
WasmKit engine works on all major platforms supported by Swift. It is continuously tested on macOS, Ubuntu, and Windows,
and should work on the following platforms:
- macOS 10.13+, iOS 12.0+, tvOS 12.0+, watchOS 6.0+
- Ubuntu 20.04+
- Windows 10+
## Implementation Status
| Category | Feature | Status |
|----------|---------|--------|
| WebAssembly MVP | Parsing binary format | ✅ Implemented |
| | Parsing text format (WAT) | ✅ Implemented |
| | Execution | ✅ Implemented |
| | Validation | ✅ Implemented |
| WebAssembly Proposal | [Reference types](https://github.com/WebAssembly/reference-types/blob/master/proposals/reference-types/Overview.md) | ✅ Implemented |
| | [Bulk memory operations](https://github.com/WebAssembly/bulk-memory-operations/blob/master/proposals/bulk-memory-operations/Overview.md) | ✅ Implemented |
| | [Mutable globals](https://github.com/WebAssembly/mutable-global/blob/master/proposals/mutable-global/Overview.md) | ✅ Implemented |
| | [Sign-extension operators](https://github.com/WebAssembly/spec/blob/master/proposals/sign-extension-ops/Overview.md) | ✅ Implemented |
| | [Non-trapping float-to-int conversions](https://github.com/WebAssembly/nontrapping-float-to-int-conversions/blob/main/proposals/nontrapping-float-to-int-conversion/Overview.md) | ✅ Implemented |
| | [Memory64](https://github.com/WebAssembly/memory64/blob/main/proposals/memory64/Overview.md) | ✅ Implemented |
| | [Threads and atomics](https://github.com/WebAssembly/threads/blob/master/proposals/threads/Overview.md) | 🚧 Parser implemented |
| WASI | WASI Preview 1 | ✅ Implemented |
## Minimum Supported Swift Version
The minimum supported Swift version of WasmKit is 5.8, which is the version used to bootstrap the Swift toolchain in [ci.swift.org](https://ci.swift.org/).
## Testing
To run the WasmKit test suite, you need to checkout the test suite repositories first.
```sh
# Checkout test suite repositories
$ ./Vendor/checkout-dependency
# Run tests
$ swift test
```
## Acknowledgement
This project was originally developed by [@akkyie](https://github.com/akkyie), and is now maintained by the community.
[^1]: On a 2020 Mac mini (M1, 16GB RAM) with Swift 5.10. Measured by `swift package resolve && swift package clean && time swift build --product PrintAdd`.