PeiPerformanceLib.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
1N/A Performance library instance used in PEI phase. 1N/A This file implements all APIs in Performance Library class in MdePkg. It creates 1N/A performance logging GUIDed HOB on the first performance logging and then logs the 1N/A performance data to the GUIDed HOB. Due to the limitation of temporary RAM, the maximum 1N/A number of performance logging entry is specified by PcdMaxPeiPerformanceLogEntries. 1N/ACopyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR> 1N/AThis program and the accompanying materials 1N/Aare licensed and made available under the terms and conditions of the BSD License 1N/Awhich accompanies this distribution. The full text of the license may be found at 1N/ATHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 1N/AWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 1N/A Gets the GUID HOB for PEI performance. 1N/A This internal function searches for the GUID HOB for PEI performance. 1N/A If that GUID HOB is not found, it will build a new one. 1N/A It outputs the data area of that GUID HOB to record performance log. 1N/A @param PeiPerformanceLog Pointer to Pointer to PEI performance log header. 1N/A @param PeiPerformanceIdArray Pointer to Pointer to PEI performance identifier array. // PEI Performance HOB was found, then return the existing one. // PEI Performance HOB was not found, then build one. Searches in the log array with keyword Handle, Token, Module and Identifier. This internal function searches for the log entry in the log array. If there is an entry that exactly matches the given keywords and its end time stamp is zero, then the index of that log entry is returned; otherwise, the the number of log entries in the array is returned. @param PeiPerformanceLog Pointer to the data structure containing PEI @param PeiPerformanceIdArray Pointer to PEI performance identifier array. @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. @retval The index of log entry in the array. 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. Fills in the end time of a performance measurement. Looks up the record that matches Handle, Token, Module and Identifier. 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. If this function is called multiple times for the same record, then the end time is overwritten. @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. 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 of entry entry. @param Handle Pointer to environment specific context used to identify the component @param Token Pointer to a Null-terminated ASCII string that identifies the component @param Module Pointer to a Null-terminated ASCII string that identifies the module @param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement @param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement @param Identifier Pointer to the 32-bit identifier that was recorded. @return The key for the next performance log entry (in general case). // Make sure that LogEntryKey is a valid log entry key. 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. 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. 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 of entry entry. @param Handle Pointer to environment specific context used to identify the component @param Token Pointer to a Null-terminated ASCII string that identifies the component @param Module Pointer to a Null-terminated ASCII string that identifies the module @param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement @param EndTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement @return The key for the next performance log entry (in general case). 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.