BaseTools/Source/C/GenFw/Elf64Convert.c

   1 /** @file
   2
   3 Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
   4 Portions copyright (c) 2013-2014, ARM Ltd. All rights reserved.<BR>
   5
   6 This program and the accompanying materials are licensed and made available
   7 under the terms and conditions of the BSD License which accompanies this
   8 distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #include "WinNtInclude.h"
  17
  18 #ifndef __GNUC__
  19 #include <windows.h>
  20 #include <io.h>
  21 #endif
  22 #include <assert.h>
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <time.h>
  27 #include <ctype.h>
  28
  29 #include <Common/UefiBaseTypes.h>
  30 #include <IndustryStandard/PeImage.h>
  31
  32 #include "PeCoffLib.h"
  33 #include "EfiUtilityMsgs.h"
  34
  35 #include "GenFw.h"
  36 #include "ElfConvert.h"
  37 #include "Elf64Convert.h"
  38
  39 STATIC
  40 VOID
  41 ScanSections64 (
  42   VOID
  43   );
  44
  45 STATIC
  46 BOOLEAN
  47 WriteSections64 (
  48   SECTION_FILTER_TYPES  FilterType
  49   );
  50
  51 STATIC
  52 VOID
  53 WriteRelocations64 (
  54   VOID
  55   );
  56
  57 STATIC
  58 VOID
  59 WriteDebug64 (
  60   VOID
  61   );
  62
  63 STATIC
  64 VOID
  65 SetImageSize64 (
  66   VOID
  67   );
  68
  69 STATIC
  70 VOID
  71 CleanUp64 (
  72   VOID
  73   );
  74
  75 //
  76 // Rename ELF32 strucutres to common names to help when porting to ELF64.
  77 //
  78 typedef Elf64_Shdr Elf_Shdr;
  79 typedef Elf64_Ehdr Elf_Ehdr;
  80 typedef Elf64_Rel Elf_Rel;
  81 typedef Elf64_Rela Elf_Rela;
  82 typedef Elf64_Sym Elf_Sym;
  83 typedef Elf64_Phdr Elf_Phdr;
  84 typedef Elf64_Dyn Elf_Dyn;
  85 #define ELFCLASS ELFCLASS64
  86 #define ELF_R_TYPE(r) ELF64_R_TYPE(r)
  87 #define ELF_R_SYM(r) ELF64_R_SYM(r)
  88
  89 //
  90 // Well known ELF structures.
  91 //
  92 STATIC Elf_Ehdr *mEhdr;
  93 STATIC Elf_Shdr *mShdrBase;
  94 STATIC Elf_Phdr *mPhdrBase;
  95
  96 //
  97 // Coff information
  98 //
  99 STATIC const UINT32 mCoffAlignment = 0x20;
 100
 101 //
 102 // PE section alignment.
 103 //
 104 STATIC const UINT16 mCoffNbrSections = 5;
 105
 106 //
 107 // ELF sections to offset in Coff file.
 108 //
 109 STATIC UINT32 *mCoffSectionsOffset = NULL;
 110
 111 //
 112 // Offsets in COFF file
 113 //
 114 STATIC UINT32 mNtHdrOffset;
 115 STATIC UINT32 mTextOffset;
 116 STATIC UINT32 mDataOffset;
 117 STATIC UINT32 mHiiRsrcOffset;
 118 STATIC UINT32 mRelocOffset;
 119
 120 //
 121 // Initialization Function
 122 //
 123 BOOLEAN
 124 InitializeElf64 (
 125   UINT8               *FileBuffer,
 126   ELF_FUNCTION_TABLE  *ElfFunctions
 127   )
 128 {
 129   //
 130   // Initialize data pointer and structures.
 131   //
 132   VerboseMsg ("Set EHDR");
 133   mEhdr = (Elf_Ehdr*) FileBuffer;
 134
 135   //
 136   // Check the ELF64 specific header information.
 137   //
 138   VerboseMsg ("Check ELF64 Header Information");
 139   if (mEhdr->e_ident[EI_CLASS] != ELFCLASS64) {
 140     Error (NULL, 0, 3000, "Unsupported", "ELF EI_DATA not ELFCLASS64");
 141     return FALSE;
 142   }
 143   if (mEhdr->e_ident[EI_DATA] != ELFDATA2LSB) {
 144     Error (NULL, 0, 3000, "Unsupported", "ELF EI_DATA not ELFDATA2LSB");
 145     return FALSE;
 146   }
 147   if ((mEhdr->e_type != ET_EXEC) && (mEhdr->e_type != ET_DYN)) {
 148     Error (NULL, 0, 3000, "Unsupported", "ELF e_type not ET_EXEC or ET_DYN");
 149     return FALSE;
 150   }
 151   if (!((mEhdr->e_machine == EM_X86_64) || (mEhdr->e_machine == EM_AARCH64))) {
 152     Error (NULL, 0, 3000, "Unsupported", "ELF e_machine not EM_X86_64 or EM_AARCH64");
 153     return FALSE;
 154   }
 155   if (mEhdr->e_version != EV_CURRENT) {
 156     Error (NULL, 0, 3000, "Unsupported", "ELF e_version (%u) not EV_CURRENT (%d)", (unsigned) mEhdr->e_version, EV_CURRENT);
 157     return FALSE;
 158   }
 159
 160   //
 161   // Update section header pointers
 162   //
 163   VerboseMsg ("Update Header Pointers");
 164   mShdrBase  = (Elf_Shdr *)((UINT8 *)mEhdr + mEhdr->e_shoff);
 165   mPhdrBase = (Elf_Phdr *)((UINT8 *)mEhdr + mEhdr->e_phoff);
 166
 167   //
 168   // Create COFF Section offset buffer and zero.
 169   //
 170   VerboseMsg ("Create COFF Section Offset Buffer");
 171   mCoffSectionsOffset = (UINT32 *)malloc(mEhdr->e_shnum * sizeof (UINT32));
 172   memset(mCoffSectionsOffset, 0, mEhdr->e_shnum * sizeof(UINT32));
 173
 174   //
 175   // Fill in function pointers.
 176   //
 177   VerboseMsg ("Fill in Function Pointers");
 178   ElfFunctions->ScanSections = ScanSections64;
 179   ElfFunctions->WriteSections = WriteSections64;
 180   ElfFunctions->WriteRelocations = WriteRelocations64;
 181   ElfFunctions->WriteDebug = WriteDebug64;
 182   ElfFunctions->SetImageSize = SetImageSize64;
 183   ElfFunctions->CleanUp = CleanUp64;
 184
 185   return TRUE;
 186 }
 187
 188
 189 //
 190 // Header by Index functions
 191 //
 192 STATIC
 193 Elf_Shdr*
 194 GetShdrByIndex (
 195   UINT32 Num
 196   )
 197 {
 198   if (Num >= mEhdr->e_shnum)
 199     return NULL;
 200   return (Elf_Shdr*)((UINT8*)mShdrBase + Num * mEhdr->e_shentsize);
 201 }
 202
 203 STATIC
 204 UINT32
 205 CoffAlign (
 206   UINT32 Offset
 207   )
 208 {
 209   return (Offset + mCoffAlignment - 1) & ~(mCoffAlignment - 1);
 210 }
 211
 212 //
 213 // filter functions
 214 //
 215 STATIC
 216 BOOLEAN
 217 IsTextShdr (
 218   Elf_Shdr *Shdr
 219   )
 220 {
 221   return (BOOLEAN) ((Shdr->sh_flags & (SHF_WRITE | SHF_ALLOC)) == SHF_ALLOC);
 222 }
 223
 224 STATIC
 225 BOOLEAN
 226 IsHiiRsrcShdr (
 227   Elf_Shdr *Shdr
 228   )
 229 {
 230   Elf_Shdr *Namedr = GetShdrByIndex(mEhdr->e_shstrndx);
 231
 232   return (BOOLEAN) (strcmp((CHAR8*)mEhdr + Namedr->sh_offset + Shdr->sh_name, ELF_HII_SECTION_NAME) == 0);
 233 }
 234
 235 STATIC
 236 BOOLEAN
 237 IsDataShdr (
 238   Elf_Shdr *Shdr
 239   )
 240 {
 241   if (IsHiiRsrcShdr(Shdr)) {
 242     return FALSE;
 243   }
 244   return (BOOLEAN) (Shdr->sh_flags & (SHF_WRITE | SHF_ALLOC)) == (SHF_ALLOC | SHF_WRITE);
 245 }
 246
 247 //
 248 // Elf functions interface implementation
 249 //
 250
 251 STATIC
 252 VOID
 253 ScanSections64 (
 254   VOID
 255   )
 256 {
 257   UINT32                          i;
 258   EFI_IMAGE_DOS_HEADER            *DosHdr;
 259   EFI_IMAGE_OPTIONAL_HEADER_UNION *NtHdr;
 260   UINT32                          CoffEntry;
 261   UINT32                          SectionCount;
 262   BOOLEAN                         FoundText;
 263
 264   CoffEntry = 0;
 265   mCoffOffset = 0;
 266   mTextOffset = 0;
 267   FoundText = FALSE;
 268
 269   //
 270   // Coff file start with a DOS header.
 271   //
 272   mCoffOffset = sizeof(EFI_IMAGE_DOS_HEADER) + 0x40;
 273   mNtHdrOffset = mCoffOffset;
 274   switch (mEhdr->e_machine) {
 275   case EM_X86_64:
 276   case EM_IA_64:
 277   case EM_AARCH64:
 278     mCoffOffset += sizeof (EFI_IMAGE_NT_HEADERS64);
 279   break;
 280   default:
 281     VerboseMsg ("%s unknown e_machine type. Assume X64", (UINTN)mEhdr->e_machine);
 282     mCoffOffset += sizeof (EFI_IMAGE_NT_HEADERS64);
 283   break;
 284   }
 285
 286   mTableOffset = mCoffOffset;
 287   mCoffOffset += mCoffNbrSections * sizeof(EFI_IMAGE_SECTION_HEADER);
 288
 289   //
 290   // First text sections.
 291   //
 292   mCoffOffset = CoffAlign(mCoffOffset);
 293   SectionCount = 0;
 294   for (i = 0; i < mEhdr->e_shnum; i++) {
 295     Elf_Shdr *shdr = GetShdrByIndex(i);
 296     if (IsTextShdr(shdr)) {
 297       if ((shdr->sh_addralign != 0) && (shdr->sh_addralign != 1)) {
 298         // the alignment field is valid
 299         if ((shdr->sh_addr & (shdr->sh_addralign - 1)) == 0) {
 300           // if the section address is aligned we must align PE/COFF
 301           mCoffOffset = (UINT32) ((mCoffOffset + shdr->sh_addralign - 1) & ~(shdr->sh_addralign - 1));
 302         } else if ((shdr->sh_addr % shdr->sh_addralign) != (mCoffOffset % shdr->sh_addralign)) {
 303           // ARM RVCT tools have behavior outside of the ELF specification to try
 304           // and make images smaller.  If sh_addr is not aligned to sh_addralign
 305           // then the section needs to preserve sh_addr MOD sh_addralign.
 306           // Normally doing nothing here works great.
 307           Error (NULL, 0, 3000, "Invalid", "Unsupported section alignment.");
 308         }
 309       }
 310
 311       /* Relocate entry.  */
 312       if ((mEhdr->e_entry >= shdr->sh_addr) &&
 313           (mEhdr->e_entry < shdr->sh_addr + shdr->sh_size)) {
 314         CoffEntry = (UINT32) (mCoffOffset + mEhdr->e_entry - shdr->sh_addr);
 315       }
 316
 317       //
 318       // Set mTextOffset with the offset of the first '.text' section
 319       //
 320       if (!FoundText) {
 321         mTextOffset = mCoffOffset;
 322         FoundText = TRUE;
 323       }
 324
 325       mCoffSectionsOffset[i] = mCoffOffset;
 326       mCoffOffset += (UINT32) shdr->sh_size;
 327       SectionCount ++;
 328     }
 329   }
 330
 331   if (!FoundText) {
 332     Error (NULL, 0, 3000, "Invalid", "Did not find any '.text' section.");
 333     assert (FALSE);
 334   }
 335
 336   if (mEhdr->e_machine != EM_ARM) {
 337     mCoffOffset = CoffAlign(mCoffOffset);
 338   }
 339
 340   if (SectionCount > 1 && mOutImageType == FW_EFI_IMAGE) {
 341     Warning (NULL, 0, 0, NULL, "Mulitple sections in %s are merged into 1 text section. Source level debug might not work correctly.", mInImageName);
 342   }
 343
 344   //
 345   //  Then data sections.
 346   //
 347   mDataOffset = mCoffOffset;
 348   SectionCount = 0;
 349   for (i = 0; i < mEhdr->e_shnum; i++) {
 350     Elf_Shdr *shdr = GetShdrByIndex(i);
 351     if (IsDataShdr(shdr)) {
 352       if ((shdr->sh_addralign != 0) && (shdr->sh_addralign != 1)) {
 353         // the alignment field is valid
 354         if ((shdr->sh_addr & (shdr->sh_addralign - 1)) == 0) {
 355           // if the section address is aligned we must align PE/COFF
 356           mCoffOffset = (UINT32) ((mCoffOffset + shdr->sh_addralign - 1) & ~(shdr->sh_addralign - 1));
 357         } else if ((shdr->sh_addr % shdr->sh_addralign) != (mCoffOffset % shdr->sh_addralign)) {
 358           // ARM RVCT tools have behavior outside of the ELF specification to try
 359           // and make images smaller.  If sh_addr is not aligned to sh_addralign
 360           // then the section needs to preserve sh_addr MOD sh_addralign.
 361           // Normally doing nothing here works great.
 362           Error (NULL, 0, 3000, "Invalid", "Unsupported section alignment.");
 363         }
 364       }
 365       mCoffSectionsOffset[i] = mCoffOffset;
 366       mCoffOffset += (UINT32) shdr->sh_size;
 367       SectionCount ++;
 368     }
 369   }
 370   mCoffOffset = CoffAlign(mCoffOffset);
 371
 372   if (SectionCount > 1 && mOutImageType == FW_EFI_IMAGE) {
 373     Warning (NULL, 0, 0, NULL, "Mulitple sections in %s are merged into 1 data section. Source level debug might not work correctly.", mInImageName);
 374   }
 375
 376   //
 377   //  The HII resource sections.
 378   //
 379   mHiiRsrcOffset = mCoffOffset;
 380   for (i = 0; i < mEhdr->e_shnum; i++) {
 381     Elf_Shdr *shdr = GetShdrByIndex(i);
 382     if (IsHiiRsrcShdr(shdr)) {
 383       if ((shdr->sh_addralign != 0) && (shdr->sh_addralign != 1)) {
 384         // the alignment field is valid
 385         if ((shdr->sh_addr & (shdr->sh_addralign - 1)) == 0) {
 386           // if the section address is aligned we must align PE/COFF
 387           mCoffOffset = (UINT32) ((mCoffOffset + shdr->sh_addralign - 1) & ~(shdr->sh_addralign - 1));
 388         } else if ((shdr->sh_addr % shdr->sh_addralign) != (mCoffOffset % shdr->sh_addralign)) {
 389           // ARM RVCT tools have behavior outside of the ELF specification to try
 390           // and make images smaller.  If sh_addr is not aligned to sh_addralign
 391           // then the section needs to preserve sh_addr MOD sh_addralign.
 392           // Normally doing nothing here works great.
 393           Error (NULL, 0, 3000, "Invalid", "Unsupported section alignment.");
 394         }
 395       }
 396       if (shdr->sh_size != 0) {
 397         mCoffSectionsOffset[i] = mCoffOffset;
 398         mCoffOffset += (UINT32) shdr->sh_size;
 399         mCoffOffset = CoffAlign(mCoffOffset);
 400         SetHiiResourceHeader ((UINT8*) mEhdr + shdr->sh_offset, mHiiRsrcOffset);
 401       }
 402       break;
 403     }
 404   }
 405
 406   mRelocOffset = mCoffOffset;
 407
 408   //
 409   // Allocate base Coff file.  Will be expanded later for relocations.
 410   //
 411   mCoffFile = (UINT8 *)malloc(mCoffOffset);
 412   memset(mCoffFile, 0, mCoffOffset);
 413
 414   //
 415   // Fill headers.
 416   //
 417   DosHdr = (EFI_IMAGE_DOS_HEADER *)mCoffFile;
 418   DosHdr->e_magic = EFI_IMAGE_DOS_SIGNATURE;
 419   DosHdr->e_lfanew = mNtHdrOffset;
 420
 421   NtHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION*)(mCoffFile + mNtHdrOffset);
 422
 423   NtHdr->Pe32Plus.Signature = EFI_IMAGE_NT_SIGNATURE;
 424
 425   switch (mEhdr->e_machine) {
 426   case EM_X86_64:
 427     NtHdr->Pe32Plus.FileHeader.Machine = EFI_IMAGE_MACHINE_X64;
 428     NtHdr->Pe32Plus.OptionalHeader.Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;
 429     break;
 430   case EM_IA_64:
 431     NtHdr->Pe32Plus.FileHeader.Machine = EFI_IMAGE_MACHINE_IPF;
 432     NtHdr->Pe32Plus.OptionalHeader.Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;
 433     break;
 434   case EM_AARCH64:
 435     NtHdr->Pe32Plus.FileHeader.Machine = EFI_IMAGE_MACHINE_AARCH64;
 436     NtHdr->Pe32Plus.OptionalHeader.Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;
 437     break;
 438   default:
 439     VerboseMsg ("%s unknown e_machine type. Assume X64", (UINTN)mEhdr->e_machine);
 440     NtHdr->Pe32Plus.FileHeader.Machine = EFI_IMAGE_MACHINE_X64;
 441     NtHdr->Pe32Plus.OptionalHeader.Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;
 442   }
 443
 444   NtHdr->Pe32Plus.FileHeader.NumberOfSections = mCoffNbrSections;
 445   NtHdr->Pe32Plus.FileHeader.TimeDateStamp = (UINT32) time(NULL);
 446   mImageTimeStamp = NtHdr->Pe32Plus.FileHeader.TimeDateStamp;
 447   NtHdr->Pe32Plus.FileHeader.PointerToSymbolTable = 0;
 448   NtHdr->Pe32Plus.FileHeader.NumberOfSymbols = 0;
 449   NtHdr->Pe32Plus.FileHeader.SizeOfOptionalHeader = sizeof(NtHdr->Pe32Plus.OptionalHeader);
 450   NtHdr->Pe32Plus.FileHeader.Characteristics = EFI_IMAGE_FILE_EXECUTABLE_IMAGE
 451     | EFI_IMAGE_FILE_LINE_NUMS_STRIPPED
 452     | EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED
 453     | EFI_IMAGE_FILE_LARGE_ADDRESS_AWARE;
 454
 455   NtHdr->Pe32Plus.OptionalHeader.SizeOfCode = mDataOffset - mTextOffset;
 456   NtHdr->Pe32Plus.OptionalHeader.SizeOfInitializedData = mRelocOffset - mDataOffset;
 457   NtHdr->Pe32Plus.OptionalHeader.SizeOfUninitializedData = 0;
 458   NtHdr->Pe32Plus.OptionalHeader.AddressOfEntryPoint = CoffEntry;
 459
 460   NtHdr->Pe32Plus.OptionalHeader.BaseOfCode = mTextOffset;
 461
 462   NtHdr->Pe32Plus.OptionalHeader.ImageBase = 0;
 463   NtHdr->Pe32Plus.OptionalHeader.SectionAlignment = mCoffAlignment;
 464   NtHdr->Pe32Plus.OptionalHeader.FileAlignment = mCoffAlignment;
 465   NtHdr->Pe32Plus.OptionalHeader.SizeOfImage = 0;
 466
 467   NtHdr->Pe32Plus.OptionalHeader.SizeOfHeaders = mTextOffset;
 468   NtHdr->Pe32Plus.OptionalHeader.NumberOfRvaAndSizes = EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES;
 469
 470   //
 471   // Section headers.
 472   //
 473   if ((mDataOffset - mTextOffset) > 0) {
 474     CreateSectionHeader (".text", mTextOffset, mDataOffset - mTextOffset,
 475             EFI_IMAGE_SCN_CNT_CODE
 476             | EFI_IMAGE_SCN_MEM_EXECUTE
 477             | EFI_IMAGE_SCN_MEM_READ);
 478   } else {
 479     // Don't make a section of size 0.
 480     NtHdr->Pe32Plus.FileHeader.NumberOfSections--;
 481   }
 482
 483   if ((mHiiRsrcOffset - mDataOffset) > 0) {
 484     CreateSectionHeader (".data", mDataOffset, mHiiRsrcOffset - mDataOffset,
 485             EFI_IMAGE_SCN_CNT_INITIALIZED_DATA
 486             | EFI_IMAGE_SCN_MEM_WRITE
 487             | EFI_IMAGE_SCN_MEM_READ);
 488   } else {
 489     // Don't make a section of size 0.
 490     NtHdr->Pe32Plus.FileHeader.NumberOfSections--;
 491   }
 492
 493   if ((mRelocOffset - mHiiRsrcOffset) > 0) {
 494     CreateSectionHeader (".rsrc", mHiiRsrcOffset, mRelocOffset - mHiiRsrcOffset,
 495             EFI_IMAGE_SCN_CNT_INITIALIZED_DATA
 496             | EFI_IMAGE_SCN_MEM_READ);
 497
 498     NtHdr->Pe32Plus.OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE].Size = mRelocOffset - mHiiRsrcOffset;
 499     NtHdr->Pe32Plus.OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE].VirtualAddress = mHiiRsrcOffset;
 500   } else {
 501     // Don't make a section of size 0.
 502     NtHdr->Pe32Plus.FileHeader.NumberOfSections--;
 503   }
 504
 505 }
 506
 507 STATIC
 508 BOOLEAN
 509 WriteSections64 (
 510   SECTION_FILTER_TYPES  FilterType
 511   )
 512 {
 513   UINT32      Idx;
 514   Elf_Shdr    *SecShdr;
 515   UINT32      SecOffset;
 516   BOOLEAN     (*Filter)(Elf_Shdr *);
 517
 518   //
 519   // Initialize filter pointer
 520   //
 521   switch (FilterType) {
 522     case SECTION_TEXT:
 523       Filter = IsTextShdr;
 524       break;
 525     case SECTION_HII:
 526       Filter = IsHiiRsrcShdr;
 527       break;
 528     case SECTION_DATA:
 529       Filter = IsDataShdr;
 530       break;
 531     default:
 532       return FALSE;
 533   }
 534
 535   //
 536   // First: copy sections.
 537   //
 538   for (Idx = 0; Idx < mEhdr->e_shnum; Idx++) {
 539     Elf_Shdr *Shdr = GetShdrByIndex(Idx);
 540     if ((*Filter)(Shdr)) {
 541       switch (Shdr->sh_type) {
 542       case SHT_PROGBITS:
 543         /* Copy.  */
 544         memcpy(mCoffFile + mCoffSectionsOffset[Idx],
 545               (UINT8*)mEhdr + Shdr->sh_offset,
 546               (size_t) Shdr->sh_size);
 547         break;
 548
 549       case SHT_NOBITS:
 550         memset(mCoffFile + mCoffSectionsOffset[Idx], 0, (size_t) Shdr->sh_size);
 551         break;
 552
 553       default:
 554         //
 555         //  Ignore for unkown section type.
 556         //
 557         VerboseMsg ("%s unknown section type %x. We directly copy this section into Coff file", mInImageName, (unsigned)Shdr->sh_type);
 558         break;
 559       }
 560     }
 561   }
 562
 563   //
 564   // Second: apply relocations.
 565   //
 566   VerboseMsg ("Applying Relocations...");
 567   for (Idx = 0; Idx < mEhdr->e_shnum; Idx++) {
 568     //
 569     // Determine if this is a relocation section.
 570     //
 571     Elf_Shdr *RelShdr = GetShdrByIndex(Idx);
 572     if ((RelShdr->sh_type != SHT_REL) && (RelShdr->sh_type != SHT_RELA)) {
 573       continue;
 574     }
 575
 576     //
 577     // Relocation section found.  Now extract section information that the relocations
 578     // apply to in the ELF data and the new COFF data.
 579     //
 580     SecShdr = GetShdrByIndex(RelShdr->sh_info);
 581     SecOffset = mCoffSectionsOffset[RelShdr->sh_info];
 582
 583     //
 584     // Only process relocations for the current filter type.
 585     //
 586     if (RelShdr->sh_type == SHT_RELA && (*Filter)(SecShdr)) {
 587       UINT64 RelIdx;
 588
 589       //
 590       // Determine the symbol table referenced by the relocation data.
 591       //
 592       Elf_Shdr *SymtabShdr = GetShdrByIndex(RelShdr->sh_link);
 593       UINT8 *Symtab = (UINT8*)mEhdr + SymtabShdr->sh_offset;
 594
 595       //
 596       // Process all relocation entries for this section.
 597       //
 598       for (RelIdx = 0; RelIdx < RelShdr->sh_size; RelIdx += (UINT32) RelShdr->sh_entsize) {
 599
 600         //
 601         // Set pointer to relocation entry
 602         //
 603         Elf_Rela *Rel = (Elf_Rela *)((UINT8*)mEhdr + RelShdr->sh_offset + RelIdx);
 604
 605         //
 606         // Set pointer to symbol table entry associated with the relocation entry.
 607         //
 608         Elf_Sym  *Sym = (Elf_Sym *)(Symtab + ELF_R_SYM(Rel->r_info) * SymtabShdr->sh_entsize);
 609
 610         Elf_Shdr *SymShdr;
 611         UINT8    *Targ;
 612
 613         //
 614         // Check section header index found in symbol table and get the section
 615         // header location.
 616         //
 617         if (Sym->st_shndx == SHN_UNDEF
 618             || Sym->st_shndx == SHN_ABS
 619             || Sym->st_shndx > mEhdr->e_shnum) {
 620           Error (NULL, 0, 3000, "Invalid", "%s bad symbol definition.", mInImageName);
 621         }
 622         SymShdr = GetShdrByIndex(Sym->st_shndx);
 623
 624         //
 625         // Convert the relocation data to a pointer into the coff file.
 626         //
 627         // Note:
 628         //   r_offset is the virtual address of the storage unit to be relocated.
 629         //   sh_addr is the virtual address for the base of the section.
 630         //
 631         //   r_offset in a memory address.
 632         //   Convert it to a pointer in the coff file.
 633         //
 634         Targ = mCoffFile + SecOffset + (Rel->r_offset - SecShdr->sh_addr);
 635
 636         //
 637         // Determine how to handle each relocation type based on the machine type.
 638         //
 639         if (mEhdr->e_machine == EM_X86_64) {
 640           switch (ELF_R_TYPE(Rel->r_info)) {
 641           case R_X86_64_NONE:
 642             break;
 643           case R_X86_64_64:
 644             //
 645             // Absolute relocation.
 646             //
 647             VerboseMsg ("R_X86_64_64");
 648             VerboseMsg ("Offset: 0x%08X, Addend: 0x%016LX",
 649               (UINT32)(SecOffset + (Rel->r_offset - SecShdr->sh_addr)),
 650               *(UINT64 *)Targ);
 651             *(UINT64 *)Targ = *(UINT64 *)Targ - SymShdr->sh_addr + mCoffSectionsOffset[Sym->st_shndx];
 652             VerboseMsg ("Relocation:  0x%016LX", *(UINT64*)Targ);
 653             break;
 654           case R_X86_64_32:
 655             VerboseMsg ("R_X86_64_32");
 656             VerboseMsg ("Offset: 0x%08X, Addend: 0x%08X",
 657               (UINT32)(SecOffset + (Rel->r_offset - SecShdr->sh_addr)),
 658               *(UINT32 *)Targ);
 659             *(UINT32 *)Targ = (UINT32)((UINT64)(*(UINT32 *)Targ) - SymShdr->sh_addr + mCoffSectionsOffset[Sym->st_shndx]);
 660             VerboseMsg ("Relocation:  0x%08X", *(UINT32*)Targ);
 661             break;
 662           case R_X86_64_32S:
 663             VerboseMsg ("R_X86_64_32S");
 664             VerboseMsg ("Offset: 0x%08X, Addend: 0x%08X",
 665               (UINT32)(SecOffset + (Rel->r_offset - SecShdr->sh_addr)),
 666               *(UINT32 *)Targ);
 667             *(INT32 *)Targ = (INT32)((INT64)(*(INT32 *)Targ) - SymShdr->sh_addr + mCoffSectionsOffset[Sym->st_shndx]);
 668             VerboseMsg ("Relocation:  0x%08X", *(UINT32*)Targ);
 669             break;
 670           case R_X86_64_PC32:
 671             //
 672             // Relative relocation: Symbol - Ip + Addend
 673             //
 674             VerboseMsg ("R_X86_64_PC32");
 675             VerboseMsg ("Offset: 0x%08X, Addend: 0x%08X",
 676               (UINT32)(SecOffset + (Rel->r_offset - SecShdr->sh_addr)),
 677               *(UINT32 *)Targ);
 678             *(UINT32 *)Targ = (UINT32) (*(UINT32 *)Targ
 679               + (mCoffSectionsOffset[Sym->st_shndx] - SymShdr->sh_addr)
 680               - (SecOffset - SecShdr->sh_addr));
 681             VerboseMsg ("Relocation:  0x%08X", *(UINT32 *)Targ);
 682             break;
 683           default:
 684             Error (NULL, 0, 3000, "Invalid", "%s unsupported ELF EM_X86_64 relocation 0x%x.", mInImageName, (unsigned) ELF_R_TYPE(Rel->r_info));
 685           }
 686         } else if (mEhdr->e_machine == EM_AARCH64) {
 687
 688           // AARCH64 GCC uses RELA relocation, so all relocations have to be fixed up.
 689           // As opposed to ARM32 using REL.
 690
 691           switch (ELF_R_TYPE(Rel->r_info)) {
 692
 693           case R_AARCH64_ADR_PREL_LO21:
 694             if  (Rel->r_addend != 0 ) { /* TODO */
 695               Error (NULL, 0, 3000, "Invalid", "AArch64: R_AARCH64_ADR_PREL_LO21 Need to fixup with addend!.");
 696             }
 697             break;
 698
 699           case R_AARCH64_CONDBR19:
 700             if  (Rel->r_addend != 0 ) { /* TODO */
 701               Error (NULL, 0, 3000, "Invalid", "AArch64: R_AARCH64_CONDBR19 Need to fixup with addend!.");
 702             }
 703             break;
 704
 705           case R_AARCH64_LD_PREL_LO19:
 706             if  (Rel->r_addend != 0 ) { /* TODO */
 707               Error (NULL, 0, 3000, "Invalid", "AArch64: R_AARCH64_LD_PREL_LO19 Need to fixup with addend!.");
 708             }
 709             break;
 710
 711           case R_AARCH64_CALL26:
 712             if  (Rel->r_addend != 0 ) { /* TODO */
 713               Error (NULL, 0, 3000, "Invalid", "AArch64: R_AARCH64_CALL26 Need to fixup with addend!.");
 714             }
 715             break;
 716
 717           case R_AARCH64_JUMP26:
 718             if  (Rel->r_addend != 0 ) { /* TODO : AArch64 '-O2' optimisation. */
 719               Error (NULL, 0, 3000, "Invalid", "AArch64: R_AARCH64_JUMP26 Need to fixup with addend!.");
 720             }
 721             break;
 722
 723           case R_AARCH64_ADR_PREL_PG_HI21:
 724             // TODO : AArch64 'small' memory model.
 725             Error (NULL, 0, 3000, "Invalid", "WriteSections64(): %s unsupported ELF EM_AARCH64 relocation R_AARCH64_ADR_PREL_PG_HI21.", mInImageName);
 726             break;
 727
 728           case R_AARCH64_ADD_ABS_LO12_NC:
 729             // TODO : AArch64 'small' memory model.
 730             Error (NULL, 0, 3000, "Invalid", "WriteSections64(): %s unsupported ELF EM_AARCH64 relocation R_AARCH64_ADD_ABS_LO12_NC.", mInImageName);
 731             break;
 732
 733           // Absolute relocations.
 734           case R_AARCH64_ABS64:
 735             *(UINT64 *)Targ = *(UINT64 *)Targ - SymShdr->sh_addr + mCoffSectionsOffset[Sym->st_shndx];
 736             break;
 737
 738           default:
 739             Error (NULL, 0, 3000, "Invalid", "WriteSections64(): %s unsupported ELF EM_AARCH64 relocation 0x%x.", mInImageName, (unsigned) ELF_R_TYPE(Rel->r_info));
 740           }
 741         } else {
 742           Error (NULL, 0, 3000, "Invalid", "Not a supported machine type");
 743         }
 744       }
 745     }
 746   }
 747
 748   return TRUE;
 749 }
 750
 751 STATIC
 752 VOID
 753 WriteRelocations64 (
 754   VOID
 755   )
 756 {
 757   UINT32                           Index;
 758   EFI_IMAGE_OPTIONAL_HEADER_UNION  *NtHdr;
 759   EFI_IMAGE_DATA_DIRECTORY         *Dir;
 760
 761   for (Index = 0; Index < mEhdr->e_shnum; Index++) {
 762     Elf_Shdr *RelShdr = GetShdrByIndex(Index);
 763     if ((RelShdr->sh_type == SHT_REL) || (RelShdr->sh_type == SHT_RELA)) {
 764       Elf_Shdr *SecShdr = GetShdrByIndex (RelShdr->sh_info);
 765       if (IsTextShdr(SecShdr) || IsDataShdr(SecShdr)) {
 766         UINT64 RelIdx;
 767
 768         for (RelIdx = 0; RelIdx < RelShdr->sh_size; RelIdx += RelShdr->sh_entsize) {
 769           Elf_Rela *Rel = (Elf_Rela *)((UINT8*)mEhdr + RelShdr->sh_offset + RelIdx);
 770
 771           if (mEhdr->e_machine == EM_X86_64) {
 772             switch (ELF_R_TYPE(Rel->r_info)) {
 773             case R_X86_64_NONE:
 774             case R_X86_64_PC32:
 775               break;
 776             case R_X86_64_64:
 777               VerboseMsg ("EFI_IMAGE_REL_BASED_DIR64 Offset: 0x%08X",
 778                 mCoffSectionsOffset[RelShdr->sh_info] + (Rel->r_offset - SecShdr->sh_addr));
 779               CoffAddFixup(
 780                 (UINT32) ((UINT64) mCoffSectionsOffset[RelShdr->sh_info]
 781                 + (Rel->r_offset - SecShdr->sh_addr)),
 782                 EFI_IMAGE_REL_BASED_DIR64);
 783               break;
 784             case R_X86_64_32S:
 785             case R_X86_64_32:
 786               VerboseMsg ("EFI_IMAGE_REL_BASED_HIGHLOW Offset: 0x%08X",
 787                 mCoffSectionsOffset[RelShdr->sh_info] + (Rel->r_offset - SecShdr->sh_addr));
 788               CoffAddFixup(
 789                 (UINT32) ((UINT64) mCoffSectionsOffset[RelShdr->sh_info]
 790                 + (Rel->r_offset - SecShdr->sh_addr)),
 791                 EFI_IMAGE_REL_BASED_HIGHLOW);
 792               break;
 793             default:
 794               Error (NULL, 0, 3000, "Invalid", "%s unsupported ELF EM_X86_64 relocation 0x%x.", mInImageName, (unsigned) ELF_R_TYPE(Rel->r_info));
 795             }
 796           } else if (mEhdr->e_machine == EM_AARCH64) {
 797             // AArch64 GCC uses RELA relocation, so all relocations has to be fixed up. ARM32 uses REL.
 798             switch (ELF_R_TYPE(Rel->r_info)) {
 799             case R_AARCH64_ADR_PREL_LO21:
 800               break;
 801
 802             case R_AARCH64_CONDBR19:
 803               break;
 804
 805             case R_AARCH64_LD_PREL_LO19:
 806               break;
 807
 808             case R_AARCH64_CALL26:
 809               break;
 810
 811             case R_AARCH64_JUMP26:
 812               break;
 813
 814             case R_AARCH64_ADR_PREL_PG_HI21:
 815               // TODO : AArch64 'small' memory model.
 816               Error (NULL, 0, 3000, "Invalid", "WriteRelocations64(): %s unsupported ELF EM_AARCH64 relocation R_AARCH64_ADR_PREL_PG_HI21.", mInImageName);
 817               break;
 818
 819             case R_AARCH64_ADD_ABS_LO12_NC:
 820               // TODO : AArch64 'small' memory model.
 821               Error (NULL, 0, 3000, "Invalid", "WriteRelocations64(): %s unsupported ELF EM_AARCH64 relocation R_AARCH64_ADD_ABS_LO12_NC.", mInImageName);
 822               break;
 823
 824             case R_AARCH64_ABS64:
 825               CoffAddFixup(
 826                 (UINT32) ((UINT64) mCoffSectionsOffset[RelShdr->sh_info]
 827                 + (Rel->r_offset - SecShdr->sh_addr)),
 828                 EFI_IMAGE_REL_BASED_DIR64);
 829               break;
 830
 831             case R_AARCH64_ABS32:
 832               CoffAddFixup(
 833                 (UINT32) ((UINT64) mCoffSectionsOffset[RelShdr->sh_info]
 834                 + (Rel->r_offset - SecShdr->sh_addr)),
 835                 EFI_IMAGE_REL_BASED_HIGHLOW);
 836              break;
 837
 838             default:
 839                 Error (NULL, 0, 3000, "Invalid", "WriteRelocations64(): %s unsupported ELF EM_AARCH64 relocation 0x%x.", mInImageName, (unsigned) ELF_R_TYPE(Rel->r_info));
 840             }
 841           } else {
 842             Error (NULL, 0, 3000, "Not Supported", "This tool does not support relocations for ELF with e_machine %u (processor type).", (unsigned) mEhdr->e_machine);
 843           }
 844         }
 845       }
 846     }
 847   }
 848
 849   //
 850   // Pad by adding empty entries.
 851   //
 852   while (mCoffOffset & (mCoffAlignment - 1)) {
 853     CoffAddFixupEntry(0);
 854   }
 855
 856   NtHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION *)(mCoffFile + mNtHdrOffset);
 857   Dir = &NtHdr->Pe32Plus.OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];
 858   Dir->Size = mCoffOffset - mRelocOffset;
 859   if (Dir->Size == 0) {
 860     // If no relocations, null out the directory entry and don't add the .reloc section
 861     Dir->VirtualAddress = 0;
 862     NtHdr->Pe32Plus.FileHeader.NumberOfSections--;
 863   } else {
 864     Dir->VirtualAddress = mRelocOffset;
 865     CreateSectionHeader (".reloc", mRelocOffset, mCoffOffset - mRelocOffset,
 866             EFI_IMAGE_SCN_CNT_INITIALIZED_DATA
 867             | EFI_IMAGE_SCN_MEM_DISCARDABLE
 868             | EFI_IMAGE_SCN_MEM_READ);
 869   }
 870 }
 871
 872 STATIC
 873 VOID
 874 WriteDebug64 (
 875   VOID
 876   )
 877 {
 878   UINT32                              Len;
 879   UINT32                              DebugOffset;
 880   EFI_IMAGE_OPTIONAL_HEADER_UNION     *NtHdr;
 881   EFI_IMAGE_DATA_DIRECTORY            *DataDir;
 882   EFI_IMAGE_DEBUG_DIRECTORY_ENTRY     *Dir;
 883   EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY *Nb10;
 884
 885   Len = strlen(mInImageName) + 1;
 886   DebugOffset = mCoffOffset;
 887
 888   mCoffOffset += sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY)
 889     + sizeof(EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY)
 890     + Len;
 891   mCoffOffset = CoffAlign(mCoffOffset);
 892
 893   mCoffFile = realloc(mCoffFile, mCoffOffset);
 894   memset(mCoffFile + DebugOffset, 0, mCoffOffset - DebugOffset);
 895
 896   Dir = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY*)(mCoffFile + DebugOffset);
 897   Dir->Type = EFI_IMAGE_DEBUG_TYPE_CODEVIEW;
 898   Dir->SizeOfData = sizeof(EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY) + Len;
 899   Dir->RVA = DebugOffset + sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);
 900   Dir->FileOffset = DebugOffset + sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);
 901
 902   Nb10 = (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY*)(Dir + 1);
 903   Nb10->Signature = CODEVIEW_SIGNATURE_NB10;
 904   strcpy ((char *)(Nb10 + 1), mInImageName);
 905
 906
 907   NtHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION *)(mCoffFile + mNtHdrOffset);
 908   DataDir = &NtHdr->Pe32Plus.OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG];
 909   DataDir->VirtualAddress = DebugOffset;
 910   DataDir->Size = mCoffOffset - DebugOffset;
 911   if (DataDir->Size == 0) {
 912     // If no debug, null out the directory entry and don't add the .debug section
 913     DataDir->VirtualAddress = 0;
 914     NtHdr->Pe32Plus.FileHeader.NumberOfSections--;
 915   } else {
 916     DataDir->VirtualAddress = DebugOffset;
 917     CreateSectionHeader (".debug", DebugOffset, mCoffOffset - DebugOffset,
 918             EFI_IMAGE_SCN_CNT_INITIALIZED_DATA
 919             | EFI_IMAGE_SCN_MEM_DISCARDABLE
 920             | EFI_IMAGE_SCN_MEM_READ);
 921
 922   }
 923 }
 924
 925 STATIC
 926 VOID
 927 SetImageSize64 (
 928   VOID
 929   )
 930 {
 931   EFI_IMAGE_OPTIONAL_HEADER_UNION *NtHdr;
 932
 933   //
 934   // Set image size
 935   //
 936   NtHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION *)(mCoffFile + mNtHdrOffset);
 937   NtHdr->Pe32Plus.OptionalHeader.SizeOfImage = mCoffOffset;
 938 }
 939
 940 STATIC
 941 VOID
 942 CleanUp64 (
 943   VOID
 944   )
 945 {
 946   if (mCoffSectionsOffset != NULL) {
 947     free (mCoffSectionsOffset);
 948   }
 949 }
 950
 951