PeCoffLib.h

Go to the documentation of this file.

 
#ifndef __BASE_PE_COFF_LIB_H__
#define __BASE_PE_COFF_LIB_H__
 
#include <IndustryStandard/PeImage.h>
//
// Return status codes from the PE/COFF Loader services
//
#define IMAGE_ERROR_SUCCESS                      0
#define IMAGE_ERROR_IMAGE_READ                   1
#define IMAGE_ERROR_INVALID_PE_HEADER_SIGNATURE  2
#define IMAGE_ERROR_INVALID_MACHINE_TYPE         3
#define IMAGE_ERROR_INVALID_SUBSYSTEM            4
#define IMAGE_ERROR_INVALID_IMAGE_ADDRESS        5
#define IMAGE_ERROR_INVALID_IMAGE_SIZE           6
#define IMAGE_ERROR_INVALID_SECTION_ALIGNMENT    7
#define IMAGE_ERROR_SECTION_NOT_LOADED           8
#define IMAGE_ERROR_FAILED_RELOCATION            9
#define IMAGE_ERROR_FAILED_ICACHE_FLUSH          10
#define IMAGE_ERROR_UNSUPPORTED                  11
 
typedef
RETURN_STATUS
(EFIAPI *PE_COFF_LOADER_READ_FILE)(
  IN     VOID   *FileHandle,
  IN     UINTN  FileOffset,
  IN OUT UINTN  *ReadSize,
  OUT    VOID   *Buffer
  );
 
typedef struct {
  PHYSICAL_ADDRESS            ImageAddress;
  UINT64                      ImageSize;
  PHYSICAL_ADDRESS            DestinationAddress;
  PHYSICAL_ADDRESS            EntryPoint;
  PE_COFF_LOADER_READ_FILE    ImageRead;
  VOID                        *Handle;
  VOID                        *FixupData;
  UINT32                      SectionAlignment;
  UINT32                      PeCoffHeaderOffset;
  UINT32                      DebugDirectoryEntryRva;
  VOID                        *CodeView;
  CHAR8                       *PdbPointer;
  UINTN                       SizeOfHeaders;
  UINT32                      ImageCodeMemoryType;
  UINT32                      ImageDataMemoryType;
  UINT32                      ImageError;
  UINTN                       FixupDataSize;
  UINT16                      Machine;
  UINT16                      ImageType;
  UINT16                      DllCharacteristics;
  UINT32                      DllCharacteristicsEx;
  BOOLEAN                     RelocationsStripped;
  BOOLEAN                     IsTeImage;
  PHYSICAL_ADDRESS            HiiResourceData;
  UINT64                      Context;
} PE_COFF_LOADER_IMAGE_CONTEXT;
 
RETURN_STATUS
EFIAPI
PeCoffLoaderGetImageInfo (
  IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
  );
 
RETURN_STATUS
EFIAPI
PeCoffLoaderRelocateImage (
  IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
  );
 
RETURN_STATUS
EFIAPI
PeCoffLoaderLoadImage (
  IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
  );
 
RETURN_STATUS
EFIAPI
PeCoffLoaderImageReadFromMemory (
  IN     VOID   *FileHandle,
  IN     UINTN  FileOffset,
  IN OUT UINTN  *ReadSize,
  OUT    VOID   *Buffer
  );
 
VOID
EFIAPI
PeCoffLoaderRelocateImageForRuntime (
  IN  PHYSICAL_ADDRESS  ImageBase,
  IN  PHYSICAL_ADDRESS  VirtImageBase,
  IN  UINTN             ImageSize,
  IN  VOID              *RelocationData
  );
 
RETURN_STATUS
EFIAPI
PeCoffLoaderUnloadImage (
  IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
  );
 
#endif