1 //===- SimplifyCFG.cpp - Code to perform CFG simplification ---------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Peephole optimize the CFG.
12 //===----------------------------------------------------------------------===//
14 #define DEBUG_TYPE "simplifycfg"
15 #include "llvm/Transforms/Utils/Local.h"
16 #include "llvm/ADT/DenseMap.h"
17 #include "llvm/ADT/STLExtras.h"
18 #include "llvm/ADT/SetVector.h"
19 #include "llvm/ADT/SmallPtrSet.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/Statistic.h"
22 #include "llvm/Analysis/InstructionSimplify.h"
23 #include "llvm/Analysis/TargetTransformInfo.h"
24 #include "llvm/Analysis/ValueTracking.h"
25 #include "llvm/IR/Constants.h"
26 #include "llvm/IR/DataLayout.h"
27 #include "llvm/IR/DerivedTypes.h"
28 #include "llvm/IR/GlobalVariable.h"
29 #include "llvm/IR/IRBuilder.h"
30 #include "llvm/IR/Instructions.h"
31 #include "llvm/IR/IntrinsicInst.h"
32 #include "llvm/IR/LLVMContext.h"
33 #include "llvm/IR/MDBuilder.h"
34 #include "llvm/IR/Metadata.h"
35 #include "llvm/IR/Module.h"
36 #include "llvm/IR/Operator.h"
37 #include "llvm/IR/Type.h"
38 #include "llvm/Support/CFG.h"
39 #include "llvm/Support/CommandLine.h"
40 #include "llvm/Support/ConstantRange.h"
41 #include "llvm/Support/Debug.h"
42 #include "llvm/Support/NoFolder.h"
43 #include "llvm/Support/raw_ostream.h"
44 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
50 static cl::opt<unsigned>
51 PHINodeFoldingThreshold("phi-node-folding-threshold", cl::Hidden, cl::init(1),
52 cl::desc("Control the amount of phi node folding to perform (default = 1)"));
55 DupRet("simplifycfg-dup-ret", cl::Hidden, cl::init(false),
56 cl::desc("Duplicate return instructions into unconditional branches"));
59 SinkCommon("simplifycfg-sink-common", cl::Hidden, cl::init(true),
60 cl::desc("Sink common instructions down to the end block"));
63 HoistCondStores("simplifycfg-hoist-cond-stores", cl::Hidden, cl::init(true),
64 cl::desc("Hoist conditional stores if an unconditional store preceeds"));
66 STATISTIC(NumBitMaps, "Number of switch instructions turned into bitmaps");
67 STATISTIC(NumLookupTables, "Number of switch instructions turned into lookup tables");
68 STATISTIC(NumSinkCommons, "Number of common instructions sunk down to the end block");
69 STATISTIC(NumSpeculations, "Number of speculative executed instructions");
72 /// ValueEqualityComparisonCase - Represents a case of a switch.
73 struct ValueEqualityComparisonCase {
77 ValueEqualityComparisonCase(ConstantInt *Value, BasicBlock *Dest)
78 : Value(Value), Dest(Dest) {}
80 bool operator<(ValueEqualityComparisonCase RHS) const {
81 // Comparing pointers is ok as we only rely on the order for uniquing.
82 return Value < RHS.Value;
85 bool operator==(BasicBlock *RHSDest) const { return Dest == RHSDest; }
88 class SimplifyCFGOpt {
89 const TargetTransformInfo &TTI;
90 const DataLayout *const TD;
92 Value *isValueEqualityComparison(TerminatorInst *TI);
93 BasicBlock *GetValueEqualityComparisonCases(TerminatorInst *TI,
94 std::vector<ValueEqualityComparisonCase> &Cases);
95 bool SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
97 IRBuilder<> &Builder);
98 bool FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
99 IRBuilder<> &Builder);
101 bool SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder);
102 bool SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder);
103 bool SimplifyUnreachable(UnreachableInst *UI);
104 bool SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder);
105 bool SimplifyIndirectBr(IndirectBrInst *IBI);
106 bool SimplifyUncondBranch(BranchInst *BI, IRBuilder <> &Builder);
107 bool SimplifyCondBranch(BranchInst *BI, IRBuilder <>&Builder);
110 SimplifyCFGOpt(const TargetTransformInfo &TTI, const DataLayout *TD)
111 : TTI(TTI), TD(TD) {}
112 bool run(BasicBlock *BB);
116 /// SafeToMergeTerminators - Return true if it is safe to merge these two
117 /// terminator instructions together.
119 static bool SafeToMergeTerminators(TerminatorInst *SI1, TerminatorInst *SI2) {
120 if (SI1 == SI2) return false; // Can't merge with self!
122 // It is not safe to merge these two switch instructions if they have a common
123 // successor, and if that successor has a PHI node, and if *that* PHI node has
124 // conflicting incoming values from the two switch blocks.
125 BasicBlock *SI1BB = SI1->getParent();
126 BasicBlock *SI2BB = SI2->getParent();
127 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
129 for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
130 if (SI1Succs.count(*I))
131 for (BasicBlock::iterator BBI = (*I)->begin();
132 isa<PHINode>(BBI); ++BBI) {
133 PHINode *PN = cast<PHINode>(BBI);
134 if (PN->getIncomingValueForBlock(SI1BB) !=
135 PN->getIncomingValueForBlock(SI2BB))
142 /// isProfitableToFoldUnconditional - Return true if it is safe and profitable
143 /// to merge these two terminator instructions together, where SI1 is an
144 /// unconditional branch. PhiNodes will store all PHI nodes in common
147 static bool isProfitableToFoldUnconditional(BranchInst *SI1,
150 SmallVectorImpl<PHINode*> &PhiNodes) {
151 if (SI1 == SI2) return false; // Can't merge with self!
152 assert(SI1->isUnconditional() && SI2->isConditional());
154 // We fold the unconditional branch if we can easily update all PHI nodes in
155 // common successors:
156 // 1> We have a constant incoming value for the conditional branch;
157 // 2> We have "Cond" as the incoming value for the unconditional branch;
158 // 3> SI2->getCondition() and Cond have same operands.
159 CmpInst *Ci2 = dyn_cast<CmpInst>(SI2->getCondition());
160 if (!Ci2) return false;
161 if (!(Cond->getOperand(0) == Ci2->getOperand(0) &&
162 Cond->getOperand(1) == Ci2->getOperand(1)) &&
163 !(Cond->getOperand(0) == Ci2->getOperand(1) &&
164 Cond->getOperand(1) == Ci2->getOperand(0)))
167 BasicBlock *SI1BB = SI1->getParent();
168 BasicBlock *SI2BB = SI2->getParent();
169 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
170 for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
171 if (SI1Succs.count(*I))
172 for (BasicBlock::iterator BBI = (*I)->begin();
173 isa<PHINode>(BBI); ++BBI) {
174 PHINode *PN = cast<PHINode>(BBI);
175 if (PN->getIncomingValueForBlock(SI1BB) != Cond ||
176 !isa<ConstantInt>(PN->getIncomingValueForBlock(SI2BB)))
178 PhiNodes.push_back(PN);
183 /// AddPredecessorToBlock - Update PHI nodes in Succ to indicate that there will
184 /// now be entries in it from the 'NewPred' block. The values that will be
185 /// flowing into the PHI nodes will be the same as those coming in from
186 /// ExistPred, an existing predecessor of Succ.
187 static void AddPredecessorToBlock(BasicBlock *Succ, BasicBlock *NewPred,
188 BasicBlock *ExistPred) {
189 if (!isa<PHINode>(Succ->begin())) return; // Quick exit if nothing to do
192 for (BasicBlock::iterator I = Succ->begin();
193 (PN = dyn_cast<PHINode>(I)); ++I)
194 PN->addIncoming(PN->getIncomingValueForBlock(ExistPred), NewPred);
198 /// GetIfCondition - Given a basic block (BB) with two predecessors (and at
199 /// least one PHI node in it), check to see if the merge at this block is due
200 /// to an "if condition". If so, return the boolean condition that determines
201 /// which entry into BB will be taken. Also, return by references the block
202 /// that will be entered from if the condition is true, and the block that will
203 /// be entered if the condition is false.
205 /// This does no checking to see if the true/false blocks have large or unsavory
206 /// instructions in them.
207 static Value *GetIfCondition(BasicBlock *BB, BasicBlock *&IfTrue,
208 BasicBlock *&IfFalse) {
209 PHINode *SomePHI = cast<PHINode>(BB->begin());
210 assert(SomePHI->getNumIncomingValues() == 2 &&
211 "Function can only handle blocks with 2 predecessors!");
212 BasicBlock *Pred1 = SomePHI->getIncomingBlock(0);
213 BasicBlock *Pred2 = SomePHI->getIncomingBlock(1);
215 // We can only handle branches. Other control flow will be lowered to
216 // branches if possible anyway.
217 BranchInst *Pred1Br = dyn_cast<BranchInst>(Pred1->getTerminator());
218 BranchInst *Pred2Br = dyn_cast<BranchInst>(Pred2->getTerminator());
219 if (Pred1Br == 0 || Pred2Br == 0)
222 // Eliminate code duplication by ensuring that Pred1Br is conditional if
224 if (Pred2Br->isConditional()) {
225 // If both branches are conditional, we don't have an "if statement". In
226 // reality, we could transform this case, but since the condition will be
227 // required anyway, we stand no chance of eliminating it, so the xform is
228 // probably not profitable.
229 if (Pred1Br->isConditional())
232 std::swap(Pred1, Pred2);
233 std::swap(Pred1Br, Pred2Br);
236 if (Pred1Br->isConditional()) {
237 // The only thing we have to watch out for here is to make sure that Pred2
238 // doesn't have incoming edges from other blocks. If it does, the condition
239 // doesn't dominate BB.
240 if (Pred2->getSinglePredecessor() == 0)
243 // If we found a conditional branch predecessor, make sure that it branches
244 // to BB and Pred2Br. If it doesn't, this isn't an "if statement".
245 if (Pred1Br->getSuccessor(0) == BB &&
246 Pred1Br->getSuccessor(1) == Pred2) {
249 } else if (Pred1Br->getSuccessor(0) == Pred2 &&
250 Pred1Br->getSuccessor(1) == BB) {
254 // We know that one arm of the conditional goes to BB, so the other must
255 // go somewhere unrelated, and this must not be an "if statement".
259 return Pred1Br->getCondition();
262 // Ok, if we got here, both predecessors end with an unconditional branch to
263 // BB. Don't panic! If both blocks only have a single (identical)
264 // predecessor, and THAT is a conditional branch, then we're all ok!
265 BasicBlock *CommonPred = Pred1->getSinglePredecessor();
266 if (CommonPred == 0 || CommonPred != Pred2->getSinglePredecessor())
269 // Otherwise, if this is a conditional branch, then we can use it!
270 BranchInst *BI = dyn_cast<BranchInst>(CommonPred->getTerminator());
271 if (BI == 0) return 0;
273 assert(BI->isConditional() && "Two successors but not conditional?");
274 if (BI->getSuccessor(0) == Pred1) {
281 return BI->getCondition();
284 /// ComputeSpeculationCost - Compute an abstract "cost" of speculating the
285 /// given instruction, which is assumed to be safe to speculate. 1 means
286 /// cheap, 2 means less cheap, and UINT_MAX means prohibitively expensive.
287 static unsigned ComputeSpeculationCost(const User *I) {
288 assert(isSafeToSpeculativelyExecute(I) &&
289 "Instruction is not safe to speculatively execute!");
290 switch (Operator::getOpcode(I)) {
292 // In doubt, be conservative.
294 case Instruction::GetElementPtr:
295 // GEPs are cheap if all indices are constant.
296 if (!cast<GEPOperator>(I)->hasAllConstantIndices())
299 case Instruction::Load:
300 case Instruction::Add:
301 case Instruction::Sub:
302 case Instruction::And:
303 case Instruction::Or:
304 case Instruction::Xor:
305 case Instruction::Shl:
306 case Instruction::LShr:
307 case Instruction::AShr:
308 case Instruction::ICmp:
309 case Instruction::Trunc:
310 case Instruction::ZExt:
311 case Instruction::SExt:
312 return 1; // These are all cheap.
314 case Instruction::Call:
315 case Instruction::Select:
320 /// DominatesMergePoint - If we have a merge point of an "if condition" as
321 /// accepted above, return true if the specified value dominates the block. We
322 /// don't handle the true generality of domination here, just a special case
323 /// which works well enough for us.
325 /// If AggressiveInsts is non-null, and if V does not dominate BB, we check to
326 /// see if V (which must be an instruction) and its recursive operands
327 /// that do not dominate BB have a combined cost lower than CostRemaining and
328 /// are non-trapping. If both are true, the instruction is inserted into the
329 /// set and true is returned.
331 /// The cost for most non-trapping instructions is defined as 1 except for
332 /// Select whose cost is 2.
334 /// After this function returns, CostRemaining is decreased by the cost of
335 /// V plus its non-dominating operands. If that cost is greater than
336 /// CostRemaining, false is returned and CostRemaining is undefined.
337 static bool DominatesMergePoint(Value *V, BasicBlock *BB,
338 SmallPtrSet<Instruction*, 4> *AggressiveInsts,
339 unsigned &CostRemaining) {
340 Instruction *I = dyn_cast<Instruction>(V);
342 // Non-instructions all dominate instructions, but not all constantexprs
343 // can be executed unconditionally.
344 if (ConstantExpr *C = dyn_cast<ConstantExpr>(V))
349 BasicBlock *PBB = I->getParent();
351 // We don't want to allow weird loops that might have the "if condition" in
352 // the bottom of this block.
353 if (PBB == BB) return false;
355 // If this instruction is defined in a block that contains an unconditional
356 // branch to BB, then it must be in the 'conditional' part of the "if
357 // statement". If not, it definitely dominates the region.
358 BranchInst *BI = dyn_cast<BranchInst>(PBB->getTerminator());
359 if (BI == 0 || BI->isConditional() || BI->getSuccessor(0) != BB)
362 // If we aren't allowing aggressive promotion anymore, then don't consider
363 // instructions in the 'if region'.
364 if (AggressiveInsts == 0) return false;
366 // If we have seen this instruction before, don't count it again.
367 if (AggressiveInsts->count(I)) return true;
369 // Okay, it looks like the instruction IS in the "condition". Check to
370 // see if it's a cheap instruction to unconditionally compute, and if it
371 // only uses stuff defined outside of the condition. If so, hoist it out.
372 if (!isSafeToSpeculativelyExecute(I))
375 unsigned Cost = ComputeSpeculationCost(I);
377 if (Cost > CostRemaining)
380 CostRemaining -= Cost;
382 // Okay, we can only really hoist these out if their operands do
383 // not take us over the cost threshold.
384 for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i)
385 if (!DominatesMergePoint(*i, BB, AggressiveInsts, CostRemaining))
387 // Okay, it's safe to do this! Remember this instruction.
388 AggressiveInsts->insert(I);
392 /// GetConstantInt - Extract ConstantInt from value, looking through IntToPtr
393 /// and PointerNullValue. Return NULL if value is not a constant int.
394 static ConstantInt *GetConstantInt(Value *V, const DataLayout *TD) {
395 // Normal constant int.
396 ConstantInt *CI = dyn_cast<ConstantInt>(V);
397 if (CI || !TD || !isa<Constant>(V) || !V->getType()->isPointerTy())
400 // This is some kind of pointer constant. Turn it into a pointer-sized
401 // ConstantInt if possible.
402 IntegerType *PtrTy = cast<IntegerType>(TD->getIntPtrType(V->getType()));
404 // Null pointer means 0, see SelectionDAGBuilder::getValue(const Value*).
405 if (isa<ConstantPointerNull>(V))
406 return ConstantInt::get(PtrTy, 0);
408 // IntToPtr const int.
409 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
410 if (CE->getOpcode() == Instruction::IntToPtr)
411 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(0))) {
412 // The constant is very likely to have the right type already.
413 if (CI->getType() == PtrTy)
416 return cast<ConstantInt>
417 (ConstantExpr::getIntegerCast(CI, PtrTy, /*isSigned=*/false));
422 /// GatherConstantCompares - Given a potentially 'or'd or 'and'd together
423 /// collection of icmp eq/ne instructions that compare a value against a
424 /// constant, return the value being compared, and stick the constant into the
427 GatherConstantCompares(Value *V, std::vector<ConstantInt*> &Vals, Value *&Extra,
428 const DataLayout *TD, bool isEQ, unsigned &UsedICmps) {
429 Instruction *I = dyn_cast<Instruction>(V);
430 if (I == 0) return 0;
432 // If this is an icmp against a constant, handle this as one of the cases.
433 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I)) {
434 if (ConstantInt *C = GetConstantInt(I->getOperand(1), TD)) {
435 if (ICI->getPredicate() == (isEQ ? ICmpInst::ICMP_EQ:ICmpInst::ICMP_NE)) {
438 return I->getOperand(0);
441 // If we have "x ult 3" comparison, for example, then we can add 0,1,2 to
444 ConstantRange::makeICmpRegion(ICI->getPredicate(), C->getValue());
446 // If this is an and/!= check then we want to optimize "x ugt 2" into
449 Span = Span.inverse();
451 // If there are a ton of values, we don't want to make a ginormous switch.
452 if (Span.getSetSize().ugt(8) || Span.isEmptySet())
455 for (APInt Tmp = Span.getLower(); Tmp != Span.getUpper(); ++Tmp)
456 Vals.push_back(ConstantInt::get(V->getContext(), Tmp));
458 return I->getOperand(0);
463 // Otherwise, we can only handle an | or &, depending on isEQ.
464 if (I->getOpcode() != (isEQ ? Instruction::Or : Instruction::And))
467 unsigned NumValsBeforeLHS = Vals.size();
468 unsigned UsedICmpsBeforeLHS = UsedICmps;
469 if (Value *LHS = GatherConstantCompares(I->getOperand(0), Vals, Extra, TD,
471 unsigned NumVals = Vals.size();
472 unsigned UsedICmpsBeforeRHS = UsedICmps;
473 if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
477 Vals.resize(NumVals);
478 UsedICmps = UsedICmpsBeforeRHS;
481 // The RHS of the or/and can't be folded in and we haven't used "Extra" yet,
482 // set it and return success.
483 if (Extra == 0 || Extra == I->getOperand(1)) {
484 Extra = I->getOperand(1);
488 Vals.resize(NumValsBeforeLHS);
489 UsedICmps = UsedICmpsBeforeLHS;
493 // If the LHS can't be folded in, but Extra is available and RHS can, try to
495 if (Extra == 0 || Extra == I->getOperand(0)) {
496 Value *OldExtra = Extra;
497 Extra = I->getOperand(0);
498 if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
501 assert(Vals.size() == NumValsBeforeLHS);
508 static void EraseTerminatorInstAndDCECond(TerminatorInst *TI) {
509 Instruction *Cond = 0;
510 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
511 Cond = dyn_cast<Instruction>(SI->getCondition());
512 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
513 if (BI->isConditional())
514 Cond = dyn_cast<Instruction>(BI->getCondition());
515 } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(TI)) {
516 Cond = dyn_cast<Instruction>(IBI->getAddress());
519 TI->eraseFromParent();
520 if (Cond) RecursivelyDeleteTriviallyDeadInstructions(Cond);
523 /// isValueEqualityComparison - Return true if the specified terminator checks
524 /// to see if a value is equal to constant integer value.
525 Value *SimplifyCFGOpt::isValueEqualityComparison(TerminatorInst *TI) {
527 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
528 // Do not permit merging of large switch instructions into their
529 // predecessors unless there is only one predecessor.
530 if (SI->getNumSuccessors()*std::distance(pred_begin(SI->getParent()),
531 pred_end(SI->getParent())) <= 128)
532 CV = SI->getCondition();
533 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI))
534 if (BI->isConditional() && BI->getCondition()->hasOneUse())
535 if (ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition()))
536 if (ICI->isEquality() && GetConstantInt(ICI->getOperand(1), TD))
537 CV = ICI->getOperand(0);
539 // Unwrap any lossless ptrtoint cast.
540 if (TD && CV && CV->getType() == TD->getIntPtrType(CV->getContext()))
541 if (PtrToIntInst *PTII = dyn_cast<PtrToIntInst>(CV))
542 CV = PTII->getOperand(0);
546 /// GetValueEqualityComparisonCases - Given a value comparison instruction,
547 /// decode all of the 'cases' that it represents and return the 'default' block.
548 BasicBlock *SimplifyCFGOpt::
549 GetValueEqualityComparisonCases(TerminatorInst *TI,
550 std::vector<ValueEqualityComparisonCase>
552 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
553 Cases.reserve(SI->getNumCases());
554 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end(); i != e; ++i)
555 Cases.push_back(ValueEqualityComparisonCase(i.getCaseValue(),
556 i.getCaseSuccessor()));
557 return SI->getDefaultDest();
560 BranchInst *BI = cast<BranchInst>(TI);
561 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
562 BasicBlock *Succ = BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_NE);
563 Cases.push_back(ValueEqualityComparisonCase(GetConstantInt(ICI->getOperand(1),
566 return BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_EQ);
570 /// EliminateBlockCases - Given a vector of bb/value pairs, remove any entries
571 /// in the list that match the specified block.
572 static void EliminateBlockCases(BasicBlock *BB,
573 std::vector<ValueEqualityComparisonCase> &Cases) {
574 Cases.erase(std::remove(Cases.begin(), Cases.end(), BB), Cases.end());
577 /// ValuesOverlap - Return true if there are any keys in C1 that exist in C2 as
580 ValuesOverlap(std::vector<ValueEqualityComparisonCase> &C1,
581 std::vector<ValueEqualityComparisonCase > &C2) {
582 std::vector<ValueEqualityComparisonCase> *V1 = &C1, *V2 = &C2;
584 // Make V1 be smaller than V2.
585 if (V1->size() > V2->size())
588 if (V1->size() == 0) return false;
589 if (V1->size() == 1) {
591 ConstantInt *TheVal = (*V1)[0].Value;
592 for (unsigned i = 0, e = V2->size(); i != e; ++i)
593 if (TheVal == (*V2)[i].Value)
597 // Otherwise, just sort both lists and compare element by element.
598 array_pod_sort(V1->begin(), V1->end());
599 array_pod_sort(V2->begin(), V2->end());
600 unsigned i1 = 0, i2 = 0, e1 = V1->size(), e2 = V2->size();
601 while (i1 != e1 && i2 != e2) {
602 if ((*V1)[i1].Value == (*V2)[i2].Value)
604 if ((*V1)[i1].Value < (*V2)[i2].Value)
612 /// SimplifyEqualityComparisonWithOnlyPredecessor - If TI is known to be a
613 /// terminator instruction and its block is known to only have a single
614 /// predecessor block, check to see if that predecessor is also a value
615 /// comparison with the same value, and if that comparison determines the
616 /// outcome of this comparison. If so, simplify TI. This does a very limited
617 /// form of jump threading.
618 bool SimplifyCFGOpt::
619 SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
621 IRBuilder<> &Builder) {
622 Value *PredVal = isValueEqualityComparison(Pred->getTerminator());
623 if (!PredVal) return false; // Not a value comparison in predecessor.
625 Value *ThisVal = isValueEqualityComparison(TI);
626 assert(ThisVal && "This isn't a value comparison!!");
627 if (ThisVal != PredVal) return false; // Different predicates.
629 // TODO: Preserve branch weight metadata, similarly to how
630 // FoldValueComparisonIntoPredecessors preserves it.
632 // Find out information about when control will move from Pred to TI's block.
633 std::vector<ValueEqualityComparisonCase> PredCases;
634 BasicBlock *PredDef = GetValueEqualityComparisonCases(Pred->getTerminator(),
636 EliminateBlockCases(PredDef, PredCases); // Remove default from cases.
638 // Find information about how control leaves this block.
639 std::vector<ValueEqualityComparisonCase> ThisCases;
640 BasicBlock *ThisDef = GetValueEqualityComparisonCases(TI, ThisCases);
641 EliminateBlockCases(ThisDef, ThisCases); // Remove default from cases.
643 // If TI's block is the default block from Pred's comparison, potentially
644 // simplify TI based on this knowledge.
645 if (PredDef == TI->getParent()) {
646 // If we are here, we know that the value is none of those cases listed in
647 // PredCases. If there are any cases in ThisCases that are in PredCases, we
649 if (!ValuesOverlap(PredCases, ThisCases))
652 if (isa<BranchInst>(TI)) {
653 // Okay, one of the successors of this condbr is dead. Convert it to a
655 assert(ThisCases.size() == 1 && "Branch can only have one case!");
656 // Insert the new branch.
657 Instruction *NI = Builder.CreateBr(ThisDef);
660 // Remove PHI node entries for the dead edge.
661 ThisCases[0].Dest->removePredecessor(TI->getParent());
663 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
664 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
666 EraseTerminatorInstAndDCECond(TI);
670 SwitchInst *SI = cast<SwitchInst>(TI);
671 // Okay, TI has cases that are statically dead, prune them away.
672 SmallPtrSet<Constant*, 16> DeadCases;
673 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
674 DeadCases.insert(PredCases[i].Value);
676 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
677 << "Through successor TI: " << *TI);
679 // Collect branch weights into a vector.
680 SmallVector<uint32_t, 8> Weights;
681 MDNode* MD = SI->getMetadata(LLVMContext::MD_prof);
682 bool HasWeight = MD && (MD->getNumOperands() == 2 + SI->getNumCases());
684 for (unsigned MD_i = 1, MD_e = MD->getNumOperands(); MD_i < MD_e;
686 ConstantInt* CI = dyn_cast<ConstantInt>(MD->getOperand(MD_i));
688 Weights.push_back(CI->getValue().getZExtValue());
690 for (SwitchInst::CaseIt i = SI->case_end(), e = SI->case_begin(); i != e;) {
692 if (DeadCases.count(i.getCaseValue())) {
694 std::swap(Weights[i.getCaseIndex()+1], Weights.back());
697 i.getCaseSuccessor()->removePredecessor(TI->getParent());
701 if (HasWeight && Weights.size() >= 2)
702 SI->setMetadata(LLVMContext::MD_prof,
703 MDBuilder(SI->getParent()->getContext()).
704 createBranchWeights(Weights));
706 DEBUG(dbgs() << "Leaving: " << *TI << "\n");
710 // Otherwise, TI's block must correspond to some matched value. Find out
711 // which value (or set of values) this is.
712 ConstantInt *TIV = 0;
713 BasicBlock *TIBB = TI->getParent();
714 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
715 if (PredCases[i].Dest == TIBB) {
717 return false; // Cannot handle multiple values coming to this block.
718 TIV = PredCases[i].Value;
720 assert(TIV && "No edge from pred to succ?");
722 // Okay, we found the one constant that our value can be if we get into TI's
723 // BB. Find out which successor will unconditionally be branched to.
724 BasicBlock *TheRealDest = 0;
725 for (unsigned i = 0, e = ThisCases.size(); i != e; ++i)
726 if (ThisCases[i].Value == TIV) {
727 TheRealDest = ThisCases[i].Dest;
731 // If not handled by any explicit cases, it is handled by the default case.
732 if (TheRealDest == 0) TheRealDest = ThisDef;
734 // Remove PHI node entries for dead edges.
735 BasicBlock *CheckEdge = TheRealDest;
736 for (succ_iterator SI = succ_begin(TIBB), e = succ_end(TIBB); SI != e; ++SI)
737 if (*SI != CheckEdge)
738 (*SI)->removePredecessor(TIBB);
742 // Insert the new branch.
743 Instruction *NI = Builder.CreateBr(TheRealDest);
746 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
747 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
749 EraseTerminatorInstAndDCECond(TI);
754 /// ConstantIntOrdering - This class implements a stable ordering of constant
755 /// integers that does not depend on their address. This is important for
756 /// applications that sort ConstantInt's to ensure uniqueness.
757 struct ConstantIntOrdering {
758 bool operator()(const ConstantInt *LHS, const ConstantInt *RHS) const {
759 return LHS->getValue().ult(RHS->getValue());
764 static int ConstantIntSortPredicate(const void *P1, const void *P2) {
765 const ConstantInt *LHS = *(const ConstantInt*const*)P1;
766 const ConstantInt *RHS = *(const ConstantInt*const*)P2;
767 if (LHS->getValue().ult(RHS->getValue()))
769 if (LHS->getValue() == RHS->getValue())
774 static inline bool HasBranchWeights(const Instruction* I) {
775 MDNode* ProfMD = I->getMetadata(LLVMContext::MD_prof);
776 if (ProfMD && ProfMD->getOperand(0))
777 if (MDString* MDS = dyn_cast<MDString>(ProfMD->getOperand(0)))
778 return MDS->getString().equals("branch_weights");
783 /// Get Weights of a given TerminatorInst, the default weight is at the front
784 /// of the vector. If TI is a conditional eq, we need to swap the branch-weight
786 static void GetBranchWeights(TerminatorInst *TI,
787 SmallVectorImpl<uint64_t> &Weights) {
788 MDNode* MD = TI->getMetadata(LLVMContext::MD_prof);
790 for (unsigned i = 1, e = MD->getNumOperands(); i < e; ++i) {
791 ConstantInt* CI = dyn_cast<ConstantInt>(MD->getOperand(i));
793 Weights.push_back(CI->getValue().getZExtValue());
796 // If TI is a conditional eq, the default case is the false case,
797 // and the corresponding branch-weight data is at index 2. We swap the
798 // default weight to be the first entry.
799 if (BranchInst* BI = dyn_cast<BranchInst>(TI)) {
800 assert(Weights.size() == 2);
801 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
802 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
803 std::swap(Weights.front(), Weights.back());
807 /// Sees if any of the weights are too big for a uint32_t, and halves all the
808 /// weights if any are.
809 static void FitWeights(MutableArrayRef<uint64_t> Weights) {
811 for (unsigned i = 0; i < Weights.size(); ++i)
812 if (Weights[i] > UINT_MAX) {
820 for (unsigned i = 0; i < Weights.size(); ++i)
824 /// FoldValueComparisonIntoPredecessors - The specified terminator is a value
825 /// equality comparison instruction (either a switch or a branch on "X == c").
826 /// See if any of the predecessors of the terminator block are value comparisons
827 /// on the same value. If so, and if safe to do so, fold them together.
828 bool SimplifyCFGOpt::FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
829 IRBuilder<> &Builder) {
830 BasicBlock *BB = TI->getParent();
831 Value *CV = isValueEqualityComparison(TI); // CondVal
832 assert(CV && "Not a comparison?");
833 bool Changed = false;
835 SmallVector<BasicBlock*, 16> Preds(pred_begin(BB), pred_end(BB));
836 while (!Preds.empty()) {
837 BasicBlock *Pred = Preds.pop_back_val();
839 // See if the predecessor is a comparison with the same value.
840 TerminatorInst *PTI = Pred->getTerminator();
841 Value *PCV = isValueEqualityComparison(PTI); // PredCondVal
843 if (PCV == CV && SafeToMergeTerminators(TI, PTI)) {
844 // Figure out which 'cases' to copy from SI to PSI.
845 std::vector<ValueEqualityComparisonCase> BBCases;
846 BasicBlock *BBDefault = GetValueEqualityComparisonCases(TI, BBCases);
848 std::vector<ValueEqualityComparisonCase> PredCases;
849 BasicBlock *PredDefault = GetValueEqualityComparisonCases(PTI, PredCases);
851 // Based on whether the default edge from PTI goes to BB or not, fill in
852 // PredCases and PredDefault with the new switch cases we would like to
854 SmallVector<BasicBlock*, 8> NewSuccessors;
856 // Update the branch weight metadata along the way
857 SmallVector<uint64_t, 8> Weights;
858 bool PredHasWeights = HasBranchWeights(PTI);
859 bool SuccHasWeights = HasBranchWeights(TI);
861 if (PredHasWeights) {
862 GetBranchWeights(PTI, Weights);
863 // branch-weight metadata is inconsistent here.
864 if (Weights.size() != 1 + PredCases.size())
865 PredHasWeights = SuccHasWeights = false;
866 } else if (SuccHasWeights)
867 // If there are no predecessor weights but there are successor weights,
868 // populate Weights with 1, which will later be scaled to the sum of
869 // successor's weights
870 Weights.assign(1 + PredCases.size(), 1);
872 SmallVector<uint64_t, 8> SuccWeights;
873 if (SuccHasWeights) {
874 GetBranchWeights(TI, SuccWeights);
875 // branch-weight metadata is inconsistent here.
876 if (SuccWeights.size() != 1 + BBCases.size())
877 PredHasWeights = SuccHasWeights = false;
878 } else if (PredHasWeights)
879 SuccWeights.assign(1 + BBCases.size(), 1);
881 if (PredDefault == BB) {
882 // If this is the default destination from PTI, only the edges in TI
883 // that don't occur in PTI, or that branch to BB will be activated.
884 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
885 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
886 if (PredCases[i].Dest != BB)
887 PTIHandled.insert(PredCases[i].Value);
889 // The default destination is BB, we don't need explicit targets.
890 std::swap(PredCases[i], PredCases.back());
892 if (PredHasWeights || SuccHasWeights) {
893 // Increase weight for the default case.
894 Weights[0] += Weights[i+1];
895 std::swap(Weights[i+1], Weights.back());
899 PredCases.pop_back();
903 // Reconstruct the new switch statement we will be building.
904 if (PredDefault != BBDefault) {
905 PredDefault->removePredecessor(Pred);
906 PredDefault = BBDefault;
907 NewSuccessors.push_back(BBDefault);
910 unsigned CasesFromPred = Weights.size();
911 uint64_t ValidTotalSuccWeight = 0;
912 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
913 if (!PTIHandled.count(BBCases[i].Value) &&
914 BBCases[i].Dest != BBDefault) {
915 PredCases.push_back(BBCases[i]);
916 NewSuccessors.push_back(BBCases[i].Dest);
917 if (SuccHasWeights || PredHasWeights) {
918 // The default weight is at index 0, so weight for the ith case
919 // should be at index i+1. Scale the cases from successor by
920 // PredDefaultWeight (Weights[0]).
921 Weights.push_back(Weights[0] * SuccWeights[i+1]);
922 ValidTotalSuccWeight += SuccWeights[i+1];
926 if (SuccHasWeights || PredHasWeights) {
927 ValidTotalSuccWeight += SuccWeights[0];
928 // Scale the cases from predecessor by ValidTotalSuccWeight.
929 for (unsigned i = 1; i < CasesFromPred; ++i)
930 Weights[i] *= ValidTotalSuccWeight;
931 // Scale the default weight by SuccDefaultWeight (SuccWeights[0]).
932 Weights[0] *= SuccWeights[0];
935 // If this is not the default destination from PSI, only the edges
936 // in SI that occur in PSI with a destination of BB will be
938 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
939 std::map<ConstantInt*, uint64_t> WeightsForHandled;
940 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
941 if (PredCases[i].Dest == BB) {
942 PTIHandled.insert(PredCases[i].Value);
944 if (PredHasWeights || SuccHasWeights) {
945 WeightsForHandled[PredCases[i].Value] = Weights[i+1];
946 std::swap(Weights[i+1], Weights.back());
950 std::swap(PredCases[i], PredCases.back());
951 PredCases.pop_back();
955 // Okay, now we know which constants were sent to BB from the
956 // predecessor. Figure out where they will all go now.
957 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
958 if (PTIHandled.count(BBCases[i].Value)) {
959 // If this is one we are capable of getting...
960 if (PredHasWeights || SuccHasWeights)
961 Weights.push_back(WeightsForHandled[BBCases[i].Value]);
962 PredCases.push_back(BBCases[i]);
963 NewSuccessors.push_back(BBCases[i].Dest);
964 PTIHandled.erase(BBCases[i].Value);// This constant is taken care of
967 // If there are any constants vectored to BB that TI doesn't handle,
968 // they must go to the default destination of TI.
969 for (std::set<ConstantInt*, ConstantIntOrdering>::iterator I =
971 E = PTIHandled.end(); I != E; ++I) {
972 if (PredHasWeights || SuccHasWeights)
973 Weights.push_back(WeightsForHandled[*I]);
974 PredCases.push_back(ValueEqualityComparisonCase(*I, BBDefault));
975 NewSuccessors.push_back(BBDefault);
979 // Okay, at this point, we know which new successor Pred will get. Make
980 // sure we update the number of entries in the PHI nodes for these
982 for (unsigned i = 0, e = NewSuccessors.size(); i != e; ++i)
983 AddPredecessorToBlock(NewSuccessors[i], Pred, BB);
985 Builder.SetInsertPoint(PTI);
986 // Convert pointer to int before we switch.
987 if (CV->getType()->isPointerTy()) {
988 assert(TD && "Cannot switch on pointer without DataLayout");
989 CV = Builder.CreatePtrToInt(CV, TD->getIntPtrType(CV->getContext()),
993 // Now that the successors are updated, create the new Switch instruction.
994 SwitchInst *NewSI = Builder.CreateSwitch(CV, PredDefault,
996 NewSI->setDebugLoc(PTI->getDebugLoc());
997 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
998 NewSI->addCase(PredCases[i].Value, PredCases[i].Dest);
1000 if (PredHasWeights || SuccHasWeights) {
1001 // Halve the weights if any of them cannot fit in an uint32_t
1002 FitWeights(Weights);
1004 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
1006 NewSI->setMetadata(LLVMContext::MD_prof,
1007 MDBuilder(BB->getContext()).
1008 createBranchWeights(MDWeights));
1011 EraseTerminatorInstAndDCECond(PTI);
1013 // Okay, last check. If BB is still a successor of PSI, then we must
1014 // have an infinite loop case. If so, add an infinitely looping block
1015 // to handle the case to preserve the behavior of the code.
1016 BasicBlock *InfLoopBlock = 0;
1017 for (unsigned i = 0, e = NewSI->getNumSuccessors(); i != e; ++i)
1018 if (NewSI->getSuccessor(i) == BB) {
1019 if (InfLoopBlock == 0) {
1020 // Insert it at the end of the function, because it's either code,
1021 // or it won't matter if it's hot. :)
1022 InfLoopBlock = BasicBlock::Create(BB->getContext(),
1023 "infloop", BB->getParent());
1024 BranchInst::Create(InfLoopBlock, InfLoopBlock);
1026 NewSI->setSuccessor(i, InfLoopBlock);
1035 // isSafeToHoistInvoke - If we would need to insert a select that uses the
1036 // value of this invoke (comments in HoistThenElseCodeToIf explain why we
1037 // would need to do this), we can't hoist the invoke, as there is nowhere
1038 // to put the select in this case.
1039 static bool isSafeToHoistInvoke(BasicBlock *BB1, BasicBlock *BB2,
1040 Instruction *I1, Instruction *I2) {
1041 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1043 for (BasicBlock::iterator BBI = SI->begin();
1044 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1045 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1046 Value *BB2V = PN->getIncomingValueForBlock(BB2);
1047 if (BB1V != BB2V && (BB1V==I1 || BB2V==I2)) {
1055 /// HoistThenElseCodeToIf - Given a conditional branch that goes to BB1 and
1056 /// BB2, hoist any common code in the two blocks up into the branch block. The
1057 /// caller of this function guarantees that BI's block dominates BB1 and BB2.
1058 static bool HoistThenElseCodeToIf(BranchInst *BI) {
1059 // This does very trivial matching, with limited scanning, to find identical
1060 // instructions in the two blocks. In particular, we don't want to get into
1061 // O(M*N) situations here where M and N are the sizes of BB1 and BB2. As
1062 // such, we currently just scan for obviously identical instructions in an
1064 BasicBlock *BB1 = BI->getSuccessor(0); // The true destination.
1065 BasicBlock *BB2 = BI->getSuccessor(1); // The false destination
1067 BasicBlock::iterator BB1_Itr = BB1->begin();
1068 BasicBlock::iterator BB2_Itr = BB2->begin();
1070 Instruction *I1 = BB1_Itr++, *I2 = BB2_Itr++;
1071 // Skip debug info if it is not identical.
1072 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1073 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1074 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1075 while (isa<DbgInfoIntrinsic>(I1))
1077 while (isa<DbgInfoIntrinsic>(I2))
1080 if (isa<PHINode>(I1) || !I1->isIdenticalToWhenDefined(I2) ||
1081 (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2)))
1084 BasicBlock *BIParent = BI->getParent();
1086 bool Changed = false;
1088 // If we are hoisting the terminator instruction, don't move one (making a
1089 // broken BB), instead clone it, and remove BI.
1090 if (isa<TerminatorInst>(I1))
1091 goto HoistTerminator;
1093 // For a normal instruction, we just move one to right before the branch,
1094 // then replace all uses of the other with the first. Finally, we remove
1095 // the now redundant second instruction.
1096 BIParent->getInstList().splice(BI, BB1->getInstList(), I1);
1097 if (!I2->use_empty())
1098 I2->replaceAllUsesWith(I1);
1099 I1->intersectOptionalDataWith(I2);
1100 I2->eraseFromParent();
1105 // Skip debug info if it is not identical.
1106 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1107 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1108 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1109 while (isa<DbgInfoIntrinsic>(I1))
1111 while (isa<DbgInfoIntrinsic>(I2))
1114 } while (I1->isIdenticalToWhenDefined(I2));
1119 // It may not be possible to hoist an invoke.
1120 if (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2))
1123 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1125 for (BasicBlock::iterator BBI = SI->begin();
1126 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1127 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1128 Value *BB2V = PN->getIncomingValueForBlock(BB2);
1132 if (isa<ConstantExpr>(BB1V) && !isSafeToSpeculativelyExecute(BB1V))
1134 if (isa<ConstantExpr>(BB2V) && !isSafeToSpeculativelyExecute(BB2V))
1139 // Okay, it is safe to hoist the terminator.
1140 Instruction *NT = I1->clone();
1141 BIParent->getInstList().insert(BI, NT);
1142 if (!NT->getType()->isVoidTy()) {
1143 I1->replaceAllUsesWith(NT);
1144 I2->replaceAllUsesWith(NT);
1148 IRBuilder<true, NoFolder> Builder(NT);
1149 // Hoisting one of the terminators from our successor is a great thing.
1150 // Unfortunately, the successors of the if/else blocks may have PHI nodes in
1151 // them. If they do, all PHI entries for BB1/BB2 must agree for all PHI
1152 // nodes, so we insert select instruction to compute the final result.
1153 std::map<std::pair<Value*,Value*>, SelectInst*> InsertedSelects;
1154 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1156 for (BasicBlock::iterator BBI = SI->begin();
1157 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1158 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1159 Value *BB2V = PN->getIncomingValueForBlock(BB2);
1160 if (BB1V == BB2V) continue;
1162 // These values do not agree. Insert a select instruction before NT
1163 // that determines the right value.
1164 SelectInst *&SI = InsertedSelects[std::make_pair(BB1V, BB2V)];
1166 SI = cast<SelectInst>
1167 (Builder.CreateSelect(BI->getCondition(), BB1V, BB2V,
1168 BB1V->getName()+"."+BB2V->getName()));
1170 // Make the PHI node use the select for all incoming values for BB1/BB2
1171 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1172 if (PN->getIncomingBlock(i) == BB1 || PN->getIncomingBlock(i) == BB2)
1173 PN->setIncomingValue(i, SI);
1177 // Update any PHI nodes in our new successors.
1178 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI)
1179 AddPredecessorToBlock(*SI, BIParent, BB1);
1181 EraseTerminatorInstAndDCECond(BI);
1185 /// SinkThenElseCodeToEnd - Given an unconditional branch that goes to BBEnd,
1186 /// check whether BBEnd has only two predecessors and the other predecessor
1187 /// ends with an unconditional branch. If it is true, sink any common code
1188 /// in the two predecessors to BBEnd.
1189 static bool SinkThenElseCodeToEnd(BranchInst *BI1) {
1190 assert(BI1->isUnconditional());
1191 BasicBlock *BB1 = BI1->getParent();
1192 BasicBlock *BBEnd = BI1->getSuccessor(0);
1194 // Check that BBEnd has two predecessors and the other predecessor ends with
1195 // an unconditional branch.
1196 pred_iterator PI = pred_begin(BBEnd), PE = pred_end(BBEnd);
1197 BasicBlock *Pred0 = *PI++;
1198 if (PI == PE) // Only one predecessor.
1200 BasicBlock *Pred1 = *PI++;
1201 if (PI != PE) // More than two predecessors.
1203 BasicBlock *BB2 = (Pred0 == BB1) ? Pred1 : Pred0;
1204 BranchInst *BI2 = dyn_cast<BranchInst>(BB2->getTerminator());
1205 if (!BI2 || !BI2->isUnconditional())
1208 // Gather the PHI nodes in BBEnd.
1209 std::map<Value*, std::pair<Value*, PHINode*> > MapValueFromBB1ToBB2;
1210 Instruction *FirstNonPhiInBBEnd = 0;
1211 for (BasicBlock::iterator I = BBEnd->begin(), E = BBEnd->end();
1213 if (PHINode *PN = dyn_cast<PHINode>(I)) {
1214 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1215 Value *BB2V = PN->getIncomingValueForBlock(BB2);
1216 MapValueFromBB1ToBB2[BB1V] = std::make_pair(BB2V, PN);
1218 FirstNonPhiInBBEnd = &*I;
1222 if (!FirstNonPhiInBBEnd)
1226 // This does very trivial matching, with limited scanning, to find identical
1227 // instructions in the two blocks. We scan backward for obviously identical
1228 // instructions in an identical order.
1229 BasicBlock::InstListType::reverse_iterator RI1 = BB1->getInstList().rbegin(),
1230 RE1 = BB1->getInstList().rend(), RI2 = BB2->getInstList().rbegin(),
1231 RE2 = BB2->getInstList().rend();
1233 while (RI1 != RE1 && isa<DbgInfoIntrinsic>(&*RI1)) ++RI1;
1236 while (RI2 != RE2 && isa<DbgInfoIntrinsic>(&*RI2)) ++RI2;
1239 // Skip the unconditional branches.
1243 bool Changed = false;
1244 while (RI1 != RE1 && RI2 != RE2) {
1246 while (RI1 != RE1 && isa<DbgInfoIntrinsic>(&*RI1)) ++RI1;
1249 while (RI2 != RE2 && isa<DbgInfoIntrinsic>(&*RI2)) ++RI2;
1253 Instruction *I1 = &*RI1, *I2 = &*RI2;
1254 // I1 and I2 should have a single use in the same PHI node, and they
1255 // perform the same operation.
1256 // Cannot move control-flow-involving, volatile loads, vaarg, etc.
1257 if (isa<PHINode>(I1) || isa<PHINode>(I2) ||
1258 isa<TerminatorInst>(I1) || isa<TerminatorInst>(I2) ||
1259 isa<LandingPadInst>(I1) || isa<LandingPadInst>(I2) ||
1260 isa<AllocaInst>(I1) || isa<AllocaInst>(I2) ||
1261 I1->mayHaveSideEffects() || I2->mayHaveSideEffects() ||
1262 I1->mayReadOrWriteMemory() || I2->mayReadOrWriteMemory() ||
1263 !I1->hasOneUse() || !I2->hasOneUse() ||
1264 MapValueFromBB1ToBB2.find(I1) == MapValueFromBB1ToBB2.end() ||
1265 MapValueFromBB1ToBB2[I1].first != I2)
1268 // Check whether we should swap the operands of ICmpInst.
1269 ICmpInst *ICmp1 = dyn_cast<ICmpInst>(I1), *ICmp2 = dyn_cast<ICmpInst>(I2);
1270 bool SwapOpnds = false;
1271 if (ICmp1 && ICmp2 &&
1272 ICmp1->getOperand(0) != ICmp2->getOperand(0) &&
1273 ICmp1->getOperand(1) != ICmp2->getOperand(1) &&
1274 (ICmp1->getOperand(0) == ICmp2->getOperand(1) ||
1275 ICmp1->getOperand(1) == ICmp2->getOperand(0))) {
1276 ICmp2->swapOperands();
1279 if (!I1->isSameOperationAs(I2)) {
1281 ICmp2->swapOperands();
1285 // The operands should be either the same or they need to be generated
1286 // with a PHI node after sinking. We only handle the case where there is
1287 // a single pair of different operands.
1288 Value *DifferentOp1 = 0, *DifferentOp2 = 0;
1289 unsigned Op1Idx = 0;
1290 for (unsigned I = 0, E = I1->getNumOperands(); I != E; ++I) {
1291 if (I1->getOperand(I) == I2->getOperand(I))
1293 // Early exit if we have more-than one pair of different operands or
1294 // the different operand is already in MapValueFromBB1ToBB2.
1295 // Early exit if we need a PHI node to replace a constant.
1297 MapValueFromBB1ToBB2.find(I1->getOperand(I)) !=
1298 MapValueFromBB1ToBB2.end() ||
1299 isa<Constant>(I1->getOperand(I)) ||
1300 isa<Constant>(I2->getOperand(I))) {
1301 // If we can't sink the instructions, undo the swapping.
1303 ICmp2->swapOperands();
1306 DifferentOp1 = I1->getOperand(I);
1308 DifferentOp2 = I2->getOperand(I);
1311 // We insert the pair of different operands to MapValueFromBB1ToBB2 and
1312 // remove (I1, I2) from MapValueFromBB1ToBB2.
1314 PHINode *NewPN = PHINode::Create(DifferentOp1->getType(), 2,
1315 DifferentOp1->getName() + ".sink",
1317 MapValueFromBB1ToBB2[DifferentOp1] = std::make_pair(DifferentOp2, NewPN);
1318 // I1 should use NewPN instead of DifferentOp1.
1319 I1->setOperand(Op1Idx, NewPN);
1320 NewPN->addIncoming(DifferentOp1, BB1);
1321 NewPN->addIncoming(DifferentOp2, BB2);
1322 DEBUG(dbgs() << "Create PHI node " << *NewPN << "\n";);
1324 PHINode *OldPN = MapValueFromBB1ToBB2[I1].second;
1325 MapValueFromBB1ToBB2.erase(I1);
1327 DEBUG(dbgs() << "SINK common instructions " << *I1 << "\n";);
1328 DEBUG(dbgs() << " " << *I2 << "\n";);
1329 // We need to update RE1 and RE2 if we are going to sink the first
1330 // instruction in the basic block down.
1331 bool UpdateRE1 = (I1 == BB1->begin()), UpdateRE2 = (I2 == BB2->begin());
1332 // Sink the instruction.
1333 BBEnd->getInstList().splice(FirstNonPhiInBBEnd, BB1->getInstList(), I1);
1334 if (!OldPN->use_empty())
1335 OldPN->replaceAllUsesWith(I1);
1336 OldPN->eraseFromParent();
1338 if (!I2->use_empty())
1339 I2->replaceAllUsesWith(I1);
1340 I1->intersectOptionalDataWith(I2);
1341 I2->eraseFromParent();
1344 RE1 = BB1->getInstList().rend();
1346 RE2 = BB2->getInstList().rend();
1347 FirstNonPhiInBBEnd = I1;
1354 /// \brief Determine if we can hoist sink a sole store instruction out of a
1355 /// conditional block.
1357 /// We are looking for code like the following:
1359 /// store i32 %add, i32* %arrayidx2
1360 /// ... // No other stores or function calls (we could be calling a memory
1361 /// ... // function).
1362 /// %cmp = icmp ult %x, %y
1363 /// br i1 %cmp, label %EndBB, label %ThenBB
1365 /// store i32 %add5, i32* %arrayidx2
1369 /// We are going to transform this into:
1371 /// store i32 %add, i32* %arrayidx2
1373 /// %cmp = icmp ult %x, %y
1374 /// %add.add5 = select i1 %cmp, i32 %add, %add5
1375 /// store i32 %add.add5, i32* %arrayidx2
1378 /// \return The pointer to the value of the previous store if the store can be
1379 /// hoisted into the predecessor block. 0 otherwise.
1380 static Value *isSafeToSpeculateStore(Instruction *I, BasicBlock *BrBB,
1381 BasicBlock *StoreBB, BasicBlock *EndBB) {
1382 StoreInst *StoreToHoist = dyn_cast<StoreInst>(I);
1386 // Volatile or atomic.
1387 if (!StoreToHoist->isSimple())
1390 Value *StorePtr = StoreToHoist->getPointerOperand();
1392 // Look for a store to the same pointer in BrBB.
1393 unsigned MaxNumInstToLookAt = 10;
1394 for (BasicBlock::reverse_iterator RI = BrBB->rbegin(),
1395 RE = BrBB->rend(); RI != RE && (--MaxNumInstToLookAt); ++RI) {
1396 Instruction *CurI = &*RI;
1398 // Could be calling an instruction that effects memory like free().
1399 if (CurI->mayHaveSideEffects() && !isa<StoreInst>(CurI))
1402 StoreInst *SI = dyn_cast<StoreInst>(CurI);
1403 // Found the previous store make sure it stores to the same location.
1404 if (SI && SI->getPointerOperand() == StorePtr)
1405 // Found the previous store, return its value operand.
1406 return SI->getValueOperand();
1408 return 0; // Unknown store.
1414 /// \brief Speculate a conditional basic block flattening the CFG.
1416 /// Note that this is a very risky transform currently. Speculating
1417 /// instructions like this is most often not desirable. Instead, there is an MI
1418 /// pass which can do it with full awareness of the resource constraints.
1419 /// However, some cases are "obvious" and we should do directly. An example of
1420 /// this is speculating a single, reasonably cheap instruction.
1422 /// There is only one distinct advantage to flattening the CFG at the IR level:
1423 /// it makes very common but simplistic optimizations such as are common in
1424 /// instcombine and the DAG combiner more powerful by removing CFG edges and
1425 /// modeling their effects with easier to reason about SSA value graphs.
1428 /// An illustration of this transform is turning this IR:
1431 /// %cmp = icmp ult %x, %y
1432 /// br i1 %cmp, label %EndBB, label %ThenBB
1434 /// %sub = sub %x, %y
1437 /// %phi = phi [ %sub, %ThenBB ], [ 0, %EndBB ]
1444 /// %cmp = icmp ult %x, %y
1445 /// %sub = sub %x, %y
1446 /// %cond = select i1 %cmp, 0, %sub
1450 /// \returns true if the conditional block is removed.
1451 static bool SpeculativelyExecuteBB(BranchInst *BI, BasicBlock *ThenBB) {
1452 // Be conservative for now. FP select instruction can often be expensive.
1453 Value *BrCond = BI->getCondition();
1454 if (isa<FCmpInst>(BrCond))
1457 BasicBlock *BB = BI->getParent();
1458 BasicBlock *EndBB = ThenBB->getTerminator()->getSuccessor(0);
1460 // If ThenBB is actually on the false edge of the conditional branch, remember
1461 // to swap the select operands later.
1462 bool Invert = false;
1463 if (ThenBB != BI->getSuccessor(0)) {
1464 assert(ThenBB == BI->getSuccessor(1) && "No edge from 'if' block?");
1467 assert(EndBB == BI->getSuccessor(!Invert) && "No edge from to end block");
1469 // Keep a count of how many times instructions are used within CondBB when
1470 // they are candidates for sinking into CondBB. Specifically:
1471 // - They are defined in BB, and
1472 // - They have no side effects, and
1473 // - All of their uses are in CondBB.
1474 SmallDenseMap<Instruction *, unsigned, 4> SinkCandidateUseCounts;
1476 unsigned SpeculationCost = 0;
1477 Value *SpeculatedStoreValue = 0;
1478 StoreInst *SpeculatedStore = 0;
1479 for (BasicBlock::iterator BBI = ThenBB->begin(),
1480 BBE = llvm::prior(ThenBB->end());
1481 BBI != BBE; ++BBI) {
1482 Instruction *I = BBI;
1484 if (isa<DbgInfoIntrinsic>(I))
1487 // Only speculatively execution a single instruction (not counting the
1488 // terminator) for now.
1490 if (SpeculationCost > 1)
1493 // Don't hoist the instruction if it's unsafe or expensive.
1494 if (!isSafeToSpeculativelyExecute(I) &&
1495 !(HoistCondStores &&
1496 (SpeculatedStoreValue = isSafeToSpeculateStore(I, BB, ThenBB,
1499 if (!SpeculatedStoreValue &&
1500 ComputeSpeculationCost(I) > PHINodeFoldingThreshold)
1503 // Store the store speculation candidate.
1504 if (SpeculatedStoreValue)
1505 SpeculatedStore = cast<StoreInst>(I);
1507 // Do not hoist the instruction if any of its operands are defined but not
1508 // used in BB. The transformation will prevent the operand from
1509 // being sunk into the use block.
1510 for (User::op_iterator i = I->op_begin(), e = I->op_end();
1512 Instruction *OpI = dyn_cast<Instruction>(*i);
1513 if (!OpI || OpI->getParent() != BB ||
1514 OpI->mayHaveSideEffects())
1515 continue; // Not a candidate for sinking.
1517 ++SinkCandidateUseCounts[OpI];
1521 // Consider any sink candidates which are only used in CondBB as costs for
1522 // speculation. Note, while we iterate over a DenseMap here, we are summing
1523 // and so iteration order isn't significant.
1524 for (SmallDenseMap<Instruction *, unsigned, 4>::iterator I =
1525 SinkCandidateUseCounts.begin(), E = SinkCandidateUseCounts.end();
1527 if (I->first->getNumUses() == I->second) {
1529 if (SpeculationCost > 1)
1533 // Check that the PHI nodes can be converted to selects.
1534 bool HaveRewritablePHIs = false;
1535 for (BasicBlock::iterator I = EndBB->begin();
1536 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1537 Value *OrigV = PN->getIncomingValueForBlock(BB);
1538 Value *ThenV = PN->getIncomingValueForBlock(ThenBB);
1540 // Skip PHIs which are trivial.
1544 HaveRewritablePHIs = true;
1545 ConstantExpr *CE = dyn_cast<ConstantExpr>(ThenV);
1547 continue; // Known safe and cheap.
1549 if (!isSafeToSpeculativelyExecute(CE))
1551 if (ComputeSpeculationCost(CE) > PHINodeFoldingThreshold)
1554 // Account for the cost of an unfolded ConstantExpr which could end up
1555 // getting expanded into Instructions.
1556 // FIXME: This doesn't account for how many operations are combined in the
1557 // constant expression.
1559 if (SpeculationCost > 1)
1563 // If there are no PHIs to process, bail early. This helps ensure idempotence
1565 if (!HaveRewritablePHIs && !(HoistCondStores && SpeculatedStoreValue))
1568 // If we get here, we can hoist the instruction and if-convert.
1569 DEBUG(dbgs() << "SPECULATIVELY EXECUTING BB" << *ThenBB << "\n";);
1571 // Insert a select of the value of the speculated store.
1572 if (SpeculatedStoreValue) {
1573 IRBuilder<true, NoFolder> Builder(BI);
1574 Value *TrueV = SpeculatedStore->getValueOperand();
1575 Value *FalseV = SpeculatedStoreValue;
1577 std::swap(TrueV, FalseV);
1578 Value *S = Builder.CreateSelect(BrCond, TrueV, FalseV, TrueV->getName() +
1579 "." + FalseV->getName());
1580 SpeculatedStore->setOperand(0, S);
1583 // Hoist the instructions.
1584 BB->getInstList().splice(BI, ThenBB->getInstList(), ThenBB->begin(),
1585 llvm::prior(ThenBB->end()));
1587 // Insert selects and rewrite the PHI operands.
1588 IRBuilder<true, NoFolder> Builder(BI);
1589 for (BasicBlock::iterator I = EndBB->begin();
1590 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1591 unsigned OrigI = PN->getBasicBlockIndex(BB);
1592 unsigned ThenI = PN->getBasicBlockIndex(ThenBB);
1593 Value *OrigV = PN->getIncomingValue(OrigI);
1594 Value *ThenV = PN->getIncomingValue(ThenI);
1596 // Skip PHIs which are trivial.
1600 // Create a select whose true value is the speculatively executed value and
1601 // false value is the preexisting value. Swap them if the branch
1602 // destinations were inverted.
1603 Value *TrueV = ThenV, *FalseV = OrigV;
1605 std::swap(TrueV, FalseV);
1606 Value *V = Builder.CreateSelect(BrCond, TrueV, FalseV,
1607 TrueV->getName() + "." + FalseV->getName());
1608 PN->setIncomingValue(OrigI, V);
1609 PN->setIncomingValue(ThenI, V);
1616 /// BlockIsSimpleEnoughToThreadThrough - Return true if we can thread a branch
1617 /// across this block.
1618 static bool BlockIsSimpleEnoughToThreadThrough(BasicBlock *BB) {
1619 BranchInst *BI = cast<BranchInst>(BB->getTerminator());
1622 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
1623 if (isa<DbgInfoIntrinsic>(BBI))
1625 if (Size > 10) return false; // Don't clone large BB's.
1628 // We can only support instructions that do not define values that are
1629 // live outside of the current basic block.
1630 for (Value::use_iterator UI = BBI->use_begin(), E = BBI->use_end();
1632 Instruction *U = cast<Instruction>(*UI);
1633 if (U->getParent() != BB || isa<PHINode>(U)) return false;
1636 // Looks ok, continue checking.
1642 /// FoldCondBranchOnPHI - If we have a conditional branch on a PHI node value
1643 /// that is defined in the same block as the branch and if any PHI entries are
1644 /// constants, thread edges corresponding to that entry to be branches to their
1645 /// ultimate destination.
1646 static bool FoldCondBranchOnPHI(BranchInst *BI, const DataLayout *TD) {
1647 BasicBlock *BB = BI->getParent();
1648 PHINode *PN = dyn_cast<PHINode>(BI->getCondition());
1649 // NOTE: we currently cannot transform this case if the PHI node is used
1650 // outside of the block.
1651 if (!PN || PN->getParent() != BB || !PN->hasOneUse())
1654 // Degenerate case of a single entry PHI.
1655 if (PN->getNumIncomingValues() == 1) {
1656 FoldSingleEntryPHINodes(PN->getParent());
1660 // Now we know that this block has multiple preds and two succs.
1661 if (!BlockIsSimpleEnoughToThreadThrough(BB)) return false;
1663 // Okay, this is a simple enough basic block. See if any phi values are
1665 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1666 ConstantInt *CB = dyn_cast<ConstantInt>(PN->getIncomingValue(i));
1667 if (CB == 0 || !CB->getType()->isIntegerTy(1)) continue;
1669 // Okay, we now know that all edges from PredBB should be revectored to
1670 // branch to RealDest.
1671 BasicBlock *PredBB = PN->getIncomingBlock(i);
1672 BasicBlock *RealDest = BI->getSuccessor(!CB->getZExtValue());
1674 if (RealDest == BB) continue; // Skip self loops.
1675 // Skip if the predecessor's terminator is an indirect branch.
1676 if (isa<IndirectBrInst>(PredBB->getTerminator())) continue;
1678 // The dest block might have PHI nodes, other predecessors and other
1679 // difficult cases. Instead of being smart about this, just insert a new
1680 // block that jumps to the destination block, effectively splitting
1681 // the edge we are about to create.
1682 BasicBlock *EdgeBB = BasicBlock::Create(BB->getContext(),
1683 RealDest->getName()+".critedge",
1684 RealDest->getParent(), RealDest);
1685 BranchInst::Create(RealDest, EdgeBB);
1687 // Update PHI nodes.
1688 AddPredecessorToBlock(RealDest, EdgeBB, BB);
1690 // BB may have instructions that are being threaded over. Clone these
1691 // instructions into EdgeBB. We know that there will be no uses of the
1692 // cloned instructions outside of EdgeBB.
1693 BasicBlock::iterator InsertPt = EdgeBB->begin();
1694 DenseMap<Value*, Value*> TranslateMap; // Track translated values.
1695 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
1696 if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
1697 TranslateMap[PN] = PN->getIncomingValueForBlock(PredBB);
1700 // Clone the instruction.
1701 Instruction *N = BBI->clone();
1702 if (BBI->hasName()) N->setName(BBI->getName()+".c");
1704 // Update operands due to translation.
1705 for (User::op_iterator i = N->op_begin(), e = N->op_end();
1707 DenseMap<Value*, Value*>::iterator PI = TranslateMap.find(*i);
1708 if (PI != TranslateMap.end())
1712 // Check for trivial simplification.
1713 if (Value *V = SimplifyInstruction(N, TD)) {
1714 TranslateMap[BBI] = V;
1715 delete N; // Instruction folded away, don't need actual inst
1717 // Insert the new instruction into its new home.
1718 EdgeBB->getInstList().insert(InsertPt, N);
1719 if (!BBI->use_empty())
1720 TranslateMap[BBI] = N;
1724 // Loop over all of the edges from PredBB to BB, changing them to branch
1725 // to EdgeBB instead.
1726 TerminatorInst *PredBBTI = PredBB->getTerminator();
1727 for (unsigned i = 0, e = PredBBTI->getNumSuccessors(); i != e; ++i)
1728 if (PredBBTI->getSuccessor(i) == BB) {
1729 BB->removePredecessor(PredBB);
1730 PredBBTI->setSuccessor(i, EdgeBB);
1733 // Recurse, simplifying any other constants.
1734 return FoldCondBranchOnPHI(BI, TD) | true;
1740 /// FoldTwoEntryPHINode - Given a BB that starts with the specified two-entry
1741 /// PHI node, see if we can eliminate it.
1742 static bool FoldTwoEntryPHINode(PHINode *PN, const DataLayout *TD) {
1743 // Ok, this is a two entry PHI node. Check to see if this is a simple "if
1744 // statement", which has a very simple dominance structure. Basically, we
1745 // are trying to find the condition that is being branched on, which
1746 // subsequently causes this merge to happen. We really want control
1747 // dependence information for this check, but simplifycfg can't keep it up
1748 // to date, and this catches most of the cases we care about anyway.
1749 BasicBlock *BB = PN->getParent();
1750 BasicBlock *IfTrue, *IfFalse;
1751 Value *IfCond = GetIfCondition(BB, IfTrue, IfFalse);
1753 // Don't bother if the branch will be constant folded trivially.
1754 isa<ConstantInt>(IfCond))
1757 // Okay, we found that we can merge this two-entry phi node into a select.
1758 // Doing so would require us to fold *all* two entry phi nodes in this block.
1759 // At some point this becomes non-profitable (particularly if the target
1760 // doesn't support cmov's). Only do this transformation if there are two or
1761 // fewer PHI nodes in this block.
1762 unsigned NumPhis = 0;
1763 for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++NumPhis, ++I)
1767 // Loop over the PHI's seeing if we can promote them all to select
1768 // instructions. While we are at it, keep track of the instructions
1769 // that need to be moved to the dominating block.
1770 SmallPtrSet<Instruction*, 4> AggressiveInsts;
1771 unsigned MaxCostVal0 = PHINodeFoldingThreshold,
1772 MaxCostVal1 = PHINodeFoldingThreshold;
1774 for (BasicBlock::iterator II = BB->begin(); isa<PHINode>(II);) {
1775 PHINode *PN = cast<PHINode>(II++);
1776 if (Value *V = SimplifyInstruction(PN, TD)) {
1777 PN->replaceAllUsesWith(V);
1778 PN->eraseFromParent();
1782 if (!DominatesMergePoint(PN->getIncomingValue(0), BB, &AggressiveInsts,
1784 !DominatesMergePoint(PN->getIncomingValue(1), BB, &AggressiveInsts,
1789 // If we folded the first phi, PN dangles at this point. Refresh it. If
1790 // we ran out of PHIs then we simplified them all.
1791 PN = dyn_cast<PHINode>(BB->begin());
1792 if (PN == 0) return true;
1794 // Don't fold i1 branches on PHIs which contain binary operators. These can
1795 // often be turned into switches and other things.
1796 if (PN->getType()->isIntegerTy(1) &&
1797 (isa<BinaryOperator>(PN->getIncomingValue(0)) ||
1798 isa<BinaryOperator>(PN->getIncomingValue(1)) ||
1799 isa<BinaryOperator>(IfCond)))
1802 // If we all PHI nodes are promotable, check to make sure that all
1803 // instructions in the predecessor blocks can be promoted as well. If
1804 // not, we won't be able to get rid of the control flow, so it's not
1805 // worth promoting to select instructions.
1806 BasicBlock *DomBlock = 0;
1807 BasicBlock *IfBlock1 = PN->getIncomingBlock(0);
1808 BasicBlock *IfBlock2 = PN->getIncomingBlock(1);
1809 if (cast<BranchInst>(IfBlock1->getTerminator())->isConditional()) {
1812 DomBlock = *pred_begin(IfBlock1);
1813 for (BasicBlock::iterator I = IfBlock1->begin();!isa<TerminatorInst>(I);++I)
1814 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
1815 // This is not an aggressive instruction that we can promote.
1816 // Because of this, we won't be able to get rid of the control
1817 // flow, so the xform is not worth it.
1822 if (cast<BranchInst>(IfBlock2->getTerminator())->isConditional()) {
1825 DomBlock = *pred_begin(IfBlock2);
1826 for (BasicBlock::iterator I = IfBlock2->begin();!isa<TerminatorInst>(I);++I)
1827 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
1828 // This is not an aggressive instruction that we can promote.
1829 // Because of this, we won't be able to get rid of the control
1830 // flow, so the xform is not worth it.
1835 DEBUG(dbgs() << "FOUND IF CONDITION! " << *IfCond << " T: "
1836 << IfTrue->getName() << " F: " << IfFalse->getName() << "\n");
1838 // If we can still promote the PHI nodes after this gauntlet of tests,
1839 // do all of the PHI's now.
1840 Instruction *InsertPt = DomBlock->getTerminator();
1841 IRBuilder<true, NoFolder> Builder(InsertPt);
1843 // Move all 'aggressive' instructions, which are defined in the
1844 // conditional parts of the if's up to the dominating block.
1846 DomBlock->getInstList().splice(InsertPt,
1847 IfBlock1->getInstList(), IfBlock1->begin(),
1848 IfBlock1->getTerminator());
1850 DomBlock->getInstList().splice(InsertPt,
1851 IfBlock2->getInstList(), IfBlock2->begin(),
1852 IfBlock2->getTerminator());
1854 while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
1855 // Change the PHI node into a select instruction.
1856 Value *TrueVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfFalse);
1857 Value *FalseVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfTrue);
1860 cast<SelectInst>(Builder.CreateSelect(IfCond, TrueVal, FalseVal, ""));
1861 PN->replaceAllUsesWith(NV);
1863 PN->eraseFromParent();
1866 // At this point, IfBlock1 and IfBlock2 are both empty, so our if statement
1867 // has been flattened. Change DomBlock to jump directly to our new block to
1868 // avoid other simplifycfg's kicking in on the diamond.
1869 TerminatorInst *OldTI = DomBlock->getTerminator();
1870 Builder.SetInsertPoint(OldTI);
1871 Builder.CreateBr(BB);
1872 OldTI->eraseFromParent();
1876 /// SimplifyCondBranchToTwoReturns - If we found a conditional branch that goes
1877 /// to two returning blocks, try to merge them together into one return,
1878 /// introducing a select if the return values disagree.
1879 static bool SimplifyCondBranchToTwoReturns(BranchInst *BI,
1880 IRBuilder<> &Builder) {
1881 assert(BI->isConditional() && "Must be a conditional branch");
1882 BasicBlock *TrueSucc = BI->getSuccessor(0);
1883 BasicBlock *FalseSucc = BI->getSuccessor(1);
1884 ReturnInst *TrueRet = cast<ReturnInst>(TrueSucc->getTerminator());
1885 ReturnInst *FalseRet = cast<ReturnInst>(FalseSucc->getTerminator());
1887 // Check to ensure both blocks are empty (just a return) or optionally empty
1888 // with PHI nodes. If there are other instructions, merging would cause extra
1889 // computation on one path or the other.
1890 if (!TrueSucc->getFirstNonPHIOrDbg()->isTerminator())
1892 if (!FalseSucc->getFirstNonPHIOrDbg()->isTerminator())
1895 Builder.SetInsertPoint(BI);
1896 // Okay, we found a branch that is going to two return nodes. If
1897 // there is no return value for this function, just change the
1898 // branch into a return.
1899 if (FalseRet->getNumOperands() == 0) {
1900 TrueSucc->removePredecessor(BI->getParent());
1901 FalseSucc->removePredecessor(BI->getParent());
1902 Builder.CreateRetVoid();
1903 EraseTerminatorInstAndDCECond(BI);
1907 // Otherwise, figure out what the true and false return values are
1908 // so we can insert a new select instruction.
1909 Value *TrueValue = TrueRet->getReturnValue();
1910 Value *FalseValue = FalseRet->getReturnValue();
1912 // Unwrap any PHI nodes in the return blocks.
1913 if (PHINode *TVPN = dyn_cast_or_null<PHINode>(TrueValue))
1914 if (TVPN->getParent() == TrueSucc)
1915 TrueValue = TVPN->getIncomingValueForBlock(BI->getParent());
1916 if (PHINode *FVPN = dyn_cast_or_null<PHINode>(FalseValue))
1917 if (FVPN->getParent() == FalseSucc)
1918 FalseValue = FVPN->getIncomingValueForBlock(BI->getParent());
1920 // In order for this transformation to be safe, we must be able to
1921 // unconditionally execute both operands to the return. This is
1922 // normally the case, but we could have a potentially-trapping
1923 // constant expression that prevents this transformation from being
1925 if (ConstantExpr *TCV = dyn_cast_or_null<ConstantExpr>(TrueValue))
1928 if (ConstantExpr *FCV = dyn_cast_or_null<ConstantExpr>(FalseValue))
1932 // Okay, we collected all the mapped values and checked them for sanity, and
1933 // defined to really do this transformation. First, update the CFG.
1934 TrueSucc->removePredecessor(BI->getParent());
1935 FalseSucc->removePredecessor(BI->getParent());
1937 // Insert select instructions where needed.
1938 Value *BrCond = BI->getCondition();
1940 // Insert a select if the results differ.
1941 if (TrueValue == FalseValue || isa<UndefValue>(FalseValue)) {
1942 } else if (isa<UndefValue>(TrueValue)) {
1943 TrueValue = FalseValue;
1945 TrueValue = Builder.CreateSelect(BrCond, TrueValue,
1946 FalseValue, "retval");
1950 Value *RI = !TrueValue ?
1951 Builder.CreateRetVoid() : Builder.CreateRet(TrueValue);
1955 DEBUG(dbgs() << "\nCHANGING BRANCH TO TWO RETURNS INTO SELECT:"
1956 << "\n " << *BI << "NewRet = " << *RI
1957 << "TRUEBLOCK: " << *TrueSucc << "FALSEBLOCK: "<< *FalseSucc);
1959 EraseTerminatorInstAndDCECond(BI);
1964 /// ExtractBranchMetadata - Given a conditional BranchInstruction, retrieve the
1965 /// probabilities of the branch taking each edge. Fills in the two APInt
1966 /// parameters and return true, or returns false if no or invalid metadata was
1968 static bool ExtractBranchMetadata(BranchInst *BI,
1969 uint64_t &ProbTrue, uint64_t &ProbFalse) {
1970 assert(BI->isConditional() &&
1971 "Looking for probabilities on unconditional branch?");
1972 MDNode *ProfileData = BI->getMetadata(LLVMContext::MD_prof);
1973 if (!ProfileData || ProfileData->getNumOperands() != 3) return false;
1974 ConstantInt *CITrue = dyn_cast<ConstantInt>(ProfileData->getOperand(1));
1975 ConstantInt *CIFalse = dyn_cast<ConstantInt>(ProfileData->getOperand(2));
1976 if (!CITrue || !CIFalse) return false;
1977 ProbTrue = CITrue->getValue().getZExtValue();
1978 ProbFalse = CIFalse->getValue().getZExtValue();
1982 /// checkCSEInPredecessor - Return true if the given instruction is available
1983 /// in its predecessor block. If yes, the instruction will be removed.
1985 static bool checkCSEInPredecessor(Instruction *Inst, BasicBlock *PB) {
1986 if (!isa<BinaryOperator>(Inst) && !isa<CmpInst>(Inst))
1988 for (BasicBlock::iterator I = PB->begin(), E = PB->end(); I != E; I++) {
1989 Instruction *PBI = &*I;
1990 // Check whether Inst and PBI generate the same value.
1991 if (Inst->isIdenticalTo(PBI)) {
1992 Inst->replaceAllUsesWith(PBI);
1993 Inst->eraseFromParent();
2000 /// FoldBranchToCommonDest - If this basic block is simple enough, and if a
2001 /// predecessor branches to us and one of our successors, fold the block into
2002 /// the predecessor and use logical operations to pick the right destination.
2003 bool llvm::FoldBranchToCommonDest(BranchInst *BI) {
2004 BasicBlock *BB = BI->getParent();
2006 Instruction *Cond = 0;
2007 if (BI->isConditional())
2008 Cond = dyn_cast<Instruction>(BI->getCondition());
2010 // For unconditional branch, check for a simple CFG pattern, where
2011 // BB has a single predecessor and BB's successor is also its predecessor's
2012 // successor. If such pattern exisits, check for CSE between BB and its
2014 if (BasicBlock *PB = BB->getSinglePredecessor())
2015 if (BranchInst *PBI = dyn_cast<BranchInst>(PB->getTerminator()))
2016 if (PBI->isConditional() &&
2017 (BI->getSuccessor(0) == PBI->getSuccessor(0) ||
2018 BI->getSuccessor(0) == PBI->getSuccessor(1))) {
2019 for (BasicBlock::iterator I = BB->begin(), E = BB->end();
2021 Instruction *Curr = I++;
2022 if (isa<CmpInst>(Curr)) {
2026 // Quit if we can't remove this instruction.
2027 if (!checkCSEInPredecessor(Curr, PB))
2036 if (Cond == 0 || (!isa<CmpInst>(Cond) && !isa<BinaryOperator>(Cond)) ||
2037 Cond->getParent() != BB || !Cond->hasOneUse())
2040 // Only allow this if the condition is a simple instruction that can be
2041 // executed unconditionally. It must be in the same block as the branch, and
2042 // must be at the front of the block.
2043 BasicBlock::iterator FrontIt = BB->front();
2045 // Ignore dbg intrinsics.
2046 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
2048 // Allow a single instruction to be hoisted in addition to the compare
2049 // that feeds the branch. We later ensure that any values that _it_ uses
2050 // were also live in the predecessor, so that we don't unnecessarily create
2051 // register pressure or inhibit out-of-order execution.
2052 Instruction *BonusInst = 0;
2053 if (&*FrontIt != Cond &&
2054 FrontIt->hasOneUse() && *FrontIt->use_begin() == Cond &&
2055 isSafeToSpeculativelyExecute(FrontIt)) {
2056 BonusInst = &*FrontIt;
2059 // Ignore dbg intrinsics.
2060 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
2063 // Only a single bonus inst is allowed.
2064 if (&*FrontIt != Cond)
2067 // Make sure the instruction after the condition is the cond branch.
2068 BasicBlock::iterator CondIt = Cond; ++CondIt;
2070 // Ingore dbg intrinsics.
2071 while (isa<DbgInfoIntrinsic>(CondIt)) ++CondIt;
2076 // Cond is known to be a compare or binary operator. Check to make sure that
2077 // neither operand is a potentially-trapping constant expression.
2078 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(0)))
2081 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(1)))
2085 // Finally, don't infinitely unroll conditional loops.
2086 BasicBlock *TrueDest = BI->getSuccessor(0);
2087 BasicBlock *FalseDest = (BI->isConditional()) ? BI->getSuccessor(1) : 0;
2088 if (TrueDest == BB || FalseDest == BB)
2091 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2092 BasicBlock *PredBlock = *PI;
2093 BranchInst *PBI = dyn_cast<BranchInst>(PredBlock->getTerminator());
2095 // Check that we have two conditional branches. If there is a PHI node in
2096 // the common successor, verify that the same value flows in from both
2098 SmallVector<PHINode*, 4> PHIs;
2099 if (PBI == 0 || PBI->isUnconditional() ||
2100 (BI->isConditional() &&
2101 !SafeToMergeTerminators(BI, PBI)) ||
2102 (!BI->isConditional() &&
2103 !isProfitableToFoldUnconditional(BI, PBI, Cond, PHIs)))
2106 // Determine if the two branches share a common destination.
2107 Instruction::BinaryOps Opc = Instruction::BinaryOpsEnd;
2108 bool InvertPredCond = false;
2110 if (BI->isConditional()) {
2111 if (PBI->getSuccessor(0) == TrueDest)
2112 Opc = Instruction::Or;
2113 else if (PBI->getSuccessor(1) == FalseDest)
2114 Opc = Instruction::And;
2115 else if (PBI->getSuccessor(0) == FalseDest)
2116 Opc = Instruction::And, InvertPredCond = true;
2117 else if (PBI->getSuccessor(1) == TrueDest)
2118 Opc = Instruction::Or, InvertPredCond = true;
2122 if (PBI->getSuccessor(0) != TrueDest && PBI->getSuccessor(1) != TrueDest)
2126 // Ensure that any values used in the bonus instruction are also used
2127 // by the terminator of the predecessor. This means that those values
2128 // must already have been resolved, so we won't be inhibiting the
2129 // out-of-order core by speculating them earlier.
2131 // Collect the values used by the bonus inst
2132 SmallPtrSet<Value*, 4> UsedValues;
2133 for (Instruction::op_iterator OI = BonusInst->op_begin(),
2134 OE = BonusInst->op_end(); OI != OE; ++OI) {
2136 if (!isa<Constant>(V))
2137 UsedValues.insert(V);
2140 SmallVector<std::pair<Value*, unsigned>, 4> Worklist;
2141 Worklist.push_back(std::make_pair(PBI->getOperand(0), 0));
2143 // Walk up to four levels back up the use-def chain of the predecessor's
2144 // terminator to see if all those values were used. The choice of four
2145 // levels is arbitrary, to provide a compile-time-cost bound.
2146 while (!Worklist.empty()) {
2147 std::pair<Value*, unsigned> Pair = Worklist.back();
2148 Worklist.pop_back();
2150 if (Pair.second >= 4) continue;
2151 UsedValues.erase(Pair.first);
2152 if (UsedValues.empty()) break;
2154 if (Instruction *I = dyn_cast<Instruction>(Pair.first)) {
2155 for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
2157 Worklist.push_back(std::make_pair(OI->get(), Pair.second+1));
2161 if (!UsedValues.empty()) return false;
2164 DEBUG(dbgs() << "FOLDING BRANCH TO COMMON DEST:\n" << *PBI << *BB);
2165 IRBuilder<> Builder(PBI);
2167 // If we need to invert the condition in the pred block to match, do so now.
2168 if (InvertPredCond) {
2169 Value *NewCond = PBI->getCondition();
2171 if (NewCond->hasOneUse() && isa<CmpInst>(NewCond)) {
2172 CmpInst *CI = cast<CmpInst>(NewCond);
2173 CI->setPredicate(CI->getInversePredicate());
2175 NewCond = Builder.CreateNot(NewCond,
2176 PBI->getCondition()->getName()+".not");
2179 PBI->setCondition(NewCond);
2180 PBI->swapSuccessors();
2183 // If we have a bonus inst, clone it into the predecessor block.
2184 Instruction *NewBonus = 0;
2186 NewBonus = BonusInst->clone();
2187 PredBlock->getInstList().insert(PBI, NewBonus);
2188 NewBonus->takeName(BonusInst);
2189 BonusInst->setName(BonusInst->getName()+".old");
2192 // Clone Cond into the predecessor basic block, and or/and the
2193 // two conditions together.
2194 Instruction *New = Cond->clone();
2195 if (BonusInst) New->replaceUsesOfWith(BonusInst, NewBonus);
2196 PredBlock->getInstList().insert(PBI, New);
2197 New->takeName(Cond);
2198 Cond->setName(New->getName()+".old");
2200 if (BI->isConditional()) {
2201 Instruction *NewCond =
2202 cast<Instruction>(Builder.CreateBinOp(Opc, PBI->getCondition(),
2204 PBI->setCondition(NewCond);
2206 uint64_t PredTrueWeight, PredFalseWeight, SuccTrueWeight, SuccFalseWeight;
2207 bool PredHasWeights = ExtractBranchMetadata(PBI, PredTrueWeight,
2209 bool SuccHasWeights = ExtractBranchMetadata(BI, SuccTrueWeight,
2211 SmallVector<uint64_t, 8> NewWeights;
2213 if (PBI->getSuccessor(0) == BB) {
2214 if (PredHasWeights && SuccHasWeights) {
2215 // PBI: br i1 %x, BB, FalseDest
2216 // BI: br i1 %y, TrueDest, FalseDest
2217 //TrueWeight is TrueWeight for PBI * TrueWeight for BI.
2218 NewWeights.push_back(PredTrueWeight * SuccTrueWeight);
2219 //FalseWeight is FalseWeight for PBI * TotalWeight for BI +
2220 // TrueWeight for PBI * FalseWeight for BI.
2221 // We assume that total weights of a BranchInst can fit into 32 bits.
2222 // Therefore, we will not have overflow using 64-bit arithmetic.
2223 NewWeights.push_back(PredFalseWeight * (SuccFalseWeight +
2224 SuccTrueWeight) + PredTrueWeight * SuccFalseWeight);
2226 AddPredecessorToBlock(TrueDest, PredBlock, BB);
2227 PBI->setSuccessor(0, TrueDest);
2229 if (PBI->getSuccessor(1) == BB) {
2230 if (PredHasWeights && SuccHasWeights) {
2231 // PBI: br i1 %x, TrueDest, BB
2232 // BI: br i1 %y, TrueDest, FalseDest
2233 //TrueWeight is TrueWeight for PBI * TotalWeight for BI +
2234 // FalseWeight for PBI * TrueWeight for BI.
2235 NewWeights.push_back(PredTrueWeight * (SuccFalseWeight +
2236 SuccTrueWeight) + PredFalseWeight * SuccTrueWeight);
2237 //FalseWeight is FalseWeight for PBI * FalseWeight for BI.
2238 NewWeights.push_back(PredFalseWeight * SuccFalseWeight);
2240 AddPredecessorToBlock(FalseDest, PredBlock, BB);
2241 PBI->setSuccessor(1, FalseDest);
2243 if (NewWeights.size() == 2) {
2244 // Halve the weights if any of them cannot fit in an uint32_t
2245 FitWeights(NewWeights);
2247 SmallVector<uint32_t, 8> MDWeights(NewWeights.begin(),NewWeights.end());
2248 PBI->setMetadata(LLVMContext::MD_prof,
2249 MDBuilder(BI->getContext()).
2250 createBranchWeights(MDWeights));
2252 PBI->setMetadata(LLVMContext::MD_prof, NULL);
2254 // Update PHI nodes in the common successors.
2255 for (unsigned i = 0, e = PHIs.size(); i != e; ++i) {
2256 ConstantInt *PBI_C = cast<ConstantInt>(
2257 PHIs[i]->getIncomingValueForBlock(PBI->getParent()));
2258 assert(PBI_C->getType()->isIntegerTy(1));
2259 Instruction *MergedCond = 0;
2260 if (PBI->getSuccessor(0) == TrueDest) {
2261 // Create (PBI_Cond and PBI_C) or (!PBI_Cond and BI_Value)
2262 // PBI_C is true: PBI_Cond or (!PBI_Cond and BI_Value)
2263 // is false: !PBI_Cond and BI_Value
2264 Instruction *NotCond =
2265 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
2268 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
2273 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
2274 PBI->getCondition(), MergedCond,
2277 // Create (PBI_Cond and BI_Value) or (!PBI_Cond and PBI_C)
2278 // PBI_C is true: (PBI_Cond and BI_Value) or (!PBI_Cond)
2279 // is false: PBI_Cond and BI_Value
2281 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
2282 PBI->getCondition(), New,
2284 if (PBI_C->isOne()) {
2285 Instruction *NotCond =
2286 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
2289 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
2290 NotCond, MergedCond,
2295 PHIs[i]->setIncomingValue(PHIs[i]->getBasicBlockIndex(PBI->getParent()),
2298 // Change PBI from Conditional to Unconditional.
2299 BranchInst *New_PBI = BranchInst::Create(TrueDest, PBI);
2300 EraseTerminatorInstAndDCECond(PBI);
2304 // TODO: If BB is reachable from all paths through PredBlock, then we
2305 // could replace PBI's branch probabilities with BI's.
2307 // Copy any debug value intrinsics into the end of PredBlock.
2308 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
2309 if (isa<DbgInfoIntrinsic>(*I))
2310 I->clone()->insertBefore(PBI);
2317 /// SimplifyCondBranchToCondBranch - If we have a conditional branch as a
2318 /// predecessor of another block, this function tries to simplify it. We know
2319 /// that PBI and BI are both conditional branches, and BI is in one of the
2320 /// successor blocks of PBI - PBI branches to BI.
2321 static bool SimplifyCondBranchToCondBranch(BranchInst *PBI, BranchInst *BI) {
2322 assert(PBI->isConditional() && BI->isConditional());
2323 BasicBlock *BB = BI->getParent();
2325 // If this block ends with a branch instruction, and if there is a
2326 // predecessor that ends on a branch of the same condition, make
2327 // this conditional branch redundant.
2328 if (PBI->getCondition() == BI->getCondition() &&
2329 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2330 // Okay, the outcome of this conditional branch is statically
2331 // knowable. If this block had a single pred, handle specially.
2332 if (BB->getSinglePredecessor()) {
2333 // Turn this into a branch on constant.
2334 bool CondIsTrue = PBI->getSuccessor(0) == BB;
2335 BI->setCondition(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
2337 return true; // Nuke the branch on constant.
2340 // Otherwise, if there are multiple predecessors, insert a PHI that merges
2341 // in the constant and simplify the block result. Subsequent passes of
2342 // simplifycfg will thread the block.
2343 if (BlockIsSimpleEnoughToThreadThrough(BB)) {
2344 pred_iterator PB = pred_begin(BB), PE = pred_end(BB);
2345 PHINode *NewPN = PHINode::Create(Type::getInt1Ty(BB->getContext()),
2346 std::distance(PB, PE),
2347 BI->getCondition()->getName() + ".pr",
2349 // Okay, we're going to insert the PHI node. Since PBI is not the only
2350 // predecessor, compute the PHI'd conditional value for all of the preds.
2351 // Any predecessor where the condition is not computable we keep symbolic.
2352 for (pred_iterator PI = PB; PI != PE; ++PI) {
2353 BasicBlock *P = *PI;
2354 if ((PBI = dyn_cast<BranchInst>(P->getTerminator())) &&
2355 PBI != BI && PBI->isConditional() &&
2356 PBI->getCondition() == BI->getCondition() &&
2357 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2358 bool CondIsTrue = PBI->getSuccessor(0) == BB;
2359 NewPN->addIncoming(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
2362 NewPN->addIncoming(BI->getCondition(), P);
2366 BI->setCondition(NewPN);
2371 // If this is a conditional branch in an empty block, and if any
2372 // predecessors is a conditional branch to one of our destinations,
2373 // fold the conditions into logical ops and one cond br.
2374 BasicBlock::iterator BBI = BB->begin();
2375 // Ignore dbg intrinsics.
2376 while (isa<DbgInfoIntrinsic>(BBI))
2382 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(BI->getCondition()))
2387 if (PBI->getSuccessor(0) == BI->getSuccessor(0))
2389 else if (PBI->getSuccessor(0) == BI->getSuccessor(1))
2390 PBIOp = 0, BIOp = 1;
2391 else if (PBI->getSuccessor(1) == BI->getSuccessor(0))
2392 PBIOp = 1, BIOp = 0;
2393 else if (PBI->getSuccessor(1) == BI->getSuccessor(1))
2398 // Check to make sure that the other destination of this branch
2399 // isn't BB itself. If so, this is an infinite loop that will
2400 // keep getting unwound.
2401 if (PBI->getSuccessor(PBIOp) == BB)
2404 // Do not perform this transformation if it would require
2405 // insertion of a large number of select instructions. For targets
2406 // without predication/cmovs, this is a big pessimization.
2407 BasicBlock *CommonDest = PBI->getSuccessor(PBIOp);
2409 unsigned NumPhis = 0;
2410 for (BasicBlock::iterator II = CommonDest->begin();
2411 isa<PHINode>(II); ++II, ++NumPhis)
2412 if (NumPhis > 2) // Disable this xform.
2415 // Finally, if everything is ok, fold the branches to logical ops.
2416 BasicBlock *OtherDest = BI->getSuccessor(BIOp ^ 1);
2418 DEBUG(dbgs() << "FOLDING BRs:" << *PBI->getParent()
2419 << "AND: " << *BI->getParent());
2422 // If OtherDest *is* BB, then BB is a basic block with a single conditional
2423 // branch in it, where one edge (OtherDest) goes back to itself but the other
2424 // exits. We don't *know* that the program avoids the infinite loop
2425 // (even though that seems likely). If we do this xform naively, we'll end up
2426 // recursively unpeeling the loop. Since we know that (after the xform is
2427 // done) that the block *is* infinite if reached, we just make it an obviously
2428 // infinite loop with no cond branch.
2429 if (OtherDest == BB) {
2430 // Insert it at the end of the function, because it's either code,
2431 // or it won't matter if it's hot. :)
2432 BasicBlock *InfLoopBlock = BasicBlock::Create(BB->getContext(),
2433 "infloop", BB->getParent());
2434 BranchInst::Create(InfLoopBlock, InfLoopBlock);
2435 OtherDest = InfLoopBlock;
2438 DEBUG(dbgs() << *PBI->getParent()->getParent());
2440 // BI may have other predecessors. Because of this, we leave
2441 // it alone, but modify PBI.
2443 // Make sure we get to CommonDest on True&True directions.
2444 Value *PBICond = PBI->getCondition();
2445 IRBuilder<true, NoFolder> Builder(PBI);
2447 PBICond = Builder.CreateNot(PBICond, PBICond->getName()+".not");
2449 Value *BICond = BI->getCondition();
2451 BICond = Builder.CreateNot(BICond, BICond->getName()+".not");
2453 // Merge the conditions.
2454 Value *Cond = Builder.CreateOr(PBICond, BICond, "brmerge");
2456 // Modify PBI to branch on the new condition to the new dests.
2457 PBI->setCondition(Cond);
2458 PBI->setSuccessor(0, CommonDest);
2459 PBI->setSuccessor(1, OtherDest);
2461 // Update branch weight for PBI.
2462 uint64_t PredTrueWeight, PredFalseWeight, SuccTrueWeight, SuccFalseWeight;
2463 bool PredHasWeights = ExtractBranchMetadata(PBI, PredTrueWeight,
2465 bool SuccHasWeights = ExtractBranchMetadata(BI, SuccTrueWeight,
2467 if (PredHasWeights && SuccHasWeights) {
2468 uint64_t PredCommon = PBIOp ? PredFalseWeight : PredTrueWeight;
2469 uint64_t PredOther = PBIOp ?PredTrueWeight : PredFalseWeight;
2470 uint64_t SuccCommon = BIOp ? SuccFalseWeight : SuccTrueWeight;
2471 uint64_t SuccOther = BIOp ? SuccTrueWeight : SuccFalseWeight;
2472 // The weight to CommonDest should be PredCommon * SuccTotal +
2473 // PredOther * SuccCommon.
2474 // The weight to OtherDest should be PredOther * SuccOther.
2475 SmallVector<uint64_t, 2> NewWeights;
2476 NewWeights.push_back(PredCommon * (SuccCommon + SuccOther) +
2477 PredOther * SuccCommon);
2478 NewWeights.push_back(PredOther * SuccOther);
2479 // Halve the weights if any of them cannot fit in an uint32_t
2480 FitWeights(NewWeights);
2482 SmallVector<uint32_t, 2> MDWeights(NewWeights.begin(),NewWeights.end());
2483 PBI->setMetadata(LLVMContext::MD_prof,
2484 MDBuilder(BI->getContext()).
2485 createBranchWeights(MDWeights));
2488 // OtherDest may have phi nodes. If so, add an entry from PBI's
2489 // block that are identical to the entries for BI's block.
2490 AddPredecessorToBlock(OtherDest, PBI->getParent(), BB);
2492 // We know that the CommonDest already had an edge from PBI to
2493 // it. If it has PHIs though, the PHIs may have different
2494 // entries for BB and PBI's BB. If so, insert a select to make
2497 for (BasicBlock::iterator II = CommonDest->begin();
2498 (PN = dyn_cast<PHINode>(II)); ++II) {
2499 Value *BIV = PN->getIncomingValueForBlock(BB);
2500 unsigned PBBIdx = PN->getBasicBlockIndex(PBI->getParent());
2501 Value *PBIV = PN->getIncomingValue(PBBIdx);
2503 // Insert a select in PBI to pick the right value.
2504 Value *NV = cast<SelectInst>
2505 (Builder.CreateSelect(PBICond, PBIV, BIV, PBIV->getName()+".mux"));
2506 PN->setIncomingValue(PBBIdx, NV);
2510 DEBUG(dbgs() << "INTO: " << *PBI->getParent());
2511 DEBUG(dbgs() << *PBI->getParent()->getParent());
2513 // This basic block is probably dead. We know it has at least
2514 // one fewer predecessor.
2518 // SimplifyTerminatorOnSelect - Simplifies a terminator by replacing it with a
2519 // branch to TrueBB if Cond is true or to FalseBB if Cond is false.
2520 // Takes care of updating the successors and removing the old terminator.
2521 // Also makes sure not to introduce new successors by assuming that edges to
2522 // non-successor TrueBBs and FalseBBs aren't reachable.
2523 static bool SimplifyTerminatorOnSelect(TerminatorInst *OldTerm, Value *Cond,
2524 BasicBlock *TrueBB, BasicBlock *FalseBB,
2525 uint32_t TrueWeight,
2526 uint32_t FalseWeight){
2527 // Remove any superfluous successor edges from the CFG.
2528 // First, figure out which successors to preserve.
2529 // If TrueBB and FalseBB are equal, only try to preserve one copy of that
2531 BasicBlock *KeepEdge1 = TrueBB;
2532 BasicBlock *KeepEdge2 = TrueBB != FalseBB ? FalseBB : 0;
2534 // Then remove the rest.
2535 for (unsigned I = 0, E = OldTerm->getNumSuccessors(); I != E; ++I) {
2536 BasicBlock *Succ = OldTerm->getSuccessor(I);
2537 // Make sure only to keep exactly one copy of each edge.
2538 if (Succ == KeepEdge1)
2540 else if (Succ == KeepEdge2)
2543 Succ->removePredecessor(OldTerm->getParent());
2546 IRBuilder<> Builder(OldTerm);
2547 Builder.SetCurrentDebugLocation(OldTerm->getDebugLoc());
2549 // Insert an appropriate new terminator.
2550 if ((KeepEdge1 == 0) && (KeepEdge2 == 0)) {
2551 if (TrueBB == FalseBB)
2552 // We were only looking for one successor, and it was present.
2553 // Create an unconditional branch to it.
2554 Builder.CreateBr(TrueBB);
2556 // We found both of the successors we were looking for.
2557 // Create a conditional branch sharing the condition of the select.
2558 BranchInst *NewBI = Builder.CreateCondBr(Cond, TrueBB, FalseBB);
2559 if (TrueWeight != FalseWeight)
2560 NewBI->setMetadata(LLVMContext::MD_prof,
2561 MDBuilder(OldTerm->getContext()).
2562 createBranchWeights(TrueWeight, FalseWeight));
2564 } else if (KeepEdge1 && (KeepEdge2 || TrueBB == FalseBB)) {
2565 // Neither of the selected blocks were successors, so this
2566 // terminator must be unreachable.
2567 new UnreachableInst(OldTerm->getContext(), OldTerm);
2569 // One of the selected values was a successor, but the other wasn't.
2570 // Insert an unconditional branch to the one that was found;
2571 // the edge to the one that wasn't must be unreachable.
2573 // Only TrueBB was found.
2574 Builder.CreateBr(TrueBB);
2576 // Only FalseBB was found.
2577 Builder.CreateBr(FalseBB);
2580 EraseTerminatorInstAndDCECond(OldTerm);
2584 // SimplifySwitchOnSelect - Replaces
2585 // (switch (select cond, X, Y)) on constant X, Y
2586 // with a branch - conditional if X and Y lead to distinct BBs,
2587 // unconditional otherwise.
2588 static bool SimplifySwitchOnSelect(SwitchInst *SI, SelectInst *Select) {
2589 // Check for constant integer values in the select.
2590 ConstantInt *TrueVal = dyn_cast<ConstantInt>(Select->getTrueValue());
2591 ConstantInt *FalseVal = dyn_cast<ConstantInt>(Select->getFalseValue());
2592 if (!TrueVal || !FalseVal)
2595 // Find the relevant condition and destinations.
2596 Value *Condition = Select->getCondition();
2597 BasicBlock *TrueBB = SI->findCaseValue(TrueVal).getCaseSuccessor();
2598 BasicBlock *FalseBB = SI->findCaseValue(FalseVal).getCaseSuccessor();
2600 // Get weight for TrueBB and FalseBB.
2601 uint32_t TrueWeight = 0, FalseWeight = 0;
2602 SmallVector<uint64_t, 8> Weights;
2603 bool HasWeights = HasBranchWeights(SI);
2605 GetBranchWeights(SI, Weights);
2606 if (Weights.size() == 1 + SI->getNumCases()) {
2607 TrueWeight = (uint32_t)Weights[SI->findCaseValue(TrueVal).
2608 getSuccessorIndex()];
2609 FalseWeight = (uint32_t)Weights[SI->findCaseValue(FalseVal).
2610 getSuccessorIndex()];
2614 // Perform the actual simplification.
2615 return SimplifyTerminatorOnSelect(SI, Condition, TrueBB, FalseBB,
2616 TrueWeight, FalseWeight);
2619 // SimplifyIndirectBrOnSelect - Replaces
2620 // (indirectbr (select cond, blockaddress(@fn, BlockA),
2621 // blockaddress(@fn, BlockB)))
2623 // (br cond, BlockA, BlockB).
2624 static bool SimplifyIndirectBrOnSelect(IndirectBrInst *IBI, SelectInst *SI) {
2625 // Check that both operands of the select are block addresses.
2626 BlockAddress *TBA = dyn_cast<BlockAddress>(SI->getTrueValue());
2627 BlockAddress *FBA = dyn_cast<BlockAddress>(SI->getFalseValue());
2631 // Extract the actual blocks.
2632 BasicBlock *TrueBB = TBA->getBasicBlock();
2633 BasicBlock *FalseBB = FBA->getBasicBlock();
2635 // Perform the actual simplification.
2636 return SimplifyTerminatorOnSelect(IBI, SI->getCondition(), TrueBB, FalseBB,
2640 /// TryToSimplifyUncondBranchWithICmpInIt - This is called when we find an icmp
2641 /// instruction (a seteq/setne with a constant) as the only instruction in a
2642 /// block that ends with an uncond branch. We are looking for a very specific
2643 /// pattern that occurs when "A == 1 || A == 2 || A == 3" gets simplified. In
2644 /// this case, we merge the first two "or's of icmp" into a switch, but then the
2645 /// default value goes to an uncond block with a seteq in it, we get something
2648 /// switch i8 %A, label %DEFAULT [ i8 1, label %end i8 2, label %end ]
2650 /// %tmp = icmp eq i8 %A, 92
2653 /// ... = phi i1 [ true, %entry ], [ %tmp, %DEFAULT ], [ true, %entry ]
2655 /// We prefer to split the edge to 'end' so that there is a true/false entry to
2656 /// the PHI, merging the third icmp into the switch.
2657 static bool TryToSimplifyUncondBranchWithICmpInIt(
2658 ICmpInst *ICI, IRBuilder<> &Builder, const TargetTransformInfo &TTI,
2659 const DataLayout *TD) {
2660 BasicBlock *BB = ICI->getParent();
2662 // If the block has any PHIs in it or the icmp has multiple uses, it is too
2664 if (isa<PHINode>(BB->begin()) || !ICI->hasOneUse()) return false;
2666 Value *V = ICI->getOperand(0);
2667 ConstantInt *Cst = cast<ConstantInt>(ICI->getOperand(1));
2669 // The pattern we're looking for is where our only predecessor is a switch on
2670 // 'V' and this block is the default case for the switch. In this case we can
2671 // fold the compared value into the switch to simplify things.
2672 BasicBlock *Pred = BB->getSinglePredecessor();
2673 if (Pred == 0 || !isa<SwitchInst>(Pred->getTerminator())) return false;
2675 SwitchInst *SI = cast<SwitchInst>(Pred->getTerminator());
2676 if (SI->getCondition() != V)
2679 // If BB is reachable on a non-default case, then we simply know the value of
2680 // V in this block. Substitute it and constant fold the icmp instruction
2682 if (SI->getDefaultDest() != BB) {
2683 ConstantInt *VVal = SI->findCaseDest(BB);
2684 assert(VVal && "Should have a unique destination value");
2685 ICI->setOperand(0, VVal);
2687 if (Value *V = SimplifyInstruction(ICI, TD)) {
2688 ICI->replaceAllUsesWith(V);
2689 ICI->eraseFromParent();
2691 // BB is now empty, so it is likely to simplify away.
2692 return SimplifyCFG(BB, TTI, TD) | true;
2695 // Ok, the block is reachable from the default dest. If the constant we're
2696 // comparing exists in one of the other edges, then we can constant fold ICI
2698 if (SI->findCaseValue(Cst) != SI->case_default()) {
2700 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2701 V = ConstantInt::getFalse(BB->getContext());
2703 V = ConstantInt::getTrue(BB->getContext());
2705 ICI->replaceAllUsesWith(V);
2706 ICI->eraseFromParent();
2707 // BB is now empty, so it is likely to simplify away.
2708 return SimplifyCFG(BB, TTI, TD) | true;
2711 // The use of the icmp has to be in the 'end' block, by the only PHI node in
2713 BasicBlock *SuccBlock = BB->getTerminator()->getSuccessor(0);
2714 PHINode *PHIUse = dyn_cast<PHINode>(ICI->use_back());
2715 if (PHIUse == 0 || PHIUse != &SuccBlock->front() ||
2716 isa<PHINode>(++BasicBlock::iterator(PHIUse)))
2719 // If the icmp is a SETEQ, then the default dest gets false, the new edge gets
2721 Constant *DefaultCst = ConstantInt::getTrue(BB->getContext());
2722 Constant *NewCst = ConstantInt::getFalse(BB->getContext());
2724 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2725 std::swap(DefaultCst, NewCst);
2727 // Replace ICI (which is used by the PHI for the default value) with true or
2728 // false depending on if it is EQ or NE.
2729 ICI->replaceAllUsesWith(DefaultCst);
2730 ICI->eraseFromParent();
2732 // Okay, the switch goes to this block on a default value. Add an edge from
2733 // the switch to the merge point on the compared value.
2734 BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), "switch.edge",
2735 BB->getParent(), BB);
2736 SmallVector<uint64_t, 8> Weights;
2737 bool HasWeights = HasBranchWeights(SI);
2739 GetBranchWeights(SI, Weights);
2740 if (Weights.size() == 1 + SI->getNumCases()) {
2741 // Split weight for default case to case for "Cst".
2742 Weights[0] = (Weights[0]+1) >> 1;
2743 Weights.push_back(Weights[0]);
2745 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
2746 SI->setMetadata(LLVMContext::MD_prof,
2747 MDBuilder(SI->getContext()).
2748 createBranchWeights(MDWeights));
2751 SI->addCase(Cst, NewBB);
2753 // NewBB branches to the phi block, add the uncond branch and the phi entry.
2754 Builder.SetInsertPoint(NewBB);
2755 Builder.SetCurrentDebugLocation(SI->getDebugLoc());
2756 Builder.CreateBr(SuccBlock);
2757 PHIUse->addIncoming(NewCst, NewBB);
2761 /// SimplifyBranchOnICmpChain - The specified branch is a conditional branch.
2762 /// Check to see if it is branching on an or/and chain of icmp instructions, and
2763 /// fold it into a switch instruction if so.
2764 static bool SimplifyBranchOnICmpChain(BranchInst *BI, const DataLayout *TD,
2765 IRBuilder<> &Builder) {
2766 Instruction *Cond = dyn_cast<Instruction>(BI->getCondition());
2767 if (Cond == 0) return false;
2770 // Change br (X == 0 | X == 1), T, F into a switch instruction.
2771 // If this is a bunch of seteq's or'd together, or if it's a bunch of
2772 // 'setne's and'ed together, collect them.
2774 std::vector<ConstantInt*> Values;
2775 bool TrueWhenEqual = true;
2776 Value *ExtraCase = 0;
2777 unsigned UsedICmps = 0;
2779 if (Cond->getOpcode() == Instruction::Or) {
2780 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, true,
2782 } else if (Cond->getOpcode() == Instruction::And) {
2783 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, false,
2785 TrueWhenEqual = false;
2788 // If we didn't have a multiply compared value, fail.
2789 if (CompVal == 0) return false;
2791 // Avoid turning single icmps into a switch.
2795 // There might be duplicate constants in the list, which the switch
2796 // instruction can't handle, remove them now.
2797 array_pod_sort(Values.begin(), Values.end(), ConstantIntSortPredicate);
2798 Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
2800 // If Extra was used, we require at least two switch values to do the
2801 // transformation. A switch with one value is just an cond branch.
2802 if (ExtraCase && Values.size() < 2) return false;
2804 // TODO: Preserve branch weight metadata, similarly to how
2805 // FoldValueComparisonIntoPredecessors preserves it.
2807 // Figure out which block is which destination.
2808 BasicBlock *DefaultBB = BI->getSuccessor(1);
2809 BasicBlock *EdgeBB = BI->getSuccessor(0);
2810 if (!TrueWhenEqual) std::swap(DefaultBB, EdgeBB);
2812 BasicBlock *BB = BI->getParent();
2814 DEBUG(dbgs() << "Converting 'icmp' chain with " << Values.size()
2815 << " cases into SWITCH. BB is:\n" << *BB);
2817 // If there are any extra values that couldn't be folded into the switch
2818 // then we evaluate them with an explicit branch first. Split the block
2819 // right before the condbr to handle it.
2821 BasicBlock *NewBB = BB->splitBasicBlock(BI, "switch.early.test");
2822 // Remove the uncond branch added to the old block.
2823 TerminatorInst *OldTI = BB->getTerminator();
2824 Builder.SetInsertPoint(OldTI);
2827 Builder.CreateCondBr(ExtraCase, EdgeBB, NewBB);
2829 Builder.CreateCondBr(ExtraCase, NewBB, EdgeBB);
2831 OldTI->eraseFromParent();
2833 // If there are PHI nodes in EdgeBB, then we need to add a new entry to them
2834 // for the edge we just added.
2835 AddPredecessorToBlock(EdgeBB, BB, NewBB);
2837 DEBUG(dbgs() << " ** 'icmp' chain unhandled condition: " << *ExtraCase
2838 << "\nEXTRABB = " << *BB);
2842 Builder.SetInsertPoint(BI);
2843 // Convert pointer to int before we switch.
2844 if (CompVal->getType()->isPointerTy()) {
2845 assert(TD && "Cannot switch on pointer without DataLayout");
2846 CompVal = Builder.CreatePtrToInt(CompVal,
2847 TD->getIntPtrType(CompVal->getContext()),
2851 // Create the new switch instruction now.
2852 SwitchInst *New = Builder.CreateSwitch(CompVal, DefaultBB, Values.size());
2854 // Add all of the 'cases' to the switch instruction.
2855 for (unsigned i = 0, e = Values.size(); i != e; ++i)
2856 New->addCase(Values[i], EdgeBB);
2858 // We added edges from PI to the EdgeBB. As such, if there were any
2859 // PHI nodes in EdgeBB, they need entries to be added corresponding to
2860 // the number of edges added.
2861 for (BasicBlock::iterator BBI = EdgeBB->begin();
2862 isa<PHINode>(BBI); ++BBI) {
2863 PHINode *PN = cast<PHINode>(BBI);
2864 Value *InVal = PN->getIncomingValueForBlock(BB);
2865 for (unsigned i = 0, e = Values.size()-1; i != e; ++i)
2866 PN->addIncoming(InVal, BB);
2869 // Erase the old branch instruction.
2870 EraseTerminatorInstAndDCECond(BI);
2872 DEBUG(dbgs() << " ** 'icmp' chain result is:\n" << *BB << '\n');
2876 bool SimplifyCFGOpt::SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder) {
2877 // If this is a trivial landing pad that just continues unwinding the caught
2878 // exception then zap the landing pad, turning its invokes into calls.
2879 BasicBlock *BB = RI->getParent();
2880 LandingPadInst *LPInst = dyn_cast<LandingPadInst>(BB->getFirstNonPHI());
2881 if (RI->getValue() != LPInst)
2882 // Not a landing pad, or the resume is not unwinding the exception that
2883 // caused control to branch here.
2886 // Check that there are no other instructions except for debug intrinsics.
2887 BasicBlock::iterator I = LPInst, E = RI;
2889 if (!isa<DbgInfoIntrinsic>(I))
2892 // Turn all invokes that unwind here into calls and delete the basic block.
2893 bool InvokeRequiresTableEntry = false;
2894 bool Changed = false;
2895 for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE;) {
2896 InvokeInst *II = cast<InvokeInst>((*PI++)->getTerminator());
2898 if (II->hasFnAttr(Attribute::UWTable)) {
2899 // Don't remove an `invoke' instruction if the ABI requires an entry into
2901 InvokeRequiresTableEntry = true;
2905 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end() - 3);
2907 // Insert a call instruction before the invoke.
2908 CallInst *Call = CallInst::Create(II->getCalledValue(), Args, "", II);
2910 Call->setCallingConv(II->getCallingConv());
2911 Call->setAttributes(II->getAttributes());
2912 Call->setDebugLoc(II->getDebugLoc());
2914 // Anything that used the value produced by the invoke instruction now uses
2915 // the value produced by the call instruction. Note that we do this even
2916 // for void functions and calls with no uses so that the callgraph edge is
2918 II->replaceAllUsesWith(Call);
2919 BB->removePredecessor(II->getParent());
2921 // Insert a branch to the normal destination right before the invoke.
2922 BranchInst::Create(II->getNormalDest(), II);
2924 // Finally, delete the invoke instruction!
2925 II->eraseFromParent();
2929 if (!InvokeRequiresTableEntry)
2930 // The landingpad is now unreachable. Zap it.
2931 BB->eraseFromParent();
2936 bool SimplifyCFGOpt::SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder) {
2937 BasicBlock *BB = RI->getParent();
2938 if (!BB->getFirstNonPHIOrDbg()->isTerminator()) return false;
2940 // Find predecessors that end with branches.
2941 SmallVector<BasicBlock*, 8> UncondBranchPreds;
2942 SmallVector<BranchInst*, 8> CondBranchPreds;
2943 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2944 BasicBlock *P = *PI;
2945 TerminatorInst *PTI = P->getTerminator();
2946 if (BranchInst *BI = dyn_cast<BranchInst>(PTI)) {
2947 if (BI->isUnconditional())
2948 UncondBranchPreds.push_back(P);
2950 CondBranchPreds.push_back(BI);
2954 // If we found some, do the transformation!
2955 if (!UncondBranchPreds.empty() && DupRet) {
2956 while (!UncondBranchPreds.empty()) {
2957 BasicBlock *Pred = UncondBranchPreds.pop_back_val();
2958 DEBUG(dbgs() << "FOLDING: " << *BB
2959 << "INTO UNCOND BRANCH PRED: " << *Pred);
2960 (void)FoldReturnIntoUncondBranch(RI, BB, Pred);
2963 // If we eliminated all predecessors of the block, delete the block now.
2964 if (pred_begin(BB) == pred_end(BB))
2965 // We know there are no successors, so just nuke the block.
2966 BB->eraseFromParent();
2971 // Check out all of the conditional branches going to this return
2972 // instruction. If any of them just select between returns, change the
2973 // branch itself into a select/return pair.
2974 while (!CondBranchPreds.empty()) {
2975 BranchInst *BI = CondBranchPreds.pop_back_val();
2977 // Check to see if the non-BB successor is also a return block.
2978 if (isa<ReturnInst>(BI->getSuccessor(0)->getTerminator()) &&
2979 isa<ReturnInst>(BI->getSuccessor(1)->getTerminator()) &&
2980 SimplifyCondBranchToTwoReturns(BI, Builder))
2986 bool SimplifyCFGOpt::SimplifyUnreachable(UnreachableInst *UI) {
2987 BasicBlock *BB = UI->getParent();
2989 bool Changed = false;
2991 // If there are any instructions immediately before the unreachable that can
2992 // be removed, do so.
2993 while (UI != BB->begin()) {
2994 BasicBlock::iterator BBI = UI;
2996 // Do not delete instructions that can have side effects which might cause
2997 // the unreachable to not be reachable; specifically, calls and volatile
2998 // operations may have this effect.
2999 if (isa<CallInst>(BBI) && !isa<DbgInfoIntrinsic>(BBI)) break;
3001 if (BBI->mayHaveSideEffects()) {
3002 if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
3003 if (SI->isVolatile())
3005 } else if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
3006 if (LI->isVolatile())
3008 } else if (AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(BBI)) {
3009 if (RMWI->isVolatile())
3011 } else if (AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(BBI)) {
3012 if (CXI->isVolatile())
3014 } else if (!isa<FenceInst>(BBI) && !isa<VAArgInst>(BBI) &&
3015 !isa<LandingPadInst>(BBI)) {
3018 // Note that deleting LandingPad's here is in fact okay, although it
3019 // involves a bit of subtle reasoning. If this inst is a LandingPad,
3020 // all the predecessors of this block will be the unwind edges of Invokes,
3021 // and we can therefore guarantee this block will be erased.
3024 // Delete this instruction (any uses are guaranteed to be dead)
3025 if (!BBI->use_empty())
3026 BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
3027 BBI->eraseFromParent();
3031 // If the unreachable instruction is the first in the block, take a gander
3032 // at all of the predecessors of this instruction, and simplify them.
3033 if (&BB->front() != UI) return Changed;
3035 SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
3036 for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
3037 TerminatorInst *TI = Preds[i]->getTerminator();
3038 IRBuilder<> Builder(TI);
3039 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
3040 if (BI->isUnconditional()) {
3041 if (BI->getSuccessor(0) == BB) {
3042 new UnreachableInst(TI->getContext(), TI);
3043 TI->eraseFromParent();
3047 if (BI->getSuccessor(0) == BB) {
3048 Builder.CreateBr(BI->getSuccessor(1));
3049 EraseTerminatorInstAndDCECond(BI);
3050 } else if (BI->getSuccessor(1) == BB) {
3051 Builder.CreateBr(BI->getSuccessor(0));
3052 EraseTerminatorInstAndDCECond(BI);
3056 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
3057 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
3059 if (i.getCaseSuccessor() == BB) {
3060 BB->removePredecessor(SI->getParent());
3065 // If the default value is unreachable, figure out the most popular
3066 // destination and make it the default.
3067 if (SI->getDefaultDest() == BB) {
3068 std::map<BasicBlock*, std::pair<unsigned, unsigned> > Popularity;
3069 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
3071 std::pair<unsigned, unsigned> &entry =
3072 Popularity[i.getCaseSuccessor()];
3073 if (entry.first == 0) {
3075 entry.second = i.getCaseIndex();
3081 // Find the most popular block.
3082 unsigned MaxPop = 0;
3083 unsigned MaxIndex = 0;
3084 BasicBlock *MaxBlock = 0;
3085 for (std::map<BasicBlock*, std::pair<unsigned, unsigned> >::iterator
3086 I = Popularity.begin(), E = Popularity.end(); I != E; ++I) {
3087 if (I->second.first > MaxPop ||
3088 (I->second.first == MaxPop && MaxIndex > I->second.second)) {
3089 MaxPop = I->second.first;
3090 MaxIndex = I->second.second;
3091 MaxBlock = I->first;
3095 // Make this the new default, allowing us to delete any explicit
3097 SI->setDefaultDest(MaxBlock);
3100 // If MaxBlock has phinodes in it, remove MaxPop-1 entries from
3102 if (isa<PHINode>(MaxBlock->begin()))
3103 for (unsigned i = 0; i != MaxPop-1; ++i)
3104 MaxBlock->removePredecessor(SI->getParent());
3106 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
3108 if (i.getCaseSuccessor() == MaxBlock) {
3114 } else if (InvokeInst *II = dyn_cast<InvokeInst>(TI)) {
3115 if (II->getUnwindDest() == BB) {
3116 // Convert the invoke to a call instruction. This would be a good
3117 // place to note that the call does not throw though.
3118 BranchInst *BI = Builder.CreateBr(II->getNormalDest());
3119 II->removeFromParent(); // Take out of symbol table
3121 // Insert the call now...
3122 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end()-3);
3123 Builder.SetInsertPoint(BI);
3124 CallInst *CI = Builder.CreateCall(II->getCalledValue(),
3125 Args, II->getName());
3126 CI->setCallingConv(II->getCallingConv());
3127 CI->setAttributes(II->getAttributes());
3128 // If the invoke produced a value, the call does now instead.
3129 II->replaceAllUsesWith(CI);
3136 // If this block is now dead, remove it.
3137 if (pred_begin(BB) == pred_end(BB) &&
3138 BB != &BB->getParent()->getEntryBlock()) {
3139 // We know there are no successors, so just nuke the block.
3140 BB->eraseFromParent();
3147 /// TurnSwitchRangeIntoICmp - Turns a switch with that contains only a
3148 /// integer range comparison into a sub, an icmp and a branch.
3149 static bool TurnSwitchRangeIntoICmp(SwitchInst *SI, IRBuilder<> &Builder) {
3150 assert(SI->getNumCases() > 1 && "Degenerate switch?");
3152 // Make sure all cases point to the same destination and gather the values.
3153 SmallVector<ConstantInt *, 16> Cases;
3154 SwitchInst::CaseIt I = SI->case_begin();
3155 Cases.push_back(I.getCaseValue());
3156 SwitchInst::CaseIt PrevI = I++;
3157 for (SwitchInst::CaseIt E = SI->case_end(); I != E; PrevI = I++) {
3158 if (PrevI.getCaseSuccessor() != I.getCaseSuccessor())
3160 Cases.push_back(I.getCaseValue());
3162 assert(Cases.size() == SI->getNumCases() && "Not all cases gathered");
3164 // Sort the case values, then check if they form a range we can transform.
3165 array_pod_sort(Cases.begin(), Cases.end(), ConstantIntSortPredicate);
3166 for (unsigned I = 1, E = Cases.size(); I != E; ++I) {
3167 if (Cases[I-1]->getValue() != Cases[I]->getValue()+1)
3171 Constant *Offset = ConstantExpr::getNeg(Cases.back());
3172 Constant *NumCases = ConstantInt::get(Offset->getType(), SI->getNumCases());
3174 Value *Sub = SI->getCondition();
3175 if (!Offset->isNullValue())
3176 Sub = Builder.CreateAdd(Sub, Offset, Sub->getName()+".off");
3178 // If NumCases overflowed, then all possible values jump to the successor.
3179 if (NumCases->isNullValue() && SI->getNumCases() != 0)
3180 Cmp = ConstantInt::getTrue(SI->getContext());
3182 Cmp = Builder.CreateICmpULT(Sub, NumCases, "switch");
3183 BranchInst *NewBI = Builder.CreateCondBr(
3184 Cmp, SI->case_begin().getCaseSuccessor(), SI->getDefaultDest());
3186 // Update weight for the newly-created conditional branch.
3187 SmallVector<uint64_t, 8> Weights;
3188 bool HasWeights = HasBranchWeights(SI);
3190 GetBranchWeights(SI, Weights);
3191 if (Weights.size() == 1 + SI->getNumCases()) {
3192 // Combine all weights for the cases to be the true weight of NewBI.
3193 // We assume that the sum of all weights for a Terminator can fit into 32
3195 uint32_t NewTrueWeight = 0;
3196 for (unsigned I = 1, E = Weights.size(); I != E; ++I)
3197 NewTrueWeight += (uint32_t)Weights[I];
3198 NewBI->setMetadata(LLVMContext::MD_prof,
3199 MDBuilder(SI->getContext()).
3200 createBranchWeights(NewTrueWeight,
3201 (uint32_t)Weights[0]));
3205 // Prune obsolete incoming values off the successor's PHI nodes.
3206 for (BasicBlock::iterator BBI = SI->case_begin().getCaseSuccessor()->begin();
3207 isa<PHINode>(BBI); ++BBI) {
3208 for (unsigned I = 0, E = SI->getNumCases()-1; I != E; ++I)
3209 cast<PHINode>(BBI)->removeIncomingValue(SI->getParent());
3211 SI->eraseFromParent();
3216 /// EliminateDeadSwitchCases - Compute masked bits for the condition of a switch
3217 /// and use it to remove dead cases.
3218 static bool EliminateDeadSwitchCases(SwitchInst *SI) {
3219 Value *Cond = SI->getCondition();
3220 unsigned Bits = cast<IntegerType>(Cond->getType())->getBitWidth();
3221 APInt KnownZero(Bits, 0), KnownOne(Bits, 0);
3222 ComputeMaskedBits(Cond, KnownZero, KnownOne);
3224 // Gather dead cases.
3225 SmallVector<ConstantInt*, 8> DeadCases;
3226 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
3227 if ((I.getCaseValue()->getValue() & KnownZero) != 0 ||
3228 (I.getCaseValue()->getValue() & KnownOne) != KnownOne) {
3229 DeadCases.push_back(I.getCaseValue());
3230 DEBUG(dbgs() << "SimplifyCFG: switch case '"
3231 << I.getCaseValue() << "' is dead.\n");
3235 SmallVector<uint64_t, 8> Weights;
3236 bool HasWeight = HasBranchWeights(SI);
3238 GetBranchWeights(SI, Weights);
3239 HasWeight = (Weights.size() == 1 + SI->getNumCases());
3242 // Remove dead cases from the switch.
3243 for (unsigned I = 0, E = DeadCases.size(); I != E; ++I) {
3244 SwitchInst::CaseIt Case = SI->findCaseValue(DeadCases[I]);
3245 assert(Case != SI->case_default() &&
3246 "Case was not found. Probably mistake in DeadCases forming.");
3248 std::swap(Weights[Case.getCaseIndex()+1], Weights.back());
3252 // Prune unused values from PHI nodes.
3253 Case.getCaseSuccessor()->removePredecessor(SI->getParent());
3254 SI->removeCase(Case);
3257 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
3258 SI->setMetadata(LLVMContext::MD_prof,
3259 MDBuilder(SI->getParent()->getContext()).
3260 createBranchWeights(MDWeights));
3263 return !DeadCases.empty();
3266 /// FindPHIForConditionForwarding - If BB would be eligible for simplification
3267 /// by TryToSimplifyUncondBranchFromEmptyBlock (i.e. it is empty and terminated
3268 /// by an unconditional branch), look at the phi node for BB in the successor
3269 /// block and see if the incoming value is equal to CaseValue. If so, return
3270 /// the phi node, and set PhiIndex to BB's index in the phi node.
3271 static PHINode *FindPHIForConditionForwarding(ConstantInt *CaseValue,
3274 if (BB->getFirstNonPHIOrDbg() != BB->getTerminator())
3275 return NULL; // BB must be empty to be a candidate for simplification.
3276 if (!BB->getSinglePredecessor())
3277 return NULL; // BB must be dominated by the switch.
3279 BranchInst *Branch = dyn_cast<BranchInst>(BB->getTerminator());
3280 if (!Branch || !Branch->isUnconditional())
3281 return NULL; // Terminator must be unconditional branch.
3283 BasicBlock *Succ = Branch->getSuccessor(0);
3285 BasicBlock::iterator I = Succ->begin();
3286 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
3287 int Idx = PHI->getBasicBlockIndex(BB);
3288 assert(Idx >= 0 && "PHI has no entry for predecessor?");
3290 Value *InValue = PHI->getIncomingValue(Idx);
3291 if (InValue != CaseValue) continue;
3300 /// ForwardSwitchConditionToPHI - Try to forward the condition of a switch
3301 /// instruction to a phi node dominated by the switch, if that would mean that
3302 /// some of the destination blocks of the switch can be folded away.
3303 /// Returns true if a change is made.
3304 static bool ForwardSwitchConditionToPHI(SwitchInst *SI) {
3305 typedef DenseMap<PHINode*, SmallVector<int,4> > ForwardingNodesMap;
3306 ForwardingNodesMap ForwardingNodes;
3308 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
3309 ConstantInt *CaseValue = I.getCaseValue();
3310 BasicBlock *CaseDest = I.getCaseSuccessor();
3313 PHINode *PHI = FindPHIForConditionForwarding(CaseValue, CaseDest,
3317 ForwardingNodes[PHI].push_back(PhiIndex);
3320 bool Changed = false;
3322 for (ForwardingNodesMap::iterator I = ForwardingNodes.begin(),
3323 E = ForwardingNodes.end(); I != E; ++I) {
3324 PHINode *Phi = I->first;
3325 SmallVector<int,4> &Indexes = I->second;
3327 if (Indexes.size() < 2) continue;
3329 for (size_t I = 0, E = Indexes.size(); I != E; ++I)
3330 Phi->setIncomingValue(Indexes[I], SI->getCondition());
3337 /// ValidLookupTableConstant - Return true if the backend will be able to handle
3338 /// initializing an array of constants like C.
3339 static bool ValidLookupTableConstant(Constant *C) {
3340 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
3341 return CE->isGEPWithNoNotionalOverIndexing();
3343 return isa<ConstantFP>(C) ||
3344 isa<ConstantInt>(C) ||
3345 isa<ConstantPointerNull>(C) ||
3346 isa<GlobalValue>(C) ||
3350 /// LookupConstant - If V is a Constant, return it. Otherwise, try to look up
3351 /// its constant value in ConstantPool, returning 0 if it's not there.
3352 static Constant *LookupConstant(Value *V,
3353 const SmallDenseMap<Value*, Constant*>& ConstantPool) {
3354 if (Constant *C = dyn_cast<Constant>(V))
3356 return ConstantPool.lookup(V);
3359 /// ConstantFold - Try to fold instruction I into a constant. This works for
3360 /// simple instructions such as binary operations where both operands are
3361 /// constant or can be replaced by constants from the ConstantPool. Returns the
3362 /// resulting constant on success, 0 otherwise.
3363 static Constant *ConstantFold(Instruction *I,
3364 const SmallDenseMap<Value*, Constant*>& ConstantPool) {
3365 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(I)) {
3366 Constant *A = LookupConstant(BO->getOperand(0), ConstantPool);
3369 Constant *B = LookupConstant(BO->getOperand(1), ConstantPool);
3372 return ConstantExpr::get(BO->getOpcode(), A, B);
3375 if (CmpInst *Cmp = dyn_cast<CmpInst>(I)) {
3376 Constant *A = LookupConstant(I->getOperand(0), ConstantPool);
3379 Constant *B = LookupConstant(I->getOperand(1), ConstantPool);
3382 return ConstantExpr::getCompare(Cmp->getPredicate(), A, B);
3385 if (SelectInst *Select = dyn_cast<SelectInst>(I)) {
3386 Constant *A = LookupConstant(Select->getCondition(), ConstantPool);
3389 if (A->isAllOnesValue())
3390 return LookupConstant(Select->getTrueValue(), ConstantPool);
3391 if (A->isNullValue())
3392 return LookupConstant(Select->getFalseValue(), ConstantPool);
3396 if (CastInst *Cast = dyn_cast<CastInst>(I)) {
3397 Constant *A = LookupConstant(I->getOperand(0), ConstantPool);
3400 return ConstantExpr::getCast(Cast->getOpcode(), A, Cast->getDestTy());
3406 /// GetCaseResults - Try to determine the resulting constant values in phi nodes
3407 /// at the common destination basic block, *CommonDest, for one of the case
3408 /// destionations CaseDest corresponding to value CaseVal (0 for the default
3409 /// case), of a switch instruction SI.
3410 static bool GetCaseResults(SwitchInst *SI,
3411 ConstantInt *CaseVal,
3412 BasicBlock *CaseDest,
3413 BasicBlock **CommonDest,
3414 SmallVector<std::pair<PHINode*,Constant*>, 4> &Res) {
3415 // The block from which we enter the common destination.
3416 BasicBlock *Pred = SI->getParent();
3418 // If CaseDest is empty except for some side-effect free instructions through
3419 // which we can constant-propagate the CaseVal, continue to its successor.
3420 SmallDenseMap<Value*, Constant*> ConstantPool;
3421 ConstantPool.insert(std::make_pair(SI->getCondition(), CaseVal));
3422 for (BasicBlock::iterator I = CaseDest->begin(), E = CaseDest->end(); I != E;
3424 if (TerminatorInst *T = dyn_cast<TerminatorInst>(I)) {
3425 // If the terminator is a simple branch, continue to the next block.
3426 if (T->getNumSuccessors() != 1)
3429 CaseDest = T->getSuccessor(0);
3430 } else if (isa<DbgInfoIntrinsic>(I)) {
3431 // Skip debug intrinsic.
3433 } else if (Constant *C = ConstantFold(I, ConstantPool)) {
3434 // Instruction is side-effect free and constant.
3435 ConstantPool.insert(std::make_pair(I, C));
3441 // If we did not have a CommonDest before, use the current one.
3443 *CommonDest = CaseDest;
3444 // If the destination isn't the common one, abort.
3445 if (CaseDest != *CommonDest)
3448 // Get the values for this case from phi nodes in the destination block.
3449 BasicBlock::iterator I = (*CommonDest)->begin();
3450 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
3451 int Idx = PHI->getBasicBlockIndex(Pred);
3455 Constant *ConstVal = LookupConstant(PHI->getIncomingValue(Idx),
3460 // Note: If the constant comes from constant-propagating the case value
3461 // through the CaseDest basic block, it will be safe to remove the
3462 // instructions in that block. They cannot be used (except in the phi nodes
3463 // we visit) outside CaseDest, because that block does not dominate its
3464 // successor. If it did, we would not be in this phi node.
3466 // Be conservative about which kinds of constants we support.
3467 if (!ValidLookupTableConstant(ConstVal))
3470 Res.push_back(std::make_pair(PHI, ConstVal));
3477 /// SwitchLookupTable - This class represents a lookup table that can be used
3478 /// to replace a switch.
3479 class SwitchLookupTable {
3481 /// SwitchLookupTable - Create a lookup table to use as a switch replacement
3482 /// with the contents of Values, using DefaultValue to fill any holes in the
3484 SwitchLookupTable(Module &M,
3486 ConstantInt *Offset,
3487 const SmallVector<std::pair<ConstantInt*, Constant*>, 4>& Values,
3488 Constant *DefaultValue,
3489 const DataLayout *TD);
3491 /// BuildLookup - Build instructions with Builder to retrieve the value at
3492 /// the position given by Index in the lookup table.
3493 Value *BuildLookup(Value *Index, IRBuilder<> &Builder);
3495 /// WouldFitInRegister - Return true if a table with TableSize elements of
3496 /// type ElementType would fit in a target-legal register.
3497 static bool WouldFitInRegister(const DataLayout *TD,
3499 const Type *ElementType);
3502 // Depending on the contents of the table, it can be represented in
3505 // For tables where each element contains the same value, we just have to
3506 // store that single value and return it for each lookup.
3509 // For small tables with integer elements, we can pack them into a bitmap
3510 // that fits into a target-legal register. Values are retrieved by
3511 // shift and mask operations.
3514 // The table is stored as an array of values. Values are retrieved by load
3515 // instructions from the table.
3519 // For SingleValueKind, this is the single value.
3520 Constant *SingleValue;
3522 // For BitMapKind, this is the bitmap.
3523 ConstantInt *BitMap;
3524 IntegerType *BitMapElementTy;
3526 // For ArrayKind, this is the array.
3527 GlobalVariable *Array;
3531 SwitchLookupTable::SwitchLookupTable(Module &M,
3533 ConstantInt *Offset,
3534 const SmallVector<std::pair<ConstantInt*, Constant*>, 4>& Values,
3535 Constant *DefaultValue,
3536 const DataLayout *TD)
3537 : SingleValue(0), BitMap(0), BitMapElementTy(0), Array(0) {
3538 assert(Values.size() && "Can't build lookup table without values!");
3539 assert(TableSize >= Values.size() && "Can't fit values in table!");
3541 // If all values in the table are equal, this is that value.
3542 SingleValue = Values.begin()->second;
3544 // Build up the table contents.
3545 SmallVector<Constant*, 64> TableContents(TableSize);
3546 for (size_t I = 0, E = Values.size(); I != E; ++I) {
3547 ConstantInt *CaseVal = Values[I].first;
3548 Constant *CaseRes = Values[I].second;
3549 assert(CaseRes->getType() == DefaultValue->getType());
3551 uint64_t Idx = (CaseVal->getValue() - Offset->getValue())
3553 TableContents[Idx] = CaseRes;
3555 if (CaseRes != SingleValue)
3559 // Fill in any holes in the table with the default result.
3560 if (Values.size() < TableSize) {
3561 for (uint64_t I = 0; I < TableSize; ++I) {
3562 if (!TableContents[I])
3563 TableContents[I] = DefaultValue;
3566 if (DefaultValue != SingleValue)
3570 // If each element in the table contains the same value, we only need to store
3571 // that single value.
3573 Kind = SingleValueKind;
3577 // If the type is integer and the table fits in a register, build a bitmap.
3578 if (WouldFitInRegister(TD, TableSize, DefaultValue->getType())) {
3579 IntegerType *IT = cast<IntegerType>(DefaultValue->getType());
3580 APInt TableInt(TableSize * IT->getBitWidth(), 0);
3581 for (uint64_t I = TableSize; I > 0; --I) {
3582 TableInt <<= IT->getBitWidth();
3583 // Insert values into the bitmap. Undef values are set to zero.
3584 if (!isa<UndefValue>(TableContents[I - 1])) {
3585 ConstantInt *Val = cast<ConstantInt>(TableContents[I - 1]);
3586 TableInt |= Val->getValue().zext(TableInt.getBitWidth());
3589 BitMap = ConstantInt::get(M.getContext(), TableInt);
3590 BitMapElementTy = IT;
3596 // Store the table in an array.
3597 ArrayType *ArrayTy = ArrayType::get(DefaultValue->getType(), TableSize);
3598 Constant *Initializer = ConstantArray::get(ArrayTy, TableContents);
3600 Array = new GlobalVariable(M, ArrayTy, /*constant=*/ true,
3601 GlobalVariable::PrivateLinkage,
3604 Array->setUnnamedAddr(true);
3608 Value *SwitchLookupTable::BuildLookup(Value *Index, IRBuilder<> &Builder) {
3610 case SingleValueKind:
3613 // Type of the bitmap (e.g. i59).
3614 IntegerType *MapTy = BitMap->getType();
3616 // Cast Index to the same type as the bitmap.
3617 // Note: The Index is <= the number of elements in the table, so
3618 // truncating it to the width of the bitmask is safe.
3619 Value *ShiftAmt = Builder.CreateZExtOrTrunc(Index, MapTy, "switch.cast");
3621 // Multiply the shift amount by the element width.
3622 ShiftAmt = Builder.CreateMul(ShiftAmt,
3623 ConstantInt::get(MapTy, BitMapElementTy->getBitWidth()),
3627 Value *DownShifted = Builder.CreateLShr(BitMap, ShiftAmt,
3628 "switch.downshift");
3630 return Builder.CreateTrunc(DownShifted, BitMapElementTy,
3634 Value *GEPIndices[] = { Builder.getInt32(0), Index };
3635 Value *GEP = Builder.CreateInBoundsGEP(Array, GEPIndices,
3637 return Builder.CreateLoad(GEP, "switch.load");
3640 llvm_unreachable("Unknown lookup table kind!");
3643 bool SwitchLookupTable::WouldFitInRegister(const DataLayout *TD,
3645 const Type *ElementType) {
3648 const IntegerType *IT = dyn_cast<IntegerType>(ElementType);
3651 // FIXME: If the type is wider than it needs to be, e.g. i8 but all values
3652 // are <= 15, we could try to narrow the type.
3654 // Avoid overflow, fitsInLegalInteger uses unsigned int for the width.
3655 if (TableSize >= UINT_MAX/IT->getBitWidth())
3657 return TD->fitsInLegalInteger(TableSize * IT->getBitWidth());
3660 /// ShouldBuildLookupTable - Determine whether a lookup table should be built
3661 /// for this switch, based on the number of caes, size of the table and the
3662 /// types of the results.
3663 static bool ShouldBuildLookupTable(SwitchInst *SI,
3665 const TargetTransformInfo &TTI,
3666 const DataLayout *TD,
3667 const SmallDenseMap<PHINode*, Type*>& ResultTypes) {
3668 if (SI->getNumCases() > TableSize || TableSize >= UINT64_MAX / 10)
3669 return false; // TableSize overflowed, or mul below might overflow.
3671 bool AllTablesFitInRegister = true;
3672 bool HasIllegalType = false;
3673 for (SmallDenseMap<PHINode*, Type*>::const_iterator I = ResultTypes.begin(),
3674 E = ResultTypes.end(); I != E; ++I) {
3675 Type *Ty = I->second;
3677 // Saturate this flag to true.
3678 HasIllegalType = HasIllegalType || !TTI.isTypeLegal(Ty);
3680 // Saturate this flag to false.
3681 AllTablesFitInRegister = AllTablesFitInRegister &&
3682 SwitchLookupTable::WouldFitInRegister(TD, TableSize, Ty);
3684 // If both flags saturate, we're done. NOTE: This *only* works with
3685 // saturating flags, and all flags have to saturate first due to the
3686 // non-deterministic behavior of iterating over a dense map.
3687 if (HasIllegalType && !AllTablesFitInRegister)
3691 // If each table would fit in a register, we should build it anyway.
3692 if (AllTablesFitInRegister)
3695 // Don't build a table that doesn't fit in-register if it has illegal types.
3699 // The table density should be at least 40%. This is the same criterion as for
3700 // jump tables, see SelectionDAGBuilder::handleJTSwitchCase.
3701 // FIXME: Find the best cut-off.
3702 return SI->getNumCases() * 10 >= TableSize * 4;
3705 /// SwitchToLookupTable - If the switch is only used to initialize one or more
3706 /// phi nodes in a common successor block with different constant values,
3707 /// replace the switch with lookup tables.
3708 static bool SwitchToLookupTable(SwitchInst *SI,
3709 IRBuilder<> &Builder,
3710 const TargetTransformInfo &TTI,
3711 const DataLayout* TD) {
3712 assert(SI->getNumCases() > 1 && "Degenerate switch?");
3714 // Only build lookup table when we have a target that supports it.
3715 if (!TTI.shouldBuildLookupTables())
3718 // FIXME: If the switch is too sparse for a lookup table, perhaps we could
3719 // split off a dense part and build a lookup table for that.
3721 // FIXME: This creates arrays of GEPs to constant strings, which means each
3722 // GEP needs a runtime relocation in PIC code. We should just build one big
3723 // string and lookup indices into that.
3725 // Ignore the switch if the number of cases is too small.
3726 // This is similar to the check when building jump tables in
3727 // SelectionDAGBuilder::handleJTSwitchCase.
3728 // FIXME: Determine the best cut-off.
3729 if (SI->getNumCases() < 4)
3732 // Figure out the corresponding result for each case value and phi node in the
3733 // common destination, as well as the the min and max case values.
3734 assert(SI->case_begin() != SI->case_end());
3735 SwitchInst::CaseIt CI = SI->case_begin();
3736 ConstantInt *MinCaseVal = CI.getCaseValue();
3737 ConstantInt *MaxCaseVal = CI.getCaseValue();
3739 BasicBlock *CommonDest = 0;
3740 typedef SmallVector<std::pair<ConstantInt*, Constant*>, 4> ResultListTy;
3741 SmallDenseMap<PHINode*, ResultListTy> ResultLists;
3742 SmallDenseMap<PHINode*, Constant*> DefaultResults;
3743 SmallDenseMap<PHINode*, Type*> ResultTypes;
3744 SmallVector<PHINode*, 4> PHIs;
3746 for (SwitchInst::CaseIt E = SI->case_end(); CI != E; ++CI) {
3747 ConstantInt *CaseVal = CI.getCaseValue();
3748 if (CaseVal->getValue().slt(MinCaseVal->getValue()))
3749 MinCaseVal = CaseVal;
3750 if (CaseVal->getValue().sgt(MaxCaseVal->getValue()))
3751 MaxCaseVal = CaseVal;
3753 // Resulting value at phi nodes for this case value.
3754 typedef SmallVector<std::pair<PHINode*, Constant*>, 4> ResultsTy;
3756 if (!GetCaseResults(SI, CaseVal, CI.getCaseSuccessor(), &CommonDest,
3760 // Append the result from this case to the list for each phi.
3761 for (ResultsTy::iterator I = Results.begin(), E = Results.end(); I!=E; ++I) {
3762 if (!ResultLists.count(I->first))
3763 PHIs.push_back(I->first);
3764 ResultLists[I->first].push_back(std::make_pair(CaseVal, I->second));
3768 // Get the resulting values for the default case.
3769 SmallVector<std::pair<PHINode*, Constant*>, 4> DefaultResultsList;
3770 if (!GetCaseResults(SI, 0, SI->getDefaultDest(), &CommonDest,
3771 DefaultResultsList))
3773 for (size_t I = 0, E = DefaultResultsList.size(); I != E; ++I) {
3774 PHINode *PHI = DefaultResultsList[I].first;
3775 Constant *Result = DefaultResultsList[I].second;
3776 DefaultResults[PHI] = Result;
3777 ResultTypes[PHI] = Result->getType();
3780 APInt RangeSpread = MaxCaseVal->getValue() - MinCaseVal->getValue();
3781 uint64_t TableSize = RangeSpread.getLimitedValue() + 1;
3782 if (!ShouldBuildLookupTable(SI, TableSize, TTI, TD, ResultTypes))
3785 // Create the BB that does the lookups.
3786 Module &Mod = *CommonDest->getParent()->getParent();
3787 BasicBlock *LookupBB = BasicBlock::Create(Mod.getContext(),
3789 CommonDest->getParent(),
3792 // Check whether the condition value is within the case range, and branch to
3794 Builder.SetInsertPoint(SI);
3795 Value *TableIndex = Builder.CreateSub(SI->getCondition(), MinCaseVal,
3797 Value *Cmp = Builder.CreateICmpULT(TableIndex, ConstantInt::get(
3798 MinCaseVal->getType(), TableSize));
3799 Builder.CreateCondBr(Cmp, LookupBB, SI->getDefaultDest());
3801 // Populate the BB that does the lookups.
3802 Builder.SetInsertPoint(LookupBB);
3803 bool ReturnedEarly = false;
3804 for (size_t I = 0, E = PHIs.size(); I != E; ++I) {
3805 PHINode *PHI = PHIs[I];
3807 SwitchLookupTable Table(Mod, TableSize, MinCaseVal, ResultLists[PHI],
3808 DefaultResults[PHI], TD);
3810 Value *Result = Table.BuildLookup(TableIndex, Builder);
3812 // If the result is used to return immediately from the function, we want to
3813 // do that right here.
3814 if (PHI->hasOneUse() && isa<ReturnInst>(*PHI->use_begin()) &&
3815 *PHI->use_begin() == CommonDest->getFirstNonPHIOrDbg()) {
3816 Builder.CreateRet(Result);
3817 ReturnedEarly = true;
3821 PHI->addIncoming(Result, LookupBB);
3825 Builder.CreateBr(CommonDest);
3827 // Remove the switch.
3828 for (unsigned i = 0; i < SI->getNumSuccessors(); ++i) {
3829 BasicBlock *Succ = SI->getSuccessor(i);
3830 if (Succ == SI->getDefaultDest()) continue;
3831 Succ->removePredecessor(SI->getParent());
3833 SI->eraseFromParent();
3839 bool SimplifyCFGOpt::SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder) {
3840 BasicBlock *BB = SI->getParent();
3842 if (isValueEqualityComparison(SI)) {
3843 // If we only have one predecessor, and if it is a branch on this value,
3844 // see if that predecessor totally determines the outcome of this switch.
3845 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
3846 if (SimplifyEqualityComparisonWithOnlyPredecessor(SI, OnlyPred, Builder))
3847 return SimplifyCFG(BB, TTI, TD) | true;
3849 Value *Cond = SI->getCondition();
3850 if (SelectInst *Select = dyn_cast<SelectInst>(Cond))
3851 if (SimplifySwitchOnSelect(SI, Select))
3852 return SimplifyCFG(BB, TTI, TD) | true;
3854 // If the block only contains the switch, see if we can fold the block
3855 // away into any preds.
3856 BasicBlock::iterator BBI = BB->begin();
3857 // Ignore dbg intrinsics.
3858 while (isa<DbgInfoIntrinsic>(BBI))
3861 if (FoldValueComparisonIntoPredecessors(SI, Builder))
3862 return SimplifyCFG(BB, TTI, TD) | true;
3865 // Try to transform the switch into an icmp and a branch.
3866 if (TurnSwitchRangeIntoICmp(SI, Builder))
3867 return SimplifyCFG(BB, TTI, TD) | true;
3869 // Remove unreachable cases.
3870 if (EliminateDeadSwitchCases(SI))
3871 return SimplifyCFG(BB, TTI, TD) | true;
3873 if (ForwardSwitchConditionToPHI(SI))
3874 return SimplifyCFG(BB, TTI, TD) | true;
3876 if (SwitchToLookupTable(SI, Builder, TTI, TD))
3877 return SimplifyCFG(BB, TTI, TD) | true;
3882 bool SimplifyCFGOpt::SimplifyIndirectBr(IndirectBrInst *IBI) {
3883 BasicBlock *BB = IBI->getParent();
3884 bool Changed = false;
3886 // Eliminate redundant destinations.
3887 SmallPtrSet<Value *, 8> Succs;
3888 for (unsigned i = 0, e = IBI->getNumDestinations(); i != e; ++i) {
3889 BasicBlock *Dest = IBI->getDestination(i);
3890 if (!Dest->hasAddressTaken() || !Succs.insert(Dest)) {
3891 Dest->removePredecessor(BB);
3892 IBI->removeDestination(i);
3898 if (IBI->getNumDestinations() == 0) {
3899 // If the indirectbr has no successors, change it to unreachable.
3900 new UnreachableInst(IBI->getContext(), IBI);
3901 EraseTerminatorInstAndDCECond(IBI);
3905 if (IBI->getNumDestinations() == 1) {
3906 // If the indirectbr has one successor, change it to a direct branch.
3907 BranchInst::Create(IBI->getDestination(0), IBI);
3908 EraseTerminatorInstAndDCECond(IBI);
3912 if (SelectInst *SI = dyn_cast<SelectInst>(IBI->getAddress())) {
3913 if (SimplifyIndirectBrOnSelect(IBI, SI))
3914 return SimplifyCFG(BB, TTI, TD) | true;
3919 bool SimplifyCFGOpt::SimplifyUncondBranch(BranchInst *BI, IRBuilder<> &Builder){
3920 BasicBlock *BB = BI->getParent();
3922 if (SinkCommon && SinkThenElseCodeToEnd(BI))
3925 // If the Terminator is the only non-phi instruction, simplify the block.
3926 BasicBlock::iterator I = BB->getFirstNonPHIOrDbgOrLifetime();
3927 if (I->isTerminator() && BB != &BB->getParent()->getEntryBlock() &&
3928 TryToSimplifyUncondBranchFromEmptyBlock(BB))
3931 // If the only instruction in the block is a seteq/setne comparison
3932 // against a constant, try to simplify the block.
3933 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I))
3934 if (ICI->isEquality() && isa<ConstantInt>(ICI->getOperand(1))) {
3935 for (++I; isa<DbgInfoIntrinsic>(I); ++I)
3937 if (I->isTerminator() &&
3938 TryToSimplifyUncondBranchWithICmpInIt(ICI, Builder, TTI, TD))
3942 // If this basic block is ONLY a compare and a branch, and if a predecessor
3943 // branches to us and our successor, fold the comparison into the
3944 // predecessor and use logical operations to update the incoming value
3945 // for PHI nodes in common successor.
3946 if (FoldBranchToCommonDest(BI))
3947 return SimplifyCFG(BB, TTI, TD) | true;
3952 bool SimplifyCFGOpt::SimplifyCondBranch(BranchInst *BI, IRBuilder<> &Builder) {
3953 BasicBlock *BB = BI->getParent();
3955 // Conditional branch
3956 if (isValueEqualityComparison(BI)) {
3957 // If we only have one predecessor, and if it is a branch on this value,
3958 // see if that predecessor totally determines the outcome of this
3960 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
3961 if (SimplifyEqualityComparisonWithOnlyPredecessor(BI, OnlyPred, Builder))
3962 return SimplifyCFG(BB, TTI, TD) | true;
3964 // This block must be empty, except for the setcond inst, if it exists.
3965 // Ignore dbg intrinsics.
3966 BasicBlock::iterator I = BB->begin();
3967 // Ignore dbg intrinsics.
3968 while (isa<DbgInfoIntrinsic>(I))
3971 if (FoldValueComparisonIntoPredecessors(BI, Builder))
3972 return SimplifyCFG(BB, TTI, TD) | true;
3973 } else if (&*I == cast<Instruction>(BI->getCondition())){
3975 // Ignore dbg intrinsics.
3976 while (isa<DbgInfoIntrinsic>(I))
3978 if (&*I == BI && FoldValueComparisonIntoPredecessors(BI, Builder))
3979 return SimplifyCFG(BB, TTI, TD) | true;
3983 // Try to turn "br (X == 0 | X == 1), T, F" into a switch instruction.
3984 if (SimplifyBranchOnICmpChain(BI, TD, Builder))
3987 // If this basic block is ONLY a compare and a branch, and if a predecessor
3988 // branches to us and one of our successors, fold the comparison into the
3989 // predecessor and use logical operations to pick the right destination.
3990 if (FoldBranchToCommonDest(BI))
3991 return SimplifyCFG(BB, TTI, TD) | true;
3993 // We have a conditional branch to two blocks that are only reachable
3994 // from BI. We know that the condbr dominates the two blocks, so see if
3995 // there is any identical code in the "then" and "else" blocks. If so, we
3996 // can hoist it up to the branching block.
3997 if (BI->getSuccessor(0)->getSinglePredecessor() != 0) {
3998 if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
3999 if (HoistThenElseCodeToIf(BI))
4000 return SimplifyCFG(BB, TTI, TD) | true;
4002 // If Successor #1 has multiple preds, we may be able to conditionally
4003 // execute Successor #0 if it branches to successor #1.
4004 TerminatorInst *Succ0TI = BI->getSuccessor(0)->getTerminator();
4005 if (Succ0TI->getNumSuccessors() == 1 &&
4006 Succ0TI->getSuccessor(0) == BI->getSuccessor(1))
4007 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(0)))
4008 return SimplifyCFG(BB, TTI, TD) | true;
4010 } else if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
4011 // If Successor #0 has multiple preds, we may be able to conditionally
4012 // execute Successor #1 if it branches to successor #0.
4013 TerminatorInst *Succ1TI = BI->getSuccessor(1)->getTerminator();
4014 if (Succ1TI->getNumSuccessors() == 1 &&
4015 Succ1TI->getSuccessor(0) == BI->getSuccessor(0))
4016 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(1)))
4017 return SimplifyCFG(BB, TTI, TD) | true;
4020 // If this is a branch on a phi node in the current block, thread control
4021 // through this block if any PHI node entries are constants.
4022 if (PHINode *PN = dyn_cast<PHINode>(BI->getCondition()))
4023 if (PN->getParent() == BI->getParent())
4024 if (FoldCondBranchOnPHI(BI, TD))
4025 return SimplifyCFG(BB, TTI, TD) | true;
4027 // Scan predecessor blocks for conditional branches.
4028 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
4029 if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
4030 if (PBI != BI && PBI->isConditional())
4031 if (SimplifyCondBranchToCondBranch(PBI, BI))
4032 return SimplifyCFG(BB, TTI, TD) | true;
4037 /// Check if passing a value to an instruction will cause undefined behavior.
4038 static bool passingValueIsAlwaysUndefined(Value *V, Instruction *I) {
4039 Constant *C = dyn_cast<Constant>(V);
4046 if (C->isNullValue()) {
4047 // Only look at the first use, avoid hurting compile time with long uselists
4048 User *Use = *I->use_begin();
4050 // Now make sure that there are no instructions in between that can alter
4051 // control flow (eg. calls)
4052 for (BasicBlock::iterator i = ++BasicBlock::iterator(I); &*i != Use; ++i)
4053 if (i == I->getParent()->end() || i->mayHaveSideEffects())
4056 // Look through GEPs. A load from a GEP derived from NULL is still undefined
4057 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Use))
4058 if (GEP->getPointerOperand() == I)
4059 return passingValueIsAlwaysUndefined(V, GEP);
4061 // Look through bitcasts.
4062 if (BitCastInst *BC = dyn_cast<BitCastInst>(Use))
4063 return passingValueIsAlwaysUndefined(V, BC);
4065 // Load from null is undefined.
4066 if (LoadInst *LI = dyn_cast<LoadInst>(Use))
4067 if (!LI->isVolatile())
4068 return LI->getPointerAddressSpace() == 0;
4070 // Store to null is undefined.
4071 if (StoreInst *SI = dyn_cast<StoreInst>(Use))
4072 if (!SI->isVolatile())
4073 return SI->getPointerAddressSpace() == 0 && SI->getPointerOperand() == I;
4078 /// If BB has an incoming value that will always trigger undefined behavior
4079 /// (eg. null pointer dereference), remove the branch leading here.
4080 static bool removeUndefIntroducingPredecessor(BasicBlock *BB) {
4081 for (BasicBlock::iterator i = BB->begin();
4082 PHINode *PHI = dyn_cast<PHINode>(i); ++i)
4083 for (unsigned i = 0, e = PHI->getNumIncomingValues(); i != e; ++i)
4084 if (passingValueIsAlwaysUndefined(PHI->getIncomingValue(i), PHI)) {
4085 TerminatorInst *T = PHI->getIncomingBlock(i)->getTerminator();
4086 IRBuilder<> Builder(T);
4087 if (BranchInst *BI = dyn_cast<BranchInst>(T)) {
4088 BB->removePredecessor(PHI->getIncomingBlock(i));
4089 // Turn uncoditional branches into unreachables and remove the dead
4090 // destination from conditional branches.
4091 if (BI->isUnconditional())
4092 Builder.CreateUnreachable();
4094 Builder.CreateBr(BI->getSuccessor(0) == BB ? BI->getSuccessor(1) :
4095 BI->getSuccessor(0));
4096 BI->eraseFromParent();
4099 // TODO: SwitchInst.
4105 bool SimplifyCFGOpt::run(BasicBlock *BB) {
4106 bool Changed = false;
4108 assert(BB && BB->getParent() && "Block not embedded in function!");
4109 assert(BB->getTerminator() && "Degenerate basic block encountered!");
4111 // Remove basic blocks that have no predecessors (except the entry block)...
4112 // or that just have themself as a predecessor. These are unreachable.
4113 if ((pred_begin(BB) == pred_end(BB) &&
4114 BB != &BB->getParent()->getEntryBlock()) ||
4115 BB->getSinglePredecessor() == BB) {
4116 DEBUG(dbgs() << "Removing BB: \n" << *BB);
4117 DeleteDeadBlock(BB);
4121 // Check to see if we can constant propagate this terminator instruction
4123 Changed |= ConstantFoldTerminator(BB, true);
4125 // Check for and eliminate duplicate PHI nodes in this block.
4126 Changed |= EliminateDuplicatePHINodes(BB);
4128 // Check for and remove branches that will always cause undefined behavior.
4129 Changed |= removeUndefIntroducingPredecessor(BB);
4131 // Merge basic blocks into their predecessor if there is only one distinct
4132 // pred, and if there is only one distinct successor of the predecessor, and
4133 // if there are no PHI nodes.
4135 if (MergeBlockIntoPredecessor(BB))
4138 IRBuilder<> Builder(BB);
4140 // If there is a trivial two-entry PHI node in this basic block, and we can
4141 // eliminate it, do so now.
4142 if (PHINode *PN = dyn_cast<PHINode>(BB->begin()))
4143 if (PN->getNumIncomingValues() == 2)
4144 Changed |= FoldTwoEntryPHINode(PN, TD);
4146 Builder.SetInsertPoint(BB->getTerminator());
4147 if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
4148 if (BI->isUnconditional()) {
4149 if (SimplifyUncondBranch(BI, Builder)) return true;
4151 if (SimplifyCondBranch(BI, Builder)) return true;
4153 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
4154 if (SimplifyReturn(RI, Builder)) return true;
4155 } else if (ResumeInst *RI = dyn_cast<ResumeInst>(BB->getTerminator())) {
4156 if (SimplifyResume(RI, Builder)) return true;
4157 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
4158 if (SimplifySwitch(SI, Builder)) return true;
4159 } else if (UnreachableInst *UI =
4160 dyn_cast<UnreachableInst>(BB->getTerminator())) {
4161 if (SimplifyUnreachable(UI)) return true;
4162 } else if (IndirectBrInst *IBI =
4163 dyn_cast<IndirectBrInst>(BB->getTerminator())) {
4164 if (SimplifyIndirectBr(IBI)) return true;
4170 /// SimplifyCFG - This function is used to do simplification of a CFG. For
4171 /// example, it adjusts branches to branches to eliminate the extra hop, it
4172 /// eliminates unreachable basic blocks, and does other "peephole" optimization
4173 /// of the CFG. It returns true if a modification was made.
4175 bool llvm::SimplifyCFG(BasicBlock *BB, const TargetTransformInfo &TTI,
4176 const DataLayout *TD) {
4177 return SimplifyCFGOpt(TTI, TD).run(BB);