Bug Summary

File:include/llvm/Object/COFF.h
Warning:line 317, column 38
Called C++ object pointer is null

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name COFFObjectFile.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mthread-model posix -fmath-errno -masm-verbose -mconstructor-aliases -munwind-tables -fuse-init-array -target-cpu x86-64 -dwarf-column-info -debugger-tuning=gdb -momit-leaf-frame-pointer -ffunction-sections -fdata-sections -resource-dir /usr/lib/llvm-9/lib/clang/9.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-9~svn361465/build-llvm/lib/Object -I /build/llvm-toolchain-snapshot-9~svn361465/lib/Object -I /build/llvm-toolchain-snapshot-9~svn361465/build-llvm/include -I /build/llvm-toolchain-snapshot-9~svn361465/include -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0/backward -internal-isystem /usr/include/clang/9.0.0/include/ -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-9/lib/clang/9.0.0/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-comment -std=c++11 -fdeprecated-macro -fdebug-compilation-dir /build/llvm-toolchain-snapshot-9~svn361465/build-llvm/lib/Object -fdebug-prefix-map=/build/llvm-toolchain-snapshot-9~svn361465=. -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -stack-protector 2 -fobjc-runtime=gcc -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -o /tmp/scan-build-2019-05-24-031927-21217-1 -x c++ /build/llvm-toolchain-snapshot-9~svn361465/lib/Object/COFFObjectFile.cpp -faddrsig

/build/llvm-toolchain-snapshot-9~svn361465/lib/Object/COFFObjectFile.cpp

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

/build/llvm-toolchain-snapshot-9~svn361465/include/llvm/Object/COFF.h

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