[mirror_edk2.git] / MdeModulePkg / Universal / EbcDxe / EbcDebugger / EdbSymbol.c

/** @file\r
\r
Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
\r
**/\r
\r
#include "Edb.h"\r
\r
/**\r
\r
  Load single symbol entry.\r
\r
  @param  Object          - Symbol file object\r
  @param  Name            - Symbol name\r
  @param  ObjName         - Object name\r
  @param  Address         - Symbol address\r
  @param  Type            - Symbol type\r
\r
  @retval EFI_SUCCESS - add single symbol entry successfully\r
\r
**/\r
EFI_STATUS\r
EdbLoadSymbolSingleEntry (\r
  IN EFI_DEBUGGER_SYMBOL_OBJECT  *Object,\r
  IN CHAR8                       *Name,\r
  IN CHAR8                       *ObjName,\r
  IN UINTN                       Address,\r
  IN EFI_DEBUGGER_SYMBOL_TYPE    Type\r
  )\r
{\r
  EFI_DEBUGGER_SYMBOL_ENTRY  *Entry;\r
\r
  //\r
  // Check Count VS MaxCount\r
  //\r
  if (Object->EntryCount >= Object->MaxEntryCount) {\r
    //\r
    // reallocate (for codebuffer too)\r
    // TBD\r
    //\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Entry = &Object->Entry[Object->EntryCount];\r
\r
  //\r
  // Print Debug info\r
  //\r
  if (sizeof (UINTN) == sizeof (UINT64)) {\r
    DEBUG ((DEBUG_ERROR, "  Symbol: %a, Address: 0x%016lx (%d)\n", Name, (UINT64)Address, (UINTN)Type));\r
  } else {\r
    DEBUG ((DEBUG_ERROR, "  Symbol: %a, Address: 0x%08x (%d)\n", Name, Address, (UINTN)Type));\r
  }\r
\r
  //\r
  // Fill the entry - name, RVA, type\r
  //\r
  AsciiStrnCpyS (Entry->Name, sizeof (Entry->Name), Name, sizeof (Entry->Name) - 1);\r
  if (ObjName != NULL) {\r
    AsciiStrnCpyS (Entry->ObjName, sizeof (Entry->ObjName), ObjName, sizeof (Entry->ObjName) - 1);\r
  }\r
\r
  Entry->Rva  = Address % EFI_DEBUGGER_DEFAULT_LINK_IMAGEBASE;\r
  Entry->Type = Type;\r
\r
  //\r
  // Increase Count\r
  //\r
  Object->EntryCount++;\r
\r
  //\r
  // Done\r
  //\r
  return EFI_SUCCESS;\r
}\r
\r
typedef enum {\r
  EdbEbcMapParseStateUninitialized,\r
  EdbEbcMapParseStateSymbolStart,\r
  EdbEbcMapParseStateSeHandlerSymbol,\r
  EdbEbcMapParseStateFunctionSymbol,\r
  EdbEbcMapParseStateVarbssInitSymbol,\r
  EdbEbcMapParseStateCrtSymbol,\r
  EdbEbcMapParseStateVariableSymbol,\r
  EdbEbcMapParseStateStaticFunctionSymbol,\r
  EdbEbcMapParseStateMax,\r
} EDB_EBC_MAP_PARSE_STATE;\r
\r
typedef enum {\r
  EdbEbcSymbolParseStateUninitialized,\r
  EdbEbcSymbolParseStateReadyForName,\r
  EdbEbcSymbolParseStateReadyForRVA,\r
  EdbEbcSymbolParseStateReadyForType,\r
  EdbEbcSymbolParseStateReadyForObject,\r
  EdbEbcSymbolParseStateMax,\r
} EDB_EBC_SYMBOL_PARSE_STATE;\r
\r
/**\r
\r
  The following code depends on the MAP file generated by IEC compiler (actually Microsoft linker).\r
\r
  Sample as follows: EbcTest.map\r
===============================================================================\r
  EbcTest\r
\r
 Timestamp is 45b02718 (Fri Jan 19 10:04:08 2007)\r
\r
 Preferred load address is 10000000\r
\r
 Start         Length     Name                   Class\r
 0001:00000000 00000370H .text                   CODE\r
 0002:00000000 00000030H _VARBSS_INIT            CODE\r
 0003:00000000 00000004H .CRT$TSA                DATA\r
 0003:00000004 00000004H .CRT$TSC                DATA\r
 0003:00000008 00000004H .CRT$X                  DATA\r
 0003:0000000c 00000008H .CRT$XCU                DATA\r
 0003:00000014 00000004H .CRT$Z                  DATA\r
 0003:00000020 0000001cH .rdata                  DATA\r
 0003:0000003c 00000000H .edata                  DATA\r
 0003:0000003c 00000056H .rdata$debug            DATA\r
 0004:00000000 00000070H .data                   DATA\r
 0004:00000070 00000020H .bss                    DATA\r
\r
  Address         Publics by Value              Rva+Base     Lib:Object\r
\r
 0000:00000000       ___safe_se_handler_table   00000000     <absolute>\r
 0000:00000000       ___safe_se_handler_count   00000000     <absolute>\r
 0001:00000042       TestSubRoutine             10000442 f   EbcTest.obj\r
 0001:0000011a       EfiMain                    1000051a f   EbcTest.obj\r
 0001:00000200       TestSubRoutineSub          10000600 f   EbcTestSub.obj\r
 0001:00000220       EfiStart                   10000620 f   EbcLib:EbcLib.obj\r
 0002:00000000       varbss_init_C:\efi_src\TIANO\Edk\Sample\Universal\Ebc\Dxe\EbcTest\EbcTest$c45b02717 10000800 f   EbcTest.obj\r
 0002:00000020       varbss_init_C:\efi_src\TIANO\Edk\Sample\Universal\Ebc\Dxe\EbcTest\EbcTestSub$c45af77f3 10000820 f   EbcTestSub.obj\r
 0003:00000000       CrtThunkBegin              10000a00     EbcLib:EbcLib.obj\r
 0003:00000004       CrtThunkEnd                10000a04     EbcLib:EbcLib.obj\r
 0003:00000008       CrtBegin                   10000a08     EbcLib:EbcLib.obj\r
 0003:00000014       CrtEnd                     10000a14     EbcLib:EbcLib.obj\r
 0004:00000070       TestStr                    10000c70     EbcTest.obj\r
 0004:00000078       TestVariable1              10000c78     EbcTest.obj\r
 0004:00000080       TestSubVariableSub         10000c80     EbcTestSub.obj\r
\r
 entry point at        0001:00000220\r
\r
 Static symbols\r
\r
 0001:00000000       TestSubRoutine2            10000400 f   EbcTest.obj\r
===============================================================================\r
\r
**/\r
\r
/**\r
\r
  Load symbol entry by Iec.\r
\r
  @param  Object          - Symbol file object\r
  @param  BufferSize      - Symbol file buffer size\r
  @param  Buffer          - Symbol file buffer\r
\r
  @retval EFI_SUCCESS - add symbol entry successfully\r
\r
**/\r
EFI_STATUS\r
EdbLoadSymbolEntryByIec (\r
  IN EFI_DEBUGGER_SYMBOL_OBJECT  *Object,\r
  IN UINTN                       BufferSize,\r
  IN VOID                        *Buffer\r
  )\r
{\r
  CHAR8                       *LineBuffer;\r
  CHAR8                       *FieldBuffer;\r
  EDB_EBC_MAP_PARSE_STATE     MapParseState;\r
  EDB_EBC_SYMBOL_PARSE_STATE  SymbolParseState;\r
  CHAR8                       *Name;\r
  CHAR8                       *ObjName;\r
  UINTN                       Address;\r
  EFI_DEBUGGER_SYMBOL_TYPE    Type;\r
\r
  //\r
  // Begin to parse the Buffer\r
  //\r
  LineBuffer    = AsciiStrGetNewTokenLine (Buffer, "\n\r");\r
  MapParseState = EdbEbcMapParseStateUninitialized;\r
  //\r
  // Check each line\r
  //\r
  while (LineBuffer != NULL) {\r
    FieldBuffer      = AsciiStrGetNewTokenField (LineBuffer, " ");\r
    SymbolParseState = EdbEbcSymbolParseStateUninitialized;\r
    //\r
    // Init entry value\r
    //\r
    Name    = NULL;\r
    ObjName = NULL;\r
    Address = 0;\r
    Type    = EfiDebuggerSymbolTypeMax;\r
    //\r
    // Check each field\r
    //\r
    while (FieldBuffer != NULL) {\r
      if (AsciiStrCmp (FieldBuffer, "") == 0) {\r
        FieldBuffer = AsciiStrGetNextTokenField (" ");\r
        continue;\r
      }\r
\r
      //\r
      // check "Address"\r
      //\r
      if (AsciiStrCmp (FieldBuffer, "Address") == 0) {\r
        MapParseState = EdbEbcMapParseStateSymbolStart;\r
        break;\r
      }\r
\r
      //\r
      // check "Static"\r
      //\r
      if (AsciiStrCmp (FieldBuffer, "Static") == 0) {\r
        MapParseState = EdbEbcMapParseStateStaticFunctionSymbol;\r
        break;\r
      }\r
\r
      if (MapParseState == EdbEbcMapParseStateUninitialized) {\r
        //\r
        // Do not parse anything until get "Address" or "Static"\r
        //\r
        break;\r
      }\r
\r
      if (AsciiStrCmp (FieldBuffer, "entry") == 0) {\r
        //\r
        // Skip entry point\r
        //\r
        break;\r
      }\r
\r
      //\r
      // Now we start to parse this line for Name, Address, and Object\r
      //\r
      switch (SymbolParseState) {\r
        case EdbEbcSymbolParseStateUninitialized:\r
          //\r
          // Get the Address\r
          //\r
          SymbolParseState = EdbEbcSymbolParseStateReadyForName;\r
          break;\r
        case EdbEbcSymbolParseStateReadyForName:\r
          //\r
          // Get the Name\r
          //\r
          if (AsciiStrnCmp (FieldBuffer, "___safe_se_handler", AsciiStrLen ("___safe_se_handler")) == 0) {\r
            //\r
            // skip SeHandler\r
            //\r
            MapParseState = EdbEbcMapParseStateSeHandlerSymbol;\r
            goto ExitFieldParse;\r
          } else if (AsciiStrnCmp (FieldBuffer, "varbss_init", AsciiStrLen ("varbss_init")) == 0) {\r
            //\r
            // check VarbssInit\r
            //\r
            MapParseState = EdbEbcMapParseStateVarbssInitSymbol;\r
            //          goto ExitFieldParse;\r
            Name             = FieldBuffer;\r
            SymbolParseState = EdbEbcSymbolParseStateReadyForRVA;\r
          } else if (AsciiStrnCmp (FieldBuffer, "Crt", AsciiStrLen ("Crt")) == 0) {\r
            //\r
            // check Crt\r
            //\r
            MapParseState = EdbEbcMapParseStateCrtSymbol;\r
            //          goto ExitFieldParse;\r
            Name             = FieldBuffer;\r
            SymbolParseState = EdbEbcSymbolParseStateReadyForRVA;\r
          } else {\r
            //\r
            // Now, it is normal function\r
            //\r
            switch (MapParseState) {\r
              case EdbEbcMapParseStateSeHandlerSymbol:\r
                MapParseState = EdbEbcMapParseStateFunctionSymbol;\r
                break;\r
              case EdbEbcMapParseStateCrtSymbol:\r
                MapParseState = EdbEbcMapParseStateVariableSymbol;\r
                break;\r
              case EdbEbcMapParseStateFunctionSymbol:\r
              case EdbEbcMapParseStateVariableSymbol:\r
              case EdbEbcMapParseStateStaticFunctionSymbol:\r
                break;\r
              default:\r
                ASSERT (FALSE);\r
                break;\r
            }\r
\r
            Name             = FieldBuffer;\r
            SymbolParseState = EdbEbcSymbolParseStateReadyForRVA;\r
          }\r
\r
          break;\r
        case EdbEbcSymbolParseStateReadyForRVA:\r
          //\r
          // Get the RVA\r
          //\r
          Address          = AsciiXtoi (FieldBuffer);\r
          SymbolParseState = EdbEbcSymbolParseStateReadyForType;\r
          break;\r
        case EdbEbcSymbolParseStateReadyForType:\r
          //\r
          // Get the Type. This is optional, only for "f".\r
          //\r
          if (AsciiStrCmp (FieldBuffer, "f") == 0) {\r
            SymbolParseState = EdbEbcSymbolParseStateReadyForObject;\r
            switch (MapParseState) {\r
              case EdbEbcMapParseStateFunctionSymbol:\r
              case EdbEbcMapParseStateVarbssInitSymbol:\r
                Type = EfiDebuggerSymbolFunction;\r
                break;\r
              case EdbEbcMapParseStateStaticFunctionSymbol:\r
                Type = EfiDebuggerSymbolStaticFunction;\r
                break;\r
              default:\r
                ASSERT (FALSE);\r
                break;\r
            }\r
\r
            break;\r
          }\r
\r
        //\r
        // Else it should be Object.\r
        // let it bypass here\r
        //\r
        case EdbEbcSymbolParseStateReadyForObject:\r
          switch (Type) {\r
            case EfiDebuggerSymbolTypeMax:\r
              switch (MapParseState) {\r
                case EdbEbcMapParseStateVariableSymbol:\r
                case EdbEbcMapParseStateCrtSymbol:\r
                  Type = EfiDebuggerSymbolGlobalVariable;\r
                  break;\r
                case EdbEbcMapParseStateSeHandlerSymbol:\r
                  //\r
                  // do nothing here\r
                  //\r
                  break;\r
                default:\r
                  ASSERT (FALSE);\r
                  break;\r
              }\r
\r
              break;\r
            case EfiDebuggerSymbolFunction:\r
            case EfiDebuggerSymbolStaticFunction:\r
              break;\r
            default:\r
              ASSERT (FALSE);\r
              break;\r
          }\r
\r
          //\r
          // Get the Object\r
          //\r
          ObjName          = FieldBuffer;\r
          SymbolParseState = EdbEbcSymbolParseStateUninitialized;\r
          break;\r
        default:\r
          ASSERT (FALSE);\r
          break;\r
      }\r
\r
      //\r
      // Get the next field\r
      //\r
      FieldBuffer = AsciiStrGetNextTokenField (" ");\r
    }\r
\r
    //\r
    // Add the entry if we get everything.\r
    //\r
    if ((Name != NULL) && (Type != EfiDebuggerSymbolTypeMax)) {\r
      EdbLoadSymbolSingleEntry (Object, Name, ObjName, Address, Type);\r
    }\r
\r
ExitFieldParse:\r
    //\r
    // Get the next line\r
    //\r
    LineBuffer = AsciiStrGetNextTokenLine ("\n\r");\r
  }\r
\r
  //\r
  // Done\r
  //\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
\r
  Load symbol entry.\r
\r
  @param  Object          - Symbol file object\r
  @param  BufferSize      - Symbol file buffer size\r
  @param  Buffer          - Symbol file buffer\r
\r
  @retval EFI_SUCCESS - add symbol entry successfully\r
\r
**/\r
EFI_STATUS\r
EdbLoadSymbolEntry (\r
  IN EFI_DEBUGGER_SYMBOL_OBJECT  *Object,\r
  IN UINTN                       BufferSize,\r
  IN VOID                        *Buffer\r
  )\r
{\r
  //\r
  // MAP file format depends on the compiler (actually linker).\r
  //\r
  // It is possible to check the different MAP file format in this routine.\r
  // Now only IEC is supported.\r
  //\r
  return EdbLoadSymbolEntryByIec (Object, BufferSize, Buffer);\r
}\r
\r
/**\r
\r
  Find symbol file by name.\r
\r
  @param  DebuggerPrivate - EBC Debugger private data structure\r
  @param  FileName        - Symbol file name\r
  @param  Index           - Symbol file index\r
\r
  @return Object\r
\r
**/\r
EFI_DEBUGGER_SYMBOL_OBJECT *\r
EdbFindSymbolFile (\r
  IN EFI_DEBUGGER_PRIVATE_DATA  *DebuggerPrivate,\r
  IN CHAR16                     *FileName,\r
  IN OUT UINTN                  *Index OPTIONAL\r
  )\r
{\r
  UINTN  ObjectIndex;\r
\r
  //\r
  // Check each Object\r
  //\r
  for (ObjectIndex = 0; ObjectIndex < DebuggerPrivate->DebuggerSymbolContext.ObjectCount; ObjectIndex++) {\r
    if (StrCmp (FileName, DebuggerPrivate->DebuggerSymbolContext.Object[ObjectIndex].Name) == 0) {\r
      //\r
      // Name match, found it\r
      //\r
      if (Index != NULL) {\r
        *Index = ObjectIndex;\r
      }\r
\r
      return &DebuggerPrivate->DebuggerSymbolContext.Object[ObjectIndex];\r
    }\r
  }\r
\r
  //\r
  // Not found\r
  //\r
  return NULL;\r
}\r
\r
/**\r
\r
  Find symbol by address.\r
\r
  @param  Address         - Symbol address\r
  @param  Type            - Search type\r
  @param  RetObject       - Symbol object\r
  @param  RetEntry        - Symbol entry\r
\r
  @return Nearest symbol address\r
\r
**/\r
UINTN\r
EbdFindSymbolAddress (\r
  IN UINTN                        Address,\r
  IN EDB_MATCH_SYMBOL_TYPE        Type,\r
  OUT EFI_DEBUGGER_SYMBOL_OBJECT  **RetObject,\r
  OUT EFI_DEBUGGER_SYMBOL_ENTRY   **RetEntry\r
  )\r
{\r
  UINTN                       Index;\r
  UINTN                       SubIndex;\r
  UINTN                       CandidateLowerAddress;\r
  UINTN                       CandidateUpperAddress;\r
  EFI_DEBUGGER_SYMBOL_OBJECT  *Object;\r
  EFI_DEBUGGER_SYMBOL_ENTRY   *Entry;\r
  EFI_DEBUGGER_SYMBOL_ENTRY   *LowEntry;\r
  EFI_DEBUGGER_SYMBOL_ENTRY   *UpperEntry;\r
  EFI_DEBUGGER_SYMBOL_OBJECT  *LowObject;\r
  EFI_DEBUGGER_SYMBOL_OBJECT  *UpperObject;\r
\r
  if ((Type < 0) || (Type >= EdbMatchSymbolTypeMax)) {\r
    return 0;\r
  }\r
\r
  //\r
  // Init\r
  //\r
  CandidateLowerAddress = 0;\r
  CandidateUpperAddress = (UINTN)-1;\r
  LowEntry              = NULL;\r
  UpperEntry            = NULL;\r
  LowObject             = NULL;\r
  UpperObject           = NULL;\r
\r
  //\r
  // Go through each object\r
  //\r
  Object = mDebuggerPrivate.DebuggerSymbolContext.Object;\r
  for (Index = 0; Index < mDebuggerPrivate.DebuggerSymbolContext.ObjectCount; Index++, Object++) {\r
    if (Object->EntryCount == 0) {\r
      continue;\r
    }\r
\r
    //\r
    // Go through each entry\r
    //\r
    Entry = Object->Entry;\r
    for (SubIndex = 0; SubIndex < Object->EntryCount; SubIndex++, Entry++) {\r
      if (Address != Entry->Rva + Object->BaseAddress) {\r
        //\r
        // Check for nearest address\r
        //\r
        if (Address > Entry->Rva + Object->BaseAddress) {\r
          //\r
          // Record it if Current RVA < Address\r
          //\r
          if (CandidateLowerAddress < Entry->Rva + Object->BaseAddress) {\r
            CandidateLowerAddress = Entry->Rva + Object->BaseAddress;\r
            LowEntry              = Entry;\r
            LowObject             = Object;\r
          }\r
        } else {\r
          //\r
          // Record it if Current RVA > Address\r
          //\r
          if (CandidateUpperAddress > Entry->Rva + Object->BaseAddress) {\r
            CandidateUpperAddress = Entry->Rva + Object->BaseAddress;\r
            UpperEntry            = Entry;\r
            UpperObject           = Object;\r
          }\r
        }\r
\r
        continue;\r
      }\r
\r
      //\r
      // address match, return directly\r
      //\r
      *RetEntry  = Entry;\r
      *RetObject = Object;\r
      return Address;\r
    }\r
  }\r
\r
  //\r
  // No Match, provide latest symbol\r
  //\r
\r
  if ((Address - CandidateLowerAddress) < EFI_DEBUGGER_MAX_SYMBOL_ADDRESS_DELTA_VALUE) {\r
    //\r
    // Check for lower address\r
    //\r
    if (((Type == EdbMatchSymbolTypeNearestAddress) &&\r
         ((CandidateUpperAddress - Address) > (Address - CandidateLowerAddress))) ||\r
        (Type == EdbMatchSymbolTypeLowerAddress))\r
    {\r
      //\r
      // return nearest lower address\r
      //\r
      *RetEntry  = LowEntry;\r
      *RetObject = LowObject;\r
      return CandidateLowerAddress;\r
    }\r
  }\r
\r
  if ((CandidateUpperAddress - Address) < EFI_DEBUGGER_MAX_SYMBOL_ADDRESS_DELTA_VALUE) {\r
    //\r
    // Check for upper address\r
    //\r
    if (((Type == EdbMatchSymbolTypeNearestAddress) &&\r
         ((CandidateUpperAddress - Address) < (Address - CandidateLowerAddress))) ||\r
        (Type == EdbMatchSymbolTypeUpperAddress))\r
    {\r
      //\r
      // return nearest upper address\r
      //\r
      *RetEntry  = UpperEntry;\r
      *RetObject = UpperObject;\r
      return CandidateUpperAddress;\r
    }\r
  }\r
\r
  //\r
  // No match and nearest one, return NULL\r
  //\r
  return 0;\r
}\r
\r
/**\r
\r
  Unload symbol file by name.\r
\r
  @param  DebuggerPrivate - EBC Debugger private data structure\r
  @param  FileName        - Symbol file name\r
\r
  @retval EFI_SUCCESS - unload symbol successfully\r
\r
**/\r
EFI_STATUS\r
EdbUnloadSymbol (\r
  IN EFI_DEBUGGER_PRIVATE_DATA  *DebuggerPrivate,\r
  IN CHAR16                     *FileName\r
  )\r
{\r
  EFI_DEBUGGER_SYMBOL_OBJECT  *Object;\r
  UINTN                       ObjectIndex;\r
  UINTN                       Index;\r
  EFI_DEBUGGER_SYMBOL_ENTRY   *OldEntry;\r
  UINTN                       OldEntryCount;\r
  UINTN                       MaxEntryCount;\r
  VOID                        **OldSourceBuffer;\r
\r
  //\r
  // Find Symbol\r
  //\r
  Object = EdbFindSymbolFile (DebuggerPrivate, FileName, &ObjectIndex);\r
  if (Object == NULL) {\r
    EDBPrint (L"SymbolFile is not loaded!\n");\r
    return EFI_DEBUG_CONTINUE;\r
  }\r
\r
  //\r
  // Record old data\r
  //\r
  Object          = DebuggerPrivate->DebuggerSymbolContext.Object;\r
  OldEntry        = Object->Entry;\r
  OldSourceBuffer = Object->SourceBuffer;\r
  MaxEntryCount   = Object->MaxEntryCount;\r
  OldEntryCount   = Object->EntryCount;\r
\r
  //\r
  // Remove the matched Object\r
  //\r
  for (Index = ObjectIndex; Index < DebuggerPrivate->DebuggerSymbolContext.ObjectCount - 1; Index++) {\r
    CopyMem (&Object[Index], &Object[Index + 1], sizeof (EFI_DEBUGGER_SYMBOL_OBJECT));\r
  }\r
\r
  ZeroMem (&Object[Index], sizeof (Object[Index]));\r
\r
  //\r
  // Move old data to new place\r
  //\r
  Object[Index].Entry         = OldEntry;\r
  Object[Index].SourceBuffer  = OldSourceBuffer;\r
  Object[Index].MaxEntryCount = MaxEntryCount;\r
  DebuggerPrivate->DebuggerSymbolContext.ObjectCount--;\r
\r
  //\r
  // Clean old entry data\r
  //\r
  for (Index = 0; Index < OldEntryCount; Index++) {\r
    ZeroMem (&OldEntry[Index], sizeof (OldEntry[Index]));\r
  }\r
\r
  //\r
  // Free OldSourceBuffer\r
  //\r
  for (Index = 0; OldSourceBuffer[Index] != NULL; Index++) {\r
    gBS->FreePool (OldSourceBuffer[Index]);\r
    OldSourceBuffer[Index] = NULL;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
\r
  Load symbol file by name.\r
\r
  @param  DebuggerPrivate - EBC Debugger private data structure\r
  @param  FileName        - Symbol file name\r
  @param  BufferSize      - Symbol file buffer size\r
  @param  Buffer          - Symbol file buffer\r
\r
  @retval EFI_SUCCESS - load symbol successfully\r
\r
**/\r
EFI_STATUS\r
EdbLoadSymbol (\r
  IN EFI_DEBUGGER_PRIVATE_DATA  *DebuggerPrivate,\r
  IN CHAR16                     *FileName,\r
  IN UINTN                      BufferSize,\r
  IN VOID                       *Buffer\r
  )\r
{\r
  EFI_DEBUGGER_SYMBOL_OBJECT  *Object;\r
  EFI_STATUS                  Status;\r
\r
  //\r
  // Check duplicated File\r
  //\r
  Object = EdbFindSymbolFile (DebuggerPrivate, FileName, NULL);\r
  if (Object != NULL) {\r
    Status = EdbUnloadSymbol (DebuggerPrivate, FileName);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_ERROR, "Unload Duplicated Symbol File Error!\n"));\r
      return Status;\r
    }\r
  }\r
\r
  //\r
  // Check Count VS MaxCount\r
  //\r
  if (DebuggerPrivate->DebuggerSymbolContext.ObjectCount >= DebuggerPrivate->DebuggerSymbolContext.MaxObjectCount) {\r
    //\r
    // reallocate\r
    // TBD\r
    //\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Object = &DebuggerPrivate->DebuggerSymbolContext.Object[DebuggerPrivate->DebuggerSymbolContext.ObjectCount];\r
\r
  //\r
  // Init Object\r
  //\r
  Object->EntryCount    = 0;\r
  Object->MaxEntryCount = EFI_DEBUGGER_SYMBOL_ENTRY_MAX;\r
\r
  //\r
  // Load SymbolEntry\r
  //\r
  DEBUG ((DEBUG_ERROR, "Symbol File: %s\n", FileName));\r
  Status = EdbLoadSymbolEntry (Object, BufferSize, Buffer);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Fill Object value\r
  //\r
  StrnCpyS (\r
    Object->Name,\r
    sizeof (Object->Name) / sizeof (CHAR16),\r
    FileName,\r
    (sizeof (Object->Name) / sizeof (CHAR16)) - 1\r
    );\r
  Object->BaseAddress = 0;\r
\r
  //\r
  // Increase the object count\r
  //\r
  DebuggerPrivate->DebuggerSymbolContext.ObjectCount++;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
\r
  Located PDB path name in PE image.\r
\r
  @param  ImageBase - base of PE to search\r
\r
  @return Pointer into image at offset of PDB file name if PDB file name is found,\r
  Otherwise a pointer to an empty string.\r
\r
**/\r
CHAR8 *\r
GetPdbPath (\r
  VOID  *ImageBase\r
  )\r
{\r
  CHAR8                            *PdbPath;\r
  UINT32                           DirCount;\r
  EFI_IMAGE_DOS_HEADER             *DosHdr;\r
  EFI_IMAGE_OPTIONAL_HEADER_UNION  *NtHdr;\r
  EFI_IMAGE_OPTIONAL_HEADER32      *OptionalHdr32;\r
  EFI_IMAGE_OPTIONAL_HEADER64      *OptionalHdr64;\r
  EFI_IMAGE_DATA_DIRECTORY         *DirectoryEntry;\r
  EFI_IMAGE_DEBUG_DIRECTORY_ENTRY  *DebugEntry;\r
  VOID                             *CodeViewEntryPointer;\r
\r
  //\r
  // Init value\r
  //\r
  CodeViewEntryPointer = NULL;\r
  PdbPath              = NULL;\r
  DosHdr               = ImageBase;\r
\r
  //\r
  // Check magic\r
  //\r
  if (DosHdr->e_magic != EFI_IMAGE_DOS_SIGNATURE) {\r
    return NULL;\r
  }\r
\r
  NtHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION *)((UINT8 *)DosHdr + DosHdr->e_lfanew);\r
  //\r
  // Check Machine, filter for EBC\r
  //\r
  if (NtHdr->Pe32.FileHeader.Machine != EFI_IMAGE_MACHINE_EBC) {\r
    //\r
    // If not EBC, return NULL\r
    //\r
    return NULL;\r
  }\r
\r
  //\r
  // Get DirectoryEntry\r
  // EBC spec says PE32+, but implementation uses PE32. So check dynamically here.\r
  //\r
  if (NtHdr->Pe32.OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
    OptionalHdr32  = (VOID *)&NtHdr->Pe32.OptionalHeader;\r
    DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&(OptionalHdr32->DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG]);\r
  } else if (NtHdr->Pe32Plus.OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC) {\r
    OptionalHdr64  = (VOID *)&NtHdr->Pe32Plus.OptionalHeader;\r
    DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&(OptionalHdr64->DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG]);\r
  } else {\r
    return NULL;\r
  }\r
\r
  if (DirectoryEntry->VirtualAddress == 0) {\r
    return NULL;\r
  }\r
\r
  //\r
  // Go through DirectoryEntry\r
  //\r
  for (DirCount = 0;\r
       (DirCount < DirectoryEntry->Size / sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY)) && CodeViewEntryPointer == NULL;\r
       DirCount++\r
       )\r
  {\r
    DebugEntry = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *)(DirectoryEntry->VirtualAddress + (UINTN)ImageBase + DirCount * sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY));\r
    if (DebugEntry->Type == EFI_IMAGE_DEBUG_TYPE_CODEVIEW) {\r
      //\r
      // Match DebugEntry, only CODEVIEW_SIGNATURE_NB10 and CODEVIEW_SIGNATURE_RSDS are supported.\r
      //\r
      CodeViewEntryPointer = (VOID *)((UINTN)DebugEntry->RVA + (UINTN)ImageBase);\r
      switch (*(UINT32 *)CodeViewEntryPointer) {\r
        case CODEVIEW_SIGNATURE_NB10:\r
          PdbPath = (CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY);\r
          break;\r
        case CODEVIEW_SIGNATURE_RSDS:\r
          PdbPath = (CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY);\r
          break;\r
        default:\r
          break;\r
      }\r
    }\r
  }\r
\r
  //\r
  // Done successfully\r
  //\r
  return PdbPath;\r
}\r
\r
/**\r
\r
  Check whether PDB file and MAP file have same name.\r
\r
  @param  PdbFileName - PDB file name\r
  @param  MapFileName - MAP file name\r
\r
  @retval TRUE  - PDB and MAP file name match\r
  @retval FALSE - PDB and MAP file name not match\r
\r
**/\r
BOOLEAN\r
MatchPdbAndMap (\r
  IN CHAR8   *PdbFileName,\r
  IN CHAR16  *MapFileName\r
  )\r
{\r
  UINTN  PdbNameSize;\r
  UINTN  MapNameSize;\r
  CHAR8  *PurePdbFileName;\r
  UINTN  Index;\r
\r
  //\r
  // remove dir name\r
  //\r
  PurePdbFileName = PdbFileName;\r
  for (Index = 0; PdbFileName[Index] != 0; Index++) {\r
    if (PdbFileName[Index] == '\\') {\r
      PurePdbFileName = &PdbFileName[Index + 1];\r
    }\r
  }\r
\r
  PdbFileName = PurePdbFileName;\r
\r
  //\r
  // get size\r
  //\r
  PdbNameSize = AsciiStrLen (PdbFileName);\r
  MapNameSize = StrLen (MapFileName);\r
\r
  if (PdbNameSize != MapNameSize) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // check the name\r
  //\r
  for (Index = 0; Index < MapNameSize - 4; Index++) {\r
    if ((PdbFileName[Index] | 0x20) != (MapFileName[Index] | 0x20)) {\r
      return FALSE;\r
    }\r
  }\r
\r
  return TRUE;\r
}\r
\r
//\r
// BUGBUG: work-around start\r
//\r
typedef struct {\r
  EFI_DEBUG_IMAGE_INFO    *EfiDebugImageInfoTable;\r
  volatile UINT32         UpdateStatus;\r
  UINT32                  TableSize;\r
} EFI_DEBUG_IMAGE_INFO_TABLE_HEADER_OLD;\r
\r
EFI_DEBUG_IMAGE_INFO_TABLE_HEADER  mDebugImageInfoTableHeader;\r
\r
/**\r
For compatibility consideration, we handle 2 cases:\r
\r
1) IA32:\r
  Old:                          New:\r
  +------------------------+    +------------------------+\r
  | EfiDebugImageInfoTable |    | UpdateStatus           |\r
  +------------------------+    +------------------------+\r
  | UpdateStatus           |    | TableSize              |\r
  +------------------------+    +------------------------+\r
  | TableSize              |    | EfiDebugImageInfoTable |\r
  +------------------------+    +------------------------+\r
\r
2) X64 and IPF:\r
  Old:                          New:\r
  +------------------------+    +------------------------+\r
  | EfiDebugImageInfoTable |    | UpdateStatus           |\r
  |                        |    +------------------------+\r
  |                        |    | TableSize              |\r
  +------------------------+    +------------------------+\r
  | UpdateStatus           |    | EfiDebugImageInfoTable |\r
  +------------------------+    |                        |\r
  | TableSize              |    |                        |\r
  +------------------------+    +------------------------+\r
\r
  @param DebugImageInfoTableHeader  Point to the EFI_DEBUG_IMAGE_INFO_TABLE_HEADER structure.\r
\r
**/\r
VOID\r
EdbFixDebugImageInfoTable (\r
  IN OUT EFI_DEBUG_IMAGE_INFO_TABLE_HEADER  **DebugImageInfoTableHeader\r
  )\r
{\r
  mDebugImageInfoTableHeader.EfiDebugImageInfoTable = ((EFI_DEBUG_IMAGE_INFO_TABLE_HEADER_OLD *)(*DebugImageInfoTableHeader))->EfiDebugImageInfoTable;\r
  mDebugImageInfoTableHeader.UpdateStatus           = ((EFI_DEBUG_IMAGE_INFO_TABLE_HEADER_OLD *)(*DebugImageInfoTableHeader))->UpdateStatus;\r
  mDebugImageInfoTableHeader.TableSize              = ((EFI_DEBUG_IMAGE_INFO_TABLE_HEADER_OLD *)(*DebugImageInfoTableHeader))->TableSize;\r
\r
  if ((*DebugImageInfoTableHeader)->UpdateStatus > 3) {\r
    *DebugImageInfoTableHeader = &mDebugImageInfoTableHeader;\r
    return;\r
  }\r
\r
  if ((*DebugImageInfoTableHeader)->TableSize % (EFI_PAGE_SIZE / (sizeof (VOID *))) != 0) {\r
    *DebugImageInfoTableHeader = &mDebugImageInfoTableHeader;\r
    return;\r
  }\r
\r
  return;\r
}\r
\r
//\r
// BUGBUG: work-around end\r
//\r
\r
/**\r
\r
  Patch symbol RVA.\r
\r
  @param  DebuggerPrivate - EBC Debugger private data structure\r
  @param  FileName        - Symbol file name\r
  @param  SearchType      - Search type for Object\r
\r
  @retval EFI_SUCCESS   - Patch symbol RVA successfully\r
  @retval EFI_NOT_FOUND - Symbol RVA base not found\r
\r
**/\r
EFI_STATUS\r
EdbPatchSymbolRVA (\r
  IN EFI_DEBUGGER_PRIVATE_DATA      *DebuggerPrivate,\r
  IN CHAR16                         *FileName,\r
  IN EDB_EBC_IMAGE_RVA_SEARCH_TYPE  SearchType\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  UINTN                       ImageNumber;\r
  EFI_DEBUG_IMAGE_INFO        *ImageTable;\r
  CHAR8                       *PdbPath;\r
  VOID                        *ImageBase;\r
  VOID                        *CandidateImageBase;\r
  EFI_DEBUGGER_SYMBOL_OBJECT  *Object;\r
\r
  if ((SearchType < 0) || (SearchType >= EdbEbcImageRvaSearchTypeMax)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Get the related object\r
  //\r
  Object = EdbFindSymbolFile (DebuggerPrivate, FileName, NULL);\r
  if (Object == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Try again to get DebugImageInfoTable\r
  //\r
  if (mDebuggerPrivate.DebugImageInfoTableHeader == NULL) {\r
    Status = EfiGetSystemConfigurationTable (\r
               &gEfiDebugImageInfoTableGuid,\r
               (VOID **)&mDebuggerPrivate.DebugImageInfoTableHeader\r
               );\r
    if (EFI_ERROR (Status)) {\r
      EDBPrint (L"DebugImageInfoTable not found!\n");\r
      return Status;\r
    }\r
  }\r
\r
  DEBUG ((DEBUG_ERROR, "DebugImageInfoTableHeader: %x\n", mDebuggerPrivate.DebugImageInfoTableHeader));\r
\r
  //\r
  // BUGBUG: work-around start\r
  //\r
  EdbFixDebugImageInfoTable (&mDebuggerPrivate.DebugImageInfoTableHeader);\r
  //\r
  // BUGBUG: work-around end\r
  //\r
\r
  //\r
  // Go through DebugImageInfoTable for each Image\r
  //\r
  CandidateImageBase = NULL;\r
  ImageTable         = mDebuggerPrivate.DebugImageInfoTableHeader->EfiDebugImageInfoTable;\r
  for (ImageNumber = 0; ImageNumber < mDebuggerPrivate.DebugImageInfoTableHeader->TableSize; ImageNumber++) {\r
    if (ImageTable[ImageNumber].NormalImage == NULL) {\r
      continue;\r
    }\r
\r
    ImageBase = ImageTable[ImageNumber].NormalImage->LoadedImageProtocolInstance->ImageBase;\r
    //\r
    // Get PDB path\r
    //\r
    PdbPath = GetPdbPath (ImageBase);\r
    if (PdbPath == NULL) {\r
      continue;\r
    }\r
\r
    //\r
    // Check PDB name\r
    //\r
    if (!MatchPdbAndMap (PdbPath, FileName)) {\r
      continue;\r
    }\r
\r
    DEBUG ((DEBUG_ERROR, "ImageBase: %x\n", ImageBase));\r
\r
    //\r
    // Check SearchType\r
    //\r
    if ((SearchType == EdbEbcImageRvaSearchTypeAny) || (SearchType == EdbEbcImageRvaSearchTypeFirst)) {\r
      //\r
      // Assign base address and return\r
      //\r
      Object->BaseAddress = (UINTN)ImageBase;\r
      return EFI_SUCCESS;\r
    }\r
\r
    //\r
    // Get CandidateImageBase for EdbEbcImageRvaSearchTypeLast\r
    //\r
    CandidateImageBase = ImageBase;\r
  }\r
\r
  //\r
  // Check EdbEbcImageRvaSearchTypeLast\r
  //\r
  if (SearchType == EdbEbcImageRvaSearchTypeLast) {\r
    if (CandidateImageBase == NULL) {\r
      return EFI_NOT_FOUND;\r
    }\r
\r
    //\r
    // Assign base address and return\r
    //\r
    Object->BaseAddress = (UINTN)CandidateImageBase;\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // No match\r
  //\r
  return EFI_NOT_FOUND;\r
}\r
\r
/**\r
\r
  Check whether OBJ file and COD file have same name.\r
\r
  @param  ObjFileName - OBJ file name\r
  @param  CodFileName - COD file name\r
\r
  @retval TRUE  - OBJ and COD file name match\r
  @retval FALSE - OBJ and COD file name not match\r
\r
**/\r
BOOLEAN\r
MatchObjAndCod (\r
  IN CHAR8   *ObjFileName,\r
  IN CHAR16  *CodFileName\r
  )\r
{\r
  UINTN  ObjNameSize;\r
  UINTN  CodNameSize;\r
  CHAR8  *PureObjFileName;\r
  UINTN  Index;\r
\r
  //\r
  // remove library name\r
  //\r
  PureObjFileName = ObjFileName;\r
  for (Index = 0; ObjFileName[Index] != 0; Index++) {\r
    if (ObjFileName[Index] == ':') {\r
      PureObjFileName = &ObjFileName[Index + 1];\r
      break;\r
    }\r
  }\r
\r
  ObjFileName = PureObjFileName;\r
\r
  //\r
  // get size\r
  //\r
  ObjNameSize = AsciiStrLen (ObjFileName);\r
  CodNameSize = StrLen (CodFileName);\r
\r
  if (ObjNameSize != CodNameSize) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // check the name\r
  //\r
  for (Index = 0; Index < CodNameSize - 4; Index++) {\r
    if ((ObjFileName[Index] | 0x20) != (CodFileName[Index] | 0x20)) {\r
      return FALSE;\r
    }\r
  }\r
\r
  return TRUE;\r
}\r
\r
typedef enum {\r
  EdbEbcCodParseStateUninitialized,\r
  EdbEbcCodParseStateSymbolInitialized,\r
  EdbEbcCodParseStateSymbolStart,\r
  EdbEbcCodParseStateSymbolEnd,\r
  EdbEbcCodParseStateMax,\r
} EDB_EBC_COD_PARSE_STATE;\r
\r
/**\r
\r
  The following code depends on the COD file generated by IEC compiler.\r
\r
**/\r
\r
/**\r
\r
  Load code by symbol by Iec.\r
\r
  @param  Name            - Symbol file name\r
  @param  Buffer          - Symbol file buffer\r
  @param  BufferSize      - Symbol file buffer size\r
  @param  CodeBufferSize  - Code buffer size\r
  @param  FuncOffset      - Code funcion offset\r
\r
  @return CodeBuffer\r
\r
**/\r
CHAR8 *\r
EdbLoadCodBySymbolByIec (\r
  IN CHAR8   *Name,\r
  IN VOID    *Buffer,\r
  IN UINTN   BufferSize,\r
  OUT UINTN  *CodeBufferSize,\r
  OUT UINTN  *FuncOffset\r
  )\r
{\r
  CHAR8                    *LineBuffer;\r
  CHAR8                    *FieldBuffer;\r
  VOID                     *BufferStart;\r
  VOID                     *BufferEnd;\r
  UINTN                    Offset;\r
  EDB_EBC_COD_PARSE_STATE  CodParseState;\r
  CHAR8                    Char[2];\r
\r
  //\r
  // Init\r
  //\r
  Char[0]       = 9;\r
  Char[1]       = 0;\r
  LineBuffer    = AsciiStrGetNewTokenLine (Buffer, "\n\r");\r
  Offset        = (UINTN)-1;\r
  BufferStart   = NULL;\r
  BufferEnd     = NULL;\r
  CodParseState = EdbEbcCodParseStateUninitialized;\r
\r
  //\r
  // Check each line\r
  //\r
  while (LineBuffer != NULL) {\r
    switch (CodParseState) {\r
      case EdbEbcCodParseStateUninitialized:\r
        //\r
        // check mark_begin, begin to check line after this match\r
        //\r
        if (AsciiStrCmp (LineBuffer, "; mark_begin;") == 0) {\r
          CodParseState = EdbEbcCodParseStateSymbolInitialized;\r
        }\r
\r
        LineBuffer = AsciiStrGetNextTokenLine ("\n\r");\r
        PatchForAsciiStrTokenBefore (LineBuffer, '\n');\r
        break;\r
\r
      case EdbEbcCodParseStateSymbolInitialized:\r
        //\r
        // check mark_end, not check line after this match\r
        //\r
        if (AsciiStrCmp (LineBuffer, "; mark_end;") == 0) {\r
          CodParseState = EdbEbcCodParseStateUninitialized;\r
          LineBuffer    = AsciiStrGetNextTokenLine ("\n\r");\r
          PatchForAsciiStrTokenBefore (LineBuffer, '\n');\r
          break;\r
        }\r
\r
        //\r
        // not check this line if the first char is as follows\r
        //\r
        if ((*LineBuffer == 0)   ||\r
            (*LineBuffer == '$') ||\r
            (*LineBuffer == ';') ||\r
            (*LineBuffer == '_') ||\r
            (*LineBuffer == ' '))\r
        {\r
          LineBuffer = AsciiStrGetNextTokenLine ("\n\r");\r
          PatchForAsciiStrTokenBefore (LineBuffer, '\n');\r
          break;\r
        }\r
\r
        //\r
        // get function name, function name is followed by char 0x09.\r
        //\r
        FieldBuffer = AsciiStrGetNewTokenField (LineBuffer, Char);\r
        ASSERT (FieldBuffer != NULL);\r
        if (AsciiStriCmp (FieldBuffer, Name) == 0) {\r
          BufferStart   = FieldBuffer;\r
          CodParseState = EdbEbcCodParseStateSymbolStart;\r
        }\r
\r
        PatchForAsciiStrTokenAfter (FieldBuffer, 0x9);\r
\r
        //\r
        // Get next line\r
        //\r
        LineBuffer = AsciiStrGetNextTokenLine ("\n\r");\r
        PatchForAsciiStrTokenBefore (LineBuffer, '\n');\r
        break;\r
\r
      case EdbEbcCodParseStateSymbolStart:\r
        //\r
        // check mark_end, if this match, means the function is found successfully.\r
        //\r
        if (AsciiStrCmp (LineBuffer, "; mark_end;") == 0) {\r
          CodParseState = EdbEbcCodParseStateSymbolEnd;\r
          //\r
          // prepare CodeBufferSize, FuncOffset, and FuncStart to return\r
          //\r
          BufferEnd       = LineBuffer + sizeof ("; mark_end;") - 1;\r
          *CodeBufferSize = (UINTN)BufferEnd - (UINTN)BufferStart;\r
          *FuncOffset     = Offset;\r
          PatchForAsciiStrTokenAfter (LineBuffer, '\n');\r
          return BufferStart;\r
        }\r
\r
        //\r
        // Get function offset\r
        //\r
        if ((Offset == (UINTN)-1) &&\r
            (*LineBuffer == ' '))\r
        {\r
          FieldBuffer = AsciiStrGetNewTokenField (LineBuffer + 2, " ");\r
          Offset      = AsciiXtoi (FieldBuffer);\r
          PatchForAsciiStrTokenAfter (FieldBuffer, ' ');\r
        }\r
\r
        //\r
        // Get next line\r
        //\r
        LineBuffer = AsciiStrGetNextTokenLine ("\n\r");\r
        PatchForAsciiStrTokenBefore (LineBuffer, '\n');\r
        break;\r
\r
      case EdbEbcCodParseStateSymbolEnd:\r
        break;\r
\r
      default:\r
        break;\r
    }\r
  }\r
\r
  //\r
  // no function found\r
  //\r
  return NULL;\r
}\r
\r
/**\r
\r
  Load code by symbol.\r
\r
  @param  Name            - Symbol file name\r
  @param  Buffer          - Symbol file buffer\r
  @param  BufferSize      - Symbol file buffer size\r
  @param  CodeBufferSize  - Code buffer size\r
  @param  FuncOffset      - Code funcion offset\r
\r
  @return CodeBuffer\r
\r
**/\r
CHAR8 *\r
EdbLoadCodBySymbol (\r
  IN CHAR8   *Name,\r
  IN VOID    *Buffer,\r
  IN UINTN   BufferSize,\r
  OUT UINTN  *CodeBufferSize,\r
  OUT UINTN  *FuncOffset\r
  )\r
{\r
  //\r
  // COD file format depends on the compiler.\r
  //\r
  // It is possible to check the different COD file format in this routine.\r
  // Now only IEC is supported.\r
  //\r
  return EdbLoadCodBySymbolByIec (Name, Buffer, BufferSize, CodeBufferSize, FuncOffset);\r
}\r
\r
/**\r
\r
  Find code from object.\r
\r
  @param  DebuggerPrivate    EBC Debugger private data structure\r
  @param  Object          - Symbol object\r
  @param  FileName        - File name\r
\r
**/\r
VOID *\r
EdbFindCodeFromObject (\r
  IN EFI_DEBUGGER_PRIVATE_DATA   *DebuggerPrivate,\r
  IN EFI_DEBUGGER_SYMBOL_OBJECT  *Object,\r
  IN CHAR16                      *FileName\r
  )\r
{\r
  UINTN  EntryIndex;\r
\r
  //\r
  // Go througn each Entry in this Object\r
  //\r
  for (EntryIndex = 0; EntryIndex < Object->EntryCount; EntryIndex++) {\r
    //\r
    // This check is for Function only\r
    //\r
    if ((Object->Entry[EntryIndex].Type != EfiDebuggerSymbolFunction) &&\r
        (Object->Entry[EntryIndex].Type != EfiDebuggerSymbolStaticFunction))\r
    {\r
      continue;\r
    }\r
\r
    //\r
    // Skip match varbss_init function, because they has no source code\r
    //\r
    if (AsciiStrnCmp (Object->Entry[EntryIndex].Name, "varbss_init", sizeof ("varbss_init") - 1) == 0) {\r
      continue;\r
    }\r
\r
    //\r
    // check the name\r
    //\r
    if (!MatchObjAndCod (Object->Entry[EntryIndex].ObjName, FileName)) {\r
      continue;\r
    }\r
\r
    //\r
    // found it, return source buffer\r
    //\r
    if (Object->Entry[EntryIndex].CodBuffer != NULL) {\r
      return Object->Entry[EntryIndex].SourceBuffer;\r
    }\r
  }\r
\r
  //\r
  // not found\r
  //\r
  return NULL;\r
}\r
\r
/**\r
\r
  Load code.\r
\r
  @param  DebuggerPrivate - EBC Debugger private data structure\r
  @param  MapFileName     - Symbol file name\r
  @param  FileName        - Code file name\r
  @param  BufferSize      - Code file buffer size\r
  @param  Buffer          - Code file buffer\r
\r
  @retval EFI_SUCCESS - Code loaded successfully\r
\r
**/\r
EFI_STATUS\r
EdbLoadCode (\r
  IN EFI_DEBUGGER_PRIVATE_DATA  *DebuggerPrivate,\r
  IN CHAR16                     *MapFileName,\r
  IN CHAR16                     *FileName,\r
  IN UINTN                      BufferSize,\r
  IN VOID                       *Buffer\r
  )\r
{\r
  EFI_DEBUGGER_SYMBOL_OBJECT  *Object;\r
  UINTN                       ObjectIndex;\r
  UINTN                       EntryIndex;\r
  VOID                        *SourceBuffer;\r
  EFI_STATUS                  Status;\r
\r
  //\r
  // Find Symbol\r
  //\r
  Object = EdbFindSymbolFile (DebuggerPrivate, MapFileName, &ObjectIndex);\r
  if (Object == NULL) {\r
    EDBPrint (L"SymbolFile is not loaded!\n");\r
    return EFI_NOT_FOUND;\r
  } else {\r
    //\r
    // Check duplicated File\r
    //\r
    SourceBuffer = EdbFindCodeFromObject (DebuggerPrivate, Object, FileName);\r
    if (SourceBuffer != NULL) {\r
      //\r
      // unnload duplicated code\r
      //\r
      Status = EdbUnloadCode (DebuggerPrivate, MapFileName, FileName, &SourceBuffer);\r
      if (EFI_ERROR (Status)) {\r
        DEBUG ((DEBUG_ERROR, "Unload Duplicated Code File Error!\n"));\r
        return Status;\r
      }\r
\r
      Status = EdbDeleteCodeBuffer (DebuggerPrivate, MapFileName, FileName, SourceBuffer);\r
      if (EFI_ERROR (Status)) {\r
        DEBUG ((DEBUG_ERROR, "Delete Duplicated Code File Error!\n"));\r
        return Status;\r
      }\r
    }\r
  }\r
\r
  //\r
  // Go through each SymbolEntry\r
  //\r
  for (EntryIndex = 0; EntryIndex < Object->EntryCount; EntryIndex++) {\r
    //\r
    // load symbol for function only\r
    //\r
    if ((Object->Entry[EntryIndex].Type != EfiDebuggerSymbolFunction) &&\r
        (Object->Entry[EntryIndex].Type != EfiDebuggerSymbolStaticFunction))\r
    {\r
      continue;\r
    }\r
\r
    //\r
    // skip varbss_init\r
    //\r
    if (AsciiStrnCmp (Object->Entry[EntryIndex].Name, "varbss_init", sizeof ("varbss_init") - 1) == 0) {\r
      continue;\r
    }\r
\r
    //\r
    // Check the name\r
    //\r
    if (!MatchObjAndCod (Object->Entry[EntryIndex].ObjName, FileName)) {\r
      continue;\r
    }\r
\r
    //\r
    // load code for this symbol\r
    //\r
    Object->Entry[EntryIndex].CodBuffer = EdbLoadCodBySymbol (\r
                                            Object->Entry[EntryIndex].Name,\r
                                            Buffer,\r
                                            BufferSize,\r
                                            &Object->Entry[EntryIndex].CodBufferSize,\r
                                            &Object->Entry[EntryIndex].FuncOffsetBase\r
                                            );\r
    if (Object->Entry[EntryIndex].CodBuffer != NULL) {\r
      Object->Entry[EntryIndex].SourceBuffer = Buffer;\r
    }\r
  }\r
\r
  //\r
  // patch end '\0' for each code buffer\r
  //\r
  for (EntryIndex = 0; EntryIndex < Object->EntryCount; EntryIndex++) {\r
    if (Object->Entry[EntryIndex].CodBuffer != NULL) {\r
      *((UINT8 *)Object->Entry[EntryIndex].CodBuffer + Object->Entry[EntryIndex].CodBufferSize) = 0;\r
      DEBUG ((DEBUG_ERROR, "  CodeSymbol: %a, FuncOffset: 0x05%x\n", Object->Entry[EntryIndex].Name, Object->Entry[EntryIndex].FuncOffsetBase));\r
      //      DEBUG ((DEBUG_ERROR, "  [CODE]:\n%a\n", Object->Entry[EntryIndex].CodBuffer));\r
    }\r
  }\r
\r
  //\r
  // Done\r
  //\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
\r
  Unload code.\r
\r
  @param  DebuggerPrivate - EBC Debugger private data structure\r
  @param  MapFileName     - Symbol file name\r
  @param  FileName        - Code file name\r
  @param  Buffer          - Code file buffer\r
\r
  @retval EFI_SUCCESS - Code unloaded successfully\r
\r
**/\r
EFI_STATUS\r
EdbUnloadCode (\r
  IN EFI_DEBUGGER_PRIVATE_DATA  *DebuggerPrivate,\r
  IN CHAR16                     *MapFileName,\r
  IN CHAR16                     *FileName,\r
  OUT VOID                      **Buffer\r
  )\r
{\r
  EFI_DEBUGGER_SYMBOL_OBJECT  *Object;\r
  UINTN                       ObjectIndex;\r
  UINTN                       EntryIndex;\r
\r
  //\r
  // Find Symbol\r
  //\r
  Object = EdbFindSymbolFile (DebuggerPrivate, MapFileName, &ObjectIndex);\r
  if (Object == NULL) {\r
    EDBPrint (L"SymbolFile is not loaded!\n");\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Find code\r
  //\r
  *Buffer = EdbFindCodeFromObject (DebuggerPrivate, Object, FileName);\r
  if (*Buffer == NULL) {\r
    EDBPrint (L"CodeFile is not loaded!\n");\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // go through each entry\r
  //\r
  for (EntryIndex = 0; EntryIndex < Object->EntryCount; EntryIndex++) {\r
    if ((Object->Entry[EntryIndex].Type != EfiDebuggerSymbolFunction) &&\r
        (Object->Entry[EntryIndex].Type != EfiDebuggerSymbolStaticFunction))\r
    {\r
      continue;\r
    }\r
\r
    if (AsciiStrnCmp (Object->Entry[EntryIndex].Name, "varbss_init", sizeof ("varbss_init") - 1) == 0) {\r
      continue;\r
    }\r
\r
    if (!MatchObjAndCod (Object->Entry[EntryIndex].ObjName, FileName)) {\r
      continue;\r
    }\r
\r
    //\r
    // clean up the buffer\r
    //\r
    Object->Entry[EntryIndex].CodBuffer      = NULL;\r
    Object->Entry[EntryIndex].CodBufferSize  = 0;\r
    Object->Entry[EntryIndex].FuncOffsetBase = 0;\r
    Object->Entry[EntryIndex].SourceBuffer   = NULL;\r
  }\r
\r
  //\r
  // Done\r
  //\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
\r
  Add code buffer.\r
\r
  @param  DebuggerPrivate - EBC Debugger private data structure\r
  @param  MapFileName     - Symbol file name\r
  @param  CodeFileName    - Code file name\r
  @param  SourceBufferSize- Code buffer size\r
  @param  SourceBuffer    - Code buffer\r
\r
  @retval EFI_SUCCESS - CodeBuffer added successfully\r
\r
**/\r
EFI_STATUS\r
EdbAddCodeBuffer (\r
  IN     EFI_DEBUGGER_PRIVATE_DATA  *DebuggerPrivate,\r
  IN     CHAR16                     *MapFileName,\r
  IN     CHAR16                     *CodeFileName,\r
  IN     UINTN                      SourceBufferSize,\r
  IN     VOID                       *SourceBuffer\r
  )\r
{\r
  UINTN                       Index;\r
  EFI_DEBUGGER_SYMBOL_OBJECT  *Object;\r
\r
  //\r
  // Find Symbol\r
  //\r
  Object = EdbFindSymbolFile (DebuggerPrivate, MapFileName, NULL);\r
  if (Object == NULL) {\r
    EDBPrint (L"SymbolFile is not loaded!\n");\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Add it to last entry\r
  //\r
  for (Index = 0; Object->SourceBuffer[Index] != NULL; Index++) {\r
  }\r
\r
  Object->SourceBuffer[Index] = SourceBuffer;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
\r
  Delete code buffer.\r
\r
  @param  DebuggerPrivate - EBC Debugger private data structure\r
  @param  MapFileName     - Symbol file name\r
  @param  CodeFileName    - Code file name\r
  @param  SourceBuffer    - Code buffer\r
\r
  @retval EFI_SUCCESS - CodeBuffer deleted successfully\r
\r
**/\r
EFI_STATUS\r
EdbDeleteCodeBuffer (\r
  IN     EFI_DEBUGGER_PRIVATE_DATA  *DebuggerPrivate,\r
  IN     CHAR16                     *MapFileName,\r
  IN     CHAR16                     *CodeFileName,\r
  IN     VOID                       *SourceBuffer\r
  )\r
{\r
  UINTN                       Index;\r
  EFI_DEBUGGER_SYMBOL_OBJECT  *Object;\r
\r
  //\r
  // Find Symbol\r
  //\r
  Object = EdbFindSymbolFile (DebuggerPrivate, MapFileName, NULL);\r
  if (Object == NULL) {\r
    EDBPrint (L"SymbolFile is not loaded!\n");\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  for (Index = 0; Object->SourceBuffer[Index] != NULL; Index++) {\r
    //\r
    // free the buffer if match\r
    //\r
    if (Object->SourceBuffer[Index] == SourceBuffer) {\r
      gBS->FreePool (SourceBuffer);\r
      break;\r
    }\r
  }\r
\r
  if (Object->SourceBuffer[Index] == NULL) {\r
    //\r
    // not return NOT_FOUND\r
    //\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // remove the entry\r
  //\r
  Object->SourceBuffer[Index] = NULL;\r
  for (Index = Index + 1; Object->SourceBuffer[Index] != NULL; Index++) {\r
    Object->SourceBuffer[Index - 1] = Object->SourceBuffer[Index];\r
  }\r
\r
  Object->SourceBuffer[Index - 1] = NULL;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
\r
  Find the symbol string according to address.\r
\r
  @param  Address         - Symbol address\r
\r
  @return Symbol string\r
\r
**/\r
CHAR8 *\r
FindSymbolStr (\r
  IN UINTN  Address\r
  )\r
{\r
  UINTN                       ObjectIndex;\r
  EFI_DEBUGGER_SYMBOL_OBJECT  *Object;\r
  UINTN                       EntryIndex;\r
  EFI_DEBUGGER_SYMBOL_ENTRY   *Entry;\r
\r
  //\r
  // need we display symbol\r
  //\r
  if (!mDebuggerPrivate.DebuggerSymbolContext.DisplaySymbol) {\r
    return NULL;\r
  }\r
\r
  //\r
  // Go through each object and entry\r
  //\r
  Object = mDebuggerPrivate.DebuggerSymbolContext.Object;\r
  for (ObjectIndex = 0; ObjectIndex < mDebuggerPrivate.DebuggerSymbolContext.ObjectCount; ObjectIndex++) {\r
    Entry = Object[ObjectIndex].Entry;\r
    for (EntryIndex = 0; EntryIndex < Object[ObjectIndex].EntryCount; EntryIndex++) {\r
      //\r
      // if Address match, return Name\r
      //\r
      if (Address == (Entry[EntryIndex].Rva + Object[ObjectIndex].BaseAddress)) {\r
        return Entry[EntryIndex].Name;\r
      }\r
    }\r
  }\r
\r
  //\r
  // not found\r
  //\r
  return NULL;\r
}\r
\r
/**\r
\r
  Get line number and offset from this line in code file.\r
\r
  @param  Line            - Line buffer in code file\r
  @param  Offset          - Offset to functin entry\r
\r
  @return Line number\r
\r
**/\r
UINTN\r
EdbGetLineNumberAndOffsetFromThisLine (\r
  IN VOID    *Line,\r
  OUT UINTN  *Offset\r
  )\r
{\r
  UINTN  LineNumber;\r
  CHAR8  *LineBuffer;\r
  CHAR8  *FieldBuffer;\r
\r
  LineNumber = (UINTN)-1;\r
  LineBuffer = Line;\r
  *Offset    = (UINTN)-1;\r
\r
  while (LineBuffer != NULL) {\r
    //\r
    // Check candidate\r
    //\r
    if (*LineBuffer != ' ') {\r
      return (UINTN)-1;\r
    }\r
\r
    //\r
    // Get Offset\r
    //\r
    if (*(LineBuffer + 2) != ' ') {\r
      if (*Offset == (UINTN)-1) {\r
        FieldBuffer = AsciiStrGetNewTokenField (LineBuffer + 2, " ");\r
        *Offset     = AsciiXtoi (FieldBuffer);\r
        PatchForAsciiStrTokenAfter (FieldBuffer, ' ');\r
      }\r
    }\r
\r
    //\r
    // 1. assembly instruction\r
    //\r
    FieldBuffer = AsciiStrGetNewTokenField (LineBuffer, ":");\r
    //\r
    // 2. file path\r
    //\r
    FieldBuffer = AsciiStrGetNextTokenField (":");\r
    PatchForAsciiStrTokenBefore (FieldBuffer, ':');\r
    if (FieldBuffer == NULL) {\r
      //\r
      // candidate found\r
      //\r
      LineNumber = 0;\r
      LineBuffer = AsciiStrGetNextTokenLine ("\n");\r
      PatchForAsciiStrTokenBefore (LineBuffer, '\n');\r
      continue;\r
    }\r
\r
    //\r
    // 3. line number\r
    //\r
    FieldBuffer = AsciiStrGetNextTokenField (":");\r
    PatchForAsciiStrTokenBefore (FieldBuffer, ':');\r
    if (FieldBuffer == NULL) {\r
      //\r
      // impossible, TBD?\r
      //\r
      LineBuffer = AsciiStrGetNextTokenLine ("\n");\r
      PatchForAsciiStrTokenBefore (LineBuffer, '\n');\r
      continue;\r
    }\r
\r
    LineNumber = AsciiAtoi (FieldBuffer);\r
    //\r
    // Not patch after\r
    //\r
\r
    return LineNumber;\r
  }\r
\r
  return (UINTN)-1;\r
}\r
\r
typedef enum {\r
  EdbEbcLineSearchTypeAny,\r
  EdbEbcLineSearchTypeFirst,\r
  EdbEbcLineSearchTypeLast,\r
  EdbEbcLineSearchTypeMax,\r
} EDB_EBC_LINE_SEARCH_TYPE;\r
\r
/**\r
\r
  Get line number from this code file.\r
\r
  @param  Entry           - Symbol entry\r
  @param  FuncOffset      - Offset to functin entry\r
  @param  SearchType      - Search type for the code\r
\r
  @return Line number\r
\r
**/\r
UINTN\r
EdbGetLineNumberFromCode (\r
  IN EFI_DEBUGGER_SYMBOL_ENTRY  *Entry,\r
  IN UINTN                      FuncOffset,\r
  IN EDB_EBC_LINE_SEARCH_TYPE   SearchType\r
  )\r
{\r
  CHAR8  *LineBuffer;\r
  UINTN  LineNumber;\r
  UINTN  Offset;\r
  UINTN  CandidateLineNumber;\r
  UINTN  CandidateOffset;\r
\r
  if ((SearchType < 0) || (SearchType >= EdbEbcLineSearchTypeMax)) {\r
    return (UINTN)-1;\r
  }\r
\r
  LineNumber          = (UINTN)-1;\r
  CandidateLineNumber = (UINTN)-1;\r
  CandidateOffset     = (UINTN)-1;\r
  LineBuffer          = AsciiStrGetNewTokenLine (Entry->CodBuffer, "\n");\r
  while (LineBuffer != NULL) {\r
    if (*LineBuffer != ' ') {\r
      LineBuffer = AsciiStrGetNextTokenLine ("\n");\r
      PatchForAsciiStrTokenBefore (LineBuffer, '\n');\r
      continue;\r
    }\r
\r
    //\r
    // Get Info\r
    //\r
    LineNumber = EdbGetLineNumberAndOffsetFromThisLine (LineBuffer, &Offset);\r
\r
    //\r
    // Check offset\r
    //\r
    if (Offset != FuncOffset) {\r
      //\r
      // Check last offset match\r
      //\r
      if (CandidateOffset == FuncOffset) {\r
        if (SearchType == EdbEbcLineSearchTypeLast) {\r
          PatchForAsciiStrTokenAfter (LineBuffer, '\n');\r
          if (CandidateLineNumber != LineNumber) {\r
            return CandidateLineNumber;\r
          } else {\r
            return (UINTN)-1;\r
          }\r
        } else {\r
          //\r
          // impossible, TBD?\r
          //\r
        }\r
      }\r
\r
      LineBuffer = AsciiStrGetNextTokenLine ("\n");\r
      PatchForAsciiStrTokenBefore (LineBuffer, '\n');\r
      CandidateLineNumber = LineNumber;\r
      continue;\r
    }\r
\r
    //\r
    // Offset match, more check\r
    //\r
    if (SearchType == EdbEbcLineSearchTypeAny) {\r
      PatchForAsciiStrTokenAfter (LineBuffer, '\n');\r
      return LineNumber;\r
    }\r
\r
    if (SearchType == EdbEbcLineSearchTypeFirst) {\r
      //\r
      // Check last line\r
      //\r
      PatchForAsciiStrTokenAfter (LineBuffer, '\n');\r
      if (CandidateLineNumber != LineNumber) {\r
        return LineNumber;\r
      } else {\r
        return (UINTN)-1;\r
      }\r
    }\r
\r
    CandidateLineNumber = LineNumber;\r
    CandidateOffset     = Offset;\r
\r
    LineBuffer = AsciiStrGetNextTokenLine ("\n");\r
    PatchForAsciiStrTokenBefore (LineBuffer, '\n');\r
  }\r
\r
  //\r
  // Check last offset match\r
  //\r
  if (CandidateOffset == FuncOffset) {\r
    if (SearchType == EdbEbcLineSearchTypeLast) {\r
      return CandidateLineNumber;\r
    }\r
  }\r
\r
  return (UINTN)-1;\r
}\r
\r
/**\r
\r
  Get the source string from this code file by line.\r
\r
  @param  Entry           - Symbol entry\r
  @param  LineNumber      - line number\r
  @param  FuncEnd         - Function end\r
\r
  @return Funtion start\r
\r
**/\r
VOID *\r
EdbGetSourceStrFromCodeByLine (\r
  IN EFI_DEBUGGER_SYMBOL_ENTRY  *Entry,\r
  IN UINTN                      LineNumber,\r
  IN VOID                       **FuncEnd\r
  )\r
{\r
  CHAR8  *LineBuffer;\r
  CHAR8  *FieldBuffer;\r
  VOID   *FuncStart;\r
  UINTN  Number;\r
\r
  FuncStart  = NULL;\r
  LineBuffer = AsciiStrGetNewTokenLine (Entry->CodBuffer, "\n");\r
  while (LineBuffer != NULL) {\r
    if (*LineBuffer != ';') {\r
      if (FuncStart != NULL) {\r
        //\r
        // Over\r
        //\r
        *FuncEnd = LineBuffer - 1;\r
        PatchForAsciiStrTokenAfter (LineBuffer, '\n');\r
        return FuncStart;\r
      }\r
\r
      LineBuffer = AsciiStrGetNextTokenLine ("\n");\r
      PatchForAsciiStrTokenBefore (LineBuffer, '\n');\r
      continue;\r
    }\r
\r
    //\r
    // Check LineNumber\r
    //\r
    FieldBuffer = AsciiStrGetNewTokenField (LineBuffer + 1, " ");\r
    Number      = AsciiAtoi (FieldBuffer);\r
    PatchForAsciiStrTokenAfter (FieldBuffer, ' ');\r
    if (Number != LineNumber) {\r
      LineBuffer = AsciiStrGetNextTokenLine ("\n");\r
      PatchForAsciiStrTokenBefore (LineBuffer, '\n');\r
      continue;\r
    }\r
\r
    //\r
    // Line match, get line number\r
    //\r
    if (FuncStart == NULL) {\r
      FuncStart = LineBuffer;\r
    }\r
\r
    LineBuffer = AsciiStrGetNextTokenLine ("\n");\r
    PatchForAsciiStrTokenBefore (LineBuffer, '\n');\r
  }\r
\r
  return NULL;\r
}\r
\r
/**\r
\r
  Get source string from this code file.\r
\r
  @param  Entry           - Symbol entry\r
  @param  FuncOffset      - Offset to functin entry\r
  @param  FuncEnd         - Function end\r
\r
  @retval Funtion start\r
\r
**/\r
VOID *\r
EdbGetSourceStrFromCode (\r
  IN EFI_DEBUGGER_SYMBOL_ENTRY  *Entry,\r
  IN UINTN                      FuncOffset,\r
  IN VOID                       **FuncEnd\r
  )\r
{\r
  UINTN  LineNumber;\r
\r
  //\r
  // Only search the last line, then display\r
  //\r
  LineNumber = EdbGetLineNumberFromCode (Entry, FuncOffset, EdbEbcLineSearchTypeLast);\r
  if (LineNumber == (UINTN)-1) {\r
    return NULL;\r
  }\r
\r
  return EdbGetSourceStrFromCodeByLine (Entry, LineNumber, FuncEnd);\r
}\r
\r
/**\r
\r
  Print source.\r
\r
  @param  Address         - Instruction address\r
  @param  IsPrint         - Whether need to print\r
\r
  @retval 1 - find the source\r
  @retval 0 - not find the source\r
\r
**/\r
UINTN\r
EdbPrintSource (\r
  IN UINTN    Address,\r
  IN BOOLEAN  IsPrint\r
  )\r
{\r
  UINTN                       SymbolAddress;\r
  EFI_DEBUGGER_SYMBOL_OBJECT  *RetObject;\r
  EFI_DEBUGGER_SYMBOL_ENTRY   *RetEntry;\r
  UINTN                       FuncOffset;\r
  UINT8                       *FuncStart;\r
  UINT8                       *FuncEnd;\r
  UINT8                       *FuncIndex;\r
  CHAR8                       Buffer[EFI_DEBUG_MAX_PRINT_BUFFER];\r
  UINTN                       BufferSize;\r
\r
  //\r
  // need we display symbol\r
  //\r
  if (!mDebuggerPrivate.DebuggerSymbolContext.DisplaySymbol) {\r
    return 0;\r
  }\r
\r
  //\r
  // find the symbol address\r
  //\r
  SymbolAddress = EbdFindSymbolAddress (\r
                    Address,\r
                    EdbMatchSymbolTypeLowerAddress,\r
                    &RetObject,\r
                    &RetEntry\r
                    );\r
  if ((SymbolAddress == 0) || (RetEntry == NULL)) {\r
    return 0;\r
  }\r
\r
  FuncOffset = Address - SymbolAddress + RetEntry->FuncOffsetBase;\r
\r
  //\r
  // Get Func String\r
  //\r
  FuncStart = EdbGetSourceStrFromCode (RetEntry, FuncOffset, (VOID **)&FuncEnd);\r
  if (FuncStart == NULL) {\r
    return 0;\r
  }\r
\r
  //\r
  // check whether need to real print\r
  //\r
  if (!IsPrint) {\r
    return 1;\r
  }\r
\r
  *(UINT8 *)FuncEnd = 0;\r
\r
  //\r
  // seperate buffer by \n, so that \r can be added.\r
  //\r
  FuncIndex = FuncStart;\r
  while (*FuncIndex != 0) {\r
    if (*FuncIndex == '\n') {\r
      if ((FuncIndex - FuncStart) < (EFI_DEBUG_MAX_PRINT_BUFFER - 3)) {\r
        BufferSize = FuncIndex - FuncStart;\r
      } else {\r
        BufferSize = EFI_DEBUG_MAX_PRINT_BUFFER - 3;\r
      }\r
\r
      if (BufferSize != 0) {\r
        CopyMem (Buffer, FuncStart, BufferSize);\r
      }\r
\r
      Buffer[BufferSize] = 0;\r
      EDBPrint (L"%a\n", Buffer);\r
      FuncStart = FuncIndex + 1;\r
      FuncIndex = FuncStart;\r
    } else {\r
      FuncIndex++;\r
    }\r
  }\r
\r
  //\r
  // Patch the end\r
  //\r
  *(UINT8 *)FuncEnd = '\n';\r
\r
  return 1;\r
}\r
\r
/**\r
\r
  Get Mapfile and SymbolName from one symbol format: [MapFileName:]SymbolName.\r
\r
  @param  Symbol          - whole Symbol name\r
  @param  MapfileName     - the mapfile name in the symbol\r
  @param  SymbolName      - the symbol name in the symbol\r
\r
**/\r
VOID\r
GetMapfileAndSymbol (\r
  IN CHAR16   *Symbol,\r
  OUT CHAR16  **MapfileName,\r
  OUT CHAR16  **SymbolName\r
  )\r
{\r
  CHAR16  *Ch;\r
\r
  *MapfileName = NULL;\r
  *SymbolName  = Symbol;\r
\r
  for (Ch = Symbol; *Ch != 0; Ch++) {\r
    //\r
    // Find split char\r
    //\r
    if (*Ch == L':') {\r
      *MapfileName = Symbol;\r
      *Ch          = 0;\r
      *SymbolName  = Ch + 1;\r
      break;\r
    }\r
  }\r
\r
  return;\r
}\r
\r
/**\r
\r
  Convert a symbol to an address.\r
\r
  @param  Symbol          - Symbol name\r
  @param  Address         - Symbol address\r
\r
  @retval EFI_SUCCESS    - symbol found and address returned.\r
  @retval EFI_NOT_FOUND  - symbol not found\r
  @retval EFI_NO_MAPPING - duplicated symbol not found\r
\r
**/\r
EFI_STATUS\r
Symboltoi (\r
  IN CHAR16  *Symbol,\r
  OUT UINTN  *Address\r
  )\r
{\r
  UINTN                       ObjectIndex;\r
  EFI_DEBUGGER_SYMBOL_OBJECT  *Object;\r
  UINTN                       EntryIndex;\r
  EFI_DEBUGGER_SYMBOL_ENTRY   *Entry;\r
  CHAR16                      *SymbolName;\r
  CHAR16                      *MapfileName;\r
\r
  //\r
  // Split one symbol to mapfile name and symbol name\r
  //\r
  GetMapfileAndSymbol (Symbol, &MapfileName, &SymbolName);\r
\r
  *Address = 0;\r
  //\r
  // Go through each object\r
  //\r
  Object = mDebuggerPrivate.DebuggerSymbolContext.Object;\r
  for (ObjectIndex = 0; ObjectIndex < mDebuggerPrivate.DebuggerSymbolContext.ObjectCount; ObjectIndex++) {\r
    //\r
    // Check MapfileName\r
    //\r
    if ((MapfileName != NULL) && (StriCmp (Object[ObjectIndex].Name, MapfileName) != 0)) {\r
      continue;\r
    }\r
\r
    //\r
    // Go through each entry\r
    //\r
    Entry = Object[ObjectIndex].Entry;\r
    for (EntryIndex = 0; EntryIndex < Object[ObjectIndex].EntryCount; EntryIndex++) {\r
      //\r
      // Check SymbolName (case sensitive)\r
      //\r
      if (StrCmpUnicodeAndAscii (SymbolName, Entry[EntryIndex].Name) == 0) {\r
        if ((*Address != 0) && (MapfileName == NULL)) {\r
          //\r
          // Find the duplicated symbol\r
          //\r
          EDBPrint (L"Duplicated Symbol found!\n");\r
          return EFI_NO_MAPPING;\r
        } else {\r
          //\r
          // record Address\r
          //\r
          *Address = (Entry[EntryIndex].Rva + Object[ObjectIndex].BaseAddress);\r
        }\r
      }\r
    }\r
  }\r
\r
  if (*Address == 0) {\r
    //\r
    // Not found\r
    //\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r