ziglang/zig
262
5.9k
Fork
You've already forked zig
757

build.zig: No way to output the -include flag #30718

Open
opened 2026年01月06日 18:00:39 +01:00 by mercenary · 2 comments
Contributor
Copy link

Zig Version

0.15.2

Observed Behavior

There seems to be no way for the Zig build system to output the -include flag when compiling C files using std.Build.Module.

I am trying to port libvarlink to the Zig build system, but here it uses -include to include a generated config.h. std.Build.addConfigHeader() works fine for the first step, but std.Build.Module.addConfigHeader() results in a -I flag being emitted.

grep -R -- -include ./lib/std/Build/ shows no hits, while grep -R -- -I ./lib/std/Build/ shows the location where the IncludeDir from addConfigHeader() gets turned into a flag.

A snippet of what I am trying to do:

constconf=b.addConfigHeader(.{},.{._GNU_SOURCE=true,._XOPEN_SOURCE=700,.__SANE_USERSPACE_TYPES__=true,.VERSION=24,// TODO HACK});constlibvarlink=b.addLibrary(.{.name="varlink",.linkage=.static,.root_module=b.createModule(.{.target=target,.optimize=optimize,.link_libc=true,}),});libvarlink.root_module.addIncludePath(path_lib);libvarlink.root_module.addConfigHeader(conf);// <----- herelibvarlink.root_module.addIncludePath(org_varlink_service_varlink_c_inc.dirname());libvarlink.root_module.addCSourceFiles(.{.root=path_lib,.files=&libvarlink_sources,.flags=&c_args,});

This results in a commandline which looks like this:

/usr/bin/zig build-lib $cflags -- $sources -ODebug \
-I /path/to/libvarlink/lib \
-I .zig-cache/o/91dc822b657a41870790e8117c96fa43 \ # <----- here
-I .zig-cache/o/edca5716a462cf2f4c3412a050dc3b01 \
-Mroot -lc --cache-dir .zig-cache --global-cache-dir /path/to/.cache/zig --name varlink -static --zig-lib-dir /usr/lib/zig/ --listen=-

Question

Is this intended? It seems like zig build-lib does not support -include (throwing an error message).

### Zig Version 0.15.2 ### Observed Behavior There seems to be no way for the Zig build system to output the [`-include`](https://clang.llvm.org/docs/ClangCommandLineReference.html#cmdoption-clang-include-file) flag when compiling C files using `std.Build.Module`. I am trying to port [libvarlink](https://github.com/varlink/libvarlink) to the Zig build system, but [here](https://github.com/varlink/libvarlink/blob/4015824f4a408906e4be27d01008b399c0c1e9ec/meson.build#L63) it uses `-include` to include a generated `config.h`. `std.Build.addConfigHeader()` works fine for the first step, but `std.Build.Module.addConfigHeader()` results in a `-I` flag being emitted. `grep -R -- -include ./lib/std/Build/` shows no hits, while `grep -R -- -I ./lib/std/Build/` shows the location where the `IncludeDir` from `addConfigHeader()` gets turned into a flag. A snippet of what I am trying to do: ```zig const conf = b.addConfigHeader(.{}, .{ ._GNU_SOURCE = true, ._XOPEN_SOURCE = 700, .__SANE_USERSPACE_TYPES__ = true, .VERSION = 24, // TODO HACK }); const libvarlink = b.addLibrary(.{ .name = "varlink", .linkage = .static, .root_module = b.createModule(.{ .target = target, .optimize = optimize, .link_libc = true, }), }); libvarlink.root_module.addIncludePath(path_lib); libvarlink.root_module.addConfigHeader(conf); // <----- here libvarlink.root_module.addIncludePath(org_varlink_service_varlink_c_inc.dirname()); libvarlink.root_module.addCSourceFiles(.{ .root = path_lib, .files = &libvarlink_sources, .flags = &c_args, }); ``` This results in a commandline which looks like this: ```sh /usr/bin/zig build-lib $cflags -- $sources -ODebug \ -I /path/to/libvarlink/lib \ -I .zig-cache/o/91dc822b657a41870790e8117c96fa43 \ # <----- here -I .zig-cache/o/edca5716a462cf2f4c3412a050dc3b01 \ -Mroot -lc --cache-dir .zig-cache --global-cache-dir /path/to/.cache/zig --name varlink -static --zig-lib-dir /usr/lib/zig/ --listen=- ``` ### Question Is this intended? It seems like `zig build-lib` does not support `-include` (throwing an error message).
linus changed title from (削除) build.zig: No way to ouput the -include flag (削除ここまで) to build.zig: No way to output the -include flag 2026年01月06日 22:15:36 +01:00

I hit a similar blockage and used the hack below to get it working

consts2n_hash=@import("build.zig.zon").dependencies.s2n_tls.hash;consts2n_prelude_h=std.fmt.allocPrint(b.allocator,"{[cwd]s}/zig-pkg/{[s2n_hash]s}/utils/s2n_prelude.h",.{.cwd=b.root.toString(b.allocator)catchunreachable,.s2n_hash=s2n_hash,})catchunreachable;mod.addCSourceFiles(.{.root=upstream.path("tls/"),.flags=&.{"-include",s2n_prelude_h},.files=tls_src,});

But in your case, since the ConfigHeader path is in the cache, I don't know how you can get the path string to the cache object.

But have you been able to find a workaround for this already in the meantime?

I hit a similar blockage and used the hack below to get it working ```zig const s2n_hash = @import("build.zig.zon").dependencies.s2n_tls.hash; const s2n_prelude_h = std.fmt.allocPrint(b.allocator, "{[cwd]s}/zig-pkg/{[s2n_hash]s}/utils/s2n_prelude.h", .{ .cwd = b.root.toString(b.allocator) catch unreachable, .s2n_hash = s2n_hash, }) catch unreachable; mod.addCSourceFiles(.{ .root = upstream.path("tls/"), .flags = &.{ "-include", s2n_prelude_h }, .files = tls_src, }); ``` But in your case, since the `ConfigHeader` path is in the cache, I don't know how you can get the `path` string to the cache object. But have you been able to find a workaround for this already in the meantime?
Author
Contributor
Copy link

@bernardassan wrote in #30718 (comment):

But have you been able to find a workaround for this already in the meantime?

I just "hardcoded" the macros with .addCMacro() (so -D), rather than -include.

// Would love to do this:
//const conf = b.addConfigHeader(.{}, .{
// ._GNU_SOURCE = true,
// ._XOPEN_SOURCE = 700,
// .__SANE_USERSPACE_TYPES__ = true,
// .VERSION = std.math.cast(i64, version.minor).?,
//});
// but that needs the `-include` flag to be emitted.
// See https://codeberg.org/ziglang/zig/issues/30718
constconf=.{
.{"_GNU_SOURCE","true"},
.{"_XOPEN_SOURCE","700"},
.{"__SANE_USERSPACE_TYPES__","true"},
.{"VERSION",b.fmt("\"{d}\"",.{std.math.cast(i64,version.minor).?})},
};
// libvarlink.addConfigHeader(conf); // see comment above
inlinefor(conf)|value|libvarlink.addCMacro(value[0],value[1]);
@bernardassan wrote in https://codeberg.org/ziglang/zig/issues/30718#issuecomment-18123689: > But have you been able to find a workaround for this already in the meantime? I just "hardcoded" the macros with `.addCMacro()` (so `-D`), rather than `-include`. https://codeberg.org/mercenary/libvarlink/src/commit/7a0c03045be5556d0317365151f651f3968c3422/build.zig#L30-L44 https://codeberg.org/mercenary/libvarlink/src/commit/7a0c03045be5556d0317365151f651f3968c3422/build.zig#L78-L79
Sign in to join this conversation.
No Branch/Tag specified
master
elfv2
spork8
restricted
0.16.x
panic-rewrite
parking-futex-lockfree
windows-Io-cleanup
Io-watch
ParseCommandLineOptions
windows-async-files
poll-ring
debug-file-leaks-differently
debug-file-leaks
ProcessPrng
elfv2-dyn
jobserver
threadtheft
io-threaded-no-queue
0.15.x
Io.net
comptime-allocator
restricted-function-pointers
cli
wasm-linker-writer
wrangle-writer-buffering
sha1-stream
async-await-demo
fixes
0.14.x
ast-node-methods
macos-debug-info
make-vs-configure
fuzz-macos
sans-aro
ArrayList-reserve
incr-bug
llvm-ir-nosanitize-metadata
ci-tarballs
ci-scripts
threadpool
0.12.x
new-pkg-hash
json-diagnostics
more-doctests
rework-comptime-mutation
0.11.x
ci-perf-comment
stage2-async
0.10.x
autofix
0.9.x
aro
hcs
0.8.x
0.7.x
0.16.0
0.15.2
0.15.1
0.15.0
0.14.1
0.14.0
0.12.1
0.13.0
0.12.0
0.11.0
0.10.1
0.10.0
0.9.1
0.9.0
0.8.1
0.8.0
0.7.1
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.1
0.1.0
Labels
Clear labels
abi/f32
abi/ilp32
abi/sf
accepted
This proposal is planned.
arch/21k
arch/6502
arch/aarch64
arch/alpha
arch/amdgcn
arch/arc
arch/arc32
arch/arc64
arch/arm
arch/avr
arch/bfin
arch/bpf
arch/colossus
arch/cris
arch/csky
arch/dlx
arch/epiphany
arch/fr30
arch/frv
arch/hexagon
arch/hppa
arch/hppa64
arch/ia64
arch/kalimba
arch/kvx
arch/lanai
arch/lm32
arch/loongarch32
arch/loongarch64
arch/m32r
arch/m68k
arch/m88k
arch/mcore
arch/microblaze
arch/mips
arch/mips64
arch/mmix
arch/moxie
arch/mrisc32
arch/msp430
arch/nds32
arch/ns32k
arch/nvptx
arch/or1k
arch/powerpc
arch/powerpc64
arch/propeller
arch/riscv32
arch/riscv64
arch/rl78
arch/rx
arch/s390x
arch/sh
arch/sparc
arch/sparc64
arch/spirv
arch/spu
arch/tricore
arch/v850
arch/vax
arch/vc4
arch/ve
arch/wasm
arch/x86
arch/x86_64
arch/xcore
arch/xtensa
autodoc
The web application for interactive documentation and generation of its assets.
backend/c
The C backend outputs C source code.
backend/llvm
The LLVM backend outputs an LLVM bitcode module.
backend/self-hosted
The self-hosted backends produce machine code directly.
binutils
Zig's included binary utilities: zig ar, zig dlltool, zig lib, zig ranlib, zig objcopy, and zig rc.
breaking
Implementing this issue could cause existing code to no longer compile or have different behavior.
build system
The Zig build system - zig build, std.Build, the build runner, and package management.
debug info
An issue related to debug information (e.g. DWARF) produced by the Zig compiler.
docs
An issue with documentation, e.g. the language reference or standard library doc comments.
error message
This issue points out an error message that is unhelpful and should be improved.
frontend
Tokenization, parsing, AstGen, ZonGen, Sema, Legalize, and Liveness.
fuzzing
An issue related to Zig's integrated fuzz testing.
incremental
Reuse of internal compiler state for faster compilation.
lib/c
This issue relates to Zig's libc implementation and/or vendored libcs.
lib/compiler-rt
This issue relates to Zig's compiler-rt library.
lib/cxx
This issue relates to Zig's vendored libc++ and/or libc++abi.
lib/std
This issue relates to Zig's standard library.
lib/tsan
This issue relates to Zig's vendored libtsan.
lib/ubsan-rt
This issue relates to Zig's ubsan-rt library.
lib/unwind
This issue relates to Zig's vendored libunwind.
linking
Zig's integrated object file and incremental linker.
miscompilation
The compiler reports success but produces semantically incorrect code.
os/android
os/contiki
os/dragonfly
os/driverkit
os/emscripten
os/freebsd
os/fuchsia
os/haiku
os/hermit
os/hurd
os/illumos
os/ios
os/linux
os/maccatalyst
os/macos
os/managarm
os/netbsd
os/ohos
os/openbsd
os/plan9
os/redox
os/rtems
os/serenity
os/tvos
os/uefi
os/visionos
os/wasi
os/watchos
os/windows
proposal
This issue suggests language modifications. If it also has the "accepted" label then it is planned.
release notes
This issue or pull request should be mentioned in the release notes.
testing
This issue is related to testing the compiler, standard library, or other parts of Zig.
zig cc
Zig as a drop-in C-family compiler.
zig fmt
The Zig source code formatter.
zig reduce
The Zig source code reduction tool.
bounty
https://ziglang.org/news/announcing-donor-bounties
bug
Observed behavior contradicts documented or intended behavior.
contributor-friendly
This issue is limited in scope and/or knowledge of project internals.
downstream
An issue with a third-party project that uses this project.
enhancement
Solving this issue will likely involve adding new logic or components to the codebase.
infra
An issue related to project infrastructure, e.g. continuous integration.
optimization
A task to improve performance and/or resource usage.
question
No questions on the issue tracker; use a community space instead.
regression
Something that used to work in a previous version stopped working
upstream
An issue with a third-party project that this project uses.
use case
Describes a real use case that is difficult or impossible, but does not propose a solution.
No labels
abi/f32
abi/ilp32
abi/sf
accepted
arch/21k
arch/6502
arch/aarch64
arch/alpha
arch/amdgcn
arch/arc
arch/arc32
arch/arc64
arch/arm
arch/avr
arch/bfin
arch/bpf
arch/colossus
arch/cris
arch/csky
arch/dlx
arch/epiphany
arch/fr30
arch/frv
arch/hexagon
arch/hppa
arch/hppa64
arch/ia64
arch/kalimba
arch/kvx
arch/lanai
arch/lm32
arch/loongarch32
arch/loongarch64
arch/m32r
arch/m68k
arch/m88k
arch/mcore
arch/microblaze
arch/mips
arch/mips64
arch/mmix
arch/moxie
arch/mrisc32
arch/msp430
arch/nds32
arch/ns32k
arch/nvptx
arch/or1k
arch/powerpc
arch/powerpc64
arch/propeller
arch/riscv32
arch/riscv64
arch/rl78
arch/rx
arch/s390x
arch/sh
arch/sparc
arch/sparc64
arch/spirv
arch/spu
arch/tricore
arch/v850
arch/vax
arch/vc4
arch/ve
arch/wasm
arch/x86
arch/x86_64
arch/xcore
arch/xtensa
autodoc
backend/c
backend/llvm
backend/self-hosted
binutils
breaking
build system
debug info
docs
error message
frontend
fuzzing
incremental
lib/c
lib/compiler-rt
lib/cxx
lib/std
lib/tsan
lib/ubsan-rt
lib/unwind
linking
miscompilation
os/android
os/contiki
os/dragonfly
os/driverkit
os/emscripten
os/freebsd
os/fuchsia
os/haiku
os/hermit
os/hurd
os/illumos
os/ios
os/linux
os/maccatalyst
os/macos
os/managarm
os/netbsd
os/ohos
os/openbsd
os/plan9
os/redox
os/rtems
os/serenity
os/tvos
os/uefi
os/visionos
os/wasi
os/watchos
os/windows
proposal
release notes
testing
zig cc
zig fmt
zig reduce
bounty
bug
contributor-friendly
downstream
enhancement
infra
optimization
question
regression
upstream
use case
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
ziglang/zig#30718
Reference in a new issue
ziglang/zig
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?