File: | llvm/include/llvm/Bitstream/BitstreamReader.h |
Warning: | line 220, column 39 The result of the right shift is undefined due to shifting by '64', which is greater or equal to the width of type 'llvm::SimpleBitstreamCursor::word_t' |
Press '?' to see keyboard shortcuts
Keyboard shortcuts:
1 | //===- BitcodeAnalyzer.cpp - Internal BitcodeAnalyzer implementation ------===// | |||
2 | // | |||
3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. | |||
4 | // See https://llvm.org/LICENSE.txt for license information. | |||
5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | |||
6 | // | |||
7 | //===----------------------------------------------------------------------===// | |||
8 | ||||
9 | #include "llvm/Bitcode/BitcodeAnalyzer.h" | |||
10 | #include "llvm/Bitcode/BitcodeReader.h" | |||
11 | #include "llvm/Bitcode/LLVMBitCodes.h" | |||
12 | #include "llvm/Bitstream/BitCodes.h" | |||
13 | #include "llvm/Bitstream/BitstreamReader.h" | |||
14 | #include "llvm/Support/Format.h" | |||
15 | #include "llvm/Support/SHA1.h" | |||
16 | ||||
17 | using namespace llvm; | |||
18 | ||||
19 | static Error reportError(StringRef Message) { | |||
20 | return createStringError(std::errc::illegal_byte_sequence, Message.data()); | |||
21 | } | |||
22 | ||||
23 | /// Return a symbolic block name if known, otherwise return null. | |||
24 | static Optional<const char *> GetBlockName(unsigned BlockID, | |||
25 | const BitstreamBlockInfo &BlockInfo, | |||
26 | CurStreamTypeType CurStreamType) { | |||
27 | // Standard blocks for all bitcode files. | |||
28 | if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) { | |||
29 | if (BlockID == bitc::BLOCKINFO_BLOCK_ID) | |||
30 | return "BLOCKINFO_BLOCK"; | |||
31 | return None; | |||
32 | } | |||
33 | ||||
34 | // Check to see if we have a blockinfo record for this block, with a name. | |||
35 | if (const BitstreamBlockInfo::BlockInfo *Info = | |||
36 | BlockInfo.getBlockInfo(BlockID)) { | |||
37 | if (!Info->Name.empty()) | |||
38 | return Info->Name.c_str(); | |||
39 | } | |||
40 | ||||
41 | if (CurStreamType != LLVMIRBitstream) | |||
42 | return None; | |||
43 | ||||
44 | switch (BlockID) { | |||
45 | default: | |||
46 | return None; | |||
47 | case bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID: | |||
48 | return "OPERAND_BUNDLE_TAGS_BLOCK"; | |||
49 | case bitc::MODULE_BLOCK_ID: | |||
50 | return "MODULE_BLOCK"; | |||
51 | case bitc::PARAMATTR_BLOCK_ID: | |||
52 | return "PARAMATTR_BLOCK"; | |||
53 | case bitc::PARAMATTR_GROUP_BLOCK_ID: | |||
54 | return "PARAMATTR_GROUP_BLOCK_ID"; | |||
55 | case bitc::TYPE_BLOCK_ID_NEW: | |||
56 | return "TYPE_BLOCK_ID"; | |||
57 | case bitc::CONSTANTS_BLOCK_ID: | |||
58 | return "CONSTANTS_BLOCK"; | |||
59 | case bitc::FUNCTION_BLOCK_ID: | |||
60 | return "FUNCTION_BLOCK"; | |||
61 | case bitc::IDENTIFICATION_BLOCK_ID: | |||
62 | return "IDENTIFICATION_BLOCK_ID"; | |||
63 | case bitc::VALUE_SYMTAB_BLOCK_ID: | |||
64 | return "VALUE_SYMTAB"; | |||
65 | case bitc::METADATA_BLOCK_ID: | |||
66 | return "METADATA_BLOCK"; | |||
67 | case bitc::METADATA_KIND_BLOCK_ID: | |||
68 | return "METADATA_KIND_BLOCK"; | |||
69 | case bitc::METADATA_ATTACHMENT_ID: | |||
70 | return "METADATA_ATTACHMENT_BLOCK"; | |||
71 | case bitc::USELIST_BLOCK_ID: | |||
72 | return "USELIST_BLOCK_ID"; | |||
73 | case bitc::GLOBALVAL_SUMMARY_BLOCK_ID: | |||
74 | return "GLOBALVAL_SUMMARY_BLOCK"; | |||
75 | case bitc::FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID: | |||
76 | return "FULL_LTO_GLOBALVAL_SUMMARY_BLOCK"; | |||
77 | case bitc::MODULE_STRTAB_BLOCK_ID: | |||
78 | return "MODULE_STRTAB_BLOCK"; | |||
79 | case bitc::STRTAB_BLOCK_ID: | |||
80 | return "STRTAB_BLOCK"; | |||
81 | case bitc::SYMTAB_BLOCK_ID: | |||
82 | return "SYMTAB_BLOCK"; | |||
83 | } | |||
84 | } | |||
85 | ||||
86 | /// Return a symbolic code name if known, otherwise return null. | |||
87 | static Optional<const char *> GetCodeName(unsigned CodeID, unsigned BlockID, | |||
88 | const BitstreamBlockInfo &BlockInfo, | |||
89 | CurStreamTypeType CurStreamType) { | |||
90 | // Standard blocks for all bitcode files. | |||
91 | if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) { | |||
92 | if (BlockID == bitc::BLOCKINFO_BLOCK_ID) { | |||
93 | switch (CodeID) { | |||
94 | default: | |||
95 | return None; | |||
96 | case bitc::BLOCKINFO_CODE_SETBID: | |||
97 | return "SETBID"; | |||
98 | case bitc::BLOCKINFO_CODE_BLOCKNAME: | |||
99 | return "BLOCKNAME"; | |||
100 | case bitc::BLOCKINFO_CODE_SETRECORDNAME: | |||
101 | return "SETRECORDNAME"; | |||
102 | } | |||
103 | } | |||
104 | return None; | |||
105 | } | |||
106 | ||||
107 | // Check to see if we have a blockinfo record for this record, with a name. | |||
108 | if (const BitstreamBlockInfo::BlockInfo *Info = | |||
109 | BlockInfo.getBlockInfo(BlockID)) { | |||
110 | for (unsigned i = 0, e = Info->RecordNames.size(); i != e; ++i) | |||
111 | if (Info->RecordNames[i].first == CodeID) | |||
112 | return Info->RecordNames[i].second.c_str(); | |||
113 | } | |||
114 | ||||
115 | if (CurStreamType != LLVMIRBitstream) | |||
116 | return None; | |||
117 | ||||
118 | #define STRINGIFY_CODE(PREFIX, CODE) \ | |||
119 | case bitc::PREFIX##_##CODE: \ | |||
120 | return #CODE; | |||
121 | switch (BlockID) { | |||
122 | default: | |||
123 | return None; | |||
124 | case bitc::MODULE_BLOCK_ID: | |||
125 | switch (CodeID) { | |||
126 | default: | |||
127 | return None; | |||
128 | STRINGIFY_CODE(MODULE_CODE, VERSION) | |||
129 | STRINGIFY_CODE(MODULE_CODE, TRIPLE) | |||
130 | STRINGIFY_CODE(MODULE_CODE, DATALAYOUT) | |||
131 | STRINGIFY_CODE(MODULE_CODE, ASM) | |||
132 | STRINGIFY_CODE(MODULE_CODE, SECTIONNAME) | |||
133 | STRINGIFY_CODE(MODULE_CODE, DEPLIB) // FIXME: Remove in 4.0 | |||
134 | STRINGIFY_CODE(MODULE_CODE, GLOBALVAR) | |||
135 | STRINGIFY_CODE(MODULE_CODE, FUNCTION) | |||
136 | STRINGIFY_CODE(MODULE_CODE, ALIAS) | |||
137 | STRINGIFY_CODE(MODULE_CODE, GCNAME) | |||
138 | STRINGIFY_CODE(MODULE_CODE, VSTOFFSET) | |||
139 | STRINGIFY_CODE(MODULE_CODE, METADATA_VALUES_UNUSED) | |||
140 | STRINGIFY_CODE(MODULE_CODE, SOURCE_FILENAME) | |||
141 | STRINGIFY_CODE(MODULE_CODE, HASH) | |||
142 | } | |||
143 | case bitc::IDENTIFICATION_BLOCK_ID: | |||
144 | switch (CodeID) { | |||
145 | default: | |||
146 | return None; | |||
147 | STRINGIFY_CODE(IDENTIFICATION_CODE, STRING) | |||
148 | STRINGIFY_CODE(IDENTIFICATION_CODE, EPOCH) | |||
149 | } | |||
150 | case bitc::PARAMATTR_BLOCK_ID: | |||
151 | switch (CodeID) { | |||
152 | default: | |||
153 | return None; | |||
154 | // FIXME: Should these be different? | |||
155 | case bitc::PARAMATTR_CODE_ENTRY_OLD: | |||
156 | return "ENTRY"; | |||
157 | case bitc::PARAMATTR_CODE_ENTRY: | |||
158 | return "ENTRY"; | |||
159 | } | |||
160 | case bitc::PARAMATTR_GROUP_BLOCK_ID: | |||
161 | switch (CodeID) { | |||
162 | default: | |||
163 | return None; | |||
164 | case bitc::PARAMATTR_GRP_CODE_ENTRY: | |||
165 | return "ENTRY"; | |||
166 | } | |||
167 | case bitc::TYPE_BLOCK_ID_NEW: | |||
168 | switch (CodeID) { | |||
169 | default: | |||
170 | return None; | |||
171 | STRINGIFY_CODE(TYPE_CODE, NUMENTRY) | |||
172 | STRINGIFY_CODE(TYPE_CODE, VOID) | |||
173 | STRINGIFY_CODE(TYPE_CODE, FLOAT) | |||
174 | STRINGIFY_CODE(TYPE_CODE, DOUBLE) | |||
175 | STRINGIFY_CODE(TYPE_CODE, LABEL) | |||
176 | STRINGIFY_CODE(TYPE_CODE, OPAQUE) | |||
177 | STRINGIFY_CODE(TYPE_CODE, INTEGER) | |||
178 | STRINGIFY_CODE(TYPE_CODE, POINTER) | |||
179 | STRINGIFY_CODE(TYPE_CODE, ARRAY) | |||
180 | STRINGIFY_CODE(TYPE_CODE, VECTOR) | |||
181 | STRINGIFY_CODE(TYPE_CODE, X86_FP80) | |||
182 | STRINGIFY_CODE(TYPE_CODE, FP128) | |||
183 | STRINGIFY_CODE(TYPE_CODE, PPC_FP128) | |||
184 | STRINGIFY_CODE(TYPE_CODE, METADATA) | |||
185 | STRINGIFY_CODE(TYPE_CODE, STRUCT_ANON) | |||
186 | STRINGIFY_CODE(TYPE_CODE, STRUCT_NAME) | |||
187 | STRINGIFY_CODE(TYPE_CODE, STRUCT_NAMED) | |||
188 | STRINGIFY_CODE(TYPE_CODE, FUNCTION) | |||
189 | } | |||
190 | ||||
191 | case bitc::CONSTANTS_BLOCK_ID: | |||
192 | switch (CodeID) { | |||
193 | default: | |||
194 | return None; | |||
195 | STRINGIFY_CODE(CST_CODE, SETTYPE) | |||
196 | STRINGIFY_CODE(CST_CODE, NULL__null) | |||
197 | STRINGIFY_CODE(CST_CODE, UNDEF) | |||
198 | STRINGIFY_CODE(CST_CODE, INTEGER) | |||
199 | STRINGIFY_CODE(CST_CODE, WIDE_INTEGER) | |||
200 | STRINGIFY_CODE(CST_CODE, FLOAT) | |||
201 | STRINGIFY_CODE(CST_CODE, AGGREGATE) | |||
202 | STRINGIFY_CODE(CST_CODE, STRING) | |||
203 | STRINGIFY_CODE(CST_CODE, CSTRING) | |||
204 | STRINGIFY_CODE(CST_CODE, CE_BINOP) | |||
205 | STRINGIFY_CODE(CST_CODE, CE_CAST) | |||
206 | STRINGIFY_CODE(CST_CODE, CE_GEP) | |||
207 | STRINGIFY_CODE(CST_CODE, CE_INBOUNDS_GEP) | |||
208 | STRINGIFY_CODE(CST_CODE, CE_SELECT) | |||
209 | STRINGIFY_CODE(CST_CODE, CE_EXTRACTELT) | |||
210 | STRINGIFY_CODE(CST_CODE, CE_INSERTELT) | |||
211 | STRINGIFY_CODE(CST_CODE, CE_SHUFFLEVEC) | |||
212 | STRINGIFY_CODE(CST_CODE, CE_CMP) | |||
213 | STRINGIFY_CODE(CST_CODE, INLINEASM) | |||
214 | STRINGIFY_CODE(CST_CODE, CE_SHUFVEC_EX) | |||
215 | STRINGIFY_CODE(CST_CODE, CE_UNOP) | |||
216 | case bitc::CST_CODE_BLOCKADDRESS: | |||
217 | return "CST_CODE_BLOCKADDRESS"; | |||
218 | STRINGIFY_CODE(CST_CODE, DATA) | |||
219 | } | |||
220 | case bitc::FUNCTION_BLOCK_ID: | |||
221 | switch (CodeID) { | |||
222 | default: | |||
223 | return None; | |||
224 | STRINGIFY_CODE(FUNC_CODE, DECLAREBLOCKS) | |||
225 | STRINGIFY_CODE(FUNC_CODE, INST_BINOP) | |||
226 | STRINGIFY_CODE(FUNC_CODE, INST_CAST) | |||
227 | STRINGIFY_CODE(FUNC_CODE, INST_GEP_OLD) | |||
228 | STRINGIFY_CODE(FUNC_CODE, INST_INBOUNDS_GEP_OLD) | |||
229 | STRINGIFY_CODE(FUNC_CODE, INST_SELECT) | |||
230 | STRINGIFY_CODE(FUNC_CODE, INST_EXTRACTELT) | |||
231 | STRINGIFY_CODE(FUNC_CODE, INST_INSERTELT) | |||
232 | STRINGIFY_CODE(FUNC_CODE, INST_SHUFFLEVEC) | |||
233 | STRINGIFY_CODE(FUNC_CODE, INST_CMP) | |||
234 | STRINGIFY_CODE(FUNC_CODE, INST_RET) | |||
235 | STRINGIFY_CODE(FUNC_CODE, INST_BR) | |||
236 | STRINGIFY_CODE(FUNC_CODE, INST_SWITCH) | |||
237 | STRINGIFY_CODE(FUNC_CODE, INST_INVOKE) | |||
238 | STRINGIFY_CODE(FUNC_CODE, INST_UNOP) | |||
239 | STRINGIFY_CODE(FUNC_CODE, INST_UNREACHABLE) | |||
240 | STRINGIFY_CODE(FUNC_CODE, INST_CLEANUPRET) | |||
241 | STRINGIFY_CODE(FUNC_CODE, INST_CATCHRET) | |||
242 | STRINGIFY_CODE(FUNC_CODE, INST_CATCHPAD) | |||
243 | STRINGIFY_CODE(FUNC_CODE, INST_PHI) | |||
244 | STRINGIFY_CODE(FUNC_CODE, INST_ALLOCA) | |||
245 | STRINGIFY_CODE(FUNC_CODE, INST_LOAD) | |||
246 | STRINGIFY_CODE(FUNC_CODE, INST_VAARG) | |||
247 | STRINGIFY_CODE(FUNC_CODE, INST_STORE) | |||
248 | STRINGIFY_CODE(FUNC_CODE, INST_EXTRACTVAL) | |||
249 | STRINGIFY_CODE(FUNC_CODE, INST_INSERTVAL) | |||
250 | STRINGIFY_CODE(FUNC_CODE, INST_CMP2) | |||
251 | STRINGIFY_CODE(FUNC_CODE, INST_VSELECT) | |||
252 | STRINGIFY_CODE(FUNC_CODE, DEBUG_LOC_AGAIN) | |||
253 | STRINGIFY_CODE(FUNC_CODE, INST_CALL) | |||
254 | STRINGIFY_CODE(FUNC_CODE, DEBUG_LOC) | |||
255 | STRINGIFY_CODE(FUNC_CODE, INST_GEP) | |||
256 | STRINGIFY_CODE(FUNC_CODE, OPERAND_BUNDLE) | |||
257 | STRINGIFY_CODE(FUNC_CODE, INST_FENCE) | |||
258 | STRINGIFY_CODE(FUNC_CODE, INST_ATOMICRMW) | |||
259 | STRINGIFY_CODE(FUNC_CODE, INST_LOADATOMIC) | |||
260 | STRINGIFY_CODE(FUNC_CODE, INST_STOREATOMIC) | |||
261 | STRINGIFY_CODE(FUNC_CODE, INST_CMPXCHG) | |||
262 | STRINGIFY_CODE(FUNC_CODE, INST_CALLBR) | |||
263 | } | |||
264 | case bitc::VALUE_SYMTAB_BLOCK_ID: | |||
265 | switch (CodeID) { | |||
266 | default: | |||
267 | return None; | |||
268 | STRINGIFY_CODE(VST_CODE, ENTRY) | |||
269 | STRINGIFY_CODE(VST_CODE, BBENTRY) | |||
270 | STRINGIFY_CODE(VST_CODE, FNENTRY) | |||
271 | STRINGIFY_CODE(VST_CODE, COMBINED_ENTRY) | |||
272 | } | |||
273 | case bitc::MODULE_STRTAB_BLOCK_ID: | |||
274 | switch (CodeID) { | |||
275 | default: | |||
276 | return None; | |||
277 | STRINGIFY_CODE(MST_CODE, ENTRY) | |||
278 | STRINGIFY_CODE(MST_CODE, HASH) | |||
279 | } | |||
280 | case bitc::GLOBALVAL_SUMMARY_BLOCK_ID: | |||
281 | case bitc::FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID: | |||
282 | switch (CodeID) { | |||
283 | default: | |||
284 | return None; | |||
285 | STRINGIFY_CODE(FS, PERMODULE) | |||
286 | STRINGIFY_CODE(FS, PERMODULE_PROFILE) | |||
287 | STRINGIFY_CODE(FS, PERMODULE_RELBF) | |||
288 | STRINGIFY_CODE(FS, PERMODULE_GLOBALVAR_INIT_REFS) | |||
289 | STRINGIFY_CODE(FS, PERMODULE_VTABLE_GLOBALVAR_INIT_REFS) | |||
290 | STRINGIFY_CODE(FS, COMBINED) | |||
291 | STRINGIFY_CODE(FS, COMBINED_PROFILE) | |||
292 | STRINGIFY_CODE(FS, COMBINED_GLOBALVAR_INIT_REFS) | |||
293 | STRINGIFY_CODE(FS, ALIAS) | |||
294 | STRINGIFY_CODE(FS, COMBINED_ALIAS) | |||
295 | STRINGIFY_CODE(FS, COMBINED_ORIGINAL_NAME) | |||
296 | STRINGIFY_CODE(FS, VERSION) | |||
297 | STRINGIFY_CODE(FS, FLAGS) | |||
298 | STRINGIFY_CODE(FS, TYPE_TESTS) | |||
299 | STRINGIFY_CODE(FS, TYPE_TEST_ASSUME_VCALLS) | |||
300 | STRINGIFY_CODE(FS, TYPE_CHECKED_LOAD_VCALLS) | |||
301 | STRINGIFY_CODE(FS, TYPE_TEST_ASSUME_CONST_VCALL) | |||
302 | STRINGIFY_CODE(FS, TYPE_CHECKED_LOAD_CONST_VCALL) | |||
303 | STRINGIFY_CODE(FS, VALUE_GUID) | |||
304 | STRINGIFY_CODE(FS, CFI_FUNCTION_DEFS) | |||
305 | STRINGIFY_CODE(FS, CFI_FUNCTION_DECLS) | |||
306 | STRINGIFY_CODE(FS, TYPE_ID) | |||
307 | STRINGIFY_CODE(FS, TYPE_ID_METADATA) | |||
308 | } | |||
309 | case bitc::METADATA_ATTACHMENT_ID: | |||
310 | switch (CodeID) { | |||
311 | default: | |||
312 | return None; | |||
313 | STRINGIFY_CODE(METADATA, ATTACHMENT) | |||
314 | } | |||
315 | case bitc::METADATA_BLOCK_ID: | |||
316 | switch (CodeID) { | |||
317 | default: | |||
318 | return None; | |||
319 | STRINGIFY_CODE(METADATA, STRING_OLD) | |||
320 | STRINGIFY_CODE(METADATA, VALUE) | |||
321 | STRINGIFY_CODE(METADATA, NODE) | |||
322 | STRINGIFY_CODE(METADATA, NAME) | |||
323 | STRINGIFY_CODE(METADATA, DISTINCT_NODE) | |||
324 | STRINGIFY_CODE(METADATA, KIND) // Older bitcode has it in a MODULE_BLOCK | |||
325 | STRINGIFY_CODE(METADATA, LOCATION) | |||
326 | STRINGIFY_CODE(METADATA, OLD_NODE) | |||
327 | STRINGIFY_CODE(METADATA, OLD_FN_NODE) | |||
328 | STRINGIFY_CODE(METADATA, NAMED_NODE) | |||
329 | STRINGIFY_CODE(METADATA, GENERIC_DEBUG) | |||
330 | STRINGIFY_CODE(METADATA, SUBRANGE) | |||
331 | STRINGIFY_CODE(METADATA, ENUMERATOR) | |||
332 | STRINGIFY_CODE(METADATA, BASIC_TYPE) | |||
333 | STRINGIFY_CODE(METADATA, FILE) | |||
334 | STRINGIFY_CODE(METADATA, DERIVED_TYPE) | |||
335 | STRINGIFY_CODE(METADATA, COMPOSITE_TYPE) | |||
336 | STRINGIFY_CODE(METADATA, SUBROUTINE_TYPE) | |||
337 | STRINGIFY_CODE(METADATA, COMPILE_UNIT) | |||
338 | STRINGIFY_CODE(METADATA, SUBPROGRAM) | |||
339 | STRINGIFY_CODE(METADATA, LEXICAL_BLOCK) | |||
340 | STRINGIFY_CODE(METADATA, LEXICAL_BLOCK_FILE) | |||
341 | STRINGIFY_CODE(METADATA, NAMESPACE) | |||
342 | STRINGIFY_CODE(METADATA, TEMPLATE_TYPE) | |||
343 | STRINGIFY_CODE(METADATA, TEMPLATE_VALUE) | |||
344 | STRINGIFY_CODE(METADATA, GLOBAL_VAR) | |||
345 | STRINGIFY_CODE(METADATA, LOCAL_VAR) | |||
346 | STRINGIFY_CODE(METADATA, EXPRESSION) | |||
347 | STRINGIFY_CODE(METADATA, OBJC_PROPERTY) | |||
348 | STRINGIFY_CODE(METADATA, IMPORTED_ENTITY) | |||
349 | STRINGIFY_CODE(METADATA, MODULE) | |||
350 | STRINGIFY_CODE(METADATA, MACRO) | |||
351 | STRINGIFY_CODE(METADATA, MACRO_FILE) | |||
352 | STRINGIFY_CODE(METADATA, STRINGS) | |||
353 | STRINGIFY_CODE(METADATA, GLOBAL_DECL_ATTACHMENT) | |||
354 | STRINGIFY_CODE(METADATA, GLOBAL_VAR_EXPR) | |||
355 | STRINGIFY_CODE(METADATA, INDEX_OFFSET) | |||
356 | STRINGIFY_CODE(METADATA, INDEX) | |||
357 | } | |||
358 | case bitc::METADATA_KIND_BLOCK_ID: | |||
359 | switch (CodeID) { | |||
360 | default: | |||
361 | return None; | |||
362 | STRINGIFY_CODE(METADATA, KIND) | |||
363 | } | |||
364 | case bitc::USELIST_BLOCK_ID: | |||
365 | switch (CodeID) { | |||
366 | default: | |||
367 | return None; | |||
368 | case bitc::USELIST_CODE_DEFAULT: | |||
369 | return "USELIST_CODE_DEFAULT"; | |||
370 | case bitc::USELIST_CODE_BB: | |||
371 | return "USELIST_CODE_BB"; | |||
372 | } | |||
373 | ||||
374 | case bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID: | |||
375 | switch (CodeID) { | |||
376 | default: | |||
377 | return None; | |||
378 | case bitc::OPERAND_BUNDLE_TAG: | |||
379 | return "OPERAND_BUNDLE_TAG"; | |||
380 | } | |||
381 | case bitc::STRTAB_BLOCK_ID: | |||
382 | switch (CodeID) { | |||
383 | default: | |||
384 | return None; | |||
385 | case bitc::STRTAB_BLOB: | |||
386 | return "BLOB"; | |||
387 | } | |||
388 | case bitc::SYMTAB_BLOCK_ID: | |||
389 | switch (CodeID) { | |||
390 | default: | |||
391 | return None; | |||
392 | case bitc::SYMTAB_BLOB: | |||
393 | return "BLOB"; | |||
394 | } | |||
395 | } | |||
396 | #undef STRINGIFY_CODE | |||
397 | } | |||
398 | ||||
399 | static void printSize(raw_ostream &OS, double Bits) { | |||
400 | OS << format("%.2f/%.2fB/%luW", Bits, Bits / 8, (unsigned long)(Bits / 32)); | |||
401 | } | |||
402 | static void printSize(raw_ostream &OS, uint64_t Bits) { | |||
403 | OS << format("%lub/%.2fB/%luW", (unsigned long)Bits, (double)Bits / 8, | |||
404 | (unsigned long)(Bits / 32)); | |||
405 | } | |||
406 | ||||
407 | static Expected<CurStreamTypeType> ReadSignature(BitstreamCursor &Stream) { | |||
408 | auto tryRead = [&Stream](char &Dest, size_t size) -> Error { | |||
409 | if (Expected<SimpleBitstreamCursor::word_t> MaybeWord = Stream.Read(size)) | |||
410 | Dest = MaybeWord.get(); | |||
411 | else | |||
412 | return MaybeWord.takeError(); | |||
413 | return Error::success(); | |||
414 | }; | |||
415 | ||||
416 | char Signature[6]; | |||
417 | if (Error Err = tryRead(Signature[0], 8)) | |||
418 | return std::move(Err); | |||
419 | if (Error Err = tryRead(Signature[1], 8)) | |||
420 | return std::move(Err); | |||
421 | ||||
422 | // Autodetect the file contents, if it is one we know. | |||
423 | if (Signature[0] == 'C' && Signature[1] == 'P') { | |||
424 | if (Error Err = tryRead(Signature[2], 8)) | |||
425 | return std::move(Err); | |||
426 | if (Error Err = tryRead(Signature[3], 8)) | |||
427 | return std::move(Err); | |||
428 | if (Signature[2] == 'C' && Signature[3] == 'H') | |||
429 | return ClangSerializedASTBitstream; | |||
430 | } else if (Signature[0] == 'D' && Signature[1] == 'I') { | |||
431 | if (Error Err = tryRead(Signature[2], 8)) | |||
432 | return std::move(Err); | |||
433 | if (Error Err = tryRead(Signature[3], 8)) | |||
434 | return std::move(Err); | |||
435 | if (Signature[2] == 'A' && Signature[3] == 'G') | |||
436 | return ClangSerializedDiagnosticsBitstream; | |||
437 | } else if (Signature[0] == 'R' && Signature[1] == 'M') { | |||
438 | if (Error Err = tryRead(Signature[2], 8)) | |||
439 | return std::move(Err); | |||
440 | if (Error Err = tryRead(Signature[3], 8)) | |||
441 | return std::move(Err); | |||
442 | if (Signature[2] == 'R' && Signature[3] == 'K') | |||
443 | return LLVMBitstreamRemarks; | |||
444 | } else { | |||
445 | if (Error Err = tryRead(Signature[2], 4)) | |||
446 | return std::move(Err); | |||
447 | if (Error Err = tryRead(Signature[3], 4)) | |||
448 | return std::move(Err); | |||
449 | if (Error Err = tryRead(Signature[4], 4)) | |||
450 | return std::move(Err); | |||
451 | if (Error Err = tryRead(Signature[5], 4)) | |||
452 | return std::move(Err); | |||
453 | if (Signature[0] == 'B' && Signature[1] == 'C' && Signature[2] == 0x0 && | |||
454 | Signature[3] == 0xC && Signature[4] == 0xE && Signature[5] == 0xD) | |||
455 | return LLVMIRBitstream; | |||
456 | } | |||
457 | return UnknownBitstream; | |||
458 | } | |||
459 | ||||
460 | static Expected<CurStreamTypeType> analyzeHeader(Optional<BCDumpOptions> O, | |||
461 | BitstreamCursor &Stream) { | |||
462 | ArrayRef<uint8_t> Bytes = Stream.getBitcodeBytes(); | |||
463 | const unsigned char *BufPtr = (const unsigned char *)Bytes.data(); | |||
464 | const unsigned char *EndBufPtr = BufPtr + Bytes.size(); | |||
465 | ||||
466 | // If we have a wrapper header, parse it and ignore the non-bc file | |||
467 | // contents. The magic number is 0x0B17C0DE stored in little endian. | |||
468 | if (isBitcodeWrapper(BufPtr, EndBufPtr)) { | |||
469 | if (Bytes.size() < BWH_HeaderSize) | |||
470 | return reportError("Invalid bitcode wrapper header"); | |||
471 | ||||
472 | if (O) { | |||
473 | unsigned Magic = support::endian::read32le(&BufPtr[BWH_MagicField]); | |||
474 | unsigned Version = support::endian::read32le(&BufPtr[BWH_VersionField]); | |||
475 | unsigned Offset = support::endian::read32le(&BufPtr[BWH_OffsetField]); | |||
476 | unsigned Size = support::endian::read32le(&BufPtr[BWH_SizeField]); | |||
477 | unsigned CPUType = support::endian::read32le(&BufPtr[BWH_CPUTypeField]); | |||
478 | ||||
479 | O->OS << "<BITCODE_WRAPPER_HEADER" | |||
480 | << " Magic=" << format_hex(Magic, 10) | |||
481 | << " Version=" << format_hex(Version, 10) | |||
482 | << " Offset=" << format_hex(Offset, 10) | |||
483 | << " Size=" << format_hex(Size, 10) | |||
484 | << " CPUType=" << format_hex(CPUType, 10) << "/>\n"; | |||
485 | } | |||
486 | ||||
487 | if (SkipBitcodeWrapperHeader(BufPtr, EndBufPtr, true)) | |||
488 | return reportError("Invalid bitcode wrapper header"); | |||
489 | } | |||
490 | ||||
491 | // Use the cursor modified by skipping the wrapper header. | |||
492 | Stream = BitstreamCursor(ArrayRef<uint8_t>(BufPtr, EndBufPtr)); | |||
493 | ||||
494 | return ReadSignature(Stream); | |||
495 | } | |||
496 | ||||
497 | static bool canDecodeBlob(unsigned Code, unsigned BlockID) { | |||
498 | return BlockID == bitc::METADATA_BLOCK_ID && Code == bitc::METADATA_STRINGS; | |||
499 | } | |||
500 | ||||
501 | Error BitcodeAnalyzer::decodeMetadataStringsBlob(StringRef Indent, | |||
502 | ArrayRef<uint64_t> Record, | |||
503 | StringRef Blob, | |||
504 | raw_ostream &OS) { | |||
505 | if (Blob.empty()) | |||
506 | return reportError("Cannot decode empty blob."); | |||
507 | ||||
508 | if (Record.size() != 2) | |||
509 | return reportError( | |||
510 | "Decoding metadata strings blob needs two record entries."); | |||
511 | ||||
512 | unsigned NumStrings = Record[0]; | |||
513 | unsigned StringsOffset = Record[1]; | |||
514 | OS << " num-strings = " << NumStrings << " {\n"; | |||
515 | ||||
516 | StringRef Lengths = Blob.slice(0, StringsOffset); | |||
517 | SimpleBitstreamCursor R(Lengths); | |||
518 | StringRef Strings = Blob.drop_front(StringsOffset); | |||
519 | do { | |||
520 | if (R.AtEndOfStream()) | |||
521 | return reportError("bad length"); | |||
522 | ||||
523 | Expected<uint32_t> MaybeSize = R.ReadVBR(6); | |||
524 | if (!MaybeSize) | |||
525 | return MaybeSize.takeError(); | |||
526 | uint32_t Size = MaybeSize.get(); | |||
527 | if (Strings.size() < Size) | |||
528 | return reportError("truncated chars"); | |||
529 | ||||
530 | OS << Indent << " '"; | |||
531 | OS.write_escaped(Strings.slice(0, Size), /*hex=*/true); | |||
532 | OS << "'\n"; | |||
533 | Strings = Strings.drop_front(Size); | |||
534 | } while (--NumStrings); | |||
535 | ||||
536 | OS << Indent << " }"; | |||
537 | return Error::success(); | |||
538 | } | |||
539 | ||||
540 | BitcodeAnalyzer::BitcodeAnalyzer(StringRef Buffer, | |||
541 | Optional<StringRef> BlockInfoBuffer) | |||
542 | : Stream(Buffer) { | |||
543 | if (BlockInfoBuffer) | |||
544 | BlockInfoStream.emplace(*BlockInfoBuffer); | |||
545 | } | |||
546 | ||||
547 | Error BitcodeAnalyzer::analyze(Optional<BCDumpOptions> O, | |||
548 | Optional<StringRef> CheckHash) { | |||
549 | Expected<CurStreamTypeType> MaybeType = analyzeHeader(O, Stream); | |||
550 | if (!MaybeType) | |||
551 | return MaybeType.takeError(); | |||
552 | else | |||
553 | CurStreamType = *MaybeType; | |||
554 | ||||
555 | Stream.setBlockInfo(&BlockInfo); | |||
556 | ||||
557 | // Read block info from BlockInfoStream, if specified. | |||
558 | // The block info must be a top-level block. | |||
559 | if (BlockInfoStream) { | |||
560 | BitstreamCursor BlockInfoCursor(*BlockInfoStream); | |||
561 | Expected<CurStreamTypeType> H = analyzeHeader(O, BlockInfoCursor); | |||
562 | if (!H) | |||
563 | return H.takeError(); | |||
564 | ||||
565 | while (!BlockInfoCursor.AtEndOfStream()) { | |||
566 | Expected<unsigned> MaybeCode = BlockInfoCursor.ReadCode(); | |||
567 | if (!MaybeCode) | |||
568 | return MaybeCode.takeError(); | |||
569 | if (MaybeCode.get() != bitc::ENTER_SUBBLOCK) | |||
570 | return reportError("Invalid record at top-level in block info file"); | |||
571 | ||||
572 | Expected<unsigned> MaybeBlockID = BlockInfoCursor.ReadSubBlockID(); | |||
573 | if (!MaybeBlockID) | |||
574 | return MaybeBlockID.takeError(); | |||
575 | if (MaybeBlockID.get() == bitc::BLOCKINFO_BLOCK_ID) { | |||
576 | Expected<Optional<BitstreamBlockInfo>> MaybeNewBlockInfo = | |||
577 | BlockInfoCursor.ReadBlockInfoBlock(/*ReadBlockInfoNames=*/true); | |||
578 | if (!MaybeNewBlockInfo) | |||
579 | return MaybeNewBlockInfo.takeError(); | |||
580 | Optional<BitstreamBlockInfo> NewBlockInfo = | |||
581 | std::move(MaybeNewBlockInfo.get()); | |||
582 | if (!NewBlockInfo) | |||
583 | return reportError("Malformed BlockInfoBlock in block info file"); | |||
584 | BlockInfo = std::move(*NewBlockInfo); | |||
585 | break; | |||
586 | } | |||
587 | ||||
588 | if (Error Err = BlockInfoCursor.SkipBlock()) | |||
589 | return Err; | |||
590 | } | |||
591 | } | |||
592 | ||||
593 | // Parse the top-level structure. We only allow blocks at the top-level. | |||
594 | while (!Stream.AtEndOfStream()) { | |||
595 | Expected<unsigned> MaybeCode = Stream.ReadCode(); | |||
596 | if (!MaybeCode) | |||
597 | return MaybeCode.takeError(); | |||
598 | if (MaybeCode.get() != bitc::ENTER_SUBBLOCK) | |||
599 | return reportError("Invalid record at top-level"); | |||
600 | ||||
601 | Expected<unsigned> MaybeBlockID = Stream.ReadSubBlockID(); | |||
602 | if (!MaybeBlockID) | |||
603 | return MaybeBlockID.takeError(); | |||
604 | ||||
605 | if (Error E = parseBlock(MaybeBlockID.get(), 0, O, CheckHash)) | |||
606 | return E; | |||
607 | ++NumTopBlocks; | |||
608 | } | |||
609 | ||||
610 | return Error::success(); | |||
611 | } | |||
612 | ||||
613 | void BitcodeAnalyzer::printStats(BCDumpOptions O, | |||
614 | Optional<StringRef> Filename) { | |||
615 | uint64_t BufferSizeBits = Stream.getBitcodeBytes().size() * CHAR_BIT8; | |||
616 | // Print a summary of the read file. | |||
617 | O.OS << "Summary "; | |||
618 | if (Filename) | |||
619 | O.OS << "of " << Filename->data() << ":\n"; | |||
620 | O.OS << " Total size: "; | |||
621 | printSize(O.OS, BufferSizeBits); | |||
622 | O.OS << "\n"; | |||
623 | O.OS << " Stream type: "; | |||
624 | switch (CurStreamType) { | |||
625 | case UnknownBitstream: | |||
626 | O.OS << "unknown\n"; | |||
627 | break; | |||
628 | case LLVMIRBitstream: | |||
629 | O.OS << "LLVM IR\n"; | |||
630 | break; | |||
631 | case ClangSerializedASTBitstream: | |||
632 | O.OS << "Clang Serialized AST\n"; | |||
633 | break; | |||
634 | case ClangSerializedDiagnosticsBitstream: | |||
635 | O.OS << "Clang Serialized Diagnostics\n"; | |||
636 | break; | |||
637 | case LLVMBitstreamRemarks: | |||
638 | O.OS << "LLVM Remarks\n"; | |||
639 | break; | |||
640 | } | |||
641 | O.OS << " # Toplevel Blocks: " << NumTopBlocks << "\n"; | |||
642 | O.OS << "\n"; | |||
643 | ||||
644 | // Emit per-block stats. | |||
645 | O.OS << "Per-block Summary:\n"; | |||
646 | for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(), | |||
647 | E = BlockIDStats.end(); | |||
648 | I != E; ++I) { | |||
649 | O.OS << " Block ID #" << I->first; | |||
650 | if (Optional<const char *> BlockName = | |||
651 | GetBlockName(I->first, BlockInfo, CurStreamType)) | |||
652 | O.OS << " (" << *BlockName << ")"; | |||
653 | O.OS << ":\n"; | |||
654 | ||||
655 | const PerBlockIDStats &Stats = I->second; | |||
656 | O.OS << " Num Instances: " << Stats.NumInstances << "\n"; | |||
657 | O.OS << " Total Size: "; | |||
658 | printSize(O.OS, Stats.NumBits); | |||
659 | O.OS << "\n"; | |||
660 | double pct = (Stats.NumBits * 100.0) / BufferSizeBits; | |||
661 | O.OS << " Percent of file: " << format("%2.4f%%", pct) << "\n"; | |||
662 | if (Stats.NumInstances > 1) { | |||
663 | O.OS << " Average Size: "; | |||
664 | printSize(O.OS, Stats.NumBits / (double)Stats.NumInstances); | |||
665 | O.OS << "\n"; | |||
666 | O.OS << " Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/" | |||
667 | << Stats.NumSubBlocks / (double)Stats.NumInstances << "\n"; | |||
668 | O.OS << " Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/" | |||
669 | << Stats.NumAbbrevs / (double)Stats.NumInstances << "\n"; | |||
670 | O.OS << " Tot/Avg Records: " << Stats.NumRecords << "/" | |||
671 | << Stats.NumRecords / (double)Stats.NumInstances << "\n"; | |||
672 | } else { | |||
673 | O.OS << " Num SubBlocks: " << Stats.NumSubBlocks << "\n"; | |||
674 | O.OS << " Num Abbrevs: " << Stats.NumAbbrevs << "\n"; | |||
675 | O.OS << " Num Records: " << Stats.NumRecords << "\n"; | |||
676 | } | |||
677 | if (Stats.NumRecords) { | |||
678 | double pct = (Stats.NumAbbreviatedRecords * 100.0) / Stats.NumRecords; | |||
679 | O.OS << " Percent Abbrevs: " << format("%2.4f%%", pct) << "\n"; | |||
680 | } | |||
681 | O.OS << "\n"; | |||
682 | ||||
683 | // Print a histogram of the codes we see. | |||
684 | if (O.Histogram && !Stats.CodeFreq.empty()) { | |||
685 | std::vector<std::pair<unsigned, unsigned>> FreqPairs; // <freq,code> | |||
686 | for (unsigned i = 0, e = Stats.CodeFreq.size(); i != e; ++i) | |||
687 | if (unsigned Freq = Stats.CodeFreq[i].NumInstances) | |||
688 | FreqPairs.push_back(std::make_pair(Freq, i)); | |||
689 | llvm::stable_sort(FreqPairs); | |||
690 | std::reverse(FreqPairs.begin(), FreqPairs.end()); | |||
691 | ||||
692 | O.OS << "\tRecord Histogram:\n"; | |||
693 | O.OS << "\t\t Count # Bits b/Rec % Abv Record Kind\n"; | |||
694 | for (unsigned i = 0, e = FreqPairs.size(); i != e; ++i) { | |||
695 | const PerRecordStats &RecStats = Stats.CodeFreq[FreqPairs[i].second]; | |||
696 | ||||
697 | O.OS << format("\t\t%7d %9lu", RecStats.NumInstances, | |||
698 | (unsigned long)RecStats.TotalBits); | |||
699 | ||||
700 | if (RecStats.NumInstances > 1) | |||
701 | O.OS << format(" %9.1f", | |||
702 | (double)RecStats.TotalBits / RecStats.NumInstances); | |||
703 | else | |||
704 | O.OS << " "; | |||
705 | ||||
706 | if (RecStats.NumAbbrev) | |||
707 | O.OS << format(" %7.2f", (double)RecStats.NumAbbrev / | |||
708 | RecStats.NumInstances * 100); | |||
709 | else | |||
710 | O.OS << " "; | |||
711 | ||||
712 | O.OS << " "; | |||
713 | if (Optional<const char *> CodeName = GetCodeName( | |||
714 | FreqPairs[i].second, I->first, BlockInfo, CurStreamType)) | |||
715 | O.OS << *CodeName << "\n"; | |||
716 | else | |||
717 | O.OS << "UnknownCode" << FreqPairs[i].second << "\n"; | |||
718 | } | |||
719 | O.OS << "\n"; | |||
720 | } | |||
721 | } | |||
722 | } | |||
723 | ||||
724 | Error BitcodeAnalyzer::parseBlock(unsigned BlockID, unsigned IndentLevel, | |||
725 | Optional<BCDumpOptions> O, | |||
726 | Optional<StringRef> CheckHash) { | |||
727 | std::string Indent(IndentLevel * 2, ' '); | |||
728 | uint64_t BlockBitStart = Stream.GetCurrentBitNo(); | |||
729 | ||||
730 | // Get the statistics for this BlockID. | |||
731 | PerBlockIDStats &BlockStats = BlockIDStats[BlockID]; | |||
732 | ||||
733 | BlockStats.NumInstances++; | |||
734 | ||||
735 | // BLOCKINFO is a special part of the stream. | |||
736 | bool DumpRecords = O.hasValue(); | |||
737 | if (BlockID == bitc::BLOCKINFO_BLOCK_ID) { | |||
| ||||
738 | if (O) | |||
739 | O->OS << Indent << "<BLOCKINFO_BLOCK/>\n"; | |||
740 | Expected<Optional<BitstreamBlockInfo>> MaybeNewBlockInfo = | |||
741 | Stream.ReadBlockInfoBlock(/*ReadBlockInfoNames=*/true); | |||
742 | if (!MaybeNewBlockInfo) | |||
743 | return MaybeNewBlockInfo.takeError(); | |||
744 | Optional<BitstreamBlockInfo> NewBlockInfo = | |||
745 | std::move(MaybeNewBlockInfo.get()); | |||
746 | if (!NewBlockInfo) | |||
747 | return reportError("Malformed BlockInfoBlock"); | |||
748 | BlockInfo = std::move(*NewBlockInfo); | |||
749 | if (Error Err = Stream.JumpToBit(BlockBitStart)) | |||
750 | return Err; | |||
751 | // It's not really interesting to dump the contents of the blockinfo | |||
752 | // block. | |||
753 | DumpRecords = false; | |||
754 | } | |||
755 | ||||
756 | unsigned NumWords = 0; | |||
757 | if (Error Err = Stream.EnterSubBlock(BlockID, &NumWords)) | |||
758 | return Err; | |||
759 | ||||
760 | // Keep it for later, when we see a MODULE_HASH record | |||
761 | uint64_t BlockEntryPos = Stream.getCurrentByteNo(); | |||
762 | ||||
763 | Optional<const char *> BlockName = None; | |||
764 | if (DumpRecords) { | |||
765 | O->OS << Indent << "<"; | |||
766 | if ((BlockName = GetBlockName(BlockID, BlockInfo, CurStreamType))) | |||
767 | O->OS << *BlockName; | |||
768 | else | |||
769 | O->OS << "UnknownBlock" << BlockID; | |||
770 | ||||
771 | if (!O->Symbolic && BlockName) | |||
772 | O->OS << " BlockID=" << BlockID; | |||
773 | ||||
774 | O->OS << " NumWords=" << NumWords | |||
775 | << " BlockCodeSize=" << Stream.getAbbrevIDWidth() << ">\n"; | |||
776 | } | |||
777 | ||||
778 | SmallVector<uint64_t, 64> Record; | |||
779 | ||||
780 | // Keep the offset to the metadata index if seen. | |||
781 | uint64_t MetadataIndexOffset = 0; | |||
782 | ||||
783 | // Read all the records for this block. | |||
784 | while (1) { | |||
785 | if (Stream.AtEndOfStream()) | |||
786 | return reportError("Premature end of bitstream"); | |||
787 | ||||
788 | uint64_t RecordStartBit = Stream.GetCurrentBitNo(); | |||
789 | ||||
790 | Expected<BitstreamEntry> MaybeEntry = | |||
791 | Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs); | |||
792 | if (!MaybeEntry) | |||
793 | return MaybeEntry.takeError(); | |||
794 | BitstreamEntry Entry = MaybeEntry.get(); | |||
795 | ||||
796 | switch (Entry.Kind) { | |||
797 | case BitstreamEntry::Error: | |||
798 | return reportError("malformed bitcode file"); | |||
799 | case BitstreamEntry::EndBlock: { | |||
800 | uint64_t BlockBitEnd = Stream.GetCurrentBitNo(); | |||
801 | BlockStats.NumBits += BlockBitEnd - BlockBitStart; | |||
802 | if (DumpRecords) { | |||
803 | O->OS << Indent << "</"; | |||
804 | if (BlockName) | |||
805 | O->OS << *BlockName << ">\n"; | |||
806 | else | |||
807 | O->OS << "UnknownBlock" << BlockID << ">\n"; | |||
808 | } | |||
809 | return Error::success(); | |||
810 | } | |||
811 | ||||
812 | case BitstreamEntry::SubBlock: { | |||
813 | uint64_t SubBlockBitStart = Stream.GetCurrentBitNo(); | |||
814 | if (Error E = parseBlock(Entry.ID, IndentLevel + 1, O, CheckHash)) | |||
815 | return E; | |||
816 | ++BlockStats.NumSubBlocks; | |||
817 | uint64_t SubBlockBitEnd = Stream.GetCurrentBitNo(); | |||
818 | ||||
819 | // Don't include subblock sizes in the size of this block. | |||
820 | BlockBitStart += SubBlockBitEnd - SubBlockBitStart; | |||
821 | continue; | |||
822 | } | |||
823 | case BitstreamEntry::Record: | |||
824 | // The interesting case. | |||
825 | break; | |||
826 | } | |||
827 | ||||
828 | if (Entry.ID == bitc::DEFINE_ABBREV) { | |||
829 | if (Error Err = Stream.ReadAbbrevRecord()) | |||
830 | return Err; | |||
831 | ++BlockStats.NumAbbrevs; | |||
832 | continue; | |||
833 | } | |||
834 | ||||
835 | Record.clear(); | |||
836 | ||||
837 | ++BlockStats.NumRecords; | |||
838 | ||||
839 | StringRef Blob; | |||
840 | uint64_t CurrentRecordPos = Stream.GetCurrentBitNo(); | |||
841 | Expected<unsigned> MaybeCode = Stream.readRecord(Entry.ID, Record, &Blob); | |||
842 | if (!MaybeCode) | |||
843 | return MaybeCode.takeError(); | |||
844 | unsigned Code = MaybeCode.get(); | |||
845 | ||||
846 | // Increment the # occurrences of this code. | |||
847 | if (BlockStats.CodeFreq.size() <= Code) | |||
848 | BlockStats.CodeFreq.resize(Code + 1); | |||
849 | BlockStats.CodeFreq[Code].NumInstances++; | |||
850 | BlockStats.CodeFreq[Code].TotalBits += | |||
851 | Stream.GetCurrentBitNo() - RecordStartBit; | |||
852 | if (Entry.ID != bitc::UNABBREV_RECORD) { | |||
853 | BlockStats.CodeFreq[Code].NumAbbrev++; | |||
854 | ++BlockStats.NumAbbreviatedRecords; | |||
855 | } | |||
856 | ||||
857 | if (DumpRecords) { | |||
858 | O->OS << Indent << " <"; | |||
859 | Optional<const char *> CodeName = | |||
860 | GetCodeName(Code, BlockID, BlockInfo, CurStreamType); | |||
861 | if (CodeName) | |||
862 | O->OS << *CodeName; | |||
863 | else | |||
864 | O->OS << "UnknownCode" << Code; | |||
865 | if (!O->Symbolic && CodeName) | |||
866 | O->OS << " codeid=" << Code; | |||
867 | const BitCodeAbbrev *Abbv = nullptr; | |||
868 | if (Entry.ID != bitc::UNABBREV_RECORD) { | |||
869 | Abbv = Stream.getAbbrev(Entry.ID); | |||
870 | O->OS << " abbrevid=" << Entry.ID; | |||
871 | } | |||
872 | ||||
873 | for (unsigned i = 0, e = Record.size(); i != e; ++i) | |||
874 | O->OS << " op" << i << "=" << (int64_t)Record[i]; | |||
875 | ||||
876 | // If we found a metadata index, let's verify that we had an offset | |||
877 | // before and validate its forward reference offset was correct! | |||
878 | if (BlockID == bitc::METADATA_BLOCK_ID) { | |||
879 | if (Code == bitc::METADATA_INDEX_OFFSET) { | |||
880 | if (Record.size() != 2) | |||
881 | O->OS << "(Invalid record)"; | |||
882 | else { | |||
883 | auto Offset = Record[0] + (Record[1] << 32); | |||
884 | MetadataIndexOffset = Stream.GetCurrentBitNo() + Offset; | |||
885 | } | |||
886 | } | |||
887 | if (Code == bitc::METADATA_INDEX) { | |||
888 | O->OS << " (offset "; | |||
889 | if (MetadataIndexOffset == RecordStartBit) | |||
890 | O->OS << "match)"; | |||
891 | else | |||
892 | O->OS << "mismatch: " << MetadataIndexOffset << " vs " | |||
893 | << RecordStartBit << ")"; | |||
894 | } | |||
895 | } | |||
896 | ||||
897 | // If we found a module hash, let's verify that it matches! | |||
898 | if (BlockID == bitc::MODULE_BLOCK_ID && Code == bitc::MODULE_CODE_HASH && | |||
899 | CheckHash.hasValue()) { | |||
900 | if (Record.size() != 5) | |||
901 | O->OS << " (invalid)"; | |||
902 | else { | |||
903 | // Recompute the hash and compare it to the one in the bitcode | |||
904 | SHA1 Hasher; | |||
905 | StringRef Hash; | |||
906 | Hasher.update(*CheckHash); | |||
907 | { | |||
908 | int BlockSize = (CurrentRecordPos / 8) - BlockEntryPos; | |||
909 | auto Ptr = Stream.getPointerToByte(BlockEntryPos, BlockSize); | |||
910 | Hasher.update(ArrayRef<uint8_t>(Ptr, BlockSize)); | |||
911 | Hash = Hasher.result(); | |||
912 | } | |||
913 | SmallString<20> RecordedHash; | |||
914 | RecordedHash.resize(20); | |||
915 | int Pos = 0; | |||
916 | for (auto &Val : Record) { | |||
917 | assert(!(Val >> 32) && "Unexpected high bits set")((!(Val >> 32) && "Unexpected high bits set") ? static_cast<void> (0) : __assert_fail ("!(Val >> 32) && \"Unexpected high bits set\"" , "/build/llvm-toolchain-snapshot-10~+201911111502510600c19528f1809/llvm/lib/Bitcode/Reader/BitcodeAnalyzer.cpp" , 917, __PRETTY_FUNCTION__)); | |||
918 | RecordedHash[Pos++] = (Val >> 24) & 0xFF; | |||
919 | RecordedHash[Pos++] = (Val >> 16) & 0xFF; | |||
920 | RecordedHash[Pos++] = (Val >> 8) & 0xFF; | |||
921 | RecordedHash[Pos++] = (Val >> 0) & 0xFF; | |||
922 | } | |||
923 | if (Hash == RecordedHash) | |||
924 | O->OS << " (match)"; | |||
925 | else | |||
926 | O->OS << " (!mismatch!)"; | |||
927 | } | |||
928 | } | |||
929 | ||||
930 | O->OS << "/>"; | |||
931 | ||||
932 | if (Abbv) { | |||
933 | for (unsigned i = 1, e = Abbv->getNumOperandInfos(); i != e; ++i) { | |||
934 | const BitCodeAbbrevOp &Op = Abbv->getOperandInfo(i); | |||
935 | if (!Op.isEncoding() || Op.getEncoding() != BitCodeAbbrevOp::Array) | |||
936 | continue; | |||
937 | assert(i + 2 == e && "Array op not second to last")((i + 2 == e && "Array op not second to last") ? static_cast <void> (0) : __assert_fail ("i + 2 == e && \"Array op not second to last\"" , "/build/llvm-toolchain-snapshot-10~+201911111502510600c19528f1809/llvm/lib/Bitcode/Reader/BitcodeAnalyzer.cpp" , 937, __PRETTY_FUNCTION__)); | |||
938 | std::string Str; | |||
939 | bool ArrayIsPrintable = true; | |||
940 | for (unsigned j = i - 1, je = Record.size(); j != je; ++j) { | |||
941 | if (!isPrint(static_cast<unsigned char>(Record[j]))) { | |||
942 | ArrayIsPrintable = false; | |||
943 | break; | |||
944 | } | |||
945 | Str += (char)Record[j]; | |||
946 | } | |||
947 | if (ArrayIsPrintable) | |||
948 | O->OS << " record string = '" << Str << "'"; | |||
949 | break; | |||
950 | } | |||
951 | } | |||
952 | ||||
953 | if (Blob.data()) { | |||
954 | if (canDecodeBlob(Code, BlockID)) { | |||
955 | if (Error E = decodeMetadataStringsBlob(Indent, Record, Blob, O->OS)) | |||
956 | return E; | |||
957 | } else { | |||
958 | O->OS << " blob data = "; | |||
959 | if (O->ShowBinaryBlobs) { | |||
960 | O->OS << "'"; | |||
961 | O->OS.write_escaped(Blob, /*hex=*/true) << "'"; | |||
962 | } else { | |||
963 | bool BlobIsPrintable = true; | |||
964 | for (unsigned i = 0, e = Blob.size(); i != e; ++i) | |||
965 | if (!isPrint(static_cast<unsigned char>(Blob[i]))) { | |||
966 | BlobIsPrintable = false; | |||
967 | break; | |||
968 | } | |||
969 | ||||
970 | if (BlobIsPrintable) | |||
971 | O->OS << "'" << Blob << "'"; | |||
972 | else | |||
973 | O->OS << "unprintable, " << Blob.size() << " bytes."; | |||
974 | } | |||
975 | } | |||
976 | } | |||
977 | ||||
978 | O->OS << "\n"; | |||
979 | } | |||
980 | ||||
981 | // Make sure that we can skip the current record. | |||
982 | if (Error Err = Stream.JumpToBit(CurrentRecordPos)) | |||
983 | return Err; | |||
984 | if (Expected<unsigned> Skipped = Stream.skipRecord(Entry.ID)) | |||
985 | ; // Do nothing. | |||
986 | else | |||
987 | return Skipped.takeError(); | |||
988 | } | |||
989 | } | |||
990 |
1 | //===- BitstreamReader.h - Low-level bitstream reader interface -*- C++ -*-===// | ||||||
2 | // | ||||||
3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. | ||||||
4 | // See https://llvm.org/LICENSE.txt for license information. | ||||||
5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | ||||||
6 | // | ||||||
7 | //===----------------------------------------------------------------------===// | ||||||
8 | // | ||||||
9 | // This header defines the BitstreamReader class. This class can be used to | ||||||
10 | // read an arbitrary bitstream, regardless of its contents. | ||||||
11 | // | ||||||
12 | //===----------------------------------------------------------------------===// | ||||||
13 | |||||||
14 | #ifndef LLVM_BITSTREAM_BITSTREAMREADER_H | ||||||
15 | #define LLVM_BITSTREAM_BITSTREAMREADER_H | ||||||
16 | |||||||
17 | #include "llvm/ADT/ArrayRef.h" | ||||||
18 | #include "llvm/ADT/SmallVector.h" | ||||||
19 | #include "llvm/Bitstream/BitCodes.h" | ||||||
20 | #include "llvm/Support/Endian.h" | ||||||
21 | #include "llvm/Support/ErrorHandling.h" | ||||||
22 | #include "llvm/Support/MathExtras.h" | ||||||
23 | #include "llvm/Support/MemoryBuffer.h" | ||||||
24 | #include <algorithm> | ||||||
25 | #include <cassert> | ||||||
26 | #include <climits> | ||||||
27 | #include <cstddef> | ||||||
28 | #include <cstdint> | ||||||
29 | #include <memory> | ||||||
30 | #include <string> | ||||||
31 | #include <utility> | ||||||
32 | #include <vector> | ||||||
33 | |||||||
34 | namespace llvm { | ||||||
35 | |||||||
36 | /// This class maintains the abbreviations read from a block info block. | ||||||
37 | class BitstreamBlockInfo { | ||||||
38 | public: | ||||||
39 | /// This contains information emitted to BLOCKINFO_BLOCK blocks. These | ||||||
40 | /// describe abbreviations that all blocks of the specified ID inherit. | ||||||
41 | struct BlockInfo { | ||||||
42 | unsigned BlockID = 0; | ||||||
43 | std::vector<std::shared_ptr<BitCodeAbbrev>> Abbrevs; | ||||||
44 | std::string Name; | ||||||
45 | std::vector<std::pair<unsigned, std::string>> RecordNames; | ||||||
46 | }; | ||||||
47 | |||||||
48 | private: | ||||||
49 | std::vector<BlockInfo> BlockInfoRecords; | ||||||
50 | |||||||
51 | public: | ||||||
52 | /// If there is block info for the specified ID, return it, otherwise return | ||||||
53 | /// null. | ||||||
54 | const BlockInfo *getBlockInfo(unsigned BlockID) const { | ||||||
55 | // Common case, the most recent entry matches BlockID. | ||||||
56 | if (!BlockInfoRecords.empty() && BlockInfoRecords.back().BlockID == BlockID) | ||||||
57 | return &BlockInfoRecords.back(); | ||||||
58 | |||||||
59 | for (unsigned i = 0, e = static_cast<unsigned>(BlockInfoRecords.size()); | ||||||
60 | i != e; ++i) | ||||||
61 | if (BlockInfoRecords[i].BlockID == BlockID) | ||||||
62 | return &BlockInfoRecords[i]; | ||||||
63 | return nullptr; | ||||||
64 | } | ||||||
65 | |||||||
66 | BlockInfo &getOrCreateBlockInfo(unsigned BlockID) { | ||||||
67 | if (const BlockInfo *BI = getBlockInfo(BlockID)) | ||||||
68 | return *const_cast<BlockInfo*>(BI); | ||||||
69 | |||||||
70 | // Otherwise, add a new record. | ||||||
71 | BlockInfoRecords.emplace_back(); | ||||||
72 | BlockInfoRecords.back().BlockID = BlockID; | ||||||
73 | return BlockInfoRecords.back(); | ||||||
74 | } | ||||||
75 | }; | ||||||
76 | |||||||
77 | /// This represents a position within a bitstream. There may be multiple | ||||||
78 | /// independent cursors reading within one bitstream, each maintaining their | ||||||
79 | /// own local state. | ||||||
80 | class SimpleBitstreamCursor { | ||||||
81 | ArrayRef<uint8_t> BitcodeBytes; | ||||||
82 | size_t NextChar = 0; | ||||||
83 | |||||||
84 | public: | ||||||
85 | /// This is the current data we have pulled from the stream but have not | ||||||
86 | /// returned to the client. This is specifically and intentionally defined to | ||||||
87 | /// follow the word size of the host machine for efficiency. We use word_t in | ||||||
88 | /// places that are aware of this to make it perfectly explicit what is going | ||||||
89 | /// on. | ||||||
90 | using word_t = size_t; | ||||||
91 | |||||||
92 | private: | ||||||
93 | word_t CurWord = 0; | ||||||
94 | |||||||
95 | /// This is the number of bits in CurWord that are valid. This is always from | ||||||
96 | /// [0...bits_of(size_t)-1] inclusive. | ||||||
97 | unsigned BitsInCurWord = 0; | ||||||
98 | |||||||
99 | public: | ||||||
100 | static const constexpr size_t MaxChunkSize = sizeof(word_t) * 8; | ||||||
101 | |||||||
102 | SimpleBitstreamCursor() = default; | ||||||
103 | explicit SimpleBitstreamCursor(ArrayRef<uint8_t> BitcodeBytes) | ||||||
104 | : BitcodeBytes(BitcodeBytes) {} | ||||||
105 | explicit SimpleBitstreamCursor(StringRef BitcodeBytes) | ||||||
106 | : BitcodeBytes(arrayRefFromStringRef(BitcodeBytes)) {} | ||||||
107 | explicit SimpleBitstreamCursor(MemoryBufferRef BitcodeBytes) | ||||||
108 | : SimpleBitstreamCursor(BitcodeBytes.getBuffer()) {} | ||||||
109 | |||||||
110 | bool canSkipToPos(size_t pos) const { | ||||||
111 | // pos can be skipped to if it is a valid address or one byte past the end. | ||||||
112 | return pos <= BitcodeBytes.size(); | ||||||
113 | } | ||||||
114 | |||||||
115 | bool AtEndOfStream() { | ||||||
116 | return BitsInCurWord == 0 && BitcodeBytes.size() <= NextChar; | ||||||
117 | } | ||||||
118 | |||||||
119 | /// Return the bit # of the bit we are reading. | ||||||
120 | uint64_t GetCurrentBitNo() const { | ||||||
121 | return NextChar*CHAR_BIT8 - BitsInCurWord; | ||||||
122 | } | ||||||
123 | |||||||
124 | // Return the byte # of the current bit. | ||||||
125 | uint64_t getCurrentByteNo() const { return GetCurrentBitNo() / 8; } | ||||||
126 | |||||||
127 | ArrayRef<uint8_t> getBitcodeBytes() const { return BitcodeBytes; } | ||||||
128 | |||||||
129 | /// Reset the stream to the specified bit number. | ||||||
130 | Error JumpToBit(uint64_t BitNo) { | ||||||
131 | size_t ByteNo = size_t(BitNo/8) & ~(sizeof(word_t)-1); | ||||||
132 | unsigned WordBitNo = unsigned(BitNo & (sizeof(word_t)*8-1)); | ||||||
133 | assert(canSkipToPos(ByteNo) && "Invalid location")((canSkipToPos(ByteNo) && "Invalid location") ? static_cast <void> (0) : __assert_fail ("canSkipToPos(ByteNo) && \"Invalid location\"" , "/build/llvm-toolchain-snapshot-10~+201911111502510600c19528f1809/llvm/include/llvm/Bitstream/BitstreamReader.h" , 133, __PRETTY_FUNCTION__)); | ||||||
134 | |||||||
135 | // Move the cursor to the right word. | ||||||
136 | NextChar = ByteNo; | ||||||
137 | BitsInCurWord = 0; | ||||||
138 | |||||||
139 | // Skip over any bits that are already consumed. | ||||||
140 | if (WordBitNo) { | ||||||
141 | if (Expected<word_t> Res = Read(WordBitNo)) | ||||||
142 | return Error::success(); | ||||||
143 | else | ||||||
144 | return Res.takeError(); | ||||||
145 | } | ||||||
146 | |||||||
147 | return Error::success(); | ||||||
148 | } | ||||||
149 | |||||||
150 | /// Get a pointer into the bitstream at the specified byte offset. | ||||||
151 | const uint8_t *getPointerToByte(uint64_t ByteNo, uint64_t NumBytes) { | ||||||
152 | return BitcodeBytes.data() + ByteNo; | ||||||
153 | } | ||||||
154 | |||||||
155 | /// Get a pointer into the bitstream at the specified bit offset. | ||||||
156 | /// | ||||||
157 | /// The bit offset must be on a byte boundary. | ||||||
158 | const uint8_t *getPointerToBit(uint64_t BitNo, uint64_t NumBytes) { | ||||||
159 | assert(!(BitNo % 8) && "Expected bit on byte boundary")((!(BitNo % 8) && "Expected bit on byte boundary") ? static_cast <void> (0) : __assert_fail ("!(BitNo % 8) && \"Expected bit on byte boundary\"" , "/build/llvm-toolchain-snapshot-10~+201911111502510600c19528f1809/llvm/include/llvm/Bitstream/BitstreamReader.h" , 159, __PRETTY_FUNCTION__)); | ||||||
160 | return getPointerToByte(BitNo / 8, NumBytes); | ||||||
161 | } | ||||||
162 | |||||||
163 | Error fillCurWord() { | ||||||
164 | if (NextChar >= BitcodeBytes.size()) | ||||||
165 | return createStringError(std::errc::io_error, | ||||||
166 | "Unexpected end of file reading %u of %u bytes", | ||||||
167 | NextChar, BitcodeBytes.size()); | ||||||
168 | |||||||
169 | // Read the next word from the stream. | ||||||
170 | const uint8_t *NextCharPtr = BitcodeBytes.data() + NextChar; | ||||||
171 | unsigned BytesRead; | ||||||
172 | if (BitcodeBytes.size() >= NextChar + sizeof(word_t)) { | ||||||
173 | BytesRead = sizeof(word_t); | ||||||
174 | CurWord = | ||||||
175 | support::endian::read<word_t, support::little, support::unaligned>( | ||||||
176 | NextCharPtr); | ||||||
177 | } else { | ||||||
178 | // Short read. | ||||||
179 | BytesRead = BitcodeBytes.size() - NextChar; | ||||||
180 | CurWord = 0; | ||||||
181 | for (unsigned B = 0; B != BytesRead; ++B) | ||||||
182 | CurWord |= uint64_t(NextCharPtr[B]) << (B * 8); | ||||||
183 | } | ||||||
184 | NextChar += BytesRead; | ||||||
185 | BitsInCurWord = BytesRead * 8; | ||||||
186 | return Error::success(); | ||||||
187 | } | ||||||
188 | |||||||
189 | Expected<word_t> Read(unsigned NumBits) { | ||||||
190 | static const unsigned BitsInWord = MaxChunkSize; | ||||||
191 | |||||||
192 | assert(NumBits && NumBits <= BitsInWord &&((NumBits && NumBits <= BitsInWord && "Cannot return zero or more than BitsInWord bits!" ) ? static_cast<void> (0) : __assert_fail ("NumBits && NumBits <= BitsInWord && \"Cannot return zero or more than BitsInWord bits!\"" , "/build/llvm-toolchain-snapshot-10~+201911111502510600c19528f1809/llvm/include/llvm/Bitstream/BitstreamReader.h" , 193, __PRETTY_FUNCTION__)) | ||||||
193 | "Cannot return zero or more than BitsInWord bits!")((NumBits && NumBits <= BitsInWord && "Cannot return zero or more than BitsInWord bits!" ) ? static_cast<void> (0) : __assert_fail ("NumBits && NumBits <= BitsInWord && \"Cannot return zero or more than BitsInWord bits!\"" , "/build/llvm-toolchain-snapshot-10~+201911111502510600c19528f1809/llvm/include/llvm/Bitstream/BitstreamReader.h" , 193, __PRETTY_FUNCTION__)); | ||||||
194 | |||||||
195 | static const unsigned Mask = sizeof(word_t) > 4 ? 0x3f : 0x1f; | ||||||
196 | |||||||
197 | // If the field is fully contained by CurWord, return it quickly. | ||||||
198 | if (BitsInCurWord >= NumBits) { | ||||||
199 | word_t R = CurWord & (~word_t(0) >> (BitsInWord - NumBits)); | ||||||
200 | |||||||
201 | // Use a mask to avoid undefined behavior. | ||||||
202 | CurWord >>= (NumBits & Mask); | ||||||
203 | |||||||
204 | BitsInCurWord -= NumBits; | ||||||
205 | return R; | ||||||
206 | } | ||||||
207 | |||||||
208 | word_t R = BitsInCurWord
| ||||||
209 | unsigned BitsLeft = NumBits - BitsInCurWord; | ||||||
210 | |||||||
211 | if (Error fillResult = fillCurWord()) | ||||||
212 | return std::move(fillResult); | ||||||
213 | |||||||
214 | // If we run out of data, abort. | ||||||
215 | if (BitsLeft > BitsInCurWord) | ||||||
216 | return createStringError(std::errc::io_error, | ||||||
217 | "Unexpected end of file reading %u of %u bits", | ||||||
218 | BitsInCurWord, BitsLeft); | ||||||
219 | |||||||
220 | word_t R2 = CurWord & (~word_t(0) >> (BitsInWord - BitsLeft)); | ||||||
| |||||||
221 | |||||||
222 | // Use a mask to avoid undefined behavior. | ||||||
223 | CurWord >>= (BitsLeft & Mask); | ||||||
224 | |||||||
225 | BitsInCurWord -= BitsLeft; | ||||||
226 | |||||||
227 | R |= R2 << (NumBits - BitsLeft); | ||||||
228 | |||||||
229 | return R; | ||||||
230 | } | ||||||
231 | |||||||
232 | Expected<uint32_t> ReadVBR(unsigned NumBits) { | ||||||
233 | Expected<unsigned> MaybeRead = Read(NumBits); | ||||||
234 | if (!MaybeRead) | ||||||
235 | return MaybeRead; | ||||||
236 | uint32_t Piece = MaybeRead.get(); | ||||||
237 | |||||||
238 | if ((Piece & (1U << (NumBits-1))) == 0) | ||||||
239 | return Piece; | ||||||
240 | |||||||
241 | uint32_t Result = 0; | ||||||
242 | unsigned NextBit = 0; | ||||||
243 | while (true) { | ||||||
244 | Result |= (Piece & ((1U << (NumBits-1))-1)) << NextBit; | ||||||
245 | |||||||
246 | if ((Piece & (1U << (NumBits-1))) == 0) | ||||||
247 | return Result; | ||||||
248 | |||||||
249 | NextBit += NumBits-1; | ||||||
250 | MaybeRead = Read(NumBits); | ||||||
251 | if (!MaybeRead) | ||||||
252 | return MaybeRead; | ||||||
253 | Piece = MaybeRead.get(); | ||||||
254 | } | ||||||
255 | } | ||||||
256 | |||||||
257 | // Read a VBR that may have a value up to 64-bits in size. The chunk size of | ||||||
258 | // the VBR must still be <= 32 bits though. | ||||||
259 | Expected<uint64_t> ReadVBR64(unsigned NumBits) { | ||||||
260 | Expected<uint64_t> MaybeRead = Read(NumBits); | ||||||
261 | if (!MaybeRead) | ||||||
262 | return MaybeRead; | ||||||
263 | uint32_t Piece = MaybeRead.get(); | ||||||
264 | |||||||
265 | if ((Piece & (1U << (NumBits-1))) == 0) | ||||||
266 | return uint64_t(Piece); | ||||||
267 | |||||||
268 | uint64_t Result = 0; | ||||||
269 | unsigned NextBit = 0; | ||||||
270 | while (true) { | ||||||
271 | Result |= uint64_t(Piece & ((1U << (NumBits-1))-1)) << NextBit; | ||||||
272 | |||||||
273 | if ((Piece & (1U << (NumBits-1))) == 0) | ||||||
274 | return Result; | ||||||
275 | |||||||
276 | NextBit += NumBits-1; | ||||||
277 | MaybeRead = Read(NumBits); | ||||||
278 | if (!MaybeRead) | ||||||
279 | return MaybeRead; | ||||||
280 | Piece = MaybeRead.get(); | ||||||
281 | } | ||||||
282 | } | ||||||
283 | |||||||
284 | void SkipToFourByteBoundary() { | ||||||
285 | // If word_t is 64-bits and if we've read less than 32 bits, just dump | ||||||
286 | // the bits we have up to the next 32-bit boundary. | ||||||
287 | if (sizeof(word_t) > 4 && | ||||||
288 | BitsInCurWord >= 32) { | ||||||
289 | CurWord >>= BitsInCurWord-32; | ||||||
290 | BitsInCurWord = 32; | ||||||
291 | return; | ||||||
292 | } | ||||||
293 | |||||||
294 | BitsInCurWord = 0; | ||||||
295 | } | ||||||
296 | |||||||
297 | /// Return the size of the stream in bytes. | ||||||
298 | size_t SizeInBytes() const { return BitcodeBytes.size(); } | ||||||
299 | |||||||
300 | /// Skip to the end of the file. | ||||||
301 | void skipToEnd() { NextChar = BitcodeBytes.size(); } | ||||||
302 | }; | ||||||
303 | |||||||
304 | /// When advancing through a bitstream cursor, each advance can discover a few | ||||||
305 | /// different kinds of entries: | ||||||
306 | struct BitstreamEntry { | ||||||
307 | enum { | ||||||
308 | Error, // Malformed bitcode was found. | ||||||
309 | EndBlock, // We've reached the end of the current block, (or the end of the | ||||||
310 | // file, which is treated like a series of EndBlock records. | ||||||
311 | SubBlock, // This is the start of a new subblock of a specific ID. | ||||||
312 | Record // This is a record with a specific AbbrevID. | ||||||
313 | } Kind; | ||||||
314 | |||||||
315 | unsigned ID; | ||||||
316 | |||||||
317 | static BitstreamEntry getError() { | ||||||
318 | BitstreamEntry E; E.Kind = Error; return E; | ||||||
319 | } | ||||||
320 | |||||||
321 | static BitstreamEntry getEndBlock() { | ||||||
322 | BitstreamEntry E; E.Kind = EndBlock; return E; | ||||||
323 | } | ||||||
324 | |||||||
325 | static BitstreamEntry getSubBlock(unsigned ID) { | ||||||
326 | BitstreamEntry E; E.Kind = SubBlock; E.ID = ID; return E; | ||||||
327 | } | ||||||
328 | |||||||
329 | static BitstreamEntry getRecord(unsigned AbbrevID) { | ||||||
330 | BitstreamEntry E; E.Kind = Record; E.ID = AbbrevID; return E; | ||||||
331 | } | ||||||
332 | }; | ||||||
333 | |||||||
334 | /// This represents a position within a bitcode file, implemented on top of a | ||||||
335 | /// SimpleBitstreamCursor. | ||||||
336 | /// | ||||||
337 | /// Unlike iterators, BitstreamCursors are heavy-weight objects that should not | ||||||
338 | /// be passed by value. | ||||||
339 | class BitstreamCursor : SimpleBitstreamCursor { | ||||||
340 | // This is the declared size of code values used for the current block, in | ||||||
341 | // bits. | ||||||
342 | unsigned CurCodeSize = 2; | ||||||
343 | |||||||
344 | /// Abbrevs installed at in this block. | ||||||
345 | std::vector<std::shared_ptr<BitCodeAbbrev>> CurAbbrevs; | ||||||
346 | |||||||
347 | struct Block { | ||||||
348 | unsigned PrevCodeSize; | ||||||
349 | std::vector<std::shared_ptr<BitCodeAbbrev>> PrevAbbrevs; | ||||||
350 | |||||||
351 | explicit Block(unsigned PCS) : PrevCodeSize(PCS) {} | ||||||
352 | }; | ||||||
353 | |||||||
354 | /// This tracks the codesize of parent blocks. | ||||||
355 | SmallVector<Block, 8> BlockScope; | ||||||
356 | |||||||
357 | BitstreamBlockInfo *BlockInfo = nullptr; | ||||||
358 | |||||||
359 | public: | ||||||
360 | static const size_t MaxChunkSize = sizeof(word_t) * 8; | ||||||
361 | |||||||
362 | BitstreamCursor() = default; | ||||||
363 | explicit BitstreamCursor(ArrayRef<uint8_t> BitcodeBytes) | ||||||
364 | : SimpleBitstreamCursor(BitcodeBytes) {} | ||||||
365 | explicit BitstreamCursor(StringRef BitcodeBytes) | ||||||
366 | : SimpleBitstreamCursor(BitcodeBytes) {} | ||||||
367 | explicit BitstreamCursor(MemoryBufferRef BitcodeBytes) | ||||||
368 | : SimpleBitstreamCursor(BitcodeBytes) {} | ||||||
369 | |||||||
370 | using SimpleBitstreamCursor::AtEndOfStream; | ||||||
371 | using SimpleBitstreamCursor::canSkipToPos; | ||||||
372 | using SimpleBitstreamCursor::fillCurWord; | ||||||
373 | using SimpleBitstreamCursor::getBitcodeBytes; | ||||||
374 | using SimpleBitstreamCursor::GetCurrentBitNo; | ||||||
375 | using SimpleBitstreamCursor::getCurrentByteNo; | ||||||
376 | using SimpleBitstreamCursor::getPointerToByte; | ||||||
377 | using SimpleBitstreamCursor::JumpToBit; | ||||||
378 | using SimpleBitstreamCursor::Read; | ||||||
379 | using SimpleBitstreamCursor::ReadVBR; | ||||||
380 | using SimpleBitstreamCursor::ReadVBR64; | ||||||
381 | using SimpleBitstreamCursor::SizeInBytes; | ||||||
382 | using SimpleBitstreamCursor::skipToEnd; | ||||||
383 | |||||||
384 | /// Return the number of bits used to encode an abbrev #. | ||||||
385 | unsigned getAbbrevIDWidth() const { return CurCodeSize; } | ||||||
386 | |||||||
387 | /// Flags that modify the behavior of advance(). | ||||||
388 | enum { | ||||||
389 | /// If this flag is used, the advance() method does not automatically pop | ||||||
390 | /// the block scope when the end of a block is reached. | ||||||
391 | AF_DontPopBlockAtEnd = 1, | ||||||
392 | |||||||
393 | /// If this flag is used, abbrev entries are returned just like normal | ||||||
394 | /// records. | ||||||
395 | AF_DontAutoprocessAbbrevs = 2 | ||||||
396 | }; | ||||||
397 | |||||||
398 | /// Advance the current bitstream, returning the next entry in the stream. | ||||||
399 | Expected<BitstreamEntry> advance(unsigned Flags = 0) { | ||||||
400 | while (true) { | ||||||
401 | if (AtEndOfStream()) | ||||||
402 | return BitstreamEntry::getError(); | ||||||
403 | |||||||
404 | Expected<unsigned> MaybeCode = ReadCode(); | ||||||
405 | if (!MaybeCode) | ||||||
406 | return MaybeCode.takeError(); | ||||||
407 | unsigned Code = MaybeCode.get(); | ||||||
408 | |||||||
409 | if (Code == bitc::END_BLOCK) { | ||||||
410 | // Pop the end of the block unless Flags tells us not to. | ||||||
411 | if (!(Flags & AF_DontPopBlockAtEnd) && ReadBlockEnd()) | ||||||
412 | return BitstreamEntry::getError(); | ||||||
413 | return BitstreamEntry::getEndBlock(); | ||||||
414 | } | ||||||
415 | |||||||
416 | if (Code == bitc::ENTER_SUBBLOCK) { | ||||||
417 | if (Expected<unsigned> MaybeSubBlock = ReadSubBlockID()) | ||||||
418 | return BitstreamEntry::getSubBlock(MaybeSubBlock.get()); | ||||||
419 | else | ||||||
420 | return MaybeSubBlock.takeError(); | ||||||
421 | } | ||||||
422 | |||||||
423 | if (Code == bitc::DEFINE_ABBREV && | ||||||
424 | !(Flags & AF_DontAutoprocessAbbrevs)) { | ||||||
425 | // We read and accumulate abbrev's, the client can't do anything with | ||||||
426 | // them anyway. | ||||||
427 | if (Error Err = ReadAbbrevRecord()) | ||||||
428 | return std::move(Err); | ||||||
429 | continue; | ||||||
430 | } | ||||||
431 | |||||||
432 | return BitstreamEntry::getRecord(Code); | ||||||
433 | } | ||||||
434 | } | ||||||
435 | |||||||
436 | /// This is a convenience function for clients that don't expect any | ||||||
437 | /// subblocks. This just skips over them automatically. | ||||||
438 | Expected<BitstreamEntry> advanceSkippingSubblocks(unsigned Flags = 0) { | ||||||
439 | while (true) { | ||||||
440 | // If we found a normal entry, return it. | ||||||
441 | Expected<BitstreamEntry> MaybeEntry = advance(Flags); | ||||||
442 | if (!MaybeEntry) | ||||||
443 | return MaybeEntry; | ||||||
444 | BitstreamEntry Entry = MaybeEntry.get(); | ||||||
445 | |||||||
446 | if (Entry.Kind != BitstreamEntry::SubBlock) | ||||||
447 | return Entry; | ||||||
448 | |||||||
449 | // If we found a sub-block, just skip over it and check the next entry. | ||||||
450 | if (Error Err = SkipBlock()) | ||||||
451 | return std::move(Err); | ||||||
452 | } | ||||||
453 | } | ||||||
454 | |||||||
455 | Expected<unsigned> ReadCode() { return Read(CurCodeSize); } | ||||||
456 | |||||||
457 | // Block header: | ||||||
458 | // [ENTER_SUBBLOCK, blockid, newcodelen, <align4bytes>, blocklen] | ||||||
459 | |||||||
460 | /// Having read the ENTER_SUBBLOCK code, read the BlockID for the block. | ||||||
461 | Expected<unsigned> ReadSubBlockID() { return ReadVBR(bitc::BlockIDWidth); } | ||||||
462 | |||||||
463 | /// Having read the ENTER_SUBBLOCK abbrevid and a BlockID, skip over the body | ||||||
464 | /// of this block. | ||||||
465 | Error SkipBlock() { | ||||||
466 | // Read and ignore the codelen value. | ||||||
467 | if (Expected<uint32_t> Res = ReadVBR(bitc::CodeLenWidth)) | ||||||
468 | ; // Since we are skipping this block, we don't care what code widths are | ||||||
469 | // used inside of it. | ||||||
470 | else | ||||||
471 | return Res.takeError(); | ||||||
472 | |||||||
473 | SkipToFourByteBoundary(); | ||||||
474 | Expected<unsigned> MaybeNum = Read(bitc::BlockSizeWidth); | ||||||
475 | if (!MaybeNum) | ||||||
476 | return MaybeNum.takeError(); | ||||||
477 | size_t NumFourBytes = MaybeNum.get(); | ||||||
478 | |||||||
479 | // Check that the block wasn't partially defined, and that the offset isn't | ||||||
480 | // bogus. | ||||||
481 | size_t SkipTo = GetCurrentBitNo() + NumFourBytes * 4 * 8; | ||||||
482 | if (AtEndOfStream()) | ||||||
483 | return createStringError(std::errc::illegal_byte_sequence, | ||||||
484 | "can't skip block: already at end of stream"); | ||||||
485 | if (!canSkipToPos(SkipTo / 8)) | ||||||
486 | return createStringError(std::errc::illegal_byte_sequence, | ||||||
487 | "can't skip to bit %zu from %" PRIu64"l" "u", SkipTo, | ||||||
488 | GetCurrentBitNo()); | ||||||
489 | |||||||
490 | if (Error Res = JumpToBit(SkipTo)) | ||||||
491 | return Res; | ||||||
492 | |||||||
493 | return Error::success(); | ||||||
494 | } | ||||||
495 | |||||||
496 | /// Having read the ENTER_SUBBLOCK abbrevid, and enter the block. | ||||||
497 | Error EnterSubBlock(unsigned BlockID, unsigned *NumWordsP = nullptr); | ||||||
498 | |||||||
499 | bool ReadBlockEnd() { | ||||||
500 | if (BlockScope.empty()) return true; | ||||||
501 | |||||||
502 | // Block tail: | ||||||
503 | // [END_BLOCK, <align4bytes>] | ||||||
504 | SkipToFourByteBoundary(); | ||||||
505 | |||||||
506 | popBlockScope(); | ||||||
507 | return false; | ||||||
508 | } | ||||||
509 | |||||||
510 | private: | ||||||
511 | void popBlockScope() { | ||||||
512 | CurCodeSize = BlockScope.back().PrevCodeSize; | ||||||
513 | |||||||
514 | CurAbbrevs = std::move(BlockScope.back().PrevAbbrevs); | ||||||
515 | BlockScope.pop_back(); | ||||||
516 | } | ||||||
517 | |||||||
518 | //===--------------------------------------------------------------------===// | ||||||
519 | // Record Processing | ||||||
520 | //===--------------------------------------------------------------------===// | ||||||
521 | |||||||
522 | public: | ||||||
523 | /// Return the abbreviation for the specified AbbrevId. | ||||||
524 | const BitCodeAbbrev *getAbbrev(unsigned AbbrevID) { | ||||||
525 | unsigned AbbrevNo = AbbrevID - bitc::FIRST_APPLICATION_ABBREV; | ||||||
526 | if (AbbrevNo >= CurAbbrevs.size()) | ||||||
527 | report_fatal_error("Invalid abbrev number"); | ||||||
528 | return CurAbbrevs[AbbrevNo].get(); | ||||||
529 | } | ||||||
530 | |||||||
531 | /// Read the current record and discard it, returning the code for the record. | ||||||
532 | Expected<unsigned> skipRecord(unsigned AbbrevID); | ||||||
533 | |||||||
534 | Expected<unsigned> readRecord(unsigned AbbrevID, | ||||||
535 | SmallVectorImpl<uint64_t> &Vals, | ||||||
536 | StringRef *Blob = nullptr); | ||||||
537 | |||||||
538 | //===--------------------------------------------------------------------===// | ||||||
539 | // Abbrev Processing | ||||||
540 | //===--------------------------------------------------------------------===// | ||||||
541 | Error ReadAbbrevRecord(); | ||||||
542 | |||||||
543 | /// Read and return a block info block from the bitstream. If an error was | ||||||
544 | /// encountered, return None. | ||||||
545 | /// | ||||||
546 | /// \param ReadBlockInfoNames Whether to read block/record name information in | ||||||
547 | /// the BlockInfo block. Only llvm-bcanalyzer uses this. | ||||||
548 | Expected<Optional<BitstreamBlockInfo>> | ||||||
549 | ReadBlockInfoBlock(bool ReadBlockInfoNames = false); | ||||||
550 | |||||||
551 | /// Set the block info to be used by this BitstreamCursor to interpret | ||||||
552 | /// abbreviated records. | ||||||
553 | void setBlockInfo(BitstreamBlockInfo *BI) { BlockInfo = BI; } | ||||||
554 | }; | ||||||
555 | |||||||
556 | } // end llvm namespace | ||||||
557 | |||||||
558 | #endif // LLVM_BITSTREAM_BITSTREAMREADER_H |
1 | //===- llvm/Support/Error.h - Recoverable error handling --------*- C++ -*-===// |
2 | // |
3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
4 | // See https://llvm.org/LICENSE.txt for license information. |
5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
6 | // |
7 | //===----------------------------------------------------------------------===// |
8 | // |
9 | // This file defines an API used to report recoverable errors. |
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 | /// Base class for error info classes. Do not extend this directly: Extend |
47 | /// the ErrorInfo template subclass instead. |
48 | class ErrorInfoBase { |
49 | public: |
50 | virtual ~ErrorInfoBase() = default; |
51 | |
52 | /// Print an error message to an output stream. |
53 | virtual void log(raw_ostream &OS) const = 0; |
54 | |
55 | /// Return the error message as a string. |
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 | /// Convert this error to a std::error_code. |
64 | /// |
65 | /// This is a temporary crutch to enable interaction with code still |
66 | /// using std::error_code. It will be removed in the future. |
67 | virtual std::error_code convertToErrorCode() const = 0; |
68 | |
69 | // Returns the class ID for this type. |
70 | static const void *classID() { return &ID; } |
71 | |
72 | // Returns the class ID for the dynamic type of this ErrorInfoBase instance. |
73 | virtual const void *dynamicClassID() const = 0; |
74 | |
75 | // Check whether this instance is a subclass of the class identified by |
76 | // ClassID. |
77 | virtual bool isA(const void *const ClassID) const { |
78 | return ClassID == classID(); |
79 | } |
80 | |
81 | // Check whether this instance is a subclass of ErrorInfoT. |
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 | /// Lightweight error class with error context and mandatory checking. |
93 | /// |
94 | /// Instances of this class wrap a ErrorInfoBase pointer. Failure states |
95 | /// are represented by setting the pointer to a ErrorInfoBase subclass |
96 | /// instance containing information describing the failure. Success is |
97 | /// represented by a null pointer value. |
98 | /// |
99 | /// Instances of Error also contains a 'Checked' flag, which must be set |
100 | /// before the destructor is called, otherwise the destructor will trigger a |
101 | /// runtime error. This enforces at runtime the requirement that all Error |
102 | /// instances be checked or returned to the caller. |
103 | /// |
104 | /// There are two ways to set the checked flag, depending on what state the |
105 | /// Error instance is in. For Error instances indicating success, it |
106 | /// is sufficient to invoke the boolean conversion operator. E.g.: |
107 | /// |
108 | /// @code{.cpp} |
109 | /// Error foo(<...>); |
110 | /// |
111 | /// if (auto E = foo(<...>)) |
112 | /// return E; // <- Return E if it is in the error state. |
113 | /// // We have verified that E was in the success state. It can now be safely |
114 | /// // destroyed. |
115 | /// @endcode |
116 | /// |
117 | /// A success value *can not* be dropped. For example, just calling 'foo(<...>)' |
118 | /// without testing the return value will raise a runtime error, even if foo |
119 | /// returns success. |
120 | /// |
121 | /// For Error instances representing failure, you must use either the |
122 | /// handleErrors or handleAllErrors function with a typed handler. E.g.: |
123 | /// |
124 | /// @code{.cpp} |
125 | /// class MyErrorInfo : public ErrorInfo<MyErrorInfo> { |
126 | /// // Custom error info. |
127 | /// }; |
128 | /// |
129 | /// Error foo(<...>) { return make_error<MyErrorInfo>(...); } |
130 | /// |
131 | /// auto E = foo(<...>); // <- foo returns failure with MyErrorInfo. |
132 | /// auto NewE = |
133 | /// handleErrors(E, |
134 | /// [](const MyErrorInfo &M) { |
135 | /// // Deal with the error. |
136 | /// }, |
137 | /// [](std::unique_ptr<OtherError> M) -> Error { |
138 | /// if (canHandle(*M)) { |
139 | /// // handle error. |
140 | /// return Error::success(); |
141 | /// } |
142 | /// // Couldn't handle this error instance. Pass it up the stack. |
143 | /// return Error(std::move(M)); |
144 | /// ); |
145 | /// // Note - we must check or return NewE in case any of the handlers |
146 | /// // returned a new error. |
147 | /// @endcode |
148 | /// |
149 | /// The handleAllErrors function is identical to handleErrors, except |
150 | /// that it has a void return type, and requires all errors to be handled and |
151 | /// no new errors be returned. It prevents errors (assuming they can all be |
152 | /// handled) from having to be bubbled all the way to the top-level. |
153 | /// |
154 | /// *All* Error instances must be checked before destruction, even if |
155 | /// they're moved-assigned or constructed from Success values that have already |
156 | /// been checked. This enforces checking through all levels of the call stack. |
157 | class LLVM_NODISCARD[[clang::warn_unused_result]] Error { |
158 | // Both ErrorList and FileError need to be able to yank ErrorInfoBase |
159 | // pointers out of this class to add to the error list. |
160 | friend class ErrorList; |
161 | friend class FileError; |
162 | |
163 | // handleErrors needs to be able to set the Checked flag. |
164 | template <typename... HandlerTs> |
165 | friend Error handleErrors(Error E, HandlerTs &&... Handlers); |
166 | |
167 | // Expected<T> needs to be able to steal the payload when constructed from an |
168 | // error. |
169 | template <typename T> friend class Expected; |
170 | |
171 | // wrap needs to be able to steal the payload. |
172 | friend LLVMErrorRef wrap(Error); |
173 | |
174 | protected: |
175 | /// Create a success value. Prefer using 'Error::success()' for readability |
176 | Error() { |
177 | setPtr(nullptr); |
178 | setChecked(false); |
179 | } |
180 | |
181 | public: |
182 | /// Create a success value. |
183 | static ErrorSuccess success(); |
184 | |
185 | // Errors are not copy-constructable. |
186 | Error(const Error &Other) = delete; |
187 | |
188 | /// Move-construct an error value. The newly constructed error is considered |
189 | /// unchecked, even if the source error had been checked. The original error |
190 | /// becomes a checked Success value, regardless of its original state. |
191 | Error(Error &&Other) { |
192 | setChecked(true); |
193 | *this = std::move(Other); |
194 | } |
195 | |
196 | /// Create an error value. Prefer using the 'make_error' function, but |
197 | /// this constructor can be useful when "re-throwing" errors from handlers. |
198 | Error(std::unique_ptr<ErrorInfoBase> Payload) { |
199 | setPtr(Payload.release()); |
200 | setChecked(false); |
201 | } |
202 | |
203 | // Errors are not copy-assignable. |
204 | Error &operator=(const Error &Other) = delete; |
205 | |
206 | /// Move-assign an error value. The current error must represent success, you |
207 | /// you cannot overwrite an unhandled error. The current error is then |
208 | /// considered unchecked. The source error becomes a checked success value, |
209 | /// regardless of its original state. |
210 | Error &operator=(Error &&Other) { |
211 | // Don't allow overwriting of unchecked values. |
212 | assertIsChecked(); |
213 | setPtr(Other.getPtr()); |
214 | |
215 | // This Error is unchecked, even if the source error was checked. |
216 | setChecked(false); |
217 | |
218 | // Null out Other's payload and set its checked bit. |
219 | Other.setPtr(nullptr); |
220 | Other.setChecked(true); |
221 | |
222 | return *this; |
223 | } |
224 | |
225 | /// Destroy a Error. Fails with a call to abort() if the error is |
226 | /// unchecked. |
227 | ~Error() { |
228 | assertIsChecked(); |
229 | delete getPtr(); |
230 | } |
231 | |
232 | /// Bool conversion. Returns true if this Error is in a failure state, |
233 | /// and false if it is in an accept state. If the error is in a Success state |
234 | /// it will be considered checked. |
235 | explicit operator bool() { |
236 | setChecked(getPtr() == nullptr); |
237 | return getPtr() != nullptr; |
238 | } |
239 | |
240 | /// Check whether one error is a subclass of another. |
241 | template <typename ErrT> bool isA() const { |
242 | return getPtr() && getPtr()->isA(ErrT::classID()); |
243 | } |
244 | |
245 | /// Returns the dynamic class id of this error, or null if this is a success |
246 | /// value. |
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_CHECKS1 |
255 | // assertIsChecked() happens very frequently, but under normal circumstances |
256 | // is supposed to be a no-op. So we want it to be inlined, but having a bunch |
257 | // of debug prints can cause the function to be too large for inlining. So |
258 | // it's important that we define this function out of line so that it can't be |
259 | // inlined. |
260 | LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) |
261 | void fatalUncheckedError() const; |
262 | #endif |
263 | |
264 | void assertIsChecked() { |
265 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
266 | if (LLVM_UNLIKELY(!getChecked() || getPtr())__builtin_expect((bool)(!getChecked() || getPtr()), false)) |
267 | fatalUncheckedError(); |
268 | #endif |
269 | } |
270 | |
271 | ErrorInfoBase *getPtr() const { |
272 | return reinterpret_cast<ErrorInfoBase*>( |
273 | reinterpret_cast<uintptr_t>(Payload) & |
274 | ~static_cast<uintptr_t>(0x1)); |
275 | } |
276 | |
277 | void setPtr(ErrorInfoBase *EI) { |
278 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
279 | Payload = reinterpret_cast<ErrorInfoBase*>( |
280 | (reinterpret_cast<uintptr_t>(EI) & |
281 | ~static_cast<uintptr_t>(0x1)) | |
282 | (reinterpret_cast<uintptr_t>(Payload) & 0x1)); |
283 | #else |
284 | Payload = EI; |
285 | #endif |
286 | } |
287 | |
288 | bool getChecked() const { |
289 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
290 | return (reinterpret_cast<uintptr_t>(Payload) & 0x1) == 0; |
291 | #else |
292 | return true; |
293 | #endif |
294 | } |
295 | |
296 | void setChecked(bool V) { |
297 | Payload = reinterpret_cast<ErrorInfoBase*>( |
298 | (reinterpret_cast<uintptr_t>(Payload) & |
299 | ~static_cast<uintptr_t>(0x1)) | |
300 | (V ? 0 : 1)); |
301 | } |
302 | |
303 | std::unique_ptr<ErrorInfoBase> takePayload() { |
304 | std::unique_ptr<ErrorInfoBase> Tmp(getPtr()); |
305 | setPtr(nullptr); |
306 | setChecked(true); |
307 | return Tmp; |
308 | } |
309 | |
310 | friend raw_ostream &operator<<(raw_ostream &OS, const Error &E) { |
311 | if (auto P = E.getPtr()) |
312 | P->log(OS); |
313 | else |
314 | OS << "success"; |
315 | return OS; |
316 | } |
317 | |
318 | ErrorInfoBase *Payload = nullptr; |
319 | }; |
320 | |
321 | /// Subclass of Error for the sole purpose of identifying the success path in |
322 | /// the type system. This allows to catch invalid conversion to Expected<T> at |
323 | /// compile time. |
324 | class ErrorSuccess final : public Error {}; |
325 | |
326 | inline ErrorSuccess Error::success() { return ErrorSuccess(); } |
327 | |
328 | /// Make a Error instance representing failure using the given error info |
329 | /// type. |
330 | template <typename ErrT, typename... ArgTs> Error make_error(ArgTs &&... Args) { |
331 | return Error(std::make_unique<ErrT>(std::forward<ArgTs>(Args)...)); |
332 | } |
333 | |
334 | /// Base class for user error types. Users should declare their error types |
335 | /// like: |
336 | /// |
337 | /// class MyError : public ErrorInfo<MyError> { |
338 | /// .... |
339 | /// }; |
340 | /// |
341 | /// This class provides an implementation of the ErrorInfoBase::kind |
342 | /// method, which is used by the Error RTTI system. |
343 | template <typename ThisErrT, typename ParentErrT = ErrorInfoBase> |
344 | class ErrorInfo : public ParentErrT { |
345 | public: |
346 | using ParentErrT::ParentErrT; // inherit constructors |
347 | |
348 | static const void *classID() { return &ThisErrT::ID; } |
349 | |
350 | const void *dynamicClassID() const override { return &ThisErrT::ID; } |
351 | |
352 | bool isA(const void *const ClassID) const override { |
353 | return ClassID == classID() || ParentErrT::isA(ClassID); |
354 | } |
355 | }; |
356 | |
357 | /// Special ErrorInfo subclass representing a list of ErrorInfos. |
358 | /// Instances of this class are constructed by joinError. |
359 | class ErrorList final : public ErrorInfo<ErrorList> { |
360 | // handleErrors needs to be able to iterate the payload list of an |
361 | // ErrorList. |
362 | template <typename... HandlerTs> |
363 | friend Error handleErrors(Error E, HandlerTs &&... Handlers); |
364 | |
365 | // joinErrors is implemented in terms of join. |
366 | friend Error joinErrors(Error, Error); |
367 | |
368 | public: |
369 | void log(raw_ostream &OS) const override { |
370 | OS << "Multiple errors:\n"; |
371 | for (auto &ErrPayload : Payloads) { |
372 | ErrPayload->log(OS); |
373 | OS << "\n"; |
374 | } |
375 | } |
376 | |
377 | std::error_code convertToErrorCode() const override; |
378 | |
379 | // Used by ErrorInfo::classID. |
380 | static char ID; |
381 | |
382 | private: |
383 | ErrorList(std::unique_ptr<ErrorInfoBase> Payload1, |
384 | std::unique_ptr<ErrorInfoBase> Payload2) { |
385 | 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-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 386, __PRETTY_FUNCTION__)) |
386 | "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-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 386, __PRETTY_FUNCTION__)); |
387 | Payloads.push_back(std::move(Payload1)); |
388 | Payloads.push_back(std::move(Payload2)); |
389 | } |
390 | |
391 | static Error join(Error E1, Error E2) { |
392 | if (!E1) |
393 | return E2; |
394 | if (!E2) |
395 | return E1; |
396 | if (E1.isA<ErrorList>()) { |
397 | auto &E1List = static_cast<ErrorList &>(*E1.getPtr()); |
398 | if (E2.isA<ErrorList>()) { |
399 | auto E2Payload = E2.takePayload(); |
400 | auto &E2List = static_cast<ErrorList &>(*E2Payload); |
401 | for (auto &Payload : E2List.Payloads) |
402 | E1List.Payloads.push_back(std::move(Payload)); |
403 | } else |
404 | E1List.Payloads.push_back(E2.takePayload()); |
405 | |
406 | return E1; |
407 | } |
408 | if (E2.isA<ErrorList>()) { |
409 | auto &E2List = static_cast<ErrorList &>(*E2.getPtr()); |
410 | E2List.Payloads.insert(E2List.Payloads.begin(), E1.takePayload()); |
411 | return E2; |
412 | } |
413 | return Error(std::unique_ptr<ErrorList>( |
414 | new ErrorList(E1.takePayload(), E2.takePayload()))); |
415 | } |
416 | |
417 | std::vector<std::unique_ptr<ErrorInfoBase>> Payloads; |
418 | }; |
419 | |
420 | /// Concatenate errors. The resulting Error is unchecked, and contains the |
421 | /// ErrorInfo(s), if any, contained in E1, followed by the |
422 | /// ErrorInfo(s), if any, contained in E2. |
423 | inline Error joinErrors(Error E1, Error E2) { |
424 | return ErrorList::join(std::move(E1), std::move(E2)); |
425 | } |
426 | |
427 | /// Tagged union holding either a T or a Error. |
428 | /// |
429 | /// This class parallels ErrorOr, but replaces error_code with Error. Since |
430 | /// Error cannot be copied, this class replaces getError() with |
431 | /// takeError(). It also adds an bool errorIsA<ErrT>() method for testing the |
432 | /// error class type. |
433 | template <class T> class LLVM_NODISCARD[[clang::warn_unused_result]] Expected { |
434 | template <class T1> friend class ExpectedAsOutParameter; |
435 | template <class OtherT> friend class Expected; |
436 | |
437 | static const bool isRef = std::is_reference<T>::value; |
438 | |
439 | using wrap = std::reference_wrapper<typename std::remove_reference<T>::type>; |
440 | |
441 | using error_type = std::unique_ptr<ErrorInfoBase>; |
442 | |
443 | public: |
444 | using storage_type = typename std::conditional<isRef, wrap, T>::type; |
445 | using value_type = T; |
446 | |
447 | private: |
448 | using reference = typename std::remove_reference<T>::type &; |
449 | using const_reference = const typename std::remove_reference<T>::type &; |
450 | using pointer = typename std::remove_reference<T>::type *; |
451 | using const_pointer = const typename std::remove_reference<T>::type *; |
452 | |
453 | public: |
454 | /// Create an Expected<T> error value from the given Error. |
455 | Expected(Error Err) |
456 | : HasError(true) |
457 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
458 | // Expected is unchecked upon construction in Debug builds. |
459 | , Unchecked(true) |
460 | #endif |
461 | { |
462 | 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-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 462, __PRETTY_FUNCTION__)); |
463 | new (getErrorStorage()) error_type(Err.takePayload()); |
464 | } |
465 | |
466 | /// Forbid to convert from Error::success() implicitly, this avoids having |
467 | /// Expected<T> foo() { return Error::success(); } which compiles otherwise |
468 | /// but triggers the assertion above. |
469 | Expected(ErrorSuccess) = delete; |
470 | |
471 | /// Create an Expected<T> success value from the given OtherT value, which |
472 | /// must be convertible to T. |
473 | template <typename OtherT> |
474 | Expected(OtherT &&Val, |
475 | typename std::enable_if<std::is_convertible<OtherT, T>::value>::type |
476 | * = nullptr) |
477 | : HasError(false) |
478 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
479 | // Expected is unchecked upon construction in Debug builds. |
480 | , Unchecked(true) |
481 | #endif |
482 | { |
483 | new (getStorage()) storage_type(std::forward<OtherT>(Val)); |
484 | } |
485 | |
486 | /// Move construct an Expected<T> value. |
487 | Expected(Expected &&Other) { moveConstruct(std::move(Other)); } |
488 | |
489 | /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT |
490 | /// must be convertible to T. |
491 | template <class OtherT> |
492 | Expected(Expected<OtherT> &&Other, |
493 | typename std::enable_if<std::is_convertible<OtherT, T>::value>::type |
494 | * = nullptr) { |
495 | moveConstruct(std::move(Other)); |
496 | } |
497 | |
498 | /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT |
499 | /// isn't convertible to T. |
500 | template <class OtherT> |
501 | explicit Expected( |
502 | Expected<OtherT> &&Other, |
503 | typename std::enable_if<!std::is_convertible<OtherT, T>::value>::type * = |
504 | nullptr) { |
505 | moveConstruct(std::move(Other)); |
506 | } |
507 | |
508 | /// Move-assign from another Expected<T>. |
509 | Expected &operator=(Expected &&Other) { |
510 | moveAssign(std::move(Other)); |
511 | return *this; |
512 | } |
513 | |
514 | /// Destroy an Expected<T>. |
515 | ~Expected() { |
516 | assertIsChecked(); |
517 | if (!HasError) |
518 | getStorage()->~storage_type(); |
519 | else |
520 | getErrorStorage()->~error_type(); |
521 | } |
522 | |
523 | /// Return false if there is an error. |
524 | explicit operator bool() { |
525 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
526 | Unchecked = HasError; |
527 | #endif |
528 | return !HasError; |
529 | } |
530 | |
531 | /// Returns a reference to the stored T value. |
532 | reference get() { |
533 | assertIsChecked(); |
534 | return *getStorage(); |
535 | } |
536 | |
537 | /// Returns a const reference to the stored T value. |
538 | const_reference get() const { |
539 | assertIsChecked(); |
540 | return const_cast<Expected<T> *>(this)->get(); |
541 | } |
542 | |
543 | /// Check that this Expected<T> is an error of type ErrT. |
544 | template <typename ErrT> bool errorIsA() const { |
545 | return HasError && (*getErrorStorage())->template isA<ErrT>(); |
546 | } |
547 | |
548 | /// Take ownership of the stored error. |
549 | /// After calling this the Expected<T> is in an indeterminate state that can |
550 | /// only be safely destructed. No further calls (beside the destructor) should |
551 | /// be made on the Expected<T> value. |
552 | Error takeError() { |
553 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
554 | Unchecked = false; |
555 | #endif |
556 | return HasError ? Error(std::move(*getErrorStorage())) : Error::success(); |
557 | } |
558 | |
559 | /// Returns a pointer to the stored T value. |
560 | pointer operator->() { |
561 | assertIsChecked(); |
562 | return toPointer(getStorage()); |
563 | } |
564 | |
565 | /// Returns a const pointer to the stored T value. |
566 | const_pointer operator->() const { |
567 | assertIsChecked(); |
568 | return toPointer(getStorage()); |
569 | } |
570 | |
571 | /// Returns a reference to the stored T value. |
572 | reference operator*() { |
573 | assertIsChecked(); |
574 | return *getStorage(); |
575 | } |
576 | |
577 | /// Returns a const reference to the stored T value. |
578 | const_reference operator*() const { |
579 | assertIsChecked(); |
580 | return *getStorage(); |
581 | } |
582 | |
583 | private: |
584 | template <class T1> |
585 | static bool compareThisIfSameType(const T1 &a, const T1 &b) { |
586 | return &a == &b; |
587 | } |
588 | |
589 | template <class T1, class T2> |
590 | static bool compareThisIfSameType(const T1 &a, const T2 &b) { |
591 | return false; |
592 | } |
593 | |
594 | template <class OtherT> void moveConstruct(Expected<OtherT> &&Other) { |
595 | HasError = Other.HasError; |
596 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
597 | Unchecked = true; |
598 | Other.Unchecked = false; |
599 | #endif |
600 | |
601 | if (!HasError) |
602 | new (getStorage()) storage_type(std::move(*Other.getStorage())); |
603 | else |
604 | new (getErrorStorage()) error_type(std::move(*Other.getErrorStorage())); |
605 | } |
606 | |
607 | template <class OtherT> void moveAssign(Expected<OtherT> &&Other) { |
608 | assertIsChecked(); |
609 | |
610 | if (compareThisIfSameType(*this, Other)) |
611 | return; |
612 | |
613 | this->~Expected(); |
614 | new (this) Expected(std::move(Other)); |
615 | } |
616 | |
617 | pointer toPointer(pointer Val) { return Val; } |
618 | |
619 | const_pointer toPointer(const_pointer Val) const { return Val; } |
620 | |
621 | pointer toPointer(wrap *Val) { return &Val->get(); } |
622 | |
623 | const_pointer toPointer(const wrap *Val) const { return &Val->get(); } |
624 | |
625 | storage_type *getStorage() { |
626 | 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-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 626, __PRETTY_FUNCTION__)); |
627 | return reinterpret_cast<storage_type *>(TStorage.buffer); |
628 | } |
629 | |
630 | const storage_type *getStorage() const { |
631 | 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-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 631, __PRETTY_FUNCTION__)); |
632 | return reinterpret_cast<const storage_type *>(TStorage.buffer); |
633 | } |
634 | |
635 | error_type *getErrorStorage() { |
636 | 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-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 636, __PRETTY_FUNCTION__)); |
637 | return reinterpret_cast<error_type *>(ErrorStorage.buffer); |
638 | } |
639 | |
640 | const error_type *getErrorStorage() const { |
641 | 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-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 641, __PRETTY_FUNCTION__)); |
642 | return reinterpret_cast<const error_type *>(ErrorStorage.buffer); |
643 | } |
644 | |
645 | // Used by ExpectedAsOutParameter to reset the checked flag. |
646 | void setUnchecked() { |
647 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
648 | Unchecked = true; |
649 | #endif |
650 | } |
651 | |
652 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
653 | LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) |
654 | LLVM_ATTRIBUTE_NOINLINE__attribute__((noinline)) |
655 | void fatalUncheckedExpected() const { |
656 | dbgs() << "Expected<T> must be checked before access or destruction.\n"; |
657 | if (HasError) { |
658 | dbgs() << "Unchecked Expected<T> contained error:\n"; |
659 | (*getErrorStorage())->log(dbgs()); |
660 | } else |
661 | dbgs() << "Expected<T> value was in success state. (Note: Expected<T> " |
662 | "values in success mode must still be checked prior to being " |
663 | "destroyed).\n"; |
664 | abort(); |
665 | } |
666 | #endif |
667 | |
668 | void assertIsChecked() { |
669 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
670 | if (LLVM_UNLIKELY(Unchecked)__builtin_expect((bool)(Unchecked), false)) |
671 | fatalUncheckedExpected(); |
672 | #endif |
673 | } |
674 | |
675 | union { |
676 | AlignedCharArrayUnion<storage_type> TStorage; |
677 | AlignedCharArrayUnion<error_type> ErrorStorage; |
678 | }; |
679 | bool HasError : 1; |
680 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
681 | bool Unchecked : 1; |
682 | #endif |
683 | }; |
684 | |
685 | /// Report a serious error, calling any installed error handler. See |
686 | /// ErrorHandling.h. |
687 | LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void report_fatal_error(Error Err, |
688 | bool gen_crash_diag = true); |
689 | |
690 | /// Report a fatal error if Err is a failure value. |
691 | /// |
692 | /// This function can be used to wrap calls to fallible functions ONLY when it |
693 | /// is known that the Error will always be a success value. E.g. |
694 | /// |
695 | /// @code{.cpp} |
696 | /// // foo only attempts the fallible operation if DoFallibleOperation is |
697 | /// // true. If DoFallibleOperation is false then foo always returns |
698 | /// // Error::success(). |
699 | /// Error foo(bool DoFallibleOperation); |
700 | /// |
701 | /// cantFail(foo(false)); |
702 | /// @endcode |
703 | inline void cantFail(Error Err, const char *Msg = nullptr) { |
704 | if (Err) { |
705 | if (!Msg) |
706 | Msg = "Failure value returned from cantFail wrapped call"; |
707 | #ifndef NDEBUG |
708 | std::string Str; |
709 | raw_string_ostream OS(Str); |
710 | OS << Msg << "\n" << Err; |
711 | Msg = OS.str().c_str(); |
712 | #endif |
713 | llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 713); |
714 | } |
715 | } |
716 | |
717 | /// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and |
718 | /// returns the contained value. |
719 | /// |
720 | /// This function can be used to wrap calls to fallible functions ONLY when it |
721 | /// is known that the Error will always be a success value. E.g. |
722 | /// |
723 | /// @code{.cpp} |
724 | /// // foo only attempts the fallible operation if DoFallibleOperation is |
725 | /// // true. If DoFallibleOperation is false then foo always returns an int. |
726 | /// Expected<int> foo(bool DoFallibleOperation); |
727 | /// |
728 | /// int X = cantFail(foo(false)); |
729 | /// @endcode |
730 | template <typename T> |
731 | T cantFail(Expected<T> ValOrErr, const char *Msg = nullptr) { |
732 | if (ValOrErr) |
733 | return std::move(*ValOrErr); |
734 | else { |
735 | if (!Msg) |
736 | Msg = "Failure value returned from cantFail wrapped call"; |
737 | #ifndef NDEBUG |
738 | std::string Str; |
739 | raw_string_ostream OS(Str); |
740 | auto E = ValOrErr.takeError(); |
741 | OS << Msg << "\n" << E; |
742 | Msg = OS.str().c_str(); |
743 | #endif |
744 | llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 744); |
745 | } |
746 | } |
747 | |
748 | /// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and |
749 | /// returns the contained reference. |
750 | /// |
751 | /// This function can be used to wrap calls to fallible functions ONLY when it |
752 | /// is known that the Error will always be a success value. E.g. |
753 | /// |
754 | /// @code{.cpp} |
755 | /// // foo only attempts the fallible operation if DoFallibleOperation is |
756 | /// // true. If DoFallibleOperation is false then foo always returns a Bar&. |
757 | /// Expected<Bar&> foo(bool DoFallibleOperation); |
758 | /// |
759 | /// Bar &X = cantFail(foo(false)); |
760 | /// @endcode |
761 | template <typename T> |
762 | T& cantFail(Expected<T&> ValOrErr, const char *Msg = nullptr) { |
763 | if (ValOrErr) |
764 | return *ValOrErr; |
765 | else { |
766 | if (!Msg) |
767 | Msg = "Failure value returned from cantFail wrapped call"; |
768 | #ifndef NDEBUG |
769 | std::string Str; |
770 | raw_string_ostream OS(Str); |
771 | auto E = ValOrErr.takeError(); |
772 | OS << Msg << "\n" << E; |
773 | Msg = OS.str().c_str(); |
774 | #endif |
775 | llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 775); |
776 | } |
777 | } |
778 | |
779 | /// Helper for testing applicability of, and applying, handlers for |
780 | /// ErrorInfo types. |
781 | template <typename HandlerT> |
782 | class ErrorHandlerTraits |
783 | : public ErrorHandlerTraits<decltype( |
784 | &std::remove_reference<HandlerT>::type::operator())> {}; |
785 | |
786 | // Specialization functions of the form 'Error (const ErrT&)'. |
787 | template <typename ErrT> class ErrorHandlerTraits<Error (&)(ErrT &)> { |
788 | public: |
789 | static bool appliesTo(const ErrorInfoBase &E) { |
790 | return E.template isA<ErrT>(); |
791 | } |
792 | |
793 | template <typename HandlerT> |
794 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { |
795 | 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-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 795, __PRETTY_FUNCTION__)); |
796 | return H(static_cast<ErrT &>(*E)); |
797 | } |
798 | }; |
799 | |
800 | // Specialization functions of the form 'void (const ErrT&)'. |
801 | template <typename ErrT> class ErrorHandlerTraits<void (&)(ErrT &)> { |
802 | public: |
803 | static bool appliesTo(const ErrorInfoBase &E) { |
804 | return E.template isA<ErrT>(); |
805 | } |
806 | |
807 | template <typename HandlerT> |
808 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { |
809 | 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-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 809, __PRETTY_FUNCTION__)); |
810 | H(static_cast<ErrT &>(*E)); |
811 | return Error::success(); |
812 | } |
813 | }; |
814 | |
815 | /// Specialization for functions of the form 'Error (std::unique_ptr<ErrT>)'. |
816 | template <typename ErrT> |
817 | class ErrorHandlerTraits<Error (&)(std::unique_ptr<ErrT>)> { |
818 | public: |
819 | static bool appliesTo(const ErrorInfoBase &E) { |
820 | return E.template isA<ErrT>(); |
821 | } |
822 | |
823 | template <typename HandlerT> |
824 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { |
825 | 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-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 825, __PRETTY_FUNCTION__)); |
826 | std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release())); |
827 | return H(std::move(SubE)); |
828 | } |
829 | }; |
830 | |
831 | /// Specialization for functions of the form 'void (std::unique_ptr<ErrT>)'. |
832 | template <typename ErrT> |
833 | class ErrorHandlerTraits<void (&)(std::unique_ptr<ErrT>)> { |
834 | public: |
835 | static bool appliesTo(const ErrorInfoBase &E) { |
836 | return E.template isA<ErrT>(); |
837 | } |
838 | |
839 | template <typename HandlerT> |
840 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { |
841 | 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-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 841, __PRETTY_FUNCTION__)); |
842 | std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release())); |
843 | H(std::move(SubE)); |
844 | return Error::success(); |
845 | } |
846 | }; |
847 | |
848 | // Specialization for member functions of the form 'RetT (const ErrT&)'. |
849 | template <typename C, typename RetT, typename ErrT> |
850 | class ErrorHandlerTraits<RetT (C::*)(ErrT &)> |
851 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; |
852 | |
853 | // Specialization for member functions of the form 'RetT (const ErrT&) const'. |
854 | template <typename C, typename RetT, typename ErrT> |
855 | class ErrorHandlerTraits<RetT (C::*)(ErrT &) const> |
856 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; |
857 | |
858 | // Specialization for member functions of the form 'RetT (const ErrT&)'. |
859 | template <typename C, typename RetT, typename ErrT> |
860 | class ErrorHandlerTraits<RetT (C::*)(const ErrT &)> |
861 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; |
862 | |
863 | // Specialization for member functions of the form 'RetT (const ErrT&) const'. |
864 | template <typename C, typename RetT, typename ErrT> |
865 | class ErrorHandlerTraits<RetT (C::*)(const ErrT &) const> |
866 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; |
867 | |
868 | /// Specialization for member functions of the form |
869 | /// 'RetT (std::unique_ptr<ErrT>)'. |
870 | template <typename C, typename RetT, typename ErrT> |
871 | class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>)> |
872 | : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {}; |
873 | |
874 | /// Specialization for member functions of the form |
875 | /// 'RetT (std::unique_ptr<ErrT>) const'. |
876 | template <typename C, typename RetT, typename ErrT> |
877 | class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>) const> |
878 | : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {}; |
879 | |
880 | inline Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload) { |
881 | return Error(std::move(Payload)); |
882 | } |
883 | |
884 | template <typename HandlerT, typename... HandlerTs> |
885 | Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload, |
886 | HandlerT &&Handler, HandlerTs &&... Handlers) { |
887 | if (ErrorHandlerTraits<HandlerT>::appliesTo(*Payload)) |
888 | return ErrorHandlerTraits<HandlerT>::apply(std::forward<HandlerT>(Handler), |
889 | std::move(Payload)); |
890 | return handleErrorImpl(std::move(Payload), |
891 | std::forward<HandlerTs>(Handlers)...); |
892 | } |
893 | |
894 | /// Pass the ErrorInfo(s) contained in E to their respective handlers. Any |
895 | /// unhandled errors (or Errors returned by handlers) are re-concatenated and |
896 | /// returned. |
897 | /// Because this function returns an error, its result must also be checked |
898 | /// or returned. If you intend to handle all errors use handleAllErrors |
899 | /// (which returns void, and will abort() on unhandled errors) instead. |
900 | template <typename... HandlerTs> |
901 | Error handleErrors(Error E, HandlerTs &&... Hs) { |
902 | if (!E) |
903 | return Error::success(); |
904 | |
905 | std::unique_ptr<ErrorInfoBase> Payload = E.takePayload(); |
906 | |
907 | if (Payload->isA<ErrorList>()) { |
908 | ErrorList &List = static_cast<ErrorList &>(*Payload); |
909 | Error R; |
910 | for (auto &P : List.Payloads) |
911 | R = ErrorList::join( |
912 | std::move(R), |
913 | handleErrorImpl(std::move(P), std::forward<HandlerTs>(Hs)...)); |
914 | return R; |
915 | } |
916 | |
917 | return handleErrorImpl(std::move(Payload), std::forward<HandlerTs>(Hs)...); |
918 | } |
919 | |
920 | /// Behaves the same as handleErrors, except that by contract all errors |
921 | /// *must* be handled by the given handlers (i.e. there must be no remaining |
922 | /// errors after running the handlers, or llvm_unreachable is called). |
923 | template <typename... HandlerTs> |
924 | void handleAllErrors(Error E, HandlerTs &&... Handlers) { |
925 | cantFail(handleErrors(std::move(E), std::forward<HandlerTs>(Handlers)...)); |
926 | } |
927 | |
928 | /// Check that E is a non-error, then drop it. |
929 | /// If E is an error, llvm_unreachable will be called. |
930 | inline void handleAllErrors(Error E) { |
931 | cantFail(std::move(E)); |
932 | } |
933 | |
934 | /// Handle any errors (if present) in an Expected<T>, then try a recovery path. |
935 | /// |
936 | /// If the incoming value is a success value it is returned unmodified. If it |
937 | /// is a failure value then it the contained error is passed to handleErrors. |
938 | /// If handleErrors is able to handle the error then the RecoveryPath functor |
939 | /// is called to supply the final result. If handleErrors is not able to |
940 | /// handle all errors then the unhandled errors are returned. |
941 | /// |
942 | /// This utility enables the follow pattern: |
943 | /// |
944 | /// @code{.cpp} |
945 | /// enum FooStrategy { Aggressive, Conservative }; |
946 | /// Expected<Foo> foo(FooStrategy S); |
947 | /// |
948 | /// auto ResultOrErr = |
949 | /// handleExpected( |
950 | /// foo(Aggressive), |
951 | /// []() { return foo(Conservative); }, |
952 | /// [](AggressiveStrategyError&) { |
953 | /// // Implicitly conusme this - we'll recover by using a conservative |
954 | /// // strategy. |
955 | /// }); |
956 | /// |
957 | /// @endcode |
958 | template <typename T, typename RecoveryFtor, typename... HandlerTs> |
959 | Expected<T> handleExpected(Expected<T> ValOrErr, RecoveryFtor &&RecoveryPath, |
960 | HandlerTs &&... Handlers) { |
961 | if (ValOrErr) |
962 | return ValOrErr; |
963 | |
964 | if (auto Err = handleErrors(ValOrErr.takeError(), |
965 | std::forward<HandlerTs>(Handlers)...)) |
966 | return std::move(Err); |
967 | |
968 | return RecoveryPath(); |
969 | } |
970 | |
971 | /// Log all errors (if any) in E to OS. If there are any errors, ErrorBanner |
972 | /// will be printed before the first one is logged. A newline will be printed |
973 | /// after each error. |
974 | /// |
975 | /// This function is compatible with the helpers from Support/WithColor.h. You |
976 | /// can pass any of them as the OS. Please consider using them instead of |
977 | /// including 'error: ' in the ErrorBanner. |
978 | /// |
979 | /// This is useful in the base level of your program to allow clean termination |
980 | /// (allowing clean deallocation of resources, etc.), while reporting error |
981 | /// information to the user. |
982 | void logAllUnhandledErrors(Error E, raw_ostream &OS, Twine ErrorBanner = {}); |
983 | |
984 | /// Write all error messages (if any) in E to a string. The newline character |
985 | /// is used to separate error messages. |
986 | inline std::string toString(Error E) { |
987 | SmallVector<std::string, 2> Errors; |
988 | handleAllErrors(std::move(E), [&Errors](const ErrorInfoBase &EI) { |
989 | Errors.push_back(EI.message()); |
990 | }); |
991 | return join(Errors.begin(), Errors.end(), "\n"); |
992 | } |
993 | |
994 | /// Consume a Error without doing anything. This method should be used |
995 | /// only where an error can be considered a reasonable and expected return |
996 | /// value. |
997 | /// |
998 | /// Uses of this method are potentially indicative of design problems: If it's |
999 | /// legitimate to do nothing while processing an "error", the error-producer |
1000 | /// might be more clearly refactored to return an Optional<T>. |
1001 | inline void consumeError(Error Err) { |
1002 | handleAllErrors(std::move(Err), [](const ErrorInfoBase &) {}); |
1003 | } |
1004 | |
1005 | /// Convert an Expected to an Optional without doing anything. This method |
1006 | /// should be used only where an error can be considered a reasonable and |
1007 | /// expected return value. |
1008 | /// |
1009 | /// Uses of this method are potentially indicative of problems: perhaps the |
1010 | /// error should be propagated further, or the error-producer should just |
1011 | /// return an Optional in the first place. |
1012 | template <typename T> Optional<T> expectedToOptional(Expected<T> &&E) { |
1013 | if (E) |
1014 | return std::move(*E); |
1015 | consumeError(E.takeError()); |
1016 | return None; |
1017 | } |
1018 | |
1019 | /// Helper for converting an Error to a bool. |
1020 | /// |
1021 | /// This method returns true if Err is in an error state, or false if it is |
1022 | /// in a success state. Puts Err in a checked state in both cases (unlike |
1023 | /// Error::operator bool(), which only does this for success states). |
1024 | inline bool errorToBool(Error Err) { |
1025 | bool IsError = static_cast<bool>(Err); |
1026 | if (IsError) |
1027 | consumeError(std::move(Err)); |
1028 | return IsError; |
1029 | } |
1030 | |
1031 | /// Helper for Errors used as out-parameters. |
1032 | /// |
1033 | /// This helper is for use with the Error-as-out-parameter idiom, where an error |
1034 | /// is passed to a function or method by reference, rather than being returned. |
1035 | /// In such cases it is helpful to set the checked bit on entry to the function |
1036 | /// so that the error can be written to (unchecked Errors abort on assignment) |
1037 | /// and clear the checked bit on exit so that clients cannot accidentally forget |
1038 | /// to check the result. This helper performs these actions automatically using |
1039 | /// RAII: |
1040 | /// |
1041 | /// @code{.cpp} |
1042 | /// Result foo(Error &Err) { |
1043 | /// ErrorAsOutParameter ErrAsOutParam(&Err); // 'Checked' flag set |
1044 | /// // <body of foo> |
1045 | /// // <- 'Checked' flag auto-cleared when ErrAsOutParam is destructed. |
1046 | /// } |
1047 | /// @endcode |
1048 | /// |
1049 | /// ErrorAsOutParameter takes an Error* rather than Error& so that it can be |
1050 | /// used with optional Errors (Error pointers that are allowed to be null). If |
1051 | /// ErrorAsOutParameter took an Error reference, an instance would have to be |
1052 | /// created inside every condition that verified that Error was non-null. By |
1053 | /// taking an Error pointer we can just create one instance at the top of the |
1054 | /// function. |
1055 | class ErrorAsOutParameter { |
1056 | public: |
1057 | ErrorAsOutParameter(Error *Err) : Err(Err) { |
1058 | // Raise the checked bit if Err is success. |
1059 | if (Err) |
1060 | (void)!!*Err; |
1061 | } |
1062 | |
1063 | ~ErrorAsOutParameter() { |
1064 | // Clear the checked bit. |
1065 | if (Err && !*Err) |
1066 | *Err = Error::success(); |
1067 | } |
1068 | |
1069 | private: |
1070 | Error *Err; |
1071 | }; |
1072 | |
1073 | /// Helper for Expected<T>s used as out-parameters. |
1074 | /// |
1075 | /// See ErrorAsOutParameter. |
1076 | template <typename T> |
1077 | class ExpectedAsOutParameter { |
1078 | public: |
1079 | ExpectedAsOutParameter(Expected<T> *ValOrErr) |
1080 | : ValOrErr(ValOrErr) { |
1081 | if (ValOrErr) |
1082 | (void)!!*ValOrErr; |
1083 | } |
1084 | |
1085 | ~ExpectedAsOutParameter() { |
1086 | if (ValOrErr) |
1087 | ValOrErr->setUnchecked(); |
1088 | } |
1089 | |
1090 | private: |
1091 | Expected<T> *ValOrErr; |
1092 | }; |
1093 | |
1094 | /// This class wraps a std::error_code in a Error. |
1095 | /// |
1096 | /// This is useful if you're writing an interface that returns a Error |
1097 | /// (or Expected) and you want to call code that still returns |
1098 | /// std::error_codes. |
1099 | class ECError : public ErrorInfo<ECError> { |
1100 | friend Error errorCodeToError(std::error_code); |
1101 | |
1102 | virtual void anchor() override; |
1103 | |
1104 | public: |
1105 | void setErrorCode(std::error_code EC) { this->EC = EC; } |
1106 | std::error_code convertToErrorCode() const override { return EC; } |
1107 | void log(raw_ostream &OS) const override { OS << EC.message(); } |
1108 | |
1109 | // Used by ErrorInfo::classID. |
1110 | static char ID; |
1111 | |
1112 | protected: |
1113 | ECError() = default; |
1114 | ECError(std::error_code EC) : EC(EC) {} |
1115 | |
1116 | std::error_code EC; |
1117 | }; |
1118 | |
1119 | /// The value returned by this function can be returned from convertToErrorCode |
1120 | /// for Error values where no sensible translation to std::error_code exists. |
1121 | /// It should only be used in this situation, and should never be used where a |
1122 | /// sensible conversion to std::error_code is available, as attempts to convert |
1123 | /// to/from this error will result in a fatal error. (i.e. it is a programmatic |
1124 | ///error to try to convert such a value). |
1125 | std::error_code inconvertibleErrorCode(); |
1126 | |
1127 | /// Helper for converting an std::error_code to a Error. |
1128 | Error errorCodeToError(std::error_code EC); |
1129 | |
1130 | /// Helper for converting an ECError to a std::error_code. |
1131 | /// |
1132 | /// This method requires that Err be Error() or an ECError, otherwise it |
1133 | /// will trigger a call to abort(). |
1134 | std::error_code errorToErrorCode(Error Err); |
1135 | |
1136 | /// Convert an ErrorOr<T> to an Expected<T>. |
1137 | template <typename T> Expected<T> errorOrToExpected(ErrorOr<T> &&EO) { |
1138 | if (auto EC = EO.getError()) |
1139 | return errorCodeToError(EC); |
1140 | return std::move(*EO); |
1141 | } |
1142 | |
1143 | /// Convert an Expected<T> to an ErrorOr<T>. |
1144 | template <typename T> ErrorOr<T> expectedToErrorOr(Expected<T> &&E) { |
1145 | if (auto Err = E.takeError()) |
1146 | return errorToErrorCode(std::move(Err)); |
1147 | return std::move(*E); |
1148 | } |
1149 | |
1150 | /// This class wraps a string in an Error. |
1151 | /// |
1152 | /// StringError is useful in cases where the client is not expected to be able |
1153 | /// to consume the specific error message programmatically (for example, if the |
1154 | /// error message is to be presented to the user). |
1155 | /// |
1156 | /// StringError can also be used when additional information is to be printed |
1157 | /// along with a error_code message. Depending on the constructor called, this |
1158 | /// class can either display: |
1159 | /// 1. the error_code message (ECError behavior) |
1160 | /// 2. a string |
1161 | /// 3. the error_code message and a string |
1162 | /// |
1163 | /// These behaviors are useful when subtyping is required; for example, when a |
1164 | /// specific library needs an explicit error type. In the example below, |
1165 | /// PDBError is derived from StringError: |
1166 | /// |
1167 | /// @code{.cpp} |
1168 | /// Expected<int> foo() { |
1169 | /// return llvm::make_error<PDBError>(pdb_error_code::dia_failed_loading, |
1170 | /// "Additional information"); |
1171 | /// } |
1172 | /// @endcode |
1173 | /// |
1174 | class StringError : public ErrorInfo<StringError> { |
1175 | public: |
1176 | static char ID; |
1177 | |
1178 | // Prints EC + S and converts to EC |
1179 | StringError(std::error_code EC, const Twine &S = Twine()); |
1180 | |
1181 | // Prints S and converts to EC |
1182 | StringError(const Twine &S, std::error_code EC); |
1183 | |
1184 | void log(raw_ostream &OS) const override; |
1185 | std::error_code convertToErrorCode() const override; |
1186 | |
1187 | const std::string &getMessage() const { return Msg; } |
1188 | |
1189 | private: |
1190 | std::string Msg; |
1191 | std::error_code EC; |
1192 | const bool PrintMsgOnly = false; |
1193 | }; |
1194 | |
1195 | /// Create formatted StringError object. |
1196 | template <typename... Ts> |
1197 | inline Error createStringError(std::error_code EC, char const *Fmt, |
1198 | const Ts &... Vals) { |
1199 | std::string Buffer; |
1200 | raw_string_ostream Stream(Buffer); |
1201 | Stream << format(Fmt, Vals...); |
1202 | return make_error<StringError>(Stream.str(), EC); |
1203 | } |
1204 | |
1205 | Error createStringError(std::error_code EC, char const *Msg); |
1206 | |
1207 | inline Error createStringError(std::error_code EC, const Twine &S) { |
1208 | return createStringError(EC, S.str().c_str()); |
1209 | } |
1210 | |
1211 | template <typename... Ts> |
1212 | inline Error createStringError(std::errc EC, char const *Fmt, |
1213 | const Ts &... Vals) { |
1214 | return createStringError(std::make_error_code(EC), Fmt, Vals...); |
1215 | } |
1216 | |
1217 | /// This class wraps a filename and another Error. |
1218 | /// |
1219 | /// In some cases, an error needs to live along a 'source' name, in order to |
1220 | /// show more detailed information to the user. |
1221 | class FileError final : public ErrorInfo<FileError> { |
1222 | |
1223 | friend Error createFileError(const Twine &, Error); |
1224 | friend Error createFileError(const Twine &, size_t, Error); |
1225 | |
1226 | public: |
1227 | void log(raw_ostream &OS) const override { |
1228 | 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-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 1228, __PRETTY_FUNCTION__)); |
1229 | OS << "'" << FileName << "': "; |
1230 | if (Line.hasValue()) |
1231 | OS << "line " << Line.getValue() << ": "; |
1232 | Err->log(OS); |
1233 | } |
1234 | |
1235 | Error takeError() { return Error(std::move(Err)); } |
1236 | |
1237 | std::error_code convertToErrorCode() const override; |
1238 | |
1239 | // Used by ErrorInfo::classID. |
1240 | static char ID; |
1241 | |
1242 | private: |
1243 | FileError(const Twine &F, Optional<size_t> LineNum, |
1244 | std::unique_ptr<ErrorInfoBase> E) { |
1245 | 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-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 1245, __PRETTY_FUNCTION__)); |
1246 | assert(!F.isTriviallyEmpty() &&((!F.isTriviallyEmpty() && "The file name provided to FileError must not be empty." ) ? static_cast<void> (0) : __assert_fail ("!F.isTriviallyEmpty() && \"The file name provided to FileError must not be empty.\"" , "/build/llvm-toolchain-snapshot-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 1247, __PRETTY_FUNCTION__)) |
1247 | "The file name provided to FileError must not be empty.")((!F.isTriviallyEmpty() && "The file name provided to FileError must not be empty." ) ? static_cast<void> (0) : __assert_fail ("!F.isTriviallyEmpty() && \"The file name provided to FileError must not be empty.\"" , "/build/llvm-toolchain-snapshot-10~+201911111502510600c19528f1809/llvm/include/llvm/Support/Error.h" , 1247, __PRETTY_FUNCTION__)); |
1248 | FileName = F.str(); |
1249 | Err = std::move(E); |
1250 | Line = std::move(LineNum); |
1251 | } |
1252 | |
1253 | static Error build(const Twine &F, Optional<size_t> Line, Error E) { |
1254 | return Error( |
1255 | std::unique_ptr<FileError>(new FileError(F, Line, E.takePayload()))); |
1256 | } |
1257 | |
1258 | std::string FileName; |
1259 | Optional<size_t> Line; |
1260 | std::unique_ptr<ErrorInfoBase> Err; |
1261 | }; |
1262 | |
1263 | /// Concatenate a source file path and/or name with an Error. The resulting |
1264 | /// Error is unchecked. |
1265 | inline Error createFileError(const Twine &F, Error E) { |
1266 | return FileError::build(F, Optional<size_t>(), std::move(E)); |
1267 | } |
1268 | |
1269 | /// Concatenate a source file path and/or name with line number and an Error. |
1270 | /// The resulting Error is unchecked. |
1271 | inline Error createFileError(const Twine &F, size_t Line, Error E) { |
1272 | return FileError::build(F, Optional<size_t>(Line), std::move(E)); |
1273 | } |
1274 | |
1275 | /// Concatenate a source file path and/or name with a std::error_code |
1276 | /// to form an Error object. |
1277 | inline Error createFileError(const Twine &F, std::error_code EC) { |
1278 | return createFileError(F, errorCodeToError(EC)); |
1279 | } |
1280 | |
1281 | /// Concatenate a source file path and/or name with line number and |
1282 | /// std::error_code to form an Error object. |
1283 | inline Error createFileError(const Twine &F, size_t Line, std::error_code EC) { |
1284 | return createFileError(F, Line, errorCodeToError(EC)); |
1285 | } |
1286 | |
1287 | Error createFileError(const Twine &F, ErrorSuccess) = delete; |
1288 | |
1289 | /// Helper for check-and-exit error handling. |
1290 | /// |
1291 | /// For tool use only. NOT FOR USE IN LIBRARY CODE. |
1292 | /// |
1293 | class ExitOnError { |
1294 | public: |
1295 | /// Create an error on exit helper. |
1296 | ExitOnError(std::string Banner = "", int DefaultErrorExitCode = 1) |
1297 | : Banner(std::move(Banner)), |
1298 | GetExitCode([=](const Error &) { return DefaultErrorExitCode; }) {} |
1299 | |
1300 | /// Set the banner string for any errors caught by operator(). |
1301 | void setBanner(std::string Banner) { this->Banner = std::move(Banner); } |
1302 | |
1303 | /// Set the exit-code mapper function. |
1304 | void setExitCodeMapper(std::function<int(const Error &)> GetExitCode) { |
1305 | this->GetExitCode = std::move(GetExitCode); |
1306 | } |
1307 | |
1308 | /// Check Err. If it's in a failure state log the error(s) and exit. |
1309 | void operator()(Error Err) const { checkError(std::move(Err)); } |
1310 | |
1311 | /// Check E. If it's in a success state then return the contained value. If |
1312 | /// it's in a failure state log the error(s) and exit. |
1313 | template <typename T> T operator()(Expected<T> &&E) const { |
1314 | checkError(E.takeError()); |
1315 | return std::move(*E); |
1316 | } |
1317 | |
1318 | /// Check E. If it's in a success state then return the contained reference. If |
1319 | /// it's in a failure state log the error(s) and exit. |
1320 | template <typename T> T& operator()(Expected<T&> &&E) const { |
1321 | checkError(E.takeError()); |
1322 | return *E; |
1323 | } |
1324 | |
1325 | private: |
1326 | void checkError(Error Err) const { |
1327 | if (Err) { |
1328 | int ExitCode = GetExitCode(Err); |
1329 | logAllUnhandledErrors(std::move(Err), errs(), Banner); |
1330 | exit(ExitCode); |
1331 | } |
1332 | } |
1333 | |
1334 | std::string Banner; |
1335 | std::function<int(const Error &)> GetExitCode; |
1336 | }; |
1337 | |
1338 | /// Conversion from Error to LLVMErrorRef for C error bindings. |
1339 | inline LLVMErrorRef wrap(Error Err) { |
1340 | return reinterpret_cast<LLVMErrorRef>(Err.takePayload().release()); |
1341 | } |
1342 | |
1343 | /// Conversion from LLVMErrorRef to Error for C error bindings. |
1344 | inline Error unwrap(LLVMErrorRef ErrRef) { |
1345 | return Error(std::unique_ptr<ErrorInfoBase>( |
1346 | reinterpret_cast<ErrorInfoBase *>(ErrRef))); |
1347 | } |
1348 | |
1349 | } // end namespace llvm |
1350 | |
1351 | #endif // LLVM_SUPPORT_ERROR_H |