@pkmn/engine 0.1.0-dev.84cc1a02 → 0.1.0-dev.8b192003

package/build.zig

@@ -1,19 +1,6 @@
 const std = @import("std");
 const builtin = @import("builtin");
 
-pub const Options = struct { showdown: ?bool = null, trace: ?bool = null };
-
-pub fn module(b: *std.Build, options: Options) *std.Build.Module {
-    const dirname = comptime std.fs.path.dirname(@src().file) orelse ".";
-    const build_options = b.addOptions();
-    build_options.addOption(?bool, "showdown", options.showdown);
-    build_options.addOption(?bool, "trace", options.trace);
-    return b.createModule(.{
-        .source_file = .{ .path = dirname ++ "/src/lib/pkmn.zig" },
-        .dependencies = &.{.{ .name = "build_options", .module = build_options.createModule() }},
-    });
-}
-
 pub fn build(b: *std.Build) !void {
     const target = b.standardTargetOptions(.{});
     const optimize = b.standardOptimizeOption(.{});
@@ -25,132 +12,169 @@ pub fn build(b: *std.Build) !void {
     const wasm_stack_size =
         b.option(u64, "wasm-stack-size", "The size of WASM stack") orelse std.wasm.page_size;
     const dynamic = b.option(bool, "dynamic", "Build a dynamic library") orelse false;
-    const strip = b.option(bool, "strip", "Strip debugging symbols from binary") orelse false;
-    const pic = b.option(bool, "pic", "Force position independent code") orelse false;
-
-    const cmd = b.findProgram(&[_][]const u8{"strip"}, &[_][]const u8{}) catch null;
-
-    var parser = std.json.Parser.init(b.allocator, false);
-    defer parser.deinit();
-    var tree = try parser.parse(@embedFile("package.json"));
-    defer tree.deinit();
-    const version = tree.root.Object.get("version").?.String;
-    const description = tree.root.Object.get("description").?.String;
-    var repository = std.mem.split(u8, tree.root.Object.get("repository").?.String, ":");
+    const strip = b.option(bool, "strip", "Strip debugging symbols from binary");
+    const pic = b.option(bool, "pic", "Force position independent code");
+    const emit_asm = b.option(bool, "emit-asm", "Output .s (assembly code)") orelse false;
+    const emit_ll = b.option(bool, "emit-ll", "Output .ll (LLVM IR)") orelse false;
+
+    const cmd = b.findProgram(&.{"strip"}, &.{}) catch null;
+
+    const json = @embedFile("package.json");
+    var parsed = try std.json.parseFromSlice(std.json.Value, b.allocator, json, .{});
+    defer parsed.deinit();
+    const version = parsed.value.object.get("version").?.string;
+    const description = parsed.value.object.get("description").?.string;
+    var repository = std.mem.splitSequence(u8, parsed.value.object.get("repository").?.string, ":");
     std.debug.assert(std.mem.eql(u8, repository.first(), "github"));
 
     const showdown =
         b.option(bool, "showdown", "Enable Pokémon Showdown compatibility mode") orelse false;
-    const trace = b.option(bool, "trace", "Enable trace logs") orelse false;
+    const log = b.option(bool, "log", "Enable protocol message logging") orelse false;
+    const chance = b.option(bool, "chance", "Enable update probability tracking") orelse false;
+    const calc = b.option(bool, "calc", "Enable damage calculator support") orelse false;
 
     const options = b.addOptions();
     options.addOption(?bool, "showdown", showdown);
-    options.addOption(?bool, "trace", trace);
+    options.addOption(?bool, "log", log);
+    options.addOption(?bool, "chance", chance);
+    options.addOption(?bool, "calc", calc);
 
     const name = if (showdown) "pkmn-showdown" else "pkmn";
 
+    const module = b.addModule("pkmn", .{
+        .root_source_file = b.path("src/lib/pkmn.zig"),
+        .optimize = optimize,
+        .target = target,
+        .imports = &.{.{ .name = "build_options", .module = options.createModule() }},
+    });
+
     var c = false;
     if (node_headers) |headers| {
         const addon = b.fmt("{s}.node", .{name});
         const lib = b.addSharedLibrary(.{
             .name = addon,
-            .root_source_file = .{ .path = "src/lib/binding/node.zig" },
+            .root_source_file = b.path("src/lib/node.zig"),
             .optimize = optimize,
             .target = target,
+            .strip = strip,
+            .pic = pic,
         });
-        lib.addOptions("build_options", options);
-        lib.setMainPkgPath("./");
-        lib.addSystemIncludePath(headers);
+        lib.root_module.addOptions("build_options", options);
+        lib.addSystemIncludePath(b.path(headers));
         lib.linkLibC();
         if (node_import_lib) |il| {
-            lib.addObjectFile(il);
-        } else if ((try std.zig.system.NativeTargetInfo.detect(target)).target.os.tag == .windows) {
+            lib.addObjectFile(b.path(il));
+        } else if (target.result.os.tag == .windows) {
             try std.io.getStdErr().writeAll("Must provide --node-import-library path on Windows\n");
             std.process.exit(1);
         }
         lib.linker_allow_shlib_undefined = true;
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
-        if (pic) lib.force_pic = pic;
         // Always emit to build/lib because this is where the driver code expects to find it
-        // TODO(ziglang/zig#2231): using the following used to work (though be hacky):
+        // TODO: ziglang/zig#2231 - using the following used to work (though was hacky):
         //
         //    lib.emit_bin = .{ .emit_to = b.fmt("build/lib/{s}", .{addon}) };
         //    b.getInstallStep().dependOn(&lib.step);
         //
         // But ziglang/zig#14647 broke this so we now need to do an install() and then manually
         // rename the file ourself in install-pkmn-engine
-        lib.install();
+        b.installArtifact(lib);
     } else if (wasm) {
-        const lib = b.addSharedLibrary(.{
+        const exe = b.addExecutable(.{
             .name = name,
-            .root_source_file = .{ .path = "src/lib/binding/wasm.zig" },
+            .root_source_file = b.path("src/lib/wasm.zig"),
             .optimize = switch (optimize) {
                 .ReleaseFast, .ReleaseSafe => .ReleaseSmall,
                 else => optimize,
             },
-            .target = .{ .cpu_arch = .wasm32, .os_tag = .freestanding },
+            .target = b.resolveTargetQuery(.{ .cpu_arch = .wasm32, .os_tag = .freestanding }),
+            .strip = strip,
+            .pic = pic,
         });
-        lib.addOptions("build_options", options);
-        lib.setMainPkgPath("./");
-        lib.stack_size = wasm_stack_size;
-        lib.rdynamic = true;
-        lib.strip = strip;
-        if (pic) lib.force_pic = pic;
-        const opt = b.findProgram(
-            &[_][]const u8{"wasm-opt"},
-            &[_][]const u8{"./node_modules/.bin"},
-        ) catch null;
+        exe.root_module.addOptions("build_options", options);
+        exe.root_module.export_symbol_names = &[_][]const u8{
+            "SHOWDOWN",
+            "LOG",
+            "CHANCE",
+            "CALC",
+            "GEN1_CHOICES_SIZE",
+            "GEN1_LOGS_SIZE",
+        };
+        exe.entry = .disabled;
+        exe.stack_size = wasm_stack_size;
+        const opt = b.findProgram(&.{"wasm-opt"}, &.{"./node_modules/.bin"}) catch null;
         if (optimize != .Debug and opt != null) {
             const out = b.fmt("build/lib/{s}.wasm", .{name});
-            const sh = b.addSystemCommand(&[_][]const u8{ opt.?, "-O4" });
-            sh.addArtifactArg(lib);
+            const sh = b.addSystemCommand(&.{ opt.?, "-O4" });
+            sh.addArtifactArg(exe);
             sh.addArg("-o");
-            sh.addFileSourceArg(.{ .path = out });
+            sh.addFileArg(b.path(out));
             b.getInstallStep().dependOn(&sh.step);
+        } else {
+            b.getInstallStep().dependOn(&b.addInstallArtifact(exe, .{
+                .dest_dir = .{ .override = std.Build.InstallDir{ .lib = {} } },
+            }).step);
         }
-        lib.install();
     } else if (dynamic) {
         const lib = b.addSharedLibrary(.{
             .name = name,
-            .root_source_file = .{ .path = "src/lib/binding/c.zig" },
-            .version = try std.builtin.Version.parse(version),
+            .root_source_file = b.path("src/lib/c.zig"),
+            .version = try std.SemanticVersion.parse(version),
             .optimize = optimize,
             .target = target,
+            .strip = strip,
+            .pic = pic,
         });
-        lib.addOptions("build_options", options);
-        lib.setMainPkgPath("./");
-        lib.addIncludePath("src/include");
+        lib.root_module.addOptions("build_options", options);
+        lib.addIncludePath(b.path("src/include"));
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
-        if (pic) lib.force_pic = pic;
-        lib.install();
+        b.installArtifact(lib);
         c = true;
     } else {
         const lib = b.addStaticLibrary(.{
             .name = name,
-            .root_source_file = .{ .path = "src/lib/binding/c.zig" },
+            .root_source_file = b.path("src/lib/c.zig"),
             .optimize = optimize,
             .target = target,
+            .strip = strip,
+            .pic = pic,
         });
-        lib.addOptions("build_options", options);
-        lib.setMainPkgPath("./");
-        lib.addIncludePath("src/include");
+        lib.root_module.addOptions("build_options", options);
+        lib.addIncludePath(b.path("src/include"));
         lib.bundle_compiler_rt = true;
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
-        if (pic) lib.force_pic = pic;
-        lib.install();
+        if (emit_asm) {
+            b.getInstallStep().dependOn(&b.addInstallFileWithDir(
+                lib.getEmittedAsm(),
+                .prefix,
+                b.fmt("{s}.s", .{name}),
+            ).step);
+        }
+        if (emit_ll) {
+            b.getInstallStep().dependOn(&b.addInstallFileWithDir(
+                lib.getEmittedLlvmIr(),
+                .prefix,
+                b.fmt("{s}.ll", .{name}),
+            ).step);
+        }
+        b.installArtifact(lib);
         c = true;
     }
 
     if (c) {
         const header = b.addInstallFileWithDir(
-            .{ .path = "src/include/pkmn.h" },
+            b.path("src/include/pkmn.h"),
             .header,
             "pkmn.h",
         );
         b.getInstallStep().dependOn(&header.step);
 
         const pc = b.fmt("lib{s}.pc", .{name});
-        const file = try b.cache_root.join(b.allocator, &.{pc});
+        const file = try std.fs.path.relative(
+            b.allocator,
+            try std.process.getCwdAlloc(b.allocator),
+            try b.cache_root.join(b.allocator, &.{pc}),
+        );
         const pkgconfig_file = try std.fs.cwd().createFile(file, .{});
 
         const dirname = comptime std.fs.path.dirname(@src().file) orelse ".";
@@ -179,14 +203,16 @@ pub fn build(b: *std.Build) !void {
         .strip = strip,
         .cmd = cmd,
     };
+
+    // TODO: tests can be run multiple times due to @imports
     const tests = TestStep.create(b, options, config);
 
-    var exes = std.ArrayList(*std.Build.CompileStep).init(b.allocator);
+    var exes = std.ArrayList(*std.Build.Step.Compile).init(b.allocator);
     const tools: ToolConfig = .{
+        .showdown = showdown,
+        .module = module,
         .general = config,
         .tool = .{
-            .showdown = showdown,
-            .trace = trace,
             .tests = if (tests.build) tests else null,
             .exes = &exes,
         },
@@ -195,141 +221,129 @@ pub fn build(b: *std.Build) !void {
     var benchmark_config = tools;
     benchmark_config.general.optimize = .ReleaseFast;
     benchmark_config.general.strip = true;
-    const benchmark = tool(b, "src/test/benchmark.zig", benchmark_config);
+    const benchmark = try tool(b, "src/test/benchmark.zig", benchmark_config);
 
     var fuzz_config = tools;
     fuzz_config.general.strip = false;
     fuzz_config.tool.name = "fuzz";
-    const fuzz = tool(b, "src/test/benchmark.zig", fuzz_config);
-
-    const serde = tool(b, "src/tools/serde.zig", tools);
-    const protocol = tool(b, "src/tools/protocol.zig", tools);
-
-    const lint_exe =
-        b.addExecutable(.{ .name = "lint", .root_source_file = .{ .path = "src/tools/lint.zig" } });
-    if (tests.build) tests.step.dependOn(&lint_exe.step);
-    const lint = lint_exe.run();
-
-    b.step("benchmark", "Run benchmark code").dependOn(&benchmark.step);
-    b.step("fuzz", "Run fuzz tester").dependOn(&fuzz.step);
-    b.step("lint", "Lint source files").dependOn(&lint.step);
-    b.step("protocol", "Run protocol dump tool").dependOn(&protocol.step);
-    b.step("serde", "Run serialization/deserialization tool").dependOn(&serde.step);
+    const fuzz = try tool(b, "src/test/fuzz.zig", fuzz_config);
+
+    const analyze = try tool(b, "src/tools/analyze.zig", tools);
+    const dump = try tool(b, "src/tools/dump.zig", tools);
+    const transitions = try tool(b, "src/tools/transitions.zig", tools);
+
+    // FIXME: serde randomly fails to build in some release configurations
+    var hack = tools;
+    if (optimize != .Debug) hack.tool.tests = null;
+    const serde = try tool(b, "src/tools/serde.zig", hack);
+
+    if (analyze) |t| b.step("analyze", "Run LLVM analysis tool").dependOn(&t.step);
+    if (benchmark) |t| b.step("benchmark", "Run benchmark code").dependOn(&t.step);
+    if (dump) |t| b.step("dump", "Run protocol dump tool").dependOn(&t.step);
+    if (fuzz) |t| b.step("fuzz", "Run fuzz tester").dependOn(&t.step);
+    if (serde) |t| b.step("serde", "Run serialization/deserialization tool").dependOn(&t.step);
     b.step("test", "Run all tests").dependOn(&tests.step);
     b.step("tools", "Install tools").dependOn(&ToolsStep.create(b, &exes).step);
+    if (transitions) |t| {
+        b.step("transitions", "Visualize transitions algorithm search").dependOn(&t.step);
+    }
 }
 
 fn maybeStrip(
     b: *std.Build,
-    artifact: *std.Build.CompileStep,
+    artifact: *std.Build.Step.Compile,
     step: *std.Build.Step,
-    strip: bool,
+    strip: ?bool,
     cmd: ?[]const u8,
 ) void {
-    artifact.strip = strip;
-    if (!strip or cmd == null) return;
+    if (!(strip orelse false) or cmd == null) return;
     // Using `strip -r -u` for dynamic libraries is supposed to work on macOS but doesn't...
     const mac = builtin.os.tag == .macos;
     if (mac and artifact.isDynamicLibrary()) return;
     // Assuming GNU strip, which complains "illegal pathname found in archive member"...
     if (!mac and artifact.isStaticLibrary()) return;
-    const sh = b.addSystemCommand(&[_][]const u8{ cmd.?, if (mac) "-x" else "-s" });
+    const sh = b.addSystemCommand(&.{ cmd.?, if (mac) "-x" else "-s" });
     sh.addArtifactArg(artifact);
     step.dependOn(&sh.step);
 }
 
 const Config = struct {
-    target: std.zig.CrossTarget,
+    target: std.Build.ResolvedTarget,
     optimize: std.builtin.OptimizeMode,
-    pic: bool,
-    strip: bool,
+    pic: ?bool,
+    strip: ?bool,
     cmd: ?[]const u8,
 };
 
-const TESTS = [_][]const u8{
-    "src/lib/common/test.zig",
-    "src/lib/gen1/test.zig",
-    "src/lib/gen2/test.zig",
-};
-
 const TestStep = struct {
     step: std.Build.Step,
     build: bool,
 
-    pub fn create(b: *std.Build, options: *std.Build.OptionsStep, config: Config) *TestStep {
+    pub fn create(b: *std.Build, options: *std.Build.Step.Options, config: Config) *TestStep {
         const coverage = b.option([]const u8, "test-coverage", "Generate test coverage");
-        const test_file = b.option([]const u8, "test-file", "Input file for test");
-        const test_bin = b.option([]const u8, "test-bin", "Emit test binary to");
         const test_filter =
             b.option([]const u8, "test-filter", "Skip tests that do not match filter");
-        const test_no_exec =
-            b.option(bool, "test-no-exec", "Compiles test binary without running it") orelse false;
 
         const self = b.allocator.create(TestStep) catch @panic("OOM");
         const step = std.Build.Step.init(.{ .id = .custom, .name = "Run all tests", .owner = b });
-        self.* = TestStep{ .step = step, .build = test_filter == null };
-
-        const paths: []const []const u8 =
-            if (test_file) |t| &.{t} else if (coverage != null) &.{"src/lib/test.zig"} else &TESTS;
-        for (paths) |path| {
-            const tests = b.addTest(.{
-                .name = std.fs.path.basename(std.fs.path.dirname(path).?),
-                .root_source_file = .{ .path = path },
-                .optimize = config.optimize,
-                .target = config.target,
-            });
-            tests.setMainPkgPath("./");
-            tests.setFilter(test_filter);
-            tests.addOptions("build_options", options);
-            tests.single_threaded = true;
-            maybeStrip(b, tests, &tests.step, config.strip, config.cmd);
-            if (config.pic) tests.force_pic = config.pic;
-            if (test_bin) |bin| {
-                tests.name = std.fs.path.basename(bin);
-                if (std.fs.path.dirname(bin)) |dir| tests.setOutputDir(dir);
-            }
-            if (coverage) |c| {
-                tests.setExecCmd(&.{ "kcov", "--include-pattern=src/lib", c, null });
-            }
-            self.step.dependOn(if (test_no_exec) &tests.step else &tests.run().step);
+        self.* = .{ .step = step, .build = test_filter == null };
+
+        const tests = b.addTest(.{
+            .root_source_file = b.path("src/lib/test.zig"),
+            .optimize = config.optimize,
+            .target = config.target,
+            .filter = test_filter,
+            .single_threaded = true,
+            .strip = config.strip,
+            .pic = config.pic,
+        });
+        tests.root_module.addOptions("build_options", options);
+        maybeStrip(b, tests, &tests.step, config.strip, config.cmd);
+        if (coverage) |c| {
+            tests.setExecCmd(&.{ "kcov", "--include-pattern=src/lib", c, null });
         }
+        self.step.dependOn(&b.addRunArtifact(tests).step);
+
         return self;
     }
 };
 
 const ToolConfig = struct {
+    showdown: ?bool,
+    module: *std.Build.Module,
     general: Config,
     tool: struct {
-        showdown: bool,
-        trace: bool,
         tests: ?*TestStep,
         name: ?[]const u8 = null,
-        exes: *std.ArrayList(*std.Build.CompileStep),
+        exes: *std.ArrayList(*std.Build.Step.Compile),
     },
 };
 
-fn tool(b: *std.Build, path: []const u8, config: ToolConfig) *std.Build.RunStep {
+fn tool(b: *std.Build, path: []const u8, config: ToolConfig) !?*std.Build.Step.Run {
+    std.fs.cwd().access(path, .{}) catch |err| switch (err) {
+        error.FileNotFound => return null,
+        else => |e| return e,
+    };
     var name = config.tool.name orelse std.fs.path.basename(path);
     const index = std.mem.lastIndexOfScalar(u8, name, '.');
     if (index) |i| name = name[0..i];
-    if (config.tool.showdown) name = b.fmt("{s}-showdown", .{name});
+    if (config.showdown orelse false) name = b.fmt("{s}-showdown", .{name});
 
     const exe = b.addExecutable(.{
         .name = name,
-        .root_source_file = .{ .path = path },
+        .root_source_file = b.path(path),
         .target = config.general.target,
         .optimize = config.general.optimize,
+        .single_threaded = true,
+        .strip = config.general.strip,
+        .pic = config.general.pic,
     });
-    exe.addModule("pkmn", module(b, .{
-        .showdown = config.tool.showdown,
-        .trace = config.tool.trace,
-    }));
-    exe.single_threaded = true;
-    if (config.general.pic) exe.force_pic = config.general.pic;
+    exe.root_module.addImport("pkmn", config.module);
+
     if (config.tool.tests) |ts| ts.step.dependOn(&exe.step);
     config.tool.exes.append(exe) catch @panic("OOM");
 
-    const run = exe.run();
+    const run = b.addRunArtifact(exe);
     maybeStrip(b, exe, &run.step, config.general.strip, config.general.cmd);
     if (b.args) |args| run.addArgs(args);
 
@@ -339,11 +353,11 @@ fn tool(b: *std.Build, path: []const u8, config: ToolConfig) *std.Build.RunStep
 const ToolsStep = struct {
     step: std.Build.Step,
 
-    pub fn create(b: *std.Build, exes: *std.ArrayList(*std.Build.CompileStep)) *ToolsStep {
+    pub fn create(b: *std.Build, exes: *std.ArrayList(*std.Build.Step.Compile)) *ToolsStep {
         const self = b.allocator.create(ToolsStep) catch @panic("OOM");
         const step = std.Build.Step.init(.{ .id = .custom, .name = "Install tools", .owner = b });
-        self.* = ToolsStep{ .step = step };
-        for (exes.items) |t| self.step.dependOn(&b.addInstallArtifact(t).step);
+        self.* = .{ .step = step };
+        for (exes.items) |t| self.step.dependOn(&b.addInstallArtifact(t, .{}).step);
         return self;
     }
 };