wasm-bindgen-rayon 1.0.3

Adapter for using Rayon-based concurrency on the Web
docs.rs failed to build wasm-bindgen-rayon-1.0.3
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build: wasm-bindgen-rayon-1.0.2

wasm-bindgen-rayon is an adapter for enabling Rayon-based concurrency on the Web with WebAssembly (via wasm-bindgen, Web Workers and SharedArrayBuffer support).

Usage

WebAssembly thread support is not yet a first-class citizen in Rust, so there are a few things to keep in mind when using this crate. Bear with me :)

For a quick demo, check out https://rreverser.com/wasm-bindgen-rayon-demo/.

Setting up

First of all, add this crate as a dependency to your Cargo.toml (in addition to wasm-bindgen and rayon themselves):

[dependencies]
wasm-bindgen = "0.2"
rayon = "1.5"
wasm-bindgen-rayon = "1.0"

Then, reexport the init_thread_pool function:

pub use wasm_bindgen_rayon::init_thread_pool;

// ...

This will expose an async initThreadPool function in the final generated JavaScript for your library.

You'll need to invoke it right after instantiating your module on the main thread in order to prepare the threadpool before calling into actual library functions:

import init, { initThreadPool, /* ... */ } from './pkg/index.js';

// Regular wasm-bindgen initialization.
await init();

// Thread pool initialization with the given number of threads
// (pass `navigator.hardwareConcurrency` if you want to use all cores).
await initThreadPool(navigator.hardwareConcurrency);

// ...now you can invoke any exported functions as you normally would

Using Rayon

Use Rayon iterators as you normally would, e.g.

#[wasm_bindgen]
pub fn sum(numbers: &[i32]) -> i32 {
    numbers.par_iter().sum()
}

will accept an Int32Array from JavaScript side and calculate the sum of its values using all available threads.

Building Rust code

First limitation to note is that you'll have to use wasm-bindgen/wasm-pack's web target (--target web).

This is because the Wasm code needs to take its own object (the WebAssembly.Module) and share it with other threads when spawning them. This object is only accessible from the --target web and --target no-modules outputs, but we further restrict it to only --target web as we also use JS snippets feature.

The other issue is that the Rust standard library for the WebAssembly target is built without threads support to ensure maximum portability.

Since we do want standard APIs like Mutex, Arc and so on to work, you'll need to use the nightly compiler toolchain and pass some flags to rebuild the standard library in addition to your own code.

In order to reduce risk of breakages, it's strongly recommended to use a fixed nightly version. For example, the latest stable Rust at the moment of writing is version 1.50, which corresponds to nightly-2021-02-11, which was tested and works with this crate.

Using config files

The easiest way to configure those flags is:

  1. Put a string nightly-2021-02-11 in a rust-toolchain file in your project directory. This tells Rustup to use nightly toolchain by default for your project.

  2. Put the following in a .cargo/config file in your project directory:

    [target.wasm32-unknown-unknown]
    rustflags = ["-C", "target-feature=+atomics,+bulk-memory"]
    
    [unstable]
    build-std = ["panic_abort", "std"]
    

    This tells Cargo to rebuild the standard library with support for Wasm atomics.

Then, run wasm-pack as you normally would with --target web:

$ wasm-pack build --target web [...normal wasm-pack params...]

Using command-line params

If you prefer not to configure those parameters by default, you can pass them as part of the build command itself.

In that case, the whole command looks like this:

RUSTFLAGS='-C target-feature=+atomics,+bulk-memory' \
	rustup run nightly-2021-02-11 \
	wasm-pack build --target web [...] \
	-- -Z build-std=panic_abort,std

It looks a bit scary, but it takes care of everything - choosing the nightly toolchain, enabling the required features as well as telling Cargo to rebuild the standard library. You only need to copy it once and hopefully forget about it :)

Feature detection

Not all browsers support WebAssembly threads yet, so you'll likely want to make two builds - one with threads support and one without - and use feature detection to choose the right one on the JavaScript side.

You can use wasm-feature-detect library for this purpose. The code will look roughly like this:

import { threads } from 'wasm-feature-detect';

let wasmPkg;

if (await threads()) {
	wasmPkg = await import('./pkg-with-threads/index.js');
	await wasmPkg.default();
	await wasmPkg.initThreadPool(navigator.hardwareConcurrency);
} else {
	wasmPkg = await import('./pkg-without-threads/index.js');
	await wasmPkg.default();
}

wasmPkg.nowCallAnyExportedFuncs();

Usage with various bundlers

WebAssembly threads use Web Workers under the hood for instantiating other threads with the same WebAssembly module & memory.

wasm-bindgen-rayon provides the required JS code for those Workers internally, and uses a syntax that is recognised across various bundlers.

Usage with Webpack

If you're using Webpack v5 (version >= 5.25.1), you don't need to do anything special, as it already supports bundling Workers out of the box.

Usage with Rollup

For Rollup, you'll need @surma/rollup-plugin-off-main-thread plugin (version >= 2.1.0) which brings the same functionality and was tested with this crate.

Usage with Parcel

[Coming soon...] Parcel v2 also recognises the used syntax, but it's still in development and there are some minor issues to fix before it can be used with this crate.

Usage without bundlers

The default JS glue was designed in a way that works great with bundlers and code-splitting, but, sadly, not yet in browsers due to different treatment of import paths (see WICG/import-maps#244 which might help unify those in the future).

If you want to build this library for usage without bundlers, enable the no-bundler feature for wasm-bindgen-rayon in your Cargo.toml:

wasm-bindgen-rayon = { version = "1.0", features = ["no-bundler"] }

Note that, in addition to the earlier mentioned restrictions, this will work only in browsers with support for Module Workers (when using bundlers, those are bundled to regular Workers automatically).

Final caveats

In order to use SharedArrayBuffer on the Web, you need to enable cross-origin isolation policies. Check out the linked article for details.

Also check out caveats listed in the wasm-bindgen threading docs. While this library specifically targets Rayon and automatically provides the necessary shims for you, some of the caveats still apply.

Most notably, even when you're using threads, the main thread still can't be blocked while waiting for the Rayon pool to get ready or for all the calculations to finish. You need to instantiate the main JS+Wasm in a dedicated Worker to avoid blocking the UI altogether.

License

This crate is licensed under the Apache-2.0 license.