#include <IndustryStandard/PeImage.h>

Data Structures
struct	PE_COFF_LOADER_IMAGE_CONTEXT

Macros
#define	IMAGE_ERROR_SUCCESS 0

#define	IMAGE_ERROR_IMAGE_READ 1

#define	IMAGE_ERROR_INVALID_PE_HEADER_SIGNATURE 2

#define	IMAGE_ERROR_INVALID_MACHINE_TYPE 3

#define	IMAGE_ERROR_INVALID_SUBSYSTEM 4

#define	IMAGE_ERROR_INVALID_IMAGE_ADDRESS 5

#define	IMAGE_ERROR_INVALID_IMAGE_SIZE 6

#define	IMAGE_ERROR_INVALID_SECTION_ALIGNMENT 7

#define	IMAGE_ERROR_SECTION_NOT_LOADED 8

#define	IMAGE_ERROR_FAILED_RELOCATION 9

#define	IMAGE_ERROR_FAILED_ICACHE_FLUSH 10

#define	IMAGE_ERROR_UNSUPPORTED 11

Typedefs
typedef RETURN_STATUS(EFIAPI *	PE_COFF_LOADER_READ_FILE) (IN VOID FileHandle, IN UINTN FileOffset, IN OUT UINTN ReadSize, OUT VOID *Buffer)

Functions
RETURN_STATUS EFIAPI	PeCoffLoaderGetImageInfo (IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext)

RETURN_STATUS EFIAPI	PeCoffLoaderRelocateImage (IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext)

RETURN_STATUS EFIAPI	PeCoffLoaderLoadImage (IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext)

RETURN_STATUS EFIAPI	PeCoffLoaderImageReadFromMemory (IN VOID FileHandle, IN UINTN FileOffset, IN OUT UINTN ReadSize, OUT VOID *Buffer)

VOID EFIAPI	PeCoffLoaderRelocateImageForRuntime (IN PHYSICAL_ADDRESS ImageBase, IN PHYSICAL_ADDRESS VirtImageBase, IN UINTN ImageSize, IN VOID *RelocationData)

RETURN_STATUS EFIAPI	PeCoffLoaderUnloadImage (IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext)

Detailed Description

Provides services to load and relocate a PE/COFF image.

The PE/COFF Loader Library abstracts the implementation of a PE/COFF loader for IA-32, x86, IPF, and EBC processor types. The library functions are memory-based and can be ported easily to any environment.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PeCoffLib.h.

Macro Definition Documentation

◆ IMAGE_ERROR_FAILED_ICACHE_FLUSH

#define IMAGE_ERROR_FAILED_ICACHE_FLUSH 10

Definition at line 30 of file PeCoffLib.h.

◆ IMAGE_ERROR_FAILED_RELOCATION

#define IMAGE_ERROR_FAILED_RELOCATION 9

Definition at line 29 of file PeCoffLib.h.

◆ IMAGE_ERROR_IMAGE_READ

#define IMAGE_ERROR_IMAGE_READ 1

Definition at line 21 of file PeCoffLib.h.

◆ IMAGE_ERROR_INVALID_IMAGE_ADDRESS

#define IMAGE_ERROR_INVALID_IMAGE_ADDRESS 5

Definition at line 25 of file PeCoffLib.h.

◆ IMAGE_ERROR_INVALID_IMAGE_SIZE

#define IMAGE_ERROR_INVALID_IMAGE_SIZE 6

Definition at line 26 of file PeCoffLib.h.

◆ IMAGE_ERROR_INVALID_MACHINE_TYPE

#define IMAGE_ERROR_INVALID_MACHINE_TYPE 3

Definition at line 23 of file PeCoffLib.h.

◆ IMAGE_ERROR_INVALID_PE_HEADER_SIGNATURE

#define IMAGE_ERROR_INVALID_PE_HEADER_SIGNATURE 2

Definition at line 22 of file PeCoffLib.h.

◆ IMAGE_ERROR_INVALID_SECTION_ALIGNMENT

#define IMAGE_ERROR_INVALID_SECTION_ALIGNMENT 7

Definition at line 27 of file PeCoffLib.h.

◆ IMAGE_ERROR_INVALID_SUBSYSTEM

#define IMAGE_ERROR_INVALID_SUBSYSTEM 4

Definition at line 24 of file PeCoffLib.h.

◆ IMAGE_ERROR_SECTION_NOT_LOADED

#define IMAGE_ERROR_SECTION_NOT_LOADED 8

Definition at line 28 of file PeCoffLib.h.

◆ IMAGE_ERROR_SUCCESS

#define IMAGE_ERROR_SUCCESS 0

Definition at line 20 of file PeCoffLib.h.

◆ IMAGE_ERROR_UNSUPPORTED

#define IMAGE_ERROR_UNSUPPORTED 11

Definition at line 31 of file PeCoffLib.h.

Typedef Documentation

◆ PE_COFF_LOADER_READ_FILE

typedef RETURN_STATUS(EFIAPI * PE_COFF_LOADER_READ_FILE) (IN VOID *FileHandle, IN UINTN FileOffset, IN OUT UINTN *ReadSize, OUT VOID *Buffer)

Reads contents of a PE/COFF image.

A function of this type reads contents of the PE/COFF image 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. If FileOffset specifies an offset past the end of the PE/COFF image, a ReadSize of 0 is returned. A function of this type must be registered in the ImageRead field of a PE_COFF_LOADER_IMAGE_CONTEXT structure for the PE/COFF Loader Library service to function correctly. This function abstracts access to a PE/COFF image so it can be implemented in an environment specific manner. For example, SEC and PEI environments may access memory directly to read the contents of a PE/COFF image, and DXE or UEFI environments may require protocol services to read the contents of PE/COFF image stored on FLASH, disk, or network devices.

If FileHandle is not a valid handle, then ASSERT(). If ReadSize is NULL, then ASSERT(). If Buffer is NULL, then ASSERT().

Parameters

FileHandle	Pointer to the file handle to read the PE/COFF image.
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 values

RETURN_SUCCESS	The specified portion of the PE/COFF image was read and the size return in ReadSize.
RETURN_DEVICE_ERROR	The specified portion of the PE/COFF image could not be read due to a device error.

Definition at line 64 of file PeCoffLib.h.

Function Documentation

◆ PeCoffLoaderGetImageInfo()

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, 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.

Parameters

ImageContext The pointer to the image context structure that describes the PE/COFF image that needs to be examined by this function.

Return values

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.

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.

Parameters

ImageContext The pointer to the image context structure that describes the PE/COFF image that needs to be examined by this function.

Return values

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.

◆ PeCoffLoaderImageReadFromMemory()

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.

If FileHandle is NULL, then ASSERT(). If ReadSize is NULL, then ASSERT(). If Buffer is NULL, then ASSERT().

Parameters

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 values

RETURN_SUCCESS The data is read from FileOffset from the Handle into the 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().

Parameters

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 values

RETURN_SUCCESS Data is read from FileOffset from the Handle into the buffer.

Definition at line 1992 of file BasePeCoff.c.

◆ PeCoffLoaderLoadImage()

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.

Parameters

ImageContext The pointer to the image context structure that describes the PE/COFF image that is being loaded.

Return values

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.

◆ PeCoffLoaderRelocateImage()

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.

Parameters

ImageContext The pointer to the image context structure that describes the PE/COFF image that is being relocated.

Return values

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.

◆ PeCoffLoaderRelocateImageForRuntime()

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 virtual 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.

Parameters

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().

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.

Parameters

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.

◆ PeCoffLoaderUnloadImage()

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().

Parameters

ImageContext Pointer to the image context structure that describes the PE/COFF image to be unloaded.

Return values

RETURN_SUCCESS The PE/COFF image was unloaded successfully.

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().

Parameters

ImageContext The pointer to the image context structure that describes the PE/COFF image to be unloaded.

Return values

RETURN_SUCCESS The PE/COFF image was unloaded successfully.

Definition at line 2025 of file BasePeCoff.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ IMAGE_ERROR_FAILED_ICACHE_FLUSH

◆ IMAGE_ERROR_FAILED_RELOCATION

◆ IMAGE_ERROR_IMAGE_READ

◆ IMAGE_ERROR_INVALID_IMAGE_ADDRESS

◆ IMAGE_ERROR_INVALID_IMAGE_SIZE

◆ IMAGE_ERROR_INVALID_MACHINE_TYPE

◆ IMAGE_ERROR_INVALID_PE_HEADER_SIGNATURE

◆ IMAGE_ERROR_INVALID_SECTION_ALIGNMENT

◆ IMAGE_ERROR_INVALID_SUBSYSTEM

◆ IMAGE_ERROR_SECTION_NOT_LOADED

◆ IMAGE_ERROR_SUCCESS

◆ IMAGE_ERROR_UNSUPPORTED

Typedef Documentation

◆ PE_COFF_LOADER_READ_FILE

Function Documentation

◆ PeCoffLoaderGetImageInfo()

◆ PeCoffLoaderImageReadFromMemory()

◆ PeCoffLoaderLoadImage()

◆ PeCoffLoaderRelocateImage()

◆ PeCoffLoaderRelocateImageForRuntime()

◆ PeCoffLoaderUnloadImage()