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 Determine whether the Measurement record is for core code.
114 @param[in] Measurement A pointer to the Measurement record to test.
116 @retval TRUE The measurement record is used for core.
117 @retval FALSE The measurement record is NOT used for core.
122 IN MEASUREMENT_RECORD
*Measurement
128 ((Measurement
->Identifier
== MODULE_START_ID
) ||
129 (Measurement
->Identifier
== MODULE_END_ID
) ||
130 (Measurement
->Identifier
== MODULE_LOADIMAGE_START_ID
) ||
131 (Measurement
->Identifier
== MODULE_LOADIMAGE_END_ID
) ||
132 (Measurement
->Identifier
== MODULE_DB_START_ID
) ||
133 (Measurement
->Identifier
== MODULE_DB_END_ID
) ||
134 (Measurement
->Identifier
== MODULE_DB_SUPPORT_START_ID
) ||
135 (Measurement
->Identifier
== MODULE_DB_SUPPORT_END_ID
) ||
136 (Measurement
->Identifier
== MODULE_DB_STOP_START_ID
) ||
137 (Measurement
->Identifier
== MODULE_DB_STOP_START_ID
))
143 Get the file name portion of the Pdb File Name.
145 The portion of the Pdb File Name between the last backslash and
146 either a following period or the end of the string is converted
147 to Unicode and copied into UnicodeBuffer. The name is truncated,
148 if necessary, to ensure that UnicodeBuffer is not overrun.
150 @param[in] PdbFileName Pdb file name.
151 @param[out] UnicodeBuffer The resultant Unicode File Name.
155 DpGetShortPdbFileName (
156 IN CHAR8
*PdbFileName
,
157 OUT CHAR16
*UnicodeBuffer
160 UINTN IndexA
; // Current work location within an ASCII string.
161 UINTN IndexU
; // Current work location within a Unicode string.
165 ZeroMem (UnicodeBuffer
, (DP_GAUGE_STRING_LENGTH
+ 1) * sizeof (CHAR16
));
167 if (PdbFileName
== NULL
) {
168 StrnCpyS (UnicodeBuffer
, DP_GAUGE_STRING_LENGTH
+ 1, L
" ", 1);
171 for (EndIndex
= 0; PdbFileName
[EndIndex
] != 0; EndIndex
++)
173 for (IndexA
= 0; PdbFileName
[IndexA
] != 0; IndexA
++) {
174 if ((PdbFileName
[IndexA
] == '\\') || (PdbFileName
[IndexA
] == '/')) {
175 StartIndex
= IndexA
+ 1;
178 if (PdbFileName
[IndexA
] == '.') {
184 for (IndexA
= StartIndex
; IndexA
< EndIndex
; IndexA
++) {
185 UnicodeBuffer
[IndexU
] = (CHAR16
) PdbFileName
[IndexA
];
187 if (IndexU
>= DP_GAUGE_STRING_LENGTH
) {
188 UnicodeBuffer
[DP_GAUGE_STRING_LENGTH
] = 0;
196 Get a human readable name for an image handle.
197 The following methods will be tried orderly:
199 2. ComponentName2 protocol
203 6. Unknown Driver Name
207 @post The resulting Unicode name string is stored in the
208 mGaugeString global array.
212 DpGetNameFromHandle (
217 EFI_LOADED_IMAGE_PROTOCOL
*Image
;
219 EFI_DRIVER_BINDING_PROTOCOL
*DriverBinding
;
220 EFI_STRING StringPtr
;
221 EFI_DEVICE_PATH_PROTOCOL
*LoadedImageDevicePath
;
222 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
226 CHAR8
*PlatformLanguage
;
228 EFI_COMPONENT_NAME2_PROTOCOL
*ComponentName2
;
231 LoadedImageDevicePath
= NULL
;
235 // Method 1: Get the name string from image PDB
237 Status
= gBS
->HandleProtocol (
239 &gEfiLoadedImageProtocolGuid
,
243 if (EFI_ERROR (Status
)) {
244 Status
= gBS
->OpenProtocol (
246 &gEfiDriverBindingProtocolGuid
,
247 (VOID
**) &DriverBinding
,
250 EFI_OPEN_PROTOCOL_GET_PROTOCOL
252 if (!EFI_ERROR (Status
)) {
253 Status
= gBS
->HandleProtocol (
254 DriverBinding
->ImageHandle
,
255 &gEfiLoadedImageProtocolGuid
,
261 if (!EFI_ERROR (Status
)) {
262 PdbFileName
= PeCoffLoaderGetPdbPointer (Image
->ImageBase
);
264 if (PdbFileName
!= NULL
) {
265 DpGetShortPdbFileName (PdbFileName
, mGaugeString
);
271 // Method 2: Get the name string from ComponentName2 protocol
273 Status
= gBS
->HandleProtocol (
275 &gEfiComponentName2ProtocolGuid
,
276 (VOID
**) &ComponentName2
278 if (!EFI_ERROR (Status
)) {
280 // Firstly use platform language setting, secondly use driver's first supported language.
282 GetVariable2 (L
"PlatformLang", &gEfiGlobalVariableGuid
, (VOID
**)&PlatformLanguage
, NULL
);
283 BestLanguage
= GetBestLanguage(
284 ComponentName2
->SupportedLanguages
,
286 (PlatformLanguage
!= NULL
) ? PlatformLanguage
: "",
287 ComponentName2
->SupportedLanguages
,
290 SHELL_FREE_NON_NULL (PlatformLanguage
);
292 Status
= ComponentName2
->GetDriverName (
294 BestLanguage
!= NULL
? BestLanguage
: "en-US",
297 if (!EFI_ERROR (Status
)) {
298 SHELL_FREE_NON_NULL (BestLanguage
);
299 StrnCpyS (mGaugeString
, DP_GAUGE_STRING_LENGTH
+ 1, StringPtr
, DP_GAUGE_STRING_LENGTH
);
300 mGaugeString
[DP_GAUGE_STRING_LENGTH
] = 0;
305 Status
= gBS
->HandleProtocol (
307 &gEfiLoadedImageDevicePathProtocolGuid
,
308 (VOID
**) &LoadedImageDevicePath
310 if (!EFI_ERROR (Status
) && (LoadedImageDevicePath
!= NULL
)) {
311 DevicePath
= LoadedImageDevicePath
;
312 } else if (Image
!= NULL
) {
313 DevicePath
= Image
->FilePath
;
316 if (DevicePath
!= NULL
) {
318 // Try to get image GUID from image DevicePath
321 while (!IsDevicePathEndType (DevicePath
)) {
322 NameGuid
= EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) DevicePath
);
323 if (NameGuid
!= NULL
) {
326 DevicePath
= NextDevicePathNode (DevicePath
);
329 if (NameGuid
!= NULL
) {
331 // Try to get the image's FFS UI section by image GUID
335 Status
= GetSectionFromAnyFv (
337 EFI_SECTION_USER_INTERFACE
,
339 (VOID
**) &NameString
,
343 if (!EFI_ERROR (Status
)) {
345 // Method 3. Get the name string from FFS UI section
347 StrnCpyS (mGaugeString
, DP_GAUGE_STRING_LENGTH
+ 1, NameString
, DP_GAUGE_STRING_LENGTH
);
348 mGaugeString
[DP_GAUGE_STRING_LENGTH
] = 0;
349 FreePool (NameString
);
352 // Method 4: Get the name string from image GUID
354 UnicodeSPrint (mGaugeString
, sizeof (mGaugeString
), L
"%g", NameGuid
);
359 // Method 5: Get the name string from image DevicePath
361 NameString
= ConvertDevicePathToText (DevicePath
, TRUE
, FALSE
);
362 if (NameString
!= NULL
) {
363 StrnCpyS (mGaugeString
, DP_GAUGE_STRING_LENGTH
+ 1, NameString
, DP_GAUGE_STRING_LENGTH
);
364 mGaugeString
[DP_GAUGE_STRING_LENGTH
] = 0;
365 FreePool (NameString
);
372 // Method 6: Unknown Driver Name
374 StringPtr
= HiiGetString (mDpHiiHandle
, STRING_TOKEN (STR_DP_ERROR_NAME
), NULL
);
375 ASSERT (StringPtr
!= NULL
);
376 StrnCpyS (mGaugeString
, DP_GAUGE_STRING_LENGTH
+ 1, StringPtr
, DP_GAUGE_STRING_LENGTH
);
377 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 (
398 return DivU64x32 (Duration
, 1000);
402 Get index of Measurement Record's match in the CumData array.
404 If the Measurement's Token value matches a Token in one of the CumData
405 records, the index of the matching record is returned. The returned
406 index is a signed value so that negative values can indicate that
407 the Measurement didn't match any entry in the CumData array.
409 @param[in] Measurement A pointer to a Measurement Record to match against the CumData array.
411 @retval <0 Token is not in the CumData array.
412 @retval >=0 Return value is the index into CumData where Token is found.
416 IN MEASUREMENT_RECORD
*Measurement
421 for( Index
= 0; Index
< (INTN
)NumCum
; ++Index
) {
422 if (AsciiStrCmp (Measurement
->Token
, CumData
[Index
].Name
) == 0) {
423 return Index
; // Exit, we found a match
426 // If the for loop exits, Token was not found.
427 return -1; // Indicate failure