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

/** @file\r
  Performance library instance used by SMM Core.\r
\r
  This library provides the performance measurement interfaces and initializes performance\r
  logging for the SMM phase.\r
  It initializes SMM phase performance logging by publishing the SMM Performance and PerformanceEx Protocol,\r
  which is consumed by SmmPerformanceLib to logging performance data in SMM phase.\r
\r
  This library is mainly used by SMM Core to start performance logging to ensure that\r
  SMM Performance and PerformanceEx Protocol are installed at the very beginning of SMM phase.\r
\r
 Caution: This module requires additional review when modified.\r
 This driver will have external input - performance data and communicate buffer in SMM mode.\r
 This external input must be validated carefully to avoid security issue like\r
 buffer overflow, integer overflow.\r
\r
 SmmPerformanceHandlerEx(), SmmPerformanceHandler() will receive untrusted input and do basic validation.\r
\r
Copyright (c) 2011 - 2015, 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 "SmmCorePerformanceLibInternal.h"\r
\r
//\r
// The data structure to hold global performance data.\r
//\r
GAUGE_DATA_HEADER       *mGaugeData;\r
\r
//\r
// The current maximum number of logging entries. If current number of \r
// entries exceeds this value, it will re-allocate a larger array and\r
// migration the old data to the larger array.\r
//\r
UINT32                  mMaxGaugeRecords;\r
\r
//\r
// The handle to install Performance Protocol instance.\r
//\r
EFI_HANDLE              mHandle = NULL;\r
\r
BOOLEAN                 mPerformanceMeasurementEnabled;\r
\r
SPIN_LOCK               mSmmPerfLock;\r
\r
//\r
// Interfaces for SMM Performance Protocol.\r
//\r
PERFORMANCE_PROTOCOL mPerformanceInterface = {\r
  StartGauge,\r
  EndGauge,\r
  GetGauge\r
};\r
\r
//\r
// Interfaces for SMM PerformanceEx Protocol.\r
//\r
PERFORMANCE_EX_PROTOCOL mPerformanceExInterface = {\r
  StartGaugeEx,\r
  EndGaugeEx,\r
  GetGaugeEx\r
};\r
\r
/**\r
  Searches in the gauge array with keyword Handle, Token, Module and Identfier.\r
\r
  This internal function searches for the gauge entry in the gauge array.\r
  If there is an entry that exactly matches the given keywords\r
  and its end time stamp is zero, then the index of that gauge entry is returned;\r
  otherwise, the the number of gauge entries in the array is returned.\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  Identifier              32-bit identifier.\r
\r
  @retval The index of gauge entry in the array.\r
\r
**/\r
UINT32\r
SmmSearchForGaugeEntry (\r
  IN CONST VOID                 *Handle,  OPTIONAL\r
  IN CONST CHAR8                *Token,   OPTIONAL\r
  IN CONST CHAR8                *Module,   OPTIONAL\r
  IN CONST UINT32               Identifier\r
  )\r
{\r
  UINT32                    Index;\r
  UINT32                    Index2;\r
  UINT32                    NumberOfEntries;\r
  GAUGE_DATA_ENTRY_EX       *GaugeEntryExArray;\r
\r
  if (Token == NULL) {\r
    Token = "";\r
  }\r
  if (Module == NULL) {\r
    Module = "";\r
  }\r
\r
  NumberOfEntries = mGaugeData->NumberOfEntries;\r
  GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1);\r
\r
  Index2 = 0;\r
\r
  for (Index = 0; Index < NumberOfEntries; Index++) {\r
    Index2 = NumberOfEntries - 1 - Index;\r
    if (GaugeEntryExArray[Index2].EndTimeStamp == 0 &&\r
        (GaugeEntryExArray[Index2].Handle == (EFI_PHYSICAL_ADDRESS) (UINTN) Handle) &&\r
        AsciiStrnCmp (GaugeEntryExArray[Index2].Token, Token, SMM_PERFORMANCE_STRING_LENGTH) == 0 &&\r
        AsciiStrnCmp (GaugeEntryExArray[Index2].Module, Module, SMM_PERFORMANCE_STRING_LENGTH) == 0 &&\r
        (GaugeEntryExArray[Index2].Identifier == Identifier)) {\r
      Index = Index2;\r
      break;\r
    }\r
  }\r
\r
  return Index;\r
}\r
\r
/**\r
  Adds a record at the end of the performance measurement log\r
  that records the start time of a performance measurement.\r
\r
  Adds a record to the end of the performance measurement log\r
  that contains the Handle, Token, Module and Identifier.\r
  The end time of the new record must be set to zero.\r
  If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.\r
  If TimeStamp is zero, the start time in the record is filled in with the value\r
  read from the current time stamp.\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 StartGauge of PERFORMANCE_PROTOCOL.\r
\r
  @retval EFI_SUCCESS             The data was read correctly from the device.\r
  @retval EFI_OUT_OF_RESOURCES    There are not enough resources to record the measurement.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
StartGaugeEx (\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
  GAUGE_DATA_ENTRY_EX       *GaugeEntryExArray;\r
  UINTN                     GaugeDataSize;\r
  GAUGE_DATA_HEADER         *NewGaugeData;\r
  UINTN                     OldGaugeDataSize;\r
  GAUGE_DATA_HEADER         *OldGaugeData;\r
  UINT32                    Index;\r
\r
  AcquireSpinLock (&mSmmPerfLock);\r
\r
  Index = mGaugeData->NumberOfEntries;\r
  if (Index >= mMaxGaugeRecords) {\r
    //\r
    // Try to enlarge the scale of gauge array.\r
    //\r
    OldGaugeData      = mGaugeData;\r
    OldGaugeDataSize  = sizeof (GAUGE_DATA_HEADER) + sizeof (GAUGE_DATA_ENTRY_EX) * mMaxGaugeRecords;\r
\r
    GaugeDataSize     = sizeof (GAUGE_DATA_HEADER) + sizeof (GAUGE_DATA_ENTRY_EX) * mMaxGaugeRecords * 2;\r
\r
    NewGaugeData = AllocateZeroPool (GaugeDataSize);\r
    if (NewGaugeData == NULL) {\r
      ReleaseSpinLock (&mSmmPerfLock);\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    mGaugeData = NewGaugeData;\r
    mMaxGaugeRecords *= 2;\r
\r
    //\r
    // Initialize new data array and migrate old data one.\r
    //\r
    mGaugeData = CopyMem (mGaugeData, OldGaugeData, OldGaugeDataSize);\r
\r
    FreePool (OldGaugeData);\r
  }\r
\r
  GaugeEntryExArray               = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1);\r
  GaugeEntryExArray[Index].Handle = (EFI_PHYSICAL_ADDRESS) (UINTN) Handle;\r
\r
  if (Token != NULL) {\r
    AsciiStrnCpyS (GaugeEntryExArray[Index].Token, SMM_PERFORMANCE_STRING_SIZE, Token, SMM_PERFORMANCE_STRING_LENGTH);\r
  }\r
  if (Module != NULL) {\r
    AsciiStrnCpyS (GaugeEntryExArray[Index].Module, SMM_PERFORMANCE_STRING_SIZE, Module, SMM_PERFORMANCE_STRING_LENGTH);\r
  }\r
\r
  GaugeEntryExArray[Index].EndTimeStamp = 0;\r
  GaugeEntryExArray[Index].Identifier = Identifier;\r
\r
  if (TimeStamp == 0) {\r
    TimeStamp = GetPerformanceCounter ();\r
  }\r
  GaugeEntryExArray[Index].StartTimeStamp = TimeStamp;\r
\r
  mGaugeData->NumberOfEntries++;\r
\r
  ReleaseSpinLock (&mSmmPerfLock);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Searches the performance measurement log from the beginning of the log\r
  for the first matching record that contains a zero end time and fills in a valid end time.\r
\r
  Searches the performance measurement log from the beginning of the log\r
  for the first record that matches Handle, Token, Module and Identifier and has an end time value of zero.\r
  If the record can not be found then return EFI_NOT_FOUND.\r
  If the record is found and TimeStamp is not zero,\r
  then the end time in the record is filled in with the value specified by TimeStamp.\r
  If the record is found and TimeStamp is zero, then the end time in the matching record\r
  is filled in with the current time stamp value.\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 EndGauge of PERFORMANCE_PROTOCOL.\r
\r
  @retval EFI_SUCCESS             The end of  the measurement was recorded.\r
  @retval EFI_NOT_FOUND           The specified measurement record could not be found.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EndGaugeEx (\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
  GAUGE_DATA_ENTRY_EX *GaugeEntryExArray;\r
  UINT32              Index;\r
\r
  AcquireSpinLock (&mSmmPerfLock);\r
\r
  if (TimeStamp == 0) {\r
    TimeStamp = GetPerformanceCounter ();\r
  }\r
\r
  Index = SmmSearchForGaugeEntry (Handle, Token, Module, Identifier);\r
  if (Index >= mGaugeData->NumberOfEntries) {\r
    ReleaseSpinLock (&mSmmPerfLock);\r
    return EFI_NOT_FOUND;\r
  }\r
  GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1);\r
  GaugeEntryExArray[Index].EndTimeStamp = TimeStamp;\r
\r
  ReleaseSpinLock (&mSmmPerfLock);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Retrieves a previously logged performance measurement.\r
  It can also retrieve the log created by StartGauge and EndGauge of PERFORMANCE_PROTOCOL,\r
  and then assign the Identifier with 0.\r
\r
  Retrieves the performance log entry from the performance log specified by LogEntryKey.\r
  If it stands for a valid entry, then EFI_SUCCESS is returned and\r
  GaugeDataEntryEx stores the pointer to that entry.\r
\r
  @param  LogEntryKey             The key for the previous performance measurement log entry.\r
                                  If 0, then the first performance measurement log entry is retrieved.\r
  @param  GaugeDataEntryEx        The indirect pointer to the extended gauge data entry specified by LogEntryKey\r
                                  if the retrieval is successful.\r
\r
  @retval EFI_SUCCESS             The GuageDataEntryEx is successfully found based on LogEntryKey.\r
  @retval EFI_NOT_FOUND           The LogEntryKey is the last entry (equals to the total entry number).\r
  @retval EFI_INVALIDE_PARAMETER  The LogEntryKey is not a valid entry (greater than the total entry number).\r
  @retval EFI_INVALIDE_PARAMETER  GaugeDataEntryEx is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetGaugeEx (\r
  IN  UINTN                 LogEntryKey,\r
  OUT GAUGE_DATA_ENTRY_EX   **GaugeDataEntryEx\r
  )\r
{\r
  UINTN               NumberOfEntries;\r
  GAUGE_DATA_ENTRY_EX *GaugeEntryExArray;\r
\r
  NumberOfEntries = (UINTN) (mGaugeData->NumberOfEntries);\r
  if (LogEntryKey > NumberOfEntries) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  if (LogEntryKey == NumberOfEntries) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1);\r
\r
  if (GaugeDataEntryEx == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  *GaugeDataEntryEx = &GaugeEntryExArray[LogEntryKey];\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Adds a record at the end of the performance measurement log\r
  that records the start time of a performance measurement.\r
\r
  Adds a record to the end of the performance measurement log\r
  that contains the Handle, Token, and Module.\r
  The end time of the new record must be set to zero.\r
  If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.\r
  If TimeStamp is zero, the start time in the record is filled in with the value\r
  read from the current time stamp.\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 EFI_SUCCESS             The data was read correctly from the device.\r
  @retval EFI_OUT_OF_RESOURCES    There are not enough resources to record the measurement.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
StartGauge (\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 StartGaugeEx (Handle, Token, Module, TimeStamp, 0);\r
}\r
\r
/**\r
  Searches the performance measurement log from the beginning of the log\r
  for the first matching record that contains a zero end time and fills in a valid end time.\r
\r
  Searches the performance measurement log from the beginning of the log\r
  for the first record that matches Handle, Token, and Module and has an end time value of zero.\r
  If the record can not be found then return EFI_NOT_FOUND.\r
  If the record is found and TimeStamp is not zero,\r
  then the end time in the record is filled in with the value specified by TimeStamp.\r
  If the record is found and TimeStamp is zero, then the end time in the matching record\r
  is filled in with the current time stamp value.\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 EFI_SUCCESS             The end of  the measurement was recorded.\r
  @retval EFI_NOT_FOUND           The specified measurement record could not be found.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EndGauge (\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 EndGaugeEx (Handle, Token, Module, TimeStamp, 0);\r
}\r
\r
/**\r
  Retrieves a previously logged performance measurement.\r
  It can also retrieve the log created by StartGaugeEx and EndGaugeEx of PERFORMANCE_EX_PROTOCOL,\r
  and then eliminate the Identifier.\r
\r
  Retrieves the performance log entry from the performance log specified by LogEntryKey.\r
  If it stands for a valid entry, then EFI_SUCCESS is returned and\r
  GaugeDataEntry stores the pointer to that entry.\r
\r
  @param  LogEntryKey             The key for the previous performance measurement log entry.\r
                                  If 0, then the first performance measurement log entry is retrieved.\r
  @param  GaugeDataEntry          The indirect pointer to the gauge data entry specified by LogEntryKey\r
                                  if the retrieval is successful.\r
\r
  @retval EFI_SUCCESS             The GuageDataEntry is successfully found based on LogEntryKey.\r
  @retval EFI_NOT_FOUND           The LogEntryKey is the last entry (equals to the total entry number).\r
  @retval EFI_INVALIDE_PARAMETER  The LogEntryKey is not a valid entry (greater than the total entry number).\r
  @retval EFI_INVALIDE_PARAMETER  GaugeDataEntry is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetGauge (\r
  IN  UINTN               LogEntryKey,\r
  OUT GAUGE_DATA_ENTRY    **GaugeDataEntry\r
  )\r
{\r
  EFI_STATUS          Status;\r
  GAUGE_DATA_ENTRY_EX *GaugeEntryEx;\r
\r
  GaugeEntryEx = NULL;\r
\r
  Status = GetGaugeEx (LogEntryKey, &GaugeEntryEx);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (GaugeDataEntry == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  *GaugeDataEntry = (GAUGE_DATA_ENTRY *) GaugeEntryEx;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Communication service SMI Handler entry.\r
\r
  This SMI handler provides services for the performance wrapper driver.\r
  \r
   Caution: This function may receive untrusted input.\r
   Communicate buffer and buffer size are external input, so this function will do basic validation.\r
\r
  @param[in]     DispatchHandle  The unique handle assigned to this handler by SmiHandlerRegister().\r
  @param[in]     RegisterContext Points to an optional handler context which was specified when the\r
                                 handler was registered.\r
  @param[in, out] CommBuffer     A pointer to a collection of data in memory that will\r
                                 be conveyed from a non-SMM environment into an SMM environment.\r
  @param[in, out] CommBufferSize The size of the CommBuffer.\r
\r
  @retval EFI_SUCCESS                         The interrupt was handled and quiesced. No other handlers \r
                                              should still be called.\r
  @retval EFI_WARN_INTERRUPT_SOURCE_QUIESCED  The interrupt has been quiesced but other handlers should \r
                                              still be called.\r
  @retval EFI_WARN_INTERRUPT_SOURCE_PENDING   The interrupt is still pending and other handlers should still \r
                                              be called.\r
  @retval EFI_INTERRUPT_PENDING               The interrupt could not be quiesced.\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmPerformanceHandlerEx (\r
  IN     EFI_HANDLE                    DispatchHandle,\r
  IN     CONST VOID                   *RegisterContext,\r
  IN OUT VOID                          *CommBuffer,\r
  IN OUT UINTN                         *CommBufferSize\r
  )\r
{\r
  EFI_STATUS                Status;\r
  SMM_PERF_COMMUNICATE_EX   *SmmPerfCommData;\r
  GAUGE_DATA_ENTRY_EX       *GaugeEntryExArray;\r
  UINTN                     DataSize;\r
  GAUGE_DATA_ENTRY_EX       *GaugeDataEx;\r
  UINTN                     NumberOfEntries;\r
  UINTN                     LogEntryKey;\r
  UINTN                     TempCommBufferSize;\r
\r
  GaugeEntryExArray = NULL;\r
\r
  //\r
  // If input is invalid, stop processing this SMI\r
  //\r
  if (CommBuffer == NULL || CommBufferSize == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  TempCommBufferSize = *CommBufferSize;\r
\r
  if(TempCommBufferSize < sizeof (SMM_PERF_COMMUNICATE_EX)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (!SmmIsBufferOutsideSmmValid ((UINTN)CommBuffer, TempCommBufferSize)) {\r
    DEBUG ((EFI_D_ERROR, "SmmPerformanceHandlerEx: SMM communcation data buffer in SMRAM or overflow!\n"));\r
    return EFI_SUCCESS;\r
  }\r
  \r
  SmmPerfCommData = (SMM_PERF_COMMUNICATE_EX *)CommBuffer;\r
\r
  switch (SmmPerfCommData->Function) {\r
    case SMM_PERF_FUNCTION_GET_GAUGE_ENTRY_NUMBER :\r
       SmmPerfCommData->NumberOfEntries = mGaugeData->NumberOfEntries;\r
       Status = EFI_SUCCESS;\r
       break;\r
\r
    case SMM_PERF_FUNCTION_GET_GAUGE_DATA :\r
      GaugeDataEx = SmmPerfCommData->GaugeDataEx;\r
      NumberOfEntries = SmmPerfCommData->NumberOfEntries;\r
      LogEntryKey = SmmPerfCommData->LogEntryKey;\r
       if (GaugeDataEx == NULL || NumberOfEntries == 0 || LogEntryKey > mGaugeData->NumberOfEntries ||\r
           NumberOfEntries > mGaugeData->NumberOfEntries || (LogEntryKey + NumberOfEntries) > mGaugeData->NumberOfEntries) {\r
         Status = EFI_INVALID_PARAMETER;\r
         break;\r
       }\r
\r
       //\r
       // Sanity check\r
       //\r
       DataSize = NumberOfEntries * sizeof(GAUGE_DATA_ENTRY_EX);\r
       if (!SmmIsBufferOutsideSmmValid ((UINTN)GaugeDataEx, DataSize)) {\r
         DEBUG ((EFI_D_ERROR, "SmmPerformanceHandlerEx: SMM Performance Data buffer in SMRAM or overflow!\n"));\r
         Status = EFI_ACCESS_DENIED;\r
         break;\r
       }\r
\r
       GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1);\r
       CopyMem(\r
         (UINT8 *) GaugeDataEx,\r
         (UINT8 *) &GaugeEntryExArray[LogEntryKey],\r
         DataSize\r
         );\r
       Status = EFI_SUCCESS;\r
       break;\r
\r
    default:\r
       Status = EFI_UNSUPPORTED;\r
  }\r
\r
\r
  SmmPerfCommData->ReturnStatus = Status;\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Communication service SMI Handler entry.\r
\r
  This SMI handler provides services for the performance wrapper driver.\r
\r
  Caution: This function may receive untrusted input.\r
  Communicate buffer and buffer size are external input, so this function will do basic validation.\r
\r
  @param[in]     DispatchHandle  The unique handle assigned to this handler by SmiHandlerRegister().\r
  @param[in]     RegisterContext Points to an optional handler context which was specified when the\r
                                 handler was registered.\r
  @param[in, out] CommBuffer     A pointer to a collection of data in memory that will\r
                                 be conveyed from a non-SMM environment into an SMM environment.\r
  @param[in, out] CommBufferSize The size of the CommBuffer.\r
\r
  @retval EFI_SUCCESS                         The interrupt was handled and quiesced. No other handlers \r
                                              should still be called.\r
  @retval EFI_WARN_INTERRUPT_SOURCE_QUIESCED  The interrupt has been quiesced but other handlers should \r
                                              still be called.\r
  @retval EFI_WARN_INTERRUPT_SOURCE_PENDING   The interrupt is still pending and other handlers should still \r
                                              be called.\r
  @retval EFI_INTERRUPT_PENDING               The interrupt could not be quiesced.\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmPerformanceHandler (\r
  IN     EFI_HANDLE                    DispatchHandle,\r
  IN     CONST VOID                   *RegisterContext,\r
  IN OUT VOID                          *CommBuffer,\r
  IN OUT UINTN                         *CommBufferSize\r
  )\r
{\r
  EFI_STATUS            Status;\r
  SMM_PERF_COMMUNICATE  *SmmPerfCommData;\r
  GAUGE_DATA_ENTRY_EX   *GaugeEntryExArray;\r
  UINTN                 DataSize;\r
  UINTN                 Index;\r
  GAUGE_DATA_ENTRY      *GaugeData;\r
  UINTN                 NumberOfEntries;\r
  UINTN                 LogEntryKey;\r
  UINTN                 TempCommBufferSize;\r
\r
  GaugeEntryExArray = NULL;\r
\r
  //\r
  // If input is invalid, stop processing this SMI\r
  //\r
  if (CommBuffer == NULL || CommBufferSize == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  TempCommBufferSize = *CommBufferSize;\r
\r
  if(TempCommBufferSize < sizeof (SMM_PERF_COMMUNICATE)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (!SmmIsBufferOutsideSmmValid ((UINTN)CommBuffer, TempCommBufferSize)) {\r
    DEBUG ((EFI_D_ERROR, "SmmPerformanceHandler: SMM communcation data buffer in SMRAM or overflow!\n"));\r
    return EFI_SUCCESS;\r
  }\r
\r
  SmmPerfCommData = (SMM_PERF_COMMUNICATE *)CommBuffer;\r
\r
  switch (SmmPerfCommData->Function) {\r
    case SMM_PERF_FUNCTION_GET_GAUGE_ENTRY_NUMBER :\r
       SmmPerfCommData->NumberOfEntries = mGaugeData->NumberOfEntries;\r
       Status = EFI_SUCCESS;\r
       break;\r
\r
    case SMM_PERF_FUNCTION_GET_GAUGE_DATA :\r
       GaugeData = SmmPerfCommData->GaugeData;\r
       NumberOfEntries = SmmPerfCommData->NumberOfEntries;\r
       LogEntryKey = SmmPerfCommData->LogEntryKey;\r
       if (GaugeData == NULL || NumberOfEntries == 0 || LogEntryKey > mGaugeData->NumberOfEntries ||\r
           NumberOfEntries > mGaugeData->NumberOfEntries || (LogEntryKey + NumberOfEntries) > mGaugeData->NumberOfEntries) {\r
         Status = EFI_INVALID_PARAMETER;\r
         break;\r
       }\r
\r
       //\r
       // Sanity check\r
       //\r
       DataSize = NumberOfEntries * sizeof(GAUGE_DATA_ENTRY);\r
       if (!SmmIsBufferOutsideSmmValid ((UINTN)GaugeData, DataSize)) {\r
         DEBUG ((EFI_D_ERROR, "SmmPerformanceHandler: SMM Performance Data buffer in SMRAM or overflow!\n"));\r
         Status = EFI_ACCESS_DENIED;\r
         break;\r
       }\r
\r
       GaugeEntryExArray = (GAUGE_DATA_ENTRY_EX *) (mGaugeData + 1);\r
\r
       for (Index = 0; Index < NumberOfEntries; Index++) {\r
         CopyMem(\r
           (UINT8 *) &GaugeData[Index],\r
           (UINT8 *) &GaugeEntryExArray[LogEntryKey++],\r
           sizeof (GAUGE_DATA_ENTRY)\r
           );\r
       }\r
       Status = EFI_SUCCESS;\r
       break;\r
\r
    default:\r
       Status = EFI_UNSUPPORTED;\r
  }\r
\r
\r
  SmmPerfCommData->ReturnStatus = Status;\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  SmmBase2 protocol notify callback function, when SMST and SMM memory service get initialized \r
  this function is callbacked to initialize the Smm Performance Lib \r
\r
  @param  Event    The event of notify protocol.\r
  @param  Context  Notify event context.\r
\r
**/\r
VOID\r
EFIAPI\r
InitializeSmmCorePerformanceLib (\r
  IN EFI_EVENT     Event,\r
  IN VOID          *Context\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_HANDLE                Handle;\r
\r
  //\r
  // Initialize spin lock\r
  //\r
  InitializeSpinLock (&mSmmPerfLock);\r
\r
  mMaxGaugeRecords = INIT_SMM_GAUGE_DATA_ENTRIES;\r
\r
  mGaugeData = AllocateZeroPool (sizeof (GAUGE_DATA_HEADER) + (sizeof (GAUGE_DATA_ENTRY_EX) * mMaxGaugeRecords));\r
  ASSERT (mGaugeData != NULL);\r
  \r
  //\r
  // Install the protocol interfaces.\r
  //\r
  Status = gSmst->SmmInstallProtocolInterface (\r
                    &mHandle,\r
                    &gSmmPerformanceProtocolGuid,\r
                    EFI_NATIVE_INTERFACE,\r
                    &mPerformanceInterface\r
                    );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = gSmst->SmmInstallProtocolInterface (\r
                    &mHandle,\r
                    &gSmmPerformanceExProtocolGuid,\r
                    EFI_NATIVE_INTERFACE,\r
                    &mPerformanceExInterface\r
                    );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  ///\r
  /// Register SMM Performance SMI handler\r
  ///\r
  Handle = NULL;\r
  Status = gSmst->SmiHandlerRegister (SmmPerformanceHandler, &gSmmPerformanceProtocolGuid, &Handle);\r
  ASSERT_EFI_ERROR (Status);\r
  Status = gSmst->SmiHandlerRegister (SmmPerformanceHandlerEx, &gSmmPerformanceExProtocolGuid, &Handle);\r
  ASSERT_EFI_ERROR (Status);\r
}\r
\r
/**\r
  The constructor function initializes the Performance Measurement Enable flag and \r
  registers SmmBase2 protocol notify callback.\r
  It will ASSERT() if one of these operations fails and it will always return EFI_SUCCESS.\r
\r
  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
  @param  SystemTable   A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmCorePerformanceLibConstructor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
  EFI_EVENT   Event;\r
  VOID        *Registration;\r
\r
  mPerformanceMeasurementEnabled =  (BOOLEAN) ((PcdGet8(PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0);\r
  if (!mPerformanceMeasurementEnabled) {\r
    //\r
    // Do not initialize performance infrastructure if not required.\r
    //\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Create the events to do the library init.\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_CALLBACK,\r
                  InitializeSmmCorePerformanceLib,\r
                  NULL,\r
                  &Event\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Register for protocol notifications on this event\r
  //\r
  Status = gBS->RegisterProtocolNotify (\r
                  &gEfiSmmBase2ProtocolGuid,\r
                  Event,\r
                  &Registration\r
                  );\r
\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Adds a record at the end of the performance measurement log\r
  that records the start time of a performance measurement.\r
\r
  Adds a record to the end of the performance measurement log\r
  that contains the Handle, Token, Module and Identifier.\r
  The end time of the new record must be set to zero.\r
  If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.\r
  If TimeStamp is zero, the start time in the record is filled in with the value\r
  read from the current time stamp.\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_STATUS) StartGaugeEx (Handle, Token, Module, TimeStamp, Identifier);\r
}\r
\r
/**\r
  Searches the performance measurement log from the beginning of the log\r
  for the first matching record that contains a zero end time and fills in a valid end time.\r
\r
  Searches the performance measurement log from the beginning of the log\r
  for the first record that matches Handle, Token, Module and Identifier and has an end time value of zero.\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 the end time in the record is filled in with the value specified by TimeStamp.\r
  If the record is found and TimeStamp is zero, then the end time in the matching record\r
  is filled in with the current time stamp value.\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_STATUS) EndGaugeEx (Handle, Token, Module, TimeStamp, Identifier);\r
}\r
\r
/**\r
  Attempts to retrieve a performance measurement log entry from the performance measurement log.\r
  It can also retrieve the log created by StartPerformanceMeasurement and EndPerformanceMeasurement,\r
  and then assign the Identifier with 0.\r
\r
  Attempts to retrieve the performance log entry specified by LogEntryKey.  If LogEntryKey is\r
  zero on entry, then an attempt is made to retrieve the first entry from the performance log,\r
  and the key for the second entry in the log is returned.  If the performance log is empty,\r
  then no entry is retrieved and zero is returned.  If LogEntryKey is not zero, then the performance\r
  log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is\r
  returned.  If LogEntryKey is the key for the last entry in the log, then the last log entry is\r
  retrieved and an implementation specific non-zero key value that specifies the end of the performance\r
  log is returned.  If LogEntryKey is equal this implementation specific non-zero key value, then no entry\r
  is retrieved and zero is returned.  In the cases where a performance log entry can be returned,\r
  the log entry is returned in Handle, Token, Module, StartTimeStamp, EndTimeStamp and Identifier.\r
  If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().\r
  If Handle is NULL, then ASSERT().\r
  If Token is NULL, then ASSERT().\r
  If Module is NULL, then ASSERT().\r
  If StartTimeStamp is NULL, then ASSERT().\r
  If EndTimeStamp is NULL, then ASSERT().\r
  If Identifier is NULL, then ASSERT().\r
\r
  @param  LogEntryKey             On entry, the key of the performance measurement log entry to retrieve.\r
                                  0, then the first performance measurement log entry is retrieved.\r
                                  On exit, the key of the next performance 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
  EFI_STATUS           Status;\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
  Status = GetGaugeEx (LogEntryKey++, &GaugeData);\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
  *Identifier     = GaugeData->Identifier;\r
\r
  return LogEntryKey;\r
}\r
\r
/**\r
  Adds a record at the end of the performance measurement log\r
  that records the start time of a performance measurement.\r
\r
  Adds a record to the end of the performance measurement log\r
  that contains the Handle, Token, and Module.\r
  The end time of the new record must be set to zero.\r
  If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.\r
  If TimeStamp is zero, the start time in the record is filled in with the value\r
  read from the current time stamp.\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 StartPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, 0);\r
}\r
\r
/**\r
  Searches the performance measurement log from the beginning of the log\r
  for the first matching record that contains a zero end time and fills in a valid end time.\r
\r
  Searches the performance measurement log from the beginning of the log\r
  for the first record that matches Handle, Token, and Module and has an end time value of zero.\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 the end time in the record is filled in with the value specified by TimeStamp.\r
  If the record is found and TimeStamp is zero, then the end time in the matching record\r
  is filled in with the current time stamp value.\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 EndPerformanceMeasurementEx (Handle, Token, Module, TimeStamp, 0);\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 mPerformanceMeasurementEnabled;\r
}\r