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"
27 /// The DOS compatible header at the front of all PE/COFF executables.
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;
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;
60 /// The 32-bit PE header that usually immediately follows the DOS 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;
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::ulittle64_t ImageBase;
109 support::ulittle32_t SectionAlignment;
110 support::ulittle32_t FileAlignment;
111 support::ulittle16_t MajorOperatingSystemVersion;
112 support::ulittle16_t MinorOperatingSystemVersion;
113 support::ulittle16_t MajorImageVersion;
114 support::ulittle16_t MinorImageVersion;
115 support::ulittle16_t MajorSubsystemVersion;
116 support::ulittle16_t MinorSubsystemVersion;
117 support::ulittle32_t Win32VersionValue;
118 support::ulittle32_t SizeOfImage;
119 support::ulittle32_t SizeOfHeaders;
120 support::ulittle32_t CheckSum;
121 support::ulittle16_t Subsystem;
122 support::ulittle16_t DLLCharacteristics;
123 support::ulittle64_t SizeOfStackReserve;
124 support::ulittle64_t SizeOfStackCommit;
125 support::ulittle64_t SizeOfHeapReserve;
126 support::ulittle64_t SizeOfHeapCommit;
127 support::ulittle32_t LoaderFlags;
128 support::ulittle32_t NumberOfRvaAndSize;
131 struct data_directory {
132 support::ulittle32_t RelativeVirtualAddress;
133 support::ulittle32_t Size;
137 struct StringTableOffset {
138 support::ulittle32_t Zeroes;
139 support::ulittle32_t Offset;
144 StringTableOffset Offset;
147 support::ulittle32_t Value;
148 support::little16_t SectionNumber;
150 support::ulittle16_t Type;
152 support::ulittle8_t StorageClass;
153 support::ulittle8_t NumberOfAuxSymbols;
155 uint8_t getBaseType() const {
159 uint8_t getComplexType() const {
160 return (Type & 0xF0) >> 4;
164 struct coff_section {
166 support::ulittle32_t VirtualSize;
167 support::ulittle32_t VirtualAddress;
168 support::ulittle32_t SizeOfRawData;
169 support::ulittle32_t PointerToRawData;
170 support::ulittle32_t PointerToRelocations;
171 support::ulittle32_t PointerToLinenumbers;
172 support::ulittle16_t NumberOfRelocations;
173 support::ulittle16_t NumberOfLinenumbers;
174 support::ulittle32_t Characteristics;
177 struct coff_relocation {
178 support::ulittle32_t VirtualAddress;
179 support::ulittle32_t SymbolTableIndex;
180 support::ulittle16_t Type;
183 struct coff_aux_section_definition {
184 support::ulittle32_t Length;
185 support::ulittle16_t NumberOfRelocations;
186 support::ulittle16_t NumberOfLinenumbers;
187 support::ulittle32_t CheckSum;
188 support::ulittle16_t Number;
189 support::ulittle8_t Selection;
193 class COFFObjectFile : public ObjectFile {
195 const coff_file_header *Header;
196 const coff_section *SectionTable;
197 const coff_symbol *SymbolTable;
198 const char *StringTable;
199 uint32_t StringTableSize;
201 error_code getString(uint32_t offset, StringRef &Res) const;
203 const coff_symbol *toSymb(DataRefImpl Symb) const;
204 const coff_section *toSec(DataRefImpl Sec) const;
205 const coff_relocation *toRel(DataRefImpl Rel) const;
208 virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const;
209 virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const;
210 virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const;
211 virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const;
212 virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const;
213 virtual error_code getSymbolNMTypeChar(DataRefImpl Symb, char &Res) const;
214 virtual error_code getSymbolFlags(DataRefImpl Symb, uint32_t &Res) const;
215 virtual error_code getSymbolType(DataRefImpl Symb, SymbolRef::Type &Res) const;
216 virtual error_code getSymbolSection(DataRefImpl Symb,
217 section_iterator &Res) const;
218 virtual error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const;
220 virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const;
221 virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const;
222 virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const;
223 virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const;
224 virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res) const;
225 virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const;
226 virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const;
227 virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const;
228 virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const;
229 virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const;
230 virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const;
231 virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const;
232 virtual error_code isSectionRequiredForExecution(DataRefImpl Sec,
234 virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
236 virtual relocation_iterator getSectionRelBegin(DataRefImpl Sec) const;
237 virtual relocation_iterator getSectionRelEnd(DataRefImpl Sec) const;
239 virtual error_code getRelocationNext(DataRefImpl Rel,
240 RelocationRef &Res) const;
241 virtual error_code getRelocationAddress(DataRefImpl Rel,
242 uint64_t &Res) const;
243 virtual error_code getRelocationOffset(DataRefImpl Rel,
244 uint64_t &Res) const;
245 virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const;
246 virtual error_code getRelocationType(DataRefImpl Rel,
247 uint64_t &Res) const;
248 virtual error_code getRelocationTypeName(DataRefImpl Rel,
249 SmallVectorImpl<char> &Result) const;
250 virtual error_code getRelocationValueString(DataRefImpl Rel,
251 SmallVectorImpl<char> &Result) const;
253 virtual error_code getLibraryNext(DataRefImpl LibData,
254 LibraryRef &Result) const;
255 virtual error_code getLibraryPath(DataRefImpl LibData,
256 StringRef &Result) const;
259 COFFObjectFile(MemoryBuffer *Object, error_code &ec);
260 virtual symbol_iterator begin_symbols() const;
261 virtual symbol_iterator end_symbols() const;
262 virtual symbol_iterator begin_dynamic_symbols() const;
263 virtual symbol_iterator end_dynamic_symbols() const;
264 virtual library_iterator begin_libraries_needed() const;
265 virtual library_iterator end_libraries_needed() const;
266 virtual section_iterator begin_sections() const;
267 virtual section_iterator end_sections() const;
269 const coff_section *getCOFFSection(section_iterator &It) const;
270 const coff_symbol *getCOFFSymbol(symbol_iterator &It) const;
271 const coff_relocation *getCOFFRelocation(relocation_iterator &It) const;
273 virtual uint8_t getBytesInAddress() const;
274 virtual StringRef getFileFormatName() const;
275 virtual unsigned getArch() const;
276 virtual StringRef getLoadName() const;
278 error_code getHeader(const coff_file_header *&Res) const;
279 error_code getSection(int32_t index, const coff_section *&Res) const;
280 error_code getSymbol(uint32_t index, const coff_symbol *&Res) const;
281 template <typename T>
282 error_code getAuxSymbol(uint32_t index, const T *&Res) const {
283 const coff_symbol *s;
284 error_code ec = getSymbol(index, s);
285 Res = reinterpret_cast<const T*>(s);
288 error_code getSymbolName(const coff_symbol *symbol, StringRef &Res) const;
289 ArrayRef<uint8_t> getSymbolAuxData(const coff_symbol *symbol) const;
291 error_code getSectionName(const coff_section *Sec, StringRef &Res) const;
292 error_code getSectionContents(const coff_section *Sec,
293 ArrayRef<uint8_t> &Res) const;
295 static inline bool classof(const Binary *v) {