1 //===- COFF.h - COFF object file implementation -----------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the COFFObjectFile class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_OBJECT_COFF_H
15 #define LLVM_OBJECT_COFF_H
17 #include "llvm/Object/ObjectFile.h"
18 #include "llvm/Support/COFF.h"
19 #include "llvm/Support/Endian.h"
26 class ImportDirectoryEntryRef;
27 typedef content_iterator<ImportDirectoryEntryRef> import_directory_iterator;
29 /// The DOS compatible header at the front of all PE/COFF executables.
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;
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;
62 /// The 32-bit PE header that follows the COFF 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;
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;
129 struct data_directory {
130 support::ulittle32_t RelativeVirtualAddress;
131 support::ulittle32_t Size;
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;
142 struct import_lookup_table_entry32 {
143 support::ulittle32_t data;
145 bool isOrdinal() const { return data & 0x80000000; }
147 uint16_t getOrdinal() const {
148 assert(isOrdinal() && "ILT entry is not an ordinal!");
149 return data & 0xFFFF;
152 uint32_t getHintNameRVA() const {
153 assert(!isOrdinal() && "ILT entry is not a Hint/Name RVA!");
159 struct StringTableOffset {
160 support::ulittle32_t Zeroes;
161 support::ulittle32_t Offset;
166 StringTableOffset Offset;
169 support::ulittle32_t Value;
170 support::little16_t SectionNumber;
172 support::ulittle16_t Type;
174 support::ulittle8_t StorageClass;
175 support::ulittle8_t NumberOfAuxSymbols;
177 uint8_t getBaseType() const {
181 uint8_t getComplexType() const {
182 return (Type & 0xF0) >> 4;
186 struct coff_section {
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;
199 struct coff_relocation {
200 support::ulittle32_t VirtualAddress;
201 support::ulittle32_t SymbolTableIndex;
202 support::ulittle16_t Type;
205 struct coff_aux_weak_external {
206 support::ulittle32_t TagIndex;
207 support::ulittle32_t Characteristics;
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;
221 class COFFObjectFile : public ObjectFile {
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;
234 error_code getString(uint32_t offset, StringRef &Res) const;
236 const coff_symbol *toSymb(DataRefImpl Symb) const;
237 const coff_section *toSec(DataRefImpl Sec) const;
238 const coff_relocation *toRel(DataRefImpl Rel) const;
240 error_code initSymbolTablePtr();
241 error_code initImportTablePtr();
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 getSymbolNMTypeChar(DataRefImpl Symb, char &Res) const;
250 virtual error_code getSymbolFlags(DataRefImpl Symb, uint32_t &Res) const;
251 virtual error_code getSymbolType(DataRefImpl Symb, SymbolRef::Type &Res) const;
252 virtual error_code getSymbolSection(DataRefImpl Symb,
253 section_iterator &Res) const;
254 virtual error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const;
256 virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const;
257 virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const;
258 virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const;
259 virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const;
260 virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res) const;
261 virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const;
262 virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const;
263 virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const;
264 virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const;
265 virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const;
266 virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const;
267 virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const;
268 virtual error_code isSectionRequiredForExecution(DataRefImpl Sec,
270 virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
272 virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const;
273 virtual relocation_iterator section_rel_end(DataRefImpl Sec) const;
275 virtual error_code getRelocationNext(DataRefImpl Rel,
276 RelocationRef &Res) const;
277 virtual error_code getRelocationAddress(DataRefImpl Rel,
278 uint64_t &Res) const;
279 virtual error_code getRelocationOffset(DataRefImpl Rel,
280 uint64_t &Res) const;
281 virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const;
282 virtual error_code getRelocationType(DataRefImpl Rel,
283 uint64_t &Res) const;
284 virtual error_code getRelocationTypeName(DataRefImpl Rel,
285 SmallVectorImpl<char> &Result) const;
286 virtual error_code getRelocationValueString(DataRefImpl Rel,
287 SmallVectorImpl<char> &Result) const;
289 virtual error_code getLibraryNext(DataRefImpl LibData,
290 LibraryRef &Result) const;
291 virtual error_code getLibraryPath(DataRefImpl LibData,
292 StringRef &Result) const;
295 COFFObjectFile(MemoryBuffer *Object, error_code &ec);
296 virtual symbol_iterator begin_symbols() const;
297 virtual symbol_iterator end_symbols() const;
298 virtual symbol_iterator begin_dynamic_symbols() const;
299 virtual symbol_iterator end_dynamic_symbols() const;
300 virtual library_iterator begin_libraries_needed() const;
301 virtual library_iterator end_libraries_needed() const;
302 virtual section_iterator begin_sections() const;
303 virtual section_iterator end_sections() const;
305 const coff_section *getCOFFSection(section_iterator &It) const;
306 const coff_symbol *getCOFFSymbol(symbol_iterator &It) const;
307 const coff_relocation *getCOFFRelocation(relocation_iterator &It) const;
309 virtual uint8_t getBytesInAddress() const;
310 virtual StringRef getFileFormatName() const;
311 virtual unsigned getArch() const;
312 virtual StringRef getLoadName() const;
314 import_directory_iterator import_directory_begin() const;
315 import_directory_iterator import_directory_end() const;
317 error_code getHeader(const coff_file_header *&Res) const;
318 error_code getCOFFHeader(const coff_file_header *&Res) const;
319 error_code getPE32Header(const pe32_header *&Res) const;
320 error_code getDataDirectory(uint32_t index, const data_directory *&Res) const;
321 error_code getSection(int32_t index, const coff_section *&Res) const;
322 error_code getSymbol(uint32_t index, const coff_symbol *&Res) const;
323 template <typename T>
324 error_code getAuxSymbol(uint32_t index, const T *&Res) const {
325 const coff_symbol *s;
326 error_code ec = getSymbol(index, s);
327 Res = reinterpret_cast<const T*>(s);
330 error_code getSymbolName(const coff_symbol *symbol, StringRef &Res) const;
331 ArrayRef<uint8_t> getSymbolAuxData(const coff_symbol *symbol) const;
333 error_code getSectionName(const coff_section *Sec, StringRef &Res) const;
334 error_code getSectionContents(const coff_section *Sec,
335 ArrayRef<uint8_t> &Res) const;
337 error_code getRvaPtr(uint32_t Rva, uintptr_t &Res) const;
338 error_code getHintName(uint32_t Rva, uint16_t &Hint, StringRef &Name) const;
340 static inline bool classof(const Binary *v) {
345 // The iterator for the import directory table.
346 class ImportDirectoryEntryRef {
348 ImportDirectoryEntryRef() : OwningObject(0) {}
349 ImportDirectoryEntryRef(DataRefImpl ImportDirectory,
350 const COFFObjectFile *Owner)
351 : ImportDirectoryPimpl(ImportDirectory), OwningObject(Owner) {}
353 bool operator==(const ImportDirectoryEntryRef &Other) const;
354 error_code getNext(ImportDirectoryEntryRef &Result) const;
355 error_code getName(StringRef &Result) const;
358 getImportTableEntry(const import_directory_table_entry *&Result) const;
361 getImportLookupEntry(const import_lookup_table_entry32 *&Result) const;
364 DataRefImpl ImportDirectoryPimpl;
365 const COFFObjectFile *OwningObject;
367 } // end namespace object
368 } // end namespace llvm