Skip to content

a JS module for creating orthogonally persistent WebAssembly instances

License

Notifications You must be signed in to change notification settings

dfinity-side-projects/wasm-persist

Repository files navigation

SYNOPSIS

NPM Package Build Status Coverage Status

js-standard-style

This allows you to hibernate a WebAssembly instance and later start it up again at the exact place you left off.

INSTALL

npm install wasm-persist

USAGE

const persist = require('wasm-persist')
...
wasm = persist.prepare(wasm)
const {instance} = await WebAssembly.instantiate(wasm)
// call some exported functions on your instance
// then when you are done
const state = persist.hibernate(instance)

...

// later you can revive the wasm instance
const {instance} = await WebAssembly.instantiate(wasm)
// just call persist.resume with the old state
persist.resume(instance, state)

DESCRIPTION

The Idea for wasm-persist came from orthogonal persistence. wasm-persist injects getter and setter function for each global and exports the memory and table if they exist. Hibernate calls the getters and creates an Object that contains the memory (as a typedArray), the globals, and the function table. Resume does the opposite and calls the setters for the globals and updates the memory and the table. Foreign functions on the table are not handled currently.

API

./docs/

LICENSE

MPL-2.0

About

a JS module for creating orthogonally persistent WebAssembly instances

Resources

License

Stars

Watchers

Forks

Packages

No packages published