Commit `d1484bf4b9`

Robin Voetter <robin@voetter.nl>

2023-04-08 23:49:17

spirv: emit nonsemantic info with zig errors

In order to be able to report nice errors in the test runner, and in order to check SkipZigTest errors, we need to pass the error names to the consumer. This kind of information can be passed via nonsemantic instructions - using OpSourceExtension here. All errors are concatenated into a single string, starting with 'zig_errors:' for identification, separated by a colon (:). To ensure that we can represent all error codes, even those which contain a colon, the error names are URI- escaped. URI-escaping, rather than base64, allows us to see the error names when viewing disassembled SPIR-V code.

master

1 parent 979b410

Changed files (1)

src

link

SpirV.zig

@@ -181,6 +181,27 @@ pub fn flushModule(self: *SpirV, comp: *Compilation, prog_node: *std.Progress.No
     try writeCapabilities(&self.spv, target);
     try writeMemoryModel(&self.spv, target);
 
+    // We need to export the list of error names somewhere so that we can pretty-print them in the
+    // executor. This is not really an important thing though, so we can just dump it in any old
+    // nonsemantic instruction. For now, just put it in OpSourceExtension with a special name.
+
+    var error_info = std.ArrayList(u8).init(self.spv.arena);
+    try error_info.appendSlice("zig_errors");
+    const module = self.base.options.module.?;
+    for (module.error_name_list.items) |name| {
+        // Errors can contain pretty much any character - to encode them in a string we must escape
+        // them somehow. Easiest here is to use some established scheme, one which also preseves the
+        // name if it contains no strange characters is nice for debugging. URI encoding fits the bill.
+        // We're using : as separator, which is a reserved character.
+
+        const escaped_name = try std.Uri.escapeString(self.base.allocator, name);
+        defer self.base.allocator.free(escaped_name);
+        try error_info.writer().print(":{s}", .{escaped_name});
+    }
+    try self.spv.sections.debug_strings.emit(self.spv.gpa, .OpSourceExtension, .{
+        .extension = error_info.items,
+    });
+
     try self.spv.flush(self.base.file.?);
 }

Commit d1484bf4b9

Commit `d1484bf4b9`