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

Make DEBUG_ERROR Messages on Memory Protection Hob Mismatch More Explicit #838

Conversation

TaylorBeebe
Copy link
Contributor

Description

To reduce the deluge of questions whenever the memory protection settings version is rolled, this PR adds extra prints when it detects a version mismatch to make it more clear what the cause of the ASSERT was.

  • 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 by setting the version incorrectly

Integration Instructions

N/A

@github-actions github-actions bot added the impact:non-functional Does not have a functional impact label May 1, 2024
@TaylorBeebe TaylorBeebe enabled auto-merge (squash) May 1, 2024 21:41
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 1.04%. Comparing base (b152f68) to head (e2e7195).

Additional details and impacted files
@@                Coverage Diff                 @@
##           release/202311     #838      +/-   ##
==================================================
- Coverage            1.22%    1.04%   -0.18%     
==================================================
  Files                1303     1303              
  Lines              335675   335172     -503     
  Branches             3183     3183              
==================================================
- Hits                 4118     3514     -604     
+ Misses             331481   331207     -274     
- Partials               76      451     +375     
Flag Coverage Δ
MdeModulePkg 0.41% <ø> (-0.28%) ⬇️

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.

@TaylorBeebe TaylorBeebe merged commit 8fb7503 into microsoft:release/202311 May 1, 2024
32 checks passed
os-d pushed a commit to os-d/mu_basecore that referenced this pull request Jun 13, 2024
…icit (microsoft#838)

## Description

To reduce the deluge of questions whenever the memory protection
settings version is rolled, this PR adds extra prints when it detects a
version mismatch to make it more clear what the cause of the ASSERT was.

- [ ] 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 by setting the version incorrectly

## Integration Instructions

N/A
os-d pushed a commit to os-d/mu_basecore that referenced this pull request Jun 25, 2024
…icit (microsoft#838)

## Description

To reduce the deluge of questions whenever the memory protection
settings version is rolled, this PR adds extra prints when it detects a
version mismatch to make it more clear what the cause of the ASSERT was.

- [ ] 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 by setting the version incorrectly

## Integration Instructions

N/A
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants