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
  27 /// The DOS compatible header at the front of all PE/COFF executables.
  28 struct dos_header {
  29   support::ulittle16_t Magic;
  30   support::ulittle16_t UsedBytesInTheLastPage;
  31   support::ulittle16_t FileSizeInPages;
  32   support::ulittle16_t NumberOfRelocationItems;
  33   support::ulittle16_t HeaderSizeInParagraphs;
  34   support::ulittle16_t MinimumExtraParagraphs;
  35   support::ulittle16_t MaximumExtraParagraphs;
  36   support::ulittle16_t InitialRelativeSS;
  37   support::ulittle16_t InitialSP;
  38   support::ulittle16_t Checksum;
  39   support::ulittle16_t InitialIP;
  40   support::ulittle16_t InitialRelativeCS;
  41   support::ulittle16_t AddressOfRelocationTable;
  42   support::ulittle16_t OverlayNumber;
  43   support::ulittle16_t Reserved[4];
  44   support::ulittle16_t OEMid;
  45   support::ulittle16_t OEMinfo;
  46   support::ulittle16_t Reserved2[10];
  47   support::ulittle32_t AddressOfNewExeHeader;
  48 };
  49
  50 struct coff_file_header {
  51   support::ulittle16_t Machine;
  52   support::ulittle16_t NumberOfSections;
  53   support::ulittle32_t TimeDateStamp;
  54   support::ulittle32_t PointerToSymbolTable;
  55   support::ulittle32_t NumberOfSymbols;
  56   support::ulittle16_t SizeOfOptionalHeader;
  57   support::ulittle16_t Characteristics;
  58 };
  59
  60 /// The 32-bit PE header that usually immediately follows the DOS header.
  61 struct pe32_header {
  62   support::ulittle32_t Signature;
  63   coff_file_header COFFHeader;
  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 usually immediately follows the DOS header.
  97 struct pe32plus_header {
  98   support::ulittle32_t Signature;
  99   coff_file_header COFFHeader;
 100   support::ulittle16_t Magic;
 101   uint8_t  MajorLinkerVersion;
 102   uint8_t  MinorLinkerVersion;
 103   support::ulittle32_t SizeOfCode;
 104   support::ulittle32_t SizeOfInitializedData;
 105   support::ulittle32_t SizeOfUninitializedData;
 106   support::ulittle32_t AddressOfEntryPoint;
 107   support::ulittle32_t BaseOfCode;
 108   support::ulittle32_t BaseOfData;
 109   support::ulittle64_t ImageBase;
 110   support::ulittle32_t SectionAlignment;
 111   support::ulittle32_t FileAlignment;
 112   support::ulittle16_t MajorOperatingSystemVersion;
 113   support::ulittle16_t MinorOperatingSystemVersion;
 114   support::ulittle16_t MajorImageVersion;
 115   support::ulittle16_t MinorImageVersion;
 116   support::ulittle16_t MajorSubsystemVersion;
 117   support::ulittle16_t MinorSubsystemVersion;
 118   support::ulittle32_t Win32VersionValue;
 119   support::ulittle32_t SizeOfImage;
 120   support::ulittle32_t SizeOfHeaders;
 121   support::ulittle32_t CheckSum;
 122   support::ulittle16_t Subsystem;
 123   support::ulittle16_t DLLCharacteristics;
 124   support::ulittle64_t SizeOfStackReserve;
 125   support::ulittle64_t SizeOfStackCommit;
 126   support::ulittle64_t SizeOfHeapReserve;
 127   support::ulittle64_t SizeOfHeapCommit;
 128   support::ulittle32_t LoaderFlags;
 129   support::ulittle32_t NumberOfRvaAndSize;
 130 };
 131
 132 struct data_directory {
 133   support::ulittle32_t RelativeVirtualAddress;
 134   support::ulittle32_t Size;
 135 };
 136
 137 struct coff_symbol {
 138   struct StringTableOffset {
 139     support::ulittle32_t Zeroes;
 140     support::ulittle32_t Offset;
 141   };
 142
 143   union {
 144     char ShortName[8];
 145     StringTableOffset Offset;
 146   } Name;
 147
 148   support::ulittle32_t Value;
 149   support::little16_t SectionNumber;
 150
 151   support::ulittle16_t Type;
 152
 153   support::ulittle8_t  StorageClass;
 154   support::ulittle8_t  NumberOfAuxSymbols;
 155
 156   uint8_t getBaseType() const {
 157     return Type & 0x0F;
 158   }
 159
 160   uint8_t getComplexType() const {
 161     return (Type & 0xF0) >> 4;
 162   }
 163 };
 164
 165 struct coff_section {
 166   char Name[8];
 167   support::ulittle32_t VirtualSize;
 168   support::ulittle32_t VirtualAddress;
 169   support::ulittle32_t SizeOfRawData;
 170   support::ulittle32_t PointerToRawData;
 171   support::ulittle32_t PointerToRelocations;
 172   support::ulittle32_t PointerToLinenumbers;
 173   support::ulittle16_t NumberOfRelocations;
 174   support::ulittle16_t NumberOfLinenumbers;
 175   support::ulittle32_t Characteristics;
 176 };
 177
 178 struct coff_relocation {
 179   support::ulittle32_t VirtualAddress;
 180   support::ulittle32_t SymbolTableIndex;
 181   support::ulittle16_t Type;
 182 };
 183
 184 struct coff_aux_section_definition {
 185   support::ulittle32_t Length;
 186   support::ulittle16_t NumberOfRelocations;
 187   support::ulittle16_t NumberOfLinenumbers;
 188   support::ulittle32_t CheckSum;
 189   support::ulittle16_t Number;
 190   support::ulittle8_t Selection;
 191   char Unused[3];
 192 };
 193
 194 class COFFObjectFile : public ObjectFile {
 195 private:
 196   const coff_file_header *Header;
 197   const coff_section     *SectionTable;
 198   const coff_symbol      *SymbolTable;
 199   const char             *StringTable;
 200         uint32_t          StringTableSize;
 201
 202         error_code        getString(uint32_t offset, StringRef &Res) const;
 203
 204   const coff_symbol      *toSymb(DataRefImpl Symb) const;
 205   const coff_section     *toSec(DataRefImpl Sec) const;
 206   const coff_relocation  *toRel(DataRefImpl Rel) const;
 207
 208 protected:
 209   virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const;
 210   virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const;
 211   virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const;
 212   virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const;
 213   virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const;
 214   virtual error_code getSymbolNMTypeChar(DataRefImpl Symb, char &Res) const;
 215   virtual error_code getSymbolFlags(DataRefImpl Symb, uint32_t &Res) const;
 216   virtual error_code getSymbolType(DataRefImpl Symb, SymbolRef::Type &Res) const;
 217   virtual error_code getSymbolSection(DataRefImpl Symb,
 218                                       section_iterator &Res) const;
 219   virtual error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const;
 220
 221   virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const;
 222   virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const;
 223   virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const;
 224   virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const;
 225   virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res) const;
 226   virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const;
 227   virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const;
 228   virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const;
 229   virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const;
 230   virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const;
 231   virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const;
 232   virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const;
 233   virtual error_code isSectionRequiredForExecution(DataRefImpl Sec,
 234                                                    bool &Res) const;
 235   virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
 236                                            bool &Result) const;
 237   virtual relocation_iterator getSectionRelBegin(DataRefImpl Sec) const;
 238   virtual relocation_iterator getSectionRelEnd(DataRefImpl Sec) const;
 239
 240   virtual error_code getRelocationNext(DataRefImpl Rel,
 241                                        RelocationRef &Res) const;
 242   virtual error_code getRelocationAddress(DataRefImpl Rel,
 243                                           uint64_t &Res) const;
 244   virtual error_code getRelocationOffset(DataRefImpl Rel,
 245                                          uint64_t &Res) const;
 246   virtual error_code getRelocationSymbol(DataRefImpl Rel,
 247                                          SymbolRef &Res) const;
 248   virtual error_code getRelocationType(DataRefImpl Rel,
 249                                        uint64_t &Res) const;
 250   virtual error_code getRelocationTypeName(DataRefImpl Rel,
 251                                            SmallVectorImpl<char> &Result) const;
 252   virtual error_code getRelocationValueString(DataRefImpl Rel,
 253                                            SmallVectorImpl<char> &Result) const;
 254
 255   virtual error_code getLibraryNext(DataRefImpl LibData,
 256                                     LibraryRef &Result) const;
 257   virtual error_code getLibraryPath(DataRefImpl LibData,
 258                                     StringRef &Result) const;
 259
 260 public:
 261   COFFObjectFile(MemoryBuffer *Object, error_code &ec);
 262   virtual symbol_iterator begin_symbols() const;
 263   virtual symbol_iterator end_symbols() const;
 264   virtual symbol_iterator begin_dynamic_symbols() const;
 265   virtual symbol_iterator end_dynamic_symbols() const;
 266   virtual library_iterator begin_libraries_needed() const;
 267   virtual library_iterator end_libraries_needed() const;
 268   virtual section_iterator begin_sections() const;
 269   virtual section_iterator end_sections() const;
 270
 271   const coff_section *getCOFFSection(section_iterator &It) const;
 272   const coff_symbol *getCOFFSymbol(symbol_iterator &It) const;
 273   const coff_relocation *getCOFFRelocation(relocation_iterator &It) const;
 274
 275   virtual uint8_t getBytesInAddress() const;
 276   virtual StringRef getFileFormatName() const;
 277   virtual unsigned getArch() const;
 278   virtual StringRef getLoadName() const;
 279
 280   error_code getHeader(const coff_file_header *&Res) const;
 281   error_code getSection(int32_t index, const coff_section *&Res) const;
 282   error_code getSymbol(uint32_t index, const coff_symbol *&Res) const;
 283   template <typename T>
 284   error_code getAuxSymbol(uint32_t index, const T *&Res) const {
 285     const coff_symbol *s;
 286     error_code ec = getSymbol(index, s);
 287     Res = reinterpret_cast<const T*>(s);
 288     return ec;
 289   }
 290   error_code getSymbolName(const coff_symbol *symbol, StringRef &Res) const;
 291   ArrayRef<uint8_t> getSymbolAuxData(const coff_symbol *symbol) const;
 292
 293   error_code getSectionName(const coff_section *Sec, StringRef &Res) const;
 294   error_code getSectionContents(const coff_section *Sec,
 295                                 ArrayRef<uint8_t> &Res) const;
 296
 297   static inline bool classof(const Binary *v) {
 298     return v->isCOFF();
 299   }
 300 };
 301
 302 }
 303 }
 304
 305 #endif