authorgravatar for xavierb@gmail.comXavier Bouchoux <xavierb@gmail.com> 2023-08-12 06:50:10+00:00
committergravatar for xavierb@gmail.comXavier Bouchoux <xavierb@gmail.com> 2023-08-12 09:54:35+02:00
log2da28d93dec0e9e484076def63e690384a4a5b1f
treee30aad29afc3c65b1b32dd192113e520718825b0
parentaecc15391a4c37a4504d29cb7e3179990b180773

build/ObjCopy: strip debug info to a separate elf file.

example usage: if (!strip) { b.installArtifact(exe); } else { const stripped_exe = b.addObjCopy(exe.getEmittedBin(), .{ .basename = exe.out_filename, // set the name for the debuglink .compress_debug = true, .strip = .debug_and_symbols, .extract_to_separate_file = true, }); b.getInstallStep().dependOn(&b.addInstallBinFile(stripped_exe.getOutput(), exe.out_filename).step); b.getInstallStep().dependOn(&b.addInstallBinFile(stripped_exe.getOutputSeparatedDebug().?, b.fmt("{s}.debug", .{exe.out_filename})).step); }

1 files changed, 47 insertions(+), 2 deletions(-)

lib/std/Build/Step/ObjCopy.zig+47-2
......@@ -17,22 +17,40 @@ pub const base_id: Step.Id = .objcopy;
1717pub const RawFormat = enum {
1818 bin,
1919 hex,
20 elf,
21};
22
23pub const Strip = enum {
24 none,
25 debug,
26 debug_and_symbols,
2027};
2128
2229step: Step,
2330input_file: std.Build.LazyPath,
2431basename: []const u8,
2532output_file: std.Build.GeneratedFile,
33output_file_debug: ?std.Build.GeneratedFile,
2634
2735format: ?RawFormat,
2836only_section: ?[]const u8,
2937pad_to: ?u64,
38strip: Strip,
39compress_debug: bool,
3040
3141pub const Options = struct {
3242 basename: ?[]const u8 = null,
3343 format: ?RawFormat = null,
3444 only_section: ?[]const u8 = null,
3545 pad_to: ?u64 = null,
46
47 compress_debug: bool = false,
48 strip: Strip = .none,
49
50 /// Put the stripped out debug sections in a separate file.
51 /// note: the `basename` is baked into the elf file to specify the link to the separate debug file.
52 /// see https://sourceware.org/gdb/onlinedocs/gdb/Separate-Debug-Files.html
53 extract_to_separate_file: bool = false,
3654};
3755
3856pub fn create(
......@@ -51,10 +69,12 @@ pub fn create(
5169 .input_file = input_file,
5270 .basename = options.basename orelse input_file.getDisplayName(),
5371 .output_file = std.Build.GeneratedFile{ .step = &self.step },
54
72 .output_file_debug = if (options.strip != .none and options.extract_to_separate_file) std.Build.GeneratedFile{ .step = &self.step } else null,
5573 .format = options.format,
5674 .only_section = options.only_section,
5775 .pad_to = options.pad_to,
76 .strip = options.strip,
77 .compress_debug = options.compress_debug,
5878 };
5979 input_file.addStepDependencies(&self.step);
6080 return self;
......@@ -66,6 +86,9 @@ pub const getOutputSource = getOutput;
6686pub fn getOutput(self: *const ObjCopy) std.Build.LazyPath {
6787 return .{ .generated = &self.output_file };
6888}
89pub fn getOutputSeparatedDebug(self: *const ObjCopy) ?std.Build.LazyPath {
90 return if (self.output_file_debug) |*file| .{ .generated = file } else null;
91}
6992
7093fn make(step: *Step, prog_node: *std.Progress.Node) !void {
7194 const b = step.owner;
......@@ -83,6 +106,9 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
83106 man.hash.addOptionalBytes(self.only_section);
84107 man.hash.addOptional(self.pad_to);
85108 man.hash.addOptional(self.format);
109 man.hash.add(self.compress_debug);
110 man.hash.add(self.strip);
111 man.hash.add(self.output_file_debug != null);
86112
87113 if (try step.cacheHit(&man)) {
88114 // Cache hit, skip subprocess execution.
......@@ -90,12 +116,18 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
90116 self.output_file.path = try b.cache_root.join(b.allocator, &.{
91117 "o", &digest, self.basename,
92118 });
119 if (self.output_file_debug) |*file| {
120 file.path = try b.cache_root.join(b.allocator, &.{
121 "o", &digest, b.fmt("{s}.debug", .{self.basename}),
122 });
123 }
93124 return;
94125 }
95126
96127 const digest = man.final();
97 const full_dest_path = try b.cache_root.join(b.allocator, &.{ "o", &digest, self.basename });
98128 const cache_path = "o" ++ fs.path.sep_str ++ digest;
129 const full_dest_path = try b.cache_root.join(b.allocator, &.{ cache_path, self.basename });
130 const full_dest_path_debug = try b.cache_root.join(b.allocator, &.{ cache_path, b.fmt("{s}.debug", .{self.basename}) });
99131 b.cache_root.handle.makePath(cache_path) catch |err| {
100132 return step.fail("unable to make path {s}: {s}", .{ cache_path, @errorName(err) });
101133 };
......@@ -106,13 +138,25 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
106138 if (self.only_section) |only_section| {
107139 try argv.appendSlice(&.{ "-j", only_section });
108140 }
141 switch (self.strip) {
142 .none => {},
143 .debug => try argv.appendSlice(&.{"--strip-debug"}),
144 .debug_and_symbols => try argv.appendSlice(&.{"--strip-all"}),
145 }
109146 if (self.pad_to) |pad_to| {
110147 try argv.appendSlice(&.{ "--pad-to", b.fmt("{d}", .{pad_to}) });
111148 }
112149 if (self.format) |format| switch (format) {
113150 .bin => try argv.appendSlice(&.{ "-O", "binary" }),
114151 .hex => try argv.appendSlice(&.{ "-O", "hex" }),
152 .elf => try argv.appendSlice(&.{ "-O", "elf" }),
115153 };
154 if (self.compress_debug) {
155 try argv.appendSlice(&.{"--compress-debug-sections"});
156 }
157 if (self.output_file_debug != null) {
158 try argv.appendSlice(&.{b.fmt("--extract-to={s}", .{full_dest_path_debug})});
159 }
116160
117161 try argv.appendSlice(&.{ full_src_path, full_dest_path });
118162
......@@ -120,5 +164,6 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
120164 _ = try step.evalZigProcess(argv.items, prog_node);
121165
122166 self.output_file.path = full_dest_path;
167 if (self.output_file_debug) |*file| file.path = full_dest_path_debug;
123168 try man.writeManifest();
124169}