2 Base PE/COFF loader supports loading any PE32/PE32+ or TE image, but
3 only supports relocating IA32, x64, IPF, and EBC images.
5 Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
6 Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this 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 "BasePeCoffLibInternals.h"
20 Retrieves the magic value from the PE/COFF header.
22 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.
24 @return EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC - Image is PE32
25 @return EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC - Image is PE32+
29 PeCoffLoaderGetPeHeaderMagicValue (
30 IN EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
34 // NOTE: Some versions of Linux ELILO for Itanium have an incorrect magic value
35 // in the PE/COFF Header. If the MachineType is Itanium(IA64) and the
36 // Magic value in the OptionalHeader is EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
37 // then override the returned value to EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
39 if (Hdr
.Pe32
->FileHeader
.Machine
== IMAGE_FILE_MACHINE_IA64
&& Hdr
.Pe32
->OptionalHeader
.Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
40 return EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
;
43 // Return the magic value from the PC/COFF Optional Header
45 return Hdr
.Pe32
->OptionalHeader
.Magic
;
50 Retrieves the PE or TE Header from a PE/COFF or TE image.
52 @param ImageContext The context of the image being loaded.
53 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.
55 @retval RETURN_SUCCESS The PE or TE Header is read.
56 @retval Other The error status from reading the PE/COFF or TE image using the ImageRead function.
60 PeCoffLoaderGetPeHeader (
61 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
62 OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
66 EFI_IMAGE_DOS_HEADER DosHdr
;
71 // Read the DOS image header to check for its existence
73 Size
= sizeof (EFI_IMAGE_DOS_HEADER
);
74 Status
= ImageContext
->ImageRead (
80 if (RETURN_ERROR (Status
)) {
81 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
85 ImageContext
->PeCoffHeaderOffset
= 0;
86 if (DosHdr
.e_magic
== EFI_IMAGE_DOS_SIGNATURE
) {
88 // DOS image header is present, so read the PE header after the DOS image
91 ImageContext
->PeCoffHeaderOffset
= DosHdr
.e_lfanew
;
95 // Read the PE/COFF Header. For PE32 (32-bit) this will read in too much
96 // data, but that should not hurt anything. Hdr.Pe32->OptionalHeader.Magic
97 // determines if this is a PE32 or PE32+ image. The magic is in the same
98 // location in both images.
100 Size
= sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION
);
101 Status
= ImageContext
->ImageRead (
102 ImageContext
->Handle
,
103 ImageContext
->PeCoffHeaderOffset
,
107 if (RETURN_ERROR (Status
)) {
108 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
113 // Use Signature to figure out if we understand the image format
115 if (Hdr
.Te
->Signature
== EFI_TE_IMAGE_HEADER_SIGNATURE
) {
116 ImageContext
->IsTeImage
= TRUE
;
117 ImageContext
->Machine
= Hdr
.Te
->Machine
;
118 ImageContext
->ImageType
= (UINT16
)(Hdr
.Te
->Subsystem
);
120 // For TeImage, SectionAlignment is undefined to be set to Zero
121 // ImageSize can be calculated.
123 ImageContext
->ImageSize
= 0;
124 ImageContext
->SectionAlignment
= 0;
125 ImageContext
->SizeOfHeaders
= sizeof (EFI_TE_IMAGE_HEADER
) + (UINTN
)Hdr
.Te
->BaseOfCode
- (UINTN
)Hdr
.Te
->StrippedSize
;
127 } else if (Hdr
.Pe32
->Signature
== EFI_IMAGE_NT_SIGNATURE
) {
128 ImageContext
->IsTeImage
= FALSE
;
129 ImageContext
->Machine
= Hdr
.Pe32
->FileHeader
.Machine
;
131 Magic
= PeCoffLoaderGetPeHeaderMagicValue (Hdr
);
133 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
137 ImageContext
->ImageType
= Hdr
.Pe32
->OptionalHeader
.Subsystem
;
138 ImageContext
->ImageSize
= (UINT64
)Hdr
.Pe32
->OptionalHeader
.SizeOfImage
;
139 ImageContext
->SectionAlignment
= Hdr
.Pe32
->OptionalHeader
.SectionAlignment
;
140 ImageContext
->SizeOfHeaders
= Hdr
.Pe32
->OptionalHeader
.SizeOfHeaders
;
142 } else if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
) {
146 ImageContext
->ImageType
= Hdr
.Pe32Plus
->OptionalHeader
.Subsystem
;
147 ImageContext
->ImageSize
= (UINT64
) Hdr
.Pe32Plus
->OptionalHeader
.SizeOfImage
;
148 ImageContext
->SectionAlignment
= Hdr
.Pe32Plus
->OptionalHeader
.SectionAlignment
;
149 ImageContext
->SizeOfHeaders
= Hdr
.Pe32Plus
->OptionalHeader
.SizeOfHeaders
;
151 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_MACHINE_TYPE
;
152 return RETURN_UNSUPPORTED
;
155 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_MACHINE_TYPE
;
156 return RETURN_UNSUPPORTED
;
159 if (!PeCoffLoaderImageFormatSupported (ImageContext
->Machine
)) {
161 // If the PE/COFF loader does not support the image type return
162 // unsupported. This library can support lots of types of images
163 // this does not mean the user of this library can call the entry
164 // point of the image.
166 return RETURN_UNSUPPORTED
;
169 return RETURN_SUCCESS
;
174 Retrieves information about a PE/COFF image.
176 Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize,
177 DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and
178 DebugDirectoryEntryRva fields of the ImageContext structure.
179 If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.
180 If the PE/COFF image accessed through the ImageRead service in the ImageContext
181 structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED.
182 If any errors occur while computing the fields of ImageContext,
183 then the error status is returned in the ImageError field of ImageContext.
184 If the image is a TE image, then SectionAlignment is set to 0.
185 The ImageRead and Handle fields of ImageContext structure must be valid prior
186 to invoking this service.
188 @param ImageContext The pointer to the image context structure that describes the PE/COFF
189 image that needs to be examined by this function.
191 @retval RETURN_SUCCESS The information on the PE/COFF image was collected.
192 @retval RETURN_INVALID_PARAMETER ImageContext is NULL.
193 @retval RETURN_UNSUPPORTED The PE/COFF image is not supported.
198 PeCoffLoaderGetImageInfo (
199 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
202 RETURN_STATUS Status
;
203 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData
;
204 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
205 EFI_IMAGE_DATA_DIRECTORY
*DebugDirectoryEntry
;
208 UINTN DebugDirectoryEntryRva
;
209 UINTN DebugDirectoryEntryFileOffset
;
210 UINTN SectionHeaderOffset
;
211 EFI_IMAGE_SECTION_HEADER SectionHeader
;
212 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY DebugEntry
;
213 UINT32 NumberOfRvaAndSizes
;
216 if (ImageContext
== NULL
) {
217 return RETURN_INVALID_PARAMETER
;
222 ImageContext
->ImageError
= IMAGE_ERROR_SUCCESS
;
224 Hdr
.Union
= &HdrData
;
225 Status
= PeCoffLoaderGetPeHeader (ImageContext
, Hdr
);
226 if (RETURN_ERROR (Status
)) {
230 Magic
= PeCoffLoaderGetPeHeaderMagicValue (Hdr
);
233 // Retrieve the base address of the image
235 if (!(ImageContext
->IsTeImage
)) {
236 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
240 ImageContext
->ImageAddress
= Hdr
.Pe32
->OptionalHeader
.ImageBase
;
245 ImageContext
->ImageAddress
= Hdr
.Pe32Plus
->OptionalHeader
.ImageBase
;
248 ImageContext
->ImageAddress
= (PHYSICAL_ADDRESS
)(Hdr
.Te
->ImageBase
+ Hdr
.Te
->StrippedSize
- sizeof (EFI_TE_IMAGE_HEADER
));
252 // Initialize the alternate destination address to 0 indicating that it
253 // should not be used.
255 ImageContext
->DestinationAddress
= 0;
258 // Initialize the debug codeview pointer.
260 ImageContext
->DebugDirectoryEntryRva
= 0;
261 ImageContext
->CodeView
= NULL
;
262 ImageContext
->PdbPointer
= NULL
;
265 // Three cases with regards to relocations:
266 // - Image has base relocs, RELOCS_STRIPPED==0 => image is relocatable
267 // - Image has no base relocs, RELOCS_STRIPPED==1 => Image is not relocatable
268 // - Image has no base relocs, RELOCS_STRIPPED==0 => Image is relocatable but
269 // has no base relocs to apply
270 // Obviously having base relocations with RELOCS_STRIPPED==1 is invalid.
272 // Look at the file header to determine if relocations have been stripped, and
273 // save this information in the image context for later use.
275 if ((!(ImageContext
->IsTeImage
)) && ((Hdr
.Pe32
->FileHeader
.Characteristics
& EFI_IMAGE_FILE_RELOCS_STRIPPED
) != 0)) {
276 ImageContext
->RelocationsStripped
= TRUE
;
277 } else if ((ImageContext
->IsTeImage
) && (Hdr
.Te
->DataDirectory
[0].Size
== 0) && (Hdr
.Te
->DataDirectory
[0].VirtualAddress
== 0)) {
278 ImageContext
->RelocationsStripped
= TRUE
;
280 ImageContext
->RelocationsStripped
= FALSE
;
283 if (!(ImageContext
->IsTeImage
)) {
284 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
288 NumberOfRvaAndSizes
= Hdr
.Pe32
->OptionalHeader
.NumberOfRvaAndSizes
;
289 DebugDirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&(Hdr
.Pe32
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
]);
294 NumberOfRvaAndSizes
= Hdr
.Pe32Plus
->OptionalHeader
.NumberOfRvaAndSizes
;
295 DebugDirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&(Hdr
.Pe32Plus
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
]);
298 if (NumberOfRvaAndSizes
> EFI_IMAGE_DIRECTORY_ENTRY_DEBUG
) {
300 DebugDirectoryEntryRva
= DebugDirectoryEntry
->VirtualAddress
;
303 // Determine the file offset of the debug directory... This means we walk
304 // the sections to find which section contains the RVA of the debug
307 DebugDirectoryEntryFileOffset
= 0;
309 SectionHeaderOffset
= (UINTN
)(
310 ImageContext
->PeCoffHeaderOffset
+
312 sizeof (EFI_IMAGE_FILE_HEADER
) +
313 Hdr
.Pe32
->FileHeader
.SizeOfOptionalHeader
316 for (Index
= 0; Index
< Hdr
.Pe32
->FileHeader
.NumberOfSections
; Index
++) {
318 // Read section header from file
320 Size
= sizeof (EFI_IMAGE_SECTION_HEADER
);
321 Status
= ImageContext
->ImageRead (
322 ImageContext
->Handle
,
327 if (RETURN_ERROR (Status
)) {
328 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
332 if (DebugDirectoryEntryRva
>= SectionHeader
.VirtualAddress
&&
333 DebugDirectoryEntryRva
< SectionHeader
.VirtualAddress
+ SectionHeader
.Misc
.VirtualSize
) {
335 DebugDirectoryEntryFileOffset
= DebugDirectoryEntryRva
- SectionHeader
.VirtualAddress
+ SectionHeader
.PointerToRawData
;
339 SectionHeaderOffset
+= sizeof (EFI_IMAGE_SECTION_HEADER
);
342 if (DebugDirectoryEntryFileOffset
!= 0) {
343 for (Index
= 0; Index
< DebugDirectoryEntry
->Size
; Index
+= sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
)) {
345 // Read next debug directory entry
347 Size
= sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
);
348 Status
= ImageContext
->ImageRead (
349 ImageContext
->Handle
,
350 DebugDirectoryEntryFileOffset
,
354 if (RETURN_ERROR (Status
)) {
355 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
358 if (DebugEntry
.Type
== EFI_IMAGE_DEBUG_TYPE_CODEVIEW
) {
359 ImageContext
->DebugDirectoryEntryRva
= (UINT32
) (DebugDirectoryEntryRva
+ Index
);
360 if (DebugEntry
.RVA
== 0 && DebugEntry
.FileOffset
!= 0) {
361 ImageContext
->ImageSize
+= DebugEntry
.SizeOfData
;
364 return RETURN_SUCCESS
;
371 DebugDirectoryEntry
= &Hdr
.Te
->DataDirectory
[1];
372 DebugDirectoryEntryRva
= DebugDirectoryEntry
->VirtualAddress
;
373 SectionHeaderOffset
= (UINTN
)(sizeof (EFI_TE_IMAGE_HEADER
));
375 DebugDirectoryEntryFileOffset
= 0;
377 for (Index
= 0; Index
< Hdr
.Te
->NumberOfSections
;) {
379 // Read section header from file
381 Size
= sizeof (EFI_IMAGE_SECTION_HEADER
);
382 Status
= ImageContext
->ImageRead (
383 ImageContext
->Handle
,
388 if (RETURN_ERROR (Status
)) {
389 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
393 if (DebugDirectoryEntryRva
>= SectionHeader
.VirtualAddress
&&
394 DebugDirectoryEntryRva
< SectionHeader
.VirtualAddress
+ SectionHeader
.Misc
.VirtualSize
) {
395 DebugDirectoryEntryFileOffset
= DebugDirectoryEntryRva
-
396 SectionHeader
.VirtualAddress
+
397 SectionHeader
.PointerToRawData
+
398 sizeof (EFI_TE_IMAGE_HEADER
) -
399 Hdr
.Te
->StrippedSize
;
402 // File offset of the debug directory was found, if this is not the last
403 // section, then skip to the last section for calculating the image size.
405 if (Index
< (UINTN
) Hdr
.Te
->NumberOfSections
- 1) {
406 SectionHeaderOffset
+= (Hdr
.Te
->NumberOfSections
- 1 - Index
) * sizeof (EFI_IMAGE_SECTION_HEADER
);
407 Index
= Hdr
.Te
->NumberOfSections
- 1;
413 // In Te image header there is not a field to describe the ImageSize.
414 // Actually, the ImageSize equals the RVA plus the VirtualSize of
415 // the last section mapped into memory (Must be rounded up to
416 // a multiple of Section Alignment). Per the PE/COFF specification, the
417 // section headers in the Section Table must appear in order of the RVA
418 // values for the corresponding sections. So the ImageSize can be determined
419 // by the RVA and the VirtualSize of the last section header in the
422 if ((++Index
) == (UINTN
)Hdr
.Te
->NumberOfSections
) {
423 ImageContext
->ImageSize
= (SectionHeader
.VirtualAddress
+ SectionHeader
.Misc
.VirtualSize
);
426 SectionHeaderOffset
+= sizeof (EFI_IMAGE_SECTION_HEADER
);
429 if (DebugDirectoryEntryFileOffset
!= 0) {
430 for (Index
= 0; Index
< DebugDirectoryEntry
->Size
; Index
+= sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
)) {
432 // Read next debug directory entry
434 Size
= sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
);
435 Status
= ImageContext
->ImageRead (
436 ImageContext
->Handle
,
437 DebugDirectoryEntryFileOffset
,
441 if (RETURN_ERROR (Status
)) {
442 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
446 if (DebugEntry
.Type
== EFI_IMAGE_DEBUG_TYPE_CODEVIEW
) {
447 ImageContext
->DebugDirectoryEntryRva
= (UINT32
) (DebugDirectoryEntryRva
+ Index
);
448 return RETURN_SUCCESS
;
454 return RETURN_SUCCESS
;
459 Converts an image address to the loaded address.
461 @param ImageContext The context of the image being loaded.
462 @param Address The relative virtual address to be converted to the loaded address.
464 @return The converted address or NULL if the address can not be converted.
468 PeCoffLoaderImageAddress (
469 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
,
474 // Make sure that Address and ImageSize is correct for the loaded image.
476 if (Address
>= ImageContext
->ImageSize
) {
477 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_IMAGE_ADDRESS
;
481 return (CHAR8
*)((UINTN
) ImageContext
->ImageAddress
+ Address
);
485 Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().
487 If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of
488 ImageContext as the relocation base address. Otherwise, use the DestinationAddress field
489 of ImageContext as the relocation base address. The caller must allocate the relocation
490 fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
492 The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress,
493 ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders,
494 DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of
495 the ImageContext structure must be valid prior to invoking this service.
497 If ImageContext is NULL, then ASSERT().
499 Note that if the platform does not maintain coherency between the instruction cache(s) and the data
500 cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
501 prior to transferring control to a PE/COFF image that is loaded using this library.
503 @param ImageContext The pointer to the image context structure that describes the PE/COFF
504 image that is being relocated.
506 @retval RETURN_SUCCESS The PE/COFF image was relocated.
507 Extended status information is in the ImageError field of ImageContext.
508 @retval RETURN_LOAD_ERROR The image in not a valid PE/COFF image.
509 Extended status information is in the ImageError field of ImageContext.
510 @retval RETURN_UNSUPPORTED A relocation record type is not supported.
511 Extended status information is in the ImageError field of ImageContext.
516 PeCoffLoaderRelocateImage (
517 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
520 RETURN_STATUS Status
;
521 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
522 EFI_IMAGE_DATA_DIRECTORY
*RelocDir
;
524 EFI_IMAGE_BASE_RELOCATION
*RelocBase
;
525 EFI_IMAGE_BASE_RELOCATION
*RelocBaseEnd
;
534 PHYSICAL_ADDRESS BaseAddress
;
535 UINT32 NumberOfRvaAndSizes
;
538 ASSERT (ImageContext
!= NULL
);
543 ImageContext
->ImageError
= IMAGE_ERROR_SUCCESS
;
546 // If there are no relocation entries, then we are done
548 if (ImageContext
->RelocationsStripped
) {
549 // Applies additional environment specific actions to relocate fixups
550 // to a PE/COFF image if needed
551 PeCoffLoaderRelocateImageExtraAction (ImageContext
);
552 return RETURN_SUCCESS
;
556 // If the destination address is not 0, use that rather than the
557 // image address as the relocation target.
559 if (ImageContext
->DestinationAddress
!= 0) {
560 BaseAddress
= ImageContext
->DestinationAddress
;
562 BaseAddress
= ImageContext
->ImageAddress
;
565 if (!(ImageContext
->IsTeImage
)) {
566 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
)ImageContext
->ImageAddress
+ ImageContext
->PeCoffHeaderOffset
);
568 Magic
= PeCoffLoaderGetPeHeaderMagicValue (Hdr
);
570 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
574 Adjust
= (UINT64
)BaseAddress
- Hdr
.Pe32
->OptionalHeader
.ImageBase
;
576 Hdr
.Pe32
->OptionalHeader
.ImageBase
= (UINT32
)BaseAddress
;
579 NumberOfRvaAndSizes
= Hdr
.Pe32
->OptionalHeader
.NumberOfRvaAndSizes
;
580 RelocDir
= &Hdr
.Pe32
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
];
585 Adjust
= (UINT64
) BaseAddress
- Hdr
.Pe32Plus
->OptionalHeader
.ImageBase
;
587 Hdr
.Pe32Plus
->OptionalHeader
.ImageBase
= (UINT64
)BaseAddress
;
590 NumberOfRvaAndSizes
= Hdr
.Pe32Plus
->OptionalHeader
.NumberOfRvaAndSizes
;
591 RelocDir
= &Hdr
.Pe32Plus
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
];
595 // Find the relocation block
596 // Per the PE/COFF spec, you can't assume that a given data directory
597 // is present in the image. You have to check the NumberOfRvaAndSizes in
598 // the optional header to verify a desired directory entry is there.
601 if ((NumberOfRvaAndSizes
> EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
) && (RelocDir
->Size
> 0)) {
602 RelocBase
= PeCoffLoaderImageAddress (ImageContext
, RelocDir
->VirtualAddress
);
603 RelocBaseEnd
= PeCoffLoaderImageAddress (
605 RelocDir
->VirtualAddress
+ RelocDir
->Size
- 1
607 if (RelocBase
== NULL
|| RelocBaseEnd
== NULL
) {
608 return RETURN_LOAD_ERROR
;
612 // Set base and end to bypass processing below.
614 RelocBase
= RelocBaseEnd
= NULL
;
617 Hdr
.Te
= (EFI_TE_IMAGE_HEADER
*)(UINTN
)(ImageContext
->ImageAddress
);
618 Adjust
= (UINT64
) (BaseAddress
- Hdr
.Te
->StrippedSize
+ sizeof (EFI_TE_IMAGE_HEADER
) - Hdr
.Te
->ImageBase
);
620 Hdr
.Te
->ImageBase
= (UINT64
) (BaseAddress
- Hdr
.Te
->StrippedSize
+ sizeof (EFI_TE_IMAGE_HEADER
));
624 // Find the relocation block
626 RelocDir
= &Hdr
.Te
->DataDirectory
[0];
627 if (RelocDir
->Size
> 0) {
628 RelocBase
= (EFI_IMAGE_BASE_RELOCATION
*)(UINTN
)(
629 ImageContext
->ImageAddress
+
630 RelocDir
->VirtualAddress
+
631 sizeof(EFI_TE_IMAGE_HEADER
) -
634 RelocBaseEnd
= (EFI_IMAGE_BASE_RELOCATION
*) ((UINTN
) RelocBase
+ (UINTN
) RelocDir
->Size
- 1);
637 // Set base and end to bypass processing below.
639 RelocBase
= RelocBaseEnd
= NULL
;
644 // If Adjust is not zero, then apply fix ups to the image
648 // Run the relocation information and apply the fixups
650 FixupData
= ImageContext
->FixupData
;
651 while (RelocBase
< RelocBaseEnd
) {
653 Reloc
= (UINT16
*) ((CHAR8
*) RelocBase
+ sizeof (EFI_IMAGE_BASE_RELOCATION
));
654 RelocEnd
= (UINT16
*) ((CHAR8
*) RelocBase
+ RelocBase
->SizeOfBlock
);
657 // Make sure RelocEnd is in the Image range.
659 if ((CHAR8
*) RelocEnd
< (CHAR8
*)((UINTN
) ImageContext
->ImageAddress
) ||
660 (CHAR8
*) RelocEnd
> (CHAR8
*)((UINTN
)ImageContext
->ImageAddress
+ (UINTN
)ImageContext
->ImageSize
)) {
661 ImageContext
->ImageError
= IMAGE_ERROR_FAILED_RELOCATION
;
662 return RETURN_LOAD_ERROR
;
665 if (!(ImageContext
->IsTeImage
)) {
666 FixupBase
= PeCoffLoaderImageAddress (ImageContext
, RelocBase
->VirtualAddress
);
667 if (FixupBase
== NULL
) {
668 return RETURN_LOAD_ERROR
;
671 FixupBase
= (CHAR8
*)(UINTN
)(ImageContext
->ImageAddress
+
672 RelocBase
->VirtualAddress
+
673 sizeof(EFI_TE_IMAGE_HEADER
) -
679 // Run this relocation record
681 while (Reloc
< RelocEnd
) {
683 Fixup
= FixupBase
+ (*Reloc
& 0xFFF);
684 switch ((*Reloc
) >> 12) {
685 case EFI_IMAGE_REL_BASED_ABSOLUTE
:
688 case EFI_IMAGE_REL_BASED_HIGH
:
689 Fixup16
= (UINT16
*) Fixup
;
690 *Fixup16
= (UINT16
) (*Fixup16
+ ((UINT16
) ((UINT32
) Adjust
>> 16)));
691 if (FixupData
!= NULL
) {
692 *(UINT16
*) FixupData
= *Fixup16
;
693 FixupData
= FixupData
+ sizeof (UINT16
);
697 case EFI_IMAGE_REL_BASED_LOW
:
698 Fixup16
= (UINT16
*) Fixup
;
699 *Fixup16
= (UINT16
) (*Fixup16
+ (UINT16
) Adjust
);
700 if (FixupData
!= NULL
) {
701 *(UINT16
*) FixupData
= *Fixup16
;
702 FixupData
= FixupData
+ sizeof (UINT16
);
706 case EFI_IMAGE_REL_BASED_HIGHLOW
:
707 Fixup32
= (UINT32
*) Fixup
;
708 *Fixup32
= *Fixup32
+ (UINT32
) Adjust
;
709 if (FixupData
!= NULL
) {
710 FixupData
= ALIGN_POINTER (FixupData
, sizeof (UINT32
));
711 *(UINT32
*)FixupData
= *Fixup32
;
712 FixupData
= FixupData
+ sizeof (UINT32
);
716 case EFI_IMAGE_REL_BASED_DIR64
:
717 Fixup64
= (UINT64
*) Fixup
;
718 *Fixup64
= *Fixup64
+ (UINT64
) Adjust
;
719 if (FixupData
!= NULL
) {
720 FixupData
= ALIGN_POINTER (FixupData
, sizeof(UINT64
));
721 *(UINT64
*)(FixupData
) = *Fixup64
;
722 FixupData
= FixupData
+ sizeof(UINT64
);
728 // The common code does not handle architecture specific immediate fixups.
729 // PeCoffLoaderRelocateImageEx () adds support for these complex fixups
730 // on IPF and ARM, but it is a No-Op on other architectures.
732 Status
= PeCoffLoaderRelocateImageEx (&Reloc
, Fixup
, &FixupData
, Adjust
);
733 if (RETURN_ERROR (Status
)) {
734 ImageContext
->ImageError
= IMAGE_ERROR_FAILED_RELOCATION
;
740 // Next relocation record
748 RelocBase
= (EFI_IMAGE_BASE_RELOCATION
*) RelocEnd
;
752 // Adjust the EntryPoint to match the linked-to address
754 if (ImageContext
->DestinationAddress
!= 0) {
755 ImageContext
->EntryPoint
-= (UINT64
) ImageContext
->ImageAddress
;
756 ImageContext
->EntryPoint
+= (UINT64
) ImageContext
->DestinationAddress
;
760 // Applies additional environment specific actions to relocate fixups
761 // to a PE/COFF image if needed
762 PeCoffLoaderRelocateImageExtraAction (ImageContext
);
764 return RETURN_SUCCESS
;
768 Loads a PE/COFF image into memory.
770 Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer
771 specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate
772 the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.
773 The EntryPoint, FixupDataSize, CodeView, PdbPointer and HiiResourceData fields of ImageContext are computed.
774 The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize,
775 DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva
776 fields of the ImageContext structure must be valid prior to invoking this service.
778 If ImageContext is NULL, then ASSERT().
780 Note that if the platform does not maintain coherency between the instruction cache(s) and the data
781 cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
782 prior to transferring control to a PE/COFF image that is loaded using this library.
784 @param ImageContext The pointer to the image context structure that describes the PE/COFF
785 image that is being loaded.
787 @retval RETURN_SUCCESS The PE/COFF image was loaded into the buffer specified by
788 the ImageAddress and ImageSize fields of ImageContext.
789 Extended status information is in the ImageError field of ImageContext.
790 @retval RETURN_BUFFER_TOO_SMALL The caller did not provide a large enough buffer.
791 Extended status information is in the ImageError field of ImageContext.
792 @retval RETURN_LOAD_ERROR The PE/COFF image is an EFI Runtime image with no relocations.
793 Extended status information is in the ImageError field of ImageContext.
794 @retval RETURN_INVALID_PARAMETER The image address is invalid.
795 Extended status information is in the ImageError field of ImageContext.
800 PeCoffLoaderLoadImage (
801 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
804 RETURN_STATUS Status
;
805 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
806 PE_COFF_LOADER_IMAGE_CONTEXT CheckContext
;
807 EFI_IMAGE_SECTION_HEADER
*FirstSection
;
808 EFI_IMAGE_SECTION_HEADER
*Section
;
809 UINTN NumberOfSections
;
814 EFI_IMAGE_DATA_DIRECTORY
*DirectoryEntry
;
815 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*DebugEntry
;
817 UINT32 TempDebugEntryRva
;
818 UINT32 NumberOfRvaAndSizes
;
820 EFI_IMAGE_RESOURCE_DIRECTORY
*ResourceDirectory
;
821 EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY
*ResourceDirectoryEntry
;
822 EFI_IMAGE_RESOURCE_DIRECTORY_STRING
*ResourceDirectoryString
;
823 EFI_IMAGE_RESOURCE_DATA_ENTRY
*ResourceDataEntry
;
826 ASSERT (ImageContext
!= NULL
);
831 ImageContext
->ImageError
= IMAGE_ERROR_SUCCESS
;
834 // Copy the provided context information into our local version, get what we
835 // can from the original image, and then use that to make sure everything
838 CopyMem (&CheckContext
, ImageContext
, sizeof (PE_COFF_LOADER_IMAGE_CONTEXT
));
840 Status
= PeCoffLoaderGetImageInfo (&CheckContext
);
841 if (RETURN_ERROR (Status
)) {
846 // Make sure there is enough allocated space for the image being loaded
848 if (ImageContext
->ImageSize
< CheckContext
.ImageSize
) {
849 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_IMAGE_SIZE
;
850 return RETURN_BUFFER_TOO_SMALL
;
852 if (ImageContext
->ImageAddress
== 0) {
854 // Image cannot be loaded into 0 address.
856 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_IMAGE_ADDRESS
;
857 return RETURN_INVALID_PARAMETER
;
860 // If there's no relocations, then make sure it's not a runtime driver,
861 // and that it's being loaded at the linked address.
863 if (CheckContext
.RelocationsStripped
) {
865 // If the image does not contain relocations and it is a runtime driver
866 // then return an error.
868 if (CheckContext
.ImageType
== EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER
) {
869 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_SUBSYSTEM
;
870 return RETURN_LOAD_ERROR
;
873 // If the image does not contain relocations, and the requested load address
874 // is not the linked address, then return an error.
876 if (CheckContext
.ImageAddress
!= ImageContext
->ImageAddress
) {
877 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_IMAGE_ADDRESS
;
878 return RETURN_INVALID_PARAMETER
;
882 // Make sure the allocated space has the proper section alignment
884 if (!(ImageContext
->IsTeImage
)) {
885 if ((ImageContext
->ImageAddress
& (CheckContext
.SectionAlignment
- 1)) != 0) {
886 ImageContext
->ImageError
= IMAGE_ERROR_INVALID_SECTION_ALIGNMENT
;
887 return RETURN_INVALID_PARAMETER
;
891 // Read the entire PE/COFF or TE header into memory
893 if (!(ImageContext
->IsTeImage
)) {
894 Status
= ImageContext
->ImageRead (
895 ImageContext
->Handle
,
897 &ImageContext
->SizeOfHeaders
,
898 (VOID
*) (UINTN
) ImageContext
->ImageAddress
901 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)((UINTN
)ImageContext
->ImageAddress
+ ImageContext
->PeCoffHeaderOffset
);
903 FirstSection
= (EFI_IMAGE_SECTION_HEADER
*) (
904 (UINTN
)ImageContext
->ImageAddress
+
905 ImageContext
->PeCoffHeaderOffset
+
907 sizeof(EFI_IMAGE_FILE_HEADER
) +
908 Hdr
.Pe32
->FileHeader
.SizeOfOptionalHeader
910 NumberOfSections
= (UINTN
) (Hdr
.Pe32
->FileHeader
.NumberOfSections
);
912 Status
= ImageContext
->ImageRead (
913 ImageContext
->Handle
,
915 &ImageContext
->SizeOfHeaders
,
916 (VOID
*)(UINTN
)ImageContext
->ImageAddress
919 Hdr
.Te
= (EFI_TE_IMAGE_HEADER
*)(UINTN
)(ImageContext
->ImageAddress
);
921 FirstSection
= (EFI_IMAGE_SECTION_HEADER
*) (
922 (UINTN
)ImageContext
->ImageAddress
+
923 sizeof(EFI_TE_IMAGE_HEADER
)
925 NumberOfSections
= (UINTN
) (Hdr
.Te
->NumberOfSections
);
929 if (RETURN_ERROR (Status
)) {
930 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
931 return RETURN_LOAD_ERROR
;
935 // Load each section of the image
937 Section
= FirstSection
;
938 for (Index
= 0, MaxEnd
= NULL
; Index
< NumberOfSections
; Index
++) {
942 Size
= (UINTN
) Section
->Misc
.VirtualSize
;
943 if ((Size
== 0) || (Size
> Section
->SizeOfRawData
)) {
944 Size
= (UINTN
) Section
->SizeOfRawData
;
948 // Compute sections address
950 Base
= PeCoffLoaderImageAddress (ImageContext
, Section
->VirtualAddress
);
951 End
= PeCoffLoaderImageAddress (
953 Section
->VirtualAddress
+ Section
->Misc
.VirtualSize
- 1
957 // If the size of the section is non-zero and the base address or end address resolved to 0, then fail.
959 if ((Size
> 0) && ((Base
== NULL
) || (End
== NULL
))) {
960 ImageContext
->ImageError
= IMAGE_ERROR_SECTION_NOT_LOADED
;
961 return RETURN_LOAD_ERROR
;
964 if (ImageContext
->IsTeImage
) {
965 Base
= (CHAR8
*)((UINTN
) Base
+ sizeof (EFI_TE_IMAGE_HEADER
) - (UINTN
)Hdr
.Te
->StrippedSize
);
966 End
= (CHAR8
*)((UINTN
) End
+ sizeof (EFI_TE_IMAGE_HEADER
) - (UINTN
)Hdr
.Te
->StrippedSize
);
973 if (Section
->SizeOfRawData
> 0) {
974 if (!(ImageContext
->IsTeImage
)) {
975 Status
= ImageContext
->ImageRead (
976 ImageContext
->Handle
,
977 Section
->PointerToRawData
,
982 Status
= ImageContext
->ImageRead (
983 ImageContext
->Handle
,
984 Section
->PointerToRawData
+ sizeof (EFI_TE_IMAGE_HEADER
) - (UINTN
)Hdr
.Te
->StrippedSize
,
990 if (RETURN_ERROR (Status
)) {
991 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
997 // If raw size is less then virtual size, zero fill the remaining
1000 if (Size
< Section
->Misc
.VirtualSize
) {
1001 ZeroMem (Base
+ Size
, Section
->Misc
.VirtualSize
- Size
);
1011 // Get image's entry point
1013 Magic
= PeCoffLoaderGetPeHeaderMagicValue (Hdr
);
1014 if (!(ImageContext
->IsTeImage
)) {
1016 // Sizes of AddressOfEntryPoint are different so we need to do this safely
1018 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
1022 ImageContext
->EntryPoint
= (PHYSICAL_ADDRESS
)(UINTN
)PeCoffLoaderImageAddress (
1024 (UINTN
)Hdr
.Pe32
->OptionalHeader
.AddressOfEntryPoint
1030 ImageContext
->EntryPoint
= (PHYSICAL_ADDRESS
)(UINTN
)PeCoffLoaderImageAddress (
1032 (UINTN
)Hdr
.Pe32Plus
->OptionalHeader
.AddressOfEntryPoint
1036 ImageContext
->EntryPoint
= (PHYSICAL_ADDRESS
) (
1037 (UINTN
)ImageContext
->ImageAddress
+
1038 (UINTN
)Hdr
.Te
->AddressOfEntryPoint
+
1039 (UINTN
)sizeof(EFI_TE_IMAGE_HEADER
) -
1040 (UINTN
)Hdr
.Te
->StrippedSize
1045 // Determine the size of the fixup data
1047 // Per the PE/COFF spec, you can't assume that a given data directory
1048 // is present in the image. You have to check the NumberOfRvaAndSizes in
1049 // the optional header to verify a desired directory entry is there.
1051 if (!(ImageContext
->IsTeImage
)) {
1052 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
1056 NumberOfRvaAndSizes
= Hdr
.Pe32
->OptionalHeader
.NumberOfRvaAndSizes
;
1057 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&Hdr
.Pe32
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
];
1062 NumberOfRvaAndSizes
= Hdr
.Pe32Plus
->OptionalHeader
.NumberOfRvaAndSizes
;
1063 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&Hdr
.Pe32Plus
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
];
1066 if (NumberOfRvaAndSizes
> EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
) {
1067 ImageContext
->FixupDataSize
= DirectoryEntry
->Size
/ sizeof (UINT16
) * sizeof (UINTN
);
1069 ImageContext
->FixupDataSize
= 0;
1072 DirectoryEntry
= &Hdr
.Te
->DataDirectory
[0];
1073 ImageContext
->FixupDataSize
= DirectoryEntry
->Size
/ sizeof (UINT16
) * sizeof (UINTN
);
1076 // Consumer must allocate a buffer for the relocation fixup log.
1077 // Only used for runtime drivers.
1079 ImageContext
->FixupData
= NULL
;
1082 // Load the Codeview information if present
1084 if (ImageContext
->DebugDirectoryEntryRva
!= 0) {
1085 if (!(ImageContext
->IsTeImage
)) {
1086 DebugEntry
= PeCoffLoaderImageAddress (
1088 ImageContext
->DebugDirectoryEntryRva
1091 DebugEntry
= (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
*)(UINTN
)(
1092 ImageContext
->ImageAddress
+
1093 ImageContext
->DebugDirectoryEntryRva
+
1094 sizeof(EFI_TE_IMAGE_HEADER
) -
1095 Hdr
.Te
->StrippedSize
1099 if (DebugEntry
!= NULL
) {
1100 TempDebugEntryRva
= DebugEntry
->RVA
;
1101 if (DebugEntry
->RVA
== 0 && DebugEntry
->FileOffset
!= 0) {
1103 if ((UINTN
)Section
->SizeOfRawData
< Section
->Misc
.VirtualSize
) {
1104 TempDebugEntryRva
= Section
->VirtualAddress
+ Section
->Misc
.VirtualSize
;
1106 TempDebugEntryRva
= Section
->VirtualAddress
+ Section
->SizeOfRawData
;
1110 if (TempDebugEntryRva
!= 0) {
1111 if (!(ImageContext
->IsTeImage
)) {
1112 ImageContext
->CodeView
= PeCoffLoaderImageAddress (ImageContext
, TempDebugEntryRva
);
1114 ImageContext
->CodeView
= (VOID
*)(
1115 (UINTN
)ImageContext
->ImageAddress
+
1116 (UINTN
)TempDebugEntryRva
+
1117 (UINTN
)sizeof (EFI_TE_IMAGE_HEADER
) -
1118 (UINTN
) Hdr
.Te
->StrippedSize
1122 if (ImageContext
->CodeView
== NULL
) {
1123 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
1124 return RETURN_LOAD_ERROR
;
1127 if (DebugEntry
->RVA
== 0) {
1128 Size
= DebugEntry
->SizeOfData
;
1129 if (!(ImageContext
->IsTeImage
)) {
1130 Status
= ImageContext
->ImageRead (
1131 ImageContext
->Handle
,
1132 DebugEntry
->FileOffset
,
1134 ImageContext
->CodeView
1137 Status
= ImageContext
->ImageRead (
1138 ImageContext
->Handle
,
1139 DebugEntry
->FileOffset
+ sizeof (EFI_TE_IMAGE_HEADER
) - Hdr
.Te
->StrippedSize
,
1141 ImageContext
->CodeView
1144 // Should we apply fix up to this field according to the size difference between PE and TE?
1145 // Because now we maintain TE header fields unfixed, this field will also remain as they are
1146 // in original PE image.
1150 if (RETURN_ERROR (Status
)) {
1151 ImageContext
->ImageError
= IMAGE_ERROR_IMAGE_READ
;
1152 return RETURN_LOAD_ERROR
;
1155 DebugEntry
->RVA
= TempDebugEntryRva
;
1158 switch (*(UINT32
*) ImageContext
->CodeView
) {
1159 case CODEVIEW_SIGNATURE_NB10
:
1160 ImageContext
->PdbPointer
= (CHAR8
*)ImageContext
->CodeView
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY
);
1163 case CODEVIEW_SIGNATURE_RSDS
:
1164 ImageContext
->PdbPointer
= (CHAR8
*)ImageContext
->CodeView
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY
);
1167 case CODEVIEW_SIGNATURE_MTOC
:
1168 ImageContext
->PdbPointer
= (CHAR8
*)ImageContext
->CodeView
+ sizeof (EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY
);
1179 // Get Image's HII resource section
1181 ImageContext
->HiiResourceData
= 0;
1182 if (!(ImageContext
->IsTeImage
)) {
1183 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
1187 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&Hdr
.Pe32
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE
];
1192 DirectoryEntry
= (EFI_IMAGE_DATA_DIRECTORY
*)&Hdr
.Pe32Plus
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE
];
1195 if (DirectoryEntry
->Size
!= 0) {
1196 Base
= PeCoffLoaderImageAddress (ImageContext
, DirectoryEntry
->VirtualAddress
);
1198 ResourceDirectory
= (EFI_IMAGE_RESOURCE_DIRECTORY
*) Base
;
1199 ResourceDirectoryEntry
= (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY
*) (ResourceDirectory
+ 1);
1201 for (Index
= 0; Index
< ResourceDirectory
->NumberOfNamedEntries
; Index
++) {
1202 if (ResourceDirectoryEntry
->u1
.s
.NameIsString
) {
1203 ResourceDirectoryString
= (EFI_IMAGE_RESOURCE_DIRECTORY_STRING
*) (Base
+ ResourceDirectoryEntry
->u1
.s
.NameOffset
);
1205 if (ResourceDirectoryString
->Length
== 3 &&
1206 ResourceDirectoryString
->String
[0] == L
'H' &&
1207 ResourceDirectoryString
->String
[1] == L
'I' &&
1208 ResourceDirectoryString
->String
[2] == L
'I') {
1210 // Resource Type "HII" found
1212 if (ResourceDirectoryEntry
->u2
.s
.DataIsDirectory
) {
1214 // Move to next level - resource Name
1216 ResourceDirectory
= (EFI_IMAGE_RESOURCE_DIRECTORY
*) (Base
+ ResourceDirectoryEntry
->u2
.s
.OffsetToDirectory
);
1217 ResourceDirectoryEntry
= (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY
*) (ResourceDirectory
+ 1);
1219 if (ResourceDirectoryEntry
->u2
.s
.DataIsDirectory
) {
1221 // Move to next level - resource Language
1223 ResourceDirectory
= (EFI_IMAGE_RESOURCE_DIRECTORY
*) (Base
+ ResourceDirectoryEntry
->u2
.s
.OffsetToDirectory
);
1224 ResourceDirectoryEntry
= (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY
*) (ResourceDirectory
+ 1);
1229 // Now it ought to be resource Data
1231 if (!ResourceDirectoryEntry
->u2
.s
.DataIsDirectory
) {
1232 ResourceDataEntry
= (EFI_IMAGE_RESOURCE_DATA_ENTRY
*) (Base
+ ResourceDirectoryEntry
->u2
.OffsetToData
);
1233 ImageContext
->HiiResourceData
= (PHYSICAL_ADDRESS
) (UINTN
) PeCoffLoaderImageAddress (ImageContext
, ResourceDataEntry
->OffsetToData
);
1238 ResourceDirectoryEntry
++;
1249 Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI
1252 This function reapplies relocation fixups to the PE/COFF image specified by ImageBase
1253 and ImageSize so the image will execute correctly when the PE/COFF image is mapped
1254 to the address specified by VirtualImageBase. RelocationData must be identical
1255 to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure
1256 after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().
1258 Note that if the platform does not maintain coherency between the instruction cache(s) and the data
1259 cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
1260 prior to transferring control to a PE/COFF image that is loaded using this library.
1262 @param ImageBase The base address of a PE/COFF image that has been loaded
1263 and relocated into system memory.
1264 @param VirtImageBase The request virtual address that the PE/COFF image is to
1266 @param ImageSize The size, in bytes, of the PE/COFF image.
1267 @param RelocationData A pointer to the relocation data that was collected when the PE/COFF
1268 image was relocated using PeCoffLoaderRelocateImage().
1273 PeCoffLoaderRelocateImageForRuntime (
1274 IN PHYSICAL_ADDRESS ImageBase
,
1275 IN PHYSICAL_ADDRESS VirtImageBase
,
1277 IN VOID
*RelocationData
1282 EFI_IMAGE_DOS_HEADER
*DosHdr
;
1283 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
1284 UINT32 NumberOfRvaAndSizes
;
1285 EFI_IMAGE_DATA_DIRECTORY
*DataDirectory
;
1286 EFI_IMAGE_DATA_DIRECTORY
*RelocDir
;
1287 EFI_IMAGE_BASE_RELOCATION
*RelocBase
;
1288 EFI_IMAGE_BASE_RELOCATION
*RelocBaseEnd
;
1298 RETURN_STATUS Status
;
1301 OldBase
= (CHAR8
*)((UINTN
)ImageBase
);
1302 NewBase
= (CHAR8
*)((UINTN
)VirtImageBase
);
1303 Adjust
= (UINTN
) NewBase
- (UINTN
) OldBase
;
1306 // Find the image's relocate dir info
1308 DosHdr
= (EFI_IMAGE_DOS_HEADER
*)OldBase
;
1309 if (DosHdr
->e_magic
== EFI_IMAGE_DOS_SIGNATURE
) {
1311 // Valid DOS header so get address of PE header
1313 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)(((CHAR8
*)DosHdr
) + DosHdr
->e_lfanew
);
1316 // No Dos header so assume image starts with PE header.
1318 Hdr
.Pe32
= (EFI_IMAGE_NT_HEADERS32
*)OldBase
;
1321 if (Hdr
.Pe32
->Signature
!= EFI_IMAGE_NT_SIGNATURE
) {
1323 // Not a valid PE image so Exit
1328 Magic
= PeCoffLoaderGetPeHeaderMagicValue (Hdr
);
1330 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
1334 NumberOfRvaAndSizes
= Hdr
.Pe32
->OptionalHeader
.NumberOfRvaAndSizes
;
1335 DataDirectory
= (EFI_IMAGE_DATA_DIRECTORY
*)&(Hdr
.Pe32
->OptionalHeader
.DataDirectory
[0]);
1340 NumberOfRvaAndSizes
= Hdr
.Pe32Plus
->OptionalHeader
.NumberOfRvaAndSizes
;
1341 DataDirectory
= (EFI_IMAGE_DATA_DIRECTORY
*)&(Hdr
.Pe32Plus
->OptionalHeader
.DataDirectory
[0]);
1345 // Find the relocation block
1347 // Per the PE/COFF spec, you can't assume that a given data directory
1348 // is present in the image. You have to check the NumberOfRvaAndSizes in
1349 // the optional header to verify a desired directory entry is there.
1351 if (NumberOfRvaAndSizes
> EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
) {
1352 RelocDir
= DataDirectory
+ EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC
;
1353 RelocBase
= (EFI_IMAGE_BASE_RELOCATION
*)(UINTN
)(ImageBase
+ RelocDir
->VirtualAddress
);
1354 RelocBaseEnd
= (EFI_IMAGE_BASE_RELOCATION
*)(UINTN
)(ImageBase
+ RelocDir
->VirtualAddress
+ RelocDir
->Size
);
1357 // Cannot find relocations, cannot continue to relocate the image, ASSERT for this invalid image.
1364 // ASSERT for the invalid image when RelocBase and RelocBaseEnd are both NULL.
1366 ASSERT (RelocBase
!= NULL
&& RelocBaseEnd
!= NULL
);
1369 // Run the whole relocation block. And re-fixup data that has not been
1370 // modified. The FixupData is used to see if the image has been modified
1371 // since it was relocated. This is so data sections that have been updated
1372 // by code will not be fixed up, since that would set them back to
1375 FixupData
= RelocationData
;
1376 while (RelocBase
< RelocBaseEnd
) {
1378 Reloc
= (UINT16
*) ((UINT8
*) RelocBase
+ sizeof (EFI_IMAGE_BASE_RELOCATION
));
1379 RelocEnd
= (UINT16
*) ((UINT8
*) RelocBase
+ RelocBase
->SizeOfBlock
);
1380 FixupBase
= (CHAR8
*) ((UINTN
)ImageBase
) + RelocBase
->VirtualAddress
;
1383 // Run this relocation record
1385 while (Reloc
< RelocEnd
) {
1387 Fixup
= FixupBase
+ (*Reloc
& 0xFFF);
1388 switch ((*Reloc
) >> 12) {
1390 case EFI_IMAGE_REL_BASED_ABSOLUTE
:
1393 case EFI_IMAGE_REL_BASED_HIGH
:
1394 Fixup16
= (UINT16
*) Fixup
;
1395 if (*(UINT16
*) FixupData
== *Fixup16
) {
1396 *Fixup16
= (UINT16
) (*Fixup16
+ ((UINT16
) ((UINT32
) Adjust
>> 16)));
1399 FixupData
= FixupData
+ sizeof (UINT16
);
1402 case EFI_IMAGE_REL_BASED_LOW
:
1403 Fixup16
= (UINT16
*) Fixup
;
1404 if (*(UINT16
*) FixupData
== *Fixup16
) {
1405 *Fixup16
= (UINT16
) (*Fixup16
+ ((UINT16
) Adjust
& 0xffff));
1408 FixupData
= FixupData
+ sizeof (UINT16
);
1411 case EFI_IMAGE_REL_BASED_HIGHLOW
:
1412 Fixup32
= (UINT32
*) Fixup
;
1413 FixupData
= ALIGN_POINTER (FixupData
, sizeof (UINT32
));
1414 if (*(UINT32
*) FixupData
== *Fixup32
) {
1415 *Fixup32
= *Fixup32
+ (UINT32
) Adjust
;
1418 FixupData
= FixupData
+ sizeof (UINT32
);
1421 case EFI_IMAGE_REL_BASED_DIR64
:
1422 Fixup64
= (UINT64
*)Fixup
;
1423 FixupData
= ALIGN_POINTER (FixupData
, sizeof (UINT64
));
1424 if (*(UINT64
*) FixupData
== *Fixup64
) {
1425 *Fixup64
= *Fixup64
+ (UINT64
)Adjust
;
1428 FixupData
= FixupData
+ sizeof (UINT64
);
1431 case EFI_IMAGE_REL_BASED_HIGHADJ
:
1433 // Not valid Relocation type for UEFI image, ASSERT
1440 // Only Itanium requires ConvertPeImage_Ex
1442 Status
= PeHotRelocateImageEx (&Reloc
, Fixup
, &FixupData
, Adjust
);
1443 if (RETURN_ERROR (Status
)) {
1448 // Next relocation record
1455 RelocBase
= (EFI_IMAGE_BASE_RELOCATION
*) RelocEnd
;
1461 Reads contents of a PE/COFF image from a buffer in system memory.
1463 This is the default implementation of a PE_COFF_LOADER_READ_FILE function
1464 that assumes FileHandle pointer to the beginning of a PE/COFF image.
1465 This function reads contents of the PE/COFF image that starts at the system memory
1466 address specified by FileHandle. The read operation copies ReadSize bytes from the
1467 PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer.
1468 The size of the buffer actually read is returned in ReadSize.
1470 If FileHandle is NULL, then ASSERT().
1471 If ReadSize is NULL, then ASSERT().
1472 If Buffer is NULL, then ASSERT().
1474 @param FileHandle The pointer to base of the input stream
1475 @param FileOffset Offset into the PE/COFF image to begin the read operation.
1476 @param ReadSize On input, the size in bytes of the requested read operation.
1477 On output, the number of bytes actually read.
1478 @param Buffer Output buffer that contains the data read from the PE/COFF image.
1480 @retval RETURN_SUCCESS Data is read from FileOffset from the Handle into
1485 PeCoffLoaderImageReadFromMemory (
1486 IN VOID
*FileHandle
,
1487 IN UINTN FileOffset
,
1488 IN OUT UINTN
*ReadSize
,
1492 ASSERT (ReadSize
!= NULL
);
1493 ASSERT (FileHandle
!= NULL
);
1494 ASSERT (Buffer
!= NULL
);
1496 CopyMem (Buffer
, ((UINT8
*)FileHandle
) + FileOffset
, *ReadSize
);
1497 return RETURN_SUCCESS
;
1501 Unloads a loaded PE/COFF image from memory and releases its taken resource.
1502 Releases any environment specific resources that were allocated when the image
1503 specified by ImageContext was loaded using PeCoffLoaderLoadImage().
1505 For NT32 emulator, the PE/COFF image loaded by system needs to release.
1506 For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded,
1507 this function can simply return RETURN_SUCCESS.
1509 If ImageContext is NULL, then ASSERT().
1511 @param ImageContext The pointer to the image context structure that describes the PE/COFF
1512 image to be unloaded.
1514 @retval RETURN_SUCCESS The PE/COFF image was unloaded successfully.
1518 PeCoffLoaderUnloadImage (
1519 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
1523 // Applies additional environment specific actions to unload a
1524 // PE/COFF image if needed
1526 PeCoffLoaderUnloadImageExtraAction (ImageContext
);
1527 return RETURN_SUCCESS
;