49 releases

new 0.2.99 Dec 7, 2024
0.2.97 Nov 30, 2024
0.2.92 Mar 4, 2024
0.2.89 Nov 27, 2023
0.2.55 Nov 19, 2019

#1526 in WebAssembly

Download history 36168/week @ 2024-08-17 33701/week @ 2024-08-24 32678/week @ 2024-08-31 32835/week @ 2024-09-07 33068/week @ 2024-09-14 31145/week @ 2024-09-21 36385/week @ 2024-09-28 32812/week @ 2024-10-05 35725/week @ 2024-10-12 36784/week @ 2024-10-19 33920/week @ 2024-10-26 32024/week @ 2024-11-02 35986/week @ 2024-11-09 39551/week @ 2024-11-16 29908/week @ 2024-11-23 34227/week @ 2024-11-30

144,480 downloads per month
Used in 38 crates (via wasm-bindgen-cli-support)

MIT/Apache

26KB
410 lines

The wasm-bindgen multi-value transformation.

This crate provides a transformation to turn exported functions that use a return pointer into exported functions that use multi-value.

Consider the following function:

#[no_mangle]
pub extern "C" fn pair(a: u32, b: u32) -> [u32; 2] {
    [a, b]
}

LLVM will by default compile this down into the following Wasm:

(func $pair (param i32 i32 i32)
  local.get 0
  local.get 2
  i32.store offset=4
  local.get 0
  local.get 1
  i32.store)

What's happening here is that the function is not directly returning the pair at all, but instead the first i32 parameter is a pointer to some scratch space, and the return value is written into the scratch space. LLVM does this because it doesn't yet have support for multi-value Wasm, and so it only knows how to return a single value at a time.

Ideally, with multi-value, what we would like instead is this:

(func $pair (param i32 i32) (result i32 i32)
  local.get 0
  local.get 1)

However, that's not what this transformation does at the moment. This transformation is a little simpler than mutating existing functions to produce a multi-value result, instead it introduces new functions that wrap the original function and translate the return pointer to multi-value results in this wrapper function.

With our running example, we end up with this:

;; The original function.
(func $pair (param i32 i32 i32)
  local.get 0
  local.get 2
  i32.store offset=4
  local.get 0
  local.get 1
  i32.store)

(func $pairWrapper (param i32 i32) (result i32 i32)
  ;; Our return pointer that points to the scratch space we are allocating
  ;; on the stack for calling `$pair`.
  (local i32)

  ;; Allocate space on the stack for the result.
  global.get $stackPointer
  i32.const 8
  i32.sub
  local.tee 2
  global.set $stackPointer

  ;; Call `$pair` with our allocated stack space for its results.
  local.get 2
  local.get 0
  local.get 1
  call $pair

  ;; Copy the return values from the stack to the Wasm stack.
  local.get 2
  i32.load
  local.get 2 offset=4
  i32.load

  ;; Finally, restore the stack pointer.
  local.get 2
  i32.const 8
  i32.add
  global.set $stackPointer)

This $pairWrapper function is what we actually end up exporting instead of $pair.

Dependencies

~5MB
~113K SLoC