feature. See also
. The project being documented here (as the example) is the Zig library itself.
Compile.lowerZigArgs
fn lowerZigArgs(
arena: Allocator,
compile: *Compile,
compile_index: Configuration.Step.Index,
maker: *Maker,
progress_node: std.Progress.Node,
zig_args: *std.ArrayList([]const u8),
fuzz: bool,
) Step.ExtendedMakeError!void
File
Code
fn lowerZigArgs(
arena: Allocator,
compile: *Compile,
compile_index: Configuration.Step.Index,
maker: *Maker,
progress_node: std.Progress.Node,
zig_args: *std.ArrayList([]const u8),
fuzz: bool,
) Step.ExtendedMakeError!void {
const step = maker.stepByIndex(compile_index);
const graph = maker.graph;
const gpa = maker.gpa;
const conf = &maker.scanned_config.configuration;
const conf_step = compile_index.ptr(conf);
const conf_comp = conf_step.extended.get(conf.extra).compile;
const root_module_target = conf_comp.rootModuleTarget(conf);
try zig_args.append(gpa, graph.zig_exe);
const cmd = switch (conf_comp.flags3.kind) {
.lib => "build-lib",
.exe => "build-exe",
.obj => "build-obj",
.@"test" => "test",
.test_obj => "test-obj",
};
try zig_args.append(gpa, cmd);
if (graph.reference_trace) |some| {
try zig_args.append(gpa, try arena.print("-freference-trace={d}", .{some}));
}
try addFlag(gpa, zig_args, "allow-so-scripts", conf_comp.flags2.allow_so_scripts.toBool() orelse graph.allow_so_scripts);
try addFlag(gpa, zig_args, "llvm", conf_comp.flags2.use_llvm.toBool());
try addFlag(gpa, zig_args, "lld", conf_comp.flags2.use_lld.toBool());
try addFlag(gpa, zig_args, "new-linker", conf_comp.flags2.use_new_linker.toBool());
const root_module = conf_comp.root_module.get(conf);
if (root_module.resolved_target.get(conf).?.query.unwrap()) |query| {
if (query.get(conf).flags.object_format.unwrap()) |ofmt| {
try zig_args.append(gpa, try arena.print("-ofmt={t}", .{ofmt}));
}
}
switch (conf_comp.flags3.entry) {
.default => {},
.disabled => try zig_args.append(gpa, "-fno-entry"),
.enabled => try zig_args.append(gpa, "-fentry"),
.symbol_name => {
const symbol_name = conf_comp.entry.value.?.slice(conf);
try zig_args.append(gpa, try arena.print("-fentry={s}", .{symbol_name}));
},
}
for (conf_comp.force_undefined_symbols.slice) |symbol_name| {
try zig_args.appendSlice(gpa, &.{ "--force_undefined", symbol_name.slice(conf) });
}
if (conf_comp.stack_size.value) |stack_size| {
try zig_args.appendSlice(gpa, &.{ "--stack", try arena.print("{d}", .{stack_size}) });
}
try addBool(gpa, zig_args, "-ffuzz", fuzz);
{
var is_linking_libc = conf_comp.flags3.is_linking_libc;
var is_linking_libcpp = conf_comp.flags3.is_linking_libcpp;
// module, along with any C compiler arguments that need to be passed
// to the compiler for each module individually as reported by
// pkg-config.
var seen_system_libs: std.array_hash_map.Auto(Configuration.String, []const []const u8) = .empty;
var frameworks: std.array_hash_map.Auto(Configuration.String, Configuration.Module.Framework.Flags) = .empty;
var module_graph: ModuleGraph = .empty;
var prev_has_cflags = false;
var prev_has_rcflags = false;
var prev_search_strategy: Configuration.SystemLib.SearchStrategy = .paths_first;
var prev_preferred_link_mode: std.builtin.LinkMode = .dynamic;
// emitted if there is nothing to link.
var total_linker_objects: usize = @intFromBool(root_module.root_source_file != .none);
// libc and libc++ linkage.
for (try getCompileDependencies(arena, &module_graph, conf, compile_index, true)) |some_compile_index| {
const some_compile = some_compile_index.ptr(conf).extended.get(conf.extra).compile;
const modules = try getModuleList(arena, &module_graph, some_compile.root_module, conf);
for (modules.keys()) |mod_index| {
const mod = mod_index.get(conf);
is_linking_libc = is_linking_libc or mod.flags2.link_libc == .true;
is_linking_libcpp = is_linking_libcpp or mod.flags2.link_libcpp == .true;
}
}
var cli_named_modules = try CliNamedModules.init(arena, &module_graph, compile_index, maker);
// objects are already linked.
for (try getCompileDependencies(arena, &module_graph, conf, compile_index, false)) |dep_compile_index| {
const dep_compile = dep_compile_index.ptr(conf).extended.get(conf.extra).compile;
const modules = try getModuleList(arena, &module_graph, dep_compile.root_module, conf);
for (modules.keys()) |mod_index| {
const mod = mod_index.get(conf);
// already included in a library, it should not redundantly be
// placed on the linker line of the dependee.
const my_responsibility = dep_compile_index == compile_index;
const already_linked = !my_responsibility and dep_compile.isDynamicLibrary();
if (!already_linked) {
for (mod.frameworks.slice) |framework| {
try frameworks.put(arena, framework.name, framework.flags);
}
}
for (0..mod.link_objects.len) |lo_i| switch (mod.link_objects.get(conf.extra, lo_i)) {
.static_path => |static_path| {
if (my_responsibility) {
try zig_args.append(gpa, try maker.resolveLazyPathIndexAbs(arena, static_path, compile_index));
total_linker_objects += 1;
}
},
.system_lib => |system_lib_index| {
const system_lib = system_lib_index.get(conf);
const system_lib_name = system_lib.name.slice(conf);
const system_lib_gop = try seen_system_libs.getOrPut(arena, system_lib.name);
if (system_lib_gop.found_existing) {
try zig_args.appendSlice(gpa, system_lib_gop.value_ptr.*);
continue;
} else {
system_lib_gop.value_ptr.* = &.{};
}
if (already_linked)
continue;
if ((system_lib.flags.search_strategy != prev_search_strategy or
system_lib.flags.preferred_link_mode != prev_preferred_link_mode) and
conf_comp.flags2.linkage != .static)
{
try zig_args.ensureUnusedCapacity(gpa, 1);
switch (system_lib.flags.search_strategy) {
.no_fallback => switch (system_lib.flags.preferred_link_mode) {
.dynamic => zig_args.appendAssumeCapacity("-search_dylibs_only"),
.static => zig_args.appendAssumeCapacity("-search_static_only"),
},
.paths_first => switch (system_lib.flags.preferred_link_mode) {
.dynamic => zig_args.appendAssumeCapacity("-search_paths_first"),
.static => zig_args.appendAssumeCapacity("-search_paths_first_static"),
},
.mode_first => switch (system_lib.flags.preferred_link_mode) {
.dynamic => zig_args.appendAssumeCapacity("-search_dylibs_first"),
.static => zig_args.appendAssumeCapacity("-search_static_first"),
},
}
prev_search_strategy = system_lib.flags.search_strategy;
prev_preferred_link_mode = system_lib.flags.preferred_link_mode;
}
const prefix: []const u8 = prefix: {
if (system_lib.flags.needed) break :prefix "-needed-l";
if (system_lib.flags.weak) break :prefix "-weak-l";
break :prefix "-l";
};
l: {
pc: {
const force = switch (system_lib.flags.use_pkg_config) {
.no => break :pc,
.yes => false,
.force => true,
};
const pkg_conf_node = progress_node.start("pkg-config", 0);
defer pkg_conf_node.end();
if (PkgConfig.run(maker, step, arena, pkg_conf_node, system_lib_name, force)) |pc| {
try zig_args.appendSlice(gpa, pc.cflags);
try zig_args.appendSlice(gpa, pc.libs);
try seen_system_libs.put(arena, system_lib.name, pc.cflags);
break :l;
} else |err| switch (err) {
error.PkgConfigUnavailable,
error.PackageNotFound,
=> {
assert(!force);
break :pc;
},
else => |e| return e,
}
}
try zig_args.append(gpa, try arena.print("{s}{s}", .{
prefix, system_lib_name,
}));
}
},
.other_step => |other_step_index| {
const other = other_step_index.ptr(conf);
const other_compile = other.extended.get(conf.extra).compile;
switch (other_compile.flags3.kind) {
.exe => return step.fail(maker, "cannot link with an executable build artifact", .{}),
.@"test" => return step.fail(maker, "cannot link with a test", .{}),
.obj, .test_obj => {
const included_in_lib_or_obj = switch (dep_compile.flags3.kind) {
.lib, .obj, .test_obj => !my_responsibility,
else => false,
};
if (!already_linked and !included_in_lib_or_obj) {
try zig_args.append(gpa, try maker.resolveLazyPathAbs(
arena,
.{ .generated = .{ .index = other_compile.generated_bin.value.? } },
compile_index,
));
total_linker_objects += 1;
}
},
.lib => l: {
const other_produces_implib = other_compile.producesImplib(conf);
const other_is_static = other_produces_implib or other_compile.isStaticLibrary();
if (conf_comp.isStaticLibrary() and other_is_static) {
break :l;
}
// For everything else, we directly link
// against the library file.
const full_path_lib = try maker.resolveLazyPathAbs(
arena,
.{ .generated = .{
.index = if (other_produces_implib)
other_compile.generated_implib.value.?
else
other_compile.generated_bin.value.?,
} },
compile_index,
);
try zig_args.append(gpa, full_path_lib);
total_linker_objects += 1;
if (other_compile.flags2.linkage == .dynamic and
root_module_target.flags.os_tag != .windows)
{
if (Dir.path.dirname(full_path_lib)) |dirname| {
try zig_args.appendSlice(gpa, &.{ "-rpath", dirname });
}
}
},
}
},
.assembly_file => |asm_file| l: {
if (!my_responsibility) break :l;
if (prev_has_cflags) {
try zig_args.appendSlice(gpa, &.{ "-cflags", "--" });
prev_has_cflags = false;
}
try zig_args.append(gpa, try maker.resolveLazyPathIndexAbs(arena, asm_file, compile_index));
total_linker_objects += 1;
},
.c_source_file => |c_source_file_index| l: {
if (!my_responsibility) break :l;
const c_source_file = c_source_file_index.get(conf);
if (prev_has_cflags or c_source_file.args.slice.len != 0) {
try zig_args.ensureUnusedCapacity(gpa, 2 + c_source_file.args.slice.len);
zig_args.appendAssumeCapacity("-cflags");
for (c_source_file.args.slice) |arg| {
zig_args.appendAssumeCapacity(arg.slice(conf));
}
zig_args.appendAssumeCapacity("--");
}
prev_has_cflags = (c_source_file.args.slice.len != 0);
if (c_source_file.flags.lang.get()) |lang|
(try zig_args.addManyAsArray(gpa, 2)).* = .{ "-x", lang.clangIdentifier() };
try zig_args.append(gpa, try maker.resolveLazyPathIndexAbs(arena, c_source_file.file, compile_index));
if (c_source_file.flags.lang != .default)
(try zig_args.addManyAsArray(gpa, 2)).* = .{ "-x", "none" };
total_linker_objects += 1;
},
.c_source_files => |c_source_files_index| l: {
if (!my_responsibility) break :l;
const c_source_files = c_source_files_index.get(conf);
if (prev_has_cflags or c_source_files.args.slice.len != 0) {
try zig_args.ensureUnusedCapacity(gpa, 2 + c_source_files.args.slice.len);
zig_args.appendAssumeCapacity("-cflags");
for (c_source_files.args.slice) |arg| {
zig_args.appendAssumeCapacity(arg.slice(conf));
}
zig_args.appendAssumeCapacity("--");
}
prev_has_cflags = (c_source_files.args.slice.len != 0);
if (c_source_files.flags.lang.get()) |lang|
(try zig_args.addManyAsArray(gpa, 2)).* = .{ "-x", lang.clangIdentifier() };
const root_path = try maker.resolveLazyPathIndexAbs(arena, c_source_files.root, compile_index);
try zig_args.ensureUnusedCapacity(gpa, c_source_files.sub_paths.slice.len);
for (c_source_files.sub_paths.slice) |sub_path| {
zig_args.appendAssumeCapacity(try Dir.path.join(arena, &.{
root_path, sub_path.slice(conf),
}));
}
if (c_source_files.flags.lang != .default)
(try zig_args.addManyAsArray(gpa, 2)).* = .{ "-x", "none" };
total_linker_objects += c_source_files.sub_paths.slice.len;
},
.win32_resource_file => |rc_source_file_index| l: {
if (!my_responsibility) break :l;
const rc_source_file = rc_source_file_index.get(conf);
if (rc_source_file.args.slice.len == 0 and rc_source_file.include_paths.slice.len == 0) {
if (prev_has_rcflags) {
(try zig_args.addManyAsArray(gpa, 2)).* = .{ "-rcflags", "--" };
prev_has_rcflags = false;
}
} else {
try zig_args.ensureUnusedCapacity(gpa, 1 + rc_source_file.args.slice.len);
zig_args.appendAssumeCapacity("-rcflags");
for (rc_source_file.args.slice) |arg| {
zig_args.appendAssumeCapacity(arg.slice(conf));
}
try zig_args.ensureUnusedCapacity(gpa, 1 + 2 * rc_source_file.include_paths.slice.len);
for (rc_source_file.include_paths.slice) |include_path| {
zig_args.appendAssumeCapacity("/I");
zig_args.appendAssumeCapacity(try maker.resolveLazyPathIndexAbs(arena, include_path, compile_index));
}
zig_args.appendAssumeCapacity("--");
prev_has_rcflags = true;
}
try zig_args.append(gpa, try maker.resolveLazyPathIndexAbs(arena, rc_source_file.file, compile_index));
total_linker_objects += 1;
},
};
// have the correct parent module, but only if the module is part of
// this compilation.
if (!my_responsibility) continue;
if (cli_named_modules.modules.getIndex(mod_index)) |module_cli_index| {
const module_cli_name = cli_named_modules.names.keys()[module_cli_index];
const module_index = cli_named_modules.modules.keys()[module_cli_index];
try appendModuleFlags(arena, module_index, zig_args, compile_index, maker);
const imports = mod.import_table.get(conf).imports.mal;
try zig_args.ensureUnusedCapacity(gpa, imports.len * 2);
for (imports.items(.name), imports.items(.module)) |name, import| {
const import_index = cli_named_modules.modules.getIndex(import).?;
const import_cli_name = cli_named_modules.names.keys()[import_index];
zig_args.appendAssumeCapacity("--dep");
const name_slice = name.slice(conf);
if (mem.eql(u8, import_cli_name, name_slice)) {
zig_args.appendAssumeCapacity(import_cli_name);
} else {
zig_args.appendAssumeCapacity(try arena.print("{s}={s}", .{
name_slice, import_cli_name,
}));
}
}
// implies the existence of a Zig compilation unit based on
// whether there is a root source file. If there is no root
// source file, then this is not a zig compilation unit - it is
// perhaps a set of linker objects, or C source files instead.
// Linker objects are added to the CLI globally, while C source
// files must have a module parent.
try zig_args.ensureUnusedCapacity(gpa, 1);
if (mod.root_source_file.unwrap()) |lp| {
const src = try maker.resolveLazyPathIndexAbs(arena, lp, compile_index);
zig_args.appendAssumeCapacity(try arena.print("-M{s}={s}", .{ module_cli_name, src }));
} else if (moduleNeedsCliArg(&mod, conf)) {
zig_args.appendAssumeCapacity(try arena.print("-M{s}", .{module_cli_name}));
}
}
}
}
if (total_linker_objects == 0) {
return step.fail(maker, "the linker needs one or more objects to link", .{});
}
for (frameworks.keys(), frameworks.values()) |name, info| {
try zig_args.ensureUnusedCapacity(gpa, 2);
if (info.needed) {
zig_args.appendAssumeCapacity("-needed_framework");
} else if (info.weak) {
zig_args.appendAssumeCapacity("-weak_framework");
} else {
zig_args.appendAssumeCapacity("-framework");
}
zig_args.appendAssumeCapacity(name.slice(conf));
}
try zig_args.ensureUnusedCapacity(gpa, 2);
if (is_linking_libcpp) zig_args.appendAssumeCapacity("-lc++");
if (is_linking_libc) zig_args.appendAssumeCapacity("-lc");
compile.is_linking_libc = is_linking_libc;
}
if (conf_comp.win32_manifest.value) |manifest_file| {
try zig_args.append(gpa, try maker.resolveLazyPathIndexAbs(arena, manifest_file, compile_index));
}
if (conf_comp.win32_module_definition.value) |module_file| {
try zig_args.append(gpa, try maker.resolveLazyPathIndexAbs(arena, module_file, compile_index));
}
if (conf_comp.image_base.value) |image_base| {
(try zig_args.addManyAsArray(gpa, 2)).* = .{
"--image-base", try arena.print("0x{x}", .{image_base}),
};
}
for (conf_comp.filters.slice) |filter| {
(try zig_args.addManyAsArray(gpa, 2)).* = .{ "--test-filter", filter.slice(conf) };
}
switch (conf_comp.test_runner.u) {
.default => {},
.simple, .server => |lp| (try zig_args.addManyAsArray(gpa, 2)).* = .{
"--test-runner", try maker.resolveLazyPathIndexAbs(arena, lp, compile_index),
},
}
for (graph.debug_log_scopes.items) |log_scope| {
(try zig_args.addManyAsArray(gpa, 2)).* = .{ "--debug-log", log_scope };
}
try addBool(gpa, zig_args, "--debug-compile-errors", graph.debug_compile_errors);
try addBool(gpa, zig_args, "--debug-incremental", graph.debug_incremental);
try addBool(gpa, zig_args, "--verbose-air", graph.verbose_air);
try addBool(gpa, zig_args, "--verbose-llvm-ir", graph.verbose_llvm_ir);
try addBool(gpa, zig_args, "--verbose-link", graph.verbose_link or conf_comp.flags.verbose_link);
try addBool(gpa, zig_args, "--verbose-cc", graph.verbose_cc or conf_comp.flags.verbose_cc);
try addBool(gpa, zig_args, "--verbose-llvm-cpu-features", graph.verbose_llvm_cpu_features);
try addBool(gpa, zig_args, "--time-report", graph.time_report);
if (conf_comp.generated_bin.value == null) try zig_args.append(gpa, "-fno-emit-bin");
if (conf_comp.generated_asm.value != null) try zig_args.append(gpa, "-femit-asm");
if (conf_comp.generated_docs.value != null) try zig_args.append(gpa, "-femit-docs");
if (conf_comp.generated_implib.value != null) try zig_args.append(gpa, "-femit-implib");
if (conf_comp.generated_llvm_bc.value != null) try zig_args.append(gpa, "-femit-llvm-bc");
if (conf_comp.generated_llvm_ir.value != null) try zig_args.append(gpa, "-femit-llvm-ir");
if (conf_comp.generated_h.value != null) try zig_args.append(gpa, "-femit-h");
try addFlag(gpa, zig_args, "formatted-panics", conf_comp.flags2.formatted_panics.toBool());
switch (conf_comp.flags3.compress_debug_sections) {
.none => {},
.zlib => try zig_args.append(gpa, "--compress-debug-sections=zlib"),
.zstd => try zig_args.append(gpa, "--compress-debug-sections=zstd"),
}
try addBool(gpa, zig_args, "--eh-frame-hdr", conf_comp.flags.link_eh_frame_hdr);
try addBool(gpa, zig_args, "--emit-relocs", conf_comp.flags.link_emit_relocs);
try addBool(gpa, zig_args, "-ffunction-sections", conf_comp.flags.link_function_sections);
try addBool(gpa, zig_args, "-fdata-sections", conf_comp.flags.link_data_sections);
if (conf_comp.flags2.link_gc_sections.toBool()) |x|
try zig_args.append(gpa, if (x) "--gc-sections" else "--no-gc-sections");
if (!conf_comp.flags.linker_dynamicbase)
try zig_args.append(gpa, "--no-dynamicbase");
try addFlag(gpa, zig_args, "allow-shlib-undefined", conf_comp.flags2.linker_allow_shlib_undefined.toBool());
if (conf_comp.flags.link_z_notext) (try zig_args.addManyAsArray(gpa, 2)).* = .{ "-z", "notext" };
if (!conf_comp.flags.link_z_relro) (try zig_args.addManyAsArray(gpa, 2)).* = .{ "-z", "norelro" };
if (conf_comp.flags.link_z_lazy) (try zig_args.addManyAsArray(gpa, 2)).* = .{ "-z", "lazy" };
if (conf_comp.link_z_common_page_size.value) |size| (try zig_args.addManyAsArray(gpa, 2)).* = .{
"-z", try arena.print("common-page-size={d}", .{size}),
};
if (conf_comp.link_z_max_page_size.value) |size| (try zig_args.addManyAsArray(gpa, 2)).* = .{
"-z", try arena.print("max-page-size={d}", .{size}),
};
if (conf_comp.flags.link_z_defs) (try zig_args.addManyAsArray(gpa, 2)).* = .{ "-z", "defs" };
try zig_args.ensureUnusedCapacity(gpa, 2);
if (conf_comp.libc_file.value) |libc_file| {
zig_args.appendAssumeCapacity("--libc");
zig_args.appendAssumeCapacity(try maker.resolveLazyPathIndexAbs(arena, libc_file, compile_index));
} else if (graph.libc_file) |libc_file| {
zig_args.appendAssumeCapacity("--libc");
zig_args.appendAssumeCapacity(libc_file);
}
(try zig_args.addManyAsArray(gpa, 4)).* = .{
"--cache-dir", graph.local_cache_root.path orelse ".",
"--global-cache-dir", graph.global_cache_root.path orelse ".",
};
try zig_args.ensureUnusedCapacity(gpa, 1);
if (graph.debug_compiler_runtime_libs) |mode| switch (mode) {
.Debug => zig_args.appendAssumeCapacity("--debug-rt"),
else => zig_args.appendAssumeCapacity(try arena.print("--debug-rt={t}", .{mode})),
};
{
try zig_args.ensureUnusedCapacity(gpa, 7);
zig_args.addManyAsArrayAssumeCapacity(2).* = .{ "--name", conf_comp.root_name.slice(conf) };
switch (conf_comp.flags2.linkage) {
.dynamic => zig_args.appendAssumeCapacity("-dynamic"),
.static => zig_args.appendAssumeCapacity("-static"),
.default => {},
}
if (conf_comp.flags3.kind == .lib and conf_comp.flags2.linkage == .dynamic) {
if (conf_comp.version.value) |version| zig_args.addManyAsArrayAssumeCapacity(2).* = .{
"--version", version.slice(conf),
};
const os_tag = root_module_target.flags.os_tag.unwrap().?;
if (os_tag.isDarwin()) {
const abi = root_module_target.flags.abi.unwrap().?;
zig_args.addManyAsArrayAssumeCapacity(2).* = .{
"-install_name",
if (conf_comp.install_name.value) |s| s.slice(conf) else try arena.print("@rpath/{s}{s}{s}", .{
os_tag.libPrefix(abi), conf_comp.root_name.slice(conf), os_tag.dynamicLibSuffix(),
}),
};
}
}
}
if (conf_comp.entitlements.value) |entitlements| {
(try zig_args.addManyAsArray(gpa, 2)).* = .{
"--entitlements", try maker.resolveLazyPathIndexAbs(arena, entitlements, compile_index),
};
}
if (conf_comp.pagezero_size.value) |pagezero_size| {
(try zig_args.addManyAsArray(gpa, 2)).* = .{
"-pagezero_size", try arena.print("{x}", .{pagezero_size}),
};
}
if (conf_comp.headerpad_size.value) |headerpad_size| {
(try zig_args.addManyAsArray(gpa, 2)).* = .{
"-headerpad", try arena.print("{x}", .{headerpad_size}),
};
}
try addBool(gpa, zig_args, "-headerpad_max_install_names", conf_comp.flags.headerpad_max_install_names);
try addBool(gpa, zig_args, "-dead_strip_dylibs", conf_comp.flags.dead_strip_dylibs);
try addBool(gpa, zig_args, "-ObjC", conf_comp.flags.force_load_objc);
try addBool(gpa, zig_args, "--discard-all", conf_comp.flags.discard_local_symbols);
try addFlag(gpa, zig_args, "compiler-rt", conf_comp.flags2.bundle_compiler_rt.toBool());
try addFlag(gpa, zig_args, "ubsan-rt", conf_comp.flags2.bundle_ubsan_rt.toBool());
try addFlag(gpa, zig_args, "dll-export-fns", conf_comp.flags2.dll_export_fns.toBool());
try addBool(gpa, zig_args, "-rdynamic", conf_comp.flags.rdynamic);
try addBool(gpa, zig_args, "--import-memory", conf_comp.flags.import_memory);
try addBool(gpa, zig_args, "--export-memory", conf_comp.flags.export_memory);
try addBool(gpa, zig_args, "--import-symbols", conf_comp.flags.import_symbols);
try addBool(gpa, zig_args, "--import-table", conf_comp.flags.import_table);
try addBool(gpa, zig_args, "--export-table", conf_comp.flags.export_table);
try addBool(gpa, zig_args, "--shared-memory", conf_comp.flags.shared_memory);
{
try zig_args.ensureUnusedCapacity(gpa, 4);
if (conf_comp.initial_memory.value) |initial_memory| {
zig_args.appendAssumeCapacity(try arena.print("--initial-memory={d}", .{initial_memory}));
}
if (conf_comp.max_memory.value) |max_memory| {
zig_args.appendAssumeCapacity(try arena.print("--max-memory={d}", .{max_memory}));
}
if (conf_comp.global_base.value) |global_base| {
zig_args.appendAssumeCapacity(try arena.print("--global-base={d}", .{global_base}));
}
switch (conf_comp.flags3.wasi_exec_model) {
.default => {},
.command => zig_args.appendAssumeCapacity("-mexec-model=command"),
.reactor => zig_args.appendAssumeCapacity("-mexec-model=reactor"),
}
}
if (conf_comp.linker_script.value) |linker_script| (try zig_args.addManyAsArray(gpa, 2)).* = .{
"--script", try maker.resolveLazyPathIndexAbs(arena, linker_script, compile_index),
};
if (conf_comp.version_script.value) |version_script| (try zig_args.addManyAsArray(gpa, 2)).* = .{
"--version-script", try maker.resolveLazyPathIndexAbs(arena, version_script, compile_index),
};
if (conf_comp.flags2.linker_allow_undefined_version.toBool()) |x| {
try zig_args.append(gpa, if (x) "--undefined-version" else "--no-undefined-version");
}
if (conf_comp.flags2.linker_enable_new_dtags.toBool()) |enabled| {
try zig_args.append(gpa, if (enabled) "--enable-new-dtags" else "--disable-new-dtags");
}
if (graph.sysroot) |sysroot| try zig_args.appendSlice(gpa, &.{ "--sysroot", sysroot });
const cwd: Io.Dir = .cwd();
const io = graph.io;
for (graph.search_prefixes.items) |search_prefix| {
var prefix_dir = cwd.openDir(io, search_prefix, .{}) catch |err| {
return step.fail(maker, "unable to open prefix directory {q}: {t}", .{ search_prefix, err });
};
defer prefix_dir.close(io);
// This prevents a warning, that should probably be upgraded to an error in Zig's
// CLI parsing code, when the linker sees an -L directory that does not exist.
if (prefix_dir.access(io, "lib", .{})) |_| {
try zig_args.appendSlice(gpa, &.{
"-L", try Dir.path.join(arena, &.{ search_prefix, "lib" }),
});
} else |err| switch (err) {
error.FileNotFound => {},
else => |e| return step.fail(maker, "unable to access {s}/lib directory: {t}", .{ search_prefix, e }),
}
if (prefix_dir.access(io, "include", .{})) |_| {
try zig_args.appendSlice(gpa, &.{
"-I", try Dir.path.join(arena, &.{ search_prefix, "include" }),
});
} else |err| switch (err) {
error.FileNotFound => {},
else => |e| return step.fail(maker, "unable to access {s}/include directory: {t}", .{ search_prefix, e }),
}
}
if (conf_comp.flags3.rc_includes != .any) (try zig_args.addManyAsArray(gpa, 2)).* = .{
"-rcincludes", @tagName(conf_comp.flags3.rc_includes),
};
try addFlag(gpa, zig_args, "each-lib-rpath", conf_comp.flags2.each_lib_rpath.toBool());
if (conf_comp.flags3.build_id.unwrap(conf_comp.build_id.value, conf) orelse graph.build_id) |build_id| {
try zig_args.append(gpa, switch (build_id) {
.hexstring => |hs| try arena.print("--build-id=0x{x}", .{hs.toSlice()}),
.none, .fast, .uuid, .sha1, .md5 => try arena.print("--build-id={t}", .{build_id}),
});
}
const opt_zig_lib_dir: ?[]const u8 = if (conf_comp.zig_lib_dir.value) |dir|
try maker.resolveLazyPathIndexAbs(arena, dir, compile_index)
else if (graph.zig_lib_directory.path) |_|
try arena.print("{f}", .{graph.zig_lib_directory})
else
null;
if (opt_zig_lib_dir) |zig_lib_dir| (try zig_args.addManyAsArray(gpa, 2)).* = .{
"--zig-lib-dir", zig_lib_dir,
};
try addFlag(gpa, zig_args, "PIE", conf_comp.flags2.pie.toBool());
try zig_args.ensureUnusedCapacity(gpa, 1);
switch (conf_comp.flags3.lto) {
.full => zig_args.appendAssumeCapacity("-flto=full"),
.thin => zig_args.appendAssumeCapacity("-flto=thin"),
.none => zig_args.appendAssumeCapacity("-fno-lto"),
.default => {},
}
try addFlag(gpa, zig_args, "sanitize-coverage-trace-pc-guard", conf_comp.flags2.sanitize_coverage_trace_pc_guard.toBool());
switch (conf_comp.flags3.subsystem) {
.default => {},
else => |t| (try zig_args.addManyAsArray(gpa, 2)).* = .{ "--subsystem", @tagName(t) },
}
try addBool(gpa, zig_args, "-municode", conf_comp.flags.mingw_unicode_entry_point);
if (conf_comp.error_limit.value orelse graph.error_limit) |err_limit| (try zig_args.addManyAsArray(gpa, 2)).* = .{
"--error-limit", try arena.print("{d}", .{err_limit}),
};
try addFlag(gpa, zig_args, "incremental", conf_comp.flags4.incremental.toBool() orelse graph.incremental);
try zig_args.append(gpa, "--listen=-");
// 2,097,152. If our args exceed 30 KiB, we instead write them to a "response file" and
// pass that to zig, e.g. via 'zig build-lib @args.rsp'
// See @file syntax here: https://gcc.gnu.org/onlinedocs/gcc/Overall-Options.html
var args_length: usize = 0;
for (zig_args.items) |arg| {
args_length += arg.len + 1;
}
if (args_length >= 30 * 1024) {
const local_cache_root = graph.local_cache_root;
const args_path: Path = .{ .root_dir = local_cache_root, .sub_path = "args" };
args_path.root_dir.handle.createDirPath(io, args_path.sub_path) catch |err|
return step.fail(maker, "failed creating directory {f}: {t}", .{ args_path, err });
const args_to_escape = zig_args.items[2..];
var escaped_args = try std.array_list.Managed([]const u8).initCapacity(arena, args_to_escape.len);
arg_blk: for (args_to_escape) |arg| {
for (arg, 0..) |c, arg_idx| {
if (c == '\\' or c == '"') {
var escaped: std.ArrayList(u8) = .empty;
try escaped.ensureTotalCapacityPrecise(arena, arg.len + 1);
try escaped.appendSlice(arena, arg[0..arg_idx]);
for (arg[arg_idx..]) |to_escape| {
if (to_escape == '\\' or to_escape == '"') try escaped.append(arena, '\\');
try escaped.append(arena, to_escape);
}
escaped_args.appendAssumeCapacity(escaped.items);
continue :arg_blk;
}
}
escaped_args.appendAssumeCapacity(arg);
}
// other zig build commands running in parallel.
const partially_quoted = try mem.join(arena, "\" \"", escaped_args.items);
const args = try mem.concat(arena, u8, &[_][]const u8{ "\"", partially_quoted, "\"" });
var args_hash: [Sha256.digest_length]u8 = undefined;
Sha256.hash(args, &args_hash, .{});
var args_hex_hash: [Sha256.digest_length * 2]u8 = undefined;
_ = std.fmt.bufPrint(&args_hex_hash, "{x}", .{&args_hash}) catch unreachable;
const args_file = "args" ++ Dir.path.sep_str ++ args_hex_hash;
local_cache_root.handle.access(io, args_file, .{}) catch {
var af = local_cache_root.handle.createFileAtomic(io, args_file, .{
.replace = false,
.make_path = true,
}) catch |e| return step.fail(maker, "failed creating tmp args file {f}{s}: {t}", .{
local_cache_root, args_file, e,
});
defer af.deinit(io);
af.file.writeStreamingAll(io, args) catch |e| {
return step.fail(maker, "failed writing args data to tmp file {f}{s}: {t}", .{
local_cache_root, args_file, e,
});
};
// success, because that might interfere with another build
// process that needs the same file.
af.link(io) catch |e| switch (e) {
error.PathAlreadyExists => {
},
else => |other_err| return step.fail(maker, "failed linking tmp file {f}{s}: {t}", .{
local_cache_root, args_file, other_err,
}),
};
};
const resolved_args_file = try mem.concat(arena, u8, &.{
"@", try local_cache_root.join(arena, &.{args_file}),
});
zig_args.shrinkRetainingCapacity(2);
try zig_args.append(gpa, resolved_args_file);
}
}
