2 Shell application for Displaying Performance Metrics.
4 The Dp application reads performance data and presents it in several
5 different formats depending upon the needs of the user. Both
6 Trace and Measured Profiling information is processed and presented.
8 Dp uses the "PerformanceLib" to read the measurement records.
9 The "TimerLib" provides information about the timer, such as frequency,
10 beginning, and ending counter values.
11 Measurement records contain identifying information (Handle, Token, Module)
12 and start and end time values.
13 Dp uses this information to group records in different ways. It also uses
14 timer information to calculate elapsed time for each measurement.
16 Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>
17 (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
18 This program and the accompanying materials
19 are licensed and made available under the terms and conditions of the BSD License
20 which accompanies this distribution. The full text of the license may be found at
21 http://opensource.org/licenses/bsd-license.php
23 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
24 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
27 #include <Library/UefiApplicationEntryPoint.h>
28 #include <Library/UefiBootServicesTableLib.h>
29 #include <Library/ShellLib.h>
30 #include <Library/BaseLib.h>
31 #include <Library/MemoryAllocationLib.h>
32 #include <Library/DebugLib.h>
33 #include <Library/TimerLib.h>
34 #include <Library/UefiLib.h>
35 #include <Library/UefiHiiServicesLib.h>
36 #include <Library/HiiLib.h>
37 #include <Library/PcdLib.h>
39 #include <Guid/Performance.h>
41 #include <PerformanceTokens.h>
44 #include "DpInternal.h"
47 // String token ID of help message text.
48 // Shell supports to find help message in the resource section of an application image if
49 // .MAN file is not found. This global variable is added to make build tool recognizes
50 // that the help string is consumed by user and then build tool will add the string into
51 // the resource section. Thus the application can use '-?' option to show help message in
54 GLOBAL_REMOVE_IF_UNREFERENCED EFI_STRING_ID mDpStrEngHelpTokenId
= STRING_TOKEN (STR_DP_HELP_INFORMATION
);
57 /// Module-Global Variables
59 EFI_HII_HANDLE gHiiHandle
;
60 SHELL_PARAM_ITEM
*DpParamList
= NULL
;
61 CHAR16
*mPrintTokenBuffer
= NULL
;
62 CHAR16 mGaugeString
[DP_GAUGE_STRING_LENGTH
+ 1];
63 CHAR16 mUnicodeToken
[DXE_PERFORMANCE_STRING_SIZE
];
64 UINT64 mInterestThreshold
;
65 BOOLEAN mShowId
= FALSE
;
67 PERF_SUMMARY_DATA SummaryData
= { 0 }; ///< Create the SummaryData structure and init. to ZERO.
69 /// Timer Specific Information.
72 /// Items for which to gather cumulative statistics.
73 PERF_CUM_DATA CumData
[] = {
74 PERF_INIT_CUM_DATA (LOAD_IMAGE_TOK
),
75 PERF_INIT_CUM_DATA (START_IMAGE_TOK
),
76 PERF_INIT_CUM_DATA (DRIVERBINDING_START_TOK
),
77 PERF_INIT_CUM_DATA (DRIVERBINDING_SUPPORT_TOK
)
80 /// Number of items for which we are gathering cumulative statistics.
81 UINT32
const NumCum
= sizeof(CumData
) / sizeof(PERF_CUM_DATA
);
83 PARAM_ITEM_LIST ParamList
[] = {
84 {STRING_TOKEN (STR_DP_OPTION_QH
), TypeFlag
}, // -? Help
85 {STRING_TOKEN (STR_DP_OPTION_LH
), TypeFlag
}, // -h Help
86 {STRING_TOKEN (STR_DP_OPTION_UH
), TypeFlag
}, // -H Help
87 {STRING_TOKEN (STR_DP_OPTION_LV
), TypeFlag
}, // -v Verbose Mode
88 {STRING_TOKEN (STR_DP_OPTION_UA
), TypeFlag
}, // -A All, Cooked
89 {STRING_TOKEN (STR_DP_OPTION_UR
), TypeFlag
}, // -R RAW All
90 {STRING_TOKEN (STR_DP_OPTION_LS
), TypeFlag
}, // -s Summary
91 #if PROFILING_IMPLEMENTED
92 {STRING_TOKEN (STR_DP_OPTION_UP
), TypeFlag
}, // -P Dump Profile Data
93 {STRING_TOKEN (STR_DP_OPTION_UT
), TypeFlag
}, // -T Dump Trace Data
95 {STRING_TOKEN (STR_DP_OPTION_LX
), TypeFlag
}, // -x eXclude Cumulative Items
96 {STRING_TOKEN (STR_DP_OPTION_LI
), TypeFlag
}, // -i Display Identifier
97 {STRING_TOKEN (STR_DP_OPTION_LC
), TypeValue
}, // -c Display cumulative data.
98 {STRING_TOKEN (STR_DP_OPTION_LN
), TypeValue
}, // -n # Number of records to display for A and R
99 {STRING_TOKEN (STR_DP_OPTION_LT
), TypeValue
} // -t # Threshold of interest
105 Transfer the param list value and get the command line parse.
109 InitialShellParamList( void )
115 // Allocate one more for the end tag.
117 ListLength
= sizeof (ParamList
) / sizeof (ParamList
[0]) + 1;
118 DpParamList
= AllocatePool (sizeof (SHELL_PARAM_ITEM
) * ListLength
);
119 ASSERT (DpParamList
!= NULL
);
121 for (ListIndex
= 0; ListIndex
< ListLength
- 1; ListIndex
++)
123 DpParamList
[ListIndex
].Name
= HiiGetString (gHiiHandle
, ParamList
[ListIndex
].Token
, NULL
);
124 DpParamList
[ListIndex
].Type
= ParamList
[ListIndex
].Type
;
126 DpParamList
[ListIndex
].Name
= NULL
;
127 DpParamList
[ListIndex
].Type
= TypeMax
;
131 Display Usage and Help information.
136 PrintToken (STRING_TOKEN (STR_DP_HELP_HEAD
));
137 #if PROFILING_IMPLEMENTED
138 PrintToken (STRING_TOKEN (STR_DP_HELP_FLAGS
));
140 PrintToken (STRING_TOKEN (STR_DP_HELP_FLAGS_2
));
141 #endif // PROFILING_IMPLEMENTED
142 PrintToken (STRING_TOKEN (STR_DP_HELP_PAGINATE
));
143 PrintToken (STRING_TOKEN (STR_DP_HELP_VERBOSE
));
144 PrintToken (STRING_TOKEN (STR_DP_HELP_EXCLUDE
));
145 PrintToken (STRING_TOKEN (STR_DP_HELP_STAT
));
146 PrintToken (STRING_TOKEN (STR_DP_HELP_ALL
));
147 PrintToken (STRING_TOKEN (STR_DP_HELP_RAW
));
148 #if PROFILING_IMPLEMENTED
149 PrintToken (STRING_TOKEN (STR_DP_HELP_TRACE
));
150 PrintToken (STRING_TOKEN (STR_DP_HELP_PROFILE
));
151 #endif // PROFILING_IMPLEMENTED
152 PrintToken (STRING_TOKEN (STR_DP_HELP_THRESHOLD
));
153 PrintToken (STRING_TOKEN (STR_DP_HELP_COUNT
));
154 PrintToken (STRING_TOKEN (STR_DP_HELP_ID
));
155 PrintToken (STRING_TOKEN (STR_DP_HELP_CUM_DATA
));
156 PrintToken (STRING_TOKEN (STR_DP_HELP_HELP
));
161 Display the trailing Verbose information.
164 DumpStatistics( void )
166 EFI_STRING StringPtr
;
167 EFI_STRING StringPtrUnknown
;
168 StringPtr
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_SECTION_STATISTICS
), NULL
);
169 StringPtrUnknown
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_ALIT_UNKNOWN
), NULL
);
170 PrintToken( STRING_TOKEN (STR_DP_SECTION_HEADER
),
171 (StringPtr
== NULL
) ? StringPtrUnknown
: StringPtr
);
173 PrintToken( STRING_TOKEN (STR_DP_STATS_NUMTRACE
), SummaryData
.NumTrace
);
174 PrintToken( STRING_TOKEN (STR_DP_STATS_NUMINCOMPLETE
), SummaryData
.NumIncomplete
);
175 PrintToken( STRING_TOKEN (STR_DP_STATS_NUMPHASES
), SummaryData
.NumSummary
);
176 PrintToken( STRING_TOKEN (STR_DP_STATS_NUMHANDLES
), SummaryData
.NumHandles
, SummaryData
.NumTrace
- SummaryData
.NumHandles
);
177 PrintToken( STRING_TOKEN (STR_DP_STATS_NUMPEIMS
), SummaryData
.NumPEIMs
);
178 PrintToken( STRING_TOKEN (STR_DP_STATS_NUMGLOBALS
), SummaryData
.NumGlobal
);
179 #if PROFILING_IMPLEMENTED
180 PrintToken( STRING_TOKEN (STR_DP_STATS_NUMPROFILE
), SummaryData
.NumProfile
);
181 #endif // PROFILING_IMPLEMENTED
182 FreePool (StringPtr
);
183 FreePool (StringPtrUnknown
);
187 Dump performance data.
189 @param[in] ImageHandle The image handle.
190 @param[in] SystemTable The system table.
192 @retval EFI_SUCCESS Command completed successfully.
193 @retval EFI_INVALID_PARAMETER Command usage error.
194 @retval EFI_ABORTED The user aborts the operation.
195 @retval value Unknown error.
200 IN EFI_HANDLE ImageHandle
,
201 IN EFI_SYSTEM_TABLE
*SystemTable
208 LIST_ENTRY
*ParamPackage
;
209 CONST CHAR16
*CmdLineArg
;
210 EFI_STRING StringPtr
;
211 UINTN Number2Display
;
221 BOOLEAN CumulativeMode
;
222 CONST CHAR16
*CustomCumulativeToken
;
223 PERF_CUM_DATA
*CustomCumulativeData
;
225 EFI_HII_PACKAGE_LIST_HEADER
*PackageList
;
227 EFI_STRING StringDpOptionQh
;
228 EFI_STRING StringDpOptionLh
;
229 EFI_STRING StringDpOptionUh
;
230 EFI_STRING StringDpOptionLv
;
231 EFI_STRING StringDpOptionUs
;
232 EFI_STRING StringDpOptionLs
;
233 EFI_STRING StringDpOptionUa
;
234 EFI_STRING StringDpOptionUr
;
235 EFI_STRING StringDpOptionUt
;
236 EFI_STRING StringDpOptionUp
;
237 EFI_STRING StringDpOptionLx
;
238 EFI_STRING StringDpOptionLn
;
239 EFI_STRING StringDpOptionLt
;
240 EFI_STRING StringDpOptionLi
;
241 EFI_STRING StringDpOptionLc
;
250 CumulativeMode
= FALSE
;
251 CustomCumulativeData
= NULL
;
253 StringDpOptionQh
= NULL
;
254 StringDpOptionLh
= NULL
;
255 StringDpOptionUh
= NULL
;
256 StringDpOptionLv
= NULL
;
257 StringDpOptionUs
= NULL
;
258 StringDpOptionLs
= NULL
;
259 StringDpOptionUa
= NULL
;
260 StringDpOptionUr
= NULL
;
261 StringDpOptionUt
= NULL
;
262 StringDpOptionUp
= NULL
;
263 StringDpOptionLx
= NULL
;
264 StringDpOptionLn
= NULL
;
265 StringDpOptionLt
= NULL
;
266 StringDpOptionLi
= NULL
;
267 StringDpOptionLc
= NULL
;
270 // Get DP's entry time as soon as possible.
271 // This is used as the Shell-Phase end time.
273 Ticker
= GetPerformanceCounter ();
276 // Retrieve HII package list from ImageHandle
278 Status
= gBS
->OpenProtocol (
280 &gEfiHiiPackageListProtocolGuid
,
281 (VOID
**) &PackageList
,
284 EFI_OPEN_PROTOCOL_GET_PROTOCOL
286 if (EFI_ERROR (Status
)) {
291 // Publish HII package list to HII Database.
293 Status
= gHiiDatabase
->NewPackageList (
299 if (EFI_ERROR (Status
)) {
302 ASSERT (gHiiHandle
!= NULL
);
305 // Initial the command list
307 InitialShellParamList ();
309 /****************************************************************************
310 **** Process Command Line arguments ****
311 ****************************************************************************/
312 Status
= ShellCommandLineParse (DpParamList
, &ParamPackage
, NULL
, TRUE
);
314 if (EFI_ERROR(Status
)) {
315 PrintToken (STRING_TOKEN (STR_DP_INVALID_ARG
));
319 StringDpOptionQh
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_QH
), NULL
);
320 StringDpOptionLh
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_LH
), NULL
);
321 StringDpOptionUh
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_UH
), NULL
);
323 if (ShellCommandLineGetFlag (ParamPackage
, StringDpOptionQh
) ||
324 ShellCommandLineGetFlag (ParamPackage
, StringDpOptionLh
) ||
325 ShellCommandLineGetFlag (ParamPackage
, StringDpOptionUh
))
330 StringDpOptionLv
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_LV
), NULL
);
331 StringDpOptionUs
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_US
), NULL
);
332 StringDpOptionLs
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_LS
), NULL
);
333 StringDpOptionUa
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_UA
), NULL
);
334 StringDpOptionUr
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_UR
), NULL
);
335 StringDpOptionUt
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_UT
), NULL
);
336 StringDpOptionUp
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_UP
), NULL
);
337 StringDpOptionLx
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_LX
), NULL
);
338 StringDpOptionLn
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_LN
), NULL
);
339 StringDpOptionLt
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_LT
), NULL
);
340 StringDpOptionLi
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_LI
), NULL
);
341 StringDpOptionLc
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_OPTION_LC
), NULL
);
345 VerboseMode
= ShellCommandLineGetFlag (ParamPackage
, StringDpOptionLv
);
346 SummaryMode
= (BOOLEAN
) (ShellCommandLineGetFlag (ParamPackage
, StringDpOptionUs
) ||
347 ShellCommandLineGetFlag (ParamPackage
, StringDpOptionLs
));
348 AllMode
= ShellCommandLineGetFlag (ParamPackage
, StringDpOptionUa
);
349 RawMode
= ShellCommandLineGetFlag (ParamPackage
, StringDpOptionUr
);
350 #if PROFILING_IMPLEMENTED
351 TraceMode
= ShellCommandLineGetFlag (ParamPackage
, StringDpOptionUt
);
352 ProfileMode
= ShellCommandLineGetFlag (ParamPackage
, StringDpOptionUp
);
353 #endif // PROFILING_IMPLEMENTED
354 ExcludeMode
= ShellCommandLineGetFlag (ParamPackage
, StringDpOptionLx
);
355 mShowId
= ShellCommandLineGetFlag (ParamPackage
, StringDpOptionLi
);
356 CumulativeMode
= ShellCommandLineGetFlag (ParamPackage
, StringDpOptionLc
);
358 // Options with Values
359 CmdLineArg
= ShellCommandLineGetValue (ParamPackage
, StringDpOptionLn
);
360 if (CmdLineArg
== NULL
) {
361 Number2Display
= DEFAULT_DISPLAYCOUNT
;
364 Number2Display
= StrDecimalToUintn(CmdLineArg
);
365 if (Number2Display
== 0) {
366 Number2Display
= MAXIMUM_DISPLAYCOUNT
;
369 CmdLineArg
= ShellCommandLineGetValue (ParamPackage
, StringDpOptionLt
);
370 if (CmdLineArg
== NULL
) {
371 mInterestThreshold
= DEFAULT_THRESHOLD
; // 1ms := 1,000 us
374 mInterestThreshold
= StrDecimalToUint64(CmdLineArg
);
376 // Handle Flag combinations and default behaviors
377 // If both TraceMode and ProfileMode are FALSE, set them both to TRUE
378 if ((! TraceMode
) && (! ProfileMode
)) {
380 #if PROFILING_IMPLEMENTED
382 #endif // PROFILING_IMPLEMENTED
386 // Init the custom cumulative data.
388 CustomCumulativeToken
= ShellCommandLineGetValue (ParamPackage
, StringDpOptionLc
);
389 if (CustomCumulativeToken
!= NULL
) {
390 CustomCumulativeData
= AllocateZeroPool (sizeof (PERF_CUM_DATA
));
391 ASSERT (CustomCumulativeData
!= NULL
);
392 CustomCumulativeData
->MinDur
= 0;
393 CustomCumulativeData
->MaxDur
= 0;
394 CustomCumulativeData
->Count
= 0;
395 CustomCumulativeData
->Duration
= 0;
396 NameSize
= StrLen (CustomCumulativeToken
) + 1;
397 CustomCumulativeData
->Name
= AllocateZeroPool (NameSize
);
398 UnicodeStrToAsciiStrS (CustomCumulativeToken
, CustomCumulativeData
->Name
, NameSize
);
401 /****************************************************************************
402 **** Timer specific processing ****
403 ****************************************************************************/
404 // Get the Performance counter characteristics:
405 // Freq = Frequency in Hz
406 // StartCount = Value loaded into the counter when it starts counting
407 // EndCount = Value counter counts to before it needs to be reset
409 Freq
= GetPerformanceCounterProperties (&TimerInfo
.StartCount
, &TimerInfo
.EndCount
);
411 // Convert the Frequency from Hz to KHz
412 TimerInfo
.Frequency
= (UINT32
)DivU64x32 (Freq
, 1000);
414 // Determine in which direction the performance counter counts.
415 TimerInfo
.CountUp
= (BOOLEAN
) (TimerInfo
.EndCount
>= TimerInfo
.StartCount
);
417 /****************************************************************************
418 **** Print heading ****
419 ****************************************************************************/
420 // print DP's build version
421 PrintToken (STRING_TOKEN (STR_DP_BUILD_REVISION
), DP_MAJOR_VERSION
, DP_MINOR_VERSION
);
423 // print performance timer characteristics
424 PrintToken (STRING_TOKEN (STR_DP_KHZ
), TimerInfo
.Frequency
); // Print Timer frequency in KHz
429 StringPtr
= HiiGetString (gHiiHandle
,
430 (EFI_STRING_ID
) (TimerInfo
.CountUp
? STRING_TOKEN (STR_DP_UP
) : STRING_TOKEN (STR_DP_DOWN
)),
432 ASSERT (StringPtr
!= NULL
);
433 PrintToken (STRING_TOKEN (STR_DP_TIMER_PROPERTIES
), // Print Timer count range and direction
435 TimerInfo
.StartCount
,
438 PrintToken (STRING_TOKEN (STR_DP_VERBOSE_THRESHOLD
), mInterestThreshold
);
441 /* **************************************************************************
442 **** Print Sections based on command line options
444 **** Option modes have the following priority:
445 **** v Verbose -- Valid in combination with any other options
446 **** t Threshold -- Modifies All, Raw, and Cooked output
447 **** Default is 0 for All and Raw mode
448 **** Default is DEFAULT_THRESHOLD for "Cooked" mode
449 **** n Number2Display Used by All and Raw mode. Otherwise ignored.
450 **** A All -- R and S options are ignored
451 **** R Raw -- S option is ignored
452 **** s Summary -- Modifies "Cooked" output only
453 **** Cooked (Default)
455 **** The All, Raw, and Cooked modes are modified by the Trace and Profile
457 **** !T && !P := (0) Default, Both are displayed
458 **** T && !P := (1) Only Trace records are displayed
459 **** !T && P := (2) Only Profile records are displayed
460 **** T && P := (3) Same as Default, both are displayed
461 ****************************************************************************/
462 GatherStatistics (CustomCumulativeData
);
463 if (CumulativeMode
) {
464 ProcessCumulative (CustomCumulativeData
);
465 } else if (AllMode
) {
467 Status
= DumpAllTrace( Number2Display
, ExcludeMode
);
468 if (Status
== EFI_ABORTED
) {
473 DumpAllProfile( Number2Display
, ExcludeMode
);
478 Status
= DumpRawTrace( Number2Display
, ExcludeMode
);
479 if (Status
== EFI_ABORTED
) {
484 DumpRawProfile( Number2Display
, ExcludeMode
);
488 //------------- Begin Cooked Mode Processing
490 ProcessPhases ( Ticker
);
491 if ( ! SummaryMode
) {
492 Status
= ProcessHandles ( ExcludeMode
);
493 if (Status
== EFI_ABORTED
) {
497 Status
= ProcessPeims ();
498 if (Status
== EFI_ABORTED
) {
502 Status
= ProcessGlobal ();
503 if (Status
== EFI_ABORTED
) {
507 ProcessCumulative (NULL
);
511 DumpAllProfile( Number2Display
, ExcludeMode
);
513 } //------------- End of Cooked Mode Processing
514 if ( VerboseMode
|| SummaryMode
) {
523 // Free the memory allocate from HiiGetString
526 while (DpParamList
[ListIndex
].Name
!= NULL
) {
527 FreePool (DpParamList
[ListIndex
].Name
);
530 FreePool (DpParamList
);
532 SafeFreePool (StringDpOptionQh
);
533 SafeFreePool (StringDpOptionLh
);
534 SafeFreePool (StringDpOptionUh
);
535 SafeFreePool (StringDpOptionLv
);
536 SafeFreePool (StringDpOptionUs
);
537 SafeFreePool (StringDpOptionLs
);
538 SafeFreePool (StringDpOptionUa
);
539 SafeFreePool (StringDpOptionUr
);
540 SafeFreePool (StringDpOptionUt
);
541 SafeFreePool (StringDpOptionUp
);
542 SafeFreePool (StringDpOptionLx
);
543 SafeFreePool (StringDpOptionLn
);
544 SafeFreePool (StringDpOptionLt
);
545 SafeFreePool (StringDpOptionLi
);
546 SafeFreePool (StringDpOptionLc
);
547 SafeFreePool (StringPtr
);
548 SafeFreePool (mPrintTokenBuffer
);
550 if (ParamPackage
!= NULL
) {
551 ShellCommandLineFreeVarList (ParamPackage
);
553 if (CustomCumulativeData
!= NULL
) {
554 SafeFreePool (CustomCumulativeData
->Name
);
556 SafeFreePool (CustomCumulativeData
);
558 HiiRemovePackages (gHiiHandle
);