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

Removed All References to PcdAdvancedLoggerPeiInRam #540

Merged

Conversation

Raymond-MS
Copy link
Contributor

@Raymond-MS Raymond-MS commented Aug 5, 2024

Description

The PCD PcdAdvancedLoggerPeiInRam does not work and is being removed. For Intel systems, the PEI phase uses cache-as-ram and determines that there is no way to allocate memory. This PCD was supposed to signal to the logger that it could allocate memory, however, it would error as memory allocation was not allowed in that phase.

  • 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

Ran the CI build for all packages in mu_plus for the X64 architecture. All tests passing.

Integration Instructions

Users of PcdAdvancedLoggerPeiInRam will need to remove that PCD from DSCs. It is not expected there are users as the PCD does not work, although platforms may have specifically set it to FALSE.

@github-actions github-actions bot added the impact:non-functional Does not have a functional impact label Aug 5, 2024
@Raymond-MS Raymond-MS linked an issue Aug 5, 2024 that may be closed by this pull request
1 task
@Raymond-MS Raymond-MS requested a review from os-d August 5, 2024 22:52
@os-d os-d added the impact:breaking-change Requires integration attention label Aug 5, 2024
Copy link
Contributor

@os-d os-d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I updated the integrations steps and marked this a breaking change, because if any platform is currently using the PCD, they will be broken moving forward, until they drop the PCD.

@codecov-commenter
Copy link

codecov-commenter commented Aug 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 10.65%. Comparing base (5d44a00) to head (5f94a11).
Report is 1 commits behind head on release/202311.

Additional details and impacted files
@@                Coverage Diff                 @@
##           release/202311     #540      +/-   ##
==================================================
- Coverage           11.01%   10.65%   -0.36%     
==================================================
  Files                 144      144              
  Lines               22079    22013      -66     
  Branches             2356     2356              
==================================================
- Hits                 2432     2346      -86     
+ Misses              19615    19579      -36     
- Partials               32       88      +56     
Flag Coverage Δ
AdvLoggerPkg 3.60% <ø> (+0.01%) ⬆️

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.

@github-actions github-actions bot added the type:documentation Improvements or additions to documentation label Aug 5, 2024
@Raymond-MS Raymond-MS marked this pull request as ready for review August 7, 2024 18:37
@Raymond-MS Raymond-MS force-pushed the RemovePcdAdvancedLoggerPeiInRam branch from 1da449b to 5f94a11 Compare August 28, 2024 18:00
@Raymond-MS Raymond-MS enabled auto-merge (squash) August 28, 2024 18:00
@Raymond-MS Raymond-MS merged commit e135172 into microsoft:release/202311 Aug 28, 2024
28 checks passed
Raymond-MS added a commit to Raymond-MS/mu_plus that referenced this pull request Aug 28, 2024
…crosoft#540)

The PCD PcdAdvancedLoggerPeiInRam does not work and is being removed.
For Intel systems, the PEI phase uses cache-as-ram and determines that
there is no way to allocate memory. This PCD was supposed to signal to
the logger that it could allocate memory, however, it would error as
memory allocation was not allowed in that phase.

- [ ] 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, ...
- [x] 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, ...
- [x] 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, ...

Ran the CI build for all packages in mu_plus for the X64 architecture.
All tests passing.

Users of PcdAdvancedLoggerPeiInRam will need to remove that PCD from
DSCs. It is not expected there are users as the PCD does not work,
although platforms may have specifically set it to FALSE.
Raymond-MS added a commit to Raymond-MS/mu_plus that referenced this pull request Aug 28, 2024
…crosoft#540)

The PCD PcdAdvancedLoggerPeiInRam does not work and is being removed.
For Intel systems, the PEI phase uses cache-as-ram and determines that
there is no way to allocate memory. This PCD was supposed to signal to
the logger that it could allocate memory, however, it would error as
memory allocation was not allowed in that phase.

- [ ] 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, ...
- [x] 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, ...
- [x] 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, ...

Ran the CI build for all packages in mu_plus for the X64 architecture.
All tests passing.

Users of PcdAdvancedLoggerPeiInRam will need to remove that PCD from
DSCs. It is not expected there are users as the PCD does not work,
although platforms may have specifically set it to FALSE.
Raymond-MS added a commit that referenced this pull request Aug 28, 2024
The PCD PcdAdvancedLoggerPeiInRam does not work and is being removed.
For Intel systems, the PEI phase uses cache-as-ram and determines that
there is no way to allocate memory. This PCD was supposed to signal to
the logger that it could allocate memory, however, it would error as
memory allocation was not allowed in that phase.

- [ ] 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, ...
- [x] 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, ...
- [x] 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, ...

Ran the CI build for all packages in mu_plus for the X64 architecture.
All tests passing.

Users of PcdAdvancedLoggerPeiInRam will need to remove that PCD from
DSCs. It is not expected there are users as the PCD does not work,
although platforms may have specifically set it to FALSE.
ProjectMuBot referenced this pull request in microsoft/mu_tiano_platforms Sep 25, 2024
Introduces 9 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/bde9c52c420dc4fc075197ae5406cfb4ecc3f3c4">bde9c5</a> AdvLoggerPkg: Exit from write call if signature mismatch (<a href="https://github.com/microsoft/mu_plus/pull/565">#565</a>)</li>
<li><a href="https://github.com/microsoft/mu_plus/commit/f56280b7280ccdbb3877f53a3fd348ad7937f4eb">f56280</a> [CHERRY-PICK] Removed All References to PcdAdvancedLoggerPeiInRam (<a href="https://github.com/microsoft/mu_plus/pull/540">#540</a>)</li>
<li><a href="https://github.com/microsoft/mu_plus/commit/7c981ae9d492ba9403b65777a4d46174743bea98">7c981a</a> [CHERRY-PICK] Removed reference to PcdAdvancedHdwLoggerDisable in the README (<a href="https://github.com/microsoft/mu_plus/pull/541">#541</a>)</li>
<li><a href="https://github.com/microsoft/mu_plus/commit/0f790244e3273db5eae465ae49cbf07468047b52">0f7902</a> pip: bump edk2-pytool-extensions from 0.27.11 to 0.27.12 (<a href="https://github.com/microsoft/mu_plus/pull/571">#571</a>)</li>
<li><a href="https://github.com/microsoft/mu_plus/commit/bedfce0da5047d2f27ff302b869fb2ad6d23ec23">bedfce</a> Add MockDeviceBootManagerLib (<a href="https://github.com/microsoft/mu_plus/pull/572">#572</a>)</li>
<li><a href="https://github.com/microsoft/mu_plus/commit/93d7793bdd1c88cf8f6747d91d8d0abe2ab9c76e">93d779</a> AdvLoggerPkg: Add GoogleTest for AdvancedLoggerPeiLib (<a href="https://github.com/microsoft/mu_plus/pull/555">#555</a>)</li>
<li><a href="https://github.com/microsoft/mu_plus/commit/ad283339db8ac5610f3d1e8f98a2d3b5fd806c1c">ad2833</a> Add DxeCore AdvancedLogger GoogleTest (<a href="https://github.com/microsoft/mu_plus/pull/569">#569</a>)</li>
<li><a href="https://github.com/microsoft/mu_plus/commit/f14beb145ac49ddb9a570f6788fff5e7da4f4aad">f14beb</a> pip: bump regex from 2024.7.24 to 2024.9.11 (<a href="https://github.com/microsoft/mu_plus/pull/579">#579</a>)</li>
<li><a href="https://github.com/microsoft/mu_plus/commit/5fb0d0462731513e3a28d5c0be1932a765dfe03d">5fb0d0</a> pip: bump edk2-pytool-library from 0.21.10 to 0.21.11 (<a href="https://github.com/microsoft/mu_plus/pull/578">#578</a>)</li>
</ul>
</details>

Signed-off-by: Project Mu Bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact:breaking-change Requires integration attention impact:non-functional Does not have a functional impact type:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: PcdAdvancedLoggerPeiInRam Does Not Work
5 participants