authorgravatar for 58830309+g-w1@users.noreply.github.comg-w1 <58830309+g-w1@users.noreply.github.com> 2020-12-25 19:40:49-05:00
committergravatar for noreply@github.comGitHub <noreply@github.com> 2020-12-26 02:40:49+02:00
log1634d45f1d53c8d7bfefa56ab4d2fa4cc8218b6d
tree85ec2c108a227da13542385d601364d7394e853b
parent939bd52c8a389993ab168ec9bb88c4e395045ac7
signaturebadge-question-mark Signed by PGP key 4AEE18F83AFDEB23

stage2: add compile log statement (#7191)

12 files changed, 119 insertions(+), 38 deletions(-)

src/Compilation.zig+13-12
......@@ -1350,8 +1350,11 @@ pub fn totalErrorCount(self: *Compilation) usize {
13501350 var total: usize = self.failed_c_objects.items().len;
13511351
13521352 if (self.bin_file.options.module) |module| {
1353 total += module.failed_decls.items().len +
1354 module.failed_exports.items().len +
1353 for (module.failed_decls.items()) |entry| {
1354 assert(entry.value.items.len > 0);
1355 total += entry.value.items.len;
1356 }
1357 total += module.failed_exports.items().len +
13551358 module.failed_files.items().len +
13561359 @boolToInt(module.failed_root_src_file != null);
13571360 }
......@@ -1385,9 +1388,11 @@ pub fn getAllErrorsAlloc(self: *Compilation) !AllErrors {
13851388 }
13861389 for (module.failed_decls.items()) |entry| {
13871390 const decl = entry.key;
1388 const err_msg = entry.value;
1389 const source = try decl.scope.getSource(module);
1390 try AllErrors.add(&arena, &errors, decl.scope.subFilePath(), source, err_msg.*);
1391 const err_msg_list = entry.value;
1392 for (err_msg_list.items) |err_msg| {
1393 const source = try decl.scope.getSource(module);
1394 try AllErrors.add(&arena, &errors, decl.scope.subFilePath(), source, err_msg.*);
1395 }
13911396 }
13921397 for (module.failed_exports.items()) |entry| {
13931398 const decl = entry.key.owner_decl;
......@@ -1480,7 +1485,6 @@ pub fn performAllTheWork(self: *Compilation) error{ TimerUnsupported, OutOfMemor
14801485 }
14811486
14821487 assert(decl.typed_value.most_recent.typed_value.ty.hasCodeGenBits());
1483
14841488 self.bin_file.updateDecl(module, decl) catch |err| {
14851489 switch (err) {
14861490 error.OutOfMemory => return error.OutOfMemory,
......@@ -1488,8 +1492,7 @@ pub fn performAllTheWork(self: *Compilation) error{ TimerUnsupported, OutOfMemor
14881492 decl.analysis = .dependency_failure;
14891493 },
14901494 else => {
1491 try module.failed_decls.ensureCapacity(module.gpa, module.failed_decls.items().len + 1);
1492 module.failed_decls.putAssumeCapacityNoClobber(decl, try ErrorMsg.create(
1495 try module.addDeclErr(decl, try ErrorMsg.create(
14931496 module.gpa,
14941497 decl.src(),
14951498 "unable to codegen: {}",
......@@ -1508,8 +1511,7 @@ pub fn performAllTheWork(self: *Compilation) error{ TimerUnsupported, OutOfMemor
15081511 decl.analysis = .dependency_failure;
15091512 },
15101513 else => {
1511 try module.failed_decls.ensureCapacity(module.gpa, module.failed_decls.items().len + 1);
1512 module.failed_decls.putAssumeCapacityNoClobber(decl, try ErrorMsg.create(
1514 try module.addDeclErr(decl, try ErrorMsg.create(
15131515 module.gpa,
15141516 decl.src(),
15151517 "unable to generate C header: {}",
......@@ -1531,8 +1533,7 @@ pub fn performAllTheWork(self: *Compilation) error{ TimerUnsupported, OutOfMemor
15311533 .update_line_number => |decl| {
15321534 const module = self.bin_file.options.module.?;
15331535 self.bin_file.updateDeclLineNumber(module, decl) catch |err| {
1534 try module.failed_decls.ensureCapacity(module.gpa, module.failed_decls.items().len + 1);
1535 module.failed_decls.putAssumeCapacityNoClobber(decl, try ErrorMsg.create(
1536 try module.addDeclErr(decl, try ErrorMsg.create(
15361537 module.gpa,
15371538 decl.src(),
15381539 "unable to update line number: {}",
src/Module.zig+29-17
......@@ -53,7 +53,7 @@ decl_table: std.ArrayHashMapUnmanaged(Scope.NameHash, *Decl, Scope.name_hash_has
5353/// The ErrorMsg memory is owned by the decl, using Module's general purpose allocator.
5454/// Note that a Decl can succeed but the Fn it represents can fail. In this case,
5555/// a Decl can have a failed_decls entry but have analysis status of success.
56failed_decls: std.AutoArrayHashMapUnmanaged(*Decl, *Compilation.ErrorMsg) = .{},
56failed_decls: std.AutoArrayHashMapUnmanaged(*Decl, ArrayListUnmanaged(*Compilation.ErrorMsg)) = .{},
5757/// Using a map here for consistency with the other fields here.
5858/// The ErrorMsg memory is owned by the `Scope`, using Module's general purpose allocator.
5959failed_files: std.AutoArrayHashMapUnmanaged(*Scope, *Compilation.ErrorMsg) = .{},
......@@ -845,8 +845,11 @@ pub fn deinit(self: *Module) void {
845845 }
846846 self.decl_table.deinit(gpa);
847847
848 for (self.failed_decls.items()) |entry| {
849 entry.value.destroy(gpa);
848 for (self.failed_decls.items()) |*entry| {
849 for (entry.value.items) |compile_err| {
850 compile_err.destroy(gpa);
851 }
852 entry.value.deinit(gpa);
850853 }
851854 self.failed_decls.deinit(gpa);
852855
......@@ -942,8 +945,7 @@ pub fn ensureDeclAnalyzed(self: *Module, decl: *Decl) InnerError!void {
942945 error.OutOfMemory => return error.OutOfMemory,
943946 error.AnalysisFail => return error.AnalysisFail,
944947 else => {
945 try self.failed_decls.ensureCapacity(self.gpa, self.failed_decls.items().len + 1);
946 self.failed_decls.putAssumeCapacityNoClobber(decl, try Compilation.ErrorMsg.create(
948 try self.addDeclErr(decl, try Compilation.ErrorMsg.create(
947949 self.gpa,
948950 decl.src(),
949951 "unable to analyze: {}",
......@@ -1550,7 +1552,7 @@ pub fn analyzeContainer(self: *Module, container_scope: *Scope.Container) !void
15501552 decl.analysis = .sema_failure;
15511553 const err_msg = try Compilation.ErrorMsg.create(self.gpa, tree.token_locs[name_tok].start, "redefinition of '{}'", .{decl.name});
15521554 errdefer err_msg.destroy(self.gpa);
1553 try self.failed_decls.putNoClobber(self.gpa, decl, err_msg);
1555 try self.addDeclErr(decl, err_msg);
15541556 } else {
15551557 if (!srcHashEql(decl.contents_hash, contents_hash)) {
15561558 try self.markOutdatedDecl(decl);
......@@ -1592,7 +1594,7 @@ pub fn analyzeContainer(self: *Module, container_scope: *Scope.Container) !void
15921594 decl.analysis = .sema_failure;
15931595 const err_msg = try Compilation.ErrorMsg.create(self.gpa, name_loc.start, "redefinition of '{}'", .{decl.name});
15941596 errdefer err_msg.destroy(self.gpa);
1595 try self.failed_decls.putNoClobber(self.gpa, decl, err_msg);
1597 try self.addDeclErr(decl, err_msg);
15961598 } else if (!srcHashEql(decl.contents_hash, contents_hash)) {
15971599 try self.markOutdatedDecl(decl);
15981600 decl.contents_hash = contents_hash;
......@@ -1718,8 +1720,11 @@ pub fn deleteDecl(self: *Module, decl: *Decl) !void {
17181720 try self.markOutdatedDecl(dep);
17191721 }
17201722 }
1721 if (self.failed_decls.remove(decl)) |entry| {
1722 entry.value.destroy(self.gpa);
1723 if (self.failed_decls.remove(decl)) |*entry| {
1724 for (entry.value.items) |compile_err| {
1725 compile_err.destroy(self.gpa);
1726 }
1727 entry.value.deinit(self.gpa);
17231728 }
17241729 self.deleteDeclExports(decl);
17251730 self.comp.bin_file.freeDecl(decl);
......@@ -1798,8 +1803,11 @@ pub fn analyzeFnBody(self: *Module, decl: *Decl, func: *Fn) !void {
17981803fn markOutdatedDecl(self: *Module, decl: *Decl) !void {
17991804 log.debug("mark {} outdated\n", .{decl.name});
18001805 try self.comp.work_queue.writeItem(.{ .analyze_decl = decl });
1801 if (self.failed_decls.remove(decl)) |entry| {
1802 entry.value.destroy(self.gpa);
1806 if (self.failed_decls.remove(decl)) |*entry| {
1807 for (entry.value.items) |compile_err| {
1808 compile_err.destroy(self.gpa);
1809 }
1810 entry.value.deinit(self.gpa);
18031811 }
18041812 decl.analysis = .outdated;
18051813}
......@@ -2944,10 +2952,14 @@ pub fn failNode(
29442952 return self.fail(scope, src, format, args);
29452953}
29462954
2955pub fn addDeclErr(self: *Module, decl: *Decl, err: *Compilation.ErrorMsg) error{OutOfMemory}!void {
2956 const entry = try self.failed_decls.getOrPutValue(self.gpa, decl, .{});
2957 try entry.value.append(self.gpa, err);
2958}
2959
29472960fn failWithOwnedErrorMsg(self: *Module, scope: *Scope, src: usize, err_msg: *Compilation.ErrorMsg) InnerError {
29482961 {
29492962 errdefer err_msg.destroy(self.gpa);
2950 try self.failed_decls.ensureCapacity(self.gpa, self.failed_decls.items().len + 1);
29512963 try self.failed_files.ensureCapacity(self.gpa, self.failed_files.items().len + 1);
29522964 }
29532965 switch (scope.tag) {
......@@ -2955,7 +2967,7 @@ fn failWithOwnedErrorMsg(self: *Module, scope: *Scope, src: usize, err_msg: *Com
29552967 const decl = scope.cast(Scope.DeclAnalysis).?.decl;
29562968 decl.analysis = .sema_failure;
29572969 decl.generation = self.generation;
2958 self.failed_decls.putAssumeCapacityNoClobber(decl, err_msg);
2970 try self.addDeclErr(decl, err_msg);
29592971 },
29602972 .block => {
29612973 const block = scope.cast(Scope.Block).?;
......@@ -2965,25 +2977,25 @@ fn failWithOwnedErrorMsg(self: *Module, scope: *Scope, src: usize, err_msg: *Com
29652977 block.decl.analysis = .sema_failure;
29662978 block.decl.generation = self.generation;
29672979 }
2968 self.failed_decls.putAssumeCapacityNoClobber(block.decl, err_msg);
2980 try self.addDeclErr(block.decl, err_msg);
29692981 },
29702982 .gen_zir => {
29712983 const gen_zir = scope.cast(Scope.GenZIR).?;
29722984 gen_zir.decl.analysis = .sema_failure;
29732985 gen_zir.decl.generation = self.generation;
2974 self.failed_decls.putAssumeCapacityNoClobber(gen_zir.decl, err_msg);
2986 try self.addDeclErr(gen_zir.decl, err_msg);
29752987 },
29762988 .local_val => {
29772989 const gen_zir = scope.cast(Scope.LocalVal).?.gen_zir;
29782990 gen_zir.decl.analysis = .sema_failure;
29792991 gen_zir.decl.generation = self.generation;
2980 self.failed_decls.putAssumeCapacityNoClobber(gen_zir.decl, err_msg);
2992 try self.addDeclErr(gen_zir.decl, err_msg);
29812993 },
29822994 .local_ptr => {
29832995 const gen_zir = scope.cast(Scope.LocalPtr).?.gen_zir;
29842996 gen_zir.decl.analysis = .sema_failure;
29852997 gen_zir.decl.generation = self.generation;
2986 self.failed_decls.putAssumeCapacityNoClobber(gen_zir.decl, err_msg);
2998 try self.addDeclErr(gen_zir.decl, err_msg);
29872999 },
29883000 .zir_module => {
29893001 const zir_module = scope.cast(Scope.ZIRModule).?;
src/astgen.zig+13
......@@ -2248,6 +2248,17 @@ fn import(mod: *Module, scope: *Scope, call: *ast.Node.BuiltinCall) InnerError!*
22482248 return addZIRUnOp(mod, scope, src, .import, target);
22492249}
22502250
2251fn compileLog(mod: *Module, scope: *Scope, call: *ast.Node.BuiltinCall) InnerError!*zir.Inst {
2252 const tree = scope.tree();
2253 const arena = scope.arena();
2254 const src = tree.token_locs[call.builtin_token].start;
2255 const params = call.params();
2256 var targets = try arena.alloc(*zir.Inst, params.len);
2257 for (params) |param, param_i|
2258 targets[param_i] = try expr(mod, scope, .none, param);
2259 return addZIRInst(mod, scope, src, zir.Inst.CompileLog, .{ .to_log = targets }, .{});
2260}
2261
22512262fn typeOf(mod: *Module, scope: *Scope, rl: ResultLoc, call: *ast.Node.BuiltinCall) InnerError!*zir.Inst {
22522263 const tree = scope.tree();
22532264 const arena = scope.arena();
......@@ -2291,6 +2302,8 @@ fn builtinCall(mod: *Module, scope: *Scope, rl: ResultLoc, call: *ast.Node.Built
22912302 return rlWrap(mod, scope, rl, try addZIRNoOp(mod, scope, src, .breakpoint));
22922303 } else if (mem.eql(u8, builtin_name, "@import")) {
22932304 return rlWrap(mod, scope, rl, try import(mod, scope, call));
2305 } else if (mem.eql(u8, builtin_name, "@compileLog")) {
2306 return compileLog(mod, scope, call);
22942307 } else {
22952308 return mod.failTok(scope, call.builtin_token, "invalid builtin function: '{}'", .{builtin_name});
22962309 }
src/codegen/c.zig+1-1
......@@ -106,7 +106,7 @@ pub fn generateHeader(
106106 const writer = header.buf.writer();
107107 renderFunctionSignature(&ctx, header, writer, decl) catch |err| {
108108 if (err == error.AnalysisFail) {
109 try module.failed_decls.put(module.gpa, decl, ctx.error_msg);
109 try module.addDeclErr(decl, ctx.error_msg);
110110 }
111111 return err;
112112 };
src/link/C.zig+1-1
......@@ -106,7 +106,7 @@ pub fn deinit(self: *C) void {
106106pub fn updateDecl(self: *C, module: *Module, decl: *Module.Decl) !void {
107107 codegen.generate(self, decl) catch |err| {
108108 if (err == error.AnalysisFail) {
109 try module.failed_decls.put(module.gpa, decl, self.error_msg);
109 try module.addDeclErr(decl, self.error_msg);
110110 }
111111 return err;
112112 };
src/link/Coff.zig+1-1
......@@ -658,7 +658,7 @@ pub fn updateDecl(self: *Coff, module: *Module, decl: *Module.Decl) !void {
658658 .appended => code_buffer.items,
659659 .fail => |em| {
660660 decl.analysis = .codegen_failure;
661 try module.failed_decls.put(module.gpa, decl, em);
661 try module.addDeclErr(decl, em);
662662 return;
663663 },
664664 };
src/link/Elf.zig+1-1
......@@ -2248,7 +2248,7 @@ pub fn updateDecl(self: *Elf, module: *Module, decl: *Module.Decl) !void {
22482248 .appended => code_buffer.items,
22492249 .fail => |em| {
22502250 decl.analysis = .codegen_failure;
2251 try module.failed_decls.put(module.gpa, decl, em);
2251 try module.addDeclErr(decl, em);
22522252 return;
22532253 },
22542254 };
src/link/MachO.zig+1-1
......@@ -1062,7 +1062,7 @@ pub fn updateDecl(self: *MachO, module: *Module, decl: *Module.Decl) !void {
10621062 .appended => code_buffer.items,
10631063 .fail => |em| {
10641064 decl.analysis = .codegen_failure;
1065 try module.failed_decls.put(module.gpa, decl, em);
1065 try module.addDeclErr(decl, em);
10661066 return;
10671067 },
10681068 };
src/value.zig+1-1
......@@ -350,7 +350,7 @@ pub const Value = extern union {
350350 val = elem_ptr.array_ptr;
351351 },
352352 .empty_array => return out_stream.writeAll(".{}"),
353 .enum_literal => return out_stream.print(".{z}", .{self.cast(Payload.Bytes).?.data}),
353 .enum_literal => return out_stream.print(".{z}", .{@fieldParentPtr(Payload.Bytes, "base", self.ptr_otherwise).data}),
354354 .bytes => return out_stream.print("\"{Z}\"", .{self.cast(Payload.Bytes).?.data}),
355355 .repeated => {
356356 try out_stream.writeAll("(repeated) ");
src/zir.zig+20-3
......@@ -122,6 +122,8 @@ pub const Inst = struct {
122122 coerce_to_ptr_elem,
123123 /// Emit an error message and fail compilation.
124124 compileerror,
125 /// Log compile time variables and emit an error message.
126 compilelog,
125127 /// Conditional branch. Splits control flow based on a boolean condition value.
126128 condbr,
127129 /// Special case, has no textual representation.
......@@ -386,6 +388,7 @@ pub const Inst = struct {
386388 .declval_in_module => DeclValInModule,
387389 .coerce_result_block_ptr => CoerceResultBlockPtr,
388390 .compileerror => CompileError,
391 .compilelog => CompileLog,
389392 .loop => Loop,
390393 .@"const" => Const,
391394 .str => Str,
......@@ -513,6 +516,7 @@ pub const Inst = struct {
513516 .slice_start,
514517 .import,
515518 .switch_range,
519 .compilelog,
516520 .typeof_peer,
517521 => false,
518522
......@@ -707,6 +711,19 @@ pub const Inst = struct {
707711 kw_args: struct {},
708712 };
709713
714 pub const CompileLog = struct {
715 pub const base_tag = Tag.compilelog;
716 base: Inst,
717
718 positionals: struct {
719 to_log: []*Inst,
720 },
721 kw_args: struct {
722 /// If we have seen it already so don't make another error
723 seen: bool = false,
724 },
725 };
726
710727 pub const Const = struct {
711728 pub const base_tag = Tag.@"const";
712729 base: Inst,
......@@ -1925,7 +1942,7 @@ const EmitZIR = struct {
19251942 .sema_failure,
19261943 .sema_failure_retryable,
19271944 .dependency_failure,
1928 => if (self.old_module.failed_decls.get(ir_decl)) |err_msg| {
1945 => if (self.old_module.failed_decls.get(ir_decl)) |err_msg_list| {
19291946 const fail_inst = try self.arena.allocator.create(Inst.CompileError);
19301947 fail_inst.* = .{
19311948 .base = .{
......@@ -1933,7 +1950,7 @@ const EmitZIR = struct {
19331950 .tag = Inst.CompileError.base_tag,
19341951 },
19351952 .positionals = .{
1936 .msg = try self.arena.allocator.dupe(u8, err_msg.msg),
1953 .msg = try self.arena.allocator.dupe(u8, err_msg_list.items[0].msg),
19371954 },
19381955 .kw_args = .{},
19391956 };
......@@ -2055,7 +2072,7 @@ const EmitZIR = struct {
20552072 try self.emitBody(body, &inst_table, &instructions);
20562073 },
20572074 .sema_failure => {
2058 const err_msg = self.old_module.failed_decls.get(module_fn.owner_decl).?;
2075 const err_msg = self.old_module.failed_decls.get(module_fn.owner_decl).?.items[0];
20592076 const fail_inst = try self.arena.allocator.create(Inst.CompileError);
20602077 fail_inst.* = .{
20612078 .base = .{
src/zir_sema.zig+23
......@@ -43,6 +43,7 @@ pub fn analyzeInst(mod: *Module, scope: *Scope, old_inst: *zir.Inst) InnerError!
4343 .coerce_result_ptr => return analyzeInstCoerceResultPtr(mod, scope, old_inst.castTag(.coerce_result_ptr).?),
4444 .coerce_to_ptr_elem => return analyzeInstCoerceToPtrElem(mod, scope, old_inst.castTag(.coerce_to_ptr_elem).?),
4545 .compileerror => return analyzeInstCompileError(mod, scope, old_inst.castTag(.compileerror).?),
46 .compilelog => return analyzeInstCompileLog(mod, scope, old_inst.castTag(.compilelog).?),
4647 .@"const" => return analyzeInstConst(mod, scope, old_inst.castTag(.@"const").?),
4748 .dbg_stmt => return analyzeInstDbgStmt(mod, scope, old_inst.castTag(.dbg_stmt).?),
4849 .declref => return analyzeInstDeclRef(mod, scope, old_inst.castTag(.declref).?),
......@@ -489,6 +490,28 @@ fn analyzeInstCompileError(mod: *Module, scope: *Scope, inst: *zir.Inst.CompileE
489490 return mod.fail(scope, inst.base.src, "{}", .{inst.positionals.msg});
490491}
491492
493fn analyzeInstCompileLog(mod: *Module, scope: *Scope, inst: *zir.Inst.CompileLog) InnerError!*Inst {
494 std.debug.print("| ", .{});
495 for (inst.positionals.to_log) |item, i| {
496 const to_log = try resolveInst(mod, scope, item);
497 if (to_log.value()) |val| {
498 std.debug.print("{}", .{val});
499 } else {
500 std.debug.print("(runtime value)", .{});
501 }
502 if (i != inst.positionals.to_log.len - 1) std.debug.print(", ", .{});
503 }
504 std.debug.print("\n", .{});
505 if (!inst.kw_args.seen) {
506 inst.kw_args.seen = true; // so that we do not give multiple compile errors if it gets evaled twice
507 switch (mod.fail(scope, inst.base.src, "found compile log statement", .{})) {
508 error.AnalysisFail => {}, // analysis continues
509 else => |e| return e,
510 }
511 }
512 return mod.constVoid(scope, inst.base.src);
513}
514
492515fn analyzeInstArg(mod: *Module, scope: *Scope, inst: *zir.Inst.Arg) InnerError!*Inst {
493516 const b = try mod.requireRuntimeBlock(scope, inst.base.src);
494517 const fn_ty = b.func.?.owner_decl.typed_value.most_recent.typed_value.ty;
test/stage2/test.zig+15
......@@ -1171,6 +1171,21 @@ pub fn addCases(ctx: *TestContext) !void {
11711171 \\fn entry() void {}
11721172 , &[_][]const u8{":2:4: error: redefinition of 'entry'"});
11731173
1174 ctx.compileError("compileLog", linux_x64,
1175 \\export fn _start() noreturn {
1176 \\ const b = true;
1177 \\ var f: u32 = 1;
1178 \\ @compileLog(b, 20, f, x, .foo);
1179 \\ var y: u32 = true;
1180 \\ unreachable;
1181 \\}
1182 \\fn x() void {}
1183 , &[_][]const u8{
1184 ":4:3: error: found compile log statement", ":5:16: error: expected u32, found bool",
1185 });
1186
1187 // "| true, 20, (runtime value), (function)" // TODO if this is here it invalidates the compile error checker. Need a way to check though.
1188
11741189 {
11751190 var case = ctx.obj("variable shadowing", linux_x64);
11761191 case.addError(