--- /dev/null
+/*++\r
+\r
+Copyright (c) 2006, Intel Corporation \r
+All rights reserved. This program and the accompanying materials \r
+are licensed and made available under the terms and conditions of the BSD License \r
+which accompanies this distribution. The full text of the license may be found at \r
+http://opensource.org/licenses/bsd-license.php \r
+ \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+Module Name:\r
+\r
+ PeiPerformanceLib.c\r
+\r
+Abstract:\r
+\r
+ Performance Library\r
+\r
+--*/\r
+\r
+/**\r
+ Gets PEI the GUID HOB for PEI performance.\r
+\r
+ This internal function searches for the GUID HOB for PEI performance.\r
+ If that GUID HOB is not found, it will build a new one.\r
+ It returns the data area of that GUID HOB to record performance log. \r
+\r
+ @param Handle Pointer to environment specific context used\r
+ to identify the component being measured.\r
+ @param Token Pointer to a Null-terminated ASCII string\r
+ that identifies the component being measured.\r
+ @param Module Pointer to a Null-terminated ASCII string\r
+ that identifies the module being measured.\r
+\r
+ @retval The index of log entry in the array.\r
+\r
+**/\r
+PEI_PERFORMANCE_LOG_HEADER *\r
+InternalGetPerformanceHobLog (\r
+ VOID\r
+ )\r
+{\r
+ EFI_HOB_GUID_TYPE *GuidHob;\r
+ PEI_PERFORMANCE_LOG_HEADER *PeiPerformanceLog;\r
+ UINTN PeiPerformanceLogSize;\r
+\r
+ GuidHob = GetFirstGuidHob (&gPeiPerformanceHobGuid);\r
+ \r
+ if (GuidHob != NULL) {\r
+ //\r
+ // PEI Performance HOB was found, then return the existing one.\r
+ //\r
+ PeiPerformanceLog = GET_GUID_HOB_DATA (GuidHob);\r
+ } else {\r
+ //\r
+ // PEI Performance HOB was not found, then build one.\r
+ //\r
+ PeiPerformanceLogSize = sizeof (PEI_PERFORMANCE_LOG_HEADER) + \r
+ sizeof (PEI_PERFORMANCE_LOG_ENTRY) * MAX_PEI_PERFORMANCE_LOG_ENTRIES;\r
+ PeiPerformanceLog = BuildGuidHob (&gPeiPerformanceHobGuid, PeiPerformanceLogSize);\r
+ PeiPerformanceLog = ZeroMem (PeiPerformanceLog, PeiPerformanceLogSize);\r
+ }\r
+\r
+ return PeiPerformanceLog;\r
+}\r
+\r
+/**\r
+ Searches in the log array with keyword Handle, Token and Module.\r
+\r
+ This internal function searches for the log entry in the log array.\r
+ If there is an entry that exactly matches the given key word triple\r
+ and its end time stamp is zero, then the index of that log entry is returned;\r
+ otherwise, the the number of log entries in the array is returned. \r
+\r
+ @param Handle Pointer to environment specific context used\r
+ to identify the component being measured.\r
+ @param Token Pointer to a Null-terminated ASCII string\r
+ that identifies the component being measured.\r
+ @param Module Pointer to a Null-terminated ASCII string\r
+ that identifies the module being measured.\r
+\r
+ @retval The index of log entry in the array.\r
+\r
+**/\r
+UINT32\r
+InternalSearchForLogEntry (\r
+ IN PEI_PERFORMANCE_LOG_HEADER *PeiPerformanceLog,\r
+ IN CONST VOID *Handle, OPTIONAL\r
+ IN CONST CHAR8 *Token, OPTIONAL\r
+ IN CONST CHAR8 *Module OPTIONAL\r
+ )\r
+{\r
+ UINT32 Index;\r
+ UINT32 NumberOfEntries;\r
+ PEI_PERFORMANCE_LOG_ENTRY *LogEntryArray;\r
+ \r
+\r
+ if (Token == NULL) {\r
+ Token = "";\r
+ }\r
+ if (Module == NULL) {\r
+ Module = "";\r
+ }\r
+ NumberOfEntries = PeiPerformanceLog->NumberOfEntries;\r
+ LogEntryArray = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);\r
+ \r
+ for (Index = 0; Index < NumberOfEntries; Index++) {\r
+ if ((LogEntryArray[Index].Handle == (EFI_PHYSICAL_ADDRESS) (UINTN) Handle) &&\r
+ AsciiStrnCmp (LogEntryArray[Index].Token, Token, PEI_PERFORMANCE_STRING_LENGTH) == 0 &&\r
+ AsciiStrnCmp (LogEntryArray[Index].Module, Module, PEI_PERFORMANCE_STRING_LENGTH) == 0 &&\r
+ LogEntryArray[Index].EndTimeStamp == 0\r
+ ) {\r
+ break;\r
+ }\r
+ }\r
+ return Index;\r
+} \r
+\r
+/**\r
+ Creates a record for the beginning of a performance measurement. \r
+ \r
+ Creates a record that contains the Handle, Token, and Module.\r
+ If TimeStamp is not zero, then TimeStamp is added to the record as the start time.\r
+ If TimeStamp is zero, then this function reads the current time stamp\r
+ and adds that time stamp value to the record as the start time.\r
+\r
+ @param Handle Pointer to environment specific context used\r
+ to identify the component being measured.\r
+ @param Token Pointer to a Null-terminated ASCII string\r
+ that identifies the component being measured.\r
+ @param Module Pointer to a Null-terminated ASCII string\r
+ that identifies the module being measured.\r
+ @param TimeStamp 64-bit time stamp.\r
+\r
+ @retval RETURN_SUCCESS The start of the measurement was recorded.\r
+ @retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+StartPerformanceMeasurement (\r
+ IN CONST VOID *Handle, OPTIONAL\r
+ IN CONST CHAR8 *Token, OPTIONAL\r
+ IN CONST CHAR8 *Module, OPTIONAL\r
+ IN UINT64 TimeStamp\r
+ )\r
+{\r
+ PEI_PERFORMANCE_LOG_HEADER *PeiPerformanceLog;\r
+ PEI_PERFORMANCE_LOG_ENTRY *LogEntryArray;\r
+ UINT32 Index;\r
+\r
+ PeiPerformanceLog = InternalGetPerformanceHobLog ();\r
+ \r
+ if (PeiPerformanceLog->NumberOfEntries >= MAX_PEI_PERFORMANCE_LOG_ENTRIES) {\r
+ return RETURN_OUT_OF_RESOURCES;\r
+ }\r
+ Index = PeiPerformanceLog->NumberOfEntries++;\r
+ LogEntryArray = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1); \r
+ LogEntryArray[Index].Handle = (EFI_PHYSICAL_ADDRESS) (UINTN) Handle;\r
+\r
+ if (Token != NULL) {\r
+ AsciiStrnCpy (LogEntryArray[Index].Token, Token, PEI_PERFORMANCE_STRING_LENGTH);\r
+ }\r
+ if (Module != NULL) {\r
+ AsciiStrnCpy (LogEntryArray[Index].Module, Module, PEI_PERFORMANCE_STRING_LENGTH);\r
+ }\r
+\r
+ if (TimeStamp == 0) {\r
+ TimeStamp = GetPerformanceCounter ();\r
+ }\r
+ LogEntryArray[Index].StartTimeStamp = TimeStamp;\r
+\r
+ return RETURN_SUCCESS;\r
+}\r
+\r
+/**\r
+ Fills in the end time of a performance measurement. \r
+ \r
+ Looks up the record that matches Handle, Token, and Module.\r
+ If the record can not be found then return RETURN_NOT_FOUND.\r
+ If the record is found and TimeStamp is not zero,\r
+ then TimeStamp is added to the record as the end time.\r
+ If the record is found and TimeStamp is zero, then this function reads\r
+ the current time stamp and adds that time stamp value to the record as the end time.\r
+ If this function is called multiple times for the same record, then the end time is overwritten.\r
+\r
+ @param Handle Pointer to environment specific context used\r
+ to identify the component being measured.\r
+ @param Token Pointer to a Null-terminated ASCII string\r
+ that identifies the component being measured.\r
+ @param Module Pointer to a Null-terminated ASCII string\r
+ that identifies the module being measured.\r
+ @param TimeStamp 64-bit time stamp.\r
+\r
+ @retval RETURN_SUCCESS The end of the measurement was recorded.\r
+ @retval RETURN_NOT_FOUND The specified measurement record could not be found.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+EndPerformanceMeasurement (\r
+ IN CONST VOID *Handle, OPTIONAL\r
+ IN CONST CHAR8 *Token, OPTIONAL\r
+ IN CONST CHAR8 *Module, OPTIONAL\r
+ IN UINT64 TimeStamp\r
+ )\r
+{\r
+ PEI_PERFORMANCE_LOG_HEADER *PeiPerformanceLog;\r
+ PEI_PERFORMANCE_LOG_ENTRY *LogEntryArray;\r
+ UINT32 Index;\r
+\r
+ if (TimeStamp == 0) {\r
+ TimeStamp = GetPerformanceCounter ();\r
+ }\r
+ \r
+ PeiPerformanceLog = InternalGetPerformanceHobLog ();\r
+ Index = InternalSearchForLogEntry (PeiPerformanceLog, Handle, Token, Module);\r
+ if (Index >= PeiPerformanceLog->NumberOfEntries) {\r
+ return RETURN_NOT_FOUND;\r
+ }\r
+ LogEntryArray = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);\r
+ LogEntryArray[Index].EndTimeStamp = TimeStamp;\r
+\r
+ return RETURN_SUCCESS;\r
+}\r
+\r
+/**\r
+ Attempts to retrieve a performance measurement log entry from the performance measurement log. \r
+ \r
+ Attempts to retrieve the performance log entry specified by LogEntryKey. If LogEntryKey is\r
+ zero on entry, then an attempt is made to retrieve the first entry from the performance log,\r
+ and the key for the second entry in the log is returned. If the performance log is empty,\r
+ then no entry is retrieved and zero is returned. If LogEntryKey is not zero, then the performance\r
+ log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is\r
+ returned. If LogEntryKey is the key for the last entry in the log, then the last log entry is\r
+ retrieved and an implementation specific non-zero key value that specifies the end of the performance\r
+ log is returned. If LogEntryKey is equal this implementation specific non-zero key value, then no entry\r
+ is retrieved and zero is returned. In the cases where a performance log entry can be returned,\r
+ the log entry is returned in Handle, Token, Module, StartTimeStamp, and EndTimeStamp.\r
+ If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().\r
+ If Handle is NULL, then ASSERT().\r
+ If Token is NULL, then ASSERT().\r
+ If Module is NULL, then ASSERT().\r
+ If StartTimeStamp is NULL, then ASSERT().\r
+ If EndTimeStamp is NULL, then ASSERT().\r
+\r
+ @param LogEntryKey On entry, the key of the performance measurement log entry to retrieve.\r
+ 0, then the first performance measurement log entry is retrieved.\r
+ On exit, the key of the next performance lof entry entry.\r
+ @param Handle Pointer to environment specific context used to identify the component\r
+ being measured. \r
+ @param Token Pointer to a Null-terminated ASCII string that identifies the component\r
+ being measured. \r
+ @param Module Pointer to a Null-terminated ASCII string that identifies the module\r
+ being measured.\r
+ @param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement\r
+ was started.\r
+ @param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement\r
+ was ended.\r
+\r
+ @return The key for the next performance log entry (in general case).\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+GetPerformanceMeasurement (\r
+ IN UINTN LogEntryKey, \r
+ OUT CONST VOID **Handle,\r
+ OUT CONST CHAR8 **Token,\r
+ OUT CONST CHAR8 **Module,\r
+ OUT UINT64 *StartTimeStamp,\r
+ OUT UINT64 *EndTimeStamp\r
+ )\r
+{\r
+ PEI_PERFORMANCE_LOG_HEADER *PeiPerformanceLog;\r
+ PEI_PERFORMANCE_LOG_ENTRY *CurrentLogEntry;\r
+ PEI_PERFORMANCE_LOG_ENTRY *LogEntryArray;\r
+ UINTN NumberOfEntries;\r
+\r
+ ASSERT (Handle != NULL);\r
+ ASSERT (Token != NULL);\r
+ ASSERT (Module != NULL);\r
+ ASSERT (StartTimeStamp != NULL);\r
+ ASSERT (EndTimeStamp != NULL);\r
+ \r
+ PeiPerformanceLog = InternalGetPerformanceHobLog ();\r
+ \r
+ NumberOfEntries = (UINTN) (PeiPerformanceLog->NumberOfEntries);\r
+ LogEntryArray = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);\r
+ //\r
+ // Make sure that LogEntryKey is a valid log entry key.\r
+ //\r
+ ASSERT (LogEntryKey <= NumberOfEntries);\r
+ \r
+ if (LogEntryKey == NumberOfEntries) {\r
+ return 0;\r
+ }\r
+\r
+ CurrentLogEntry = &(LogEntryArray[LogEntryKey++]);\r
+\r
+ *Handle = (VOID *) (UINTN) (CurrentLogEntry->Handle);\r
+ *Token = CurrentLogEntry->Token;\r
+ *Module = CurrentLogEntry->Module;\r
+ *StartTimeStamp = CurrentLogEntry->StartTimeStamp;\r
+ *EndTimeStamp = CurrentLogEntry->EndTimeStamp;\r
+\r
+ return LogEntryKey; \r
+}\r
+\r
+/**\r
+ Returns TRUE if the performance measurement macros are enabled. \r
+ \r
+ This function returns TRUE if the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r
+ PcdPerformanceLibraryPropertyMask is set. Otherwise FALSE is returned.\r
+\r
+ @retval TRUE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r
+ PcdPerformanceLibraryPropertyMask is set.\r
+ @retval FALSE The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r
+ PcdPerformanceLibraryPropertyMask is clear.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+PerformanceMeasurementEnabled (\r
+ VOID\r
+ )\r
+{\r
+ return ((PcdGet8(PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0);\r
+}\r
projects / mirror_edk2.git / blobdiff