2 Declarations of objects defined internally to the Dp Application.
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.
9 Copyright (c) 2009 - 2013, 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
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.
19 #ifndef _DP_INTELNAL_H_
20 #define _DP_INTELNAL_H_
22 #define DP_GAUGE_STRING_LENGTH 36
25 /// Module-Global Variables
27 extern EFI_HII_HANDLE gDpHiiHandle
;
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
;
33 extern PERF_SUMMARY_DATA SummaryData
; ///< Create the SummaryData structure and init. to ZERO.
35 /// Timer Specific Information.
36 extern TIMER_INFO TimerInfo
;
38 /// Items for which to gather cumulative statistics.
39 extern PERF_CUM_DATA CumData
[];
41 /// Number of items for which we are gathering cumulative statistics.
42 extern UINT32
const NumCum
;
47 Calculate an event's duration in timer ticks.
49 Given the count direction and the event's start and end timer values,
50 calculate the duration of the event in timer ticks. Information for
51 the current measurement is pointed to by the parameter.
53 If the measurement's start time is 1, it indicates that the developer
54 is indicating that the measurement began at the release of reset.
55 The start time is adjusted to the timer's starting count before performing
56 the elapsed time calculation.
58 The calculated duration, in ticks, is the absolute difference between
59 the measurement's ending and starting counts.
61 @param Measurement Pointer to a MEASUREMENT_RECORD structure containing
62 data for the current measurement.
64 @return The 64-bit duration of the event.
68 IN OUT MEASUREMENT_RECORD
*Measurement
72 Determine whether the Measurement record is for an EFI Phase.
74 The Token and Module members of the measurement record are checked.
75 Module must be empty and Token must be one of SEC, PEI, DXE, BDS, or SHELL.
77 @param[in] Measurement A pointer to the Measurement record to test.
79 @retval TRUE The measurement record is for an EFI Phase.
80 @retval FALSE The measurement record is NOT for an EFI Phase.
84 IN MEASUREMENT_RECORD
*Measurement
88 Get the file name portion of the Pdb File Name.
90 The portion of the Pdb File Name between the last backslash and
91 either a following period or the end of the string is converted
92 to Unicode and copied into UnicodeBuffer. The name is truncated,
93 if necessary, to ensure that UnicodeBuffer is not overrun.
95 @param[in] PdbFileName Pdb file name.
96 @param[out] UnicodeBuffer The resultant Unicode File Name.
100 DpGetShortPdbFileName (
101 IN CHAR8
*PdbFileName
,
102 OUT CHAR16
*UnicodeBuffer
106 Get a human readable name for an image handle.
107 The following methods will be tried orderly:
109 2. ComponentName2 protocol
113 6. Unknown Driver Name
117 @post The resulting Unicode name string is stored in the
118 mGaugeString global array.
122 DpGetNameFromHandle (
127 Calculate the Duration in microseconds.
129 Duration is multiplied by 1000, instead of Frequency being divided by 1000 or
130 multiplying the result by 1000, in order to maintain precision. Since Duration is
131 a 64-bit value, multiplying it by 1000 is unlikely to produce an overflow.
133 The time is calculated as (Duration * 1000) / Timer_Frequency.
135 @param[in] Duration The event duration in timer ticks.
137 @return A 64-bit value which is the Elapsed time in microseconds.
140 DurationInMicroSeconds (
145 Get index of Measurement Record's match in the CumData array.
147 If the Measurement's Token value matches a Token in one of the CumData
148 records, the index of the matching record is returned. The returned
149 index is a signed value so that negative values can indicate that
150 the Measurement didn't match any entry in the CumData array.
152 @param[in] Measurement A pointer to a Measurement Record to match against the CumData array.
154 @retval <0 Token is not in the CumData array.
155 @retval >=0 Return value is the index into CumData where Token is found.
159 IN MEASUREMENT_RECORD
*Measurement
163 Collect verbose statistics about the logged performance measurements.
165 General Summary information for all Trace measurements is gathered and
166 stored within the SummaryData structure. This information is both
167 used internally by subsequent reporting functions, and displayed
168 at the end of verbose reports.
170 @pre The SummaryData and CumData structures must be initialized
171 prior to calling this function.
173 @post The SummaryData and CumData structures contain statistics for the
174 current performance logs.
176 @param[in, out] CustomCumulativeData The pointer to the custom cumulative data.
181 IN OUT PERF_CUM_DATA
*CustomCumulativeData OPTIONAL
185 Gather and print ALL Trace Records.
187 Displays all "interesting" Trace measurements in order.<BR>
188 The number of records displayed is controlled by:
189 - records with a duration less than mInterestThreshold microseconds are not displayed.
190 - No more than Limit records are displayed. A Limit of zero will not limit the output.
191 - If the ExcludeFlag is TRUE, records matching entries in the CumData array are not
194 @pre The mInterestThreshold global variable is set to the shortest duration to be printed.
195 The mGaugeString and mUnicodeToken global arrays are used for temporary string storage.
196 They must not be in use by a calling function.
198 @param[in] Limit The number of records to print. Zero is ALL.
199 @param[in] ExcludeFlag TRUE to exclude individual Cumulative items from display.
201 @retval EFI_SUCCESS The operation was successful.
202 @retval EFI_ABORTED The user aborts the operation.
203 @return Others from a call to gBS->LocateHandleBuffer().
208 IN BOOLEAN ExcludeFlag
212 Gather and print Raw Trace Records.
214 All Trace measurements with a duration greater than or equal to
215 mInterestThreshold are printed without interpretation.
217 The number of records displayed is controlled by:
218 - records with a duration less than mInterestThreshold microseconds are not displayed.
219 - No more than Limit records are displayed. A Limit of zero will not limit the output.
220 - If the ExcludeFlag is TRUE, records matching entries in the CumData array are not
223 @pre The mInterestThreshold global variable is set to the shortest duration to be printed.
225 @param[in] Limit The number of records to print. Zero is ALL.
226 @param[in] ExcludeFlag TRUE to exclude individual Cumulative items from display.
227 @retval EFI_SUCCESS The operation was successful.
228 @retval EFI_ABORTED The user aborts the operation.
233 IN BOOLEAN ExcludeFlag
237 Gather and print Major Phase metrics.
239 @param[in] Ticker The timer value for the END of Shell phase
249 Gather and print Handle data.
251 @param[in] ExcludeFlag TRUE to exclude individual Cumulative items from display.
253 @retval EFI_SUCCESS The operation was successful.
254 @retval EFI_ABORTED The user aborts the operation.
255 @return Others from a call to gBS->LocateHandleBuffer().
259 IN BOOLEAN ExcludeFlag
264 Gather and print PEIM data.
266 Only prints complete PEIM records
268 @retval EFI_SUCCESS The operation was successful.
269 @retval EFI_ABORTED The user aborts the operation.
277 Gather and print global data.
279 Strips out incomplete or "Execution Phase" records
280 Only prints records where Handle is NULL
281 Increment TIndex for every record, even skipped ones, so that we have an
282 indication of every measurement record taken.
284 @retval EFI_SUCCESS The operation was successful.
285 @retval EFI_ABORTED The user aborts the operation.
293 Gather and print cumulative data.
295 Traverse the measurement records and:<BR>
296 For each record with a Token listed in the CumData array:<BR>
297 - Update the instance count and the total, minimum, and maximum durations.
298 Finally, print the gathered cumulative statistics.
300 @param[in] CustomCumulativeData The pointer to the custom cumulative data.
305 IN PERF_CUM_DATA
*CustomCumulativeData OPTIONAL
309 Gather and print ALL Profiling Records.
311 Displays all "interesting" Profile measurements in order.
312 The number of records displayed is controlled by:
313 - records with a duration less than mInterestThreshold microseconds are not displayed.
314 - No more than Limit records are displayed. A Limit of zero will not limit the output.
315 - If the ExcludeFlag is TRUE, records matching entries in the CumData array are not
318 @pre The mInterestThreshold global variable is set to the shortest duration to be printed.
319 The mGaugeString and mUnicodeToken global arrays are used for temporary string storage.
320 They must not be in use by a calling function.
322 @param[in] Limit The number of records to print. Zero is ALL.
323 @param[in] ExcludeFlag TRUE to exclude individual Cumulative items from display.
329 IN BOOLEAN ExcludeFlag
333 Gather and print Raw Profile Records.
335 All Profile measurements with a duration greater than or equal to
336 mInterestThreshold are printed without interpretation.
338 The number of records displayed is controlled by:
339 - records with a duration less than mInterestThreshold microseconds are not displayed.
340 - No more than Limit records are displayed. A Limit of zero will not limit the output.
341 - If the ExcludeFlag is TRUE, records matching entries in the CumData array are not
344 @pre The mInterestThreshold global variable is set to the shortest duration to be printed.
346 @param[in] Limit The number of records to print. Zero is ALL.
347 @param[in] ExcludeFlag TRUE to exclude individual Cumulative items from display.
353 IN BOOLEAN ExcludeFlag