Import DxeCorePerformanceLib DxePerformanceLib PeiPerformanceLib and EdkDxePrintLib

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

3 files changed, 421 insertions, 0 deletions

diff --git a/MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.c b/MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.c
new file mode 100644
index 0000000..fbfba26
--- /dev/null
+++ b/MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.c
@@ -0,0 +1,266 @@
+/*++

+

+Copyright (c) 2006, Intel Corporation

+All rights reserved. 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.             

+

+Module Name:

+

+  DxePerformanceLib.c

+

+Abstract:

+

+  Performance Library

+

+--*/

+

+//

+// The package level header files this module uses

+//

+#include <PiDxe.h>

+//

+// The protocols, PPI and GUID defintions for this module

+//

+#include <Protocol/Performance.h>

+//

+// The Library classes this module consumes

+//

+#include <Library/PerformanceLib.h>

+#include <Library/DebugLib.h>

+#include <Library/UefiBootServicesTableLib.h>

+#include <Library/PcdLib.h>

+

+STATIC PERFORMANCE_PROTOCOL    *mPerformance = NULL;

+

+/**

+  The constructor function caches the pointer to Performance protocol.

+

+  The constructor function locates Performance protocol from 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.

+

+**/

+STATIC

+EFI_STATUS

+GetPerformanceProtocol (

+  VOID

+  )

+{

+  EFI_STATUS            Status;

+  PERFORMANCE_PROTOCOL  *Performance;

+

+  if (mPerformance != NULL) {

+    return EFI_SUCCESS;

+  }

+

+  Status = gBS->LocateProtocol (&gPerformanceProtocolGuid, 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 lof entry 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;

+

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

+

+  return LogEntryKey;

+}

+

+/**

+  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 (BOOLEAN) ((PcdGet8(PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0);

+}

diff --git a/MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.inf b/MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.inf
new file mode 100644
index 0000000..95500f3
--- /dev/null
+++ b/MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.inf
@@ -0,0 +1,93 @@
+#/** @file

+# Component description file for Dxe Performance Library

+#

+# This library provides intrastructure for Dxe driver to log performance.

+# Copyright (c) 2006 - 2007, Intel Corporation

+#

+#  All rights reserved. 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 Section - statements that will be processed to create a Makefile.

+#

+################################################################################

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = DxePerformanceLib

+  FILE_GUID                      = 8B8B4CCC-65FC-41a5-8067-308B8E42CCF2

+  MODULE_TYPE                    = DXE_DRIVER

+  VERSION_STRING                 = 1.0

+  LIBRARY_CLASS                  = PerformanceLib|DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER

+  EDK_RELEASE_VERSION            = 0x00020000

+  EFI_SPECIFICATION_VERSION      = 0x00020000

+

+

+#

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

+#

+#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC

+#

+

+################################################################################

+#

+# Sources Section - list of files that are required for the build to succeed.

+#

+################################################################################

+

+[Sources.common]

+  DxePerformanceLib.c

+

+

+################################################################################

+#

+# Package Dependency Section - list of Package files that are required for

+#                              this module.

+#

+################################################################################

+

+[Packages]

+  MdePkg/MdePkg.dec

+  MdeModulePkg/MdeModulePkg.dec

+

+

+################################################################################

+#

+# Library Class Section - list of Library Classes that are required for

+#                         this module.

+#

+################################################################################

+

+[LibraryClasses]

+  PcdLib

+  UefiBootServicesTableLib

+  DebugLib

+

+

+################################################################################

+#

+# Protocol C Name Section - list of Protocol and Protocol Notify C Names

+#                           that this module uses or produces.

+#

+################################################################################

+

+[Protocols]

+  gPerformanceProtocolGuid                      # PROTOCOL ALWAYS_CONSUMED

+

+

+################################################################################

+#

+# Pcd FIXED_AT_BUILD - list of PCDs that this module is coded for.

+#

+################################################################################

+

+[PcdsFixedAtBuild.common]

+  PcdPerformanceLibraryPropertyMask|gEfiMdePkgTokenSpaceGuid

+

diff --git a/MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.msa b/MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.msa
new file mode 100644
index 0000000..3555a24
--- /dev/null
+++ b/MdeModulePkg/Library/DxePerformanceLib/DxePerformanceLib.msa
@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8"?>

+<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

+  <MsaHeader>

+    <ModuleName>DxePerformanceLib</ModuleName>

+    <ModuleType>DXE_DRIVER</ModuleType>

+    <GuidValue>8B8B4CCC-65FC-41a5-8067-308B8E42CCF2</GuidValue>

+    <Version>1.0</Version>

+    <Abstract>Component description file for Dxe Performance Library</Abstract>

+    <Description>This library provides intrastructure for Dxe driver to log performance.</Description>

+    <Copyright>Copyright (c) 2006 - 2007, Intel Corporation</Copyright>

+    <License>All rights reserved. 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.</License>

+    <Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00000052</Specification>

+  </MsaHeader>

+  <ModuleDefinitions>

+    <SupportedArchitectures>IA32 X64 IPF EBC</SupportedArchitectures>

+    <BinaryModule>false</BinaryModule>

+    <OutputFileBasename>DxePerformanceLib</OutputFileBasename>

+  </ModuleDefinitions>

+  <LibraryClassDefinitions>

+    <LibraryClass Usage="ALWAYS_PRODUCED" SupModuleList="DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER">

+      <Keyword>PerformanceLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>DebugLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>UefiBootServicesTableLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>PcdLib</Keyword>

+    </LibraryClass>

+  </LibraryClassDefinitions>

+  <SourceFiles>

+    <Filename>DxePerformanceLib.c</Filename>

+  </SourceFiles>

+  <PackageDependencies>

+    <Package PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec"/>

+    <Package PackageGuid="68169ab0-d41b-4009-9060-292c253ac43d"/>

+  </PackageDependencies>

+  <Protocols>

+    <Protocol Usage="ALWAYS_CONSUMED">

+      <ProtocolCName>gPerformanceProtocolGuid</ProtocolCName>

+    </Protocol>

+  </Protocols>

+  <Externs>

+    <Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>

+    <Specification>EDK_RELEASE_VERSION 0x00020000</Specification>

+  </Externs>

+  <PcdCoded>

+    <PcdEntry PcdItemType="FIXED_AT_BUILD">

+      <C_Name>PcdPerformanceLibraryPropertyMask</C_Name>

+      <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>

+      <HelpText>The bitmask of flags that specify the enable/disable of
+                Performance Measurement.</HelpText>

+    </PcdEntry>

+  </PcdCoded>

+</ModuleSurfaceArea>
\ No newline at end of file