Commit a01b1448e2927146cde9f7861605585f96b5084d | zig

author	Luuk de Gram <luuk@degram.dev> 2022-09-10 13:49:39+02:00
committer	Luuk de Gram <luuk@degram.dev> 2022-09-12 21:19:13+02:00
log	a01b1448e2927146cde9f7861605585f96b5084d
tree	9fcaa97cbb0fbf7cf0068f2fbacdb2f107ee564f
parent	e323cf1264f390911dcc2efea71d46be1d631d92
signature	Commit is signed but in an unrecognized format.

wasm-linker: write magic bytes only on success

By writing them at the very end, we can easily detect
where the writing of the binary went wrong as tools will
indicate the missing of the magic bytes.

1 files changed, 12 insertions(+), 8 deletions(-)

src
- link
  - Wasm.zig

src/link/Wasm.zig+12-8

 @@ -324,8 +324,6 @@ pub fn openPath(allocator: Allocator, sub_path: []const u8, options: link.Option
     wasm_bin.base.file = file;
     wasm_bin.name = sub_path;
-    try file.writeAll(&(wasm.magic ++ wasm.version));
     // As sym_index '0' is reserved, we use it for our stack pointer symbol
     const sym_name = try wasm_bin.string_table.put(allocator, "__stack_pointer");
     const symbol = try wasm_bin.symbols.addOne(allocator);
 @@ -363,7 +361,11 @@ pub fn openPath(allocator: Allocator, sub_path: []const u8, options: link.Option
         };
     }
-    try wasm_bin.initDebugSections();
+    if (!options.strip and options.module != null) {
+        wasm_bin.dwarf = Dwarf.init(allocator, .wasm, options.target);
+        try wasm_bin.initDebugSections();
+    }
     return wasm_bin;
 }
 @@ -380,10 +382,6 @@ pub fn createEmpty(gpa: Allocator, options: link.Options) !*Wasm {
         .name = undefined,
     };
-    if (!options.strip and options.module != null) {
-        self.dwarf = Dwarf.init(gpa, .wasm, options.target);
-    }
     const use_llvm = build_options.have_llvm and options.use_llvm;
     const use_stage1 = build_options.have_stage1 and options.use_stage1;
     if (use_llvm and !use_stage1) {
 @@ -2213,7 +2211,8 @@ pub fn flushModule(self: *Wasm, comp: *Compilation, prog_node: *std.Progress.Nod
     const header_size = 5 + 1;
     const is_obj = self.base.options.output_mode == .Obj;
-    // No need to rewrite the magic/version header
+    // We write the magic bytes at the end so they will only be written
+    // if everything succeeded as expected.
     try file.setEndPos(@sizeOf(@TypeOf(wasm.magic ++ wasm.version)));
     try file.seekTo(@sizeOf(@TypeOf(wasm.magic ++ wasm.version)));
 @@ -2599,6 +2598,11 @@ pub fn flushModule(self: *Wasm, comp: *Compilation, prog_node: *std.Progress.Nod
         }
         try self.emitNameSection(file, arena);
     }
+    // Only when writing all sections executed properly we write the magic
+    // bytes. This allows us to easily detect what went wrong while generating
+    // the final binary.
+    try file.pwriteAll(&(wasm.magic ++ wasm.version), 0);
 }
 fn emitDebugSection(file: fs.File, data: []const u8, name: []const u8) !void {