3 Functions to get info and load PE/COFF image.
5 Copyright (c) 2004 - 2008, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include <Common/UefiBaseTypes.h>
17 #include <CommonLib.h>
18 #include <IndustryStandard/PeImage.h>
19 #include "PeCoffLib.h"
23 EFI_IMAGE_OPTIONAL_HEADER32
*Optional32
;
24 EFI_IMAGE_OPTIONAL_HEADER64
*Optional64
;
25 } EFI_IMAGE_OPTIONAL_HEADER_POINTER
;
29 PeCoffLoaderGetPeHeader (
30 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
31 OUT EFI_IMAGE_OPTIONAL_HEADER_UNION
**PeHdr
,
32 OUT EFI_TE_IMAGE_HEADER
**TeHdr
37 PeCoffLoaderCheckImageType (
38 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
39 IN EFI_IMAGE_OPTIONAL_HEADER_UNION
*PeHdr
,
40 IN EFI_TE_IMAGE_HEADER
*TeHdr
45 PeCoffLoaderImageAddress (
46 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
51 PeCoffLoaderRelocateIa32Image (
54 IN OUT CHAR8
**FixupData
,
59 PeCoffLoaderRelocateX64Image (
62 IN OUT CHAR8
**FixupData
,
67 PeCoffLoaderRelocateIpfImage (
70 IN OUT CHAR8
**FixupData
,
75 PeCoffLoaderRelocateArmImage (
78 IN OUT CHAR8
**FixupData
,
84 PeCoffLoaderGetPeHeader (
85 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
86 OUT EFI_IMAGE_OPTIONAL_HEADER_UNION
**PeHdr
,
87 OUT EFI_TE_IMAGE_HEADER
**TeHdr
93 Retrieves the PE or TE Header from a PE/COFF or TE image
97 ImageContext - The context of the image being loaded
99 PeHdr - The buffer in which to return the PE header
101 TeHdr - The buffer in which to return the TE header
105 RETURN_SUCCESS if the PE or TE Header is read,
106 Otherwise, the error status from reading the PE/COFF or TE image using the ImageRead function.
110 RETURN_STATUS Status
;
111 EFI_IMAGE_DOS_HEADER DosHdr
;
114 ImageContext
->IsTeImage
= FALSE
;
116 // Read the DOS image headers
118 Size
= sizeof (EFI_IMAGE_DOS_HEADER
);
119 Status
= ImageContext
->ImageRead (
120 ImageContext
->Handle
,
125 if (RETURN_ERROR (Status
)) {
126 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
130 ImageContext
->PeCoffHeaderOffset
= 0;
131 if (DosHdr
.e_magic
== EFI_IMAGE_DOS_SIGNATURE
) {
133 // DOS image header is present, so read the PE header after the DOS image header
135 ImageContext
->PeCoffHeaderOffset
= DosHdr
.e_lfanew
;
138 // Get the PE/COFF Header pointer
140 *PeHdr
= (EFI_IMAGE_OPTIONAL_HEADER_UNION
*) ((UINTN
)ImageContext
->Handle
+ ImageContext
->PeCoffHeaderOffset
);
141 if ((*PeHdr
)->Pe32
.Signature
!= EFI_IMAGE_NT_SIGNATURE
) {
143 // Check the PE/COFF Header Signature. If not, then try to get a TE header
145 *TeHdr
= (EFI_TE_IMAGE_HEADER
*)*PeHdr
;
146 if ((*TeHdr
)->Signature
!= EFI_TE_IMAGE_HEADER_SIGNATURE
) {
147 return RETURN_UNSUPPORTED
;
149 ImageContext
->IsTeImage
= TRUE
;
152 return RETURN_SUCCESS
;
157 PeCoffLoaderCheckImageType (
158 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
159 IN EFI_IMAGE_OPTIONAL_HEADER_UNION
*PeHdr
,
160 IN EFI_TE_IMAGE_HEADER
*TeHdr
166 Checks the PE or TE header of a PE/COFF or TE image to determine if it supported
170 ImageContext - The context of the image being loaded
172 PeHdr - The buffer in which to return the PE header
174 TeHdr - The buffer in which to return the TE header
178 RETURN_SUCCESS if the PE/COFF or TE image is supported
179 RETURN_UNSUPPORTED of the PE/COFF or TE image is not supported.
184 // See if the machine type is supported.
185 // We support a native machine type (IA-32/Itanium-based)
187 if (ImageContext
->IsTeImage
== FALSE
) {
188 ImageContext
->Machine
= PeHdr
->Pe32
.FileHeader
.Machine
;
190 ImageContext
->Machine
= TeHdr
->Machine
;
193 if (ImageContext
->Machine
!= EFI_IMAGE_MACHINE_IA32
&& \
194 ImageContext
->Machine
!= EFI_IMAGE_MACHINE_IA64
&& \
195 ImageContext
->Machine
!= EFI_IMAGE_MACHINE_X64
&& \
196 ImageContext
->Machine
!= EFI_IMAGE_MACHINE_ARMT
&& \
197 ImageContext
->Machine
!= EFI_IMAGE_MACHINE_EBC
) {
198 if (ImageContext
->Machine
== IMAGE_FILE_MACHINE_ARM
) {
200 // There are two types of ARM images. Pure ARM and ARM/Thumb.
201 // If we see the ARM say it is the ARM/Thumb so there is only
202 // a single machine type we need to check for ARM.
204 ImageContext
->Machine
= EFI_IMAGE_MACHINE_ARMT
;
205 if (ImageContext
->IsTeImage
== FALSE
) {
206 PeHdr
->Pe32
.FileHeader
.Machine
= ImageContext
->Machine
;
208 TeHdr
->Machine
= ImageContext
->Machine
;
213 // unsupported PeImage machine type
215 return RETURN_UNSUPPORTED
;
220 // See if the image type is supported. We support EFI Applications,
221 // EFI Boot Service Drivers, EFI Runtime Drivers and EFI SAL Drivers.
223 if (ImageContext
->IsTeImage
== FALSE
) {
224 ImageContext
->ImageType
= PeHdr
->Pe32
.OptionalHeader
.Subsystem
;
226 ImageContext
->ImageType
= (UINT16
) (TeHdr
->Subsystem
);
229 if (ImageContext
->ImageType
!= EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
&& \
230 ImageContext
->ImageType
!= EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER
&& \
231 ImageContext
->ImageType
!= EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
&& \
232 ImageContext
->ImageType
!= EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER
) {
234 // upsupported PeImage subsystem type
236 return RETURN_UNSUPPORTED
;
239 return RETURN_SUCCESS
;
244 PeCoffLoaderGetImageInfo (
245 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
251 Retrieves information on a PE/COFF image
255 This - Calling context
256 ImageContext - The context of the image being loaded
260 RETURN_SUCCESS - The information on the PE/COFF image was collected.
261 RETURN_INVALID_PARAMETER - ImageContext is NULL.
262 RETURN_UNSUPPORTED - The PE/COFF image is not supported.
263 Otherwise - The error status from reading the PE/COFF image using the
264 ImageContext->ImageRead() function
268 RETURN_STATUS Status
;
269 EFI_IMAGE_OPTIONAL_HEADER_UNION
*PeHdr
;
270 EFI_TE_IMAGE_HEADER
*TeHdr
;
271 EFI_IMAGE_DATA_DIRECTORY
*DebugDirectoryEntry
;
274 UINTN DebugDirectoryEntryRva
;
275 UINTN DebugDirectoryEntryFileOffset
;
276 UINTN SectionHeaderOffset
;
277 EFI_IMAGE_SECTION_HEADER SectionHeader
;
278 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY DebugEntry
;
279 EFI_IMAGE_OPTIONAL_HEADER_POINTER OptionHeader
;
283 DebugDirectoryEntry
= NULL
;
284 DebugDirectoryEntryRva
= 0;
286 if (NULL
== ImageContext
) {
287 return RETURN_INVALID_PARAMETER
;
292 ImageContext
->ImageError
= IMAGE_ERROR_SUCCESS
;
294 Status
= PeCoffLoaderGetPeHeader (ImageContext
, &PeHdr
, &TeHdr
);
295 if (RETURN_ERROR (Status
)) {
300 // Verify machine type
302 Status
= PeCoffLoaderCheckImageType (ImageContext
, PeHdr
, TeHdr
);
303 if (RETURN_ERROR (Status
)) {
306 OptionHeader
.Header
= (VOID
*) &(PeHdr
->Pe32
.OptionalHeader
);
309 // Retrieve the base address of the image
311 if (!(ImageContext
->IsTeImage
)) {
312 if (PeHdr
->Pe32
.OptionalHeader
.Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
313 ImageContext
->ImageAddress
= (PHYSICAL_ADDRESS
) OptionHeader
.Optional32
->ImageBase
;
315 ImageContext
->ImageAddress
= (PHYSICAL_ADDRESS
) OptionHeader
.Optional64
->ImageBase
;
318 ImageContext
->ImageAddress
= (PHYSICAL_ADDRESS
) (TeHdr
->ImageBase
+ TeHdr
->StrippedSize
- sizeof (EFI_TE_IMAGE_HEADER
));
321 // Initialize the alternate destination address to 0 indicating that it
322 // should not be used.
324 ImageContext
->DestinationAddress
= 0;
327 // Initialize the codeview pointer.
329 ImageContext
->CodeView
= NULL
;
330 ImageContext
->PdbPointer
= NULL
;
333 // Three cases with regards to relocations:
334 // - Image has base relocs, RELOCS_STRIPPED==0 => image is relocatable
335 // - Image has no base relocs, RELOCS_STRIPPED==1 => Image is not relocatable
336 // - Image has no base relocs, RELOCS_STRIPPED==0 => Image is relocatable but
337 // has no base relocs to apply
338 // Obviously having base relocations with RELOCS_STRIPPED==1 is invalid.
340 // Look at the file header to determine if relocations have been stripped, and
341 // save this info in the image context for later use.
343 if ((!(ImageContext
->IsTeImage
)) && ((PeHdr
->Pe32
.FileHeader
.Characteristics
& EFI_IMAGE_FILE_RELOCS_STRIPPED
) != 0)) {
344 ImageContext
->RelocationsStripped
= TRUE
;
345 } else if ((ImageContext
->IsTeImage
) && (TeHdr
->DataDirectory
[0].Size
== 0)) {
346 ImageContext
->RelocationsStripped
= TRUE
;
348 ImageContext
->RelocationsStripped
= FALSE
;
351 if (!(ImageContext
->IsTeImage
)) {
353 if (PeHdr
->Pe32
.OptionalHeader
.Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
354 ImageContext
->ImageSize
= (UINT64
) OptionHeader
.Optional32
->SizeOfImage
;
355 ImageContext
->SectionAlignment
= OptionHeader
.Optional32
->SectionAlignment
;
356 ImageContext
->SizeOfHeaders
= OptionHeader
.Optional32
->SizeOfHeaders
;
359 // Modify ImageSize to contain .PDB file name if required and initialize
362 if (OptionHeader
.Optional32
->NumberOfRvaAndSizes
> EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
) {
363 DebugDirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*) &(OptionHeader
.Optional32
->DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
]);
364 DebugDirectoryEntryRva
= DebugDirectoryEntry
->VirtualAddress
;
367 ImageContext
->ImageSize
= (UINT64
) OptionHeader
.Optional64
->SizeOfImage
;
368 ImageContext
->SectionAlignment
= OptionHeader
.Optional64
->SectionAlignment
;
369 ImageContext
->SizeOfHeaders
= OptionHeader
.Optional64
->SizeOfHeaders
;
372 // Modify ImageSize to contain .PDB file name if required and initialize
375 if (OptionHeader
.Optional64
->NumberOfRvaAndSizes
> EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
) {
376 DebugDirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*) &(OptionHeader
.Optional64
->DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
]);
377 DebugDirectoryEntryRva
= DebugDirectoryEntry
->VirtualAddress
;
381 if (DebugDirectoryEntryRva
!= 0) {
383 // Determine the file offset of the debug directory... This means we walk
384 // the sections to find which section contains the RVA of the debug
387 DebugDirectoryEntryFileOffset
= 0;
389 SectionHeaderOffset
= (UINTN
)(
390 ImageContext
->PeCoffHeaderOffset
+
392 sizeof (EFI_IMAGE_FILE_HEADER
) +
393 PeHdr
->Pe32
.FileHeader
.SizeOfOptionalHeader
396 for (Index
= 0; Index
< PeHdr
->Pe32
.FileHeader
.NumberOfSections
; Index
++) {
398 // Read section header from file
400 Size
= sizeof (EFI_IMAGE_SECTION_HEADER
);
401 Status
= ImageContext
->ImageRead (
402 ImageContext
->Handle
,
407 if (RETURN_ERROR (Status
)) {
408 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
412 if (DebugDirectoryEntryRva
>= SectionHeader
.VirtualAddress
&&
413 DebugDirectoryEntryRva
< SectionHeader
.VirtualAddress
+ SectionHeader
.Misc
.VirtualSize
) {
414 DebugDirectoryEntryFileOffset
=
415 DebugDirectoryEntryRva
- SectionHeader
.VirtualAddress
+ SectionHeader
.PointerToRawData
;
419 SectionHeaderOffset
+= sizeof (EFI_IMAGE_SECTION_HEADER
);
422 if (DebugDirectoryEntryFileOffset
!= 0) {
423 for (Index
= 0; Index
< DebugDirectoryEntry
->Size
; Index
+= sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
)) {
425 // Read next debug directory entry
427 Size
= sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
);
428 Status
= ImageContext
->ImageRead (
429 ImageContext
->Handle
,
430 DebugDirectoryEntryFileOffset
+ Index
,
434 if (RETURN_ERROR (Status
)) {
435 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
439 if (DebugEntry
.Type
== EFI_IMAGE_DEBUG_TYPE_CODEVIEW
) {
440 ImageContext
->DebugDirectoryEntryRva
= (UINT32
) (DebugDirectoryEntryRva
+ Index
);
441 if (DebugEntry
.RVA
== 0 && DebugEntry
.FileOffset
!= 0) {
442 ImageContext
->ImageSize
+= DebugEntry
.SizeOfData
;
445 return RETURN_SUCCESS
;
451 ImageContext
->ImageSize
= 0;
452 ImageContext
->SectionAlignment
= 4096;
453 ImageContext
->SizeOfHeaders
= sizeof (EFI_TE_IMAGE_HEADER
) + (UINTN
) TeHdr
->BaseOfCode
- (UINTN
) TeHdr
->StrippedSize
;
455 DebugDirectoryEntry
= &TeHdr
->DataDirectory
[1];
456 DebugDirectoryEntryRva
= DebugDirectoryEntry
->VirtualAddress
;
457 SectionHeaderOffset
= (UINTN
) (sizeof (EFI_TE_IMAGE_HEADER
));
459 DebugDirectoryEntryFileOffset
= 0;
461 for (Index
= 0; Index
< TeHdr
->NumberOfSections
;) {
463 // Read section header from file
465 Size
= sizeof (EFI_IMAGE_SECTION_HEADER
);
466 Status
= ImageContext
->ImageRead (
467 ImageContext
->Handle
,
472 if (RETURN_ERROR (Status
)) {
473 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
477 if (DebugDirectoryEntryRva
>= SectionHeader
.VirtualAddress
&&
478 DebugDirectoryEntryRva
< SectionHeader
.VirtualAddress
+ SectionHeader
.Misc
.VirtualSize
) {
479 DebugDirectoryEntryFileOffset
= DebugDirectoryEntryRva
-
480 SectionHeader
.VirtualAddress
+
481 SectionHeader
.PointerToRawData
+
482 sizeof (EFI_TE_IMAGE_HEADER
) -
486 // File offset of the debug directory was found, if this is not the last
487 // section, then skip to the last section for calculating the image size.
489 if (Index
< (UINTN
) TeHdr
->NumberOfSections
- 1) {
490 SectionHeaderOffset
+= (TeHdr
->NumberOfSections
- 1 - Index
) * sizeof (EFI_IMAGE_SECTION_HEADER
);
491 Index
= TeHdr
->NumberOfSections
- 1;
497 // In Te image header there is not a field to describe the ImageSize.
498 // Actually, the ImageSize equals the RVA plus the VirtualSize of
499 // the last section mapped into memory (Must be rounded up to
500 // a mulitple of Section Alignment). Per the PE/COFF specification, the
501 // section headers in the Section Table must appear in order of the RVA
502 // values for the corresponding sections. So the ImageSize can be determined
503 // by the RVA and the VirtualSize of the last section header in the
506 if ((++Index
) == (UINTN
) TeHdr
->NumberOfSections
) {
507 ImageContext
->ImageSize
= (SectionHeader
.VirtualAddress
+ SectionHeader
.Misc
.VirtualSize
+
508 ImageContext
->SectionAlignment
- 1) & ~(ImageContext
->SectionAlignment
- 1);
511 SectionHeaderOffset
+= sizeof (EFI_IMAGE_SECTION_HEADER
);
514 if (DebugDirectoryEntryFileOffset
!= 0) {
515 for (Index
= 0; Index
< DebugDirectoryEntry
->Size
; Index
+= sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
)) {
517 // Read next debug directory entry
519 Size
= sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
);
520 Status
= ImageContext
->ImageRead (
521 ImageContext
->Handle
,
522 DebugDirectoryEntryFileOffset
,
526 if (RETURN_ERROR (Status
)) {
527 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
531 if (DebugEntry
.Type
== EFI_IMAGE_DEBUG_TYPE_CODEVIEW
) {
532 ImageContext
->DebugDirectoryEntryRva
= (UINT32
) (DebugDirectoryEntryRva
+ Index
);
533 return RETURN_SUCCESS
;
539 return RETURN_SUCCESS
;
544 PeCoffLoaderImageAddress (
545 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
552 Converts an image address to the loaded address
556 ImageContext - The context of the image being loaded
558 Address - The address to be converted to the loaded address
562 NULL if the address can not be converted, otherwise, the converted address
566 if (Address
>= ImageContext
->ImageSize
) {
567 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_IMAGE_ADDRESS
;
571 return (UINT8
*) ((UINTN
) ImageContext
->ImageAddress
+ Address
);
576 PeCoffLoaderRelocateImage (
577 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
583 Relocates a PE/COFF image in memory
587 This - Calling context
589 ImageContext - Contains information on the loaded image to relocate
593 RETURN_SUCCESS if the PE/COFF image was relocated
594 RETURN_LOAD_ERROR if the image is not a valid PE/COFF image
595 RETURN_UNSUPPORTED not support
599 RETURN_STATUS Status
;
600 EFI_IMAGE_OPTIONAL_HEADER_UNION
*PeHdr
;
601 EFI_TE_IMAGE_HEADER
*TeHdr
;
602 EFI_IMAGE_DATA_DIRECTORY
*RelocDir
;
604 EFI_IMAGE_BASE_RELOCATION
*RelocBase
;
605 EFI_IMAGE_BASE_RELOCATION
*RelocBaseEnd
;
613 PHYSICAL_ADDRESS BaseAddress
;
615 EFI_IMAGE_OPTIONAL_HEADER_POINTER OptionHeader
;
622 ImageContext
->ImageError
= IMAGE_ERROR_SUCCESS
;
625 // If there are no relocation entries, then we are done
627 if (ImageContext
->RelocationsStripped
) {
628 return RETURN_SUCCESS
;
632 // If the destination address is not 0, use that rather than the
633 // image address as the relocation target.
635 if (ImageContext
->DestinationAddress
) {
636 BaseAddress
= ImageContext
->DestinationAddress
;
638 BaseAddress
= ImageContext
->ImageAddress
;
641 if (!(ImageContext
->IsTeImage
)) {
642 PeHdr
= (EFI_IMAGE_OPTIONAL_HEADER_UNION
*)((UINTN
)ImageContext
->ImageAddress
+
643 ImageContext
->PeCoffHeaderOffset
);
644 OptionHeader
.Header
= (VOID
*) &(PeHdr
->Pe32
.OptionalHeader
);
645 if (PeHdr
->Pe32
.OptionalHeader
.Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
646 Adjust
= (UINT64
) BaseAddress
- OptionHeader
.Optional32
->ImageBase
;
647 OptionHeader
.Optional32
->ImageBase
= (UINT32
) BaseAddress
;
648 MachineType
= ImageContext
->Machine
;
650 // Find the relocation block
652 // Per the PE/COFF spec, you can't assume that a given data directory
653 // is present in the image. You have to check the NumberOfRvaAndSizes in
654 // the optional header to verify a desired directory entry is there.
656 if (OptionHeader
.Optional32
->NumberOfRvaAndSizes
> EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
) {
657 RelocDir
= &OptionHeader
.Optional32
->DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
];
658 RelocBase
= PeCoffLoaderImageAddress (ImageContext
, RelocDir
->VirtualAddress
);
659 RelocBaseEnd
= PeCoffLoaderImageAddress (
661 RelocDir
->VirtualAddress
+ RelocDir
->Size
- 1
665 // Set base and end to bypass processing below.
667 RelocBase
= RelocBaseEnd
= 0;
670 Adjust
= (UINT64
) BaseAddress
- OptionHeader
.Optional64
->ImageBase
;
671 OptionHeader
.Optional64
->ImageBase
= BaseAddress
;
672 MachineType
= ImageContext
->Machine
;
674 // Find the relocation block
676 // Per the PE/COFF spec, you can't assume that a given data directory
677 // is present in the image. You have to check the NumberOfRvaAndSizes in
678 // the optional header to verify a desired directory entry is there.
680 if (OptionHeader
.Optional64
->NumberOfRvaAndSizes
> EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
) {
681 RelocDir
= &OptionHeader
.Optional64
->DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
];
682 RelocBase
= PeCoffLoaderImageAddress (ImageContext
, RelocDir
->VirtualAddress
);
683 RelocBaseEnd
= PeCoffLoaderImageAddress (
685 RelocDir
->VirtualAddress
+ RelocDir
->Size
- 1
689 // Set base and end to bypass processing below.
691 RelocBase
= RelocBaseEnd
= 0;
695 TeHdr
= (EFI_TE_IMAGE_HEADER
*) (UINTN
) (ImageContext
->ImageAddress
);
696 Adjust
= (UINT64
) (BaseAddress
- TeHdr
->ImageBase
);
697 TeHdr
->ImageBase
= (UINT64
) (BaseAddress
);
698 MachineType
= TeHdr
->Machine
;
701 // Find the relocation block
703 RelocDir
= &TeHdr
->DataDirectory
[0];
704 RelocBase
= (EFI_IMAGE_BASE_RELOCATION
*)(UINTN
)(
705 ImageContext
->ImageAddress
+
706 RelocDir
->VirtualAddress
+
707 sizeof(EFI_TE_IMAGE_HEADER
) -
710 RelocBaseEnd
= (EFI_IMAGE_BASE_RELOCATION
*) ((UINTN
) RelocBase
+ (UINTN
) RelocDir
->Size
- 1);
714 // Run the relocation information and apply the fixups
716 FixupData
= ImageContext
->FixupData
;
717 while (RelocBase
< RelocBaseEnd
) {
719 Reloc
= (UINT16
*) ((CHAR8
*) RelocBase
+ sizeof (EFI_IMAGE_BASE_RELOCATION
));
720 RelocEnd
= (UINT16
*) ((CHAR8
*) RelocBase
+ RelocBase
->SizeOfBlock
);
721 if (!(ImageContext
->IsTeImage
)) {
722 FixupBase
= PeCoffLoaderImageAddress (ImageContext
, RelocBase
->VirtualAddress
);
724 FixupBase
= (CHAR8
*)(UINTN
)(ImageContext
->ImageAddress
+
725 RelocBase
->VirtualAddress
+
726 sizeof(EFI_TE_IMAGE_HEADER
) -
731 if ((CHAR8
*) RelocEnd
< (CHAR8
*) ((UINTN
) ImageContext
->ImageAddress
) ||
732 (CHAR8
*) RelocEnd
> (CHAR8
*)((UINTN
)ImageContext
->ImageAddress
+
733 (UINTN
)ImageContext
->ImageSize
)) {
734 ImageContext
->ImageError
= IMAGE_ERROR_FAILED_RELOCATION
;
735 return RETURN_LOAD_ERROR
;
739 // Run this relocation record
741 while (Reloc
< RelocEnd
) {
743 Fixup
= FixupBase
+ (*Reloc
& 0xFFF);
744 switch ((*Reloc
) >> 12) {
745 case EFI_IMAGE_REL_BASED_ABSOLUTE
:
748 case EFI_IMAGE_REL_BASED_HIGH
:
749 F16
= (UINT16
*) Fixup
;
750 *F16
= (UINT16
) (*F16
+ ((UINT16
) ((UINT32
) Adjust
>> 16)));
751 if (FixupData
!= NULL
) {
752 *(UINT16
*) FixupData
= *F16
;
753 FixupData
= FixupData
+ sizeof (UINT16
);
757 case EFI_IMAGE_REL_BASED_LOW
:
758 F16
= (UINT16
*) Fixup
;
759 *F16
= (UINT16
) (*F16
+ (UINT16
) Adjust
);
760 if (FixupData
!= NULL
) {
761 *(UINT16
*) FixupData
= *F16
;
762 FixupData
= FixupData
+ sizeof (UINT16
);
766 case EFI_IMAGE_REL_BASED_HIGHLOW
:
767 F32
= (UINT32
*) Fixup
;
768 *F32
= *F32
+ (UINT32
) Adjust
;
769 if (FixupData
!= NULL
) {
770 FixupData
= ALIGN_POINTER (FixupData
, sizeof (UINT32
));
771 *(UINT32
*) FixupData
= *F32
;
772 FixupData
= FixupData
+ sizeof (UINT32
);
776 case EFI_IMAGE_REL_BASED_HIGHADJ
:
778 // Return the same EFI_UNSUPPORTED return code as
779 // PeCoffLoaderRelocateImageEx() returns if it does not recognize
780 // the relocation type.
782 ImageContext
->ImageError
= IMAGE_ERROR_FAILED_RELOCATION
;
783 return RETURN_UNSUPPORTED
;
786 switch (MachineType
) {
787 case EFI_IMAGE_MACHINE_IA32
:
788 Status
= PeCoffLoaderRelocateIa32Image (Reloc
, Fixup
, &FixupData
, Adjust
);
790 case EFI_IMAGE_MACHINE_ARMT
:
791 Status
= PeCoffLoaderRelocateArmImage (&Reloc
, Fixup
, &FixupData
, Adjust
);
793 case EFI_IMAGE_MACHINE_X64
:
794 Status
= PeCoffLoaderRelocateX64Image (Reloc
, Fixup
, &FixupData
, Adjust
);
796 case EFI_IMAGE_MACHINE_IA64
:
797 Status
= PeCoffLoaderRelocateIpfImage (Reloc
, Fixup
, &FixupData
, Adjust
);
800 Status
= RETURN_UNSUPPORTED
;
803 if (RETURN_ERROR (Status
)) {
804 ImageContext
->ImageError
= IMAGE_ERROR_FAILED_RELOCATION
;
810 // Next relocation record
818 RelocBase
= (EFI_IMAGE_BASE_RELOCATION
*) RelocEnd
;
821 return RETURN_SUCCESS
;
826 PeCoffLoaderLoadImage (
827 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
833 Loads a PE/COFF image into memory
837 This - Calling context
839 ImageContext - Contains information on image to load into memory
843 RETURN_SUCCESS if the PE/COFF image was loaded
844 RETURN_BUFFER_TOO_SMALL if the caller did not provide a large enough buffer
845 RETURN_LOAD_ERROR if the image is a runtime driver with no relocations
846 RETURN_INVALID_PARAMETER if the image address is invalid
850 RETURN_STATUS Status
;
851 EFI_IMAGE_OPTIONAL_HEADER_UNION
*PeHdr
;
852 EFI_TE_IMAGE_HEADER
*TeHdr
;
853 PE_COFF_LOADER_IMAGE_CONTEXT CheckContext
;
854 EFI_IMAGE_SECTION_HEADER
*FirstSection
;
855 EFI_IMAGE_SECTION_HEADER
*Section
;
856 UINTN NumberOfSections
;
861 EFI_IMAGE_DATA_DIRECTORY
*DirectoryEntry
;
862 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*DebugEntry
;
864 UINT32 TempDebugEntryRva
;
865 EFI_IMAGE_OPTIONAL_HEADER_POINTER OptionHeader
;
869 OptionHeader
.Header
= NULL
;
873 ImageContext
->ImageError
= IMAGE_ERROR_SUCCESS
;
876 // Copy the provided context info into our local version, get what we
877 // can from the original image, and then use that to make sure everything
880 CopyMem (&CheckContext
, ImageContext
, sizeof (PE_COFF_LOADER_IMAGE_CONTEXT
));
882 Status
= PeCoffLoaderGetImageInfo (&CheckContext
);
883 if (RETURN_ERROR (Status
)) {
888 // Make sure there is enough allocated space for the image being loaded
890 if (ImageContext
->ImageSize
< CheckContext
.ImageSize
) {
891 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_IMAGE_SIZE
;
892 return RETURN_BUFFER_TOO_SMALL
;
896 // If there's no relocations, then make sure it's not a runtime driver,
897 // and that it's being loaded at the linked address.
899 if (CheckContext
.RelocationsStripped
) {
901 // If the image does not contain relocations and it is a runtime driver
902 // then return an error.
904 if (CheckContext
.ImageType
== EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
) {
905 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_SUBSYSTEM
;
906 return RETURN_LOAD_ERROR
;
909 // If the image does not contain relocations, and the requested load address
910 // is not the linked address, then return an error.
912 if (CheckContext
.ImageAddress
!= ImageContext
->ImageAddress
) {
913 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_IMAGE_ADDRESS
;
914 return RETURN_INVALID_PARAMETER
;
918 // Make sure the allocated space has the proper section alignment
920 if (!(ImageContext
->IsTeImage
)) {
921 if ((ImageContext
->ImageAddress
& (CheckContext
.SectionAlignment
- 1)) != 0) {
922 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_SECTION_ALIGNMENT
;
923 return RETURN_INVALID_PARAMETER
;
927 // Read the entire PE/COFF or TE header into memory
929 if (!(ImageContext
->IsTeImage
)) {
930 Status
= ImageContext
->ImageRead (
931 ImageContext
->Handle
,
933 &ImageContext
->SizeOfHeaders
,
934 (VOID
*) (UINTN
) ImageContext
->ImageAddress
937 PeHdr
= (EFI_IMAGE_OPTIONAL_HEADER_UNION
*)
938 ((UINTN
)ImageContext
->ImageAddress
+ ImageContext
->PeCoffHeaderOffset
);
940 OptionHeader
.Header
= (VOID
*) &(PeHdr
->Pe32
.OptionalHeader
);
942 FirstSection
= (EFI_IMAGE_SECTION_HEADER
*) (
943 (UINTN
)ImageContext
->ImageAddress
+
944 ImageContext
->PeCoffHeaderOffset
+
946 sizeof(EFI_IMAGE_FILE_HEADER
) +
947 PeHdr
->Pe32
.FileHeader
.SizeOfOptionalHeader
949 NumberOfSections
= (UINTN
) (PeHdr
->Pe32
.FileHeader
.NumberOfSections
);
951 Status
= ImageContext
->ImageRead (
952 ImageContext
->Handle
,
954 &ImageContext
->SizeOfHeaders
,
955 (VOID
*) (UINTN
) ImageContext
->ImageAddress
958 TeHdr
= (EFI_TE_IMAGE_HEADER
*) (UINTN
) (ImageContext
->ImageAddress
);
960 FirstSection
= (EFI_IMAGE_SECTION_HEADER
*) (
961 (UINTN
)ImageContext
->ImageAddress
+
962 sizeof(EFI_TE_IMAGE_HEADER
)
964 NumberOfSections
= (UINTN
) (TeHdr
->NumberOfSections
);
968 if (RETURN_ERROR (Status
)) {
969 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
970 return RETURN_LOAD_ERROR
;
974 // Load each section of the image
976 Section
= FirstSection
;
977 for (Index
= 0, MaxEnd
= NULL
; Index
< NumberOfSections
; Index
++) {
980 // Compute sections address
982 Base
= PeCoffLoaderImageAddress (ImageContext
, Section
->VirtualAddress
);
983 End
= PeCoffLoaderImageAddress (
985 Section
->VirtualAddress
+ Section
->Misc
.VirtualSize
- 1
987 if (ImageContext
->IsTeImage
) {
988 Base
= (CHAR8
*) ((UINTN
) Base
+ sizeof (EFI_TE_IMAGE_HEADER
) - (UINTN
) TeHdr
->StrippedSize
);
989 End
= (CHAR8
*) ((UINTN
) End
+ sizeof (EFI_TE_IMAGE_HEADER
) - (UINTN
) TeHdr
->StrippedSize
);
996 // If the base start or end address resolved to 0, then fail.
998 if ((Base
== NULL
) || (End
== NULL
)) {
999 ImageContext
->ImageError
= IMAGE_ERROR_SECTION_NOT_LOADED
;
1000 return RETURN_LOAD_ERROR
;
1006 Size
= (UINTN
) Section
->Misc
.VirtualSize
;
1007 if ((Size
== 0) || (Size
> Section
->SizeOfRawData
)) {
1008 Size
= (UINTN
) Section
->SizeOfRawData
;
1011 if (Section
->SizeOfRawData
) {
1012 if (!(ImageContext
->IsTeImage
)) {
1013 Status
= ImageContext
->ImageRead (
1014 ImageContext
->Handle
,
1015 Section
->PointerToRawData
,
1020 Status
= ImageContext
->ImageRead (
1021 ImageContext
->Handle
,
1022 Section
->PointerToRawData
+ sizeof (EFI_TE_IMAGE_HEADER
) - (UINTN
) TeHdr
->StrippedSize
,
1028 if (RETURN_ERROR (Status
)) {
1029 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
1035 // If raw size is less then virt size, zero fill the remaining
1038 if (Size
< Section
->Misc
.VirtualSize
) {
1039 ZeroMem (Base
+ Size
, Section
->Misc
.VirtualSize
- Size
);
1049 // Get image's entry point
1051 if (!(ImageContext
->IsTeImage
)) {
1052 ImageContext
->EntryPoint
= (PHYSICAL_ADDRESS
) (UINTN
) PeCoffLoaderImageAddress (
1054 PeHdr
->Pe32
.OptionalHeader
.AddressOfEntryPoint
1057 ImageContext
->EntryPoint
= (PHYSICAL_ADDRESS
) (
1058 (UINTN
)ImageContext
->ImageAddress
+
1059 (UINTN
)TeHdr
->AddressOfEntryPoint
+
1060 (UINTN
)sizeof(EFI_TE_IMAGE_HEADER
) -
1061 (UINTN
) TeHdr
->StrippedSize
1066 // Determine the size of the fixup data
1068 // Per the PE/COFF spec, you can't assume that a given data directory
1069 // is present in the image. You have to check the NumberOfRvaAndSizes in
1070 // the optional header to verify a desired directory entry is there.
1072 if (!(ImageContext
->IsTeImage
)) {
1073 if (PeHdr
->Pe32
.OptionalHeader
.Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
1074 if (OptionHeader
.Optional32
->NumberOfRvaAndSizes
> EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
) {
1075 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)
1076 &OptionHeader
.Optional32
->DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
];
1077 ImageContext
->FixupDataSize
= DirectoryEntry
->Size
/ sizeof (UINT16
) * sizeof (UINTN
);
1079 ImageContext
->FixupDataSize
= 0;
1082 if (OptionHeader
.Optional64
->NumberOfRvaAndSizes
> EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
) {
1083 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)
1084 &OptionHeader
.Optional64
->DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
];
1085 ImageContext
->FixupDataSize
= DirectoryEntry
->Size
/ sizeof (UINT16
) * sizeof (UINTN
);
1087 ImageContext
->FixupDataSize
= 0;
1091 DirectoryEntry
= &TeHdr
->DataDirectory
[0];
1092 ImageContext
->FixupDataSize
= DirectoryEntry
->Size
/ sizeof (UINT16
) * sizeof (UINTN
);
1095 // Consumer must allocate a buffer for the relocation fixup log.
1096 // Only used for runtime drivers.
1098 ImageContext
->FixupData
= NULL
;
1101 // Load the Codeview info if present
1103 if (ImageContext
->DebugDirectoryEntryRva
!= 0) {
1104 if (!(ImageContext
->IsTeImage
)) {
1105 DebugEntry
= PeCoffLoaderImageAddress (
1107 ImageContext
->DebugDirectoryEntryRva
1110 DebugEntry
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*)(UINTN
)(
1111 ImageContext
->ImageAddress
+
1112 ImageContext
->DebugDirectoryEntryRva
+
1113 sizeof(EFI_TE_IMAGE_HEADER
) -
1118 if (DebugEntry
!= NULL
) {
1119 TempDebugEntryRva
= DebugEntry
->RVA
;
1120 if (DebugEntry
->RVA
== 0 && DebugEntry
->FileOffset
!= 0) {
1122 if ((UINTN
) Section
->SizeOfRawData
< Section
->Misc
.VirtualSize
) {
1123 TempDebugEntryRva
= Section
->VirtualAddress
+ Section
->Misc
.VirtualSize
;
1125 TempDebugEntryRva
= Section
->VirtualAddress
+ Section
->SizeOfRawData
;
1129 if (TempDebugEntryRva
!= 0) {
1130 if (!(ImageContext
->IsTeImage
)) {
1131 ImageContext
->CodeView
= PeCoffLoaderImageAddress (ImageContext
, TempDebugEntryRva
);
1133 ImageContext
->CodeView
= (VOID
*)(
1134 (UINTN
)ImageContext
->ImageAddress
+
1135 (UINTN
)TempDebugEntryRva
+
1136 (UINTN
)sizeof(EFI_TE_IMAGE_HEADER
) -
1137 (UINTN
) TeHdr
->StrippedSize
1141 if (ImageContext
->CodeView
== NULL
) {
1142 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
1143 return RETURN_LOAD_ERROR
;
1146 if (DebugEntry
->RVA
== 0) {
1147 Size
= DebugEntry
->SizeOfData
;
1148 if (!(ImageContext
->IsTeImage
)) {
1149 Status
= ImageContext
->ImageRead (
1150 ImageContext
->Handle
,
1151 DebugEntry
->FileOffset
,
1153 ImageContext
->CodeView
1156 Status
= ImageContext
->ImageRead (
1157 ImageContext
->Handle
,
1158 DebugEntry
->FileOffset
+ sizeof (EFI_TE_IMAGE_HEADER
) - TeHdr
->StrippedSize
,
1160 ImageContext
->CodeView
1163 // Should we apply fix up to this field according to the size difference between PE and TE?
1164 // Because now we maintain TE header fields unfixed, this field will also remain as they are
1165 // in original PE image.
1169 if (RETURN_ERROR (Status
)) {
1170 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
1171 return RETURN_LOAD_ERROR
;
1174 DebugEntry
->RVA
= TempDebugEntryRva
;
1177 switch (*(UINT32
*) ImageContext
->CodeView
) {
1178 case CODEVIEW_SIGNATURE_NB10
:
1179 ImageContext
->PdbPointer
= (CHAR8
*) ImageContext
->CodeView
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY
);
1182 case CODEVIEW_SIGNATURE_RSDS
:
1183 ImageContext
->PdbPointer
= (CHAR8
*) ImageContext
->CodeView
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY
);
1186 case CODEVIEW_SIGNATURE_MTOC
:
1187 ImageContext
->PdbPointer
= (CHAR8
*) ImageContext
->CodeView
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY
);
1200 Returns a pointer to the PDB file name for a raw PE/COFF image that is not
1201 loaded into system memory with the PE/COFF Loader Library functions.
1203 Returns the PDB file name for the PE/COFF image specified by Pe32Data. If
1204 the PE/COFF image specified by Pe32Data is not a valid, then NULL is
1205 returned. If the PE/COFF image specified by Pe32Data does not contain a
1206 debug directory entry, then NULL is returned. If the debug directory entry
1207 in the PE/COFF image specified by Pe32Data does not contain a PDB file name,
1208 then NULL is returned.
1209 If Pe32Data is NULL, then return NULL.
1211 @param Pe32Data Pointer to the PE/COFF image that is loaded in system
1214 @return The PDB file name for the PE/COFF image specified by Pe32Data or NULL
1215 if it cannot be retrieved.
1220 PeCoffLoaderGetPdbPointer (
1224 EFI_IMAGE_DOS_HEADER
*DosHdr
;
1225 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
1226 EFI_IMAGE_DATA_DIRECTORY
*DirectoryEntry
;
1227 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*DebugEntry
;
1229 VOID
*CodeViewEntryPointer
;
1231 UINT32 NumberOfRvaAndSizes
;
1233 EFI_IMAGE_SECTION_HEADER
*SectionHeader
;
1234 UINT32 Index
, Index1
;
1236 if (Pe32Data
== NULL
) {
1241 DirectoryEntry
= NULL
;
1243 NumberOfRvaAndSizes
= 0;
1246 SectionHeader
= NULL
;
1248 DosHdr
= (EFI_IMAGE_DOS_HEADER
*)Pe32Data
;
1249 if (EFI_IMAGE_DOS_SIGNATURE
== DosHdr
->e_magic
) {
1251 // DOS image header is present, so read the PE header after the DOS image header.
1253 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
) Pe32Data
+ (UINTN
) ((DosHdr
->e_lfanew
) & 0x0ffff));
1256 // DOS image header is not present, so PE header is at the image base.
1258 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)Pe32Data
;
1261 if (EFI_TE_IMAGE_HEADER_SIGNATURE
== Hdr
.Te
->Signature
) {
1262 if (Hdr
.Te
->DataDirectory
[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG
].VirtualAddress
!= 0) {
1263 DirectoryEntry
= &Hdr
.Te
->DataDirectory
[EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG
];
1264 TEImageAdjust
= sizeof (EFI_TE_IMAGE_HEADER
) - Hdr
.Te
->StrippedSize
;
1267 // Get the DebugEntry offset in the raw data image.
1269 SectionHeader
= (EFI_IMAGE_SECTION_HEADER
*) (Hdr
.Te
+ 1);
1270 Index
= Hdr
.Te
->NumberOfSections
;
1271 for (Index1
= 0; Index1
< Index
; Index1
++) {
1272 if ((DirectoryEntry
->VirtualAddress
>= SectionHeader
[Index1
].VirtualAddress
) &&
1273 (DirectoryEntry
->VirtualAddress
< (SectionHeader
[Index1
].VirtualAddress
+ SectionHeader
[Index1
].Misc
.VirtualSize
))) {
1274 DebugEntry
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*)((UINTN
) Hdr
.Te
+
1275 DirectoryEntry
->VirtualAddress
-
1276 SectionHeader
[Index1
].VirtualAddress
+
1277 SectionHeader
[Index1
].PointerToRawData
+
1283 } else if (EFI_IMAGE_NT_SIGNATURE
== Hdr
.Pe32
->Signature
) {
1285 // NOTE: We use Machine field to identify PE32/PE32+, instead of Magic.
1286 // It is due to backward-compatibility, for some system might
1287 // generate PE32+ image with PE32 Magic.
1289 switch (Hdr
.Pe32
->FileHeader
.Machine
) {
1290 case EFI_IMAGE_MACHINE_IA32
:
1291 case EFI_IMAGE_MACHINE_ARMT
:
1293 // Assume PE32 image with IA32 Machine field.
1295 Magic
= EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
;
1297 case EFI_IMAGE_MACHINE_X64
:
1298 case EFI_IMAGE_MACHINE_IPF
:
1300 // Assume PE32+ image with X64 or IPF Machine field
1302 Magic
= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
;
1306 // For unknow Machine field, use Magic in optional Header
1308 Magic
= Hdr
.Pe32
->OptionalHeader
.Magic
;
1311 SectionHeader
= (EFI_IMAGE_SECTION_HEADER
*) (
1312 (UINT8
*) Hdr
.Pe32
+
1314 sizeof (EFI_IMAGE_FILE_HEADER
) +
1315 Hdr
.Pe32
->FileHeader
.SizeOfOptionalHeader
1317 Index
= Hdr
.Pe32
->FileHeader
.NumberOfSections
;
1319 if (EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
== Magic
) {
1321 // Use PE32 offset get Debug Directory Entry
1323 NumberOfRvaAndSizes
= Hdr
.Pe32
->OptionalHeader
.NumberOfRvaAndSizes
;
1324 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&(Hdr
.Pe32
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
]);
1325 } else if (Hdr
.Pe32
->OptionalHeader
.Magic
== EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
) {
1327 // Use PE32+ offset get Debug Directory Entry
1329 NumberOfRvaAndSizes
= Hdr
.Pe32Plus
->OptionalHeader
.NumberOfRvaAndSizes
;
1330 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&(Hdr
.Pe32Plus
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
]);
1333 if (NumberOfRvaAndSizes
<= EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
|| DirectoryEntry
->VirtualAddress
== 0) {
1334 DirectoryEntry
= NULL
;
1338 // Get the DebugEntry offset in the raw data image.
1340 for (Index1
= 0; Index1
< Index
; Index1
++) {
1341 if ((DirectoryEntry
->VirtualAddress
>= SectionHeader
[Index1
].VirtualAddress
) &&
1342 (DirectoryEntry
->VirtualAddress
< (SectionHeader
[Index1
].VirtualAddress
+ SectionHeader
[Index1
].Misc
.VirtualSize
))) {
1343 DebugEntry
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*) (
1345 DirectoryEntry
->VirtualAddress
-
1346 SectionHeader
[Index1
].VirtualAddress
+
1347 SectionHeader
[Index1
].PointerToRawData
);
1356 if (NULL
== DebugEntry
|| NULL
== DirectoryEntry
) {
1361 // Scan the directory to find the debug entry.
1363 for (DirCount
= 0; DirCount
< DirectoryEntry
->Size
; DirCount
+= sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
), DebugEntry
++) {
1364 if (EFI_IMAGE_DEBUG_TYPE_CODEVIEW
== DebugEntry
->Type
) {
1365 if (DebugEntry
->SizeOfData
> 0) {
1367 // Get the DebugEntry offset in the raw data image.
1369 CodeViewEntryPointer
= NULL
;
1370 for (Index1
= 0; Index1
< Index
; Index1
++) {
1371 if ((DebugEntry
->RVA
>= SectionHeader
[Index1
].VirtualAddress
) &&
1372 (DebugEntry
->RVA
< (SectionHeader
[Index1
].VirtualAddress
+ SectionHeader
[Index1
].Misc
.VirtualSize
))) {
1373 CodeViewEntryPointer
= (VOID
*) (
1375 (UINTN
) DebugEntry
->RVA
-
1376 SectionHeader
[Index1
].VirtualAddress
+
1377 SectionHeader
[Index1
].PointerToRawData
+
1378 (UINTN
)TEImageAdjust
);
1382 if (Index1
>= Index
) {
1384 // Can't find CodeViewEntryPointer in raw PE/COFF image.
1388 switch (* (UINT32
*) CodeViewEntryPointer
) {
1389 case CODEVIEW_SIGNATURE_NB10
:
1390 return (VOID
*) ((CHAR8
*)CodeViewEntryPointer
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY
));
1391 case CODEVIEW_SIGNATURE_RSDS
:
1392 return (VOID
*) ((CHAR8
*)CodeViewEntryPointer
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY
));
1393 case CODEVIEW_SIGNATURE_MTOC
:
1394 return (VOID
*) ((CHAR8
*)CodeViewEntryPointer
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY
));
1408 PeCoffLoaderGetEntryPoint (
1410 OUT VOID
**EntryPoint
,
1411 OUT VOID
**BaseOfImage
1414 EFI_IMAGE_DOS_HEADER
*DosHdr
;
1415 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
1417 DosHdr
= (EFI_IMAGE_DOS_HEADER
*)Pe32Data
;
1418 if (DosHdr
->e_magic
== EFI_IMAGE_DOS_SIGNATURE
) {
1420 // DOS image header is present, so read the PE header after the DOS image header.
1422 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
) Pe32Data
+ (UINTN
) ((DosHdr
->e_lfanew
) & 0x0ffff));
1425 // DOS image header is not present, so PE header is at the image base.
1427 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)Pe32Data
;
1431 // Calculate the entry point relative to the start of the image.
1432 // AddressOfEntryPoint is common for PE32 & PE32+
1434 if (Hdr
.Te
->Signature
== EFI_TE_IMAGE_HEADER_SIGNATURE
) {
1435 *BaseOfImage
= (VOID
*)(UINTN
)(Hdr
.Te
->ImageBase
+ Hdr
.Te
->StrippedSize
- sizeof (EFI_TE_IMAGE_HEADER
));
1436 *EntryPoint
= (VOID
*)((UINTN
)*BaseOfImage
+ (Hdr
.Te
->AddressOfEntryPoint
& 0x0ffffffff) + sizeof(EFI_TE_IMAGE_HEADER
) - Hdr
.Te
->StrippedSize
);
1437 return RETURN_SUCCESS
;
1438 } else if (Hdr
.Pe32
->Signature
== EFI_IMAGE_NT_SIGNATURE
) {
1439 *EntryPoint
= (VOID
*)(UINTN
)Hdr
.Pe32
->OptionalHeader
.AddressOfEntryPoint
;
1440 if (Hdr
.Pe32
->OptionalHeader
.Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
1441 *BaseOfImage
= (VOID
*)(UINTN
)Hdr
.Pe32
->OptionalHeader
.ImageBase
;
1443 *BaseOfImage
= (VOID
*)(UINTN
)Hdr
.Pe32Plus
->OptionalHeader
.ImageBase
;
1445 *EntryPoint
= (VOID
*)(UINTN
)((UINTN
)*EntryPoint
+ (UINTN
)*BaseOfImage
);
1446 return RETURN_SUCCESS
;
1449 return RETURN_UNSUPPORTED
;