+++ /dev/null
-/*++\r
-\r
-Copyright (c) 2004 - 2006, Intel Corporation. All rights reserved.<BR>\r
-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
-\r
-Module Name:\r
-\r
- EdkIIGluePeCoffLib.h\r
-\r
-Abstract: \r
-\r
- Public header file for PeCoff Lib\r
-\r
---*/\r
-\r
-#ifndef __EDKII_GLUE_BASE_PE_COFF_LIB_H__\r
-#define __EDKII_GLUE_BASE_PE_COFF_LIB_H__\r
-\r
-\r
-#define PeCoffLoaderGetImageInfo(_IMAGECONTEXT) GluePeCoffLoaderGetImageInfo(_IMAGECONTEXT)\r
-#define PeCoffLoaderRelocateImage(_IMAGECONTEXT) GluePeCoffLoaderRelocateImage(_IMAGECONTEXT)\r
-#define PeCoffLoaderLoadImage(_IMAGECONTEXT) GluePeCoffLoaderLoadImage(_IMAGECONTEXT)\r
-#define PeCoffLoaderGetPeHeader(_IMAGECONTEXT, _HDR) GluePeCoffLoaderGetPeHeader(_IMAGECONTEXT, _HDR)\r
-#define PeCoffLoaderImageAddress(_IMAGECONTEXT, _ADR) GluePeCoffLoaderImageAddress(_IMAGECONTEXT, _ADR)\r
-#define PeCoffLoaderRelocateImage(_IMAGECONTEXT) GluePeCoffLoaderRelocateImage(_IMAGECONTEXT)\r
-#define PeCoffLoaderRelocateImageEx(_RELOC, _FIXUP, _FIXUPDATA, _ADJUST) \\r
- GluePeCoffLoaderRelocateImageEx(_RELOC, _FIXUP, _FIXUPDATA, _ADJUST)\r
-#define PeHotRelocateImageEx(_RELOC, _FIXUP, _FIXUPDATA, _ADJUST) \\r
- GluePeHotRelocateImageEx(_RELOC, _FIXUP, _FIXUPDATA, _ADJUST)\r
-\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
-//\r
-#define IMAGE_ERROR_SUCCESS 0\r
-#define IMAGE_ERROR_IMAGE_READ 1 \r
-#define IMAGE_ERROR_INVALID_PE_HEADER_SIGNATURE 2\r
-#define IMAGE_ERROR_INVALID_MACHINE_TYPE 3\r
-#define IMAGE_ERROR_INVALID_SUBSYSTEM 4\r
-#define IMAGE_ERROR_INVALID_IMAGE_ADDRESS 5\r
-#define IMAGE_ERROR_INVALID_IMAGE_SIZE 6\r
-#define IMAGE_ERROR_INVALID_SECTION_ALIGNMENT 7\r
-#define IMAGE_ERROR_SECTION_NOT_LOADED 8\r
-#define IMAGE_ERROR_FAILED_RELOCATION 9\r
-#define IMAGE_ERROR_FAILED_ICACHE_FLUSH 10\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
- 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 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
-GluePeCoffLoaderGetImageInfo (\r
- IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
- );\r
-\r
-/**\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
- 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 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
-EFIAPI\r
-GluePeCoffLoaderRelocateImage (\r
- IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
- );\r
-\r
-/**\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
-EFIAPI\r
-GluePeCoffLoaderLoadImage (\r
- IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\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
- 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
-#endif\r
projects / mirror_edk2.git / blobdiff