Files
bd85549918 wasm2go: a WebAssembly-to-Go ahead-of-time transpiler (#1)
* wasm2go: a WebAssembly-to-Go ahead-of-time transpiler

wasm2go translates a WebAssembly binary into standalone Go source. The
generated package runs the module natively — no interpreter and no
embedded wasm runtime — so it builds and links like ordinary Go code.
This makes it practical to ship a wasm-compiled library (for example a
large C/C++ codebase built with the WASI SDK) inside a Go program
without the startup and memory cost of a wasm engine.

Components:

- internal/wasm — the WebAssembly binary parser.
- internal/codegen — translates a parsed module into Go source through
  the SSA lowering + optimization + emission pipeline.
- internal/ssa — a lightweight SSA IR plus optimization passes
  (const-propagation, DCE, CSE, branch folding, memory promotion).
- transpile — the public library API: Parse, Translate, and the
  Transpile one-shot convenience wrapper.
- cmd/wasm2go — the command-line interface.
- internal/testfixture — shared helper that compiles testdata/*.wat
  to wasm on demand via wat2wasm.

Library API (Options):

- Required: Package, OutputImportPath.
- Optional: BulkExportPrefix (per-export Inv_<svc>_<mt> dispatch for
  modules with uniformly-named exports), EntryExports (narrow DCE
  root set), KeepDeadFuncs (disable DCE for diff/debug),
  PromotionReportPath (write SSA memory-promotion JSON).

Everything else is auto-derived from the input: the SSA pipeline runs
unconditionally; data segments emit as //go:embed sidecars; wasi
imports translate to Go-native syscalls; modules whose total
function-body bytes exceed an internal threshold are emitted as a
chain of //go:linkname-split sub-packages so the Go compiler stays
inside a bounded per-package memory budget.

WASI runtime: full wasi_snapshot_preview1 coverage. Args/environ,
clocks, fd_*, path_* (open/create_directory/unlink_file/
remove_directory/rename/filestat_get/filestat_set_times/link/
symlink/readlink), readdir, pread/pwrite, sync/datasync, poll_oneoff
(clock + fd-event branches), sched_yield, random_get, proc_exit,
proc_raise, sock_accept/recv/send/shutdown — every call routes to the
Go stdlib or golang.org/x/sys/unix equivalent. Per-platform companion
files (unix/linux/darwin/windows) carry the bits that differ across
OSes; the translated module is a normal Go program with the host's
ordinary filesystem and network reach.

Release engineering for the public repository:

- GitHub Actions CI: build, vet, race-enabled tests behind an 85%
  coverage gate, golangci-lint — all driven through make targets.
- Release workflow runs GoReleaser on version tags, including
  deb/rpm/apk packages, with build-provenance attestations recorded
  for every release asset.
- A release-test workflow runs `make release/check` (GoReleaser
  config validation + a publish-free dry-run build) on every PR and
  main push so a broken release is caught before tag time.
- golangci-lint and goreleaser are pinned in tools/go.mod and run
  via `go tool`, so local and CI invocations use the same versions.
- `make install/wat2wasm` provisions the wat2wasm CLI the test suite
  needs, dispatching to the host's package manager (Homebrew on
  macOS, apt/dnf/pacman/apk on Linux).
- Makefile targets for local development.

Test coverage is 85.2% of statements overall.

* README: document the WASI runtime, performance, and library entry points

- Add a "WASI support" subsection explaining the single-file,
  stdlib-only `wasi_snapshot_preview1` implementation and the
  resulting cross-platform reach.
- Add a "Performance" section with the wazero-vs-wasm2go corpus
  numbers (cold start 8.4×, short queries up to 81×, TPC-H scans
  within ±10%).

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>

* ci: align release-test with release.yml — use stable Go

The release-test workflow exercises the same `make release/check`
dry-run that the publish job runs at tag time, so it should pull
the same toolchain. Switch it from `go-version-file: tools/go.mod`
to `go-version: stable` to match release.yml.

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>

---------

Co-authored-by: Claude Opus 4.7 (1M context) <[email protected]>
2026-05-24 13:34:54 +09:00

105 lines
2.9 KiB
Go

package pass
import (
"testing"
"github.com/goccy/wasm2go/internal/ssa"
)
// TestBranchFold_ConstTrue: an `if (1)` keeps the then-branch, drops the
// else-branch, and leaves the now-unreachable else block removed.
func TestBranchFold_ConstTrue(t *testing.T) {
b := ssa.NewFuncBuilder("bf", ssa.FuncSig{Results: []ssa.Type{ssa.TypeI32}})
entry := b.NewBlock(ssa.BlockIf)
thenB := b.NewBlock(ssa.BlockRet)
elseB := b.NewBlock(ssa.BlockRet)
b.SetEntry(entry)
b.SetCurrent(entry)
cond := b.Const32(1)
entry.Control = cond
ssa.AddEdge(entry, thenB) // Succs[0] = then
ssa.AddEdge(entry, elseB) // Succs[1] = else
b.SetCurrent(thenB)
b.FinishRet(b.Const32(10))
b.SetCurrent(elseB)
b.FinishRet(b.Const32(20))
f := b.Func()
if !BranchFold(f) {
t.Fatal("BranchFold reported no change for if(1)")
}
if entry.Kind != ssa.BlockPlain {
t.Errorf("entry kind = %v, want BlockPlain", entry.Kind)
}
if entry.Control != nil {
t.Errorf("entry.Control not cleared")
}
if len(entry.Succs) != 1 || entry.Succs[0].Block != thenB {
t.Errorf("entry should jump only to the then-block")
}
for _, blk := range f.Blocks {
if blk == elseB {
t.Errorf("unreachable else block was not removed")
}
}
if err := ssa.Verify(f); err != nil {
t.Errorf("verify after BranchFold: %v", err)
}
}
// TestBranchFold_ConstFalse_PhiFixup: an `if (0)` into a merge block must
// drop the taken-from-then phi argument so the merge's phi still has one
// argument per surviving predecessor.
func TestBranchFold_ConstFalse_PhiFixup(t *testing.T) {
b := ssa.NewFuncBuilder("bf2", ssa.FuncSig{
Params: []ssa.Type{ssa.TypeI32}, Results: []ssa.Type{ssa.TypeI32},
})
entry := b.NewBlock(ssa.BlockIf)
thenB := b.NewBlock(ssa.BlockPlain)
elseB := b.NewBlock(ssa.BlockPlain)
merge := b.NewBlock(ssa.BlockRet)
b.SetEntry(entry)
b.SetCurrent(entry)
p0 := b.Param(0, ssa.TypeI32)
cond := b.Const32(0) // false → else taken
entry.Control = cond
ssa.AddEdge(entry, thenB)
ssa.AddEdge(entry, elseB)
b.SetCurrent(thenB)
tv := b.Const32(1) // value flowing from the then-branch
ssa.AddEdge(thenB, merge) // merge.Preds[0] = then
b.SetCurrent(elseB)
ssa.AddEdge(elseB, merge) // merge.Preds[1] = else
b.SetCurrent(merge)
phi := b.NewValue(ssa.OpPhi, ssa.TypeI32, tv, p0) // phi(then, else)
b.FinishRet(phi)
f := b.Func()
if !BranchFold(f) {
t.Fatal("BranchFold reported no change for if(0)")
}
if entry.Kind != ssa.BlockPlain || len(entry.Succs) != 1 || entry.Succs[0].Block != elseB {
t.Errorf("entry should jump only to the else-block")
}
for _, blk := range f.Blocks {
if blk == thenB {
t.Errorf("unreachable then block was not removed")
}
}
if len(merge.Preds) != 1 {
t.Fatalf("merge.Preds = %d, want 1", len(merge.Preds))
}
if len(phi.Args) != 1 || phi.Args[0] != p0 {
t.Errorf("phi not fixed up: args=%d want [p0]", len(phi.Args))
}
if err := ssa.Verify(f); err != nil {
t.Errorf("verify after BranchFold: %v", err)
}
}