include/llvm/Object/COFF.h

   1 //===- COFF.h - COFF object file implementation -----------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file declares the COFFObjectFile class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_OBJECT_COFF_H
  15 #define LLVM_OBJECT_COFF_H
  16
  17 #include "llvm/Object/ObjectFile.h"
  18 #include "llvm/Support/COFF.h"
  19 #include "llvm/Support/Endian.h"
  20
  21 namespace llvm {
  22   template <typename T>
  23   class ArrayRef;
  24
  25 namespace object {
  26 class ImportDirectoryEntryRef;
  27 typedef content_iterator<ImportDirectoryEntryRef> import_directory_iterator;
  28
  29 /// The DOS compatible header at the front of all PE/COFF executables.
  30 struct dos_header {
  31   support::ulittle16_t Magic;
  32   support::ulittle16_t UsedBytesInTheLastPage;
  33   support::ulittle16_t FileSizeInPages;
  34   support::ulittle16_t NumberOfRelocationItems;
  35   support::ulittle16_t HeaderSizeInParagraphs;
  36   support::ulittle16_t MinimumExtraParagraphs;
  37   support::ulittle16_t MaximumExtraParagraphs;
  38   support::ulittle16_t InitialRelativeSS;
  39   support::ulittle16_t InitialSP;
  40   support::ulittle16_t Checksum;
  41   support::ulittle16_t InitialIP;
  42   support::ulittle16_t InitialRelativeCS;
  43   support::ulittle16_t AddressOfRelocationTable;
  44   support::ulittle16_t OverlayNumber;
  45   support::ulittle16_t Reserved[4];
  46   support::ulittle16_t OEMid;
  47   support::ulittle16_t OEMinfo;
  48   support::ulittle16_t Reserved2[10];
  49   support::ulittle32_t AddressOfNewExeHeader;
  50 };
  51
  52 struct coff_file_header {
  53   support::ulittle16_t Machine;
  54   support::ulittle16_t NumberOfSections;
  55   support::ulittle32_t TimeDateStamp;
  56   support::ulittle32_t PointerToSymbolTable;
  57   support::ulittle32_t NumberOfSymbols;
  58   support::ulittle16_t SizeOfOptionalHeader;
  59   support::ulittle16_t Characteristics;
  60 };
  61
  62 /// The 32-bit PE header that follows the COFF header.
  63 struct pe32_header {
  64   support::ulittle16_t Magic;
  65   uint8_t  MajorLinkerVersion;
  66   uint8_t  MinorLinkerVersion;
  67   support::ulittle32_t SizeOfCode;
  68   support::ulittle32_t SizeOfInitializedData;
  69   support::ulittle32_t SizeOfUninitializedData;
  70   support::ulittle32_t AddressOfEntryPoint;
  71   support::ulittle32_t BaseOfCode;
  72   support::ulittle32_t BaseOfData;
  73   support::ulittle32_t ImageBase;
  74   support::ulittle32_t SectionAlignment;
  75   support::ulittle32_t FileAlignment;
  76   support::ulittle16_t MajorOperatingSystemVersion;
  77   support::ulittle16_t MinorOperatingSystemVersion;
  78   support::ulittle16_t MajorImageVersion;
  79   support::ulittle16_t MinorImageVersion;
  80   support::ulittle16_t MajorSubsystemVersion;
  81   support::ulittle16_t MinorSubsystemVersion;
  82   support::ulittle32_t Win32VersionValue;
  83   support::ulittle32_t SizeOfImage;
  84   support::ulittle32_t SizeOfHeaders;
  85   support::ulittle32_t CheckSum;
  86   support::ulittle16_t Subsystem;
  87   support::ulittle16_t DLLCharacteristics;
  88   support::ulittle32_t SizeOfStackReserve;
  89   support::ulittle32_t SizeOfStackCommit;
  90   support::ulittle32_t SizeOfHeapReserve;
  91   support::ulittle32_t SizeOfHeapCommit;
  92   support::ulittle32_t LoaderFlags;
  93   support::ulittle32_t NumberOfRvaAndSize;
  94 };
  95
  96 /// The 64-bit PE header that follows the COFF header.
  97 struct pe32plus_header {
  98   support::ulittle16_t Magic;
  99   uint8_t  MajorLinkerVersion;
 100   uint8_t  MinorLinkerVersion;
 101   support::ulittle32_t SizeOfCode;
 102   support::ulittle32_t SizeOfInitializedData;
 103   support::ulittle32_t SizeOfUninitializedData;
 104   support::ulittle32_t AddressOfEntryPoint;
 105   support::ulittle32_t BaseOfCode;
 106   support::ulittle64_t ImageBase;
 107   support::ulittle32_t SectionAlignment;
 108   support::ulittle32_t FileAlignment;
 109   support::ulittle16_t MajorOperatingSystemVersion;
 110   support::ulittle16_t MinorOperatingSystemVersion;
 111   support::ulittle16_t MajorImageVersion;
 112   support::ulittle16_t MinorImageVersion;
 113   support::ulittle16_t MajorSubsystemVersion;
 114   support::ulittle16_t MinorSubsystemVersion;
 115   support::ulittle32_t Win32VersionValue;
 116   support::ulittle32_t SizeOfImage;
 117   support::ulittle32_t SizeOfHeaders;
 118   support::ulittle32_t CheckSum;
 119   support::ulittle16_t Subsystem;
 120   support::ulittle16_t DLLCharacteristics;
 121   support::ulittle64_t SizeOfStackReserve;
 122   support::ulittle64_t SizeOfStackCommit;
 123   support::ulittle64_t SizeOfHeapReserve;
 124   support::ulittle64_t SizeOfHeapCommit;
 125   support::ulittle32_t LoaderFlags;
 126   support::ulittle32_t NumberOfRvaAndSize;
 127 };
 128
 129 struct data_directory {
 130   support::ulittle32_t RelativeVirtualAddress;
 131   support::ulittle32_t Size;
 132 };
 133
 134 struct import_directory_table_entry {
 135   support::ulittle32_t ImportLookupTableRVA;
 136   support::ulittle32_t TimeDateStamp;
 137   support::ulittle32_t ForwarderChain;
 138   support::ulittle32_t NameRVA;
 139   support::ulittle32_t ImportAddressTableRVA;
 140 };
 141
 142 struct import_lookup_table_entry32 {
 143   support::ulittle32_t data;
 144
 145   bool isOrdinal() const { return data & 0x80000000; }
 146
 147   uint16_t getOrdinal() const {
 148     assert(isOrdinal() && "ILT entry is not an ordinal!");
 149     return data & 0xFFFF;
 150   }
 151
 152   uint32_t getHintNameRVA() const {
 153     assert(!isOrdinal() && "ILT entry is not a Hint/Name RVA!");
 154     return data;
 155   }
 156 };
 157
 158 struct coff_symbol {
 159   struct StringTableOffset {
 160     support::ulittle32_t Zeroes;
 161     support::ulittle32_t Offset;
 162   };
 163
 164   union {
 165     char ShortName[8];
 166     StringTableOffset Offset;
 167   } Name;
 168
 169   support::ulittle32_t Value;
 170   support::little16_t SectionNumber;
 171
 172   support::ulittle16_t Type;
 173
 174   support::ulittle8_t  StorageClass;
 175   support::ulittle8_t  NumberOfAuxSymbols;
 176
 177   uint8_t getBaseType() const {
 178     return Type & 0x0F;
 179   }
 180
 181   uint8_t getComplexType() const {
 182     return (Type & 0xF0) >> 4;
 183   }
 184 };
 185
 186 struct coff_section {
 187   char Name[8];
 188   support::ulittle32_t VirtualSize;
 189   support::ulittle32_t VirtualAddress;
 190   support::ulittle32_t SizeOfRawData;
 191   support::ulittle32_t PointerToRawData;
 192   support::ulittle32_t PointerToRelocations;
 193   support::ulittle32_t PointerToLinenumbers;
 194   support::ulittle16_t NumberOfRelocations;
 195   support::ulittle16_t NumberOfLinenumbers;
 196   support::ulittle32_t Characteristics;
 197 };
 198
 199 struct coff_relocation {
 200   support::ulittle32_t VirtualAddress;
 201   support::ulittle32_t SymbolTableIndex;
 202   support::ulittle16_t Type;
 203 };
 204
 205 struct coff_aux_weak_external {
 206   support::ulittle32_t TagIndex;
 207   support::ulittle32_t Characteristics;
 208   char Unused[10];
 209 };
 210
 211 struct coff_aux_section_definition {
 212   support::ulittle32_t Length;
 213   support::ulittle16_t NumberOfRelocations;
 214   support::ulittle16_t NumberOfLinenumbers;
 215   support::ulittle32_t CheckSum;
 216   support::ulittle16_t Number;
 217   support::ulittle8_t Selection;
 218   char Unused[3];
 219 };
 220
 221 class COFFObjectFile : public ObjectFile {
 222 private:
 223   friend class ImportDirectoryEntryRef;
 224   const coff_file_header *COFFHeader;
 225   const pe32_header      *PE32Header;
 226   const data_directory   *DataDirectory;
 227   const coff_section     *SectionTable;
 228   const coff_symbol      *SymbolTable;
 229   const char             *StringTable;
 230         uint32_t          StringTableSize;
 231   const import_directory_table_entry *ImportDirectory;
 232         uint32_t          NumberOfImportDirectory;
 233
 234         error_code        getString(uint32_t offset, StringRef &Res) const;
 235
 236   const coff_symbol      *toSymb(DataRefImpl Symb) const;
 237   const coff_section     *toSec(DataRefImpl Sec) const;
 238   const coff_relocation  *toRel(DataRefImpl Rel) const;
 239
 240         error_code        initSymbolTablePtr();
 241         error_code        initImportTablePtr();
 242
 243 protected:
 244   virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const;
 245   virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const;
 246   virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const;
 247   virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const;
 248   virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const;
 249   virtual error_code getSymbolFlags(DataRefImpl Symb, uint32_t &Res) const;
 250   virtual error_code getSymbolType(DataRefImpl Symb, SymbolRef::Type &Res) const;
 251   virtual error_code getSymbolSection(DataRefImpl Symb,
 252                                       section_iterator &Res) const;
 253   virtual error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const;
 254
 255   virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const;
 256   virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const;
 257   virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const;
 258   virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const;
 259   virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res) const;
 260   virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const;
 261   virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const;
 262   virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const;
 263   virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const;
 264   virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const;
 265   virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const;
 266   virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const;
 267   virtual error_code isSectionRequiredForExecution(DataRefImpl Sec,
 268                                                    bool &Res) const;
 269   virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
 270                                            bool &Result) const;
 271   virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const;
 272   virtual relocation_iterator section_rel_end(DataRefImpl Sec) const;
 273
 274   virtual error_code getRelocationNext(DataRefImpl Rel,
 275                                        RelocationRef &Res) const;
 276   virtual error_code getRelocationAddress(DataRefImpl Rel,
 277                                           uint64_t &Res) const;
 278   virtual error_code getRelocationOffset(DataRefImpl Rel,
 279                                          uint64_t &Res) const;
 280   virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const;
 281   virtual error_code getRelocationType(DataRefImpl Rel,
 282                                        uint64_t &Res) const;
 283   virtual error_code getRelocationTypeName(DataRefImpl Rel,
 284                                            SmallVectorImpl<char> &Result) const;
 285   virtual error_code getRelocationValueString(DataRefImpl Rel,
 286                                            SmallVectorImpl<char> &Result) const;
 287
 288   virtual error_code getLibraryNext(DataRefImpl LibData,
 289                                     LibraryRef &Result) const;
 290   virtual error_code getLibraryPath(DataRefImpl LibData,
 291                                     StringRef &Result) const;
 292
 293 public:
 294   COFFObjectFile(MemoryBuffer *Object, error_code &ec);
 295   virtual symbol_iterator begin_symbols() const;
 296   virtual symbol_iterator end_symbols() const;
 297   virtual symbol_iterator begin_dynamic_symbols() const;
 298   virtual symbol_iterator end_dynamic_symbols() const;
 299   virtual library_iterator begin_libraries_needed() const;
 300   virtual library_iterator end_libraries_needed() const;
 301   virtual section_iterator begin_sections() const;
 302   virtual section_iterator end_sections() const;
 303
 304   const coff_section *getCOFFSection(section_iterator &It) const;
 305   const coff_symbol *getCOFFSymbol(symbol_iterator &It) const;
 306   const coff_relocation *getCOFFRelocation(relocation_iterator &It) const;
 307
 308   virtual uint8_t getBytesInAddress() const;
 309   virtual StringRef getFileFormatName() const;
 310   virtual unsigned getArch() const;
 311   virtual StringRef getLoadName() const;
 312
 313   import_directory_iterator import_directory_begin() const;
 314   import_directory_iterator import_directory_end() const;
 315
 316   error_code getHeader(const coff_file_header *&Res) const;
 317   error_code getCOFFHeader(const coff_file_header *&Res) const;
 318   error_code getPE32Header(const pe32_header *&Res) const;
 319   error_code getDataDirectory(uint32_t index, const data_directory *&Res) const;
 320   error_code getSection(int32_t index, const coff_section *&Res) const;
 321   error_code getSymbol(uint32_t index, const coff_symbol *&Res) const;
 322   template <typename T>
 323   error_code getAuxSymbol(uint32_t index, const T *&Res) const {
 324     const coff_symbol *s;
 325     error_code ec = getSymbol(index, s);
 326     Res = reinterpret_cast<const T*>(s);
 327     return ec;
 328   }
 329   error_code getSymbolName(const coff_symbol *symbol, StringRef &Res) const;
 330   ArrayRef<uint8_t> getSymbolAuxData(const coff_symbol *symbol) const;
 331
 332   error_code getSectionName(const coff_section *Sec, StringRef &Res) const;
 333   error_code getSectionContents(const coff_section *Sec,
 334                                 ArrayRef<uint8_t> &Res) const;
 335
 336   error_code getRvaPtr(uint32_t Rva, uintptr_t &Res) const;
 337   error_code getHintName(uint32_t Rva, uint16_t &Hint, StringRef &Name) const;
 338
 339   static inline bool classof(const Binary *v) {
 340     return v->isCOFF();
 341   }
 342 };
 343
 344 // The iterator for the import directory table.
 345 class ImportDirectoryEntryRef {
 346 public:
 347   ImportDirectoryEntryRef() : OwningObject(0) {}
 348   ImportDirectoryEntryRef(DataRefImpl ImportDirectory,
 349                           const COFFObjectFile *Owner)
 350       : ImportDirectoryPimpl(ImportDirectory), OwningObject(Owner) {}
 351
 352   bool operator==(const ImportDirectoryEntryRef &Other) const;
 353   error_code getNext(ImportDirectoryEntryRef &Result) const;
 354   error_code getName(StringRef &Result) const;
 355
 356   error_code
 357   getImportTableEntry(const import_directory_table_entry *&Result) const;
 358
 359   error_code
 360   getImportLookupEntry(const import_lookup_table_entry32 *&Result) const;
 361
 362 private:
 363   DataRefImpl ImportDirectoryPimpl;
 364   const COFFObjectFile *OwningObject;
 365 };
 366 } // end namespace object
 367 } // end namespace llvm
 368
 369 #endif