authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2020-11-30 16:40:25-07:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2020-11-30 16:50:56-07:00
log791e38da8c416b62e4e30f4c9cb44fd6f26442a5
tree97bc088985627d86d3315821fc47d7c7ff0e17e5
parent1a61a9d4bf37183282de8a09431ed1baaf049999

Merge branch 'alexnask-bundle_compiler_rt' into master

Closes #7013 Closes #6817

5 files changed, 104 insertions(+), 33 deletions(-)

lib/std/build.zig+7-4
......@@ -1216,7 +1216,7 @@ pub const LibExeObjStep = struct {
12161216 emit_bin: bool = true,
12171217 emit_docs: bool = false,
12181218 emit_h: bool = false,
1219 bundle_compiler_rt: bool,
1219 bundle_compiler_rt: ?bool = null,
12201220 disable_stack_probing: bool,
12211221 disable_sanitize_c: bool,
12221222 rdynamic: bool,
......@@ -1392,7 +1392,6 @@ pub const LibExeObjStep = struct {
13921392 .exec_cmd_args = null,
13931393 .name_prefix = "",
13941394 .filter = null,
1395 .bundle_compiler_rt = false,
13961395 .disable_stack_probing = false,
13971396 .disable_sanitize_c = false,
13981397 .rdynamic = false,
......@@ -2117,8 +2116,12 @@ pub const LibExeObjStep = struct {
21172116 if (self.is_dynamic) {
21182117 try zig_args.append("-dynamic");
21192118 }
2120 if (self.bundle_compiler_rt) {
2121 try zig_args.append("--bundle-compiler-rt");
2119 if (self.bundle_compiler_rt) |x| {
2120 if (x) {
2121 try zig_args.append("-fcompiler-rt");
2122 } else {
2123 try zig_args.append("-fno-compiler-rt");
2124 }
21222125 }
21232126 if (self.disable_stack_probing) {
21242127 try zig_args.append("-fno-stack-check");
src/Compilation.zig+57-20
......@@ -93,6 +93,9 @@ libc_static_lib: ?CRTFile = null,
9393/// Populated when we build the libcompiler_rt static library. A Job to build this is placed in the queue
9494/// and resolved before calling linker.flush().
9595compiler_rt_static_lib: ?CRTFile = null,
96/// Populated when we build the compiler_rt_obj object. A Job to build this is placed in the queue
97/// and resolved before calling linker.flush().
98compiler_rt_obj: ?CRTFile = null,
9699
97100glibc_so_files: ?glibc.BuiltSharedObjects = null,
98101
......@@ -164,8 +167,8 @@ const Job = union(enum) {
164167 libcxx: void,
165168 libcxxabi: void,
166169 libssp: void,
167 /// needed when producing a dynamic library or executable
168 libcompiler_rt: void,
170 compiler_rt_lib: void,
171 compiler_rt_obj: void,
169172 /// needed when not linking libc and using LLVM for code generation because it generates
170173 /// calls to, for example, memcpy and memset.
171174 zig_libc: void,
......@@ -346,6 +349,7 @@ pub const InitOptions = struct {
346349 want_sanitize_c: ?bool = null,
347350 want_stack_check: ?bool = null,
348351 want_valgrind: ?bool = null,
352 want_compiler_rt: ?bool = null,
349353 use_llvm: ?bool = null,
350354 use_lld: ?bool = null,
351355 use_clang: ?bool = null,
......@@ -405,6 +409,9 @@ pub fn create(gpa: *Allocator, options: InitOptions) !*Compilation {
405409 .Lib => is_dyn_lib,
406410 .Exe => true,
407411 };
412 const needs_c_symbols = !options.is_compiler_rt_or_libc and
413 (is_exe_or_dyn_lib or (options.target.isWasm() and options.output_mode != .Obj));
414
408415 const comp: *Compilation = comp: {
409416 // For allocations that have the same lifetime as Compilation. This arena is used only during this
410417 // initialization and then is freed in deinit().
......@@ -568,6 +575,8 @@ pub fn create(gpa: *Allocator, options: InitOptions) !*Compilation {
568575 break :b options.want_valgrind orelse (options.optimize_mode == .Debug);
569576 };
570577
578 const include_compiler_rt = options.want_compiler_rt orelse needs_c_symbols;
579
571580 const single_threaded = options.single_threaded or target_util.isSingleThreaded(options.target);
572581
573582 const llvm_cpu_features: ?[*:0]const u8 = if (build_options.have_llvm and use_llvm) blk: {
......@@ -803,6 +812,7 @@ pub fn create(gpa: *Allocator, options: InitOptions) !*Compilation {
803812 .z_defs = options.linker_z_defs,
804813 .stack_size_override = options.stack_size_override,
805814 .image_base_override = options.image_base_override,
815 .include_compiler_rt = include_compiler_rt,
806816 .linker_script = options.linker_script,
807817 .version_script = options.version_script,
808818 .gc_sections = options.linker_gc_sections,
......@@ -947,16 +957,31 @@ pub fn create(gpa: *Allocator, options: InitOptions) !*Compilation {
947957 try comp.work_queue.writeItem(.libcxxabi);
948958 }
949959
950 const needs_compiler_rt_and_c = is_exe_or_dyn_lib or
951 (comp.getTarget().isWasm() and comp.bin_file.options.output_mode != .Obj);
952 if (needs_compiler_rt_and_c and build_options.is_stage1) {
953 try comp.work_queue.writeItem(.{ .libcompiler_rt = {} });
954 // MinGW provides no libssp, use our own implementation.
955 if (comp.getTarget().isMinGW()) {
956 try comp.work_queue.writeItem(.{ .libssp = {} });
960 // The `is_stage1` condition is here only because stage2 cannot yet build compiler-rt.
961 // Once it is capable this condition should be removed.
962 if (build_options.is_stage1) {
963 if (comp.bin_file.options.include_compiler_rt) {
964 if (is_exe_or_dyn_lib) {
965 try comp.work_queue.writeItem(.{ .compiler_rt_lib = {} });
966 } else {
967 try comp.work_queue.writeItem(.{ .compiler_rt_obj = {} });
968 if (comp.bin_file.options.object_format != .elf) {
969 // For ELF we can rely on using -r to link multiple objects together into one,
970 // but to truly support `build-obj -fcompiler-rt` will require virtually
971 // injecting `_ = @import("compiler_rt.zig")` into the root source file of
972 // the compilation.
973 fatal("Embedding compiler-rt into non-ELF objects is not yet implemented.", .{});
974 }
975 }
957976 }
958 if (!comp.bin_file.options.link_libc) {
959 try comp.work_queue.writeItem(.{ .zig_libc = {} });
977 if (needs_c_symbols) {
978 // MinGW provides no libssp, use our own implementation.
979 if (comp.getTarget().isMinGW()) {
980 try comp.work_queue.writeItem(.{ .libssp = {} });
981 }
982 if (!comp.bin_file.options.link_libc) {
983 try comp.work_queue.writeItem(.{ .zig_libc = {} });
984 }
960985 }
961986 }
962987 }
......@@ -1354,20 +1379,26 @@ pub fn performAllTheWork(self: *Compilation) error{ TimerUnsupported, OutOfMemor
13541379 fatal("unable to build libcxxabi: {}", .{@errorName(err)});
13551380 };
13561381 },
1357 .libcompiler_rt => {
1358 self.buildStaticLibFromZig("compiler_rt.zig", &self.compiler_rt_static_lib) catch |err| {
1382 .compiler_rt_lib => {
1383 self.buildOutputFromZig("compiler_rt.zig", .Lib, &self.compiler_rt_static_lib) catch |err| {
13591384 // TODO Expose this as a normal compile error rather than crashing here.
1360 fatal("unable to build compiler_rt: {}", .{@errorName(err)});
1385 fatal("unable to build compiler_rt: {s}", .{@errorName(err)});
1386 };
1387 },
1388 .compiler_rt_obj => {
1389 self.buildOutputFromZig("compiler_rt.zig", .Obj, &self.compiler_rt_obj) catch |err| {
1390 // TODO Expose this as a normal compile error rather than crashing here.
1391 fatal("unable to build compiler_rt: {s}", .{@errorName(err)});
13611392 };
13621393 },
13631394 .libssp => {
1364 self.buildStaticLibFromZig("ssp.zig", &self.libssp_static_lib) catch |err| {
1395 self.buildOutputFromZig("ssp.zig", .Lib, &self.libssp_static_lib) catch |err| {
13651396 // TODO Expose this as a normal compile error rather than crashing here.
13661397 fatal("unable to build libssp: {}", .{@errorName(err)});
13671398 };
13681399 },
13691400 .zig_libc => {
1370 self.buildStaticLibFromZig("c.zig", &self.libc_static_lib) catch |err| {
1401 self.buildOutputFromZig("c.zig", .Lib, &self.libc_static_lib) catch |err| {
13711402 // TODO Expose this as a normal compile error rather than crashing here.
13721403 fatal("unable to build zig's multitarget libc: {}", .{@errorName(err)});
13731404 };
......@@ -2531,10 +2562,16 @@ pub fn updateSubCompilation(sub_compilation: *Compilation) !void {
25312562 }
25322563}
25332564
2534fn buildStaticLibFromZig(comp: *Compilation, src_basename: []const u8, out: *?CRTFile) !void {
2565fn buildOutputFromZig(
2566 comp: *Compilation,
2567 src_basename: []const u8,
2568 output_mode: std.builtin.OutputMode,
2569 out: *?CRTFile,
2570) !void {
25352571 const tracy = trace(@src());
25362572 defer tracy.end();
25372573
2574 std.debug.assert(output_mode != .Exe);
25382575 const special_sub = "std" ++ std.fs.path.sep_str ++ "special";
25392576 const special_path = try comp.zig_lib_directory.join(comp.gpa, &[_][]const u8{special_sub});
25402577 defer comp.gpa.free(special_path);
......@@ -2551,11 +2588,11 @@ fn buildStaticLibFromZig(comp: *Compilation, src_basename: []const u8, out: *?CR
25512588 };
25522589 const root_name = mem.split(src_basename, ".").next().?;
25532590 const target = comp.getTarget();
2554 const output_mode: std.builtin.OutputMode = if (target.cpu.arch.isWasm()) .Obj else .Lib;
2591 const fixed_output_mode = if (target.cpu.arch.isWasm()) .Obj else output_mode;
25552592 const bin_basename = try std.zig.binNameAlloc(comp.gpa, .{
25562593 .root_name = root_name,
25572594 .target = target,
2558 .output_mode = output_mode,
2595 .output_mode = fixed_output_mode,
25592596 });
25602597 defer comp.gpa.free(bin_basename);
25612598
......@@ -2578,7 +2615,7 @@ fn buildStaticLibFromZig(comp: *Compilation, src_basename: []const u8, out: *?CR
25782615 .target = target,
25792616 .root_name = root_name,
25802617 .root_pkg = &root_pkg,
2581 .output_mode = output_mode,
2618 .output_mode = fixed_output_mode,
25822619 .rand = comp.rand,
25832620 .libc_installation = comp.bin_file.options.libc_installation,
25842621 .emit_bin = emit_bin,
src/link.zig+11-1
......@@ -46,6 +46,7 @@ pub const Options = struct {
4646 entry_addr: ?u64 = null,
4747 stack_size_override: ?u64,
4848 image_base_override: ?u64,
49 include_compiler_rt: bool,
4950 /// Set to `true` to omit debug info.
5051 strip: bool,
5152 /// If this is true then this link code is responsible for outputting an object
......@@ -450,6 +451,11 @@ pub const File = struct {
450451 break :blk full_obj_path;
451452 } else null;
452453
454 const compiler_rt_path: ?[]const u8 = if (base.options.include_compiler_rt)
455 comp.compiler_rt_obj.?.full_object_path
456 else
457 null;
458
453459 // This function follows the same pattern as link.Elf.linkWithLLD so if you want some
454460 // insight as to what's going on here you can read that function body which is more
455461 // well-commented.
......@@ -466,6 +472,7 @@ pub const File = struct {
466472 _ = try ch.addFile(entry.key.status.success.object_path, null);
467473 }
468474 try ch.addOptionalFile(module_obj_path);
475 try ch.addOptionalFile(compiler_rt_path);
469476
470477 // We don't actually care whether it's a cache hit or miss; we just need the digest and the lock.
471478 _ = try ch.hit();
......@@ -495,7 +502,7 @@ pub const File = struct {
495502 var object_files = std.ArrayList([*:0]const u8).init(base.allocator);
496503 defer object_files.deinit();
497504
498 try object_files.ensureCapacity(base.options.objects.len + comp.c_object_table.items().len + 1);
505 try object_files.ensureCapacity(base.options.objects.len + comp.c_object_table.items().len + 2);
499506 for (base.options.objects) |obj_path| {
500507 object_files.appendAssumeCapacity(try arena.dupeZ(u8, obj_path));
501508 }
......@@ -505,6 +512,9 @@ pub const File = struct {
505512 if (module_obj_path) |p| {
506513 object_files.appendAssumeCapacity(try arena.dupeZ(u8, p));
507514 }
515 if (compiler_rt_path) |p| {
516 object_files.appendAssumeCapacity(try arena.dupeZ(u8, p));
517 }
508518
509519 const full_out_path = try directory.join(arena, &[_][]const u8{base.options.emit.?.sub_path});
510520 const full_out_path_z = try arena.dupeZ(u8, full_out_path);
src/link/Elf.zig+17-6
......@@ -1260,6 +1260,13 @@ fn linkWithLLD(self: *Elf, comp: *Compilation) !void {
12601260 const gc_sections = self.base.options.gc_sections orelse !is_obj;
12611261 const stack_size = self.base.options.stack_size_override orelse 16777216;
12621262 const allow_shlib_undefined = self.base.options.allow_shlib_undefined orelse !self.base.options.is_native_os;
1263 const compiler_rt_path: ?[]const u8 = if (self.base.options.include_compiler_rt) blk: {
1264 if (is_exe_or_dyn_lib) {
1265 break :blk comp.compiler_rt_static_lib.?.full_object_path;
1266 } else {
1267 break :blk comp.compiler_rt_obj.?.full_object_path;
1268 }
1269 } else null;
12631270
12641271 // Here we want to determine whether we can save time by not invoking LLD when the
12651272 // output is unchanged. None of the linker options or the object files that are being
......@@ -1289,6 +1296,8 @@ fn linkWithLLD(self: *Elf, comp: *Compilation) !void {
12891296 _ = try man.addFile(entry.key.status.success.object_path, null);
12901297 }
12911298 try man.addOptionalFile(module_obj_path);
1299 try man.addOptionalFile(compiler_rt_path);
1300
12921301 // We can skip hashing libc and libc++ components that we are in charge of building from Zig
12931302 // installation sources because they are always a product of the compiler version + target information.
12941303 man.hash.add(stack_size);
......@@ -1524,12 +1533,14 @@ fn linkWithLLD(self: *Elf, comp: *Compilation) !void {
15241533 try argv.append(p);
15251534 }
15261535
1527 // compiler-rt and libc
1528 if (is_exe_or_dyn_lib and !self.base.options.is_compiler_rt_or_libc) {
1529 if (!self.base.options.link_libc) {
1530 try argv.append(comp.libc_static_lib.?.full_object_path);
1531 }
1532 try argv.append(comp.compiler_rt_static_lib.?.full_object_path);
1536 // libc
1537 if (is_exe_or_dyn_lib and !self.base.options.is_compiler_rt_or_libc and !self.base.options.link_libc) {
1538 try argv.append(comp.libc_static_lib.?.full_object_path);
1539 }
1540
1541 // compiler-rt
1542 if (compiler_rt_path) |p| {
1543 try argv.append(p);
15331544 }
15341545
15351546 // Shared libraries.
src/main.zig+12-2
......@@ -304,8 +304,12 @@ const usage_build_generic =
304304 \\ --version-script [path] Provide a version .map file
305305 \\ --dynamic-linker [path] Set the dynamic interpreter path (usually ld.so)
306306 \\ --version [ver] Dynamic library semver
307 \\ -fsoname[=name] (linux) Override the default SONAME value
308 \\ -fno-soname (linux) Disable emitting a SONAME
307 \\ -fsoname[=name] (Linux) Override the default SONAME value
308 \\ -fno-soname (Linux) Disable emitting a SONAME
309 \\ -fLLD Force using LLD as the linker
310 \\ -fno-LLD Prevent using LLD as the linker
311 \\ -fcompiler-rt Always include compiler-rt symbols in output
312 \\ -fno-compiler-rt Prevent including compiler-rt symbols in output
309313 \\ -rdynamic Add all symbols to the dynamic symbol table
310314 \\ -rpath [path] Add directory to the runtime library search path
311315 \\ -feach-lib-rpath Ensure adding rpath for each used dynamic library
......@@ -469,6 +473,7 @@ fn buildOutputType(
469473 var want_sanitize_c: ?bool = null;
470474 var want_stack_check: ?bool = null;
471475 var want_valgrind: ?bool = null;
476 var want_compiler_rt: ?bool = null;
472477 var rdynamic: bool = false;
473478 var linker_script: ?[]const u8 = null;
474479 var version_script: ?[]const u8 = null;
......@@ -785,6 +790,10 @@ fn buildOutputType(
785790 if (i + 1 >= args.len) fatal("expected parameter after {}", .{arg});
786791 i += 1;
787792 override_lib_dir = args[i];
793 } else if (mem.eql(u8, arg, "-fcompiler-rt")) {
794 want_compiler_rt = true;
795 } else if (mem.eql(u8, arg, "-fno-compiler-rt")) {
796 want_compiler_rt = false;
788797 } else if (mem.eql(u8, arg, "-feach-lib-rpath")) {
789798 each_lib_rpath = true;
790799 } else if (mem.eql(u8, arg, "-fno-each-lib-rpath")) {
......@@ -1667,6 +1676,7 @@ fn buildOutputType(
16671676 .want_sanitize_c = want_sanitize_c,
16681677 .want_stack_check = want_stack_check,
16691678 .want_valgrind = want_valgrind,
1679 .want_compiler_rt = want_compiler_rt,
16701680 .use_llvm = use_llvm,
16711681 .use_lld = use_lld,
16721682 .use_clang = use_clang,