Bug Summary

File:llvm/lib/Transforms/ObjCARC/ObjCARCContract.cpp
Warning:line 426, column 7
Called C++ object pointer is null

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name ObjCARCContract.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mframe-pointer=none -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -tune-cpu generic -fno-split-dwarf-inlining -debugger-tuning=gdb -ffunction-sections -fdata-sections -resource-dir /usr/lib/llvm-12/lib/clang/12.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/build-llvm/lib/Transforms/ObjCARC -I /build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/lib/Transforms/ObjCARC -I /build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/build-llvm/include -I /build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/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/local/include -internal-isystem /usr/lib/llvm-12/lib/clang/12.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++14 -fdeprecated-macro -fdebug-compilation-dir /build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/build-llvm/lib/Transforms/ObjCARC -fdebug-prefix-map=/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998=. -ferror-limit 19 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -o /tmp/scan-build-2020-09-28-092409-31635-1 -x c++ /build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/lib/Transforms/ObjCARC/ObjCARCContract.cpp

/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/lib/Transforms/ObjCARC/ObjCARCContract.cpp

1//===- ObjCARCContract.cpp - ObjC ARC Optimization ------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8/// \file
9/// This file defines late ObjC ARC optimizations. ARC stands for Automatic
10/// Reference Counting and is a system for managing reference counts for objects
11/// in Objective C.
12///
13/// This specific file mainly deals with ``contracting'' multiple lower level
14/// operations into singular higher level operations through pattern matching.
15///
16/// WARNING: This file knows about certain library functions. It recognizes them
17/// by name, and hardwires knowledge of their semantics.
18///
19/// WARNING: This file knows about how certain Objective-C library functions are
20/// used. Naive LLVM IR transformations which would otherwise be
21/// behavior-preserving may break these assumptions.
22///
23//===----------------------------------------------------------------------===//
24
25// TODO: ObjCARCContract could insert PHI nodes when uses aren't
26// dominated by single calls.
27
28#include "ARCRuntimeEntryPoints.h"
29#include "DependencyAnalysis.h"
30#include "ObjCARC.h"
31#include "ProvenanceAnalysis.h"
32#include "llvm/ADT/Statistic.h"
33#include "llvm/Analysis/EHPersonalities.h"
34#include "llvm/IR/Dominators.h"
35#include "llvm/IR/InlineAsm.h"
36#include "llvm/IR/InstIterator.h"
37#include "llvm/IR/Operator.h"
38#include "llvm/IR/PassManager.h"
39#include "llvm/InitializePasses.h"
40#include "llvm/Support/CommandLine.h"
41#include "llvm/Support/Debug.h"
42#include "llvm/Support/raw_ostream.h"
43#include "llvm/Transforms/ObjCARC.h"
44
45using namespace llvm;
46using namespace llvm::objcarc;
47
48#define DEBUG_TYPE"objc-arc-contract" "objc-arc-contract"
49
50STATISTIC(NumPeeps, "Number of calls peephole-optimized")static llvm::Statistic NumPeeps = {"objc-arc-contract", "NumPeeps"
, "Number of calls peephole-optimized"}
;
51STATISTIC(NumStoreStrongs, "Number objc_storeStrong calls formed")static llvm::Statistic NumStoreStrongs = {"objc-arc-contract"
, "NumStoreStrongs", "Number objc_storeStrong calls formed"}
;
52
53//===----------------------------------------------------------------------===//
54// Declarations
55//===----------------------------------------------------------------------===//
56
57namespace {
58/// Late ARC optimizations
59///
60/// These change the IR in a way that makes it difficult to be analyzed by
61/// ObjCARCOpt, so it's run late.
62
63class ObjCARCContract {
64 bool Changed;
65 AliasAnalysis *AA;
66 DominatorTree *DT;
67 ProvenanceAnalysis PA;
68 ARCRuntimeEntryPoints EP;
69
70 /// A flag indicating whether this optimization pass should run.
71 bool Run;
72
73 /// The inline asm string to insert between calls and RetainRV calls to make
74 /// the optimization work on targets which need it.
75 const MDString *RVInstMarker;
76
77 /// The set of inserted objc_storeStrong calls. If at the end of walking the
78 /// function we have found no alloca instructions, these calls can be marked
79 /// "tail".
80 SmallPtrSet<CallInst *, 8> StoreStrongCalls;
81
82 /// Returns true if we eliminated Inst.
83 bool tryToPeepholeInstruction(
84 Function &F, Instruction *Inst, inst_iterator &Iter,
85 SmallPtrSetImpl<Instruction *> &DepInsts,
86 SmallPtrSetImpl<const BasicBlock *> &Visited, bool &TailOkForStoreStrong,
87 const DenseMap<BasicBlock *, ColorVector> &BlockColors);
88
89 bool optimizeRetainCall(Function &F, Instruction *Retain);
90
91 bool
92 contractAutorelease(Function &F, Instruction *Autorelease, ARCInstKind Class,
93 SmallPtrSetImpl<Instruction *> &DependingInstructions,
94 SmallPtrSetImpl<const BasicBlock *> &Visited);
95
96 void tryToContractReleaseIntoStoreStrong(
97 Instruction *Release, inst_iterator &Iter,
98 const DenseMap<BasicBlock *, ColorVector> &BlockColors);
99
100public:
101 bool init(Module &M);
102 bool run(Function &F, AAResults *AA, DominatorTree *DT);
103};
104
105class ObjCARCContractLegacyPass : public FunctionPass {
106 ObjCARCContract OCARCC;
107
108public:
109 void getAnalysisUsage(AnalysisUsage &AU) const override;
110 bool doInitialization(Module &M) override;
111 bool runOnFunction(Function &F) override;
112
113 static char ID;
114 ObjCARCContractLegacyPass() : FunctionPass(ID) {
115 initializeObjCARCContractLegacyPassPass(*PassRegistry::getPassRegistry());
116 }
117};
118}
119
120//===----------------------------------------------------------------------===//
121// Implementation
122//===----------------------------------------------------------------------===//
123
124/// Turn objc_retain into objc_retainAutoreleasedReturnValue if the operand is a
125/// return value. We do this late so we do not disrupt the dataflow analysis in
126/// ObjCARCOpt.
127bool ObjCARCContract::optimizeRetainCall(Function &F, Instruction *Retain) {
128 const auto *Call = dyn_cast<CallBase>(GetArgRCIdentityRoot(Retain));
129 if (!Call)
130 return false;
131 if (Call->getParent() != Retain->getParent())
132 return false;
133
134 // Check that the call is next to the retain.
135 BasicBlock::const_iterator I = ++Call->getIterator();
136 while (IsNoopInstruction(&*I))
137 ++I;
138 if (&*I != Retain)
139 return false;
140
141 // Turn it to an objc_retainAutoreleasedReturnValue.
142 Changed = true;
143 ++NumPeeps;
144
145 LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << "Transforming objc_retain => "
"objc_retainAutoreleasedReturnValue since the operand is a "
"return value.\nOld: " << *Retain << "\n"; } } while
(false)
146 dbgs() << "Transforming objc_retain => "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << "Transforming objc_retain => "
"objc_retainAutoreleasedReturnValue since the operand is a "
"return value.\nOld: " << *Retain << "\n"; } } while
(false)
147 "objc_retainAutoreleasedReturnValue since the operand is a "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << "Transforming objc_retain => "
"objc_retainAutoreleasedReturnValue since the operand is a "
"return value.\nOld: " << *Retain << "\n"; } } while
(false)
148 "return value.\nOld: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << "Transforming objc_retain => "
"objc_retainAutoreleasedReturnValue since the operand is a "
"return value.\nOld: " << *Retain << "\n"; } } while
(false)
149 << *Retain << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << "Transforming objc_retain => "
"objc_retainAutoreleasedReturnValue since the operand is a "
"return value.\nOld: " << *Retain << "\n"; } } while
(false)
;
150
151 // We do not have to worry about tail calls/does not throw since
152 // retain/retainRV have the same properties.
153 Function *Decl = EP.get(ARCRuntimeEntryPointKind::RetainRV);
154 cast<CallInst>(Retain)->setCalledFunction(Decl);
155
156 LLVM_DEBUG(dbgs() << "New: " << *Retain << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << "New: " << *Retain
<< "\n"; } } while (false)
;
157 return true;
158}
159
160/// Merge an autorelease with a retain into a fused call.
161bool ObjCARCContract::contractAutorelease(
162 Function &F, Instruction *Autorelease, ARCInstKind Class,
163 SmallPtrSetImpl<Instruction *> &DependingInstructions,
164 SmallPtrSetImpl<const BasicBlock *> &Visited) {
165 const Value *Arg = GetArgRCIdentityRoot(Autorelease);
166
167 // Check that there are no instructions between the retain and the autorelease
168 // (such as an autorelease_pop) which may change the count.
169 CallInst *Retain = nullptr;
170 if (Class == ARCInstKind::AutoreleaseRV)
171 FindDependencies(RetainAutoreleaseRVDep, Arg,
172 Autorelease->getParent(), Autorelease,
173 DependingInstructions, Visited, PA);
174 else
175 FindDependencies(RetainAutoreleaseDep, Arg,
176 Autorelease->getParent(), Autorelease,
177 DependingInstructions, Visited, PA);
178
179 Visited.clear();
180 if (DependingInstructions.size() != 1) {
181 DependingInstructions.clear();
182 return false;
183 }
184
185 Retain = dyn_cast_or_null<CallInst>(*DependingInstructions.begin());
186 DependingInstructions.clear();
187
188 if (!Retain || GetBasicARCInstKind(Retain) != ARCInstKind::Retain ||
189 GetArgRCIdentityRoot(Retain) != Arg)
190 return false;
191
192 Changed = true;
193 ++NumPeeps;
194
195 LLVM_DEBUG(dbgs() << " Fusing retain/autorelease!\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << " Fusing retain/autorelease!\n"
" Autorelease:" << *Autorelease << "\n" " Retain: "
<< *Retain << "\n"; } } while (false)
196 " Autorelease:"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << " Fusing retain/autorelease!\n"
" Autorelease:" << *Autorelease << "\n" " Retain: "
<< *Retain << "\n"; } } while (false)
197 << *Autoreleasedo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << " Fusing retain/autorelease!\n"
" Autorelease:" << *Autorelease << "\n" " Retain: "
<< *Retain << "\n"; } } while (false)
198 << "\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << " Fusing retain/autorelease!\n"
" Autorelease:" << *Autorelease << "\n" " Retain: "
<< *Retain << "\n"; } } while (false)
199 " Retain: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << " Fusing retain/autorelease!\n"
" Autorelease:" << *Autorelease << "\n" " Retain: "
<< *Retain << "\n"; } } while (false)
200 << *Retain << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << " Fusing retain/autorelease!\n"
" Autorelease:" << *Autorelease << "\n" " Retain: "
<< *Retain << "\n"; } } while (false)
;
201
202 Function *Decl = EP.get(Class == ARCInstKind::AutoreleaseRV
203 ? ARCRuntimeEntryPointKind::RetainAutoreleaseRV
204 : ARCRuntimeEntryPointKind::RetainAutorelease);
205 Retain->setCalledFunction(Decl);
206
207 LLVM_DEBUG(dbgs() << " New RetainAutorelease: " << *Retain << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << " New RetainAutorelease: "
<< *Retain << "\n"; } } while (false)
;
208
209 EraseInstruction(Autorelease);
210 return true;
211}
212
213static StoreInst *findSafeStoreForStoreStrongContraction(LoadInst *Load,
214 Instruction *Release,
215 ProvenanceAnalysis &PA,
216 AliasAnalysis *AA) {
217 StoreInst *Store = nullptr;
218 bool SawRelease = false;
219
220 // Get the location associated with Load.
221 MemoryLocation Loc = MemoryLocation::get(Load);
222 auto *LocPtr = Loc.Ptr->stripPointerCasts();
223
224 // Walk down to find the store and the release, which may be in either order.
225 for (auto I = std::next(BasicBlock::iterator(Load)),
31
Loop condition is true. Entering loop body
49
Loop condition is true. Entering loop body
58
Loop condition is false. Execution continues on line 292
226 E = Load->getParent()->end();
227 I != E; ++I) {
27
Calling 'operator!='
30
Returning from 'operator!='
45
Calling 'operator!='
48
Returning from 'operator!='
54
Calling 'operator!='
57
Returning from 'operator!='
228 // If we found the store we were looking for and saw the release,
229 // break. There is no more work to be done.
230 if (Store
31.1
'Store' is null
49.1
'Store' is non-null, which participates in a condition later
31.1
'Store' is null
49.1
'Store' is non-null, which participates in a condition later
31.1
'Store' is null
49.1
'Store' is non-null, which participates in a condition later
&& SawRelease
49.2
'SawRelease' is false
49.2
'SawRelease' is false
49.2
'SawRelease' is false
)
50
Taking false branch
231 break;
232
233 // Now we know that we have not seen either the store or the release. If I
234 // is the release, mark that we saw the release and continue.
235 Instruction *Inst = &*I;
236 if (Inst == Release) {
32
Assuming 'Inst' is not equal to 'Release', which participates in a condition later
33
Taking false branch
51
Assuming 'Inst' is equal to 'Release'
52
Taking true branch
237 SawRelease = true;
238 continue;
53
Execution continues on line 227
239 }
240
241 // Otherwise, we check if Inst is a "good" store. Grab the instruction class
242 // of Inst.
243 ARCInstKind Class = GetBasicARCInstKind(Inst);
244
245 // If Inst is an unrelated retain, we don't care about it.
246 //
247 // TODO: This is one area where the optimization could be made more
248 // aggressive.
249 if (IsRetain(Class))
34
Assuming the condition is false
35
Taking false branch
250 continue;
251
252 // If we have seen the store, but not the release...
253 if (Store
35.1
'Store' is null
35.1
'Store' is null
35.1
'Store' is null
) {
36
Taking false branch
254 // We need to make sure that it is safe to move the release from its
255 // current position to the store. This implies proving that any
256 // instruction in between Store and the Release conservatively can not use
257 // the RCIdentityRoot of Release. If we can prove we can ignore Inst, so
258 // continue...
259 if (!CanUse(Inst, Load, PA, Class)) {
260 continue;
261 }
262
263 // Otherwise, be conservative and return nullptr.
264 return nullptr;
265 }
266
267 // Ok, now we know we have not seen a store yet. See if Inst can write to
268 // our load location, if it can not, just ignore the instruction.
269 if (!isModSet(AA->getModRefInfo(Inst, Loc)))
37
Assuming the condition is false
38
Taking false branch
270 continue;
271
272 Store = dyn_cast<StoreInst>(Inst);
39
Assuming 'Inst' is a 'StoreInst'
273
274 // If Inst can, then check if Inst is a simple store. If Inst is not a
275 // store or a store that is not simple, then we have some we do not
276 // understand writing to this memory implying we can not move the load
277 // over the write to any subsequent store that we may find.
278 if (!Store
39.1
'Store' is non-null, which participates in a condition later
39.1
'Store' is non-null, which participates in a condition later
39.1
'Store' is non-null, which participates in a condition later
|| !Store->isSimple())
40
Assuming the condition is false
41
Taking false branch
279 return nullptr;
280
281 // Then make sure that the pointer we are storing to is Ptr. If so, we
282 // found our Store!
283 if (Store->getPointerOperand()->stripPointerCasts() == LocPtr)
42
Assuming the condition is true
43
Taking true branch
284 continue;
44
Execution continues on line 227
285
286 // Otherwise, we have an unknown store to some other ptr that clobbers
287 // Loc.Ptr. Bail!
288 return nullptr;
289 }
290
291 // If we did not find the store or did not see the release, fail.
292 if (!Store
58.1
'Store' is non-null, which participates in a condition later
58.1
'Store' is non-null, which participates in a condition later
58.1
'Store' is non-null, which participates in a condition later
|| !SawRelease
58.2
'SawRelease' is true
58.2
'SawRelease' is true
58.2
'SawRelease' is true
)
59
Taking false branch
293 return nullptr;
294
295 // We succeeded!
296 return Store;
60
Returning pointer (loaded from 'Store'), which participates in a condition later
297}
298
299static Instruction *
300findRetainForStoreStrongContraction(Value *New, StoreInst *Store,
301 Instruction *Release,
302 ProvenanceAnalysis &PA) {
303 // Walk up from the Store to find the retain.
304 BasicBlock::iterator I = Store->getIterator();
305 BasicBlock::iterator Begin = Store->getParent()->begin();
306 while (I != Begin && GetBasicARCInstKind(&*I) != ARCInstKind::Retain) {
64
Calling 'operator!='
67
Returning from 'operator!='
307 Instruction *Inst = &*I;
308
309 // It is only safe to move the retain to the store if we can prove
310 // conservatively that nothing besides the release can decrement reference
311 // counts in between the retain and the store.
312 if (CanDecrementRefCount(Inst, New, PA) && Inst != Release)
313 return nullptr;
314 --I;
315 }
316 Instruction *Retain = &*I;
317 if (GetBasicARCInstKind(Retain) != ARCInstKind::Retain)
68
Assuming the condition is false
69
Taking false branch
318 return nullptr;
319 if (GetArgRCIdentityRoot(Retain) != New)
70
Assuming the condition is false
71
Taking false branch
320 return nullptr;
321 return Retain;
72
Returning pointer (loaded from 'Retain'), which participates in a condition later
322}
323
324/// Create a call instruction with the correct funclet token. Should be used
325/// instead of calling CallInst::Create directly.
326static CallInst *
327createCallInst(FunctionType *FTy, Value *Func, ArrayRef<Value *> Args,
328 const Twine &NameStr, Instruction *InsertBefore,
329 const DenseMap<BasicBlock *, ColorVector> &BlockColors) {
330 SmallVector<OperandBundleDef, 1> OpBundles;
331 if (!BlockColors.empty()) {
332 const ColorVector &CV = BlockColors.find(InsertBefore->getParent())->second;
333 assert(CV.size() == 1 && "non-unique color for block!")((CV.size() == 1 && "non-unique color for block!") ? static_cast
<void> (0) : __assert_fail ("CV.size() == 1 && \"non-unique color for block!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/lib/Transforms/ObjCARC/ObjCARCContract.cpp"
, 333, __PRETTY_FUNCTION__))
;
334 Instruction *EHPad = CV.front()->getFirstNonPHI();
335 if (EHPad->isEHPad())
336 OpBundles.emplace_back("funclet", EHPad);
337 }
338
339 return CallInst::Create(FTy, Func, Args, OpBundles, NameStr, InsertBefore);
340}
341
342static CallInst *
343createCallInst(FunctionCallee Func, ArrayRef<Value *> Args, const Twine &NameStr,
344 Instruction *InsertBefore,
345 const DenseMap<BasicBlock *, ColorVector> &BlockColors) {
346 return createCallInst(Func.getFunctionType(), Func.getCallee(), Args, NameStr,
347 InsertBefore, BlockColors);
348}
349
350/// Attempt to merge an objc_release with a store, load, and objc_retain to form
351/// an objc_storeStrong. An objc_storeStrong:
352///
353/// objc_storeStrong(i8** %old_ptr, i8* new_value)
354///
355/// is equivalent to the following IR sequence:
356///
357/// ; Load old value.
358/// %old_value = load i8** %old_ptr (1)
359///
360/// ; Increment the new value and then release the old value. This must occur
361/// ; in order in case old_value releases new_value in its destructor causing
362/// ; us to potentially have a dangling ptr.
363/// tail call i8* @objc_retain(i8* %new_value) (2)
364/// tail call void @objc_release(i8* %old_value) (3)
365///
366/// ; Store the new_value into old_ptr
367/// store i8* %new_value, i8** %old_ptr (4)
368///
369/// The safety of this optimization is based around the following
370/// considerations:
371///
372/// 1. We are forming the store strong at the store. Thus to perform this
373/// optimization it must be safe to move the retain, load, and release to
374/// (4).
375/// 2. We need to make sure that any re-orderings of (1), (2), (3), (4) are
376/// safe.
377void ObjCARCContract::tryToContractReleaseIntoStoreStrong(
378 Instruction *Release, inst_iterator &Iter,
379 const DenseMap<BasicBlock *, ColorVector> &BlockColors) {
380 // See if we are releasing something that we just loaded.
381 auto *Load = dyn_cast<LoadInst>(GetArgRCIdentityRoot(Release));
17
Assuming the object is a 'LoadInst'
382 if (!Load
17.1
'Load' is non-null
17.1
'Load' is non-null
17.1
'Load' is non-null
|| !Load->isSimple())
18
Calling 'LoadInst::isSimple'
22
Returning from 'LoadInst::isSimple'
23
Taking false branch
383 return;
384
385 // For now, require everything to be in one basic block.
386 BasicBlock *BB = Release->getParent();
387 if (Load->getParent() != BB)
24
Assuming the condition is false
25
Taking false branch
388 return;
389
390 // First scan down the BB from Load, looking for a store of the RCIdentityRoot
391 // of Load's
392 StoreInst *Store =
393 findSafeStoreForStoreStrongContraction(Load, Release, PA, AA);
26
Calling 'findSafeStoreForStoreStrongContraction'
61
Returning from 'findSafeStoreForStoreStrongContraction'
394 // If we fail, bail.
395 if (!Store
61.1
'Store' is non-null
61.1
'Store' is non-null
61.1
'Store' is non-null
)
62
Taking false branch
396 return;
397
398 // Then find what new_value's RCIdentity Root is.
399 Value *New = GetRCIdentityRoot(Store->getValueOperand());
400
401 // Then walk up the BB and look for a retain on New without any intervening
402 // instructions which conservatively might decrement ref counts.
403 Instruction *Retain =
404 findRetainForStoreStrongContraction(New, Store, Release, PA);
63
Calling 'findRetainForStoreStrongContraction'
73
Returning from 'findRetainForStoreStrongContraction'
405
406 // If we fail, bail.
407 if (!Retain
73.1
'Retain' is non-null
73.1
'Retain' is non-null
73.1
'Retain' is non-null
)
74
Taking false branch
408 return;
409
410 Changed = true;
411 ++NumStoreStrongs;
412
413 LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { llvm::dbgs() << " Contracting retain, release into objc_storeStrong.\n"
<< " Old:\n" << " Store: " <<
*Store << "\n" << " Release: " <<
*Release << "\n" << " Retain: " <<
*Retain << "\n" << " Load: " <<
*Load << "\n"; } } while (false)
75
Assuming 'DebugFlag' is false
76
Loop condition is false. Exiting loop
414 llvm::dbgs() << " Contracting retain, release into objc_storeStrong.\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { llvm::dbgs() << " Contracting retain, release into objc_storeStrong.\n"
<< " Old:\n" << " Store: " <<
*Store << "\n" << " Release: " <<
*Release << "\n" << " Retain: " <<
*Retain << "\n" << " Load: " <<
*Load << "\n"; } } while (false)
415 << " Old:\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { llvm::dbgs() << " Contracting retain, release into objc_storeStrong.\n"
<< " Old:\n" << " Store: " <<
*Store << "\n" << " Release: " <<
*Release << "\n" << " Retain: " <<
*Retain << "\n" << " Load: " <<
*Load << "\n"; } } while (false)
416 << " Store: " << *Store << "\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { llvm::dbgs() << " Contracting retain, release into objc_storeStrong.\n"
<< " Old:\n" << " Store: " <<
*Store << "\n" << " Release: " <<
*Release << "\n" << " Retain: " <<
*Retain << "\n" << " Load: " <<
*Load << "\n"; } } while (false)
417 << " Release: " << *Release << "\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { llvm::dbgs() << " Contracting retain, release into objc_storeStrong.\n"
<< " Old:\n" << " Store: " <<
*Store << "\n" << " Release: " <<
*Release << "\n" << " Retain: " <<
*Retain << "\n" << " Load: " <<
*Load << "\n"; } } while (false)
418 << " Retain: " << *Retain << "\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { llvm::dbgs() << " Contracting retain, release into objc_storeStrong.\n"
<< " Old:\n" << " Store: " <<
*Store << "\n" << " Release: " <<
*Release << "\n" << " Retain: " <<
*Retain << "\n" << " Load: " <<
*Load << "\n"; } } while (false)
419 << " Load: " << *Load << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { llvm::dbgs() << " Contracting retain, release into objc_storeStrong.\n"
<< " Old:\n" << " Store: " <<
*Store << "\n" << " Release: " <<
*Release << "\n" << " Retain: " <<
*Retain << "\n" << " Load: " <<
*Load << "\n"; } } while (false)
;
420
421 LLVMContext &C = Release->getContext();
422 Type *I8X = PointerType::getUnqual(Type::getInt8Ty(C));
423 Type *I8XX = PointerType::getUnqual(I8X);
424
425 Value *Args[] = { Load->getPointerOperand(), New };
77
Initializing to a null pointer value
426 if (Args[0]->getType() != I8XX)
78
Called C++ object pointer is null
427 Args[0] = new BitCastInst(Args[0], I8XX, "", Store);
428 if (Args[1]->getType() != I8X)
429 Args[1] = new BitCastInst(Args[1], I8X, "", Store);
430 Function *Decl = EP.get(ARCRuntimeEntryPointKind::StoreStrong);
431 CallInst *StoreStrong = createCallInst(Decl, Args, "", Store, BlockColors);
432 StoreStrong->setDoesNotThrow();
433 StoreStrong->setDebugLoc(Store->getDebugLoc());
434
435 // We can't set the tail flag yet, because we haven't yet determined
436 // whether there are any escaping allocas. Remember this call, so that
437 // we can set the tail flag once we know it's safe.
438 StoreStrongCalls.insert(StoreStrong);
439
440 LLVM_DEBUG(llvm::dbgs() << " New Store Strong: " << *StoreStrongdo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { llvm::dbgs() << " New Store Strong: "
<< *StoreStrong << "\n"; } } while (false)
441 << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { llvm::dbgs() << " New Store Strong: "
<< *StoreStrong << "\n"; } } while (false)
;
442
443 if (&*Iter == Retain) ++Iter;
444 if (&*Iter == Store) ++Iter;
445 Store->eraseFromParent();
446 Release->eraseFromParent();
447 EraseInstruction(Retain);
448 if (Load->use_empty())
449 Load->eraseFromParent();
450}
451
452bool ObjCARCContract::tryToPeepholeInstruction(
453 Function &F, Instruction *Inst, inst_iterator &Iter,
454 SmallPtrSetImpl<Instruction *> &DependingInsts,
455 SmallPtrSetImpl<const BasicBlock *> &Visited, bool &TailOkForStoreStrongs,
456 const DenseMap<BasicBlock *, ColorVector> &BlockColors) {
457 // Only these library routines return their argument. In particular,
458 // objc_retainBlock does not necessarily return its argument.
459 ARCInstKind Class = GetBasicARCInstKind(Inst);
460 switch (Class) {
15
Control jumps to 'case Release:' at line 528
461 case ARCInstKind::FusedRetainAutorelease:
462 case ARCInstKind::FusedRetainAutoreleaseRV:
463 return false;
464 case ARCInstKind::Autorelease:
465 case ARCInstKind::AutoreleaseRV:
466 return contractAutorelease(F, Inst, Class, DependingInsts, Visited);
467 case ARCInstKind::Retain:
468 // Attempt to convert retains to retainrvs if they are next to function
469 // calls.
470 if (!optimizeRetainCall(F, Inst))
471 return false;
472 // If we succeed in our optimization, fall through.
473 LLVM_FALLTHROUGH[[gnu::fallthrough]];
474 case ARCInstKind::RetainRV:
475 case ARCInstKind::ClaimRV: {
476 // If we're compiling for a target which needs a special inline-asm
477 // marker to do the return value optimization, insert it now.
478 if (!RVInstMarker)
479 return false;
480 BasicBlock::iterator BBI = Inst->getIterator();
481 BasicBlock *InstParent = Inst->getParent();
482
483 // Step up to see if the call immediately precedes the RV call.
484 // If it's an invoke, we have to cross a block boundary. And we have
485 // to carefully dodge no-op instructions.
486 do {
487 if (BBI == InstParent->begin()) {
488 BasicBlock *Pred = InstParent->getSinglePredecessor();
489 if (!Pred)
490 goto decline_rv_optimization;
491 BBI = Pred->getTerminator()->getIterator();
492 break;
493 }
494 --BBI;
495 } while (IsNoopInstruction(&*BBI));
496
497 if (&*BBI == GetArgRCIdentityRoot(Inst)) {
498 LLVM_DEBUG(dbgs() << "Adding inline asm marker for the return value "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << "Adding inline asm marker for the return value "
"optimization.\n"; } } while (false)
499 "optimization.\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << "Adding inline asm marker for the return value "
"optimization.\n"; } } while (false)
;
500 Changed = true;
501 InlineAsm *IA =
502 InlineAsm::get(FunctionType::get(Type::getVoidTy(Inst->getContext()),
503 /*isVarArg=*/false),
504 RVInstMarker->getString(),
505 /*Constraints=*/"", /*hasSideEffects=*/true);
506
507 createCallInst(IA, None, "", Inst, BlockColors);
508 }
509 decline_rv_optimization:
510 return false;
511 }
512 case ARCInstKind::InitWeak: {
513 // objc_initWeak(p, null) => *p = null
514 CallInst *CI = cast<CallInst>(Inst);
515 if (IsNullOrUndef(CI->getArgOperand(1))) {
516 Value *Null = ConstantPointerNull::get(cast<PointerType>(CI->getType()));
517 Changed = true;
518 new StoreInst(Null, CI->getArgOperand(0), CI);
519
520 LLVM_DEBUG(dbgs() << "OBJCARCContract: Old = " << *CI << "\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << "OBJCARCContract: Old = "
<< *CI << "\n" << " New = "
<< *Null << "\n"; } } while (false)
521 << " New = " << *Null << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << "OBJCARCContract: Old = "
<< *CI << "\n" << " New = "
<< *Null << "\n"; } } while (false)
;
522
523 CI->replaceAllUsesWith(Null);
524 CI->eraseFromParent();
525 }
526 return true;
527 }
528 case ARCInstKind::Release:
529 // Try to form an objc store strong from our release. If we fail, there is
530 // nothing further to do below, so continue.
531 tryToContractReleaseIntoStoreStrong(Inst, Iter, BlockColors);
16
Calling 'ObjCARCContract::tryToContractReleaseIntoStoreStrong'
532 return true;
533 case ARCInstKind::User:
534 // Be conservative if the function has any alloca instructions.
535 // Technically we only care about escaping alloca instructions,
536 // but this is sufficient to handle some interesting cases.
537 if (isa<AllocaInst>(Inst))
538 TailOkForStoreStrongs = false;
539 return true;
540 case ARCInstKind::IntrinsicUser:
541 // Remove calls to @llvm.objc.clang.arc.use(...).
542 Changed = true;
543 Inst->eraseFromParent();
544 return true;
545 default:
546 return true;
547 }
548}
549
550//===----------------------------------------------------------------------===//
551// Top Level Driver
552//===----------------------------------------------------------------------===//
553
554bool ObjCARCContract::init(Module &M) {
555 // If nothing in the Module uses ARC, don't do anything.
556 Run = ModuleHasARC(M);
557 if (!Run)
558 return false;
559
560 EP.init(&M);
561
562 // Initialize RVInstMarker.
563 const char *MarkerKey = "clang.arc.retainAutoreleasedReturnValueMarker";
564 RVInstMarker = dyn_cast_or_null<MDString>(M.getModuleFlag(MarkerKey));
565
566 return false;
567}
568
569bool ObjCARCContract::run(Function &F, AAResults *A, DominatorTree *D) {
570 if (!EnableARCOpts)
4
Assuming 'EnableARCOpts' is true
5
Taking false branch
571 return false;
572
573 // If nothing in the Module uses ARC, don't do anything.
574 if (!Run
5.1
Field 'Run' is true
5.1
Field 'Run' is true
5.1
Field 'Run' is true
)
6
Taking false branch
575 return false;
576
577 Changed = false;
578 AA = A;
579 DT = D;
580 PA.setAA(A);
581
582 DenseMap<BasicBlock *, ColorVector> BlockColors;
583 if (F.hasPersonalityFn() &&
7
Assuming the condition is false
584 isScopedEHPersonality(classifyEHPersonality(F.getPersonalityFn())))
585 BlockColors = colorEHFunclets(F);
586
587 LLVM_DEBUG(llvm::dbgs() << "**** ObjCARC Contract ****\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { llvm::dbgs() << "**** ObjCARC Contract ****\n"
; } } while (false)
;
8
Assuming 'DebugFlag' is false
9
Loop condition is false. Exiting loop
588
589 // Track whether it's ok to mark objc_storeStrong calls with the "tail"
590 // keyword. Be conservative if the function has variadic arguments.
591 // It seems that functions which "return twice" are also unsafe for the
592 // "tail" argument, because they are setjmp, which could need to
593 // return to an earlier stack state.
594 bool TailOkForStoreStrongs =
595 !F.isVarArg() && !F.callsFunctionThatReturnsTwice();
10
Assuming the condition is false
596
597 // For ObjC library calls which return their argument, replace uses of the
598 // argument with uses of the call return value, if it dominates the use. This
599 // reduces register pressure.
600 SmallPtrSet<Instruction *, 4> DependingInstructions;
601 SmallPtrSet<const BasicBlock *, 4> Visited;
602
603 for (inst_iterator I = inst_begin(&F), E = inst_end(&F); I != E;) {
11
Loop condition is true. Entering loop body
604 Instruction *Inst = &*I++;
605
606 LLVM_DEBUG(dbgs() << "Visiting: " << *Inst << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-contract")) { dbgs() << "Visiting: " <<
*Inst << "\n"; } } while (false)
;
12
Assuming 'DebugFlag' is false
13
Loop condition is false. Exiting loop
607
608 // First try to peephole Inst. If there is nothing further we can do in
609 // terms of undoing objc-arc-expand, process the next inst.
610 if (tryToPeepholeInstruction(F, Inst, I, DependingInstructions, Visited,
14
Calling 'ObjCARCContract::tryToPeepholeInstruction'
611 TailOkForStoreStrongs, BlockColors))
612 continue;
613
614 // Otherwise, try to undo objc-arc-expand.
615
616 // Don't use GetArgRCIdentityRoot because we don't want to look through bitcasts
617 // and such; to do the replacement, the argument must have type i8*.
618
619 // Function for replacing uses of Arg dominated by Inst.
620 auto ReplaceArgUses = [Inst, this](Value *Arg) {
621 // If we're compiling bugpointed code, don't get in trouble.
622 if (!isa<Instruction>(Arg) && !isa<Argument>(Arg))
623 return;
624
625 // Look through the uses of the pointer.
626 for (Value::use_iterator UI = Arg->use_begin(), UE = Arg->use_end();
627 UI != UE; ) {
628 // Increment UI now, because we may unlink its element.
629 Use &U = *UI++;
630 unsigned OperandNo = U.getOperandNo();
631
632 // If the call's return value dominates a use of the call's argument
633 // value, rewrite the use to use the return value. We check for
634 // reachability here because an unreachable call is considered to
635 // trivially dominate itself, which would lead us to rewriting its
636 // argument in terms of its return value, which would lead to
637 // infinite loops in GetArgRCIdentityRoot.
638 if (!DT->isReachableFromEntry(U) || !DT->dominates(Inst, U))
639 continue;
640
641 Changed = true;
642 Instruction *Replacement = Inst;
643 Type *UseTy = U.get()->getType();
644 if (PHINode *PHI = dyn_cast<PHINode>(U.getUser())) {
645 // For PHI nodes, insert the bitcast in the predecessor block.
646 unsigned ValNo = PHINode::getIncomingValueNumForOperand(OperandNo);
647 BasicBlock *IncomingBB = PHI->getIncomingBlock(ValNo);
648 if (Replacement->getType() != UseTy) {
649 // A catchswitch is both a pad and a terminator, meaning a basic
650 // block with a catchswitch has no insertion point. Keep going up
651 // the dominator tree until we find a non-catchswitch.
652 BasicBlock *InsertBB = IncomingBB;
653 while (isa<CatchSwitchInst>(InsertBB->getFirstNonPHI())) {
654 InsertBB = DT->getNode(InsertBB)->getIDom()->getBlock();
655 }
656
657 assert(DT->dominates(Inst, &InsertBB->back()) &&((DT->dominates(Inst, &InsertBB->back()) &&
"Invalid insertion point for bitcast") ? static_cast<void
> (0) : __assert_fail ("DT->dominates(Inst, &InsertBB->back()) && \"Invalid insertion point for bitcast\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/lib/Transforms/ObjCARC/ObjCARCContract.cpp"
, 658, __PRETTY_FUNCTION__))
658 "Invalid insertion point for bitcast")((DT->dominates(Inst, &InsertBB->back()) &&
"Invalid insertion point for bitcast") ? static_cast<void
> (0) : __assert_fail ("DT->dominates(Inst, &InsertBB->back()) && \"Invalid insertion point for bitcast\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/lib/Transforms/ObjCARC/ObjCARCContract.cpp"
, 658, __PRETTY_FUNCTION__))
;
659 Replacement =
660 new BitCastInst(Replacement, UseTy, "", &InsertBB->back());
661 }
662
663 // While we're here, rewrite all edges for this PHI, rather
664 // than just one use at a time, to minimize the number of
665 // bitcasts we emit.
666 for (unsigned i = 0, e = PHI->getNumIncomingValues(); i != e; ++i)
667 if (PHI->getIncomingBlock(i) == IncomingBB) {
668 // Keep the UI iterator valid.
669 if (UI != UE &&
670 &PHI->getOperandUse(
671 PHINode::getOperandNumForIncomingValue(i)) == &*UI)
672 ++UI;
673 PHI->setIncomingValue(i, Replacement);
674 }
675 } else {
676 if (Replacement->getType() != UseTy)
677 Replacement = new BitCastInst(Replacement, UseTy, "",
678 cast<Instruction>(U.getUser()));
679 U.set(Replacement);
680 }
681 }
682 };
683
684 Value *Arg = cast<CallInst>(Inst)->getArgOperand(0);
685 Value *OrigArg = Arg;
686
687 // TODO: Change this to a do-while.
688 for (;;) {
689 ReplaceArgUses(Arg);
690
691 // If Arg is a no-op casted pointer, strip one level of casts and iterate.
692 if (const BitCastInst *BI = dyn_cast<BitCastInst>(Arg))
693 Arg = BI->getOperand(0);
694 else if (isa<GEPOperator>(Arg) &&
695 cast<GEPOperator>(Arg)->hasAllZeroIndices())
696 Arg = cast<GEPOperator>(Arg)->getPointerOperand();
697 else if (isa<GlobalAlias>(Arg) &&
698 !cast<GlobalAlias>(Arg)->isInterposable())
699 Arg = cast<GlobalAlias>(Arg)->getAliasee();
700 else {
701 // If Arg is a PHI node, get PHIs that are equivalent to it and replace
702 // their uses.
703 if (PHINode *PN = dyn_cast<PHINode>(Arg)) {
704 SmallVector<Value *, 1> PHIList;
705 getEquivalentPHIs(*PN, PHIList);
706 for (Value *PHI : PHIList)
707 ReplaceArgUses(PHI);
708 }
709 break;
710 }
711 }
712
713 // Replace bitcast users of Arg that are dominated by Inst.
714 SmallVector<BitCastInst *, 2> BitCastUsers;
715
716 // Add all bitcast users of the function argument first.
717 for (User *U : OrigArg->users())
718 if (auto *BC = dyn_cast<BitCastInst>(U))
719 BitCastUsers.push_back(BC);
720
721 // Replace the bitcasts with the call return. Iterate until list is empty.
722 while (!BitCastUsers.empty()) {
723 auto *BC = BitCastUsers.pop_back_val();
724 for (User *U : BC->users())
725 if (auto *B = dyn_cast<BitCastInst>(U))
726 BitCastUsers.push_back(B);
727
728 ReplaceArgUses(BC);
729 }
730 }
731
732 // If this function has no escaping allocas or suspicious vararg usage,
733 // objc_storeStrong calls can be marked with the "tail" keyword.
734 if (TailOkForStoreStrongs)
735 for (CallInst *CI : StoreStrongCalls)
736 CI->setTailCall();
737 StoreStrongCalls.clear();
738
739 return Changed;
740}
741
742//===----------------------------------------------------------------------===//
743// Misc Pass Manager
744//===----------------------------------------------------------------------===//
745
746char ObjCARCContractLegacyPass::ID = 0;
747INITIALIZE_PASS_BEGIN(ObjCARCContractLegacyPass, "objc-arc-contract",static void *initializeObjCARCContractLegacyPassPassOnce(PassRegistry
&Registry) {
748 "ObjC ARC contraction", false, false)static void *initializeObjCARCContractLegacyPassPassOnce(PassRegistry
&Registry) {
749INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass)initializeAAResultsWrapperPassPass(Registry);
750INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)initializeDominatorTreeWrapperPassPass(Registry);
751INITIALIZE_PASS_END(ObjCARCContractLegacyPass, "objc-arc-contract",PassInfo *PI = new PassInfo( "ObjC ARC contraction", "objc-arc-contract"
, &ObjCARCContractLegacyPass::ID, PassInfo::NormalCtor_t(
callDefaultCtor<ObjCARCContractLegacyPass>), false, false
); Registry.registerPass(*PI, true); return PI; } static llvm
::once_flag InitializeObjCARCContractLegacyPassPassFlag; void
llvm::initializeObjCARCContractLegacyPassPass(PassRegistry &
Registry) { llvm::call_once(InitializeObjCARCContractLegacyPassPassFlag
, initializeObjCARCContractLegacyPassPassOnce, std::ref(Registry
)); }
752 "ObjC ARC contraction", false, false)PassInfo *PI = new PassInfo( "ObjC ARC contraction", "objc-arc-contract"
, &ObjCARCContractLegacyPass::ID, PassInfo::NormalCtor_t(
callDefaultCtor<ObjCARCContractLegacyPass>), false, false
); Registry.registerPass(*PI, true); return PI; } static llvm
::once_flag InitializeObjCARCContractLegacyPassPassFlag; void
llvm::initializeObjCARCContractLegacyPassPass(PassRegistry &
Registry) { llvm::call_once(InitializeObjCARCContractLegacyPassPassFlag
, initializeObjCARCContractLegacyPassPassOnce, std::ref(Registry
)); }
753
754void ObjCARCContractLegacyPass::getAnalysisUsage(AnalysisUsage &AU) const {
755 AU.addRequired<AAResultsWrapperPass>();
756 AU.addRequired<DominatorTreeWrapperPass>();
757 AU.setPreservesCFG();
758}
759
760Pass *llvm::createObjCARCContractPass() {
761 return new ObjCARCContractLegacyPass();
762}
763
764bool ObjCARCContractLegacyPass::doInitialization(Module &M) {
765 return OCARCC.init(M);
766}
767
768bool ObjCARCContractLegacyPass::runOnFunction(Function &F) {
769 auto *AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
770 auto *DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
771 return OCARCC.run(F, AA, DT);
772}
773
774PreservedAnalyses ObjCARCContractPass::run(Module &M,
775 ModuleAnalysisManager &AM) {
776 ObjCARCContract OCAC;
777 OCAC.init(M);
778
779 auto &FAM = AM.getResult<FunctionAnalysisManagerModuleProxy>(M).getManager();
780 bool Changed = false;
781 for (Function &F : M) {
782 if (F.isDeclaration())
1
Assuming the condition is false
2
Taking false branch
783 continue;
784 Changed |= OCAC.run(F, &FAM.getResult<AAManager>(F),
3
Calling 'ObjCARCContract::run'
785 &FAM.getResult<DominatorTreeAnalysis>(F));
786 }
787 if (Changed) {
788 PreservedAnalyses PA;
789 PA.preserveSet<CFGAnalyses>();
790 return PA;
791 }
792 return PreservedAnalyses::all();
793}

/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h

1//===- llvm/Instructions.h - Instruction subclass definitions ---*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file exposes the class definitions of all of the subclasses of the
10// Instruction class. This is meant to be an easy way to get access to all
11// instruction subclasses.
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_IR_INSTRUCTIONS_H
16#define LLVM_IR_INSTRUCTIONS_H
17
18#include "llvm/ADT/ArrayRef.h"
19#include "llvm/ADT/Bitfields.h"
20#include "llvm/ADT/None.h"
21#include "llvm/ADT/STLExtras.h"
22#include "llvm/ADT/SmallVector.h"
23#include "llvm/ADT/StringRef.h"
24#include "llvm/ADT/Twine.h"
25#include "llvm/ADT/iterator.h"
26#include "llvm/ADT/iterator_range.h"
27#include "llvm/IR/Attributes.h"
28#include "llvm/IR/BasicBlock.h"
29#include "llvm/IR/CallingConv.h"
30#include "llvm/IR/CFG.h"
31#include "llvm/IR/Constant.h"
32#include "llvm/IR/DerivedTypes.h"
33#include "llvm/IR/Function.h"
34#include "llvm/IR/InstrTypes.h"
35#include "llvm/IR/Instruction.h"
36#include "llvm/IR/OperandTraits.h"
37#include "llvm/IR/Type.h"
38#include "llvm/IR/Use.h"
39#include "llvm/IR/User.h"
40#include "llvm/IR/Value.h"
41#include "llvm/Support/AtomicOrdering.h"
42#include "llvm/Support/Casting.h"
43#include "llvm/Support/ErrorHandling.h"
44#include <cassert>
45#include <cstddef>
46#include <cstdint>
47#include <iterator>
48
49namespace llvm {
50
51class APInt;
52class ConstantInt;
53class DataLayout;
54class LLVMContext;
55
56//===----------------------------------------------------------------------===//
57// AllocaInst Class
58//===----------------------------------------------------------------------===//
59
60/// an instruction to allocate memory on the stack
61class AllocaInst : public UnaryInstruction {
62 Type *AllocatedType;
63
64 using AlignmentField = AlignmentBitfieldElementT<0>;
65 using UsedWithInAllocaField = BoolBitfieldElementT<AlignmentField::NextBit>;
66 using SwiftErrorField = BoolBitfieldElementT<UsedWithInAllocaField::NextBit>;
67 static_assert(Bitfield::areContiguous<AlignmentField, UsedWithInAllocaField,
68 SwiftErrorField>(),
69 "Bitfields must be contiguous");
70
71protected:
72 // Note: Instruction needs to be a friend here to call cloneImpl.
73 friend class Instruction;
74
75 AllocaInst *cloneImpl() const;
76
77public:
78 explicit AllocaInst(Type *Ty, unsigned AddrSpace, Value *ArraySize,
79 const Twine &Name, Instruction *InsertBefore);
80 AllocaInst(Type *Ty, unsigned AddrSpace, Value *ArraySize,
81 const Twine &Name, BasicBlock *InsertAtEnd);
82
83 AllocaInst(Type *Ty, unsigned AddrSpace, const Twine &Name,
84 Instruction *InsertBefore);
85 AllocaInst(Type *Ty, unsigned AddrSpace,
86 const Twine &Name, BasicBlock *InsertAtEnd);
87
88 AllocaInst(Type *Ty, unsigned AddrSpace, Value *ArraySize, Align Align,
89 const Twine &Name = "", Instruction *InsertBefore = nullptr);
90 AllocaInst(Type *Ty, unsigned AddrSpace, Value *ArraySize, Align Align,
91 const Twine &Name, BasicBlock *InsertAtEnd);
92
93 /// Return true if there is an allocation size parameter to the allocation
94 /// instruction that is not 1.
95 bool isArrayAllocation() const;
96
97 /// Get the number of elements allocated. For a simple allocation of a single
98 /// element, this will return a constant 1 value.
99 const Value *getArraySize() const { return getOperand(0); }
100 Value *getArraySize() { return getOperand(0); }
101
102 /// Overload to return most specific pointer type.
103 PointerType *getType() const {
104 return cast<PointerType>(Instruction::getType());
105 }
106
107 /// Get allocation size in bits. Returns None if size can't be determined,
108 /// e.g. in case of a VLA.
109 Optional<uint64_t> getAllocationSizeInBits(const DataLayout &DL) const;
110
111 /// Return the type that is being allocated by the instruction.
112 Type *getAllocatedType() const { return AllocatedType; }
113 /// for use only in special circumstances that need to generically
114 /// transform a whole instruction (eg: IR linking and vectorization).
115 void setAllocatedType(Type *Ty) { AllocatedType = Ty; }
116
117 /// Return the alignment of the memory that is being allocated by the
118 /// instruction.
119 Align getAlign() const {
120 return Align(1ULL << getSubclassData<AlignmentField>());
121 }
122
123 void setAlignment(Align Align) {
124 setSubclassData<AlignmentField>(Log2(Align));
125 }
126
127 // FIXME: Remove this one transition to Align is over.
128 unsigned getAlignment() const { return getAlign().value(); }
129
130 /// Return true if this alloca is in the entry block of the function and is a
131 /// constant size. If so, the code generator will fold it into the
132 /// prolog/epilog code, so it is basically free.
133 bool isStaticAlloca() const;
134
135 /// Return true if this alloca is used as an inalloca argument to a call. Such
136 /// allocas are never considered static even if they are in the entry block.
137 bool isUsedWithInAlloca() const {
138 return getSubclassData<UsedWithInAllocaField>();
139 }
140
141 /// Specify whether this alloca is used to represent the arguments to a call.
142 void setUsedWithInAlloca(bool V) {
143 setSubclassData<UsedWithInAllocaField>(V);
144 }
145
146 /// Return true if this alloca is used as a swifterror argument to a call.
147 bool isSwiftError() const { return getSubclassData<SwiftErrorField>(); }
148 /// Specify whether this alloca is used to represent a swifterror.
149 void setSwiftError(bool V) { setSubclassData<SwiftErrorField>(V); }
150
151 // Methods for support type inquiry through isa, cast, and dyn_cast:
152 static bool classof(const Instruction *I) {
153 return (I->getOpcode() == Instruction::Alloca);
154 }
155 static bool classof(const Value *V) {
156 return isa<Instruction>(V) && classof(cast<Instruction>(V));
157 }
158
159private:
160 // Shadow Instruction::setInstructionSubclassData with a private forwarding
161 // method so that subclasses cannot accidentally use it.
162 template <typename Bitfield>
163 void setSubclassData(typename Bitfield::Type Value) {
164 Instruction::setSubclassData<Bitfield>(Value);
165 }
166};
167
168//===----------------------------------------------------------------------===//
169// LoadInst Class
170//===----------------------------------------------------------------------===//
171
172/// An instruction for reading from memory. This uses the SubclassData field in
173/// Value to store whether or not the load is volatile.
174class LoadInst : public UnaryInstruction {
175 using VolatileField = BoolBitfieldElementT<0>;
176 using AlignmentField = AlignmentBitfieldElementT<VolatileField::NextBit>;
177 using OrderingField = AtomicOrderingBitfieldElementT<AlignmentField::NextBit>;
178 static_assert(
179 Bitfield::areContiguous<VolatileField, AlignmentField, OrderingField>(),
180 "Bitfields must be contiguous");
181
182 void AssertOK();
183
184protected:
185 // Note: Instruction needs to be a friend here to call cloneImpl.
186 friend class Instruction;
187
188 LoadInst *cloneImpl() const;
189
190public:
191 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr,
192 Instruction *InsertBefore);
193 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, BasicBlock *InsertAtEnd);
194 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
195 Instruction *InsertBefore);
196 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
197 BasicBlock *InsertAtEnd);
198 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
199 Align Align, Instruction *InsertBefore = nullptr);
200 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
201 Align Align, BasicBlock *InsertAtEnd);
202 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
203 Align Align, AtomicOrdering Order,
204 SyncScope::ID SSID = SyncScope::System,
205 Instruction *InsertBefore = nullptr);
206 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
207 Align Align, AtomicOrdering Order, SyncScope::ID SSID,
208 BasicBlock *InsertAtEnd);
209
210 /// Return true if this is a load from a volatile memory location.
211 bool isVolatile() const { return getSubclassData<VolatileField>(); }
212
213 /// Specify whether this is a volatile load or not.
214 void setVolatile(bool V) { setSubclassData<VolatileField>(V); }
215
216 /// Return the alignment of the access that is being performed.
217 /// FIXME: Remove this function once transition to Align is over.
218 /// Use getAlign() instead.
219 unsigned getAlignment() const { return getAlign().value(); }
220
221 /// Return the alignment of the access that is being performed.
222 Align getAlign() const {
223 return Align(1ULL << (getSubclassData<AlignmentField>()));
224 }
225
226 void setAlignment(Align Align) {
227 setSubclassData<AlignmentField>(Log2(Align));
228 }
229
230 /// Returns the ordering constraint of this load instruction.
231 AtomicOrdering getOrdering() const {
232 return getSubclassData<OrderingField>();
233 }
234 /// Sets the ordering constraint of this load instruction. May not be Release
235 /// or AcquireRelease.
236 void setOrdering(AtomicOrdering Ordering) {
237 setSubclassData<OrderingField>(Ordering);
238 }
239
240 /// Returns the synchronization scope ID of this load instruction.
241 SyncScope::ID getSyncScopeID() const {
242 return SSID;
243 }
244
245 /// Sets the synchronization scope ID of this load instruction.
246 void setSyncScopeID(SyncScope::ID SSID) {
247 this->SSID = SSID;
248 }
249
250 /// Sets the ordering constraint and the synchronization scope ID of this load
251 /// instruction.
252 void setAtomic(AtomicOrdering Ordering,
253 SyncScope::ID SSID = SyncScope::System) {
254 setOrdering(Ordering);
255 setSyncScopeID(SSID);
256 }
257
258 bool isSimple() const { return !isAtomic() && !isVolatile(); }
19
Assuming the condition is true
20
Assuming the condition is true
21
Returning the value 1, which participates in a condition later
259
260 bool isUnordered() const {
261 return (getOrdering() == AtomicOrdering::NotAtomic ||
262 getOrdering() == AtomicOrdering::Unordered) &&
263 !isVolatile();
264 }
265
266 Value *getPointerOperand() { return getOperand(0); }
267 const Value *getPointerOperand() const { return getOperand(0); }
268 static unsigned getPointerOperandIndex() { return 0U; }
269 Type *getPointerOperandType() const { return getPointerOperand()->getType(); }
270
271 /// Returns the address space of the pointer operand.
272 unsigned getPointerAddressSpace() const {
273 return getPointerOperandType()->getPointerAddressSpace();
274 }
275
276 // Methods for support type inquiry through isa, cast, and dyn_cast:
277 static bool classof(const Instruction *I) {
278 return I->getOpcode() == Instruction::Load;
279 }
280 static bool classof(const Value *V) {
281 return isa<Instruction>(V) && classof(cast<Instruction>(V));
282 }
283
284private:
285 // Shadow Instruction::setInstructionSubclassData with a private forwarding
286 // method so that subclasses cannot accidentally use it.
287 template <typename Bitfield>
288 void setSubclassData(typename Bitfield::Type Value) {
289 Instruction::setSubclassData<Bitfield>(Value);
290 }
291
292 /// The synchronization scope ID of this load instruction. Not quite enough
293 /// room in SubClassData for everything, so synchronization scope ID gets its
294 /// own field.
295 SyncScope::ID SSID;
296};
297
298//===----------------------------------------------------------------------===//
299// StoreInst Class
300//===----------------------------------------------------------------------===//
301
302/// An instruction for storing to memory.
303class StoreInst : public Instruction {
304 using VolatileField = BoolBitfieldElementT<0>;
305 using AlignmentField = AlignmentBitfieldElementT<VolatileField::NextBit>;
306 using OrderingField = AtomicOrderingBitfieldElementT<AlignmentField::NextBit>;
307 static_assert(
308 Bitfield::areContiguous<VolatileField, AlignmentField, OrderingField>(),
309 "Bitfields must be contiguous");
310
311 void AssertOK();
312
313protected:
314 // Note: Instruction needs to be a friend here to call cloneImpl.
315 friend class Instruction;
316
317 StoreInst *cloneImpl() const;
318
319public:
320 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
321 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
322 StoreInst(Value *Val, Value *Ptr, bool isVolatile, Instruction *InsertBefore);
323 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
324 StoreInst(Value *Val, Value *Ptr, bool isVolatile, Align Align,
325 Instruction *InsertBefore = nullptr);
326 StoreInst(Value *Val, Value *Ptr, bool isVolatile, Align Align,
327 BasicBlock *InsertAtEnd);
328 StoreInst(Value *Val, Value *Ptr, bool isVolatile, Align Align,
329 AtomicOrdering Order, SyncScope::ID SSID = SyncScope::System,
330 Instruction *InsertBefore = nullptr);
331 StoreInst(Value *Val, Value *Ptr, bool isVolatile, Align Align,
332 AtomicOrdering Order, SyncScope::ID SSID, BasicBlock *InsertAtEnd);
333
334 // allocate space for exactly two operands
335 void *operator new(size_t s) {
336 return User::operator new(s, 2);
337 }
338
339 /// Return true if this is a store to a volatile memory location.
340 bool isVolatile() const { return getSubclassData<VolatileField>(); }
341
342 /// Specify whether this is a volatile store or not.
343 void setVolatile(bool V) { setSubclassData<VolatileField>(V); }
344
345 /// Transparently provide more efficient getOperand methods.
346 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
347
348 /// Return the alignment of the access that is being performed
349 /// FIXME: Remove this function once transition to Align is over.
350 /// Use getAlign() instead.
351 unsigned getAlignment() const { return getAlign().value(); }
352
353 Align getAlign() const {
354 return Align(1ULL << (getSubclassData<AlignmentField>()));
355 }
356
357 void setAlignment(Align Align) {
358 setSubclassData<AlignmentField>(Log2(Align));
359 }
360
361 /// Returns the ordering constraint of this store instruction.
362 AtomicOrdering getOrdering() const {
363 return getSubclassData<OrderingField>();
364 }
365
366 /// Sets the ordering constraint of this store instruction. May not be
367 /// Acquire or AcquireRelease.
368 void setOrdering(AtomicOrdering Ordering) {
369 setSubclassData<OrderingField>(Ordering);
370 }
371
372 /// Returns the synchronization scope ID of this store instruction.
373 SyncScope::ID getSyncScopeID() const {
374 return SSID;
375 }
376
377 /// Sets the synchronization scope ID of this store instruction.
378 void setSyncScopeID(SyncScope::ID SSID) {
379 this->SSID = SSID;
380 }
381
382 /// Sets the ordering constraint and the synchronization scope ID of this
383 /// store instruction.
384 void setAtomic(AtomicOrdering Ordering,
385 SyncScope::ID SSID = SyncScope::System) {
386 setOrdering(Ordering);
387 setSyncScopeID(SSID);
388 }
389
390 bool isSimple() const { return !isAtomic() && !isVolatile(); }
391
392 bool isUnordered() const {
393 return (getOrdering() == AtomicOrdering::NotAtomic ||
394 getOrdering() == AtomicOrdering::Unordered) &&
395 !isVolatile();
396 }
397
398 Value *getValueOperand() { return getOperand(0); }
399 const Value *getValueOperand() const { return getOperand(0); }
400
401 Value *getPointerOperand() { return getOperand(1); }
402 const Value *getPointerOperand() const { return getOperand(1); }
403 static unsigned getPointerOperandIndex() { return 1U; }
404 Type *getPointerOperandType() const { return getPointerOperand()->getType(); }
405
406 /// Returns the address space of the pointer operand.
407 unsigned getPointerAddressSpace() const {
408 return getPointerOperandType()->getPointerAddressSpace();
409 }
410
411 // Methods for support type inquiry through isa, cast, and dyn_cast:
412 static bool classof(const Instruction *I) {
413 return I->getOpcode() == Instruction::Store;
414 }
415 static bool classof(const Value *V) {
416 return isa<Instruction>(V) && classof(cast<Instruction>(V));
417 }
418
419private:
420 // Shadow Instruction::setInstructionSubclassData with a private forwarding
421 // method so that subclasses cannot accidentally use it.
422 template <typename Bitfield>
423 void setSubclassData(typename Bitfield::Type Value) {
424 Instruction::setSubclassData<Bitfield>(Value);
425 }
426
427 /// The synchronization scope ID of this store instruction. Not quite enough
428 /// room in SubClassData for everything, so synchronization scope ID gets its
429 /// own field.
430 SyncScope::ID SSID;
431};
432
433template <>
434struct OperandTraits<StoreInst> : public FixedNumOperandTraits<StoreInst, 2> {
435};
436
437DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)StoreInst::op_iterator StoreInst::op_begin() { return OperandTraits
<StoreInst>::op_begin(this); } StoreInst::const_op_iterator
StoreInst::op_begin() const { return OperandTraits<StoreInst
>::op_begin(const_cast<StoreInst*>(this)); } StoreInst
::op_iterator StoreInst::op_end() { return OperandTraits<StoreInst
>::op_end(this); } StoreInst::const_op_iterator StoreInst::
op_end() const { return OperandTraits<StoreInst>::op_end
(const_cast<StoreInst*>(this)); } Value *StoreInst::getOperand
(unsigned i_nocapture) const { ((i_nocapture < OperandTraits
<StoreInst>::operands(this) && "getOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<StoreInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 437, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<StoreInst>::op_begin(const_cast<StoreInst
*>(this))[i_nocapture].get()); } void StoreInst::setOperand
(unsigned i_nocapture, Value *Val_nocapture) { ((i_nocapture <
OperandTraits<StoreInst>::operands(this) && "setOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<StoreInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 437, __PRETTY_FUNCTION__)); OperandTraits<StoreInst>::
op_begin(this)[i_nocapture] = Val_nocapture; } unsigned StoreInst
::getNumOperands() const { return OperandTraits<StoreInst>
::operands(this); } template <int Idx_nocapture> Use &
StoreInst::Op() { return this->OpFrom<Idx_nocapture>
(this); } template <int Idx_nocapture> const Use &StoreInst
::Op() const { return this->OpFrom<Idx_nocapture>(this
); }
438
439//===----------------------------------------------------------------------===//
440// FenceInst Class
441//===----------------------------------------------------------------------===//
442
443/// An instruction for ordering other memory operations.
444class FenceInst : public Instruction {
445 using OrderingField = AtomicOrderingBitfieldElementT<0>;
446
447 void Init(AtomicOrdering Ordering, SyncScope::ID SSID);
448
449protected:
450 // Note: Instruction needs to be a friend here to call cloneImpl.
451 friend class Instruction;
452
453 FenceInst *cloneImpl() const;
454
455public:
456 // Ordering may only be Acquire, Release, AcquireRelease, or
457 // SequentiallyConsistent.
458 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
459 SyncScope::ID SSID = SyncScope::System,
460 Instruction *InsertBefore = nullptr);
461 FenceInst(LLVMContext &C, AtomicOrdering Ordering, SyncScope::ID SSID,
462 BasicBlock *InsertAtEnd);
463
464 // allocate space for exactly zero operands
465 void *operator new(size_t s) {
466 return User::operator new(s, 0);
467 }
468
469 /// Returns the ordering constraint of this fence instruction.
470 AtomicOrdering getOrdering() const {
471 return getSubclassData<OrderingField>();
472 }
473
474 /// Sets the ordering constraint of this fence instruction. May only be
475 /// Acquire, Release, AcquireRelease, or SequentiallyConsistent.
476 void setOrdering(AtomicOrdering Ordering) {
477 setSubclassData<OrderingField>(Ordering);
478 }
479
480 /// Returns the synchronization scope ID of this fence instruction.
481 SyncScope::ID getSyncScopeID() const {
482 return SSID;
483 }
484
485 /// Sets the synchronization scope ID of this fence instruction.
486 void setSyncScopeID(SyncScope::ID SSID) {
487 this->SSID = SSID;
488 }
489
490 // Methods for support type inquiry through isa, cast, and dyn_cast:
491 static bool classof(const Instruction *I) {
492 return I->getOpcode() == Instruction::Fence;
493 }
494 static bool classof(const Value *V) {
495 return isa<Instruction>(V) && classof(cast<Instruction>(V));
496 }
497
498private:
499 // Shadow Instruction::setInstructionSubclassData with a private forwarding
500 // method so that subclasses cannot accidentally use it.
501 template <typename Bitfield>
502 void setSubclassData(typename Bitfield::Type Value) {
503 Instruction::setSubclassData<Bitfield>(Value);
504 }
505
506 /// The synchronization scope ID of this fence instruction. Not quite enough
507 /// room in SubClassData for everything, so synchronization scope ID gets its
508 /// own field.
509 SyncScope::ID SSID;
510};
511
512//===----------------------------------------------------------------------===//
513// AtomicCmpXchgInst Class
514//===----------------------------------------------------------------------===//
515
516/// An instruction that atomically checks whether a
517/// specified value is in a memory location, and, if it is, stores a new value
518/// there. The value returned by this instruction is a pair containing the
519/// original value as first element, and an i1 indicating success (true) or
520/// failure (false) as second element.
521///
522class AtomicCmpXchgInst : public Instruction {
523 void Init(Value *Ptr, Value *Cmp, Value *NewVal, Align Align,
524 AtomicOrdering SuccessOrdering, AtomicOrdering FailureOrdering,
525 SyncScope::ID SSID);
526
527 template <unsigned Offset>
528 using AtomicOrderingBitfieldElement =
529 typename Bitfield::Element<AtomicOrdering, Offset, 3,
530 AtomicOrdering::LAST>;
531
532protected:
533 // Note: Instruction needs to be a friend here to call cloneImpl.
534 friend class Instruction;
535
536 AtomicCmpXchgInst *cloneImpl() const;
537
538public:
539 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal, Align Alignment,
540 AtomicOrdering SuccessOrdering,
541 AtomicOrdering FailureOrdering, SyncScope::ID SSID,
542 Instruction *InsertBefore = nullptr);
543 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal, Align Alignment,
544 AtomicOrdering SuccessOrdering,
545 AtomicOrdering FailureOrdering, SyncScope::ID SSID,
546 BasicBlock *InsertAtEnd);
547
548 // allocate space for exactly three operands
549 void *operator new(size_t s) {
550 return User::operator new(s, 3);
551 }
552
553 using VolatileField = BoolBitfieldElementT<0>;
554 using WeakField = BoolBitfieldElementT<VolatileField::NextBit>;
555 using SuccessOrderingField =
556 AtomicOrderingBitfieldElementT<WeakField::NextBit>;
557 using FailureOrderingField =
558 AtomicOrderingBitfieldElementT<SuccessOrderingField::NextBit>;
559 using AlignmentField =
560 AlignmentBitfieldElementT<FailureOrderingField::NextBit>;
561 static_assert(
562 Bitfield::areContiguous<VolatileField, WeakField, SuccessOrderingField,
563 FailureOrderingField, AlignmentField>(),
564 "Bitfields must be contiguous");
565
566 /// Return the alignment of the memory that is being allocated by the
567 /// instruction.
568 Align getAlign() const {
569 return Align(1ULL << getSubclassData<AlignmentField>());
570 }
571
572 void setAlignment(Align Align) {
573 setSubclassData<AlignmentField>(Log2(Align));
574 }
575
576 /// Return true if this is a cmpxchg from a volatile memory
577 /// location.
578 ///
579 bool isVolatile() const { return getSubclassData<VolatileField>(); }
580
581 /// Specify whether this is a volatile cmpxchg.
582 ///
583 void setVolatile(bool V) { setSubclassData<VolatileField>(V); }
584
585 /// Return true if this cmpxchg may spuriously fail.
586 bool isWeak() const { return getSubclassData<WeakField>(); }
587
588 void setWeak(bool IsWeak) { setSubclassData<WeakField>(IsWeak); }
589
590 /// Transparently provide more efficient getOperand methods.
591 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
592
593 /// Returns the success ordering constraint of this cmpxchg instruction.
594 AtomicOrdering getSuccessOrdering() const {
595 return getSubclassData<SuccessOrderingField>();
596 }
597
598 /// Sets the success ordering constraint of this cmpxchg instruction.
599 void setSuccessOrdering(AtomicOrdering Ordering) {
600 assert(Ordering != AtomicOrdering::NotAtomic &&((Ordering != AtomicOrdering::NotAtomic && "CmpXchg instructions can only be atomic."
) ? static_cast<void> (0) : __assert_fail ("Ordering != AtomicOrdering::NotAtomic && \"CmpXchg instructions can only be atomic.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 601, __PRETTY_FUNCTION__))
601 "CmpXchg instructions can only be atomic.")((Ordering != AtomicOrdering::NotAtomic && "CmpXchg instructions can only be atomic."
) ? static_cast<void> (0) : __assert_fail ("Ordering != AtomicOrdering::NotAtomic && \"CmpXchg instructions can only be atomic.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 601, __PRETTY_FUNCTION__))
;
602 setSubclassData<SuccessOrderingField>(Ordering);
603 }
604
605 /// Returns the failure ordering constraint of this cmpxchg instruction.
606 AtomicOrdering getFailureOrdering() const {
607 return getSubclassData<FailureOrderingField>();
608 }
609
610 /// Sets the failure ordering constraint of this cmpxchg instruction.
611 void setFailureOrdering(AtomicOrdering Ordering) {
612 assert(Ordering != AtomicOrdering::NotAtomic &&((Ordering != AtomicOrdering::NotAtomic && "CmpXchg instructions can only be atomic."
) ? static_cast<void> (0) : __assert_fail ("Ordering != AtomicOrdering::NotAtomic && \"CmpXchg instructions can only be atomic.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 613, __PRETTY_FUNCTION__))
613 "CmpXchg instructions can only be atomic.")((Ordering != AtomicOrdering::NotAtomic && "CmpXchg instructions can only be atomic."
) ? static_cast<void> (0) : __assert_fail ("Ordering != AtomicOrdering::NotAtomic && \"CmpXchg instructions can only be atomic.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 613, __PRETTY_FUNCTION__))
;
614 setSubclassData<FailureOrderingField>(Ordering);
615 }
616
617 /// Returns the synchronization scope ID of this cmpxchg instruction.
618 SyncScope::ID getSyncScopeID() const {
619 return SSID;
620 }
621
622 /// Sets the synchronization scope ID of this cmpxchg instruction.
623 void setSyncScopeID(SyncScope::ID SSID) {
624 this->SSID = SSID;
625 }
626
627 Value *getPointerOperand() { return getOperand(0); }
628 const Value *getPointerOperand() const { return getOperand(0); }
629 static unsigned getPointerOperandIndex() { return 0U; }
630
631 Value *getCompareOperand() { return getOperand(1); }
632 const Value *getCompareOperand() const { return getOperand(1); }
633
634 Value *getNewValOperand() { return getOperand(2); }
635 const Value *getNewValOperand() const { return getOperand(2); }
636
637 /// Returns the address space of the pointer operand.
638 unsigned getPointerAddressSpace() const {
639 return getPointerOperand()->getType()->getPointerAddressSpace();
640 }
641
642 /// Returns the strongest permitted ordering on failure, given the
643 /// desired ordering on success.
644 ///
645 /// If the comparison in a cmpxchg operation fails, there is no atomic store
646 /// so release semantics cannot be provided. So this function drops explicit
647 /// Release requests from the AtomicOrdering. A SequentiallyConsistent
648 /// operation would remain SequentiallyConsistent.
649 static AtomicOrdering
650 getStrongestFailureOrdering(AtomicOrdering SuccessOrdering) {
651 switch (SuccessOrdering) {
652 default:
653 llvm_unreachable("invalid cmpxchg success ordering")::llvm::llvm_unreachable_internal("invalid cmpxchg success ordering"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 653)
;
654 case AtomicOrdering::Release:
655 case AtomicOrdering::Monotonic:
656 return AtomicOrdering::Monotonic;
657 case AtomicOrdering::AcquireRelease:
658 case AtomicOrdering::Acquire:
659 return AtomicOrdering::Acquire;
660 case AtomicOrdering::SequentiallyConsistent:
661 return AtomicOrdering::SequentiallyConsistent;
662 }
663 }
664
665 // Methods for support type inquiry through isa, cast, and dyn_cast:
666 static bool classof(const Instruction *I) {
667 return I->getOpcode() == Instruction::AtomicCmpXchg;
668 }
669 static bool classof(const Value *V) {
670 return isa<Instruction>(V) && classof(cast<Instruction>(V));
671 }
672
673private:
674 // Shadow Instruction::setInstructionSubclassData with a private forwarding
675 // method so that subclasses cannot accidentally use it.
676 template <typename Bitfield>
677 void setSubclassData(typename Bitfield::Type Value) {
678 Instruction::setSubclassData<Bitfield>(Value);
679 }
680
681 /// The synchronization scope ID of this cmpxchg instruction. Not quite
682 /// enough room in SubClassData for everything, so synchronization scope ID
683 /// gets its own field.
684 SyncScope::ID SSID;
685};
686
687template <>
688struct OperandTraits<AtomicCmpXchgInst> :
689 public FixedNumOperandTraits<AtomicCmpXchgInst, 3> {
690};
691
692DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicCmpXchgInst, Value)AtomicCmpXchgInst::op_iterator AtomicCmpXchgInst::op_begin() {
return OperandTraits<AtomicCmpXchgInst>::op_begin(this
); } AtomicCmpXchgInst::const_op_iterator AtomicCmpXchgInst::
op_begin() const { return OperandTraits<AtomicCmpXchgInst>
::op_begin(const_cast<AtomicCmpXchgInst*>(this)); } AtomicCmpXchgInst
::op_iterator AtomicCmpXchgInst::op_end() { return OperandTraits
<AtomicCmpXchgInst>::op_end(this); } AtomicCmpXchgInst::
const_op_iterator AtomicCmpXchgInst::op_end() const { return OperandTraits
<AtomicCmpXchgInst>::op_end(const_cast<AtomicCmpXchgInst
*>(this)); } Value *AtomicCmpXchgInst::getOperand(unsigned
i_nocapture) const { ((i_nocapture < OperandTraits<AtomicCmpXchgInst
>::operands(this) && "getOperand() out of range!")
? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<AtomicCmpXchgInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 692, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<AtomicCmpXchgInst>::op_begin(const_cast
<AtomicCmpXchgInst*>(this))[i_nocapture].get()); } void
AtomicCmpXchgInst::setOperand(unsigned i_nocapture, Value *Val_nocapture
) { ((i_nocapture < OperandTraits<AtomicCmpXchgInst>
::operands(this) && "setOperand() out of range!") ? static_cast
<void> (0) : __assert_fail ("i_nocapture < OperandTraits<AtomicCmpXchgInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 692, __PRETTY_FUNCTION__)); OperandTraits<AtomicCmpXchgInst
>::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned
AtomicCmpXchgInst::getNumOperands() const { return OperandTraits
<AtomicCmpXchgInst>::operands(this); } template <int
Idx_nocapture> Use &AtomicCmpXchgInst::Op() { return this
->OpFrom<Idx_nocapture>(this); } template <int Idx_nocapture
> const Use &AtomicCmpXchgInst::Op() const { return this
->OpFrom<Idx_nocapture>(this); }
693
694//===----------------------------------------------------------------------===//
695// AtomicRMWInst Class
696//===----------------------------------------------------------------------===//
697
698/// an instruction that atomically reads a memory location,
699/// combines it with another value, and then stores the result back. Returns
700/// the old value.
701///
702class AtomicRMWInst : public Instruction {
703protected:
704 // Note: Instruction needs to be a friend here to call cloneImpl.
705 friend class Instruction;
706
707 AtomicRMWInst *cloneImpl() const;
708
709public:
710 /// This enumeration lists the possible modifications atomicrmw can make. In
711 /// the descriptions, 'p' is the pointer to the instruction's memory location,
712 /// 'old' is the initial value of *p, and 'v' is the other value passed to the
713 /// instruction. These instructions always return 'old'.
714 enum BinOp : unsigned {
715 /// *p = v
716 Xchg,
717 /// *p = old + v
718 Add,
719 /// *p = old - v
720 Sub,
721 /// *p = old & v
722 And,
723 /// *p = ~(old & v)
724 Nand,
725 /// *p = old | v
726 Or,
727 /// *p = old ^ v
728 Xor,
729 /// *p = old >signed v ? old : v
730 Max,
731 /// *p = old <signed v ? old : v
732 Min,
733 /// *p = old >unsigned v ? old : v
734 UMax,
735 /// *p = old <unsigned v ? old : v
736 UMin,
737
738 /// *p = old + v
739 FAdd,
740
741 /// *p = old - v
742 FSub,
743
744 FIRST_BINOP = Xchg,
745 LAST_BINOP = FSub,
746 BAD_BINOP
747 };
748
749private:
750 template <unsigned Offset>
751 using AtomicOrderingBitfieldElement =
752 typename Bitfield::Element<AtomicOrdering, Offset, 3,
753 AtomicOrdering::LAST>;
754
755 template <unsigned Offset>
756 using BinOpBitfieldElement =
757 typename Bitfield::Element<BinOp, Offset, 4, BinOp::LAST_BINOP>;
758
759public:
760 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val, Align Alignment,
761 AtomicOrdering Ordering, SyncScope::ID SSID,
762 Instruction *InsertBefore = nullptr);
763 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val, Align Alignment,
764 AtomicOrdering Ordering, SyncScope::ID SSID,
765 BasicBlock *InsertAtEnd);
766
767 // allocate space for exactly two operands
768 void *operator new(size_t s) {
769 return User::operator new(s, 2);
770 }
771
772 using VolatileField = BoolBitfieldElementT<0>;
773 using AtomicOrderingField =
774 AtomicOrderingBitfieldElementT<VolatileField::NextBit>;
775 using OperationField = BinOpBitfieldElement<AtomicOrderingField::NextBit>;
776 using AlignmentField = AlignmentBitfieldElementT<OperationField::NextBit>;
777 static_assert(Bitfield::areContiguous<VolatileField, AtomicOrderingField,
778 OperationField, AlignmentField>(),
779 "Bitfields must be contiguous");
780
781 BinOp getOperation() const { return getSubclassData<OperationField>(); }
782
783 static StringRef getOperationName(BinOp Op);
784
785 static bool isFPOperation(BinOp Op) {
786 switch (Op) {
787 case AtomicRMWInst::FAdd:
788 case AtomicRMWInst::FSub:
789 return true;
790 default:
791 return false;
792 }
793 }
794
795 void setOperation(BinOp Operation) {
796 setSubclassData<OperationField>(Operation);
797 }
798
799 /// Return the alignment of the memory that is being allocated by the
800 /// instruction.
801 Align getAlign() const {
802 return Align(1ULL << getSubclassData<AlignmentField>());
803 }
804
805 void setAlignment(Align Align) {
806 setSubclassData<AlignmentField>(Log2(Align));
807 }
808
809 /// Return true if this is a RMW on a volatile memory location.
810 ///
811 bool isVolatile() const { return getSubclassData<VolatileField>(); }
812
813 /// Specify whether this is a volatile RMW or not.
814 ///
815 void setVolatile(bool V) { setSubclassData<VolatileField>(V); }
816
817 /// Transparently provide more efficient getOperand methods.
818 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
819
820 /// Returns the ordering constraint of this rmw instruction.
821 AtomicOrdering getOrdering() const {
822 return getSubclassData<AtomicOrderingField>();
823 }
824
825 /// Sets the ordering constraint of this rmw instruction.
826 void setOrdering(AtomicOrdering Ordering) {
827 assert(Ordering != AtomicOrdering::NotAtomic &&((Ordering != AtomicOrdering::NotAtomic && "atomicrmw instructions can only be atomic."
) ? static_cast<void> (0) : __assert_fail ("Ordering != AtomicOrdering::NotAtomic && \"atomicrmw instructions can only be atomic.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 828, __PRETTY_FUNCTION__))
828 "atomicrmw instructions can only be atomic.")((Ordering != AtomicOrdering::NotAtomic && "atomicrmw instructions can only be atomic."
) ? static_cast<void> (0) : __assert_fail ("Ordering != AtomicOrdering::NotAtomic && \"atomicrmw instructions can only be atomic.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 828, __PRETTY_FUNCTION__))
;
829 setSubclassData<AtomicOrderingField>(Ordering);
830 }
831
832 /// Returns the synchronization scope ID of this rmw instruction.
833 SyncScope::ID getSyncScopeID() const {
834 return SSID;
835 }
836
837 /// Sets the synchronization scope ID of this rmw instruction.
838 void setSyncScopeID(SyncScope::ID SSID) {
839 this->SSID = SSID;
840 }
841
842 Value *getPointerOperand() { return getOperand(0); }
843 const Value *getPointerOperand() const { return getOperand(0); }
844 static unsigned getPointerOperandIndex() { return 0U; }
845
846 Value *getValOperand() { return getOperand(1); }
847 const Value *getValOperand() const { return getOperand(1); }
848
849 /// Returns the address space of the pointer operand.
850 unsigned getPointerAddressSpace() const {
851 return getPointerOperand()->getType()->getPointerAddressSpace();
852 }
853
854 bool isFloatingPointOperation() const {
855 return isFPOperation(getOperation());
856 }
857
858 // Methods for support type inquiry through isa, cast, and dyn_cast:
859 static bool classof(const Instruction *I) {
860 return I->getOpcode() == Instruction::AtomicRMW;
861 }
862 static bool classof(const Value *V) {
863 return isa<Instruction>(V) && classof(cast<Instruction>(V));
864 }
865
866private:
867 void Init(BinOp Operation, Value *Ptr, Value *Val, Align Align,
868 AtomicOrdering Ordering, SyncScope::ID SSID);
869
870 // Shadow Instruction::setInstructionSubclassData with a private forwarding
871 // method so that subclasses cannot accidentally use it.
872 template <typename Bitfield>
873 void setSubclassData(typename Bitfield::Type Value) {
874 Instruction::setSubclassData<Bitfield>(Value);
875 }
876
877 /// The synchronization scope ID of this rmw instruction. Not quite enough
878 /// room in SubClassData for everything, so synchronization scope ID gets its
879 /// own field.
880 SyncScope::ID SSID;
881};
882
883template <>
884struct OperandTraits<AtomicRMWInst>
885 : public FixedNumOperandTraits<AtomicRMWInst,2> {
886};
887
888DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicRMWInst, Value)AtomicRMWInst::op_iterator AtomicRMWInst::op_begin() { return
OperandTraits<AtomicRMWInst>::op_begin(this); } AtomicRMWInst
::const_op_iterator AtomicRMWInst::op_begin() const { return OperandTraits
<AtomicRMWInst>::op_begin(const_cast<AtomicRMWInst*>
(this)); } AtomicRMWInst::op_iterator AtomicRMWInst::op_end()
{ return OperandTraits<AtomicRMWInst>::op_end(this); }
AtomicRMWInst::const_op_iterator AtomicRMWInst::op_end() const
{ return OperandTraits<AtomicRMWInst>::op_end(const_cast
<AtomicRMWInst*>(this)); } Value *AtomicRMWInst::getOperand
(unsigned i_nocapture) const { ((i_nocapture < OperandTraits
<AtomicRMWInst>::operands(this) && "getOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<AtomicRMWInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 888, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<AtomicRMWInst>::op_begin(const_cast<
AtomicRMWInst*>(this))[i_nocapture].get()); } void AtomicRMWInst
::setOperand(unsigned i_nocapture, Value *Val_nocapture) { ((
i_nocapture < OperandTraits<AtomicRMWInst>::operands
(this) && "setOperand() out of range!") ? static_cast
<void> (0) : __assert_fail ("i_nocapture < OperandTraits<AtomicRMWInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 888, __PRETTY_FUNCTION__)); OperandTraits<AtomicRMWInst>
::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned AtomicRMWInst
::getNumOperands() const { return OperandTraits<AtomicRMWInst
>::operands(this); } template <int Idx_nocapture> Use
&AtomicRMWInst::Op() { return this->OpFrom<Idx_nocapture
>(this); } template <int Idx_nocapture> const Use &
AtomicRMWInst::Op() const { return this->OpFrom<Idx_nocapture
>(this); }
889
890//===----------------------------------------------------------------------===//
891// GetElementPtrInst Class
892//===----------------------------------------------------------------------===//
893
894// checkGEPType - Simple wrapper function to give a better assertion failure
895// message on bad indexes for a gep instruction.
896//
897inline Type *checkGEPType(Type *Ty) {
898 assert(Ty && "Invalid GetElementPtrInst indices for type!")((Ty && "Invalid GetElementPtrInst indices for type!"
) ? static_cast<void> (0) : __assert_fail ("Ty && \"Invalid GetElementPtrInst indices for type!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 898, __PRETTY_FUNCTION__))
;
899 return Ty;
900}
901
902/// an instruction for type-safe pointer arithmetic to
903/// access elements of arrays and structs
904///
905class GetElementPtrInst : public Instruction {
906 Type *SourceElementType;
907 Type *ResultElementType;
908
909 GetElementPtrInst(const GetElementPtrInst &GEPI);
910
911 /// Constructors - Create a getelementptr instruction with a base pointer an
912 /// list of indices. The first ctor can optionally insert before an existing
913 /// instruction, the second appends the new instruction to the specified
914 /// BasicBlock.
915 inline GetElementPtrInst(Type *PointeeType, Value *Ptr,
916 ArrayRef<Value *> IdxList, unsigned Values,
917 const Twine &NameStr, Instruction *InsertBefore);
918 inline GetElementPtrInst(Type *PointeeType, Value *Ptr,
919 ArrayRef<Value *> IdxList, unsigned Values,
920 const Twine &NameStr, BasicBlock *InsertAtEnd);
921
922 void init(Value *Ptr, ArrayRef<Value *> IdxList, const Twine &NameStr);
923
924protected:
925 // Note: Instruction needs to be a friend here to call cloneImpl.
926 friend class Instruction;
927
928 GetElementPtrInst *cloneImpl() const;
929
930public:
931 static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr,
932 ArrayRef<Value *> IdxList,
933 const Twine &NameStr = "",
934 Instruction *InsertBefore = nullptr) {
935 unsigned Values = 1 + unsigned(IdxList.size());
936 if (!PointeeType)
937 PointeeType =
938 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType();
939 else
940 assert(((PointeeType == cast<PointerType>(Ptr->getType()->
getScalarType())->getElementType()) ? static_cast<void>
(0) : __assert_fail ("PointeeType == cast<PointerType>(Ptr->getType()->getScalarType())->getElementType()"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 942, __PRETTY_FUNCTION__))
941 PointeeType ==((PointeeType == cast<PointerType>(Ptr->getType()->
getScalarType())->getElementType()) ? static_cast<void>
(0) : __assert_fail ("PointeeType == cast<PointerType>(Ptr->getType()->getScalarType())->getElementType()"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 942, __PRETTY_FUNCTION__))
942 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType())((PointeeType == cast<PointerType>(Ptr->getType()->
getScalarType())->getElementType()) ? static_cast<void>
(0) : __assert_fail ("PointeeType == cast<PointerType>(Ptr->getType()->getScalarType())->getElementType()"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 942, __PRETTY_FUNCTION__))
;
943 return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values,
944 NameStr, InsertBefore);
945 }
946
947 static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr,
948 ArrayRef<Value *> IdxList,
949 const Twine &NameStr,
950 BasicBlock *InsertAtEnd) {
951 unsigned Values = 1 + unsigned(IdxList.size());
952 if (!PointeeType)
953 PointeeType =
954 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType();
955 else
956 assert(((PointeeType == cast<PointerType>(Ptr->getType()->
getScalarType())->getElementType()) ? static_cast<void>
(0) : __assert_fail ("PointeeType == cast<PointerType>(Ptr->getType()->getScalarType())->getElementType()"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 958, __PRETTY_FUNCTION__))
957 PointeeType ==((PointeeType == cast<PointerType>(Ptr->getType()->
getScalarType())->getElementType()) ? static_cast<void>
(0) : __assert_fail ("PointeeType == cast<PointerType>(Ptr->getType()->getScalarType())->getElementType()"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 958, __PRETTY_FUNCTION__))
958 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType())((PointeeType == cast<PointerType>(Ptr->getType()->
getScalarType())->getElementType()) ? static_cast<void>
(0) : __assert_fail ("PointeeType == cast<PointerType>(Ptr->getType()->getScalarType())->getElementType()"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 958, __PRETTY_FUNCTION__))
;
959 return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values,
960 NameStr, InsertAtEnd);
961 }
962
963 /// Create an "inbounds" getelementptr. See the documentation for the
964 /// "inbounds" flag in LangRef.html for details.
965 static GetElementPtrInst *CreateInBounds(Value *Ptr,
966 ArrayRef<Value *> IdxList,
967 const Twine &NameStr = "",
968 Instruction *InsertBefore = nullptr){
969 return CreateInBounds(nullptr, Ptr, IdxList, NameStr, InsertBefore);
970 }
971
972 static GetElementPtrInst *
973 CreateInBounds(Type *PointeeType, Value *Ptr, ArrayRef<Value *> IdxList,
974 const Twine &NameStr = "",
975 Instruction *InsertBefore = nullptr) {
976 GetElementPtrInst *GEP =
977 Create(PointeeType, Ptr, IdxList, NameStr, InsertBefore);
978 GEP->setIsInBounds(true);
979 return GEP;
980 }
981
982 static GetElementPtrInst *CreateInBounds(Value *Ptr,
983 ArrayRef<Value *> IdxList,
984 const Twine &NameStr,
985 BasicBlock *InsertAtEnd) {
986 return CreateInBounds(nullptr, Ptr, IdxList, NameStr, InsertAtEnd);
987 }
988
989 static GetElementPtrInst *CreateInBounds(Type *PointeeType, Value *Ptr,
990 ArrayRef<Value *> IdxList,
991 const Twine &NameStr,
992 BasicBlock *InsertAtEnd) {
993 GetElementPtrInst *GEP =
994 Create(PointeeType, Ptr, IdxList, NameStr, InsertAtEnd);
995 GEP->setIsInBounds(true);
996 return GEP;
997 }
998
999 /// Transparently provide more efficient getOperand methods.
1000 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
1001
1002 Type *getSourceElementType() const { return SourceElementType; }
1003
1004 void setSourceElementType(Type *Ty) { SourceElementType = Ty; }
1005 void setResultElementType(Type *Ty) { ResultElementType = Ty; }
1006
1007 Type *getResultElementType() const {
1008 assert(ResultElementType ==((ResultElementType == cast<PointerType>(getType()->
getScalarType())->getElementType()) ? static_cast<void>
(0) : __assert_fail ("ResultElementType == cast<PointerType>(getType()->getScalarType())->getElementType()"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1009, __PRETTY_FUNCTION__))
1009 cast<PointerType>(getType()->getScalarType())->getElementType())((ResultElementType == cast<PointerType>(getType()->
getScalarType())->getElementType()) ? static_cast<void>
(0) : __assert_fail ("ResultElementType == cast<PointerType>(getType()->getScalarType())->getElementType()"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1009, __PRETTY_FUNCTION__))
;
1010 return ResultElementType;
1011 }
1012
1013 /// Returns the address space of this instruction's pointer type.
1014 unsigned getAddressSpace() const {
1015 // Note that this is always the same as the pointer operand's address space
1016 // and that is cheaper to compute, so cheat here.
1017 return getPointerAddressSpace();
1018 }
1019
1020 /// Returns the result type of a getelementptr with the given source
1021 /// element type and indexes.
1022 ///
1023 /// Null is returned if the indices are invalid for the specified
1024 /// source element type.
1025 static Type *getIndexedType(Type *Ty, ArrayRef<Value *> IdxList);
1026 static Type *getIndexedType(Type *Ty, ArrayRef<Constant *> IdxList);
1027 static Type *getIndexedType(Type *Ty, ArrayRef<uint64_t> IdxList);
1028
1029 /// Return the type of the element at the given index of an indexable
1030 /// type. This is equivalent to "getIndexedType(Agg, {Zero, Idx})".
1031 ///
1032 /// Returns null if the type can't be indexed, or the given index is not
1033 /// legal for the given type.
1034 static Type *getTypeAtIndex(Type *Ty, Value *Idx);
1035 static Type *getTypeAtIndex(Type *Ty, uint64_t Idx);
1036
1037 inline op_iterator idx_begin() { return op_begin()+1; }
1038 inline const_op_iterator idx_begin() const { return op_begin()+1; }
1039 inline op_iterator idx_end() { return op_end(); }
1040 inline const_op_iterator idx_end() const { return op_end(); }
1041
1042 inline iterator_range<op_iterator> indices() {
1043 return make_range(idx_begin(), idx_end());
1044 }
1045
1046 inline iterator_range<const_op_iterator> indices() const {
1047 return make_range(idx_begin(), idx_end());
1048 }
1049
1050 Value *getPointerOperand() {
1051 return getOperand(0);
1052 }
1053 const Value *getPointerOperand() const {
1054 return getOperand(0);
1055 }
1056 static unsigned getPointerOperandIndex() {
1057 return 0U; // get index for modifying correct operand.
1058 }
1059
1060 /// Method to return the pointer operand as a
1061 /// PointerType.
1062 Type *getPointerOperandType() const {
1063 return getPointerOperand()->getType();
1064 }
1065
1066 /// Returns the address space of the pointer operand.
1067 unsigned getPointerAddressSpace() const {
1068 return getPointerOperandType()->getPointerAddressSpace();
1069 }
1070
1071 /// Returns the pointer type returned by the GEP
1072 /// instruction, which may be a vector of pointers.
1073 static Type *getGEPReturnType(Type *ElTy, Value *Ptr,
1074 ArrayRef<Value *> IdxList) {
1075 Type *PtrTy = PointerType::get(checkGEPType(getIndexedType(ElTy, IdxList)),
1076 Ptr->getType()->getPointerAddressSpace());
1077 // Vector GEP
1078 if (auto *PtrVTy = dyn_cast<VectorType>(Ptr->getType())) {
1079 ElementCount EltCount = PtrVTy->getElementCount();
1080 return VectorType::get(PtrTy, EltCount);
1081 }
1082 for (Value *Index : IdxList)
1083 if (auto *IndexVTy = dyn_cast<VectorType>(Index->getType())) {
1084 ElementCount EltCount = IndexVTy->getElementCount();
1085 return VectorType::get(PtrTy, EltCount);
1086 }
1087 // Scalar GEP
1088 return PtrTy;
1089 }
1090
1091 unsigned getNumIndices() const { // Note: always non-negative
1092 return getNumOperands() - 1;
1093 }
1094
1095 bool hasIndices() const {
1096 return getNumOperands() > 1;
1097 }
1098
1099 /// Return true if all of the indices of this GEP are
1100 /// zeros. If so, the result pointer and the first operand have the same
1101 /// value, just potentially different types.
1102 bool hasAllZeroIndices() const;
1103
1104 /// Return true if all of the indices of this GEP are
1105 /// constant integers. If so, the result pointer and the first operand have
1106 /// a constant offset between them.
1107 bool hasAllConstantIndices() const;
1108
1109 /// Set or clear the inbounds flag on this GEP instruction.
1110 /// See LangRef.html for the meaning of inbounds on a getelementptr.
1111 void setIsInBounds(bool b = true);
1112
1113 /// Determine whether the GEP has the inbounds flag.
1114 bool isInBounds() const;
1115
1116 /// Accumulate the constant address offset of this GEP if possible.
1117 ///
1118 /// This routine accepts an APInt into which it will accumulate the constant
1119 /// offset of this GEP if the GEP is in fact constant. If the GEP is not
1120 /// all-constant, it returns false and the value of the offset APInt is
1121 /// undefined (it is *not* preserved!). The APInt passed into this routine
1122 /// must be at least as wide as the IntPtr type for the address space of
1123 /// the base GEP pointer.
1124 bool accumulateConstantOffset(const DataLayout &DL, APInt &Offset) const;
1125
1126 // Methods for support type inquiry through isa, cast, and dyn_cast:
1127 static bool classof(const Instruction *I) {
1128 return (I->getOpcode() == Instruction::GetElementPtr);
1129 }
1130 static bool classof(const Value *V) {
1131 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1132 }
1133};
1134
1135template <>
1136struct OperandTraits<GetElementPtrInst> :
1137 public VariadicOperandTraits<GetElementPtrInst, 1> {
1138};
1139
1140GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr,
1141 ArrayRef<Value *> IdxList, unsigned Values,
1142 const Twine &NameStr,
1143 Instruction *InsertBefore)
1144 : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr,
1145 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
1146 Values, InsertBefore),
1147 SourceElementType(PointeeType),
1148 ResultElementType(getIndexedType(PointeeType, IdxList)) {
1149 assert(ResultElementType ==((ResultElementType == cast<PointerType>(getType()->
getScalarType())->getElementType()) ? static_cast<void>
(0) : __assert_fail ("ResultElementType == cast<PointerType>(getType()->getScalarType())->getElementType()"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1150, __PRETTY_FUNCTION__))
1150 cast<PointerType>(getType()->getScalarType())->getElementType())((ResultElementType == cast<PointerType>(getType()->
getScalarType())->getElementType()) ? static_cast<void>
(0) : __assert_fail ("ResultElementType == cast<PointerType>(getType()->getScalarType())->getElementType()"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1150, __PRETTY_FUNCTION__))
;
1151 init(Ptr, IdxList, NameStr);
1152}
1153
1154GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr,
1155 ArrayRef<Value *> IdxList, unsigned Values,
1156 const Twine &NameStr,
1157 BasicBlock *InsertAtEnd)
1158 : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr,
1159 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
1160 Values, InsertAtEnd),
1161 SourceElementType(PointeeType),
1162 ResultElementType(getIndexedType(PointeeType, IdxList)) {
1163 assert(ResultElementType ==((ResultElementType == cast<PointerType>(getType()->
getScalarType())->getElementType()) ? static_cast<void>
(0) : __assert_fail ("ResultElementType == cast<PointerType>(getType()->getScalarType())->getElementType()"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1164, __PRETTY_FUNCTION__))
1164 cast<PointerType>(getType()->getScalarType())->getElementType())((ResultElementType == cast<PointerType>(getType()->
getScalarType())->getElementType()) ? static_cast<void>
(0) : __assert_fail ("ResultElementType == cast<PointerType>(getType()->getScalarType())->getElementType()"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1164, __PRETTY_FUNCTION__))
;
1165 init(Ptr, IdxList, NameStr);
1166}
1167
1168DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)GetElementPtrInst::op_iterator GetElementPtrInst::op_begin() {
return OperandTraits<GetElementPtrInst>::op_begin(this
); } GetElementPtrInst::const_op_iterator GetElementPtrInst::
op_begin() const { return OperandTraits<GetElementPtrInst>
::op_begin(const_cast<GetElementPtrInst*>(this)); } GetElementPtrInst
::op_iterator GetElementPtrInst::op_end() { return OperandTraits
<GetElementPtrInst>::op_end(this); } GetElementPtrInst::
const_op_iterator GetElementPtrInst::op_end() const { return OperandTraits
<GetElementPtrInst>::op_end(const_cast<GetElementPtrInst
*>(this)); } Value *GetElementPtrInst::getOperand(unsigned
i_nocapture) const { ((i_nocapture < OperandTraits<GetElementPtrInst
>::operands(this) && "getOperand() out of range!")
? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<GetElementPtrInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1168, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<GetElementPtrInst>::op_begin(const_cast
<GetElementPtrInst*>(this))[i_nocapture].get()); } void
GetElementPtrInst::setOperand(unsigned i_nocapture, Value *Val_nocapture
) { ((i_nocapture < OperandTraits<GetElementPtrInst>
::operands(this) && "setOperand() out of range!") ? static_cast
<void> (0) : __assert_fail ("i_nocapture < OperandTraits<GetElementPtrInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1168, __PRETTY_FUNCTION__)); OperandTraits<GetElementPtrInst
>::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned
GetElementPtrInst::getNumOperands() const { return OperandTraits
<GetElementPtrInst>::operands(this); } template <int
Idx_nocapture> Use &GetElementPtrInst::Op() { return this
->OpFrom<Idx_nocapture>(this); } template <int Idx_nocapture
> const Use &GetElementPtrInst::Op() const { return this
->OpFrom<Idx_nocapture>(this); }
1169
1170//===----------------------------------------------------------------------===//
1171// ICmpInst Class
1172//===----------------------------------------------------------------------===//
1173
1174/// This instruction compares its operands according to the predicate given
1175/// to the constructor. It only operates on integers or pointers. The operands
1176/// must be identical types.
1177/// Represent an integer comparison operator.
1178class ICmpInst: public CmpInst {
1179 void AssertOK() {
1180 assert(isIntPredicate() &&((isIntPredicate() && "Invalid ICmp predicate value")
? static_cast<void> (0) : __assert_fail ("isIntPredicate() && \"Invalid ICmp predicate value\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1181, __PRETTY_FUNCTION__))
1181 "Invalid ICmp predicate value")((isIntPredicate() && "Invalid ICmp predicate value")
? static_cast<void> (0) : __assert_fail ("isIntPredicate() && \"Invalid ICmp predicate value\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1181, __PRETTY_FUNCTION__))
;
1182 assert(getOperand(0)->getType() == getOperand(1)->getType() &&((getOperand(0)->getType() == getOperand(1)->getType() &&
"Both operands to ICmp instruction are not of the same type!"
) ? static_cast<void> (0) : __assert_fail ("getOperand(0)->getType() == getOperand(1)->getType() && \"Both operands to ICmp instruction are not of the same type!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1183, __PRETTY_FUNCTION__))
1183 "Both operands to ICmp instruction are not of the same type!")((getOperand(0)->getType() == getOperand(1)->getType() &&
"Both operands to ICmp instruction are not of the same type!"
) ? static_cast<void> (0) : __assert_fail ("getOperand(0)->getType() == getOperand(1)->getType() && \"Both operands to ICmp instruction are not of the same type!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1183, __PRETTY_FUNCTION__))
;
1184 // Check that the operands are the right type
1185 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||(((getOperand(0)->getType()->isIntOrIntVectorTy() || getOperand
(0)->getType()->isPtrOrPtrVectorTy()) && "Invalid operand types for ICmp instruction"
) ? static_cast<void> (0) : __assert_fail ("(getOperand(0)->getType()->isIntOrIntVectorTy() || getOperand(0)->getType()->isPtrOrPtrVectorTy()) && \"Invalid operand types for ICmp instruction\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1187, __PRETTY_FUNCTION__))
1186 getOperand(0)->getType()->isPtrOrPtrVectorTy()) &&(((getOperand(0)->getType()->isIntOrIntVectorTy() || getOperand
(0)->getType()->isPtrOrPtrVectorTy()) && "Invalid operand types for ICmp instruction"
) ? static_cast<void> (0) : __assert_fail ("(getOperand(0)->getType()->isIntOrIntVectorTy() || getOperand(0)->getType()->isPtrOrPtrVectorTy()) && \"Invalid operand types for ICmp instruction\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1187, __PRETTY_FUNCTION__))
1187 "Invalid operand types for ICmp instruction")(((getOperand(0)->getType()->isIntOrIntVectorTy() || getOperand
(0)->getType()->isPtrOrPtrVectorTy()) && "Invalid operand types for ICmp instruction"
) ? static_cast<void> (0) : __assert_fail ("(getOperand(0)->getType()->isIntOrIntVectorTy() || getOperand(0)->getType()->isPtrOrPtrVectorTy()) && \"Invalid operand types for ICmp instruction\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1187, __PRETTY_FUNCTION__))
;
1188 }
1189
1190protected:
1191 // Note: Instruction needs to be a friend here to call cloneImpl.
1192 friend class Instruction;
1193
1194 /// Clone an identical ICmpInst
1195 ICmpInst *cloneImpl() const;
1196
1197public:
1198 /// Constructor with insert-before-instruction semantics.
1199 ICmpInst(
1200 Instruction *InsertBefore, ///< Where to insert
1201 Predicate pred, ///< The predicate to use for the comparison
1202 Value *LHS, ///< The left-hand-side of the expression
1203 Value *RHS, ///< The right-hand-side of the expression
1204 const Twine &NameStr = "" ///< Name of the instruction
1205 ) : CmpInst(makeCmpResultType(LHS->getType()),
1206 Instruction::ICmp, pred, LHS, RHS, NameStr,
1207 InsertBefore) {
1208#ifndef NDEBUG
1209 AssertOK();
1210#endif
1211 }
1212
1213 /// Constructor with insert-at-end semantics.
1214 ICmpInst(
1215 BasicBlock &InsertAtEnd, ///< Block to insert into.
1216 Predicate pred, ///< The predicate to use for the comparison
1217 Value *LHS, ///< The left-hand-side of the expression
1218 Value *RHS, ///< The right-hand-side of the expression
1219 const Twine &NameStr = "" ///< Name of the instruction
1220 ) : CmpInst(makeCmpResultType(LHS->getType()),
1221 Instruction::ICmp, pred, LHS, RHS, NameStr,
1222 &InsertAtEnd) {
1223#ifndef NDEBUG
1224 AssertOK();
1225#endif
1226 }
1227
1228 /// Constructor with no-insertion semantics
1229 ICmpInst(
1230 Predicate pred, ///< The predicate to use for the comparison
1231 Value *LHS, ///< The left-hand-side of the expression
1232 Value *RHS, ///< The right-hand-side of the expression
1233 const Twine &NameStr = "" ///< Name of the instruction
1234 ) : CmpInst(makeCmpResultType(LHS->getType()),
1235 Instruction::ICmp, pred, LHS, RHS, NameStr) {
1236#ifndef NDEBUG
1237 AssertOK();
1238#endif
1239 }
1240
1241 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
1242 /// @returns the predicate that would be the result if the operand were
1243 /// regarded as signed.
1244 /// Return the signed version of the predicate
1245 Predicate getSignedPredicate() const {
1246 return getSignedPredicate(getPredicate());
1247 }
1248
1249 /// This is a static version that you can use without an instruction.
1250 /// Return the signed version of the predicate.
1251 static Predicate getSignedPredicate(Predicate pred);
1252
1253 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
1254 /// @returns the predicate that would be the result if the operand were
1255 /// regarded as unsigned.
1256 /// Return the unsigned version of the predicate
1257 Predicate getUnsignedPredicate() const {
1258 return getUnsignedPredicate(getPredicate());
1259 }
1260
1261 /// This is a static version that you can use without an instruction.
1262 /// Return the unsigned version of the predicate.
1263 static Predicate getUnsignedPredicate(Predicate pred);
1264
1265 /// Return true if this predicate is either EQ or NE. This also
1266 /// tests for commutativity.
1267 static bool isEquality(Predicate P) {
1268 return P == ICMP_EQ || P == ICMP_NE;
1269 }
1270
1271 /// Return true if this predicate is either EQ or NE. This also
1272 /// tests for commutativity.
1273 bool isEquality() const {
1274 return isEquality(getPredicate());
1275 }
1276
1277 /// @returns true if the predicate of this ICmpInst is commutative
1278 /// Determine if this relation is commutative.
1279 bool isCommutative() const { return isEquality(); }
1280
1281 /// Return true if the predicate is relational (not EQ or NE).
1282 ///
1283 bool isRelational() const {
1284 return !isEquality();
1285 }
1286
1287 /// Return true if the predicate is relational (not EQ or NE).
1288 ///
1289 static bool isRelational(Predicate P) {
1290 return !isEquality(P);
1291 }
1292
1293 /// Exchange the two operands to this instruction in such a way that it does
1294 /// not modify the semantics of the instruction. The predicate value may be
1295 /// changed to retain the same result if the predicate is order dependent
1296 /// (e.g. ult).
1297 /// Swap operands and adjust predicate.
1298 void swapOperands() {
1299 setPredicate(getSwappedPredicate());
1300 Op<0>().swap(Op<1>());
1301 }
1302
1303 // Methods for support type inquiry through isa, cast, and dyn_cast:
1304 static bool classof(const Instruction *I) {
1305 return I->getOpcode() == Instruction::ICmp;
1306 }
1307 static bool classof(const Value *V) {
1308 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1309 }
1310};
1311
1312//===----------------------------------------------------------------------===//
1313// FCmpInst Class
1314//===----------------------------------------------------------------------===//
1315
1316/// This instruction compares its operands according to the predicate given
1317/// to the constructor. It only operates on floating point values or packed
1318/// vectors of floating point values. The operands must be identical types.
1319/// Represents a floating point comparison operator.
1320class FCmpInst: public CmpInst {
1321 void AssertOK() {
1322 assert(isFPPredicate() && "Invalid FCmp predicate value")((isFPPredicate() && "Invalid FCmp predicate value") ?
static_cast<void> (0) : __assert_fail ("isFPPredicate() && \"Invalid FCmp predicate value\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1322, __PRETTY_FUNCTION__))
;
1323 assert(getOperand(0)->getType() == getOperand(1)->getType() &&((getOperand(0)->getType() == getOperand(1)->getType() &&
"Both operands to FCmp instruction are not of the same type!"
) ? static_cast<void> (0) : __assert_fail ("getOperand(0)->getType() == getOperand(1)->getType() && \"Both operands to FCmp instruction are not of the same type!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1324, __PRETTY_FUNCTION__))
1324 "Both operands to FCmp instruction are not of the same type!")((getOperand(0)->getType() == getOperand(1)->getType() &&
"Both operands to FCmp instruction are not of the same type!"
) ? static_cast<void> (0) : __assert_fail ("getOperand(0)->getType() == getOperand(1)->getType() && \"Both operands to FCmp instruction are not of the same type!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1324, __PRETTY_FUNCTION__))
;
1325 // Check that the operands are the right type
1326 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&((getOperand(0)->getType()->isFPOrFPVectorTy() &&
"Invalid operand types for FCmp instruction") ? static_cast<
void> (0) : __assert_fail ("getOperand(0)->getType()->isFPOrFPVectorTy() && \"Invalid operand types for FCmp instruction\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1327, __PRETTY_FUNCTION__))
1327 "Invalid operand types for FCmp instruction")((getOperand(0)->getType()->isFPOrFPVectorTy() &&
"Invalid operand types for FCmp instruction") ? static_cast<
void> (0) : __assert_fail ("getOperand(0)->getType()->isFPOrFPVectorTy() && \"Invalid operand types for FCmp instruction\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1327, __PRETTY_FUNCTION__))
;
1328 }
1329
1330protected:
1331 // Note: Instruction needs to be a friend here to call cloneImpl.
1332 friend class Instruction;
1333
1334 /// Clone an identical FCmpInst
1335 FCmpInst *cloneImpl() const;
1336
1337public:
1338 /// Constructor with insert-before-instruction semantics.
1339 FCmpInst(
1340 Instruction *InsertBefore, ///< Where to insert
1341 Predicate pred, ///< The predicate to use for the comparison
1342 Value *LHS, ///< The left-hand-side of the expression
1343 Value *RHS, ///< The right-hand-side of the expression
1344 const Twine &NameStr = "" ///< Name of the instruction
1345 ) : CmpInst(makeCmpResultType(LHS->getType()),
1346 Instruction::FCmp, pred, LHS, RHS, NameStr,
1347 InsertBefore) {
1348 AssertOK();
1349 }
1350
1351 /// Constructor with insert-at-end semantics.
1352 FCmpInst(
1353 BasicBlock &InsertAtEnd, ///< Block to insert into.
1354 Predicate pred, ///< The predicate to use for the comparison
1355 Value *LHS, ///< The left-hand-side of the expression
1356 Value *RHS, ///< The right-hand-side of the expression
1357 const Twine &NameStr = "" ///< Name of the instruction
1358 ) : CmpInst(makeCmpResultType(LHS->getType()),
1359 Instruction::FCmp, pred, LHS, RHS, NameStr,
1360 &InsertAtEnd) {
1361 AssertOK();
1362 }
1363
1364 /// Constructor with no-insertion semantics
1365 FCmpInst(
1366 Predicate Pred, ///< The predicate to use for the comparison
1367 Value *LHS, ///< The left-hand-side of the expression
1368 Value *RHS, ///< The right-hand-side of the expression
1369 const Twine &NameStr = "", ///< Name of the instruction
1370 Instruction *FlagsSource = nullptr
1371 ) : CmpInst(makeCmpResultType(LHS->getType()), Instruction::FCmp, Pred, LHS,
1372 RHS, NameStr, nullptr, FlagsSource) {
1373 AssertOK();
1374 }
1375
1376 /// @returns true if the predicate of this instruction is EQ or NE.
1377 /// Determine if this is an equality predicate.
1378 static bool isEquality(Predicate Pred) {
1379 return Pred == FCMP_OEQ || Pred == FCMP_ONE || Pred == FCMP_UEQ ||
1380 Pred == FCMP_UNE;
1381 }
1382
1383 /// @returns true if the predicate of this instruction is EQ or NE.
1384 /// Determine if this is an equality predicate.
1385 bool isEquality() const { return isEquality(getPredicate()); }
1386
1387 /// @returns true if the predicate of this instruction is commutative.
1388 /// Determine if this is a commutative predicate.
1389 bool isCommutative() const {
1390 return isEquality() ||
1391 getPredicate() == FCMP_FALSE ||
1392 getPredicate() == FCMP_TRUE ||
1393 getPredicate() == FCMP_ORD ||
1394 getPredicate() == FCMP_UNO;
1395 }
1396
1397 /// @returns true if the predicate is relational (not EQ or NE).
1398 /// Determine if this a relational predicate.
1399 bool isRelational() const { return !isEquality(); }
1400
1401 /// Exchange the two operands to this instruction in such a way that it does
1402 /// not modify the semantics of the instruction. The predicate value may be
1403 /// changed to retain the same result if the predicate is order dependent
1404 /// (e.g. ult).
1405 /// Swap operands and adjust predicate.
1406 void swapOperands() {
1407 setPredicate(getSwappedPredicate());
1408 Op<0>().swap(Op<1>());
1409 }
1410
1411 /// Methods for support type inquiry through isa, cast, and dyn_cast:
1412 static bool classof(const Instruction *I) {
1413 return I->getOpcode() == Instruction::FCmp;
1414 }
1415 static bool classof(const Value *V) {
1416 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1417 }
1418};
1419
1420//===----------------------------------------------------------------------===//
1421/// This class represents a function call, abstracting a target
1422/// machine's calling convention. This class uses low bit of the SubClassData
1423/// field to indicate whether or not this is a tail call. The rest of the bits
1424/// hold the calling convention of the call.
1425///
1426class CallInst : public CallBase {
1427 CallInst(const CallInst &CI);
1428
1429 /// Construct a CallInst given a range of arguments.
1430 /// Construct a CallInst from a range of arguments
1431 inline CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1432 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1433 Instruction *InsertBefore);
1434
1435 inline CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1436 const Twine &NameStr, Instruction *InsertBefore)
1437 : CallInst(Ty, Func, Args, None, NameStr, InsertBefore) {}
1438
1439 /// Construct a CallInst given a range of arguments.
1440 /// Construct a CallInst from a range of arguments
1441 inline CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1442 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1443 BasicBlock *InsertAtEnd);
1444
1445 explicit CallInst(FunctionType *Ty, Value *F, const Twine &NameStr,
1446 Instruction *InsertBefore);
1447
1448 CallInst(FunctionType *ty, Value *F, const Twine &NameStr,
1449 BasicBlock *InsertAtEnd);
1450
1451 void init(FunctionType *FTy, Value *Func, ArrayRef<Value *> Args,
1452 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr);
1453 void init(FunctionType *FTy, Value *Func, const Twine &NameStr);
1454
1455 /// Compute the number of operands to allocate.
1456 static int ComputeNumOperands(int NumArgs, int NumBundleInputs = 0) {
1457 // We need one operand for the called function, plus the input operand
1458 // counts provided.
1459 return 1 + NumArgs + NumBundleInputs;
1460 }
1461
1462protected:
1463 // Note: Instruction needs to be a friend here to call cloneImpl.
1464 friend class Instruction;
1465
1466 CallInst *cloneImpl() const;
1467
1468public:
1469 static CallInst *Create(FunctionType *Ty, Value *F, const Twine &NameStr = "",
1470 Instruction *InsertBefore = nullptr) {
1471 return new (ComputeNumOperands(0)) CallInst(Ty, F, NameStr, InsertBefore);
1472 }
1473
1474 static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1475 const Twine &NameStr,
1476 Instruction *InsertBefore = nullptr) {
1477 return new (ComputeNumOperands(Args.size()))
1478 CallInst(Ty, Func, Args, None, NameStr, InsertBefore);
1479 }
1480
1481 static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1482 ArrayRef<OperandBundleDef> Bundles = None,
1483 const Twine &NameStr = "",
1484 Instruction *InsertBefore = nullptr) {
1485 const int NumOperands =
1486 ComputeNumOperands(Args.size(), CountBundleInputs(Bundles));
1487 const unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
1488
1489 return new (NumOperands, DescriptorBytes)
1490 CallInst(Ty, Func, Args, Bundles, NameStr, InsertBefore);
1491 }
1492
1493 static CallInst *Create(FunctionType *Ty, Value *F, const Twine &NameStr,
1494 BasicBlock *InsertAtEnd) {
1495 return new (ComputeNumOperands(0)) CallInst(Ty, F, NameStr, InsertAtEnd);
1496 }
1497
1498 static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1499 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1500 return new (ComputeNumOperands(Args.size()))
1501 CallInst(Ty, Func, Args, None, NameStr, InsertAtEnd);
1502 }
1503
1504 static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1505 ArrayRef<OperandBundleDef> Bundles,
1506 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1507 const int NumOperands =
1508 ComputeNumOperands(Args.size(), CountBundleInputs(Bundles));
1509 const unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
1510
1511 return new (NumOperands, DescriptorBytes)
1512 CallInst(Ty, Func, Args, Bundles, NameStr, InsertAtEnd);
1513 }
1514
1515 static CallInst *Create(FunctionCallee Func, const Twine &NameStr = "",
1516 Instruction *InsertBefore = nullptr) {
1517 return Create(Func.getFunctionType(), Func.getCallee(), NameStr,
1518 InsertBefore);
1519 }
1520
1521 static CallInst *Create(FunctionCallee Func, ArrayRef<Value *> Args,
1522 ArrayRef<OperandBundleDef> Bundles = None,
1523 const Twine &NameStr = "",
1524 Instruction *InsertBefore = nullptr) {
1525 return Create(Func.getFunctionType(), Func.getCallee(), Args, Bundles,
1526 NameStr, InsertBefore);
1527 }
1528
1529 static CallInst *Create(FunctionCallee Func, ArrayRef<Value *> Args,
1530 const Twine &NameStr,
1531 Instruction *InsertBefore = nullptr) {
1532 return Create(Func.getFunctionType(), Func.getCallee(), Args, NameStr,
1533 InsertBefore);
1534 }
1535
1536 static CallInst *Create(FunctionCallee Func, const Twine &NameStr,
1537 BasicBlock *InsertAtEnd) {
1538 return Create(Func.getFunctionType(), Func.getCallee(), NameStr,
1539 InsertAtEnd);
1540 }
1541
1542 static CallInst *Create(FunctionCallee Func, ArrayRef<Value *> Args,
1543 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1544 return Create(Func.getFunctionType(), Func.getCallee(), Args, NameStr,
1545 InsertAtEnd);
1546 }
1547
1548 static CallInst *Create(FunctionCallee Func, ArrayRef<Value *> Args,
1549 ArrayRef<OperandBundleDef> Bundles,
1550 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1551 return Create(Func.getFunctionType(), Func.getCallee(), Args, Bundles,
1552 NameStr, InsertAtEnd);
1553 }
1554
1555 /// Create a clone of \p CI with a different set of operand bundles and
1556 /// insert it before \p InsertPt.
1557 ///
1558 /// The returned call instruction is identical \p CI in every way except that
1559 /// the operand bundles for the new instruction are set to the operand bundles
1560 /// in \p Bundles.
1561 static CallInst *Create(CallInst *CI, ArrayRef<OperandBundleDef> Bundles,
1562 Instruction *InsertPt = nullptr);
1563
1564 /// Create a clone of \p CI with a different set of operand bundles and
1565 /// insert it before \p InsertPt.
1566 ///
1567 /// The returned call instruction is identical \p CI in every way except that
1568 /// the operand bundle for the new instruction is set to the operand bundle
1569 /// in \p Bundle.
1570 static CallInst *CreateWithReplacedBundle(CallInst *CI,
1571 OperandBundleDef Bundle,
1572 Instruction *InsertPt = nullptr);
1573
1574 /// Generate the IR for a call to malloc:
1575 /// 1. Compute the malloc call's argument as the specified type's size,
1576 /// possibly multiplied by the array size if the array size is not
1577 /// constant 1.
1578 /// 2. Call malloc with that argument.
1579 /// 3. Bitcast the result of the malloc call to the specified type.
1580 static Instruction *CreateMalloc(Instruction *InsertBefore, Type *IntPtrTy,
1581 Type *AllocTy, Value *AllocSize,
1582 Value *ArraySize = nullptr,
1583 Function *MallocF = nullptr,
1584 const Twine &Name = "");
1585 static Instruction *CreateMalloc(BasicBlock *InsertAtEnd, Type *IntPtrTy,
1586 Type *AllocTy, Value *AllocSize,
1587 Value *ArraySize = nullptr,
1588 Function *MallocF = nullptr,
1589 const Twine &Name = "");
1590 static Instruction *CreateMalloc(Instruction *InsertBefore, Type *IntPtrTy,
1591 Type *AllocTy, Value *AllocSize,
1592 Value *ArraySize = nullptr,
1593 ArrayRef<OperandBundleDef> Bundles = None,
1594 Function *MallocF = nullptr,
1595 const Twine &Name = "");
1596 static Instruction *CreateMalloc(BasicBlock *InsertAtEnd, Type *IntPtrTy,
1597 Type *AllocTy, Value *AllocSize,
1598 Value *ArraySize = nullptr,
1599 ArrayRef<OperandBundleDef> Bundles = None,
1600 Function *MallocF = nullptr,
1601 const Twine &Name = "");
1602 /// Generate the IR for a call to the builtin free function.
1603 static Instruction *CreateFree(Value *Source, Instruction *InsertBefore);
1604 static Instruction *CreateFree(Value *Source, BasicBlock *InsertAtEnd);
1605 static Instruction *CreateFree(Value *Source,
1606 ArrayRef<OperandBundleDef> Bundles,
1607 Instruction *InsertBefore);
1608 static Instruction *CreateFree(Value *Source,
1609 ArrayRef<OperandBundleDef> Bundles,
1610 BasicBlock *InsertAtEnd);
1611
1612 // Note that 'musttail' implies 'tail'.
1613 enum TailCallKind : unsigned {
1614 TCK_None = 0,
1615 TCK_Tail = 1,
1616 TCK_MustTail = 2,
1617 TCK_NoTail = 3,
1618 TCK_LAST = TCK_NoTail
1619 };
1620
1621 using TailCallKindField = Bitfield::Element<TailCallKind, 0, 2, TCK_LAST>;
1622 static_assert(
1623 Bitfield::areContiguous<TailCallKindField, CallBase::CallingConvField>(),
1624 "Bitfields must be contiguous");
1625
1626 TailCallKind getTailCallKind() const {
1627 return getSubclassData<TailCallKindField>();
1628 }
1629
1630 bool isTailCall() const {
1631 TailCallKind Kind = getTailCallKind();
1632 return Kind == TCK_Tail || Kind == TCK_MustTail;
1633 }
1634
1635 bool isMustTailCall() const { return getTailCallKind() == TCK_MustTail; }
1636
1637 bool isNoTailCall() const { return getTailCallKind() == TCK_NoTail; }
1638
1639 void setTailCallKind(TailCallKind TCK) {
1640 setSubclassData<TailCallKindField>(TCK);
1641 }
1642
1643 void setTailCall(bool IsTc = true) {
1644 setTailCallKind(IsTc ? TCK_Tail : TCK_None);
1645 }
1646
1647 /// Return true if the call can return twice
1648 bool canReturnTwice() const { return hasFnAttr(Attribute::ReturnsTwice); }
1649 void setCanReturnTwice() {
1650 addAttribute(AttributeList::FunctionIndex, Attribute::ReturnsTwice);
1651 }
1652
1653 // Methods for support type inquiry through isa, cast, and dyn_cast:
1654 static bool classof(const Instruction *I) {
1655 return I->getOpcode() == Instruction::Call;
1656 }
1657 static bool classof(const Value *V) {
1658 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1659 }
1660
1661 /// Updates profile metadata by scaling it by \p S / \p T.
1662 void updateProfWeight(uint64_t S, uint64_t T);
1663
1664private:
1665 // Shadow Instruction::setInstructionSubclassData with a private forwarding
1666 // method so that subclasses cannot accidentally use it.
1667 template <typename Bitfield>
1668 void setSubclassData(typename Bitfield::Type Value) {
1669 Instruction::setSubclassData<Bitfield>(Value);
1670 }
1671};
1672
1673CallInst::CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1674 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1675 BasicBlock *InsertAtEnd)
1676 : CallBase(Ty->getReturnType(), Instruction::Call,
1677 OperandTraits<CallBase>::op_end(this) -
1678 (Args.size() + CountBundleInputs(Bundles) + 1),
1679 unsigned(Args.size() + CountBundleInputs(Bundles) + 1),
1680 InsertAtEnd) {
1681 init(Ty, Func, Args, Bundles, NameStr);
1682}
1683
1684CallInst::CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1685 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1686 Instruction *InsertBefore)
1687 : CallBase(Ty->getReturnType(), Instruction::Call,
1688 OperandTraits<CallBase>::op_end(this) -
1689 (Args.size() + CountBundleInputs(Bundles) + 1),
1690 unsigned(Args.size() + CountBundleInputs(Bundles) + 1),
1691 InsertBefore) {
1692 init(Ty, Func, Args, Bundles, NameStr);
1693}
1694
1695//===----------------------------------------------------------------------===//
1696// SelectInst Class
1697//===----------------------------------------------------------------------===//
1698
1699/// This class represents the LLVM 'select' instruction.
1700///
1701class SelectInst : public Instruction {
1702 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1703 Instruction *InsertBefore)
1704 : Instruction(S1->getType(), Instruction::Select,
1705 &Op<0>(), 3, InsertBefore) {
1706 init(C, S1, S2);
1707 setName(NameStr);
1708 }
1709
1710 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1711 BasicBlock *InsertAtEnd)
1712 : Instruction(S1->getType(), Instruction::Select,
1713 &Op<0>(), 3, InsertAtEnd) {
1714 init(C, S1, S2);
1715 setName(NameStr);
1716 }
1717
1718 void init(Value *C, Value *S1, Value *S2) {
1719 assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select")((!areInvalidOperands(C, S1, S2) && "Invalid operands for select"
) ? static_cast<void> (0) : __assert_fail ("!areInvalidOperands(C, S1, S2) && \"Invalid operands for select\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1719, __PRETTY_FUNCTION__))
;
1720 Op<0>() = C;
1721 Op<1>() = S1;
1722 Op<2>() = S2;
1723 }
1724
1725protected:
1726 // Note: Instruction needs to be a friend here to call cloneImpl.
1727 friend class Instruction;
1728
1729 SelectInst *cloneImpl() const;
1730
1731public:
1732 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1733 const Twine &NameStr = "",
1734 Instruction *InsertBefore = nullptr,
1735 Instruction *MDFrom = nullptr) {
1736 SelectInst *Sel = new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1737 if (MDFrom)
1738 Sel->copyMetadata(*MDFrom);
1739 return Sel;
1740 }
1741
1742 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1743 const Twine &NameStr,
1744 BasicBlock *InsertAtEnd) {
1745 return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1746 }
1747
1748 const Value *getCondition() const { return Op<0>(); }
1749 const Value *getTrueValue() const { return Op<1>(); }
1750 const Value *getFalseValue() const { return Op<2>(); }
1751 Value *getCondition() { return Op<0>(); }
1752 Value *getTrueValue() { return Op<1>(); }
1753 Value *getFalseValue() { return Op<2>(); }
1754
1755 void setCondition(Value *V) { Op<0>() = V; }
1756 void setTrueValue(Value *V) { Op<1>() = V; }
1757 void setFalseValue(Value *V) { Op<2>() = V; }
1758
1759 /// Swap the true and false values of the select instruction.
1760 /// This doesn't swap prof metadata.
1761 void swapValues() { Op<1>().swap(Op<2>()); }
1762
1763 /// Return a string if the specified operands are invalid
1764 /// for a select operation, otherwise return null.
1765 static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
1766
1767 /// Transparently provide more efficient getOperand methods.
1768 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
1769
1770 OtherOps getOpcode() const {
1771 return static_cast<OtherOps>(Instruction::getOpcode());
1772 }
1773
1774 // Methods for support type inquiry through isa, cast, and dyn_cast:
1775 static bool classof(const Instruction *I) {
1776 return I->getOpcode() == Instruction::Select;
1777 }
1778 static bool classof(const Value *V) {
1779 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1780 }
1781};
1782
1783template <>
1784struct OperandTraits<SelectInst> : public FixedNumOperandTraits<SelectInst, 3> {
1785};
1786
1787DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)SelectInst::op_iterator SelectInst::op_begin() { return OperandTraits
<SelectInst>::op_begin(this); } SelectInst::const_op_iterator
SelectInst::op_begin() const { return OperandTraits<SelectInst
>::op_begin(const_cast<SelectInst*>(this)); } SelectInst
::op_iterator SelectInst::op_end() { return OperandTraits<
SelectInst>::op_end(this); } SelectInst::const_op_iterator
SelectInst::op_end() const { return OperandTraits<SelectInst
>::op_end(const_cast<SelectInst*>(this)); } Value *SelectInst
::getOperand(unsigned i_nocapture) const { ((i_nocapture <
OperandTraits<SelectInst>::operands(this) && "getOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<SelectInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1787, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<SelectInst>::op_begin(const_cast<SelectInst
*>(this))[i_nocapture].get()); } void SelectInst::setOperand
(unsigned i_nocapture, Value *Val_nocapture) { ((i_nocapture <
OperandTraits<SelectInst>::operands(this) && "setOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<SelectInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1787, __PRETTY_FUNCTION__)); OperandTraits<SelectInst>
::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned SelectInst
::getNumOperands() const { return OperandTraits<SelectInst
>::operands(this); } template <int Idx_nocapture> Use
&SelectInst::Op() { return this->OpFrom<Idx_nocapture
>(this); } template <int Idx_nocapture> const Use &
SelectInst::Op() const { return this->OpFrom<Idx_nocapture
>(this); }
1788
1789//===----------------------------------------------------------------------===//
1790// VAArgInst Class
1791//===----------------------------------------------------------------------===//
1792
1793/// This class represents the va_arg llvm instruction, which returns
1794/// an argument of the specified type given a va_list and increments that list
1795///
1796class VAArgInst : public UnaryInstruction {
1797protected:
1798 // Note: Instruction needs to be a friend here to call cloneImpl.
1799 friend class Instruction;
1800
1801 VAArgInst *cloneImpl() const;
1802
1803public:
1804 VAArgInst(Value *List, Type *Ty, const Twine &NameStr = "",
1805 Instruction *InsertBefore = nullptr)
1806 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1807 setName(NameStr);
1808 }
1809
1810 VAArgInst(Value *List, Type *Ty, const Twine &NameStr,
1811 BasicBlock *InsertAtEnd)
1812 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1813 setName(NameStr);
1814 }
1815
1816 Value *getPointerOperand() { return getOperand(0); }
1817 const Value *getPointerOperand() const { return getOperand(0); }
1818 static unsigned getPointerOperandIndex() { return 0U; }
1819
1820 // Methods for support type inquiry through isa, cast, and dyn_cast:
1821 static bool classof(const Instruction *I) {
1822 return I->getOpcode() == VAArg;
1823 }
1824 static bool classof(const Value *V) {
1825 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1826 }
1827};
1828
1829//===----------------------------------------------------------------------===//
1830// ExtractElementInst Class
1831//===----------------------------------------------------------------------===//
1832
1833/// This instruction extracts a single (scalar)
1834/// element from a VectorType value
1835///
1836class ExtractElementInst : public Instruction {
1837 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "",
1838 Instruction *InsertBefore = nullptr);
1839 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr,
1840 BasicBlock *InsertAtEnd);
1841
1842protected:
1843 // Note: Instruction needs to be a friend here to call cloneImpl.
1844 friend class Instruction;
1845
1846 ExtractElementInst *cloneImpl() const;
1847
1848public:
1849 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1850 const Twine &NameStr = "",
1851 Instruction *InsertBefore = nullptr) {
1852 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore);
1853 }
1854
1855 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1856 const Twine &NameStr,
1857 BasicBlock *InsertAtEnd) {
1858 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd);
1859 }
1860
1861 /// Return true if an extractelement instruction can be
1862 /// formed with the specified operands.
1863 static bool isValidOperands(const Value *Vec, const Value *Idx);
1864
1865 Value *getVectorOperand() { return Op<0>(); }
1866 Value *getIndexOperand() { return Op<1>(); }
1867 const Value *getVectorOperand() const { return Op<0>(); }
1868 const Value *getIndexOperand() const { return Op<1>(); }
1869
1870 VectorType *getVectorOperandType() const {
1871 return cast<VectorType>(getVectorOperand()->getType());
1872 }
1873
1874 /// Transparently provide more efficient getOperand methods.
1875 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
1876
1877 // Methods for support type inquiry through isa, cast, and dyn_cast:
1878 static bool classof(const Instruction *I) {
1879 return I->getOpcode() == Instruction::ExtractElement;
1880 }
1881 static bool classof(const Value *V) {
1882 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1883 }
1884};
1885
1886template <>
1887struct OperandTraits<ExtractElementInst> :
1888 public FixedNumOperandTraits<ExtractElementInst, 2> {
1889};
1890
1891DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)ExtractElementInst::op_iterator ExtractElementInst::op_begin(
) { return OperandTraits<ExtractElementInst>::op_begin(
this); } ExtractElementInst::const_op_iterator ExtractElementInst
::op_begin() const { return OperandTraits<ExtractElementInst
>::op_begin(const_cast<ExtractElementInst*>(this)); }
ExtractElementInst::op_iterator ExtractElementInst::op_end()
{ return OperandTraits<ExtractElementInst>::op_end(this
); } ExtractElementInst::const_op_iterator ExtractElementInst
::op_end() const { return OperandTraits<ExtractElementInst
>::op_end(const_cast<ExtractElementInst*>(this)); } Value
*ExtractElementInst::getOperand(unsigned i_nocapture) const {
((i_nocapture < OperandTraits<ExtractElementInst>::
operands(this) && "getOperand() out of range!") ? static_cast
<void> (0) : __assert_fail ("i_nocapture < OperandTraits<ExtractElementInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1891, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<ExtractElementInst>::op_begin(const_cast
<ExtractElementInst*>(this))[i_nocapture].get()); } void
ExtractElementInst::setOperand(unsigned i_nocapture, Value *
Val_nocapture) { ((i_nocapture < OperandTraits<ExtractElementInst
>::operands(this) && "setOperand() out of range!")
? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<ExtractElementInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1891, __PRETTY_FUNCTION__)); OperandTraits<ExtractElementInst
>::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned
ExtractElementInst::getNumOperands() const { return OperandTraits
<ExtractElementInst>::operands(this); } template <int
Idx_nocapture> Use &ExtractElementInst::Op() { return
this->OpFrom<Idx_nocapture>(this); } template <int
Idx_nocapture> const Use &ExtractElementInst::Op() const
{ return this->OpFrom<Idx_nocapture>(this); }
1892
1893//===----------------------------------------------------------------------===//
1894// InsertElementInst Class
1895//===----------------------------------------------------------------------===//
1896
1897/// This instruction inserts a single (scalar)
1898/// element into a VectorType value
1899///
1900class InsertElementInst : public Instruction {
1901 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1902 const Twine &NameStr = "",
1903 Instruction *InsertBefore = nullptr);
1904 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx, const Twine &NameStr,
1905 BasicBlock *InsertAtEnd);
1906
1907protected:
1908 // Note: Instruction needs to be a friend here to call cloneImpl.
1909 friend class Instruction;
1910
1911 InsertElementInst *cloneImpl() const;
1912
1913public:
1914 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1915 const Twine &NameStr = "",
1916 Instruction *InsertBefore = nullptr) {
1917 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1918 }
1919
1920 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1921 const Twine &NameStr,
1922 BasicBlock *InsertAtEnd) {
1923 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1924 }
1925
1926 /// Return true if an insertelement instruction can be
1927 /// formed with the specified operands.
1928 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1929 const Value *Idx);
1930
1931 /// Overload to return most specific vector type.
1932 ///
1933 VectorType *getType() const {
1934 return cast<VectorType>(Instruction::getType());
1935 }
1936
1937 /// Transparently provide more efficient getOperand methods.
1938 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
1939
1940 // Methods for support type inquiry through isa, cast, and dyn_cast:
1941 static bool classof(const Instruction *I) {
1942 return I->getOpcode() == Instruction::InsertElement;
1943 }
1944 static bool classof(const Value *V) {
1945 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1946 }
1947};
1948
1949template <>
1950struct OperandTraits<InsertElementInst> :
1951 public FixedNumOperandTraits<InsertElementInst, 3> {
1952};
1953
1954DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)InsertElementInst::op_iterator InsertElementInst::op_begin() {
return OperandTraits<InsertElementInst>::op_begin(this
); } InsertElementInst::const_op_iterator InsertElementInst::
op_begin() const { return OperandTraits<InsertElementInst>
::op_begin(const_cast<InsertElementInst*>(this)); } InsertElementInst
::op_iterator InsertElementInst::op_end() { return OperandTraits
<InsertElementInst>::op_end(this); } InsertElementInst::
const_op_iterator InsertElementInst::op_end() const { return OperandTraits
<InsertElementInst>::op_end(const_cast<InsertElementInst
*>(this)); } Value *InsertElementInst::getOperand(unsigned
i_nocapture) const { ((i_nocapture < OperandTraits<InsertElementInst
>::operands(this) && "getOperand() out of range!")
? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<InsertElementInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1954, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<InsertElementInst>::op_begin(const_cast
<InsertElementInst*>(this))[i_nocapture].get()); } void
InsertElementInst::setOperand(unsigned i_nocapture, Value *Val_nocapture
) { ((i_nocapture < OperandTraits<InsertElementInst>
::operands(this) && "setOperand() out of range!") ? static_cast
<void> (0) : __assert_fail ("i_nocapture < OperandTraits<InsertElementInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 1954, __PRETTY_FUNCTION__)); OperandTraits<InsertElementInst
>::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned
InsertElementInst::getNumOperands() const { return OperandTraits
<InsertElementInst>::operands(this); } template <int
Idx_nocapture> Use &InsertElementInst::Op() { return this
->OpFrom<Idx_nocapture>(this); } template <int Idx_nocapture
> const Use &InsertElementInst::Op() const { return this
->OpFrom<Idx_nocapture>(this); }
1955
1956//===----------------------------------------------------------------------===//
1957// ShuffleVectorInst Class
1958//===----------------------------------------------------------------------===//
1959
1960constexpr int UndefMaskElem = -1;
1961
1962/// This instruction constructs a fixed permutation of two
1963/// input vectors.
1964///
1965/// For each element of the result vector, the shuffle mask selects an element
1966/// from one of the input vectors to copy to the result. Non-negative elements
1967/// in the mask represent an index into the concatenated pair of input vectors.
1968/// UndefMaskElem (-1) specifies that the result element is undefined.
1969///
1970/// For scalable vectors, all the elements of the mask must be 0 or -1. This
1971/// requirement may be relaxed in the future.
1972class ShuffleVectorInst : public Instruction {
1973 SmallVector<int, 4> ShuffleMask;
1974 Constant *ShuffleMaskForBitcode;
1975
1976protected:
1977 // Note: Instruction needs to be a friend here to call cloneImpl.
1978 friend class Instruction;
1979
1980 ShuffleVectorInst *cloneImpl() const;
1981
1982public:
1983 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1984 const Twine &NameStr = "",
1985 Instruction *InsertBefor = nullptr);
1986 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1987 const Twine &NameStr, BasicBlock *InsertAtEnd);
1988 ShuffleVectorInst(Value *V1, Value *V2, ArrayRef<int> Mask,
1989 const Twine &NameStr = "",
1990 Instruction *InsertBefor = nullptr);
1991 ShuffleVectorInst(Value *V1, Value *V2, ArrayRef<int> Mask,
1992 const Twine &NameStr, BasicBlock *InsertAtEnd);
1993
1994 void *operator new(size_t s) { return User::operator new(s, 2); }
1995
1996 /// Swap the operands and adjust the mask to preserve the semantics
1997 /// of the instruction.
1998 void commute();
1999
2000 /// Return true if a shufflevector instruction can be
2001 /// formed with the specified operands.
2002 static bool isValidOperands(const Value *V1, const Value *V2,
2003 const Value *Mask);
2004 static bool isValidOperands(const Value *V1, const Value *V2,
2005 ArrayRef<int> Mask);
2006
2007 /// Overload to return most specific vector type.
2008 ///
2009 VectorType *getType() const {
2010 return cast<VectorType>(Instruction::getType());
2011 }
2012
2013 /// Transparently provide more efficient getOperand methods.
2014 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
2015
2016 /// Return the shuffle mask value of this instruction for the given element
2017 /// index. Return UndefMaskElem if the element is undef.
2018 int getMaskValue(unsigned Elt) const { return ShuffleMask[Elt]; }
2019
2020 /// Convert the input shuffle mask operand to a vector of integers. Undefined
2021 /// elements of the mask are returned as UndefMaskElem.
2022 static void getShuffleMask(const Constant *Mask,
2023 SmallVectorImpl<int> &Result);
2024
2025 /// Return the mask for this instruction as a vector of integers. Undefined
2026 /// elements of the mask are returned as UndefMaskElem.
2027 void getShuffleMask(SmallVectorImpl<int> &Result) const {
2028 Result.assign(ShuffleMask.begin(), ShuffleMask.end());
2029 }
2030
2031 /// Return the mask for this instruction, for use in bitcode.
2032 ///
2033 /// TODO: This is temporary until we decide a new bitcode encoding for
2034 /// shufflevector.
2035 Constant *getShuffleMaskForBitcode() const { return ShuffleMaskForBitcode; }
2036
2037 static Constant *convertShuffleMaskForBitcode(ArrayRef<int> Mask,
2038 Type *ResultTy);
2039
2040 void setShuffleMask(ArrayRef<int> Mask);
2041
2042 ArrayRef<int> getShuffleMask() const { return ShuffleMask; }
2043
2044 /// Return true if this shuffle returns a vector with a different number of
2045 /// elements than its source vectors.
2046 /// Examples: shufflevector <4 x n> A, <4 x n> B, <1,2,3>
2047 /// shufflevector <4 x n> A, <4 x n> B, <1,2,3,4,5>
2048 bool changesLength() const {
2049 unsigned NumSourceElts = cast<VectorType>(Op<0>()->getType())
2050 ->getElementCount()
2051 .getKnownMinValue();
2052 unsigned NumMaskElts = ShuffleMask.size();
2053 return NumSourceElts != NumMaskElts;
2054 }
2055
2056 /// Return true if this shuffle returns a vector with a greater number of
2057 /// elements than its source vectors.
2058 /// Example: shufflevector <2 x n> A, <2 x n> B, <1,2,3>
2059 bool increasesLength() const {
2060 unsigned NumSourceElts =
2061 cast<FixedVectorType>(Op<0>()->getType())->getNumElements();
2062 unsigned NumMaskElts = ShuffleMask.size();
2063 return NumSourceElts < NumMaskElts;
2064 }
2065
2066 /// Return true if this shuffle mask chooses elements from exactly one source
2067 /// vector.
2068 /// Example: <7,5,undef,7>
2069 /// This assumes that vector operands are the same length as the mask.
2070 static bool isSingleSourceMask(ArrayRef<int> Mask);
2071 static bool isSingleSourceMask(const Constant *Mask) {
2072 assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((Mask->getType()->isVectorTy() && "Shuffle needs vector constant."
) ? static_cast<void> (0) : __assert_fail ("Mask->getType()->isVectorTy() && \"Shuffle needs vector constant.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2072, __PRETTY_FUNCTION__))
;
2073 SmallVector<int, 16> MaskAsInts;
2074 getShuffleMask(Mask, MaskAsInts);
2075 return isSingleSourceMask(MaskAsInts);
2076 }
2077
2078 /// Return true if this shuffle chooses elements from exactly one source
2079 /// vector without changing the length of that vector.
2080 /// Example: shufflevector <4 x n> A, <4 x n> B, <3,0,undef,3>
2081 /// TODO: Optionally allow length-changing shuffles.
2082 bool isSingleSource() const {
2083 return !changesLength() && isSingleSourceMask(ShuffleMask);
2084 }
2085
2086 /// Return true if this shuffle mask chooses elements from exactly one source
2087 /// vector without lane crossings. A shuffle using this mask is not
2088 /// necessarily a no-op because it may change the number of elements from its
2089 /// input vectors or it may provide demanded bits knowledge via undef lanes.
2090 /// Example: <undef,undef,2,3>
2091 static bool isIdentityMask(ArrayRef<int> Mask);
2092 static bool isIdentityMask(const Constant *Mask) {
2093 assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((Mask->getType()->isVectorTy() && "Shuffle needs vector constant."
) ? static_cast<void> (0) : __assert_fail ("Mask->getType()->isVectorTy() && \"Shuffle needs vector constant.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2093, __PRETTY_FUNCTION__))
;
2094 SmallVector<int, 16> MaskAsInts;
2095 getShuffleMask(Mask, MaskAsInts);
2096 return isIdentityMask(MaskAsInts);
2097 }
2098
2099 /// Return true if this shuffle chooses elements from exactly one source
2100 /// vector without lane crossings and does not change the number of elements
2101 /// from its input vectors.
2102 /// Example: shufflevector <4 x n> A, <4 x n> B, <4,undef,6,undef>
2103 bool isIdentity() const {
2104 return !changesLength() && isIdentityMask(ShuffleMask);
2105 }
2106
2107 /// Return true if this shuffle lengthens exactly one source vector with
2108 /// undefs in the high elements.
2109 bool isIdentityWithPadding() const;
2110
2111 /// Return true if this shuffle extracts the first N elements of exactly one
2112 /// source vector.
2113 bool isIdentityWithExtract() const;
2114
2115 /// Return true if this shuffle concatenates its 2 source vectors. This
2116 /// returns false if either input is undefined. In that case, the shuffle is
2117 /// is better classified as an identity with padding operation.
2118 bool isConcat() const;
2119
2120 /// Return true if this shuffle mask chooses elements from its source vectors
2121 /// without lane crossings. A shuffle using this mask would be
2122 /// equivalent to a vector select with a constant condition operand.
2123 /// Example: <4,1,6,undef>
2124 /// This returns false if the mask does not choose from both input vectors.
2125 /// In that case, the shuffle is better classified as an identity shuffle.
2126 /// This assumes that vector operands are the same length as the mask
2127 /// (a length-changing shuffle can never be equivalent to a vector select).
2128 static bool isSelectMask(ArrayRef<int> Mask);
2129 static bool isSelectMask(const Constant *Mask) {
2130 assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((Mask->getType()->isVectorTy() && "Shuffle needs vector constant."
) ? static_cast<void> (0) : __assert_fail ("Mask->getType()->isVectorTy() && \"Shuffle needs vector constant.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2130, __PRETTY_FUNCTION__))
;
2131 SmallVector<int, 16> MaskAsInts;
2132 getShuffleMask(Mask, MaskAsInts);
2133 return isSelectMask(MaskAsInts);
2134 }
2135
2136 /// Return true if this shuffle chooses elements from its source vectors
2137 /// without lane crossings and all operands have the same number of elements.
2138 /// In other words, this shuffle is equivalent to a vector select with a
2139 /// constant condition operand.
2140 /// Example: shufflevector <4 x n> A, <4 x n> B, <undef,1,6,3>
2141 /// This returns false if the mask does not choose from both input vectors.
2142 /// In that case, the shuffle is better classified as an identity shuffle.
2143 /// TODO: Optionally allow length-changing shuffles.
2144 bool isSelect() const {
2145 return !changesLength() && isSelectMask(ShuffleMask);
2146 }
2147
2148 /// Return true if this shuffle mask swaps the order of elements from exactly
2149 /// one source vector.
2150 /// Example: <7,6,undef,4>
2151 /// This assumes that vector operands are the same length as the mask.
2152 static bool isReverseMask(ArrayRef<int> Mask);
2153 static bool isReverseMask(const Constant *Mask) {
2154 assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((Mask->getType()->isVectorTy() && "Shuffle needs vector constant."
) ? static_cast<void> (0) : __assert_fail ("Mask->getType()->isVectorTy() && \"Shuffle needs vector constant.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2154, __PRETTY_FUNCTION__))
;
2155 SmallVector<int, 16> MaskAsInts;
2156 getShuffleMask(Mask, MaskAsInts);
2157 return isReverseMask(MaskAsInts);
2158 }
2159
2160 /// Return true if this shuffle swaps the order of elements from exactly
2161 /// one source vector.
2162 /// Example: shufflevector <4 x n> A, <4 x n> B, <3,undef,1,undef>
2163 /// TODO: Optionally allow length-changing shuffles.
2164 bool isReverse() const {
2165 return !changesLength() && isReverseMask(ShuffleMask);
2166 }
2167
2168 /// Return true if this shuffle mask chooses all elements with the same value
2169 /// as the first element of exactly one source vector.
2170 /// Example: <4,undef,undef,4>
2171 /// This assumes that vector operands are the same length as the mask.
2172 static bool isZeroEltSplatMask(ArrayRef<int> Mask);
2173 static bool isZeroEltSplatMask(const Constant *Mask) {
2174 assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((Mask->getType()->isVectorTy() && "Shuffle needs vector constant."
) ? static_cast<void> (0) : __assert_fail ("Mask->getType()->isVectorTy() && \"Shuffle needs vector constant.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2174, __PRETTY_FUNCTION__))
;
2175 SmallVector<int, 16> MaskAsInts;
2176 getShuffleMask(Mask, MaskAsInts);
2177 return isZeroEltSplatMask(MaskAsInts);
2178 }
2179
2180 /// Return true if all elements of this shuffle are the same value as the
2181 /// first element of exactly one source vector without changing the length
2182 /// of that vector.
2183 /// Example: shufflevector <4 x n> A, <4 x n> B, <undef,0,undef,0>
2184 /// TODO: Optionally allow length-changing shuffles.
2185 /// TODO: Optionally allow splats from other elements.
2186 bool isZeroEltSplat() const {
2187 return !changesLength() && isZeroEltSplatMask(ShuffleMask);
2188 }
2189
2190 /// Return true if this shuffle mask is a transpose mask.
2191 /// Transpose vector masks transpose a 2xn matrix. They read corresponding
2192 /// even- or odd-numbered vector elements from two n-dimensional source
2193 /// vectors and write each result into consecutive elements of an
2194 /// n-dimensional destination vector. Two shuffles are necessary to complete
2195 /// the transpose, one for the even elements and another for the odd elements.
2196 /// This description closely follows how the TRN1 and TRN2 AArch64
2197 /// instructions operate.
2198 ///
2199 /// For example, a simple 2x2 matrix can be transposed with:
2200 ///
2201 /// ; Original matrix
2202 /// m0 = < a, b >
2203 /// m1 = < c, d >
2204 ///
2205 /// ; Transposed matrix
2206 /// t0 = < a, c > = shufflevector m0, m1, < 0, 2 >
2207 /// t1 = < b, d > = shufflevector m0, m1, < 1, 3 >
2208 ///
2209 /// For matrices having greater than n columns, the resulting nx2 transposed
2210 /// matrix is stored in two result vectors such that one vector contains
2211 /// interleaved elements from all the even-numbered rows and the other vector
2212 /// contains interleaved elements from all the odd-numbered rows. For example,
2213 /// a 2x4 matrix can be transposed with:
2214 ///
2215 /// ; Original matrix
2216 /// m0 = < a, b, c, d >
2217 /// m1 = < e, f, g, h >
2218 ///
2219 /// ; Transposed matrix
2220 /// t0 = < a, e, c, g > = shufflevector m0, m1 < 0, 4, 2, 6 >
2221 /// t1 = < b, f, d, h > = shufflevector m0, m1 < 1, 5, 3, 7 >
2222 static bool isTransposeMask(ArrayRef<int> Mask);
2223 static bool isTransposeMask(const Constant *Mask) {
2224 assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((Mask->getType()->isVectorTy() && "Shuffle needs vector constant."
) ? static_cast<void> (0) : __assert_fail ("Mask->getType()->isVectorTy() && \"Shuffle needs vector constant.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2224, __PRETTY_FUNCTION__))
;
2225 SmallVector<int, 16> MaskAsInts;
2226 getShuffleMask(Mask, MaskAsInts);
2227 return isTransposeMask(MaskAsInts);
2228 }
2229
2230 /// Return true if this shuffle transposes the elements of its inputs without
2231 /// changing the length of the vectors. This operation may also be known as a
2232 /// merge or interleave. See the description for isTransposeMask() for the
2233 /// exact specification.
2234 /// Example: shufflevector <4 x n> A, <4 x n> B, <0,4,2,6>
2235 bool isTranspose() const {
2236 return !changesLength() && isTransposeMask(ShuffleMask);
2237 }
2238
2239 /// Return true if this shuffle mask is an extract subvector mask.
2240 /// A valid extract subvector mask returns a smaller vector from a single
2241 /// source operand. The base extraction index is returned as well.
2242 static bool isExtractSubvectorMask(ArrayRef<int> Mask, int NumSrcElts,
2243 int &Index);
2244 static bool isExtractSubvectorMask(const Constant *Mask, int NumSrcElts,
2245 int &Index) {
2246 assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((Mask->getType()->isVectorTy() && "Shuffle needs vector constant."
) ? static_cast<void> (0) : __assert_fail ("Mask->getType()->isVectorTy() && \"Shuffle needs vector constant.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2246, __PRETTY_FUNCTION__))
;
2247 SmallVector<int, 16> MaskAsInts;
2248 getShuffleMask(Mask, MaskAsInts);
2249 return isExtractSubvectorMask(MaskAsInts, NumSrcElts, Index);
2250 }
2251
2252 /// Return true if this shuffle mask is an extract subvector mask.
2253 bool isExtractSubvectorMask(int &Index) const {
2254 int NumSrcElts =
2255 cast<FixedVectorType>(Op<0>()->getType())->getNumElements();
2256 return isExtractSubvectorMask(ShuffleMask, NumSrcElts, Index);
2257 }
2258
2259 /// Change values in a shuffle permute mask assuming the two vector operands
2260 /// of length InVecNumElts have swapped position.
2261 static void commuteShuffleMask(MutableArrayRef<int> Mask,
2262 unsigned InVecNumElts) {
2263 for (int &Idx : Mask) {
2264 if (Idx == -1)
2265 continue;
2266 Idx = Idx < (int)InVecNumElts ? Idx + InVecNumElts : Idx - InVecNumElts;
2267 assert(Idx >= 0 && Idx < (int)InVecNumElts * 2 &&((Idx >= 0 && Idx < (int)InVecNumElts * 2 &&
"shufflevector mask index out of range") ? static_cast<void
> (0) : __assert_fail ("Idx >= 0 && Idx < (int)InVecNumElts * 2 && \"shufflevector mask index out of range\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2268, __PRETTY_FUNCTION__))
2268 "shufflevector mask index out of range")((Idx >= 0 && Idx < (int)InVecNumElts * 2 &&
"shufflevector mask index out of range") ? static_cast<void
> (0) : __assert_fail ("Idx >= 0 && Idx < (int)InVecNumElts * 2 && \"shufflevector mask index out of range\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2268, __PRETTY_FUNCTION__))
;
2269 }
2270 }
2271
2272 // Methods for support type inquiry through isa, cast, and dyn_cast:
2273 static bool classof(const Instruction *I) {
2274 return I->getOpcode() == Instruction::ShuffleVector;
2275 }
2276 static bool classof(const Value *V) {
2277 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2278 }
2279};
2280
2281template <>
2282struct OperandTraits<ShuffleVectorInst>
2283 : public FixedNumOperandTraits<ShuffleVectorInst, 2> {};
2284
2285DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)ShuffleVectorInst::op_iterator ShuffleVectorInst::op_begin() {
return OperandTraits<ShuffleVectorInst>::op_begin(this
); } ShuffleVectorInst::const_op_iterator ShuffleVectorInst::
op_begin() const { return OperandTraits<ShuffleVectorInst>
::op_begin(const_cast<ShuffleVectorInst*>(this)); } ShuffleVectorInst
::op_iterator ShuffleVectorInst::op_end() { return OperandTraits
<ShuffleVectorInst>::op_end(this); } ShuffleVectorInst::
const_op_iterator ShuffleVectorInst::op_end() const { return OperandTraits
<ShuffleVectorInst>::op_end(const_cast<ShuffleVectorInst
*>(this)); } Value *ShuffleVectorInst::getOperand(unsigned
i_nocapture) const { ((i_nocapture < OperandTraits<ShuffleVectorInst
>::operands(this) && "getOperand() out of range!")
? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<ShuffleVectorInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2285, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<ShuffleVectorInst>::op_begin(const_cast
<ShuffleVectorInst*>(this))[i_nocapture].get()); } void
ShuffleVectorInst::setOperand(unsigned i_nocapture, Value *Val_nocapture
) { ((i_nocapture < OperandTraits<ShuffleVectorInst>
::operands(this) && "setOperand() out of range!") ? static_cast
<void> (0) : __assert_fail ("i_nocapture < OperandTraits<ShuffleVectorInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2285, __PRETTY_FUNCTION__)); OperandTraits<ShuffleVectorInst
>::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned
ShuffleVectorInst::getNumOperands() const { return OperandTraits
<ShuffleVectorInst>::operands(this); } template <int
Idx_nocapture> Use &ShuffleVectorInst::Op() { return this
->OpFrom<Idx_nocapture>(this); } template <int Idx_nocapture
> const Use &ShuffleVectorInst::Op() const { return this
->OpFrom<Idx_nocapture>(this); }
2286
2287//===----------------------------------------------------------------------===//
2288// ExtractValueInst Class
2289//===----------------------------------------------------------------------===//
2290
2291/// This instruction extracts a struct member or array
2292/// element value from an aggregate value.
2293///
2294class ExtractValueInst : public UnaryInstruction {
2295 SmallVector<unsigned, 4> Indices;
2296
2297 ExtractValueInst(const ExtractValueInst &EVI);
2298
2299 /// Constructors - Create a extractvalue instruction with a base aggregate
2300 /// value and a list of indices. The first ctor can optionally insert before
2301 /// an existing instruction, the second appends the new instruction to the
2302 /// specified BasicBlock.
2303 inline ExtractValueInst(Value *Agg,
2304 ArrayRef<unsigned> Idxs,
2305 const Twine &NameStr,
2306 Instruction *InsertBefore);
2307 inline ExtractValueInst(Value *Agg,
2308 ArrayRef<unsigned> Idxs,
2309 const Twine &NameStr, BasicBlock *InsertAtEnd);
2310
2311 void init(ArrayRef<unsigned> Idxs, const Twine &NameStr);
2312
2313protected:
2314 // Note: Instruction needs to be a friend here to call cloneImpl.
2315 friend class Instruction;
2316
2317 ExtractValueInst *cloneImpl() const;
2318
2319public:
2320 static ExtractValueInst *Create(Value *Agg,
2321 ArrayRef<unsigned> Idxs,
2322 const Twine &NameStr = "",
2323 Instruction *InsertBefore = nullptr) {
2324 return new
2325 ExtractValueInst(Agg, Idxs, NameStr, InsertBefore);
2326 }
2327
2328 static ExtractValueInst *Create(Value *Agg,
2329 ArrayRef<unsigned> Idxs,
2330 const Twine &NameStr,
2331 BasicBlock *InsertAtEnd) {
2332 return new ExtractValueInst(Agg, Idxs, NameStr, InsertAtEnd);
2333 }
2334
2335 /// Returns the type of the element that would be extracted
2336 /// with an extractvalue instruction with the specified parameters.
2337 ///
2338 /// Null is returned if the indices are invalid for the specified type.
2339 static Type *getIndexedType(Type *Agg, ArrayRef<unsigned> Idxs);
2340
2341 using idx_iterator = const unsigned*;
2342
2343 inline idx_iterator idx_begin() const { return Indices.begin(); }
2344 inline idx_iterator idx_end() const { return Indices.end(); }
2345 inline iterator_range<idx_iterator> indices() const {
2346 return make_range(idx_begin(), idx_end());
2347 }
2348
2349 Value *getAggregateOperand() {
2350 return getOperand(0);
2351 }
2352 const Value *getAggregateOperand() const {
2353 return getOperand(0);
2354 }
2355 static unsigned getAggregateOperandIndex() {
2356 return 0U; // get index for modifying correct operand
2357 }
2358
2359 ArrayRef<unsigned> getIndices() const {
2360 return Indices;
2361 }
2362
2363 unsigned getNumIndices() const {
2364 return (unsigned)Indices.size();
2365 }
2366
2367 bool hasIndices() const {
2368 return true;
2369 }
2370
2371 // Methods for support type inquiry through isa, cast, and dyn_cast:
2372 static bool classof(const Instruction *I) {
2373 return I->getOpcode() == Instruction::ExtractValue;
2374 }
2375 static bool classof(const Value *V) {
2376 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2377 }
2378};
2379
2380ExtractValueInst::ExtractValueInst(Value *Agg,
2381 ArrayRef<unsigned> Idxs,
2382 const Twine &NameStr,
2383 Instruction *InsertBefore)
2384 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
2385 ExtractValue, Agg, InsertBefore) {
2386 init(Idxs, NameStr);
2387}
2388
2389ExtractValueInst::ExtractValueInst(Value *Agg,
2390 ArrayRef<unsigned> Idxs,
2391 const Twine &NameStr,
2392 BasicBlock *InsertAtEnd)
2393 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
2394 ExtractValue, Agg, InsertAtEnd) {
2395 init(Idxs, NameStr);
2396}
2397
2398//===----------------------------------------------------------------------===//
2399// InsertValueInst Class
2400//===----------------------------------------------------------------------===//
2401
2402/// This instruction inserts a struct field of array element
2403/// value into an aggregate value.
2404///
2405class InsertValueInst : public Instruction {
2406 SmallVector<unsigned, 4> Indices;
2407
2408 InsertValueInst(const InsertValueInst &IVI);
2409
2410 /// Constructors - Create a insertvalue instruction with a base aggregate
2411 /// value, a value to insert, and a list of indices. The first ctor can
2412 /// optionally insert before an existing instruction, the second appends
2413 /// the new instruction to the specified BasicBlock.
2414 inline InsertValueInst(Value *Agg, Value *Val,
2415 ArrayRef<unsigned> Idxs,
2416 const Twine &NameStr,
2417 Instruction *InsertBefore);
2418 inline InsertValueInst(Value *Agg, Value *Val,
2419 ArrayRef<unsigned> Idxs,
2420 const Twine &NameStr, BasicBlock *InsertAtEnd);
2421
2422 /// Constructors - These two constructors are convenience methods because one
2423 /// and two index insertvalue instructions are so common.
2424 InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
2425 const Twine &NameStr = "",
2426 Instruction *InsertBefore = nullptr);
2427 InsertValueInst(Value *Agg, Value *Val, unsigned Idx, const Twine &NameStr,
2428 BasicBlock *InsertAtEnd);
2429
2430 void init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs,
2431 const Twine &NameStr);
2432
2433protected:
2434 // Note: Instruction needs to be a friend here to call cloneImpl.
2435 friend class Instruction;
2436
2437 InsertValueInst *cloneImpl() const;
2438
2439public:
2440 // allocate space for exactly two operands
2441 void *operator new(size_t s) {
2442 return User::operator new(s, 2);
2443 }
2444
2445 static InsertValueInst *Create(Value *Agg, Value *Val,
2446 ArrayRef<unsigned> Idxs,
2447 const Twine &NameStr = "",
2448 Instruction *InsertBefore = nullptr) {
2449 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertBefore);
2450 }
2451
2452 static InsertValueInst *Create(Value *Agg, Value *Val,
2453 ArrayRef<unsigned> Idxs,
2454 const Twine &NameStr,
2455 BasicBlock *InsertAtEnd) {
2456 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertAtEnd);
2457 }
2458
2459 /// Transparently provide more efficient getOperand methods.
2460 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
2461
2462 using idx_iterator = const unsigned*;
2463
2464 inline idx_iterator idx_begin() const { return Indices.begin(); }
2465 inline idx_iterator idx_end() const { return Indices.end(); }
2466 inline iterator_range<idx_iterator> indices() const {
2467 return make_range(idx_begin(), idx_end());
2468 }
2469
2470 Value *getAggregateOperand() {
2471 return getOperand(0);
2472 }
2473 const Value *getAggregateOperand() const {
2474 return getOperand(0);
2475 }
2476 static unsigned getAggregateOperandIndex() {
2477 return 0U; // get index for modifying correct operand
2478 }
2479
2480 Value *getInsertedValueOperand() {
2481 return getOperand(1);
2482 }
2483 const Value *getInsertedValueOperand() const {
2484 return getOperand(1);
2485 }
2486 static unsigned getInsertedValueOperandIndex() {
2487 return 1U; // get index for modifying correct operand
2488 }
2489
2490 ArrayRef<unsigned> getIndices() const {
2491 return Indices;
2492 }
2493
2494 unsigned getNumIndices() const {
2495 return (unsigned)Indices.size();
2496 }
2497
2498 bool hasIndices() const {
2499 return true;
2500 }
2501
2502 // Methods for support type inquiry through isa, cast, and dyn_cast:
2503 static bool classof(const Instruction *I) {
2504 return I->getOpcode() == Instruction::InsertValue;
2505 }
2506 static bool classof(const Value *V) {
2507 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2508 }
2509};
2510
2511template <>
2512struct OperandTraits<InsertValueInst> :
2513 public FixedNumOperandTraits<InsertValueInst, 2> {
2514};
2515
2516InsertValueInst::InsertValueInst(Value *Agg,
2517 Value *Val,
2518 ArrayRef<unsigned> Idxs,
2519 const Twine &NameStr,
2520 Instruction *InsertBefore)
2521 : Instruction(Agg->getType(), InsertValue,
2522 OperandTraits<InsertValueInst>::op_begin(this),
2523 2, InsertBefore) {
2524 init(Agg, Val, Idxs, NameStr);
2525}
2526
2527InsertValueInst::InsertValueInst(Value *Agg,
2528 Value *Val,
2529 ArrayRef<unsigned> Idxs,
2530 const Twine &NameStr,
2531 BasicBlock *InsertAtEnd)
2532 : Instruction(Agg->getType(), InsertValue,
2533 OperandTraits<InsertValueInst>::op_begin(this),
2534 2, InsertAtEnd) {
2535 init(Agg, Val, Idxs, NameStr);
2536}
2537
2538DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)InsertValueInst::op_iterator InsertValueInst::op_begin() { return
OperandTraits<InsertValueInst>::op_begin(this); } InsertValueInst
::const_op_iterator InsertValueInst::op_begin() const { return
OperandTraits<InsertValueInst>::op_begin(const_cast<
InsertValueInst*>(this)); } InsertValueInst::op_iterator InsertValueInst
::op_end() { return OperandTraits<InsertValueInst>::op_end
(this); } InsertValueInst::const_op_iterator InsertValueInst::
op_end() const { return OperandTraits<InsertValueInst>::
op_end(const_cast<InsertValueInst*>(this)); } Value *InsertValueInst
::getOperand(unsigned i_nocapture) const { ((i_nocapture <
OperandTraits<InsertValueInst>::operands(this) &&
"getOperand() out of range!") ? static_cast<void> (0) :
__assert_fail ("i_nocapture < OperandTraits<InsertValueInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2538, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<InsertValueInst>::op_begin(const_cast<
InsertValueInst*>(this))[i_nocapture].get()); } void InsertValueInst
::setOperand(unsigned i_nocapture, Value *Val_nocapture) { ((
i_nocapture < OperandTraits<InsertValueInst>::operands
(this) && "setOperand() out of range!") ? static_cast
<void> (0) : __assert_fail ("i_nocapture < OperandTraits<InsertValueInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2538, __PRETTY_FUNCTION__)); OperandTraits<InsertValueInst
>::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned
InsertValueInst::getNumOperands() const { return OperandTraits
<InsertValueInst>::operands(this); } template <int Idx_nocapture
> Use &InsertValueInst::Op() { return this->OpFrom<
Idx_nocapture>(this); } template <int Idx_nocapture>
const Use &InsertValueInst::Op() const { return this->
OpFrom<Idx_nocapture>(this); }
2539
2540//===----------------------------------------------------------------------===//
2541// PHINode Class
2542//===----------------------------------------------------------------------===//
2543
2544// PHINode - The PHINode class is used to represent the magical mystical PHI
2545// node, that can not exist in nature, but can be synthesized in a computer
2546// scientist's overactive imagination.
2547//
2548class PHINode : public Instruction {
2549 /// The number of operands actually allocated. NumOperands is
2550 /// the number actually in use.
2551 unsigned ReservedSpace;
2552
2553 PHINode(const PHINode &PN);
2554
2555 explicit PHINode(Type *Ty, unsigned NumReservedValues,
2556 const Twine &NameStr = "",
2557 Instruction *InsertBefore = nullptr)
2558 : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertBefore),
2559 ReservedSpace(NumReservedValues) {
2560 setName(NameStr);
2561 allocHungoffUses(ReservedSpace);
2562 }
2563
2564 PHINode(Type *Ty, unsigned NumReservedValues, const Twine &NameStr,
2565 BasicBlock *InsertAtEnd)
2566 : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertAtEnd),
2567 ReservedSpace(NumReservedValues) {
2568 setName(NameStr);
2569 allocHungoffUses(ReservedSpace);
2570 }
2571
2572protected:
2573 // Note: Instruction needs to be a friend here to call cloneImpl.
2574 friend class Instruction;
2575
2576 PHINode *cloneImpl() const;
2577
2578 // allocHungoffUses - this is more complicated than the generic
2579 // User::allocHungoffUses, because we have to allocate Uses for the incoming
2580 // values and pointers to the incoming blocks, all in one allocation.
2581 void allocHungoffUses(unsigned N) {
2582 User::allocHungoffUses(N, /* IsPhi */ true);
2583 }
2584
2585public:
2586 /// Constructors - NumReservedValues is a hint for the number of incoming
2587 /// edges that this phi node will have (use 0 if you really have no idea).
2588 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2589 const Twine &NameStr = "",
2590 Instruction *InsertBefore = nullptr) {
2591 return new PHINode(Ty, NumReservedValues, NameStr, InsertBefore);
2592 }
2593
2594 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2595 const Twine &NameStr, BasicBlock *InsertAtEnd) {
2596 return new PHINode(Ty, NumReservedValues, NameStr, InsertAtEnd);
2597 }
2598
2599 /// Provide fast operand accessors
2600 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
2601
2602 // Block iterator interface. This provides access to the list of incoming
2603 // basic blocks, which parallels the list of incoming values.
2604
2605 using block_iterator = BasicBlock **;
2606 using const_block_iterator = BasicBlock * const *;
2607
2608 block_iterator block_begin() {
2609 return reinterpret_cast<block_iterator>(op_begin() + ReservedSpace);
2610 }
2611
2612 const_block_iterator block_begin() const {
2613 return reinterpret_cast<const_block_iterator>(op_begin() + ReservedSpace);
2614 }
2615
2616 block_iterator block_end() {
2617 return block_begin() + getNumOperands();
2618 }
2619
2620 const_block_iterator block_end() const {
2621 return block_begin() + getNumOperands();
2622 }
2623
2624 iterator_range<block_iterator> blocks() {
2625 return make_range(block_begin(), block_end());
2626 }
2627
2628 iterator_range<const_block_iterator> blocks() const {
2629 return make_range(block_begin(), block_end());
2630 }
2631
2632 op_range incoming_values() { return operands(); }
2633
2634 const_op_range incoming_values() const { return operands(); }
2635
2636 /// Return the number of incoming edges
2637 ///
2638 unsigned getNumIncomingValues() const { return getNumOperands(); }
2639
2640 /// Return incoming value number x
2641 ///
2642 Value *getIncomingValue(unsigned i) const {
2643 return getOperand(i);
2644 }
2645 void setIncomingValue(unsigned i, Value *V) {
2646 assert(V && "PHI node got a null value!")((V && "PHI node got a null value!") ? static_cast<
void> (0) : __assert_fail ("V && \"PHI node got a null value!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2646, __PRETTY_FUNCTION__))
;
2647 assert(getType() == V->getType() &&((getType() == V->getType() && "All operands to PHI node must be the same type as the PHI node!"
) ? static_cast<void> (0) : __assert_fail ("getType() == V->getType() && \"All operands to PHI node must be the same type as the PHI node!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2648, __PRETTY_FUNCTION__))
2648 "All operands to PHI node must be the same type as the PHI node!")((getType() == V->getType() && "All operands to PHI node must be the same type as the PHI node!"
) ? static_cast<void> (0) : __assert_fail ("getType() == V->getType() && \"All operands to PHI node must be the same type as the PHI node!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2648, __PRETTY_FUNCTION__))
;
2649 setOperand(i, V);
2650 }
2651
2652 static unsigned getOperandNumForIncomingValue(unsigned i) {
2653 return i;
2654 }
2655
2656 static unsigned getIncomingValueNumForOperand(unsigned i) {
2657 return i;
2658 }
2659
2660 /// Return incoming basic block number @p i.
2661 ///
2662 BasicBlock *getIncomingBlock(unsigned i) const {
2663 return block_begin()[i];
2664 }
2665
2666 /// Return incoming basic block corresponding
2667 /// to an operand of the PHI.
2668 ///
2669 BasicBlock *getIncomingBlock(const Use &U) const {
2670 assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?")((this == U.getUser() && "Iterator doesn't point to PHI's Uses?"
) ? static_cast<void> (0) : __assert_fail ("this == U.getUser() && \"Iterator doesn't point to PHI's Uses?\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2670, __PRETTY_FUNCTION__))
;
2671 return getIncomingBlock(unsigned(&U - op_begin()));
2672 }
2673
2674 /// Return incoming basic block corresponding
2675 /// to value use iterator.
2676 ///
2677 BasicBlock *getIncomingBlock(Value::const_user_iterator I) const {
2678 return getIncomingBlock(I.getUse());
2679 }
2680
2681 void setIncomingBlock(unsigned i, BasicBlock *BB) {
2682 assert(BB && "PHI node got a null basic block!")((BB && "PHI node got a null basic block!") ? static_cast
<void> (0) : __assert_fail ("BB && \"PHI node got a null basic block!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2682, __PRETTY_FUNCTION__))
;
2683 block_begin()[i] = BB;
2684 }
2685
2686 /// Replace every incoming basic block \p Old to basic block \p New.
2687 void replaceIncomingBlockWith(const BasicBlock *Old, BasicBlock *New) {
2688 assert(New && Old && "PHI node got a null basic block!")((New && Old && "PHI node got a null basic block!"
) ? static_cast<void> (0) : __assert_fail ("New && Old && \"PHI node got a null basic block!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2688, __PRETTY_FUNCTION__))
;
2689 for (unsigned Op = 0, NumOps = getNumOperands(); Op != NumOps; ++Op)
2690 if (getIncomingBlock(Op) == Old)
2691 setIncomingBlock(Op, New);
2692 }
2693
2694 /// Add an incoming value to the end of the PHI list
2695 ///
2696 void addIncoming(Value *V, BasicBlock *BB) {
2697 if (getNumOperands() == ReservedSpace)
2698 growOperands(); // Get more space!
2699 // Initialize some new operands.
2700 setNumHungOffUseOperands(getNumOperands() + 1);
2701 setIncomingValue(getNumOperands() - 1, V);
2702 setIncomingBlock(getNumOperands() - 1, BB);
2703 }
2704
2705 /// Remove an incoming value. This is useful if a
2706 /// predecessor basic block is deleted. The value removed is returned.
2707 ///
2708 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
2709 /// is true), the PHI node is destroyed and any uses of it are replaced with
2710 /// dummy values. The only time there should be zero incoming values to a PHI
2711 /// node is when the block is dead, so this strategy is sound.
2712 ///
2713 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
2714
2715 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
2716 int Idx = getBasicBlockIndex(BB);
2717 assert(Idx >= 0 && "Invalid basic block argument to remove!")((Idx >= 0 && "Invalid basic block argument to remove!"
) ? static_cast<void> (0) : __assert_fail ("Idx >= 0 && \"Invalid basic block argument to remove!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2717, __PRETTY_FUNCTION__))
;
2718 return removeIncomingValue(Idx, DeletePHIIfEmpty);
2719 }
2720
2721 /// Return the first index of the specified basic
2722 /// block in the value list for this PHI. Returns -1 if no instance.
2723 ///
2724 int getBasicBlockIndex(const BasicBlock *BB) const {
2725 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2726 if (block_begin()[i] == BB)
2727 return i;
2728 return -1;
2729 }
2730
2731 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
2732 int Idx = getBasicBlockIndex(BB);
2733 assert(Idx >= 0 && "Invalid basic block argument!")((Idx >= 0 && "Invalid basic block argument!") ? static_cast
<void> (0) : __assert_fail ("Idx >= 0 && \"Invalid basic block argument!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2733, __PRETTY_FUNCTION__))
;
2734 return getIncomingValue(Idx);
2735 }
2736
2737 /// Set every incoming value(s) for block \p BB to \p V.
2738 void setIncomingValueForBlock(const BasicBlock *BB, Value *V) {
2739 assert(BB && "PHI node got a null basic block!")((BB && "PHI node got a null basic block!") ? static_cast
<void> (0) : __assert_fail ("BB && \"PHI node got a null basic block!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2739, __PRETTY_FUNCTION__))
;
2740 bool Found = false;
2741 for (unsigned Op = 0, NumOps = getNumOperands(); Op != NumOps; ++Op)
2742 if (getIncomingBlock(Op) == BB) {
2743 Found = true;
2744 setIncomingValue(Op, V);
2745 }
2746 (void)Found;
2747 assert(Found && "Invalid basic block argument to set!")((Found && "Invalid basic block argument to set!") ? static_cast
<void> (0) : __assert_fail ("Found && \"Invalid basic block argument to set!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2747, __PRETTY_FUNCTION__))
;
2748 }
2749
2750 /// If the specified PHI node always merges together the
2751 /// same value, return the value, otherwise return null.
2752 Value *hasConstantValue() const;
2753
2754 /// Whether the specified PHI node always merges
2755 /// together the same value, assuming undefs are equal to a unique
2756 /// non-undef value.
2757 bool hasConstantOrUndefValue() const;
2758
2759 /// If the PHI node is complete which means all of its parent's predecessors
2760 /// have incoming value in this PHI, return true, otherwise return false.
2761 bool isComplete() const {
2762 return llvm::all_of(predecessors(getParent()),
2763 [this](const BasicBlock *Pred) {
2764 return getBasicBlockIndex(Pred) >= 0;
2765 });
2766 }
2767
2768 /// Methods for support type inquiry through isa, cast, and dyn_cast:
2769 static bool classof(const Instruction *I) {
2770 return I->getOpcode() == Instruction::PHI;
2771 }
2772 static bool classof(const Value *V) {
2773 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2774 }
2775
2776private:
2777 void growOperands();
2778};
2779
2780template <>
2781struct OperandTraits<PHINode> : public HungoffOperandTraits<2> {
2782};
2783
2784DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)PHINode::op_iterator PHINode::op_begin() { return OperandTraits
<PHINode>::op_begin(this); } PHINode::const_op_iterator
PHINode::op_begin() const { return OperandTraits<PHINode>
::op_begin(const_cast<PHINode*>(this)); } PHINode::op_iterator
PHINode::op_end() { return OperandTraits<PHINode>::op_end
(this); } PHINode::const_op_iterator PHINode::op_end() const {
return OperandTraits<PHINode>::op_end(const_cast<PHINode
*>(this)); } Value *PHINode::getOperand(unsigned i_nocapture
) const { ((i_nocapture < OperandTraits<PHINode>::operands
(this) && "getOperand() out of range!") ? static_cast
<void> (0) : __assert_fail ("i_nocapture < OperandTraits<PHINode>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2784, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<PHINode>::op_begin(const_cast<PHINode
*>(this))[i_nocapture].get()); } void PHINode::setOperand(
unsigned i_nocapture, Value *Val_nocapture) { ((i_nocapture <
OperandTraits<PHINode>::operands(this) && "setOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<PHINode>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2784, __PRETTY_FUNCTION__)); OperandTraits<PHINode>::
op_begin(this)[i_nocapture] = Val_nocapture; } unsigned PHINode
::getNumOperands() const { return OperandTraits<PHINode>
::operands(this); } template <int Idx_nocapture> Use &
PHINode::Op() { return this->OpFrom<Idx_nocapture>(this
); } template <int Idx_nocapture> const Use &PHINode
::Op() const { return this->OpFrom<Idx_nocapture>(this
); }
2785
2786//===----------------------------------------------------------------------===//
2787// LandingPadInst Class
2788//===----------------------------------------------------------------------===//
2789
2790//===---------------------------------------------------------------------------
2791/// The landingpad instruction holds all of the information
2792/// necessary to generate correct exception handling. The landingpad instruction
2793/// cannot be moved from the top of a landing pad block, which itself is
2794/// accessible only from the 'unwind' edge of an invoke. This uses the
2795/// SubclassData field in Value to store whether or not the landingpad is a
2796/// cleanup.
2797///
2798class LandingPadInst : public Instruction {
2799 using CleanupField = BoolBitfieldElementT<0>;
2800
2801 /// The number of operands actually allocated. NumOperands is
2802 /// the number actually in use.
2803 unsigned ReservedSpace;
2804
2805 LandingPadInst(const LandingPadInst &LP);
2806
2807public:
2808 enum ClauseType { Catch, Filter };
2809
2810private:
2811 explicit LandingPadInst(Type *RetTy, unsigned NumReservedValues,
2812 const Twine &NameStr, Instruction *InsertBefore);
2813 explicit LandingPadInst(Type *RetTy, unsigned NumReservedValues,
2814 const Twine &NameStr, BasicBlock *InsertAtEnd);
2815
2816 // Allocate space for exactly zero operands.
2817 void *operator new(size_t s) {
2818 return User::operator new(s);
2819 }
2820
2821 void growOperands(unsigned Size);
2822 void init(unsigned NumReservedValues, const Twine &NameStr);
2823
2824protected:
2825 // Note: Instruction needs to be a friend here to call cloneImpl.
2826 friend class Instruction;
2827
2828 LandingPadInst *cloneImpl() const;
2829
2830public:
2831 /// Constructors - NumReservedClauses is a hint for the number of incoming
2832 /// clauses that this landingpad will have (use 0 if you really have no idea).
2833 static LandingPadInst *Create(Type *RetTy, unsigned NumReservedClauses,
2834 const Twine &NameStr = "",
2835 Instruction *InsertBefore = nullptr);
2836 static LandingPadInst *Create(Type *RetTy, unsigned NumReservedClauses,
2837 const Twine &NameStr, BasicBlock *InsertAtEnd);
2838
2839 /// Provide fast operand accessors
2840 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
2841
2842 /// Return 'true' if this landingpad instruction is a
2843 /// cleanup. I.e., it should be run when unwinding even if its landing pad
2844 /// doesn't catch the exception.
2845 bool isCleanup() const { return getSubclassData<CleanupField>(); }
2846
2847 /// Indicate that this landingpad instruction is a cleanup.
2848 void setCleanup(bool V) { setSubclassData<CleanupField>(V); }
2849
2850 /// Add a catch or filter clause to the landing pad.
2851 void addClause(Constant *ClauseVal);
2852
2853 /// Get the value of the clause at index Idx. Use isCatch/isFilter to
2854 /// determine what type of clause this is.
2855 Constant *getClause(unsigned Idx) const {
2856 return cast<Constant>(getOperandList()[Idx]);
2857 }
2858
2859 /// Return 'true' if the clause and index Idx is a catch clause.
2860 bool isCatch(unsigned Idx) const {
2861 return !isa<ArrayType>(getOperandList()[Idx]->getType());
2862 }
2863
2864 /// Return 'true' if the clause and index Idx is a filter clause.
2865 bool isFilter(unsigned Idx) const {
2866 return isa<ArrayType>(getOperandList()[Idx]->getType());
2867 }
2868
2869 /// Get the number of clauses for this landing pad.
2870 unsigned getNumClauses() const { return getNumOperands(); }
2871
2872 /// Grow the size of the operand list to accommodate the new
2873 /// number of clauses.
2874 void reserveClauses(unsigned Size) { growOperands(Size); }
2875
2876 // Methods for support type inquiry through isa, cast, and dyn_cast:
2877 static bool classof(const Instruction *I) {
2878 return I->getOpcode() == Instruction::LandingPad;
2879 }
2880 static bool classof(const Value *V) {
2881 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2882 }
2883};
2884
2885template <>
2886struct OperandTraits<LandingPadInst> : public HungoffOperandTraits<1> {
2887};
2888
2889DEFINE_TRANSPARENT_OPERAND_ACCESSORS(LandingPadInst, Value)LandingPadInst::op_iterator LandingPadInst::op_begin() { return
OperandTraits<LandingPadInst>::op_begin(this); } LandingPadInst
::const_op_iterator LandingPadInst::op_begin() const { return
OperandTraits<LandingPadInst>::op_begin(const_cast<
LandingPadInst*>(this)); } LandingPadInst::op_iterator LandingPadInst
::op_end() { return OperandTraits<LandingPadInst>::op_end
(this); } LandingPadInst::const_op_iterator LandingPadInst::op_end
() const { return OperandTraits<LandingPadInst>::op_end
(const_cast<LandingPadInst*>(this)); } Value *LandingPadInst
::getOperand(unsigned i_nocapture) const { ((i_nocapture <
OperandTraits<LandingPadInst>::operands(this) &&
"getOperand() out of range!") ? static_cast<void> (0) :
__assert_fail ("i_nocapture < OperandTraits<LandingPadInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2889, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<LandingPadInst>::op_begin(const_cast<
LandingPadInst*>(this))[i_nocapture].get()); } void LandingPadInst
::setOperand(unsigned i_nocapture, Value *Val_nocapture) { ((
i_nocapture < OperandTraits<LandingPadInst>::operands
(this) && "setOperand() out of range!") ? static_cast
<void> (0) : __assert_fail ("i_nocapture < OperandTraits<LandingPadInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2889, __PRETTY_FUNCTION__)); OperandTraits<LandingPadInst
>::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned
LandingPadInst::getNumOperands() const { return OperandTraits
<LandingPadInst>::operands(this); } template <int Idx_nocapture
> Use &LandingPadInst::Op() { return this->OpFrom<
Idx_nocapture>(this); } template <int Idx_nocapture>
const Use &LandingPadInst::Op() const { return this->
OpFrom<Idx_nocapture>(this); }
2890
2891//===----------------------------------------------------------------------===//
2892// ReturnInst Class
2893//===----------------------------------------------------------------------===//
2894
2895//===---------------------------------------------------------------------------
2896/// Return a value (possibly void), from a function. Execution
2897/// does not continue in this function any longer.
2898///
2899class ReturnInst : public Instruction {
2900 ReturnInst(const ReturnInst &RI);
2901
2902private:
2903 // ReturnInst constructors:
2904 // ReturnInst() - 'ret void' instruction
2905 // ReturnInst( null) - 'ret void' instruction
2906 // ReturnInst(Value* X) - 'ret X' instruction
2907 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
2908 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
2909 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
2910 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
2911 //
2912 // NOTE: If the Value* passed is of type void then the constructor behaves as
2913 // if it was passed NULL.
2914 explicit ReturnInst(LLVMContext &C, Value *retVal = nullptr,
2915 Instruction *InsertBefore = nullptr);
2916 ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd);
2917 explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2918
2919protected:
2920 // Note: Instruction needs to be a friend here to call cloneImpl.
2921 friend class Instruction;
2922
2923 ReturnInst *cloneImpl() const;
2924
2925public:
2926 static ReturnInst* Create(LLVMContext &C, Value *retVal = nullptr,
2927 Instruction *InsertBefore = nullptr) {
2928 return new(!!retVal) ReturnInst(C, retVal, InsertBefore);
2929 }
2930
2931 static ReturnInst* Create(LLVMContext &C, Value *retVal,
2932 BasicBlock *InsertAtEnd) {
2933 return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd);
2934 }
2935
2936 static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) {
2937 return new(0) ReturnInst(C, InsertAtEnd);
2938 }
2939
2940 /// Provide fast operand accessors
2941 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
2942
2943 /// Convenience accessor. Returns null if there is no return value.
2944 Value *getReturnValue() const {
2945 return getNumOperands() != 0 ? getOperand(0) : nullptr;
2946 }
2947
2948 unsigned getNumSuccessors() const { return 0; }
2949
2950 // Methods for support type inquiry through isa, cast, and dyn_cast:
2951 static bool classof(const Instruction *I) {
2952 return (I->getOpcode() == Instruction::Ret);
2953 }
2954 static bool classof(const Value *V) {
2955 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2956 }
2957
2958private:
2959 BasicBlock *getSuccessor(unsigned idx) const {
2960 llvm_unreachable("ReturnInst has no successors!")::llvm::llvm_unreachable_internal("ReturnInst has no successors!"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2960)
;
2961 }
2962
2963 void setSuccessor(unsigned idx, BasicBlock *B) {
2964 llvm_unreachable("ReturnInst has no successors!")::llvm::llvm_unreachable_internal("ReturnInst has no successors!"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2964)
;
2965 }
2966};
2967
2968template <>
2969struct OperandTraits<ReturnInst> : public VariadicOperandTraits<ReturnInst> {
2970};
2971
2972DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)ReturnInst::op_iterator ReturnInst::op_begin() { return OperandTraits
<ReturnInst>::op_begin(this); } ReturnInst::const_op_iterator
ReturnInst::op_begin() const { return OperandTraits<ReturnInst
>::op_begin(const_cast<ReturnInst*>(this)); } ReturnInst
::op_iterator ReturnInst::op_end() { return OperandTraits<
ReturnInst>::op_end(this); } ReturnInst::const_op_iterator
ReturnInst::op_end() const { return OperandTraits<ReturnInst
>::op_end(const_cast<ReturnInst*>(this)); } Value *ReturnInst
::getOperand(unsigned i_nocapture) const { ((i_nocapture <
OperandTraits<ReturnInst>::operands(this) && "getOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<ReturnInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2972, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<ReturnInst>::op_begin(const_cast<ReturnInst
*>(this))[i_nocapture].get()); } void ReturnInst::setOperand
(unsigned i_nocapture, Value *Val_nocapture) { ((i_nocapture <
OperandTraits<ReturnInst>::operands(this) && "setOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<ReturnInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 2972, __PRETTY_FUNCTION__)); OperandTraits<ReturnInst>
::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned ReturnInst
::getNumOperands() const { return OperandTraits<ReturnInst
>::operands(this); } template <int Idx_nocapture> Use
&ReturnInst::Op() { return this->OpFrom<Idx_nocapture
>(this); } template <int Idx_nocapture> const Use &
ReturnInst::Op() const { return this->OpFrom<Idx_nocapture
>(this); }
2973
2974//===----------------------------------------------------------------------===//
2975// BranchInst Class
2976//===----------------------------------------------------------------------===//
2977
2978//===---------------------------------------------------------------------------
2979/// Conditional or Unconditional Branch instruction.
2980///
2981class BranchInst : public Instruction {
2982 /// Ops list - Branches are strange. The operands are ordered:
2983 /// [Cond, FalseDest,] TrueDest. This makes some accessors faster because
2984 /// they don't have to check for cond/uncond branchness. These are mostly
2985 /// accessed relative from op_end().
2986 BranchInst(const BranchInst &BI);
2987 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2988 // BranchInst(BB *B) - 'br B'
2989 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
2990 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
2991 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2992 // BranchInst(BB* B, BB *I) - 'br B' insert at end
2993 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
2994 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = nullptr);
2995 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2996 Instruction *InsertBefore = nullptr);
2997 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2998 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2999 BasicBlock *InsertAtEnd);
3000
3001 void AssertOK();
3002
3003protected:
3004 // Note: Instruction needs to be a friend here to call cloneImpl.
3005 friend class Instruction;
3006
3007 BranchInst *cloneImpl() const;
3008
3009public:
3010 /// Iterator type that casts an operand to a basic block.
3011 ///
3012 /// This only makes sense because the successors are stored as adjacent
3013 /// operands for branch instructions.
3014 struct succ_op_iterator
3015 : iterator_adaptor_base<succ_op_iterator, value_op_iterator,
3016 std::random_access_iterator_tag, BasicBlock *,
3017 ptrdiff_t, BasicBlock *, BasicBlock *> {
3018 explicit succ_op_iterator(value_op_iterator I) : iterator_adaptor_base(I) {}
3019
3020 BasicBlock *operator*() const { return cast<BasicBlock>(*I); }
3021 BasicBlock *operator->() const { return operator*(); }
3022 };
3023
3024 /// The const version of `succ_op_iterator`.
3025 struct const_succ_op_iterator
3026 : iterator_adaptor_base<const_succ_op_iterator, const_value_op_iterator,
3027 std::random_access_iterator_tag,
3028 const BasicBlock *, ptrdiff_t, const BasicBlock *,
3029 const BasicBlock *> {
3030 explicit const_succ_op_iterator(const_value_op_iterator I)
3031 : iterator_adaptor_base(I) {}
3032
3033 const BasicBlock *operator*() const { return cast<BasicBlock>(*I); }
3034 const BasicBlock *operator->() const { return operator*(); }
3035 };
3036
3037 static BranchInst *Create(BasicBlock *IfTrue,
3038 Instruction *InsertBefore = nullptr) {
3039 return new(1) BranchInst(IfTrue, InsertBefore);
3040 }
3041
3042 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
3043 Value *Cond, Instruction *InsertBefore = nullptr) {
3044 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
3045 }
3046
3047 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
3048 return new(1) BranchInst(IfTrue, InsertAtEnd);
3049 }
3050
3051 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
3052 Value *Cond, BasicBlock *InsertAtEnd) {
3053 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
3054 }
3055
3056 /// Transparently provide more efficient getOperand methods.
3057 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
3058
3059 bool isUnconditional() const { return getNumOperands() == 1; }
3060 bool isConditional() const { return getNumOperands() == 3; }
3061
3062 Value *getCondition() const {
3063 assert(isConditional() && "Cannot get condition of an uncond branch!")((isConditional() && "Cannot get condition of an uncond branch!"
) ? static_cast<void> (0) : __assert_fail ("isConditional() && \"Cannot get condition of an uncond branch!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3063, __PRETTY_FUNCTION__))
;
3064 return Op<-3>();
3065 }
3066
3067 void setCondition(Value *V) {
3068 assert(isConditional() && "Cannot set condition of unconditional branch!")((isConditional() && "Cannot set condition of unconditional branch!"
) ? static_cast<void> (0) : __assert_fail ("isConditional() && \"Cannot set condition of unconditional branch!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3068, __PRETTY_FUNCTION__))
;
3069 Op<-3>() = V;
3070 }
3071
3072 unsigned getNumSuccessors() const { return 1+isConditional(); }
3073
3074 BasicBlock *getSuccessor(unsigned i) const {
3075 assert(i < getNumSuccessors() && "Successor # out of range for Branch!")((i < getNumSuccessors() && "Successor # out of range for Branch!"
) ? static_cast<void> (0) : __assert_fail ("i < getNumSuccessors() && \"Successor # out of range for Branch!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3075, __PRETTY_FUNCTION__))
;
3076 return cast_or_null<BasicBlock>((&Op<-1>() - i)->get());
3077 }
3078
3079 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3080 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!")((idx < getNumSuccessors() && "Successor # out of range for Branch!"
) ? static_cast<void> (0) : __assert_fail ("idx < getNumSuccessors() && \"Successor # out of range for Branch!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3080, __PRETTY_FUNCTION__))
;
3081 *(&Op<-1>() - idx) = NewSucc;
3082 }
3083
3084 /// Swap the successors of this branch instruction.
3085 ///
3086 /// Swaps the successors of the branch instruction. This also swaps any
3087 /// branch weight metadata associated with the instruction so that it
3088 /// continues to map correctly to each operand.
3089 void swapSuccessors();
3090
3091 iterator_range<succ_op_iterator> successors() {
3092 return make_range(
3093 succ_op_iterator(std::next(value_op_begin(), isConditional() ? 1 : 0)),
3094 succ_op_iterator(value_op_end()));
3095 }
3096
3097 iterator_range<const_succ_op_iterator> successors() const {
3098 return make_range(const_succ_op_iterator(
3099 std::next(value_op_begin(), isConditional() ? 1 : 0)),
3100 const_succ_op_iterator(value_op_end()));
3101 }
3102
3103 // Methods for support type inquiry through isa, cast, and dyn_cast:
3104 static bool classof(const Instruction *I) {
3105 return (I->getOpcode() == Instruction::Br);
3106 }
3107 static bool classof(const Value *V) {
3108 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3109 }
3110};
3111
3112template <>
3113struct OperandTraits<BranchInst> : public VariadicOperandTraits<BranchInst, 1> {
3114};
3115
3116DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)BranchInst::op_iterator BranchInst::op_begin() { return OperandTraits
<BranchInst>::op_begin(this); } BranchInst::const_op_iterator
BranchInst::op_begin() const { return OperandTraits<BranchInst
>::op_begin(const_cast<BranchInst*>(this)); } BranchInst
::op_iterator BranchInst::op_end() { return OperandTraits<
BranchInst>::op_end(this); } BranchInst::const_op_iterator
BranchInst::op_end() const { return OperandTraits<BranchInst
>::op_end(const_cast<BranchInst*>(this)); } Value *BranchInst
::getOperand(unsigned i_nocapture) const { ((i_nocapture <
OperandTraits<BranchInst>::operands(this) && "getOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<BranchInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3116, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<BranchInst>::op_begin(const_cast<BranchInst
*>(this))[i_nocapture].get()); } void BranchInst::setOperand
(unsigned i_nocapture, Value *Val_nocapture) { ((i_nocapture <
OperandTraits<BranchInst>::operands(this) && "setOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<BranchInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3116, __PRETTY_FUNCTION__)); OperandTraits<BranchInst>
::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned BranchInst
::getNumOperands() const { return OperandTraits<BranchInst
>::operands(this); } template <int Idx_nocapture> Use
&BranchInst::Op() { return this->OpFrom<Idx_nocapture
>(this); } template <int Idx_nocapture> const Use &
BranchInst::Op() const { return this->OpFrom<Idx_nocapture
>(this); }
3117
3118//===----------------------------------------------------------------------===//
3119// SwitchInst Class
3120//===----------------------------------------------------------------------===//
3121
3122//===---------------------------------------------------------------------------
3123/// Multiway switch
3124///
3125class SwitchInst : public Instruction {
3126 unsigned ReservedSpace;
3127
3128 // Operand[0] = Value to switch on
3129 // Operand[1] = Default basic block destination
3130 // Operand[2n ] = Value to match
3131 // Operand[2n+1] = BasicBlock to go to on match
3132 SwitchInst(const SwitchInst &SI);
3133
3134 /// Create a new switch instruction, specifying a value to switch on and a
3135 /// default destination. The number of additional cases can be specified here
3136 /// to make memory allocation more efficient. This constructor can also
3137 /// auto-insert before another instruction.
3138 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
3139 Instruction *InsertBefore);
3140
3141 /// Create a new switch instruction, specifying a value to switch on and a
3142 /// default destination. The number of additional cases can be specified here
3143 /// to make memory allocation more efficient. This constructor also
3144 /// auto-inserts at the end of the specified BasicBlock.
3145 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
3146 BasicBlock *InsertAtEnd);
3147
3148 // allocate space for exactly zero operands
3149 void *operator new(size_t s) {
3150 return User::operator new(s);
3151 }
3152
3153 void init(Value *Value, BasicBlock *Default, unsigned NumReserved);
3154 void growOperands();
3155
3156protected:
3157 // Note: Instruction needs to be a friend here to call cloneImpl.
3158 friend class Instruction;
3159
3160 SwitchInst *cloneImpl() const;
3161
3162public:
3163 // -2
3164 static const unsigned DefaultPseudoIndex = static_cast<unsigned>(~0L-1);
3165
3166 template <typename CaseHandleT> class CaseIteratorImpl;
3167
3168 /// A handle to a particular switch case. It exposes a convenient interface
3169 /// to both the case value and the successor block.
3170 ///
3171 /// We define this as a template and instantiate it to form both a const and
3172 /// non-const handle.
3173 template <typename SwitchInstT, typename ConstantIntT, typename BasicBlockT>
3174 class CaseHandleImpl {
3175 // Directly befriend both const and non-const iterators.
3176 friend class SwitchInst::CaseIteratorImpl<
3177 CaseHandleImpl<SwitchInstT, ConstantIntT, BasicBlockT>>;
3178
3179 protected:
3180 // Expose the switch type we're parameterized with to the iterator.
3181 using SwitchInstType = SwitchInstT;
3182
3183 SwitchInstT *SI;
3184 ptrdiff_t Index;
3185
3186 CaseHandleImpl() = default;
3187 CaseHandleImpl(SwitchInstT *SI, ptrdiff_t Index) : SI(SI), Index(Index) {}
3188
3189 public:
3190 /// Resolves case value for current case.
3191 ConstantIntT *getCaseValue() const {
3192 assert((unsigned)Index < SI->getNumCases() &&(((unsigned)Index < SI->getNumCases() && "Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("(unsigned)Index < SI->getNumCases() && \"Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3193, __PRETTY_FUNCTION__))
3193 "Index out the number of cases.")(((unsigned)Index < SI->getNumCases() && "Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("(unsigned)Index < SI->getNumCases() && \"Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3193, __PRETTY_FUNCTION__))
;
3194 return reinterpret_cast<ConstantIntT *>(SI->getOperand(2 + Index * 2));
3195 }
3196
3197 /// Resolves successor for current case.
3198 BasicBlockT *getCaseSuccessor() const {
3199 assert(((unsigned)Index < SI->getNumCases() ||((((unsigned)Index < SI->getNumCases() || (unsigned)Index
== DefaultPseudoIndex) && "Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("((unsigned)Index < SI->getNumCases() || (unsigned)Index == DefaultPseudoIndex) && \"Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3201, __PRETTY_FUNCTION__))
3200 (unsigned)Index == DefaultPseudoIndex) &&((((unsigned)Index < SI->getNumCases() || (unsigned)Index
== DefaultPseudoIndex) && "Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("((unsigned)Index < SI->getNumCases() || (unsigned)Index == DefaultPseudoIndex) && \"Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3201, __PRETTY_FUNCTION__))
3201 "Index out the number of cases.")((((unsigned)Index < SI->getNumCases() || (unsigned)Index
== DefaultPseudoIndex) && "Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("((unsigned)Index < SI->getNumCases() || (unsigned)Index == DefaultPseudoIndex) && \"Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3201, __PRETTY_FUNCTION__))
;
3202 return SI->getSuccessor(getSuccessorIndex());
3203 }
3204
3205 /// Returns number of current case.
3206 unsigned getCaseIndex() const { return Index; }
3207
3208 /// Returns successor index for current case successor.
3209 unsigned getSuccessorIndex() const {
3210 assert(((unsigned)Index == DefaultPseudoIndex ||((((unsigned)Index == DefaultPseudoIndex || (unsigned)Index <
SI->getNumCases()) && "Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("((unsigned)Index == DefaultPseudoIndex || (unsigned)Index < SI->getNumCases()) && \"Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3212, __PRETTY_FUNCTION__))
3211 (unsigned)Index < SI->getNumCases()) &&((((unsigned)Index == DefaultPseudoIndex || (unsigned)Index <
SI->getNumCases()) && "Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("((unsigned)Index == DefaultPseudoIndex || (unsigned)Index < SI->getNumCases()) && \"Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3212, __PRETTY_FUNCTION__))
3212 "Index out the number of cases.")((((unsigned)Index == DefaultPseudoIndex || (unsigned)Index <
SI->getNumCases()) && "Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("((unsigned)Index == DefaultPseudoIndex || (unsigned)Index < SI->getNumCases()) && \"Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3212, __PRETTY_FUNCTION__))
;
3213 return (unsigned)Index != DefaultPseudoIndex ? Index + 1 : 0;
3214 }
3215
3216 bool operator==(const CaseHandleImpl &RHS) const {
3217 assert(SI == RHS.SI && "Incompatible operators.")((SI == RHS.SI && "Incompatible operators.") ? static_cast
<void> (0) : __assert_fail ("SI == RHS.SI && \"Incompatible operators.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3217, __PRETTY_FUNCTION__))
;
3218 return Index == RHS.Index;
3219 }
3220 };
3221
3222 using ConstCaseHandle =
3223 CaseHandleImpl<const SwitchInst, const ConstantInt, const BasicBlock>;
3224
3225 class CaseHandle
3226 : public CaseHandleImpl<SwitchInst, ConstantInt, BasicBlock> {
3227 friend class SwitchInst::CaseIteratorImpl<CaseHandle>;
3228
3229 public:
3230 CaseHandle(SwitchInst *SI, ptrdiff_t Index) : CaseHandleImpl(SI, Index) {}
3231
3232 /// Sets the new value for current case.
3233 void setValue(ConstantInt *V) {
3234 assert((unsigned)Index < SI->getNumCases() &&(((unsigned)Index < SI->getNumCases() && "Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("(unsigned)Index < SI->getNumCases() && \"Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3235, __PRETTY_FUNCTION__))
3235 "Index out the number of cases.")(((unsigned)Index < SI->getNumCases() && "Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("(unsigned)Index < SI->getNumCases() && \"Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3235, __PRETTY_FUNCTION__))
;
3236 SI->setOperand(2 + Index*2, reinterpret_cast<Value*>(V));
3237 }
3238
3239 /// Sets the new successor for current case.
3240 void setSuccessor(BasicBlock *S) {
3241 SI->setSuccessor(getSuccessorIndex(), S);
3242 }
3243 };
3244
3245 template <typename CaseHandleT>
3246 class CaseIteratorImpl
3247 : public iterator_facade_base<CaseIteratorImpl<CaseHandleT>,
3248 std::random_access_iterator_tag,
3249 CaseHandleT> {
3250 using SwitchInstT = typename CaseHandleT::SwitchInstType;
3251
3252 CaseHandleT Case;
3253
3254 public:
3255 /// Default constructed iterator is in an invalid state until assigned to
3256 /// a case for a particular switch.
3257 CaseIteratorImpl() = default;
3258
3259 /// Initializes case iterator for given SwitchInst and for given
3260 /// case number.
3261 CaseIteratorImpl(SwitchInstT *SI, unsigned CaseNum) : Case(SI, CaseNum) {}
3262
3263 /// Initializes case iterator for given SwitchInst and for given
3264 /// successor index.
3265 static CaseIteratorImpl fromSuccessorIndex(SwitchInstT *SI,
3266 unsigned SuccessorIndex) {
3267 assert(SuccessorIndex < SI->getNumSuccessors() &&((SuccessorIndex < SI->getNumSuccessors() && "Successor index # out of range!"
) ? static_cast<void> (0) : __assert_fail ("SuccessorIndex < SI->getNumSuccessors() && \"Successor index # out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3268, __PRETTY_FUNCTION__))
3268 "Successor index # out of range!")((SuccessorIndex < SI->getNumSuccessors() && "Successor index # out of range!"
) ? static_cast<void> (0) : __assert_fail ("SuccessorIndex < SI->getNumSuccessors() && \"Successor index # out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3268, __PRETTY_FUNCTION__))
;
3269 return SuccessorIndex != 0 ? CaseIteratorImpl(SI, SuccessorIndex - 1)
3270 : CaseIteratorImpl(SI, DefaultPseudoIndex);
3271 }
3272
3273 /// Support converting to the const variant. This will be a no-op for const
3274 /// variant.
3275 operator CaseIteratorImpl<ConstCaseHandle>() const {
3276 return CaseIteratorImpl<ConstCaseHandle>(Case.SI, Case.Index);
3277 }
3278
3279 CaseIteratorImpl &operator+=(ptrdiff_t N) {
3280 // Check index correctness after addition.
3281 // Note: Index == getNumCases() means end().
3282 assert(Case.Index + N >= 0 &&((Case.Index + N >= 0 && (unsigned)(Case.Index + N
) <= Case.SI->getNumCases() && "Case.Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("Case.Index + N >= 0 && (unsigned)(Case.Index + N) <= Case.SI->getNumCases() && \"Case.Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3284, __PRETTY_FUNCTION__))
3283 (unsigned)(Case.Index + N) <= Case.SI->getNumCases() &&((Case.Index + N >= 0 && (unsigned)(Case.Index + N
) <= Case.SI->getNumCases() && "Case.Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("Case.Index + N >= 0 && (unsigned)(Case.Index + N) <= Case.SI->getNumCases() && \"Case.Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3284, __PRETTY_FUNCTION__))
3284 "Case.Index out the number of cases.")((Case.Index + N >= 0 && (unsigned)(Case.Index + N
) <= Case.SI->getNumCases() && "Case.Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("Case.Index + N >= 0 && (unsigned)(Case.Index + N) <= Case.SI->getNumCases() && \"Case.Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3284, __PRETTY_FUNCTION__))
;
3285 Case.Index += N;
3286 return *this;
3287 }
3288 CaseIteratorImpl &operator-=(ptrdiff_t N) {
3289 // Check index correctness after subtraction.
3290 // Note: Case.Index == getNumCases() means end().
3291 assert(Case.Index - N >= 0 &&((Case.Index - N >= 0 && (unsigned)(Case.Index - N
) <= Case.SI->getNumCases() && "Case.Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("Case.Index - N >= 0 && (unsigned)(Case.Index - N) <= Case.SI->getNumCases() && \"Case.Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3293, __PRETTY_FUNCTION__))
3292 (unsigned)(Case.Index - N) <= Case.SI->getNumCases() &&((Case.Index - N >= 0 && (unsigned)(Case.Index - N
) <= Case.SI->getNumCases() && "Case.Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("Case.Index - N >= 0 && (unsigned)(Case.Index - N) <= Case.SI->getNumCases() && \"Case.Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3293, __PRETTY_FUNCTION__))
3293 "Case.Index out the number of cases.")((Case.Index - N >= 0 && (unsigned)(Case.Index - N
) <= Case.SI->getNumCases() && "Case.Index out the number of cases."
) ? static_cast<void> (0) : __assert_fail ("Case.Index - N >= 0 && (unsigned)(Case.Index - N) <= Case.SI->getNumCases() && \"Case.Index out the number of cases.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3293, __PRETTY_FUNCTION__))
;
3294 Case.Index -= N;
3295 return *this;
3296 }
3297 ptrdiff_t operator-(const CaseIteratorImpl &RHS) const {
3298 assert(Case.SI == RHS.Case.SI && "Incompatible operators.")((Case.SI == RHS.Case.SI && "Incompatible operators."
) ? static_cast<void> (0) : __assert_fail ("Case.SI == RHS.Case.SI && \"Incompatible operators.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3298, __PRETTY_FUNCTION__))
;
3299 return Case.Index - RHS.Case.Index;
3300 }
3301 bool operator==(const CaseIteratorImpl &RHS) const {
3302 return Case == RHS.Case;
3303 }
3304 bool operator<(const CaseIteratorImpl &RHS) const {
3305 assert(Case.SI == RHS.Case.SI && "Incompatible operators.")((Case.SI == RHS.Case.SI && "Incompatible operators."
) ? static_cast<void> (0) : __assert_fail ("Case.SI == RHS.Case.SI && \"Incompatible operators.\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3305, __PRETTY_FUNCTION__))
;
3306 return Case.Index < RHS.Case.Index;
3307 }
3308 CaseHandleT &operator*() { return Case; }
3309 const CaseHandleT &operator*() const { return Case; }
3310 };
3311
3312 using CaseIt = CaseIteratorImpl<CaseHandle>;
3313 using ConstCaseIt = CaseIteratorImpl<ConstCaseHandle>;
3314
3315 static SwitchInst *Create(Value *Value, BasicBlock *Default,
3316 unsigned NumCases,
3317 Instruction *InsertBefore = nullptr) {
3318 return new SwitchInst(Value, Default, NumCases, InsertBefore);
3319 }
3320
3321 static SwitchInst *Create(Value *Value, BasicBlock *Default,
3322 unsigned NumCases, BasicBlock *InsertAtEnd) {
3323 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
3324 }
3325
3326 /// Provide fast operand accessors
3327 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
3328
3329 // Accessor Methods for Switch stmt
3330 Value *getCondition() const { return getOperand(0); }
3331 void setCondition(Value *V) { setOperand(0, V); }
3332
3333 BasicBlock *getDefaultDest() const {
3334 return cast<BasicBlock>(getOperand(1));
3335 }
3336
3337 void setDefaultDest(BasicBlock *DefaultCase) {
3338 setOperand(1, reinterpret_cast<Value*>(DefaultCase));
3339 }
3340
3341 /// Return the number of 'cases' in this switch instruction, excluding the
3342 /// default case.
3343 unsigned getNumCases() const {
3344 return getNumOperands()/2 - 1;
3345 }
3346
3347 /// Returns a read/write iterator that points to the first case in the
3348 /// SwitchInst.
3349 CaseIt case_begin() {
3350 return CaseIt(this, 0);
3351 }
3352
3353 /// Returns a read-only iterator that points to the first case in the
3354 /// SwitchInst.
3355 ConstCaseIt case_begin() const {
3356 return ConstCaseIt(this, 0);
3357 }
3358
3359 /// Returns a read/write iterator that points one past the last in the
3360 /// SwitchInst.
3361 CaseIt case_end() {
3362 return CaseIt(this, getNumCases());
3363 }
3364
3365 /// Returns a read-only iterator that points one past the last in the
3366 /// SwitchInst.
3367 ConstCaseIt case_end() const {
3368 return ConstCaseIt(this, getNumCases());
3369 }
3370
3371 /// Iteration adapter for range-for loops.
3372 iterator_range<CaseIt> cases() {
3373 return make_range(case_begin(), case_end());
3374 }
3375
3376 /// Constant iteration adapter for range-for loops.
3377 iterator_range<ConstCaseIt> cases() const {
3378 return make_range(case_begin(), case_end());
3379 }
3380
3381 /// Returns an iterator that points to the default case.
3382 /// Note: this iterator allows to resolve successor only. Attempt
3383 /// to resolve case value causes an assertion.
3384 /// Also note, that increment and decrement also causes an assertion and
3385 /// makes iterator invalid.
3386 CaseIt case_default() {
3387 return CaseIt(this, DefaultPseudoIndex);
3388 }
3389 ConstCaseIt case_default() const {
3390 return ConstCaseIt(this, DefaultPseudoIndex);
3391 }
3392
3393 /// Search all of the case values for the specified constant. If it is
3394 /// explicitly handled, return the case iterator of it, otherwise return
3395 /// default case iterator to indicate that it is handled by the default
3396 /// handler.
3397 CaseIt findCaseValue(const ConstantInt *C) {
3398 CaseIt I = llvm::find_if(
3399 cases(), [C](CaseHandle &Case) { return Case.getCaseValue() == C; });
3400 if (I != case_end())
3401 return I;
3402
3403 return case_default();
3404 }
3405 ConstCaseIt findCaseValue(const ConstantInt *C) const {
3406 ConstCaseIt I = llvm::find_if(cases(), [C](ConstCaseHandle &Case) {
3407 return Case.getCaseValue() == C;
3408 });
3409 if (I != case_end())
3410 return I;
3411
3412 return case_default();
3413 }
3414
3415 /// Finds the unique case value for a given successor. Returns null if the
3416 /// successor is not found, not unique, or is the default case.
3417 ConstantInt *findCaseDest(BasicBlock *BB) {
3418 if (BB == getDefaultDest())
3419 return nullptr;
3420
3421 ConstantInt *CI = nullptr;
3422 for (auto Case : cases()) {
3423 if (Case.getCaseSuccessor() != BB)
3424 continue;
3425
3426 if (CI)
3427 return nullptr; // Multiple cases lead to BB.
3428
3429 CI = Case.getCaseValue();
3430 }
3431
3432 return CI;
3433 }
3434
3435 /// Add an entry to the switch instruction.
3436 /// Note:
3437 /// This action invalidates case_end(). Old case_end() iterator will
3438 /// point to the added case.
3439 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
3440
3441 /// This method removes the specified case and its successor from the switch
3442 /// instruction. Note that this operation may reorder the remaining cases at
3443 /// index idx and above.
3444 /// Note:
3445 /// This action invalidates iterators for all cases following the one removed,
3446 /// including the case_end() iterator. It returns an iterator for the next
3447 /// case.
3448 CaseIt removeCase(CaseIt I);
3449
3450 unsigned getNumSuccessors() const { return getNumOperands()/2; }
3451 BasicBlock *getSuccessor(unsigned idx) const {
3452 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!")((idx < getNumSuccessors() &&"Successor idx out of range for switch!"
) ? static_cast<void> (0) : __assert_fail ("idx < getNumSuccessors() &&\"Successor idx out of range for switch!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3452, __PRETTY_FUNCTION__))
;
3453 return cast<BasicBlock>(getOperand(idx*2+1));
3454 }
3455 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3456 assert(idx < getNumSuccessors() && "Successor # out of range for switch!")((idx < getNumSuccessors() && "Successor # out of range for switch!"
) ? static_cast<void> (0) : __assert_fail ("idx < getNumSuccessors() && \"Successor # out of range for switch!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3456, __PRETTY_FUNCTION__))
;
3457 setOperand(idx * 2 + 1, NewSucc);
3458 }
3459
3460 // Methods for support type inquiry through isa, cast, and dyn_cast:
3461 static bool classof(const Instruction *I) {
3462 return I->getOpcode() == Instruction::Switch;
3463 }
3464 static bool classof(const Value *V) {
3465 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3466 }
3467};
3468
3469/// A wrapper class to simplify modification of SwitchInst cases along with
3470/// their prof branch_weights metadata.
3471class SwitchInstProfUpdateWrapper {
3472 SwitchInst &SI;
3473 Optional<SmallVector<uint32_t, 8> > Weights = None;
3474 bool Changed = false;
3475
3476protected:
3477 static MDNode *getProfBranchWeightsMD(const SwitchInst &SI);
3478
3479 MDNode *buildProfBranchWeightsMD();
3480
3481 void init();
3482
3483public:
3484 using CaseWeightOpt = Optional<uint32_t>;
3485 SwitchInst *operator->() { return &SI; }
3486 SwitchInst &operator*() { return SI; }
3487 operator SwitchInst *() { return &SI; }
3488
3489 SwitchInstProfUpdateWrapper(SwitchInst &SI) : SI(SI) { init(); }
3490
3491 ~SwitchInstProfUpdateWrapper() {
3492 if (Changed)
3493 SI.setMetadata(LLVMContext::MD_prof, buildProfBranchWeightsMD());
3494 }
3495
3496 /// Delegate the call to the underlying SwitchInst::removeCase() and remove
3497 /// correspondent branch weight.
3498 SwitchInst::CaseIt removeCase(SwitchInst::CaseIt I);
3499
3500 /// Delegate the call to the underlying SwitchInst::addCase() and set the
3501 /// specified branch weight for the added case.
3502 void addCase(ConstantInt *OnVal, BasicBlock *Dest, CaseWeightOpt W);
3503
3504 /// Delegate the call to the underlying SwitchInst::eraseFromParent() and mark
3505 /// this object to not touch the underlying SwitchInst in destructor.
3506 SymbolTableList<Instruction>::iterator eraseFromParent();
3507
3508 void setSuccessorWeight(unsigned idx, CaseWeightOpt W);
3509 CaseWeightOpt getSuccessorWeight(unsigned idx);
3510
3511 static CaseWeightOpt getSuccessorWeight(const SwitchInst &SI, unsigned idx);
3512};
3513
3514template <>
3515struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> {
3516};
3517
3518DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)SwitchInst::op_iterator SwitchInst::op_begin() { return OperandTraits
<SwitchInst>::op_begin(this); } SwitchInst::const_op_iterator
SwitchInst::op_begin() const { return OperandTraits<SwitchInst
>::op_begin(const_cast<SwitchInst*>(this)); } SwitchInst
::op_iterator SwitchInst::op_end() { return OperandTraits<
SwitchInst>::op_end(this); } SwitchInst::const_op_iterator
SwitchInst::op_end() const { return OperandTraits<SwitchInst
>::op_end(const_cast<SwitchInst*>(this)); } Value *SwitchInst
::getOperand(unsigned i_nocapture) const { ((i_nocapture <
OperandTraits<SwitchInst>::operands(this) && "getOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<SwitchInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3518, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<SwitchInst>::op_begin(const_cast<SwitchInst
*>(this))[i_nocapture].get()); } void SwitchInst::setOperand
(unsigned i_nocapture, Value *Val_nocapture) { ((i_nocapture <
OperandTraits<SwitchInst>::operands(this) && "setOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<SwitchInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3518, __PRETTY_FUNCTION__)); OperandTraits<SwitchInst>
::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned SwitchInst
::getNumOperands() const { return OperandTraits<SwitchInst
>::operands(this); } template <int Idx_nocapture> Use
&SwitchInst::Op() { return this->OpFrom<Idx_nocapture
>(this); } template <int Idx_nocapture> const Use &
SwitchInst::Op() const { return this->OpFrom<Idx_nocapture
>(this); }
3519
3520//===----------------------------------------------------------------------===//
3521// IndirectBrInst Class
3522//===----------------------------------------------------------------------===//
3523
3524//===---------------------------------------------------------------------------
3525/// Indirect Branch Instruction.
3526///
3527class IndirectBrInst : public Instruction {
3528 unsigned ReservedSpace;
3529
3530 // Operand[0] = Address to jump to
3531 // Operand[n+1] = n-th destination
3532 IndirectBrInst(const IndirectBrInst &IBI);
3533
3534 /// Create a new indirectbr instruction, specifying an
3535 /// Address to jump to. The number of expected destinations can be specified
3536 /// here to make memory allocation more efficient. This constructor can also
3537 /// autoinsert before another instruction.
3538 IndirectBrInst(Value *Address, unsigned NumDests, Instruction *InsertBefore);
3539
3540 /// Create a new indirectbr instruction, specifying an
3541 /// Address to jump to. The number of expected destinations can be specified
3542 /// here to make memory allocation more efficient. This constructor also
3543 /// autoinserts at the end of the specified BasicBlock.
3544 IndirectBrInst(Value *Address, unsigned NumDests, BasicBlock *InsertAtEnd);
3545
3546 // allocate space for exactly zero operands
3547 void *operator new(size_t s) {
3548 return User::operator new(s);
3549 }
3550
3551 void init(Value *Address, unsigned NumDests);
3552 void growOperands();
3553
3554protected:
3555 // Note: Instruction needs to be a friend here to call cloneImpl.
3556 friend class Instruction;
3557
3558 IndirectBrInst *cloneImpl() const;
3559
3560public:
3561 /// Iterator type that casts an operand to a basic block.
3562 ///
3563 /// This only makes sense because the successors are stored as adjacent
3564 /// operands for indirectbr instructions.
3565 struct succ_op_iterator
3566 : iterator_adaptor_base<succ_op_iterator, value_op_iterator,
3567 std::random_access_iterator_tag, BasicBlock *,
3568 ptrdiff_t, BasicBlock *, BasicBlock *> {
3569 explicit succ_op_iterator(value_op_iterator I) : iterator_adaptor_base(I) {}
3570
3571 BasicBlock *operator*() const { return cast<BasicBlock>(*I); }
3572 BasicBlock *operator->() const { return operator*(); }
3573 };
3574
3575 /// The const version of `succ_op_iterator`.
3576 struct const_succ_op_iterator
3577 : iterator_adaptor_base<const_succ_op_iterator, const_value_op_iterator,
3578 std::random_access_iterator_tag,
3579 const BasicBlock *, ptrdiff_t, const BasicBlock *,
3580 const BasicBlock *> {
3581 explicit const_succ_op_iterator(const_value_op_iterator I)
3582 : iterator_adaptor_base(I) {}
3583
3584 const BasicBlock *operator*() const { return cast<BasicBlock>(*I); }
3585 const BasicBlock *operator->() const { return operator*(); }
3586 };
3587
3588 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
3589 Instruction *InsertBefore = nullptr) {
3590 return new IndirectBrInst(Address, NumDests, InsertBefore);
3591 }
3592
3593 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
3594 BasicBlock *InsertAtEnd) {
3595 return new IndirectBrInst(Address, NumDests, InsertAtEnd);
3596 }
3597
3598 /// Provide fast operand accessors.
3599 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
3600
3601 // Accessor Methods for IndirectBrInst instruction.
3602 Value *getAddress() { return getOperand(0); }
3603 const Value *getAddress() const { return getOperand(0); }
3604 void setAddress(Value *V) { setOperand(0, V); }
3605
3606 /// return the number of possible destinations in this
3607 /// indirectbr instruction.
3608 unsigned getNumDestinations() const { return getNumOperands()-1; }
3609
3610 /// Return the specified destination.
3611 BasicBlock *getDestination(unsigned i) { return getSuccessor(i); }
3612 const BasicBlock *getDestination(unsigned i) const { return getSuccessor(i); }
3613
3614 /// Add a destination.
3615 ///
3616 void addDestination(BasicBlock *Dest);
3617
3618 /// This method removes the specified successor from the
3619 /// indirectbr instruction.
3620 void removeDestination(unsigned i);
3621
3622 unsigned getNumSuccessors() const { return getNumOperands()-1; }
3623 BasicBlock *getSuccessor(unsigned i) const {
3624 return cast<BasicBlock>(getOperand(i+1));
3625 }
3626 void setSuccessor(unsigned i, BasicBlock *NewSucc) {
3627 setOperand(i + 1, NewSucc);
3628 }
3629
3630 iterator_range<succ_op_iterator> successors() {
3631 return make_range(succ_op_iterator(std::next(value_op_begin())),
3632 succ_op_iterator(value_op_end()));
3633 }
3634
3635 iterator_range<const_succ_op_iterator> successors() const {
3636 return make_range(const_succ_op_iterator(std::next(value_op_begin())),
3637 const_succ_op_iterator(value_op_end()));
3638 }
3639
3640 // Methods for support type inquiry through isa, cast, and dyn_cast:
3641 static bool classof(const Instruction *I) {
3642 return I->getOpcode() == Instruction::IndirectBr;
3643 }
3644 static bool classof(const Value *V) {
3645 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3646 }
3647};
3648
3649template <>
3650struct OperandTraits<IndirectBrInst> : public HungoffOperandTraits<1> {
3651};
3652
3653DEFINE_TRANSPARENT_OPERAND_ACCESSORS(IndirectBrInst, Value)IndirectBrInst::op_iterator IndirectBrInst::op_begin() { return
OperandTraits<IndirectBrInst>::op_begin(this); } IndirectBrInst
::const_op_iterator IndirectBrInst::op_begin() const { return
OperandTraits<IndirectBrInst>::op_begin(const_cast<
IndirectBrInst*>(this)); } IndirectBrInst::op_iterator IndirectBrInst
::op_end() { return OperandTraits<IndirectBrInst>::op_end
(this); } IndirectBrInst::const_op_iterator IndirectBrInst::op_end
() const { return OperandTraits<IndirectBrInst>::op_end
(const_cast<IndirectBrInst*>(this)); } Value *IndirectBrInst
::getOperand(unsigned i_nocapture) const { ((i_nocapture <
OperandTraits<IndirectBrInst>::operands(this) &&
"getOperand() out of range!") ? static_cast<void> (0) :
__assert_fail ("i_nocapture < OperandTraits<IndirectBrInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3653, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<IndirectBrInst>::op_begin(const_cast<
IndirectBrInst*>(this))[i_nocapture].get()); } void IndirectBrInst
::setOperand(unsigned i_nocapture, Value *Val_nocapture) { ((
i_nocapture < OperandTraits<IndirectBrInst>::operands
(this) && "setOperand() out of range!") ? static_cast
<void> (0) : __assert_fail ("i_nocapture < OperandTraits<IndirectBrInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3653, __PRETTY_FUNCTION__)); OperandTraits<IndirectBrInst
>::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned
IndirectBrInst::getNumOperands() const { return OperandTraits
<IndirectBrInst>::operands(this); } template <int Idx_nocapture
> Use &IndirectBrInst::Op() { return this->OpFrom<
Idx_nocapture>(this); } template <int Idx_nocapture>
const Use &IndirectBrInst::Op() const { return this->
OpFrom<Idx_nocapture>(this); }
3654
3655//===----------------------------------------------------------------------===//
3656// InvokeInst Class
3657//===----------------------------------------------------------------------===//
3658
3659/// Invoke instruction. The SubclassData field is used to hold the
3660/// calling convention of the call.
3661///
3662class InvokeInst : public CallBase {
3663 /// The number of operands for this call beyond the called function,
3664 /// arguments, and operand bundles.
3665 static constexpr int NumExtraOperands = 2;
3666
3667 /// The index from the end of the operand array to the normal destination.
3668 static constexpr int NormalDestOpEndIdx = -3;
3669
3670 /// The index from the end of the operand array to the unwind destination.
3671 static constexpr int UnwindDestOpEndIdx = -2;
3672
3673 InvokeInst(const InvokeInst &BI);
3674
3675 /// Construct an InvokeInst given a range of arguments.
3676 ///
3677 /// Construct an InvokeInst from a range of arguments
3678 inline InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3679 BasicBlock *IfException, ArrayRef<Value *> Args,
3680 ArrayRef<OperandBundleDef> Bundles, int NumOperands,
3681 const Twine &NameStr, Instruction *InsertBefore);
3682
3683 inline InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3684 BasicBlock *IfException, ArrayRef<Value *> Args,
3685 ArrayRef<OperandBundleDef> Bundles, int NumOperands,
3686 const Twine &NameStr, BasicBlock *InsertAtEnd);
3687
3688 void init(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3689 BasicBlock *IfException, ArrayRef<Value *> Args,
3690 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr);
3691
3692 /// Compute the number of operands to allocate.
3693 static int ComputeNumOperands(int NumArgs, int NumBundleInputs = 0) {
3694 // We need one operand for the called function, plus our extra operands and
3695 // the input operand counts provided.
3696 return 1 + NumExtraOperands + NumArgs + NumBundleInputs;
3697 }
3698
3699protected:
3700 // Note: Instruction needs to be a friend here to call cloneImpl.
3701 friend class Instruction;
3702
3703 InvokeInst *cloneImpl() const;
3704
3705public:
3706 static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3707 BasicBlock *IfException, ArrayRef<Value *> Args,
3708 const Twine &NameStr,
3709 Instruction *InsertBefore = nullptr) {
3710 int NumOperands = ComputeNumOperands(Args.size());
3711 return new (NumOperands)
3712 InvokeInst(Ty, Func, IfNormal, IfException, Args, None, NumOperands,
3713 NameStr, InsertBefore);
3714 }
3715
3716 static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3717 BasicBlock *IfException, ArrayRef<Value *> Args,
3718 ArrayRef<OperandBundleDef> Bundles = None,
3719 const Twine &NameStr = "",
3720 Instruction *InsertBefore = nullptr) {
3721 int NumOperands =
3722 ComputeNumOperands(Args.size(), CountBundleInputs(Bundles));
3723 unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
3724
3725 return new (NumOperands, DescriptorBytes)
3726 InvokeInst(Ty, Func, IfNormal, IfException, Args, Bundles, NumOperands,
3727 NameStr, InsertBefore);
3728 }
3729
3730 static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3731 BasicBlock *IfException, ArrayRef<Value *> Args,
3732 const Twine &NameStr, BasicBlock *InsertAtEnd) {
3733 int NumOperands = ComputeNumOperands(Args.size());
3734 return new (NumOperands)
3735 InvokeInst(Ty, Func, IfNormal, IfException, Args, None, NumOperands,
3736 NameStr, InsertAtEnd);
3737 }
3738
3739 static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3740 BasicBlock *IfException, ArrayRef<Value *> Args,
3741 ArrayRef<OperandBundleDef> Bundles,
3742 const Twine &NameStr, BasicBlock *InsertAtEnd) {
3743 int NumOperands =
3744 ComputeNumOperands(Args.size(), CountBundleInputs(Bundles));
3745 unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
3746
3747 return new (NumOperands, DescriptorBytes)
3748 InvokeInst(Ty, Func, IfNormal, IfException, Args, Bundles, NumOperands,
3749 NameStr, InsertAtEnd);
3750 }
3751
3752 static InvokeInst *Create(FunctionCallee Func, BasicBlock *IfNormal,
3753 BasicBlock *IfException, ArrayRef<Value *> Args,
3754 const Twine &NameStr,
3755 Instruction *InsertBefore = nullptr) {
3756 return Create(Func.getFunctionType(), Func.getCallee(), IfNormal,
3757 IfException, Args, None, NameStr, InsertBefore);
3758 }
3759
3760 static InvokeInst *Create(FunctionCallee Func, BasicBlock *IfNormal,
3761 BasicBlock *IfException, ArrayRef<Value *> Args,
3762 ArrayRef<OperandBundleDef> Bundles = None,
3763 const Twine &NameStr = "",
3764 Instruction *InsertBefore = nullptr) {
3765 return Create(Func.getFunctionType(), Func.getCallee(), IfNormal,
3766 IfException, Args, Bundles, NameStr, InsertBefore);
3767 }
3768
3769 static InvokeInst *Create(FunctionCallee Func, BasicBlock *IfNormal,
3770 BasicBlock *IfException, ArrayRef<Value *> Args,
3771 const Twine &NameStr, BasicBlock *InsertAtEnd) {
3772 return Create(Func.getFunctionType(), Func.getCallee(), IfNormal,
3773 IfException, Args, NameStr, InsertAtEnd);
3774 }
3775
3776 static InvokeInst *Create(FunctionCallee Func, BasicBlock *IfNormal,
3777 BasicBlock *IfException, ArrayRef<Value *> Args,
3778 ArrayRef<OperandBundleDef> Bundles,
3779 const Twine &NameStr, BasicBlock *InsertAtEnd) {
3780 return Create(Func.getFunctionType(), Func.getCallee(), IfNormal,
3781 IfException, Args, Bundles, NameStr, InsertAtEnd);
3782 }
3783
3784 /// Create a clone of \p II with a different set of operand bundles and
3785 /// insert it before \p InsertPt.
3786 ///
3787 /// The returned invoke instruction is identical to \p II in every way except
3788 /// that the operand bundles for the new instruction are set to the operand
3789 /// bundles in \p Bundles.
3790 static InvokeInst *Create(InvokeInst *II, ArrayRef<OperandBundleDef> Bundles,
3791 Instruction *InsertPt = nullptr);
3792
3793 /// Create a clone of \p II with a different set of operand bundles and
3794 /// insert it before \p InsertPt.
3795 ///
3796 /// The returned invoke instruction is identical to \p II in every way except
3797 /// that the operand bundle for the new instruction is set to the operand
3798 /// bundle in \p Bundle.
3799 static InvokeInst *CreateWithReplacedBundle(InvokeInst *II,
3800 OperandBundleDef Bundles,
3801 Instruction *InsertPt = nullptr);
3802
3803 // get*Dest - Return the destination basic blocks...
3804 BasicBlock *getNormalDest() const {
3805 return cast<BasicBlock>(Op<NormalDestOpEndIdx>());
3806 }
3807 BasicBlock *getUnwindDest() const {
3808 return cast<BasicBlock>(Op<UnwindDestOpEndIdx>());
3809 }
3810 void setNormalDest(BasicBlock *B) {
3811 Op<NormalDestOpEndIdx>() = reinterpret_cast<Value *>(B);
3812 }
3813 void setUnwindDest(BasicBlock *B) {
3814 Op<UnwindDestOpEndIdx>() = reinterpret_cast<Value *>(B);
3815 }
3816
3817 /// Get the landingpad instruction from the landing pad
3818 /// block (the unwind destination).
3819 LandingPadInst *getLandingPadInst() const;
3820
3821 BasicBlock *getSuccessor(unsigned i) const {
3822 assert(i < 2 && "Successor # out of range for invoke!")((i < 2 && "Successor # out of range for invoke!")
? static_cast<void> (0) : __assert_fail ("i < 2 && \"Successor # out of range for invoke!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3822, __PRETTY_FUNCTION__))
;
3823 return i == 0 ? getNormalDest() : getUnwindDest();
3824 }
3825
3826 void setSuccessor(unsigned i, BasicBlock *NewSucc) {
3827 assert(i < 2 && "Successor # out of range for invoke!")((i < 2 && "Successor # out of range for invoke!")
? static_cast<void> (0) : __assert_fail ("i < 2 && \"Successor # out of range for invoke!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 3827, __PRETTY_FUNCTION__))
;
3828 if (i == 0)
3829 setNormalDest(NewSucc);
3830 else
3831 setUnwindDest(NewSucc);
3832 }
3833
3834 unsigned getNumSuccessors() const { return 2; }
3835
3836 // Methods for support type inquiry through isa, cast, and dyn_cast:
3837 static bool classof(const Instruction *I) {
3838 return (I->getOpcode() == Instruction::Invoke);
3839 }
3840 static bool classof(const Value *V) {
3841 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3842 }
3843
3844private:
3845 // Shadow Instruction::setInstructionSubclassData with a private forwarding
3846 // method so that subclasses cannot accidentally use it.
3847 template <typename Bitfield>
3848 void setSubclassData(typename Bitfield::Type Value) {
3849 Instruction::setSubclassData<Bitfield>(Value);
3850 }
3851};
3852
3853InvokeInst::InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3854 BasicBlock *IfException, ArrayRef<Value *> Args,
3855 ArrayRef<OperandBundleDef> Bundles, int NumOperands,
3856 const Twine &NameStr, Instruction *InsertBefore)
3857 : CallBase(Ty->getReturnType(), Instruction::Invoke,
3858 OperandTraits<CallBase>::op_end(this) - NumOperands, NumOperands,
3859 InsertBefore) {
3860 init(Ty, Func, IfNormal, IfException, Args, Bundles, NameStr);
3861}
3862
3863InvokeInst::InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3864 BasicBlock *IfException, ArrayRef<Value *> Args,
3865 ArrayRef<OperandBundleDef> Bundles, int NumOperands,
3866 const Twine &NameStr, BasicBlock *InsertAtEnd)
3867 : CallBase(Ty->getReturnType(), Instruction::Invoke,
3868 OperandTraits<CallBase>::op_end(this) - NumOperands, NumOperands,
3869 InsertAtEnd) {
3870 init(Ty, Func, IfNormal, IfException, Args, Bundles, NameStr);
3871}
3872
3873//===----------------------------------------------------------------------===//
3874// CallBrInst Class
3875//===----------------------------------------------------------------------===//
3876
3877/// CallBr instruction, tracking function calls that may not return control but
3878/// instead transfer it to a third location. The SubclassData field is used to
3879/// hold the calling convention of the call.
3880///
3881class CallBrInst : public CallBase {
3882
3883 unsigned NumIndirectDests;
3884
3885 CallBrInst(const CallBrInst &BI);
3886
3887 /// Construct a CallBrInst given a range of arguments.
3888 ///
3889 /// Construct a CallBrInst from a range of arguments
3890 inline CallBrInst(FunctionType *Ty, Value *Func, BasicBlock *DefaultDest,
3891 ArrayRef<BasicBlock *> IndirectDests,
3892 ArrayRef<Value *> Args,
3893 ArrayRef<OperandBundleDef> Bundles, int NumOperands,
3894 const Twine &NameStr, Instruction *InsertBefore);
3895
3896 inline CallBrInst(FunctionType *Ty, Value *Func, BasicBlock *DefaultDest,
3897 ArrayRef<BasicBlock *> IndirectDests,
3898 ArrayRef<Value *> Args,
3899 ArrayRef<OperandBundleDef> Bundles, int NumOperands,
3900 const Twine &NameStr, BasicBlock *InsertAtEnd);
3901
3902 void init(FunctionType *FTy, Value *Func, BasicBlock *DefaultDest,
3903 ArrayRef<BasicBlock *> IndirectDests, ArrayRef<Value *> Args,
3904 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr);
3905
3906 /// Should the Indirect Destinations change, scan + update the Arg list.
3907 void updateArgBlockAddresses(unsigned i, BasicBlock *B);
3908
3909 /// Compute the number of operands to allocate.
3910 static int ComputeNumOperands(int NumArgs, int NumIndirectDests,
3911 int NumBundleInputs = 0) {
3912 // We need one operand for the called function, plus our extra operands and
3913 // the input operand counts provided.
3914 return 2 + NumIndirectDests + NumArgs + NumBundleInputs;
3915 }
3916
3917protected:
3918 // Note: Instruction needs to be a friend here to call cloneImpl.
3919 friend class Instruction;
3920
3921 CallBrInst *cloneImpl() const;
3922
3923public:
3924 static CallBrInst *Create(FunctionType *Ty, Value *Func,
3925 BasicBlock *DefaultDest,
3926 ArrayRef<BasicBlock *> IndirectDests,
3927 ArrayRef<Value *> Args, const Twine &NameStr,
3928 Instruction *InsertBefore = nullptr) {
3929 int NumOperands = ComputeNumOperands(Args.size(), IndirectDests.size());
3930 return new (NumOperands)
3931 CallBrInst(Ty, Func, DefaultDest, IndirectDests, Args, None,
3932 NumOperands, NameStr, InsertBefore);
3933 }
3934
3935 static CallBrInst *Create(FunctionType *Ty, Value *Func,
3936 BasicBlock *DefaultDest,
3937 ArrayRef<BasicBlock *> IndirectDests,
3938 ArrayRef<Value *> Args,
3939 ArrayRef<OperandBundleDef> Bundles = None,
3940 const Twine &NameStr = "",
3941 Instruction *InsertBefore = nullptr) {
3942 int NumOperands = ComputeNumOperands(Args.size(), IndirectDests.size(),
3943 CountBundleInputs(Bundles));
3944 unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
3945
3946 return new (NumOperands, DescriptorBytes)
3947 CallBrInst(Ty, Func, DefaultDest, IndirectDests, Args, Bundles,
3948 NumOperands, NameStr, InsertBefore);
3949 }
3950
3951 static CallBrInst *Create(FunctionType *Ty, Value *Func,
3952 BasicBlock *DefaultDest,
3953 ArrayRef<BasicBlock *> IndirectDests,
3954 ArrayRef<Value *> Args, const Twine &NameStr,
3955 BasicBlock *InsertAtEnd) {
3956 int NumOperands = ComputeNumOperands(Args.size(), IndirectDests.size());
3957 return new (NumOperands)
3958 CallBrInst(Ty, Func, DefaultDest, IndirectDests, Args, None,
3959 NumOperands, NameStr, InsertAtEnd);
3960 }
3961
3962 static CallBrInst *Create(FunctionType *Ty, Value *Func,
3963 BasicBlock *DefaultDest,
3964 ArrayRef<BasicBlock *> IndirectDests,
3965 ArrayRef<Value *> Args,
3966 ArrayRef<OperandBundleDef> Bundles,
3967 const Twine &NameStr, BasicBlock *InsertAtEnd) {
3968 int NumOperands = ComputeNumOperands(Args.size(), IndirectDests.size(),
3969 CountBundleInputs(Bundles));
3970 unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
3971
3972 return new (NumOperands, DescriptorBytes)
3973 CallBrInst(Ty, Func, DefaultDest, IndirectDests, Args, Bundles,
3974 NumOperands, NameStr, InsertAtEnd);
3975 }
3976
3977 static CallBrInst *Create(FunctionCallee Func, BasicBlock *DefaultDest,
3978 ArrayRef<BasicBlock *> IndirectDests,
3979 ArrayRef<Value *> Args, const Twine &NameStr,
3980 Instruction *InsertBefore = nullptr) {
3981 return Create(Func.getFunctionType(), Func.getCallee(), DefaultDest,
3982 IndirectDests, Args, NameStr, InsertBefore);
3983 }
3984
3985 static CallBrInst *Create(FunctionCallee Func, BasicBlock *DefaultDest,
3986 ArrayRef<BasicBlock *> IndirectDests,
3987 ArrayRef<Value *> Args,
3988 ArrayRef<OperandBundleDef> Bundles = None,
3989 const Twine &NameStr = "",
3990 Instruction *InsertBefore = nullptr) {
3991 return Create(Func.getFunctionType(), Func.getCallee(), DefaultDest,
3992 IndirectDests, Args, Bundles, NameStr, InsertBefore);
3993 }
3994
3995 static CallBrInst *Create(FunctionCallee Func, BasicBlock *DefaultDest,
3996 ArrayRef<BasicBlock *> IndirectDests,
3997 ArrayRef<Value *> Args, const Twine &NameStr,
3998 BasicBlock *InsertAtEnd) {
3999 return Create(Func.getFunctionType(), Func.getCallee(), DefaultDest,
4000 IndirectDests, Args, NameStr, InsertAtEnd);
4001 }
4002
4003 static CallBrInst *Create(FunctionCallee Func,
4004 BasicBlock *DefaultDest,
4005 ArrayRef<BasicBlock *> IndirectDests,
4006 ArrayRef<Value *> Args,
4007 ArrayRef<OperandBundleDef> Bundles,
4008 const Twine &NameStr, BasicBlock *InsertAtEnd) {
4009 return Create(Func.getFunctionType(), Func.getCallee(), DefaultDest,
4010 IndirectDests, Args, Bundles, NameStr, InsertAtEnd);
4011 }
4012
4013 /// Create a clone of \p CBI with a different set of operand bundles and
4014 /// insert it before \p InsertPt.
4015 ///
4016 /// The returned callbr instruction is identical to \p CBI in every way
4017 /// except that the operand bundles for the new instruction are set to the
4018 /// operand bundles in \p Bundles.
4019 static CallBrInst *Create(CallBrInst *CBI,
4020 ArrayRef<OperandBundleDef> Bundles,
4021 Instruction *InsertPt = nullptr);
4022
4023 /// Return the number of callbr indirect dest labels.
4024 ///
4025 unsigned getNumIndirectDests() const { return NumIndirectDests; }
4026
4027 /// getIndirectDestLabel - Return the i-th indirect dest label.
4028 ///
4029 Value *getIndirectDestLabel(unsigned i) const {
4030 assert(i < getNumIndirectDests() && "Out of bounds!")((i < getNumIndirectDests() && "Out of bounds!") ?
static_cast<void> (0) : __assert_fail ("i < getNumIndirectDests() && \"Out of bounds!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4030, __PRETTY_FUNCTION__))
;
4031 return getOperand(i + getNumArgOperands() + getNumTotalBundleOperands() +
4032 1);
4033 }
4034
4035 Value *getIndirectDestLabelUse(unsigned i) const {
4036 assert(i < getNumIndirectDests() && "Out of bounds!")((i < getNumIndirectDests() && "Out of bounds!") ?
static_cast<void> (0) : __assert_fail ("i < getNumIndirectDests() && \"Out of bounds!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4036, __PRETTY_FUNCTION__))
;
4037 return getOperandUse(i + getNumArgOperands() + getNumTotalBundleOperands() +
4038 1);
4039 }
4040
4041 // Return the destination basic blocks...
4042 BasicBlock *getDefaultDest() const {
4043 return cast<BasicBlock>(*(&Op<-1>() - getNumIndirectDests() - 1));
4044 }
4045 BasicBlock *getIndirectDest(unsigned i) const {
4046 return cast_or_null<BasicBlock>(*(&Op<-1>() - getNumIndirectDests() + i));
4047 }
4048 SmallVector<BasicBlock *, 16> getIndirectDests() const {
4049 SmallVector<BasicBlock *, 16> IndirectDests;
4050 for (unsigned i = 0, e = getNumIndirectDests(); i < e; ++i)
4051 IndirectDests.push_back(getIndirectDest(i));
4052 return IndirectDests;
4053 }
4054 void setDefaultDest(BasicBlock *B) {
4055 *(&Op<-1>() - getNumIndirectDests() - 1) = reinterpret_cast<Value *>(B);
4056 }
4057 void setIndirectDest(unsigned i, BasicBlock *B) {
4058 updateArgBlockAddresses(i, B);
4059 *(&Op<-1>() - getNumIndirectDests() + i) = reinterpret_cast<Value *>(B);
4060 }
4061
4062 BasicBlock *getSuccessor(unsigned i) const {
4063 assert(i < getNumSuccessors() + 1 &&((i < getNumSuccessors() + 1 && "Successor # out of range for callbr!"
) ? static_cast<void> (0) : __assert_fail ("i < getNumSuccessors() + 1 && \"Successor # out of range for callbr!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4064, __PRETTY_FUNCTION__))
4064 "Successor # out of range for callbr!")((i < getNumSuccessors() + 1 && "Successor # out of range for callbr!"
) ? static_cast<void> (0) : __assert_fail ("i < getNumSuccessors() + 1 && \"Successor # out of range for callbr!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4064, __PRETTY_FUNCTION__))
;
4065 return i == 0 ? getDefaultDest() : getIndirectDest(i - 1);
4066 }
4067
4068 void setSuccessor(unsigned i, BasicBlock *NewSucc) {
4069 assert(i < getNumIndirectDests() + 1 &&((i < getNumIndirectDests() + 1 && "Successor # out of range for callbr!"
) ? static_cast<void> (0) : __assert_fail ("i < getNumIndirectDests() + 1 && \"Successor # out of range for callbr!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4070, __PRETTY_FUNCTION__))
4070 "Successor # out of range for callbr!")((i < getNumIndirectDests() + 1 && "Successor # out of range for callbr!"
) ? static_cast<void> (0) : __assert_fail ("i < getNumIndirectDests() + 1 && \"Successor # out of range for callbr!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4070, __PRETTY_FUNCTION__))
;
4071 return i == 0 ? setDefaultDest(NewSucc) : setIndirectDest(i - 1, NewSucc);
4072 }
4073
4074 unsigned getNumSuccessors() const { return getNumIndirectDests() + 1; }
4075
4076 // Methods for support type inquiry through isa, cast, and dyn_cast:
4077 static bool classof(const Instruction *I) {
4078 return (I->getOpcode() == Instruction::CallBr);
4079 }
4080 static bool classof(const Value *V) {
4081 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4082 }
4083
4084private:
4085 // Shadow Instruction::setInstructionSubclassData with a private forwarding
4086 // method so that subclasses cannot accidentally use it.
4087 template <typename Bitfield>
4088 void setSubclassData(typename Bitfield::Type Value) {
4089 Instruction::setSubclassData<Bitfield>(Value);
4090 }
4091};
4092
4093CallBrInst::CallBrInst(FunctionType *Ty, Value *Func, BasicBlock *DefaultDest,
4094 ArrayRef<BasicBlock *> IndirectDests,
4095 ArrayRef<Value *> Args,
4096 ArrayRef<OperandBundleDef> Bundles, int NumOperands,
4097 const Twine &NameStr, Instruction *InsertBefore)
4098 : CallBase(Ty->getReturnType(), Instruction::CallBr,
4099 OperandTraits<CallBase>::op_end(this) - NumOperands, NumOperands,
4100 InsertBefore) {
4101 init(Ty, Func, DefaultDest, IndirectDests, Args, Bundles, NameStr);
4102}
4103
4104CallBrInst::CallBrInst(FunctionType *Ty, Value *Func, BasicBlock *DefaultDest,
4105 ArrayRef<BasicBlock *> IndirectDests,
4106 ArrayRef<Value *> Args,
4107 ArrayRef<OperandBundleDef> Bundles, int NumOperands,
4108 const Twine &NameStr, BasicBlock *InsertAtEnd)
4109 : CallBase(Ty->getReturnType(), Instruction::CallBr,
4110 OperandTraits<CallBase>::op_end(this) - NumOperands, NumOperands,
4111 InsertAtEnd) {
4112 init(Ty, Func, DefaultDest, IndirectDests, Args, Bundles, NameStr);
4113}
4114
4115//===----------------------------------------------------------------------===//
4116// ResumeInst Class
4117//===----------------------------------------------------------------------===//
4118
4119//===---------------------------------------------------------------------------
4120/// Resume the propagation of an exception.
4121///
4122class ResumeInst : public Instruction {
4123 ResumeInst(const ResumeInst &RI);
4124
4125 explicit ResumeInst(Value *Exn, Instruction *InsertBefore=nullptr);
4126 ResumeInst(Value *Exn, BasicBlock *InsertAtEnd);
4127
4128protected:
4129 // Note: Instruction needs to be a friend here to call cloneImpl.
4130 friend class Instruction;
4131
4132 ResumeInst *cloneImpl() const;
4133
4134public:
4135 static ResumeInst *Create(Value *Exn, Instruction *InsertBefore = nullptr) {
4136 return new(1) ResumeInst(Exn, InsertBefore);
4137 }
4138
4139 static ResumeInst *Create(Value *Exn, BasicBlock *InsertAtEnd) {
4140 return new(1) ResumeInst(Exn, InsertAtEnd);
4141 }
4142
4143 /// Provide fast operand accessors
4144 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
4145
4146 /// Convenience accessor.
4147 Value *getValue() const { return Op<0>(); }
4148
4149 unsigned getNumSuccessors() const { return 0; }
4150
4151 // Methods for support type inquiry through isa, cast, and dyn_cast:
4152 static bool classof(const Instruction *I) {
4153 return I->getOpcode() == Instruction::Resume;
4154 }
4155 static bool classof(const Value *V) {
4156 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4157 }
4158
4159private:
4160 BasicBlock *getSuccessor(unsigned idx) const {
4161 llvm_unreachable("ResumeInst has no successors!")::llvm::llvm_unreachable_internal("ResumeInst has no successors!"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4161)
;
4162 }
4163
4164 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
4165 llvm_unreachable("ResumeInst has no successors!")::llvm::llvm_unreachable_internal("ResumeInst has no successors!"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4165)
;
4166 }
4167};
4168
4169template <>
4170struct OperandTraits<ResumeInst> :
4171 public FixedNumOperandTraits<ResumeInst, 1> {
4172};
4173
4174DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ResumeInst, Value)ResumeInst::op_iterator ResumeInst::op_begin() { return OperandTraits
<ResumeInst>::op_begin(this); } ResumeInst::const_op_iterator
ResumeInst::op_begin() const { return OperandTraits<ResumeInst
>::op_begin(const_cast<ResumeInst*>(this)); } ResumeInst
::op_iterator ResumeInst::op_end() { return OperandTraits<
ResumeInst>::op_end(this); } ResumeInst::const_op_iterator
ResumeInst::op_end() const { return OperandTraits<ResumeInst
>::op_end(const_cast<ResumeInst*>(this)); } Value *ResumeInst
::getOperand(unsigned i_nocapture) const { ((i_nocapture <
OperandTraits<ResumeInst>::operands(this) && "getOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<ResumeInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4174, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<ResumeInst>::op_begin(const_cast<ResumeInst
*>(this))[i_nocapture].get()); } void ResumeInst::setOperand
(unsigned i_nocapture, Value *Val_nocapture) { ((i_nocapture <
OperandTraits<ResumeInst>::operands(this) && "setOperand() out of range!"
) ? static_cast<void> (0) : __assert_fail ("i_nocapture < OperandTraits<ResumeInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4174, __PRETTY_FUNCTION__)); OperandTraits<ResumeInst>
::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned ResumeInst
::getNumOperands() const { return OperandTraits<ResumeInst
>::operands(this); } template <int Idx_nocapture> Use
&ResumeInst::Op() { return this->OpFrom<Idx_nocapture
>(this); } template <int Idx_nocapture> const Use &
ResumeInst::Op() const { return this->OpFrom<Idx_nocapture
>(this); }
4175
4176//===----------------------------------------------------------------------===//
4177// CatchSwitchInst Class
4178//===----------------------------------------------------------------------===//
4179class CatchSwitchInst : public Instruction {
4180 using UnwindDestField = BoolBitfieldElementT<0>;
4181
4182 /// The number of operands actually allocated. NumOperands is
4183 /// the number actually in use.
4184 unsigned ReservedSpace;
4185
4186 // Operand[0] = Outer scope
4187 // Operand[1] = Unwind block destination
4188 // Operand[n] = BasicBlock to go to on match
4189 CatchSwitchInst(const CatchSwitchInst &CSI);
4190
4191 /// Create a new switch instruction, specifying a
4192 /// default destination. The number of additional handlers can be specified
4193 /// here to make memory allocation more efficient.
4194 /// This constructor can also autoinsert before another instruction.
4195 CatchSwitchInst(Value *ParentPad, BasicBlock *UnwindDest,
4196 unsigned NumHandlers, const Twine &NameStr,
4197 Instruction *InsertBefore);
4198
4199 /// Create a new switch instruction, specifying a
4200 /// default destination. The number of additional handlers can be specified
4201 /// here to make memory allocation more efficient.
4202 /// This constructor also autoinserts at the end of the specified BasicBlock.
4203 CatchSwitchInst(Value *ParentPad, BasicBlock *UnwindDest,
4204 unsigned NumHandlers, const Twine &NameStr,
4205 BasicBlock *InsertAtEnd);
4206
4207 // allocate space for exactly zero operands
4208 void *operator new(size_t s) { return User::operator new(s); }
4209
4210 void init(Value *ParentPad, BasicBlock *UnwindDest, unsigned NumReserved);
4211 void growOperands(unsigned Size);
4212
4213protected:
4214 // Note: Instruction needs to be a friend here to call cloneImpl.
4215 friend class Instruction;
4216
4217 CatchSwitchInst *cloneImpl() const;
4218
4219public:
4220 static CatchSwitchInst *Create(Value *ParentPad, BasicBlock *UnwindDest,
4221 unsigned NumHandlers,
4222 const Twine &NameStr = "",
4223 Instruction *InsertBefore = nullptr) {
4224 return new CatchSwitchInst(ParentPad, UnwindDest, NumHandlers, NameStr,
4225 InsertBefore);
4226 }
4227
4228 static CatchSwitchInst *Create(Value *ParentPad, BasicBlock *UnwindDest,
4229 unsigned NumHandlers, const Twine &NameStr,
4230 BasicBlock *InsertAtEnd) {
4231 return new CatchSwitchInst(ParentPad, UnwindDest, NumHandlers, NameStr,
4232 InsertAtEnd);
4233 }
4234
4235 /// Provide fast operand accessors
4236 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void
setOperand(unsigned, Value*); inline op_iterator op_begin();
inline const_op_iterator op_begin() const; inline op_iterator
op_end(); inline const_op_iterator op_end() const; protected
: template <int> inline Use &Op(); template <int
> inline const Use &Op() const; public: inline unsigned
getNumOperands() const
;
4237
4238 // Accessor Methods for CatchSwitch stmt
4239 Value *getParentPad() const { return getOperand(0); }
4240 void setParentPad(Value *ParentPad) { setOperand(0, ParentPad); }
4241
4242 // Accessor Methods for CatchSwitch stmt
4243 bool hasUnwindDest() const { return getSubclassData<UnwindDestField>(); }
4244 bool unwindsToCaller() const { return !hasUnwindDest(); }
4245 BasicBlock *getUnwindDest() const {
4246 if (hasUnwindDest())
4247 return cast<BasicBlock>(getOperand(1));
4248 return nullptr;
4249 }
4250 void setUnwindDest(BasicBlock *UnwindDest) {
4251 assert(UnwindDest)((UnwindDest) ? static_cast<void> (0) : __assert_fail (
"UnwindDest", "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4251, __PRETTY_FUNCTION__))
;
4252 assert(hasUnwindDest())((hasUnwindDest()) ? static_cast<void> (0) : __assert_fail
("hasUnwindDest()", "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4252, __PRETTY_FUNCTION__))
;
4253 setOperand(1, UnwindDest);
4254 }
4255
4256 /// return the number of 'handlers' in this catchswitch
4257 /// instruction, except the default handler
4258 unsigned getNumHandlers() const {
4259 if (hasUnwindDest())
4260 return getNumOperands() - 2;
4261 return getNumOperands() - 1;
4262 }
4263
4264private:
4265 static BasicBlock *handler_helper(Value *V) { return cast<BasicBlock>(V); }
4266 static const BasicBlock *handler_helper(const Value *V) {
4267 return cast<BasicBlock>(V);
4268 }
4269
4270public:
4271 using DerefFnTy = BasicBlock *(*)(Value *);
4272 using handler_iterator = mapped_iterator<op_iterator, DerefFnTy>;
4273 using handler_range = iterator_range<handler_iterator>;
4274 using ConstDerefFnTy = const BasicBlock *(*)(const Value *);
4275 using const_handler_iterator =
4276 mapped_iterator<const_op_iterator, ConstDerefFnTy>;
4277 using const_handler_range = iterator_range<const_handler_iterator>;
4278
4279 /// Returns an iterator that points to the first handler in CatchSwitchInst.
4280 handler_iterator handler_begin() {
4281 op_iterator It = op_begin() + 1;
4282 if (hasUnwindDest())
4283 ++It;
4284 return handler_iterator(It, DerefFnTy(handler_helper));
4285 }
4286
4287 /// Returns an iterator that points to the first handler in the
4288 /// CatchSwitchInst.
4289 const_handler_iterator handler_begin() const {
4290 const_op_iterator It = op_begin() + 1;
4291 if (hasUnwindDest())
4292 ++It;
4293 return const_handler_iterator(It, ConstDerefFnTy(handler_helper));
4294 }
4295
4296 /// Returns a read-only iterator that points one past the last
4297 /// handler in the CatchSwitchInst.
4298 handler_iterator handler_end() {
4299 return handler_iterator(op_end(), DerefFnTy(handler_helper));
4300 }
4301
4302 /// Returns an iterator that points one past the last handler in the
4303 /// CatchSwitchInst.
4304 const_handler_iterator handler_end() const {
4305 return const_handler_iterator(op_end(), ConstDerefFnTy(handler_helper));
4306 }
4307
4308 /// iteration adapter for range-for loops.
4309 handler_range handlers() {
4310 return make_range(handler_begin(), handler_end());
4311 }
4312
4313 /// iteration adapter for range-for loops.
4314 const_handler_range handlers() const {
4315 return make_range(handler_begin(), handler_end());
4316 }
4317
4318 /// Add an entry to the switch instruction...
4319 /// Note:
4320 /// This action invalidates handler_end(). Old handler_end() iterator will
4321 /// point to the added handler.
4322 void addHandler(BasicBlock *Dest);
4323
4324 void removeHandler(handler_iterator HI);
4325
4326 unsigned getNumSuccessors() const { return getNumOperands() - 1; }
4327 BasicBlock *getSuccessor(unsigned Idx) const {
4328 assert(Idx < getNumSuccessors() &&((Idx < getNumSuccessors() && "Successor # out of range for catchswitch!"
) ? static_cast<void> (0) : __assert_fail ("Idx < getNumSuccessors() && \"Successor # out of range for catchswitch!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4329, __PRETTY_FUNCTION__))
4329 "Successor # out of range for catchswitch!")((Idx < getNumSuccessors() && "Successor # out of range for catchswitch!"
) ? static_cast<void> (0) : __assert_fail ("Idx < getNumSuccessors() && \"Successor # out of range for catchswitch!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4329, __PRETTY_FUNCTION__))
;
4330 return cast<BasicBlock>(getOperand(Idx + 1));
4331 }
4332 void setSuccessor(unsigned Idx, BasicBlock *NewSucc) {
4333 assert(Idx < getNumSuccessors() &&((Idx < getNumSuccessors() && "Successor # out of range for catchswitch!"
) ? static_cast<void> (0) : __assert_fail ("Idx < getNumSuccessors() && \"Successor # out of range for catchswitch!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4334, __PRETTY_FUNCTION__))
4334 "Successor # out of range for catchswitch!")((Idx < getNumSuccessors() && "Successor # out of range for catchswitch!"
) ? static_cast<void> (0) : __assert_fail ("Idx < getNumSuccessors() && \"Successor # out of range for catchswitch!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4334, __PRETTY_FUNCTION__))
;
4335 setOperand(Idx + 1, NewSucc);
4336 }
4337
4338 // Methods for support type inquiry through isa, cast, and dyn_cast:
4339 static bool classof(const Instruction *I) {
4340 return I->getOpcode() == Instruction::CatchSwitch;
4341 }
4342 static bool classof(const Value *V) {
4343 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4344 }
4345};
4346
4347template <>
4348struct OperandTraits<CatchSwitchInst> : public HungoffOperandTraits<2> {};
4349
4350DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CatchSwitchInst, Value)CatchSwitchInst::op_iterator CatchSwitchInst::op_begin() { return
OperandTraits<CatchSwitchInst>::op_begin(this); } CatchSwitchInst
::const_op_iterator CatchSwitchInst::op_begin() const { return
OperandTraits<CatchSwitchInst>::op_begin(const_cast<
CatchSwitchInst*>(this)); } CatchSwitchInst::op_iterator CatchSwitchInst
::op_end() { return OperandTraits<CatchSwitchInst>::op_end
(this); } CatchSwitchInst::const_op_iterator CatchSwitchInst::
op_end() const { return OperandTraits<CatchSwitchInst>::
op_end(const_cast<CatchSwitchInst*>(this)); } Value *CatchSwitchInst
::getOperand(unsigned i_nocapture) const { ((i_nocapture <
OperandTraits<CatchSwitchInst>::operands(this) &&
"getOperand() out of range!") ? static_cast<void> (0) :
__assert_fail ("i_nocapture < OperandTraits<CatchSwitchInst>::operands(this) && \"getOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4350, __PRETTY_FUNCTION__)); return cast_or_null<Value>
( OperandTraits<CatchSwitchInst>::op_begin(const_cast<
CatchSwitchInst*>(this))[i_nocapture].get()); } void CatchSwitchInst
::setOperand(unsigned i_nocapture, Value *Val_nocapture) { ((
i_nocapture < OperandTraits<CatchSwitchInst>::operands
(this) && "setOperand() out of range!") ? static_cast
<void> (0) : __assert_fail ("i_nocapture < OperandTraits<CatchSwitchInst>::operands(this) && \"setOperand() out of range!\""
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4350, __PRETTY_FUNCTION__)); OperandTraits<CatchSwitchInst
>::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned
CatchSwitchInst::getNumOperands() const { return OperandTraits
<CatchSwitchInst>::operands(this); } template <int Idx_nocapture
> Use &CatchSwitchInst::Op() { return this->OpFrom<
Idx_nocapture>(this); } template <int Idx_nocapture>
const Use &CatchSwitchInst::Op() const { return this->
OpFrom<Idx_nocapture>(this); }
4351
4352//===----------------------------------------------------------------------===//
4353// CleanupPadInst Class
4354//===----------------------------------------------------------------------===//
4355class CleanupPadInst : public FuncletPadInst {
4356private:
4357 explicit CleanupPadInst(Value *ParentPad, ArrayRef<Value *> Args,
4358 unsigned Values, const Twine &NameStr,
4359 Instruction *InsertBefore)
4360 : FuncletPadInst(Instruction::CleanupPad, ParentPad, Args, Values,
4361 NameStr, InsertBefore) {}
4362 explicit CleanupPadInst(Value *ParentPad, ArrayRef<Value *> Args,
4363 unsigned Values, const Twine &NameStr,
4364 BasicBlock *InsertAtEnd)
4365 : FuncletPadInst(Instruction::CleanupPad, ParentPad, Args, Values,
4366 NameStr, InsertAtEnd) {}
4367
4368public:
4369 static CleanupPadInst *Create(Value *ParentPad, ArrayRef<Value *> Args = None,
4370 const Twine &NameStr = "",
4371 Instruction *InsertBefore = nullptr) {
4372 unsigned Values = 1 + Args.size();
4373 return new (Values)
4374 CleanupPadInst(ParentPad, Args, Values, NameStr, InsertBefore);
4375 }
4376
4377 static CleanupPadInst *Create(Value *ParentPad, ArrayRef<Value *> Args,
4378 const Twine &NameStr, BasicBlock *InsertAtEnd) {
4379 unsigned Values = 1 + Args.size();
4380 return new (Values)
4381 CleanupPadInst(ParentPad, Args, Values, NameStr, InsertAtEnd);
4382 }
4383
4384 /// Methods for support type inquiry through isa, cast, and dyn_cast:
4385 static bool classof(const Instruction *I) {
4386 return I->getOpcode() == Instruction::CleanupPad;
4387 }
4388 static bool classof(const Value *V) {
4389 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4390 }
4391};
4392
4393//===----------------------------------------------------------------------===//
4394// CatchPadInst Class
4395//===----------------------------------------------------------------------===//
4396class CatchPadInst : public FuncletPadInst {
4397private:
4398 explicit CatchPadInst(Value *CatchSwitch, ArrayRef<Value *> Args,
4399 unsigned Values, const Twine &NameStr,
4400 Instruction *InsertBefore)
4401 : FuncletPadInst(Instruction::CatchPad, CatchSwitch, Args, Values,
4402 NameStr, InsertBefore) {}
4403 explicit CatchPadInst(Value *CatchSwitch, ArrayRef<Value *> Args,
4404 unsigned Values, const Twine &NameStr,
4405 BasicBlock *InsertAtEnd)
4406 : FuncletPadInst(Instruction::CatchPad, CatchSwitch, Args, Values,
4407 NameStr, InsertAtEnd) {}
4408
4409public:
4410 static CatchPadInst *Create(Value *CatchSwitch, ArrayRef<Value *> Args,
4411 const Twine &NameStr = "",
4412 Instruction *InsertBefore = nullptr) {
4413 unsigned Values = 1 + Args.size();
4414 return new (Values)
4415 CatchPadInst(CatchSwitch, Args, Values, NameStr, InsertBefore);
4416 }
4417
4418 static CatchPadInst *Create(Value *CatchSwitch, ArrayRef<Value *> Args,
4419 const Twine &NameStr, BasicBlock *InsertAtEnd) {
4420 unsigned Values = 1 + Args.size();
4421 return new (Values)
4422 CatchPadInst(CatchSwitch, Args, Values, NameStr, InsertAtEnd);
4423 }
4424
4425 /// Convenience accessors
4426 CatchSwitchInst *getCatchSwitch() const {
4427 return cast<CatchSwitchInst>(Op<-1>());
4428 }
4429 void setCatchSwitch(Value *CatchSwitch) {
4430 assert(CatchSwitch)((CatchSwitch) ? static_cast<void> (0) : __assert_fail (
"CatchSwitch", "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4430, __PRETTY_FUNCTION__))
;
4431 Op<-1>() = CatchSwitch;
4432 }
4433
4434 /// Methods for support type inquiry through isa, cast, and dyn_cast:
4435 static bool classof(const Instruction *I) {
4436 return I->getOpcode() == Instruction::CatchPad;
4437 }
4438 static bool classof(const Value *V) {
4439 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4440 }
4441};
4442
4443//===----------------------------------------------------------------------===//
4444// CatchReturnInst Class
4445//===----------------------------------------------------------------------===//
4446
4447class CatchReturnInst : public Instruction {
4448 CatchReturnInst(const CatchReturnInst &RI);
4449 CatchReturnInst(Value *CatchPad, BasicBlock *BB, Instruction *InsertBefore);
4450 CatchReturnInst(Value *CatchPad, BasicBlock *BB, BasicBlock *InsertAtEnd);
4451
4452 void init(Value *CatchPad, BasicBlock *BB);
4453
4454protected:
4455 // Note: Instruction needs to be a friend here to call cloneImpl.
4456 friend class Instruction;
4457
4458 CatchReturnInst *cloneImpl() const;
4459
4460public:
4461 static CatchReturnInst *Create(Value *CatchPad, BasicBlock *BB,
4462 Instruction *InsertBefore = nullptr) {
4463 assert(CatchPad)((CatchPad) ? static_cast<void> (0) : __assert_fail ("CatchPad"
, "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4463, __PRETTY_FUNCTION__))
;
4464 assert(BB)((BB) ? static_cast<void> (0) : __assert_fail ("BB", "/build/llvm-toolchain-snapshot-12~++20200927111121+5811d723998/llvm/include/llvm/IR/Instructions.h"
, 4464, __PRETTY_FUNCTION__))
;
4465 return new (2) CatchReturnInst(CatchPad, BB, InsertBefore);
4466 }
4467
4468