[mirror_edk2.git] / MdeModulePkg / Library / DxeSmmPerformanceLib / DxeSmmPerformanceLib.c

/** @file\r
  Performance library instance used in DXE phase to dump both PEI/DXE and SMM performance data.\r
\r
  This library instance allows a DXE driver or UEFI application to dump both PEI/DXE and SMM performance data.\r
  StartPerformanceMeasurement(), EndPerformanceMeasurement(), StartPerformanceMeasurementEx()\r
  and EndPerformanceMeasurementEx() are not implemented.\r
\r
  Copyright (c) 2011 - 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
**/\r
\r
\r
#include <PiDxe.h>\r
\r
#include <Guid/Performance.h>\r
\r
#include <Library/PerformanceLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
\r
#include <Protocol/SmmCommunication.h>\r
\r
#define SMM_PERFORMANCE_COMMUNICATION_BUFFER_SIZE (OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)  + sizeof (SMM_PERF_COMMUNICATE))\r
\r
EFI_SMM_COMMUNICATION_PROTOCOL  *mSmmCommunication = NULL;\r
UINT8                           mSmmPerformanceBuffer[SMM_PERFORMANCE_COMMUNICATION_BUFFER_SIZE];\r
GAUGE_DATA_ENTRY                *mGaugeData = NULL;\r
UINTN                           mGaugeNumberOfEntries = 0;\r
GAUGE_DATA_ENTRY_EX             *mGaugeDataEx = NULL;\r
UINTN                           mGaugeNumberOfEntriesEx = 0;\r
\r
BOOLEAN                         mNoSmmPerfHandler = FALSE;\r
BOOLEAN                         mNoSmmPerfExHandler = FALSE;\r
\r
//\r
// The cached Performance Protocol and PerformanceEx Protocol interface.\r
//\r
PERFORMANCE_PROTOCOL            *mPerformance = NULL;\r
PERFORMANCE_EX_PROTOCOL         *mPerformanceEx = NULL;\r
\r
/**\r
  The function caches the pointer to SMM Communication protocol.\r
\r
  The function locates SMM Communication protocol from protocol database.\r
\r
  @retval EFI_SUCCESS     SMM Communication protocol is successfully located.\r
  @retval Other           SMM Communication protocol is not located to log performance.\r
\r
**/\r
EFI_STATUS\r
GetCommunicationProtocol (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  EFI_SMM_COMMUNICATION_PROTOCOL  *Communication;\r
\r
  if (mSmmCommunication != NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Status = gBS->LocateProtocol (&gEfiSmmCommunicationProtocolGuid, NULL, (VOID **) &Communication);\r
  if (!EFI_ERROR (Status)) {\r
    ASSERT (Communication != NULL);\r
    //\r
    // Cache SMM Communication protocol.\r
    //\r
    mSmmCommunication = Communication;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  The function caches the pointers to PerformanceEx protocol and Performance Protocol.\r
\r
  The function locates PerformanceEx protocol and Performance Protocol from protocol database.\r
\r
  @retval EFI_SUCCESS     PerformanceEx protocol or Performance Protocol is successfully located.\r
  @retval EFI_NOT_FOUND   Both PerformanceEx protocol and Performance Protocol are not located to log performance.\r
\r
**/\r
EFI_STATUS\r
GetPerformanceProtocol (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                Status;\r
  PERFORMANCE_PROTOCOL      *Performance;\r
  PERFORMANCE_EX_PROTOCOL   *PerformanceEx;\r
\r
  if (mPerformanceEx != NULL || mPerformance != NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Status = gBS->LocateProtocol (&gPerformanceExProtocolGuid, NULL, (VOID **) &PerformanceEx);\r
  if (!EFI_ERROR (Status)) {\r
    ASSERT (PerformanceEx != NULL);\r
    //\r
    // Cache PerformanceEx Protocol.\r
    //\r
    mPerformanceEx = PerformanceEx;\r
    return EFI_SUCCESS;\r
  }\r
\r
  Status = gBS->LocateProtocol (&gPerformanceProtocolGuid, NULL, (VOID **) &Performance);\r
  if (!EFI_ERROR (Status)) {\r
    ASSERT (Performance != NULL);\r
    //\r
    // Cache performance protocol.\r
    //\r
    mPerformance = Performance;\r
    return EFI_SUCCESS;\r
  }\r
\r
  return EFI_NOT_FOUND;\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
\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
  return RETURN_SUCCESS;\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
\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
  return RETURN_SUCCESS;\r
}\r
\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
  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
\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
\r
**/\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 UINT64       TimeStamp\r
  )\r
{\r
  return RETURN_SUCCESS;\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
\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
\r
**/\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 UINT64       TimeStamp\r
  )\r
{\r
  return RETURN_SUCCESS;\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 log 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
GetByPerformanceProtocol (\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
  EFI_STATUS            Status;\r
  GAUGE_DATA_ENTRY_EX   *GaugeData;\r
\r
  Status = GetPerformanceProtocol ();\r
  if (EFI_ERROR (Status)) {\r
    return 0;\r
  }\r
\r
  if (mPerformanceEx != NULL) {\r
    Status = mPerformanceEx->GetGaugeEx (LogEntryKey++, &GaugeData);\r
  } else if (mPerformance != NULL) {\r
    Status = mPerformance->GetGauge (LogEntryKey++, (GAUGE_DATA_ENTRY **) &GaugeData);\r
  } else {\r
    ASSERT (FALSE);\r
    return 0;\r
  }\r
\r
  //\r
  // Make sure that LogEntryKey is a valid log entry key,\r
  //\r
  ASSERT (Status != EFI_INVALID_PARAMETER);\r
\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // The LogEntryKey is the last entry (equals to the total entry number).\r
    //\r
    return 0;\r
  }\r
\r
  ASSERT (GaugeData != NULL);\r
\r
  *Handle         = (VOID *) (UINTN) GaugeData->Handle;\r
  *Token          = GaugeData->Token;\r
  *Module         = GaugeData->Module;\r
  *StartTimeStamp = GaugeData->StartTimeStamp;\r
  *EndTimeStamp   = GaugeData->EndTimeStamp;\r
  if (mPerformanceEx != NULL) {\r
    *Identifier   = GaugeData->Identifier;\r
  } else {\r
    *Identifier   = 0;\r
  }\r
\r
  return LogEntryKey;\r
}\r
\r
\r
/**\r
  Retrieves all previous logged performance measurement.\r
  Function will use SMM communicate protocol to get all previous SMM performance measurement data.\r
  If success, data buffer will be returned. If fail function will return NULL.\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 log entry.\r
\r
  @retval !NULL           Get all gauge data success.\r
  @retval NULL            Get all gauge data failed.\r
**/\r
GAUGE_DATA_ENTRY *\r
EFIAPI\r
GetAllSmmGaugeData (\r
  IN UINTN      LogEntryKey\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  EFI_SMM_COMMUNICATE_HEADER  *SmmCommBufferHeader;\r
  SMM_PERF_COMMUNICATE        *SmmPerfCommData;\r
  UINTN                       CommSize;\r
  UINTN                       DataSize;\r
\r
  if (mNoSmmPerfHandler) {\r
    //\r
    // Not try to get the SMM gauge data again\r
    // if no SMM Performance handler found.\r
    //\r
    return NULL;\r
  }\r
\r
  if (LogEntryKey != 0) {\r
    if (mGaugeData != NULL) {\r
      return mGaugeData;\r
    }\r
  } else {\r
    //\r
    // Reget the SMM gauge data at the first entry get.\r
    //\r
    if (mGaugeData != NULL) {\r
      FreePool (mGaugeData);\r
      mGaugeData = NULL;\r
      mGaugeNumberOfEntries = 0;\r
    }\r
  }\r
\r
  Status = GetCommunicationProtocol ();\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
\r
  //\r
  // Initialize communicate buffer \r
  //\r
  SmmCommBufferHeader = (EFI_SMM_COMMUNICATE_HEADER *)mSmmPerformanceBuffer;\r
  SmmPerfCommData = (SMM_PERF_COMMUNICATE *)SmmCommBufferHeader->Data;\r
  ZeroMem((UINT8*)SmmPerfCommData, sizeof(SMM_PERF_COMMUNICATE));\r
    \r
  CopyGuid (&SmmCommBufferHeader->HeaderGuid, &gSmmPerformanceProtocolGuid);\r
  SmmCommBufferHeader->MessageLength = sizeof(SMM_PERF_COMMUNICATE);\r
  CommSize = SMM_PERFORMANCE_COMMUNICATION_BUFFER_SIZE;\r
\r
  //\r
  // Get total number of SMM gauge entries\r
  //\r
  SmmPerfCommData->Function = SMM_PERF_FUNCTION_GET_GAUGE_ENTRY_NUMBER;\r
  Status = mSmmCommunication->Communicate (mSmmCommunication, mSmmPerformanceBuffer, &CommSize);\r
  if (Status == EFI_NOT_FOUND) {\r
    mNoSmmPerfHandler = TRUE;\r
  }\r
  if (EFI_ERROR (Status) || EFI_ERROR (SmmPerfCommData->ReturnStatus) || SmmPerfCommData->NumberOfEntries == 0) {\r
    return NULL;\r
  }\r
\r
  mGaugeNumberOfEntries = SmmPerfCommData->NumberOfEntries;\r
  \r
  DataSize = mGaugeNumberOfEntries * sizeof(GAUGE_DATA_ENTRY);\r
  mGaugeData = AllocateZeroPool(DataSize);\r
  ASSERT (mGaugeData != NULL);\r
  \r
  //\r
  // Get all SMM gauge data\r
  //  \r
  SmmPerfCommData->Function = SMM_PERF_FUNCTION_GET_GAUGE_DATA;\r
  SmmPerfCommData->LogEntryKey = 0;\r
  SmmPerfCommData->NumberOfEntries = mGaugeNumberOfEntries;\r
  SmmPerfCommData->GaugeData = mGaugeData;\r
  Status = mSmmCommunication->Communicate (mSmmCommunication, mSmmPerformanceBuffer, &CommSize);\r
  if (EFI_ERROR (Status) || EFI_ERROR (SmmPerfCommData->ReturnStatus)) {\r
    FreePool (mGaugeData);\r
    mGaugeData = NULL;\r
    mGaugeNumberOfEntries = 0;\r
  }\r
\r
  return mGaugeData;\r
}\r
\r
/**\r
  Retrieves all previous logged performance measurement.\r
  Function will use SMM communicate protocol to get all previous SMM performance measurement data.\r
  If success, data buffer will be returned. If fail function will return NULL.\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 log entry.\r
\r
  @retval !NULL           Get all gauge data success.\r
  @retval NULL            Get all gauge data failed.\r
**/\r
GAUGE_DATA_ENTRY_EX *\r
EFIAPI\r
GetAllSmmGaugeDataEx (\r
  IN UINTN      LogEntryKey\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  EFI_SMM_COMMUNICATE_HEADER  *SmmCommBufferHeader;\r
  SMM_PERF_COMMUNICATE_EX     *SmmPerfCommData;\r
  UINTN                       CommSize;\r
  UINTN                       DataSize;\r
\r
  if (mNoSmmPerfExHandler) {\r
    //\r
    // Not try to get the SMM gauge data again\r
    // if no SMM PerformanceEx handler found.\r
    //\r
    return NULL;\r
  }\r
\r
  if (LogEntryKey != 0) {\r
    if (mGaugeDataEx != NULL) {\r
      return mGaugeDataEx;\r
    }\r
  } else {\r
    //\r
    // Reget the SMM gauge data at the first entry get.\r
    //\r
    if (mGaugeDataEx != NULL) {\r
      FreePool (mGaugeDataEx);\r
      mGaugeDataEx = NULL;\r
      mGaugeNumberOfEntriesEx = 0;\r
    }\r
  }\r
\r
  Status = GetCommunicationProtocol ();\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
\r
  //\r
  // Initialize communicate buffer \r
  //\r
  SmmCommBufferHeader = (EFI_SMM_COMMUNICATE_HEADER *)mSmmPerformanceBuffer;\r
  SmmPerfCommData = (SMM_PERF_COMMUNICATE_EX *)SmmCommBufferHeader->Data;\r
  ZeroMem((UINT8*)SmmPerfCommData, sizeof(SMM_PERF_COMMUNICATE_EX));\r
    \r
  CopyGuid (&SmmCommBufferHeader->HeaderGuid, &gSmmPerformanceExProtocolGuid);\r
  SmmCommBufferHeader->MessageLength = sizeof(SMM_PERF_COMMUNICATE_EX);\r
  CommSize = SMM_PERFORMANCE_COMMUNICATION_BUFFER_SIZE;\r
\r
  //\r
  // Get total number of SMM gauge entries\r
  //\r
  SmmPerfCommData->Function = SMM_PERF_FUNCTION_GET_GAUGE_ENTRY_NUMBER;\r
  Status = mSmmCommunication->Communicate (mSmmCommunication, mSmmPerformanceBuffer, &CommSize);\r
  if (Status == EFI_NOT_FOUND) {\r
    mNoSmmPerfExHandler = TRUE;\r
  }\r
  if (EFI_ERROR (Status) || EFI_ERROR (SmmPerfCommData->ReturnStatus) || SmmPerfCommData->NumberOfEntries == 0) {\r
    return NULL;\r
  }\r
\r
  mGaugeNumberOfEntriesEx = SmmPerfCommData->NumberOfEntries;\r
  \r
  DataSize = mGaugeNumberOfEntriesEx * sizeof(GAUGE_DATA_ENTRY_EX);\r
  mGaugeDataEx = AllocateZeroPool(DataSize);\r
  ASSERT (mGaugeDataEx != NULL);\r
  \r
  //\r
  // Get all SMM gauge data\r
  //  \r
  SmmPerfCommData->Function = SMM_PERF_FUNCTION_GET_GAUGE_DATA;\r
  SmmPerfCommData->LogEntryKey = 0;\r
  SmmPerfCommData->NumberOfEntries = mGaugeNumberOfEntriesEx;\r
  SmmPerfCommData->GaugeDataEx = mGaugeDataEx;\r
  Status = mSmmCommunication->Communicate (mSmmCommunication, mSmmPerformanceBuffer, &CommSize);\r
  if (EFI_ERROR (Status) || EFI_ERROR (SmmPerfCommData->ReturnStatus)) {\r
    FreePool (mGaugeDataEx);\r
    mGaugeDataEx = NULL;\r
    mGaugeNumberOfEntriesEx = 0;\r
  }\r
 \r
  return mGaugeDataEx;\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 log 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
  GAUGE_DATA_ENTRY_EX   *GaugeData;\r
\r
  GaugeData = NULL;\r
\r
  ASSERT (Handle != NULL);\r
  ASSERT (Token != NULL);\r
  ASSERT (Module != NULL);\r
  ASSERT (StartTimeStamp != NULL);\r
  ASSERT (EndTimeStamp != NULL);\r
  ASSERT (Identifier != NULL);\r
\r
  mGaugeDataEx = GetAllSmmGaugeDataEx (LogEntryKey);\r
  if (mGaugeDataEx != NULL) {\r
    if (LogEntryKey >= mGaugeNumberOfEntriesEx) {\r
      //\r
      // Try to get the data by Performance Protocol.\r
      //\r
      LogEntryKey = LogEntryKey - mGaugeNumberOfEntriesEx;\r
      LogEntryKey = GetByPerformanceProtocol (\r
                      LogEntryKey,\r
                      Handle,\r
                      Token,\r
                      Module,\r
                      StartTimeStamp,\r
                      EndTimeStamp,\r
                      Identifier\r
                      );\r
      if (LogEntryKey == 0) {\r
        //\r
        // Last entry.\r
        //\r
        return LogEntryKey;\r
      } else {\r
        return (LogEntryKey + mGaugeNumberOfEntriesEx);\r
      }\r
    }\r
\r
    GaugeData = &mGaugeDataEx[LogEntryKey++];\r
    *Identifier = GaugeData->Identifier;\r
  } else {\r
    mGaugeData = GetAllSmmGaugeData (LogEntryKey);\r
    if (mGaugeData != NULL) {\r
      if (LogEntryKey >= mGaugeNumberOfEntries) {\r
        //\r
        // Try to get the data by Performance Protocol.\r
        //\r
        LogEntryKey = LogEntryKey - mGaugeNumberOfEntries;\r
        LogEntryKey = GetByPerformanceProtocol (\r
                        LogEntryKey,\r
                        Handle,\r
                        Token,\r
                        Module,\r
                        StartTimeStamp,\r
                        EndTimeStamp,\r
                        Identifier\r
                        );\r
        if (LogEntryKey == 0) {\r
          //\r
          // Last entry.\r
          //\r
          return LogEntryKey;\r
        } else {\r
          return (LogEntryKey + mGaugeNumberOfEntries);\r
        }\r
      }\r
\r
      GaugeData = (GAUGE_DATA_ENTRY_EX *) &mGaugeData[LogEntryKey++];\r
      *Identifier = 0;\r
    } else {\r
      return GetByPerformanceProtocol (\r
               LogEntryKey,\r
               Handle,\r
               Token,\r
               Module,\r
               StartTimeStamp,\r
               EndTimeStamp,\r
               Identifier\r
               );\r
    }\r
  }\r
\r
  *Handle         = (VOID *) (UINTN) GaugeData->Handle;\r
  *Token          = GaugeData->Token;\r
  *Module         = GaugeData->Module;\r
  *StartTimeStamp = GaugeData->StartTimeStamp;\r
  *EndTimeStamp   = GaugeData->EndTimeStamp;\r
\r
  return LogEntryKey;\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 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
  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, and EndTimeStamp.\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
\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 log 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
\r
  @return The key for the next performance log entry (in general case).\r
\r
**/\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
  )\r
{\r
  UINT32 Identifier;\r
  return GetPerformanceMeasurementEx (LogEntryKey, Handle, Token, Module, StartTimeStamp, EndTimeStamp, &Identifier);\r
}\r
\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
  @retval TRUE                    The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r
                                  PcdPerformanceLibraryPropertyMask is set.\r
  @retval FALSE                   The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of\r
                                  PcdPerformanceLibraryPropertyMask is clear.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
PerformanceMeasurementEnabled (\r
  VOID\r
  )\r
{\r
  return (BOOLEAN) ((PcdGet8(PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0);\r
}\r