PerformancePkg/Dp_App/DpUtilities.c

   1 /** @file
   2   Utility functions used by the Dp application.
   3
   4   Copyright (c) 2009 - 2013, 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
   9
  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.
  12 **/
  13
  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>
  26
  27 #include <Pi/PiFirmwareFile.h>
  28 #include <Library/DxeServicesLib.h>
  29
  30 #include <Protocol/LoadedImage.h>
  31 #include <Protocol/DriverBinding.h>
  32 #include <Protocol/ComponentName2.h>
  33 #include <Protocol/DevicePath.h>
  34
  35 #include <Guid/Performance.h>
  36
  37 #include "Dp.h"
  38 #include "Literals.h"
  39 #include "DpInternal.h"
  40
  41 /**
  42   Wrap original FreePool to check NULL pointer first.
  43
  44   @param[in]    Buffer      The pointer to the buffer to free.
  45
  46 **/
  47 VOID
  48 SafeFreePool (
  49   IN VOID   *Buffer
  50   )
  51 {
  52   if (Buffer != NULL) {
  53     FreePool (Buffer);
  54   }
  55 }
  56
  57 /**
  58   Calculate an event's duration in timer ticks.
  59
  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.
  63
  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.
  68
  69   The calculated duration, in ticks, is the absolute difference between
  70   the measurement's ending and starting counts.
  71
  72   @param Measurement   Pointer to a MEASUREMENT_RECORD structure containing
  73                        data for the current measurement.
  74
  75   @return              The 64-bit duration of the event.
  76 **/
  77 UINT64
  78 GetDuration (
  79   IN OUT MEASUREMENT_RECORD   *Measurement
  80   )
  81 {
  82   UINT64    Duration;
  83   BOOLEAN   Error;
  84
  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;
  92   }
  93   if (TimerInfo.CountUp) {
  94     Duration = Measurement->EndTimeStamp - Measurement->StartTimeStamp;
  95     Error = (BOOLEAN)(Duration > Measurement->EndTimeStamp);
  96   }
  97   else {
  98     Duration = Measurement->StartTimeStamp - Measurement->EndTimeStamp;
  99     Error = (BOOLEAN)(Duration > Measurement->StartTimeStamp);
 100   }
 101
 102   if (Error) {
 103     DEBUG ((EFI_D_ERROR, ALit_TimerLibError));
 104     Duration = 0;
 105   }
 106   return Duration;
 107 }
 108
 109 /**
 110   Determine whether the Measurement record is for an EFI Phase.
 111
 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.
 114
 115   @param[in]  Measurement A pointer to the Measurement record to test.
 116
 117   @retval     TRUE        The measurement record is for an EFI Phase.
 118   @retval     FALSE       The measurement record is NOT for an EFI Phase.
 119 **/
 120 BOOLEAN
 121 IsPhase(
 122   IN MEASUREMENT_RECORD        *Measurement
 123   )
 124 {
 125   BOOLEAN   RetVal;
 126
 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))
 132             );
 133   return RetVal;
 134 }
 135
 136 /**
 137   Get the file name portion of the Pdb File Name.
 138
 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.
 143
 144   @param[in]  PdbFileName     Pdb file name.
 145   @param[out] UnicodeBuffer   The resultant Unicode File Name.
 146
 147 **/
 148 VOID
 149 GetShortPdbFileName (
 150   IN  CHAR8     *PdbFileName,
 151   OUT CHAR16    *UnicodeBuffer
 152   )
 153 {
 154   UINTN IndexA;     // Current work location within an ASCII string.
 155   UINTN IndexU;     // Current work location within a Unicode string.
 156   UINTN StartIndex;
 157   UINTN EndIndex;
 158
 159   ZeroMem (UnicodeBuffer, DXE_PERFORMANCE_STRING_LENGTH * sizeof (CHAR16));
 160
 161   if (PdbFileName == NULL) {
 162     StrCpy (UnicodeBuffer, L" ");
 163   } else {
 164     StartIndex = 0;
 165     for (EndIndex = 0; PdbFileName[EndIndex] != 0; EndIndex++)
 166       ;
 167     for (IndexA = 0; PdbFileName[IndexA] != 0; IndexA++) {
 168       if (PdbFileName[IndexA] == '\\') {
 169         StartIndex = IndexA + 1;
 170       }
 171
 172       if (PdbFileName[IndexA] == '.') {
 173         EndIndex = IndexA;
 174       }
 175     }
 176
 177     IndexU = 0;
 178     for (IndexA = StartIndex; IndexA < EndIndex; IndexA++) {
 179       UnicodeBuffer[IndexU] = (CHAR16) PdbFileName[IndexA];
 180       IndexU++;
 181       if (IndexU >= DXE_PERFORMANCE_STRING_LENGTH) {
 182         UnicodeBuffer[DXE_PERFORMANCE_STRING_LENGTH] = 0;
 183         break;
 184       }
 185     }
 186   }
 187 }
 188
 189 /**
 190   Get a human readable name for an image handle.
 191   The following methods will be tried orderly:
 192     1. Image PDB
 193     2. ComponentName2 protocol
 194     3. FFS UI section
 195     4. Image GUID
 196     5. Image DevicePath
 197     6. Unknown Driver Name
 198
 199   @param[in]    Handle
 200
 201   @post   The resulting Unicode name string is stored in the
 202           mGaugeString global array.
 203
 204 **/
 205 VOID
 206 GetNameFromHandle (
 207   IN EFI_HANDLE   Handle
 208   )
 209 {
 210   EFI_STATUS                  Status;
 211   EFI_LOADED_IMAGE_PROTOCOL   *Image;
 212   CHAR8                       *PdbFileName;
 213   EFI_DRIVER_BINDING_PROTOCOL *DriverBinding;
 214   EFI_STRING                  StringPtr;
 215   EFI_DEVICE_PATH_PROTOCOL    *LoadedImageDevicePath;
 216   EFI_DEVICE_PATH_PROTOCOL    *DevicePath;
 217   EFI_GUID                    *NameGuid;
 218   CHAR16                      *NameString;
 219   UINTN                       StringSize;
 220   CHAR8                       *PlatformLanguage;
 221   EFI_COMPONENT_NAME2_PROTOCOL      *ComponentName2;
 222
 223   //
 224   // Method 1: Get the name string from image PDB
 225   //
 226   Status = gBS->HandleProtocol (
 227                   Handle,
 228                   &gEfiLoadedImageProtocolGuid,
 229                   (VOID **) &Image
 230                   );
 231
 232   if (EFI_ERROR (Status)) {
 233     Status = gBS->OpenProtocol (
 234                     Handle,
 235                     &gEfiDriverBindingProtocolGuid,
 236                     (VOID **) &DriverBinding,
 237                     NULL,
 238                     NULL,
 239                     EFI_OPEN_PROTOCOL_GET_PROTOCOL
 240                     );
 241     if (!EFI_ERROR (Status)) {
 242       Status = gBS->HandleProtocol (
 243                       DriverBinding->ImageHandle,
 244                       &gEfiLoadedImageProtocolGuid,
 245                       (VOID **) &Image
 246                       );
 247     }
 248   }
 249
 250   if (!EFI_ERROR (Status)) {
 251     PdbFileName = PeCoffLoaderGetPdbPointer (Image->ImageBase);
 252
 253     if (PdbFileName != NULL) {
 254       GetShortPdbFileName (PdbFileName, mGaugeString);
 255       return;
 256     }
 257   }
 258
 259   //
 260   // Method 2: Get the name string from ComponentName2 protocol
 261   //
 262   Status = gBS->HandleProtocol (
 263                   Handle,
 264                   &gEfiComponentName2ProtocolGuid,
 265                   (VOID **) &ComponentName2
 266                   );
 267   if (!EFI_ERROR (Status)) {
 268     //
 269     // Get the current platform language setting
 270     //
 271     GetEfiGlobalVariable2 (L"PlatformLang", (VOID**)&PlatformLanguage, NULL);
 272     Status = ComponentName2->GetDriverName (
 273                                ComponentName2,
 274                                PlatformLanguage != NULL ? PlatformLanguage : "en-US",
 275                                &StringPtr
 276                                );
 277     if (!EFI_ERROR (Status)) {
 278       SafeFreePool (PlatformLanguage);
 279       StrnCpy (mGaugeString, StringPtr, DP_GAUGE_STRING_LENGTH);
 280       mGaugeString[DP_GAUGE_STRING_LENGTH] = 0;
 281       return;
 282     }
 283   }
 284
 285   Status = gBS->HandleProtocol (
 286                   Handle,
 287                   &gEfiLoadedImageDevicePathProtocolGuid,
 288                   (VOID **) &LoadedImageDevicePath
 289                   );
 290   if (!EFI_ERROR (Status) && (LoadedImageDevicePath != NULL)) {
 291     DevicePath = LoadedImageDevicePath;
 292
 293     //
 294     // Try to get image GUID from LoadedImageDevicePath protocol
 295     //
 296     NameGuid = NULL;
 297     while (!IsDevicePathEndType (DevicePath)) {
 298       NameGuid = EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *) DevicePath);
 299       if (NameGuid != NULL) {
 300         break;
 301       }
 302       DevicePath = NextDevicePathNode (DevicePath);
 303     }
 304
 305     if (NameGuid != NULL) {
 306       //
 307       // Try to get the image's FFS UI section by image GUID
 308       //
 309       NameString = NULL;
 310       StringSize = 0;
 311       Status = GetSectionFromAnyFv (
 312                 NameGuid,
 313                 EFI_SECTION_USER_INTERFACE,
 314                 0,
 315                 (VOID **) &NameString,
 316                 &StringSize
 317                 );
 318
 319       if (!EFI_ERROR (Status)) {
 320         //
 321         // Method 3. Get the name string from FFS UI section
 322         //
 323         StrnCpy (mGaugeString, NameString, DP_GAUGE_STRING_LENGTH);
 324         mGaugeString[DP_GAUGE_STRING_LENGTH] = 0;
 325         FreePool (NameString);
 326       } else {
 327         //
 328         // Method 4: Get the name string from image GUID
 329         //
 330         UnicodeSPrint (mGaugeString, sizeof (mGaugeString), L"%g", NameGuid);
 331       }
 332       return;
 333     } else {
 334       //
 335       // Method 5: Get the name string from image DevicePath
 336       //
 337       NameString = ConvertDevicePathToText (LoadedImageDevicePath, TRUE, FALSE);
 338       if (NameString != NULL) {
 339         StrnCpy (mGaugeString, NameString, DP_GAUGE_STRING_LENGTH);
 340         mGaugeString[DP_GAUGE_STRING_LENGTH] = 0;
 341         FreePool (NameString);
 342         return;
 343       }
 344     }
 345   }
 346
 347   //
 348   // Method 6: Unknown Driver Name
 349   //
 350   StringPtr = HiiGetString (gHiiHandle, STRING_TOKEN (STR_DP_ERROR_NAME), NULL);
 351   ASSERT (StringPtr != NULL);
 352   StrCpy (mGaugeString, StringPtr);
 353   FreePool (StringPtr);
 354   return;
 355 }
 356
 357 /**
 358   Calculate the Duration in microseconds.
 359
 360   Duration is multiplied by 1000, instead of Frequency being divided by 1000 or
 361   multiplying the result by 1000, in order to maintain precision.  Since Duration is
 362   a 64-bit value, multiplying it by 1000 is unlikely to produce an overflow.
 363
 364   The time is calculated as (Duration * 1000) / Timer_Frequency.
 365
 366   @param[in]  Duration   The event duration in timer ticks.
 367
 368   @return     A 64-bit value which is the Elapsed time in microseconds.
 369 **/
 370 UINT64
 371 DurationInMicroSeconds (
 372   IN UINT64 Duration
 373   )
 374 {
 375   UINT64 Temp;
 376
 377   Temp = MultU64x32 (Duration, 1000);
 378   return DivU64x32 (Temp, TimerInfo.Frequency);
 379 }
 380
 381 /**
 382   Formatted Print using a Hii Token to reference the localized format string.
 383
 384   @param[in]  Token   A HII token associated with a localized Unicode string.
 385   @param[in]  ...     The variable argument list.
 386
 387   @return             The number of characters converted by UnicodeVSPrint().
 388
 389 **/
 390 UINTN
 391 PrintToken (
 392   IN UINT16           Token,
 393   ...
 394   )
 395 {
 396   VA_LIST           Marker;
 397   EFI_STRING        StringPtr;
 398   UINTN             Return;
 399   UINTN             BufferSize;
 400
 401   StringPtr = HiiGetString (gHiiHandle, Token, NULL);
 402   ASSERT (StringPtr != NULL);
 403
 404   VA_START (Marker, Token);
 405
 406   BufferSize = (PcdGet32 (PcdUefiLibMaxPrintBufferSize) + 1) * sizeof (CHAR16);
 407
 408   if (mPrintTokenBuffer == NULL) {
 409     mPrintTokenBuffer = AllocatePool (BufferSize);
 410     ASSERT (mPrintTokenBuffer != NULL);
 411   }
 412   SetMem( mPrintTokenBuffer, BufferSize, 0);
 413
 414   Return = UnicodeVSPrint (mPrintTokenBuffer, BufferSize, StringPtr, Marker);
 415   VA_END (Marker);
 416
 417   if (Return > 0 && gST->ConOut != NULL) {
 418     gST->ConOut->OutputString (gST->ConOut, mPrintTokenBuffer);
 419   }
 420   FreePool (StringPtr);
 421   return Return;
 422 }
 423
 424 /**
 425   Get index of Measurement Record's match in the CumData array.
 426
 427   If the Measurement's Token value matches a Token in one of the CumData
 428   records, the index of the matching record is returned.  The returned
 429   index is a signed value so that negative values can indicate that
 430   the Measurement didn't match any entry in the CumData array.
 431
 432   @param[in]  Measurement A pointer to a Measurement Record to match against the CumData array.
 433
 434   @retval     <0    Token is not in the CumData array.
 435   @retval     >=0   Return value is the index into CumData where Token is found.
 436 **/
 437 INTN
 438 GetCumulativeItem(
 439   IN MEASUREMENT_RECORD   *Measurement
 440   )
 441 {
 442   INTN    Index;
 443
 444   for( Index = 0; Index < (INTN)NumCum; ++Index) {
 445     if (AsciiStrnCmp (Measurement->Token, CumData[Index].Name, PERF_TOKEN_LENGTH) == 0) {
 446       return Index;  // Exit, we found a match
 447     }
 448   }
 449   // If the for loop exits, Token was not found.
 450   return -1;   // Indicate failure
 451 }