Files
sx/build.zig
agra dcb1392255 comptime VM: strict no-fallback mode — the interp-retirement enumeration gate (Phase 4)
Add -Dcomptime-flat-strict / env SX_COMPTIME_FLAT_STRICT (implies comptime_flat):
at all three comptime sites (type-fn in lower/comptime.zig, const-init + #run in
emit_llvm.zig) a VM bail becomes a build-gating error naming the reason INSTEAD of
falling back to legacy. Forces every comptime eval onto the VM so the complete gap
set is enumerable in one sweep; when the corpus is green under strict mode AND every
example matches legacy, interp.zig can be deleted.

Default behaviour unchanged (699/0 both default gates). Fixed a wiring bug: the
type-fn site's local comptime_flat didn't include the strict flag (every type-fn
falsely reported <unknown>); strict now implies flat there too.

Swept the gap list (19 strict bails): switch_br (5, + unmasks a []Type-across-call
silent-wrong in 0114), compiler_call (6, = the BuildOptions->abi(.zig) extern
compiler migration), out (2), type_name (1), global_addr (1), interp_print_frames
(1), 2 negative-test diagnostics (1179/1180), 1 dlsym (1654). Recorded as the
deletion checklist in CHECKPOINT-COMPILER-API.md.
2026-06-18 19:06:51 +03:00

281 lines
13 KiB
Zig

const std = @import("std");
const builtin = @import("builtin");
const math = @import("math");
pub fn build(b: *std.Build) void {
const target = b.standardTargetOptions(.{});
const optimize = b.standardOptimizeOption(.{});
const static_llvm = b.option(bool, "static-llvm", "Statically link LLVM (self-contained binary, no LLVM needed at runtime)") orelse false;
const llvm_prefix = b.option([]const u8, "llvm-prefix", "Path to LLVM installation") orelse "/opt/homebrew/opt/llvm@22";
const include_dir = b.fmt("{s}/include", .{llvm_prefix});
const lib_dir = b.fmt("{s}/lib", .{llvm_prefix});
const llvm_config = b.fmt("{s}/bin/llvm-config", .{llvm_prefix});
const mod = b.addModule("sx", .{
.root_source_file = b.path("src/root.zig"),
.target = target,
.optimize = optimize,
});
mod.addSystemIncludePath(.{ .cwd_relative = include_dir });
mod.addSystemIncludePath(.{ .cwd_relative = "." }); // for clang_shim.h
mod.addLibraryPath(.{ .cwd_relative = lib_dir });
mod.link_libc = true;
mod.addCSourceFile(.{
.file = b.path("llvm_shim.c"),
.flags = &.{b.fmt("-I{s}", .{include_dir})},
});
// FFI step 2.16c runtime — `_Thread_local`-backed JNIEnv* slot.
// Linked into sx-the-compiler so the JIT process-symbol generator
// can resolve `sx_jni_env_tl_get` / `sx_jni_env_tl_set` without the
// user importing the runtime module. AOT outputs pick up the same
// .c file via lower-side auto-injected c_import.
mod.addCSourceFile(.{
.file = b.path("library/vendors/sx_jni_runtime/sx_jni_env_tl.c"),
.flags = &.{},
});
// ERR E3.1 runtime — `_Thread_local` error return-trace ring buffer.
// Same linkage rationale as the JNIEnv* slot above: linked into the
// compiler so the JIT resolves `sx_trace_*` via dlsym; AOT outputs pick it
// up via a lower-side auto-injected c_import (gated on needs_trace_runtime).
mod.addCSourceFile(.{
.file = b.path("library/vendors/sx_trace_runtime/sx_trace.c"),
.flags = &.{},
});
mod.addCSourceFile(.{
.file = b.path("clang_shim.cpp"),
.flags = &.{
b.fmt("-I{s}", .{include_dir}),
"-std=c++17",
"-fno-rtti",
"-fno-exceptions",
"-D__STDC_CONSTANT_MACROS",
"-D__STDC_FORMAT_MACROS",
"-D__STDC_LIMIT_MACROS",
b.fmt("-DSX_LLVM_PREFIX=\"{s}\"", .{llvm_prefix}),
},
});
const target_os = target.result.os.tag;
if (static_llvm) {
if (target_os == .windows) {
// Windows target: enumerate LLVM .lib files in prefix.
// Use the host-appropriate command to list files.
const libs_raw = if (builtin.os.tag == .windows) blk: {
const dir_cmd = b.fmt("dir /b {s}\\lib\\LLVM*.lib", .{llvm_prefix});
break :blk std.mem.trim(u8, b.run(&.{ "cmd.exe", "/c", dir_cmd }), " \t\n\r");
} else blk: {
break :blk std.mem.trim(u8, b.run(&.{ "ls", lib_dir }), " \t\n\r");
};
var libs_it = std.mem.tokenizeAny(u8, libs_raw, "\r\n");
while (libs_it.next()) |filename| {
const trimmed = std.mem.trim(u8, filename, " \t");
if (std.mem.endsWith(u8, trimmed, ".lib") and std.mem.startsWith(u8, trimmed, "LLVM")) {
mod.linkSystemLibrary(
trimmed[0 .. trimmed.len - 4],
.{ .preferred_link_mode = .static },
);
}
}
// Windows system libraries LLVM depends on
const win_syslibs = [_][]const u8{
"advapi32", "shell32", "ole32", "uuid",
"psapi", "version", "ntdll", "ws2_32",
"dbghelp", "msvcprt",
};
for (&win_syslibs) |syslib| {
mod.linkSystemLibrary(syslib, .{});
}
} else {
// Unix target: query llvm-config for the static libraries needed
const libs_raw = std.mem.trim(u8, b.run(&.{ llvm_config, "--libs", "--link-static" }), " \t\n\r");
var libs_it = std.mem.tokenizeAny(u8, libs_raw, " \t\n\r");
while (libs_it.next()) |flag| {
if (flag.len > 2 and std.mem.startsWith(u8, flag, "-l")) {
mod.linkSystemLibrary(flag[2..], .{ .preferred_link_mode = .static });
}
}
// Clang static libraries (for clang_shim: header parsing + C compilation)
const clang_libs_raw = std.mem.trim(u8, b.run(&.{ "sh", "-c", b.fmt("ls {s}/lib/libclang*.a | xargs -n1 basename | sed 's/^lib//;s/\\.a$//'", .{llvm_prefix}) }), " \t\n\r");
var clang_libs_it = std.mem.tokenizeAny(u8, clang_libs_raw, "\n");
while (clang_libs_it.next()) |lib_name| {
const trimmed = std.mem.trim(u8, lib_name, " \t\r");
if (trimmed.len > 0) {
mod.linkSystemLibrary(trimmed, .{ .preferred_link_mode = .static });
}
}
// System libraries LLVM depends on — link statically where possible.
// Add homebrew lib paths for static archives.
if (builtin.os.tag == .macos) {
const homebrew_static_paths = [_][]const u8{
"/opt/homebrew/opt/zlib/lib",
"/opt/homebrew/opt/zstd/lib",
"/opt/homebrew/opt/ncurses/lib",
};
for (&homebrew_static_paths) |p| {
mod.addLibraryPath(.{ .cwd_relative = p });
}
}
const syslibs_raw = std.mem.trim(u8, b.run(&.{ llvm_config, "--system-libs", "--link-static" }), " \t\n\r");
var syslibs_it = std.mem.tokenizeAny(u8, syslibs_raw, " \t\n\r");
while (syslibs_it.next()) |flag| {
if (flag.len > 2 and std.mem.startsWith(u8, flag, "-l")) {
const name = flag[2..];
// Skip xml2 — only used by LLVM's Windows manifest parser (not needed)
if (std.mem.eql(u8, name, "xml2")) continue;
// Skip m — part of libSystem on macOS, libc on Linux
if (std.mem.eql(u8, name, "m")) continue;
mod.linkSystemLibrary(name, .{ .preferred_link_mode = .static });
}
}
// On Linux, add the multiarch system library directory so LLVM's
// system-lib dependencies (zstd, tinfo, xml2) are found by the linker.
if (builtin.os.tag == .linux) {
const multiarch = @tagName(builtin.cpu.arch) ++ "-linux-gnu";
mod.addLibraryPath(.{ .cwd_relative = "/usr/lib/" ++ multiarch });
}
}
// LLVM is C++ — link the C++ standard library.
// Windows/MSVC: msvcprt already linked above
// Linux (apt LLVM): compiled with GCC, needs libstdc++
// macOS (Homebrew LLVM): compiled with Clang, needs libc++
if (target_os == .linux) {
mod.linkSystemLibrary("stdc++", .{});
} else if (target_os != .windows) {
mod.link_libcpp = true;
}
} else {
mod.linkSystemLibrary("LLVM-22", .{});
mod.linkSystemLibrary("clang-cpp", .{});
// clang-cpp is C++ — need libc++ on macOS
if (target_os != .windows and target_os != .linux) {
mod.link_libcpp = true;
}
}
const exe = b.addExecutable(.{
.name = "sx",
.root_module = b.createModule(.{
.root_source_file = b.path("src/main.zig"),
.target = target,
.optimize = optimize,
.imports = &.{
.{ .name = "sx", .module = mod },
},
}),
});
b.installArtifact(exe);
// Install the stdlib alongside the binary so `<prefix>/bin/sx` finds
// `<prefix>/library/modules/...` via the install-layout fallback in
// `src/imports.zig::discoverStdlibPaths`.
const install_library = b.addInstallDirectory(.{
.source_dir = b.path("library"),
.install_dir = .prefix,
.install_subdir = "library",
});
b.getInstallStep().dependOn(&install_library.step);
const run_step = b.step("run", "Run the app");
const run_cmd = b.addRunArtifact(exe);
run_step.dependOn(&run_cmd.step);
run_cmd.step.dependOn(b.getInstallStep());
if (b.args) |args| {
run_cmd.addArgs(args);
}
// Corpus paths for the corpus tests (src/lsp/corpus_sweep.test.zig — the
// in-process analyzer sweep — and src/corpus_run.test.zig — the end-to-end
// example/issue runner). Inject absolute corpus dirs + the installed `sx`
// binary path at configure time so the tests are CWD-independent; the
// runner still ENUMERATES the directory contents at runtime, so new
// examples are covered with no test edit.
const corpus_opts = b.addOptions();
corpus_opts.addOption([]const u8, "examples_dir", b.path("examples").getPath(b));
corpus_opts.addOption([]const u8, "issues_dir", b.path("issues").getPath(b));
corpus_opts.addOption([]const u8, "library_dir", b.path("library").getPath(b));
// Absolute path to the installed `sx` binary the corpus runner spawns per
// example. The runner test depends on the install step (below) so this
// exists — and so the sibling library/ tree the binary loads is in place.
corpus_opts.addOption([]const u8, "sx_exe", b.getInstallPath(.bin, "sx"));
// `zig build test -Dupdate-goldens` flips src/corpus_run.test.zig from
// verify mode to regenerate mode: it overwrites each example's expected
// .exit/.stdout/.stderr (+ .ir where one exists) with freshly-normalized
// output instead of asserting against it. The in-build equivalent of the
// legacy `run_examples.sh --update`.
const update_goldens = b.option(
bool,
"update-goldens",
"Regenerate example/issue snapshots instead of verifying them (use with `zig build test`)",
) orelse false;
corpus_opts.addOption(bool, "update_goldens", update_goldens);
// `zig build test -Dname=examples/0213-foo.sx[,examples/0214-bar.sx]` restricts
// the corpus runner to ONLY the named example(s) — full repo-relative `.sx`
// paths, comma-separated. Empty = run every example. Use it to verify or
// regenerate (-Dupdate-goldens) a specific example without re-running (or
// clobbering the snapshots of) the rest of the corpus. Because the value is
// baked into the corpus options module, changing it also busts the cached
// test-run result (the runner enumerates .sx/expected files at RUNTIME, so a
// bare snapshot edit alone would otherwise be served from cache).
const name_filter = b.option(
[]const u8,
"name",
"Run only the named example(s): comma-separated repo-relative .sx paths (e.g. examples/0213-foo.sx)",
) orelse "";
corpus_opts.addOption([]const u8, "name", name_filter);
mod.addOptions("corpus_paths", corpus_opts);
// `zig build [test] -Dcomptime-flat` defaults comptime evaluation to the
// flat-memory VM (`src/ir/comptime_vm.zig`), with the legacy tagged interpreter
// as the per-eval fallback — the "swap behind a build flag" step of
// `current/PLAN-COMPILER-VM.md`. Default OFF (legacy). The `SX_COMPTIME_FLAT`
// env var enables it too (either turns it on); read in `emit_llvm.zig::init`.
const comptime_flat = b.option(
bool,
"comptime-flat",
"Default comptime evaluation to the flat-memory VM (legacy interp as fallback)",
) orelse false;
// `-Dcomptime-flat-strict` (or env `SX_COMPTIME_FLAT_STRICT`): run EVERY comptime
// eval on the VM with NO legacy fallback — a VM bail becomes a build-gating error
// naming the reason. The enumeration gate for retiring `interp.zig`: when the
// corpus is green under strict mode, the VM handles everything and legacy can be
// deleted. Implies `comptime_flat`.
const comptime_flat_strict = b.option(
bool,
"comptime-flat-strict",
"Run all comptime eval on the VM with NO fallback; a bail is a hard error (interp-retirement gate)",
) orelse false;
const build_opts = b.addOptions();
build_opts.addOption(bool, "comptime_flat", comptime_flat);
build_opts.addOption(bool, "comptime_flat_strict", comptime_flat_strict);
mod.addOptions("build_opts", build_opts);
const mod_tests = b.addTest(.{
.root_module = mod,
});
const run_mod_tests = b.addRunArtifact(mod_tests);
// src/corpus_run.test.zig spawns the installed `sx` binary per example, so
// the mod test binary must not run until `zig-out/bin/sx` + `zig-out/library`
// are installed. This is what folds the full example/issue regression suite
// into `zig build test` — no shell script, just a Zig test.
run_mod_tests.step.dependOn(b.getInstallStep());
const exe_tests = b.addTest(.{
.root_module = exe.root_module,
});
const run_exe_tests = b.addRunArtifact(exe_tests);
const test_step = b.step("test", "Run unit tests + the example/issue regression suite");
test_step.dependOn(&run_mod_tests.step);
test_step.dependOn(&run_exe_tests.step);
}