@assemblyscript/rtrace
TypeScript icon, indicating that this package has built-in type declarations

0.27.24 • Public • Published

AssemblyScript Rtrace

A tiny utility to sanitize the AssemblyScript runtime. Records allocations and frees performed by the runtime and emits an error if something is off. Also checks for leaks.

Instructions

Compile your module that uses the full or half runtime with -use ASC_RTRACE=1 --exportStart _initialize and include an instance of this module as the import named rtrace.

const rtrace = new Rtrace({
  onerror(err, info) {
    // handle error
  },
  oninfo(msg) {
    // print message, optional
  },
  getMemory() {
    // obtain the module's memory,
    // e.g. using --exportStart:
    return instance.exports.memory;
  }
});

const { module, instance } = await WebAssembly.instantiate(...,
  rtrace.install({
    ...imports...
  })
);
instance.exports._initialize();
...

if (rtrace.active) {
  let leakCount = rtr.check();
  if (leakCount) {
    // handle error
  }
}

Note that references in globals which are not cleared before collection is performed appear as leaks, including their inner members. A TypedArray would leak itself and its backing ArrayBuffer in this case for example. This is perfectly normal and clearing all globals avoids this.

Package Sidebar

Install

npm i @assemblyscript/rtrace

Weekly Downloads

34

Version

0.27.24

License

Apache-2.0

Unpacked Size

28.3 kB

Total Files

8

Last publish

Collaborators

  • assemblyscript