4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides services to load and relocate a PE/COFF image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The PE/COFF Loader Library abstracts the implementation of a PE/COFF loader for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IA-32, x86, IPF, and EBC processor types. The library functions are memory-based
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and can be ported easily to any environment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsyncThis program and the accompanying materials are licensed and made available under
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsynchttp://opensource.org/licenses/bsd-license.php.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifndef __BASE_PE_COFF_LIB_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define __BASE_PE_COFF_LIB_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <IndustryStandard/PeImage.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Return status codes from the PE/COFF Loader services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IMAGE_ERROR_SUCCESS 0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IMAGE_ERROR_IMAGE_READ 1
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IMAGE_ERROR_INVALID_PE_HEADER_SIGNATURE 2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IMAGE_ERROR_INVALID_MACHINE_TYPE 3
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IMAGE_ERROR_INVALID_SUBSYSTEM 4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IMAGE_ERROR_INVALID_IMAGE_ADDRESS 5
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IMAGE_ERROR_INVALID_IMAGE_SIZE 6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IMAGE_ERROR_INVALID_SECTION_ALIGNMENT 7
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IMAGE_ERROR_SECTION_NOT_LOADED 8
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IMAGE_ERROR_FAILED_RELOCATION 9
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IMAGE_ERROR_FAILED_ICACHE_FLUSH 10
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Reads contents of a PE/COFF image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A function of this type reads contents of the PE/COFF image specified by FileHandle. The read
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync operation copies ReadSize bytes from the PE/COFF image starting at byte offset FileOffset into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the buffer specified by Buffer. The size of the buffer actually read is returned in ReadSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileOffset specifies an offset past the end of the PE/COFF image, a ReadSize of 0 is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A function of this type must be registered in the ImageRead field of a PE_COFF_LOADER_IMAGE_CONTEXT
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync structure for the PE/COFF Loader Library service to function correctly. This function abstracts access
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to a PE/COFF image so it can be implemented in an environment specific manner. For example, SEC and PEI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environments may access memory directly to read the contents of a PE/COFF image, and DXE or UEFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environments may require protocol services to read the contents of PE/COFF image
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync stored on FLASH, disk, or network devices.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileHandle is not a valid handle, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ReadSize is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Buffer is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle Pointer to the file handle to read the PE/COFF image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileOffset Offset into the PE/COFF image to begin the read operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ReadSize On input, the size in bytes of the requested read operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, the number of bytes actually read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Output buffer that contains the data read from the PE/COFF image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync @retval RETURN_SUCCESS The specified portion of the PE/COFF image was
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync read and the size
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync @retval RETURN_DEVICE_ERROR The specified portion of the PE/COFF image
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync could not be read due to a device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *PE_COFF_LOADER_READ_FILE)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *FileHandle,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINTN FileOffset,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINTN *ReadSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT VOID *Buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The context structure used while PE/COFF image is being loaded and relocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by PeCoffLoaderGetImageInfo() to the ImageBase in the PE/COFF header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PHYSICAL_ADDRESS ImageAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by PeCoffLoaderGetImageInfo() to the SizeOfImage in the PE/COFF header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Image size includes the size of Debug Entry if it is present.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 ImageSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Is set to zero by PeCoffLoaderGetImageInfo(). If DestinationAddress is non-zero,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PeCoffLoaderRelocateImage() will relocate the image using this base address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If the DestinationAddress is zero, the ImageAddress will be used as the base
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// address of relocation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PHYSICAL_ADDRESS DestinationAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PeCoffLoaderLoadImage() sets EntryPoint to to the entry point of the PE/COFF image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PHYSICAL_ADDRESS EntryPoint;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Passed in by the caller to PeCoffLoaderGetImageInfo() and PeCoffLoaderLoadImage()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to abstract accessing the image from the library.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PE_COFF_LOADER_READ_FILE ImageRead;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Used as the FileHandle passed into the ImageRead function when it's called.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *Handle;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Caller allocated buffer of size FixupDataSize that can be optionally allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// prior to calling PeCoffLoaderRelocateImage().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This buffer is filled with the information used to fix up the image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The fixups have been applied to the image and this entry is just for information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *FixupData;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If the image is a TE image, then this field is set to 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 SectionAlignment;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by PeCoffLoaderGetImageInfo() to offset to the PE/COFF header.
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync /// If the PE/COFF image does not start with a DOS header, this value is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Otherwise, it's the offset to the PE/COFF header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 PeCoffHeaderOffset;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by PeCoffLoaderGetImageInfo() to the Relative Virtual Address of the debug directory,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// if it exists in the image
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 DebugDirectoryEntryRva;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by PeCoffLoaderLoadImage() to CodeView area of the PE/COFF Debug directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *CodeView;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by PeCoffLoaderLoadImage() to point to the PDB entry contained in the CodeView area.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The PdbPointer points to the filename of the PDB file used for source-level debug of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the image by a debugger.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *PdbPointer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Is set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN SizeOfHeaders;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Not used by this library class. Other library classes that layer on top of this library
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// class fill in this value as part of their GetImageInfo call.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This allows the caller of the library to know what type of memory needs to be allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to load and relocate the image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 ImageCodeMemoryType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Not used by this library class. Other library classes that layer on top of this library
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// class fill in this value as part of their GetImageInfo call.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This allows the caller of the library to know what type of memory needs to be allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to load and relocate the image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 ImageDataMemoryType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by any of the library functions if they encounter an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 ImageError;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by PeCoffLoaderLoadImage() to indicate the size of FixupData that the caller must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// allocate before calling PeCoffLoaderRelocateImage().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN FixupDataSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by PeCoffLoaderGetImageInfo() to the machine type stored in the PE/COFF header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 Machine;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by PeCoffLoaderGetImageInfo() to the subsystem type stored in the PE/COFF header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 ImageType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by PeCoffLoaderGetImageInfo() to TRUE if the PE/COFF image does not contain
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// relocation information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN RelocationsStripped;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by PeCoffLoaderGetImageInfo() to TRUE if the image is a TE image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// For a definition of the TE Image format, see the Platform Initialization Pre-EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Initialization Core Interface Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN IsTeImage;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set by PeCoffLoaderLoadImage() to the HII resource offset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// if the image contains a custom PE/COFF resource with the type 'HII'.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Otherwise, the entry remains to be 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PHYSICAL_ADDRESS HiiResourceData;
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync#ifdef VBOX /* Mach-O FAT support. */
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync ///
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync /// Indicates that this is a FAT image.
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync ///
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync BOOLEAN IsFat;
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync ///
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync /// The EFI image offset within the FAT file.
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync ///
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync UINT32 FatOffset;
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync#endif
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Private storage for implementation specific data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync UINT64 Context;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} PE_COFF_LOADER_IMAGE_CONTEXT;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves information about a PE/COFF image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DebugDirectoryEntryRva fields of the ImageContext structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the PE/COFF image accessed through the ImageRead service in the ImageContext
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any errors occur while computing the fields of ImageContext,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then the error status is returned in the ImageError field of ImageContext.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the image is a TE image, then SectionAlignment is set to 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The ImageRead and Handle fields of ImageContext structure must be valid prior
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to invoking this service.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync @param ImageContext The pointer to the image context structure that
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync describes the PE/COFF image that needs to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync examined by this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS The information on the PE/COFF image was collected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_INVALID_PARAMETER ImageContext is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_UNSUPPORTED The PE/COFF image is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPeCoffLoaderGetImageInfo (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ImageContext as the relocation base address. Otherwise, use the DestinationAddress field
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of ImageContext as the relocation base address. The caller must allocate the relocation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the ImageContext structure must be valid prior to invoking this service.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ImageContext is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note that if the platform does not maintain coherency between the instruction cache(s) and the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync prior to transferring control to a PE/COFF image that is loaded using this library.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageContext The pointer to the image context structure that describes the PE/COFF
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync image that is being relocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS The PE/COFF image was relocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Extended status information is in the ImageError field of ImageContext.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_LOAD_ERROR The image in not a valid PE/COFF image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Extended status information is in the ImageError field of ImageContext.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_UNSUPPORTED A relocation record type is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Extended status information is in the ImageError field of ImageContext.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPeCoffLoaderRelocateImage (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Loads a PE/COFF image into memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EntryPoint, FixupDataSize, CodeView, PdbPointer and HiiResourceData fields of ImageContext are computed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync fields of the ImageContext structure must be valid prior to invoking this service.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ImageContext is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note that if the platform does not maintain coherency between the instruction cache(s) and the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync prior to transferring control to a PE/COFF image that is loaded using this library.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageContext The pointer to the image context structure that describes the PE/COFF
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync image that is being loaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS The PE/COFF image was loaded into the buffer specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the ImageAddress and ImageSize fields of ImageContext.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Extended status information is in the ImageError field of ImageContext.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_BUFFER_TOO_SMALL The caller did not provide a large enough buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Extended status information is in the ImageError field of ImageContext.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_LOAD_ERROR The PE/COFF image is an EFI Runtime image with no relocations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Extended status information is in the ImageError field of ImageContext.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_INVALID_PARAMETER The image address is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Extended status information is in the ImageError field of ImageContext.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPeCoffLoaderLoadImage (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Reads contents of a PE/COFF image from a buffer in system memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is the default implementation of a PE_COFF_LOADER_READ_FILE function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that assumes FileHandle pointer to the beginning of a PE/COFF image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function reads contents of the PE/COFF image that starts at the system memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address specified by FileHandle. The read operation copies ReadSize bytes from the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The size of the buffer actually read is returned in ReadSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileHandle is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ReadSize is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Buffer is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle The pointer to base of the input stream
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileOffset Offset into the PE/COFF image to begin the read operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ReadSize On input, the size in bytes of the requested read operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, the number of bytes actually read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Output buffer that contains the data read from the PE/COFF image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync @retval RETURN_SUCCESS The data is read from FileOffset from the Handle into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPeCoffLoaderImageReadFromMemory (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *FileHandle,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINTN FileOffset,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINTN *ReadSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT VOID *Buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync runtime.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function reapplies relocation fixups to the PE/COFF image specified by ImageBase
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and ImageSize so the image will execute correctly when the PE/COFF image is mapped
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the address specified by VirtualImageBase. RelocationData must be identical
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note that if the platform does not maintain coherency between the instruction cache(s) and the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync prior to transferring control to a PE/COFF image that is loaded using this library.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
404cc3d8ee7f345150f9d3ea57e56714adcca56avboxsync @param ImageBase The base address of a PE/COFF image that has been loaded
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and relocated into system memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VirtImageBase The request virtual address that the PE/COFF image is to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be fixed up for.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageSize The size, in bytes, of the PE/COFF image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RelocationData A pointer to the relocation data that was collected when the PE/COFF
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync image was relocated using PeCoffLoaderRelocateImage().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPeCoffLoaderRelocateImageForRuntime (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN PHYSICAL_ADDRESS ImageBase,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN PHYSICAL_ADDRESS VirtImageBase,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINTN ImageSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *RelocationData
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Unloads a loaded PE/COFF image from memory and releases its taken resource.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Releases any environment specific resources that were allocated when the image
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by ImageContext was loaded using PeCoffLoaderLoadImage().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For NT32 emulator, the PE/COFF image loaded by system needs to release.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function can simply return RETURN_SUCCESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ImageContext is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageContext Pointer to the image context structure that describes the PE/COFF
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync image to be unloaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS The PE/COFF image was unloaded successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPeCoffLoaderUnloadImage (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif