Bug Summary

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

Annotated Source Code

Press '?' to see keyboard shortcuts

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

/build/llvm-toolchain-snapshot-8~svn345461/lib/Transforms/Instrumentation/InstrProfiling.cpp

1//===-- InstrProfiling.cpp - Frontend instrumentation based profiling -----===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This pass lowers instrprof_* intrinsics emitted by a frontend for profiling.
11// It also builds the data structures and initialization code needed for
12// updating execution counts and emitting the profile at runtime.
13//
14//===----------------------------------------------------------------------===//
15
16#include "llvm/Transforms/Instrumentation/InstrProfiling.h"
17#include "llvm/ADT/ArrayRef.h"
18#include "llvm/ADT/SmallVector.h"
19#include "llvm/ADT/StringRef.h"
20#include "llvm/ADT/Triple.h"
21#include "llvm/ADT/Twine.h"
22#include "llvm/Analysis/LoopInfo.h"
23#include "llvm/Analysis/TargetLibraryInfo.h"
24#include "llvm/IR/Attributes.h"
25#include "llvm/IR/BasicBlock.h"
26#include "llvm/IR/Constant.h"
27#include "llvm/IR/Constants.h"
28#include "llvm/IR/DerivedTypes.h"
29#include "llvm/IR/Dominators.h"
30#include "llvm/IR/Function.h"
31#include "llvm/IR/GlobalValue.h"
32#include "llvm/IR/GlobalVariable.h"
33#include "llvm/IR/IRBuilder.h"
34#include "llvm/IR/Instruction.h"
35#include "llvm/IR/Instructions.h"
36#include "llvm/IR/IntrinsicInst.h"
37#include "llvm/IR/Module.h"
38#include "llvm/IR/Type.h"
39#include "llvm/Pass.h"
40#include "llvm/ProfileData/InstrProf.h"
41#include "llvm/Support/Casting.h"
42#include "llvm/Support/CommandLine.h"
43#include "llvm/Support/Error.h"
44#include "llvm/Support/ErrorHandling.h"
45#include "llvm/Transforms/Utils/BasicBlockUtils.h"
46#include "llvm/Transforms/Utils/ModuleUtils.h"
47#include "llvm/Transforms/Utils/SSAUpdater.h"
48#include <algorithm>
49#include <cassert>
50#include <cstddef>
51#include <cstdint>
52#include <string>
53
54using namespace llvm;
55
56#define DEBUG_TYPE"instrprof" "instrprof"
57
58// The start and end values of precise value profile range for memory
59// intrinsic sizes
60cl::opt<std::string> MemOPSizeRange(
61 "memop-size-range",
62 cl::desc("Set the range of size in memory intrinsic calls to be profiled "
63 "precisely, in a format of <start_val>:<end_val>"),
64 cl::init(""));
65
66// The value that considered to be large value in memory intrinsic.
67cl::opt<unsigned> MemOPSizeLarge(
68 "memop-size-large",
69 cl::desc("Set large value thresthold in memory intrinsic size profiling. "
70 "Value of 0 disables the large value profiling."),
71 cl::init(8192));
72
73namespace {
74
75cl::opt<bool> DoNameCompression("enable-name-compression",
76 cl::desc("Enable name string compression"),
77 cl::init(true));
78
79cl::opt<bool> DoHashBasedCounterSplit(
80 "hash-based-counter-split",
81 cl::desc("Rename counter variable of a comdat function based on cfg hash"),
82 cl::init(true));
83
84cl::opt<bool> ValueProfileStaticAlloc(
85 "vp-static-alloc",
86 cl::desc("Do static counter allocation for value profiler"),
87 cl::init(true));
88
89cl::opt<double> NumCountersPerValueSite(
90 "vp-counters-per-site",
91 cl::desc("The average number of profile counters allocated "
92 "per value profiling site."),
93 // This is set to a very small value because in real programs, only
94 // a very small percentage of value sites have non-zero targets, e.g, 1/30.
95 // For those sites with non-zero profile, the average number of targets
96 // is usually smaller than 2.
97 cl::init(1.0));
98
99cl::opt<bool> AtomicCounterUpdateAll(
100 "instrprof-atomic-counter-update-all", cl::ZeroOrMore,
101 cl::desc("Make all profile counter updates atomic (for testing only)"),
102 cl::init(false));
103
104cl::opt<bool> AtomicCounterUpdatePromoted(
105 "atomic-counter-update-promoted", cl::ZeroOrMore,
106 cl::desc("Do counter update using atomic fetch add "
107 " for promoted counters only"),
108 cl::init(false));
109
110// If the option is not specified, the default behavior about whether
111// counter promotion is done depends on how instrumentaiton lowering
112// pipeline is setup, i.e., the default value of true of this option
113// does not mean the promotion will be done by default. Explicitly
114// setting this option can override the default behavior.
115cl::opt<bool> DoCounterPromotion("do-counter-promotion", cl::ZeroOrMore,
116 cl::desc("Do counter register promotion"),
117 cl::init(false));
118cl::opt<unsigned> MaxNumOfPromotionsPerLoop(
119 cl::ZeroOrMore, "max-counter-promotions-per-loop", cl::init(20),
120 cl::desc("Max number counter promotions per loop to avoid"
121 " increasing register pressure too much"));
122
123// A debug option
124cl::opt<int>
125 MaxNumOfPromotions(cl::ZeroOrMore, "max-counter-promotions", cl::init(-1),
126 cl::desc("Max number of allowed counter promotions"));
127
128cl::opt<unsigned> SpeculativeCounterPromotionMaxExiting(
129 cl::ZeroOrMore, "speculative-counter-promotion-max-exiting", cl::init(3),
130 cl::desc("The max number of exiting blocks of a loop to allow "
131 " speculative counter promotion"));
132
133cl::opt<bool> SpeculativeCounterPromotionToLoop(
134 cl::ZeroOrMore, "speculative-counter-promotion-to-loop", cl::init(false),
135 cl::desc("When the option is false, if the target block is in a loop, "
136 "the promotion will be disallowed unless the promoted counter "
137 " update can be further/iteratively promoted into an acyclic "
138 " region."));
139
140cl::opt<bool> IterativeCounterPromotion(
141 cl::ZeroOrMore, "iterative-counter-promotion", cl::init(true),
142 cl::desc("Allow counter promotion across the whole loop nest."));
143
144class InstrProfilingLegacyPass : public ModulePass {
145 InstrProfiling InstrProf;
146
147public:
148 static char ID;
149
150 InstrProfilingLegacyPass() : ModulePass(ID) {}
151 InstrProfilingLegacyPass(const InstrProfOptions &Options)
152 : ModulePass(ID), InstrProf(Options) {}
153
154 StringRef getPassName() const override {
155 return "Frontend instrumentation-based coverage lowering";
156 }
157
158 bool runOnModule(Module &M) override {
159 return InstrProf.run(M, getAnalysis<TargetLibraryInfoWrapperPass>().getTLI());
160 }
161
162 void getAnalysisUsage(AnalysisUsage &AU) const override {
163 AU.setPreservesCFG();
164 AU.addRequired<TargetLibraryInfoWrapperPass>();
165 }
166};
167
168///
169/// A helper class to promote one counter RMW operation in the loop
170/// into register update.
171///
172/// RWM update for the counter will be sinked out of the loop after
173/// the transformation.
174///
175class PGOCounterPromoterHelper : public LoadAndStorePromoter {
176public:
177 PGOCounterPromoterHelper(
178 Instruction *L, Instruction *S, SSAUpdater &SSA, Value *Init,
179 BasicBlock *PH, ArrayRef<BasicBlock *> ExitBlocks,
180 ArrayRef<Instruction *> InsertPts,
181 DenseMap<Loop *, SmallVector<LoadStorePair, 8>> &LoopToCands,
182 LoopInfo &LI)
183 : LoadAndStorePromoter({L, S}, SSA), Store(S), ExitBlocks(ExitBlocks),
184 InsertPts(InsertPts), LoopToCandidates(LoopToCands), LI(LI) {
185 assert(isa<LoadInst>(L))((isa<LoadInst>(L)) ? static_cast<void> (0) : __assert_fail
("isa<LoadInst>(L)", "/build/llvm-toolchain-snapshot-8~svn345461/lib/Transforms/Instrumentation/InstrProfiling.cpp"
, 185, __PRETTY_FUNCTION__))
;
186 assert(isa<StoreInst>(S))((isa<StoreInst>(S)) ? static_cast<void> (0) : __assert_fail
("isa<StoreInst>(S)", "/build/llvm-toolchain-snapshot-8~svn345461/lib/Transforms/Instrumentation/InstrProfiling.cpp"
, 186, __PRETTY_FUNCTION__))
;
187 SSA.AddAvailableValue(PH, Init);
188 }
189
190 void doExtraRewritesBeforeFinalDeletion() const override {
191 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
192 BasicBlock *ExitBlock = ExitBlocks[i];
193 Instruction *InsertPos = InsertPts[i];
194 // Get LiveIn value into the ExitBlock. If there are multiple
195 // predecessors, the value is defined by a PHI node in this
196 // block.
197 Value *LiveInValue = SSA.GetValueInMiddleOfBlock(ExitBlock);
198 Value *Addr = cast<StoreInst>(Store)->getPointerOperand();
199 IRBuilder<> Builder(InsertPos);
200 if (AtomicCounterUpdatePromoted)
201 // automic update currently can only be promoted across the current
202 // loop, not the whole loop nest.
203 Builder.CreateAtomicRMW(AtomicRMWInst::Add, Addr, LiveInValue,
204 AtomicOrdering::SequentiallyConsistent);
205 else {
206 LoadInst *OldVal = Builder.CreateLoad(Addr, "pgocount.promoted");
207 auto *NewVal = Builder.CreateAdd(OldVal, LiveInValue);
208 auto *NewStore = Builder.CreateStore(NewVal, Addr);
209
210 // Now update the parent loop's candidate list:
211 if (IterativeCounterPromotion) {
212 auto *TargetLoop = LI.getLoopFor(ExitBlock);
213 if (TargetLoop)
214 LoopToCandidates[TargetLoop].emplace_back(OldVal, NewStore);
215 }
216 }
217 }
218 }
219
220private:
221 Instruction *Store;
222 ArrayRef<BasicBlock *> ExitBlocks;
223 ArrayRef<Instruction *> InsertPts;
224 DenseMap<Loop *, SmallVector<LoadStorePair, 8>> &LoopToCandidates;
225 LoopInfo &LI;
226};
227
228/// A helper class to do register promotion for all profile counter
229/// updates in a loop.
230///
231class PGOCounterPromoter {
232public:
233 PGOCounterPromoter(
234 DenseMap<Loop *, SmallVector<LoadStorePair, 8>> &LoopToCands,
235 Loop &CurLoop, LoopInfo &LI)
236 : LoopToCandidates(LoopToCands), ExitBlocks(), InsertPts(), L(CurLoop),
237 LI(LI) {
238
239 SmallVector<BasicBlock *, 8> LoopExitBlocks;
240 SmallPtrSet<BasicBlock *, 8> BlockSet;
241 L.getExitBlocks(LoopExitBlocks);
242
243 for (BasicBlock *ExitBlock : LoopExitBlocks) {
244 if (BlockSet.insert(ExitBlock).second) {
245 ExitBlocks.push_back(ExitBlock);
246 InsertPts.push_back(&*ExitBlock->getFirstInsertionPt());
247 }
248 }
249 }
250
251 bool run(int64_t *NumPromoted) {
252 // Skip 'infinite' loops:
253 if (ExitBlocks.size() == 0)
254 return false;
255 unsigned MaxProm = getMaxNumOfPromotionsInLoop(&L);
256 if (MaxProm == 0)
257 return false;
258
259 unsigned Promoted = 0;
260 for (auto &Cand : LoopToCandidates[&L]) {
261
262 SmallVector<PHINode *, 4> NewPHIs;
263 SSAUpdater SSA(&NewPHIs);
264 Value *InitVal = ConstantInt::get(Cand.first->getType(), 0);
265
266 PGOCounterPromoterHelper Promoter(Cand.first, Cand.second, SSA, InitVal,
267 L.getLoopPreheader(), ExitBlocks,
268 InsertPts, LoopToCandidates, LI);
269 Promoter.run(SmallVector<Instruction *, 2>({Cand.first, Cand.second}));
270 Promoted++;
271 if (Promoted >= MaxProm)
272 break;
273
274 (*NumPromoted)++;
275 if (MaxNumOfPromotions != -1 && *NumPromoted >= MaxNumOfPromotions)
276 break;
277 }
278
279 LLVM_DEBUG(dbgs() << Promoted << " counters promoted for loop (depth="do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("instrprof")) { dbgs() << Promoted << " counters promoted for loop (depth="
<< L.getLoopDepth() << ")\n"; } } while (false)
280 << L.getLoopDepth() << ")\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("instrprof")) { dbgs() << Promoted << " counters promoted for loop (depth="
<< L.getLoopDepth() << ")\n"; } } while (false)
;
281 return Promoted != 0;
282 }
283
284private:
285 bool allowSpeculativeCounterPromotion(Loop *LP) {
286 SmallVector<BasicBlock *, 8> ExitingBlocks;
287 L.getExitingBlocks(ExitingBlocks);
288 // Not considierered speculative.
289 if (ExitingBlocks.size() == 1)
290 return true;
291 if (ExitingBlocks.size() > SpeculativeCounterPromotionMaxExiting)
292 return false;
293 return true;
294 }
295
296 // Returns the max number of Counter Promotions for LP.
297 unsigned getMaxNumOfPromotionsInLoop(Loop *LP) {
298 // We can't insert into a catchswitch.
299 SmallVector<BasicBlock *, 8> LoopExitBlocks;
300 LP->getExitBlocks(LoopExitBlocks);
301 if (llvm::any_of(LoopExitBlocks, [](BasicBlock *Exit) {
302 return isa<CatchSwitchInst>(Exit->getTerminator());
303 }))
304 return 0;
305
306 if (!LP->hasDedicatedExits())
307 return 0;
308
309 BasicBlock *PH = LP->getLoopPreheader();
310 if (!PH)
311 return 0;
312
313 SmallVector<BasicBlock *, 8> ExitingBlocks;
314 LP->getExitingBlocks(ExitingBlocks);
315 // Not considierered speculative.
316 if (ExitingBlocks.size() == 1)
317 return MaxNumOfPromotionsPerLoop;
318
319 if (ExitingBlocks.size() > SpeculativeCounterPromotionMaxExiting)
320 return 0;
321
322 // Whether the target block is in a loop does not matter:
323 if (SpeculativeCounterPromotionToLoop)
324 return MaxNumOfPromotionsPerLoop;
325
326 // Now check the target block:
327 unsigned MaxProm = MaxNumOfPromotionsPerLoop;
328 for (auto *TargetBlock : LoopExitBlocks) {
329 auto *TargetLoop = LI.getLoopFor(TargetBlock);
330 if (!TargetLoop)
331 continue;
332 unsigned MaxPromForTarget = getMaxNumOfPromotionsInLoop(TargetLoop);
333 unsigned PendingCandsInTarget = LoopToCandidates[TargetLoop].size();
334 MaxProm =
335 std::min(MaxProm, std::max(MaxPromForTarget, PendingCandsInTarget) -
336 PendingCandsInTarget);
337 }
338 return MaxProm;
339 }
340
341 DenseMap<Loop *, SmallVector<LoadStorePair, 8>> &LoopToCandidates;
342 SmallVector<BasicBlock *, 8> ExitBlocks;
343 SmallVector<Instruction *, 8> InsertPts;
344 Loop &L;
345 LoopInfo &LI;
346};
347
348} // end anonymous namespace
349
350PreservedAnalyses InstrProfiling::run(Module &M, ModuleAnalysisManager &AM) {
351 auto &TLI = AM.getResult<TargetLibraryAnalysis>(M);
352 if (!run(M, TLI))
1
Calling 'InstrProfiling::run'
353 return PreservedAnalyses::all();
354
355 return PreservedAnalyses::none();
356}
357
358char InstrProfilingLegacyPass::ID = 0;
359INITIALIZE_PASS_BEGIN(static void *initializeInstrProfilingLegacyPassPassOnce(PassRegistry
&Registry) {
360 InstrProfilingLegacyPass, "instrprof",static void *initializeInstrProfilingLegacyPassPassOnce(PassRegistry
&Registry) {
361 "Frontend instrumentation-based coverage lowering.", false, false)static void *initializeInstrProfilingLegacyPassPassOnce(PassRegistry
&Registry) {
362INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)initializeTargetLibraryInfoWrapperPassPass(Registry);
363INITIALIZE_PASS_END(PassInfo *PI = new PassInfo( "Frontend instrumentation-based coverage lowering."
, "instrprof", &InstrProfilingLegacyPass::ID, PassInfo::NormalCtor_t
(callDefaultCtor<InstrProfilingLegacyPass>), false, false
); Registry.registerPass(*PI, true); return PI; } static llvm
::once_flag InitializeInstrProfilingLegacyPassPassFlag; void llvm
::initializeInstrProfilingLegacyPassPass(PassRegistry &Registry
) { llvm::call_once(InitializeInstrProfilingLegacyPassPassFlag
, initializeInstrProfilingLegacyPassPassOnce, std::ref(Registry
)); }
364 InstrProfilingLegacyPass, "instrprof",PassInfo *PI = new PassInfo( "Frontend instrumentation-based coverage lowering."
, "instrprof", &InstrProfilingLegacyPass::ID, PassInfo::NormalCtor_t
(callDefaultCtor<InstrProfilingLegacyPass>), false, false
); Registry.registerPass(*PI, true); return PI; } static llvm
::once_flag InitializeInstrProfilingLegacyPassPassFlag; void llvm
::initializeInstrProfilingLegacyPassPass(PassRegistry &Registry
) { llvm::call_once(InitializeInstrProfilingLegacyPassPassFlag
, initializeInstrProfilingLegacyPassPassOnce, std::ref(Registry
)); }
365 "Frontend instrumentation-based coverage lowering.", false, false)PassInfo *PI = new PassInfo( "Frontend instrumentation-based coverage lowering."
, "instrprof", &InstrProfilingLegacyPass::ID, PassInfo::NormalCtor_t
(callDefaultCtor<InstrProfilingLegacyPass>), false, false
); Registry.registerPass(*PI, true); return PI; } static llvm
::once_flag InitializeInstrProfilingLegacyPassPassFlag; void llvm
::initializeInstrProfilingLegacyPassPass(PassRegistry &Registry
) { llvm::call_once(InitializeInstrProfilingLegacyPassPassFlag
, initializeInstrProfilingLegacyPassPassOnce, std::ref(Registry
)); }
366
367ModulePass *
368llvm::createInstrProfilingLegacyPass(const InstrProfOptions &Options) {
369 return new InstrProfilingLegacyPass(Options);
370}
371
372static InstrProfIncrementInst *castToIncrementInst(Instruction *Instr) {
373 InstrProfIncrementInst *Inc = dyn_cast<InstrProfIncrementInstStep>(Instr);
374 if (Inc)
375 return Inc;
376 return dyn_cast<InstrProfIncrementInst>(Instr);
377}
378
379bool InstrProfiling::lowerIntrinsics(Function *F) {
380 bool MadeChange = false;
381 PromotionCandidates.clear();
382 for (BasicBlock &BB : *F) {
383 for (auto I = BB.begin(), E = BB.end(); I != E;) {
384 auto Instr = I++;
385 InstrProfIncrementInst *Inc = castToIncrementInst(&*Instr);
386 if (Inc) {
387 lowerIncrement(Inc);
388 MadeChange = true;
389 } else if (auto *Ind = dyn_cast<InstrProfValueProfileInst>(Instr)) {
390 lowerValueProfileInst(Ind);
391 MadeChange = true;
392 }
393 }
394 }
395
396 if (!MadeChange)
397 return false;
398
399 promoteCounterLoadStores(F);
400 return true;
401}
402
403bool InstrProfiling::isCounterPromotionEnabled() const {
404 if (DoCounterPromotion.getNumOccurrences() > 0)
405 return DoCounterPromotion;
406
407 return Options.DoCounterPromotion;
408}
409
410void InstrProfiling::promoteCounterLoadStores(Function *F) {
411 if (!isCounterPromotionEnabled())
412 return;
413
414 DominatorTree DT(*F);
415 LoopInfo LI(DT);
416 DenseMap<Loop *, SmallVector<LoadStorePair, 8>> LoopPromotionCandidates;
417
418 for (const auto &LoadStore : PromotionCandidates) {
419 auto *CounterLoad = LoadStore.first;
420 auto *CounterStore = LoadStore.second;
421 BasicBlock *BB = CounterLoad->getParent();
422 Loop *ParentLoop = LI.getLoopFor(BB);
423 if (!ParentLoop)
424 continue;
425 LoopPromotionCandidates[ParentLoop].emplace_back(CounterLoad, CounterStore);
426 }
427
428 SmallVector<Loop *, 4> Loops = LI.getLoopsInPreorder();
429
430 // Do a post-order traversal of the loops so that counter updates can be
431 // iteratively hoisted outside the loop nest.
432 for (auto *Loop : llvm::reverse(Loops)) {
433 PGOCounterPromoter Promoter(LoopPromotionCandidates, *Loop, LI);
434 Promoter.run(&TotalCountersPromoted);
435 }
436}
437
438/// Check if the module contains uses of any profiling intrinsics.
439static bool containsProfilingIntrinsics(Module &M) {
440 if (auto *F = M.getFunction(
441 Intrinsic::getName(llvm::Intrinsic::instrprof_increment)))
442 if (!F->use_empty())
443 return true;
444 if (auto *F = M.getFunction(
445 Intrinsic::getName(llvm::Intrinsic::instrprof_increment_step)))
446 if (!F->use_empty())
447 return true;
448 if (auto *F = M.getFunction(
449 Intrinsic::getName(llvm::Intrinsic::instrprof_value_profile)))
450 if (!F->use_empty())
451 return true;
452 return false;
453}
454
455bool InstrProfiling::run(Module &M, const TargetLibraryInfo &TLI) {
456 this->M = &M;
457 this->TLI = &TLI;
458 NamesVar = nullptr;
459 NamesSize = 0;
460 ProfileDataMap.clear();
461 UsedVars.clear();
462 getMemOPSizeRangeFromOption(MemOPSizeRange, MemOPSizeRangeStart,
463 MemOPSizeRangeLast);
464 TT = Triple(M.getTargetTriple());
465
466 // Emit the runtime hook even if no counters are present.
467 bool MadeChange = emitRuntimeHook();
468
469 // Improve compile time by avoiding linear scans when there is no work.
470 GlobalVariable *CoverageNamesVar =
471 M.getNamedGlobal(getCoverageUnusedNamesVarName());
472 if (!containsProfilingIntrinsics(M) && !CoverageNamesVar)
473 return MadeChange;
474
475 // We did not know how many value sites there would be inside
476 // the instrumented function. This is counting the number of instrumented
477 // target value sites to enter it as field in the profile data variable.
478 for (Function &F : M) {
479 InstrProfIncrementInst *FirstProfIncInst = nullptr;
480 for (BasicBlock &BB : F)
481 for (auto I = BB.begin(), E = BB.end(); I != E; I++)
482 if (auto *Ind = dyn_cast<InstrProfValueProfileInst>(I))
483 computeNumValueSiteCounts(Ind);
484 else if (FirstProfIncInst == nullptr)
485 FirstProfIncInst = dyn_cast<InstrProfIncrementInst>(I);
486
487 // Value profiling intrinsic lowering requires per-function profile data
488 // variable to be created first.
489 if (FirstProfIncInst != nullptr)
490 static_cast<void>(getOrCreateRegionCounters(FirstProfIncInst));
491 }
492
493 for (Function &F : M)
494 MadeChange |= lowerIntrinsics(&F);
495
496 if (CoverageNamesVar) {
2
Assuming 'CoverageNamesVar' is null
3
Taking false branch
497 lowerCoverageData(CoverageNamesVar);
498 MadeChange = true;
499 }
500
501 if (!MadeChange)
4
Taking false branch
502 return false;
503
504 emitVNodes();
505 emitNameData();
5
Calling 'InstrProfiling::emitNameData'
506 emitRegistration();
507 emitUses();
508 emitInitialization();
509 return true;
510}
511
512static Constant *getOrInsertValueProfilingCall(Module &M,
513 const TargetLibraryInfo &TLI,
514 bool IsRange = false) {
515 LLVMContext &Ctx = M.getContext();
516 auto *ReturnTy = Type::getVoidTy(M.getContext());
517
518 Constant *Res;
519 if (!IsRange) {
520 Type *ParamTypes[] = {
521#define VALUE_PROF_FUNC_PARAM(ParamType, ParamName, ParamLLVMType) ParamLLVMType
522#include "llvm/ProfileData/InstrProfData.inc"
523 };
524 auto *ValueProfilingCallTy =
525 FunctionType::get(ReturnTy, makeArrayRef(ParamTypes), false);
526 Res = M.getOrInsertFunction(getInstrProfValueProfFuncName(),
527 ValueProfilingCallTy);
528 } else {
529 Type *RangeParamTypes[] = {
530#define VALUE_RANGE_PROF 1
531#define VALUE_PROF_FUNC_PARAM(ParamType, ParamName, ParamLLVMType) ParamLLVMType
532#include "llvm/ProfileData/InstrProfData.inc"
533#undef VALUE_RANGE_PROF
534 };
535 auto *ValueRangeProfilingCallTy =
536 FunctionType::get(ReturnTy, makeArrayRef(RangeParamTypes), false);
537 Res = M.getOrInsertFunction(getInstrProfValueRangeProfFuncName(),
538 ValueRangeProfilingCallTy);
539 }
540
541 if (Function *FunRes = dyn_cast<Function>(Res)) {
542 if (auto AK = TLI.getExtAttrForI32Param(false))
543 FunRes->addParamAttr(2, AK);
544 }
545 return Res;
546}
547
548void InstrProfiling::computeNumValueSiteCounts(InstrProfValueProfileInst *Ind) {
549 GlobalVariable *Name = Ind->getName();
550 uint64_t ValueKind = Ind->getValueKind()->getZExtValue();
551 uint64_t Index = Ind->getIndex()->getZExtValue();
552 auto It = ProfileDataMap.find(Name);
553 if (It == ProfileDataMap.end()) {
554 PerFunctionProfileData PD;
555 PD.NumValueSites[ValueKind] = Index + 1;
556 ProfileDataMap[Name] = PD;
557 } else if (It->second.NumValueSites[ValueKind] <= Index)
558 It->second.NumValueSites[ValueKind] = Index + 1;
559}
560
561void InstrProfiling::lowerValueProfileInst(InstrProfValueProfileInst *Ind) {
562 GlobalVariable *Name = Ind->getName();
563 auto It = ProfileDataMap.find(Name);
564 assert(It != ProfileDataMap.end() && It->second.DataVar &&((It != ProfileDataMap.end() && It->second.DataVar
&& "value profiling detected in function with no counter incerement"
) ? static_cast<void> (0) : __assert_fail ("It != ProfileDataMap.end() && It->second.DataVar && \"value profiling detected in function with no counter incerement\""
, "/build/llvm-toolchain-snapshot-8~svn345461/lib/Transforms/Instrumentation/InstrProfiling.cpp"
, 565, __PRETTY_FUNCTION__))
565 "value profiling detected in function with no counter incerement")((It != ProfileDataMap.end() && It->second.DataVar
&& "value profiling detected in function with no counter incerement"
) ? static_cast<void> (0) : __assert_fail ("It != ProfileDataMap.end() && It->second.DataVar && \"value profiling detected in function with no counter incerement\""
, "/build/llvm-toolchain-snapshot-8~svn345461/lib/Transforms/Instrumentation/InstrProfiling.cpp"
, 565, __PRETTY_FUNCTION__))
;
566
567 GlobalVariable *DataVar = It->second.DataVar;
568 uint64_t ValueKind = Ind->getValueKind()->getZExtValue();
569 uint64_t Index = Ind->getIndex()->getZExtValue();
570 for (uint32_t Kind = IPVK_First; Kind < ValueKind; ++Kind)
571 Index += It->second.NumValueSites[Kind];
572
573 IRBuilder<> Builder(Ind);
574 bool IsRange = (Ind->getValueKind()->getZExtValue() ==
575 llvm::InstrProfValueKind::IPVK_MemOPSize);
576 CallInst *Call = nullptr;
577 if (!IsRange) {
578 Value *Args[3] = {Ind->getTargetValue(),
579 Builder.CreateBitCast(DataVar, Builder.getInt8PtrTy()),
580 Builder.getInt32(Index)};
581 Call = Builder.CreateCall(getOrInsertValueProfilingCall(*M, *TLI), Args);
582 } else {
583 Value *Args[6] = {
584 Ind->getTargetValue(),
585 Builder.CreateBitCast(DataVar, Builder.getInt8PtrTy()),
586 Builder.getInt32(Index),
587 Builder.getInt64(MemOPSizeRangeStart),
588 Builder.getInt64(MemOPSizeRangeLast),
589 Builder.getInt64(MemOPSizeLarge == 0 ? INT64_MIN(-9223372036854775807L -1) : MemOPSizeLarge)};
590 Call =
591 Builder.CreateCall(getOrInsertValueProfilingCall(*M, *TLI, true), Args);
592 }
593 if (auto AK = TLI->getExtAttrForI32Param(false))
594 Call->addParamAttr(2, AK);
595 Ind->replaceAllUsesWith(Call);
596 Ind->eraseFromParent();
597}
598
599void InstrProfiling::lowerIncrement(InstrProfIncrementInst *Inc) {
600 GlobalVariable *Counters = getOrCreateRegionCounters(Inc);
601
602 IRBuilder<> Builder(Inc);
603 uint64_t Index = Inc->getIndex()->getZExtValue();
604 Value *Addr = Builder.CreateConstInBoundsGEP2_64(Counters, 0, Index);
605
606 if (Options.Atomic || AtomicCounterUpdateAll) {
607 Builder.CreateAtomicRMW(AtomicRMWInst::Add, Addr, Inc->getStep(),
608 AtomicOrdering::Monotonic);
609 } else {
610 Value *Load = Builder.CreateLoad(Addr, "pgocount");
611 auto *Count = Builder.CreateAdd(Load, Inc->getStep());
612 auto *Store = Builder.CreateStore(Count, Addr);
613 if (isCounterPromotionEnabled())
614 PromotionCandidates.emplace_back(cast<Instruction>(Load), Store);
615 }
616 Inc->eraseFromParent();
617}
618
619void InstrProfiling::lowerCoverageData(GlobalVariable *CoverageNamesVar) {
620 ConstantArray *Names =
621 cast<ConstantArray>(CoverageNamesVar->getInitializer());
622 for (unsigned I = 0, E = Names->getNumOperands(); I < E; ++I) {
623 Constant *NC = Names->getOperand(I);
624 Value *V = NC->stripPointerCasts();
625 assert(isa<GlobalVariable>(V) && "Missing reference to function name")((isa<GlobalVariable>(V) && "Missing reference to function name"
) ? static_cast<void> (0) : __assert_fail ("isa<GlobalVariable>(V) && \"Missing reference to function name\""
, "/build/llvm-toolchain-snapshot-8~svn345461/lib/Transforms/Instrumentation/InstrProfiling.cpp"
, 625, __PRETTY_FUNCTION__))
;
626 GlobalVariable *Name = cast<GlobalVariable>(V);
627
628 Name->setLinkage(GlobalValue::PrivateLinkage);
629 ReferencedNames.push_back(Name);
630 NC->dropAllReferences();
631 }
632 CoverageNamesVar->eraseFromParent();
633}
634
635/// Get the name of a profiling variable for a particular function.
636static std::string getVarName(InstrProfIncrementInst *Inc, StringRef Prefix) {
637 StringRef NamePrefix = getInstrProfNameVarPrefix();
638 StringRef Name = Inc->getName()->getName().substr(NamePrefix.size());
639 Function *F = Inc->getParent()->getParent();
640 Module *M = F->getParent();
641 if (!DoHashBasedCounterSplit || !isIRPGOFlagSet(M) ||
642 !canRenameComdatFunc(*F))
643 return (Prefix + Name).str();
644 uint64_t FuncHash = Inc->getHash()->getZExtValue();
645 SmallVector<char, 24> HashPostfix;
646 if (Name.endswith((Twine(".") + Twine(FuncHash)).toStringRef(HashPostfix)))
647 return (Prefix + Name).str();
648 return (Prefix + Name + "." + Twine(FuncHash)).str();
649}
650
651static inline bool shouldRecordFunctionAddr(Function *F) {
652 // Check the linkage
653 bool HasAvailableExternallyLinkage = F->hasAvailableExternallyLinkage();
654 if (!F->hasLinkOnceLinkage() && !F->hasLocalLinkage() &&
655 !HasAvailableExternallyLinkage)
656 return true;
657
658 // A function marked 'alwaysinline' with available_externally linkage can't
659 // have its address taken. Doing so would create an undefined external ref to
660 // the function, which would fail to link.
661 if (HasAvailableExternallyLinkage &&
662 F->hasFnAttribute(Attribute::AlwaysInline))
663 return false;
664
665 // Prohibit function address recording if the function is both internal and
666 // COMDAT. This avoids the profile data variable referencing internal symbols
667 // in COMDAT.
668 if (F->hasLocalLinkage() && F->hasComdat())
669 return false;
670
671 // Check uses of this function for other than direct calls or invokes to it.
672 // Inline virtual functions have linkeOnceODR linkage. When a key method
673 // exists, the vtable will only be emitted in the TU where the key method
674 // is defined. In a TU where vtable is not available, the function won't
675 // be 'addresstaken'. If its address is not recorded here, the profile data
676 // with missing address may be picked by the linker leading to missing
677 // indirect call target info.
678 return F->hasAddressTaken() || F->hasLinkOnceLinkage();
679}
680
681static inline Comdat *getOrCreateProfileComdat(Module &M, Function &F,
682 InstrProfIncrementInst *Inc) {
683 if (!needsComdatForCounter(F, M))
684 return nullptr;
685
686 // COFF format requires a COMDAT section to have a key symbol with the same
687 // name. The linker targeting COFF also requires that the COMDAT
688 // a section is associated to must precede the associating section. For this
689 // reason, we must choose the counter var's name as the name of the comdat.
690 StringRef ComdatPrefix = (Triple(M.getTargetTriple()).isOSBinFormatCOFF()
691 ? getInstrProfCountersVarPrefix()
692 : getInstrProfComdatPrefix());
693 return M.getOrInsertComdat(StringRef(getVarName(Inc, ComdatPrefix)));
694}
695
696static bool needsRuntimeRegistrationOfSectionRange(const Module &M) {
697 // Don't do this for Darwin. compiler-rt uses linker magic.
698 if (Triple(M.getTargetTriple()).isOSDarwin())
699 return false;
700
701 // Use linker script magic to get data/cnts/name start/end.
702 if (Triple(M.getTargetTriple()).isOSLinux() ||
703 Triple(M.getTargetTriple()).isOSFreeBSD() ||
704 Triple(M.getTargetTriple()).isOSFuchsia() ||
705 Triple(M.getTargetTriple()).isPS4CPU())
706 return false;
707
708 return true;
709}
710
711GlobalVariable *
712InstrProfiling::getOrCreateRegionCounters(InstrProfIncrementInst *Inc) {
713 GlobalVariable *NamePtr = Inc->getName();
714 auto It = ProfileDataMap.find(NamePtr);
715 PerFunctionProfileData PD;
716 if (It != ProfileDataMap.end()) {
717 if (It->second.RegionCounters)
718 return It->second.RegionCounters;
719 PD = It->second;
720 }
721
722 // Move the name variable to the right section. Place them in a COMDAT group
723 // if the associated function is a COMDAT. This will make sure that
724 // only one copy of counters of the COMDAT function will be emitted after
725 // linking.
726 Function *Fn = Inc->getParent()->getParent();
727 Comdat *ProfileVarsComdat = nullptr;
728 ProfileVarsComdat = getOrCreateProfileComdat(*M, *Fn, Inc);
729
730 uint64_t NumCounters = Inc->getNumCounters()->getZExtValue();
731 LLVMContext &Ctx = M->getContext();
732 ArrayType *CounterTy = ArrayType::get(Type::getInt64Ty(Ctx), NumCounters);
733
734 // Create the counters variable.
735 auto *CounterPtr =
736 new GlobalVariable(*M, CounterTy, false, NamePtr->getLinkage(),
737 Constant::getNullValue(CounterTy),
738 getVarName(Inc, getInstrProfCountersVarPrefix()));
739 CounterPtr->setVisibility(NamePtr->getVisibility());
740 CounterPtr->setSection(
741 getInstrProfSectionName(IPSK_cnts, TT.getObjectFormat()));
742 CounterPtr->setAlignment(8);
743 CounterPtr->setComdat(ProfileVarsComdat);
744
745 auto *Int8PtrTy = Type::getInt8PtrTy(Ctx);
746 // Allocate statically the array of pointers to value profile nodes for
747 // the current function.
748 Constant *ValuesPtrExpr = ConstantPointerNull::get(Int8PtrTy);
749 if (ValueProfileStaticAlloc && !needsRuntimeRegistrationOfSectionRange(*M)) {
750 uint64_t NS = 0;
751 for (uint32_t Kind = IPVK_First; Kind <= IPVK_Last; ++Kind)
752 NS += PD.NumValueSites[Kind];
753 if (NS) {
754 ArrayType *ValuesTy = ArrayType::get(Type::getInt64Ty(Ctx), NS);
755
756 auto *ValuesVar =
757 new GlobalVariable(*M, ValuesTy, false, NamePtr->getLinkage(),
758 Constant::getNullValue(ValuesTy),
759 getVarName(Inc, getInstrProfValuesVarPrefix()));
760 ValuesVar->setVisibility(NamePtr->getVisibility());
761 ValuesVar->setSection(
762 getInstrProfSectionName(IPSK_vals, TT.getObjectFormat()));
763 ValuesVar->setAlignment(8);
764 ValuesVar->setComdat(ProfileVarsComdat);
765 ValuesPtrExpr =
766 ConstantExpr::getBitCast(ValuesVar, Type::getInt8PtrTy(Ctx));
767 }
768 }
769
770 // Create data variable.
771 auto *Int16Ty = Type::getInt16Ty(Ctx);
772 auto *Int16ArrayTy = ArrayType::get(Int16Ty, IPVK_Last + 1);
773 Type *DataTypes[] = {
774#define INSTR_PROF_DATA(Type, LLVMType, Name, Init) LLVMType,
775#include "llvm/ProfileData/InstrProfData.inc"
776 };
777 auto *DataTy = StructType::get(Ctx, makeArrayRef(DataTypes));
778
779 Constant *FunctionAddr = shouldRecordFunctionAddr(Fn)
780 ? ConstantExpr::getBitCast(Fn, Int8PtrTy)
781 : ConstantPointerNull::get(Int8PtrTy);
782
783 Constant *Int16ArrayVals[IPVK_Last + 1];
784 for (uint32_t Kind = IPVK_First; Kind <= IPVK_Last; ++Kind)
785 Int16ArrayVals[Kind] = ConstantInt::get(Int16Ty, PD.NumValueSites[Kind]);
786
787 Constant *DataVals[] = {
788#define INSTR_PROF_DATA(Type, LLVMType, Name, Init) Init,
789#include "llvm/ProfileData/InstrProfData.inc"
790 };
791 auto *Data = new GlobalVariable(*M, DataTy, false, NamePtr->getLinkage(),
792 ConstantStruct::get(DataTy, DataVals),
793 getVarName(Inc, getInstrProfDataVarPrefix()));
794 Data->setVisibility(NamePtr->getVisibility());
795 Data->setSection(getInstrProfSectionName(IPSK_data, TT.getObjectFormat()));
796 Data->setAlignment(INSTR_PROF_DATA_ALIGNMENT8);
797 Data->setComdat(ProfileVarsComdat);
798
799 PD.RegionCounters = CounterPtr;
800 PD.DataVar = Data;
801 ProfileDataMap[NamePtr] = PD;
802
803 // Mark the data variable as used so that it isn't stripped out.
804 UsedVars.push_back(Data);
805 // Now that the linkage set by the FE has been passed to the data and counter
806 // variables, reset Name variable's linkage and visibility to private so that
807 // it can be removed later by the compiler.
808 NamePtr->setLinkage(GlobalValue::PrivateLinkage);
809 // Collect the referenced names to be used by emitNameData.
810 ReferencedNames.push_back(NamePtr);
811
812 return CounterPtr;
813}
814
815void InstrProfiling::emitVNodes() {
816 if (!ValueProfileStaticAlloc)
817 return;
818
819 // For now only support this on platforms that do
820 // not require runtime registration to discover
821 // named section start/end.
822 if (needsRuntimeRegistrationOfSectionRange(*M))
823 return;
824
825 size_t TotalNS = 0;
826 for (auto &PD : ProfileDataMap) {
827 for (uint32_t Kind = IPVK_First; Kind <= IPVK_Last; ++Kind)
828 TotalNS += PD.second.NumValueSites[Kind];
829 }
830
831 if (!TotalNS)
832 return;
833
834 uint64_t NumCounters = TotalNS * NumCountersPerValueSite;
835// Heuristic for small programs with very few total value sites.
836// The default value of vp-counters-per-site is chosen based on
837// the observation that large apps usually have a low percentage
838// of value sites that actually have any profile data, and thus
839// the average number of counters per site is low. For small
840// apps with very few sites, this may not be true. Bump up the
841// number of counters in this case.
842#define INSTR_PROF_MIN_VAL_COUNTS10 10
843 if (NumCounters < INSTR_PROF_MIN_VAL_COUNTS10)
844 NumCounters = std::max(INSTR_PROF_MIN_VAL_COUNTS10, (int)NumCounters * 2);
845
846 auto &Ctx = M->getContext();
847 Type *VNodeTypes[] = {
848#define INSTR_PROF_VALUE_NODE(Type, LLVMType, Name, Init) LLVMType,
849#include "llvm/ProfileData/InstrProfData.inc"
850 };
851 auto *VNodeTy = StructType::get(Ctx, makeArrayRef(VNodeTypes));
852
853 ArrayType *VNodesTy = ArrayType::get(VNodeTy, NumCounters);
854 auto *VNodesVar = new GlobalVariable(
855 *M, VNodesTy, false, GlobalValue::PrivateLinkage,
856 Constant::getNullValue(VNodesTy), getInstrProfVNodesVarName());
857 VNodesVar->setSection(
858 getInstrProfSectionName(IPSK_vnodes, TT.getObjectFormat()));
859 UsedVars.push_back(VNodesVar);
860}
861
862void InstrProfiling::emitNameData() {
863 std::string UncompressedData;
864
865 if (ReferencedNames.empty())
6
Assuming the condition is false
7
Taking false branch
866 return;
867
868 std::string CompressedNameStr;
869 if (Error E = collectPGOFuncNameStrings(ReferencedNames, CompressedNameStr,
8
Taking true branch
870 DoNameCompression)) {
871 report_fatal_error(toString(std::move(E)), false);
9
Calling 'toString'
872 }
873
874 auto &Ctx = M->getContext();
875 auto *NamesVal = ConstantDataArray::getString(
876 Ctx, StringRef(CompressedNameStr), false);
877 NamesVar = new GlobalVariable(*M, NamesVal->getType(), true,
878 GlobalValue::PrivateLinkage, NamesVal,
879 getInstrProfNamesVarName());
880 NamesSize = CompressedNameStr.size();
881 NamesVar->setSection(
882 getInstrProfSectionName(IPSK_name, TT.getObjectFormat()));
883 UsedVars.push_back(NamesVar);
884
885 for (auto *NamePtr : ReferencedNames)
886 NamePtr->eraseFromParent();
887}
888
889void InstrProfiling::emitRegistration() {
890 if (!needsRuntimeRegistrationOfSectionRange(*M))
891 return;
892
893 // Construct the function.
894 auto *VoidTy = Type::getVoidTy(M->getContext());
895 auto *VoidPtrTy = Type::getInt8PtrTy(M->getContext());
896 auto *Int64Ty = Type::getInt64Ty(M->getContext());
897 auto *RegisterFTy = FunctionType::get(VoidTy, false);
898 auto *RegisterF = Function::Create(RegisterFTy, GlobalValue::InternalLinkage,
899 getInstrProfRegFuncsName(), M);
900 RegisterF->setUnnamedAddr(GlobalValue::UnnamedAddr::Global);
901 if (Options.NoRedZone)
902 RegisterF->addFnAttr(Attribute::NoRedZone);
903
904 auto *RuntimeRegisterTy = FunctionType::get(VoidTy, VoidPtrTy, false);
905 auto *RuntimeRegisterF =
906 Function::Create(RuntimeRegisterTy, GlobalVariable::ExternalLinkage,
907 getInstrProfRegFuncName(), M);
908
909 IRBuilder<> IRB(BasicBlock::Create(M->getContext(), "", RegisterF));
910 for (Value *Data : UsedVars)
911 if (Data != NamesVar && !isa<Function>(Data))
912 IRB.CreateCall(RuntimeRegisterF, IRB.CreateBitCast(Data, VoidPtrTy));
913
914 if (NamesVar) {
915 Type *ParamTypes[] = {VoidPtrTy, Int64Ty};
916 auto *NamesRegisterTy =
917 FunctionType::get(VoidTy, makeArrayRef(ParamTypes), false);
918 auto *NamesRegisterF =
919 Function::Create(NamesRegisterTy, GlobalVariable::ExternalLinkage,
920 getInstrProfNamesRegFuncName(), M);
921 IRB.CreateCall(NamesRegisterF, {IRB.CreateBitCast(NamesVar, VoidPtrTy),
922 IRB.getInt64(NamesSize)});
923 }
924
925 IRB.CreateRetVoid();
926}
927
928bool InstrProfiling::emitRuntimeHook() {
929 // We expect the linker to be invoked with -u<hook_var> flag for linux,
930 // for which case there is no need to emit the user function.
931 if (Triple(M->getTargetTriple()).isOSLinux())
932 return false;
933
934 // If the module's provided its own runtime, we don't need to do anything.
935 if (M->getGlobalVariable(getInstrProfRuntimeHookVarName()))
936 return false;
937
938 // Declare an external variable that will pull in the runtime initialization.
939 auto *Int32Ty = Type::getInt32Ty(M->getContext());
940 auto *Var =
941 new GlobalVariable(*M, Int32Ty, false, GlobalValue::ExternalLinkage,
942 nullptr, getInstrProfRuntimeHookVarName());
943
944 // Make a function that uses it.
945 auto *User = Function::Create(FunctionType::get(Int32Ty, false),
946 GlobalValue::LinkOnceODRLinkage,
947 getInstrProfRuntimeHookVarUseFuncName(), M);
948 User->addFnAttr(Attribute::NoInline);
949 if (Options.NoRedZone)
950 User->addFnAttr(Attribute::NoRedZone);
951 User->setVisibility(GlobalValue::HiddenVisibility);
952 if (Triple(M->getTargetTriple()).supportsCOMDAT())
953 User->setComdat(M->getOrInsertComdat(User->getName()));
954
955 IRBuilder<> IRB(BasicBlock::Create(M->getContext(), "", User));
956 auto *Load = IRB.CreateLoad(Var);
957 IRB.CreateRet(Load);
958
959 // Mark the user variable as used so that it isn't stripped out.
960 UsedVars.push_back(User);
961 return true;
962}
963
964void InstrProfiling::emitUses() {
965 if (!UsedVars.empty())
966 appendToUsed(*M, UsedVars);
967}
968
969void InstrProfiling::emitInitialization() {
970 StringRef InstrProfileOutput = Options.InstrProfileOutput;
971
972 if (!InstrProfileOutput.empty()) {
973 // Create variable for profile name.
974 Constant *ProfileNameConst =
975 ConstantDataArray::getString(M->getContext(), InstrProfileOutput, true);
976 GlobalVariable *ProfileNameVar = new GlobalVariable(
977 *M, ProfileNameConst->getType(), true, GlobalValue::WeakAnyLinkage,
978 ProfileNameConst, INSTR_PROF_QUOTE(INSTR_PROF_PROFILE_NAME_VAR)"__llvm_profile_filename");
979 if (TT.supportsCOMDAT()) {
980 ProfileNameVar->setLinkage(GlobalValue::ExternalLinkage);
981 ProfileNameVar->setComdat(M->getOrInsertComdat(
982 StringRef(INSTR_PROF_QUOTE(INSTR_PROF_PROFILE_NAME_VAR)"__llvm_profile_filename")));
983 }
984 }
985
986 Constant *RegisterF = M->getFunction(getInstrProfRegFuncsName());
987 if (!RegisterF)
988 return;
989
990 // Create the initialization function.
991 auto *VoidTy = Type::getVoidTy(M->getContext());
992 auto *F = Function::Create(FunctionType::get(VoidTy, false),
993 GlobalValue::InternalLinkage,
994 getInstrProfInitFuncName(), M);
995 F->setUnnamedAddr(GlobalValue::UnnamedAddr::Global);
996 F->addFnAttr(Attribute::NoInline);
997 if (Options.NoRedZone)
998 F->addFnAttr(Attribute::NoRedZone);
999
1000 // Add the basic block and the necessary calls.
1001 IRBuilder<> IRB(BasicBlock::Create(M->getContext(), "", F));
1002 if (RegisterF)
1003 IRB.CreateCall(RegisterF, {});
1004 IRB.CreateRetVoid();
1005
1006 appendToGlobalCtors(*M, F, 0);
1007}

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

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