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;
31 typedef content_iterator<ImportDirectoryEntryRef> import_directory_iterator;
32 typedef content_iterator<DelayImportDirectoryEntryRef>
33 delay_import_directory_iterator;
34 typedef content_iterator<ExportDirectoryEntryRef> export_directory_iterator;
35 typedef content_iterator<ImportedSymbolRef> imported_symbol_iterator;
37 /// The DOS compatible header at the front of all PE/COFF executables.
39 support::ulittle16_t Magic;
40 support::ulittle16_t UsedBytesInTheLastPage;
41 support::ulittle16_t FileSizeInPages;
42 support::ulittle16_t NumberOfRelocationItems;
43 support::ulittle16_t HeaderSizeInParagraphs;
44 support::ulittle16_t MinimumExtraParagraphs;
45 support::ulittle16_t MaximumExtraParagraphs;
46 support::ulittle16_t InitialRelativeSS;
47 support::ulittle16_t InitialSP;
48 support::ulittle16_t Checksum;
49 support::ulittle16_t InitialIP;
50 support::ulittle16_t InitialRelativeCS;
51 support::ulittle16_t AddressOfRelocationTable;
52 support::ulittle16_t OverlayNumber;
53 support::ulittle16_t Reserved[4];
54 support::ulittle16_t OEMid;
55 support::ulittle16_t OEMinfo;
56 support::ulittle16_t Reserved2[10];
57 support::ulittle32_t AddressOfNewExeHeader;
60 struct coff_file_header {
61 support::ulittle16_t Machine;
62 support::ulittle16_t NumberOfSections;
63 support::ulittle32_t TimeDateStamp;
64 support::ulittle32_t PointerToSymbolTable;
65 support::ulittle32_t NumberOfSymbols;
66 support::ulittle16_t SizeOfOptionalHeader;
67 support::ulittle16_t Characteristics;
69 bool isImportLibrary() const { return NumberOfSections == 0xffff; }
72 struct coff_bigobj_file_header {
73 support::ulittle16_t Sig1;
74 support::ulittle16_t Sig2;
75 support::ulittle16_t Version;
76 support::ulittle16_t Machine;
77 support::ulittle32_t TimeDateStamp;
79 support::ulittle32_t unused1;
80 support::ulittle32_t unused2;
81 support::ulittle32_t unused3;
82 support::ulittle32_t unused4;
83 support::ulittle32_t NumberOfSections;
84 support::ulittle32_t PointerToSymbolTable;
85 support::ulittle32_t NumberOfSymbols;
88 /// The 32-bit PE header that follows the COFF header.
90 support::ulittle16_t Magic;
91 uint8_t MajorLinkerVersion;
92 uint8_t MinorLinkerVersion;
93 support::ulittle32_t SizeOfCode;
94 support::ulittle32_t SizeOfInitializedData;
95 support::ulittle32_t SizeOfUninitializedData;
96 support::ulittle32_t AddressOfEntryPoint;
97 support::ulittle32_t BaseOfCode;
98 support::ulittle32_t BaseOfData;
99 support::ulittle32_t ImageBase;
100 support::ulittle32_t SectionAlignment;
101 support::ulittle32_t FileAlignment;
102 support::ulittle16_t MajorOperatingSystemVersion;
103 support::ulittle16_t MinorOperatingSystemVersion;
104 support::ulittle16_t MajorImageVersion;
105 support::ulittle16_t MinorImageVersion;
106 support::ulittle16_t MajorSubsystemVersion;
107 support::ulittle16_t MinorSubsystemVersion;
108 support::ulittle32_t Win32VersionValue;
109 support::ulittle32_t SizeOfImage;
110 support::ulittle32_t SizeOfHeaders;
111 support::ulittle32_t CheckSum;
112 support::ulittle16_t Subsystem;
113 support::ulittle16_t DLLCharacteristics;
114 support::ulittle32_t SizeOfStackReserve;
115 support::ulittle32_t SizeOfStackCommit;
116 support::ulittle32_t SizeOfHeapReserve;
117 support::ulittle32_t SizeOfHeapCommit;
118 support::ulittle32_t LoaderFlags;
119 support::ulittle32_t NumberOfRvaAndSize;
122 /// The 64-bit PE header that follows the COFF header.
123 struct pe32plus_header {
124 support::ulittle16_t Magic;
125 uint8_t MajorLinkerVersion;
126 uint8_t MinorLinkerVersion;
127 support::ulittle32_t SizeOfCode;
128 support::ulittle32_t SizeOfInitializedData;
129 support::ulittle32_t SizeOfUninitializedData;
130 support::ulittle32_t AddressOfEntryPoint;
131 support::ulittle32_t BaseOfCode;
132 support::ulittle64_t ImageBase;
133 support::ulittle32_t SectionAlignment;
134 support::ulittle32_t FileAlignment;
135 support::ulittle16_t MajorOperatingSystemVersion;
136 support::ulittle16_t MinorOperatingSystemVersion;
137 support::ulittle16_t MajorImageVersion;
138 support::ulittle16_t MinorImageVersion;
139 support::ulittle16_t MajorSubsystemVersion;
140 support::ulittle16_t MinorSubsystemVersion;
141 support::ulittle32_t Win32VersionValue;
142 support::ulittle32_t SizeOfImage;
143 support::ulittle32_t SizeOfHeaders;
144 support::ulittle32_t CheckSum;
145 support::ulittle16_t Subsystem;
146 support::ulittle16_t DLLCharacteristics;
147 support::ulittle64_t SizeOfStackReserve;
148 support::ulittle64_t SizeOfStackCommit;
149 support::ulittle64_t SizeOfHeapReserve;
150 support::ulittle64_t SizeOfHeapCommit;
151 support::ulittle32_t LoaderFlags;
152 support::ulittle32_t NumberOfRvaAndSize;
155 struct data_directory {
156 support::ulittle32_t RelativeVirtualAddress;
157 support::ulittle32_t Size;
160 struct import_directory_table_entry {
161 support::ulittle32_t ImportLookupTableRVA;
162 support::ulittle32_t TimeDateStamp;
163 support::ulittle32_t ForwarderChain;
164 support::ulittle32_t NameRVA;
165 support::ulittle32_t ImportAddressTableRVA;
168 template <typename IntTy>
169 struct import_lookup_table_entry {
172 bool isOrdinal() const { return Data < 0; }
174 uint16_t getOrdinal() const {
175 assert(isOrdinal() && "ILT entry is not an ordinal!");
176 return Data & 0xFFFF;
179 uint32_t getHintNameRVA() const {
180 assert(!isOrdinal() && "ILT entry is not a Hint/Name RVA!");
181 return Data & 0xFFFFFFFF;
185 typedef import_lookup_table_entry<support::little32_t>
186 import_lookup_table_entry32;
187 typedef import_lookup_table_entry<support::little64_t>
188 import_lookup_table_entry64;
190 struct delay_import_directory_table_entry {
191 // dumpbin reports this field as "Characteristics" instead of "Attributes".
192 support::ulittle32_t Attributes;
193 support::ulittle32_t Name;
194 support::ulittle32_t ModuleHandle;
195 support::ulittle32_t DelayImportAddressTable;
196 support::ulittle32_t DelayImportNameTable;
197 support::ulittle32_t BoundDelayImportTable;
198 support::ulittle32_t UnloadDelayImportTable;
199 support::ulittle32_t TimeStamp;
202 struct export_directory_table_entry {
203 support::ulittle32_t ExportFlags;
204 support::ulittle32_t TimeDateStamp;
205 support::ulittle16_t MajorVersion;
206 support::ulittle16_t MinorVersion;
207 support::ulittle32_t NameRVA;
208 support::ulittle32_t OrdinalBase;
209 support::ulittle32_t AddressTableEntries;
210 support::ulittle32_t NumberOfNamePointers;
211 support::ulittle32_t ExportAddressTableRVA;
212 support::ulittle32_t NamePointerRVA;
213 support::ulittle32_t OrdinalTableRVA;
216 union export_address_table_entry {
217 support::ulittle32_t ExportRVA;
218 support::ulittle32_t ForwarderRVA;
221 typedef support::ulittle32_t export_name_pointer_table_entry;
222 typedef support::ulittle16_t export_ordinal_table_entry;
224 struct StringTableOffset {
225 support::ulittle32_t Zeroes;
226 support::ulittle32_t Offset;
229 template <typename SectionNumberType>
232 char ShortName[COFF::NameSize];
233 StringTableOffset Offset;
236 support::ulittle32_t Value;
237 SectionNumberType SectionNumber;
239 support::ulittle16_t Type;
241 uint8_t StorageClass;
242 uint8_t NumberOfAuxSymbols;
245 typedef coff_symbol<support::ulittle16_t> coff_symbol16;
246 typedef coff_symbol<support::ulittle32_t> coff_symbol32;
248 class COFFSymbolRef {
250 COFFSymbolRef(const coff_symbol16 *CS) : CS16(CS), CS32(nullptr) {}
251 COFFSymbolRef(const coff_symbol32 *CS) : CS16(nullptr), CS32(CS) {}
252 COFFSymbolRef() : CS16(nullptr), CS32(nullptr) {}
254 const void *getRawPtr() const {
255 return CS16 ? static_cast<const void *>(CS16) : CS32;
258 friend bool operator<(COFFSymbolRef A, COFFSymbolRef B) {
259 return A.getRawPtr() < B.getRawPtr();
262 bool isBigObj() const {
267 llvm_unreachable("COFFSymbolRef points to nothing!");
270 const char *getShortName() const {
271 return CS16 ? CS16->Name.ShortName : CS32->Name.ShortName;
274 const StringTableOffset &getStringTableOffset() const {
275 return CS16 ? CS16->Name.Offset : CS32->Name.Offset;
278 uint32_t getValue() const { return CS16 ? CS16->Value : CS32->Value; }
280 int32_t getSectionNumber() const {
282 // Reserved sections are returned as negative numbers.
283 if (CS16->SectionNumber <= COFF::MaxNumberOfSections16)
284 return CS16->SectionNumber;
285 return static_cast<int16_t>(CS16->SectionNumber);
287 return static_cast<int32_t>(CS32->SectionNumber);
290 uint16_t getType() const { return CS16 ? CS16->Type : CS32->Type; }
292 uint8_t getStorageClass() const {
293 return CS16 ? CS16->StorageClass : CS32->StorageClass;
296 uint8_t getNumberOfAuxSymbols() const {
297 return CS16 ? CS16->NumberOfAuxSymbols : CS32->NumberOfAuxSymbols;
300 uint8_t getBaseType() const { return getType() & 0x0F; }
302 uint8_t getComplexType() const { return (getType() & 0xF0) >> 4; }
304 bool isFunctionDefinition() const {
305 return getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
306 getBaseType() == COFF::IMAGE_SYM_TYPE_NULL &&
307 getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION &&
308 !COFF::isReservedSectionNumber(getSectionNumber());
311 bool isFunctionLineInfo() const {
312 return getStorageClass() == COFF::IMAGE_SYM_CLASS_FUNCTION;
315 bool isWeakExternal() const {
316 return getStorageClass() == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL ||
317 (getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
318 getSectionNumber() == COFF::IMAGE_SYM_UNDEFINED && getValue() == 0);
321 bool isFileRecord() const {
322 return getStorageClass() == COFF::IMAGE_SYM_CLASS_FILE;
325 bool isSectionDefinition() const {
326 // C++/CLI creates external ABS symbols for non-const appdomain globals.
327 // These are also followed by an auxiliary section definition.
328 bool isAppdomainGlobal =
329 getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
330 getSectionNumber() == COFF::IMAGE_SYM_ABSOLUTE;
331 bool isOrdinarySection = getStorageClass() == COFF::IMAGE_SYM_CLASS_STATIC;
332 return isAppdomainGlobal || isOrdinarySection;
335 bool isCLRToken() const {
336 return getStorageClass() == COFF::IMAGE_SYM_CLASS_CLR_TOKEN;
340 const coff_symbol16 *CS16;
341 const coff_symbol32 *CS32;
344 struct coff_section {
345 char Name[COFF::NameSize];
346 support::ulittle32_t VirtualSize;
347 support::ulittle32_t VirtualAddress;
348 support::ulittle32_t SizeOfRawData;
349 support::ulittle32_t PointerToRawData;
350 support::ulittle32_t PointerToRelocations;
351 support::ulittle32_t PointerToLinenumbers;
352 support::ulittle16_t NumberOfRelocations;
353 support::ulittle16_t NumberOfLinenumbers;
354 support::ulittle32_t Characteristics;
356 // Returns true if the actual number of relocations is stored in
357 // VirtualAddress field of the first relocation table entry.
358 bool hasExtendedRelocations() const {
359 return Characteristics & COFF::IMAGE_SCN_LNK_NRELOC_OVFL &&
360 NumberOfRelocations == UINT16_MAX;
364 struct coff_relocation {
365 support::ulittle32_t VirtualAddress;
366 support::ulittle32_t SymbolTableIndex;
367 support::ulittle16_t Type;
370 struct coff_aux_function_definition {
371 support::ulittle32_t TagIndex;
372 support::ulittle32_t TotalSize;
373 support::ulittle32_t PointerToLinenumber;
374 support::ulittle32_t PointerToNextFunction;
377 struct coff_aux_bf_and_ef_symbol {
379 support::ulittle16_t Linenumber;
381 support::ulittle32_t PointerToNextFunction;
384 struct coff_aux_weak_external {
385 support::ulittle32_t TagIndex;
386 support::ulittle32_t Characteristics;
389 struct coff_aux_section_definition {
390 support::ulittle32_t Length;
391 support::ulittle16_t NumberOfRelocations;
392 support::ulittle16_t NumberOfLinenumbers;
393 support::ulittle32_t CheckSum;
394 support::ulittle16_t NumberLowPart;
397 support::ulittle16_t NumberHighPart;
398 int32_t getNumber(bool IsBigObj) const {
399 uint32_t Number = static_cast<uint32_t>(NumberLowPart);
401 Number |= static_cast<uint32_t>(NumberHighPart) << 16;
402 return static_cast<int32_t>(Number);
406 struct coff_aux_clr_token {
409 support::ulittle32_t SymbolTableIndex;
412 struct coff_load_configuration32 {
413 support::ulittle32_t Characteristics;
414 support::ulittle32_t TimeDateStamp;
415 support::ulittle16_t MajorVersion;
416 support::ulittle16_t MinorVersion;
417 support::ulittle32_t GlobalFlagsClear;
418 support::ulittle32_t GlobalFlagsSet;
419 support::ulittle32_t CriticalSectionDefaultTimeout;
420 support::ulittle32_t DeCommitFreeBlockThreshold;
421 support::ulittle32_t DeCommitTotalFreeThreshold;
422 support::ulittle32_t LockPrefixTable;
423 support::ulittle32_t MaximumAllocationSize;
424 support::ulittle32_t VirtualMemoryThreshold;
425 support::ulittle32_t ProcessAffinityMask;
426 support::ulittle32_t ProcessHeapFlags;
427 support::ulittle16_t CSDVersion;
428 support::ulittle16_t Reserved;
429 support::ulittle32_t EditList;
430 support::ulittle32_t SecurityCookie;
431 support::ulittle32_t SEHandlerTable;
432 support::ulittle32_t SEHandlerCount;
435 struct coff_runtime_function_x64 {
436 support::ulittle32_t BeginAddress;
437 support::ulittle32_t EndAddress;
438 support::ulittle32_t UnwindInformation;
441 class COFFObjectFile : public ObjectFile {
443 friend class ImportDirectoryEntryRef;
444 friend class ExportDirectoryEntryRef;
445 const coff_file_header *COFFHeader;
446 const coff_bigobj_file_header *COFFBigObjHeader;
447 const pe32_header *PE32Header;
448 const pe32plus_header *PE32PlusHeader;
449 const data_directory *DataDirectory;
450 const coff_section *SectionTable;
451 const coff_symbol16 *SymbolTable16;
452 const coff_symbol32 *SymbolTable32;
453 const char *StringTable;
454 uint32_t StringTableSize;
455 const import_directory_table_entry *ImportDirectory;
456 uint32_t NumberOfImportDirectory;
457 const delay_import_directory_table_entry *DelayImportDirectory;
458 uint32_t NumberOfDelayImportDirectory;
459 const export_directory_table_entry *ExportDirectory;
461 std::error_code getString(uint32_t offset, StringRef &Res) const;
463 template <typename coff_symbol_type>
464 const coff_symbol_type *toSymb(DataRefImpl Symb) const;
465 const coff_section *toSec(DataRefImpl Sec) const;
466 const coff_relocation *toRel(DataRefImpl Rel) const;
468 std::error_code initSymbolTablePtr();
469 std::error_code initImportTablePtr();
470 std::error_code initDelayImportTablePtr();
471 std::error_code initExportTablePtr();
474 uintptr_t getSymbolTable() const {
476 return reinterpret_cast<uintptr_t>(SymbolTable16);
478 return reinterpret_cast<uintptr_t>(SymbolTable32);
481 uint16_t getMachine() const {
483 return COFFHeader->Machine;
484 if (COFFBigObjHeader)
485 return COFFBigObjHeader->Machine;
486 llvm_unreachable("no COFF header!");
488 uint16_t getSizeOfOptionalHeader() const {
490 return COFFHeader->SizeOfOptionalHeader;
491 // bigobj doesn't have this field.
492 if (COFFBigObjHeader)
494 llvm_unreachable("no COFF header!");
496 uint16_t getCharacteristics() const {
498 return COFFHeader->Characteristics;
499 // bigobj doesn't have characteristics to speak of,
500 // editbin will silently lie to you if you attempt to set any.
501 if (COFFBigObjHeader)
503 llvm_unreachable("no COFF header!");
505 uint32_t getTimeDateStamp() const {
507 return COFFHeader->TimeDateStamp;
508 if (COFFBigObjHeader)
509 return COFFBigObjHeader->TimeDateStamp;
510 llvm_unreachable("no COFF header!");
512 uint32_t getNumberOfSections() const {
514 return COFFHeader->NumberOfSections;
515 if (COFFBigObjHeader)
516 return COFFBigObjHeader->NumberOfSections;
517 llvm_unreachable("no COFF header!");
519 uint32_t getPointerToSymbolTable() const {
521 return COFFHeader->PointerToSymbolTable;
522 if (COFFBigObjHeader)
523 return COFFBigObjHeader->PointerToSymbolTable;
524 llvm_unreachable("no COFF header!");
526 uint32_t getNumberOfSymbols() const {
528 return COFFHeader->NumberOfSymbols;
529 if (COFFBigObjHeader)
530 return COFFBigObjHeader->NumberOfSymbols;
531 llvm_unreachable("no COFF header!");
534 void moveSymbolNext(DataRefImpl &Symb) const override;
535 std::error_code getSymbolName(DataRefImpl Symb,
536 StringRef &Res) const override;
537 std::error_code getSymbolAddress(DataRefImpl Symb,
538 uint64_t &Res) const override;
539 std::error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const override;
540 uint32_t getSymbolFlags(DataRefImpl Symb) const override;
541 std::error_code getSymbolType(DataRefImpl Symb,
542 SymbolRef::Type &Res) const override;
543 std::error_code getSymbolSection(DataRefImpl Symb,
544 section_iterator &Res) const override;
545 void moveSectionNext(DataRefImpl &Sec) const override;
546 std::error_code getSectionName(DataRefImpl Sec,
547 StringRef &Res) const override;
548 uint64_t getSectionAddress(DataRefImpl Sec) const override;
549 uint64_t getSectionSize(DataRefImpl Sec) const override;
550 std::error_code getSectionContents(DataRefImpl Sec,
551 StringRef &Res) const override;
552 uint64_t getSectionAlignment(DataRefImpl Sec) const override;
553 bool isSectionText(DataRefImpl Sec) const override;
554 bool isSectionData(DataRefImpl Sec) const override;
555 bool isSectionBSS(DataRefImpl Sec) const override;
556 bool isSectionVirtual(DataRefImpl Sec) const override;
557 bool isSectionZeroInit(DataRefImpl Sec) const override;
558 bool isSectionReadOnlyData(DataRefImpl Sec) const override;
559 bool isSectionRequiredForExecution(DataRefImpl Sec) const override;
560 bool sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb) const override;
561 relocation_iterator section_rel_begin(DataRefImpl Sec) const override;
562 relocation_iterator section_rel_end(DataRefImpl Sec) const override;
564 void moveRelocationNext(DataRefImpl &Rel) const override;
565 std::error_code getRelocationAddress(DataRefImpl Rel,
566 uint64_t &Res) const override;
567 std::error_code getRelocationOffset(DataRefImpl Rel,
568 uint64_t &Res) const override;
569 symbol_iterator getRelocationSymbol(DataRefImpl Rel) const override;
570 std::error_code getRelocationType(DataRefImpl Rel,
571 uint64_t &Res) const override;
573 getRelocationTypeName(DataRefImpl Rel,
574 SmallVectorImpl<char> &Result) const override;
576 getRelocationValueString(DataRefImpl Rel,
577 SmallVectorImpl<char> &Result) const override;
580 COFFObjectFile(MemoryBufferRef Object, std::error_code &EC);
581 basic_symbol_iterator symbol_begin_impl() const override;
582 basic_symbol_iterator symbol_end_impl() const override;
583 section_iterator section_begin() const override;
584 section_iterator section_end() const override;
586 const coff_section *getCOFFSection(const SectionRef &Section) const;
587 COFFSymbolRef getCOFFSymbol(const DataRefImpl &Ref) const;
588 COFFSymbolRef getCOFFSymbol(const SymbolRef &Symbol) const;
589 const coff_relocation *getCOFFRelocation(const RelocationRef &Reloc) const;
591 uint8_t getBytesInAddress() const override;
592 StringRef getFileFormatName() const override;
593 unsigned getArch() const override;
595 import_directory_iterator import_directory_begin() const;
596 import_directory_iterator import_directory_end() const;
597 delay_import_directory_iterator delay_import_directory_begin() const;
598 delay_import_directory_iterator delay_import_directory_end() const;
599 export_directory_iterator export_directory_begin() const;
600 export_directory_iterator export_directory_end() const;
602 iterator_range<import_directory_iterator> import_directories() const;
603 iterator_range<delay_import_directory_iterator>
604 delay_import_directories() const;
605 iterator_range<export_directory_iterator> export_directories() const;
607 std::error_code getPE32Header(const pe32_header *&Res) const;
608 std::error_code getPE32PlusHeader(const pe32plus_header *&Res) const;
609 std::error_code getDataDirectory(uint32_t index,
610 const data_directory *&Res) const;
611 std::error_code getSection(int32_t index, const coff_section *&Res) const;
612 template <typename coff_symbol_type>
613 std::error_code getSymbol(uint32_t Index,
614 const coff_symbol_type *&Res) const {
615 if (Index >= getNumberOfSymbols())
616 return object_error::parse_failed;
618 Res = reinterpret_cast<coff_symbol_type *>(getSymbolTable()) + Index;
619 return object_error::success;
621 ErrorOr<COFFSymbolRef> getSymbol(uint32_t index) const {
623 const coff_symbol16 *Symb = nullptr;
624 if (std::error_code EC = getSymbol(index, Symb))
626 return COFFSymbolRef(Symb);
629 const coff_symbol32 *Symb = nullptr;
630 if (std::error_code EC = getSymbol(index, Symb))
632 return COFFSymbolRef(Symb);
634 llvm_unreachable("no symbol table pointer!");
636 template <typename T>
637 std::error_code getAuxSymbol(uint32_t index, const T *&Res) const {
638 ErrorOr<COFFSymbolRef> s = getSymbol(index);
639 if (std::error_code EC = s.getError())
641 Res = reinterpret_cast<const T *>(s->getRawPtr());
642 return object_error::success;
644 std::error_code getSymbolName(COFFSymbolRef Symbol, StringRef &Res) const;
646 ArrayRef<uint8_t> getSymbolAuxData(COFFSymbolRef Symbol) const;
648 size_t getSymbolTableEntrySize() const {
650 return sizeof(coff_symbol16);
651 if (COFFBigObjHeader)
652 return sizeof(coff_symbol32);
653 llvm_unreachable("null symbol table pointer!");
656 std::error_code getSectionName(const coff_section *Sec, StringRef &Res) const;
657 uint64_t getSectionSize(const coff_section *Sec) const;
658 std::error_code getSectionContents(const coff_section *Sec,
659 ArrayRef<uint8_t> &Res) const;
661 std::error_code getVaPtr(uint64_t VA, uintptr_t &Res) const;
662 std::error_code getRvaPtr(uint32_t Rva, uintptr_t &Res) const;
663 std::error_code getHintName(uint32_t Rva, uint16_t &Hint,
664 StringRef &Name) const;
666 bool isRelocatableObject() const override;
668 static inline bool classof(const Binary *v) { return v->isCOFF(); }
671 // The iterator for the import directory table.
672 class ImportDirectoryEntryRef {
674 ImportDirectoryEntryRef() : OwningObject(nullptr) {}
675 ImportDirectoryEntryRef(const import_directory_table_entry *Table, uint32_t I,
676 const COFFObjectFile *Owner)
677 : ImportTable(Table), Index(I), OwningObject(Owner) {}
679 bool operator==(const ImportDirectoryEntryRef &Other) const;
682 imported_symbol_iterator imported_symbol_begin() const;
683 imported_symbol_iterator imported_symbol_end() const;
684 iterator_range<imported_symbol_iterator> imported_symbols() const;
686 std::error_code getName(StringRef &Result) const;
687 std::error_code getImportLookupTableRVA(uint32_t &Result) const;
688 std::error_code getImportAddressTableRVA(uint32_t &Result) const;
691 getImportTableEntry(const import_directory_table_entry *&Result) const;
694 getImportLookupEntry(const import_lookup_table_entry32 *&Result) const;
697 const import_directory_table_entry *ImportTable;
699 const COFFObjectFile *OwningObject;
702 class DelayImportDirectoryEntryRef {
704 DelayImportDirectoryEntryRef() : OwningObject(nullptr) {}
705 DelayImportDirectoryEntryRef(const delay_import_directory_table_entry *T,
706 uint32_t I, const COFFObjectFile *Owner)
707 : Table(T), Index(I), OwningObject(Owner) {}
709 bool operator==(const DelayImportDirectoryEntryRef &Other) const;
712 imported_symbol_iterator imported_symbol_begin() const;
713 imported_symbol_iterator imported_symbol_end() const;
714 iterator_range<imported_symbol_iterator> imported_symbols() const;
716 std::error_code getName(StringRef &Result) const;
717 std::error_code getDelayImportTable(
718 const delay_import_directory_table_entry *&Result) const;
721 const delay_import_directory_table_entry *Table;
723 const COFFObjectFile *OwningObject;
726 // The iterator for the export directory table entry.
727 class ExportDirectoryEntryRef {
729 ExportDirectoryEntryRef() : OwningObject(nullptr) {}
730 ExportDirectoryEntryRef(const export_directory_table_entry *Table, uint32_t I,
731 const COFFObjectFile *Owner)
732 : ExportTable(Table), Index(I), OwningObject(Owner) {}
734 bool operator==(const ExportDirectoryEntryRef &Other) const;
737 std::error_code getDllName(StringRef &Result) const;
738 std::error_code getOrdinalBase(uint32_t &Result) const;
739 std::error_code getOrdinal(uint32_t &Result) const;
740 std::error_code getExportRVA(uint32_t &Result) const;
741 std::error_code getSymbolName(StringRef &Result) const;
744 const export_directory_table_entry *ExportTable;
746 const COFFObjectFile *OwningObject;
749 class ImportedSymbolRef {
751 ImportedSymbolRef() : OwningObject(nullptr) {}
752 ImportedSymbolRef(const import_lookup_table_entry32 *Entry, uint32_t I,
753 const COFFObjectFile *Owner)
754 : Entry32(Entry), Entry64(nullptr), Index(I), OwningObject(Owner) {}
755 ImportedSymbolRef(const import_lookup_table_entry64 *Entry, uint32_t I,
756 const COFFObjectFile *Owner)
757 : Entry32(nullptr), Entry64(Entry), Index(I), OwningObject(Owner) {}
759 bool operator==(const ImportedSymbolRef &Other) const;
762 std::error_code getSymbolName(StringRef &Result) const;
763 std::error_code getOrdinal(uint16_t &Result) const;
766 const import_lookup_table_entry32 *Entry32;
767 const import_lookup_table_entry64 *Entry64;
769 const COFFObjectFile *OwningObject;
771 } // end namespace object
772 } // end namespace llvm