clang -cc1 -cc1 -triple amd64-unknown-openbsd7.0 -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 -setup-static-analyzer -mrelocation-model static -mframe-pointer=all -relaxed-aliasing -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -fcoverage-compilation-dir=/usr/src/gnu/usr.bin/clang/libLLVM/obj -resource-dir /usr/local/lib/clang/13.0.0 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Analysis -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ASMParser -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/BinaryFormat -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Bitcode -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Bitcode -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Bitstream -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /include/llvm/CodeGen -I /include/llvm/CodeGen/PBQP -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/IR -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/IR -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Coroutines -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ProfileData/Coverage -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/CodeView -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/DWARF -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/MSF -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/PDB -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Demangle -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ExecutionEngine -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ExecutionEngine/JITLink -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ExecutionEngine/Orc -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend/OpenACC -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend/OpenMP -I /include/llvm/CodeGen/GlobalISel -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/IRReader -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/InstCombine -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/Transforms/InstCombine -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/LTO -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Linker -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/MC -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/MC/MCParser -I /include/llvm/CodeGen/MIRParser -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Object -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Option -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Passes -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ProfileData -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Scalar -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ADT -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Support -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/Symbolize -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Target -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Utils -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Vectorize -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/IPO -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include -I /usr/src/gnu/usr.bin/clang/libLLVM/../include -I /usr/src/gnu/usr.bin/clang/libLLVM/obj -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include -D NDEBUG -D __STDC_LIMIT_MACROS -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D LLVM_PREFIX="/usr" -internal-isystem /usr/include/c++/v1 -internal-isystem /usr/local/lib/clang/13.0.0/include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir=/usr/src/gnu/usr.bin/clang/libLLVM/obj -ferror-limit 19 -fvisibility-inlines-hidden -fwrapv -stack-protector 2 -fno-rtti -fgnuc-version=4.2.1 -vectorize-loops -vectorize-slp -fno-builtin-malloc -fno-builtin-calloc -fno-builtin-realloc -fno-builtin-valloc -fno-builtin-free -fno-builtin-strdup -fno-builtin-strndup -analyzer-output=html -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /home/ben/Projects/vmm/scan-build/2022-01-12-194120-40624-1 -x c++ /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp
1 | |
2 | |
3 | |
4 | |
5 | |
6 | |
7 | |
8 | |
9 | |
10 | |
11 | |
12 | |
13 | #include "llvm/ExecutionEngine/RuntimeDyld.h" |
14 | #include "RuntimeDyldCOFF.h" |
15 | #include "RuntimeDyldELF.h" |
16 | #include "RuntimeDyldImpl.h" |
17 | #include "RuntimeDyldMachO.h" |
18 | #include "llvm/Object/COFF.h" |
19 | #include "llvm/Object/ELFObjectFile.h" |
20 | #include "llvm/Support/Alignment.h" |
21 | #include "llvm/Support/MSVCErrorWorkarounds.h" |
22 | #include "llvm/Support/ManagedStatic.h" |
23 | #include "llvm/Support/MathExtras.h" |
24 | #include <mutex> |
25 | |
26 | #include <future> |
27 | |
28 | using namespace llvm; |
29 | using namespace llvm::object; |
30 | |
31 | #define DEBUG_TYPE "dyld" |
32 | |
33 | namespace { |
34 | |
35 | enum RuntimeDyldErrorCode { |
36 | GenericRTDyldError = 1 |
37 | }; |
38 | |
39 | |
40 | |
41 | |
42 | class RuntimeDyldErrorCategory : public std::error_category { |
43 | public: |
44 | const char *name() const noexcept override { return "runtimedyld"; } |
45 | |
46 | std::string message(int Condition) const override { |
47 | switch (static_cast<RuntimeDyldErrorCode>(Condition)) { |
48 | case GenericRTDyldError: return "Generic RuntimeDyld error"; |
49 | } |
50 | llvm_unreachable("Unrecognized RuntimeDyldErrorCode"); |
51 | } |
52 | }; |
53 | |
54 | static ManagedStatic<RuntimeDyldErrorCategory> RTDyldErrorCategory; |
55 | |
56 | } |
57 | |
58 | char RuntimeDyldError::ID = 0; |
59 | |
60 | void RuntimeDyldError::log(raw_ostream &OS) const { |
61 | OS << ErrMsg << "\n"; |
62 | } |
63 | |
64 | std::error_code RuntimeDyldError::convertToErrorCode() const { |
65 | return std::error_code(GenericRTDyldError, *RTDyldErrorCategory); |
66 | } |
67 | |
68 | |
69 | RuntimeDyldImpl::~RuntimeDyldImpl() {} |
70 | |
71 | |
72 | void RuntimeDyld::LoadedObjectInfo::anchor() {} |
73 | |
74 | namespace llvm { |
75 | |
76 | void RuntimeDyldImpl::registerEHFrames() {} |
77 | |
78 | void RuntimeDyldImpl::deregisterEHFrames() { |
79 | MemMgr.deregisterEHFrames(); |
80 | } |
81 | |
82 | #ifndef NDEBUG |
83 | static void dumpSectionMemory(const SectionEntry &S, StringRef State) { |
84 | dbgs() << "----- Contents of section " << S.getName() << " " << State |
85 | << " -----"; |
86 | |
87 | if (S.getAddress() == nullptr) { |
88 | dbgs() << "\n <section not emitted>\n"; |
89 | return; |
90 | } |
91 | |
92 | const unsigned ColsPerRow = 16; |
93 | |
94 | uint8_t *DataAddr = S.getAddress(); |
95 | uint64_t LoadAddr = S.getLoadAddress(); |
96 | |
97 | unsigned StartPadding = LoadAddr & (ColsPerRow - 1); |
98 | unsigned BytesRemaining = S.getSize(); |
99 | |
100 | if (StartPadding) { |
101 | dbgs() << "\n" << format("0x%016" PRIx64, |
102 | LoadAddr & ~(uint64_t)(ColsPerRow - 1)) << ":"; |
103 | while (StartPadding--) |
104 | dbgs() << " "; |
105 | } |
106 | |
107 | while (BytesRemaining > 0) { |
108 | if ((LoadAddr & (ColsPerRow - 1)) == 0) |
109 | dbgs() << "\n" << format("0x%016" PRIx64, LoadAddr) << ":"; |
110 | |
111 | dbgs() << " " << format("%02x", *DataAddr); |
112 | |
113 | ++DataAddr; |
114 | ++LoadAddr; |
115 | --BytesRemaining; |
116 | } |
117 | |
118 | dbgs() << "\n"; |
119 | } |
120 | #endif |
121 | |
122 | |
123 | void RuntimeDyldImpl::resolveRelocations() { |
124 | std::lock_guard<sys::Mutex> locked(lock); |
125 | |
126 | |
127 | LLVM_DEBUG(for (int i = 0, e = Sections.size(); i != e; ++i) |
128 | dumpSectionMemory(Sections[i], "before relocations");); |
129 | |
130 | |
131 | if (auto Err = resolveExternalSymbols()) { |
132 | HasError = true; |
133 | ErrorStr = toString(std::move(Err)); |
134 | } |
135 | |
136 | resolveLocalRelocations(); |
137 | |
138 | |
139 | LLVM_DEBUG(for (int i = 0, e = Sections.size(); i != e; ++i) |
140 | dumpSectionMemory(Sections[i], "after relocations");); |
141 | } |
142 | |
143 | void RuntimeDyldImpl::resolveLocalRelocations() { |
144 | |
145 | for (auto it = Relocations.begin(), e = Relocations.end(); it != e; ++it) { |
146 | |
147 | |
148 | |
149 | unsigned Idx = it->first; |
150 | uint64_t Addr = getSectionLoadAddress(Idx); |
151 | LLVM_DEBUG(dbgs() << "Resolving relocations Section #" << Idx << "\t" |
152 | << format("%p", (uintptr_t)Addr) << "\n"); |
153 | resolveRelocationList(it->second, Addr); |
154 | } |
155 | Relocations.clear(); |
156 | } |
157 | |
158 | void RuntimeDyldImpl::mapSectionAddress(const void *LocalAddress, |
159 | uint64_t TargetAddress) { |
160 | std::lock_guard<sys::Mutex> locked(lock); |
161 | for (unsigned i = 0, e = Sections.size(); i != e; ++i) { |
162 | if (Sections[i].getAddress() == LocalAddress) { |
163 | reassignSectionAddress(i, TargetAddress); |
164 | return; |
165 | } |
166 | } |
167 | llvm_unreachable("Attempting to remap address of unknown section!"); |
168 | } |
169 | |
170 | static Error getOffset(const SymbolRef &Sym, SectionRef Sec, |
171 | uint64_t &Result) { |
172 | Expected<uint64_t> AddressOrErr = Sym.getAddress(); |
173 | if (!AddressOrErr) |
| |
174 | return AddressOrErr.takeError(); |
| 57 | | Returning without writing to 'Result' | |
|
175 | Result = *AddressOrErr - Sec.getAddress(); |
176 | return Error::success(); |
177 | } |
178 | |
179 | Expected<RuntimeDyldImpl::ObjSectionToIDMap> |
180 | RuntimeDyldImpl::loadObjectImpl(const object::ObjectFile &Obj) { |
181 | std::lock_guard<sys::Mutex> locked(lock); |
182 | |
183 | |
184 | Arch = (Triple::ArchType)Obj.getArch(); |
185 | IsTargetLittleEndian = Obj.isLittleEndian(); |
186 | setMipsABI(Obj); |
187 | |
188 | |
189 | |
190 | if (MemMgr.needsToReserveAllocationSpace()) { |
| 1 | Assuming the condition is false | |
|
| |
191 | uint64_t CodeSize = 0, RODataSize = 0, RWDataSize = 0; |
192 | uint32_t CodeAlign = 1, RODataAlign = 1, RWDataAlign = 1; |
193 | if (auto Err = computeTotalAllocSize(Obj, |
194 | CodeSize, CodeAlign, |
195 | RODataSize, RODataAlign, |
196 | RWDataSize, RWDataAlign)) |
197 | return std::move(Err); |
198 | MemMgr.reserveAllocationSpace(CodeSize, CodeAlign, RODataSize, RODataAlign, |
199 | RWDataSize, RWDataAlign); |
200 | } |
201 | |
202 | |
203 | ObjSectionToIDMap LocalSections; |
204 | |
205 | |
206 | CommonSymbolList CommonSymbolsToAllocate; |
207 | |
208 | uint64_t CommonSize = 0; |
209 | uint32_t CommonAlign = 0; |
210 | |
211 | |
212 | |
213 | JITSymbolResolver::LookupSet ResponsibilitySet; |
214 | { |
215 | JITSymbolResolver::LookupSet Symbols; |
216 | for (auto &Sym : Obj.symbols()) { |
217 | Expected<uint32_t> FlagsOrErr = Sym.getFlags(); |
218 | if (!FlagsOrErr) |
219 | |
220 | return FlagsOrErr.takeError(); |
221 | if ((*FlagsOrErr & SymbolRef::SF_Common) || |
222 | (*FlagsOrErr & SymbolRef::SF_Weak)) { |
223 | |
224 | if (auto NameOrErr = Sym.getName()) |
225 | Symbols.insert(*NameOrErr); |
226 | else |
227 | return NameOrErr.takeError(); |
228 | } |
229 | } |
230 | |
231 | if (auto ResultOrErr = Resolver.getResponsibilitySet(Symbols)) |
| 3 | | Calling 'Expected::operator bool' | |
|
| 6 | | Returning from 'Expected::operator bool' | |
|
| |
232 | ResponsibilitySet = std::move(*ResultOrErr); |
233 | else |
234 | return ResultOrErr.takeError(); |
235 | } |
236 | |
237 | |
238 | LLVM_DEBUG(dbgs() << "Parse symbols:\n"); |
| 8 | | Loop condition is false. Exiting loop | |
|
239 | for (symbol_iterator I = Obj.symbol_begin(), E = Obj.symbol_end(); I != E; |
| 9 | | Loop condition is true. Entering loop body | |
|
240 | ++I) { |
241 | Expected<uint32_t> FlagsOrErr = I->getFlags(); |
242 | if (!FlagsOrErr) |
| 10 | | Calling 'Expected::operator bool' | |
|
| 13 | | Returning from 'Expected::operator bool' | |
|
| |
243 | |
244 | return FlagsOrErr.takeError(); |
245 | |
246 | |
247 | if (*FlagsOrErr & SymbolRef::SF_Undefined) |
| 15 | | Assuming the condition is false | |
|
| |
248 | continue; |
249 | |
250 | |
251 | object::SymbolRef::Type SymType; |
252 | if (auto SymTypeOrErr = I->getType()) |
| 17 | | Calling 'Expected::operator bool' | |
|
| 20 | | Returning from 'Expected::operator bool' | |
|
| |
253 | SymType = *SymTypeOrErr; |
254 | else |
255 | return SymTypeOrErr.takeError(); |
256 | |
257 | |
258 | StringRef Name; |
259 | if (auto NameOrErr = I->getName()) |
| 22 | | Calling 'Expected::operator bool' | |
|
| 25 | | Returning from 'Expected::operator bool' | |
|
| |
260 | Name = *NameOrErr; |
261 | else |
262 | return NameOrErr.takeError(); |
263 | |
264 | |
265 | auto JITSymFlags = getJITSymbolFlags(*I); |
266 | if (!JITSymFlags) |
| 27 | | Calling 'Expected::operator bool' | |
|
| 30 | | Returning from 'Expected::operator bool' | |
|
| |
267 | return JITSymFlags.takeError(); |
268 | |
269 | |
270 | |
271 | |
272 | |
273 | if (JITSymFlags->isWeak() || JITSymFlags->isCommon()) { |
| 32 | | Calling 'JITSymbolFlags::isWeak' | |
|
| 35 | | Returning from 'JITSymbolFlags::isWeak' | |
|
| 36 | | Calling 'JITSymbolFlags::isCommon' | |
|
| 39 | | Returning from 'JITSymbolFlags::isCommon' | |
|
| |
274 | |
275 | if (GlobalSymbolTable.count(Name)) |
276 | continue; |
277 | |
278 | |
279 | if (!ResponsibilitySet.count(Name)) |
280 | continue; |
281 | |
282 | |
283 | |
284 | if (JITSymFlags->isWeak()) |
285 | *JITSymFlags &= ~JITSymbolFlags::Weak; |
286 | if (JITSymFlags->isCommon()) { |
287 | *JITSymFlags &= ~JITSymbolFlags::Common; |
288 | uint32_t Align = I->getAlignment(); |
289 | uint64_t Size = I->getCommonSize(); |
290 | if (!CommonAlign) |
291 | CommonAlign = Align; |
292 | CommonSize = alignTo(CommonSize, Align) + Size; |
293 | CommonSymbolsToAllocate.push_back(*I); |
294 | } |
295 | } |
296 | |
297 | if (*FlagsOrErr & SymbolRef::SF_Absolute && |
| 41 | | Assuming the condition is false | |
|
298 | SymType != object::SymbolRef::ST_File) { |
299 | uint64_t Addr = 0; |
300 | if (auto AddrOrErr = I->getAddress()) |
301 | Addr = *AddrOrErr; |
302 | else |
303 | return AddrOrErr.takeError(); |
304 | |
305 | unsigned SectionID = AbsoluteSymbolSection; |
306 | |
307 | LLVM_DEBUG(dbgs() << "\tType: " << SymType << " (absolute) Name: " << Name |
308 | << " SID: " << SectionID |
309 | << " Offset: " << format("%p", (uintptr_t)Addr) |
310 | << " flags: " << *FlagsOrErr << "\n"); |
311 | if (!Name.empty()) |
312 | GlobalSymbolTable[Name] = |
313 | SymbolTableEntry(SectionID, Addr, *JITSymFlags); |
314 | } else if (SymType == object::SymbolRef::ST_Function || |
| 42 | | Assuming 'SymType' is not equal to ST_Function | |
|
| |
315 | SymType == object::SymbolRef::ST_Data || |
| 43 | | Assuming 'SymType' is not equal to ST_Data | |
|
316 | SymType == object::SymbolRef::ST_Unknown || |
| 44 | | Assuming 'SymType' is not equal to ST_Unknown | |
|
317 | SymType == object::SymbolRef::ST_Other) { |
| 45 | | Assuming 'SymType' is equal to ST_Other | |
|
318 | |
319 | section_iterator SI = Obj.section_end(); |
320 | if (auto SIOrErr = I->getSection()) |
| 47 | | Calling 'Expected::operator bool' | |
|
| 50 | | Returning from 'Expected::operator bool' | |
|
| |
321 | SI = *SIOrErr; |
322 | else |
323 | return SIOrErr.takeError(); |
324 | |
325 | if (SI == Obj.section_end()) |
| 52 | | Assuming the condition is false | |
|
| |
326 | continue; |
327 | |
328 | |
329 | uint64_t SectOffset; |
| 54 | | 'SectOffset' declared without an initial value | |
|
330 | if (auto Err = getOffset(*I, *SI, SectOffset)) |
| |
| 58 | | Returning from 'getOffset' | |
|
| 59 | | Calling 'Error::operator bool' | |
|
| 62 | | Returning from 'Error::operator bool' | |
|
| |
331 | return std::move(Err); |
332 | |
333 | bool IsCode = SI->isText(); |
334 | unsigned SectionID; |
335 | if (auto SectionIDOrErr = |
| 64 | | Calling 'Expected::operator bool' | |
|
| 66 | | Returning from 'Expected::operator bool' | |
|
| |
336 | findOrEmitSection(Obj, *SI, IsCode, LocalSections)) |
337 | SectionID = *SectionIDOrErr; |
338 | else |
339 | return SectionIDOrErr.takeError(); |
340 | |
341 | LLVM_DEBUG(dbgs() << "\tType: " << SymType << " Name: " << Name |
| 68 | | Loop condition is false. Exiting loop | |
|
342 | << " SID: " << SectionID |
343 | << " Offset: " << format("%p", (uintptr_t)SectOffset) |
344 | << " flags: " << *FlagsOrErr << "\n"); |
345 | if (!Name.empty()) |
| 69 | | Assuming the condition is true | |
|
| |
346 | GlobalSymbolTable[Name] = |
347 | SymbolTableEntry(SectionID, SectOffset, *JITSymFlags); |
| 71 | | 2nd function call argument is an uninitialized value |
|
348 | } |
349 | } |
350 | |
351 | |
352 | if (auto Err = emitCommonSymbols(Obj, CommonSymbolsToAllocate, CommonSize, |
353 | CommonAlign)) |
354 | return std::move(Err); |
355 | |
356 | |
357 | LLVM_DEBUG(dbgs() << "Parse relocations:\n"); |
358 | for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end(); |
359 | SI != SE; ++SI) { |
360 | StubMap Stubs; |
361 | |
362 | Expected<section_iterator> RelSecOrErr = SI->getRelocatedSection(); |
363 | if (!RelSecOrErr) |
364 | return RelSecOrErr.takeError(); |
365 | |
366 | section_iterator RelocatedSection = *RelSecOrErr; |
367 | if (RelocatedSection == SE) |
368 | continue; |
369 | |
370 | relocation_iterator I = SI->relocation_begin(); |
371 | relocation_iterator E = SI->relocation_end(); |
372 | |
373 | if (I == E && !ProcessAllSections) |
374 | continue; |
375 | |
376 | bool IsCode = RelocatedSection->isText(); |
377 | unsigned SectionID = 0; |
378 | if (auto SectionIDOrErr = findOrEmitSection(Obj, *RelocatedSection, IsCode, |
379 | LocalSections)) |
380 | SectionID = *SectionIDOrErr; |
381 | else |
382 | return SectionIDOrErr.takeError(); |
383 | |
384 | LLVM_DEBUG(dbgs() << "\tSectionID: " << SectionID << "\n"); |
385 | |
386 | for (; I != E;) |
387 | if (auto IOrErr = processRelocationRef(SectionID, I, Obj, LocalSections, Stubs)) |
388 | I = *IOrErr; |
389 | else |
390 | return IOrErr.takeError(); |
391 | |
392 | |
393 | |
394 | if (NotifyStubEmitted) { |
395 | StringRef FileName = Obj.getFileName(); |
396 | StringRef SectionName = Sections[SectionID].getName(); |
397 | for (auto &KV : Stubs) { |
398 | |
399 | auto &VR = KV.first; |
400 | uint64_t StubAddr = KV.second; |
401 | |
402 | |
403 | if (VR.SymbolName) { |
404 | NotifyStubEmitted(FileName, SectionName, VR.SymbolName, SectionID, |
405 | StubAddr); |
406 | continue; |
407 | } |
408 | |
409 | |
410 | for (auto &GSTMapEntry : GlobalSymbolTable) { |
411 | StringRef SymbolName = GSTMapEntry.first(); |
412 | auto &GSTEntry = GSTMapEntry.second; |
413 | if (GSTEntry.getSectionID() == VR.SectionID && |
414 | GSTEntry.getOffset() == VR.Offset) { |
415 | NotifyStubEmitted(FileName, SectionName, SymbolName, SectionID, |
416 | StubAddr); |
417 | break; |
418 | } |
419 | } |
420 | } |
421 | } |
422 | } |
423 | |
424 | |
425 | if (ProcessAllSections) { |
426 | LLVM_DEBUG(dbgs() << "Process remaining sections:\n"); |
427 | for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end(); |
428 | SI != SE; ++SI) { |
429 | |
430 | |
431 | if (LocalSections.find(*SI) != LocalSections.end()) |
432 | continue; |
433 | |
434 | bool IsCode = SI->isText(); |
435 | if (auto SectionIDOrErr = |
436 | findOrEmitSection(Obj, *SI, IsCode, LocalSections)) |
437 | LLVM_DEBUG(dbgs() << "\tSectionID: " << (*SectionIDOrErr) << "\n"); |
438 | else |
439 | return SectionIDOrErr.takeError(); |
440 | } |
441 | } |
442 | |
443 | |
444 | if (auto Err = finalizeLoad(Obj, LocalSections)) |
445 | return std::move(Err); |
446 | |
447 | |
448 | |
449 | |
450 | return LocalSections; |
451 | } |
452 | |
453 | |
454 | |
455 | |
456 | static uint64_t |
457 | computeAllocationSizeForSections(std::vector<uint64_t> &SectionSizes, |
458 | uint64_t Alignment) { |
459 | uint64_t TotalSize = 0; |
460 | for (size_t Idx = 0, Cnt = SectionSizes.size(); Idx < Cnt; Idx++) { |
461 | uint64_t AlignedSize = |
462 | (SectionSizes[Idx] + Alignment - 1) / Alignment * Alignment; |
463 | TotalSize += AlignedSize; |
464 | } |
465 | return TotalSize; |
466 | } |
467 | |
468 | static bool isRequiredForExecution(const SectionRef Section) { |
469 | const ObjectFile *Obj = Section.getObject(); |
470 | if (isa<object::ELFObjectFileBase>(Obj)) |
471 | return ELFSectionRef(Section).getFlags() & ELF::SHF_ALLOC; |
472 | if (auto *COFFObj = dyn_cast<object::COFFObjectFile>(Obj)) { |
473 | const coff_section *CoffSection = COFFObj->getCOFFSection(Section); |
474 | |
475 | |
476 | |
477 | |
478 | |
479 | bool HasContent = |
480 | (CoffSection->VirtualSize > 0) || (CoffSection->SizeOfRawData > 0); |
481 | bool IsDiscardable = |
482 | CoffSection->Characteristics & |
483 | (COFF::IMAGE_SCN_MEM_DISCARDABLE | COFF::IMAGE_SCN_LNK_INFO); |
484 | return HasContent && !IsDiscardable; |
485 | } |
486 | |
487 | assert(isa<MachOObjectFile>(Obj)); |
488 | return true; |
489 | } |
490 | |
491 | static bool isReadOnlyData(const SectionRef Section) { |
492 | const ObjectFile *Obj = Section.getObject(); |
493 | if (isa<object::ELFObjectFileBase>(Obj)) |
494 | return !(ELFSectionRef(Section).getFlags() & |
495 | (ELF::SHF_WRITE | ELF::SHF_EXECINSTR)); |
496 | if (auto *COFFObj = dyn_cast<object::COFFObjectFile>(Obj)) |
497 | return ((COFFObj->getCOFFSection(Section)->Characteristics & |
498 | (COFF::IMAGE_SCN_CNT_INITIALIZED_DATA |
499 | | COFF::IMAGE_SCN_MEM_READ |
500 | | COFF::IMAGE_SCN_MEM_WRITE)) |
501 | == |
502 | (COFF::IMAGE_SCN_CNT_INITIALIZED_DATA |
503 | | COFF::IMAGE_SCN_MEM_READ)); |
504 | |
505 | assert(isa<MachOObjectFile>(Obj)); |
506 | return false; |
507 | } |
508 | |
509 | static bool isZeroInit(const SectionRef Section) { |
510 | const ObjectFile *Obj = Section.getObject(); |
511 | if (isa<object::ELFObjectFileBase>(Obj)) |
512 | return ELFSectionRef(Section).getType() == ELF::SHT_NOBITS; |
513 | if (auto *COFFObj = dyn_cast<object::COFFObjectFile>(Obj)) |
514 | return COFFObj->getCOFFSection(Section)->Characteristics & |
515 | COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA; |
516 | |
517 | auto *MachO = cast<MachOObjectFile>(Obj); |
518 | unsigned SectionType = MachO->getSectionType(Section); |
519 | return SectionType == MachO::S_ZEROFILL || |
520 | SectionType == MachO::S_GB_ZEROFILL; |
521 | } |
522 | |
523 | |
524 | |
525 | Error RuntimeDyldImpl::computeTotalAllocSize(const ObjectFile &Obj, |
526 | uint64_t &CodeSize, |
527 | uint32_t &CodeAlign, |
528 | uint64_t &RODataSize, |
529 | uint32_t &RODataAlign, |
530 | uint64_t &RWDataSize, |
531 | uint32_t &RWDataAlign) { |
532 | |
533 | std::vector<uint64_t> CodeSectionSizes; |
534 | std::vector<uint64_t> ROSectionSizes; |
535 | std::vector<uint64_t> RWSectionSizes; |
536 | |
537 | |
538 | |
539 | for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end(); |
540 | SI != SE; ++SI) { |
541 | const SectionRef &Section = *SI; |
542 | |
543 | bool IsRequired = isRequiredForExecution(Section) || ProcessAllSections; |
544 | |
545 | |
546 | if (IsRequired) { |
547 | uint64_t DataSize = Section.getSize(); |
548 | uint64_t Alignment64 = Section.getAlignment(); |
549 | unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL; |
550 | bool IsCode = Section.isText(); |
551 | bool IsReadOnly = isReadOnlyData(Section); |
552 | |
553 | Expected<StringRef> NameOrErr = Section.getName(); |
554 | if (!NameOrErr) |
555 | return NameOrErr.takeError(); |
556 | StringRef Name = *NameOrErr; |
557 | |
558 | uint64_t StubBufSize = computeSectionStubBufSize(Obj, Section); |
559 | |
560 | uint64_t PaddingSize = 0; |
561 | if (Name == ".eh_frame") |
562 | PaddingSize += 4; |
563 | if (StubBufSize != 0) |
564 | PaddingSize += getStubAlignment() - 1; |
565 | |
566 | uint64_t SectionSize = DataSize + PaddingSize + StubBufSize; |
567 | |
568 | |
569 | |
570 | |
571 | |
572 | |
573 | if (Name == ".eh_frame") |
574 | SectionSize += 4; |
575 | |
576 | if (!SectionSize) |
577 | SectionSize = 1; |
578 | |
579 | if (IsCode) { |
580 | CodeAlign = std::max(CodeAlign, Alignment); |
581 | CodeSectionSizes.push_back(SectionSize); |
582 | } else if (IsReadOnly) { |
583 | RODataAlign = std::max(RODataAlign, Alignment); |
584 | ROSectionSizes.push_back(SectionSize); |
585 | } else { |
586 | RWDataAlign = std::max(RWDataAlign, Alignment); |
587 | RWSectionSizes.push_back(SectionSize); |
588 | } |
589 | } |
590 | } |
591 | |
592 | |
593 | |
594 | |
595 | if (unsigned GotSize = computeGOTSize(Obj)) { |
596 | RWSectionSizes.push_back(GotSize); |
597 | RWDataAlign = std::max<uint32_t>(RWDataAlign, getGOTEntrySize()); |
598 | } |
599 | |
600 | |
601 | uint64_t CommonSize = 0; |
602 | uint32_t CommonAlign = 1; |
603 | for (symbol_iterator I = Obj.symbol_begin(), E = Obj.symbol_end(); I != E; |
604 | ++I) { |
605 | Expected<uint32_t> FlagsOrErr = I->getFlags(); |
606 | if (!FlagsOrErr) |
607 | |
608 | return FlagsOrErr.takeError(); |
609 | if (*FlagsOrErr & SymbolRef::SF_Common) { |
610 | |
611 | uint64_t Size = I->getCommonSize(); |
612 | uint32_t Align = I->getAlignment(); |
613 | |
614 | |
615 | if (CommonSize == 0) |
616 | CommonAlign = Align; |
617 | CommonSize = alignTo(CommonSize, Align) + Size; |
618 | } |
619 | } |
620 | if (CommonSize != 0) { |
621 | RWSectionSizes.push_back(CommonSize); |
622 | RWDataAlign = std::max(RWDataAlign, CommonAlign); |
623 | } |
624 | |
625 | |
626 | |
627 | |
628 | |
629 | |
630 | CodeSize = computeAllocationSizeForSections(CodeSectionSizes, CodeAlign); |
631 | RODataSize = computeAllocationSizeForSections(ROSectionSizes, RODataAlign); |
632 | RWDataSize = computeAllocationSizeForSections(RWSectionSizes, RWDataAlign); |
633 | |
634 | return Error::success(); |
635 | } |
636 | |
637 | |
638 | unsigned RuntimeDyldImpl::computeGOTSize(const ObjectFile &Obj) { |
639 | size_t GotEntrySize = getGOTEntrySize(); |
640 | if (!GotEntrySize) |
641 | return 0; |
642 | |
643 | size_t GotSize = 0; |
644 | for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end(); |
645 | SI != SE; ++SI) { |
646 | |
647 | for (const RelocationRef &Reloc : SI->relocations()) |
648 | if (relocationNeedsGot(Reloc)) |
649 | GotSize += GotEntrySize; |
650 | } |
651 | |
652 | return GotSize; |
653 | } |
654 | |
655 | |
656 | unsigned RuntimeDyldImpl::computeSectionStubBufSize(const ObjectFile &Obj, |
657 | const SectionRef &Section) { |
658 | if (!MemMgr.allowStubAllocation()) { |
659 | return 0; |
660 | } |
661 | |
662 | unsigned StubSize = getMaxStubSize(); |
663 | if (StubSize == 0) { |
664 | return 0; |
665 | } |
666 | |
667 | |
668 | |
669 | unsigned StubBufSize = 0; |
670 | for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end(); |
671 | SI != SE; ++SI) { |
672 | |
673 | Expected<section_iterator> RelSecOrErr = SI->getRelocatedSection(); |
674 | if (!RelSecOrErr) |
675 | report_fatal_error(toString(RelSecOrErr.takeError())); |
676 | |
677 | section_iterator RelSecI = *RelSecOrErr; |
678 | if (!(RelSecI == Section)) |
679 | continue; |
680 | |
681 | for (const RelocationRef &Reloc : SI->relocations()) |
682 | if (relocationNeedsStub(Reloc)) |
683 | StubBufSize += StubSize; |
684 | } |
685 | |
686 | |
687 | uint64_t DataSize = Section.getSize(); |
688 | uint64_t Alignment64 = Section.getAlignment(); |
689 | |
690 | |
691 | unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL; |
692 | unsigned StubAlignment = getStubAlignment(); |
693 | unsigned EndAlignment = (DataSize | Alignment) & -(DataSize | Alignment); |
694 | if (StubAlignment > EndAlignment) |
695 | StubBufSize += StubAlignment - EndAlignment; |
696 | return StubBufSize; |
697 | } |
698 | |
699 | uint64_t RuntimeDyldImpl::readBytesUnaligned(uint8_t *Src, |
700 | unsigned Size) const { |
701 | uint64_t Result = 0; |
702 | if (IsTargetLittleEndian) { |
703 | Src += Size - 1; |
704 | while (Size--) |
705 | Result = (Result << 8) | *Src--; |
706 | } else |
707 | while (Size--) |
708 | Result = (Result << 8) | *Src++; |
709 | |
710 | return Result; |
711 | } |
712 | |
713 | void RuntimeDyldImpl::writeBytesUnaligned(uint64_t Value, uint8_t *Dst, |
714 | unsigned Size) const { |
715 | if (IsTargetLittleEndian) { |
716 | while (Size--) { |
717 | *Dst++ = Value & 0xFF; |
718 | Value >>= 8; |
719 | } |
720 | } else { |
721 | Dst += Size - 1; |
722 | while (Size--) { |
723 | *Dst-- = Value & 0xFF; |
724 | Value >>= 8; |
725 | } |
726 | } |
727 | } |
728 | |
729 | Expected<JITSymbolFlags> |
730 | RuntimeDyldImpl::getJITSymbolFlags(const SymbolRef &SR) { |
731 | return JITSymbolFlags::fromObjectSymbol(SR); |
732 | } |
733 | |
734 | Error RuntimeDyldImpl::emitCommonSymbols(const ObjectFile &Obj, |
735 | CommonSymbolList &SymbolsToAllocate, |
736 | uint64_t CommonSize, |
737 | uint32_t CommonAlign) { |
738 | if (SymbolsToAllocate.empty()) |
739 | return Error::success(); |
740 | |
741 | |
742 | unsigned SectionID = Sections.size(); |
743 | uint8_t *Addr = MemMgr.allocateDataSection(CommonSize, CommonAlign, SectionID, |
744 | "<common symbols>", false); |
745 | if (!Addr) |
746 | report_fatal_error("Unable to allocate memory for common symbols!"); |
747 | uint64_t Offset = 0; |
748 | Sections.push_back( |
749 | SectionEntry("<common symbols>", Addr, CommonSize, CommonSize, 0)); |
750 | memset(Addr, 0, CommonSize); |
751 | |
752 | LLVM_DEBUG(dbgs() << "emitCommonSection SectionID: " << SectionID |
753 | << " new addr: " << format("%p", Addr) |
754 | << " DataSize: " << CommonSize << "\n"); |
755 | |
756 | |
757 | for (auto &Sym : SymbolsToAllocate) { |
758 | uint32_t Alignment = Sym.getAlignment(); |
759 | uint64_t Size = Sym.getCommonSize(); |
760 | StringRef Name; |
761 | if (auto NameOrErr = Sym.getName()) |
762 | Name = *NameOrErr; |
763 | else |
764 | return NameOrErr.takeError(); |
765 | if (Alignment) { |
766 | |
767 | uint64_t AlignOffset = |
768 | offsetToAlignment((uint64_t)Addr, Align(Alignment)); |
769 | Addr += AlignOffset; |
770 | Offset += AlignOffset; |
771 | } |
772 | auto JITSymFlags = getJITSymbolFlags(Sym); |
773 | |
774 | if (!JITSymFlags) |
775 | return JITSymFlags.takeError(); |
776 | |
777 | LLVM_DEBUG(dbgs() << "Allocating common symbol " << Name << " address " |
778 | << format("%p", Addr) << "\n"); |
779 | if (!Name.empty()) |
780 | GlobalSymbolTable[Name] = |
781 | SymbolTableEntry(SectionID, Offset, std::move(*JITSymFlags)); |
782 | Offset += Size; |
783 | Addr += Size; |
784 | } |
785 | |
786 | return Error::success(); |
787 | } |
788 | |
789 | Expected<unsigned> |
790 | RuntimeDyldImpl::emitSection(const ObjectFile &Obj, |
791 | const SectionRef &Section, |
792 | bool IsCode) { |
793 | StringRef data; |
794 | uint64_t Alignment64 = Section.getAlignment(); |
795 | |
796 | unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL; |
797 | unsigned PaddingSize = 0; |
798 | unsigned StubBufSize = 0; |
799 | bool IsRequired = isRequiredForExecution(Section); |
800 | bool IsVirtual = Section.isVirtual(); |
801 | bool IsZeroInit = isZeroInit(Section); |
802 | bool IsReadOnly = isReadOnlyData(Section); |
803 | uint64_t DataSize = Section.getSize(); |
804 | |
805 | |
806 | |
807 | |
808 | Alignment = std::max(1u, Alignment); |
809 | |
810 | Expected<StringRef> NameOrErr = Section.getName(); |
811 | if (!NameOrErr) |
812 | return NameOrErr.takeError(); |
813 | StringRef Name = *NameOrErr; |
814 | |
815 | StubBufSize = computeSectionStubBufSize(Obj, Section); |
816 | |
817 | |
818 | |
819 | |
820 | if (Name == ".eh_frame") |
821 | PaddingSize = 4; |
822 | |
823 | uintptr_t Allocate; |
824 | unsigned SectionID = Sections.size(); |
825 | uint8_t *Addr; |
826 | const char *pData = nullptr; |
827 | |
828 | |
829 | |
830 | if (!IsVirtual && !IsZeroInit) { |
831 | |
832 | |
833 | if (Expected<StringRef> E = Section.getContents()) |
834 | data = *E; |
835 | else |
836 | return E.takeError(); |
837 | pData = data.data(); |
838 | } |
839 | |
840 | |
841 | |
842 | |
843 | if (StubBufSize != 0) { |
844 | Alignment = std::max(Alignment, getStubAlignment()); |
845 | PaddingSize += getStubAlignment() - 1; |
846 | } |
847 | |
848 | |
849 | |
850 | if (IsRequired || ProcessAllSections) { |
851 | Allocate = DataSize + PaddingSize + StubBufSize; |
852 | if (!Allocate) |
853 | Allocate = 1; |
854 | Addr = IsCode ? MemMgr.allocateCodeSection(Allocate, Alignment, SectionID, |
855 | Name) |
856 | : MemMgr.allocateDataSection(Allocate, Alignment, SectionID, |
857 | Name, IsReadOnly); |
858 | if (!Addr) |
859 | report_fatal_error("Unable to allocate section memory!"); |
860 | |
861 | |
862 | if (IsZeroInit || IsVirtual) |
863 | memset(Addr, 0, DataSize); |
864 | else |
865 | memcpy(Addr, pData, DataSize); |
866 | |
867 | |
868 | if (PaddingSize != 0) { |
869 | memset(Addr + DataSize, 0, PaddingSize); |
870 | |
871 | DataSize += PaddingSize; |
872 | |
873 | |
874 | |
875 | if (StubBufSize > 0) |
876 | DataSize &= -(uint64_t)getStubAlignment(); |
877 | } |
878 | |
879 | LLVM_DEBUG(dbgs() << "emitSection SectionID: " << SectionID << " Name: " |
880 | << Name << " obj addr: " << format("%p", pData) |
881 | << " new addr: " << format("%p", Addr) << " DataSize: " |
882 | << DataSize << " StubBufSize: " << StubBufSize |
883 | << " Allocate: " << Allocate << "\n"); |
884 | } else { |
885 | |
886 | |
887 | |
888 | Allocate = 0; |
889 | Addr = nullptr; |
890 | LLVM_DEBUG( |
891 | dbgs() << "emitSection SectionID: " << SectionID << " Name: " << Name |
892 | << " obj addr: " << format("%p", data.data()) << " new addr: 0" |
893 | << " DataSize: " << DataSize << " StubBufSize: " << StubBufSize |
894 | << " Allocate: " << Allocate << "\n"); |
895 | } |
896 | |
897 | Sections.push_back( |
898 | SectionEntry(Name, Addr, DataSize, Allocate, (uintptr_t)pData)); |
899 | |
900 | |
901 | if (!IsRequired) |
902 | Sections.back().setLoadAddress(0); |
903 | |
904 | return SectionID; |
905 | } |
906 | |
907 | Expected<unsigned> |
908 | RuntimeDyldImpl::findOrEmitSection(const ObjectFile &Obj, |
909 | const SectionRef &Section, |
910 | bool IsCode, |
911 | ObjSectionToIDMap &LocalSections) { |
912 | |
913 | unsigned SectionID = 0; |
914 | ObjSectionToIDMap::iterator i = LocalSections.find(Section); |
915 | if (i != LocalSections.end()) |
916 | SectionID = i->second; |
917 | else { |
918 | if (auto SectionIDOrErr = emitSection(Obj, Section, IsCode)) |
919 | SectionID = *SectionIDOrErr; |
920 | else |
921 | return SectionIDOrErr.takeError(); |
922 | LocalSections[Section] = SectionID; |
923 | } |
924 | return SectionID; |
925 | } |
926 | |
927 | void RuntimeDyldImpl::addRelocationForSection(const RelocationEntry &RE, |
928 | unsigned SectionID) { |
929 | Relocations[SectionID].push_back(RE); |
930 | } |
931 | |
932 | void RuntimeDyldImpl::addRelocationForSymbol(const RelocationEntry &RE, |
933 | StringRef SymbolName) { |
934 | |
935 | |
936 | |
937 | RTDyldSymbolTable::const_iterator Loc = GlobalSymbolTable.find(SymbolName); |
938 | if (Loc == GlobalSymbolTable.end()) { |
939 | ExternalSymbolRelocations[SymbolName].push_back(RE); |
940 | } else { |
941 | assert(!SymbolName.empty() && |
942 | "Empty symbol should not be in GlobalSymbolTable"); |
943 | |
944 | RelocationEntry RECopy = RE; |
945 | const auto &SymInfo = Loc->second; |
946 | RECopy.Addend += SymInfo.getOffset(); |
947 | Relocations[SymInfo.getSectionID()].push_back(RECopy); |
948 | } |
949 | } |
950 | |
951 | uint8_t *RuntimeDyldImpl::createStubFunction(uint8_t *Addr, |
952 | unsigned AbiVariant) { |
953 | if (Arch == Triple::aarch64 || Arch == Triple::aarch64_be || |
954 | Arch == Triple::aarch64_32) { |
955 | |
956 | |
957 | |
958 | |
959 | writeBytesUnaligned(0xd2e00010, Addr, 4); |
960 | writeBytesUnaligned(0xf2c00010, Addr+4, 4); |
961 | writeBytesUnaligned(0xf2a00010, Addr+8, 4); |
962 | writeBytesUnaligned(0xf2800010, Addr+12, 4); |
963 | writeBytesUnaligned(0xd61f0200, Addr+16, 4); |
964 | |
965 | return Addr; |
966 | } else if (Arch == Triple::arm || Arch == Triple::armeb) { |
967 | |
968 | |
969 | writeBytesUnaligned(0xe51ff004, Addr, 4); |
970 | return Addr + 4; |
971 | } else if (IsMipsO32ABI || IsMipsN32ABI) { |
972 | |
973 | |
974 | |
975 | |
976 | const unsigned LuiT9Instr = 0x3c190000, AdduiT9Instr = 0x27390000; |
977 | const unsigned NopInstr = 0x0; |
978 | unsigned JrT9Instr = 0x03200008; |
979 | if ((AbiVariant & ELF::EF_MIPS_ARCH) == ELF::EF_MIPS_ARCH_32R6 || |
980 | (AbiVariant & ELF::EF_MIPS_ARCH) == ELF::EF_MIPS_ARCH_64R6) |
981 | JrT9Instr = 0x03200009; |
982 | |
983 | writeBytesUnaligned(LuiT9Instr, Addr, 4); |
984 | writeBytesUnaligned(AdduiT9Instr, Addr + 4, 4); |
985 | writeBytesUnaligned(JrT9Instr, Addr + 8, 4); |
986 | writeBytesUnaligned(NopInstr, Addr + 12, 4); |
987 | return Addr; |
988 | } else if (IsMipsN64ABI) { |
989 | |
990 | |
991 | |
992 | |
993 | |
994 | |
995 | |
996 | |
997 | const unsigned LuiT9Instr = 0x3c190000, DaddiuT9Instr = 0x67390000, |
998 | DsllT9Instr = 0x19CC38; |
999 | const unsigned NopInstr = 0x0; |
1000 | unsigned JrT9Instr = 0x03200008; |
1001 | if ((AbiVariant & ELF::EF_MIPS_ARCH) == ELF::EF_MIPS_ARCH_64R6) |
1002 | JrT9Instr = 0x03200009; |
1003 | |
1004 | writeBytesUnaligned(LuiT9Instr, Addr, 4); |
1005 | writeBytesUnaligned(DaddiuT9Instr, Addr + 4, 4); |
1006 | writeBytesUnaligned(DsllT9Instr, Addr + 8, 4); |
1007 | writeBytesUnaligned(DaddiuT9Instr, Addr + 12, 4); |
1008 | writeBytesUnaligned(DsllT9Instr, Addr + 16, 4); |
1009 | writeBytesUnaligned(DaddiuT9Instr, Addr + 20, 4); |
1010 | writeBytesUnaligned(JrT9Instr, Addr + 24, 4); |
1011 | writeBytesUnaligned(NopInstr, Addr + 28, 4); |
1012 | return Addr; |
1013 | } else if (Arch == Triple::ppc64 || Arch == Triple::ppc64le) { |
1014 | |
1015 | |
1016 | |
1017 | writeInt32BE(Addr, 0x3D800000); |
1018 | writeInt32BE(Addr+4, 0x618C0000); |
1019 | writeInt32BE(Addr+8, 0x798C07C6); |
1020 | writeInt32BE(Addr+12, 0x658C0000); |
1021 | writeInt32BE(Addr+16, 0x618C0000); |
1022 | if (AbiVariant == 2) { |
1023 | |
1024 | |
1025 | writeInt32BE(Addr+20, 0xF8410018); |
1026 | writeInt32BE(Addr+24, 0x7D8903A6); |
1027 | writeInt32BE(Addr+28, 0x4E800420); |
1028 | } else { |
1029 | |
1030 | |
1031 | |
1032 | writeInt32BE(Addr+20, 0xF8410028); |
1033 | writeInt32BE(Addr+24, 0xE96C0000); |
1034 | writeInt32BE(Addr+28, 0xE84C0008); |
1035 | writeInt32BE(Addr+32, 0x7D6903A6); |
1036 | writeInt32BE(Addr+36, 0xE96C0010); |
1037 | writeInt32BE(Addr+40, 0x4E800420); |
1038 | } |
1039 | return Addr; |
1040 | } else if (Arch == Triple::systemz) { |
1041 | writeInt16BE(Addr, 0xC418); |
1042 | writeInt16BE(Addr+2, 0x0000); |
1043 | writeInt16BE(Addr+4, 0x0004); |
1044 | writeInt16BE(Addr+6, 0x07F1); |
1045 | |
1046 | return Addr; |
1047 | } else if (Arch == Triple::x86_64) { |
1048 | *Addr = 0xFF; |
1049 | *(Addr+1) = 0x25; |
1050 | |
1051 | } else if (Arch == Triple::x86) { |
1052 | *Addr = 0xE9; |
1053 | } |
1054 | return Addr; |
1055 | } |
1056 | |
1057 | |
1058 | |
1059 | void RuntimeDyldImpl::reassignSectionAddress(unsigned SectionID, |
1060 | uint64_t Addr) { |
1061 | |
1062 | |
1063 | |
1064 | |
1065 | |
1066 | |
1067 | |
1068 | |
1069 | |
1070 | |
1071 | LLVM_DEBUG( |
1072 | dbgs() << "Reassigning address for section " << SectionID << " (" |
1073 | << Sections[SectionID].getName() << "): " |
1074 | << format("0x%016" PRIx64, Sections[SectionID].getLoadAddress()) |
1075 | << " -> " << format("0x%016" PRIx64, Addr) << "\n"); |
1076 | Sections[SectionID].setLoadAddress(Addr); |
1077 | } |
1078 | |
1079 | void RuntimeDyldImpl::resolveRelocationList(const RelocationList &Relocs, |
1080 | uint64_t Value) { |
1081 | for (unsigned i = 0, e = Relocs.size(); i != e; ++i) { |
1082 | const RelocationEntry &RE = Relocs[i]; |
1083 | |
1084 | if (RE.SectionID != AbsoluteSymbolSection && |
1085 | Sections[RE.SectionID].getAddress() == nullptr) |
1086 | continue; |
1087 | resolveRelocation(RE, Value); |
1088 | } |
1089 | } |
1090 | |
1091 | void RuntimeDyldImpl::applyExternalSymbolRelocations( |
1092 | const StringMap<JITEvaluatedSymbol> ExternalSymbolMap) { |
1093 | for (auto &RelocKV : ExternalSymbolRelocations) { |
1094 | StringRef Name = RelocKV.first(); |
1095 | RelocationList &Relocs = RelocKV.second; |
1096 | if (Name.size() == 0) { |
1097 | |
1098 | LLVM_DEBUG(dbgs() << "Resolving absolute relocations." |
1099 | << "\n"); |
1100 | resolveRelocationList(Relocs, 0); |
1101 | } else { |
1102 | uint64_t Addr = 0; |
1103 | JITSymbolFlags Flags; |
1104 | RTDyldSymbolTable::const_iterator Loc = GlobalSymbolTable.find(Name); |
1105 | if (Loc == GlobalSymbolTable.end()) { |
1106 | auto RRI = ExternalSymbolMap.find(Name); |
1107 | assert(RRI != ExternalSymbolMap.end() && "No result for symbol"); |
1108 | Addr = RRI->second.getAddress(); |
1109 | Flags = RRI->second.getFlags(); |
1110 | } else { |
1111 | |
1112 | |
1113 | const auto &SymInfo = Loc->second; |
1114 | Addr = getSectionLoadAddress(SymInfo.getSectionID()) + |
1115 | SymInfo.getOffset(); |
1116 | Flags = SymInfo.getFlags(); |
1117 | } |
1118 | |
1119 | |
1120 | if (!Addr && !Resolver.allowsZeroSymbols()) |
1121 | report_fatal_error("Program used external function '" + Name + |
1122 | "' which could not be resolved!"); |
1123 | |
1124 | |
1125 | |
1126 | if (Addr != UINT64_MAX) { |
1127 | |
1128 | |
1129 | |
1130 | |
1131 | Addr = modifyAddressBasedOnFlags(Addr, Flags); |
1132 | |
1133 | LLVM_DEBUG(dbgs() << "Resolving relocations Name: " << Name << "\t" |
1134 | << format("0x%lx", Addr) << "\n"); |
1135 | resolveRelocationList(Relocs, Addr); |
1136 | } |
1137 | } |
1138 | } |
1139 | ExternalSymbolRelocations.clear(); |
1140 | } |
1141 | |
1142 | Error RuntimeDyldImpl::resolveExternalSymbols() { |
1143 | StringMap<JITEvaluatedSymbol> ExternalSymbolMap; |
1144 | |
1145 | |
1146 | |
1147 | { |
1148 | JITSymbolResolver::LookupSet ResolvedSymbols; |
1149 | |
1150 | while (true) { |
1151 | JITSymbolResolver::LookupSet NewSymbols; |
1152 | |
1153 | for (auto &RelocKV : ExternalSymbolRelocations) { |
1154 | StringRef Name = RelocKV.first(); |
1155 | if (!Name.empty() && !GlobalSymbolTable.count(Name) && |
1156 | !ResolvedSymbols.count(Name)) |
1157 | NewSymbols.insert(Name); |
1158 | } |
1159 | |
1160 | if (NewSymbols.empty()) |
1161 | break; |
1162 | |
1163 | #ifdef _MSC_VER |
1164 | using ExpectedLookupResult = |
1165 | MSVCPExpected<JITSymbolResolver::LookupResult>; |
1166 | #else |
1167 | using ExpectedLookupResult = Expected<JITSymbolResolver::LookupResult>; |
1168 | #endif |
1169 | |
1170 | auto NewSymbolsP = std::make_shared<std::promise<ExpectedLookupResult>>(); |
1171 | auto NewSymbolsF = NewSymbolsP->get_future(); |
1172 | Resolver.lookup(NewSymbols, |
1173 | [=](Expected<JITSymbolResolver::LookupResult> Result) { |
1174 | NewSymbolsP->set_value(std::move(Result)); |
1175 | }); |
1176 | |
1177 | auto NewResolverResults = NewSymbolsF.get(); |
1178 | |
1179 | if (!NewResolverResults) |
1180 | return NewResolverResults.takeError(); |
1181 | |
1182 | assert(NewResolverResults->size() == NewSymbols.size() && |
1183 | "Should have errored on unresolved symbols"); |
1184 | |
1185 | for (auto &RRKV : *NewResolverResults) { |
1186 | assert(!ResolvedSymbols.count(RRKV.first) && "Redundant resolution?"); |
1187 | ExternalSymbolMap.insert(RRKV); |
1188 | ResolvedSymbols.insert(RRKV.first); |
1189 | } |
1190 | } |
1191 | } |
1192 | |
1193 | applyExternalSymbolRelocations(ExternalSymbolMap); |
1194 | |
1195 | return Error::success(); |
1196 | } |
1197 | |
1198 | void RuntimeDyldImpl::finalizeAsync( |
1199 | std::unique_ptr<RuntimeDyldImpl> This, |
1200 | unique_function<void(object::OwningBinary<object::ObjectFile>, |
1201 | std::unique_ptr<RuntimeDyld::LoadedObjectInfo>, Error)> |
1202 | OnEmitted, |
1203 | object::OwningBinary<object::ObjectFile> O, |
1204 | std::unique_ptr<RuntimeDyld::LoadedObjectInfo> Info) { |
1205 | |
1206 | auto SharedThis = std::shared_ptr<RuntimeDyldImpl>(std::move(This)); |
1207 | auto PostResolveContinuation = |
1208 | [SharedThis, OnEmitted = std::move(OnEmitted), O = std::move(O), |
1209 | Info = std::move(Info)]( |
1210 | Expected<JITSymbolResolver::LookupResult> Result) mutable { |
1211 | if (!Result) { |
1212 | OnEmitted(std::move(O), std::move(Info), Result.takeError()); |
1213 | return; |
1214 | } |
1215 | |
1216 | |
1217 | StringMap<JITEvaluatedSymbol> Resolved; |
1218 | for (auto &KV : *Result) |
1219 | Resolved[KV.first] = KV.second; |
1220 | |
1221 | SharedThis->applyExternalSymbolRelocations(Resolved); |
1222 | SharedThis->resolveLocalRelocations(); |
1223 | SharedThis->registerEHFrames(); |
1224 | std::string ErrMsg; |
1225 | if (SharedThis->MemMgr.finalizeMemory(&ErrMsg)) |
1226 | OnEmitted(std::move(O), std::move(Info), |
1227 | make_error<StringError>(std::move(ErrMsg), |
1228 | inconvertibleErrorCode())); |
1229 | else |
1230 | OnEmitted(std::move(O), std::move(Info), Error::success()); |
1231 | }; |
1232 | |
1233 | JITSymbolResolver::LookupSet Symbols; |
1234 | |
1235 | for (auto &RelocKV : SharedThis->ExternalSymbolRelocations) { |
1236 | StringRef Name = RelocKV.first(); |
1237 | if (Name.empty()) |
1238 | continue; |
1239 | assert(!SharedThis->GlobalSymbolTable.count(Name) && |
1240 | "Name already processed. RuntimeDyld instances can not be re-used " |
1241 | "when finalizing with finalizeAsync."); |
1242 | Symbols.insert(Name); |
1243 | } |
1244 | |
1245 | if (!Symbols.empty()) { |
1246 | SharedThis->Resolver.lookup(Symbols, std::move(PostResolveContinuation)); |
1247 | } else |
1248 | PostResolveContinuation(std::map<StringRef, JITEvaluatedSymbol>()); |
1249 | } |
1250 | |
1251 | |
1252 | |
1253 | |
1254 | uint64_t RuntimeDyld::LoadedObjectInfo::getSectionLoadAddress( |
1255 | const object::SectionRef &Sec) const { |
1256 | |
1257 | auto I = ObjSecToIDMap.find(Sec); |
1258 | if (I != ObjSecToIDMap.end()) |
1259 | return RTDyld.Sections[I->second].getLoadAddress(); |
1260 | |
1261 | return 0; |
1262 | } |
1263 | |
1264 | void RuntimeDyld::MemoryManager::anchor() {} |
1265 | void JITSymbolResolver::anchor() {} |
1266 | void LegacyJITSymbolResolver::anchor() {} |
1267 | |
1268 | RuntimeDyld::RuntimeDyld(RuntimeDyld::MemoryManager &MemMgr, |
1269 | JITSymbolResolver &Resolver) |
1270 | : MemMgr(MemMgr), Resolver(Resolver) { |
1271 | |
1272 | |
1273 | |
1274 | |
1275 | |
1276 | |
1277 | Dyld = nullptr; |
1278 | ProcessAllSections = false; |
1279 | } |
1280 | |
1281 | RuntimeDyld::~RuntimeDyld() {} |
1282 | |
1283 | static std::unique_ptr<RuntimeDyldCOFF> |
1284 | createRuntimeDyldCOFF( |
1285 | Triple::ArchType Arch, RuntimeDyld::MemoryManager &MM, |
1286 | JITSymbolResolver &Resolver, bool ProcessAllSections, |
1287 | RuntimeDyld::NotifyStubEmittedFunction NotifyStubEmitted) { |
1288 | std::unique_ptr<RuntimeDyldCOFF> Dyld = |
1289 | RuntimeDyldCOFF::create(Arch, MM, Resolver); |
1290 | Dyld->setProcessAllSections(ProcessAllSections); |
1291 | Dyld->setNotifyStubEmitted(std::move(NotifyStubEmitted)); |
1292 | return Dyld; |
1293 | } |
1294 | |
1295 | static std::unique_ptr<RuntimeDyldELF> |
1296 | createRuntimeDyldELF(Triple::ArchType Arch, RuntimeDyld::MemoryManager &MM, |
1297 | JITSymbolResolver &Resolver, bool ProcessAllSections, |
1298 | RuntimeDyld::NotifyStubEmittedFunction NotifyStubEmitted) { |
1299 | std::unique_ptr<RuntimeDyldELF> Dyld = |
1300 | RuntimeDyldELF::create(Arch, MM, Resolver); |
1301 | Dyld->setProcessAllSections(ProcessAllSections); |
1302 | Dyld->setNotifyStubEmitted(std::move(NotifyStubEmitted)); |
1303 | return Dyld; |
1304 | } |
1305 | |
1306 | static std::unique_ptr<RuntimeDyldMachO> |
1307 | createRuntimeDyldMachO( |
1308 | Triple::ArchType Arch, RuntimeDyld::MemoryManager &MM, |
1309 | JITSymbolResolver &Resolver, |
1310 | bool ProcessAllSections, |
1311 | RuntimeDyld::NotifyStubEmittedFunction NotifyStubEmitted) { |
1312 | std::unique_ptr<RuntimeDyldMachO> Dyld = |
1313 | RuntimeDyldMachO::create(Arch, MM, Resolver); |
1314 | Dyld->setProcessAllSections(ProcessAllSections); |
1315 | Dyld->setNotifyStubEmitted(std::move(NotifyStubEmitted)); |
1316 | return Dyld; |
1317 | } |
1318 | |
1319 | std::unique_ptr<RuntimeDyld::LoadedObjectInfo> |
1320 | RuntimeDyld::loadObject(const ObjectFile &Obj) { |
1321 | if (!Dyld) { |
1322 | if (Obj.isELF()) |
1323 | Dyld = |
1324 | createRuntimeDyldELF(static_cast<Triple::ArchType>(Obj.getArch()), |
1325 | MemMgr, Resolver, ProcessAllSections, |
1326 | std::move(NotifyStubEmitted)); |
1327 | else if (Obj.isMachO()) |
1328 | Dyld = createRuntimeDyldMachO( |
1329 | static_cast<Triple::ArchType>(Obj.getArch()), MemMgr, Resolver, |
1330 | ProcessAllSections, std::move(NotifyStubEmitted)); |
1331 | else if (Obj.isCOFF()) |
1332 | Dyld = createRuntimeDyldCOFF( |
1333 | static_cast<Triple::ArchType>(Obj.getArch()), MemMgr, Resolver, |
1334 | ProcessAllSections, std::move(NotifyStubEmitted)); |
1335 | else |
1336 | report_fatal_error("Incompatible object format!"); |
1337 | } |
1338 | |
1339 | if (!Dyld->isCompatibleFile(Obj)) |
1340 | report_fatal_error("Incompatible object format!"); |
1341 | |
1342 | auto LoadedObjInfo = Dyld->loadObject(Obj); |
1343 | MemMgr.notifyObjectLoaded(*this, Obj); |
1344 | return LoadedObjInfo; |
1345 | } |
1346 | |
1347 | void *RuntimeDyld::getSymbolLocalAddress(StringRef Name) const { |
1348 | if (!Dyld) |
1349 | return nullptr; |
1350 | return Dyld->getSymbolLocalAddress(Name); |
1351 | } |
1352 | |
1353 | unsigned RuntimeDyld::getSymbolSectionID(StringRef Name) const { |
1354 | assert(Dyld && "No RuntimeDyld instance attached"); |
1355 | return Dyld->getSymbolSectionID(Name); |
1356 | } |
1357 | |
1358 | JITEvaluatedSymbol RuntimeDyld::getSymbol(StringRef Name) const { |
1359 | if (!Dyld) |
1360 | return nullptr; |
1361 | return Dyld->getSymbol(Name); |
1362 | } |
1363 | |
1364 | std::map<StringRef, JITEvaluatedSymbol> RuntimeDyld::getSymbolTable() const { |
1365 | if (!Dyld) |
1366 | return std::map<StringRef, JITEvaluatedSymbol>(); |
1367 | return Dyld->getSymbolTable(); |
1368 | } |
1369 | |
1370 | void RuntimeDyld::resolveRelocations() { Dyld->resolveRelocations(); } |
1371 | |
1372 | void RuntimeDyld::reassignSectionAddress(unsigned SectionID, uint64_t Addr) { |
1373 | Dyld->reassignSectionAddress(SectionID, Addr); |
1374 | } |
1375 | |
1376 | void RuntimeDyld::mapSectionAddress(const void *LocalAddress, |
1377 | uint64_t TargetAddress) { |
1378 | Dyld->mapSectionAddress(LocalAddress, TargetAddress); |
1379 | } |
1380 | |
1381 | bool RuntimeDyld::hasError() { return Dyld->hasError(); } |
1382 | |
1383 | StringRef RuntimeDyld::getErrorString() { return Dyld->getErrorString(); } |
1384 | |
1385 | void RuntimeDyld::finalizeWithMemoryManagerLocking() { |
1386 | bool MemoryFinalizationLocked = MemMgr.FinalizationLocked; |
1387 | MemMgr.FinalizationLocked = true; |
1388 | resolveRelocations(); |
1389 | registerEHFrames(); |
1390 | if (!MemoryFinalizationLocked) { |
1391 | MemMgr.finalizeMemory(); |
1392 | MemMgr.FinalizationLocked = false; |
1393 | } |
1394 | } |
1395 | |
1396 | StringRef RuntimeDyld::getSectionContent(unsigned SectionID) const { |
1397 | assert(Dyld && "No Dyld instance attached"); |
1398 | return Dyld->getSectionContent(SectionID); |
1399 | } |
1400 | |
1401 | uint64_t RuntimeDyld::getSectionLoadAddress(unsigned SectionID) const { |
1402 | assert(Dyld && "No Dyld instance attached"); |
1403 | return Dyld->getSectionLoadAddress(SectionID); |
1404 | } |
1405 | |
1406 | void RuntimeDyld::registerEHFrames() { |
1407 | if (Dyld) |
1408 | Dyld->registerEHFrames(); |
1409 | } |
1410 | |
1411 | void RuntimeDyld::deregisterEHFrames() { |
1412 | if (Dyld) |
1413 | Dyld->deregisterEHFrames(); |
1414 | } |
1415 | |
1416 | |
1417 | |
1418 | void jitLinkForORC( |
1419 | object::OwningBinary<object::ObjectFile> O, |
1420 | RuntimeDyld::MemoryManager &MemMgr, JITSymbolResolver &Resolver, |
1421 | bool ProcessAllSections, |
1422 | unique_function<Error(const object::ObjectFile &Obj, |
1423 | RuntimeDyld::LoadedObjectInfo &LoadedObj, |
1424 | std::map<StringRef, JITEvaluatedSymbol>)> |
1425 | OnLoaded, |
1426 | unique_function<void(object::OwningBinary<object::ObjectFile>, |
1427 | std::unique_ptr<RuntimeDyld::LoadedObjectInfo>, Error)> |
1428 | OnEmitted) { |
1429 | |
1430 | RuntimeDyld RTDyld(MemMgr, Resolver); |
1431 | RTDyld.setProcessAllSections(ProcessAllSections); |
1432 | |
1433 | auto Info = RTDyld.loadObject(*O.getBinary()); |
1434 | |
1435 | if (RTDyld.hasError()) { |
1436 | OnEmitted(std::move(O), std::move(Info), |
1437 | make_error<StringError>(RTDyld.getErrorString(), |
1438 | inconvertibleErrorCode())); |
1439 | return; |
1440 | } |
1441 | |
1442 | if (auto Err = OnLoaded(*O.getBinary(), *Info, RTDyld.getSymbolTable())) |
1443 | OnEmitted(std::move(O), std::move(Info), std::move(Err)); |
1444 | |
1445 | RuntimeDyldImpl::finalizeAsync(std::move(RTDyld.Dyld), std::move(OnEmitted), |
1446 | std::move(O), std::move(Info)); |
1447 | } |
1448 | |
1449 | } |
1 | |
2 | |
3 | |
4 | |
5 | |
6 | |
7 | |
8 | |
9 | |
10 | |
11 | |
12 | |
13 | #ifndef LLVM_SUPPORT_ERROR_H |
14 | #define LLVM_SUPPORT_ERROR_H |
15 | |
16 | #include "llvm-c/Error.h" |
17 | #include "llvm/ADT/STLExtras.h" |
18 | #include "llvm/ADT/SmallVector.h" |
19 | #include "llvm/ADT/StringExtras.h" |
20 | #include "llvm/ADT/Twine.h" |
21 | #include "llvm/Config/abi-breaking.h" |
22 | #include "llvm/Support/AlignOf.h" |
23 | #include "llvm/Support/Compiler.h" |
24 | #include "llvm/Support/Debug.h" |
25 | #include "llvm/Support/ErrorHandling.h" |
26 | #include "llvm/Support/ErrorOr.h" |
27 | #include "llvm/Support/Format.h" |
28 | #include "llvm/Support/raw_ostream.h" |
29 | #include <algorithm> |
30 | #include <cassert> |
31 | #include <cstdint> |
32 | #include <cstdlib> |
33 | #include <functional> |
34 | #include <memory> |
35 | #include <new> |
36 | #include <string> |
37 | #include <system_error> |
38 | #include <type_traits> |
39 | #include <utility> |
40 | #include <vector> |
41 | |
42 | namespace llvm { |
43 | |
44 | class ErrorSuccess; |
45 | |
46 | |
47 | |
48 | class ErrorInfoBase { |
49 | public: |
50 | virtual ~ErrorInfoBase() = default; |
51 | |
52 | |
53 | virtual void log(raw_ostream &OS) const = 0; |
54 | |
55 | |
56 | virtual std::string message() const { |
57 | std::string Msg; |
58 | raw_string_ostream OS(Msg); |
59 | log(OS); |
60 | return OS.str(); |
61 | } |
62 | |
63 | |
64 | |
65 | |
66 | |
67 | virtual std::error_code convertToErrorCode() const = 0; |
68 | |
69 | |
70 | static const void *classID() { return &ID; } |
71 | |
72 | |
73 | virtual const void *dynamicClassID() const = 0; |
74 | |
75 | |
76 | |
77 | virtual bool isA(const void *const ClassID) const { |
78 | return ClassID == classID(); |
79 | } |
80 | |
81 | |
82 | template <typename ErrorInfoT> bool isA() const { |
83 | return isA(ErrorInfoT::classID()); |
84 | } |
85 | |
86 | private: |
87 | virtual void anchor(); |
88 | |
89 | static char ID; |
90 | }; |
91 | |
92 | |
93 | |
94 | |
95 | |
96 | |
97 | |
98 | |
99 | |
100 | |
101 | |
102 | |
103 | |
104 | |
105 | |
106 | |
107 | |
108 | |
109 | |
110 | |
111 | |
112 | |
113 | |
114 | |
115 | |
116 | |
117 | |
118 | |
119 | |
120 | |
121 | |
122 | |
123 | |
124 | |
125 | |
126 | |
127 | |
128 | |
129 | |
130 | |
131 | |
132 | |
133 | |
134 | |
135 | |
136 | |
137 | |
138 | |
139 | |
140 | |
141 | |
142 | |
143 | |
144 | |
145 | |
146 | |
147 | |
148 | |
149 | |
150 | |
151 | |
152 | |
153 | |
154 | |
155 | |
156 | |
157 | class LLVM_NODISCARD Error { |
158 | |
159 | |
160 | |
161 | friend class ErrorList; |
162 | |
163 | |
164 | template <typename... HandlerTs> |
165 | friend Error handleErrors(Error E, HandlerTs &&... Handlers); |
166 | |
167 | |
168 | |
169 | template <typename T> friend class Expected; |
170 | |
171 | |
172 | friend LLVMErrorRef wrap(Error); |
173 | |
174 | protected: |
175 | |
176 | Error() { |
177 | setPtr(nullptr); |
178 | setChecked(false); |
179 | } |
180 | |
181 | public: |
182 | |
183 | static ErrorSuccess success(); |
184 | |
185 | |
186 | Error(const Error &Other) = delete; |
187 | |
188 | |
189 | |
190 | |
191 | Error(Error &&Other) { |
192 | setChecked(true); |
193 | *this = std::move(Other); |
194 | } |
195 | |
196 | |
197 | |
198 | Error(std::unique_ptr<ErrorInfoBase> Payload) { |
199 | setPtr(Payload.release()); |
200 | setChecked(false); |
201 | } |
202 | |
203 | |
204 | Error &operator=(const Error &Other) = delete; |
205 | |
206 | |
207 | |
208 | |
209 | |
210 | Error &operator=(Error &&Other) { |
211 | |
212 | assertIsChecked(); |
213 | setPtr(Other.getPtr()); |
214 | |
215 | |
216 | setChecked(false); |
217 | |
218 | |
219 | Other.setPtr(nullptr); |
220 | Other.setChecked(true); |
221 | |
222 | return *this; |
223 | } |
224 | |
225 | |
226 | |
227 | ~Error() { |
228 | assertIsChecked(); |
229 | delete getPtr(); |
230 | } |
231 | |
232 | |
233 | |
234 | |
235 | explicit operator bool() { |
236 | setChecked(getPtr() == nullptr); |
| 60 | | Assuming the condition is true | |
|
237 | return getPtr() != nullptr; |
| 61 | | Returning zero, which participates in a condition later | |
|
238 | } |
239 | |
240 | |
241 | template <typename ErrT> bool isA() const { |
242 | return getPtr() && getPtr()->isA(ErrT::classID()); |
243 | } |
244 | |
245 | |
246 | |
247 | const void* dynamicClassID() const { |
248 | if (!getPtr()) |
249 | return nullptr; |
250 | return getPtr()->dynamicClassID(); |
251 | } |
252 | |
253 | private: |
254 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
255 | |
256 | |
257 | |
258 | |
259 | |
260 | LLVM_ATTRIBUTE_NORETURN |
261 | void fatalUncheckedError() const; |
262 | #endif |
263 | |
264 | void assertIsChecked() { |
265 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
266 | if (LLVM_UNLIKELY(!getChecked() || getPtr())) |
267 | fatalUncheckedError(); |
268 | #endif |
269 | } |
270 | |
271 | ErrorInfoBase *getPtr() const { |
272 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
273 | return reinterpret_cast<ErrorInfoBase*>( |
274 | reinterpret_cast<uintptr_t>(Payload) & |
275 | ~static_cast<uintptr_t>(0x1)); |
276 | #else |
277 | return Payload; |
278 | #endif |
279 | } |
280 | |
281 | void setPtr(ErrorInfoBase *EI) { |
282 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
283 | Payload = reinterpret_cast<ErrorInfoBase*>( |
284 | (reinterpret_cast<uintptr_t>(EI) & |
285 | ~static_cast<uintptr_t>(0x1)) | |
286 | (reinterpret_cast<uintptr_t>(Payload) & 0x1)); |
287 | #else |
288 | Payload = EI; |
289 | #endif |
290 | } |
291 | |
292 | bool getChecked() const { |
293 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
294 | return (reinterpret_cast<uintptr_t>(Payload) & 0x1) == 0; |
295 | #else |
296 | return true; |
297 | #endif |
298 | } |
299 | |
300 | void setChecked(bool V) { |
301 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
302 | Payload = reinterpret_cast<ErrorInfoBase*>( |
303 | (reinterpret_cast<uintptr_t>(Payload) & |
304 | ~static_cast<uintptr_t>(0x1)) | |
305 | (V ? 0 : 1)); |
306 | #endif |
307 | } |
308 | |
309 | std::unique_ptr<ErrorInfoBase> takePayload() { |
310 | std::unique_ptr<ErrorInfoBase> Tmp(getPtr()); |
311 | setPtr(nullptr); |
312 | setChecked(true); |
313 | return Tmp; |
314 | } |
315 | |
316 | friend raw_ostream &operator<<(raw_ostream &OS, const Error &E) { |
317 | if (auto P = E.getPtr()) |
318 | P->log(OS); |
319 | else |
320 | OS << "success"; |
321 | return OS; |
322 | } |
323 | |
324 | ErrorInfoBase *Payload = nullptr; |
325 | }; |
326 | |
327 | |
328 | |
329 | |
330 | class ErrorSuccess final : public Error {}; |
331 | |
332 | inline ErrorSuccess Error::success() { return ErrorSuccess(); } |
333 | |
334 | |
335 | |
336 | template <typename ErrT, typename... ArgTs> Error make_error(ArgTs &&... Args) { |
337 | return Error(std::make_unique<ErrT>(std::forward<ArgTs>(Args)...)); |
338 | } |
339 | |
340 | |
341 | |
342 | |
343 | |
344 | |
345 | |
346 | |
347 | |
348 | |
349 | template <typename ThisErrT, typename ParentErrT = ErrorInfoBase> |
350 | class ErrorInfo : public ParentErrT { |
351 | public: |
352 | using ParentErrT::ParentErrT; |
353 | |
354 | static const void *classID() { return &ThisErrT::ID; } |
355 | |
356 | const void *dynamicClassID() const override { return &ThisErrT::ID; } |
357 | |
358 | bool isA(const void *const ClassID) const override { |
359 | return ClassID == classID() || ParentErrT::isA(ClassID); |
360 | } |
361 | }; |
362 | |
363 | |
364 | |
365 | class ErrorList final : public ErrorInfo<ErrorList> { |
366 | |
367 | |
368 | template <typename... HandlerTs> |
369 | friend Error handleErrors(Error E, HandlerTs &&... Handlers); |
370 | |
371 | |
372 | friend Error joinErrors(Error, Error); |
373 | |
374 | public: |
375 | void log(raw_ostream &OS) const override { |
376 | OS << "Multiple errors:\n"; |
377 | for (auto &ErrPayload : Payloads) { |
378 | ErrPayload->log(OS); |
379 | OS << "\n"; |
380 | } |
381 | } |
382 | |
383 | std::error_code convertToErrorCode() const override; |
384 | |
385 | |
386 | static char ID; |
387 | |
388 | private: |
389 | ErrorList(std::unique_ptr<ErrorInfoBase> Payload1, |
390 | std::unique_ptr<ErrorInfoBase> Payload2) { |
391 | assert(!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && |
392 | "ErrorList constructor payloads should be singleton errors"); |
393 | Payloads.push_back(std::move(Payload1)); |
394 | Payloads.push_back(std::move(Payload2)); |
395 | } |
396 | |
397 | static Error join(Error E1, Error E2) { |
398 | if (!E1) |
399 | return E2; |
400 | if (!E2) |
401 | return E1; |
402 | if (E1.isA<ErrorList>()) { |
403 | auto &E1List = static_cast<ErrorList &>(*E1.getPtr()); |
404 | if (E2.isA<ErrorList>()) { |
405 | auto E2Payload = E2.takePayload(); |
406 | auto &E2List = static_cast<ErrorList &>(*E2Payload); |
407 | for (auto &Payload : E2List.Payloads) |
408 | E1List.Payloads.push_back(std::move(Payload)); |
409 | } else |
410 | E1List.Payloads.push_back(E2.takePayload()); |
411 | |
412 | return E1; |
413 | } |
414 | if (E2.isA<ErrorList>()) { |
415 | auto &E2List = static_cast<ErrorList &>(*E2.getPtr()); |
416 | E2List.Payloads.insert(E2List.Payloads.begin(), E1.takePayload()); |
417 | return E2; |
418 | } |
419 | return Error(std::unique_ptr<ErrorList>( |
420 | new ErrorList(E1.takePayload(), E2.takePayload()))); |
421 | } |
422 | |
423 | std::vector<std::unique_ptr<ErrorInfoBase>> Payloads; |
424 | }; |
425 | |
426 | |
427 | |
428 | |
429 | inline Error joinErrors(Error E1, Error E2) { |
430 | return ErrorList::join(std::move(E1), std::move(E2)); |
431 | } |
432 | |
433 | |
434 | |
435 | |
436 | |
437 | |
438 | |
439 | |
440 | |
441 | |
442 | |
443 | |
444 | |
445 | |
446 | |
447 | |
448 | |
449 | |
450 | |
451 | |
452 | |
453 | |
454 | |
455 | |
456 | |
457 | |
458 | |
459 | |
460 | |
461 | |
462 | |
463 | |
464 | |
465 | |
466 | |
467 | |
468 | |
469 | |
470 | |
471 | |
472 | template <class T> class LLVM_NODISCARD Expected { |
473 | template <class T1> friend class ExpectedAsOutParameter; |
474 | template <class OtherT> friend class Expected; |
475 | |
476 | static constexpr bool isRef = std::is_reference<T>::value; |
477 | |
478 | using wrap = std::reference_wrapper<std::remove_reference_t<T>>; |
479 | |
480 | using error_type = std::unique_ptr<ErrorInfoBase>; |
481 | |
482 | public: |
483 | using storage_type = std::conditional_t<isRef, wrap, T>; |
484 | using value_type = T; |
485 | |
486 | private: |
487 | using reference = std::remove_reference_t<T> &; |
488 | using const_reference = const std::remove_reference_t<T> &; |
489 | using pointer = std::remove_reference_t<T> *; |
490 | using const_pointer = const std::remove_reference_t<T> *; |
491 | |
492 | public: |
493 | |
494 | Expected(Error Err) |
495 | : HasError(true) |
496 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
497 | |
498 | , Unchecked(true) |
499 | #endif |
500 | { |
501 | assert(Err && "Cannot create Expected<T> from Error success value."); |
502 | new (getErrorStorage()) error_type(Err.takePayload()); |
503 | } |
504 | |
505 | |
506 | |
507 | |
508 | Expected(ErrorSuccess) = delete; |
509 | |
510 | |
511 | |
512 | template <typename OtherT> |
513 | Expected(OtherT &&Val, |
514 | std::enable_if_t<std::is_convertible<OtherT, T>::value> * = nullptr) |
515 | : HasError(false) |
516 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
517 | |
518 | , |
519 | Unchecked(true) |
520 | #endif |
521 | { |
522 | new (getStorage()) storage_type(std::forward<OtherT>(Val)); |
523 | } |
524 | |
525 | |
526 | Expected(Expected &&Other) { moveConstruct(std::move(Other)); } |
527 | |
528 | |
529 | |
530 | template <class OtherT> |
531 | Expected( |
532 | Expected<OtherT> &&Other, |
533 | std::enable_if_t<std::is_convertible<OtherT, T>::value> * = nullptr) { |
534 | moveConstruct(std::move(Other)); |
535 | } |
536 | |
537 | |
538 | |
539 | template <class OtherT> |
540 | explicit Expected( |
541 | Expected<OtherT> &&Other, |
542 | std::enable_if_t<!std::is_convertible<OtherT, T>::value> * = nullptr) { |
543 | moveConstruct(std::move(Other)); |
544 | } |
545 | |
546 | |
547 | Expected &operator=(Expected &&Other) { |
548 | moveAssign(std::move(Other)); |
549 | return *this; |
550 | } |
551 | |
552 | |
553 | ~Expected() { |
554 | assertIsChecked(); |
555 | if (!HasError) |
556 | getStorage()->~storage_type(); |
557 | else |
558 | getErrorStorage()->~error_type(); |
559 | } |
560 | |
561 | |
562 | explicit operator bool() { |
563 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
564 | Unchecked = HasError; |
565 | #endif |
566 | return !HasError; |
| 4 | | Assuming field 'HasError' is false, which participates in a condition later | |
|
| 5 | | Returning the value 1, which participates in a condition later | |
|
| 11 | | Assuming field 'HasError' is false, which participates in a condition later | |
|
| 12 | | Returning the value 1, which participates in a condition later | |
|
| 18 | | Assuming field 'HasError' is false, which participates in a condition later | |
|
| 19 | | Returning the value 1, which participates in a condition later | |
|
| 23 | | Assuming field 'HasError' is false, which participates in a condition later | |
|
| 24 | | Returning the value 1, which participates in a condition later | |
|
| 28 | | Assuming field 'HasError' is false, which participates in a condition later | |
|
| 29 | | Returning the value 1, which participates in a condition later | |
|
| 48 | | Assuming field 'HasError' is false, which participates in a condition later | |
|
| 49 | | Returning the value 1, which participates in a condition later | |
|
| 65 | | Returning the value 1, which participates in a condition later | |
|
567 | } |
568 | |
569 | |
570 | reference get() { |
571 | assertIsChecked(); |
572 | return *getStorage(); |
573 | } |
574 | |
575 | |
576 | const_reference get() const { |
577 | assertIsChecked(); |
578 | return const_cast<Expected<T> *>(this)->get(); |
579 | } |
580 | |
581 | |
582 | template <typename ErrT> bool errorIsA() const { |
583 | return HasError && (*getErrorStorage())->template isA<ErrT>(); |
584 | } |
585 | |
586 | |
587 | |
588 | |
589 | |
590 | Error takeError() { |
591 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
592 | Unchecked = false; |
593 | #endif |
594 | return HasError ? Error(std::move(*getErrorStorage())) : Error::success(); |
595 | } |
596 | |
597 | |
598 | pointer operator->() { |
599 | assertIsChecked(); |
600 | return toPointer(getStorage()); |
601 | } |
602 | |
603 | |
604 | const_pointer operator->() const { |
605 | assertIsChecked(); |
606 | return toPointer(getStorage()); |
607 | } |
608 | |
609 | |
610 | reference operator*() { |
611 | assertIsChecked(); |
612 | return *getStorage(); |
613 | } |
614 | |
615 | |
616 | const_reference operator*() const { |
617 | assertIsChecked(); |
618 | return *getStorage(); |
619 | } |
620 | |
621 | private: |
622 | template <class T1> |
623 | static bool compareThisIfSameType(const T1 &a, const T1 &b) { |
624 | return &a == &b; |
625 | } |
626 | |
627 | template <class T1, class T2> |
628 | static bool compareThisIfSameType(const T1 &, const T2 &) { |
629 | return false; |
630 | } |
631 | |
632 | template <class OtherT> void moveConstruct(Expected<OtherT> &&Other) { |
633 | HasError = Other.HasError; |
634 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
635 | Unchecked = true; |
636 | Other.Unchecked = false; |
637 | #endif |
638 | |
639 | if (!HasError) |
640 | new (getStorage()) storage_type(std::move(*Other.getStorage())); |
641 | else |
642 | new (getErrorStorage()) error_type(std::move(*Other.getErrorStorage())); |
643 | } |
644 | |
645 | template <class OtherT> void moveAssign(Expected<OtherT> &&Other) { |
646 | assertIsChecked(); |
647 | |
648 | if (compareThisIfSameType(*this, Other)) |
649 | return; |
650 | |
651 | this->~Expected(); |
652 | new (this) Expected(std::move(Other)); |
653 | } |
654 | |
655 | pointer toPointer(pointer Val) { return Val; } |
656 | |
657 | const_pointer toPointer(const_pointer Val) const { return Val; } |
658 | |
659 | pointer toPointer(wrap *Val) { return &Val->get(); } |
660 | |
661 | const_pointer toPointer(const wrap *Val) const { return &Val->get(); } |
662 | |
663 | storage_type *getStorage() { |
664 | assert(!HasError && "Cannot get value when an error exists!"); |
665 | return reinterpret_cast<storage_type *>(&TStorage); |
666 | } |
667 | |
668 | const storage_type *getStorage() const { |
669 | assert(!HasError && "Cannot get value when an error exists!"); |
670 | return reinterpret_cast<const storage_type *>(&TStorage); |
671 | } |
672 | |
673 | error_type *getErrorStorage() { |
674 | assert(HasError && "Cannot get error when a value exists!"); |
675 | return reinterpret_cast<error_type *>(&ErrorStorage); |
676 | } |
677 | |
678 | const error_type *getErrorStorage() const { |
679 | assert(HasError && "Cannot get error when a value exists!"); |
680 | return reinterpret_cast<const error_type *>(&ErrorStorage); |
681 | } |
682 | |
683 | |
684 | void setUnchecked() { |
685 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
686 | Unchecked = true; |
687 | #endif |
688 | } |
689 | |
690 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
691 | LLVM_ATTRIBUTE_NORETURN |
692 | LLVM_ATTRIBUTE_NOINLINE |
693 | void fatalUncheckedExpected() const { |
694 | dbgs() << "Expected<T> must be checked before access or destruction.\n"; |
695 | if (HasError) { |
696 | dbgs() << "Unchecked Expected<T> contained error:\n"; |
697 | (*getErrorStorage())->log(dbgs()); |
698 | } else |
699 | dbgs() << "Expected<T> value was in success state. (Note: Expected<T> " |
700 | "values in success mode must still be checked prior to being " |
701 | "destroyed).\n"; |
702 | abort(); |
703 | } |
704 | #endif |
705 | |
706 | void assertIsChecked() const { |
707 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
708 | if (LLVM_UNLIKELY(Unchecked)) |
709 | fatalUncheckedExpected(); |
710 | #endif |
711 | } |
712 | |
713 | union { |
714 | AlignedCharArrayUnion<storage_type> TStorage; |
715 | AlignedCharArrayUnion<error_type> ErrorStorage; |
716 | }; |
717 | bool HasError : 1; |
718 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
719 | bool Unchecked : 1; |
720 | #endif |
721 | }; |
722 | |
723 | |
724 | |
725 | LLVM_ATTRIBUTE_NORETURN void report_fatal_error(Error Err, |
726 | bool gen_crash_diag = true); |
727 | |
728 | |
729 | |
730 | |
731 | |
732 | |
733 | |
734 | |
735 | |
736 | |
737 | |
738 | |
739 | |
740 | |
741 | inline void cantFail(Error Err, const char *Msg = nullptr) { |
742 | if (Err) { |
743 | if (!Msg) |
744 | Msg = "Failure value returned from cantFail wrapped call"; |
745 | #ifndef NDEBUG |
746 | std::string Str; |
747 | raw_string_ostream OS(Str); |
748 | OS << Msg << "\n" << Err; |
749 | Msg = OS.str().c_str(); |
750 | #endif |
751 | llvm_unreachable(Msg); |
752 | } |
753 | } |
754 | |
755 | |
756 | |
757 | |
758 | |
759 | |
760 | |
761 | |
762 | |
763 | |
764 | |
765 | |
766 | |
767 | |
768 | template <typename T> |
769 | T cantFail(Expected<T> ValOrErr, const char *Msg = nullptr) { |
770 | if (ValOrErr) |
771 | return std::move(*ValOrErr); |
772 | else { |
773 | if (!Msg) |
774 | Msg = "Failure value returned from cantFail wrapped call"; |
775 | #ifndef NDEBUG |
776 | std::string Str; |
777 | raw_string_ostream OS(Str); |
778 | auto E = ValOrErr.takeError(); |
779 | OS << Msg << "\n" << E; |
780 | Msg = OS.str().c_str(); |
781 | #endif |
782 | llvm_unreachable(Msg); |
783 | } |
784 | } |
785 | |
786 | |
787 | |
788 | |
789 | |
790 | |
791 | |
792 | |
793 | |
794 | |
795 | |
796 | |
797 | |
798 | |
799 | template <typename T> |
800 | T& cantFail(Expected<T&> ValOrErr, const char *Msg = nullptr) { |
801 | if (ValOrErr) |
802 | return *ValOrErr; |
803 | else { |
804 | if (!Msg) |
805 | Msg = "Failure value returned from cantFail wrapped call"; |
806 | #ifndef NDEBUG |
807 | std::string Str; |
808 | raw_string_ostream OS(Str); |
809 | auto E = ValOrErr.takeError(); |
810 | OS << Msg << "\n" << E; |
811 | Msg = OS.str().c_str(); |
812 | #endif |
813 | llvm_unreachable(Msg); |
814 | } |
815 | } |
816 | |
817 | |
818 | |
819 | template <typename HandlerT> |
820 | class ErrorHandlerTraits |
821 | : public ErrorHandlerTraits<decltype( |
822 | &std::remove_reference<HandlerT>::type::operator())> {}; |
823 | |
824 | |
825 | template <typename ErrT> class ErrorHandlerTraits<Error (&)(ErrT &)> { |
826 | public: |
827 | static bool appliesTo(const ErrorInfoBase &E) { |
828 | return E.template isA<ErrT>(); |
829 | } |
830 | |
831 | template <typename HandlerT> |
832 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { |
833 | assert(appliesTo(*E) && "Applying incorrect handler"); |
834 | return H(static_cast<ErrT &>(*E)); |
835 | } |
836 | }; |
837 | |
838 | |
839 | template <typename ErrT> class ErrorHandlerTraits<void (&)(ErrT &)> { |
840 | public: |
841 | static bool appliesTo(const ErrorInfoBase &E) { |
842 | return E.template isA<ErrT>(); |
843 | } |
844 | |
845 | template <typename HandlerT> |
846 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { |
847 | assert(appliesTo(*E) && "Applying incorrect handler"); |
848 | H(static_cast<ErrT &>(*E)); |
849 | return Error::success(); |
850 | } |
851 | }; |
852 | |
853 | |
854 | template <typename ErrT> |
855 | class ErrorHandlerTraits<Error (&)(std::unique_ptr<ErrT>)> { |
856 | public: |
857 | static bool appliesTo(const ErrorInfoBase &E) { |
858 | return E.template isA<ErrT>(); |
859 | } |
860 | |
861 | template <typename HandlerT> |
862 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { |
863 | assert(appliesTo(*E) && "Applying incorrect handler"); |
864 | std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release())); |
865 | return H(std::move(SubE)); |
866 | } |
867 | }; |
868 | |
869 | |
870 | template <typename ErrT> |
871 | class ErrorHandlerTraits<void (&)(std::unique_ptr<ErrT>)> { |
872 | public: |
873 | static bool appliesTo(const ErrorInfoBase &E) { |
874 | return E.template isA<ErrT>(); |
875 | } |
876 | |
877 | template <typename HandlerT> |
878 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { |
879 | assert(appliesTo(*E) && "Applying incorrect handler"); |
880 | std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release())); |
881 | H(std::move(SubE)); |
882 | return Error::success(); |
883 | } |
884 | }; |
885 | |
886 | |
887 | template <typename C, typename RetT, typename ErrT> |
888 | class ErrorHandlerTraits<RetT (C::*)(ErrT &)> |
889 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; |
890 | |
891 | |
892 | template <typename C, typename RetT, typename ErrT> |
893 | class ErrorHandlerTraits<RetT (C::*)(ErrT &) const> |
894 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; |
895 | |
896 | |
897 | template <typename C, typename RetT, typename ErrT> |
898 | class ErrorHandlerTraits<RetT (C::*)(const ErrT &)> |
899 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; |
900 | |
901 | |
902 | template <typename C, typename RetT, typename ErrT> |
903 | class ErrorHandlerTraits<RetT (C::*)(const ErrT &) const> |
904 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; |
905 | |
906 | |
907 | |
908 | template <typename C, typename RetT, typename ErrT> |
909 | class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>)> |
910 | : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {}; |
911 | |
912 | |
913 | |
914 | template <typename C, typename RetT, typename ErrT> |
915 | class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>) const> |
916 | : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {}; |
917 | |
918 | inline Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload) { |
919 | return Error(std::move(Payload)); |
920 | } |
921 | |
922 | template <typename HandlerT, typename... HandlerTs> |
923 | Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload, |
924 | HandlerT &&Handler, HandlerTs &&... Handlers) { |
925 | if (ErrorHandlerTraits<HandlerT>::appliesTo(*Payload)) |
926 | return ErrorHandlerTraits<HandlerT>::apply(std::forward<HandlerT>(Handler), |
927 | std::move(Payload)); |
928 | return handleErrorImpl(std::move(Payload), |
929 | std::forward<HandlerTs>(Handlers)...); |
930 | } |
931 | |
932 | |
933 | |
934 | |
935 | |
936 | |
937 | |
938 | template <typename... HandlerTs> |
939 | Error handleErrors(Error E, HandlerTs &&... Hs) { |
940 | if (!E) |
941 | return Error::success(); |
942 | |
943 | std::unique_ptr<ErrorInfoBase> Payload = E.takePayload(); |
944 | |
945 | if (Payload->isA<ErrorList>()) { |
946 | ErrorList &List = static_cast<ErrorList &>(*Payload); |
947 | Error R; |
948 | for (auto &P : List.Payloads) |
949 | R = ErrorList::join( |
950 | std::move(R), |
951 | handleErrorImpl(std::move(P), std::forward<HandlerTs>(Hs)...)); |
952 | return R; |
953 | } |
954 | |
955 | return handleErrorImpl(std::move(Payload), std::forward<HandlerTs>(Hs)...); |
956 | } |
957 | |
958 | |
959 | |
960 | |
961 | template <typename... HandlerTs> |
962 | void handleAllErrors(Error E, HandlerTs &&... Handlers) { |
963 | cantFail(handleErrors(std::move(E), std::forward<HandlerTs>(Handlers)...)); |
964 | } |
965 | |
966 | |
967 | |
968 | inline void handleAllErrors(Error E) { |
969 | cantFail(std::move(E)); |
970 | } |
971 | |
972 | |
973 | |
974 | |
975 | |
976 | |
977 | |
978 | |
979 | |
980 | |
981 | |
982 | |
983 | |
984 | |
985 | |
986 | |
987 | |
988 | |
989 | |
990 | |
991 | |
992 | |
993 | |
994 | |
995 | |
996 | template <typename T, typename RecoveryFtor, typename... HandlerTs> |
997 | Expected<T> handleExpected(Expected<T> ValOrErr, RecoveryFtor &&RecoveryPath, |
998 | HandlerTs &&... Handlers) { |
999 | if (ValOrErr) |
1000 | return ValOrErr; |
1001 | |
1002 | if (auto Err = handleErrors(ValOrErr.takeError(), |
1003 | std::forward<HandlerTs>(Handlers)...)) |
1004 | return std::move(Err); |
1005 | |
1006 | return RecoveryPath(); |
1007 | } |
1008 | |
1009 | |
1010 | |
1011 | |
1012 | |
1013 | |
1014 | |
1015 | |
1016 | |
1017 | |
1018 | |
1019 | |
1020 | void logAllUnhandledErrors(Error E, raw_ostream &OS, Twine ErrorBanner = {}); |
1021 | |
1022 | |
1023 | |
1024 | inline std::string toString(Error E) { |
1025 | SmallVector<std::string, 2> Errors; |
1026 | handleAllErrors(std::move(E), [&Errors](const ErrorInfoBase &EI) { |
1027 | Errors.push_back(EI.message()); |
1028 | }); |
1029 | return join(Errors.begin(), Errors.end(), "\n"); |
1030 | } |
1031 | |
1032 | |
1033 | |
1034 | |
1035 | |
1036 | |
1037 | |
1038 | |
1039 | inline void consumeError(Error Err) { |
1040 | handleAllErrors(std::move(Err), [](const ErrorInfoBase &) {}); |
1041 | } |
1042 | |
1043 | |
1044 | |
1045 | |
1046 | |
1047 | |
1048 | |
1049 | |
1050 | template <typename T> Optional<T> expectedToOptional(Expected<T> &&E) { |
1051 | if (E) |
1052 | return std::move(*E); |
1053 | consumeError(E.takeError()); |
1054 | return None; |
1055 | } |
1056 | |
1057 | |
1058 | |
1059 | |
1060 | |
1061 | |
1062 | inline bool errorToBool(Error Err) { |
1063 | bool IsError = static_cast<bool>(Err); |
1064 | if (IsError) |
1065 | consumeError(std::move(Err)); |
1066 | return IsError; |
1067 | } |
1068 | |
1069 | |
1070 | |
1071 | |
1072 | |
1073 | |
1074 | |
1075 | |
1076 | |
1077 | |
1078 | |
1079 | |
1080 | |
1081 | |
1082 | |
1083 | |
1084 | |
1085 | |
1086 | |
1087 | |
1088 | |
1089 | |
1090 | |
1091 | |
1092 | |
1093 | class ErrorAsOutParameter { |
1094 | public: |
1095 | ErrorAsOutParameter(Error *Err) : Err(Err) { |
1096 | |
1097 | if (Err) |
1098 | (void)!!*Err; |
1099 | } |
1100 | |
1101 | ~ErrorAsOutParameter() { |
1102 | |
1103 | if (Err && !*Err) |
1104 | *Err = Error::success(); |
1105 | } |
1106 | |
1107 | private: |
1108 | Error *Err; |
1109 | }; |
1110 | |
1111 | |
1112 | |
1113 | |
1114 | template <typename T> |
1115 | class ExpectedAsOutParameter { |
1116 | public: |
1117 | ExpectedAsOutParameter(Expected<T> *ValOrErr) |
1118 | : ValOrErr(ValOrErr) { |
1119 | if (ValOrErr) |
1120 | (void)!!*ValOrErr; |
1121 | } |
1122 | |
1123 | ~ExpectedAsOutParameter() { |
1124 | if (ValOrErr) |
1125 | ValOrErr->setUnchecked(); |
1126 | } |
1127 | |
1128 | private: |
1129 | Expected<T> *ValOrErr; |
1130 | }; |
1131 | |
1132 | |
1133 | |
1134 | |
1135 | |
1136 | |
1137 | class ECError : public ErrorInfo<ECError> { |
1138 | friend Error errorCodeToError(std::error_code); |
1139 | |
1140 | virtual void anchor() override; |
1141 | |
1142 | public: |
1143 | void setErrorCode(std::error_code EC) { this->EC = EC; } |
1144 | std::error_code convertToErrorCode() const override { return EC; } |
1145 | void log(raw_ostream &OS) const override { OS << EC.message(); } |
1146 | |
1147 | |
1148 | static char ID; |
1149 | |
1150 | protected: |
1151 | ECError() = default; |
1152 | ECError(std::error_code EC) : EC(EC) {} |
1153 | |
1154 | std::error_code EC; |
1155 | }; |
1156 | |
1157 | |
1158 | |
1159 | |
1160 | |
1161 | |
1162 | |
1163 | std::error_code inconvertibleErrorCode(); |
1164 | |
1165 | |
1166 | Error errorCodeToError(std::error_code EC); |
1167 | |
1168 | |
1169 | |
1170 | |
1171 | |
1172 | std::error_code errorToErrorCode(Error Err); |
1173 | |
1174 | |
1175 | template <typename T> Expected<T> errorOrToExpected(ErrorOr<T> &&EO) { |
1176 | if (auto EC = EO.getError()) |
1177 | return errorCodeToError(EC); |
1178 | return std::move(*EO); |
1179 | } |
1180 | |
1181 | |
1182 | template <typename T> ErrorOr<T> expectedToErrorOr(Expected<T> &&E) { |
1183 | if (auto Err = E.takeError()) |
1184 | return errorToErrorCode(std::move(Err)); |
1185 | return std::move(*E); |
1186 | } |
1187 | |
1188 | |
1189 | |
1190 | |
1191 | |
1192 | |
1193 | |
1194 | |
1195 | |
1196 | |
1197 | |
1198 | |
1199 | |
1200 | |
1201 | |
1202 | |
1203 | |
1204 | |
1205 | |
1206 | |
1207 | |
1208 | |
1209 | |
1210 | |
1211 | |
1212 | class StringError : public ErrorInfo<StringError> { |
1213 | public: |
1214 | static char ID; |
1215 | |
1216 | |
1217 | StringError(std::error_code EC, const Twine &S = Twine()); |
1218 | |
1219 | |
1220 | StringError(const Twine &S, std::error_code EC); |
1221 | |
1222 | void log(raw_ostream &OS) const override; |
1223 | std::error_code convertToErrorCode() const override; |
1224 | |
1225 | const std::string &getMessage() const { return Msg; } |
1226 | |
1227 | private: |
1228 | std::string Msg; |
1229 | std::error_code EC; |
1230 | const bool PrintMsgOnly = false; |
1231 | }; |
1232 | |
1233 | |
1234 | template <typename... Ts> |
1235 | inline Error createStringError(std::error_code EC, char const *Fmt, |
1236 | const Ts &... Vals) { |
1237 | std::string Buffer; |
1238 | raw_string_ostream Stream(Buffer); |
1239 | Stream << format(Fmt, Vals...); |
1240 | return make_error<StringError>(Stream.str(), EC); |
1241 | } |
1242 | |
1243 | Error createStringError(std::error_code EC, char const *Msg); |
1244 | |
1245 | inline Error createStringError(std::error_code EC, const Twine &S) { |
1246 | return createStringError(EC, S.str().c_str()); |
1247 | } |
1248 | |
1249 | template <typename... Ts> |
1250 | inline Error createStringError(std::errc EC, char const *Fmt, |
1251 | const Ts &... Vals) { |
1252 | return createStringError(std::make_error_code(EC), Fmt, Vals...); |
1253 | } |
1254 | |
1255 | |
1256 | |
1257 | |
1258 | |
1259 | class FileError final : public ErrorInfo<FileError> { |
1260 | |
1261 | friend Error createFileError(const Twine &, Error); |
1262 | friend Error createFileError(const Twine &, size_t, Error); |
1263 | |
1264 | public: |
1265 | void log(raw_ostream &OS) const override { |
1266 | assert(Err && !FileName.empty() && "Trying to log after takeError()."); |
1267 | OS << "'" << FileName << "': "; |
1268 | if (Line.hasValue()) |
1269 | OS << "line " << Line.getValue() << ": "; |
1270 | Err->log(OS); |
1271 | } |
1272 | |
1273 | StringRef getFileName() { return FileName; } |
1274 | |
1275 | Error takeError() { return Error(std::move(Err)); } |
1276 | |
1277 | std::error_code convertToErrorCode() const override; |
1278 | |
1279 | |
1280 | static char ID; |
1281 | |
1282 | private: |
1283 | FileError(const Twine &F, Optional<size_t> LineNum, |
1284 | std::unique_ptr<ErrorInfoBase> E) { |
1285 | assert(E && "Cannot create FileError from Error success value."); |
1286 | assert(!F.isTriviallyEmpty() && |
1287 | "The file name provided to FileError must not be empty."); |
1288 | FileName = F.str(); |
1289 | Err = std::move(E); |
1290 | Line = std::move(LineNum); |
1291 | } |
1292 | |
1293 | static Error build(const Twine &F, Optional<size_t> Line, Error E) { |
1294 | std::unique_ptr<ErrorInfoBase> Payload; |
1295 | handleAllErrors(std::move(E), |
1296 | [&](std::unique_ptr<ErrorInfoBase> EIB) -> Error { |
1297 | Payload = std::move(EIB); |
1298 | return Error::success(); |
1299 | }); |
1300 | return Error( |
1301 | std::unique_ptr<FileError>(new FileError(F, Line, std::move(Payload)))); |
1302 | } |
1303 | |
1304 | std::string FileName; |
1305 | Optional<size_t> Line; |
1306 | std::unique_ptr<ErrorInfoBase> Err; |
1307 | }; |
1308 | |
1309 | |
1310 | |
1311 | inline Error createFileError(const Twine &F, Error E) { |
1312 | return FileError::build(F, Optional<size_t>(), std::move(E)); |
1313 | } |
1314 | |
1315 | |
1316 | |
1317 | inline Error createFileError(const Twine &F, size_t Line, Error E) { |
1318 | return FileError::build(F, Optional<size_t>(Line), std::move(E)); |
1319 | } |
1320 | |
1321 | |
1322 | |
1323 | inline Error createFileError(const Twine &F, std::error_code EC) { |
1324 | return createFileError(F, errorCodeToError(EC)); |
1325 | } |
1326 | |
1327 | |
1328 | |
1329 | inline Error createFileError(const Twine &F, size_t Line, std::error_code EC) { |
1330 | return createFileError(F, Line, errorCodeToError(EC)); |
1331 | } |
1332 | |
1333 | Error createFileError(const Twine &F, ErrorSuccess) = delete; |
1334 | |
1335 | |
1336 | |
1337 | |
1338 | |
1339 | class ExitOnError { |
1340 | public: |
1341 | |
1342 | ExitOnError(std::string Banner = "", int DefaultErrorExitCode = 1) |
1343 | : Banner(std::move(Banner)), |
1344 | GetExitCode([=](const Error &) { return DefaultErrorExitCode; }) {} |
1345 | |
1346 | |
1347 | void setBanner(std::string Banner) { this->Banner = std::move(Banner); } |
1348 | |
1349 | |
1350 | void setExitCodeMapper(std::function<int(const Error &)> GetExitCode) { |
1351 | this->GetExitCode = std::move(GetExitCode); |
1352 | } |
1353 | |
1354 | |
1355 | void operator()(Error Err) const { checkError(std::move(Err)); } |
1356 | |
1357 | |
1358 | |
1359 | template <typename T> T operator()(Expected<T> &&E) const { |
1360 | checkError(E.takeError()); |
1361 | return std::move(*E); |
1362 | } |
1363 | |
1364 | |
1365 | |
1366 | template <typename T> T& operator()(Expected<T&> &&E) const { |
1367 | checkError(E.takeError()); |
1368 | return *E; |
1369 | } |
1370 | |
1371 | private: |
1372 | void checkError(Error Err) const { |
1373 | if (Err) { |
1374 | int ExitCode = GetExitCode(Err); |
1375 | logAllUnhandledErrors(std::move(Err), errs(), Banner); |
1376 | exit(ExitCode); |
1377 | } |
1378 | } |
1379 | |
1380 | std::string Banner; |
1381 | std::function<int(const Error &)> GetExitCode; |
1382 | }; |
1383 | |
1384 | |
1385 | inline LLVMErrorRef wrap(Error Err) { |
1386 | return reinterpret_cast<LLVMErrorRef>(Err.takePayload().release()); |
1387 | } |
1388 | |
1389 | |
1390 | inline Error unwrap(LLVMErrorRef ErrRef) { |
1391 | return Error(std::unique_ptr<ErrorInfoBase>( |
1392 | reinterpret_cast<ErrorInfoBase *>(ErrRef))); |
1393 | } |
1394 | |
1395 | } |
1396 | |
1397 | #endif // LLVM_SUPPORT_ERROR_H |