Commit d9f1a952b8b0e19aafcf568b35cc220adbb4a7b5 | zig

author	Jonathan Marler <johnnymarler@gmail.com> 2024-07-02 06:15:29-06:00
committer	Andrew Kelley <andrew@ziglang.org> 2024-07-04 13:34:17-04:00
log	d9f1a952b8b0e19aafcf568b35cc220adbb4a7b5
tree	d7333d6953a0fe37ac11b12a2456efebffd2a4c0
parent	b67caf72e31eefe08fe2dc8b17b4bca16e0e3cc6

build: fix WriteFile and addCSourceFiles not adding LazyPath deps

Adds a missing call to addLazyPathDependenciesOnly in
std.Build.Module.addCSourceFiles.  Also fixes an issue in
std.Build.Step.WriteFile where it wasn't updating all the GeneratedFile
instances for every directory.  To fix the second issue, I removed
all the GeneratedFile instances and now all files/directories reference
the steps main GeneratedFile via sub paths.

12 files changed, 96 insertions(+), 47 deletions(-)

lib
- std
  - Build
    Module.zig
    Step
    WriteFile.zig
test
- src
- standalone
  - build.zig.zon
  - dep_lazypath
    build.zig
    inc
    foo.h
    inctest.zig
- tests.zig

lib/std/Build/Module.zig+1

...	@@ -484,6 +484,7 @@ pub fn addCSourceFiles(m: *Module, options: AddCSourceFilesOptions) void {	...	@@ -484,6 +484,7 @@ pub fn addCSourceFiles(m: *Module, options: AddCSourceFilesOptions) void {
484	.flags = b.dupeStrings(options.flags),	484	.flags = b.dupeStrings(options.flags),
485	};	485	};
486	m.link_objects.append(allocator, .{ .c_source_files = c_source_files }) catch @panic("OOM");	486	m.link_objects.append(allocator, .{ .c_source_files = c_source_files }) catch @panic("OOM");
		487	addLazyPathDependenciesOnly(m, c_source_files.root);
487	}	488	}
488		489
489	pub fn addCSourceFile(m: *Module, source: CSourceFile) void {	490	pub fn addCSourceFile(m: *Module, source: CSourceFile) void {

lib/std/Build/Step/WriteFile.zig+23-33

 @@ -17,8 +17,8 @@ const WriteFile = @This();
 step: Step,
 // The elements here are pointers because we need stable pointers for the GeneratedFile field.
-files: std.ArrayListUnmanaged(*File),
+files: std.ArrayListUnmanaged(File),
-directories: std.ArrayListUnmanaged(*Directory),
+directories: std.ArrayListUnmanaged(Directory),
 output_source_files: std.ArrayListUnmanaged(OutputSourceFile),
 generated_directory: std.Build.GeneratedFile,
 @@ -26,20 +26,14 @@ generated_directory: std.Build.GeneratedFile,
 pub const base_id: Step.Id = .write_file;
 pub const File = struct {
-    generated_file: std.Build.GeneratedFile,
     sub_path: []const u8,
     contents: Contents,
-    pub fn getPath(file: *File) std.Build.LazyPath {
-        return .{ .generated = .{ .file = &file.generated_file } };
-    }
 };
 pub const Directory = struct {
     source: std.Build.LazyPath,
     sub_path: []const u8,
     options: Options,
-    generated_dir: std.Build.GeneratedFile,
     pub const Options = struct {
         /// File paths that end in any of these suffixes will be excluded from copying.
 @@ -56,10 +50,6 @@ pub const Directory = struct {
             };
         }
     };
-    pub fn getPath(dir: *Directory) std.Build.LazyPath {
-        return .{ .generated = .{ .file = &dir.generated_dir } };
-    }
 };
 pub const OutputSourceFile = struct {
 @@ -92,15 +82,18 @@ pub fn create(owner: *std.Build) *WriteFile {
 pub fn add(write_file: *WriteFile, sub_path: []const u8, bytes: []const u8) std.Build.LazyPath {
     const b = write_file.step.owner;
     const gpa = b.allocator;
-    const file = gpa.create(File) catch @panic("OOM");
+    const file = File{
-    file.* = .{
-        .generated_file = .{ .step = &write_file.step },
         .sub_path = b.dupePath(sub_path),
         .contents = .{ .bytes = b.dupe(bytes) },
     };
     write_file.files.append(gpa, file) catch @panic("OOM");
     write_file.maybeUpdateName();
-    return file.getPath();
+    return .{
+        .generated = .{
+            .file = &write_file.generated_directory,
+            .sub_path = file.sub_path,
+        },
+    };
 }
 /// Place the file into the generated directory within the local cache,
 @@ -113,9 +106,7 @@ pub fn add(write_file: *WriteFile, sub_path: []const u8, bytes: []const u8) std.
 pub fn addCopyFile(write_file: *WriteFile, source: std.Build.LazyPath, sub_path: []const u8) std.Build.LazyPath {
     const b = write_file.step.owner;
     const gpa = b.allocator;
-    const file = gpa.create(File) catch @panic("OOM");
+    const file = File{
-    file.* = .{
-        .generated_file = .{ .step = &write_file.step },
         .sub_path = b.dupePath(sub_path),
         .contents = .{ .copy = source },
     };
 @@ -123,7 +114,12 @@ pub fn addCopyFile(write_file: *WriteFile, source: std.Build.LazyPath, sub_path:
     write_file.maybeUpdateName();
     source.addStepDependencies(&write_file.step);
-    return file.getPath();
+    return .{
+        .generated = .{
+            .file = &write_file.generated_directory,
+            .sub_path = file.sub_path,
+        },
+    };
 }
 /// Copy files matching the specified exclude/include patterns to the specified subdirectory
 @@ -137,18 +133,21 @@ pub fn addCopyDirectory(
 ) std.Build.LazyPath {
     const b = write_file.step.owner;
     const gpa = b.allocator;
-    const dir = gpa.create(Directory) catch @panic("OOM");
+    const dir = Directory{
-    dir.* = .{
         .source = source.dupe(b),
         .sub_path = b.dupePath(sub_path),
         .options = options.dupe(b),
-        .generated_dir = .{ .step = &write_file.step },
     };
     write_file.directories.append(gpa, dir) catch @panic("OOM");
     write_file.maybeUpdateName();
     source.addStepDependencies(&write_file.step);
-    return dir.getPath();
+    return .{
+        .generated = .{
+            .file = &write_file.generated_directory,
+            .sub_path = dir.sub_path,
+        },
+    };
 }
 /// A path relative to the package root.
 @@ -278,11 +277,6 @@ fn make(step: *Step, prog_node: std.Progress.Node) !void {
     if (try step.cacheHit(&man)) {
         const digest = man.final();
-        for (write_file.files.items) |file| {
-            file.generated_file.path = try b.cache_root.join(b.allocator, &.{
-                "o", &digest, file.sub_path,
-            });
-        }
         write_file.generated_directory.path = try b.cache_root.join(b.allocator, &.{ "o", &digest });
         return;
     }
 @@ -342,10 +336,6 @@ fn make(step: *Step, prog_node: std.Progress.Node) !void {
                 _ = prev_status;
             },
         }
-        file.generated_file.path = try b.cache_root.join(b.allocator, &.{
-            cache_path, file.sub_path,
-        });
     }
     for (write_file.directories.items) |dir| {
         const full_src_dir_path = dir.source.getPath2(b, step);

test/src/Cases.zig+4-2

 @@ -665,10 +665,12 @@ pub fn lowerToBuildSteps(
         const writefiles = b.addWriteFiles();
         var file_sources = std.StringHashMap(std.Build.LazyPath).init(b.allocator);
         defer file_sources.deinit();
-        for (update.files.items) |file| {
+        const first_file = update.files.items[0];
+        const root_source_file = writefiles.add(first_file.path, first_file.src);
+        file_sources.put(first_file.path, root_source_file) catch @panic("OOM");
+        for (update.files.items[1..]) |file| {
             file_sources.put(file.path, writefiles.add(file.path, file.src)) catch @panic("OOM");
         }
-        const root_source_file = writefiles.files.items[0].getPath();
         const artifact = if (case.is_test) b.addTest(.{
             .root_source_file = root_source_file,

test/src/CompareOutput.zig+6-4

...	@@ -81,7 +81,9 @@ pub fn addCase(self: *CompareOutput, case: TestCase) void {	...	@@ -81,7 +81,9 @@ pub fn addCase(self: *CompareOutput, case: TestCase) void {
81	const b = self.b;	81	const b = self.b;
82		82
83	const write_src = b.addWriteFiles();	83	const write_src = b.addWriteFiles();
84	for (case.sources.items) \|src_file\| {	84	const first_src = case.sources.items[0];
		85	const first_file = write_src.add(first_src.filename, first_src.source);
		86	for (case.sources.items[1..]) \|src_file\| {
85	_ = write_src.add(src_file.filename, src_file.source);	87	_ = write_src.add(src_file.filename, src_file.source);
86	}	88	}
87		89
...	@@ -99,7 +101,7 @@ pub fn addCase(self: *CompareOutput, case: TestCase) void {	...	@@ -99,7 +101,7 @@ pub fn addCase(self: *CompareOutput, case: TestCase) void {
99	.target = b.graph.host,	101	.target = b.graph.host,
100	.optimize = .Debug,	102	.optimize = .Debug,
101	});	103	});
102	exe.addAssemblyFile(write_src.files.items[0].getPath());	104	exe.addAssemblyFile(first_file);
103		105
104	const run = b.addRunArtifact(exe);	106	const run = b.addRunArtifact(exe);
105	run.setName(annotated_case_name);	107	run.setName(annotated_case_name);
...	@@ -119,7 +121,7 @@ pub fn addCase(self: *CompareOutput, case: TestCase) void {	...	@@ -119,7 +121,7 @@ pub fn addCase(self: *CompareOutput, case: TestCase) void {
119		121
120	const exe = b.addExecutable(.{	122	const exe = b.addExecutable(.{
121	.name = "test",	123	.name = "test",
122	.root_source_file = write_src.files.items[0].getPath(),	124	.root_source_file = first_file,
123	.optimize = optimize,	125	.optimize = optimize,
124	.target = b.graph.host,	126	.target = b.graph.host,
125	});	127	});
...	@@ -145,7 +147,7 @@ pub fn addCase(self: *CompareOutput, case: TestCase) void {	...	@@ -145,7 +147,7 @@ pub fn addCase(self: *CompareOutput, case: TestCase) void {
145		147
146	const exe = b.addExecutable(.{	148	const exe = b.addExecutable(.{
147	.name = "test",	149	.name = "test",
148	.root_source_file = write_src.files.items[0].getPath(),	150	.root_source_file = first_file,
149	.target = b.graph.host,	151	.target = b.graph.host,
150	.optimize = .Debug,	152	.optimize = .Debug,
151	});	153	});

test/src/RunTranslatedC.zig+4-2

 @@ -72,11 +72,13 @@ pub fn addCase(self: *RunTranslatedCContext, case: *const TestCase) void {
     } else if (self.test_filters.len > 0) return;
     const write_src = b.addWriteFiles();
-    for (case.sources.items) |src_file| {
+    const first_case = case.sources.items[0];
+    const root_source_file = write_src.add(first_case.filename, first_case.source);
+    for (case.sources.items[1..]) |src_file| {
         _ = write_src.add(src_file.filename, src_file.source);
     }
     const translate_c = b.addTranslateC(.{
-        .root_source_file = write_src.files.items[0].getPath(),
+        .root_source_file = root_source_file,
         .target = b.graph.host,
         .optimize = .Debug,
     });

test/src/StackTrace.zig+3-2

 @@ -51,10 +51,11 @@ fn addExpect(
         if (mem.indexOf(u8, annotated_case_name, test_filter)) |_| break;
     } else if (self.test_filters.len > 0) return;
-    const write_src = b.addWriteFile("source.zig", source);
+    const write_files = b.addWriteFiles();
+    const source_zig = write_files.add("source.zig", source);
     const exe = b.addExecutable(.{
         .name = "test",
-        .root_source_file = write_src.files.items[0].getPath(),
+        .root_source_file = source_zig,
         .optimize = optimize_mode,
         .target = b.graph.host,
         .error_tracing = mode_config.error_tracing,

test/src/TranslateC.zig+4-2

 @@ -93,12 +93,14 @@ pub fn addCase(self: *TranslateCContext, case: *const TestCase) void {
     } else if (self.test_filters.len > 0) return;
     const write_src = b.addWriteFiles();
-    for (case.sources.items) |src_file| {
+    const first_src = case.sources.items[0];
+    const root_source_file = write_src.add(first_src.filename, first_src.source);
+    for (case.sources.items[1..]) |src_file| {
         _ = write_src.add(src_file.filename, src_file.source);
     }
     const translate_c = b.addTranslateC(.{
-        .root_source_file = write_src.files.items[0].getPath(),
+        .root_source_file = root_source_file,
         .target = b.resolveTargetQuery(case.target),
         .optimize = .Debug,
     });

test/standalone/build.zig.zon+3

 @@ -83,6 +83,9 @@
         .dep_shared_builtin = .{
             .path = "dep_shared_builtin",
         },
+        .dep_lazypath = .{
+            .path = "dep_lazypath",
+        },
         .dirname = .{
             .path = "dirname",
         },

test/standalone/dep_lazypath/build.zig created+37

...	@@ -0,0 +1,37 @@
1	const std = @import("std");
2
3	pub fn build(b: *std.Build) void {
4	const test_step = b.step("test", "Test it");
5	b.default_step = test_step;
6
7	const optimize: std.builtin.OptimizeMode = .Debug;
8
9	{
10	const write_files = b.addWriteFiles();
11	const generated_main_c = write_files.add("main.c", "");
12	const exe = b.addExecutable(.{
13	.name = "test",
14	.target = b.graph.host,
15	.optimize = optimize,
16	});
17	exe.addCSourceFiles(.{
18	.root = generated_main_c.dirname(),
19	.files = &.{"main.c"},
20	});
21	b.step("csourcefiles", "").dependOn(&exe.step);
22	test_step.dependOn(&exe.step);
23	}
24	{
25	const write_files = b.addWriteFiles();
26	const dir = write_files.addCopyDirectory(b.path("inc"), "", .{});
27	const exe = b.addExecutable(.{
28	.name = "test",
29	.root_source_file = b.path("inctest.zig"),
30	.target = b.graph.host,
31	.optimize = optimize,
32	});
33	exe.addIncludePath(dir);
34	b.step("copydir", "").dependOn(&exe.step);
35	test_step.dependOn(&exe.step);
36	}
37	}

test/standalone/dep_lazypath/inc/foo.h created+1

...	@@ -0,0 +1 @@
1	#define foo_value 42

test/standalone/dep_lazypath/inctest.zig created+8

...	@@ -0,0 +1,8 @@
1	const std = @import("std");
2	const c = @cImport({
3	@cInclude("foo.h");
4	});
5	comptime {
6	std.debug.assert(c.foo_value == 42);
7	}
8	pub fn main() void {}

test/tests.zig+2-2

...	@@ -783,7 +783,7 @@ pub fn addCliTests(b: std.Build) Step {	...	@@ -783,7 +783,7 @@ pub fn addCliTests(b: std.Build) Step {
783	if (builtin.os.tag == .linux and builtin.cpu.arch == .x86_64) {	783	if (builtin.os.tag == .linux and builtin.cpu.arch == .x86_64) {
784	const tmp_path = b.makeTempPath();	784	const tmp_path = b.makeTempPath();
785		785
786	const writefile = b.addWriteFile("example.zig",	786	const example_zig = b.addWriteFiles().add("example.zig",
787	\\// Type your code here, or load an example.	787	\\// Type your code here, or load an example.
788	\\export fn square(num: i32) i32 {	788	\\export fn square(num: i32) i32 {
789	\\ return num * num;	789	\\ return num * num;
...	@@ -804,7 +804,7 @@ pub fn addCliTests(b: std.Build) Step {	...	@@ -804,7 +804,7 @@ pub fn addCliTests(b: std.Build) Step {
804	"-fno-emit-bin", "-fno-emit-h",	804	"-fno-emit-bin", "-fno-emit-h",
805	"-fstrip", "-OReleaseFast",	805	"-fstrip", "-OReleaseFast",
806	});	806	});
807	run.addFileArg(writefile.files.items[0].getPath());	807	run.addFileArg(example_zig);
808	const example_s = run.addPrefixedOutputFileArg("-femit-asm=", "example.s");	808	const example_s = run.addPrefixedOutputFileArg("-femit-asm=", "example.s");
809		809
810	const checkfile = b.addCheckFile(example_s, .{	810	const checkfile = b.addCheckFile(example_s, .{