/** @file\r
- Memory Only PE COFF loader\r
+ Memory Only PE COFF loader. \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
+ Copyright (c) 2006 - 2007, 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
+ 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
+ Module Name: PeCoffLib.h\r
\r
**/\r
\r
#ifndef __BASE_PE_COFF_LIB_H__\r
#define __BASE_PE_COFF_LIB_H__\r
\r
+#include <Common/PeCoffLoaderImageContext.h>\r
+\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
#define IMAGE_ERROR_FAILED_ICACHE_FLUSH 10\r
\r
\r
-//\r
-// PE/COFF Loader Read Function passed in by caller\r
-//\r
-typedef\r
-RETURN_STATUS\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
-typedef struct {\r
- PHYSICAL_ADDRESS ImageAddress;\r
- UINT64 ImageSize;\r
- PHYSICAL_ADDRESS DestinationAddress;\r
- PHYSICAL_ADDRESS EntryPoint;\r
- PE_COFF_LOADER_READ_FILE ImageRead;\r
- VOID *Handle;\r
- VOID *FixupData;\r
- UINT32 SectionAlignment;\r
- UINT32 PeCoffHeaderOffset;\r
- UINT32 DebugDirectoryEntryRva;\r
- VOID *CodeView;\r
- CHAR8 *PdbPointer;\r
- UINTN SizeOfHeaders;\r
- UINT32 ImageCodeMemoryType;\r
- UINT32 ImageDataMemoryType;\r
- UINT32 ImageError;\r
- UINTN FixupDataSize;\r
- UINT16 Machine;\r
- UINT16 ImageType;\r
- BOOLEAN RelocationsStripped;\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
+ Computes the PeCoffHeaderOffset, ImageAddress, ImageSize, DestinationAddress, CodeView,\r
+ PdbPointer, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva\r
+ fields of the ImageContext structure. If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.\r
+ If the PE/COFF image accessed through the ImageRead service in the ImageContext structure is not\r
+ a supported PE/COFF image type, then return RETURN_UNSUPPORTED. If any errors occur while\r
+ computing the fields of ImageContext, then the error status is returned in the ImageError field of\r
+ ImageContext. \r
\r
- @param ImageContext The context of the image being loaded\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 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
+ @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
;\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
- @param ImageContext Contains information on the loaded image to relocate\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
+ If ImageContext is NULL, then ASSERT().\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
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF\r
+ image that is being relocated.\r
+\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
;\r
\r
/**\r
- Loads a PE/COFF image into memory\r
-\r
- @param ImageContext Contains information on image to load into memory\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
+ 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
+ If ImageContext is NULL, then ASSERT().\r
+\r
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF\r
+ image that is being loaded.\r
+\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
)\r
;\r
\r
+\r
+/**\r
+ ImageRead function that operates on a memory buffer whos base is passed into\r
+ FileHandle. \r
+\r
+ @param FileHandle Ponter to baes of the input stream\r
+ @param FileOffset Offset to the start of the buffer\r
+ @param ReadSize Number of bytes to copy into the buffer\r
+ @param Buffer Location to place results of read\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
+/**\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 relocated image\r
+ @param VirtImageBase Virtual mapping for ImageBase\r
+ @param ImageSize Size of the image to relocate\r
+ @param RelocationData Location to place results of read\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
+\r
#endif\r
projects / mirror_edk2.git / blobdiff