ShellPkg: Add "dp" command library to ShellPkg.

This command is only included in the build with command line option "-D INCLUDE_DP".  The user must also update the DSC with appropriate library instances that match the platform for the build to succeed.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jaben Carsey <jaben.carsey@intel.com>
Reviewed-by: Erik Bjorge <erik.c.bjorge@intel.com>

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

1 files changed, 310 insertions, 0 deletions

diff --git a/ShellPkg/Library/UefiDpLib/Dp.c b/ShellPkg/Library/UefiDpLib/Dp.c
new file mode 100644
index 0000000000..b5a6e7a713
--- /dev/null
+++ b/ShellPkg/Library/UefiDpLib/Dp.c
@@ -0,0 +1,310 @@
+/** @file

+  Shell command for Displaying Performance Metrics.

+

+  The Dp command reads performance data and presents it in several

+  different formats depending upon the needs of the user.  Both

+  Trace and Measured Profiling information is processed and presented.

+

+  Dp uses the "PerformanceLib" to read the measurement records.

+  The "TimerLib" provides information about the timer, such as frequency,

+  beginning, and ending counter values.

+  Measurement records contain identifying information (Handle, Token, Module)

+  and start and end time values.

+  Dp uses this information to group records in different ways.  It also uses

+  timer information to calculate elapsed time for each measurement.

+ 

+  Copyright (c) 2009 - 2013, 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.

+**/

+

+#include "UefiDpLib.h"

+#include <Guid/GlobalVariable.h>

+#include <Library/PrintLib.h>

+#include <Library/HandleParsingLib.h>

+#include <Library/DevicePathLib.h>

+

+#include <Library/ShellLib.h>

+#include <Library/BaseLib.h>

+#include <Library/MemoryAllocationLib.h>

+#include <Library/DebugLib.h>

+#include <Library/TimerLib.h>

+#include <Library/UefiLib.h>

+

+#include <Guid/Performance.h>

+

+#include <PerformanceTokens.h>

+#include "Dp.h"

+#include "Literals.h"

+#include "DpInternal.h"

+

+//

+/// Module-Global Variables

+///@{

+CHAR16           mGaugeString[DP_GAUGE_STRING_LENGTH + 1];

+CHAR16           mUnicodeToken[DXE_PERFORMANCE_STRING_SIZE];

+UINT64           mInterestThreshold;

+BOOLEAN          mShowId = FALSE;

+

+PERF_SUMMARY_DATA SummaryData = { 0 };    ///< Create the SummaryData structure and init. to ZERO.

+

+/// Timer Specific Information.

+TIMER_INFO TimerInfo;

+

+/// Items for which to gather cumulative statistics.

+PERF_CUM_DATA CumData[] = {

+  PERF_INIT_CUM_DATA (LOAD_IMAGE_TOK),

+  PERF_INIT_CUM_DATA (START_IMAGE_TOK),

+  PERF_INIT_CUM_DATA (DRIVERBINDING_START_TOK),

+  PERF_INIT_CUM_DATA (DRIVERBINDING_SUPPORT_TOK)

+};

+

+/// Number of items for which we are gathering cumulative statistics.

+UINT32 const      NumCum = sizeof(CumData) / sizeof(PERF_CUM_DATA);

+

+STATIC CONST SHELL_PARAM_ITEM ParamList[] = {

+  {L"-v", TypeFlag},   // -v   Verbose Mode

+  {L"-A", TypeFlag},   // -A   All, Cooked

+  {L"-R", TypeFlag},   // -R   RAW All

+  {L"-s", TypeFlag},   // -s   Summary

+#if PROFILING_IMPLEMENTED

+  {L"-P", TypeFlag},   // -P   Dump Profile Data

+  {L"-T", TypeFlag},   // -T   Dump Trace Data

+#endif // PROFILING_IMPLEMENTED

+  {L"-x", TypeFlag},   // -x   eXclude Cumulative Items

+  {L"-i", TypeFlag},   // -i   Display Identifier

+  {L"-n", TypeValue},  // -n # Number of records to display for A and R

+  {L"-t", TypeValue},  // -t # Threshold of interest

+  {NULL, TypeMax}

+  };

+

+///@}

+

+/**

+   Display the trailing Verbose information.

+**/

+VOID

+DumpStatistics( void )

+{

+  EFI_STRING                StringPtr;

+  EFI_STRING                StringPtrUnknown;

+  StringPtr        = HiiGetString (gDpHiiHandle, STRING_TOKEN (STR_DP_SECTION_STATISTICS), NULL);

+  StringPtrUnknown = HiiGetString (gDpHiiHandle, STRING_TOKEN (STR_ALIT_UNKNOWN), NULL);

+  ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DP_SECTION_HEADER), gDpHiiHandle,

+              (StringPtr == NULL) ? StringPtrUnknown : StringPtr);

+  ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DP_STATS_NUMTRACE), gDpHiiHandle,      SummaryData.NumTrace);

+  ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DP_STATS_NUMINCOMPLETE), gDpHiiHandle, SummaryData.NumIncomplete);

+  ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DP_STATS_NUMPHASES), gDpHiiHandle,     SummaryData.NumSummary);

+  ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DP_STATS_NUMHANDLES), gDpHiiHandle,    SummaryData.NumHandles, SummaryData.NumTrace - SummaryData.NumHandles);

+  ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DP_STATS_NUMPEIMS), gDpHiiHandle,      SummaryData.NumPEIMs);

+  ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DP_STATS_NUMGLOBALS), gDpHiiHandle,    SummaryData.NumGlobal);

+#if PROFILING_IMPLEMENTED

+  ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DP_STATS_NUMPROFILE), gDpHiiHandle,    SummaryData.NumProfile);

+#endif // PROFILING_IMPLEMENTED

+  SHELL_FREE_NON_NULL (StringPtr);

+  SHELL_FREE_NON_NULL (StringPtrUnknown);

+}

+

+/** 

+  Dump performance data.

+  

+  @param[in]  ImageHandle     The image handle.

+  @param[in]  SystemTable     The system table.

+  

+  @retval EFI_SUCCESS            Command completed successfully.

+  @retval EFI_INVALID_PARAMETER  Command usage error.

+  @retval value                  Unknown error.

+  

+**/

+SHELL_STATUS

+EFIAPI

+ShellCommandRunDp (

+  IN EFI_HANDLE               ImageHandle,

+  IN EFI_SYSTEM_TABLE         *SystemTable

+  )

+{

+  LIST_ENTRY                *ParamPackage;

+  CONST CHAR16              *CmdLineArg;

+  EFI_STATUS                Status;

+

+  UINT64                    Freq;

+  UINT64                    Ticker;

+  UINTN                     Number2Display;

+

+  EFI_STRING                StringPtr   = NULL;

+  BOOLEAN                   SummaryMode = FALSE;

+  BOOLEAN                   VerboseMode = FALSE;

+  BOOLEAN                   AllMode     = FALSE;

+  BOOLEAN                   RawMode     = FALSE;

+  BOOLEAN                   TraceMode   = FALSE;

+  BOOLEAN                   ProfileMode = FALSE;

+  BOOLEAN                   ExcludeMode = FALSE;

+

+  // Get DP's entry time as soon as possible.

+  // This is used as the Shell-Phase end time.

+  //

+  Ticker  = GetPerformanceCounter ();

+

+  //

+  // initialize the shell lib (we must be in non-auto-init...)

+  //

+  Status = ShellInitialize();

+  ASSERT_EFI_ERROR(Status);

+

+  Status = CommandInit();

+  ASSERT_EFI_ERROR(Status);

+

+  //

+  // Process Command Line arguments

+  //

+  Status = ShellCommandLineParse (ParamList, &ParamPackage, NULL, TRUE);

+  if (EFI_ERROR(Status)) {

+    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DP_INVALID_ARG), gDpHiiHandle);

+    return SHELL_INVALID_PARAMETER;

+  }

+

+  //

+  // Boolean options

+  //

+  VerboseMode = ShellCommandLineGetFlag (ParamPackage, L"-v");

+  SummaryMode = (BOOLEAN) (ShellCommandLineGetFlag (ParamPackage, L"-S") || ShellCommandLineGetFlag (ParamPackage, L"-s"));

+  AllMode     = ShellCommandLineGetFlag (ParamPackage, L"-A");

+  RawMode     = ShellCommandLineGetFlag (ParamPackage, L"-R");

+#if PROFILING_IMPLEMENTED

+  TraceMode   = ShellCommandLineGetFlag (ParamPackage, L"-T");

+  ProfileMode = ShellCommandLineGetFlag (ParamPackage, L"-P");

+#endif  // PROFILING_IMPLEMENTED

+  ExcludeMode = ShellCommandLineGetFlag (ParamPackage, L"-x");

+  mShowId     = ShellCommandLineGetFlag (ParamPackage, L"-i");

+

+  // Options with Values

+  CmdLineArg  = ShellCommandLineGetValue (ParamPackage, L"-n");

+  if (CmdLineArg == NULL) {

+    Number2Display = DEFAULT_DISPLAYCOUNT;

+  } else {

+    Number2Display = StrDecimalToUintn(CmdLineArg);

+    if (Number2Display == 0) {

+      Number2Display = MAXIMUM_DISPLAYCOUNT;

+    }

+  }

+

+  CmdLineArg  = ShellCommandLineGetValue (ParamPackage, L"-t");

+  if (CmdLineArg == NULL) {

+    mInterestThreshold = DEFAULT_THRESHOLD;  // 1ms := 1,000 us

+  } else {

+    mInterestThreshold = StrDecimalToUint64(CmdLineArg);

+  }

+

+  // Handle Flag combinations and default behaviors

+  // If both TraceMode and ProfileMode are FALSE, set them both to TRUE

+  if ((! TraceMode) && (! ProfileMode)) {

+    TraceMode   = TRUE;

+#if PROFILING_IMPLEMENTED

+    ProfileMode = TRUE;

+#endif  // PROFILING_IMPLEMENTED

+  }

+

+  //

+  // Timer specific processing

+  //

+  // Get the Performance counter characteristics:

+  //          Freq = Frequency in Hz

+  //    StartCount = Value loaded into the counter when it starts counting

+  //      EndCount = Value counter counts to before it needs to be reset

+  //

+  Freq = GetPerformanceCounterProperties (&TimerInfo.StartCount, &TimerInfo.EndCount);

+

+  // Convert the Frequency from Hz to KHz

+  TimerInfo.Frequency = (UINT32)DivU64x32 (Freq, 1000);

+

+  // Determine in which direction the performance counter counts.

+  TimerInfo.CountUp = (BOOLEAN) (TimerInfo.EndCount >= TimerInfo.StartCount);

+

+  //

+  // Print header

+  //

+  // print DP's build version

+  ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DP_BUILD_REVISION), gDpHiiHandle, DP_MAJOR_VERSION, DP_MINOR_VERSION);

+

+  // print performance timer characteristics

+  ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DP_KHZ), gDpHiiHandle, TimerInfo.Frequency);

+

+  if (VerboseMode && !RawMode) {

+    StringPtr = HiiGetString (gDpHiiHandle,

+                  (EFI_STRING_ID) (TimerInfo.CountUp ? STRING_TOKEN (STR_DP_UP) : STRING_TOKEN (STR_DP_DOWN)), NULL);

+    ASSERT (StringPtr != NULL);

+    // Print Timer count range and direction

+    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DP_TIMER_PROPERTIES), gDpHiiHandle,

+                StringPtr,

+                TimerInfo.StartCount,

+                TimerInfo.EndCount

+                );

+    ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DP_VERBOSE_THRESHOLD), gDpHiiHandle, mInterestThreshold);

+  }

+

+/****************************************************************************

+****            Print Sections based on command line options

+****

+****  Option modes have the following priority:

+****    v Verbose     --  Valid in combination with any other options

+****    t Threshold   --  Modifies All, Raw, and Cooked output

+****                      Default is 0 for All and Raw mode

+****                      Default is DEFAULT_THRESHOLD for "Cooked" mode

+****    n Number2Display  Used by All and Raw mode.  Otherwise ignored.

+****    A All         --  R and S options are ignored

+****    R Raw         --  S option is ignored

+****    s Summary     --  Modifies "Cooked" output only

+****    Cooked (Default)

+****

+****  The All, Raw, and Cooked modes are modified by the Trace and Profile

+****  options.

+****    !T && !P  := (0) Default, Both are displayed

+****     T && !P  := (1) Only Trace records are displayed

+****    !T &&  P  := (2) Only Profile records are displayed

+****     T &&  P  := (3) Same as Default, both are displayed

+****************************************************************************/

+  GatherStatistics();

+  if (AllMode) {

+    if (TraceMode) {

+      DumpAllTrace( Number2Display, ExcludeMode);

+    }

+    if (ProfileMode) {

+      DumpAllProfile( Number2Display, ExcludeMode);

+    }

+  } else if (RawMode) {

+    if (TraceMode) {

+      DumpRawTrace( Number2Display, ExcludeMode);

+    }

+    if (ProfileMode) {

+      DumpRawProfile( Number2Display, ExcludeMode);

+    }

+  } else {

+    //------------- Begin Cooked Mode Processing

+    if (TraceMode) {

+      ProcessPhases ( Ticker );

+      if ( ! SummaryMode) {

+        Status = ProcessHandles ( ExcludeMode);

+        if ( ! EFI_ERROR( Status)) {

+          ProcessPeims ();

+          ProcessGlobal ();

+          ProcessCumulative ();

+        }

+      }

+    }

+    if (ProfileMode) {

+      DumpAllProfile( Number2Display, ExcludeMode);

+    }

+  } //------------- End of Cooked Mode Processing

+  if ( VerboseMode || SummaryMode) {

+    DumpStatistics();

+  }

+

+  SHELL_FREE_NON_NULL (StringPtr);

+

+  return SHELL_SUCCESS;

+}