public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: Dandan Bi <dandan.bi@intel.com>
To: edk2-devel@lists.01.org
Cc: Liming Gao <liming.gao@intel.com>,
	Michael Kinney <michael.d.kinney@intel.com>
Subject: [RFC] MdePkg/PerformanceLib.h: Add new Perf macros
Date: Thu,  7 Jun 2018 09:46:32 +0800	[thread overview]
Message-ID: <20180607014632.86632-1-dandan.bi@intel.com> (raw)

We plan to add a group of new Perf macros in performance library for
performance logging. Which will simplify the usage model of performance
measurement.

New Perf Macros:
Macros 1:
#define PERF_START_IMAGE_BEGIN(ModuleHandle)
#define PERF_START_IMAGE_END(ModuleHandle)

Macros 2:
#define PERF_LOAD_IMAGE_BEGIN(ModuleHandle)
#define PERF_LOAD_IMAGE_END(ModuleHandle)

Macros 3:
#define PERF_DRIVER_BINDING_SUPPORT_BEGIN(ModuleHandle, ControllerHandle)
#define PERF_DRIVER_BINDING_SUPPORT_END(ModuleHandle, ControllerHandle)

Macros 4:
#define PERF_DRIVER_BINDING_START_BEGIN(ModuleHandle, ControllerHandle)
#define PERF_DRIVER_BINDING_START_END(ModuleHandle, ControllerHandle)

Macros 5:
#define PERF_DRIVER_BINDING_STOP_BEGIN(ModuleHandle, ControllerHandle)
#define PERF_DRIVER_BINDING_STOP_END(ModuleHandle, ControllerHandle)

Macros 6:
#define PERF_EVENT(EventString)

Macros 7:
#define PERF_EVENT_SIGNAL_BEGIN(EventGuid)
#define PERF_EVENT_SIGNAL_END(EventGuid)

Macros 8:
#define PERF_CALLBACK_BEGIN(TriggerGuid)
#define PERF_CALLBACK_END(TriggerGuid)

Macros 9:
#define PERF_FUNCTION_BEGIN()
#define PERF_FUNCTION_END()

Macros 10:
#define PERF_INMODULE_BEGIN(MeasurementString)
#define PERF_INMODULE_END(MeasurementString)

Macros 11:
#define PERF_CROSSMODULE_BEGIN(MeasurementString)
#define PERF_CROSSMODULE_END(MeasurementString)

The detailed descriptions and changes are listed here.
1. Reasons of introducing these new Perf macros:
   a. Simplify the usage model of Perf macros.
      New Perf macros will have less input parameters.
      And different use cases can map to different Perf macros.

   b. Introduce new control functionality for performance logging.
      Such as there are lots of DriverBinding Support (Start/Stop) Perf
      entries in core codes. User can stop logging the performance of
      these entries by configure PCD.

   c. User can get more info through the new Perf macros.
      Like the ControllerHandle for DriverBinding Perf entries...

2. Macros 1-11, each macro will be identified by different perf identifiers.
   Macros 1-5 are for core use cases and used in the
   PeiCore, DxeCore and SmmCore.
   Macros 6-11 are for general use cases and can be used in any modules.
   Map each pair of core macros in Macros 1-5 to a core Perf type:
   PERF_CORE_START_IMAGE
   PERF_CORE_LOAD_IMAGE
   PERF_CORE_DB_SUPPORT
   PERF_CORE_DB_START
   PERF_CORE_DB_STOP
   And map all general Perf macros in Macros 6-11 to PERF_GENERAL_TYPE
   Then we can configure PCD to disable different Perf macros.

3. Update PcdPerformanceLibraryPropertyMask to control performance logging.
   Now BIT0 of PcdPerformanceLibraryPropertyMaskis is to enable the
   performance measurement. We will add BIT1-BIT6 to control different
   Perf types. Only when performance measurement is enabled, we can check
   BIT1-BIT6 to see whether a specific Perf type is disabled or not.
   This configuration are compatible with current performance enable
   behavior, set BIT0 can enable all the performance measurement.
   PcdPerformanceLibraryPropertyMask in MdePkg
   #  BIT0 - Enable Performance Measurement.
   #  BIT1 - Disable Start Image Logging.
   #  BIT2 - Disable Load Image logging.
   #  BIT3 - Disable Binding Support logging.
   #  BIT4 - Disable Binding Start logging.
   #  BIT5 - Disable Binding Stop logging.
   #  BIT6 - Disable all other general Perfs.
   #  BIT1-BIT6 are evaluated when BIT0 is set.

4. Introduce two new Library APIs for PerformanceLib library class.
   a. LogPerformanceMeasurementEnabled (Type);
   b. LogPerformanceMeasurement (CallerId, Guid, String, Address, PerfId);
   LogPerformanceMeasurementEnabled (Type):
   check whether a specified performance measurement can be logged.
   LogPerformanceMeasurement (CallerId, Guid, String, Address, PerfId):
   Log performance measurement info.

5. Code updates
   a. Performance library instances update:
      MdePkg:
      BasePerformanceLibNull
      MdeModulePkg:
      PeiPerformanceLib
      DxePerformanceLib
      DxeCorePerformanceLib
      SmmPerformanceLib
      SmmCorePerformanceLib

   b. Consumer code update:
      Update the old perf macros to use new perf macros for
      MdeModulePkg, UefiCpuPkg and SecurityPkg.
      For other packages, if old Perf macros are used, packages owners
      can decide whether using new Perf macros to replace old ones.

Can refer to the following patch for more detailed code changes and
description of new macros, APIs, definitions and PCD updating.

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>
---
 MdePkg/Include/Library/PerformanceLib.h | 407 +++++++++++++++++++++++++++++++-
 MdePkg/MdePkg.dec                       |   9 +-
 2 files changed, 414 insertions(+), 2 deletions(-)

diff --git a/MdePkg/Include/Library/PerformanceLib.h b/MdePkg/Include/Library/PerformanceLib.h
index 3ecd62bd201..dea79a9ff53 100644
--- a/MdePkg/Include/Library/PerformanceLib.h
+++ b/MdePkg/Include/Library/PerformanceLib.h
@@ -1,9 +1,9 @@
 /** @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
 http://opensource.org/licenses/bsd-license.php
 
@@ -18,10 +18,49 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 ///
 /// Performance library propery mask bits
 ///
 #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. 
   
   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.
@@ -269,10 +308,376 @@ BOOLEAN
 EFIAPI
 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)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)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)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)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)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)ControllerHandle, MODULE_DB_STOP_END_ID); \
+    } \
+  } while (FALSE)
+
+/**
+  Macro to measure time from power-on to this macro execution
+
+  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().
 
   If the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set,
   then EndPerformanceMeasurement() is called.
diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index 0e64f22f4a7..1ab2141f947 100644
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -2167,12 +2167,19 @@
   # @Prompt Value to Clear Memory.
   gEfiMdePkgTokenSpaceGuid.PcdDebugClearMemoryValue|0xAF|UINT8|0x00000008
 
   ## 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 & 0x10) == 0
   gEfiMdePkgTokenSpaceGuid.PcdPerformanceLibraryPropertyMask|0|UINT8|0x00000009
 
   ## The mask is used to control PostCodeLib behavior.<BR><BR>
   #  BIT0 - Enable Post Code.<BR>
   #  BIT1 - Enable Post Code with Description.<BR>
-- 
2.14.3.windows.1



                 reply	other threads:[~2018-06-07  1:46 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180607014632.86632-1-dandan.bi@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox