Categorygate.computer/wag
modulepackage
0.36.0
Repository: https://github.com/gate-computer/wag.git
Documentation: pkg.go.dev

# README

Wag is a WebAssembly compiler implemented as a Go package.

Features

  • The input is a wasm binary module.

  • The output is machine code.

  • It is only a compiler. A runtime environment for the compiled program, including all import functions, needs to be implemented separately. Wag has been developed for the Gate runtime.

  • Single-pass, fast ahead-of-time compilation. Early functions can be executed while the latter functions are still being compiled, even while the source is still being downloaded.

  • The generated code requires minimal runtime support; it's designed to be executed in an isolated environment. Calling standard library ABIs is not directly supported.

  • Supports snapshot-and-restore across compiler versions and CPU architectures.

  • Supports breakpoint debugging via recompilation.

  • Cross-compilation is supported via Go build tags. If wagamd64 is specified, the x86-64 code generator is used regardless of host architecture, and CPU feature detection is disabled with pessimistic assumptions. Likewise for wagarm64 (but feature detection is not currently used for ARM64 in any case).

Status

  • Supports WebAssembly version 1 (wasm32). No wasm extensions are supported.

  • Supports x86-64 and ARM64 code generation.

  • Generated x86-64 code requires SSE4.1 floating-point instructions (available since 2007).

Security

Spectre variant 1: Out-of-bounds linear memory access detection requires that addressable but unallocated memory is inaccessible. It naturally prevents conditional branch exploitation.

Spectre variant 2: On x86-64, Retpoline is used to protect the runtime environment (although user programs shouldn't be able to inject arbitrary addresses into the branch target buffer).

Testing

Requires Linux, Make, Go, Python, Capstone, and a recent version of WABT. The applicable parts of the WebAssembly spec testsuite are run. Code execution tests are implemented in a separate Go module in the testsuite subdirectory (to work around circular dependencies). All tests can be run by checking out Git submodules and running make check.

# Packages

Package binary implements WebAssembly integer decoding.
Package binding contains import and export utilities.
Package buffer implements compile.CodeBuffer and compile.DataBuffer.
Package compile implements a WebAssembly compiler.
Package errors exports common error types without unnecessary dependencies.
Package object contains ObjectMapper implementations.
Package section contains binary stream manipulation utilities.
Package trap enumerates trap identifiers.
Package wa contains miscellaneous WebAssembly-related things.

# Functions

Compile a WebAssembly binary module into machine code.
No description provided by the author

# Structs

Config for a single compiler invocation.
Object code with debug information.