Removed MdePkg usage of ModuleName: in file headers

[mirror_edk2.git] / MdePkg / Library / BasePeCoffGetEntryPointLib / PeCoffGetEntryPoint.c

/** @file\r
  Tiano PE/COFF loader.\r
\r
  Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
  All rights reserved. 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
\r
//\r
// The package level header files this module uses\r
//\r
#include <Base.h>\r
//\r
// The protocols, PPI and GUID defintions for this module\r
//\r
//\r
// The Library classes this module consumes\r
//\r
#include <Library/PeCoffGetEntryPointLib.h>\r
#include <Library/DebugLib.h>\r
\r
#include <IndustryStandard/PeImage.h>\r
\r
/**\r
  Retrieves and returns a pointer to the entry point to a PE/COFF image that has been loaded\r
  into system memory with the PE/COFF Loader Library functions.\r
\r
  Retrieves the entry point to the PE/COFF image specified by Pe32Data and returns this entry\r
  point in EntryPoint.  If the entry point could not be retrieved from the PE/COFF image, then\r
  return RETURN_INVALID_PARAMETER.  Otherwise return RETURN_SUCCESS.\r
  If Pe32Data is NULL, then ASSERT().\r
  If EntryPoint is NULL, then ASSERT().\r
\r
  @param  Pe32Data                  Pointer to the PE/COFF image that is loaded in system memory.\r
  @param  EntryPoint                Pointer to entry point to the PE/COFF image to return.\r
\r
  @retval RETURN_SUCCESS            EntryPoint was returned.\r
  @retval RETURN_INVALID_PARAMETER  The entry point could not be found in the PE/COFF image.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
PeCoffLoaderGetEntryPoint (\r
  IN  VOID  *Pe32Data,\r
  OUT VOID  **EntryPoint\r
  )\r
{\r
  EFI_IMAGE_DOS_HEADER                  *DosHeader;\r
  EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION   Header;\r
\r
  ASSERT (Pe32Data   != NULL);\r
  ASSERT (EntryPoint != NULL);\r
\r
  DosHeader = (EFI_IMAGE_DOS_HEADER *)Pe32Data;\r
  if (DosHeader->e_magic == EFI_IMAGE_DOS_SIGNATURE) {\r
    //\r
    // DOS image header is present, so read the PE header after the DOS image header.\r
    //\r
    Header.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)((UINTN) Pe32Data + (UINTN) ((DosHeader->e_lfanew) & 0x0ffff));\r
  } else {\r
    //\r
    // DOS image header is not present, so PE header is at the image base.\r
    //\r
    Header.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)Pe32Data;\r
  }\r
\r
  //\r
  // Calculate the entry point relative to the start of the image.\r
  // AddressOfEntryPoint is common for PE32 & PE32+\r
  //\r
  *EntryPoint = (VOID *)((UINTN)Pe32Data + (UINTN)(Header.Pe32->OptionalHeader.AddressOfEntryPoint & 0x0ffffffff));\r
  return RETURN_SUCCESS;\r
}\r
\r
\r
/**\r
  Returns the machine type of a PE/COFF image.\r
\r
  Returns the machine type from the PE/COFF image specified by Pe32Data.\r
  If Pe32Data is NULL, then ASSERT().\r
\r
  @param  Pe32Data   Pointer to the PE/COFF image that is loaded in system\r
                     memory.\r
\r
  @return Machine type or zero if not a valid iamge.\r
\r
**/\r
UINT16\r
EFIAPI\r
PeCoffLoaderGetMachineType (\r
  IN VOID  *Pe32Data\r
  )\r
{\r
  EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION  Hdr;\r
  EFI_IMAGE_DOS_HEADER                 *DosHdr;\r
\r
  DosHdr = (EFI_IMAGE_DOS_HEADER  *)Pe32Data;\r
  if (DosHdr->e_magic == EFI_IMAGE_DOS_SIGNATURE) {\r
    Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)((UINTN)Pe32Data + DosHdr->e_lfanew);\r
  } else {\r
    Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)((UINTN)Pe32Data);\r
  }\r
\r
  if (Hdr.Pe32->Signature == EFI_IMAGE_NT_SIGNATURE)  {\r
    return Hdr.Pe32->FileHeader.Machine;\r
  }\r
\r
  return 0x0000;\r
}\r
\r
/**\r
  Returns a pointer to the PDB file name for a PE/COFF image that has been\r
  loaded into system memory with the PE/COFF Loader Library functions.\r
\r
  Returns the PDB file name for the PE/COFF image specified by Pe32Data.  If\r
  the PE/COFF image specified by Pe32Data is not a valid, then NULL is\r
  returned.  If the PE/COFF image specified by Pe32Data does not contain a\r
  debug directory entry, then NULL is returned.  If the debug directory entry\r
  in the PE/COFF image specified by Pe32Data does not contain a PDB file name,\r
  then NULL is returned.\r
  If Pe32Data is NULL, then ASSERT().\r
\r
  @param  Pe32Data   Pointer to the PE/COFF image that is loaded in system\r
                     memory.\r
\r
  @return The PDB file name for the PE/COFF image specified by Pe32Data or NULL\r
          if it cannot be retrieved.\r
\r
**/\r
VOID *\r
EFIAPI\r
PeCoffLoaderGetPdbPointer (\r
  IN VOID  *Pe32Data\r
  )\r
{\r
  EFI_IMAGE_DOS_HEADER                  *DosHeader;\r
  EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION   Hdr;\r
  EFI_IMAGE_DATA_DIRECTORY              *DirectoryEntry;\r
  EFI_IMAGE_DEBUG_DIRECTORY_ENTRY       *DebugEntry;\r
  UINTN                                 DirCount;\r
  VOID                                  *CodeViewEntryPointer;\r
  INTN                                  TEImageAdjust;\r
  UINT32                                NumberOfRvaAndSizes;\r
  UINT16                                Magic;\r
\r
  ASSERT (Pe32Data   != NULL);\r
\r
  TEImageAdjust       = 0;\r
  DirectoryEntry      = NULL;\r
  DebugEntry          = NULL;\r
  NumberOfRvaAndSizes = 0;\r
\r
  DosHeader = (EFI_IMAGE_DOS_HEADER *)Pe32Data;\r
  if (DosHeader->e_magic == EFI_IMAGE_DOS_SIGNATURE) {\r
    //\r
    // DOS image header is present, so read the PE header after the DOS image header.\r
    //\r
    Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)((UINTN) Pe32Data + (UINTN) ((DosHeader->e_lfanew) & 0x0ffff));\r
  } else {\r
    //\r
    // DOS image header is not present, so PE header is at the image base.\r
    //\r
    Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)Pe32Data;\r
  }\r
\r
  if (Hdr.Te->Signature == EFI_TE_IMAGE_HEADER_SIGNATURE) {\r
    if (Hdr.Te->DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress != 0) {\r
      DirectoryEntry  = &Hdr.Te->DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG];\r
      TEImageAdjust   = sizeof (EFI_TE_IMAGE_HEADER) - Hdr.Te->StrippedSize;\r
      DebugEntry = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *)((UINTN) Hdr.Te +\r
                    Hdr.Te->DataDirectory[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress +\r
                    TEImageAdjust);\r
    }\r
  } else if (Hdr.Pe32->Signature == EFI_IMAGE_NT_SIGNATURE) {\r
    //\r
    // NOTE: We use Machine field to identify PE32/PE32+, instead of Magic.\r
    //       It is due to backward-compatibility, for some system might\r
    //       generate PE32+ image with PE32 Magic.\r
    //\r
    switch (Hdr.Pe32->FileHeader.Machine) {\r
    case EFI_IMAGE_MACHINE_IA32:\r
      //\r
      // Assume PE32 image with IA32 Machine field.\r
      //\r
      Magic = EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC;\r
      break;\r
    case EFI_IMAGE_MACHINE_X64:\r
    case EFI_IMAGE_MACHINE_IPF:\r
      //\r
      // Assume PE32+ image with X64 or IPF Machine field\r
      //\r
      Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;\r
      break;\r
    default:\r
      //\r
      // For unknow Machine field, use Magic in optional Header\r
      //\r
      Magic = Hdr.Pe32->OptionalHeader.Magic;\r
    }\r
\r
    if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
      //\r
      // Use PE32 offset get Debug Directory Entry\r
      //\r
      NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;\r
      DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG]);\r
      DebugEntry     = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *) ((UINTN) Pe32Data + DirectoryEntry->VirtualAddress);\r
    } else if (Hdr.Pe32->OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC) {\r
      //\r
      // Use PE32+ offset get Debug Directory Entry\r
      //\r
      NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;\r
      DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG]);\r
      DebugEntry     = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *) ((UINTN) Pe32Data + DirectoryEntry->VirtualAddress);\r
    }\r
\r
    if (NumberOfRvaAndSizes <= EFI_IMAGE_DIRECTORY_ENTRY_DEBUG) {\r
      DirectoryEntry = NULL;\r
      DebugEntry = NULL;\r
    }\r
  } else {\r
    return NULL;\r
  }\r
\r
  if (DebugEntry == NULL || DirectoryEntry == NULL) {\r
    return NULL;\r
  }\r
\r
  for (DirCount = 0; DirCount < DirectoryEntry->Size; DirCount++, DebugEntry++) {\r
    if (DebugEntry->Type == EFI_IMAGE_DEBUG_TYPE_CODEVIEW) {\r
      if (DebugEntry->SizeOfData > 0) {\r
        CodeViewEntryPointer = (VOID *) ((UINTN) DebugEntry->RVA + ((UINTN)Pe32Data) + (UINTN)TEImageAdjust);\r
        switch (* (UINT32 *) CodeViewEntryPointer) {\r
        case CODEVIEW_SIGNATURE_NB10:\r
          return (VOID *) ((CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY));\r
        case CODEVIEW_SIGNATURE_RSDS:\r
          return (VOID *) ((CHAR8 *)CodeViewEntryPointer + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY));\r
        default:\r
          break;\r
        }\r
      }\r
    }\r
  }\r
\r
  return NULL;\r
}\r
\r
\r