Skip to content

Fix std.Build.Step.Run directory caching #24438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix std.Build.Step.Run directory caching #24438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58dd73d
let std.Build.Step.WriteFile copy symlinks
silversquirl Jul 13, 2025
e9ba35d
make Build.Step.Run recursively cache and watch directory trees
silversquirl Jul 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 31 additions & 10 deletions lib/std/Build/Step/Run.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,13 +370,7 @@ pub fn addDirectoryArg(run: *Run, lazy_directory: std.Build.LazyPath) void {
}

pub fn addPrefixedDirectoryArg(run: *Run, prefix: []const u8, lazy_directory: std.Build.LazyPath) void {
const b = run.step.owner;
run.argv.append(b.allocator, .{ .decorated_directory = .{
.prefix = b.dupe(prefix),
.lazy_path = lazy_directory.dupe(b),
.suffix = "",
} }) catch @panic("OOM");
lazy_directory.addStepDependencies(&run.step);
run.addDecoratedDirectoryArg(prefix, lazy_directory, "");
}

pub fn addDecoratedDirectoryArg(
Expand Down Expand Up @@ -678,6 +672,8 @@ fn make(step: *Step, options: Step.MakeOptions) !void {
var argv_list = std.ArrayList([]const u8).init(arena);
var output_placeholders = std.ArrayList(IndexedOutput).init(arena);

step.clearWatchInputs();

var man = b.graph.cache.obtain();
defer man.deinit();

Expand Down Expand Up @@ -721,12 +717,35 @@ fn make(step: *Step, options: Step.MakeOptions) !void {
try argv_list.append(b.fmt("{s}{s}", .{ file.prefix, run.convertPathArg(file_path) }));
man.hash.addBytes(file.prefix);
_ = try man.addFilePath(file_path, null);
try step.addWatchInput(file.lazy_path);
},
.decorated_directory => |dd| {
const file_path = dd.lazy_path.getPath3(b, step);
const resolved_arg = b.fmt("{s}{s}{s}", .{ dd.prefix, run.convertPathArg(file_path), dd.suffix });
try argv_list.append(resolved_arg);

man.hash.addBytes(resolved_arg);

const need_derived_inputs = try step.addDirectoryWatchInput(dd.lazy_path);

var dir = file_path.root_dir.handle.openDir(file_path.subPathOrDot(), .{ .iterate = true }) catch |err| {
return step.fail("unable to open directory '{f}': {s}", .{
file_path, @errorName(err),
});
};

var it = try dir.walk(b.allocator);
defer it.deinit();
while (try it.next()) |entry| {
const entry_path = try file_path.join(arena, entry.path);
switch (entry.kind) {
.directory => if (need_derived_inputs) {
try step.addDirectoryWatchInputFromPath(entry_path);
},
.file, .sym_link => _ = try man.addFilePath(entry_path, null),
else => {},
}
}
},
.artifact => |pa| {
const artifact = pa.artifact;
Expand Down Expand Up @@ -767,6 +786,7 @@ fn make(step: *Step, options: Step.MakeOptions) !void {
.lazy_path => |lazy_path| {
const file_path = lazy_path.getPath2(b, step);
_ = try man.addFile(file_path, null);
try step.addWatchInput(lazy_path);
},
.none => {},
}
Expand All @@ -783,14 +803,15 @@ fn make(step: *Step, options: Step.MakeOptions) !void {

for (run.file_inputs.items) |lazy_path| {
_ = try man.addFile(lazy_path.getPath2(b, step), null);
try step.addWatchInput(lazy_path);
}

if (run.cwd) |cwd| {
const cwd_path = cwd.getPath3(b, step);
_ = man.hash.addBytes(try cwd_path.toString(arena));
}

if (!has_side_effects and try step.cacheHitAndWatch(&man)) {
if (!has_side_effects and try step.cacheHit(&man)) {
// cache hit, skip running command
const digest = man.final();

Expand Down Expand Up @@ -847,7 +868,7 @@ fn make(step: *Step, options: Step.MakeOptions) !void {
}

try runCommand(run, argv_list.items, has_side_effects, output_dir_path, prog_node, null);
if (!has_side_effects) try step.writeManifestAndWatch(&man);
if (!has_side_effects) try step.writeManifest(&man);
return;
};

Expand Down Expand Up @@ -926,7 +947,7 @@ fn make(step: *Step, options: Step.MakeOptions) !void {
};
}

if (!has_side_effects) try step.writeManifestAndWatch(&man);
if (!has_side_effects) try step.writeManifest(&man);

try populateGeneratedPaths(
arena,
Expand Down
4 changes: 2 additions & 2 deletions lib/std/Build/Step/WriteFile.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ fn make(step: *Step, options: Step.MakeOptions) !void {
try step.addDirectoryWatchInputFromPath(entry_path);
}
},
.file => {
.file, .sym_link => {
const entry_path = try src_dir_path.join(arena, entry.path);
_ = try man.addFilePath(entry_path, null);
},
Expand Down Expand Up @@ -330,7 +330,7 @@ fn make(step: *Step, options: Step.MakeOptions) !void {
const dest_path = b.pathJoin(&.{ dest_dirname, entry.path });
switch (entry.kind) {
.directory => try cache_dir.makePath(dest_path),
.file => {
.file, .sym_link => {
const prev_status = fs.Dir.updateFile(
src_entry_path.root_dir.handle,
src_entry_path.sub_path,
Expand Down
Loading