Bug Summary

File:src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Bitcode/Reader/BitcodeAnalyzer.cpp
Warning:line 437, column 22
The left operand of '==' is a garbage value

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple amd64-unknown-openbsd7.0 -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name BitcodeAnalyzer.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 1 -fhalf-no-semantic-interposition -mframe-pointer=all -relaxed-aliasing -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -fcoverage-compilation-dir=/usr/src/gnu/usr.bin/clang/libLLVM/obj -resource-dir /usr/local/lib/clang/13.0.0 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Analysis -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ASMParser -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/BinaryFormat -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Bitcode -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Bitcode -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Bitstream -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /include/llvm/CodeGen -I /include/llvm/CodeGen/PBQP -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/IR -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/IR -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Coroutines -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ProfileData/Coverage -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/CodeView -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/DWARF -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/MSF -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/PDB -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Demangle -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ExecutionEngine -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ExecutionEngine/JITLink -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ExecutionEngine/Orc -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend/OpenACC -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend/OpenMP -I /include/llvm/CodeGen/GlobalISel -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/IRReader -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/InstCombine -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/Transforms/InstCombine -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/LTO -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Linker -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/MC -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/MC/MCParser -I /include/llvm/CodeGen/MIRParser -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Object -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Option -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Passes -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ProfileData -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Scalar -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ADT -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Support -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/Symbolize -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Target -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Utils -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Vectorize -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/IPO -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include -I /usr/src/gnu/usr.bin/clang/libLLVM/../include -I /usr/src/gnu/usr.bin/clang/libLLVM/obj -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include -D NDEBUG -D __STDC_LIMIT_MACROS -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D LLVM_PREFIX="/usr" -D PIC -internal-isystem /usr/include/c++/v1 -internal-isystem /usr/local/lib/clang/13.0.0/include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir=/usr/src/gnu/usr.bin/clang/libLLVM/obj -ferror-limit 19 -fvisibility-inlines-hidden -fwrapv -D_RET_PROTECTOR -ret-protector -fno-rtti -fgnuc-version=4.2.1 -vectorize-loops -vectorize-slp -fno-builtin-malloc -fno-builtin-calloc -fno-builtin-realloc -fno-builtin-valloc -fno-builtin-free -fno-builtin-strdup -fno-builtin-strndup -analyzer-output=html -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /home/ben/Projects/vmm/scan-build/2022-01-12-194120-40624-1 -x c++ /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Bitcode/Reader/BitcodeAnalyzer.cpp

/usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Bitcode/Reader/BitcodeAnalyzer.cpp

→
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
17using namespace llvm;
18
19static 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.
24static 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.
87static 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) // Deprecated, present in old bitcode
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, COMDAT)
139 STRINGIFY_CODE(MODULE_CODE, VSTOFFSET)
140 STRINGIFY_CODE(MODULE_CODE, METADATA_VALUES_UNUSED)
141 STRINGIFY_CODE(MODULE_CODE, SOURCE_FILENAME)
142 STRINGIFY_CODE(MODULE_CODE, HASH)
143 }
144 case bitc::IDENTIFICATION_BLOCK_ID:
145 switch (CodeID) {
146 default:
147 return None;
148 STRINGIFY_CODE(IDENTIFICATION_CODE, STRING)
149 STRINGIFY_CODE(IDENTIFICATION_CODE, EPOCH)
150 }
151 case bitc::PARAMATTR_BLOCK_ID:
152 switch (CodeID) {
153 default:
154 return None;
155 // FIXME: Should these be different?
156 case bitc::PARAMATTR_CODE_ENTRY_OLD:
157 return "ENTRY";
158 case bitc::PARAMATTR_CODE_ENTRY:
159 return "ENTRY";
160 }
161 case bitc::PARAMATTR_GROUP_BLOCK_ID:
162 switch (CodeID) {
163 default:
164 return None;
165 case bitc::PARAMATTR_GRP_CODE_ENTRY:
166 return "ENTRY";
167 }
168 case bitc::TYPE_BLOCK_ID_NEW:
169 switch (CodeID) {
170 default:
171 return None;
172 STRINGIFY_CODE(TYPE_CODE, NUMENTRY)
173 STRINGIFY_CODE(TYPE_CODE, VOID)
174 STRINGIFY_CODE(TYPE_CODE, FLOAT)
175 STRINGIFY_CODE(TYPE_CODE, DOUBLE)
176 STRINGIFY_CODE(TYPE_CODE, LABEL)
177 STRINGIFY_CODE(TYPE_CODE, OPAQUE)
178 STRINGIFY_CODE(TYPE_CODE, INTEGER)
179 STRINGIFY_CODE(TYPE_CODE, POINTER)
180 STRINGIFY_CODE(TYPE_CODE, HALF)
181 STRINGIFY_CODE(TYPE_CODE, ARRAY)
182 STRINGIFY_CODE(TYPE_CODE, VECTOR)
183 STRINGIFY_CODE(TYPE_CODE, X86_FP80)
184 STRINGIFY_CODE(TYPE_CODE, FP128)
185 STRINGIFY_CODE(TYPE_CODE, PPC_FP128)
186 STRINGIFY_CODE(TYPE_CODE, METADATA)
187 STRINGIFY_CODE(TYPE_CODE, X86_MMX)
188 STRINGIFY_CODE(TYPE_CODE, STRUCT_ANON)
189 STRINGIFY_CODE(TYPE_CODE, STRUCT_NAME)
190 STRINGIFY_CODE(TYPE_CODE, STRUCT_NAMED)
191 STRINGIFY_CODE(TYPE_CODE, FUNCTION)
192 STRINGIFY_CODE(TYPE_CODE, TOKEN)
193 STRINGIFY_CODE(TYPE_CODE, BFLOAT)
194 }
195
196 case bitc::CONSTANTS_BLOCK_ID:
197 switch (CodeID) {
198 default:
199 return None;
200 STRINGIFY_CODE(CST_CODE, SETTYPE)
201 STRINGIFY_CODE(CST_CODE, NULL__null)
202 STRINGIFY_CODE(CST_CODE, UNDEF)
203 STRINGIFY_CODE(CST_CODE, INTEGER)
204 STRINGIFY_CODE(CST_CODE, WIDE_INTEGER)
205 STRINGIFY_CODE(CST_CODE, FLOAT)
206 STRINGIFY_CODE(CST_CODE, AGGREGATE)
207 STRINGIFY_CODE(CST_CODE, STRING)
208 STRINGIFY_CODE(CST_CODE, CSTRING)
209 STRINGIFY_CODE(CST_CODE, CE_BINOP)
210 STRINGIFY_CODE(CST_CODE, CE_CAST)
211 STRINGIFY_CODE(CST_CODE, CE_GEP)
212 STRINGIFY_CODE(CST_CODE, CE_INBOUNDS_GEP)
213 STRINGIFY_CODE(CST_CODE, CE_SELECT)
214 STRINGIFY_CODE(CST_CODE, CE_EXTRACTELT)
215 STRINGIFY_CODE(CST_CODE, CE_INSERTELT)
216 STRINGIFY_CODE(CST_CODE, CE_SHUFFLEVEC)
217 STRINGIFY_CODE(CST_CODE, CE_CMP)
218 STRINGIFY_CODE(CST_CODE, INLINEASM)
219 STRINGIFY_CODE(CST_CODE, CE_SHUFVEC_EX)
220 STRINGIFY_CODE(CST_CODE, CE_UNOP)
221 STRINGIFY_CODE(CST_CODE, DSO_LOCAL_EQUIVALENT)
222 case bitc::CST_CODE_BLOCKADDRESS:
223 return "CST_CODE_BLOCKADDRESS";
224 STRINGIFY_CODE(CST_CODE, DATA)
225 }
226 case bitc::FUNCTION_BLOCK_ID:
227 switch (CodeID) {
228 default:
229 return None;
230 STRINGIFY_CODE(FUNC_CODE, DECLAREBLOCKS)
231 STRINGIFY_CODE(FUNC_CODE, INST_BINOP)
232 STRINGIFY_CODE(FUNC_CODE, INST_CAST)
233 STRINGIFY_CODE(FUNC_CODE, INST_GEP_OLD)
234 STRINGIFY_CODE(FUNC_CODE, INST_INBOUNDS_GEP_OLD)
235 STRINGIFY_CODE(FUNC_CODE, INST_SELECT)
236 STRINGIFY_CODE(FUNC_CODE, INST_EXTRACTELT)
237 STRINGIFY_CODE(FUNC_CODE, INST_INSERTELT)
238 STRINGIFY_CODE(FUNC_CODE, INST_SHUFFLEVEC)
239 STRINGIFY_CODE(FUNC_CODE, INST_CMP)
240 STRINGIFY_CODE(FUNC_CODE, INST_RET)
241 STRINGIFY_CODE(FUNC_CODE, INST_BR)
242 STRINGIFY_CODE(FUNC_CODE, INST_SWITCH)
243 STRINGIFY_CODE(FUNC_CODE, INST_INVOKE)
244 STRINGIFY_CODE(FUNC_CODE, INST_UNOP)
245 STRINGIFY_CODE(FUNC_CODE, INST_UNREACHABLE)
246 STRINGIFY_CODE(FUNC_CODE, INST_CLEANUPRET)
247 STRINGIFY_CODE(FUNC_CODE, INST_CATCHRET)
248 STRINGIFY_CODE(FUNC_CODE, INST_CATCHPAD)
249 STRINGIFY_CODE(FUNC_CODE, INST_PHI)
250 STRINGIFY_CODE(FUNC_CODE, INST_ALLOCA)
251 STRINGIFY_CODE(FUNC_CODE, INST_LOAD)
252 STRINGIFY_CODE(FUNC_CODE, INST_VAARG)
253 STRINGIFY_CODE(FUNC_CODE, INST_STORE)
254 STRINGIFY_CODE(FUNC_CODE, INST_EXTRACTVAL)
255 STRINGIFY_CODE(FUNC_CODE, INST_INSERTVAL)
256 STRINGIFY_CODE(FUNC_CODE, INST_CMP2)
257 STRINGIFY_CODE(FUNC_CODE, INST_VSELECT)
258 STRINGIFY_CODE(FUNC_CODE, DEBUG_LOC_AGAIN)
259 STRINGIFY_CODE(FUNC_CODE, INST_CALL)
260 STRINGIFY_CODE(FUNC_CODE, DEBUG_LOC)
261 STRINGIFY_CODE(FUNC_CODE, INST_GEP)
262 STRINGIFY_CODE(FUNC_CODE, OPERAND_BUNDLE)
263 STRINGIFY_CODE(FUNC_CODE, INST_FENCE)
264 STRINGIFY_CODE(FUNC_CODE, INST_ATOMICRMW)
265 STRINGIFY_CODE(FUNC_CODE, INST_LOADATOMIC)
266 STRINGIFY_CODE(FUNC_CODE, INST_STOREATOMIC)
267 STRINGIFY_CODE(FUNC_CODE, INST_CMPXCHG)
268 STRINGIFY_CODE(FUNC_CODE, INST_CALLBR)
269 }
270 case bitc::VALUE_SYMTAB_BLOCK_ID:
271 switch (CodeID) {
272 default:
273 return None;
274 STRINGIFY_CODE(VST_CODE, ENTRY)
275 STRINGIFY_CODE(VST_CODE, BBENTRY)
276 STRINGIFY_CODE(VST_CODE, FNENTRY)
277 STRINGIFY_CODE(VST_CODE, COMBINED_ENTRY)
278 }
279 case bitc::MODULE_STRTAB_BLOCK_ID:
280 switch (CodeID) {
281 default:
282 return None;
283 STRINGIFY_CODE(MST_CODE, ENTRY)
284 STRINGIFY_CODE(MST_CODE, HASH)
285 }
286 case bitc::GLOBALVAL_SUMMARY_BLOCK_ID:
287 case bitc::FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID:
288 switch (CodeID) {
289 default:
290 return None;
291 STRINGIFY_CODE(FS, PERMODULE)
292 STRINGIFY_CODE(FS, PERMODULE_PROFILE)
293 STRINGIFY_CODE(FS, PERMODULE_RELBF)
294 STRINGIFY_CODE(FS, PERMODULE_GLOBALVAR_INIT_REFS)
295 STRINGIFY_CODE(FS, PERMODULE_VTABLE_GLOBALVAR_INIT_REFS)
296 STRINGIFY_CODE(FS, COMBINED)
297 STRINGIFY_CODE(FS, COMBINED_PROFILE)
298 STRINGIFY_CODE(FS, COMBINED_GLOBALVAR_INIT_REFS)
299 STRINGIFY_CODE(FS, ALIAS)
300 STRINGIFY_CODE(FS, COMBINED_ALIAS)
301 STRINGIFY_CODE(FS, COMBINED_ORIGINAL_NAME)
302 STRINGIFY_CODE(FS, VERSION)
303 STRINGIFY_CODE(FS, FLAGS)
304 STRINGIFY_CODE(FS, TYPE_TESTS)
305 STRINGIFY_CODE(FS, TYPE_TEST_ASSUME_VCALLS)
306 STRINGIFY_CODE(FS, TYPE_CHECKED_LOAD_VCALLS)
307 STRINGIFY_CODE(FS, TYPE_TEST_ASSUME_CONST_VCALL)
308 STRINGIFY_CODE(FS, TYPE_CHECKED_LOAD_CONST_VCALL)
309 STRINGIFY_CODE(FS, VALUE_GUID)
310 STRINGIFY_CODE(FS, CFI_FUNCTION_DEFS)
311 STRINGIFY_CODE(FS, CFI_FUNCTION_DECLS)
312 STRINGIFY_CODE(FS, TYPE_ID)
313 STRINGIFY_CODE(FS, TYPE_ID_METADATA)
314 STRINGIFY_CODE(FS, BLOCK_COUNT)
315 STRINGIFY_CODE(FS, PARAM_ACCESS)
316 }
317 case bitc::METADATA_ATTACHMENT_ID:
318 switch (CodeID) {
319 default:
320 return None;
321 STRINGIFY_CODE(METADATA, ATTACHMENT)
322 }
323 case bitc::METADATA_BLOCK_ID:
324 switch (CodeID) {
325 default:
326 return None;
327 STRINGIFY_CODE(METADATA, STRING_OLD)
328 STRINGIFY_CODE(METADATA, VALUE)
329 STRINGIFY_CODE(METADATA, NODE)
330 STRINGIFY_CODE(METADATA, NAME)
331 STRINGIFY_CODE(METADATA, DISTINCT_NODE)
332 STRINGIFY_CODE(METADATA, KIND) // Older bitcode has it in a MODULE_BLOCK
333 STRINGIFY_CODE(METADATA, LOCATION)
334 STRINGIFY_CODE(METADATA, OLD_NODE)
335 STRINGIFY_CODE(METADATA, OLD_FN_NODE)
336 STRINGIFY_CODE(METADATA, NAMED_NODE)
337 STRINGIFY_CODE(METADATA, GENERIC_DEBUG)
338 STRINGIFY_CODE(METADATA, SUBRANGE)
339 STRINGIFY_CODE(METADATA, ENUMERATOR)
340 STRINGIFY_CODE(METADATA, BASIC_TYPE)
341 STRINGIFY_CODE(METADATA, FILE)
342 STRINGIFY_CODE(METADATA, DERIVED_TYPE)
343 STRINGIFY_CODE(METADATA, COMPOSITE_TYPE)
344 STRINGIFY_CODE(METADATA, SUBROUTINE_TYPE)
345 STRINGIFY_CODE(METADATA, COMPILE_UNIT)
346 STRINGIFY_CODE(METADATA, SUBPROGRAM)
347 STRINGIFY_CODE(METADATA, LEXICAL_BLOCK)
348 STRINGIFY_CODE(METADATA, LEXICAL_BLOCK_FILE)
349 STRINGIFY_CODE(METADATA, NAMESPACE)
350 STRINGIFY_CODE(METADATA, TEMPLATE_TYPE)
351 STRINGIFY_CODE(METADATA, TEMPLATE_VALUE)
352 STRINGIFY_CODE(METADATA, GLOBAL_VAR)
353 STRINGIFY_CODE(METADATA, LOCAL_VAR)
354 STRINGIFY_CODE(METADATA, EXPRESSION)
355 STRINGIFY_CODE(METADATA, OBJC_PROPERTY)
356 STRINGIFY_CODE(METADATA, IMPORTED_ENTITY)
357 STRINGIFY_CODE(METADATA, MODULE)
358 STRINGIFY_CODE(METADATA, MACRO)
359 STRINGIFY_CODE(METADATA, MACRO_FILE)
360 STRINGIFY_CODE(METADATA, STRINGS)
361 STRINGIFY_CODE(METADATA, GLOBAL_DECL_ATTACHMENT)
362 STRINGIFY_CODE(METADATA, GLOBAL_VAR_EXPR)
363 STRINGIFY_CODE(METADATA, INDEX_OFFSET)
364 STRINGIFY_CODE(METADATA, INDEX)
365 STRINGIFY_CODE(METADATA, ARG_LIST)
366 }
367 case bitc::METADATA_KIND_BLOCK_ID:
368 switch (CodeID) {
369 default:
370 return None;
371 STRINGIFY_CODE(METADATA, KIND)
372 }
373 case bitc::USELIST_BLOCK_ID:
374 switch (CodeID) {
375 default:
376 return None;
377 case bitc::USELIST_CODE_DEFAULT:
378 return "USELIST_CODE_DEFAULT";
379 case bitc::USELIST_CODE_BB:
380 return "USELIST_CODE_BB";
381 }
382
383 case bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID:
384 switch (CodeID) {
385 default:
386 return None;
387 case bitc::OPERAND_BUNDLE_TAG:
388 return "OPERAND_BUNDLE_TAG";
389 }
390 case bitc::STRTAB_BLOCK_ID:
391 switch (CodeID) {
392 default:
393 return None;
394 case bitc::STRTAB_BLOB:
395 return "BLOB";
396 }
397 case bitc::SYMTAB_BLOCK_ID:
398 switch (CodeID) {
399 default:
400 return None;
401 case bitc::SYMTAB_BLOB:
402 return "BLOB";
403 }
404 }
405#undef STRINGIFY_CODE
406}
407
408static void printSize(raw_ostream &OS, double Bits) {
409 OS << format("%.2f/%.2fB/%luW", Bits, Bits / 8, (unsigned long)(Bits / 32));
410}
411static void printSize(raw_ostream &OS, uint64_t Bits) {
412 OS << format("%lub/%.2fB/%luW", (unsigned long)Bits, (double)Bits / 8,
413 (unsigned long)(Bits / 32));
414}
415
416static Expected<CurStreamTypeType> ReadSignature(BitstreamCursor &Stream) {
417 auto tryRead = [&Stream](char &Dest, size_t size) -> Error {
418 if (Expected<SimpleBitstreamCursor::word_t> MaybeWord = Stream.Read(size))
8
←
Taking true branch
→
22
←
Taking false branch
→
419 Dest = MaybeWord.get();
420 else
421 return MaybeWord.takeError();
23
←
Returning without writing to 'Dest'
→
422 return Error::success();
423 };
424
425 char Signature[6];
426 if (Error Err = tryRead(Signature[0], 8))
7
←
Calling 'operator()'
→
9
←
Returning from 'operator()'
→
10
←
Calling 'Error::operator bool'
→
12
←
Returning from 'Error::operator bool'
→
13
←
Taking false branch
→
427 return std::move(Err);
428 if (Error Err = tryRead(Signature[1], 8))
14
←
Calling 'Error::operator bool'
→
16
←
Returning from 'Error::operator bool'
→
17
←
Taking false branch
→
429 return std::move(Err);
430
431 // Autodetect the file contents, if it is one we know.
432 if (Signature[0] == 'C' && Signature[1] == 'P') {
18
←
Assuming the condition is true
→
19
←
Assuming the condition is true
→
20
←
Taking true branch
→
433 if (Error Err = tryRead(Signature[2], 8))
21
←
Calling 'operator()'
→
24
←
Returning from 'operator()'
→
25
←
Calling 'Error::operator bool'
→
28
←
Returning from 'Error::operator bool'
→
29
←
Taking false branch
→
434 return std::move(Err);
435 if (Error Err = tryRead(Signature[3], 8))
30
←
Calling 'Error::operator bool'
→
32
←
Returning from 'Error::operator bool'
→
33
←
Taking false branch
→
436 return std::move(Err);
437 if (Signature[2] == 'C' && Signature[3] == 'H')
34
←
The left operand of '==' is a garbage value
438 return ClangSerializedASTBitstream;
439 } else if (Signature[0] == 'D' && Signature[1] == 'I') {
440 if (Error Err = tryRead(Signature[2], 8))
441 return std::move(Err);
442 if (Error Err = tryRead(Signature[3], 8))
443 return std::move(Err);
444 if (Signature[2] == 'A' && Signature[3] == 'G')
445 return ClangSerializedDiagnosticsBitstream;
446 } else if (Signature[0] == 'R' && Signature[1] == 'M') {
447 if (Error Err = tryRead(Signature[2], 8))
448 return std::move(Err);
449 if (Error Err = tryRead(Signature[3], 8))
450 return std::move(Err);
451 if (Signature[2] == 'R' && Signature[3] == 'K')
452 return LLVMBitstreamRemarks;
453 } else {
454 if (Error Err = tryRead(Signature[2], 4))
455 return std::move(Err);
456 if (Error Err = tryRead(Signature[3], 4))
457 return std::move(Err);
458 if (Error Err = tryRead(Signature[4], 4))
459 return std::move(Err);
460 if (Error Err = tryRead(Signature[5], 4))
461 return std::move(Err);
462 if (Signature[0] == 'B' && Signature[1] == 'C' && Signature[2] == 0x0 &&
463 Signature[3] == 0xC && Signature[4] == 0xE && Signature[5] == 0xD)
464 return LLVMIRBitstream;
465 }
466 return UnknownBitstream;
467}
468
469static Expected<CurStreamTypeType> analyzeHeader(Optional<BCDumpOptions> O,
470 BitstreamCursor &Stream) {
471 ArrayRef<uint8_t> Bytes = Stream.getBitcodeBytes();
472 const unsigned char *BufPtr = (const unsigned char *)Bytes.data();
473 const unsigned char *EndBufPtr = BufPtr + Bytes.size();
474
475 // If we have a wrapper header, parse it and ignore the non-bc file
476 // contents. The magic number is 0x0B17C0DE stored in little endian.
477 if (isBitcodeWrapper(BufPtr, EndBufPtr)) {
5
←
Taking false branch
→
478 if (Bytes.size() < BWH_HeaderSize)
479 return reportError("Invalid bitcode wrapper header");
480
481 if (O) {
482 unsigned Magic = support::endian::read32le(&BufPtr[BWH_MagicField]);
483 unsigned Version = support::endian::read32le(&BufPtr[BWH_VersionField]);
484 unsigned Offset = support::endian::read32le(&BufPtr[BWH_OffsetField]);
485 unsigned Size = support::endian::read32le(&BufPtr[BWH_SizeField]);
486 unsigned CPUType = support::endian::read32le(&BufPtr[BWH_CPUTypeField]);
487
488 O->OS << "<BITCODE_WRAPPER_HEADER"
489 << " Magic=" << format_hex(Magic, 10)
490 << " Version=" << format_hex(Version, 10)
491 << " Offset=" << format_hex(Offset, 10)
492 << " Size=" << format_hex(Size, 10)
493 << " CPUType=" << format_hex(CPUType, 10) << "/>\n";
494 }
495
496 if (SkipBitcodeWrapperHeader(BufPtr, EndBufPtr, true))
497 return reportError("Invalid bitcode wrapper header");
498 }
499
500 // Use the cursor modified by skipping the wrapper header.
501 Stream = BitstreamCursor(ArrayRef<uint8_t>(BufPtr, EndBufPtr));
502
503 return ReadSignature(Stream);
6
←
Calling 'ReadSignature'
→
504}
505
506static bool canDecodeBlob(unsigned Code, unsigned BlockID) {
507 return BlockID == bitc::METADATA_BLOCK_ID && Code == bitc::METADATA_STRINGS;
508}
509
510Error BitcodeAnalyzer::decodeMetadataStringsBlob(StringRef Indent,
511 ArrayRef<uint64_t> Record,
512 StringRef Blob,
513 raw_ostream &OS) {
514 if (Blob.empty())
515 return reportError("Cannot decode empty blob.");
516
517 if (Record.size() != 2)
518 return reportError(
519 "Decoding metadata strings blob needs two record entries.");
520
521 unsigned NumStrings = Record[0];
522 unsigned StringsOffset = Record[1];
523 OS << " num-strings = " << NumStrings << " {\n";
524
525 StringRef Lengths = Blob.slice(0, StringsOffset);
526 SimpleBitstreamCursor R(Lengths);
527 StringRef Strings = Blob.drop_front(StringsOffset);
528 do {
529 if (R.AtEndOfStream())
530 return reportError("bad length");
531
532 Expected<uint32_t> MaybeSize = R.ReadVBR(6);
533 if (!MaybeSize)
534 return MaybeSize.takeError();
535 uint32_t Size = MaybeSize.get();
536 if (Strings.size() < Size)
537 return reportError("truncated chars");
538
539 OS << Indent << " '";
540 OS.write_escaped(Strings.slice(0, Size), /*hex=*/true);
541 OS << "'\n";
542 Strings = Strings.drop_front(Size);
543 } while (--NumStrings);
544
545 OS << Indent << " }";
546 return Error::success();
547}
548
549BitcodeAnalyzer::BitcodeAnalyzer(StringRef Buffer,
550 Optional<StringRef> BlockInfoBuffer)
551 : Stream(Buffer) {
552 if (BlockInfoBuffer)
553 BlockInfoStream.emplace(*BlockInfoBuffer);
554}
555
556Error BitcodeAnalyzer::analyze(Optional<BCDumpOptions> O,
557 Optional<StringRef> CheckHash) {
558 Expected<CurStreamTypeType> MaybeType = analyzeHeader(O, Stream);
559 if (!MaybeType)
1
Taking false branch
→
560 return MaybeType.takeError();
561 else
562 CurStreamType = *MaybeType;
563
564 Stream.setBlockInfo(&BlockInfo);
565
566 // Read block info from BlockInfoStream, if specified.
567 // The block info must be a top-level block.
568 if (BlockInfoStream) {
2
←
Assuming the condition is true
→
3
←
Taking true branch
→
569 BitstreamCursor BlockInfoCursor(*BlockInfoStream);
570 Expected<CurStreamTypeType> H = analyzeHeader(O, BlockInfoCursor);
4
←
Calling 'analyzeHeader'
→
571 if (!H)
572 return H.takeError();
573
574 while (!BlockInfoCursor.AtEndOfStream()) {
575 Expected<unsigned> MaybeCode = BlockInfoCursor.ReadCode();
576 if (!MaybeCode)
577 return MaybeCode.takeError();
578 if (MaybeCode.get() != bitc::ENTER_SUBBLOCK)
579 return reportError("Invalid record at top-level in block info file");
580
581 Expected<unsigned> MaybeBlockID = BlockInfoCursor.ReadSubBlockID();
582 if (!MaybeBlockID)
583 return MaybeBlockID.takeError();
584 if (MaybeBlockID.get() == bitc::BLOCKINFO_BLOCK_ID) {
585 Expected<Optional<BitstreamBlockInfo>> MaybeNewBlockInfo =
586 BlockInfoCursor.ReadBlockInfoBlock(/*ReadBlockInfoNames=*/true);
587 if (!MaybeNewBlockInfo)
588 return MaybeNewBlockInfo.takeError();
589 Optional<BitstreamBlockInfo> NewBlockInfo =
590 std::move(MaybeNewBlockInfo.get());
591 if (!NewBlockInfo)
592 return reportError("Malformed BlockInfoBlock in block info file");
593 BlockInfo = std::move(*NewBlockInfo);
594 break;
595 }
596
597 if (Error Err = BlockInfoCursor.SkipBlock())
598 return Err;
599 }
600 }
601
602 // Parse the top-level structure. We only allow blocks at the top-level.
603 while (!Stream.AtEndOfStream()) {
604 Expected<unsigned> MaybeCode = Stream.ReadCode();
605 if (!MaybeCode)
606 return MaybeCode.takeError();
607 if (MaybeCode.get() != bitc::ENTER_SUBBLOCK)
608 return reportError("Invalid record at top-level");
609
610 Expected<unsigned> MaybeBlockID = Stream.ReadSubBlockID();
611 if (!MaybeBlockID)
612 return MaybeBlockID.takeError();
613
614 if (Error E = parseBlock(MaybeBlockID.get(), 0, O, CheckHash))
615 return E;
616 ++NumTopBlocks;
617 }
618
619 return Error::success();
620}
621
622void BitcodeAnalyzer::printStats(BCDumpOptions O,
623 Optional<StringRef> Filename) {
624 uint64_t BufferSizeBits = Stream.getBitcodeBytes().size() * CHAR_BIT8;
625 // Print a summary of the read file.
626 O.OS << "Summary ";
627 if (Filename)
628 O.OS << "of " << Filename->data() << ":\n";
629 O.OS << " Total size: ";
630 printSize(O.OS, BufferSizeBits);
631 O.OS << "\n";
632 O.OS << " Stream type: ";
633 switch (CurStreamType) {
634 case UnknownBitstream:
635 O.OS << "unknown\n";
636 break;
637 case LLVMIRBitstream:
638 O.OS << "LLVM IR\n";
639 break;
640 case ClangSerializedASTBitstream:
641 O.OS << "Clang Serialized AST\n";
642 break;
643 case ClangSerializedDiagnosticsBitstream:
644 O.OS << "Clang Serialized Diagnostics\n";
645 break;
646 case LLVMBitstreamRemarks:
647 O.OS << "LLVM Remarks\n";
648 break;
649 }
650 O.OS << " # Toplevel Blocks: " << NumTopBlocks << "\n";
651 O.OS << "\n";
652
653 // Emit per-block stats.
654 O.OS << "Per-block Summary:\n";
655 for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
656 E = BlockIDStats.end();
657 I != E; ++I) {
658 O.OS << " Block ID #" << I->first;
659 if (Optional<const char *> BlockName =
660 GetBlockName(I->first, BlockInfo, CurStreamType))
661 O.OS << " (" << *BlockName << ")";
662 O.OS << ":\n";
663
664 const PerBlockIDStats &Stats = I->second;
665 O.OS << " Num Instances: " << Stats.NumInstances << "\n";
666 O.OS << " Total Size: ";
667 printSize(O.OS, Stats.NumBits);
668 O.OS << "\n";
669 double pct = (Stats.NumBits * 100.0) / BufferSizeBits;
670 O.OS << " Percent of file: " << format("%2.4f%%", pct) << "\n";
671 if (Stats.NumInstances > 1) {
672 O.OS << " Average Size: ";
673 printSize(O.OS, Stats.NumBits / (double)Stats.NumInstances);
674 O.OS << "\n";
675 O.OS << " Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
676 << Stats.NumSubBlocks / (double)Stats.NumInstances << "\n";
677 O.OS << " Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
678 << Stats.NumAbbrevs / (double)Stats.NumInstances << "\n";
679 O.OS << " Tot/Avg Records: " << Stats.NumRecords << "/"
680 << Stats.NumRecords / (double)Stats.NumInstances << "\n";
681 } else {
682 O.OS << " Num SubBlocks: " << Stats.NumSubBlocks << "\n";
683 O.OS << " Num Abbrevs: " << Stats.NumAbbrevs << "\n";
684 O.OS << " Num Records: " << Stats.NumRecords << "\n";
685 }
686 if (Stats.NumRecords) {
687 double pct = (Stats.NumAbbreviatedRecords * 100.0) / Stats.NumRecords;
688 O.OS << " Percent Abbrevs: " << format("%2.4f%%", pct) << "\n";
689 }
690 O.OS << "\n";
691
692 // Print a histogram of the codes we see.
693 if (O.Histogram && !Stats.CodeFreq.empty()) {
694 std::vector<std::pair<unsigned, unsigned>> FreqPairs; // <freq,code>
695 for (unsigned i = 0, e = Stats.CodeFreq.size(); i != e; ++i)
696 if (unsigned Freq = Stats.CodeFreq[i].NumInstances)
697 FreqPairs.push_back(std::make_pair(Freq, i));
698 llvm::stable_sort(FreqPairs);
699 std::reverse(FreqPairs.begin(), FreqPairs.end());
700
701 O.OS << "\tRecord Histogram:\n";
702 O.OS << "\t\t Count # Bits b/Rec % Abv Record Kind\n";
703 for (unsigned i = 0, e = FreqPairs.size(); i != e; ++i) {
704 const PerRecordStats &RecStats = Stats.CodeFreq[FreqPairs[i].second];
705
706 O.OS << format("\t\t%7d %9lu", RecStats.NumInstances,
707 (unsigned long)RecStats.TotalBits);
708
709 if (RecStats.NumInstances > 1)
710 O.OS << format(" %9.1f",
711 (double)RecStats.TotalBits / RecStats.NumInstances);
712 else
713 O.OS << " ";
714
715 if (RecStats.NumAbbrev)
716 O.OS << format(" %7.2f", (double)RecStats.NumAbbrev /
717 RecStats.NumInstances * 100);
718 else
719 O.OS << " ";
720
721 O.OS << " ";
722 if (Optional<const char *> CodeName = GetCodeName(
723 FreqPairs[i].second, I->first, BlockInfo, CurStreamType))
724 O.OS << *CodeName << "\n";
725 else
726 O.OS << "UnknownCode" << FreqPairs[i].second << "\n";
727 }
728 O.OS << "\n";
729 }
730 }
731}
732
733Error BitcodeAnalyzer::parseBlock(unsigned BlockID, unsigned IndentLevel,
734 Optional<BCDumpOptions> O,
735 Optional<StringRef> CheckHash) {
736 std::string Indent(IndentLevel * 2, ' ');
737 uint64_t BlockBitStart = Stream.GetCurrentBitNo();
738
739 // Get the statistics for this BlockID.
740 PerBlockIDStats &BlockStats = BlockIDStats[BlockID];
741
742 BlockStats.NumInstances++;
743
744 // BLOCKINFO is a special part of the stream.
745 bool DumpRecords = O.hasValue();
746 if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
747 if (O)
748 O->OS << Indent << "<BLOCKINFO_BLOCK/>\n";
749 Expected<Optional<BitstreamBlockInfo>> MaybeNewBlockInfo =
750 Stream.ReadBlockInfoBlock(/*ReadBlockInfoNames=*/true);
751 if (!MaybeNewBlockInfo)
752 return MaybeNewBlockInfo.takeError();
753 Optional<BitstreamBlockInfo> NewBlockInfo =
754 std::move(MaybeNewBlockInfo.get());
755 if (!NewBlockInfo)
756 return reportError("Malformed BlockInfoBlock");
757 BlockInfo = std::move(*NewBlockInfo);
758 if (Error Err = Stream.JumpToBit(BlockBitStart))
759 return Err;
760 // It's not really interesting to dump the contents of the blockinfo
761 // block.
762 DumpRecords = false;
763 }
764
765 unsigned NumWords = 0;
766 if (Error Err = Stream.EnterSubBlock(BlockID, &NumWords))
767 return Err;
768
769 // Keep it for later, when we see a MODULE_HASH record
770 uint64_t BlockEntryPos = Stream.getCurrentByteNo();
771
772 Optional<const char *> BlockName = None;
773 if (DumpRecords) {
774 O->OS << Indent << "<";
775 if ((BlockName = GetBlockName(BlockID, BlockInfo, CurStreamType)))
776 O->OS << *BlockName;
777 else
778 O->OS << "UnknownBlock" << BlockID;
779
780 if (!O->Symbolic && BlockName)
781 O->OS << " BlockID=" << BlockID;
782
783 O->OS << " NumWords=" << NumWords
784 << " BlockCodeSize=" << Stream.getAbbrevIDWidth() << ">\n";
785 }
786
787 SmallVector<uint64_t, 64> Record;
788
789 // Keep the offset to the metadata index if seen.
790 uint64_t MetadataIndexOffset = 0;
791
792 // Read all the records for this block.
793 while (1) {
794 if (Stream.AtEndOfStream())
795 return reportError("Premature end of bitstream");
796
797 uint64_t RecordStartBit = Stream.GetCurrentBitNo();
798
799 Expected<BitstreamEntry> MaybeEntry =
800 Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
801 if (!MaybeEntry)
802 return MaybeEntry.takeError();
803 BitstreamEntry Entry = MaybeEntry.get();
804
805 switch (Entry.Kind) {
806 case BitstreamEntry::Error:
807 return reportError("malformed bitcode file");
808 case BitstreamEntry::EndBlock: {
809 uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
810 BlockStats.NumBits += BlockBitEnd - BlockBitStart;
811 if (DumpRecords) {
812 O->OS << Indent << "</";
813 if (BlockName)
814 O->OS << *BlockName << ">\n";
815 else
816 O->OS << "UnknownBlock" << BlockID << ">\n";
817 }
818 return Error::success();
819 }
820
821 case BitstreamEntry::SubBlock: {
822 uint64_t SubBlockBitStart = Stream.GetCurrentBitNo();
823 if (Error E = parseBlock(Entry.ID, IndentLevel + 1, O, CheckHash))
824 return E;
825 ++BlockStats.NumSubBlocks;
826 uint64_t SubBlockBitEnd = Stream.GetCurrentBitNo();
827
828 // Don't include subblock sizes in the size of this block.
829 BlockBitStart += SubBlockBitEnd - SubBlockBitStart;
830 continue;
831 }
832 case BitstreamEntry::Record:
833 // The interesting case.
834 break;
835 }
836
837 if (Entry.ID == bitc::DEFINE_ABBREV) {
838 if (Error Err = Stream.ReadAbbrevRecord())
839 return Err;
840 ++BlockStats.NumAbbrevs;
841 continue;
842 }
843
844 Record.clear();
845
846 ++BlockStats.NumRecords;
847
848 StringRef Blob;
849 uint64_t CurrentRecordPos = Stream.GetCurrentBitNo();
850 Expected<unsigned> MaybeCode = Stream.readRecord(Entry.ID, Record, &Blob);
851 if (!MaybeCode)
852 return MaybeCode.takeError();
853 unsigned Code = MaybeCode.get();
854
855 // Increment the # occurrences of this code.
856 if (BlockStats.CodeFreq.size() <= Code)
857 BlockStats.CodeFreq.resize(Code + 1);
858 BlockStats.CodeFreq[Code].NumInstances++;
859 BlockStats.CodeFreq[Code].TotalBits +=
860 Stream.GetCurrentBitNo() - RecordStartBit;
861 if (Entry.ID != bitc::UNABBREV_RECORD) {
862 BlockStats.CodeFreq[Code].NumAbbrev++;
863 ++BlockStats.NumAbbreviatedRecords;
864 }
865
866 if (DumpRecords) {
867 O->OS << Indent << " <";
868 Optional<const char *> CodeName =
869 GetCodeName(Code, BlockID, BlockInfo, CurStreamType);
870 if (CodeName)
871 O->OS << *CodeName;
872 else
873 O->OS << "UnknownCode" << Code;
874 if (!O->Symbolic && CodeName)
875 O->OS << " codeid=" << Code;
876 const BitCodeAbbrev *Abbv = nullptr;
877 if (Entry.ID != bitc::UNABBREV_RECORD) {
878 Abbv = Stream.getAbbrev(Entry.ID);
879 O->OS << " abbrevid=" << Entry.ID;
880 }
881
882 for (unsigned i = 0, e = Record.size(); i != e; ++i)
883 O->OS << " op" << i << "=" << (int64_t)Record[i];
884
885 // If we found a metadata index, let's verify that we had an offset
886 // before and validate its forward reference offset was correct!
887 if (BlockID == bitc::METADATA_BLOCK_ID) {
888 if (Code == bitc::METADATA_INDEX_OFFSET) {
889 if (Record.size() != 2)
890 O->OS << "(Invalid record)";
891 else {
892 auto Offset = Record[0] + (Record[1] << 32);
893 MetadataIndexOffset = Stream.GetCurrentBitNo() + Offset;
894 }
895 }
896 if (Code == bitc::METADATA_INDEX) {
897 O->OS << " (offset ";
898 if (MetadataIndexOffset == RecordStartBit)
899 O->OS << "match)";
900 else
901 O->OS << "mismatch: " << MetadataIndexOffset << " vs "
902 << RecordStartBit << ")";
903 }
904 }
905
906 // If we found a module hash, let's verify that it matches!
907 if (BlockID == bitc::MODULE_BLOCK_ID && Code == bitc::MODULE_CODE_HASH &&
908 CheckHash.hasValue()) {
909 if (Record.size() != 5)
910 O->OS << " (invalid)";
911 else {
912 // Recompute the hash and compare it to the one in the bitcode
913 SHA1 Hasher;
914 StringRef Hash;
915 Hasher.update(*CheckHash);
916 {
917 int BlockSize = (CurrentRecordPos / 8) - BlockEntryPos;
918 auto Ptr = Stream.getPointerToByte(BlockEntryPos, BlockSize);
919 Hasher.update(ArrayRef<uint8_t>(Ptr, BlockSize));
920 Hash = Hasher.result();
921 }
922 std::array<char, 20> RecordedHash;
923 int Pos = 0;
924 for (auto &Val : Record) {
925 assert(!(Val >> 32) && "Unexpected high bits set")((void)0);
926 support::endian::write32be(&RecordedHash[Pos], Val);
927 Pos += 4;
928 }
929 if (Hash == StringRef(RecordedHash.data(), RecordedHash.size()))
930 O->OS << " (match)";
931 else
932 O->OS << " (!mismatch!)";
933 }
934 }
935
936 O->OS << "/>";
937
938 if (Abbv) {
939 for (unsigned i = 1, e = Abbv->getNumOperandInfos(); i != e; ++i) {
940 const BitCodeAbbrevOp &Op = Abbv->getOperandInfo(i);
941 if (!Op.isEncoding() || Op.getEncoding() != BitCodeAbbrevOp::Array)
942 continue;
943 assert(i + 2 == e && "Array op not second to last")((void)0);
944 std::string Str;
945 bool ArrayIsPrintable = true;
946 for (unsigned j = i - 1, je = Record.size(); j != je; ++j) {
947 if (!isPrint(static_cast<unsigned char>(Record[j]))) {
948 ArrayIsPrintable = false;
949 break;
950 }
951 Str += (char)Record[j];
952 }
953 if (ArrayIsPrintable)
954 O->OS << " record string = '" << Str << "'";
955 break;
956 }
957 }
958
959 if (Blob.data()) {
960 if (canDecodeBlob(Code, BlockID)) {
961 if (Error E = decodeMetadataStringsBlob(Indent, Record, Blob, O->OS))
962 return E;
963 } else {
964 O->OS << " blob data = ";
965 if (O->ShowBinaryBlobs) {
966 O->OS << "'";
967 O->OS.write_escaped(Blob, /*hex=*/true) << "'";
968 } else {
969 bool BlobIsPrintable = true;
970 for (unsigned i = 0, e = Blob.size(); i != e; ++i)
971 if (!isPrint(static_cast<unsigned char>(Blob[i]))) {
972 BlobIsPrintable = false;
973 break;
974 }
975
976 if (BlobIsPrintable)
977 O->OS << "'" << Blob << "'";
978 else
979 O->OS << "unprintable, " << Blob.size() << " bytes.";
980 }
981 }
982 }
983
984 O->OS << "\n";
985 }
986
987 // Make sure that we can skip the current record.
988 if (Error Err = Stream.JumpToBit(CurrentRecordPos))
989 return Err;
990 if (Expected<unsigned> Skipped = Stream.skipRecord(Entry.ID))
991 ; // Do nothing.
992 else
993 return Skipped.takeError();
994 }
995}
996
←

/usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Support/Error.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
42namespace llvm {
43
44class ErrorSuccess;
45
46/// Base class for error info classes. Do not extend this directly: Extend
47/// the ErrorInfo template subclass instead.
48class ErrorInfoBase {
49public:
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
86private:
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.
157class LLVM_NODISCARD[[clang::warn_unused_result]] Error {
158 // ErrorList needs to be able to yank ErrorInfoBase pointers out of Errors
159 // to add to the error list. It can't rely on handleErrors for this, since
160 // handleErrors does not support ErrorList handlers.
161 friend class ErrorList;
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
174protected:
175 /// Create a success value. Prefer using 'Error::success()' for readability
176 Error() {
177 setPtr(nullptr);
178 setChecked(false);
179 }
180
181public:
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);
26
←
Assuming the condition is true
→
237 return getPtr() != nullptr;
11
←
Returning zero, which participates in a condition later
→
15
←
Returning zero, which participates in a condition later
→
27
←
Returning zero, which participates in a condition later
→
31
←
Returning zero, which participates in a condition later
→
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
253private:
254#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
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_CHECKS0
266 if (LLVM_UNLIKELY(!getChecked() || getPtr())__builtin_expect((bool)(!getChecked() || getPtr()), false))
267 fatalUncheckedError();
268#endif
269 }
270
271 ErrorInfoBase *getPtr() const {
272#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
273 return reinterpret_cast<ErrorInfoBase*>(
274 reinterpret_cast<uintptr_t>(Payload) &
275 ~static_cast<uintptr_t>(0x1));
276#else
277 return Payload;
278#endif
279 }
280
281 void setPtr(ErrorInfoBase *EI) {
282#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
283 Payload = reinterpret_cast<ErrorInfoBase*>(
284 (reinterpret_cast<uintptr_t>(EI) &
285 ~static_cast<uintptr_t>(0x1)) |
286 (reinterpret_cast<uintptr_t>(Payload) & 0x1));
287#else
288 Payload = EI;
289#endif
290 }
291
292 bool getChecked() const {
293#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
294 return (reinterpret_cast<uintptr_t>(Payload) & 0x1) == 0;
295#else
296 return true;
297#endif
298 }
299
300 void setChecked(bool V) {
301#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
302 Payload = reinterpret_cast<ErrorInfoBase*>(
303 (reinterpret_cast<uintptr_t>(Payload) &
304 ~static_cast<uintptr_t>(0x1)) |
305 (V ? 0 : 1));
306#endif
307 }
308
309 std::unique_ptr<ErrorInfoBase> takePayload() {
310 std::unique_ptr<ErrorInfoBase> Tmp(getPtr());
311 setPtr(nullptr);
312 setChecked(true);
313 return Tmp;
314 }
315
316 friend raw_ostream &operator<<(raw_ostream &OS, const Error &E) {
317 if (auto P = E.getPtr())
318 P->log(OS);
319 else
320 OS << "success";
321 return OS;
322 }
323
324 ErrorInfoBase *Payload = nullptr;
325};
326
327/// Subclass of Error for the sole purpose of identifying the success path in
328/// the type system. This allows to catch invalid conversion to Expected<T> at
329/// compile time.
330class ErrorSuccess final : public Error {};
331
332inline ErrorSuccess Error::success() { return ErrorSuccess(); }
333
334/// Make a Error instance representing failure using the given error info
335/// type.
336template <typename ErrT, typename... ArgTs> Error make_error(ArgTs &&... Args) {
337 return Error(std::make_unique<ErrT>(std::forward<ArgTs>(Args)...));
338}
339
340/// Base class for user error types. Users should declare their error types
341/// like:
342///
343/// class MyError : public ErrorInfo<MyError> {
344/// ....
345/// };
346///
347/// This class provides an implementation of the ErrorInfoBase::kind
348/// method, which is used by the Error RTTI system.
349template <typename ThisErrT, typename ParentErrT = ErrorInfoBase>
350class ErrorInfo : public ParentErrT {
351public:
352 using ParentErrT::ParentErrT; // inherit constructors
353
354 static const void *classID() { return &ThisErrT::ID; }
355
356 const void *dynamicClassID() const override { return &ThisErrT::ID; }
357
358 bool isA(const void *const ClassID) const override {
359 return ClassID == classID() || ParentErrT::isA(ClassID);
360 }
361};
362
363/// Special ErrorInfo subclass representing a list of ErrorInfos.
364/// Instances of this class are constructed by joinError.
365class ErrorList final : public ErrorInfo<ErrorList> {
366 // handleErrors needs to be able to iterate the payload list of an
367 // ErrorList.
368 template <typename... HandlerTs>
369 friend Error handleErrors(Error E, HandlerTs &&... Handlers);
370
371 // joinErrors is implemented in terms of join.
372 friend Error joinErrors(Error, Error);
373
374public:
375 void log(raw_ostream &OS) const override {
376 OS << "Multiple errors:\n";
377 for (auto &ErrPayload : Payloads) {
378 ErrPayload->log(OS);
379 OS << "\n";
380 }
381 }
382
383 std::error_code convertToErrorCode() const override;
384
385 // Used by ErrorInfo::classID.
386 static char ID;
387
388private:
389 ErrorList(std::unique_ptr<ErrorInfoBase> Payload1,
390 std::unique_ptr<ErrorInfoBase> Payload2) {
391 assert(!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() &&((void)0)
392 "ErrorList constructor payloads should be singleton errors")((void)0);
393 Payloads.push_back(std::move(Payload1));
394 Payloads.push_back(std::move(Payload2));
395 }
396
397 static Error join(Error E1, Error E2) {
398 if (!E1)
399 return E2;
400 if (!E2)
401 return E1;
402 if (E1.isA<ErrorList>()) {
403 auto &E1List = static_cast<ErrorList &>(*E1.getPtr());
404 if (E2.isA<ErrorList>()) {
405 auto E2Payload = E2.takePayload();
406 auto &E2List = static_cast<ErrorList &>(*E2Payload);
407 for (auto &Payload : E2List.Payloads)
408 E1List.Payloads.push_back(std::move(Payload));
409 } else
410 E1List.Payloads.push_back(E2.takePayload());
411
412 return E1;
413 }
414 if (E2.isA<ErrorList>()) {
415 auto &E2List = static_cast<ErrorList &>(*E2.getPtr());
416 E2List.Payloads.insert(E2List.Payloads.begin(), E1.takePayload());
417 return E2;
418 }
419 return Error(std::unique_ptr<ErrorList>(
420 new ErrorList(E1.takePayload(), E2.takePayload())));
421 }
422
423 std::vector<std::unique_ptr<ErrorInfoBase>> Payloads;
424};
425
426/// Concatenate errors. The resulting Error is unchecked, and contains the
427/// ErrorInfo(s), if any, contained in E1, followed by the
428/// ErrorInfo(s), if any, contained in E2.
429inline Error joinErrors(Error E1, Error E2) {
430 return ErrorList::join(std::move(E1), std::move(E2));
431}
432
433/// Tagged union holding either a T or a Error.
434///
435/// This class parallels ErrorOr, but replaces error_code with Error. Since
436/// Error cannot be copied, this class replaces getError() with
437/// takeError(). It also adds an bool errorIsA<ErrT>() method for testing the
438/// error class type.
439///
440/// Example usage of 'Expected<T>' as a function return type:
441///
442/// @code{.cpp}
443/// Expected<int> myDivide(int A, int B) {
444/// if (B == 0) {
445/// // return an Error
446/// return createStringError(inconvertibleErrorCode(),
447/// "B must not be zero!");
448/// }
449/// // return an integer
450/// return A / B;
451/// }
452/// @endcode
453///
454/// Checking the results of to a function returning 'Expected<T>':
455/// @code{.cpp}
456/// if (auto E = Result.takeError()) {
457/// // We must consume the error. Typically one of:
458/// // - return the error to our caller
459/// // - toString(), when logging
460/// // - consumeError(), to silently swallow the error
461/// // - handleErrors(), to distinguish error types
462/// errs() << "Problem with division " << toString(std::move(E)) << "\n";
463/// return;
464/// }
465/// // use the result
466/// outs() << "The answer is " << *Result << "\n";
467/// @endcode
468///
469/// For unit-testing a function returning an 'Expceted<T>', see the
470/// 'EXPECT_THAT_EXPECTED' macros in llvm/Testing/Support/Error.h
471
472template <class T> class LLVM_NODISCARD[[clang::warn_unused_result]] Expected {
473 template <class T1> friend class ExpectedAsOutParameter;
474 template <class OtherT> friend class Expected;
475
476 static constexpr bool isRef = std::is_reference<T>::value;
477
478 using wrap = std::reference_wrapper<std::remove_reference_t<T>>;
479
480 using error_type = std::unique_ptr<ErrorInfoBase>;
481
482public:
483 using storage_type = std::conditional_t<isRef, wrap, T>;
484 using value_type = T;
485
486private:
487 using reference = std::remove_reference_t<T> &;
488 using const_reference = const std::remove_reference_t<T> &;
489 using pointer = std::remove_reference_t<T> *;
490 using const_pointer = const std::remove_reference_t<T> *;
491
492public:
493 /// Create an Expected<T> error value from the given Error.
494 Expected(Error Err)
495 : HasError(true)
496#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
497 // Expected is unchecked upon construction in Debug builds.
498 , Unchecked(true)
499#endif
500 {
501 assert(Err && "Cannot create Expected<T> from Error success value.")((void)0);
502 new (getErrorStorage()) error_type(Err.takePayload());
503 }
504
505 /// Forbid to convert from Error::success() implicitly, this avoids having
506 /// Expected<T> foo() { return Error::success(); } which compiles otherwise
507 /// but triggers the assertion above.
508 Expected(ErrorSuccess) = delete;
509
510 /// Create an Expected<T> success value from the given OtherT value, which
511 /// must be convertible to T.
512 template <typename OtherT>
513 Expected(OtherT &&Val,
514 std::enable_if_t<std::is_convertible<OtherT, T>::value> * = nullptr)
515 : HasError(false)
516#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
517 // Expected is unchecked upon construction in Debug builds.
518 ,
519 Unchecked(true)
520#endif
521 {
522 new (getStorage()) storage_type(std::forward<OtherT>(Val));
523 }
524
525 /// Move construct an Expected<T> value.
526 Expected(Expected &&Other) { moveConstruct(std::move(Other)); }
527
528 /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT
529 /// must be convertible to T.
530 template <class OtherT>
531 Expected(
532 Expected<OtherT> &&Other,
533 std::enable_if_t<std::is_convertible<OtherT, T>::value> * = nullptr) {
534 moveConstruct(std::move(Other));
535 }
536
537 /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT
538 /// isn't convertible to T.
539 template <class OtherT>
540 explicit Expected(
541 Expected<OtherT> &&Other,
542 std::enable_if_t<!std::is_convertible<OtherT, T>::value> * = nullptr) {
543 moveConstruct(std::move(Other));
544 }
545
546 /// Move-assign from another Expected<T>.
547 Expected &operator=(Expected &&Other) {
548 moveAssign(std::move(Other));
549 return *this;
550 }
551
552 /// Destroy an Expected<T>.
553 ~Expected() {
554 assertIsChecked();
555 if (!HasError)
556 getStorage()->~storage_type();
557 else
558 getErrorStorage()->~error_type();
559 }
560
561 /// Return false if there is an error.
562 explicit operator bool() {
563#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
564 Unchecked = HasError;
565#endif
566 return !HasError;
567 }
568
569 /// Returns a reference to the stored T value.
570 reference get() {
571 assertIsChecked();
572 return *getStorage();
573 }
574
575 /// Returns a const reference to the stored T value.
576 const_reference get() const {
577 assertIsChecked();
578 return const_cast<Expected<T> *>(this)->get();
579 }
580
581 /// Check that this Expected<T> is an error of type ErrT.
582 template <typename ErrT> bool errorIsA() const {
583 return HasError && (*getErrorStorage())->template isA<ErrT>();
584 }
585
586 /// Take ownership of the stored error.
587 /// After calling this the Expected<T> is in an indeterminate state that can
588 /// only be safely destructed. No further calls (beside the destructor) should
589 /// be made on the Expected<T> value.
590 Error takeError() {
591#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
592 Unchecked = false;
593#endif
594 return HasError ? Error(std::move(*getErrorStorage())) : Error::success();
595 }
596
597 /// Returns a pointer to the stored T value.
598 pointer operator->() {
599 assertIsChecked();
600 return toPointer(getStorage());
601 }
602
603 /// Returns a const pointer to the stored T value.
604 const_pointer operator->() const {
605 assertIsChecked();
606 return toPointer(getStorage());
607 }
608
609 /// Returns a reference to the stored T value.
610 reference operator*() {
611 assertIsChecked();
612 return *getStorage();
613 }
614
615 /// Returns a const reference to the stored T value.
616 const_reference operator*() const {
617 assertIsChecked();
618 return *getStorage();
619 }
620
621private:
622 template <class T1>
623 static bool compareThisIfSameType(const T1 &a, const T1 &b) {
624 return &a == &b;
625 }
626
627 template <class T1, class T2>
628 static bool compareThisIfSameType(const T1 &, const T2 &) {
629 return false;
630 }
631
632 template <class OtherT> void moveConstruct(Expected<OtherT> &&Other) {
633 HasError = Other.HasError;
634#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
635 Unchecked = true;
636 Other.Unchecked = false;
637#endif
638
639 if (!HasError)
640 new (getStorage()) storage_type(std::move(*Other.getStorage()));
641 else
642 new (getErrorStorage()) error_type(std::move(*Other.getErrorStorage()));
643 }
644
645 template <class OtherT> void moveAssign(Expected<OtherT> &&Other) {
646 assertIsChecked();
647
648 if (compareThisIfSameType(*this, Other))
649 return;
650
651 this->~Expected();
652 new (this) Expected(std::move(Other));
653 }
654
655 pointer toPointer(pointer Val) { return Val; }
656
657 const_pointer toPointer(const_pointer Val) const { return Val; }
658
659 pointer toPointer(wrap *Val) { return &Val->get(); }
660
661 const_pointer toPointer(const wrap *Val) const { return &Val->get(); }
662
663 storage_type *getStorage() {
664 assert(!HasError && "Cannot get value when an error exists!")((void)0);
665 return reinterpret_cast<storage_type *>(&TStorage);
666 }
667
668 const storage_type *getStorage() const {
669 assert(!HasError && "Cannot get value when an error exists!")((void)0);
670 return reinterpret_cast<const storage_type *>(&TStorage);
671 }
672
673 error_type *getErrorStorage() {
674 assert(HasError && "Cannot get error when a value exists!")((void)0);
675 return reinterpret_cast<error_type *>(&ErrorStorage);
676 }
677
678 const error_type *getErrorStorage() const {
679 assert(HasError && "Cannot get error when a value exists!")((void)0);
680 return reinterpret_cast<const error_type *>(&ErrorStorage);
681 }
682
683 // Used by ExpectedAsOutParameter to reset the checked flag.
684 void setUnchecked() {
685#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
686 Unchecked = true;
687#endif
688 }
689
690#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
691 LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn))
692 LLVM_ATTRIBUTE_NOINLINE__attribute__((noinline))
693 void fatalUncheckedExpected() const {
694 dbgs() << "Expected<T> must be checked before access or destruction.\n";
695 if (HasError) {
696 dbgs() << "Unchecked Expected<T> contained error:\n";
697 (*getErrorStorage())->log(dbgs());
698 } else
699 dbgs() << "Expected<T> value was in success state. (Note: Expected<T> "
700 "values in success mode must still be checked prior to being "
701 "destroyed).\n";
702 abort();
703 }
704#endif
705
706 void assertIsChecked() const {
707#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
708 if (LLVM_UNLIKELY(Unchecked)__builtin_expect((bool)(Unchecked), false))
709 fatalUncheckedExpected();
710#endif
711 }
712
713 union {
714 AlignedCharArrayUnion<storage_type> TStorage;
715 AlignedCharArrayUnion<error_type> ErrorStorage;
716 };
717 bool HasError : 1;
718#if LLVM_ENABLE_ABI_BREAKING_CHECKS0
719 bool Unchecked : 1;
720#endif
721};
722
723/// Report a serious error, calling any installed error handler. See
724/// ErrorHandling.h.
725LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void report_fatal_error(Error Err,
726 bool gen_crash_diag = true);
727
728/// Report a fatal error if Err is a failure value.
729///
730/// This function can be used to wrap calls to fallible functions ONLY when it
731/// is known that the Error will always be a success value. E.g.
732///
733/// @code{.cpp}
734/// // foo only attempts the fallible operation if DoFallibleOperation is
735/// // true. If DoFallibleOperation is false then foo always returns
736/// // Error::success().
737/// Error foo(bool DoFallibleOperation);
738///
739/// cantFail(foo(false));
740/// @endcode
741inline void cantFail(Error Err, const char *Msg = nullptr) {
742 if (Err) {
743 if (!Msg)
744 Msg = "Failure value returned from cantFail wrapped call";
745#ifndef NDEBUG1
746 std::string Str;
747 raw_string_ostream OS(Str);
748 OS << Msg << "\n" << Err;
749 Msg = OS.str().c_str();
750#endif
751 llvm_unreachable(Msg)__builtin_unreachable();
752 }
753}
754
755/// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and
756/// returns the contained value.
757///
758/// This function can be used to wrap calls to fallible functions ONLY when it
759/// is known that the Error will always be a success value. E.g.
760///
761/// @code{.cpp}
762/// // foo only attempts the fallible operation if DoFallibleOperation is
763/// // true. If DoFallibleOperation is false then foo always returns an int.
764/// Expected<int> foo(bool DoFallibleOperation);
765///
766/// int X = cantFail(foo(false));
767/// @endcode
768template <typename T>
769T cantFail(Expected<T> ValOrErr, const char *Msg = nullptr) {
770 if (ValOrErr)
771 return std::move(*ValOrErr);
772 else {
773 if (!Msg)
774 Msg = "Failure value returned from cantFail wrapped call";
775#ifndef NDEBUG1
776 std::string Str;
777 raw_string_ostream OS(Str);
778 auto E = ValOrErr.takeError();
779 OS << Msg << "\n" << E;
780 Msg = OS.str().c_str();
781#endif
782 llvm_unreachable(Msg)__builtin_unreachable();
783 }
784}
785
786/// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and
787/// returns the contained reference.
788///
789/// This function can be used to wrap calls to fallible functions ONLY when it
790/// is known that the Error will always be a success value. E.g.
791///
792/// @code{.cpp}
793/// // foo only attempts the fallible operation if DoFallibleOperation is
794/// // true. If DoFallibleOperation is false then foo always returns a Bar&.
795/// Expected<Bar&> foo(bool DoFallibleOperation);
796///
797/// Bar &X = cantFail(foo(false));
798/// @endcode
799template <typename T>
800T& cantFail(Expected<T&> ValOrErr, const char *Msg = nullptr) {
801 if (ValOrErr)
802 return *ValOrErr;
803 else {
804 if (!Msg)
805 Msg = "Failure value returned from cantFail wrapped call";
806#ifndef NDEBUG1
807 std::string Str;
808 raw_string_ostream OS(Str);
809 auto E = ValOrErr.takeError();
810 OS << Msg << "\n" << E;
811 Msg = OS.str().c_str();
812#endif
813 llvm_unreachable(Msg)__builtin_unreachable();
814 }
815}
816
817/// Helper for testing applicability of, and applying, handlers for
818/// ErrorInfo types.
819template <typename HandlerT>
820class ErrorHandlerTraits
821 : public ErrorHandlerTraits<decltype(
822 &std::remove_reference<HandlerT>::type::operator())> {};
823
824// Specialization functions of the form 'Error (const ErrT&)'.
825template <typename ErrT> class ErrorHandlerTraits<Error (&)(ErrT &)> {
826public:
827 static bool appliesTo(const ErrorInfoBase &E) {
828 return E.template isA<ErrT>();
829 }
830
831 template <typename HandlerT>
832 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
833 assert(appliesTo(*E) && "Applying incorrect handler")((void)0);
834 return H(static_cast<ErrT &>(*E));
835 }
836};
837
838// Specialization functions of the form 'void (const ErrT&)'.
839template <typename ErrT> class ErrorHandlerTraits<void (&)(ErrT &)> {
840public:
841 static bool appliesTo(const ErrorInfoBase &E) {
842 return E.template isA<ErrT>();
843 }
844
845 template <typename HandlerT>
846 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
847 assert(appliesTo(*E) && "Applying incorrect handler")((void)0);
848 H(static_cast<ErrT &>(*E));
849 return Error::success();
850 }
851};
852
853/// Specialization for functions of the form 'Error (std::unique_ptr<ErrT>)'.
854template <typename ErrT>
855class ErrorHandlerTraits<Error (&)(std::unique_ptr<ErrT>)> {
856public:
857 static bool appliesTo(const ErrorInfoBase &E) {
858 return E.template isA<ErrT>();
859 }
860
861 template <typename HandlerT>
862 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
863 assert(appliesTo(*E) && "Applying incorrect handler")((void)0);
864 std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release()));
865 return H(std::move(SubE));
866 }
867};
868
869/// Specialization for functions of the form 'void (std::unique_ptr<ErrT>)'.
870template <typename ErrT>
871class ErrorHandlerTraits<void (&)(std::unique_ptr<ErrT>)> {
872public:
873 static bool appliesTo(const ErrorInfoBase &E) {
874 return E.template isA<ErrT>();
875 }
876
877 template <typename HandlerT>
878 static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) {
879 assert(appliesTo(*E) && "Applying incorrect handler")((void)0);
880 std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release()));
881 H(std::move(SubE));
882 return Error::success();
883 }
884};
885
886// Specialization for member functions of the form 'RetT (const ErrT&)'.
887template <typename C, typename RetT, typename ErrT>
888class ErrorHandlerTraits<RetT (C::*)(ErrT &)>
889 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
890
891// Specialization for member functions of the form 'RetT (const ErrT&) const'.
892template <typename C, typename RetT, typename ErrT>
893class ErrorHandlerTraits<RetT (C::*)(ErrT &) const>
894 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
895
896// Specialization for member functions of the form 'RetT (const ErrT&)'.
897template <typename C, typename RetT, typename ErrT>
898class ErrorHandlerTraits<RetT (C::*)(const ErrT &)>
899 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
900
901// Specialization for member functions of the form 'RetT (const ErrT&) const'.
902template <typename C, typename RetT, typename ErrT>
903class ErrorHandlerTraits<RetT (C::*)(const ErrT &) const>
904 : public ErrorHandlerTraits<RetT (&)(ErrT &)> {};
905
906/// Specialization for member functions of the form
907/// 'RetT (std::unique_ptr<ErrT>)'.
908template <typename C, typename RetT, typename ErrT>
909class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>)>
910 : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {};
911
912/// Specialization for member functions of the form
913/// 'RetT (std::unique_ptr<ErrT>) const'.
914template <typename C, typename RetT, typename ErrT>
915class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>) const>
916 : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {};
917
918inline Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload) {
919 return Error(std::move(Payload));
920}
921
922template <typename HandlerT, typename... HandlerTs>
923Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload,
924 HandlerT &&Handler, HandlerTs &&... Handlers) {
925 if (ErrorHandlerTraits<HandlerT>::appliesTo(*Payload))
926 return ErrorHandlerTraits<HandlerT>::apply(std::forward<HandlerT>(Handler),
927 std::move(Payload));
928 return handleErrorImpl(std::move(Payload),
929 std::forward<HandlerTs>(Handlers)...);
930}
931
932/// Pass the ErrorInfo(s) contained in E to their respective handlers. Any
933/// unhandled errors (or Errors returned by handlers) are re-concatenated and
934/// returned.
935/// Because this function returns an error, its result must also be checked
936/// or returned. If you intend to handle all errors use handleAllErrors
937/// (which returns void, and will abort() on unhandled errors) instead.
938template <typename... HandlerTs>
939Error handleErrors(Error E, HandlerTs &&... Hs) {
940 if (!E)
941 return Error::success();
942
943 std::unique_ptr<ErrorInfoBase> Payload = E.takePayload();
944
945 if (Payload->isA<ErrorList>()) {
946 ErrorList &List = static_cast<ErrorList &>(*Payload);
947 Error R;
948 for (auto &P : List.Payloads)
949 R = ErrorList::join(
950 std::move(R),
951 handleErrorImpl(std::move(P), std::forward<HandlerTs>(Hs)...));
952 return R;
953 }
954
955 return handleErrorImpl(std::move(Payload), std::forward<HandlerTs>(Hs)...);
956}
957
958/// Behaves the same as handleErrors, except that by contract all errors
959/// *must* be handled by the given handlers (i.e. there must be no remaining
960/// errors after running the handlers, or llvm_unreachable is called).
961template <typename... HandlerTs>
962void handleAllErrors(Error E, HandlerTs &&... Handlers) {
963 cantFail(handleErrors(std::move(E), std::forward<HandlerTs>(Handlers)...));
964}
965
966/// Check that E is a non-error, then drop it.
967/// If E is an error, llvm_unreachable will be called.
968inline void handleAllErrors(Error E) {
969 cantFail(std::move(E));
970}
971
972/// Handle any errors (if present) in an Expected<T>, then try a recovery path.
973///
974/// If the incoming value is a success value it is returned unmodified. If it
975/// is a failure value then it the contained error is passed to handleErrors.
976/// If handleErrors is able to handle the error then the RecoveryPath functor
977/// is called to supply the final result. If handleErrors is not able to
978/// handle all errors then the unhandled errors are returned.
979///
980/// This utility enables the follow pattern:
981///
982/// @code{.cpp}
983/// enum FooStrategy { Aggressive, Conservative };
984/// Expected<Foo> foo(FooStrategy S);
985///
986/// auto ResultOrErr =
987/// handleExpected(
988/// foo(Aggressive),
989/// []() { return foo(Conservative); },
990/// [](AggressiveStrategyError&) {
991/// // Implicitly conusme this - we'll recover by using a conservative
992/// // strategy.
993/// });
994///
995/// @endcode
996template <typename T, typename RecoveryFtor, typename... HandlerTs>
997Expected<T> handleExpected(Expected<T> ValOrErr, RecoveryFtor &&RecoveryPath,
998 HandlerTs &&... Handlers) {
999 if (ValOrErr)
1000 return ValOrErr;
1001
1002 if (auto Err = handleErrors(ValOrErr.takeError(),
1003 std::forward<HandlerTs>(Handlers)...))
1004 return std::move(Err);
1005
1006 return RecoveryPath();
1007}
1008
1009/// Log all errors (if any) in E to OS. If there are any errors, ErrorBanner
1010/// will be printed before the first one is logged. A newline will be printed
1011/// after each error.
1012///
1013/// This function is compatible with the helpers from Support/WithColor.h. You
1014/// can pass any of them as the OS. Please consider using them instead of
1015/// including 'error: ' in the ErrorBanner.
1016///
1017/// This is useful in the base level of your program to allow clean termination
1018/// (allowing clean deallocation of resources, etc.), while reporting error
1019/// information to the user.
1020void logAllUnhandledErrors(Error E, raw_ostream &OS, Twine ErrorBanner = {});
1021
1022/// Write all error messages (if any) in E to a string. The newline character
1023/// is used to separate error messages.
1024inline std::string toString(Error E) {
1025 SmallVector<std::string, 2> Errors;
1026 handleAllErrors(std::move(E), [&Errors](const ErrorInfoBase &EI) {
1027 Errors.push_back(EI.message());
1028 });
1029 return join(Errors.begin(), Errors.end(), "\n");
1030}
1031
1032/// Consume a Error without doing anything. This method should be used
1033/// only where an error can be considered a reasonable and expected return
1034/// value.
1035///
1036/// Uses of this method are potentially indicative of design problems: If it's
1037/// legitimate to do nothing while processing an "error", the error-producer
1038/// might be more clearly refactored to return an Optional<T>.
1039inline void consumeError(Error Err) {
1040 handleAllErrors(std::move(Err), [](const ErrorInfoBase &) {});
1041}
1042
1043/// Convert an Expected to an Optional without doing anything. This method
1044/// should be used only where an error can be considered a reasonable and
1045/// expected return value.
1046///
1047/// Uses of this method are potentially indicative of problems: perhaps the
1048/// error should be propagated further, or the error-producer should just
1049/// return an Optional in the first place.
1050template <typename T> Optional<T> expectedToOptional(Expected<T> &&E) {
1051 if (E)
1052 return std::move(*E);
1053 consumeError(E.takeError());
1054 return None;
1055}
1056
1057/// Helper for converting an Error to a bool.
1058///
1059/// This method returns true if Err is in an error state, or false if it is
1060/// in a success state. Puts Err in a checked state in both cases (unlike
1061/// Error::operator bool(), which only does this for success states).
1062inline bool errorToBool(Error Err) {
1063 bool IsError = static_cast<bool>(Err);
1064 if (IsError)
1065 consumeError(std::move(Err));
1066 return IsError;
1067}
1068
1069/// Helper for Errors used as out-parameters.
1070///
1071/// This helper is for use with the Error-as-out-parameter idiom, where an error
1072/// is passed to a function or method by reference, rather than being returned.
1073/// In such cases it is helpful to set the checked bit on entry to the function
1074/// so that the error can be written to (unchecked Errors abort on assignment)
1075/// and clear the checked bit on exit so that clients cannot accidentally forget
1076/// to check the result. This helper performs these actions automatically using
1077/// RAII:
1078///
1079/// @code{.cpp}
1080/// Result foo(Error &Err) {
1081/// ErrorAsOutParameter ErrAsOutParam(&Err); // 'Checked' flag set
1082/// // <body of foo>
1083/// // <- 'Checked' flag auto-cleared when ErrAsOutParam is destructed.
1084/// }
1085/// @endcode
1086///
1087/// ErrorAsOutParameter takes an Error* rather than Error& so that it can be
1088/// used with optional Errors (Error pointers that are allowed to be null). If
1089/// ErrorAsOutParameter took an Error reference, an instance would have to be
1090/// created inside every condition that verified that Error was non-null. By
1091/// taking an Error pointer we can just create one instance at the top of the
1092/// function.
1093class ErrorAsOutParameter {
1094public:
1095 ErrorAsOutParameter(Error *Err) : Err(Err) {
1096 // Raise the checked bit if Err is success.
1097 if (Err)
1098 (void)!!*Err;
1099 }
1100
1101 ~ErrorAsOutParameter() {
1102 // Clear the checked bit.
1103 if (Err && !*Err)
1104 *Err = Error::success();
1105 }
1106
1107private:
1108 Error *Err;
1109};
1110
1111/// Helper for Expected<T>s used as out-parameters.
1112///
1113/// See ErrorAsOutParameter.
1114template <typename T>
1115class ExpectedAsOutParameter {
1116public:
1117 ExpectedAsOutParameter(Expected<T> *ValOrErr)
1118 : ValOrErr(ValOrErr) {
1119 if (ValOrErr)
1120 (void)!!*ValOrErr;
1121 }
1122
1123 ~ExpectedAsOutParameter() {
1124 if (ValOrErr)
1125 ValOrErr->setUnchecked();
1126 }
1127
1128private:
1129 Expected<T> *ValOrErr;
1130};
1131
1132/// This class wraps a std::error_code in a Error.
1133///
1134/// This is useful if you're writing an interface that returns a Error
1135/// (or Expected) and you want to call code that still returns
1136/// std::error_codes.
1137class ECError : public ErrorInfo<ECError> {
1138 friend Error errorCodeToError(std::error_code);
1139
1140 virtual void anchor() override;
1141
1142public:
1143 void setErrorCode(std::error_code EC) { this->EC = EC; }
1144 std::error_code convertToErrorCode() const override { return EC; }
1145 void log(raw_ostream &OS) const override { OS << EC.message(); }
1146
1147 // Used by ErrorInfo::classID.
1148 static char ID;
1149
1150protected:
1151 ECError() = default;
1152 ECError(std::error_code EC) : EC(EC) {}
1153
1154 std::error_code EC;
1155};
1156
1157/// The value returned by this function can be returned from convertToErrorCode
1158/// for Error values where no sensible translation to std::error_code exists.
1159/// It should only be used in this situation, and should never be used where a
1160/// sensible conversion to std::error_code is available, as attempts to convert
1161/// to/from this error will result in a fatal error. (i.e. it is a programmatic
1162///error to try to convert such a value).
1163std::error_code inconvertibleErrorCode();
1164
1165/// Helper for converting an std::error_code to a Error.
1166Error errorCodeToError(std::error_code EC);
1167
1168/// Helper for converting an ECError to a std::error_code.
1169///
1170/// This method requires that Err be Error() or an ECError, otherwise it
1171/// will trigger a call to abort().
1172std::error_code errorToErrorCode(Error Err);
1173
1174/// Convert an ErrorOr<T> to an Expected<T>.
1175template <typename T> Expected<T> errorOrToExpected(ErrorOr<T> &&EO) {
1176 if (auto EC = EO.getError())
1177 return errorCodeToError(EC);
1178 return std::move(*EO);
1179}
1180
1181/// Convert an Expected<T> to an ErrorOr<T>.
1182template <typename T> ErrorOr<T> expectedToErrorOr(Expected<T> &&E) {
1183 if (auto Err = E.takeError())
1184 return errorToErrorCode(std::move(Err));
1185 return std::move(*E);
1186}
1187
1188/// This class wraps a string in an Error.
1189///
1190/// StringError is useful in cases where the client is not expected to be able
1191/// to consume the specific error message programmatically (for example, if the
1192/// error message is to be presented to the user).
1193///
1194/// StringError can also be used when additional information is to be printed
1195/// along with a error_code message. Depending on the constructor called, this
1196/// class can either display:
1197/// 1. the error_code message (ECError behavior)
1198/// 2. a string
1199/// 3. the error_code message and a string
1200///
1201/// These behaviors are useful when subtyping is required; for example, when a
1202/// specific library needs an explicit error type. In the example below,
1203/// PDBError is derived from StringError:
1204///
1205/// @code{.cpp}
1206/// Expected<int> foo() {
1207/// return llvm::make_error<PDBError>(pdb_error_code::dia_failed_loading,
1208/// "Additional information");
1209/// }
1210/// @endcode
1211///
1212class StringError : public ErrorInfo<StringError> {
1213public:
1214 static char ID;
1215
1216 // Prints EC + S and converts to EC
1217 StringError(std::error_code EC, const Twine &S = Twine());
1218
1219 // Prints S and converts to EC
1220 StringError(const Twine &S, std::error_code EC);
1221
1222 void log(raw_ostream &OS) const override;
1223 std::error_code convertToErrorCode() const override;
1224
1225 const std::string &getMessage() const { return Msg; }
1226
1227private:
1228 std::string Msg;
1229 std::error_code EC;
1230 const bool PrintMsgOnly = false;
1231};
1232
1233/// Create formatted StringError object.
1234template <typename... Ts>
1235inline Error createStringError(std::error_code EC, char const *Fmt,
1236 const Ts &... Vals) {
1237 std::string Buffer;
1238 raw_string_ostream Stream(Buffer);
1239 Stream << format(Fmt, Vals...);
1240 return make_error<StringError>(Stream.str(), EC);
1241}
1242
1243Error createStringError(std::error_code EC, char const *Msg);
1244
1245inline Error createStringError(std::error_code EC, const Twine &S) {
1246 return createStringError(EC, S.str().c_str());
1247}
1248
1249template <typename... Ts>
1250inline Error createStringError(std::errc EC, char const *Fmt,
1251 const Ts &... Vals) {
1252 return createStringError(std::make_error_code(EC), Fmt, Vals...);
1253}
1254
1255/// This class wraps a filename and another Error.
1256///
1257/// In some cases, an error needs to live along a 'source' name, in order to
1258/// show more detailed information to the user.
1259class FileError final : public ErrorInfo<FileError> {
1260
1261 friend Error createFileError(const Twine &, Error);
1262 friend Error createFileError(const Twine &, size_t, Error);
1263
1264public:
1265 void log(raw_ostream &OS) const override {
1266 assert(Err && !FileName.empty() && "Trying to log after takeError().")((void)0);
1267 OS << "'" << FileName << "': ";
1268 if (Line.hasValue())
1269 OS << "line " << Line.getValue() << ": ";
1270 Err->log(OS);
1271 }
1272
1273 StringRef getFileName() { return FileName; }
1274
1275 Error takeError() { return Error(std::move(Err)); }
1276
1277 std::error_code convertToErrorCode() const override;
1278
1279 // Used by ErrorInfo::classID.
1280 static char ID;
1281
1282private:
1283 FileError(const Twine &F, Optional<size_t> LineNum,
1284 std::unique_ptr<ErrorInfoBase> E) {
1285 assert(E && "Cannot create FileError from Error success value.")((void)0);
1286 assert(!F.isTriviallyEmpty() &&((void)0)
1287 "The file name provided to FileError must not be empty.")((void)0);
1288 FileName = F.str();
1289 Err = std::move(E);
1290 Line = std::move(LineNum);
1291 }
1292
1293 static Error build(const Twine &F, Optional<size_t> Line, Error E) {
1294 std::unique_ptr<ErrorInfoBase> Payload;
1295 handleAllErrors(std::move(E),
1296 [&](std::unique_ptr<ErrorInfoBase> EIB) -> Error {
1297 Payload = std::move(EIB);
1298 return Error::success();
1299 });
1300 return Error(
1301 std::unique_ptr<FileError>(new FileError(F, Line, std::move(Payload))));
1302 }
1303
1304 std::string FileName;
1305 Optional<size_t> Line;
1306 std::unique_ptr<ErrorInfoBase> Err;
1307};
1308
1309/// Concatenate a source file path and/or name with an Error. The resulting
1310/// Error is unchecked.
1311inline Error createFileError(const Twine &F, Error E) {
1312 return FileError::build(F, Optional<size_t>(), std::move(E));
1313}
1314
1315/// Concatenate a source file path and/or name with line number and an Error.
1316/// The resulting Error is unchecked.
1317inline Error createFileError(const Twine &F, size_t Line, Error E) {
1318 return FileError::build(F, Optional<size_t>(Line), std::move(E));
1319}
1320
1321/// Concatenate a source file path and/or name with a std::error_code
1322/// to form an Error object.
1323inline Error createFileError(const Twine &F, std::error_code EC) {
1324 return createFileError(F, errorCodeToError(EC));
1325}
1326
1327/// Concatenate a source file path and/or name with line number and
1328/// std::error_code to form an Error object.
1329inline Error createFileError(const Twine &F, size_t Line, std::error_code EC) {
1330 return createFileError(F, Line, errorCodeToError(EC));
1331}
1332
1333Error createFileError(const Twine &F, ErrorSuccess) = delete;
1334
1335/// Helper for check-and-exit error handling.
1336///
1337/// For tool use only. NOT FOR USE IN LIBRARY CODE.
1338///
1339class ExitOnError {
1340public:
1341 /// Create an error on exit helper.
1342 ExitOnError(std::string Banner = "", int DefaultErrorExitCode = 1)
1343 : Banner(std::move(Banner)),
1344 GetExitCode([=](const Error &) { return DefaultErrorExitCode; }) {}
1345
1346 /// Set the banner string for any errors caught by operator().
1347 void setBanner(std::string Banner) { this->Banner = std::move(Banner); }
1348
1349 /// Set the exit-code mapper function.
1350 void setExitCodeMapper(std::function<int(const Error &)> GetExitCode) {
1351 this->GetExitCode = std::move(GetExitCode);
1352 }
1353
1354 /// Check Err. If it's in a failure state log the error(s) and exit.
1355 void operator()(Error Err) const { checkError(std::move(Err)); }
1356
1357 /// Check E. If it's in a success state then return the contained value. If
1358 /// it's in a failure state log the error(s) and exit.
1359 template <typename T> T operator()(Expected<T> &&E) const {
1360 checkError(E.takeError());
1361 return std::move(*E);
1362 }
1363
1364 /// Check E. If it's in a success state then return the contained reference. If
1365 /// it's in a failure state log the error(s) and exit.
1366 template <typename T> T& operator()(Expected<T&> &&E) const {
1367 checkError(E.takeError());
1368 return *E;
1369 }
1370
1371private:
1372 void checkError(Error Err) const {
1373 if (Err) {
1374 int ExitCode = GetExitCode(Err);
1375 logAllUnhandledErrors(std::move(Err), errs(), Banner);
1376 exit(ExitCode);
1377 }
1378 }
1379
1380 std::string Banner;
1381 std::function<int(const Error &)> GetExitCode;
1382};
1383
1384/// Conversion from Error to LLVMErrorRef for C error bindings.
1385inline LLVMErrorRef wrap(Error Err) {
1386 return reinterpret_cast<LLVMErrorRef>(Err.takePayload().release());
1387}
1388
1389/// Conversion from LLVMErrorRef to Error for C error bindings.
1390inline Error unwrap(LLVMErrorRef ErrRef) {
1391 return Error(std::unique_ptr<ErrorInfoBase>(
1392 reinterpret_cast<ErrorInfoBase *>(ErrRef)));
1393}
1394
1395} // end namespace llvm
1396
1397#endif // LLVM_SUPPORT_ERROR_H