@cImport fails (macro substitution?) and compiler bug [ir.cpp:22931]

[OBenjaminT]

Remember to search before filing a new report

• I searched for this bug and did not find it in the issue tracker, and furthermore, the title I used above will make this new bug report turn up in the search results for my query.

Zig Version

0.9.0-dev.1433+4a76523b9

Steps to Reproduce

I haven't narrowed the issue down. But basically you clone dwm and try and build it through a main.zig file.

git clone git://git.suckless.org/dwm

build.zig (what I could translate from the make files):

const std = @import("std");

pub fn build(b: *std.build.Builder) void {
    const target = b.standardTargetOptions(.{});
    const mode = b.standardReleaseOptions();

    const exe = b.addExecutable("zig-dwm", "main.zig");
    exe.linkLibC();
    exe.setTarget(target);
    exe.setBuildMode(mode);

    exe.linkSystemLibrary("X11");
    exe.linkSystemLibrary("Xinerama");
    exe.linkSystemLibrary("fontconfig");
    exe.linkSystemLibrary("Xft");
    exe.linkSystemLibrary("X11-xcb");
    exe.linkSystemLibrary("xcb");
    exe.linkSystemLibrary("xcb-res");

    exe.addLibPath("/usr/X11R6/lib");

    exe.addIncludeDir(".");
    exe.addIncludeDir("/usr/include/freetype2");
    exe.addIncludeDir("/usr/X11R6/include");
    exe.addIncludeDir("/usr/X11R8/lib");

    exe.addCSourceFiles(&.{
        "drw.c",
        "dwm.c",
        "util.c",
    }, &.{
        "-std=c99",
        "-pedantic", 
        "-Wall", 
        "-Wno-deprecated-declarations", 
        "-Os",
        "-D_DEFAULT_SOURCE",
        "-D_BSD_SOURCE",
        "-D_POSIX_C_SOURCE=200809L",
        "-DVERSION=\"6.2\"",
        "-DXINERAMA",
    });
    exe.install();
}

main.zig:

const dwm = @cImport(@cInclude("./dwm.c"));

pub fn main() anyerror!void {
    dwm.main();
}

And then run zig build run

Expected Behavior

Compiles normally, No errors.

(It compiles with zig cc perfectly fine.)

Actual Behavior

First it doesn't understand "dwm-"VERSION and fails to translate the brackets. (This happens twice)

If you remove the two occurrences of VERSION you get this error:

Unreachable at /home/vsts/work/1/s/src/stage1/ir.cpp:22931 in buf_write_value_bytes. This is a bug in the Zig compiler.thread 8047 panic: 
Unable to dump stack trace: debug info stripped
zig-dwm...The following command terminated unexpectedly:
~/zig build-exe ~/zig-dwm/main.zig -lc -lX11 -lXinerama -lfontconfig -lfreetype -lXft -lX11-xcb -lX11 -lxcb -lxcb -lxcb-res -cflags -std=c99 -pedantic -Wall -Wno-deprecated-declarations -Os -D_DEFAULT_SOURCE -D_BSD_SOURCE -D_POSIX_C_SOURCE=200809L -DVERSION="6.2" -DXINERAMA -- ~/zig-dwm/drw.c ~/zig-dwm/dwm.c ~/zig-dwm/util.c --cache-dir ~/zig-dwm/zig-cache --global-cache-dir ~/.cache/zig --name zig-dwm -I /usr/include/freetype2 -I /usr/include/libpng16 -I /usr/include/harfbuzz -I /usr/include/glib-2.0 -I /usr/lib/glib-2.0/include -I /usr/include/freetype2 -I /usr/include/libpng16 -I /usr/include/harfbuzz -I /usr/include/glib-2.0 -I /usr/lib/glib-2.0/include -I ~/zig-dwm -I /usr/include/freetype2 -I /usr/X11R6/include -I /usr/X11R8/lib -L /usr/X11R6/lib --enable-cache 
error: the following build command failed with exit code 6:
~/zig-dwm/zig-cache/o/6bc0c2586523ccc671438b5989f75207/build ~/zig ~/zig-dwm ~/zig-dwm/zig-cache ~/.cache/zig

[jmc-88]

For the first issue: a zig build --verbose-cc seems to suggest that the macros defined via -D are passed main.zig but not forwarded to the @cInclude("./dwm.c").

[jmc-88]

For the second issue, breaking in buf_write_value_bytes on ir.cpp:22931, I get the following:

(gdb) print val->type->name
$1 = {list = {items = 0x8659620 "[*c].cimport:1:13.Visual", length = 25, capacity = 28}}
(gdb) print val->data.x_ptr
$2 = {special = ConstPtrSpecialInvalid, mut = ConstPtrMutComptimeConst, data = {ref = {pointee = 0x0}, base_array = {array_val = 0x0, elem_index = 0}, base_struct = {
      struct_val = 0x0, field_index = 0}, base_err_union_code = {err_union_val = 0x0}, base_err_union_payload = {err_union_val = 0x0}, base_optional_payload = {
      optional_val = 0x0}, hard_coded_addr = {addr = 0}, fn = {fn_entry = 0x0}}}

and from a quick look at the translated source code, there's DefaultVisual which was a macro and it may be tripping the compiler:

pub inline fn DefaultVisual(dpy_1: anytype, scr: anytype) @TypeOf(ScreenOfDisplay(dpy_1, scr).*.root_visual) {
    return ScreenOfDisplay(dpy_1, scr).*.root_visual;
}

but this is just speculation.

[TwoClocks]

I think this is related. Also importing a C header file. Also on released 0.9.0. Linux.

Unreachable at /home/andy/dev/bootstrap-zig/zig/src/stage1/ir.cpp:23019 in buf_write_value_bytes. This is a bug in the Zig compiler.thread 30968 panic:

The zig code is just trying to integrate over an array defined in a .h file. The .h part of a larger project though. I can put together a small repro that reproduces if you need it.

adding --verbose-cc did not output anything different.

[TwoClocks]

Not sure if this is useful.
I build a debug compiler from tag 0.9.0. Here is the full trace:

/home/twoclocks/tinker/forks/zig/build/zig build run
Semantic Analysis [614/7065] Unreachable at /home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:23019 in buf_write_value_bytes. This is a bug in the Zig compiler.thread 3339257 panic: 
/home/twoclocks/tinker/forks/zig/src/stage1.zig:178:5: 0x559a4fcafc17 in stage2_panic (zig1)
    @panic(ptr[0..len]);
    ^
/home/twoclocks/tinker/forks/zig/src/stage1/util.cpp:20:17: 0x559a50bd1daa in zig_panic (/home/twoclocks/tinker/forks/zig/src/stage1/util.cpp)
    stage2_panic("", 0);
                ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:23019:17: 0x559a50c7da8d in buf_write_value_bytes (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
                zig_unreachable();
                ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:23037:46: 0x559a50c7dc1f in buf_write_value_bytes (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
                        buf_write_value_bytes(codegen, buf + offset, field_val);
                                             ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:13876:30: 0x559a50c576b4 in ir_read_const_ptr (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
        buf_write_value_bytes(codegen, (uint8_t*)buf_ptr(&buf), pointee);
                             ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:2599:33: 0x559a50c2afdf in eval_comptime_ptr_reinterpret (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
    if ((err = ir_read_const_ptr(ira, codegen, source_node, &tmp, ptr_val)))
                                ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:2626:49: 0x559a50c2b152 in const_ptr_pointee (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
        if ((err = eval_comptime_ptr_reinterpret(ira, codegen, source_node, const_val)))
                                                ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:5368:50: 0x559a50c36056 in ir_resolve_ptr_of_array_to_slice (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
            ZigValue *pointee = const_ptr_pointee(ira, ira->codegen, array_ptr_val, source_node);
                                                 ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:7684:60: 0x559a50c3f2ca in ir_analyze_cast (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
                    return ir_resolve_ptr_of_array_to_slice(ira, scope, source_node, value, slice_type, nullptr);
                                                           ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:8092:27: 0x559a50c41196 in ir_implicit_cast2 (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
    return ir_analyze_cast(ira, scope, source_node, expected_type, value);
                          ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:8096:29: 0x559a50c411d8 in ir_implicit_cast (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
    return ir_implicit_cast2(ira, value->scope, value->source_node, value, expected_type);
                            ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:12618:38: 0x559a50c527b4 in ir_analyze_fn_call_inline_arg (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
        casted_arg = ir_implicit_cast(ira, arg, param_type);
                                     ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:13066:47: 0x559a50c53f44 in ir_analyze_fn_call (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
            if (!ir_analyze_fn_call_inline_arg(ira, fn_proto_node, old_arg, &exec_scope, &next_proto_i))
                                              ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:13574:47: 0x559a50c5627a in ir_analyze_fn_call_src (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
    Stage1AirInst *result = ir_analyze_fn_call(ira, call_instruction->base.scope,
                                              ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:13823:42: 0x559a50c572b1 in ir_analyze_instruction_call (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
            return ir_analyze_fn_call_src(ira, call_instruction, fn_table_entry, fn_type,
                                         ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:24936:47: 0x559a50c849e8 in ir_analyze_instruction_base (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
            return ir_analyze_instruction_call(ira, (Stage1ZirInstCall *)instruction);
                                              ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:25258:69: 0x559a50c859f5 in ir_analyze (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
        Stage1AirInst *new_instruction = ir_analyze_instruction_base(ira, old_instruction);
                                                                    ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:5745:38: 0x559a50c373a7 in ir_eval_const_value (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
    ZigType *result_type = ir_analyze(codegen, stage1_zir, analyzed_executable,
                                     ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:13127:43: 0x559a50c542e5 in ir_analyze_fn_call (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
            if ((err = ir_eval_const_value(ira->codegen, exec_scope, body_node, result_ptr,
                                          ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:13574:47: 0x559a50c5627a in ir_analyze_fn_call_src (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
    Stage1AirInst *result = ir_analyze_fn_call(ira, call_instruction->base.scope,
                                              ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:13823:42: 0x559a50c572b1 in ir_analyze_instruction_call (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
            return ir_analyze_fn_call_src(ira, call_instruction, fn_table_entry, fn_type,
                                         ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:24936:47: 0x559a50c849e8 in ir_analyze_instruction_base (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
            return ir_analyze_instruction_call(ira, (Stage1ZirInstCall *)instruction);
                                              ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:25258:69: 0x559a50c859f5 in ir_analyze (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
        Stage1AirInst *new_instruction = ir_analyze_instruction_base(ira, old_instruction);
                                                                    ^
/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp:5745:38: 0x559a50c373a7 in ir_eval_const_value (/home/twoclocks/tinker/forks/zig/src/stage1/ir.cpp)
    ZigType *result_type = ir_analyze(codegen, stage1_zir, analyzed_executable,
                                     ^
/home/twoclocks/tinker/forks/zig/src/stage1/analyze.cpp:1210:35: 0x559a50cbf6d4 in analyze_const_value (/home/twoclocks/tinker/forks/zig/src/stage1/analyze.cpp)
    if ((err = ir_eval_const_value(g, scope, node, result_ptr,
                                  ^
/home/twoclocks/tinker/forks/zig/src/stage1/analyze.cpp:4239:41: 0x559a50cc92bc in resolve_decl_var (/home/twoclocks/tinker/forks/zig/src/stage1/analyze.cpp)
        init_value = analyze_const_value(g, tld_var->base.parent_scope, var_decl->expr, explicit_type,
                                        ^
/home/twoclocks/tinker/forks/zig/src/stage1/analyze.cpp:4439:33: 0x559a50cc9dc9 in resolve_top_level_decl (/home/twoclocks/tinker/forks/zig/src/stage1/analyze.cpp)
                resolve_decl_var(g, tld_var, allow_lazy);
                                ^
/home/twoclocks/tinker/forks/zig/src/stage1/analyze.cpp:5308:35: 0x559a50cccb16 in semantic_analyze (/home/twoclocks/tinker/forks/zig/src/stage1/analyze.cpp)
            resolve_top_level_decl(g, tld, source_node, false);
                                  ^
/home/twoclocks/tinker/forks/zig/src/stage1/codegen.cpp:9787:25: 0x559a50bfccfe in gen_root_source (/home/twoclocks/tinker/forks/zig/src/stage1/codegen.cpp)
        semantic_analyze(g);
                        ^
/home/twoclocks/tinker/forks/zig/src/stage1/codegen.cpp:9836:20: 0x559a50bfd09d in codegen_build_object (/home/twoclocks/tinker/forks/zig/src/stage1/codegen.cpp)
    gen_root_source(g);
                   ^
/home/twoclocks/tinker/forks/zig/src/stage1/stage1.cpp:132:25: 0x559a50bcdd6d in zig_stage1_build_object (/home/twoclocks/tinker/forks/zig/src/stage1/stage1.cpp)
    codegen_build_object(g);
                        ^
/home/twoclocks/tinker/forks/zig/src/stage1.zig:149:32: 0x559a500a2164 in Module.build_object (zig1)
        zig_stage1_build_object(mod);
                               ^
/home/twoclocks/tinker/forks/zig/src/Compilation.zig:4731:31: 0x559a5006402a in Compilation.updateStage1Module (zig1)
    stage1_module.build_object();
                              ^
/home/twoclocks/tinker/forks/zig/src/Compilation.zig:2723:36: 0x559a4fe46a15 in Compilation.processOneJob (zig1)
            comp.updateStage1Module(main_progress_node) catch |err| {
                                   ^
/home/twoclocks/tinker/forks/zig/src/Compilation.zig:2261:30: 0x559a4fe39c42 in Compilation.performAllTheWork (zig1)
            try processOneJob(self, work_item, main_progress_node);
                             ^
/home/twoclocks/tinker/forks/zig/src/Compilation.zig:1872:31: 0x559a4fe357e1 in Compilation.update (zig1)
    try self.performAllTheWork();
                              ^
/home/twoclocks/tinker/forks/zig/src/main.zig:2875:20: 0x559a4fdc445f in main.updateModule (zig1)
    try comp.update();
                   ^
/home/twoclocks/tinker/forks/zig/src/main.zig:2558:17: 0x559a4fcde46d in main.buildOutputType (zig1)
    updateModule(gpa, comp, hook) catch |err| switch (err) {
                ^
/home/twoclocks/tinker/forks/zig/src/main.zig:210:31: 0x559a4fcae1d7 in main.mainArgs (zig1)
        return buildOutputType(gpa, arena, args, .{ .build = .Exe });
                              ^
/home/twoclocks/tinker/forks/zig/src/stage1.zig:48:24: 0x559a4fcadbe9 in main (zig1)
        stage2.mainArgs(gpa, arena, args) catch unreachable;
                       ^
???:?:?: 0x7f43ab2db0b2 in ??? (???)
pgn...The following command terminated unexpectedly:
/home/twoclocks/tinker/forks/zig/build/zig build-exe /home/twoclocks/tinker/canboat/analyzer/pgn.zig -lc --cache-dir /home/twoclocks/tinker/canboat/analyzer/zig-cache --global-cache-dir /home/twoclocks/.cache/zig --name pgn -I /home/twoclocks/tinker/canboat/analyzer -I /home/twoclocks/tinker/canboat/common --enable-cache 
error: the following build command failed with exit code 6:
/home/twoclocks/tinker/canboat/analyzer/zig-cache/o/db8962c162d121021ed63b3592d34f53/build /home/twoclocks/tinker/forks/zig/build/zig /home/twoclocks/tinker/canboat/analyzer /home/twoclocks/tinker/canboat/analyzer/zig-cache /home/twoclocks/.cache/zig run