Add new extension PerformanceLib APIs to store ID info.

Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13215 6f19259b-4bc3-4df7-8a09-765794883524

2 files changed, 250 insertions, 75 deletions

diff --git a/MdeModulePkg/Library/DxeSmmPerformanceLib/DxeSmmPerformanceLib.c b/MdeModulePkg/Library/DxeSmmPerformanceLib/DxeSmmPerformanceLib.c
index 19e9877cbf..3ceda5ef6e 100644
--- a/MdeModulePkg/Library/DxeSmmPerformanceLib/DxeSmmPerformanceLib.c
+++ b/MdeModulePkg/Library/DxeSmmPerformanceLib/DxeSmmPerformanceLib.c
@@ -2,7 +2,8 @@
   Performance library instance used in DXE phase to dump SMM performance data.

 

   This library instance allows a DXE driver or UEFI application to dump the SMM performance data.

-  StartPerformanceMeasurement() and EndPerformanceMeasurement() are not implemented.

+  StartPerformanceMeasurement(), EndPerformanceMeasurement(), StartPerformanceMeasurementEx()

+  and EndPerformanceMeasurementEx() are not implemented.

 

   Copyright (c) 2011 - 2012, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

@@ -39,16 +40,16 @@ EFI_SMM_COMMUNICATION_PROTOCOL  *mSmmCommunication = NULL;
 UINT8                           mSmmPerformanceBuffer[SMM_PERFORMANCE_COMMUNICATION_BUFFER_SIZE];

 GAUGE_DATA_ENTRY                *mGaugeData = NULL;

 UINTN                           mGaugeNumberOfEntries = 0;

-

+GAUGE_DATA_ENTRY_EX             *mGaugeDataEx = NULL;

+UINTN                           mGaugeNumberOfEntriesEx = 0;

 

 /**

-  The constructor function caches the pointer to SMM Communication protocol.

+  The function caches the pointer to SMM Communication protocol.

 

-  The constructor function locates Performance protocol from protocol database.

-  It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.

+  The function locates SMM Communication protocol from protocol database.

 

-  @retval EFI_SUCCESS     Performance protocol is successfully located.

-  @retval Other           Performance protocol is not located to log performance.

+  @retval EFI_SUCCESS     SMM Communication protocol is successfully located.

+  @retval Other           SMM Communication protocol is not located to log performance.

 

 **/

 EFI_STATUS

@@ -78,6 +79,78 @@ GetCommunicationProtocol (
 /**

   Creates a record for the beginning of a performance measurement.

 

+  Creates a record that contains the Handle, Token, Module and Identifier.

+  If TimeStamp is not zero, then TimeStamp is added to the record as the start time.

+  If TimeStamp is zero, then this function reads the current time stamp

+  and adds that time stamp value to the record as the start time.

+

+  @param  Handle                  Pointer to environment specific context used

+                                  to identify the component being measured.

+  @param  Token                   Pointer to a Null-terminated ASCII string

+                                  that identifies the component being measured.

+  @param  Module                  Pointer to a Null-terminated ASCII string

+                                  that identifies the module being measured.

+  @param  TimeStamp               64-bit time stamp.

+  @param  Identifier              32-bit identifier. If the value is 0, the created record

+                                  is same as the one created by StartPerformanceMeasurement.

+

+  @retval RETURN_SUCCESS          The start of the measurement was recorded.

+  @retval RETURN_OUT_OF_RESOURCES There are not enough resources to record the measurement.

+

+**/

+RETURN_STATUS

+EFIAPI

+StartPerformanceMeasurementEx (

+  IN CONST VOID   *Handle,  OPTIONAL

+  IN CONST CHAR8  *Token,   OPTIONAL

+  IN CONST CHAR8  *Module,  OPTIONAL

+  IN UINT64       TimeStamp,

+  IN UINT32       Identifier

+  )

+{

+  return RETURN_SUCCESS;

+}

+

+/**

+  Fills in the end time of a performance measurement.

+

+  Looks up the record that matches Handle, Token, Module and Identifier.

+  If the record can not be found then return RETURN_NOT_FOUND.

+  If the record is found and TimeStamp is not zero,

+  then TimeStamp is added to the record as the end time.

+  If the record is found and TimeStamp is zero, then this function reads

+  the current time stamp and adds that time stamp value to the record as the end time.

+

+  @param  Handle                  Pointer to environment specific context used

+                                  to identify the component being measured.

+  @param  Token                   Pointer to a Null-terminated ASCII string

+                                  that identifies the component being measured.

+  @param  Module                  Pointer to a Null-terminated ASCII string

+                                  that identifies the module being measured.

+  @param  TimeStamp               64-bit time stamp.

+  @param  Identifier              32-bit identifier. If the value is 0, the found record

+                                  is same as the one found by EndPerformanceMeasurement.

+

+  @retval RETURN_SUCCESS          The end of  the measurement was recorded.

+  @retval RETURN_NOT_FOUND        The specified measurement record could not be found.

+

+**/

+RETURN_STATUS

+EFIAPI

+EndPerformanceMeasurementEx (

+  IN CONST VOID   *Handle,  OPTIONAL

+  IN CONST CHAR8  *Token,   OPTIONAL

+  IN CONST CHAR8  *Module,  OPTIONAL

+  IN UINT64       TimeStamp,

+  IN UINT32       Identifier

+  )

+{

+  return RETURN_SUCCESS;

+}

+

+/**

+  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.

   If TimeStamp is zero, then this function reads the current time stamp

@@ -104,7 +177,7 @@ StartPerformanceMeasurement (
   IN UINT64       TimeStamp

   )

 {

-  return EFI_UNSUPPORTED;

+  return RETURN_SUCCESS;

 }

 

 /**

@@ -138,7 +211,7 @@ EndPerformanceMeasurement (
   IN UINT64       TimeStamp

   )

 {

-  return EFI_UNSUPPORTED;

+  return RETURN_SUCCESS;

 }

 

 /**

@@ -149,7 +222,7 @@ EndPerformanceMeasurement (
   @retval !NULL           Get all gauge data success.

   @retval NULL            Get all guage data failed.

 **/

-GAUGE_DATA_ENTRY*

+GAUGE_DATA_ENTRY *

 EFIAPI

 GetAllSmmGaugeData (VOID)

 {

@@ -171,22 +244,20 @@ GetAllSmmGaugeData (VOID)
   //

   // Initialize communicate buffer 

   //

-  SmmCommBufferHeader = (EFI_SMM_COMMUNICATE_HEADER*)mSmmPerformanceBuffer;

-  SmmPerfCommData = (SMM_PERF_COMMUNICATE*)SmmCommBufferHeader->Data;

+  SmmCommBufferHeader = (EFI_SMM_COMMUNICATE_HEADER *)mSmmPerformanceBuffer;

+  SmmPerfCommData = (SMM_PERF_COMMUNICATE *)SmmCommBufferHeader->Data;

   ZeroMem((UINT8*)SmmPerfCommData, sizeof(SMM_PERF_COMMUNICATE));

     

   CopyGuid (&SmmCommBufferHeader->HeaderGuid, &gSmmPerformanceProtocolGuid);

   SmmCommBufferHeader->MessageLength = sizeof(SMM_PERF_COMMUNICATE);

-  CommSize = OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)  + sizeof(SMM_PERF_COMMUNICATE);

+  CommSize = SMM_PERFORMANCE_COMMUNICATION_BUFFER_SIZE;

 

   //

   // Get totol number of SMM gauge entries

   //

   SmmPerfCommData->Function = SMM_PERF_FUNCTION_GET_GAUGE_ENTRY_NUMBER;

   Status = mSmmCommunication->Communicate (mSmmCommunication, mSmmPerformanceBuffer, &CommSize);

-  ASSERT_EFI_ERROR (Status);

-

-  if (EFI_ERROR (SmmPerfCommData->ReturnStatus) || SmmPerfCommData->NumberOfEntries == 0) {

+  if (EFI_ERROR (Status) || EFI_ERROR (SmmPerfCommData->ReturnStatus) || SmmPerfCommData->NumberOfEntries == 0) {

     return NULL;

   }

 

@@ -194,7 +265,7 @@ GetAllSmmGaugeData (VOID)
   

   DataSize = mGaugeNumberOfEntries * sizeof(GAUGE_DATA_ENTRY);

   mGaugeData = AllocateZeroPool(DataSize);

-  ASSERT_EFI_ERROR (Status);

+  ASSERT (mGaugeData != NULL);

   

   //

   // Get all SMM gauge data

@@ -204,54 +275,89 @@ GetAllSmmGaugeData (VOID)
   SmmPerfCommData->NumberOfEntries = mGaugeNumberOfEntries;

   SmmPerfCommData->GaugeData = mGaugeData;

   Status = mSmmCommunication->Communicate (mSmmCommunication, mSmmPerformanceBuffer, &CommSize);

-  ASSERT_EFI_ERROR (Status);

-  ASSERT_EFI_ERROR(SmmPerfCommData->ReturnStatus);

+  if (EFI_ERROR (Status) || EFI_ERROR (SmmPerfCommData->ReturnStatus)) {

+    FreePool (mGaugeData);

+    mGaugeData = NULL;

+    mGaugeNumberOfEntries = 0;

+  }

 

-  return mGaugeData; 

+  return mGaugeData;

 }

 

 /**

-  Retrieves a previously logged performance measurement.

-

-  Retrieves the performance log entry from the performance log specified by LogEntryKey.

-  If it stands for a valid entry, then EFI_SUCCESS is returned and

-  GaugeDataEntry stores the pointer to that entry.

-

-  @param  LogEntryKey             The key for the previous performance measurement log entry.

-                                  If 0, then the first performance measurement log entry is retrieved.

-  @param  GaugeDataEntry          The indirect pointer to the gauge data entry specified by LogEntryKey

-                                  if the retrieval is successful.

-

-  @retval EFI_SUCCESS             The GuageDataEntry is successfully found based on LogEntryKey.

-  @retval EFI_NOT_FOUND           The LogEntryKey is the last entry (equals to the total entry number).

-  @retval EFI_INVALIDE_PARAMETER  The LogEntryKey is not a valid entry (greater than the total entry number).

-  @retval EFI_INVALIDE_PARAMETER  GaugeDataEntry is NULL.

+  Retrieves all previous logged performance measurement.

+  Function will use SMM communicate protocol to get all previous SMM performance measurement data.

+  If success, data buffer will be returned. If fail function will return NULL.

 

+  @retval !NULL           Get all gauge data success.

+  @retval NULL            Get all guage data failed.

 **/

-EFI_STATUS

+GAUGE_DATA_ENTRY_EX *

 EFIAPI

-GetGauge (

-  IN  UINTN               LogEntryKey,

-  OUT GAUGE_DATA_ENTRY    **GaugeDataEntry

-  )

+GetAllSmmGaugeDataEx (VOID)

 {

-  if (LogEntryKey > mGaugeNumberOfEntries) {

-    return EFI_INVALID_PARAMETER;

+  EFI_STATUS                  Status;

+  EFI_SMM_COMMUNICATE_HEADER  *SmmCommBufferHeader;

+  SMM_PERF_COMMUNICATE_EX     *SmmPerfCommData;

+  UINTN                       CommSize;

+  UINTN                       DataSize;

+

+  if (mGaugeDataEx != NULL) {

+    return mGaugeDataEx;

   }

-  if (LogEntryKey == mGaugeNumberOfEntries) {

-    return EFI_NOT_FOUND;

+

+  Status = GetCommunicationProtocol ();

+  if (EFI_ERROR (Status)) {

+    return NULL;

   }

 

-  if (GaugeDataEntry == NULL) {

-    return EFI_INVALID_PARAMETER;

+  //

+  // Initialize communicate buffer 

+  //

+  SmmCommBufferHeader = (EFI_SMM_COMMUNICATE_HEADER *)mSmmPerformanceBuffer;

+  SmmPerfCommData = (SMM_PERF_COMMUNICATE_EX *)SmmCommBufferHeader->Data;

+  ZeroMem((UINT8*)SmmPerfCommData, sizeof(SMM_PERF_COMMUNICATE_EX));

+    

+  CopyGuid (&SmmCommBufferHeader->HeaderGuid, &gSmmPerformanceExProtocolGuid);

+  SmmCommBufferHeader->MessageLength = sizeof(SMM_PERF_COMMUNICATE_EX);

+  CommSize = SMM_PERFORMANCE_COMMUNICATION_BUFFER_SIZE;

+

+  //

+  // Get totol number of SMM gauge entries

+  //

+  SmmPerfCommData->Function = SMM_PERF_FUNCTION_GET_GAUGE_ENTRY_NUMBER;

+  Status = mSmmCommunication->Communicate (mSmmCommunication, mSmmPerformanceBuffer, &CommSize);

+  if (EFI_ERROR (Status) || EFI_ERROR (SmmPerfCommData->ReturnStatus) || SmmPerfCommData->NumberOfEntries == 0) {

+    return NULL;

   }

-  *GaugeDataEntry = &mGaugeData[LogEntryKey];

 

-  return EFI_SUCCESS;

+  mGaugeNumberOfEntriesEx = SmmPerfCommData->NumberOfEntries;

+  

+  DataSize = mGaugeNumberOfEntriesEx * sizeof(GAUGE_DATA_ENTRY_EX);

+  mGaugeDataEx = AllocateZeroPool(DataSize);

+  ASSERT (mGaugeDataEx != NULL);

+  

+  //

+  // Get all SMM gauge data

+  //  

+  SmmPerfCommData->Function = SMM_PERF_FUNCTION_GET_GAUGE_DATA;

+  SmmPerfCommData->LogEntryKey = 0;

+  SmmPerfCommData->NumberOfEntries = mGaugeNumberOfEntriesEx;

+  SmmPerfCommData->GaugeDataEx = mGaugeDataEx;

+  Status = mSmmCommunication->Communicate (mSmmCommunication, mSmmPerformanceBuffer, &CommSize);

+  if (EFI_ERROR (Status) || EFI_ERROR (SmmPerfCommData->ReturnStatus)) {

+    FreePool (mGaugeDataEx);

+    mGaugeDataEx = NULL;

+    mGaugeNumberOfEntriesEx = 0;

+  }

+ 

+  return mGaugeDataEx;

 }

 

 /**

   Attempts to retrieve a performance measurement log entry from the performance measurement log.

+  It can also retrieve the log created by StartPerformanceMeasurement and EndPerformanceMeasurement,

+  and then assign the Identifier with 0.

 

   Attempts to retrieve the performance log entry specified by LogEntryKey.  If LogEntryKey is

   zero on entry, then an attempt is made to retrieve the first entry from the performance log,

@@ -262,13 +368,14 @@ GetGauge (
   retrieved and an implementation specific non-zero key value that specifies the end of the performance

   log is returned.  If LogEntryKey is equal this implementation specific non-zero key value, then no entry

   is retrieved and zero is returned.  In the cases where a performance log entry can be returned,

-  the log entry is returned in Handle, Token, Module, StartTimeStamp, and EndTimeStamp.

+  the log entry is returned in Handle, Token, Module, StartTimeStamp, EndTimeStamp and Identifier.

   If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().

   If Handle is NULL, then ASSERT().

   If Token is NULL, then ASSERT().

   If Module is NULL, then ASSERT().

   If StartTimeStamp is NULL, then ASSERT().

   If EndTimeStamp is NULL, then ASSERT().

+  If Identifier is NULL, then ASSERT().

 

   @param  LogEntryKey             On entry, the key of the performance measurement log entry to retrieve.

                                   0, then the first performance measurement log entry is retrieved.

@@ -283,23 +390,24 @@ GetGauge (
                                   was started.

   @param  EndTimeStamp            Pointer to the 64-bit time stamp that was recorded when the measurement

                                   was ended.

+  @param  Identifier              Pointer to the 32-bit identifier that was recorded.

 

   @return The key for the next performance log entry (in general case).

 

 **/

 UINTN

 EFIAPI

-GetPerformanceMeasurement (

-  IN  UINTN       LogEntryKey,

+GetPerformanceMeasurementEx (

+  IN  UINTN       LogEntryKey, 

   OUT CONST VOID  **Handle,

   OUT CONST CHAR8 **Token,

   OUT CONST CHAR8 **Module,

   OUT UINT64      *StartTimeStamp,

-  OUT UINT64      *EndTimeStamp

+  OUT UINT64      *EndTimeStamp,

+  OUT UINT32      *Identifier

   )

 {

-  EFI_STATUS                    Status;

-  GAUGE_DATA_ENTRY      *GaugeData;

+  GAUGE_DATA_ENTRY_EX   *GaugeData;

 

   GaugeData = NULL;

 

@@ -308,29 +416,40 @@ GetPerformanceMeasurement (
   ASSERT (Module != NULL);

   ASSERT (StartTimeStamp != NULL);

   ASSERT (EndTimeStamp != NULL);

+  ASSERT (Identifier != NULL);

 

-  mGaugeData = GetAllSmmGaugeData();

-  if (mGaugeData == NULL) {

-    return 0;

-  }

-

-  Status = GetGauge (LogEntryKey++, &GaugeData);

-

-  //

-  // Make sure that LogEntryKey is a valid log entry key,

-  //

-  ASSERT (Status != EFI_INVALID_PARAMETER);

-

-  if (EFI_ERROR (Status)) {

+  mGaugeDataEx = GetAllSmmGaugeDataEx();

+  if (mGaugeDataEx != NULL) {

     //

-    // The LogEntryKey is the last entry (equals to the total entry number).

+    // Make sure that LogEntryKey is a valid log entry key.

     //

-    return 0;

-

+    ASSERT (LogEntryKey <= mGaugeNumberOfEntriesEx);

+

+    if (LogEntryKey == mGaugeNumberOfEntriesEx) {

+      return 0;

+    }

+

+    GaugeData = &mGaugeDataEx[LogEntryKey++];

+    *Identifier = GaugeData->Identifier;

+  } else {

+    mGaugeData = GetAllSmmGaugeData();

+    if (mGaugeData != NULL) {

+      //

+      // Make sure that LogEntryKey is a valid log entry key.

+      //

+      ASSERT (LogEntryKey <= mGaugeNumberOfEntries);

+

+      if (LogEntryKey == mGaugeNumberOfEntries) {

+        return 0;

+      }

+

+      GaugeData = (GAUGE_DATA_ENTRY_EX *) &mGaugeData[LogEntryKey++];

+      *Identifier = 0;

+    } else {

+      return 0;

+    }

   }

 

-  ASSERT (GaugeData != NULL);

-

   *Handle         = (VOID *) (UINTN) GaugeData->Handle;

   *Token          = GaugeData->Token;

   *Module         = GaugeData->Module;

@@ -341,6 +460,60 @@ GetPerformanceMeasurement (
 }

 

 /**

+  Attempts to retrieve a performance measurement log entry from the performance measurement log.

+  It can also retrieve the log created by StartPerformanceMeasurementEx and EndPerformanceMeasurementEx,

+  and then eliminate the Identifier.

+

+  Attempts to retrieve the performance log entry specified by LogEntryKey.  If LogEntryKey is

+  zero on entry, then an attempt is made to retrieve the first entry from the performance log,

+  and the key for the second entry in the log is returned.  If the performance log is empty,

+  then no entry is retrieved and zero is returned.  If LogEntryKey is not zero, then the performance

+  log entry associated with LogEntryKey is retrieved, and the key for the next entry in the log is

+  returned.  If LogEntryKey is the key for the last entry in the log, then the last log entry is

+  retrieved and an implementation specific non-zero key value that specifies the end of the performance

+  log is returned.  If LogEntryKey is equal this implementation specific non-zero key value, then no entry

+  is retrieved and zero is returned.  In the cases where a performance log entry can be returned,

+  the log entry is returned in Handle, Token, Module, StartTimeStamp, and EndTimeStamp.

+  If LogEntryKey is not a valid log entry key for the performance measurement log, then ASSERT().

+  If Handle is NULL, then ASSERT().

+  If Token is NULL, then ASSERT().

+  If Module is NULL, then ASSERT().

+  If StartTimeStamp is NULL, then ASSERT().

+  If EndTimeStamp is NULL, then ASSERT().

+

+  @param  LogEntryKey             On entry, the key of the performance measurement log entry to retrieve.

+                                  0, then the first performance measurement log entry is retrieved.

+                                  On exit, the key of the next performance log entry.

+  @param  Handle                  Pointer to environment specific context used to identify the component

+                                  being measured.

+  @param  Token                   Pointer to a Null-terminated ASCII string that identifies the component

+                                  being measured.

+  @param  Module                  Pointer to a Null-terminated ASCII string that identifies the module

+                                  being measured.

+  @param  StartTimeStamp          Pointer to the 64-bit time stamp that was recorded when the measurement

+                                  was started.

+  @param  EndTimeStamp            Pointer to the 64-bit time stamp that was recorded when the measurement

+                                  was ended.

+

+  @return The key for the next performance log entry (in general case).

+

+**/

+UINTN

+EFIAPI

+GetPerformanceMeasurement (

+  IN  UINTN       LogEntryKey,

+  OUT CONST VOID  **Handle,

+  OUT CONST CHAR8 **Token,

+  OUT CONST CHAR8 **Module,

+  OUT UINT64      *StartTimeStamp,

+  OUT UINT64      *EndTimeStamp

+  )

+{

+  UINT32 Identifier;

+  return GetPerformanceMeasurementEx (LogEntryKey, Handle, Token, Module, StartTimeStamp, EndTimeStamp, &Identifier);

+}

+

+/**

   Returns TRUE if the performance measurement macros are enabled.

 

   This function returns TRUE if the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of

diff --git a/MdeModulePkg/Library/DxeSmmPerformanceLib/DxeSmmPerformanceLib.inf b/MdeModulePkg/Library/DxeSmmPerformanceLib/DxeSmmPerformanceLib.inf
index 997187c38f..5fdaf051af 100644
--- a/MdeModulePkg/Library/DxeSmmPerformanceLib/DxeSmmPerformanceLib.inf
+++ b/MdeModulePkg/Library/DxeSmmPerformanceLib/DxeSmmPerformanceLib.inf
@@ -2,9 +2,10 @@
 #  Performance library instance used in DXE phase to dump SMM performance data.

 #  

 #  This library instance allows a DXE driver or UEFI application to dump the SMM performance data.

-#  StartPerformanceMeasurement() and EndPerformanceMeasurement() are not implemented.

+#  StartPerformanceMeasurement(), EndPerformanceMeasurement(), StartPerformanceMeasurementEx()

+#  and EndPerformanceMeasurementEx() are not implemented.

 #  

-#  Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>

+#  Copyright (c) 2011 - 2012, 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

@@ -48,7 +49,8 @@
   MemoryAllocationLib

 

 [Guids]

-  gSmmPerformanceProtocolGuid            ## CONSUMES

+  gSmmPerformanceProtocolGuid            ## SOMETIMES_CONSUMES

+  gSmmPerformanceExProtocolGuid          ## SOMETIMES_CONSUMES

 

 [Protocols]

   gEfiSmmCommunicationProtocolGuid       ## CONSUMES