Add performance library instances for SMM performance measurement.

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

2 files changed, 353 insertions, 0 deletions

diff --git a/MdeModulePkg/Library/SmmPerformanceLib/SmmPerformanceLib.c b/MdeModulePkg/Library/SmmPerformanceLib/SmmPerformanceLib.c
new file mode 100644
index 0000000000..982d8ac43a
--- /dev/null
+++ b/MdeModulePkg/Library/SmmPerformanceLib/SmmPerformanceLib.c
@@ -0,0 +1,290 @@
+/** @file

+  Performance Library used in SMM phase.

+

+  This library instance provides infrastructure for SMM drivers to log performance

+  data. It consumes SMM Performance Protocol published by SmmCorePerformanceLib

+  to log performance data. If Performance Protocol is not available, it does not log any

+  performance information.

+

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

+This program and the accompanying materials

+are licensed and made available under the terms and conditions of the BSD License

+which accompanies this distribution.  The full text of the license may be found at

+http://opensource.org/licenses/bsd-license.php

+

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+

+

+#include <Guid/Performance.h>

+

+#include <Library/PerformanceLib.h>

+#include <Library/DebugLib.h>

+#include <Library/SmmServicesTableLib.h>

+#include <Library/PcdLib.h>

+#include <Library/BaseMemoryLib.h>

+

+#include <Protocol/SmmCommunication.h>

+

+//

+// The cached performance protocol interface.

+//

+PERFORMANCE_PROTOCOL  *mPerformance = NULL;

+BOOLEAN               mPerformanceMeasurementEnabled;

+

+

+/**

+  The constructor function initializes Performance infrastructure for DXE phase.

+

+  The constructor function publishes Performance protocol, allocates memory to log DXE performance

+  and merges PEI performance data to DXE performance log.

+  It will ASSERT() if one of these operations fails and it will always return EFI_SUCCESS.

+

+  @param  ImageHandle   The firmware allocated handle for the EFI image.

+  @param  SystemTable   A pointer to the EFI System Table.

+

+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.

+

+**/

+EFI_STATUS

+EFIAPI

+SmmPerformanceLibConstructor (

+  IN EFI_HANDLE        ImageHandle,

+  IN EFI_SYSTEM_TABLE  *SystemTable

+  )

+{

+  

+  mPerformanceMeasurementEnabled =  (BOOLEAN) ((PcdGet8(PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0);

+

+  return EFI_SUCCESS;

+}

+

+/**

+  The constructor function caches the pointer to Performance protocol.

+

+  The constructor function locates SMM erformance protocol from the SMM protocol database.

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

+

+  @retval EFI_SUCCESS     Performance protocol is successfully located.

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

+

+**/

+EFI_STATUS

+GetPerformanceProtocol (

+  VOID

+  )

+{

+  EFI_STATUS            Status;

+  PERFORMANCE_PROTOCOL  *Performance;

+

+  if (mPerformance != NULL) {

+    return EFI_SUCCESS;

+  }

+

+  Status = gSmst->SmmLocateProtocol (&gSmmPerformanceProtocolGuid, NULL, (VOID **) &Performance);

+  if (!EFI_ERROR (Status)) {

+    ASSERT (Performance != NULL);

+    //

+    // Cache performance protocol.

+    //

+    mPerformance = Performance;

+  }

+

+  return Status;

+}

+

+/**

+  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

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

+

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

+StartPerformanceMeasurement (

+  IN CONST VOID   *Handle,  OPTIONAL

+  IN CONST CHAR8  *Token,   OPTIONAL

+  IN CONST CHAR8  *Module,  OPTIONAL

+  IN UINT64       TimeStamp

+  )

+{

+  EFI_STATUS  Status;

+

+  Status = GetPerformanceProtocol ();

+  if (EFI_ERROR (Status)) {

+    return RETURN_OUT_OF_RESOURCES;

+  }

+

+  Status = mPerformance->StartGauge (Handle, Token, Module, TimeStamp);

+

+  return (RETURN_STATUS) Status;

+}

+

+/**

+  Fills in the end time of a performance measurement.

+

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

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

+  If this function is called multiple times for the same record, then the end time is overwritten.

+

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

+

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

+EndPerformanceMeasurement (

+  IN CONST VOID   *Handle,  OPTIONAL

+  IN CONST CHAR8  *Token,   OPTIONAL

+  IN CONST CHAR8  *Module,  OPTIONAL

+  IN UINT64       TimeStamp

+  )

+{

+  EFI_STATUS  Status;

+

+  Status = GetPerformanceProtocol ();

+  if (EFI_ERROR (Status)) {

+    return RETURN_NOT_FOUND;

+  }

+

+  Status = mPerformance->EndGauge (Handle, Token, Module, TimeStamp);

+

+  return (RETURN_STATUS) Status;

+}

+

+/**

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

+

+  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

+  )

+{

+  EFI_STATUS        Status;

+  GAUGE_DATA_ENTRY  *GaugeData;

+	

+  GaugeData = NULL;

+

+  ASSERT (Handle != NULL);

+  ASSERT (Token != NULL);

+  ASSERT (Module != NULL);

+  ASSERT (StartTimeStamp != NULL);

+  ASSERT (EndTimeStamp != NULL);

+

+  Status = GetPerformanceProtocol ();

+  if (EFI_ERROR (Status)) {

+    return 0;

+  }

+

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

+

+  //

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

+  //

+  ASSERT (Status != EFI_INVALID_PARAMETER);

+

+  if (EFI_ERROR (Status)) {

+    //

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

+    //

+    return 0;

+  }

+

+  ASSERT (GaugeData != NULL);

+

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

+  *Token          = GaugeData->Token;

+  *Module         = GaugeData->Module;

+  *StartTimeStamp = GaugeData->StartTimeStamp;

+  *EndTimeStamp   = GaugeData->EndTimeStamp;

+

+}

+

+/**

+  Returns TRUE if the performance measurement macros are enabled.

+

+  This function returns TRUE if the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of

+  PcdPerformanceLibraryPropertyMask is set.  Otherwise FALSE is returned.

+

+  @retval TRUE                    The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of

+                                  PcdPerformanceLibraryPropertyMask is set.

+  @retval FALSE                   The PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of

+                                  PcdPerformanceLibraryPropertyMask is clear.

+

+**/

+BOOLEAN

+EFIAPI

+PerformanceMeasurementEnabled (

+  VOID

+  )

+{

+  return mPerformanceMeasurementEnabled;

+}

diff --git a/MdeModulePkg/Library/SmmPerformanceLib/SmmPerformanceLib.inf b/MdeModulePkg/Library/SmmPerformanceLib/SmmPerformanceLib.inf
new file mode 100644
index 0000000000..9397fec368
--- /dev/null
+++ b/MdeModulePkg/Library/SmmPerformanceLib/SmmPerformanceLib.inf
@@ -0,0 +1,63 @@
+## @file

+#  Performance library instance used in SMM phase.

+#  

+#  This library instance provides infrastructure for SMM drivers to log performance

+#  data. It consumes SMM Performance Protocol published by SmmCorePerformanceLib

+#  to log performance data. If Performance Protocol is not available, it does not log any

+#  performance information.

+#  

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

+#  This program and the accompanying materials

+#  are licensed and made available under the terms and conditions of the BSD License

+#  which accompanies this distribution.  The full text of the license may be found at

+#  http://opensource.org/licenses/bsd-license.php

+#  

+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+#  

+##

+

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = SmmPerformanceLib

+  FILE_GUID                      = 1EDD13E6-D0CD-4432-A692-FF65C9B4F039

+  MODULE_TYPE                    = DXE_SMM_DRIVER

+  VERSION_STRING                 = 1.0

+  LIBRARY_CLASS                  = PerformanceLib|DXE_SMM_DRIVER

+

+  CONSTRUCTOR                    = SmmPerformanceLibConstructor

+

+#

+# The following information is for reference only and not required by the build tools.

+#

+#  VALID_ARCHITECTURES           = IA32 X64

+#

+

+[Sources]

+  SmmPerformanceLib.c

+

+

+[Packages]

+  MdePkg/MdePkg.dec

+  MdeModulePkg/MdeModulePkg.dec

+

+

+[LibraryClasses]

+  PcdLib

+  SmmServicesTableLib

+  DebugLib

+  BaseMemoryLib

+

+[Protocols]

+  gEfiSmmCommunicationProtocolGuid      ## CONSUMES

+

+

+[Guids]

+  gSmmPerformanceProtocolGuid           ## CONSUMES

+

+

+[Pcd]

+  gEfiMdePkgTokenSpaceGuid.PcdPerformanceLibraryPropertyMask

+

+[Depex]

+  gEfiSmmCommunicationProtocolGuid