authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2024-07-15 01:27:23-07:00
committergravatar for noreply@github.comGitHub <noreply@github.com> 2024-07-15 01:27:23-07:00
log9d38e82b5c0f28ea6a2d8d31ebd73b6e2a8aad26
treeba3290d61fd4c856f73a14b6346c674a1a178ffb
parent583e698256a2a26f26738c983e319d76926ef048
parent445bd7a06fc34c9a59c6458774769bfaa2757a2f
signaturebadge-check Signed by PGP key B5690EEEBB952194

Merge pull request #20633 from ziglang/long-live-zig

make zig compiler processes live across rebuilds

27 files changed, 285 insertions(+), 105 deletions(-)

lib/compiler/build_runner.zig+21-3
......@@ -235,6 +235,10 @@ pub fn main() !void {
235235 prominent_compile_errors = true;
236236 } else if (mem.eql(u8, arg, "--watch")) {
237237 watch = true;
238 } else if (mem.eql(u8, arg, "-fincremental")) {
239 graph.incremental = true;
240 } else if (mem.eql(u8, arg, "-fno-incremental")) {
241 graph.incremental = false;
238242 } else if (mem.eql(u8, arg, "-fwine")) {
239243 builder.enable_wine = true;
240244 } else if (mem.eql(u8, arg, "-fno-wine")) {
......@@ -406,8 +410,8 @@ pub fn main() !void {
406410 // trigger a rebuild on all steps with modified inputs, as well as their
407411 // recursive dependants.
408412 var caption_buf: [std.Progress.Node.max_name_len]u8 = undefined;
409 const caption = std.fmt.bufPrint(&caption_buf, "Watching {d} Directories", .{
410 w.dir_table.entries.len,
413 const caption = std.fmt.bufPrint(&caption_buf, "watching {d} directories, {d} processes", .{
414 w.dir_table.entries.len, countSubProcesses(run.step_stack.keys()),
411415 }) catch &caption_buf;
412416 var debouncing_node = main_progress_node.start(caption, 0);
413417 var debounce_timeout: Watch.Timeout = .none;
......@@ -440,6 +444,14 @@ fn markFailedStepsDirty(gpa: Allocator, all_steps: []const *Step) void {
440444 };
441445}
442446
447fn countSubProcesses(all_steps: []const *Step) usize {
448 var count: usize = 0;
449 for (all_steps) |s| {
450 count += @intFromBool(s.getZigProcess() != null);
451 }
452 return count;
453}
454
443455const Run = struct {
444456 max_rss: u64,
445457 max_rss_is_default: bool,
......@@ -1031,7 +1043,11 @@ fn workerMakeOneStep(
10311043 const sub_prog_node = prog_node.start(s.name, 0);
10321044 defer sub_prog_node.end();
10331045
1034 const make_result = s.make(sub_prog_node);
1046 const make_result = s.make(.{
1047 .progress_node = sub_prog_node,
1048 .thread_pool = thread_pool,
1049 .watch = run.watch,
1050 });
10351051
10361052 // No matter the result, we want to display error/warning messages.
10371053 const show_compile_errors = !run.prominent_compile_errors and
......@@ -1212,6 +1228,8 @@ fn usage(b: *std.Build, out_stream: anytype) !void {
12121228 \\ --fetch Exit after fetching dependency tree
12131229 \\ --watch Continuously rebuild when source files are modified
12141230 \\ --debounce <ms> Delay before rebuilding after changed file detected
1231 \\ -fincremental Enable incremental compilation
1232 \\ -fno-incremental Disable incremental compilation
12151233 \\
12161234 \\Project-Specific Options:
12171235 \\
lib/std/Build.zig+3-2
......@@ -120,6 +120,7 @@ pub const Graph = struct {
120120 needed_lazy_dependencies: std.StringArrayHashMapUnmanaged(void) = .{},
121121 /// Information about the native target. Computed before build() is invoked.
122122 host: ResolvedTarget,
123 incremental: ?bool = null,
123124};
124125
125126const AvailableDeps = []const struct { []const u8, []const u8 };
......@@ -1078,8 +1079,8 @@ pub fn getUninstallStep(b: *Build) *Step {
10781079 return &b.uninstall_tls.step;
10791080}
10801081
1081fn makeUninstall(uninstall_step: *Step, prog_node: std.Progress.Node) anyerror!void {
1082 _ = prog_node;
1082fn makeUninstall(uninstall_step: *Step, options: Step.MakeOptions) anyerror!void {
1083 _ = options;
10831084 const uninstall_tls: *TopLevelStep = @fieldParentPtr("step", uninstall_step);
10841085 const b: *Build = @fieldParentPtr("uninstall_tls", uninstall_tls);
10851086
lib/std/Build/Step.zig+157-44
......@@ -68,7 +68,13 @@ pub const TestResults = struct {
6868 }
6969};
7070
71pub const MakeFn = *const fn (step: *Step, prog_node: std.Progress.Node) anyerror!void;
71pub const MakeOptions = struct {
72 progress_node: std.Progress.Node,
73 thread_pool: *std.Thread.Pool,
74 watch: bool,
75};
76
77pub const MakeFn = *const fn (step: *Step, options: MakeOptions) anyerror!void;
7278
7379pub const State = enum {
7480 precheck_unstarted,
......@@ -219,10 +225,10 @@ pub fn init(options: StepOptions) Step {
219225/// If the Step's `make` function reports `error.MakeFailed`, it indicates they
220226/// have already reported the error. Otherwise, we add a simple error report
221227/// here.
222pub fn make(s: *Step, prog_node: std.Progress.Node) error{ MakeFailed, MakeSkipped }!void {
228pub fn make(s: *Step, options: MakeOptions) error{ MakeFailed, MakeSkipped }!void {
223229 const arena = s.owner.allocator;
224230
225 s.makeFn(s, prog_node) catch |err| switch (err) {
231 s.makeFn(s, options) catch |err| switch (err) {
226232 error.MakeFailed => return error.MakeFailed,
227233 error.MakeSkipped => return error.MakeSkipped,
228234 else => {
......@@ -260,8 +266,8 @@ pub fn getStackTrace(s: *Step) ?std.builtin.StackTrace {
260266 };
261267}
262268
263fn makeNoOp(step: *Step, prog_node: std.Progress.Node) anyerror!void {
264 _ = prog_node;
269fn makeNoOp(step: *Step, options: MakeOptions) anyerror!void {
270 _ = options;
265271
266272 var all_cached = true;
267273
......@@ -352,13 +358,54 @@ pub fn addError(step: *Step, comptime fmt: []const u8, args: anytype) error{OutO
352358 try step.result_error_msgs.append(arena, msg);
353359}
354360
361pub const ZigProcess = struct {
362 child: std.process.Child,
363 poller: std.io.Poller(StreamEnum),
364 progress_ipc_fd: if (std.Progress.have_ipc) ?std.posix.fd_t else void,
365
366 pub const StreamEnum = enum { stdout, stderr };
367};
368
355369/// Assumes that argv contains `--listen=-` and that the process being spawned
356370/// is the zig compiler - the same version that compiled the build runner.
357371pub fn evalZigProcess(
358372 s: *Step,
359373 argv: []const []const u8,
360374 prog_node: std.Progress.Node,
375 watch: bool,
361376) !?[]const u8 {
377 if (s.getZigProcess()) |zp| update: {
378 assert(watch);
379 if (std.Progress.have_ipc) if (zp.progress_ipc_fd) |fd| prog_node.setIpcFd(fd);
380 const result = zigProcessUpdate(s, zp, watch) catch |err| switch (err) {
381 error.BrokenPipe => {
382 // Process restart required.
383 const term = zp.child.wait() catch |e| {
384 return s.fail("unable to wait for {s}: {s}", .{ argv[0], @errorName(e) });
385 };
386 _ = term;
387 s.clearZigProcess();
388 break :update;
389 },
390 else => |e| return e,
391 };
392
393 if (s.result_error_bundle.errorMessageCount() > 0)
394 return s.fail("{d} compilation errors", .{s.result_error_bundle.errorMessageCount()});
395
396 if (s.result_error_msgs.items.len > 0 and result == null) {
397 // Crash detected.
398 const term = zp.child.wait() catch |e| {
399 return s.fail("unable to wait for {s}: {s}", .{ argv[0], @errorName(e) });
400 };
401 s.result_peak_rss = zp.child.resource_usage_statistics.getMaxRss() orelse 0;
402 s.clearZigProcess();
403 try handleChildProcessTerm(s, term, null, argv);
404 return error.MakeFailed;
405 }
406
407 return result;
408 }
362409 assert(argv.len != 0);
363410 const b = s.owner;
364411 const arena = b.allocator;
......@@ -378,29 +425,79 @@ pub fn evalZigProcess(
378425 child.spawn() catch |err| return s.fail("unable to spawn {s}: {s}", .{
379426 argv[0], @errorName(err),
380427 });
381 var timer = try std.time.Timer.start();
382428
383 var poller = std.io.poll(gpa, enum { stdout, stderr }, .{
384 .stdout = child.stdout.?,
385 .stderr = child.stderr.?,
386 });
387 defer poller.deinit();
429 const zp = try gpa.create(ZigProcess);
430 zp.* = .{
431 .child = child,
432 .poller = std.io.poll(gpa, ZigProcess.StreamEnum, .{
433 .stdout = child.stdout.?,
434 .stderr = child.stderr.?,
435 }),
436 .progress_ipc_fd = if (std.Progress.have_ipc) child.progress_node.getIpcFd() else {},
437 };
438 if (watch) s.setZigProcess(zp);
439 defer if (!watch) zp.poller.deinit();
440
441 const result = try zigProcessUpdate(s, zp, watch);
442
443 if (!watch) {
444 // Send EOF to stdin.
445 zp.child.stdin.?.close();
446 zp.child.stdin = null;
447
448 const term = zp.child.wait() catch |err| {
449 return s.fail("unable to wait for {s}: {s}", .{ argv[0], @errorName(err) });
450 };
451 s.result_peak_rss = zp.child.resource_usage_statistics.getMaxRss() orelse 0;
452
453 // Special handling for Compile step that is expecting compile errors.
454 if (s.cast(Compile)) |compile| switch (term) {
455 .Exited => {
456 // Note that the exit code may be 0 in this case due to the
457 // compiler server protocol.
458 if (compile.expect_errors != null) {
459 return error.NeedCompileErrorCheck;
460 }
461 },
462 else => {},
463 };
464
465 try handleChildProcessTerm(s, term, null, argv);
466 }
467
468 // This is intentionally printed for failure on the first build but not for
469 // subsequent rebuilds.
470 if (s.result_error_bundle.errorMessageCount() > 0) {
471 return s.fail("the following command failed with {d} compilation errors:\n{s}", .{
472 s.result_error_bundle.errorMessageCount(),
473 try allocPrintCmd(arena, null, argv),
474 });
475 }
388476
389 try sendMessage(child.stdin.?, .update);
390 try sendMessage(child.stdin.?, .exit);
477 return result;
478}
479
480fn zigProcessUpdate(s: *Step, zp: *ZigProcess, watch: bool) !?[]const u8 {
481 const b = s.owner;
482 const arena = b.allocator;
483
484 var timer = try std.time.Timer.start();
485
486 try sendMessage(zp.child.stdin.?, .update);
487 if (!watch) try sendMessage(zp.child.stdin.?, .exit);
391488
392489 const Header = std.zig.Server.Message.Header;
393490 var result: ?[]const u8 = null;
394491
395 const stdout = poller.fifo(.stdout);
492 const stdout = zp.poller.fifo(.stdout);
396493
397494 poll: while (true) {
398495 while (stdout.readableLength() < @sizeOf(Header)) {
399 if (!(try poller.poll())) break :poll;
496 if (!(try zp.poller.poll())) break :poll;
400497 }
401498 const header = stdout.reader().readStruct(Header) catch unreachable;
402499 while (stdout.readableLength() < header.bytes_len) {
403 if (!(try poller.poll())) break :poll;
500 if (!(try zp.poller.poll())) break :poll;
404501 }
405502 const body = stdout.readableSliceOfLen(header.bytes_len);
406503
......@@ -428,12 +525,22 @@ pub fn evalZigProcess(
428525 .string_bytes = try arena.dupe(u8, string_bytes),
429526 .extra = extra_array,
430527 };
528 if (watch) {
529 // This message indicates the end of the update.
530 stdout.discard(body.len);
531 break;
532 }
431533 },
432534 .emit_bin_path => {
433535 const EbpHdr = std.zig.Server.Message.EmitBinPath;
434536 const ebp_hdr = @as(*align(1) const EbpHdr, @ptrCast(body));
435537 s.result_cached = ebp_hdr.flags.cache_hit;
436538 result = try arena.dupe(u8, body[@sizeOf(EbpHdr)..]);
539 if (watch) {
540 // This message indicates the end of the update.
541 stdout.discard(body.len);
542 break;
543 }
437544 },
438545 .file_system_inputs => {
439546 s.clearWatchInputs();
......@@ -470,6 +577,13 @@ pub fn evalZigProcess(
470577 };
471578 try addWatchInputFromPath(s, path, std.fs.path.basename(sub_path));
472579 },
580 .global_cache => {
581 const path: Build.Cache.Path = .{
582 .root_dir = s.owner.graph.global_cache_root,
583 .sub_path = sub_path_dirname,
584 };
585 try addWatchInputFromPath(s, path, std.fs.path.basename(sub_path));
586 },
473587 }
474588 }
475589 },
......@@ -479,43 +593,42 @@ pub fn evalZigProcess(
479593 stdout.discard(body.len);
480594 }
481595
482 const stderr = poller.fifo(.stderr);
596 s.result_duration_ns = timer.read();
597
598 const stderr = zp.poller.fifo(.stderr);
483599 if (stderr.readableLength() > 0) {
484600 try s.result_error_msgs.append(arena, try stderr.toOwnedSlice());
485601 }
486602
487 // Send EOF to stdin.
488 child.stdin.?.close();
489 child.stdin = null;
603 return result;
604}
490605
491 const term = child.wait() catch |err| {
492 return s.fail("unable to wait for {s}: {s}", .{ argv[0], @errorName(err) });
493 };
494 s.result_duration_ns = timer.read();
495 s.result_peak_rss = child.resource_usage_statistics.getMaxRss() orelse 0;
496
497 // Special handling for Compile step that is expecting compile errors.
498 if (s.cast(Compile)) |compile| switch (term) {
499 .Exited => {
500 // Note that the exit code may be 0 in this case due to the
501 // compiler server protocol.
502 if (compile.expect_errors != null) {
503 return error.NeedCompileErrorCheck;
504 }
505 },
506 else => {},
606pub fn getZigProcess(s: *Step) ?*ZigProcess {
607 return switch (s.id) {
608 .compile => s.cast(Compile).?.zig_process,
609 else => null,
507610 };
611}
508612
509 try handleChildProcessTerm(s, term, null, argv);
510
511 if (s.result_error_bundle.errorMessageCount() > 0) {
512 return s.fail("the following command failed with {d} compilation errors:\n{s}", .{
513 s.result_error_bundle.errorMessageCount(),
514 try allocPrintCmd(arena, null, argv),
515 });
613fn setZigProcess(s: *Step, zp: *ZigProcess) void {
614 switch (s.id) {
615 .compile => s.cast(Compile).?.zig_process = zp,
616 else => unreachable,
516617 }
618}
517619
518 return result;
620fn clearZigProcess(s: *Step) void {
621 const gpa = s.owner.allocator;
622 switch (s.id) {
623 .compile => {
624 const compile = s.cast(Compile).?;
625 if (compile.zig_process) |zp| {
626 gpa.destroy(zp);
627 compile.zig_process = null;
628 }
629 },
630 else => unreachable,
631 }
519632}
520633
521634fn sendMessage(file: std.fs.File, tag: std.zig.Client.Message.Tag) !void {
lib/std/Build/Step/CheckFile.zig+2-2
......@@ -46,8 +46,8 @@ pub fn setName(check_file: *CheckFile, name: []const u8) void {
4646 check_file.step.name = name;
4747}
4848
49fn make(step: *Step, prog_node: std.Progress.Node) !void {
50 _ = prog_node;
49fn make(step: *Step, options: Step.MakeOptions) !void {
50 _ = options;
5151 const b = step.owner;
5252 const check_file: *CheckFile = @fieldParentPtr("step", step);
5353 try step.singleUnchangingWatchInput(check_file.source);
lib/std/Build/Step/CheckObject.zig+2-2
......@@ -550,8 +550,8 @@ pub fn checkComputeCompare(
550550 check_object.checks.append(check) catch @panic("OOM");
551551}
552552
553fn make(step: *Step, prog_node: std.Progress.Node) !void {
554 _ = prog_node;
553fn make(step: *Step, make_options: Step.MakeOptions) !void {
554 _ = make_options;
555555 const b = step.owner;
556556 const gpa = b.allocator;
557557 const check_object: *CheckObject = @fieldParentPtr("step", step);
lib/std/Build/Step/Compile.zig+14-2
......@@ -213,6 +213,10 @@ is_linking_libcpp: bool = false,
213213
214214no_builtin: bool = false,
215215
216/// Populated during the make phase when there is a long-lived compiler process.
217/// Managed by the build runner, not user build script.
218zig_process: ?*Step.ZigProcess,
219
216220pub const ExpectedCompileErrors = union(enum) {
217221 contains: []const u8,
218222 exact: []const []const u8,
......@@ -398,6 +402,8 @@ pub fn create(owner: *std.Build, options: Options) *Compile {
398402
399403 .use_llvm = options.use_llvm,
400404 .use_lld = options.use_lld,
405
406 .zig_process = null,
401407 };
402408
403409 compile.root_module.init(owner, options.root_module, compile);
......@@ -1673,6 +1679,8 @@ fn getZigArgs(compile: *Compile) ![][]const u8 {
16731679 b.fmt("{}", .{err_limit}),
16741680 });
16751681
1682 try addFlag(&zig_args, "incremental", b.graph.incremental);
1683
16761684 try zig_args.append("--listen=-");
16771685
16781686 // Windows has an argument length limit of 32,766 characters, macOS 262,144 and Linux
......@@ -1735,13 +1743,17 @@ fn getZigArgs(compile: *Compile) ![][]const u8 {
17351743 return try zig_args.toOwnedSlice();
17361744}
17371745
1738fn make(step: *Step, prog_node: std.Progress.Node) !void {
1746fn make(step: *Step, options: Step.MakeOptions) !void {
17391747 const b = step.owner;
17401748 const compile: *Compile = @fieldParentPtr("step", step);
17411749
17421750 const zig_args = try getZigArgs(compile);
17431751
1744 const maybe_output_bin_path = step.evalZigProcess(zig_args, prog_node) catch |err| switch (err) {
1752 const maybe_output_bin_path = step.evalZigProcess(
1753 zig_args,
1754 options.progress_node,
1755 (b.graph.incremental == true) and options.watch,
1756 ) catch |err| switch (err) {
17451757 error.NeedCompileErrorCheck => {
17461758 assert(compile.expect_errors != null);
17471759 try checkCompileErrors(compile);
lib/std/Build/Step/ConfigHeader.zig+2-2
......@@ -164,8 +164,8 @@ fn putValue(config_header: *ConfigHeader, field_name: []const u8, comptime T: ty
164164 }
165165}
166166
167fn make(step: *Step, prog_node: std.Progress.Node) !void {
168 _ = prog_node;
167fn make(step: *Step, options: Step.MakeOptions) !void {
168 _ = options;
169169 const b = step.owner;
170170 const config_header: *ConfigHeader = @fieldParentPtr("step", step);
171171 if (config_header.style.getPath()) |lp| try step.singleUnchangingWatchInput(lp);
lib/std/Build/Step/Fail.zig+2-2
......@@ -24,8 +24,8 @@ pub fn create(owner: *std.Build, error_msg: []const u8) *Fail {
2424 return fail;
2525}
2626
27fn make(step: *Step, prog_node: std.Progress.Node) !void {
28 _ = prog_node; // No progress to report.
27fn make(step: *Step, options: Step.MakeOptions) !void {
28 _ = options; // No progress to report.
2929
3030 const fail: *Fail = @fieldParentPtr("step", step);
3131
lib/std/Build/Step/Fmt.zig+3-1
......@@ -36,7 +36,9 @@ pub fn create(owner: *std.Build, options: Options) *Fmt {
3636 return fmt;
3737}
3838
39fn make(step: *Step, prog_node: std.Progress.Node) !void {
39fn make(step: *Step, options: Step.MakeOptions) !void {
40 const prog_node = options.progress_node;
41
4042 // TODO: if check=false, this means we are modifying source files in place, which
4143 // is an operation that could race against other operations also modifying source files
4244 // in place. In this case, this step should obtain a write lock while making those
lib/std/Build/Step/InstallArtifact.zig+2-2
......@@ -115,8 +115,8 @@ pub fn create(owner: *std.Build, artifact: *Step.Compile, options: Options) *Ins
115115 return install_artifact;
116116}
117117
118fn make(step: *Step, prog_node: std.Progress.Node) !void {
119 _ = prog_node;
118fn make(step: *Step, options: Step.MakeOptions) !void {
119 _ = options;
120120 const install_artifact: *InstallArtifact = @fieldParentPtr("step", step);
121121 const b = step.owner;
122122 const cwd = fs.cwd();
lib/std/Build/Step/InstallDir.zig+2-2
......@@ -55,8 +55,8 @@ pub fn create(owner: *std.Build, options: Options) *InstallDir {
5555 return install_dir;
5656}
5757
58fn make(step: *Step, prog_node: std.Progress.Node) !void {
59 _ = prog_node;
58fn make(step: *Step, options: Step.MakeOptions) !void {
59 _ = options;
6060 const b = step.owner;
6161 const install_dir: *InstallDir = @fieldParentPtr("step", step);
6262 step.clearWatchInputs();
lib/std/Build/Step/InstallFile.zig+2-2
......@@ -35,8 +35,8 @@ pub fn create(
3535 return install_file;
3636}
3737
38fn make(step: *Step, prog_node: std.Progress.Node) !void {
39 _ = prog_node;
38fn make(step: *Step, options: Step.MakeOptions) !void {
39 _ = options;
4040 const b = step.owner;
4141 const install_file: *InstallFile = @fieldParentPtr("step", step);
4242 try step.singleUnchangingWatchInput(install_file.source);
lib/std/Build/Step/ObjCopy.zig+3-2
......@@ -90,7 +90,8 @@ pub fn getOutputSeparatedDebug(objcopy: *const ObjCopy) ?std.Build.LazyPath {
9090 return if (objcopy.output_file_debug) |*file| .{ .generated = .{ .file = file } } else null;
9191}
9292
93fn make(step: *Step, prog_node: std.Progress.Node) !void {
93fn make(step: *Step, options: Step.MakeOptions) !void {
94 const prog_node = options.progress_node;
9495 const b = step.owner;
9596 const objcopy: *ObjCopy = @fieldParentPtr("step", step);
9697 try step.singleUnchangingWatchInput(objcopy.input_file);
......@@ -158,7 +159,7 @@ fn make(step: *Step, prog_node: std.Progress.Node) !void {
158159 try argv.appendSlice(&.{ full_src_path, full_dest_path });
159160
160161 try argv.append("--listen=-");
161 _ = try step.evalZigProcess(argv.items, prog_node);
162 _ = try step.evalZigProcess(argv.items, prog_node, false);
162163
163164 objcopy.output_file.path = full_dest_path;
164165 if (objcopy.output_file_debug) |*file| file.path = full_dest_path_debug;
lib/std/Build/Step/Options.zig+3-3
......@@ -410,9 +410,9 @@ pub fn getOutput(options: *Options) LazyPath {
410410 return .{ .generated = .{ .file = &options.generated_file } };
411411}
412412
413fn make(step: *Step, prog_node: std.Progress.Node) !void {
414 // This step completes so quickly that no progress is necessary.
415 _ = prog_node;
413fn make(step: *Step, make_options: Step.MakeOptions) !void {
414 // This step completes so quickly that no progress reporting is necessary.
415 _ = make_options;
416416
417417 const b = step.owner;
418418 const options: *Options = @fieldParentPtr("step", step);
lib/std/Build/Step/RemoveDir.zig+2-4
......@@ -23,10 +23,8 @@ pub fn create(owner: *std.Build, doomed_path: LazyPath) *RemoveDir {
2323 return remove_dir;
2424}
2525
26fn make(step: *Step, prog_node: std.Progress.Node) !void {
27 // TODO update progress node while walking file system.
28 // Should the standard library support this use case??
29 _ = prog_node;
26fn make(step: *Step, options: Step.MakeOptions) !void {
27 _ = options;
3028
3129 const b = step.owner;
3230 const remove_dir: *RemoveDir = @fieldParentPtr("step", step);
lib/std/Build/Step/Run.zig+2-1
......@@ -595,7 +595,8 @@ const IndexedOutput = struct {
595595 tag: @typeInfo(Arg).Union.tag_type.?,
596596 output: *Output,
597597};
598fn make(step: *Step, prog_node: std.Progress.Node) !void {
598fn make(step: *Step, options: Step.MakeOptions) !void {
599 const prog_node = options.progress_node;
599600 const b = step.owner;
600601 const arena = b.allocator;
601602 const run: *Run = @fieldParentPtr("step", step);
lib/std/Build/Step/TranslateC.zig+3-2
......@@ -116,7 +116,8 @@ pub fn defineCMacroRaw(translate_c: *TranslateC, name_and_value: []const u8) voi
116116 translate_c.c_macros.append(translate_c.step.owner.dupe(name_and_value)) catch @panic("OOM");
117117}
118118
119fn make(step: *Step, prog_node: std.Progress.Node) !void {
119fn make(step: *Step, options: Step.MakeOptions) !void {
120 const prog_node = options.progress_node;
120121 const b = step.owner;
121122 const translate_c: *TranslateC = @fieldParentPtr("step", step);
122123
......@@ -154,7 +155,7 @@ fn make(step: *Step, prog_node: std.Progress.Node) !void {
154155
155156 try argv_list.append(translate_c.source.getPath2(b, step));
156157
157 const output_path = try step.evalZigProcess(argv_list.items, prog_node);
158 const output_path = try step.evalZigProcess(argv_list.items, prog_node, false);
158159
159160 translate_c.out_basename = fs.path.basename(output_path.?);
160161 const output_dir = fs.path.dirname(output_path.?).?;
lib/std/Build/Step/UpdateSourceFiles.zig+2-2
......@@ -67,8 +67,8 @@ pub fn addBytesToSource(usf: *UpdateSourceFiles, bytes: []const u8, sub_path: []
6767 }) catch @panic("OOM");
6868}
6969
70fn make(step: *Step, prog_node: std.Progress.Node) !void {
71 _ = prog_node;
70fn make(step: *Step, options: Step.MakeOptions) !void {
71 _ = options;
7272 const b = step.owner;
7373 const usf: *UpdateSourceFiles = @fieldParentPtr("step", step);
7474
lib/std/Build/Step/WriteFile.zig+2-2
......@@ -171,8 +171,8 @@ fn maybeUpdateName(write_file: *WriteFile) void {
171171 }
172172}
173173
174fn make(step: *Step, prog_node: std.Progress.Node) !void {
175 _ = prog_node;
174fn make(step: *Step, options: Step.MakeOptions) !void {
175 _ = options;
176176 const b = step.owner;
177177 const arena = b.allocator;
178178 const gpa = arena;
lib/std/Progress.zig+18
......@@ -269,6 +269,19 @@ pub const Node = struct {
269269 storageByIndex(index).setIpcFd(fd);
270270 }
271271
272 /// Posix-only. Thread-safe. Assumes the node is storing an IPC file
273 /// descriptor.
274 pub fn getIpcFd(node: Node) ?posix.fd_t {
275 const index = node.index.unwrap() orelse return null;
276 const storage = storageByIndex(index);
277 const int = @atomicLoad(u32, &storage.completed_count, .monotonic);
278 return switch (@typeInfo(posix.fd_t)) {
279 .Int => @bitCast(int),
280 .Pointer => @ptrFromInt(int),
281 else => @compileError("unsupported fd_t of " ++ @typeName(posix.fd_t)),
282 };
283 }
284
272285 fn storageByIndex(index: Node.Index) *Node.Storage {
273286 return &global_progress.node_storage[@intFromEnum(index)];
274287 }
......@@ -329,6 +342,11 @@ var default_draw_buffer: [4096]u8 = undefined;
329342
330343var debug_start_trace = std.debug.Trace.init;
331344
345pub const have_ipc = switch (builtin.os.tag) {
346 .wasi, .freestanding, .windows => false,
347 else => true,
348};
349
332350const noop_impl = builtin.single_threaded or switch (builtin.os.tag) {
333351 .wasi, .freestanding => true,
334352 else => false,
lib/std/zig/Server.zig+1
......@@ -36,6 +36,7 @@ pub const Message = struct {
3636 cwd,
3737 zig_lib,
3838 local_cache,
39 global_cache,
3940 };
4041
4142 /// Trailing:
src/Compilation.zig+5-4
......@@ -169,7 +169,7 @@ time_report: bool,
169169stack_report: bool,
170170debug_compiler_runtime_libs: bool,
171171debug_compile_errors: bool,
172debug_incremental: bool,
172incremental: bool,
173173job_queued_compiler_rt_lib: bool = false,
174174job_queued_compiler_rt_obj: bool = false,
175175job_queued_update_builtin_zig: bool,
......@@ -1134,7 +1134,7 @@ pub const CreateOptions = struct {
11341134 verbose_llvm_cpu_features: bool = false,
11351135 debug_compiler_runtime_libs: bool = false,
11361136 debug_compile_errors: bool = false,
1137 debug_incremental: bool = false,
1137 incremental: bool = false,
11381138 /// Normally when you create a `Compilation`, Zig will automatically build
11391139 /// and link in required dependencies, such as compiler-rt and libc. When
11401140 /// building such dependencies themselves, this flag must be set to avoid
......@@ -1363,6 +1363,7 @@ pub fn create(gpa: Allocator, arena: Allocator, options: CreateOptions) !*Compil
13631363 cache.addPrefix(.{ .path = null, .handle = std.fs.cwd() });
13641364 cache.addPrefix(options.zig_lib_directory);
13651365 cache.addPrefix(options.local_cache_directory);
1366 cache.addPrefix(options.global_cache_directory);
13661367 errdefer cache.manifest_dir.close();
13671368
13681369 // This is shared hasher state common to zig source and all C source files.
......@@ -1515,7 +1516,7 @@ pub fn create(gpa: Allocator, arena: Allocator, options: CreateOptions) !*Compil
15151516 .test_name_prefix = options.test_name_prefix,
15161517 .debug_compiler_runtime_libs = options.debug_compiler_runtime_libs,
15171518 .debug_compile_errors = options.debug_compile_errors,
1518 .debug_incremental = options.debug_incremental,
1519 .incremental = options.incremental,
15191520 .libcxx_abi_version = options.libcxx_abi_version,
15201521 .root_name = root_name,
15211522 .sysroot = sysroot,
......@@ -2358,7 +2359,7 @@ pub fn update(comp: *Compilation, main_progress_node: std.Progress.Node) !void {
23582359 }
23592360}
23602361
2361fn appendFileSystemInput(
2362pub fn appendFileSystemInput(
23622363 comp: *Compilation,
23632364 file_system_inputs: *std.ArrayListUnmanaged(u8),
23642365 root: Cache.Path,
src/Sema.zig+6-6
......@@ -2726,7 +2726,7 @@ fn maybeRemoveOutdatedType(sema: *Sema, ty: InternPool.Index) !bool {
27262726 const pt = sema.pt;
27272727 const zcu = pt.zcu;
27282728
2729 if (!zcu.comp.debug_incremental) return false;
2729 if (!zcu.comp.incremental) return false;
27302730
27312731 const decl_index = Type.fromInterned(ty).getOwnerDecl(zcu);
27322732 const decl_as_depender = AnalUnit.wrap(.{ .decl = decl_index });
......@@ -2826,7 +2826,7 @@ fn zirStructDecl(
28262826 mod.declPtr(new_decl_index).owns_tv = true;
28272827 errdefer pt.abortAnonDecl(new_decl_index);
28282828
2829 if (pt.zcu.comp.debug_incremental) {
2829 if (pt.zcu.comp.incremental) {
28302830 try ip.addDependency(
28312831 sema.gpa,
28322832 AnalUnit.wrap(.{ .decl = new_decl_index }),
......@@ -3064,7 +3064,7 @@ fn zirEnumDecl(
30643064 new_decl.owns_tv = true;
30653065 errdefer if (!done) pt.abortAnonDecl(new_decl_index);
30663066
3067 if (pt.zcu.comp.debug_incremental) {
3067 if (pt.zcu.comp.incremental) {
30683068 try mod.intern_pool.addDependency(
30693069 gpa,
30703070 AnalUnit.wrap(.{ .decl = new_decl_index }),
......@@ -3331,7 +3331,7 @@ fn zirUnionDecl(
33313331 mod.declPtr(new_decl_index).owns_tv = true;
33323332 errdefer pt.abortAnonDecl(new_decl_index);
33333333
3334 if (pt.zcu.comp.debug_incremental) {
3334 if (pt.zcu.comp.incremental) {
33353335 try mod.intern_pool.addDependency(
33363336 gpa,
33373337 AnalUnit.wrap(.{ .decl = new_decl_index }),
......@@ -3421,7 +3421,7 @@ fn zirOpaqueDecl(
34213421 mod.declPtr(new_decl_index).owns_tv = true;
34223422 errdefer pt.abortAnonDecl(new_decl_index);
34233423
3424 if (pt.zcu.comp.debug_incremental) {
3424 if (pt.zcu.comp.incremental) {
34253425 try ip.addDependency(
34263426 gpa,
34273427 AnalUnit.wrap(.{ .decl = new_decl_index }),
......@@ -38104,7 +38104,7 @@ fn isKnownZigType(sema: *Sema, ref: Air.Inst.Ref, tag: std.builtin.TypeId) bool
3810438104
3810538105pub fn declareDependency(sema: *Sema, dependee: InternPool.Dependee) !void {
3810638106 const zcu = sema.pt.zcu;
38107 if (!zcu.comp.debug_incremental) return;
38107 if (!zcu.comp.incremental) return;
3810838108
3810938109 // Avoid creating dependencies on ourselves. This situation can arise when we analyze the fields
3811038110 // of a type and they use `@This()`. This dependency would be unnecessary, and in fact would
src/Zcu.zig+1-1
......@@ -2679,7 +2679,7 @@ fn markTransitiveDependersPotentiallyOutdated(zcu: *Zcu, maybe_outdated: AnalUni
26792679}
26802680
26812681pub fn findOutdatedToAnalyze(zcu: *Zcu) Allocator.Error!?AnalUnit {
2682 if (!zcu.comp.debug_incremental) return null;
2682 if (!zcu.comp.incremental) return null;
26832683
26842684 if (zcu.outdated.count() == 0 and zcu.potentially_outdated.count() == 0) {
26852685 log.debug("findOutdatedToAnalyze: no outdated depender", .{});
src/Zcu/PerThread.zig+9-1
......@@ -888,7 +888,7 @@ fn getFileRootStruct(
888888 };
889889 errdefer wip_ty.cancel(ip, pt.tid);
890890
891 if (zcu.comp.debug_incremental) {
891 if (zcu.comp.incremental) {
892892 try ip.addDependency(
893893 gpa,
894894 InternPool.AnalUnit.wrap(.{ .decl = decl_index }),
......@@ -1418,6 +1418,10 @@ pub fn importPkg(pt: Zcu.PerThread, mod: *Module) !Zcu.ImportFileResult {
14181418 const sub_file_path = try gpa.dupe(u8, mod.root_src_path);
14191419 errdefer gpa.free(sub_file_path);
14201420
1421 const comp = zcu.comp;
1422 if (comp.file_system_inputs) |fsi|
1423 try comp.appendFileSystemInput(fsi, mod.root, sub_file_path);
1424
14211425 const new_file = try gpa.create(Zcu.File);
14221426 errdefer gpa.destroy(new_file);
14231427
......@@ -1527,6 +1531,10 @@ pub fn importFile(
15271531 resolved_root_path, resolved_path, sub_file_path, import_string,
15281532 });
15291533
1534 const comp = zcu.comp;
1535 if (comp.file_system_inputs) |fsi|
1536 try comp.appendFileSystemInput(fsi, mod.root, sub_file_path);
1537
15301538 const path_digest = zcu.computePathDigest(mod, sub_file_path);
15311539 const new_file_index = try ip.createFile(gpa, pt.tid, .{
15321540 .bin_digest = path_digest,
src/main.zig+14-9
......@@ -404,6 +404,8 @@ const usage_build_generic =
404404 \\ -h, --help Print this help and exit
405405 \\ --color [auto|off|on] Enable or disable colored error messages
406406 \\ -j<N> Limit concurrent jobs (default is to use all CPU cores)
407 \\ -fincremental Enable incremental compilation
408 \\ -fno-incremental Disable incremental compilation
407409 \\ -femit-bin[=path] (default) Output machine code
408410 \\ -fno-emit-bin Do not output machine code
409411 \\ -femit-asm[=path] Output .s (assembly code)
......@@ -642,7 +644,6 @@ const usage_build_generic =
642644 \\ --debug-log [scope] Enable printing debug/info log messages for scope
643645 \\ --debug-compile-errors Crash with helpful diagnostics at the first compile error
644646 \\ --debug-link-snapshot Enable dumping of the linker's state in JSON format
645 \\ --debug-incremental Enable experimental feature: incremental compilation
646647 \\
647648;
648649
......@@ -904,7 +905,7 @@ fn buildOutputType(
904905 var minor_subsystem_version: ?u16 = null;
905906 var mingw_unicode_entry_point: bool = false;
906907 var enable_link_snapshots: bool = false;
907 var debug_incremental: bool = false;
908 var opt_incremental: ?bool = null;
908909 var install_name: ?[]const u8 = null;
909910 var hash_style: link.File.Elf.HashStyle = .both;
910911 var entitlements: ?[]const u8 = null;
......@@ -1357,8 +1358,10 @@ fn buildOutputType(
13571358 } else {
13581359 enable_link_snapshots = true;
13591360 }
1360 } else if (mem.eql(u8, arg, "--debug-incremental")) {
1361 debug_incremental = true;
1361 } else if (mem.eql(u8, arg, "-fincremental")) {
1362 opt_incremental = true;
1363 } else if (mem.eql(u8, arg, "-fno-incremental")) {
1364 opt_incremental = false;
13621365 } else if (mem.eql(u8, arg, "--entitlements")) {
13631366 entitlements = args_iter.nextOrFatal();
13641367 } else if (mem.eql(u8, arg, "-fcompiler-rt")) {
......@@ -3225,6 +3228,8 @@ fn buildOutputType(
32253228 break :b .incremental;
32263229 };
32273230
3231 const incremental = opt_incremental orelse false;
3232
32283233 process.raiseFileDescriptorLimit();
32293234
32303235 var file_system_inputs: std.ArrayListUnmanaged(u8) = .{};
......@@ -3336,7 +3341,7 @@ fn buildOutputType(
33363341 .cache_mode = cache_mode,
33373342 .subsystem = subsystem,
33383343 .debug_compile_errors = debug_compile_errors,
3339 .debug_incremental = debug_incremental,
3344 .incremental = incremental,
33403345 .enable_link_snapshots = enable_link_snapshots,
33413346 .install_name = install_name,
33423347 .entitlements = entitlements,
......@@ -3443,7 +3448,7 @@ fn buildOutputType(
34433448 updateModule(comp, color, root_prog_node) catch |err| switch (err) {
34443449 error.SemanticAnalyzeFail => {
34453450 assert(listen == .none);
3446 saveState(comp, debug_incremental);
3451 saveState(comp, incremental);
34473452 process.exit(1);
34483453 },
34493454 else => |e| return e,
......@@ -3451,7 +3456,7 @@ fn buildOutputType(
34513456 }
34523457 if (build_options.only_c) return cleanExit();
34533458 try comp.makeBinFileExecutable();
3454 saveState(comp, debug_incremental);
3459 saveState(comp, incremental);
34553460
34563461 if (test_exec_args.items.len == 0 and target.ofmt == .c) default_exec_args: {
34573462 // Default to using `zig run` to execute the produced .c code from `zig test`.
......@@ -4032,8 +4037,8 @@ fn createModule(
40324037 return mod;
40334038}
40344039
4035fn saveState(comp: *Compilation, debug_incremental: bool) void {
4036 if (debug_incremental) {
4040fn saveState(comp: *Compilation, incremental: bool) void {
4041 if (incremental) {
40374042 comp.saveState() catch |err| {
40384043 warn("unable to save incremental compilation state: {s}", .{@errorName(err)});
40394044 };
test/standalone/cmakedefine/build.zig+2-2
......@@ -80,8 +80,8 @@ pub fn build(b: *std.Build) void {
8080 test_step.dependOn(&wrapper_header.step);
8181}
8282
83fn compare_headers(step: *std.Build.Step, prog_node: std.Progress.Node) !void {
84 _ = prog_node;
83fn compare_headers(step: *std.Build.Step, options: std.Build.Step.MakeOptions) !void {
84 _ = options;
8585 const allocator = step.owner.allocator;
8686 const expected_fmt = "expected_{s}";
8787