Files
wasm2go/internal/codegen/brtable_switch_test.go
c71ddafe1b Back shared linear memories with anonymous mappings, not the Go heap (#56)
* Back shared linear memories with anonymous mappings, not the Go heap

A shared memory is allocated at its declared ceiling LENGTH once
(agents deref the base pointer concurrently, so the array must never
move). On the Go heap that size is a trap: the FIRST make is lazily
paged, but a freed ceiling-sized span gets zeroed when the allocator
reuses it — so the second instance a process builds and discards
(e.g. the private builder engines behind the copy-on-write image
tiers) memclrs the whole ceiling. With llama's 8 GiB ceiling that
measured ~8 GB of dirty resident pages for memory nothing had
touched, on every process, regardless of model size; guests with
small ceilings (spidermonkey's 256 MiB) had the same behaviour hidden
under the noise floor.

Generated constructors for SHARED memories now call the sharedimage
runtime's AllocSharedMemory: anonymous, private, zero-fill-on-demand
pages outside the GC heap, fresh from the OS on every call, with a
finalizer on the module preserving the heap allocation's reclaim
semantics (a module kept reachable — say by a parked agent goroutine
— keeps its memory). Platforms without mmap keep the historical make.

The sharedimage aux files thereby become a compile-time dependency of
shared-memory output, which they were always documented to be: the
gcasm capture tree and the test snippet runners now include
Result.AuxFiles instead of silently dropping them.

Pinned by a fixture with a 1 GiB ceiling: the constructor must route
through AllocSharedMemory, and building + discarding three instances
must hold process RSS far under one ceiling.

Co-Authored-By: Claude Fable 5 <[email protected]>

* Add in-place image builders: the builder writes the image file directly

The image tiers built their template by booting a throwaway instance
on private memory, copying its linear memory into a heap buffer, and
writing that to the image file — the same bytes crossing memory up to
three times, and (before the off-heap change) the trigger for the
ceiling-zeroing regression. Elide all of it: NewSharedImageInPlace /
NewSharedSnapshotInPlace hand the builder a MAP_SHARED mapping of the
(sparse) image file, so every page the build touches is written once,
straight into the file's page cache, and IS the image. Building now
dirties exactly the touched pages, and they are file-backed — the
kernel can write them back and evict under pressure, which anonymous
pages cannot offer.

The data-segment kind keeps its contract (carry NOTHING above the
segments): the builder's BSS is punched back out of the file
(truncate down, re-extend sparse) before instances map it. The
builder's mapping stays valid until the module is unreachable, via
the same finalizer discipline as AllocSharedMemory.

Constructing a module ON caller memory needs the declared initial
size, so generated packages now export InitialMemoryBytes: what
NewWithMemory's memSize must be when the provided memory is fresh
zeros rather than an existing image.

Pinned by the sharedmem_ceiling fixture: a snapshot instance inherits
the builder's BSS write, a data-segment-image instance must not.

Co-Authored-By: Claude Fable 5 <[email protected]>

* Drop the dead make-expression path for shared memories

Review feedback on the constructor emission: the make() call
expression was built for every memory and then discarded whenever the
shared branch (AllocSharedMemory) or the caller-memory branch replaced
it, and the shared branch assigned a capArg nothing consumes. Select
the memory expression in one switch instead — each variant builds only
what it emits.

Co-Authored-By: Claude Fable 5 <[email protected]>

* Remove AllocSharedMemory: the in-place builders are the fix

Review feedback: with the image tiers built in place, no default path
allocates a discarded ceiling-length shared memory any more, and the
paths the anonymous-mmap constructor change still claimed to protect
do not hold up. The fallback engines exist precisely because mmap is
unavailable or failing — an mmap-based allocator cannot be their
safety net (its no-mmap variant was plain make anyway), and the
debugging escape hatch is not a production path to engineer for.
Embedders still building images through throwaway plain-constructor
engines migrate to the in-place builders when their bundles roll
forward.

Generated constructors go back to make for shared memories, the
capture tree no longer needs the aux files (nothing in generated
constructors references them; the snippet harnesses keep them because
embedder-level tests exercise the image API), and the off-heap
constructor test goes away with the machinery it pinned.

Co-Authored-By: Claude Fable 5 <[email protected]>

---------

Co-authored-by: Claude Fable 5 <[email protected]>
2026-08-27 10:53:10 +09:00

123 lines
3.6 KiB
Go

package codegen_test
import (
"bytes"
"context"
"fmt"
"regexp"
"strings"
"testing"
"github.com/tetratelabs/wazero"
"github.com/goccy/wasm2go/internal/codegen"
"github.com/goccy/wasm2go/internal/testfixture"
"github.com/goccy/wasm2go/internal/wasm"
)
// TestBrTableEmitsSwitch pins the pure-mode br_table emission to a Go
// switch STATEMENT. The Go compiler lowers dense integer switches to
// jump tables but never reconstructs a switch from an if-else
// cascade, so the old chain-of-equality-Ifs emission cost
// O(len(cases)) compares per dispatch (CPython's eval loop: a
// 255-deep chain). The control fixture's switch3 export is a 3-case
// br_table.
func TestBrTableEmitsSwitch(t *testing.T) {
bin := testfixture.Wasm(t, "control")
mod, err := wasm.Parse(bytes.NewReader(bin))
if err != nil {
t.Fatal(err)
}
var buf bytes.Buffer
res, err := codegen.Translate(&buf, mod, codegen.Options{Package: "ctl", OutputImportPath: "gentest/ctl"})
if err != nil {
t.Fatalf("translate: %v", err)
}
var sb strings.Builder
sb.Write(buf.Bytes())
for _, data := range res.AuxFiles {
sb.Write(data)
}
for _, data := range res.Files {
sb.Write(data)
}
src := sb.String()
// A switch with the three dispatch cases must exist...
swRe := regexp.MustCompile(`switch [^\n]+\{`)
if !swRe.MatchString(src) {
t.Fatalf("no switch statement emitted for the br_table dispatcher")
}
if !strings.Contains(src, "case 0:") || !strings.Contains(src, "case 1:") || !strings.Contains(src, "case 2:") {
t.Fatalf("switch missing dispatch case clauses:\n%s", clip(src))
}
if !strings.Contains(src, "default:") {
t.Fatalf("switch missing default clause")
}
}
func clip(s string) string {
if len(s) > 4000 {
return s[:4000] + "\n...[clipped]"
}
return s
}
// TestBrTable64RuntimePure diffs the pure-mode switch dispatch against
// wazero for every selector 0..70 (all 64 cases + a band of
// out-of-range values) plus the payload-carrying `pick` fallback.
func TestBrTable64RuntimePure(t *testing.T) {
bin := testfixture.Wasm(t, "cg_brtable64")
mod, err := wasm.Parse(bytes.NewReader(bin))
if err != nil {
t.Fatal(err)
}
ctx := context.Background()
r := wazero.NewRuntime(ctx)
t.Cleanup(func() {
if err := r.Close(ctx); err != nil {
t.Errorf("wazero close: %v", err)
}
})
wmod, err := r.Instantiate(ctx, bin)
if err != nil {
t.Fatalf("wazero instantiate: %v", err)
}
var mainSB strings.Builder
mainSB.WriteString("package main\n\nimport (\n\t\"fmt\"\n\t\"gentest/pkg\"\n)\n\nfunc main() {\n\tm := pkg.New()\n")
var want []string
for sel := int32(0); sel <= 70; sel++ {
o, err := wmod.ExportedFunction("switch64").Call(ctx, u32(sel))
if err != nil {
t.Fatalf("wazero switch64(%d): %v", sel, err)
}
want = append(want, fmt.Sprintf("%d", int32(o[0])))
fmt.Fprintf(&mainSB, "\tfmt.Println(m.Switch64(int32(%d)))\n", sel)
}
for _, sel := range []int32{0, 1, 2} {
o, err := wmod.ExportedFunction("pick").Call(ctx, u32(sel))
if err != nil {
t.Fatalf("wazero pick(%d): %v", sel, err)
}
want = append(want, fmt.Sprintf("%d", int32(o[0])))
fmt.Fprintf(&mainSB, "\tfmt.Println(m.Pick(int32(%d)))\n", sel)
}
mainSB.WriteString("}\n")
var buf bytes.Buffer
res, err := codegen.Translate(&buf, mod, codegen.Options{Package: "pkg", OutputImportPath: "gentest/pkg"})
if err != nil {
t.Fatalf("translate: %v", err)
}
out := strings.Fields(strings.TrimSpace(runGoSnippet(t, buf.String(), mainSB.String(), res.Sidecars, filesWithAux(res))))
if len(out) != len(want) {
t.Fatalf("got %d outputs, want %d", len(out), len(want))
}
for i := range want {
if out[i] != want[i] {
t.Fatalf("output %d: got %s want %s", i, out[i], want[i])
}
}
}