Bug Summary

File:include/llvm/Support/Error.h
Warning:line 201, column 5
Potential leak of memory pointed to by 'Payload._M_t._M_head_impl'

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 RuntimeDyld.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 -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-8/lib/clang/8.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-8~svn345461/build-llvm/lib/ExecutionEngine/RuntimeDyld -I /build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld -I /build/llvm-toolchain-snapshot-8~svn345461/build-llvm/include -I /build/llvm-toolchain-snapshot-8~svn345461/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/8.0.0/include/ -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-8/lib/clang/8.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-8~svn345461/build-llvm/lib/ExecutionEngine/RuntimeDyld -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -fobjc-runtime=gcc -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -o /tmp/scan-build-2018-10-27-211344-32123-1 -x c++ /build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp -faddrsig

/build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp

1//===-- RuntimeDyld.cpp - Run-time dynamic linker for MC-JIT ----*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Implementation of the MC-JIT runtime dynamic linker.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/ExecutionEngine/RuntimeDyld.h"
15#include "RuntimeDyldCOFF.h"
16#include "RuntimeDyldCheckerImpl.h"
17#include "RuntimeDyldELF.h"
18#include "RuntimeDyldImpl.h"
19#include "RuntimeDyldMachO.h"
20#include "llvm/Object/COFF.h"
21#include "llvm/Object/ELFObjectFile.h"
22#include "llvm/Support/MSVCErrorWorkarounds.h"
23#include "llvm/Support/ManagedStatic.h"
24#include "llvm/Support/MathExtras.h"
25#include "llvm/Support/MutexGuard.h"
26
27#include <future>
28
29using namespace llvm;
30using namespace llvm::object;
31
32#define DEBUG_TYPE"dyld" "dyld"
33
34namespace {
35
36enum RuntimeDyldErrorCode {
37 GenericRTDyldError = 1
38};
39
40// FIXME: This class is only here to support the transition to llvm::Error. It
41// will be removed once this transition is complete. Clients should prefer to
42// deal with the Error value directly, rather than converting to error_code.
43class RuntimeDyldErrorCategory : public std::error_category {
44public:
45 const char *name() const noexcept override { return "runtimedyld"; }
46
47 std::string message(int Condition) const override {
48 switch (static_cast<RuntimeDyldErrorCode>(Condition)) {
49 case GenericRTDyldError: return "Generic RuntimeDyld error";
50 }
51 llvm_unreachable("Unrecognized RuntimeDyldErrorCode")::llvm::llvm_unreachable_internal("Unrecognized RuntimeDyldErrorCode"
, "/build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp"
, 51)
;
52 }
53};
54
55static ManagedStatic<RuntimeDyldErrorCategory> RTDyldErrorCategory;
56
57}
58
59char RuntimeDyldError::ID = 0;
60
61void RuntimeDyldError::log(raw_ostream &OS) const {
62 OS << ErrMsg << "\n";
63}
64
65std::error_code RuntimeDyldError::convertToErrorCode() const {
66 return std::error_code(GenericRTDyldError, *RTDyldErrorCategory);
67}
68
69// Empty out-of-line virtual destructor as the key function.
70RuntimeDyldImpl::~RuntimeDyldImpl() {}
71
72// Pin LoadedObjectInfo's vtables to this file.
73void RuntimeDyld::LoadedObjectInfo::anchor() {}
74
75namespace llvm {
76
77void RuntimeDyldImpl::registerEHFrames() {}
78
79void RuntimeDyldImpl::deregisterEHFrames() {
80 MemMgr.deregisterEHFrames();
81}
82
83#ifndef NDEBUG
84static void dumpSectionMemory(const SectionEntry &S, StringRef State) {
85 dbgs() << "----- Contents of section " << S.getName() << " " << State
86 << " -----";
87
88 if (S.getAddress() == nullptr) {
89 dbgs() << "\n <section not emitted>\n";
90 return;
91 }
92
93 const unsigned ColsPerRow = 16;
94
95 uint8_t *DataAddr = S.getAddress();
96 uint64_t LoadAddr = S.getLoadAddress();
97
98 unsigned StartPadding = LoadAddr & (ColsPerRow - 1);
99 unsigned BytesRemaining = S.getSize();
100
101 if (StartPadding) {
102 dbgs() << "\n" << format("0x%016" PRIx64"l" "x",
103 LoadAddr & ~(uint64_t)(ColsPerRow - 1)) << ":";
104 while (StartPadding--)
105 dbgs() << " ";
106 }
107
108 while (BytesRemaining > 0) {
109 if ((LoadAddr & (ColsPerRow - 1)) == 0)
110 dbgs() << "\n" << format("0x%016" PRIx64"l" "x", LoadAddr) << ":";
111
112 dbgs() << " " << format("%02x", *DataAddr);
113
114 ++DataAddr;
115 ++LoadAddr;
116 --BytesRemaining;
117 }
118
119 dbgs() << "\n";
120}
121#endif
122
123// Resolve the relocations for all symbols we currently know about.
124void RuntimeDyldImpl::resolveRelocations() {
125 MutexGuard locked(lock);
126
127 // Print out the sections prior to relocation.
128 LLVM_DEBUG(for (int i = 0, e = Sections.size(); i != e; ++i)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { for (int i = 0, e = Sections.size(); i != e; ++i)
dumpSectionMemory(Sections[i], "before relocations");; } } while
(false)
129 dumpSectionMemory(Sections[i], "before relocations");)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { for (int i = 0, e = Sections.size(); i != e; ++i)
dumpSectionMemory(Sections[i], "before relocations");; } } while
(false)
;
130
131 // First, resolve relocations associated with external symbols.
132 if (auto Err = resolveExternalSymbols()) {
133 HasError = true;
134 ErrorStr = toString(std::move(Err));
135 }
136
137 resolveLocalRelocations();
138
139 // Print out sections after relocation.
140 LLVM_DEBUG(for (int i = 0, e = Sections.size(); i != e; ++i)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { for (int i = 0, e = Sections.size(); i != e; ++i)
dumpSectionMemory(Sections[i], "after relocations");; } } while
(false)
141 dumpSectionMemory(Sections[i], "after relocations");)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { for (int i = 0, e = Sections.size(); i != e; ++i)
dumpSectionMemory(Sections[i], "after relocations");; } } while
(false)
;
142}
143
144void RuntimeDyldImpl::resolveLocalRelocations() {
145 // Iterate over all outstanding relocations
146 for (auto it = Relocations.begin(), e = Relocations.end(); it != e; ++it) {
147 // The Section here (Sections[i]) refers to the section in which the
148 // symbol for the relocation is located. The SectionID in the relocation
149 // entry provides the section to which the relocation will be applied.
150 int Idx = it->first;
151 uint64_t Addr = Sections[Idx].getLoadAddress();
152 LLVM_DEBUG(dbgs() << "Resolving relocations Section #" << Idx << "\t"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Resolving relocations Section #"
<< Idx << "\t" << format("%p", (uintptr_t)
Addr) << "\n"; } } while (false)
153 << format("%p", (uintptr_t)Addr) << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Resolving relocations Section #"
<< Idx << "\t" << format("%p", (uintptr_t)
Addr) << "\n"; } } while (false)
;
154 resolveRelocationList(it->second, Addr);
155 }
156 Relocations.clear();
157}
158
159void RuntimeDyldImpl::mapSectionAddress(const void *LocalAddress,
160 uint64_t TargetAddress) {
161 MutexGuard locked(lock);
162 for (unsigned i = 0, e = Sections.size(); i != e; ++i) {
163 if (Sections[i].getAddress() == LocalAddress) {
164 reassignSectionAddress(i, TargetAddress);
165 return;
166 }
167 }
168 llvm_unreachable("Attempting to remap address of unknown section!")::llvm::llvm_unreachable_internal("Attempting to remap address of unknown section!"
, "/build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp"
, 168)
;
169}
170
171static Error getOffset(const SymbolRef &Sym, SectionRef Sec,
172 uint64_t &Result) {
173 Expected<uint64_t> AddressOrErr = Sym.getAddress();
174 if (!AddressOrErr)
175 return AddressOrErr.takeError();
176 Result = *AddressOrErr - Sec.getAddress();
177 return Error::success();
178}
179
180Expected<RuntimeDyldImpl::ObjSectionToIDMap>
181RuntimeDyldImpl::loadObjectImpl(const object::ObjectFile &Obj) {
182 MutexGuard locked(lock);
183
184 // Save information about our target
185 Arch = (Triple::ArchType)Obj.getArch();
186 IsTargetLittleEndian = Obj.isLittleEndian();
187 setMipsABI(Obj);
188
189 // Compute the memory size required to load all sections to be loaded
190 // and pass this information to the memory manager
191 if (MemMgr.needsToReserveAllocationSpace()) {
192 uint64_t CodeSize = 0, RODataSize = 0, RWDataSize = 0;
193 uint32_t CodeAlign = 1, RODataAlign = 1, RWDataAlign = 1;
194 if (auto Err = computeTotalAllocSize(Obj,
195 CodeSize, CodeAlign,
196 RODataSize, RODataAlign,
197 RWDataSize, RWDataAlign))
198 return std::move(Err);
199 MemMgr.reserveAllocationSpace(CodeSize, CodeAlign, RODataSize, RODataAlign,
200 RWDataSize, RWDataAlign);
201 }
202
203 // Used sections from the object file
204 ObjSectionToIDMap LocalSections;
205
206 // Common symbols requiring allocation, with their sizes and alignments
207 CommonSymbolList CommonSymbolsToAllocate;
208
209 uint64_t CommonSize = 0;
210 uint32_t CommonAlign = 0;
211
212 // First, collect all weak and common symbols. We need to know if stronger
213 // definitions occur elsewhere.
214 JITSymbolResolver::LookupSet ResponsibilitySet;
215 {
216 JITSymbolResolver::LookupSet Symbols;
217 for (auto &Sym : Obj.symbols()) {
218 uint32_t Flags = Sym.getFlags();
219 if ((Flags & SymbolRef::SF_Common) || (Flags & SymbolRef::SF_Weak)) {
220 // Get symbol name.
221 if (auto NameOrErr = Sym.getName())
222 Symbols.insert(*NameOrErr);
223 else
224 return NameOrErr.takeError();
225 }
226 }
227
228 if (auto ResultOrErr = Resolver.getResponsibilitySet(Symbols))
229 ResponsibilitySet = std::move(*ResultOrErr);
230 else
231 return ResultOrErr.takeError();
232 }
233
234 // Parse symbols
235 LLVM_DEBUG(dbgs() << "Parse symbols:\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Parse symbols:\n"; } } while (false
)
;
236 for (symbol_iterator I = Obj.symbol_begin(), E = Obj.symbol_end(); I != E;
237 ++I) {
238 uint32_t Flags = I->getFlags();
239
240 // Skip undefined symbols.
241 if (Flags & SymbolRef::SF_Undefined)
242 continue;
243
244 // Get the symbol type.
245 object::SymbolRef::Type SymType;
246 if (auto SymTypeOrErr = I->getType())
247 SymType = *SymTypeOrErr;
248 else
249 return SymTypeOrErr.takeError();
250
251 // Get symbol name.
252 StringRef Name;
253 if (auto NameOrErr = I->getName())
254 Name = *NameOrErr;
255 else
256 return NameOrErr.takeError();
257
258 // Compute JIT symbol flags.
259 auto JITSymFlags = getJITSymbolFlags(*I);
260 if (!JITSymFlags)
261 return JITSymFlags.takeError();
262
263 // If this is a weak definition, check to see if there's a strong one.
264 // If there is, skip this symbol (we won't be providing it: the strong
265 // definition will). If there's no strong definition, make this definition
266 // strong.
267 if (JITSymFlags->isWeak() || JITSymFlags->isCommon()) {
268 // First check whether there's already a definition in this instance.
269 if (GlobalSymbolTable.count(Name))
270 continue;
271
272 // If we're not responsible for this symbol, skip it.
273 if (!ResponsibilitySet.count(Name))
274 continue;
275
276 // Otherwise update the flags on the symbol to make this definition
277 // strong.
278 if (JITSymFlags->isWeak())
279 *JITSymFlags &= ~JITSymbolFlags::Weak;
280 if (JITSymFlags->isCommon()) {
281 *JITSymFlags &= ~JITSymbolFlags::Common;
282 uint32_t Align = I->getAlignment();
283 uint64_t Size = I->getCommonSize();
284 if (!CommonAlign)
285 CommonAlign = Align;
286 CommonSize = alignTo(CommonSize, Align) + Size;
287 CommonSymbolsToAllocate.push_back(*I);
288 }
289 }
290
291 if (Flags & SymbolRef::SF_Absolute &&
292 SymType != object::SymbolRef::ST_File) {
293 uint64_t Addr = 0;
294 if (auto AddrOrErr = I->getAddress())
295 Addr = *AddrOrErr;
296 else
297 return AddrOrErr.takeError();
298
299 unsigned SectionID = AbsoluteSymbolSection;
300
301 LLVM_DEBUG(dbgs() << "\tType: " << SymType << " (absolute) Name: " << Namedo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "\tType: " << SymType <<
" (absolute) Name: " << Name << " SID: " <<
SectionID << " Offset: " << format("%p", (uintptr_t
)Addr) << " flags: " << Flags << "\n"; } } while
(false)
302 << " SID: " << SectionIDdo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "\tType: " << SymType <<
" (absolute) Name: " << Name << " SID: " <<
SectionID << " Offset: " << format("%p", (uintptr_t
)Addr) << " flags: " << Flags << "\n"; } } while
(false)
303 << " Offset: " << format("%p", (uintptr_t)Addr)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "\tType: " << SymType <<
" (absolute) Name: " << Name << " SID: " <<
SectionID << " Offset: " << format("%p", (uintptr_t
)Addr) << " flags: " << Flags << "\n"; } } while
(false)
304 << " flags: " << Flags << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "\tType: " << SymType <<
" (absolute) Name: " << Name << " SID: " <<
SectionID << " Offset: " << format("%p", (uintptr_t
)Addr) << " flags: " << Flags << "\n"; } } while
(false)
;
305 GlobalSymbolTable[Name] = SymbolTableEntry(SectionID, Addr, *JITSymFlags);
306 } else if (SymType == object::SymbolRef::ST_Function ||
307 SymType == object::SymbolRef::ST_Data ||
308 SymType == object::SymbolRef::ST_Unknown ||
309 SymType == object::SymbolRef::ST_Other) {
310
311 section_iterator SI = Obj.section_end();
312 if (auto SIOrErr = I->getSection())
313 SI = *SIOrErr;
314 else
315 return SIOrErr.takeError();
316
317 if (SI == Obj.section_end())
318 continue;
319
320 // Get symbol offset.
321 uint64_t SectOffset;
322 if (auto Err = getOffset(*I, *SI, SectOffset))
323 return std::move(Err);
324
325 bool IsCode = SI->isText();
326 unsigned SectionID;
327 if (auto SectionIDOrErr =
328 findOrEmitSection(Obj, *SI, IsCode, LocalSections))
329 SectionID = *SectionIDOrErr;
330 else
331 return SectionIDOrErr.takeError();
332
333 LLVM_DEBUG(dbgs() << "\tType: " << SymType << " Name: " << Namedo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "\tType: " << SymType <<
" Name: " << Name << " SID: " << SectionID
<< " Offset: " << format("%p", (uintptr_t)SectOffset
) << " flags: " << Flags << "\n"; } } while
(false)
334 << " SID: " << SectionIDdo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "\tType: " << SymType <<
" Name: " << Name << " SID: " << SectionID
<< " Offset: " << format("%p", (uintptr_t)SectOffset
) << " flags: " << Flags << "\n"; } } while
(false)
335 << " Offset: " << format("%p", (uintptr_t)SectOffset)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "\tType: " << SymType <<
" Name: " << Name << " SID: " << SectionID
<< " Offset: " << format("%p", (uintptr_t)SectOffset
) << " flags: " << Flags << "\n"; } } while
(false)
336 << " flags: " << Flags << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "\tType: " << SymType <<
" Name: " << Name << " SID: " << SectionID
<< " Offset: " << format("%p", (uintptr_t)SectOffset
) << " flags: " << Flags << "\n"; } } while
(false)
;
337 GlobalSymbolTable[Name] =
338 SymbolTableEntry(SectionID, SectOffset, *JITSymFlags);
339 }
340 }
341
342 // Allocate common symbols
343 if (auto Err = emitCommonSymbols(Obj, CommonSymbolsToAllocate, CommonSize,
344 CommonAlign))
345 return std::move(Err);
346
347 // Parse and process relocations
348 LLVM_DEBUG(dbgs() << "Parse relocations:\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Parse relocations:\n"; } } while
(false)
;
349 for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
350 SI != SE; ++SI) {
351 StubMap Stubs;
352 section_iterator RelocatedSection = SI->getRelocatedSection();
353
354 if (RelocatedSection == SE)
355 continue;
356
357 relocation_iterator I = SI->relocation_begin();
358 relocation_iterator E = SI->relocation_end();
359
360 if (I == E && !ProcessAllSections)
361 continue;
362
363 bool IsCode = RelocatedSection->isText();
364 unsigned SectionID = 0;
365 if (auto SectionIDOrErr = findOrEmitSection(Obj, *RelocatedSection, IsCode,
366 LocalSections))
367 SectionID = *SectionIDOrErr;
368 else
369 return SectionIDOrErr.takeError();
370
371 LLVM_DEBUG(dbgs() << "\tSectionID: " << SectionID << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "\tSectionID: " << SectionID
<< "\n"; } } while (false)
;
372
373 for (; I != E;)
374 if (auto IOrErr = processRelocationRef(SectionID, I, Obj, LocalSections, Stubs))
375 I = *IOrErr;
376 else
377 return IOrErr.takeError();
378
379 // If there is an attached checker, notify it about the stubs for this
380 // section so that they can be verified.
381 if (Checker)
382 Checker->registerStubMap(Obj.getFileName(), SectionID, Stubs);
383 }
384
385 // Give the subclasses a chance to tie-up any loose ends.
386 if (auto Err = finalizeLoad(Obj, LocalSections))
387 return std::move(Err);
388
389// for (auto E : LocalSections)
390// llvm::dbgs() << "Added: " << E.first.getRawDataRefImpl() << " -> " << E.second << "\n";
391
392 return LocalSections;
393}
394
395// A helper method for computeTotalAllocSize.
396// Computes the memory size required to allocate sections with the given sizes,
397// assuming that all sections are allocated with the given alignment
398static uint64_t
399computeAllocationSizeForSections(std::vector<uint64_t> &SectionSizes,
400 uint64_t Alignment) {
401 uint64_t TotalSize = 0;
402 for (size_t Idx = 0, Cnt = SectionSizes.size(); Idx < Cnt; Idx++) {
403 uint64_t AlignedSize =
404 (SectionSizes[Idx] + Alignment - 1) / Alignment * Alignment;
405 TotalSize += AlignedSize;
406 }
407 return TotalSize;
408}
409
410static bool isRequiredForExecution(const SectionRef Section) {
411 const ObjectFile *Obj = Section.getObject();
412 if (isa<object::ELFObjectFileBase>(Obj))
413 return ELFSectionRef(Section).getFlags() & ELF::SHF_ALLOC;
414 if (auto *COFFObj = dyn_cast<object::COFFObjectFile>(Obj)) {
415 const coff_section *CoffSection = COFFObj->getCOFFSection(Section);
416 // Avoid loading zero-sized COFF sections.
417 // In PE files, VirtualSize gives the section size, and SizeOfRawData
418 // may be zero for sections with content. In Obj files, SizeOfRawData
419 // gives the section size, and VirtualSize is always zero. Hence
420 // the need to check for both cases below.
421 bool HasContent =
422 (CoffSection->VirtualSize > 0) || (CoffSection->SizeOfRawData > 0);
423 bool IsDiscardable =
424 CoffSection->Characteristics &
425 (COFF::IMAGE_SCN_MEM_DISCARDABLE | COFF::IMAGE_SCN_LNK_INFO);
426 return HasContent && !IsDiscardable;
427 }
428
429 assert(isa<MachOObjectFile>(Obj))((isa<MachOObjectFile>(Obj)) ? static_cast<void> (
0) : __assert_fail ("isa<MachOObjectFile>(Obj)", "/build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp"
, 429, __PRETTY_FUNCTION__))
;
430 return true;
431}
432
433static bool isReadOnlyData(const SectionRef Section) {
434 const ObjectFile *Obj = Section.getObject();
435 if (isa<object::ELFObjectFileBase>(Obj))
436 return !(ELFSectionRef(Section).getFlags() &
437 (ELF::SHF_WRITE | ELF::SHF_EXECINSTR));
438 if (auto *COFFObj = dyn_cast<object::COFFObjectFile>(Obj))
439 return ((COFFObj->getCOFFSection(Section)->Characteristics &
440 (COFF::IMAGE_SCN_CNT_INITIALIZED_DATA
441 | COFF::IMAGE_SCN_MEM_READ
442 | COFF::IMAGE_SCN_MEM_WRITE))
443 ==
444 (COFF::IMAGE_SCN_CNT_INITIALIZED_DATA
445 | COFF::IMAGE_SCN_MEM_READ));
446
447 assert(isa<MachOObjectFile>(Obj))((isa<MachOObjectFile>(Obj)) ? static_cast<void> (
0) : __assert_fail ("isa<MachOObjectFile>(Obj)", "/build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp"
, 447, __PRETTY_FUNCTION__))
;
448 return false;
449}
450
451static bool isZeroInit(const SectionRef Section) {
452 const ObjectFile *Obj = Section.getObject();
453 if (isa<object::ELFObjectFileBase>(Obj))
454 return ELFSectionRef(Section).getType() == ELF::SHT_NOBITS;
455 if (auto *COFFObj = dyn_cast<object::COFFObjectFile>(Obj))
456 return COFFObj->getCOFFSection(Section)->Characteristics &
457 COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA;
458
459 auto *MachO = cast<MachOObjectFile>(Obj);
460 unsigned SectionType = MachO->getSectionType(Section);
461 return SectionType == MachO::S_ZEROFILL ||
462 SectionType == MachO::S_GB_ZEROFILL;
463}
464
465// Compute an upper bound of the memory size that is required to load all
466// sections
467Error RuntimeDyldImpl::computeTotalAllocSize(const ObjectFile &Obj,
468 uint64_t &CodeSize,
469 uint32_t &CodeAlign,
470 uint64_t &RODataSize,
471 uint32_t &RODataAlign,
472 uint64_t &RWDataSize,
473 uint32_t &RWDataAlign) {
474 // Compute the size of all sections required for execution
475 std::vector<uint64_t> CodeSectionSizes;
476 std::vector<uint64_t> ROSectionSizes;
477 std::vector<uint64_t> RWSectionSizes;
478
479 // Collect sizes of all sections to be loaded;
480 // also determine the max alignment of all sections
481 for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
482 SI != SE; ++SI) {
483 const SectionRef &Section = *SI;
484
485 bool IsRequired = isRequiredForExecution(Section) || ProcessAllSections;
486
487 // Consider only the sections that are required to be loaded for execution
488 if (IsRequired) {
489 uint64_t DataSize = Section.getSize();
490 uint64_t Alignment64 = Section.getAlignment();
491 unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL;
492 bool IsCode = Section.isText();
493 bool IsReadOnly = isReadOnlyData(Section);
494
495 StringRef Name;
496 if (auto EC = Section.getName(Name))
497 return errorCodeToError(EC);
498
499 uint64_t StubBufSize = computeSectionStubBufSize(Obj, Section);
500 uint64_t SectionSize = DataSize + StubBufSize;
501
502 // The .eh_frame section (at least on Linux) needs an extra four bytes
503 // padded
504 // with zeroes added at the end. For MachO objects, this section has a
505 // slightly different name, so this won't have any effect for MachO
506 // objects.
507 if (Name == ".eh_frame")
508 SectionSize += 4;
509
510 if (!SectionSize)
511 SectionSize = 1;
512
513 if (IsCode) {
514 CodeAlign = std::max(CodeAlign, Alignment);
515 CodeSectionSizes.push_back(SectionSize);
516 } else if (IsReadOnly) {
517 RODataAlign = std::max(RODataAlign, Alignment);
518 ROSectionSizes.push_back(SectionSize);
519 } else {
520 RWDataAlign = std::max(RWDataAlign, Alignment);
521 RWSectionSizes.push_back(SectionSize);
522 }
523 }
524 }
525
526 // Compute Global Offset Table size. If it is not zero we
527 // also update alignment, which is equal to a size of a
528 // single GOT entry.
529 if (unsigned GotSize = computeGOTSize(Obj)) {
530 RWSectionSizes.push_back(GotSize);
531 RWDataAlign = std::max<uint32_t>(RWDataAlign, getGOTEntrySize());
532 }
533
534 // Compute the size of all common symbols
535 uint64_t CommonSize = 0;
536 uint32_t CommonAlign = 1;
537 for (symbol_iterator I = Obj.symbol_begin(), E = Obj.symbol_end(); I != E;
538 ++I) {
539 uint32_t Flags = I->getFlags();
540 if (Flags & SymbolRef::SF_Common) {
541 // Add the common symbols to a list. We'll allocate them all below.
542 uint64_t Size = I->getCommonSize();
543 uint32_t Align = I->getAlignment();
544 // If this is the first common symbol, use its alignment as the alignment
545 // for the common symbols section.
546 if (CommonSize == 0)
547 CommonAlign = Align;
548 CommonSize = alignTo(CommonSize, Align) + Size;
549 }
550 }
551 if (CommonSize != 0) {
552 RWSectionSizes.push_back(CommonSize);
553 RWDataAlign = std::max(RWDataAlign, CommonAlign);
554 }
555
556 // Compute the required allocation space for each different type of sections
557 // (code, read-only data, read-write data) assuming that all sections are
558 // allocated with the max alignment. Note that we cannot compute with the
559 // individual alignments of the sections, because then the required size
560 // depends on the order, in which the sections are allocated.
561 CodeSize = computeAllocationSizeForSections(CodeSectionSizes, CodeAlign);
562 RODataSize = computeAllocationSizeForSections(ROSectionSizes, RODataAlign);
563 RWDataSize = computeAllocationSizeForSections(RWSectionSizes, RWDataAlign);
564
565 return Error::success();
566}
567
568// compute GOT size
569unsigned RuntimeDyldImpl::computeGOTSize(const ObjectFile &Obj) {
570 size_t GotEntrySize = getGOTEntrySize();
571 if (!GotEntrySize)
572 return 0;
573
574 size_t GotSize = 0;
575 for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
576 SI != SE; ++SI) {
577
578 for (const RelocationRef &Reloc : SI->relocations())
579 if (relocationNeedsGot(Reloc))
580 GotSize += GotEntrySize;
581 }
582
583 return GotSize;
584}
585
586// compute stub buffer size for the given section
587unsigned RuntimeDyldImpl::computeSectionStubBufSize(const ObjectFile &Obj,
588 const SectionRef &Section) {
589 unsigned StubSize = getMaxStubSize();
590 if (StubSize == 0) {
591 return 0;
592 }
593 // FIXME: this is an inefficient way to handle this. We should computed the
594 // necessary section allocation size in loadObject by walking all the sections
595 // once.
596 unsigned StubBufSize = 0;
597 for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
598 SI != SE; ++SI) {
599 section_iterator RelSecI = SI->getRelocatedSection();
600 if (!(RelSecI == Section))
601 continue;
602
603 for (const RelocationRef &Reloc : SI->relocations())
604 if (relocationNeedsStub(Reloc))
605 StubBufSize += StubSize;
606 }
607
608 // Get section data size and alignment
609 uint64_t DataSize = Section.getSize();
610 uint64_t Alignment64 = Section.getAlignment();
611
612 // Add stubbuf size alignment
613 unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL;
614 unsigned StubAlignment = getStubAlignment();
615 unsigned EndAlignment = (DataSize | Alignment) & -(DataSize | Alignment);
616 if (StubAlignment > EndAlignment)
617 StubBufSize += StubAlignment - EndAlignment;
618 return StubBufSize;
619}
620
621uint64_t RuntimeDyldImpl::readBytesUnaligned(uint8_t *Src,
622 unsigned Size) const {
623 uint64_t Result = 0;
624 if (IsTargetLittleEndian) {
625 Src += Size - 1;
626 while (Size--)
627 Result = (Result << 8) | *Src--;
628 } else
629 while (Size--)
630 Result = (Result << 8) | *Src++;
631
632 return Result;
633}
634
635void RuntimeDyldImpl::writeBytesUnaligned(uint64_t Value, uint8_t *Dst,
636 unsigned Size) const {
637 if (IsTargetLittleEndian) {
638 while (Size--) {
639 *Dst++ = Value & 0xFF;
640 Value >>= 8;
641 }
642 } else {
643 Dst += Size - 1;
644 while (Size--) {
645 *Dst-- = Value & 0xFF;
646 Value >>= 8;
647 }
648 }
649}
650
651Expected<JITSymbolFlags>
652RuntimeDyldImpl::getJITSymbolFlags(const SymbolRef &SR) {
653 return JITSymbolFlags::fromObjectSymbol(SR);
654}
655
656Error RuntimeDyldImpl::emitCommonSymbols(const ObjectFile &Obj,
657 CommonSymbolList &SymbolsToAllocate,
658 uint64_t CommonSize,
659 uint32_t CommonAlign) {
660 if (SymbolsToAllocate.empty())
661 return Error::success();
662
663 // Allocate memory for the section
664 unsigned SectionID = Sections.size();
665 uint8_t *Addr = MemMgr.allocateDataSection(CommonSize, CommonAlign, SectionID,
666 "<common symbols>", false);
667 if (!Addr)
668 report_fatal_error("Unable to allocate memory for common symbols!");
669 uint64_t Offset = 0;
670 Sections.push_back(
671 SectionEntry("<common symbols>", Addr, CommonSize, CommonSize, 0));
672 memset(Addr, 0, CommonSize);
673
674 LLVM_DEBUG(dbgs() << "emitCommonSection SectionID: " << SectionIDdo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "emitCommonSection SectionID: " <<
SectionID << " new addr: " << format("%p", Addr)
<< " DataSize: " << CommonSize << "\n"; } }
while (false)
675 << " new addr: " << format("%p", Addr)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "emitCommonSection SectionID: " <<
SectionID << " new addr: " << format("%p", Addr)
<< " DataSize: " << CommonSize << "\n"; } }
while (false)
676 << " DataSize: " << CommonSize << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "emitCommonSection SectionID: " <<
SectionID << " new addr: " << format("%p", Addr)
<< " DataSize: " << CommonSize << "\n"; } }
while (false)
;
677
678 // Assign the address of each symbol
679 for (auto &Sym : SymbolsToAllocate) {
680 uint32_t Align = Sym.getAlignment();
681 uint64_t Size = Sym.getCommonSize();
682 StringRef Name;
683 if (auto NameOrErr = Sym.getName())
684 Name = *NameOrErr;
685 else
686 return NameOrErr.takeError();
687 if (Align) {
688 // This symbol has an alignment requirement.
689 uint64_t AlignOffset = OffsetToAlignment((uint64_t)Addr, Align);
690 Addr += AlignOffset;
691 Offset += AlignOffset;
692 }
693 auto JITSymFlags = getJITSymbolFlags(Sym);
694
695 if (!JITSymFlags)
696 return JITSymFlags.takeError();
697
698 LLVM_DEBUG(dbgs() << "Allocating common symbol " << Name << " address "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Allocating common symbol " <<
Name << " address " << format("%p", Addr) <<
"\n"; } } while (false)
699 << format("%p", Addr) << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Allocating common symbol " <<
Name << " address " << format("%p", Addr) <<
"\n"; } } while (false)
;
700 GlobalSymbolTable[Name] =
701 SymbolTableEntry(SectionID, Offset, std::move(*JITSymFlags));
702 Offset += Size;
703 Addr += Size;
704 }
705
706 if (Checker)
707 Checker->registerSection(Obj.getFileName(), SectionID);
708
709 return Error::success();
710}
711
712Expected<unsigned>
713RuntimeDyldImpl::emitSection(const ObjectFile &Obj,
714 const SectionRef &Section,
715 bool IsCode) {
716 StringRef data;
717 uint64_t Alignment64 = Section.getAlignment();
718
719 unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL;
720 unsigned PaddingSize = 0;
721 unsigned StubBufSize = 0;
722 bool IsRequired = isRequiredForExecution(Section);
723 bool IsVirtual = Section.isVirtual();
724 bool IsZeroInit = isZeroInit(Section);
725 bool IsReadOnly = isReadOnlyData(Section);
726 uint64_t DataSize = Section.getSize();
727
728 StringRef Name;
729 if (auto EC = Section.getName(Name))
730 return errorCodeToError(EC);
731
732 StubBufSize = computeSectionStubBufSize(Obj, Section);
733
734 // The .eh_frame section (at least on Linux) needs an extra four bytes padded
735 // with zeroes added at the end. For MachO objects, this section has a
736 // slightly different name, so this won't have any effect for MachO objects.
737 if (Name == ".eh_frame")
738 PaddingSize = 4;
739
740 uintptr_t Allocate;
741 unsigned SectionID = Sections.size();
742 uint8_t *Addr;
743 const char *pData = nullptr;
744
745 // If this section contains any bits (i.e. isn't a virtual or bss section),
746 // grab a reference to them.
747 if (!IsVirtual && !IsZeroInit) {
748 // In either case, set the location of the unrelocated section in memory,
749 // since we still process relocations for it even if we're not applying them.
750 if (auto EC = Section.getContents(data))
751 return errorCodeToError(EC);
752 pData = data.data();
753 }
754
755 // Code section alignment needs to be at least as high as stub alignment or
756 // padding calculations may by incorrect when the section is remapped to a
757 // higher alignment.
758 if (IsCode) {
759 Alignment = std::max(Alignment, getStubAlignment());
760 if (StubBufSize > 0)
761 PaddingSize += getStubAlignment() - 1;
762 }
763
764 // Some sections, such as debug info, don't need to be loaded for execution.
765 // Process those only if explicitly requested.
766 if (IsRequired || ProcessAllSections) {
767 Allocate = DataSize + PaddingSize + StubBufSize;
768 if (!Allocate)
769 Allocate = 1;
770 Addr = IsCode ? MemMgr.allocateCodeSection(Allocate, Alignment, SectionID,
771 Name)
772 : MemMgr.allocateDataSection(Allocate, Alignment, SectionID,
773 Name, IsReadOnly);
774 if (!Addr)
775 report_fatal_error("Unable to allocate section memory!");
776
777 // Zero-initialize or copy the data from the image
778 if (IsZeroInit || IsVirtual)
779 memset(Addr, 0, DataSize);
780 else
781 memcpy(Addr, pData, DataSize);
782
783 // Fill in any extra bytes we allocated for padding
784 if (PaddingSize != 0) {
785 memset(Addr + DataSize, 0, PaddingSize);
786 // Update the DataSize variable to include padding.
787 DataSize += PaddingSize;
788
789 // Align DataSize to stub alignment if we have any stubs (PaddingSize will
790 // have been increased above to account for this).
791 if (StubBufSize > 0)
792 DataSize &= ~(getStubAlignment() - 1);
793 }
794
795 LLVM_DEBUG(dbgs() << "emitSection SectionID: " << SectionID << " Name: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "emitSection SectionID: " <<
SectionID << " Name: " << Name << " obj addr: "
<< format("%p", pData) << " new addr: " <<
format("%p", Addr) << " DataSize: " << DataSize <<
" StubBufSize: " << StubBufSize << " Allocate: "
<< Allocate << "\n"; } } while (false)
796 << Name << " obj addr: " << format("%p", pData)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "emitSection SectionID: " <<
SectionID << " Name: " << Name << " obj addr: "
<< format("%p", pData) << " new addr: " <<
format("%p", Addr) << " DataSize: " << DataSize <<
" StubBufSize: " << StubBufSize << " Allocate: "
<< Allocate << "\n"; } } while (false)
797 << " new addr: " << format("%p", Addr) << " DataSize: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "emitSection SectionID: " <<
SectionID << " Name: " << Name << " obj addr: "
<< format("%p", pData) << " new addr: " <<
format("%p", Addr) << " DataSize: " << DataSize <<
" StubBufSize: " << StubBufSize << " Allocate: "
<< Allocate << "\n"; } } while (false)
798 << DataSize << " StubBufSize: " << StubBufSizedo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "emitSection SectionID: " <<
SectionID << " Name: " << Name << " obj addr: "
<< format("%p", pData) << " new addr: " <<
format("%p", Addr) << " DataSize: " << DataSize <<
" StubBufSize: " << StubBufSize << " Allocate: "
<< Allocate << "\n"; } } while (false)
799 << " Allocate: " << Allocate << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "emitSection SectionID: " <<
SectionID << " Name: " << Name << " obj addr: "
<< format("%p", pData) << " new addr: " <<
format("%p", Addr) << " DataSize: " << DataSize <<
" StubBufSize: " << StubBufSize << " Allocate: "
<< Allocate << "\n"; } } while (false)
;
800 } else {
801 // Even if we didn't load the section, we need to record an entry for it
802 // to handle later processing (and by 'handle' I mean don't do anything
803 // with these sections).
804 Allocate = 0;
805 Addr = nullptr;
806 LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "emitSection SectionID: " <<
SectionID << " Name: " << Name << " obj addr: "
<< format("%p", data.data()) << " new addr: 0" <<
" DataSize: " << DataSize << " StubBufSize: " <<
StubBufSize << " Allocate: " << Allocate <<
"\n"; } } while (false)
807 dbgs() << "emitSection SectionID: " << SectionID << " Name: " << Namedo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "emitSection SectionID: " <<
SectionID << " Name: " << Name << " obj addr: "
<< format("%p", data.data()) << " new addr: 0" <<
" DataSize: " << DataSize << " StubBufSize: " <<
StubBufSize << " Allocate: " << Allocate <<
"\n"; } } while (false)
808 << " obj addr: " << format("%p", data.data()) << " new addr: 0"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "emitSection SectionID: " <<
SectionID << " Name: " << Name << " obj addr: "
<< format("%p", data.data()) << " new addr: 0" <<
" DataSize: " << DataSize << " StubBufSize: " <<
StubBufSize << " Allocate: " << Allocate <<
"\n"; } } while (false)
809 << " DataSize: " << DataSize << " StubBufSize: " << StubBufSizedo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "emitSection SectionID: " <<
SectionID << " Name: " << Name << " obj addr: "
<< format("%p", data.data()) << " new addr: 0" <<
" DataSize: " << DataSize << " StubBufSize: " <<
StubBufSize << " Allocate: " << Allocate <<
"\n"; } } while (false)
810 << " Allocate: " << Allocate << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "emitSection SectionID: " <<
SectionID << " Name: " << Name << " obj addr: "
<< format("%p", data.data()) << " new addr: 0" <<
" DataSize: " << DataSize << " StubBufSize: " <<
StubBufSize << " Allocate: " << Allocate <<
"\n"; } } while (false)
;
811 }
812
813 Sections.push_back(
814 SectionEntry(Name, Addr, DataSize, Allocate, (uintptr_t)pData));
815
816 // Debug info sections are linked as if their load address was zero
817 if (!IsRequired)
818 Sections.back().setLoadAddress(0);
819
820 if (Checker)
821 Checker->registerSection(Obj.getFileName(), SectionID);
822
823 return SectionID;
824}
825
826Expected<unsigned>
827RuntimeDyldImpl::findOrEmitSection(const ObjectFile &Obj,
828 const SectionRef &Section,
829 bool IsCode,
830 ObjSectionToIDMap &LocalSections) {
831
832 unsigned SectionID = 0;
833 ObjSectionToIDMap::iterator i = LocalSections.find(Section);
834 if (i != LocalSections.end())
835 SectionID = i->second;
836 else {
837 if (auto SectionIDOrErr = emitSection(Obj, Section, IsCode))
838 SectionID = *SectionIDOrErr;
839 else
840 return SectionIDOrErr.takeError();
841 LocalSections[Section] = SectionID;
842 }
843 return SectionID;
844}
845
846void RuntimeDyldImpl::addRelocationForSection(const RelocationEntry &RE,
847 unsigned SectionID) {
848 Relocations[SectionID].push_back(RE);
849}
850
851void RuntimeDyldImpl::addRelocationForSymbol(const RelocationEntry &RE,
852 StringRef SymbolName) {
853 // Relocation by symbol. If the symbol is found in the global symbol table,
854 // create an appropriate section relocation. Otherwise, add it to
855 // ExternalSymbolRelocations.
856 RTDyldSymbolTable::const_iterator Loc = GlobalSymbolTable.find(SymbolName);
857 if (Loc == GlobalSymbolTable.end()) {
858 ExternalSymbolRelocations[SymbolName].push_back(RE);
859 } else {
860 // Copy the RE since we want to modify its addend.
861 RelocationEntry RECopy = RE;
862 const auto &SymInfo = Loc->second;
863 RECopy.Addend += SymInfo.getOffset();
864 Relocations[SymInfo.getSectionID()].push_back(RECopy);
865 }
866}
867
868uint8_t *RuntimeDyldImpl::createStubFunction(uint8_t *Addr,
869 unsigned AbiVariant) {
870 if (Arch == Triple::aarch64 || Arch == Triple::aarch64_be) {
871 // This stub has to be able to access the full address space,
872 // since symbol lookup won't necessarily find a handy, in-range,
873 // PLT stub for functions which could be anywhere.
874 // Stub can use ip0 (== x16) to calculate address
875 writeBytesUnaligned(0xd2e00010, Addr, 4); // movz ip0, #:abs_g3:<addr>
876 writeBytesUnaligned(0xf2c00010, Addr+4, 4); // movk ip0, #:abs_g2_nc:<addr>
877 writeBytesUnaligned(0xf2a00010, Addr+8, 4); // movk ip0, #:abs_g1_nc:<addr>
878 writeBytesUnaligned(0xf2800010, Addr+12, 4); // movk ip0, #:abs_g0_nc:<addr>
879 writeBytesUnaligned(0xd61f0200, Addr+16, 4); // br ip0
880
881 return Addr;
882 } else if (Arch == Triple::arm || Arch == Triple::armeb) {
883 // TODO: There is only ARM far stub now. We should add the Thumb stub,
884 // and stubs for branches Thumb - ARM and ARM - Thumb.
885 writeBytesUnaligned(0xe51ff004, Addr, 4); // ldr pc, [pc, #-4]
886 return Addr + 4;
887 } else if (IsMipsO32ABI || IsMipsN32ABI) {
888 // 0: 3c190000 lui t9,%hi(addr).
889 // 4: 27390000 addiu t9,t9,%lo(addr).
890 // 8: 03200008 jr t9.
891 // c: 00000000 nop.
892 const unsigned LuiT9Instr = 0x3c190000, AdduiT9Instr = 0x27390000;
893 const unsigned NopInstr = 0x0;
894 unsigned JrT9Instr = 0x03200008;
895 if ((AbiVariant & ELF::EF_MIPS_ARCH) == ELF::EF_MIPS_ARCH_32R6 ||
896 (AbiVariant & ELF::EF_MIPS_ARCH) == ELF::EF_MIPS_ARCH_64R6)
897 JrT9Instr = 0x03200009;
898
899 writeBytesUnaligned(LuiT9Instr, Addr, 4);
900 writeBytesUnaligned(AdduiT9Instr, Addr + 4, 4);
901 writeBytesUnaligned(JrT9Instr, Addr + 8, 4);
902 writeBytesUnaligned(NopInstr, Addr + 12, 4);
903 return Addr;
904 } else if (IsMipsN64ABI) {
905 // 0: 3c190000 lui t9,%highest(addr).
906 // 4: 67390000 daddiu t9,t9,%higher(addr).
907 // 8: 0019CC38 dsll t9,t9,16.
908 // c: 67390000 daddiu t9,t9,%hi(addr).
909 // 10: 0019CC38 dsll t9,t9,16.
910 // 14: 67390000 daddiu t9,t9,%lo(addr).
911 // 18: 03200008 jr t9.
912 // 1c: 00000000 nop.
913 const unsigned LuiT9Instr = 0x3c190000, DaddiuT9Instr = 0x67390000,
914 DsllT9Instr = 0x19CC38;
915 const unsigned NopInstr = 0x0;
916 unsigned JrT9Instr = 0x03200008;
917 if ((AbiVariant & ELF::EF_MIPS_ARCH) == ELF::EF_MIPS_ARCH_64R6)
918 JrT9Instr = 0x03200009;
919
920 writeBytesUnaligned(LuiT9Instr, Addr, 4);
921 writeBytesUnaligned(DaddiuT9Instr, Addr + 4, 4);
922 writeBytesUnaligned(DsllT9Instr, Addr + 8, 4);
923 writeBytesUnaligned(DaddiuT9Instr, Addr + 12, 4);
924 writeBytesUnaligned(DsllT9Instr, Addr + 16, 4);
925 writeBytesUnaligned(DaddiuT9Instr, Addr + 20, 4);
926 writeBytesUnaligned(JrT9Instr, Addr + 24, 4);
927 writeBytesUnaligned(NopInstr, Addr + 28, 4);
928 return Addr;
929 } else if (Arch == Triple::ppc64 || Arch == Triple::ppc64le) {
930 // Depending on which version of the ELF ABI is in use, we need to
931 // generate one of two variants of the stub. They both start with
932 // the same sequence to load the target address into r12.
933 writeInt32BE(Addr, 0x3D800000); // lis r12, highest(addr)
934 writeInt32BE(Addr+4, 0x618C0000); // ori r12, higher(addr)
935 writeInt32BE(Addr+8, 0x798C07C6); // sldi r12, r12, 32
936 writeInt32BE(Addr+12, 0x658C0000); // oris r12, r12, h(addr)
937 writeInt32BE(Addr+16, 0x618C0000); // ori r12, r12, l(addr)
938 if (AbiVariant == 2) {
939 // PowerPC64 stub ELFv2 ABI: The address points to the function itself.
940 // The address is already in r12 as required by the ABI. Branch to it.
941 writeInt32BE(Addr+20, 0xF8410018); // std r2, 24(r1)
942 writeInt32BE(Addr+24, 0x7D8903A6); // mtctr r12
943 writeInt32BE(Addr+28, 0x4E800420); // bctr
944 } else {
945 // PowerPC64 stub ELFv1 ABI: The address points to a function descriptor.
946 // Load the function address on r11 and sets it to control register. Also
947 // loads the function TOC in r2 and environment pointer to r11.
948 writeInt32BE(Addr+20, 0xF8410028); // std r2, 40(r1)
949 writeInt32BE(Addr+24, 0xE96C0000); // ld r11, 0(r12)
950 writeInt32BE(Addr+28, 0xE84C0008); // ld r2, 0(r12)
951 writeInt32BE(Addr+32, 0x7D6903A6); // mtctr r11
952 writeInt32BE(Addr+36, 0xE96C0010); // ld r11, 16(r2)
953 writeInt32BE(Addr+40, 0x4E800420); // bctr
954 }
955 return Addr;
956 } else if (Arch == Triple::systemz) {
957 writeInt16BE(Addr, 0xC418); // lgrl %r1,.+8
958 writeInt16BE(Addr+2, 0x0000);
959 writeInt16BE(Addr+4, 0x0004);
960 writeInt16BE(Addr+6, 0x07F1); // brc 15,%r1
961 // 8-byte address stored at Addr + 8
962 return Addr;
963 } else if (Arch == Triple::x86_64) {
964 *Addr = 0xFF; // jmp
965 *(Addr+1) = 0x25; // rip
966 // 32-bit PC-relative address of the GOT entry will be stored at Addr+2
967 } else if (Arch == Triple::x86) {
968 *Addr = 0xE9; // 32-bit pc-relative jump.
969 }
970 return Addr;
971}
972
973// Assign an address to a symbol name and resolve all the relocations
974// associated with it.
975void RuntimeDyldImpl::reassignSectionAddress(unsigned SectionID,
976 uint64_t Addr) {
977 // The address to use for relocation resolution is not
978 // the address of the local section buffer. We must be doing
979 // a remote execution environment of some sort. Relocations can't
980 // be applied until all the sections have been moved. The client must
981 // trigger this with a call to MCJIT::finalize() or
982 // RuntimeDyld::resolveRelocations().
983 //
984 // Addr is a uint64_t because we can't assume the pointer width
985 // of the target is the same as that of the host. Just use a generic
986 // "big enough" type.
987 LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Reassigning address for section "
<< SectionID << " (" << Sections[SectionID
].getName() << "): " << format("0x%016" "l" "x", Sections
[SectionID].getLoadAddress()) << " -> " << format
("0x%016" "l" "x", Addr) << "\n"; } } while (false)
988 dbgs() << "Reassigning address for section " << SectionID << " ("do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Reassigning address for section "
<< SectionID << " (" << Sections[SectionID
].getName() << "): " << format("0x%016" "l" "x", Sections
[SectionID].getLoadAddress()) << " -> " << format
("0x%016" "l" "x", Addr) << "\n"; } } while (false)
989 << Sections[SectionID].getName() << "): "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Reassigning address for section "
<< SectionID << " (" << Sections[SectionID
].getName() << "): " << format("0x%016" "l" "x", Sections
[SectionID].getLoadAddress()) << " -> " << format
("0x%016" "l" "x", Addr) << "\n"; } } while (false)
990 << format("0x%016" PRIx64, Sections[SectionID].getLoadAddress())do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Reassigning address for section "
<< SectionID << " (" << Sections[SectionID
].getName() << "): " << format("0x%016" "l" "x", Sections
[SectionID].getLoadAddress()) << " -> " << format
("0x%016" "l" "x", Addr) << "\n"; } } while (false)
991 << " -> " << format("0x%016" PRIx64, Addr) << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Reassigning address for section "
<< SectionID << " (" << Sections[SectionID
].getName() << "): " << format("0x%016" "l" "x", Sections
[SectionID].getLoadAddress()) << " -> " << format
("0x%016" "l" "x", Addr) << "\n"; } } while (false)
;
992 Sections[SectionID].setLoadAddress(Addr);
993}
994
995void RuntimeDyldImpl::resolveRelocationList(const RelocationList &Relocs,
996 uint64_t Value) {
997 for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
998 const RelocationEntry &RE = Relocs[i];
999 // Ignore relocations for sections that were not loaded
1000 if (Sections[RE.SectionID].getAddress() == nullptr)
1001 continue;
1002 resolveRelocation(RE, Value);
1003 }
1004}
1005
1006void RuntimeDyldImpl::applyExternalSymbolRelocations(
1007 const StringMap<JITEvaluatedSymbol> ExternalSymbolMap) {
1008 while (!ExternalSymbolRelocations.empty()) {
1009
1010 StringMap<RelocationList>::iterator i = ExternalSymbolRelocations.begin();
1011
1012 StringRef Name = i->first();
1013 if (Name.size() == 0) {
1014 // This is an absolute symbol, use an address of zero.
1015 LLVM_DEBUG(dbgs() << "Resolving absolute relocations."do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Resolving absolute relocations."
<< "\n"; } } while (false)
1016 << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Resolving absolute relocations."
<< "\n"; } } while (false)
;
1017 RelocationList &Relocs = i->second;
1018 resolveRelocationList(Relocs, 0);
1019 } else {
1020 uint64_t Addr = 0;
1021 JITSymbolFlags Flags;
1022 RTDyldSymbolTable::const_iterator Loc = GlobalSymbolTable.find(Name);
1023 if (Loc == GlobalSymbolTable.end()) {
1024 auto RRI = ExternalSymbolMap.find(Name);
1025 assert(RRI != ExternalSymbolMap.end() && "No result for symbol")((RRI != ExternalSymbolMap.end() && "No result for symbol"
) ? static_cast<void> (0) : __assert_fail ("RRI != ExternalSymbolMap.end() && \"No result for symbol\""
, "/build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp"
, 1025, __PRETTY_FUNCTION__))
;
1026 Addr = RRI->second.getAddress();
1027 Flags = RRI->second.getFlags();
1028 // The call to getSymbolAddress may have caused additional modules to
1029 // be loaded, which may have added new entries to the
1030 // ExternalSymbolRelocations map. Consquently, we need to update our
1031 // iterator. This is also why retrieval of the relocation list
1032 // associated with this symbol is deferred until below this point.
1033 // New entries may have been added to the relocation list.
1034 i = ExternalSymbolRelocations.find(Name);
1035 } else {
1036 // We found the symbol in our global table. It was probably in a
1037 // Module that we loaded previously.
1038 const auto &SymInfo = Loc->second;
1039 Addr = getSectionLoadAddress(SymInfo.getSectionID()) +
1040 SymInfo.getOffset();
1041 Flags = SymInfo.getFlags();
1042 }
1043
1044 // FIXME: Implement error handling that doesn't kill the host program!
1045 if (!Addr)
1046 report_fatal_error("Program used external function '" + Name +
1047 "' which could not be resolved!");
1048
1049 // If Resolver returned UINT64_MAX, the client wants to handle this symbol
1050 // manually and we shouldn't resolve its relocations.
1051 if (Addr != UINT64_MAX(18446744073709551615UL)) {
1052
1053 // Tweak the address based on the symbol flags if necessary.
1054 // For example, this is used by RuntimeDyldMachOARM to toggle the low bit
1055 // if the target symbol is Thumb.
1056 Addr = modifyAddressBasedOnFlags(Addr, Flags);
1057
1058 LLVM_DEBUG(dbgs() << "Resolving relocations Name: " << Name << "\t"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Resolving relocations Name: " <<
Name << "\t" << format("0x%lx", Addr) << "\n"
; } } while (false)
1059 << format("0x%lx", Addr) << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("dyld")) { dbgs() << "Resolving relocations Name: " <<
Name << "\t" << format("0x%lx", Addr) << "\n"
; } } while (false)
;
1060 // This list may have been updated when we called getSymbolAddress, so
1061 // don't change this code to get the list earlier.
1062 RelocationList &Relocs = i->second;
1063 resolveRelocationList(Relocs, Addr);
1064 }
1065 }
1066
1067 ExternalSymbolRelocations.erase(i);
1068 }
1069}
1070
1071Error RuntimeDyldImpl::resolveExternalSymbols() {
1072 StringMap<JITEvaluatedSymbol> ExternalSymbolMap;
1073
1074 // Resolution can trigger emission of more symbols, so iterate until
1075 // we've resolved *everything*.
1076 {
1077 JITSymbolResolver::LookupSet ResolvedSymbols;
1078
1079 while (true) {
1080 JITSymbolResolver::LookupSet NewSymbols;
1081
1082 for (auto &RelocKV : ExternalSymbolRelocations) {
1083 StringRef Name = RelocKV.first();
1084 if (!Name.empty() && !GlobalSymbolTable.count(Name) &&
1085 !ResolvedSymbols.count(Name))
1086 NewSymbols.insert(Name);
1087 }
1088
1089 if (NewSymbols.empty())
1090 break;
1091
1092#ifdef _MSC_VER
1093 using ExpectedLookupResult =
1094 MSVCPExpected<JITSymbolResolver::LookupResult>;
1095#else
1096 using ExpectedLookupResult = Expected<JITSymbolResolver::LookupResult>;
1097#endif
1098
1099 auto NewSymbolsP = std::make_shared<std::promise<ExpectedLookupResult>>();
1100 auto NewSymbolsF = NewSymbolsP->get_future();
1101 Resolver.lookup(NewSymbols,
1102 [=](Expected<JITSymbolResolver::LookupResult> Result) {
1103 NewSymbolsP->set_value(std::move(Result));
1104 });
1105
1106 auto NewResolverResults = NewSymbolsF.get();
1107
1108 if (!NewResolverResults)
1109 return NewResolverResults.takeError();
1110
1111 assert(NewResolverResults->size() == NewSymbols.size() &&((NewResolverResults->size() == NewSymbols.size() &&
"Should have errored on unresolved symbols") ? static_cast<
void> (0) : __assert_fail ("NewResolverResults->size() == NewSymbols.size() && \"Should have errored on unresolved symbols\""
, "/build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp"
, 1112, __PRETTY_FUNCTION__))
1112 "Should have errored on unresolved symbols")((NewResolverResults->size() == NewSymbols.size() &&
"Should have errored on unresolved symbols") ? static_cast<
void> (0) : __assert_fail ("NewResolverResults->size() == NewSymbols.size() && \"Should have errored on unresolved symbols\""
, "/build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp"
, 1112, __PRETTY_FUNCTION__))
;
1113
1114 for (auto &RRKV : *NewResolverResults) {
1115 assert(!ResolvedSymbols.count(RRKV.first) && "Redundant resolution?")((!ResolvedSymbols.count(RRKV.first) && "Redundant resolution?"
) ? static_cast<void> (0) : __assert_fail ("!ResolvedSymbols.count(RRKV.first) && \"Redundant resolution?\""
, "/build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp"
, 1115, __PRETTY_FUNCTION__))
;
1116 ExternalSymbolMap.insert(RRKV);
1117 ResolvedSymbols.insert(RRKV.first);
1118 }
1119 }
1120 }
1121
1122 applyExternalSymbolRelocations(ExternalSymbolMap);
1123
1124 return Error::success();
1125}
1126
1127void RuntimeDyldImpl::finalizeAsync(
1128 std::unique_ptr<RuntimeDyldImpl> This, std::function<void(Error)> OnEmitted,
1129 std::unique_ptr<MemoryBuffer> UnderlyingBuffer) {
1130
1131 // FIXME: Move-capture OnRelocsApplied and UnderlyingBuffer once we have
1132 // c++14.
1133 auto SharedUnderlyingBuffer =
1134 std::shared_ptr<MemoryBuffer>(std::move(UnderlyingBuffer));
1135 auto SharedThis = std::shared_ptr<RuntimeDyldImpl>(std::move(This));
1136 auto PostResolveContinuation =
1137 [SharedThis, OnEmitted, SharedUnderlyingBuffer](
1138 Expected<JITSymbolResolver::LookupResult> Result) {
1139 if (!Result) {
1140 OnEmitted(Result.takeError());
1141 return;
1142 }
1143
1144 /// Copy the result into a StringMap, where the keys are held by value.
1145 StringMap<JITEvaluatedSymbol> Resolved;
1146 for (auto &KV : *Result)
1147 Resolved[KV.first] = KV.second;
1148
1149 SharedThis->applyExternalSymbolRelocations(Resolved);
1150 SharedThis->resolveLocalRelocations();
1151 SharedThis->registerEHFrames();
1152 std::string ErrMsg;
1153 if (SharedThis->MemMgr.finalizeMemory(&ErrMsg))
1154 OnEmitted(make_error<StringError>(std::move(ErrMsg),
1155 inconvertibleErrorCode()));
1156 else
1157 OnEmitted(Error::success());
1158 };
1159
1160 JITSymbolResolver::LookupSet Symbols;
1161
1162 for (auto &RelocKV : SharedThis->ExternalSymbolRelocations) {
1163 StringRef Name = RelocKV.first();
1164 assert(!Name.empty() && "Symbol has no name?")((!Name.empty() && "Symbol has no name?") ? static_cast
<void> (0) : __assert_fail ("!Name.empty() && \"Symbol has no name?\""
, "/build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp"
, 1164, __PRETTY_FUNCTION__))
;
1165 assert(!SharedThis->GlobalSymbolTable.count(Name) &&((!SharedThis->GlobalSymbolTable.count(Name) && "Name already processed. RuntimeDyld instances can not be re-used "
"when finalizing with finalizeAsync.") ? static_cast<void
> (0) : __assert_fail ("!SharedThis->GlobalSymbolTable.count(Name) && \"Name already processed. RuntimeDyld instances can not be re-used \" \"when finalizing with finalizeAsync.\""
, "/build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp"
, 1167, __PRETTY_FUNCTION__))
1166 "Name already processed. RuntimeDyld instances can not be re-used "((!SharedThis->GlobalSymbolTable.count(Name) && "Name already processed. RuntimeDyld instances can not be re-used "
"when finalizing with finalizeAsync.") ? static_cast<void
> (0) : __assert_fail ("!SharedThis->GlobalSymbolTable.count(Name) && \"Name already processed. RuntimeDyld instances can not be re-used \" \"when finalizing with finalizeAsync.\""
, "/build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp"
, 1167, __PRETTY_FUNCTION__))
1167 "when finalizing with finalizeAsync.")((!SharedThis->GlobalSymbolTable.count(Name) && "Name already processed. RuntimeDyld instances can not be re-used "
"when finalizing with finalizeAsync.") ? static_cast<void
> (0) : __assert_fail ("!SharedThis->GlobalSymbolTable.count(Name) && \"Name already processed. RuntimeDyld instances can not be re-used \" \"when finalizing with finalizeAsync.\""
, "/build/llvm-toolchain-snapshot-8~svn345461/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp"
, 1167, __PRETTY_FUNCTION__))
;
1168 Symbols.insert(Name);
1169 }
1170
1171 if (!Symbols.empty()) {
1172 SharedThis->Resolver.lookup(Symbols, PostResolveContinuation);
1173 } else
1174 PostResolveContinuation(std::map<StringRef, JITEvaluatedSymbol>());
1175}
1176
1177//===----------------------------------------------------------------------===//
1178// RuntimeDyld class implementation
1179
1180uint64_t RuntimeDyld::LoadedObjectInfo::getSectionLoadAddress(
1181 const object::SectionRef &Sec) const {
1182
1183 auto I = ObjSecToIDMap.find(Sec);
1184 if (I != ObjSecToIDMap.end())
1185 return RTDyld.Sections[I->second].getLoadAddress();
1186
1187 return 0;
1188}
1189
1190void RuntimeDyld::MemoryManager::anchor() {}
1191void JITSymbolResolver::anchor() {}
1192void LegacyJITSymbolResolver::anchor() {}
1193
1194RuntimeDyld::RuntimeDyld(RuntimeDyld::MemoryManager &MemMgr,
1195 JITSymbolResolver &Resolver)
1196 : MemMgr(MemMgr), Resolver(Resolver) {
1197 // FIXME: There's a potential issue lurking here if a single instance of
1198 // RuntimeDyld is used to load multiple objects. The current implementation
1199 // associates a single memory manager with a RuntimeDyld instance. Even
1200 // though the public class spawns a new 'impl' instance for each load,
1201 // they share a single memory manager. This can become a problem when page
1202 // permissions are applied.
1203 Dyld = nullptr;
1204 ProcessAllSections = false;
1205 Checker = nullptr;
1206}
1207
1208RuntimeDyld::~RuntimeDyld() {}
1209
1210static std::unique_ptr<RuntimeDyldCOFF>
1211createRuntimeDyldCOFF(Triple::ArchType Arch, RuntimeDyld::MemoryManager &MM,
1212 JITSymbolResolver &Resolver, bool ProcessAllSections,
1213 RuntimeDyldCheckerImpl *Checker) {
1214 std::unique_ptr<RuntimeDyldCOFF> Dyld =
1215 RuntimeDyldCOFF::create(Arch, MM, Resolver);
1216 Dyld->setProcessAllSections(ProcessAllSections);
1217 Dyld->setRuntimeDyldChecker(Checker);
1218 return Dyld;
1219}
1220
1221static std::unique_ptr<RuntimeDyldELF>
1222createRuntimeDyldELF(Triple::ArchType Arch, RuntimeDyld::MemoryManager &MM,
1223 JITSymbolResolver &Resolver, bool ProcessAllSections,
1224 RuntimeDyldCheckerImpl *Checker) {
1225 std::unique_ptr<RuntimeDyldELF> Dyld =
1226 RuntimeDyldELF::create(Arch, MM, Resolver);
1227 Dyld->setProcessAllSections(ProcessAllSections);
1228 Dyld->setRuntimeDyldChecker(Checker);
1229 return Dyld;
1230}
1231
1232static std::unique_ptr<RuntimeDyldMachO>
1233createRuntimeDyldMachO(Triple::ArchType Arch, RuntimeDyld::MemoryManager &MM,
1234 JITSymbolResolver &Resolver,
1235 bool ProcessAllSections,
1236 RuntimeDyldCheckerImpl *Checker) {
1237 std::unique_ptr<RuntimeDyldMachO> Dyld =
1238 RuntimeDyldMachO::create(Arch, MM, Resolver);
1239 Dyld->setProcessAllSections(ProcessAllSections);
1240 Dyld->setRuntimeDyldChecker(Checker);
1241 return Dyld;
1242}
1243
1244std::unique_ptr<RuntimeDyld::LoadedObjectInfo>
1245RuntimeDyld::loadObject(const ObjectFile &Obj) {
1246 if (!Dyld) {
1247 if (Obj.isELF())
1248 Dyld =
1249 createRuntimeDyldELF(static_cast<Triple::ArchType>(Obj.getArch()),
1250 MemMgr, Resolver, ProcessAllSections, Checker);
1251 else if (Obj.isMachO())
1252 Dyld = createRuntimeDyldMachO(
1253 static_cast<Triple::ArchType>(Obj.getArch()), MemMgr, Resolver,
1254 ProcessAllSections, Checker);
1255 else if (Obj.isCOFF())
1256 Dyld = createRuntimeDyldCOFF(
1257 static_cast<Triple::ArchType>(Obj.getArch()), MemMgr, Resolver,
1258 ProcessAllSections, Checker);
1259 else
1260 report_fatal_error("Incompatible object format!");
1261 }
1262
1263 if (!Dyld->isCompatibleFile(Obj))
1264 report_fatal_error("Incompatible object format!");
1265
1266 auto LoadedObjInfo = Dyld->loadObject(Obj);
1267 MemMgr.notifyObjectLoaded(*this, Obj);
1268 return LoadedObjInfo;
1269}
1270
1271void *RuntimeDyld::getSymbolLocalAddress(StringRef Name) const {
1272 if (!Dyld)
1273 return nullptr;
1274 return Dyld->getSymbolLocalAddress(Name);
1275}
1276
1277JITEvaluatedSymbol RuntimeDyld::getSymbol(StringRef Name) const {
1278 if (!Dyld)
1279 return nullptr;
1280 return Dyld->getSymbol(Name);
1281}
1282
1283std::map<StringRef, JITEvaluatedSymbol> RuntimeDyld::getSymbolTable() const {
1284 if (!Dyld)
1285 return std::map<StringRef, JITEvaluatedSymbol>();
1286 return Dyld->getSymbolTable();
1287}
1288
1289void RuntimeDyld::resolveRelocations() { Dyld->resolveRelocations(); }
1290
1291void RuntimeDyld::reassignSectionAddress(unsigned SectionID, uint64_t Addr) {
1292 Dyld->reassignSectionAddress(SectionID, Addr);
1293}
1294
1295void RuntimeDyld::mapSectionAddress(const void *LocalAddress,
1296 uint64_t TargetAddress) {
1297 Dyld->mapSectionAddress(LocalAddress, TargetAddress);
1298}
1299
1300bool RuntimeDyld::hasError() { return Dyld->hasError(); }
1301
1302StringRef RuntimeDyld::getErrorString() { return Dyld->getErrorString(); }
1303
1304void RuntimeDyld::finalizeWithMemoryManagerLocking() {
1305 bool MemoryFinalizationLocked = MemMgr.FinalizationLocked;
1306 MemMgr.FinalizationLocked = true;
1307 resolveRelocations();
1308 registerEHFrames();
1309 if (!MemoryFinalizationLocked) {
1310 MemMgr.finalizeMemory();
1311 MemMgr.FinalizationLocked = false;
1312 }
1313}
1314
1315void RuntimeDyld::registerEHFrames() {
1316 if (Dyld)
1317 Dyld->registerEHFrames();
1318}
1319
1320void RuntimeDyld::deregisterEHFrames() {
1321 if (Dyld)
1322 Dyld->deregisterEHFrames();
1323}
1324// FIXME: Kill this with fire once we have a new JIT linker: this is only here
1325// so that we can re-use RuntimeDyld's implementation without twisting the
1326// interface any further for ORC's purposes.
1327void jitLinkForORC(object::ObjectFile &Obj,
1328 std::unique_ptr<MemoryBuffer> UnderlyingBuffer,
1329 RuntimeDyld::MemoryManager &MemMgr,
1330 JITSymbolResolver &Resolver, bool ProcessAllSections,
1331 std::function<Error(
1332 std::unique_ptr<RuntimeDyld::LoadedObjectInfo> LoadedObj,
1333 std::map<StringRef, JITEvaluatedSymbol>)>
1334 OnLoaded,
1335 std::function<void(Error)> OnEmitted) {
1336
1337 RuntimeDyld RTDyld(MemMgr, Resolver);
1338 RTDyld.setProcessAllSections(ProcessAllSections);
1339
1340 auto Info = RTDyld.loadObject(Obj);
1341
1342 if (RTDyld.hasError()) {
1
Assuming the condition is true
2
Taking true branch
1343 OnEmitted(make_error<StringError>(RTDyld.getErrorString(),
3
Calling 'make_error<llvm::StringError, llvm::StringRef, std::error_code>'
1344 inconvertibleErrorCode()));
1345 return;
1346 }
1347
1348 if (auto Err = OnLoaded(std::move(Info), RTDyld.getSymbolTable()))
1349 OnEmitted(std::move(Err));
1350
1351 RuntimeDyldImpl::finalizeAsync(std::move(RTDyld.Dyld), std::move(OnEmitted),
1352 std::move(UnderlyingBuffer));
1353}
1354
1355} // end namespace llvm

/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h

1//===- llvm/Support/Error.h - Recoverable error handling --------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file defines an API used to report recoverable errors.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_SUPPORT_ERROR_H
15#define LLVM_SUPPORT_ERROR_H
16
17#include "llvm-c/Error.h"
18#include "llvm/ADT/STLExtras.h"
19#include "llvm/ADT/SmallVector.h"
20#include "llvm/ADT/StringExtras.h"
21#include "llvm/ADT/Twine.h"
22#include "llvm/Config/abi-breaking.h"
23#include "llvm/Support/AlignOf.h"
24#include "llvm/Support/Compiler.h"
25#include "llvm/Support/Debug.h"
26#include "llvm/Support/ErrorHandling.h"
27#include "llvm/Support/ErrorOr.h"
28#include "llvm/Support/Format.h"
29#include "llvm/Support/raw_ostream.h"
30#include <algorithm>
31#include <cassert>
32#include <cstdint>
33#include <cstdlib>
34#include <functional>
35#include <memory>
36#include <new>
37#include <string>
38#include <system_error>
39#include <type_traits>
40#include <utility>
41#include <vector>
42
43namespace llvm {
44
45class ErrorSuccess;
46
47/// Base class for error info classes. Do not extend this directly: Extend
48/// the ErrorInfo template subclass instead.
49class ErrorInfoBase {
50public:
51 virtual ~ErrorInfoBase() = default;
52
53 /// Print an error message to an output stream.
54 virtual void log(raw_ostream &OS) const = 0;
55
56 /// Return the error message as a string.
57 virtual std::string message() const {
58 std::string Msg;
59 raw_string_ostream OS(Msg);
60 log(OS);
61 return OS.str();
62 }
63
64 /// Convert this error to a std::error_code.
65 ///
66 /// This is a temporary crutch to enable interaction with code still
67 /// using std::error_code. It will be removed in the future.
68 virtual std::error_code convertToErrorCode() const = 0;
69
70 // Returns the class ID for this type.
71 static const void *classID() { return &ID; }
72
73 // Returns the class ID for the dynamic type of this ErrorInfoBase instance.
74 virtual const void *dynamicClassID() const = 0;
75
76 // Check whether this instance is a subclass of the class identified by
77 // ClassID.
78 virtual bool isA(const void *const ClassID) const {
79 return ClassID == classID();
80 }
81
82 // Check whether this instance is a subclass of ErrorInfoT.
83 template <typename ErrorInfoT> bool isA() const {
84 return isA(ErrorInfoT::classID());
85 }
86
87private:
88 virtual void anchor();
89
90 static char ID;
91};
92
93/// Lightweight error class with error context and mandatory checking.
94///
95/// Instances of this class wrap a ErrorInfoBase pointer. Failure states
96/// are represented by setting the pointer to a ErrorInfoBase subclass
97/// instance containing information describing the failure. Success is
98/// represented by a null pointer value.
99///
100/// Instances of Error also contains a 'Checked' flag, which must be set
101/// before the destructor is called, otherwise the destructor will trigger a
102/// runtime error. This enforces at runtime the requirement that all Error
103/// instances be checked or returned to the caller.
104///
105/// There are two ways to set the checked flag, depending on what state the
106/// Error instance is in. For Error instances indicating success, it
107/// is sufficient to invoke the boolean conversion operator. E.g.:
108///
109/// @code{.cpp}
110/// Error foo(<...>);
111///
112/// if (auto E = foo(<...>))
113/// return E; // <- Return E if it is in the error state.
114/// // We have verified that E was in the success state. It can now be safely
115/// // destroyed.
116/// @endcode
117///
118/// A success value *can not* be dropped. For example, just calling 'foo(<...>)'
119/// without testing the return value will raise a runtime error, even if foo
120/// returns success.
121///
122/// For Error instances representing failure, you must use either the
123/// handleErrors or handleAllErrors function with a typed handler. E.g.:
124///
125/// @code{.cpp}
126/// class MyErrorInfo : public ErrorInfo<MyErrorInfo> {
127/// // Custom error info.
128/// };
129///
130/// Error foo(<...>) { return make_error<MyErrorInfo>(...); }
131///
132/// auto E = foo(<...>); // <- foo returns failure with MyErrorInfo.
133/// auto NewE =
134/// handleErrors(E,
135/// [](const MyErrorInfo &M) {
136/// // Deal with the error.
137/// },
138/// [](std::unique_ptr<OtherError> M) -> Error {
139/// if (canHandle(*M)) {
140/// // handle error.
141/// return Error::success();
142/// }
143/// // Couldn't handle this error instance. Pass it up the stack.
144/// return Error(std::move(M));
145/// );
146/// // Note - we must check or return NewE in case any of the handlers
147/// // returned a new error.
148/// @endcode
149///
150/// The handleAllErrors function is identical to handleErrors, except
151/// that it has a void return type, and requires all errors to be handled and
152/// no new errors be returned. It prevents errors (assuming they can all be
153/// handled) from having to be bubbled all the way to the top-level.
154///
155/// *All* Error instances must be checked before destruction, even if
156/// they're moved-assigned or constructed from Success values that have already
157/// been checked. This enforces checking through all levels of the call stack.
158class LLVM_NODISCARD[[clang::warn_unused_result]] Error {
159 // Both ErrorList and FileError need to be able to yank ErrorInfoBase
160 // pointers out of this class to add to the error list.
161 friend class ErrorList;
162 friend class FileError;
163
164 // handleErrors needs to be able to set the Checked flag.
165 template <typename... HandlerTs>
166 friend Error handleErrors(Error E, HandlerTs &&... Handlers);
167
168 // Expected<T> needs to be able to steal the payload when constructed from an
169 // error.
170 template <typename T> friend class Expected;
171
172 // wrap needs to be able to steal the payload.
173 friend LLVMErrorRef wrap(Error);
174
175protected:
176 /// Create a success value. Prefer using 'Error::success()' for readability
177 Error() {
178 setPtr(nullptr);
179 setChecked(false);
180 }
181
182public:
183 /// Create a success value.
184 static ErrorSuccess success();
185
186 // Errors are not copy-constructable.
187 Error(const Error &Other) = delete;
188
189 /// Move-construct an error value. The newly constructed error is considered
190 /// unchecked, even if the source error had been checked. The original error
191 /// becomes a checked Success value, regardless of its original state.
192 Error(Error &&Other) {
193 setChecked(true);
194 *this = std::move(Other);
195 }
196
197 /// Create an error value. Prefer using the 'make_error' function, but
198 /// this constructor can be useful when "re-throwing" errors from handlers.
199 Error(std::unique_ptr<ErrorInfoBase> Payload) {
200 setPtr(Payload.release());
201 setChecked(false);
8
Potential leak of memory pointed to by 'Payload._M_t._M_head_impl'
202 }
203
204 // Errors are not copy-assignable.
205 Error &operator=(const Error &Other) = delete;
206
207 /// Move-assign an error value. The current error must represent success, you
208 /// you cannot overwrite an unhandled error. The current error is then
209 /// considered unchecked. The source error becomes a checked success value,
210 /// regardless of its original state.
211 Error &operator=(Error &&Other) {
212 // Don't allow overwriting of unchecked values.
213 assertIsChecked();
214 setPtr(Other.getPtr());
215
216 // This Error is unchecked, even if the source error was checked.
217 setChecked(false);
218
219 // Null out Other's payload and set its checked bit.
220 Other.setPtr(nullptr);
221 Other.setChecked(true);
222
223 return *this;
224 }
225
226 /// Destroy a Error. Fails with a call to abort() if the error is
227 /// unchecked.
228 ~Error() {
229 assertIsChecked();
230 delete getPtr();
231 }
232
233 /// Bool conversion. Returns true if this Error is in a failure state,
234 /// and false if it is in an accept state. If the error is in a Success state
235 /// it will be considered checked.
236 explicit operator bool() {
237 setChecked(getPtr() == nullptr);
238 return getPtr() != nullptr;
239 }
240
241 /// Check whether one error is a subclass of another.
242 template <typename ErrT> bool isA() const {
243 return getPtr() && getPtr()->isA(ErrT::classID());
244 }
245
246 /// Returns the dynamic class id of this error, or null if this is a success
247 /// value.
248 const void* dynamicClassID() const {
249 if (!getPtr())
250 return nullptr;
251 return getPtr()->dynamicClassID();
252 }
253
254private:
255#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
256 // assertIsChecked() happens very frequently, but under normal circumstances
257 // is supposed to be a no-op. So we want it to be inlined, but having a bunch
258 // of debug prints can cause the function to be too large for inlining. So
259 // it's important that we define this function out of line so that it can't be
260 // inlined.
261 LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn))
262 void fatalUncheckedError() const;
263#endif
264
265 void assertIsChecked() {
266#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
267 if (LLVM_UNLIKELY(!getChecked() || getPtr())__builtin_expect((bool)(!getChecked() || getPtr()), false))
268 fatalUncheckedError();
269#endif
270 }
271
272 ErrorInfoBase *getPtr() const {
273 return reinterpret_cast<ErrorInfoBase*>(
274 reinterpret_cast<uintptr_t>(Payload) &
275 ~static_cast<uintptr_t>(0x1));
276 }
277
278 void setPtr(ErrorInfoBase *EI) {
279#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
280 Payload = reinterpret_cast<ErrorInfoBase*>(
281 (reinterpret_cast<uintptr_t>(EI) &
282 ~static_cast<uintptr_t>(0x1)) |
283 (reinterpret_cast<uintptr_t>(Payload) & 0x1));
284#else
285 Payload = EI;
286#endif
287 }
288
289 bool getChecked() const {
290#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
291 return (reinterpret_cast<uintptr_t>(Payload) & 0x1) == 0;
292#else
293 return true;
294#endif
295 }
296
297 void setChecked(bool V) {
298 Payload = reinterpret_cast<ErrorInfoBase*>(
299 (reinterpret_cast<uintptr_t>(Payload) &
300 ~static_cast<uintptr_t>(0x1)) |
301 (V ? 0 : 1));
302 }
303
304 std::unique_ptr<ErrorInfoBase> takePayload() {
305 std::unique_ptr<ErrorInfoBase> Tmp(getPtr());
306 setPtr(nullptr);
307 setChecked(true);
308 return Tmp;
309 }
310
311 friend raw_ostream &operator<<(raw_ostream &OS, const Error &E) {
312 if (auto P = E.getPtr())
313 P->log(OS);
314 else
315 OS << "success";
316 return OS;
317 }
318
319 ErrorInfoBase *Payload = nullptr;
320};
321
322/// Subclass of Error for the sole purpose of identifying the success path in
323/// the type system. This allows to catch invalid conversion to Expected<T> at
324/// compile time.
325class ErrorSuccess final : public Error {};
326
327inline ErrorSuccess Error::success() { return ErrorSuccess(); }
328
329/// Make a Error instance representing failure using the given error info
330/// type.
331template <typename ErrT, typename... ArgTs> Error make_error(ArgTs &&... Args) {
332 return Error(llvm::make_unique<ErrT>(std::forward<ArgTs>(Args)...));
4
Calling 'make_unique<llvm::StringError, llvm::StringRef, std::error_code>'
6
Returned allocated memory
7
Calling constructor for 'Error'
333}
334
335/// Base class for user error types. Users should declare their error types
336/// like:
337///
338/// class MyError : public ErrorInfo<MyError> {
339/// ....
340/// };
341///
342/// This class provides an implementation of the ErrorInfoBase::kind
343/// method, which is used by the Error RTTI system.
344template <typename ThisErrT, typename ParentErrT = ErrorInfoBase>
345class ErrorInfo : public ParentErrT {
346public:
347 using ParentErrT::ParentErrT; // inherit constructors
348
349 static const void *classID() { return &ThisErrT::ID; }
350
351 const void *dynamicClassID() const override { return &ThisErrT::ID; }
352
353 bool isA(const void *const ClassID) const override {
354 return ClassID == classID() || ParentErrT::isA(ClassID);
355 }
356};
357
358/// Special ErrorInfo subclass representing a list of ErrorInfos.
359/// Instances of this class are constructed by joinError.
360class ErrorList final : public ErrorInfo<ErrorList> {
361 // handleErrors needs to be able to iterate the payload list of an
362 // ErrorList.
363 template <typename... HandlerTs>
364 friend Error handleErrors(Error E, HandlerTs &&... Handlers);
365
366 // joinErrors is implemented in terms of join.
367 friend Error joinErrors(Error, Error);
368
369public:
370 void log(raw_ostream &OS) const override {
371 OS << "Multiple errors:\n";
372 for (auto &ErrPayload : Payloads) {
373 ErrPayload->log(OS);
374 OS << "\n";
375 }
376 }
377
378 std::error_code convertToErrorCode() const override;
379
380 // Used by ErrorInfo::classID.
381 static char ID;
382
383private:
384 ErrorList(std::unique_ptr<ErrorInfoBase> Payload1,
385 std::unique_ptr<ErrorInfoBase> Payload2) {
386 assert(!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() &&((!Payload1->isA<ErrorList>() && !Payload2->
isA<ErrorList>() && "ErrorList constructor payloads should be singleton errors"
) ? static_cast<void> (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 387, __PRETTY_FUNCTION__))
387 "ErrorList constructor payloads should be singleton errors")((!Payload1->isA<ErrorList>() && !Payload2->
isA<ErrorList>() && "ErrorList constructor payloads should be singleton errors"
) ? static_cast<void> (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 387, __PRETTY_FUNCTION__))
;
388 Payloads.push_back(std::move(Payload1));
389 Payloads.push_back(std::move(Payload2));
390 }
391
392 static Error join(Error E1, Error E2) {
393 if (!E1)
394 return E2;
395 if (!E2)
396 return E1;
397 if (E1.isA<ErrorList>()) {
398 auto &E1List = static_cast<ErrorList &>(*E1.getPtr());
399 if (E2.isA<ErrorList>()) {
400 auto E2Payload = E2.takePayload();
401 auto &E2List = static_cast<ErrorList &>(*E2Payload);
402 for (auto &Payload : E2List.Payloads)
403 E1List.Payloads.push_back(std::move(Payload));
404 } else
405 E1List.Payloads.push_back(E2.takePayload());
406
407 return E1;
408 }
409 if (E2.isA<ErrorList>()) {
410 auto &E2List = static_cast<ErrorList &>(*E2.getPtr());
411 E2List.Payloads.insert(E2List.Payloads.begin(), E1.takePayload());
412 return E2;
413 }
414 return Error(std::unique_ptr<ErrorList>(
415 new ErrorList(E1.takePayload(), E2.takePayload())));
416 }
417
418 std::vector<std::unique_ptr<ErrorInfoBase>> Payloads;
419};
420
421/// Concatenate errors. The resulting Error is unchecked, and contains the
422/// ErrorInfo(s), if any, contained in E1, followed by the
423/// ErrorInfo(s), if any, contained in E2.
424inline Error joinErrors(Error E1, Error E2) {
425 return ErrorList::join(std::move(E1), std::move(E2));
426}
427
428/// Tagged union holding either a T or a Error.
429///
430/// This class parallels ErrorOr, but replaces error_code with Error. Since
431/// Error cannot be copied, this class replaces getError() with
432/// takeError(). It also adds an bool errorIsA<ErrT>() method for testing the
433/// error class type.
434template <class T> class LLVM_NODISCARD[[clang::warn_unused_result]] Expected {
435 template <class T1> friend class ExpectedAsOutParameter;
436 template <class OtherT> friend class Expected;
437
438 static const bool isRef = std::is_reference<T>::value;
439
440 using wrap = std::reference_wrapper<typename std::remove_reference<T>::type>;
441
442 using error_type = std::unique_ptr<ErrorInfoBase>;
443
444public:
445 using storage_type = typename std::conditional<isRef, wrap, T>::type;
446 using value_type = T;
447
448private:
449 using reference = typename std::remove_reference<T>::type &;
450 using const_reference = const typename std::remove_reference<T>::type &;
451 using pointer = typename std::remove_reference<T>::type *;
452 using const_pointer = const typename std::remove_reference<T>::type *;
453
454public:
455 /// Create an Expected<T> error value from the given Error.
456 Expected(Error Err)
457 : HasError(true)
458#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
459 // Expected is unchecked upon construction in Debug builds.
460 , Unchecked(true)
461#endif
462 {
463 assert(Err && "Cannot create Expected<T> from Error success value.")((Err && "Cannot create Expected<T> from Error success value."
) ? static_cast<void> (0) : __assert_fail ("Err && \"Cannot create Expected<T> from Error success value.\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 463, __PRETTY_FUNCTION__))
;
464 new (getErrorStorage()) error_type(Err.takePayload());
465 }
466
467 /// Forbid to convert from Error::success() implicitly, this avoids having
468 /// Expected<T> foo() { return Error::success(); } which compiles otherwise
469 /// but triggers the assertion above.
470 Expected(ErrorSuccess) = delete;
471
472 /// Create an Expected<T> success value from the given OtherT value, which
473 /// must be convertible to T.
474 template <typename OtherT>
475 Expected(OtherT &&Val,
476 typename std::enable_if<std::is_convertible<OtherT, T>::value>::type
477 * = nullptr)
478 : HasError(false)
479#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
480 // Expected is unchecked upon construction in Debug builds.
481 , Unchecked(true)
482#endif
483 {
484 new (getStorage()) storage_type(std::forward<OtherT>(Val));
485 }
486
487 /// Move construct an Expected<T> value.
488 Expected(Expected &&Other) { moveConstruct(std::move(Other)); }
489
490 /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT
491 /// must be convertible to T.
492 template <class OtherT>
493 Expected(Expected<OtherT> &&Other,
494 typename std::enable_if<std::is_convertible<OtherT, T>::value>::type
495 * = nullptr) {
496 moveConstruct(std::move(Other));
497 }
498
499 /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT
500 /// isn't convertible to T.
501 template <class OtherT>
502 explicit Expected(
503 Expected<OtherT> &&Other,
504 typename std::enable_if<!std::is_convertible<OtherT, T>::value>::type * =
505 nullptr) {
506 moveConstruct(std::move(Other));
507 }
508
509 /// Move-assign from another Expected<T>.
510 Expected &operator=(Expected &&Other) {
511 moveAssign(std::move(Other));
512 return *this;
513 }
514
515 /// Destroy an Expected<T>.
516 ~Expected() {
517 assertIsChecked();
518 if (!HasError)
519 getStorage()->~storage_type();
520 else
521 getErrorStorage()->~error_type();
522 }
523
524 /// Return false if there is an error.
525 explicit operator bool() {
526#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
527 Unchecked = HasError;
528#endif
529 return !HasError;
530 }
531
532 /// Returns a reference to the stored T value.
533 reference get() {
534 assertIsChecked();
535 return *getStorage();
536 }
537
538 /// Returns a const reference to the stored T value.
539 const_reference get() const {
540 assertIsChecked();
541 return const_cast<Expected<T> *>(this)->get();
542 }
543
544 /// Check that this Expected<T> is an error of type ErrT.
545 template <typename ErrT> bool errorIsA() const {
546 return HasError && (*getErrorStorage())->template isA<ErrT>();
547 }
548
549 /// Take ownership of the stored error.
550 /// After calling this the Expected<T> is in an indeterminate state that can
551 /// only be safely destructed. No further calls (beside the destructor) should
552 /// be made on the Expected<T> vaule.
553 Error takeError() {
554#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
555 Unchecked = false;
556#endif
557 return HasError ? Error(std::move(*getErrorStorage())) : Error::success();
558 }
559
560 /// Returns a pointer to the stored T value.
561 pointer operator->() {
562 assertIsChecked();
563 return toPointer(getStorage());
564 }
565
566 /// Returns a const pointer to the stored T value.
567 const_pointer operator->() const {
568 assertIsChecked();
569 return toPointer(getStorage());
570 }
571
572 /// Returns a reference to the stored T value.
573 reference operator*() {
574 assertIsChecked();
575 return *getStorage();
576 }
577
578 /// Returns a const reference to the stored T value.
579 const_reference operator*() const {
580 assertIsChecked();
581 return *getStorage();
582 }
583
584private:
585 template <class T1>
586 static bool compareThisIfSameType(const T1 &a, const T1 &b) {
587 return &a == &b;
588 }
589
590 template <class T1, class T2>
591 static bool compareThisIfSameType(const T1 &a, const T2 &b) {
592 return false;
593 }
594
595 template <class OtherT> void moveConstruct(Expected<OtherT> &&Other) {
596 HasError = Other.HasError;
597#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
598 Unchecked = true;
599 Other.Unchecked = false;
600#endif
601
602 if (!HasError)
603 new (getStorage()) storage_type(std::move(*Other.getStorage()));
604 else
605 new (getErrorStorage()) error_type(std::move(*Other.getErrorStorage()));
606 }
607
608 template <class OtherT> void moveAssign(Expected<OtherT> &&Other) {
609 assertIsChecked();
610
611 if (compareThisIfSameType(*this, Other))
612 return;
613
614 this->~Expected();
615 new (this) Expected(std::move(Other));
616 }
617
618 pointer toPointer(pointer Val) { return Val; }
619
620 const_pointer toPointer(const_pointer Val) const { return Val; }
621
622 pointer toPointer(wrap *Val) { return &Val->get(); }
623
624 const_pointer toPointer(const wrap *Val) const { return &Val->get(); }
625
626 storage_type *getStorage() {
627 assert(!HasError && "Cannot get value when an error exists!")((!HasError && "Cannot get value when an error exists!"
) ? static_cast<void> (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 627, __PRETTY_FUNCTION__))
;
628 return reinterpret_cast<storage_type *>(TStorage.buffer);
629 }
630
631 const storage_type *getStorage() const {
632 assert(!HasError && "Cannot get value when an error exists!")((!HasError && "Cannot get value when an error exists!"
) ? static_cast<void> (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 632, __PRETTY_FUNCTION__))
;
633 return reinterpret_cast<const storage_type *>(TStorage.buffer);
634 }
635
636 error_type *getErrorStorage() {
637 assert(HasError && "Cannot get error when a value exists!")((HasError && "Cannot get error when a value exists!"
) ? static_cast<void> (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 637, __PRETTY_FUNCTION__))
;
638 return reinterpret_cast<error_type *>(ErrorStorage.buffer);
639 }
640
641 const error_type *getErrorStorage() const {
642 assert(HasError && "Cannot get error when a value exists!")((HasError && "Cannot get error when a value exists!"
) ? static_cast<void> (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 642, __PRETTY_FUNCTION__))
;
643 return reinterpret_cast<const error_type *>(ErrorStorage.buffer);
644 }
645
646 // Used by ExpectedAsOutParameter to reset the checked flag.
647 void setUnchecked() {
648#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
649 Unchecked = true;
650#endif
651 }
652
653#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
654 LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn))
655 LLVM_ATTRIBUTE_NOINLINE__attribute__((noinline))
656 void fatalUncheckedExpected() const {
657 dbgs() << "Expected<T> must be checked before access or destruction.\n";
658 if (HasError) {
659 dbgs() << "Unchecked Expected<T> contained error:\n";
660 (*getErrorStorage())->log(dbgs());
661 } else
662 dbgs() << "Expected<T> value was in success state. (Note: Expected<T> "
663 "values in success mode must still be checked prior to being "
664 "destroyed).\n";
665 abort();
666 }
667#endif
668
669 void assertIsChecked() {
670#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
671 if (LLVM_UNLIKELY(Unchecked)__builtin_expect((bool)(Unchecked), false))
672 fatalUncheckedExpected();
673#endif
674 }
675
676 union {
677 AlignedCharArrayUnion<storage_type> TStorage;
678 AlignedCharArrayUnion<error_type> ErrorStorage;
679 };
680 bool HasError : 1;
681#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
682 bool Unchecked : 1;
683#endif
684};
685
686/// Report a serious error, calling any installed error handler. See
687/// ErrorHandling.h.
688LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void report_fatal_error(Error Err,
689 bool gen_crash_diag = true);
690
691/// Report a fatal error if Err is a failure value.
692///
693/// This function can be used to wrap calls to fallible functions ONLY when it
694/// is known that the Error will always be a success value. E.g.
695///
696/// @code{.cpp}
697/// // foo only attempts the fallible operation if DoFallibleOperation is
698/// // true. If DoFallibleOperation is false then foo always returns
699/// // Error::success().
700/// Error foo(bool DoFallibleOperation);
701///
702/// cantFail(foo(false));
703/// @endcode
704inline void cantFail(Error Err, const char *Msg = nullptr) {
705 if (Err) {
706 if (!Msg)
707 Msg = "Failure value returned from cantFail wrapped call";
708 llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 708)
;
709 }
710}
711
712/// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and
713/// returns the contained value.
714///
715/// This function can be used to wrap calls to fallible functions ONLY when it
716/// is known that the Error will always be a success value. E.g.
717///
718/// @code{.cpp}
719/// // foo only attempts the fallible operation if DoFallibleOperation is
720/// // true. If DoFallibleOperation is false then foo always returns an int.
721/// Expected<int> foo(bool DoFallibleOperation);
722///
723/// int X = cantFail(foo(false));
724/// @endcode
725template <typename T>
726T cantFail(Expected<T> ValOrErr, const char *Msg = nullptr) {
727 if (ValOrErr)
728 return std::move(*ValOrErr);
729 else {
730 if (!Msg)
731 Msg = "Failure value returned from cantFail wrapped call";
732 llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 732)
;
733 }
734}
735
736/// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and
737/// returns the contained reference.
738///
739/// This function can be used to wrap calls to fallible functions ONLY when it
740/// is known that the Error will always be a success value. E.g.
741///
742/// @code{.cpp}
743/// // foo only attempts the fallible operation if DoFallibleOperation is
744/// // true. If DoFallibleOperation is false then foo always returns a Bar&.
745/// Expected<Bar&> foo(bool DoFallibleOperation);
746///
747/// Bar &X = cantFail(foo(false));
748/// @endcode
749template <typename T>
750T& cantFail(Expected<T&> ValOrErr, const char *Msg = nullptr) {
751 if (ValOrErr)
752 return *ValOrErr;
753 else {
754 if (!Msg)
755 Msg = "Failure value returned from cantFail wrapped call";
756 llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 756)
;
757 }
758}
759
760/// Helper for testing applicability of, and applying, handlers for
761/// ErrorInfo types.
762template <typename HandlerT>
763class ErrorHandlerTraits
764 : public ErrorHandlerTraits<decltype(
765 &std::remove_reference<HandlerT>::type::operator())> {};
766
767// Specialization functions of the form 'Error (const ErrT&)'.
768template <typename ErrT> class ErrorHandlerTraits<Error (&)(ErrT &)> {
769public:
770 static bool appliesTo(const ErrorInfoBase &E) {
771 return E.template isA<ErrT>();
772 }
773
774 template <typename HandlerT>
775 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
776 assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 776, __PRETTY_FUNCTION__))
;
777 return H(static_cast<ErrT &>(*E));
778 }
779};
780
781// Specialization functions of the form 'void (const ErrT&)'.
782template <typename ErrT> class ErrorHandlerTraits<void (&)(ErrT &)> {
783public:
784 static bool appliesTo(const ErrorInfoBase &E) {
785 return E.template isA<ErrT>();
786 }
787
788 template <typename HandlerT>
789 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
790 assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 790, __PRETTY_FUNCTION__))
;
791 H(static_cast<ErrT &>(*E));
792 return Error::success();
793 }
794};
795
796/// Specialization for functions of the form 'Error (std::unique_ptr<ErrT>)'.
797template <typename ErrT>
798class ErrorHandlerTraits<Error (&)(std::unique_ptr<ErrT>)> {
799public:
800 static bool appliesTo(const ErrorInfoBase &E) {
801 return E.template isA<ErrT>();
802 }
803
804 template <typename HandlerT>
805 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
806 assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 806, __PRETTY_FUNCTION__))
;
807 std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release()));
808 return H(std::move(SubE));
809 }
810};
811
812/// Specialization for functions of the form 'void (std::unique_ptr<ErrT>)'.
813template <typename ErrT>
814class ErrorHandlerTraits<void (&)(std::unique_ptr<ErrT>)> {
815public:
816 static bool appliesTo(const ErrorInfoBase &E) {
817 return E.template isA<ErrT>();
818 }
819
820 template <typename HandlerT>
821 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
822 assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast
<void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 822, __PRETTY_FUNCTION__))
;
823 std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release()));
824 H(std::move(SubE));
825 return Error::success();
826 }
827};
828
829// Specialization for member functions of the form 'RetT (const ErrT&)'.
830template <typename C, typename RetT, typename ErrT>
831class ErrorHandlerTraits<RetT (C::*)(ErrT &)>
832 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
833
834// Specialization for member functions of the form 'RetT (const ErrT&) const'.
835template <typename C, typename RetT, typename ErrT>
836class ErrorHandlerTraits<RetT (C::*)(ErrT &) const>
837 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
838
839// Specialization for member functions of the form 'RetT (const ErrT&)'.
840template <typename C, typename RetT, typename ErrT>
841class ErrorHandlerTraits<RetT (C::*)(const ErrT &)>
842 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
843
844// Specialization for member functions of the form 'RetT (const ErrT&) const'.
845template <typename C, typename RetT, typename ErrT>
846class ErrorHandlerTraits<RetT (C::*)(const ErrT &) const>
847 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
848
849/// Specialization for member functions of the form
850/// 'RetT (std::unique_ptr<ErrT>)'.
851template <typename C, typename RetT, typename ErrT>
852class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>)>
853 : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {};
854
855/// Specialization for member functions of the form
856/// 'RetT (std::unique_ptr<ErrT>) const'.
857template <typename C, typename RetT, typename ErrT>
858class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>) const>
859 : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {};
860
861inline Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload) {
862 return Error(std::move(Payload));
863}
864
865template <typename HandlerT, typename... HandlerTs>
866Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload,
867 HandlerT &&Handler, HandlerTs &&... Handlers) {
868 if (ErrorHandlerTraits<HandlerT>::appliesTo(*Payload))
869 return ErrorHandlerTraits<HandlerT>::apply(std::forward<HandlerT>(Handler),
870 std::move(Payload));
871 return handleErrorImpl(std::move(Payload),
872 std::forward<HandlerTs>(Handlers)...);
873}
874
875/// Pass the ErrorInfo(s) contained in E to their respective handlers. Any
876/// unhandled errors (or Errors returned by handlers) are re-concatenated and
877/// returned.
878/// Because this function returns an error, its result must also be checked
879/// or returned. If you intend to handle all errors use handleAllErrors
880/// (which returns void, and will abort() on unhandled errors) instead.
881template <typename... HandlerTs>
882Error handleErrors(Error E, HandlerTs &&... Hs) {
883 if (!E)
884 return Error::success();
885
886 std::unique_ptr<ErrorInfoBase> Payload = E.takePayload();
887
888 if (Payload->isA<ErrorList>()) {
889 ErrorList &List = static_cast<ErrorList &>(*Payload);
890 Error R;
891 for (auto &P : List.Payloads)
892 R = ErrorList::join(
893 std::move(R),
894 handleErrorImpl(std::move(P), std::forward<HandlerTs>(Hs)...));
895 return R;
896 }
897
898 return handleErrorImpl(std::move(Payload), std::forward<HandlerTs>(Hs)...);
899}
900
901/// Behaves the same as handleErrors, except that by contract all errors
902/// *must* be handled by the given handlers (i.e. there must be no remaining
903/// errors after running the handlers, or llvm_unreachable is called).
904template <typename... HandlerTs>
905void handleAllErrors(Error E, HandlerTs &&... Handlers) {
906 cantFail(handleErrors(std::move(E), std::forward<HandlerTs>(Handlers)...));
907}
908
909/// Check that E is a non-error, then drop it.
910/// If E is an error, llvm_unreachable will be called.
911inline void handleAllErrors(Error E) {
912 cantFail(std::move(E));
913}
914
915/// Handle any errors (if present) in an Expected<T>, then try a recovery path.
916///
917/// If the incoming value is a success value it is returned unmodified. If it
918/// is a failure value then it the contained error is passed to handleErrors.
919/// If handleErrors is able to handle the error then the RecoveryPath functor
920/// is called to supply the final result. If handleErrors is not able to
921/// handle all errors then the unhandled errors are returned.
922///
923/// This utility enables the follow pattern:
924///
925/// @code{.cpp}
926/// enum FooStrategy { Aggressive, Conservative };
927/// Expected<Foo> foo(FooStrategy S);
928///
929/// auto ResultOrErr =
930/// handleExpected(
931/// foo(Aggressive),
932/// []() { return foo(Conservative); },
933/// [](AggressiveStrategyError&) {
934/// // Implicitly conusme this - we'll recover by using a conservative
935/// // strategy.
936/// });
937///
938/// @endcode
939template <typename T, typename RecoveryFtor, typename... HandlerTs>
940Expected<T> handleExpected(Expected<T> ValOrErr, RecoveryFtor &&RecoveryPath,
941 HandlerTs &&... Handlers) {
942 if (ValOrErr)
943 return ValOrErr;
944
945 if (auto Err = handleErrors(ValOrErr.takeError(),
946 std::forward<HandlerTs>(Handlers)...))
947 return std::move(Err);
948
949 return RecoveryPath();
950}
951
952/// Log all errors (if any) in E to OS. If there are any errors, ErrorBanner
953/// will be printed before the first one is logged. A newline will be printed
954/// after each error.
955///
956/// This is useful in the base level of your program to allow clean termination
957/// (allowing clean deallocation of resources, etc.), while reporting error
958/// information to the user.
959void logAllUnhandledErrors(Error E, raw_ostream &OS, Twine ErrorBanner);
960
961/// Write all error messages (if any) in E to a string. The newline character
962/// is used to separate error messages.
963inline std::string toString(Error E) {
964 SmallVector<std::string, 2> Errors;
965 handleAllErrors(std::move(E), [&Errors](const ErrorInfoBase &EI) {
966 Errors.push_back(EI.message());
967 });
968 return join(Errors.begin(), Errors.end(), "\n");
969}
970
971/// Consume a Error without doing anything. This method should be used
972/// only where an error can be considered a reasonable and expected return
973/// value.
974///
975/// Uses of this method are potentially indicative of design problems: If it's
976/// legitimate to do nothing while processing an "error", the error-producer
977/// might be more clearly refactored to return an Optional<T>.
978inline void consumeError(Error Err) {
979 handleAllErrors(std::move(Err), [](const ErrorInfoBase &) {});
980}
981
982/// Helper for converting an Error to a bool.
983///
984/// This method returns true if Err is in an error state, or false if it is
985/// in a success state. Puts Err in a checked state in both cases (unlike
986/// Error::operator bool(), which only does this for success states).
987inline bool errorToBool(Error Err) {
988 bool IsError = static_cast<bool>(Err);
989 if (IsError)
990 consumeError(std::move(Err));
991 return IsError;
992}
993
994/// Helper for Errors used as out-parameters.
995///
996/// This helper is for use with the Error-as-out-parameter idiom, where an error
997/// is passed to a function or method by reference, rather than being returned.
998/// In such cases it is helpful to set the checked bit on entry to the function
999/// so that the error can be written to (unchecked Errors abort on assignment)
1000/// and clear the checked bit on exit so that clients cannot accidentally forget
1001/// to check the result. This helper performs these actions automatically using
1002/// RAII:
1003///
1004/// @code{.cpp}
1005/// Result foo(Error &Err) {
1006/// ErrorAsOutParameter ErrAsOutParam(&Err); // 'Checked' flag set
1007/// // <body of foo>
1008/// // <- 'Checked' flag auto-cleared when ErrAsOutParam is destructed.
1009/// }
1010/// @endcode
1011///
1012/// ErrorAsOutParameter takes an Error* rather than Error& so that it can be
1013/// used with optional Errors (Error pointers that are allowed to be null). If
1014/// ErrorAsOutParameter took an Error reference, an instance would have to be
1015/// created inside every condition that verified that Error was non-null. By
1016/// taking an Error pointer we can just create one instance at the top of the
1017/// function.
1018class ErrorAsOutParameter {
1019public:
1020 ErrorAsOutParameter(Error *Err) : Err(Err) {
1021 // Raise the checked bit if Err is success.
1022 if (Err)
1023 (void)!!*Err;
1024 }
1025
1026 ~ErrorAsOutParameter() {
1027 // Clear the checked bit.
1028 if (Err && !*Err)
1029 *Err = Error::success();
1030 }
1031
1032private:
1033 Error *Err;
1034};
1035
1036/// Helper for Expected<T>s used as out-parameters.
1037///
1038/// See ErrorAsOutParameter.
1039template <typename T>
1040class ExpectedAsOutParameter {
1041public:
1042 ExpectedAsOutParameter(Expected<T> *ValOrErr)
1043 : ValOrErr(ValOrErr) {
1044 if (ValOrErr)
1045 (void)!!*ValOrErr;
1046 }
1047
1048 ~ExpectedAsOutParameter() {
1049 if (ValOrErr)
1050 ValOrErr->setUnchecked();
1051 }
1052
1053private:
1054 Expected<T> *ValOrErr;
1055};
1056
1057/// This class wraps a std::error_code in a Error.
1058///
1059/// This is useful if you're writing an interface that returns a Error
1060/// (or Expected) and you want to call code that still returns
1061/// std::error_codes.
1062class ECError : public ErrorInfo<ECError> {
1063 friend Error errorCodeToError(std::error_code);
1064
1065public:
1066 void setErrorCode(std::error_code EC) { this->EC = EC; }
1067 std::error_code convertToErrorCode() const override { return EC; }
1068 void log(raw_ostream &OS) const override { OS << EC.message(); }
1069
1070 // Used by ErrorInfo::classID.
1071 static char ID;
1072
1073protected:
1074 ECError() = default;
1075 ECError(std::error_code EC) : EC(EC) {}
1076
1077 std::error_code EC;
1078};
1079
1080/// The value returned by this function can be returned from convertToErrorCode
1081/// for Error values where no sensible translation to std::error_code exists.
1082/// It should only be used in this situation, and should never be used where a
1083/// sensible conversion to std::error_code is available, as attempts to convert
1084/// to/from this error will result in a fatal error. (i.e. it is a programmatic
1085///error to try to convert such a value).
1086std::error_code inconvertibleErrorCode();
1087
1088/// Helper for converting an std::error_code to a Error.
1089Error errorCodeToError(std::error_code EC);
1090
1091/// Helper for converting an ECError to a std::error_code.
1092///
1093/// This method requires that Err be Error() or an ECError, otherwise it
1094/// will trigger a call to abort().
1095std::error_code errorToErrorCode(Error Err);
1096
1097/// Convert an ErrorOr<T> to an Expected<T>.
1098template <typename T> Expected<T> errorOrToExpected(ErrorOr<T> &&EO) {
1099 if (auto EC = EO.getError())
1100 return errorCodeToError(EC);
1101 return std::move(*EO);
1102}
1103
1104/// Convert an Expected<T> to an ErrorOr<T>.
1105template <typename T> ErrorOr<T> expectedToErrorOr(Expected<T> &&E) {
1106 if (auto Err = E.takeError())
1107 return errorToErrorCode(std::move(Err));
1108 return std::move(*E);
1109}
1110
1111/// This class wraps a string in an Error.
1112///
1113/// StringError is useful in cases where the client is not expected to be able
1114/// to consume the specific error message programmatically (for example, if the
1115/// error message is to be presented to the user).
1116///
1117/// StringError can also be used when additional information is to be printed
1118/// along with a error_code message. Depending on the constructor called, this
1119/// class can either display:
1120/// 1. the error_code message (ECError behavior)
1121/// 2. a string
1122/// 3. the error_code message and a string
1123///
1124/// These behaviors are useful when subtyping is required; for example, when a
1125/// specific library needs an explicit error type. In the example below,
1126/// PDBError is derived from StringError:
1127///
1128/// @code{.cpp}
1129/// Expected<int> foo() {
1130/// return llvm::make_error<PDBError>(pdb_error_code::dia_failed_loading,
1131/// "Additional information");
1132/// }
1133/// @endcode
1134///
1135class StringError : public ErrorInfo<StringError> {
1136public:
1137 static char ID;
1138
1139 // Prints EC + S and converts to EC
1140 StringError(std::error_code EC, const Twine &S = Twine());
1141
1142 // Prints S and converts to EC
1143 StringError(const Twine &S, std::error_code EC);
1144
1145 void log(raw_ostream &OS) const override;
1146 std::error_code convertToErrorCode() const override;
1147
1148 const std::string &getMessage() const { return Msg; }
1149
1150private:
1151 std::string Msg;
1152 std::error_code EC;
1153 const bool PrintMsgOnly = false;
1154};
1155
1156/// Create formatted StringError object.
1157template <typename... Ts>
1158Error createStringError(std::error_code EC, char const *Fmt,
1159 const Ts &... Vals) {
1160 std::string Buffer;
1161 raw_string_ostream Stream(Buffer);
1162 Stream << format(Fmt, Vals...);
1163 return make_error<StringError>(Stream.str(), EC);
1164}
1165
1166Error createStringError(std::error_code EC, char const *Msg);
1167
1168/// This class wraps a filename and another Error.
1169///
1170/// In some cases, an error needs to live along a 'source' name, in order to
1171/// show more detailed information to the user.
1172class FileError final : public ErrorInfo<FileError> {
1173
1174 friend Error createFileError(std::string, Error);
1175
1176public:
1177 void log(raw_ostream &OS) const override {
1178 assert(Err && !FileName.empty() && "Trying to log after takeError().")((Err && !FileName.empty() && "Trying to log after takeError()."
) ? static_cast<void> (0) : __assert_fail ("Err && !FileName.empty() && \"Trying to log after takeError().\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 1178, __PRETTY_FUNCTION__))
;
1179 OS << "'" << FileName << "': ";
1180 Err->log(OS);
1181 }
1182
1183 Error takeError() { return Error(std::move(Err)); }
1184
1185 std::error_code convertToErrorCode() const override;
1186
1187 // Used by ErrorInfo::classID.
1188 static char ID;
1189
1190private:
1191 FileError(std::string F, std::unique_ptr<ErrorInfoBase> E) {
1192 assert(E && "Cannot create FileError from Error success value.")((E && "Cannot create FileError from Error success value."
) ? static_cast<void> (0) : __assert_fail ("E && \"Cannot create FileError from Error success value.\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 1192, __PRETTY_FUNCTION__))
;
1193 assert(!F.empty() &&((!F.empty() && "The file name provided to FileError must not be empty."
) ? static_cast<void> (0) : __assert_fail ("!F.empty() && \"The file name provided to FileError must not be empty.\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 1194, __PRETTY_FUNCTION__))
1194 "The file name provided to FileError must not be empty.")((!F.empty() && "The file name provided to FileError must not be empty."
) ? static_cast<void> (0) : __assert_fail ("!F.empty() && \"The file name provided to FileError must not be empty.\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h"
, 1194, __PRETTY_FUNCTION__))
;
1195 FileName = F;
1196 Err = std::move(E);
1197 }
1198
1199 static Error build(std::string F, Error E) {
1200 return Error(std::unique_ptr<FileError>(new FileError(F, E.takePayload())));
1201 }
1202
1203 std::string FileName;
1204 std::unique_ptr<ErrorInfoBase> Err;
1205};
1206
1207/// Concatenate a source file path and/or name with an Error. The resulting
1208/// Error is unchecked.
1209inline Error createFileError(std::string F, Error E) {
1210 return FileError::build(F, std::move(E));
1211}
1212
1213Error createFileError(std::string F, ErrorSuccess) = delete;
1214
1215/// Helper for check-and-exit error handling.
1216///
1217/// For tool use only. NOT FOR USE IN LIBRARY CODE.
1218///
1219class ExitOnError {
1220public:
1221 /// Create an error on exit helper.
1222 ExitOnError(std::string Banner = "", int DefaultErrorExitCode = 1)
1223 : Banner(std::move(Banner)),
1224 GetExitCode([=](const Error &) { return DefaultErrorExitCode; }) {}
1225
1226 /// Set the banner string for any errors caught by operator().
1227 void setBanner(std::string Banner) { this->Banner = std::move(Banner); }
1228
1229 /// Set the exit-code mapper function.
1230 void setExitCodeMapper(std::function<int(const Error &)> GetExitCode) {
1231 this->GetExitCode = std::move(GetExitCode);
1232 }
1233
1234 /// Check Err. If it's in a failure state log the error(s) and exit.
1235 void operator()(Error Err) const { checkError(std::move(Err)); }
1236
1237 /// Check E. If it's in a success state then return the contained value. If
1238 /// it's in a failure state log the error(s) and exit.
1239 template <typename T> T operator()(Expected<T> &&E) const {
1240 checkError(E.takeError());
1241 return std::move(*E);
1242 }
1243
1244 /// Check E. If it's in a success state then return the contained reference. If
1245 /// it's in a failure state log the error(s) and exit.
1246 template <typename T> T& operator()(Expected<T&> &&E) const {
1247 checkError(E.takeError());
1248 return *E;
1249 }
1250
1251private:
1252 void checkError(Error Err) const {
1253 if (Err) {
1254 int ExitCode = GetExitCode(Err);
1255 logAllUnhandledErrors(std::move(Err), errs(), Banner);
1256 exit(ExitCode);
1257 }
1258 }
1259
1260 std::string Banner;
1261 std::function<int(const Error &)> GetExitCode;
1262};
1263
1264/// Conversion from Error to LLVMErrorRef for C error bindings.
1265inline LLVMErrorRef wrap(Error Err) {
1266 return reinterpret_cast<LLVMErrorRef>(Err.takePayload().release());
1267}
1268
1269/// Conversion from LLVMErrorRef to Error for C error bindings.
1270inline Error unwrap(LLVMErrorRef ErrRef) {
1271 return Error(std::unique_ptr<ErrorInfoBase>(
1272 reinterpret_cast<ErrorInfoBase *>(ErrRef)));
1273}
1274
1275} // end namespace llvm
1276
1277#endif // LLVM_SUPPORT_ERROR_H

/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h

1//===- llvm/ADT/STLExtras.h - Useful STL related functions ------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains some templates that are useful if you are working with the
11// STL at all.
12//
13// No library is required when using these functions.
14//
15//===----------------------------------------------------------------------===//
16
17#ifndef LLVM_ADT_STLEXTRAS_H
18#define LLVM_ADT_STLEXTRAS_H
19
20#include "llvm/ADT/Optional.h"
21#include "llvm/ADT/SmallVector.h"
22#include "llvm/ADT/iterator.h"
23#include "llvm/ADT/iterator_range.h"
24#include "llvm/Config/abi-breaking.h"
25#include "llvm/Support/ErrorHandling.h"
26#include <algorithm>
27#include <cassert>
28#include <cstddef>
29#include <cstdint>
30#include <cstdlib>
31#include <functional>
32#include <initializer_list>
33#include <iterator>
34#include <limits>
35#include <memory>
36#include <tuple>
37#include <type_traits>
38#include <utility>
39
40#ifdef EXPENSIVE_CHECKS
41#include <random> // for std::mt19937
42#endif
43
44namespace llvm {
45
46// Only used by compiler if both template types are the same. Useful when
47// using SFINAE to test for the existence of member functions.
48template <typename T, T> struct SameType;
49
50namespace detail {
51
52template <typename RangeT>
53using IterOfRange = decltype(std::begin(std::declval<RangeT &>()));
54
55template <typename RangeT>
56using ValueOfRange = typename std::remove_reference<decltype(
57 *std::begin(std::declval<RangeT &>()))>::type;
58
59} // end namespace detail
60
61//===----------------------------------------------------------------------===//
62// Extra additions to <type_traits>
63//===----------------------------------------------------------------------===//
64
65template <typename T>
66struct negation : std::integral_constant<bool, !bool(T::value)> {};
67
68template <typename...> struct conjunction : std::true_type {};
69template <typename B1> struct conjunction<B1> : B1 {};
70template <typename B1, typename... Bn>
71struct conjunction<B1, Bn...>
72 : std::conditional<bool(B1::value), conjunction<Bn...>, B1>::type {};
73
74//===----------------------------------------------------------------------===//
75// Extra additions to <functional>
76//===----------------------------------------------------------------------===//
77
78template <class Ty> struct identity {
79 using argument_type = Ty;
80
81 Ty &operator()(Ty &self) const {
82 return self;
83 }
84 const Ty &operator()(const Ty &self) const {
85 return self;
86 }
87};
88
89template <class Ty> struct less_ptr {
90 bool operator()(const Ty* left, const Ty* right) const {
91 return *left < *right;
92 }
93};
94
95template <class Ty> struct greater_ptr {
96 bool operator()(const Ty* left, const Ty* right) const {
97 return *right < *left;
98 }
99};
100
101/// An efficient, type-erasing, non-owning reference to a callable. This is
102/// intended for use as the type of a function parameter that is not used
103/// after the function in question returns.
104///
105/// This class does not own the callable, so it is not in general safe to store
106/// a function_ref.
107template<typename Fn> class function_ref;
108
109template<typename Ret, typename ...Params>
110class function_ref<Ret(Params...)> {
111 Ret (*callback)(intptr_t callable, Params ...params) = nullptr;
112 intptr_t callable;
113
114 template<typename Callable>
115 static Ret callback_fn(intptr_t callable, Params ...params) {
116 return (*reinterpret_cast<Callable*>(callable))(
117 std::forward<Params>(params)...);
118 }
119
120public:
121 function_ref() = default;
122 function_ref(std::nullptr_t) {}
123
124 template <typename Callable>
125 function_ref(Callable &&callable,
126 typename std::enable_if<
127 !std::is_same<typename std::remove_reference<Callable>::type,
128 function_ref>::value>::type * = nullptr)
129 : callback(callback_fn<typename std::remove_reference<Callable>::type>),
130 callable(reinterpret_cast<intptr_t>(&callable)) {}
131
132 Ret operator()(Params ...params) const {
133 return callback(callable, std::forward<Params>(params)...);
134 }
135
136 operator bool() const { return callback; }
137};
138
139// deleter - Very very very simple method that is used to invoke operator
140// delete on something. It is used like this:
141//
142// for_each(V.begin(), B.end(), deleter<Interval>);
143template <class T>
144inline void deleter(T *Ptr) {
145 delete Ptr;
146}
147
148//===----------------------------------------------------------------------===//
149// Extra additions to <iterator>
150//===----------------------------------------------------------------------===//
151
152namespace adl_detail {
153
154using std::begin;
155
156template <typename ContainerTy>
157auto adl_begin(ContainerTy &&container)
158 -> decltype(begin(std::forward<ContainerTy>(container))) {
159 return begin(std::forward<ContainerTy>(container));
160}
161
162using std::end;
163
164template <typename ContainerTy>
165auto adl_end(ContainerTy &&container)
166 -> decltype(end(std::forward<ContainerTy>(container))) {
167 return end(std::forward<ContainerTy>(container));
168}
169
170using std::swap;
171
172template <typename T>
173void adl_swap(T &&lhs, T &&rhs) noexcept(noexcept(swap(std::declval<T>(),
174 std::declval<T>()))) {
175 swap(std::forward<T>(lhs), std::forward<T>(rhs));
176}
177
178} // end namespace adl_detail
179
180template <typename ContainerTy>
181auto adl_begin(ContainerTy &&container)
182 -> decltype(adl_detail::adl_begin(std::forward<ContainerTy>(container))) {
183 return adl_detail::adl_begin(std::forward<ContainerTy>(container));
184}
185
186template <typename ContainerTy>
187auto adl_end(ContainerTy &&container)
188 -> decltype(adl_detail::adl_end(std::forward<ContainerTy>(container))) {
189 return adl_detail::adl_end(std::forward<ContainerTy>(container));
190}
191
192template <typename T>
193void adl_swap(T &&lhs, T &&rhs) noexcept(
194 noexcept(adl_detail::adl_swap(std::declval<T>(), std::declval<T>()))) {
195 adl_detail::adl_swap(std::forward<T>(lhs), std::forward<T>(rhs));
196}
197
198// mapped_iterator - This is a simple iterator adapter that causes a function to
199// be applied whenever operator* is invoked on the iterator.
200
201template <typename ItTy, typename FuncTy,
202 typename FuncReturnTy =
203 decltype(std::declval<FuncTy>()(*std::declval<ItTy>()))>
204class mapped_iterator
205 : public iterator_adaptor_base<
206 mapped_iterator<ItTy, FuncTy>, ItTy,
207 typename std::iterator_traits<ItTy>::iterator_category,
208 typename std::remove_reference<FuncReturnTy>::type> {
209public:
210 mapped_iterator(ItTy U, FuncTy F)
211 : mapped_iterator::iterator_adaptor_base(std::move(U)), F(std::move(F)) {}
212
213 ItTy getCurrent() { return this->I; }
214
215 FuncReturnTy operator*() { return F(*this->I); }
216
217private:
218 FuncTy F;
219};
220
221// map_iterator - Provide a convenient way to create mapped_iterators, just like
222// make_pair is useful for creating pairs...
223template <class ItTy, class FuncTy>
224inline mapped_iterator<ItTy, FuncTy> map_iterator(ItTy I, FuncTy F) {
225 return mapped_iterator<ItTy, FuncTy>(std::move(I), std::move(F));
226}
227
228/// Helper to determine if type T has a member called rbegin().
229template <typename Ty> class has_rbegin_impl {
230 using yes = char[1];
231 using no = char[2];
232
233 template <typename Inner>
234 static yes& test(Inner *I, decltype(I->rbegin()) * = nullptr);
235
236 template <typename>
237 static no& test(...);
238
239public:
240 static const bool value = sizeof(test<Ty>(nullptr)) == sizeof(yes);
241};
242
243/// Metafunction to determine if T& or T has a member called rbegin().
244template <typename Ty>
245struct has_rbegin : has_rbegin_impl<typename std::remove_reference<Ty>::type> {
246};
247
248// Returns an iterator_range over the given container which iterates in reverse.
249// Note that the container must have rbegin()/rend() methods for this to work.
250template <typename ContainerTy>
251auto reverse(ContainerTy &&C,
252 typename std::enable_if<has_rbegin<ContainerTy>::value>::type * =
253 nullptr) -> decltype(make_range(C.rbegin(), C.rend())) {
254 return make_range(C.rbegin(), C.rend());
255}
256
257// Returns a std::reverse_iterator wrapped around the given iterator.
258template <typename IteratorTy>
259std::reverse_iterator<IteratorTy> make_reverse_iterator(IteratorTy It) {
260 return std::reverse_iterator<IteratorTy>(It);
261}
262
263// Returns an iterator_range over the given container which iterates in reverse.
264// Note that the container must have begin()/end() methods which return
265// bidirectional iterators for this to work.
266template <typename ContainerTy>
267auto reverse(
268 ContainerTy &&C,
269 typename std::enable_if<!has_rbegin<ContainerTy>::value>::type * = nullptr)
270 -> decltype(make_range(llvm::make_reverse_iterator(std::end(C)),
271 llvm::make_reverse_iterator(std::begin(C)))) {
272 return make_range(llvm::make_reverse_iterator(std::end(C)),
273 llvm::make_reverse_iterator(std::begin(C)));
274}
275
276/// An iterator adaptor that filters the elements of given inner iterators.
277///
278/// The predicate parameter should be a callable object that accepts the wrapped
279/// iterator's reference type and returns a bool. When incrementing or
280/// decrementing the iterator, it will call the predicate on each element and
281/// skip any where it returns false.
282///
283/// \code
284/// int A[] = { 1, 2, 3, 4 };
285/// auto R = make_filter_range(A, [](int N) { return N % 2 == 1; });
286/// // R contains { 1, 3 }.
287/// \endcode
288///
289/// Note: filter_iterator_base implements support for forward iteration.
290/// filter_iterator_impl exists to provide support for bidirectional iteration,
291/// conditional on whether the wrapped iterator supports it.
292template <typename WrappedIteratorT, typename PredicateT, typename IterTag>
293class filter_iterator_base
294 : public iterator_adaptor_base<
295 filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>,
296 WrappedIteratorT,
297 typename std::common_type<
298 IterTag, typename std::iterator_traits<
299 WrappedIteratorT>::iterator_category>::type> {
300 using BaseT = iterator_adaptor_base<
301 filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>,
302 WrappedIteratorT,
303 typename std::common_type<
304 IterTag, typename std::iterator_traits<
305 WrappedIteratorT>::iterator_category>::type>;
306
307protected:
308 WrappedIteratorT End;
309 PredicateT Pred;
310
311 void findNextValid() {
312 while (this->I != End && !Pred(*this->I))
313 BaseT::operator++();
314 }
315
316 // Construct the iterator. The begin iterator needs to know where the end
317 // is, so that it can properly stop when it gets there. The end iterator only
318 // needs the predicate to support bidirectional iteration.
319 filter_iterator_base(WrappedIteratorT Begin, WrappedIteratorT End,
320 PredicateT Pred)
321 : BaseT(Begin), End(End), Pred(Pred) {
322 findNextValid();
323 }
324
325public:
326 using BaseT::operator++;
327
328 filter_iterator_base &operator++() {
329 BaseT::operator++();
330 findNextValid();
331 return *this;
332 }
333};
334
335/// Specialization of filter_iterator_base for forward iteration only.
336template <typename WrappedIteratorT, typename PredicateT,
337 typename IterTag = std::forward_iterator_tag>
338class filter_iterator_impl
339 : public filter_iterator_base<WrappedIteratorT, PredicateT, IterTag> {
340 using BaseT = filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>;
341
342public:
343 filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End,
344 PredicateT Pred)
345 : BaseT(Begin, End, Pred) {}
346};
347
348/// Specialization of filter_iterator_base for bidirectional iteration.
349template <typename WrappedIteratorT, typename PredicateT>
350class filter_iterator_impl<WrappedIteratorT, PredicateT,
351 std::bidirectional_iterator_tag>
352 : public filter_iterator_base<WrappedIteratorT, PredicateT,
353 std::bidirectional_iterator_tag> {
354 using BaseT = filter_iterator_base<WrappedIteratorT, PredicateT,
355 std::bidirectional_iterator_tag>;
356 void findPrevValid() {
357 while (!this->Pred(*this->I))
358 BaseT::operator--();
359 }
360
361public:
362 using BaseT::operator--;
363
364 filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End,
365 PredicateT Pred)
366 : BaseT(Begin, End, Pred) {}
367
368 filter_iterator_impl &operator--() {
369 BaseT::operator--();
370 findPrevValid();
371 return *this;
372 }
373};
374
375namespace detail {
376
377template <bool is_bidirectional> struct fwd_or_bidi_tag_impl {
378 using type = std::forward_iterator_tag;
379};
380
381template <> struct fwd_or_bidi_tag_impl<true> {
382 using type = std::bidirectional_iterator_tag;
383};
384
385/// Helper which sets its type member to forward_iterator_tag if the category
386/// of \p IterT does not derive from bidirectional_iterator_tag, and to
387/// bidirectional_iterator_tag otherwise.
388template <typename IterT> struct fwd_or_bidi_tag {
389 using type = typename fwd_or_bidi_tag_impl<std::is_base_of<
390 std::bidirectional_iterator_tag,
391 typename std::iterator_traits<IterT>::iterator_category>::value>::type;
392};
393
394} // namespace detail
395
396/// Defines filter_iterator to a suitable specialization of
397/// filter_iterator_impl, based on the underlying iterator's category.
398template <typename WrappedIteratorT, typename PredicateT>
399using filter_iterator = filter_iterator_impl<
400 WrappedIteratorT, PredicateT,
401 typename detail::fwd_or_bidi_tag<WrappedIteratorT>::type>;
402
403/// Convenience function that takes a range of elements and a predicate,
404/// and return a new filter_iterator range.
405///
406/// FIXME: Currently if RangeT && is a rvalue reference to a temporary, the
407/// lifetime of that temporary is not kept by the returned range object, and the
408/// temporary is going to be dropped on the floor after the make_iterator_range
409/// full expression that contains this function call.
410template <typename RangeT, typename PredicateT>
411iterator_range<filter_iterator<detail::IterOfRange<RangeT>, PredicateT>>
412make_filter_range(RangeT &&Range, PredicateT Pred) {
413 using FilterIteratorT =
414 filter_iterator<detail::IterOfRange<RangeT>, PredicateT>;
415 return make_range(
416 FilterIteratorT(std::begin(std::forward<RangeT>(Range)),
417 std::end(std::forward<RangeT>(Range)), Pred),
418 FilterIteratorT(std::end(std::forward<RangeT>(Range)),
419 std::end(std::forward<RangeT>(Range)), Pred));
420}
421
422/// A pseudo-iterator adaptor that is designed to implement "early increment"
423/// style loops.
424///
425/// This is *not a normal iterator* and should almost never be used directly. It
426/// is intended primarily to be used with range based for loops and some range
427/// algorithms.
428///
429/// The iterator isn't quite an `OutputIterator` or an `InputIterator` but
430/// somewhere between them. The constraints of these iterators are:
431///
432/// - On construction or after being incremented, it is comparable and
433/// dereferencable. It is *not* incrementable.
434/// - After being dereferenced, it is neither comparable nor dereferencable, it
435/// is only incrementable.
436///
437/// This means you can only dereference the iterator once, and you can only
438/// increment it once between dereferences.
439template <typename WrappedIteratorT>
440class early_inc_iterator_impl
441 : public iterator_adaptor_base<early_inc_iterator_impl<WrappedIteratorT>,
442 WrappedIteratorT, std::input_iterator_tag> {
443 using BaseT =
444 iterator_adaptor_base<early_inc_iterator_impl<WrappedIteratorT>,
445 WrappedIteratorT, std::input_iterator_tag>;
446
447 using PointerT = typename std::iterator_traits<WrappedIteratorT>::pointer;
448
449protected:
450#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
451 bool IsEarlyIncremented = false;
452#endif
453
454public:
455 early_inc_iterator_impl(WrappedIteratorT I) : BaseT(I) {}
456
457 using BaseT::operator*;
458 typename BaseT::reference operator*() {
459#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
460 assert(!IsEarlyIncremented && "Cannot dereference twice!")((!IsEarlyIncremented && "Cannot dereference twice!")
? static_cast<void> (0) : __assert_fail ("!IsEarlyIncremented && \"Cannot dereference twice!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 460, __PRETTY_FUNCTION__))
;
461 IsEarlyIncremented = true;
462#endif
463 return *(this->I)++;
464 }
465
466 using BaseT::operator++;
467 early_inc_iterator_impl &operator++() {
468#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
469 assert(IsEarlyIncremented && "Cannot increment before dereferencing!")((IsEarlyIncremented && "Cannot increment before dereferencing!"
) ? static_cast<void> (0) : __assert_fail ("IsEarlyIncremented && \"Cannot increment before dereferencing!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 469, __PRETTY_FUNCTION__))
;
470 IsEarlyIncremented = false;
471#endif
472 return *this;
473 }
474
475 using BaseT::operator==;
476 bool operator==(const early_inc_iterator_impl &RHS) const {
477#if LLVM_ENABLE_ABI_BREAKING_CHECKS1
478 assert(!IsEarlyIncremented && "Cannot compare after dereferencing!")((!IsEarlyIncremented && "Cannot compare after dereferencing!"
) ? static_cast<void> (0) : __assert_fail ("!IsEarlyIncremented && \"Cannot compare after dereferencing!\""
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 478, __PRETTY_FUNCTION__))
;
479#endif
480 return BaseT::operator==(RHS);
481 }
482};
483
484/// Make a range that does early increment to allow mutation of the underlying
485/// range without disrupting iteration.
486///
487/// The underlying iterator will be incremented immediately after it is
488/// dereferenced, allowing deletion of the current node or insertion of nodes to
489/// not disrupt iteration provided they do not invalidate the *next* iterator --
490/// the current iterator can be invalidated.
491///
492/// This requires a very exact pattern of use that is only really suitable to
493/// range based for loops and other range algorithms that explicitly guarantee
494/// to dereference exactly once each element, and to increment exactly once each
495/// element.
496template <typename RangeT>
497iterator_range<early_inc_iterator_impl<detail::IterOfRange<RangeT>>>
498make_early_inc_range(RangeT &&Range) {
499 using EarlyIncIteratorT =
500 early_inc_iterator_impl<detail::IterOfRange<RangeT>>;
501 return make_range(EarlyIncIteratorT(std::begin(std::forward<RangeT>(Range))),
502 EarlyIncIteratorT(std::end(std::forward<RangeT>(Range))));
503}
504
505// forward declarations required by zip_shortest/zip_first
506template <typename R, typename UnaryPredicate>
507bool all_of(R &&range, UnaryPredicate P);
508
509template <size_t... I> struct index_sequence;
510
511template <class... Ts> struct index_sequence_for;
512
513namespace detail {
514
515using std::declval;
516
517// We have to alias this since inlining the actual type at the usage site
518// in the parameter list of iterator_facade_base<> below ICEs MSVC 2017.
519template<typename... Iters> struct ZipTupleType {
520 using type = std::tuple<decltype(*declval<Iters>())...>;
521};
522
523template <typename ZipType, typename... Iters>
524using zip_traits = iterator_facade_base<
525 ZipType, typename std::common_type<std::bidirectional_iterator_tag,
526 typename std::iterator_traits<
527 Iters>::iterator_category...>::type,
528 // ^ TODO: Implement random access methods.
529 typename ZipTupleType<Iters...>::type,
530 typename std::iterator_traits<typename std::tuple_element<
531 0, std::tuple<Iters...>>::type>::difference_type,
532 // ^ FIXME: This follows boost::make_zip_iterator's assumption that all
533 // inner iterators have the same difference_type. It would fail if, for
534 // instance, the second field's difference_type were non-numeric while the
535 // first is.
536 typename ZipTupleType<Iters...>::type *,
537 typename ZipTupleType<Iters...>::type>;
538
539template <typename ZipType, typename... Iters>
540struct zip_common : public zip_traits<ZipType, Iters...> {
541 using Base = zip_traits<ZipType, Iters...>;
542 using value_type = typename Base::value_type;
543
544 std::tuple<Iters...> iterators;
545
546protected:
547 template <size_t... Ns> value_type deref(index_sequence<Ns...>) const {
548 return value_type(*std::get<Ns>(iterators)...);
549 }
550
551 template <size_t... Ns>
552 decltype(iterators) tup_inc(index_sequence<Ns...>) const {
553 return std::tuple<Iters...>(std::next(std::get<Ns>(iterators))...);
554 }
555
556 template <size_t... Ns>
557 decltype(iterators) tup_dec(index_sequence<Ns...>) const {
558 return std::tuple<Iters...>(std::prev(std::get<Ns>(iterators))...);
559 }
560
561public:
562 zip_common(Iters &&... ts) : iterators(std::forward<Iters>(ts)...) {}
563
564 value_type operator*() { return deref(index_sequence_for<Iters...>{}); }
565
566 const value_type operator*() const {
567 return deref(index_sequence_for<Iters...>{});
568 }
569
570 ZipType &operator++() {
571 iterators = tup_inc(index_sequence_for<Iters...>{});
572 return *reinterpret_cast<ZipType *>(this);
573 }
574
575 ZipType &operator--() {
576 static_assert(Base::IsBidirectional,
577 "All inner iterators must be at least bidirectional.");
578 iterators = tup_dec(index_sequence_for<Iters...>{});
579 return *reinterpret_cast<ZipType *>(this);
580 }
581};
582
583template <typename... Iters>
584struct zip_first : public zip_common<zip_first<Iters...>, Iters...> {
585 using Base = zip_common<zip_first<Iters...>, Iters...>;
586
587 bool operator==(const zip_first<Iters...> &other) const {
588 return std::get<0>(this->iterators) == std::get<0>(other.iterators);
589 }
590
591 zip_first(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {}
592};
593
594template <typename... Iters>
595class zip_shortest : public zip_common<zip_shortest<Iters...>, Iters...> {
596 template <size_t... Ns>
597 bool test(const zip_shortest<Iters...> &other, index_sequence<Ns...>) const {
598 return all_of(std::initializer_list<bool>{std::get<Ns>(this->iterators) !=
599 std::get<Ns>(other.iterators)...},
600 identity<bool>{});
601 }
602
603public:
604 using Base = zip_common<zip_shortest<Iters...>, Iters...>;
605
606 zip_shortest(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {}
607
608 bool operator==(const zip_shortest<Iters...> &other) const {
609 return !test(other, index_sequence_for<Iters...>{});
610 }
611};
612
613template <template <typename...> class ItType, typename... Args> class zippy {
614public:
615 using iterator = ItType<decltype(std::begin(std::declval<Args>()))...>;
616 using iterator_category = typename iterator::iterator_category;
617 using value_type = typename iterator::value_type;
618 using difference_type = typename iterator::difference_type;
619 using pointer = typename iterator::pointer;
620 using reference = typename iterator::reference;
621
622private:
623 std::tuple<Args...> ts;
624
625 template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) const {
626 return iterator(std::begin(std::get<Ns>(ts))...);
627 }
628 template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) const {
629 return iterator(std::end(std::get<Ns>(ts))...);
630 }
631
632public:
633 zippy(Args &&... ts_) : ts(std::forward<Args>(ts_)...) {}
634
635 iterator begin() const { return begin_impl(index_sequence_for<Args...>{}); }
636 iterator end() const { return end_impl(index_sequence_for<Args...>{}); }
637};
638
639} // end namespace detail
640
641/// zip iterator for two or more iteratable types.
642template <typename T, typename U, typename... Args>
643detail::zippy<detail::zip_shortest, T, U, Args...> zip(T &&t, U &&u,
644 Args &&... args) {
645 return detail::zippy<detail::zip_shortest, T, U, Args...>(
646 std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...);
647}
648
649/// zip iterator that, for the sake of efficiency, assumes the first iteratee to
650/// be the shortest.
651template <typename T, typename U, typename... Args>
652detail::zippy<detail::zip_first, T, U, Args...> zip_first(T &&t, U &&u,
653 Args &&... args) {
654 return detail::zippy<detail::zip_first, T, U, Args...>(
655 std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...);
656}
657
658/// Iterator wrapper that concatenates sequences together.
659///
660/// This can concatenate different iterators, even with different types, into
661/// a single iterator provided the value types of all the concatenated
662/// iterators expose `reference` and `pointer` types that can be converted to
663/// `ValueT &` and `ValueT *` respectively. It doesn't support more
664/// interesting/customized pointer or reference types.
665///
666/// Currently this only supports forward or higher iterator categories as
667/// inputs and always exposes a forward iterator interface.
668template <typename ValueT, typename... IterTs>
669class concat_iterator
670 : public iterator_facade_base<concat_iterator<ValueT, IterTs...>,
671 std::forward_iterator_tag, ValueT> {
672 using BaseT = typename concat_iterator::iterator_facade_base;
673
674 /// We store both the current and end iterators for each concatenated
675 /// sequence in a tuple of pairs.
676 ///
677 /// Note that something like iterator_range seems nice at first here, but the
678 /// range properties are of little benefit and end up getting in the way
679 /// because we need to do mutation on the current iterators.
680 std::tuple<IterTs...> Begins;
681 std::tuple<IterTs...> Ends;
682
683 /// Attempts to increment a specific iterator.
684 ///
685 /// Returns true if it was able to increment the iterator. Returns false if
686 /// the iterator is already at the end iterator.
687 template <size_t Index> bool incrementHelper() {
688 auto &Begin = std::get<Index>(Begins);
689 auto &End = std::get<Index>(Ends);
690 if (Begin == End)
691 return false;
692
693 ++Begin;
694 return true;
695 }
696
697 /// Increments the first non-end iterator.
698 ///
699 /// It is an error to call this with all iterators at the end.
700 template <size_t... Ns> void increment(index_sequence<Ns...>) {
701 // Build a sequence of functions to increment each iterator if possible.
702 bool (concat_iterator::*IncrementHelperFns[])() = {
703 &concat_iterator::incrementHelper<Ns>...};
704
705 // Loop over them, and stop as soon as we succeed at incrementing one.
706 for (auto &IncrementHelperFn : IncrementHelperFns)
707 if ((this->*IncrementHelperFn)())
708 return;
709
710 llvm_unreachable("Attempted to increment an end concat iterator!")::llvm::llvm_unreachable_internal("Attempted to increment an end concat iterator!"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 710)
;
711 }
712
713 /// Returns null if the specified iterator is at the end. Otherwise,
714 /// dereferences the iterator and returns the address of the resulting
715 /// reference.
716 template <size_t Index> ValueT *getHelper() const {
717 auto &Begin = std::get<Index>(Begins);
718 auto &End = std::get<Index>(Ends);
719 if (Begin == End)
720 return nullptr;
721
722 return &*Begin;
723 }
724
725 /// Finds the first non-end iterator, dereferences, and returns the resulting
726 /// reference.
727 ///
728 /// It is an error to call this with all iterators at the end.
729 template <size_t... Ns> ValueT &get(index_sequence<Ns...>) const {
730 // Build a sequence of functions to get from iterator if possible.
731 ValueT *(concat_iterator::*GetHelperFns[])() const = {
732 &concat_iterator::getHelper<Ns>...};
733
734 // Loop over them, and return the first result we find.
735 for (auto &GetHelperFn : GetHelperFns)
736 if (ValueT *P = (this->*GetHelperFn)())
737 return *P;
738
739 llvm_unreachable("Attempted to get a pointer from an end concat iterator!")::llvm::llvm_unreachable_internal("Attempted to get a pointer from an end concat iterator!"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 739)
;
740 }
741
742public:
743 /// Constructs an iterator from a squence of ranges.
744 ///
745 /// We need the full range to know how to switch between each of the
746 /// iterators.
747 template <typename... RangeTs>
748 explicit concat_iterator(RangeTs &&... Ranges)
749 : Begins(std::begin(Ranges)...), Ends(std::end(Ranges)...) {}
750
751 using BaseT::operator++;
752
753 concat_iterator &operator++() {
754 increment(index_sequence_for<IterTs...>());
755 return *this;
756 }
757
758 ValueT &operator*() const { return get(index_sequence_for<IterTs...>()); }
759
760 bool operator==(const concat_iterator &RHS) const {
761 return Begins == RHS.Begins && Ends == RHS.Ends;
762 }
763};
764
765namespace detail {
766
767/// Helper to store a sequence of ranges being concatenated and access them.
768///
769/// This is designed to facilitate providing actual storage when temporaries
770/// are passed into the constructor such that we can use it as part of range
771/// based for loops.
772template <typename ValueT, typename... RangeTs> class concat_range {
773public:
774 using iterator =
775 concat_iterator<ValueT,
776 decltype(std::begin(std::declval<RangeTs &>()))...>;
777
778private:
779 std::tuple<RangeTs...> Ranges;
780
781 template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) {
782 return iterator(std::get<Ns>(Ranges)...);
783 }
784 template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) {
785 return iterator(make_range(std::end(std::get<Ns>(Ranges)),
786 std::end(std::get<Ns>(Ranges)))...);
787 }
788
789public:
790 concat_range(RangeTs &&... Ranges)
791 : Ranges(std::forward<RangeTs>(Ranges)...) {}
792
793 iterator begin() { return begin_impl(index_sequence_for<RangeTs...>{}); }
794 iterator end() { return end_impl(index_sequence_for<RangeTs...>{}); }
795};
796
797} // end namespace detail
798
799/// Concatenated range across two or more ranges.
800///
801/// The desired value type must be explicitly specified.
802template <typename ValueT, typename... RangeTs>
803detail::concat_range<ValueT, RangeTs...> concat(RangeTs &&... Ranges) {
804 static_assert(sizeof...(RangeTs) > 1,
805 "Need more than one range to concatenate!");
806 return detail::concat_range<ValueT, RangeTs...>(
807 std::forward<RangeTs>(Ranges)...);
808}
809
810//===----------------------------------------------------------------------===//
811// Extra additions to <utility>
812//===----------------------------------------------------------------------===//
813
814/// Function object to check whether the first component of a std::pair
815/// compares less than the first component of another std::pair.
816struct less_first {
817 template <typename T> bool operator()(const T &lhs, const T &rhs) const {
818 return lhs.first < rhs.first;
819 }
820};
821
822/// Function object to check whether the second component of a std::pair
823/// compares less than the second component of another std::pair.
824struct less_second {
825 template <typename T> bool operator()(const T &lhs, const T &rhs) const {
826 return lhs.second < rhs.second;
827 }
828};
829
830/// \brief Function object to apply a binary function to the first component of
831/// a std::pair.
832template<typename FuncTy>
833struct on_first {
834 FuncTy func;
835
836 template <typename T>
837 auto operator()(const T &lhs, const T &rhs) const
838 -> decltype(func(lhs.first, rhs.first)) {
839 return func(lhs.first, rhs.first);
840 }
841};
842
843// A subset of N3658. More stuff can be added as-needed.
844
845/// Represents a compile-time sequence of integers.
846template <class T, T... I> struct integer_sequence {
847 using value_type = T;
848
849 static constexpr size_t size() { return sizeof...(I); }
850};
851
852/// Alias for the common case of a sequence of size_ts.
853template <size_t... I>
854struct index_sequence : integer_sequence<std::size_t, I...> {};
855
856template <std::size_t N, std::size_t... I>
857struct build_index_impl : build_index_impl<N - 1, N - 1, I...> {};
858template <std::size_t... I>
859struct build_index_impl<0, I...> : index_sequence<I...> {};
860
861/// Creates a compile-time integer sequence for a parameter pack.
862template <class... Ts>
863struct index_sequence_for : build_index_impl<sizeof...(Ts)> {};
864
865/// Utility type to build an inheritance chain that makes it easy to rank
866/// overload candidates.
867template <int N> struct rank : rank<N - 1> {};
868template <> struct rank<0> {};
869
870/// traits class for checking whether type T is one of any of the given
871/// types in the variadic list.
872template <typename T, typename... Ts> struct is_one_of {
873 static const bool value = false;
874};
875
876template <typename T, typename U, typename... Ts>
877struct is_one_of<T, U, Ts...> {
878 static const bool value =
879 std::is_same<T, U>::value || is_one_of<T, Ts...>::value;
880};
881
882/// traits class for checking whether type T is a base class for all
883/// the given types in the variadic list.
884template <typename T, typename... Ts> struct are_base_of {
885 static const bool value = true;
886};
887
888template <typename T, typename U, typename... Ts>
889struct are_base_of<T, U, Ts...> {
890 static const bool value =
891 std::is_base_of<T, U>::value && are_base_of<T, Ts...>::value;
892};
893
894//===----------------------------------------------------------------------===//
895// Extra additions for arrays
896//===----------------------------------------------------------------------===//
897
898/// Find the length of an array.
899template <class T, std::size_t N>
900constexpr inline size_t array_lengthof(T (&)[N]) {
901 return N;
902}
903
904/// Adapt std::less<T> for array_pod_sort.
905template<typename T>
906inline int array_pod_sort_comparator(const void *P1, const void *P2) {
907 if (std::less<T>()(*reinterpret_cast<const T*>(P1),
908 *reinterpret_cast<const T*>(P2)))
909 return -1;
910 if (std::less<T>()(*reinterpret_cast<const T*>(P2),
911 *reinterpret_cast<const T*>(P1)))
912 return 1;
913 return 0;
914}
915
916/// get_array_pod_sort_comparator - This is an internal helper function used to
917/// get type deduction of T right.
918template<typename T>
919inline int (*get_array_pod_sort_comparator(const T &))
920 (const void*, const void*) {
921 return array_pod_sort_comparator<T>;
922}
923
924/// array_pod_sort - This sorts an array with the specified start and end
925/// extent. This is just like std::sort, except that it calls qsort instead of
926/// using an inlined template. qsort is slightly slower than std::sort, but
927/// most sorts are not performance critical in LLVM and std::sort has to be
928/// template instantiated for each type, leading to significant measured code
929/// bloat. This function should generally be used instead of std::sort where
930/// possible.
931///
932/// This function assumes that you have simple POD-like types that can be
933/// compared with std::less and can be moved with memcpy. If this isn't true,
934/// you should use std::sort.
935///
936/// NOTE: If qsort_r were portable, we could allow a custom comparator and
937/// default to std::less.
938template<class IteratorTy>
939inline void array_pod_sort(IteratorTy Start, IteratorTy End) {
940 // Don't inefficiently call qsort with one element or trigger undefined
941 // behavior with an empty sequence.
942 auto NElts = End - Start;
943 if (NElts <= 1) return;
944#ifdef EXPENSIVE_CHECKS
945 std::mt19937 Generator(std::random_device{}());
946 std::shuffle(Start, End, Generator);
947#endif
948 qsort(&*Start, NElts, sizeof(*Start), get_array_pod_sort_comparator(*Start));
949}
950
951template <class IteratorTy>
952inline void array_pod_sort(
953 IteratorTy Start, IteratorTy End,
954 int (*Compare)(
955 const typename std::iterator_traits<IteratorTy>::value_type *,
956 const typename std::iterator_traits<IteratorTy>::value_type *)) {
957 // Don't inefficiently call qsort with one element or trigger undefined
958 // behavior with an empty sequence.
959 auto NElts = End - Start;
960 if (NElts <= 1) return;
961#ifdef EXPENSIVE_CHECKS
962 std::mt19937 Generator(std::random_device{}());
963 std::shuffle(Start, End, Generator);
964#endif
965 qsort(&*Start, NElts, sizeof(*Start),
966 reinterpret_cast<int (*)(const void *, const void *)>(Compare));
967}
968
969// Provide wrappers to std::sort which shuffle the elements before sorting
970// to help uncover non-deterministic behavior (PR35135).
971template <typename IteratorTy>
972inline void sort(IteratorTy Start, IteratorTy End) {
973#ifdef EXPENSIVE_CHECKS
974 std::mt19937 Generator(std::random_device{}());
975 std::shuffle(Start, End, Generator);
976#endif
977 std::sort(Start, End);
978}
979
980template <typename Container> inline void sort(Container &&C) {
981 llvm::sort(adl_begin(C), adl_end(C));
982}
983
984template <typename IteratorTy, typename Compare>
985inline void sort(IteratorTy Start, IteratorTy End, Compare Comp) {
986#ifdef EXPENSIVE_CHECKS
987 std::mt19937 Generator(std::random_device{}());
988 std::shuffle(Start, End, Generator);
989#endif
990 std::sort(Start, End, Comp);
991}
992
993template <typename Container, typename Compare>
994inline void sort(Container &&C, Compare Comp) {
995 llvm::sort(adl_begin(C), adl_end(C), Comp);
996}
997
998//===----------------------------------------------------------------------===//
999// Extra additions to <algorithm>
1000//===----------------------------------------------------------------------===//
1001
1002/// For a container of pointers, deletes the pointers and then clears the
1003/// container.
1004template<typename Container>
1005void DeleteContainerPointers(Container &C) {
1006 for (auto V : C)
1007 delete V;
1008 C.clear();
1009}
1010
1011/// In a container of pairs (usually a map) whose second element is a pointer,
1012/// deletes the second elements and then clears the container.
1013template<typename Container>
1014void DeleteContainerSeconds(Container &C) {
1015 for (auto &V : C)
1016 delete V.second;
1017 C.clear();
1018}
1019
1020/// Get the size of a range. This is a wrapper function around std::distance
1021/// which is only enabled when the operation is O(1).
1022template <typename R>
1023auto size(R &&Range, typename std::enable_if<
1024 std::is_same<typename std::iterator_traits<decltype(
1025 Range.begin())>::iterator_category,
1026 std::random_access_iterator_tag>::value,
1027 void>::type * = nullptr)
1028 -> decltype(std::distance(Range.begin(), Range.end())) {
1029 return std::distance(Range.begin(), Range.end());
1030}
1031
1032/// Provide wrappers to std::for_each which take ranges instead of having to
1033/// pass begin/end explicitly.
1034template <typename R, typename UnaryPredicate>
1035UnaryPredicate for_each(R &&Range, UnaryPredicate P) {
1036 return std::for_each(adl_begin(Range), adl_end(Range), P);
1037}
1038
1039/// Provide wrappers to std::all_of which take ranges instead of having to pass
1040/// begin/end explicitly.
1041template <typename R, typename UnaryPredicate>
1042bool all_of(R &&Range, UnaryPredicate P) {
1043 return std::all_of(adl_begin(Range), adl_end(Range), P);
1044}
1045
1046/// Provide wrappers to std::any_of which take ranges instead of having to pass
1047/// begin/end explicitly.
1048template <typename R, typename UnaryPredicate>
1049bool any_of(R &&Range, UnaryPredicate P) {
1050 return std::any_of(adl_begin(Range), adl_end(Range), P);
1051}
1052
1053/// Provide wrappers to std::none_of which take ranges instead of having to pass
1054/// begin/end explicitly.
1055template <typename R, typename UnaryPredicate>
1056bool none_of(R &&Range, UnaryPredicate P) {
1057 return std::none_of(adl_begin(Range), adl_end(Range), P);
1058}
1059
1060/// Provide wrappers to std::find which take ranges instead of having to pass
1061/// begin/end explicitly.
1062template <typename R, typename T>
1063auto find(R &&Range, const T &Val) -> decltype(adl_begin(Range)) {
1064 return std::find(adl_begin(Range), adl_end(Range), Val);
1065}
1066
1067/// Provide wrappers to std::find_if which take ranges instead of having to pass
1068/// begin/end explicitly.
1069template <typename R, typename UnaryPredicate>
1070auto find_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) {
1071 return std::find_if(adl_begin(Range), adl_end(Range), P);
1072}
1073
1074template <typename R, typename UnaryPredicate>
1075auto find_if_not(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) {
1076 return std::find_if_not(adl_begin(Range), adl_end(Range), P);
1077}
1078
1079/// Provide wrappers to std::remove_if which take ranges instead of having to
1080/// pass begin/end explicitly.
1081template <typename R, typename UnaryPredicate>
1082auto remove_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) {
1083 return std::remove_if(adl_begin(Range), adl_end(Range), P);
1084}
1085
1086/// Provide wrappers to std::copy_if which take ranges instead of having to
1087/// pass begin/end explicitly.
1088template <typename R, typename OutputIt, typename UnaryPredicate>
1089OutputIt copy_if(R &&Range, OutputIt Out, UnaryPredicate P) {
1090 return std::copy_if(adl_begin(Range), adl_end(Range), Out, P);
1091}
1092
1093template <typename R, typename OutputIt>
1094OutputIt copy(R &&Range, OutputIt Out) {
1095 return std::copy(adl_begin(Range), adl_end(Range), Out);
1096}
1097
1098/// Wrapper function around std::find to detect if an element exists
1099/// in a container.
1100template <typename R, typename E>
1101bool is_contained(R &&Range, const E &Element) {
1102 return std::find(adl_begin(Range), adl_end(Range), Element) != adl_end(Range);
1103}
1104
1105/// Wrapper function around std::count to count the number of times an element
1106/// \p Element occurs in the given range \p Range.
1107template <typename R, typename E>
1108auto count(R &&Range, const E &Element) ->
1109 typename std::iterator_traits<decltype(adl_begin(Range))>::difference_type {
1110 return std::count(adl_begin(Range), adl_end(Range), Element);
1111}
1112
1113/// Wrapper function around std::count_if to count the number of times an
1114/// element satisfying a given predicate occurs in a range.
1115template <typename R, typename UnaryPredicate>
1116auto count_if(R &&Range, UnaryPredicate P) ->
1117 typename std::iterator_traits<decltype(adl_begin(Range))>::difference_type {
1118 return std::count_if(adl_begin(Range), adl_end(Range), P);
1119}
1120
1121/// Wrapper function around std::transform to apply a function to a range and
1122/// store the result elsewhere.
1123template <typename R, typename OutputIt, typename UnaryPredicate>
1124OutputIt transform(R &&Range, OutputIt d_first, UnaryPredicate P) {
1125 return std::transform(adl_begin(Range), adl_end(Range), d_first, P);
1126}
1127
1128/// Provide wrappers to std::partition which take ranges instead of having to
1129/// pass begin/end explicitly.
1130template <typename R, typename UnaryPredicate>
1131auto partition(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) {
1132 return std::partition(adl_begin(Range), adl_end(Range), P);
1133}
1134
1135/// Provide wrappers to std::lower_bound which take ranges instead of having to
1136/// pass begin/end explicitly.
1137template <typename R, typename ForwardIt>
1138auto lower_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range)) {
1139 return std::lower_bound(adl_begin(Range), adl_end(Range), I);
1140}
1141
1142template <typename R, typename ForwardIt, typename Compare>
1143auto lower_bound(R &&Range, ForwardIt I, Compare C)
1144 -> decltype(adl_begin(Range)) {
1145 return std::lower_bound(adl_begin(Range), adl_end(Range), I, C);
1146}
1147
1148/// Provide wrappers to std::upper_bound which take ranges instead of having to
1149/// pass begin/end explicitly.
1150template <typename R, typename ForwardIt>
1151auto upper_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range)) {
1152 return std::upper_bound(adl_begin(Range), adl_end(Range), I);
1153}
1154
1155template <typename R, typename ForwardIt, typename Compare>
1156auto upper_bound(R &&Range, ForwardIt I, Compare C)
1157 -> decltype(adl_begin(Range)) {
1158 return std::upper_bound(adl_begin(Range), adl_end(Range), I, C);
1159}
1160/// Wrapper function around std::equal to detect if all elements
1161/// in a container are same.
1162template <typename R>
1163bool is_splat(R &&Range) {
1164 size_t range_size = size(Range);
1165 return range_size != 0 && (range_size == 1 ||
1166 std::equal(adl_begin(Range) + 1, adl_end(Range), adl_begin(Range)));
1167}
1168
1169/// Given a range of type R, iterate the entire range and return a
1170/// SmallVector with elements of the vector. This is useful, for example,
1171/// when you want to iterate a range and then sort the results.
1172template <unsigned Size, typename R>
1173SmallVector<typename std::remove_const<detail::ValueOfRange<R>>::type, Size>
1174to_vector(R &&Range) {
1175 return {adl_begin(Range), adl_end(Range)};
1176}
1177
1178/// Provide a container algorithm similar to C++ Library Fundamentals v2's
1179/// `erase_if` which is equivalent to:
1180///
1181/// C.erase(remove_if(C, pred), C.end());
1182///
1183/// This version works for any container with an erase method call accepting
1184/// two iterators.
1185template <typename Container, typename UnaryPredicate>
1186void erase_if(Container &C, UnaryPredicate P) {
1187 C.erase(remove_if(C, P), C.end());
1188}
1189
1190//===----------------------------------------------------------------------===//
1191// Extra additions to <memory>
1192//===----------------------------------------------------------------------===//
1193
1194// Implement make_unique according to N3656.
1195
1196/// Constructs a `new T()` with the given args and returns a
1197/// `unique_ptr<T>` which owns the object.
1198///
1199/// Example:
1200///
1201/// auto p = make_unique<int>();
1202/// auto p = make_unique<std::tuple<int, int>>(0, 1);
1203template <class T, class... Args>
1204typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
1205make_unique(Args &&... args) {
1206 return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
5
Memory is allocated
1207}
1208
1209/// Constructs a `new T[n]` with the given args and returns a
1210/// `unique_ptr<T[]>` which owns the object.
1211///
1212/// \param n size of the new array.
1213///
1214/// Example:
1215///
1216/// auto p = make_unique<int[]>(2); // value-initializes the array with 0's.
1217template <class T>
1218typename std::enable_if<std::is_array<T>::value && std::extent<T>::value == 0,
1219 std::unique_ptr<T>>::type
1220make_unique(size_t n) {
1221 return std::unique_ptr<T>(new typename std::remove_extent<T>::type[n]());
1222}
1223
1224/// This function isn't used and is only here to provide better compile errors.
1225template <class T, class... Args>
1226typename std::enable_if<std::extent<T>::value != 0>::type
1227make_unique(Args &&...) = delete;
1228
1229struct FreeDeleter {
1230 void operator()(void* v) {
1231 ::free(v);
1232 }
1233};
1234
1235template<typename First, typename Second>
1236struct pair_hash {
1237 size_t operator()(const std::pair<First, Second> &P) const {
1238 return std::hash<First>()(P.first) * 31 + std::hash<Second>()(P.second);
1239 }
1240};
1241
1242/// A functor like C++14's std::less<void> in its absence.
1243struct less {
1244 template <typename A, typename B> bool operator()(A &&a, B &&b) const {
1245 return std::forward<A>(a) < std::forward<B>(b);
1246 }
1247};
1248
1249/// A functor like C++14's std::equal<void> in its absence.
1250struct equal {
1251 template <typename A, typename B> bool operator()(A &&a, B &&b) const {
1252 return std::forward<A>(a) == std::forward<B>(b);
1253 }
1254};
1255
1256/// Binary functor that adapts to any other binary functor after dereferencing
1257/// operands.
1258template <typename T> struct deref {
1259 T func;
1260
1261 // Could be further improved to cope with non-derivable functors and
1262 // non-binary functors (should be a variadic template member function
1263 // operator()).
1264 template <typename A, typename B>
1265 auto operator()(A &lhs, B &rhs) const -> decltype(func(*lhs, *rhs)) {
1266 assert(lhs)((lhs) ? static_cast<void> (0) : __assert_fail ("lhs", "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 1266, __PRETTY_FUNCTION__))
;
1267 assert(rhs)((rhs) ? static_cast<void> (0) : __assert_fail ("rhs", "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 1267, __PRETTY_FUNCTION__))
;
1268 return func(*lhs, *rhs);
1269 }
1270};
1271
1272namespace detail {
1273
1274template <typename R> class enumerator_iter;
1275
1276template <typename R> struct result_pair {
1277 friend class enumerator_iter<R>;
1278
1279 result_pair() = default;
1280 result_pair(std::size_t Index, IterOfRange<R> Iter)
1281 : Index(Index), Iter(Iter) {}
1282
1283 result_pair<R> &operator=(const result_pair<R> &Other) {
1284 Index = Other.Index;
1285 Iter = Other.Iter;
1286 return *this;
1287 }
1288
1289 std::size_t index() const { return Index; }
1290 const ValueOfRange<R> &value() const { return *Iter; }
1291 ValueOfRange<R> &value() { return *Iter; }
1292
1293private:
1294 std::size_t Index = std::numeric_limits<std::size_t>::max();
1295 IterOfRange<R> Iter;
1296};
1297
1298template <typename R>
1299class enumerator_iter
1300 : public iterator_facade_base<
1301 enumerator_iter<R>, std::forward_iterator_tag, result_pair<R>,
1302 typename std::iterator_traits<IterOfRange<R>>::difference_type,
1303 typename std::iterator_traits<IterOfRange<R>>::pointer,
1304 typename std::iterator_traits<IterOfRange<R>>::reference> {
1305 using result_type = result_pair<R>;
1306
1307public:
1308 explicit enumerator_iter(IterOfRange<R> EndIter)
1309 : Result(std::numeric_limits<size_t>::max(), EndIter) {}
1310
1311 enumerator_iter(std::size_t Index, IterOfRange<R> Iter)
1312 : Result(Index, Iter) {}
1313
1314 result_type &operator*() { return Result; }
1315 const result_type &operator*() const { return Result; }
1316
1317 enumerator_iter<R> &operator++() {
1318 assert(Result.Index != std::numeric_limits<size_t>::max())((Result.Index != std::numeric_limits<size_t>::max()) ?
static_cast<void> (0) : __assert_fail ("Result.Index != std::numeric_limits<size_t>::max()"
, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h"
, 1318, __PRETTY_FUNCTION__))
;
1319 ++Result.Iter;
1320 ++Result.Index;
1321 return *this;
1322 }
1323
1324 bool operator==(const enumerator_iter<R> &RHS) const {
1325 // Don't compare indices here, only iterators. It's possible for an end
1326 // iterator to have different indices depending on whether it was created
1327 // by calling std::end() versus incrementing a valid iterator.
1328 return Result.Iter == RHS.Result.Iter;
1329 }
1330
1331 enumerator_iter<R> &operator=(const enumerator_iter<R> &Other) {
1332 Result = Other.Result;
1333 return *this;
1334 }
1335
1336private:
1337 result_type Result;
1338};
1339
1340template <typename R> class enumerator {
1341public:
1342 explicit enumerator(R &&Range) : TheRange(std::forward<R>(Range)) {}
1343
1344 enumerator_iter<R> begin() {
1345 return enumerator_iter<R>(0, std::begin(TheRange));
1346 }
1347
1348 enumerator_iter<R> end() {
1349 return enumerator_iter<R>(std::end(TheRange));
1350 }
1351
1352private:
1353 R TheRange;
1354};
1355
1356} // end namespace detail
1357
1358/// Given an input range, returns a new range whose values are are pair (A,B)
1359/// such that A is the 0-based index of the item in the sequence, and B is
1360/// the value from the original sequence. Example:
1361///
1362/// std::vector<char> Items = {'A', 'B', 'C', 'D'};
1363/// for (auto X : enumerate(Items)) {
1364/// printf("Item %d - %c\n", X.index(), X.value());
1365/// }
1366///
1367/// Output:
1368/// Item 0 - A
1369/// Item 1 - B
1370/// Item 2 - C
1371/// Item 3 - D
1372///
1373template <typename R> detail::enumerator<R> enumerate(R &&TheRange) {
1374 return detail::enumerator<R>(std::forward<R>(TheRange));
1375}
1376
1377namespace detail {
1378
1379template <typename F, typename Tuple, std::size_t... I>
1380auto apply_tuple_impl(F &&f, Tuple &&t, index_sequence<I...>)
1381 -> decltype(std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...)) {
1382 return std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...);
1383}
1384
1385} // end namespace detail
1386
1387/// Given an input tuple (a1, a2, ..., an), pass the arguments of the
1388/// tuple variadically to f as if by calling f(a1, a2, ..., an) and
1389/// return the result.
1390template <typename F, typename Tuple>
1391auto apply_tuple(F &&f, Tuple &&t) -> decltype(detail::apply_tuple_impl(
1392 std::forward<F>(f), std::forward<Tuple>(t),
1393 build_index_impl<
1394 std::tuple_size<typename std::decay<Tuple>::type>::value>{})) {
1395 using Indices = build_index_impl<
1396 std::tuple_size<typename std::decay<Tuple>::type>::value>;
1397
1398 return detail::apply_tuple_impl(std::forward<F>(f), std::forward<Tuple>(t),
1399 Indices{});
1400}
1401
1402} // end namespace llvm
1403
1404#endif // LLVM_ADT_STLEXTRAS_H