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