Commit b2718e213ed7e7cd8bcd85bdf49d7ae33c857c58 | zig

author	Luuk de Gram <luuk@degram.dev> 2022-09-02 21:13:59+02:00
committer	Luuk de Gram <luuk@degram.dev> 2022-09-07 18:53:16+02:00
log	b2718e213ed7e7cd8bcd85bdf49d7ae33c857c58
tree	20879860762e6645ed26f747221b821a0b1e6405
parent	46c932a2c9650f14ae8035d7382d825bfabdc0a5
signature	Commit is signed but in an unrecognized format.

wasm-linker: use Atoms for zig debug info

Previously we used single arraylists for each debug section for debug
information that was generated from Zig code. (e.i. `Module` is available).
This information is now stored in Atoms, similarly to debug information
from object files. This will allow us to link them together and resolve
debug relocations.

2 files changed, 45 insertions(+), 57 deletions(-)

src
- link
  - Dwarf.zig
  - Wasm.zig

src/link/Dwarf.zig+29-16

 @@ -861,7 +861,9 @@ pub fn commitDeclState(
                             },
                             .wasm => {
                                 const wasm_file = file.cast(File.Wasm).?;
-                                writeDbgLineNopsBuffered(wasm_file.debug_line.items, src_fn.off, 0, &.{}, src_fn.len);
+                                const segment_index = wasm_file.debug_line_index.?;
+                                const debug_line = wasm_file.atoms.get(segment_index).?.code;
+                                writeDbgLineNopsBuffered(debug_line.items, src_fn.off, 0, &.{}, src_fn.len);
                             },
                             else => unreachable,
                         }
 @@ -972,9 +974,9 @@ pub fn commitDeclState(
                 },
                 .wasm => {
                     const wasm_file = file.cast(File.Wasm).?;
-                    const segment_index = try wasm_file.getDebugLineIndex();
+                    const segment_index = try wasm_file.getOrSetDebugIndex(&wasm_file.debug_line_index);
                     const segment = &wasm_file.segments.items[segment_index];
-                    const debug_line = &wasm_file.debug_line;
+                    const debug_line = &wasm_file.atoms.get(segment_index).?.code;
                     if (needed_size != segment.size) {
                         log.debug(" needed size does not equal allocated size: {d}", .{needed_size});
                         if (needed_size > segment.size) {
 @@ -1146,10 +1148,11 @@ fn updateDeclDebugInfoAllocation(self: *Dwarf, file: *File, atom: *Atom, len: u3
                     },
                     .wasm => {
                         const wasm_file = file.cast(File.Wasm).?;
-                        const segment_index = try wasm_file.getDebugInfoIndex();
+                        const segment_index = try wasm_file.getOrSetDebugIndex(&wasm_file.debug_info_index);
                         const segment = &wasm_file.segments.items[segment_index];
+                        const debug_info = &wasm_file.atoms.get(segment_index).?.code;
                         const offset = segment.offset + atom.off;
-                        try writeDbgInfoNopsToArrayList(gpa, &wasm_file.debug_info, offset, 0, &.{0}, atom.len, false);
+                        try writeDbgInfoNopsToArrayList(gpa, debug_info, offset, 0, &.{0}, atom.len, false);
                     },
                     else => unreachable,
                 }
 @@ -1276,9 +1279,9 @@ fn writeDeclDebugInfo(self: *Dwarf, file: *File, atom: *Atom, dbg_info_buf: []co
         },
         .wasm => {
             const wasm_file = file.cast(File.Wasm).?;
-            const segment_index = try wasm_file.getDebugInfoIndex();
+            const segment_index = try wasm_file.getOrSetDebugIndex(&wasm_file.debug_info_index);
             const segment = &wasm_file.segments.items[segment_index];
-            const debug_info = &wasm_file.debug_info;
+            const debug_info = &wasm_file.atoms.get(segment_index).?.code;
             if (needed_size != segment.size) {
                 log.debug(" needed size does not equal allocated size: {d}", .{needed_size});
                 if (needed_size > segment.size) {
 @@ -1337,10 +1340,10 @@ pub fn updateDeclLineNumber(self: *Dwarf, file: *File, decl: *const Module.Decl)
         },
         .wasm => {
             const wasm_file = file.cast(File.Wasm).?;
-            const segment_index = wasm_file.getDebugLineIndex() catch unreachable;
+            const segment_index = wasm_file.debug_line_index.?;
             const segment = wasm_file.segments.items[segment_index];
             const offset = segment.offset + decl.fn_link.wasm.src_fn.off + self.getRelocDbgLineOff();
-            mem.copy(u8, wasm_file.debug_line.items[offset..], &data);
+            mem.copy(u8, wasm_file.atoms.get(segment_index).?.code.items[offset..], &data);
         },
         else => unreachable,
     }
 @@ -1576,8 +1579,10 @@ pub fn writeDbgAbbrev(self: *Dwarf, file: *File) !void {
         },
         .wasm => {
             const wasm_file = file.cast(File.Wasm).?;
-            try wasm_file.debug_abbrev.resize(wasm_file.base.allocator, needed_size);
+            const segment_index = try wasm_file.getOrSetDebugIndex(&wasm_file.debug_abbrev_index);
-            mem.copy(u8, wasm_file.debug_abbrev.items, &abbrev_buf);
+            const debug_abbrev = &wasm_file.atoms.get(segment_index).?.code;
+            try debug_abbrev.resize(wasm_file.base.allocator, needed_size);
+            mem.copy(u8, debug_abbrev.items, &abbrev_buf);
         },
         else => unreachable,
     }
 @@ -1687,7 +1692,9 @@ pub fn writeDbgInfoHeader(self: *Dwarf, file: *File, module: *Module, low_pc: u6
         },
         .wasm => {
             const wasm_file = file.cast(File.Wasm).?;
-            try writeDbgInfoNopsToArrayList(self.allocator, &wasm_file.debug_info, 0, 0, di_buf.items, jmp_amt, false);
+            const segment_index = wasm_file.debug_info_index.?;
+            const debug_info = &wasm_file.atoms.get(segment_index).?.code;
+            try writeDbgInfoNopsToArrayList(self.allocator, debug_info, 0, 0, di_buf.items, jmp_amt, false);
         },
         else => unreachable,
     }
 @@ -2016,8 +2023,10 @@ pub fn writeDbgAranges(self: *Dwarf, file: *File, addr: u64, size: u64) !void {
         },
         .wasm => {
             const wasm_file = file.cast(File.Wasm).?;
-            try wasm_file.debug_aranges.resize(wasm_file.base.allocator, needed_size);
+            const segment_index = try wasm_file.getOrSetDebugIndex(&wasm_file.debug_ranges_index);
-            mem.copy(u8, wasm_file.debug_aranges.items, di_buf.items);
+            const debug_ranges = &wasm_file.atoms.get(segment_index).?.code;
+            try debug_ranges.resize(wasm_file.base.allocator, needed_size);
+            mem.copy(u8, debug_ranges.items, di_buf.items);
         },
         else => unreachable,
     }
 @@ -2139,7 +2148,9 @@ pub fn writeDbgLineHeader(self: *Dwarf, file: *File, module: *Module) !void {
         },
         .wasm => {
             const wasm_file = file.cast(File.Wasm).?;
-            writeDbgLineNopsBuffered(wasm_file.debug_line.items, 0, 0, di_buf.items, jmp_amt);
+            const segment_index = wasm_file.debug_line_index.?;
+            const debug_line = wasm_file.atoms.get(segment_index).?.code;
+            writeDbgLineNopsBuffered(debug_line.items, 0, 0, di_buf.items, jmp_amt);
         },
         else => unreachable,
     }
 @@ -2287,7 +2298,9 @@ pub fn flushModule(self: *Dwarf, file: *File, module: *Module) !void {
                 },
                 .wasm => {
                     const wasm_file = file.cast(File.Wasm).?;
-                    mem.copy(u8, wasm_file.debug_info.items[reloc.atom.off + reloc.offset ..], &buf);
+                    const segment_index = wasm_file.debug_info_index.?;
+                    const debug_info = wasm_file.atoms.get(segment_index).?.code;
+                    mem.copy(u8, debug_info.items[reloc.atom.off + reloc.offset ..], &buf);
                 },
                 else => unreachable,
             }

src/link/Wasm.zig+16-41

...	@@ -103,16 +103,6 @@ string_table: StringTable = .{},	...	@@ -103,16 +103,6 @@ string_table: StringTable = .{},
103	/// Debug information for wasm	103	/// Debug information for wasm
104	dwarf: ?Dwarf = null,	104	dwarf: ?Dwarf = null,
105		105
106	// debug information //
107	/// Contains all bytes for the '.debug_info' section
108	debug_info: std.ArrayListUnmanaged(u8) = .{},
109	/// Contains all bytes for the '.debug_line' section
110	debug_line: std.ArrayListUnmanaged(u8) = .{},
111	/// Contains all bytes for the '.debug_abbrev' section
112	debug_abbrev: std.ArrayListUnmanaged(u8) = .{},
113	/// Contains all bytes for the '.debug_ranges' section
114	debug_aranges: std.ArrayListUnmanaged(u8) = .{},
115
116	// Output sections	106	// Output sections
117	/// Output type section	107	/// Output type section
118	func_types: std.ArrayListUnmanaged(wasm.Type) = .{},	108	func_types: std.ArrayListUnmanaged(wasm.Type) = .{},
...	@@ -716,11 +706,6 @@ pub fn deinit(self: *Wasm) void {	...	@@ -716,11 +706,6 @@ pub fn deinit(self: *Wasm) void {
716	if (self.dwarf) \|*dwarf\| {	706	if (self.dwarf) \|*dwarf\| {
717	dwarf.deinit();	707	dwarf.deinit();
718	}	708	}
719
720	self.debug_info.deinit(gpa);
721	self.debug_line.deinit(gpa);
722	self.debug_abbrev.deinit(gpa);
723	self.debug_aranges.deinit(gpa);
724	}	709	}
725		710
726	pub fn allocateDeclIndexes(self: *Wasm, decl_index: Module.Decl.Index) !void {	711	pub fn allocateDeclIndexes(self: *Wasm, decl_index: Module.Decl.Index) !void {
...	@@ -1983,32 +1968,22 @@ fn populateErrorNameTable(self: *Wasm) !void {	...	@@ -1983,32 +1968,22 @@ fn populateErrorNameTable(self: *Wasm) !void {
1983	try self.parseAtom(names_atom, .{ .data = .read_only });	1968	try self.parseAtom(names_atom, .{ .data = .read_only });
1984	}	1969	}
1985		1970
1986	pub fn getDebugInfoIndex(self: *Wasm) !u32 {	1971	/// From a given index variable, returns it value if set.
1987	assert(self.dwarf != null);	1972	/// When not set, initialises a new segment, sets the index,
1988	return self.debug_info_index orelse {	1973	/// and returns it value.
1989	self.debug_info_index = @intCast(u32, self.segments.items.len);	1974	/// When a new segment is initialised. It also creates an atom.
1990	const segment = try self.segments.addOne(self.base.allocator);	1975	pub fn getOrSetDebugIndex(self: Wasm, index: ?u32) !u32 {
1991	segment.* = .{	1976	return (index.*) orelse {
1992	.size = 0,	1977	const new_index = @intCast(u32, self.segments.items.len);
1993	.offset = 0,	1978	index.* = new_index;
1994	// debug sections always have alignment '1'	1979	try self.appendDummySegment();
1995	.alignment = 1,	1980
1996	};	1981	const atom = try self.base.allocator.create(Atom);
1997	return self.debug_info_index.?;	1982	atom.* = Atom.empty;
1998	};	1983	atom.alignment = 1; // debug sections are always 1-byte-aligned
1999	}	1984	try self.managed_atoms.append(self.base.allocator, atom);
2000		1985	try self.atoms.put(self.base.allocator, new_index, atom);
2001	pub fn getDebugLineIndex(self: *Wasm) !u32 {	1986	return new_index;
2002	assert(self.dwarf != null);
2003	return self.debug_line_index orelse {
2004	self.debug_line_index = @intCast(u32, self.segments.items.len);
2005	const segment = try self.segments.addOne(self.base.allocator);
2006	segment.* = .{
2007	.size = 0,
2008	.offset = 0,
2009	.alignment = 1,
2010	};
2011	return self.debug_line_index.?;
2012	};	1987	};
2013	}	1988	}
2014		1989