Provides services to log the execution times and retrieve them later.\r
\r
Copyright (c) 2006 - 2018, 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
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
//\r
// Public Progress Identifiers for Event Records.\r
//\r
-#define PERF_EVENT_ID 0x00\r
-\r
-#define MODULE_START_ID 0x01\r
-#define MODULE_END_ID 0x02\r
-#define MODULE_LOADIMAGE_START_ID 0x03\r
-#define MODULE_LOADIMAGE_END_ID 0x04\r
-#define MODULE_DB_START_ID 0x05\r
-#define MODULE_DB_END_ID 0x06\r
-#define MODULE_DB_SUPPORT_START_ID 0x07\r
-#define MODULE_DB_SUPPORT_END_ID 0x08\r
-#define MODULE_DB_STOP_START_ID 0x09\r
-#define MODULE_DB_STOP_END_ID 0x0A\r
-\r
-#define PERF_EVENTSIGNAL_START_ID 0x10\r
-#define PERF_EVENTSIGNAL_END_ID 0x11\r
-#define PERF_CALLBACK_START_ID 0x20\r
-#define PERF_CALLBACK_END_ID 0x21\r
-#define PERF_FUNCTION_START_ID 0x30\r
-#define PERF_FUNCTION_END_ID 0x31\r
-#define PERF_INMODULE_START_ID 0x40\r
-#define PERF_INMODULE_END_ID 0x41\r
-#define PERF_CROSSMODULE_START_ID 0x50\r
-#define PERF_CROSSMODULE_END_ID 0x51\r
+#define PERF_EVENT_ID 0x00\r
+\r
+#define MODULE_START_ID 0x01\r
+#define MODULE_END_ID 0x02\r
+#define MODULE_LOADIMAGE_START_ID 0x03\r
+#define MODULE_LOADIMAGE_END_ID 0x04\r
+#define MODULE_DB_START_ID 0x05\r
+#define MODULE_DB_END_ID 0x06\r
+#define MODULE_DB_SUPPORT_START_ID 0x07\r
+#define MODULE_DB_SUPPORT_END_ID 0x08\r
+#define MODULE_DB_STOP_START_ID 0x09\r
+#define MODULE_DB_STOP_END_ID 0x0A\r
+\r
+#define PERF_EVENTSIGNAL_START_ID 0x10\r
+#define PERF_EVENTSIGNAL_END_ID 0x11\r
+#define PERF_CALLBACK_START_ID 0x20\r
+#define PERF_CALLBACK_END_ID 0x21\r
+#define PERF_FUNCTION_START_ID 0x30\r
+#define PERF_FUNCTION_END_ID 0x31\r
+#define PERF_INMODULE_START_ID 0x40\r
+#define PERF_INMODULE_END_ID 0x41\r
+#define PERF_CROSSMODULE_START_ID 0x50\r
+#define PERF_CROSSMODULE_END_ID 0x51\r
\r
//\r
// Declare bits for PcdPerformanceLibraryPropertyMask and\r
// also used as the Type parameter of LogPerformanceMeasurementEnabled().\r
//\r
-#define PERF_CORE_START_IMAGE 0x0002\r
-#define PERF_CORE_LOAD_IMAGE 0x0004\r
-#define PERF_CORE_DB_SUPPORT 0x0008\r
-#define PERF_CORE_DB_START 0x0010\r
-#define PERF_CORE_DB_STOP 0x0020\r
+#define PERF_CORE_START_IMAGE 0x0002\r
+#define PERF_CORE_LOAD_IMAGE 0x0004\r
+#define PERF_CORE_DB_SUPPORT 0x0008\r
+#define PERF_CORE_DB_START 0x0010\r
+#define PERF_CORE_DB_STOP 0x0020\r
\r
-#define PERF_GENERAL_TYPE 0x0040\r
+#define PERF_GENERAL_TYPE 0x0040\r
\r
/**\r
- Creates a record for the beginning of a performance measurement. \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
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 CONST VOID *Handle OPTIONAL,\r
+ IN CONST CHAR8 *Token OPTIONAL,\r
+ IN CONST CHAR8 *Module OPTIONAL,\r
IN UINT64 TimeStamp\r
);\r
\r
/**\r
- Fills in the end time of a performance measurement. \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
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 CONST VOID *Handle OPTIONAL,\r
+ IN CONST CHAR8 *Token OPTIONAL,\r
+ IN CONST CHAR8 *Module OPTIONAL,\r
IN UINT64 TimeStamp\r
);\r
\r
/**\r
- Attempts to retrieve a performance measurement log entry from the performance measurement log. \r
+ Attempts to retrieve a performance measurement log entry from the performance measurement log.\r
It can also retrieve the log created by StartPerformanceMeasurementEx and EndPerformanceMeasurementEx,\r
and then eliminate the Identifier.\r
\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
+ being measured.\r
@param Token Pointer to a Null-terminated ASCII string that identifies the component\r
- being measured. \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
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
+ 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
/**\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 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
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 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
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
+ 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
+ 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
VOID\r
);\r
\r
-\r
/**\r
Check whether the specified performance measurement can be logged.\r
\r
BOOLEAN\r
EFIAPI\r
LogPerformanceMeasurementEnabled (\r
- IN CONST UINTN Type\r
+ IN CONST UINTN Type\r
);\r
\r
/**\r
RETURN_STATUS\r
EFIAPI\r
LogPerformanceMeasurement (\r
- IN CONST VOID *CallerIdentifier, OPTIONAL\r
- IN CONST VOID *Guid, OPTIONAL\r
- IN CONST CHAR8 *String, OPTIONAL\r
- IN UINT64 Address, OPTIONAL\r
+ IN CONST VOID *CallerIdentifier OPTIONAL,\r
+ IN CONST VOID *Guid OPTIONAL,\r
+ IN CONST CHAR8 *String OPTIONAL,\r
+ IN UINT64 Address OPTIONAL,\r
IN UINT32 Identifier\r
);\r
\r
Begin Macro to measure the performance of StartImage in core.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT1(dsiable PERF_CORE_START_IMAGE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT1 (disable PERF_CORE_START_IMAGE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
End Macro to measure the performance of StartImage in core.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT1 (dsiable PERF_CORE_START_IMAGE)of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT1 (disable PERF_CORE_START_IMAGE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
Begin Macro to measure the performance of LoadImage in core.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT2 (dsiable PERF_CORE_LOAD_IAMGE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT2 (disable PERF_CORE_LOAD_IMAGE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
End Macro to measure the performance of LoadImage in core.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT2 (dsiable PERF_CORE_LOAD_IAMGE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT2 (disable PERF_CORE_LOAD_IMAGE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
Start Macro to measure the performance of DriverBinding Support in core.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT3 (dsiable PERF_CORE_DB_SUPPORT) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT3 (disable PERF_CORE_DB_SUPPORT) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
End Macro to measure the performance of DriverBinding Support in core.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT3 (dsiable PERF_CORE_DB_SUPPORT) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT3 (disable PERF_CORE_DB_SUPPORT) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
Begin Macro to measure the performance of DriverBinding Start in core.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT4 (dsiable PERF_CORE_DB_START) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT4 (disable PERF_CORE_DB_START) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
End Macro to measure the performance of DriverBinding Start in core.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT4 (dsiable PERF_CORE_DB_START) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT4 (disable PERF_CORE_DB_START) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
Start Macro to measure the performance of DriverBinding Stop in core.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT5 (dsiable PERF_CORE_DB_STOP) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT5 (disable PERF_CORE_DB_STOP) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
End Macro to measure the performance of DriverBinding Stop in core.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT5 (dsiable PERF_CORE_DB_STOP) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT5 (disable PERF_CORE_DB_STOP) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
It can be used to log a meaningful thing which happens at a time point.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
} while (FALSE)\r
\r
/**\r
- Begin Macro to measure the perofrmance of evnent signal behavior in any module.\r
+ Begin Macro to measure the performance of evnent signal behavior in any module.\r
The event guid will be passed with this macro.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
} while (FALSE)\r
\r
/**\r
- End Macro to measure the perofrmance of evnent signal behavior in any module.\r
+ End Macro to measure the performance of evnent signal behavior in any module.\r
The event guid will be passed with this macro.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
} while (FALSE)\r
\r
/**\r
- Begin Macro to measure the perofrmance of a callback function in any module.\r
+ Begin Macro to measure the performance of a callback function in any module.\r
The event guid which trigger the callback function will be passed with this macro.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
} while (FALSE)\r
\r
/**\r
- End Macro to measure the perofrmance of a callback function in any module.\r
+ End Macro to measure the performance of a callback function in any module.\r
The event guid which trigger the callback function will be passed with this macro.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
} while (FALSE)\r
\r
/**\r
- Begin Macro to measure the perofrmance of a general function in any module.\r
+ Begin Macro to measure the performance of a general function in any module.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
} while (FALSE)\r
\r
/**\r
- End Macro to measure the perofrmance of a general function in any module.\r
+ End Macro to measure the performance of a general function in any module.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
} while (FALSE)\r
\r
/**\r
- Begin Macro to measure the perofrmance of a behavior within one module.\r
+ Begin Macro to measure the performance of a behavior within one module.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
} while (FALSE)\r
\r
/**\r
- End Macro to measure the perofrmance of a behavior within one module.\r
+ End Macro to measure the performance of a behavior within one module.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
} while (FALSE)\r
\r
/**\r
- Begin Macro to measure the perofrmance of a behavior in different modules.\r
+ Begin Macro to measure the performance of a behavior in different modules.\r
Such as the performance of PEI phase, DXE phase, BDS phase.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
} while (FALSE)\r
\r
/**\r
- End Macro to measure the perofrmance of a behavior in different modules.\r
+ End Macro to measure the performance of a behavior in different modules.\r
Such as the performance of PEI phase, DXE phase, BDS phase.\r
\r
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,\r
- and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.\r
+ and the BIT6 (disable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set,\r
then LogPerformanceMeasurement() is called.\r
\r
**/\r
Otherwise, the source lines between PERF_CODE_BEGIN() and PERF_CODE_END() are not included in a module.\r
\r
**/\r
-#define PERF_CODE_END() __PerformanceCodeLocal = 0; __PerformanceCodeLocal++; } } while (FALSE)\r
+#define PERF_CODE_END() __PerformanceCodeLocal = 0; __PerformanceCodeLocal++; } } while (FALSE)\r
\r
/**\r
Macro that declares a section of performance measurement source code.\r
Expression \\r
PERF_CODE_END ()\r
\r
-\r
#endif\r
projects / mirror_edk2.git / blobdiff