BaseTools/Source/C/GenFw/Elf64Convert.c

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