Bug Summary

File:lib/Object/COFFObjectFile.cpp
Warning:line 315, column 38
Called C++ object pointer is null

Annotated Source Code

/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp

1//===- COFFObjectFile.cpp - COFF object file implementation ---------------===//
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
14#include "llvm/ADT/ArrayRef.h"
15#include "llvm/ADT/StringRef.h"
16#include "llvm/ADT/Triple.h"
17#include "llvm/ADT/iterator_range.h"
18#include "llvm/BinaryFormat/COFF.h"
19#include "llvm/Object/Binary.h"
20#include "llvm/Object/COFF.h"
21#include "llvm/Object/Error.h"
22#include "llvm/Object/ObjectFile.h"
23#include "llvm/Support/BinaryStreamReader.h"
24#include "llvm/Support/Endian.h"
25#include "llvm/Support/Error.h"
26#include "llvm/Support/ErrorHandling.h"
27#include "llvm/Support/MathExtras.h"
28#include "llvm/Support/MemoryBuffer.h"
29#include <algorithm>
30#include <cassert>
31#include <cstddef>
32#include <cstdint>
33#include <cstring>
34#include <limits>
35#include <memory>
36#include <system_error>
37
38using namespace llvm;
39using namespace object;
40
41using support::ulittle16_t;
42using support::ulittle32_t;
43using support::ulittle64_t;
44using support::little16_t;
45
46// Returns false if size is greater than the buffer size. And sets ec.
47static bool checkSize(MemoryBufferRef M, std::error_code &EC, uint64_t Size) {
48 if (M.getBufferSize() < Size) {
49 EC = object_error::unexpected_eof;
50 return false;
51 }
52 return true;
53}
54
55// Sets Obj unless any bytes in [addr, addr + size) fall outsize of m.
56// Returns unexpected_eof if error.
57template <typename T>
58static std::error_code getObject(const T *&Obj, MemoryBufferRef M,
59 const void *Ptr,
60 const uint64_t Size = sizeof(T)) {
61 uintptr_t Addr = uintptr_t(Ptr);
62 if (std::error_code EC = Binary::checkOffset(M, Addr, Size))
63 return EC;
64 Obj = reinterpret_cast<const T *>(Addr);
65 return std::error_code();
66}
67
68// Decode a string table entry in base 64 (//AAAAAA). Expects \arg Str without
69// prefixed slashes.
70static bool decodeBase64StringEntry(StringRef Str, uint32_t &Result) {
71 assert(Str.size() <= 6 && "String too long, possible overflow.")(static_cast <bool> (Str.size() <= 6 && "String too long, possible overflow."
) ? void (0) : __assert_fail ("Str.size() <= 6 && \"String too long, possible overflow.\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 71, __extension__ __PRETTY_FUNCTION__))
;
72 if (Str.size() > 6)
73 return true;
74
75 uint64_t Value = 0;
76 while (!Str.empty()) {
77 unsigned CharVal;
78 if (Str[0] >= 'A' && Str[0] <= 'Z') // 0..25
79 CharVal = Str[0] - 'A';
80 else if (Str[0] >= 'a' && Str[0] <= 'z') // 26..51
81 CharVal = Str[0] - 'a' + 26;
82 else if (Str[0] >= '0' && Str[0] <= '9') // 52..61
83 CharVal = Str[0] - '0' + 52;
84 else if (Str[0] == '+') // 62
85 CharVal = 62;
86 else if (Str[0] == '/') // 63
87 CharVal = 63;
88 else
89 return true;
90
91 Value = (Value * 64) + CharVal;
92 Str = Str.substr(1);
93 }
94
95 if (Value > std::numeric_limits<uint32_t>::max())
96 return true;
97
98 Result = static_cast<uint32_t>(Value);
99 return false;
100}
101
102template <typename coff_symbol_type>
103const coff_symbol_type *COFFObjectFile::toSymb(DataRefImpl Ref) const {
104 const coff_symbol_type *Addr =
105 reinterpret_cast<const coff_symbol_type *>(Ref.p);
106
107 assert(!checkOffset(Data, uintptr_t(Addr), sizeof(*Addr)))(static_cast <bool> (!checkOffset(Data, uintptr_t(Addr)
, sizeof(*Addr))) ? void (0) : __assert_fail ("!checkOffset(Data, uintptr_t(Addr), sizeof(*Addr))"
, "/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 107, __extension__ __PRETTY_FUNCTION__))
;
108#ifndef NDEBUG
109 // Verify that the symbol points to a valid entry in the symbol table.
110 uintptr_t Offset = uintptr_t(Addr) - uintptr_t(base());
111
112 assert((Offset - getPointerToSymbolTable()) % sizeof(coff_symbol_type) == 0 &&(static_cast <bool> ((Offset - getPointerToSymbolTable(
)) % sizeof(coff_symbol_type) == 0 && "Symbol did not point to the beginning of a symbol"
) ? void (0) : __assert_fail ("(Offset - getPointerToSymbolTable()) % sizeof(coff_symbol_type) == 0 && \"Symbol did not point to the beginning of a symbol\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 113, __extension__ __PRETTY_FUNCTION__))
113 "Symbol did not point to the beginning of a symbol")(static_cast <bool> ((Offset - getPointerToSymbolTable(
)) % sizeof(coff_symbol_type) == 0 && "Symbol did not point to the beginning of a symbol"
) ? void (0) : __assert_fail ("(Offset - getPointerToSymbolTable()) % sizeof(coff_symbol_type) == 0 && \"Symbol did not point to the beginning of a symbol\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 113, __extension__ __PRETTY_FUNCTION__))
;
114#endif
115
116 return Addr;
117}
118
119const coff_section *COFFObjectFile::toSec(DataRefImpl Ref) const {
120 const coff_section *Addr = reinterpret_cast<const coff_section*>(Ref.p);
121
122#ifndef NDEBUG
123 // Verify that the section points to a valid entry in the section table.
124 if (Addr < SectionTable || Addr >= (SectionTable + getNumberOfSections()))
125 report_fatal_error("Section was outside of section table.");
126
127 uintptr_t Offset = uintptr_t(Addr) - uintptr_t(SectionTable);
128 assert(Offset % sizeof(coff_section) == 0 &&(static_cast <bool> (Offset % sizeof(coff_section) == 0
&& "Section did not point to the beginning of a section"
) ? void (0) : __assert_fail ("Offset % sizeof(coff_section) == 0 && \"Section did not point to the beginning of a section\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 129, __extension__ __PRETTY_FUNCTION__))
129 "Section did not point to the beginning of a section")(static_cast <bool> (Offset % sizeof(coff_section) == 0
&& "Section did not point to the beginning of a section"
) ? void (0) : __assert_fail ("Offset % sizeof(coff_section) == 0 && \"Section did not point to the beginning of a section\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 129, __extension__ __PRETTY_FUNCTION__))
;
130#endif
131
132 return Addr;
133}
134
135void COFFObjectFile::moveSymbolNext(DataRefImpl &Ref) const {
136 auto End = reinterpret_cast<uintptr_t>(StringTable);
137 if (SymbolTable16) {
138 const coff_symbol16 *Symb = toSymb<coff_symbol16>(Ref);
139 Symb += 1 + Symb->NumberOfAuxSymbols;
140 Ref.p = std::min(reinterpret_cast<uintptr_t>(Symb), End);
141 } else if (SymbolTable32) {
142 const coff_symbol32 *Symb = toSymb<coff_symbol32>(Ref);
143 Symb += 1 + Symb->NumberOfAuxSymbols;
144 Ref.p = std::min(reinterpret_cast<uintptr_t>(Symb), End);
145 } else {
146 llvm_unreachable("no symbol table pointer!")::llvm::llvm_unreachable_internal("no symbol table pointer!",
"/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 146)
;
147 }
148}
149
150Expected<StringRef> COFFObjectFile::getSymbolName(DataRefImpl Ref) const {
151 COFFSymbolRef Symb = getCOFFSymbol(Ref);
152 StringRef Result;
153 if (std::error_code EC = getSymbolName(Symb, Result))
154 return errorCodeToError(EC);
155 return Result;
156}
157
158uint64_t COFFObjectFile::getSymbolValueImpl(DataRefImpl Ref) const {
159 return getCOFFSymbol(Ref).getValue();
160}
161
162uint32_t COFFObjectFile::getSymbolAlignment(DataRefImpl Ref) const {
163 // MSVC/link.exe seems to align symbols to the next-power-of-2
164 // up to 32 bytes.
165 COFFSymbolRef Symb = getCOFFSymbol(Ref);
166 return std::min(uint64_t(32), PowerOf2Ceil(Symb.getValue()));
167}
168
169Expected<uint64_t> COFFObjectFile::getSymbolAddress(DataRefImpl Ref) const {
170 uint64_t Result = getSymbolValue(Ref);
171 COFFSymbolRef Symb = getCOFFSymbol(Ref);
172 int32_t SectionNumber = Symb.getSectionNumber();
173
174 if (Symb.isAnyUndefined() || Symb.isCommon() ||
175 COFF::isReservedSectionNumber(SectionNumber))
176 return Result;
177
178 const coff_section *Section = nullptr;
179 if (std::error_code EC = getSection(SectionNumber, Section))
180 return errorCodeToError(EC);
181 Result += Section->VirtualAddress;
182
183 // The section VirtualAddress does not include ImageBase, and we want to
184 // return virtual addresses.
185 Result += getImageBase();
186
187 return Result;
188}
189
190Expected<SymbolRef::Type> COFFObjectFile::getSymbolType(DataRefImpl Ref) const {
191 COFFSymbolRef Symb = getCOFFSymbol(Ref);
192 int32_t SectionNumber = Symb.getSectionNumber();
193
194 if (Symb.getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION)
195 return SymbolRef::ST_Function;
196 if (Symb.isAnyUndefined())
197 return SymbolRef::ST_Unknown;
198 if (Symb.isCommon())
199 return SymbolRef::ST_Data;
200 if (Symb.isFileRecord())
201 return SymbolRef::ST_File;
202
203 // TODO: perhaps we need a new symbol type ST_Section.
204 if (SectionNumber == COFF::IMAGE_SYM_DEBUG || Symb.isSectionDefinition())
205 return SymbolRef::ST_Debug;
206
207 if (!COFF::isReservedSectionNumber(SectionNumber))
208 return SymbolRef::ST_Data;
209
210 return SymbolRef::ST_Other;
211}
212
213uint32_t COFFObjectFile::getSymbolFlags(DataRefImpl Ref) const {
214 COFFSymbolRef Symb = getCOFFSymbol(Ref);
215 uint32_t Result = SymbolRef::SF_None;
216
217 if (Symb.isExternal() || Symb.isWeakExternal())
218 Result |= SymbolRef::SF_Global;
219
220 if (Symb.isWeakExternal()) {
221 Result |= SymbolRef::SF_Weak;
222 // We use indirect to allow the archiver to write weak externs
223 Result |= SymbolRef::SF_Indirect;
224 }
225
226 if (Symb.getSectionNumber() == COFF::IMAGE_SYM_ABSOLUTE)
227 Result |= SymbolRef::SF_Absolute;
228
229 if (Symb.isFileRecord())
230 Result |= SymbolRef::SF_FormatSpecific;
231
232 if (Symb.isSectionDefinition())
233 Result |= SymbolRef::SF_FormatSpecific;
234
235 if (Symb.isCommon())
236 Result |= SymbolRef::SF_Common;
237
238 if (Symb.isAnyUndefined())
239 Result |= SymbolRef::SF_Undefined;
240
241 return Result;
242}
243
244uint64_t COFFObjectFile::getCommonSymbolSizeImpl(DataRefImpl Ref) const {
245 COFFSymbolRef Symb = getCOFFSymbol(Ref);
246 return Symb.getValue();
1
Calling 'COFFSymbolRef::getValue'
247}
248
249Expected<section_iterator>
250COFFObjectFile::getSymbolSection(DataRefImpl Ref) const {
251 COFFSymbolRef Symb = getCOFFSymbol(Ref);
252 if (COFF::isReservedSectionNumber(Symb.getSectionNumber()))
253 return section_end();
254 const coff_section *Sec = nullptr;
255 if (std::error_code EC = getSection(Symb.getSectionNumber(), Sec))
256 return errorCodeToError(EC);
257 DataRefImpl Ret;
258 Ret.p = reinterpret_cast<uintptr_t>(Sec);
259 return section_iterator(SectionRef(Ret, this));
260}
261
262unsigned COFFObjectFile::getSymbolSectionID(SymbolRef Sym) const {
263 COFFSymbolRef Symb = getCOFFSymbol(Sym.getRawDataRefImpl());
264 return Symb.getSectionNumber();
265}
266
267void COFFObjectFile::moveSectionNext(DataRefImpl &Ref) const {
268 const coff_section *Sec = toSec(Ref);
269 Sec += 1;
270 Ref.p = reinterpret_cast<uintptr_t>(Sec);
271}
272
273std::error_code COFFObjectFile::getSectionName(DataRefImpl Ref,
274 StringRef &Result) const {
275 const coff_section *Sec = toSec(Ref);
276 return getSectionName(Sec, Result);
277}
278
279uint64_t COFFObjectFile::getSectionAddress(DataRefImpl Ref) const {
280 const coff_section *Sec = toSec(Ref);
281 uint64_t Result = Sec->VirtualAddress;
282
283 // The section VirtualAddress does not include ImageBase, and we want to
284 // return virtual addresses.
285 Result += getImageBase();
286 return Result;
287}
288
289uint64_t COFFObjectFile::getSectionIndex(DataRefImpl Sec) const {
290 return toSec(Sec) - SectionTable;
291}
292
293uint64_t COFFObjectFile::getSectionSize(DataRefImpl Ref) const {
294 return getSectionSize(toSec(Ref));
295}
296
297std::error_code COFFObjectFile::getSectionContents(DataRefImpl Ref,
298 StringRef &Result) const {
299 const coff_section *Sec = toSec(Ref);
300 ArrayRef<uint8_t> Res;
301 std::error_code EC = getSectionContents(Sec, Res);
302 Result = StringRef(reinterpret_cast<const char*>(Res.data()), Res.size());
303 return EC;
304}
305
306uint64_t COFFObjectFile::getSectionAlignment(DataRefImpl Ref) const {
307 const coff_section *Sec = toSec(Ref);
308 return Sec->getAlignment();
309}
310
311bool COFFObjectFile::isSectionCompressed(DataRefImpl Sec) const {
312 return false;
313}
314
315bool COFFObjectFile::isSectionText(DataRefImpl Ref) const {
316 const coff_section *Sec = toSec(Ref);
317 return Sec->Characteristics & COFF::IMAGE_SCN_CNT_CODE;
318}
319
320bool COFFObjectFile::isSectionData(DataRefImpl Ref) const {
321 const coff_section *Sec = toSec(Ref);
322 return Sec->Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA;
323}
324
325bool COFFObjectFile::isSectionBSS(DataRefImpl Ref) const {
326 const coff_section *Sec = toSec(Ref);
327 const uint32_t BssFlags = COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA |
328 COFF::IMAGE_SCN_MEM_READ |
329 COFF::IMAGE_SCN_MEM_WRITE;
330 return (Sec->Characteristics & BssFlags) == BssFlags;
331}
332
333unsigned COFFObjectFile::getSectionID(SectionRef Sec) const {
334 uintptr_t Offset =
335 uintptr_t(Sec.getRawDataRefImpl().p) - uintptr_t(SectionTable);
336 assert((Offset % sizeof(coff_section)) == 0)(static_cast <bool> ((Offset % sizeof(coff_section)) ==
0) ? void (0) : __assert_fail ("(Offset % sizeof(coff_section)) == 0"
, "/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 336, __extension__ __PRETTY_FUNCTION__))
;
337 return (Offset / sizeof(coff_section)) + 1;
338}
339
340bool COFFObjectFile::isSectionVirtual(DataRefImpl Ref) const {
341 const coff_section *Sec = toSec(Ref);
342 // In COFF, a virtual section won't have any in-file
343 // content, so the file pointer to the content will be zero.
344 return Sec->PointerToRawData == 0;
345}
346
347static uint32_t getNumberOfRelocations(const coff_section *Sec,
348 MemoryBufferRef M, const uint8_t *base) {
349 // The field for the number of relocations in COFF section table is only
350 // 16-bit wide. If a section has more than 65535 relocations, 0xFFFF is set to
351 // NumberOfRelocations field, and the actual relocation count is stored in the
352 // VirtualAddress field in the first relocation entry.
353 if (Sec->hasExtendedRelocations()) {
354 const coff_relocation *FirstReloc;
355 if (getObject(FirstReloc, M, reinterpret_cast<const coff_relocation*>(
356 base + Sec->PointerToRelocations)))
357 return 0;
358 // -1 to exclude this first relocation entry.
359 return FirstReloc->VirtualAddress - 1;
360 }
361 return Sec->NumberOfRelocations;
362}
363
364static const coff_relocation *
365getFirstReloc(const coff_section *Sec, MemoryBufferRef M, const uint8_t *Base) {
366 uint64_t NumRelocs = getNumberOfRelocations(Sec, M, Base);
367 if (!NumRelocs)
368 return nullptr;
369 auto begin = reinterpret_cast<const coff_relocation *>(
370 Base + Sec->PointerToRelocations);
371 if (Sec->hasExtendedRelocations()) {
372 // Skip the first relocation entry repurposed to store the number of
373 // relocations.
374 begin++;
375 }
376 if (Binary::checkOffset(M, uintptr_t(begin),
377 sizeof(coff_relocation) * NumRelocs))
378 return nullptr;
379 return begin;
380}
381
382relocation_iterator COFFObjectFile::section_rel_begin(DataRefImpl Ref) const {
383 const coff_section *Sec = toSec(Ref);
384 const coff_relocation *begin = getFirstReloc(Sec, Data, base());
385 if (begin && Sec->VirtualAddress != 0)
386 report_fatal_error("Sections with relocations should have an address of 0");
387 DataRefImpl Ret;
388 Ret.p = reinterpret_cast<uintptr_t>(begin);
389 return relocation_iterator(RelocationRef(Ret, this));
390}
391
392relocation_iterator COFFObjectFile::section_rel_end(DataRefImpl Ref) const {
393 const coff_section *Sec = toSec(Ref);
394 const coff_relocation *I = getFirstReloc(Sec, Data, base());
395 if (I)
396 I += getNumberOfRelocations(Sec, Data, base());
397 DataRefImpl Ret;
398 Ret.p = reinterpret_cast<uintptr_t>(I);
399 return relocation_iterator(RelocationRef(Ret, this));
400}
401
402// Initialize the pointer to the symbol table.
403std::error_code COFFObjectFile::initSymbolTablePtr() {
404 if (COFFHeader)
405 if (std::error_code EC = getObject(
406 SymbolTable16, Data, base() + getPointerToSymbolTable(),
407 (uint64_t)getNumberOfSymbols() * getSymbolTableEntrySize()))
408 return EC;
409
410 if (COFFBigObjHeader)
411 if (std::error_code EC = getObject(
412 SymbolTable32, Data, base() + getPointerToSymbolTable(),
413 (uint64_t)getNumberOfSymbols() * getSymbolTableEntrySize()))
414 return EC;
415
416 // Find string table. The first four byte of the string table contains the
417 // total size of the string table, including the size field itself. If the
418 // string table is empty, the value of the first four byte would be 4.
419 uint32_t StringTableOffset = getPointerToSymbolTable() +
420 getNumberOfSymbols() * getSymbolTableEntrySize();
421 const uint8_t *StringTableAddr = base() + StringTableOffset;
422 const ulittle32_t *StringTableSizePtr;
423 if (std::error_code EC = getObject(StringTableSizePtr, Data, StringTableAddr))
424 return EC;
425 StringTableSize = *StringTableSizePtr;
426 if (std::error_code EC =
427 getObject(StringTable, Data, StringTableAddr, StringTableSize))
428 return EC;
429
430 // Treat table sizes < 4 as empty because contrary to the PECOFF spec, some
431 // tools like cvtres write a size of 0 for an empty table instead of 4.
432 if (StringTableSize < 4)
433 StringTableSize = 4;
434
435 // Check that the string table is null terminated if has any in it.
436 if (StringTableSize > 4 && StringTable[StringTableSize - 1] != 0)
437 return object_error::parse_failed;
438 return std::error_code();
439}
440
441uint64_t COFFObjectFile::getImageBase() const {
442 if (PE32Header)
443 return PE32Header->ImageBase;
444 else if (PE32PlusHeader)
445 return PE32PlusHeader->ImageBase;
446 // This actually comes up in practice.
447 return 0;
448}
449
450// Returns the file offset for the given VA.
451std::error_code COFFObjectFile::getVaPtr(uint64_t Addr, uintptr_t &Res) const {
452 uint64_t ImageBase = getImageBase();
453 uint64_t Rva = Addr - ImageBase;
454 assert(Rva <= UINT32_MAX)(static_cast <bool> (Rva <= (4294967295U)) ? void (0
) : __assert_fail ("Rva <= UINT32_MAX", "/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 454, __extension__ __PRETTY_FUNCTION__))
;
455 return getRvaPtr((uint32_t)Rva, Res);
456}
457
458// Returns the file offset for the given RVA.
459std::error_code COFFObjectFile::getRvaPtr(uint32_t Addr, uintptr_t &Res) const {
460 for (const SectionRef &S : sections()) {
461 const coff_section *Section = getCOFFSection(S);
462 uint32_t SectionStart = Section->VirtualAddress;
463 uint32_t SectionEnd = Section->VirtualAddress + Section->VirtualSize;
464 if (SectionStart <= Addr && Addr < SectionEnd) {
465 uint32_t Offset = Addr - SectionStart;
466 Res = uintptr_t(base()) + Section->PointerToRawData + Offset;
467 return std::error_code();
468 }
469 }
470 return object_error::parse_failed;
471}
472
473std::error_code
474COFFObjectFile::getRvaAndSizeAsBytes(uint32_t RVA, uint32_t Size,
475 ArrayRef<uint8_t> &Contents) const {
476 for (const SectionRef &S : sections()) {
477 const coff_section *Section = getCOFFSection(S);
478 uint32_t SectionStart = Section->VirtualAddress;
479 // Check if this RVA is within the section bounds. Be careful about integer
480 // overflow.
481 uint32_t OffsetIntoSection = RVA - SectionStart;
482 if (SectionStart <= RVA && OffsetIntoSection < Section->VirtualSize &&
483 Size <= Section->VirtualSize - OffsetIntoSection) {
484 uintptr_t Begin =
485 uintptr_t(base()) + Section->PointerToRawData + OffsetIntoSection;
486 Contents =
487 ArrayRef<uint8_t>(reinterpret_cast<const uint8_t *>(Begin), Size);
488 return std::error_code();
489 }
490 }
491 return object_error::parse_failed;
492}
493
494// Returns hint and name fields, assuming \p Rva is pointing to a Hint/Name
495// table entry.
496std::error_code COFFObjectFile::getHintName(uint32_t Rva, uint16_t &Hint,
497 StringRef &Name) const {
498 uintptr_t IntPtr = 0;
499 if (std::error_code EC = getRvaPtr(Rva, IntPtr))
500 return EC;
501 const uint8_t *Ptr = reinterpret_cast<const uint8_t *>(IntPtr);
502 Hint = *reinterpret_cast<const ulittle16_t *>(Ptr);
503 Name = StringRef(reinterpret_cast<const char *>(Ptr + 2));
504 return std::error_code();
505}
506
507std::error_code
508COFFObjectFile::getDebugPDBInfo(const debug_directory *DebugDir,
509 const codeview::DebugInfo *&PDBInfo,
510 StringRef &PDBFileName) const {
511 ArrayRef<uint8_t> InfoBytes;
512 if (std::error_code EC = getRvaAndSizeAsBytes(
513 DebugDir->AddressOfRawData, DebugDir->SizeOfData, InfoBytes))
514 return EC;
515 if (InfoBytes.size() < sizeof(*PDBInfo) + 1)
516 return object_error::parse_failed;
517 PDBInfo = reinterpret_cast<const codeview::DebugInfo *>(InfoBytes.data());
518 InfoBytes = InfoBytes.drop_front(sizeof(*PDBInfo));
519 PDBFileName = StringRef(reinterpret_cast<const char *>(InfoBytes.data()),
520 InfoBytes.size());
521 // Truncate the name at the first null byte. Ignore any padding.
522 PDBFileName = PDBFileName.split('\0').first;
523 return std::error_code();
524}
525
526std::error_code
527COFFObjectFile::getDebugPDBInfo(const codeview::DebugInfo *&PDBInfo,
528 StringRef &PDBFileName) const {
529 for (const debug_directory &D : debug_directories())
530 if (D.Type == COFF::IMAGE_DEBUG_TYPE_CODEVIEW)
531 return getDebugPDBInfo(&D, PDBInfo, PDBFileName);
532 // If we get here, there is no PDB info to return.
533 PDBInfo = nullptr;
534 PDBFileName = StringRef();
535 return std::error_code();
536}
537
538// Find the import table.
539std::error_code COFFObjectFile::initImportTablePtr() {
540 // First, we get the RVA of the import table. If the file lacks a pointer to
541 // the import table, do nothing.
542 const data_directory *DataEntry;
543 if (getDataDirectory(COFF::IMPORT_TABLE, DataEntry))
544 return std::error_code();
545
546 // Do nothing if the pointer to import table is NULL.
547 if (DataEntry->RelativeVirtualAddress == 0)
548 return std::error_code();
549
550 uint32_t ImportTableRva = DataEntry->RelativeVirtualAddress;
551
552 // Find the section that contains the RVA. This is needed because the RVA is
553 // the import table's memory address which is different from its file offset.
554 uintptr_t IntPtr = 0;
555 if (std::error_code EC = getRvaPtr(ImportTableRva, IntPtr))
556 return EC;
557 if (std::error_code EC = checkOffset(Data, IntPtr, DataEntry->Size))
558 return EC;
559 ImportDirectory = reinterpret_cast<
560 const coff_import_directory_table_entry *>(IntPtr);
561 return std::error_code();
562}
563
564// Initializes DelayImportDirectory and NumberOfDelayImportDirectory.
565std::error_code COFFObjectFile::initDelayImportTablePtr() {
566 const data_directory *DataEntry;
567 if (getDataDirectory(COFF::DELAY_IMPORT_DESCRIPTOR, DataEntry))
568 return std::error_code();
569 if (DataEntry->RelativeVirtualAddress == 0)
570 return std::error_code();
571
572 uint32_t RVA = DataEntry->RelativeVirtualAddress;
573 NumberOfDelayImportDirectory = DataEntry->Size /
574 sizeof(delay_import_directory_table_entry) - 1;
575
576 uintptr_t IntPtr = 0;
577 if (std::error_code EC = getRvaPtr(RVA, IntPtr))
578 return EC;
579 DelayImportDirectory = reinterpret_cast<
580 const delay_import_directory_table_entry *>(IntPtr);
581 return std::error_code();
582}
583
584// Find the export table.
585std::error_code COFFObjectFile::initExportTablePtr() {
586 // First, we get the RVA of the export table. If the file lacks a pointer to
587 // the export table, do nothing.
588 const data_directory *DataEntry;
589 if (getDataDirectory(COFF::EXPORT_TABLE, DataEntry))
590 return std::error_code();
591
592 // Do nothing if the pointer to export table is NULL.
593 if (DataEntry->RelativeVirtualAddress == 0)
594 return std::error_code();
595
596 uint32_t ExportTableRva = DataEntry->RelativeVirtualAddress;
597 uintptr_t IntPtr = 0;
598 if (std::error_code EC = getRvaPtr(ExportTableRva, IntPtr))
599 return EC;
600 ExportDirectory =
601 reinterpret_cast<const export_directory_table_entry *>(IntPtr);
602 return std::error_code();
603}
604
605std::error_code COFFObjectFile::initBaseRelocPtr() {
606 const data_directory *DataEntry;
607 if (getDataDirectory(COFF::BASE_RELOCATION_TABLE, DataEntry))
608 return std::error_code();
609 if (DataEntry->RelativeVirtualAddress == 0)
610 return std::error_code();
611
612 uintptr_t IntPtr = 0;
613 if (std::error_code EC = getRvaPtr(DataEntry->RelativeVirtualAddress, IntPtr))
614 return EC;
615 BaseRelocHeader = reinterpret_cast<const coff_base_reloc_block_header *>(
616 IntPtr);
617 BaseRelocEnd = reinterpret_cast<coff_base_reloc_block_header *>(
618 IntPtr + DataEntry->Size);
619 return std::error_code();
620}
621
622std::error_code COFFObjectFile::initDebugDirectoryPtr() {
623 // Get the RVA of the debug directory. Do nothing if it does not exist.
624 const data_directory *DataEntry;
625 if (getDataDirectory(COFF::DEBUG_DIRECTORY, DataEntry))
626 return std::error_code();
627
628 // Do nothing if the RVA is NULL.
629 if (DataEntry->RelativeVirtualAddress == 0)
630 return std::error_code();
631
632 // Check that the size is a multiple of the entry size.
633 if (DataEntry->Size % sizeof(debug_directory) != 0)
634 return object_error::parse_failed;
635
636 uintptr_t IntPtr = 0;
637 if (std::error_code EC = getRvaPtr(DataEntry->RelativeVirtualAddress, IntPtr))
638 return EC;
639 DebugDirectoryBegin = reinterpret_cast<const debug_directory *>(IntPtr);
640 if (std::error_code EC = getRvaPtr(
641 DataEntry->RelativeVirtualAddress + DataEntry->Size, IntPtr))
642 return EC;
643 DebugDirectoryEnd = reinterpret_cast<const debug_directory *>(IntPtr);
644 return std::error_code();
645}
646
647std::error_code COFFObjectFile::initLoadConfigPtr() {
648 // Get the RVA of the debug directory. Do nothing if it does not exist.
649 const data_directory *DataEntry;
650 if (getDataDirectory(COFF::LOAD_CONFIG_TABLE, DataEntry))
651 return std::error_code();
652
653 // Do nothing if the RVA is NULL.
654 if (DataEntry->RelativeVirtualAddress == 0)
655 return std::error_code();
656 uintptr_t IntPtr = 0;
657 if (std::error_code EC = getRvaPtr(DataEntry->RelativeVirtualAddress, IntPtr))
658 return EC;
659
660 LoadConfig = (const void *)IntPtr;
661 return std::error_code();
662}
663
664COFFObjectFile::COFFObjectFile(MemoryBufferRef Object, std::error_code &EC)
665 : ObjectFile(Binary::ID_COFF, Object), COFFHeader(nullptr),
666 COFFBigObjHeader(nullptr), PE32Header(nullptr), PE32PlusHeader(nullptr),
667 DataDirectory(nullptr), SectionTable(nullptr), SymbolTable16(nullptr),
668 SymbolTable32(nullptr), StringTable(nullptr), StringTableSize(0),
669 ImportDirectory(nullptr),
670 DelayImportDirectory(nullptr), NumberOfDelayImportDirectory(0),
671 ExportDirectory(nullptr), BaseRelocHeader(nullptr), BaseRelocEnd(nullptr),
672 DebugDirectoryBegin(nullptr), DebugDirectoryEnd(nullptr) {
673 // Check that we at least have enough room for a header.
674 if (!checkSize(Data, EC, sizeof(coff_file_header)))
675 return;
676
677 // The current location in the file where we are looking at.
678 uint64_t CurPtr = 0;
679
680 // PE header is optional and is present only in executables. If it exists,
681 // it is placed right after COFF header.
682 bool HasPEHeader = false;
683
684 // Check if this is a PE/COFF file.
685 if (checkSize(Data, EC, sizeof(dos_header) + sizeof(COFF::PEMagic))) {
686 // PE/COFF, seek through MS-DOS compatibility stub and 4-byte
687 // PE signature to find 'normal' COFF header.
688 const auto *DH = reinterpret_cast<const dos_header *>(base());
689 if (DH->Magic[0] == 'M' && DH->Magic[1] == 'Z') {
690 CurPtr = DH->AddressOfNewExeHeader;
691 // Check the PE magic bytes. ("PE\0\0")
692 if (memcmp(base() + CurPtr, COFF::PEMagic, sizeof(COFF::PEMagic)) != 0) {
693 EC = object_error::parse_failed;
694 return;
695 }
696 CurPtr += sizeof(COFF::PEMagic); // Skip the PE magic bytes.
697 HasPEHeader = true;
698 }
699 }
700
701 if ((EC = getObject(COFFHeader, Data, base() + CurPtr)))
702 return;
703
704 // It might be a bigobj file, let's check. Note that COFF bigobj and COFF
705 // import libraries share a common prefix but bigobj is more restrictive.
706 if (!HasPEHeader && COFFHeader->Machine == COFF::IMAGE_FILE_MACHINE_UNKNOWN &&
707 COFFHeader->NumberOfSections == uint16_t(0xffff) &&
708 checkSize(Data, EC, sizeof(coff_bigobj_file_header))) {
709 if ((EC = getObject(COFFBigObjHeader, Data, base() + CurPtr)))
710 return;
711
712 // Verify that we are dealing with bigobj.
713 if (COFFBigObjHeader->Version >= COFF::BigObjHeader::MinBigObjectVersion &&
714 std::memcmp(COFFBigObjHeader->UUID, COFF::BigObjMagic,
715 sizeof(COFF::BigObjMagic)) == 0) {
716 COFFHeader = nullptr;
717 CurPtr += sizeof(coff_bigobj_file_header);
718 } else {
719 // It's not a bigobj.
720 COFFBigObjHeader = nullptr;
721 }
722 }
723 if (COFFHeader) {
724 // The prior checkSize call may have failed. This isn't a hard error
725 // because we were just trying to sniff out bigobj.
726 EC = std::error_code();
727 CurPtr += sizeof(coff_file_header);
728
729 if (COFFHeader->isImportLibrary())
730 return;
731 }
732
733 if (HasPEHeader) {
734 const pe32_header *Header;
735 if ((EC = getObject(Header, Data, base() + CurPtr)))
736 return;
737
738 const uint8_t *DataDirAddr;
739 uint64_t DataDirSize;
740 if (Header->Magic == COFF::PE32Header::PE32) {
741 PE32Header = Header;
742 DataDirAddr = base() + CurPtr + sizeof(pe32_header);
743 DataDirSize = sizeof(data_directory) * PE32Header->NumberOfRvaAndSize;
744 } else if (Header->Magic == COFF::PE32Header::PE32_PLUS) {
745 PE32PlusHeader = reinterpret_cast<const pe32plus_header *>(Header);
746 DataDirAddr = base() + CurPtr + sizeof(pe32plus_header);
747 DataDirSize = sizeof(data_directory) * PE32PlusHeader->NumberOfRvaAndSize;
748 } else {
749 // It's neither PE32 nor PE32+.
750 EC = object_error::parse_failed;
751 return;
752 }
753 if ((EC = getObject(DataDirectory, Data, DataDirAddr, DataDirSize)))
754 return;
755 }
756
757 if (COFFHeader)
758 CurPtr += COFFHeader->SizeOfOptionalHeader;
759
760 if ((EC = getObject(SectionTable, Data, base() + CurPtr,
761 (uint64_t)getNumberOfSections() * sizeof(coff_section))))
762 return;
763
764 // Initialize the pointer to the symbol table.
765 if (getPointerToSymbolTable() != 0) {
766 if ((EC = initSymbolTablePtr())) {
767 SymbolTable16 = nullptr;
768 SymbolTable32 = nullptr;
769 StringTable = nullptr;
770 StringTableSize = 0;
771 }
772 } else {
773 // We had better not have any symbols if we don't have a symbol table.
774 if (getNumberOfSymbols() != 0) {
775 EC = object_error::parse_failed;
776 return;
777 }
778 }
779
780 // Initialize the pointer to the beginning of the import table.
781 if ((EC = initImportTablePtr()))
782 return;
783 if ((EC = initDelayImportTablePtr()))
784 return;
785
786 // Initialize the pointer to the export table.
787 if ((EC = initExportTablePtr()))
788 return;
789
790 // Initialize the pointer to the base relocation table.
791 if ((EC = initBaseRelocPtr()))
792 return;
793
794 // Initialize the pointer to the export table.
795 if ((EC = initDebugDirectoryPtr()))
796 return;
797
798 if ((EC = initLoadConfigPtr()))
799 return;
800
801 EC = std::error_code();
802}
803
804basic_symbol_iterator COFFObjectFile::symbol_begin() const {
805 DataRefImpl Ret;
806 Ret.p = getSymbolTable();
807 return basic_symbol_iterator(SymbolRef(Ret, this));
808}
809
810basic_symbol_iterator COFFObjectFile::symbol_end() const {
811 // The symbol table ends where the string table begins.
812 DataRefImpl Ret;
813 Ret.p = reinterpret_cast<uintptr_t>(StringTable);
814 return basic_symbol_iterator(SymbolRef(Ret, this));
815}
816
817import_directory_iterator COFFObjectFile::import_directory_begin() const {
818 if (!ImportDirectory)
819 return import_directory_end();
820 if (ImportDirectory->isNull())
821 return import_directory_end();
822 return import_directory_iterator(
823 ImportDirectoryEntryRef(ImportDirectory, 0, this));
824}
825
826import_directory_iterator COFFObjectFile::import_directory_end() const {
827 return import_directory_iterator(
828 ImportDirectoryEntryRef(nullptr, -1, this));
829}
830
831delay_import_directory_iterator
832COFFObjectFile::delay_import_directory_begin() const {
833 return delay_import_directory_iterator(
834 DelayImportDirectoryEntryRef(DelayImportDirectory, 0, this));
835}
836
837delay_import_directory_iterator
838COFFObjectFile::delay_import_directory_end() const {
839 return delay_import_directory_iterator(
840 DelayImportDirectoryEntryRef(
841 DelayImportDirectory, NumberOfDelayImportDirectory, this));
842}
843
844export_directory_iterator COFFObjectFile::export_directory_begin() const {
845 return export_directory_iterator(
846 ExportDirectoryEntryRef(ExportDirectory, 0, this));
847}
848
849export_directory_iterator COFFObjectFile::export_directory_end() const {
850 if (!ExportDirectory)
851 return export_directory_iterator(ExportDirectoryEntryRef(nullptr, 0, this));
852 ExportDirectoryEntryRef Ref(ExportDirectory,
853 ExportDirectory->AddressTableEntries, this);
854 return export_directory_iterator(Ref);
855}
856
857section_iterator COFFObjectFile::section_begin() const {
858 DataRefImpl Ret;
859 Ret.p = reinterpret_cast<uintptr_t>(SectionTable);
860 return section_iterator(SectionRef(Ret, this));
861}
862
863section_iterator COFFObjectFile::section_end() const {
864 DataRefImpl Ret;
865 int NumSections =
866 COFFHeader && COFFHeader->isImportLibrary() ? 0 : getNumberOfSections();
867 Ret.p = reinterpret_cast<uintptr_t>(SectionTable + NumSections);
868 return section_iterator(SectionRef(Ret, this));
869}
870
871base_reloc_iterator COFFObjectFile::base_reloc_begin() const {
872 return base_reloc_iterator(BaseRelocRef(BaseRelocHeader, this));
873}
874
875base_reloc_iterator COFFObjectFile::base_reloc_end() const {
876 return base_reloc_iterator(BaseRelocRef(BaseRelocEnd, this));
877}
878
879uint8_t COFFObjectFile::getBytesInAddress() const {
880 return getArch() == Triple::x86_64 || getArch() == Triple::aarch64 ? 8 : 4;
881}
882
883StringRef COFFObjectFile::getFileFormatName() const {
884 switch(getMachine()) {
885 case COFF::IMAGE_FILE_MACHINE_I386:
886 return "COFF-i386";
887 case COFF::IMAGE_FILE_MACHINE_AMD64:
888 return "COFF-x86-64";
889 case COFF::IMAGE_FILE_MACHINE_ARMNT:
890 return "COFF-ARM";
891 case COFF::IMAGE_FILE_MACHINE_ARM64:
892 return "COFF-ARM64";
893 default:
894 return "COFF-<unknown arch>";
895 }
896}
897
898unsigned COFFObjectFile::getArch() const {
899 switch (getMachine()) {
900 case COFF::IMAGE_FILE_MACHINE_I386:
901 return Triple::x86;
902 case COFF::IMAGE_FILE_MACHINE_AMD64:
903 return Triple::x86_64;
904 case COFF::IMAGE_FILE_MACHINE_ARMNT:
905 return Triple::thumb;
906 case COFF::IMAGE_FILE_MACHINE_ARM64:
907 return Triple::aarch64;
908 default:
909 return Triple::UnknownArch;
910 }
911}
912
913iterator_range<import_directory_iterator>
914COFFObjectFile::import_directories() const {
915 return make_range(import_directory_begin(), import_directory_end());
916}
917
918iterator_range<delay_import_directory_iterator>
919COFFObjectFile::delay_import_directories() const {
920 return make_range(delay_import_directory_begin(),
921 delay_import_directory_end());
922}
923
924iterator_range<export_directory_iterator>
925COFFObjectFile::export_directories() const {
926 return make_range(export_directory_begin(), export_directory_end());
927}
928
929iterator_range<base_reloc_iterator> COFFObjectFile::base_relocs() const {
930 return make_range(base_reloc_begin(), base_reloc_end());
931}
932
933std::error_code COFFObjectFile::getPE32Header(const pe32_header *&Res) const {
934 Res = PE32Header;
935 return std::error_code();
936}
937
938std::error_code
939COFFObjectFile::getPE32PlusHeader(const pe32plus_header *&Res) const {
940 Res = PE32PlusHeader;
941 return std::error_code();
942}
943
944std::error_code
945COFFObjectFile::getDataDirectory(uint32_t Index,
946 const data_directory *&Res) const {
947 // Error if if there's no data directory or the index is out of range.
948 if (!DataDirectory) {
949 Res = nullptr;
950 return object_error::parse_failed;
951 }
952 assert(PE32Header || PE32PlusHeader)(static_cast <bool> (PE32Header || PE32PlusHeader) ? void
(0) : __assert_fail ("PE32Header || PE32PlusHeader", "/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 952, __extension__ __PRETTY_FUNCTION__))
;
953 uint32_t NumEnt = PE32Header ? PE32Header->NumberOfRvaAndSize
954 : PE32PlusHeader->NumberOfRvaAndSize;
955 if (Index >= NumEnt) {
956 Res = nullptr;
957 return object_error::parse_failed;
958 }
959 Res = &DataDirectory[Index];
960 return std::error_code();
961}
962
963std::error_code COFFObjectFile::getSection(int32_t Index,
964 const coff_section *&Result) const {
965 Result = nullptr;
966 if (COFF::isReservedSectionNumber(Index))
967 return std::error_code();
968 if (static_cast<uint32_t>(Index) <= getNumberOfSections()) {
969 // We already verified the section table data, so no need to check again.
970 Result = SectionTable + (Index - 1);
971 return std::error_code();
972 }
973 return object_error::parse_failed;
974}
975
976std::error_code COFFObjectFile::getString(uint32_t Offset,
977 StringRef &Result) const {
978 if (StringTableSize <= 4)
979 // Tried to get a string from an empty string table.
980 return object_error::parse_failed;
981 if (Offset >= StringTableSize)
982 return object_error::unexpected_eof;
983 Result = StringRef(StringTable + Offset);
984 return std::error_code();
985}
986
987std::error_code COFFObjectFile::getSymbolName(COFFSymbolRef Symbol,
988 StringRef &Res) const {
989 return getSymbolName(Symbol.getGeneric(), Res);
990}
991
992std::error_code COFFObjectFile::getSymbolName(const coff_symbol_generic *Symbol,
993 StringRef &Res) const {
994 // Check for string table entry. First 4 bytes are 0.
995 if (Symbol->Name.Offset.Zeroes == 0) {
996 if (std::error_code EC = getString(Symbol->Name.Offset.Offset, Res))
997 return EC;
998 return std::error_code();
999 }
1000
1001 if (Symbol->Name.ShortName[COFF::NameSize - 1] == 0)
1002 // Null terminated, let ::strlen figure out the length.
1003 Res = StringRef(Symbol->Name.ShortName);
1004 else
1005 // Not null terminated, use all 8 bytes.
1006 Res = StringRef(Symbol->Name.ShortName, COFF::NameSize);
1007 return std::error_code();
1008}
1009
1010ArrayRef<uint8_t>
1011COFFObjectFile::getSymbolAuxData(COFFSymbolRef Symbol) const {
1012 const uint8_t *Aux = nullptr;
1013
1014 size_t SymbolSize = getSymbolTableEntrySize();
1015 if (Symbol.getNumberOfAuxSymbols() > 0) {
1016 // AUX data comes immediately after the symbol in COFF
1017 Aux = reinterpret_cast<const uint8_t *>(Symbol.getRawPtr()) + SymbolSize;
1018#ifndef NDEBUG
1019 // Verify that the Aux symbol points to a valid entry in the symbol table.
1020 uintptr_t Offset = uintptr_t(Aux) - uintptr_t(base());
1021 if (Offset < getPointerToSymbolTable() ||
1022 Offset >=
1023 getPointerToSymbolTable() + (getNumberOfSymbols() * SymbolSize))
1024 report_fatal_error("Aux Symbol data was outside of symbol table.");
1025
1026 assert((Offset - getPointerToSymbolTable()) % SymbolSize == 0 &&(static_cast <bool> ((Offset - getPointerToSymbolTable(
)) % SymbolSize == 0 && "Aux Symbol data did not point to the beginning of a symbol"
) ? void (0) : __assert_fail ("(Offset - getPointerToSymbolTable()) % SymbolSize == 0 && \"Aux Symbol data did not point to the beginning of a symbol\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 1027, __extension__ __PRETTY_FUNCTION__))
1027 "Aux Symbol data did not point to the beginning of a symbol")(static_cast <bool> ((Offset - getPointerToSymbolTable(
)) % SymbolSize == 0 && "Aux Symbol data did not point to the beginning of a symbol"
) ? void (0) : __assert_fail ("(Offset - getPointerToSymbolTable()) % SymbolSize == 0 && \"Aux Symbol data did not point to the beginning of a symbol\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 1027, __extension__ __PRETTY_FUNCTION__))
;
1028#endif
1029 }
1030 return makeArrayRef(Aux, Symbol.getNumberOfAuxSymbols() * SymbolSize);
1031}
1032
1033std::error_code COFFObjectFile::getSectionName(const coff_section *Sec,
1034 StringRef &Res) const {
1035 StringRef Name;
1036 if (Sec->Name[COFF::NameSize - 1] == 0)
1037 // Null terminated, let ::strlen figure out the length.
1038 Name = Sec->Name;
1039 else
1040 // Not null terminated, use all 8 bytes.
1041 Name = StringRef(Sec->Name, COFF::NameSize);
1042
1043 // Check for string table entry. First byte is '/'.
1044 if (Name.startswith("/")) {
1045 uint32_t Offset;
1046 if (Name.startswith("//")) {
1047 if (decodeBase64StringEntry(Name.substr(2), Offset))
1048 return object_error::parse_failed;
1049 } else {
1050 if (Name.substr(1).getAsInteger(10, Offset))
1051 return object_error::parse_failed;
1052 }
1053 if (std::error_code EC = getString(Offset, Name))
1054 return EC;
1055 }
1056
1057 Res = Name;
1058 return std::error_code();
1059}
1060
1061uint64_t COFFObjectFile::getSectionSize(const coff_section *Sec) const {
1062 // SizeOfRawData and VirtualSize change what they represent depending on
1063 // whether or not we have an executable image.
1064 //
1065 // For object files, SizeOfRawData contains the size of section's data;
1066 // VirtualSize should be zero but isn't due to buggy COFF writers.
1067 //
1068 // For executables, SizeOfRawData *must* be a multiple of FileAlignment; the
1069 // actual section size is in VirtualSize. It is possible for VirtualSize to
1070 // be greater than SizeOfRawData; the contents past that point should be
1071 // considered to be zero.
1072 if (getDOSHeader())
1073 return std::min(Sec->VirtualSize, Sec->SizeOfRawData);
1074 return Sec->SizeOfRawData;
1075}
1076
1077std::error_code
1078COFFObjectFile::getSectionContents(const coff_section *Sec,
1079 ArrayRef<uint8_t> &Res) const {
1080 // In COFF, a virtual section won't have any in-file
1081 // content, so the file pointer to the content will be zero.
1082 if (Sec->PointerToRawData == 0)
1083 return std::error_code();
1084 // The only thing that we need to verify is that the contents is contained
1085 // within the file bounds. We don't need to make sure it doesn't cover other
1086 // data, as there's nothing that says that is not allowed.
1087 uintptr_t ConStart = uintptr_t(base()) + Sec->PointerToRawData;
1088 uint32_t SectionSize = getSectionSize(Sec);
1089 if (checkOffset(Data, ConStart, SectionSize))
1090 return object_error::parse_failed;
1091 Res = makeArrayRef(reinterpret_cast<const uint8_t *>(ConStart), SectionSize);
1092 return std::error_code();
1093}
1094
1095const coff_relocation *COFFObjectFile::toRel(DataRefImpl Rel) const {
1096 return reinterpret_cast<const coff_relocation*>(Rel.p);
1097}
1098
1099void COFFObjectFile::moveRelocationNext(DataRefImpl &Rel) const {
1100 Rel.p = reinterpret_cast<uintptr_t>(
1101 reinterpret_cast<const coff_relocation*>(Rel.p) + 1);
1102}
1103
1104uint64_t COFFObjectFile::getRelocationOffset(DataRefImpl Rel) const {
1105 const coff_relocation *R = toRel(Rel);
1106 return R->VirtualAddress;
1107}
1108
1109symbol_iterator COFFObjectFile::getRelocationSymbol(DataRefImpl Rel) const {
1110 const coff_relocation *R = toRel(Rel);
1111 DataRefImpl Ref;
1112 if (R->SymbolTableIndex >= getNumberOfSymbols())
1113 return symbol_end();
1114 if (SymbolTable16)
1115 Ref.p = reinterpret_cast<uintptr_t>(SymbolTable16 + R->SymbolTableIndex);
1116 else if (SymbolTable32)
1117 Ref.p = reinterpret_cast<uintptr_t>(SymbolTable32 + R->SymbolTableIndex);
1118 else
1119 llvm_unreachable("no symbol table pointer!")::llvm::llvm_unreachable_internal("no symbol table pointer!",
"/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 1119)
;
1120 return symbol_iterator(SymbolRef(Ref, this));
1121}
1122
1123uint64_t COFFObjectFile::getRelocationType(DataRefImpl Rel) const {
1124 const coff_relocation* R = toRel(Rel);
1125 return R->Type;
1126}
1127
1128const coff_section *
1129COFFObjectFile::getCOFFSection(const SectionRef &Section) const {
1130 return toSec(Section.getRawDataRefImpl());
1131}
1132
1133COFFSymbolRef COFFObjectFile::getCOFFSymbol(const DataRefImpl &Ref) const {
1134 if (SymbolTable16)
1135 return toSymb<coff_symbol16>(Ref);
1136 if (SymbolTable32)
1137 return toSymb<coff_symbol32>(Ref);
1138 llvm_unreachable("no symbol table pointer!")::llvm::llvm_unreachable_internal("no symbol table pointer!",
"/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 1138)
;
1139}
1140
1141COFFSymbolRef COFFObjectFile::getCOFFSymbol(const SymbolRef &Symbol) const {
1142 return getCOFFSymbol(Symbol.getRawDataRefImpl());
1143}
1144
1145const coff_relocation *
1146COFFObjectFile::getCOFFRelocation(const RelocationRef &Reloc) const {
1147 return toRel(Reloc.getRawDataRefImpl());
1148}
1149
1150iterator_range<const coff_relocation *>
1151COFFObjectFile::getRelocations(const coff_section *Sec) const {
1152 const coff_relocation *I = getFirstReloc(Sec, Data, base());
1153 const coff_relocation *E = I;
1154 if (I)
1155 E += getNumberOfRelocations(Sec, Data, base());
1156 return make_range(I, E);
1157}
1158
1159#define LLVM_COFF_SWITCH_RELOC_TYPE_NAME(reloc_type) \
1160 case COFF::reloc_type: \
1161 Res = #reloc_type; \
1162 break;
1163
1164void COFFObjectFile::getRelocationTypeName(
1165 DataRefImpl Rel, SmallVectorImpl<char> &Result) const {
1166 const coff_relocation *Reloc = toRel(Rel);
1167 StringRef Res;
1168 switch (getMachine()) {
1169 case COFF::IMAGE_FILE_MACHINE_AMD64:
1170 switch (Reloc->Type) {
1171 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ABSOLUTE);
1172 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR64);
1173 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32);
1174 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32NB);
1175 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32);
1176 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_1);
1177 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_2);
1178 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_3);
1179 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_4);
1180 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_5);
1181 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECTION);
1182 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL);
1183 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL7);
1184 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_TOKEN);
1185 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SREL32);
1186 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_PAIR);
1187 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SSPAN32);
1188 default:
1189 Res = "Unknown";
1190 }
1191 break;
1192 case COFF::IMAGE_FILE_MACHINE_ARMNT:
1193 switch (Reloc->Type) {
1194 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_ABSOLUTE);
1195 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_ADDR32);
1196 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_ADDR32NB);
1197 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH24);
1198 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH11);
1199 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_TOKEN);
1200 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BLX24);
1201 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BLX11);
1202 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_SECTION);
1203 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_SECREL);
1204 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_MOV32A);
1205 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_MOV32T);
1206 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH20T);
1207 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH24T);
1208 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BLX23T);
1209 default:
1210 Res = "Unknown";
1211 }
1212 break;
1213 case COFF::IMAGE_FILE_MACHINE_ARM64:
1214 switch (Reloc->Type) {
1215 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_ABSOLUTE);
1216 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_ADDR32);
1217 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_ADDR32NB);
1218 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_BRANCH26);
1219 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_PAGEBASE_REL21);
1220 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_REL21);
1221 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_PAGEOFFSET_12A);
1222 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_PAGEOFFSET_12L);
1223 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_SECREL);
1224 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_SECREL_LOW12A);
1225 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_SECREL_HIGH12A);
1226 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_SECREL_LOW12L);
1227 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_TOKEN);
1228 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_SECTION);
1229 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_ADDR64);
1230 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_BRANCH19);
1231 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_BRANCH14);
1232 default:
1233 Res = "Unknown";
1234 }
1235 break;
1236 case COFF::IMAGE_FILE_MACHINE_I386:
1237 switch (Reloc->Type) {
1238 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_ABSOLUTE);
1239 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR16);
1240 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL16);
1241 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32);
1242 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32NB);
1243 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SEG12);
1244 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECTION);
1245 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL);
1246 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_TOKEN);
1247 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL7);
1248 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL32);
1249 default:
1250 Res = "Unknown";
1251 }
1252 break;
1253 default:
1254 Res = "Unknown";
1255 }
1256 Result.append(Res.begin(), Res.end());
1257}
1258
1259#undef LLVM_COFF_SWITCH_RELOC_TYPE_NAME
1260
1261bool COFFObjectFile::isRelocatableObject() const {
1262 return !DataDirectory;
1263}
1264
1265bool ImportDirectoryEntryRef::
1266operator==(const ImportDirectoryEntryRef &Other) const {
1267 return ImportTable == Other.ImportTable && Index == Other.Index;
1268}
1269
1270void ImportDirectoryEntryRef::moveNext() {
1271 ++Index;
1272 if (ImportTable[Index].isNull()) {
1273 Index = -1;
1274 ImportTable = nullptr;
1275 }
1276}
1277
1278std::error_code ImportDirectoryEntryRef::getImportTableEntry(
1279 const coff_import_directory_table_entry *&Result) const {
1280 return getObject(Result, OwningObject->Data, ImportTable + Index);
1281}
1282
1283static imported_symbol_iterator
1284makeImportedSymbolIterator(const COFFObjectFile *Object,
1285 uintptr_t Ptr, int Index) {
1286 if (Object->getBytesInAddress() == 4) {
1287 auto *P = reinterpret_cast<const import_lookup_table_entry32 *>(Ptr);
1288 return imported_symbol_iterator(ImportedSymbolRef(P, Index, Object));
1289 }
1290 auto *P = reinterpret_cast<const import_lookup_table_entry64 *>(Ptr);
1291 return imported_symbol_iterator(ImportedSymbolRef(P, Index, Object));
1292}
1293
1294static imported_symbol_iterator
1295importedSymbolBegin(uint32_t RVA, const COFFObjectFile *Object) {
1296 uintptr_t IntPtr = 0;
1297 Object->getRvaPtr(RVA, IntPtr);
1298 return makeImportedSymbolIterator(Object, IntPtr, 0);
1299}
1300
1301static imported_symbol_iterator
1302importedSymbolEnd(uint32_t RVA, const COFFObjectFile *Object) {
1303 uintptr_t IntPtr = 0;
1304 Object->getRvaPtr(RVA, IntPtr);
1305 // Forward the pointer to the last entry which is null.
1306 int Index = 0;
1307 if (Object->getBytesInAddress() == 4) {
1308 auto *Entry = reinterpret_cast<ulittle32_t *>(IntPtr);
1309 while (*Entry++)
1310 ++Index;
1311 } else {
1312 auto *Entry = reinterpret_cast<ulittle64_t *>(IntPtr);
1313 while (*Entry++)
1314 ++Index;
1315 }
1316 return makeImportedSymbolIterator(Object, IntPtr, Index);
1317}
1318
1319imported_symbol_iterator
1320ImportDirectoryEntryRef::imported_symbol_begin() const {
1321 return importedSymbolBegin(ImportTable[Index].ImportAddressTableRVA,
1322 OwningObject);
1323}
1324
1325imported_symbol_iterator
1326ImportDirectoryEntryRef::imported_symbol_end() const {
1327 return importedSymbolEnd(ImportTable[Index].ImportAddressTableRVA,
1328 OwningObject);
1329}
1330
1331iterator_range<imported_symbol_iterator>
1332ImportDirectoryEntryRef::imported_symbols() const {
1333 return make_range(imported_symbol_begin(), imported_symbol_end());
1334}
1335
1336imported_symbol_iterator ImportDirectoryEntryRef::lookup_table_begin() const {
1337 return importedSymbolBegin(ImportTable[Index].ImportLookupTableRVA,
1338 OwningObject);
1339}
1340
1341imported_symbol_iterator ImportDirectoryEntryRef::lookup_table_end() const {
1342 return importedSymbolEnd(ImportTable[Index].ImportLookupTableRVA,
1343 OwningObject);
1344}
1345
1346iterator_range<imported_symbol_iterator>
1347ImportDirectoryEntryRef::lookup_table_symbols() const {
1348 return make_range(lookup_table_begin(), lookup_table_end());
1349}
1350
1351std::error_code ImportDirectoryEntryRef::getName(StringRef &Result) const {
1352 uintptr_t IntPtr = 0;
1353 if (std::error_code EC =
1354 OwningObject->getRvaPtr(ImportTable[Index].NameRVA, IntPtr))
1355 return EC;
1356 Result = StringRef(reinterpret_cast<const char *>(IntPtr));
1357 return std::error_code();
1358}
1359
1360std::error_code
1361ImportDirectoryEntryRef::getImportLookupTableRVA(uint32_t &Result) const {
1362 Result = ImportTable[Index].ImportLookupTableRVA;
1363 return std::error_code();
1364}
1365
1366std::error_code
1367ImportDirectoryEntryRef::getImportAddressTableRVA(uint32_t &Result) const {
1368 Result = ImportTable[Index].ImportAddressTableRVA;
1369 return std::error_code();
1370}
1371
1372bool DelayImportDirectoryEntryRef::
1373operator==(const DelayImportDirectoryEntryRef &Other) const {
1374 return Table == Other.Table && Index == Other.Index;
1375}
1376
1377void DelayImportDirectoryEntryRef::moveNext() {
1378 ++Index;
1379}
1380
1381imported_symbol_iterator
1382DelayImportDirectoryEntryRef::imported_symbol_begin() const {
1383 return importedSymbolBegin(Table[Index].DelayImportNameTable,
1384 OwningObject);
1385}
1386
1387imported_symbol_iterator
1388DelayImportDirectoryEntryRef::imported_symbol_end() const {
1389 return importedSymbolEnd(Table[Index].DelayImportNameTable,
1390 OwningObject);
1391}
1392
1393iterator_range<imported_symbol_iterator>
1394DelayImportDirectoryEntryRef::imported_symbols() const {
1395 return make_range(imported_symbol_begin(), imported_symbol_end());
1396}
1397
1398std::error_code DelayImportDirectoryEntryRef::getName(StringRef &Result) const {
1399 uintptr_t IntPtr = 0;
1400 if (std::error_code EC = OwningObject->getRvaPtr(Table[Index].Name, IntPtr))
1401 return EC;
1402 Result = StringRef(reinterpret_cast<const char *>(IntPtr));
1403 return std::error_code();
1404}
1405
1406std::error_code DelayImportDirectoryEntryRef::
1407getDelayImportTable(const delay_import_directory_table_entry *&Result) const {
1408 Result = Table;
1409 return std::error_code();
1410}
1411
1412std::error_code DelayImportDirectoryEntryRef::
1413getImportAddress(int AddrIndex, uint64_t &Result) const {
1414 uint32_t RVA = Table[Index].DelayImportAddressTable +
1415 AddrIndex * (OwningObject->is64() ? 8 : 4);
1416 uintptr_t IntPtr = 0;
1417 if (std::error_code EC = OwningObject->getRvaPtr(RVA, IntPtr))
1418 return EC;
1419 if (OwningObject->is64())
1420 Result = *reinterpret_cast<const ulittle64_t *>(IntPtr);
1421 else
1422 Result = *reinterpret_cast<const ulittle32_t *>(IntPtr);
1423 return std::error_code();
1424}
1425
1426bool ExportDirectoryEntryRef::
1427operator==(const ExportDirectoryEntryRef &Other) const {
1428 return ExportTable == Other.ExportTable && Index == Other.Index;
1429}
1430
1431void ExportDirectoryEntryRef::moveNext() {
1432 ++Index;
1433}
1434
1435// Returns the name of the current export symbol. If the symbol is exported only
1436// by ordinal, the empty string is set as a result.
1437std::error_code ExportDirectoryEntryRef::getDllName(StringRef &Result) const {
1438 uintptr_t IntPtr = 0;
1439 if (std::error_code EC =
1440 OwningObject->getRvaPtr(ExportTable->NameRVA, IntPtr))
1441 return EC;
1442 Result = StringRef(reinterpret_cast<const char *>(IntPtr));
1443 return std::error_code();
1444}
1445
1446// Returns the starting ordinal number.
1447std::error_code
1448ExportDirectoryEntryRef::getOrdinalBase(uint32_t &Result) const {
1449 Result = ExportTable->OrdinalBase;
1450 return std::error_code();
1451}
1452
1453// Returns the export ordinal of the current export symbol.
1454std::error_code ExportDirectoryEntryRef::getOrdinal(uint32_t &Result) const {
1455 Result = ExportTable->OrdinalBase + Index;
1456 return std::error_code();
1457}
1458
1459// Returns the address of the current export symbol.
1460std::error_code ExportDirectoryEntryRef::getExportRVA(uint32_t &Result) const {
1461 uintptr_t IntPtr = 0;
1462 if (std::error_code EC =
1463 OwningObject->getRvaPtr(ExportTable->ExportAddressTableRVA, IntPtr))
1464 return EC;
1465 const export_address_table_entry *entry =
1466 reinterpret_cast<const export_address_table_entry *>(IntPtr);
1467 Result = entry[Index].ExportRVA;
1468 return std::error_code();
1469}
1470
1471// Returns the name of the current export symbol. If the symbol is exported only
1472// by ordinal, the empty string is set as a result.
1473std::error_code
1474ExportDirectoryEntryRef::getSymbolName(StringRef &Result) const {
1475 uintptr_t IntPtr = 0;
1476 if (std::error_code EC =
1477 OwningObject->getRvaPtr(ExportTable->OrdinalTableRVA, IntPtr))
1478 return EC;
1479 const ulittle16_t *Start = reinterpret_cast<const ulittle16_t *>(IntPtr);
1480
1481 uint32_t NumEntries = ExportTable->NumberOfNamePointers;
1482 int Offset = 0;
1483 for (const ulittle16_t *I = Start, *E = Start + NumEntries;
1484 I < E; ++I, ++Offset) {
1485 if (*I != Index)
1486 continue;
1487 if (std::error_code EC =
1488 OwningObject->getRvaPtr(ExportTable->NamePointerRVA, IntPtr))
1489 return EC;
1490 const ulittle32_t *NamePtr = reinterpret_cast<const ulittle32_t *>(IntPtr);
1491 if (std::error_code EC = OwningObject->getRvaPtr(NamePtr[Offset], IntPtr))
1492 return EC;
1493 Result = StringRef(reinterpret_cast<const char *>(IntPtr));
1494 return std::error_code();
1495 }
1496 Result = "";
1497 return std::error_code();
1498}
1499
1500std::error_code ExportDirectoryEntryRef::isForwarder(bool &Result) const {
1501 const data_directory *DataEntry;
1502 if (auto EC = OwningObject->getDataDirectory(COFF::EXPORT_TABLE, DataEntry))
1503 return EC;
1504 uint32_t RVA;
1505 if (auto EC = getExportRVA(RVA))
1506 return EC;
1507 uint32_t Begin = DataEntry->RelativeVirtualAddress;
1508 uint32_t End = DataEntry->RelativeVirtualAddress + DataEntry->Size;
1509 Result = (Begin <= RVA && RVA < End);
1510 return std::error_code();
1511}
1512
1513std::error_code ExportDirectoryEntryRef::getForwardTo(StringRef &Result) const {
1514 uint32_t RVA;
1515 if (auto EC = getExportRVA(RVA))
1516 return EC;
1517 uintptr_t IntPtr = 0;
1518 if (auto EC = OwningObject->getRvaPtr(RVA, IntPtr))
1519 return EC;
1520 Result = StringRef(reinterpret_cast<const char *>(IntPtr));
1521 return std::error_code();
1522}
1523
1524bool ImportedSymbolRef::
1525operator==(const ImportedSymbolRef &Other) const {
1526 return Entry32 == Other.Entry32 && Entry64 == Other.Entry64
1527 && Index == Other.Index;
1528}
1529
1530void ImportedSymbolRef::moveNext() {
1531 ++Index;
1532}
1533
1534std::error_code
1535ImportedSymbolRef::getSymbolName(StringRef &Result) const {
1536 uint32_t RVA;
1537 if (Entry32) {
1538 // If a symbol is imported only by ordinal, it has no name.
1539 if (Entry32[Index].isOrdinal())
1540 return std::error_code();
1541 RVA = Entry32[Index].getHintNameRVA();
1542 } else {
1543 if (Entry64[Index].isOrdinal())
1544 return std::error_code();
1545 RVA = Entry64[Index].getHintNameRVA();
1546 }
1547 uintptr_t IntPtr = 0;
1548 if (std::error_code EC = OwningObject->getRvaPtr(RVA, IntPtr))
1549 return EC;
1550 // +2 because the first two bytes is hint.
1551 Result = StringRef(reinterpret_cast<const char *>(IntPtr + 2));
1552 return std::error_code();
1553}
1554
1555std::error_code ImportedSymbolRef::isOrdinal(bool &Result) const {
1556 if (Entry32)
1557 Result = Entry32[Index].isOrdinal();
1558 else
1559 Result = Entry64[Index].isOrdinal();
1560 return std::error_code();
1561}
1562
1563std::error_code ImportedSymbolRef::getHintNameRVA(uint32_t &Result) const {
1564 if (Entry32)
1565 Result = Entry32[Index].getHintNameRVA();
1566 else
1567 Result = Entry64[Index].getHintNameRVA();
1568 return std::error_code();
1569}
1570
1571std::error_code ImportedSymbolRef::getOrdinal(uint16_t &Result) const {
1572 uint32_t RVA;
1573 if (Entry32) {
1574 if (Entry32[Index].isOrdinal()) {
1575 Result = Entry32[Index].getOrdinal();
1576 return std::error_code();
1577 }
1578 RVA = Entry32[Index].getHintNameRVA();
1579 } else {
1580 if (Entry64[Index].isOrdinal()) {
1581 Result = Entry64[Index].getOrdinal();
1582 return std::error_code();
1583 }
1584 RVA = Entry64[Index].getHintNameRVA();
1585 }
1586 uintptr_t IntPtr = 0;
1587 if (std::error_code EC = OwningObject->getRvaPtr(RVA, IntPtr))
1588 return EC;
1589 Result = *reinterpret_cast<const ulittle16_t *>(IntPtr);
1590 return std::error_code();
1591}
1592
1593Expected<std::unique_ptr<COFFObjectFile>>
1594ObjectFile::createCOFFObjectFile(MemoryBufferRef Object) {
1595 std::error_code EC;
1596 std::unique_ptr<COFFObjectFile> Ret(new COFFObjectFile(Object, EC));
1597 if (EC)
1598 return errorCodeToError(EC);
1599 return std::move(Ret);
1600}
1601
1602bool BaseRelocRef::operator==(const BaseRelocRef &Other) const {
1603 return Header == Other.Header && Index == Other.Index;
1604}
1605
1606void BaseRelocRef::moveNext() {
1607 // Header->BlockSize is the size of the current block, including the
1608 // size of the header itself.
1609 uint32_t Size = sizeof(*Header) +
1610 sizeof(coff_base_reloc_block_entry) * (Index + 1);
1611 if (Size == Header->BlockSize) {
1612 // .reloc contains a list of base relocation blocks. Each block
1613 // consists of the header followed by entries. The header contains
1614 // how many entories will follow. When we reach the end of the
1615 // current block, proceed to the next block.
1616 Header = reinterpret_cast<const coff_base_reloc_block_header *>(
1617 reinterpret_cast<const uint8_t *>(Header) + Size);
1618 Index = 0;
1619 } else {
1620 ++Index;
1621 }
1622}
1623
1624std::error_code BaseRelocRef::getType(uint8_t &Type) const {
1625 auto *Entry = reinterpret_cast<const coff_base_reloc_block_entry *>(Header + 1);
1626 Type = Entry[Index].getType();
1627 return std::error_code();
1628}
1629
1630std::error_code BaseRelocRef::getRVA(uint32_t &Result) const {
1631 auto *Entry = reinterpret_cast<const coff_base_reloc_block_entry *>(Header + 1);
1632 Result = Header->PageRVA + Entry[Index].getOffset();
1633 return std::error_code();
1634}
1635
1636#define RETURN_IF_ERROR(E)if (E) return E; \
1637 if (E) \
1638 return E;
1639
1640Expected<ArrayRef<UTF16>>
1641ResourceSectionRef::getDirStringAtOffset(uint32_t Offset) {
1642 BinaryStreamReader Reader = BinaryStreamReader(BBS);
1643 Reader.setOffset(Offset);
1644 uint16_t Length;
1645 RETURN_IF_ERROR(Reader.readInteger(Length))if (Reader.readInteger(Length)) return Reader.readInteger(Length
);
;
1646 ArrayRef<UTF16> RawDirString;
1647 RETURN_IF_ERROR(Reader.readArray(RawDirString, Length))if (Reader.readArray(RawDirString, Length)) return Reader.readArray
(RawDirString, Length);
;
1648 return RawDirString;
1649}
1650
1651Expected<ArrayRef<UTF16>>
1652ResourceSectionRef::getEntryNameString(const coff_resource_dir_entry &Entry) {
1653 return getDirStringAtOffset(Entry.Identifier.getNameOffset());
1654}
1655
1656Expected<const coff_resource_dir_table &>
1657ResourceSectionRef::getTableAtOffset(uint32_t Offset) {
1658 const coff_resource_dir_table *Table = nullptr;
1659
1660 BinaryStreamReader Reader(BBS);
1661 Reader.setOffset(Offset);
1662 RETURN_IF_ERROR(Reader.readObject(Table))if (Reader.readObject(Table)) return Reader.readObject(Table)
;
;
1663 assert(Table != nullptr)(static_cast <bool> (Table != nullptr) ? void (0) : __assert_fail
("Table != nullptr", "/build/llvm-toolchain-snapshot-6.0~svn318801/lib/Object/COFFObjectFile.cpp"
, 1663, __extension__ __PRETTY_FUNCTION__))
;
1664 return *Table;
1665}
1666
1667Expected<const coff_resource_dir_table &>
1668ResourceSectionRef::getEntrySubDir(const coff_resource_dir_entry &Entry) {
1669 return getTableAtOffset(Entry.Offset.value());
1670}
1671
1672Expected<const coff_resource_dir_table &> ResourceSectionRef::getBaseTable() {
1673 return getTableAtOffset(0);
1674}

/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h

1//===- COFF.h - 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
14#ifndef LLVM_OBJECT_COFF_H
15#define LLVM_OBJECT_COFF_H
16
17#include "llvm/ADT/iterator_range.h"
18#include "llvm/BinaryFormat/COFF.h"
19#include "llvm/DebugInfo/CodeView/CVDebugRecord.h"
20#include "llvm/MC/SubtargetFeature.h"
21#include "llvm/Object/Binary.h"
22#include "llvm/Object/Error.h"
23#include "llvm/Object/ObjectFile.h"
24#include "llvm/Support/BinaryByteStream.h"
25#include "llvm/Support/ConvertUTF.h"
26#include "llvm/Support/Endian.h"
27#include "llvm/Support/ErrorHandling.h"
28#include <cassert>
29#include <cstddef>
30#include <cstdint>
31#include <system_error>
32
33namespace llvm {
34
35template <typename T> class ArrayRef;
36
37namespace object {
38
39class BaseRelocRef;
40class DelayImportDirectoryEntryRef;
41class ExportDirectoryEntryRef;
42class ImportDirectoryEntryRef;
43class ImportedSymbolRef;
44class ResourceSectionRef;
45
46using import_directory_iterator = content_iterator<ImportDirectoryEntryRef>;
47using delay_import_directory_iterator =
48 content_iterator<DelayImportDirectoryEntryRef>;
49using export_directory_iterator = content_iterator<ExportDirectoryEntryRef>;
50using imported_symbol_iterator = content_iterator<ImportedSymbolRef>;
51using base_reloc_iterator = content_iterator<BaseRelocRef>;
52
53/// The DOS compatible header at the front of all PE/COFF executables.
54struct dos_header {
55 char Magic[2];
56 support::ulittle16_t UsedBytesInTheLastPage;
57 support::ulittle16_t FileSizeInPages;
58 support::ulittle16_t NumberOfRelocationItems;
59 support::ulittle16_t HeaderSizeInParagraphs;
60 support::ulittle16_t MinimumExtraParagraphs;
61 support::ulittle16_t MaximumExtraParagraphs;
62 support::ulittle16_t InitialRelativeSS;
63 support::ulittle16_t InitialSP;
64 support::ulittle16_t Checksum;
65 support::ulittle16_t InitialIP;
66 support::ulittle16_t InitialRelativeCS;
67 support::ulittle16_t AddressOfRelocationTable;
68 support::ulittle16_t OverlayNumber;
69 support::ulittle16_t Reserved[4];
70 support::ulittle16_t OEMid;
71 support::ulittle16_t OEMinfo;
72 support::ulittle16_t Reserved2[10];
73 support::ulittle32_t AddressOfNewExeHeader;
74};
75
76struct coff_file_header {
77 support::ulittle16_t Machine;
78 support::ulittle16_t NumberOfSections;
79 support::ulittle32_t TimeDateStamp;
80 support::ulittle32_t PointerToSymbolTable;
81 support::ulittle32_t NumberOfSymbols;
82 support::ulittle16_t SizeOfOptionalHeader;
83 support::ulittle16_t Characteristics;
84
85 bool isImportLibrary() const { return NumberOfSections == 0xffff; }
86};
87
88struct coff_bigobj_file_header {
89 support::ulittle16_t Sig1;
90 support::ulittle16_t Sig2;
91 support::ulittle16_t Version;
92 support::ulittle16_t Machine;
93 support::ulittle32_t TimeDateStamp;
94 uint8_t UUID[16];
95 support::ulittle32_t unused1;
96 support::ulittle32_t unused2;
97 support::ulittle32_t unused3;
98 support::ulittle32_t unused4;
99 support::ulittle32_t NumberOfSections;
100 support::ulittle32_t PointerToSymbolTable;
101 support::ulittle32_t NumberOfSymbols;
102};
103
104/// The 32-bit PE header that follows the COFF header.
105struct pe32_header {
106 support::ulittle16_t Magic;
107 uint8_t MajorLinkerVersion;
108 uint8_t MinorLinkerVersion;
109 support::ulittle32_t SizeOfCode;
110 support::ulittle32_t SizeOfInitializedData;
111 support::ulittle32_t SizeOfUninitializedData;
112 support::ulittle32_t AddressOfEntryPoint;
113 support::ulittle32_t BaseOfCode;
114 support::ulittle32_t BaseOfData;
115 support::ulittle32_t ImageBase;
116 support::ulittle32_t SectionAlignment;
117 support::ulittle32_t FileAlignment;
118 support::ulittle16_t MajorOperatingSystemVersion;
119 support::ulittle16_t MinorOperatingSystemVersion;
120 support::ulittle16_t MajorImageVersion;
121 support::ulittle16_t MinorImageVersion;
122 support::ulittle16_t MajorSubsystemVersion;
123 support::ulittle16_t MinorSubsystemVersion;
124 support::ulittle32_t Win32VersionValue;
125 support::ulittle32_t SizeOfImage;
126 support::ulittle32_t SizeOfHeaders;
127 support::ulittle32_t CheckSum;
128 support::ulittle16_t Subsystem;
129 // FIXME: This should be DllCharacteristics.
130 support::ulittle16_t DLLCharacteristics;
131 support::ulittle32_t SizeOfStackReserve;
132 support::ulittle32_t SizeOfStackCommit;
133 support::ulittle32_t SizeOfHeapReserve;
134 support::ulittle32_t SizeOfHeapCommit;
135 support::ulittle32_t LoaderFlags;
136 // FIXME: This should be NumberOfRvaAndSizes.
137 support::ulittle32_t NumberOfRvaAndSize;
138};
139
140/// The 64-bit PE header that follows the COFF header.
141struct pe32plus_header {
142 support::ulittle16_t Magic;
143 uint8_t MajorLinkerVersion;
144 uint8_t MinorLinkerVersion;
145 support::ulittle32_t SizeOfCode;
146 support::ulittle32_t SizeOfInitializedData;
147 support::ulittle32_t SizeOfUninitializedData;
148 support::ulittle32_t AddressOfEntryPoint;
149 support::ulittle32_t BaseOfCode;
150 support::ulittle64_t ImageBase;
151 support::ulittle32_t SectionAlignment;
152 support::ulittle32_t FileAlignment;
153 support::ulittle16_t MajorOperatingSystemVersion;
154 support::ulittle16_t MinorOperatingSystemVersion;
155 support::ulittle16_t MajorImageVersion;
156 support::ulittle16_t MinorImageVersion;
157 support::ulittle16_t MajorSubsystemVersion;
158 support::ulittle16_t MinorSubsystemVersion;
159 support::ulittle32_t Win32VersionValue;
160 support::ulittle32_t SizeOfImage;
161 support::ulittle32_t SizeOfHeaders;
162 support::ulittle32_t CheckSum;
163 support::ulittle16_t Subsystem;
164 support::ulittle16_t DLLCharacteristics;
165 support::ulittle64_t SizeOfStackReserve;
166 support::ulittle64_t SizeOfStackCommit;
167 support::ulittle64_t SizeOfHeapReserve;
168 support::ulittle64_t SizeOfHeapCommit;
169 support::ulittle32_t LoaderFlags;
170 support::ulittle32_t NumberOfRvaAndSize;
171};
172
173struct data_directory {
174 support::ulittle32_t RelativeVirtualAddress;
175 support::ulittle32_t Size;
176};
177
178struct debug_directory {
179 support::ulittle32_t Characteristics;
180 support::ulittle32_t TimeDateStamp;
181 support::ulittle16_t MajorVersion;
182 support::ulittle16_t MinorVersion;
183 support::ulittle32_t Type;
184 support::ulittle32_t SizeOfData;
185 support::ulittle32_t AddressOfRawData;
186 support::ulittle32_t PointerToRawData;
187};
188
189template <typename IntTy>
190struct import_lookup_table_entry {
191 IntTy Data;
192
193 bool isOrdinal() const { return Data < 0; }
194
195 uint16_t getOrdinal() const {
196 assert(isOrdinal() && "ILT entry is not an ordinal!")(static_cast <bool> (isOrdinal() && "ILT entry is not an ordinal!"
) ? void (0) : __assert_fail ("isOrdinal() && \"ILT entry is not an ordinal!\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 196, __extension__ __PRETTY_FUNCTION__))
;
197 return Data & 0xFFFF;
198 }
199
200 uint32_t getHintNameRVA() const {
201 assert(!isOrdinal() && "ILT entry is not a Hint/Name RVA!")(static_cast <bool> (!isOrdinal() && "ILT entry is not a Hint/Name RVA!"
) ? void (0) : __assert_fail ("!isOrdinal() && \"ILT entry is not a Hint/Name RVA!\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 201, __extension__ __PRETTY_FUNCTION__))
;
202 return Data & 0xFFFFFFFF;
203 }
204};
205
206using import_lookup_table_entry32 =
207 import_lookup_table_entry<support::little32_t>;
208using import_lookup_table_entry64 =
209 import_lookup_table_entry<support::little64_t>;
210
211struct delay_import_directory_table_entry {
212 // dumpbin reports this field as "Characteristics" instead of "Attributes".
213 support::ulittle32_t Attributes;
214 support::ulittle32_t Name;
215 support::ulittle32_t ModuleHandle;
216 support::ulittle32_t DelayImportAddressTable;
217 support::ulittle32_t DelayImportNameTable;
218 support::ulittle32_t BoundDelayImportTable;
219 support::ulittle32_t UnloadDelayImportTable;
220 support::ulittle32_t TimeStamp;
221};
222
223struct export_directory_table_entry {
224 support::ulittle32_t ExportFlags;
225 support::ulittle32_t TimeDateStamp;
226 support::ulittle16_t MajorVersion;
227 support::ulittle16_t MinorVersion;
228 support::ulittle32_t NameRVA;
229 support::ulittle32_t OrdinalBase;
230 support::ulittle32_t AddressTableEntries;
231 support::ulittle32_t NumberOfNamePointers;
232 support::ulittle32_t ExportAddressTableRVA;
233 support::ulittle32_t NamePointerRVA;
234 support::ulittle32_t OrdinalTableRVA;
235};
236
237union export_address_table_entry {
238 support::ulittle32_t ExportRVA;
239 support::ulittle32_t ForwarderRVA;
240};
241
242using export_name_pointer_table_entry = support::ulittle32_t;
243using export_ordinal_table_entry = support::ulittle16_t;
244
245struct StringTableOffset {
246 support::ulittle32_t Zeroes;
247 support::ulittle32_t Offset;
248};
249
250template <typename SectionNumberType>
251struct coff_symbol {
252 union {
253 char ShortName[COFF::NameSize];
254 StringTableOffset Offset;
255 } Name;
256
257 support::ulittle32_t Value;
258 SectionNumberType SectionNumber;
259
260 support::ulittle16_t Type;
261
262 uint8_t StorageClass;
263 uint8_t NumberOfAuxSymbols;
264};
265
266using coff_symbol16 = coff_symbol<support::ulittle16_t>;
267using coff_symbol32 = coff_symbol<support::ulittle32_t>;
268
269// Contains only common parts of coff_symbol16 and coff_symbol32.
270struct coff_symbol_generic {
271 union {
272 char ShortName[COFF::NameSize];
273 StringTableOffset Offset;
274 } Name;
275 support::ulittle32_t Value;
276};
277
278class COFFSymbolRef {
279public:
280 COFFSymbolRef() = default;
281 COFFSymbolRef(const coff_symbol16 *CS) : CS16(CS) {}
282 COFFSymbolRef(const coff_symbol32 *CS) : CS32(CS) {}
283
284 const void *getRawPtr() const {
285 return CS16 ? static_cast<const void *>(CS16) : CS32;
286 }
287
288 const coff_symbol_generic *getGeneric() const {
289 if (CS16)
290 return reinterpret_cast<const coff_symbol_generic *>(CS16);
291 return reinterpret_cast<const coff_symbol_generic *>(CS32);
292 }
293
294 friend bool operator<(COFFSymbolRef A, COFFSymbolRef B) {
295 return A.getRawPtr() < B.getRawPtr();
296 }
297
298 bool isBigObj() const {
299 if (CS16)
300 return false;
301 if (CS32)
302 return true;
303 llvm_unreachable("COFFSymbolRef points to nothing!")::llvm::llvm_unreachable_internal("COFFSymbolRef points to nothing!"
, "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 303)
;
304 }
305
306 const char *getShortName() const {
307 return CS16 ? CS16->Name.ShortName : CS32->Name.ShortName;
308 }
309
310 const StringTableOffset &getStringTableOffset() const {
311 assert(isSet() && "COFFSymbolRef points to nothing!")(static_cast <bool> (isSet() && "COFFSymbolRef points to nothing!"
) ? void (0) : __assert_fail ("isSet() && \"COFFSymbolRef points to nothing!\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 311, __extension__ __PRETTY_FUNCTION__))
;
312 return CS16 ? CS16->Name.Offset : CS32->Name.Offset;
313 }
314
315 uint32_t getValue() const { return CS16 ? CS16->Value : CS32->Value; }
2
Assuming the condition is false
3
'?' condition is false
4
Called C++ object pointer is null
316
317 int32_t getSectionNumber() const {
318 assert(isSet() && "COFFSymbolRef points to nothing!")(static_cast <bool> (isSet() && "COFFSymbolRef points to nothing!"
) ? void (0) : __assert_fail ("isSet() && \"COFFSymbolRef points to nothing!\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 318, __extension__ __PRETTY_FUNCTION__))
;
319 if (CS16) {
320 // Reserved sections are returned as negative numbers.
321 if (CS16->SectionNumber <= COFF::MaxNumberOfSections16)
322 return CS16->SectionNumber;
323 return static_cast<int16_t>(CS16->SectionNumber);
324 }
325 return static_cast<int32_t>(CS32->SectionNumber);
326 }
327
328 uint16_t getType() const {
329 assert(isSet() && "COFFSymbolRef points to nothing!")(static_cast <bool> (isSet() && "COFFSymbolRef points to nothing!"
) ? void (0) : __assert_fail ("isSet() && \"COFFSymbolRef points to nothing!\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 329, __extension__ __PRETTY_FUNCTION__))
;
330 return CS16 ? CS16->Type : CS32->Type;
331 }
332
333 uint8_t getStorageClass() const {
334 assert(isSet() && "COFFSymbolRef points to nothing!")(static_cast <bool> (isSet() && "COFFSymbolRef points to nothing!"
) ? void (0) : __assert_fail ("isSet() && \"COFFSymbolRef points to nothing!\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 334, __extension__ __PRETTY_FUNCTION__))
;
335 return CS16 ? CS16->StorageClass : CS32->StorageClass;
336 }
337
338 uint8_t getNumberOfAuxSymbols() const {
339 assert(isSet() && "COFFSymbolRef points to nothing!")(static_cast <bool> (isSet() && "COFFSymbolRef points to nothing!"
) ? void (0) : __assert_fail ("isSet() && \"COFFSymbolRef points to nothing!\""
, "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 339, __extension__ __PRETTY_FUNCTION__))
;
340 return CS16 ? CS16->NumberOfAuxSymbols : CS32->NumberOfAuxSymbols;
341 }
342
343 uint8_t getBaseType() const { return getType() & 0x0F; }
344
345 uint8_t getComplexType() const {
346 return (getType() & 0xF0) >> COFF::SCT_COMPLEX_TYPE_SHIFT;
347 }
348
349 bool isAbsolute() const {
350 return getSectionNumber() == -1;
351 }
352
353 bool isExternal() const {
354 return getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL;
355 }
356
357 bool isCommon() const {
358 return isExternal() && getSectionNumber() == COFF::IMAGE_SYM_UNDEFINED &&
359 getValue() != 0;
360 }
361
362 bool isUndefined() const {
363 return isExternal() && getSectionNumber() == COFF::IMAGE_SYM_UNDEFINED &&
364 getValue() == 0;
365 }
366
367 bool isWeakExternal() const {
368 return getStorageClass() == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL;
369 }
370
371 bool isFunctionDefinition() const {
372 return isExternal() && getBaseType() == COFF::IMAGE_SYM_TYPE_NULL &&
373 getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION &&
374 !COFF::isReservedSectionNumber(getSectionNumber());
375 }
376
377 bool isFunctionLineInfo() const {
378 return getStorageClass() == COFF::IMAGE_SYM_CLASS_FUNCTION;
379 }
380
381 bool isAnyUndefined() const {
382 return isUndefined() || isWeakExternal();
383 }
384
385 bool isFileRecord() const {
386 return getStorageClass() == COFF::IMAGE_SYM_CLASS_FILE;
387 }
388
389 bool isSection() const {
390 return getStorageClass() == COFF::IMAGE_SYM_CLASS_SECTION;
391 }
392
393 bool isSectionDefinition() const {
394 // C++/CLI creates external ABS symbols for non-const appdomain globals.
395 // These are also followed by an auxiliary section definition.
396 bool isAppdomainGlobal =
397 getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
398 getSectionNumber() == COFF::IMAGE_SYM_ABSOLUTE;
399 bool isOrdinarySection = getStorageClass() == COFF::IMAGE_SYM_CLASS_STATIC;
400 if (!getNumberOfAuxSymbols())
401 return false;
402 return isAppdomainGlobal || isOrdinarySection;
403 }
404
405 bool isCLRToken() const {
406 return getStorageClass() == COFF::IMAGE_SYM_CLASS_CLR_TOKEN;
407 }
408
409private:
410 bool isSet() const { return CS16 || CS32; }
411
412 const coff_symbol16 *CS16 = nullptr;
413 const coff_symbol32 *CS32 = nullptr;
414};
415
416struct coff_section {
417 char Name[COFF::NameSize];
418 support::ulittle32_t VirtualSize;
419 support::ulittle32_t VirtualAddress;
420 support::ulittle32_t SizeOfRawData;
421 support::ulittle32_t PointerToRawData;
422 support::ulittle32_t PointerToRelocations;
423 support::ulittle32_t PointerToLinenumbers;
424 support::ulittle16_t NumberOfRelocations;
425 support::ulittle16_t NumberOfLinenumbers;
426 support::ulittle32_t Characteristics;
427
428 // Returns true if the actual number of relocations is stored in
429 // VirtualAddress field of the first relocation table entry.
430 bool hasExtendedRelocations() const {
431 return (Characteristics & COFF::IMAGE_SCN_LNK_NRELOC_OVFL) &&
432 NumberOfRelocations == UINT16_MAX(65535);
433 }
434
435 uint32_t getAlignment() const {
436 // The IMAGE_SCN_TYPE_NO_PAD bit is a legacy way of getting to
437 // IMAGE_SCN_ALIGN_1BYTES.
438 if (Characteristics & COFF::IMAGE_SCN_TYPE_NO_PAD)
439 return 1;
440
441 // Bit [20:24] contains section alignment. Both 0 and 1 mean alignment 1.
442 uint32_t Shift = (Characteristics >> 20) & 0xF;
443 if (Shift > 0)
444 return 1U << (Shift - 1);
445 return 1;
446 }
447};
448
449struct coff_relocation {
450 support::ulittle32_t VirtualAddress;
451 support::ulittle32_t SymbolTableIndex;
452 support::ulittle16_t Type;
453};
454
455struct coff_aux_function_definition {
456 support::ulittle32_t TagIndex;
457 support::ulittle32_t TotalSize;
458 support::ulittle32_t PointerToLinenumber;
459 support::ulittle32_t PointerToNextFunction;
460 char Unused1[2];
461};
462
463static_assert(sizeof(coff_aux_function_definition) == 18,
464 "auxiliary entry must be 18 bytes");
465
466struct coff_aux_bf_and_ef_symbol {
467 char Unused1[4];
468 support::ulittle16_t Linenumber;
469 char Unused2[6];
470 support::ulittle32_t PointerToNextFunction;
471 char Unused3[2];
472};
473
474static_assert(sizeof(coff_aux_bf_and_ef_symbol) == 18,
475 "auxiliary entry must be 18 bytes");
476
477struct coff_aux_weak_external {
478 support::ulittle32_t TagIndex;
479 support::ulittle32_t Characteristics;
480 char Unused1[10];
481};
482
483static_assert(sizeof(coff_aux_weak_external) == 18,
484 "auxiliary entry must be 18 bytes");
485
486struct coff_aux_section_definition {
487 support::ulittle32_t Length;
488 support::ulittle16_t NumberOfRelocations;
489 support::ulittle16_t NumberOfLinenumbers;
490 support::ulittle32_t CheckSum;
491 support::ulittle16_t NumberLowPart;
492 uint8_t Selection;
493 uint8_t Unused;
494 support::ulittle16_t NumberHighPart;
495 int32_t getNumber(bool IsBigObj) const {
496 uint32_t Number = static_cast<uint32_t>(NumberLowPart);
497 if (IsBigObj)
498 Number |= static_cast<uint32_t>(NumberHighPart) << 16;
499 return static_cast<int32_t>(Number);
500 }
501};
502
503static_assert(sizeof(coff_aux_section_definition) == 18,
504 "auxiliary entry must be 18 bytes");
505
506struct coff_aux_clr_token {
507 uint8_t AuxType;
508 uint8_t Reserved;
509 support::ulittle32_t SymbolTableIndex;
510 char MBZ[12];
511};
512
513static_assert(sizeof(coff_aux_clr_token) == 18,
514 "auxiliary entry must be 18 bytes");
515
516struct coff_import_header {
517 support::ulittle16_t Sig1;
518 support::ulittle16_t Sig2;
519 support::ulittle16_t Version;
520 support::ulittle16_t Machine;
521 support::ulittle32_t TimeDateStamp;
522 support::ulittle32_t SizeOfData;
523 support::ulittle16_t OrdinalHint;
524 support::ulittle16_t TypeInfo;
525
526 int getType() const { return TypeInfo & 0x3; }
527 int getNameType() const { return (TypeInfo >> 2) & 0x7; }
528};
529
530struct coff_import_directory_table_entry {
531 support::ulittle32_t ImportLookupTableRVA;
532 support::ulittle32_t TimeDateStamp;
533 support::ulittle32_t ForwarderChain;
534 support::ulittle32_t NameRVA;
535 support::ulittle32_t ImportAddressTableRVA;
536
537 bool isNull() const {
538 return ImportLookupTableRVA == 0 && TimeDateStamp == 0 &&
539 ForwarderChain == 0 && NameRVA == 0 && ImportAddressTableRVA == 0;
540 }
541};
542
543template <typename IntTy>
544struct coff_tls_directory {
545 IntTy StartAddressOfRawData;
546 IntTy EndAddressOfRawData;
547 IntTy AddressOfIndex;
548 IntTy AddressOfCallBacks;
549 support::ulittle32_t SizeOfZeroFill;
550 support::ulittle32_t Characteristics;
551
552 uint32_t getAlignment() const {
553 // Bit [20:24] contains section alignment.
554 uint32_t Shift = (Characteristics & 0x00F00000) >> 20;
555 if (Shift > 0)
556 return 1U << (Shift - 1);
557 return 0;
558 }
559};
560
561using coff_tls_directory32 = coff_tls_directory<support::little32_t>;
562using coff_tls_directory64 = coff_tls_directory<support::little64_t>;
563
564/// Bits in control flow guard flags as we understand them.
565enum class coff_guard_flags : uint32_t {
566 CFInstrumented = 0x00000100,
567 HasFidTable = 0x00000400,
568 ProtectDelayLoadIAT = 0x00001000,
569 DelayLoadIATSection = 0x00002000, // Delay load in separate section
570 HasLongJmpTable = 0x00010000,
571 FidTableHasFlags = 0x10000000, // Indicates that fid tables are 5 bytes
572};
573
574struct coff_load_config_code_integrity {
575 support::ulittle16_t Flags;
576 support::ulittle16_t Catalog;
577 support::ulittle32_t CatalogOffset;
578 support::ulittle32_t Reserved;
579};
580
581/// 32-bit load config (IMAGE_LOAD_CONFIG_DIRECTORY32)
582struct coff_load_configuration32 {
583 support::ulittle32_t Size;
584 support::ulittle32_t TimeDateStamp;
585 support::ulittle16_t MajorVersion;
586 support::ulittle16_t MinorVersion;
587 support::ulittle32_t GlobalFlagsClear;
588 support::ulittle32_t GlobalFlagsSet;
589 support::ulittle32_t CriticalSectionDefaultTimeout;
590 support::ulittle32_t DeCommitFreeBlockThreshold;
591 support::ulittle32_t DeCommitTotalFreeThreshold;
592 support::ulittle32_t LockPrefixTable;
593 support::ulittle32_t MaximumAllocationSize;
594 support::ulittle32_t VirtualMemoryThreshold;
595 support::ulittle32_t ProcessAffinityMask;
596 support::ulittle32_t ProcessHeapFlags;
597 support::ulittle16_t CSDVersion;
598 support::ulittle16_t DependentLoadFlags;
599 support::ulittle32_t EditList;
600 support::ulittle32_t SecurityCookie;
601 support::ulittle32_t SEHandlerTable;
602 support::ulittle32_t SEHandlerCount;
603
604 // Added in MSVC 2015 for /guard:cf.
605 support::ulittle32_t GuardCFCheckFunction;
606 support::ulittle32_t GuardCFCheckDispatch;
607 support::ulittle32_t GuardCFFunctionTable;
608 support::ulittle32_t GuardCFFunctionCount;
609 support::ulittle32_t GuardFlags; // coff_guard_flags
610
611 // Added in MSVC 2017
612 coff_load_config_code_integrity CodeIntegrity;
613 support::ulittle32_t GuardAddressTakenIatEntryTable;
614 support::ulittle32_t GuardAddressTakenIatEntryCount;
615 support::ulittle32_t GuardLongJumpTargetTable;
616 support::ulittle32_t GuardLongJumpTargetCount;
617 support::ulittle32_t DynamicValueRelocTable;
618 support::ulittle32_t CHPEMetadataPointer;
619 support::ulittle32_t GuardRFFailureRoutine;
620 support::ulittle32_t GuardRFFailureRoutineFunctionPointer;
621 support::ulittle32_t DynamicValueRelocTableOffset;
622 support::ulittle16_t DynamicValueRelocTableSection;
623 support::ulittle16_t Reserved2;
624 support::ulittle32_t GuardRFVerifyStackPointerFunctionPointer;
625 support::ulittle32_t HotPatchTableOffset;
626};
627
628/// 64-bit load config (IMAGE_LOAD_CONFIG_DIRECTORY64)
629struct coff_load_configuration64 {
630 support::ulittle32_t Size;
631 support::ulittle32_t TimeDateStamp;
632 support::ulittle16_t MajorVersion;
633 support::ulittle16_t MinorVersion;
634 support::ulittle32_t GlobalFlagsClear;
635 support::ulittle32_t GlobalFlagsSet;
636 support::ulittle32_t CriticalSectionDefaultTimeout;
637 support::ulittle64_t DeCommitFreeBlockThreshold;
638 support::ulittle64_t DeCommitTotalFreeThreshold;
639 support::ulittle64_t LockPrefixTable;
640 support::ulittle64_t MaximumAllocationSize;
641 support::ulittle64_t VirtualMemoryThreshold;
642 support::ulittle64_t ProcessAffinityMask;
643 support::ulittle32_t ProcessHeapFlags;
644 support::ulittle16_t CSDVersion;
645 support::ulittle16_t DependentLoadFlags;
646 support::ulittle64_t EditList;
647 support::ulittle64_t SecurityCookie;
648 support::ulittle64_t SEHandlerTable;
649 support::ulittle64_t SEHandlerCount;
650
651 // Added in MSVC 2015 for /guard:cf.
652 support::ulittle64_t GuardCFCheckFunction;
653 support::ulittle64_t GuardCFCheckDispatch;
654 support::ulittle64_t GuardCFFunctionTable;
655 support::ulittle64_t GuardCFFunctionCount;
656 support::ulittle32_t GuardFlags;
657
658 // Added in MSVC 2017
659 coff_load_config_code_integrity CodeIntegrity;
660 support::ulittle64_t GuardAddressTakenIatEntryTable;
661 support::ulittle64_t GuardAddressTakenIatEntryCount;
662 support::ulittle64_t GuardLongJumpTargetTable;
663 support::ulittle64_t GuardLongJumpTargetCount;
664 support::ulittle64_t DynamicValueRelocTable;
665 support::ulittle64_t CHPEMetadataPointer;
666 support::ulittle64_t GuardRFFailureRoutine;
667 support::ulittle64_t GuardRFFailureRoutineFunctionPointer;
668 support::ulittle32_t DynamicValueRelocTableOffset;
669 support::ulittle16_t DynamicValueRelocTableSection;
670 support::ulittle16_t Reserved2;
671 support::ulittle64_t GuardRFVerifyStackPointerFunctionPointer;
672 support::ulittle32_t HotPatchTableOffset;
673};
674
675struct coff_runtime_function_x64 {
676 support::ulittle32_t BeginAddress;
677 support::ulittle32_t EndAddress;
678 support::ulittle32_t UnwindInformation;
679};
680
681struct coff_base_reloc_block_header {
682 support::ulittle32_t PageRVA;
683 support::ulittle32_t BlockSize;
684};
685
686struct coff_base_reloc_block_entry {
687 support::ulittle16_t Data;
688
689 int getType() const { return Data >> 12; }
690 int getOffset() const { return Data & ((1 << 12) - 1); }
691};
692
693struct coff_resource_dir_entry {
694 union {
695 support::ulittle32_t NameOffset;
696 support::ulittle32_t ID;
697 uint32_t getNameOffset() const {
698 return maskTrailingOnes<uint32_t>(31) & NameOffset;
699 }
700 // Even though the PE/COFF spec doesn't mention this, the high bit of a name
701 // offset is set.
702 void setNameOffset(uint32_t Offset) { NameOffset = Offset | (1 << 31); }
703 } Identifier;
704 union {
705 support::ulittle32_t DataEntryOffset;
706 support::ulittle32_t SubdirOffset;
707
708 bool isSubDir() const { return SubdirOffset >> 31; }
709 uint32_t value() const {
710 return maskTrailingOnes<uint32_t>(31) & SubdirOffset;
711 }
712
713 } Offset;
714};
715
716struct coff_resource_data_entry {
717 support::ulittle32_t DataRVA;
718 support::ulittle32_t DataSize;
719 support::ulittle32_t Codepage;
720 support::ulittle32_t Reserved;
721};
722
723struct coff_resource_dir_table {
724 support::ulittle32_t Characteristics;
725 support::ulittle32_t TimeDateStamp;
726 support::ulittle16_t MajorVersion;
727 support::ulittle16_t MinorVersion;
728 support::ulittle16_t NumberOfNameEntries;
729 support::ulittle16_t NumberOfIDEntries;
730};
731
732class COFFObjectFile : public ObjectFile {
733private:
734 friend class ImportDirectoryEntryRef;
735 friend class ExportDirectoryEntryRef;
736 const coff_file_header *COFFHeader;
737 const coff_bigobj_file_header *COFFBigObjHeader;
738 const pe32_header *PE32Header;
739 const pe32plus_header *PE32PlusHeader;
740 const data_directory *DataDirectory;
741 const coff_section *SectionTable;
742 const coff_symbol16 *SymbolTable16;
743 const coff_symbol32 *SymbolTable32;
744 const char *StringTable;
745 uint32_t StringTableSize;
746 const coff_import_directory_table_entry *ImportDirectory;
747 const delay_import_directory_table_entry *DelayImportDirectory;
748 uint32_t NumberOfDelayImportDirectory;
749 const export_directory_table_entry *ExportDirectory;
750 const coff_base_reloc_block_header *BaseRelocHeader;
751 const coff_base_reloc_block_header *BaseRelocEnd;
752 const debug_directory *DebugDirectoryBegin;
753 const debug_directory *DebugDirectoryEnd;
754 // Either coff_load_configuration32 or coff_load_configuration64.
755 const void *LoadConfig = nullptr;
756
757 std::error_code getString(uint32_t offset, StringRef &Res) const;
758
759 template <typename coff_symbol_type>
760 const coff_symbol_type *toSymb(DataRefImpl Symb) const;
761 const coff_section *toSec(DataRefImpl Sec) const;
762 const coff_relocation *toRel(DataRefImpl Rel) const;
763
764 std::error_code initSymbolTablePtr();
765 std::error_code initImportTablePtr();
766 std::error_code initDelayImportTablePtr();
767 std::error_code initExportTablePtr();
768 std::error_code initBaseRelocPtr();
769 std::error_code initDebugDirectoryPtr();
770 std::error_code initLoadConfigPtr();
771
772public:
773 uintptr_t getSymbolTable() const {
774 if (SymbolTable16)
775 return reinterpret_cast<uintptr_t>(SymbolTable16);
776 if (SymbolTable32)
777 return reinterpret_cast<uintptr_t>(SymbolTable32);
778 return uintptr_t(0);
779 }
780
781 uint16_t getMachine() const {
782 if (COFFHeader)
783 return COFFHeader->Machine;
784 if (COFFBigObjHeader)
785 return COFFBigObjHeader->Machine;
786 llvm_unreachable("no COFF header!")::llvm::llvm_unreachable_internal("no COFF header!", "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 786)
;
787 }
788
789 uint16_t getSizeOfOptionalHeader() const {
790 if (COFFHeader)
791 return COFFHeader->isImportLibrary() ? 0
792 : COFFHeader->SizeOfOptionalHeader;
793 // bigobj doesn't have this field.
794 if (COFFBigObjHeader)
795 return 0;
796 llvm_unreachable("no COFF header!")::llvm::llvm_unreachable_internal("no COFF header!", "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 796)
;
797 }
798
799 uint16_t getCharacteristics() const {
800 if (COFFHeader)
801 return COFFHeader->isImportLibrary() ? 0 : COFFHeader->Characteristics;
802 // bigobj doesn't have characteristics to speak of,
803 // editbin will silently lie to you if you attempt to set any.
804 if (COFFBigObjHeader)
805 return 0;
806 llvm_unreachable("no COFF header!")::llvm::llvm_unreachable_internal("no COFF header!", "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 806)
;
807 }
808
809 uint32_t getTimeDateStamp() const {
810 if (COFFHeader)
811 return COFFHeader->TimeDateStamp;
812 if (COFFBigObjHeader)
813 return COFFBigObjHeader->TimeDateStamp;
814 llvm_unreachable("no COFF header!")::llvm::llvm_unreachable_internal("no COFF header!", "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 814)
;
815 }
816
817 uint32_t getNumberOfSections() const {
818 if (COFFHeader)
819 return COFFHeader->isImportLibrary() ? 0 : COFFHeader->NumberOfSections;
820 if (COFFBigObjHeader)
821 return COFFBigObjHeader->NumberOfSections;
822 llvm_unreachable("no COFF header!")::llvm::llvm_unreachable_internal("no COFF header!", "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 822)
;
823 }
824
825 uint32_t getPointerToSymbolTable() const {
826 if (COFFHeader)
827 return COFFHeader->isImportLibrary() ? 0
828 : COFFHeader->PointerToSymbolTable;
829 if (COFFBigObjHeader)
830 return COFFBigObjHeader->PointerToSymbolTable;
831 llvm_unreachable("no COFF header!")::llvm::llvm_unreachable_internal("no COFF header!", "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 831)
;
832 }
833
834 uint32_t getRawNumberOfSymbols() const {
835 if (COFFHeader)
836 return COFFHeader->isImportLibrary() ? 0 : COFFHeader->NumberOfSymbols;
837 if (COFFBigObjHeader)
838 return COFFBigObjHeader->NumberOfSymbols;
839 llvm_unreachable("no COFF header!")::llvm::llvm_unreachable_internal("no COFF header!", "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 839)
;
840 }
841
842 uint32_t getNumberOfSymbols() const {
843 if (!SymbolTable16 && !SymbolTable32)
844 return 0;
845 return getRawNumberOfSymbols();
846 }
847
848 const coff_load_configuration32 *getLoadConfig32() const {
849 assert(!is64())(static_cast <bool> (!is64()) ? void (0) : __assert_fail
("!is64()", "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 849, __extension__ __PRETTY_FUNCTION__))
;
850 return reinterpret_cast<const coff_load_configuration32 *>(LoadConfig);
851 }
852
853 const coff_load_configuration64 *getLoadConfig64() const {
854 assert(is64())(static_cast <bool> (is64()) ? void (0) : __assert_fail
("is64()", "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 854, __extension__ __PRETTY_FUNCTION__))
;
855 return reinterpret_cast<const coff_load_configuration64 *>(LoadConfig);
856 }
857
858protected:
859 void moveSymbolNext(DataRefImpl &Symb) const override;
860 Expected<StringRef> getSymbolName(DataRefImpl Symb) const override;
861 Expected<uint64_t> getSymbolAddress(DataRefImpl Symb) const override;
862 uint32_t getSymbolAlignment(DataRefImpl Symb) const override;
863 uint64_t getSymbolValueImpl(DataRefImpl Symb) const override;
864 uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const override;
865 uint32_t getSymbolFlags(DataRefImpl Symb) const override;
866 Expected<SymbolRef::Type> getSymbolType(DataRefImpl Symb) const override;
867 Expected<section_iterator> getSymbolSection(DataRefImpl Symb) const override;
868 void moveSectionNext(DataRefImpl &Sec) const override;
869 std::error_code getSectionName(DataRefImpl Sec,
870 StringRef &Res) const override;
871 uint64_t getSectionAddress(DataRefImpl Sec) const override;
872 uint64_t getSectionIndex(DataRefImpl Sec) const override;
873 uint64_t getSectionSize(DataRefImpl Sec) const override;
874 std::error_code getSectionContents(DataRefImpl Sec,
875 StringRef &Res) const override;
876 uint64_t getSectionAlignment(DataRefImpl Sec) const override;
877 bool isSectionCompressed(DataRefImpl Sec) const override;
878 bool isSectionText(DataRefImpl Sec) const override;
879 bool isSectionData(DataRefImpl Sec) const override;
880 bool isSectionBSS(DataRefImpl Sec) const override;
881 bool isSectionVirtual(DataRefImpl Sec) const override;
882 relocation_iterator section_rel_begin(DataRefImpl Sec) const override;
883 relocation_iterator section_rel_end(DataRefImpl Sec) const override;
884
885 void moveRelocationNext(DataRefImpl &Rel) const override;
886 uint64_t getRelocationOffset(DataRefImpl Rel) const override;
887 symbol_iterator getRelocationSymbol(DataRefImpl Rel) const override;
888 uint64_t getRelocationType(DataRefImpl Rel) const override;
889 void getRelocationTypeName(DataRefImpl Rel,
890 SmallVectorImpl<char> &Result) const override;
891
892public:
893 COFFObjectFile(MemoryBufferRef Object, std::error_code &EC);
894
895 basic_symbol_iterator symbol_begin() const override;
896 basic_symbol_iterator symbol_end() const override;
897 section_iterator section_begin() const override;
898 section_iterator section_end() const override;
899
900 const coff_section *getCOFFSection(const SectionRef &Section) const;
901 COFFSymbolRef getCOFFSymbol(const DataRefImpl &Ref) const;
902 COFFSymbolRef getCOFFSymbol(const SymbolRef &Symbol) const;
903 const coff_relocation *getCOFFRelocation(const RelocationRef &Reloc) const;
904 unsigned getSectionID(SectionRef Sec) const;
905 unsigned getSymbolSectionID(SymbolRef Sym) const;
906
907 uint8_t getBytesInAddress() const override;
908 StringRef getFileFormatName() const override;
909 unsigned getArch() const override;
910 SubtargetFeatures getFeatures() const override { return SubtargetFeatures(); }
911
912 import_directory_iterator import_directory_begin() const;
913 import_directory_iterator import_directory_end() const;
914 delay_import_directory_iterator delay_import_directory_begin() const;
915 delay_import_directory_iterator delay_import_directory_end() const;
916 export_directory_iterator export_directory_begin() const;
917 export_directory_iterator export_directory_end() const;
918 base_reloc_iterator base_reloc_begin() const;
919 base_reloc_iterator base_reloc_end() const;
920 const debug_directory *debug_directory_begin() const {
921 return DebugDirectoryBegin;
922 }
923 const debug_directory *debug_directory_end() const {
924 return DebugDirectoryEnd;
925 }
926
927 iterator_range<import_directory_iterator> import_directories() const;
928 iterator_range<delay_import_directory_iterator>
929 delay_import_directories() const;
930 iterator_range<export_directory_iterator> export_directories() const;
931 iterator_range<base_reloc_iterator> base_relocs() const;
932 iterator_range<const debug_directory *> debug_directories() const {
933 return make_range(debug_directory_begin(), debug_directory_end());
934 }
935
936 const dos_header *getDOSHeader() const {
937 if (!PE32Header && !PE32PlusHeader)
938 return nullptr;
939 return reinterpret_cast<const dos_header *>(base());
940 }
941 std::error_code getPE32Header(const pe32_header *&Res) const;
942 std::error_code getPE32PlusHeader(const pe32plus_header *&Res) const;
943 std::error_code getDataDirectory(uint32_t index,
944 const data_directory *&Res) const;
945 std::error_code getSection(int32_t index, const coff_section *&Res) const;
946
947 template <typename coff_symbol_type>
948 std::error_code getSymbol(uint32_t Index,
949 const coff_symbol_type *&Res) const {
950 if (Index >= getNumberOfSymbols())
951 return object_error::parse_failed;
952
953 Res = reinterpret_cast<coff_symbol_type *>(getSymbolTable()) + Index;
954 return std::error_code();
955 }
956 Expected<COFFSymbolRef> getSymbol(uint32_t index) const {
957 if (SymbolTable16) {
958 const coff_symbol16 *Symb = nullptr;
959 if (std::error_code EC = getSymbol(index, Symb))
960 return errorCodeToError(EC);
961 return COFFSymbolRef(Symb);
962 }
963 if (SymbolTable32) {
964 const coff_symbol32 *Symb = nullptr;
965 if (std::error_code EC = getSymbol(index, Symb))
966 return errorCodeToError(EC);
967 return COFFSymbolRef(Symb);
968 }
969 return errorCodeToError(object_error::parse_failed);
970 }
971
972 template <typename T>
973 std::error_code getAuxSymbol(uint32_t index, const T *&Res) const {
974 Expected<COFFSymbolRef> S = getSymbol(index);
975 if (Error E = S.takeError())
976 return errorToErrorCode(std::move(E));
977 Res = reinterpret_cast<const T *>(S->getRawPtr());
978 return std::error_code();
979 }
980
981 std::error_code getSymbolName(COFFSymbolRef Symbol, StringRef &Res) const;
982 std::error_code getSymbolName(const coff_symbol_generic *Symbol,
983 StringRef &Res) const;
984
985 ArrayRef<uint8_t> getSymbolAuxData(COFFSymbolRef Symbol) const;
986
987 size_t getSymbolTableEntrySize() const {
988 if (COFFHeader)
989 return sizeof(coff_symbol16);
990 if (COFFBigObjHeader)
991 return sizeof(coff_symbol32);
992 llvm_unreachable("null symbol table pointer!")::llvm::llvm_unreachable_internal("null symbol table pointer!"
, "/build/llvm-toolchain-snapshot-6.0~svn318801/include/llvm/Object/COFF.h"
, 992)
;
993 }
994
995 iterator_range<const coff_relocation *>
996 getRelocations(const coff_section *Sec) const;
997
998 std::error_code getSectionName(const coff_section *Sec, StringRef &Res) const;
999 uint64_t getSectionSize(const coff_section *Sec) const;
1000 std::error_code getSectionContents(const coff_section *Sec,
1001 ArrayRef<uint8_t> &Res) const;
1002
1003 uint64_t getImageBase() const;
1004 std::error_code getVaPtr(uint64_t VA, uintptr_t &Res) const;
1005 std::error_code getRvaPtr(uint32_t Rva, uintptr_t &Res) const;
1006
1007 /// Given an RVA base and size, returns a valid array of bytes or an error
1008 /// code if the RVA and size is not contained completely within a valid
1009 /// section.
1010 std::error_code getRvaAndSizeAsBytes(uint32_t RVA, uint32_t Size,
1011 ArrayRef<uint8_t> &Contents) const;
1012
1013 std::error_code getHintName(uint32_t Rva, uint16_t &Hint,
1014 StringRef &Name) const;
1015
1016 /// Get PDB information out of a codeview debug directory entry.
1017 std::error_code getDebugPDBInfo(const debug_directory *DebugDir,
1018 const codeview::DebugInfo *&Info,
1019 StringRef &PDBFileName) const;
1020
1021 /// Get PDB information from an executable. If the information is not present,
1022 /// Info will be set to nullptr and PDBFileName will be empty. An error is
1023 /// returned only on corrupt object files. Convenience accessor that can be
1024 /// used if the debug directory is not already handy.
1025 std::error_code getDebugPDBInfo(const codeview::DebugInfo *&Info,
1026 StringRef &PDBFileName) const;
1027
1028 bool isRelocatableObject() const override;
1029 bool is64() const { return PE32PlusHeader; }
1030
1031 static bool classof(const Binary *v) { return v->isCOFF(); }
1032};
1033
1034// The iterator for the import directory table.
1035class ImportDirectoryEntryRef {
1036public:
1037 ImportDirectoryEntryRef() = default;
1038 ImportDirectoryEntryRef(const coff_import_directory_table_entry *Table,
1039 uint32_t I, const COFFObjectFile *Owner)
1040 : ImportTable(Table), Index(I), OwningObject(Owner) {}
1041
1042 bool operator==(const ImportDirectoryEntryRef &Other) const;
1043 void moveNext();
1044
1045 imported_symbol_iterator imported_symbol_begin() const;
1046 imported_symbol_iterator imported_symbol_end() const;
1047 iterator_range<imported_symbol_iterator> imported_symbols() const;
1048
1049 imported_symbol_iterator lookup_table_begin() const;
1050 imported_symbol_iterator lookup_table_end() const;
1051 iterator_range<imported_symbol_iterator> lookup_table_symbols() const;
1052
1053 std::error_code getName(StringRef &Result) const;
1054 std::error_code getImportLookupTableRVA(uint32_t &Result) const;
1055 std::error_code getImportAddressTableRVA(uint32_t &Result) const;
1056
1057 std::error_code
1058 getImportTableEntry(const coff_import_directory_table_entry *&Result) const;
1059
1060private:
1061 const coff_import_directory_table_entry *ImportTable;
1062 uint32_t Index;
1063 const COFFObjectFile *OwningObject = nullptr;
1064};
1065
1066class DelayImportDirectoryEntryRef {
1067public:
1068 DelayImportDirectoryEntryRef() = default;
1069 DelayImportDirectoryEntryRef(const delay_import_directory_table_entry *T,
1070 uint32_t I, const COFFObjectFile *Owner)
1071 : Table(T), Index(I), OwningObject(Owner) {}
1072
1073 bool operator==(const DelayImportDirectoryEntryRef &Other) const;
1074 void moveNext();
1075
1076 imported_symbol_iterator imported_symbol_begin() const;
1077 imported_symbol_iterator imported_symbol_end() const;
1078 iterator_range<imported_symbol_iterator> imported_symbols() const;
1079
1080 std::error_code getName(StringRef &Result) const;
1081 std::error_code getDelayImportTable(
1082 const delay_import_directory_table_entry *&Result) const;
1083 std::error_code getImportAddress(int AddrIndex, uint64_t &Result) const;
1084
1085private:
1086 const delay_import_directory_table_entry *Table;
1087 uint32_t Index;
1088 const COFFObjectFile *OwningObject = nullptr;
1089};
1090
1091// The iterator for the export directory table entry.
1092class ExportDirectoryEntryRef {
1093public:
1094 ExportDirectoryEntryRef() = default;
1095 ExportDirectoryEntryRef(const export_directory_table_entry *Table, uint32_t I,
1096 const COFFObjectFile *Owner)
1097 : ExportTable(Table), Index(I), OwningObject(Owner) {}
1098
1099 bool operator==(const ExportDirectoryEntryRef &Other) const;
1100 void moveNext();
1101
1102 std::error_code getDllName(StringRef &Result) const;
1103 std::error_code getOrdinalBase(uint32_t &Result) const;
1104 std::error_code getOrdinal(uint32_t &Result) const;
1105 std::error_code getExportRVA(uint32_t &Result) const;
1106 std::error_code getSymbolName(StringRef &Result) const;
1107
1108 std::error_code isForwarder(bool &Result) const;
1109 std::error_code getForwardTo(StringRef &Result) const;
1110
1111private:
1112 const export_directory_table_entry *ExportTable;
1113 uint32_t Index;
1114 const COFFObjectFile *OwningObject = nullptr;
1115};
1116
1117class ImportedSymbolRef {
1118public:
1119 ImportedSymbolRef() = default;
1120 ImportedSymbolRef(const import_lookup_table_entry32 *Entry, uint32_t I,
1121 const COFFObjectFile *Owner)
1122 : Entry32(Entry), Entry64(nullptr), Index(I), OwningObject(Owner) {}
1123 ImportedSymbolRef(const import_lookup_table_entry64 *Entry, uint32_t I,
1124 const COFFObjectFile *Owner)
1125 : Entry32(nullptr), Entry64(Entry), Index(I), OwningObject(Owner) {}
1126
1127 bool operator==(const ImportedSymbolRef &Other) const;
1128 void moveNext();
1129
1130 std::error_code getSymbolName(StringRef &Result) const;
1131 std::error_code isOrdinal(bool &Result) const;
1132 std::error_code getOrdinal(uint16_t &Result) const;
1133 std::error_code getHintNameRVA(uint32_t &Result) const;
1134
1135private:
1136 const import_lookup_table_entry32 *Entry32;
1137 const import_lookup_table_entry64 *Entry64;
1138 uint32_t Index;
1139 const COFFObjectFile *OwningObject = nullptr;
1140};
1141
1142class BaseRelocRef {
1143public:
1144 BaseRelocRef() = default;
1145 BaseRelocRef(const coff_base_reloc_block_header *Header,
1146 const COFFObjectFile *Owner)
1147 : Header(Header), Index(0) {}
1148
1149 bool operator==(const BaseRelocRef &Other) const;
1150 void moveNext();
1151
1152 std::error_code getType(uint8_t &Type) const;
1153 std::error_code getRVA(uint32_t &Result) const;
1154
1155private:
1156 const coff_base_reloc_block_header *Header;
1157 uint32_t Index;
1158};
1159
1160class ResourceSectionRef {
1161public:
1162 ResourceSectionRef() = default;
1163 explicit ResourceSectionRef(StringRef Ref) : BBS(Ref, support::little) {}
1164
1165 Expected<ArrayRef<UTF16>>
1166 getEntryNameString(const coff_resource_dir_entry &Entry);
1167 Expected<const coff_resource_dir_table &>
1168 getEntrySubDir(const coff_resource_dir_entry &Entry);
1169 Expected<const coff_resource_dir_table &> getBaseTable();
1170
1171private:
1172 BinaryByteStream BBS;
1173
1174 Expected<const coff_resource_dir_table &> getTableAtOffset(uint32_t Offset);
1175 Expected<ArrayRef<UTF16>> getDirStringAtOffset(uint32_t Offset);
1176};
1177
1178// Corresponds to `_FPO_DATA` structure in the PE/COFF spec.
1179struct FpoData {
1180 support::ulittle32_t Offset; // ulOffStart: Offset 1st byte of function code
1181 support::ulittle32_t Size; // cbProcSize: # bytes in function
1182 support::ulittle32_t NumLocals; // cdwLocals: # bytes in locals/4
1183 support::ulittle16_t NumParams; // cdwParams: # bytes in params/4
1184 support::ulittle16_t Attributes;
1185
1186 // cbProlog: # bytes in prolog
1187 int getPrologSize() const { return Attributes & 0xF; }
1188
1189 // cbRegs: # regs saved
1190 int getNumSavedRegs() const { return (Attributes >> 8) & 0x7; }
1191
1192 // fHasSEH: true if seh is func
1193 bool hasSEH() const { return (Attributes >> 9) & 1; }
1194
1195 // fUseBP: true if EBP has been allocated
1196 bool useBP() const { return (Attributes >> 10) & 1; }
1197
1198 // cbFrame: frame pointer
1199 int getFP() const { return Attributes >> 14; }
1200};
1201
1202} // end namespace object
1203
1204} // end namespace llvm
1205
1206#endif // LLVM_OBJECT_COFF_H