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/ADT/PointerUnion.h"
18 #include "llvm/Object/ObjectFile.h"
19 #include "llvm/Support/COFF.h"
20 #include "llvm/Support/Endian.h"
21 #include "llvm/Support/ErrorOr.h"
24 template <typename T> class ArrayRef;
27 class ImportDirectoryEntryRef;
28 class DelayImportDirectoryEntryRef;
29 class ExportDirectoryEntryRef;
30 class ImportedSymbolRef;
32 typedef content_iterator<ImportDirectoryEntryRef> import_directory_iterator;
33 typedef content_iterator<DelayImportDirectoryEntryRef>
34 delay_import_directory_iterator;
35 typedef content_iterator<ExportDirectoryEntryRef> export_directory_iterator;
36 typedef content_iterator<ImportedSymbolRef> imported_symbol_iterator;
37 typedef content_iterator<BaseRelocRef> base_reloc_iterator;
39 /// The DOS compatible header at the front of all PE/COFF executables.
42 support::ulittle16_t UsedBytesInTheLastPage;
43 support::ulittle16_t FileSizeInPages;
44 support::ulittle16_t NumberOfRelocationItems;
45 support::ulittle16_t HeaderSizeInParagraphs;
46 support::ulittle16_t MinimumExtraParagraphs;
47 support::ulittle16_t MaximumExtraParagraphs;
48 support::ulittle16_t InitialRelativeSS;
49 support::ulittle16_t InitialSP;
50 support::ulittle16_t Checksum;
51 support::ulittle16_t InitialIP;
52 support::ulittle16_t InitialRelativeCS;
53 support::ulittle16_t AddressOfRelocationTable;
54 support::ulittle16_t OverlayNumber;
55 support::ulittle16_t Reserved[4];
56 support::ulittle16_t OEMid;
57 support::ulittle16_t OEMinfo;
58 support::ulittle16_t Reserved2[10];
59 support::ulittle32_t AddressOfNewExeHeader;
62 struct coff_file_header {
63 support::ulittle16_t Machine;
64 support::ulittle16_t NumberOfSections;
65 support::ulittle32_t TimeDateStamp;
66 support::ulittle32_t PointerToSymbolTable;
67 support::ulittle32_t NumberOfSymbols;
68 support::ulittle16_t SizeOfOptionalHeader;
69 support::ulittle16_t Characteristics;
71 bool isImportLibrary() const { return NumberOfSections == 0xffff; }
74 struct coff_bigobj_file_header {
75 support::ulittle16_t Sig1;
76 support::ulittle16_t Sig2;
77 support::ulittle16_t Version;
78 support::ulittle16_t Machine;
79 support::ulittle32_t TimeDateStamp;
81 support::ulittle32_t unused1;
82 support::ulittle32_t unused2;
83 support::ulittle32_t unused3;
84 support::ulittle32_t unused4;
85 support::ulittle32_t NumberOfSections;
86 support::ulittle32_t PointerToSymbolTable;
87 support::ulittle32_t NumberOfSymbols;
90 /// The 32-bit PE header that follows the COFF header.
92 support::ulittle16_t Magic;
93 uint8_t MajorLinkerVersion;
94 uint8_t MinorLinkerVersion;
95 support::ulittle32_t SizeOfCode;
96 support::ulittle32_t SizeOfInitializedData;
97 support::ulittle32_t SizeOfUninitializedData;
98 support::ulittle32_t AddressOfEntryPoint;
99 support::ulittle32_t BaseOfCode;
100 support::ulittle32_t BaseOfData;
101 support::ulittle32_t ImageBase;
102 support::ulittle32_t SectionAlignment;
103 support::ulittle32_t FileAlignment;
104 support::ulittle16_t MajorOperatingSystemVersion;
105 support::ulittle16_t MinorOperatingSystemVersion;
106 support::ulittle16_t MajorImageVersion;
107 support::ulittle16_t MinorImageVersion;
108 support::ulittle16_t MajorSubsystemVersion;
109 support::ulittle16_t MinorSubsystemVersion;
110 support::ulittle32_t Win32VersionValue;
111 support::ulittle32_t SizeOfImage;
112 support::ulittle32_t SizeOfHeaders;
113 support::ulittle32_t CheckSum;
114 support::ulittle16_t Subsystem;
115 // FIXME: This should be DllCharacteristics.
116 support::ulittle16_t DLLCharacteristics;
117 support::ulittle32_t SizeOfStackReserve;
118 support::ulittle32_t SizeOfStackCommit;
119 support::ulittle32_t SizeOfHeapReserve;
120 support::ulittle32_t SizeOfHeapCommit;
121 support::ulittle32_t LoaderFlags;
122 // FIXME: This should be NumberOfRvaAndSizes.
123 support::ulittle32_t NumberOfRvaAndSize;
126 /// The 64-bit PE header that follows the COFF header.
127 struct pe32plus_header {
128 support::ulittle16_t Magic;
129 uint8_t MajorLinkerVersion;
130 uint8_t MinorLinkerVersion;
131 support::ulittle32_t SizeOfCode;
132 support::ulittle32_t SizeOfInitializedData;
133 support::ulittle32_t SizeOfUninitializedData;
134 support::ulittle32_t AddressOfEntryPoint;
135 support::ulittle32_t BaseOfCode;
136 support::ulittle64_t ImageBase;
137 support::ulittle32_t SectionAlignment;
138 support::ulittle32_t FileAlignment;
139 support::ulittle16_t MajorOperatingSystemVersion;
140 support::ulittle16_t MinorOperatingSystemVersion;
141 support::ulittle16_t MajorImageVersion;
142 support::ulittle16_t MinorImageVersion;
143 support::ulittle16_t MajorSubsystemVersion;
144 support::ulittle16_t MinorSubsystemVersion;
145 support::ulittle32_t Win32VersionValue;
146 support::ulittle32_t SizeOfImage;
147 support::ulittle32_t SizeOfHeaders;
148 support::ulittle32_t CheckSum;
149 support::ulittle16_t Subsystem;
150 support::ulittle16_t DLLCharacteristics;
151 support::ulittle64_t SizeOfStackReserve;
152 support::ulittle64_t SizeOfStackCommit;
153 support::ulittle64_t SizeOfHeapReserve;
154 support::ulittle64_t SizeOfHeapCommit;
155 support::ulittle32_t LoaderFlags;
156 support::ulittle32_t NumberOfRvaAndSize;
159 struct data_directory {
160 support::ulittle32_t RelativeVirtualAddress;
161 support::ulittle32_t Size;
164 struct import_directory_table_entry {
165 support::ulittle32_t ImportLookupTableRVA;
166 support::ulittle32_t TimeDateStamp;
167 support::ulittle32_t ForwarderChain;
168 support::ulittle32_t NameRVA;
169 support::ulittle32_t ImportAddressTableRVA;
172 template <typename IntTy>
173 struct import_lookup_table_entry {
176 bool isOrdinal() const { return Data < 0; }
178 uint16_t getOrdinal() const {
179 assert(isOrdinal() && "ILT entry is not an ordinal!");
180 return Data & 0xFFFF;
183 uint32_t getHintNameRVA() const {
184 assert(!isOrdinal() && "ILT entry is not a Hint/Name RVA!");
185 return Data & 0xFFFFFFFF;
189 typedef import_lookup_table_entry<support::little32_t>
190 import_lookup_table_entry32;
191 typedef import_lookup_table_entry<support::little64_t>
192 import_lookup_table_entry64;
194 struct delay_import_directory_table_entry {
195 // dumpbin reports this field as "Characteristics" instead of "Attributes".
196 support::ulittle32_t Attributes;
197 support::ulittle32_t Name;
198 support::ulittle32_t ModuleHandle;
199 support::ulittle32_t DelayImportAddressTable;
200 support::ulittle32_t DelayImportNameTable;
201 support::ulittle32_t BoundDelayImportTable;
202 support::ulittle32_t UnloadDelayImportTable;
203 support::ulittle32_t TimeStamp;
206 struct export_directory_table_entry {
207 support::ulittle32_t ExportFlags;
208 support::ulittle32_t TimeDateStamp;
209 support::ulittle16_t MajorVersion;
210 support::ulittle16_t MinorVersion;
211 support::ulittle32_t NameRVA;
212 support::ulittle32_t OrdinalBase;
213 support::ulittle32_t AddressTableEntries;
214 support::ulittle32_t NumberOfNamePointers;
215 support::ulittle32_t ExportAddressTableRVA;
216 support::ulittle32_t NamePointerRVA;
217 support::ulittle32_t OrdinalTableRVA;
220 union export_address_table_entry {
221 support::ulittle32_t ExportRVA;
222 support::ulittle32_t ForwarderRVA;
225 typedef support::ulittle32_t export_name_pointer_table_entry;
226 typedef support::ulittle16_t export_ordinal_table_entry;
228 struct StringTableOffset {
229 support::ulittle32_t Zeroes;
230 support::ulittle32_t Offset;
233 template <typename SectionNumberType>
236 char ShortName[COFF::NameSize];
237 StringTableOffset Offset;
240 support::ulittle32_t Value;
241 SectionNumberType SectionNumber;
243 support::ulittle16_t Type;
245 uint8_t StorageClass;
246 uint8_t NumberOfAuxSymbols;
249 typedef coff_symbol<support::ulittle16_t> coff_symbol16;
250 typedef coff_symbol<support::ulittle32_t> coff_symbol32;
252 class COFFSymbolRef {
254 COFFSymbolRef(const coff_symbol16 *CS) : CS16(CS), CS32(nullptr) {}
255 COFFSymbolRef(const coff_symbol32 *CS) : CS16(nullptr), CS32(CS) {}
256 COFFSymbolRef() : CS16(nullptr), CS32(nullptr) {}
258 const void *getRawPtr() const {
259 return CS16 ? static_cast<const void *>(CS16) : CS32;
262 friend bool operator<(COFFSymbolRef A, COFFSymbolRef B) {
263 return A.getRawPtr() < B.getRawPtr();
266 bool isBigObj() const {
271 llvm_unreachable("COFFSymbolRef points to nothing!");
274 const char *getShortName() const {
275 return CS16 ? CS16->Name.ShortName : CS32->Name.ShortName;
278 const StringTableOffset &getStringTableOffset() const {
279 assert(isSet() && "COFFSymbolRef points to nothing!");
280 return CS16 ? CS16->Name.Offset : CS32->Name.Offset;
283 uint32_t getValue() const { return CS16 ? CS16->Value : CS32->Value; }
285 int32_t getSectionNumber() const {
286 assert(isSet() && "COFFSymbolRef points to nothing!");
288 // Reserved sections are returned as negative numbers.
289 if (CS16->SectionNumber <= COFF::MaxNumberOfSections16)
290 return CS16->SectionNumber;
291 return static_cast<int16_t>(CS16->SectionNumber);
293 return static_cast<int32_t>(CS32->SectionNumber);
296 uint16_t getType() const {
297 assert(isSet() && "COFFSymbolRef points to nothing!");
298 return CS16 ? CS16->Type : CS32->Type;
301 uint8_t getStorageClass() const {
302 assert(isSet() && "COFFSymbolRef points to nothing!");
303 return CS16 ? CS16->StorageClass : CS32->StorageClass;
306 uint8_t getNumberOfAuxSymbols() const {
307 assert(isSet() && "COFFSymbolRef points to nothing!");
308 return CS16 ? CS16->NumberOfAuxSymbols : CS32->NumberOfAuxSymbols;
311 uint8_t getBaseType() const { return getType() & 0x0F; }
313 uint8_t getComplexType() const {
314 return (getType() & 0xF0) >> COFF::SCT_COMPLEX_TYPE_SHIFT;
317 bool isAbsolute() const {
318 return getSectionNumber() == -1;
321 bool isExternal() const {
322 return getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL;
325 bool isCommon() const {
326 return isExternal() && getSectionNumber() == COFF::IMAGE_SYM_UNDEFINED &&
330 bool isUndefined() const {
331 return isExternal() && getSectionNumber() == COFF::IMAGE_SYM_UNDEFINED &&
335 bool isWeakExternal() const {
336 return getStorageClass() == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL;
339 bool isFunctionDefinition() const {
340 return isExternal() && getBaseType() == COFF::IMAGE_SYM_TYPE_NULL &&
341 getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION &&
342 !COFF::isReservedSectionNumber(getSectionNumber());
345 bool isFunctionLineInfo() const {
346 return getStorageClass() == COFF::IMAGE_SYM_CLASS_FUNCTION;
349 bool isAnyUndefined() const {
350 return isUndefined() || isWeakExternal();
353 bool isFileRecord() const {
354 return getStorageClass() == COFF::IMAGE_SYM_CLASS_FILE;
357 bool isSection() const {
358 return getStorageClass() == COFF::IMAGE_SYM_CLASS_SECTION;
361 bool isSectionDefinition() const {
362 // C++/CLI creates external ABS symbols for non-const appdomain globals.
363 // These are also followed by an auxiliary section definition.
364 bool isAppdomainGlobal =
365 getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
366 getSectionNumber() == COFF::IMAGE_SYM_ABSOLUTE;
367 bool isOrdinarySection = getStorageClass() == COFF::IMAGE_SYM_CLASS_STATIC;
368 if (!getNumberOfAuxSymbols())
370 return isAppdomainGlobal || isOrdinarySection;
373 bool isCLRToken() const {
374 return getStorageClass() == COFF::IMAGE_SYM_CLASS_CLR_TOKEN;
378 bool isSet() const { return CS16 || CS32; }
380 const coff_symbol16 *CS16;
381 const coff_symbol32 *CS32;
384 struct coff_section {
385 char Name[COFF::NameSize];
386 support::ulittle32_t VirtualSize;
387 support::ulittle32_t VirtualAddress;
388 support::ulittle32_t SizeOfRawData;
389 support::ulittle32_t PointerToRawData;
390 support::ulittle32_t PointerToRelocations;
391 support::ulittle32_t PointerToLinenumbers;
392 support::ulittle16_t NumberOfRelocations;
393 support::ulittle16_t NumberOfLinenumbers;
394 support::ulittle32_t Characteristics;
396 // Returns true if the actual number of relocations is stored in
397 // VirtualAddress field of the first relocation table entry.
398 bool hasExtendedRelocations() const {
399 return (Characteristics & COFF::IMAGE_SCN_LNK_NRELOC_OVFL) &&
400 NumberOfRelocations == UINT16_MAX;
404 struct coff_relocation {
405 support::ulittle32_t VirtualAddress;
406 support::ulittle32_t SymbolTableIndex;
407 support::ulittle16_t Type;
410 struct coff_aux_function_definition {
411 support::ulittle32_t TagIndex;
412 support::ulittle32_t TotalSize;
413 support::ulittle32_t PointerToLinenumber;
414 support::ulittle32_t PointerToNextFunction;
417 struct coff_aux_bf_and_ef_symbol {
419 support::ulittle16_t Linenumber;
421 support::ulittle32_t PointerToNextFunction;
424 struct coff_aux_weak_external {
425 support::ulittle32_t TagIndex;
426 support::ulittle32_t Characteristics;
429 struct coff_aux_section_definition {
430 support::ulittle32_t Length;
431 support::ulittle16_t NumberOfRelocations;
432 support::ulittle16_t NumberOfLinenumbers;
433 support::ulittle32_t CheckSum;
434 support::ulittle16_t NumberLowPart;
437 support::ulittle16_t NumberHighPart;
438 int32_t getNumber(bool IsBigObj) const {
439 uint32_t Number = static_cast<uint32_t>(NumberLowPart);
441 Number |= static_cast<uint32_t>(NumberHighPart) << 16;
442 return static_cast<int32_t>(Number);
446 struct coff_aux_clr_token {
449 support::ulittle32_t SymbolTableIndex;
452 struct coff_import_header {
453 support::ulittle16_t Sig1;
454 support::ulittle16_t Sig2;
455 support::ulittle16_t Version;
456 support::ulittle16_t Machine;
457 support::ulittle32_t TimeDateStamp;
458 support::ulittle32_t SizeOfData;
459 support::ulittle16_t OrdinalHint;
460 support::ulittle16_t TypeInfo;
461 int getType() const { return TypeInfo & 0x3; }
462 int getNameType() const { return (TypeInfo & 0x7) >> 2; }
465 struct coff_import_directory_table_entry {
466 support::ulittle32_t ImportLookupTableRVA;
467 support::ulittle32_t TimeDateStamp;
468 support::ulittle32_t ForwarderChain;
469 support::ulittle32_t NameRVA;
470 support::ulittle32_t ImportAddressTableRVA;
473 struct coff_load_configuration32 {
474 support::ulittle32_t Characteristics;
475 support::ulittle32_t TimeDateStamp;
476 support::ulittle16_t MajorVersion;
477 support::ulittle16_t MinorVersion;
478 support::ulittle32_t GlobalFlagsClear;
479 support::ulittle32_t GlobalFlagsSet;
480 support::ulittle32_t CriticalSectionDefaultTimeout;
481 support::ulittle32_t DeCommitFreeBlockThreshold;
482 support::ulittle32_t DeCommitTotalFreeThreshold;
483 support::ulittle32_t LockPrefixTable;
484 support::ulittle32_t MaximumAllocationSize;
485 support::ulittle32_t VirtualMemoryThreshold;
486 support::ulittle32_t ProcessAffinityMask;
487 support::ulittle32_t ProcessHeapFlags;
488 support::ulittle16_t CSDVersion;
489 support::ulittle16_t Reserved;
490 support::ulittle32_t EditList;
491 support::ulittle32_t SecurityCookie;
492 support::ulittle32_t SEHandlerTable;
493 support::ulittle32_t SEHandlerCount;
496 struct coff_runtime_function_x64 {
497 support::ulittle32_t BeginAddress;
498 support::ulittle32_t EndAddress;
499 support::ulittle32_t UnwindInformation;
502 struct coff_base_reloc_block_header {
503 support::ulittle32_t PageRVA;
504 support::ulittle32_t BlockSize;
507 struct coff_base_reloc_block_entry {
508 support::ulittle16_t Data;
509 int getType() const { return Data >> 12; }
510 int getOffset() const { return Data & ((1 << 12) - 1); }
513 class COFFObjectFile : public ObjectFile {
515 friend class ImportDirectoryEntryRef;
516 friend class ExportDirectoryEntryRef;
517 const coff_file_header *COFFHeader;
518 const coff_bigobj_file_header *COFFBigObjHeader;
519 const pe32_header *PE32Header;
520 const pe32plus_header *PE32PlusHeader;
521 const data_directory *DataDirectory;
522 const coff_section *SectionTable;
523 const coff_symbol16 *SymbolTable16;
524 const coff_symbol32 *SymbolTable32;
525 const char *StringTable;
526 uint32_t StringTableSize;
527 const import_directory_table_entry *ImportDirectory;
528 uint32_t NumberOfImportDirectory;
529 const delay_import_directory_table_entry *DelayImportDirectory;
530 uint32_t NumberOfDelayImportDirectory;
531 const export_directory_table_entry *ExportDirectory;
532 const coff_base_reloc_block_header *BaseRelocHeader;
533 const coff_base_reloc_block_header *BaseRelocEnd;
535 std::error_code getString(uint32_t offset, StringRef &Res) const;
537 template <typename coff_symbol_type>
538 const coff_symbol_type *toSymb(DataRefImpl Symb) const;
539 const coff_section *toSec(DataRefImpl Sec) const;
540 const coff_relocation *toRel(DataRefImpl Rel) const;
542 std::error_code initSymbolTablePtr();
543 std::error_code initImportTablePtr();
544 std::error_code initDelayImportTablePtr();
545 std::error_code initExportTablePtr();
546 std::error_code initBaseRelocPtr();
549 uintptr_t getSymbolTable() const {
551 return reinterpret_cast<uintptr_t>(SymbolTable16);
553 return reinterpret_cast<uintptr_t>(SymbolTable32);
556 uint16_t getMachine() const {
558 return COFFHeader->Machine;
559 if (COFFBigObjHeader)
560 return COFFBigObjHeader->Machine;
561 llvm_unreachable("no COFF header!");
563 uint16_t getSizeOfOptionalHeader() const {
565 return COFFHeader->isImportLibrary() ? 0
566 : COFFHeader->SizeOfOptionalHeader;
567 // bigobj doesn't have this field.
568 if (COFFBigObjHeader)
570 llvm_unreachable("no COFF header!");
572 uint16_t getCharacteristics() const {
574 return COFFHeader->isImportLibrary() ? 0 : COFFHeader->Characteristics;
575 // bigobj doesn't have characteristics to speak of,
576 // editbin will silently lie to you if you attempt to set any.
577 if (COFFBigObjHeader)
579 llvm_unreachable("no COFF header!");
581 uint32_t getTimeDateStamp() const {
583 return COFFHeader->TimeDateStamp;
584 if (COFFBigObjHeader)
585 return COFFBigObjHeader->TimeDateStamp;
586 llvm_unreachable("no COFF header!");
588 uint32_t getNumberOfSections() const {
590 return COFFHeader->isImportLibrary() ? 0 : COFFHeader->NumberOfSections;
591 if (COFFBigObjHeader)
592 return COFFBigObjHeader->NumberOfSections;
593 llvm_unreachable("no COFF header!");
595 uint32_t getPointerToSymbolTable() const {
597 return COFFHeader->isImportLibrary() ? 0
598 : COFFHeader->PointerToSymbolTable;
599 if (COFFBigObjHeader)
600 return COFFBigObjHeader->PointerToSymbolTable;
601 llvm_unreachable("no COFF header!");
603 uint32_t getNumberOfSymbols() const {
605 return COFFHeader->isImportLibrary() ? 0 : COFFHeader->NumberOfSymbols;
606 if (COFFBigObjHeader)
607 return COFFBigObjHeader->NumberOfSymbols;
608 llvm_unreachable("no COFF header!");
611 void moveSymbolNext(DataRefImpl &Symb) const override;
612 std::error_code getSymbolName(DataRefImpl Symb,
613 StringRef &Res) const override;
614 std::error_code getSymbolAddress(DataRefImpl Symb,
615 uint64_t &Res) const override;
616 uint64_t getSymbolSize(DataRefImpl Symb) const override;
617 uint32_t getSymbolFlags(DataRefImpl Symb) const override;
618 std::error_code getSymbolType(DataRefImpl Symb,
619 SymbolRef::Type &Res) const override;
620 std::error_code getSymbolSection(DataRefImpl Symb,
621 section_iterator &Res) const override;
622 void moveSectionNext(DataRefImpl &Sec) const override;
623 std::error_code getSectionName(DataRefImpl Sec,
624 StringRef &Res) const override;
625 uint64_t getSectionAddress(DataRefImpl Sec) const override;
626 uint64_t getSectionSize(DataRefImpl Sec) const override;
627 std::error_code getSectionContents(DataRefImpl Sec,
628 StringRef &Res) const override;
629 uint64_t getSectionAlignment(DataRefImpl Sec) const override;
630 bool isSectionText(DataRefImpl Sec) const override;
631 bool isSectionData(DataRefImpl Sec) const override;
632 bool isSectionBSS(DataRefImpl Sec) const override;
633 bool isSectionVirtual(DataRefImpl Sec) const override;
634 bool sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb) const override;
635 relocation_iterator section_rel_begin(DataRefImpl Sec) const override;
636 relocation_iterator section_rel_end(DataRefImpl Sec) const override;
638 void moveRelocationNext(DataRefImpl &Rel) const override;
639 std::error_code getRelocationAddress(DataRefImpl Rel,
640 uint64_t &Res) const override;
641 std::error_code getRelocationOffset(DataRefImpl Rel,
642 uint64_t &Res) const override;
643 symbol_iterator getRelocationSymbol(DataRefImpl Rel) const override;
644 section_iterator getRelocationSection(DataRefImpl Rel) const override;
645 std::error_code getRelocationType(DataRefImpl Rel,
646 uint64_t &Res) const override;
648 getRelocationTypeName(DataRefImpl Rel,
649 SmallVectorImpl<char> &Result) const override;
651 getRelocationValueString(DataRefImpl Rel,
652 SmallVectorImpl<char> &Result) const override;
655 COFFObjectFile(MemoryBufferRef Object, std::error_code &EC);
656 basic_symbol_iterator symbol_begin_impl() const override;
657 basic_symbol_iterator symbol_end_impl() const override;
658 section_iterator section_begin() const override;
659 section_iterator section_end() const override;
661 const coff_section *getCOFFSection(const SectionRef &Section) const;
662 COFFSymbolRef getCOFFSymbol(const DataRefImpl &Ref) const;
663 COFFSymbolRef getCOFFSymbol(const SymbolRef &Symbol) const;
664 const coff_relocation *getCOFFRelocation(const RelocationRef &Reloc) const;
666 uint8_t getBytesInAddress() const override;
667 StringRef getFileFormatName() const override;
668 unsigned getArch() const override;
670 import_directory_iterator import_directory_begin() const;
671 import_directory_iterator import_directory_end() const;
672 delay_import_directory_iterator delay_import_directory_begin() const;
673 delay_import_directory_iterator delay_import_directory_end() const;
674 export_directory_iterator export_directory_begin() const;
675 export_directory_iterator export_directory_end() const;
676 base_reloc_iterator base_reloc_begin() const;
677 base_reloc_iterator base_reloc_end() const;
679 iterator_range<import_directory_iterator> import_directories() const;
680 iterator_range<delay_import_directory_iterator>
681 delay_import_directories() const;
682 iterator_range<export_directory_iterator> export_directories() const;
683 iterator_range<base_reloc_iterator> base_relocs() const;
685 const dos_header *getDOSHeader() const {
686 if (!PE32Header && !PE32PlusHeader)
688 return reinterpret_cast<const dos_header *>(base());
690 std::error_code getPE32Header(const pe32_header *&Res) const;
691 std::error_code getPE32PlusHeader(const pe32plus_header *&Res) const;
692 std::error_code getDataDirectory(uint32_t index,
693 const data_directory *&Res) const;
694 std::error_code getSection(int32_t index, const coff_section *&Res) const;
695 template <typename coff_symbol_type>
696 std::error_code getSymbol(uint32_t Index,
697 const coff_symbol_type *&Res) const {
698 if (Index >= getNumberOfSymbols())
699 return object_error::parse_failed;
701 Res = reinterpret_cast<coff_symbol_type *>(getSymbolTable()) + Index;
702 return object_error::success;
704 ErrorOr<COFFSymbolRef> getSymbol(uint32_t index) const {
706 const coff_symbol16 *Symb = nullptr;
707 if (std::error_code EC = getSymbol(index, Symb))
709 return COFFSymbolRef(Symb);
712 const coff_symbol32 *Symb = nullptr;
713 if (std::error_code EC = getSymbol(index, Symb))
715 return COFFSymbolRef(Symb);
717 return object_error::parse_failed;
719 template <typename T>
720 std::error_code getAuxSymbol(uint32_t index, const T *&Res) const {
721 ErrorOr<COFFSymbolRef> s = getSymbol(index);
722 if (std::error_code EC = s.getError())
724 Res = reinterpret_cast<const T *>(s->getRawPtr());
725 return object_error::success;
727 std::error_code getSymbolName(COFFSymbolRef Symbol, StringRef &Res) const;
729 ArrayRef<uint8_t> getSymbolAuxData(COFFSymbolRef Symbol) const;
731 size_t getSymbolTableEntrySize() const {
733 return sizeof(coff_symbol16);
734 if (COFFBigObjHeader)
735 return sizeof(coff_symbol32);
736 llvm_unreachable("null symbol table pointer!");
739 std::error_code getSectionName(const coff_section *Sec, StringRef &Res) const;
740 uint64_t getSectionSize(const coff_section *Sec) const;
741 std::error_code getSectionContents(const coff_section *Sec,
742 ArrayRef<uint8_t> &Res) const;
744 std::error_code getVaPtr(uint64_t VA, uintptr_t &Res) const;
745 std::error_code getRvaPtr(uint32_t Rva, uintptr_t &Res) const;
746 std::error_code getHintName(uint32_t Rva, uint16_t &Hint,
747 StringRef &Name) const;
749 bool isRelocatableObject() const override;
750 bool is64() const { return PE32PlusHeader; }
752 static inline bool classof(const Binary *v) { return v->isCOFF(); }
755 // The iterator for the import directory table.
756 class ImportDirectoryEntryRef {
758 ImportDirectoryEntryRef() : OwningObject(nullptr) {}
759 ImportDirectoryEntryRef(const import_directory_table_entry *Table, uint32_t I,
760 const COFFObjectFile *Owner)
761 : ImportTable(Table), Index(I), OwningObject(Owner) {}
763 bool operator==(const ImportDirectoryEntryRef &Other) const;
766 imported_symbol_iterator imported_symbol_begin() const;
767 imported_symbol_iterator imported_symbol_end() const;
768 iterator_range<imported_symbol_iterator> imported_symbols() const;
770 std::error_code getName(StringRef &Result) const;
771 std::error_code getImportLookupTableRVA(uint32_t &Result) const;
772 std::error_code getImportAddressTableRVA(uint32_t &Result) const;
775 getImportTableEntry(const import_directory_table_entry *&Result) const;
778 getImportLookupEntry(const import_lookup_table_entry32 *&Result) const;
781 const import_directory_table_entry *ImportTable;
783 const COFFObjectFile *OwningObject;
786 class DelayImportDirectoryEntryRef {
788 DelayImportDirectoryEntryRef() : OwningObject(nullptr) {}
789 DelayImportDirectoryEntryRef(const delay_import_directory_table_entry *T,
790 uint32_t I, const COFFObjectFile *Owner)
791 : Table(T), Index(I), OwningObject(Owner) {}
793 bool operator==(const DelayImportDirectoryEntryRef &Other) const;
796 imported_symbol_iterator imported_symbol_begin() const;
797 imported_symbol_iterator imported_symbol_end() const;
798 iterator_range<imported_symbol_iterator> imported_symbols() const;
800 std::error_code getName(StringRef &Result) const;
801 std::error_code getDelayImportTable(
802 const delay_import_directory_table_entry *&Result) const;
803 std::error_code getImportAddress(int AddrIndex, uint64_t &Result) const;
806 const delay_import_directory_table_entry *Table;
808 const COFFObjectFile *OwningObject;
811 // The iterator for the export directory table entry.
812 class ExportDirectoryEntryRef {
814 ExportDirectoryEntryRef() : OwningObject(nullptr) {}
815 ExportDirectoryEntryRef(const export_directory_table_entry *Table, uint32_t I,
816 const COFFObjectFile *Owner)
817 : ExportTable(Table), Index(I), OwningObject(Owner) {}
819 bool operator==(const ExportDirectoryEntryRef &Other) const;
822 std::error_code getDllName(StringRef &Result) const;
823 std::error_code getOrdinalBase(uint32_t &Result) const;
824 std::error_code getOrdinal(uint32_t &Result) const;
825 std::error_code getExportRVA(uint32_t &Result) const;
826 std::error_code getSymbolName(StringRef &Result) const;
829 const export_directory_table_entry *ExportTable;
831 const COFFObjectFile *OwningObject;
834 class ImportedSymbolRef {
836 ImportedSymbolRef() : OwningObject(nullptr) {}
837 ImportedSymbolRef(const import_lookup_table_entry32 *Entry, uint32_t I,
838 const COFFObjectFile *Owner)
839 : Entry32(Entry), Entry64(nullptr), Index(I), OwningObject(Owner) {}
840 ImportedSymbolRef(const import_lookup_table_entry64 *Entry, uint32_t I,
841 const COFFObjectFile *Owner)
842 : Entry32(nullptr), Entry64(Entry), Index(I), OwningObject(Owner) {}
844 bool operator==(const ImportedSymbolRef &Other) const;
847 std::error_code getSymbolName(StringRef &Result) const;
848 std::error_code getOrdinal(uint16_t &Result) const;
851 const import_lookup_table_entry32 *Entry32;
852 const import_lookup_table_entry64 *Entry64;
854 const COFFObjectFile *OwningObject;
859 BaseRelocRef() : OwningObject(nullptr) {}
860 BaseRelocRef(const coff_base_reloc_block_header *Header,
861 const COFFObjectFile *Owner)
862 : Header(Header), Index(0), OwningObject(Owner) {}
864 bool operator==(const BaseRelocRef &Other) const;
867 std::error_code getType(uint8_t &Type) const;
868 std::error_code getRVA(uint32_t &Result) const;
871 const coff_base_reloc_block_header *Header;
873 const COFFObjectFile *OwningObject;
876 } // end namespace object
877 } // end namespace llvm