mirror of https://github.com/acidanthera/audk.git
MdePkg/PerformanceLib.h: Add new Perf macros
1. Add new Perf macros for performance measurement and related APIs and definitions in Performance library class. 2. Update NULL performance library instance in MdePkg. Cc: Liming Gao <liming.gao@intel.com> Cc: Michael Kinney <michael.d.kinney@intel.com> Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Dandan Bi <dandan.bi@intel.com> Reviewed-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
Bi, Dandan
Liming Gao
parent
137fb13deb
commit
2c5b667e64
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Provides services to log the execution times and retrieve them later.
|
||||
|
||||
Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
|
||||
Copyright (c) 2006 - 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
|
||||
|
|
@ -20,6 +20,45 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|||
///
|
||||
#define PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED 0x00000001
|
||||
|
||||
//
|
||||
// Public Progress Identifiers for Event Records.
|
||||
//
|
||||
#define PERF_EVENT_ID 0x00
|
||||
|
||||
#define MODULE_START_ID 0x01
|
||||
#define MODULE_END_ID 0x02
|
||||
#define MODULE_LOADIMAGE_START_ID 0x03
|
||||
#define MODULE_LOADIMAGE_END_ID 0x04
|
||||
#define MODULE_DB_START_ID 0x05
|
||||
#define MODULE_DB_END_ID 0x06
|
||||
#define MODULE_DB_SUPPORT_START_ID 0x07
|
||||
#define MODULE_DB_SUPPORT_END_ID 0x08
|
||||
#define MODULE_DB_STOP_START_ID 0x09
|
||||
#define MODULE_DB_STOP_END_ID 0x0A
|
||||
|
||||
#define PERF_EVENTSIGNAL_START_ID 0x10
|
||||
#define PERF_EVENTSIGNAL_END_ID 0x11
|
||||
#define PERF_CALLBACK_START_ID 0x20
|
||||
#define PERF_CALLBACK_END_ID 0x21
|
||||
#define PERF_FUNCTION_START_ID 0x30
|
||||
#define PERF_FUNCTION_END_ID 0x31
|
||||
#define PERF_INMODULE_START_ID 0x40
|
||||
#define PERF_INMODULE_END_ID 0x41
|
||||
#define PERF_CROSSMODULE_START_ID 0x50
|
||||
#define PERF_CROSSMODULE_END_ID 0x51
|
||||
|
||||
//
|
||||
// Declare bits for PcdPerformanceLibraryPropertyMask and
|
||||
// also used as the Type parameter of LogPerformanceMeasurementEnabled().
|
||||
//
|
||||
#define PERF_CORE_START_IMAGE 0x0002
|
||||
#define PERF_CORE_LOAD_IMAGE 0x0004
|
||||
#define PERF_CORE_DB_SUPPORT 0x0008
|
||||
#define PERF_CORE_DB_START 0x0010
|
||||
#define PERF_CORE_DB_STOP 0x0020
|
||||
|
||||
#define PERF_GENERAL_TYPE 0x0040
|
||||
|
||||
/**
|
||||
Creates a record for the beginning of a performance measurement.
|
||||
|
||||
|
|
@ -271,6 +310,373 @@ PerformanceMeasurementEnabled (
|
|||
VOID
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
Check whether the specified performance measurement can be logged.
|
||||
|
||||
This function returns TRUE when the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set
|
||||
and the Type disable bit in PcdPerformanceLibraryPropertyMask is not set.
|
||||
|
||||
@param Type - Type of the performance measurement entry.
|
||||
|
||||
@retval TRUE The performance measurement can be logged.
|
||||
@retval FALSE The performance measurement can NOT be logged.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
LogPerformanceMeasurementEnabled (
|
||||
IN CONST UINTN Type
|
||||
);
|
||||
|
||||
/**
|
||||
Create performance record with event description.
|
||||
|
||||
@param CallerIdentifier - Image handle or pointer to caller ID GUID
|
||||
@param Guid - Pointer to a GUID.
|
||||
Used for event signal perf and callback perf to cache the event guid.
|
||||
@param String - Pointer to a string describing the measurement
|
||||
@param Address - Pointer to a location in memory relevant to the measurement.
|
||||
@param Identifier - Performance identifier describing the type of measurement.
|
||||
|
||||
@retval RETURN_SUCCESS - Successfully created performance record
|
||||
@retval RETURN_OUT_OF_RESOURCES - Ran out of space to store the records
|
||||
@retval RETURN_INVALID_PARAMETER - Invalid parameter passed to function - NULL
|
||||
pointer or invalid Identifier.
|
||||
|
||||
**/
|
||||
RETURN_STATUS
|
||||
EFIAPI
|
||||
LogPerformanceMeasurement (
|
||||
IN CONST VOID *CallerIdentifier, OPTIONAL
|
||||
IN CONST VOID *Guid, OPTIONAL
|
||||
IN CONST CHAR8 *String, OPTIONAL
|
||||
IN UINT64 Address, OPTIONAL
|
||||
IN UINT32 Identifier
|
||||
);
|
||||
|
||||
/**
|
||||
Begin Macro to measure the performance of StartImage in core.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT1(dsiable PERF_CORE_START_IMAGE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_START_IMAGE_BEGIN(ModuleHandle) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_CORE_START_IMAGE)) { \
|
||||
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, 0, MODULE_START_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
End Macro to measure the performance of StartImage in core.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT1 (dsiable PERF_CORE_START_IMAGE)of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_START_IMAGE_END(ModuleHandle) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_CORE_START_IMAGE)) { \
|
||||
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, 0, MODULE_END_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
Begin Macro to measure the performance of LoadImage in core.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT2 (dsiable PERF_CORE_LOAD_IAMGE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_LOAD_IMAGE_BEGIN(ModuleHandle) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_CORE_LOAD_IMAGE)) { \
|
||||
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, 0, MODULE_LOADIMAGE_START_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
End Macro to measure the performance of LoadImage in core.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT2 (dsiable PERF_CORE_LOAD_IAMGE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_LOAD_IMAGE_END(ModuleHandle) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_CORE_LOAD_IMAGE)) { \
|
||||
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, 0, MODULE_LOADIMAGE_END_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
Start Macro to measure the performance of DriverBinding Support in core.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT3 (dsiable PERF_CORE_DB_SUPPORT) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_DRIVER_BINDING_SUPPORT_BEGIN(ModuleHandle, ControllerHandle) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_CORE_DB_SUPPORT)) { \
|
||||
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, (UINT64)(UINTN)ControllerHandle, MODULE_DB_SUPPORT_START_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
End Macro to measure the performance of DriverBinding Support in core.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT3 (dsiable PERF_CORE_DB_SUPPORT) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_DRIVER_BINDING_SUPPORT_END(ModuleHandle, ControllerHandle) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_CORE_DB_SUPPORT)) { \
|
||||
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, (UINT64)(UINTN)ControllerHandle, MODULE_DB_SUPPORT_END_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
Begin Macro to measure the performance of DriverBinding Start in core.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT4 (dsiable PERF_CORE_DB_START) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_DRIVER_BINDING_START_BEGIN(ModuleHandle, ControllerHandle) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_CORE_DB_START)) { \
|
||||
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, (UINT64)(UINTN)ControllerHandle, MODULE_DB_START_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
End Macro to measure the performance of DriverBinding Start in core.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT4 (dsiable PERF_CORE_DB_START) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_DRIVER_BINDING_START_END(ModuleHandle, ControllerHandle) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_CORE_DB_START)) { \
|
||||
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, (UINT64)(UINTN)ControllerHandle, MODULE_DB_END_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
Start Macro to measure the performance of DriverBinding Stop in core.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT5 (dsiable PERF_CORE_DB_STOP) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_DRIVER_BINDING_STOP_BEGIN(ModuleHandle, ControllerHandle) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_CORE_DB_STOP)) { \
|
||||
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, (UINT64)(UINTN)ControllerHandle, MODULE_DB_STOP_START_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
End Macro to measure the performance of DriverBinding Stop in core.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT5 (dsiable PERF_CORE_DB_STOP) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_DRIVER_BINDING_STOP_END(ModuleHandle, ControllerHandle) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_CORE_DB_STOP)) { \
|
||||
LogPerformanceMeasurement (ModuleHandle, NULL, NULL, (UINT64)(UINTN)ControllerHandle, MODULE_DB_STOP_END_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
Macro to measure the time from power-on to this macro execution.
|
||||
It can be used to log a meaningful thing which happens at a time point.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_EVENT(EventString) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
|
||||
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, EventString , 0, PERF_EVENT_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
Begin Macro to measure the perofrmance of evnent signal behavior in any module.
|
||||
The event guid will be passed with this macro.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_EVENT_SIGNAL_BEGIN(EventGuid) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
|
||||
LogPerformanceMeasurement (&gEfiCallerIdGuid, EventGuid, __FUNCTION__ , 0, PERF_EVENTSIGNAL_START_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
End Macro to measure the perofrmance of evnent signal behavior in any module.
|
||||
The event guid will be passed with this macro.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_EVENT_SIGNAL_END(EventGuid) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
|
||||
LogPerformanceMeasurement (&gEfiCallerIdGuid, EventGuid, __FUNCTION__ , 0, PERF_EVENTSIGNAL_END_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
Begin Macro to measure the perofrmance of a callback function in any module.
|
||||
The event guid which trigger the callback function will be passed with this macro.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_CALLBACK_BEGIN(TriggerGuid) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
|
||||
LogPerformanceMeasurement (&gEfiCallerIdGuid, TriggerGuid, __FUNCTION__ , 0, PERF_CALLBACK_START_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
End Macro to measure the perofrmance of a callback function in any module.
|
||||
The event guid which trigger the callback function will be passed with this macro.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_CALLBACK_END(TriggerGuid) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
|
||||
LogPerformanceMeasurement (&gEfiCallerIdGuid, TriggerGuid, __FUNCTION__ , 0, PERF_CALLBACK_END_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
Begin Macro to measure the perofrmance of a general function in any module.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_FUNCTION_BEGIN() \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
|
||||
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, __FUNCTION__ , 0, PERF_FUNCTION_START_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
End Macro to measure the perofrmance of a general function in any module.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_FUNCTION_END() \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
|
||||
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, __FUNCTION__ , 0, PERF_FUNCTION_END_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
Begin Macro to measure the perofrmance of a behavior within one module.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_INMODULE_BEGIN(MeasurementString) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
|
||||
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, MeasurementString, 0, PERF_INMODULE_START_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
End Macro to measure the perofrmance of a behavior within one module.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_INMODULE_END(MeasurementString) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
|
||||
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, MeasurementString, 0, PERF_INMODULE_END_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
Begin Macro to measure the perofrmance of a behavior in different modules.
|
||||
Such as the performance of PEI phase, DXE phase, BDS phase.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_CROSSMODULE_BEGIN(MeasurementString) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
|
||||
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, MeasurementString, 0, PERF_CROSSMODULE_START_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
End Macro to measure the perofrmance of a behavior in different modules.
|
||||
Such as the performance of PEI phase, DXE phase, BDS phase.
|
||||
|
||||
If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
|
||||
and the BIT6 (dsiable PERF_GENERAL_TYPE) of PcdPerformanceLibraryPropertyMask is not set.
|
||||
then LogPerformanceMeasurement() is called.
|
||||
|
||||
**/
|
||||
#define PERF_CROSSMODULE_END(MeasurementString) \
|
||||
do { \
|
||||
if (LogPerformanceMeasurementEnabled (PERF_GENERAL_TYPE)) { \
|
||||
LogPerformanceMeasurement (&gEfiCallerIdGuid, NULL, MeasurementString, 0, PERF_CROSSMODULE_END_ID); \
|
||||
} \
|
||||
} while (FALSE)
|
||||
|
||||
/**
|
||||
Macro that calls EndPerformanceMeasurement().
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Base Performance Library which provides no service.
|
||||
|
||||
Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
|
||||
Copyright (c) 2006 - 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
|
||||
|
|
@ -304,3 +304,58 @@ PerformanceMeasurementEnabled (
|
|||
{
|
||||
return (BOOLEAN) ((PcdGet8(PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0);
|
||||
}
|
||||
|
||||
/**
|
||||
Create performance record with event description and a timestamp.
|
||||
|
||||
@param CallerIdentifier - Image handle or pointer to caller ID GUID
|
||||
@param Guid - Pointer to a GUID
|
||||
@param String - Pointer to a string describing the measurement
|
||||
@param Address - Pointer to a location in memory relevant to the measurement
|
||||
@param Identifier - Performance identifier describing the type of measurement
|
||||
|
||||
@retval RETURN_SUCCESS - Successfully created performance record
|
||||
@retval RETURN_OUT_OF_RESOURCES - Ran out of space to store the records
|
||||
@retval RETURN_INVALID_PARAMETER - Invalid parameter passed to function - NULL
|
||||
pointer or invalid PerfId
|
||||
|
||||
**/
|
||||
RETURN_STATUS
|
||||
EFIAPI
|
||||
LogPerformanceMeasurement (
|
||||
IN CONST VOID *CallerIdentifier,OPTIONAL
|
||||
IN CONST VOID *Guid, OPTIONAL
|
||||
IN CONST CHAR8 *String, OPTIONAL
|
||||
IN UINT64 Address, OPTIONAL
|
||||
IN UINT32 Identifier
|
||||
)
|
||||
{
|
||||
return RETURN_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
Check whether the specified performance measurement can be logged.
|
||||
|
||||
This function returns TRUE when the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set
|
||||
and the Type disable bit in PcdPerformanceLibraryPropertyMask is not set.
|
||||
|
||||
@param Type - Type of the performance measurement entry.
|
||||
|
||||
@retval TRUE The performance measurement can be logged.
|
||||
@retval FALSE The performance measurement can NOT be logged.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
LogPerformanceMeasurementEnabled (
|
||||
IN CONST UINTN Type
|
||||
)
|
||||
{
|
||||
//
|
||||
// When Performance measurement is enabled and the type is not filtered, the performance can be logged.
|
||||
//
|
||||
if (PerformanceMeasurementEnabled () && (PcdGet8(PcdPerformanceLibraryPropertyMask) & Type) == 0) {
|
||||
return TRUE;
|
||||
}
|
||||
return FALSE;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -2169,8 +2169,15 @@
|
|||
|
||||
## The mask is used to control PerformanceLib behavior.<BR><BR>
|
||||
# BIT0 - Enable Performance Measurement.<BR>
|
||||
# BIT1 - Disable Start Image Logging.<BR>
|
||||
# BIT2 - Disable Load Image logging.<BR>
|
||||
# BIT3 - Disable Binding Support logging.<BR>
|
||||
# BIT4 - Disable Binding Start logging.<BR>
|
||||
# BIT5 - Disable Binding Stop logging.<BR>
|
||||
# BIT6 - Disable all other general Perfs.<BR>
|
||||
# BIT1-BIT6 are evaluated when BIT0 is set.<BR>
|
||||
# @Prompt Performance Measurement Property.
|
||||
# @Expression 0x80000002 | (gEfiMdePkgTokenSpaceGuid.PcdPerformanceLibraryPropertyMask & 0xFE) == 0
|
||||
# @Expression 0x80000002 | (gEfiMdePkgTokenSpaceGuid.PcdPerformanceLibraryPropertyMask & 0x80) == 0
|
||||
gEfiMdePkgTokenSpaceGuid.PcdPerformanceLibraryPropertyMask|0|UINT8|0x00000009
|
||||
|
||||
## The mask is used to control PostCodeLib behavior.<BR><BR>
|
||||
|
|
|
|||
|
|
@ -245,6 +245,12 @@
|
|||
|
||||
#string STR_gEfiMdePkgTokenSpaceGuid_PcdPerformanceLibraryPropertyMask_HELP #language en-US "The mask is used to control PerformanceLib behavior.<BR><BR>\n"
|
||||
"BIT0 - Enable Performance Measurement.<BR>"
|
||||
"BIT1 - Disable Start Image Logging.<BR>"
|
||||
"BIT2 - Disable Load Image logging.<BR>"
|
||||
"BIT3 - Disable Binding Support logging.<BR>"
|
||||
"BIT4 - Disable Binding Start logging.<BR>"
|
||||
"BIT5 - Disable Binding Stop logging.<BR>"
|
||||
"BIT6 - Disable all other general Perfs.<BR>"
|
||||
|
||||
#string STR_gEfiMdePkgTokenSpaceGuid_PcdPostCodePropertyMask_PROMPT #language en-US "Post Code Property"
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue