std.os.uefi.protocol: ziggify function signatures by dotcarmen · Pull Request #23214 · ziglang/zig

dotcarmen · 2025-03-12T13:03:15Z

A lot of the function signatures in std.os.uefi.protocol aren't very ziggy. This PR modifies a significant number of the namespace's functions to align more with verbose Zig code.

Some parameters changed from * to *const and vice-versa as appropriate
Some pairs of parameters that represent slices were consolidated into a single slice parameter
Status errors associated with each function according to the UEFI Specification are handled specifically, resulting in narrow error unions being returned from each function
- unexpected status codes result in a new call to uefi.unexpectedError, which is akin to posix.unexpectedError
As appropriate, return values from various functions are returned directly when the underlying function's return value is .success, rather than requiring an output pointer parameter

note: most of std.os.uefi is untested, and that's not really changing here. I'm mostly focused on making sure there are no compiler errors. Any further problems will require a future PR to address.

dotcarmen · 2025-03-12T13:16:07Z

one problem I'm struggling to address in this PR is the potential for the underlying API to return status codes - most of std.os.uefi already assumes non-.success return values are errors, but I wonder if warnings (high bit clear) should be stored somewhere?

linusg · 2025-03-13T16:10:24Z

+ pub fn delete(self: *File) bool {
+ switch (self._delete(self)) {
+ .success => return true,
+ .warn_delete_failure => return false,


That seems like a good solution. Once we find an API that can return both a value and a warning it'll get awkward though.

dotcarmen · 2025-03-15T17:21:47Z

for warnings, i'm considering a global pub var warning: Status = .success; in uefi.zig, which the user can check for a value. then, uefi.unexpectedStatus can return UnexpectedError!void and callers can return .success value.

alternatively, I can make a pub fn MaybeWarned(T: type) type which has an optional warning: ?Status field in addition to result: T. thoughts?

dotcarmen · 2025-03-17T01:59:33Z

as mentioned in the last commit message, i've finished the initial refactorings :D I don't have time for a self-review right now, I'll get to it later today (I'm traveling in Japan for another couple days)

dotcarmen · 2025-03-17T07:34:02Z

 pub const HiiDatabase = @import("protocol/hii_database.zig").HiiDatabase;
 pub const HiiPopup = @import("protocol/hii_popup.zig").HiiPopup;

+pub fn ServiceBinding(service_guid: uefi.Guid) type {


there's more ServiceBinding types, and none of them provide more specific info about errors, nor do I see any of them have more functionality...

dotcarmen · 2025-03-17T09:15:26Z

+ pub fn getStatus(
+ self: *SimpleNetwork,
+ interrupt_status: ?*InterruptStatus,
+ tx_buf: ?*?[*]u8,
+ ) GetStatusError!void {


lol there's 4 different ways to return values here, so i just left it as is...

dotcarmen · 2025-03-17T09:29:49Z

+ pub fn outputString(self: *SimpleTextOutput, msg: [*:0]const u16) OutputStringError!bool {
+ switch (self._output_string(self, msg)) {
+ .success => return true,
+ .warn_unknown_glyph => return false,


another instance of a defined warning being possible, luckily this one is also easy...

getEdid should return all values via return value nitty mcpicky more enum Flag types oops didnt update the signature IpAddress union

linusg

Great work, I really like where this is going 🙂

Please ping me when you consider this done and want a full review.

dotcarmen · 2025-03-17T13:55:27Z

ah dang, i'm getting some compiler errors as i'm integrating this into my code 😅 sorry if i push while you're reviewing, i'll try to push only once (after i get regular zig build and the zig test artifact built with refAllDeclsRecursive(std.os.uefi))

dotcarmen · 2025-03-17T14:27:16Z

ok fixed the compiler errors :) done pushing for the (japanese) night!

dotcarmen · 2025-03-18T02:35:07Z

addressed all feedback, ready for 🤞🏻 final review @linusg

the only changes i made that were beyond the previous reviews' comments were
dc2df7c and 478bae7 - if these are too weird, i can revert.

dotcarmen · 2025-03-19T06:41:36Z

added 5205b19 because in my work on my next PR, i realized that the next methods should return null when the next node is the termination entry in the list - similar to how iterating over a null-terminated slice doesn't yield the null terminator in the final iteration.

linusg · 2025-03-24T16:50:55Z

Apologies for the delay on this, I haven't forgotten about it yet 🙂

dotcarmen · 2025-03-24T17:13:52Z

No worries! Thanks for letting me know

linusg

Finally got around to testing this with my own project - std.debug needs an update:

--- a/lib/std/debug.zig+++ b/lib/std/debug.zig@@ -629,9 +629,9 @@ pub fn defaultPanic(
// 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(exit_msg);- _ = out.setAttribute(uefi.protocol.SimpleTextOutput.white);+ out.setAttribute(.{ .foreground = .red }) catch {};+ _ = out.outputString(exit_msg) catch {};+ out.setAttribute(.{ .foreground = .white }) catch {};
}
}

Please do a quick grep around std to see if any other UEFI-specific code paths need updating.

Once this is merged I think we should look into supporting returning std.os.uefi.Status.Error from main(), having to convert the errors back into a status every time is a bit tedious :)

Co-authored-by: linusg <mail@linusgroh.de>

dotcarmen · 2025-03-31T21:41:53Z

I grepped and none of the other uefi symbols in lib/std are using these APIs 😅 they're attempting to use boot_services or runtime_services (which this PR doesn't affect) or checking the current os tag for other usage (path separaters, string selection).

none of the rest of the codebase uses anything from std.os.uefi :)

good idea! i'll open a PR in a bit :)

* master: Sema: increment extra index even if return type is generic std.start: allow return uefi error union in main (ziglang#23425) std.os.uefi.protocol: ziggify function signatures (ziglang#23214) zon: normalize negative zeroes Elf: fix incrementally reallocating the last atom in a section Sema: allow `@ptrCast` slice of zero-bit type to slice of non-zero-bit type translate-c: fix referencing extern locals from nested blocks Add quota for comptime sort, add test std.compress.zstd: ensure window size fits into usize std.compress.zstd: fix OOB access in literal decode ci: Build stage4 and run behavior tests with it on aarch64-linux-debug. ci: Don't do the update-zig1 test steps on aarch64-linux. ci: Don't build the compiler for arm-linux-musleabihf on aarch64-linux. ci: Set execute bit on aarch64-linux scripts.

dotcarmen mentioned this pull request Mar 12, 2025
lib/std/os/uefi/protocol/file.zig: change io adapter fns to const ptr #23160
Closed

dotcarmen force-pushed the uefi-fn-signatures branch from 4f65107 to c5ad247Compare March 12, 2025 13:06

dotcarmen force-pushed the uefi-fn-signatures branch from c5ad247 to 3c4cfa8Compare March 12, 2025 15:39

std.os.uefi.protocol: ziggify function signatures
29c91b7

dotcarmen force-pushed the uefi-fn-signatures branch from 3c4cfa8 to 29c91b7Compare March 13, 2025 15:42

linusg reviewed Mar 13, 2025
View reviewed changes

dotcarmen added 2 commits March 14, 2025 01:49

address some feedback
da26164

explicit error unions
7c21d60

linusg reviewed Mar 14, 2025
View reviewed changes

Comment threadlib/std/os/uefi/protocol/absolute_pointer.zig Outdated
Comment threadlib/std/os/uefi/protocol/device_path.zig Outdated

dotcarmen added 3 commits March 15, 2025 12:02

finish unexpectedErr -> unexpectedStatus
3e1aea5

use undefined and null-unwrap in getEdid
5938b73

some more signature updates
65b98d3

dotcarmen commented Mar 15, 2025
View reviewed changes

Comment threadlib/std/os/uefi/protocol/ip6.zig Outdated

dotcarmen commented Mar 15, 2025
View reviewed changes

Comment threadlib/std/os/uefi/protocol/ip6_config.zig Outdated

dotcarmen commented Mar 15, 2025
View reviewed changes

Comment threadlib/std/os/uefi/protocol/ip6_service_binding.zig Outdated

dotcarmen commented Mar 15, 2025
View reviewed changes

Comment threadlib/std/os/uefi/protocol/managed_network.zig Outdated

a few fixes
6fc4b2b

dotcarmen commented Mar 16, 2025
View reviewed changes

Comment threadlib/std/os/uefi/protocol/graphics_output.zig Outdated

dotcarmen added 2 commits March 16, 2025 23:49

almost there...
abf2b0c

finished initial implementations
f535ed9

dotcarmen marked this pull request as ready for review March 17, 2025 01:59

dotcarmen commented Mar 17, 2025
View reviewed changes

dotcarmen added 2 commits March 17, 2025 18:43

various changes from self-review
c2dadaf
getEdid should return all values via return value nitty mcpicky more enum Flag types oops didnt update the signature IpAddress union

File.open - typed mode and create_attributes args
a7b3533

linusg reviewed Mar 17, 2025
View reviewed changes

dotcarmen added 2 commits March 17, 2025 21:19

CreateAttributes => Attributes
08653d2

more updates to ip6
3a558f8

compiler error fixes
a40d2bf

linusg reviewed Mar 17, 2025
View reviewed changes

dotcarmen added 6 commits March 18, 2025 10:16

quick code review fixes
78b46ae

historical typing error
c55e1e7

move file info stuff to file.zig
063f431

nicky mcpickwickitty
4bc3d97

typed File.getInfo and setInfo
dc2df7c

typed Ip6Config.getData and setData
478bae7

dotcarmen commented Mar 18, 2025
View reviewed changes

Comment threadlib/std/os/uefi/protocol/device_path.zig

dotcarmen mentioned this pull request Mar 18, 2025
std.os.uefi tests in ci #23286
Closed

DevicePath.next should return null if the next node is the end
5205b19

linusg mentioned this pull request Mar 30, 2025
fix(uefi): Add const qualifier for reader, writer and seekablestream #23408
Closed

linusg requested changes Mar 31, 2025
View reviewed changes

update API usage in panic
1135c61
Co-authored-by: linusg <mail@linusgroh.de>

dotcarmen requested a review from linusg March 31, 2025 21:42

linusg approved these changes Mar 31, 2025
View reviewed changes

linusg enabled auto-merge (squash) March 31, 2025 21:54

dotcarmen mentioned this pull request Mar 31, 2025
lib/std/start: allow return uefi error union in main #23425
Merged

linusg merged commit fa86e09 into ziglang:masterApr 1, 2025

dotcarmen deleted the uefi-fn-signatures branch April 1, 2025 12:02

This was referenced Apr 2, 2025
std.os.uefi.tables: ziggify boot and runtime services #23441
Merged
std.os.uefi.protocol.File: fix some typed definitions #23443
Merged

Uh oh!

Uh oh!

Conversation

dotcarmen commented Mar 12, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dotcarmen commented Mar 12, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

linusgMar 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dotcarmen commented Mar 15, 2025

Uh oh!

Uh oh!

dotcarmen commented Mar 17, 2025

Uh oh!

dotcarmenMar 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dotcarmenMar 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dotcarmenMar 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

linusg left a comment

Choose a reason for hiding this comment

Uh oh!

dotcarmen commented Mar 17, 2025

Uh oh!

dotcarmen commented Mar 17, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dotcarmen commented Mar 18, 2025

Uh oh!

Uh oh!

dotcarmen commented Mar 19, 2025

Uh oh!

linusg commented Mar 24, 2025

Uh oh!

dotcarmen commented Mar 24, 2025

Uh oh!

linusg left a comment

Choose a reason for hiding this comment

Uh oh!

dotcarmen commented Mar 31, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

dotcarmen commented Mar 12, 2025•
edited
Loading

dotcarmen commented Mar 31, 2025•
edited
Loading