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 - 2012, Intel Corporation. All rights reserved.<BR>
10 This program and the accompanying materials
11 are licensed and made available under the terms and conditions of the BSD License
12 which accompanies this distribution. The full text of the license may be found at
13 http://opensource.org/licenses/bsd-license.php
15 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
16 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #ifndef _DP_INTELNAL_H_
19 #define _DP_INTELNAL_H_
21 #define DP_GAUGE_STRING_LENGTH 36
24 /// Module-Global Variables
26 extern EFI_HII_HANDLE gHiiHandle
;
27 extern CHAR16
*mPrintTokenBuffer
;
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 GetShortPdbFileName (
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.
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 Formatted Print using a Hii Token to reference the localized format string.
147 @param[in] Token A HII token associated with a localized Unicode string.
148 @param[in] ... The variable argument list.
150 @return The number of characters converted by UnicodeVSPrint().
160 Get index of Measurement Record's match in the CumData array.
162 If the Measurement's Token value matches a Token in one of the CumData
163 records, the index of the matching record is returned. The returned
164 index is a signed value so that negative values can indicate that
165 the Measurement didn't match any entry in the CumData array.
167 @param[in] Measurement A pointer to a Measurement Record to match against the CumData array.
169 @retval <0 Token is not in the CumData array.
170 @retval >=0 Return value is the index into CumData where Token is found.
174 IN MEASUREMENT_RECORD
*Measurement
178 Collect verbose statistics about the logged performance measurements.
180 General Summary information for all Trace measurements is gathered and
181 stored within the SummaryData structure. This information is both
182 used internally by subsequent reporting functions, and displayed
183 at the end of verbose reports.
185 @pre The SummaryData and CumData structures must be initialized
186 prior to calling this function.
188 @post The SummaryData and CumData structures contain statistics for the
189 current performance logs.
197 Gather and print ALL Trace Records.
199 Displays all "interesting" Trace measurements in order.<BR>
200 The number of records displayed is controlled by:
201 - records with a duration less than mInterestThreshold microseconds are not displayed.
202 - No more than Limit records are displayed. A Limit of zero will not limit the output.
203 - If the ExcludeFlag is TRUE, records matching entries in the CumData array are not
206 @pre The mInterestThreshold global variable is set to the shortest duration to be printed.
207 The mGaugeString and mUnicodeToken global arrays are used for temporary string storage.
208 They must not be in use by a calling function.
210 @param[in] Limit The number of records to print. Zero is ALL.
211 @param[in] ExcludeFlag TRUE to exclude individual Cumulative items from display.
217 IN BOOLEAN ExcludeFlag
221 Gather and print Raw Trace Records.
223 All Trace measurements with a duration greater than or equal to
224 mInterestThreshold are printed without interpretation.
226 The number of records displayed is controlled by:
227 - records with a duration less than mInterestThreshold microseconds are not displayed.
228 - No more than Limit records are displayed. A Limit of zero will not limit the output.
229 - If the ExcludeFlag is TRUE, records matching entries in the CumData array are not
232 @pre The mInterestThreshold global variable is set to the shortest duration to be printed.
234 @param[in] Limit The number of records to print. Zero is ALL.
235 @param[in] ExcludeFlag TRUE to exclude individual Cumulative items from display.
241 IN BOOLEAN ExcludeFlag
245 Gather and print Major Phase metrics.
247 @param[in] Ticker The timer value for the END of Shell phase
257 Gather and print Handle data.
259 @param[in] ExcludeFlag TRUE to exclude individual Cumulative items from display.
261 @return Status from a call to gBS->LocateHandle().
265 IN BOOLEAN ExcludeFlag
270 Gather and print PEIM data.
272 Only prints complete PEIM records
281 Gather and print global data.
283 Strips out incomplete or "Execution Phase" records
284 Only prints records where Handle is NULL
285 Increment TIndex for every record, even skipped ones, so that we have an
286 indication of every measurement record taken.
295 Gather and print cumulative data.
297 Traverse the measurement records and:<BR>
298 For each record with a Token listed in the CumData array:<BR>
299 - Update the instance count and the total, minimum, and maximum durations.
300 Finally, print the gathered cumulative statistics.
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
357 Wrap original FreePool to check NULL pointer first.
359 @param[in] Buffer The pointer to the buffer to free.