/** @file\r
- Memory Only PE COFF loader\r
+ Provides services to load and relocate a PE/COFF image.\r
\r
- Copyright (c) 2006, Intel Corporation \r
- All rights reserved. This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. The full text of the license may be found at \r
- http://opensource.org/licenses/bsd-license.php \r
+ The PE/COFF Loader Library abstracts the implementation of a PE/COFF loader for\r
+ IA-32, x86, IPF, and EBC processor types. The library functions are memory based \r
+ and can be ported easily to any environment.\r
+ \r
+Copyright (c) 2006 - 2008, Intel Corporation \r
+All rights reserved. This program and the accompanying materials \r
+are licensed and made available under the terms and conditions of the BSD License \r
+which accompanies this distribution. The full text of the license may be found at \r
+http://opensource.org/licenses/bsd-license.php \r
\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
-\r
- Module Name: PeCoffLib.h\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
**/\r
\r
#ifndef __BASE_PE_COFF_LIB_H__\r
#define __BASE_PE_COFF_LIB_H__\r
\r
+#include <IndustryStandard/PeImage.h>\r
//\r
// Return status codes from the PE/COFF Loader services\r
-// BUGBUG: Find where used and see if can be replaced by RETURN_STATUS codes\r
//\r
#define IMAGE_ERROR_SUCCESS 0\r
#define IMAGE_ERROR_IMAGE_READ 1 \r
#define IMAGE_ERROR_FAILED_RELOCATION 9\r
#define IMAGE_ERROR_FAILED_ICACHE_FLUSH 10\r
\r
+/**\r
+ Reads contents of a PE/COFF image.\r
\r
-//\r
-// PE/COFF Loader Read Function passed in by caller\r
-//\r
+ A function of this type reads contents of the PE/COFF image specified by FileHandle. The read \r
+ operation copies ReadSize bytes from the PE/COFF image starting at byte offset FileOffset into \r
+ the buffer specified by Buffer. The size of the buffer actually read is returned in ReadSize. \r
+ If FileOffset specifies an offset past the end of the PE/COFF image, a ReadSize of 0 is returned.\r
+ A function of this type must be registered in the ImageRead field of a PE_COFF_LOADER_IMAGE_CONTEXT \r
+ structure for the PE/COFF Loader Library service to function correctly. This function abstracts access \r
+ to a PE/COFF image so it can be implemented in an environment specific manner. For example, SEC and PEI \r
+ environments may access memory directly to read the contents of a PE/COFF image, and DXE or UEFI \r
+ environments may require protocol services to read the contents of PE/COFF image \r
+ stored on FLASH, disk, or network devices.\r
+ \r
+ If FileHandle is not a valid handle, then ASSERT().\r
+ If ReadSize is NULL, then ASSERT().\r
+ If Buffer is NULL, then ASSERT().\r
+\r
+ @param FileHandle Pointer to the file handle to read the PE/COFF image.\r
+ @param FileOffset Offset into the PE/COFF image to begin the read operation.\r
+ @param ReadSize On input, the size in bytes of the requested read operation. \r
+ On output, the number of bytes actually read.\r
+ @param Buffer Output buffer that contains the data read from the PE/COFF image.\r
+ \r
+ @retval RETURN_SUCCESS The specified portion of the PE/COFF image was read and the size \r
+ @retval RETURN_DEVICE_ERROR The specified portion of the PE/COFF image could not be read due \r
+ to a device error.\r
+\r
+**/\r
typedef\r
RETURN_STATUS\r
-(EFIAPI *PE_COFF_LOADER_READ_FILE) (\r
+(EFIAPI *PE_COFF_LOADER_READ_FILE)(\r
IN VOID *FileHandle,\r
IN UINTN FileOffset,\r
IN OUT UINTN *ReadSize,\r
OUT VOID *Buffer\r
);\r
\r
-//\r
-// Context structure used while PE/COFF image is being loaded and relocated\r
-//\r
+///\r
+/// Context structure used while PE/COFF image is being loaded and relocated\r
+///\r
typedef struct {\r
+ ///\r
+ /// Is set by PeCoffLoaderGetImageInfo() to the ImageBase in the PE/COFF header\r
+ ///\r
PHYSICAL_ADDRESS ImageAddress;\r
+ ///\r
+ /// Is set by PeCoffLoaderGetImageInfo() to the SizeOfImage in the PE/COFF header.\r
+ /// Image size includes the size of Debug Entry if it is present.\r
+ ///\r
UINT64 ImageSize;\r
+ ///\r
+ /// Is set to zero by PeCoffLoaderGetImageInfo(). If DestinationAddress is non zero,\r
+ /// PeCoffLoaderRelocateImage() will relocate the image using this base address.\r
+ /// If the DestinationAddress is zero, the ImageAddress will be used as the base\r
+ /// address of relocation.\r
+ ///\r
PHYSICAL_ADDRESS DestinationAddress;\r
+ ///\r
+ /// PeCoffLoaderLoadImage() sets EntryPoint to to the entry point of the PE/COFF image.\r
+ ///\r
PHYSICAL_ADDRESS EntryPoint;\r
+ ///\r
+ /// Passed in by the caller to PeCoffLoaderGetImageInfo() and PeCoffLoaderLoadImage()\r
+ /// to abstract accessing the image from the library.\r
+ ///\r
PE_COFF_LOADER_READ_FILE ImageRead;\r
+ ///\r
+ /// Used as the FileHandle passed into the ImageRead function when it's called.\r
+ ///\r
VOID *Handle;\r
+ ///\r
+ /// Caller allocated buffer of size FixupDataSize that can be optionally allocated\r
+ /// prior to calling PeCoffLoaderRelocateImage(). \r
+ /// This buffer is filled with the information used to fix up the image. \r
+ /// The fixups have been applied to the image and this entry is just for information.\r
+ ///\r
VOID *FixupData;\r
+ ///\r
+ /// Is set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header\r
+ /// If the image is a TE image, then this field is set to 0.\r
+ ///\r
UINT32 SectionAlignment;\r
+ ///\r
+ /// Set by PeCoffLoaderGetImageInfo() to offset to the PE/COFF header.\r
+ /// If the PE/COFF image does not start with a DOS header, this value is zero; \r
+ /// otherwise, it's the offset to the PE/COFF header.\r
+ ///\r
UINT32 PeCoffHeaderOffset;\r
+ ///\r
+ /// Set by PeCoffLoaderGetImageInfo() to the Relative Virtual Address of the debug directory\r
+ /// if it exists in the image\r
+ ///\r
UINT32 DebugDirectoryEntryRva;\r
+ ///\r
+ /// Set by PeCoffLoaderLoadImage() to CodeView area of the PE/COFF Debug directory.\r
+ ///\r
VOID *CodeView;\r
+ ///\r
+ /// Set by PeCoffLoaderLoadImage() to point to the PDB entry contained in the CodeView area.\r
+ /// The PdbPointer points to the filename of the PDB file used for source-level debug of \r
+ /// the image by a debugger.\r
+ ///\r
CHAR8 *PdbPointer;\r
+ ///\r
+ /// Is set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header.\r
+ ///\r
UINTN SizeOfHeaders;\r
+ ///\r
+ /// Not used by this library class. Other library classes that layer on top of this library\r
+ /// class fill in this value as part of their GetImageInfo call. \r
+ /// This allows the caller of the library to know what type of memory needs to be allocated\r
+ /// to load and relocate the image.\r
+ ///\r
UINT32 ImageCodeMemoryType;\r
+ ///\r
+ /// Not used by this library class. Other library classes that layer on top of this library \r
+ /// class fill in this value as part of their GetImageInfo call.\r
+ /// This allows the caller of the library to know what type of memory needs to be allocated\r
+ /// to load and relocate the image\r
+ ///\r
UINT32 ImageDataMemoryType;\r
+ ///\r
+ /// Set by any of the library functions if they encounter an error. \r
+ ///\r
UINT32 ImageError;\r
+ ///\r
+ /// Set by PeCoffLoaderLoadImage() to indicate the size of FixupData that the caller must\r
+ /// allocate before calling PeCoffLoaderRelocateImage()\r
+ ///\r
UINTN FixupDataSize;\r
+ ///\r
+ /// Set by PeCoffLoaderGetImageInfo() to the machine type stored in the PE/COFF header\r
+ ///\r
UINT16 Machine;\r
+ ///\r
+ /// Set by PeCoffLoaderGetImageInfo() to the subsystem type stored in the PE/COFF header.\r
+ ///\r
UINT16 ImageType;\r
+ ///\r
+ /// Set by PeCoffLoaderGetImageInfo() to TRUE if the PE/COFF image does not contain\r
+ /// relocation information.\r
+ ///\r
BOOLEAN RelocationsStripped;\r
+ ///\r
+ /// Set by PeCoffLoaderGetImageInfo() to TRUE if the image is a TE image. \r
+ /// For a definition of the TE Image format, see the Platform Initialization Pre-EFI\r
+ /// Initialization Core Interface Specification.\r
+ ///\r
BOOLEAN IsTeImage;\r
} PE_COFF_LOADER_IMAGE_CONTEXT;\r
\r
-\r
/**\r
- Retrieves information on a PE/COFF image\r
+ Retrieves information about a PE/COFF image.\r
\r
- @param ImageContext The context of the image being loaded\r
+ Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize, \r
+ DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and \r
+ DebugDirectoryEntryRva fields of the ImageContext structure. \r
+ If ImageContext is NULL, then return RETURN_INVALID_PARAMETER. \r
+ If the PE/COFF image accessed through the ImageRead service in the ImageContext \r
+ structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED. \r
+ If any errors occur while computing the fields of ImageContext, \r
+ then the error status is returned in the ImageError field of ImageContext. \r
+ If the image is a TE image, then SectionAlignment is set to 0.\r
+ The ImageRead and Handle fields of ImageContext structure must be valid prior \r
+ to invoking this service.\r
\r
- @retval EFI_SUCCESS The information on the PE/COFF image was collected.\r
- @retval EFI_INVALID_PARAMETER ImageContext is NULL.\r
- @retval EFI_UNSUPPORTED The PE/COFF image is not supported.\r
- @retval Otherwise The error status from reading the PE/COFF image using the\r
- ImageContext->ImageRead() function\r
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF\r
+ image that needs to be examined by this function.\r
+\r
+ @retval RETURN_SUCCESS The information on the PE/COFF image was collected.\r
+ @retval RETURN_INVALID_PARAMETER ImageContext is NULL.\r
+ @retval RETURN_UNSUPPORTED The PE/COFF image is not supported.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
PeCoffLoaderGetImageInfo (\r
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
- )\r
-;\r
+ );\r
\r
/**\r
- Relocates a PE/COFF image in memory\r
+ Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().\r
+\r
+ If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of\r
+ ImageContext as the relocation base address. Otherwise, use the DestinationAddress field\r
+ of ImageContext as the relocation base address. The caller must allocate the relocation\r
+ fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.\r
+ \r
+ The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, \r
+ ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, \r
+ DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of \r
+ the ImageContext structure must be valid prior to invoking this service.\r
+ \r
+ If ImageContext is NULL, then ASSERT().\r
\r
- @param ImageContext Contains information on the loaded image to relocate\r
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF\r
+ image that is being relocated.\r
\r
- @retval EFI_SUCCESS if the PE/COFF image was relocated\r
- @retval EFI_LOAD_ERROR if the image is not a valid PE/COFF image\r
- @retval EFI_UNSUPPORTED not support\r
+ @retval RETURN_SUCCESS The PE/COFF image was relocated.\r
+ Extended status information is in the ImageError field of ImageContext.\r
+ @retval RETURN_LOAD_ERROR The image in not a valid PE/COFF image.\r
+ Extended status information is in the ImageError field of ImageContext.\r
+ @retval RETURN_UNSUPPORTED A relocation record type is not supported.\r
+ Extended status information is in the ImageError field of ImageContext.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
PeCoffLoaderRelocateImage (\r
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
- )\r
-;\r
+ );\r
\r
/**\r
- Loads a PE/COFF image into memory\r
+ Loads a PE/COFF image into memory.\r
+\r
+ Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer\r
+ specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate\r
+ the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.\r
+ The EntryPoint, FixupDataSize, CodeView, and PdbPointer fields of ImageContext are computed.\r
+ The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize, \r
+ DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva \r
+ fields of the ImageContext structure must be valid prior to invoking this service.\r
+ \r
+ If ImageContext is NULL, then ASSERT().\r
\r
- @param ImageContext Contains information on image to load into memory\r
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF\r
+ image that is being loaded.\r
\r
- @retval EFI_SUCCESS if the PE/COFF image was loaded\r
- @retval EFI_BUFFER_TOO_SMALL if the caller did not provide a large enough buffer\r
- @retval EFI_LOAD_ERROR if the image is a runtime driver with no relocations\r
- @retval EFI_INVALID_PARAMETER if the image address is invalid\r
+ @retval RETURN_SUCCESS The PE/COFF image was loaded into the buffer specified by\r
+ the ImageAddress and ImageSize fields of ImageContext.\r
+ Extended status information is in the ImageError field of ImageContext.\r
+ @retval RETURN_BUFFER_TOO_SMALL The caller did not provide a large enough buffer.\r
+ Extended status information is in the ImageError field of ImageContext.\r
+ @retval RETURN_LOAD_ERROR The PE/COFF image is an EFI Runtime image with no relocations.\r
+ Extended status information is in the ImageError field of ImageContext.\r
+ @retval RETURN_INVALID_PARAMETER The image address is invalid.\r
+ Extended status information is in the ImageError field of ImageContext.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
PeCoffLoaderLoadImage (\r
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
- )\r
-;\r
+ );\r
+\r
+\r
+/**\r
+ Reads contents of a PE/COFF image from a buffer in system memory.\r
+ \r
+ This is the default implementation of a PE_COFF_LOADER_READ_FILE function \r
+ that assumes FileHandle pointer to the beginning of a PE/COFF image. \r
+ This function reads contents of the PE/COFF image that starts at the system memory \r
+ address specified by FileHandle. The read operation copies ReadSize bytes from the \r
+ PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer. \r
+ The size of the buffer actually read is returned in ReadSize.\r
+ \r
+ If FileHandle is NULL, then ASSERT().\r
+ If ReadSize is NULL, then ASSERT().\r
+ If Buffer is NULL, then ASSERT().\r
+\r
+ @param FileHandle Pointer to base of the input stream\r
+ @param FileOffset Offset into the PE/COFF image to begin the read operation.\r
+ @param ReadSize On input, the size in bytes of the requested read operation. \r
+ On output, the number of bytes actually read.\r
+ @param Buffer Output buffer that contains the data read from the PE/COFF image.\r
\r
+ @retval RETURN_SUCCESS Data is read from FileOffset from the Handle into \r
+ the buffer.\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+PeCoffLoaderImageReadFromMemory (\r
+ IN VOID *FileHandle,\r
+ IN UINTN FileOffset,\r
+ IN OUT UINTN *ReadSize,\r
+ OUT VOID *Buffer\r
+ );\r
+\r
+\r
+/**\r
+ Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI\r
+ runtime. \r
+ \r
+ PE_COFF_LOADER_IMAGE_CONTEXT.FixupData stores information needed to reapply\r
+ the fixups with a virtual mapping.\r
+\r
+\r
+ @param ImageBase Base address of a PE/COFF image that has been loaded \r
+ and relocated into system memory.\r
+ @param VirtImageBase The request virtual address that the PE/COFF image is to\r
+ be fixed up for.\r
+ @param ImageSize The size, in bytes, of the PE/COFF image.\r
+ @param RelocationData A pointer to the relocation data that was collected when the PE/COFF \r
+ image was relocated using PeCoffLoaderRelocateImage().\r
+ \r
+**/\r
+VOID\r
+EFIAPI\r
+PeCoffLoaderRelocateImageForRuntime (\r
+ IN PHYSICAL_ADDRESS ImageBase,\r
+ IN PHYSICAL_ADDRESS VirtImageBase,\r
+ IN UINTN ImageSize,\r
+ IN VOID *RelocationData\r
+ );\r
+\r
+/**\r
+ Unloads a loaded PE/COFF image from memory and releases its taken resource.\r
+ Releases any environment specific resources that were allocated when the image \r
+ specified by ImageContext was loaded using PeCoffLoaderLoadImage(). \r
+ \r
+ For NT32 emulator, the PE/COFF image loaded by system needs to release.\r
+ For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, \r
+ this function can simply return RETURN_SUCCESS.\r
+ \r
+ If ImageContext is NULL, then ASSERT().\r
+ \r
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF\r
+ image to be unloaded.\r
+\r
+ @retval RETURN_SUCCESS The PE/COFF image was unloaded successfully.\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+PeCoffLoaderUnloadImage (\r
+ IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
+ );\r
#endif\r
projects / mirror_edk2.git / blobdiff