4 Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>
5 Portions copyright (c) 2013-2014, ARM Ltd. All rights reserved.<BR>
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
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.
17 #include "WinNtInclude.h"
31 #include <Common/UefiBaseTypes.h>
32 #include <IndustryStandard/PeImage.h>
34 #include "PeCoffLib.h"
35 #include "EfiUtilityMsgs.h"
38 #include "ElfConvert.h"
39 #include "Elf64Convert.h"
50 SECTION_FILTER_TYPES FilterType
78 // Rename ELF32 strucutres to common names to help when porting to ELF64.
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)
92 // Well known ELF structures.
94 STATIC Elf_Ehdr
*mEhdr
;
95 STATIC Elf_Shdr
*mShdrBase
;
96 STATIC Elf_Phdr
*mPhdrBase
;
101 STATIC UINT32 mCoffAlignment
= 0x20;
104 // PE section alignment.
106 STATIC
const UINT16 mCoffNbrSections
= 4;
109 // ELF sections to offset in Coff file.
111 STATIC UINT32
*mCoffSectionsOffset
= NULL
;
114 // Offsets in COFF file
116 STATIC UINT32 mNtHdrOffset
;
117 STATIC UINT32 mTextOffset
;
118 STATIC UINT32 mDataOffset
;
119 STATIC UINT32 mHiiRsrcOffset
;
120 STATIC UINT32 mRelocOffset
;
121 STATIC UINT32 mDebugOffset
;
124 // Initialization Function
129 ELF_FUNCTION_TABLE
*ElfFunctions
133 // Initialize data pointer and structures.
135 VerboseMsg ("Set EHDR");
136 mEhdr
= (Elf_Ehdr
*) FileBuffer
;
139 // Check the ELF64 specific header information.
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");
146 if (mEhdr
->e_ident
[EI_DATA
] != ELFDATA2LSB
) {
147 Error (NULL
, 0, 3000, "Unsupported", "ELF EI_DATA not ELFDATA2LSB");
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");
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");
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
);
164 // Update section header pointers
166 VerboseMsg ("Update Header Pointers");
167 mShdrBase
= (Elf_Shdr
*)((UINT8
*)mEhdr
+ mEhdr
->e_shoff
);
168 mPhdrBase
= (Elf_Phdr
*)((UINT8
*)mEhdr
+ mEhdr
->e_phoff
);
171 // Create COFF Section offset buffer and zero.
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
));
178 // Fill in function pointers.
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
;
193 // Header by Index functions
201 if (Num
>= mEhdr
->e_shnum
) {
202 Error (NULL
, 0, 3000, "Invalid", "GetShdrByIndex: Index %u is too high.", Num
);
206 return (Elf_Shdr
*)((UINT8
*)mShdrBase
+ Num
* mEhdr
->e_shentsize
);
215 return (Offset
+ mCoffAlignment
- 1) & ~(mCoffAlignment
- 1);
224 return (Offset
+ 3) & ~3;
236 return (BOOLEAN
) ((Shdr
->sh_flags
& (SHF_WRITE
| SHF_ALLOC
)) == SHF_ALLOC
);
245 Elf_Shdr
*Namedr
= GetShdrByIndex(mEhdr
->e_shstrndx
);
247 return (BOOLEAN
) (strcmp((CHAR8
*)mEhdr
+ Namedr
->sh_offset
+ Shdr
->sh_name
, ELF_HII_SECTION_NAME
) == 0);
256 if (IsHiiRsrcShdr(Shdr
)) {
259 return (BOOLEAN
) (Shdr
->sh_flags
& (SHF_WRITE
| SHF_ALLOC
)) == (SHF_ALLOC
| SHF_WRITE
);
268 Elf_Shdr
*Namedr
= GetShdrByIndex(mEhdr
->e_shstrndx
);
270 return (BOOLEAN
) (strcmp((CHAR8
*)mEhdr
+ Namedr
->sh_offset
+ Shdr
->sh_name
, ELF_STRTAB_SECTION_NAME
) == 0);
280 for (i
= 0; i
< mEhdr
->e_shnum
; i
++) {
281 Elf_Shdr
*shdr
= GetShdrByIndex(i
);
282 if (IsStrtabShdr(shdr
)) {
295 if (Sym
->st_name
== 0) {
299 Elf_Shdr
*StrtabShdr
= FindStrtabShdr();
300 if (StrtabShdr
== NULL
) {
304 assert(Sym
->st_name
< StrtabShdr
->sh_size
);
306 UINT8
* StrtabContents
= (UINT8
*)mEhdr
+ StrtabShdr
->sh_offset
;
308 bool foundEnd
= false;
309 for (UINT32 i
= Sym
->st_name
; (i
< StrtabShdr
->sh_size
) && !foundEnd
; i
++) {
310 foundEnd
= StrtabContents
[i
] == 0;
314 return StrtabContents
+ Sym
->st_name
;
318 // Elf functions interface implementation
328 EFI_IMAGE_DOS_HEADER
*DosHdr
;
329 EFI_IMAGE_OPTIONAL_HEADER_UNION
*NtHdr
;
332 BOOLEAN FoundSection
;
338 // Coff file start with a DOS header.
340 mCoffOffset
= sizeof(EFI_IMAGE_DOS_HEADER
) + 0x40;
341 mNtHdrOffset
= mCoffOffset
;
342 switch (mEhdr
->e_machine
) {
346 mCoffOffset
+= sizeof (EFI_IMAGE_NT_HEADERS64
);
349 VerboseMsg ("%s unknown e_machine type %hu. Assume X64", mInImageName
, mEhdr
->e_machine
);
350 mCoffOffset
+= sizeof (EFI_IMAGE_NT_HEADERS64
);
354 mTableOffset
= mCoffOffset
;
355 mCoffOffset
+= mCoffNbrSections
* sizeof(EFI_IMAGE_SECTION_HEADER
);
358 // Set mCoffAlignment to the maximum alignment of the input sections
361 for (i
= 0; i
< mEhdr
->e_shnum
; i
++) {
362 Elf_Shdr
*shdr
= GetShdrByIndex(i
);
363 if (shdr
->sh_addralign
<= mCoffAlignment
) {
366 if (IsTextShdr(shdr
) || IsDataShdr(shdr
) || IsHiiRsrcShdr(shdr
)) {
367 mCoffAlignment
= (UINT32
)shdr
->sh_addralign
;
372 // Move the PE/COFF header right before the first section. This will help us
373 // save space when converting to TE.
375 if (mCoffAlignment
> mCoffOffset
) {
376 mNtHdrOffset
+= mCoffAlignment
- mCoffOffset
;
377 mTableOffset
+= mCoffAlignment
- mCoffOffset
;
378 mCoffOffset
= mCoffAlignment
;
382 // First text sections.
384 mCoffOffset
= CoffAlign(mCoffOffset
);
385 mTextOffset
= mCoffOffset
;
386 FoundSection
= FALSE
;
388 for (i
= 0; i
< mEhdr
->e_shnum
; i
++) {
389 Elf_Shdr
*shdr
= GetShdrByIndex(i
);
390 if (IsTextShdr(shdr
)) {
391 if ((shdr
->sh_addralign
!= 0) && (shdr
->sh_addralign
!= 1)) {
392 // the alignment field is valid
393 if ((shdr
->sh_addr
& (shdr
->sh_addralign
- 1)) == 0) {
394 // if the section address is aligned we must align PE/COFF
395 mCoffOffset
= (UINT32
) ((mCoffOffset
+ shdr
->sh_addralign
- 1) & ~(shdr
->sh_addralign
- 1));
397 Error (NULL
, 0, 3000, "Invalid", "Section address not aligned to its own alignment.");
401 /* Relocate entry. */
402 if ((mEhdr
->e_entry
>= shdr
->sh_addr
) &&
403 (mEhdr
->e_entry
< shdr
->sh_addr
+ shdr
->sh_size
)) {
404 CoffEntry
= (UINT32
) (mCoffOffset
+ mEhdr
->e_entry
- shdr
->sh_addr
);
408 // Set mTextOffset with the offset of the first '.text' section
411 mTextOffset
= mCoffOffset
;
415 mCoffSectionsOffset
[i
] = mCoffOffset
;
416 mCoffOffset
+= (UINT32
) shdr
->sh_size
;
422 Error (NULL
, 0, 3000, "Invalid", "Did not find any '.text' section.");
426 mDebugOffset
= DebugRvaAlign(mCoffOffset
);
427 mCoffOffset
= CoffAlign(mCoffOffset
);
429 if (SectionCount
> 1 && mOutImageType
== FW_EFI_IMAGE
) {
430 Warning (NULL
, 0, 0, NULL
, "Mulitple sections in %s are merged into 1 text section. Source level debug might not work correctly.", mInImageName
);
434 // Then data sections.
436 mDataOffset
= mCoffOffset
;
437 FoundSection
= FALSE
;
439 for (i
= 0; i
< mEhdr
->e_shnum
; i
++) {
440 Elf_Shdr
*shdr
= GetShdrByIndex(i
);
441 if (IsDataShdr(shdr
)) {
442 if ((shdr
->sh_addralign
!= 0) && (shdr
->sh_addralign
!= 1)) {
443 // the alignment field is valid
444 if ((shdr
->sh_addr
& (shdr
->sh_addralign
- 1)) == 0) {
445 // if the section address is aligned we must align PE/COFF
446 mCoffOffset
= (UINT32
) ((mCoffOffset
+ shdr
->sh_addralign
- 1) & ~(shdr
->sh_addralign
- 1));
448 Error (NULL
, 0, 3000, "Invalid", "Section address not aligned to its own alignment.");
453 // Set mDataOffset with the offset of the first '.data' section
456 mDataOffset
= mCoffOffset
;
459 mCoffSectionsOffset
[i
] = mCoffOffset
;
460 mCoffOffset
+= (UINT32
) shdr
->sh_size
;
466 // Make room for .debug data in .data (or .text if .data is empty) instead of
467 // putting it in a section of its own. This is explicitly allowed by the
468 // PE/COFF spec, and prevents bloat in the binary when using large values for
469 // section alignment.
471 if (SectionCount
> 0) {
472 mDebugOffset
= DebugRvaAlign(mCoffOffset
);
474 mCoffOffset
= mDebugOffset
+ sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
) +
475 sizeof(EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY
) +
476 strlen(mInImageName
) + 1;
478 mCoffOffset
= CoffAlign(mCoffOffset
);
479 if (SectionCount
== 0) {
480 mDataOffset
= mCoffOffset
;
483 if (SectionCount
> 1 && mOutImageType
== FW_EFI_IMAGE
) {
484 Warning (NULL
, 0, 0, NULL
, "Mulitple sections in %s are merged into 1 data section. Source level debug might not work correctly.", mInImageName
);
488 // The HII resource sections.
490 mHiiRsrcOffset
= mCoffOffset
;
491 for (i
= 0; i
< mEhdr
->e_shnum
; i
++) {
492 Elf_Shdr
*shdr
= GetShdrByIndex(i
);
493 if (IsHiiRsrcShdr(shdr
)) {
494 if ((shdr
->sh_addralign
!= 0) && (shdr
->sh_addralign
!= 1)) {
495 // the alignment field is valid
496 if ((shdr
->sh_addr
& (shdr
->sh_addralign
- 1)) == 0) {
497 // if the section address is aligned we must align PE/COFF
498 mCoffOffset
= (UINT32
) ((mCoffOffset
+ shdr
->sh_addralign
- 1) & ~(shdr
->sh_addralign
- 1));
500 Error (NULL
, 0, 3000, "Invalid", "Section address not aligned to its own alignment.");
503 if (shdr
->sh_size
!= 0) {
504 mHiiRsrcOffset
= mCoffOffset
;
505 mCoffSectionsOffset
[i
] = mCoffOffset
;
506 mCoffOffset
+= (UINT32
) shdr
->sh_size
;
507 mCoffOffset
= CoffAlign(mCoffOffset
);
508 SetHiiResourceHeader ((UINT8
*) mEhdr
+ shdr
->sh_offset
, mHiiRsrcOffset
);
514 mRelocOffset
= mCoffOffset
;
517 // Allocate base Coff file. Will be expanded later for relocations.
519 mCoffFile
= (UINT8
*)malloc(mCoffOffset
);
520 memset(mCoffFile
, 0, mCoffOffset
);
525 DosHdr
= (EFI_IMAGE_DOS_HEADER
*)mCoffFile
;
526 DosHdr
->e_magic
= EFI_IMAGE_DOS_SIGNATURE
;
527 DosHdr
->e_lfanew
= mNtHdrOffset
;
529 NtHdr
= (EFI_IMAGE_OPTIONAL_HEADER_UNION
*)(mCoffFile
+ mNtHdrOffset
);
531 NtHdr
->Pe32Plus
.Signature
= EFI_IMAGE_NT_SIGNATURE
;
533 switch (mEhdr
->e_machine
) {
535 NtHdr
->Pe32Plus
.FileHeader
.Machine
= EFI_IMAGE_MACHINE_X64
;
536 NtHdr
->Pe32Plus
.OptionalHeader
.Magic
= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
;
539 NtHdr
->Pe32Plus
.FileHeader
.Machine
= EFI_IMAGE_MACHINE_IPF
;
540 NtHdr
->Pe32Plus
.OptionalHeader
.Magic
= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
;
543 NtHdr
->Pe32Plus
.FileHeader
.Machine
= EFI_IMAGE_MACHINE_AARCH64
;
544 NtHdr
->Pe32Plus
.OptionalHeader
.Magic
= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
;
547 VerboseMsg ("%s unknown e_machine type. Assume X64", (UINTN
)mEhdr
->e_machine
);
548 NtHdr
->Pe32Plus
.FileHeader
.Machine
= EFI_IMAGE_MACHINE_X64
;
549 NtHdr
->Pe32Plus
.OptionalHeader
.Magic
= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
;
552 NtHdr
->Pe32Plus
.FileHeader
.NumberOfSections
= mCoffNbrSections
;
553 NtHdr
->Pe32Plus
.FileHeader
.TimeDateStamp
= (UINT32
) time(NULL
);
554 mImageTimeStamp
= NtHdr
->Pe32Plus
.FileHeader
.TimeDateStamp
;
555 NtHdr
->Pe32Plus
.FileHeader
.PointerToSymbolTable
= 0;
556 NtHdr
->Pe32Plus
.FileHeader
.NumberOfSymbols
= 0;
557 NtHdr
->Pe32Plus
.FileHeader
.SizeOfOptionalHeader
= sizeof(NtHdr
->Pe32Plus
.OptionalHeader
);
558 NtHdr
->Pe32Plus
.FileHeader
.Characteristics
= EFI_IMAGE_FILE_EXECUTABLE_IMAGE
559 | EFI_IMAGE_FILE_LINE_NUMS_STRIPPED
560 | EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED
561 | EFI_IMAGE_FILE_LARGE_ADDRESS_AWARE
;
563 NtHdr
->Pe32Plus
.OptionalHeader
.SizeOfCode
= mDataOffset
- mTextOffset
;
564 NtHdr
->Pe32Plus
.OptionalHeader
.SizeOfInitializedData
= mRelocOffset
- mDataOffset
;
565 NtHdr
->Pe32Plus
.OptionalHeader
.SizeOfUninitializedData
= 0;
566 NtHdr
->Pe32Plus
.OptionalHeader
.AddressOfEntryPoint
= CoffEntry
;
568 NtHdr
->Pe32Plus
.OptionalHeader
.BaseOfCode
= mTextOffset
;
570 NtHdr
->Pe32Plus
.OptionalHeader
.ImageBase
= 0;
571 NtHdr
->Pe32Plus
.OptionalHeader
.SectionAlignment
= mCoffAlignment
;
572 NtHdr
->Pe32Plus
.OptionalHeader
.FileAlignment
= mCoffAlignment
;
573 NtHdr
->Pe32Plus
.OptionalHeader
.SizeOfImage
= 0;
575 NtHdr
->Pe32Plus
.OptionalHeader
.SizeOfHeaders
= mTextOffset
;
576 NtHdr
->Pe32Plus
.OptionalHeader
.NumberOfRvaAndSizes
= EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES
;
581 if ((mDataOffset
- mTextOffset
) > 0) {
582 CreateSectionHeader (".text", mTextOffset
, mDataOffset
- mTextOffset
,
583 EFI_IMAGE_SCN_CNT_CODE
584 | EFI_IMAGE_SCN_MEM_EXECUTE
585 | EFI_IMAGE_SCN_MEM_READ
);
587 // Don't make a section of size 0.
588 NtHdr
->Pe32Plus
.FileHeader
.NumberOfSections
--;
591 if ((mHiiRsrcOffset
- mDataOffset
) > 0) {
592 CreateSectionHeader (".data", mDataOffset
, mHiiRsrcOffset
- mDataOffset
,
593 EFI_IMAGE_SCN_CNT_INITIALIZED_DATA
594 | EFI_IMAGE_SCN_MEM_WRITE
595 | EFI_IMAGE_SCN_MEM_READ
);
597 // Don't make a section of size 0.
598 NtHdr
->Pe32Plus
.FileHeader
.NumberOfSections
--;
601 if ((mRelocOffset
- mHiiRsrcOffset
) > 0) {
602 CreateSectionHeader (".rsrc", mHiiRsrcOffset
, mRelocOffset
- mHiiRsrcOffset
,
603 EFI_IMAGE_SCN_CNT_INITIALIZED_DATA
604 | EFI_IMAGE_SCN_MEM_READ
);
606 NtHdr
->Pe32Plus
.OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE
].Size
= mRelocOffset
- mHiiRsrcOffset
;
607 NtHdr
->Pe32Plus
.OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE
].VirtualAddress
= mHiiRsrcOffset
;
609 // Don't make a section of size 0.
610 NtHdr
->Pe32Plus
.FileHeader
.NumberOfSections
--;
618 SECTION_FILTER_TYPES FilterType
624 BOOLEAN (*Filter
)(Elf_Shdr
*);
627 // Initialize filter pointer
629 switch (FilterType
) {
634 Filter
= IsHiiRsrcShdr
;
644 // First: copy sections.
646 for (Idx
= 0; Idx
< mEhdr
->e_shnum
; Idx
++) {
647 Elf_Shdr
*Shdr
= GetShdrByIndex(Idx
);
648 if ((*Filter
)(Shdr
)) {
649 switch (Shdr
->sh_type
) {
652 memcpy(mCoffFile
+ mCoffSectionsOffset
[Idx
],
653 (UINT8
*)mEhdr
+ Shdr
->sh_offset
,
654 (size_t) Shdr
->sh_size
);
658 memset(mCoffFile
+ mCoffSectionsOffset
[Idx
], 0, (size_t) Shdr
->sh_size
);
663 // Ignore for unkown section type.
665 VerboseMsg ("%s unknown section type %x. We directly copy this section into Coff file", mInImageName
, (unsigned)Shdr
->sh_type
);
672 // Second: apply relocations.
674 VerboseMsg ("Applying Relocations...");
675 for (Idx
= 0; Idx
< mEhdr
->e_shnum
; Idx
++) {
677 // Determine if this is a relocation section.
679 Elf_Shdr
*RelShdr
= GetShdrByIndex(Idx
);
680 if ((RelShdr
->sh_type
!= SHT_REL
) && (RelShdr
->sh_type
!= SHT_RELA
)) {
685 // Relocation section found. Now extract section information that the relocations
686 // apply to in the ELF data and the new COFF data.
688 SecShdr
= GetShdrByIndex(RelShdr
->sh_info
);
689 SecOffset
= mCoffSectionsOffset
[RelShdr
->sh_info
];
692 // Only process relocations for the current filter type.
694 if (RelShdr
->sh_type
== SHT_RELA
&& (*Filter
)(SecShdr
)) {
698 // Determine the symbol table referenced by the relocation data.
700 Elf_Shdr
*SymtabShdr
= GetShdrByIndex(RelShdr
->sh_link
);
701 UINT8
*Symtab
= (UINT8
*)mEhdr
+ SymtabShdr
->sh_offset
;
704 // Process all relocation entries for this section.
706 for (RelIdx
= 0; RelIdx
< RelShdr
->sh_size
; RelIdx
+= (UINT32
) RelShdr
->sh_entsize
) {
709 // Set pointer to relocation entry
711 Elf_Rela
*Rel
= (Elf_Rela
*)((UINT8
*)mEhdr
+ RelShdr
->sh_offset
+ RelIdx
);
714 // Set pointer to symbol table entry associated with the relocation entry.
716 Elf_Sym
*Sym
= (Elf_Sym
*)(Symtab
+ ELF_R_SYM(Rel
->r_info
) * SymtabShdr
->sh_entsize
);
722 // Check section header index found in symbol table and get the section
725 if (Sym
->st_shndx
== SHN_UNDEF
726 || Sym
->st_shndx
>= mEhdr
->e_shnum
) {
727 const UINT8
*SymName
= GetSymName(Sym
);
728 if (SymName
== NULL
) {
729 SymName
= (const UINT8
*)"<unknown>";
732 Error (NULL
, 0, 3000, "Invalid",
733 "%s: Bad definition for symbol '%s'@%#llx or unsupported symbol type. "
734 "For example, absolute and undefined symbols are not supported.",
735 mInImageName
, SymName
, Sym
->st_value
);
739 SymShdr
= GetShdrByIndex(Sym
->st_shndx
);
742 // Convert the relocation data to a pointer into the coff file.
745 // r_offset is the virtual address of the storage unit to be relocated.
746 // sh_addr is the virtual address for the base of the section.
748 // r_offset in a memory address.
749 // Convert it to a pointer in the coff file.
751 Targ
= mCoffFile
+ SecOffset
+ (Rel
->r_offset
- SecShdr
->sh_addr
);
754 // Determine how to handle each relocation type based on the machine type.
756 if (mEhdr
->e_machine
== EM_X86_64
) {
757 switch (ELF_R_TYPE(Rel
->r_info
)) {
762 // Absolute relocation.
764 VerboseMsg ("R_X86_64_64");
765 VerboseMsg ("Offset: 0x%08X, Addend: 0x%016LX",
766 (UINT32
)(SecOffset
+ (Rel
->r_offset
- SecShdr
->sh_addr
)),
768 *(UINT64
*)Targ
= *(UINT64
*)Targ
- SymShdr
->sh_addr
+ mCoffSectionsOffset
[Sym
->st_shndx
];
769 VerboseMsg ("Relocation: 0x%016LX", *(UINT64
*)Targ
);
772 VerboseMsg ("R_X86_64_32");
773 VerboseMsg ("Offset: 0x%08X, Addend: 0x%08X",
774 (UINT32
)(SecOffset
+ (Rel
->r_offset
- SecShdr
->sh_addr
)),
776 *(UINT32
*)Targ
= (UINT32
)((UINT64
)(*(UINT32
*)Targ
) - SymShdr
->sh_addr
+ mCoffSectionsOffset
[Sym
->st_shndx
]);
777 VerboseMsg ("Relocation: 0x%08X", *(UINT32
*)Targ
);
780 VerboseMsg ("R_X86_64_32S");
781 VerboseMsg ("Offset: 0x%08X, Addend: 0x%08X",
782 (UINT32
)(SecOffset
+ (Rel
->r_offset
- SecShdr
->sh_addr
)),
784 *(INT32
*)Targ
= (INT32
)((INT64
)(*(INT32
*)Targ
) - SymShdr
->sh_addr
+ mCoffSectionsOffset
[Sym
->st_shndx
]);
785 VerboseMsg ("Relocation: 0x%08X", *(UINT32
*)Targ
);
789 // Relative relocation: Symbol - Ip + Addend
791 VerboseMsg ("R_X86_64_PC32");
792 VerboseMsg ("Offset: 0x%08X, Addend: 0x%08X",
793 (UINT32
)(SecOffset
+ (Rel
->r_offset
- SecShdr
->sh_addr
)),
795 *(UINT32
*)Targ
= (UINT32
) (*(UINT32
*)Targ
796 + (mCoffSectionsOffset
[Sym
->st_shndx
] - SymShdr
->sh_addr
)
797 - (SecOffset
- SecShdr
->sh_addr
));
798 VerboseMsg ("Relocation: 0x%08X", *(UINT32
*)Targ
);
801 Error (NULL
, 0, 3000, "Invalid", "%s unsupported ELF EM_X86_64 relocation 0x%x.", mInImageName
, (unsigned) ELF_R_TYPE(Rel
->r_info
));
803 } else if (mEhdr
->e_machine
== EM_AARCH64
) {
805 switch (ELF_R_TYPE(Rel
->r_info
)) {
807 case R_AARCH64_ADR_PREL_PG_HI21
:
808 case R_AARCH64_ADD_ABS_LO12_NC
:
809 case R_AARCH64_LDST8_ABS_LO12_NC
:
810 case R_AARCH64_LDST16_ABS_LO12_NC
:
811 case R_AARCH64_LDST32_ABS_LO12_NC
:
812 case R_AARCH64_LDST64_ABS_LO12_NC
:
813 case R_AARCH64_LDST128_ABS_LO12_NC
:
815 // AArch64 PG_H21 relocations are typically paired with ABS_LO12
816 // relocations, where a PC-relative reference with +/- 4 GB range is
817 // split into a relative high part and an absolute low part. Since
818 // the absolute low part represents the offset into a 4 KB page, we
819 // have to make sure that the 4 KB relative offsets of both the
820 // section containing the reference as well as the section to which
821 // it refers have not been changed during PE/COFF conversion (i.e.,
822 // in ScanSections64() above).
824 if (((SecShdr
->sh_addr
^ SecOffset
) & 0xfff) != 0 ||
825 ((SymShdr
->sh_addr
^ mCoffSectionsOffset
[Sym
->st_shndx
]) & 0xfff) != 0 ||
826 mCoffAlignment
< 0x1000) {
827 Error (NULL
, 0, 3000, "Invalid", "WriteSections64(): %s AARCH64 small code model requires 4 KB section alignment.",
833 case R_AARCH64_ADR_PREL_LO21
:
834 case R_AARCH64_CONDBR19
:
835 case R_AARCH64_LD_PREL_LO19
:
836 case R_AARCH64_CALL26
:
837 case R_AARCH64_JUMP26
:
838 case R_AARCH64_PREL64
:
839 case R_AARCH64_PREL32
:
840 case R_AARCH64_PREL16
:
842 // The GCC toolchains (i.e., binutils) may corrupt section relative
843 // relocations when emitting relocation sections into fully linked
844 // binaries. More specifically, they tend to fail to take into
845 // account the fact that a '.rodata + XXX' relocation needs to have
846 // its addend recalculated once .rodata is merged into the .text
847 // section, and the relocation emitted into the .rela.text section.
849 // We cannot really recover from this loss of information, so the
850 // only workaround is to prevent having to recalculate any relative
851 // relocations at all, by using a linker script that ensures that
852 // the offset between the Place and the Symbol is the same in both
853 // the ELF and the PE/COFF versions of the binary.
855 if ((SymShdr
->sh_addr
- SecShdr
->sh_addr
) !=
856 (mCoffSectionsOffset
[Sym
->st_shndx
] - SecOffset
)) {
857 Error (NULL
, 0, 3000, "Invalid", "WriteSections64(): %s AARCH64 relative relocations require identical ELF and PE/COFF section offsets",
862 // Absolute relocations.
863 case R_AARCH64_ABS64
:
864 *(UINT64
*)Targ
= *(UINT64
*)Targ
- SymShdr
->sh_addr
+ mCoffSectionsOffset
[Sym
->st_shndx
];
868 Error (NULL
, 0, 3000, "Invalid", "WriteSections64(): %s unsupported ELF EM_AARCH64 relocation 0x%x.", mInImageName
, (unsigned) ELF_R_TYPE(Rel
->r_info
));
871 Error (NULL
, 0, 3000, "Invalid", "Not a supported machine type");
887 EFI_IMAGE_OPTIONAL_HEADER_UNION
*NtHdr
;
888 EFI_IMAGE_DATA_DIRECTORY
*Dir
;
890 for (Index
= 0; Index
< mEhdr
->e_shnum
; Index
++) {
891 Elf_Shdr
*RelShdr
= GetShdrByIndex(Index
);
892 if ((RelShdr
->sh_type
== SHT_REL
) || (RelShdr
->sh_type
== SHT_RELA
)) {
893 Elf_Shdr
*SecShdr
= GetShdrByIndex (RelShdr
->sh_info
);
894 if (IsTextShdr(SecShdr
) || IsDataShdr(SecShdr
)) {
897 for (RelIdx
= 0; RelIdx
< RelShdr
->sh_size
; RelIdx
+= RelShdr
->sh_entsize
) {
898 Elf_Rela
*Rel
= (Elf_Rela
*)((UINT8
*)mEhdr
+ RelShdr
->sh_offset
+ RelIdx
);
900 if (mEhdr
->e_machine
== EM_X86_64
) {
901 switch (ELF_R_TYPE(Rel
->r_info
)) {
906 VerboseMsg ("EFI_IMAGE_REL_BASED_DIR64 Offset: 0x%08X",
907 mCoffSectionsOffset
[RelShdr
->sh_info
] + (Rel
->r_offset
- SecShdr
->sh_addr
));
909 (UINT32
) ((UINT64
) mCoffSectionsOffset
[RelShdr
->sh_info
]
910 + (Rel
->r_offset
- SecShdr
->sh_addr
)),
911 EFI_IMAGE_REL_BASED_DIR64
);
915 VerboseMsg ("EFI_IMAGE_REL_BASED_HIGHLOW Offset: 0x%08X",
916 mCoffSectionsOffset
[RelShdr
->sh_info
] + (Rel
->r_offset
- SecShdr
->sh_addr
));
918 (UINT32
) ((UINT64
) mCoffSectionsOffset
[RelShdr
->sh_info
]
919 + (Rel
->r_offset
- SecShdr
->sh_addr
)),
920 EFI_IMAGE_REL_BASED_HIGHLOW
);
923 Error (NULL
, 0, 3000, "Invalid", "%s unsupported ELF EM_X86_64 relocation 0x%x.", mInImageName
, (unsigned) ELF_R_TYPE(Rel
->r_info
));
925 } else if (mEhdr
->e_machine
== EM_AARCH64
) {
927 switch (ELF_R_TYPE(Rel
->r_info
)) {
928 case R_AARCH64_ADR_PREL_LO21
:
929 case R_AARCH64_CONDBR19
:
930 case R_AARCH64_LD_PREL_LO19
:
931 case R_AARCH64_CALL26
:
932 case R_AARCH64_JUMP26
:
933 case R_AARCH64_PREL64
:
934 case R_AARCH64_PREL32
:
935 case R_AARCH64_PREL16
:
936 case R_AARCH64_ADR_PREL_PG_HI21
:
937 case R_AARCH64_ADD_ABS_LO12_NC
:
938 case R_AARCH64_LDST8_ABS_LO12_NC
:
939 case R_AARCH64_LDST16_ABS_LO12_NC
:
940 case R_AARCH64_LDST32_ABS_LO12_NC
:
941 case R_AARCH64_LDST64_ABS_LO12_NC
:
942 case R_AARCH64_LDST128_ABS_LO12_NC
:
944 // No fixups are required for relative relocations, provided that
945 // the relative offsets between sections have been preserved in
946 // the ELF to PE/COFF conversion. We have already asserted that
947 // this is the case in WriteSections64 ().
951 case R_AARCH64_ABS64
:
953 (UINT32
) ((UINT64
) mCoffSectionsOffset
[RelShdr
->sh_info
]
954 + (Rel
->r_offset
- SecShdr
->sh_addr
)),
955 EFI_IMAGE_REL_BASED_DIR64
);
958 case R_AARCH64_ABS32
:
960 (UINT32
) ((UINT64
) mCoffSectionsOffset
[RelShdr
->sh_info
]
961 + (Rel
->r_offset
- SecShdr
->sh_addr
)),
962 EFI_IMAGE_REL_BASED_HIGHLOW
);
966 Error (NULL
, 0, 3000, "Invalid", "WriteRelocations64(): %s unsupported ELF EM_AARCH64 relocation 0x%x.", mInImageName
, (unsigned) ELF_R_TYPE(Rel
->r_info
));
969 Error (NULL
, 0, 3000, "Not Supported", "This tool does not support relocations for ELF with e_machine %u (processor type).", (unsigned) mEhdr
->e_machine
);
977 // Pad by adding empty entries.
979 while (mCoffOffset
& (mCoffAlignment
- 1)) {
980 CoffAddFixupEntry(0);
983 NtHdr
= (EFI_IMAGE_OPTIONAL_HEADER_UNION
*)(mCoffFile
+ mNtHdrOffset
);
984 Dir
= &NtHdr
->Pe32Plus
.OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
];
985 Dir
->Size
= mCoffOffset
- mRelocOffset
;
986 if (Dir
->Size
== 0) {
987 // If no relocations, null out the directory entry and don't add the .reloc section
988 Dir
->VirtualAddress
= 0;
989 NtHdr
->Pe32Plus
.FileHeader
.NumberOfSections
--;
991 Dir
->VirtualAddress
= mRelocOffset
;
992 CreateSectionHeader (".reloc", mRelocOffset
, mCoffOffset
- mRelocOffset
,
993 EFI_IMAGE_SCN_CNT_INITIALIZED_DATA
994 | EFI_IMAGE_SCN_MEM_DISCARDABLE
995 | EFI_IMAGE_SCN_MEM_READ
);
1006 EFI_IMAGE_OPTIONAL_HEADER_UNION
*NtHdr
;
1007 EFI_IMAGE_DATA_DIRECTORY
*DataDir
;
1008 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*Dir
;
1009 EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY
*Nb10
;
1011 Len
= strlen(mInImageName
) + 1;
1013 Dir
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*)(mCoffFile
+ mDebugOffset
);
1014 Dir
->Type
= EFI_IMAGE_DEBUG_TYPE_CODEVIEW
;
1015 Dir
->SizeOfData
= sizeof(EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY
) + Len
;
1016 Dir
->RVA
= mDebugOffset
+ sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
);
1017 Dir
->FileOffset
= mDebugOffset
+ sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
);
1019 Nb10
= (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY
*)(Dir
+ 1);
1020 Nb10
->Signature
= CODEVIEW_SIGNATURE_NB10
;
1021 strcpy ((char *)(Nb10
+ 1), mInImageName
);
1024 NtHdr
= (EFI_IMAGE_OPTIONAL_HEADER_UNION
*)(mCoffFile
+ mNtHdrOffset
);
1025 DataDir
= &NtHdr
->Pe32Plus
.OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
];
1026 DataDir
->VirtualAddress
= mDebugOffset
;
1027 DataDir
->Size
= Dir
->SizeOfData
+ sizeof(EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
);
1036 EFI_IMAGE_OPTIONAL_HEADER_UNION
*NtHdr
;
1041 NtHdr
= (EFI_IMAGE_OPTIONAL_HEADER_UNION
*)(mCoffFile
+ mNtHdrOffset
);
1042 NtHdr
->Pe32Plus
.OptionalHeader
.SizeOfImage
= mCoffOffset
;
1051 if (mCoffSectionsOffset
!= NULL
) {
1052 free (mCoffSectionsOffset
);