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 - 2010, Intel Corporation. All rights reserved.<BR>
   9 This program and the accompanying materials are licensed and made available under
  10 the terms and conditions of the BSD License that accompanies this distribution.
  11 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
  63                                     read and the size
  64   @retval RETURN_DEVICE_ERROR       The specified portion of the PE/COFF image
  65                                     could not be read due to a device error.
  66
  67 **/
  68 typedef
  69 RETURN_STATUS
  70 (EFIAPI *PE_COFF_LOADER_READ_FILE)(
  71   IN     VOID   *FileHandle,
  72   IN     UINTN  FileOffset,
  73   IN OUT UINTN  *ReadSize,
  74   OUT    VOID   *Buffer
  75   );
  76
  77 ///
  78 /// The context structure used while PE/COFF image is being loaded and relocated.
  79 ///
  80 typedef struct {
  81   ///
  82   /// Set by PeCoffLoaderGetImageInfo() to the ImageBase in the PE/COFF header.
  83   ///
  84   PHYSICAL_ADDRESS                  ImageAddress;
  85   ///
  86   /// Set by PeCoffLoaderGetImageInfo() to the SizeOfImage in the PE/COFF header.
  87   /// Image size includes the size of Debug Entry if it is present.
  88   ///
  89   UINT64                            ImageSize;
  90   ///
  91   /// Is set to zero by PeCoffLoaderGetImageInfo(). If DestinationAddress is non-zero,
  92   /// PeCoffLoaderRelocateImage() will relocate the image using this base address.
  93   /// If the DestinationAddress is zero, the ImageAddress will be used as the base
  94   /// address of relocation.
  95   ///
  96   PHYSICAL_ADDRESS                  DestinationAddress;
  97   ///
  98   /// PeCoffLoaderLoadImage() sets EntryPoint to to the entry point of the PE/COFF image.
  99   ///
 100   PHYSICAL_ADDRESS                  EntryPoint;
 101   ///
 102   /// Passed in by the caller to PeCoffLoaderGetImageInfo() and PeCoffLoaderLoadImage()
 103   /// to abstract accessing the image from the library.
 104   ///
 105   PE_COFF_LOADER_READ_FILE          ImageRead;
 106   ///
 107   /// Used as the FileHandle passed into the ImageRead function when it's called.
 108   ///
 109   VOID                              *Handle;
 110   ///
 111   /// Caller allocated buffer of size FixupDataSize that can be optionally allocated
 112   /// prior to calling PeCoffLoaderRelocateImage().
 113   /// This buffer is filled with the information used to fix up the image.
 114   /// The fixups have been applied to the image and this entry is just for information.
 115   ///
 116   VOID                              *FixupData;
 117   ///
 118   /// Set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header.
 119   /// If the image is a TE image, then this field is set to 0.
 120   ///
 121   UINT32                            SectionAlignment;
 122   ///
 123   /// Set by PeCoffLoaderGetImageInfo() to offset to the PE/COFF header.
 124   /// If the PE/COFF image does not start with a DOS header, this value is zero.
 125   /// Otherwise, it's the offset to the PE/COFF header.
 126   ///
 127   UINT32                            PeCoffHeaderOffset;
 128   ///
 129   /// Set by PeCoffLoaderGetImageInfo() to the Relative Virtual Address of the debug directory,
 130   /// if it exists in the image
 131   ///
 132   UINT32                            DebugDirectoryEntryRva;
 133   ///
 134   /// Set by PeCoffLoaderLoadImage() to CodeView area of the PE/COFF Debug directory.
 135   ///
 136   VOID                              *CodeView;
 137   ///
 138   /// Set by PeCoffLoaderLoadImage() to point to the PDB entry contained in the CodeView area.
 139   /// The PdbPointer points to the filename of the PDB file used for source-level debug of
 140   /// the image by a debugger.
 141   ///
 142   CHAR8                             *PdbPointer;
 143   ///
 144   /// Is set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header.
 145   ///
 146   UINTN                             SizeOfHeaders;
 147   ///
 148   /// Not used by this library class. Other library classes that layer on  top of this library
 149   /// class fill in this value as part of their GetImageInfo call.
 150   /// This allows the caller of the library to know what type of memory needs to be allocated
 151   /// to load and relocate the image.
 152   ///
 153   UINT32                            ImageCodeMemoryType;
 154   ///
 155   /// Not used by this library class. Other library classes that layer on top of this library
 156   /// class fill in this value as part of their GetImageInfo call.
 157   /// This allows the caller of the library to know what type of memory needs to be allocated
 158   /// to load and relocate the image.
 159   ///
 160   UINT32                            ImageDataMemoryType;
 161   ///
 162   /// Set by any of the library functions if they encounter an error.
 163   ///
 164   UINT32                            ImageError;
 165   ///
 166   /// Set by PeCoffLoaderLoadImage() to indicate the size of FixupData that the caller must
 167   /// allocate before calling PeCoffLoaderRelocateImage().
 168   ///
 169   UINTN                             FixupDataSize;
 170   ///
 171   /// Set by PeCoffLoaderGetImageInfo() to the machine type stored in the PE/COFF header.
 172   ///
 173   UINT16                            Machine;
 174   ///
 175   /// Set by PeCoffLoaderGetImageInfo() to the subsystem type stored in the PE/COFF header.
 176   ///
 177   UINT16                            ImageType;
 178   ///
 179   /// Set by PeCoffLoaderGetImageInfo() to TRUE if the PE/COFF image does not contain
 180   /// relocation information.
 181   ///
 182   BOOLEAN                           RelocationsStripped;
 183   ///
 184   /// Set by PeCoffLoaderGetImageInfo() to TRUE if the image is a TE image.
 185   /// For a definition of the TE Image format, see the Platform Initialization Pre-EFI
 186   /// Initialization Core Interface Specification.
 187   ///
 188   BOOLEAN                           IsTeImage;
 189   ///
 190   /// Set by PeCoffLoaderLoadImage() to the HII resource offset
 191   /// if the image contains a custom PE/COFF resource with the type 'HII'.
 192   /// Otherwise, the entry remains to be 0.
 193   ///
 194   PHYSICAL_ADDRESS                  HiiResourceData;
 195   ///
 196   /// Private storage for implementation specific data.
 197   ///
 198   UINT64                            Context;
 199 } PE_COFF_LOADER_IMAGE_CONTEXT;
 200
 201 /**
 202   Retrieves information about a PE/COFF image.
 203
 204   Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize,
 205   DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and
 206   DebugDirectoryEntryRva fields of the ImageContext structure.
 207   If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.
 208   If the PE/COFF image accessed through the ImageRead service in the ImageContext
 209   structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED.
 210   If any errors occur while computing the fields of ImageContext,
 211   then the error status is returned in the ImageError field of ImageContext.
 212   If the image is a TE image, then SectionAlignment is set to 0.
 213   The ImageRead and Handle fields of ImageContext structure must be valid prior
 214   to invoking this service.
 215
 216   @param  ImageContext              The pointer to the image context structure that
 217                                     describes the PE/COFF image that needs to be
 218                                     examined by this function.
 219
 220   @retval RETURN_SUCCESS            The information on the PE/COFF image was collected.
 221   @retval RETURN_INVALID_PARAMETER  ImageContext is NULL.
 222   @retval RETURN_UNSUPPORTED        The PE/COFF image is not supported.
 223
 224 **/
 225 RETURN_STATUS
 226 EFIAPI
 227 PeCoffLoaderGetImageInfo (
 228   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
 229   );
 230
 231 /**
 232   Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().
 233
 234   If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of
 235   ImageContext as the relocation base address.  Otherwise, use the DestinationAddress field
 236   of ImageContext as the relocation base address.  The caller must allocate the relocation
 237   fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
 238
 239   The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress,
 240   ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders,
 241   DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of
 242   the ImageContext structure must be valid prior to invoking this service.
 243
 244   If ImageContext is NULL, then ASSERT().
 245
 246   Note that if the platform does not maintain coherency between the instruction cache(s) and the data
 247   cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
 248   prior to transferring control to a PE/COFF image that is loaded using this library.
 249
 250   @param  ImageContext        The pointer to the image context structure that describes the PE/COFF
 251                               image that is being relocated.
 252
 253   @retval RETURN_SUCCESS      The PE/COFF image was relocated.
 254                               Extended status information is in the ImageError field of ImageContext.
 255   @retval RETURN_LOAD_ERROR   The image in not a valid PE/COFF image.
 256                               Extended status information is in the ImageError field of ImageContext.
 257   @retval RETURN_UNSUPPORTED  A relocation record type is not supported.
 258                               Extended status information is in the ImageError field of ImageContext.
 259
 260 **/
 261 RETURN_STATUS
 262 EFIAPI
 263 PeCoffLoaderRelocateImage (
 264   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
 265   );
 266
 267 /**
 268   Loads a PE/COFF image into memory.
 269
 270   Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer
 271   specified by the ImageAddress and ImageSize fields of ImageContext.  The caller must allocate
 272   the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.
 273   The EntryPoint, FixupDataSize, CodeView, PdbPointer and HiiResourceData fields of ImageContext are computed.
 274   The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize,
 275   DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva
 276   fields of the ImageContext structure must be valid prior to invoking this service.
 277
 278   If ImageContext is NULL, then ASSERT().
 279
 280   Note that if the platform does not maintain coherency between the instruction cache(s) and the data
 281   cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
 282   prior to transferring control to a PE/COFF image that is loaded using this library.
 283
 284   @param  ImageContext              The pointer to the image context structure that describes the PE/COFF
 285                                     image that is being loaded.
 286
 287   @retval RETURN_SUCCESS            The PE/COFF image was loaded into the buffer specified by
 288                                     the ImageAddress and ImageSize fields of ImageContext.
 289                                     Extended status information is in the ImageError field of ImageContext.
 290   @retval RETURN_BUFFER_TOO_SMALL   The caller did not provide a large enough buffer.
 291                                     Extended status information is in the ImageError field of ImageContext.
 292   @retval RETURN_LOAD_ERROR         The PE/COFF image is an EFI Runtime image with no relocations.
 293                                     Extended status information is in the ImageError field of ImageContext.
 294   @retval RETURN_INVALID_PARAMETER  The image address is invalid.
 295                                     Extended status information is in the ImageError field of ImageContext.
 296
 297 **/
 298 RETURN_STATUS
 299 EFIAPI
 300 PeCoffLoaderLoadImage (
 301   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
 302   );
 303
 304
 305 /**
 306   Reads contents of a PE/COFF image from a buffer in system memory.
 307
 308   This is the default implementation of a PE_COFF_LOADER_READ_FILE function
 309   that assumes FileHandle pointer to the beginning of a PE/COFF image.
 310   This function reads contents of the PE/COFF image that starts at the system memory
 311   address specified by FileHandle. The read operation copies ReadSize bytes from the
 312   PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer.
 313   The size of the buffer actually read is returned in ReadSize.
 314
 315   If FileHandle is NULL, then ASSERT().
 316   If ReadSize is NULL, then ASSERT().
 317   If Buffer is NULL, then ASSERT().
 318
 319   @param  FileHandle        The pointer to base of the input stream
 320   @param  FileOffset        Offset into the PE/COFF image to begin the read operation.
 321   @param  ReadSize          On input, the size in bytes of the requested read operation.
 322                             On output, the number of bytes actually read.
 323   @param  Buffer            Output buffer that contains the data read from the PE/COFF image.
 324
 325   @retval RETURN_SUCCESS    The data is read from FileOffset from the Handle into
 326                             the buffer.
 327 **/
 328 RETURN_STATUS
 329 EFIAPI
 330 PeCoffLoaderImageReadFromMemory (
 331   IN     VOID    *FileHandle,
 332   IN     UINTN   FileOffset,
 333   IN OUT UINTN   *ReadSize,
 334   OUT    VOID    *Buffer
 335   );
 336
 337
 338 /**
 339   Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI
 340   runtime.
 341
 342   This function reapplies relocation fixups to the PE/COFF image specified by ImageBase
 343   and ImageSize so the image will execute correctly when the PE/COFF image is mapped
 344   to the address specified by VirtualImageBase. RelocationData must be identical
 345   to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure
 346   after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().
 347
 348   Note that if the platform does not maintain coherency between the instruction cache(s) and the data
 349   cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
 350   prior to transferring control to a PE/COFF image that is loaded using this library.
 351
 352   @param  ImageBase          The base address of a PE/COFF image that has been loaded
 353                              and relocated into system memory.
 354   @param  VirtImageBase      The request virtual address that the PE/COFF image is to
 355                              be fixed up for.
 356   @param  ImageSize          The size, in bytes, of the PE/COFF image.
 357   @param  RelocationData     A pointer to the relocation data that was collected when the PE/COFF
 358                              image was relocated using PeCoffLoaderRelocateImage().
 359
 360 **/
 361 VOID
 362 EFIAPI
 363 PeCoffLoaderRelocateImageForRuntime (
 364   IN  PHYSICAL_ADDRESS        ImageBase,
 365   IN  PHYSICAL_ADDRESS        VirtImageBase,
 366   IN  UINTN                   ImageSize,
 367   IN  VOID                    *RelocationData
 368   );
 369
 370 /**
 371   Unloads a loaded PE/COFF image from memory and releases its taken resource.
 372   Releases any environment specific resources that were allocated when the image
 373   specified by ImageContext was loaded using PeCoffLoaderLoadImage().
 374
 375   For NT32 emulator, the PE/COFF image loaded by system needs to release.
 376   For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded,
 377   this function can simply return RETURN_SUCCESS.
 378
 379   If ImageContext is NULL, then ASSERT().
 380
 381   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF
 382                                     image to be unloaded.
 383
 384   @retval RETURN_SUCCESS            The PE/COFF image was unloaded successfully.
 385 **/
 386 RETURN_STATUS
 387 EFIAPI
 388 PeCoffLoaderUnloadImage (
 389   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
 390   );
 391 #endif