2 Utility functions used by the Dp application.
4 Copyright (c) 2009 - 2015, 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 PlatformLanguage
= NULL
;
228 // Method 1: Get the name string from image PDB
230 Status
= gBS
->HandleProtocol (
232 &gEfiLoadedImageProtocolGuid
,
236 if (EFI_ERROR (Status
)) {
237 Status
= gBS
->OpenProtocol (
239 &gEfiDriverBindingProtocolGuid
,
240 (VOID
**) &DriverBinding
,
243 EFI_OPEN_PROTOCOL_GET_PROTOCOL
245 if (!EFI_ERROR (Status
)) {
246 Status
= gBS
->HandleProtocol (
247 DriverBinding
->ImageHandle
,
248 &gEfiLoadedImageProtocolGuid
,
254 if (!EFI_ERROR (Status
)) {
255 PdbFileName
= PeCoffLoaderGetPdbPointer (Image
->ImageBase
);
257 if (PdbFileName
!= NULL
) {
258 GetShortPdbFileName (PdbFileName
, mGaugeString
);
264 // Method 2: Get the name string from ComponentName2 protocol
266 Status
= gBS
->HandleProtocol (
268 &gEfiComponentName2ProtocolGuid
,
269 (VOID
**) &ComponentName2
271 if (!EFI_ERROR (Status
)) {
273 // Get the current platform language setting
275 GetEfiGlobalVariable2 (L
"PlatformLang", (VOID
**)&PlatformLanguage
, NULL
);
277 BestLanguage
= GetBestLanguage(
278 ComponentName2
->SupportedLanguages
,
281 ComponentName2
->SupportedLanguages
,
285 SafeFreePool (PlatformLanguage
);
286 Status
= ComponentName2
->GetDriverName (
291 SafeFreePool (BestLanguage
);
292 if (!EFI_ERROR (Status
)) {
295 DP_GAUGE_STRING_LENGTH
+ 1,
302 Status
= gBS
->HandleProtocol (
304 &gEfiLoadedImageDevicePathProtocolGuid
,
305 (VOID
**) &LoadedImageDevicePath
307 if (!EFI_ERROR (Status
) && (LoadedImageDevicePath
!= NULL
)) {
308 DevicePath
= LoadedImageDevicePath
;
311 // Try to get image GUID from LoadedImageDevicePath protocol
314 while (!IsDevicePathEndType (DevicePath
)) {
315 NameGuid
= EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) DevicePath
);
316 if (NameGuid
!= NULL
) {
319 DevicePath
= NextDevicePathNode (DevicePath
);
322 if (NameGuid
!= NULL
) {
324 // Try to get the image's FFS UI section by image GUID
328 Status
= GetSectionFromAnyFv (
330 EFI_SECTION_USER_INTERFACE
,
332 (VOID
**) &NameString
,
336 if (!EFI_ERROR (Status
)) {
338 // Method 3. Get the name string from FFS UI section
342 DP_GAUGE_STRING_LENGTH
+ 1,
345 FreePool (NameString
);
348 // Method 4: Get the name string from image GUID
350 UnicodeSPrint (mGaugeString
, sizeof (mGaugeString
), L
"%g", NameGuid
);
355 // Method 5: Get the name string from image DevicePath
357 NameString
= ConvertDevicePathToText (LoadedImageDevicePath
, TRUE
, FALSE
);
358 if (NameString
!= NULL
) {
361 DP_GAUGE_STRING_LENGTH
+ 1,
364 FreePool (NameString
);
371 // Method 6: Unknown Driver Name
373 StringPtr
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_DP_ERROR_NAME
), NULL
);
374 ASSERT (StringPtr
!= NULL
);
375 StrCpyS (mGaugeString
, DP_GAUGE_STRING_LENGTH
+ 1, StringPtr
);
376 FreePool (StringPtr
);
381 Calculate the Duration in microseconds.
383 Duration is multiplied by 1000, instead of Frequency being divided by 1000 or
384 multiplying the result by 1000, in order to maintain precision. Since Duration is
385 a 64-bit value, multiplying it by 1000 is unlikely to produce an overflow.
387 The time is calculated as (Duration * 1000) / Timer_Frequency.
389 @param[in] Duration The event duration in timer ticks.
391 @return A 64-bit value which is the Elapsed time in microseconds.
394 DurationInMicroSeconds (
400 Temp
= MultU64x32 (Duration
, 1000);
401 return DivU64x32 (Temp
, TimerInfo
.Frequency
);
405 Formatted Print using a Hii Token to reference the localized format string.
407 @param[in] Token A HII token associated with a localized Unicode string.
408 @param[in] ... The variable argument list.
410 @return The number of characters converted by UnicodeVSPrint().
421 EFI_STRING StringPtr
;
425 StringPtr
= HiiGetString (gHiiHandle
, Token
, NULL
);
426 ASSERT (StringPtr
!= NULL
);
428 VA_START (Marker
, Token
);
430 BufferSize
= (PcdGet32 (PcdUefiLibMaxPrintBufferSize
) + 1) * sizeof (CHAR16
);
432 if (mPrintTokenBuffer
== NULL
) {
433 mPrintTokenBuffer
= AllocatePool (BufferSize
);
434 ASSERT (mPrintTokenBuffer
!= NULL
);
436 SetMem( mPrintTokenBuffer
, BufferSize
, 0);
438 Return
= UnicodeVSPrint (mPrintTokenBuffer
, BufferSize
, StringPtr
, Marker
);
441 if (Return
> 0 && gST
->ConOut
!= NULL
) {
442 gST
->ConOut
->OutputString (gST
->ConOut
, mPrintTokenBuffer
);
444 FreePool (StringPtr
);
449 Get index of Measurement Record's match in the CumData array.
451 If the Measurement's Token value matches a Token in one of the CumData
452 records, the index of the matching record is returned. The returned
453 index is a signed value so that negative values can indicate that
454 the Measurement didn't match any entry in the CumData array.
456 @param[in] Measurement A pointer to a Measurement Record to match against the CumData array.
458 @retval <0 Token is not in the CumData array.
459 @retval >=0 Return value is the index into CumData where Token is found.
463 IN MEASUREMENT_RECORD
*Measurement
468 for( Index
= 0; Index
< (INTN
)NumCum
; ++Index
) {
469 if (AsciiStrnCmp (Measurement
->Token
, CumData
[Index
].Name
, PERF_TOKEN_LENGTH
) == 0) {
470 return Index
; // Exit, we found a match
473 // If the for loop exits, Token was not found.
474 return -1; // Indicate failure