const std = @import("std"); const builtin = @import("builtin"); const assert = std.debug.assert; const io = std.io; const fs = std.fs; const mem = std.mem; const process = std.process; const Allocator = mem.Allocator; const ArrayList = std.ArrayList; const Ast = std.zig.Ast; const Color = std.zig.Color; const warn = std.log.warn; const ThreadPool = std.Thread.Pool; const cleanExit = std.process.cleanExit; const tracy = @import("tracy.zig"); const Compilation = @import("Compilation.zig"); const link = @import("link.zig"); const Package = @import("Package.zig"); const build_options = @import("build_options"); const introspect = @import("introspect.zig"); const EnvVar = std.zig.EnvVar; const LibCInstallation = std.zig.LibCInstallation; const wasi_libc = @import("wasi_libc.zig"); const Cache = std.Build.Cache; const target_util = @import("target.zig"); const crash_report = @import("crash_report.zig"); const Module = @import("Module.zig"); const AstGen = std.zig.AstGen; const mingw = @import("mingw.zig"); const Server = std.zig.Server; pub const std_options = .{ .wasiCwd = wasi_cwd, .logFn = log, .enable_segfault_handler = false, .log_level = switch (builtin.mode) { .Debug => .debug, .ReleaseSafe, .ReleaseFast => .info, .ReleaseSmall => .err, }, }; // Crash report needs to override the panic handler pub const panic = crash_report.panic; var wasi_preopens: fs.wasi.Preopens = undefined; pub fn wasi_cwd() std.os.wasi.fd_t { // Expect the first preopen to be current working directory. const cwd_fd: std.os.fd_t = 3; assert(mem.eql(u8, wasi_preopens.names[cwd_fd], ".")); return cwd_fd; } fn getWasiPreopen(name: []const u8) Compilation.Directory { return .{ .path = name, .handle = .{ .fd = wasi_preopens.find(name) orelse fatal("WASI preopen not found: '{s}'", .{name}), }, }; } pub fn fatal(comptime format: []const u8, args: anytype) noreturn { std.log.err(format, args); process.exit(1); } const debug_extensions_enabled = builtin.mode == .Debug; const normal_usage = \\Usage: zig [command] [options] \\ \\Commands: \\ \\ build Build project from build.zig \\ fetch Copy a package into global cache and print its hash \\ init Initialize a Zig package in the current directory \\ \\ build-exe Create executable from source or object files \\ build-lib Create library from source or object files \\ build-obj Create object from source or object files \\ test Perform unit testing \\ run Create executable and run immediately \\ \\ ast-check Look for simple compile errors in any set of files \\ fmt Reformat Zig source into canonical form \\ reduce Minimize a bug report \\ translate-c Convert C code to Zig code \\ \\ ar Use Zig as a drop-in archiver \\ cc Use Zig as a drop-in C compiler \\ c++ Use Zig as a drop-in C++ compiler \\ dlltool Use Zig as a drop-in dlltool.exe \\ lib Use Zig as a drop-in lib.exe \\ ranlib Use Zig as a drop-in ranlib \\ objcopy Use Zig as a drop-in objcopy \\ rc Use Zig as a drop-in rc.exe \\ \\ env Print lib path, std path, cache directory, and version \\ help Print this help and exit \\ libc Display native libc paths file or validate one \\ targets List available compilation targets \\ version Print version number and exit \\ zen Print Zen of Zig and exit \\ \\General Options: \\ \\ -h, --help Print command-specific usage \\ ; const debug_usage = normal_usage ++ \\ \\Debug Commands: \\ \\ changelist Compute mappings from old ZIR to new ZIR \\ dump-zir Dump a file containing cached ZIR \\ ; const usage = if (debug_extensions_enabled) debug_usage else normal_usage; var log_scopes: std.ArrayListUnmanaged([]const u8) = .{}; pub fn log( comptime level: std.log.Level, comptime scope: @TypeOf(.EnumLiteral), comptime format: []const u8, args: anytype, ) void { // Hide debug messages unless: // * logging enabled with `-Dlog`. // * the --debug-log arg for the scope has been provided if (@intFromEnum(level) > @intFromEnum(std.options.log_level) or @intFromEnum(level) > @intFromEnum(std.log.Level.info)) { if (!build_options.enable_logging) return; const scope_name = @tagName(scope); for (log_scopes.items) |log_scope| { if (mem.eql(u8, log_scope, scope_name)) break; } else return; } const prefix1 = comptime level.asText(); const prefix2 = if (scope == .default) ": " else "(" ++ @tagName(scope) ++ "): "; // Print the message to stderr, silently ignoring any errors std.debug.print(prefix1 ++ prefix2 ++ format ++ "\n", args); } var general_purpose_allocator = std.heap.GeneralPurposeAllocator(.{ .stack_trace_frames = build_options.mem_leak_frames, }){}; pub fn main() anyerror!void { crash_report.initialize(); const use_gpa = (build_options.force_gpa or !builtin.link_libc) and builtin.os.tag != .wasi; const gpa = gpa: { if (builtin.os.tag == .wasi) { break :gpa std.heap.wasm_allocator; } if (use_gpa) { break :gpa general_purpose_allocator.allocator(); } // We would prefer to use raw libc allocator here, but cannot // use it if it won't support the alignment we need. if (@alignOf(std.c.max_align_t) < @alignOf(i128)) { break :gpa std.heap.c_allocator; } break :gpa std.heap.raw_c_allocator; }; defer if (use_gpa) { _ = general_purpose_allocator.deinit(); }; var arena_instance = std.heap.ArenaAllocator.init(gpa); defer arena_instance.deinit(); const arena = arena_instance.allocator(); const args = try process.argsAlloc(arena); if (tracy.enable_allocation) { var gpa_tracy = tracy.tracyAllocator(gpa); return mainArgs(gpa_tracy.allocator(), arena, args); } if (builtin.os.tag == .wasi) { wasi_preopens = try fs.wasi.preopensAlloc(arena); } // Short circuit some of the other logic for bootstrapping. if (build_options.only_c) { if (mem.eql(u8, args[1], "build-exe")) { return buildOutputType(gpa, arena, args, .{ .build = .Exe }); } else if (mem.eql(u8, args[1], "build-obj")) { return buildOutputType(gpa, arena, args, .{ .build = .Obj }); } else { @panic("only build-exe or build-obj is supported in a -Donly-c build"); } } return mainArgs(gpa, arena, args); } /// Check that LLVM and Clang have been linked properly so that they are using the same /// libc++ and can safely share objects with pointers to static variables in libc++ fn verifyLibcxxCorrectlyLinked() void { if (build_options.have_llvm and ZigClangIsLLVMUsingSeparateLibcxx()) { fatal( \\Zig was built/linked incorrectly: LLVM and Clang have separate copies of libc++ \\ If you are dynamically linking LLVM, make sure you dynamically link libc++ too , .{}); } } fn mainArgs(gpa: Allocator, arena: Allocator, args: []const []const u8) !void { if (args.len <= 1) { std.log.info("{s}", .{usage}); fatal("expected command argument", .{}); } if (process.can_execv and std.os.getenvZ("ZIG_IS_DETECTING_LIBC_PATHS") != null) { // In this case we have accidentally invoked ourselves as "the system C compiler" // to figure out where libc is installed. This is essentially infinite recursion // via child process execution due to the CC environment variable pointing to Zig. // Here we ignore the CC environment variable and exec `cc` as a child process. // However it's possible Zig is installed as *that* C compiler as well, which is // why we have this additional environment variable here to check. var env_map = try process.getEnvMap(arena); const inf_loop_env_key = "ZIG_IS_TRYING_TO_NOT_CALL_ITSELF"; if (env_map.get(inf_loop_env_key) != null) { fatal("The compilation links against libc, but Zig is unable to provide a libc " ++ "for this operating system, and no --libc " ++ "parameter was provided, so Zig attempted to invoke the system C compiler " ++ "in order to determine where libc is installed. However the system C " ++ "compiler is `zig cc`, so no libc installation was found.", .{}); } try env_map.put(inf_loop_env_key, "1"); // Some programs such as CMake will strip the `cc` and subsequent args from the // CC environment variable. We detect and support this scenario here because of // the ZIG_IS_DETECTING_LIBC_PATHS environment variable. if (mem.eql(u8, args[1], "cc")) { return process.execve(arena, args[1..], &env_map); } else { const modified_args = try arena.dupe([]const u8, args); modified_args[0] = "cc"; return process.execve(arena, modified_args, &env_map); } } const cmd = args[1]; const cmd_args = args[2..]; if (mem.eql(u8, cmd, "build-exe")) { return buildOutputType(gpa, arena, args, .{ .build = .Exe }); } else if (mem.eql(u8, cmd, "build-lib")) { return buildOutputType(gpa, arena, args, .{ .build = .Lib }); } else if (mem.eql(u8, cmd, "build-obj")) { return buildOutputType(gpa, arena, args, .{ .build = .Obj }); } else if (mem.eql(u8, cmd, "test")) { return buildOutputType(gpa, arena, args, .zig_test); } else if (mem.eql(u8, cmd, "run")) { return buildOutputType(gpa, arena, args, .run); } else if (mem.eql(u8, cmd, "dlltool") or mem.eql(u8, cmd, "ranlib") or mem.eql(u8, cmd, "lib") or mem.eql(u8, cmd, "ar")) { return process.exit(try llvmArMain(arena, args)); } else if (mem.eql(u8, cmd, "build")) { return cmdBuild(gpa, arena, cmd_args); } else if (mem.eql(u8, cmd, "clang") or mem.eql(u8, cmd, "-cc1") or mem.eql(u8, cmd, "-cc1as")) { return process.exit(try clangMain(arena, args)); } else if (mem.eql(u8, cmd, "ld.lld") or mem.eql(u8, cmd, "lld-link") or mem.eql(u8, cmd, "wasm-ld")) { return process.exit(try lldMain(arena, args, true)); } else if (build_options.only_core_functionality) { @panic("only a few subcommands are supported in a zig2.c build"); } else if (mem.eql(u8, cmd, "cc")) { return buildOutputType(gpa, arena, args, .cc); } else if (mem.eql(u8, cmd, "c++")) { return buildOutputType(gpa, arena, args, .cpp); } else if (mem.eql(u8, cmd, "translate-c")) { return buildOutputType(gpa, arena, args, .translate_c); } else if (mem.eql(u8, cmd, "rc")) { return cmdRc(gpa, arena, args[1..]); } else if (mem.eql(u8, cmd, "fmt")) { return jitCmd(gpa, arena, cmd_args, .{ .cmd_name = "fmt", .root_src_path = "fmt.zig", }); } else if (mem.eql(u8, cmd, "objcopy")) { return @import("objcopy.zig").cmdObjCopy(gpa, arena, cmd_args); } else if (mem.eql(u8, cmd, "fetch")) { return cmdFetch(gpa, arena, cmd_args); } else if (mem.eql(u8, cmd, "libc")) { return jitCmd(gpa, arena, cmd_args, .{ .cmd_name = "libc", .root_src_path = "libc.zig", .prepend_zig_lib_dir_path = true, }); } else if (mem.eql(u8, cmd, "init")) { return cmdInit(gpa, arena, cmd_args); } else if (mem.eql(u8, cmd, "targets")) { const host = std.zig.resolveTargetQueryOrFatal(.{}); const stdout = io.getStdOut().writer(); return @import("print_targets.zig").cmdTargets(arena, cmd_args, stdout, host); } else if (mem.eql(u8, cmd, "version")) { try std.io.getStdOut().writeAll(build_options.version ++ "\n"); // Check libc++ linkage to make sure Zig was built correctly, but only // for "env" and "version" to avoid affecting the startup time for // build-critical commands (check takes about ~10 μs) return verifyLibcxxCorrectlyLinked(); } else if (mem.eql(u8, cmd, "env")) { verifyLibcxxCorrectlyLinked(); return @import("print_env.zig").cmdEnv(arena, cmd_args, io.getStdOut().writer()); } else if (mem.eql(u8, cmd, "reduce")) { return jitCmd(gpa, arena, cmd_args, .{ .cmd_name = "reduce", .root_src_path = "reduce.zig", }); } else if (mem.eql(u8, cmd, "zen")) { return io.getStdOut().writeAll(info_zen); } else if (mem.eql(u8, cmd, "help") or mem.eql(u8, cmd, "-h") or mem.eql(u8, cmd, "--help")) { return io.getStdOut().writeAll(usage); } else if (mem.eql(u8, cmd, "ast-check")) { return cmdAstCheck(gpa, arena, cmd_args); } else if (debug_extensions_enabled and mem.eql(u8, cmd, "changelist")) { return cmdChangelist(gpa, arena, cmd_args); } else if (debug_extensions_enabled and mem.eql(u8, cmd, "dump-zir")) { return cmdDumpZir(gpa, arena, cmd_args); } else { std.log.info("{s}", .{usage}); fatal("unknown command: {s}", .{args[1]}); } } const usage_build_generic = \\Usage: zig build-exe [options] [files] \\ zig build-lib [options] [files] \\ zig build-obj [options] [files] \\ zig test [options] [files] \\ zig run [options] [files] [-- [args]] \\ zig translate-c [options] [file] \\ \\Supported file types: \\ .zig Zig source code \\ .o ELF object file \\ .o Mach-O (macOS) object file \\ .o WebAssembly object file \\ .obj COFF (Windows) object file \\ .lib COFF (Windows) static library \\ .a ELF static library \\ .a Mach-O (macOS) static library \\ .a WebAssembly static library \\ .so ELF shared object (dynamic link) \\ .dll Windows Dynamic Link Library \\ .dylib Mach-O (macOS) dynamic library \\ .tbd (macOS) text-based dylib definition \\ .s Target-specific assembly source code \\ .S Assembly with C preprocessor (requires LLVM extensions) \\ .c C source code (requires LLVM extensions) \\ .cxx .cc .C .cpp .stub C++ source code (requires LLVM extensions) \\ .m Objective-C source code (requires LLVM extensions) \\ .mm Objective-C++ source code (requires LLVM extensions) \\ .bc LLVM IR Module (requires LLVM extensions) \\ .cu Cuda source code (requires LLVM extensions) \\ \\General Options: \\ -h, --help Print this help and exit \\ --color [auto|off|on] Enable or disable colored error messages \\ -femit-bin[=path] (default) Output machine code \\ -fno-emit-bin Do not output machine code \\ -femit-asm[=path] Output .s (assembly code) \\ -fno-emit-asm (default) Do not output .s (assembly code) \\ -femit-llvm-ir[=path] Produce a .ll file with optimized LLVM IR (requires LLVM extensions) \\ -fno-emit-llvm-ir (default) Do not produce a .ll file with optimized LLVM IR \\ -femit-llvm-bc[=path] Produce an optimized LLVM module as a .bc file (requires LLVM extensions) \\ -fno-emit-llvm-bc (default) Do not produce an optimized LLVM module as a .bc file \\ -femit-h[=path] Generate a C header file (.h) \\ -fno-emit-h (default) Do not generate a C header file (.h) \\ -femit-docs[=path] Create a docs/ dir with html documentation \\ -fno-emit-docs (default) Do not produce docs/ dir with html documentation \\ -femit-implib[=path] (default) Produce an import .lib when building a Windows DLL \\ -fno-emit-implib Do not produce an import .lib when building a Windows DLL \\ --show-builtin Output the source of @import("builtin") then exit \\ --cache-dir [path] Override the local cache directory \\ --global-cache-dir [path] Override the global cache directory \\ --zig-lib-dir [path] Override path to Zig installation lib directory \\ \\Global Compile Options: \\ --name [name] Compilation unit name (not a file path) \\ --libc [file] Provide a file which specifies libc paths \\ -x language Treat subsequent input files as having type \\ --dep [[import=]name] Add an entry to the next module's import table \\ -M[name][=src] Create a module based on the current per-module settings. \\ The first module is the main module. \\ "std" can be configured by omitting src \\ After a -M argument, per-module settings are reset. \\ --error-limit [num] Set the maximum amount of distinct error values \\ -fllvm Force using LLVM as the codegen backend \\ -fno-llvm Prevent using LLVM as the codegen backend \\ -flibllvm Force using the LLVM API in the codegen backend \\ -fno-libllvm Prevent using the LLVM API in the codegen backend \\ -fclang Force using Clang as the C/C++ compilation backend \\ -fno-clang Prevent using Clang as the C/C++ compilation backend \\ -fPIE Force-enable Position Independent Executable \\ -fno-PIE Force-disable Position Independent Executable \\ -flto Force-enable Link Time Optimization (requires LLVM extensions) \\ -fno-lto Force-disable Link Time Optimization \\ -fdll-export-fns Mark exported functions as DLL exports (Windows) \\ -fno-dll-export-fns Force-disable marking exported functions as DLL exports \\ -freference-trace[=num] Show num lines of reference trace per compile error \\ -fno-reference-trace Disable reference trace \\ -fbuiltin Enable implicit builtin knowledge of functions \\ -fno-builtin Disable implicit builtin knowledge of functions \\ -ffunction-sections Places each function in a separate section \\ -fno-function-sections All functions go into same section \\ -fdata-sections Places each data in a separate section \\ -fno-data-sections All data go into same section \\ -fformatted-panics Enable formatted safety panics \\ -fno-formatted-panics Disable formatted safety panics \\ -fstructured-cfg (SPIR-V) force SPIR-V kernels to use structured control flow \\ -fno-structured-cfg (SPIR-V) force SPIR-V kernels to not use structured control flow \\ -mexec-model=[value] (WASI) Execution model \\ \\Per-Module Compile Options: \\ -target [name] -- see the targets command \\ -O [mode] Choose what to optimize for \\ Debug (default) Optimizations off, safety on \\ ReleaseFast Optimize for performance, safety off \\ ReleaseSafe Optimize for performance, safety on \\ ReleaseSmall Optimize for small binary, safety off \\ -ofmt=[fmt] Override target object format \\ elf Executable and Linking Format \\ c C source code \\ wasm WebAssembly \\ coff Common Object File Format (Windows) \\ macho macOS relocatables \\ spirv Standard, Portable Intermediate Representation V (SPIR-V) \\ plan9 Plan 9 from Bell Labs object format \\ hex (planned feature) Intel IHEX \\ raw (planned feature) Dump machine code directly \\ -mcpu [cpu] Specify target CPU and feature set \\ -mcmodel=[default|tiny| Limit range of code and data virtual addresses \\ small|kernel| \\ medium|large] \\ -mred-zone Force-enable the "red-zone" \\ -mno-red-zone Force-disable the "red-zone" \\ -fomit-frame-pointer Omit the stack frame pointer \\ -fno-omit-frame-pointer Store the stack frame pointer \\ -fPIC Force-enable Position Independent Code \\ -fno-PIC Force-disable Position Independent Code \\ -fstack-check Enable stack probing in unsafe builds \\ -fno-stack-check Disable stack probing in safe builds \\ -fstack-protector Enable stack protection in unsafe builds \\ -fno-stack-protector Disable stack protection in safe builds \\ -fsanitize-c Enable C undefined behavior detection in unsafe builds \\ -fno-sanitize-c Disable C undefined behavior detection in safe builds \\ -fvalgrind Include valgrind client requests in release builds \\ -fno-valgrind Omit valgrind client requests in debug builds \\ -fsanitize-thread Enable Thread Sanitizer \\ -fno-sanitize-thread Disable Thread Sanitizer \\ -funwind-tables Always produce unwind table entries for all functions \\ -fno-unwind-tables Never produce unwind table entries \\ -ferror-tracing Enable error tracing in ReleaseFast mode \\ -fno-error-tracing Disable error tracing in Debug and ReleaseSafe mode \\ -fsingle-threaded Code assumes there is only one thread \\ -fno-single-threaded Code may not assume there is only one thread \\ -fstrip Omit debug symbols \\ -fno-strip Keep debug symbols \\ -idirafter [dir] Add directory to AFTER include search path \\ -isystem [dir] Add directory to SYSTEM include search path \\ -I[dir] Add directory to include search path \\ -D[macro]=[value] Define C [macro] to [value] (1 if [value] omitted) \\ -cflags [flags] -- Set extra flags for the next positional C source files \\ -rcflags [flags] -- Set extra flags for the next positional .rc source files \\ -rcincludes=[type] Set the type of includes to use when compiling .rc source files \\ any (default) Use msvc if available, fall back to gnu \\ msvc Use msvc include paths (must be present on the system) \\ gnu Use mingw include paths (distributed with Zig) \\ none Do not use any autodetected include paths \\ \\Global Link Options: \\ -T[script], --script [script] Use a custom linker script \\ --version-script [path] Provide a version .map file \\ --undefined-version Allow version scripts to refer to undefined symbols \\ --no-undefined-version (default) Disallow version scripts from referring to undefined symbols \\ --dynamic-linker [path] Set the dynamic interpreter path (usually ld.so) \\ --sysroot [path] Set the system root directory (usually /) \\ --version [ver] Dynamic library semver \\ -fentry Enable entry point with default symbol name \\ -fentry=[name] Override the entry point symbol name \\ -fno-entry Do not output any entry point \\ --force_undefined [name] Specify the symbol must be defined for the link to succeed \\ -fsoname[=name] Override the default SONAME value \\ -fno-soname Disable emitting a SONAME \\ -flld Force using LLD as the linker \\ -fno-lld Prevent using LLD as the linker \\ -fcompiler-rt Always include compiler-rt symbols in output \\ -fno-compiler-rt Prevent including compiler-rt symbols in output \\ -rdynamic Add all symbols to the dynamic symbol table \\ -feach-lib-rpath Ensure adding rpath for each used dynamic library \\ -fno-each-lib-rpath Prevent adding rpath for each used dynamic library \\ -fallow-shlib-undefined Allows undefined symbols in shared libraries \\ -fno-allow-shlib-undefined Disallows undefined symbols in shared libraries \\ --build-id[=style] At a minor link-time expense, coordinates stripped binaries \\ fast, uuid, sha1, md5 with debug symbols via a '.note.gnu.build-id' section \\ 0x[hexstring] Maximum 32 bytes \\ none (default) Disable build-id \\ --eh-frame-hdr Enable C++ exception handling by passing --eh-frame-hdr to linker \\ --emit-relocs Enable output of relocation sections for post build tools \\ -z [arg] Set linker extension flags \\ nodelete Indicate that the object cannot be deleted from a process \\ notext Permit read-only relocations in read-only segments \\ defs Force a fatal error if any undefined symbols remain \\ undefs Reverse of -z defs \\ origin Indicate that the object must have its origin processed \\ nocopyreloc Disable the creation of copy relocations \\ now (default) Force all relocations to be processed on load \\ lazy Don't force all relocations to be processed on load \\ relro (default) Force all relocations to be read-only after processing \\ norelro Don't force all relocations to be read-only after processing \\ common-page-size=[bytes] Set the common page size for ELF binaries \\ max-page-size=[bytes] Set the max page size for ELF binaries \\ -dynamic Force output to be dynamically linked \\ -static Force output to be statically linked \\ -Bsymbolic Bind global references locally \\ --compress-debug-sections=[e] Debug section compression settings \\ none No compression \\ zlib Compression with deflate/inflate \\ zstd Compression with zstandard \\ --gc-sections Force removal of functions and data that are unreachable by the entry point or exported symbols \\ --no-gc-sections Don't force removal of unreachable functions and data \\ --sort-section=[value] Sort wildcard section patterns by 'name' or 'alignment' \\ --subsystem [subsystem] (Windows) /SUBSYSTEM: to the linker \\ --stack [size] Override default stack size \\ --image-base [addr] Set base address for executable image \\ -install_name=[value] (Darwin) add dylib's install name \\ --entitlements [path] (Darwin) add path to entitlements file for embedding in code signature \\ -pagezero_size [value] (Darwin) size of the __PAGEZERO segment in hexadecimal notation \\ -headerpad [value] (Darwin) set minimum space for future expansion of the load commands in hexadecimal notation \\ -headerpad_max_install_names (Darwin) set enough space as if all paths were MAXPATHLEN \\ -dead_strip (Darwin) remove functions and data that are unreachable by the entry point or exported symbols \\ -dead_strip_dylibs (Darwin) remove dylibs that are unreachable by the entry point or exported symbols \\ -ObjC (Darwin) force load all members of static archives that implement an Objective-C class or category \\ --import-memory (WebAssembly) import memory from the environment \\ --export-memory (WebAssembly) export memory to the host (Default unless --import-memory used) \\ --import-symbols (WebAssembly) import missing symbols from the host environment \\ --import-table (WebAssembly) import function table from the host environment \\ --export-table (WebAssembly) export function table to the host environment \\ --initial-memory=[bytes] (WebAssembly) initial size of the linear memory \\ --max-memory=[bytes] (WebAssembly) maximum size of the linear memory \\ --shared-memory (WebAssembly) use shared linear memory \\ --global-base=[addr] (WebAssembly) where to start to place global data \\ \\Per-Module Link Options: \\ -l[lib], --library [lib] Link against system library (only if actually used) \\ -needed-l[lib], Link against system library (even if unused) \\ --needed-library [lib] \\ -weak-l[lib] link against system library marking it and all \\ -weak_library [lib] referenced symbols as weak \\ -L[d], --library-directory [d] Add a directory to the library search path \\ -search_paths_first For each library search path, check for dynamic \\ lib then static lib before proceeding to next path. \\ -search_paths_first_static For each library search path, check for static \\ lib then dynamic lib before proceeding to next path. \\ -search_dylibs_first Search for dynamic libs in all library search \\ paths, then static libs. \\ -search_static_first Search for static libs in all library search \\ paths, then dynamic libs. \\ -search_dylibs_only Only search for dynamic libs. \\ -search_static_only Only search for static libs. \\ -rpath [path] Add directory to the runtime library search path \\ -framework [name] (Darwin) link against framework \\ -needed_framework [name] (Darwin) link against framework (even if unused) \\ -needed_library [lib] (Darwin) link against system library (even if unused) \\ -weak_framework [name] (Darwin) link against framework and mark it and all referenced symbols as weak \\ -F[dir] (Darwin) add search path for frameworks \\ --export=[value] (WebAssembly) Force a symbol to be exported \\ \\Test Options: \\ --test-filter [text] Skip tests that do not match any filter \\ --test-name-prefix [text] Add prefix to all tests \\ --test-cmd [arg] Specify test execution command one arg at a time \\ --test-cmd-bin Appends test binary path to test cmd args \\ --test-evented-io Runs the test in evented I/O mode \\ --test-no-exec Compiles test binary without running it \\ --test-runner [path] Specify a custom test runner \\ \\Debug Options (Zig Compiler Development): \\ -fopt-bisect-limit=[limit] Only run [limit] first LLVM optimization passes \\ -ftime-report Print timing diagnostics \\ -fstack-report Print stack size diagnostics \\ --verbose-link Display linker invocations \\ --verbose-cc Display C compiler invocations \\ --verbose-air Enable compiler debug output for Zig AIR \\ --verbose-intern-pool Enable compiler debug output for InternPool \\ --verbose-generic-instances Enable compiler debug output for generic instance generation \\ --verbose-llvm-ir[=path] Enable compiler debug output for unoptimized LLVM IR \\ --verbose-llvm-bc=[path] Enable compiler debug output for unoptimized LLVM BC \\ --verbose-cimport Enable compiler debug output for C imports \\ --verbose-llvm-cpu-features Enable compiler debug output for LLVM CPU features \\ --debug-log [scope] Enable printing debug/info log messages for scope \\ --debug-compile-errors Crash with helpful diagnostics at the first compile error \\ --debug-link-snapshot Enable dumping of the linker's state in JSON format \\ --debug-incremental Enable experimental feature: incremental compilation \\ ; const SOName = union(enum) { no, yes_default_value, yes: []const u8, }; const EmitBin = union(enum) { no, yes_default_path, yes: []const u8, yes_a_out, }; const Emit = union(enum) { no, yes_default_path, yes: []const u8, const Resolved = struct { data: ?Compilation.EmitLoc, dir: ?fs.Dir, fn deinit(self: *Resolved) void { if (self.dir) |*dir| { dir.close(); } } }; fn resolve(emit: Emit, default_basename: []const u8, output_to_cache: bool) !Resolved { var resolved: Resolved = .{ .data = null, .dir = null }; errdefer resolved.deinit(); switch (emit) { .no => {}, .yes_default_path => { resolved.data = Compilation.EmitLoc{ .directory = if (output_to_cache) null else .{ .path = null, .handle = fs.cwd(), }, .basename = default_basename, }; }, .yes => |full_path| { const basename = fs.path.basename(full_path); if (fs.path.dirname(full_path)) |dirname| { const handle = try fs.cwd().openDir(dirname, .{}); resolved = .{ .dir = handle, .data = Compilation.EmitLoc{ .basename = basename, .directory = .{ .path = dirname, .handle = handle, }, }, }; } else { resolved.data = Compilation.EmitLoc{ .basename = basename, .directory = .{ .path = null, .handle = fs.cwd() }, }; } }, } return resolved; } }; const ArgMode = union(enum) { build: std.builtin.OutputMode, cc, cpp, translate_c, zig_test, run, }; /// Avoid dragging networking into zig2.c because it adds dependencies on some /// linker symbols that are annoying to satisfy while bootstrapping. const Ip4Address = if (build_options.only_core_functionality) void else std.net.Ip4Address; const Listen = union(enum) { none, ip4: Ip4Address, stdio, }; const ArgsIterator = struct { resp_file: ?ArgIteratorResponseFile = null, args: []const []const u8, i: usize = 0, fn next(it: *@This()) ?[]const u8 { if (it.i >= it.args.len) { if (it.resp_file) |*resp| return resp.next(); return null; } defer it.i += 1; return it.args[it.i]; } fn nextOrFatal(it: *@This()) []const u8 { if (it.i >= it.args.len) { if (it.resp_file) |*resp| if (resp.next()) |ret| return ret; fatal("expected parameter after {s}", .{it.args[it.i - 1]}); } defer it.i += 1; return it.args[it.i]; } }; /// In contrast to `link.SystemLib`, this stores arguments that may need to be /// resolved into static libraries so that we can pass only dynamic libraries /// as system libs to `Compilation`. const SystemLib = struct { needed: bool, weak: bool, preferred_mode: std.builtin.LinkMode, search_strategy: SearchStrategy, const SearchStrategy = enum { paths_first, mode_first, no_fallback }; fn fallbackMode(this: SystemLib) std.builtin.LinkMode { assert(this.search_strategy != .no_fallback); return switch (this.preferred_mode) { .Dynamic => .Static, .Static => .Dynamic, }; } }; /// Similar to `link.Framework` except it doesn't store yet unresolved /// path to the framework. const Framework = struct { needed: bool = false, weak: bool = false, }; const CliModule = struct { paths: Package.Module.CreateOptions.Paths, cc_argv: []const []const u8, inherited: Package.Module.CreateOptions.Inherited, target_arch_os_abi: ?[]const u8, target_mcpu: ?[]const u8, deps: []const Dep, resolved: ?*Package.Module, c_source_files_start: usize, c_source_files_end: usize, rc_source_files_start: usize, rc_source_files_end: usize, const Dep = struct { key: []const u8, value: []const u8, }; }; fn buildOutputType( gpa: Allocator, arena: Allocator, all_args: []const []const u8, arg_mode: ArgMode, ) !void { var provided_name: ?[]const u8 = null; var root_src_file: ?[]const u8 = null; var version: std.SemanticVersion = .{ .major = 0, .minor = 0, .patch = 0 }; var have_version = false; var compatibility_version: ?std.SemanticVersion = null; var formatted_panics: ?bool = null; var function_sections = false; var data_sections = false; var no_builtin = false; var listen: Listen = .none; var debug_compile_errors = false; var verbose_link = (builtin.os.tag != .wasi or builtin.link_libc) and EnvVar.ZIG_VERBOSE_LINK.isSet(); var verbose_cc = (builtin.os.tag != .wasi or builtin.link_libc) and EnvVar.ZIG_VERBOSE_CC.isSet(); var verbose_air = false; var verbose_intern_pool = false; var verbose_generic_instances = false; var verbose_llvm_ir: ?[]const u8 = null; var verbose_llvm_bc: ?[]const u8 = null; var verbose_cimport = false; var verbose_llvm_cpu_features = false; var time_report = false; var stack_report = false; var show_builtin = false; var emit_bin: EmitBin = .yes_default_path; var emit_asm: Emit = .no; var emit_llvm_ir: Emit = .no; var emit_llvm_bc: Emit = .no; var emit_docs: Emit = .no; var emit_implib: Emit = .yes_default_path; var emit_implib_arg_provided = false; var target_arch_os_abi: ?[]const u8 = null; var target_mcpu: ?[]const u8 = null; var emit_h: Emit = .no; var soname: SOName = undefined; var want_compiler_rt: ?bool = null; var linker_script: ?[]const u8 = null; var version_script: ?[]const u8 = null; var linker_allow_undefined_version: bool = false; var disable_c_depfile = false; var linker_sort_section: ?link.File.Elf.SortSection = null; var linker_gc_sections: ?bool = null; var linker_compress_debug_sections: ?link.File.Elf.CompressDebugSections = null; var linker_allow_shlib_undefined: ?bool = null; var linker_bind_global_refs_locally: ?bool = null; var linker_import_symbols: bool = false; var linker_import_table: bool = false; var linker_export_table: bool = false; var linker_initial_memory: ?u64 = null; var linker_max_memory: ?u64 = null; var linker_global_base: ?u64 = null; var linker_print_gc_sections: bool = false; var linker_print_icf_sections: bool = false; var linker_print_map: bool = false; var llvm_opt_bisect_limit: c_int = -1; var linker_z_nocopyreloc = false; var linker_z_nodelete = false; var linker_z_notext = false; var linker_z_defs = false; var linker_z_origin = false; var linker_z_now = true; var linker_z_relro = true; var linker_z_common_page_size: ?u64 = null; var linker_z_max_page_size: ?u64 = null; var linker_tsaware = false; var linker_nxcompat = false; var linker_dynamicbase = true; var linker_optimization: ?[]const u8 = null; var linker_module_definition_file: ?[]const u8 = null; var test_no_exec = false; var entry: Compilation.CreateOptions.Entry = .default; var force_undefined_symbols: std.StringArrayHashMapUnmanaged(void) = .{}; var stack_size: ?u64 = null; var image_base: ?u64 = null; var link_eh_frame_hdr = false; var link_emit_relocs = false; var build_id: ?std.zig.BuildId = null; var runtime_args_start: ?usize = null; var test_filters: std.ArrayListUnmanaged([]const u8) = .{}; var test_name_prefix: ?[]const u8 = null; var test_runner_path: ?[]const u8 = null; var override_local_cache_dir: ?[]const u8 = try EnvVar.ZIG_LOCAL_CACHE_DIR.get(arena); var override_global_cache_dir: ?[]const u8 = try EnvVar.ZIG_GLOBAL_CACHE_DIR.get(arena); var override_lib_dir: ?[]const u8 = try EnvVar.ZIG_LIB_DIR.get(arena); var clang_preprocessor_mode: Compilation.ClangPreprocessorMode = .no; var subsystem: ?std.Target.SubSystem = null; var major_subsystem_version: ?u16 = null; var minor_subsystem_version: ?u16 = null; var enable_link_snapshots: bool = false; var debug_incremental: bool = false; var install_name: ?[]const u8 = null; var hash_style: link.File.Elf.HashStyle = .both; var entitlements: ?[]const u8 = null; var pagezero_size: ?u64 = null; var lib_search_strategy: SystemLib.SearchStrategy = .paths_first; var lib_preferred_mode: std.builtin.LinkMode = .Dynamic; var headerpad_size: ?u32 = null; var headerpad_max_install_names: bool = false; var dead_strip_dylibs: bool = false; var force_load_objc: bool = false; var contains_res_file: bool = false; var reference_trace: ?u32 = null; var pdb_out_path: ?[]const u8 = null; var error_limit: ?Module.ErrorInt = null; // These are before resolving sysroot. var extra_cflags: std.ArrayListUnmanaged([]const u8) = .{}; var extra_rcflags: std.ArrayListUnmanaged([]const u8) = .{}; var symbol_wrap_set: std.StringArrayHashMapUnmanaged(void) = .{}; var rc_includes: Compilation.RcIncludes = .any; var manifest_file: ?[]const u8 = null; var linker_export_symbol_names: std.ArrayListUnmanaged([]const u8) = .{}; // Tracks the position in c_source_files which have already their owner populated. var c_source_files_owner_index: usize = 0; // Tracks the position in rc_source_files which have already their owner populated. var rc_source_files_owner_index: usize = 0; // null means replace with the test executable binary var test_exec_args: std.ArrayListUnmanaged(?[]const u8) = .{}; // These get set by CLI flags and then snapshotted when a `--mod` flag is // encountered. var mod_opts: Package.Module.CreateOptions.Inherited = .{}; // These get appended to by CLI flags and then slurped when a `--mod` flag // is encountered. var cssan: ClangSearchSanitizer = .{}; var cc_argv: std.ArrayListUnmanaged([]const u8) = .{}; var deps: std.ArrayListUnmanaged(CliModule.Dep) = .{}; // Contains every module specified via --mod. The dependencies are added // after argument parsing is completed. We use a StringArrayHashMap to make // error output consistent. "root" is special. var create_module: CreateModule = .{ // Populated just before the call to `createModule`. .global_cache_directory = undefined, .object_format = null, .dynamic_linker = null, .modules = .{}, .opts = .{ .is_test = arg_mode == .zig_test, // Populated while parsing CLI args. .output_mode = undefined, // Populated in the call to `createModule` for the root module. .resolved_target = undefined, .have_zcu = false, // Populated just before the call to `createModule`. .emit_llvm_ir = undefined, // Populated just before the call to `createModule`. .emit_llvm_bc = undefined, // Populated just before the call to `createModule`. .emit_bin = undefined, // Populated just before the call to `createModule`. .any_c_source_files = undefined, }, // Populated in the call to `createModule` for the root module. .resolved_options = undefined, .system_libs = .{}, .resolved_system_libs = .{}, .wasi_emulated_libs = .{}, .c_source_files = .{}, .rc_source_files = .{}, .llvm_m_args = .{}, .sysroot = null, .lib_dirs = .{}, // populated by createModule() .lib_dir_args = .{}, // populated from CLI arg parsing .libc_installation = null, .want_native_include_dirs = false, .frameworks = .{}, .framework_dirs = .{}, .rpath_list = .{}, .each_lib_rpath = null, .libc_paths_file = try EnvVar.ZIG_LIBC.get(arena), .link_objects = .{}, .native_system_include_paths = &.{}, .host_triple = null, .host_cpu = null, .host_dynamic_linker = null, }; // before arg parsing, check for the NO_COLOR environment variable // if it exists, default the color setting to .off // explicit --color arguments will still override this setting. // Disable color on WASI per https://github.com/WebAssembly/WASI/issues/162 var color: Color = if (builtin.os.tag == .wasi or EnvVar.NO_COLOR.isSet()) .off else .auto; switch (arg_mode) { .build, .translate_c, .zig_test, .run => { switch (arg_mode) { .build => |m| { create_module.opts.output_mode = m; }, .translate_c => { emit_bin = .no; create_module.opts.output_mode = .Obj; }, .zig_test, .run => { create_module.opts.output_mode = .Exe; }, else => unreachable, } soname = .yes_default_value; var args_iter = ArgsIterator{ .args = all_args[2..], }; var file_ext: ?Compilation.FileExt = null; args_loop: while (args_iter.next()) |arg| { if (mem.startsWith(u8, arg, "@")) { // This is a "compiler response file". We must parse the file and treat its // contents as command line parameters. const resp_file_path = arg[1..]; args_iter.resp_file = initArgIteratorResponseFile(arena, resp_file_path) catch |err| { fatal("unable to read response file '{s}': {s}", .{ resp_file_path, @errorName(err) }); }; } else if (mem.startsWith(u8, arg, "-")) { if (mem.eql(u8, arg, "-h") or mem.eql(u8, arg, "--help")) { try io.getStdOut().writeAll(usage_build_generic); return cleanExit(); } else if (mem.eql(u8, arg, "--")) { if (arg_mode == .run) { // args_iter.i is 1, referring the next arg after "--" in ["--", ...] // Add +2 to the index so it is relative to all_args runtime_args_start = args_iter.i + 2; break :args_loop; } else { fatal("unexpected end-of-parameter mark: --", .{}); } } else if (mem.eql(u8, arg, "--dep")) { var it = mem.splitScalar(u8, args_iter.nextOrFatal(), '='); const key = it.next().?; const value = it.next() orelse key; if (mem.eql(u8, key, "std") and !mem.eql(u8, value, "std")) { fatal("unable to import as '{s}': conflicts with builtin module", .{ key, }); } for ([_][]const u8{ "root", "builtin" }) |name| { if (mem.eql(u8, key, name)) { fatal("unable to import as '{s}': conflicts with builtin module", .{ key, }); } } try deps.append(arena, .{ .key = key, .value = value, }); } else if (mem.eql(u8, arg, "--mod")) { // deprecated, kept around until the next zig1.wasm update try handleModArg( arena, args_iter.nextOrFatal(), args_iter.nextOrFatal(), &create_module, &mod_opts, &cc_argv, &target_arch_os_abi, &target_mcpu, &deps, &c_source_files_owner_index, &rc_source_files_owner_index, &cssan, ); } else if (mem.startsWith(u8, arg, "-M")) { var it = mem.splitScalar(u8, arg["-M".len..], '='); const mod_name = it.next().?; const root_src_orig = it.next(); try handleModArg( arena, mod_name, root_src_orig, &create_module, &mod_opts, &cc_argv, &target_arch_os_abi, &target_mcpu, &deps, &c_source_files_owner_index, &rc_source_files_owner_index, &cssan, ); } else if (mem.eql(u8, arg, "--error-limit")) { const next_arg = args_iter.nextOrFatal(); error_limit = std.fmt.parseUnsigned(Module.ErrorInt, next_arg, 0) catch |err| { fatal("unable to parse error limit '{s}': {s}", .{ next_arg, @errorName(err) }); }; } else if (mem.eql(u8, arg, "-cflags")) { extra_cflags.shrinkRetainingCapacity(0); while (true) { const next_arg = args_iter.next() orelse { fatal("expected -- after -cflags", .{}); }; if (mem.eql(u8, next_arg, "--")) break; try extra_cflags.append(arena, next_arg); } } else if (mem.eql(u8, arg, "-rcincludes")) { rc_includes = parseRcIncludes(args_iter.nextOrFatal()); } else if (mem.startsWith(u8, arg, "-rcincludes=")) { rc_includes = parseRcIncludes(arg["-rcincludes=".len..]); } else if (mem.eql(u8, arg, "-rcflags")) { extra_rcflags.shrinkRetainingCapacity(0); while (true) { const next_arg = args_iter.next() orelse { fatal("expected -- after -rcflags", .{}); }; if (mem.eql(u8, next_arg, "--")) break; try extra_rcflags.append(arena, next_arg); } } else if (mem.startsWith(u8, arg, "-fstructured-cfg")) { mod_opts.structured_cfg = true; } else if (mem.startsWith(u8, arg, "-fno-structured-cfg")) { mod_opts.structured_cfg = false; } else if (mem.eql(u8, arg, "--color")) { const next_arg = args_iter.next() orelse { fatal("expected [auto|on|off] after --color", .{}); }; color = std.meta.stringToEnum(Color, next_arg) orelse { fatal("expected [auto|on|off] after --color, found '{s}'", .{next_arg}); }; } else if (mem.eql(u8, arg, "--subsystem")) { subsystem = try parseSubSystem(args_iter.nextOrFatal()); } else if (mem.eql(u8, arg, "-O")) { mod_opts.optimize_mode = parseOptimizeMode(args_iter.nextOrFatal()); } else if (mem.startsWith(u8, arg, "-fentry=")) { entry = .{ .named = arg["-fentry=".len..] }; } else if (mem.eql(u8, arg, "--force_undefined")) { try force_undefined_symbols.put(arena, args_iter.nextOrFatal(), {}); } else if (mem.eql(u8, arg, "--stack")) { stack_size = parseStackSize(args_iter.nextOrFatal()); } else if (mem.eql(u8, arg, "--image-base")) { image_base = parseImageBase(args_iter.nextOrFatal()); } else if (mem.eql(u8, arg, "--name")) { provided_name = args_iter.nextOrFatal(); if (!mem.eql(u8, provided_name.?, fs.path.basename(provided_name.?))) fatal("invalid package name '{s}': cannot contain folder separators", .{provided_name.?}); } else if (mem.eql(u8, arg, "-rpath")) { try create_module.rpath_list.append(arena, args_iter.nextOrFatal()); } else if (mem.eql(u8, arg, "--library-directory") or mem.eql(u8, arg, "-L")) { try create_module.lib_dir_args.append(arena, args_iter.nextOrFatal()); } else if (mem.eql(u8, arg, "-F")) { try create_module.framework_dirs.append(arena, args_iter.nextOrFatal()); } else if (mem.eql(u8, arg, "-framework")) { try create_module.frameworks.put(arena, args_iter.nextOrFatal(), .{}); } else if (mem.eql(u8, arg, "-weak_framework")) { try create_module.frameworks.put(arena, args_iter.nextOrFatal(), .{ .weak = true }); } else if (mem.eql(u8, arg, "-needed_framework")) { try create_module.frameworks.put(arena, args_iter.nextOrFatal(), .{ .needed = true }); } else if (mem.eql(u8, arg, "-install_name")) { install_name = args_iter.nextOrFatal(); } else if (mem.startsWith(u8, arg, "--compress-debug-sections=")) { const param = arg["--compress-debug-sections=".len..]; linker_compress_debug_sections = std.meta.stringToEnum(link.File.Elf.CompressDebugSections, param) orelse { fatal("expected --compress-debug-sections=[none|zlib|zstd], found '{s}'", .{param}); }; } else if (mem.eql(u8, arg, "--compress-debug-sections")) { linker_compress_debug_sections = link.File.Elf.CompressDebugSections.zlib; } else if (mem.eql(u8, arg, "-pagezero_size")) { const next_arg = args_iter.nextOrFatal(); pagezero_size = std.fmt.parseUnsigned(u64, eatIntPrefix(next_arg, 16), 16) catch |err| { fatal("unable to parse pagezero size'{s}': {s}", .{ next_arg, @errorName(err) }); }; } else if (mem.eql(u8, arg, "-search_paths_first")) { lib_search_strategy = .paths_first; lib_preferred_mode = .Dynamic; } else if (mem.eql(u8, arg, "-search_paths_first_static")) { lib_search_strategy = .paths_first; lib_preferred_mode = .Static; } else if (mem.eql(u8, arg, "-search_dylibs_first")) { lib_search_strategy = .mode_first; lib_preferred_mode = .Dynamic; } else if (mem.eql(u8, arg, "-search_static_first")) { lib_search_strategy = .mode_first; lib_preferred_mode = .Static; } else if (mem.eql(u8, arg, "-search_dylibs_only")) { lib_search_strategy = .no_fallback; lib_preferred_mode = .Dynamic; } else if (mem.eql(u8, arg, "-search_static_only")) { lib_search_strategy = .no_fallback; lib_preferred_mode = .Static; } else if (mem.eql(u8, arg, "-headerpad")) { const next_arg = args_iter.nextOrFatal(); headerpad_size = std.fmt.parseUnsigned(u32, eatIntPrefix(next_arg, 16), 16) catch |err| { fatal("unable to parse headerpad size '{s}': {s}", .{ next_arg, @errorName(err) }); }; } else if (mem.eql(u8, arg, "-headerpad_max_install_names")) { headerpad_max_install_names = true; } else if (mem.eql(u8, arg, "-dead_strip")) { linker_gc_sections = true; } else if (mem.eql(u8, arg, "-dead_strip_dylibs")) { dead_strip_dylibs = true; } else if (mem.eql(u8, arg, "-ObjC")) { force_load_objc = true; } else if (mem.eql(u8, arg, "-T") or mem.eql(u8, arg, "--script")) { linker_script = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "-version-script") or mem.eql(u8, arg, "--version-script")) { version_script = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "--undefined-version")) { linker_allow_undefined_version = true; } else if (mem.eql(u8, arg, "--no-undefined-version")) { linker_allow_undefined_version = false; } else if (mem.eql(u8, arg, "--library") or mem.eql(u8, arg, "-l")) { // We don't know whether this library is part of libc // or libc++ until we resolve the target, so we append // to the list for now. try create_module.system_libs.put(arena, args_iter.nextOrFatal(), .{ .needed = false, .weak = false, .preferred_mode = lib_preferred_mode, .search_strategy = lib_search_strategy, }); } else if (mem.eql(u8, arg, "--needed-library") or mem.eql(u8, arg, "-needed-l") or mem.eql(u8, arg, "-needed_library")) { const next_arg = args_iter.nextOrFatal(); try create_module.system_libs.put(arena, next_arg, .{ .needed = true, .weak = false, .preferred_mode = lib_preferred_mode, .search_strategy = lib_search_strategy, }); } else if (mem.eql(u8, arg, "-weak_library") or mem.eql(u8, arg, "-weak-l")) { try create_module.system_libs.put(arena, args_iter.nextOrFatal(), .{ .needed = false, .weak = true, .preferred_mode = lib_preferred_mode, .search_strategy = lib_search_strategy, }); } else if (mem.eql(u8, arg, "-D")) { try cc_argv.appendSlice(arena, &.{ arg, args_iter.nextOrFatal() }); } else if (mem.eql(u8, arg, "-I")) { try cssan.addIncludePath(arena, &cc_argv, .I, arg, args_iter.nextOrFatal(), false); } else if (mem.eql(u8, arg, "-isystem")) { try cssan.addIncludePath(arena, &cc_argv, .isystem, arg, args_iter.nextOrFatal(), false); } else if (mem.eql(u8, arg, "-iwithsysroot")) { try cssan.addIncludePath(arena, &cc_argv, .iwithsysroot, arg, args_iter.nextOrFatal(), false); } else if (mem.eql(u8, arg, "-idirafter")) { try cssan.addIncludePath(arena, &cc_argv, .idirafter, arg, args_iter.nextOrFatal(), false); } else if (mem.eql(u8, arg, "-iframework")) { const path = args_iter.nextOrFatal(); try cssan.addIncludePath(arena, &cc_argv, .iframework, arg, path, false); try create_module.framework_dirs.append(arena, path); // Forward to the backend as -F } else if (mem.eql(u8, arg, "-iframeworkwithsysroot")) { const path = args_iter.nextOrFatal(); try cssan.addIncludePath(arena, &cc_argv, .iframeworkwithsysroot, arg, path, false); try create_module.framework_dirs.append(arena, path); // Forward to the backend as -F } else if (mem.eql(u8, arg, "--version")) { const next_arg = args_iter.nextOrFatal(); version = std.SemanticVersion.parse(next_arg) catch |err| { fatal("unable to parse --version '{s}': {s}", .{ next_arg, @errorName(err) }); }; have_version = true; } else if (mem.eql(u8, arg, "-target")) { target_arch_os_abi = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "-mcpu")) { target_mcpu = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "-mcmodel")) { mod_opts.code_model = parseCodeModel(args_iter.nextOrFatal()); } else if (mem.startsWith(u8, arg, "-mcmodel=")) { mod_opts.code_model = parseCodeModel(arg["-mcmodel=".len..]); } else if (mem.startsWith(u8, arg, "-ofmt=")) { create_module.object_format = arg["-ofmt=".len..]; } else if (mem.startsWith(u8, arg, "-mcpu=")) { target_mcpu = arg["-mcpu=".len..]; } else if (mem.startsWith(u8, arg, "-O")) { mod_opts.optimize_mode = parseOptimizeMode(arg["-O".len..]); } else if (mem.eql(u8, arg, "--dynamic-linker")) { create_module.dynamic_linker = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "--host-target")) { create_module.host_triple = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "--host-cpu")) { create_module.host_cpu = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "--host-dynamic-linker")) { create_module.host_dynamic_linker = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "--sysroot")) { const next_arg = args_iter.nextOrFatal(); create_module.sysroot = next_arg; try cc_argv.appendSlice(arena, &.{ "-isysroot", next_arg }); } else if (mem.eql(u8, arg, "--libc")) { create_module.libc_paths_file = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "--test-filter")) { try test_filters.append(arena, args_iter.nextOrFatal()); } else if (mem.eql(u8, arg, "--test-name-prefix")) { test_name_prefix = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "--test-runner")) { test_runner_path = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "--test-cmd")) { try test_exec_args.append(arena, args_iter.nextOrFatal()); } else if (mem.eql(u8, arg, "--cache-dir")) { override_local_cache_dir = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "--global-cache-dir")) { override_global_cache_dir = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "--zig-lib-dir")) { override_lib_dir = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "--debug-log")) { if (!build_options.enable_logging) { warn("Zig was compiled without logging enabled (-Dlog). --debug-log has no effect.", .{}); _ = args_iter.nextOrFatal(); } else { try log_scopes.append(arena, args_iter.nextOrFatal()); } } else if (mem.eql(u8, arg, "--listen")) { const next_arg = args_iter.nextOrFatal(); if (mem.eql(u8, next_arg, "-")) { listen = .stdio; } else { if (build_options.only_core_functionality) unreachable; // example: --listen 127.0.0.1:9000 var it = std.mem.splitScalar(u8, next_arg, ':'); const host = it.next().?; const port_text = it.next() orelse "14735"; const port = std.fmt.parseInt(u16, port_text, 10) catch |err| fatal("invalid port number: '{s}': {s}", .{ port_text, @errorName(err) }); listen = .{ .ip4 = std.net.Ip4Address.parse(host, port) catch |err| fatal("invalid host: '{s}': {s}", .{ host, @errorName(err) }) }; } } else if (mem.eql(u8, arg, "--listen=-")) { listen = .stdio; } else if (mem.eql(u8, arg, "--debug-link-snapshot")) { if (!build_options.enable_link_snapshots) { warn("Zig was compiled without linker snapshots enabled (-Dlink-snapshot). --debug-link-snapshot has no effect.", .{}); } else { enable_link_snapshots = true; } } else if (mem.eql(u8, arg, "--debug-incremental")) { debug_incremental = true; } else if (mem.eql(u8, arg, "--entitlements")) { entitlements = args_iter.nextOrFatal(); } else if (mem.eql(u8, arg, "-fcompiler-rt")) { want_compiler_rt = true; } else if (mem.eql(u8, arg, "-fno-compiler-rt")) { want_compiler_rt = false; } else if (mem.eql(u8, arg, "-feach-lib-rpath")) { create_module.each_lib_rpath = true; } else if (mem.eql(u8, arg, "-fno-each-lib-rpath")) { create_module.each_lib_rpath = false; } else if (mem.eql(u8, arg, "--test-cmd-bin")) { try test_exec_args.append(arena, null); } else if (mem.eql(u8, arg, "--test-no-exec")) { test_no_exec = true; } else if (mem.eql(u8, arg, "-ftime-report")) { time_report = true; } else if (mem.eql(u8, arg, "-fstack-report")) { stack_report = true; } else if (mem.eql(u8, arg, "-fPIC")) { mod_opts.pic = true; } else if (mem.eql(u8, arg, "-fno-PIC")) { mod_opts.pic = false; } else if (mem.eql(u8, arg, "-fPIE")) { create_module.opts.pie = true; } else if (mem.eql(u8, arg, "-fno-PIE")) { create_module.opts.pie = false; } else if (mem.eql(u8, arg, "-flto")) { create_module.opts.lto = true; } else if (mem.eql(u8, arg, "-fno-lto")) { create_module.opts.lto = false; } else if (mem.eql(u8, arg, "-funwind-tables")) { mod_opts.unwind_tables = true; } else if (mem.eql(u8, arg, "-fno-unwind-tables")) { mod_opts.unwind_tables = false; } else if (mem.eql(u8, arg, "-fstack-check")) { mod_opts.stack_check = true; } else if (mem.eql(u8, arg, "-fno-stack-check")) { mod_opts.stack_check = false; } else if (mem.eql(u8, arg, "-fstack-protector")) { mod_opts.stack_protector = Compilation.default_stack_protector_buffer_size; } else if (mem.eql(u8, arg, "-fno-stack-protector")) { mod_opts.stack_protector = 0; } else if (mem.eql(u8, arg, "-mred-zone")) { mod_opts.red_zone = true; } else if (mem.eql(u8, arg, "-mno-red-zone")) { mod_opts.red_zone = false; } else if (mem.eql(u8, arg, "-fomit-frame-pointer")) { mod_opts.omit_frame_pointer = true; } else if (mem.eql(u8, arg, "-fno-omit-frame-pointer")) { mod_opts.omit_frame_pointer = false; } else if (mem.eql(u8, arg, "-fsanitize-c")) { mod_opts.sanitize_c = true; } else if (mem.eql(u8, arg, "-fno-sanitize-c")) { mod_opts.sanitize_c = false; } else if (mem.eql(u8, arg, "-fvalgrind")) { mod_opts.valgrind = true; } else if (mem.eql(u8, arg, "-fno-valgrind")) { mod_opts.valgrind = false; } else if (mem.eql(u8, arg, "-fsanitize-thread")) { mod_opts.sanitize_thread = true; } else if (mem.eql(u8, arg, "-fno-sanitize-thread")) { mod_opts.sanitize_thread = false; } else if (mem.eql(u8, arg, "-fllvm")) { create_module.opts.use_llvm = true; } else if (mem.eql(u8, arg, "-fno-llvm")) { create_module.opts.use_llvm = false; } else if (mem.eql(u8, arg, "-flibllvm")) { create_module.opts.use_lib_llvm = true; } else if (mem.eql(u8, arg, "-fno-libllvm")) { create_module.opts.use_lib_llvm = false; } else if (mem.eql(u8, arg, "-flld")) { create_module.opts.use_lld = true; } else if (mem.eql(u8, arg, "-fno-lld")) { create_module.opts.use_lld = false; } else if (mem.eql(u8, arg, "-fclang")) { create_module.opts.use_clang = true; } else if (mem.eql(u8, arg, "-fno-clang")) { create_module.opts.use_clang = false; } else if (mem.eql(u8, arg, "-freference-trace")) { reference_trace = 256; } else if (mem.startsWith(u8, arg, "-freference-trace=")) { const num = arg["-freference-trace=".len..]; reference_trace = std.fmt.parseUnsigned(u32, num, 10) catch |err| { fatal("unable to parse reference_trace count '{s}': {s}", .{ num, @errorName(err) }); }; } else if (mem.eql(u8, arg, "-fno-reference-trace")) { reference_trace = null; } else if (mem.eql(u8, arg, "-ferror-tracing")) { mod_opts.error_tracing = true; } else if (mem.eql(u8, arg, "-fno-error-tracing")) { mod_opts.error_tracing = false; } else if (mem.eql(u8, arg, "-rdynamic")) { create_module.opts.rdynamic = true; } else if (mem.eql(u8, arg, "-fsoname")) { soname = .yes_default_value; } else if (mem.startsWith(u8, arg, "-fsoname=")) { soname = .{ .yes = arg["-fsoname=".len..] }; } else if (mem.eql(u8, arg, "-fno-soname")) { soname = .no; } else if (mem.eql(u8, arg, "-femit-bin")) { emit_bin = .yes_default_path; } else if (mem.startsWith(u8, arg, "-femit-bin=")) { emit_bin = .{ .yes = arg["-femit-bin=".len..] }; } else if (mem.eql(u8, arg, "-fno-emit-bin")) { emit_bin = .no; } else if (mem.eql(u8, arg, "-femit-h")) { emit_h = .yes_default_path; } else if (mem.startsWith(u8, arg, "-femit-h=")) { emit_h = .{ .yes = arg["-femit-h=".len..] }; } else if (mem.eql(u8, arg, "-fno-emit-h")) { emit_h = .no; } else if (mem.eql(u8, arg, "-femit-asm")) { emit_asm = .yes_default_path; } else if (mem.startsWith(u8, arg, "-femit-asm=")) { emit_asm = .{ .yes = arg["-femit-asm=".len..] }; } else if (mem.eql(u8, arg, "-fno-emit-asm")) { emit_asm = .no; } else if (mem.eql(u8, arg, "-femit-llvm-ir")) { emit_llvm_ir = .yes_default_path; } else if (mem.startsWith(u8, arg, "-femit-llvm-ir=")) { emit_llvm_ir = .{ .yes = arg["-femit-llvm-ir=".len..] }; } else if (mem.eql(u8, arg, "-fno-emit-llvm-ir")) { emit_llvm_ir = .no; } else if (mem.eql(u8, arg, "-femit-llvm-bc")) { emit_llvm_bc = .yes_default_path; } else if (mem.startsWith(u8, arg, "-femit-llvm-bc=")) { emit_llvm_bc = .{ .yes = arg["-femit-llvm-bc=".len..] }; } else if (mem.eql(u8, arg, "-fno-emit-llvm-bc")) { emit_llvm_bc = .no; } else if (mem.eql(u8, arg, "-femit-docs")) { emit_docs = .yes_default_path; } else if (mem.startsWith(u8, arg, "-femit-docs=")) { emit_docs = .{ .yes = arg["-femit-docs=".len..] }; } else if (mem.eql(u8, arg, "-fno-emit-docs")) { emit_docs = .no; } else if (mem.eql(u8, arg, "-femit-implib")) { emit_implib = .yes_default_path; emit_implib_arg_provided = true; } else if (mem.startsWith(u8, arg, "-femit-implib=")) { emit_implib = .{ .yes = arg["-femit-implib=".len..] }; emit_implib_arg_provided = true; } else if (mem.eql(u8, arg, "-fno-emit-implib")) { emit_implib = .no; emit_implib_arg_provided = true; } else if (mem.eql(u8, arg, "-dynamic")) { create_module.opts.link_mode = .Dynamic; lib_preferred_mode = .Dynamic; lib_search_strategy = .mode_first; } else if (mem.eql(u8, arg, "-static")) { create_module.opts.link_mode = .Static; lib_preferred_mode = .Static; lib_search_strategy = .no_fallback; } else if (mem.eql(u8, arg, "-fdll-export-fns")) { create_module.opts.dll_export_fns = true; } else if (mem.eql(u8, arg, "-fno-dll-export-fns")) { create_module.opts.dll_export_fns = false; } else if (mem.eql(u8, arg, "--show-builtin")) { show_builtin = true; emit_bin = .no; } else if (mem.eql(u8, arg, "-fstrip")) { mod_opts.strip = true; } else if (mem.eql(u8, arg, "-fno-strip")) { mod_opts.strip = false; } else if (mem.eql(u8, arg, "-gdwarf32")) { create_module.opts.debug_format = .{ .dwarf = .@"32" }; } else if (mem.eql(u8, arg, "-gdwarf64")) { create_module.opts.debug_format = .{ .dwarf = .@"64" }; } else if (mem.eql(u8, arg, "-fformatted-panics")) { formatted_panics = true; } else if (mem.eql(u8, arg, "-fno-formatted-panics")) { formatted_panics = false; } else if (mem.eql(u8, arg, "-fsingle-threaded")) { mod_opts.single_threaded = true; } else if (mem.eql(u8, arg, "-fno-single-threaded")) { mod_opts.single_threaded = false; } else if (mem.eql(u8, arg, "-ffunction-sections")) { function_sections = true; } else if (mem.eql(u8, arg, "-fno-function-sections")) { function_sections = false; } else if (mem.eql(u8, arg, "-fdata-sections")) { data_sections = true; } else if (mem.eql(u8, arg, "-fno-data-sections")) { data_sections = false; } else if (mem.eql(u8, arg, "-fbuiltin")) { no_builtin = false; } else if (mem.eql(u8, arg, "-fno-builtin")) { no_builtin = true; } else if (mem.startsWith(u8, arg, "-fopt-bisect-limit=")) { const next_arg = arg["-fopt-bisect-limit=".len..]; llvm_opt_bisect_limit = std.fmt.parseInt(c_int, next_arg, 0) catch |err| fatal("unable to parse '{s}': {s}", .{ arg, @errorName(err) }); } else if (mem.eql(u8, arg, "--eh-frame-hdr")) { link_eh_frame_hdr = true; } else if (mem.eql(u8, arg, "--dynamicbase")) { linker_dynamicbase = true; } else if (mem.eql(u8, arg, "--no-dynamicbase")) { linker_dynamicbase = false; } else if (mem.eql(u8, arg, "--emit-relocs")) { link_emit_relocs = true; } else if (mem.eql(u8, arg, "-fallow-shlib-undefined")) { linker_allow_shlib_undefined = true; } else if (mem.eql(u8, arg, "-fno-allow-shlib-undefined")) { linker_allow_shlib_undefined = false; } else if (mem.eql(u8, arg, "-z")) { const z_arg = args_iter.nextOrFatal(); if (mem.eql(u8, z_arg, "nodelete")) { linker_z_nodelete = true; } else if (mem.eql(u8, z_arg, "notext")) { linker_z_notext = true; } else if (mem.eql(u8, z_arg, "defs")) { linker_z_defs = true; } else if (mem.eql(u8, z_arg, "undefs")) { linker_z_defs = false; } else if (mem.eql(u8, z_arg, "origin")) { linker_z_origin = true; } else if (mem.eql(u8, z_arg, "nocopyreloc")) { linker_z_nocopyreloc = true; } else if (mem.eql(u8, z_arg, "now")) { linker_z_now = true; } else if (mem.eql(u8, z_arg, "lazy")) { linker_z_now = false; } else if (mem.eql(u8, z_arg, "relro")) { linker_z_relro = true; } else if (mem.eql(u8, z_arg, "norelro")) { linker_z_relro = false; } else if (mem.startsWith(u8, z_arg, "common-page-size=")) { linker_z_common_page_size = parseIntSuffix(z_arg, "common-page-size=".len); } else if (mem.startsWith(u8, z_arg, "max-page-size=")) { linker_z_max_page_size = parseIntSuffix(z_arg, "max-page-size=".len); } else { fatal("unsupported linker extension flag: -z {s}", .{z_arg}); } } else if (mem.eql(u8, arg, "--import-memory")) { create_module.opts.import_memory = true; } else if (mem.eql(u8, arg, "-fentry")) { switch (entry) { .default, .disabled => entry = .enabled, .enabled, .named => {}, } } else if (mem.eql(u8, arg, "-fno-entry")) { entry = .disabled; } else if (mem.eql(u8, arg, "--export-memory")) { create_module.opts.export_memory = true; } else if (mem.eql(u8, arg, "--import-symbols")) { linker_import_symbols = true; } else if (mem.eql(u8, arg, "--import-table")) { linker_import_table = true; } else if (mem.eql(u8, arg, "--export-table")) { linker_export_table = true; } else if (mem.startsWith(u8, arg, "--initial-memory=")) { linker_initial_memory = parseIntSuffix(arg, "--initial-memory=".len); } else if (mem.startsWith(u8, arg, "--max-memory=")) { linker_max_memory = parseIntSuffix(arg, "--max-memory=".len); } else if (mem.eql(u8, arg, "--shared-memory")) { create_module.opts.shared_memory = true; } else if (mem.startsWith(u8, arg, "--global-base=")) { linker_global_base = parseIntSuffix(arg, "--global-base=".len); } else if (mem.startsWith(u8, arg, "--export=")) { try linker_export_symbol_names.append(arena, arg["--export=".len..]); } else if (mem.eql(u8, arg, "-Bsymbolic")) { linker_bind_global_refs_locally = true; } else if (mem.eql(u8, arg, "--gc-sections")) { linker_gc_sections = true; } else if (mem.eql(u8, arg, "--no-gc-sections")) { linker_gc_sections = false; } else if (mem.eql(u8, arg, "--build-id")) { build_id = .fast; } else if (mem.startsWith(u8, arg, "--build-id=")) { const style = arg["--build-id=".len..]; build_id = std.zig.BuildId.parse(style) catch |err| { fatal("unable to parse --build-id style '{s}': {s}", .{ style, @errorName(err), }); }; } else if (mem.eql(u8, arg, "--debug-compile-errors")) { if (!crash_report.is_enabled) { warn("Zig was compiled in a release mode. --debug-compile-errors has no effect.", .{}); } else { debug_compile_errors = true; } } else if (mem.eql(u8, arg, "--verbose-link")) { verbose_link = true; } else if (mem.eql(u8, arg, "--verbose-cc")) { verbose_cc = true; } else if (mem.eql(u8, arg, "--verbose-air")) { verbose_air = true; } else if (mem.eql(u8, arg, "--verbose-intern-pool")) { verbose_intern_pool = true; } else if (mem.eql(u8, arg, "--verbose-generic-instances")) { verbose_generic_instances = true; } else if (mem.eql(u8, arg, "--verbose-llvm-ir")) { verbose_llvm_ir = "-"; } else if (mem.startsWith(u8, arg, "--verbose-llvm-ir=")) { verbose_llvm_ir = arg["--verbose-llvm-ir=".len..]; } else if (mem.startsWith(u8, arg, "--verbose-llvm-bc=")) { verbose_llvm_bc = arg["--verbose-llvm-bc=".len..]; } else if (mem.eql(u8, arg, "--verbose-cimport")) { verbose_cimport = true; } else if (mem.eql(u8, arg, "--verbose-llvm-cpu-features")) { verbose_llvm_cpu_features = true; } else if (mem.startsWith(u8, arg, "-T")) { linker_script = arg[2..]; } else if (mem.startsWith(u8, arg, "-L")) { try create_module.lib_dir_args.append(arena, arg[2..]); } else if (mem.startsWith(u8, arg, "-F")) { try create_module.framework_dirs.append(arena, arg[2..]); } else if (mem.startsWith(u8, arg, "-l")) { // We don't know whether this library is part of libc // or libc++ until we resolve the target, so we append // to the list for now. try create_module.system_libs.put(arena, arg["-l".len..], .{ .needed = false, .weak = false, .preferred_mode = lib_preferred_mode, .search_strategy = lib_search_strategy, }); } else if (mem.startsWith(u8, arg, "-needed-l")) { try create_module.system_libs.put(arena, arg["-needed-l".len..], .{ .needed = true, .weak = false, .preferred_mode = lib_preferred_mode, .search_strategy = lib_search_strategy, }); } else if (mem.startsWith(u8, arg, "-weak-l")) { try create_module.system_libs.put(arena, arg["-weak-l".len..], .{ .needed = false, .weak = true, .preferred_mode = lib_preferred_mode, .search_strategy = lib_search_strategy, }); } else if (mem.startsWith(u8, arg, "-D")) { try cc_argv.append(arena, arg); } else if (mem.startsWith(u8, arg, "-I")) { try cssan.addIncludePath(arena, &cc_argv, .I, arg, arg[2..], true); } else if (mem.eql(u8, arg, "-x")) { const lang = args_iter.nextOrFatal(); if (mem.eql(u8, lang, "none")) { file_ext = null; } else if (Compilation.LangToExt.get(lang)) |got_ext| { file_ext = got_ext; } else { fatal("language not recognized: '{s}'", .{lang}); } } else if (mem.startsWith(u8, arg, "-mexec-model=")) { create_module.opts.wasi_exec_model = parseWasiExecModel(arg["-mexec-model=".len..]); } else { fatal("unrecognized parameter: '{s}'", .{arg}); } } else switch (file_ext orelse Compilation.classifyFileExt(arg)) { .shared_library => { try create_module.link_objects.append(arena, .{ .path = arg }); create_module.opts.any_dyn_libs = true; }, .object, .static_library => { try create_module.link_objects.append(arena, .{ .path = arg }); }, .res => { try create_module.link_objects.append(arena, .{ .path = arg }); contains_res_file = true; }, .manifest => { if (manifest_file) |other| { fatal("only one manifest file can be specified, found '{s}' after '{s}'", .{ arg, other }); } else manifest_file = arg; }, .assembly, .assembly_with_cpp, .c, .cpp, .h, .hpp, .hm, .hmm, .ll, .bc, .m, .mm, .cu => { try create_module.c_source_files.append(arena, .{ // Populated after module creation. .owner = undefined, .src_path = arg, .extra_flags = try arena.dupe([]const u8, extra_cflags.items), // duped when parsing the args. .ext = file_ext, }); }, .rc => { try create_module.rc_source_files.append(arena, .{ // Populated after module creation. .owner = undefined, .src_path = arg, .extra_flags = try arena.dupe([]const u8, extra_rcflags.items), }); }, .zig => { if (root_src_file) |other| { fatal("found another zig file '{s}' after root source file '{s}'", .{ arg, other }); } else root_src_file = arg; }, .def, .unknown => { if (std.ascii.eqlIgnoreCase(".xml", std.fs.path.extension(arg))) { warn("embedded manifest files must have the extension '.manifest'", .{}); } fatal("unrecognized file extension of parameter '{s}'", .{arg}); }, } } }, .cc, .cpp => { if (build_options.only_c) unreachable; emit_h = .no; soname = .no; create_module.opts.ensure_libc_on_non_freestanding = true; create_module.opts.ensure_libcpp_on_non_freestanding = arg_mode == .cpp; create_module.want_native_include_dirs = true; // Clang's driver enables this switch unconditionally. // Disabling the emission of .eh_frame_hdr can unexpectedly break // some functionality that depend on it, such as C++ exceptions and // DWARF-based stack traces. link_eh_frame_hdr = true; const COutMode = enum { link, object, assembly, preprocessor, }; var c_out_mode: ?COutMode = null; var out_path: ?[]const u8 = null; var is_shared_lib = false; var linker_args = std.ArrayList([]const u8).init(arena); var it = ClangArgIterator.init(arena, all_args); var emit_llvm = false; var needed = false; var must_link = false; var file_ext: ?Compilation.FileExt = null; while (it.has_next) { it.next() catch |err| { fatal("unable to parse command line parameters: {s}", .{@errorName(err)}); }; switch (it.zig_equivalent) { .target => target_arch_os_abi = it.only_arg, // example: -target riscv64-linux-unknown .o => { // We handle -o /dev/null equivalent to -fno-emit-bin because // otherwise our atomic rename into place will fail. This also // makes Zig do less work, avoiding pointless file system operations. if (mem.eql(u8, it.only_arg, "/dev/null")) { emit_bin = .no; } else { out_path = it.only_arg; } }, .c, .r => c_out_mode = .object, // -c or -r .asm_only => c_out_mode = .assembly, // -S .preprocess_only => c_out_mode = .preprocessor, // -E .emit_llvm => emit_llvm = true, .x => { const lang = mem.sliceTo(it.only_arg, 0); if (mem.eql(u8, lang, "none")) { file_ext = null; } else if (Compilation.LangToExt.get(lang)) |got_ext| { file_ext = got_ext; } else { fatal("language not recognized: '{s}'", .{lang}); } }, .other => { try cc_argv.appendSlice(arena, it.other_args); }, .positional => switch (file_ext orelse Compilation.classifyFileExt(mem.sliceTo(it.only_arg, 0))) { .assembly, .assembly_with_cpp, .c, .cpp, .ll, .bc, .h, .hpp, .hm, .hmm, .m, .mm, .cu => { try create_module.c_source_files.append(arena, .{ // Populated after module creation. .owner = undefined, .src_path = it.only_arg, .ext = file_ext, // duped while parsing the args. }); }, .shared_library => { try create_module.link_objects.append(arena, .{ .path = it.only_arg, .must_link = must_link, }); create_module.opts.any_dyn_libs = true; }, .unknown, .object, .static_library => { try create_module.link_objects.append(arena, .{ .path = it.only_arg, .must_link = must_link, }); }, .res => { try create_module.link_objects.append(arena, .{ .path = it.only_arg, .must_link = must_link, }); contains_res_file = true; }, .manifest => { if (manifest_file) |other| { fatal("only one manifest file can be specified, found '{s}' after previously specified manifest '{s}'", .{ it.only_arg, other }); } else manifest_file = it.only_arg; }, .def => { linker_module_definition_file = it.only_arg; }, .rc => { try create_module.rc_source_files.append(arena, .{ // Populated after module creation. .owner = undefined, .src_path = it.only_arg, }); }, .zig => { if (root_src_file) |other| { fatal("found another zig file '{s}' after root source file '{s}'", .{ it.only_arg, other }); } else root_src_file = it.only_arg; }, }, .l => { // -l // We don't know whether this library is part of libc or libc++ until // we resolve the target, so we simply append to the list for now. if (mem.startsWith(u8, it.only_arg, ":")) { // -l :path/to/filename is used when callers need // more control over what's in the resulting // binary: no extra rpaths and DSO filename exactly // as provided. Hello, Go. try create_module.link_objects.append(arena, .{ .path = it.only_arg, .must_link = must_link, .loption = true, }); } else { try create_module.system_libs.put(arena, it.only_arg, .{ .needed = needed, .weak = false, .preferred_mode = lib_preferred_mode, .search_strategy = lib_search_strategy, }); } }, .ignore => {}, .driver_punt => { // Never mind what we're doing, just pass the args directly. For example --help. return process.exit(try clangMain(arena, all_args)); }, .pic => mod_opts.pic = true, .no_pic => mod_opts.pic = false, .pie => create_module.opts.pie = true, .no_pie => create_module.opts.pie = false, .lto => create_module.opts.lto = true, .no_lto => create_module.opts.lto = false, .red_zone => mod_opts.red_zone = true, .no_red_zone => mod_opts.red_zone = false, .omit_frame_pointer => mod_opts.omit_frame_pointer = true, .no_omit_frame_pointer => mod_opts.omit_frame_pointer = false, .function_sections => function_sections = true, .no_function_sections => function_sections = false, .data_sections => data_sections = true, .no_data_sections => data_sections = false, .builtin => no_builtin = false, .no_builtin => no_builtin = true, .color_diagnostics => color = .on, .no_color_diagnostics => color = .off, .stack_check => mod_opts.stack_check = true, .no_stack_check => mod_opts.stack_check = false, .stack_protector => { if (mod_opts.stack_protector == null) { mod_opts.stack_protector = Compilation.default_stack_protector_buffer_size; } }, .no_stack_protector => mod_opts.stack_protector = 0, .unwind_tables => mod_opts.unwind_tables = true, .no_unwind_tables => mod_opts.unwind_tables = false, .nostdlib => { create_module.opts.ensure_libc_on_non_freestanding = false; create_module.opts.ensure_libcpp_on_non_freestanding = false; }, .nostdlib_cpp => create_module.opts.ensure_libcpp_on_non_freestanding = false, .shared => { create_module.opts.link_mode = .Dynamic; is_shared_lib = true; }, .rdynamic => create_module.opts.rdynamic = true, .wl => { var split_it = mem.splitScalar(u8, it.only_arg, ','); while (split_it.next()) |linker_arg| { // Handle nested-joined args like `-Wl,-rpath=foo`. // Must be prefixed with 1 or 2 dashes. if (linker_arg.len >= 3 and linker_arg[0] == '-' and linker_arg[2] != '-') { if (mem.indexOfScalar(u8, linker_arg, '=')) |equals_pos| { const key = linker_arg[0..equals_pos]; const value = linker_arg[equals_pos + 1 ..]; if (mem.eql(u8, key, "--build-id")) { build_id = std.zig.BuildId.parse(value) catch |err| { fatal("unable to parse --build-id style '{s}': {s}", .{ value, @errorName(err), }); }; continue; } else if (mem.eql(u8, key, "--sort-common")) { // this ignores --sort=common=; ignoring plain --sort-common // is done below. continue; } try linker_args.append(key); try linker_args.append(value); continue; } } if (mem.eql(u8, linker_arg, "--build-id")) { build_id = .fast; } else if (mem.eql(u8, linker_arg, "--as-needed")) { needed = false; } else if (mem.eql(u8, linker_arg, "--no-as-needed")) { needed = true; } else if (mem.eql(u8, linker_arg, "-no-pie")) { create_module.opts.pie = false; } else if (mem.eql(u8, linker_arg, "--sort-common")) { // from ld.lld(1): --sort-common is ignored for GNU compatibility, // this ignores plain --sort-common } else if (mem.eql(u8, linker_arg, "--whole-archive") or mem.eql(u8, linker_arg, "-whole-archive")) { must_link = true; } else if (mem.eql(u8, linker_arg, "--no-whole-archive") or mem.eql(u8, linker_arg, "-no-whole-archive")) { must_link = false; } else if (mem.eql(u8, linker_arg, "-Bdynamic") or mem.eql(u8, linker_arg, "-dy") or mem.eql(u8, linker_arg, "-call_shared")) { lib_search_strategy = .no_fallback; lib_preferred_mode = .Dynamic; } else if (mem.eql(u8, linker_arg, "-Bstatic") or mem.eql(u8, linker_arg, "-dn") or mem.eql(u8, linker_arg, "-non_shared") or mem.eql(u8, linker_arg, "-static")) { lib_search_strategy = .no_fallback; lib_preferred_mode = .Static; } else if (mem.eql(u8, linker_arg, "-search_paths_first")) { lib_search_strategy = .paths_first; lib_preferred_mode = .Dynamic; } else if (mem.eql(u8, linker_arg, "-search_dylibs_first")) { lib_search_strategy = .mode_first; lib_preferred_mode = .Dynamic; } else { try linker_args.append(linker_arg); } } }, .optimize => { // Alright, what release mode do they want? const level = if (it.only_arg.len >= 1 and it.only_arg[0] == 'O') it.only_arg[1..] else it.only_arg; if (mem.eql(u8, level, "s") or mem.eql(u8, level, "z")) { mod_opts.optimize_mode = .ReleaseSmall; } else if (mem.eql(u8, level, "1") or mem.eql(u8, level, "2") or mem.eql(u8, level, "3") or mem.eql(u8, level, "4") or mem.eql(u8, level, "fast")) { mod_opts.optimize_mode = .ReleaseFast; } else if (mem.eql(u8, level, "g") or mem.eql(u8, level, "0")) { mod_opts.optimize_mode = .Debug; } else { try cc_argv.appendSlice(arena, it.other_args); } }, .debug => { mod_opts.strip = false; if (mem.eql(u8, it.only_arg, "g")) { // We handled with strip = false above. } else if (mem.eql(u8, it.only_arg, "g1") or mem.eql(u8, it.only_arg, "gline-tables-only")) { // We handled with strip = false above. but we also want reduced debug info. try cc_argv.append(arena, "-gline-tables-only"); } else { try cc_argv.appendSlice(arena, it.other_args); } }, .gdwarf32 => { mod_opts.strip = false; create_module.opts.debug_format = .{ .dwarf = .@"32" }; }, .gdwarf64 => { mod_opts.strip = false; create_module.opts.debug_format = .{ .dwarf = .@"64" }; }, .sanitize => { if (mem.eql(u8, it.only_arg, "undefined")) { mod_opts.sanitize_c = true; } else if (mem.eql(u8, it.only_arg, "thread")) { mod_opts.sanitize_thread = true; } else { try cc_argv.appendSlice(arena, it.other_args); } }, .linker_script => linker_script = it.only_arg, .verbose => { verbose_link = true; // Have Clang print more infos, some tools such as CMake // parse this to discover any implicit include and // library dir to look-up into. try cc_argv.append(arena, "-v"); }, .dry_run => { // This flag means "dry run". Clang will not actually output anything // to the file system. verbose_link = true; disable_c_depfile = true; try cc_argv.append(arena, "-###"); }, .for_linker => try linker_args.append(it.only_arg), .linker_input_z => { try linker_args.append("-z"); try linker_args.append(it.only_arg); }, .lib_dir => try create_module.lib_dir_args.append(arena, it.only_arg), .mcpu => target_mcpu = it.only_arg, .m => try create_module.llvm_m_args.append(arena, it.only_arg), .dep_file => { disable_c_depfile = true; try cc_argv.appendSlice(arena, it.other_args); }, .dep_file_to_stdout => { // -M, -MM // "Like -MD, but also implies -E and writes to stdout by default" // "Like -MMD, but also implies -E and writes to stdout by default" c_out_mode = .preprocessor; disable_c_depfile = true; try cc_argv.appendSlice(arena, it.other_args); }, .framework_dir => try create_module.framework_dirs.append(arena, it.only_arg), .framework => try create_module.frameworks.put(arena, it.only_arg, .{}), .nostdlibinc => create_module.want_native_include_dirs = false, .strip => mod_opts.strip = true, .exec_model => { create_module.opts.wasi_exec_model = parseWasiExecModel(it.only_arg); }, .sysroot => { create_module.sysroot = it.only_arg; }, .entry => { entry = .{ .named = it.only_arg }; }, .force_undefined_symbol => { try force_undefined_symbols.put(arena, it.only_arg, {}); }, .force_load_objc => force_load_objc = true, .weak_library => try create_module.system_libs.put(arena, it.only_arg, .{ .needed = false, .weak = true, .preferred_mode = lib_preferred_mode, .search_strategy = lib_search_strategy, }), .weak_framework => try create_module.frameworks.put(arena, it.only_arg, .{ .weak = true }), .headerpad_max_install_names => headerpad_max_install_names = true, .compress_debug_sections => { if (it.only_arg.len == 0) { linker_compress_debug_sections = .zlib; } else { linker_compress_debug_sections = std.meta.stringToEnum(link.File.Elf.CompressDebugSections, it.only_arg) orelse { fatal("expected [none|zlib|zstd] after --compress-debug-sections, found '{s}'", .{it.only_arg}); }; } }, .install_name => { install_name = it.only_arg; }, .undefined => { if (mem.eql(u8, "dynamic_lookup", it.only_arg)) { linker_allow_shlib_undefined = true; } else if (mem.eql(u8, "error", it.only_arg)) { linker_allow_shlib_undefined = false; } else { fatal("unsupported -undefined option '{s}'", .{it.only_arg}); } }, } } // Parse linker args. var linker_args_it = ArgsIterator{ .args = linker_args.items, }; while (linker_args_it.next()) |arg| { if (mem.eql(u8, arg, "-soname") or mem.eql(u8, arg, "--soname")) { const name = linker_args_it.nextOrFatal(); soname = .{ .yes = name }; // Use it as --name. // Example: libsoundio.so.2 var prefix: usize = 0; if (mem.startsWith(u8, name, "lib")) { prefix = 3; } var end: usize = name.len; if (mem.endsWith(u8, name, ".so")) { end -= 3; } else { var found_digit = false; while (end > 0 and std.ascii.isDigit(name[end - 1])) { found_digit = true; end -= 1; } if (found_digit and end > 0 and name[end - 1] == '.') { end -= 1; } else { end = name.len; } if (mem.endsWith(u8, name[prefix..end], ".so")) { end -= 3; } } provided_name = name[prefix..end]; } else if (mem.eql(u8, arg, "-rpath")) { try create_module.rpath_list.append(arena, linker_args_it.nextOrFatal()); } else if (mem.eql(u8, arg, "--subsystem")) { subsystem = try parseSubSystem(linker_args_it.nextOrFatal()); } else if (mem.eql(u8, arg, "-I") or mem.eql(u8, arg, "--dynamic-linker") or mem.eql(u8, arg, "-dynamic-linker")) { create_module.dynamic_linker = linker_args_it.nextOrFatal(); } else if (mem.eql(u8, arg, "-E") or mem.eql(u8, arg, "--export-dynamic") or mem.eql(u8, arg, "-export-dynamic")) { create_module.opts.rdynamic = true; } else if (mem.eql(u8, arg, "-version-script") or mem.eql(u8, arg, "--version-script")) { version_script = linker_args_it.nextOrFatal(); } else if (mem.eql(u8, arg, "--undefined-version")) { linker_allow_undefined_version = true; } else if (mem.eql(u8, arg, "--no-undefined-version")) { linker_allow_undefined_version = false; } else if (mem.eql(u8, arg, "-O")) { linker_optimization = linker_args_it.nextOrFatal(); } else if (mem.startsWith(u8, arg, "-O")) { linker_optimization = arg["-O".len..]; } else if (mem.eql(u8, arg, "-pagezero_size")) { const next_arg = linker_args_it.nextOrFatal(); pagezero_size = std.fmt.parseUnsigned(u64, eatIntPrefix(next_arg, 16), 16) catch |err| { fatal("unable to parse pagezero size '{s}': {s}", .{ next_arg, @errorName(err) }); }; } else if (mem.eql(u8, arg, "-headerpad")) { const next_arg = linker_args_it.nextOrFatal(); headerpad_size = std.fmt.parseUnsigned(u32, eatIntPrefix(next_arg, 16), 16) catch |err| { fatal("unable to parse headerpad size '{s}': {s}", .{ next_arg, @errorName(err) }); }; } else if (mem.eql(u8, arg, "-headerpad_max_install_names")) { headerpad_max_install_names = true; } else if (mem.eql(u8, arg, "-dead_strip")) { linker_gc_sections = true; } else if (mem.eql(u8, arg, "-dead_strip_dylibs")) { dead_strip_dylibs = true; } else if (mem.eql(u8, arg, "-ObjC")) { force_load_objc = true; } else if (mem.eql(u8, arg, "--no-undefined")) { linker_z_defs = true; } else if (mem.eql(u8, arg, "--gc-sections")) { linker_gc_sections = true; } else if (mem.eql(u8, arg, "--no-gc-sections")) { linker_gc_sections = false; } else if (mem.eql(u8, arg, "--print-gc-sections")) { linker_print_gc_sections = true; } else if (mem.eql(u8, arg, "--print-icf-sections")) { linker_print_icf_sections = true; } else if (mem.eql(u8, arg, "--print-map")) { linker_print_map = true; } else if (mem.eql(u8, arg, "--sort-section")) { const arg1 = linker_args_it.nextOrFatal(); linker_sort_section = std.meta.stringToEnum(link.File.Elf.SortSection, arg1) orelse { fatal("expected [name|alignment] after --sort-section, found '{s}'", .{arg1}); }; } else if (mem.eql(u8, arg, "--allow-shlib-undefined") or mem.eql(u8, arg, "-allow-shlib-undefined")) { linker_allow_shlib_undefined = true; } else if (mem.eql(u8, arg, "--no-allow-shlib-undefined") or mem.eql(u8, arg, "-no-allow-shlib-undefined")) { linker_allow_shlib_undefined = false; } else if (mem.eql(u8, arg, "-Bsymbolic")) { linker_bind_global_refs_locally = true; } else if (mem.eql(u8, arg, "--import-memory")) { create_module.opts.import_memory = true; } else if (mem.eql(u8, arg, "--export-memory")) { create_module.opts.export_memory = true; } else if (mem.eql(u8, arg, "--import-symbols")) { linker_import_symbols = true; } else if (mem.eql(u8, arg, "--import-table")) { linker_import_table = true; } else if (mem.eql(u8, arg, "--export-table")) { linker_export_table = true; } else if (mem.eql(u8, arg, "--no-entry")) { entry = .disabled; } else if (mem.eql(u8, arg, "--initial-memory")) { const next_arg = linker_args_it.nextOrFatal(); linker_initial_memory = std.fmt.parseUnsigned(u32, eatIntPrefix(next_arg, 16), 16) catch |err| { fatal("unable to parse initial memory size '{s}': {s}", .{ next_arg, @errorName(err) }); }; } else if (mem.eql(u8, arg, "--max-memory")) { const next_arg = linker_args_it.nextOrFatal(); linker_max_memory = std.fmt.parseUnsigned(u32, eatIntPrefix(next_arg, 16), 16) catch |err| { fatal("unable to parse max memory size '{s}': {s}", .{ next_arg, @errorName(err) }); }; } else if (mem.eql(u8, arg, "--shared-memory")) { create_module.opts.shared_memory = true; } else if (mem.eql(u8, arg, "--global-base")) { const next_arg = linker_args_it.nextOrFatal(); linker_global_base = std.fmt.parseUnsigned(u32, eatIntPrefix(next_arg, 16), 16) catch |err| { fatal("unable to parse global base '{s}': {s}", .{ next_arg, @errorName(err) }); }; } else if (mem.eql(u8, arg, "--export")) { try linker_export_symbol_names.append(arena, linker_args_it.nextOrFatal()); } else if (mem.eql(u8, arg, "--compress-debug-sections")) { const arg1 = linker_args_it.nextOrFatal(); linker_compress_debug_sections = std.meta.stringToEnum(link.File.Elf.CompressDebugSections, arg1) orelse { fatal("expected [none|zlib|zstd] after --compress-debug-sections, found '{s}'", .{arg1}); }; } else if (mem.startsWith(u8, arg, "-z")) { var z_arg = arg[2..]; if (z_arg.len == 0) { z_arg = linker_args_it.nextOrFatal(); } if (mem.eql(u8, z_arg, "nodelete")) { linker_z_nodelete = true; } else if (mem.eql(u8, z_arg, "notext")) { linker_z_notext = true; } else if (mem.eql(u8, z_arg, "defs")) { linker_z_defs = true; } else if (mem.eql(u8, z_arg, "undefs")) { linker_z_defs = false; } else if (mem.eql(u8, z_arg, "origin")) { linker_z_origin = true; } else if (mem.eql(u8, z_arg, "nocopyreloc")) { linker_z_nocopyreloc = true; } else if (mem.eql(u8, z_arg, "noexecstack")) { // noexecstack is the default when linking with LLD } else if (mem.eql(u8, z_arg, "now")) { linker_z_now = true; } else if (mem.eql(u8, z_arg, "lazy")) { linker_z_now = false; } else if (mem.eql(u8, z_arg, "relro")) { linker_z_relro = true; } else if (mem.eql(u8, z_arg, "norelro")) { linker_z_relro = false; } else if (mem.startsWith(u8, z_arg, "stack-size=")) { stack_size = parseStackSize(z_arg["stack-size=".len..]); } else if (mem.startsWith(u8, z_arg, "common-page-size=")) { linker_z_common_page_size = parseIntSuffix(z_arg, "common-page-size=".len); } else if (mem.startsWith(u8, z_arg, "max-page-size=")) { linker_z_max_page_size = parseIntSuffix(z_arg, "max-page-size=".len); } else { fatal("unsupported linker extension flag: -z {s}", .{z_arg}); } } else if (mem.eql(u8, arg, "--major-image-version")) { const major = linker_args_it.nextOrFatal(); version.major = std.fmt.parseUnsigned(u32, major, 10) catch |err| { fatal("unable to parse major image version '{s}': {s}", .{ major, @errorName(err) }); }; have_version = true; } else if (mem.eql(u8, arg, "--minor-image-version")) { const minor = linker_args_it.nextOrFatal(); version.minor = std.fmt.parseUnsigned(u32, minor, 10) catch |err| { fatal("unable to parse minor image version '{s}': {s}", .{ minor, @errorName(err) }); }; have_version = true; } else if (mem.eql(u8, arg, "-e") or mem.eql(u8, arg, "--entry")) { entry = .{ .named = linker_args_it.nextOrFatal() }; } else if (mem.eql(u8, arg, "-u")) { try force_undefined_symbols.put(arena, linker_args_it.nextOrFatal(), {}); } else if (mem.eql(u8, arg, "--stack") or mem.eql(u8, arg, "-stack_size")) { stack_size = parseStackSize(linker_args_it.nextOrFatal()); } else if (mem.eql(u8, arg, "--image-base")) { image_base = parseImageBase(linker_args_it.nextOrFatal()); } else if (mem.eql(u8, arg, "-T") or mem.eql(u8, arg, "--script")) { linker_script = linker_args_it.nextOrFatal(); } else if (mem.eql(u8, arg, "--eh-frame-hdr")) { link_eh_frame_hdr = true; } else if (mem.eql(u8, arg, "--no-eh-frame-hdr")) { link_eh_frame_hdr = false; } else if (mem.eql(u8, arg, "--tsaware")) { linker_tsaware = true; } else if (mem.eql(u8, arg, "--nxcompat")) { linker_nxcompat = true; } else if (mem.eql(u8, arg, "--dynamicbase")) { linker_dynamicbase = true; } else if (mem.eql(u8, arg, "--no-dynamicbase")) { linker_dynamicbase = false; } else if (mem.eql(u8, arg, "--high-entropy-va")) { // This option does not do anything. } else if (mem.eql(u8, arg, "--export-all-symbols")) { create_module.opts.rdynamic = true; } else if (mem.eql(u8, arg, "--color-diagnostics") or mem.eql(u8, arg, "--color-diagnostics=always")) { color = .on; } else if (mem.eql(u8, arg, "--no-color-diagnostics") or mem.eql(u8, arg, "--color-diagnostics=never")) { color = .off; } else if (mem.eql(u8, arg, "-s") or mem.eql(u8, arg, "--strip-all") or mem.eql(u8, arg, "-S") or mem.eql(u8, arg, "--strip-debug")) { // -s, --strip-all Strip all symbols // -S, --strip-debug Strip debugging symbols mod_opts.strip = true; } else if (mem.eql(u8, arg, "--start-group") or mem.eql(u8, arg, "--end-group")) { // We don't need to care about these because these args are // for resolving circular dependencies but our linker takes // care of this without explicit args. } else if (mem.eql(u8, arg, "--major-os-version") or mem.eql(u8, arg, "--minor-os-version")) { // This option does not do anything. _ = linker_args_it.nextOrFatal(); } else if (mem.eql(u8, arg, "--major-subsystem-version")) { const major = linker_args_it.nextOrFatal(); major_subsystem_version = std.fmt.parseUnsigned(u16, major, 10) catch |err| { fatal("unable to parse major subsystem version '{s}': {s}", .{ major, @errorName(err), }); }; } else if (mem.eql(u8, arg, "--minor-subsystem-version")) { const minor = linker_args_it.nextOrFatal(); minor_subsystem_version = std.fmt.parseUnsigned(u16, minor, 10) catch |err| { fatal("unable to parse minor subsystem version '{s}': {s}", .{ minor, @errorName(err), }); }; } else if (mem.eql(u8, arg, "-framework")) { try create_module.frameworks.put(arena, linker_args_it.nextOrFatal(), .{}); } else if (mem.eql(u8, arg, "-weak_framework")) { try create_module.frameworks.put(arena, linker_args_it.nextOrFatal(), .{ .weak = true }); } else if (mem.eql(u8, arg, "-needed_framework")) { try create_module.frameworks.put(arena, linker_args_it.nextOrFatal(), .{ .needed = true }); } else if (mem.eql(u8, arg, "-needed_library")) { try create_module.system_libs.put(arena, linker_args_it.nextOrFatal(), .{ .weak = false, .needed = true, .preferred_mode = lib_preferred_mode, .search_strategy = lib_search_strategy, }); } else if (mem.startsWith(u8, arg, "-weak-l")) { try create_module.system_libs.put(arena, arg["-weak-l".len..], .{ .weak = true, .needed = false, .preferred_mode = lib_preferred_mode, .search_strategy = lib_search_strategy, }); } else if (mem.eql(u8, arg, "-weak_library")) { try create_module.system_libs.put(arena, linker_args_it.nextOrFatal(), .{ .weak = true, .needed = false, .preferred_mode = lib_preferred_mode, .search_strategy = lib_search_strategy, }); } else if (mem.eql(u8, arg, "-compatibility_version")) { const compat_version = linker_args_it.nextOrFatal(); compatibility_version = std.SemanticVersion.parse(compat_version) catch |err| { fatal("unable to parse -compatibility_version '{s}': {s}", .{ compat_version, @errorName(err) }); }; } else if (mem.eql(u8, arg, "-current_version")) { const curr_version = linker_args_it.nextOrFatal(); version = std.SemanticVersion.parse(curr_version) catch |err| { fatal("unable to parse -current_version '{s}': {s}", .{ curr_version, @errorName(err) }); }; have_version = true; } else if (mem.eql(u8, arg, "--out-implib") or mem.eql(u8, arg, "-implib")) { emit_implib = .{ .yes = linker_args_it.nextOrFatal() }; emit_implib_arg_provided = true; } else if (mem.eql(u8, arg, "-undefined")) { const lookup_type = linker_args_it.nextOrFatal(); if (mem.eql(u8, "dynamic_lookup", lookup_type)) { linker_allow_shlib_undefined = true; } else if (mem.eql(u8, "error", lookup_type)) { linker_allow_shlib_undefined = false; } else { fatal("unsupported -undefined option '{s}'", .{lookup_type}); } } else if (mem.eql(u8, arg, "-install_name")) { install_name = linker_args_it.nextOrFatal(); } else if (mem.eql(u8, arg, "-force_load")) { try create_module.link_objects.append(arena, .{ .path = linker_args_it.nextOrFatal(), .must_link = true, }); } else if (mem.eql(u8, arg, "-hash-style") or mem.eql(u8, arg, "--hash-style")) { const next_arg = linker_args_it.nextOrFatal(); hash_style = std.meta.stringToEnum(link.File.Elf.HashStyle, next_arg) orelse { fatal("expected [sysv|gnu|both] after --hash-style, found '{s}'", .{ next_arg, }); }; } else if (mem.eql(u8, arg, "-wrap")) { const next_arg = linker_args_it.nextOrFatal(); try symbol_wrap_set.put(arena, next_arg, {}); } else if (mem.startsWith(u8, arg, "/subsystem:")) { var split_it = mem.splitBackwardsScalar(u8, arg, ':'); subsystem = try parseSubSystem(split_it.first()); } else if (mem.startsWith(u8, arg, "/implib:")) { var split_it = mem.splitBackwardsScalar(u8, arg, ':'); emit_implib = .{ .yes = split_it.first() }; emit_implib_arg_provided = true; } else if (mem.startsWith(u8, arg, "/pdb:")) { var split_it = mem.splitBackwardsScalar(u8, arg, ':'); pdb_out_path = split_it.first(); } else if (mem.startsWith(u8, arg, "/version:")) { var split_it = mem.splitBackwardsScalar(u8, arg, ':'); const version_arg = split_it.first(); version = std.SemanticVersion.parse(version_arg) catch |err| { fatal("unable to parse /version '{s}': {s}", .{ arg, @errorName(err) }); }; have_version = true; } else if (mem.eql(u8, arg, "--version")) { try std.io.getStdOut().writeAll("zig ld " ++ build_options.version ++ "\n"); process.exit(0); } else { fatal("unsupported linker arg: {s}", .{arg}); } } if (mod_opts.sanitize_c) |wsc| { if (wsc and mod_opts.optimize_mode == .ReleaseFast) { mod_opts.optimize_mode = .ReleaseSafe; } } // precompiled header syntax: "zig cc -x c-header test.h -o test.pch" const emit_pch = ((file_ext == .h or file_ext == .hpp or file_ext == .hm or file_ext == .hmm) and c_out_mode == null); if (emit_pch) c_out_mode = .preprocessor; switch (c_out_mode orelse .link) { .link => { create_module.opts.output_mode = if (is_shared_lib) .Lib else .Exe; emit_bin = if (out_path) |p| .{ .yes = p } else EmitBin.yes_a_out; if (emit_llvm) { fatal("-emit-llvm cannot be used when linking", .{}); } }, .object => { create_module.opts.output_mode = .Obj; if (emit_llvm) { emit_bin = .no; if (out_path) |p| { emit_llvm_bc = .{ .yes = p }; } else { emit_llvm_bc = .yes_default_path; } } else { if (out_path) |p| { emit_bin = .{ .yes = p }; } else { emit_bin = .yes_default_path; } } }, .assembly => { create_module.opts.output_mode = .Obj; emit_bin = .no; if (emit_llvm) { if (out_path) |p| { emit_llvm_ir = .{ .yes = p }; } else { emit_llvm_ir = .yes_default_path; } } else { if (out_path) |p| { emit_asm = .{ .yes = p }; } else { emit_asm = .yes_default_path; } } }, .preprocessor => { create_module.opts.output_mode = .Obj; // An error message is generated when there is more than 1 C source file. if (create_module.c_source_files.items.len != 1) { // For example `zig cc` and no args should print the "no input files" message. return process.exit(try clangMain(arena, all_args)); } if (emit_pch) { emit_bin = if (out_path) |p| .{ .yes = p } else .yes_default_path; clang_preprocessor_mode = .pch; } else { if (out_path) |p| { emit_bin = .{ .yes = p }; clang_preprocessor_mode = .yes; } else { clang_preprocessor_mode = .stdout; } } }, } if (create_module.c_source_files.items.len == 0 and create_module.link_objects.items.len == 0 and root_src_file == null) { // For example `zig cc` and no args should print the "no input files" message. // There could be other reasons to punt to clang, for example, --help. return process.exit(try clangMain(arena, all_args)); } }, } if (arg_mode == .translate_c and create_module.c_source_files.items.len != 1) { fatal("translate-c expects exactly 1 source file (found {d})", .{create_module.c_source_files.items.len}); } if (show_builtin and root_src_file == null) { // Without this, there will be no main module created and no zig // compilation unit, and therefore also no builtin.zig contents // created. root_src_file = "builtin.zig"; } implicit_root_mod: { const unresolved_src_path = b: { if (root_src_file) |src_path| { if (create_module.modules.count() != 0) { fatal("main module provided both by '--mod {s} {}{s}' and by positional argument '{s}'", .{ create_module.modules.keys()[0], create_module.modules.values()[0].paths.root, create_module.modules.values()[0].paths.root_src_path, src_path, }); } create_module.opts.have_zcu = true; break :b src_path; } if (create_module.modules.count() != 0) break :implicit_root_mod; if (create_module.c_source_files.items.len >= 1) break :b create_module.c_source_files.items[0].src_path; if (create_module.link_objects.items.len >= 1) break :b create_module.link_objects.items[0].path; if (emit_bin == .yes) break :b emit_bin.yes; if (create_module.rc_source_files.items.len >= 1) break :b create_module.rc_source_files.items[0].src_path; if (arg_mode == .run) fatal("`zig run` expects at least one positional argument", .{}); fatal("expected a positional argument, -femit-bin=[path], --show-builtin, or --name [name]", .{}); break :implicit_root_mod; }; // See duplicate logic: ModCreationGlobalFlags if (mod_opts.single_threaded == false) create_module.opts.any_non_single_threaded = true; if (mod_opts.sanitize_thread == true) create_module.opts.any_sanitize_thread = true; if (mod_opts.unwind_tables == true) create_module.opts.any_unwind_tables = true; if (mod_opts.strip == false) create_module.opts.any_non_stripped = true; if (mod_opts.error_tracing == true) create_module.opts.any_error_tracing = true; const src_path = try introspect.resolvePath(arena, unresolved_src_path); const name = if (arg_mode == .zig_test) "test" else fs.path.stem(fs.path.basename(src_path)); try create_module.modules.put(arena, name, .{ .paths = .{ .root = .{ .root_dir = Cache.Directory.cwd(), .sub_path = fs.path.dirname(src_path) orelse "", }, .root_src_path = fs.path.basename(src_path), }, .cc_argv = try cc_argv.toOwnedSlice(arena), .inherited = mod_opts, .target_arch_os_abi = target_arch_os_abi, .target_mcpu = target_mcpu, .deps = try deps.toOwnedSlice(arena), .resolved = null, .c_source_files_start = c_source_files_owner_index, .c_source_files_end = create_module.c_source_files.items.len, .rc_source_files_start = rc_source_files_owner_index, .rc_source_files_end = create_module.rc_source_files.items.len, }); cssan.reset(); mod_opts = .{}; target_arch_os_abi = null; target_mcpu = null; c_source_files_owner_index = create_module.c_source_files.items.len; rc_source_files_owner_index = create_module.rc_source_files.items.len; } if (!create_module.opts.have_zcu and arg_mode == .zig_test) { fatal("`zig test` expects a zig source file argument", .{}); } if (c_source_files_owner_index != create_module.c_source_files.items.len) { fatal("C source file '{s}' has no parent module", .{ create_module.c_source_files.items[c_source_files_owner_index].src_path, }); } if (rc_source_files_owner_index != create_module.rc_source_files.items.len) { fatal("resource file '{s}' has no parent module", .{ create_module.rc_source_files.items[rc_source_files_owner_index].src_path, }); } const self_exe_path: ?[]const u8 = if (!process.can_spawn) null else introspect.findZigExePath(arena) catch |err| { fatal("unable to find zig self exe path: {s}", .{@errorName(err)}); }; var zig_lib_directory: Compilation.Directory = d: { if (override_lib_dir) |unresolved_lib_dir| { const lib_dir = try introspect.resolvePath(arena, unresolved_lib_dir); break :d .{ .path = lib_dir, .handle = fs.cwd().openDir(lib_dir, .{}) catch |err| { fatal("unable to open zig lib directory '{s}': {s}", .{ lib_dir, @errorName(err) }); }, }; } else if (builtin.os.tag == .wasi) { break :d getWasiPreopen("/lib"); } else if (self_exe_path) |p| { break :d introspect.findZigLibDirFromSelfExe(arena, p) catch |err| { fatal("unable to find zig installation directory: {s}", .{@errorName(err)}); }; } else { unreachable; } }; defer zig_lib_directory.handle.close(); var global_cache_directory: Compilation.Directory = l: { if (override_global_cache_dir) |p| { break :l .{ .handle = try fs.cwd().makeOpenPath(p, .{}), .path = p, }; } if (builtin.os.tag == .wasi) { break :l getWasiPreopen("/cache"); } const p = try introspect.resolveGlobalCacheDir(arena); break :l .{ .handle = try fs.cwd().makeOpenPath(p, .{}), .path = p, }; }; defer global_cache_directory.handle.close(); if (linker_optimization) |o| { warn("ignoring deprecated linker optimization setting '{s}'", .{o}); } create_module.global_cache_directory = global_cache_directory; create_module.opts.emit_llvm_ir = emit_llvm_ir != .no; create_module.opts.emit_llvm_bc = emit_llvm_bc != .no; create_module.opts.emit_bin = emit_bin != .no; create_module.opts.any_c_source_files = create_module.c_source_files.items.len != 0; const main_mod = try createModule(gpa, arena, &create_module, 0, null, zig_lib_directory); for (create_module.modules.keys(), create_module.modules.values()) |key, cli_mod| { if (cli_mod.resolved == null) fatal("module '{s}' declared but not used", .{key}); } // When you're testing std, the main module is std. In that case, // we'll just set the std module to the main one, since avoiding // the errors caused by duplicating it is more effort than it's // worth. const main_mod_is_std = m: { const std_path = try fs.path.resolve(arena, &.{ zig_lib_directory.path orelse ".", "std", "std.zig", }); const main_path = try fs.path.resolve(arena, &.{ main_mod.root.root_dir.path orelse ".", main_mod.root.sub_path, main_mod.root_src_path, }); break :m mem.eql(u8, main_path, std_path); }; const std_mod = m: { if (main_mod_is_std) break :m main_mod; if (create_module.modules.get("std")) |cli_mod| break :m cli_mod.resolved.?; break :m null; }; const root_mod = if (arg_mode == .zig_test) root_mod: { const test_mod = if (test_runner_path) |test_runner| test_mod: { const test_mod = try Package.Module.create(arena, .{ .global_cache_directory = global_cache_directory, .paths = .{ .root = .{ .root_dir = Cache.Directory.cwd(), .sub_path = fs.path.dirname(test_runner) orelse "", }, .root_src_path = fs.path.basename(test_runner), }, .fully_qualified_name = "root", .cc_argv = &.{}, .inherited = .{}, .global = create_module.resolved_options, .parent = main_mod, .builtin_mod = main_mod.getBuiltinDependency(), }); test_mod.deps = try main_mod.deps.clone(arena); break :test_mod test_mod; } else try Package.Module.create(arena, .{ .global_cache_directory = global_cache_directory, .paths = .{ .root = .{ .root_dir = zig_lib_directory, .sub_path = "compiler", }, .root_src_path = "test_runner.zig", }, .fully_qualified_name = "root", .cc_argv = &.{}, .inherited = .{}, .global = create_module.resolved_options, .parent = main_mod, .builtin_mod = main_mod.getBuiltinDependency(), }); break :root_mod test_mod; } else main_mod; const target = main_mod.resolved_target.result; if (target.ofmt != .coff) { if (manifest_file != null) { fatal("manifest file is not allowed unless the target object format is coff (Windows/UEFI)", .{}); } if (create_module.rc_source_files.items.len != 0) { fatal("rc files are not allowed unless the target object format is coff (Windows/UEFI)", .{}); } if (contains_res_file) { fatal("res files are not allowed unless the target object format is coff (Windows/UEFI)", .{}); } } // We now repeat part of the process for frameworks. var resolved_frameworks = std.ArrayList(Compilation.Framework).init(arena); if (create_module.frameworks.keys().len > 0) { var test_path = std.ArrayList(u8).init(gpa); defer test_path.deinit(); var checked_paths = std.ArrayList(u8).init(gpa); defer checked_paths.deinit(); var failed_frameworks = std.ArrayList(struct { name: []const u8, checked_paths: []const u8, }).init(arena); framework: for (create_module.frameworks.keys(), create_module.frameworks.values()) |framework_name, info| { checked_paths.clearRetainingCapacity(); for (create_module.framework_dirs.items) |framework_dir_path| { if (try accessFrameworkPath( &test_path, &checked_paths, framework_dir_path, framework_name, )) { const path = try arena.dupe(u8, test_path.items); try resolved_frameworks.append(.{ .needed = info.needed, .weak = info.weak, .path = path, }); continue :framework; } } try failed_frameworks.append(.{ .name = framework_name, .checked_paths = try arena.dupe(u8, checked_paths.items), }); } if (failed_frameworks.items.len > 0) { for (failed_frameworks.items) |f| { const searched_paths = if (f.checked_paths.len == 0) " none" else f.checked_paths; std.log.err("unable to find framework '{s}'. searched paths: {s}", .{ f.name, searched_paths, }); } process.exit(1); } } // After this point, resolved_frameworks is used instead of frameworks. if (create_module.resolved_options.output_mode == .Obj and target.ofmt == .coff) { const total_obj_count = create_module.c_source_files.items.len + @intFromBool(root_src_file != null) + create_module.rc_source_files.items.len + create_module.link_objects.items.len; if (total_obj_count > 1) { fatal("{s} does not support linking multiple objects into one", .{@tagName(target.ofmt)}); } } var cleanup_emit_bin_dir: ?fs.Dir = null; defer if (cleanup_emit_bin_dir) |*dir| dir.close(); const output_to_cache = listen != .none; const optional_version = if (have_version) version else null; const root_name = if (provided_name) |n| n else main_mod.fully_qualified_name; const resolved_soname: ?[]const u8 = switch (soname) { .yes => |explicit| explicit, .no => null, .yes_default_value => switch (target.ofmt) { .elf => if (have_version) try std.fmt.allocPrint(arena, "lib{s}.so.{d}", .{ root_name, version.major }) else try std.fmt.allocPrint(arena, "lib{s}.so", .{root_name}), else => null, }, }; const a_out_basename = switch (target.ofmt) { .coff => "a.exe", else => "a.out", }; const emit_bin_loc: ?Compilation.EmitLoc = switch (emit_bin) { .no => null, .yes_default_path => Compilation.EmitLoc{ .directory = blk: { switch (arg_mode) { .run, .zig_test => break :blk null, else => { if (output_to_cache) { break :blk null; } else { break :blk .{ .path = null, .handle = fs.cwd() }; } }, } }, .basename = if (clang_preprocessor_mode == .pch) try std.fmt.allocPrint(arena, "{s}.pch", .{root_name}) else try std.zig.binNameAlloc(arena, .{ .root_name = root_name, .target = target, .output_mode = create_module.resolved_options.output_mode, .link_mode = create_module.resolved_options.link_mode, .version = optional_version, }), }, .yes => |full_path| b: { const basename = fs.path.basename(full_path); if (fs.path.dirname(full_path)) |dirname| { const handle = fs.cwd().openDir(dirname, .{}) catch |err| { fatal("unable to open output directory '{s}': {s}", .{ dirname, @errorName(err) }); }; cleanup_emit_bin_dir = handle; break :b Compilation.EmitLoc{ .basename = basename, .directory = .{ .path = dirname, .handle = handle, }, }; } else { break :b Compilation.EmitLoc{ .basename = basename, .directory = .{ .path = null, .handle = fs.cwd() }, }; } }, .yes_a_out => Compilation.EmitLoc{ .directory = .{ .path = null, .handle = fs.cwd() }, .basename = a_out_basename, }, }; const default_h_basename = try std.fmt.allocPrint(arena, "{s}.h", .{root_name}); var emit_h_resolved = emit_h.resolve(default_h_basename, output_to_cache) catch |err| { switch (emit_h) { .yes => |p| { fatal("unable to open directory from argument '-femit-h', '{s}': {s}", .{ p, @errorName(err), }); }, .yes_default_path => { fatal("unable to open directory from arguments '--name' or '-fsoname', '{s}': {s}", .{ default_h_basename, @errorName(err), }); }, .no => unreachable, } }; defer emit_h_resolved.deinit(); const default_asm_basename = try std.fmt.allocPrint(arena, "{s}.s", .{root_name}); var emit_asm_resolved = emit_asm.resolve(default_asm_basename, output_to_cache) catch |err| { switch (emit_asm) { .yes => |p| { fatal("unable to open directory from argument '-femit-asm', '{s}': {s}", .{ p, @errorName(err), }); }, .yes_default_path => { fatal("unable to open directory from arguments '--name' or '-fsoname', '{s}': {s}", .{ default_asm_basename, @errorName(err), }); }, .no => unreachable, } }; defer emit_asm_resolved.deinit(); const default_llvm_ir_basename = try std.fmt.allocPrint(arena, "{s}.ll", .{root_name}); var emit_llvm_ir_resolved = emit_llvm_ir.resolve(default_llvm_ir_basename, output_to_cache) catch |err| { switch (emit_llvm_ir) { .yes => |p| { fatal("unable to open directory from argument '-femit-llvm-ir', '{s}': {s}", .{ p, @errorName(err), }); }, .yes_default_path => { fatal("unable to open directory from arguments '--name' or '-fsoname', '{s}': {s}", .{ default_llvm_ir_basename, @errorName(err), }); }, .no => unreachable, } }; defer emit_llvm_ir_resolved.deinit(); const default_llvm_bc_basename = try std.fmt.allocPrint(arena, "{s}.bc", .{root_name}); var emit_llvm_bc_resolved = emit_llvm_bc.resolve(default_llvm_bc_basename, output_to_cache) catch |err| { switch (emit_llvm_bc) { .yes => |p| { fatal("unable to open directory from argument '-femit-llvm-bc', '{s}': {s}", .{ p, @errorName(err), }); }, .yes_default_path => { fatal("unable to open directory from arguments '--name' or '-fsoname', '{s}': {s}", .{ default_llvm_bc_basename, @errorName(err), }); }, .no => unreachable, } }; defer emit_llvm_bc_resolved.deinit(); var emit_docs_resolved = emit_docs.resolve("docs", output_to_cache) catch |err| { switch (emit_docs) { .yes => |p| { fatal("unable to open directory from argument '-femit-docs', '{s}': {s}", .{ p, @errorName(err), }); }, .yes_default_path => { fatal("unable to open directory 'docs': {s}", .{@errorName(err)}); }, .no => unreachable, } }; defer emit_docs_resolved.deinit(); const is_exe_or_dyn_lib = switch (create_module.resolved_options.output_mode) { .Obj => false, .Lib => create_module.resolved_options.link_mode == .Dynamic, .Exe => true, }; // Note that cmake when targeting Windows will try to execute // zig cc to make an executable and output an implib too. const implib_eligible = is_exe_or_dyn_lib and emit_bin_loc != null and target.os.tag == .windows; if (!implib_eligible) { if (!emit_implib_arg_provided) { emit_implib = .no; } else if (emit_implib != .no) { fatal("the argument -femit-implib is allowed only when building a Windows DLL", .{}); } } const default_implib_basename = try std.fmt.allocPrint(arena, "{s}.lib", .{root_name}); var emit_implib_resolved = switch (emit_implib) { .no => Emit.Resolved{ .data = null, .dir = null }, .yes => |p| emit_implib.resolve(default_implib_basename, output_to_cache) catch |err| { fatal("unable to open directory from argument '-femit-implib', '{s}': {s}", .{ p, @errorName(err), }); }, .yes_default_path => Emit.Resolved{ .data = Compilation.EmitLoc{ .directory = emit_bin_loc.?.directory, .basename = default_implib_basename, }, .dir = null, }, }; defer emit_implib_resolved.deinit(); var thread_pool: ThreadPool = undefined; try thread_pool.init(.{ .allocator = gpa }); defer thread_pool.deinit(); var cleanup_local_cache_dir: ?fs.Dir = null; defer if (cleanup_local_cache_dir) |*dir| dir.close(); var local_cache_directory: Compilation.Directory = l: { if (override_local_cache_dir) |local_cache_dir_path| { const dir = try fs.cwd().makeOpenPath(local_cache_dir_path, .{}); cleanup_local_cache_dir = dir; break :l .{ .handle = dir, .path = local_cache_dir_path, }; } if (arg_mode == .run) { break :l global_cache_directory; } // search upwards from cwd until we find directory with build.zig const cwd_path = try process.getCwdAlloc(arena); const zig_cache = "zig-cache"; var dirname: []const u8 = cwd_path; while (true) { const joined_path = try fs.path.join(arena, &.{ dirname, Package.build_zig_basename, }); if (fs.cwd().access(joined_path, .{})) |_| { const cache_dir_path = try fs.path.join(arena, &.{ dirname, zig_cache }); const dir = try fs.cwd().makeOpenPath(cache_dir_path, .{}); cleanup_local_cache_dir = dir; break :l .{ .handle = dir, .path = cache_dir_path }; } else |err| switch (err) { error.FileNotFound => { dirname = fs.path.dirname(dirname) orelse { break :l global_cache_directory; }; continue; }, else => break :l global_cache_directory, } } // Otherwise we really don't have a reasonable place to put the local cache directory, // so we utilize the global one. break :l global_cache_directory; }; for (create_module.c_source_files.items) |*src| { if (!mem.eql(u8, src.src_path, "-")) continue; const ext = src.ext orelse fatal("-E or -x is required when reading from a non-regular file", .{}); // "-" is stdin. Dump it to a real file. const sep = fs.path.sep_str; const sub_path = try std.fmt.allocPrint(arena, "tmp" ++ sep ++ "{x}-stdin{s}", .{ std.crypto.random.int(u64), ext.canonicalName(target), }); try local_cache_directory.handle.makePath("tmp"); // Note that in one of the happy paths, execve() is used to switch // to clang in which case any cleanup logic that exists for this // temporary file will not run and this temp file will be leaked. // Oh well. It's a minor punishment for using `-x c` which nobody // should be doing. Therefore, we make no effort to clean up. Using // `-` for stdin as a source file always leaks a temp file. var f = try local_cache_directory.handle.createFile(sub_path, .{}); defer f.close(); try f.writeFileAll(io.getStdIn(), .{}); // Convert `sub_path` to be relative to current working directory. src.src_path = try local_cache_directory.join(arena, &.{sub_path}); } if (build_options.have_llvm and emit_asm != .no) { // LLVM has no way to set this non-globally. const argv = [_][*:0]const u8{ "zig (LLVM option parsing)", "--x86-asm-syntax=intel" }; @import("codegen/llvm/bindings.zig").ParseCommandLineOptions(argv.len, &argv); } const clang_passthrough_mode = switch (arg_mode) { .cc, .cpp, .translate_c => true, else => false, }; const disable_lld_caching = !output_to_cache; const cache_mode: Compilation.CacheMode = b: { if (disable_lld_caching) break :b .incremental; if (!create_module.resolved_options.have_zcu) break :b .whole; // TODO: once we support incremental compilation for the LLVM backend // via saving the LLVM module into a bitcode file and restoring it, // along with compiler state, this clause can be removed so that // incremental cache mode is used for LLVM backend too. if (create_module.resolved_options.use_llvm) break :b .whole; break :b .incremental; }; gimmeMoreOfThoseSweetSweetFileDescriptors(); const comp = Compilation.create(gpa, arena, .{ .zig_lib_directory = zig_lib_directory, .local_cache_directory = local_cache_directory, .global_cache_directory = global_cache_directory, .thread_pool = &thread_pool, .self_exe_path = self_exe_path, .config = create_module.resolved_options, .root_name = root_name, .sysroot = create_module.sysroot, .main_mod = main_mod, .root_mod = root_mod, .std_mod = std_mod, .emit_bin = emit_bin_loc, .emit_h = emit_h_resolved.data, .emit_asm = emit_asm_resolved.data, .emit_llvm_ir = emit_llvm_ir_resolved.data, .emit_llvm_bc = emit_llvm_bc_resolved.data, .emit_docs = emit_docs_resolved.data, .emit_implib = emit_implib_resolved.data, .lib_dirs = create_module.lib_dirs.items, .rpath_list = create_module.rpath_list.items, .symbol_wrap_set = symbol_wrap_set, .c_source_files = create_module.c_source_files.items, .rc_source_files = create_module.rc_source_files.items, .manifest_file = manifest_file, .rc_includes = rc_includes, .link_objects = create_module.link_objects.items, .framework_dirs = create_module.framework_dirs.items, .frameworks = resolved_frameworks.items, .system_lib_names = create_module.resolved_system_libs.items(.name), .system_lib_infos = create_module.resolved_system_libs.items(.lib), .wasi_emulated_libs = create_module.wasi_emulated_libs.items, .want_compiler_rt = want_compiler_rt, .hash_style = hash_style, .linker_script = linker_script, .version_script = version_script, .linker_allow_undefined_version = linker_allow_undefined_version, .disable_c_depfile = disable_c_depfile, .soname = resolved_soname, .linker_sort_section = linker_sort_section, .linker_gc_sections = linker_gc_sections, .linker_allow_shlib_undefined = linker_allow_shlib_undefined, .linker_bind_global_refs_locally = linker_bind_global_refs_locally, .linker_import_symbols = linker_import_symbols, .linker_import_table = linker_import_table, .linker_export_table = linker_export_table, .linker_initial_memory = linker_initial_memory, .linker_max_memory = linker_max_memory, .linker_print_gc_sections = linker_print_gc_sections, .linker_print_icf_sections = linker_print_icf_sections, .linker_print_map = linker_print_map, .llvm_opt_bisect_limit = llvm_opt_bisect_limit, .linker_global_base = linker_global_base, .linker_export_symbol_names = linker_export_symbol_names.items, .linker_z_nocopyreloc = linker_z_nocopyreloc, .linker_z_nodelete = linker_z_nodelete, .linker_z_notext = linker_z_notext, .linker_z_defs = linker_z_defs, .linker_z_origin = linker_z_origin, .linker_z_now = linker_z_now, .linker_z_relro = linker_z_relro, .linker_z_common_page_size = linker_z_common_page_size, .linker_z_max_page_size = linker_z_max_page_size, .linker_tsaware = linker_tsaware, .linker_nxcompat = linker_nxcompat, .linker_dynamicbase = linker_dynamicbase, .linker_compress_debug_sections = linker_compress_debug_sections, .linker_module_definition_file = linker_module_definition_file, .major_subsystem_version = major_subsystem_version, .minor_subsystem_version = minor_subsystem_version, .link_eh_frame_hdr = link_eh_frame_hdr, .link_emit_relocs = link_emit_relocs, .entry = entry, .force_undefined_symbols = force_undefined_symbols, .stack_size = stack_size, .image_base = image_base, .formatted_panics = formatted_panics, .function_sections = function_sections, .data_sections = data_sections, .no_builtin = no_builtin, .clang_passthrough_mode = clang_passthrough_mode, .clang_preprocessor_mode = clang_preprocessor_mode, .version = optional_version, .compatibility_version = compatibility_version, .libc_installation = if (create_module.libc_installation) |*lci| lci else null, .verbose_cc = verbose_cc, .verbose_link = verbose_link, .verbose_air = verbose_air, .verbose_intern_pool = verbose_intern_pool, .verbose_generic_instances = verbose_generic_instances, .verbose_llvm_ir = verbose_llvm_ir, .verbose_llvm_bc = verbose_llvm_bc, .verbose_cimport = verbose_cimport, .verbose_llvm_cpu_features = verbose_llvm_cpu_features, .time_report = time_report, .stack_report = stack_report, .build_id = build_id, .test_filters = test_filters.items, .test_name_prefix = test_name_prefix, .test_runner_path = test_runner_path, .disable_lld_caching = disable_lld_caching, .cache_mode = cache_mode, .subsystem = subsystem, .debug_compile_errors = debug_compile_errors, .debug_incremental = debug_incremental, .enable_link_snapshots = enable_link_snapshots, .install_name = install_name, .entitlements = entitlements, .pagezero_size = pagezero_size, .headerpad_size = headerpad_size, .headerpad_max_install_names = headerpad_max_install_names, .dead_strip_dylibs = dead_strip_dylibs, .force_load_objc = force_load_objc, .reference_trace = reference_trace, .pdb_out_path = pdb_out_path, .error_limit = error_limit, .native_system_include_paths = create_module.native_system_include_paths, // Any leftover C compilation args (such as -I) apply globally rather // than to any particular module. This feature can greatly reduce CLI // noise when --search-prefix and --mod are combined. .global_cc_argv = try cc_argv.toOwnedSlice(arena), }) catch |err| switch (err) { error.LibCUnavailable => { const triple_name = try target.zigTriple(arena); std.log.err("unable to find or provide libc for target '{s}'", .{triple_name}); for (std.zig.target.available_libcs) |t| { if (t.arch == target.cpu.arch and t.os == target.os.tag) { if (t.os_ver) |os_ver| { std.log.info("zig can provide libc for related target {s}-{s}.{d}-{s}", .{ @tagName(t.arch), @tagName(t.os), os_ver.major, @tagName(t.abi), }); } else { std.log.info("zig can provide libc for related target {s}-{s}-{s}", .{ @tagName(t.arch), @tagName(t.os), @tagName(t.abi), }); } } } process.exit(1); }, error.ExportTableAndImportTableConflict => { fatal("--import-table and --export-table may not be used together", .{}); }, else => fatal("unable to create compilation: {s}", .{@errorName(err)}), }; var comp_destroyed = false; defer if (!comp_destroyed) comp.destroy(); if (show_builtin) { const builtin_mod = comp.root_mod.getBuiltinDependency(); const source = builtin_mod.builtin_file.?.source; return std.io.getStdOut().writeAll(source); } switch (listen) { .none => {}, .stdio => { if (build_options.only_c) unreachable; try serve( comp, std.io.getStdIn(), std.io.getStdOut(), test_exec_args.items, self_exe_path, arg_mode, all_args, runtime_args_start, ); return cleanExit(); }, .ip4 => |ip4_addr| { if (build_options.only_core_functionality) unreachable; const addr: std.net.Address = .{ .in = ip4_addr }; var server = try addr.listen(.{ .reuse_address = true, }); defer server.deinit(); const conn = try server.accept(); defer conn.stream.close(); try serve( comp, .{ .handle = conn.stream.handle }, .{ .handle = conn.stream.handle }, test_exec_args.items, self_exe_path, arg_mode, all_args, runtime_args_start, ); return cleanExit(); }, } if (arg_mode == .translate_c) { return cmdTranslateC(comp, arena, null); } updateModule(comp, color) catch |err| switch (err) { error.SemanticAnalyzeFail => { assert(listen == .none); saveState(comp, debug_incremental); process.exit(1); }, else => |e| return e, }; if (build_options.only_c) return cleanExit(); try comp.makeBinFileExecutable(); saveState(comp, debug_incremental); if (test_exec_args.items.len == 0 and target.ofmt == .c) default_exec_args: { // Default to using `zig run` to execute the produced .c code from `zig test`. const c_code_loc = emit_bin_loc orelse break :default_exec_args; const c_code_directory = c_code_loc.directory orelse comp.bin_file.?.emit.directory; const c_code_path = try fs.path.join(arena, &[_][]const u8{ c_code_directory.path orelse ".", c_code_loc.basename, }); try test_exec_args.appendSlice(arena, &.{ self_exe_path, "run" }); if (zig_lib_directory.path) |p| { try test_exec_args.appendSlice(arena, &.{ "-I", p }); } if (create_module.resolved_options.link_libc) { try test_exec_args.append(arena, "-lc"); } else if (target.os.tag == .windows) { try test_exec_args.appendSlice(arena, &.{ "--subsystem", "console", "-lkernel32", "-lntdll", }); } const first_cli_mod = create_module.modules.values()[0]; if (first_cli_mod.target_arch_os_abi) |triple| { try test_exec_args.appendSlice(arena, &.{ "-target", triple }); } if (first_cli_mod.target_mcpu) |mcpu| { try test_exec_args.append(arena, try std.fmt.allocPrint(arena, "-mcpu={s}", .{mcpu})); } if (create_module.dynamic_linker) |dl| { try test_exec_args.appendSlice(arena, &.{ "--dynamic-linker", dl }); } try test_exec_args.append(arena, c_code_path); } const run_or_test = switch (arg_mode) { .run => true, .zig_test => !test_no_exec, else => false, }; if (run_or_test) { try runOrTest( comp, gpa, arena, test_exec_args.items, self_exe_path.?, arg_mode, &target, &comp_destroyed, all_args, runtime_args_start, create_module.resolved_options.link_libc, ); } // Skip resource deallocation in release builds; let the OS do it. return cleanExit(); } const CreateModule = struct { global_cache_directory: Cache.Directory, modules: std.StringArrayHashMapUnmanaged(CliModule), opts: Compilation.Config.Options, dynamic_linker: ?[]const u8, object_format: ?[]const u8, /// undefined until createModule() for the root module is called. resolved_options: Compilation.Config, /// This one is used while collecting CLI options. The set of libs is used /// directly after computing the target and used to compute link_libc, /// link_libcpp, and then the libraries are filtered into /// `external_system_libs` and `resolved_system_libs`. system_libs: std.StringArrayHashMapUnmanaged(SystemLib), resolved_system_libs: std.MultiArrayList(struct { name: []const u8, lib: Compilation.SystemLib, }), wasi_emulated_libs: std.ArrayListUnmanaged(wasi_libc.CRTFile), c_source_files: std.ArrayListUnmanaged(Compilation.CSourceFile), rc_source_files: std.ArrayListUnmanaged(Compilation.RcSourceFile), /// e.g. -m3dnow or -mno-outline-atomics. They correspond to std.Target llvm cpu feature names. /// This array is populated by zig cc frontend and then has to be converted to zig-style /// CPU features. llvm_m_args: std.ArrayListUnmanaged([]const u8), sysroot: ?[]const u8, lib_dirs: std.ArrayListUnmanaged([]const u8), lib_dir_args: std.ArrayListUnmanaged([]const u8), libc_installation: ?LibCInstallation, want_native_include_dirs: bool, frameworks: std.StringArrayHashMapUnmanaged(Framework), native_system_include_paths: []const []const u8, framework_dirs: std.ArrayListUnmanaged([]const u8), rpath_list: std.ArrayListUnmanaged([]const u8), each_lib_rpath: ?bool, libc_paths_file: ?[]const u8, link_objects: std.ArrayListUnmanaged(Compilation.LinkObject), host_triple: ?[]const u8, host_cpu: ?[]const u8, host_dynamic_linker: ?[]const u8, }; fn createModule( gpa: Allocator, arena: Allocator, create_module: *CreateModule, index: usize, parent: ?*Package.Module, zig_lib_directory: Cache.Directory, ) Allocator.Error!*Package.Module { const cli_mod = &create_module.modules.values()[index]; if (cli_mod.resolved) |m| return m; const name = create_module.modules.keys()[index]; cli_mod.inherited.resolved_target = t: { // If the target is not overridden, use the parent's target. Of course, // if this is the root module then we need to proceed to resolve the // target. if (cli_mod.target_arch_os_abi == null and cli_mod.target_mcpu == null and create_module.dynamic_linker == null and create_module.object_format == null) { if (parent) |p| break :t p.resolved_target; } var target_parse_options: std.Target.Query.ParseOptions = .{ .arch_os_abi = cli_mod.target_arch_os_abi orelse "native", .cpu_features = cli_mod.target_mcpu, .dynamic_linker = create_module.dynamic_linker, .object_format = create_module.object_format, }; // Before passing the mcpu string in for parsing, we convert any -m flags that were // passed in via zig cc to zig-style. if (create_module.llvm_m_args.items.len != 0) { // If this returns null, we let it fall through to the case below which will // run the full parse function and do proper error handling. if (std.Target.Query.parseCpuArch(target_parse_options)) |cpu_arch| { var llvm_to_zig_name = std.StringHashMap([]const u8).init(gpa); defer llvm_to_zig_name.deinit(); for (cpu_arch.allFeaturesList()) |feature| { const llvm_name = feature.llvm_name orelse continue; try llvm_to_zig_name.put(llvm_name, feature.name); } var mcpu_buffer = std.ArrayList(u8).init(gpa); defer mcpu_buffer.deinit(); try mcpu_buffer.appendSlice(cli_mod.target_mcpu orelse "baseline"); for (create_module.llvm_m_args.items) |llvm_m_arg| { if (mem.startsWith(u8, llvm_m_arg, "mno-")) { const llvm_name = llvm_m_arg["mno-".len..]; const zig_name = llvm_to_zig_name.get(llvm_name) orelse { fatal("target architecture {s} has no LLVM CPU feature named '{s}'", .{ @tagName(cpu_arch), llvm_name, }); }; try mcpu_buffer.append('-'); try mcpu_buffer.appendSlice(zig_name); } else if (mem.startsWith(u8, llvm_m_arg, "m")) { const llvm_name = llvm_m_arg["m".len..]; const zig_name = llvm_to_zig_name.get(llvm_name) orelse { fatal("target architecture {s} has no LLVM CPU feature named '{s}'", .{ @tagName(cpu_arch), llvm_name, }); }; try mcpu_buffer.append('+'); try mcpu_buffer.appendSlice(zig_name); } else { unreachable; } } const adjusted_target_mcpu = try arena.dupe(u8, mcpu_buffer.items); std.log.debug("adjusted target_mcpu: {s}", .{adjusted_target_mcpu}); target_parse_options.cpu_features = adjusted_target_mcpu; } } const target_query = std.zig.parseTargetQueryOrReportFatalError(arena, target_parse_options); const adjusted_target_query = a: { if (!target_query.isNative()) break :a target_query; if (create_module.host_triple) |triple| target_parse_options.arch_os_abi = triple; if (create_module.host_cpu) |cpu| target_parse_options.cpu_features = cpu; if (create_module.host_dynamic_linker) |dl| target_parse_options.dynamic_linker = dl; break :a std.zig.parseTargetQueryOrReportFatalError(arena, target_parse_options); }; const target = std.zig.resolveTargetQueryOrFatal(adjusted_target_query); break :t .{ .result = target, .is_native_os = target_query.isNativeOs(), .is_native_abi = target_query.isNativeAbi(), }; }; if (parent == null) { // This block is for initializing the fields of // `Compilation.Config.Options` that require knowledge of the // target (which was just now resolved for the root module above). const resolved_target = cli_mod.inherited.resolved_target.?; create_module.opts.resolved_target = resolved_target; create_module.opts.root_optimize_mode = cli_mod.inherited.optimize_mode; create_module.opts.root_strip = cli_mod.inherited.strip; create_module.opts.root_error_tracing = cli_mod.inherited.error_tracing; const target = resolved_target.result; // First, remove libc, libc++, and compiler_rt libraries from the system libraries list. // We need to know whether the set of system libraries contains anything besides these // to decide whether to trigger native path detection logic. var external_system_libs: std.MultiArrayList(struct { name: []const u8, info: SystemLib, }) = .{}; for (create_module.system_libs.keys(), create_module.system_libs.values()) |lib_name, info| { if (target.is_libc_lib_name(lib_name)) { create_module.opts.link_libc = true; continue; } if (target.is_libcpp_lib_name(lib_name)) { create_module.opts.link_libcpp = true; continue; } switch (target_util.classifyCompilerRtLibName(target, lib_name)) { .none => {}, .only_libunwind, .both => { create_module.opts.link_libunwind = true; continue; }, .only_compiler_rt => { warn("ignoring superfluous library '{s}': this dependency is fulfilled instead by compiler-rt which zig unconditionally provides", .{lib_name}); continue; }, } if (target.isMinGW()) { const exists = mingw.libExists(arena, target, zig_lib_directory, lib_name) catch |err| { fatal("failed to check zig installation for DLL import libs: {s}", .{ @errorName(err), }); }; if (exists) { try create_module.resolved_system_libs.append(arena, .{ .name = lib_name, .lib = .{ .needed = true, .weak = false, .path = null, }, }); continue; } } if (fs.path.isAbsolute(lib_name)) { fatal("cannot use absolute path as a system library: {s}", .{lib_name}); } if (target.os.tag == .wasi) { if (wasi_libc.getEmulatedLibCRTFile(lib_name)) |crt_file| { try create_module.wasi_emulated_libs.append(arena, crt_file); continue; } } try external_system_libs.append(arena, .{ .name = lib_name, .info = info, }); } // After this point, external_system_libs is used instead of system_libs. if (external_system_libs.len != 0) create_module.want_native_include_dirs = true; // Resolve the library path arguments with respect to sysroot. if (create_module.sysroot) |root| { try create_module.lib_dirs.ensureUnusedCapacity(arena, create_module.lib_dir_args.items.len * 2); for (create_module.lib_dir_args.items) |dir| { if (fs.path.isAbsolute(dir)) { const stripped_dir = dir[fs.path.diskDesignator(dir).len..]; const full_path = try fs.path.join(arena, &[_][]const u8{ root, stripped_dir }); create_module.lib_dirs.appendAssumeCapacity(full_path); } create_module.lib_dirs.appendAssumeCapacity(dir); } } else { create_module.lib_dirs = create_module.lib_dir_args; } create_module.lib_dir_args = undefined; // From here we use lib_dirs instead. if (resolved_target.is_native_os and target.isDarwin()) { // If we want to link against frameworks, we need system headers. if (create_module.frameworks.count() > 0) create_module.want_native_include_dirs = true; } if (create_module.each_lib_rpath orelse resolved_target.is_native_os) { try create_module.rpath_list.appendSlice(arena, create_module.lib_dirs.items); } // Trigger native system library path detection if necessary. if (create_module.sysroot == null and resolved_target.is_native_os and resolved_target.is_native_abi and create_module.want_native_include_dirs) { var paths = std.zig.system.NativePaths.detect(arena, target) catch |err| { fatal("unable to detect native system paths: {s}", .{@errorName(err)}); }; for (paths.warnings.items) |warning| { warn("{s}", .{warning}); } create_module.native_system_include_paths = try paths.include_dirs.toOwnedSlice(arena); try create_module.framework_dirs.appendSlice(arena, paths.framework_dirs.items); try create_module.lib_dirs.appendSlice(arena, paths.lib_dirs.items); try create_module.rpath_list.appendSlice(arena, paths.rpaths.items); } if (create_module.libc_paths_file) |paths_file| { create_module.libc_installation = LibCInstallation.parse(arena, paths_file, target) catch |err| { fatal("unable to parse libc paths file at path {s}: {s}", .{ paths_file, @errorName(err), }); }; } if (builtin.target.os.tag == .windows and target.abi == .msvc and external_system_libs.len != 0) { if (create_module.libc_installation == null) { create_module.libc_installation = LibCInstallation.findNative(.{ .allocator = arena, .verbose = true, .target = target, }) catch |err| { fatal("unable to find native libc installation: {s}", .{@errorName(err)}); }; try create_module.lib_dirs.appendSlice(arena, &.{ create_module.libc_installation.?.msvc_lib_dir.?, create_module.libc_installation.?.kernel32_lib_dir.?, }); } } // If any libs in this list are statically provided, we omit them from the // resolved list and populate the link_objects array instead. { var test_path = std.ArrayList(u8).init(gpa); defer test_path.deinit(); var checked_paths = std.ArrayList(u8).init(gpa); defer checked_paths.deinit(); var failed_libs = std.ArrayList(struct { name: []const u8, strategy: SystemLib.SearchStrategy, checked_paths: []const u8, preferred_mode: std.builtin.LinkMode, }).init(arena); syslib: for (external_system_libs.items(.name), external_system_libs.items(.info)) |lib_name, info| { // Checked in the first pass above while looking for libc libraries. assert(!fs.path.isAbsolute(lib_name)); checked_paths.clearRetainingCapacity(); switch (info.search_strategy) { .mode_first, .no_fallback => { // check for preferred mode for (create_module.lib_dirs.items) |lib_dir_path| { if (try accessLibPath( &test_path, &checked_paths, lib_dir_path, lib_name, target, info.preferred_mode, )) { const path = try arena.dupe(u8, test_path.items); switch (info.preferred_mode) { .Static => try create_module.link_objects.append(arena, .{ .path = path }), .Dynamic => try create_module.resolved_system_libs.append(arena, .{ .name = lib_name, .lib = .{ .needed = info.needed, .weak = info.weak, .path = path, }, }), } continue :syslib; } } // check for fallback mode if (info.search_strategy == .no_fallback) { try failed_libs.append(.{ .name = lib_name, .strategy = info.search_strategy, .checked_paths = try arena.dupe(u8, checked_paths.items), .preferred_mode = info.preferred_mode, }); continue :syslib; } for (create_module.lib_dirs.items) |lib_dir_path| { if (try accessLibPath( &test_path, &checked_paths, lib_dir_path, lib_name, target, info.fallbackMode(), )) { const path = try arena.dupe(u8, test_path.items); switch (info.fallbackMode()) { .Static => try create_module.link_objects.append(arena, .{ .path = path }), .Dynamic => try create_module.resolved_system_libs.append(arena, .{ .name = lib_name, .lib = .{ .needed = info.needed, .weak = info.weak, .path = path, }, }), } continue :syslib; } } try failed_libs.append(.{ .name = lib_name, .strategy = info.search_strategy, .checked_paths = try arena.dupe(u8, checked_paths.items), .preferred_mode = info.preferred_mode, }); continue :syslib; }, .paths_first => { for (create_module.lib_dirs.items) |lib_dir_path| { // check for preferred mode if (try accessLibPath( &test_path, &checked_paths, lib_dir_path, lib_name, target, info.preferred_mode, )) { const path = try arena.dupe(u8, test_path.items); switch (info.preferred_mode) { .Static => try create_module.link_objects.append(arena, .{ .path = path }), .Dynamic => try create_module.resolved_system_libs.append(arena, .{ .name = lib_name, .lib = .{ .needed = info.needed, .weak = info.weak, .path = path, }, }), } continue :syslib; } // check for fallback mode if (try accessLibPath( &test_path, &checked_paths, lib_dir_path, lib_name, target, info.fallbackMode(), )) { const path = try arena.dupe(u8, test_path.items); switch (info.fallbackMode()) { .Static => try create_module.link_objects.append(arena, .{ .path = path }), .Dynamic => try create_module.resolved_system_libs.append(arena, .{ .name = lib_name, .lib = .{ .needed = info.needed, .weak = info.weak, .path = path, }, }), } continue :syslib; } } try failed_libs.append(.{ .name = lib_name, .strategy = info.search_strategy, .checked_paths = try arena.dupe(u8, checked_paths.items), .preferred_mode = info.preferred_mode, }); continue :syslib; }, } @compileError("unreachable"); } if (failed_libs.items.len > 0) { for (failed_libs.items) |f| { const searched_paths = if (f.checked_paths.len == 0) " none" else f.checked_paths; std.log.err("unable to find {s} system library '{s}' using strategy '{s}'. searched paths:{s}", .{ @tagName(f.preferred_mode), f.name, @tagName(f.strategy), searched_paths, }); } process.exit(1); } } // After this point, create_module.resolved_system_libs is used instead of // create_module.external_system_libs. if (create_module.resolved_system_libs.len != 0) create_module.opts.any_dyn_libs = true; create_module.resolved_options = Compilation.Config.resolve(create_module.opts) catch |err| switch (err) { error.WasiExecModelRequiresWasi => fatal("only WASI OS targets support execution model", .{}), error.SharedMemoryIsWasmOnly => fatal("only WebAssembly CPU targets support shared memory", .{}), error.ObjectFilesCannotShareMemory => fatal("object files cannot share memory", .{}), error.SharedMemoryRequiresAtomicsAndBulkMemory => fatal("shared memory requires atomics and bulk_memory CPU features", .{}), error.ThreadsRequireSharedMemory => fatal("threads require shared memory", .{}), error.EmittingLlvmModuleRequiresLlvmBackend => fatal("emitting an LLVM module requires using the LLVM backend", .{}), error.LlvmLacksTargetSupport => fatal("LLVM lacks support for the specified target", .{}), error.ZigLacksTargetSupport => fatal("compiler backend unavailable for the specified target", .{}), error.EmittingBinaryRequiresLlvmLibrary => fatal("producing machine code via LLVM requires using the LLVM library", .{}), error.LldIncompatibleObjectFormat => fatal("using LLD to link {s} files is unsupported", .{@tagName(target.ofmt)}), error.LtoRequiresLld => fatal("LTO requires using LLD", .{}), error.SanitizeThreadRequiresLibCpp => fatal("thread sanitization is (for now) implemented in C++, so it requires linking libc++", .{}), error.LibCppRequiresLibUnwind => fatal("libc++ requires linking libunwind", .{}), error.OsRequiresLibC => fatal("the target OS requires using libc as the stable syscall interface", .{}), error.LibCppRequiresLibC => fatal("libc++ requires linking libc", .{}), error.LibUnwindRequiresLibC => fatal("libunwind requires linking libc", .{}), error.TargetCannotDynamicLink => fatal("dynamic linking unavailable on the specified target", .{}), error.LibCRequiresDynamicLinking => fatal("libc of the specified target requires dynamic linking", .{}), error.SharedLibrariesRequireDynamicLinking => fatal("using shared libraries requires dynamic linking", .{}), error.ExportMemoryAndDynamicIncompatible => fatal("exporting memory is incompatible with dynamic linking", .{}), error.DynamicLibraryPrecludesPie => fatal("dynamic libraries cannot be position independent executables", .{}), error.TargetRequiresPie => fatal("the specified target requires position independent executables", .{}), error.SanitizeThreadRequiresPie => fatal("thread sanitization requires position independent executables", .{}), error.BackendLacksErrorTracing => fatal("the selected backend has not yet implemented error return tracing", .{}), error.LlvmLibraryUnavailable => fatal("zig was compiled without LLVM libraries", .{}), error.LldUnavailable => fatal("zig was compiled without LLD libraries", .{}), error.ClangUnavailable => fatal("zig was compiled without Clang libraries", .{}), error.DllExportFnsRequiresWindows => fatal("only Windows OS targets support DLLs", .{}), }; } const mod = Package.Module.create(arena, .{ .global_cache_directory = create_module.global_cache_directory, .paths = cli_mod.paths, .fully_qualified_name = name, .cc_argv = cli_mod.cc_argv, .inherited = cli_mod.inherited, .global = create_module.resolved_options, .parent = parent, .builtin_mod = null, }) catch |err| switch (err) { error.ValgrindUnsupportedOnTarget => fatal("unable to create module '{s}': valgrind does not support the selected target CPU architecture", .{name}), error.TargetRequiresSingleThreaded => fatal("unable to create module '{s}': the selected target does not support multithreading", .{name}), error.BackendRequiresSingleThreaded => fatal("unable to create module '{s}': the selected machine code backend is limited to single-threaded applications", .{name}), error.TargetRequiresPic => fatal("unable to create module '{s}': the selected target requires position independent code", .{name}), error.PieRequiresPic => fatal("unable to create module '{s}': making a Position Independent Executable requires enabling Position Independent Code", .{name}), error.DynamicLinkingRequiresPic => fatal("unable to create module '{s}': dynamic linking requires enabling Position Independent Code", .{name}), error.TargetHasNoRedZone => fatal("unable to create module '{s}': the selected target does not have a red zone", .{name}), error.StackCheckUnsupportedByTarget => fatal("unable to create module '{s}': the selected target does not support stack checking", .{name}), error.StackProtectorUnsupportedByTarget => fatal("unable to create module '{s}': the selected target does not support stack protection", .{name}), error.StackProtectorUnavailableWithoutLibC => fatal("unable to create module '{s}': enabling stack protection requires libc", .{name}), error.OutOfMemory => return error.OutOfMemory, }; cli_mod.resolved = mod; for (create_module.c_source_files.items[cli_mod.c_source_files_start..cli_mod.c_source_files_end]) |*item| item.owner = mod; for (create_module.rc_source_files.items[cli_mod.rc_source_files_start..cli_mod.rc_source_files_end]) |*item| item.owner = mod; for (cli_mod.deps) |dep| { const dep_index = create_module.modules.getIndex(dep.value) orelse fatal("module '{s}' depends on non-existent module '{s}'", .{ name, dep.key }); const dep_mod = try createModule(gpa, arena, create_module, dep_index, mod, zig_lib_directory); try mod.deps.put(arena, dep.key, dep_mod); } return mod; } fn saveState(comp: *Compilation, debug_incremental: bool) void { if (debug_incremental) { comp.saveState() catch |err| { warn("unable to save incremental compilation state: {s}", .{@errorName(err)}); }; } } fn serve( comp: *Compilation, in: fs.File, out: fs.File, test_exec_args: []const ?[]const u8, self_exe_path: ?[]const u8, arg_mode: ArgMode, all_args: []const []const u8, runtime_args_start: ?usize, ) !void { const gpa = comp.gpa; var server = try Server.init(.{ .gpa = gpa, .in = in, .out = out, .zig_version = build_options.version, }); defer server.deinit(); var child_pid: ?std.ChildProcess.Id = null; var progress: std.Progress = .{ .terminal = null, .root = .{ .context = undefined, .parent = null, .name = "", .unprotected_estimated_total_items = 0, .unprotected_completed_items = 0, }, .columns_written = 0, .prev_refresh_timestamp = 0, .timer = null, .done = false, }; const main_progress_node = &progress.root; main_progress_node.context = &progress; while (true) { const hdr = try server.receiveMessage(); switch (hdr.tag) { .exit => return cleanExit(), .update => { assert(main_progress_node.recently_updated_child == null); tracy.frameMark(); if (arg_mode == .translate_c) { var arena_instance = std.heap.ArenaAllocator.init(gpa); defer arena_instance.deinit(); const arena = arena_instance.allocator(); var output: Compilation.CImportResult = undefined; try cmdTranslateC(comp, arena, &output); defer output.deinit(gpa); if (output.errors.errorMessageCount() != 0) { try server.serveErrorBundle(output.errors); } else { try server.serveEmitBinPath(output.out_zig_path, .{ .flags = .{ .cache_hit = output.cache_hit }, }); } continue; } if (comp.config.output_mode == .Exe) { try comp.makeBinFileWritable(); } if (builtin.single_threaded) { try comp.update(main_progress_node); } else { var reset: std.Thread.ResetEvent = .{}; var progress_thread = try std.Thread.spawn(.{}, progressThread, .{ &progress, &server, &reset, }); defer { reset.set(); progress_thread.join(); } try comp.update(main_progress_node); } try comp.makeBinFileExecutable(); try serveUpdateResults(&server, comp); }, .run => { if (child_pid != null) { @panic("TODO block until the child exits"); } @panic("TODO call runOrTest"); //try runOrTest( // comp, // gpa, // arena, // test_exec_args, // self_exe_path.?, // arg_mode, // target, // true, // &comp_destroyed, // all_args, // runtime_args_start, // link_libc, //); }, .hot_update => { tracy.frameMark(); assert(main_progress_node.recently_updated_child == null); if (child_pid) |pid| { try comp.hotCodeSwap(main_progress_node, pid); try serveUpdateResults(&server, comp); } else { if (comp.config.output_mode == .Exe) { try comp.makeBinFileWritable(); } try comp.update(main_progress_node); try comp.makeBinFileExecutable(); try serveUpdateResults(&server, comp); child_pid = try runOrTestHotSwap( comp, gpa, test_exec_args, self_exe_path.?, arg_mode, all_args, runtime_args_start, ); } }, else => { fatal("unrecognized message from client: 0x{x}", .{@intFromEnum(hdr.tag)}); }, } } } fn progressThread(progress: *std.Progress, server: *const Server, reset: *std.Thread.ResetEvent) void { while (true) { if (reset.timedWait(500 * std.time.ns_per_ms)) |_| { // The Compilation update has completed. return; } else |err| switch (err) { error.Timeout => {}, } var buf: std.BoundedArray(u8, 160) = .{}; { progress.update_mutex.lock(); defer progress.update_mutex.unlock(); var need_ellipse = false; var maybe_node: ?*std.Progress.Node = &progress.root; while (maybe_node) |node| { if (need_ellipse) { buf.appendSlice("... ") catch {}; } need_ellipse = false; const eti = @atomicLoad(usize, &node.unprotected_estimated_total_items, .Monotonic); const completed_items = @atomicLoad(usize, &node.unprotected_completed_items, .Monotonic); const current_item = completed_items + 1; if (node.name.len != 0 or eti > 0) { if (node.name.len != 0) { buf.appendSlice(node.name) catch {}; need_ellipse = true; } if (eti > 0) { if (need_ellipse) buf.appendSlice(" ") catch {}; buf.writer().print("[{d}/{d}] ", .{ current_item, eti }) catch {}; need_ellipse = false; } else if (completed_items != 0) { if (need_ellipse) buf.appendSlice(" ") catch {}; buf.writer().print("[{d}] ", .{current_item}) catch {}; need_ellipse = false; } } maybe_node = @atomicLoad(?*std.Progress.Node, &node.recently_updated_child, .Acquire); } } const progress_string = buf.slice(); server.serveMessage(.{ .tag = .progress, .bytes_len = @as(u32, @intCast(progress_string.len)), }, &.{ progress_string, }) catch |err| { fatal("unable to write to client: {s}", .{@errorName(err)}); }; } } fn serveUpdateResults(s: *Server, comp: *Compilation) !void { const gpa = comp.gpa; var error_bundle = try comp.getAllErrorsAlloc(); defer error_bundle.deinit(gpa); if (error_bundle.errorMessageCount() > 0) { try s.serveErrorBundle(error_bundle); return; } // This logic is counter-intuitive because the protocol accounts for each // emitted artifact possibly being in a different location, which correctly // matches the behavior of the compiler, however, the build system // currently always passes flags that makes all build artifacts output to // the same local cache directory, and relies on them all being in the same // directory. // // So, until the build system and protocol are changed to reflect this, // this logic must ensure that emit_bin_path is emitted for at least one // thing, if there are any artifacts. switch (comp.cache_use) { .incremental => if (comp.bin_file) |lf| { const full_path = try lf.emit.directory.join(gpa, &.{lf.emit.sub_path}); defer gpa.free(full_path); try s.serveEmitBinPath(full_path, .{ .flags = .{ .cache_hit = comp.last_update_was_cache_hit }, }); return; }, .whole => |whole| if (whole.bin_sub_path) |sub_path| { const full_path = try comp.local_cache_directory.join(gpa, &.{sub_path}); defer gpa.free(full_path); try s.serveEmitBinPath(full_path, .{ .flags = .{ .cache_hit = comp.last_update_was_cache_hit }, }); return; }, } for ([_]?Compilation.Emit{ comp.docs_emit, comp.implib_emit, }) |opt_emit| { const emit = opt_emit orelse continue; const full_path = try emit.directory.join(gpa, &.{emit.sub_path}); defer gpa.free(full_path); try s.serveEmitBinPath(full_path, .{ .flags = .{ .cache_hit = comp.last_update_was_cache_hit }, }); return; } for ([_]?Compilation.EmitLoc{ comp.emit_asm, comp.emit_llvm_ir, comp.emit_llvm_bc, }) |opt_emit_loc| { const emit_loc = opt_emit_loc orelse continue; const directory = emit_loc.directory orelse continue; const full_path = try directory.join(gpa, &.{emit_loc.basename}); defer gpa.free(full_path); try s.serveEmitBinPath(full_path, .{ .flags = .{ .cache_hit = comp.last_update_was_cache_hit }, }); return; } } fn runOrTest( comp: *Compilation, gpa: Allocator, arena: Allocator, test_exec_args: []const ?[]const u8, self_exe_path: []const u8, arg_mode: ArgMode, target: *const std.Target, comp_destroyed: *bool, all_args: []const []const u8, runtime_args_start: ?usize, link_libc: bool, ) !void { const lf = comp.bin_file orelse return; // A naive `directory.join` here will indeed get the correct path to the binary, // however, in the case of cwd, we actually want `./foo` so that the path can be executed. const exe_path = try fs.path.join(arena, &[_][]const u8{ lf.emit.directory.path orelse ".", lf.emit.sub_path, }); var argv = std.ArrayList([]const u8).init(gpa); defer argv.deinit(); if (test_exec_args.len == 0) { try argv.append(exe_path); } else { for (test_exec_args) |arg| { try argv.append(arg orelse exe_path); } } if (runtime_args_start) |i| { try argv.appendSlice(all_args[i..]); } var env_map = try process.getEnvMap(arena); try env_map.put("ZIG_EXE", self_exe_path); // We do not execve for tests because if the test fails we want to print // the error message and invocation below. if (process.can_execv and arg_mode == .run) { // execv releases the locks; no need to destroy the Compilation here. const err = process.execve(gpa, argv.items, &env_map); try warnAboutForeignBinaries(arena, arg_mode, target, link_libc); const cmd = try std.mem.join(arena, " ", argv.items); fatal("the following command failed to execve with '{s}':\n{s}", .{ @errorName(err), cmd }); } else if (process.can_spawn) { var child = std.ChildProcess.init(argv.items, gpa); child.env_map = &env_map; child.stdin_behavior = .Inherit; child.stdout_behavior = .Inherit; child.stderr_behavior = .Inherit; // Here we release all the locks associated with the Compilation so // that whatever this child process wants to do won't deadlock. comp.destroy(); comp_destroyed.* = true; const term = child.spawnAndWait() catch |err| { try warnAboutForeignBinaries(arena, arg_mode, target, link_libc); const cmd = try std.mem.join(arena, " ", argv.items); fatal("the following command failed with '{s}':\n{s}", .{ @errorName(err), cmd }); }; switch (arg_mode) { .run, .build => { switch (term) { .Exited => |code| { if (code == 0) { return cleanExit(); } else { process.exit(code); } }, else => { process.exit(1); }, } }, .zig_test => { switch (term) { .Exited => |code| { if (code == 0) { return cleanExit(); } else { const cmd = try std.mem.join(arena, " ", argv.items); fatal("the following test command failed with exit code {d}:\n{s}", .{ code, cmd }); } }, else => { const cmd = try std.mem.join(arena, " ", argv.items); fatal("the following test command crashed:\n{s}", .{cmd}); }, } }, else => unreachable, } } else { const cmd = try std.mem.join(arena, " ", argv.items); fatal("the following command cannot be executed ({s} does not support spawning a child process):\n{s}", .{ @tagName(builtin.os.tag), cmd }); } } fn runOrTestHotSwap( comp: *Compilation, gpa: Allocator, test_exec_args: []const ?[]const u8, self_exe_path: []const u8, arg_mode: ArgMode, all_args: []const []const u8, runtime_args_start: ?usize, ) !std.ChildProcess.Id { const lf = comp.bin_file.?; const exe_path = switch (builtin.target.os.tag) { // On Windows it seems impossible to perform an atomic rename of a file that is currently // running in a process. Therefore, we do the opposite. We create a copy of the file in // tmp zig-cache and use it to spawn the child process. This way we are free to update // the binary with each requested hot update. .windows => blk: { try lf.emit.directory.handle.copyFile(lf.emit.sub_path, comp.local_cache_directory.handle, lf.emit.sub_path, .{}); break :blk try fs.path.join(gpa, &[_][]const u8{ comp.local_cache_directory.path orelse ".", lf.emit.sub_path, }); }, // A naive `directory.join` here will indeed get the correct path to the binary, // however, in the case of cwd, we actually want `./foo` so that the path can be executed. else => try fs.path.join(gpa, &[_][]const u8{ lf.emit.directory.path orelse ".", lf.emit.sub_path, }), }; defer gpa.free(exe_path); var argv = std.ArrayList([]const u8).init(gpa); defer argv.deinit(); if (test_exec_args.len == 0) { // when testing pass the zig_exe_path to argv if (arg_mode == .zig_test) try argv.appendSlice(&[_][]const u8{ exe_path, self_exe_path, }) // when running just pass the current exe else try argv.appendSlice(&[_][]const u8{ exe_path, }); } else { for (test_exec_args) |arg| { if (arg) |a| { try argv.append(a); } else { try argv.appendSlice(&[_][]const u8{ exe_path, self_exe_path, }); } } } if (runtime_args_start) |i| { try argv.appendSlice(all_args[i..]); } switch (builtin.target.os.tag) { .macos, .ios, .tvos, .watchos => { const PosixSpawn = std.os.darwin.PosixSpawn; var attr = try PosixSpawn.Attr.init(); defer attr.deinit(); // ASLR is probably a good default for better debugging experience/programming // with hot-code updates in mind. However, we can also make it work with ASLR on. const flags: u16 = std.os.darwin.POSIX_SPAWN.SETSIGDEF | std.os.darwin.POSIX_SPAWN.SETSIGMASK | std.os.darwin.POSIX_SPAWN.DISABLE_ASLR; try attr.set(flags); var arena_allocator = std.heap.ArenaAllocator.init(gpa); defer arena_allocator.deinit(); const arena = arena_allocator.allocator(); const argv_buf = try arena.allocSentinel(?[*:0]u8, argv.items.len, null); for (argv.items, 0..) |arg, i| argv_buf[i] = (try arena.dupeZ(u8, arg)).ptr; const pid = try PosixSpawn.spawn(argv.items[0], null, attr, argv_buf, std.c.environ); return pid; }, else => { var child = std.ChildProcess.init(argv.items, gpa); child.stdin_behavior = .Inherit; child.stdout_behavior = .Inherit; child.stderr_behavior = .Inherit; try child.spawn(); return child.id; }, } } fn updateModule(comp: *Compilation, color: Color) !void { { // If the terminal is dumb, we dont want to show the user all the output. var progress: std.Progress = .{ .dont_print_on_dumb = true }; const main_progress_node = progress.start("", 0); defer main_progress_node.end(); switch (color) { .off => { progress.terminal = null; }, .on => { progress.terminal = std.io.getStdErr(); progress.supports_ansi_escape_codes = true; }, .auto => {}, } try comp.update(main_progress_node); } var errors = try comp.getAllErrorsAlloc(); defer errors.deinit(comp.gpa); if (errors.errorMessageCount() > 0) { errors.renderToStdErr(color.renderOptions()); return error.SemanticAnalyzeFail; } } fn cmdTranslateC(comp: *Compilation, arena: Allocator, fancy_output: ?*Compilation.CImportResult) !void { if (build_options.only_core_functionality) @panic("@translate-c is not available in a zig2.c build"); const color: Color = .auto; assert(comp.c_source_files.len == 1); const c_source_file = comp.c_source_files[0]; const translated_zig_basename = try std.fmt.allocPrint(arena, "{s}.zig", .{comp.root_name}); var man: Cache.Manifest = comp.obtainCObjectCacheManifest(comp.root_mod); man.want_shared_lock = false; defer man.deinit(); man.hash.add(@as(u16, 0xb945)); // Random number to distinguish translate-c from compiling C objects man.hash.add(comp.config.c_frontend); Compilation.cache_helpers.hashCSource(&man, c_source_file) catch |err| { fatal("unable to process '{s}': {s}", .{ c_source_file.src_path, @errorName(err) }); }; if (fancy_output) |p| p.cache_hit = true; const digest = if (try man.hit()) man.final() else digest: { if (fancy_output) |p| p.cache_hit = false; var argv = std.ArrayList([]const u8).init(arena); switch (comp.config.c_frontend) { .aro => {}, .clang => { // argv[0] is program name, actual args start at [1] try argv.append(@tagName(comp.config.c_frontend)); }, } var zig_cache_tmp_dir = try comp.local_cache_directory.handle.makeOpenPath("tmp", .{}); defer zig_cache_tmp_dir.close(); const ext = Compilation.classifyFileExt(c_source_file.src_path); const out_dep_path: ?[]const u8 = blk: { if (comp.config.c_frontend == .aro or comp.disable_c_depfile or !ext.clangSupportsDepFile()) break :blk null; const c_src_basename = fs.path.basename(c_source_file.src_path); const dep_basename = try std.fmt.allocPrint(arena, "{s}.d", .{c_src_basename}); const out_dep_path = try comp.tmpFilePath(arena, dep_basename); break :blk out_dep_path; }; // TODO if (comp.config.c_frontend != .aro) try comp.addTranslateCCArgs(arena, &argv, ext, out_dep_path, comp.root_mod); try argv.append(c_source_file.src_path); if (comp.verbose_cc) { Compilation.dump_argv(argv.items); } const formatted = switch (comp.config.c_frontend) { .aro => f: { var stdout: []u8 = undefined; try jitCmd(comp.gpa, arena, argv.items, .{ .cmd_name = "aro_translate_c", .root_src_path = "aro_translate_c.zig", .depend_on_aro = true, .capture = &stdout, }); break :f stdout; }, .clang => f: { if (!build_options.have_llvm) unreachable; const translate_c = @import("translate_c.zig"); // Convert to null terminated args. const clang_args_len = argv.items.len + c_source_file.extra_flags.len; const new_argv_with_sentinel = try arena.alloc(?[*:0]const u8, clang_args_len + 1); new_argv_with_sentinel[clang_args_len] = null; const new_argv = new_argv_with_sentinel[0..clang_args_len :null]; for (argv.items, 0..) |arg, i| { new_argv[i] = try arena.dupeZ(u8, arg); } for (c_source_file.extra_flags, 0..) |arg, i| { new_argv[argv.items.len + i] = try arena.dupeZ(u8, arg); } const c_headers_dir_path_z = try comp.zig_lib_directory.joinZ(arena, &[_][]const u8{"include"}); var errors = std.zig.ErrorBundle.empty; var tree = translate_c.translate( comp.gpa, new_argv.ptr, new_argv.ptr + new_argv.len, &errors, c_headers_dir_path_z, ) catch |err| switch (err) { error.OutOfMemory => return error.OutOfMemory, error.SemanticAnalyzeFail => { if (fancy_output) |p| { p.errors = errors; return; } else { errors.renderToStdErr(color.renderOptions()); process.exit(1); } }, }; defer tree.deinit(comp.gpa); break :f try tree.render(arena); }, }; if (out_dep_path) |dep_file_path| { const dep_basename = fs.path.basename(dep_file_path); // Add the files depended on to the cache system. try man.addDepFilePost(zig_cache_tmp_dir, dep_basename); // Just to save disk space, we delete the file because it is never needed again. zig_cache_tmp_dir.deleteFile(dep_basename) catch |err| { warn("failed to delete '{s}': {s}", .{ dep_file_path, @errorName(err) }); }; } const digest = man.final(); const o_sub_path = try fs.path.join(arena, &[_][]const u8{ "o", &digest }); var o_dir = try comp.local_cache_directory.handle.makeOpenPath(o_sub_path, .{}); defer o_dir.close(); var zig_file = try o_dir.createFile(translated_zig_basename, .{}); defer zig_file.close(); try zig_file.writeAll(formatted); man.writeManifest() catch |err| warn("failed to write cache manifest: {s}", .{ @errorName(err), }); break :digest digest; }; if (fancy_output) |p| { p.out_zig_path = try comp.local_cache_directory.join(comp.gpa, &[_][]const u8{ "o", &digest, translated_zig_basename, }); p.errors = std.zig.ErrorBundle.empty; } else { const out_zig_path = try fs.path.join(arena, &[_][]const u8{ "o", &digest, translated_zig_basename }); const zig_file = comp.local_cache_directory.handle.openFile(out_zig_path, .{}) catch |err| { const path = comp.local_cache_directory.path orelse "."; fatal("unable to open cached translated zig file '{s}{s}{s}': {s}", .{ path, fs.path.sep_str, out_zig_path, @errorName(err) }); }; defer zig_file.close(); try io.getStdOut().writeFileAll(zig_file, .{}); return cleanExit(); } } fn cmdRc(gpa: Allocator, arena: Allocator, args: []const []const u8) !void { const resinator = @import("resinator.zig"); const stderr = std.io.getStdErr(); const stderr_config = std.io.tty.detectConfig(stderr); var options = options: { var cli_diagnostics = resinator.cli.Diagnostics.init(gpa); defer cli_diagnostics.deinit(); var options = resinator.cli.parse(gpa, args, &cli_diagnostics) catch |err| switch (err) { error.ParseError => { cli_diagnostics.renderToStdErr(args, stderr_config); process.exit(1); }, else => |e| return e, }; try options.maybeAppendRC(std.fs.cwd()); // print any warnings/notes cli_diagnostics.renderToStdErr(args, stderr_config); // If there was something printed, then add an extra newline separator // so that there is a clear separation between the cli diagnostics and whatever // gets printed after if (cli_diagnostics.errors.items.len > 0) { std.debug.print("\n", .{}); } break :options options; }; defer options.deinit(); if (options.print_help_and_exit) { try resinator.cli.writeUsage(stderr.writer(), "zig rc"); return; } const stdout_writer = std.io.getStdOut().writer(); if (options.verbose) { try options.dumpVerbose(stdout_writer); try stdout_writer.writeByte('\n'); } const full_input = full_input: { if (options.preprocess != .no) { if (!build_options.have_llvm) { fatal("clang not available: compiler built without LLVM extensions", .{}); } var argv = std.ArrayList([]const u8).init(gpa); defer argv.deinit(); const self_exe_path = try introspect.findZigExePath(arena); var zig_lib_directory = introspect.findZigLibDirFromSelfExe(arena, self_exe_path) catch |err| { try resinator.utils.renderErrorMessage(stderr.writer(), stderr_config, .err, "unable to find zig installation directory: {s}", .{@errorName(err)}); process.exit(1); }; defer zig_lib_directory.handle.close(); const include_args = detectRcIncludeDirs(arena, zig_lib_directory.path.?, options.auto_includes) catch |err| { try resinator.utils.renderErrorMessage(stderr.writer(), stderr_config, .err, "unable to detect system include directories: {s}", .{@errorName(err)}); process.exit(1); }; try argv.appendSlice(&[_][]const u8{ self_exe_path, "clang" }); const clang_target = clang_target: { if (include_args.target_abi) |abi| { break :clang_target try std.fmt.allocPrint(arena, "x86_64-unknown-windows-{s}", .{abi}); } break :clang_target "x86_64-unknown-windows"; }; try resinator.preprocess.appendClangArgs(arena, &argv, options, .{ .clang_target = clang_target, .system_include_paths = include_args.include_paths, .needs_gnu_workaround = if (include_args.target_abi) |abi| std.mem.eql(u8, abi, "gnu") else false, .nostdinc = true, }); try argv.append(options.input_filename); if (options.verbose) { try stdout_writer.writeAll("Preprocessor: zig clang\n"); for (argv.items[0 .. argv.items.len - 1]) |arg| { try stdout_writer.print("{s} ", .{arg}); } try stdout_writer.print("{s}\n\n", .{argv.items[argv.items.len - 1]}); } if (process.can_spawn) { const result = std.ChildProcess.run(.{ .allocator = gpa, .argv = argv.items, .max_output_bytes = std.math.maxInt(u32), }) catch |err| { try resinator.utils.renderErrorMessage(stderr.writer(), stderr_config, .err, "unable to spawn preprocessor child process: {s}", .{@errorName(err)}); process.exit(1); }; errdefer gpa.free(result.stdout); defer gpa.free(result.stderr); switch (result.term) { .Exited => |code| { if (code != 0) { try resinator.utils.renderErrorMessage(stderr.writer(), stderr_config, .err, "the preprocessor failed with exit code {}:", .{code}); try stderr.writeAll(result.stderr); try stderr.writeAll("\n"); process.exit(1); } }, .Signal, .Stopped, .Unknown => { try resinator.utils.renderErrorMessage(stderr.writer(), stderr_config, .err, "the preprocessor terminated unexpectedly ({s}):", .{@tagName(result.term)}); try stderr.writeAll(result.stderr); try stderr.writeAll("\n"); process.exit(1); }, } break :full_input result.stdout; } else { // need to use an intermediate file const rand_int = std.crypto.random.int(u64); const preprocessed_path = try std.fmt.allocPrint(gpa, "resinator{x}.rcpp", .{rand_int}); defer gpa.free(preprocessed_path); defer std.fs.cwd().deleteFile(preprocessed_path) catch {}; try argv.appendSlice(&.{ "-o", preprocessed_path }); const exit_code = try clangMain(arena, argv.items); if (exit_code != 0) { try resinator.utils.renderErrorMessage(stderr.writer(), stderr_config, .err, "the preprocessor failed with exit code {}:", .{exit_code}); process.exit(1); } break :full_input std.fs.cwd().readFileAlloc(gpa, preprocessed_path, std.math.maxInt(usize)) catch |err| { try resinator.utils.renderErrorMessage(stderr.writer(), stderr_config, .err, "unable to read preprocessed file path '{s}': {s}", .{ preprocessed_path, @errorName(err) }); process.exit(1); }; } } else { break :full_input std.fs.cwd().readFileAlloc(gpa, options.input_filename, std.math.maxInt(usize)) catch |err| { try resinator.utils.renderErrorMessage(stderr.writer(), stderr_config, .err, "unable to read input file path '{s}': {s}", .{ options.input_filename, @errorName(err) }); process.exit(1); }; } }; defer gpa.free(full_input); if (options.preprocess == .only) { std.fs.cwd().writeFile(options.output_filename, full_input) catch |err| { try resinator.utils.renderErrorMessage(stderr.writer(), stderr_config, .err, "unable to write output file '{s}': {s}", .{ options.output_filename, @errorName(err) }); process.exit(1); }; return cleanExit(); } var mapping_results = try resinator.source_mapping.parseAndRemoveLineCommands(gpa, full_input, full_input, .{ .initial_filename = options.input_filename }); defer mapping_results.mappings.deinit(gpa); const final_input = resinator.comments.removeComments(mapping_results.result, mapping_results.result, &mapping_results.mappings); var output_file = std.fs.cwd().createFile(options.output_filename, .{}) catch |err| { try resinator.utils.renderErrorMessage(stderr.writer(), stderr_config, .err, "unable to create output file '{s}': {s}", .{ options.output_filename, @errorName(err) }); process.exit(1); }; var output_file_closed = false; defer if (!output_file_closed) output_file.close(); var diagnostics = resinator.errors.Diagnostics.init(gpa); defer diagnostics.deinit(); var output_buffered_stream = std.io.bufferedWriter(output_file.writer()); resinator.compile.compile(gpa, final_input, output_buffered_stream.writer(), .{ .cwd = std.fs.cwd(), .diagnostics = &diagnostics, .source_mappings = &mapping_results.mappings, .dependencies_list = null, .ignore_include_env_var = options.ignore_include_env_var, .extra_include_paths = options.extra_include_paths.items, .default_language_id = options.default_language_id, .default_code_page = options.default_code_page orelse .windows1252, .verbose = options.verbose, .null_terminate_string_table_strings = options.null_terminate_string_table_strings, .max_string_literal_codepoints = options.max_string_literal_codepoints, .silent_duplicate_control_ids = options.silent_duplicate_control_ids, .warn_instead_of_error_on_invalid_code_page = options.warn_instead_of_error_on_invalid_code_page, }) catch |err| switch (err) { error.ParseError, error.CompileError => { diagnostics.renderToStdErr(std.fs.cwd(), final_input, stderr_config, mapping_results.mappings); // Delete the output file on error output_file.close(); output_file_closed = true; // Failing to delete is not really a big deal, so swallow any errors std.fs.cwd().deleteFile(options.output_filename) catch {}; process.exit(1); }, else => |e| return e, }; try output_buffered_stream.flush(); // print any warnings/notes diagnostics.renderToStdErr(std.fs.cwd(), final_input, stderr_config, mapping_results.mappings); return cleanExit(); } const RcIncludeArgs = struct { include_paths: []const []const u8 = &.{}, target_abi: ?[]const u8 = null, }; fn detectRcIncludeDirs(arena: Allocator, zig_lib_dir: []const u8, auto_includes: @import("resinator.zig").cli.Options.AutoIncludes) !RcIncludeArgs { if (auto_includes == .none) return .{}; var cur_includes = auto_includes; if (builtin.target.os.tag != .windows) { switch (cur_includes) { // MSVC can't be found when the host isn't Windows, so short-circuit. .msvc => return error.WindowsSdkNotFound, // Skip straight to gnu since we won't be able to detect MSVC on non-Windows hosts. .any => cur_includes = .gnu, .gnu => {}, .none => unreachable, } } while (true) { switch (cur_includes) { .any, .msvc => { const target_query: std.Target.Query = .{ .os_tag = .windows, .abi = .msvc, }; const target = std.zig.resolveTargetQueryOrFatal(target_query); const is_native_abi = target_query.isNativeAbi(); const detected_libc = std.zig.LibCDirs.detect(arena, zig_lib_dir, target, is_native_abi, true, null) catch |err| { if (cur_includes == .any) { // fall back to mingw cur_includes = .gnu; continue; } return err; }; if (detected_libc.libc_include_dir_list.len == 0) { if (cur_includes == .any) { // fall back to mingw cur_includes = .gnu; continue; } return error.WindowsSdkNotFound; } return .{ .include_paths = detected_libc.libc_include_dir_list, .target_abi = "msvc", }; }, .gnu => { const target_query: std.Target.Query = .{ .os_tag = .windows, .abi = .gnu, }; const target = std.zig.resolveTargetQueryOrFatal(target_query); const is_native_abi = target_query.isNativeAbi(); const detected_libc = try std.zig.LibCDirs.detect(arena, zig_lib_dir, target, is_native_abi, true, null); return .{ .include_paths = detected_libc.libc_include_dir_list, .target_abi = "gnu", }; }, .none => unreachable, } } } const usage_init = \\Usage: zig init \\ \\ Initializes a `zig build` project in the current working \\ directory. \\ \\Options: \\ -h, --help Print this help and exit \\ \\ ; fn cmdInit(gpa: Allocator, arena: Allocator, args: []const []const u8) !void { { var i: usize = 0; while (i < args.len) : (i += 1) { const arg = args[i]; if (mem.startsWith(u8, arg, "-")) { if (mem.eql(u8, arg, "-h") or mem.eql(u8, arg, "--help")) { try io.getStdOut().writeAll(usage_init); return cleanExit(); } else { fatal("unrecognized parameter: '{s}'", .{arg}); } } else { fatal("unexpected extra parameter: '{s}'", .{arg}); } } } var templates = findTemplates(gpa, arena); defer templates.deinit(); const cwd_path = try process.getCwdAlloc(arena); const cwd_basename = fs.path.basename(cwd_path); const s = fs.path.sep_str; const template_paths = [_][]const u8{ Package.build_zig_basename, Package.Manifest.basename, "src" ++ s ++ "main.zig", "src" ++ s ++ "root.zig", }; var ok_count: usize = 0; for (template_paths) |template_path| { if (templates.write(arena, fs.cwd(), cwd_basename, template_path)) |_| { std.log.info("created {s}", .{template_path}); ok_count += 1; } else |err| switch (err) { error.PathAlreadyExists => std.log.info("preserving already existing file: {s}", .{ template_path, }), else => std.log.err("unable to write {s}: {s}\n", .{ template_path, @errorName(err) }), } } if (ok_count == template_paths.len) { std.log.info("see `zig build --help` for a menu of options", .{}); } return cleanExit(); } const usage_build = \\Usage: zig build [steps] [options] \\ \\ Build a project from build.zig. \\ \\Options: \\ -freference-trace[=num] How many lines of reference trace should be shown per compile error \\ -fno-reference-trace Disable reference trace \\ --summary [mode] Control the printing of the build summary \\ all Print the build summary in its entirety \\ failures (Default) Only print failed steps \\ none Do not print the build summary \\ --build-file [file] Override path to build.zig \\ --cache-dir [path] Override path to local Zig cache directory \\ --global-cache-dir [path] Override path to global Zig cache directory \\ --zig-lib-dir [arg] Override path to Zig lib directory \\ --build-runner [file] Override path to build runner \\ --prominent-compile-errors Buffer compile errors and display at end \\ --seed [integer] For shuffling dependency traversal order (default: random) \\ --fetch Exit after fetching dependency tree \\ -h, --help Print this help and exit \\ ; fn cmdBuild(gpa: Allocator, arena: Allocator, args: []const []const u8) !void { var progress: std.Progress = .{ .dont_print_on_dumb = true }; var build_file: ?[]const u8 = null; var override_lib_dir: ?[]const u8 = try EnvVar.ZIG_LIB_DIR.get(arena); var override_global_cache_dir: ?[]const u8 = try EnvVar.ZIG_GLOBAL_CACHE_DIR.get(arena); var override_local_cache_dir: ?[]const u8 = try EnvVar.ZIG_LOCAL_CACHE_DIR.get(arena); var override_build_runner: ?[]const u8 = try EnvVar.ZIG_BUILD_RUNNER.get(arena); var child_argv = std.ArrayList([]const u8).init(arena); var reference_trace: ?u32 = null; var debug_compile_errors = false; var verbose_link = (builtin.os.tag != .wasi or builtin.link_libc) and EnvVar.ZIG_VERBOSE_LINK.isSet(); var verbose_cc = (builtin.os.tag != .wasi or builtin.link_libc) and EnvVar.ZIG_VERBOSE_CC.isSet(); var verbose_air = false; var verbose_intern_pool = false; var verbose_generic_instances = false; var verbose_llvm_ir: ?[]const u8 = null; var verbose_llvm_bc: ?[]const u8 = null; var verbose_cimport = false; var verbose_llvm_cpu_features = false; var fetch_only = false; var system_pkg_dir_path: ?[]const u8 = null; const argv_index_exe = child_argv.items.len; _ = try child_argv.addOne(); const self_exe_path = try introspect.findZigExePath(arena); try child_argv.append(self_exe_path); const argv_index_build_file = child_argv.items.len; _ = try child_argv.addOne(); const argv_index_cache_dir = child_argv.items.len; _ = try child_argv.addOne(); const argv_index_global_cache_dir = child_argv.items.len; _ = try child_argv.addOne(); try child_argv.appendSlice(&.{ "--seed", try std.fmt.allocPrint(arena, "0x{x}", .{std.crypto.random.int(u32)}), }); const argv_index_seed = child_argv.items.len - 1; // This parent process needs a way to obtain results from the configuration // phase of the child process. In the future, the make phase will be // executed in a separate process than the configure phase, and we can then // use stdout from the configuration phase for this purpose. // // However, currently, both phases are in the same process, and Run Step // provides API for making the runned subprocesses inherit stdout and stderr // which means these streams are not available for passing metadata back // to the parent. // // Until make and configure phases are separated into different processes, // the strategy is to choose a temporary file name ahead of time, and then // read this file in the parent to obtain the results, in the case the child // exits with code 3. const results_tmp_file_nonce = Package.Manifest.hex64(std.crypto.random.int(u64)); try child_argv.append("-Z" ++ results_tmp_file_nonce); { var i: usize = 0; while (i < args.len) : (i += 1) { const arg = args[i]; if (mem.startsWith(u8, arg, "-")) { if (mem.eql(u8, arg, "--build-file")) { if (i + 1 >= args.len) fatal("expected argument after '{s}'", .{arg}); i += 1; build_file = args[i]; continue; } else if (mem.eql(u8, arg, "--zig-lib-dir")) { if (i + 1 >= args.len) fatal("expected argument after '{s}'", .{arg}); i += 1; override_lib_dir = args[i]; try child_argv.appendSlice(&.{ arg, args[i] }); continue; } else if (mem.eql(u8, arg, "--build-runner")) { if (i + 1 >= args.len) fatal("expected argument after '{s}'", .{arg}); i += 1; override_build_runner = args[i]; continue; } else if (mem.eql(u8, arg, "--cache-dir")) { if (i + 1 >= args.len) fatal("expected argument after '{s}'", .{arg}); i += 1; override_local_cache_dir = args[i]; continue; } else if (mem.eql(u8, arg, "--global-cache-dir")) { if (i + 1 >= args.len) fatal("expected argument after '{s}'", .{arg}); i += 1; override_global_cache_dir = args[i]; continue; } else if (mem.eql(u8, arg, "-freference-trace")) { reference_trace = 256; } else if (mem.eql(u8, arg, "--fetch")) { fetch_only = true; } else if (mem.eql(u8, arg, "--system")) { if (i + 1 >= args.len) fatal("expected argument after '{s}'", .{arg}); i += 1; system_pkg_dir_path = args[i]; try child_argv.append("--system"); continue; } else if (mem.startsWith(u8, arg, "-freference-trace=")) { const num = arg["-freference-trace=".len..]; reference_trace = std.fmt.parseUnsigned(u32, num, 10) catch |err| { fatal("unable to parse reference_trace count '{s}': {s}", .{ num, @errorName(err) }); }; } else if (mem.eql(u8, arg, "-fno-reference-trace")) { reference_trace = null; } else if (mem.eql(u8, arg, "--debug-log")) { if (i + 1 >= args.len) fatal("expected argument after '{s}'", .{arg}); try child_argv.appendSlice(args[i .. i + 2]); i += 1; if (!build_options.enable_logging) { warn("Zig was compiled without logging enabled (-Dlog). --debug-log has no effect.", .{}); } else { try log_scopes.append(arena, args[i]); } continue; } else if (mem.eql(u8, arg, "--debug-compile-errors")) { if (!crash_report.is_enabled) { warn("Zig was compiled in a release mode. --debug-compile-errors has no effect.", .{}); } else { debug_compile_errors = true; } } else if (mem.eql(u8, arg, "--verbose-link")) { verbose_link = true; } else if (mem.eql(u8, arg, "--verbose-cc")) { verbose_cc = true; } else if (mem.eql(u8, arg, "--verbose-air")) { verbose_air = true; } else if (mem.eql(u8, arg, "--verbose-intern-pool")) { verbose_intern_pool = true; } else if (mem.eql(u8, arg, "--verbose-generic-instances")) { verbose_generic_instances = true; } else if (mem.eql(u8, arg, "--verbose-llvm-ir")) { verbose_llvm_ir = "-"; } else if (mem.startsWith(u8, arg, "--verbose-llvm-ir=")) { verbose_llvm_ir = arg["--verbose-llvm-ir=".len..]; } else if (mem.startsWith(u8, arg, "--verbose-llvm-bc=")) { verbose_llvm_bc = arg["--verbose-llvm-bc=".len..]; } else if (mem.eql(u8, arg, "--verbose-cimport")) { verbose_cimport = true; } else if (mem.eql(u8, arg, "--verbose-llvm-cpu-features")) { verbose_llvm_cpu_features = true; } else if (mem.eql(u8, arg, "--seed")) { if (i + 1 >= args.len) fatal("expected argument after '{s}'", .{arg}); i += 1; child_argv.items[argv_index_seed] = args[i]; continue; } } try child_argv.append(arg); } } const work_around_btrfs_bug = builtin.os.tag == .linux and EnvVar.ZIG_BTRFS_WORKAROUND.isSet(); const color: Color = .auto; const target_query: std.Target.Query = .{}; const resolved_target: Package.Module.ResolvedTarget = .{ .result = std.zig.resolveTargetQueryOrFatal(target_query), .is_native_os = true, .is_native_abi = true, }; const exe_basename = try std.zig.binNameAlloc(arena, .{ .root_name = "build", .target = resolved_target.result, .output_mode = .Exe, }); const emit_bin: Compilation.EmitLoc = .{ .directory = null, // Use the local zig-cache. .basename = exe_basename, }; gimmeMoreOfThoseSweetSweetFileDescriptors(); var zig_lib_directory: Compilation.Directory = if (override_lib_dir) |lib_dir| .{ .path = lib_dir, .handle = fs.cwd().openDir(lib_dir, .{}) catch |err| { fatal("unable to open zig lib directory from 'zig-lib-dir' argument: '{s}': {s}", .{ lib_dir, @errorName(err) }); }, } else introspect.findZigLibDirFromSelfExe(arena, self_exe_path) catch |err| { fatal("unable to find zig installation directory '{s}': {s}", .{ self_exe_path, @errorName(err) }); }; defer zig_lib_directory.handle.close(); const cwd_path = try process.getCwdAlloc(arena); const build_root = try findBuildRoot(arena, .{ .cwd_path = cwd_path, .build_file = build_file, }); child_argv.items[argv_index_build_file] = build_root.directory.path orelse cwd_path; var global_cache_directory: Compilation.Directory = l: { const p = override_global_cache_dir orelse try introspect.resolveGlobalCacheDir(arena); break :l .{ .handle = try fs.cwd().makeOpenPath(p, .{}), .path = p, }; }; defer global_cache_directory.handle.close(); child_argv.items[argv_index_global_cache_dir] = global_cache_directory.path orelse cwd_path; var local_cache_directory: Compilation.Directory = l: { if (override_local_cache_dir) |local_cache_dir_path| { break :l .{ .handle = try fs.cwd().makeOpenPath(local_cache_dir_path, .{}), .path = local_cache_dir_path, }; } const cache_dir_path = try build_root.directory.join(arena, &[_][]const u8{"zig-cache"}); break :l .{ .handle = try build_root.directory.handle.makeOpenPath("zig-cache", .{}), .path = cache_dir_path, }; }; defer local_cache_directory.handle.close(); child_argv.items[argv_index_cache_dir] = local_cache_directory.path orelse cwd_path; var thread_pool: ThreadPool = undefined; try thread_pool.init(.{ .allocator = gpa }); defer thread_pool.deinit(); // Dummy http client that is not actually used when only_core_functionality is enabled. // Prevents bootstrap from depending on a bunch of unnecessary stuff. const HttpClient = if (build_options.only_core_functionality) struct { allocator: Allocator, fn deinit(self: *@This()) void { _ = self; } } else std.http.Client; var http_client: HttpClient = .{ .allocator = gpa }; defer http_client.deinit(); var unlazy_set: Package.Fetch.JobQueue.UnlazySet = .{}; // This loop is re-evaluated when the build script exits with an indication that it // could not continue due to missing lazy dependencies. while (true) { // We want to release all the locks before executing the child process, so we make a nice // big block here to ensure the cleanup gets run when we extract out our argv. { const main_mod_paths: Package.Module.CreateOptions.Paths = if (override_build_runner) |runner| .{ .root = .{ .root_dir = Cache.Directory.cwd(), .sub_path = fs.path.dirname(runner) orelse "", }, .root_src_path = fs.path.basename(runner), } else .{ .root = .{ .root_dir = zig_lib_directory, }, .root_src_path = "build_runner.zig", }; const config = try Compilation.Config.resolve(.{ .output_mode = .Exe, .resolved_target = resolved_target, .have_zcu = true, .emit_bin = true, .is_test = false, }); const root_mod = try Package.Module.create(arena, .{ .global_cache_directory = global_cache_directory, .paths = main_mod_paths, .fully_qualified_name = "root", .cc_argv = &.{}, .inherited = .{ .resolved_target = resolved_target, }, .global = config, .parent = null, .builtin_mod = null, }); const builtin_mod = root_mod.getBuiltinDependency(); const build_mod = try Package.Module.create(arena, .{ .global_cache_directory = global_cache_directory, .paths = .{ .root = .{ .root_dir = build_root.directory }, .root_src_path = build_root.build_zig_basename, }, .fully_qualified_name = "root.@build", .cc_argv = &.{}, .inherited = .{}, .global = config, .parent = root_mod, .builtin_mod = builtin_mod, }); var cleanup_build_dir: ?fs.Dir = null; defer if (cleanup_build_dir) |*dir| dir.close(); if (build_options.only_core_functionality) { try createEmptyDependenciesModule( arena, root_mod, global_cache_directory, local_cache_directory, builtin_mod, config, ); } else { const root_prog_node = progress.start("Fetch Packages", 0); defer root_prog_node.end(); var job_queue: Package.Fetch.JobQueue = .{ .http_client = &http_client, .thread_pool = &thread_pool, .global_cache = global_cache_directory, .read_only = false, .recursive = true, .debug_hash = false, .work_around_btrfs_bug = work_around_btrfs_bug, .unlazy_set = unlazy_set, }; defer job_queue.deinit(); if (system_pkg_dir_path) |p| { job_queue.global_cache = .{ .path = p, .handle = fs.cwd().openDir(p, .{}) catch |err| { fatal("unable to open system package directory '{s}': {s}", .{ p, @errorName(err), }); }, }; job_queue.read_only = true; cleanup_build_dir = job_queue.global_cache.handle; } else { try http_client.initDefaultProxies(arena); } try job_queue.all_fetches.ensureUnusedCapacity(gpa, 1); try job_queue.table.ensureUnusedCapacity(gpa, 1); var fetch: Package.Fetch = .{ .arena = std.heap.ArenaAllocator.init(gpa), .location = .{ .relative_path = build_mod.root }, .location_tok = 0, .hash_tok = 0, .name_tok = 0, .lazy_status = .eager, .parent_package_root = build_mod.root, .parent_manifest_ast = null, .prog_node = root_prog_node, .job_queue = &job_queue, .omit_missing_hash_error = true, .allow_missing_paths_field = false, .package_root = undefined, .error_bundle = undefined, .manifest = null, .manifest_ast = undefined, .actual_hash = undefined, .has_build_zig = true, .oom_flag = false, .module = build_mod, }; job_queue.all_fetches.appendAssumeCapacity(&fetch); job_queue.table.putAssumeCapacityNoClobber( Package.Fetch.relativePathDigest(build_mod.root, global_cache_directory), &fetch, ); job_queue.wait_group.start(); try job_queue.thread_pool.spawn(Package.Fetch.workerRun, .{ &fetch, "root" }); job_queue.wait_group.wait(); try job_queue.consolidateErrors(); if (fetch.error_bundle.root_list.items.len > 0) { var errors = try fetch.error_bundle.toOwnedBundle(""); errors.renderToStdErr(color.renderOptions()); process.exit(1); } if (fetch_only) return cleanExit(); var source_buf = std.ArrayList(u8).init(gpa); defer source_buf.deinit(); try job_queue.createDependenciesSource(&source_buf); const deps_mod = try createDependenciesModule( arena, source_buf.items, root_mod, global_cache_directory, local_cache_directory, builtin_mod, config, ); { // We need a Module for each package's build.zig. const hashes = job_queue.table.keys(); const fetches = job_queue.table.values(); try deps_mod.deps.ensureUnusedCapacity(arena, @intCast(hashes.len)); for (hashes, fetches) |hash, f| { if (f == &fetch) { // The first one is a dummy package for the current project. continue; } if (!f.has_build_zig) continue; const m = try Package.Module.create(arena, .{ .global_cache_directory = global_cache_directory, .paths = .{ .root = try f.package_root.clone(arena), .root_src_path = Package.build_zig_basename, }, .fully_qualified_name = try std.fmt.allocPrint( arena, "root.@dependencies.{s}", .{&hash}, ), .cc_argv = &.{}, .inherited = .{}, .global = config, .parent = root_mod, .builtin_mod = builtin_mod, }); const hash_cloned = try arena.dupe(u8, &hash); deps_mod.deps.putAssumeCapacityNoClobber(hash_cloned, m); f.module = m; } // Each build.zig module needs access to each of its // dependencies' build.zig modules by name. for (fetches) |f| { const mod = f.module orelse continue; const man = f.manifest orelse continue; const dep_names = man.dependencies.keys(); try mod.deps.ensureUnusedCapacity(arena, @intCast(dep_names.len)); for (dep_names, man.dependencies.values()) |name, dep| { const dep_digest = Package.Fetch.depDigest( f.package_root, global_cache_directory, dep, ) orelse continue; const dep_mod = job_queue.table.get(dep_digest).?.module orelse continue; const name_cloned = try arena.dupe(u8, name); mod.deps.putAssumeCapacityNoClobber(name_cloned, dep_mod); } } } } try root_mod.deps.put(arena, "@build", build_mod); const comp = Compilation.create(gpa, arena, .{ .zig_lib_directory = zig_lib_directory, .local_cache_directory = local_cache_directory, .global_cache_directory = global_cache_directory, .root_name = "build", .config = config, .root_mod = root_mod, .main_mod = build_mod, .emit_bin = emit_bin, .emit_h = null, .self_exe_path = self_exe_path, .thread_pool = &thread_pool, .verbose_cc = verbose_cc, .verbose_link = verbose_link, .verbose_air = verbose_air, .verbose_intern_pool = verbose_intern_pool, .verbose_generic_instances = verbose_generic_instances, .verbose_llvm_ir = verbose_llvm_ir, .verbose_llvm_bc = verbose_llvm_bc, .verbose_cimport = verbose_cimport, .verbose_llvm_cpu_features = verbose_llvm_cpu_features, .cache_mode = .whole, .reference_trace = reference_trace, .debug_compile_errors = debug_compile_errors, }) catch |err| { fatal("unable to create compilation: {s}", .{@errorName(err)}); }; defer comp.destroy(); updateModule(comp, color) catch |err| switch (err) { error.SemanticAnalyzeFail => process.exit(2), else => |e| return e, }; // Since incremental compilation isn't done yet, we use cache_mode = whole // above, and thus the output file is already closed. //try comp.makeBinFileExecutable(); child_argv.items[argv_index_exe] = try local_cache_directory.join(arena, &.{comp.cache_use.whole.bin_sub_path.?}); } if (process.can_spawn) { var child = std.ChildProcess.init(child_argv.items, gpa); child.stdin_behavior = .Inherit; child.stdout_behavior = .Inherit; child.stderr_behavior = .Inherit; const term = try child.spawnAndWait(); switch (term) { .Exited => |code| { if (code == 0) return cleanExit(); // Indicates that the build runner has reported compile errors // and this parent process does not need to report any further // diagnostics. if (code == 2) process.exit(2); if (code == 3) { if (build_options.only_core_functionality) process.exit(3); // Indicates the configure phase failed due to missing lazy // dependencies and stdout contains the hashes of the ones // that are missing. const s = fs.path.sep_str; const tmp_sub_path = "tmp" ++ s ++ results_tmp_file_nonce; const stdout = local_cache_directory.handle.readFileAlloc(arena, tmp_sub_path, 50 * 1024 * 1024) catch |err| { fatal("unable to read results of configure phase from '{}{s}': {s}", .{ local_cache_directory, tmp_sub_path, @errorName(err), }); }; local_cache_directory.handle.deleteFile(tmp_sub_path) catch {}; var it = mem.splitScalar(u8, stdout, '\n'); var any_errors = false; while (it.next()) |hash| { if (hash.len == 0) continue; const digest_len = @typeInfo(Package.Manifest.MultiHashHexDigest).Array.len; if (hash.len != digest_len) { std.log.err("invalid digest (length {d} instead of {d}): '{s}'", .{ hash.len, digest_len, hash, }); any_errors = true; continue; } try unlazy_set.put(arena, hash[0..digest_len].*, {}); } if (any_errors) process.exit(3); if (system_pkg_dir_path) |p| { // In this mode, the system needs to provide these packages; they // cannot be fetched by Zig. for (unlazy_set.keys()) |hash| { std.log.err("lazy dependency package not found: {s}" ++ s ++ "{s}", .{ p, hash, }); } std.log.info("remote package fetching disabled due to --system mode", .{}); std.log.info("dependencies might be avoidable depending on build configuration", .{}); process.exit(3); } continue; } const cmd = try std.mem.join(arena, " ", child_argv.items); fatal("the following build command failed with exit code {d}:\n{s}", .{ code, cmd }); }, else => { const cmd = try std.mem.join(arena, " ", child_argv.items); fatal("the following build command crashed:\n{s}", .{cmd}); }, } } else { const cmd = try std.mem.join(arena, " ", child_argv.items); fatal("the following command cannot be executed ({s} does not support spawning a child process):\n{s}", .{ @tagName(builtin.os.tag), cmd }); } } } const JitCmdOptions = struct { cmd_name: []const u8, root_src_path: []const u8, prepend_zig_lib_dir_path: bool = false, depend_on_aro: bool = false, capture: ?*[]u8 = null, }; fn jitCmd( gpa: Allocator, arena: Allocator, args: []const []const u8, options: JitCmdOptions, ) !void { const color: Color = .auto; const target_query: std.Target.Query = .{}; const resolved_target: Package.Module.ResolvedTarget = .{ .result = std.zig.resolveTargetQueryOrFatal(target_query), .is_native_os = true, .is_native_abi = true, }; const exe_basename = try std.zig.binNameAlloc(arena, .{ .root_name = options.cmd_name, .target = resolved_target.result, .output_mode = .Exe, }); const emit_bin: Compilation.EmitLoc = .{ .directory = null, // Use the global zig-cache. .basename = exe_basename, }; const self_exe_path = introspect.findZigExePath(arena) catch |err| { fatal("unable to find self exe path: {s}", .{@errorName(err)}); }; const optimize_mode: std.builtin.OptimizeMode = if (EnvVar.ZIG_DEBUG_CMD.isSet()) .Debug else .ReleaseFast; const strip = optimize_mode != .Debug; const override_lib_dir: ?[]const u8 = try EnvVar.ZIG_LIB_DIR.get(arena); const override_global_cache_dir: ?[]const u8 = try EnvVar.ZIG_GLOBAL_CACHE_DIR.get(arena); var zig_lib_directory: Compilation.Directory = if (override_lib_dir) |lib_dir| .{ .path = lib_dir, .handle = fs.cwd().openDir(lib_dir, .{}) catch |err| { fatal("unable to open zig lib directory from 'zig-lib-dir' argument: '{s}': {s}", .{ lib_dir, @errorName(err) }); }, } else introspect.findZigLibDirFromSelfExe(arena, self_exe_path) catch |err| { fatal("unable to find zig installation directory '{s}': {s}", .{ self_exe_path, @errorName(err) }); }; defer zig_lib_directory.handle.close(); var global_cache_directory: Compilation.Directory = l: { const p = override_global_cache_dir orelse try introspect.resolveGlobalCacheDir(arena); break :l .{ .handle = try fs.cwd().makeOpenPath(p, .{}), .path = p, }; }; defer global_cache_directory.handle.close(); var thread_pool: ThreadPool = undefined; try thread_pool.init(.{ .allocator = gpa }); defer thread_pool.deinit(); var child_argv: std.ArrayListUnmanaged([]const u8) = .{}; try child_argv.ensureUnusedCapacity(arena, args.len + 2); // We want to release all the locks before executing the child process, so we make a nice // big block here to ensure the cleanup gets run when we extract out our argv. { const main_mod_paths: Package.Module.CreateOptions.Paths = .{ .root = .{ .root_dir = zig_lib_directory, .sub_path = "compiler", }, .root_src_path = options.root_src_path, }; const config = try Compilation.Config.resolve(.{ .output_mode = .Exe, .root_strip = strip, .root_optimize_mode = optimize_mode, .resolved_target = resolved_target, .have_zcu = true, .emit_bin = true, .is_test = false, }); const root_mod = try Package.Module.create(arena, .{ .global_cache_directory = global_cache_directory, .paths = main_mod_paths, .fully_qualified_name = "root", .cc_argv = &.{}, .inherited = .{ .resolved_target = resolved_target, .optimize_mode = optimize_mode, .strip = strip, }, .global = config, .parent = null, .builtin_mod = null, }); if (options.depend_on_aro) { const aro_mod = try Package.Module.create(arena, .{ .global_cache_directory = global_cache_directory, .paths = .{ .root = .{ .root_dir = zig_lib_directory, .sub_path = "compiler/aro", }, .root_src_path = "aro.zig", }, .fully_qualified_name = "aro", .cc_argv = &.{}, .inherited = .{ .resolved_target = resolved_target, .optimize_mode = optimize_mode, .strip = strip, }, .global = config, .parent = null, .builtin_mod = root_mod.getBuiltinDependency(), }); try root_mod.deps.put(arena, "aro", aro_mod); } const comp = Compilation.create(gpa, arena, .{ .zig_lib_directory = zig_lib_directory, .local_cache_directory = global_cache_directory, .global_cache_directory = global_cache_directory, .root_name = options.cmd_name, .config = config, .root_mod = root_mod, .main_mod = root_mod, .emit_bin = emit_bin, .emit_h = null, .self_exe_path = self_exe_path, .thread_pool = &thread_pool, .cache_mode = .whole, }) catch |err| { fatal("unable to create compilation: {s}", .{@errorName(err)}); }; defer comp.destroy(); updateModule(comp, color) catch |err| switch (err) { error.SemanticAnalyzeFail => process.exit(2), else => |e| return e, }; const exe_path = try global_cache_directory.join(arena, &.{comp.cache_use.whole.bin_sub_path.?}); child_argv.appendAssumeCapacity(exe_path); } if (options.prepend_zig_lib_dir_path) child_argv.appendAssumeCapacity(zig_lib_directory.path.?); child_argv.appendSliceAssumeCapacity(args); if (process.can_execv and options.capture == null) { const err = process.execv(gpa, child_argv.items); const cmd = try std.mem.join(arena, " ", child_argv.items); fatal("the following command failed to execve with '{s}':\n{s}", .{ @errorName(err), cmd, }); } if (!process.can_spawn) { const cmd = try std.mem.join(arena, " ", child_argv.items); fatal("the following command cannot be executed ({s} does not support spawning a child process):\n{s}", .{ @tagName(builtin.os.tag), cmd, }); } var child = std.ChildProcess.init(child_argv.items, gpa); child.stdin_behavior = .Inherit; child.stdout_behavior = if (options.capture == null) .Inherit else .Pipe; child.stderr_behavior = .Inherit; try child.spawn(); if (options.capture) |ptr| { ptr.* = try child.stdout.?.readToEndAlloc(arena, std.math.maxInt(u32)); } const term = try child.wait(); switch (term) { .Exited => |code| { if (code == 0) { if (options.capture != null) return; return cleanExit(); } const cmd = try std.mem.join(arena, " ", child_argv.items); fatal("the following build command failed with exit code {d}:\n{s}", .{ code, cmd }); }, else => { const cmd = try std.mem.join(arena, " ", child_argv.items); fatal("the following build command crashed:\n{s}", .{cmd}); }, } } const info_zen = \\ \\ * Communicate intent precisely. \\ * Edge cases matter. \\ * Favor reading code over writing code. \\ * Only one obvious way to do things. \\ * Runtime crashes are better than bugs. \\ * Compile errors are better than runtime crashes. \\ * Incremental improvements. \\ * Avoid local maximums. \\ * Reduce the amount one must remember. \\ * Focus on code rather than style. \\ * Resource allocation may fail; resource deallocation must succeed. \\ * Memory is a resource. \\ * Together we serve the users. \\ \\ ; extern fn ZigClangIsLLVMUsingSeparateLibcxx() bool; extern "c" fn ZigClang_main(argc: c_int, argv: [*:null]?[*:0]u8) c_int; extern "c" fn ZigLlvmAr_main(argc: c_int, argv: [*:null]?[*:0]u8) c_int; fn argsCopyZ(alloc: Allocator, args: []const []const u8) ![:null]?[*:0]u8 { var argv = try alloc.allocSentinel(?[*:0]u8, args.len, null); for (args, 0..) |arg, i| { argv[i] = try alloc.dupeZ(u8, arg); // TODO If there was an argsAllocZ we could avoid this allocation. } return argv; } pub fn clangMain(alloc: Allocator, args: []const []const u8) error{OutOfMemory}!u8 { if (!build_options.have_llvm) fatal("`zig cc` and `zig c++` unavailable: compiler built without LLVM extensions", .{}); var arena_instance = std.heap.ArenaAllocator.init(alloc); defer arena_instance.deinit(); const arena = arena_instance.allocator(); // Convert the args to the null-terminated format Clang expects. const argv = try argsCopyZ(arena, args); const exit_code = ZigClang_main(@as(c_int, @intCast(argv.len)), argv.ptr); return @as(u8, @bitCast(@as(i8, @truncate(exit_code)))); } pub fn llvmArMain(alloc: Allocator, args: []const []const u8) error{OutOfMemory}!u8 { if (!build_options.have_llvm) fatal("`zig ar`, `zig dlltool`, `zig ranlib', and `zig lib` unavailable: compiler built without LLVM extensions", .{}); var arena_instance = std.heap.ArenaAllocator.init(alloc); defer arena_instance.deinit(); const arena = arena_instance.allocator(); // Convert the args to the format llvm-ar expects. // We intentionally shave off the zig binary at args[0]. const argv = try argsCopyZ(arena, args[1..]); const exit_code = ZigLlvmAr_main(@as(c_int, @intCast(argv.len)), argv.ptr); return @as(u8, @bitCast(@as(i8, @truncate(exit_code)))); } /// The first argument determines which backend is invoked. The options are: /// * `ld.lld` - ELF /// * `lld-link` - COFF /// * `wasm-ld` - WebAssembly pub fn lldMain( alloc: Allocator, args: []const []const u8, can_exit_early: bool, ) error{OutOfMemory}!u8 { if (!build_options.have_llvm) fatal("`zig {s}` unavailable: compiler built without LLVM extensions", .{args[0]}); // Print a warning if lld is called multiple times in the same process, // since it may misbehave // https://github.com/ziglang/zig/issues/3825 const CallCounter = struct { var count: usize = 0; }; if (CallCounter.count == 1) { // Issue the warning on the first repeat call warn("invoking LLD for the second time within the same process because the host OS ({s}) does not support spawning child processes. This sometimes activates LLD bugs", .{@tagName(builtin.os.tag)}); } CallCounter.count += 1; var arena_instance = std.heap.ArenaAllocator.init(alloc); defer arena_instance.deinit(); const arena = arena_instance.allocator(); // Convert the args to the format LLD expects. // We intentionally shave off the zig binary at args[0]. const argv = try argsCopyZ(arena, args[1..]); // "If an error occurs, false will be returned." const ok = rc: { const llvm = @import("codegen/llvm/bindings.zig"); const argc = @as(c_int, @intCast(argv.len)); if (mem.eql(u8, args[1], "ld.lld")) { break :rc llvm.LinkELF(argc, argv.ptr, can_exit_early, false); } else if (mem.eql(u8, args[1], "lld-link")) { break :rc llvm.LinkCOFF(argc, argv.ptr, can_exit_early, false); } else if (mem.eql(u8, args[1], "wasm-ld")) { break :rc llvm.LinkWasm(argc, argv.ptr, can_exit_early, false); } else { unreachable; } }; return @intFromBool(!ok); } const ArgIteratorResponseFile = process.ArgIteratorGeneral(.{ .comments = true, .single_quotes = true }); /// Initialize the arguments from a Response File. "*.rsp" fn initArgIteratorResponseFile(allocator: Allocator, resp_file_path: []const u8) !ArgIteratorResponseFile { const max_bytes = 10 * 1024 * 1024; // 10 MiB of command line arguments is a reasonable limit const cmd_line = try fs.cwd().readFileAlloc(allocator, resp_file_path, max_bytes); errdefer allocator.free(cmd_line); return ArgIteratorResponseFile.initTakeOwnership(allocator, cmd_line); } const clang_args = @import("clang_options.zig").list; pub const ClangArgIterator = struct { has_next: bool, zig_equivalent: ZigEquivalent, only_arg: []const u8, second_arg: []const u8, other_args: []const []const u8, argv: []const []const u8, next_index: usize, root_args: ?*Args, arg_iterator_response_file: ArgIteratorResponseFile, arena: Allocator, pub const ZigEquivalent = enum { target, o, c, r, m, x, other, positional, l, ignore, driver_punt, pic, no_pic, pie, no_pie, lto, no_lto, unwind_tables, no_unwind_tables, nostdlib, nostdlib_cpp, shared, rdynamic, wl, preprocess_only, asm_only, optimize, debug, gdwarf32, gdwarf64, sanitize, linker_script, dry_run, verbose, for_linker, linker_input_z, lib_dir, mcpu, dep_file, dep_file_to_stdout, framework_dir, framework, nostdlibinc, red_zone, no_red_zone, omit_frame_pointer, no_omit_frame_pointer, function_sections, no_function_sections, data_sections, no_data_sections, builtin, no_builtin, color_diagnostics, no_color_diagnostics, stack_check, no_stack_check, stack_protector, no_stack_protector, strip, exec_model, emit_llvm, sysroot, entry, force_undefined_symbol, weak_library, weak_framework, headerpad_max_install_names, compress_debug_sections, install_name, undefined, force_load_objc, }; const Args = struct { next_index: usize, argv: []const []const u8, }; fn init(arena: Allocator, argv: []const []const u8) ClangArgIterator { return .{ .next_index = 2, // `zig cc foo` this points to `foo` .has_next = argv.len > 2, .zig_equivalent = undefined, .only_arg = undefined, .second_arg = undefined, .other_args = undefined, .argv = argv, .root_args = null, .arg_iterator_response_file = undefined, .arena = arena, }; } fn next(self: *ClangArgIterator) !void { assert(self.has_next); assert(self.next_index < self.argv.len); // In this state we know that the parameter we are looking at is a root parameter // rather than an argument to a parameter. // We adjust the len below when necessary. self.other_args = (self.argv.ptr + self.next_index)[0..1]; var arg = self.argv[self.next_index]; self.incrementArgIndex(); if (mem.startsWith(u8, arg, "@")) { if (self.root_args != null) return error.NestedResponseFile; // This is a "compiler response file". We must parse the file and treat its // contents as command line parameters. const arena = self.arena; const resp_file_path = arg[1..]; self.arg_iterator_response_file = initArgIteratorResponseFile(arena, resp_file_path) catch |err| { fatal("unable to read response file '{s}': {s}", .{ resp_file_path, @errorName(err) }); }; // NOTE: The ArgIteratorResponseFile returns tokens from next() that are slices of an // internal buffer. This internal buffer is arena allocated, so it is not cleaned up here. var resp_arg_list = std.ArrayList([]const u8).init(arena); defer resp_arg_list.deinit(); { while (self.arg_iterator_response_file.next()) |token| { try resp_arg_list.append(token); } const args = try arena.create(Args); errdefer arena.destroy(args); args.* = .{ .next_index = self.next_index, .argv = self.argv, }; self.root_args = args; } const resp_arg_slice = try resp_arg_list.toOwnedSlice(); self.next_index = 0; self.argv = resp_arg_slice; if (resp_arg_slice.len == 0) { self.resolveRespFileArgs(); return; } self.has_next = true; self.other_args = (self.argv.ptr + self.next_index)[0..1]; // We adjust len below when necessary. arg = self.argv[self.next_index]; self.incrementArgIndex(); } if (mem.eql(u8, arg, "-") or !mem.startsWith(u8, arg, "-")) { self.zig_equivalent = .positional; self.only_arg = arg; return; } find_clang_arg: for (clang_args) |clang_arg| switch (clang_arg.syntax) { .flag => { const prefix_len = clang_arg.matchEql(arg); if (prefix_len > 0) { self.zig_equivalent = clang_arg.zig_equivalent; self.only_arg = arg[prefix_len..]; break :find_clang_arg; } }, .joined, .comma_joined => { // joined example: --target=foo // comma_joined example: -Wl,-soname,libsoundio.so.2 const prefix_len = clang_arg.matchStartsWith(arg); if (prefix_len != 0) { self.zig_equivalent = clang_arg.zig_equivalent; self.only_arg = arg[prefix_len..]; // This will skip over the "--target=" part. break :find_clang_arg; } }, .joined_or_separate => { // Examples: `-lfoo`, `-l foo` const prefix_len = clang_arg.matchStartsWith(arg); if (prefix_len == arg.len) { if (self.next_index >= self.argv.len) { fatal("Expected parameter after '{s}'", .{arg}); } self.only_arg = self.argv[self.next_index]; self.incrementArgIndex(); self.other_args.len += 1; self.zig_equivalent = clang_arg.zig_equivalent; break :find_clang_arg; } else if (prefix_len != 0) { self.zig_equivalent = clang_arg.zig_equivalent; self.only_arg = arg[prefix_len..]; break :find_clang_arg; } }, .joined_and_separate => { // Example: `-Xopenmp-target=riscv64-linux-unknown foo` const prefix_len = clang_arg.matchStartsWith(arg); if (prefix_len != 0) { self.only_arg = arg[prefix_len..]; if (self.next_index >= self.argv.len) { fatal("Expected parameter after '{s}'", .{arg}); } self.second_arg = self.argv[self.next_index]; self.incrementArgIndex(); self.other_args.len += 1; self.zig_equivalent = clang_arg.zig_equivalent; break :find_clang_arg; } }, .separate => if (clang_arg.matchEql(arg) > 0) { if (self.next_index >= self.argv.len) { fatal("Expected parameter after '{s}'", .{arg}); } self.only_arg = self.argv[self.next_index]; self.incrementArgIndex(); self.other_args.len += 1; self.zig_equivalent = clang_arg.zig_equivalent; break :find_clang_arg; }, .remaining_args_joined => { const prefix_len = clang_arg.matchStartsWith(arg); if (prefix_len != 0) { @panic("TODO"); } }, .multi_arg => |num_args| if (clang_arg.matchEql(arg) > 0) { // Example `-sectcreate `. var i: usize = 0; while (i < num_args) : (i += 1) { self.incrementArgIndex(); self.other_args.len += 1; } self.zig_equivalent = clang_arg.zig_equivalent; break :find_clang_arg; }, } else { fatal("Unknown Clang option: '{s}'", .{arg}); } } fn incrementArgIndex(self: *ClangArgIterator) void { self.next_index += 1; self.resolveRespFileArgs(); } fn resolveRespFileArgs(self: *ClangArgIterator) void { const arena = self.arena; if (self.next_index >= self.argv.len) { if (self.root_args) |root_args| { self.next_index = root_args.next_index; self.argv = root_args.argv; arena.destroy(root_args); self.root_args = null; } if (self.next_index >= self.argv.len) { self.has_next = false; } } } }; fn parseCodeModel(arg: []const u8) std.builtin.CodeModel { return std.meta.stringToEnum(std.builtin.CodeModel, arg) orelse fatal("unsupported machine code model: '{s}'", .{arg}); } /// Raise the open file descriptor limit. Ask and ye shall receive. /// For one example of why this is handy, consider the case of building musl libc. /// We keep a lock open for each of the object files in the form of a file descriptor /// until they are finally put into an archive file. This is to allow a zig-cache /// garbage collector to run concurrently to zig processes, and to allow multiple /// zig processes to run concurrently with each other, without clobbering each other. fn gimmeMoreOfThoseSweetSweetFileDescriptors() void { if (!@hasDecl(std.os.system, "rlimit")) return; const posix = std.os; var lim = posix.getrlimit(.NOFILE) catch return; // Oh well; we tried. if (comptime builtin.target.isDarwin()) { // On Darwin, `NOFILE` is bounded by a hardcoded value `OPEN_MAX`. // According to the man pages for setrlimit(): // setrlimit() now returns with errno set to EINVAL in places that historically succeeded. // It no longer accepts "rlim_cur = RLIM.INFINITY" for RLIM.NOFILE. // Use "rlim_cur = min(OPEN_MAX, rlim_max)". lim.max = @min(std.os.darwin.OPEN_MAX, lim.max); } if (lim.cur == lim.max) return; // Do a binary search for the limit. var min: posix.rlim_t = lim.cur; var max: posix.rlim_t = 1 << 20; // But if there's a defined upper bound, don't search, just set it. if (lim.max != posix.RLIM.INFINITY) { min = lim.max; max = lim.max; } while (true) { lim.cur = min + @divTrunc(max - min, 2); // on freebsd rlim_t is signed if (posix.setrlimit(.NOFILE, lim)) |_| { min = lim.cur; } else |_| { max = lim.cur; } if (min + 1 >= max) break; } } test "fds" { gimmeMoreOfThoseSweetSweetFileDescriptors(); } const usage_ast_check = \\Usage: zig ast-check [file] \\ \\ Given a .zig source file, reports any compile errors that can be \\ ascertained on the basis of the source code alone, without target \\ information or type checking. \\ \\ If [file] is omitted, stdin is used. \\ \\Options: \\ -h, --help Print this help and exit \\ --color [auto|off|on] Enable or disable colored error messages \\ -t (debug option) Output ZIR in text form to stdout \\ \\ ; fn cmdAstCheck( gpa: Allocator, arena: Allocator, args: []const []const u8, ) !void { const Zir = std.zig.Zir; var color: Color = .auto; var want_output_text = false; var zig_source_file: ?[]const u8 = null; var i: usize = 0; while (i < args.len) : (i += 1) { const arg = args[i]; if (mem.startsWith(u8, arg, "-")) { if (mem.eql(u8, arg, "-h") or mem.eql(u8, arg, "--help")) { try io.getStdOut().writeAll(usage_ast_check); return cleanExit(); } else if (mem.eql(u8, arg, "-t")) { want_output_text = true; } else if (mem.eql(u8, arg, "--color")) { if (i + 1 >= args.len) { fatal("expected [auto|on|off] after --color", .{}); } i += 1; const next_arg = args[i]; color = std.meta.stringToEnum(Color, next_arg) orelse { fatal("expected [auto|on|off] after --color, found '{s}'", .{next_arg}); }; } else { fatal("unrecognized parameter: '{s}'", .{arg}); } } else if (zig_source_file == null) { zig_source_file = arg; } else { fatal("extra positional parameter: '{s}'", .{arg}); } } var file: Module.File = .{ .status = .never_loaded, .source_loaded = false, .tree_loaded = false, .zir_loaded = false, .sub_file_path = undefined, .source = undefined, .stat = undefined, .tree = undefined, .zir = undefined, .mod = undefined, .root_decl = .none, }; if (zig_source_file) |file_name| { var f = fs.cwd().openFile(file_name, .{}) catch |err| { fatal("unable to open file for ast-check '{s}': {s}", .{ file_name, @errorName(err) }); }; defer f.close(); const stat = try f.stat(); if (stat.size > std.zig.max_src_size) return error.FileTooBig; const source = try arena.allocSentinel(u8, @as(usize, @intCast(stat.size)), 0); const amt = try f.readAll(source); if (amt != stat.size) return error.UnexpectedEndOfFile; file.sub_file_path = file_name; file.source = source; file.source_loaded = true; file.stat = .{ .size = stat.size, .inode = stat.inode, .mtime = stat.mtime, }; } else { const stdin = io.getStdIn(); const source = std.zig.readSourceFileToEndAlloc(arena, stdin, null) catch |err| { fatal("unable to read stdin: {}", .{err}); }; file.sub_file_path = ""; file.source = source; file.source_loaded = true; file.stat.size = source.len; } file.mod = try Package.Module.createLimited(arena, .{ .root = Package.Path.cwd(), .root_src_path = file.sub_file_path, .fully_qualified_name = "root", }); file.tree = try Ast.parse(gpa, file.source, .zig); file.tree_loaded = true; defer file.tree.deinit(gpa); file.zir = try AstGen.generate(gpa, file.tree); file.zir_loaded = true; defer file.zir.deinit(gpa); if (file.zir.hasCompileErrors()) { var wip_errors: std.zig.ErrorBundle.Wip = undefined; try wip_errors.init(gpa); defer wip_errors.deinit(); try Compilation.addZirErrorMessages(&wip_errors, &file); var error_bundle = try wip_errors.toOwnedBundle(""); defer error_bundle.deinit(gpa); error_bundle.renderToStdErr(color.renderOptions()); process.exit(1); } if (!want_output_text) { return cleanExit(); } if (!debug_extensions_enabled) { fatal("-t option only available in debug builds of zig", .{}); } { const token_bytes = @sizeOf(Ast.TokenList) + file.tree.tokens.len * (@sizeOf(std.zig.Token.Tag) + @sizeOf(Ast.ByteOffset)); const tree_bytes = @sizeOf(Ast) + file.tree.nodes.len * (@sizeOf(Ast.Node.Tag) + @sizeOf(Ast.Node.Data) + @sizeOf(Ast.TokenIndex)); const instruction_bytes = file.zir.instructions.len * // Here we don't use @sizeOf(Zir.Inst.Data) because it would include // the debug safety tag but we want to measure release size. (@sizeOf(Zir.Inst.Tag) + 8); const extra_bytes = file.zir.extra.len * @sizeOf(u32); const total_bytes = @sizeOf(Zir) + instruction_bytes + extra_bytes + file.zir.string_bytes.len * @sizeOf(u8); const stdout = io.getStdOut(); const fmtIntSizeBin = std.fmt.fmtIntSizeBin; // zig fmt: off try stdout.writer().print( \\# Source bytes: {} \\# Tokens: {} ({}) \\# AST Nodes: {} ({}) \\# Total ZIR bytes: {} \\# Instructions: {d} ({}) \\# String Table Bytes: {} \\# Extra Data Items: {d} ({}) \\ , .{ fmtIntSizeBin(file.source.len), file.tree.tokens.len, fmtIntSizeBin(token_bytes), file.tree.nodes.len, fmtIntSizeBin(tree_bytes), fmtIntSizeBin(total_bytes), file.zir.instructions.len, fmtIntSizeBin(instruction_bytes), fmtIntSizeBin(file.zir.string_bytes.len), file.zir.extra.len, fmtIntSizeBin(extra_bytes), }); // zig fmt: on } return @import("print_zir.zig").renderAsTextToFile(gpa, &file, io.getStdOut()); } /// This is only enabled for debug builds. fn cmdDumpZir( gpa: Allocator, arena: Allocator, args: []const []const u8, ) !void { _ = arena; const Zir = std.zig.Zir; const cache_file = args[0]; var f = fs.cwd().openFile(cache_file, .{}) catch |err| { fatal("unable to open zir cache file for dumping '{s}': {s}", .{ cache_file, @errorName(err) }); }; defer f.close(); var file: Module.File = .{ .status = .never_loaded, .source_loaded = false, .tree_loaded = false, .zir_loaded = true, .sub_file_path = undefined, .source = undefined, .stat = undefined, .tree = undefined, .zir = try Module.loadZirCache(gpa, f), .mod = undefined, .root_decl = .none, }; defer file.zir.deinit(gpa); { const instruction_bytes = file.zir.instructions.len * // Here we don't use @sizeOf(Zir.Inst.Data) because it would include // the debug safety tag but we want to measure release size. (@sizeOf(Zir.Inst.Tag) + 8); const extra_bytes = file.zir.extra.len * @sizeOf(u32); const total_bytes = @sizeOf(Zir) + instruction_bytes + extra_bytes + file.zir.string_bytes.len * @sizeOf(u8); const stdout = io.getStdOut(); const fmtIntSizeBin = std.fmt.fmtIntSizeBin; // zig fmt: off try stdout.writer().print( \\# Total ZIR bytes: {} \\# Instructions: {d} ({}) \\# String Table Bytes: {} \\# Extra Data Items: {d} ({}) \\ , .{ fmtIntSizeBin(total_bytes), file.zir.instructions.len, fmtIntSizeBin(instruction_bytes), fmtIntSizeBin(file.zir.string_bytes.len), file.zir.extra.len, fmtIntSizeBin(extra_bytes), }); // zig fmt: on } return @import("print_zir.zig").renderAsTextToFile(gpa, &file, io.getStdOut()); } /// This is only enabled for debug builds. fn cmdChangelist( gpa: Allocator, arena: Allocator, args: []const []const u8, ) !void { const color: Color = .auto; const Zir = std.zig.Zir; const old_source_file = args[0]; const new_source_file = args[1]; var f = fs.cwd().openFile(old_source_file, .{}) catch |err| { fatal("unable to open old source file for comparison '{s}': {s}", .{ old_source_file, @errorName(err) }); }; defer f.close(); const stat = try f.stat(); if (stat.size > std.zig.max_src_size) return error.FileTooBig; var file: Module.File = .{ .status = .never_loaded, .source_loaded = false, .tree_loaded = false, .zir_loaded = false, .sub_file_path = old_source_file, .source = undefined, .stat = .{ .size = stat.size, .inode = stat.inode, .mtime = stat.mtime, }, .tree = undefined, .zir = undefined, .mod = undefined, .root_decl = .none, }; file.mod = try Package.Module.createLimited(arena, .{ .root = Package.Path.cwd(), .root_src_path = file.sub_file_path, .fully_qualified_name = "root", }); const source = try arena.allocSentinel(u8, @as(usize, @intCast(stat.size)), 0); const amt = try f.readAll(source); if (amt != stat.size) return error.UnexpectedEndOfFile; file.source = source; file.source_loaded = true; file.tree = try Ast.parse(gpa, file.source, .zig); file.tree_loaded = true; defer file.tree.deinit(gpa); file.zir = try AstGen.generate(gpa, file.tree); file.zir_loaded = true; defer file.zir.deinit(gpa); if (file.zir.hasCompileErrors()) { var wip_errors: std.zig.ErrorBundle.Wip = undefined; try wip_errors.init(gpa); defer wip_errors.deinit(); try Compilation.addZirErrorMessages(&wip_errors, &file); var error_bundle = try wip_errors.toOwnedBundle(""); defer error_bundle.deinit(gpa); error_bundle.renderToStdErr(color.renderOptions()); process.exit(1); } var new_f = fs.cwd().openFile(new_source_file, .{}) catch |err| { fatal("unable to open new source file for comparison '{s}': {s}", .{ new_source_file, @errorName(err) }); }; defer new_f.close(); const new_stat = try new_f.stat(); if (new_stat.size > std.zig.max_src_size) return error.FileTooBig; const new_source = try arena.allocSentinel(u8, @as(usize, @intCast(new_stat.size)), 0); const new_amt = try new_f.readAll(new_source); if (new_amt != new_stat.size) return error.UnexpectedEndOfFile; var new_tree = try Ast.parse(gpa, new_source, .zig); defer new_tree.deinit(gpa); var old_zir = file.zir; defer old_zir.deinit(gpa); file.zir_loaded = false; file.zir = try AstGen.generate(gpa, new_tree); file.zir_loaded = true; if (file.zir.hasCompileErrors()) { var wip_errors: std.zig.ErrorBundle.Wip = undefined; try wip_errors.init(gpa); defer wip_errors.deinit(); try Compilation.addZirErrorMessages(&wip_errors, &file); var error_bundle = try wip_errors.toOwnedBundle(""); defer error_bundle.deinit(gpa); error_bundle.renderToStdErr(color.renderOptions()); process.exit(1); } var inst_map: std.AutoHashMapUnmanaged(Zir.Inst.Index, Zir.Inst.Index) = .{}; defer inst_map.deinit(gpa); try Module.mapOldZirToNew(gpa, old_zir, file.zir, &inst_map); var bw = io.bufferedWriter(io.getStdOut().writer()); const stdout = bw.writer(); { try stdout.print("Instruction mappings:\n", .{}); var it = inst_map.iterator(); while (it.next()) |entry| { try stdout.print(" %{d} => %{d}\n", .{ @intFromEnum(entry.key_ptr.*), @intFromEnum(entry.value_ptr.*), }); } } try bw.flush(); } fn eatIntPrefix(arg: []const u8, base: u8) []const u8 { if (arg.len > 2 and arg[0] == '0') { switch (std.ascii.toLower(arg[1])) { 'b' => if (base == 2) return arg[2..], 'o' => if (base == 8) return arg[2..], 'x' => if (base == 16) return arg[2..], else => {}, } } return arg; } fn parseIntSuffix(arg: []const u8, prefix_len: usize) u64 { return std.fmt.parseUnsigned(u64, arg[prefix_len..], 0) catch |err| { fatal("unable to parse '{s}': {s}", .{ arg, @errorName(err) }); }; } fn warnAboutForeignBinaries( arena: Allocator, arg_mode: ArgMode, target: *const std.Target, link_libc: bool, ) !void { const host_query: std.Target.Query = .{}; const host_target = std.zig.resolveTargetQueryOrFatal(host_query); switch (std.zig.system.getExternalExecutor(host_target, target, .{ .link_libc = link_libc })) { .native => return, .rosetta => { const host_name = try host_target.zigTriple(arena); const foreign_name = try target.zigTriple(arena); warn("the host system ({s}) does not appear to be capable of executing binaries from the target ({s}). Consider installing Rosetta.", .{ host_name, foreign_name, }); }, .qemu => |qemu| { const host_name = try host_target.zigTriple(arena); const foreign_name = try target.zigTriple(arena); switch (arg_mode) { .zig_test => warn( "the host system ({s}) does not appear to be capable of executing binaries " ++ "from the target ({s}). Consider using '--test-cmd {s} --test-cmd-bin' " ++ "to run the tests", .{ host_name, foreign_name, qemu }, ), else => warn( "the host system ({s}) does not appear to be capable of executing binaries " ++ "from the target ({s}). Consider using '{s}' to run the binary", .{ host_name, foreign_name, qemu }, ), } }, .wine => |wine| { const host_name = try host_target.zigTriple(arena); const foreign_name = try target.zigTriple(arena); switch (arg_mode) { .zig_test => warn( "the host system ({s}) does not appear to be capable of executing binaries " ++ "from the target ({s}). Consider using '--test-cmd {s} --test-cmd-bin' " ++ "to run the tests", .{ host_name, foreign_name, wine }, ), else => warn( "the host system ({s}) does not appear to be capable of executing binaries " ++ "from the target ({s}). Consider using '{s}' to run the binary", .{ host_name, foreign_name, wine }, ), } }, .wasmtime => |wasmtime| { const host_name = try host_target.zigTriple(arena); const foreign_name = try target.zigTriple(arena); switch (arg_mode) { .zig_test => warn( "the host system ({s}) does not appear to be capable of executing binaries " ++ "from the target ({s}). Consider using '--test-cmd {s} --test-cmd-bin' " ++ "to run the tests", .{ host_name, foreign_name, wasmtime }, ), else => warn( "the host system ({s}) does not appear to be capable of executing binaries " ++ "from the target ({s}). Consider using '{s}' to run the binary", .{ host_name, foreign_name, wasmtime }, ), } }, .darling => |darling| { const host_name = try host_target.zigTriple(arena); const foreign_name = try target.zigTriple(arena); switch (arg_mode) { .zig_test => warn( "the host system ({s}) does not appear to be capable of executing binaries " ++ "from the target ({s}). Consider using '--test-cmd {s} --test-cmd-bin' " ++ "to run the tests", .{ host_name, foreign_name, darling }, ), else => warn( "the host system ({s}) does not appear to be capable of executing binaries " ++ "from the target ({s}). Consider using '{s}' to run the binary", .{ host_name, foreign_name, darling }, ), } }, .bad_dl => |foreign_dl| { const host_dl = host_target.dynamic_linker.get() orelse "(none)"; const tip_suffix = switch (arg_mode) { .zig_test => ", '--test-no-exec', or '--test-cmd'", else => "", }; warn("the host system does not appear to be capable of executing binaries from the target because the host dynamic linker is '{s}', while the target dynamic linker is '{s}'. Consider using '--dynamic-linker'{s}", .{ host_dl, foreign_dl, tip_suffix, }); }, .bad_os_or_cpu => { const host_name = try host_target.zigTriple(arena); const foreign_name = try target.zigTriple(arena); const tip_suffix = switch (arg_mode) { .zig_test => ". Consider using '--test-no-exec' or '--test-cmd'", else => "", }; warn("the host system ({s}) does not appear to be capable of executing binaries from the target ({s}){s}", .{ host_name, foreign_name, tip_suffix, }); }, } } fn parseSubSystem(next_arg: []const u8) !std.Target.SubSystem { if (mem.eql(u8, next_arg, "console")) { return .Console; } else if (mem.eql(u8, next_arg, "windows")) { return .Windows; } else if (mem.eql(u8, next_arg, "posix")) { return .Posix; } else if (mem.eql(u8, next_arg, "native")) { return .Native; } else if (mem.eql(u8, next_arg, "efi_application")) { return .EfiApplication; } else if (mem.eql(u8, next_arg, "efi_boot_service_driver")) { return .EfiBootServiceDriver; } else if (mem.eql(u8, next_arg, "efi_rom")) { return .EfiRom; } else if (mem.eql(u8, next_arg, "efi_runtime_driver")) { return .EfiRuntimeDriver; } else { fatal("invalid: --subsystem: '{s}'. Options are:\n{s}", .{ next_arg, \\ console \\ windows \\ posix \\ native \\ efi_application \\ efi_boot_service_driver \\ efi_rom \\ efi_runtime_driver \\ }); } } /// Model a header searchlist as a group. /// Silently ignore superfluous search dirs. /// Warn when a dir is added to multiple searchlists. const ClangSearchSanitizer = struct { map: std.StringHashMapUnmanaged(Membership) = .{}, fn reset(self: *@This()) void { self.map.clearRetainingCapacity(); } fn addIncludePath( self: *@This(), ally: Allocator, argv: *std.ArrayListUnmanaged([]const u8), group: Group, arg: []const u8, dir: []const u8, joined: bool, ) !void { const gopr = try self.map.getOrPut(ally, dir); const m = gopr.value_ptr; if (!gopr.found_existing) { // init empty membership m.* = .{}; } const wtxt = "add '{s}' to header searchlist '-{s}' conflicts with '-{s}'"; switch (group) { .I => { if (m.I) return; m.I = true; if (m.isystem) warn(wtxt, .{ dir, "I", "isystem" }); if (m.idirafter) warn(wtxt, .{ dir, "I", "idirafter" }); if (m.iframework) warn(wtxt, .{ dir, "I", "iframework" }); }, .isystem => { if (m.isystem) return; m.isystem = true; if (m.I) warn(wtxt, .{ dir, "isystem", "I" }); if (m.idirafter) warn(wtxt, .{ dir, "isystem", "idirafter" }); if (m.iframework) warn(wtxt, .{ dir, "isystem", "iframework" }); }, .iwithsysroot => { if (m.iwithsysroot) return; m.iwithsysroot = true; if (m.iframeworkwithsysroot) warn(wtxt, .{ dir, "iwithsysroot", "iframeworkwithsysroot" }); }, .idirafter => { if (m.idirafter) return; m.idirafter = true; if (m.I) warn(wtxt, .{ dir, "idirafter", "I" }); if (m.isystem) warn(wtxt, .{ dir, "idirafter", "isystem" }); if (m.iframework) warn(wtxt, .{ dir, "idirafter", "iframework" }); }, .iframework => { if (m.iframework) return; m.iframework = true; if (m.I) warn(wtxt, .{ dir, "iframework", "I" }); if (m.isystem) warn(wtxt, .{ dir, "iframework", "isystem" }); if (m.idirafter) warn(wtxt, .{ dir, "iframework", "idirafter" }); }, .iframeworkwithsysroot => { if (m.iframeworkwithsysroot) return; m.iframeworkwithsysroot = true; if (m.iwithsysroot) warn(wtxt, .{ dir, "iframeworkwithsysroot", "iwithsysroot" }); }, } try argv.ensureUnusedCapacity(ally, 2); argv.appendAssumeCapacity(arg); if (!joined) argv.appendAssumeCapacity(dir); } const Group = enum { I, isystem, iwithsysroot, idirafter, iframework, iframeworkwithsysroot }; const Membership = packed struct { I: bool = false, isystem: bool = false, iwithsysroot: bool = false, idirafter: bool = false, iframework: bool = false, iframeworkwithsysroot: bool = false, }; }; fn accessLibPath( test_path: *std.ArrayList(u8), checked_paths: *std.ArrayList(u8), lib_dir_path: []const u8, lib_name: []const u8, target: std.Target, link_mode: std.builtin.LinkMode, ) !bool { const sep = fs.path.sep_str; if (target.isDarwin() and link_mode == .Dynamic) tbd: { // Prefer .tbd over .dylib. test_path.clearRetainingCapacity(); try test_path.writer().print("{s}" ++ sep ++ "lib{s}.tbd", .{ lib_dir_path, lib_name }); try checked_paths.writer().print("\n {s}", .{test_path.items}); fs.cwd().access(test_path.items, .{}) catch |err| switch (err) { error.FileNotFound => break :tbd, else => |e| fatal("unable to search for tbd library '{s}': {s}", .{ test_path.items, @errorName(e), }), }; return true; } main_check: { test_path.clearRetainingCapacity(); try test_path.writer().print("{s}" ++ sep ++ "{s}{s}{s}", .{ lib_dir_path, target.libPrefix(), lib_name, switch (link_mode) { .Static => target.staticLibSuffix(), .Dynamic => target.dynamicLibSuffix(), }, }); try checked_paths.writer().print("\n {s}", .{test_path.items}); fs.cwd().access(test_path.items, .{}) catch |err| switch (err) { error.FileNotFound => break :main_check, else => |e| fatal("unable to search for {s} library '{s}': {s}", .{ @tagName(link_mode), test_path.items, @errorName(e), }), }; return true; } // In the case of Darwin, the main check will be .dylib, so here we // additionally check for .so files. if (target.isDarwin() and link_mode == .Dynamic) so: { test_path.clearRetainingCapacity(); try test_path.writer().print("{s}" ++ sep ++ "lib{s}.so", .{ lib_dir_path, lib_name }); try checked_paths.writer().print("\n {s}", .{test_path.items}); fs.cwd().access(test_path.items, .{}) catch |err| switch (err) { error.FileNotFound => break :so, else => |e| fatal("unable to search for so library '{s}': {s}", .{ test_path.items, @errorName(e), }), }; return true; } // In the case of MinGW, the main check will be .lib but we also need to // look for `libfoo.a`. if (target.isMinGW() and link_mode == .Static) mingw: { test_path.clearRetainingCapacity(); try test_path.writer().print("{s}" ++ sep ++ "lib{s}.a", .{ lib_dir_path, lib_name, }); try checked_paths.writer().print("\n {s}", .{test_path.items}); fs.cwd().access(test_path.items, .{}) catch |err| switch (err) { error.FileNotFound => break :mingw, else => |e| fatal("unable to search for static library '{s}': {s}", .{ test_path.items, @errorName(e), }), }; return true; } return false; } fn accessFrameworkPath( test_path: *std.ArrayList(u8), checked_paths: *std.ArrayList(u8), framework_dir_path: []const u8, framework_name: []const u8, ) !bool { const sep = fs.path.sep_str; for (&[_][]const u8{ ".tbd", ".dylib", "" }) |ext| { test_path.clearRetainingCapacity(); try test_path.writer().print("{s}" ++ sep ++ "{s}.framework" ++ sep ++ "{s}{s}", .{ framework_dir_path, framework_name, framework_name, ext, }); try checked_paths.writer().print("\n {s}", .{test_path.items}); fs.cwd().access(test_path.items, .{}) catch |err| switch (err) { error.FileNotFound => continue, else => |e| fatal("unable to search for {s} framework '{s}': {s}", .{ ext, test_path.items, @errorName(e), }), }; return true; } return false; } fn parseRcIncludes(arg: []const u8) Compilation.RcIncludes { return std.meta.stringToEnum(Compilation.RcIncludes, arg) orelse fatal("unsupported rc includes type: '{s}'", .{arg}); } const usage_fetch = \\Usage: zig fetch [options] \\Usage: zig fetch [options] \\ \\ Copy a package into the global cache and print its hash. \\ \\Options: \\ -h, --help Print this help and exit \\ --global-cache-dir [path] Override path to global Zig cache directory \\ --debug-hash Print verbose hash information to stdout \\ --save Add the fetched package to build.zig.zon \\ --save=[name] Add the fetched package to build.zig.zon as name \\ ; fn cmdFetch( gpa: Allocator, arena: Allocator, args: []const []const u8, ) !void { const color: Color = .auto; const work_around_btrfs_bug = builtin.os.tag == .linux and EnvVar.ZIG_BTRFS_WORKAROUND.isSet(); var opt_path_or_url: ?[]const u8 = null; var override_global_cache_dir: ?[]const u8 = try EnvVar.ZIG_GLOBAL_CACHE_DIR.get(arena); var debug_hash: bool = false; var save: union(enum) { no, yes, name: []const u8 } = .no; { var i: usize = 0; while (i < args.len) : (i += 1) { const arg = args[i]; if (mem.startsWith(u8, arg, "-")) { if (mem.eql(u8, arg, "-h") or mem.eql(u8, arg, "--help")) { const stdout = io.getStdOut().writer(); try stdout.writeAll(usage_fetch); return cleanExit(); } else if (mem.eql(u8, arg, "--global-cache-dir")) { if (i + 1 >= args.len) fatal("expected argument after '{s}'", .{arg}); i += 1; override_global_cache_dir = args[i]; } else if (mem.eql(u8, arg, "--debug-hash")) { debug_hash = true; } else if (mem.eql(u8, arg, "--save")) { save = .yes; } else if (mem.startsWith(u8, arg, "--save=")) { save = .{ .name = arg["--save=".len..] }; } else { fatal("unrecognized parameter: '{s}'", .{arg}); } } else if (opt_path_or_url != null) { fatal("unexpected extra parameter: '{s}'", .{arg}); } else { opt_path_or_url = arg; } } } const path_or_url = opt_path_or_url orelse fatal("missing url or path parameter", .{}); var thread_pool: ThreadPool = undefined; try thread_pool.init(.{ .allocator = gpa }); defer thread_pool.deinit(); var http_client: std.http.Client = .{ .allocator = gpa }; defer http_client.deinit(); try http_client.initDefaultProxies(arena); var progress: std.Progress = .{ .dont_print_on_dumb = true }; const root_prog_node = progress.start("Fetch", 0); defer root_prog_node.end(); var global_cache_directory: Compilation.Directory = l: { const p = override_global_cache_dir orelse try introspect.resolveGlobalCacheDir(arena); break :l .{ .handle = try fs.cwd().makeOpenPath(p, .{}), .path = p, }; }; defer global_cache_directory.handle.close(); var job_queue: Package.Fetch.JobQueue = .{ .http_client = &http_client, .thread_pool = &thread_pool, .global_cache = global_cache_directory, .recursive = false, .read_only = false, .debug_hash = debug_hash, .work_around_btrfs_bug = work_around_btrfs_bug, }; defer job_queue.deinit(); var fetch: Package.Fetch = .{ .arena = std.heap.ArenaAllocator.init(gpa), .location = .{ .path_or_url = path_or_url }, .location_tok = 0, .hash_tok = 0, .name_tok = 0, .lazy_status = .eager, .parent_package_root = undefined, .parent_manifest_ast = null, .prog_node = root_prog_node, .job_queue = &job_queue, .omit_missing_hash_error = true, .allow_missing_paths_field = false, .package_root = undefined, .error_bundle = undefined, .manifest = null, .manifest_ast = undefined, .actual_hash = undefined, .has_build_zig = false, .oom_flag = false, .module = null, }; defer fetch.deinit(); fetch.run() catch |err| switch (err) { error.OutOfMemory => fatal("out of memory", .{}), error.FetchFailed => {}, // error bundle checked below }; if (fetch.error_bundle.root_list.items.len > 0) { var errors = try fetch.error_bundle.toOwnedBundle(""); errors.renderToStdErr(color.renderOptions()); process.exit(1); } const hex_digest = Package.Manifest.hexDigest(fetch.actual_hash); progress.done = true; progress.refresh(); const name = switch (save) { .no => { try io.getStdOut().writeAll(hex_digest ++ "\n"); return cleanExit(); }, .yes => n: { const fetched_manifest = fetch.manifest orelse fatal("unable to determine name; fetched package has no build.zig.zon file", .{}); break :n fetched_manifest.name; }, .name => |n| n, }; const cwd_path = try process.getCwdAlloc(arena); var build_root = try findBuildRoot(arena, .{ .cwd_path = cwd_path, }); defer build_root.deinit(); // The name to use in case the manifest file needs to be created now. const init_root_name = fs.path.basename(build_root.directory.path orelse cwd_path); var manifest, var ast = try loadManifest(gpa, arena, .{ .root_name = init_root_name, .dir = build_root.directory.handle, .color = color, }); defer { manifest.deinit(gpa); ast.deinit(gpa); } var fixups: Ast.Fixups = .{}; defer fixups.deinit(gpa); const new_node_init = try std.fmt.allocPrint(arena, \\.{{ \\ .url = "{}", \\ .hash = "{}", \\ }} , .{ std.zig.fmtEscapes(path_or_url), std.zig.fmtEscapes(&hex_digest), }); const new_node_text = try std.fmt.allocPrint(arena, ".{} = {s},\n", .{ std.zig.fmtId(name), new_node_init, }); const dependencies_init = try std.fmt.allocPrint(arena, ".{{\n {s} }}", .{ new_node_text, }); const dependencies_text = try std.fmt.allocPrint(arena, ".dependencies = {s},\n", .{ dependencies_init, }); if (manifest.dependencies.get(name)) |dep| { if (dep.hash) |h| { switch (dep.location) { .url => |u| { if (mem.eql(u8, h, &hex_digest) and mem.eql(u8, u, path_or_url)) { std.log.info("existing dependency named '{s}' is up-to-date", .{name}); process.exit(0); } }, .path => {}, } } warn("overwriting existing dependency named '{s}'", .{name}); try fixups.replace_nodes_with_string.put(gpa, dep.node, new_node_init); } else if (manifest.dependencies.count() > 0) { // Add fixup for adding another dependency. const deps = manifest.dependencies.values(); const last_dep_node = deps[deps.len - 1].node; try fixups.append_string_after_node.put(gpa, last_dep_node, new_node_text); } else if (manifest.dependencies_node != 0) { // Add fixup for replacing the entire dependencies struct. try fixups.replace_nodes_with_string.put(gpa, manifest.dependencies_node, dependencies_init); } else { // Add fixup for adding dependencies struct. try fixups.append_string_after_node.put(gpa, manifest.version_node, dependencies_text); } var rendered = std.ArrayList(u8).init(gpa); defer rendered.deinit(); try ast.renderToArrayList(&rendered, fixups); build_root.directory.handle.writeFile(Package.Manifest.basename, rendered.items) catch |err| { fatal("unable to write {s} file: {s}", .{ Package.Manifest.basename, @errorName(err) }); }; return cleanExit(); } fn createEmptyDependenciesModule( arena: Allocator, main_mod: *Package.Module, global_cache_directory: Cache.Directory, local_cache_directory: Cache.Directory, builtin_mod: *Package.Module, global_options: Compilation.Config, ) !void { var source = std.ArrayList(u8).init(arena); try Package.Fetch.JobQueue.createEmptyDependenciesSource(&source); _ = try createDependenciesModule( arena, source.items, main_mod, global_cache_directory, local_cache_directory, builtin_mod, global_options, ); } /// Creates the dependencies.zig file and corresponding `Package.Module` for the /// build runner to obtain via `@import("@dependencies")`. fn createDependenciesModule( arena: Allocator, source: []const u8, main_mod: *Package.Module, global_cache_directory: Cache.Directory, local_cache_directory: Cache.Directory, builtin_mod: *Package.Module, global_options: Compilation.Config, ) !*Package.Module { // Atomically create the file in a directory named after the hash of its contents. const basename = "dependencies.zig"; const rand_int = std.crypto.random.int(u64); const tmp_dir_sub_path = "tmp" ++ fs.path.sep_str ++ Package.Manifest.hex64(rand_int); { var tmp_dir = try local_cache_directory.handle.makeOpenPath(tmp_dir_sub_path, .{}); defer tmp_dir.close(); try tmp_dir.writeFile(basename, source); } var hh: Cache.HashHelper = .{}; hh.addBytes(build_options.version); hh.addBytes(source); const hex_digest = hh.final(); const o_dir_sub_path = try arena.dupe(u8, "o" ++ fs.path.sep_str ++ hex_digest); try Package.Fetch.renameTmpIntoCache( local_cache_directory.handle, tmp_dir_sub_path, o_dir_sub_path, ); const deps_mod = try Package.Module.create(arena, .{ .global_cache_directory = global_cache_directory, .paths = .{ .root = .{ .root_dir = local_cache_directory, .sub_path = o_dir_sub_path, }, .root_src_path = basename, }, .fully_qualified_name = "root.@dependencies", .parent = main_mod, .builtin_mod = builtin_mod, .cc_argv = &.{}, .inherited = .{}, .global = global_options, }); try main_mod.deps.put(arena, "@dependencies", deps_mod); return deps_mod; } const BuildRoot = struct { directory: Cache.Directory, build_zig_basename: []const u8, cleanup_build_dir: ?fs.Dir, fn deinit(br: *BuildRoot) void { if (br.cleanup_build_dir) |*dir| dir.close(); br.* = undefined; } }; const FindBuildRootOptions = struct { build_file: ?[]const u8 = null, cwd_path: ?[]const u8 = null, }; fn findBuildRoot(arena: Allocator, options: FindBuildRootOptions) !BuildRoot { const cwd_path = options.cwd_path orelse try process.getCwdAlloc(arena); const build_zig_basename = if (options.build_file) |bf| fs.path.basename(bf) else Package.build_zig_basename; if (options.build_file) |bf| { if (fs.path.dirname(bf)) |dirname| { const dir = fs.cwd().openDir(dirname, .{}) catch |err| { fatal("unable to open directory to build file from argument 'build-file', '{s}': {s}", .{ dirname, @errorName(err) }); }; return .{ .build_zig_basename = build_zig_basename, .directory = .{ .path = dirname, .handle = dir }, .cleanup_build_dir = dir, }; } return .{ .build_zig_basename = build_zig_basename, .directory = .{ .path = null, .handle = fs.cwd() }, .cleanup_build_dir = null, }; } // Search up parent directories until we find build.zig. var dirname: []const u8 = cwd_path; while (true) { const joined_path = try fs.path.join(arena, &[_][]const u8{ dirname, build_zig_basename }); if (fs.cwd().access(joined_path, .{})) |_| { const dir = fs.cwd().openDir(dirname, .{}) catch |err| { fatal("unable to open directory while searching for build.zig file, '{s}': {s}", .{ dirname, @errorName(err) }); }; return .{ .build_zig_basename = build_zig_basename, .directory = .{ .path = dirname, .handle = dir, }, .cleanup_build_dir = dir, }; } else |err| switch (err) { error.FileNotFound => { dirname = fs.path.dirname(dirname) orelse { std.log.info("initialize {s} template file with 'zig init'", .{ Package.build_zig_basename, }); std.log.info("see 'zig --help' for more options", .{}); fatal("no build.zig file found, in the current directory or any parent directories", .{}); }; continue; }, else => |e| return e, } } } const LoadManifestOptions = struct { root_name: []const u8, dir: fs.Dir, color: Color, }; fn loadManifest( gpa: Allocator, arena: Allocator, options: LoadManifestOptions, ) !struct { Package.Manifest, Ast } { const manifest_bytes = while (true) { break options.dir.readFileAllocOptions( arena, Package.Manifest.basename, Package.Manifest.max_bytes, null, 1, 0, ) catch |err| switch (err) { error.FileNotFound => { var templates = findTemplates(gpa, arena); defer templates.deinit(); templates.write(arena, options.dir, options.root_name, Package.Manifest.basename) catch |e| { fatal("unable to write {s}: {s}", .{ Package.Manifest.basename, @errorName(e), }); }; continue; }, else => |e| fatal("unable to load {s}: {s}", .{ Package.Manifest.basename, @errorName(e), }), }; }; var ast = try Ast.parse(gpa, manifest_bytes, .zon); errdefer ast.deinit(gpa); if (ast.errors.len > 0) { try std.zig.printAstErrorsToStderr(gpa, ast, Package.Manifest.basename, options.color); process.exit(2); } var manifest = try Package.Manifest.parse(gpa, ast, .{}); errdefer manifest.deinit(gpa); if (manifest.errors.len > 0) { var wip_errors: std.zig.ErrorBundle.Wip = undefined; try wip_errors.init(gpa); defer wip_errors.deinit(); const src_path = try wip_errors.addString(Package.Manifest.basename); try manifest.copyErrorsIntoBundle(ast, src_path, &wip_errors); var error_bundle = try wip_errors.toOwnedBundle(""); defer error_bundle.deinit(gpa); error_bundle.renderToStdErr(options.color.renderOptions()); process.exit(2); } return .{ manifest, ast }; } const Templates = struct { zig_lib_directory: Cache.Directory, dir: fs.Dir, buffer: std.ArrayList(u8), fn deinit(templates: *Templates) void { templates.zig_lib_directory.handle.close(); templates.dir.close(); templates.buffer.deinit(); templates.* = undefined; } fn write( templates: *Templates, arena: Allocator, out_dir: fs.Dir, root_name: []const u8, template_path: []const u8, ) !void { if (fs.path.dirname(template_path)) |dirname| { out_dir.makePath(dirname) catch |err| { fatal("unable to make path '{s}': {s}", .{ dirname, @errorName(err) }); }; } const max_bytes = 10 * 1024 * 1024; const contents = templates.dir.readFileAlloc(arena, template_path, max_bytes) catch |err| { fatal("unable to read template file '{s}': {s}", .{ template_path, @errorName(err) }); }; templates.buffer.clearRetainingCapacity(); try templates.buffer.ensureUnusedCapacity(contents.len); for (contents) |c| { if (c == '$') { try templates.buffer.appendSlice(root_name); } else { try templates.buffer.append(c); } } return out_dir.writeFile2(.{ .sub_path = template_path, .data = templates.buffer.items, .flags = .{ .exclusive = true }, }); } }; fn findTemplates(gpa: Allocator, arena: Allocator) Templates { const self_exe_path = introspect.findZigExePath(arena) catch |err| { fatal("unable to find self exe path: {s}", .{@errorName(err)}); }; var zig_lib_directory = introspect.findZigLibDirFromSelfExe(arena, self_exe_path) catch |err| { fatal("unable to find zig installation directory: {s}", .{@errorName(err)}); }; const s = fs.path.sep_str; const template_sub_path = "init"; const template_dir = zig_lib_directory.handle.openDir(template_sub_path, .{}) catch |err| { const path = zig_lib_directory.path orelse "."; fatal("unable to open zig project template directory '{s}{s}{s}': {s}", .{ path, s, template_sub_path, @errorName(err), }); }; return .{ .zig_lib_directory = zig_lib_directory, .dir = template_dir, .buffer = std.ArrayList(u8).init(gpa), }; } fn parseOptimizeMode(s: []const u8) std.builtin.OptimizeMode { return std.meta.stringToEnum(std.builtin.OptimizeMode, s) orelse fatal("unrecognized optimization mode: '{s}'", .{s}); } fn parseWasiExecModel(s: []const u8) std.builtin.WasiExecModel { return std.meta.stringToEnum(std.builtin.WasiExecModel, s) orelse fatal("expected [command|reactor] for -mexec-mode=[value], found '{s}'", .{s}); } fn parseStackSize(s: []const u8) u64 { return std.fmt.parseUnsigned(u64, s, 0) catch |err| fatal("unable to parse stack size '{s}': {s}", .{ s, @errorName(err) }); } fn parseImageBase(s: []const u8) u64 { return std.fmt.parseUnsigned(u64, s, 0) catch |err| fatal("unable to parse image base '{s}': {s}", .{ s, @errorName(err) }); } fn handleModArg( arena: Allocator, mod_name: []const u8, opt_root_src_orig: ?[]const u8, create_module: *CreateModule, mod_opts: *Package.Module.CreateOptions.Inherited, cc_argv: *std.ArrayListUnmanaged([]const u8), target_arch_os_abi: *?[]const u8, target_mcpu: *?[]const u8, deps: *std.ArrayListUnmanaged(CliModule.Dep), c_source_files_owner_index: *usize, rc_source_files_owner_index: *usize, cssan: *ClangSearchSanitizer, ) !void { const gop = try create_module.modules.getOrPut(arena, mod_name); if (gop.found_existing) { fatal("unable to add module '{s}': already exists as '{s}'", .{ mod_name, gop.value_ptr.paths.root_src_path, }); } // See duplicate logic: ModCreationGlobalFlags if (mod_opts.single_threaded == false) create_module.opts.any_non_single_threaded = true; if (mod_opts.sanitize_thread == true) create_module.opts.any_sanitize_thread = true; if (mod_opts.unwind_tables == true) create_module.opts.any_unwind_tables = true; if (mod_opts.strip == false) create_module.opts.any_non_stripped = true; if (mod_opts.error_tracing == true) create_module.opts.any_error_tracing = true; gop.value_ptr.* = .{ .paths = p: { if (opt_root_src_orig) |root_src_orig| { create_module.opts.have_zcu = true; const root_src = try introspect.resolvePath(arena, root_src_orig); break :p .{ .root = .{ .root_dir = Cache.Directory.cwd(), .sub_path = fs.path.dirname(root_src) orelse "", }, .root_src_path = fs.path.basename(root_src), }; } break :p .{ .root = .{ .root_dir = Cache.Directory.cwd() }, .root_src_path = "", }; }, .cc_argv = try cc_argv.toOwnedSlice(arena), .inherited = mod_opts.*, .target_arch_os_abi = target_arch_os_abi.*, .target_mcpu = target_mcpu.*, .deps = try deps.toOwnedSlice(arena), .resolved = null, .c_source_files_start = c_source_files_owner_index.*, .c_source_files_end = create_module.c_source_files.items.len, .rc_source_files_start = rc_source_files_owner_index.*, .rc_source_files_end = create_module.rc_source_files.items.len, }; cssan.reset(); mod_opts.* = .{}; target_arch_os_abi.* = null; target_mcpu.* = null; c_source_files_owner_index.* = create_module.c_source_files.items.len; rc_source_files_owner_index.* = create_module.rc_source_files.items.len; }