BaseTools: Roll back GenFw Change to keep unknown field in RSDS debug entry

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

/** @file\r
Elf convert solution\r
\r
Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>\r
\r
This program and the accompanying materials are licensed and made available \r
under the terms and conditions of the BSD License which accompanies this \r
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
#include "WinNtInclude.h"\r
\r
#ifndef __GNUC__\r
#include <windows.h>\r
#include <io.h>\r
#endif\r
#include <stdio.h>\r
#include <stdlib.h>\r
#include <string.h>\r
#include <time.h>\r
#include <ctype.h>\r
#include <assert.h>\r
\r
#include <Common/UefiBaseTypes.h>\r
#include <IndustryStandard/PeImage.h>\r
\r
#include "EfiUtilityMsgs.h"\r
\r
#include "GenFw.h"\r
#include "ElfConvert.h"\r
#include "Elf32Convert.h"\r
#include "Elf64Convert.h"\r
\r
//\r
// Result Coff file in memory.\r
//\r
UINT8 *mCoffFile = NULL;\r
\r
//\r
// COFF relocation data\r
//\r
EFI_IMAGE_BASE_RELOCATION *mCoffBaseRel;\r
UINT16                    *mCoffEntryRel;\r
\r
//\r
// Current offset in coff file.\r
//\r
UINT32 mCoffOffset;\r
\r
//\r
// Offset in Coff file of headers and sections.\r
//\r
UINT32 mTableOffset;\r
\r
//\r
//*****************************************************************************\r
// Common ELF Functions\r
//*****************************************************************************\r
//\r
\r
VOID\r
CoffAddFixupEntry(\r
  UINT16 Val\r
  )\r
{\r
  *mCoffEntryRel = Val;\r
  mCoffEntryRel++;\r
  mCoffBaseRel->SizeOfBlock += 2;\r
  mCoffOffset += 2;\r
}\r
\r
VOID\r
CoffAddFixup(\r
  UINT32 Offset,\r
  UINT8  Type\r
  )\r
{\r
  if (mCoffBaseRel == NULL\r
      || mCoffBaseRel->VirtualAddress != (Offset & ~0xfff)) {\r
    if (mCoffBaseRel != NULL) {\r
      //\r
      // Add a null entry (is it required ?)\r
      //\r
      CoffAddFixupEntry (0);\r
      \r
      //\r
      // Pad for alignment.\r
      //\r
      if (mCoffOffset % 4 != 0)\r
        CoffAddFixupEntry (0);\r
    }\r
\r
    mCoffFile = realloc (\r
      mCoffFile,\r
      mCoffOffset + sizeof(EFI_IMAGE_BASE_RELOCATION) + 2 * MAX_COFF_ALIGNMENT\r
      );\r
    if (mCoffFile == NULL) {\r
      Error (NULL, 0, 4001, "Resource", "memory cannot be allocated!");\r
    }\r
    assert (mCoffFile != NULL);\r
    memset (\r
      mCoffFile + mCoffOffset, 0,\r
      sizeof(EFI_IMAGE_BASE_RELOCATION) + 2 * MAX_COFF_ALIGNMENT\r
      );\r
\r
    mCoffBaseRel = (EFI_IMAGE_BASE_RELOCATION*)(mCoffFile + mCoffOffset);\r
    mCoffBaseRel->VirtualAddress = Offset & ~0xfff;\r
    mCoffBaseRel->SizeOfBlock = sizeof(EFI_IMAGE_BASE_RELOCATION);\r
\r
    mCoffEntryRel = (UINT16 *)(mCoffBaseRel + 1);\r
    mCoffOffset += sizeof(EFI_IMAGE_BASE_RELOCATION);\r
  }\r
\r
  //\r
  // Fill the entry.\r
  //\r
  CoffAddFixupEntry((UINT16) ((Type << 12) | (Offset & 0xfff)));\r
}\r
\r
VOID\r
CreateSectionHeader (\r
  const CHAR8 *Name,\r
  UINT32      Offset,\r
  UINT32      Size,\r
  UINT32      Flags\r
  )\r
{\r
  EFI_IMAGE_SECTION_HEADER *Hdr;\r
  Hdr = (EFI_IMAGE_SECTION_HEADER*)(mCoffFile + mTableOffset);\r
\r
  strcpy((char *)Hdr->Name, Name);\r
  Hdr->Misc.VirtualSize = Size;\r
  Hdr->VirtualAddress = Offset;\r
  Hdr->SizeOfRawData = Size;\r
  Hdr->PointerToRawData = Offset;\r
  Hdr->PointerToRelocations = 0;\r
  Hdr->PointerToLinenumbers = 0;\r
  Hdr->NumberOfRelocations = 0;\r
  Hdr->NumberOfLinenumbers = 0;\r
  Hdr->Characteristics = Flags;\r
\r
  mTableOffset += sizeof (EFI_IMAGE_SECTION_HEADER);\r
}\r
\r
//\r
//*****************************************************************************\r
// Functions called from GenFw main code.\r
//*****************************************************************************\r
//\r
\r
INTN\r
IsElfHeader (\r
  UINT8  *FileBuffer\r
)\r
{\r
  return (FileBuffer[EI_MAG0] == ELFMAG0 && \r
          FileBuffer[EI_MAG1] == ELFMAG1 &&\r
          FileBuffer[EI_MAG2] == ELFMAG2 &&\r
          FileBuffer[EI_MAG3] == ELFMAG3);\r
}\r
\r
BOOLEAN\r
ConvertElf (\r
  UINT8  **FileBuffer,\r
  UINT32 *FileLength\r
  )\r
{\r
  ELF_FUNCTION_TABLE              ElfFunctions;\r
  UINT8                           EiClass;\r
\r
  //\r
  // Determine ELF type and set function table pointer correctly.\r
  //\r
  VerboseMsg ("Check Elf Image Header");\r
  EiClass = (*FileBuffer)[EI_CLASS];\r
  if (EiClass == ELFCLASS32) {\r
    if (!InitializeElf32 (*FileBuffer, &ElfFunctions)) {\r
      return FALSE;\r
    }\r
  } else if (EiClass == ELFCLASS64) {\r
    if (!InitializeElf64 (*FileBuffer, &ElfFunctions)) {\r
      return FALSE;\r
    }\r
  } else {\r
    Error (NULL, 0, 3000, "Unsupported", "ELF EI_CLASS not supported.");\r
    return FALSE;\r
  }\r
\r
  //\r
  // Compute sections new address.\r
  //  \r
  VerboseMsg ("Compute sections new address.");\r
  ElfFunctions.ScanSections ();\r
\r
  //\r
  // Write and relocate sections.\r
  //\r
  VerboseMsg ("Write and relocate sections.");\r
  ElfFunctions.WriteSections (SECTION_TEXT);\r
  ElfFunctions.WriteSections (SECTION_DATA);\r
  ElfFunctions.WriteSections (SECTION_HII);\r
\r
  //\r
  // Translate and write relocations.\r
  //\r
  VerboseMsg ("Translate and write relocations.");\r
  ElfFunctions.WriteRelocations ();\r
\r
  //\r
  // Write debug info.\r
  //\r
  VerboseMsg ("Write debug info.");\r
  ElfFunctions.WriteDebug ();\r
\r
  //\r
  // Make sure image size is correct before returning the new image.\r
  //\r
  VerboseMsg ("Set image size.");\r
  ElfFunctions.SetImageSize ();\r
\r
  //\r
  // Replace.\r
  //\r
  free (*FileBuffer);\r
  *FileBuffer = mCoffFile;\r
  *FileLength = mCoffOffset;\r
\r
  //\r
  // Free resources used by ELF functions.\r
  //\r
  ElfFunctions.CleanUp ();\r
  \r
  return TRUE;\r
}\r