Add Standalone MM Performance Support [Rebase & FF] #1268

makubacki · 2025-02-03T16:16:06Z

Description

This series is going to edk2 but it is being made available in parallel to Project Mu since the edk2 202502 soft freeze began today. The plan is to not backport this Mu series but keep in the "dev" branch. Once the changes are in edk2, the dev branch will be reconciled with those changes and that will be backported.

This gets performance records from most Standalone MM drivers. In a privilege separated environment like that of the Standalone MM Supervisor, this would cover user mode drivers. Additional changes specific to the supervisor would need to be made to also get performance records from the supervisor itself.

MdeModulePkg: Add Standalone MM Core performance support

Adds a new library instance to support MM core functionality for
performance in Standalone MM.

Add StandaloneMmCorePerformanceLib instance
Move common MM logic to a new file MmCorePerformanceLib.c
Define interfaces with implementation specific to MM environment
type in SmmCorePerformanceLibInternal.h and implement those
functions in the Standalone MM and Traditional MM specific C files

Note: StandaloneMmCorePerformanceLib supports both
MM_CORE_STANDALONE and MM_STANDALONE as some Standalone MM
environments need to link this functionality in a ring 3 driver
that is outside the ring 0 core driver.

MdeModulePkg: Add Standalone MM perf library support

Adds a new library instance to support logging performance data in
Standalone MM.

Add StandaloneMmPerformanceLib instance
Move common MM logic to a new file SmmPerformanceLibInternal.c
Since the library largely defers most logic to the performance
measurement protocol a large degree of code can be shared between
Standalone MM and Traditional MM.

How This Was Tested

Build and CI
Return performance records from Standalone MM (MM Supervisor)
Return performance records from Traditional MM (OVMF)

Integration Instructions

Traditional MM should be able to continue using the same libraries.
Standalone MM:
- Link MdeModulePkg/Library/SmmCorePerformanceLib/StandaloneMmCorePerformanceLib.inf
  against a Standalone MM module that is loaded early and has MM Services available.
- Link MdeModulePkg/Library/SmmPerformanceLib/StandaloneMmPerformanceLib.inf against
  all Standalone MM modules that have a PerformanceLib dependency and need to log
  MM performance data.

MdeModulePkg/Library/DxeCorePerformanceLib/DxeCorePerformanceLib.c

MdeModulePkg/Library/SmmCorePerformanceLib/MmCorePerformanceLib.c

codecov-commenter · 2025-02-03T16:34:46Z

Codecov Report

Attention: Patch coverage is 0% with 926 lines in your changes missing coverage. Please review.

Project coverage is 1.60%. Comparing base (8fbee33) to head (b8cae80).

Files with missing lines	Patch %	Lines
...brary/SmmCorePerformanceLib/MmCorePerformanceLib.c	0.00%	590 Missing ⚠️
...rary/SmmPerformanceLib/SmmPerformanceLibInternal.c	0.00%	145 Missing ⚠️
...rary/DxeCorePerformanceLib/DxeCorePerformanceLib.c	0.00%	53 Missing ⚠️
...rary/SmmCorePerformanceLib/SmmCorePerformanceLib.c	0.00%	50 Missing ⚠️
...orePerformanceLib/StandaloneMmCorePerformanceLib.c	0.00%	44 Missing ⚠️
...ary/SmmPerformanceLib/StandaloneMmPerformanceLib.c	0.00%	33 Missing ⚠️
...ePkg/Library/SmmPerformanceLib/SmmPerformanceLib.c	0.00%	11 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff               @@
##           dev/202405    #1268      +/-   ##
==============================================
- Coverage        1.60%    1.60%   -0.01%     
==============================================
  Files            1379     1383       +4     
  Lines          359710   359859     +149     
  Branches         5524     5524              
==============================================
  Hits             5760     5760              
- Misses         353843   353992     +149     
  Partials          107      107

Flag	Coverage Δ
MdeModulePkg	`0.67% <0.00%> (-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.

Temporarily use this branch for testing. This commit will be reverted after the following Mu Basecore PR is merged: microsoft/mu_basecore#1268 Signed-off-by: Michael Kubacki <[email protected]>

MdeModulePkg/Library/DxeCorePerformanceLib/DxeCorePerformanceLib.c

MdeModulePkg/Library/SmmPerformanceLib/StandaloneMmPerformanceLib.c

MdeModulePkg/Library/SmmCorePerformanceLib/SmmCorePerformanceLib.c

MdeModulePkg/Library/SmmCorePerformanceLib/MmCorePerformanceLib.c

Adds a new library instance to support MM core functionality for performance in Standalone MM. - Add StandaloneMmCorePerformanceLib instance - Move common MM logic to a new file `MmCorePerformanceLib.c` - Define interfaces with implementation specific to MM environment type in `SmmCorePerformanceLibInternal.h` and implement those functions in the Standalone MM and Traditional MM specific C files Note: StandaloneMmCorePerformanceLib supports both `MM_CORE_STANDALONE` and `MM_STANDALONE` as some Standalone MM environments need to link this functionality in a ring 3 driver that is outside the ring 0 core driver. Signed-off-by: Michael Kubacki <[email protected]>

Adds a new library instance to support logging performance data in Standalone MM. - Add StandaloneMmPerformanceLib instance - Move common MM logic to a new file `SmmPerformanceLibInternal.c` - Since the library largely defers most logic to the performance measurement protocol a large degree of code can be shared between Standalone MM and Traditional MM. Signed-off-by: Michael Kubacki <[email protected]>

makubacki requested a review from kuqin12 February 3, 2025 16:16

makubacki self-assigned this Feb 3, 2025