Bug Summary

File:llvm/lib/Transforms/ObjCARC/ObjCARCContract.cpp
Warning:line 387, 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 -debugger-tuning=gdb -ffunction-sections -fdata-sections -fcoverage-compilation-dir=/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/lib/Transforms/ObjCARC -resource-dir /usr/lib/llvm-14/lib/clang/14.0.0 -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/lib/Transforms/ObjCARC -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/llvm/lib/Transforms/ObjCARC -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/include -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/llvm/include -D NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/x86_64-linux-gnu/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10/backward -internal-isystem /usr/lib/llvm-14/lib/clang/14.0.0/include -internal-isystem /usr/local/include -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../x86_64-linux-gnu/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-class-memaccess -Wno-redundant-move -Wno-pessimizing-move -Wno-noexcept-type -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir=/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/lib/Transforms/ObjCARC -fdebug-prefix-map=/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e=. -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 -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /tmp/scan-build-2021-09-04-040900-46481-1 -x c++ /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/llvm/lib/Transforms/ObjCARC/ObjCARCContract.cpp

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

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