StdLib: Fix some corrupted comments and inconsistent indentation.

[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 - 2010, 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
  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
  FreePool (StringDpOptionQh);\r
  FreePool (StringDpOptionLh);\r
  FreePool (StringDpOptionUh);\r
  FreePool (StringDpOptionLv);\r
  FreePool (StringDpOptionUs);\r
  FreePool (StringDpOptionLs);\r
  FreePool (StringDpOptionUa);\r
  FreePool (StringDpOptionUr);\r
  FreePool (StringDpOptionUt);\r
  FreePool (StringDpOptionUp);\r
  FreePool (StringDpOptionLx);\r
  FreePool (StringDpOptionLn);\r
  FreePool (StringDpOptionLt);  \r
  FreePool (StringPtr);\r
  FreePool (mPrintTokenBuffer);\r
  \r
  HiiRemovePackages (gHiiHandle);\r
  return Status;\r
}\r