firmware_uefi: add diagnostics service for uefi logs #1209
+560
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maheeraeron
changed the title
maheeraeron
changed the title
jstarks
reviewed
Apr 21, 2025
smalis-msft
reviewed
Apr 21, 2025
jstarks
reviewed
Apr 21, 2025
jstarks
reviewed
Apr 21, 2025
jstarks
reviewed
Apr 21, 2025
jstarks
reviewed
Apr 21, 2025
jstarks
reviewed
Apr 21, 2025
chris-oo
reviewed
May 1, 2025
| use zerocopy::Immutable; | ||
| use zerocopy::KnownLayout; | ||
|
|
||
| // Advanced Logger Info signature |
There was a problem hiding this comment.
use /// doc comments here, please. Also, can we require doc comments?
jstarks
reviewed
May 14, 2025
jstarks
reviewed
May 14, 2025
jstarks
reviewed
May 14, 2025
jstarks
reviewed
May 14, 2025
jstarks
reviewed
May 14, 2025
jstarks
reviewed
May 14, 2025
| return Err(EntryParseError::Timestamp(entry.time_stamp)); | ||
| } | ||
|
|
||
| // Validate the message length |
There was a problem hiding this comment.
I suggest leaving out comments that don't say anything more than what the code is obviously doing.
jstarks
reviewed
May 14, 2025
| /// UEFI Advanced Logger Info Header, which is shared | ||
| /// with the Advanced Logger Package in UEFI. The entries | ||
| /// live right after. | ||
| #[repr(C, packed)] |
There was a problem hiding this comment.
Why is this packed? It looks like it has natural alignment for all fields. Marking it packed just makes more work for yourself since you can't take references to fields inside it.
jstarks
reviewed
May 14, 2025
jstarks
reviewed
May 14, 2025
jstarks
reviewed
May 14, 2025
| } | ||
|
|
||
| // Process any remaining accumulated message | ||
| if is_accumulating && !accumulated_message.is_empty() { |
There was a problem hiding this comment.
This chunk of code is duplicated. Find a way to avoid this duplication (e.g., define a closure and call that closure in the two places).
jstarks
reviewed
May 14, 2025
jstarks
reviewed
May 14, 2025
jstarks
reviewed
May 14, 2025
jstarks
reviewed
May 14, 2025
…e of overflow instead, avoid allocation for message, remove explicit endianness, remove unnecessary comments, use kv pairs in trace statements, change to log_message for actual message, remove prefix
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR focuses on a new diagnostics service for firmware_uefi.
UEFI will write the GPA of the advanced logger buffer (which we formally call EFI Diagnostics here) to an Io port intercept called
SET_EFI_DIAGNOSTICS_GPA.UEFI will also write to a different Io port intercept called
PROCESS_EFI_DIAGNOSTICS, which signals us to process the EFI Diagnostics buffer.The diagnostics subsystem's role is to read into guest memory from the specified GPA, collect advanced logger entries and log them to our tracing facilities. This will get triggered by the following conditions:
PROCESS_EFI_DIAGNOSTICS)PROCESS_EFI_DIAGNOSTICS)