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
-
| ImageContext | Pointer to the image context structure that describes the PE/COFF image that needs to be examined by this function. |
- Return values
-
| RETURN_SUCCESS | The information on the PE/COFF image was collected. |
| RETURN_INVALID_PARAMETER | ImageContext is NULL. |
| RETURN_UNSUPPORTED | The PE/COFF image is not supported. |
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
-
| ImageContext | Pointer to the image context structure that describes the PE/COFF image that is being relocated. |
- Return values
-
| RETURN_SUCCESS | The PE/COFF image was relocated. Extended status information is in the ImageError field of ImageContext. |
| RETURN_LOAD_ERROR | The image in not a valid PE/COFF image. Extended status information is in the ImageError field of ImageContext. |
| RETURN_UNSUPPORTED | A relocation record type is not supported. 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
-
| ImageContext | Pointer to the image context structure that describes the PE/COFF image that is being loaded. |
- Return values
-
| RETURN_SUCCESS | The 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_SMALL | The caller did not provide a large enough buffer. Extended status information is in the ImageError field of ImageContext. |
| RETURN_LOAD_ERROR | The PE/COFF image is an EFI Runtime image with no relocations. Extended status information is in the ImageError field of ImageContext. |
| RETURN_INVALID_PARAMETER | The image address is invalid. Extended status information is in the ImageError field of ImageContext. |
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
-
| FileHandle | Pointer to base of the input stream |
| FileOffset | Offset into the PE/COFF image to begin the read operation. |
| ReadSize | On input, the size in bytes of the requested read operation. On output, the number of bytes actually read. |
| Buffer | Output buffer that contains the data read from the PE/COFF image. |
- Return values
-
| RETURN_SUCCESS | Data is read from FileOffset from the Handle into the buffer. |
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
-
| ImageContext | Pointer to the image context structure that describes the PE/COFF image to be unloaded. |
- Return values
-
| RETURN_SUCCESS | The PE/COFF image was unloaded successfully. |
1.8.6 
