blob: 0b7ee34c09af71dd85aeba486fe809e84e323e6e [file] [log] [blame]
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +00001//===- COFFObjectFile.cpp - 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
Michael J. Spencer001c9202011-06-25 17:54:50 +000014#include "llvm/Object/COFF.h"
Michael J. Spencer1f6e3f92012-03-19 20:27:37 +000015#include "llvm/ADT/ArrayRef.h"
Michael J. Spencer4344b1e2011-10-07 19:25:32 +000016#include "llvm/ADT/SmallString.h"
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +000017#include "llvm/ADT/StringSwitch.h"
18#include "llvm/ADT/Triple.h"
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +000019
20using namespace llvm;
21using namespace object;
22
23namespace {
24using support::ulittle8_t;
25using support::ulittle16_t;
26using support::ulittle32_t;
27using support::little16_t;
28}
29
Michael J. Spencer25b15772011-06-25 17:55:23 +000030namespace {
31// Returns false if size is greater than the buffer size. And sets ec.
32bool checkSize(const MemoryBuffer *m, error_code &ec, uint64_t size) {
33 if (m->getBufferSize() < size) {
34 ec = object_error::unexpected_eof;
35 return false;
36 }
37 return true;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +000038}
39
Michael J. Spencer25b15772011-06-25 17:55:23 +000040// Returns false if any bytes in [addr, addr + size) fall outsize of m.
41bool checkAddr(const MemoryBuffer *m,
42 error_code &ec,
43 uintptr_t addr,
44 uint64_t size) {
45 if (addr + size < addr ||
46 addr + size < size ||
47 addr + size > uintptr_t(m->getBufferEnd())) {
48 ec = object_error::unexpected_eof;
49 return false;
50 }
51 return true;
52}
53}
54
55const coff_symbol *COFFObjectFile::toSymb(DataRefImpl Symb) const {
56 const coff_symbol *addr = reinterpret_cast<const coff_symbol*>(Symb.p);
57
58# ifndef NDEBUG
59 // Verify that the symbol points to a valid entry in the symbol table.
60 uintptr_t offset = uintptr_t(addr) - uintptr_t(base());
61 if (offset < Header->PointerToSymbolTable
62 || offset >= Header->PointerToSymbolTable
63 + (Header->NumberOfSymbols * sizeof(coff_symbol)))
64 report_fatal_error("Symbol was outside of symbol table.");
65
66 assert((offset - Header->PointerToSymbolTable) % sizeof(coff_symbol)
67 == 0 && "Symbol did not point to the beginning of a symbol");
68# endif
69
70 return addr;
71}
72
73const coff_section *COFFObjectFile::toSec(DataRefImpl Sec) const {
74 const coff_section *addr = reinterpret_cast<const coff_section*>(Sec.p);
75
76# ifndef NDEBUG
77 // Verify that the section points to a valid entry in the section table.
78 if (addr < SectionTable
79 || addr >= (SectionTable + Header->NumberOfSections))
80 report_fatal_error("Section was outside of section table.");
81
82 uintptr_t offset = uintptr_t(addr) - uintptr_t(SectionTable);
83 assert(offset % sizeof(coff_section) == 0 &&
84 "Section did not point to the beginning of a section");
85# endif
86
87 return addr;
88}
89
90error_code COFFObjectFile::getSymbolNext(DataRefImpl Symb,
91 SymbolRef &Result) const {
92 const coff_symbol *symb = toSymb(Symb);
93 symb += 1 + symb->NumberOfAuxSymbols;
94 Symb.p = reinterpret_cast<uintptr_t>(symb);
95 Result = SymbolRef(Symb, this);
96 return object_error::success;
97}
98
99 error_code COFFObjectFile::getSymbolName(DataRefImpl Symb,
100 StringRef &Result) const {
101 const coff_symbol *symb = toSymb(Symb);
Michael J. Spencer0e752cb2011-10-17 23:53:56 +0000102 return getSymbolName(symb, Result);
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000103}
104
Danil Malyshevb0436a72011-11-29 17:40:10 +0000105error_code COFFObjectFile::getSymbolFileOffset(DataRefImpl Symb,
Michael J. Spencer25b15772011-06-25 17:55:23 +0000106 uint64_t &Result) const {
107 const coff_symbol *symb = toSymb(Symb);
Michael J. Spencer64388ce2011-07-05 14:48:59 +0000108 const coff_section *Section = NULL;
Michael J. Spencer25b15772011-06-25 17:55:23 +0000109 if (error_code ec = getSection(symb->SectionNumber, Section))
110 return ec;
111 char Type;
112 if (error_code ec = getSymbolNMTypeChar(Symb, Type))
113 return ec;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000114 if (Type == 'U' || Type == 'w')
Michael J. Spencer25b15772011-06-25 17:55:23 +0000115 Result = UnknownAddressOrSize;
116 else if (Section)
Danil Malyshevb0436a72011-11-29 17:40:10 +0000117 Result = Section->PointerToRawData + symb->Value;
Michael J. Spencer25b15772011-06-25 17:55:23 +0000118 else
119 Result = symb->Value;
120 return object_error::success;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000121}
122
Benjamin Kramerac241fe2011-09-14 01:22:52 +0000123error_code COFFObjectFile::getSymbolAddress(DataRefImpl Symb,
124 uint64_t &Result) const {
125 const coff_symbol *symb = toSymb(Symb);
126 const coff_section *Section = NULL;
127 if (error_code ec = getSection(symb->SectionNumber, Section))
128 return ec;
129 char Type;
130 if (error_code ec = getSymbolNMTypeChar(Symb, Type))
131 return ec;
132 if (Type == 'U' || Type == 'w')
133 Result = UnknownAddressOrSize;
134 else if (Section)
Danil Malyshevb0436a72011-11-29 17:40:10 +0000135 Result = Section->VirtualAddress + symb->Value;
Benjamin Kramerac241fe2011-09-14 01:22:52 +0000136 else
Danil Malyshevb0436a72011-11-29 17:40:10 +0000137 Result = symb->Value;
Benjamin Kramerac241fe2011-09-14 01:22:52 +0000138 return object_error::success;
139}
140
141error_code COFFObjectFile::getSymbolType(DataRefImpl Symb,
Michael J. Spencer1130a792011-10-17 20:19:29 +0000142 SymbolRef::Type &Result) const {
Benjamin Kramerac241fe2011-09-14 01:22:52 +0000143 const coff_symbol *symb = toSymb(Symb);
144 Result = SymbolRef::ST_Other;
145 if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
146 symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED) {
David Meyer2c677272012-02-29 02:11:55 +0000147 Result = SymbolRef::ST_Unknown;
Benjamin Kramerac241fe2011-09-14 01:22:52 +0000148 } else {
Michael J. Spencer5e3a0822011-10-18 19:31:59 +0000149 if (symb->getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION) {
Benjamin Kramerac241fe2011-09-14 01:22:52 +0000150 Result = SymbolRef::ST_Function;
151 } else {
152 char Type;
153 if (error_code ec = getSymbolNMTypeChar(Symb, Type))
154 return ec;
155 if (Type == 'r' || Type == 'R') {
156 Result = SymbolRef::ST_Data;
157 }
158 }
159 }
160 return object_error::success;
161}
162
David Meyerc46255a2012-02-28 23:47:53 +0000163error_code COFFObjectFile::getSymbolFlags(DataRefImpl Symb,
164 uint32_t &Result) const {
Benjamin Kramerac241fe2011-09-14 01:22:52 +0000165 const coff_symbol *symb = toSymb(Symb);
David Meyerc46255a2012-02-28 23:47:53 +0000166 Result = SymbolRef::SF_None;
Benjamin Kramerac241fe2011-09-14 01:22:52 +0000167
David Meyer2c677272012-02-29 02:11:55 +0000168 // TODO: Correctly set SF_FormatSpecific, SF_ThreadLocal, SF_Common
169
170 if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
171 symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED)
172 Result |= SymbolRef::SF_Undefined;
David Meyerc46255a2012-02-28 23:47:53 +0000173
174 // TODO: This are certainly too restrictive.
175 if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL)
176 Result |= SymbolRef::SF_Global;
177
178 if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL)
179 Result |= SymbolRef::SF_Weak;
180
181 if (symb->SectionNumber == COFF::IMAGE_SYM_ABSOLUTE)
182 Result |= SymbolRef::SF_Absolute;
183
Michael J. Spencerc38c36a2011-10-17 23:54:22 +0000184 return object_error::success;
185}
186
Michael J. Spencer25b15772011-06-25 17:55:23 +0000187error_code COFFObjectFile::getSymbolSize(DataRefImpl Symb,
188 uint64_t &Result) const {
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000189 // FIXME: Return the correct size. This requires looking at all the symbols
190 // in the same section as this symbol, and looking for either the next
191 // symbol, or the end of the section.
Michael J. Spencer25b15772011-06-25 17:55:23 +0000192 const coff_symbol *symb = toSymb(Symb);
Michael J. Spencer64388ce2011-07-05 14:48:59 +0000193 const coff_section *Section = NULL;
Michael J. Spencer25b15772011-06-25 17:55:23 +0000194 if (error_code ec = getSection(symb->SectionNumber, Section))
195 return ec;
196 char Type;
197 if (error_code ec = getSymbolNMTypeChar(Symb, Type))
198 return ec;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000199 if (Type == 'U' || Type == 'w')
Michael J. Spencer25b15772011-06-25 17:55:23 +0000200 Result = UnknownAddressOrSize;
201 else if (Section)
202 Result = Section->SizeOfRawData - symb->Value;
203 else
204 Result = 0;
205 return object_error::success;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000206}
207
Michael J. Spencer25b15772011-06-25 17:55:23 +0000208error_code COFFObjectFile::getSymbolNMTypeChar(DataRefImpl Symb,
209 char &Result) const {
210 const coff_symbol *symb = toSymb(Symb);
211 StringRef name;
212 if (error_code ec = getSymbolName(Symb, name))
213 return ec;
214 char ret = StringSwitch<char>(name)
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000215 .StartsWith(".debug", 'N')
216 .StartsWith(".sxdata", 'N')
217 .Default('?');
218
Michael J. Spencer25b15772011-06-25 17:55:23 +0000219 if (ret != '?') {
220 Result = ret;
221 return object_error::success;
222 }
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000223
224 uint32_t Characteristics = 0;
Michael J. Spencer25b15772011-06-25 17:55:23 +0000225 if (symb->SectionNumber > 0) {
Michael J. Spencer64388ce2011-07-05 14:48:59 +0000226 const coff_section *Section = NULL;
Michael J. Spencer25b15772011-06-25 17:55:23 +0000227 if (error_code ec = getSection(symb->SectionNumber, Section))
228 return ec;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000229 Characteristics = Section->Characteristics;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000230 }
231
232 switch (symb->SectionNumber) {
233 case COFF::IMAGE_SYM_UNDEFINED:
234 // Check storage classes.
Michael J. Spencer25b15772011-06-25 17:55:23 +0000235 if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL) {
236 Result = 'w';
237 return object_error::success; // Don't do ::toupper.
Michael J. Spencer11ba26d2011-11-16 23:36:12 +0000238 } else if (symb->Value != 0) // Check for common symbols.
239 ret = 'c';
240 else
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000241 ret = 'u';
242 break;
243 case COFF::IMAGE_SYM_ABSOLUTE:
244 ret = 'a';
245 break;
246 case COFF::IMAGE_SYM_DEBUG:
247 ret = 'n';
248 break;
249 default:
250 // Check section type.
251 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
252 ret = 't';
253 else if ( Characteristics & COFF::IMAGE_SCN_MEM_READ
254 && ~Characteristics & COFF::IMAGE_SCN_MEM_WRITE) // Read only.
255 ret = 'r';
256 else if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
257 ret = 'd';
258 else if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
259 ret = 'b';
260 else if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
261 ret = 'i';
262
263 // Check for section symbol.
264 else if ( symb->StorageClass == COFF::IMAGE_SYM_CLASS_STATIC
265 && symb->Value == 0)
266 ret = 's';
267 }
268
269 if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL)
270 ret = ::toupper(ret);
271
Michael J. Spencer25b15772011-06-25 17:55:23 +0000272 Result = ret;
273 return object_error::success;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000274}
275
Michael J. Spencer9b2b8122011-10-17 23:54:46 +0000276error_code COFFObjectFile::getSymbolSection(DataRefImpl Symb,
277 section_iterator &Result) const {
278 const coff_symbol *symb = toSymb(Symb);
279 if (symb->SectionNumber <= COFF::IMAGE_SYM_UNDEFINED)
280 Result = end_sections();
281 else {
Daniel Dunbara483fc82011-11-28 22:19:32 +0000282 const coff_section *sec = 0;
Michael J. Spencer9b2b8122011-10-17 23:54:46 +0000283 if (error_code ec = getSection(symb->SectionNumber, sec)) return ec;
284 DataRefImpl Sec;
285 Sec.p = reinterpret_cast<uintptr_t>(sec);
286 Result = section_iterator(SectionRef(Sec, this));
287 }
288 return object_error::success;
289}
290
Tim Northovera41dce32012-10-29 10:47:00 +0000291error_code COFFObjectFile::getSymbolValue(DataRefImpl Symb,
292 uint64_t &Val) const {
293 report_fatal_error("getSymbolValue unimplemented in COFFObjectFile");
294}
295
Michael J. Spencer25b15772011-06-25 17:55:23 +0000296error_code COFFObjectFile::getSectionNext(DataRefImpl Sec,
297 SectionRef &Result) const {
298 const coff_section *sec = toSec(Sec);
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000299 sec += 1;
Michael J. Spencer25b15772011-06-25 17:55:23 +0000300 Sec.p = reinterpret_cast<uintptr_t>(sec);
301 Result = SectionRef(Sec, this);
302 return object_error::success;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000303}
304
Michael J. Spencer25b15772011-06-25 17:55:23 +0000305error_code COFFObjectFile::getSectionName(DataRefImpl Sec,
306 StringRef &Result) const {
307 const coff_section *sec = toSec(Sec);
Michael J. Spencerb35a8962012-03-19 20:27:15 +0000308 return getSectionName(sec, Result);
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000309}
310
Michael J. Spencer25b15772011-06-25 17:55:23 +0000311error_code COFFObjectFile::getSectionAddress(DataRefImpl Sec,
312 uint64_t &Result) const {
313 const coff_section *sec = toSec(Sec);
314 Result = sec->VirtualAddress;
315 return object_error::success;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000316}
317
Michael J. Spencer25b15772011-06-25 17:55:23 +0000318error_code COFFObjectFile::getSectionSize(DataRefImpl Sec,
319 uint64_t &Result) const {
320 const coff_section *sec = toSec(Sec);
321 Result = sec->SizeOfRawData;
322 return object_error::success;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000323}
324
Michael J. Spencer25b15772011-06-25 17:55:23 +0000325error_code COFFObjectFile::getSectionContents(DataRefImpl Sec,
326 StringRef &Result) const {
327 const coff_section *sec = toSec(Sec);
Michael J. Spencer1f6e3f92012-03-19 20:27:37 +0000328 ArrayRef<uint8_t> Res;
329 error_code EC = getSectionContents(sec, Res);
330 Result = StringRef(reinterpret_cast<const char*>(Res.data()), Res.size());
331 return EC;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000332}
333
Michael J. Spencere2f2f072011-10-10 21:55:43 +0000334error_code COFFObjectFile::getSectionAlignment(DataRefImpl Sec,
335 uint64_t &Res) const {
336 const coff_section *sec = toSec(Sec);
337 if (!sec)
338 return object_error::parse_failed;
339 Res = uint64_t(1) << (((sec->Characteristics & 0x00F00000) >> 20) - 1);
340 return object_error::success;
341}
342
Michael J. Spencer25b15772011-06-25 17:55:23 +0000343error_code COFFObjectFile::isSectionText(DataRefImpl Sec,
344 bool &Result) const {
345 const coff_section *sec = toSec(Sec);
346 Result = sec->Characteristics & COFF::IMAGE_SCN_CNT_CODE;
347 return object_error::success;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000348}
349
Michael J. Spencer13afc5e2011-09-28 20:57:30 +0000350error_code COFFObjectFile::isSectionData(DataRefImpl Sec,
351 bool &Result) const {
352 const coff_section *sec = toSec(Sec);
353 Result = sec->Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA;
354 return object_error::success;
355}
356
357error_code COFFObjectFile::isSectionBSS(DataRefImpl Sec,
358 bool &Result) const {
359 const coff_section *sec = toSec(Sec);
360 Result = sec->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA;
361 return object_error::success;
362}
363
Preston Gurdc68dda82012-04-12 20:13:57 +0000364error_code COFFObjectFile::isSectionRequiredForExecution(DataRefImpl Sec,
365 bool &Result) const {
366 // FIXME: Unimplemented
367 Result = true;
368 return object_error::success;
369}
370
371error_code COFFObjectFile::isSectionVirtual(DataRefImpl Sec,
372 bool &Result) const {
373 const coff_section *sec = toSec(Sec);
374 Result = sec->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA;
375 return object_error::success;
376}
377
378error_code COFFObjectFile::isSectionZeroInit(DataRefImpl Sec,
379 bool &Result) const {
Andrew Kaylor30b20eb2012-10-10 01:45:52 +0000380 // FIXME: Unimplemented.
Preston Gurdc68dda82012-04-12 20:13:57 +0000381 Result = false;
382 return object_error::success;
383}
384
Andrew Kaylor3a129c82012-10-10 01:41:33 +0000385error_code COFFObjectFile::isSectionReadOnlyData(DataRefImpl Sec,
386 bool &Result) const {
387 // FIXME: Unimplemented.
388 Result = false;
389 return object_error::success;
390}
391
Benjamin Kramer07ea23a2011-07-15 18:39:21 +0000392error_code COFFObjectFile::sectionContainsSymbol(DataRefImpl Sec,
393 DataRefImpl Symb,
394 bool &Result) const {
Michael J. Spencerbff6f862011-10-13 20:36:54 +0000395 const coff_section *sec = toSec(Sec);
396 const coff_symbol *symb = toSymb(Symb);
Daniel Dunbara483fc82011-11-28 22:19:32 +0000397 const coff_section *symb_sec = 0;
Michael J. Spencerbff6f862011-10-13 20:36:54 +0000398 if (error_code ec = getSection(symb->SectionNumber, symb_sec)) return ec;
399 if (symb_sec == sec)
400 Result = true;
401 else
402 Result = false;
Benjamin Kramer07ea23a2011-07-15 18:39:21 +0000403 return object_error::success;
404}
405
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000406relocation_iterator COFFObjectFile::getSectionRelBegin(DataRefImpl Sec) const {
407 const coff_section *sec = toSec(Sec);
408 DataRefImpl ret;
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000409 if (sec->NumberOfRelocations == 0)
410 ret.p = 0;
411 else
412 ret.p = reinterpret_cast<uintptr_t>(base() + sec->PointerToRelocations);
413
414 return relocation_iterator(RelocationRef(ret, this));
415}
416
417relocation_iterator COFFObjectFile::getSectionRelEnd(DataRefImpl Sec) const {
418 const coff_section *sec = toSec(Sec);
419 DataRefImpl ret;
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000420 if (sec->NumberOfRelocations == 0)
421 ret.p = 0;
422 else
423 ret.p = reinterpret_cast<uintptr_t>(
424 reinterpret_cast<const coff_relocation*>(
425 base() + sec->PointerToRelocations)
426 + sec->NumberOfRelocations);
427
428 return relocation_iterator(RelocationRef(ret, this));
429}
430
Michael J. Spencer001c9202011-06-25 17:54:50 +0000431COFFObjectFile::COFFObjectFile(MemoryBuffer *Object, error_code &ec)
David Meyer6f9489a2012-03-09 20:41:57 +0000432 : ObjectFile(Binary::ID_COFF, Object, ec)
Michael J. Spencer7151ddd2011-11-08 23:34:07 +0000433 , Header(0)
434 , SectionTable(0)
435 , SymbolTable(0)
436 , StringTable(0)
437 , StringTableSize(0) {
Michael J. Spencer25b15772011-06-25 17:55:23 +0000438 // Check that we at least have enough room for a header.
439 if (!checkSize(Data, ec, sizeof(coff_file_header))) return;
Eric Christopher539d8d82011-04-03 22:53:19 +0000440
Michael J. Spencer25b15772011-06-25 17:55:23 +0000441 // The actual starting location of the COFF header in the file. This can be
442 // non-zero in PE/COFF files.
443 uint64_t HeaderStart = 0;
Eric Christopher539d8d82011-04-03 22:53:19 +0000444
Michael J. Spencer25b15772011-06-25 17:55:23 +0000445 // Check if this is a PE/COFF file.
Michael J. Spencer001c9202011-06-25 17:54:50 +0000446 if (base()[0] == 0x4d && base()[1] == 0x5a) {
Eric Christopher539d8d82011-04-03 22:53:19 +0000447 // PE/COFF, seek through MS-DOS compatibility stub and 4-byte
448 // PE signature to find 'normal' COFF header.
Michael J. Spencer25b15772011-06-25 17:55:23 +0000449 if (!checkSize(Data, ec, 0x3c + 8)) return;
Michael J. Spencer7151ddd2011-11-08 23:34:07 +0000450 HeaderStart = *reinterpret_cast<const ulittle16_t *>(base() + 0x3c);
Michael J. Spencer25b15772011-06-25 17:55:23 +0000451 // Check the PE header. ("PE\0\0")
Benjamin Kramer3209a032011-07-05 20:28:00 +0000452 if (std::memcmp(base() + HeaderStart, "PE\0\0", 4) != 0) {
Michael J. Spencer25b15772011-06-25 17:55:23 +0000453 ec = object_error::parse_failed;
454 return;
455 }
456 HeaderStart += 4; // Skip the PE Header.
Eric Christopher539d8d82011-04-03 22:53:19 +0000457 }
458
Michael J. Spencer25b15772011-06-25 17:55:23 +0000459 Header = reinterpret_cast<const coff_file_header *>(base() + HeaderStart);
460 if (!checkAddr(Data, ec, uintptr_t(Header), sizeof(coff_file_header)))
461 return;
Benjamin Kramer0fcab072011-09-08 20:52:17 +0000462
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000463 SectionTable =
Michael J. Spencer001c9202011-06-25 17:54:50 +0000464 reinterpret_cast<const coff_section *>( base()
Michael J. Spencer25b15772011-06-25 17:55:23 +0000465 + HeaderStart
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000466 + sizeof(coff_file_header)
467 + Header->SizeOfOptionalHeader);
Michael J. Spencer25b15772011-06-25 17:55:23 +0000468 if (!checkAddr(Data, ec, uintptr_t(SectionTable),
469 Header->NumberOfSections * sizeof(coff_section)))
470 return;
471
Michael J. Spencer7151ddd2011-11-08 23:34:07 +0000472 if (Header->PointerToSymbolTable != 0) {
473 SymbolTable =
474 reinterpret_cast<const coff_symbol *>(base()
475 + Header->PointerToSymbolTable);
476 if (!checkAddr(Data, ec, uintptr_t(SymbolTable),
477 Header->NumberOfSymbols * sizeof(coff_symbol)))
478 return;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000479
Michael J. Spencer7151ddd2011-11-08 23:34:07 +0000480 // Find string table.
481 StringTable = reinterpret_cast<const char *>(base())
482 + Header->PointerToSymbolTable
483 + Header->NumberOfSymbols * sizeof(coff_symbol);
484 if (!checkAddr(Data, ec, uintptr_t(StringTable), sizeof(ulittle32_t)))
485 return;
Michael J. Spencer25b15772011-06-25 17:55:23 +0000486
Michael J. Spencer7151ddd2011-11-08 23:34:07 +0000487 StringTableSize = *reinterpret_cast<const ulittle32_t *>(StringTable);
488 if (!checkAddr(Data, ec, uintptr_t(StringTable), StringTableSize))
489 return;
490 // Check that the string table is null terminated if has any in it.
491 if (StringTableSize < 4
492 || (StringTableSize > 4 && StringTable[StringTableSize - 1] != 0)) {
493 ec = object_error::parse_failed;
494 return;
495 }
Michael J. Spencer25b15772011-06-25 17:55:23 +0000496 }
Benjamin Kramer0fcab072011-09-08 20:52:17 +0000497
Michael J. Spencer25b15772011-06-25 17:55:23 +0000498 ec = object_error::success;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000499}
500
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000501symbol_iterator COFFObjectFile::begin_symbols() const {
Michael J. Spencer7acdb4d2011-01-21 02:27:02 +0000502 DataRefImpl ret;
503 ret.p = reinterpret_cast<intptr_t>(SymbolTable);
504 return symbol_iterator(SymbolRef(ret, this));
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000505}
506
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000507symbol_iterator COFFObjectFile::end_symbols() const {
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000508 // The symbol table ends where the string table begins.
Michael J. Spencer7acdb4d2011-01-21 02:27:02 +0000509 DataRefImpl ret;
510 ret.p = reinterpret_cast<intptr_t>(StringTable);
511 return symbol_iterator(SymbolRef(ret, this));
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000512}
513
Michael J. Spencerdfa18962012-02-28 00:40:37 +0000514symbol_iterator COFFObjectFile::begin_dynamic_symbols() const {
515 // TODO: implement
516 report_fatal_error("Dynamic symbols unimplemented in COFFObjectFile");
517}
518
519symbol_iterator COFFObjectFile::end_dynamic_symbols() const {
520 // TODO: implement
521 report_fatal_error("Dynamic symbols unimplemented in COFFObjectFile");
522}
523
David Meyer5c2b4ea2012-03-01 01:36:50 +0000524library_iterator COFFObjectFile::begin_libraries_needed() const {
525 // TODO: implement
526 report_fatal_error("Libraries needed unimplemented in COFFObjectFile");
527}
528
529library_iterator COFFObjectFile::end_libraries_needed() const {
530 // TODO: implement
531 report_fatal_error("Libraries needed unimplemented in COFFObjectFile");
532}
533
David Meyer97f77872012-03-01 22:19:54 +0000534StringRef COFFObjectFile::getLoadName() const {
535 // COFF does not have this field.
536 return "";
537}
538
539
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000540section_iterator COFFObjectFile::begin_sections() const {
Michael J. Spencer7acdb4d2011-01-21 02:27:02 +0000541 DataRefImpl ret;
542 ret.p = reinterpret_cast<intptr_t>(SectionTable);
543 return section_iterator(SectionRef(ret, this));
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000544}
545
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000546section_iterator COFFObjectFile::end_sections() const {
Michael J. Spencer7acdb4d2011-01-21 02:27:02 +0000547 DataRefImpl ret;
548 ret.p = reinterpret_cast<intptr_t>(SectionTable + Header->NumberOfSections);
549 return section_iterator(SectionRef(ret, this));
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000550}
551
552uint8_t COFFObjectFile::getBytesInAddress() const {
Michael J. Spencer7acdb4d2011-01-21 02:27:02 +0000553 return getArch() == Triple::x86_64 ? 8 : 4;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000554}
555
556StringRef COFFObjectFile::getFileFormatName() const {
557 switch(Header->Machine) {
558 case COFF::IMAGE_FILE_MACHINE_I386:
559 return "COFF-i386";
560 case COFF::IMAGE_FILE_MACHINE_AMD64:
561 return "COFF-x86-64";
562 default:
563 return "COFF-<unknown arch>";
564 }
565}
566
567unsigned COFFObjectFile::getArch() const {
568 switch(Header->Machine) {
569 case COFF::IMAGE_FILE_MACHINE_I386:
570 return Triple::x86;
571 case COFF::IMAGE_FILE_MACHINE_AMD64:
572 return Triple::x86_64;
573 default:
574 return Triple::UnknownArch;
575 }
576}
577
Michael J. Spencer0e752cb2011-10-17 23:53:56 +0000578error_code COFFObjectFile::getHeader(const coff_file_header *&Res) const {
579 Res = Header;
580 return object_error::success;
581}
582
Michael J. Spencer25b15772011-06-25 17:55:23 +0000583error_code COFFObjectFile::getSection(int32_t index,
584 const coff_section *&Result) const {
585 // Check for special index values.
586 if (index == COFF::IMAGE_SYM_UNDEFINED ||
587 index == COFF::IMAGE_SYM_ABSOLUTE ||
588 index == COFF::IMAGE_SYM_DEBUG)
589 Result = NULL;
590 else if (index > 0 && index <= Header->NumberOfSections)
591 // We already verified the section table data, so no need to check again.
592 Result = SectionTable + (index - 1);
593 else
594 return object_error::parse_failed;
595 return object_error::success;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000596}
597
Michael J. Spencer25b15772011-06-25 17:55:23 +0000598error_code COFFObjectFile::getString(uint32_t offset,
599 StringRef &Result) const {
600 if (StringTableSize <= 4)
601 // Tried to get a string from an empty string table.
602 return object_error::parse_failed;
603 if (offset >= StringTableSize)
604 return object_error::unexpected_eof;
605 Result = StringRef(StringTable + offset);
606 return object_error::success;
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000607}
608
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000609error_code COFFObjectFile::getSymbol(uint32_t index,
610 const coff_symbol *&Result) const {
Michael J. Spencer7c246652011-10-18 19:51:36 +0000611 if (index < Header->NumberOfSymbols)
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000612 Result = SymbolTable + index;
613 else
614 return object_error::parse_failed;
615 return object_error::success;
616}
617
Michael J. Spencer0e752cb2011-10-17 23:53:56 +0000618error_code COFFObjectFile::getSymbolName(const coff_symbol *symbol,
619 StringRef &Res) const {
620 // Check for string table entry. First 4 bytes are 0.
621 if (symbol->Name.Offset.Zeroes == 0) {
622 uint32_t Offset = symbol->Name.Offset.Offset;
623 if (error_code ec = getString(Offset, Res))
624 return ec;
625 return object_error::success;
626 }
627
628 if (symbol->Name.ShortName[7] == 0)
629 // Null terminated, let ::strlen figure out the length.
630 Res = StringRef(symbol->Name.ShortName);
631 else
632 // Not null terminated, use all 8 bytes.
633 Res = StringRef(symbol->Name.ShortName, 8);
634 return object_error::success;
635}
636
Marshall Clowd4d03e02012-06-15 01:08:25 +0000637ArrayRef<uint8_t> COFFObjectFile::getSymbolAuxData(
638 const coff_symbol *symbol) const {
639 const uint8_t *aux = NULL;
640
641 if ( symbol->NumberOfAuxSymbols > 0 ) {
642 // AUX data comes immediately after the symbol in COFF
643 aux = reinterpret_cast<const uint8_t *>(symbol + 1);
644# ifndef NDEBUG
645 // Verify that the aux symbol points to a valid entry in the symbol table.
646 uintptr_t offset = uintptr_t(aux) - uintptr_t(base());
647 if (offset < Header->PointerToSymbolTable
648 || offset >= Header->PointerToSymbolTable
649 + (Header->NumberOfSymbols * sizeof(coff_symbol)))
650 report_fatal_error("Aux Symbol data was outside of symbol table.");
651
652 assert((offset - Header->PointerToSymbolTable) % sizeof(coff_symbol)
653 == 0 && "Aux Symbol data did not point to the beginning of a symbol");
Marshall Clowd4d03e02012-06-15 01:08:25 +0000654# endif
Marshall Clow45aad162012-06-15 01:15:47 +0000655 }
Marshall Clowd4d03e02012-06-15 01:08:25 +0000656 return ArrayRef<uint8_t>(aux, symbol->NumberOfAuxSymbols * sizeof(coff_symbol));
657}
658
Michael J. Spencerb35a8962012-03-19 20:27:15 +0000659error_code COFFObjectFile::getSectionName(const coff_section *Sec,
660 StringRef &Res) const {
661 StringRef Name;
662 if (Sec->Name[7] == 0)
663 // Null terminated, let ::strlen figure out the length.
664 Name = Sec->Name;
665 else
666 // Not null terminated, use all 8 bytes.
667 Name = StringRef(Sec->Name, 8);
668
669 // Check for string table entry. First byte is '/'.
670 if (Name[0] == '/') {
671 uint32_t Offset;
672 if (Name.substr(1).getAsInteger(10, Offset))
673 return object_error::parse_failed;
674 if (error_code ec = getString(Offset, Name))
675 return ec;
676 }
677
678 Res = Name;
679 return object_error::success;
680}
681
Michael J. Spencer1f6e3f92012-03-19 20:27:37 +0000682error_code COFFObjectFile::getSectionContents(const coff_section *Sec,
683 ArrayRef<uint8_t> &Res) const {
684 // The only thing that we need to verify is that the contents is contained
685 // within the file bounds. We don't need to make sure it doesn't cover other
686 // data, as there's nothing that says that is not allowed.
687 uintptr_t ConStart = uintptr_t(base()) + Sec->PointerToRawData;
688 uintptr_t ConEnd = ConStart + Sec->SizeOfRawData;
689 if (ConEnd > uintptr_t(Data->getBufferEnd()))
690 return object_error::parse_failed;
691 Res = ArrayRef<uint8_t>(reinterpret_cast<const unsigned char*>(ConStart),
692 Sec->SizeOfRawData);
693 return object_error::success;
694}
695
Benjamin Kramer0fcab072011-09-08 20:52:17 +0000696const coff_relocation *COFFObjectFile::toRel(DataRefImpl Rel) const {
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000697 return reinterpret_cast<const coff_relocation*>(Rel.p);
Benjamin Kramer0fcab072011-09-08 20:52:17 +0000698}
699error_code COFFObjectFile::getRelocationNext(DataRefImpl Rel,
700 RelocationRef &Res) const {
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000701 Rel.p = reinterpret_cast<uintptr_t>(
702 reinterpret_cast<const coff_relocation*>(Rel.p) + 1);
Benjamin Kramer0fcab072011-09-08 20:52:17 +0000703 Res = RelocationRef(Rel, this);
704 return object_error::success;
705}
706error_code COFFObjectFile::getRelocationAddress(DataRefImpl Rel,
707 uint64_t &Res) const {
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000708 Res = toRel(Rel)->VirtualAddress;
Benjamin Kramer0fcab072011-09-08 20:52:17 +0000709 return object_error::success;
710}
Danil Malyshevb0436a72011-11-29 17:40:10 +0000711error_code COFFObjectFile::getRelocationOffset(DataRefImpl Rel,
712 uint64_t &Res) const {
713 Res = toRel(Rel)->VirtualAddress;
714 return object_error::success;
715}
Benjamin Kramer0fcab072011-09-08 20:52:17 +0000716error_code COFFObjectFile::getRelocationSymbol(DataRefImpl Rel,
717 SymbolRef &Res) const {
718 const coff_relocation* R = toRel(Rel);
719 DataRefImpl Symb;
720 Symb.p = reinterpret_cast<uintptr_t>(SymbolTable + R->SymbolTableIndex);
721 Res = SymbolRef(Symb, this);
722 return object_error::success;
723}
724error_code COFFObjectFile::getRelocationType(DataRefImpl Rel,
Owen Anderson9472b8d2011-10-26 17:08:49 +0000725 uint64_t &Res) const {
Benjamin Kramer0fcab072011-09-08 20:52:17 +0000726 const coff_relocation* R = toRel(Rel);
727 Res = R->Type;
728 return object_error::success;
729}
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000730
Marshall Clowd4d03e02012-06-15 01:08:25 +0000731const coff_section *COFFObjectFile::getCOFFSection(section_iterator &It) const {
732 return toSec(It->getRawDataRefImpl());
733}
734
735const coff_symbol *COFFObjectFile::getCOFFSymbol(symbol_iterator &It) const {
736 return toSymb(It->getRawDataRefImpl());
737}
738
Marshall Clow9ac0f1d2012-06-18 19:47:16 +0000739const coff_relocation *COFFObjectFile::getCOFFRelocation(
740 relocation_iterator &It) const {
741 return toRel(It->getRawDataRefImpl());
742}
743
Marshall Clowd4d03e02012-06-15 01:08:25 +0000744
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000745#define LLVM_COFF_SWITCH_RELOC_TYPE_NAME(enum) \
746 case COFF::enum: res = #enum; break;
747
748error_code COFFObjectFile::getRelocationTypeName(DataRefImpl Rel,
749 SmallVectorImpl<char> &Result) const {
750 const coff_relocation *reloc = toRel(Rel);
751 StringRef res;
752 switch (Header->Machine) {
753 case COFF::IMAGE_FILE_MACHINE_AMD64:
754 switch (reloc->Type) {
755 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ABSOLUTE);
756 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR64);
757 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32);
758 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32NB);
759 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32);
760 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_1);
761 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_2);
762 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_3);
763 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_4);
764 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_5);
765 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECTION);
766 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL);
767 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL7);
768 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_TOKEN);
769 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SREL32);
770 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_PAIR);
771 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SSPAN32);
772 default:
773 res = "Unknown";
774 }
775 break;
776 case COFF::IMAGE_FILE_MACHINE_I386:
777 switch (reloc->Type) {
778 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_ABSOLUTE);
779 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR16);
780 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL16);
781 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32);
782 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32NB);
783 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SEG12);
784 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECTION);
785 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL);
786 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_TOKEN);
787 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL7);
788 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL32);
789 default:
790 res = "Unknown";
791 }
792 break;
793 default:
794 res = "Unknown";
795 }
796 Result.append(res.begin(), res.end());
797 return object_error::success;
798}
799
800#undef LLVM_COFF_SWITCH_RELOC_TYPE_NAME
801
Benjamin Kramer0fcab072011-09-08 20:52:17 +0000802error_code COFFObjectFile::getRelocationAdditionalInfo(DataRefImpl Rel,
803 int64_t &Res) const {
804 Res = 0;
805 return object_error::success;
806}
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000807error_code COFFObjectFile::getRelocationValueString(DataRefImpl Rel,
808 SmallVectorImpl<char> &Result) const {
809 const coff_relocation *reloc = toRel(Rel);
NAKAMURA Takumi48f248a2011-10-08 11:22:53 +0000810 const coff_symbol *symb = 0;
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000811 if (error_code ec = getSymbol(reloc->SymbolTableIndex, symb)) return ec;
812 DataRefImpl sym;
Michael J. Spencer4344b1e2011-10-07 19:25:32 +0000813 sym.p = reinterpret_cast<uintptr_t>(symb);
814 StringRef symname;
815 if (error_code ec = getSymbolName(sym, symname)) return ec;
816 Result.append(symname.begin(), symname.end());
817 return object_error::success;
Benjamin Kramer0fcab072011-09-08 20:52:17 +0000818}
Benjamin Kramer0fcab072011-09-08 20:52:17 +0000819
David Meyer5c2b4ea2012-03-01 01:36:50 +0000820error_code COFFObjectFile::getLibraryNext(DataRefImpl LibData,
821 LibraryRef &Result) const {
822 report_fatal_error("getLibraryNext not implemented in COFFObjectFile");
823}
824
825error_code COFFObjectFile::getLibraryPath(DataRefImpl LibData,
826 StringRef &Result) const {
827 report_fatal_error("getLibraryPath not implemented in COFFObjectFile");
828}
829
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000830namespace llvm {
831
832 ObjectFile *ObjectFile::createCOFFObjectFile(MemoryBuffer *Object) {
Michael J. Spencer001c9202011-06-25 17:54:50 +0000833 error_code ec;
834 return new COFFObjectFile(Object, ec);
Michael J. Spencera1ef8ef2011-01-20 06:38:34 +0000835 }
836
837} // end namespace llvm