1 //===- COFFObjectFile.cpp - 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 #include "llvm/Object/COFF.h"
15 #include "llvm/ADT/SmallString.h"
16 #include "llvm/ADT/StringSwitch.h"
17 #include "llvm/ADT/Triple.h"
20 using namespace object;
23 using support::ulittle8_t;
24 using support::ulittle16_t;
25 using support::ulittle32_t;
26 using support::little16_t;
30 // Returns false if size is greater than the buffer size. And sets ec.
31 bool checkSize(const MemoryBuffer *m, error_code &ec, uint64_t size) {
32 if (m->getBufferSize() < size) {
33 ec = object_error::unexpected_eof;
39 // Returns false if any bytes in [addr, addr + size) fall outsize of m.
40 bool checkAddr(const MemoryBuffer *m,
44 if (addr + size < addr ||
46 addr + size > uintptr_t(m->getBufferEnd())) {
47 ec = object_error::unexpected_eof;
54 const coff_symbol *COFFObjectFile::toSymb(DataRefImpl Symb) const {
55 const coff_symbol *addr = reinterpret_cast<const coff_symbol*>(Symb.p);
58 // Verify that the symbol points to a valid entry in the symbol table.
59 uintptr_t offset = uintptr_t(addr) - uintptr_t(base());
60 if (offset < Header->PointerToSymbolTable
61 || offset >= Header->PointerToSymbolTable
62 + (Header->NumberOfSymbols * sizeof(coff_symbol)))
63 report_fatal_error("Symbol was outside of symbol table.");
65 assert((offset - Header->PointerToSymbolTable) % sizeof(coff_symbol)
66 == 0 && "Symbol did not point to the beginning of a symbol");
72 const coff_section *COFFObjectFile::toSec(DataRefImpl Sec) const {
73 const coff_section *addr = reinterpret_cast<const coff_section*>(Sec.p);
76 // Verify that the section points to a valid entry in the section table.
77 if (addr < SectionTable
78 || addr >= (SectionTable + Header->NumberOfSections))
79 report_fatal_error("Section was outside of section table.");
81 uintptr_t offset = uintptr_t(addr) - uintptr_t(SectionTable);
82 assert(offset % sizeof(coff_section) == 0 &&
83 "Section did not point to the beginning of a section");
89 error_code COFFObjectFile::getSymbolNext(DataRefImpl Symb,
90 SymbolRef &Result) const {
91 const coff_symbol *symb = toSymb(Symb);
92 symb += 1 + symb->NumberOfAuxSymbols;
93 Symb.p = reinterpret_cast<uintptr_t>(symb);
94 Result = SymbolRef(Symb, this);
95 return object_error::success;
98 error_code COFFObjectFile::getSymbolName(DataRefImpl Symb,
99 StringRef &Result) const {
100 const coff_symbol *symb = toSymb(Symb);
101 // Check for string table entry. First 4 bytes are 0.
102 if (symb->Name.Offset.Zeroes == 0) {
103 uint32_t Offset = symb->Name.Offset.Offset;
104 if (error_code ec = getString(Offset, Result))
106 return object_error::success;
109 if (symb->Name.ShortName[7] == 0)
110 // Null terminated, let ::strlen figure out the length.
111 Result = StringRef(symb->Name.ShortName);
113 // Not null terminated, use all 8 bytes.
114 Result = StringRef(symb->Name.ShortName, 8);
115 return object_error::success;
118 error_code COFFObjectFile::getSymbolOffset(DataRefImpl Symb,
119 uint64_t &Result) const {
120 const coff_symbol *symb = toSymb(Symb);
121 const coff_section *Section = NULL;
122 if (error_code ec = getSection(symb->SectionNumber, Section))
125 if (error_code ec = getSymbolNMTypeChar(Symb, Type))
127 if (Type == 'U' || Type == 'w')
128 Result = UnknownAddressOrSize;
130 Result = Section->VirtualAddress + symb->Value;
132 Result = symb->Value;
133 return object_error::success;
136 error_code COFFObjectFile::getSymbolAddress(DataRefImpl Symb,
137 uint64_t &Result) const {
138 const coff_symbol *symb = toSymb(Symb);
139 const coff_section *Section = NULL;
140 if (error_code ec = getSection(symb->SectionNumber, Section))
143 if (error_code ec = getSymbolNMTypeChar(Symb, Type))
145 if (Type == 'U' || Type == 'w')
146 Result = UnknownAddressOrSize;
148 Result = reinterpret_cast<uintptr_t>(base() +
149 Section->PointerToRawData +
152 Result = reinterpret_cast<uintptr_t>(base() + symb->Value);
153 return object_error::success;
156 error_code COFFObjectFile::getSymbolType(DataRefImpl Symb,
157 SymbolRef::SymbolType &Result) const {
158 const coff_symbol *symb = toSymb(Symb);
159 Result = SymbolRef::ST_Other;
160 if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
161 symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED) {
162 Result = SymbolRef::ST_External;
164 if (symb->Type.ComplexType == COFF::IMAGE_SYM_DTYPE_FUNCTION) {
165 Result = SymbolRef::ST_Function;
168 if (error_code ec = getSymbolNMTypeChar(Symb, Type))
170 if (Type == 'r' || Type == 'R') {
171 Result = SymbolRef::ST_Data;
175 return object_error::success;
178 error_code COFFObjectFile::isSymbolGlobal(DataRefImpl Symb,
179 bool &Result) const {
180 const coff_symbol *symb = toSymb(Symb);
181 Result = (symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL);
182 return object_error::success;
185 error_code COFFObjectFile::getSymbolSize(DataRefImpl Symb,
186 uint64_t &Result) const {
187 // FIXME: Return the correct size. This requires looking at all the symbols
188 // in the same section as this symbol, and looking for either the next
189 // symbol, or the end of the section.
190 const coff_symbol *symb = toSymb(Symb);
191 const coff_section *Section = NULL;
192 if (error_code ec = getSection(symb->SectionNumber, Section))
195 if (error_code ec = getSymbolNMTypeChar(Symb, Type))
197 if (Type == 'U' || Type == 'w')
198 Result = UnknownAddressOrSize;
200 Result = Section->SizeOfRawData - symb->Value;
203 return object_error::success;
206 error_code COFFObjectFile::getSymbolNMTypeChar(DataRefImpl Symb,
207 char &Result) const {
208 const coff_symbol *symb = toSymb(Symb);
210 if (error_code ec = getSymbolName(Symb, name))
212 char ret = StringSwitch<char>(name)
213 .StartsWith(".debug", 'N')
214 .StartsWith(".sxdata", 'N')
219 return object_error::success;
222 uint32_t Characteristics = 0;
223 if (symb->SectionNumber > 0) {
224 const coff_section *Section = NULL;
225 if (error_code ec = getSection(symb->SectionNumber, Section))
227 Characteristics = Section->Characteristics;
230 switch (symb->SectionNumber) {
231 case COFF::IMAGE_SYM_UNDEFINED:
232 // Check storage classes.
233 if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL) {
235 return object_error::success; // Don't do ::toupper.
239 case COFF::IMAGE_SYM_ABSOLUTE:
242 case COFF::IMAGE_SYM_DEBUG:
246 // Check section type.
247 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
249 else if ( Characteristics & COFF::IMAGE_SCN_MEM_READ
250 && ~Characteristics & COFF::IMAGE_SCN_MEM_WRITE) // Read only.
252 else if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
254 else if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
256 else if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
259 // Check for section symbol.
260 else if ( symb->StorageClass == COFF::IMAGE_SYM_CLASS_STATIC
265 if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL)
266 ret = ::toupper(ret);
269 return object_error::success;
272 error_code COFFObjectFile::isSymbolInternal(DataRefImpl Symb,
273 bool &Result) const {
275 return object_error::success;
278 error_code COFFObjectFile::getSectionNext(DataRefImpl Sec,
279 SectionRef &Result) const {
280 const coff_section *sec = toSec(Sec);
282 Sec.p = reinterpret_cast<uintptr_t>(sec);
283 Result = SectionRef(Sec, this);
284 return object_error::success;
287 error_code COFFObjectFile::getSectionName(DataRefImpl Sec,
288 StringRef &Result) const {
289 const coff_section *sec = toSec(Sec);
291 if (sec->Name[7] == 0)
292 // Null terminated, let ::strlen figure out the length.
295 // Not null terminated, use all 8 bytes.
296 name = StringRef(sec->Name, 8);
298 // Check for string table entry. First byte is '/'.
299 if (name[0] == '/') {
301 name.substr(1).getAsInteger(10, Offset);
302 if (error_code ec = getString(Offset, name))
307 return object_error::success;
310 error_code COFFObjectFile::getSectionAddress(DataRefImpl Sec,
311 uint64_t &Result) const {
312 const coff_section *sec = toSec(Sec);
313 Result = sec->VirtualAddress;
314 return object_error::success;
317 error_code COFFObjectFile::getSectionSize(DataRefImpl Sec,
318 uint64_t &Result) const {
319 const coff_section *sec = toSec(Sec);
320 Result = sec->SizeOfRawData;
321 return object_error::success;
324 error_code COFFObjectFile::getSectionContents(DataRefImpl Sec,
325 StringRef &Result) const {
326 const coff_section *sec = toSec(Sec);
327 // The only thing that we need to verify is that the contents is contained
328 // within the file bounds. We don't need to make sure it doesn't cover other
329 // data, as there's nothing that says that is not allowed.
330 uintptr_t con_start = uintptr_t(base()) + sec->PointerToRawData;
331 uintptr_t con_end = con_start + sec->SizeOfRawData;
332 if (con_end >= uintptr_t(Data->getBufferEnd()))
333 return object_error::parse_failed;
334 Result = StringRef(reinterpret_cast<const char*>(con_start),
336 return object_error::success;
339 error_code COFFObjectFile::getSectionAlignment(DataRefImpl Sec,
340 uint64_t &Res) const {
341 const coff_section *sec = toSec(Sec);
343 return object_error::parse_failed;
344 Res = uint64_t(1) << (((sec->Characteristics & 0x00F00000) >> 20) - 1);
345 return object_error::success;
348 error_code COFFObjectFile::isSectionText(DataRefImpl Sec,
349 bool &Result) const {
350 const coff_section *sec = toSec(Sec);
351 Result = sec->Characteristics & COFF::IMAGE_SCN_CNT_CODE;
352 return object_error::success;
355 error_code COFFObjectFile::isSectionData(DataRefImpl Sec,
356 bool &Result) const {
357 const coff_section *sec = toSec(Sec);
358 Result = sec->Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA;
359 return object_error::success;
362 error_code COFFObjectFile::isSectionBSS(DataRefImpl Sec,
363 bool &Result) const {
364 const coff_section *sec = toSec(Sec);
365 Result = sec->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA;
366 return object_error::success;
369 error_code COFFObjectFile::sectionContainsSymbol(DataRefImpl Sec,
371 bool &Result) const {
372 // FIXME: Unimplemented.
374 return object_error::success;
377 relocation_iterator COFFObjectFile::getSectionRelBegin(DataRefImpl Sec) const {
378 const coff_section *sec = toSec(Sec);
380 std::memset(&ret, 0, sizeof(ret));
381 if (sec->NumberOfRelocations == 0)
384 ret.p = reinterpret_cast<uintptr_t>(base() + sec->PointerToRelocations);
386 return relocation_iterator(RelocationRef(ret, this));
389 relocation_iterator COFFObjectFile::getSectionRelEnd(DataRefImpl Sec) const {
390 const coff_section *sec = toSec(Sec);
392 std::memset(&ret, 0, sizeof(ret));
393 if (sec->NumberOfRelocations == 0)
396 ret.p = reinterpret_cast<uintptr_t>(
397 reinterpret_cast<const coff_relocation*>(
398 base() + sec->PointerToRelocations)
399 + sec->NumberOfRelocations);
401 return relocation_iterator(RelocationRef(ret, this));
404 COFFObjectFile::COFFObjectFile(MemoryBuffer *Object, error_code &ec)
405 : ObjectFile(Binary::isCOFF, Object, ec) {
406 // Check that we at least have enough room for a header.
407 if (!checkSize(Data, ec, sizeof(coff_file_header))) return;
409 // The actual starting location of the COFF header in the file. This can be
410 // non-zero in PE/COFF files.
411 uint64_t HeaderStart = 0;
413 // Check if this is a PE/COFF file.
414 if (base()[0] == 0x4d && base()[1] == 0x5a) {
415 // PE/COFF, seek through MS-DOS compatibility stub and 4-byte
416 // PE signature to find 'normal' COFF header.
417 if (!checkSize(Data, ec, 0x3c + 8)) return;
418 HeaderStart += *reinterpret_cast<const ulittle32_t *>(base() + 0x3c);
419 // Check the PE header. ("PE\0\0")
420 if (std::memcmp(base() + HeaderStart, "PE\0\0", 4) != 0) {
421 ec = object_error::parse_failed;
424 HeaderStart += 4; // Skip the PE Header.
427 Header = reinterpret_cast<const coff_file_header *>(base() + HeaderStart);
428 if (!checkAddr(Data, ec, uintptr_t(Header), sizeof(coff_file_header)))
432 reinterpret_cast<const coff_section *>( base()
434 + sizeof(coff_file_header)
435 + Header->SizeOfOptionalHeader);
436 if (!checkAddr(Data, ec, uintptr_t(SectionTable),
437 Header->NumberOfSections * sizeof(coff_section)))
441 reinterpret_cast<const coff_symbol *>(base()
442 + Header->PointerToSymbolTable);
443 if (!checkAddr(Data, ec, uintptr_t(SymbolTable),
444 Header->NumberOfSymbols * sizeof(coff_symbol)))
447 // Find string table.
448 StringTable = reinterpret_cast<const char *>(base())
449 + Header->PointerToSymbolTable
450 + Header->NumberOfSymbols * sizeof(coff_symbol);
451 if (!checkAddr(Data, ec, uintptr_t(StringTable), sizeof(ulittle32_t)))
454 StringTableSize = *reinterpret_cast<const ulittle32_t *>(StringTable);
455 if (!checkAddr(Data, ec, uintptr_t(StringTable), StringTableSize))
457 // Check that the string table is null terminated if has any in it.
458 if (StringTableSize < 4
459 || (StringTableSize > 4 && StringTable[StringTableSize - 1] != 0)) {
460 ec = object_error::parse_failed;
464 ec = object_error::success;
467 symbol_iterator COFFObjectFile::begin_symbols() const {
469 std::memset(&ret, 0, sizeof(DataRefImpl));
470 ret.p = reinterpret_cast<intptr_t>(SymbolTable);
471 return symbol_iterator(SymbolRef(ret, this));
474 symbol_iterator COFFObjectFile::end_symbols() const {
475 // The symbol table ends where the string table begins.
477 std::memset(&ret, 0, sizeof(DataRefImpl));
478 ret.p = reinterpret_cast<intptr_t>(StringTable);
479 return symbol_iterator(SymbolRef(ret, this));
482 section_iterator COFFObjectFile::begin_sections() const {
484 std::memset(&ret, 0, sizeof(DataRefImpl));
485 ret.p = reinterpret_cast<intptr_t>(SectionTable);
486 return section_iterator(SectionRef(ret, this));
489 section_iterator COFFObjectFile::end_sections() const {
491 std::memset(&ret, 0, sizeof(DataRefImpl));
492 ret.p = reinterpret_cast<intptr_t>(SectionTable + Header->NumberOfSections);
493 return section_iterator(SectionRef(ret, this));
496 uint8_t COFFObjectFile::getBytesInAddress() const {
497 return getArch() == Triple::x86_64 ? 8 : 4;
500 StringRef COFFObjectFile::getFileFormatName() const {
501 switch(Header->Machine) {
502 case COFF::IMAGE_FILE_MACHINE_I386:
504 case COFF::IMAGE_FILE_MACHINE_AMD64:
505 return "COFF-x86-64";
507 return "COFF-<unknown arch>";
511 unsigned COFFObjectFile::getArch() const {
512 switch(Header->Machine) {
513 case COFF::IMAGE_FILE_MACHINE_I386:
515 case COFF::IMAGE_FILE_MACHINE_AMD64:
516 return Triple::x86_64;
518 return Triple::UnknownArch;
522 error_code COFFObjectFile::getSection(int32_t index,
523 const coff_section *&Result) const {
524 // Check for special index values.
525 if (index == COFF::IMAGE_SYM_UNDEFINED ||
526 index == COFF::IMAGE_SYM_ABSOLUTE ||
527 index == COFF::IMAGE_SYM_DEBUG)
529 else if (index > 0 && index <= Header->NumberOfSections)
530 // We already verified the section table data, so no need to check again.
531 Result = SectionTable + (index - 1);
533 return object_error::parse_failed;
534 return object_error::success;
537 error_code COFFObjectFile::getString(uint32_t offset,
538 StringRef &Result) const {
539 if (StringTableSize <= 4)
540 // Tried to get a string from an empty string table.
541 return object_error::parse_failed;
542 if (offset >= StringTableSize)
543 return object_error::unexpected_eof;
544 Result = StringRef(StringTable + offset);
545 return object_error::success;
548 error_code COFFObjectFile::getSymbol(uint32_t index,
549 const coff_symbol *&Result) const {
550 if (index > 0 && index < Header->NumberOfSymbols)
551 Result = SymbolTable + index;
553 return object_error::parse_failed;
554 return object_error::success;
557 const coff_relocation *COFFObjectFile::toRel(DataRefImpl Rel) const {
558 return reinterpret_cast<const coff_relocation*>(Rel.p);
560 error_code COFFObjectFile::getRelocationNext(DataRefImpl Rel,
561 RelocationRef &Res) const {
562 Rel.p = reinterpret_cast<uintptr_t>(
563 reinterpret_cast<const coff_relocation*>(Rel.p) + 1);
564 Res = RelocationRef(Rel, this);
565 return object_error::success;
567 error_code COFFObjectFile::getRelocationAddress(DataRefImpl Rel,
568 uint64_t &Res) const {
569 Res = toRel(Rel)->VirtualAddress;
570 return object_error::success;
572 error_code COFFObjectFile::getRelocationSymbol(DataRefImpl Rel,
573 SymbolRef &Res) const {
574 const coff_relocation* R = toRel(Rel);
576 Symb.p = reinterpret_cast<uintptr_t>(SymbolTable + R->SymbolTableIndex);
577 Res = SymbolRef(Symb, this);
578 return object_error::success;
580 error_code COFFObjectFile::getRelocationType(DataRefImpl Rel,
581 uint32_t &Res) const {
582 const coff_relocation* R = toRel(Rel);
584 return object_error::success;
587 #define LLVM_COFF_SWITCH_RELOC_TYPE_NAME(enum) \
588 case COFF::enum: res = #enum; break;
590 error_code COFFObjectFile::getRelocationTypeName(DataRefImpl Rel,
591 SmallVectorImpl<char> &Result) const {
592 const coff_relocation *reloc = toRel(Rel);
594 switch (Header->Machine) {
595 case COFF::IMAGE_FILE_MACHINE_AMD64:
596 switch (reloc->Type) {
597 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ABSOLUTE);
598 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR64);
599 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32);
600 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32NB);
601 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32);
602 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_1);
603 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_2);
604 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_3);
605 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_4);
606 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_5);
607 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECTION);
608 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL);
609 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL7);
610 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_TOKEN);
611 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SREL32);
612 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_PAIR);
613 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SSPAN32);
618 case COFF::IMAGE_FILE_MACHINE_I386:
619 switch (reloc->Type) {
620 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_ABSOLUTE);
621 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR16);
622 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL16);
623 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32);
624 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32NB);
625 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SEG12);
626 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECTION);
627 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL);
628 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_TOKEN);
629 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL7);
630 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL32);
638 Result.append(res.begin(), res.end());
639 return object_error::success;
642 #undef LLVM_COFF_SWITCH_RELOC_TYPE_NAME
644 error_code COFFObjectFile::getRelocationAdditionalInfo(DataRefImpl Rel,
645 int64_t &Res) const {
647 return object_error::success;
649 error_code COFFObjectFile::getRelocationValueString(DataRefImpl Rel,
650 SmallVectorImpl<char> &Result) const {
651 const coff_relocation *reloc = toRel(Rel);
652 const coff_symbol *symb = 0;
653 if (error_code ec = getSymbol(reloc->SymbolTableIndex, symb)) return ec;
655 ::memset(&sym, 0, sizeof(sym));
656 sym.p = reinterpret_cast<uintptr_t>(symb);
658 if (error_code ec = getSymbolName(sym, symname)) return ec;
659 Result.append(symname.begin(), symname.end());
660 return object_error::success;
665 ObjectFile *ObjectFile::createCOFFObjectFile(MemoryBuffer *Object) {
667 return new COFFObjectFile(Object, ec);
670 } // end namespace llvm