EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Data Structures | Defines | Typedefs | Functions

VBoxPkg/Include/Library/PeCoffLib.h File Reference

#include <IndustryStandard/PeImage.h>

Go to the source code of this file.

Data Structures

struct  PE_COFF_LOADER_IMAGE_CONTEXT

Defines

#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

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 - 2008, Intel Corporation
Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.
All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file PeCoffLib.h.


Define Documentation

#define IMAGE_ERROR_FAILED_ICACHE_FLUSH   10

Definition at line 37 of file PeCoffLib.h.

#define IMAGE_ERROR_FAILED_RELOCATION   9

Definition at line 36 of file PeCoffLib.h.

#define IMAGE_ERROR_IMAGE_READ   1

Definition at line 28 of file PeCoffLib.h.

#define IMAGE_ERROR_INVALID_IMAGE_ADDRESS   5

Definition at line 32 of file PeCoffLib.h.

#define IMAGE_ERROR_INVALID_IMAGE_SIZE   6

Definition at line 33 of file PeCoffLib.h.

#define IMAGE_ERROR_INVALID_MACHINE_TYPE   3

Definition at line 30 of file PeCoffLib.h.

#define IMAGE_ERROR_INVALID_PE_HEADER_SIGNATURE   2

Definition at line 29 of file PeCoffLib.h.

#define IMAGE_ERROR_INVALID_SECTION_ALIGNMENT   7

Definition at line 34 of file PeCoffLib.h.

#define IMAGE_ERROR_INVALID_SUBSYSTEM   4

Definition at line 31 of file PeCoffLib.h.

#define IMAGE_ERROR_SECTION_NOT_LOADED   8

Definition at line 35 of file PeCoffLib.h.

#define IMAGE_ERROR_SUCCESS   0

Definition at line 27 of file PeCoffLib.h.


Typedef Documentation

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:
FileHandlePointer to the file handle to read the PE/COFF image.
FileOffsetOffset into the PE/COFF image to begin the read operation.
ReadSizeOn input, the size in bytes of the requested read operation. On output, the number of bytes actually read.
BufferOutput buffer that contains the data read from the PE/COFF image.
Return values:
RETURN_SUCCESSThe specified portion of the PE/COFF image was read and the size
RETURN_DEVICE_ERRORThe specified portion of the PE/COFF image could not be read due to a device error.

Definition at line 70 of file PeCoffLib.h.


Function Documentation

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:
ImageContextPointer to the image context structure that describes the PE/COFF image that needs to be examined by this function.
Return values:
RETURN_SUCCESSThe information on the PE/COFF image was collected.
RETURN_INVALID_PARAMETERImageContext is NULL.
RETURN_UNSUPPORTEDThe PE/COFF image is not supported.

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:
ImageContextThe pointer to the image context structure that describes the PE/COFF image that needs to be examined by this function.
Return values:
RETURN_SUCCESSThe information on the PE/COFF image was collected.
RETURN_INVALID_PARAMETERImageContext is NULL.
RETURN_UNSUPPORTEDThe PE/COFF image is not supported.

Retrieves information on a PE/COFF image

Parameters:
ImageContextThe context of the image being loaded
Return values:
EFI_SUCCESSThe information on the PE/COFF image was collected.
EFI_INVALID_PARAMETERImageContext is NULL.
EFI_UNSUPPORTEDThe PE/COFF image is not supported.
OtherwiseThe error status from reading the PE/COFF image using the ImageContext->ImageRead() function

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:
ImageContextThe pointer to the image context structure that describes the PE/COFF image that needs to be examined by this function.
Return values:
RETURN_SUCCESSThe information on the PE/COFF image was collected.
RETURN_INVALID_PARAMETERImageContext is NULL.
RETURN_UNSUPPORTEDThe PE/COFF image is not supported.

Definition at line 198 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.

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

Parameters:
FileHandlePointer to base of the input stream
FileOffsetOffset into the PE/COFF image to begin the read operation.
ReadSizeOn input, the size in bytes of the requested read operation. On output, the number of bytes actually read.
BufferOutput buffer that contains the data read from the PE/COFF image.
Return values:
RETURN_SUCCESSData 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.

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

Parameters:
FileHandleThe pointer to base of the input stream
FileOffsetOffset into the PE/COFF image to begin the read operation.
ReadSizeOn input, the size in bytes of the requested read operation. On output, the number of bytes actually read.
BufferOutput buffer that contains the data read from the PE/COFF image.
Return values:
RETURN_SUCCESSData is read from FileOffset from the Handle into the buffer.

ImageRead function that operates on a memory buffer whos base is passed into FileHandle.

Parameters:
FileHandlePonter to baes of the input stream
FileOffsetOffset to the start of the buffer
ReadSizeNumber of bytes to copy into the buffer
BufferLocation to place results of read
Return values:
RETURN_SUCCESSData is read from FileOffset from the Handle into the buffer.

Definition at line 1485 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.

Parameters:
ImageContextPointer to the image context structure that describes the PE/COFF image that is being loaded.
Return values:
RETURN_SUCCESSThe 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_SMALLThe caller did not provide a large enough buffer. Extended status information is in the ImageError field of ImageContext.
RETURN_LOAD_ERRORThe PE/COFF image is an EFI Runtime image with no relocations. Extended status information is in the ImageError field of ImageContext.
RETURN_INVALID_PARAMETERThe image address is invalid. Extended status information is in the ImageError field of 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:
ImageContextThe pointer to the image context structure that describes the PE/COFF image that is being loaded.
Return values:
RETURN_SUCCESSThe 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_SMALLThe caller did not provide a large enough buffer. Extended status information is in the ImageError field of ImageContext.
RETURN_LOAD_ERRORThe PE/COFF image is an EFI Runtime image with no relocations. Extended status information is in the ImageError field of ImageContext.
RETURN_INVALID_PARAMETERThe image address is invalid. Extended status information is in the ImageError field of ImageContext.

Loads a PE/COFF image into memory

Parameters:
ImageContextContains information on image to load into memory
Return values:
EFI_SUCCESSif the PE/COFF image was loaded
EFI_BUFFER_TOO_SMALLif the caller did not provide a large enough buffer
EFI_LOAD_ERRORif the image is a runtime driver with no relocations
EFI_INVALID_PARAMETERif the image address is invalid

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:
ImageContextThe pointer to the image context structure that describes the PE/COFF image that is being loaded.
Return values:
RETURN_SUCCESSThe 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_SMALLThe caller did not provide a large enough buffer. Extended status information is in the ImageError field of ImageContext.
RETURN_LOAD_ERRORThe PE/COFF image is an EFI Runtime image with no relocations. Extended status information is in the ImageError field of ImageContext.
RETURN_INVALID_PARAMETERThe image address is invalid. Extended status information is in the ImageError field of ImageContext.

Definition at line 800 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.

Parameters:
ImageContextPointer to the image context structure that describes the PE/COFF image that is being relocated.
Return values:
RETURN_SUCCESSThe PE/COFF image was relocated. Extended status information is in the ImageError field of ImageContext.
RETURN_LOAD_ERRORThe image in not a valid PE/COFF image. Extended status information is in the ImageError field of ImageContext.
RETURN_UNSUPPORTEDA relocation record type is not supported. Extended status information is in the ImageError field of 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:
ImageContextThe pointer to the image context structure that describes the PE/COFF image that is being relocated.
Return values:
RETURN_SUCCESSThe PE/COFF image was relocated. Extended status information is in the ImageError field of ImageContext.
RETURN_LOAD_ERRORThe image in not a valid PE/COFF image. Extended status information is in the ImageError field of ImageContext.
RETURN_UNSUPPORTEDA relocation record type is not supported. Extended status information is in the ImageError field of ImageContext.

Relocates a PE/COFF image in memory

Parameters:
ImageContextContains information on the loaded image to relocate
Return values:
EFI_SUCCESSif the PE/COFF image was relocated
EFI_LOAD_ERRORif the image is not a valid PE/COFF image
EFI_UNSUPPORTEDnot support

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:
ImageContextThe pointer to the image context structure that describes the PE/COFF image that is being relocated.
Return values:
RETURN_SUCCESSThe PE/COFF image was relocated. Extended status information is in the ImageError field of ImageContext.
RETURN_LOAD_ERRORThe image in not a valid PE/COFF image. Extended status information is in the ImageError field of ImageContext.
RETURN_UNSUPPORTEDA relocation record type is not supported. Extended status information is in the ImageError field of ImageContext.

Definition at line 516 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 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:
ImageBaseBase address of a PE/COFF image that has been loaded and relocated into system memory.
VirtImageBaseThe request virtual address that the PE/COFF image is to be fixed up for.
ImageSizeThe size, in bytes, of the PE/COFF image.
RelocationDataA 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:
ImageBaseThe base address of a PE/COFF image that has been loaded and relocated into system memory.
VirtImageBaseThe request virtual address that the PE/COFF image is to be fixed up for.
ImageSizeThe size, in bytes, of the PE/COFF image.
RelocationDataA 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.

PE_COFF_LOADER_IMAGE_CONTEXT.FixupData stores information needed to reapply the fixups with a virtual mapping.

Parameters:
ImageBaseBase address of relocated image
VirtImageBaseVirtual mapping for ImageBase
ImageSizeSize of the image to relocate
RelocationDataLocation to place results of read

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:
ImageBaseBase address of a PE/COFF image that has been loaded and relocated into system memory.
VirtImageBaseThe request virtual address that the PE/COFF image is to be fixed up for.
ImageSizeThe size, in bytes, of the PE/COFF image.
RelocationDataA pointer to the relocation data that was collected when the PE/COFF image was relocated using PeCoffLoaderRelocateImage().

Definition at line 1273 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().

Parameters:
ImageContextPointer to the image context structure that describes the PE/COFF image to be unloaded.
Return values:
RETURN_SUCCESSThe 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:
ImageContextThe pointer to the image context structure that describes the PE/COFF image to be unloaded.
Return values:
RETURN_SUCCESSThe PE/COFF image was unloaded successfully.

Definition at line 1518 of file BasePeCoff.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines