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 coff_symbol {
 143   struct StringTableOffset {
 144     support::ulittle32_t Zeroes;
 145     support::ulittle32_t Offset;
 146   };
 147
 148   union {
 149     char ShortName[8];
 150     StringTableOffset Offset;
 151   } Name;
 152
 153   support::ulittle32_t Value;
 154   support::little16_t SectionNumber;
 155
 156   support::ulittle16_t Type;
 157
 158   support::ulittle8_t  StorageClass;
 159   support::ulittle8_t  NumberOfAuxSymbols;
 160
 161   uint8_t getBaseType() const {
 162     return Type & 0x0F;
 163   }
 164
 165   uint8_t getComplexType() const {
 166     return (Type & 0xF0) >> 4;
 167   }
 168 };
 169
 170 struct coff_section {
 171   char Name[8];
 172   support::ulittle32_t VirtualSize;
 173   support::ulittle32_t VirtualAddress;
 174   support::ulittle32_t SizeOfRawData;
 175   support::ulittle32_t PointerToRawData;
 176   support::ulittle32_t PointerToRelocations;
 177   support::ulittle32_t PointerToLinenumbers;
 178   support::ulittle16_t NumberOfRelocations;
 179   support::ulittle16_t NumberOfLinenumbers;
 180   support::ulittle32_t Characteristics;
 181 };
 182
 183 struct coff_relocation {
 184   support::ulittle32_t VirtualAddress;
 185   support::ulittle32_t SymbolTableIndex;
 186   support::ulittle16_t Type;
 187 };
 188
 189 struct coff_aux_weak_external {
 190   support::ulittle32_t TagIndex;
 191   support::ulittle32_t Characteristics;
 192   char Unused[10];
 193 };
 194
 195 struct coff_aux_section_definition {
 196   support::ulittle32_t Length;
 197   support::ulittle16_t NumberOfRelocations;
 198   support::ulittle16_t NumberOfLinenumbers;
 199   support::ulittle32_t CheckSum;
 200   support::ulittle16_t Number;
 201   support::ulittle8_t Selection;
 202   char Unused[3];
 203 };
 204
 205 class COFFObjectFile : public ObjectFile {
 206 private:
 207   friend class ImportDirectoryEntryRef;
 208   const coff_file_header *COFFHeader;
 209   const pe32_header      *PE32Header;
 210   const data_directory   *DataDirectory;
 211   const coff_section     *SectionTable;
 212   const coff_symbol      *SymbolTable;
 213   const char             *StringTable;
 214         uint32_t          StringTableSize;
 215   const import_directory_table_entry *ImportDirectory;
 216         uint32_t          NumberOfImportDirectory;
 217
 218         error_code        getString(uint32_t offset, StringRef &Res) const;
 219
 220   const coff_symbol      *toSymb(DataRefImpl Symb) const;
 221   const coff_section     *toSec(DataRefImpl Sec) const;
 222   const coff_relocation  *toRel(DataRefImpl Rel) const;
 223
 224         error_code        initSymbolTablePtr();
 225         error_code        initImportTablePtr();
 226
 227 protected:
 228   virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const;
 229   virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const;
 230   virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const;
 231   virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const;
 232   virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const;
 233   virtual error_code getSymbolNMTypeChar(DataRefImpl Symb, char &Res) const;
 234   virtual error_code getSymbolFlags(DataRefImpl Symb, uint32_t &Res) const;
 235   virtual error_code getSymbolType(DataRefImpl Symb, SymbolRef::Type &Res) const;
 236   virtual error_code getSymbolSection(DataRefImpl Symb,
 237                                       section_iterator &Res) const;
 238   virtual error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const;
 239
 240   virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const;
 241   virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const;
 242   virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const;
 243   virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const;
 244   virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res) const;
 245   virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const;
 246   virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const;
 247   virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const;
 248   virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const;
 249   virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const;
 250   virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const;
 251   virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const;
 252   virtual error_code isSectionRequiredForExecution(DataRefImpl Sec,
 253                                                    bool &Res) const;
 254   virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
 255                                            bool &Result) const;
 256   virtual relocation_iterator getSectionRelBegin(DataRefImpl Sec) const;
 257   virtual relocation_iterator getSectionRelEnd(DataRefImpl Sec) const;
 258
 259   virtual error_code getRelocationNext(DataRefImpl Rel,
 260                                        RelocationRef &Res) const;
 261   virtual error_code getRelocationAddress(DataRefImpl Rel,
 262                                           uint64_t &Res) const;
 263   virtual error_code getRelocationOffset(DataRefImpl Rel,
 264                                          uint64_t &Res) const;
 265   virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const;
 266   virtual error_code getRelocationType(DataRefImpl Rel,
 267                                        uint64_t &Res) const;
 268   virtual error_code getRelocationTypeName(DataRefImpl Rel,
 269                                            SmallVectorImpl<char> &Result) const;
 270   virtual error_code getRelocationValueString(DataRefImpl Rel,
 271                                            SmallVectorImpl<char> &Result) const;
 272
 273   virtual error_code getLibraryNext(DataRefImpl LibData,
 274                                     LibraryRef &Result) const;
 275   virtual error_code getLibraryPath(DataRefImpl LibData,
 276                                     StringRef &Result) const;
 277
 278 public:
 279   COFFObjectFile(MemoryBuffer *Object, error_code &ec);
 280   virtual symbol_iterator begin_symbols() const;
 281   virtual symbol_iterator end_symbols() const;
 282   virtual symbol_iterator begin_dynamic_symbols() const;
 283   virtual symbol_iterator end_dynamic_symbols() const;
 284   virtual library_iterator begin_libraries_needed() const;
 285   virtual library_iterator end_libraries_needed() const;
 286   virtual section_iterator begin_sections() const;
 287   virtual section_iterator end_sections() const;
 288
 289   const coff_section *getCOFFSection(section_iterator &It) const;
 290   const coff_symbol *getCOFFSymbol(symbol_iterator &It) const;
 291   const coff_relocation *getCOFFRelocation(relocation_iterator &It) const;
 292
 293   virtual uint8_t getBytesInAddress() const;
 294   virtual StringRef getFileFormatName() const;
 295   virtual unsigned getArch() const;
 296   virtual StringRef getLoadName() const;
 297
 298   import_directory_iterator getImportDirectoryBegin() const;
 299   import_directory_iterator getImportDirectoryEnd() const;
 300
 301   error_code getHeader(const coff_file_header *&Res) const;
 302   error_code getCOFFHeader(const coff_file_header *&Res) const;
 303   error_code getPE32Header(const pe32_header *&Res) const;
 304   error_code getDataDirectory(uint32_t index, const data_directory *&Res) const;
 305   error_code getSection(int32_t index, const coff_section *&Res) const;
 306   error_code getSymbol(uint32_t index, const coff_symbol *&Res) const;
 307   template <typename T>
 308   error_code getAuxSymbol(uint32_t index, const T *&Res) const {
 309     const coff_symbol *s;
 310     error_code ec = getSymbol(index, s);
 311     Res = reinterpret_cast<const T*>(s);
 312     return ec;
 313   }
 314   error_code getSymbolName(const coff_symbol *symbol, StringRef &Res) const;
 315   ArrayRef<uint8_t> getSymbolAuxData(const coff_symbol *symbol) const;
 316
 317   error_code getSectionName(const coff_section *Sec, StringRef &Res) const;
 318   error_code getSectionContents(const coff_section *Sec,
 319                                 ArrayRef<uint8_t> &Res) const;
 320
 321   error_code getRvaPtr(uint32_t Rva, uintptr_t &Res) const;
 322   error_code getHintName(uint32_t Rva, uint16_t &Hint, StringRef &Name) const;
 323
 324   static inline bool classof(const Binary *v) {
 325     return v->isCOFF();
 326   }
 327 };
 328
 329 // The iterator for the import directory table.
 330 class ImportDirectoryEntryRef {
 331 public:
 332   ImportDirectoryEntryRef() : OwningObject(0) {}
 333   ImportDirectoryEntryRef(DataRefImpl ImportDirectory,
 334                           const COFFObjectFile *Owner)
 335       : ImportDirectoryPimpl(ImportDirectory), OwningObject(Owner) {}
 336
 337   bool operator==(const ImportDirectoryEntryRef &Other) const;
 338   error_code getNext(ImportDirectoryEntryRef &Result) const;
 339   error_code getName(StringRef &Result) const;
 340
 341   error_code
 342   getImportTableEntry(const import_directory_table_entry *&Result) const;
 343
 344   error_code
 345   getImportLookupEntry(const COFF::ImportLookupTableEntry32 *&Result) const;
 346
 347 private:
 348   DataRefImpl ImportDirectoryPimpl;
 349   const COFFObjectFile *OwningObject;
 350 };
 351 } // end namespace object
 352 } // end namespace llvm
 353
 354 #endif