mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
55 lines
1.9 KiB
Markdown
55 lines
1.9 KiB
Markdown
|
# WebAssembly / WASI port of Ruby
|
||
|
|
|
||
|
|
## How to cross-build
|
||
|
|
|
||
|
|
### Requirement
|
||
|
|
|
||
|
|
- Ruby (the same version as the building target version) (baseruby)
|
||
|
|
- GNU make
|
||
|
|
- [WASI SDK](https://github.com/WebAssembly/wasi-sdk) 14.0 or later
|
||
|
|
- [Binaryen](https://github.com/WebAssembly/binaryen) **version 91**
|
||
|
|
- See also: https://github.com/WebAssembly/binaryen/issues/4401
|
||
|
|
- Linux or macOS build machine
|
||
|
|
|
||
|
|
### Steps
|
||
|
|
|
||
|
|
1. Download a prebuilt WASI SDK package from [WASI SDK release page](https://github.com/WebAssembly/wasi-sdk/releases).
|
||
|
|
2. Set `WASI_SDK_PATH` environment variable to the root directory of the WASI SDK package.
|
||
|
|
```console
|
||
|
|
$ export WASI_SDK_PATH=/path/to/wasi-sdk-X.Y
|
||
|
|
```
|
||
|
|
3. Download a prebuilt binaryen from [Binaryen release page](https://github.com/WebAssembly/binaryen/releases)
|
||
|
|
4. Set PATH environment variable to lookup binaryen tools
|
||
|
|
```console
|
||
|
|
$ export PATH=path/to/binaryen:$PATH
|
||
|
|
```
|
||
|
|
5. Configure
|
||
|
|
- You can select which extensions you want to build.
|
||
|
|
- If you got `Out of bounds memory access` while running the produced ruby, you may need to increase the maximum size of stack.
|
||
|
|
```console
|
||
|
|
$ ./configure LDFLAGS="-Xlinker -zstack-size=16777216" \
|
||
|
|
--host wasm32-unknown-wasi \
|
||
|
|
--with-destdir=./ruby-wasm32-wasi \
|
||
|
|
--with-static-linked-ext \
|
||
|
|
--with-ext=ripper,monitor
|
||
|
|
```
|
||
|
|
|
||
|
|
6. Make
|
||
|
|
```console
|
||
|
|
$ make install
|
||
|
|
```
|
||
|
|
|
||
|
|
Now you have a WASI compatible ruby binary. You can run it by any WebAssembly runtime like [`wasmtime`](https://github.com/bytecodealliance/wasmtime), [`wasmer`](https://github.com/wasmerio/wasmer), [Node.js](https://nodejs.org/api/wasi.html), or browser with [WASI polyfill](https://www.npmjs.com/package/@wasmer/wasi).
|
||
|
|
|
||
|
|
Note: it may take a long time (~20 sec) for the first time for JIT compilation
|
||
|
|
|
||
|
|
```
|
||
|
|
$ wasmtime ruby-wasm32-wasi/usr/local/bin/ruby --mapdir /::./ruby-wasm32-wasi/ -- -e 'puts RUBY_PLATFORM'
|
||
|
|
wasm32-wasi
|
||
|
|
```
|
||
|
|
|
||
|
|
## Current Limitation
|
||
|
|
|
||
|
|
- No `Thread` support for now.
|
||
|
|
- Spawning a new process is not supported. e.g. `Kernel.spawn` and `Kernel.system`
|