Updated to convert Pref entry to FPDT record in SMM phase and then export records to FPDT table.
Cc: Liming Gao <liming....@intel.com> Cc: Star Zeng <star.z...@intel.com> Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Dandan Bi <dandan...@intel.com> --- .../SmmCorePerformanceLib/SmmCorePerformanceLib.c | 1094 ++++++++++++-------- .../SmmCorePerformanceLib.inf | 10 +- .../SmmCorePerformanceLibInternal.h | 11 +- 3 files changed, 681 insertions(+), 434 deletions(-) diff --git a/MdeModulePkg/Library/SmmCorePerformanceLib/SmmCorePerformanceLib.c b/MdeModulePkg/Library/SmmCorePerformanceLib/SmmCorePerformanceLib.c index cd1f1a5..cb880ef 100644 --- a/MdeModulePkg/Library/SmmCorePerformanceLib/SmmCorePerformanceLib.c +++ b/MdeModulePkg/Library/SmmCorePerformanceLib/SmmCorePerformanceLib.c @@ -14,11 +14,11 @@ 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) 2011 - 2017, Intel Corporation. All rights reserved.<BR> +Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php @@ -28,30 +28,32 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #include "SmmCorePerformanceLibInternal.h" -// -// The data structure to hold global performance data. -// -GAUGE_DATA_HEADER *mGaugeData; - -// -// The current maximum number of logging entries. If current number of -// entries exceeds this value, it will re-allocate a larger array and -// migration the old data to the larger array. -// -UINT32 mMaxGaugeRecords; - -// -// The handle to install Performance Protocol instance. -// -EFI_HANDLE mHandle = NULL; - -BOOLEAN mPerformanceMeasurementEnabled; - -SPIN_LOCK mSmmPerfLock; +#define STRING_SIZE (EDKII_STRING_EVENT_RECORD_NAME_LENGTH * sizeof (CHAR8)) +#define MAX_RECORD_SIZE (sizeof (FPDT_RECORD) + STRING_SIZE) +#define FIRMWARE_RECORD_BUFFER 0x1000 +#define CACHE_HANDLE_GUID_COUNT 0x1000 + +typedef struct { + EFI_HANDLE Handle; + CHAR8 NameString[EDKII_STRING_EVENT_RECORD_NAME_LENGTH]; + EFI_GUID ModuleGuid; +} HANDLE_GUID_MAP; + +HANDLE_GUID_MAP mCacheHandleGuidTable[CACHE_HANDLE_GUID_COUNT]; +UINTN mCachePairCount = 0; + +UINT8 *mPerformancePointer = NULL; +UINTN mPerformanceLength = 0; +UINTN mMaxPerformanceLength = 0; +BOOLEAN mFpdtDataIsReported = FALSE; +BOOLEAN mStartFpdtDataReport = FALSE; +CHAR8 *mPlatformLanguage = NULL; +SPIN_LOCK mSmmFpdtLock; +PERFORMANCE_PROPERTY mPerformanceProperty; // // Interfaces for SMM Performance Protocol. // PERFORMANCE_PROTOCOL mPerformanceInterface = { @@ -67,172 +69,634 @@ PERFORMANCE_EX_PROTOCOL mPerformanceExInterface = { StartGaugeEx, EndGaugeEx, GetGaugeEx }; -PERFORMANCE_PROPERTY mPerformanceProperty; +/** +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 (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; + } +} /** - Searches in the gauge array with keyword Handle, Token, Module and Identfier. +Check whether the ID is a known one which map to the known Token. + +@param Identifier 32-bit identifier. - This internal function searches for the gauge entry in the gauge array. - If there is an entry that exactly matches the given keywords - and its end time stamp is zero, then the index of that gauge entry is returned; - otherwise, the the number of gauge entries in the array is returned. +@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 info. + + @param IsStart TRUE if the performance log is start log. @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 Identifier 32-bit identifier. + @param RecordInfo On return, pointer to the info of the record. + @param UseModuleName Only useful for DYNAMIC_STRING_EVENT_TYPE, indicate that whether need use + Module name to fill the string field in the DYNAMIC_STRING_EVENT_RECORD. - @retval The index of gauge entry in the array. + @retval EFI_SUCCESS Get record info successfully. + @retval EFI_UNSUPPORTED No matched FPDT record. **/ -UINT32 -SmmSearchForGaugeEntry ( - IN CONST VOID *Handle, OPTIONAL - IN CONST CHAR8 *Token, OPTIONAL - IN CONST CHAR8 *Module, OPTIONAL - IN CONST UINT32 Identifier +EFI_STATUS +GetFpdtRecordInfo ( + IN BOOLEAN IsStart, + IN CONST VOID *Handle, + IN CONST CHAR8 *Token, + IN CONST CHAR8 *Module, + OUT BASIC_RECORD_INFO *RecordInfo, + IN OUT BOOLEAN *UseModuleName ) { - UINT32 Index; - UINT32 Index2; - UINT32 NumberOfEntries; - GAUGE_DATA_ENTRY_EX *GaugeEntryExArray; + UINT16 RecordType; + UINTN StringSize; - if (Token == NULL) { - Token = ""; - } - if (Module == NULL) { - Module = ""; + RecordType = DYNAMIC_STRING_EVENT_TYPE; + + // + // Token to Type and Id. + // + if (Token != NULL) { + if (AsciiStrCmp (Token, START_IMAGE_TOK) == 0) { // "StartImage:" + *UseModuleName = TRUE; + RecordType = GUID_EVENT_TYPE; + if (IsStart) { + RecordInfo->ProgressID = MODULE_START_ID; + } else { + RecordInfo->ProgressID = MODULE_END_ID; + } + } else if (AsciiStrCmp (Token, LOAD_IMAGE_TOK) == 0) { // "LoadImage:" + *UseModuleName = TRUE; + RecordType = GUID_QWORD_EVENT_TYPE; + if (IsStart) { + RecordInfo->ProgressID = MODULE_LOADIMAGE_START_ID; + } else { + RecordInfo->ProgressID = MODULE_LOADIMAGE_END_ID; + } + } else { // Pref used in Modules + if (IsStart) { + RecordInfo->ProgressID = PERF_INMODULE_START_ID; + } else { + RecordInfo->ProgressID = PERF_INMODULE_END_ID; + } + } + } else if (Handle != NULL || Module != NULL) { // Pref used in Modules + if (IsStart) { + RecordInfo->ProgressID = PERF_INMODULE_START_ID; + } else { + RecordInfo->ProgressID = PERF_INMODULE_END_ID; + } + } else { + return EFI_UNSUPPORTED; } - NumberOfEntries = mGaugeData->NumberOfEntries; - GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1); + if (PcdGetBool (PcdEdkiiFpdtStringRecordEnableOnly)) { + RecordType = DYNAMIC_STRING_EVENT_TYPE; + RecordInfo->RecordSize = sizeof (DYNAMIC_STRING_EVENT_RECORD) + STRING_SIZE; + } else { + switch (RecordType) { + case GUID_EVENT_TYPE: + RecordInfo->RecordSize = sizeof (GUID_EVENT_RECORD); + break; - Index2 = 0; + case DYNAMIC_STRING_EVENT_TYPE: + if (*UseModuleName) { + StringSize = STRING_SIZE; + } else if (Token != NULL) { + StringSize = AsciiStrSize (Token); + } else if (Module != NULL) { + StringSize = AsciiStrSize (Module); + } else { + StringSize = STRING_SIZE; + } + if (StringSize > STRING_SIZE) { + StringSize = STRING_SIZE; + } + RecordInfo->RecordSize = (UINT8)(sizeof (DYNAMIC_STRING_EVENT_RECORD) + StringSize); + break; - for (Index = 0; Index < NumberOfEntries; Index++) { - Index2 = NumberOfEntries - 1 - Index; - if (GaugeEntryExArray[Index2].EndTimeStamp == 0 && - (GaugeEntryExArray[Index2].Handle == (EFI_PHYSICAL_ADDRESS) (UINTN) Handle) && - AsciiStrnCmp (GaugeEntryExArray[Index2].Token, Token, SMM_PERFORMANCE_STRING_LENGTH) == 0 && - AsciiStrnCmp (GaugeEntryExArray[Index2].Module, Module, SMM_PERFORMANCE_STRING_LENGTH) == 0) { - Index = Index2; + case GUID_QWORD_EVENT_TYPE: + RecordInfo->RecordSize = (UINT8)sizeof (GUID_QWORD_EVENT_RECORD); break; + + default: + // + // Record type is unsupported in SMM phase. + // + return EFI_UNSUPPORTED; } } - return Index; + RecordInfo->Type = RecordType; + return EFI_SUCCESS; } /** - Adds a record at the end of the performance measurement log - that records the start time of a performance measurement. + Get a human readable module name and module guid for the given image handle. + If module name can't be found, "" string will return. + If module guid can't be found, Zero Guid will return. + + @param Handle Image handle or Controller handle. + @param NameString The ascii string will be filled into it. If not found, null string will return. + @param BufferSize Size of the input NameString buffer. + @param ModuleGuid Point to the guid buffer to store the got module guid value. + + @retval EFI_SUCCESS Successfully get module name and guid. + @retval EFI_INVALID_PARAMETER The input parameter NameString is NULL. + @retval other value Module Name can't be got. +**/ +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_DRIVER_BINDING_PROTOCOL *DriverBinding; + CHAR8 *PdbFileName; + EFI_GUID *TempGuid; + UINTN StartIndex; + UINTN Index; + INTN Count; + BOOLEAN ModuleGuidIsGet; + UINTN StringSize; + CHAR16 *StringPtr; + MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvFilePath; + + if (NameString == NULL || BufferSize == 0) { + return EFI_INVALID_PARAMETER; + } - 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. + // + // Try to get the ModuleGuid and name string form the caached array. + // + if (mCachePairCount > 0) { + for (Count = mCachePairCount - 1; Count >= 0; Count--) { + if (Handle == mCacheHandleGuidTable[Count].Handle) { + CopyGuid (ModuleGuid, &mCacheHandleGuidTable[Count].ModuleGuid); + AsciiStrCpyS (NameString, EDKII_STRING_EVENT_RECORD_NAME_LENGTH, mCacheHandleGuidTable[Count].NameString); + return EFI_SUCCESS; + } + } + } + + Status = EFI_INVALID_PARAMETER; + LoadedImage = NULL; + ModuleGuidIsGet = FALSE; + + // + // Initialize GUID as zero value. + // + TempGuid = &gZeroGuid; + // + // Initialize it as "" string. + // + NameString[0] = 0; + if (Handle != NULL) { + // + // Try Handle as ImageHandle. + // + Status = gBS->HandleProtocol ( + Handle, + &gEfiLoadedImageProtocolGuid, + (VOID**) &LoadedImage + ); + + if (EFI_ERROR (Status)) { + // + // Try Handle as Controller Handle + // + Status = gBS->OpenProtocol ( + Handle, + &gEfiDriverBindingProtocolGuid, + (VOID **) &DriverBinding, + NULL, + NULL, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (!EFI_ERROR (Status)) { + // + // Get Image protocol from ImageHandle + // + Status = gBS->HandleProtocol ( + DriverBinding->ImageHandle, + &gEfiLoadedImageProtocolGuid, + (VOID**) &LoadedImage + ); + } + } + } + + if (!EFI_ERROR (Status) && 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 + // + ModuleGuidIsGet = TRUE; + FvFilePath = (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *) LoadedImage->FilePath; + TempGuid = &FvFilePath->FvFileName; + } + + // + // Method 1 Get Module Name from PDB string. + // + PdbFileName = PeCoffLoaderGetPdbPointer (LoadedImage->ImageBase); + if (PdbFileName != NULL && BufferSize > 0) { + StartIndex = 0; + for (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; + } + // + // Module Name is got. + // + goto Done; + } + } + + if (ModuleGuidIsGet) { + // + // Method 2 Try to get the image's FFS UI section by image GUID + // + StringPtr = NULL; + StringSize = 0; + Status = GetSectionFromAnyFv ( + TempGuid, + EFI_SECTION_USER_INTERFACE, + 0, + (VOID **) &StringPtr, + &StringSize + ); + + if (!EFI_ERROR (Status)) { + // + // Method 3. Get the name string from FFS UI section + // + for (Index = 0; Index < BufferSize - 1 && StringPtr[Index] != 0; Index++) { + NameString[Index] = (CHAR8) StringPtr[Index]; + } + NameString[Index] = 0; + FreePool (StringPtr); + } + } + +Done: + // + // Copy Module Guid + // + if (ModuleGuid != NULL) { + CopyGuid (ModuleGuid, TempGuid); + if (IsZeroGuid(TempGuid) && (Handle != NULL) && !ModuleGuidIsGet) { + // 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, EDKII_STRING_EVENT_RECORD_NAME_LENGTH, NameString); + mCachePairCount ++; + } + + return Status; +} + +/** + Add performance log to FPDT boot record table. + + @param IsStart TRUE if the performance log is start log. @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 Ticker 64-bit time stamp. @param Identifier 32-bit identifier. If the value is 0, the created record is same as the one created by StartGauge of PERFORMANCE_PROTOCOL. - @retval EFI_SUCCESS The data was read correctly from the device. + @retval EFI_SUCCESS Add FPDT boot record. @retval EFI_OUT_OF_RESOURCES There are not enough resources to record the measurement. + @retval EFI_UNSUPPORTED No matched FPDT record. **/ EFI_STATUS -EFIAPI -StartGaugeEx ( +InsertFpdtMeasurement ( + IN BOOLEAN IsStart, IN CONST VOID *Handle, OPTIONAL IN CONST CHAR8 *Token, OPTIONAL IN CONST CHAR8 *Module, OPTIONAL - IN UINT64 TimeStamp, + IN UINT64 Ticker, IN UINT32 Identifier ) { - GAUGE_DATA_ENTRY_EX *GaugeEntryExArray; - UINTN GaugeDataSize; - GAUGE_DATA_HEADER *NewGaugeData; - UINTN OldGaugeDataSize; - GAUGE_DATA_HEADER *OldGaugeData; - UINT32 Index; + EFI_GUID ModuleGuid; + CHAR8 ModuleName[EDKII_STRING_EVENT_RECORD_NAME_LENGTH]; + UINT8 FpdtRecord[MAX_RECORD_SIZE]; + EFI_STATUS Status; + FPDT_RECORD_PTR FpdtRecordPtr; + UINT64 TimeStamp; + BASIC_RECORD_INFO RecordInfo; + UINTN DestMax; + UINTN StrLength; + CONST CHAR8 *StringPtr; + BOOLEAN UseModuleName; + + StringPtr = NULL; + UseModuleName = FALSE; + ZeroMem (ModuleName, sizeof (ModuleName)); + ZeroMem (FpdtRecord, sizeof (FpdtRecord)); - AcquireSpinLock (&mSmmPerfLock); + // + // Get record info includes type, size, ProgressID. + // + Status = GetFpdtRecordInfo (IsStart, Handle, Token, Module, &RecordInfo, &UseModuleName); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // If PERF_START()/PERF_END() have specified the ProgressID,it has high priority. + // !!! Note: If the Pref 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 ((Identifier != 0) && (IsKnownID (Identifier)) && (!IsKnownTokens (Token))) { + return EFI_UNSUPPORTED; + } else if ((Identifier != 0) && (!IsKnownID (Identifier)) && (!IsKnownTokens (Token))) { + if (IsStart && ((Identifier & 0x000F) != 0)) { + Identifier &= 0xFFF0; + } else if ((!IsStart) && ((Identifier & 0x000F) == 0)) { + Identifier += 1; + } + RecordInfo.ProgressID = (UINT16)Identifier; + } - Index = mGaugeData->NumberOfEntries; - if (Index >= mMaxGaugeRecords) { + if (mFpdtDataIsReported) { // - // Try to enlarge the scale of gauge array. + // Cached FPDT data has been reported. Now, report FPDT record one by one. // - OldGaugeData = mGaugeData; - OldGaugeDataSize = sizeof (GAUGE_DATA_HEADER) + sizeof (GAUGE_DATA_ENTRY_EX) * mMaxGaugeRecords; - - GaugeDataSize = sizeof (GAUGE_DATA_HEADER) + sizeof (GAUGE_DATA_ENTRY_EX) * mMaxGaugeRecords * 2; - - NewGaugeData = AllocateZeroPool (GaugeDataSize); - if (NewGaugeData == NULL) { - ReleaseSpinLock (&mSmmPerfLock); - return EFI_OUT_OF_RESOURCES; + FpdtRecordPtr.RecordHeader = (EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER *)FpdtRecord; + } else { + if (mStartFpdtDataReport) { + return EFI_UNSUPPORTED; + } + // + // Check if pre-allocated buffer is full + // + if (mPerformanceLength + RecordInfo.RecordSize > mMaxPerformanceLength) { + mPerformancePointer = ReallocatePool ( + mPerformanceLength, + mPerformanceLength + RecordInfo.RecordSize + FIRMWARE_RECORD_BUFFER, + mPerformancePointer + ); + + if (mPerformancePointer == NULL) { + return EFI_OUT_OF_RESOURCES; + } + mMaxPerformanceLength = mPerformanceLength + RecordInfo.RecordSize + FIRMWARE_RECORD_BUFFER; } - - mGaugeData = NewGaugeData; - mMaxGaugeRecords *= 2; - // - // Initialize new data array and migrate old data one. + // Covert buffer to FPDT Ptr Union type. // - mGaugeData = CopyMem (mGaugeData, OldGaugeData, OldGaugeDataSize); + FpdtRecordPtr.RecordHeader = (EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER *)(mPerformancePointer + mPerformanceLength); + } + FpdtRecordPtr.RecordHeader->Length = 0; - FreePool (OldGaugeData); + // + // Get the TimeStamp. + // + if (Ticker == 0) { + Ticker = GetPerformanceCounter (); + TimeStamp = GetTimeInNanoSecond (Ticker); + } else if (Ticker == 1) { + TimeStamp = 0; + } else { + TimeStamp = GetTimeInNanoSecond (Ticker); } - GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1); - GaugeEntryExArray[Index].Handle = (EFI_PHYSICAL_ADDRESS) (UINTN) Handle; + // + // Get the ModuleName and ModuleGuid form the handle. + // + GetModuleInfoFromHandle ((EFI_HANDLE *)Handle, ModuleName, sizeof (ModuleName), &ModuleGuid); - if (Token != NULL) { - AsciiStrnCpyS (GaugeEntryExArray[Index].Token, SMM_PERFORMANCE_STRING_SIZE, Token, SMM_PERFORMANCE_STRING_LENGTH); + // + // Fill in the record information. + // + switch (RecordInfo.Type) { + case GUID_EVENT_TYPE: + FpdtRecordPtr.GuidEvent->Header.Type = GUID_EVENT_TYPE; + FpdtRecordPtr.GuidEvent->Header.Length = RecordInfo.RecordSize; + FpdtRecordPtr.GuidEvent->Header.Revision = RECORD_REVISION_1; + FpdtRecordPtr.GuidEvent->ProgressID = RecordInfo.ProgressID; + FpdtRecordPtr.GuidEvent->Timestamp = TimeStamp; + CopyMem (&FpdtRecordPtr.GuidEvent->Guid, &ModuleGuid, sizeof (FpdtRecordPtr.GuidEvent->Guid)); + break; + + case DYNAMIC_STRING_EVENT_TYPE: + FpdtRecordPtr.DynamicStringEvent->Header.Type = DYNAMIC_STRING_EVENT_TYPE; + FpdtRecordPtr.DynamicStringEvent->Header.Length = RecordInfo.RecordSize; + FpdtRecordPtr.DynamicStringEvent->Header.Revision = RECORD_REVISION_1; + FpdtRecordPtr.DynamicStringEvent->ProgressID = RecordInfo.ProgressID; + FpdtRecordPtr.DynamicStringEvent->Timestamp = TimeStamp; + CopyMem (&FpdtRecordPtr.DynamicStringEvent->Guid, &ModuleGuid, sizeof (FpdtRecordPtr.DynamicStringEvent->Guid)); + + if (UseModuleName) { + StringPtr = ModuleName; + } else if (Token != NULL) { + StringPtr = Token; + } else if (Module != NULL) { + StringPtr = Module; + } else if (ModuleName != NULL) { + StringPtr = ModuleName; + } + if (StringPtr != NULL && AsciiStrLen (StringPtr) != 0) { + StrLength = AsciiStrLen (StringPtr); + DestMax = (RecordInfo.RecordSize - sizeof (DYNAMIC_STRING_EVENT_RECORD)) / sizeof (CHAR8); + if (StrLength >= DestMax) { + StrLength = DestMax -1; + } + AsciiStrnCpyS (FpdtRecordPtr.DynamicStringEvent->String, DestMax, StringPtr, StrLength); + } + break; + + case GUID_QWORD_EVENT_TYPE: + FpdtRecordPtr.GuidQwordEvent->Header.Type = GUID_QWORD_EVENT_TYPE; + FpdtRecordPtr.GuidQwordEvent->Header.Length = RecordInfo.RecordSize; + FpdtRecordPtr.GuidQwordEvent->Header.Revision = RECORD_REVISION_1; + FpdtRecordPtr.GuidQwordEvent->ProgressID = RecordInfo.ProgressID; + FpdtRecordPtr.GuidQwordEvent->Timestamp = TimeStamp; + CopyMem (&FpdtRecordPtr.GuidQwordEvent->Guid, &ModuleGuid, sizeof (FpdtRecordPtr.GuidQwordEvent->Guid)); + break; + + default: + // + // Record is not supported in current SMM phase, return EFI_UNSUPPORTED + // + return EFI_UNSUPPORTED; } - if (Module != NULL) { - AsciiStrnCpyS (GaugeEntryExArray[Index].Module, SMM_PERFORMANCE_STRING_SIZE, Module, SMM_PERFORMANCE_STRING_LENGTH); + // + // Report record one by one after records have been reported together. + // + if (mFpdtDataIsReported) { + REPORT_STATUS_CODE_EX ( + EFI_PROGRESS_CODE, + EFI_SOFTWARE_SMM_DRIVER, + 0, + NULL, + &gEfiFirmwarePerformanceGuid, + FpdtRecordPtr.RecordHeader, + FpdtRecordPtr.RecordHeader->Length + ); + } else { + // + // Update the cached FPDT record buffer. + // + mPerformanceLength += FpdtRecordPtr.RecordHeader->Length; } - GaugeEntryExArray[Index].EndTimeStamp = 0; - GaugeEntryExArray[Index].Identifier = Identifier; + return EFI_SUCCESS; +} - if (TimeStamp == 0) { - TimeStamp = GetPerformanceCounter (); - } - GaugeEntryExArray[Index].StartTimeStamp = TimeStamp; +/** + Adds a record at the end of the performance measurement log + that records the start time of a performance measurement. - mGaugeData->NumberOfEntries++; + 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. - ReleaseSpinLock (&mSmmPerfLock); + @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 StartGauge of PERFORMANCE_PROTOCOL. - return EFI_SUCCESS; + @retval EFI_SUCCESS The data was read correctly from the device. + @retval EFI_OUT_OF_RESOURCES There are not enough resources to record the measurement. + +**/ +EFI_STATUS +EFIAPI +StartGaugeEx ( + IN CONST VOID *Handle, OPTIONAL + IN CONST CHAR8 *Token, OPTIONAL + IN CONST CHAR8 *Module, OPTIONAL + IN UINT64 TimeStamp, + IN UINT32 Identifier + ) +{ + EFI_STATUS Status; + + AcquireSpinLock (&mSmmFpdtLock); + + Status = InsertFpdtMeasurement (TRUE, Handle, Token, Module, TimeStamp, Identifier); + + ReleaseSpinLock (&mSmmFpdtLock); + + return Status; } /** 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. + 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 EFI_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. @@ -259,37 +723,28 @@ EndGaugeEx ( IN CONST CHAR8 *Module, OPTIONAL IN UINT64 TimeStamp, IN UINT32 Identifier ) { - GAUGE_DATA_ENTRY_EX *GaugeEntryExArray; - UINT32 Index; + EFI_STATUS Status; - AcquireSpinLock (&mSmmPerfLock); + AcquireSpinLock (&mSmmFpdtLock); - if (TimeStamp == 0) { - TimeStamp = GetPerformanceCounter (); - } - - Index = SmmSearchForGaugeEntry (Handle, Token, Module, Identifier); - if (Index >= mGaugeData->NumberOfEntries) { - ReleaseSpinLock (&mSmmPerfLock); - return EFI_NOT_FOUND; - } - GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1); - GaugeEntryExArray[Index].EndTimeStamp = TimeStamp; + Status = InsertFpdtMeasurement (FALSE, Handle, Token, Module, TimeStamp, Identifier); - ReleaseSpinLock (&mSmmPerfLock); + ReleaseSpinLock (&mSmmFpdtLock); - return EFI_SUCCESS; + return Status; } /** Retrieves a previously logged performance measurement. It can also retrieve the log created by StartGauge and EndGauge of PERFORMANCE_PROTOCOL, and then assign the Identifier with 0. + !!! Not Support!!! + Retrieves the performance log entry from the performance log specified by LogEntryKey. If it stands for a valid entry, then EFI_SUCCESS is returned and GaugeDataEntryEx stores the pointer to that entry. @param LogEntryKey The key for the previous performance measurement log entry. @@ -308,29 +763,11 @@ EFIAPI GetGaugeEx ( IN UINTN LogEntryKey, OUT GAUGE_DATA_ENTRY_EX **GaugeDataEntryEx ) { - UINTN NumberOfEntries; - GAUGE_DATA_ENTRY_EX *GaugeEntryExArray; - - NumberOfEntries = (UINTN) (mGaugeData->NumberOfEntries); - if (LogEntryKey > NumberOfEntries) { - return EFI_INVALID_PARAMETER; - } - if (LogEntryKey == NumberOfEntries) { - return EFI_NOT_FOUND; - } - - GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1); - - if (GaugeDataEntryEx == NULL) { - return EFI_INVALID_PARAMETER; - } - *GaugeDataEntryEx = &GaugeEntryExArray[LogEntryKey]; - - return EFI_SUCCESS; + return EFI_UNSUPPORTED; } /** Adds a record at the end of the performance measurement log that records the start time of a performance measurement. @@ -405,10 +842,12 @@ EndGauge ( /** Retrieves a previously logged performance measurement. It can also retrieve the log created by StartGaugeEx and EndGaugeEx of PERFORMANCE_EX_PROTOCOL, and then eliminate the Identifier. + !!! Not Support!!! + Retrieves the performance log entry from the performance log specified by LogEntryKey. If it stands for a valid entry, then EFI_SUCCESS is returned and GaugeDataEntry stores the pointer to that entry. @param LogEntryKey The key for the previous performance measurement log entry. @@ -427,256 +866,90 @@ EFIAPI GetGauge ( IN UINTN LogEntryKey, OUT GAUGE_DATA_ENTRY **GaugeDataEntry ) { - EFI_STATUS Status; - GAUGE_DATA_ENTRY_EX *GaugeEntryEx; + return EFI_UNSUPPORTED; +} - GaugeEntryEx = NULL; - Status = GetGaugeEx (LogEntryKey, &GaugeEntryEx); - if (EFI_ERROR (Status)) { - return Status; - } +/** + SMM END_OF_DXE protocol notification event handler. - if (GaugeDataEntry == NULL) { - return EFI_INVALID_PARAMETER; - } + @param Protocol Points to the protocol's unique identifier + @param Interface Points to the interface instance + @param Handle The handle on which the interface was installed - *GaugeDataEntry = (GAUGE_DATA_ENTRY *) GaugeEntryEx; + @retval EFI_SUCCESS SmmEndOfDxeCallback runs successfully - return EFI_SUCCESS; -} - -/** - Communication service SMI Handler entry. - - This SMI handler provides services for the performance wrapper driver. - - 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-SMM environment into an SMM 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 -SmmPerformanceHandlerEx ( - IN EFI_HANDLE DispatchHandle, - IN CONST VOID *RegisterContext, - IN OUT VOID *CommBuffer, - IN OUT UINTN *CommBufferSize +SmmReportFpdtRecordData ( + IN CONST EFI_GUID *Protocol, + IN VOID *Interface, + IN EFI_HANDLE Handle ) { - EFI_STATUS Status; - SMM_PERF_COMMUNICATE_EX *SmmPerfCommData; - GAUGE_DATA_ENTRY_EX *GaugeEntryExArray; - UINT64 DataSize; - UINTN Index; - GAUGE_DATA_ENTRY_EX *GaugeDataEx; - UINTN NumberOfEntries; - UINTN LogEntryKey; - UINTN TempCommBufferSize; + UINT8 *PerfBuffer; + UINTN MaxUint16; - GaugeEntryExArray = NULL; + PerfBuffer = mPerformancePointer; + MaxUint16 = 0xFFFF; - // - // If input is invalid, stop processing this SMI - // - if (CommBuffer == NULL || CommBufferSize == NULL) { + if ( mPerformanceLength== 0 || mPerformancePointer == NULL) { return EFI_SUCCESS; } - TempCommBufferSize = *CommBufferSize; + mStartFpdtDataReport = TRUE; - if(TempCommBufferSize < sizeof (SMM_PERF_COMMUNICATE_EX)) { - return EFI_SUCCESS; - } - - if (!SmmIsBufferOutsideSmmValid ((UINTN)CommBuffer, TempCommBufferSize)) { - DEBUG ((EFI_D_ERROR, "SmmPerformanceHandlerEx: SMM communcation data buffer in SMRAM or overflow!\n")); - return EFI_SUCCESS; - } - - SmmPerfCommData = (SMM_PERF_COMMUNICATE_EX *)CommBuffer; - - switch (SmmPerfCommData->Function) { - case SMM_PERF_FUNCTION_GET_GAUGE_ENTRY_NUMBER : - SmmPerfCommData->NumberOfEntries = mGaugeData->NumberOfEntries; - Status = EFI_SUCCESS; - break; - - case SMM_PERF_FUNCTION_GET_GAUGE_DATA : - GaugeDataEx = SmmPerfCommData->GaugeDataEx; - NumberOfEntries = SmmPerfCommData->NumberOfEntries; - LogEntryKey = SmmPerfCommData->LogEntryKey; - if (GaugeDataEx == NULL || NumberOfEntries == 0 || LogEntryKey > mGaugeData->NumberOfEntries || - NumberOfEntries > mGaugeData->NumberOfEntries || LogEntryKey > (mGaugeData->NumberOfEntries - NumberOfEntries)) { - Status = EFI_INVALID_PARAMETER; - break; - } - - // - // Sanity check - // - DataSize = MultU64x32 (NumberOfEntries, sizeof(GAUGE_DATA_ENTRY_EX)); - if (!SmmIsBufferOutsideSmmValid ((UINTN) GaugeDataEx, DataSize)) { - DEBUG ((EFI_D_ERROR, "SmmPerformanceHandlerEx: SMM Performance Data buffer in SMRAM or overflow!\n")); - Status = EFI_ACCESS_DENIED; - break; - } - - GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1); - - for (Index = 0; Index < NumberOfEntries; Index++) { - CopyMem ( - (UINT8 *) &GaugeDataEx[Index], - (UINT8 *) &GaugeEntryExArray[LogEntryKey++], - sizeof (GAUGE_DATA_ENTRY_EX) - ); - } - Status = EFI_SUCCESS; - break; - - default: - Status = EFI_UNSUPPORTED; + while (mPerformanceLength > MaxUint16) { + // + // Report extension data size is UINT16. So, the size of report data can't exceed 0xFFFF. + // + REPORT_STATUS_CODE_EX ( + EFI_PROGRESS_CODE, + EFI_SOFTWARE_SMM_DRIVER, + 0, + NULL, + &gEfiFirmwarePerformanceGuid, + PerfBuffer, + MaxUint16 + ); + mPerformanceLength = mPerformanceLength - MaxUint16; + PerfBuffer = PerfBuffer + MaxUint16; } - - SmmPerfCommData->ReturnStatus = Status; - - return EFI_SUCCESS; -} - -/** - Communication service SMI Handler entry. - - This SMI handler provides services for the performance wrapper driver. - - 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-SMM environment into an SMM 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 -SmmPerformanceHandler ( - IN EFI_HANDLE DispatchHandle, - IN CONST VOID *RegisterContext, - IN OUT VOID *CommBuffer, - IN OUT UINTN *CommBufferSize - ) -{ - EFI_STATUS Status; - SMM_PERF_COMMUNICATE *SmmPerfCommData; - GAUGE_DATA_ENTRY_EX *GaugeEntryExArray; - UINT64 DataSize; - UINTN Index; - GAUGE_DATA_ENTRY *GaugeData; - UINTN NumberOfEntries; - UINTN LogEntryKey; - UINTN TempCommBufferSize; - - GaugeEntryExArray = NULL; + REPORT_STATUS_CODE_EX ( + EFI_PROGRESS_CODE, + EFI_SOFTWARE_SMM_DRIVER, + 0, + NULL, + &gEfiFirmwarePerformanceGuid, + PerfBuffer, + mPerformanceLength + ); // - // If input is invalid, stop processing this SMI + // Free Cached FPDT record Buffer // - if (CommBuffer == NULL || CommBufferSize == NULL) { - return EFI_SUCCESS; - } - - TempCommBufferSize = *CommBufferSize; - - if(TempCommBufferSize < sizeof (SMM_PERF_COMMUNICATE)) { - return EFI_SUCCESS; - } - - if (!SmmIsBufferOutsideSmmValid ((UINTN)CommBuffer, TempCommBufferSize)) { - DEBUG ((EFI_D_ERROR, "SmmPerformanceHandler: SMM communcation data buffer in SMRAM or overflow!\n")); - return EFI_SUCCESS; - } - - SmmPerfCommData = (SMM_PERF_COMMUNICATE *)CommBuffer; - - switch (SmmPerfCommData->Function) { - case SMM_PERF_FUNCTION_GET_GAUGE_ENTRY_NUMBER : - SmmPerfCommData->NumberOfEntries = mGaugeData->NumberOfEntries; - Status = EFI_SUCCESS; - break; - - case SMM_PERF_FUNCTION_GET_GAUGE_DATA : - GaugeData = SmmPerfCommData->GaugeData; - NumberOfEntries = SmmPerfCommData->NumberOfEntries; - LogEntryKey = SmmPerfCommData->LogEntryKey; - if (GaugeData == NULL || NumberOfEntries == 0 || LogEntryKey > mGaugeData->NumberOfEntries || - NumberOfEntries > mGaugeData->NumberOfEntries || LogEntryKey > (mGaugeData->NumberOfEntries - NumberOfEntries)) { - Status = EFI_INVALID_PARAMETER; - break; - } - - // - // Sanity check - // - DataSize = MultU64x32 (NumberOfEntries, sizeof(GAUGE_DATA_ENTRY)); - if (!SmmIsBufferOutsideSmmValid ((UINTN) GaugeData, DataSize)) { - DEBUG ((EFI_D_ERROR, "SmmPerformanceHandler: SMM Performance Data buffer in SMRAM or overflow!\n")); - Status = EFI_ACCESS_DENIED; - break; - } - - GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1); - - for (Index = 0; Index < NumberOfEntries; Index++) { - CopyMem ( - (UINT8 *) &GaugeData[Index], - (UINT8 *) &GaugeEntryExArray[LogEntryKey++], - sizeof (GAUGE_DATA_ENTRY) - ); - } - Status = EFI_SUCCESS; - break; - - default: - Status = EFI_UNSUPPORTED; - } - + FreePool (mPerformancePointer); + mPerformancePointer = NULL; + mPerformanceLength = 0; + mMaxPerformanceLength = 0; + // + // Set FPDT report state to TRUE. + // + mFpdtDataIsReported = TRUE; + mStartFpdtDataReport = FALSE; - SmmPerfCommData->ReturnStatus = Status; - return EFI_SUCCESS; } /** - SmmBase2 protocol notify callback function, when SMST and SMM memory service get initialized - this function is callbacked to initialize the Smm Performance Lib + SmmBase2 protocol notify callback function, when SMST and SMM memory service get initialized + this function is callbacked to initialize the Smm Performance Lib @param Event The event of notify protocol. @param Context Notify event context. **/ @@ -685,52 +958,44 @@ EFIAPI InitializeSmmCorePerformanceLib ( IN EFI_EVENT Event, IN VOID *Context ) { - EFI_STATUS Status; EFI_HANDLE Handle; + EFI_STATUS Status; + VOID *SmmReadyToBootRegistration; PERFORMANCE_PROPERTY *PerformanceProperty; // // Initialize spin lock // - InitializeSpinLock (&mSmmPerfLock); - - mMaxGaugeRecords = INIT_SMM_GAUGE_DATA_ENTRIES; + InitializeSpinLock (&mSmmFpdtLock); - mGaugeData = AllocateZeroPool (sizeof (GAUGE_DATA_HEADER) + (sizeof (GAUGE_DATA_ENTRY_EX) * mMaxGaugeRecords)); - ASSERT (mGaugeData != NULL); - // - // Install the protocol interfaces. + // Install the protocol interfaces for SMM performance library instance. // + Handle = NULL; Status = gSmst->SmmInstallProtocolInterface ( - &mHandle, + &Handle, &gSmmPerformanceProtocolGuid, EFI_NATIVE_INTERFACE, &mPerformanceInterface ); ASSERT_EFI_ERROR (Status); - Status = gSmst->SmmInstallProtocolInterface ( - &mHandle, + &Handle, &gSmmPerformanceExProtocolGuid, EFI_NATIVE_INTERFACE, &mPerformanceExInterface ); ASSERT_EFI_ERROR (Status); - /// - /// Register SMM Performance SMI handler - /// - Handle = NULL; - Status = gSmst->SmiHandlerRegister (SmmPerformanceHandler, &gSmmPerformanceProtocolGuid, &Handle); - ASSERT_EFI_ERROR (Status); - Status = gSmst->SmiHandlerRegister (SmmPerformanceHandlerEx, &gSmmPerformanceExProtocolGuid, &Handle); - ASSERT_EFI_ERROR (Status); - + Status = gSmst->SmmRegisterProtocolNotify ( + &gEdkiiSmmReadyToBootProtocolGuid, + SmmReportFpdtRecordData, + &SmmReadyToBootRegistration + ); Status = EfiGetSystemConfigurationTable (&gPerformanceProtocolGuid, (VOID **) &PerformanceProperty); if (EFI_ERROR (Status)) { // // Install configuration table for performance property. // @@ -744,11 +1009,11 @@ InitializeSmmCorePerformanceLib ( ASSERT_EFI_ERROR (Status); } } /** - The constructor function initializes the Performance Measurement Enable flag and + The constructor function initializes the Performance Measurement Enable flag and registers SmmBase2 protocol notify callback. It will ASSERT() if one of these operations fails and it will always return EFI_SUCCESS. @param ImageHandle The firmware allocated handle for the EFI image. @param SystemTable A pointer to the EFI System Table. @@ -765,12 +1030,11 @@ SmmCorePerformanceLibConstructor ( { EFI_STATUS Status; EFI_EVENT Event; VOID *Registration; - mPerformanceMeasurementEnabled = (BOOLEAN) ((PcdGet8(PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0); - if (!mPerformanceMeasurementEnabled) { + if (!PerformanceMeasurementEnabled ()) { // // Do not initialize performance infrastructure if not required. // return EFI_SUCCESS; } @@ -842,11 +1106,11 @@ StartPerformanceMeasurementEx ( /** 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. + 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. @@ -881,10 +1145,12 @@ EndPerformanceMeasurementEx ( /** 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 @@ -920,55 +1186,20 @@ EndPerformanceMeasurementEx ( **/ UINTN EFIAPI GetPerformanceMeasurementEx ( - IN UINTN LogEntryKey, + IN UINTN LogEntryKey, OUT CONST VOID **Handle, OUT CONST CHAR8 **Token, OUT CONST CHAR8 **Module, OUT UINT64 *StartTimeStamp, OUT UINT64 *EndTimeStamp, OUT UINT32 *Identifier ) { - EFI_STATUS Status; - GAUGE_DATA_ENTRY_EX *GaugeData; - - GaugeData = NULL; - - ASSERT (Handle != NULL); - ASSERT (Token != NULL); - ASSERT (Module != NULL); - ASSERT (StartTimeStamp != NULL); - ASSERT (EndTimeStamp != NULL); - ASSERT (Identifier != NULL); - - Status = GetGaugeEx (LogEntryKey++, &GaugeData); - - // - // Make sure that LogEntryKey is a valid log entry key, - // - ASSERT (Status != EFI_INVALID_PARAMETER); - - if (EFI_ERROR (Status)) { - // - // The LogEntryKey is the last entry (equals to the total entry number). - // - return 0; - } - - ASSERT (GaugeData != NULL); - - *Handle = (VOID *) (UINTN) GaugeData->Handle; - *Token = GaugeData->Token; - *Module = GaugeData->Module; - *StartTimeStamp = GaugeData->StartTimeStamp; - *EndTimeStamp = GaugeData->EndTimeStamp; - *Identifier = GaugeData->Identifier; - - return LogEntryKey; + return 0; } /** Adds a record at the end of the performance measurement log that records the start time of a performance measurement. @@ -999,11 +1230,11 @@ StartPerformanceMeasurement ( IN CONST CHAR8 *Token, OPTIONAL IN CONST CHAR8 *Module, OPTIONAL IN UINT64 TimeStamp ) { - return StartPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, 0); + return StartGaugeEx (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. @@ -1035,18 +1266,20 @@ EndPerformanceMeasurement ( IN CONST CHAR8 *Token, OPTIONAL IN CONST CHAR8 *Module, OPTIONAL IN UINT64 TimeStamp ) { - return EndPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, 0); + return EndGaugeEx (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 @@ -1088,12 +1321,11 @@ GetPerformanceMeasurement ( OUT CONST CHAR8 **Module, OUT UINT64 *StartTimeStamp, OUT UINT64 *EndTimeStamp ) { - UINT32 Identifier; - return GetPerformanceMeasurementEx (LogEntryKey, Handle, Token, Module, StartTimeStamp, EndTimeStamp, &Identifier); + return 0; } /** Returns TRUE if the performance measurement macros are enabled. @@ -1110,7 +1342,7 @@ BOOLEAN EFIAPI PerformanceMeasurementEnabled ( VOID ) { - return mPerformanceMeasurementEnabled; + return (BOOLEAN) ((PcdGet8(PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0); } diff --git a/MdeModulePkg/Library/SmmCorePerformanceLib/SmmCorePerformanceLib.inf b/MdeModulePkg/Library/SmmCorePerformanceLib/SmmCorePerformanceLib.inf index 1b2fbd3..1d1841c 100644 --- a/MdeModulePkg/Library/SmmCorePerformanceLib/SmmCorePerformanceLib.inf +++ b/MdeModulePkg/Library/SmmCorePerformanceLib/SmmCorePerformanceLib.inf @@ -6,11 +6,11 @@ # It initializes SMM phase performance logging by publishing the SMM Performance and PerformanceEx Protocol, # which is consumed by SmmPerformanceLib to logging performance data in SMM phase. # This library is mainly used by SMM Core to start performance logging to ensure that # SMM Performance and PerformanceEx Protocol are installed at the very beginning of SMM phase. # -# Copyright (c) 2011 - 2017, Intel Corporation. All rights reserved.<BR> +# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR> # This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License # which accompanies this distribution. The full text of the license may be found at # http://opensource.org/licenses/bsd-license.php # @@ -56,21 +56,27 @@ DebugLib SynchronizationLib SmmServicesTableLib SmmMemLib UefiLib + ReportStatusCodeLib + PeCoffGetEntryPointLib [Protocols] gEfiSmmBase2ProtocolGuid ## CONSUMES + gEdkiiSmmReadyToBootProtocolGuid ## NOTIFY [Guids] ## PRODUCES ## UNDEFINED # Install protocol ## CONSUMES ## UNDEFINED # SmiHandlerRegister gSmmPerformanceProtocolGuid ## PRODUCES ## UNDEFINED # Install protocol ## CONSUMES ## UNDEFINED # SmiHandlerRegister gSmmPerformanceExProtocolGuid ## PRODUCES ## SystemTable gPerformanceProtocolGuid + gEfiFirmwarePerformanceGuid ## SOMETIMES_PRODUCES ## UNDEFINED # StatusCode Data + gZeroGuid ## SOMETIMES_CONSUMES ## GUID [Pcd] - gEfiMdePkgTokenSpaceGuid.PcdPerformanceLibraryPropertyMask ## CONSUMES + gEfiMdePkgTokenSpaceGuid.PcdPerformanceLibraryPropertyMask ## CONSUMES + gEfiMdeModulePkgTokenSpaceGuid.PcdEdkiiFpdtStringRecordEnableOnly ## CONSUMES diff --git a/MdeModulePkg/Library/SmmCorePerformanceLib/SmmCorePerformanceLibInternal.h b/MdeModulePkg/Library/SmmCorePerformanceLib/SmmCorePerformanceLibInternal.h index 8eb3032..9d24d9f 100644 --- a/MdeModulePkg/Library/SmmCorePerformanceLib/SmmCorePerformanceLibInternal.h +++ b/MdeModulePkg/Library/SmmCorePerformanceLib/SmmCorePerformanceLibInternal.h @@ -2,11 +2,11 @@ Master header files for SmmCorePerformanceLib instance. This header file holds the prototypes of the SMM Performance and PerformanceEx Protocol published by this library instance at its constructor. -Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.<BR> +Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php @@ -18,10 +18,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #ifndef _SMM_CORE_PERFORMANCE_LIB_INTERNAL_H_ #define _SMM_CORE_PERFORMANCE_LIB_INTERNAL_H_ #include <Guid/Performance.h> +#include <Guid/ExtendedFirmwarePerformance.h> +#include <Guid/FirmwarePerformance.h> +#include <Guid/ZeroGuid.h> +#include <Guid/EventGroup.h> #include <Library/SmmServicesTableLib.h> #include <Library/DebugLib.h> #include <Library/PerformanceLib.h> #include <Library/BaseLib.h> @@ -31,12 +35,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include <Library/UefiLib.h> #include <Library/UefiBootServicesTableLib.h> #include <Library/MemoryAllocationLib.h> #include <Library/SynchronizationLib.h> #include <Library/SmmMemLib.h> +#include <Library/ReportStatusCodeLib.h> +#include <Library/DxeServicesLib.h> +#include <Library/PeCoffGetEntryPointLib.h> #include <Protocol/SmmBase2.h> +#include <Protocol/LoadedImage.h> +#include <Protocol/DevicePathToText.h> // // Interface declarations for SMM PerformanceEx Protocol. // /** -- 1.9.5.msysgit.1 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
