Commit 9848318725345e4516d68e4f4537f602078d59ad | zig

author	Andrew Kelley <andrew@ziglang.org> 2024-08-23 12:57:55-07:00
committer	Andrew Kelley <andrew@ziglang.org> 2024-08-23 19:23:38-07:00
log	9848318725345e4516d68e4f4537f602078d59ad
tree	0f1746127373a75442bce8fdab7f916c333bfbe4
parent	5dd2bb525d1f19969c450c2b99a71f866a4f01ff

fix autodocs regression FTBFS

regressed in dffc8c44f9a01aa05ea364ffdc71509d15bc2601 since there is no
test coverage for the `zig std` command yet.

closes #21180

3 files changed, 60 insertions(+), 39 deletions(-)

lib
- compiler
  - std-docs.zig
- std
  - Build
    Fuzz
    WebServer.zig
    Step.zig

lib/compiler/std-docs.zig+51-30

 @@ -4,6 +4,7 @@ const mem = std.mem;
 const io = std.io;
 const Allocator = std.mem.Allocator;
 const assert = std.debug.assert;
+const Cache = std.Build.Cache;
 fn usage() noreturn {
     io.getStdOut().writeAll(
 @@ -232,9 +233,18 @@ fn serveWasm(
     // Do the compilation every request, so that the user can edit the files
     // and see the changes without restarting the server.
-    const wasm_binary_path = try buildWasmBinary(arena, context, optimize_mode);
+    const wasm_base_path = try buildWasmBinary(arena, context, optimize_mode);
+    const bin_name = try std.zig.binNameAlloc(arena, .{
+        .root_name = autodoc_root_name,
+        .target = std.zig.system.resolveTargetQuery(std.Build.parseTargetQuery(.{
+            .arch_os_abi = autodoc_arch_os_abi,
+            .cpu_features = autodoc_cpu_features,
+        }) catch unreachable) catch unreachable,
+        .output_mode = .Exe,
+    });
     // std.http.Server does not have a sendfile API yet.
-    const file_contents = try std.fs.cwd().readFileAlloc(gpa, wasm_binary_path, 10 * 1024 * 1024);
+    const bin_path = try wasm_base_path.join(arena, bin_name);
+    const file_contents = try bin_path.root_dir.handle.readFileAlloc(gpa, bin_path.sub_path, 10 * 1024 * 1024);
     defer gpa.free(file_contents);
     try request.respond(file_contents, .{
         .extra_headers = &.{
 @@ -244,37 +254,42 @@ fn serveWasm(
     });
 }
+const autodoc_root_name = "autodoc";
+const autodoc_arch_os_abi = "wasm32-freestanding";
+const autodoc_cpu_features = "baseline+atomics+bulk_memory+multivalue+mutable_globals+nontrapping_fptoint+reference_types+sign_ext";
 fn buildWasmBinary(
     arena: Allocator,
     context: *Context,
     optimize_mode: std.builtin.OptimizeMode,
-) ![]const u8 {
+) !Cache.Path {
     const gpa = context.gpa;
     var argv: std.ArrayListUnmanaged([]const u8) = .{};
     try argv.appendSlice(arena, &.{
-        context.zig_exe_path,
+        context.zig_exe_path, //
-        "build-exe",
+        "build-exe", //
-        "-fno-entry",
+        "-fno-entry", //
-        "-O",
+        "-O", @tagName(optimize_mode), //
-        @tagName(optimize_mode),
+        "-target", autodoc_arch_os_abi, //
-        "-target",
+        "-mcpu", autodoc_cpu_features, //
-        "wasm32-freestanding",
+        "--cache-dir", context.global_cache_path, //
-        "-mcpu",
+        "--global-cache-dir", context.global_cache_path, //
-        "baseline+atomics+bulk_memory+multivalue+mutable_globals+nontrapping_fptoint+reference_types+sign_ext",
+        "--name", autodoc_root_name, //
-        "--cache-dir",
+        "-rdynamic", //
-        context.global_cache_path,
+        "--dep", "Walk", //
-        "--global-cache-dir",
+        try std.fmt.allocPrint(
-        context.global_cache_path,
+            arena,
-        "--name",
+            "-Mroot={s}/docs/wasm/main.zig",
-        "autodoc",
+            .{context.zig_lib_directory},
-        "-rdynamic",
+        ),
-        "--dep",
+        try std.fmt.allocPrint(
-        "Walk",
+            arena,
-        try std.fmt.allocPrint(arena, "-Mroot={s}/docs/wasm/main.zig", .{context.zig_lib_directory}),
+            "-MWalk={s}/docs/wasm/Walk.zig",
-        try std.fmt.allocPrint(arena, "-MWalk={s}/docs/wasm/Walk.zig", .{context.zig_lib_directory}),
+            .{context.zig_lib_directory},
-        "--listen=-",
+        ),
+        "--listen=-", //
     });
     var child = std.process.Child.init(argv.items, gpa);
 @@ -293,7 +308,7 @@ fn buildWasmBinary(
     try sendMessage(child.stdin.?, .exit);
     const Header = std.zig.Server.Message.Header;
-    var result: ?[]const u8 = null;
+    var result: ?Cache.Path = null;
     var result_error_bundle = std.zig.ErrorBundle.empty;
     const stdout = poller.fifo(.stdout);
 @@ -330,13 +345,19 @@ fn buildWasmBinary(
                     .extra = extra_array,
                 };
             },
-            .emit_bin_path => {
+            .emit_digest => {
-                const EbpHdr = std.zig.Server.Message.EmitBinPath;
+                const EmitDigest = std.zig.Server.Message.EmitDigest;
-                const ebp_hdr = @as(*align(1) const EbpHdr, @ptrCast(body));
+                const emit_digest = @as(*align(1) const EmitDigest, @ptrCast(body));
-                if (!ebp_hdr.flags.cache_hit) {
+                if (!emit_digest.flags.cache_hit) {
                     std.log.info("source changes detected; rebuilt wasm component", .{});
                 }
-                result = try arena.dupe(u8, body[@sizeOf(EbpHdr)..]);
+                const digest = body[@sizeOf(EmitDigest)..][0..Cache.bin_digest_len];
+                result = .{
+                    .root_dir = Cache.Directory.cwd(),
+                    .sub_path = try std.fs.path.join(arena, &.{
+                        context.global_cache_path, "o" ++ std.fs.path.sep_str ++ Cache.binToHex(digest.*),
+                    }),
+                };
             },
             else => {}, // ignore other messages
         }

lib/std/Build/Fuzz/WebServer.zig+4-4

...	@@ -304,13 +304,13 @@ fn buildWasmBinary(	...	@@ -304,13 +304,13 @@ fn buildWasmBinary(
304	};	304	};
305	},	305	},
306	.emit_digest => {	306	.emit_digest => {
307	const EbpHdr = std.zig.Server.Message.EmitDigest;	307	const EmitDigest = std.zig.Server.Message.EmitDigest;
308	const ebp_hdr = @as(*align(1) const EbpHdr, @ptrCast(body));	308	const ebp_hdr = @as(*align(1) const EmitDigest, @ptrCast(body));
309	if (!ebp_hdr.flags.cache_hit) {	309	if (!ebp_hdr.flags.cache_hit) {
310	log.info("source changes detected; rebuilt wasm component", .{});	310	log.info("source changes detected; rebuilt wasm component", .{});
311	}	311	}
312	const digest = body[@sizeOf(EbpHdr)..][0..Cache.bin_digest_len];	312	const digest = body[@sizeOf(EmitDigest)..][0..Cache.bin_digest_len];
313	result = Path{	313	result = .{
314	.root_dir = ws.global_cache_directory,	314	.root_dir = ws.global_cache_directory,
315	.sub_path = try arena.dupe(u8, "o" ++ std.fs.path.sep_str ++ Cache.binToHex(digest.*)),	315	.sub_path = try arena.dupe(u8, "o" ++ std.fs.path.sep_str ++ Cache.binToHex(digest.*)),
316	};	316	};

lib/std/Build/Step.zig+5-5

...	@@ -534,11 +534,11 @@ fn zigProcessUpdate(s: Step, zp: ZigProcess, watch: bool) !?Path {	...	@@ -534,11 +534,11 @@ fn zigProcessUpdate(s: Step, zp: ZigProcess, watch: bool) !?Path {
534	}	534	}
535	},	535	},
536	.emit_digest => {	536	.emit_digest => {
537	const EbpHdr = std.zig.Server.Message.EmitDigest;	537	const EmitDigest = std.zig.Server.Message.EmitDigest;
538	const ebp_hdr = @as(*align(1) const EbpHdr, @ptrCast(body));	538	const emit_digest = @as(*align(1) const EmitDigest, @ptrCast(body));
539	s.result_cached = ebp_hdr.flags.cache_hit;	539	s.result_cached = emit_digest.flags.cache_hit;
540	const digest = body[@sizeOf(EbpHdr)..][0..Cache.bin_digest_len];	540	const digest = body[@sizeOf(EmitDigest)..][0..Cache.bin_digest_len];
541	result = Path{	541	result = .{
542	.root_dir = b.cache_root,	542	.root_dir = b.cache_root,
543	.sub_path = try arena.dupe(u8, "o" ++ std.fs.path.sep_str ++ Cache.binToHex(digest.*)),	543	.sub_path = try arena.dupe(u8, "o" ++ std.fs.path.sep_str ++ Cache.binToHex(digest.*)),
544	};	544	};