[mirror_edk2.git] / BaseTools / Source / C / GenFw / Elf32Convert.c

/** @file\r
Elf32 Convert solution\r
\r
Copyright (c) 2010 - 2021, Intel Corporation. All rights reserved.<BR>\r
Portions copyright (c) 2013, ARM Ltd. All rights reserved.<BR>\r
Portions Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "WinNtInclude.h"\r
\r
#ifndef __GNUC__\r
#include <windows.h>\r
#include <io.h>\r
#endif\r
#include <assert.h>\r
#include <stdio.h>\r
#include <stdlib.h>\r
#include <string.h>\r
#include <time.h>\r
#include <ctype.h>\r
\r
#include <Common/UefiBaseTypes.h>\r
#include <IndustryStandard/PeImage.h>\r
\r
#include "PeCoffLib.h"\r
#include "EfiUtilityMsgs.h"\r
\r
#include "GenFw.h"\r
#include "ElfConvert.h"\r
#include "Elf32Convert.h"\r
\r
STATIC\r
VOID\r
ScanSections32 (\r
  VOID\r
  );\r
\r
STATIC\r
BOOLEAN\r
WriteSections32 (\r
  SECTION_FILTER_TYPES  FilterType\r
  );\r
\r
STATIC\r
VOID\r
WriteRelocations32 (\r
  VOID\r
  );\r
\r
STATIC\r
VOID\r
WriteDebug32 (\r
  VOID\r
  );\r
\r
STATIC\r
VOID\r
SetImageSize32 (\r
  VOID\r
  );\r
\r
STATIC\r
VOID\r
CleanUp32 (\r
  VOID\r
  );\r
\r
//\r
// Rename ELF32 structures to common names to help when porting to ELF64.\r
//\r
typedef Elf32_Shdr Elf_Shdr;\r
typedef Elf32_Ehdr Elf_Ehdr;\r
typedef Elf32_Rel Elf_Rel;\r
typedef Elf32_Sym Elf_Sym;\r
typedef Elf32_Phdr Elf_Phdr;\r
typedef Elf32_Dyn Elf_Dyn;\r
#define ELFCLASS ELFCLASS32\r
#define ELF_R_TYPE(r) ELF32_R_TYPE(r)\r
#define ELF_R_SYM(r) ELF32_R_SYM(r)\r
\r
//\r
// Well known ELF structures.\r
//\r
STATIC Elf_Ehdr *mEhdr;\r
STATIC Elf_Shdr *mShdrBase;\r
STATIC Elf_Phdr *mPhdrBase;\r
\r
//\r
// Coff information\r
//\r
STATIC UINT32 mCoffAlignment = 0x20;\r
\r
//\r
// PE section alignment.\r
//\r
STATIC const UINT16 mCoffNbrSections = 4;\r
\r
//\r
// ELF sections to offset in Coff file.\r
//\r
STATIC UINT32 *mCoffSectionsOffset = NULL;\r
\r
//\r
// Offsets in COFF file\r
//\r
STATIC UINT32 mNtHdrOffset;\r
STATIC UINT32 mTextOffset;\r
STATIC UINT32 mDataOffset;\r
STATIC UINT32 mHiiRsrcOffset;\r
STATIC UINT32 mRelocOffset;\r
STATIC UINT32 mDebugOffset;\r
\r
//\r
// Initialization Function\r
//\r
BOOLEAN\r
InitializeElf32 (\r
  UINT8               *FileBuffer,\r
  ELF_FUNCTION_TABLE  *ElfFunctions\r
  )\r
{\r
  //\r
  // Initialize data pointer and structures.\r
  //\r
  mEhdr = (Elf_Ehdr*) FileBuffer;\r
\r
  //\r
  // Check the ELF32 specific header information.\r
  //\r
  if (mEhdr->e_ident[EI_CLASS] != ELFCLASS32) {\r
    Error (NULL, 0, 3000, "Unsupported", "ELF EI_DATA not ELFCLASS32");\r
    return FALSE;\r
  }\r
  if (mEhdr->e_ident[EI_DATA] != ELFDATA2LSB) {\r
    Error (NULL, 0, 3000, "Unsupported", "ELF EI_DATA not ELFDATA2LSB");\r
    return FALSE;\r
  }\r
  if ((mEhdr->e_type != ET_EXEC) && (mEhdr->e_type != ET_DYN)) {\r
    Error (NULL, 0, 3000, "Unsupported", "ELF e_type not ET_EXEC or ET_DYN");\r
    return FALSE;\r
  }\r
  if (!((mEhdr->e_machine == EM_386) || (mEhdr->e_machine == EM_ARM) || (mEhdr->e_machine == EM_RISCV))) {\r
    Warning (NULL, 0, 3000, "Unsupported", "ELF e_machine is not Elf32 machine.");\r
  }\r
  if (mEhdr->e_version != EV_CURRENT) {\r
    Error (NULL, 0, 3000, "Unsupported", "ELF e_version (%u) not EV_CURRENT (%d)", (unsigned) mEhdr->e_version, EV_CURRENT);\r
    return FALSE;\r
  }\r
\r
  //\r
  // Update section header pointers\r
  //\r
  mShdrBase  = (Elf_Shdr *)((UINT8 *)mEhdr + mEhdr->e_shoff);\r
  mPhdrBase = (Elf_Phdr *)((UINT8 *)mEhdr + mEhdr->e_phoff);\r
\r
  //\r
  // Create COFF Section offset buffer and zero.\r
  //\r
  mCoffSectionsOffset = (UINT32 *)malloc(mEhdr->e_shnum * sizeof (UINT32));\r
  if (mCoffSectionsOffset == NULL) {\r
    Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");\r
    return FALSE;\r
  }\r
  memset(mCoffSectionsOffset, 0, mEhdr->e_shnum * sizeof(UINT32));\r
\r
  //\r
  // Fill in function pointers.\r
  //\r
  ElfFunctions->ScanSections = ScanSections32;\r
  ElfFunctions->WriteSections = WriteSections32;\r
  ElfFunctions->WriteRelocations = WriteRelocations32;\r
  ElfFunctions->WriteDebug = WriteDebug32;\r
  ElfFunctions->SetImageSize = SetImageSize32;\r
  ElfFunctions->CleanUp = CleanUp32;\r
\r
  return TRUE;\r
}\r
\r
\r
//\r
// Header by Index functions\r
//\r
STATIC\r
Elf_Shdr*\r
GetShdrByIndex (\r
  UINT32 Num\r
  )\r
{\r
  if (Num >= mEhdr->e_shnum) {\r
    Error (NULL, 0, 3000, "Invalid", "GetShdrByIndex: Index %u is too high.", Num);\r
    exit(EXIT_FAILURE);\r
  }\r
\r
  return (Elf_Shdr*)((UINT8*)mShdrBase + Num * mEhdr->e_shentsize);\r
}\r
\r
STATIC\r
Elf_Phdr*\r
GetPhdrByIndex (\r
  UINT32 num\r
  )\r
{\r
  if (num >= mEhdr->e_phnum) {\r
    Error (NULL, 0, 3000, "Invalid", "GetPhdrByIndex: Index %u is too high.", num);\r
    exit(EXIT_FAILURE);\r
  }\r
\r
  return (Elf_Phdr *)((UINT8*)mPhdrBase + num * mEhdr->e_phentsize);\r
}\r
\r
STATIC\r
UINT32\r
CoffAlign (\r
  UINT32 Offset\r
  )\r
{\r
  return (Offset + mCoffAlignment - 1) & ~(mCoffAlignment - 1);\r
}\r
\r
STATIC\r
UINT32\r
DebugRvaAlign (\r
  UINT32 Offset\r
  )\r
{\r
  return (Offset + 3) & ~3;\r
}\r
\r
//\r
// filter functions\r
//\r
STATIC\r
BOOLEAN\r
IsTextShdr (\r
  Elf_Shdr *Shdr\r
  )\r
{\r
  return (BOOLEAN) ((Shdr->sh_flags & (SHF_EXECINSTR | SHF_ALLOC)) == (SHF_EXECINSTR | SHF_ALLOC));\r
}\r
\r
STATIC\r
BOOLEAN\r
IsHiiRsrcShdr (\r
  Elf_Shdr *Shdr\r
  )\r
{\r
  Elf_Shdr *Namedr = GetShdrByIndex(mEhdr->e_shstrndx);\r
\r
  return (BOOLEAN) (strcmp((CHAR8*)mEhdr + Namedr->sh_offset + Shdr->sh_name, ELF_HII_SECTION_NAME) == 0);\r
}\r
\r
STATIC\r
BOOLEAN\r
IsDataShdr (\r
  Elf_Shdr *Shdr\r
  )\r
{\r
  if (IsHiiRsrcShdr(Shdr)) {\r
    return FALSE;\r
  }\r
  return (BOOLEAN) (Shdr->sh_flags & (SHF_EXECINSTR | SHF_WRITE | SHF_ALLOC)) == (SHF_ALLOC | SHF_WRITE);\r
}\r
\r
STATIC\r
BOOLEAN\r
IsStrtabShdr (\r
  Elf_Shdr *Shdr\r
  )\r
{\r
  Elf_Shdr *Namedr = GetShdrByIndex(mEhdr->e_shstrndx);\r
\r
  return (BOOLEAN) (strcmp((CHAR8*)mEhdr + Namedr->sh_offset + Shdr->sh_name, ELF_STRTAB_SECTION_NAME) == 0);\r
}\r
\r
STATIC\r
Elf_Shdr *\r
FindStrtabShdr (\r
  VOID\r
  )\r
{\r
  UINT32 i;\r
  for (i = 0; i < mEhdr->e_shnum; i++) {\r
    Elf_Shdr *shdr = GetShdrByIndex(i);\r
    if (IsStrtabShdr(shdr)) {\r
      return shdr;\r
    }\r
  }\r
  return NULL;\r
}\r
\r
STATIC\r
const UINT8 *\r
GetSymName (\r
  Elf_Sym *Sym\r
  )\r
{\r
  Elf_Shdr *StrtabShdr;\r
  UINT8    *StrtabContents;\r
  BOOLEAN  foundEnd;\r
  UINT32   i;\r
\r
  if (Sym->st_name == 0) {\r
    return NULL;\r
  }\r
\r
  StrtabShdr = FindStrtabShdr();\r
  if (StrtabShdr == NULL) {\r
    return NULL;\r
  }\r
\r
  assert(Sym->st_name < StrtabShdr->sh_size);\r
\r
  StrtabContents = (UINT8*)mEhdr + StrtabShdr->sh_offset;\r
\r
  foundEnd = FALSE;\r
  for (i = Sym->st_name; (i < StrtabShdr->sh_size) && !foundEnd; i++) {\r
    foundEnd = (BOOLEAN)(StrtabContents[i] == 0);\r
  }\r
  assert(foundEnd);\r
\r
  return StrtabContents + Sym->st_name;\r
}\r
\r
//\r
// Elf functions interface implementation\r
//\r
\r
STATIC\r
VOID\r
ScanSections32 (\r
  VOID\r
  )\r
{\r
  UINT32                          i;\r
  EFI_IMAGE_DOS_HEADER            *DosHdr;\r
  EFI_IMAGE_OPTIONAL_HEADER_UNION *NtHdr;\r
  UINT32                          CoffEntry;\r
  UINT32                          SectionCount;\r
  BOOLEAN                         FoundSection;\r
\r
  CoffEntry = 0;\r
  mCoffOffset = 0;\r
\r
  //\r
  // Coff file start with a DOS header.\r
  //\r
  mCoffOffset = sizeof(EFI_IMAGE_DOS_HEADER) + 0x40;\r
  mNtHdrOffset = mCoffOffset;\r
  switch (mEhdr->e_machine) {\r
  case EM_386:\r
  case EM_ARM:\r
    mCoffOffset += sizeof (EFI_IMAGE_NT_HEADERS32);\r
  break;\r
  default:\r
    VerboseMsg ("%s unknown e_machine type. Assume IA-32", (UINTN)mEhdr->e_machine);\r
    mCoffOffset += sizeof (EFI_IMAGE_NT_HEADERS32);\r
  break;\r
  }\r
\r
  mTableOffset = mCoffOffset;\r
  mCoffOffset += mCoffNbrSections * sizeof(EFI_IMAGE_SECTION_HEADER);\r
\r
  //\r
  // Set mCoffAlignment to the maximum alignment of the input sections\r
  // we care about\r
  //\r
  for (i = 0; i < mEhdr->e_shnum; i++) {\r
    Elf_Shdr *shdr = GetShdrByIndex(i);\r
    if (shdr->sh_addralign <= mCoffAlignment) {\r
      continue;\r
    }\r
    if (IsTextShdr(shdr) || IsDataShdr(shdr) || IsHiiRsrcShdr(shdr)) {\r
      mCoffAlignment = (UINT32)shdr->sh_addralign;\r
    }\r
  }\r
\r
  //\r
  // Check if mCoffAlignment is larger than MAX_COFF_ALIGNMENT\r
  //\r
  if (mCoffAlignment > MAX_COFF_ALIGNMENT) {\r
    Error (NULL, 0, 3000, "Invalid", "Section alignment is larger than MAX_COFF_ALIGNMENT.");\r
    assert (FALSE);\r
  }\r
\r
  //\r
  // Move the PE/COFF header right before the first section. This will help us\r
  // save space when converting to TE.\r
  //\r
  if (mCoffAlignment > mCoffOffset) {\r
    mNtHdrOffset += mCoffAlignment - mCoffOffset;\r
    mTableOffset += mCoffAlignment - mCoffOffset;\r
    mCoffOffset = mCoffAlignment;\r
  }\r
\r
  //\r
  // First text sections.\r
  //\r
  mCoffOffset = CoffAlign(mCoffOffset);\r
  mTextOffset = mCoffOffset;\r
  FoundSection = FALSE;\r
  SectionCount = 0;\r
  for (i = 0; i < mEhdr->e_shnum; i++) {\r
    Elf_Shdr *shdr = GetShdrByIndex(i);\r
    if (IsTextShdr(shdr)) {\r
      if ((shdr->sh_addralign != 0) && (shdr->sh_addralign != 1)) {\r
        // the alignment field is valid\r
        if ((shdr->sh_addr & (shdr->sh_addralign - 1)) == 0) {\r
          // if the section address is aligned we must align PE/COFF\r
          mCoffOffset = (mCoffOffset + shdr->sh_addralign - 1) & ~(shdr->sh_addralign - 1);\r
        } else {\r
          Error (NULL, 0, 3000, "Invalid", "Section address not aligned to its own alignment.");\r
        }\r
      }\r
\r
      /* Relocate entry.  */\r
      if ((mEhdr->e_entry >= shdr->sh_addr) &&\r
          (mEhdr->e_entry < shdr->sh_addr + shdr->sh_size)) {\r
        CoffEntry = mCoffOffset + mEhdr->e_entry - shdr->sh_addr;\r
      }\r
\r
      //\r
      // Set mTextOffset with the offset of the first '.text' section\r
      //\r
      if (!FoundSection) {\r
        mTextOffset = mCoffOffset;\r
        FoundSection = TRUE;\r
      }\r
\r
      mCoffSectionsOffset[i] = mCoffOffset;\r
      mCoffOffset += shdr->sh_size;\r
      SectionCount ++;\r
    }\r
  }\r
\r
  if (!FoundSection) {\r
    Error (NULL, 0, 3000, "Invalid", "Did not find any '.text' section.");\r
    assert (FALSE);\r
  }\r
\r
  mDebugOffset = DebugRvaAlign(mCoffOffset);\r
  mCoffOffset = CoffAlign(mCoffOffset);\r
\r
  if (SectionCount > 1 && mOutImageType == FW_EFI_IMAGE) {\r
    Warning (NULL, 0, 0, NULL, "Multiple sections in %s are merged into 1 text section. Source level debug might not work correctly.", mInImageName);\r
  }\r
\r
  //\r
  //  Then data sections.\r
  //\r
  mDataOffset = mCoffOffset;\r
  FoundSection = FALSE;\r
  SectionCount = 0;\r
  for (i = 0; i < mEhdr->e_shnum; i++) {\r
    Elf_Shdr *shdr = GetShdrByIndex(i);\r
    if (IsDataShdr(shdr)) {\r
      if ((shdr->sh_addralign != 0) && (shdr->sh_addralign != 1)) {\r
        // the alignment field is valid\r
        if ((shdr->sh_addr & (shdr->sh_addralign - 1)) == 0) {\r
          // if the section address is aligned we must align PE/COFF\r
          mCoffOffset = (mCoffOffset + shdr->sh_addralign - 1) & ~(shdr->sh_addralign - 1);\r
        } else {\r
          Error (NULL, 0, 3000, "Invalid", "Section address not aligned to its own alignment.");\r
        }\r
      }\r
\r
      //\r
      // Set mDataOffset with the offset of the first '.data' section\r
      //\r
      if (!FoundSection) {\r
        mDataOffset = mCoffOffset;\r
        FoundSection = TRUE;\r
      }\r
\r
      mCoffSectionsOffset[i] = mCoffOffset;\r
      mCoffOffset += shdr->sh_size;\r
      SectionCount ++;\r
    }\r
  }\r
\r
  if (SectionCount > 1 && mOutImageType == FW_EFI_IMAGE) {\r
    Warning (NULL, 0, 0, NULL, "Multiple sections in %s are merged into 1 data section. Source level debug might not work correctly.", mInImageName);\r
  }\r
\r
  //\r
  // Make room for .debug data in .data (or .text if .data is empty) instead of\r
  // putting it in a section of its own. This is explicitly allowed by the\r
  // PE/COFF spec, and prevents bloat in the binary when using large values for\r
  // section alignment.\r
  //\r
  if (SectionCount > 0) {\r
    mDebugOffset = DebugRvaAlign(mCoffOffset);\r
  }\r
  mCoffOffset = mDebugOffset + sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY) +\r
                sizeof(EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY) +\r
                strlen(mInImageName) + 1;\r
\r
  mCoffOffset = CoffAlign(mCoffOffset);\r
  if (SectionCount == 0) {\r
    mDataOffset = mCoffOffset;\r
  }\r
\r
  //\r
  //  The HII resource sections.\r
  //\r
  mHiiRsrcOffset = mCoffOffset;\r
  for (i = 0; i < mEhdr->e_shnum; i++) {\r
    Elf_Shdr *shdr = GetShdrByIndex(i);\r
    if (IsHiiRsrcShdr(shdr)) {\r
      if ((shdr->sh_addralign != 0) && (shdr->sh_addralign != 1)) {\r
        // the alignment field is valid\r
        if ((shdr->sh_addr & (shdr->sh_addralign - 1)) == 0) {\r
          // if the section address is aligned we must align PE/COFF\r
          mCoffOffset = (mCoffOffset + shdr->sh_addralign - 1) & ~(shdr->sh_addralign - 1);\r
        } else {\r
          Error (NULL, 0, 3000, "Invalid", "Section address not aligned to its own alignment.");\r
        }\r
      }\r
      if (shdr->sh_size != 0) {\r
        mHiiRsrcOffset = mCoffOffset;\r
        mCoffSectionsOffset[i] = mCoffOffset;\r
        mCoffOffset += shdr->sh_size;\r
        mCoffOffset = CoffAlign(mCoffOffset);\r
        SetHiiResourceHeader ((UINT8*) mEhdr + shdr->sh_offset, mHiiRsrcOffset);\r
      }\r
      break;\r
    }\r
  }\r
\r
  mRelocOffset = mCoffOffset;\r
\r
  //\r
  // Allocate base Coff file.  Will be expanded later for relocations.\r
  //\r
  mCoffFile = (UINT8 *)malloc(mCoffOffset);\r
  if (mCoffFile == NULL) {\r
    Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");\r
  }\r
  assert (mCoffFile != NULL);\r
  memset(mCoffFile, 0, mCoffOffset);\r
\r
  //\r
  // Fill headers.\r
  //\r
  DosHdr = (EFI_IMAGE_DOS_HEADER *)mCoffFile;\r
  DosHdr->e_magic = EFI_IMAGE_DOS_SIGNATURE;\r
  DosHdr->e_lfanew = mNtHdrOffset;\r
\r
  NtHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION*)(mCoffFile + mNtHdrOffset);\r
\r
  NtHdr->Pe32.Signature = EFI_IMAGE_NT_SIGNATURE;\r
\r
  switch (mEhdr->e_machine) {\r
  case EM_386:\r
    NtHdr->Pe32.FileHeader.Machine = EFI_IMAGE_MACHINE_IA32;\r
    NtHdr->Pe32.OptionalHeader.Magic = EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC;\r
    break;\r
  case EM_ARM:\r
    NtHdr->Pe32.FileHeader.Machine = EFI_IMAGE_MACHINE_ARMT;\r
    NtHdr->Pe32.OptionalHeader.Magic = EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC;\r
    break;\r
  default:\r
    VerboseMsg ("%s unknown e_machine type %hu. Assume IA-32", mInImageName, mEhdr->e_machine);\r
    NtHdr->Pe32.FileHeader.Machine = EFI_IMAGE_MACHINE_IA32;\r
    NtHdr->Pe32.OptionalHeader.Magic = EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC;\r
  }\r
\r
  NtHdr->Pe32.FileHeader.NumberOfSections = mCoffNbrSections;\r
  NtHdr->Pe32.FileHeader.TimeDateStamp = (UINT32) time(NULL);\r
  mImageTimeStamp = NtHdr->Pe32.FileHeader.TimeDateStamp;\r
  NtHdr->Pe32.FileHeader.PointerToSymbolTable = 0;\r
  NtHdr->Pe32.FileHeader.NumberOfSymbols = 0;\r
  NtHdr->Pe32.FileHeader.SizeOfOptionalHeader = sizeof(NtHdr->Pe32.OptionalHeader);\r
  NtHdr->Pe32.FileHeader.Characteristics = EFI_IMAGE_FILE_EXECUTABLE_IMAGE\r
    | EFI_IMAGE_FILE_LINE_NUMS_STRIPPED\r
    | EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED\r
    | EFI_IMAGE_FILE_32BIT_MACHINE;\r
\r
  NtHdr->Pe32.OptionalHeader.SizeOfCode = mDataOffset - mTextOffset;\r
  NtHdr->Pe32.OptionalHeader.SizeOfInitializedData = mRelocOffset - mDataOffset;\r
  NtHdr->Pe32.OptionalHeader.SizeOfUninitializedData = 0;\r
  NtHdr->Pe32.OptionalHeader.AddressOfEntryPoint = CoffEntry;\r
\r
  NtHdr->Pe32.OptionalHeader.BaseOfCode = mTextOffset;\r
\r
  NtHdr->Pe32.OptionalHeader.BaseOfData = mDataOffset;\r
  NtHdr->Pe32.OptionalHeader.ImageBase = 0;\r
  NtHdr->Pe32.OptionalHeader.SectionAlignment = mCoffAlignment;\r
  NtHdr->Pe32.OptionalHeader.FileAlignment = mCoffAlignment;\r
  NtHdr->Pe32.OptionalHeader.SizeOfImage = 0;\r
\r
  NtHdr->Pe32.OptionalHeader.SizeOfHeaders = mTextOffset;\r
  NtHdr->Pe32.OptionalHeader.NumberOfRvaAndSizes = EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES;\r
\r
  //\r
  // Section headers.\r
  //\r
  if ((mDataOffset - mTextOffset) > 0) {\r
    CreateSectionHeader (".text", mTextOffset, mDataOffset - mTextOffset,\r
            EFI_IMAGE_SCN_CNT_CODE\r
            | EFI_IMAGE_SCN_MEM_EXECUTE\r
            | EFI_IMAGE_SCN_MEM_READ);\r
  } else {\r
    // Don't make a section of size 0.\r
    NtHdr->Pe32.FileHeader.NumberOfSections--;\r
  }\r
\r
  if ((mHiiRsrcOffset - mDataOffset) > 0) {\r
    CreateSectionHeader (".data", mDataOffset, mHiiRsrcOffset - mDataOffset,\r
            EFI_IMAGE_SCN_CNT_INITIALIZED_DATA\r
            | EFI_IMAGE_SCN_MEM_WRITE\r
            | EFI_IMAGE_SCN_MEM_READ);\r
  } else {\r
    // Don't make a section of size 0.\r
    NtHdr->Pe32.FileHeader.NumberOfSections--;\r
  }\r
\r
  if ((mRelocOffset - mHiiRsrcOffset) > 0) {\r
    CreateSectionHeader (".rsrc", mHiiRsrcOffset, mRelocOffset - mHiiRsrcOffset,\r
            EFI_IMAGE_SCN_CNT_INITIALIZED_DATA\r
            | EFI_IMAGE_SCN_MEM_READ);\r
\r
    NtHdr->Pe32.OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE].Size = mRelocOffset - mHiiRsrcOffset;\r
    NtHdr->Pe32.OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE].VirtualAddress = mHiiRsrcOffset;\r
  } else {\r
    // Don't make a section of size 0.\r
    NtHdr->Pe32.FileHeader.NumberOfSections--;\r
  }\r
\r
}\r
\r
STATIC\r
BOOLEAN\r
WriteSections32 (\r
  SECTION_FILTER_TYPES  FilterType\r
  )\r
{\r
  UINT32      Idx;\r
  Elf_Shdr    *SecShdr;\r
  UINT32      SecOffset;\r
  BOOLEAN     (*Filter)(Elf_Shdr *);\r
\r
  //\r
  // Initialize filter pointer\r
  //\r
  switch (FilterType) {\r
    case SECTION_TEXT:\r
      Filter = IsTextShdr;\r
      break;\r
    case SECTION_HII:\r
      Filter = IsHiiRsrcShdr;\r
      break;\r
    case SECTION_DATA:\r
      Filter = IsDataShdr;\r
      break;\r
    default:\r
      return FALSE;\r
  }\r
\r
  //\r
  // First: copy sections.\r
  //\r
  for (Idx = 0; Idx < mEhdr->e_shnum; Idx++) {\r
    Elf_Shdr *Shdr = GetShdrByIndex(Idx);\r
    if ((*Filter)(Shdr)) {\r
      switch (Shdr->sh_type) {\r
      case SHT_PROGBITS:\r
        /* Copy.  */\r
        if (Shdr->sh_offset + Shdr->sh_size > mFileBufferSize) {\r
          return FALSE;\r
        }\r
        memcpy(mCoffFile + mCoffSectionsOffset[Idx],\r
              (UINT8*)mEhdr + Shdr->sh_offset,\r
              Shdr->sh_size);\r
        break;\r
\r
      case SHT_NOBITS:\r
        memset(mCoffFile + mCoffSectionsOffset[Idx], 0, Shdr->sh_size);\r
        break;\r
\r
      default:\r
        //\r
        //  Ignore for unknown section type.\r
        //\r
        VerboseMsg ("%s unknown section type %x. We ignore this unknown section type.", mInImageName, (unsigned)Shdr->sh_type);\r
        break;\r
      }\r
    }\r
  }\r
\r
  //\r
  // Second: apply relocations.\r
  //\r
  for (Idx = 0; Idx < mEhdr->e_shnum; Idx++) {\r
    //\r
    // Determine if this is a relocation section.\r
    //\r
    Elf_Shdr *RelShdr = GetShdrByIndex(Idx);\r
    if ((RelShdr->sh_type != SHT_REL) && (RelShdr->sh_type != SHT_RELA)) {\r
      continue;\r
    }\r
\r
    //\r
    // Relocation section found.  Now extract section information that the relocations\r
    // apply to in the ELF data and the new COFF data.\r
    //\r
    SecShdr = GetShdrByIndex(RelShdr->sh_info);\r
    SecOffset = mCoffSectionsOffset[RelShdr->sh_info];\r
\r
    //\r
    // Only process relocations for the current filter type.\r
    //\r
    if (RelShdr->sh_type == SHT_REL && (*Filter)(SecShdr)) {\r
      UINT32 RelOffset;\r
\r
      //\r
      // Determine the symbol table referenced by the relocation data.\r
      //\r
      Elf_Shdr *SymtabShdr = GetShdrByIndex(RelShdr->sh_link);\r
      UINT8 *Symtab = (UINT8*)mEhdr + SymtabShdr->sh_offset;\r
\r
      //\r
      // Process all relocation entries for this section.\r
      //\r
      for (RelOffset = 0; RelOffset < RelShdr->sh_size; RelOffset += RelShdr->sh_entsize) {\r
        //\r
        // Set pointer to relocation entry\r
        //\r
        Elf_Rel *Rel = (Elf_Rel *)((UINT8*)mEhdr + RelShdr->sh_offset + RelOffset);\r
\r
        //\r
        // Set pointer to symbol table entry associated with the relocation entry.\r
        //\r
        Elf_Sym *Sym = (Elf_Sym *)(Symtab + ELF_R_SYM(Rel->r_info) * SymtabShdr->sh_entsize);\r
\r
        Elf_Shdr *SymShdr;\r
        UINT8 *Targ;\r
        UINT16 Address;\r
\r
        //\r
        // Check section header index found in symbol table and get the section\r
        // header location.\r
        //\r
        if (Sym->st_shndx == SHN_UNDEF\r
            || Sym->st_shndx >= mEhdr->e_shnum) {\r
          const UINT8 *SymName = GetSymName(Sym);\r
          if (SymName == NULL) {\r
            SymName = (const UINT8 *)"<unknown>";\r
          }\r
          continue;\r
        }\r
        SymShdr = GetShdrByIndex(Sym->st_shndx);\r
\r
        //\r
        // Convert the relocation data to a pointer into the coff file.\r
        //\r
        // Note:\r
        //   r_offset is the virtual address of the storage unit to be relocated.\r
        //   sh_addr is the virtual address for the base of the section.\r
        //\r
        Targ = mCoffFile + SecOffset + (Rel->r_offset - SecShdr->sh_addr);\r
\r
        //\r
        // Determine how to handle each relocation type based on the machine type.\r
        //\r
        if (mEhdr->e_machine == EM_386) {\r
          switch (ELF_R_TYPE(Rel->r_info)) {\r
          case R_386_NONE:\r
            break;\r
          case R_386_32:\r
            //\r
            // Absolute relocation.\r
            //  Converts Targ from a absolute virtual address to the absolute\r
            //  COFF address.\r
            //\r
            *(UINT32 *)Targ = *(UINT32 *)Targ - SymShdr->sh_addr\r
              + mCoffSectionsOffset[Sym->st_shndx];\r
            break;\r
          case R_386_PC32:\r
            //\r
            // Relative relocation: Symbol - Ip + Addend\r
            //\r
            *(UINT32 *)Targ = *(UINT32 *)Targ\r
              + (mCoffSectionsOffset[Sym->st_shndx] - SymShdr->sh_addr)\r
              - (SecOffset - SecShdr->sh_addr);\r
            break;\r
          default:\r
            Error (NULL, 0, 3000, "Invalid", "%s unsupported ELF EM_386 relocation 0x%x.", mInImageName, (unsigned) ELF_R_TYPE(Rel->r_info));\r
          }\r
        } else if (mEhdr->e_machine == EM_ARM) {\r
          switch (ELF32_R_TYPE(Rel->r_info)) {\r
          case R_ARM_RBASE:\r
            // No relocation - no action required\r
            // break skipped\r
\r
          case R_ARM_PC24:\r
          case R_ARM_REL32:\r
          case R_ARM_XPC25:\r
          case R_ARM_THM_PC22:\r
          case R_ARM_THM_JUMP19:\r
          case R_ARM_CALL:\r
          case R_ARM_JMP24:\r
          case R_ARM_THM_JUMP24:\r
          case R_ARM_PREL31:\r
          case R_ARM_MOVW_PREL_NC:\r
          case R_ARM_MOVT_PREL:\r
          case R_ARM_THM_MOVW_PREL_NC:\r
          case R_ARM_THM_MOVT_PREL:\r
          case R_ARM_THM_JMP6:\r
          case R_ARM_THM_ALU_PREL_11_0:\r
          case R_ARM_THM_PC12:\r
          case R_ARM_REL32_NOI:\r
          case R_ARM_ALU_PC_G0_NC:\r
          case R_ARM_ALU_PC_G0:\r
          case R_ARM_ALU_PC_G1_NC:\r
          case R_ARM_ALU_PC_G1:\r
          case R_ARM_ALU_PC_G2:\r
          case R_ARM_LDR_PC_G1:\r
          case R_ARM_LDR_PC_G2:\r
          case R_ARM_LDRS_PC_G0:\r
          case R_ARM_LDRS_PC_G1:\r
          case R_ARM_LDRS_PC_G2:\r
          case R_ARM_LDC_PC_G0:\r
          case R_ARM_LDC_PC_G1:\r
          case R_ARM_LDC_PC_G2:\r
          case R_ARM_THM_JUMP11:\r
          case R_ARM_THM_JUMP8:\r
          case R_ARM_TLS_GD32:\r
          case R_ARM_TLS_LDM32:\r
          case R_ARM_TLS_IE32:\r
            // Thease are all PC-relative relocations and don't require modification\r
            // GCC does not seem to have the concept of a application that just needs to get relocated.\r
            break;\r
\r
          case R_ARM_THM_MOVW_ABS_NC:\r
            // MOVW is only lower 16-bits of the addres\r
            Address = (UINT16)(Sym->st_value - SymShdr->sh_addr + mCoffSectionsOffset[Sym->st_shndx]);\r
            ThumbMovtImmediatePatch ((UINT16 *)Targ, Address);\r
            break;\r
\r
          case R_ARM_THM_MOVT_ABS:\r
            // MOVT is only upper 16-bits of the addres\r
            Address = (UINT16)((Sym->st_value - SymShdr->sh_addr + mCoffSectionsOffset[Sym->st_shndx]) >> 16);\r
            ThumbMovtImmediatePatch ((UINT16 *)Targ, Address);\r
            break;\r
\r
          case R_ARM_ABS32:\r
          case R_ARM_RABS32:\r
            //\r
            // Absolute relocation.\r
            //\r
            *(UINT32 *)Targ = *(UINT32 *)Targ - SymShdr->sh_addr + mCoffSectionsOffset[Sym->st_shndx];\r
            break;\r
\r
          default:\r
            Error (NULL, 0, 3000, "Invalid", "WriteSections (): %s unsupported ELF EM_ARM relocation 0x%x.", mInImageName, (unsigned) ELF32_R_TYPE(Rel->r_info));\r
          }\r
        }\r
      }\r
    }\r
  }\r
\r
  return TRUE;\r
}\r
\r
UINTN gMovwOffset = 0;\r
\r
STATIC\r
VOID\r
WriteRelocations32 (\r
  VOID\r
  )\r
{\r
  UINT32                           Index;\r
  EFI_IMAGE_OPTIONAL_HEADER_UNION  *NtHdr;\r
  EFI_IMAGE_DATA_DIRECTORY         *Dir;\r
  BOOLEAN                          FoundRelocations;\r
  Elf_Dyn                          *Dyn;\r
  Elf_Rel                          *Rel;\r
  UINTN                            RelElementSize;\r
  UINTN                            RelSize;\r
  UINTN                            RelOffset;\r
  UINTN                            K;\r
  Elf32_Phdr                       *DynamicSegment;\r
\r
  for (Index = 0, FoundRelocations = FALSE; Index < mEhdr->e_shnum; Index++) {\r
    Elf_Shdr *RelShdr = GetShdrByIndex(Index);\r
    if ((RelShdr->sh_type == SHT_REL) || (RelShdr->sh_type == SHT_RELA)) {\r
      Elf_Shdr *SecShdr = GetShdrByIndex (RelShdr->sh_info);\r
      if (IsTextShdr(SecShdr) || IsDataShdr(SecShdr)) {\r
        UINT32 RelIdx;\r
\r
        FoundRelocations = TRUE;\r
        for (RelIdx = 0; RelIdx < RelShdr->sh_size; RelIdx += RelShdr->sh_entsize) {\r
          Rel = (Elf_Rel *)((UINT8*)mEhdr + RelShdr->sh_offset + RelIdx);\r
\r
          if (mEhdr->e_machine == EM_386) {\r
            switch (ELF_R_TYPE(Rel->r_info)) {\r
            case R_386_NONE:\r
            case R_386_PC32:\r
              //\r
              // No fixup entry required.\r
              //\r
              break;\r
            case R_386_32:\r
              //\r
              // Creates a relative relocation entry from the absolute entry.\r
              //\r
              CoffAddFixup(mCoffSectionsOffset[RelShdr->sh_info]\r
              + (Rel->r_offset - SecShdr->sh_addr),\r
              EFI_IMAGE_REL_BASED_HIGHLOW);\r
              break;\r
            default:\r
              Error (NULL, 0, 3000, "Invalid", "%s unsupported ELF EM_386 relocation 0x%x.", mInImageName, (unsigned) ELF_R_TYPE(Rel->r_info));\r
            }\r
          } else if (mEhdr->e_machine == EM_ARM) {\r
            switch (ELF32_R_TYPE(Rel->r_info)) {\r
            case R_ARM_RBASE:\r
              // No relocation - no action required\r
              // break skipped\r
\r
            case R_ARM_PC24:\r
            case R_ARM_REL32:\r
            case R_ARM_XPC25:\r
            case R_ARM_THM_PC22:\r
            case R_ARM_THM_JUMP19:\r
            case R_ARM_CALL:\r
            case R_ARM_JMP24:\r
            case R_ARM_THM_JUMP24:\r
            case R_ARM_PREL31:\r
            case R_ARM_MOVW_PREL_NC:\r
            case R_ARM_MOVT_PREL:\r
            case R_ARM_THM_MOVW_PREL_NC:\r
            case R_ARM_THM_MOVT_PREL:\r
            case R_ARM_THM_JMP6:\r
            case R_ARM_THM_ALU_PREL_11_0:\r
            case R_ARM_THM_PC12:\r
            case R_ARM_REL32_NOI:\r
            case R_ARM_ALU_PC_G0_NC:\r
            case R_ARM_ALU_PC_G0:\r
            case R_ARM_ALU_PC_G1_NC:\r
            case R_ARM_ALU_PC_G1:\r
            case R_ARM_ALU_PC_G2:\r
            case R_ARM_LDR_PC_G1:\r
            case R_ARM_LDR_PC_G2:\r
            case R_ARM_LDRS_PC_G0:\r
            case R_ARM_LDRS_PC_G1:\r
            case R_ARM_LDRS_PC_G2:\r
            case R_ARM_LDC_PC_G0:\r
            case R_ARM_LDC_PC_G1:\r
            case R_ARM_LDC_PC_G2:\r
            case R_ARM_THM_JUMP11:\r
            case R_ARM_THM_JUMP8:\r
            case R_ARM_TLS_GD32:\r
            case R_ARM_TLS_LDM32:\r
            case R_ARM_TLS_IE32:\r
              // Thease are all PC-relative relocations and don't require modification\r
              break;\r
\r
            case R_ARM_THM_MOVW_ABS_NC:\r
              CoffAddFixup (\r
                mCoffSectionsOffset[RelShdr->sh_info]\r
                + (Rel->r_offset - SecShdr->sh_addr),\r
                EFI_IMAGE_REL_BASED_ARM_MOV32T\r
                );\r
\r
              // PE/COFF treats MOVW/MOVT relocation as single 64-bit instruction\r
              // Track this address so we can log an error for unsupported sequence of MOVW/MOVT\r
              gMovwOffset = mCoffSectionsOffset[RelShdr->sh_info] + (Rel->r_offset - SecShdr->sh_addr);\r
              break;\r
\r
            case R_ARM_THM_MOVT_ABS:\r
              if ((gMovwOffset + 4) !=  (mCoffSectionsOffset[RelShdr->sh_info] + (Rel->r_offset - SecShdr->sh_addr))) {\r
                Error (NULL, 0, 3000, "Not Supported", "PE/COFF requires MOVW+MOVT instruction sequence %x +4 != %x.", gMovwOffset, mCoffSectionsOffset[RelShdr->sh_info] + (Rel->r_offset - SecShdr->sh_addr));\r
              }\r
              break;\r
\r
            case R_ARM_ABS32:\r
            case R_ARM_RABS32:\r
              CoffAddFixup (\r
                mCoffSectionsOffset[RelShdr->sh_info]\r
                + (Rel->r_offset - SecShdr->sh_addr),\r
                EFI_IMAGE_REL_BASED_HIGHLOW\r
                );\r
              break;\r
\r
           default:\r
              Error (NULL, 0, 3000, "Invalid", "WriteRelocations(): %s unsupported ELF EM_ARM relocation 0x%x.", mInImageName, (unsigned) ELF32_R_TYPE(Rel->r_info));\r
            }\r
          } else {\r
            Error (NULL, 0, 3000, "Not Supported", "This tool does not support relocations for ELF with e_machine %u (processor type).", (unsigned) mEhdr->e_machine);\r
          }\r
        }\r
      }\r
    }\r
  }\r
\r
  if (!FoundRelocations && (mEhdr->e_machine == EM_ARM)) {\r
    /* Try again, but look for PT_DYNAMIC instead of SHT_REL */\r
\r
    for (Index = 0; Index < mEhdr->e_phnum; Index++) {\r
      RelElementSize = 0;\r
      RelSize = 0;\r
      RelOffset = 0;\r
\r
      DynamicSegment = GetPhdrByIndex (Index);\r
\r
      if (DynamicSegment->p_type == PT_DYNAMIC) {\r
        Dyn = (Elf32_Dyn *) ((UINT8 *)mEhdr + DynamicSegment->p_offset);\r
\r
        while (Dyn->d_tag != DT_NULL) {\r
          switch (Dyn->d_tag) {\r
            case  DT_REL:\r
              RelOffset = Dyn->d_un.d_val;\r
              break;\r
\r
            case  DT_RELSZ:\r
              RelSize = Dyn->d_un.d_val;\r
              break;\r
\r
            case  DT_RELENT:\r
              RelElementSize = Dyn->d_un.d_val;\r
              break;\r
\r
            default:\r
              break;\r
          }\r
          Dyn++;\r
        }\r
        if (( RelOffset == 0 ) || ( RelSize == 0 ) || ( RelElementSize == 0 )) {\r
          Error (NULL, 0, 3000, "Invalid", "%s bad ARM dynamic relocations.", mInImageName);\r
        }\r
\r
        for (Index = 0; Index < mEhdr->e_shnum; Index++) {\r
          Elf_Shdr *shdr = GetShdrByIndex(Index);\r
\r
          //\r
          // The PT_DYNAMIC section contains DT_REL relocations whose r_offset\r
          // field is relative to the base of a segment (or the entire image),\r
          // and not to the base of an ELF input section as is the case for\r
          // SHT_REL sections. This means that we cannot fix up such relocations\r
          // unless we cross-reference ELF sections and segments, considering\r
          // that the output placement recorded in mCoffSectionsOffset[] is\r
          // section based, not segment based.\r
          //\r
          // Fortunately, there is a simple way around this: we require that the\r
          // in-memory layout of the ELF and PE/COFF versions of the binary is\r
          // identical. That way, r_offset will retain its validity as a PE/COFF\r
          // image offset, and we can record it in the COFF fixup table\r
          // unmodified.\r
          //\r
          if (shdr->sh_addr != mCoffSectionsOffset[Index]) {\r
            Error (NULL, 0, 3000,\r
              "Invalid", "%s: PT_DYNAMIC relocations require identical ELF and PE/COFF section offsets.",\r
              mInImageName);\r
          }\r
        }\r
\r
        for (K = 0; K < RelSize; K += RelElementSize) {\r
\r
          if (DynamicSegment->p_paddr == 0) {\r
            // Older versions of the ARM ELF (SWS ESPC 0003 B-02) specification define DT_REL\r
            // as an offset in the dynamic segment. p_paddr is defined to be zero for ARM tools\r
            Rel = (Elf32_Rel *) ((UINT8 *) mEhdr + DynamicSegment->p_offset + RelOffset + K);\r
          } else {\r
            // This is how it reads in the generic ELF specification\r
            Rel = (Elf32_Rel *) ((UINT8 *) mEhdr + RelOffset + K);\r
          }\r
\r
          switch (ELF32_R_TYPE (Rel->r_info)) {\r
          case  R_ARM_RBASE:\r
            break;\r
\r
          case  R_ARM_RABS32:\r
            CoffAddFixup (Rel->r_offset, EFI_IMAGE_REL_BASED_HIGHLOW);\r
            break;\r
\r
          default:\r
            Error (NULL, 0, 3000, "Invalid", "%s bad ARM dynamic relocations, unknown type %d.", mInImageName, ELF32_R_TYPE (Rel->r_info));\r
            break;\r
          }\r
        }\r
        break;\r
      }\r
    }\r
  }\r
\r
  //\r
  // Pad by adding empty entries.\r
  //\r
  while (mCoffOffset & (mCoffAlignment - 1)) {\r
    CoffAddFixupEntry(0);\r
  }\r
\r
  NtHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION *)(mCoffFile + mNtHdrOffset);\r
  Dir = &NtHdr->Pe32.OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];\r
  Dir->Size = mCoffOffset - mRelocOffset;\r
  if (Dir->Size == 0) {\r
    // If no relocations, null out the directory entry and don't add the .reloc section\r
    Dir->VirtualAddress = 0;\r
    NtHdr->Pe32.FileHeader.NumberOfSections--;\r
  } else {\r
    Dir->VirtualAddress = mRelocOffset;\r
    CreateSectionHeader (".reloc", mRelocOffset, mCoffOffset - mRelocOffset,\r
            EFI_IMAGE_SCN_CNT_INITIALIZED_DATA\r
            | EFI_IMAGE_SCN_MEM_DISCARDABLE\r
            | EFI_IMAGE_SCN_MEM_READ);\r
  }\r
\r
}\r
\r
STATIC\r
VOID\r
WriteDebug32 (\r
  VOID\r
  )\r
{\r
  UINT32                              Len;\r
  EFI_IMAGE_OPTIONAL_HEADER_UNION     *NtHdr;\r
  EFI_IMAGE_DATA_DIRECTORY            *DataDir;\r
  EFI_IMAGE_DEBUG_DIRECTORY_ENTRY     *Dir;\r
  EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY *Nb10;\r
\r
  Len = strlen(mInImageName) + 1;\r
\r
  Dir = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY*)(mCoffFile + mDebugOffset);\r
  Dir->Type = EFI_IMAGE_DEBUG_TYPE_CODEVIEW;\r
  Dir->SizeOfData = sizeof(EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY) + Len;\r
  Dir->RVA = mDebugOffset + sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);\r
  Dir->FileOffset = mDebugOffset + sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);\r
\r
  Nb10 = (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY*)(Dir + 1);\r
  Nb10->Signature = CODEVIEW_SIGNATURE_NB10;\r
  strcpy ((char *)(Nb10 + 1), mInImageName);\r
\r
\r
  NtHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION *)(mCoffFile + mNtHdrOffset);\r
  DataDir = &NtHdr->Pe32.OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG];\r
  DataDir->VirtualAddress = mDebugOffset;\r
  DataDir->Size = sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);\r
}\r
\r
STATIC\r
VOID\r
SetImageSize32 (\r
  VOID\r
  )\r
{\r
  EFI_IMAGE_OPTIONAL_HEADER_UNION *NtHdr;\r
\r
  //\r
  // Set image size\r
  //\r
  NtHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION *)(mCoffFile + mNtHdrOffset);\r
  NtHdr->Pe32.OptionalHeader.SizeOfImage = mCoffOffset;\r
}\r
\r
STATIC\r
VOID\r
CleanUp32 (\r
  VOID\r
  )\r
{\r
  if (mCoffSectionsOffset != NULL) {\r
    free (mCoffSectionsOffset);\r
  }\r
}\r
\r
\r