ShellPkg/DynamicCommand/DpDynamicCommand/DpInternal.h

   1 /** @file
   2   Declarations of objects defined internally to the Dp Application.
   3
   4   Declarations of data and functions which are private to the Dp application.
   5   This file should never be referenced by anything other than components of the
   6   Dp application.  In addition to global data, function declarations for
   7   DpUtilities.c, DpTrace.c, and DpProfile.c are included here.
   8
   9   Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
  10   (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
  11   This program and the accompanying materials
  12   are licensed and made available under the terms and conditions of the BSD License
  13   which accompanies this distribution.  The full text of the license may be found at
  14   http://opensource.org/licenses/bsd-license.php
  15
  16   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  17   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  18 **/
  19 #ifndef _DP_INTELNAL_H_
  20 #define _DP_INTELNAL_H_
  21
  22 #define DP_GAUGE_STRING_LENGTH   36
  23
  24 //
  25 /// Module-Global Variables
  26 ///@{
  27 extern EFI_HII_HANDLE     mDpHiiHandle;
  28 extern CHAR16             mGaugeString[DP_GAUGE_STRING_LENGTH + 1];
  29 extern CHAR16             mUnicodeToken[DXE_PERFORMANCE_STRING_SIZE];
  30 extern UINT64             mInterestThreshold;
  31 extern BOOLEAN            mShowId;
  32 extern UINT8              *mBootPerformanceTable;
  33 extern UINTN              mBootPerformanceTableLength;
  34 extern MEASUREMENT_RECORD *mMeasurementList;
  35 extern UINTN              mMeasurementNum;
  36
  37 extern PERF_SUMMARY_DATA  SummaryData;    ///< Create the SummaryData structure and init. to ZERO.
  38
  39 /// Items for which to gather cumulative statistics.
  40 extern PERF_CUM_DATA      CumData[];
  41
  42 /// Number of items for which we are gathering cumulative statistics.
  43 extern UINT32 const       NumCum;
  44
  45 ///@}
  46
  47 /**
  48   Calculate an event's duration in timer ticks.
  49
  50   Given the count direction and the event's start and end timer values,
  51   calculate the duration of the event in timer ticks.  Information for
  52   the current measurement is pointed to by the parameter.
  53
  54   If the measurement's start time is 1, it indicates that the developer
  55   is indicating that the measurement began at the release of reset.
  56   The start time is adjusted to the timer's starting count before performing
  57   the elapsed time calculation.
  58
  59   The calculated duration, in ticks, is the absolute difference between
  60   the measurement's ending and starting counts.
  61
  62   @param Measurement   Pointer to a MEASUREMENT_RECORD structure containing
  63                        data for the current measurement.
  64
  65   @return              The 64-bit duration of the event.
  66 **/
  67 UINT64
  68 GetDuration (
  69   IN OUT MEASUREMENT_RECORD *Measurement
  70   );
  71
  72 /**
  73   Determine whether the Measurement record is for an EFI Phase.
  74
  75   The Token and Module members of the measurement record are checked.
  76   Module must be empty and Token must be one of SEC, PEI, DXE, BDS, or SHELL.
  77
  78   @param[in]  Measurement A pointer to the Measurement record to test.
  79
  80   @retval     TRUE        The measurement record is for an EFI Phase.
  81   @retval     FALSE       The measurement record is NOT for an EFI Phase.
  82 **/
  83 BOOLEAN
  84 IsPhase(
  85   IN MEASUREMENT_RECORD *Measurement
  86   );
  87
  88 /**
  89   Get the file name portion of the Pdb File Name.
  90
  91   The portion of the Pdb File Name between the last backslash and
  92   either a following period or the end of the string is converted
  93   to Unicode and copied into UnicodeBuffer.  The name is truncated,
  94   if necessary, to ensure that UnicodeBuffer is not overrun.
  95
  96   @param[in]  PdbFileName     Pdb file name.
  97   @param[out] UnicodeBuffer   The resultant Unicode File Name.
  98
  99 **/
 100 VOID
 101 DpGetShortPdbFileName (
 102   IN  CHAR8     *PdbFileName,
 103   OUT CHAR16    *UnicodeBuffer
 104   );
 105
 106 /**
 107   Get a human readable name for an image handle.
 108   The following methods will be tried orderly:
 109     1. Image PDB
 110     2. ComponentName2 protocol
 111     3. FFS UI section
 112     4. Image GUID
 113     5. Image DevicePath
 114     6. Unknown Driver Name
 115
 116   @param[in]    Handle
 117
 118   @post   The resulting Unicode name string is stored in the
 119           mGaugeString global array.
 120
 121 **/
 122 VOID
 123 DpGetNameFromHandle (
 124   IN EFI_HANDLE Handle
 125   );
 126
 127 /**
 128   Calculate the Duration in microseconds.
 129
 130   Duration is multiplied by 1000, instead of Frequency being divided by 1000 or
 131   multiplying the result by 1000, in order to maintain precision.  Since Duration is
 132   a 64-bit value, multiplying it by 1000 is unlikely to produce an overflow.
 133
 134   The time is calculated as (Duration * 1000) / Timer_Frequency.
 135
 136   @param[in]  Duration   The event duration in timer ticks.
 137
 138   @return     A 64-bit value which is the Elapsed time in microseconds.
 139 **/
 140 UINT64
 141 DurationInMicroSeconds (
 142   IN UINT64 Duration
 143   );
 144
 145 /**
 146   Get index of Measurement Record's match in the CumData array.
 147
 148   If the Measurement's Token value matches a Token in one of the CumData
 149   records, the index of the matching record is returned.  The returned
 150   index is a signed value so that negative values can indicate that
 151   the Measurement didn't match any entry in the CumData array.
 152
 153   @param[in]  Measurement A pointer to a Measurement Record to match against the CumData array.
 154
 155   @retval     <0    Token is not in the CumData array.
 156   @retval     >=0   Return value is the index into CumData where Token is found.
 157 **/
 158 INTN
 159 GetCumulativeItem(
 160   IN MEASUREMENT_RECORD *Measurement
 161   );
 162
 163 /**
 164   Collect verbose statistics about the logged performance measurements.
 165
 166   General Summary information for all Trace measurements is gathered and
 167   stored within the SummaryData structure.  This information is both
 168   used internally by subsequent reporting functions, and displayed
 169   at the end of verbose reports.
 170
 171   @pre  The SummaryData and CumData structures must be initialized
 172         prior to calling this function.
 173
 174   @post The SummaryData and CumData structures contain statistics for the
 175         current performance logs.
 176
 177   @param[in, out] CustomCumulativeData  The pointer to the custom cumulative data.
 178
 179 **/
 180 VOID
 181 GatherStatistics(
 182   IN OUT PERF_CUM_DATA              *CustomCumulativeData OPTIONAL
 183   );
 184
 185 /**
 186   Gather and print ALL Trace Records.
 187
 188   Displays all "interesting" Trace measurements in order.<BR>
 189   The number of records displayed is controlled by:
 190      - records with a duration less than mInterestThreshold microseconds are not displayed.
 191      - No more than Limit records are displayed.  A Limit of zero will not limit the output.
 192      - If the ExcludeFlag is TRUE, records matching entries in the CumData array are not
 193        displayed.
 194
 195   @pre    The mInterestThreshold global variable is set to the shortest duration to be printed.
 196            The mGaugeString and mUnicodeToken global arrays are used for temporary string storage.
 197            They must not be in use by a calling function.
 198
 199   @param[in]    Limit       The number of records to print.  Zero is ALL.
 200   @param[in]    ExcludeFlag TRUE to exclude individual Cumulative items from display.
 201
 202   @retval EFI_SUCCESS           The operation was successful.
 203   @retval EFI_ABORTED           The user aborts the operation.
 204   @return Others                from a call to gBS->LocateHandleBuffer().
 205 **/
 206 EFI_STATUS
 207 DumpAllTrace(
 208   IN UINTN             Limit,
 209   IN BOOLEAN           ExcludeFlag
 210   );
 211
 212 /**
 213   Gather and print Raw Trace Records.
 214
 215   All Trace measurements with a duration greater than or equal to
 216   mInterestThreshold are printed without interpretation.
 217
 218   The number of records displayed is controlled by:
 219      - records with a duration less than mInterestThreshold microseconds are not displayed.
 220      - No more than Limit records are displayed.  A Limit of zero will not limit the output.
 221      - If the ExcludeFlag is TRUE, records matching entries in the CumData array are not
 222        displayed.
 223
 224   @pre    The mInterestThreshold global variable is set to the shortest duration to be printed.
 225
 226   @param[in]    Limit       The number of records to print.  Zero is ALL.
 227   @param[in]    ExcludeFlag TRUE to exclude individual Cumulative items from display.
 228   @retval EFI_SUCCESS           The operation was successful.
 229   @retval EFI_ABORTED           The user aborts the operation.
 230 **/
 231 EFI_STATUS
 232 DumpRawTrace(
 233   IN UINTN          Limit,
 234   IN BOOLEAN        ExcludeFlag
 235   );
 236
 237 /**
 238   Gather and print Major Phase metrics.
 239
 240 **/
 241 VOID
 242 ProcessPhases(
 243   VOID
 244   );
 245
 246
 247 /**
 248   Gather and print Handle data.
 249
 250   @param[in]    ExcludeFlag   TRUE to exclude individual Cumulative items from display.
 251
 252   @retval EFI_SUCCESS             The operation was successful.
 253   @retval EFI_ABORTED             The user aborts the operation.
 254   @return Others                  from a call to gBS->LocateHandleBuffer().
 255 **/
 256 EFI_STATUS
 257 ProcessHandles(
 258   IN BOOLEAN ExcludeFlag
 259   );
 260
 261
 262 /**
 263   Gather and print PEIM data.
 264
 265   Only prints complete PEIM records
 266
 267   @retval EFI_SUCCESS           The operation was successful.
 268   @retval EFI_ABORTED           The user aborts the operation.
 269 **/
 270 EFI_STATUS
 271 ProcessPeims(
 272   VOID
 273   );
 274
 275 /**
 276   Gather and print global data.
 277
 278   Strips out incomplete or "Execution Phase" records
 279   Only prints records where Handle is NULL
 280   Increment TIndex for every record, even skipped ones, so that we have an
 281   indication of every measurement record taken.
 282
 283   @retval EFI_SUCCESS           The operation was successful.
 284   @retval EFI_ABORTED           The user aborts the operation.
 285 **/
 286 EFI_STATUS
 287 ProcessGlobal(
 288   VOID
 289   );
 290
 291 /**
 292   Gather and print cumulative data.
 293
 294   Traverse the measurement records and:<BR>
 295   For each record with a Token listed in the CumData array:<BR>
 296      - Update the instance count and the total, minimum, and maximum durations.
 297   Finally, print the gathered cumulative statistics.
 298
 299   @param[in]    CustomCumulativeData  The pointer to the custom cumulative data.
 300
 301 **/
 302 VOID
 303 ProcessCumulative(
 304   IN PERF_CUM_DATA                  *CustomCumulativeData OPTIONAL
 305   );
 306
 307 #endif