Commit 05a8c4796f633bfebad7ec403560ce442cae11ba | zig

author	Veikka Tuominen <git@vexu.eu> 2024-07-23 04:06:30+03:00
committer	GitHub <noreply@github.com> 2024-07-23 04:06:30+03:00
log	05a8c4796f633bfebad7ec403560ce442cae11ba
tree	d80820304245f0e704ed7350b8f23ac615bffa57
parent	d2c9a51d1e9aa9de1341bfb52caf8b15daffe79c
parent	22d964fe22f2e154640f71ef52c1ed552be518bd
signature	Signed by PGP key B5690EEEBB952194

Merge pull request #18962 from fifty-six/master

std.builtin.panic(uefi): usability improvements

1 files changed, 37 insertions(+), 23 deletions(-)

lib
- std
  - builtin.zig

lib/std/builtin.zig+37-23

 @@ -799,41 +799,55 @@ pub fn default_panic(msg: []const u8, error_return_trace: ?*StackTrace, ret_addr
         .uefi => {
             const uefi = std.os.uefi;
+            const Formatter = struct {
+                pub fn fmt(exit_msg: []const u8, out: []u16) ![:0]u16 {
+                    var u8_buf: [256]u8 = undefined;
+                    const slice = try std.fmt.bufPrint(&u8_buf, "err: {s}\r\n", .{exit_msg});
+                    // We pass len - 1 because we need to add a null terminator after
+                    const len = try std.unicode.utf8ToUtf16Le(out[0 .. out.len - 1], slice);
+                    out[len] = 0;
+                    return out[0..len :0];
+                }
+            };
             const ExitData = struct {
-                pub fn create_exit_data(exit_msg: []const u8, exit_size: *usize) ![*:0]u16 {
+                pub fn create_exit_data(exit_msg: [:0]u16, exit_size: *usize) ![*:0]u16 {
                     // Need boot services for pool allocation
                     if (uefi.system_table.boot_services == null) {
                         return error.BootServicesUnavailable;
                     }
-                    // ExitData buffer must be allocated using boot_services.allocatePool
+                    // ExitData buffer must be allocated using boot_services.allocatePool (spec: page 220)
-                    var utf16: []u16 = try uefi.raw_pool_allocator.alloc(u16, 256);
+                    const exit_data: []u16 = try uefi.raw_pool_allocator.alloc(u16, exit_msg.len + 1);
-                    errdefer uefi.raw_pool_allocator.free(utf16);
-                    if (exit_msg.len > 255) {
-                        return error.MessageTooLong;
-                    }
-                    var fmt: [256]u8 = undefined;
-                    const slice = try std.fmt.bufPrint(&fmt, "\r\nerr: {s}\r\n", .{exit_msg});
-                    const len = try std.unicode.utf8ToUtf16Le(utf16, slice);
-                    utf16[len] = 0;
-                    exit_size.* = 256;
+                    @memcpy(exit_data[0 .. exit_msg.len + 1], exit_msg[0 .. exit_msg.len + 1]);
+                    exit_size.* = exit_msg.len + 1;
-                    return @as([*:0]u16, @ptrCast(utf16.ptr));
+                    return @as([*:0]u16, @ptrCast(exit_data.ptr));
                 }
             };
-            var exit_size: usize = 0;
+            var buf: [256]u16 = undefined;
-            const exit_data = ExitData.create_exit_data(msg, &exit_size) catch null;
+            const utf16 = Formatter.fmt(msg, &buf) catch null;
-            if (exit_data) |data| {
+            var exit_size: usize = 0;
-                if (uefi.system_table.std_err) |out| {
+            const exit_data = if (utf16) |u|
-                    _ = out.setAttribute(uefi.protocol.SimpleTextOutput.red);
+                ExitData.create_exit_data(u, &exit_size) catch null
-                    _ = out.outputString(data);
+            else
-                    _ = out.setAttribute(uefi.protocol.SimpleTextOutput.white);
+                null;
+            if (utf16) |str| {
+                // Output to both std_err and con_out, as std_err is easier
+                // to read in stuff like QEMU at times, but, unlike con_out,
+                // isn't visible on actual hardware if directly booted into
+                inline for ([_]?*uefi.protocol.SimpleTextOutput{ uefi.system_table.std_err, uefi.system_table.con_out }) |o| {
+                    if (o) |out| {
+                        _ = out.setAttribute(uefi.protocol.SimpleTextOutput.red);
+                        _ = out.outputString(str);
+                        _ = out.setAttribute(uefi.protocol.SimpleTextOutput.white);
+                    }
                 }
             }