2 Utility functions used by the Dp application.
4 Copyright (c) 2009 - 2016, 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>
35 #include <Guid/Performance.h>
39 #include "DpInternal.h"
42 Wrap original FreePool to check NULL pointer first.
44 @param[in] Buffer The pointer to the buffer to free.
58 Calculate an event's duration in timer ticks.
60 Given the count direction and the event's start and end timer values,
61 calculate the duration of the event in timer ticks. Information for
62 the current measurement is pointed to by the parameter.
64 If the measurement's start time is 1, it indicates that the developer
65 is indicating that the measurement began at the release of reset.
66 The start time is adjusted to the timer's starting count before performing
67 the elapsed time calculation.
69 The calculated duration, in ticks, is the absolute difference between
70 the measurement's ending and starting counts.
72 @param Measurement Pointer to a MEASUREMENT_RECORD structure containing
73 data for the current measurement.
75 @return The 64-bit duration of the event.
79 IN OUT MEASUREMENT_RECORD
*Measurement
85 // PERF_START macros are called with a value of 1 to indicate
86 // the beginning of time. So, adjust the start ticker value
87 // to the real beginning of time.
88 // Assumes no wraparound. Even then, there is a very low probability
89 // of having a valid StartTicker value of 1.
90 if (Measurement
->StartTimeStamp
== 1) {
91 Measurement
->StartTimeStamp
= TimerInfo
.StartCount
;
93 if (TimerInfo
.CountUp
) {
94 Duration
= Measurement
->EndTimeStamp
- Measurement
->StartTimeStamp
;
95 Error
= (BOOLEAN
)(Duration
> Measurement
->EndTimeStamp
);
98 Duration
= Measurement
->StartTimeStamp
- Measurement
->EndTimeStamp
;
99 Error
= (BOOLEAN
)(Duration
> Measurement
->StartTimeStamp
);
103 DEBUG ((EFI_D_ERROR
, ALit_TimerLibError
));
110 Determine whether the Measurement record is for an EFI Phase.
112 The Token and Module members of the measurement record are checked.
113 Module must be empty and Token must be one of SEC, PEI, DXE, BDS, or SHELL.
115 @param[in] Measurement A pointer to the Measurement record to test.
117 @retval TRUE The measurement record is for an EFI Phase.
118 @retval FALSE The measurement record is NOT for an EFI Phase.
122 IN MEASUREMENT_RECORD
*Measurement
127 RetVal
= (BOOLEAN
)( ( *Measurement
->Module
== '\0') &&
128 ((AsciiStrnCmp (Measurement
->Token
, ALit_SEC
, PERF_TOKEN_LENGTH
) == 0) ||
129 (AsciiStrnCmp (Measurement
->Token
, ALit_PEI
, PERF_TOKEN_LENGTH
) == 0) ||
130 (AsciiStrnCmp (Measurement
->Token
, ALit_DXE
, PERF_TOKEN_LENGTH
) == 0) ||
131 (AsciiStrnCmp (Measurement
->Token
, ALit_BDS
, PERF_TOKEN_LENGTH
) == 0))
137 Get the file name portion of the Pdb File Name.
139 The portion of the Pdb File Name between the last backslash and
140 either a following period or the end of the string is converted
141 to Unicode and copied into UnicodeBuffer. The name is truncated,
142 if necessary, to ensure that UnicodeBuffer is not overrun.
144 @param[in] PdbFileName Pdb file name.
145 @param[out] UnicodeBuffer The resultant Unicode File Name.
149 GetShortPdbFileName (
150 IN CHAR8
*PdbFileName
,
151 OUT CHAR16
*UnicodeBuffer
154 UINTN IndexA
; // Current work location within an ASCII string.
155 UINTN IndexU
; // Current work location within a Unicode string.
159 ZeroMem (UnicodeBuffer
, (DP_GAUGE_STRING_LENGTH
+ 1) * sizeof (CHAR16
));
161 if (PdbFileName
== NULL
) {
162 StrCpyS (UnicodeBuffer
, DP_GAUGE_STRING_LENGTH
+ 1, L
" ");
165 for (EndIndex
= 0; PdbFileName
[EndIndex
] != 0; EndIndex
++)
167 for (IndexA
= 0; PdbFileName
[IndexA
] != 0; IndexA
++) {
168 if (PdbFileName
[IndexA
] == '\\') {
169 StartIndex
= IndexA
+ 1;
172 if (PdbFileName
[IndexA
] == '.') {
178 for (IndexA
= StartIndex
; IndexA
< EndIndex
; IndexA
++) {
179 UnicodeBuffer
[IndexU
] = (CHAR16
) PdbFileName
[IndexA
];
181 if (IndexU
>= DP_GAUGE_STRING_LENGTH
) {
182 UnicodeBuffer
[DP_GAUGE_STRING_LENGTH
] = 0;
190 Get a human readable name for an image handle.
191 The following methods will be tried orderly:
193 2. ComponentName2 protocol
197 6. Unknown Driver Name
201 @post The resulting Unicode name string is stored in the
202 mGaugeString global array.
211 EFI_LOADED_IMAGE_PROTOCOL
*Image
;
213 EFI_DRIVER_BINDING_PROTOCOL
*DriverBinding
;
214 EFI_STRING StringPtr
;
215 EFI_DEVICE_PATH_PROTOCOL
*LoadedImageDevicePath
;
216 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
220 CHAR8
*PlatformLanguage
;
222 EFI_COMPONENT_NAME2_PROTOCOL
*ComponentName2
;
225 LoadedImageDevicePath
= NULL
;
228 PlatformLanguage
= NULL
;
231 // Method 1: Get the name string from image PDB
233 Status
= gBS
->HandleProtocol (
235 &gEfiLoadedImageProtocolGuid
,
239 if (EFI_ERROR (Status
)) {
240 Status
= gBS
->OpenProtocol (
242 &gEfiDriverBindingProtocolGuid
,
243 (VOID
**) &DriverBinding
,
246 EFI_OPEN_PROTOCOL_GET_PROTOCOL
248 if (!EFI_ERROR (Status
)) {
249 Status
= gBS
->HandleProtocol (
250 DriverBinding
->ImageHandle
,
251 &gEfiLoadedImageProtocolGuid
,
257 if (!EFI_ERROR (Status
)) {
258 PdbFileName
= PeCoffLoaderGetPdbPointer (Image
->ImageBase
);
260 if (PdbFileName
!= NULL
) {
261 GetShortPdbFileName (PdbFileName
, mGaugeString
);
267 // Method 2: Get the name string from ComponentName2 protocol
269 Status
= gBS
->HandleProtocol (
271 &gEfiComponentName2ProtocolGuid
,
272 (VOID
**) &ComponentName2
274 if (!EFI_ERROR (Status
)) {
276 // Get the current platform language setting
278 GetEfiGlobalVariable2 (L
"PlatformLang", (VOID
**)&PlatformLanguage
, NULL
);
280 BestLanguage
= GetBestLanguage(
281 ComponentName2
->SupportedLanguages
,
284 ComponentName2
->SupportedLanguages
,
288 SafeFreePool (PlatformLanguage
);
289 Status
= ComponentName2
->GetDriverName (
294 SafeFreePool (BestLanguage
);
295 if (!EFI_ERROR (Status
)) {
298 DP_GAUGE_STRING_LENGTH
+ 1,
300 DP_GAUGE_STRING_LENGTH
306 Status
= gBS
->HandleProtocol (
308 &gEfiLoadedImageDevicePathProtocolGuid
,
309 (VOID
**) &LoadedImageDevicePath
311 if (!EFI_ERROR (Status
) && (LoadedImageDevicePath
!= NULL
)) {
312 DevicePath
= LoadedImageDevicePath
;
313 } else if (Image
!= NULL
) {
314 DevicePath
= Image
->FilePath
;
317 if (DevicePath
!= NULL
) {
319 // Try to get image GUID from image DevicePath
322 while (!IsDevicePathEndType (DevicePath
)) {
323 NameGuid
= EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) DevicePath
);
324 if (NameGuid
!= NULL
) {
327 DevicePath
= NextDevicePathNode (DevicePath
);
330 if (NameGuid
!= NULL
) {
332 // Try to get the image's FFS UI section by image GUID
336 Status
= GetSectionFromAnyFv (
338 EFI_SECTION_USER_INTERFACE
,
340 (VOID
**) &NameString
,
344 if (!EFI_ERROR (Status
)) {
346 // Method 3. Get the name string from FFS UI section
350 DP_GAUGE_STRING_LENGTH
+ 1,
352 DP_GAUGE_STRING_LENGTH
354 FreePool (NameString
);
357 // Method 4: Get the name string from image GUID
359 UnicodeSPrint (mGaugeString
, sizeof (mGaugeString
), L
"%g", NameGuid
);
364 // Method 5: Get the name string from image DevicePath
366 NameString
= ConvertDevicePathToText (DevicePath
, TRUE
, FALSE
);
367 if (NameString
!= NULL
) {
370 DP_GAUGE_STRING_LENGTH
+ 1,
372 DP_GAUGE_STRING_LENGTH
374 FreePool (NameString
);
381 // Method 6: Unknown Driver Name
383 StringPtr
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_ERROR_NAME
), NULL
);
384 ASSERT (StringPtr
!= NULL
);
385 StrCpyS (mGaugeString
, DP_GAUGE_STRING_LENGTH
+ 1, StringPtr
);
386 FreePool (StringPtr
);
391 Calculate the Duration in microseconds.
393 Duration is multiplied by 1000, instead of Frequency being divided by 1000 or
394 multiplying the result by 1000, in order to maintain precision. Since Duration is
395 a 64-bit value, multiplying it by 1000 is unlikely to produce an overflow.
397 The time is calculated as (Duration * 1000) / Timer_Frequency.
399 @param[in] Duration The event duration in timer ticks.
401 @return A 64-bit value which is the Elapsed time in microseconds.
404 DurationInMicroSeconds (
410 Temp
= MultU64x32 (Duration
, 1000);
411 return DivU64x32 (Temp
, TimerInfo
.Frequency
);
415 Formatted Print using a Hii Token to reference the localized format string.
417 @param[in] Token A HII token associated with a localized Unicode string.
418 @param[in] ... The variable argument list.
420 @return The number of characters converted by UnicodeVSPrint().
431 EFI_STRING StringPtr
;
435 StringPtr
= HiiGetString (gHiiHandle
, Token
, NULL
);
436 ASSERT (StringPtr
!= NULL
);
438 VA_START (Marker
, Token
);
440 BufferSize
= (PcdGet32 (PcdUefiLibMaxPrintBufferSize
) + 1) * sizeof (CHAR16
);
442 if (mPrintTokenBuffer
== NULL
) {
443 mPrintTokenBuffer
= AllocatePool (BufferSize
);
444 ASSERT (mPrintTokenBuffer
!= NULL
);
446 SetMem( mPrintTokenBuffer
, BufferSize
, 0);
448 Return
= UnicodeVSPrint (mPrintTokenBuffer
, BufferSize
, StringPtr
, Marker
);
451 if (Return
> 0 && gST
->ConOut
!= NULL
) {
452 gST
->ConOut
->OutputString (gST
->ConOut
, mPrintTokenBuffer
);
454 FreePool (StringPtr
);
459 Get index of Measurement Record's match in the CumData array.
461 If the Measurement's Token value matches a Token in one of the CumData
462 records, the index of the matching record is returned. The returned
463 index is a signed value so that negative values can indicate that
464 the Measurement didn't match any entry in the CumData array.
466 @param[in] Measurement A pointer to a Measurement Record to match against the CumData array.
468 @retval <0 Token is not in the CumData array.
469 @retval >=0 Return value is the index into CumData where Token is found.
473 IN MEASUREMENT_RECORD
*Measurement
478 for( Index
= 0; Index
< (INTN
)NumCum
; ++Index
) {
479 if (AsciiStrnCmp (Measurement
->Token
, CumData
[Index
].Name
, PERF_TOKEN_LENGTH
) == 0) {
480 return Index
; // Exit, we found a match
483 // If the for loop exits, Token was not found.
484 return -1; // Indicate failure