2 Utility functions used by the Dp application.
4 Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14 #include <Library/BaseLib.h>
15 #include <Library/BaseMemoryLib.h>
16 #include <Library/MemoryAllocationLib.h>
17 #include <Library/DebugLib.h>
18 #include <Library/UefiBootServicesTableLib.h>
19 #include <Library/TimerLib.h>
20 #include <Library/PeCoffGetEntryPointLib.h>
21 #include <Library/PrintLib.h>
22 #include <Library/HiiLib.h>
23 #include <Library/PcdLib.h>
24 #include <Library/UefiLib.h>
25 #include <Library/DevicePathLib.h>
27 #include <Pi/PiFirmwareFile.h>
28 #include <Library/DxeServicesLib.h>
30 #include <Protocol/LoadedImage.h>
31 #include <Protocol/DriverBinding.h>
32 #include <Protocol/ComponentName2.h>
33 #include <Protocol/DevicePath.h>
34 #include <Protocol/DevicePathToText.h>
36 #include <Guid/Performance.h>
40 #include "DpInternal.h"
43 Wrap original FreePool to check NULL pointer first.
45 @param[in] Buffer The pointer to the buffer to free.
59 Calculate an event's duration in timer ticks.
61 Given the count direction and the event's start and end timer values,
62 calculate the duration of the event in timer ticks. Information for
63 the current measurement is pointed to by the parameter.
65 If the measurement's start time is 1, it indicates that the developer
66 is indicating that the measurement began at the release of reset.
67 The start time is adjusted to the timer's starting count before performing
68 the elapsed time calculation.
70 The calculated duration, in ticks, is the absolute difference between
71 the measurement's ending and starting counts.
73 @param Measurement Pointer to a MEASUREMENT_RECORD structure containing
74 data for the current measurement.
76 @return The 64-bit duration of the event.
80 IN OUT MEASUREMENT_RECORD
*Measurement
86 // PERF_START macros are called with a value of 1 to indicate
87 // the beginning of time. So, adjust the start ticker value
88 // to the real beginning of time.
89 // Assumes no wraparound. Even then, there is a very low probability
90 // of having a valid StartTicker value of 1.
91 if (Measurement
->StartTimeStamp
== 1) {
92 Measurement
->StartTimeStamp
= TimerInfo
.StartCount
;
94 if (TimerInfo
.CountUp
) {
95 Duration
= Measurement
->EndTimeStamp
- Measurement
->StartTimeStamp
;
96 Error
= (BOOLEAN
)(Duration
> Measurement
->EndTimeStamp
);
99 Duration
= Measurement
->StartTimeStamp
- Measurement
->EndTimeStamp
;
100 Error
= (BOOLEAN
)(Duration
> Measurement
->StartTimeStamp
);
104 DEBUG ((EFI_D_ERROR
, ALit_TimerLibError
));
111 Determine whether the Measurement record is for an EFI Phase.
113 The Token and Module members of the measurement record are checked.
114 Module must be empty and Token must be one of SEC, PEI, DXE, BDS, or SHELL.
116 @param[in] Measurement A pointer to the Measurement record to test.
118 @retval TRUE The measurement record is for an EFI Phase.
119 @retval FALSE The measurement record is NOT for an EFI Phase.
123 IN MEASUREMENT_RECORD
*Measurement
128 RetVal
= (BOOLEAN
)( ( *Measurement
->Module
== '\0') &&
129 ((AsciiStrnCmp (Measurement
->Token
, ALit_SEC
, PERF_TOKEN_LENGTH
) == 0) ||
130 (AsciiStrnCmp (Measurement
->Token
, ALit_PEI
, PERF_TOKEN_LENGTH
) == 0) ||
131 (AsciiStrnCmp (Measurement
->Token
, ALit_DXE
, PERF_TOKEN_LENGTH
) == 0) ||
132 (AsciiStrnCmp (Measurement
->Token
, ALit_BDS
, PERF_TOKEN_LENGTH
) == 0))
138 Get the file name portion of the Pdb File Name.
140 The portion of the Pdb File Name between the last backslash and
141 either a following period or the end of the string is converted
142 to Unicode and copied into UnicodeBuffer. The name is truncated,
143 if necessary, to ensure that UnicodeBuffer is not overrun.
145 @param[in] PdbFileName Pdb file name.
146 @param[out] UnicodeBuffer The resultant Unicode File Name.
150 GetShortPdbFileName (
151 IN CHAR8
*PdbFileName
,
152 OUT CHAR16
*UnicodeBuffer
155 UINTN IndexA
; // Current work location within an ASCII string.
156 UINTN IndexU
; // Current work location within a Unicode string.
160 ZeroMem (UnicodeBuffer
, DXE_PERFORMANCE_STRING_LENGTH
* sizeof (CHAR16
));
162 if (PdbFileName
== NULL
) {
163 StrCpy (UnicodeBuffer
, L
" ");
166 for (EndIndex
= 0; PdbFileName
[EndIndex
] != 0; EndIndex
++)
168 for (IndexA
= 0; PdbFileName
[IndexA
] != 0; IndexA
++) {
169 if (PdbFileName
[IndexA
] == '\\') {
170 StartIndex
= IndexA
+ 1;
173 if (PdbFileName
[IndexA
] == '.') {
179 for (IndexA
= StartIndex
; IndexA
< EndIndex
; IndexA
++) {
180 UnicodeBuffer
[IndexU
] = (CHAR16
) PdbFileName
[IndexA
];
182 if (IndexU
>= DXE_PERFORMANCE_STRING_LENGTH
) {
183 UnicodeBuffer
[DXE_PERFORMANCE_STRING_LENGTH
] = 0;
191 Get a human readable name for an image handle.
192 The following methods will be tried orderly:
194 2. ComponentName2 protocol
198 6. Unknown Driver Name
202 @post The resulting Unicode name string is stored in the
203 mGaugeString global array.
212 EFI_LOADED_IMAGE_PROTOCOL
*Image
;
214 EFI_DRIVER_BINDING_PROTOCOL
*DriverBinding
;
215 EFI_STRING StringPtr
;
216 EFI_DEVICE_PATH_PROTOCOL
*LoadedImageDevicePath
;
217 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
221 CHAR8
*PlatformLanguage
;
222 EFI_COMPONENT_NAME2_PROTOCOL
*ComponentName2
;
223 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL
*DevicePathToText
;
226 // Method 1: Get the name string from image PDB
228 Status
= gBS
->HandleProtocol (
230 &gEfiLoadedImageProtocolGuid
,
234 if (EFI_ERROR (Status
)) {
235 Status
= gBS
->OpenProtocol (
237 &gEfiDriverBindingProtocolGuid
,
238 (VOID
**) &DriverBinding
,
241 EFI_OPEN_PROTOCOL_GET_PROTOCOL
243 if (!EFI_ERROR (Status
)) {
244 Status
= gBS
->HandleProtocol (
245 DriverBinding
->ImageHandle
,
246 &gEfiLoadedImageProtocolGuid
,
252 if (!EFI_ERROR (Status
)) {
253 PdbFileName
= PeCoffLoaderGetPdbPointer (Image
->ImageBase
);
255 if (PdbFileName
!= NULL
) {
256 GetShortPdbFileName (PdbFileName
, mGaugeString
);
262 // Method 2: Get the name string from ComponentName2 protocol
264 Status
= gBS
->HandleProtocol (
266 &gEfiComponentName2ProtocolGuid
,
267 (VOID
**) &ComponentName2
269 if (!EFI_ERROR (Status
)) {
271 // Get the current platform language setting
273 PlatformLanguage
= GetEfiGlobalVariable (L
"PlatformLang");
274 Status
= ComponentName2
->GetDriverName (
276 PlatformLanguage
!= NULL
? PlatformLanguage
: "en-US",
279 if (!EFI_ERROR (Status
)) {
280 SafeFreePool (PlatformLanguage
);
281 StrnCpy (mGaugeString
, StringPtr
, DP_GAUGE_STRING_LENGTH
);
282 mGaugeString
[DP_GAUGE_STRING_LENGTH
] = 0;
287 Status
= gBS
->HandleProtocol (
289 &gEfiLoadedImageDevicePathProtocolGuid
,
290 (VOID
**) &LoadedImageDevicePath
292 if (!EFI_ERROR (Status
)) {
293 DevicePath
= LoadedImageDevicePath
;
296 // Try to get image GUID from LoadedImageDevicePath protocol
299 while (!IsDevicePathEndType (DevicePath
)) {
300 NameGuid
= EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) DevicePath
);
301 if (NameGuid
!= NULL
) {
304 DevicePath
= NextDevicePathNode (DevicePath
);
307 if (NameGuid
!= NULL
) {
309 // Try to get the image's FFS UI section by image GUID
313 Status
= GetSectionFromAnyFv (
315 EFI_SECTION_USER_INTERFACE
,
317 (VOID
**) &NameString
,
321 if (!EFI_ERROR (Status
)) {
323 // Method 3. Get the name string from FFS UI section
325 StrnCpy (mGaugeString
, NameString
, DP_GAUGE_STRING_LENGTH
);
326 mGaugeString
[DP_GAUGE_STRING_LENGTH
] = 0;
327 FreePool (NameString
);
330 // Method 4: Get the name string from image GUID
332 UnicodeSPrint (mGaugeString
, sizeof (mGaugeString
), L
"%g", NameGuid
);
337 // Method 5: Get the name string from image DevicePath
339 Status
= gBS
->LocateProtocol (
340 &gEfiDevicePathToTextProtocolGuid
,
342 (VOID
**) &DevicePathToText
344 if (!EFI_ERROR (Status
)) {
345 NameString
= DevicePathToText
->ConvertDevicePathToText (LoadedImageDevicePath
, TRUE
, FALSE
);
346 if (NameString
!= NULL
) {
347 StrnCpy (mGaugeString
, NameString
, DP_GAUGE_STRING_LENGTH
);
348 mGaugeString
[DP_GAUGE_STRING_LENGTH
] = 0;
349 FreePool (NameString
);
357 // Method 6: Unknown Driver Name
359 StringPtr
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_ERROR_NAME
), NULL
);
360 ASSERT (StringPtr
!= NULL
);
361 StrCpy (mGaugeString
, StringPtr
);
362 FreePool (StringPtr
);
367 Calculate the Duration in microseconds.
369 Duration is multiplied by 1000, instead of Frequency being divided by 1000 or
370 multiplying the result by 1000, in order to maintain precision. Since Duration is
371 a 64-bit value, multiplying it by 1000 is unlikely to produce an overflow.
373 The time is calculated as (Duration * 1000) / Timer_Frequency.
375 @param[in] Duration The event duration in timer ticks.
377 @return A 64-bit value which is the Elapsed time in microseconds.
380 DurationInMicroSeconds (
386 Temp
= MultU64x32 (Duration
, 1000);
387 return DivU64x32 (Temp
, TimerInfo
.Frequency
);
391 Formatted Print using a Hii Token to reference the localized format string.
393 @param[in] Token A HII token associated with a localized Unicode string.
394 @param[in] ... The variable argument list.
396 @return The number of characters converted by UnicodeVSPrint().
406 EFI_STRING StringPtr
;
410 StringPtr
= HiiGetString (gHiiHandle
, Token
, NULL
);
411 ASSERT (StringPtr
!= NULL
);
413 VA_START (Marker
, Token
);
415 BufferSize
= (PcdGet32 (PcdUefiLibMaxPrintBufferSize
) + 1) * sizeof (CHAR16
);
417 if (mPrintTokenBuffer
== NULL
) {
418 mPrintTokenBuffer
= AllocatePool (BufferSize
);
419 ASSERT (mPrintTokenBuffer
!= NULL
);
421 SetMem( mPrintTokenBuffer
, BufferSize
, 0);
423 Return
= UnicodeVSPrint (mPrintTokenBuffer
, BufferSize
, StringPtr
, Marker
);
426 if (Return
> 0 && gST
->ConOut
!= NULL
) {
427 gST
->ConOut
->OutputString (gST
->ConOut
, mPrintTokenBuffer
);
429 FreePool (StringPtr
);
434 Get index of Measurement Record's match in the CumData array.
436 If the Measurement's Token value matches a Token in one of the CumData
437 records, the index of the matching record is returned. The returned
438 index is a signed value so that negative values can indicate that
439 the Measurement didn't match any entry in the CumData array.
441 @param[in] Measurement A pointer to a Measurement Record to match against the CumData array.
443 @retval <0 Token is not in the CumData array.
444 @retval >=0 Return value is the index into CumData where Token is found.
448 IN MEASUREMENT_RECORD
*Measurement
453 for( Index
= 0; Index
< (INTN
)NumCum
; ++Index
) {
454 if (AsciiStrnCmp (Measurement
->Token
, CumData
[Index
].Name
, PERF_TOKEN_LENGTH
) == 0) {
455 return Index
; // Exit, we found a match
458 // If the for loop exits, Token was not found.
459 return -1; // Indicate failure