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 <stdbool.h>
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <time.h>
  29 #include <ctype.h>
  30
  31 #include <Common/UefiBaseTypes.h>
  32 #include <IndustryStandard/PeImage.h>
  33
  34 #include "PeCoffLib.h"
  35 #include "EfiUtilityMsgs.h"
  36
  37 #include "GenFw.h"
  38 #include "ElfConvert.h"
  39 #include "Elf64Convert.h"
  40
  41 STATIC
  42 VOID
  43 ScanSections64 (
  44   VOID
  45   );
  46
  47 STATIC
  48 BOOLEAN
  49 WriteSections64 (
  50   SECTION_FILTER_TYPES  FilterType
  51   );
  52
  53 STATIC
  54 VOID
  55 WriteRelocations64 (
  56   VOID
  57   );
  58
  59 STATIC
  60 VOID
  61 WriteDebug64 (
  62   VOID
  63   );
  64
  65 STATIC
  66 VOID
  67 SetImageSize64 (
  68   VOID
  69   );
  70
  71 STATIC
  72 VOID
  73 CleanUp64 (
  74   VOID
  75   );
  76
  77 //
  78 // Rename ELF32 strucutres to common names to help when porting to ELF64.
  79 //
  80 typedef Elf64_Shdr Elf_Shdr;
  81 typedef Elf64_Ehdr Elf_Ehdr;
  82 typedef Elf64_Rel Elf_Rel;
  83 typedef Elf64_Rela Elf_Rela;
  84 typedef Elf64_Sym Elf_Sym;
  85 typedef Elf64_Phdr Elf_Phdr;
  86 typedef Elf64_Dyn Elf_Dyn;
  87 #define ELFCLASS ELFCLASS64
  88 #define ELF_R_TYPE(r) ELF64_R_TYPE(r)
  89 #define ELF_R_SYM(r) ELF64_R_SYM(r)
  90
  91 //
  92 // Well known ELF structures.
  93 //
  94 STATIC Elf_Ehdr *mEhdr;
  95 STATIC Elf_Shdr *mShdrBase;
  96 STATIC Elf_Phdr *mPhdrBase;
  97
  98 //
  99 // Coff information
 100 //
 101 STATIC UINT32 mCoffAlignment = 0x20;
 102
 103 //
 104 // PE section alignment.
 105 //
 106 STATIC const UINT16 mCoffNbrSections = 4;
 107
 108 //
 109 // ELF sections to offset in Coff file.
 110 //
 111 STATIC UINT32 *mCoffSectionsOffset = NULL;
 112
 113 //
 114 // Offsets in COFF file
 115 //
 116 STATIC UINT32 mNtHdrOffset;
 117 STATIC UINT32 mTextOffset;
 118 STATIC UINT32 mDataOffset;
 119 STATIC UINT32 mHiiRsrcOffset;
 120 STATIC UINT32 mRelocOffset;
 121 STATIC UINT32 mDebugOffset;
 122
 123 //
 124 // Initialization Function
 125 //
 126 BOOLEAN
 127 InitializeElf64 (
 128   UINT8               *FileBuffer,
 129   ELF_FUNCTION_TABLE  *ElfFunctions
 130   )
 131 {
 132   //
 133   // Initialize data pointer and structures.
 134   //
 135   VerboseMsg ("Set EHDR");
 136   mEhdr = (Elf_Ehdr*) FileBuffer;
 137
 138   //
 139   // Check the ELF64 specific header information.
 140   //
 141   VerboseMsg ("Check ELF64 Header Information");
 142   if (mEhdr->e_ident[EI_CLASS] != ELFCLASS64) {
 143     Error (NULL, 0, 3000, "Unsupported", "ELF EI_DATA not ELFCLASS64");
 144     return FALSE;
 145   }
 146   if (mEhdr->e_ident[EI_DATA] != ELFDATA2LSB) {
 147     Error (NULL, 0, 3000, "Unsupported", "ELF EI_DATA not ELFDATA2LSB");
 148     return FALSE;
 149   }
 150   if ((mEhdr->e_type != ET_EXEC) && (mEhdr->e_type != ET_DYN)) {
 151     Error (NULL, 0, 3000, "Unsupported", "ELF e_type not ET_EXEC or ET_DYN");
 152     return FALSE;
 153   }
 154   if (!((mEhdr->e_machine == EM_X86_64) || (mEhdr->e_machine == EM_AARCH64))) {
 155     Error (NULL, 0, 3000, "Unsupported", "ELF e_machine not EM_X86_64 or EM_AARCH64");
 156     return FALSE;
 157   }
 158   if (mEhdr->e_version != EV_CURRENT) {
 159     Error (NULL, 0, 3000, "Unsupported", "ELF e_version (%u) not EV_CURRENT (%d)", (unsigned) mEhdr->e_version, EV_CURRENT);
 160     return FALSE;
 161   }
 162
 163   //
 164   // Update section header pointers
 165   //
 166   VerboseMsg ("Update Header Pointers");
 167   mShdrBase  = (Elf_Shdr *)((UINT8 *)mEhdr + mEhdr->e_shoff);
 168   mPhdrBase = (Elf_Phdr *)((UINT8 *)mEhdr + mEhdr->e_phoff);
 169
 170   //
 171   // Create COFF Section offset buffer and zero.
 172   //
 173   VerboseMsg ("Create COFF Section Offset Buffer");
 174   mCoffSectionsOffset = (UINT32 *)malloc(mEhdr->e_shnum * sizeof (UINT32));
 175   memset(mCoffSectionsOffset, 0, mEhdr->e_shnum * sizeof(UINT32));
 176
 177   //
 178   // Fill in function pointers.
 179   //
 180   VerboseMsg ("Fill in Function Pointers");
 181   ElfFunctions->ScanSections = ScanSections64;
 182   ElfFunctions->WriteSections = WriteSections64;
 183   ElfFunctions->WriteRelocations = WriteRelocations64;
 184   ElfFunctions->WriteDebug = WriteDebug64;
 185   ElfFunctions->SetImageSize = SetImageSize64;
 186   ElfFunctions->CleanUp = CleanUp64;
 187
 188   return TRUE;
 189 }
 190
 191
 192 //
 193 // Header by Index functions
 194 //
 195 STATIC
 196 Elf_Shdr*
 197 GetShdrByIndex (
 198   UINT32 Num
 199   )
 200 {
 201   if (Num >= mEhdr->e_shnum) {
 202     Error (NULL, 0, 3000, "Invalid", "GetShdrByIndex: Index %u is too high.", Num);
 203     exit(EXIT_FAILURE);
 204   }
 205
 206   return (Elf_Shdr*)((UINT8*)mShdrBase + Num * mEhdr->e_shentsize);
 207 }
 208
 209 STATIC
 210 UINT32
 211 CoffAlign (
 212   UINT32 Offset
 213   )
 214 {
 215   return (Offset + mCoffAlignment - 1) & ~(mCoffAlignment - 1);
 216 }
 217
 218 STATIC
 219 UINT32
 220 DebugRvaAlign (
 221   UINT32 Offset
 222   )
 223 {
 224   return (Offset + 3) & ~3;
 225 }
 226
 227 //
 228 // filter functions
 229 //
 230 STATIC
 231 BOOLEAN
 232 IsTextShdr (
 233   Elf_Shdr *Shdr
 234   )
 235 {
 236   return (BOOLEAN) ((Shdr->sh_flags & (SHF_WRITE | SHF_ALLOC)) == SHF_ALLOC);
 237 }
 238
 239 STATIC
 240 BOOLEAN
 241 IsHiiRsrcShdr (
 242   Elf_Shdr *Shdr
 243   )
 244 {
 245   Elf_Shdr *Namedr = GetShdrByIndex(mEhdr->e_shstrndx);
 246
 247   return (BOOLEAN) (strcmp((CHAR8*)mEhdr + Namedr->sh_offset + Shdr->sh_name, ELF_HII_SECTION_NAME) == 0);
 248 }
 249
 250 STATIC
 251 BOOLEAN
 252 IsDataShdr (
 253   Elf_Shdr *Shdr
 254   )
 255 {
 256   if (IsHiiRsrcShdr(Shdr)) {
 257     return FALSE;
 258   }
 259   return (BOOLEAN) (Shdr->sh_flags & (SHF_WRITE | SHF_ALLOC)) == (SHF_ALLOC | SHF_WRITE);
 260 }
 261
 262 STATIC
 263 BOOLEAN
 264 IsStrtabShdr (
 265   Elf_Shdr *Shdr
 266   )
 267 {
 268   Elf_Shdr *Namedr = GetShdrByIndex(mEhdr->e_shstrndx);
 269
 270   return (BOOLEAN) (strcmp((CHAR8*)mEhdr + Namedr->sh_offset + Shdr->sh_name, ELF_STRTAB_SECTION_NAME) == 0);
 271 }
 272
 273 STATIC
 274 Elf_Shdr *
 275 FindStrtabShdr (
 276   VOID
 277   )
 278 {
 279   UINT32 i;
 280   for (i = 0; i < mEhdr->e_shnum; i++) {
 281     Elf_Shdr *shdr = GetShdrByIndex(i);
 282     if (IsStrtabShdr(shdr)) {
 283       return shdr;
 284     }
 285   }
 286   return NULL;
 287 }
 288
 289 STATIC
 290 const UINT8 *
 291 GetSymName (
 292   Elf_Sym *Sym
 293   )
 294 {
 295   if (Sym->st_name == 0) {
 296     return NULL;
 297   }
 298
 299   Elf_Shdr *StrtabShdr = FindStrtabShdr();
 300   if (StrtabShdr == NULL) {
 301     return NULL;
 302   }
 303
 304   assert(Sym->st_name < StrtabShdr->sh_size);
 305
 306   UINT8* StrtabContents = (UINT8*)mEhdr + StrtabShdr->sh_offset;
 307
 308   bool foundEnd = false;
 309   UINT32 i;
 310   for (i= Sym->st_name; (i < StrtabShdr->sh_size) && !foundEnd; i++) {
 311     foundEnd = StrtabContents[i] == 0;
 312   }
 313   assert(foundEnd);
 314
 315   return StrtabContents + Sym->st_name;
 316 }
 317
 318 //
 319 // Elf functions interface implementation
 320 //
 321
 322 STATIC
 323 VOID
 324 ScanSections64 (
 325   VOID
 326   )
 327 {
 328   UINT32                          i;
 329   EFI_IMAGE_DOS_HEADER            *DosHdr;
 330   EFI_IMAGE_OPTIONAL_HEADER_UNION *NtHdr;
 331   UINT32                          CoffEntry;
 332   UINT32                          SectionCount;
 333   BOOLEAN                         FoundSection;
 334
 335   CoffEntry = 0;
 336   mCoffOffset = 0;
 337
 338   //
 339   // Coff file start with a DOS header.
 340   //
 341   mCoffOffset = sizeof(EFI_IMAGE_DOS_HEADER) + 0x40;
 342   mNtHdrOffset = mCoffOffset;
 343   switch (mEhdr->e_machine) {
 344   case EM_X86_64:
 345   case EM_IA_64:
 346   case EM_AARCH64:
 347     mCoffOffset += sizeof (EFI_IMAGE_NT_HEADERS64);
 348   break;
 349   default:
 350     VerboseMsg ("%s unknown e_machine type %hu. Assume X64", mInImageName, mEhdr->e_machine);
 351     mCoffOffset += sizeof (EFI_IMAGE_NT_HEADERS64);
 352   break;
 353   }
 354
 355   mTableOffset = mCoffOffset;
 356   mCoffOffset += mCoffNbrSections * sizeof(EFI_IMAGE_SECTION_HEADER);
 357
 358   //
 359   // Set mCoffAlignment to the maximum alignment of the input sections
 360   // we care about
 361   //
 362   for (i = 0; i < mEhdr->e_shnum; i++) {
 363     Elf_Shdr *shdr = GetShdrByIndex(i);
 364     if (shdr->sh_addralign <= mCoffAlignment) {
 365       continue;
 366     }
 367     if (IsTextShdr(shdr) || IsDataShdr(shdr) || IsHiiRsrcShdr(shdr)) {
 368       mCoffAlignment = (UINT32)shdr->sh_addralign;
 369     }
 370   }
 371
 372   //
 373   // Move the PE/COFF header right before the first section. This will help us
 374   // save space when converting to TE.
 375   //
 376   if (mCoffAlignment > mCoffOffset) {
 377     mNtHdrOffset += mCoffAlignment - mCoffOffset;
 378     mTableOffset += mCoffAlignment - mCoffOffset;
 379     mCoffOffset = mCoffAlignment;
 380   }
 381
 382   //
 383   // First text sections.
 384   //
 385   mCoffOffset = CoffAlign(mCoffOffset);
 386   mTextOffset = mCoffOffset;
 387   FoundSection = FALSE;
 388   SectionCount = 0;
 389   for (i = 0; i < mEhdr->e_shnum; i++) {
 390     Elf_Shdr *shdr = GetShdrByIndex(i);
 391     if (IsTextShdr(shdr)) {
 392       if ((shdr->sh_addralign != 0) && (shdr->sh_addralign != 1)) {
 393         // the alignment field is valid
 394         if ((shdr->sh_addr & (shdr->sh_addralign - 1)) == 0) {
 395           // if the section address is aligned we must align PE/COFF
 396           mCoffOffset = (UINT32) ((mCoffOffset + shdr->sh_addralign - 1) & ~(shdr->sh_addralign - 1));
 397         } else {
 398           Error (NULL, 0, 3000, "Invalid", "Section address not aligned to its own alignment.");
 399         }
 400       }
 401
 402       /* Relocate entry.  */
 403       if ((mEhdr->e_entry >= shdr->sh_addr) &&
 404           (mEhdr->e_entry < shdr->sh_addr + shdr->sh_size)) {
 405         CoffEntry = (UINT32) (mCoffOffset + mEhdr->e_entry - shdr->sh_addr);
 406       }
 407
 408       //
 409       // Set mTextOffset with the offset of the first '.text' section
 410       //
 411       if (!FoundSection) {
 412         mTextOffset = mCoffOffset;
 413         FoundSection = TRUE;
 414       }
 415
 416       mCoffSectionsOffset[i] = mCoffOffset;
 417       mCoffOffset += (UINT32) shdr->sh_size;
 418       SectionCount ++;
 419     }
 420   }
 421
 422   if (!FoundSection) {
 423     Error (NULL, 0, 3000, "Invalid", "Did not find any '.text' section.");
 424     assert (FALSE);
 425   }
 426
 427   mDebugOffset = DebugRvaAlign(mCoffOffset);
 428   mCoffOffset = CoffAlign(mCoffOffset);
 429
 430   if (SectionCount > 1 && mOutImageType == FW_EFI_IMAGE) {
 431     Warning (NULL, 0, 0, NULL, "Mulitple sections in %s are merged into 1 text section. Source level debug might not work correctly.", mInImageName);
 432   }
 433
 434   //
 435   //  Then data sections.
 436   //
 437   mDataOffset = mCoffOffset;
 438   FoundSection = FALSE;
 439   SectionCount = 0;
 440   for (i = 0; i < mEhdr->e_shnum; i++) {
 441     Elf_Shdr *shdr = GetShdrByIndex(i);
 442     if (IsDataShdr(shdr)) {
 443       if ((shdr->sh_addralign != 0) && (shdr->sh_addralign != 1)) {
 444         // the alignment field is valid
 445         if ((shdr->sh_addr & (shdr->sh_addralign - 1)) == 0) {
 446           // if the section address is aligned we must align PE/COFF
 447           mCoffOffset = (UINT32) ((mCoffOffset + shdr->sh_addralign - 1) & ~(shdr->sh_addralign - 1));
 448         } else {
 449           Error (NULL, 0, 3000, "Invalid", "Section address not aligned to its own alignment.");
 450         }
 451       }
 452
 453       //
 454       // Set mDataOffset with the offset of the first '.data' section
 455       //
 456       if (!FoundSection) {
 457         mDataOffset = mCoffOffset;
 458         FoundSection = TRUE;
 459       }
 460       mCoffSectionsOffset[i] = mCoffOffset;
 461       mCoffOffset += (UINT32) shdr->sh_size;
 462       SectionCount ++;
 463     }
 464   }
 465
 466   //
 467   // Make room for .debug data in .data (or .text if .data is empty) instead of
 468   // putting it in a section of its own. This is explicitly allowed by the
 469   // PE/COFF spec, and prevents bloat in the binary when using large values for
 470   // section alignment.
 471   //
 472   if (SectionCount > 0) {
 473     mDebugOffset = DebugRvaAlign(mCoffOffset);
 474   }
 475   mCoffOffset = mDebugOffset + sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY) +
 476                 sizeof(EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY) +
 477                 strlen(mInImageName) + 1;
 478
 479   mCoffOffset = CoffAlign(mCoffOffset);
 480   if (SectionCount == 0) {
 481     mDataOffset = mCoffOffset;
 482   }
 483
 484   if (SectionCount > 1 && mOutImageType == FW_EFI_IMAGE) {
 485     Warning (NULL, 0, 0, NULL, "Mulitple sections in %s are merged into 1 data section. Source level debug might not work correctly.", mInImageName);
 486   }
 487
 488   //
 489   //  The HII resource sections.
 490   //
 491   mHiiRsrcOffset = mCoffOffset;
 492   for (i = 0; i < mEhdr->e_shnum; i++) {
 493     Elf_Shdr *shdr = GetShdrByIndex(i);
 494     if (IsHiiRsrcShdr(shdr)) {
 495       if ((shdr->sh_addralign != 0) && (shdr->sh_addralign != 1)) {
 496         // the alignment field is valid
 497         if ((shdr->sh_addr & (shdr->sh_addralign - 1)) == 0) {
 498           // if the section address is aligned we must align PE/COFF
 499           mCoffOffset = (UINT32) ((mCoffOffset + shdr->sh_addralign - 1) & ~(shdr->sh_addralign - 1));
 500         } else {
 501           Error (NULL, 0, 3000, "Invalid", "Section address not aligned to its own alignment.");
 502         }
 503       }
 504       if (shdr->sh_size != 0) {
 505         mHiiRsrcOffset = mCoffOffset;
 506         mCoffSectionsOffset[i] = mCoffOffset;
 507         mCoffOffset += (UINT32) shdr->sh_size;
 508         mCoffOffset = CoffAlign(mCoffOffset);
 509         SetHiiResourceHeader ((UINT8*) mEhdr + shdr->sh_offset, mHiiRsrcOffset);
 510       }
 511       break;
 512     }
 513   }
 514
 515   mRelocOffset = mCoffOffset;
 516
 517   //
 518   // Allocate base Coff file.  Will be expanded later for relocations.
 519   //
 520   mCoffFile = (UINT8 *)malloc(mCoffOffset);
 521   memset(mCoffFile, 0, mCoffOffset);
 522
 523   //
 524   // Fill headers.
 525   //
 526   DosHdr = (EFI_IMAGE_DOS_HEADER *)mCoffFile;
 527   DosHdr->e_magic = EFI_IMAGE_DOS_SIGNATURE;
 528   DosHdr->e_lfanew = mNtHdrOffset;
 529
 530   NtHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION*)(mCoffFile + mNtHdrOffset);
 531
 532   NtHdr->Pe32Plus.Signature = EFI_IMAGE_NT_SIGNATURE;
 533
 534   switch (mEhdr->e_machine) {
 535   case EM_X86_64:
 536     NtHdr->Pe32Plus.FileHeader.Machine = EFI_IMAGE_MACHINE_X64;
 537     NtHdr->Pe32Plus.OptionalHeader.Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;
 538     break;
 539   case EM_IA_64:
 540     NtHdr->Pe32Plus.FileHeader.Machine = EFI_IMAGE_MACHINE_IPF;
 541     NtHdr->Pe32Plus.OptionalHeader.Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;
 542     break;
 543   case EM_AARCH64:
 544     NtHdr->Pe32Plus.FileHeader.Machine = EFI_IMAGE_MACHINE_AARCH64;
 545     NtHdr->Pe32Plus.OptionalHeader.Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;
 546     break;
 547   default:
 548     VerboseMsg ("%s unknown e_machine type. Assume X64", (UINTN)mEhdr->e_machine);
 549     NtHdr->Pe32Plus.FileHeader.Machine = EFI_IMAGE_MACHINE_X64;
 550     NtHdr->Pe32Plus.OptionalHeader.Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;
 551   }
 552
 553   NtHdr->Pe32Plus.FileHeader.NumberOfSections = mCoffNbrSections;
 554   NtHdr->Pe32Plus.FileHeader.TimeDateStamp = (UINT32) time(NULL);
 555   mImageTimeStamp = NtHdr->Pe32Plus.FileHeader.TimeDateStamp;
 556   NtHdr->Pe32Plus.FileHeader.PointerToSymbolTable = 0;
 557   NtHdr->Pe32Plus.FileHeader.NumberOfSymbols = 0;
 558   NtHdr->Pe32Plus.FileHeader.SizeOfOptionalHeader = sizeof(NtHdr->Pe32Plus.OptionalHeader);
 559   NtHdr->Pe32Plus.FileHeader.Characteristics = EFI_IMAGE_FILE_EXECUTABLE_IMAGE
 560     | EFI_IMAGE_FILE_LINE_NUMS_STRIPPED
 561     | EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED
 562     | EFI_IMAGE_FILE_LARGE_ADDRESS_AWARE;
 563
 564   NtHdr->Pe32Plus.OptionalHeader.SizeOfCode = mDataOffset - mTextOffset;
 565   NtHdr->Pe32Plus.OptionalHeader.SizeOfInitializedData = mRelocOffset - mDataOffset;
 566   NtHdr->Pe32Plus.OptionalHeader.SizeOfUninitializedData = 0;
 567   NtHdr->Pe32Plus.OptionalHeader.AddressOfEntryPoint = CoffEntry;
 568
 569   NtHdr->Pe32Plus.OptionalHeader.BaseOfCode = mTextOffset;
 570
 571   NtHdr->Pe32Plus.OptionalHeader.ImageBase = 0;
 572   NtHdr->Pe32Plus.OptionalHeader.SectionAlignment = mCoffAlignment;
 573   NtHdr->Pe32Plus.OptionalHeader.FileAlignment = mCoffAlignment;
 574   NtHdr->Pe32Plus.OptionalHeader.SizeOfImage = 0;
 575
 576   NtHdr->Pe32Plus.OptionalHeader.SizeOfHeaders = mTextOffset;
 577   NtHdr->Pe32Plus.OptionalHeader.NumberOfRvaAndSizes = EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES;
 578
 579   //
 580   // Section headers.
 581   //
 582   if ((mDataOffset - mTextOffset) > 0) {
 583     CreateSectionHeader (".text", mTextOffset, mDataOffset - mTextOffset,
 584             EFI_IMAGE_SCN_CNT_CODE
 585             | EFI_IMAGE_SCN_MEM_EXECUTE
 586             | EFI_IMAGE_SCN_MEM_READ);
 587   } else {
 588     // Don't make a section of size 0.
 589     NtHdr->Pe32Plus.FileHeader.NumberOfSections--;
 590   }
 591
 592   if ((mHiiRsrcOffset - mDataOffset) > 0) {
 593     CreateSectionHeader (".data", mDataOffset, mHiiRsrcOffset - mDataOffset,
 594             EFI_IMAGE_SCN_CNT_INITIALIZED_DATA
 595             | EFI_IMAGE_SCN_MEM_WRITE
 596             | EFI_IMAGE_SCN_MEM_READ);
 597   } else {
 598     // Don't make a section of size 0.
 599     NtHdr->Pe32Plus.FileHeader.NumberOfSections--;
 600   }
 601
 602   if ((mRelocOffset - mHiiRsrcOffset) > 0) {
 603     CreateSectionHeader (".rsrc", mHiiRsrcOffset, mRelocOffset - mHiiRsrcOffset,
 604             EFI_IMAGE_SCN_CNT_INITIALIZED_DATA
 605             | EFI_IMAGE_SCN_MEM_READ);
 606
 607     NtHdr->Pe32Plus.OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE].Size = mRelocOffset - mHiiRsrcOffset;
 608     NtHdr->Pe32Plus.OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE].VirtualAddress = mHiiRsrcOffset;
 609   } else {
 610     // Don't make a section of size 0.
 611     NtHdr->Pe32Plus.FileHeader.NumberOfSections--;
 612   }
 613
 614 }
 615
 616 STATIC
 617 BOOLEAN
 618 WriteSections64 (
 619   SECTION_FILTER_TYPES  FilterType
 620   )
 621 {
 622   UINT32      Idx;
 623   Elf_Shdr    *SecShdr;
 624   UINT32      SecOffset;
 625   BOOLEAN     (*Filter)(Elf_Shdr *);
 626
 627   //
 628   // Initialize filter pointer
 629   //
 630   switch (FilterType) {
 631     case SECTION_TEXT:
 632       Filter = IsTextShdr;
 633       break;
 634     case SECTION_HII:
 635       Filter = IsHiiRsrcShdr;
 636       break;
 637     case SECTION_DATA:
 638       Filter = IsDataShdr;
 639       break;
 640     default:
 641       return FALSE;
 642   }
 643
 644   //
 645   // First: copy sections.
 646   //
 647   for (Idx = 0; Idx < mEhdr->e_shnum; Idx++) {
 648     Elf_Shdr *Shdr = GetShdrByIndex(Idx);
 649     if ((*Filter)(Shdr)) {
 650       switch (Shdr->sh_type) {
 651       case SHT_PROGBITS:
 652         /* Copy.  */
 653         memcpy(mCoffFile + mCoffSectionsOffset[Idx],
 654               (UINT8*)mEhdr + Shdr->sh_offset,
 655               (size_t) Shdr->sh_size);
 656         break;
 657
 658       case SHT_NOBITS:
 659         memset(mCoffFile + mCoffSectionsOffset[Idx], 0, (size_t) Shdr->sh_size);
 660         break;
 661
 662       default:
 663         //
 664         //  Ignore for unkown section type.
 665         //
 666         VerboseMsg ("%s unknown section type %x. We directly copy this section into Coff file", mInImageName, (unsigned)Shdr->sh_type);
 667         break;
 668       }
 669     }
 670   }
 671
 672   //
 673   // Second: apply relocations.
 674   //
 675   VerboseMsg ("Applying Relocations...");
 676   for (Idx = 0; Idx < mEhdr->e_shnum; Idx++) {
 677     //
 678     // Determine if this is a relocation section.
 679     //
 680     Elf_Shdr *RelShdr = GetShdrByIndex(Idx);
 681     if ((RelShdr->sh_type != SHT_REL) && (RelShdr->sh_type != SHT_RELA)) {
 682       continue;
 683     }
 684
 685     //
 686     // Relocation section found.  Now extract section information that the relocations
 687     // apply to in the ELF data and the new COFF data.
 688     //
 689     SecShdr = GetShdrByIndex(RelShdr->sh_info);
 690     SecOffset = mCoffSectionsOffset[RelShdr->sh_info];
 691
 692     //
 693     // Only process relocations for the current filter type.
 694     //
 695     if (RelShdr->sh_type == SHT_RELA && (*Filter)(SecShdr)) {
 696       UINT64 RelIdx;
 697
 698       //
 699       // Determine the symbol table referenced by the relocation data.
 700       //
 701       Elf_Shdr *SymtabShdr = GetShdrByIndex(RelShdr->sh_link);
 702       UINT8 *Symtab = (UINT8*)mEhdr + SymtabShdr->sh_offset;
 703
 704       //
 705       // Process all relocation entries for this section.
 706       //
 707       for (RelIdx = 0; RelIdx < RelShdr->sh_size; RelIdx += (UINT32) RelShdr->sh_entsize) {
 708
 709         //
 710         // Set pointer to relocation entry
 711         //
 712         Elf_Rela *Rel = (Elf_Rela *)((UINT8*)mEhdr + RelShdr->sh_offset + RelIdx);
 713
 714         //
 715         // Set pointer to symbol table entry associated with the relocation entry.
 716         //
 717         Elf_Sym  *Sym = (Elf_Sym *)(Symtab + ELF_R_SYM(Rel->r_info) * SymtabShdr->sh_entsize);
 718
 719         Elf_Shdr *SymShdr;
 720         UINT8    *Targ;
 721
 722         //
 723         // Check section header index found in symbol table and get the section
 724         // header location.
 725         //
 726         if (Sym->st_shndx == SHN_UNDEF
 727             || Sym->st_shndx >= mEhdr->e_shnum) {
 728           const UINT8 *SymName = GetSymName(Sym);
 729           if (SymName == NULL) {
 730             SymName = (const UINT8 *)"<unknown>";
 731           }
 732
 733           Error (NULL, 0, 3000, "Invalid",
 734                  "%s: Bad definition for symbol '%s'@%#llx or unsupported symbol type.  "
 735                  "For example, absolute and undefined symbols are not supported.",
 736                  mInImageName, SymName, Sym->st_value);
 737
 738           exit(EXIT_FAILURE);
 739         }
 740         SymShdr = GetShdrByIndex(Sym->st_shndx);
 741
 742         //
 743         // Convert the relocation data to a pointer into the coff file.
 744         //
 745         // Note:
 746         //   r_offset is the virtual address of the storage unit to be relocated.
 747         //   sh_addr is the virtual address for the base of the section.
 748         //
 749         //   r_offset in a memory address.
 750         //   Convert it to a pointer in the coff file.
 751         //
 752         Targ = mCoffFile + SecOffset + (Rel->r_offset - SecShdr->sh_addr);
 753
 754         //
 755         // Determine how to handle each relocation type based on the machine type.
 756         //
 757         if (mEhdr->e_machine == EM_X86_64) {
 758           switch (ELF_R_TYPE(Rel->r_info)) {
 759           case R_X86_64_NONE:
 760             break;
 761           case R_X86_64_64:
 762             //
 763             // Absolute relocation.
 764             //
 765             VerboseMsg ("R_X86_64_64");
 766             VerboseMsg ("Offset: 0x%08X, Addend: 0x%016LX",
 767               (UINT32)(SecOffset + (Rel->r_offset - SecShdr->sh_addr)),
 768               *(UINT64 *)Targ);
 769             *(UINT64 *)Targ = *(UINT64 *)Targ - SymShdr->sh_addr + mCoffSectionsOffset[Sym->st_shndx];
 770             VerboseMsg ("Relocation:  0x%016LX", *(UINT64*)Targ);
 771             break;
 772           case R_X86_64_32:
 773             VerboseMsg ("R_X86_64_32");
 774             VerboseMsg ("Offset: 0x%08X, Addend: 0x%08X",
 775               (UINT32)(SecOffset + (Rel->r_offset - SecShdr->sh_addr)),
 776               *(UINT32 *)Targ);
 777             *(UINT32 *)Targ = (UINT32)((UINT64)(*(UINT32 *)Targ) - SymShdr->sh_addr + mCoffSectionsOffset[Sym->st_shndx]);
 778             VerboseMsg ("Relocation:  0x%08X", *(UINT32*)Targ);
 779             break;
 780           case R_X86_64_32S:
 781             VerboseMsg ("R_X86_64_32S");
 782             VerboseMsg ("Offset: 0x%08X, Addend: 0x%08X",
 783               (UINT32)(SecOffset + (Rel->r_offset - SecShdr->sh_addr)),
 784               *(UINT32 *)Targ);
 785             *(INT32 *)Targ = (INT32)((INT64)(*(INT32 *)Targ) - SymShdr->sh_addr + mCoffSectionsOffset[Sym->st_shndx]);
 786             VerboseMsg ("Relocation:  0x%08X", *(UINT32*)Targ);
 787             break;
 788
 789           case R_X86_64_PLT32:
 790             //
 791             // Treat R_X86_64_PLT32 relocations as R_X86_64_PC32: this is
 792             // possible since we know all code symbol references resolve to
 793             // definitions in the same module (UEFI has no shared libraries),
 794             // and so there is never a reason to jump via a PLT entry,
 795             // allowing us to resolve the reference using the symbol directly.
 796             //
 797             VerboseMsg ("Treating R_X86_64_PLT32 as R_X86_64_PC32 ...");
 798             /* fall through */
 799           case R_X86_64_PC32:
 800             //
 801             // Relative relocation: Symbol - Ip + Addend
 802             //
 803             VerboseMsg ("R_X86_64_PC32");
 804             VerboseMsg ("Offset: 0x%08X, Addend: 0x%08X",
 805               (UINT32)(SecOffset + (Rel->r_offset - SecShdr->sh_addr)),
 806               *(UINT32 *)Targ);
 807             *(UINT32 *)Targ = (UINT32) (*(UINT32 *)Targ
 808               + (mCoffSectionsOffset[Sym->st_shndx] - SymShdr->sh_addr)
 809               - (SecOffset - SecShdr->sh_addr));
 810             VerboseMsg ("Relocation:  0x%08X", *(UINT32 *)Targ);
 811             break;
 812           default:
 813             Error (NULL, 0, 3000, "Invalid", "%s unsupported ELF EM_X86_64 relocation 0x%x.", mInImageName, (unsigned) ELF_R_TYPE(Rel->r_info));
 814           }
 815         } else if (mEhdr->e_machine == EM_AARCH64) {
 816
 817           switch (ELF_R_TYPE(Rel->r_info)) {
 818
 819           case R_AARCH64_ADR_PREL_PG_HI21:
 820             //
 821             // AArch64 PG_H21 relocations are typically paired with ABS_LO12
 822             // relocations, where a PC-relative reference with +/- 4 GB range is
 823             // split into a relative high part and an absolute low part. Since
 824             // the absolute low part represents the offset into a 4 KB page, we
 825             // either have to convert the ADRP into an ADR instruction, or we
 826             // need to use a section alignment of at least 4 KB, so that the
 827             // binary appears at a correct offset at runtime. In any case, we
 828             // have to make sure that the 4 KB relative offsets of both the
 829             // section containing the reference as well as the section to which
 830             // it refers have not been changed during PE/COFF conversion (i.e.,
 831             // in ScanSections64() above).
 832             //
 833             if (mCoffAlignment < 0x1000) {
 834               //
 835               // Attempt to convert the ADRP into an ADR instruction.
 836               // This is only possible if the symbol is within +/- 1 MB.
 837               //
 838               INT64 Offset;
 839
 840               // Decode the ADRP instruction
 841               Offset = (INT32)((*(UINT32 *)Targ & 0xffffe0) << 8);
 842               Offset = (Offset << (6 - 5)) | ((*(UINT32 *)Targ & 0x60000000) >> (29 - 12));
 843
 844               //
 845               // ADRP offset is relative to the previous page boundary,
 846               // whereas ADR offset is relative to the instruction itself.
 847               // So fix up the offset so it points to the page containing
 848               // the symbol.
 849               //
 850               Offset -= (UINTN)(Targ - mCoffFile) & 0xfff;
 851
 852               if (Offset < -0x100000 || Offset > 0xfffff) {
 853                 Error (NULL, 0, 3000, "Invalid", "WriteSections64(): %s  due to its size (> 1 MB), this module requires 4 KB section alignment.",
 854                   mInImageName);
 855                 break;
 856               }
 857
 858               // Re-encode the offset as an ADR instruction
 859               *(UINT32 *)Targ &= 0x1000001f;
 860               *(UINT32 *)Targ |= ((Offset & 0x1ffffc) << (5 - 2)) | ((Offset & 0x3) << 29);
 861             }
 862             /* fall through */
 863
 864           case R_AARCH64_ADD_ABS_LO12_NC:
 865           case R_AARCH64_LDST8_ABS_LO12_NC:
 866           case R_AARCH64_LDST16_ABS_LO12_NC:
 867           case R_AARCH64_LDST32_ABS_LO12_NC:
 868           case R_AARCH64_LDST64_ABS_LO12_NC:
 869           case R_AARCH64_LDST128_ABS_LO12_NC:
 870             if (((SecShdr->sh_addr ^ SecOffset) & 0xfff) != 0 ||
 871                 ((SymShdr->sh_addr ^ mCoffSectionsOffset[Sym->st_shndx]) & 0xfff) != 0) {
 872               Error (NULL, 0, 3000, "Invalid", "WriteSections64(): %s AARCH64 small code model requires identical ELF and PE/COFF section offsets modulo 4 KB.",
 873                 mInImageName);
 874               break;
 875             }
 876             /* fall through */
 877
 878           case R_AARCH64_ADR_PREL_LO21:
 879           case R_AARCH64_CONDBR19:
 880           case R_AARCH64_LD_PREL_LO19:
 881           case R_AARCH64_CALL26:
 882           case R_AARCH64_JUMP26:
 883           case R_AARCH64_PREL64:
 884           case R_AARCH64_PREL32:
 885           case R_AARCH64_PREL16:
 886             //
 887             // The GCC toolchains (i.e., binutils) may corrupt section relative
 888             // relocations when emitting relocation sections into fully linked
 889             // binaries. More specifically, they tend to fail to take into
 890             // account the fact that a '.rodata + XXX' relocation needs to have
 891             // its addend recalculated once .rodata is merged into the .text
 892             // section, and the relocation emitted into the .rela.text section.
 893             //
 894             // We cannot really recover from this loss of information, so the
 895             // only workaround is to prevent having to recalculate any relative
 896             // relocations at all, by using a linker script that ensures that
 897             // the offset between the Place and the Symbol is the same in both
 898             // the ELF and the PE/COFF versions of the binary.
 899             //
 900             if ((SymShdr->sh_addr - SecShdr->sh_addr) !=
 901                 (mCoffSectionsOffset[Sym->st_shndx] - SecOffset)) {
 902               Error (NULL, 0, 3000, "Invalid", "WriteSections64(): %s AARCH64 relative relocations require identical ELF and PE/COFF section offsets",
 903                 mInImageName);
 904             }
 905             break;
 906
 907           // Absolute relocations.
 908           case R_AARCH64_ABS64:
 909             *(UINT64 *)Targ = *(UINT64 *)Targ - SymShdr->sh_addr + mCoffSectionsOffset[Sym->st_shndx];
 910             break;
 911
 912           default:
 913             Error (NULL, 0, 3000, "Invalid", "WriteSections64(): %s unsupported ELF EM_AARCH64 relocation 0x%x.", mInImageName, (unsigned) ELF_R_TYPE(Rel->r_info));
 914           }
 915         } else {
 916           Error (NULL, 0, 3000, "Invalid", "Not a supported machine type");
 917         }
 918       }
 919     }
 920   }
 921
 922   return TRUE;
 923 }
 924
 925 STATIC
 926 VOID
 927 WriteRelocations64 (
 928   VOID
 929   )
 930 {
 931   UINT32                           Index;
 932   EFI_IMAGE_OPTIONAL_HEADER_UNION  *NtHdr;
 933   EFI_IMAGE_DATA_DIRECTORY         *Dir;
 934
 935   for (Index = 0; Index < mEhdr->e_shnum; Index++) {
 936     Elf_Shdr *RelShdr = GetShdrByIndex(Index);
 937     if ((RelShdr->sh_type == SHT_REL) || (RelShdr->sh_type == SHT_RELA)) {
 938       Elf_Shdr *SecShdr = GetShdrByIndex (RelShdr->sh_info);
 939       if (IsTextShdr(SecShdr) || IsDataShdr(SecShdr)) {
 940         UINT64 RelIdx;
 941
 942         for (RelIdx = 0; RelIdx < RelShdr->sh_size; RelIdx += RelShdr->sh_entsize) {
 943           Elf_Rela *Rel = (Elf_Rela *)((UINT8*)mEhdr + RelShdr->sh_offset + RelIdx);
 944
 945           if (mEhdr->e_machine == EM_X86_64) {
 946             switch (ELF_R_TYPE(Rel->r_info)) {
 947             case R_X86_64_NONE:
 948             case R_X86_64_PC32:
 949             case R_X86_64_PLT32:
 950               break;
 951             case R_X86_64_64:
 952               VerboseMsg ("EFI_IMAGE_REL_BASED_DIR64 Offset: 0x%08X",
 953                 mCoffSectionsOffset[RelShdr->sh_info] + (Rel->r_offset - SecShdr->sh_addr));
 954               CoffAddFixup(
 955                 (UINT32) ((UINT64) mCoffSectionsOffset[RelShdr->sh_info]
 956                 + (Rel->r_offset - SecShdr->sh_addr)),
 957                 EFI_IMAGE_REL_BASED_DIR64);
 958               break;
 959             case R_X86_64_32S:
 960             case R_X86_64_32:
 961               VerboseMsg ("EFI_IMAGE_REL_BASED_HIGHLOW Offset: 0x%08X",
 962                 mCoffSectionsOffset[RelShdr->sh_info] + (Rel->r_offset - SecShdr->sh_addr));
 963               CoffAddFixup(
 964                 (UINT32) ((UINT64) mCoffSectionsOffset[RelShdr->sh_info]
 965                 + (Rel->r_offset - SecShdr->sh_addr)),
 966                 EFI_IMAGE_REL_BASED_HIGHLOW);
 967               break;
 968             default:
 969               Error (NULL, 0, 3000, "Invalid", "%s unsupported ELF EM_X86_64 relocation 0x%x.", mInImageName, (unsigned) ELF_R_TYPE(Rel->r_info));
 970             }
 971           } else if (mEhdr->e_machine == EM_AARCH64) {
 972
 973             switch (ELF_R_TYPE(Rel->r_info)) {
 974             case R_AARCH64_ADR_PREL_LO21:
 975             case R_AARCH64_CONDBR19:
 976             case R_AARCH64_LD_PREL_LO19:
 977             case R_AARCH64_CALL26:
 978             case R_AARCH64_JUMP26:
 979             case R_AARCH64_PREL64:
 980             case R_AARCH64_PREL32:
 981             case R_AARCH64_PREL16:
 982             case R_AARCH64_ADR_PREL_PG_HI21:
 983             case R_AARCH64_ADD_ABS_LO12_NC:
 984             case R_AARCH64_LDST8_ABS_LO12_NC:
 985             case R_AARCH64_LDST16_ABS_LO12_NC:
 986             case R_AARCH64_LDST32_ABS_LO12_NC:
 987             case R_AARCH64_LDST64_ABS_LO12_NC:
 988             case R_AARCH64_LDST128_ABS_LO12_NC:
 989               //
 990               // No fixups are required for relative relocations, provided that
 991               // the relative offsets between sections have been preserved in
 992               // the ELF to PE/COFF conversion. We have already asserted that
 993               // this is the case in WriteSections64 ().
 994               //
 995               break;
 996
 997             case R_AARCH64_ABS64:
 998               CoffAddFixup(
 999                 (UINT32) ((UINT64) mCoffSectionsOffset[RelShdr->sh_info]
1000                 + (Rel->r_offset - SecShdr->sh_addr)),
1001                 EFI_IMAGE_REL_BASED_DIR64);
1002               break;
1003
1004             case R_AARCH64_ABS32:
1005               CoffAddFixup(
1006                 (UINT32) ((UINT64) mCoffSectionsOffset[RelShdr->sh_info]
1007                 + (Rel->r_offset - SecShdr->sh_addr)),
1008                 EFI_IMAGE_REL_BASED_HIGHLOW);
1009              break;
1010
1011             default:
1012                 Error (NULL, 0, 3000, "Invalid", "WriteRelocations64(): %s unsupported ELF EM_AARCH64 relocation 0x%x.", mInImageName, (unsigned) ELF_R_TYPE(Rel->r_info));
1013             }
1014           } else {
1015             Error (NULL, 0, 3000, "Not Supported", "This tool does not support relocations for ELF with e_machine %u (processor type).", (unsigned) mEhdr->e_machine);
1016           }
1017         }
1018       }
1019     }
1020   }
1021
1022   //
1023   // Pad by adding empty entries.
1024   //
1025   while (mCoffOffset & (mCoffAlignment - 1)) {
1026     CoffAddFixupEntry(0);
1027   }
1028
1029   NtHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION *)(mCoffFile + mNtHdrOffset);
1030   Dir = &NtHdr->Pe32Plus.OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];
1031   Dir->Size = mCoffOffset - mRelocOffset;
1032   if (Dir->Size == 0) {
1033     // If no relocations, null out the directory entry and don't add the .reloc section
1034     Dir->VirtualAddress = 0;
1035     NtHdr->Pe32Plus.FileHeader.NumberOfSections--;
1036   } else {
1037     Dir->VirtualAddress = mRelocOffset;
1038     CreateSectionHeader (".reloc", mRelocOffset, mCoffOffset - mRelocOffset,
1039             EFI_IMAGE_SCN_CNT_INITIALIZED_DATA
1040             | EFI_IMAGE_SCN_MEM_DISCARDABLE
1041             | EFI_IMAGE_SCN_MEM_READ);
1042   }
1043 }
1044
1045 STATIC
1046 VOID
1047 WriteDebug64 (
1048   VOID
1049   )
1050 {
1051   UINT32                              Len;
1052   EFI_IMAGE_OPTIONAL_HEADER_UNION     *NtHdr;
1053   EFI_IMAGE_DATA_DIRECTORY            *DataDir;
1054   EFI_IMAGE_DEBUG_DIRECTORY_ENTRY     *Dir;
1055   EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY *Nb10;
1056
1057   Len = strlen(mInImageName) + 1;
1058
1059   Dir = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY*)(mCoffFile + mDebugOffset);
1060   Dir->Type = EFI_IMAGE_DEBUG_TYPE_CODEVIEW;
1061   Dir->SizeOfData = sizeof(EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY) + Len;
1062   Dir->RVA = mDebugOffset + sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);
1063   Dir->FileOffset = mDebugOffset + sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);
1064
1065   Nb10 = (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY*)(Dir + 1);
1066   Nb10->Signature = CODEVIEW_SIGNATURE_NB10;
1067   strcpy ((char *)(Nb10 + 1), mInImageName);
1068
1069
1070   NtHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION *)(mCoffFile + mNtHdrOffset);
1071   DataDir = &NtHdr->Pe32Plus.OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG];
1072   DataDir->VirtualAddress = mDebugOffset;
1073   DataDir->Size = Dir->SizeOfData + sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);
1074 }
1075
1076 STATIC
1077 VOID
1078 SetImageSize64 (
1079   VOID
1080   )
1081 {
1082   EFI_IMAGE_OPTIONAL_HEADER_UNION *NtHdr;
1083
1084   //
1085   // Set image size
1086   //
1087   NtHdr = (EFI_IMAGE_OPTIONAL_HEADER_UNION *)(mCoffFile + mNtHdrOffset);
1088   NtHdr->Pe32Plus.OptionalHeader.SizeOfImage = mCoffOffset;
1089 }
1090
1091 STATIC
1092 VOID
1093 CleanUp64 (
1094   VOID
1095   )
1096 {
1097   if (mCoffSectionsOffset != NULL) {
1098     free (mCoffSectionsOffset);
1099   }
1100 }
1101
1102