[mirror_edk2.git] / ShellPkg / Library / UefiDpLib / DpUtilities.c

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