/** @file\r
- Library that provides services to measure module execution performance\r
+ Provides services to log the execution times and retrieve them later.\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
+Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
+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: PerformanceLib.h\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
**/\r
\r
#ifndef __PERFORMANCE_LIB_H__\r
#define __PERFORMANCE_LIB_H__\r
\r
-//\r
-// Performance library propery mask bits\r
-//\r
+///\r
+/// Performance library propery mask bits\r
+///\r
#define PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED 0x00000001\r
\r
/**\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
+ @retval RETURN_DEVICE_ERROR A device error reading the time stamp.\r
\r
**/\r
RETURN_STATUS\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
\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
+ @retval RETURN_DEVICE_ERROR A device error reading the time stamp.\r
\r
**/\r
RETURN_STATUS\r
\r
/**\r
Attempts to retrieve a performance measurement log entry from the performance measurement log. \r
- \r
+ It can also retrieve the log created by StartPerformanceMeasurementEx and EndPerformanceMeasurementEx,\r
+ and then eliminate the Identifier.\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
OUT UINT64 *EndTimeStamp\r
);\r
\r
+/**\r
+ Creates a record for the beginning of a performance measurement.\r
+\r
+ Creates a record that contains the Handle, Token, Module and Identifier.\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
+ @param Identifier 32-bit identifier. If the value is 0, the created record\r
+ is same as the one created by StartPerformanceMeasurement.\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
+ @retval RETURN_DEVICE_ERROR A device error reading the time stamp.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+StartPerformanceMeasurementEx (\r
+ IN CONST VOID *Handle, OPTIONAL\r
+ IN CONST CHAR8 *Token, OPTIONAL\r
+ IN CONST CHAR8 *Module, OPTIONAL\r
+ IN UINT64 TimeStamp,\r
+ IN UINT32 Identifier\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
+\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
+ @param Identifier 32-bit identifier. If the value is 0, the found record\r
+ is same as the one found by EndPerformanceMeasurement.\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
+ @retval RETURN_DEVICE_ERROR A device error reading the time stamp.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+EndPerformanceMeasurementEx (\r
+ IN CONST VOID *Handle, OPTIONAL\r
+ IN CONST CHAR8 *Token, OPTIONAL\r
+ IN CONST CHAR8 *Module, OPTIONAL\r
+ IN UINT64 TimeStamp,\r
+ IN UINT32 Identifier\r
+ );\r
+\r
+/**\r
+ Attempts to retrieve a performance measurement log entry from the performance measurement log.\r
+ It can also retrieve the log created by StartPerformanceMeasurement and EndPerformanceMeasurement,\r
+ and then assign the Identifier with 0.\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, EndTimeStamp and Identifier.\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
+ If Identifier 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 of 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
+ @param Identifier Pointer to the 32-bit identifier that was recorded.\r
+\r
+ @return The key for the next performance log entry (in general case).\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+GetPerformanceMeasurementEx (\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
+ OUT UINT32 *Identifier\r
+ );\r
+\r
/**\r
Returns TRUE if the performance measurement macros are enabled. \r
\r
} \\r
} while (FALSE)\r
\r
+/**\r
+ Macro that calls EndPerformanceMeasurementEx().\r
+\r
+ If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
+ then EndPerformanceMeasurementEx() is called.\r
+\r
+**/\r
+#define PERF_END_EX(Handle, Token, Module, TimeStamp, Identifier) \\r
+ do { \\r
+ if (PerformanceMeasurementEnabled ()) { \\r
+ EndPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, Identifier); \\r
+ } \\r
+ } while (FALSE)\r
+\r
+/**\r
+ Macro that calls StartPerformanceMeasurementEx().\r
+\r
+ If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
+ then StartPerformanceMeasurementEx() is called.\r
+\r
+**/\r
+#define PERF_START_EX(Handle, Token, Module, TimeStamp, Identifier) \\r
+ do { \\r
+ if (PerformanceMeasurementEnabled ()) { \\r
+ StartPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, Identifier); \\r
+ } \\r
+ } while (FALSE)\r
+\r
/**\r
Macro that marks the beginning of performance measurement source code.\r
\r
projects / mirror_edk2.git / blobdiff