2 Utility functions used by the Dp application.
4 Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
5 (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include <Library/BaseLib.h>
16 #include <Library/BaseMemoryLib.h>
17 #include <Library/MemoryAllocationLib.h>
18 #include <Library/DebugLib.h>
19 #include <Library/UefiBootServicesTableLib.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>
26 #include <Library/HandleParsingLib.h>
28 #include <Pi/PiFirmwareFile.h>
29 #include <Library/DxeServicesLib.h>
31 #include <Protocol/LoadedImage.h>
32 #include <Protocol/DriverBinding.h>
33 #include <Protocol/ComponentName2.h>
34 #include <Protocol/DevicePath.h>
36 #include <Guid/Performance.h>
40 #include "DpInternal.h"
43 Calculate an event's duration in timer ticks.
45 Given the count direction and the event's start and end timer values,
46 calculate the duration of the event in timer ticks. Information for
47 the current measurement is pointed to by the parameter.
49 If the measurement's start time is 1, it indicates that the developer
50 is indicating that the measurement began at the release of reset.
51 The start time is adjusted to the timer's starting count before performing
52 the elapsed time calculation.
54 The calculated duration, in ticks, is the absolute difference between
55 the measurement's ending and starting counts.
57 @param Measurement Pointer to a MEASUREMENT_RECORD structure containing
58 data for the current measurement.
60 @return The 64-bit duration of the event.
64 IN OUT MEASUREMENT_RECORD
*Measurement
70 if (Measurement
->EndTimeStamp
== 0) {
74 Duration
= Measurement
->EndTimeStamp
- Measurement
->StartTimeStamp
;
75 Error
= (BOOLEAN
)(Duration
> Measurement
->EndTimeStamp
);
78 DEBUG ((EFI_D_ERROR
, ALit_TimerLibError
));
85 Determine whether the Measurement record is for an EFI Phase.
87 The Token and Module members of the measurement record are checked.
88 Module must be empty and Token must be one of SEC, PEI, DXE, BDS, or SHELL.
90 @param[in] Measurement A pointer to the Measurement record to test.
92 @retval TRUE The measurement record is for an EFI Phase.
93 @retval FALSE The measurement record is NOT for an EFI Phase.
97 IN MEASUREMENT_RECORD
*Measurement
103 ((AsciiStrCmp (Measurement
->Token
, ALit_SEC
) == 0) ||
104 (AsciiStrCmp (Measurement
->Token
, ALit_PEI
) == 0) ||
105 (AsciiStrCmp (Measurement
->Token
, ALit_DXE
) == 0) ||
106 (AsciiStrCmp (Measurement
->Token
, ALit_BDS
) == 0))
112 Get the file name portion of the Pdb File Name.
114 The portion of the Pdb File Name between the last backslash and
115 either a following period or the end of the string is converted
116 to Unicode and copied into UnicodeBuffer. The name is truncated,
117 if necessary, to ensure that UnicodeBuffer is not overrun.
119 @param[in] PdbFileName Pdb file name.
120 @param[out] UnicodeBuffer The resultant Unicode File Name.
124 DpGetShortPdbFileName (
125 IN CHAR8
*PdbFileName
,
126 OUT CHAR16
*UnicodeBuffer
129 UINTN IndexA
; // Current work location within an ASCII string.
130 UINTN IndexU
; // Current work location within a Unicode string.
134 ZeroMem (UnicodeBuffer
, (DP_GAUGE_STRING_LENGTH
+ 1) * sizeof (CHAR16
));
136 if (PdbFileName
== NULL
) {
137 StrnCpyS (UnicodeBuffer
, DP_GAUGE_STRING_LENGTH
+ 1, L
" ", 1);
140 for (EndIndex
= 0; PdbFileName
[EndIndex
] != 0; EndIndex
++)
142 for (IndexA
= 0; PdbFileName
[IndexA
] != 0; IndexA
++) {
143 if ((PdbFileName
[IndexA
] == '\\') || (PdbFileName
[IndexA
] == '/')) {
144 StartIndex
= IndexA
+ 1;
147 if (PdbFileName
[IndexA
] == '.') {
153 for (IndexA
= StartIndex
; IndexA
< EndIndex
; IndexA
++) {
154 UnicodeBuffer
[IndexU
] = (CHAR16
) PdbFileName
[IndexA
];
156 if (IndexU
>= DP_GAUGE_STRING_LENGTH
) {
157 UnicodeBuffer
[DP_GAUGE_STRING_LENGTH
] = 0;
165 Get a human readable name for an image handle.
166 The following methods will be tried orderly:
168 2. ComponentName2 protocol
172 6. Unknown Driver Name
176 @post The resulting Unicode name string is stored in the
177 mGaugeString global array.
181 DpGetNameFromHandle (
186 EFI_LOADED_IMAGE_PROTOCOL
*Image
;
188 EFI_DRIVER_BINDING_PROTOCOL
*DriverBinding
;
189 EFI_STRING StringPtr
;
190 EFI_DEVICE_PATH_PROTOCOL
*LoadedImageDevicePath
;
191 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
195 CHAR8
*PlatformLanguage
;
197 EFI_COMPONENT_NAME2_PROTOCOL
*ComponentName2
;
200 LoadedImageDevicePath
= NULL
;
204 // Method 1: Get the name string from image PDB
206 Status
= gBS
->HandleProtocol (
208 &gEfiLoadedImageProtocolGuid
,
212 if (EFI_ERROR (Status
)) {
213 Status
= gBS
->OpenProtocol (
215 &gEfiDriverBindingProtocolGuid
,
216 (VOID
**) &DriverBinding
,
219 EFI_OPEN_PROTOCOL_GET_PROTOCOL
221 if (!EFI_ERROR (Status
)) {
222 Status
= gBS
->HandleProtocol (
223 DriverBinding
->ImageHandle
,
224 &gEfiLoadedImageProtocolGuid
,
230 if (!EFI_ERROR (Status
)) {
231 PdbFileName
= PeCoffLoaderGetPdbPointer (Image
->ImageBase
);
233 if (PdbFileName
!= NULL
) {
234 DpGetShortPdbFileName (PdbFileName
, mGaugeString
);
240 // Method 2: Get the name string from ComponentName2 protocol
242 Status
= gBS
->HandleProtocol (
244 &gEfiComponentName2ProtocolGuid
,
245 (VOID
**) &ComponentName2
247 if (!EFI_ERROR (Status
)) {
249 // Firstly use platform language setting, secondly use driver's first supported language.
251 GetVariable2 (L
"PlatformLang", &gEfiGlobalVariableGuid
, (VOID
**)&PlatformLanguage
, NULL
);
252 BestLanguage
= GetBestLanguage(
253 ComponentName2
->SupportedLanguages
,
255 (PlatformLanguage
!= NULL
) ? PlatformLanguage
: "",
256 ComponentName2
->SupportedLanguages
,
259 SHELL_FREE_NON_NULL (PlatformLanguage
);
261 Status
= ComponentName2
->GetDriverName (
263 BestLanguage
!= NULL
? BestLanguage
: "en-US",
266 if (!EFI_ERROR (Status
)) {
267 SHELL_FREE_NON_NULL (BestLanguage
);
268 StrnCpyS (mGaugeString
, DP_GAUGE_STRING_LENGTH
+ 1, StringPtr
, DP_GAUGE_STRING_LENGTH
);
269 mGaugeString
[DP_GAUGE_STRING_LENGTH
] = 0;
274 Status
= gBS
->HandleProtocol (
276 &gEfiLoadedImageDevicePathProtocolGuid
,
277 (VOID
**) &LoadedImageDevicePath
279 if (!EFI_ERROR (Status
) && (LoadedImageDevicePath
!= NULL
)) {
280 DevicePath
= LoadedImageDevicePath
;
281 } else if (Image
!= NULL
) {
282 DevicePath
= Image
->FilePath
;
285 if (DevicePath
!= NULL
) {
287 // Try to get image GUID from image DevicePath
290 while (!IsDevicePathEndType (DevicePath
)) {
291 NameGuid
= EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) DevicePath
);
292 if (NameGuid
!= NULL
) {
295 DevicePath
= NextDevicePathNode (DevicePath
);
298 if (NameGuid
!= NULL
) {
300 // Try to get the image's FFS UI section by image GUID
304 Status
= GetSectionFromAnyFv (
306 EFI_SECTION_USER_INTERFACE
,
308 (VOID
**) &NameString
,
312 if (!EFI_ERROR (Status
)) {
314 // Method 3. Get the name string from FFS UI section
316 StrnCpyS (mGaugeString
, DP_GAUGE_STRING_LENGTH
+ 1, NameString
, DP_GAUGE_STRING_LENGTH
);
317 mGaugeString
[DP_GAUGE_STRING_LENGTH
] = 0;
318 FreePool (NameString
);
321 // Method 4: Get the name string from image GUID
323 UnicodeSPrint (mGaugeString
, sizeof (mGaugeString
), L
"%g", NameGuid
);
328 // Method 5: Get the name string from image DevicePath
330 NameString
= ConvertDevicePathToText (DevicePath
, TRUE
, FALSE
);
331 if (NameString
!= NULL
) {
332 StrnCpyS (mGaugeString
, DP_GAUGE_STRING_LENGTH
+ 1, NameString
, DP_GAUGE_STRING_LENGTH
);
333 mGaugeString
[DP_GAUGE_STRING_LENGTH
] = 0;
334 FreePool (NameString
);
341 // Method 6: Unknown Driver Name
343 StringPtr
= HiiGetString (mDpHiiHandle
, STRING_TOKEN (STR_DP_ERROR_NAME
), NULL
);
344 ASSERT (StringPtr
!= NULL
);
345 StrnCpyS (mGaugeString
, DP_GAUGE_STRING_LENGTH
+ 1, StringPtr
, DP_GAUGE_STRING_LENGTH
);
346 FreePool (StringPtr
);
350 Calculate the Duration in microseconds.
352 Duration is multiplied by 1000, instead of Frequency being divided by 1000 or
353 multiplying the result by 1000, in order to maintain precision. Since Duration is
354 a 64-bit value, multiplying it by 1000 is unlikely to produce an overflow.
356 The time is calculated as (Duration * 1000) / Timer_Frequency.
358 @param[in] Duration The event duration in timer ticks.
360 @return A 64-bit value which is the Elapsed time in microseconds.
363 DurationInMicroSeconds (
367 return DivU64x32 (Duration
, 1000);
371 Get index of Measurement Record's match in the CumData array.
373 If the Measurement's Token value matches a Token in one of the CumData
374 records, the index of the matching record is returned. The returned
375 index is a signed value so that negative values can indicate that
376 the Measurement didn't match any entry in the CumData array.
378 @param[in] Measurement A pointer to a Measurement Record to match against the CumData array.
380 @retval <0 Token is not in the CumData array.
381 @retval >=0 Return value is the index into CumData where Token is found.
385 IN MEASUREMENT_RECORD
*Measurement
390 for( Index
= 0; Index
< (INTN
)NumCum
; ++Index
) {
391 if (AsciiStrCmp (Measurement
->Token
, CumData
[Index
].Name
) == 0) {
392 return Index
; // Exit, we found a match
395 // If the for loop exits, Token was not found.
396 return -1; // Indicate failure