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 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
//! A multithreading library for Rust and WebAssembly. //! //! `wasm-mt` helps you create and execute Web Worker based threads. You can program the threads simply using Rust closures and orchestrate them with `async/await`. //! //! #### Examples //! //! - **`wasm-mt-pool`** - Thread pool library based on `wasm-mt`. [ [crate](https://crates.io/crates/wasm-mt-pool) | [source](https://github.com/w3reality/wasm-mt/tree/master/crates/pool) ] //! //! You can run all the following apps in browser! //! //! - **exec** - How to use <code>wasm_mt</code>. [ [live](https://w3reality.github.io/wasm-mt/examples/exec/index.html) | [source](https://github.com/w3reality/wasm-mt/tree/master/examples/exec) ] //! - **fib** - Computing a Fibonacci sequence with nested threads. [ [live](https://w3reality.github.io/wasm-mt/examples/fib/index.html) | [source](https://github.com/w3reality/wasm-mt/tree/master/examples/fib) ] //! - **executors** - Minimal serial/parallel executors using <code>wasm_mt</code>. [ [live](https://w3reality.github.io/wasm-mt/examples/executors/index.html) | [source](https://github.com/w3reality/wasm-mt/tree/master/examples/executors) ] //! - **parallel** - Julia set benchmark of serial/parallel executors. [ [live](https://w3reality.github.io/wasm-mt/examples/parallel/index.html) | [source](https://github.com/w3reality/wasm-mt/tree/master/examples/parallel) ] //! - **arraybuffers** - Demo of using <code>WasmMt::new_with_arraybuffers()</code>. [ [live](https://w3reality.github.io/wasm-mt/examples/arraybuffers/index.html) | [source](https://github.com/w3reality/wasm-mt/tree/master/examples/arraybuffers) ] //! //! #### Background and implementation //! //! The preceding seminal work entitled ["Multithreading Rust and Wasm"](https://rustwasm.github.io/2018/10/24/multithreading-rust-and-wasm.html) by [@alexcrichton](https://github.com/alexcrichton) centers on [*Web Workers*](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API), *shared memory*, and [the WebAssembly threads proposal](https://github.com/WebAssembly/threads/blob/master/proposals/threads/Overview.md). Shared memory is built on top of [`SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) whose [availability across major browsers](https://caniuse.com/#feat=sharedarraybuffer) has been somewhat limited. Also, the rust-wasm thread implementation work, along with the threads proposal, seems still in progress. //! //! On the contrary, Web Worker based multithreading in JavaScript has been [well supported for a long time](https://caniuse.com/#feat=webworkers). After experimenting, we have come up to a Rust ergonomic multithreading solution that does not require `SharedArrayBuffer`. It just works across all major browsers today and we named it `wasm-mt`. //! //! Internally, we use the [`postMessage()`](https://developer.mozilla.org/en-US/docs/Web/API/Worker/postMessage) Web Worker API (through bindings provided by [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen)) to initialize spawned threads. And, importantly, we keep using `postMessage()` for dynamically sending Rust closures (serialized by [`serde_traitobject`](https://github.com/alecmocatta/serde_traitobject)) to the spawned threads. By doing so, the parent thread can `await` the results of the closures executed in the spawned thread. We have found that this approach is highly flexible for extension, too. For example, it is straightforward to augment `WasmMt::Thread` to support more customized inter-thread communication patterns. //! //! Note, however, that `wasm-mt` has some remarkable limitations compared to the ongoing shared memory based multithreading work led by `wasm-bindgen`. `wasm-mt` is not efficient in that it does **not include** support of the standard thread primitive operations: //! //! - shared memory based message passing and mutexes, //! - atomic instructions and efficient memory handling per [the threads proposal](https://github.com/WebAssembly/threads/blob/master/proposals/threads/Overview.md). //! //! #### Thanks //! //! - [wasm-bindgen](https://github.com/rustwasm/wasm-bindgen) developers //! - [@alecmocatta](https://github.com/alecmocatta) for the [serde_traitobject](https://github.com/alecmocatta/serde_traitobject) crate //! - [swc-project](https://github.com/swc-project) that facilitates the [wasm-mt-test](https://github.com/w3reality/wasm-mt/tree/master/crates/test) crate //! //! # Getting started //! //! Requirements: //! //! - rustc (nightly) //! - [`wasm-pack build`](https://github.com/rustwasm/wasm-pack#%EF%B8%8F-commands) with the [`--target no-modules`](https://rustwasm.github.io/docs/wasm-bindgen/reference/deployment.html#without-a-bundler) option //! //! Cargo.toml: //! //! ```toml //! wasm-mt = "0.1" //! serde = { version = "1.0", features = ["derive"] } //! serde_closure = "0.2" //! ``` //! //! # Creating a thread //! //! First, create a [`WasmMt`] thread builder with [`new`][WasmMt::new] and initialize it: //! //! ```rust //! use wasm_mt::prelude::*; //! //! let pkg_js = "./pkg/exec.js"; // path to `wasm-bindgen`'s JS binding //! let mt = WasmMt::new(pkg_js).and_init().await.unwrap(); //! ``` //! //! Then, create a [`wasm_mt::Thread`][Thread] with the [`thread`][WasmMt::thread] function and initialize it: //! //! ```rust //! let th = mt.thread().and_init().await.unwrap(); //! ``` //! //! # Executing a thread //! //! Using the [`exec!`] macro, you can execute a closure in the thread and `await` the result: //! //! ```rust //! // fn add(a: i32, b: i32) -> i32 { a + b } //! //! let a = 1; //! let b = 2; //! let ans = exec!(th, move || { //! let c = add(a, b); //! //! Ok(JsValue::from(c)) //! }).await?; //! assert_eq!(ans, JsValue::from(3)); //! ``` //! //! You can also execute an [async closure] with `exec!`: //! //! ```rust //! // use wasm_mt::utils::sleep; //! // async fn sub(a: i32, b: i32) -> i32 { //! // sleep(1000).await; //! // a - b //! // } //! //! let a = 1; //! let b = 2; //! let ans = exec!(th, async move || { //! let c = sub(a, b).await; //! //! Ok(JsValue::from(c)) //! }).await?; //! assert_eq!(ans, JsValue::from(-1)); //! ``` //! //! # Executing JavaScript in a thread //! //! Using the [`exec_js!`] macro, you can execute JavaScript within a thread: //! //! ```rust //! let ans = exec_js!(th, " //! const add = (a, b) => a + b; //! return add(1, 2); //! ").await?; //! assert_eq!(ans, JsValue::from(3)); //! ``` //! //! Similarly, use [`exec_js_async!`] for running asynchronous JavaScript: //! //! ```rust //! let ans = exec_js_async!(th, " //! const sub = (a, b) => new Promise(resolve => { //! setTimeout(() => resolve(a - b), 1000); //! }); //! return await sub(1, 2); //! ").await?; //! assert_eq!(ans, JsValue::from(-1)); //! ``` //! //! # Making executors //! //! By using [`wasm_mt:Thread`][Thread], you can easily create custom executors. One such example is the [`wasm-mt-pool` crate](https://crates.io/crates/wasm-mt-pool). It provides a [thread pool](https://doc.rust-lang.org/book/ch20-02-multithreaded.html#improving-throughput-with-a-thread-pool) that is based on the [work stealing] scheduling strategy. //! //! Here, for simplicity, we show the implementation of much more straightforward executors: a serial executor and a parallel executor. //! //! First, prepare a `Vec<wasm_mt::Thread>` containing initialized threads: //! //! ```rust //! let mut v: Vec<wasm_mt::Thread> = vec![]; //! for i in 0..4 { //! let th = mt.thread().and_init().await?; //! v.push(th); //! } //! ``` //! //! Then, here's the executors in action. Note, in the latter case, we are using [`wasm_bindgen_futures::spawn_local`](https://rustwasm.github.io/wasm-bindgen/api/wasm_bindgen_futures/fn.spawn_local.html) to dispatch the threads in parallel. //! //! ```rust //! console_ln!("🚀 serial executor:"); //! for th in &v { //! console_ln!("starting a thread"); //! let ans = exec!(th, move || Ok(JsValue::from(42))).await?; //! console_ln!("ans: {:?}", ans); //! } //! //! console_ln!("🚀 parallel executor:"); //! for th in v { //! spawn_local(async move { //! console_ln!("starting a thread"); //! let ans = exec!(th, move || Ok(JsValue::from(42))).await.unwrap(); //! console_ln!("ans: {:?}", ans); //! }); //! } //! ``` //! //! Observe the starting/ending timing of each thread in the developer console: //! //! ```text //! 🚀 serial executor: //! starting a thread //! ans: JsValue(42) //! starting a thread //! ans: JsValue(42) //! starting a thread //! ans: JsValue(42) //! starting a thread //! ans: JsValue(42) //! 🚀 parallel executor: //! (4) starting a thread //! (4) ans: JsValue(42) //! ``` //! //! [async closure]: https://github.com/rust-lang/rfcs/blob/master/text/2394-async_await.md#async--closures //! [work stealing]: https://en.wikipedia.org/wiki/Work_stealing #![feature(trait_alias)] #![feature(async_closure)] use wasm_bindgen::prelude::*; use js_sys::{ArrayBuffer, Object, Reflect}; use std::cell::RefCell; pub mod prelude; pub mod utils; mod job; mod atw; mod worker; mod thread; pub use job::{MtClosure, MtAsyncClosure}; pub use thread::Thread; #[macro_export] macro_rules! console_ln { ( $( $x:expr ),* ) => (web_sys::console::log_1(&format!( $( $x ),* ).into())); } #[macro_export] macro_rules! debug_ln { ( $( $x:expr ),* ) => { if cfg!(debug_assertions) { let mut ln = String::from("👀 "); ln.push_str(&format!( $( $x ),* )); web_sys::console::log_1(&ln.into()); } }; } #[macro_export] macro_rules! exec { ($th:expr, async $clos:expr) => (($th).exec_async(FnOnce!(async $clos))); ($th:expr, $clos:expr) => (($th).exec(FnOnce!($clos))); } #[macro_export] macro_rules! exec_js { ($th:expr, $str:expr) => (($th).exec_js($str)); } #[macro_export] macro_rules! exec_js_async { ($th:expr, $str:expr) => (($th).exec_js_async($str)); } pub struct WasmMt { pkg_js_uri: Option<String>, ab_init: RefCell<Option<ArrayBuffer>>, ab_wasm: RefCell<Option<ArrayBuffer>>, is_initialized: RefCell<bool>, } impl WasmMt { pub fn new(pkg_js_uri: &str) -> Self { debug_ln!("pkg_js_uri: {}", pkg_js_uri); Self { pkg_js_uri: Some(String::from(pkg_js_uri)), ab_init: RefCell::new(None), ab_wasm: RefCell::new(None), is_initialized: RefCell::new(false), } } pub fn new_with_arraybuffers(ab_js: ArrayBuffer, ab_wasm: ArrayBuffer) -> Self { let ab_init = Self::ab_init_from(&utils::text_from_ab(&ab_js).unwrap()); Self { pkg_js_uri: None, ab_init: RefCell::new(Some(ab_init)), ab_wasm: RefCell::new(Some(ab_wasm)), is_initialized: RefCell::new(false), } } pub fn set_ab_init(&self, ab: ArrayBuffer) { self.ab_init.replace(Some(ab)); } pub fn set_ab_wasm(&self, ab: ArrayBuffer) { self.ab_wasm.replace(Some(ab)); } pub async fn init(&self) -> Result<&Self, JsValue> { assert!(!*self.is_initialized.borrow()); self.is_initialized.replace(true); if let Some(ref pkg_js_uri) = self.pkg_js_uri { let pkg_wasm_uri = if pkg_js_uri.ends_with("wasm-bindgen-test") { // We defer updating `self.ab_init` in this 'test' context format!("{}_bg.wasm", pkg_js_uri) } else { self.set_ab_init(Self::create_ab_init(pkg_js_uri).await?); pkg_js_uri.replace(".js", "_bg.wasm") }; if !pkg_wasm_uri.ends_with("_bg.wasm") { wasm_bindgen::throw_str("failed to resolve `pkg_wasm_uri`"); } self.set_ab_wasm(utils::fetch_as_arraybuffer(&pkg_wasm_uri).await?); } else { debug_ln!("init(): `pkg_js_uri` is `None`; should be using `new_with_arraybuffers()`"); assert!(self.ab_init.borrow().is_some()); assert!(self.ab_wasm.borrow().is_some()); } Ok(self) } pub async fn and_init(self) -> Result<Self, JsValue> { self.init().await?; Ok(self) } pub fn thread(&self) -> Thread { assert!(*self.is_initialized.borrow()); // https://rustwasm.github.io/wasm-bindgen/api/js_sys/struct.ArrayBuffer.html#method.slice Thread::new( self.ab_init.borrow().as_ref().unwrap().slice(0), self.ab_wasm.borrow().as_ref().unwrap().slice(0)) } fn ab_init_from(pkg_js: &str) -> ArrayBuffer { let mut init_js = String::new(); init_js.push_str("return () => { "); init_js.push_str(&pkg_js); init_js.push_str(" return wasm_bindgen; };"); utils::ab_from_text(&init_js) } async fn create_ab_init(pkg_js_uri: &str) -> Result<ArrayBuffer, JsValue> { let pkg_js = utils::fetch_as_text(pkg_js_uri).await?; Ok(Self::ab_init_from(&pkg_js)) } } fn encode_task_msg(name: &str, data: Option<&JsValue>) -> Object { let msg = Object::new(); Reflect::set(msg.as_ref(), &JsValue::from("task"), &JsValue::from(name)).unwrap(); if let Some(jsv) = data { Reflect::set(msg.as_ref(), &JsValue::from("data"), jsv).unwrap(); } msg } fn decode_task_msg(msg: &JsValue) -> (String, JsValue) { let name = Reflect::get(msg, &JsValue::from("task")) .unwrap_throw().as_string().unwrap_throw(); let jsv = Reflect::get(msg, &JsValue::from("data")) .unwrap_throw(); (name, jsv) }