SecurityPkg: Introduce Dynamic TCG Log Scaling by Raymond-MS · Pull Request #1788 · microsoft/mu_basecore

Raymond-MS · 2026-05-08T19:00:24Z

Description

Implemented dynamic TCG log scaling in Tcg2Dxe. When the log would become truncated it instead now dynamically scales doubling the size each time. An ERROR log is reported that an increase to your base log size should occur such that scaling is not necessary. This is a precaution against platforms that log a lot and the addition of new hashing algorithms for PQC. The log is allocated in BootServices memory. The ACPI log is created on ReadyToBoot with logs being added to both until they would need to scale. In this instance a truncation event is added to the ACPI log to indicate that the log is no longer valid and/or may not contain the entirety of the log. This ACPI log is allocated in NVS memory. If the ACPI table was already allocated at the time of the ACPI log creation, it is uninstalled and reinstalled with the updated LAML and LASA PCDs. Tests were added via TcgLogTest which includes a DXE driver and a UEFI shell UnitTest app. The DXE driver handles pre-ReadyToBoot tests while the TestApp handles post-ReadyToBoot tests as well as gathering the test results from the DXE driver. Markdown documents were created to detail the changes.

For details on how to complete these options and their meaning refer to CONTRIBUTING.md.

How This Was Tested

Tested via TcgLogTest included in the reference QEMU SBSA platform with TPM enabled. Confirmed the UnitTest results. Both tests report PASS.

Integration Instructions

Include the TcgLogTest .inf's to your platform .dsc and .fdf files. You will need to include both the TcgLogTestDxe and TcgLogTestApp for full functionality.

mu-automation · 2026-05-08T19:05:50Z

✅ QEMU Validation Passed

Source Dependencies

Repository	Commit
mu_basecore	`4d886b7`
mu_tiano_platforms	`78fad16`

Results

Platform	Target	Build	Boot	Overall Boot Time	Build Logs	Boot Logs
Q35	DEBUG	✅ success	✅ success	0m 18s	Build Logs	Boot Logs
SBSA	DEBUG	✅ success	✅ success	0m 33s	Build Logs	Boot Logs

Workflow run: https://github.com/microsoft/mu_basecore/actions/runs/25770214018

This comment was automatically generated by the Mu QEMU PR Validation workflow.

codecov-commenter · 2026-05-08T20:11:24Z

Codecov Report

❌ Patch coverage is 0% with 839 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (release/202511@6f6a7c6). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
SecurityPkg/Tcg/TcgLogTest/TcgLogTestCommon.c	0.00%	281 Missing ⚠️
SecurityPkg/Tcg/Tcg2Dxe/Tcg2Dxe.c	0.00%	224 Missing ⚠️
SecurityPkg/Tcg/TcgLogTest/TcgLogTestApp.c	0.00%	175 Missing ⚠️
SecurityPkg/Tcg/TcgLogTest/TcgLogTestDxe.c	0.00%	139 Missing ⚠️
SecurityPkg/Tcg/Tcg2Acpi/Tcg2Acpi.c	0.00%	10 Missing ⚠️
SecurityPkg/Tcg/Tcg2AcpiFfa/Tcg2AcpiFfa.c	0.00%	10 Missing ⚠️

Additional details and impacted files

@@                Coverage Diff                @@
##             release/202511    #1788   +/-   ##
=================================================
  Coverage                  ?    2.21%           
=================================================
  Files                     ?     1636           
  Lines                     ?   420850           
  Branches                  ?     4949           
=================================================
  Hits                      ?     9308           
  Misses                    ?   411467           
  Partials                  ?       75

Flag	Coverage Δ
FmpDevicePkg	`9.53% <ø> (?)`
MdeModulePkg	`1.58% <ø> (?)`
MdePkg	`5.44% <ø> (?)`
NetworkPkg	`0.55% <ø> (?)`
PolicyServicePkg	`30.42% <ø> (?)`
SecurityPkg	`1.56% <0.00%> (?)`
UefiCpuPkg	`4.78% <ø> (?)`
UnitTestFrameworkPkg	`11.70% <ø> (?)`

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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

makubacki

@Raymond-MS, I found the accompanying documentation helpful. I left some comments in a quick first pass, I might follow up when I have time to look in more detail.

…come truncated it instead now dynamically scales doubling the size each time. An ERROR log is reported that an increase to your base log size should occur such that scaling is not necessary. This is a precaution against platforms that log a lot and the addition of new hashing algorithms for PQC. The log is allocated in BootServices memory. The ACPI log is created on ReadyToBoot with logs being added to both until they would need to scale. In this instance a truncation event is added to the ACPI log to indicate that the log is no longer valid and/or may not contain the entirety of the log. This ACPI table is allocated in NVS memory. If the ACPI table was already allocated at the time of the ACPI log creation, it is uninstalled and reinstalled with the updated LAML and LASA PCDs. Tests were added via TcgLogTest which includes a DXE driver and a UEFI shelld UnitTest app. The DXE driver handles pre-ReadyToBoot tests while the TestApp handles post-ReadyToBoot tests as well as gathering the test results from the DXE driver. Markdown documents were created to detail the changes.

…cause possible loss of data.

…used dynamic scaling to occur. Scaling the log now makes sure the LastEvent pointer is always valid.

spbrogan · 2026-05-13T23:28:55Z

+// String logged as a NO_ACTION event to mark the ACPI-visible TCG
+// log as truncated when dynamic scaling occurs post ReadyToBoot.
+#define TCG_LOG_TRUNCATION_EVENT_STRING  "TCG Event Log Truncated"
+


follow existing pattern to add len

spbrogan · 2026-05-13T23:29:20Z

+// String logged as a NO_ACTION event to mark the ACPI-visible TCG
+// log as truncated when dynamic scaling occurs post ReadyToBoot.
+#define TCG_LOG_TRUNCATION_EVENT_STRING  "TCG Event Log Truncated"
+


Add comment that this is not yet spec defined. do we have plans to take to tcg?

I believe that when we upstream, if this feature is adopted by the EDK2 community, it would be in our best interest to bring this to the TCG spec.

spbrogan · 2026-05-13T23:46:37Z

+  EFI_TPM2_ACPI_START_METHOD_SPECIFIC_PARAMETERS_ARM_FFA    FfaParameters;
+  UINT32                                                    Laml; // Optional
+  UINT64                                                    Lasa; // Optional
+} EFI_TPM2_ACPI_TABLE_V5;


is this really a version 5 table and is it really hard coded to FFA? Seems like we should use unions and make a more flexible data structure. What is the guidance for non FFA TPMs. What table version do they use? I also don't see a place for EFI_TPM2_ACPI_START_METHOD_SPECIFIC_PARAMETERS_ARM_SMC in the table. Again, I assume there is a flavor of the table that has this.

I created a union of PlatformSpecificParameters, SmcParameters, and FfaParameters. All have the same length and allow backwards compatibility with the other versions of the table structure.

spbrogan · 2026-05-13T23:49:07Z

+  UINT8                          PlatformSpecificParameters[12]; // size up to 12
+  UINT32                         Laml;                           // Optional
+  UINT64                         Lasa;                           // Optional
+} EFI_TPM2_ACPI_TABLE_V4;


need to combine this with EFI_TPM2_ACPI_TABLE

spbrogan · 2026-05-13T23:53:01Z

+events the log fills up. Traditionally, when the log is full, subsequent events
+are dropped and the log is marked as truncated.
+
+Tcg2Dxe extends this behavior with **dynamic scaling**: when the log is about


probably important to call out here the different behaviors based on time of execution (pre ready to boot vs post).

spbrogan · 2026-05-14T00:03:31Z

+  SecurityPkg/Tcg/TcgLogTest/TcgLogTestApp.inf {
+    <LibraryClasses>
+      UnitTestLib|UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.inf
+      UnitTestPersistenceLib|UnitTestFrameworkPkg/Library/UnitTestPersistenceLibNull/UnitTestPersistenceLibNull.inf


these don't look right for a functioning app

spbrogan · 2026-05-14T00:09:58Z

  ## MU_CHANGE - END - Add a new protocol to support Log-only events.
+
+  ## MU_CHANGE - [BEGIN]
+  ## Protocol used to test dynamic TCG log scaling functionality.


this is a private protocol with visibility only to the test app and test dxe driver.

I could see two options.

just note that here

don't create a package defined global for it and just include the guid define in the header file.

spbrogan · 2026-05-14T00:11:58Z

+#define TCG_LOG_TEST_EVENT_TYPE     EV_NO_ACTION
+#define TCG_LOG_TEST_EVENT_PAYLOAD  "TcgLogTestDxeEvent"
+
+STATIC CHAR8  mCommonEventPayload[] = TCG_LOG_TEST_EVENT_PAYLOAD;


this will probably cause a problem with initializer and compiler intrinsics that are not supported.

Copilot

Pull request overview

Introduces dynamic scaling for the TCG2 event log and adds a multi-boot test driver/application pair to validate pre- and post-ReadyToBoot behavior, including ACPI log truncation marking.

Changes:

Adds dynamic TCG2 log reallocation in Tcg2Dxe, plus a fixed ACPI NVS log generated at ReadyToBoot.
Adds truncation marker support for the ACPI-visible log when post-ReadyToBoot scaling occurs.
Adds TcgLogTest DXE/app components, protocol definitions, DSC/DEC integration, and documentation.

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
`SecurityPkg/Tcg/TcgLogTest/TcgLogTestDxe.inf`	Defines the new DXE test driver build metadata.
`SecurityPkg/Tcg/TcgLogTest/TcgLogTestDxe.c`	Implements pre-ReadyToBoot scaling test coordination and protocol publication.
`SecurityPkg/Tcg/TcgLogTest/TcgLogTestCommon.h`	Declares shared TCG log test helpers.
`SecurityPkg/Tcg/TcgLogTest/TcgLogTestCommon.c`	Implements event parsing, event logging until scale, and log dumping helpers.
`SecurityPkg/Tcg/TcgLogTest/TcgLogTestApp.inf`	Defines the new UEFI shell unit test app build metadata.
`SecurityPkg/Tcg/TcgLogTest/TcgLogTestApp.c`	Implements post-ReadyToBoot scaling tests and multi-boot test flow.
`SecurityPkg/Tcg/TcgLogTest/TcgLogTest.h`	Defines the test coordination protocol and enable variable.
`SecurityPkg/Tcg/TcgLogTest/README.md`	Documents the TcgLogTest components and boot flow.
`SecurityPkg/Tcg/Tcg2Dxe/Tcg2Dxe.inf`	Adds ACPI protocol dependencies for TPM2 table updates.
`SecurityPkg/Tcg/Tcg2Dxe/Tcg2Dxe.c`	Adds dynamic log scaling, ACPI log generation, and truncation marker handling.
`SecurityPkg/Tcg/Tcg2Dxe/README.md`	Documents dynamic scaling and log lifetime behavior.
`SecurityPkg/Tcg/Tcg2AcpiFfa/Tcg2AcpiFfa.c`	Switches TPM2 ACPI v5 struct usage to the shared industry-standard header.
`SecurityPkg/Tcg/Tcg2Acpi/Tcg2Acpi.c`	Switches TPM2 ACPI v4 struct usage to the shared industry-standard header.
`SecurityPkg/SecurityPkg.dsc`	Adds the new TcgLogTest modules to the package build.
`SecurityPkg/SecurityPkg.dec`	Publishes the TcgLogTest protocol GUID.
`MdePkg/Include/IndustryStandard/UefiTcgPlatform.h`	Adds the TCG log truncation event string constant.
`MdePkg/Include/IndustryStandard/Tpm2Acpi.h`	Adds TPM2 ACPI v4/v5 table structs for shared use.

Comments suppressed due to low confidence (1)

SecurityPkg/Tcg/Tcg2Dxe/Tcg2Dxe.c:3009

GenerateAcpiLog() can fail (for example, NVS allocation failure), but the result is ignored and mReadyToBoot is set immediately afterward. That leaves the TPM2 ACPI table pointing at the pre-ReadyToBoot boot-services log/PCDs while later code assumes the ACPI NVS log exists. Check and handle this status before marking ReadyToBoot complete.

          if ((PcdGet8 (PcdTpm2AcpiTableRev) >= 4) && !mReadyToBoot) {
            GenerateAcpiLog (&mTcgDxeData.EventLogAreaStruct[Index]);

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+    *PcrIndex = *(UINT32 *)EventPtr;
+  }
+
+  // Store the EventType, if provided.
+  if (EventType != NULL) {
+    *EventType = *(UINT32 *)(EventPtr + sizeof (UINT32));


+  // Uninstall and reinstall the ACPI table with the updated LAML/LASA.
+  UpdateTpm2AcpiTable ();


+  *LogBuffer = mLogBuffer;
+  *LogSize   = mLogOffset + 1;
+  return EFI_SUCCESS;


+
+Tcg2Dxe is a DXE-phase UEFI driver that publishes the TCG2 protocol defined
+by the [TCG EFI Protocol Specification](https://trustedcomputinggroup.org/resource/tcg-efi-protocol-specification/).
+It's main responsibilites are to expose a standard interface to a TPM device,


+  SecurityPkg/Tcg/TcgLogTest/TcgLogTestApp.inf {
+    <LibraryClasses>
+      UnitTestLib|UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.inf
+      UnitTestPersistenceLib|UnitTestFrameworkPkg/Library/UnitTestPersistenceLibNull/UnitTestPersistenceLibNull.inf


+  IN UNIT_TEST_CONTEXT  Context
+  )
+{
+  SaveFrameworkState (NULL, 0);


+  Cleanup for TestPostReadyToBootScaling: enable the DXE pre-ReadyToBoot test
+  for the next boot, then save and reboot so the DXE driver runs before
+  ReadyToBoot on the second boot.
+
+  @param[in] Context  Unit test context (unused).
+**/
+STATIC
+VOID
+EFIAPI
+EnableDxeTestAndReboot (
+  IN UNIT_TEST_CONTEXT  Context
+  )
+{
+  EFI_STATUS  Status;
+
+  if (mTcgLogTestProtocol != NULL) {
+    Status = mTcgLogTestProtocol->Enable (mTcgLogTestProtocol, TRUE);
+    DEBUG ((DEBUG_INFO, "%a: Enable (TRUE) - %r\n", __func__, Status));
+  } else {
+    DEBUG ((DEBUG_ERROR, "%a: mTcgLogTestProtocol is NULL, cannot enable\n", __func__));
+  }
+
+  SaveAndReboot (Context);
+}
+
+/**
+  Prerequisite: locate the TCG2 and TcgLogTest protocols.
+
+  @param[in] Context  Unit test context (unused).
+
+  @retval UNIT_TEST_PASSED                      Protocols located.
+  @retval UNIT_TEST_ERROR_PREREQUISITE_NOT_MET  Protocol not found.
+**/


+  // Free the old log region.
+  gBS->FreePages (OldLasa, EFI_SIZE_TO_PAGES ((UINTN)OldLaml));


Raymond-MS requested review from cfernald, kuqin12, makubacki and spbrogan May 8, 2026 19:00

Raymond-MS force-pushed the personal/rdiaz/DynamicTcgLog branch 2 times, most recently from 83f4da1 to 7711c4f Compare May 8, 2026 19:52

makubacki reviewed May 8, 2026

View reviewed changes

Raymond-MS force-pushed the personal/rdiaz/DynamicTcgLog branch from 7711c4f to 2ee0b3c Compare May 11, 2026 21:16

Raymond-MS requested a review from makubacki May 11, 2026 22:23

Raymond-MS added 8 commits May 13, 2026 00:09

Ran Uncrustify.

c996b96

Fixed a warning as error where conversion from UINT64 to UINTN would …

7abb186

…cause possible loss of data.

Added TcgLogTestApp and TcgLogTestDxe to SecurityPkg.dsc.

99fda2e

Added UnitTestLib module overrides for TcgLogTestApp.

703f774

Addressed review feedback/comments.

12c63d7

Fixed an issue where LastEvent could be stale when an 800155 event ca…

79d99e7

…used dynamic scaling to occur. Scaling the log now makes sure the LastEvent pointer is always valid.

Reworded the post-ReadyToBoot error log message to be less confusing.

4d886b7

Raymond-MS force-pushed the personal/rdiaz/DynamicTcgLog branch from ee53d3f to 4d886b7 Compare May 13, 2026 00:09

Raymond-MS requested a review from Flickdm May 13, 2026 00:17

spbrogan reviewed May 13, 2026

View reviewed changes

spbrogan reviewed May 14, 2026

View reviewed changes

Raymond-MS requested a review from Copilot May 14, 2026 00:25

Copilot started reviewing on behalf of Raymond-MS May 14, 2026 00:26 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

		// Uninstall and reinstall the ACPI table with the updated LAML/LASA.
		UpdateTpm2AcpiTable ();

		// Free the old log region.
		gBS->FreePages (OldLasa, EFI_SIZE_TO_PAGES ((UINTN)OldLaml));

Conversation

Raymond-MS commented May 8, 2026

Description

How This Was Tested

Integration Instructions

Uh oh!

mu-automation Bot commented May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ QEMU Validation Passed

Source Dependencies

Results

Uh oh!

codecov-commenter commented May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

makubacki left a comment

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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mu-automation Bot commented May 8, 2026 •

edited

Loading

codecov-commenter commented May 8, 2026 •

edited

Loading