Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add debug level prefix for advanced logger memory message entries #523

Merged

Conversation

liqiqiii
Copy link
Contributor

@liqiqiii liqiqiii commented Jul 15, 2024

Description

This change added the existing metadata - debug level into the final advanced logger memory entries, it can differentiate the different debug levels, DEBUG_INFO, DEBUG_ERROR, etc.
We don't need to touch firmware as debug level info is already part of metadata, so we only need to update the decode script.
It's useful to be able to filter out the specific debug level msgs that we care about and make data processing of uefi logs possible.
For example, DEBUG_ERROR level prints are generally very important and worth analyzing. One blocking thing now is that we can't tell the difference between different debug level msgs because not all DEBUG_ERROR will have an "error:" as the prefix of the debug msg, and search for "error" will also be noisy as it's a commonly used word. After this PR checked in, we can easily track the DEBUG_ERRORs.

  • Impacts functionality?
    • Functionality - Does the change ultimately impact how firmware functions?
    • Examples: Add a new library, publish a new PPI, update an algorithm, ...
  • Impacts security?
    • Security - Does the change have a direct security impact on an application,
      flow, or firmware?
    • Examples: Crypto algorithm change, buffer overflow fix, parameter
      validation improvement, ...
  • Breaking change?
    • Breaking change - Will anyone consuming this change experience a break
      in build or boot behavior?
    • Examples: Add a new library class, move a module to a different repo, call
      a function in a new library class in a pre-existing module, ...
  • Includes tests?
    • Tests - Does the change include any explicit test code?
    • Examples: Unit tests, integration tests, robot tests, ...
  • Includes documentation?
    • Documentation - Does the change contain explicit documentation additions
      outside direct code modifications (and comments)?
    • Examples: Update readme file, add feature readme file, link to documentation
      on an a separate Web page, ...

How This Was Tested

Tested with a platform that uses advancedlogger and can seedebug level prefixes in the msg.
22:36:22.840 : [MM_CORE] [DEBUG_INFO]AdvancedLoggerGetLoggerInfo: LoggerInfo=70F37000
22:36:22.857 : [MM_CORE] [DEBUG_ERROR]ERROR - The FV at 0xFFE60000 is invalid!

Integration Instructions

N/A

@github-actions github-actions bot added language:python Pull requests that update Python code impact:non-functional Does not have a functional impact labels Jul 15, 2024
@codecov-commenter
Copy link

codecov-commenter commented Jul 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 11.04%. Comparing base (877bd3f) to head (f072b4c).

Additional details and impacted files
@@               Coverage Diff               @@
##           release/202311     #523   +/-   ##
===============================================
  Coverage           11.04%   11.04%           
===============================================
  Files                 144      144           
  Lines               22019    22019           
  Branches             2356     2356           
===============================================
  Hits                 2432     2432           
  Misses              19555    19555           
  Partials               32       32           
Flag Coverage Δ
AdvLoggerPkg 3.65% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kenlautner kenlautner merged commit 243bd18 into microsoft:release/202311 Jul 16, 2024
28 checks passed
@makubacki makubacki added the type:enhancement New feature or pull request label Jul 16, 2024
ProjectMuBot referenced this pull request in microsoft/mu_tiano_platforms Jul 17, 2024
Introduces 1 new commits in [Common/MU](https://github.com/microsoft/mu_plus.git).

<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/microsoft/mu_plus/commit/243bd187e4aa6ac68a3eb323d07554576d39ad47">243bd1</a> Add debug level prefix for advanced logger memory message entries (<a href="https://github.com/microsoft/mu_plus/pull/523">#523</a>)</li>
</ul>
</details>

Signed-off-by: Project Mu Bot <[email protected]>
apop5 referenced this pull request in microsoft/mu_tiano_platforms Jul 23, 2024
Bumps Common/MU from `2023110001.0.2` to `2023110001.0.3`


Introduces 1 new commits in
[Common/MU](https://github.com/microsoft/mu_plus.git).

<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/microsoft/mu_plus/commit/243bd187e4aa6ac68a3eb323d07554576d39ad47">243bd1</a>
Add debug level prefix for advanced logger memory message entries (<a
href="https://github.com/microsoft/mu_plus/pull/523">#523</a>)</li>
</ul>
</details>

Signed-off-by: Project Mu Bot <[email protected]>

Signed-off-by: Project Mu Bot <[email protected]>
Co-authored-by: Aaron <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact:non-functional Does not have a functional impact language:python Pull requests that update Python code type:enhancement New feature or pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants