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/Constants.h"
17 #include "llvm/Instructions.h"
18 #include "llvm/Type.h"
19 #include "llvm/DerivedTypes.h"
20 #include "llvm/Support/CFG.h"
21 #include "llvm/Support/Debug.h"
22 #include "llvm/Analysis/ConstantFolding.h"
23 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
24 #include "llvm/ADT/SmallVector.h"
25 #include "llvm/ADT/SmallPtrSet.h"
26 #include "llvm/ADT/Statistic.h"
33 STATISTIC(NumSpeculations, "Number of speculative executed instructions");
35 /// SafeToMergeTerminators - Return true if it is safe to merge these two
36 /// terminator instructions together.
38 static bool SafeToMergeTerminators(TerminatorInst *SI1, TerminatorInst *SI2) {
39 if (SI1 == SI2) return false; // Can't merge with self!
41 // It is not safe to merge these two switch instructions if they have a common
42 // successor, and if that successor has a PHI node, and if *that* PHI node has
43 // conflicting incoming values from the two switch blocks.
44 BasicBlock *SI1BB = SI1->getParent();
45 BasicBlock *SI2BB = SI2->getParent();
46 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
48 for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
49 if (SI1Succs.count(*I))
50 for (BasicBlock::iterator BBI = (*I)->begin();
51 isa<PHINode>(BBI); ++BBI) {
52 PHINode *PN = cast<PHINode>(BBI);
53 if (PN->getIncomingValueForBlock(SI1BB) !=
54 PN->getIncomingValueForBlock(SI2BB))
61 /// AddPredecessorToBlock - Update PHI nodes in Succ to indicate that there will
62 /// now be entries in it from the 'NewPred' block. The values that will be
63 /// flowing into the PHI nodes will be the same as those coming in from
64 /// ExistPred, an existing predecessor of Succ.
65 static void AddPredecessorToBlock(BasicBlock *Succ, BasicBlock *NewPred,
66 BasicBlock *ExistPred) {
67 assert(std::find(succ_begin(ExistPred), succ_end(ExistPred), Succ) !=
68 succ_end(ExistPred) && "ExistPred is not a predecessor of Succ!");
69 if (!isa<PHINode>(Succ->begin())) return; // Quick exit if nothing to do
72 for (BasicBlock::iterator I = Succ->begin();
73 (PN = dyn_cast<PHINode>(I)); ++I)
74 PN->addIncoming(PN->getIncomingValueForBlock(ExistPred), NewPred);
77 /// CanPropagatePredecessorsForPHIs - Return true if we can fold BB, an
78 /// almost-empty BB ending in an unconditional branch to Succ, into succ.
80 /// Assumption: Succ is the single successor for BB.
82 static bool CanPropagatePredecessorsForPHIs(BasicBlock *BB, BasicBlock *Succ) {
83 assert(*succ_begin(BB) == Succ && "Succ is not successor of BB!");
85 DOUT << "Looking to fold " << BB->getNameStart() << " into "
86 << Succ->getNameStart() << "\n";
87 // Shortcut, if there is only a single predecessor is must be BB and merging
89 if (Succ->getSinglePredecessor()) return true;
91 typedef SmallPtrSet<Instruction*, 16> InstrSet;
94 // Make a list of all phi nodes in BB
95 BasicBlock::iterator BBI = BB->begin();
96 while (isa<PHINode>(*BBI)) BBPHIs.insert(BBI++);
98 // Make a list of the predecessors of BB
99 typedef SmallPtrSet<BasicBlock*, 16> BlockSet;
100 BlockSet BBPreds(pred_begin(BB), pred_end(BB));
102 // Use that list to make another list of common predecessors of BB and Succ
103 BlockSet CommonPreds;
104 for (pred_iterator PI = pred_begin(Succ), PE = pred_end(Succ);
106 if (BBPreds.count(*PI))
107 CommonPreds.insert(*PI);
109 // Shortcut, if there are no common predecessors, merging is always safe
110 if (CommonPreds.empty())
113 // Look at all the phi nodes in Succ, to see if they present a conflict when
114 // merging these blocks
115 for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
116 PHINode *PN = cast<PHINode>(I);
118 // If the incoming value from BB is again a PHINode in
119 // BB which has the same incoming value for *PI as PN does, we can
120 // merge the phi nodes and then the blocks can still be merged
121 PHINode *BBPN = dyn_cast<PHINode>(PN->getIncomingValueForBlock(BB));
122 if (BBPN && BBPN->getParent() == BB) {
123 for (BlockSet::iterator PI = CommonPreds.begin(), PE = CommonPreds.end();
125 if (BBPN->getIncomingValueForBlock(*PI)
126 != PN->getIncomingValueForBlock(*PI)) {
127 DOUT << "Can't fold, phi node " << *PN->getNameStart() << " in "
128 << Succ->getNameStart() << " is conflicting with "
129 << BBPN->getNameStart() << " with regard to common predecessor "
130 << (*PI)->getNameStart() << "\n";
134 // Remove this phinode from the list of phis in BB, since it has been
138 Value* Val = PN->getIncomingValueForBlock(BB);
139 for (BlockSet::iterator PI = CommonPreds.begin(), PE = CommonPreds.end();
141 // See if the incoming value for the common predecessor is equal to the
142 // one for BB, in which case this phi node will not prevent the merging
144 if (Val != PN->getIncomingValueForBlock(*PI)) {
145 DOUT << "Can't fold, phi node " << *PN->getNameStart() << " in "
146 << Succ->getNameStart() << " is conflicting with regard to common "
147 << "predecessor " << (*PI)->getNameStart() << "\n";
154 // If there are any other phi nodes in BB that don't have a phi node in Succ
155 // to merge with, they must be moved to Succ completely. However, for any
156 // predecessors of Succ, branches will be added to the phi node that just
157 // point to itself. So, for any common predecessors, this must not cause
159 for (InstrSet::iterator I = BBPHIs.begin(), E = BBPHIs.end();
161 PHINode *PN = cast<PHINode>(*I);
162 for (BlockSet::iterator PI = CommonPreds.begin(), PE = CommonPreds.end();
164 if (PN->getIncomingValueForBlock(*PI) != PN) {
165 DOUT << "Can't fold, phi node " << *PN->getNameStart() << " in "
166 << BB->getNameStart() << " is conflicting with regard to common "
167 << "predecessor " << (*PI)->getNameStart() << "\n";
175 /// TryToSimplifyUncondBranchFromEmptyBlock - BB contains an unconditional
176 /// branch to Succ, and contains no instructions other than PHI nodes and the
177 /// branch. If possible, eliminate BB.
178 static bool TryToSimplifyUncondBranchFromEmptyBlock(BasicBlock *BB,
180 // Check to see if merging these blocks would cause conflicts for any of the
181 // phi nodes in BB or Succ. If not, we can safely merge.
182 if (!CanPropagatePredecessorsForPHIs(BB, Succ)) return false;
184 DOUT << "Killing Trivial BB: \n" << *BB;
186 if (isa<PHINode>(Succ->begin())) {
187 // If there is more than one pred of succ, and there are PHI nodes in
188 // the successor, then we need to add incoming edges for the PHI nodes
190 const SmallVector<BasicBlock*, 16> BBPreds(pred_begin(BB), pred_end(BB));
192 // Loop over all of the PHI nodes in the successor of BB.
193 for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
194 PHINode *PN = cast<PHINode>(I);
195 Value *OldVal = PN->removeIncomingValue(BB, false);
196 assert(OldVal && "No entry in PHI for Pred BB!");
198 // If this incoming value is one of the PHI nodes in BB, the new entries
199 // in the PHI node are the entries from the old PHI.
200 if (isa<PHINode>(OldVal) && cast<PHINode>(OldVal)->getParent() == BB) {
201 PHINode *OldValPN = cast<PHINode>(OldVal);
202 for (unsigned i = 0, e = OldValPN->getNumIncomingValues(); i != e; ++i)
203 // Note that, since we are merging phi nodes and BB and Succ might
204 // have common predecessors, we could end up with a phi node with
205 // identical incoming branches. This will be cleaned up later (and
206 // will trigger asserts if we try to clean it up now, without also
207 // simplifying the corresponding conditional branch).
208 PN->addIncoming(OldValPN->getIncomingValue(i),
209 OldValPN->getIncomingBlock(i));
211 // Add an incoming value for each of the new incoming values.
212 for (unsigned i = 0, e = BBPreds.size(); i != e; ++i)
213 PN->addIncoming(OldVal, BBPreds[i]);
218 if (isa<PHINode>(&BB->front())) {
219 SmallVector<BasicBlock*, 16>
220 OldSuccPreds(pred_begin(Succ), pred_end(Succ));
222 // Move all PHI nodes in BB to Succ if they are alive, otherwise
224 while (PHINode *PN = dyn_cast<PHINode>(&BB->front())) {
225 if (PN->use_empty()) {
226 // Just remove the dead phi. This happens if Succ's PHIs were the only
227 // users of the PHI nodes.
228 PN->eraseFromParent();
232 // The instruction is alive, so this means that BB must dominate all
233 // predecessors of Succ (Since all uses of the PN are after its
234 // definition, so in Succ or a block dominated by Succ. If a predecessor
235 // of Succ would not be dominated by BB, PN would violate the def before
236 // use SSA demand). Therefore, we can simply move the phi node to the
238 Succ->getInstList().splice(Succ->begin(),
239 BB->getInstList(), BB->begin());
241 // We need to add new entries for the PHI node to account for
242 // predecessors of Succ that the PHI node does not take into
243 // account. At this point, since we know that BB dominated succ and all
244 // of its predecessors, this means that we should any newly added
245 // incoming edges should use the PHI node itself as the value for these
246 // edges, because they are loop back edges.
247 for (unsigned i = 0, e = OldSuccPreds.size(); i != e; ++i)
248 if (OldSuccPreds[i] != BB)
249 PN->addIncoming(PN, OldSuccPreds[i]);
253 // Everything that jumped to BB now goes to Succ.
254 BB->replaceAllUsesWith(Succ);
255 if (!Succ->hasName()) Succ->takeName(BB);
256 BB->eraseFromParent(); // Delete the old basic block.
260 /// GetIfCondition - Given a basic block (BB) with two predecessors (and
261 /// presumably PHI nodes in it), check to see if the merge at this block is due
262 /// to an "if condition". If so, return the boolean condition that determines
263 /// which entry into BB will be taken. Also, return by references the block
264 /// that will be entered from if the condition is true, and the block that will
265 /// be entered if the condition is false.
268 static Value *GetIfCondition(BasicBlock *BB,
269 BasicBlock *&IfTrue, BasicBlock *&IfFalse) {
270 assert(std::distance(pred_begin(BB), pred_end(BB)) == 2 &&
271 "Function can only handle blocks with 2 predecessors!");
272 BasicBlock *Pred1 = *pred_begin(BB);
273 BasicBlock *Pred2 = *++pred_begin(BB);
275 // We can only handle branches. Other control flow will be lowered to
276 // branches if possible anyway.
277 if (!isa<BranchInst>(Pred1->getTerminator()) ||
278 !isa<BranchInst>(Pred2->getTerminator()))
280 BranchInst *Pred1Br = cast<BranchInst>(Pred1->getTerminator());
281 BranchInst *Pred2Br = cast<BranchInst>(Pred2->getTerminator());
283 // Eliminate code duplication by ensuring that Pred1Br is conditional if
285 if (Pred2Br->isConditional()) {
286 // If both branches are conditional, we don't have an "if statement". In
287 // reality, we could transform this case, but since the condition will be
288 // required anyway, we stand no chance of eliminating it, so the xform is
289 // probably not profitable.
290 if (Pred1Br->isConditional())
293 std::swap(Pred1, Pred2);
294 std::swap(Pred1Br, Pred2Br);
297 if (Pred1Br->isConditional()) {
298 // If we found a conditional branch predecessor, make sure that it branches
299 // to BB and Pred2Br. If it doesn't, this isn't an "if statement".
300 if (Pred1Br->getSuccessor(0) == BB &&
301 Pred1Br->getSuccessor(1) == Pred2) {
304 } else if (Pred1Br->getSuccessor(0) == Pred2 &&
305 Pred1Br->getSuccessor(1) == BB) {
309 // We know that one arm of the conditional goes to BB, so the other must
310 // go somewhere unrelated, and this must not be an "if statement".
314 // The only thing we have to watch out for here is to make sure that Pred2
315 // doesn't have incoming edges from other blocks. If it does, the condition
316 // doesn't dominate BB.
317 if (++pred_begin(Pred2) != pred_end(Pred2))
320 return Pred1Br->getCondition();
323 // Ok, if we got here, both predecessors end with an unconditional branch to
324 // BB. Don't panic! If both blocks only have a single (identical)
325 // predecessor, and THAT is a conditional branch, then we're all ok!
326 if (pred_begin(Pred1) == pred_end(Pred1) ||
327 ++pred_begin(Pred1) != pred_end(Pred1) ||
328 pred_begin(Pred2) == pred_end(Pred2) ||
329 ++pred_begin(Pred2) != pred_end(Pred2) ||
330 *pred_begin(Pred1) != *pred_begin(Pred2))
333 // Otherwise, if this is a conditional branch, then we can use it!
334 BasicBlock *CommonPred = *pred_begin(Pred1);
335 if (BranchInst *BI = dyn_cast<BranchInst>(CommonPred->getTerminator())) {
336 assert(BI->isConditional() && "Two successors but not conditional?");
337 if (BI->getSuccessor(0) == Pred1) {
344 return BI->getCondition();
350 /// DominatesMergePoint - If we have a merge point of an "if condition" as
351 /// accepted above, return true if the specified value dominates the block. We
352 /// don't handle the true generality of domination here, just a special case
353 /// which works well enough for us.
355 /// If AggressiveInsts is non-null, and if V does not dominate BB, we check to
356 /// see if V (which must be an instruction) is cheap to compute and is
357 /// non-trapping. If both are true, the instruction is inserted into the set
358 /// and true is returned.
359 static bool DominatesMergePoint(Value *V, BasicBlock *BB,
360 std::set<Instruction*> *AggressiveInsts) {
361 Instruction *I = dyn_cast<Instruction>(V);
363 // Non-instructions all dominate instructions, but not all constantexprs
364 // can be executed unconditionally.
365 if (ConstantExpr *C = dyn_cast<ConstantExpr>(V))
370 BasicBlock *PBB = I->getParent();
372 // We don't want to allow weird loops that might have the "if condition" in
373 // the bottom of this block.
374 if (PBB == BB) return false;
376 // If this instruction is defined in a block that contains an unconditional
377 // branch to BB, then it must be in the 'conditional' part of the "if
379 if (BranchInst *BI = dyn_cast<BranchInst>(PBB->getTerminator()))
380 if (BI->isUnconditional() && BI->getSuccessor(0) == BB) {
381 if (!AggressiveInsts) return false;
382 // Okay, it looks like the instruction IS in the "condition". Check to
383 // see if its a cheap instruction to unconditionally compute, and if it
384 // only uses stuff defined outside of the condition. If so, hoist it out.
385 switch (I->getOpcode()) {
386 default: return false; // Cannot hoist this out safely.
387 case Instruction::Load:
388 // We can hoist loads that are non-volatile and obviously cannot trap.
389 if (cast<LoadInst>(I)->isVolatile())
391 // FIXME: A computation of a constant can trap!
392 if (!isa<AllocaInst>(I->getOperand(0)) &&
393 !isa<Constant>(I->getOperand(0)))
396 // Finally, we have to check to make sure there are no instructions
397 // before the load in its basic block, as we are going to hoist the loop
398 // out to its predecessor.
399 if (PBB->begin() != BasicBlock::iterator(I))
402 case Instruction::Add:
403 case Instruction::Sub:
404 case Instruction::And:
405 case Instruction::Or:
406 case Instruction::Xor:
407 case Instruction::Shl:
408 case Instruction::LShr:
409 case Instruction::AShr:
410 case Instruction::ICmp:
411 case Instruction::FCmp:
412 if (I->getOperand(0)->getType()->isFPOrFPVector())
413 return false; // FP arithmetic might trap.
414 break; // These are all cheap and non-trapping instructions.
417 // Okay, we can only really hoist these out if their operands are not
418 // defined in the conditional region.
419 for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i)
420 if (!DominatesMergePoint(*i, BB, 0))
422 // Okay, it's safe to do this! Remember this instruction.
423 AggressiveInsts->insert(I);
429 /// GatherConstantSetEQs - Given a potentially 'or'd together collection of
430 /// icmp_eq instructions that compare a value against a constant, return the
431 /// value being compared, and stick the constant into the Values vector.
432 static Value *GatherConstantSetEQs(Value *V, std::vector<ConstantInt*> &Values){
433 if (Instruction *Inst = dyn_cast<Instruction>(V)) {
434 if (Inst->getOpcode() == Instruction::ICmp &&
435 cast<ICmpInst>(Inst)->getPredicate() == ICmpInst::ICMP_EQ) {
436 if (ConstantInt *C = dyn_cast<ConstantInt>(Inst->getOperand(1))) {
438 return Inst->getOperand(0);
439 } else if (ConstantInt *C = dyn_cast<ConstantInt>(Inst->getOperand(0))) {
441 return Inst->getOperand(1);
443 } else if (Inst->getOpcode() == Instruction::Or) {
444 if (Value *LHS = GatherConstantSetEQs(Inst->getOperand(0), Values))
445 if (Value *RHS = GatherConstantSetEQs(Inst->getOperand(1), Values))
453 /// GatherConstantSetNEs - Given a potentially 'and'd together collection of
454 /// setne instructions that compare a value against a constant, return the value
455 /// being compared, and stick the constant into the Values vector.
456 static Value *GatherConstantSetNEs(Value *V, std::vector<ConstantInt*> &Values){
457 if (Instruction *Inst = dyn_cast<Instruction>(V)) {
458 if (Inst->getOpcode() == Instruction::ICmp &&
459 cast<ICmpInst>(Inst)->getPredicate() == ICmpInst::ICMP_NE) {
460 if (ConstantInt *C = dyn_cast<ConstantInt>(Inst->getOperand(1))) {
462 return Inst->getOperand(0);
463 } else if (ConstantInt *C = dyn_cast<ConstantInt>(Inst->getOperand(0))) {
465 return Inst->getOperand(1);
467 } else if (Inst->getOpcode() == Instruction::And) {
468 if (Value *LHS = GatherConstantSetNEs(Inst->getOperand(0), Values))
469 if (Value *RHS = GatherConstantSetNEs(Inst->getOperand(1), Values))
477 /// GatherValueComparisons - If the specified Cond is an 'and' or 'or' of a
478 /// bunch of comparisons of one value against constants, return the value and
479 /// the constants being compared.
480 static bool GatherValueComparisons(Instruction *Cond, Value *&CompVal,
481 std::vector<ConstantInt*> &Values) {
482 if (Cond->getOpcode() == Instruction::Or) {
483 CompVal = GatherConstantSetEQs(Cond, Values);
485 // Return true to indicate that the condition is true if the CompVal is
486 // equal to one of the constants.
488 } else if (Cond->getOpcode() == Instruction::And) {
489 CompVal = GatherConstantSetNEs(Cond, Values);
491 // Return false to indicate that the condition is false if the CompVal is
492 // equal to one of the constants.
498 static void EraseTerminatorInstAndDCECond(TerminatorInst *TI) {
499 Instruction* Cond = 0;
500 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
501 Cond = dyn_cast<Instruction>(SI->getCondition());
502 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
503 if (BI->isConditional())
504 Cond = dyn_cast<Instruction>(BI->getCondition());
507 TI->eraseFromParent();
508 if (Cond) RecursivelyDeleteTriviallyDeadInstructions(Cond);
511 /// isValueEqualityComparison - Return true if the specified terminator checks
512 /// to see if a value is equal to constant integer value.
513 static Value *isValueEqualityComparison(TerminatorInst *TI) {
514 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
515 // Do not permit merging of large switch instructions into their
516 // predecessors unless there is only one predecessor.
517 if (SI->getNumSuccessors() * std::distance(pred_begin(SI->getParent()),
518 pred_end(SI->getParent())) > 128)
521 return SI->getCondition();
523 if (BranchInst *BI = dyn_cast<BranchInst>(TI))
524 if (BI->isConditional() && BI->getCondition()->hasOneUse())
525 if (ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition()))
526 if ((ICI->getPredicate() == ICmpInst::ICMP_EQ ||
527 ICI->getPredicate() == ICmpInst::ICMP_NE) &&
528 isa<ConstantInt>(ICI->getOperand(1)))
529 return ICI->getOperand(0);
533 /// GetValueEqualityComparisonCases - Given a value comparison instruction,
534 /// decode all of the 'cases' that it represents and return the 'default' block.
536 GetValueEqualityComparisonCases(TerminatorInst *TI,
537 std::vector<std::pair<ConstantInt*,
538 BasicBlock*> > &Cases) {
539 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
540 Cases.reserve(SI->getNumCases());
541 for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
542 Cases.push_back(std::make_pair(SI->getCaseValue(i), SI->getSuccessor(i)));
543 return SI->getDefaultDest();
546 BranchInst *BI = cast<BranchInst>(TI);
547 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
548 Cases.push_back(std::make_pair(cast<ConstantInt>(ICI->getOperand(1)),
549 BI->getSuccessor(ICI->getPredicate() ==
550 ICmpInst::ICMP_NE)));
551 return BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_EQ);
555 /// EliminateBlockCases - Given a vector of bb/value pairs, remove any entries
556 /// in the list that match the specified block.
557 static void EliminateBlockCases(BasicBlock *BB,
558 std::vector<std::pair<ConstantInt*, BasicBlock*> > &Cases) {
559 for (unsigned i = 0, e = Cases.size(); i != e; ++i)
560 if (Cases[i].second == BB) {
561 Cases.erase(Cases.begin()+i);
566 /// ValuesOverlap - Return true if there are any keys in C1 that exist in C2 as
569 ValuesOverlap(std::vector<std::pair<ConstantInt*, BasicBlock*> > &C1,
570 std::vector<std::pair<ConstantInt*, BasicBlock*> > &C2) {
571 std::vector<std::pair<ConstantInt*, BasicBlock*> > *V1 = &C1, *V2 = &C2;
573 // Make V1 be smaller than V2.
574 if (V1->size() > V2->size())
577 if (V1->size() == 0) return false;
578 if (V1->size() == 1) {
580 ConstantInt *TheVal = (*V1)[0].first;
581 for (unsigned i = 0, e = V2->size(); i != e; ++i)
582 if (TheVal == (*V2)[i].first)
586 // Otherwise, just sort both lists and compare element by element.
587 std::sort(V1->begin(), V1->end());
588 std::sort(V2->begin(), V2->end());
589 unsigned i1 = 0, i2 = 0, e1 = V1->size(), e2 = V2->size();
590 while (i1 != e1 && i2 != e2) {
591 if ((*V1)[i1].first == (*V2)[i2].first)
593 if ((*V1)[i1].first < (*V2)[i2].first)
601 /// SimplifyEqualityComparisonWithOnlyPredecessor - If TI is known to be a
602 /// terminator instruction and its block is known to only have a single
603 /// predecessor block, check to see if that predecessor is also a value
604 /// comparison with the same value, and if that comparison determines the
605 /// outcome of this comparison. If so, simplify TI. This does a very limited
606 /// form of jump threading.
607 static bool SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
609 Value *PredVal = isValueEqualityComparison(Pred->getTerminator());
610 if (!PredVal) return false; // Not a value comparison in predecessor.
612 Value *ThisVal = isValueEqualityComparison(TI);
613 assert(ThisVal && "This isn't a value comparison!!");
614 if (ThisVal != PredVal) return false; // Different predicates.
616 // Find out information about when control will move from Pred to TI's block.
617 std::vector<std::pair<ConstantInt*, BasicBlock*> > PredCases;
618 BasicBlock *PredDef = GetValueEqualityComparisonCases(Pred->getTerminator(),
620 EliminateBlockCases(PredDef, PredCases); // Remove default from cases.
622 // Find information about how control leaves this block.
623 std::vector<std::pair<ConstantInt*, BasicBlock*> > ThisCases;
624 BasicBlock *ThisDef = GetValueEqualityComparisonCases(TI, ThisCases);
625 EliminateBlockCases(ThisDef, ThisCases); // Remove default from cases.
627 // If TI's block is the default block from Pred's comparison, potentially
628 // simplify TI based on this knowledge.
629 if (PredDef == TI->getParent()) {
630 // If we are here, we know that the value is none of those cases listed in
631 // PredCases. If there are any cases in ThisCases that are in PredCases, we
633 if (ValuesOverlap(PredCases, ThisCases)) {
634 if (isa<BranchInst>(TI)) {
635 // Okay, one of the successors of this condbr is dead. Convert it to a
637 assert(ThisCases.size() == 1 && "Branch can only have one case!");
638 // Insert the new branch.
639 Instruction *NI = BranchInst::Create(ThisDef, TI);
641 // Remove PHI node entries for the dead edge.
642 ThisCases[0].second->removePredecessor(TI->getParent());
644 DOUT << "Threading pred instr: " << *Pred->getTerminator()
645 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n";
647 EraseTerminatorInstAndDCECond(TI);
651 SwitchInst *SI = cast<SwitchInst>(TI);
652 // Okay, TI has cases that are statically dead, prune them away.
653 SmallPtrSet<Constant*, 16> DeadCases;
654 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
655 DeadCases.insert(PredCases[i].first);
657 DOUT << "Threading pred instr: " << *Pred->getTerminator()
658 << "Through successor TI: " << *TI;
660 for (unsigned i = SI->getNumCases()-1; i != 0; --i)
661 if (DeadCases.count(SI->getCaseValue(i))) {
662 SI->getSuccessor(i)->removePredecessor(TI->getParent());
666 DOUT << "Leaving: " << *TI << "\n";
672 // Otherwise, TI's block must correspond to some matched value. Find out
673 // which value (or set of values) this is.
674 ConstantInt *TIV = 0;
675 BasicBlock *TIBB = TI->getParent();
676 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
677 if (PredCases[i].second == TIBB) {
679 TIV = PredCases[i].first;
681 return false; // Cannot handle multiple values coming to this block.
683 assert(TIV && "No edge from pred to succ?");
685 // Okay, we found the one constant that our value can be if we get into TI's
686 // BB. Find out which successor will unconditionally be branched to.
687 BasicBlock *TheRealDest = 0;
688 for (unsigned i = 0, e = ThisCases.size(); i != e; ++i)
689 if (ThisCases[i].first == TIV) {
690 TheRealDest = ThisCases[i].second;
694 // If not handled by any explicit cases, it is handled by the default case.
695 if (TheRealDest == 0) TheRealDest = ThisDef;
697 // Remove PHI node entries for dead edges.
698 BasicBlock *CheckEdge = TheRealDest;
699 for (succ_iterator SI = succ_begin(TIBB), e = succ_end(TIBB); SI != e; ++SI)
700 if (*SI != CheckEdge)
701 (*SI)->removePredecessor(TIBB);
705 // Insert the new branch.
706 Instruction *NI = BranchInst::Create(TheRealDest, TI);
708 DOUT << "Threading pred instr: " << *Pred->getTerminator()
709 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n";
711 EraseTerminatorInstAndDCECond(TI);
717 /// FoldValueComparisonIntoPredecessors - The specified terminator is a value
718 /// equality comparison instruction (either a switch or a branch on "X == c").
719 /// See if any of the predecessors of the terminator block are value comparisons
720 /// on the same value. If so, and if safe to do so, fold them together.
721 static bool FoldValueComparisonIntoPredecessors(TerminatorInst *TI) {
722 BasicBlock *BB = TI->getParent();
723 Value *CV = isValueEqualityComparison(TI); // CondVal
724 assert(CV && "Not a comparison?");
725 bool Changed = false;
727 SmallVector<BasicBlock*, 16> Preds(pred_begin(BB), pred_end(BB));
728 while (!Preds.empty()) {
729 BasicBlock *Pred = Preds.back();
732 // See if the predecessor is a comparison with the same value.
733 TerminatorInst *PTI = Pred->getTerminator();
734 Value *PCV = isValueEqualityComparison(PTI); // PredCondVal
736 if (PCV == CV && SafeToMergeTerminators(TI, PTI)) {
737 // Figure out which 'cases' to copy from SI to PSI.
738 std::vector<std::pair<ConstantInt*, BasicBlock*> > BBCases;
739 BasicBlock *BBDefault = GetValueEqualityComparisonCases(TI, BBCases);
741 std::vector<std::pair<ConstantInt*, BasicBlock*> > PredCases;
742 BasicBlock *PredDefault = GetValueEqualityComparisonCases(PTI, PredCases);
744 // Based on whether the default edge from PTI goes to BB or not, fill in
745 // PredCases and PredDefault with the new switch cases we would like to
747 SmallVector<BasicBlock*, 8> NewSuccessors;
749 if (PredDefault == BB) {
750 // If this is the default destination from PTI, only the edges in TI
751 // that don't occur in PTI, or that branch to BB will be activated.
752 std::set<ConstantInt*> PTIHandled;
753 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
754 if (PredCases[i].second != BB)
755 PTIHandled.insert(PredCases[i].first);
757 // The default destination is BB, we don't need explicit targets.
758 std::swap(PredCases[i], PredCases.back());
759 PredCases.pop_back();
763 // Reconstruct the new switch statement we will be building.
764 if (PredDefault != BBDefault) {
765 PredDefault->removePredecessor(Pred);
766 PredDefault = BBDefault;
767 NewSuccessors.push_back(BBDefault);
769 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
770 if (!PTIHandled.count(BBCases[i].first) &&
771 BBCases[i].second != BBDefault) {
772 PredCases.push_back(BBCases[i]);
773 NewSuccessors.push_back(BBCases[i].second);
777 // If this is not the default destination from PSI, only the edges
778 // in SI that occur in PSI with a destination of BB will be
780 std::set<ConstantInt*> PTIHandled;
781 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
782 if (PredCases[i].second == BB) {
783 PTIHandled.insert(PredCases[i].first);
784 std::swap(PredCases[i], PredCases.back());
785 PredCases.pop_back();
789 // Okay, now we know which constants were sent to BB from the
790 // predecessor. Figure out where they will all go now.
791 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
792 if (PTIHandled.count(BBCases[i].first)) {
793 // If this is one we are capable of getting...
794 PredCases.push_back(BBCases[i]);
795 NewSuccessors.push_back(BBCases[i].second);
796 PTIHandled.erase(BBCases[i].first);// This constant is taken care of
799 // If there are any constants vectored to BB that TI doesn't handle,
800 // they must go to the default destination of TI.
801 for (std::set<ConstantInt*>::iterator I = PTIHandled.begin(),
802 E = PTIHandled.end(); I != E; ++I) {
803 PredCases.push_back(std::make_pair(*I, BBDefault));
804 NewSuccessors.push_back(BBDefault);
808 // Okay, at this point, we know which new successor Pred will get. Make
809 // sure we update the number of entries in the PHI nodes for these
811 for (unsigned i = 0, e = NewSuccessors.size(); i != e; ++i)
812 AddPredecessorToBlock(NewSuccessors[i], Pred, BB);
814 // Now that the successors are updated, create the new Switch instruction.
815 SwitchInst *NewSI = SwitchInst::Create(CV, PredDefault,
816 PredCases.size(), PTI);
817 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
818 NewSI->addCase(PredCases[i].first, PredCases[i].second);
820 EraseTerminatorInstAndDCECond(PTI);
822 // Okay, last check. If BB is still a successor of PSI, then we must
823 // have an infinite loop case. If so, add an infinitely looping block
824 // to handle the case to preserve the behavior of the code.
825 BasicBlock *InfLoopBlock = 0;
826 for (unsigned i = 0, e = NewSI->getNumSuccessors(); i != e; ++i)
827 if (NewSI->getSuccessor(i) == BB) {
828 if (InfLoopBlock == 0) {
829 // Insert it at the end of the function, because it's either code,
830 // or it won't matter if it's hot. :)
831 InfLoopBlock = BasicBlock::Create("infloop", BB->getParent());
832 BranchInst::Create(InfLoopBlock, InfLoopBlock);
834 NewSI->setSuccessor(i, InfLoopBlock);
843 /// HoistThenElseCodeToIf - Given a conditional branch that goes to BB1 and
844 /// BB2, hoist any common code in the two blocks up into the branch block. The
845 /// caller of this function guarantees that BI's block dominates BB1 and BB2.
846 static bool HoistThenElseCodeToIf(BranchInst *BI) {
847 // This does very trivial matching, with limited scanning, to find identical
848 // instructions in the two blocks. In particular, we don't want to get into
849 // O(M*N) situations here where M and N are the sizes of BB1 and BB2. As
850 // such, we currently just scan for obviously identical instructions in an
852 BasicBlock *BB1 = BI->getSuccessor(0); // The true destination.
853 BasicBlock *BB2 = BI->getSuccessor(1); // The false destination
855 Instruction *I1 = BB1->begin(), *I2 = BB2->begin();
856 if (I1->getOpcode() != I2->getOpcode() || isa<PHINode>(I1) ||
857 isa<InvokeInst>(I1) || !I1->isIdenticalTo(I2))
860 // If we get here, we can hoist at least one instruction.
861 BasicBlock *BIParent = BI->getParent();
864 // If we are hoisting the terminator instruction, don't move one (making a
865 // broken BB), instead clone it, and remove BI.
866 if (isa<TerminatorInst>(I1))
867 goto HoistTerminator;
869 // For a normal instruction, we just move one to right before the branch,
870 // then replace all uses of the other with the first. Finally, we remove
871 // the now redundant second instruction.
872 BIParent->getInstList().splice(BI, BB1->getInstList(), I1);
873 if (!I2->use_empty())
874 I2->replaceAllUsesWith(I1);
875 BB2->getInstList().erase(I2);
879 } while (I1->getOpcode() == I2->getOpcode() && I1->isIdenticalTo(I2));
884 // Okay, it is safe to hoist the terminator.
885 Instruction *NT = I1->clone();
886 BIParent->getInstList().insert(BI, NT);
887 if (NT->getType() != Type::VoidTy) {
888 I1->replaceAllUsesWith(NT);
889 I2->replaceAllUsesWith(NT);
893 // Hoisting one of the terminators from our successor is a great thing.
894 // Unfortunately, the successors of the if/else blocks may have PHI nodes in
895 // them. If they do, all PHI entries for BB1/BB2 must agree for all PHI
896 // nodes, so we insert select instruction to compute the final result.
897 std::map<std::pair<Value*,Value*>, SelectInst*> InsertedSelects;
898 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
900 for (BasicBlock::iterator BBI = SI->begin();
901 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
902 Value *BB1V = PN->getIncomingValueForBlock(BB1);
903 Value *BB2V = PN->getIncomingValueForBlock(BB2);
905 // These values do not agree. Insert a select instruction before NT
906 // that determines the right value.
907 SelectInst *&SI = InsertedSelects[std::make_pair(BB1V, BB2V)];
909 SI = SelectInst::Create(BI->getCondition(), BB1V, BB2V,
910 BB1V->getName()+"."+BB2V->getName(), NT);
911 // Make the PHI node use the select for all incoming values for BB1/BB2
912 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
913 if (PN->getIncomingBlock(i) == BB1 || PN->getIncomingBlock(i) == BB2)
914 PN->setIncomingValue(i, SI);
919 // Update any PHI nodes in our new successors.
920 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI)
921 AddPredecessorToBlock(*SI, BIParent, BB1);
923 EraseTerminatorInstAndDCECond(BI);
927 /// SpeculativelyExecuteBB - Given a conditional branch that goes to BB1
928 /// and an BB2 and the only successor of BB1 is BB2, hoist simple code
929 /// (for now, restricted to a single instruction that's side effect free) from
930 /// the BB1 into the branch block to speculatively execute it.
931 static bool SpeculativelyExecuteBB(BranchInst *BI, BasicBlock *BB1) {
932 // Only speculatively execution a single instruction (not counting the
933 // terminator) for now.
934 BasicBlock::iterator BBI = BB1->begin();
935 ++BBI; // must have at least a terminator
936 if (BBI == BB1->end()) return false; // only one inst
938 if (BBI != BB1->end()) return false; // more than 2 insts.
940 // Be conservative for now. FP select instruction can often be expensive.
941 Value *BrCond = BI->getCondition();
942 if (isa<Instruction>(BrCond) &&
943 cast<Instruction>(BrCond)->getOpcode() == Instruction::FCmp)
946 // If BB1 is actually on the false edge of the conditional branch, remember
947 // to swap the select operands later.
949 if (BB1 != BI->getSuccessor(0)) {
950 assert(BB1 == BI->getSuccessor(1) && "No edge from 'if' block?");
957 // br i1 %t1, label %BB1, label %BB2
966 // %t3 = select i1 %t1, %t2, %t3
967 Instruction *I = BB1->begin();
968 switch (I->getOpcode()) {
969 default: return false; // Not safe / profitable to hoist.
970 case Instruction::Add:
971 case Instruction::Sub:
972 // FP arithmetic might trap. Not worth doing for vector ops.
973 if (I->getType()->isFloatingPoint() || isa<VectorType>(I->getType()))
976 case Instruction::And:
977 case Instruction::Or:
978 case Instruction::Xor:
979 case Instruction::Shl:
980 case Instruction::LShr:
981 case Instruction::AShr:
982 // Don't mess with vector operations.
983 if (isa<VectorType>(I->getType()))
985 break; // These are all cheap and non-trapping instructions.
988 // If the instruction is obviously dead, don't try to predicate it.
989 if (I->use_empty()) {
990 I->eraseFromParent();
994 // Can we speculatively execute the instruction? And what is the value
995 // if the condition is false? Consider the phi uses, if the incoming value
996 // from the "if" block are all the same V, then V is the value of the
997 // select if the condition is false.
998 BasicBlock *BIParent = BI->getParent();
999 SmallVector<PHINode*, 4> PHIUses;
1000 Value *FalseV = NULL;
1002 BasicBlock *BB2 = BB1->getTerminator()->getSuccessor(0);
1003 for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
1005 // Ignore any user that is not a PHI node in BB2. These can only occur in
1006 // unreachable blocks, because they would not be dominated by the instr.
1007 PHINode *PN = dyn_cast<PHINode>(UI);
1008 if (!PN || PN->getParent() != BB2)
1010 PHIUses.push_back(PN);
1012 Value *PHIV = PN->getIncomingValueForBlock(BIParent);
1015 else if (FalseV != PHIV)
1016 return false; // Inconsistent value when condition is false.
1019 assert(FalseV && "Must have at least one user, and it must be a PHI");
1021 // Do not hoist the instruction if any of its operands are defined but not
1022 // used in this BB. The transformation will prevent the operand from
1023 // being sunk into the use block.
1024 for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i) {
1025 Instruction *OpI = dyn_cast<Instruction>(*i);
1026 if (OpI && OpI->getParent() == BIParent &&
1027 !OpI->isUsedInBasicBlock(BIParent))
1031 // If we get here, we can hoist the instruction. Try to place it
1032 // before the icmp instruction preceeding the conditional branch.
1033 BasicBlock::iterator InsertPos = BI;
1034 if (InsertPos != BIParent->begin())
1036 if (InsertPos == BrCond && !isa<PHINode>(BrCond)) {
1037 SmallPtrSet<Instruction *, 4> BB1Insns;
1038 for(BasicBlock::iterator BB1I = BB1->begin(), BB1E = BB1->end();
1039 BB1I != BB1E; ++BB1I)
1040 BB1Insns.insert(BB1I);
1041 for(Value::use_iterator UI = BrCond->use_begin(), UE = BrCond->use_end();
1043 Instruction *Use = cast<Instruction>(*UI);
1044 if (BB1Insns.count(Use)) {
1045 // If BrCond uses the instruction that place it just before
1046 // branch instruction.
1053 BIParent->getInstList().splice(InsertPos, BB1->getInstList(), I);
1055 // Create a select whose true value is the speculatively executed value and
1056 // false value is the previously determined FalseV.
1059 SI = SelectInst::Create(BrCond, FalseV, I,
1060 FalseV->getName() + "." + I->getName(), BI);
1062 SI = SelectInst::Create(BrCond, I, FalseV,
1063 I->getName() + "." + FalseV->getName(), BI);
1065 // Make the PHI node use the select for all incoming values for "then" and
1067 for (unsigned i = 0, e = PHIUses.size(); i != e; ++i) {
1068 PHINode *PN = PHIUses[i];
1069 for (unsigned j = 0, ee = PN->getNumIncomingValues(); j != ee; ++j)
1070 if (PN->getIncomingBlock(j) == BB1 ||
1071 PN->getIncomingBlock(j) == BIParent)
1072 PN->setIncomingValue(j, SI);
1079 /// BlockIsSimpleEnoughToThreadThrough - Return true if we can thread a branch
1080 /// across this block.
1081 static bool BlockIsSimpleEnoughToThreadThrough(BasicBlock *BB) {
1082 BranchInst *BI = cast<BranchInst>(BB->getTerminator());
1085 // If this basic block contains anything other than a PHI (which controls the
1086 // branch) and branch itself, bail out. FIXME: improve this in the future.
1087 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI, ++Size) {
1088 if (Size > 10) return false; // Don't clone large BB's.
1090 // We can only support instructions that are do not define values that are
1091 // live outside of the current basic block.
1092 for (Value::use_iterator UI = BBI->use_begin(), E = BBI->use_end();
1094 Instruction *U = cast<Instruction>(*UI);
1095 if (U->getParent() != BB || isa<PHINode>(U)) return false;
1098 // Looks ok, continue checking.
1104 /// FoldCondBranchOnPHI - If we have a conditional branch on a PHI node value
1105 /// that is defined in the same block as the branch and if any PHI entries are
1106 /// constants, thread edges corresponding to that entry to be branches to their
1107 /// ultimate destination.
1108 static bool FoldCondBranchOnPHI(BranchInst *BI) {
1109 BasicBlock *BB = BI->getParent();
1110 PHINode *PN = dyn_cast<PHINode>(BI->getCondition());
1111 // NOTE: we currently cannot transform this case if the PHI node is used
1112 // outside of the block.
1113 if (!PN || PN->getParent() != BB || !PN->hasOneUse())
1116 // Degenerate case of a single entry PHI.
1117 if (PN->getNumIncomingValues() == 1) {
1118 FoldSingleEntryPHINodes(PN->getParent());
1122 // Now we know that this block has multiple preds and two succs.
1123 if (!BlockIsSimpleEnoughToThreadThrough(BB)) return false;
1125 // Okay, this is a simple enough basic block. See if any phi values are
1127 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1129 if ((CB = dyn_cast<ConstantInt>(PN->getIncomingValue(i))) &&
1130 CB->getType() == Type::Int1Ty) {
1131 // Okay, we now know that all edges from PredBB should be revectored to
1132 // branch to RealDest.
1133 BasicBlock *PredBB = PN->getIncomingBlock(i);
1134 BasicBlock *RealDest = BI->getSuccessor(!CB->getZExtValue());
1136 if (RealDest == BB) continue; // Skip self loops.
1138 // The dest block might have PHI nodes, other predecessors and other
1139 // difficult cases. Instead of being smart about this, just insert a new
1140 // block that jumps to the destination block, effectively splitting
1141 // the edge we are about to create.
1142 BasicBlock *EdgeBB = BasicBlock::Create(RealDest->getName()+".critedge",
1143 RealDest->getParent(), RealDest);
1144 BranchInst::Create(RealDest, EdgeBB);
1146 for (BasicBlock::iterator BBI = RealDest->begin();
1147 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1148 Value *V = PN->getIncomingValueForBlock(BB);
1149 PN->addIncoming(V, EdgeBB);
1152 // BB may have instructions that are being threaded over. Clone these
1153 // instructions into EdgeBB. We know that there will be no uses of the
1154 // cloned instructions outside of EdgeBB.
1155 BasicBlock::iterator InsertPt = EdgeBB->begin();
1156 std::map<Value*, Value*> TranslateMap; // Track translated values.
1157 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
1158 if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
1159 TranslateMap[PN] = PN->getIncomingValueForBlock(PredBB);
1161 // Clone the instruction.
1162 Instruction *N = BBI->clone();
1163 if (BBI->hasName()) N->setName(BBI->getName()+".c");
1165 // Update operands due to translation.
1166 for (User::op_iterator i = N->op_begin(), e = N->op_end();
1168 std::map<Value*, Value*>::iterator PI =
1169 TranslateMap.find(*i);
1170 if (PI != TranslateMap.end())
1174 // Check for trivial simplification.
1175 if (Constant *C = ConstantFoldInstruction(N)) {
1176 TranslateMap[BBI] = C;
1177 delete N; // Constant folded away, don't need actual inst
1179 // Insert the new instruction into its new home.
1180 EdgeBB->getInstList().insert(InsertPt, N);
1181 if (!BBI->use_empty())
1182 TranslateMap[BBI] = N;
1187 // Loop over all of the edges from PredBB to BB, changing them to branch
1188 // to EdgeBB instead.
1189 TerminatorInst *PredBBTI = PredBB->getTerminator();
1190 for (unsigned i = 0, e = PredBBTI->getNumSuccessors(); i != e; ++i)
1191 if (PredBBTI->getSuccessor(i) == BB) {
1192 BB->removePredecessor(PredBB);
1193 PredBBTI->setSuccessor(i, EdgeBB);
1196 // Recurse, simplifying any other constants.
1197 return FoldCondBranchOnPHI(BI) | true;
1204 /// FoldTwoEntryPHINode - Given a BB that starts with the specified two-entry
1205 /// PHI node, see if we can eliminate it.
1206 static bool FoldTwoEntryPHINode(PHINode *PN) {
1207 // Ok, this is a two entry PHI node. Check to see if this is a simple "if
1208 // statement", which has a very simple dominance structure. Basically, we
1209 // are trying to find the condition that is being branched on, which
1210 // subsequently causes this merge to happen. We really want control
1211 // dependence information for this check, but simplifycfg can't keep it up
1212 // to date, and this catches most of the cases we care about anyway.
1214 BasicBlock *BB = PN->getParent();
1215 BasicBlock *IfTrue, *IfFalse;
1216 Value *IfCond = GetIfCondition(BB, IfTrue, IfFalse);
1217 if (!IfCond) return false;
1219 // Okay, we found that we can merge this two-entry phi node into a select.
1220 // Doing so would require us to fold *all* two entry phi nodes in this block.
1221 // At some point this becomes non-profitable (particularly if the target
1222 // doesn't support cmov's). Only do this transformation if there are two or
1223 // fewer PHI nodes in this block.
1224 unsigned NumPhis = 0;
1225 for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++NumPhis, ++I)
1229 DOUT << "FOUND IF CONDITION! " << *IfCond << " T: "
1230 << IfTrue->getName() << " F: " << IfFalse->getName() << "\n";
1232 // Loop over the PHI's seeing if we can promote them all to select
1233 // instructions. While we are at it, keep track of the instructions
1234 // that need to be moved to the dominating block.
1235 std::set<Instruction*> AggressiveInsts;
1237 BasicBlock::iterator AfterPHIIt = BB->begin();
1238 while (isa<PHINode>(AfterPHIIt)) {
1239 PHINode *PN = cast<PHINode>(AfterPHIIt++);
1240 if (PN->getIncomingValue(0) == PN->getIncomingValue(1)) {
1241 if (PN->getIncomingValue(0) != PN)
1242 PN->replaceAllUsesWith(PN->getIncomingValue(0));
1244 PN->replaceAllUsesWith(UndefValue::get(PN->getType()));
1245 } else if (!DominatesMergePoint(PN->getIncomingValue(0), BB,
1246 &AggressiveInsts) ||
1247 !DominatesMergePoint(PN->getIncomingValue(1), BB,
1248 &AggressiveInsts)) {
1253 // If we all PHI nodes are promotable, check to make sure that all
1254 // instructions in the predecessor blocks can be promoted as well. If
1255 // not, we won't be able to get rid of the control flow, so it's not
1256 // worth promoting to select instructions.
1257 BasicBlock *DomBlock = 0, *IfBlock1 = 0, *IfBlock2 = 0;
1258 PN = cast<PHINode>(BB->begin());
1259 BasicBlock *Pred = PN->getIncomingBlock(0);
1260 if (cast<BranchInst>(Pred->getTerminator())->isUnconditional()) {
1262 DomBlock = *pred_begin(Pred);
1263 for (BasicBlock::iterator I = Pred->begin();
1264 !isa<TerminatorInst>(I); ++I)
1265 if (!AggressiveInsts.count(I)) {
1266 // This is not an aggressive instruction that we can promote.
1267 // Because of this, we won't be able to get rid of the control
1268 // flow, so the xform is not worth it.
1273 Pred = PN->getIncomingBlock(1);
1274 if (cast<BranchInst>(Pred->getTerminator())->isUnconditional()) {
1276 DomBlock = *pred_begin(Pred);
1277 for (BasicBlock::iterator I = Pred->begin();
1278 !isa<TerminatorInst>(I); ++I)
1279 if (!AggressiveInsts.count(I)) {
1280 // This is not an aggressive instruction that we can promote.
1281 // Because of this, we won't be able to get rid of the control
1282 // flow, so the xform is not worth it.
1287 // If we can still promote the PHI nodes after this gauntlet of tests,
1288 // do all of the PHI's now.
1290 // Move all 'aggressive' instructions, which are defined in the
1291 // conditional parts of the if's up to the dominating block.
1293 DomBlock->getInstList().splice(DomBlock->getTerminator(),
1294 IfBlock1->getInstList(),
1296 IfBlock1->getTerminator());
1299 DomBlock->getInstList().splice(DomBlock->getTerminator(),
1300 IfBlock2->getInstList(),
1302 IfBlock2->getTerminator());
1305 while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
1306 // Change the PHI node into a select instruction.
1308 PN->getIncomingValue(PN->getIncomingBlock(0) == IfFalse);
1310 PN->getIncomingValue(PN->getIncomingBlock(0) == IfTrue);
1312 Value *NV = SelectInst::Create(IfCond, TrueVal, FalseVal, "", AfterPHIIt);
1313 PN->replaceAllUsesWith(NV);
1316 BB->getInstList().erase(PN);
1321 /// SimplifyCondBranchToTwoReturns - If we found a conditional branch that goes
1322 /// to two returning blocks, try to merge them together into one return,
1323 /// introducing a select if the return values disagree.
1324 static bool SimplifyCondBranchToTwoReturns(BranchInst *BI) {
1325 assert(BI->isConditional() && "Must be a conditional branch");
1326 BasicBlock *TrueSucc = BI->getSuccessor(0);
1327 BasicBlock *FalseSucc = BI->getSuccessor(1);
1328 ReturnInst *TrueRet = cast<ReturnInst>(TrueSucc->getTerminator());
1329 ReturnInst *FalseRet = cast<ReturnInst>(FalseSucc->getTerminator());
1331 // Check to ensure both blocks are empty (just a return) or optionally empty
1332 // with PHI nodes. If there are other instructions, merging would cause extra
1333 // computation on one path or the other.
1334 BasicBlock::iterator BBI = TrueRet;
1335 if (BBI != TrueSucc->begin() && !isa<PHINode>(--BBI))
1336 return false; // Not empty with optional phi nodes.
1338 if (BBI != FalseSucc->begin() && !isa<PHINode>(--BBI))
1339 return false; // Not empty with optional phi nodes.
1341 // Okay, we found a branch that is going to two return nodes. If
1342 // there is no return value for this function, just change the
1343 // branch into a return.
1344 if (FalseRet->getNumOperands() == 0) {
1345 TrueSucc->removePredecessor(BI->getParent());
1346 FalseSucc->removePredecessor(BI->getParent());
1347 ReturnInst::Create(0, BI);
1348 EraseTerminatorInstAndDCECond(BI);
1352 // Otherwise, figure out what the true and false return values are
1353 // so we can insert a new select instruction.
1354 Value *TrueValue = TrueRet->getReturnValue();
1355 Value *FalseValue = FalseRet->getReturnValue();
1357 // Unwrap any PHI nodes in the return blocks.
1358 if (PHINode *TVPN = dyn_cast_or_null<PHINode>(TrueValue))
1359 if (TVPN->getParent() == TrueSucc)
1360 TrueValue = TVPN->getIncomingValueForBlock(BI->getParent());
1361 if (PHINode *FVPN = dyn_cast_or_null<PHINode>(FalseValue))
1362 if (FVPN->getParent() == FalseSucc)
1363 FalseValue = FVPN->getIncomingValueForBlock(BI->getParent());
1365 // In order for this transformation to be safe, we must be able to
1366 // unconditionally execute both operands to the return. This is
1367 // normally the case, but we could have a potentially-trapping
1368 // constant expression that prevents this transformation from being
1370 if (ConstantExpr *TCV = dyn_cast_or_null<ConstantExpr>(TrueValue))
1373 if (ConstantExpr *FCV = dyn_cast_or_null<ConstantExpr>(FalseValue))
1377 // Okay, we collected all the mapped values and checked them for sanity, and
1378 // defined to really do this transformation. First, update the CFG.
1379 TrueSucc->removePredecessor(BI->getParent());
1380 FalseSucc->removePredecessor(BI->getParent());
1382 // Insert select instructions where needed.
1383 Value *BrCond = BI->getCondition();
1385 // Insert a select if the results differ.
1386 if (TrueValue == FalseValue || isa<UndefValue>(FalseValue)) {
1387 } else if (isa<UndefValue>(TrueValue)) {
1388 TrueValue = FalseValue;
1390 TrueValue = SelectInst::Create(BrCond, TrueValue,
1391 FalseValue, "retval", BI);
1395 Value *RI = !TrueValue ?
1396 ReturnInst::Create(BI) :
1397 ReturnInst::Create(TrueValue, BI);
1399 DOUT << "\nCHANGING BRANCH TO TWO RETURNS INTO SELECT:"
1400 << "\n " << *BI << "NewRet = " << *RI
1401 << "TRUEBLOCK: " << *TrueSucc << "FALSEBLOCK: "<< *FalseSucc;
1403 EraseTerminatorInstAndDCECond(BI);
1408 /// FoldBranchToCommonDest - If this basic block is ONLY a setcc and a branch,
1409 /// and if a predecessor branches to us and one of our successors, fold the
1410 /// setcc into the predecessor and use logical operations to pick the right
1412 static bool FoldBranchToCommonDest(BranchInst *BI) {
1413 BasicBlock *BB = BI->getParent();
1414 Instruction *Cond = dyn_cast<Instruction>(BI->getCondition());
1415 if (Cond == 0) return false;
1418 // Only allow this if the condition is a simple instruction that can be
1419 // executed unconditionally. It must be in the same block as the branch, and
1420 // must be at the front of the block.
1421 if ((!isa<CmpInst>(Cond) && !isa<BinaryOperator>(Cond)) ||
1422 Cond->getParent() != BB || &BB->front() != Cond || !Cond->hasOneUse())
1425 // Make sure the instruction after the condition is the cond branch.
1426 BasicBlock::iterator CondIt = Cond; ++CondIt;
1430 // Cond is known to be a compare or binary operator. Check to make sure that
1431 // neither operand is a potentially-trapping constant expression.
1432 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(0)))
1435 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(1)))
1440 // Finally, don't infinitely unroll conditional loops.
1441 BasicBlock *TrueDest = BI->getSuccessor(0);
1442 BasicBlock *FalseDest = BI->getSuccessor(1);
1443 if (TrueDest == BB || FalseDest == BB)
1446 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
1447 BasicBlock *PredBlock = *PI;
1448 BranchInst *PBI = dyn_cast<BranchInst>(PredBlock->getTerminator());
1450 // Check that we have two conditional branches. If there is a PHI node in
1451 // the common successor, verify that the same value flows in from both
1453 if (PBI == 0 || PBI->isUnconditional() ||
1454 !SafeToMergeTerminators(BI, PBI))
1457 Instruction::BinaryOps Opc;
1458 bool InvertPredCond = false;
1460 if (PBI->getSuccessor(0) == TrueDest)
1461 Opc = Instruction::Or;
1462 else if (PBI->getSuccessor(1) == FalseDest)
1463 Opc = Instruction::And;
1464 else if (PBI->getSuccessor(0) == FalseDest)
1465 Opc = Instruction::And, InvertPredCond = true;
1466 else if (PBI->getSuccessor(1) == TrueDest)
1467 Opc = Instruction::Or, InvertPredCond = true;
1471 DOUT << "FOLDING BRANCH TO COMMON DEST:\n" << *PBI << *BB;
1473 // If we need to invert the condition in the pred block to match, do so now.
1474 if (InvertPredCond) {
1476 BinaryOperator::CreateNot(PBI->getCondition(),
1477 PBI->getCondition()->getName()+".not", PBI);
1478 PBI->setCondition(NewCond);
1479 BasicBlock *OldTrue = PBI->getSuccessor(0);
1480 BasicBlock *OldFalse = PBI->getSuccessor(1);
1481 PBI->setSuccessor(0, OldFalse);
1482 PBI->setSuccessor(1, OldTrue);
1485 // Clone Cond into the predecessor basic block, and or/and the
1486 // two conditions together.
1487 Instruction *New = Cond->clone();
1488 PredBlock->getInstList().insert(PBI, New);
1489 New->takeName(Cond);
1490 Cond->setName(New->getName()+".old");
1492 Value *NewCond = BinaryOperator::Create(Opc, PBI->getCondition(),
1493 New, "or.cond", PBI);
1494 PBI->setCondition(NewCond);
1495 if (PBI->getSuccessor(0) == BB) {
1496 AddPredecessorToBlock(TrueDest, PredBlock, BB);
1497 PBI->setSuccessor(0, TrueDest);
1499 if (PBI->getSuccessor(1) == BB) {
1500 AddPredecessorToBlock(FalseDest, PredBlock, BB);
1501 PBI->setSuccessor(1, FalseDest);
1508 /// SimplifyCondBranchToCondBranch - If we have a conditional branch as a
1509 /// predecessor of another block, this function tries to simplify it. We know
1510 /// that PBI and BI are both conditional branches, and BI is in one of the
1511 /// successor blocks of PBI - PBI branches to BI.
1512 static bool SimplifyCondBranchToCondBranch(BranchInst *PBI, BranchInst *BI) {
1513 assert(PBI->isConditional() && BI->isConditional());
1514 BasicBlock *BB = BI->getParent();
1516 // If this block ends with a branch instruction, and if there is a
1517 // predecessor that ends on a branch of the same condition, make
1518 // this conditional branch redundant.
1519 if (PBI->getCondition() == BI->getCondition() &&
1520 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
1521 // Okay, the outcome of this conditional branch is statically
1522 // knowable. If this block had a single pred, handle specially.
1523 if (BB->getSinglePredecessor()) {
1524 // Turn this into a branch on constant.
1525 bool CondIsTrue = PBI->getSuccessor(0) == BB;
1526 BI->setCondition(ConstantInt::get(Type::Int1Ty, CondIsTrue));
1527 return true; // Nuke the branch on constant.
1530 // Otherwise, if there are multiple predecessors, insert a PHI that merges
1531 // in the constant and simplify the block result. Subsequent passes of
1532 // simplifycfg will thread the block.
1533 if (BlockIsSimpleEnoughToThreadThrough(BB)) {
1534 PHINode *NewPN = PHINode::Create(Type::Int1Ty,
1535 BI->getCondition()->getName() + ".pr",
1537 // Okay, we're going to insert the PHI node. Since PBI is not the only
1538 // predecessor, compute the PHI'd conditional value for all of the preds.
1539 // Any predecessor where the condition is not computable we keep symbolic.
1540 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
1541 if ((PBI = dyn_cast<BranchInst>((*PI)->getTerminator())) &&
1542 PBI != BI && PBI->isConditional() &&
1543 PBI->getCondition() == BI->getCondition() &&
1544 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
1545 bool CondIsTrue = PBI->getSuccessor(0) == BB;
1546 NewPN->addIncoming(ConstantInt::get(Type::Int1Ty,
1549 NewPN->addIncoming(BI->getCondition(), *PI);
1552 BI->setCondition(NewPN);
1557 // If this is a conditional branch in an empty block, and if any
1558 // predecessors is a conditional branch to one of our destinations,
1559 // fold the conditions into logical ops and one cond br.
1560 if (&BB->front() != BI)
1564 if (PBI->getSuccessor(0) == BI->getSuccessor(0))
1566 else if (PBI->getSuccessor(0) == BI->getSuccessor(1))
1567 PBIOp = 0, BIOp = 1;
1568 else if (PBI->getSuccessor(1) == BI->getSuccessor(0))
1569 PBIOp = 1, BIOp = 0;
1570 else if (PBI->getSuccessor(1) == BI->getSuccessor(1))
1575 // Check to make sure that the other destination of this branch
1576 // isn't BB itself. If so, this is an infinite loop that will
1577 // keep getting unwound.
1578 if (PBI->getSuccessor(PBIOp) == BB)
1581 // Do not perform this transformation if it would require
1582 // insertion of a large number of select instructions. For targets
1583 // without predication/cmovs, this is a big pessimization.
1584 BasicBlock *CommonDest = PBI->getSuccessor(PBIOp);
1586 unsigned NumPhis = 0;
1587 for (BasicBlock::iterator II = CommonDest->begin();
1588 isa<PHINode>(II); ++II, ++NumPhis)
1589 if (NumPhis > 2) // Disable this xform.
1592 // Finally, if everything is ok, fold the branches to logical ops.
1593 BasicBlock *OtherDest = BI->getSuccessor(BIOp ^ 1);
1595 DOUT << "FOLDING BRs:" << *PBI->getParent()
1596 << "AND: " << *BI->getParent();
1599 // If OtherDest *is* BB, then BB is a basic block with a single conditional
1600 // branch in it, where one edge (OtherDest) goes back to itself but the other
1601 // exits. We don't *know* that the program avoids the infinite loop
1602 // (even though that seems likely). If we do this xform naively, we'll end up
1603 // recursively unpeeling the loop. Since we know that (after the xform is
1604 // done) that the block *is* infinite if reached, we just make it an obviously
1605 // infinite loop with no cond branch.
1606 if (OtherDest == BB) {
1607 // Insert it at the end of the function, because it's either code,
1608 // or it won't matter if it's hot. :)
1609 BasicBlock *InfLoopBlock = BasicBlock::Create("infloop", BB->getParent());
1610 BranchInst::Create(InfLoopBlock, InfLoopBlock);
1611 OtherDest = InfLoopBlock;
1614 DOUT << *PBI->getParent()->getParent();
1616 // BI may have other predecessors. Because of this, we leave
1617 // it alone, but modify PBI.
1619 // Make sure we get to CommonDest on True&True directions.
1620 Value *PBICond = PBI->getCondition();
1622 PBICond = BinaryOperator::CreateNot(PBICond,
1623 PBICond->getName()+".not",
1625 Value *BICond = BI->getCondition();
1627 BICond = BinaryOperator::CreateNot(BICond,
1628 BICond->getName()+".not",
1630 // Merge the conditions.
1631 Value *Cond = BinaryOperator::CreateOr(PBICond, BICond, "brmerge", PBI);
1633 // Modify PBI to branch on the new condition to the new dests.
1634 PBI->setCondition(Cond);
1635 PBI->setSuccessor(0, CommonDest);
1636 PBI->setSuccessor(1, OtherDest);
1638 // OtherDest may have phi nodes. If so, add an entry from PBI's
1639 // block that are identical to the entries for BI's block.
1641 for (BasicBlock::iterator II = OtherDest->begin();
1642 (PN = dyn_cast<PHINode>(II)); ++II) {
1643 Value *V = PN->getIncomingValueForBlock(BB);
1644 PN->addIncoming(V, PBI->getParent());
1647 // We know that the CommonDest already had an edge from PBI to
1648 // it. If it has PHIs though, the PHIs may have different
1649 // entries for BB and PBI's BB. If so, insert a select to make
1651 for (BasicBlock::iterator II = CommonDest->begin();
1652 (PN = dyn_cast<PHINode>(II)); ++II) {
1653 Value *BIV = PN->getIncomingValueForBlock(BB);
1654 unsigned PBBIdx = PN->getBasicBlockIndex(PBI->getParent());
1655 Value *PBIV = PN->getIncomingValue(PBBIdx);
1657 // Insert a select in PBI to pick the right value.
1658 Value *NV = SelectInst::Create(PBICond, PBIV, BIV,
1659 PBIV->getName()+".mux", PBI);
1660 PN->setIncomingValue(PBBIdx, NV);
1664 DOUT << "INTO: " << *PBI->getParent();
1666 DOUT << *PBI->getParent()->getParent();
1668 // This basic block is probably dead. We know it has at least
1669 // one fewer predecessor.
1675 /// ConstantIntOrdering - This class implements a stable ordering of constant
1676 /// integers that does not depend on their address. This is important for
1677 /// applications that sort ConstantInt's to ensure uniqueness.
1678 struct ConstantIntOrdering {
1679 bool operator()(const ConstantInt *LHS, const ConstantInt *RHS) const {
1680 return LHS->getValue().ult(RHS->getValue());
1685 /// SimplifyCFG - This function is used to do simplification of a CFG. For
1686 /// example, it adjusts branches to branches to eliminate the extra hop, it
1687 /// eliminates unreachable basic blocks, and does other "peephole" optimization
1688 /// of the CFG. It returns true if a modification was made.
1690 /// WARNING: The entry node of a function may not be simplified.
1692 bool llvm::SimplifyCFG(BasicBlock *BB) {
1693 bool Changed = false;
1694 Function *M = BB->getParent();
1696 assert(BB && BB->getParent() && "Block not embedded in function!");
1697 assert(BB->getTerminator() && "Degenerate basic block encountered!");
1698 assert(&BB->getParent()->getEntryBlock() != BB &&
1699 "Can't Simplify entry block!");
1701 // Remove basic blocks that have no predecessors... or that just have themself
1702 // as a predecessor. These are unreachable.
1703 if (pred_begin(BB) == pred_end(BB) || BB->getSinglePredecessor() == BB) {
1704 DOUT << "Removing BB: \n" << *BB;
1705 DeleteDeadBlock(BB);
1709 // Check to see if we can constant propagate this terminator instruction
1711 Changed |= ConstantFoldTerminator(BB);
1713 // If there is a trivial two-entry PHI node in this basic block, and we can
1714 // eliminate it, do so now.
1715 if (PHINode *PN = dyn_cast<PHINode>(BB->begin()))
1716 if (PN->getNumIncomingValues() == 2)
1717 Changed |= FoldTwoEntryPHINode(PN);
1719 // If this is a returning block with only PHI nodes in it, fold the return
1720 // instruction into any unconditional branch predecessors.
1722 // If any predecessor is a conditional branch that just selects among
1723 // different return values, fold the replace the branch/return with a select
1725 if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
1726 BasicBlock::iterator BBI = BB->getTerminator();
1727 if (BBI == BB->begin() || isa<PHINode>(--BBI)) {
1728 // Find predecessors that end with branches.
1729 SmallVector<BasicBlock*, 8> UncondBranchPreds;
1730 SmallVector<BranchInst*, 8> CondBranchPreds;
1731 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
1732 TerminatorInst *PTI = (*PI)->getTerminator();
1733 if (BranchInst *BI = dyn_cast<BranchInst>(PTI)) {
1734 if (BI->isUnconditional())
1735 UncondBranchPreds.push_back(*PI);
1737 CondBranchPreds.push_back(BI);
1741 // If we found some, do the transformation!
1742 if (!UncondBranchPreds.empty()) {
1743 while (!UncondBranchPreds.empty()) {
1744 BasicBlock *Pred = UncondBranchPreds.back();
1745 DOUT << "FOLDING: " << *BB
1746 << "INTO UNCOND BRANCH PRED: " << *Pred;
1747 UncondBranchPreds.pop_back();
1748 Instruction *UncondBranch = Pred->getTerminator();
1749 // Clone the return and add it to the end of the predecessor.
1750 Instruction *NewRet = RI->clone();
1751 Pred->getInstList().push_back(NewRet);
1753 // If the return instruction returns a value, and if the value was a
1754 // PHI node in "BB", propagate the right value into the return.
1755 for (User::op_iterator i = NewRet->op_begin(), e = NewRet->op_end();
1757 if (PHINode *PN = dyn_cast<PHINode>(*i))
1758 if (PN->getParent() == BB)
1759 *i = PN->getIncomingValueForBlock(Pred);
1761 // Update any PHI nodes in the returning block to realize that we no
1762 // longer branch to them.
1763 BB->removePredecessor(Pred);
1764 Pred->getInstList().erase(UncondBranch);
1767 // If we eliminated all predecessors of the block, delete the block now.
1768 if (pred_begin(BB) == pred_end(BB))
1769 // We know there are no successors, so just nuke the block.
1770 M->getBasicBlockList().erase(BB);
1775 // Check out all of the conditional branches going to this return
1776 // instruction. If any of them just select between returns, change the
1777 // branch itself into a select/return pair.
1778 while (!CondBranchPreds.empty()) {
1779 BranchInst *BI = CondBranchPreds.back();
1780 CondBranchPreds.pop_back();
1782 // Check to see if the non-BB successor is also a return block.
1783 if (isa<ReturnInst>(BI->getSuccessor(0)->getTerminator()) &&
1784 isa<ReturnInst>(BI->getSuccessor(1)->getTerminator()) &&
1785 SimplifyCondBranchToTwoReturns(BI))
1789 } else if (isa<UnwindInst>(BB->begin())) {
1790 // Check to see if the first instruction in this block is just an unwind.
1791 // If so, replace any invoke instructions which use this as an exception
1792 // destination with call instructions, and any unconditional branch
1793 // predecessor with an unwind.
1795 SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
1796 while (!Preds.empty()) {
1797 BasicBlock *Pred = Preds.back();
1798 if (BranchInst *BI = dyn_cast<BranchInst>(Pred->getTerminator())) {
1799 if (BI->isUnconditional()) {
1800 Pred->getInstList().pop_back(); // nuke uncond branch
1801 new UnwindInst(Pred); // Use unwind.
1804 } else if (InvokeInst *II = dyn_cast<InvokeInst>(Pred->getTerminator()))
1805 if (II->getUnwindDest() == BB) {
1806 // Insert a new branch instruction before the invoke, because this
1807 // is now a fall through...
1808 BranchInst *BI = BranchInst::Create(II->getNormalDest(), II);
1809 Pred->getInstList().remove(II); // Take out of symbol table
1811 // Insert the call now...
1812 SmallVector<Value*,8> Args(II->op_begin()+3, II->op_end());
1813 CallInst *CI = CallInst::Create(II->getCalledValue(),
1814 Args.begin(), Args.end(),
1816 CI->setCallingConv(II->getCallingConv());
1817 CI->setAttributes(II->getAttributes());
1818 // If the invoke produced a value, the Call now does instead
1819 II->replaceAllUsesWith(CI);
1827 // If this block is now dead, remove it.
1828 if (pred_begin(BB) == pred_end(BB)) {
1829 // We know there are no successors, so just nuke the block.
1830 M->getBasicBlockList().erase(BB);
1834 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
1835 if (isValueEqualityComparison(SI)) {
1836 // If we only have one predecessor, and if it is a branch on this value,
1837 // see if that predecessor totally determines the outcome of this switch.
1838 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
1839 if (SimplifyEqualityComparisonWithOnlyPredecessor(SI, OnlyPred))
1840 return SimplifyCFG(BB) || 1;
1842 // If the block only contains the switch, see if we can fold the block
1843 // away into any preds.
1844 if (SI == &BB->front())
1845 if (FoldValueComparisonIntoPredecessors(SI))
1846 return SimplifyCFG(BB) || 1;
1848 } else if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
1849 if (BI->isUnconditional()) {
1850 BasicBlock::iterator BBI = BB->getFirstNonPHI();
1852 BasicBlock *Succ = BI->getSuccessor(0);
1853 if (BBI->isTerminator() && // Terminator is the only non-phi instruction!
1854 Succ != BB) // Don't hurt infinite loops!
1855 if (TryToSimplifyUncondBranchFromEmptyBlock(BB, Succ))
1858 } else { // Conditional branch
1859 if (isValueEqualityComparison(BI)) {
1860 // If we only have one predecessor, and if it is a branch on this value,
1861 // see if that predecessor totally determines the outcome of this
1863 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
1864 if (SimplifyEqualityComparisonWithOnlyPredecessor(BI, OnlyPred))
1865 return SimplifyCFG(BB) || 1;
1867 // This block must be empty, except for the setcond inst, if it exists.
1868 BasicBlock::iterator I = BB->begin();
1870 (&*I == cast<Instruction>(BI->getCondition()) &&
1872 if (FoldValueComparisonIntoPredecessors(BI))
1873 return SimplifyCFG(BB) | true;
1876 // If this is a branch on a phi node in the current block, thread control
1877 // through this block if any PHI node entries are constants.
1878 if (PHINode *PN = dyn_cast<PHINode>(BI->getCondition()))
1879 if (PN->getParent() == BI->getParent())
1880 if (FoldCondBranchOnPHI(BI))
1881 return SimplifyCFG(BB) | true;
1883 // If this basic block is ONLY a setcc and a branch, and if a predecessor
1884 // branches to us and one of our successors, fold the setcc into the
1885 // predecessor and use logical operations to pick the right destination.
1886 if (FoldBranchToCommonDest(BI))
1887 return SimplifyCFG(BB) | 1;
1890 // Scan predecessor blocks for conditional branches.
1891 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
1892 if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
1893 if (PBI != BI && PBI->isConditional())
1894 if (SimplifyCondBranchToCondBranch(PBI, BI))
1895 return SimplifyCFG(BB) | true;
1897 } else if (isa<UnreachableInst>(BB->getTerminator())) {
1898 // If there are any instructions immediately before the unreachable that can
1899 // be removed, do so.
1900 Instruction *Unreachable = BB->getTerminator();
1901 while (Unreachable != BB->begin()) {
1902 BasicBlock::iterator BBI = Unreachable;
1904 // Do not delete instructions that can have side effects, like calls
1905 // (which may never return) and volatile loads and stores.
1906 if (isa<CallInst>(BBI)) break;
1908 if (StoreInst *SI = dyn_cast<StoreInst>(BBI))
1909 if (SI->isVolatile())
1912 if (LoadInst *LI = dyn_cast<LoadInst>(BBI))
1913 if (LI->isVolatile())
1916 // Delete this instruction
1917 BB->getInstList().erase(BBI);
1921 // If the unreachable instruction is the first in the block, take a gander
1922 // at all of the predecessors of this instruction, and simplify them.
1923 if (&BB->front() == Unreachable) {
1924 SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
1925 for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
1926 TerminatorInst *TI = Preds[i]->getTerminator();
1928 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
1929 if (BI->isUnconditional()) {
1930 if (BI->getSuccessor(0) == BB) {
1931 new UnreachableInst(TI);
1932 TI->eraseFromParent();
1936 if (BI->getSuccessor(0) == BB) {
1937 BranchInst::Create(BI->getSuccessor(1), BI);
1938 EraseTerminatorInstAndDCECond(BI);
1939 } else if (BI->getSuccessor(1) == BB) {
1940 BranchInst::Create(BI->getSuccessor(0), BI);
1941 EraseTerminatorInstAndDCECond(BI);
1945 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
1946 for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
1947 if (SI->getSuccessor(i) == BB) {
1948 BB->removePredecessor(SI->getParent());
1953 // If the default value is unreachable, figure out the most popular
1954 // destination and make it the default.
1955 if (SI->getSuccessor(0) == BB) {
1956 std::map<BasicBlock*, unsigned> Popularity;
1957 for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
1958 Popularity[SI->getSuccessor(i)]++;
1960 // Find the most popular block.
1961 unsigned MaxPop = 0;
1962 BasicBlock *MaxBlock = 0;
1963 for (std::map<BasicBlock*, unsigned>::iterator
1964 I = Popularity.begin(), E = Popularity.end(); I != E; ++I) {
1965 if (I->second > MaxPop) {
1967 MaxBlock = I->first;
1971 // Make this the new default, allowing us to delete any explicit
1973 SI->setSuccessor(0, MaxBlock);
1976 // If MaxBlock has phinodes in it, remove MaxPop-1 entries from
1978 if (isa<PHINode>(MaxBlock->begin()))
1979 for (unsigned i = 0; i != MaxPop-1; ++i)
1980 MaxBlock->removePredecessor(SI->getParent());
1982 for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
1983 if (SI->getSuccessor(i) == MaxBlock) {
1989 } else if (InvokeInst *II = dyn_cast<InvokeInst>(TI)) {
1990 if (II->getUnwindDest() == BB) {
1991 // Convert the invoke to a call instruction. This would be a good
1992 // place to note that the call does not throw though.
1993 BranchInst *BI = BranchInst::Create(II->getNormalDest(), II);
1994 II->removeFromParent(); // Take out of symbol table
1996 // Insert the call now...
1997 SmallVector<Value*, 8> Args(II->op_begin()+3, II->op_end());
1998 CallInst *CI = CallInst::Create(II->getCalledValue(),
1999 Args.begin(), Args.end(),
2001 CI->setCallingConv(II->getCallingConv());
2002 CI->setAttributes(II->getAttributes());
2003 // If the invoke produced a value, the Call does now instead.
2004 II->replaceAllUsesWith(CI);
2011 // If this block is now dead, remove it.
2012 if (pred_begin(BB) == pred_end(BB)) {
2013 // We know there are no successors, so just nuke the block.
2014 M->getBasicBlockList().erase(BB);
2020 // Merge basic blocks into their predecessor if there is only one distinct
2021 // pred, and if there is only one distinct successor of the predecessor, and
2022 // if there are no PHI nodes.
2024 if (MergeBlockIntoPredecessor(BB))
2027 // Otherwise, if this block only has a single predecessor, and if that block
2028 // is a conditional branch, see if we can hoist any code from this block up
2029 // into our predecessor.
2030 pred_iterator PI(pred_begin(BB)), PE(pred_end(BB));
2031 BasicBlock *OnlyPred = *PI++;
2032 for (; PI != PE; ++PI) // Search all predecessors, see if they are all same
2033 if (*PI != OnlyPred) {
2034 OnlyPred = 0; // There are multiple different predecessors...
2039 if (BranchInst *BI = dyn_cast<BranchInst>(OnlyPred->getTerminator()))
2040 if (BI->isConditional()) {
2041 // Get the other block.
2042 BasicBlock *OtherBB = BI->getSuccessor(BI->getSuccessor(0) == BB);
2043 PI = pred_begin(OtherBB);
2046 if (PI == pred_end(OtherBB)) {
2047 // We have a conditional branch to two blocks that are only reachable
2048 // from the condbr. We know that the condbr dominates the two blocks,
2049 // so see if there is any identical code in the "then" and "else"
2050 // blocks. If so, we can hoist it up to the branching block.
2051 Changed |= HoistThenElseCodeToIf(BI);
2053 BasicBlock* OnlySucc = NULL;
2054 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB);
2058 else if (*SI != OnlySucc) {
2059 OnlySucc = 0; // There are multiple distinct successors!
2064 if (OnlySucc == OtherBB) {
2065 // If BB's only successor is the other successor of the predecessor,
2066 // i.e. a triangle, see if we can hoist any code from this block up
2067 // to the "if" block.
2068 Changed |= SpeculativelyExecuteBB(BI, BB);
2073 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
2074 if (BranchInst *BI = dyn_cast<BranchInst>((*PI)->getTerminator()))
2075 // Change br (X == 0 | X == 1), T, F into a switch instruction.
2076 if (BI->isConditional() && isa<Instruction>(BI->getCondition())) {
2077 Instruction *Cond = cast<Instruction>(BI->getCondition());
2078 // If this is a bunch of seteq's or'd together, or if it's a bunch of
2079 // 'setne's and'ed together, collect them.
2081 std::vector<ConstantInt*> Values;
2082 bool TrueWhenEqual = GatherValueComparisons(Cond, CompVal, Values);
2083 if (CompVal && CompVal->getType()->isInteger()) {
2084 // There might be duplicate constants in the list, which the switch
2085 // instruction can't handle, remove them now.
2086 std::sort(Values.begin(), Values.end(), ConstantIntOrdering());
2087 Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
2089 // Figure out which block is which destination.
2090 BasicBlock *DefaultBB = BI->getSuccessor(1);
2091 BasicBlock *EdgeBB = BI->getSuccessor(0);
2092 if (!TrueWhenEqual) std::swap(DefaultBB, EdgeBB);
2094 // Create the new switch instruction now.
2095 SwitchInst *New = SwitchInst::Create(CompVal, DefaultBB,
2098 // Add all of the 'cases' to the switch instruction.
2099 for (unsigned i = 0, e = Values.size(); i != e; ++i)
2100 New->addCase(Values[i], EdgeBB);
2102 // We added edges from PI to the EdgeBB. As such, if there were any
2103 // PHI nodes in EdgeBB, they need entries to be added corresponding to
2104 // the number of edges added.
2105 for (BasicBlock::iterator BBI = EdgeBB->begin();
2106 isa<PHINode>(BBI); ++BBI) {
2107 PHINode *PN = cast<PHINode>(BBI);
2108 Value *InVal = PN->getIncomingValueForBlock(*PI);
2109 for (unsigned i = 0, e = Values.size()-1; i != e; ++i)
2110 PN->addIncoming(InVal, *PI);
2113 // Erase the old branch instruction.
2114 EraseTerminatorInstAndDCECond(BI);