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, 533 insertions, 0 deletions

diff --git a/MdeModulePkg/Library/PeiPerformanceLib/PeiPerformanceLib.c b/MdeModulePkg/Library/PeiPerformanceLib/PeiPerformanceLib.c
new file mode 100644
index 0000000000..aa231849f6
--- /dev/null
+++ b/MdeModulePkg/Library/PeiPerformanceLib/PeiPerformanceLib.c
@@ -0,0 +1,352 @@
+/*++

+

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

+

+  PeiPerformanceLib.c

+

+Abstract:

+

+  Performance Library

+

+--*/

+

+//

+// The package level header files this module uses

+//

+#include <PiPei.h>

+//

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

+//

+#include <Guid/PeiPerformanceHob.h>

+//

+// The Library classes this module consumes

+//

+#include <Library/PerformanceLib.h>

+#include <Library/DebugLib.h>

+#include <Library/HobLib.h>

+#include <Library/BaseLib.h>

+#include <Library/TimerLib.h>

+#include <Library/PcdLib.h>

+#include <Library/BaseMemoryLib.h>

+

+

+/**

+  Gets PEI the GUID HOB for PEI performance.

+

+  This internal function searches for the GUID HOB for PEI performance.

+  If that GUID HOB is not found, it will build a new one.

+  It returns the data area of that GUID HOB to record performance log.

+

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

+

+  @retval The index of log entry in the array.

+

+**/

+STATIC

+PEI_PERFORMANCE_LOG_HEADER *

+InternalGetPerformanceHobLog (

+  VOID

+  )

+{

+  EFI_HOB_GUID_TYPE           *GuidHob;

+  PEI_PERFORMANCE_LOG_HEADER  *PeiPerformanceLog;

+  UINTN                       PeiPerformanceLogSize;

+

+  GuidHob = GetFirstGuidHob (&gPeiPerformanceHobGuid);

+

+  if (GuidHob != NULL) {

+    //

+    // PEI Performance HOB was found, then return the existing one.

+    //

+    PeiPerformanceLog = GET_GUID_HOB_DATA (GuidHob);

+  } else {

+    //

+    // PEI Performance HOB was not found, then build one.

+    //

+    PeiPerformanceLogSize = sizeof (PEI_PERFORMANCE_LOG_HEADER) +

+                            sizeof (PEI_PERFORMANCE_LOG_ENTRY) * PcdGet8 (PcdMaxPeiPerformanceLogEntries);

+    PeiPerformanceLog     = BuildGuidHob (&gPeiPerformanceHobGuid, PeiPerformanceLogSize);

+    PeiPerformanceLog     = ZeroMem (PeiPerformanceLog, PeiPerformanceLogSize);

+  }

+

+  return PeiPerformanceLog;

+}

+

+/**

+  Searches in the log array with keyword Handle, Token and Module.

+

+  This internal function searches for the log entry in the log array.

+  If there is an entry that exactly matches the given key word triple

+  and its end time stamp is zero, then the index of that log entry is returned;

+  otherwise, the the number of log entries in the array is returned.

+

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

+

+  @retval The index of log entry in the array.

+

+**/

+STATIC

+UINT32

+InternalSearchForLogEntry (

+  IN PEI_PERFORMANCE_LOG_HEADER *PeiPerformanceLog,

+  IN CONST VOID                 *Handle,  OPTIONAL

+  IN CONST CHAR8                *Token,   OPTIONAL

+  IN CONST CHAR8                *Module   OPTIONAL

+  )

+{

+  UINT32                    Index;

+  UINT32                    NumberOfEntries;

+  PEI_PERFORMANCE_LOG_ENTRY *LogEntryArray;

+

+

+  if (Token == NULL) {

+    Token = "";

+  }

+  if (Module == NULL) {

+    Module = "";

+  }

+  NumberOfEntries = PeiPerformanceLog->NumberOfEntries;

+  LogEntryArray   = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);

+

+  for (Index = 0; Index < NumberOfEntries; Index++) {

+    if ((LogEntryArray[Index].Handle == (EFI_PHYSICAL_ADDRESS) (UINTN) Handle) &&

+         AsciiStrnCmp (LogEntryArray[Index].Token, Token, PEI_PERFORMANCE_STRING_LENGTH) == 0 &&

+         AsciiStrnCmp (LogEntryArray[Index].Module, Module, PEI_PERFORMANCE_STRING_LENGTH) == 0 &&

+         LogEntryArray[Index].EndTimeStamp == 0

+       ) {

+      break;

+    }

+  }

+  return Index;

+}

+

+/**

+  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

+  )

+{

+  PEI_PERFORMANCE_LOG_HEADER  *PeiPerformanceLog;

+  PEI_PERFORMANCE_LOG_ENTRY   *LogEntryArray;

+  UINT32                      Index;

+

+  PeiPerformanceLog = InternalGetPerformanceHobLog ();

+

+  if (PeiPerformanceLog->NumberOfEntries >= PcdGet8 (PcdMaxPeiPerformanceLogEntries)) {

+    return RETURN_OUT_OF_RESOURCES;

+  }

+  Index                       = PeiPerformanceLog->NumberOfEntries++;

+  LogEntryArray               = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);

+  LogEntryArray[Index].Handle = (EFI_PHYSICAL_ADDRESS) (UINTN) Handle;

+

+  if (Token != NULL) {

+    AsciiStrnCpy (LogEntryArray[Index].Token, Token, PEI_PERFORMANCE_STRING_LENGTH);

+  }

+  if (Module != NULL) {

+    AsciiStrnCpy (LogEntryArray[Index].Module, Module, PEI_PERFORMANCE_STRING_LENGTH);

+  }

+

+  if (TimeStamp == 0) {

+    TimeStamp = GetPerformanceCounter ();

+  }

+  LogEntryArray[Index].StartTimeStamp = TimeStamp;

+

+  return RETURN_SUCCESS;

+}

+

+/**

+  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

+  )

+{

+  PEI_PERFORMANCE_LOG_HEADER  *PeiPerformanceLog;

+  PEI_PERFORMANCE_LOG_ENTRY   *LogEntryArray;

+  UINT32                      Index;

+

+  if (TimeStamp == 0) {

+    TimeStamp = GetPerformanceCounter ();

+  }

+

+  PeiPerformanceLog = InternalGetPerformanceHobLog ();

+  Index             = InternalSearchForLogEntry (PeiPerformanceLog, Handle, Token, Module);

+  if (Index >= PeiPerformanceLog->NumberOfEntries) {

+    return RETURN_NOT_FOUND;

+  }

+  LogEntryArray     = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);

+  LogEntryArray[Index].EndTimeStamp = TimeStamp;

+

+  return RETURN_SUCCESS;

+}

+

+/**

+  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

+  )

+{

+  PEI_PERFORMANCE_LOG_HEADER  *PeiPerformanceLog;

+  PEI_PERFORMANCE_LOG_ENTRY   *CurrentLogEntry;

+  PEI_PERFORMANCE_LOG_ENTRY   *LogEntryArray;

+  UINTN                       NumberOfEntries;

+

+  ASSERT (Handle != NULL);

+  ASSERT (Token != NULL);

+  ASSERT (Module != NULL);

+  ASSERT (StartTimeStamp != NULL);

+  ASSERT (EndTimeStamp != NULL);

+

+  PeiPerformanceLog = InternalGetPerformanceHobLog ();

+

+  NumberOfEntries   = (UINTN) (PeiPerformanceLog->NumberOfEntries);

+  LogEntryArray     = (PEI_PERFORMANCE_LOG_ENTRY *) (PeiPerformanceLog + 1);

+  //

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

+  //

+  ASSERT (LogEntryKey <= NumberOfEntries);

+

+  if (LogEntryKey == NumberOfEntries) {

+    return 0;

+  }

+

+  CurrentLogEntry = &(LogEntryArray[LogEntryKey++]);

+

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

+  *Token          = CurrentLogEntry->Token;

+  *Module         = CurrentLogEntry->Module;

+  *StartTimeStamp = CurrentLogEntry->StartTimeStamp;

+  *EndTimeStamp   = CurrentLogEntry->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/PeiPerformanceLib/PeiPerformanceLib.inf b/MdeModulePkg/Library/PeiPerformanceLib/PeiPerformanceLib.inf
new file mode 100644
index 0000000000..07c08413d6
--- /dev/null
+++ b/MdeModulePkg/Library/PeiPerformanceLib/PeiPerformanceLib.inf
@@ -0,0 +1,105 @@
+#/** @file

+# Memory-only library functions with no library constructor/destructor

+#

+# This module provides the performance measurement interfaces in PEI phase, it is one instance of Performance Libarary.

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

+#

+#

+#**/

+

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

+#

+# Defines Section - statements that will be processed to create a Makefile.

+#

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

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = PeiPerformanceLib

+  FILE_GUID                      = F72DE735-B24F-4ef6-897F-70A85D01A047

+  MODULE_TYPE                    = PEIM

+  VERSION_STRING                 = 1.0

+  LIBRARY_CLASS                  = PerformanceLib|PEIM PEI_CORE

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

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

+  BaseMemoryLib

+  PcdLib

+  TimerLib

+  BaseLib

+  HobLib

+  DebugLib

+

+

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

+#

+# Guid C Name Section - list of Guids that this module uses or produces.

+#

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

+

+[Guids]

+  gPeiPerformanceHobGuid                        # SOMETIMES_CONSUMED

+

+

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

+#

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

+#

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

+

+[PcdsFixedAtBuild.common]

+  PcdPerformanceLibraryPropertyMask|gEfiMdePkgTokenSpaceGuid

+

+

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

+#

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

+#

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

+

+[PcdsDynamic.common]

+  PcdMaxPeiPerformanceLogEntries|gEfiEdkModulePkgTokenSpaceGuid

+

diff --git a/MdeModulePkg/Library/PeiPerformanceLib/PeiPerformanceLib.msa b/MdeModulePkg/Library/PeiPerformanceLib/PeiPerformanceLib.msa
new file mode 100644
index 0000000000..85ce0ad520
--- /dev/null
+++ b/MdeModulePkg/Library/PeiPerformanceLib/PeiPerformanceLib.msa
@@ -0,0 +1,76 @@
+<?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>PeiPerformanceLib</ModuleName>

+    <ModuleType>PEIM</ModuleType>

+    <GuidValue>F72DE735-B24F-4ef6-897F-70A85D01A047</GuidValue>

+    <Version>1.0</Version>

+    <Abstract>Memory-only library functions with no library constructor/destructor</Abstract>

+    <Description>This module provides the performance measurement interfaces in PEI phase, it is one instance of Performance Libarary.</Description>

+    <Copyright>Copyright (c) 2006, 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>PeiPerformanceLib</OutputFileBasename>

+  </ModuleDefinitions>

+  <LibraryClassDefinitions>

+    <LibraryClass Usage="ALWAYS_PRODUCED" SupModuleList="PEIM PEI_CORE">

+      <Keyword>PerformanceLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>DebugLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>HobLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>BaseLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>TimerLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>PcdLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>BaseMemoryLib</Keyword>

+    </LibraryClass>

+  </LibraryClassDefinitions>

+  <SourceFiles>

+    <Filename>PeiPerformanceLib.c</Filename>

+  </SourceFiles>

+  <PackageDependencies>

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

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

+  </PackageDependencies>

+  <Guids>

+    <GuidCNames Usage="SOMETIMES_CONSUMED">

+      <GuidCName>gPeiPerformanceHobGuid</GuidCName>

+    </GuidCNames>

+  </Guids>

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

+    <PcdEntry PcdItemType="DYNAMIC">

+      <C_Name>PcdMaxPeiPerformanceLogEntries</C_Name>

+      <TokenSpaceGuidCName>gEfiEdkModulePkgTokenSpaceGuid</TokenSpaceGuidCName>

+      <HelpText>Maximun number of performance log entries during PEI phase.</HelpText>

+    </PcdEntry>

+  </PcdCoded>

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