summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-11-16 23:00:19 -0300
committerGabriel Schneider <[email protected]>2026-11-17 12:15:01 -0300
commit5b8cf6f66e367192090350c9129fa341edfc9343 (patch)
tree48a5e6229aca31c4a44473343d47fb7fcc63a32f /README.md
parent88c04dd6c392c6d8fc3a02408506e85d86f476d5 (diff)
downloadsketchbook-5b8cf6f66e367192090350c9129fa341edfc9343.tar.gz
sketchbook-5b8cf6f66e367192090350c9129fa341edfc9343.zip
Compute abi.hash's layout half once per abi change, not in every compile
The comptime walk over the shared types cost about half a second of every sketch library's compile. abi_hash.zig runs it at build time, once per change of the abi sources (watched like any input), and build.zig hands the number to host and sketches as the module abi_hash; abi.hash folds in the build as before. The value is the walk's own, computed for the build machine in Debug.
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/README.md b/README.md
index 8e4e430..3a4384a 100644
--- a/README.md
+++ b/README.md
@@ -873,15 +873,19 @@ renderer migration work and the optional addon boundary.
## The boundary
Host and sketch are built by the same `zig build`, so ordinary Zig types cross
-it (slices, tagged unions, `std.mem.Allocator`). `abi.hash`, a comptime hash
-of every shared type's layout and of the zig version, backend and optimize
+it (slices, tagged unions, `std.mem.Allocator`). `abi.hash`, a hash of
+every shared type's layout and of the zig version, backend and optimize
mode, guards against the real hazards: a host refuses a library built
against different definitions, or by another compiler or mode (`zig build
run` beside `zig build lib --watch -Doptimize=fast`: Zig's own calling
-convention differs between them), and says what differs. Everything that outlives
-a call lives in host memory, since host code is never unloaded. Only the
-recorded `Event` and the reflected `Layout` are `extern`, because they are
-written to disk.
+convention differs between them), and says what differs. The layout half
+costs half a second of comptime, so a small program (`src/abi_hash.zig`)
+computes it once per change of the abi sources, at build time, and host and
+sketches import the number; it is computed for the build machine in Debug,
+so a layout change seen only by another target or mode is not caught.
+Everything that outlives a call lives in host memory, since host code is
+never unloaded. Only the recorded `Event` and the reflected `Layout` are
+`extern`, because they are written to disk.
`zig build test` in this directory runs the unit tests, a headless reload
through `dlopen`, where a counter sketch changes its layout mid-run and keeps