+#include <Library/UefiLib.h>

+ Event notification that is fired when ReadyToLockProtocol is signaled.

+

+ @param Event The Event that is being processed, not used.

+ @param Context Event Context, not used.

+

+**/

+VOID

+EFIAPI

+MMReadyToLockProtocolNotify (

+ IN EFI_EVENT Event,

+ IN VOID *Context

+ )

+{

+ EFI_MM_COMMUNICATE_HEADER Header;

+ UINTN Size;

+

+ //

+ // Use Guid to initialize EFI_SMM_COMMUNICATE_HEADER structure

+ //

+ CopyGuid (&Header.HeaderGuid, &gEfiDxeMmReadyToLockProtocolGuid);

+ Header.MessageLength = 1;

+ Header.Data[0] = 0;

+

+ Size = sizeof (Header);

+ MmCommunication2Communicate (&mMmCommunication2, &Header, &Header, &Size);

+}

+

+/**

+ Status = EfiNamedEventListen (

+ &gEfiDxeMmReadyToLockProtocolGuid,

+ TPL_NOTIFY,

+ MMReadyToLockProtocolNotify,

+ NULL,

+ NULL

+ );

+ ASSERT_EFI_ERROR (Status);

+

+ gEfiDxeMmReadyToLockProtocolGuid ## UNDEFINED # SmiHandlerRegister

+ UINTN VtfPadSize;

+ VtfPadSize = 0;

+ // Vtf file should be bottom aligned at end of block.

+ // If it is not aligned, insert EFI_FFS_FILE_HEADER to ensure the minimum pad file size for left space.

+ //

+ if ((VtfFileSize > 0) && (CurrentOffset % FvInfoPtr->FvBlocks[0].Length)) {

+ VtfPadSize = sizeof (EFI_FFS_FILE_HEADER);

+ }

+

+ //

+ FvInfoPtr->FvBlocks[0].NumBlocks = ((CurrentOffset + VtfPadSize) / FvInfoPtr->FvBlocks[0].Length) +

+ (((CurrentOffset + VtfPadSize) % FvInfoPtr->FvBlocks[0].Length) ? 1 : 0);

+ } else if ((VtfFileSize > 0) &&

+ (FvInfoPtr->Size > CurrentOffset) &&

+ ((FvInfoPtr->Size - CurrentOffset) < sizeof (EFI_FFS_FILE_HEADER)))

+ {

+ //

+ // Not invalid

+ //

+ Error (

+ NULL,

+ 0,

+ 3000,

+ "Invalid",

+ "the required fv image size = 0x%x. the set fv image size = 0x%x. Free space left is not enough to add a pad file (0x18)",

+ (unsigned)CurrentOffset,

+ (unsigned)FvInfoPtr->Size

+ );

+ return EFI_INVALID_PARAMETER;

+R: Khor Swee Aun <swee.aun.khor@intel.com> [sweeaun]

+R: Shuo Liu <shuo.liu@intel.com> [shuoliu0]

+ UINT8 OriginalInterval = Interval;

+

+ ASSERT (Interval != 0);

+

+ //

+ // Some devices incorrectly report full-speed bInterval values in

+ // their high/super-speed interrupt endpoint descriptors. Try to

+ // adjust those assuming they were expressed in units of ms with an

+ // upper limit of 128ms.

+ //

+ if (Interval > 16) {

+ Interval = (UINT8)HighBitSet32 ((UINT32)Interval*8);

+

+ DEBUG ((

+ DEBUG_WARN,

+ "EpDesc->Interval (%u) out of range. Adjusted to %u\n",

+ OriginalInterval,

+ Interval

+ ));

+ } else {

+ Interval = Interval - 1;

+ }

+#define SMM_BOOT_RECORD_COMM_SIZE (OFFSET_OF (EFI_MM_COMMUNICATE_HEADER, Data) + sizeof(SMM_BOOT_RECORD_COMMUNICATE))

+ EFI_MM_COMMUNICATE_HEADER *MmCommBufferHeader;

+ VOID *CurrentBootRecordData;

+ UINTN BootRecordDataPayloadSize;

+ MmCommBufferHeader = (EFI_MM_COMMUNICATE_HEADER *)SmmBootRecordCommBuffer;

+ SmmCommData = (SMM_BOOT_RECORD_COMMUNICATE *)MmCommBufferHeader->Data;

+ CopyGuid (&MmCommBufferHeader->HeaderGuid, &gEfiFirmwarePerformanceGuid);

+ MmCommBufferHeader->MessageLength = sizeof (SMM_BOOT_RECORD_COMMUNICATE);

+ CommSize = SMM_BOOT_RECORD_COMM_SIZE;

+ if (EFI_ERROR (Status)) {

+ DEBUG ((DEBUG_WARN, "Perf handler MMI not found or communicate failed. Status = %r.\n", Status));

+ } else if (EFI_ERROR (SmmCommData->ReturnStatus)) {

+ DEBUG ((DEBUG_ERROR, "Perf handler MMI returned an error. Status = %r.\n", SmmCommData->ReturnStatus));

+ }

+ if (SmmBootRecordData != NULL) {

+ CurrentBootRecordData = (VOID *)((UINTN)SmmCommMemRegion->PhysicalStart + SMM_BOOT_RECORD_COMM_SIZE);

+ while (SmmBootRecordDataRetrieved < SmmBootRecordDataSize) {

+ // Note: Maximum comm buffer data payload size is ReservedMemSize - SMM_BOOT_RECORD_COMM_SIZE

+ BootRecordDataPayloadSize = MIN (

+ ReservedMemSize - SMM_BOOT_RECORD_COMM_SIZE,

+ SmmBootRecordDataSize - SmmBootRecordDataRetrieved - SMM_BOOT_RECORD_COMM_SIZE

+ );

+

+ MmCommBufferHeader->MessageLength = sizeof (SMM_BOOT_RECORD_COMMUNICATE) + BootRecordDataPayloadSize;

+ CommSize = sizeof (EFI_MM_COMMUNICATE_HEADER) + (UINTN)MmCommBufferHeader->MessageLength;

+

+ Status = Communication->Communicate (Communication, SmmBootRecordCommBuffer, &CommSize);

+ ASSERT_EFI_ERROR (Status);

+ if (EFI_ERROR (Status) || EFI_ERROR (SmmCommData->ReturnStatus)) {

+ break;

+ }

+

+ if (SmmBootRecordDataRetrieved + SmmCommData->BootRecordSize > SmmBootRecordDataSize) {

+ CopyMem ((UINT8 *)SmmBootRecordData + SmmBootRecordDataRetrieved, CurrentBootRecordData, SmmBootRecordDataSize - SmmBootRecordDataRetrieved);

+ } else {

+ CopyMem ((UINT8 *)SmmBootRecordData + SmmBootRecordDataRetrieved, CurrentBootRecordData, SmmCommData->BootRecordSize);

+ }

+

+ SmmBootRecordDataRetrieved += SmmCommData->BootRecordSize;

+ SmmCommData->BootRecordOffset += SmmCommData->BootRecordSize;

+ mSmmBootRecordOffset = SmmCommData->BootRecordOffset;

+ *SmmPerfData = SmmBootRecordData;

+ *SmmPerfDataSize = SmmBootRecordDataSize;

+ }

+/** @file

+ This library is mainly used by a MM Core to start performance logging to ensure that

+ MM Performance and PerformanceEx Protocol are installed as early as possible in the MM phase.

+

+ Caution: This module requires additional review when modified.

+ - This driver will have external input - performance data and communicate buffer in SMM mode.

+ - This external input must be validated carefully to avoid security issue like

+ buffer overflow, integer overflow.

+

+ SmmPerformanceHandlerEx(), SmmPerformanceHandler() will receive untrusted input and do basic validation.

+

+ Copyright (c) 2006 - 2023, Intel Corporation. All rights reserved.<BR>

+ (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>

+ Copyright (c) Microsoft Corporation.

+ SPDX-License-Identifier: BSD-2-Clause-Patent

+

+**/

+

+#include "SmmCorePerformanceLibInternal.h"

+

+#include <Protocol/MmCommunication.h>

+#include <Protocol/SmmExitBootServices.h>

+

+SMM_BOOT_PERFORMANCE_TABLE *mSmmBootPerformanceTable = NULL;

+

+typedef struct {

+ EFI_HANDLE Handle;

+ CHAR8 NameString[FPDT_STRING_EVENT_RECORD_NAME_LENGTH];

+ EFI_GUID ModuleGuid;

+} HANDLE_GUID_MAP;

+

+HANDLE_GUID_MAP mCacheHandleGuidTable[CACHE_HANDLE_GUID_COUNT];

+UINTN mCachePairCount = 0;

+

+UINT32 mPerformanceLength = sizeof (SMM_BOOT_PERFORMANCE_TABLE);

+UINT32 mMaxPerformanceLength = 0;

+UINT32 mLoadImageCount = 0;

+BOOLEAN mFpdtDataIsReported = FALSE;

+BOOLEAN mLackSpaceIsReport = FALSE;

+SPIN_LOCK mSmmFpdtLock;

+UINT32 mCachedLength = 0;

+UINT32 mBootRecordSize = 0;

+BOOLEAN mPerformanceMeasurementEnabled;

+

+//

+// Interfaces for SMM PerformanceMeasurement Protocol.

+//

+EDKII_PERFORMANCE_MEASUREMENT_PROTOCOL mPerformanceMeasurementInterface = {

+ CreatePerformanceMeasurement,

+};

+

+/**

+ Return the module name and optionally module GUID for a given handle.

+

+ @param[in] Handle The image handle.

+ @param[out] NameString The buffer to store the name string.

+ @param[in] BufferSize The size of the NameString buffer in bytes.

+ @param[out] ModuleGuid An optional buffer to store the module GUID.

+

+ @retval EFI_SUCCESS The module information was successfully retrieved.

+ @retval EFI_INVALID_PARAMETER A required pointer argument is null or the given handle is invalid.

+

+**/

+EFI_STATUS

+EFIAPI

+GetModuleInfoFromHandle (

+ IN EFI_HANDLE Handle,

+ OUT CHAR8 *NameString,

+ IN UINTN BufferSize,

+ OUT EFI_GUID *ModuleGuid OPTIONAL

+ )

+{

+ EFI_STATUS Status;

+ EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;

+ EFI_GUID *TempGuid;

+ INTN Count;

+ MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvFilePath;

+

+ if ((NameString == NULL) || (BufferSize == 0)) {

+ return EFI_INVALID_PARAMETER;

+ }

+

+ //

+ // Try to get the ModuleGuid and name string form the cached array.

+ //

+ if (mCachePairCount > 0) {

+ for (Count = mCachePairCount - 1; Count >= 0; Count--) {

+ if (Handle == mCacheHandleGuidTable[Count].Handle) {

+ CopyGuid (ModuleGuid, &mCacheHandleGuidTable[Count].ModuleGuid);

+ AsciiStrCpyS (NameString, FPDT_STRING_EVENT_RECORD_NAME_LENGTH, mCacheHandleGuidTable[Count].NameString);

+ return EFI_SUCCESS;

+ }

+ }

+ }

+

+ Status = EFI_INVALID_PARAMETER;

+ NameString[0] = 0;

+ TempGuid = &gZeroGuid;

+

+ LoadedImage = GetLoadedImageProtocol (Handle);

+ if (LoadedImage != NULL) {

+ //

+ // Get Module Guid from DevicePath.

+ //

+ if ((LoadedImage->FilePath != NULL) &&

+ (LoadedImage->FilePath->Type == MEDIA_DEVICE_PATH) &&

+ (LoadedImage->FilePath->SubType == MEDIA_PIWG_FW_FILE_DP)

+ )

+ {

+ //

+ // Determine GUID associated with module logging performance

+ //

+ FvFilePath = (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *)LoadedImage->FilePath;

+ TempGuid = &FvFilePath->FvFileName;

+ }

+

+ if (GetModuleNameFromPdbString (LoadedImage->ImageBase, NameString, BufferSize) == EFI_SUCCESS) {

+ goto Done;

+ }

+ }

+

+ if (!IsZeroGuid (TempGuid)) {

+ Status = GetNameFromUiSection (TempGuid, NameString, BufferSize);

+ }

+

+Done:

+ //

+ // Copy Module Guid

+ //

+ if (ModuleGuid != NULL) {

+ CopyGuid (ModuleGuid, TempGuid);

+ if (IsZeroGuid (TempGuid) && (Handle != NULL)) {

+ // Handle is GUID

+ CopyGuid (ModuleGuid, (EFI_GUID *)Handle);

+ }

+ }

+

+ //

+ // Cache the Handle and Guid pairs.

+ //

+ if (mCachePairCount < CACHE_HANDLE_GUID_COUNT) {

+ mCacheHandleGuidTable[mCachePairCount].Handle = Handle;

+ CopyGuid (&mCacheHandleGuidTable[mCachePairCount].ModuleGuid, ModuleGuid);

+ AsciiStrCpyS (mCacheHandleGuidTable[mCachePairCount].NameString, FPDT_STRING_EVENT_RECORD_NAME_LENGTH, NameString);

+ mCachePairCount++;

+ }

+

+ return Status;

+}

+

+/**

+ Get the module name from the PDB file name in the image header.

+

+ @param[in] ImageBase The base address of the image.

+ @param[out] NameString The buffer to store the name string.

+ @param[in] BufferSize The size of the buffer in bytes.

+

+ @retval EFI_SUCCESS The name string is successfully retrieved.

+ @retval EFI_INVALID_PARAMETER A pointer argument provided is null.

+ @retval EFI_NOT_FOUND The module name was not found.

+

+**/

+EFI_STATUS

+GetModuleNameFromPdbString (

+ IN VOID *ImageBase,

+ OUT CHAR8 *NameString,

+ IN UINTN BufferSize

+ )

+{

+ CHAR8 *PdbFileName;

+ UINTN Index;

+ UINTN StartIndex;

+

+ if ((ImageBase == NULL) || (NameString == NULL) || (BufferSize == 0)) {

+ return EFI_INVALID_PARAMETER;

+ }

+

+ PdbFileName = PeCoffLoaderGetPdbPointer (ImageBase);

+

+ if (PdbFileName == NULL) {

+ return EFI_NOT_FOUND;

+ }

+

+ for (StartIndex = 0, Index = 0; PdbFileName[Index] != 0; Index++) {

+ if ((PdbFileName[Index] == '\\') || (PdbFileName[Index] == '/')) {

+ StartIndex = Index + 1;

+ }

+ }

+

+ //

+ // Copy the PDB file name to our temporary string.

+ // If the length is bigger than BufferSize, trim the redudant characters to avoid overflow in array boundary.

+ //

+ for (Index = 0; Index < BufferSize - 1; Index++) {

+ NameString[Index] = PdbFileName[Index + StartIndex];

+ if ((NameString[Index] == 0) || (NameString[Index] == '.')) {

+ NameString[Index] = 0;

+ break;

+ }

+ }

+

+ if (Index == BufferSize - 1) {

+ NameString[Index] = 0;

+ }

+

+ return EFI_SUCCESS;

+}

+

+/**

+ Return the pointer to the FPDT record in the allocated memory.

+

+ @param RecordSize The size of FPDT record.

+ @param FpdtRecordPtr Pointer the FPDT record in the allocated memory.

+

+ @retval EFI_SUCCESS Successfully get the pointer to the FPDT record.

+ @retval EFI_OUT_OF_RESOURCES Ran out of space to store the records.

+**/

+EFI_STATUS

+GetFpdtRecordPtr (

+ IN UINT8 RecordSize,

+ IN OUT FPDT_RECORD_PTR *FpdtRecordPtr

+ )

+{

+ if (mFpdtDataIsReported) {

+ //

+ // Append Boot records after Smm boot performance records have been reported.

+ //

+ if (mPerformanceLength + RecordSize > mMaxPerformanceLength) {

+ if (!mLackSpaceIsReport) {

+ DEBUG ((DEBUG_ERROR, "[%a] - Not enough space to save boot records\n", __func__));

+ mLackSpaceIsReport = TRUE;

+ }

+

+ return EFI_OUT_OF_RESOURCES;

+ } else {

+ //

+ // Covert buffer to FPDT Ptr Union type.

+ //

+ FpdtRecordPtr->RecordHeader = (EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER *)((UINT8 *)mSmmBootPerformanceTable + mSmmBootPerformanceTable->Header.Length);

+ }

+ } else {

+ //

+ // Check if pre-allocated buffer is full

+ //

+ if (mPerformanceLength + RecordSize > mMaxPerformanceLength) {

+ mSmmBootPerformanceTable = ReallocatePool (

+ mPerformanceLength,

+ mPerformanceLength + RecordSize + FIRMWARE_RECORD_BUFFER,

+ mSmmBootPerformanceTable

+ );

+

+ if (mSmmBootPerformanceTable == NULL) {

+ return EFI_OUT_OF_RESOURCES;

+ }

+

+ mSmmBootPerformanceTable->Header.Length = mPerformanceLength;

+ mMaxPerformanceLength = mPerformanceLength + RecordSize + FIRMWARE_RECORD_BUFFER;

+ }

+

+ //

+ // Covert buffer to FPDT Ptr Union type.

+ //

+ FpdtRecordPtr->RecordHeader = (EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER *)((UINT8 *)mSmmBootPerformanceTable + mSmmBootPerformanceTable->Header.Length);

+ }

+

+ FpdtRecordPtr->RecordHeader->Length = 0;

+ return EFI_SUCCESS;

+}

+

+/**

+Check whether the Token is a known one which is uesed by core.

+

+@param Token Pointer to a Null-terminated ASCII string

+

+@retval TRUE Is a known one used by core.

+@retval FALSE Not a known one.

+

+**/

+BOOLEAN

+IsKnownTokens (

+ IN CONST CHAR8 *Token

+ )

+{

+ if (Token == NULL) {

+ return FALSE;

+ }

+

+ if ((AsciiStrCmp (Token, SEC_TOK) == 0) ||

+ (AsciiStrCmp (Token, PEI_TOK) == 0) ||

+ (AsciiStrCmp (Token, DXE_TOK) == 0) ||

+ (AsciiStrCmp (Token, BDS_TOK) == 0) ||

+ (AsciiStrCmp (Token, DRIVERBINDING_START_TOK) == 0) ||

+ (AsciiStrCmp (Token, DRIVERBINDING_SUPPORT_TOK) == 0) ||

+ (AsciiStrCmp (Token, DRIVERBINDING_STOP_TOK) == 0) ||

+ (AsciiStrCmp (Token, LOAD_IMAGE_TOK) == 0) ||

+ (AsciiStrCmp (Token, START_IMAGE_TOK) == 0) ||

+ (AsciiStrCmp (Token, PEIM_TOK) == 0))

+ {

+ return TRUE;

+ } else {

+ return FALSE;

+ }

+}

+

+/**

+Check whether the ID is a known one which map to the known Token.

+

+@param Identifier 32-bit identifier.

+

+@retval TRUE Is a known one used by core.

+@retval FALSE Not a known one.

+

+**/

+BOOLEAN

+IsKnownID (

+ IN UINT32 Identifier

+ )

+{

+ if ((Identifier == MODULE_START_ID) ||

+ (Identifier == MODULE_END_ID) ||

+ (Identifier == MODULE_LOADIMAGE_START_ID) ||

+ (Identifier == MODULE_LOADIMAGE_END_ID) ||

+ (Identifier == MODULE_DB_START_ID) ||

+ (Identifier == MODULE_DB_END_ID) ||

+ (Identifier == MODULE_DB_SUPPORT_START_ID) ||

+ (Identifier == MODULE_DB_SUPPORT_END_ID) ||

+ (Identifier == MODULE_DB_STOP_START_ID) ||

+ (Identifier == MODULE_DB_STOP_END_ID))

+ {

+ return TRUE;

+ } else {

+ return FALSE;

+ }

+}

+

+/**

+ Get the FPDT record identifier.

+

+ @param Attribute The attribute of the Record.

+ PerfStartEntry: Start Record.

+ PerfEndEntry: End Record.

+ @param Handle Pointer to environment specific context used to identify the component being measured.

+ @param String Pointer to a Null-terminated ASCII string that identifies the component being measured.

+ @param ProgressID On return, pointer to the ProgressID.

+

+ @retval EFI_SUCCESS Get record info successfully.

+ @retval EFI_INVALID_PARAMETER No matched FPDT record.

+

+**/

+EFI_STATUS

+GetFpdtRecordId (

+ IN PERF_MEASUREMENT_ATTRIBUTE Attribute,

+ IN CONST VOID *Handle,

+ IN CONST CHAR8 *String,

+ OUT UINT16 *ProgressID

+ )

+{

+ //

+ // Token to Id.

+ //

+ if (String != NULL) {

+ if (AsciiStrCmp (String, START_IMAGE_TOK) == 0) {

+ // "StartImage:"

+ if (Attribute == PerfStartEntry) {

+ *ProgressID = MODULE_START_ID;

+ } else {

+ *ProgressID = MODULE_END_ID;

+ }

+ } else if (AsciiStrCmp (String, LOAD_IMAGE_TOK) == 0) {

+ // "LoadImage:"

+ if (Attribute == PerfStartEntry) {

+ *ProgressID = MODULE_LOADIMAGE_START_ID;

+ } else {

+ *ProgressID = MODULE_LOADIMAGE_END_ID;

+ }

+ } else {

+ // Pref used in Modules

+ if (Attribute == PerfStartEntry) {

+ *ProgressID = PERF_INMODULE_START_ID;

+ } else {

+ *ProgressID = PERF_INMODULE_END_ID;

+ }

+ }

+ } else if (Handle != NULL) {

+ // Pref used in Modules

+ if (Attribute == PerfStartEntry) {

+ *ProgressID = PERF_INMODULE_START_ID;

+ } else {

+ *ProgressID = PERF_INMODULE_END_ID;

+ }

+ } else {

+ return EFI_UNSUPPORTED;

+ }

+

+ return EFI_SUCCESS;

+}

+

+/**

+ Copies the string from Source into Destination and updates Length with the

+ size of the string.

+

+ @param Destination - destination of the string copy

+ @param Source - pointer to the source string which will get copied

+ @param Length - pointer to a length variable to be updated

+

+**/

+VOID

+CopyStringIntoPerfRecordAndUpdateLength (

+ IN OUT CHAR8 *Destination,

+ IN CONST CHAR8 *Source,

+ IN OUT UINT8 *Length

+ )

+{

+ UINTN StringLen;

+ UINTN DestMax;

+

+ ASSERT (Source != NULL);

+

+ if (PcdGetBool (PcdEdkiiFpdtStringRecordEnableOnly)) {

+ DestMax = STRING_SIZE;

+ } else {

+ DestMax = AsciiStrSize (Source);

+ if (DestMax > STRING_SIZE) {

+ DestMax = STRING_SIZE;

+ }

+ }

+

+ StringLen = AsciiStrLen (Source);

+ if (StringLen >= DestMax) {

+ StringLen = DestMax -1;

+ }

+

+ AsciiStrnCpyS (Destination, DestMax, Source, StringLen);

+ *Length += (UINT8)DestMax;

+

+ return;

+}

+

+/**

+ Create performance record with event description and a timestamp.

+

+ @param CallerIdentifier - Image handle or pointer to caller ID GUID.

+ @param Guid - Pointer to a GUID.

+ @param String - Pointer to a string describing the measurement.

+ @param Ticker - 64-bit time stamp.

+ @param Address - Pointer to a location in memory relevant to the measurement.

+ @param PerfId - Performance identifier describing the type of measurement.

+ @param Attribute - The attribute of the measurement. According to attribute can create a start

+ record for PERF_START/PERF_START_EX, or a end record for PERF_END/PERF_END_EX,

+ or a general record for other Perf macros.

+

+ @retval EFI_SUCCESS - Successfully created performance record.

+ @retval EFI_OUT_OF_RESOURCES - Ran out of space to store the records.

+ @retval EFI_INVALID_PARAMETER - Invalid parameter passed to function - NULL

+ pointer or invalid PerfId.

+

+ @retval EFI_SUCCESS - Successfully created performance record

+ @retval EFI_OUT_OF_RESOURCES - Ran out of space to store the records

+ @retval EFI_INVALID_PARAMETER - Invalid parameter passed to function - NULL

+ pointer or invalid PerfId

+

+**/

+EFI_STATUS

+InsertFpdtRecord (

+ IN CONST VOID *CallerIdentifier OPTIONAL,

+ IN CONST VOID *Guid OPTIONAL,

+ IN CONST CHAR8 *String OPTIONAL,

+ IN UINT64 Ticker,

+ IN UINT64 Address OPTIONAL,

+ IN UINT16 PerfId,

+ IN PERF_MEASUREMENT_ATTRIBUTE Attribute

+ )

+

+{

+ EFI_STATUS Status;

+ EFI_GUID ModuleGuid;

+ CHAR8 ModuleName[FPDT_STRING_EVENT_RECORD_NAME_LENGTH];

+ FPDT_RECORD_PTR FpdtRecordPtr;

+ FPDT_RECORD_PTR CachedFpdtRecordPtr;

+ UINT64 TimeStamp;

+ CONST CHAR8 *StringPtr;

+ UINTN DestMax;

+ UINTN StringLen;

+ UINT16 ProgressId;

+

+ StringPtr = NULL;

+ ZeroMem (ModuleName, sizeof (ModuleName));

+

+ //

+ // 1. Get the Perf Id for records from PERF_START/PERF_END, PERF_START_EX/PERF_END_EX.

+ // notes: For other Perf macros (Attribute == PerfEntry), their Id is known.

+ //

+ if (Attribute != PerfEntry) {

+ //

+ // If PERF_START_EX()/PERF_END_EX() have specified the ProgressID,it has high priority.

+ // !!! Note: If the Perf is not the known Token used in the core but have same

+ // ID with the core Token, this case will not be supported.

+ // And in currtnt usage mode, for the unkown ID, there is a general rule:

+ // If it is start pref: the lower 4 bits of the ID should be 0.

+ // If it is end pref: the lower 4 bits of the ID should not be 0.

+ // If input ID doesn't follow the rule, we will adjust it.

+ //

+ if ((PerfId != 0) && (IsKnownID (PerfId)) && (!IsKnownTokens (String))) {

+ return EFI_INVALID_PARAMETER;

+ } else if ((PerfId != 0) && (!IsKnownID (PerfId)) && (!IsKnownTokens (String))) {

+ if ((Attribute == PerfStartEntry) && ((PerfId & 0x000F) != 0)) {

+ PerfId &= 0xFFF0;

+ } else if ((Attribute == PerfEndEntry) && ((PerfId & 0x000F) == 0)) {

+ PerfId += 1;

+ }

+ }

+

+ if (PerfId == 0) {

+ //

+ // Get ProgressID form the String Token.

+ //

+ Status = GetFpdtRecordId (Attribute, CallerIdentifier, String, &ProgressId);

+ if (EFI_ERROR (Status)) {

+ return Status;

+ }

+

+ PerfId = ProgressId;

+ }

+ }

+

+ //

+ // 2. Get the buffer to store the FPDT record.

+ //

+ Status = GetFpdtRecordPtr (FPDT_MAX_PERF_RECORD_SIZE, &FpdtRecordPtr);

+ if (EFI_ERROR (Status)) {

+ return Status;

+ }

+

+ //

+ // 3. Get the TimeStamp.

+ //

+ if (Ticker == 0) {

+ Ticker = GetPerformanceCounter ();

+ TimeStamp = GetTimeInNanoSecond (Ticker);

+ } else if (Ticker == 1) {

+ TimeStamp = 0;

+ } else {

+ TimeStamp = GetTimeInNanoSecond (Ticker);

+ }

+

+ //

+ // 4. Fill in the FPDT record according to different Performance Identifier.

+ //

+ switch (PerfId) {

+ case MODULE_START_ID:

+ case MODULE_END_ID:

+ GetModuleInfoFromHandle ((EFI_HANDLE)CallerIdentifier, ModuleName, sizeof (ModuleName), &ModuleGuid);

+ StringPtr = ModuleName;

+ //

+ // Cache the offset of start image start record and use to update the start image end record if needed.

+ //

+ if ((PerfId == MODULE_START_ID) && (Attribute == PerfEntry)) {

+ mCachedLength = mSmmBootPerformanceTable->Header.Length;

+ }

+

+ if (!PcdGetBool (PcdEdkiiFpdtStringRecordEnableOnly)) {

+ FpdtRecordPtr.GuidEvent->Header.Type = FPDT_GUID_EVENT_TYPE;

+ FpdtRecordPtr.GuidEvent->Header.Length = sizeof (FPDT_GUID_EVENT_RECORD);

+ FpdtRecordPtr.GuidEvent->Header.Revision = FPDT_RECORD_REVISION_1;

+ FpdtRecordPtr.GuidEvent->ProgressID = PerfId;

+ FpdtRecordPtr.GuidEvent->Timestamp = TimeStamp;

+ CopyMem (&FpdtRecordPtr.GuidEvent->Guid, &ModuleGuid, sizeof (FpdtRecordPtr.GuidEvent->Guid));

+ if ((CallerIdentifier == NULL) && (PerfId == MODULE_END_ID) && (mCachedLength != 0)) {

+ CachedFpdtRecordPtr.RecordHeader = (EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER *)((UINT8 *)mSmmBootPerformanceTable + mCachedLength);

+ CopyMem (&FpdtRecordPtr.GuidEvent->Guid, &CachedFpdtRecordPtr.GuidEvent->Guid, sizeof (FpdtRecordPtr.GuidEvent->Guid));

+ mCachedLength = 0;

+ }

+ }

+

+ break;

+

+ case MODULE_LOADIMAGE_START_ID:

+ case MODULE_LOADIMAGE_END_ID:

+ GetModuleInfoFromHandle ((EFI_HANDLE)CallerIdentifier, ModuleName, sizeof (ModuleName), &ModuleGuid);

+ StringPtr = ModuleName;

+ if (PerfId == MODULE_LOADIMAGE_START_ID) {

+ mLoadImageCount++;

+ //

+ // Cache the offset of load image start record and use to be updated by the load image end record if needed.

+ //

+ if ((CallerIdentifier == NULL) && (Attribute == PerfEntry)) {

+ mCachedLength = mSmmBootPerformanceTable->Header.Length;

+ }

+ }

+

+ if (!PcdGetBool (PcdEdkiiFpdtStringRecordEnableOnly)) {

+ FpdtRecordPtr.GuidQwordEvent->Header.Type = FPDT_GUID_QWORD_EVENT_TYPE;

+ FpdtRecordPtr.GuidQwordEvent->Header.Length = sizeof (FPDT_GUID_QWORD_EVENT_RECORD);

+ FpdtRecordPtr.GuidQwordEvent->Header.Revision = FPDT_RECORD_REVISION_1;

+ FpdtRecordPtr.GuidQwordEvent->ProgressID = PerfId;

+ FpdtRecordPtr.GuidQwordEvent->Timestamp = TimeStamp;

+ FpdtRecordPtr.GuidQwordEvent->Qword = mLoadImageCount;

+ CopyMem (&FpdtRecordPtr.GuidQwordEvent->Guid, &ModuleGuid, sizeof (FpdtRecordPtr.GuidQwordEvent->Guid));

+ if ((PerfId == MODULE_LOADIMAGE_END_ID) && (mCachedLength != 0)) {

+ CachedFpdtRecordPtr.RecordHeader = (EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER *)((UINT8 *)mSmmBootPerformanceTable + mCachedLength);

+ CopyMem (&CachedFpdtRecordPtr.GuidQwordEvent->Guid, &ModuleGuid, sizeof (CachedFpdtRecordPtr.GuidQwordEvent->Guid));

+ mCachedLength = 0;

+ }

+ }

+

+ break;

+

+ case PERF_EVENTSIGNAL_START_ID:

+ case PERF_EVENTSIGNAL_END_ID:

+ case PERF_CALLBACK_START_ID:

+ case PERF_CALLBACK_END_ID:

+ if ((String == NULL) || (Guid == NULL)) {

+ return EFI_INVALID_PARAMETER;

+ }

+

+ StringPtr = String;

+ if (AsciiStrLen (String) == 0) {

+ StringPtr = "unknown name";

+ }

+

+ if (!PcdGetBool (PcdEdkiiFpdtStringRecordEnableOnly)) {

+ FpdtRecordPtr.DualGuidStringEvent->Header.Type = FPDT_DUAL_GUID_STRING_EVENT_TYPE;

+ FpdtRecordPtr.DualGuidStringEvent->Header.Length = sizeof (FPDT_DUAL_GUID_STRING_EVENT_RECORD);

+ FpdtRecordPtr.DualGuidStringEvent->Header.Revision = FPDT_RECORD_REVISION_1;

+ FpdtRecordPtr.DualGuidStringEvent->ProgressID = PerfId;

+ FpdtRecordPtr.DualGuidStringEvent->Timestamp = TimeStamp;

+ CopyMem (&FpdtRecordPtr.DualGuidStringEvent->Guid1, CallerIdentifier, sizeof (FpdtRecordPtr.DualGuidStringEvent->Guid1));

+ CopyMem (&FpdtRecordPtr.DualGuidStringEvent->Guid2, Guid, sizeof (FpdtRecordPtr.DualGuidStringEvent->Guid2));

+ CopyStringIntoPerfRecordAndUpdateLength (FpdtRecordPtr.DualGuidStringEvent->String, StringPtr, &FpdtRecordPtr.DualGuidStringEvent->Header.Length);

+ }

+

+ break;

+

+ case PERF_EVENT_ID:

+ case PERF_FUNCTION_START_ID:

+ case PERF_FUNCTION_END_ID:

+ case PERF_INMODULE_START_ID:

+ case PERF_INMODULE_END_ID:

+ case PERF_CROSSMODULE_START_ID:

+ case PERF_CROSSMODULE_END_ID:

+ GetModuleInfoFromHandle ((EFI_HANDLE)CallerIdentifier, ModuleName, sizeof (ModuleName), &ModuleGuid);

+ if (String != NULL) {

+ StringPtr = String;

+ } else {

+ StringPtr = ModuleName;

+ }

+

+ if (AsciiStrLen (StringPtr) == 0) {

+ StringPtr = "unknown name";

+ }

+

+ if (!PcdGetBool (PcdEdkiiFpdtStringRecordEnableOnly)) {

+ FpdtRecordPtr.DynamicStringEvent->Header.Type = FPDT_DYNAMIC_STRING_EVENT_TYPE;

+ FpdtRecordPtr.DynamicStringEvent->Header.Length = sizeof (FPDT_DYNAMIC_STRING_EVENT_RECORD);

+ FpdtRecordPtr.DynamicStringEvent->Header.Revision = FPDT_RECORD_REVISION_1;

+ FpdtRecordPtr.DynamicStringEvent->ProgressID = PerfId;

+ FpdtRecordPtr.DynamicStringEvent->Timestamp = TimeStamp;

+ CopyMem (&FpdtRecordPtr.DynamicStringEvent->Guid, &ModuleGuid, sizeof (FpdtRecordPtr.DynamicStringEvent->Guid));

+ CopyStringIntoPerfRecordAndUpdateLength (FpdtRecordPtr.DynamicStringEvent->String, StringPtr, &FpdtRecordPtr.DynamicStringEvent->Header.Length);

+ }

+

+ break;

+

+ default:

+ if (Attribute != PerfEntry) {

+ GetModuleInfoFromHandle ((EFI_HANDLE)CallerIdentifier, ModuleName, sizeof (ModuleName), &ModuleGuid);

+ if (String != NULL) {

+ StringPtr = String;

+ } else {

+ StringPtr = ModuleName;

+ }

+

+ if (AsciiStrLen (StringPtr) == 0) {

+ StringPtr = "unknown name";

+ }

+

+ if (!PcdGetBool (PcdEdkiiFpdtStringRecordEnableOnly)) {

+ FpdtRecordPtr.DynamicStringEvent->Header.Type = FPDT_DYNAMIC_STRING_EVENT_TYPE;

+ FpdtRecordPtr.DynamicStringEvent->Header.Length = sizeof (FPDT_DYNAMIC_STRING_EVENT_RECORD);

+ FpdtRecordPtr.DynamicStringEvent->Header.Revision = FPDT_RECORD_REVISION_1;

+ FpdtRecordPtr.DynamicStringEvent->ProgressID = PerfId;

+ FpdtRecordPtr.DynamicStringEvent->Timestamp = TimeStamp;

+ CopyMem (&FpdtRecordPtr.DynamicStringEvent->Guid, &ModuleGuid, sizeof (FpdtRecordPtr.DynamicStringEvent->Guid));

+ CopyStringIntoPerfRecordAndUpdateLength (FpdtRecordPtr.DynamicStringEvent->String, StringPtr, &FpdtRecordPtr.DynamicStringEvent->Header.Length);

+ }

+ } else {

+ return EFI_INVALID_PARAMETER;

+ }

+

+ break;

+ }

+

+ //

+ // 4.2 When PcdEdkiiFpdtStringRecordEnableOnly==TRUE, create string record for all Perf entries.

+ //

+ if (PcdGetBool (PcdEdkiiFpdtStringRecordEnableOnly)) {

+ if (StringPtr == NULL) {

+ return EFI_INVALID_PARAMETER;

+ }

+

+ FpdtRecordPtr.DynamicStringEvent->Header.Type = FPDT_DYNAMIC_STRING_EVENT_TYPE;

+ FpdtRecordPtr.DynamicStringEvent->Header.Length = sizeof (FPDT_DYNAMIC_STRING_EVENT_RECORD);

+ FpdtRecordPtr.DynamicStringEvent->Header.Revision = FPDT_RECORD_REVISION_1;

+ FpdtRecordPtr.DynamicStringEvent->ProgressID = PerfId;

+ FpdtRecordPtr.DynamicStringEvent->Timestamp = TimeStamp;

+ if (Guid != NULL) {

+ //

+ // Cache the event guid in string event record.

+ //

+ CopyMem (&FpdtRecordPtr.DynamicStringEvent->Guid, Guid, sizeof (FpdtRecordPtr.DynamicStringEvent->Guid));

+ } else {

+ CopyMem (&FpdtRecordPtr.DynamicStringEvent->Guid, &ModuleGuid, sizeof (FpdtRecordPtr.DynamicStringEvent->Guid));

+ }

+

+ if (AsciiStrLen (StringPtr) == 0) {

+ StringPtr = "unknown name";

+ }

+

+ CopyStringIntoPerfRecordAndUpdateLength (FpdtRecordPtr.DynamicStringEvent->String, StringPtr, &FpdtRecordPtr.DynamicStringEvent->Header.Length);

+

+ if ((PerfId == MODULE_LOADIMAGE_START_ID) || (PerfId == MODULE_END_ID)) {

+ FpdtRecordPtr.DynamicStringEvent->Header.Length = (UINT8)(sizeof (FPDT_DYNAMIC_STRING_EVENT_RECORD)+ STRING_SIZE);

+ }

+

+ if (((PerfId == MODULE_LOADIMAGE_END_ID) || (PerfId == MODULE_END_ID)) && (mCachedLength != 0)) {

+ CachedFpdtRecordPtr.RecordHeader = (EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER *)((UINT8 *)mSmmBootPerformanceTable + mCachedLength);

+ if (PerfId == MODULE_LOADIMAGE_END_ID) {

+ DestMax = CachedFpdtRecordPtr.DynamicStringEvent->Header.Length - sizeof (FPDT_DYNAMIC_STRING_EVENT_RECORD);

+ StringLen = AsciiStrLen (StringPtr);

+ if (StringLen >= DestMax) {

+ StringLen = DestMax -1;

+ }

+

+ CopyMem (&CachedFpdtRecordPtr.DynamicStringEvent->Guid, &ModuleGuid, sizeof (CachedFpdtRecordPtr.DynamicStringEvent->Guid));

+ AsciiStrnCpyS (CachedFpdtRecordPtr.DynamicStringEvent->String, DestMax, StringPtr, StringLen);

+ } else if (PerfId == MODULE_END_ID) {

+ DestMax = FpdtRecordPtr.DynamicStringEvent->Header.Length - sizeof (FPDT_DYNAMIC_STRING_EVENT_RECORD);

+ StringLen = AsciiStrLen (CachedFpdtRecordPtr.DynamicStringEvent->String);

+ if (StringLen >= DestMax) {

+ StringLen = DestMax -1;

+ }

+

+ CopyMem (&FpdtRecordPtr.DynamicStringEvent->Guid, &CachedFpdtRecordPtr.DynamicStringEvent->Guid, sizeof (CachedFpdtRecordPtr.DynamicStringEvent->Guid));

+ AsciiStrnCpyS (FpdtRecordPtr.DynamicStringEvent->String, DestMax, CachedFpdtRecordPtr.DynamicStringEvent->String, StringLen);

+ }

+

+ mCachedLength = 0;

+ }

+ }

+

+ //

+ // 5. Update the length of the used buffer after fill in the record.

+ //

+ mPerformanceLength += FpdtRecordPtr.RecordHeader->Length;

+ mSmmBootPerformanceTable->Header.Length += FpdtRecordPtr.RecordHeader->Length;

+

+ return EFI_SUCCESS;

+}

+

+/**

+ Communication service SMI Handler entry.

+

+ This SMI handler provides services for report MM boot records.

+

+ Caution: This function may receive untrusted input.

+ Communicate buffer and buffer size are external input, so this function will do basic validation.

+

+ @param[in] DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().

+ @param[in] RegisterContext Points to an optional handler context which was specified when the

+ handler was registered.

+ @param[in, out] CommBuffer A pointer to a collection of data in memory that will

+ be conveyed from a non-MM environment into an MM environment.

+ @param[in, out] CommBufferSize The size of the CommBuffer.

+

+ @retval EFI_SUCCESS The interrupt was handled and quiesced. No other handlers

+ should still be called.

+ @retval EFI_WARN_INTERRUPT_SOURCE_QUIESCED The interrupt has been quiesced but other handlers should

+ still be called.

+ @retval EFI_WARN_INTERRUPT_SOURCE_PENDING The interrupt is still pending and other handlers should still

+ be called.

+ @retval EFI_INTERRUPT_PENDING The interrupt could not be quiesced.

+

+**/

+EFI_STATUS

+EFIAPI

+FpdtSmiHandler (

+ IN EFI_HANDLE DispatchHandle,

+ IN CONST VOID *RegisterContext,

+ IN OUT VOID *CommBuffer,

+ IN OUT UINTN *CommBufferSize

+ )

+{

+ EFI_STATUS Status;

+ SMM_BOOT_RECORD_COMMUNICATE *SmmCommData;

+ UINTN BootRecordOffset;

+ UINTN BootRecordSize;

+ VOID *BootRecordData;

+ UINTN TempCommBufferSize;

+ UINT8 *BootRecordBuffer;

+

+ //

+ // If input is invalid, stop processing this SMI

+ //

+ if ((CommBuffer == NULL) || (CommBufferSize == NULL)) {

+ return EFI_SUCCESS;

+ }

+

+ TempCommBufferSize = *CommBufferSize;

+

+ if (TempCommBufferSize < sizeof (SMM_BOOT_RECORD_COMMUNICATE)) {

+ return EFI_SUCCESS;

+ }

+

+ if (!MmCorePerformanceIsPrimaryBufferValid ((UINTN)CommBuffer, TempCommBufferSize)) {

+ ASSERT (FALSE);

+ return EFI_SUCCESS;

+ }

+

+ SmmCommData = (SMM_BOOT_RECORD_COMMUNICATE *)CommBuffer;

+

+ Status = EFI_SUCCESS;

+

+ switch (SmmCommData->Function) {

+ case SMM_FPDT_FUNCTION_GET_BOOT_RECORD_SIZE:

+ DEBUG ((DEBUG_VERBOSE, "[%a] - SMM_FPDT_FUNCTION_GET_BOOT_RECORD_SIZE entry.\n", __func__));

+ if (mSmmBootPerformanceTable != NULL) {

+ mBootRecordSize = mSmmBootPerformanceTable->Header.Length - sizeof (SMM_BOOT_PERFORMANCE_TABLE);

+ }

+

+ SmmCommData->BootRecordSize = mBootRecordSize;

+ break;

+

+ case SMM_FPDT_FUNCTION_GET_BOOT_RECORD_DATA:

+ DEBUG ((DEBUG_VERBOSE, "[%a] - SMM_FPDT_FUNCTION_GET_BOOT_RECORD_DATA entry.\n", __func__));

+ Status = EFI_UNSUPPORTED;

+ break;

+

+ case SMM_FPDT_FUNCTION_GET_BOOT_RECORD_DATA_BY_OFFSET:

+ DEBUG ((DEBUG_VERBOSE, "[%a] - SMM_FPDT_FUNCTION_GET_BOOT_RECORD_DATA_BY_OFFSET entry.\n", __func__));

+ BootRecordOffset = SmmCommData->BootRecordOffset;

+ BootRecordData = SmmCommData->BootRecordData;

+ BootRecordSize = SmmCommData->BootRecordSize;

+

+ if (BootRecordOffset >= mBootRecordSize) {

+ Status = EFI_INVALID_PARAMETER;

+ break;

+ }

+

+ if (BootRecordData == NULL) {

+ BootRecordData = (UINT8 *)SmmCommData + sizeof (SMM_BOOT_RECORD_COMMUNICATE);

+ } else if (!MmCorePerformanceIsNonPrimaryBufferValid ((UINTN)BootRecordData, BootRecordSize)) {

+ Status = EFI_ACCESS_DENIED;

+ break;

+ }

+

+ //

+ // Sanity check

+ //

+ if (BootRecordSize > mBootRecordSize - BootRecordOffset) {

+ BootRecordSize = mBootRecordSize - BootRecordOffset;

+ }

+

+ // Note: Comm size passed to this handler already has OFFSET_OF (EFI_MM_COMMUNICATE_HEADER, Data) removed.

+ if ((SmmCommData->BootRecordData == NULL) && (BootRecordSize > TempCommBufferSize - sizeof (SMM_BOOT_RECORD_COMMUNICATE))) {

+ Status = EFI_BUFFER_TOO_SMALL;

+ break;

+ }

+

+ SmmCommData->BootRecordSize = BootRecordSize;

+ BootRecordBuffer = ((UINT8 *)(mSmmBootPerformanceTable)) + sizeof (SMM_BOOT_PERFORMANCE_TABLE);

+ CopyMem (

+ (UINT8 *)BootRecordData,

+ BootRecordBuffer + BootRecordOffset,

+ BootRecordSize

+ );

+ mFpdtDataIsReported = TRUE;

+ break;

+

+ default:

+ Status = EFI_UNSUPPORTED;

+ }

+

+ SmmCommData->ReturnStatus = Status;

+

+ return EFI_SUCCESS;

+}

+

+/**

+ This is the Event call back function is triggered in SMM to notify the Library

+ the system is entering runtime phase.

+

+ @param[in] Protocol Points to the protocol's unique identifier

+ @param[in] Interface Points to the interface instance

+ @param[in] Handle The handle on which the interface was installed

+

+ @retval EFI_SUCCESS SmmAtRuntimeCallBack runs successfully

+ **/

+EFI_STATUS

+EFIAPI

+SmmCorePerformanceLibExitBootServicesCallback (

+ IN CONST EFI_GUID *Protocol,

+ IN VOID *Interface,

+ IN EFI_HANDLE Handle

+ )

+{

+ //

+ // Disable performance measurement after ExitBootServices because

+ // 1. Performance measurement might impact SMI latency at runtime;

+ // 2. Performance log is copied to non SMRAM at ReadyToBoot so runtime performance

+ // log is not useful.

+ //

+ mPerformanceMeasurementEnabled = FALSE;

+

+ return EFI_SUCCESS;

+}

+

+/**

+ Common initialization code for the MM Core Performance Library.

+

+ @param[in] ExitBootServicesProtocolGuid The GUID of the ExitBootServices protocol.

+

+ @retval EFI_SUCCESS The MM Core Performance Library was initialized successfully.

+ @retval Others The MM Core Performance Library was not initialized successfully.

+ **/

+EFI_STATUS

+InitializeMmCorePerformanceLibCommon (

+ IN CONST EFI_GUID *ExitBootServicesProtocolGuid

+ )

+{

+ EFI_STATUS Status;

+ EFI_HANDLE Handle;

+ EFI_HANDLE MmiHandle;

+ VOID *Registration;

+

+ //

+ // Initialize spin lock

+ //

+ InitializeSpinLock (&mSmmFpdtLock);

+

+ //

+ // Install the protocol interfaces for MM performance library instance.

+ //

+ Handle = NULL;

+ Status = gMmst->MmInstallProtocolInterface (

+ &Handle,

+ &gEdkiiSmmPerformanceMeasurementProtocolGuid,

+ EFI_NATIVE_INTERFACE,

+ &mPerformanceMeasurementInterface

+ );

+ ASSERT_EFI_ERROR (Status);

+

+ //

+ // Register MMI handler.

+ //

+ MmiHandle = NULL;

+ Status = gMmst->MmiHandlerRegister (FpdtSmiHandler, &gEfiFirmwarePerformanceGuid, &MmiHandle);

+ if (EFI_ERROR (Status)) {

+ return Status;

+ }

+

+ //

+ // Register callback function for ExitBootServices event.

+ //

+ Status = gMmst->MmRegisterProtocolNotify (

+ ExitBootServicesProtocolGuid,

+ SmmCorePerformanceLibExitBootServicesCallback,

+ &Registration

+ );

+

+ return Status;

+}

+

+/**

+ Create performance record with event description and a timestamp.

+

+ @param CallerIdentifier - Image handle or pointer to caller ID GUID.

+ @param Guid - Pointer to a GUID.

+ @param String - Pointer to a string describing the measurement.

+ @param TimeStamp - 64-bit time stamp.

+ @param Address - Pointer to a location in memory relevant to the measurement.

+ @param Identifier - Performance identifier describing the type of measurement.

+ @param Attribute - The attribute of the measurement. According to attribute can create a start

+ record for PERF_START/PERF_START_EX, or a end record for PERF_END/PERF_END_EX,

+ or a general record for other Perf macros.

+

+ @retval EFI_SUCCESS - Successfully created performance record.

+ @retval EFI_OUT_OF_RESOURCES - Ran out of space to store the records.

+ @retval EFI_INVALID_PARAMETER - Invalid parameter passed to function - NULL

+ pointer or invalid PerfId.

+**/

+EFI_STATUS

+EFIAPI

+CreatePerformanceMeasurement (

+ IN CONST VOID *CallerIdentifier OPTIONAL,

+ IN CONST VOID *Guid OPTIONAL,

+ IN CONST CHAR8 *String OPTIONAL,

+ IN UINT64 TimeStamp OPTIONAL,

+ IN UINT64 Address OPTIONAL,

+ IN UINT32 Identifier,

+ IN PERF_MEASUREMENT_ATTRIBUTE Attribute

+ )

+{

+ EFI_STATUS Status;

+

+ Status = EFI_SUCCESS;

+

+ AcquireSpinLock (&mSmmFpdtLock);

+ Status = InsertFpdtRecord (CallerIdentifier, Guid, String, TimeStamp, Address, (UINT16)Identifier, Attribute);

+ ReleaseSpinLock (&mSmmFpdtLock);

+ return Status;

+}

+

+/**

+ Adds a record at the end of the performance measurement log

+ that records the start time of a performance measurement.

+

+ Adds a record to the end of the performance measurement log

+ that contains the Handle, Token, Module and Identifier.

+ The end time of the new record must be set to zero.

+ If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.

+ If TimeStamp is zero, the start time in the record is filled in with the value

+ read from the current time stamp.

+

+ @param Handle Pointer to environment specific context used

+ to identify the component being measured.

+ @param Token Pointer to a Null-terminated ASCII string

+ that identifies the component being measured.

+ @param Module Pointer to a Null-terminated ASCII string

+ that identifies the module being measured.

+ @param TimeStamp 64-bit time stamp.

+ @param Identifier 32-bit identifier. If the value is 0, the created record

+ is same as the one created by StartPerformanceMeasurement.

+

+ @retval RETURN_SUCCESS The start of the measurement was recorded.

+ @retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.

+

+**/

+RETURN_STATUS

+EFIAPI

+StartPerformanceMeasurementEx (

+ IN CONST VOID *Handle OPTIONAL,

+ IN CONST CHAR8 *Token OPTIONAL,

+ IN CONST CHAR8 *Module OPTIONAL,

+ IN UINT64 TimeStamp,

+ IN UINT32 Identifier

+ )

+{

+ CONST CHAR8 *String;

+

+ if (Token != NULL) {

+ String = Token;

+ } else if (Module != NULL) {

+ String = Module;

+ } else {

+ String = NULL;

+ }

+

+ return (RETURN_STATUS)CreatePerformanceMeasurement (Handle, NULL, String, TimeStamp, 0, Identifier, PerfStartEntry);

+}

+

+/**

+ Searches the performance measurement log from the beginning of the log

+ for the first matching record that contains a zero end time and fills in a valid end time.

+

+ Searches the performance measurement log from the beginning of the log

+ for the first record that matches Handle, Token, Module and Identifier and has an end time value of zero.

+ If the record can not be found then return RETURN_NOT_FOUND.

+ If the record is found and TimeStamp is not zero,

+ then the end time in the record is filled in with the value specified by TimeStamp.

+ If the record is found and TimeStamp is zero, then the end time in the matching record

+ is filled in with the current time stamp value.

+

+ @param Handle Pointer to environment specific context used

+ to identify the component being measured.

+ @param Token Pointer to a Null-terminated ASCII string

+ that identifies the component being measured.

+ @param Module Pointer to a Null-terminated ASCII string

+ that identifies the module being measured.

+ @param TimeStamp 64-bit time stamp.

+ @param Identifier 32-bit identifier. If the value is 0, the found record

+ is same as the one found by EndPerformanceMeasurement.

+

+ @retval RETURN_SUCCESS The end of the measurement was recorded.

+ @retval RETURN_NOT_FOUND The specified measurement record could not be found.

+

+**/

+RETURN_STATUS

+EFIAPI

+EndPerformanceMeasurementEx (

+ IN CONST VOID *Handle OPTIONAL,

+ IN CONST CHAR8 *Token OPTIONAL,

+ IN CONST CHAR8 *Module OPTIONAL,

+ IN UINT64 TimeStamp,

+ IN UINT32 Identifier

+ )

+{

+ CONST CHAR8 *String;

+

+ if (Token != NULL) {

+ String = Token;

+ } else if (Module != NULL) {

+ String = Module;

+ } else {

+ String = NULL;

+ }

+

+ return (RETURN_STATUS)CreatePerformanceMeasurement (Handle, NULL, String, TimeStamp, 0, Identifier, PerfEndEntry);

+}

+

+/**

+ Attempts to retrieve a performance measurement log entry from the performance measurement log.

+ It can also retrieve the log created by StartPerformanceMeasurement and EndPerformanceMeasurement,

+ and then assign the Identifier with 0.

+

+ !!! Not Support!!!

+

+ Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is

+ zero on entry, then an attempt is made to retrieve the first entry from the performance log,

+ and the key for the second entry in the log is returned. If the performance log is empty,

+ then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance

+ log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is

+ returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is

+ retrieved and an implementation specific non-zero key value that specifies the end of the performance

+ log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry

+ is retrieved and zero is returned. In the cases where a performance log entry can be returned,

+ the log entry is returned in Handle, Token, Module, StartTimeStamp, EndTimeStamp and Identifier.

+ If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().

+ If Handle is NULL, then ASSERT().

+ If Token is NULL, then ASSERT().

+ If Module is NULL, then ASSERT().

+ If StartTimeStamp is NULL, then ASSERT().

+ If EndTimeStamp is NULL, then ASSERT().

+ If Identifier is NULL, then ASSERT().

+

+ @param LogEntryKey On entry, the key of the performance measurement log entry to retrieve.

+ 0, then the first performance measurement log entry is retrieved.

+ On exit, the key of the next performance log entry.

+ @param Handle Pointer to environment specific context used to identify the component

+ being measured.

+ @param Token Pointer to a Null-terminated ASCII string that identifies the component

+ being measured.

+ @param Module Pointer to a Null-terminated ASCII string that identifies the module

+ being measured.

+ @param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement

+ was started.

+ @param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement

+ was ended.

+ @param Identifier Pointer to the 32-bit identifier that was recorded.

+

+ @return The key for the next performance log entry (in general case).

+

+**/

+UINTN

+EFIAPI

+GetPerformanceMeasurementEx (

+ IN UINTN LogEntryKey,

+ OUT CONST VOID **Handle,

+ OUT CONST CHAR8 **Token,

+ OUT CONST CHAR8 **Module,

+ OUT UINT64 *StartTimeStamp,

+ OUT UINT64 *EndTimeStamp,

+ OUT UINT32 *Identifier

+ )

+{

+ return 0;

+}

+

+/**

+ Adds a record at the end of the performance measurement log

+ that records the start time of a performance measurement.

+

+ Adds a record to the end of the performance measurement log

+ that contains the Handle, Token, and Module.

+ The end time of the new record must be set to zero.

+ If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.

+ If TimeStamp is zero, the start time in the record is filled in with the value

+ read from the current time stamp.

+

+ @param Handle Pointer to environment specific context used

+ to identify the component being measured.

+ @param Token Pointer to a Null-terminated ASCII string

+ that identifies the component being measured.

+ @param Module Pointer to a Null-terminated ASCII string

+ that identifies the module being measured.

+ @param TimeStamp 64-bit time stamp.

+

+ @retval RETURN_SUCCESS The start of the measurement was recorded.

+ @retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.

+

+**/

+RETURN_STATUS

+EFIAPI

+StartPerformanceMeasurement (

+ IN CONST VOID *Handle OPTIONAL,

+ IN CONST CHAR8 *Token OPTIONAL,

+ IN CONST CHAR8 *Module OPTIONAL,

+ IN UINT64 TimeStamp

+ )

+{

+ return StartPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, 0);

+}

+

+/**

+ Searches the performance measurement log from the beginning of the log

+ for the first matching record that contains a zero end time and fills in a valid end time.

+

+ Searches the performance measurement log from the beginning of the log

+ for the first record that matches Handle, Token, and Module and has an end time value of zero.

+ If the record can not be found then return RETURN_NOT_FOUND.

+ If the record is found and TimeStamp is not zero,

+ then the end time in the record is filled in with the value specified by TimeStamp.

+ If the record is found and TimeStamp is zero, then the end time in the matching record

+ is filled in with the current time stamp value.

+

+ @param Handle Pointer to environment specific context used

+ to identify the component being measured.

+ @param Token Pointer to a Null-terminated ASCII string

+ that identifies the component being measured.

+ @param Module Pointer to a Null-terminated ASCII string

+ that identifies the module being measured.

+ @param TimeStamp 64-bit time stamp.

+

+ @retval RETURN_SUCCESS The end of the measurement was recorded.

+ @retval RETURN_NOT_FOUND The specified measurement record could not be found.

+

+**/

+RETURN_STATUS

+EFIAPI

+EndPerformanceMeasurement (

+ IN CONST VOID *Handle OPTIONAL,

+ IN CONST CHAR8 *Token OPTIONAL,

+ IN CONST CHAR8 *Module OPTIONAL,

+ IN UINT64 TimeStamp

+ )

+{

+ return EndPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, 0);

+}

+

+/**

+ Attempts to retrieve a performance measurement log entry from the performance measurement log.

+ It can also retrieve the log created by StartPerformanceMeasurementEx and EndPerformanceMeasurementEx,

+ and then eliminate the Identifier.

+

+ !!! Not Support!!!

+

+ Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is

+ zero on entry, then an attempt is made to retrieve the first entry from the performance log,

+ and the key for the second entry in the log is returned. If the performance log is empty,

+ then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance

+ log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is

+ returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is

+ retrieved and an implementation specific non-zero key value that specifies the end of the performance

+ log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry

+ is retrieved and zero is returned. In the cases where a performance log entry can be returned,

+ the log entry is returned in Handle, Token, Module, StartTimeStamp, and EndTimeStamp.

+ If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().

+ If Handle is NULL, then ASSERT().

+ If Token is NULL, then ASSERT().

+ If Module is NULL, then ASSERT().

+ If StartTimeStamp is NULL, then ASSERT().

+ If EndTimeStamp is NULL, then ASSERT().

+

+ @param LogEntryKey On entry, the key of the performance measurement log entry to retrieve.

+ 0, then the first performance measurement log entry is retrieved.

+ On exit, the key of the next performance log entry.

+ @param Handle Pointer to environment specific context used to identify the component

+ being measured.

+ @param Token Pointer to a Null-terminated ASCII string that identifies the component

+ being measured.

+ @param Module Pointer to a Null-terminated ASCII string that identifies the module

+ being measured.

+ @param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement

+ was started.

+ @param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement

+ was ended.

+

+ @return The key for the next performance log entry (in general case).

+

+**/

+UINTN

+EFIAPI

+GetPerformanceMeasurement (

+ IN UINTN LogEntryKey,

+ OUT CONST VOID **Handle,

+ OUT CONST CHAR8 **Token,

+ OUT CONST CHAR8 **Module,

+ OUT UINT64 *StartTimeStamp,

+ OUT UINT64 *EndTimeStamp

+ )

+{

+ return 0;

+}

+

+/**

+ Returns TRUE if the performance measurement macros are enabled.

+

+ This function returns TRUE if the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of

+ PcdPerformanceLibraryPropertyMask is set. Otherwise FALSE is returned.

+

+ @retval TRUE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of

+ PcdPerformanceLibraryPropertyMask is set.

+ @retval FALSE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of

+ PcdPerformanceLibraryPropertyMask is clear.

+

+**/

+BOOLEAN

+EFIAPI

+PerformanceMeasurementEnabled (

+ VOID

+ )

+{

+ return mPerformanceMeasurementEnabled;

+}

+

+/**

+ Create performance record with event description and a timestamp.

+

+ @param CallerIdentifier - Image handle or pointer to caller ID GUID

+ @param Guid - Pointer to a GUID

+ @param String - Pointer to a string describing the measurement

+ @param Address - Pointer to a location in memory relevant to the measurement

+ @param Identifier - Performance identifier describing the type of measurement

+

+ @retval RETURN_SUCCESS - Successfully created performance record

+ @retval RETURN_OUT_OF_RESOURCES - Ran out of space to store the records

+ @retval RETURN_INVALID_PARAMETER - Invalid parameter passed to function - NULL

+ pointer or invalid PerfId

+

+**/

+RETURN_STATUS

+EFIAPI

+LogPerformanceMeasurement (

+ IN CONST VOID *CallerIdentifier,

+ IN CONST VOID *Guid OPTIONAL,

+ IN CONST CHAR8 *String OPTIONAL,

+ IN UINT64 Address OPTIONAL,

+ IN UINT32 Identifier

+ )

+{

+ return (RETURN_STATUS)CreatePerformanceMeasurement (CallerIdentifier, Guid, String, 0, Address, Identifier, PerfEntry);

+}

+

+/**

+ Check whether the specified performance measurement can be logged.

+

+ This function returns TRUE when the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set

+ and the Type disable bit in PcdPerformanceLibraryPropertyMask is not set.

+

+ @param Type - Type of the performance measurement entry.

+

+ @retval TRUE The performance measurement can be logged.

+ @retval FALSE The performance measurement can NOT be logged.

+

+**/

+BOOLEAN

+EFIAPI

+LogPerformanceMeasurementEnabled (

+ IN CONST UINTN Type

+ )

+{

+ //

+ // When Performance measurement is enabled and the type is not filtered, the performance can be logged.

+ //

+ if (PerformanceMeasurementEnabled () && ((PcdGet8 (PcdPerformanceLibraryPropertyMask) & Type) == 0)) {

+ return TRUE;

+ }

+

+ return FALSE;

+}

+Copyright (c) Microsoft Corporation.

+#include <Library/DxeServicesLib.h>

+#include <Library/SmmMemLib.h>

+#include <Library/UefiBootServicesTableLib.h>

+#include <Library/UefiLib.h>

+#include <Protocol/SmmBase2.h>

+#include <Protocol/SmmExitBootServices.h>

+ A library internal MM-instance specific implementation to check if a buffer outside MM is valid.

+ This function is provided so Standalone MM and Traditional MM may use a different implementation

+ of data buffer check logic.

+ @param[in] Buffer The buffer start address to be checked.

+ @param[in] Length The buffer length to be checked.

+ @retval TRUE This buffer is valid per processor architecture.

+ @retval FALSE This buffer is not valid per processor architecture.

+MmCorePerformanceIsNonPrimaryBufferValid (

+ IN EFI_PHYSICAL_ADDRESS Buffer,

+ IN UINT64 Length

+ return SmmIsBufferOutsideSmmValid (Buffer, Length);

+ A library internal MM-instance specific implementation to check if a comm buffer is valid.

+ This function is provided so Standalone MM and Traditional MM may use a different implementation

+ of comm buffer check logic.

+ @param[in] Buffer The buffer start address to be checked.

+ @param[in] Length The buffer length to be checked.

+ @retval TRUE This communicate buffer is valid per processor architecture.

+ @retval FALSE This communicate buffer is not valid per processor architecture.

+MmCorePerformanceIsPrimaryBufferValid (

+ IN EFI_PHYSICAL_ADDRESS Buffer,

+ IN UINT64 Length

+ return SmmIsBufferOutsideSmmValid (Buffer, Length);

+ Return a pointer to the loaded image protocol for the given handle.

+ @param[in] Handle A handle to query for the loaded image protocol.

+ @return A pointer to a loaded image protocol instance or null if the handle does not support load image protocol.

+EFI_LOADED_IMAGE_PROTOCOL *

+GetLoadedImageProtocol (

+ IN EFI_HANDLE Handle

+ EFI_STATUS Status;

+ EFI_DRIVER_BINDING_PROTOCOL *DriverBinding;

+ EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;

+ if (Handle == NULL) {

+ return NULL;

+ LoadedImage = NULL;

+ // Try Handle as ImageHandle.

+ Status = gBS->HandleProtocol (

+ Handle,

+ &gEfiLoadedImageProtocolGuid,

+ (VOID **)&LoadedImage

+ );

+ if (EFI_ERROR (Status)) {

+ // Try Handle as Controller Handle

+ Status = gBS->OpenProtocol (

+ &gEfiDriverBindingProtocolGuid,

+ (VOID **)&DriverBinding,

+ NULL,

+ NULL,

+ EFI_OPEN_PROTOCOL_GET_PROTOCOL

+ // Get Image protocol from ImageHandle

+ Status = gBS->HandleProtocol (

+ DriverBinding->ImageHandle,

+ &gEfiLoadedImageProtocolGuid,

+ (VOID **)&LoadedImage

+ );

+ return LoadedImage;

+ Get the module name from the user interface section.

+ @param[in] ModuleGuid The GUID of the module.

+ @param[out] NameString The buffer to store the name string.

+ @param[in] BufferSize The size of the buffer in bytes.

+ @retval EFI_SUCCESS The name string is successfully retrieved.

+ @retval EFI_NOT_FOUND The module name was not found.

+GetNameFromUiSection (

+ IN EFI_GUID *ModuleGuid,

+ OUT CHAR8 *NameString,

+ IN UINTN BufferSize

+ EFI_STATUS Status;

+ CHAR16 *StringPtr;

+ UINTN Index;

+ UINTN StringSize;

+

+ StringPtr = NULL;

+ StringSize = 0;

+ Status = GetSectionFromAnyFv (

+ ModuleGuid,

+ EFI_SECTION_USER_INTERFACE,

+ 0,

+ (VOID **)&StringPtr,

+ &StringSize

+ );

+ if (!EFI_ERROR (Status)) {

+ for (Index = 0; Index < BufferSize - 1 && StringPtr[Index] != 0; Index++) {

+ NameString[Index] = (CHAR8)StringPtr[Index];

+ NameString[Index] = 0;

+ FreePool (StringPtr);

+ return Status;

+ Initializes the MM Core Performance library after MM services are available.

+ @param[in] Event The event of notify protocol.

+ @param[in] Context Notify event context.

+ Status = InitializeMmCorePerformanceLibCommon (&gEdkiiSmmExitBootServicesProtocolGuid);

+ DEBUG ((DEBUG_WARN, "[%a] - Performance library is linked but performance tracing is not enabled.\n", __func__));

+# Copyright (c) Microsoft Corporation.

+ INF_VERSION = 0x0001001B

+ PI_SPECIFICATION_VERSION = 0x00010032

+ MmCorePerformanceLib.c

+ SmmCorePerformanceLib.c

+ BaseMemoryLib

+ DxeServicesLib

+ MemoryAllocationLib

+ MmServicesTableLib

+ PcdLib

+ PeCoffGetEntryPointLib

+ SynchronizationLib

+ TimerLib

+ UefiBootServicesTableLib

+ gEdkiiSmmExitBootServicesProtocolGuid ## CONSUMES ## NOTIFY

+ gEfiLoadedImageProtocolGuid ## CONSUMES

+Copyright (c) Microsoft Corporation.

+#include <Guid/EventGroup.h>

+#include <Guid/Performance.h>

+#include <Guid/PerformanceMeasurement.h>

+#include <Library/DebugLib.h>

+#include <Library/MmServicesTableLib.h>

+#include <Library/PcdLib.h>

+#include <Library/PerformanceLib.h>

+#include <Library/SmmMemLib.h>

+#include <Library/SynchronizationLib.h>

+#include <Library/TimerLib.h>

+#include <Protocol/LoadedImage.h>

+

+#define STRING_SIZE (FPDT_STRING_EVENT_RECORD_NAME_LENGTH * sizeof (CHAR8))

+#define FIRMWARE_RECORD_BUFFER 0x1000

+#define CACHE_HANDLE_GUID_COUNT 0x100

+

+extern BOOLEAN mPerformanceMeasurementEnabled;

+

+//

+// Library internal function declarations

+//

+

+/**

+ Return a pointer to the loaded image protocol for the given handle.

+

+ @param[in] Handle A handle to query for the loaded image protocol.

+

+ @return A pointer to a loaded image protocol instance or null if the handle does not support load image protocol.

+**/

+EFI_LOADED_IMAGE_PROTOCOL *

+GetLoadedImageProtocol (

+ IN EFI_HANDLE Handle

+ );

+

+/**

+ Get the module name from the PDB file name in the image header.

+

+ @param[in] ImageBase The base address of the image.

+ @param[out] NameString The buffer to store the name string.

+ @param[in] BufferSize The size of the buffer in bytes.

+

+ @retval EFI_SUCCESS The name string is successfully retrieved.

+ @retval EFI_INVALID_PARAMETER A pointer argument provided is null.

+ @retval EFI_NOT_FOUND The module name was not found.

+

+**/

+EFI_STATUS

+GetModuleNameFromPdbString (

+ IN VOID *ImageBase,

+ OUT CHAR8 *NameString,

+ IN UINTN BufferSize

+ );

+

+/**

+ Get the module name from the user interface section.

+

+ @param[in] ModuleGuid The GUID of the module.

+ @param[out] NameString The buffer to store the name string.

+ @param[in] BufferSize The size of the buffer in bytes.

+

+ @retval EFI_SUCCESS The name string is successfully retrieved.

+ @retval EFI_NOT_FOUND The module name was not found.

+

+**/

+EFI_STATUS

+GetNameFromUiSection (

+ IN EFI_GUID *ModuleGuid,

+ OUT CHAR8 *NameString,

+ IN UINTN BufferSize

+ );

+

+/**

+ Common initialization code for the MM Core Performance Library.

+

+ @param[in] ExitBootServicesProtocolGuid The GUID of the ExitBootServices protocol.

+

+ @retval EFI_SUCCESS The MM Core Performance Library was initialized successfully.

+ @retval Others The MM Core Performance Library was not initialized successfully.

+ **/

+EFI_STATUS

+InitializeMmCorePerformanceLibCommon (

+ IN CONST EFI_GUID *ExitBootServicesProtocolGuid

+ );

+

+/**

+ A library internal MM-instance specific implementation to check if a buffer outside MM is valid.

+

+ This function is provided so Standalone MM and Traditional MM may use a different implementation

+ of data buffer check logic.

+

+ @param[in] Buffer The buffer start address to be checked.

+ @param[in] Length The buffer length to be checked.

+

+ @retval TRUE This buffer is valid per processor architecture.

+ @retval FALSE This buffer is not valid per processor architecture.

+**/

+BOOLEAN

+MmCorePerformanceIsNonPrimaryBufferValid (

+ IN EFI_PHYSICAL_ADDRESS Buffer,

+ IN UINT64 Length

+ );

+

+/**

+ A library internal MM-instance specific implementation to check if a comm buffer is valid.

+

+ This function is provided so Standalone MM and Traditional MM may use a different implementation

+ of comm buffer check logic.

+

+ @param[in] Buffer The buffer start address to be checked.

+ @param[in] Length The buffer length to be checked.

+

+ @retval TRUE This communicate buffer is valid per processor architecture.

+ @retval FALSE This communicate buffer is not valid per processor architecture.

+**/

+BOOLEAN

+MmCorePerformanceIsPrimaryBufferValid (

+ IN EFI_PHYSICAL_ADDRESS Buffer,

+ IN UINT64 Length

+ );

+/** @file

+ This library is mainly used by the Standalone MM Core to start performance logging to ensure that

+ Standalone MM Performance and PerformanceEx Protocol are installed as early as possible in the MM phase.

+

+ Caution: This module requires additional review when modified.

+ - This driver will have external input - performance data and communicate buffer in MM mode.

+ - This external input must be validated carefully to avoid security issue like

+ buffer overflow, integer overflow.

+

+ SmmPerformanceHandlerEx(), SmmPerformanceHandler() will receive untrusted input and do basic validation.

+

+ Copyright (c) Microsoft Corporation.

+ SPDX-License-Identifier: BSD-2-Clause-Patent

+

+**/

+

+#include "SmmCorePerformanceLibInternal.h"

+

+#include <Guid/EventGroup.h>

+#include <Library/StandaloneMmMemLib.h>

+

+/**

+ A library internal MM-instance specific implementation to check if a buffer outside MM is valid.

+

+ This function is provided so Standalone MM and Traditional MM may use a different implementation

+ of data buffer check logic.

+

+ @param[in] Buffer The buffer start address to be checked.

+ @param[in] Length The buffer length to be checked.

+

+ @retval TRUE This buffer is valid per processor architecture.

+ @retval FALSE This buffer is not valid per processor architecture.

+**/

+BOOLEAN

+MmCorePerformanceIsNonPrimaryBufferValid (

+ IN EFI_PHYSICAL_ADDRESS Buffer,

+ IN UINT64 Length

+ )

+{

+ return MmIsBufferOutsideMmValid (Buffer, Length);

+}

+

+/**

+ A library internal MM-instance specific implementation to check if a comm buffer is valid.

+

+ This function is provided so Standalone MM and Traditional MM may use a different implementation

+ of comm buffer check logic.

+

+ @param[in] Buffer The buffer start address to be checked.

+ @param[in] Length The buffer length to be checked.

+

+ @retval TRUE This communicate buffer is valid per processor architecture.

+ @retval FALSE This communicate buffer is not valid per processor architecture.

+**/

+BOOLEAN

+MmCorePerformanceIsPrimaryBufferValid (

+ IN EFI_PHYSICAL_ADDRESS Buffer,

+ IN UINT64 Length

+ )

+{

+ return TRUE;

+}

+

+/**

+ Return a pointer to the loaded image protocol for the given handle.

+

+ @param[in] Handle A handle to query for the loaded image protocol.

+

+ @return A pointer to a loaded image protocol instance or null if the handle does not support load image protocol.

+**/

+EFI_LOADED_IMAGE_PROTOCOL *

+GetLoadedImageProtocol (

+ IN EFI_HANDLE Handle

+ )

+{

+ EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;

+

+ if (Handle == NULL) {

+ return NULL;

+ }

+

+ LoadedImage = NULL;

+ gMmst->MmHandleProtocol (

+ Handle,

+ &gEfiLoadedImageProtocolGuid,

+ (VOID **)&LoadedImage

+ );

+ return LoadedImage;

+}

+

+/**

+ Get the module name from the user interface section.

+

+ @param[in] ModuleGuid The GUID of the module.

+ @param[out] NameString The buffer to store the name string.

+ @param[in] BufferSize The size of the buffer in bytes.

+

+ @retval EFI_SUCCESS The name string is successfully retrieved.

+ @retval EFI_NOT_FOUND The module name was not found.

+

+**/

+EFI_STATUS

+GetNameFromUiSection (

+ IN EFI_GUID *ModuleGuid,

+ OUT CHAR8 *NameString,

+ IN UINTN BufferSize

+ )

+{

+ return EFI_NOT_FOUND;

+}

+

+/**

+ The constructor function initializes the Standalone MM Core performance library.

+

+ It will ASSERT() if one of these operations fails and it will always return EFI_SUCCESS.

+

+ @param[in] ImageHandle The firmware allocated handle for the image.

+ @param[in] MmSystemTable A pointer to the MM System Table.

+

+ @retval EFI_SUCCESS The constructor successfully gets HobList.

+ @retval Other value The constructor can't get HobList.

+

+**/

+EFI_STATUS

+EFIAPI

+StandaloneMmCorePerformanceLibConstructor (

+ IN EFI_HANDLE ImageHandle,

+ IN EFI_MM_SYSTEM_TABLE *MmSystemTable

+ )

+{

+ EFI_STATUS Status;

+

+ mPerformanceMeasurementEnabled = (BOOLEAN)((FixedPcdGet8 (PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0);

+

+ if (!PerformanceMeasurementEnabled ()) {

+ DEBUG ((DEBUG_WARN, "[%a] - Performance library is linked but performance tracing is not enabled.\n", __func__));

+ //

+ // Do not initialize performance infrastructure if not required.

+ //

+ return EFI_SUCCESS;

+ }

+

+ Status = InitializeMmCorePerformanceLibCommon (&gEfiEventExitBootServicesGuid);

+ ASSERT_EFI_ERROR (Status);

+

+ return EFI_SUCCESS;

+}

+## @file

+# Performance library instance used by a Standalone MM Core or an early Standlaone MM module that

+# should install performance measurement services.

+#

+# Installs the MM performance measurement protocol and returns MM performance data via MM communicate.

+#

+# Copyright (c) Microsoft Corporation.

+# SPDX-License-Identifier: BSD-2-Clause-Patent

+#

+##

+

+[Defines]

+ INF_VERSION = 0x0001001B

+ BASE_NAME = StandaloneMmCorePerformanceLib

+ FILE_GUID = 8585D462-DE63-4080-882A-A73974CE5609

+ MODULE_TYPE = MM_CORE_STANDALONE

+ VERSION_STRING = 1.0

+ PI_SPECIFICATION_VERSION = 0x00010032

+ LIBRARY_CLASS = PerformanceLib|MM_CORE_STANDALONE MM_STANDALONE

+ CONSTRUCTOR = StandaloneMmCorePerformanceLibConstructor

+

+[Sources]

+ MmCorePerformanceLib.c

+ SmmCorePerformanceLibInternal.h

+ StandaloneMmCorePerformanceLib.c

+

+[Packages]

+ MdePkg/MdePkg.dec

+ MdeModulePkg/MdeModulePkg.dec

+ StandaloneMmPkg/StandaloneMmPkg.dec

+

+[LibraryClasses]

+ BaseLib

+ BaseMemoryLib

+ DebugLib

+ MemoryAllocationLib

+ MemLib

+ MmServicesTableLib

+ PcdLib

+ PeCoffGetEntryPointLib

+ SynchronizationLib

+ TimerLib

+

+[Protocols]

+ gEdkiiSmmExitBootServicesProtocolGuid ## CONSUMES ## NOTIFY

+ gEfiLoadedImageProtocolGuid ## CONSUMES

+

+[Guids]

+ gEfiFirmwarePerformanceGuid ## SOMETIMES_PRODUCES # SmiHandlerRegister

+ gEdkiiSmmPerformanceMeasurementProtocolGuid ## PRODUCES # Install protocol

+ gZeroGuid ## SOMETIMES_CONSUMES ## GUID

+

+[FixedPcd]

+ gEfiMdePkgTokenSpaceGuid.PcdPerformanceLibraryPropertyMask ## CONSUMES

+ gEfiMdeModulePkgTokenSpaceGuid.PcdEdkiiFpdtStringRecordEnableOnly ## CONSUMES

+ Copyright (c) Microsoft Corporation.

+#include <PiMm.h>

+#include <Protocol/SmmExitBootServices.h>

+#include "SmmPerformanceLibInternal.h"

+ The constructor function initializes the Performance Measurement Enable flag.

+ @param[in] ImageHandle The firmware allocated handle for the EFI image.

+ @param[in] SystemTable A pointer to the EFI System Table.

+ return RegisterExitBootServicesCallback (&gEdkiiSmmExitBootServicesProtocolGuid);

+ @param[in] ImageHandle The firmware allocated handle for the EFI image.

+ @param[in] SystemTable A pointer to the EFI System Table.

+

+ return UnregisterExitBootServicesCallback (&gEdkiiSmmExitBootServicesProtocolGuid);

+# Copyright (c) Microsoft Corporation.

+ SmmPerformanceLibInternal.h

+ SmmPerformanceLibInternal.c

+ MmServicesTableLib

+/** @file

+ Performance Library used in the MM phase.

+

+ This library instance provides infrastructure for MM drivers to log performance

+ data. It consumes MM PerformanceEx or Performance Protocol published by SmmCorePerformanceLib

+ to log performance data. If both MM PerformanceEx and Performance Protocol are not available,

+ it does not log any performance information.

+

+ Copyright (c) 2011 - 2023, Intel Corporation. All rights reserved.<BR>

+ Copyright (c) Microsoft Corporation.

+ SPDX-License-Identifier: BSD-2-Clause-Patent

+

+**/

+

+#include <Guid/PerformanceMeasurement.h>

+

+#include <Library/BaseMemoryLib.h>

+#include <Library/DebugLib.h>

+#include <Library/MmServicesTableLib.h>

+#include <Library/PcdLib.h>

+#include <Library/PerformanceLib.h>

+

+#include "SmmPerformanceLibInternal.h"

+

+//

+// The cached MM Performance Protocol and MM PerformanceEx Protocol interface.

+EDKII_PERFORMANCE_MEASUREMENT_PROTOCOL *mPerformanceMeasurement = NULL;

+BOOLEAN mPerformanceMeasurementEnabled;

+VOID *mPerformanceLibExitBootServicesRegistration;

+

+/**

+ Registers a callback to perform library actions needed at exit boot services.

+

+ @param[in] ExitBootServicesProtocolGuid The protocol GUID to register the callback for.

+

+ @retval EFI_SUCCESS The callback was registered successfully.

+ @retval Others An error occurred registering the callback.

+ **/

+EFI_STATUS

+RegisterExitBootServicesCallback (

+ IN CONST EFI_GUID *ExitBootServicesProtocolGuid

+ )

+{

+ EFI_STATUS Status;

+

+ mPerformanceMeasurementEnabled = (BOOLEAN)((PcdGet8 (PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0);

+

+ Status = gMmst->MmRegisterProtocolNotify (

+ ExitBootServicesProtocolGuid,

+ SmmPerformanceLibExitBootServicesCallback,

+ &mPerformanceLibExitBootServicesRegistration

+ );

+ ASSERT_EFI_ERROR (Status);

+

+ return Status;

+}

+

+/**

+ Unregisters a callback to perform library actions needed at exit boot services.

+

+ @param[in] ExitBootServicesProtocolGuid The protocol GUID to unregister the callback for.

+

+ @retval EFI_SUCCESS The callback was unregistered successfully.

+ @retval Others An error occurred unregistering the callback.

+ **/

+EFI_STATUS

+UnregisterExitBootServicesCallback (

+ IN CONST EFI_GUID *ExitBootServicesProtocolGuid

+ )

+{

+ EFI_STATUS Status;

+

+ //

+ // Unregister SmmExitBootServices notification.

+ //

+ Status = gMmst->MmRegisterProtocolNotify (

+ ExitBootServicesProtocolGuid,

+ NULL,

+ &mPerformanceLibExitBootServicesRegistration

+ );

+ ASSERT_EFI_ERROR (Status);

+

+ return Status;

+}

+

+/**

+ This is the Event call back function is triggered in MM to notify the Library

+ the system is entering runtime phase.

+

+ @param[in] Protocol Points to the protocol's unique identifier

+ @param[in] Interface Points to the interface instance

+ @param[in] Handle The handle on which the interface was installed

+

+ @retval EFI_SUCCESS SmmAtRuntimeCallBack runs successfully

+ **/

+EFI_STATUS

+EFIAPI

+SmmPerformanceLibExitBootServicesCallback (

+ IN CONST EFI_GUID *Protocol,

+ IN VOID *Interface,

+ IN EFI_HANDLE Handle

+ )

+{

+ //

+ // Disable performance measurement after ExitBootServices because

+ // 1. Performance measurement might impact SMI latency at runtime;

+ // 2. Performance log is copied to non SMRAM at ReadyToBoot so runtime performance

+ // log is not useful.

+ //

+ mPerformanceMeasurementEnabled = FALSE;

+

+ return EFI_SUCCESS;

+}

+

+/**

+ The function caches the pointers to MM PerformanceEx protocol and Performance Protocol.

+

+ The function locates MM PerformanceEx protocol and Performance Protocol from protocol database.

+

+ @retval EFI_SUCCESS MM PerformanceEx protocol or Performance Protocol is successfully located.

+ @retval EFI_NOT_FOUND Both MM PerformanceEx protocol and Performance Protocol are not located to log performance.

+

+**/

+EFI_STATUS

+GetPerformanceMeasurementProtocol (

+ VOID

+ )

+{

+ EFI_STATUS Status;

+ EDKII_PERFORMANCE_MEASUREMENT_PROTOCOL *PerformanceMeasurement;

+

+ if (mPerformanceMeasurement != NULL) {

+ return EFI_SUCCESS;

+ }

+

+ Status = gMmst->MmLocateProtocol (&gEdkiiSmmPerformanceMeasurementProtocolGuid, NULL, (VOID **)&PerformanceMeasurement);

+ if (!EFI_ERROR (Status)) {

+ ASSERT (PerformanceMeasurement != NULL);

+

+ //

+ // Cache PerformanceMeasurement Protocol.

+ //

+ mPerformanceMeasurement = PerformanceMeasurement;

+ return EFI_SUCCESS;

+ }

+

+ return EFI_NOT_FOUND;

+}

+

+/**

+ Creates a record for the beginning of a performance measurement.

+

+ Creates a record that contains the Handle, Token, Module and Identifier.

+ If TimeStamp is not zero, then TimeStamp is added to the record as the start time.

+ If TimeStamp is zero, then this function reads the current time stamp

+ and adds that time stamp value to the record as the start time.

+

+ @param Handle Pointer to environment specific context used

+ to identify the component being measured.

+ @param Token Pointer to a Null-terminated ASCII string

+ that identifies the component being measured.

+ @param Module Pointer to a Null-terminated ASCII string

+ that identifies the module being measured.

+ @param TimeStamp 64-bit time stamp.

+ @param Identifier 32-bit identifier. If the value is 0, the created record

+ is same as the one created by StartPerformanceMeasurement.

+

+ @retval RETURN_SUCCESS The start of the measurement was recorded.

+ @retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.

+

+**/

+RETURN_STATUS

+EFIAPI

+StartPerformanceMeasurementEx (

+ IN CONST VOID *Handle OPTIONAL,

+ IN CONST CHAR8 *Token OPTIONAL,

+ IN CONST CHAR8 *Module OPTIONAL,

+ IN UINT64 TimeStamp,

+ IN UINT32 Identifier

+ )

+{

+ EFI_STATUS Status;

+ CONST CHAR8 *String;

+

+ Status = GetPerformanceMeasurementProtocol ();

+ if (EFI_ERROR (Status)) {

+ return RETURN_NOT_FOUND;

+ }

+

+ if (Token != NULL) {

+ String = Token;

+ } else if (Module != NULL) {

+ String = Module;

+ } else {

+ String = NULL;

+ }

+

+ if (mPerformanceMeasurement != NULL) {

+ Status = mPerformanceMeasurement->CreatePerformanceMeasurement (Handle, NULL, String, TimeStamp, 0, Identifier, PerfStartEntry);

+ } else {

+ ASSERT (FALSE);

+ }

+

+ return (RETURN_STATUS)Status;

+}

+

+/**

+ Fills in the end time of a performance measurement.

+

+ Looks up the record that matches Handle, Token and Module.

+ If the record can not be found then return RETURN_NOT_FOUND.

+ If the record is found and TimeStamp is not zero,

+ then TimeStamp is added to the record as the end time.

+ If the record is found and TimeStamp is zero, then this function reads

+ the current time stamp and adds that time stamp value to the record as the end time.

+

+ @param Handle Pointer to environment specific context used

+ to identify the component being measured.

+ @param Token Pointer to a Null-terminated ASCII string

+ that identifies the component being measured.

+ @param Module Pointer to a Null-terminated ASCII string

+ that identifies the module being measured.

+ @param TimeStamp 64-bit time stamp.

+ @param Identifier 32-bit identifier. If the value is 0, the found record

+ is same as the one found by EndPerformanceMeasurement.

+

+ @retval RETURN_SUCCESS The end of the measurement was recorded.

+ @retval RETURN_NOT_FOUND The specified measurement record could not be found.

+

+**/

+RETURN_STATUS

+EFIAPI

+EndPerformanceMeasurementEx (

+ IN CONST VOID *Handle OPTIONAL,

+ IN CONST CHAR8 *Token OPTIONAL,

+ IN CONST CHAR8 *Module OPTIONAL,

+ IN UINT64 TimeStamp,

+ IN UINT32 Identifier

+ )

+{

+ EFI_STATUS Status;

+ CONST CHAR8 *String;

+

+ Status = GetPerformanceMeasurementProtocol ();

+ if (EFI_ERROR (Status)) {

+ return RETURN_NOT_FOUND;

+ }

+

+ if (Token != NULL) {

+ String = Token;

+ } else if (Module != NULL) {

+ String = Module;

+ } else {

+ String = NULL;

+ }

+

+ if (mPerformanceMeasurement != NULL) {

+ Status = mPerformanceMeasurement->CreatePerformanceMeasurement (Handle, NULL, String, TimeStamp, 0, Identifier, PerfEndEntry);

+ } else {

+ ASSERT (FALSE);

+ }

+

+ return (RETURN_STATUS)Status;

+}

+

+/**

+ Attempts to retrieve a performance measurement log entry from the performance measurement log.

+ It can also retrieve the log created by StartPerformanceMeasurement and EndPerformanceMeasurement,

+ and then assign the Identifier with 0.

+

+ Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is

+ zero on entry, then an attempt is made to retrieve the first entry from the performance log,

+ and the key for the second entry in the log is returned. If the performance log is empty,

+ then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance

+ log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is

+ returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is

+ retrieved and an implementation specific non-zero key value that specifies the end of the performance

+ log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry

+ is retrieved and zero is returned. In the cases where a performance log entry can be returned,

+ the log entry is returned in Handle, Token, Module, StartTimeStamp, EndTimeStamp and Identifier.

+ If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().

+ If Handle is NULL, then ASSERT().

+ If Token is NULL, then ASSERT().

+ If Module is NULL, then ASSERT().

+ If StartTimeStamp is NULL, then ASSERT().

+ If EndTimeStamp is NULL, then ASSERT().

+ If Identifier is NULL, then ASSERT().

+

+ @param LogEntryKey On entry, the key of the performance measurement log entry to retrieve.

+ 0, then the first performance measurement log entry is retrieved.

+ On exit, the key of the next performance log entry.

+ @param Handle Pointer to environment specific context used to identify the component

+ being measured.

+ @param Token Pointer to a Null-terminated ASCII string that identifies the component

+ being measured.

+ @param Module Pointer to a Null-terminated ASCII string that identifies the module

+ being measured.

+ @param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement

+ was started.

+ @param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement

+ was ended.

+ @param Identifier Pointer to the 32-bit identifier that was recorded.

+

+ @return The key for the next performance log entry (in general case).

+

+**/

+UINTN

+EFIAPI

+GetPerformanceMeasurementEx (

+ IN UINTN LogEntryKey,

+ OUT CONST VOID **Handle,

+ OUT CONST CHAR8 **Token,

+ OUT CONST CHAR8 **Module,

+ OUT UINT64 *StartTimeStamp,

+ OUT UINT64 *EndTimeStamp,

+ OUT UINT32 *Identifier

+ )

+{

+ return 0;

+}

+

+/**

+ Creates a record for the beginning of a performance measurement.

+

+ Creates a record that contains the Handle, Token, and Module.

+ If TimeStamp is not zero, then TimeStamp is added to the record as the start time.

+ If TimeStamp is zero, then this function reads the current time stamp

+ and adds that time stamp value to the record as the start time.

+

+ @param Handle Pointer to environment specific context used

+ to identify the component being measured.

+ @param Token Pointer to a Null-terminated ASCII string

+ that identifies the component being measured.

+ @param Module Pointer to a Null-terminated ASCII string

+ that identifies the module being measured.

+ @param TimeStamp 64-bit time stamp.

+

+ @retval RETURN_SUCCESS The start of the measurement was recorded.

+ @retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.

+

+**/

+RETURN_STATUS

+EFIAPI

+StartPerformanceMeasurement (

+ IN CONST VOID *Handle OPTIONAL,

+ IN CONST CHAR8 *Token OPTIONAL,

+ IN CONST CHAR8 *Module OPTIONAL,

+ IN UINT64 TimeStamp

+ )

+{

+ return StartPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, 0);

+}

+

+/**

+ Fills in the end time of a performance measurement.

+

+ Looks up the record that matches Handle, Token, and Module.

+ If the record can not be found then return RETURN_NOT_FOUND.

+ If the record is found and TimeStamp is not zero,

+ then TimeStamp is added to the record as the end time.

+ If the record is found and TimeStamp is zero, then this function reads

+ the current time stamp and adds that time stamp value to the record as the end time.

+

+ @param Handle Pointer to environment specific context used

+ to identify the component being measured.

+ @param Token Pointer to a Null-terminated ASCII string

+ that identifies the component being measured.

+ @param Module Pointer to a Null-terminated ASCII string

+ that identifies the module being measured.

+ @param TimeStamp 64-bit time stamp.

+

+ @retval RETURN_SUCCESS The end of the measurement was recorded.

+ @retval RETURN_NOT_FOUND The specified measurement record could not be found.

+

+**/

+RETURN_STATUS

+EFIAPI

+EndPerformanceMeasurement (

+ IN CONST VOID *Handle OPTIONAL,

+ IN CONST CHAR8 *Token OPTIONAL,

+ IN CONST CHAR8 *Module OPTIONAL,

+ IN UINT64 TimeStamp

+ )

+{

+ return EndPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, 0);

+}

+

+/**

+ Attempts to retrieve a performance measurement log entry from the performance measurement log.

+ It can also retrieve the log created by StartPerformanceMeasurementEx and EndPerformanceMeasurementEx,

+ and then eliminate the Identifier.

+

+ Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is

+ zero on entry, then an attempt is made to retrieve the first entry from the performance log,

+ and the key for the second entry in the log is returned. If the performance log is empty,

+ then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance

+ log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is

+ returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is

+ retrieved and an implementation specific non-zero key value that specifies the end of the performance

+ log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry

+ is retrieved and zero is returned. In the cases where a performance log entry can be returned,

+ the log entry is returned in Handle, Token, Module, StartTimeStamp, and EndTimeStamp.

+ If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().

+ If Handle is NULL, then ASSERT().

+ If Token is NULL, then ASSERT().

+ If Module is NULL, then ASSERT().

+ If StartTimeStamp is NULL, then ASSERT().

+ If EndTimeStamp is NULL, then ASSERT().

+

+ @param LogEntryKey On entry, the key of the performance measurement log entry to retrieve.

+ 0, then the first performance measurement log entry is retrieved.

+ On exit, the key of the next performance log entry.

+ @param Handle Pointer to environment specific context used to identify the component

+ being measured.

+ @param Token Pointer to a Null-terminated ASCII string that identifies the component

+ being measured.

+ @param Module Pointer to a Null-terminated ASCII string that identifies the module

+ being measured.

+ @param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement

+ was started.

+ @param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement

+ was ended.

+

+ @return The key for the next performance log entry (in general case).

+

+**/

+UINTN

+EFIAPI

+GetPerformanceMeasurement (

+ IN UINTN LogEntryKey,

+ OUT CONST VOID **Handle,

+ OUT CONST CHAR8 **Token,

+ OUT CONST CHAR8 **Module,

+ OUT UINT64 *StartTimeStamp,

+ OUT UINT64 *EndTimeStamp

+ )

+{

+ return 0;

+}

+

+/**

+ Returns TRUE if the performance measurement macros are enabled.

+

+ This function returns TRUE if the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of

+ PcdPerformanceLibraryPropertyMask is set. Otherwise FALSE is returned.

+

+ @retval TRUE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of

+ PcdPerformanceLibraryPropertyMask is set.

+ @retval FALSE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of

+ PcdPerformanceLibraryPropertyMask is clear.

+

+**/

+BOOLEAN

+EFIAPI

+PerformanceMeasurementEnabled (

+ VOID

+ )

+{

+ return mPerformanceMeasurementEnabled;

+}

+

+/**

+ Create performance record with event description and a timestamp.

+

+ @param CallerIdentifier - Image handle or pointer to caller ID GUID

+ @param Guid - Pointer to a GUID

+ @param String - Pointer to a string describing the measurement

+ @param Address - Pointer to a location in memory relevant to the measurement

+ @param Identifier - Performance identifier describing the type of measurement

+

+ @retval RETURN_SUCCESS - Successfully created performance record

+ @retval RETURN_OUT_OF_RESOURCES - Ran out of space to store the records

+ @retval RETURN_INVALID_PARAMETER - Invalid parameter passed to function - NULL

+ pointer or invalid PerfId

+

+**/

+RETURN_STATUS

+EFIAPI

+LogPerformanceMeasurement (

+ IN CONST VOID *CallerIdentifier,

+ IN CONST VOID *Guid OPTIONAL,

+ IN CONST CHAR8 *String OPTIONAL,

+ IN UINT64 Address OPTIONAL,

+ IN UINT32 Identifier

+ )

+{

+ EFI_STATUS Status;

+

+ Status = GetPerformanceMeasurementProtocol ();

+ if (EFI_ERROR (Status)) {

+ return RETURN_OUT_OF_RESOURCES;

+ }

+

+ if (mPerformanceMeasurement != NULL) {

+ Status = mPerformanceMeasurement->CreatePerformanceMeasurement (CallerIdentifier, Guid, String, 0, Address, Identifier, PerfEntry);

+ } else {

+ ASSERT (FALSE);

+ }

+

+ return (RETURN_STATUS)Status;

+}

+

+/**

+ Check whether the specified performance measurement can be logged.

+

+ This function returns TRUE when the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set

+ and the Type disable bit in PcdPerformanceLibraryPropertyMask is not set.

+

+ @param Type - Type of the performance measurement entry.

+

+ @retval TRUE The performance measurement can be logged.

+ @retval FALSE The performance measurement can NOT be logged.

+

+**/

+BOOLEAN

+EFIAPI

+LogPerformanceMeasurementEnabled (

+ IN CONST UINTN Type

+ )

+{

+ //

+ // When Performance measurement is enabled and the type is not filtered, the performance can be logged.

+ //

+ if (PerformanceMeasurementEnabled () && ((PcdGet8 (PcdPerformanceLibraryPropertyMask) & Type) == 0)) {

+ return TRUE;

+ }

+

+ return FALSE;

+}

+/** @file

+ Internal library header.

+

+ Copyright (c) Microsoft Corporation.

+ SPDX-License-Identifier: BSD-2-Clause-Patent

+

+**/

+

+#ifndef SMM_CORE_PERFORMANCE_LIB_INTERNAL_H_

+#define SMM_CORE_PERFORMANCE_LIB_INTERNAL_H_

+

+/**

+ Registers a callback to perform library actions needed at exit boot services.

+

+ @param[in] ExitBootServicesProtocolGuid The protocol GUID to register the callback for.

+

+ @retval EFI_SUCCESS The callback was registered successfully.

+ @retval Others An error occurred registering the callback.

+ **/

+EFI_STATUS

+RegisterExitBootServicesCallback (

+ IN CONST EFI_GUID *ExitBootServicesProtocolGuid

+ );

+

+/**

+ Unregisters a callback to perform library actions needed at exit boot services.

+

+ @param[in] ExitBootServicesProtocolGuid The protocol GUID to unregister the callback for.

+

+ @retval EFI_SUCCESS The callback was unregistered successfully.

+ @retval Others An error occurred unregistering the callback.

+ **/

+EFI_STATUS

+UnregisterExitBootServicesCallback (

+ IN CONST EFI_GUID *ExitBootServicesProtocolGuid

+ );

+

+/**

+ This is the Event call back function is triggered in MM to notify the Library

+ the system is entering runtime phase.

+

+ @param[in] Protocol Points to the protocol's unique identifier

+ @param[in] Interface Points to the interface instance

+ @param[in] Handle The handle on which the interface was installed

+

+ @retval EFI_SUCCESS SmmAtRuntimeCallBack runs successfully

+ **/

+EFI_STATUS

+EFIAPI

+SmmPerformanceLibExitBootServicesCallback (

+ IN CONST EFI_GUID *Protocol,

+ IN VOID *Interface,

+ IN EFI_HANDLE Handle

+ );

+

+#endif // SMM_CORE_PERFORMANCE_LIB_INTERNAL_H_

+/** @file

+ Performance Library used in Standalone MM phase.

+

+ This library instance provides infrastructure for Standalone MM drivers to log performance

+ data. It consumes the MM PerformanceEx or Performance Protocol to log performance data. If

+ both MM PerformanceEx and Performance Protocol are not available, it does not log any

+ performance information.

+

+ Copyright (c) 2011 - 2023, Intel Corporation. All rights reserved.<BR>

+ Copyright (c) Microsoft Corporation.

+ SPDX-License-Identifier: BSD-2-Clause-Patent

+

+**/

+

+#include <PiMm.h>

+#include <Guid/EventGroup.h>

+#include "SmmPerformanceLibInternal.h"

+

+/**

+ The constructor function initializes the Performance Measurement Enable flag.

+

+ @param[in] ImageHandle The firmware allocated handle for the EFI image.

+ @param[in] MmSystemTable A pointer to the MM System Table.

+

+ @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.

+

+**/

+EFI_STATUS

+EFIAPI

+StandaloneMmPerformanceLibConstructor (

+ IN EFI_HANDLE ImageHandle,

+ IN EFI_MM_SYSTEM_TABLE *MmSystemTable

+ )

+{

+ return RegisterExitBootServicesCallback (&gEfiEventExitBootServicesGuid);

+}

+

+/**

+ The destructor function frees resources allocated by constructor.

+

+ @param[in] ImageHandle The firmware allocated handle for the EFI image.

+ @param[in] MmSystemTable A pointer to the MM System Table.

+

+ @retval EFI_SUCCESS The destructor always returns EFI_SUCCESS.

+

+**/

+EFI_STATUS

+EFIAPI

+StandaloneMmPerformanceLibDestructor (

+ IN EFI_HANDLE ImageHandle,

+ IN EFI_MM_SYSTEM_TABLE *MmSystemTable

+ )

+{

+ return UnregisterExitBootServicesCallback (&gEfiEventExitBootServicesGuid);

+}

+## @file

+# Performance library instance used in Standalone MM phase.

+#

+# This library instance provides infrastructure for Standalone MM drivers to log performance

+# data. It consumes the MM PerformanceEx or Performance Protocol to log performance data. If

+# both MM PerformanceEx and Performance Protocol are not available, it does not log any

+# performance information.

+#

+# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>

+# Copyright Microsoft Corporation.

+# SPDX-License-Identifier: BSD-2-Clause-Patent

+#

+##

+

+[Defines]

+ INF_VERSION = 0x0001001B

+ BASE_NAME = StandaloneMmPerformanceLib

+ MODULE_UNI_FILE = StandaloneMmPerformanceLib.uni

+ FILE_GUID = 7E7415FC-0BFB-47B4-B1C8-66149CC9050C

+ MODULE_TYPE = MM_STANDALONE

+ VERSION_STRING = 1.0

+ PI_SPECIFICATION_VERSION = 0x00010032

+ LIBRARY_CLASS = PerformanceLib|MM_STANDALONE

+

+ CONSTRUCTOR = StandaloneMmPerformanceLibConstructor

+ DESTRUCTOR = StandaloneMmPerformanceLibDestructor

+

+[Sources]

+ SmmPerformanceLibInternal.h

+ SmmPerformanceLibInternal.c

+ StandaloneMmPerformanceLib.c

+

+[Packages]

+ MdePkg/MdePkg.dec

+ MdeModulePkg/MdeModulePkg.dec

+

+[LibraryClasses]

+ PcdLib

+ MmServicesTableLib

+ DebugLib

+ BaseMemoryLib

+

+[Guids]

+ gEdkiiSmmPerformanceMeasurementProtocolGuid ## SOMETIMES_CONSUMES ## UNDEFINED # Locate protocol

+ gEfiEventExitBootServicesGuid ## CONSUMES

+

+[Pcd]

+ gEfiMdePkgTokenSpaceGuid.PcdPerformanceLibraryPropertyMask ## CONSUMES

+// /** @file

+// Performance library instance used in Standalone MM phase.

+//

+// This library instance provides infrastructure for Standalone MM drivers to log performance

+// data. It consumes the MM PerformanceEx or Performance Protocol to log performance data. If

+// both MM PerformanceEx and Performance Protocol are not available, it does not log any

+// performance information.

+//

+// Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>

+// Copyright Microsoft Corporation.

+//

+// SPDX-License-Identifier: BSD-2-Clause-Patent

+//

+// **/

+

+

+#string STR_MODULE_ABSTRACT #language en-US "Performance library instance used in the Standalone MM phase"

+

+#string STR_MODULE_DESCRIPTION #language en-US "This library instance provides infrastructure for Standalone MM drivers to log performance data. It consumes the Standalone MM PerformanceEx or Performance Protocol to log performance data. If both Standalone MM PerformanceEx and Performance Protocol are not available, it does not log any performance information."

+

+ if ((DispatchHandle == NULL) || (CommBuffer == NULL) || (CommBufferSize == NULL)) {

+ return EFI_INVALID_PARAMETER;

+

+ Status = gMmst->MmiHandlerUnRegister (DispatchHandle);

+ return Status;

+ DEBUG ((DEBUG_INFO, "%a: Handler unregistered successfully.\n", __func__));

+

+ MdeModulePkg/Library/SmmCorePerformanceLib/StandaloneMmCorePerformanceLib.inf

+ MdeModulePkg/Library/SmmPerformanceLib/StandaloneMmPerformanceLib.inf

+#define EFI_ACPI_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_REVISION_4 0x04

+} EFI_ACPI_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_4;

+

+/*

+The work area is used to support reading from cache in QemuFwCfgLib.

+It is also used as global variable in Dxe phase.

+*/

+typedef struct {

+ BOOLEAN QemuFwCfgSupported;

+ BOOLEAN QemuFwCfgDmaSupported;

+ UINT16 FwCfgItem;

+ UINT32 Offset;

+ BOOLEAN Reading;

+} QEMU_FW_CFG_WORK_AREA;

+

+ EFI_HOB_GUID_TYPE GuidHeader;

+ UINT16 HostBridgeDevId;

+

+ UINT64 PcdConfidentialComputingGuestAttr;

+ BOOLEAN SevEsIsEnabled;

+ UINT32 BootMode;

+ BOOLEAN S3Supported;

+ BOOLEAN SmmSmramRequire;

+ BOOLEAN Q35SmramAtDefaultSmbase;

+ UINT16 Q35TsegMbytes;

+ UINT32 LowMemory;

+ UINT64 FirstNonAddress;

+ UINT8 PhysMemAddressWidth;

+ UINT32 Uc32Base;

+ UINT32 Uc32Size;

+ BOOLEAN PcdSetNxForStack;

+ UINT64 PcdTdxSharedBitMask;

+ UINT64 PcdPciMmio64Base;

+ UINT64 PcdPciMmio64Size;

+ BOOLEAN PcdPciMmio64Override;

+ UINT32 PcdPciMmio32Base;

+ UINT32 PcdPciMmio32Size;

+ UINT64 PcdPciIoBase;

+ UINT64 PcdPciIoSize;

+ UINT64 PcdEmuVariableNvStoreReserved;

+ UINT32 PcdCpuBootLogicalProcessorNumber;

+ UINT32 PcdCpuMaxLogicalProcessorNumber;

+ UINT32 DefaultMaxCpuNumber;

+ UINT32 S3AcpiReservedMemoryBase;

+ UINT32 S3AcpiReservedMemorySize;

+ UINT64 FeatureControlValue;

+ BOOLEAN QemuFwCfgChecked;

+ QEMU_FW_CFG_WORK_AREA QemuFwCfgWorkArea;

+#include <Library/PlatformInitLib.h>

+/**

+ OVMF reads configuration data from QEMU via fw_cfg.

+ For Td-Guest VMM is out of TCB and the configuration data is untrusted.

+ From the security perpective the configuration data shall be measured

+ before it is consumed.

+ This function reads the fw_cfg items and cached them. In the meanwhile these

+ fw_cfg items are measured as well. This is to avoid changing the order when

+ reading the fw_cfg process, which depends on multiple factors(depex, order in

+ the Firmware volume).

+

+ @retval RETURN_SUCCESS - Successfully cache with measurement

+ @retval Others - As the error code indicates

+ */

+RETURN_STATUS

+EFIAPI

+QemuFwCfgInitCache (

+ IN OUT EFI_HOB_PLATFORM_INFO *PlatformInfoHob

+ );

+

+ TpmMeasurementLib|SecurityPkg/Library/SecTpmMeasurementLib/SecTpmMeasurementLib.inf

+#include <Base.h>

+#include <Library/QemuFwCfgLib.h>

+#include <Library/HobLib.h>

+ if (RETURN_ERROR (QemuFwCfgInitCache (PlatformInfoHob))) {

+ DEBUG ((DEBUG_ERROR, "QemuFwCfgInitCache failed !\n"));

+ }

+

+STATIC

+EFI_HOB_PLATFORM_INFO *

+BuildPlatformInfoHob (

+ VOID

+ )

+{

+ EFI_HOB_PLATFORM_INFO PlatformInfoHob;

+ EFI_HOB_GUID_TYPE *GuidHob;

+

+ ZeroMem (&PlatformInfoHob, sizeof PlatformInfoHob);

+ BuildGuidDataHob (&gUefiOvmfPkgPlatformInfoGuid, &PlatformInfoHob, sizeof (EFI_HOB_PLATFORM_INFO));

+ GuidHob = GetFirstGuidHob (&gUefiOvmfPkgPlatformInfoGuid);

+ return (EFI_HOB_PLATFORM_INFO *)GET_GUID_HOB_DATA (GuidHob);

+}

+

+ EFI_HOB_PLATFORM_INFO *PlatformInfoHob;

+ PlatformInfoHob = BuildPlatformInfoHob ();

+

+ Status = InitializePlatform (PlatformInfoHob);

+/** @file

+ QemuFwCfg cached feature related functions.

+ Copyright (c) 2025, Intel Corporation. All rights reserved.<BR>

+ SPDX-License-Identifier: BSD-2-Clause-Patent

+**/

+

+#include <Uefi.h>

+#include <Library/BaseLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/DebugLib.h>

+#include <Library/QemuFwCfgLib.h>

+#include "QemuFwCfgLibInternal.h"

+

+/**

+ Get the pointer to the cached fw_cfg item.

+ @param[in] Item The fw_cfg item to be retrieved.

+ @retval FW_CFG_CACHED_ITEM Pointer to the cached fw_cfg item.

+ @retval NULL The fw_cfg item is not cached.

+**/

+FW_CFG_CACHED_ITEM *

+InternalQemuFwCfgItemCached (

+ IN FIRMWARE_CONFIG_ITEM Item

+ )

+{

+ BOOLEAN Cached;

+ FW_CFG_CACHED_ITEM *CachedItem;

+ UINT16 SelectItem;

+ EFI_PEI_HOB_POINTERS Hob;

+ FW_CFG_CACHED_ITEM *FwCfgCachedItem;

+

+ #ifdef TDX_PEI_LESS_BOOT

+ if (InternalQemuFwCfgCheckOvmfWorkArea () == FALSE) {

+ return NULL;

+ }

+

+ #endif

+

+ SelectItem = (UINT16)(UINTN)Item;

+

+ Hob.Raw = GetFirstGuidHob (&gOvmfFwCfgInfoHobGuid);

+ Cached = FALSE;

+ CachedItem = NULL;

+

+ while (Hob.Raw != NULL) {

+ FwCfgCachedItem = GET_GUID_HOB_DATA (Hob);

+ if ((SelectItem == FwCfgCachedItem->FwCfgItem) && (FwCfgCachedItem->DataSize != 0)) {

+ Cached = TRUE;

+ CachedItem = FwCfgCachedItem;

+ break;

+ }

+

+ Hob.Raw = GET_NEXT_HOB (Hob);

+ Hob.Raw = GetNextGuidHob (&gOvmfFwCfgInfoHobGuid, Hob.Raw);

+ }

+

+ return Cached ? CachedItem : NULL;

+}

+

+/**

+ Clear the QEMU_FW_CFG_WORK_AREA.

+**/

+VOID

+InternalQemuFwCfgCacheResetWorkArea (

+ VOID

+ )

+{

+ QEMU_FW_CFG_WORK_AREA *QemuFwCfgWorkArea;

+

+ QemuFwCfgWorkArea = InternalQemuFwCfgCacheGetWorkArea ();

+ if (QemuFwCfgWorkArea != NULL) {

+ QemuFwCfgWorkArea->FwCfgItem = 0;

+ QemuFwCfgWorkArea->Offset = 0;

+ QemuFwCfgWorkArea->Reading = FALSE;

+ }

+}

+

+/**

+ Check if reading from FwCfgCache is ongoing.

+ @retval TRUE Reading from FwCfgCache is ongoing.

+ @retval FALSE Reading from FwCfgCache is not ongoing.

+**/

+BOOLEAN

+InternalQemuFwCfgCacheReading (

+ VOID

+ )

+{

+ BOOLEAN Reading;

+ QEMU_FW_CFG_WORK_AREA *QemuFwCfgWorkArea;

+

+ Reading = FALSE;

+ QemuFwCfgWorkArea = InternalQemuFwCfgCacheGetWorkArea ();

+ if (QemuFwCfgWorkArea != NULL) {

+ Reading = QemuFwCfgWorkArea->Reading;

+ }

+

+ return Reading;

+}

+

+BOOLEAN

+InternalQemuFwCfgCacheSelectItem (

+ IN FIRMWARE_CONFIG_ITEM Item

+ )

+{

+ QEMU_FW_CFG_WORK_AREA *QemuFwCfgWorkArea;

+

+ // Walk thru cached fw_items to see if Item is cached.

+ if (InternalQemuFwCfgItemCached (Item) == NULL) {

+ return FALSE;

+ }

+

+ QemuFwCfgWorkArea = InternalQemuFwCfgCacheGetWorkArea ();

+ if (QemuFwCfgWorkArea == NULL) {

+ DEBUG ((DEBUG_ERROR, "%a: Invalid FwCfg Cache Work Area\n", __func__));

+ return FALSE;

+ }

+

+ QemuFwCfgWorkArea->FwCfgItem = (UINT16)Item;

+ QemuFwCfgWorkArea->Offset = 0;

+ QemuFwCfgWorkArea->Reading = TRUE;

+

+ return TRUE;

+}

+

+/**

+ Read the fw_cfg data from Cache.

+ @param[in] Size Data size to be read

+ @param[in] Buffer Pointer to the buffer to which data is written

+ @retval EFI_SUCCESS - Successfully

+ @retval Others - As the error code indicates

+**/

+EFI_STATUS

+InternalQemuFwCfgCacheReadBytes (

+ IN UINTN Size,

+ IN OUT VOID *Buffer

+ )

+{

+ QEMU_FW_CFG_WORK_AREA *QemuFwCfgWorkArea;

+ FW_CFG_CACHED_ITEM *CachedItem;

+ UINTN ReadSize;

+

+ if (Buffer == NULL) {

+ return EFI_INVALID_PARAMETER;

+ }

+

+ QemuFwCfgWorkArea = InternalQemuFwCfgCacheGetWorkArea ();

+ if (QemuFwCfgWorkArea == NULL) {

+ return RETURN_NOT_FOUND;

+ }

+

+ if (!QemuFwCfgWorkArea->Reading) {

+ return RETURN_NOT_READY;

+ }

+

+ CachedItem = InternalQemuFwCfgItemCached (QemuFwCfgWorkArea->FwCfgItem);

+ if (CachedItem == NULL) {

+ return RETURN_NOT_FOUND;

+ }

+

+ if (QemuFwCfgWorkArea->Offset >= CachedItem->DataSize) {

+ DEBUG ((DEBUG_ERROR, "%a: Invalid Item Offset(0x%x) in FwCfg Cache\n", __func__, QemuFwCfgWorkArea->Offset));

+ ASSERT (FALSE);

+ return RETURN_ABORTED;

+ }

+

+ if (CachedItem->DataSize - QemuFwCfgWorkArea->Offset > Size) {

+ ReadSize = Size;

+ } else {

+ ReadSize = CachedItem->DataSize - QemuFwCfgWorkArea->Offset;

+ }

+

+ CopyMem (Buffer, (UINT8 *)CachedItem + sizeof (FW_CFG_CACHED_ITEM) + QemuFwCfgWorkArea->Offset, ReadSize);

+ QemuFwCfgWorkArea->Offset += (UINT32)ReadSize;

+

+ DEBUG ((DEBUG_VERBOSE, "%a: found Item 0x%x in FwCfg Cache\n", __func__, QemuFwCfgWorkArea->FwCfgItem));

+ return RETURN_SUCCESS;

+}

+/** @file

+ QemuFwCfg cached feature related functions.

+ Copyright (c) 2025, Intel Corporation. All rights reserved.<BR>

+ SPDX-License-Identifier: BSD-2-Clause-Patent

+**/

+

+#include <Uefi.h>

+#include <Library/BaseLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/DebugLib.h>

+#include <Library/QemuFwCfgLib.h>

+#include "QemuFwCfgLibInternal.h"

+#include <Library/TdxHelperLib.h>

+#include <Library/PrintLib.h>

+#include <Library/TpmMeasurementLib.h>

+#include <IndustryStandard/UefiTcgPlatform.h>

+

+#define EV_POSTCODE_INFO_QEMU_FW_CFG_DATA "QEMU FW CFG"

+#define QEMU_FW_CFG_SIZE sizeof (EV_POSTCODE_INFO_QEMU_FW_CFG_DATA)

+

+#pragma pack(1)

+typedef struct {

+ CHAR8 FileName[QEMU_FW_CFG_FNAME_SIZE];

+ BOOLEAN NeedMeasure;

+ UINT16 FwCfgItem;

+ UINT32 FwCfgSize;

+} CACHE_FW_CFG_STRCUT;

+

+typedef struct {

+ UINT8 FwCfg[QEMU_FW_CFG_SIZE];

+ UINT8 FwCfgFileName[QEMU_FW_CFG_FNAME_SIZE];

+} FW_CFG_EVENT;

+

+#pragma pack()

+

+#define QEMU_FW_CFG_SIGNATURE \

+ "QemuFwCfgSignature"

+

+#define QEMU_FW_CFG_SIGNATURE_SIZE sizeof (UINT32)

+

+#define QEMU_FW_CFG_INTERFACE_VERSION \

+ "QemuFwCfgInterfaceVersion"

+

+#define QEMU_FW_CFG_INTERFACE_VERSION_SIZE sizeof (UINT32)

+

+#define QEMU_FW_CFG_FILE_DIR \

+ "QemuFwCfgFileDri"

+

+#define E820_FWCFG_FILE \

+ "etc/e820"

+

+#define SYSTEM_STATES_FWCFG_FILE \

+ "etc/system-states"

+

+#define EXTRA_PCI_ROOTS_FWCFG_FILE \

+ "etc/extra-pci-roots"

+

+#define EXTRA_PCI_ROOTS_FWCFG_SIZE sizeof (UINT64)

+

+#define BOOT_MENU_FWCFG_NAME "BootMenu"

+

+#define BOOT_MENU_FWCFG_SIZE sizeof (UINT16)

+

+#define BOOT_MENU_WAIT_TIME_FWCFG_FILE \

+ "etc/boot-menu-wait"

+

+#define BOOT_MENU_WAIT_TIME_FWCFG_SIZE sizeof (UINT16)

+

+#define RESERVED_MEMORY_END_FWCFG_FILE \

+ "etc/reserved-memory-end"

+

+#define RESERVED_MEMORY_END_FWCFG_SIZE sizeof (UINT64)

+

+#define PCI_MMIO64_FWCFG_FILE \

+ "opt/ovmf/X-PciMmio64Mb"

+

+#define BOOTORDER_FWCFG_FILE \

+ "bootorder"

+

+#define INVALID_FW_CFG_ITEM 0xFFFF

+

+STATIC CONST CACHE_FW_CFG_STRCUT mCacheFwCfgList[] = {

+ { QEMU_FW_CFG_SIGNATURE, FALSE, QemuFwCfgItemSignature, QEMU_FW_CFG_SIGNATURE_SIZE },

+ { QEMU_FW_CFG_INTERFACE_VERSION, FALSE, QemuFwCfgItemInterfaceVersion, QEMU_FW_CFG_INTERFACE_VERSION_SIZE },

+ { QEMU_FW_CFG_FILE_DIR, FALSE, QemuFwCfgItemFileDir, 0 },

+ { E820_FWCFG_FILE, FALSE, INVALID_FW_CFG_ITEM, 0 },

+ { SYSTEM_STATES_FWCFG_FILE, FALSE, INVALID_FW_CFG_ITEM, 0 },

+ { EXTRA_PCI_ROOTS_FWCFG_FILE, TRUE, INVALID_FW_CFG_ITEM, EXTRA_PCI_ROOTS_FWCFG_SIZE },

+ { BOOT_MENU_FWCFG_NAME, TRUE, QemuFwCfgItemBootMenu, BOOT_MENU_FWCFG_SIZE },

+ { BOOT_MENU_WAIT_TIME_FWCFG_FILE, TRUE, INVALID_FW_CFG_ITEM, BOOT_MENU_WAIT_TIME_FWCFG_SIZE },

+ { RESERVED_MEMORY_END_FWCFG_FILE, TRUE, INVALID_FW_CFG_ITEM, RESERVED_MEMORY_END_FWCFG_SIZE },

+ { PCI_MMIO64_FWCFG_FILE, TRUE, INVALID_FW_CFG_ITEM, 0 },

+ { BOOTORDER_FWCFG_FILE, TRUE, INVALID_FW_CFG_ITEM, 0 },

+};

+

+#define CACHE_FW_CFG_COUNT sizeof (mCacheFwCfgList)/sizeof (mCacheFwCfgList[0])

+

+STATIC

+UINT32

+CalcuateQemuFwCfgFileDirSize (

+ IN FIRMWARE_CONFIG_ITEM FwCfgItem

+ )

+{

+ UINT32 FileCount;

+ UINT32 FileDirSize;

+

+ QemuFwCfgSelectItem (FwCfgItem);

+ FileCount = SwapBytes32 (QemuFwCfgRead32 ());

+ FileDirSize = FileCount * sizeof (FWCFG_FILE) + sizeof (UINT32);

+ return FileDirSize;

+}

+

+STATIC

+EFI_STATUS

+ConstructCacheFwCfgList (

+ IN OUT CACHE_FW_CFG_STRCUT *CacheFwCfgList

+ )

+{

+ UINT32 Index;

+ UINT32 Count;

+ UINTN FwCfgSize;

+ FIRMWARE_CONFIG_ITEM FwCfgItem;

+

+ if (CacheFwCfgList == NULL) {

+ return EFI_INVALID_PARAMETER;

+ }

+

+ CopyMem (CacheFwCfgList, mCacheFwCfgList, sizeof (mCacheFwCfgList));

+ Count = CACHE_FW_CFG_COUNT;

+

+ for (Index = 0; Index < Count; Index++) {

+ if (CacheFwCfgList[Index].FwCfgItem == QemuFwCfgItemFileDir) {

+ CacheFwCfgList[Index].FwCfgSize = CalcuateQemuFwCfgFileDirSize (QemuFwCfgItemFileDir);

+ continue;

+ }

+

+ if (CacheFwCfgList[Index].FwCfgItem != INVALID_FW_CFG_ITEM) {

+ continue;

+ }

+

+ if (EFI_ERROR (QemuFwCfgFindFile (CacheFwCfgList[Index].FileName, &FwCfgItem, &FwCfgSize))) {

+ continue;

+ }

+

+ if (FwCfgSize == 0) {

+ continue;

+ }

+

+ if ((CacheFwCfgList[Index].FwCfgSize != 0) && (FwCfgSize != CacheFwCfgList[Index].FwCfgSize)) {

+ continue;

+ }

+

+ CacheFwCfgList[Index].FwCfgItem = (UINT16)FwCfgItem;

+ CacheFwCfgList[Index].FwCfgSize = (UINT32)FwCfgSize;

+ }

+

+ return EFI_SUCCESS;

+}

+

+STATIC

+EFI_STATUS

+CacheFwCfgInfoWithOptionalMeasurment (

+ IN CACHE_FW_CFG_STRCUT *CacheFwCfgList

+ )

+{

+ UINT32 Index;

+ UINT32 Count;

+ UINT8 *FwCfginfoHobData;

+ FW_CFG_CACHED_ITEM *CachedItem;

+ UINT8 *ItemData;

+ UINT32 FwCfgItemHobSize;

+

+ Count = CACHE_FW_CFG_COUNT;

+

+ for (Index = 0; Index < Count; Index++) {

+ if ((CacheFwCfgList[Index].FwCfgItem == INVALID_FW_CFG_ITEM) || (CacheFwCfgList[Index].FwCfgSize == 0)) {

+ continue;

+ }

+

+ FwCfginfoHobData = NULL;

+ FwCfgItemHobSize = sizeof (FW_CFG_CACHED_ITEM) + CacheFwCfgList[Index].FwCfgSize;

+ FwCfginfoHobData = BuildGuidHob (&gOvmfFwCfgInfoHobGuid, FwCfgItemHobSize);

+ if (FwCfginfoHobData == NULL) {

+ DEBUG ((DEBUG_ERROR, "%a: BuildGuidHob Failed with FwCfgItemHobSize(0x%x)\n", __func__, FwCfgItemHobSize));

+ return EFI_OUT_OF_RESOURCES;

+ }

+

+ ZeroMem (FwCfginfoHobData, FwCfgItemHobSize);

+ CachedItem = (FW_CFG_CACHED_ITEM *)FwCfginfoHobData;

+ ItemData = (UINT8 *)CachedItem + sizeof (FW_CFG_CACHED_ITEM);

+

+ QemuFwCfgSelectItem (CacheFwCfgList[Index].FwCfgItem);

+ QemuFwCfgReadBytes (CacheFwCfgList[Index].FwCfgSize, ItemData);

+

+ CachedItem->FwCfgItem = CacheFwCfgList[Index].FwCfgItem;

+ CachedItem->DataSize = CacheFwCfgList[Index].FwCfgSize;

+ DEBUG ((

+ DEBUG_INFO,

+ "Cache FwCfg Name: %a Item:0x%x Size: 0x%x \n",

+ CacheFwCfgList[Index].FileName,

+ CachedItem->FwCfgItem,

+ CachedItem->DataSize

+ ));

+

+ if (CacheFwCfgList[Index].NeedMeasure == FALSE) {

+ continue;

+ }

+

+ if (TdIsEnabled ()) {

+ FW_CFG_EVENT FwCfgEvent;

+ EFI_STATUS Status;

+

+ ZeroMem (&FwCfgEvent, sizeof (FW_CFG_EVENT));

+ CopyMem (&FwCfgEvent.FwCfg, EV_POSTCODE_INFO_QEMU_FW_CFG_DATA, sizeof (EV_POSTCODE_INFO_QEMU_FW_CFG_DATA));

+ CopyMem (&FwCfgEvent.FwCfgFileName, CacheFwCfgList[Index].FileName, QEMU_FW_CFG_FNAME_SIZE);

+

+ Status = TpmMeasureAndLogData (

+ 1,

+ EV_PLATFORM_CONFIG_FLAGS,

+ (VOID *)&FwCfgEvent,

+ sizeof (FwCfgEvent),

+ (VOID *)ItemData,

+ CacheFwCfgList[Index].FwCfgSize

+ );

+ if (EFI_ERROR (Status)) {

+ DEBUG ((DEBUG_ERROR, "TpmMeasureAndLogData failed with %r\n", Status));

+ }

+ }

+ }

+

+ return EFI_SUCCESS;

+}

+

+EFI_STATUS

+InternalQemuFwCfgInitCache (

+ IN OUT EFI_HOB_PLATFORM_INFO *PlatformInfoHob

+ )

+{

+ if (PlatformInfoHob == NULL) {

+ return EFI_INVALID_PARAMETER;

+ }

+

+ PlatformInfoHob->QemuFwCfgWorkArea.FwCfgItem = INVALID_FW_CFG_ITEM;

+ PlatformInfoHob->QemuFwCfgWorkArea.Offset = 0;

+ PlatformInfoHob->QemuFwCfgWorkArea.Reading = FALSE;

+

+ if (!QemuFwCfgIsAvailable ()) {

+ return EFI_UNSUPPORTED;

+ }

+

+ CACHE_FW_CFG_STRCUT CacheFwCfgList[CACHE_FW_CFG_COUNT];

+

+ if (EFI_ERROR (ConstructCacheFwCfgList (CacheFwCfgList))) {

+ return EFI_ABORTED;

+ }

+

+ if (EFI_ERROR (CacheFwCfgInfoWithOptionalMeasurment (CacheFwCfgList))) {

+ return EFI_ABORTED;

+ }

+

+ return EFI_SUCCESS;

+}

+STATIC QEMU_FW_CFG_WORK_AREA mQemuFwCfgWorkArea = { 0 };

+

+ mQemuFwCfgWorkArea.QemuFwCfgSupported = TRUE;

+ mQemuFwCfgWorkArea.QemuFwCfgDmaSupported = FALSE;

+ mQemuFwCfgWorkArea.QemuFwCfgSupported = FALSE;

+ mQemuFwCfgWorkArea.QemuFwCfgDmaSupported = TRUE;

+ if (mQemuFwCfgWorkArea.QemuFwCfgDmaSupported && (CC_GUEST_IS_SEV (CcGuestAttr) ||

+ CC_GUEST_IS_TDX (CcGuestAttr)))

+ return mQemuFwCfgWorkArea.QemuFwCfgSupported;

+ return mQemuFwCfgWorkArea.QemuFwCfgDmaSupported;

+

+/**

+ Check if the Ovmf work area is built as HobList before invoking Hob services.

+

+ @retval TRUE Ovmf work area is not NULL and it is built as HobList.

+ @retval FALSE Ovmf work area is NULL or it is not built as HobList.

+**/

+BOOLEAN

+InternalQemuFwCfgCheckOvmfWorkArea (

+ VOID

+ )

+{

+ return TRUE;

+}

+

+/**

+ Get the pointer to the QEMU_FW_CFG_WORK_AREA. This data is used as the

+ workarea to record the ongoing fw_cfg item and offset.

+ @retval QEMU_FW_CFG_WORK_AREA Pointer to the QEMU_FW_CFG_WORK_AREA

+ @retval NULL QEMU_FW_CFG_WORK_AREA doesn't exist

+**/

+QEMU_FW_CFG_WORK_AREA *

+InternalQemuFwCfgCacheGetWorkArea (

+ VOID

+ )

+{

+ return &mQemuFwCfgWorkArea;

+}

+

+RETURN_STATUS

+EFIAPI

+QemuFwCfgInitCache (

+ IN OUT EFI_HOB_PLATFORM_INFO *PlatformInfoHob

+ )

+{

+ return RETURN_UNSUPPORTED;

+}

+ QemuFwCfgCache.c

+ HobLib

+[Guids]

+ gOvmfFwCfgInfoHobGuid

+

+

+ if (InternalQemuFwCfgCacheSelectItem (QemuFwCfgItem)) {

+ return;

+ } else {

+ InternalQemuFwCfgCacheResetWorkArea ();

+ }

+

+ if ( InternalQemuFwCfgCacheReading ()) {

+ InternalQemuFwCfgCacheReadBytes (Size, Buffer);

+ return;

+ }

+

+ Skip bytes in FwCfg cache info Hob.

+ @param[in] Size Number of bytes to skip.

+**/

+STATIC

+VOID

+InternalQemuFwCfgCacheSkipBytes (

+ IN UINT32 Size

+ )

+{

+ QEMU_FW_CFG_WORK_AREA *QemuFwCfgWorkArea;

+

+ if (Size == 0) {

+ return;

+ }

+

+ QemuFwCfgWorkArea = InternalQemuFwCfgCacheGetWorkArea ();

+ if ((QemuFwCfgWorkArea->Offset + Size) > MAX_UINT32) {

+ DEBUG ((DEBUG_ERROR, "%a: Integer overflow with invalid offset size\n", __func__));

+ ASSERT (FALSE);

+ QemuFwCfgWorkArea->Offset = MAX_UINT32;

+ } else {

+ QemuFwCfgWorkArea->Offset += Size;

+ }

+}

+

+/**

+ if ( InternalQemuFwCfgCacheReading () && (Size <= MAX_UINT32)) {

+ InternalQemuFwCfgCacheSkipBytes ((UINT32)Size);

+ return;

+ }

+

+#include <Base.h>

+#include <Uefi/UefiMultiPhase.h>

+#include <Uefi/UefiBaseType.h>

+#include <Pi/PiBootMode.h>

+#include <Pi/PiHob.h>

+#include <Library/HobLib.h>

+#include <Library/BaseMemoryLib.h>

+

+#pragma pack(1)

+typedef struct {

+ UINT16 FwCfgItem;

+ UINT32 DataSize;

+ // UINT8 *data

+} FW_CFG_CACHED_ITEM;

+

+// Refer to https://www.qemu.org/docs/master/specs/fw_cfg.html

+// The FwCfg File item struct in QemuFwCfgItemFileDir

+typedef struct {

+ UINT32 Size; /* size of referenced fw_cfg item, big-endian */

+ UINT16 Select; /* selector key of fw_cfg item, big-endian */

+ UINT16 Reserved;

+ UINT8 Name[QEMU_FW_CFG_FNAME_SIZE];

+} FWCFG_FILE;

+#pragma pack()

+

+/**

+ Check if the Ovmf work area is built as HobList before invoking Hob services.

+

+ @retval TRUE Ovmf work area is not NULL and it is built as HobList.

+ @retval FALSE Ovmf work area is NULL or it is not built as HobList.

+**/

+BOOLEAN

+InternalQemuFwCfgCheckOvmfWorkArea (

+ VOID

+ );

+

+/**

+ Read the fw_cfg data from Cache.

+ @retval EFI_SUCCESS - Successfully

+ @retval Others - As the error code indicates

+**/

+EFI_STATUS

+InternalQemuFwCfgCacheReadBytes (

+ IN UINTN Size,

+ IN OUT VOID *Buffer

+ );

+

+/**

+ Select the fw_cfg item for reading from cache. If the fw_cfg item

+ is not cached, then it returns FALSE.

+ @param[in] Item The fw_cfg item to be selected

+ @retval TRUE The fw_cfg item is selected.

+ @retval FALSE The fw_cfg item is not selected.

+**/

+BOOLEAN

+InternalQemuFwCfgCacheSelectItem (

+ IN FIRMWARE_CONFIG_ITEM Item

+ );

+

+/**

+ Get the pointer to the QEMU_FW_CFG_WORK_AREA. This data is used as the

+ workarea to record the ongoing fw_cfg item and offset.

+ @retval QEMU_FW_CFG_WORK_AREA Pointer to the QEMU_FW_CFG_WORK_AREA

+ @retval NULL QEMU_FW_CFG_WORK_AREA doesn't exist

+**/

+QEMU_FW_CFG_WORK_AREA *

+InternalQemuFwCfgCacheGetWorkArea (

+ VOID

+ );

+

+/**

+ Clear the QEMU_FW_CFG_WORK_AREA.

+**/

+VOID

+InternalQemuFwCfgCacheResetWorkArea (

+ VOID

+ );

+

+/**

+ Get the pointer to the cached fw_cfg item.

+ @param[in] Item The fw_cfg item to be retrieved.

+ @retval FW_CFG_CACHED_ITEM Pointer to the cached fw_cfg item.

+ @retval NULL The fw_cfg item is not cached.

+**/

+FW_CFG_CACHED_ITEM *

+InternalQemuFwCfgItemCached (

+ IN FIRMWARE_CONFIG_ITEM Item

+ );

+

+/**

+ Check if reading from FwCfgCache is ongoing.

+ @retval TRUE Reading from FwCfgCache is ongoing.

+ @retval FALSE Reading from FwCfgCache is not ongoing.

+**/

+BOOLEAN

+InternalQemuFwCfgCacheReading (

+ VOID

+ );

+

+/**

+ init the fw_cfg info hob with optional measurement

+**/

+EFI_STATUS

+InternalQemuFwCfgInitCache (

+ IN OUT EFI_HOB_PLATFORM_INFO *PlatformInfoHob

+ );

+

+

+RETURN_STATUS

+EFIAPI

+QemuFwCfgInitCache (

+ IN OUT EFI_HOB_PLATFORM_INFO *PlatformInfoHob

+ )

+{

+ return RETURN_UNSUPPORTED;

+}

+ QemuFwCfgSelectItem (QemuFwCfgItemSignature);

+ if ( InternalQemuFwCfgCacheReading ()) {

+ InternalQemuFwCfgCacheReadBytes (sizeof Signature, &Signature);

+ } else {

+ IoReadFifo8 (FW_CFG_IO_DATA, sizeof Signature, &Signature);

+ }

+

+ QemuFwCfgSelectItem (QemuFwCfgItemInterfaceVersion);

+ if ( InternalQemuFwCfgCacheReading ()) {

+ InternalQemuFwCfgCacheReadBytes (sizeof Revision, &Revision);

+ } else {

+ IoReadFifo8 (FW_CFG_IO_DATA, sizeof Revision, &Revision);

+ }

+

+ &PlatformInfoHob->QemuFwCfgWorkArea.QemuFwCfgSupported,

+ &PlatformInfoHob->QemuFwCfgWorkArea.QemuFwCfgDmaSupported

+ return PlatformInfoHob->QemuFwCfgWorkArea.QemuFwCfgSupported;

+ return PlatformInfoHob->QemuFwCfgWorkArea.QemuFwCfgDmaSupported;

+

+/**

+ Get the pointer to the QEMU_FW_CFG_WORK_AREA. This data is used as the

+ workarea to record the onging fw_cfg item and offset.

+ @retval QEMU_FW_CFG_WORK_AREA Pointer to the QEMU_FW_CFG_WORK_AREA

+ @retval NULL QEMU_FW_CFG_WORK_AREA doesn't exist

+**/

+QEMU_FW_CFG_WORK_AREA *

+InternalQemuFwCfgCacheGetWorkArea (

+ VOID

+ )

+{

+ EFI_HOB_GUID_TYPE *GuidHob;

+ EFI_HOB_PLATFORM_INFO *PlatformHobinfo;

+

+ GuidHob = GetFirstGuidHob (&gUefiOvmfPkgPlatformInfoGuid);

+ if (GuidHob == NULL) {

+ return NULL;

+ }

+

+ PlatformHobinfo = (EFI_HOB_PLATFORM_INFO *)(VOID *)GET_GUID_HOB_DATA (GuidHob);

+ return &(PlatformHobinfo->QemuFwCfgWorkArea);

+}

+

+/**

+ OVMF reads configuration data from QEMU via fw_cfg.

+ For Td-Guest VMM is out of TCB and the configuration data is untrusted.

+ From the security perpective the configuration data shall be measured

+ before it is consumed.

+ This function reads the fw_cfg items and cached them. In the meanwhile these

+ fw_cfg items are measured as well. This is to avoid changing the order when

+ reading the fw_cfg process, which depends on multiple factors(depex, order in

+ the Firmware volume).

+ @retval RETURN_SUCCESS - Successfully cache with measurement

+ @retval Others - As the error code indicates

+ */

+RETURN_STATUS

+EFIAPI

+QemuFwCfgInitCache (

+ IN OUT EFI_HOB_PLATFORM_INFO *PlatformInfoHob

+ )

+{

+ if (EFI_ERROR (InternalQemuFwCfgInitCache (PlatformInfoHob))) {

+ return RETURN_ABORTED;

+ }

+

+ DEBUG ((DEBUG_INFO, "QemuFwCfgInitCache Pass!!!\n"));

+ return RETURN_SUCCESS;

+}

+ QemuFwCfgCache.c

+ QemuFwCfgCacheInit.c

+ MdeModulePkg/MdeModulePkg.dec

+ SecurityPkg/SecurityPkg.dec

+ TpmMeasurementLib

+ gOvmfFwCfgInfoHobGuid

+#include <Library/PcdLib.h>

+#include <PiPei.h>

+#include <WorkArea.h>

+

+#ifdef TDX_PEI_LESS_BOOT

+

+/**

+ Check if the Ovmf work area is built as HobList before invoking Hob services.

+

+ @retval TRUE Ovmf work area is not NULL and it is built as HobList.

+ @retval FALSE Ovmf work area is NULL or it is not built as HobList.

+**/

+BOOLEAN

+InternalQemuFwCfgCheckOvmfWorkArea (

+ VOID

+ )

+{

+ TDX_WORK_AREA *TdxWorkArea;

+

+ // QemuFwCfgLib might be called in a very early stage

+ // (at that moment HobList may not be set). So an additional check

+ // to the HobList is needed.

+ TdxWorkArea = (TDX_WORK_AREA *)(UINTN)FixedPcdGet32 (PcdOvmfWorkAreaBase);

+ if ((TdxWorkArea == NULL) || (TdxWorkArea->SecTdxWorkArea.HobList == 0)) {

+ return FALSE;

+ } else {

+ return TRUE;

+ }

+}

+

+/**

+ Get the pointer to the QEMU_FW_CFG_WORK_AREA. This data is used as the

+ workarea to record the ongoing fw_cfg item and offset.

+ @retval QEMU_FW_CFG_WORK_AREA Pointer to the QEMU_FW_CFG_WORK_AREA

+ @retval NULL QEMU_FW_CFG_WORK_AREA doesn't exist

+**/

+QEMU_FW_CFG_WORK_AREA *

+InternalQemuFwCfgCacheGetWorkArea (

+ VOID

+ )

+{

+ EFI_HOB_GUID_TYPE *GuidHob;

+ EFI_HOB_PLATFORM_INFO *PlatformHobinfo;

+

+ if (InternalQemuFwCfgCheckOvmfWorkArea () == FALSE) {

+ return NULL;

+ }

+

+ GuidHob = GetFirstGuidHob (&gUefiOvmfPkgPlatformInfoGuid);

+ if (GuidHob == NULL) {

+ return NULL;

+ }

+

+ PlatformHobinfo = (EFI_HOB_PLATFORM_INFO *)(VOID *)GET_GUID_HOB_DATA (GuidHob);

+ return &(PlatformHobinfo->QemuFwCfgWorkArea);

+}

+

+/**

+ OVMF reads configuration data from QEMU via fw_cfg.

+ For Td-Guest VMM is out of TCB and the configuration data is untrusted.

+ From the security perpective the configuration data shall be measured

+ before it is consumed.

+ This function reads the fw_cfg items and cached them. In the meanwhile these

+ fw_cfg items are measured as well. This is to avoid changing the order when

+ reading the fw_cfg process, which depends on multiple factors(depex, order in

+ the Firmware volume).

+ @retval RETURN_SUCCESS - Successfully cache with measurement

+ @retval Others - As the error code indicates

+ */

+RETURN_STATUS

+EFIAPI

+QemuFwCfgInitCache (

+ IN OUT EFI_HOB_PLATFORM_INFO *PlatformInfoHob

+ )

+{

+ if (!QemuFwCfgIsAvailable ()) {

+ DEBUG ((DEBUG_ERROR, "%a: Qemu Fw_Cfg is not Available! \n", __func__));

+ return RETURN_UNSUPPORTED;

+ }

+

+ if (InternalQemuFwCfgCheckOvmfWorkArea () == FALSE) {

+ return RETURN_ABORTED;

+ }

+

+ if (EFI_ERROR (InternalQemuFwCfgInitCache (PlatformInfoHob))) {

+ return RETURN_ABORTED;

+ }

+

+ DEBUG ((DEBUG_INFO, "QemuFwCfgInitCache Pass!!!\n"));

+ return RETURN_SUCCESS;

+}

+

+#endif

+ QemuFwCfgCache.c

+ QemuFwCfgCacheInit.c

+ MdeModulePkg/MdeModulePkg.dec

+ SecurityPkg/SecurityPkg.dec

+ HobLib

+ TpmMeasurementLib

+

+[Guids]

+ gOvmfFwCfgInfoHobGuid

+ gUefiOvmfPkgPlatformInfoGuid

+

+[Pcd]

+ gUefiOvmfPkgTokenSpaceGuid.PcdOvmfWorkAreaBase

+ gOvmfFwCfgInfoHobGuid = {0xa291ce0e, 0xdc09, 0x11ee, {0x9e, 0xdb, 0x73, 0x49, 0xd7, 0x92, 0xaf, 0x51}}

+ if (RETURN_ERROR (QemuFwCfgInitCache (PlatformInfoHob))) {

+ DEBUG ((DEBUG_ERROR, "QemuFwCfgInitCache failed !\n"));

+ }

+

+/** @file

+ Extend to RTMR and Build GuidHob for tdx measurement.

+

+ Copyright (c) 2025, Intel Corporation. All rights reserved.<BR>

+

+ SPDX-License-Identifier: BSD-2-Clause-Patent

+

+**/

+

+#include <PiPei.h>

+#include <Library/BaseLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/DebugLib.h>

+#include <Library/HobLib.h>

+#include <Library/PrintLib.h>

+#include <Library/TdxLib.h>

+#include <Library/BaseCryptLib.h>

+#include <Library/TpmMeasurementLib.h>

+#include <IndustryStandard/UefiTcgPlatform.h>

+#include <Library/TdxMeasurementLib.h>

+

+/**

+ Do a hash operation on a data buffer, extend a specific RTMR with the hash result,

+ and add an entry to the Event Log.

+

+ @param[in] PcrIndex PCRIndex Index of the TPM PCR

+ @param[in] EventType Type of the Event.

+ @param[in] EventLog Physical address of the start of the data buffer.

+ @param[in] EventSize The length, in bytes, of the buffer referenced by EventLog.

+ @param[in] HashData Physical address of the start of the data buffer

+ to be hashed, extended, and logged.

+ @param[in] HashDataLen The length, in bytes, of the buffer referenced by HashData

+

+ @retval EFI_SUCCESS The measurement is successful

+ @retval Others Other errors as indicated

+**/

+EFI_STATUS

+EFIAPI

+TdxHashLogExtendEvent (

+ IN UINT32 PcrIndex,

+ IN UINT32 EventType,

+ IN VOID *EventLog,

+ IN UINT32 LogLen,

+ IN VOID *HashData,

+ IN UINT64 HashDataLen

+ )

+{

+ EFI_STATUS Status;

+ UINT8 Digest[SHA384_DIGEST_SIZE];

+ UINT32 MrIndex;

+

+ if ((EventLog == NULL) || (HashData == NULL)) {

+ return EFI_INVALID_PARAMETER;

+ }

+

+ if (!TdIsEnabled ()) {

+ return EFI_UNSUPPORTED;

+ }

+

+ MrIndex = TdxMeasurementMapPcrToMrIndex (PcrIndex);

+ if (MrIndex == CC_MR_INDEX_INVALID) {

+ return EFI_INVALID_PARAMETER;

+ }

+

+ Status = TdxMeasurementHashAndExtendToRtmr (

+ MrIndex - 1,

+ (UINT8 *)HashData,

+ (UINTN)HashDataLen,

+ Digest,

+ SHA384_DIGEST_SIZE

+ );

+

+ if (EFI_ERROR (Status)) {

+ DEBUG ((DEBUG_ERROR, "%a: TdxMeasurementHashAndExtendToRtmr failed with %r\n", __func__, Status));

+ return Status;

+ }

+

+ Status = TdxMeasurementBuildGuidHob (

+ MrIndex - 1,

+ EventType,

+ EventLog,

+ LogLen,

+ Digest,

+ SHA384_DIGEST_SIZE

+ );

+

+ if (EFI_ERROR (Status)) {

+ DEBUG ((DEBUG_ERROR, "%a: TdxMeasurementBuildGuidHob failed with %r\n", __func__, Status));

+ }

+

+ return Status;

+}

+/** @file

+ TpmMeasurementLib SEC implementation.

+

+ Copyright (c) 2025, Intel Corporation. All rights reserved.<BR>

+

+ SPDX-License-Identifier: BSD-2-Clause-Patent

+

+**/

+

+#include <PiPei.h>

+#include <Library/BaseLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/DebugLib.h>

+#include <Library/TpmMeasurementLib.h>

+#include <IndustryStandard/UefiTcgPlatform.h>

+#include <Library/CcProbeLib.h>

+

+/**

+ Do a hash operation on a data buffer, extend a specific RTMR with the hash result,

+ and add an entry to the Event Log.

+

+ @param[in] PcrIndex PCRIndex Index of the TPM PCR

+ @param[in] EventType Type of the Event.

+ @param[in] EventLog Physical address of the start of the data buffer.

+ @param[in] EventSize The length, in bytes, of the buffer referenced by EventLog.

+ @param[in] HashData Physical address of the start of the data buffer

+ to be hashed, extended, and logged.

+ @param[in] HashDataLen The length, in bytes, of the buffer referenced by HashData

+

+ @retval EFI_SUCCESS The measurement is successful

+ @retval Others Other errors as indicated

+**/

+EFI_STATUS

+EFIAPI

+TdxHashLogExtendEvent (

+ IN UINT32 PcrIndex,

+ IN UINT32 EventType,

+ IN VOID *EventLog,

+ IN UINT32 LogLen,

+ IN VOID *HashData,

+ IN UINT64 HashDataLen

+ );

+

+/**

+ Tpm measure and log data, and extend the measurement result into a specific PCR.

+

+ @param[in] PcrIndex PCR Index.

+ @param[in] EventType Event type.

+ @param[in] EventLog Measurement event log.

+ @param[in] LogLen Event log length in bytes.

+ @param[in] HashData The start of the data buffer to be hashed, extended.

+ @param[in] HashDataLen The length, in bytes, of the buffer referenced by HashData

+

+ @retval EFI_SUCCESS Operation completed successfully.

+ @retval EFI_UNSUPPORTED TPM device not available.

+ @retval EFI_OUT_OF_RESOURCES Out of memory.

+ @retval EFI_DEVICE_ERROR The operation was unsuccessful.

+**/

+EFI_STATUS

+EFIAPI

+TpmMeasureAndLogData (

+ IN UINT32 PcrIndex,

+ IN UINT32 EventType,

+ IN VOID *EventLog,

+ IN UINT32 LogLen,

+ IN VOID *HashData,

+ IN UINT64 HashDataLen

+ )

+{

+ if (CcProbe () == CcGuestTypeIntelTdx) {

+ return TdxHashLogExtendEvent (PcrIndex, EventType, EventLog, LogLen, HashData, HashDataLen);

+ }

+

+ return EFI_UNSUPPORTED;

+}

+## @file

+# TpmMeasurementLib SEC instance

+#

+# Copyright (c) 2025, Intel Corporation. All rights reserved.<BR>

+#

+# SPDX-License-Identifier: BSD-2-Clause-Patent

+#

+##

+

+[Defines]

+ INF_VERSION = 0x00010005

+ BASE_NAME = SecTpmMeasurementLib

+ FILE_GUID = a608aadb-3809-4b7c-9ab9-c42ef79c508e

+ MODULE_TYPE = BASE

+ VERSION_STRING = 1.0

+ LIBRARY_CLASS = TpmMeasurementLib | SEC

+

+#

+# The following information is for reference only and not required by the build tools.

+#

+# VALID_ARCHITECTURES = X64

+#

+

+[Sources]

+ IntelTdx.c

+ SecTpmMeasurementLib.c

+

+[Packages]

+ MdePkg/MdePkg.dec

+ CryptoPkg/CryptoPkg.dec

+ MdeModulePkg/MdeModulePkg.dec

+ SecurityPkg/SecurityPkg.dec

+

+[LibraryClasses]

+ BaseLib

+ DebugLib

+ HobLib

+ PcdLib

+ CcProbeLib

+ TdxMeasurementLib

+ BaseCryptLib

+

+[Guids]

+ gCcEventEntryHobGuid

+[LibraryClasses.common.SEC]

+ TpmMeasurementLib|SecurityPkg/Library/SecTpmMeasurementLib/SecTpmMeasurementLib.inf

+

+ SecurityPkg/Library/SecTpmMeasurementLib/SecTpmMeasurementLib.inf

+ MP information HOB to be provided by MP service module.

+ MP information HOB only provides static information of MP processors.

+ Copyright (c) 2023 - 2025, Intel Corporation. All rights reserved.<BR>

+#include <Pi/PiMultiPhase.h>