[mirror_edk2.git] / ShellPkg / DynamicCommand / DpDynamicCommand / DpUtilities.c

/** @file\r
  Utility functions used by the Dp application.\r
\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.\r
  (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/PeCoffGetEntryPointLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/HandleParsingLib.h>\r
\r
#include <Pi/PiFirmwareFile.h>\r
#include <Library/DxeServicesLib.h>\r
\r
#include <Protocol/LoadedImage.h>\r
#include <Protocol/DriverBinding.h>\r
#include <Protocol/ComponentName2.h>\r
#include <Protocol/DevicePath.h>\r
\r
#include <Guid/Performance.h>\r
\r
#include "Dp.h"\r
#include "Literals.h"\r
#include "DpInternal.h"\r
\r
/**\r
  Calculate an event's duration in timer ticks.\r
\r
  Given the count direction and the event's start and end timer values,\r
  calculate the duration of the event in timer ticks.  Information for\r
  the current measurement is pointed to by the parameter.\r
\r
  If the measurement's start time is 1, it indicates that the developer\r
  is indicating that the measurement began at the release of reset.\r
  The start time is adjusted to the timer's starting count before performing\r
  the elapsed time calculation.\r
\r
  The calculated duration, in ticks, is the absolute difference between\r
  the measurement's ending and starting counts.\r
\r
  @param Measurement   Pointer to a MEASUREMENT_RECORD structure containing\r
                       data for the current measurement.\r
\r
  @return              The 64-bit duration of the event.\r
**/\r
UINT64\r
GetDuration (\r
  IN OUT MEASUREMENT_RECORD   *Measurement\r
  )\r
{\r
  UINT64    Duration;\r
  BOOLEAN   Error;\r
\r
  if (Measurement->EndTimeStamp == 0) {\r
    return 0;\r
  }\r
\r
  Duration = Measurement->EndTimeStamp - Measurement->StartTimeStamp;\r
  Error = (BOOLEAN)(Duration > Measurement->EndTimeStamp);\r
\r
  if (Error) {\r
    DEBUG ((EFI_D_ERROR, ALit_TimerLibError));\r
    Duration = 0;\r
  }\r
  return Duration;\r
}\r
\r
/**\r
  Determine whether the Measurement record is for an EFI Phase.\r
\r
  The Token and Module members of the measurement record are checked.\r
  Module must be empty and Token must be one of SEC, PEI, DXE, BDS, or SHELL.\r
\r
  @param[in]  Measurement A pointer to the Measurement record to test.\r
\r
  @retval     TRUE        The measurement record is for an EFI Phase.\r
  @retval     FALSE       The measurement record is NOT for an EFI Phase.\r
**/\r
BOOLEAN\r
IsPhase(\r
  IN MEASUREMENT_RECORD        *Measurement\r
  )\r
{\r
  BOOLEAN   RetVal;\r
\r
  RetVal = (BOOLEAN)(\r
            ((AsciiStrCmp (Measurement->Token, ALit_SEC) == 0)    ||\r
             (AsciiStrCmp (Measurement->Token, ALit_PEI) == 0)    ||\r
             (AsciiStrCmp (Measurement->Token, ALit_DXE) == 0)    ||\r
             (AsciiStrCmp (Measurement->Token, ALit_BDS) == 0))\r
            );\r
  return RetVal;\r
}\r
\r
/**\r
  Determine whether the Measurement record is for core code.\r
\r
  @param[in] Measurement  A pointer to the Measurement record to test.\r
\r
  @retval     TRUE        The measurement record is used for core.\r
  @retval     FALSE       The measurement record is NOT used for core.\r
\r
**/\r
BOOLEAN\r
IsCorePerf(\r
  IN MEASUREMENT_RECORD        *Measurement\r
  )\r
{\r
  BOOLEAN   RetVal;\r
\r
  RetVal = (BOOLEAN)(\r
            ((Measurement->Identifier == MODULE_START_ID)            ||\r
             (Measurement->Identifier == MODULE_END_ID)              ||\r
             (Measurement->Identifier == MODULE_LOADIMAGE_START_ID)  ||\r
             (Measurement->Identifier == MODULE_LOADIMAGE_END_ID)    ||\r
             (Measurement->Identifier == MODULE_DB_START_ID)         ||\r
             (Measurement->Identifier == MODULE_DB_END_ID)           ||\r
             (Measurement->Identifier == MODULE_DB_SUPPORT_START_ID) ||\r
             (Measurement->Identifier == MODULE_DB_SUPPORT_END_ID)   ||\r
             (Measurement->Identifier == MODULE_DB_STOP_START_ID)    ||\r
             (Measurement->Identifier == MODULE_DB_STOP_START_ID))\r
            );\r
  return RetVal;\r
}\r
\r
/**\r
  Get the file name portion of the Pdb File Name.\r
\r
  The portion of the Pdb File Name between the last backslash and\r
  either a following period or the end of the string is converted\r
  to Unicode and copied into UnicodeBuffer.  The name is truncated,\r
  if necessary, to ensure that UnicodeBuffer is not overrun.\r
\r
  @param[in]  PdbFileName     Pdb file name.\r
  @param[out] UnicodeBuffer   The resultant Unicode File Name.\r
\r
**/\r
VOID\r
DpGetShortPdbFileName (\r
  IN  CHAR8     *PdbFileName,\r
  OUT CHAR16    *UnicodeBuffer\r
  )\r
{\r
  UINTN IndexA;     // Current work location within an ASCII string.\r
  UINTN IndexU;     // Current work location within a Unicode string.\r
  UINTN StartIndex;\r
  UINTN EndIndex;\r
\r
  ZeroMem (UnicodeBuffer, (DP_GAUGE_STRING_LENGTH + 1) * sizeof (CHAR16));\r
\r
  if (PdbFileName == NULL) {\r
    StrnCpyS (UnicodeBuffer, DP_GAUGE_STRING_LENGTH + 1, L" ", 1);\r
  } else {\r
    StartIndex = 0;\r
    for (EndIndex = 0; PdbFileName[EndIndex] != 0; EndIndex++)\r
      ;\r
    for (IndexA = 0; PdbFileName[IndexA] != 0; IndexA++) {\r
      if ((PdbFileName[IndexA] == '\\') || (PdbFileName[IndexA] == '/')) {\r
        StartIndex = IndexA + 1;\r
      }\r
\r
      if (PdbFileName[IndexA] == '.') {\r
        EndIndex = IndexA;\r
      }\r
    }\r
\r
    IndexU = 0;\r
    for (IndexA = StartIndex; IndexA < EndIndex; IndexA++) {\r
      UnicodeBuffer[IndexU] = (CHAR16) PdbFileName[IndexA];\r
      IndexU++;\r
      if (IndexU >= DP_GAUGE_STRING_LENGTH) {\r
        UnicodeBuffer[DP_GAUGE_STRING_LENGTH] = 0;\r
        break;\r
      }\r
    }\r
  }\r
}\r
\r
/**\r
  Get a human readable name for an image handle.\r
  The following methods will be tried orderly:\r
    1. Image PDB\r
    2. ComponentName2 protocol\r
    3. FFS UI section\r
    4. Image GUID\r
    5. Image DevicePath\r
    6. Unknown Driver Name\r
\r
  @param[in]    Handle\r
\r
  @post   The resulting Unicode name string is stored in the\r
          mGaugeString global array.\r
\r
**/\r
VOID\r
DpGetNameFromHandle (\r
  IN EFI_HANDLE   Handle\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  EFI_LOADED_IMAGE_PROTOCOL    *Image;\r
  CHAR8                        *PdbFileName;\r
  EFI_DRIVER_BINDING_PROTOCOL  *DriverBinding;\r
  EFI_STRING                   StringPtr;\r
  EFI_DEVICE_PATH_PROTOCOL     *LoadedImageDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL     *DevicePath;\r
  EFI_GUID                     *NameGuid;\r
  CHAR16                       *NameString;\r
  UINTN                        StringSize;\r
  CHAR8                        *PlatformLanguage;\r
  CHAR8                        *BestLanguage;\r
  EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2;\r
\r
  Image = NULL;\r
  LoadedImageDevicePath = NULL;\r
  DevicePath = NULL;\r
\r
  //\r
  // Method 1: Get the name string from image PDB\r
  //\r
  Status = gBS->HandleProtocol (\r
                  Handle,\r
                  &gEfiLoadedImageProtocolGuid,\r
                  (VOID **) &Image\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    Status = gBS->OpenProtocol (\r
                    Handle,\r
                    &gEfiDriverBindingProtocolGuid,\r
                    (VOID **) &DriverBinding,\r
                    NULL,\r
                    NULL,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (!EFI_ERROR (Status)) {\r
      Status = gBS->HandleProtocol (\r
                      DriverBinding->ImageHandle,\r
                      &gEfiLoadedImageProtocolGuid,\r
                      (VOID **) &Image\r
                      );\r
    }\r
  }\r
\r
  if (!EFI_ERROR (Status)) {\r
    PdbFileName = PeCoffLoaderGetPdbPointer (Image->ImageBase);\r
\r
    if (PdbFileName != NULL) {\r
      DpGetShortPdbFileName (PdbFileName, mGaugeString);\r
      return;\r
    }\r
  }\r
\r
  //\r
  // Method 2: Get the name string from ComponentName2 protocol\r
  //\r
  Status = gBS->HandleProtocol (\r
                  Handle,\r
                  &gEfiComponentName2ProtocolGuid,\r
                  (VOID **) &ComponentName2\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // Firstly use platform language setting, secondly use driver's first supported language.\r
    //\r
    GetVariable2 (L"PlatformLang", &gEfiGlobalVariableGuid, (VOID**)&PlatformLanguage, NULL);\r
    BestLanguage = GetBestLanguage(\r
                     ComponentName2->SupportedLanguages,\r
                     FALSE,\r
                     (PlatformLanguage != NULL) ? PlatformLanguage : "",\r
                     ComponentName2->SupportedLanguages,\r
                     NULL\r
                     );\r
    SHELL_FREE_NON_NULL (PlatformLanguage);\r
\r
    Status = ComponentName2->GetDriverName (\r
                               ComponentName2,\r
                               BestLanguage != NULL ? BestLanguage : "en-US",\r
                               &StringPtr\r
                               );\r
    if (!EFI_ERROR (Status)) {\r
      SHELL_FREE_NON_NULL (BestLanguage);\r
      StrnCpyS (mGaugeString, DP_GAUGE_STRING_LENGTH + 1, StringPtr, DP_GAUGE_STRING_LENGTH);\r
      mGaugeString[DP_GAUGE_STRING_LENGTH] = 0;\r
      return;\r
    }\r
  }\r
\r
  Status = gBS->HandleProtocol (\r
                  Handle,\r
                  &gEfiLoadedImageDevicePathProtocolGuid,\r
                  (VOID **) &LoadedImageDevicePath\r
                  );\r
  if (!EFI_ERROR (Status) && (LoadedImageDevicePath != NULL)) {\r
    DevicePath = LoadedImageDevicePath;\r
  } else if (Image != NULL) {\r
    DevicePath = Image->FilePath;\r
  }\r
\r
  if (DevicePath != NULL) {\r
    //\r
    // Try to get image GUID from image DevicePath\r
    //\r
    NameGuid = NULL;\r
    while (!IsDevicePathEndType (DevicePath)) {\r
      NameGuid = EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *) DevicePath);\r
      if (NameGuid != NULL) {\r
        break;\r
      }\r
      DevicePath = NextDevicePathNode (DevicePath);\r
    }\r
\r
    if (NameGuid != NULL) {\r
      //\r
      // Try to get the image's FFS UI section by image GUID\r
      //\r
      NameString = NULL;\r
      StringSize = 0;\r
      Status = GetSectionFromAnyFv (\r
                NameGuid,\r
                EFI_SECTION_USER_INTERFACE,\r
                0,\r
                (VOID **) &NameString,\r
                &StringSize\r
                );\r
\r
      if (!EFI_ERROR (Status)) {\r
        //\r
        // Method 3. Get the name string from FFS UI section\r
        //\r
        StrnCpyS (mGaugeString, DP_GAUGE_STRING_LENGTH + 1, NameString, DP_GAUGE_STRING_LENGTH);\r
        mGaugeString[DP_GAUGE_STRING_LENGTH] = 0;\r
        FreePool (NameString);\r
      } else {\r
        //\r
        // Method 4: Get the name string from image GUID\r
        //\r
        UnicodeSPrint (mGaugeString, sizeof (mGaugeString), L"%g", NameGuid);\r
      }\r
      return;\r
    } else {\r
      //\r
      // Method 5: Get the name string from image DevicePath\r
      //\r
      NameString = ConvertDevicePathToText (DevicePath, TRUE, FALSE);\r
      if (NameString != NULL) {\r
        StrnCpyS (mGaugeString, DP_GAUGE_STRING_LENGTH + 1, NameString, DP_GAUGE_STRING_LENGTH);\r
        mGaugeString[DP_GAUGE_STRING_LENGTH] = 0;\r
        FreePool (NameString);\r
        return;\r
      }\r
    }\r
  }\r
\r
  //\r
  // Method 6: Unknown Driver Name\r
  //\r
  StringPtr = HiiGetString (mDpHiiHandle, STRING_TOKEN (STR_DP_ERROR_NAME), NULL);\r
  ASSERT (StringPtr != NULL);\r
  StrnCpyS (mGaugeString, DP_GAUGE_STRING_LENGTH + 1, StringPtr, DP_GAUGE_STRING_LENGTH);\r
  FreePool (StringPtr);\r
}\r
\r
/**\r
  Calculate the Duration in microseconds.\r
\r
  Duration is multiplied by 1000, instead of Frequency being divided by 1000 or\r
  multiplying the result by 1000, in order to maintain precision.  Since Duration is\r
  a 64-bit value, multiplying it by 1000 is unlikely to produce an overflow.\r
\r
  The time is calculated as (Duration * 1000) / Timer_Frequency.\r
\r
  @param[in]  Duration   The event duration in timer ticks.\r
\r
  @return     A 64-bit value which is the Elapsed time in microseconds.\r
**/\r
UINT64\r
DurationInMicroSeconds (\r
  IN UINT64 Duration\r
  )\r
{\r
  return DivU64x32 (Duration, 1000);\r
}\r
\r
/**\r
  Get index of Measurement Record's match in the CumData array.\r
\r
  If the Measurement's Token value matches a Token in one of the CumData\r
  records, the index of the matching record is returned.  The returned\r
  index is a signed value so that negative values can indicate that\r
  the Measurement didn't match any entry in the CumData array.\r
\r
  @param[in]  Measurement A pointer to a Measurement Record to match against the CumData array.\r
\r
  @retval     <0    Token is not in the CumData array.\r
  @retval     >=0   Return value is the index into CumData where Token is found.\r
**/\r
INTN\r
GetCumulativeItem(\r
  IN MEASUREMENT_RECORD   *Measurement\r
  )\r
{\r
  INTN    Index;\r
\r
  for( Index = 0; Index < (INTN)NumCum; ++Index) {\r
    if (AsciiStrCmp (Measurement->Token, CumData[Index].Name) == 0) {\r
      return Index;  // Exit, we found a match\r
    }\r
  }\r
  // If the for loop exits, Token was not found.\r
  return -1;   // Indicate failure\r
}\r
Commit	Line	Data
	1	/** @file\r
	2	Utility functions used by the Dp application.\r
	3	\r
	4	Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.\r
	5	(C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>\r
	6	SPDX-License-Identifier: BSD-2-Clause-Patent\r
	7	**/\r
	8	\r
	9	#include <Library/BaseLib.h>\r
	10	#include <Library/BaseMemoryLib.h>\r
	11	#include <Library/MemoryAllocationLib.h>\r
	12	#include <Library/DebugLib.h>\r
	13	#include <Library/UefiBootServicesTableLib.h>\r
	14	#include <Library/PeCoffGetEntryPointLib.h>\r
	15	#include <Library/PrintLib.h>\r
	16	#include <Library/HiiLib.h>\r
	17	#include <Library/PcdLib.h>\r
	18	#include <Library/UefiLib.h>\r
	19	#include <Library/DevicePathLib.h>\r
	20	#include <Library/HandleParsingLib.h>\r
	21	\r
	22	#include <Pi/PiFirmwareFile.h>\r
	23	#include <Library/DxeServicesLib.h>\r
	24	\r
	25	#include <Protocol/LoadedImage.h>\r
	26	#include <Protocol/DriverBinding.h>\r
	27	#include <Protocol/ComponentName2.h>\r
	28	#include <Protocol/DevicePath.h>\r
	29	\r
	30	#include <Guid/Performance.h>\r
	31	\r
	32	#include "Dp.h"\r
	33	#include "Literals.h"\r
	34	#include "DpInternal.h"\r
	35	\r
	36	/**\r
	37	Calculate an event's duration in timer ticks.\r
	38	\r
	39	Given the count direction and the event's start and end timer values,\r
	40	calculate the duration of the event in timer ticks. Information for\r
	41	the current measurement is pointed to by the parameter.\r
	42	\r
	43	If the measurement's start time is 1, it indicates that the developer\r
	44	is indicating that the measurement began at the release of reset.\r
	45	The start time is adjusted to the timer's starting count before performing\r
	46	the elapsed time calculation.\r
	47	\r
	48	The calculated duration, in ticks, is the absolute difference between\r
	49	the measurement's ending and starting counts.\r
	50	\r
	51	@param Measurement Pointer to a MEASUREMENT_RECORD structure containing\r
	52	data for the current measurement.\r
	53	\r
	54	@return The 64-bit duration of the event.\r
	55	**/\r
	56	UINT64\r
	57	GetDuration (\r
	58	IN OUT MEASUREMENT_RECORD *Measurement\r
	59	)\r
	60	{\r
	61	UINT64 Duration;\r
	62	BOOLEAN Error;\r
	63	\r
	64	if (Measurement->EndTimeStamp == 0) {\r
	65	return 0;\r
	66	}\r
	67	\r
	68	Duration = Measurement->EndTimeStamp - Measurement->StartTimeStamp;\r
	69	Error = (BOOLEAN)(Duration > Measurement->EndTimeStamp);\r
	70	\r
	71	if (Error) {\r
	72	DEBUG ((EFI_D_ERROR, ALit_TimerLibError));\r
	73	Duration = 0;\r
	74	}\r
	75	return Duration;\r
	76	}\r
	77	\r
	78	/**\r
	79	Determine whether the Measurement record is for an EFI Phase.\r
	80	\r
	81	The Token and Module members of the measurement record are checked.\r
	82	Module must be empty and Token must be one of SEC, PEI, DXE, BDS, or SHELL.\r
	83	\r
	84	@param[in] Measurement A pointer to the Measurement record to test.\r
	85	\r
	86	@retval TRUE The measurement record is for an EFI Phase.\r
	87	@retval FALSE The measurement record is NOT for an EFI Phase.\r
	88	**/\r
	89	BOOLEAN\r
	90	IsPhase(\r
	91	IN MEASUREMENT_RECORD *Measurement\r
	92	)\r
	93	{\r
	94	BOOLEAN RetVal;\r
	95	\r
	96	RetVal = (BOOLEAN)(\r
	97	((AsciiStrCmp (Measurement->Token, ALit_SEC) == 0) \|\|\r
	98	(AsciiStrCmp (Measurement->Token, ALit_PEI) == 0) \|\|\r
	99	(AsciiStrCmp (Measurement->Token, ALit_DXE) == 0) \|\|\r
	100	(AsciiStrCmp (Measurement->Token, ALit_BDS) == 0))\r
	101	);\r
	102	return RetVal;\r
	103	}\r
	104	\r
	105	/**\r
	106	Determine whether the Measurement record is for core code.\r
	107	\r
	108	@param[in] Measurement A pointer to the Measurement record to test.\r
	109	\r
	110	@retval TRUE The measurement record is used for core.\r
	111	@retval FALSE The measurement record is NOT used for core.\r
	112	\r
	113	**/\r
	114	BOOLEAN\r
	115	IsCorePerf(\r
	116	IN MEASUREMENT_RECORD *Measurement\r
	117	)\r
	118	{\r
	119	BOOLEAN RetVal;\r
	120	\r
	121	RetVal = (BOOLEAN)(\r
	122	((Measurement->Identifier == MODULE_START_ID) \|\|\r
	123	(Measurement->Identifier == MODULE_END_ID) \|\|\r
	124	(Measurement->Identifier == MODULE_LOADIMAGE_START_ID) \|\|\r
	125	(Measurement->Identifier == MODULE_LOADIMAGE_END_ID) \|\|\r
	126	(Measurement->Identifier == MODULE_DB_START_ID) \|\|\r
	127	(Measurement->Identifier == MODULE_DB_END_ID) \|\|\r
	128	(Measurement->Identifier == MODULE_DB_SUPPORT_START_ID) \|\|\r
	129	(Measurement->Identifier == MODULE_DB_SUPPORT_END_ID) \|\|\r
	130	(Measurement->Identifier == MODULE_DB_STOP_START_ID) \|\|\r
	131	(Measurement->Identifier == MODULE_DB_STOP_START_ID))\r
	132	);\r
	133	return RetVal;\r
	134	}\r
	135	\r
	136	/**\r
	137	Get the file name portion of the Pdb File Name.\r
	138	\r
	139	The portion of the Pdb File Name between the last backslash and\r
	140	either a following period or the end of the string is converted\r
	141	to Unicode and copied into UnicodeBuffer. The name is truncated,\r
	142	if necessary, to ensure that UnicodeBuffer is not overrun.\r
	143	\r
	144	@param[in] PdbFileName Pdb file name.\r
	145	@param[out] UnicodeBuffer The resultant Unicode File Name.\r
	146	\r
	147	**/\r
	148	VOID\r
	149	DpGetShortPdbFileName (\r
	150	IN CHAR8 *PdbFileName,\r
	151	OUT CHAR16 *UnicodeBuffer\r
	152	)\r
	153	{\r
	154	UINTN IndexA; // Current work location within an ASCII string.\r
	155	UINTN IndexU; // Current work location within a Unicode string.\r
	156	UINTN StartIndex;\r
	157	UINTN EndIndex;\r
	158	\r
	159	ZeroMem (UnicodeBuffer, (DP_GAUGE_STRING_LENGTH + 1) * sizeof (CHAR16));\r
	160	\r
	161	if (PdbFileName == NULL) {\r
	162	StrnCpyS (UnicodeBuffer, DP_GAUGE_STRING_LENGTH + 1, L" ", 1);\r
	163	} else {\r
	164	StartIndex = 0;\r
	165	for (EndIndex = 0; PdbFileName[EndIndex] != 0; EndIndex++)\r
	166	;\r
	167	for (IndexA = 0; PdbFileName[IndexA] != 0; IndexA++) {\r
	168	if ((PdbFileName[IndexA] == '\\') \|\| (PdbFileName[IndexA] == '/')) {\r
	169	StartIndex = IndexA + 1;\r
	170	}\r
	171	\r
	172	if (PdbFileName[IndexA] == '.') {\r
	173	EndIndex = IndexA;\r
	174	}\r
	175	}\r
	176	\r
	177	IndexU = 0;\r
	178	for (IndexA = StartIndex; IndexA < EndIndex; IndexA++) {\r
	179	UnicodeBuffer[IndexU] = (CHAR16) PdbFileName[IndexA];\r
	180	IndexU++;\r
	181	if (IndexU >= DP_GAUGE_STRING_LENGTH) {\r
	182	UnicodeBuffer[DP_GAUGE_STRING_LENGTH] = 0;\r
	183	break;\r
	184	}\r
	185	}\r
	186	}\r
	187	}\r
	188	\r
	189	/**\r
	190	Get a human readable name for an image handle.\r
	191	The following methods will be tried orderly:\r
	192	1. Image PDB\r
	193	2. ComponentName2 protocol\r
	194	3. FFS UI section\r
	195	4. Image GUID\r
	196	5. Image DevicePath\r
	197	6. Unknown Driver Name\r
	198	\r
	199	@param[in] Handle\r
	200	\r
	201	@post The resulting Unicode name string is stored in the\r
	202	mGaugeString global array.\r
	203	\r
	204	**/\r
	205	VOID\r
	206	DpGetNameFromHandle (\r
	207	IN EFI_HANDLE Handle\r
	208	)\r
	209	{\r
	210	EFI_STATUS Status;\r
	211	EFI_LOADED_IMAGE_PROTOCOL *Image;\r
	212	CHAR8 *PdbFileName;\r
	213	EFI_DRIVER_BINDING_PROTOCOL *DriverBinding;\r
	214	EFI_STRING StringPtr;\r
	215	EFI_DEVICE_PATH_PROTOCOL *LoadedImageDevicePath;\r
	216	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
	217	EFI_GUID *NameGuid;\r
	218	CHAR16 *NameString;\r
	219	UINTN StringSize;\r
	220	CHAR8 *PlatformLanguage;\r
	221	CHAR8 *BestLanguage;\r
	222	EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2;\r
	223	\r
	224	Image = NULL;\r
	225	LoadedImageDevicePath = NULL;\r
	226	DevicePath = NULL;\r
	227	\r
	228	//\r
	229	// Method 1: Get the name string from image PDB\r
	230	//\r
	231	Status = gBS->HandleProtocol (\r
	232	Handle,\r
	233	&gEfiLoadedImageProtocolGuid,\r
	234	(VOID **) &Image\r
	235	);\r
	236	\r
	237	if (EFI_ERROR (Status)) {\r
	238	Status = gBS->OpenProtocol (\r
	239	Handle,\r
	240	&gEfiDriverBindingProtocolGuid,\r
	241	(VOID **) &DriverBinding,\r
	242	NULL,\r
	243	NULL,\r
	244	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
	245	);\r
	246	if (!EFI_ERROR (Status)) {\r
	247	Status = gBS->HandleProtocol (\r
	248	DriverBinding->ImageHandle,\r
	249	&gEfiLoadedImageProtocolGuid,\r
	250	(VOID **) &Image\r
	251	);\r
	252	}\r
	253	}\r
	254	\r
	255	if (!EFI_ERROR (Status)) {\r
	256	PdbFileName = PeCoffLoaderGetPdbPointer (Image->ImageBase);\r
	257	\r
	258	if (PdbFileName != NULL) {\r
	259	DpGetShortPdbFileName (PdbFileName, mGaugeString);\r
	260	return;\r
	261	}\r
	262	}\r
	263	\r
	264	//\r
	265	// Method 2: Get the name string from ComponentName2 protocol\r
	266	//\r
	267	Status = gBS->HandleProtocol (\r
	268	Handle,\r
	269	&gEfiComponentName2ProtocolGuid,\r
	270	(VOID **) &ComponentName2\r
	271	);\r
	272	if (!EFI_ERROR (Status)) {\r
	273	//\r
	274	// Firstly use platform language setting, secondly use driver's first supported language.\r
	275	//\r
	276	GetVariable2 (L"PlatformLang", &gEfiGlobalVariableGuid, (VOID**)&PlatformLanguage, NULL);\r
	277	BestLanguage = GetBestLanguage(\r
	278	ComponentName2->SupportedLanguages,\r
	279	FALSE,\r
	280	(PlatformLanguage != NULL) ? PlatformLanguage : "",\r
	281	ComponentName2->SupportedLanguages,\r
	282	NULL\r
	283	);\r
	284	SHELL_FREE_NON_NULL (PlatformLanguage);\r
	285	\r
	286	Status = ComponentName2->GetDriverName (\r
	287	ComponentName2,\r
	288	BestLanguage != NULL ? BestLanguage : "en-US",\r
	289	&StringPtr\r
	290	);\r
	291	if (!EFI_ERROR (Status)) {\r
	292	SHELL_FREE_NON_NULL (BestLanguage);\r
	293	StrnCpyS (mGaugeString, DP_GAUGE_STRING_LENGTH + 1, StringPtr, DP_GAUGE_STRING_LENGTH);\r
	294	mGaugeString[DP_GAUGE_STRING_LENGTH] = 0;\r
	295	return;\r
	296	}\r
	297	}\r
	298	\r
	299	Status = gBS->HandleProtocol (\r
	300	Handle,\r
	301	&gEfiLoadedImageDevicePathProtocolGuid,\r
	302	(VOID **) &LoadedImageDevicePath\r
	303	);\r
	304	if (!EFI_ERROR (Status) && (LoadedImageDevicePath != NULL)) {\r
	305	DevicePath = LoadedImageDevicePath;\r
	306	} else if (Image != NULL) {\r
	307	DevicePath = Image->FilePath;\r
	308	}\r
	309	\r
	310	if (DevicePath != NULL) {\r
	311	//\r
	312	// Try to get image GUID from image DevicePath\r
	313	//\r
	314	NameGuid = NULL;\r
	315	while (!IsDevicePathEndType (DevicePath)) {\r
	316	NameGuid = EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *) DevicePath);\r
	317	if (NameGuid != NULL) {\r
	318	break;\r
	319	}\r
	320	DevicePath = NextDevicePathNode (DevicePath);\r
	321	}\r
	322	\r
	323	if (NameGuid != NULL) {\r
	324	//\r
	325	// Try to get the image's FFS UI section by image GUID\r
	326	//\r
	327	NameString = NULL;\r
	328	StringSize = 0;\r
	329	Status = GetSectionFromAnyFv (\r
	330	NameGuid,\r
	331	EFI_SECTION_USER_INTERFACE,\r
	332	0,\r
	333	(VOID **) &NameString,\r
	334	&StringSize\r
	335	);\r
	336	\r
	337	if (!EFI_ERROR (Status)) {\r
	338	//\r
	339	// Method 3. Get the name string from FFS UI section\r
	340	//\r
	341	StrnCpyS (mGaugeString, DP_GAUGE_STRING_LENGTH + 1, NameString, DP_GAUGE_STRING_LENGTH);\r
	342	mGaugeString[DP_GAUGE_STRING_LENGTH] = 0;\r
	343	FreePool (NameString);\r
	344	} else {\r
	345	//\r
	346	// Method 4: Get the name string from image GUID\r
	347	//\r
	348	UnicodeSPrint (mGaugeString, sizeof (mGaugeString), L"%g", NameGuid);\r
	349	}\r
	350	return;\r
	351	} else {\r
	352	//\r
	353	// Method 5: Get the name string from image DevicePath\r
	354	//\r
	355	NameString = ConvertDevicePathToText (DevicePath, TRUE, FALSE);\r
	356	if (NameString != NULL) {\r
	357	StrnCpyS (mGaugeString, DP_GAUGE_STRING_LENGTH + 1, NameString, DP_GAUGE_STRING_LENGTH);\r
	358	mGaugeString[DP_GAUGE_STRING_LENGTH] = 0;\r
	359	FreePool (NameString);\r
	360	return;\r
	361	}\r
	362	}\r
	363	}\r
	364	\r
	365	//\r
	366	// Method 6: Unknown Driver Name\r
	367	//\r
	368	StringPtr = HiiGetString (mDpHiiHandle, STRING_TOKEN (STR_DP_ERROR_NAME), NULL);\r
	369	ASSERT (StringPtr != NULL);\r
	370	StrnCpyS (mGaugeString, DP_GAUGE_STRING_LENGTH + 1, StringPtr, DP_GAUGE_STRING_LENGTH);\r
	371	FreePool (StringPtr);\r
	372	}\r
	373	\r
	374	/**\r
	375	Calculate the Duration in microseconds.\r
	376	\r
	377	Duration is multiplied by 1000, instead of Frequency being divided by 1000 or\r
	378	multiplying the result by 1000, in order to maintain precision. Since Duration is\r
	379	a 64-bit value, multiplying it by 1000 is unlikely to produce an overflow.\r
	380	\r
	381	The time is calculated as (Duration * 1000) / Timer_Frequency.\r
	382	\r
	383	@param[in] Duration The event duration in timer ticks.\r
	384	\r
	385	@return A 64-bit value which is the Elapsed time in microseconds.\r
	386	**/\r
	387	UINT64\r
	388	DurationInMicroSeconds (\r
	389	IN UINT64 Duration\r
	390	)\r
	391	{\r
	392	return DivU64x32 (Duration, 1000);\r
	393	}\r
	394	\r
	395	/**\r
	396	Get index of Measurement Record's match in the CumData array.\r
	397	\r
	398	If the Measurement's Token value matches a Token in one of the CumData\r
	399	records, the index of the matching record is returned. The returned\r
	400	index is a signed value so that negative values can indicate that\r
	401	the Measurement didn't match any entry in the CumData array.\r
	402	\r
	403	@param[in] Measurement A pointer to a Measurement Record to match against the CumData array.\r
	404	\r
	405	@retval <0 Token is not in the CumData array.\r
	406	@retval >=0 Return value is the index into CumData where Token is found.\r
	407	**/\r
	408	INTN\r
	409	GetCumulativeItem(\r
	410	IN MEASUREMENT_RECORD *Measurement\r
	411	)\r
	412	{\r
	413	INTN Index;\r
	414	\r
	415	for( Index = 0; Index < (INTN)NumCum; ++Index) {\r
	416	if (AsciiStrCmp (Measurement->Token, CumData[Index].Name) == 0) {\r
	417	return Index; // Exit, we found a match\r
	418	}\r
	419	}\r
	420	// If the for loop exits, Token was not found.\r
	421	return -1; // Indicate failure\r
	422	}\r