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 // If we have a merge point of an "if condition" as accepted above, return true
351 // if the specified value dominates the block. We don't handle the true
352 // generality of domination here, just a special case which works well enough
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 and
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))
479 /// GatherValueComparisons - If the specified Cond is an 'and' or 'or' of a
480 /// bunch of comparisons of one value against constants, return the value and
481 /// the constants being compared.
482 static bool GatherValueComparisons(Instruction *Cond, Value *&CompVal,
483 std::vector<ConstantInt*> &Values) {
484 if (Cond->getOpcode() == Instruction::Or) {
485 CompVal = GatherConstantSetEQs(Cond, Values);
487 // Return true to indicate that the condition is true if the CompVal is
488 // equal to one of the constants.
490 } else if (Cond->getOpcode() == Instruction::And) {
491 CompVal = GatherConstantSetNEs(Cond, Values);
493 // Return false to indicate that the condition is false if the CompVal is
494 // equal to one of the constants.
500 static void EraseTerminatorInstAndDCECond(TerminatorInst *TI) {
501 Instruction* Cond = 0;
502 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
503 Cond = dyn_cast<Instruction>(SI->getCondition());
504 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
505 if (BI->isConditional())
506 Cond = dyn_cast<Instruction>(BI->getCondition());
509 TI->eraseFromParent();
510 if (Cond) RecursivelyDeleteTriviallyDeadInstructions(Cond);
513 /// isValueEqualityComparison - Return true if the specified terminator checks
514 /// to see if a value is equal to constant integer value.
515 static Value *isValueEqualityComparison(TerminatorInst *TI) {
516 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
517 // Do not permit merging of large switch instructions into their
518 // predecessors unless there is only one predecessor.
519 if (SI->getNumSuccessors() * std::distance(pred_begin(SI->getParent()),
520 pred_end(SI->getParent())) > 128)
523 return SI->getCondition();
525 if (BranchInst *BI = dyn_cast<BranchInst>(TI))
526 if (BI->isConditional() && BI->getCondition()->hasOneUse())
527 if (ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition()))
528 if ((ICI->getPredicate() == ICmpInst::ICMP_EQ ||
529 ICI->getPredicate() == ICmpInst::ICMP_NE) &&
530 isa<ConstantInt>(ICI->getOperand(1)))
531 return ICI->getOperand(0);
535 /// Given a value comparison instruction, decode all of the 'cases' that it
536 /// represents and return the 'default' block.
538 GetValueEqualityComparisonCases(TerminatorInst *TI,
539 std::vector<std::pair<ConstantInt*,
540 BasicBlock*> > &Cases) {
541 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
542 Cases.reserve(SI->getNumCases());
543 for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
544 Cases.push_back(std::make_pair(SI->getCaseValue(i), SI->getSuccessor(i)));
545 return SI->getDefaultDest();
548 BranchInst *BI = cast<BranchInst>(TI);
549 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
550 Cases.push_back(std::make_pair(cast<ConstantInt>(ICI->getOperand(1)),
551 BI->getSuccessor(ICI->getPredicate() ==
552 ICmpInst::ICMP_NE)));
553 return BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_EQ);
557 // EliminateBlockCases - Given a vector of bb/value pairs, remove any entries
558 // in the list that match the specified block.
559 static void EliminateBlockCases(BasicBlock *BB,
560 std::vector<std::pair<ConstantInt*, BasicBlock*> > &Cases) {
561 for (unsigned i = 0, e = Cases.size(); i != e; ++i)
562 if (Cases[i].second == BB) {
563 Cases.erase(Cases.begin()+i);
568 // ValuesOverlap - Return true if there are any keys in C1 that exist in C2 as
571 ValuesOverlap(std::vector<std::pair<ConstantInt*, BasicBlock*> > &C1,
572 std::vector<std::pair<ConstantInt*, BasicBlock*> > &C2) {
573 std::vector<std::pair<ConstantInt*, BasicBlock*> > *V1 = &C1, *V2 = &C2;
575 // Make V1 be smaller than V2.
576 if (V1->size() > V2->size())
579 if (V1->size() == 0) return false;
580 if (V1->size() == 1) {
582 ConstantInt *TheVal = (*V1)[0].first;
583 for (unsigned i = 0, e = V2->size(); i != e; ++i)
584 if (TheVal == (*V2)[i].first)
588 // Otherwise, just sort both lists and compare element by element.
589 std::sort(V1->begin(), V1->end());
590 std::sort(V2->begin(), V2->end());
591 unsigned i1 = 0, i2 = 0, e1 = V1->size(), e2 = V2->size();
592 while (i1 != e1 && i2 != e2) {
593 if ((*V1)[i1].first == (*V2)[i2].first)
595 if ((*V1)[i1].first < (*V2)[i2].first)
603 // SimplifyEqualityComparisonWithOnlyPredecessor - If TI is known to be a
604 // terminator instruction and its block is known to only have a single
605 // predecessor block, check to see if that predecessor is also a value
606 // comparison with the same value, and if that comparison determines the outcome
607 // of this comparison. If so, simplify TI. This does a very limited form of
609 static bool SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
611 Value *PredVal = isValueEqualityComparison(Pred->getTerminator());
612 if (!PredVal) return false; // Not a value comparison in predecessor.
614 Value *ThisVal = isValueEqualityComparison(TI);
615 assert(ThisVal && "This isn't a value comparison!!");
616 if (ThisVal != PredVal) return false; // Different predicates.
618 // Find out information about when control will move from Pred to TI's block.
619 std::vector<std::pair<ConstantInt*, BasicBlock*> > PredCases;
620 BasicBlock *PredDef = GetValueEqualityComparisonCases(Pred->getTerminator(),
622 EliminateBlockCases(PredDef, PredCases); // Remove default from cases.
624 // Find information about how control leaves this block.
625 std::vector<std::pair<ConstantInt*, BasicBlock*> > ThisCases;
626 BasicBlock *ThisDef = GetValueEqualityComparisonCases(TI, ThisCases);
627 EliminateBlockCases(ThisDef, ThisCases); // Remove default from cases.
629 // If TI's block is the default block from Pred's comparison, potentially
630 // simplify TI based on this knowledge.
631 if (PredDef == TI->getParent()) {
632 // If we are here, we know that the value is none of those cases listed in
633 // PredCases. If there are any cases in ThisCases that are in PredCases, we
635 if (ValuesOverlap(PredCases, ThisCases)) {
636 if (isa<BranchInst>(TI)) {
637 // Okay, one of the successors of this condbr is dead. Convert it to a
639 assert(ThisCases.size() == 1 && "Branch can only have one case!");
640 // Insert the new branch.
641 Instruction *NI = BranchInst::Create(ThisDef, TI);
643 // Remove PHI node entries for the dead edge.
644 ThisCases[0].second->removePredecessor(TI->getParent());
646 DOUT << "Threading pred instr: " << *Pred->getTerminator()
647 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n";
649 EraseTerminatorInstAndDCECond(TI);
653 SwitchInst *SI = cast<SwitchInst>(TI);
654 // Okay, TI has cases that are statically dead, prune them away.
655 SmallPtrSet<Constant*, 16> DeadCases;
656 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
657 DeadCases.insert(PredCases[i].first);
659 DOUT << "Threading pred instr: " << *Pred->getTerminator()
660 << "Through successor TI: " << *TI;
662 for (unsigned i = SI->getNumCases()-1; i != 0; --i)
663 if (DeadCases.count(SI->getCaseValue(i))) {
664 SI->getSuccessor(i)->removePredecessor(TI->getParent());
668 DOUT << "Leaving: " << *TI << "\n";
674 // Otherwise, TI's block must correspond to some matched value. Find out
675 // which value (or set of values) this is.
676 ConstantInt *TIV = 0;
677 BasicBlock *TIBB = TI->getParent();
678 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
679 if (PredCases[i].second == TIBB) {
681 TIV = PredCases[i].first;
683 return false; // Cannot handle multiple values coming to this block.
685 assert(TIV && "No edge from pred to succ?");
687 // Okay, we found the one constant that our value can be if we get into TI's
688 // BB. Find out which successor will unconditionally be branched to.
689 BasicBlock *TheRealDest = 0;
690 for (unsigned i = 0, e = ThisCases.size(); i != e; ++i)
691 if (ThisCases[i].first == TIV) {
692 TheRealDest = ThisCases[i].second;
696 // If not handled by any explicit cases, it is handled by the default case.
697 if (TheRealDest == 0) TheRealDest = ThisDef;
699 // Remove PHI node entries for dead edges.
700 BasicBlock *CheckEdge = TheRealDest;
701 for (succ_iterator SI = succ_begin(TIBB), e = succ_end(TIBB); SI != e; ++SI)
702 if (*SI != CheckEdge)
703 (*SI)->removePredecessor(TIBB);
707 // Insert the new branch.
708 Instruction *NI = BranchInst::Create(TheRealDest, TI);
710 DOUT << "Threading pred instr: " << *Pred->getTerminator()
711 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n";
713 EraseTerminatorInstAndDCECond(TI);
719 // FoldValueComparisonIntoPredecessors - The specified terminator is a value
720 // equality comparison instruction (either a switch or a branch on "X == c").
721 // See if any of the predecessors of the terminator block are value comparisons
722 // on the same value. If so, and if safe to do so, fold them together.
723 static bool FoldValueComparisonIntoPredecessors(TerminatorInst *TI) {
724 BasicBlock *BB = TI->getParent();
725 Value *CV = isValueEqualityComparison(TI); // CondVal
726 assert(CV && "Not a comparison?");
727 bool Changed = false;
729 SmallVector<BasicBlock*, 16> Preds(pred_begin(BB), pred_end(BB));
730 while (!Preds.empty()) {
731 BasicBlock *Pred = Preds.back();
734 // See if the predecessor is a comparison with the same value.
735 TerminatorInst *PTI = Pred->getTerminator();
736 Value *PCV = isValueEqualityComparison(PTI); // PredCondVal
738 if (PCV == CV && SafeToMergeTerminators(TI, PTI)) {
739 // Figure out which 'cases' to copy from SI to PSI.
740 std::vector<std::pair<ConstantInt*, BasicBlock*> > BBCases;
741 BasicBlock *BBDefault = GetValueEqualityComparisonCases(TI, BBCases);
743 std::vector<std::pair<ConstantInt*, BasicBlock*> > PredCases;
744 BasicBlock *PredDefault = GetValueEqualityComparisonCases(PTI, PredCases);
746 // Based on whether the default edge from PTI goes to BB or not, fill in
747 // PredCases and PredDefault with the new switch cases we would like to
749 SmallVector<BasicBlock*, 8> NewSuccessors;
751 if (PredDefault == BB) {
752 // If this is the default destination from PTI, only the edges in TI
753 // that don't occur in PTI, or that branch to BB will be activated.
754 std::set<ConstantInt*> PTIHandled;
755 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
756 if (PredCases[i].second != BB)
757 PTIHandled.insert(PredCases[i].first);
759 // The default destination is BB, we don't need explicit targets.
760 std::swap(PredCases[i], PredCases.back());
761 PredCases.pop_back();
765 // Reconstruct the new switch statement we will be building.
766 if (PredDefault != BBDefault) {
767 PredDefault->removePredecessor(Pred);
768 PredDefault = BBDefault;
769 NewSuccessors.push_back(BBDefault);
771 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
772 if (!PTIHandled.count(BBCases[i].first) &&
773 BBCases[i].second != BBDefault) {
774 PredCases.push_back(BBCases[i]);
775 NewSuccessors.push_back(BBCases[i].second);
779 // If this is not the default destination from PSI, only the edges
780 // in SI that occur in PSI with a destination of BB will be
782 std::set<ConstantInt*> PTIHandled;
783 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
784 if (PredCases[i].second == BB) {
785 PTIHandled.insert(PredCases[i].first);
786 std::swap(PredCases[i], PredCases.back());
787 PredCases.pop_back();
791 // Okay, now we know which constants were sent to BB from the
792 // predecessor. Figure out where they will all go now.
793 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
794 if (PTIHandled.count(BBCases[i].first)) {
795 // If this is one we are capable of getting...
796 PredCases.push_back(BBCases[i]);
797 NewSuccessors.push_back(BBCases[i].second);
798 PTIHandled.erase(BBCases[i].first);// This constant is taken care of
801 // If there are any constants vectored to BB that TI doesn't handle,
802 // they must go to the default destination of TI.
803 for (std::set<ConstantInt*>::iterator I = PTIHandled.begin(),
804 E = PTIHandled.end(); I != E; ++I) {
805 PredCases.push_back(std::make_pair(*I, BBDefault));
806 NewSuccessors.push_back(BBDefault);
810 // Okay, at this point, we know which new successor Pred will get. Make
811 // sure we update the number of entries in the PHI nodes for these
813 for (unsigned i = 0, e = NewSuccessors.size(); i != e; ++i)
814 AddPredecessorToBlock(NewSuccessors[i], Pred, BB);
816 // Now that the successors are updated, create the new Switch instruction.
817 SwitchInst *NewSI = SwitchInst::Create(CV, PredDefault,
818 PredCases.size(), PTI);
819 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
820 NewSI->addCase(PredCases[i].first, PredCases[i].second);
822 EraseTerminatorInstAndDCECond(PTI);
824 // Okay, last check. If BB is still a successor of PSI, then we must
825 // have an infinite loop case. If so, add an infinitely looping block
826 // to handle the case to preserve the behavior of the code.
827 BasicBlock *InfLoopBlock = 0;
828 for (unsigned i = 0, e = NewSI->getNumSuccessors(); i != e; ++i)
829 if (NewSI->getSuccessor(i) == BB) {
830 if (InfLoopBlock == 0) {
831 // Insert it at the end of the function, because it's either code,
832 // or it won't matter if it's hot. :)
833 InfLoopBlock = BasicBlock::Create("infloop", BB->getParent());
834 BranchInst::Create(InfLoopBlock, InfLoopBlock);
836 NewSI->setSuccessor(i, InfLoopBlock);
845 /// HoistThenElseCodeToIf - Given a conditional branch that goes to BB1 and
846 /// BB2, hoist any common code in the two blocks up into the branch block. The
847 /// caller of this function guarantees that BI's block dominates BB1 and BB2.
848 static bool HoistThenElseCodeToIf(BranchInst *BI) {
849 // This does very trivial matching, with limited scanning, to find identical
850 // instructions in the two blocks. In particular, we don't want to get into
851 // O(M*N) situations here where M and N are the sizes of BB1 and BB2. As
852 // such, we currently just scan for obviously identical instructions in an
854 BasicBlock *BB1 = BI->getSuccessor(0); // The true destination.
855 BasicBlock *BB2 = BI->getSuccessor(1); // The false destination
857 Instruction *I1 = BB1->begin(), *I2 = BB2->begin();
858 if (I1->getOpcode() != I2->getOpcode() || isa<PHINode>(I1) ||
859 isa<InvokeInst>(I1) || !I1->isIdenticalTo(I2))
862 // If we get here, we can hoist at least one instruction.
863 BasicBlock *BIParent = BI->getParent();
866 // If we are hoisting the terminator instruction, don't move one (making a
867 // broken BB), instead clone it, and remove BI.
868 if (isa<TerminatorInst>(I1))
869 goto HoistTerminator;
871 // For a normal instruction, we just move one to right before the branch,
872 // then replace all uses of the other with the first. Finally, we remove
873 // the now redundant second instruction.
874 BIParent->getInstList().splice(BI, BB1->getInstList(), I1);
875 if (!I2->use_empty())
876 I2->replaceAllUsesWith(I1);
877 BB2->getInstList().erase(I2);
881 } while (I1->getOpcode() == I2->getOpcode() && I1->isIdenticalTo(I2));
886 // Okay, it is safe to hoist the terminator.
887 Instruction *NT = I1->clone();
888 BIParent->getInstList().insert(BI, NT);
889 if (NT->getType() != Type::VoidTy) {
890 I1->replaceAllUsesWith(NT);
891 I2->replaceAllUsesWith(NT);
895 // Hoisting one of the terminators from our successor is a great thing.
896 // Unfortunately, the successors of the if/else blocks may have PHI nodes in
897 // them. If they do, all PHI entries for BB1/BB2 must agree for all PHI
898 // nodes, so we insert select instruction to compute the final result.
899 std::map<std::pair<Value*,Value*>, SelectInst*> InsertedSelects;
900 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
902 for (BasicBlock::iterator BBI = SI->begin();
903 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
904 Value *BB1V = PN->getIncomingValueForBlock(BB1);
905 Value *BB2V = PN->getIncomingValueForBlock(BB2);
907 // These values do not agree. Insert a select instruction before NT
908 // that determines the right value.
909 SelectInst *&SI = InsertedSelects[std::make_pair(BB1V, BB2V)];
911 SI = SelectInst::Create(BI->getCondition(), BB1V, BB2V,
912 BB1V->getName()+"."+BB2V->getName(), NT);
913 // Make the PHI node use the select for all incoming values for BB1/BB2
914 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
915 if (PN->getIncomingBlock(i) == BB1 || PN->getIncomingBlock(i) == BB2)
916 PN->setIncomingValue(i, SI);
921 // Update any PHI nodes in our new successors.
922 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI)
923 AddPredecessorToBlock(*SI, BIParent, BB1);
925 EraseTerminatorInstAndDCECond(BI);
929 /// SpeculativelyExecuteBB - Given a conditional branch that goes to BB1
930 /// and an BB2 and the only successor of BB1 is BB2, hoist simple code
931 /// (for now, restricted to a single instruction that's side effect free) from
932 /// the BB1 into the branch block to speculatively execute it.
933 static bool SpeculativelyExecuteBB(BranchInst *BI, BasicBlock *BB1) {
934 // Only speculatively execution a single instruction (not counting the
935 // terminator) for now.
936 BasicBlock::iterator BBI = BB1->begin();
937 ++BBI; // must have at least a terminator
938 if (BBI == BB1->end()) return false; // only one inst
940 if (BBI != BB1->end()) return false; // more than 2 insts.
942 // Be conservative for now. FP select instruction can often be expensive.
943 Value *BrCond = BI->getCondition();
944 if (isa<Instruction>(BrCond) &&
945 cast<Instruction>(BrCond)->getOpcode() == Instruction::FCmp)
948 // If BB1 is actually on the false edge of the conditional branch, remember
949 // to swap the select operands later.
951 if (BB1 != BI->getSuccessor(0)) {
952 assert(BB1 == BI->getSuccessor(1) && "No edge from 'if' block?");
959 // br i1 %t1, label %BB1, label %BB2
968 // %t3 = select i1 %t1, %t2, %t3
969 Instruction *I = BB1->begin();
970 switch (I->getOpcode()) {
971 default: return false; // Not safe / profitable to hoist.
972 case Instruction::Add:
973 case Instruction::Sub:
974 // FP arithmetic might trap. Not worth doing for vector ops.
975 if (I->getType()->isFloatingPoint() || isa<VectorType>(I->getType()))
978 case Instruction::And:
979 case Instruction::Or:
980 case Instruction::Xor:
981 case Instruction::Shl:
982 case Instruction::LShr:
983 case Instruction::AShr:
984 // Don't mess with vector operations.
985 if (isa<VectorType>(I->getType()))
987 break; // These are all cheap and non-trapping instructions.
990 // If the instruction is obviously dead, don't try to predicate it.
991 if (I->use_empty()) {
992 I->eraseFromParent();
996 // Can we speculatively execute the instruction? And what is the value
997 // if the condition is false? Consider the phi uses, if the incoming value
998 // from the "if" block are all the same V, then V is the value of the
999 // select if the condition is false.
1000 BasicBlock *BIParent = BI->getParent();
1001 SmallVector<PHINode*, 4> PHIUses;
1002 Value *FalseV = NULL;
1004 BasicBlock *BB2 = BB1->getTerminator()->getSuccessor(0);
1005 for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
1007 // Ignore any user that is not a PHI node in BB2. These can only occur in
1008 // unreachable blocks, because they would not be dominated by the instr.
1009 PHINode *PN = dyn_cast<PHINode>(UI);
1010 if (!PN || PN->getParent() != BB2)
1012 PHIUses.push_back(PN);
1014 Value *PHIV = PN->getIncomingValueForBlock(BIParent);
1017 else if (FalseV != PHIV)
1018 return false; // Inconsistent value when condition is false.
1021 assert(FalseV && "Must have at least one user, and it must be a PHI");
1023 // Do not hoist the instruction if any of its operands are defined but not
1024 // used in this BB. The transformation will prevent the operand from
1025 // being sunk into the use block.
1026 for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i) {
1027 Instruction *OpI = dyn_cast<Instruction>(*i);
1028 if (OpI && OpI->getParent() == BIParent &&
1029 !OpI->isUsedInBasicBlock(BIParent))
1033 // If we get here, we can hoist the instruction. Try to place it
1034 // before the icmp instruction preceeding the conditional branch.
1035 BasicBlock::iterator InsertPos = BI;
1036 if (InsertPos != BIParent->begin())
1038 if (InsertPos == BrCond && !isa<PHINode>(BrCond)) {
1039 SmallPtrSet<Instruction *, 4> BB1Insns;
1040 for(BasicBlock::iterator BB1I = BB1->begin(), BB1E = BB1->end();
1041 BB1I != BB1E; ++BB1I)
1042 BB1Insns.insert(BB1I);
1043 for(Value::use_iterator UI = BrCond->use_begin(), UE = BrCond->use_end();
1045 Instruction *Use = cast<Instruction>(*UI);
1046 if (BB1Insns.count(Use)) {
1047 // If BrCond uses the instruction that place it just before
1048 // branch instruction.
1055 BIParent->getInstList().splice(InsertPos, BB1->getInstList(), I);
1057 // Create a select whose true value is the speculatively executed value and
1058 // false value is the previously determined FalseV.
1061 SI = SelectInst::Create(BrCond, FalseV, I,
1062 FalseV->getName() + "." + I->getName(), BI);
1064 SI = SelectInst::Create(BrCond, I, FalseV,
1065 I->getName() + "." + FalseV->getName(), BI);
1067 // Make the PHI node use the select for all incoming values for "then" and
1069 for (unsigned i = 0, e = PHIUses.size(); i != e; ++i) {
1070 PHINode *PN = PHIUses[i];
1071 for (unsigned j = 0, ee = PN->getNumIncomingValues(); j != ee; ++j)
1072 if (PN->getIncomingBlock(j) == BB1 ||
1073 PN->getIncomingBlock(j) == BIParent)
1074 PN->setIncomingValue(j, SI);
1081 /// BlockIsSimpleEnoughToThreadThrough - Return true if we can thread a branch
1082 /// across this block.
1083 static bool BlockIsSimpleEnoughToThreadThrough(BasicBlock *BB) {
1084 BranchInst *BI = cast<BranchInst>(BB->getTerminator());
1087 // If this basic block contains anything other than a PHI (which controls the
1088 // branch) and branch itself, bail out. FIXME: improve this in the future.
1089 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI, ++Size) {
1090 if (Size > 10) return false; // Don't clone large BB's.
1092 // We can only support instructions that are do not define values that are
1093 // live outside of the current basic block.
1094 for (Value::use_iterator UI = BBI->use_begin(), E = BBI->use_end();
1096 Instruction *U = cast<Instruction>(*UI);
1097 if (U->getParent() != BB || isa<PHINode>(U)) return false;
1100 // Looks ok, continue checking.
1106 /// FoldCondBranchOnPHI - If we have a conditional branch on a PHI node value
1107 /// that is defined in the same block as the branch and if any PHI entries are
1108 /// constants, thread edges corresponding to that entry to be branches to their
1109 /// ultimate destination.
1110 static bool FoldCondBranchOnPHI(BranchInst *BI) {
1111 BasicBlock *BB = BI->getParent();
1112 PHINode *PN = dyn_cast<PHINode>(BI->getCondition());
1113 // NOTE: we currently cannot transform this case if the PHI node is used
1114 // outside of the block.
1115 if (!PN || PN->getParent() != BB || !PN->hasOneUse())
1118 // Degenerate case of a single entry PHI.
1119 if (PN->getNumIncomingValues() == 1) {
1120 FoldSingleEntryPHINodes(PN->getParent());
1124 // Now we know that this block has multiple preds and two succs.
1125 if (!BlockIsSimpleEnoughToThreadThrough(BB)) return false;
1127 // Okay, this is a simple enough basic block. See if any phi values are
1129 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1131 if ((CB = dyn_cast<ConstantInt>(PN->getIncomingValue(i))) &&
1132 CB->getType() == Type::Int1Ty) {
1133 // Okay, we now know that all edges from PredBB should be revectored to
1134 // branch to RealDest.
1135 BasicBlock *PredBB = PN->getIncomingBlock(i);
1136 BasicBlock *RealDest = BI->getSuccessor(!CB->getZExtValue());
1138 if (RealDest == BB) continue; // Skip self loops.
1140 // The dest block might have PHI nodes, other predecessors and other
1141 // difficult cases. Instead of being smart about this, just insert a new
1142 // block that jumps to the destination block, effectively splitting
1143 // the edge we are about to create.
1144 BasicBlock *EdgeBB = BasicBlock::Create(RealDest->getName()+".critedge",
1145 RealDest->getParent(), RealDest);
1146 BranchInst::Create(RealDest, EdgeBB);
1148 for (BasicBlock::iterator BBI = RealDest->begin();
1149 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1150 Value *V = PN->getIncomingValueForBlock(BB);
1151 PN->addIncoming(V, EdgeBB);
1154 // BB may have instructions that are being threaded over. Clone these
1155 // instructions into EdgeBB. We know that there will be no uses of the
1156 // cloned instructions outside of EdgeBB.
1157 BasicBlock::iterator InsertPt = EdgeBB->begin();
1158 std::map<Value*, Value*> TranslateMap; // Track translated values.
1159 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
1160 if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
1161 TranslateMap[PN] = PN->getIncomingValueForBlock(PredBB);
1163 // Clone the instruction.
1164 Instruction *N = BBI->clone();
1165 if (BBI->hasName()) N->setName(BBI->getName()+".c");
1167 // Update operands due to translation.
1168 for (User::op_iterator i = N->op_begin(), e = N->op_end();
1170 std::map<Value*, Value*>::iterator PI =
1171 TranslateMap.find(*i);
1172 if (PI != TranslateMap.end())
1176 // Check for trivial simplification.
1177 if (Constant *C = ConstantFoldInstruction(N)) {
1178 TranslateMap[BBI] = C;
1179 delete N; // Constant folded away, don't need actual inst
1181 // Insert the new instruction into its new home.
1182 EdgeBB->getInstList().insert(InsertPt, N);
1183 if (!BBI->use_empty())
1184 TranslateMap[BBI] = N;
1189 // Loop over all of the edges from PredBB to BB, changing them to branch
1190 // to EdgeBB instead.
1191 TerminatorInst *PredBBTI = PredBB->getTerminator();
1192 for (unsigned i = 0, e = PredBBTI->getNumSuccessors(); i != e; ++i)
1193 if (PredBBTI->getSuccessor(i) == BB) {
1194 BB->removePredecessor(PredBB);
1195 PredBBTI->setSuccessor(i, EdgeBB);
1198 // Recurse, simplifying any other constants.
1199 return FoldCondBranchOnPHI(BI) | true;
1206 /// FoldTwoEntryPHINode - Given a BB that starts with the specified two-entry
1207 /// PHI node, see if we can eliminate it.
1208 static bool FoldTwoEntryPHINode(PHINode *PN) {
1209 // Ok, this is a two entry PHI node. Check to see if this is a simple "if
1210 // statement", which has a very simple dominance structure. Basically, we
1211 // are trying to find the condition that is being branched on, which
1212 // subsequently causes this merge to happen. We really want control
1213 // dependence information for this check, but simplifycfg can't keep it up
1214 // to date, and this catches most of the cases we care about anyway.
1216 BasicBlock *BB = PN->getParent();
1217 BasicBlock *IfTrue, *IfFalse;
1218 Value *IfCond = GetIfCondition(BB, IfTrue, IfFalse);
1219 if (!IfCond) return false;
1221 // Okay, we found that we can merge this two-entry phi node into a select.
1222 // Doing so would require us to fold *all* two entry phi nodes in this block.
1223 // At some point this becomes non-profitable (particularly if the target
1224 // doesn't support cmov's). Only do this transformation if there are two or
1225 // fewer PHI nodes in this block.
1226 unsigned NumPhis = 0;
1227 for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++NumPhis, ++I)
1231 DOUT << "FOUND IF CONDITION! " << *IfCond << " T: "
1232 << IfTrue->getName() << " F: " << IfFalse->getName() << "\n";
1234 // Loop over the PHI's seeing if we can promote them all to select
1235 // instructions. While we are at it, keep track of the instructions
1236 // that need to be moved to the dominating block.
1237 std::set<Instruction*> AggressiveInsts;
1239 BasicBlock::iterator AfterPHIIt = BB->begin();
1240 while (isa<PHINode>(AfterPHIIt)) {
1241 PHINode *PN = cast<PHINode>(AfterPHIIt++);
1242 if (PN->getIncomingValue(0) == PN->getIncomingValue(1)) {
1243 if (PN->getIncomingValue(0) != PN)
1244 PN->replaceAllUsesWith(PN->getIncomingValue(0));
1246 PN->replaceAllUsesWith(UndefValue::get(PN->getType()));
1247 } else if (!DominatesMergePoint(PN->getIncomingValue(0), BB,
1248 &AggressiveInsts) ||
1249 !DominatesMergePoint(PN->getIncomingValue(1), BB,
1250 &AggressiveInsts)) {
1255 // If we all PHI nodes are promotable, check to make sure that all
1256 // instructions in the predecessor blocks can be promoted as well. If
1257 // not, we won't be able to get rid of the control flow, so it's not
1258 // worth promoting to select instructions.
1259 BasicBlock *DomBlock = 0, *IfBlock1 = 0, *IfBlock2 = 0;
1260 PN = cast<PHINode>(BB->begin());
1261 BasicBlock *Pred = PN->getIncomingBlock(0);
1262 if (cast<BranchInst>(Pred->getTerminator())->isUnconditional()) {
1264 DomBlock = *pred_begin(Pred);
1265 for (BasicBlock::iterator I = Pred->begin();
1266 !isa<TerminatorInst>(I); ++I)
1267 if (!AggressiveInsts.count(I)) {
1268 // This is not an aggressive instruction that we can promote.
1269 // Because of this, we won't be able to get rid of the control
1270 // flow, so the xform is not worth it.
1275 Pred = PN->getIncomingBlock(1);
1276 if (cast<BranchInst>(Pred->getTerminator())->isUnconditional()) {
1278 DomBlock = *pred_begin(Pred);
1279 for (BasicBlock::iterator I = Pred->begin();
1280 !isa<TerminatorInst>(I); ++I)
1281 if (!AggressiveInsts.count(I)) {
1282 // This is not an aggressive instruction that we can promote.
1283 // Because of this, we won't be able to get rid of the control
1284 // flow, so the xform is not worth it.
1289 // If we can still promote the PHI nodes after this gauntlet of tests,
1290 // do all of the PHI's now.
1292 // Move all 'aggressive' instructions, which are defined in the
1293 // conditional parts of the if's up to the dominating block.
1295 DomBlock->getInstList().splice(DomBlock->getTerminator(),
1296 IfBlock1->getInstList(),
1298 IfBlock1->getTerminator());
1301 DomBlock->getInstList().splice(DomBlock->getTerminator(),
1302 IfBlock2->getInstList(),
1304 IfBlock2->getTerminator());
1307 while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
1308 // Change the PHI node into a select instruction.
1310 PN->getIncomingValue(PN->getIncomingBlock(0) == IfFalse);
1312 PN->getIncomingValue(PN->getIncomingBlock(0) == IfTrue);
1314 Value *NV = SelectInst::Create(IfCond, TrueVal, FalseVal, "", AfterPHIIt);
1315 PN->replaceAllUsesWith(NV);
1318 BB->getInstList().erase(PN);
1323 /// SimplifyCondBranchToTwoReturns - If we found a conditional branch that goes
1324 /// to two returning blocks, try to merge them together into one return,
1325 /// introducing a select if the return values disagree.
1326 static bool SimplifyCondBranchToTwoReturns(BranchInst *BI) {
1327 assert(BI->isConditional() && "Must be a conditional branch");
1328 BasicBlock *TrueSucc = BI->getSuccessor(0);
1329 BasicBlock *FalseSucc = BI->getSuccessor(1);
1330 ReturnInst *TrueRet = cast<ReturnInst>(TrueSucc->getTerminator());
1331 ReturnInst *FalseRet = cast<ReturnInst>(FalseSucc->getTerminator());
1333 // Check to ensure both blocks are empty (just a return) or optionally empty
1334 // with PHI nodes. If there are other instructions, merging would cause extra
1335 // computation on one path or the other.
1336 BasicBlock::iterator BBI = TrueRet;
1337 if (BBI != TrueSucc->begin() && !isa<PHINode>(--BBI))
1338 return false; // Not empty with optional phi nodes.
1340 if (BBI != FalseSucc->begin() && !isa<PHINode>(--BBI))
1341 return false; // Not empty with optional phi nodes.
1343 // Okay, we found a branch that is going to two return nodes. If
1344 // there is no return value for this function, just change the
1345 // branch into a return.
1346 if (FalseRet->getNumOperands() == 0) {
1347 TrueSucc->removePredecessor(BI->getParent());
1348 FalseSucc->removePredecessor(BI->getParent());
1349 ReturnInst::Create(0, BI);
1350 EraseTerminatorInstAndDCECond(BI);
1354 // Otherwise, figure out what the true and false return values are
1355 // so we can insert a new select instruction.
1356 Value *TrueValue = TrueRet->getReturnValue();
1357 Value *FalseValue = FalseRet->getReturnValue();
1359 // Unwrap any PHI nodes in the return blocks.
1360 if (PHINode *TVPN = dyn_cast_or_null<PHINode>(TrueValue))
1361 if (TVPN->getParent() == TrueSucc)
1362 TrueValue = TVPN->getIncomingValueForBlock(BI->getParent());
1363 if (PHINode *FVPN = dyn_cast_or_null<PHINode>(FalseValue))
1364 if (FVPN->getParent() == FalseSucc)
1365 FalseValue = FVPN->getIncomingValueForBlock(BI->getParent());
1367 // In order for this transformation to be safe, we must be able to
1368 // unconditionally execute both operands to the return. This is
1369 // normally the case, but we could have a potentially-trapping
1370 // constant expression that prevents this transformation from being
1372 if (ConstantExpr *TCV = dyn_cast_or_null<ConstantExpr>(TrueValue))
1375 if (ConstantExpr *FCV = dyn_cast_or_null<ConstantExpr>(FalseValue))
1379 // Okay, we collected all the mapped values and checked them for sanity, and
1380 // defined to really do this transformation. First, update the CFG.
1381 TrueSucc->removePredecessor(BI->getParent());
1382 FalseSucc->removePredecessor(BI->getParent());
1384 // Insert select instructions where needed.
1385 Value *BrCond = BI->getCondition();
1387 // Insert a select if the results differ.
1388 if (TrueValue == FalseValue || isa<UndefValue>(FalseValue)) {
1389 } else if (isa<UndefValue>(TrueValue)) {
1390 TrueValue = FalseValue;
1392 TrueValue = SelectInst::Create(BrCond, TrueValue,
1393 FalseValue, "retval", BI);
1397 Value *RI = !TrueValue ?
1398 ReturnInst::Create(BI) :
1399 ReturnInst::Create(TrueValue, BI);
1401 DOUT << "\nCHANGING BRANCH TO TWO RETURNS INTO SELECT:"
1402 << "\n " << *BI << "NewRet = " << *RI
1403 << "TRUEBLOCK: " << *TrueSucc << "FALSEBLOCK: "<< *FalseSucc;
1405 EraseTerminatorInstAndDCECond(BI);
1410 /// FoldBranchToCommonDest - If this basic block is ONLY a setcc and a branch,
1411 /// and if a predecessor branches to us and one of our successors, fold the
1412 /// setcc into the predecessor and use logical operations to pick the right
1414 static bool FoldBranchToCommonDest(BranchInst *BI) {
1415 BasicBlock *BB = BI->getParent();
1416 Instruction *Cond = dyn_cast<Instruction>(BI->getCondition());
1417 if (Cond == 0) return false;
1420 // Only allow this if the condition is a simple instruction that can be
1421 // executed unconditionally. It must be in the same block as the branch, and
1422 // must be at the front of the block.
1423 if ((!isa<CmpInst>(Cond) && !isa<BinaryOperator>(Cond)) ||
1424 Cond->getParent() != BB || &BB->front() != Cond || !Cond->hasOneUse())
1427 // Make sure the instruction after the condition is the cond branch.
1428 BasicBlock::iterator CondIt = Cond; ++CondIt;
1432 // Cond is known to be a compare or binary operator. Check to make sure that
1433 // neither operand is a potentially-trapping constant expression.
1434 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(0)))
1437 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(1)))
1442 // Finally, don't infinitely unroll conditional loops.
1443 BasicBlock *TrueDest = BI->getSuccessor(0);
1444 BasicBlock *FalseDest = BI->getSuccessor(1);
1445 if (TrueDest == BB || FalseDest == BB)
1448 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
1449 BasicBlock *PredBlock = *PI;
1450 BranchInst *PBI = dyn_cast<BranchInst>(PredBlock->getTerminator());
1452 // Check that we have two conditional branches. If there is a PHI node in
1453 // the common successor, verify that the same value flows in from both
1455 if (PBI == 0 || PBI->isUnconditional() ||
1456 !SafeToMergeTerminators(BI, PBI))
1459 Instruction::BinaryOps Opc;
1460 bool InvertPredCond = false;
1462 if (PBI->getSuccessor(0) == TrueDest)
1463 Opc = Instruction::Or;
1464 else if (PBI->getSuccessor(1) == FalseDest)
1465 Opc = Instruction::And;
1466 else if (PBI->getSuccessor(0) == FalseDest)
1467 Opc = Instruction::And, InvertPredCond = true;
1468 else if (PBI->getSuccessor(1) == TrueDest)
1469 Opc = Instruction::Or, InvertPredCond = true;
1473 DOUT << "FOLDING BRANCH TO COMMON DEST:\n" << *PBI << *BB;
1475 // If we need to invert the condition in the pred block to match, do so now.
1476 if (InvertPredCond) {
1478 BinaryOperator::CreateNot(PBI->getCondition(),
1479 PBI->getCondition()->getName()+".not", PBI);
1480 PBI->setCondition(NewCond);
1481 BasicBlock *OldTrue = PBI->getSuccessor(0);
1482 BasicBlock *OldFalse = PBI->getSuccessor(1);
1483 PBI->setSuccessor(0, OldFalse);
1484 PBI->setSuccessor(1, OldTrue);
1487 // Clone Cond into the predecessor basic block, and or/and the
1488 // two conditions together.
1489 Instruction *New = Cond->clone();
1490 PredBlock->getInstList().insert(PBI, New);
1491 New->takeName(Cond);
1492 Cond->setName(New->getName()+".old");
1494 Value *NewCond = BinaryOperator::Create(Opc, PBI->getCondition(),
1495 New, "or.cond", PBI);
1496 PBI->setCondition(NewCond);
1497 if (PBI->getSuccessor(0) == BB) {
1498 AddPredecessorToBlock(TrueDest, PredBlock, BB);
1499 PBI->setSuccessor(0, TrueDest);
1501 if (PBI->getSuccessor(1) == BB) {
1502 AddPredecessorToBlock(FalseDest, PredBlock, BB);
1503 PBI->setSuccessor(1, FalseDest);
1510 /// SimplifyCondBranchToCondBranch - If we have a conditional branch as a
1511 /// predecessor of another block, this function tries to simplify it. We know
1512 /// that PBI and BI are both conditional branches, and BI is in one of the
1513 /// successor blocks of PBI - PBI branches to BI.
1514 static bool SimplifyCondBranchToCondBranch(BranchInst *PBI, BranchInst *BI) {
1515 assert(PBI->isConditional() && BI->isConditional());
1516 BasicBlock *BB = BI->getParent();
1518 // If this block ends with a branch instruction, and if there is a
1519 // predecessor that ends on a branch of the same condition, make
1520 // this conditional branch redundant.
1521 if (PBI->getCondition() == BI->getCondition() &&
1522 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
1523 // Okay, the outcome of this conditional branch is statically
1524 // knowable. If this block had a single pred, handle specially.
1525 if (BB->getSinglePredecessor()) {
1526 // Turn this into a branch on constant.
1527 bool CondIsTrue = PBI->getSuccessor(0) == BB;
1528 BI->setCondition(ConstantInt::get(Type::Int1Ty, CondIsTrue));
1529 return true; // Nuke the branch on constant.
1532 // Otherwise, if there are multiple predecessors, insert a PHI that merges
1533 // in the constant and simplify the block result. Subsequent passes of
1534 // simplifycfg will thread the block.
1535 if (BlockIsSimpleEnoughToThreadThrough(BB)) {
1536 PHINode *NewPN = PHINode::Create(Type::Int1Ty,
1537 BI->getCondition()->getName() + ".pr",
1539 // Okay, we're going to insert the PHI node. Since PBI is not the only
1540 // predecessor, compute the PHI'd conditional value for all of the preds.
1541 // Any predecessor where the condition is not computable we keep symbolic.
1542 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
1543 if ((PBI = dyn_cast<BranchInst>((*PI)->getTerminator())) &&
1544 PBI != BI && PBI->isConditional() &&
1545 PBI->getCondition() == BI->getCondition() &&
1546 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
1547 bool CondIsTrue = PBI->getSuccessor(0) == BB;
1548 NewPN->addIncoming(ConstantInt::get(Type::Int1Ty,
1551 NewPN->addIncoming(BI->getCondition(), *PI);
1554 BI->setCondition(NewPN);
1559 // If this is a conditional branch in an empty block, and if any
1560 // predecessors is a conditional branch to one of our destinations,
1561 // fold the conditions into logical ops and one cond br.
1562 if (&BB->front() != BI)
1566 if (PBI->getSuccessor(0) == BI->getSuccessor(0))
1568 else if (PBI->getSuccessor(0) == BI->getSuccessor(1))
1569 PBIOp = 0, BIOp = 1;
1570 else if (PBI->getSuccessor(1) == BI->getSuccessor(0))
1571 PBIOp = 1, BIOp = 0;
1572 else if (PBI->getSuccessor(1) == BI->getSuccessor(1))
1577 // Check to make sure that the other destination of this branch
1578 // isn't BB itself. If so, this is an infinite loop that will
1579 // keep getting unwound.
1580 if (PBI->getSuccessor(PBIOp) == BB)
1583 // Do not perform this transformation if it would require
1584 // insertion of a large number of select instructions. For targets
1585 // without predication/cmovs, this is a big pessimization.
1586 BasicBlock *CommonDest = PBI->getSuccessor(PBIOp);
1588 unsigned NumPhis = 0;
1589 for (BasicBlock::iterator II = CommonDest->begin();
1590 isa<PHINode>(II); ++II, ++NumPhis)
1591 if (NumPhis > 2) // Disable this xform.
1594 // Finally, if everything is ok, fold the branches to logical ops.
1595 BasicBlock *OtherDest = BI->getSuccessor(BIOp ^ 1);
1597 DOUT << "FOLDING BRs:" << *PBI->getParent()
1598 << "AND: " << *BI->getParent();
1601 // If OtherDest *is* BB, then BB is a basic block with a single conditional
1602 // branch in it, where one edge (OtherDest) goes back to itself but the other
1603 // exits. We don't *know* that the program avoids the infinite loop
1604 // (even though that seems likely). If we do this xform naively, we'll end up
1605 // recursively unpeeling the loop. Since we know that (after the xform is
1606 // done) that the block *is* infinite if reached, we just make it an obviously
1607 // infinite loop with no cond branch.
1608 if (OtherDest == BB) {
1609 // Insert it at the end of the function, because it's either code,
1610 // or it won't matter if it's hot. :)
1611 BasicBlock *InfLoopBlock = BasicBlock::Create("infloop", BB->getParent());
1612 BranchInst::Create(InfLoopBlock, InfLoopBlock);
1613 OtherDest = InfLoopBlock;
1616 DOUT << *PBI->getParent()->getParent();
1618 // BI may have other predecessors. Because of this, we leave
1619 // it alone, but modify PBI.
1621 // Make sure we get to CommonDest on True&True directions.
1622 Value *PBICond = PBI->getCondition();
1624 PBICond = BinaryOperator::CreateNot(PBICond,
1625 PBICond->getName()+".not",
1627 Value *BICond = BI->getCondition();
1629 BICond = BinaryOperator::CreateNot(BICond,
1630 BICond->getName()+".not",
1632 // Merge the conditions.
1633 Value *Cond = BinaryOperator::CreateOr(PBICond, BICond, "brmerge", PBI);
1635 // Modify PBI to branch on the new condition to the new dests.
1636 PBI->setCondition(Cond);
1637 PBI->setSuccessor(0, CommonDest);
1638 PBI->setSuccessor(1, OtherDest);
1640 // OtherDest may have phi nodes. If so, add an entry from PBI's
1641 // block that are identical to the entries for BI's block.
1643 for (BasicBlock::iterator II = OtherDest->begin();
1644 (PN = dyn_cast<PHINode>(II)); ++II) {
1645 Value *V = PN->getIncomingValueForBlock(BB);
1646 PN->addIncoming(V, PBI->getParent());
1649 // We know that the CommonDest already had an edge from PBI to
1650 // it. If it has PHIs though, the PHIs may have different
1651 // entries for BB and PBI's BB. If so, insert a select to make
1653 for (BasicBlock::iterator II = CommonDest->begin();
1654 (PN = dyn_cast<PHINode>(II)); ++II) {
1655 Value *BIV = PN->getIncomingValueForBlock(BB);
1656 unsigned PBBIdx = PN->getBasicBlockIndex(PBI->getParent());
1657 Value *PBIV = PN->getIncomingValue(PBBIdx);
1659 // Insert a select in PBI to pick the right value.
1660 Value *NV = SelectInst::Create(PBICond, PBIV, BIV,
1661 PBIV->getName()+".mux", PBI);
1662 PN->setIncomingValue(PBBIdx, NV);
1666 DOUT << "INTO: " << *PBI->getParent();
1668 DOUT << *PBI->getParent()->getParent();
1670 // This basic block is probably dead. We know it has at least
1671 // one fewer predecessor.
1677 /// ConstantIntOrdering - This class implements a stable ordering of constant
1678 /// integers that does not depend on their address. This is important for
1679 /// applications that sort ConstantInt's to ensure uniqueness.
1680 struct ConstantIntOrdering {
1681 bool operator()(const ConstantInt *LHS, const ConstantInt *RHS) const {
1682 return LHS->getValue().ult(RHS->getValue());
1687 // SimplifyCFG - This function is used to do simplification of a CFG. For
1688 // example, it adjusts branches to branches to eliminate the extra hop, it
1689 // eliminates unreachable basic blocks, and does other "peephole" optimization
1690 // of the CFG. It returns true if a modification was made.
1692 // WARNING: The entry node of a function may not be simplified.
1694 bool llvm::SimplifyCFG(BasicBlock *BB) {
1695 bool Changed = false;
1696 Function *M = BB->getParent();
1698 assert(BB && BB->getParent() && "Block not embedded in function!");
1699 assert(BB->getTerminator() && "Degenerate basic block encountered!");
1700 assert(&BB->getParent()->getEntryBlock() != BB &&
1701 "Can't Simplify entry block!");
1703 // Remove basic blocks that have no predecessors... or that just have themself
1704 // as a predecessor. These are unreachable.
1705 if (pred_begin(BB) == pred_end(BB) || BB->getSinglePredecessor() == BB) {
1706 DOUT << "Removing BB: \n" << *BB;
1707 DeleteDeadBlock(BB);
1711 // Check to see if we can constant propagate this terminator instruction
1713 Changed |= ConstantFoldTerminator(BB);
1715 // If there is a trivial two-entry PHI node in this basic block, and we can
1716 // eliminate it, do so now.
1717 if (PHINode *PN = dyn_cast<PHINode>(BB->begin()))
1718 if (PN->getNumIncomingValues() == 2)
1719 Changed |= FoldTwoEntryPHINode(PN);
1721 // If this is a returning block with only PHI nodes in it, fold the return
1722 // instruction into any unconditional branch predecessors.
1724 // If any predecessor is a conditional branch that just selects among
1725 // different return values, fold the replace the branch/return with a select
1727 if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
1728 BasicBlock::iterator BBI = BB->getTerminator();
1729 if (BBI == BB->begin() || isa<PHINode>(--BBI)) {
1730 // Find predecessors that end with branches.
1731 SmallVector<BasicBlock*, 8> UncondBranchPreds;
1732 SmallVector<BranchInst*, 8> CondBranchPreds;
1733 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
1734 TerminatorInst *PTI = (*PI)->getTerminator();
1735 if (BranchInst *BI = dyn_cast<BranchInst>(PTI)) {
1736 if (BI->isUnconditional())
1737 UncondBranchPreds.push_back(*PI);
1739 CondBranchPreds.push_back(BI);
1743 // If we found some, do the transformation!
1744 if (!UncondBranchPreds.empty()) {
1745 while (!UncondBranchPreds.empty()) {
1746 BasicBlock *Pred = UncondBranchPreds.back();
1747 DOUT << "FOLDING: " << *BB
1748 << "INTO UNCOND BRANCH PRED: " << *Pred;
1749 UncondBranchPreds.pop_back();
1750 Instruction *UncondBranch = Pred->getTerminator();
1751 // Clone the return and add it to the end of the predecessor.
1752 Instruction *NewRet = RI->clone();
1753 Pred->getInstList().push_back(NewRet);
1755 // If the return instruction returns a value, and if the value was a
1756 // PHI node in "BB", propagate the right value into the return.
1757 for (User::op_iterator i = NewRet->op_begin(), e = NewRet->op_end();
1759 if (PHINode *PN = dyn_cast<PHINode>(*i))
1760 if (PN->getParent() == BB)
1761 *i = PN->getIncomingValueForBlock(Pred);
1763 // Update any PHI nodes in the returning block to realize that we no
1764 // longer branch to them.
1765 BB->removePredecessor(Pred);
1766 Pred->getInstList().erase(UncondBranch);
1769 // If we eliminated all predecessors of the block, delete the block now.
1770 if (pred_begin(BB) == pred_end(BB))
1771 // We know there are no successors, so just nuke the block.
1772 M->getBasicBlockList().erase(BB);
1777 // Check out all of the conditional branches going to this return
1778 // instruction. If any of them just select between returns, change the
1779 // branch itself into a select/return pair.
1780 while (!CondBranchPreds.empty()) {
1781 BranchInst *BI = CondBranchPreds.back();
1782 CondBranchPreds.pop_back();
1784 // Check to see if the non-BB successor is also a return block.
1785 if (isa<ReturnInst>(BI->getSuccessor(0)->getTerminator()) &&
1786 isa<ReturnInst>(BI->getSuccessor(1)->getTerminator()) &&
1787 SimplifyCondBranchToTwoReturns(BI))
1791 } else if (isa<UnwindInst>(BB->begin())) {
1792 // Check to see if the first instruction in this block is just an unwind.
1793 // If so, replace any invoke instructions which use this as an exception
1794 // destination with call instructions, and any unconditional branch
1795 // predecessor with an unwind.
1797 SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
1798 while (!Preds.empty()) {
1799 BasicBlock *Pred = Preds.back();
1800 if (BranchInst *BI = dyn_cast<BranchInst>(Pred->getTerminator())) {
1801 if (BI->isUnconditional()) {
1802 Pred->getInstList().pop_back(); // nuke uncond branch
1803 new UnwindInst(Pred); // Use unwind.
1806 } else if (InvokeInst *II = dyn_cast<InvokeInst>(Pred->getTerminator()))
1807 if (II->getUnwindDest() == BB) {
1808 // Insert a new branch instruction before the invoke, because this
1809 // is now a fall through...
1810 BranchInst *BI = BranchInst::Create(II->getNormalDest(), II);
1811 Pred->getInstList().remove(II); // Take out of symbol table
1813 // Insert the call now...
1814 SmallVector<Value*,8> Args(II->op_begin()+3, II->op_end());
1815 CallInst *CI = CallInst::Create(II->getCalledValue(),
1816 Args.begin(), Args.end(),
1818 CI->setCallingConv(II->getCallingConv());
1819 CI->setAttributes(II->getAttributes());
1820 // If the invoke produced a value, the Call now does instead
1821 II->replaceAllUsesWith(CI);
1829 // If this block is now dead, remove it.
1830 if (pred_begin(BB) == pred_end(BB)) {
1831 // We know there are no successors, so just nuke the block.
1832 M->getBasicBlockList().erase(BB);
1836 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
1837 if (isValueEqualityComparison(SI)) {
1838 // If we only have one predecessor, and if it is a branch on this value,
1839 // see if that predecessor totally determines the outcome of this switch.
1840 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
1841 if (SimplifyEqualityComparisonWithOnlyPredecessor(SI, OnlyPred))
1842 return SimplifyCFG(BB) || 1;
1844 // If the block only contains the switch, see if we can fold the block
1845 // away into any preds.
1846 if (SI == &BB->front())
1847 if (FoldValueComparisonIntoPredecessors(SI))
1848 return SimplifyCFG(BB) || 1;
1850 } else if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
1851 if (BI->isUnconditional()) {
1852 BasicBlock::iterator BBI = BB->getFirstNonPHI();
1854 BasicBlock *Succ = BI->getSuccessor(0);
1855 if (BBI->isTerminator() && // Terminator is the only non-phi instruction!
1856 Succ != BB) // Don't hurt infinite loops!
1857 if (TryToSimplifyUncondBranchFromEmptyBlock(BB, Succ))
1860 } else { // Conditional branch
1861 if (isValueEqualityComparison(BI)) {
1862 // If we only have one predecessor, and if it is a branch on this value,
1863 // see if that predecessor totally determines the outcome of this
1865 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
1866 if (SimplifyEqualityComparisonWithOnlyPredecessor(BI, OnlyPred))
1867 return SimplifyCFG(BB) || 1;
1869 // This block must be empty, except for the setcond inst, if it exists.
1870 BasicBlock::iterator I = BB->begin();
1872 (&*I == cast<Instruction>(BI->getCondition()) &&
1874 if (FoldValueComparisonIntoPredecessors(BI))
1875 return SimplifyCFG(BB) | true;
1878 // If this is a branch on a phi node in the current block, thread control
1879 // through this block if any PHI node entries are constants.
1880 if (PHINode *PN = dyn_cast<PHINode>(BI->getCondition()))
1881 if (PN->getParent() == BI->getParent())
1882 if (FoldCondBranchOnPHI(BI))
1883 return SimplifyCFG(BB) | true;
1885 // If this basic block is ONLY a setcc and a branch, and if a predecessor
1886 // branches to us and one of our successors, fold the setcc into the
1887 // predecessor and use logical operations to pick the right destination.
1888 if (FoldBranchToCommonDest(BI))
1889 return SimplifyCFG(BB) | 1;
1892 // Scan predecessor blocks for conditional branches.
1893 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
1894 if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
1895 if (PBI != BI && PBI->isConditional())
1896 if (SimplifyCondBranchToCondBranch(PBI, BI))
1897 return SimplifyCFG(BB) | true;
1899 } else if (isa<UnreachableInst>(BB->getTerminator())) {
1900 // If there are any instructions immediately before the unreachable that can
1901 // be removed, do so.
1902 Instruction *Unreachable = BB->getTerminator();
1903 while (Unreachable != BB->begin()) {
1904 BasicBlock::iterator BBI = Unreachable;
1906 // Do not delete instructions that can have side effects, like calls
1907 // (which may never return) and volatile loads and stores.
1908 if (isa<CallInst>(BBI)) break;
1910 if (StoreInst *SI = dyn_cast<StoreInst>(BBI))
1911 if (SI->isVolatile())
1914 if (LoadInst *LI = dyn_cast<LoadInst>(BBI))
1915 if (LI->isVolatile())
1918 // Delete this instruction
1919 BB->getInstList().erase(BBI);
1923 // If the unreachable instruction is the first in the block, take a gander
1924 // at all of the predecessors of this instruction, and simplify them.
1925 if (&BB->front() == Unreachable) {
1926 SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
1927 for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
1928 TerminatorInst *TI = Preds[i]->getTerminator();
1930 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
1931 if (BI->isUnconditional()) {
1932 if (BI->getSuccessor(0) == BB) {
1933 new UnreachableInst(TI);
1934 TI->eraseFromParent();
1938 if (BI->getSuccessor(0) == BB) {
1939 BranchInst::Create(BI->getSuccessor(1), BI);
1940 EraseTerminatorInstAndDCECond(BI);
1941 } else if (BI->getSuccessor(1) == BB) {
1942 BranchInst::Create(BI->getSuccessor(0), BI);
1943 EraseTerminatorInstAndDCECond(BI);
1947 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
1948 for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
1949 if (SI->getSuccessor(i) == BB) {
1950 BB->removePredecessor(SI->getParent());
1955 // If the default value is unreachable, figure out the most popular
1956 // destination and make it the default.
1957 if (SI->getSuccessor(0) == BB) {
1958 std::map<BasicBlock*, unsigned> Popularity;
1959 for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
1960 Popularity[SI->getSuccessor(i)]++;
1962 // Find the most popular block.
1963 unsigned MaxPop = 0;
1964 BasicBlock *MaxBlock = 0;
1965 for (std::map<BasicBlock*, unsigned>::iterator
1966 I = Popularity.begin(), E = Popularity.end(); I != E; ++I) {
1967 if (I->second > MaxPop) {
1969 MaxBlock = I->first;
1973 // Make this the new default, allowing us to delete any explicit
1975 SI->setSuccessor(0, MaxBlock);
1978 // If MaxBlock has phinodes in it, remove MaxPop-1 entries from
1980 if (isa<PHINode>(MaxBlock->begin()))
1981 for (unsigned i = 0; i != MaxPop-1; ++i)
1982 MaxBlock->removePredecessor(SI->getParent());
1984 for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
1985 if (SI->getSuccessor(i) == MaxBlock) {
1991 } else if (InvokeInst *II = dyn_cast<InvokeInst>(TI)) {
1992 if (II->getUnwindDest() == BB) {
1993 // Convert the invoke to a call instruction. This would be a good
1994 // place to note that the call does not throw though.
1995 BranchInst *BI = BranchInst::Create(II->getNormalDest(), II);
1996 II->removeFromParent(); // Take out of symbol table
1998 // Insert the call now...
1999 SmallVector<Value*, 8> Args(II->op_begin()+3, II->op_end());
2000 CallInst *CI = CallInst::Create(II->getCalledValue(),
2001 Args.begin(), Args.end(),
2003 CI->setCallingConv(II->getCallingConv());
2004 CI->setAttributes(II->getAttributes());
2005 // If the invoke produced a value, the Call does now instead.
2006 II->replaceAllUsesWith(CI);
2013 // If this block is now dead, remove it.
2014 if (pred_begin(BB) == pred_end(BB)) {
2015 // We know there are no successors, so just nuke the block.
2016 M->getBasicBlockList().erase(BB);
2022 // Merge basic blocks into their predecessor if there is only one distinct
2023 // pred, and if there is only one distinct successor of the predecessor, and
2024 // if there are no PHI nodes.
2026 if (MergeBlockIntoPredecessor(BB))
2029 // Otherwise, if this block only has a single predecessor, and if that block
2030 // is a conditional branch, see if we can hoist any code from this block up
2031 // into our predecessor.
2032 pred_iterator PI(pred_begin(BB)), PE(pred_end(BB));
2033 BasicBlock *OnlyPred = *PI++;
2034 for (; PI != PE; ++PI) // Search all predecessors, see if they are all same
2035 if (*PI != OnlyPred) {
2036 OnlyPred = 0; // There are multiple different predecessors...
2041 if (BranchInst *BI = dyn_cast<BranchInst>(OnlyPred->getTerminator()))
2042 if (BI->isConditional()) {
2043 // Get the other block.
2044 BasicBlock *OtherBB = BI->getSuccessor(BI->getSuccessor(0) == BB);
2045 PI = pred_begin(OtherBB);
2048 if (PI == pred_end(OtherBB)) {
2049 // We have a conditional branch to two blocks that are only reachable
2050 // from the condbr. We know that the condbr dominates the two blocks,
2051 // so see if there is any identical code in the "then" and "else"
2052 // blocks. If so, we can hoist it up to the branching block.
2053 Changed |= HoistThenElseCodeToIf(BI);
2055 BasicBlock* OnlySucc = NULL;
2056 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB);
2060 else if (*SI != OnlySucc) {
2061 OnlySucc = 0; // There are multiple distinct successors!
2066 if (OnlySucc == OtherBB) {
2067 // If BB's only successor is the other successor of the predecessor,
2068 // i.e. a triangle, see if we can hoist any code from this block up
2069 // to the "if" block.
2070 Changed |= SpeculativelyExecuteBB(BI, BB);
2075 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
2076 if (BranchInst *BI = dyn_cast<BranchInst>((*PI)->getTerminator()))
2077 // Change br (X == 0 | X == 1), T, F into a switch instruction.
2078 if (BI->isConditional() && isa<Instruction>(BI->getCondition())) {
2079 Instruction *Cond = cast<Instruction>(BI->getCondition());
2080 // If this is a bunch of seteq's or'd together, or if it's a bunch of
2081 // 'setne's and'ed together, collect them.
2083 std::vector<ConstantInt*> Values;
2084 bool TrueWhenEqual = GatherValueComparisons(Cond, CompVal, Values);
2085 if (CompVal && CompVal->getType()->isInteger()) {
2086 // There might be duplicate constants in the list, which the switch
2087 // instruction can't handle, remove them now.
2088 std::sort(Values.begin(), Values.end(), ConstantIntOrdering());
2089 Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
2091 // Figure out which block is which destination.
2092 BasicBlock *DefaultBB = BI->getSuccessor(1);
2093 BasicBlock *EdgeBB = BI->getSuccessor(0);
2094 if (!TrueWhenEqual) std::swap(DefaultBB, EdgeBB);
2096 // Create the new switch instruction now.
2097 SwitchInst *New = SwitchInst::Create(CompVal, DefaultBB,
2100 // Add all of the 'cases' to the switch instruction.
2101 for (unsigned i = 0, e = Values.size(); i != e; ++i)
2102 New->addCase(Values[i], EdgeBB);
2104 // We added edges from PI to the EdgeBB. As such, if there were any
2105 // PHI nodes in EdgeBB, they need entries to be added corresponding to
2106 // the number of edges added.
2107 for (BasicBlock::iterator BBI = EdgeBB->begin();
2108 isa<PHINode>(BBI); ++BBI) {
2109 PHINode *PN = cast<PHINode>(BBI);
2110 Value *InVal = PN->getIncomingValueForBlock(*PI);
2111 for (unsigned i = 0, e = Values.size()-1; i != e; ++i)
2112 PN->addIncoming(InVal, *PI);
2115 // Erase the old branch instruction.
2116 EraseTerminatorInstAndDCECond(BI);