Running dart2wasm

You don't need to build the Dart SDK to run dart2wasm, as long as you have a Dart SDK installed and have the Dart SDK repository checked out. NB: the SDK must be checked out using depot tools and not just cloned from this repo.

To compile a Dart file to Wasm, in a checkout of the Dart SDK repository, run:

dart --enable-asserts pkg/dart2wasm/bin/dart2wasm.dart options infile.dart outfile.wasm

where options include:

OptionDefaultDescription
--dart-sdk=pathrelative to scriptThe location of the sdk directory inside the Dart SDK, containing the core library sources.
--platform=pathnoneThe location of the platform dill file containing the compiled core libraries.
--depfile=pathnoneWrite a Ninja depfile listing the input sources for the compilation.
--[no-]export-allnoExport all functions; otherwise, just export main.
--[no-]import-shared-memorynoImport a shared memory buffer. If this is on, --shared-memory-max-pages must also be specified.
--[no-]inliningnoInline small functions.
--[no-]name-sectionyesEmit Name Section with function names.
--[no-]polymorphic-specializationnoDo virtual calls by switching on the class ID instead of using call_indirect.
--[no-]print-kernelnoPrint IR for each function before compiling it.
--[no-]print-wasmnoPrint Wasm instructions of each compiled function.
--[no-]enable-assertsnoEnable assertions at runtime.
--shared-memory-max-pages pagecountMax size of the imported memory buffer. If --shared-import-memory is specified, this must also be specified.
--watch offsetPrint stack trace leading to the byte at offset offset in the .wasm output file. Can be specified multiple times.

The resulting .wasm file can be run with:

d8 --experimental-wasm-gc --experimental-wasm-stack-switching --experimental-wasm-type-reflection pkg/dart2wasm/bin/run_wasm.js -- outfile.wasm

Where d8 is the V8 developer shell.

Imports and exports

To import a function, declare it as a global, external function and mark it with a wasm:import pragma indicating the imported name (which must be two identifiers separated by a dot):

@pragma("wasm:import", "foo.bar")
external void fooBar(Object object);

which will call foo.bar on the host side:

var foo = {
    bar: function(object) { /* implementation here */ }
};

To export a function, mark it with a wasm:export pragma:

@pragma("wasm:export")
void foo(double x) { /* implementation here */  }

@pragma("wasm:export", "baz")
void bar(double x) { /* implementation here */  }

With the Wasm module instance in inst, these can be called as:

inst.exports.foo(1);
inst.exports.baz(2);

Types to use for interop

In the signatures of imported and exported functions, use the following types:

  • For numbers, use double.
  • For JS objects, use the WasmExternRef? type from the dart:wasm package, which translates to the Wasm externref type. These can be passed around and stored as opaque values on the Dart side.
  • For Dart objects, use the corresponding Dart type. This will be emitted as externref and automatically converted to and from the Dart type at the boundary.