- Generated on Fri Nov 15 2024 18:01:37 for TianoCore EDK2 by
1.9.6
|
TianoCore EDK2 master
|
#include "BasePeCoffLibInternals.h"Go to the source code of this file.
Base PE/COFF loader supports loading any PE32/PE32+ or TE image, but only supports relocating IA32, x64, IPF, ARM, RISC-V, LoongArch and EBC images.
Caution: This file requires additional review when modified. This library will have external input - PE/COFF image. This external input must be validated carefully to avoid security issue like buffer overflow, integer overflow.
The basic guideline is that caller need provide ImageContext->ImageRead () with the necessary data range check, to make sure when this library reads PE/COFF image, the PE image buffer is always in valid range. This library will also do some additional check for PE header fields.
PeCoffLoaderGetPeHeader() routine will do basic check for PE/COFF header. PeCoffLoaderGetImageInfo() routine will do basic check for whole PE/COFF image.
Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.
Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
Portions Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.
Portions Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file BasePeCoff.c.
| VOID PeCoffLoaderAdjustOffsetForTeImage | ( | EFI_IMAGE_SECTION_HEADER * | SectionHeader, |
| UINT32 | TeStrippedOffset | ||
| ) |
Adjust some fields in section header for TE image.
| SectionHeader | Pointer to the section header. |
| TeStrippedOffset | Size adjust for the TE image. |
Definition at line 36 of file BasePeCoff.c.
| RETURN_STATUS EFIAPI PeCoffLoaderGetImageInfo | ( | IN OUT PE_COFF_LOADER_IMAGE_CONTEXT * | ImageContext | ) |
Retrieves information about a PE/COFF image.
Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, DllCharacteristics, DllCharacteristicsEx and DebugDirectoryEntryRva fields of the ImageContext structure. If ImageContext is NULL, then return RETURN_INVALID_PARAMETER. If the PE/COFF image accessed through the ImageRead service in the ImageContext structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED. If any errors occur while computing the fields of ImageContext, then the error status is returned in the ImageError field of ImageContext. If the image is a TE image, then SectionAlignment is set to 0. The ImageRead and Handle fields of ImageContext structure must be valid prior to invoking this service.
Caution: This function may receive untrusted input. PE/COFF image is external input, so this routine will also done many checks in PE image to make sure PE image DosHeader, PeOptionHeader, SizeOfHeader, Section Data Region and Security Data Region be in PE image range.
| ImageContext | The pointer to the image context structure that describes the PE/COFF image that needs to be examined by this function. |
| RETURN_SUCCESS | The information on the PE/COFF image was collected. |
| RETURN_INVALID_PARAMETER | ImageContext is NULL. |
| RETURN_UNSUPPORTED | The PE/COFF image is not supported. |
Definition at line 577 of file BasePeCoff.c.
| RETURN_STATUS PeCoffLoaderGetPeHeader | ( | IN OUT PE_COFF_LOADER_IMAGE_CONTEXT * | ImageContext, |
| OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION | Hdr | ||
| ) |
Retrieves the PE or TE Header from a PE/COFF or TE image.
Caution: This function may receive untrusted input. PE/COFF image is external input, so this routine will also done many checks in PE image to make sure PE image DosHeader, PeOptionHeader, SizeOfHeader, Section Data Region and Security Data Region be in PE image range.
| ImageContext | The context of the image being loaded. |
| Hdr | The buffer in which to return the PE32, PE32+, or TE header. |
| RETURN_SUCCESS | The PE or TE Header is read. |
| Other | The error status from reading the PE/COFF or TE image using the ImageRead function. |
Definition at line 61 of file BasePeCoff.c.
| VOID * PeCoffLoaderImageAddress | ( | IN OUT PE_COFF_LOADER_IMAGE_CONTEXT * | ImageContext, |
| IN UINTN | Address, | ||
| IN UINTN | TeStrippedOffset | ||
| ) |
Converts an image address to the loaded address.
| ImageContext | The context of the image being loaded. |
| Address | The address to be converted to the loaded address. |
| TeStrippedOffset | Stripped offset for TE image. |
Definition at line 907 of file BasePeCoff.c.
| RETURN_STATUS EFIAPI PeCoffLoaderImageReadFromMemory | ( | IN VOID * | FileHandle, |
| IN UINTN | FileOffset, | ||
| IN OUT UINTN * | ReadSize, | ||
| OUT VOID * | Buffer | ||
| ) |
Reads contents of a PE/COFF image from a buffer in system memory.
This is the default implementation of a PE_COFF_LOADER_READ_FILE function that assumes FileHandle pointer to the beginning of a PE/COFF image. This function reads contents of the PE/COFF image that starts at the system memory address specified by FileHandle. The read operation copies ReadSize bytes from the PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer. The size of the buffer actually read is returned in ReadSize.
The caller must make sure the FileOffset and ReadSize within the file scope.
If FileHandle is NULL, then ASSERT(). If ReadSize is NULL, then ASSERT(). If Buffer is NULL, then ASSERT().
| FileHandle | The pointer to base of the input stream |
| FileOffset | Offset into the PE/COFF image to begin the read operation. |
| ReadSize | On input, the size in bytes of the requested read operation. On output, the number of bytes actually read. |
| Buffer | Output buffer that contains the data read from the PE/COFF image. |
| RETURN_SUCCESS | Data is read from FileOffset from the Handle into the buffer. |
Definition at line 1992 of file BasePeCoff.c.
| RETURN_STATUS EFIAPI PeCoffLoaderLoadImage | ( | IN OUT PE_COFF_LOADER_IMAGE_CONTEXT * | ImageContext | ) |
Loads a PE/COFF image into memory.
Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function. The EntryPoint, FixupDataSize, CodeView, PdbPointer and HiiResourceData fields of ImageContext are computed. The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva fields of the ImageContext structure must be valid prior to invoking this service.
If ImageContext is NULL, then ASSERT().
Note that if the platform does not maintain coherency between the instruction cache(s) and the data cache(s) in hardware, then the caller is responsible for performing cache maintenance operations prior to transferring control to a PE/COFF image that is loaded using this library.
| ImageContext | The pointer to the image context structure that describes the PE/COFF image that is being loaded. |
| RETURN_SUCCESS | The PE/COFF image was loaded into the buffer specified by the ImageAddress and ImageSize fields of ImageContext. Extended status information is in the ImageError field of ImageContext. |
| RETURN_BUFFER_TOO_SMALL | The caller did not provide a large enough buffer. Extended status information is in the ImageError field of ImageContext. |
| RETURN_LOAD_ERROR | The PE/COFF image is an EFI Runtime image with no relocations. Extended status information is in the ImageError field of ImageContext. |
| RETURN_INVALID_PARAMETER | The image address is invalid. Extended status information is in the ImageError field of ImageContext. |
Definition at line 1244 of file BasePeCoff.c.
| RETURN_STATUS EFIAPI PeCoffLoaderRelocateImage | ( | IN OUT PE_COFF_LOADER_IMAGE_CONTEXT * | ImageContext | ) |
Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().
If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of ImageContext as the relocation base address. Otherwise, use the DestinationAddress field of ImageContext as the relocation base address. The caller must allocate the relocation fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of the ImageContext structure must be valid prior to invoking this service.
If ImageContext is NULL, then ASSERT().
Note that if the platform does not maintain coherency between the instruction cache(s) and the data cache(s) in hardware, then the caller is responsible for performing cache maintenance operations prior to transferring control to a PE/COFF image that is loaded using this library.
| ImageContext | The pointer to the image context structure that describes the PE/COFF image that is being relocated. |
| RETURN_SUCCESS | The PE/COFF image was relocated. Extended status information is in the ImageError field of ImageContext. |
| RETURN_LOAD_ERROR | The image in not a valid PE/COFF image. Extended status information is in the ImageError field of ImageContext. |
| RETURN_UNSUPPORTED | A relocation record type is not supported. Extended status information is in the ImageError field of ImageContext. |
Definition at line 956 of file BasePeCoff.c.
| VOID EFIAPI PeCoffLoaderRelocateImageForRuntime | ( | IN PHYSICAL_ADDRESS | ImageBase, |
| IN PHYSICAL_ADDRESS | VirtImageBase, | ||
| IN UINTN | ImageSize, | ||
| IN VOID * | RelocationData | ||
| ) |
Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI runtime.
This function reapplies relocation fixups to the PE/COFF image specified by ImageBase and ImageSize so the image will execute correctly when the PE/COFF image is mapped to the address specified by VirtualImageBase. RelocationData must be identical to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().
Note that if the platform does not maintain coherency between the instruction cache(s) and the data cache(s) in hardware, then the caller is responsible for performing cache maintenance operations prior to transferring control to a PE/COFF image that is loaded using this library.
| ImageBase | The base address of a PE/COFF image that has been loaded and relocated into system memory. |
| VirtImageBase | The request virtual address that the PE/COFF image is to be fixed up for. |
| ImageSize | The size, in bytes, of the PE/COFF image. |
| RelocationData | A pointer to the relocation data that was collected when the PE/COFF image was relocated using PeCoffLoaderRelocateImage(). |
Definition at line 1742 of file BasePeCoff.c.
| RETURN_STATUS EFIAPI PeCoffLoaderUnloadImage | ( | IN OUT PE_COFF_LOADER_IMAGE_CONTEXT * | ImageContext | ) |
Unloads a loaded PE/COFF image from memory and releases its taken resource. Releases any environment specific resources that were allocated when the image specified by ImageContext was loaded using PeCoffLoaderLoadImage().
For NT32 emulator, the PE/COFF image loaded by system needs to release. For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, this function can simply return RETURN_SUCCESS.
If ImageContext is NULL, then ASSERT().
| ImageContext | The pointer to the image context structure that describes the PE/COFF image to be unloaded. |
| RETURN_SUCCESS | The PE/COFF image was unloaded successfully. |
Definition at line 2025 of file BasePeCoff.c.
1.9.6