[mirror_edk2.git] / PerformancePkg / Dp_App / Dp.c

/** @file\r
  * Shell application for Displaying Performance Metrics.\r
  *\r
  * The Dp application reads performance data and presents it in several\r
  * different formats depending upon the needs of the user.  Both\r
  * Trace and Measured Profiling information is processed and presented.\r
  *\r
  * Dp uses the "PerformanceLib" to read the measurement records.\r
  * The "TimerLib" provides information about the timer, such as frequency,\r
  * beginning, and ending counter values.\r
  * Measurement records contain identifying information (Handle, Token, Module)\r
  * and start and end time values.\r
  * Dp uses this information to group records in different ways.  It also uses\r
  * timer information to calculate elapsed time for each measurement.\r
  *\r
  * Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
  * This program and the accompanying materials\r
  * are licensed and made available under the terms and conditions of the BSD License\r
  * which accompanies this distribution.  The full text of the license may be found at\r
  * http://opensource.org/licenses/bsd-license.php\r
  *\r
  * THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  * WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
**/\r
\r
#include <Library/UefiApplicationEntryPoint.h>\r
#include <Library/ShellLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/PcdLib.h>\r
\r
#include <Guid/Performance.h>\r
\r
#include <PerformanceTokens.h>\r
#include "Dp.h"\r
#include "Literals.h"\r
#include "DpInternal.h"\r
\r
//\r
/// Module-Global Variables\r
///@{\r
EFI_HII_HANDLE   gHiiHandle;\r
SHELL_PARAM_ITEM *DpParamList       = NULL;\r
CHAR16           *mPrintTokenBuffer = NULL;\r
CHAR16           mGaugeString[DXE_PERFORMANCE_STRING_SIZE];\r
CHAR16           mUnicodeToken[PERF_TOKEN_LENGTH + 1];\r
UINT64           mInterestThreshold;\r
\r
PERF_SUMMARY_DATA SummaryData = { 0 };    ///< Create the SummaryData structure and init. to ZERO.\r
\r
/// Timer Specific Information.\r
TIMER_INFO TimerInfo;\r
\r
/// Items for which to gather cumulative statistics.\r
PERF_CUM_DATA CumData[] = {\r
  PERF_INIT_CUM_DATA (LOAD_IMAGE_TOK),\r
  PERF_INIT_CUM_DATA (START_IMAGE_TOK),\r
  PERF_INIT_CUM_DATA (DRIVERBINDING_START_TOK),\r
  PERF_INIT_CUM_DATA (DRIVERBINDING_SUPPORT_TOK)\r
};\r
\r
/// Number of items for which we are gathering cumulative statistics.\r
UINT32 const      NumCum = sizeof(CumData) / sizeof(PERF_CUM_DATA);\r
\r
PARAM_ITEM_LIST  ParamList[] = {\r
  {STRING_TOKEN (STR_DP_OPTION_QH), TypeFlag},   // -?   Help\r
  {STRING_TOKEN (STR_DP_OPTION_LH), TypeFlag},   // -h   Help\r
  {STRING_TOKEN (STR_DP_OPTION_UH), TypeFlag},   // -H   Help\r
  {STRING_TOKEN (STR_DP_OPTION_LV), TypeFlag},   // -v   Verbose Mode\r
  {STRING_TOKEN (STR_DP_OPTION_UA), TypeFlag},   // -A   All, Cooked\r
  {STRING_TOKEN (STR_DP_OPTION_UR), TypeFlag},   // -R   RAW All\r
  {STRING_TOKEN (STR_DP_OPTION_LS), TypeFlag},   // -s   Summary\r
#if PROFILING_IMPLEMENTED\r
  {STRING_TOKEN (STR_DP_OPTION_UP), TypeFlag},   // -P   Dump Profile Data\r
  {STRING_TOKEN (STR_DP_OPTION_UT), TypeFlag},   // -T   Dump Trace Data\r
#endif\r
  {STRING_TOKEN (STR_DP_OPTION_LX), TypeFlag},   // -x   eXclude Cumulative Items\r
  {STRING_TOKEN (STR_DP_OPTION_LN), TypeValue},  // -n # Number of records to display for A and R\r
  {STRING_TOKEN (STR_DP_OPTION_LT), TypeValue}   // -t # Threshold of interest\r
  };\r
\r
///@}\r
\r
/**\r
  Wrap original FreePool to check NULL pointer first.\r
\r
  @param[in]    Buffer      The pointer to the buffer to free.\r
\r
**/\r
VOID\r
SafeFreePool (\r
  IN VOID   *Buffer\r
  )\r
{\r
  if (Buffer != NULL) {\r
    FreePool (Buffer);\r
  }\r
}\r
\r
/**\r
  Transfer the param list value and get the command line parse.\r
\r
**/\r
VOID\r
InitialShellParamList( void )\r
{\r
  UINT32            ListIndex;\r
  UINT32            ListLength;  \r
\r
  //\r
  // Allocate one more for the end tag.\r
  //\r
  ListLength = sizeof (ParamList) / sizeof (ParamList[0]) + 1;  \r
  DpParamList = AllocatePool (sizeof (SHELL_PARAM_ITEM) * ListLength);\r
  ASSERT (DpParamList != NULL);\r
  \r
  for (ListIndex = 0; ListIndex < ListLength - 1; ListIndex ++)\r
  { \r
    DpParamList[ListIndex].Name = HiiGetString (gHiiHandle, ParamList[ListIndex].Token, NULL);      \r
    DpParamList[ListIndex].Type = ParamList[ListIndex].Type;\r
  }\r
  DpParamList[ListIndex].Name = NULL;\r
  DpParamList[ListIndex].Type = TypeMax;\r
}\r
\r
/**\r
   Display Usage and Help information.\r
**/\r
VOID\r
ShowHelp( void )\r
{\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_HEAD));\r
#if PROFILING_IMPLEMENTED\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_FLAGS));\r
#else\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_FLAGS_2));\r
#endif // PROFILING_IMPLEMENTED\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_PAGINATE));\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_VERBOSE));\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_EXCLUDE));\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_STAT));\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_ALL));\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_RAW));\r
#if PROFILING_IMPLEMENTED\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_TRACE));\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_PROFILE));\r
#endif // PROFILING_IMPLEMENTED\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_THRESHOLD));\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_COUNT));\r
  PrintToken (STRING_TOKEN (STR_DP_HELP_HELP));\r
  Print(L"\n");\r
}\r
\r
/**\r
   Display the trailing Verbose information.\r
**/\r
VOID\r
DumpStatistics( void )\r
{\r
  EFI_STRING                StringPtr;\r
  EFI_STRING                StringPtrUnknown;\r
  StringPtr        = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_SECTION_STATISTICS), NULL);\r
  StringPtrUnknown = HiiGetString (gHiiHandle, STRING_TOKEN (STR_ALIT_UNKNOWN), NULL);  \r
  PrintToken( STRING_TOKEN (STR_DP_SECTION_HEADER),\r
              (StringPtr == NULL) ? StringPtrUnknown : StringPtr);\r
\r
  PrintToken( STRING_TOKEN (STR_DP_STATS_NUMTRACE),       SummaryData.NumTrace);\r
  PrintToken( STRING_TOKEN (STR_DP_STATS_NUMINCOMPLETE),  SummaryData.NumIncomplete);\r
  PrintToken( STRING_TOKEN (STR_DP_STATS_NUMPHASES),      SummaryData.NumSummary);\r
  PrintToken( STRING_TOKEN (STR_DP_STATS_NUMHANDLES),     SummaryData.NumHandles, SummaryData.NumTrace - SummaryData.NumHandles);\r
  PrintToken( STRING_TOKEN (STR_DP_STATS_NUMPEIMS),       SummaryData.NumPEIMs);\r
  PrintToken( STRING_TOKEN (STR_DP_STATS_NUMGLOBALS),     SummaryData.NumGlobal);\r
#if PROFILING_IMPLEMENTED\r
  PrintToken( STRING_TOKEN (STR_DP_STATS_NUMPROFILE),     SummaryData.NumProfile);\r
#endif // PROFILING_IMPLEMENTED\r
  FreePool (StringPtr);\r
  FreePool (StringPtrUnknown);\r
}\r
\r
/** \r
  Dump performance data.\r
  \r
  @param[in]  ImageHandle     The image handle.\r
  @param[in]  SystemTable     The system table.\r
  \r
  @retval EFI_SUCCESS            Command completed successfully.\r
  @retval EFI_INVALID_PARAMETER  Command usage error.\r
  @retval value                  Unknown error.\r
  \r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeDp (\r
  IN EFI_HANDLE               ImageHandle,\r
  IN EFI_SYSTEM_TABLE         *SystemTable\r
  )\r
{\r
  UINT64                    Freq;\r
  UINT64                    Ticker;\r
  UINT32                    ListIndex;\r
  \r
  LIST_ENTRY                *ParamPackage;\r
  CONST CHAR16              *CmdLineArg;\r
  EFI_STRING                StringPtr;\r
  UINTN                     Number2Display;\r
\r
  EFI_STATUS                Status;\r
  BOOLEAN                   SummaryMode;\r
  BOOLEAN                   VerboseMode;\r
  BOOLEAN                   AllMode;\r
  BOOLEAN                   RawMode;\r
  BOOLEAN                   TraceMode;\r
  BOOLEAN                   ProfileMode;\r
  BOOLEAN                   ExcludeMode;\r
\r
  EFI_STRING                StringDpOptionQh;\r
  EFI_STRING                StringDpOptionLh;\r
  EFI_STRING                StringDpOptionUh;\r
  EFI_STRING                StringDpOptionLv;\r
  EFI_STRING                StringDpOptionUs;\r
  EFI_STRING                StringDpOptionLs;\r
  EFI_STRING                StringDpOptionUa;\r
  EFI_STRING                StringDpOptionUr;\r
  EFI_STRING                StringDpOptionUt;\r
  EFI_STRING                StringDpOptionUp;\r
  EFI_STRING                StringDpOptionLx;\r
  EFI_STRING                StringDpOptionLn;\r
  EFI_STRING                StringDpOptionLt;\r
  \r
  SummaryMode     = FALSE;\r
  VerboseMode     = FALSE;\r
  AllMode         = FALSE;\r
  RawMode         = FALSE;\r
  TraceMode       = FALSE;\r
  ProfileMode     = FALSE;\r
  ExcludeMode     = FALSE;\r
\r
  StringDpOptionQh = NULL;\r
  StringDpOptionLh = NULL;\r
  StringDpOptionUh = NULL;\r
  StringDpOptionLv = NULL;\r
  StringDpOptionUs = NULL;\r
  StringDpOptionLs = NULL;\r
  StringDpOptionUa = NULL;\r
  StringDpOptionUr = NULL;\r
  StringDpOptionUt = NULL;\r
  StringDpOptionUp = NULL;\r
  StringDpOptionLx = NULL;\r
  StringDpOptionLn = NULL;\r
  StringDpOptionLt = NULL;\r
  StringPtr        = NULL;\r
\r
  // Get DP's entry time as soon as possible.\r
  // This is used as the Shell-Phase end time.\r
  //\r
  Ticker  = GetPerformanceCounter ();\r
\r
  // Register our string package with HII and return the handle to it.\r
  //\r
  gHiiHandle = HiiAddPackages (&gEfiCallerIdGuid, ImageHandle, DPStrings, NULL);\r
  ASSERT (gHiiHandle != NULL);\r
\r
  // Initial the command list\r
  //\r
  InitialShellParamList ();\r
  \r
/****************************************************************************\r
****            Process Command Line arguments                           ****\r
****************************************************************************/\r
  Status = ShellCommandLineParse (DpParamList, &ParamPackage, NULL, TRUE);\r
\r
  if (EFI_ERROR(Status)) {\r
    PrintToken (STRING_TOKEN (STR_DP_INVALID_ARG));\r
    ShowHelp();\r
  }\r
  else {\r
    StringDpOptionQh = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_QH), NULL);\r
    StringDpOptionLh = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_LH), NULL);\r
    StringDpOptionUh = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_UH), NULL);\r
    \r
    if (ShellCommandLineGetFlag (ParamPackage, StringDpOptionQh)  ||\r
        ShellCommandLineGetFlag (ParamPackage, StringDpOptionLh)  ||\r
        ShellCommandLineGetFlag (ParamPackage, StringDpOptionUh))\r
    {\r
      ShowHelp();\r
    }\r
    else {\r
      StringDpOptionLv = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_LV), NULL);\r
      StringDpOptionUs = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_US), NULL);\r
      StringDpOptionLs = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_LS), NULL);\r
      StringDpOptionUa = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_UA), NULL);\r
      StringDpOptionUr = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_UR), NULL);\r
      StringDpOptionUt = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_UT), NULL);\r
      StringDpOptionUp = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_UP), NULL);\r
      StringDpOptionLx = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_LX), NULL);\r
      StringDpOptionLn = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_LN), NULL);\r
      StringDpOptionLt = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_LT), NULL);\r
      \r
      // Boolean Options\r
      // \r
      VerboseMode = ShellCommandLineGetFlag (ParamPackage, StringDpOptionLv);\r
      SummaryMode = (BOOLEAN) (ShellCommandLineGetFlag (ParamPackage, StringDpOptionUs) ||\r
                    ShellCommandLineGetFlag (ParamPackage, StringDpOptionLs));\r
      AllMode     = ShellCommandLineGetFlag (ParamPackage, StringDpOptionUa);\r
      RawMode     = ShellCommandLineGetFlag (ParamPackage, StringDpOptionUr);\r
#if PROFILING_IMPLEMENTED\r
      TraceMode   = ShellCommandLineGetFlag (ParamPackage, StringDpOptionUt);\r
      ProfileMode = ShellCommandLineGetFlag (ParamPackage, StringDpOptionUp);\r
#endif  // PROFILING_IMPLEMENTED\r
      ExcludeMode = ShellCommandLineGetFlag (ParamPackage, StringDpOptionLx);\r
\r
      // Options with Values\r
      CmdLineArg  = ShellCommandLineGetValue (ParamPackage, StringDpOptionLn);\r
      if (CmdLineArg == NULL) {\r
        Number2Display = DEFAULT_DISPLAYCOUNT;\r
      }\r
      else {\r
        Number2Display = StrDecimalToUintn(CmdLineArg);\r
        if (Number2Display == 0) {\r
          Number2Display = MAXIMUM_DISPLAYCOUNT;\r
        }\r
      }\r
      CmdLineArg  = ShellCommandLineGetValue (ParamPackage, StringDpOptionLt);\r
      if (CmdLineArg == NULL) {\r
        mInterestThreshold = DEFAULT_THRESHOLD;  // 1ms := 1,000 us\r
      }\r
      else {\r
        mInterestThreshold = StrDecimalToUint64(CmdLineArg);\r
      }\r
      // Handle Flag combinations and default behaviors\r
      // If both TraceMode and ProfileMode are FALSE, set them both to TRUE\r
      if ((! TraceMode) && (! ProfileMode)) {\r
        TraceMode   = TRUE;\r
#if PROFILING_IMPLEMENTED\r
        ProfileMode = TRUE;\r
#endif  // PROFILING_IMPLEMENTED\r
      }\r
\r
/****************************************************************************\r
****            Timer specific processing                                ****\r
****************************************************************************/\r
      // Get the Performance counter characteristics:\r
      //          Freq = Frequency in Hz\r
      //    StartCount = Value loaded into the counter when it starts counting\r
      //      EndCount = Value counter counts to before it needs to be reset\r
      //\r
      Freq = GetPerformanceCounterProperties (&TimerInfo.StartCount, &TimerInfo.EndCount);\r
\r
      // Convert the Frequency from Hz to KHz\r
      TimerInfo.Frequency = (UINT32)DivU64x32 (Freq, 1000);\r
\r
      // Determine in which direction the performance counter counts.\r
      TimerInfo.CountUp = (BOOLEAN) (TimerInfo.EndCount >= TimerInfo.StartCount);\r
\r
/****************************************************************************\r
****            Print heading                                            ****\r
****************************************************************************/\r
      // print DP's build version\r
      PrintToken (STRING_TOKEN (STR_DP_BUILD_REVISION), DP_MAJOR_VERSION, DP_MINOR_VERSION);\r
\r
      // print performance timer characteristics\r
      PrintToken (STRING_TOKEN (STR_DP_KHZ), TimerInfo.Frequency);         // Print Timer frequency in KHz\r
\r
      if ((VerboseMode)   &&\r
          (! RawMode)\r
         ) {\r
        StringPtr = HiiGetString (gHiiHandle,\r
                      (EFI_STRING_ID) (TimerInfo.CountUp ? STRING_TOKEN (STR_DP_UP) : STRING_TOKEN (STR_DP_DOWN)),\r
                      NULL);\r
        ASSERT (StringPtr != NULL);\r
        PrintToken (STRING_TOKEN (STR_DP_TIMER_PROPERTIES),   // Print Timer count range and direction\r
                    StringPtr,\r
                    TimerInfo.StartCount,\r
                    TimerInfo.EndCount\r
                    );\r
        PrintToken (STRING_TOKEN (STR_DP_VERBOSE_THRESHOLD), mInterestThreshold);\r
      }\r
\r
/* **************************************************************************\r
****            Print Sections based on command line options\r
****\r
****  Option modes have the following priority:\r
****    v Verbose     --  Valid in combination with any other options\r
****    t Threshold   --  Modifies All, Raw, and Cooked output\r
****                      Default is 0 for All and Raw mode\r
****                      Default is DEFAULT_THRESHOLD for "Cooked" mode\r
****    n Number2Display  Used by All and Raw mode.  Otherwise ignored.\r
****    A All         --  R and S options are ignored\r
****    R Raw         --  S option is ignored\r
****    s Summary     --  Modifies "Cooked" output only\r
****    Cooked (Default)\r
****\r
****  The All, Raw, and Cooked modes are modified by the Trace and Profile\r
****  options.\r
****    !T && !P  := (0) Default, Both are displayed\r
****     T && !P  := (1) Only Trace records are displayed\r
****    !T &&  P  := (2) Only Profile records are displayed\r
****     T &&  P  := (3) Same as Default, both are displayed\r
****************************************************************************/\r
      GatherStatistics();\r
      if (AllMode) {\r
        if (TraceMode) {\r
          DumpAllTrace( Number2Display, ExcludeMode);\r
        }\r
        if (ProfileMode) {\r
          DumpAllProfile( Number2Display, ExcludeMode);\r
        }\r
      }\r
      else if (RawMode) {\r
        if (TraceMode) {\r
          DumpRawTrace( Number2Display, ExcludeMode);\r
        }\r
        if (ProfileMode) {\r
          DumpRawProfile( Number2Display, ExcludeMode);\r
        }\r
      }\r
      else {\r
        //------------- Begin Cooked Mode Processing\r
        if (TraceMode) {\r
          ProcessPhases ( Ticker );\r
          if ( ! SummaryMode) {\r
            Status = ProcessHandles ( ExcludeMode);\r
            if ( ! EFI_ERROR( Status)) {\r
              ProcessPeims (     );\r
              ProcessGlobal (    );\r
              ProcessCumulative ();\r
            }\r
          }\r
        }\r
        if (ProfileMode) {\r
          DumpAllProfile( Number2Display, ExcludeMode);\r
        }\r
      } //------------- End of Cooked Mode Processing\r
      if ( VerboseMode || SummaryMode) {\r
        DumpStatistics();\r
      }\r
    }\r
  }\r
\r
  // Free the memory allocate from HiiGetString\r
  //\r
  ListIndex = 0;\r
  while (DpParamList[ListIndex].Name != NULL) {\r
    FreePool (DpParamList[ListIndex].Name);\r
    ListIndex ++;\r
  }  \r
  FreePool (DpParamList);\r
\r
  SafeFreePool (StringDpOptionQh);\r
  SafeFreePool (StringDpOptionLh);\r
  SafeFreePool (StringDpOptionUh);\r
  SafeFreePool (StringDpOptionLv);\r
  SafeFreePool (StringDpOptionUs);\r
  SafeFreePool (StringDpOptionLs);\r
  SafeFreePool (StringDpOptionUa);\r
  SafeFreePool (StringDpOptionUr);\r
  SafeFreePool (StringDpOptionUt);\r
  SafeFreePool (StringDpOptionUp);\r
  SafeFreePool (StringDpOptionLx);\r
  SafeFreePool (StringDpOptionLn);\r
  SafeFreePool (StringDpOptionLt);\r
  SafeFreePool (StringPtr);\r
  SafeFreePool (mPrintTokenBuffer);\r
\r
  HiiRemovePackages (gHiiHandle);\r
  return Status;\r
}\r
Commit	Line	Data
c06ad33e	1	/** @file\r
	2	* Shell application for Displaying Performance Metrics.\r
	3	*\r
	4	* The Dp application reads performance data and presents it in several\r
	5	* different formats depending upon the needs of the user. Both\r
	6	* Trace and Measured Profiling information is processed and presented.\r
	7	*\r
	8	* Dp uses the "PerformanceLib" to read the measurement records.\r
	9	* The "TimerLib" provides information about the timer, such as frequency,\r
	10	* beginning, and ending counter values.\r
	11	* Measurement records contain identifying information (Handle, Token, Module)\r
	12	* and start and end time values.\r
	13	* Dp uses this information to group records in different ways. It also uses\r
	14	* timer information to calculate elapsed time for each measurement.\r
	15	*\r
cdd95292	16	* Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
c06ad33e	17	* This program and the accompanying materials\r
	18	* are licensed and made available under the terms and conditions of the BSD License\r
	19	* which accompanies this distribution. The full text of the license may be found at\r
	20	* http://opensource.org/licenses/bsd-license.php\r
	21	*\r
	22	* THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	23	* WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	24	**/\r
	25	\r
	26	#include <Library/UefiApplicationEntryPoint.h>\r
	27	#include <Library/ShellLib.h>\r
	28	#include <Library/BaseLib.h>\r
	29	#include <Library/MemoryAllocationLib.h>\r
	30	#include <Library/DebugLib.h>\r
	31	#include <Library/TimerLib.h>\r
	32	#include <Library/UefiLib.h>\r
	33	#include <Library/HiiLib.h>\r
	34	#include <Library/PcdLib.h>\r
	35	\r
	36	#include <Guid/Performance.h>\r
	37	\r
	38	#include <PerformanceTokens.h>\r
	39	#include "Dp.h"\r
	40	#include "Literals.h"\r
	41	#include "DpInternal.h"\r
	42	\r
	43	//\r
	44	/// Module-Global Variables\r
9dd74618	45	///@{\r
c06ad33e	46	EFI_HII_HANDLE gHiiHandle;\r
88359546	47	SHELL_PARAM_ITEM *DpParamList = NULL;\r
c06ad33e	48	CHAR16 *mPrintTokenBuffer = NULL;\r
	49	CHAR16 mGaugeString[DXE_PERFORMANCE_STRING_SIZE];\r
	50	CHAR16 mUnicodeToken[PERF_TOKEN_LENGTH + 1];\r
	51	UINT64 mInterestThreshold;\r
	52	\r
	53	PERF_SUMMARY_DATA SummaryData = { 0 }; ///< Create the SummaryData structure and init. to ZERO.\r
	54	\r
	55	/// Timer Specific Information.\r
	56	TIMER_INFO TimerInfo;\r
	57	\r
	58	/// Items for which to gather cumulative statistics.\r
	59	PERF_CUM_DATA CumData[] = {\r
	60	PERF_INIT_CUM_DATA (LOAD_IMAGE_TOK),\r
	61	PERF_INIT_CUM_DATA (START_IMAGE_TOK),\r
	62	PERF_INIT_CUM_DATA (DRIVERBINDING_START_TOK),\r
	63	PERF_INIT_CUM_DATA (DRIVERBINDING_SUPPORT_TOK)\r
	64	};\r
	65	\r
	66	/// Number of items for which we are gathering cumulative statistics.\r
	67	UINT32 const NumCum = sizeof(CumData) / sizeof(PERF_CUM_DATA);\r
	68	\r
88359546 ED	69	PARAM_ITEM_LIST ParamList[] = {\r
	70	{STRING_TOKEN (STR_DP_OPTION_QH), TypeFlag}, // -? Help\r
	71	{STRING_TOKEN (STR_DP_OPTION_LH), TypeFlag}, // -h Help\r
	72	{STRING_TOKEN (STR_DP_OPTION_UH), TypeFlag}, // -H Help\r
	73	{STRING_TOKEN (STR_DP_OPTION_LV), TypeFlag}, // -v Verbose Mode\r
	74	{STRING_TOKEN (STR_DP_OPTION_UA), TypeFlag}, // -A All, Cooked\r
	75	{STRING_TOKEN (STR_DP_OPTION_UR), TypeFlag}, // -R RAW All\r
	76	{STRING_TOKEN (STR_DP_OPTION_LS), TypeFlag}, // -s Summary\r
c06ad33e	77	#if PROFILING_IMPLEMENTED\r
88359546 ED	78	{STRING_TOKEN (STR_DP_OPTION_UP), TypeFlag}, // -P Dump Profile Data\r
88359546 ED	79	{STRING_TOKEN (STR_DP_OPTION_UT), TypeFlag}, // -T Dump Trace Data\r
c06ad33e	80	#endif\r
88359546 ED	81	{STRING_TOKEN (STR_DP_OPTION_LX), TypeFlag}, // -x eXclude Cumulative Items\r
	82	{STRING_TOKEN (STR_DP_OPTION_LN), TypeValue}, // -n # Number of records to display for A and R\r
	83	{STRING_TOKEN (STR_DP_OPTION_LT), TypeValue} // -t # Threshold of interest\r
c06ad33e	84	};\r
c06ad33e	85	\r
9dd74618	86	///@}\r
c06ad33e	87	\r
cdd95292 SZ	88	/**\r
cdd95292 SZ	89	Wrap original FreePool to check NULL pointer first.\r
18d37b82 SZ	90	\r
	91	@param[in] Buffer The pointer to the buffer to free.\r
	92	\r
cdd95292 SZ	93	**/\r
	94	VOID\r
	95	SafeFreePool (\r
	96	IN VOID *Buffer\r
	97	)\r
	98	{\r
	99	if (Buffer != NULL) {\r
	100	FreePool (Buffer);\r
	101	}\r
	102	}\r
	103	\r
88359546 ED	104	/**\r
	105	Transfer the param list value and get the command line parse.\r
	106	\r
	107	**/\r
	108	VOID\r
	109	InitialShellParamList( void )\r
	110	{\r
	111	UINT32 ListIndex;\r
	112	UINT32 ListLength; \r
	113	\r
	114	//\r
	115	// Allocate one more for the end tag.\r
	116	//\r
	117	ListLength = sizeof (ParamList) / sizeof (ParamList[0]) + 1; \r
	118	DpParamList = AllocatePool (sizeof (SHELL_PARAM_ITEM) * ListLength);\r
	119	ASSERT (DpParamList != NULL);\r
	120	\r
	121	for (ListIndex = 0; ListIndex < ListLength - 1; ListIndex ++)\r
	122	{ \r
	123	DpParamList[ListIndex].Name = HiiGetString (gHiiHandle, ParamList[ListIndex].Token, NULL); \r
	124	DpParamList[ListIndex].Type = ParamList[ListIndex].Type;\r
	125	}\r
	126	DpParamList[ListIndex].Name = NULL;\r
	127	DpParamList[ListIndex].Type = TypeMax;\r
	128	}\r
	129	\r
9dd74618 ED	130	/**\r
	131	Display Usage and Help information.\r
	132	**/\r
c06ad33e	133	VOID\r
	134	ShowHelp( void )\r
	135	{\r
	136	PrintToken (STRING_TOKEN (STR_DP_HELP_HEAD));\r
	137	#if PROFILING_IMPLEMENTED\r
	138	PrintToken (STRING_TOKEN (STR_DP_HELP_FLAGS));\r
	139	#else\r
	140	PrintToken (STRING_TOKEN (STR_DP_HELP_FLAGS_2));\r
	141	#endif // PROFILING_IMPLEMENTED\r
	142	PrintToken (STRING_TOKEN (STR_DP_HELP_PAGINATE));\r
	143	PrintToken (STRING_TOKEN (STR_DP_HELP_VERBOSE));\r
	144	PrintToken (STRING_TOKEN (STR_DP_HELP_EXCLUDE));\r
	145	PrintToken (STRING_TOKEN (STR_DP_HELP_STAT));\r
	146	PrintToken (STRING_TOKEN (STR_DP_HELP_ALL));\r
	147	PrintToken (STRING_TOKEN (STR_DP_HELP_RAW));\r
	148	#if PROFILING_IMPLEMENTED\r
	149	PrintToken (STRING_TOKEN (STR_DP_HELP_TRACE));\r
	150	PrintToken (STRING_TOKEN (STR_DP_HELP_PROFILE));\r
	151	#endif // PROFILING_IMPLEMENTED\r
	152	PrintToken (STRING_TOKEN (STR_DP_HELP_THRESHOLD));\r
	153	PrintToken (STRING_TOKEN (STR_DP_HELP_COUNT));\r
	154	PrintToken (STRING_TOKEN (STR_DP_HELP_HELP));\r
	155	Print(L"\n");\r
	156	}\r
	157	\r
9dd74618 ED	158	/**\r
	159	Display the trailing Verbose information.\r
	160	**/\r
c06ad33e	161	VOID\r
	162	DumpStatistics( void )\r
	163	{\r
	164	EFI_STRING StringPtr;\r
88359546 ED	165	EFI_STRING StringPtrUnknown;\r
	166	StringPtr = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_SECTION_STATISTICS), NULL);\r
	167	StringPtrUnknown = HiiGetString (gHiiHandle, STRING_TOKEN (STR_ALIT_UNKNOWN), NULL); \r
c06ad33e	168	PrintToken( STRING_TOKEN (STR_DP_SECTION_HEADER),\r
88359546	169	(StringPtr == NULL) ? StringPtrUnknown : StringPtr);\r
c06ad33e	170	\r
	171	PrintToken( STRING_TOKEN (STR_DP_STATS_NUMTRACE), SummaryData.NumTrace);\r
	172	PrintToken( STRING_TOKEN (STR_DP_STATS_NUMINCOMPLETE), SummaryData.NumIncomplete);\r
	173	PrintToken( STRING_TOKEN (STR_DP_STATS_NUMPHASES), SummaryData.NumSummary);\r
	174	PrintToken( STRING_TOKEN (STR_DP_STATS_NUMHANDLES), SummaryData.NumHandles, SummaryData.NumTrace - SummaryData.NumHandles);\r
	175	PrintToken( STRING_TOKEN (STR_DP_STATS_NUMPEIMS), SummaryData.NumPEIMs);\r
	176	PrintToken( STRING_TOKEN (STR_DP_STATS_NUMGLOBALS), SummaryData.NumGlobal);\r
	177	#if PROFILING_IMPLEMENTED\r
	178	PrintToken( STRING_TOKEN (STR_DP_STATS_NUMPROFILE), SummaryData.NumProfile);\r
	179	#endif // PROFILING_IMPLEMENTED\r
88359546 ED	180	FreePool (StringPtr);\r
88359546 ED	181	FreePool (StringPtrUnknown);\r
c06ad33e	182	}\r
c06ad33e	183	\r
9dd74618 ED	184	/** \r
	185	Dump performance data.\r
	186	\r
	187	@param[in] ImageHandle The image handle.\r
	188	@param[in] SystemTable The system table.\r
	189	\r
	190	@retval EFI_SUCCESS Command completed successfully.\r
	191	@retval EFI_INVALID_PARAMETER Command usage error.\r
	192	@retval value Unknown error.\r
	193	\r
c06ad33e	194	**/\r
	195	EFI_STATUS\r
	196	EFIAPI\r
	197	InitializeDp (\r
	198	IN EFI_HANDLE ImageHandle,\r
	199	IN EFI_SYSTEM_TABLE *SystemTable\r
	200	)\r
	201	{\r
	202	UINT64 Freq;\r
	203	UINT64 Ticker;\r
88359546 ED	204	UINT32 ListIndex;\r
88359546 ED	205	\r
c06ad33e	206	LIST_ENTRY *ParamPackage;\r
	207	CONST CHAR16 *CmdLineArg;\r
	208	EFI_STRING StringPtr;\r
	209	UINTN Number2Display;\r
	210	\r
	211	EFI_STATUS Status;\r
9dd74618 ED	212	BOOLEAN SummaryMode;\r
	213	BOOLEAN VerboseMode;\r
	214	BOOLEAN AllMode;\r
	215	BOOLEAN RawMode;\r
	216	BOOLEAN TraceMode;\r
	217	BOOLEAN ProfileMode;\r
	218	BOOLEAN ExcludeMode;\r
	219	\r
88359546 ED	220	EFI_STRING StringDpOptionQh;\r
	221	EFI_STRING StringDpOptionLh;\r
	222	EFI_STRING StringDpOptionUh;\r
	223	EFI_STRING StringDpOptionLv;\r
	224	EFI_STRING StringDpOptionUs;\r
	225	EFI_STRING StringDpOptionLs;\r
	226	EFI_STRING StringDpOptionUa;\r
	227	EFI_STRING StringDpOptionUr;\r
	228	EFI_STRING StringDpOptionUt;\r
	229	EFI_STRING StringDpOptionUp;\r
	230	EFI_STRING StringDpOptionLx;\r
	231	EFI_STRING StringDpOptionLn;\r
	232	EFI_STRING StringDpOptionLt;\r
	233	\r
9dd74618 ED	234	SummaryMode = FALSE;\r
	235	VerboseMode = FALSE;\r
	236	AllMode = FALSE;\r
	237	RawMode = FALSE;\r
	238	TraceMode = FALSE;\r
	239	ProfileMode = FALSE;\r
	240	ExcludeMode = FALSE;\r
88359546 ED	241	\r
	242	StringDpOptionQh = NULL;\r
	243	StringDpOptionLh = NULL;\r
	244	StringDpOptionUh = NULL;\r
	245	StringDpOptionLv = NULL;\r
	246	StringDpOptionUs = NULL;\r
	247	StringDpOptionLs = NULL;\r
	248	StringDpOptionUa = NULL;\r
	249	StringDpOptionUr = NULL;\r
	250	StringDpOptionUt = NULL;\r
	251	StringDpOptionUp = NULL;\r
	252	StringDpOptionLx = NULL;\r
	253	StringDpOptionLn = NULL;\r
	254	StringDpOptionLt = NULL;\r
	255	StringPtr = NULL;\r
	256	\r
c06ad33e	257	// Get DP's entry time as soon as possible.\r
	258	// This is used as the Shell-Phase end time.\r
	259	//\r
	260	Ticker = GetPerformanceCounter ();\r
	261	\r
	262	// Register our string package with HII and return the handle to it.\r
	263	//\r
	264	gHiiHandle = HiiAddPackages (&gEfiCallerIdGuid, ImageHandle, DPStrings, NULL);\r
	265	ASSERT (gHiiHandle != NULL);\r
	266	\r
88359546 ED	267	// Initial the command list\r
	268	//\r
	269	InitialShellParamList ();\r
	270	\r
c06ad33e	271	/****************************************************************************\r
	272	** Process Command Line arguments **\r
	273	****************************************************************************/\r
	274	Status = ShellCommandLineParse (DpParamList, &ParamPackage, NULL, TRUE);\r
	275	\r
	276	if (EFI_ERROR(Status)) {\r
	277	PrintToken (STRING_TOKEN (STR_DP_INVALID_ARG));\r
	278	ShowHelp();\r
	279	}\r
	280	else {\r
88359546 ED	281	StringDpOptionQh = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_QH), NULL);\r
	282	StringDpOptionLh = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_LH), NULL);\r
	283	StringDpOptionUh = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_UH), NULL);\r
	284	\r
	285	if (ShellCommandLineGetFlag (ParamPackage, StringDpOptionQh) \|\|\r
	286	ShellCommandLineGetFlag (ParamPackage, StringDpOptionLh) \|\|\r
	287	ShellCommandLineGetFlag (ParamPackage, StringDpOptionUh))\r
c06ad33e	288	{\r
	289	ShowHelp();\r
	290	}\r
	291	else {\r
88359546 ED	292	StringDpOptionLv = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_LV), NULL);\r
	293	StringDpOptionUs = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_US), NULL);\r
	294	StringDpOptionLs = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_LS), NULL);\r
	295	StringDpOptionUa = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_UA), NULL);\r
	296	StringDpOptionUr = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_UR), NULL);\r
	297	StringDpOptionUt = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_UT), NULL);\r
	298	StringDpOptionUp = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_UP), NULL);\r
	299	StringDpOptionLx = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_LX), NULL);\r
	300	StringDpOptionLn = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_LN), NULL);\r
	301	StringDpOptionLt = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_OPTION_LT), NULL);\r
	302	\r
c06ad33e	303	// Boolean Options\r
88359546 ED	304	// \r
88359546 ED	305	VerboseMode = ShellCommandLineGetFlag (ParamPackage, StringDpOptionLv);\r
aec905b7 ED	306	SummaryMode = (BOOLEAN) (ShellCommandLineGetFlag (ParamPackage, StringDpOptionUs) \|\|\r
aec905b7 ED	307	ShellCommandLineGetFlag (ParamPackage, StringDpOptionLs));\r
88359546 ED	308	AllMode = ShellCommandLineGetFlag (ParamPackage, StringDpOptionUa);\r
88359546 ED	309	RawMode = ShellCommandLineGetFlag (ParamPackage, StringDpOptionUr);\r
c06ad33e	310	#if PROFILING_IMPLEMENTED\r
88359546 ED	311	TraceMode = ShellCommandLineGetFlag (ParamPackage, StringDpOptionUt);\r
88359546 ED	312	ProfileMode = ShellCommandLineGetFlag (ParamPackage, StringDpOptionUp);\r
c06ad33e	313	#endif // PROFILING_IMPLEMENTED\r
88359546	314	ExcludeMode = ShellCommandLineGetFlag (ParamPackage, StringDpOptionLx);\r
c06ad33e	315	\r
c06ad33e	316	// Options with Values\r
88359546	317	CmdLineArg = ShellCommandLineGetValue (ParamPackage, StringDpOptionLn);\r
c06ad33e	318	if (CmdLineArg == NULL) {\r
	319	Number2Display = DEFAULT_DISPLAYCOUNT;\r
	320	}\r
	321	else {\r
	322	Number2Display = StrDecimalToUintn(CmdLineArg);\r
	323	if (Number2Display == 0) {\r
	324	Number2Display = MAXIMUM_DISPLAYCOUNT;\r
	325	}\r
	326	}\r
88359546	327	CmdLineArg = ShellCommandLineGetValue (ParamPackage, StringDpOptionLt);\r
c06ad33e	328	if (CmdLineArg == NULL) {\r
	329	mInterestThreshold = DEFAULT_THRESHOLD; // 1ms := 1,000 us\r
	330	}\r
	331	else {\r
	332	mInterestThreshold = StrDecimalToUint64(CmdLineArg);\r
	333	}\r
	334	// Handle Flag combinations and default behaviors\r
	335	// If both TraceMode and ProfileMode are FALSE, set them both to TRUE\r
	336	if ((! TraceMode) && (! ProfileMode)) {\r
	337	TraceMode = TRUE;\r
	338	#if PROFILING_IMPLEMENTED\r
	339	ProfileMode = TRUE;\r
	340	#endif // PROFILING_IMPLEMENTED\r
	341	}\r
	342	\r
	343	/****************************************************************************\r
	344	** Timer specific processing **\r
	345	****************************************************************************/\r
	346	// Get the Performance counter characteristics:\r
	347	// Freq = Frequency in Hz\r
	348	// StartCount = Value loaded into the counter when it starts counting\r
	349	// EndCount = Value counter counts to before it needs to be reset\r
	350	//\r
	351	Freq = GetPerformanceCounterProperties (&TimerInfo.StartCount, &TimerInfo.EndCount);\r
	352	\r
	353	// Convert the Frequency from Hz to KHz\r
	354	TimerInfo.Frequency = (UINT32)DivU64x32 (Freq, 1000);\r
	355	\r
	356	// Determine in which direction the performance counter counts.\r
	357	TimerInfo.CountUp = (BOOLEAN) (TimerInfo.EndCount >= TimerInfo.StartCount);\r
	358	\r
	359	/****************************************************************************\r
	360	** Print heading **\r
	361	****************************************************************************/\r
	362	// print DP's build version\r
	363	PrintToken (STRING_TOKEN (STR_DP_BUILD_REVISION), DP_MAJOR_VERSION, DP_MINOR_VERSION);\r
	364	\r
	365	// print performance timer characteristics\r
	366	PrintToken (STRING_TOKEN (STR_DP_KHZ), TimerInfo.Frequency); // Print Timer frequency in KHz\r
	367	\r
	368	if ((VerboseMode) &&\r
	369	(! RawMode)\r
	370	) {\r
	371	StringPtr = HiiGetString (gHiiHandle,\r
aec905b7	372	(EFI_STRING_ID) (TimerInfo.CountUp ? STRING_TOKEN (STR_DP_UP) : STRING_TOKEN (STR_DP_DOWN)),\r
c06ad33e	373	NULL);\r
	374	ASSERT (StringPtr != NULL);\r
	375	PrintToken (STRING_TOKEN (STR_DP_TIMER_PROPERTIES), // Print Timer count range and direction\r
	376	StringPtr,\r
	377	TimerInfo.StartCount,\r
	378	TimerInfo.EndCount\r
	379	);\r
	380	PrintToken (STRING_TOKEN (STR_DP_VERBOSE_THRESHOLD), mInterestThreshold);\r
	381	}\r
	382	\r
	383	/* **************************************************************************\r
	384	**** Print Sections based on command line options\r
	385	****\r
	386	**** Option modes have the following priority:\r
	387	**** v Verbose -- Valid in combination with any other options\r
	388	**** t Threshold -- Modifies All, Raw, and Cooked output\r
	389	**** Default is 0 for All and Raw mode\r
	390	**** Default is DEFAULT_THRESHOLD for "Cooked" mode\r
	391	**** n Number2Display Used by All and Raw mode. Otherwise ignored.\r
	392	**** A All -- R and S options are ignored\r
	393	**** R Raw -- S option is ignored\r
	394	**** s Summary -- Modifies "Cooked" output only\r
	395	**** Cooked (Default)\r
	396	****\r
	397	**** The All, Raw, and Cooked modes are modified by the Trace and Profile\r
	398	**** options.\r
	399	**** !T && !P := (0) Default, Both are displayed\r
	400	**** T && !P := (1) Only Trace records are displayed\r
	401	**** !T && P := (2) Only Profile records are displayed\r
	402	**** T && P := (3) Same as Default, both are displayed\r
	403	****************************************************************************/\r
	404	GatherStatistics();\r
	405	if (AllMode) {\r
	406	if (TraceMode) {\r
	407	DumpAllTrace( Number2Display, ExcludeMode);\r
	408	}\r
	409	if (ProfileMode) {\r
	410	DumpAllProfile( Number2Display, ExcludeMode);\r
	411	}\r
	412	}\r
	413	else if (RawMode) {\r
	414	if (TraceMode) {\r
	415	DumpRawTrace( Number2Display, ExcludeMode);\r
	416	}\r
	417	if (ProfileMode) {\r
	418	DumpRawProfile( Number2Display, ExcludeMode);\r
	419	}\r
	420	}\r
	421	else {\r
	422	//------------- Begin Cooked Mode Processing\r
	423	if (TraceMode) {\r
	424	ProcessPhases ( Ticker );\r
	425	if ( ! SummaryMode) {\r
	426	Status = ProcessHandles ( ExcludeMode);\r
	427	if ( ! EFI_ERROR( Status)) {\r
	428	ProcessPeims ( );\r
	429	ProcessGlobal ( );\r
	430	ProcessCumulative ();\r
	431	}\r
	432	}\r
	433	}\r
	434	if (ProfileMode) {\r
	435	DumpAllProfile( Number2Display, ExcludeMode);\r
	436	}\r
437	} //------------- End of Cooked Mode Processing\r
438	if ( VerboseMode \|\| SummaryMode) {\r
439	DumpStatistics();\r
440	}\r
441	}\r
442	}\r
88359546 ED	443	\r
	444	// Free the memory allocate from HiiGetString\r
	445	//\r
	446	ListIndex = 0;\r
	447	while (DpParamList[ListIndex].Name != NULL) {\r
	448	FreePool (DpParamList[ListIndex].Name);\r
	449	ListIndex ++;\r
	450	} \r
	451	FreePool (DpParamList);\r
cdd95292 SZ	452	\r
	453	SafeFreePool (StringDpOptionQh);\r
	454	SafeFreePool (StringDpOptionLh);\r
	455	SafeFreePool (StringDpOptionUh);\r
	456	SafeFreePool (StringDpOptionLv);\r
	457	SafeFreePool (StringDpOptionUs);\r
	458	SafeFreePool (StringDpOptionLs);\r
	459	SafeFreePool (StringDpOptionUa);\r
	460	SafeFreePool (StringDpOptionUr);\r
	461	SafeFreePool (StringDpOptionUt);\r
	462	SafeFreePool (StringDpOptionUp);\r
	463	SafeFreePool (StringDpOptionLx);\r
	464	SafeFreePool (StringDpOptionLn);\r
	465	SafeFreePool (StringDpOptionLt);\r
	466	SafeFreePool (StringPtr);\r
	467	SafeFreePool (mPrintTokenBuffer);\r
	468	\r
c06ad33e	469	HiiRemovePackages (gHiiHandle);\r
	470	return Status;\r
	471	}\r