MdePkg/Include/Library/PeCoffLib.h

   1 /** @file
   2   Provides services to load and relocate a PE/COFF image.
   3
   4   The PE/COFF Loader Library abstracts the implementation of a PE/COFF loader for
   5   IA-32, x86, IPF, and EBC processor types. The library functions are memory based
   6   and can be ported easily to any environment.
   7
   8 Copyright (c) 2006 - 2008, Intel Corporation
   9 All rights reserved. This program and the accompanying materials
  10 are licensed and made available under the terms and conditions of the BSD License
  11 which accompanies this distribution.  The full text of the license may be found at
  12 http://opensource.org/licenses/bsd-license.php
  13
  14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  16
  17 **/
  18
  19 #ifndef __BASE_PE_COFF_LIB_H__
  20 #define __BASE_PE_COFF_LIB_H__
  21
  22 #include <IndustryStandard/PeImage.h>
  23 //
  24 // Return status codes from the PE/COFF Loader services
  25 //
  26 #define IMAGE_ERROR_SUCCESS                      0
  27 #define IMAGE_ERROR_IMAGE_READ                   1
  28 #define IMAGE_ERROR_INVALID_PE_HEADER_SIGNATURE  2
  29 #define IMAGE_ERROR_INVALID_MACHINE_TYPE         3
  30 #define IMAGE_ERROR_INVALID_SUBSYSTEM            4
  31 #define IMAGE_ERROR_INVALID_IMAGE_ADDRESS        5
  32 #define IMAGE_ERROR_INVALID_IMAGE_SIZE           6
  33 #define IMAGE_ERROR_INVALID_SECTION_ALIGNMENT    7
  34 #define IMAGE_ERROR_SECTION_NOT_LOADED           8
  35 #define IMAGE_ERROR_FAILED_RELOCATION            9
  36 #define IMAGE_ERROR_FAILED_ICACHE_FLUSH          10
  37
  38 /**
  39   Reads contents of a PE/COFF image.
  40
  41   A function of this type reads contents of the PE/COFF image specified by FileHandle. The read
  42   operation copies ReadSize bytes from the PE/COFF image starting at byte offset FileOffset into
  43   the buffer specified by Buffer. The size of the buffer actually read is returned in ReadSize.
  44   If FileOffset specifies an offset past the end of the PE/COFF image, a ReadSize of 0 is returned.
  45   A function of this type must be registered in the ImageRead field of a PE_COFF_LOADER_IMAGE_CONTEXT
  46   structure for the PE/COFF Loader Library service to function correctly.  This function abstracts access
  47   to a PE/COFF image so it can be implemented in an environment specific manner.  For example, SEC and PEI
  48   environments may access memory directly to read the contents of a PE/COFF image, and DXE or UEFI
  49   environments may require protocol services to read the contents of PE/COFF image
  50   stored on FLASH, disk, or network devices.
  51
  52   If FileHandle is not a valid handle, then ASSERT().
  53   If ReadSize is NULL, then ASSERT().
  54   If Buffer is NULL, then ASSERT().
  55
  56   @param  FileHandle      Pointer to the file handle to read the PE/COFF image.
  57   @param  FileOffset      Offset into the PE/COFF image to begin the read operation.
  58   @param  ReadSize        On input, the size in bytes of the requested read operation.
  59                           On output, the number of bytes actually read.
  60   @param  Buffer          Output buffer that contains the data read from the PE/COFF image.
  61
  62   @retval RETURN_SUCCESS            The specified portion of the PE/COFF image was read and the size
  63   @retval RETURN_DEVICE_ERROR       The specified portion of the PE/COFF image could not be read due
  64                                     to a device error.
  65
  66 **/
  67 typedef
  68 RETURN_STATUS
  69 (EFIAPI *PE_COFF_LOADER_READ_FILE)(
  70   IN     VOID   *FileHandle,
  71   IN     UINTN  FileOffset,
  72   IN OUT UINTN  *ReadSize,
  73   OUT    VOID   *Buffer
  74   );
  75
  76 ///
  77 /// Context structure used while PE/COFF image is being loaded and relocated
  78 ///
  79 typedef struct {
  80   ///
  81   /// Is set by PeCoffLoaderGetImageInfo() to the ImageBase in the PE/COFF header
  82   ///
  83   PHYSICAL_ADDRESS                  ImageAddress;
  84   ///
  85   /// Is set by PeCoffLoaderGetImageInfo() to the SizeOfImage in the PE/COFF header.
  86   /// Image size includes the size of Debug Entry if it is present.
  87   ///
  88   UINT64                            ImageSize;
  89   ///
  90   /// Is set to zero by PeCoffLoaderGetImageInfo(). If DestinationAddress is non zero,
  91   /// PeCoffLoaderRelocateImage() will relocate the image using this base address.
  92   /// If the DestinationAddress is zero, the ImageAddress will be used as the base
  93   /// address of relocation.
  94   ///
  95   PHYSICAL_ADDRESS                  DestinationAddress;
  96   ///
  97   /// PeCoffLoaderLoadImage() sets EntryPoint to to the entry point of the PE/COFF image.
  98   ///
  99   PHYSICAL_ADDRESS                  EntryPoint;
 100   ///
 101   /// Passed in by the caller to PeCoffLoaderGetImageInfo() and PeCoffLoaderLoadImage()
 102   /// to abstract accessing the image from the library.
 103   ///
 104   PE_COFF_LOADER_READ_FILE          ImageRead;
 105   ///
 106   /// Used as the FileHandle passed into the ImageRead function when it's called.
 107   ///
 108   VOID                              *Handle;
 109   ///
 110   /// Caller allocated buffer of size FixupDataSize that can be optionally allocated
 111   /// prior to calling PeCoffLoaderRelocateImage().
 112   /// This buffer is filled with the information used to fix up the image.
 113   /// The fixups have been applied to the image and this entry is just for information.
 114   ///
 115   VOID                              *FixupData;
 116   ///
 117   /// Is set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header
 118   /// If the image is a TE image, then this field is set to 0.
 119   ///
 120   UINT32                            SectionAlignment;
 121   ///
 122   /// Set by PeCoffLoaderGetImageInfo() to offset to the PE/COFF header.
 123   /// If the PE/COFF image does not start with a DOS header, this value is zero;
 124   /// otherwise, it's the offset to the PE/COFF header.
 125   ///
 126   UINT32                            PeCoffHeaderOffset;
 127   ///
 128   /// Set by PeCoffLoaderGetImageInfo() to the Relative Virtual Address of the debug directory
 129   /// if it exists in the image
 130   ///
 131   UINT32                            DebugDirectoryEntryRva;
 132   ///
 133   /// Set by PeCoffLoaderLoadImage() to CodeView area of the PE/COFF Debug directory.
 134   ///
 135   VOID                              *CodeView;
 136   ///
 137   /// Set by PeCoffLoaderLoadImage() to point to the PDB entry contained in the CodeView area.
 138   /// The PdbPointer points to the filename of the PDB file used for source-level debug of
 139   /// the image by a debugger.
 140   ///
 141   CHAR8                             *PdbPointer;
 142   ///
 143   /// Is set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header.
 144   ///
 145   UINTN                             SizeOfHeaders;
 146   ///
 147   /// Not used by this library class. Other library classes that layer on  top of this library
 148   /// class fill in this value as part of their GetImageInfo call.
 149   /// This allows the caller of the library to know what type of memory needs to be allocated
 150   /// to load and relocate the image.
 151   ///
 152   UINT32                            ImageCodeMemoryType;
 153   ///
 154   /// Not used by this library class. Other library classes that layer on top of this library
 155   /// class fill in this value as part of their GetImageInfo call.
 156   /// This allows the caller of the library to know what type of memory needs to be allocated
 157   /// to load and relocate the image
 158   ///
 159   UINT32                            ImageDataMemoryType;
 160   ///
 161   /// Set by any of the library functions if they encounter an error.
 162   ///
 163   UINT32                            ImageError;
 164   ///
 165   /// Set by PeCoffLoaderLoadImage() to indicate the size of FixupData that the caller must
 166   /// allocate before calling PeCoffLoaderRelocateImage()
 167   ///
 168   UINTN                             FixupDataSize;
 169   ///
 170   /// Set by PeCoffLoaderGetImageInfo() to the machine type stored in the PE/COFF header
 171   ///
 172   UINT16                            Machine;
 173   ///
 174   /// Set by PeCoffLoaderGetImageInfo() to the subsystem type stored in the PE/COFF header.
 175   ///
 176   UINT16                            ImageType;
 177   ///
 178   /// Set by PeCoffLoaderGetImageInfo() to TRUE if the PE/COFF image does not contain
 179   /// relocation information.
 180   ///
 181   BOOLEAN                           RelocationsStripped;
 182   ///
 183   /// Set by PeCoffLoaderGetImageInfo() to TRUE if the image is a TE image.
 184   /// For a definition of the TE Image format, see the Platform Initialization Pre-EFI
 185   /// Initialization Core Interface Specification.
 186   ///
 187   BOOLEAN                           IsTeImage;
 188 } PE_COFF_LOADER_IMAGE_CONTEXT;
 189
 190 /**
 191   Retrieves information about a PE/COFF image.
 192
 193   Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize,
 194   DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and
 195   DebugDirectoryEntryRva fields of the ImageContext structure.
 196   If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.
 197   If the PE/COFF image accessed through the ImageRead service in the ImageContext
 198   structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED.
 199   If any errors occur while computing the fields of ImageContext,
 200   then the error status is returned in the ImageError field of ImageContext.
 201   If the image is a TE image, then SectionAlignment is set to 0.
 202   The ImageRead and Handle fields of ImageContext structure must be valid prior
 203   to invoking this service.
 204
 205   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF
 206                                     image that needs to be examined by this function.
 207
 208   @retval RETURN_SUCCESS            The information on the PE/COFF image was collected.
 209   @retval RETURN_INVALID_PARAMETER  ImageContext is NULL.
 210   @retval RETURN_UNSUPPORTED        The PE/COFF image is not supported.
 211
 212 **/
 213 RETURN_STATUS
 214 EFIAPI
 215 PeCoffLoaderGetImageInfo (
 216   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
 217   );
 218
 219 /**
 220   Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().
 221
 222   If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of
 223   ImageContext as the relocation base address.  Otherwise, use the DestinationAddress field
 224   of ImageContext as the relocation base address.  The caller must allocate the relocation
 225   fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
 226
 227   The ImageRead, Handle, PeCoffHeaderOffset,  IsTeImage, Machine, ImageType, ImageAddress,
 228   ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders,
 229   DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of
 230   the ImageContext structure must be valid prior to invoking this service.
 231
 232   If ImageContext is NULL, then ASSERT().
 233
 234   @param  ImageContext        Pointer to the image context structure that describes the PE/COFF
 235                               image that is being relocated.
 236
 237   @retval RETURN_SUCCESS      The PE/COFF image was relocated.
 238                               Extended status information is in the ImageError field of ImageContext.
 239   @retval RETURN_LOAD_ERROR   The image in not a valid PE/COFF image.
 240                               Extended status information is in the ImageError field of ImageContext.
 241   @retval RETURN_UNSUPPORTED  A relocation record type is not supported.
 242                               Extended status information is in the ImageError field of ImageContext.
 243
 244 **/
 245 RETURN_STATUS
 246 EFIAPI
 247 PeCoffLoaderRelocateImage (
 248   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
 249   );
 250
 251 /**
 252   Loads a PE/COFF image into memory.
 253
 254   Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer
 255   specified by the ImageAddress and ImageSize fields of ImageContext.  The caller must allocate
 256   the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.
 257   The EntryPoint, FixupDataSize, CodeView, and PdbPointer fields of ImageContext are computed.
 258   The ImageRead, Handle, PeCoffHeaderOffset,  IsTeImage,  Machine, ImageType, ImageAddress, ImageSize,
 259   DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva
 260   fields of the ImageContext structure must be valid prior to invoking this service.
 261
 262   If ImageContext is NULL, then ASSERT().
 263
 264   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF
 265                                     image that is being loaded.
 266
 267   @retval RETURN_SUCCESS            The PE/COFF image was loaded into the buffer specified by
 268                                     the ImageAddress and ImageSize fields of ImageContext.
 269                                     Extended status information is in the ImageError field of ImageContext.
 270   @retval RETURN_BUFFER_TOO_SMALL   The caller did not provide a large enough buffer.
 271                                     Extended status information is in the ImageError field of ImageContext.
 272   @retval RETURN_LOAD_ERROR         The PE/COFF image is an EFI Runtime image with no relocations.
 273                                     Extended status information is in the ImageError field of ImageContext.
 274   @retval RETURN_INVALID_PARAMETER  The image address is invalid.
 275                                     Extended status information is in the ImageError field of ImageContext.
 276
 277 **/
 278 RETURN_STATUS
 279 EFIAPI
 280 PeCoffLoaderLoadImage (
 281   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
 282   );
 283
 284
 285 /**
 286   Reads contents of a PE/COFF image from a buffer in system memory.
 287
 288   This is the default implementation of a PE_COFF_LOADER_READ_FILE function
 289   that assumes FileHandle pointer to the beginning of a PE/COFF image.
 290   This function reads contents of the PE/COFF image that starts at the system memory
 291   address specified by FileHandle.  The read operation copies ReadSize bytes from the
 292   PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer.
 293   The size of the buffer actually read is returned in ReadSize.
 294
 295   If FileHandle is NULL, then ASSERT().
 296   If ReadSize is NULL, then ASSERT().
 297   If Buffer is NULL, then ASSERT().
 298
 299   @param  FileHandle        Pointer to base of the input stream
 300   @param  FileOffset        Offset into the PE/COFF image to begin the read operation.
 301   @param  ReadSize          On input, the size in bytes of the requested read operation.
 302                             On output, the number of bytes actually read.
 303   @param  Buffer            Output buffer that contains the data read from the PE/COFF image.
 304
 305   @retval RETURN_SUCCESS    Data is read from FileOffset from the Handle into
 306                             the buffer.
 307 **/
 308 RETURN_STATUS
 309 EFIAPI
 310 PeCoffLoaderImageReadFromMemory (
 311   IN     VOID    *FileHandle,
 312   IN     UINTN   FileOffset,
 313   IN OUT UINTN   *ReadSize,
 314   OUT    VOID    *Buffer
 315   );
 316
 317
 318 /**
 319   Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI
 320   runtime.
 321
 322   This function reapplies relocation fixups to the PE/COFF image specified by ImageBase
 323   and ImageSize so the image will execute correctly when the PE/COFF image is mapped
 324   to the address specified by VirtualImageBase.  RelocationData must be identical
 325   to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure
 326   after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().
 327
 328   @param  ImageBase          Base address of a PE/COFF image that has been loaded
 329                              and relocated into system memory.
 330   @param  VirtImageBase      The request virtual address that the PE/COFF image is to
 331                              be fixed up for.
 332   @param  ImageSize          The size, in bytes, of the PE/COFF image.
 333   @param  RelocationData     A pointer to the relocation data that was collected when the PE/COFF
 334                              image was relocated using PeCoffLoaderRelocateImage().
 335
 336 **/
 337 VOID
 338 EFIAPI
 339 PeCoffLoaderRelocateImageForRuntime (
 340   IN  PHYSICAL_ADDRESS        ImageBase,
 341   IN  PHYSICAL_ADDRESS        VirtImageBase,
 342   IN  UINTN                   ImageSize,
 343   IN  VOID                    *RelocationData
 344   );
 345
 346 /**
 347   Unloads a loaded PE/COFF image from memory and releases its taken resource.
 348   Releases any environment specific resources that were allocated when the image
 349   specified by ImageContext was loaded using PeCoffLoaderLoadImage().
 350
 351   For NT32 emulator, the PE/COFF image loaded by system needs to release.
 352   For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded,
 353   this function can simply return RETURN_SUCCESS.
 354
 355   If ImageContext is NULL, then ASSERT().
 356
 357   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF
 358                                     image to be unloaded.
 359
 360   @retval RETURN_SUCCESS            The PE/COFF image was unloaded successfully.
 361 **/
 362 RETURN_STATUS
 363 EFIAPI
 364 PeCoffLoaderUnloadImage (
 365   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
 366   );
 367 #endif