Make simplifycfg reprocess newly formed "br (cond1 | cond2)" conditions
[oota-llvm.git] / lib / Transforms / Utils / SimplifyCFG.cpp
1 //===- SimplifyCFG.cpp - Code to perform CFG simplification ---------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // Peephole optimize the CFG.
11 //
12 //===----------------------------------------------------------------------===//
13
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/IntrinsicInst.h"
19 #include "llvm/Type.h"
20 #include "llvm/DerivedTypes.h"
21 #include "llvm/GlobalVariable.h"
22 #include "llvm/Support/CFG.h"
23 #include "llvm/Support/Debug.h"
24 #include "llvm/Support/raw_ostream.h"
25 #include "llvm/Analysis/ConstantFolding.h"
26 #include "llvm/Target/TargetData.h"
27 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
28 #include "llvm/ADT/DenseMap.h"
29 #include "llvm/ADT/SmallVector.h"
30 #include "llvm/ADT/SmallPtrSet.h"
31 #include "llvm/ADT/Statistic.h"
32 #include "llvm/ADT/STLExtras.h"
33 #include <algorithm>
34 #include <set>
35 #include <map>
36 using namespace llvm;
37
38 STATISTIC(NumSpeculations, "Number of speculative executed instructions");
39
40 namespace {
41 class SimplifyCFGOpt {
42   const TargetData *const TD;
43
44   Value *isValueEqualityComparison(TerminatorInst *TI);
45   BasicBlock *GetValueEqualityComparisonCases(TerminatorInst *TI,
46     std::vector<std::pair<ConstantInt*, BasicBlock*> > &Cases);
47   bool SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
48                                                      BasicBlock *Pred);
49   bool FoldValueComparisonIntoPredecessors(TerminatorInst *TI);
50
51   bool SimplifyReturn(ReturnInst *RI);
52   bool SimplifyUnwind(UnwindInst *UI);
53   bool SimplifyUnreachable(UnreachableInst *UI);
54   bool SimplifySwitch(SwitchInst *SI);
55   bool SimplifyIndirectBr(IndirectBrInst *IBI);
56   bool SimplifyUncondBranch(BranchInst *BI);
57   bool SimplifyCondBranch(BranchInst *BI);
58
59 public:
60   explicit SimplifyCFGOpt(const TargetData *td) : TD(td) {}
61   bool run(BasicBlock *BB);
62 };
63 }
64
65 /// SafeToMergeTerminators - Return true if it is safe to merge these two
66 /// terminator instructions together.
67 ///
68 static bool SafeToMergeTerminators(TerminatorInst *SI1, TerminatorInst *SI2) {
69   if (SI1 == SI2) return false;  // Can't merge with self!
70   
71   // It is not safe to merge these two switch instructions if they have a common
72   // successor, and if that successor has a PHI node, and if *that* PHI node has
73   // conflicting incoming values from the two switch blocks.
74   BasicBlock *SI1BB = SI1->getParent();
75   BasicBlock *SI2BB = SI2->getParent();
76   SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
77   
78   for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
79     if (SI1Succs.count(*I))
80       for (BasicBlock::iterator BBI = (*I)->begin();
81            isa<PHINode>(BBI); ++BBI) {
82         PHINode *PN = cast<PHINode>(BBI);
83         if (PN->getIncomingValueForBlock(SI1BB) !=
84             PN->getIncomingValueForBlock(SI2BB))
85           return false;
86       }
87         
88   return true;
89 }
90
91 /// AddPredecessorToBlock - Update PHI nodes in Succ to indicate that there will
92 /// now be entries in it from the 'NewPred' block.  The values that will be
93 /// flowing into the PHI nodes will be the same as those coming in from
94 /// ExistPred, an existing predecessor of Succ.
95 static void AddPredecessorToBlock(BasicBlock *Succ, BasicBlock *NewPred,
96                                   BasicBlock *ExistPred) {
97   assert(std::find(succ_begin(ExistPred), succ_end(ExistPred), Succ) !=
98          succ_end(ExistPred) && "ExistPred is not a predecessor of Succ!");
99   if (!isa<PHINode>(Succ->begin())) return; // Quick exit if nothing to do
100   
101   PHINode *PN;
102   for (BasicBlock::iterator I = Succ->begin();
103        (PN = dyn_cast<PHINode>(I)); ++I)
104     PN->addIncoming(PN->getIncomingValueForBlock(ExistPred), NewPred);
105 }
106
107
108 /// GetIfCondition - Given a basic block (BB) with two predecessors (and
109 /// presumably PHI nodes in it), check to see if the merge at this block is due
110 /// to an "if condition".  If so, return the boolean condition that determines
111 /// which entry into BB will be taken.  Also, return by references the block
112 /// that will be entered from if the condition is true, and the block that will
113 /// be entered if the condition is false.
114 ///
115 ///
116 static Value *GetIfCondition(BasicBlock *BB,
117                              BasicBlock *&IfTrue, BasicBlock *&IfFalse) {
118   assert(std::distance(pred_begin(BB), pred_end(BB)) == 2 &&
119          "Function can only handle blocks with 2 predecessors!");
120   BasicBlock *Pred1 = *pred_begin(BB);
121   BasicBlock *Pred2 = *++pred_begin(BB);
122
123   // We can only handle branches.  Other control flow will be lowered to
124   // branches if possible anyway.
125   if (!isa<BranchInst>(Pred1->getTerminator()) ||
126       !isa<BranchInst>(Pred2->getTerminator()))
127     return 0;
128   BranchInst *Pred1Br = cast<BranchInst>(Pred1->getTerminator());
129   BranchInst *Pred2Br = cast<BranchInst>(Pred2->getTerminator());
130
131   // Eliminate code duplication by ensuring that Pred1Br is conditional if
132   // either are.
133   if (Pred2Br->isConditional()) {
134     // If both branches are conditional, we don't have an "if statement".  In
135     // reality, we could transform this case, but since the condition will be
136     // required anyway, we stand no chance of eliminating it, so the xform is
137     // probably not profitable.
138     if (Pred1Br->isConditional())
139       return 0;
140
141     std::swap(Pred1, Pred2);
142     std::swap(Pred1Br, Pred2Br);
143   }
144
145   if (Pred1Br->isConditional()) {
146     // If we found a conditional branch predecessor, make sure that it branches
147     // to BB and Pred2Br.  If it doesn't, this isn't an "if statement".
148     if (Pred1Br->getSuccessor(0) == BB &&
149         Pred1Br->getSuccessor(1) == Pred2) {
150       IfTrue = Pred1;
151       IfFalse = Pred2;
152     } else if (Pred1Br->getSuccessor(0) == Pred2 &&
153                Pred1Br->getSuccessor(1) == BB) {
154       IfTrue = Pred2;
155       IfFalse = Pred1;
156     } else {
157       // We know that one arm of the conditional goes to BB, so the other must
158       // go somewhere unrelated, and this must not be an "if statement".
159       return 0;
160     }
161
162     // The only thing we have to watch out for here is to make sure that Pred2
163     // doesn't have incoming edges from other blocks.  If it does, the condition
164     // doesn't dominate BB.
165     if (++pred_begin(Pred2) != pred_end(Pred2))
166       return 0;
167
168     return Pred1Br->getCondition();
169   }
170
171   // Ok, if we got here, both predecessors end with an unconditional branch to
172   // BB.  Don't panic!  If both blocks only have a single (identical)
173   // predecessor, and THAT is a conditional branch, then we're all ok!
174   if (pred_begin(Pred1) == pred_end(Pred1) ||
175       ++pred_begin(Pred1) != pred_end(Pred1) ||
176       pred_begin(Pred2) == pred_end(Pred2) ||
177       ++pred_begin(Pred2) != pred_end(Pred2) ||
178       *pred_begin(Pred1) != *pred_begin(Pred2))
179     return 0;
180
181   // Otherwise, if this is a conditional branch, then we can use it!
182   BasicBlock *CommonPred = *pred_begin(Pred1);
183   if (BranchInst *BI = dyn_cast<BranchInst>(CommonPred->getTerminator())) {
184     assert(BI->isConditional() && "Two successors but not conditional?");
185     if (BI->getSuccessor(0) == Pred1) {
186       IfTrue = Pred1;
187       IfFalse = Pred2;
188     } else {
189       IfTrue = Pred2;
190       IfFalse = Pred1;
191     }
192     return BI->getCondition();
193   }
194   return 0;
195 }
196
197 /// DominatesMergePoint - If we have a merge point of an "if condition" as
198 /// accepted above, return true if the specified value dominates the block.  We
199 /// don't handle the true generality of domination here, just a special case
200 /// which works well enough for us.
201 ///
202 /// If AggressiveInsts is non-null, and if V does not dominate BB, we check to
203 /// see if V (which must be an instruction) is cheap to compute and is
204 /// non-trapping.  If both are true, the instruction is inserted into the set
205 /// and true is returned.
206 static bool DominatesMergePoint(Value *V, BasicBlock *BB,
207                                 std::set<Instruction*> *AggressiveInsts) {
208   Instruction *I = dyn_cast<Instruction>(V);
209   if (!I) {
210     // Non-instructions all dominate instructions, but not all constantexprs
211     // can be executed unconditionally.
212     if (ConstantExpr *C = dyn_cast<ConstantExpr>(V))
213       if (C->canTrap())
214         return false;
215     return true;
216   }
217   BasicBlock *PBB = I->getParent();
218
219   // We don't want to allow weird loops that might have the "if condition" in
220   // the bottom of this block.
221   if (PBB == BB) return false;
222
223   // If this instruction is defined in a block that contains an unconditional
224   // branch to BB, then it must be in the 'conditional' part of the "if
225   // statement".
226   if (BranchInst *BI = dyn_cast<BranchInst>(PBB->getTerminator()))
227     if (BI->isUnconditional() && BI->getSuccessor(0) == BB) {
228       if (!AggressiveInsts) return false;
229       // Okay, it looks like the instruction IS in the "condition".  Check to
230       // see if it's a cheap instruction to unconditionally compute, and if it
231       // only uses stuff defined outside of the condition.  If so, hoist it out.
232       if (!I->isSafeToSpeculativelyExecute())
233         return false;
234
235       switch (I->getOpcode()) {
236       default: return false;  // Cannot hoist this out safely.
237       case Instruction::Load: {
238         // We have to check to make sure there are no instructions before the
239         // load in its basic block, as we are going to hoist the loop out to
240         // its predecessor.
241         BasicBlock::iterator IP = PBB->begin();
242         while (isa<DbgInfoIntrinsic>(IP))
243           IP++;
244         if (IP != BasicBlock::iterator(I))
245           return false;
246         break;
247       }
248       case Instruction::Add:
249       case Instruction::Sub:
250       case Instruction::And:
251       case Instruction::Or:
252       case Instruction::Xor:
253       case Instruction::Shl:
254       case Instruction::LShr:
255       case Instruction::AShr:
256       case Instruction::ICmp:
257         break;   // These are all cheap and non-trapping instructions.
258       }
259
260       // Okay, we can only really hoist these out if their operands are not
261       // defined in the conditional region.
262       for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i)
263         if (!DominatesMergePoint(*i, BB, 0))
264           return false;
265       // Okay, it's safe to do this!  Remember this instruction.
266       AggressiveInsts->insert(I);
267     }
268
269   return true;
270 }
271
272 /// GetConstantInt - Extract ConstantInt from value, looking through IntToPtr
273 /// and PointerNullValue. Return NULL if value is not a constant int.
274 static ConstantInt *GetConstantInt(Value *V, const TargetData *TD) {
275   // Normal constant int.
276   ConstantInt *CI = dyn_cast<ConstantInt>(V);
277   if (CI || !TD || !isa<Constant>(V) || !V->getType()->isPointerTy())
278     return CI;
279
280   // This is some kind of pointer constant. Turn it into a pointer-sized
281   // ConstantInt if possible.
282   const IntegerType *PtrTy = TD->getIntPtrType(V->getContext());
283
284   // Null pointer means 0, see SelectionDAGBuilder::getValue(const Value*).
285   if (isa<ConstantPointerNull>(V))
286     return ConstantInt::get(PtrTy, 0);
287
288   // IntToPtr const int.
289   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
290     if (CE->getOpcode() == Instruction::IntToPtr)
291       if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(0))) {
292         // The constant is very likely to have the right type already.
293         if (CI->getType() == PtrTy)
294           return CI;
295         else
296           return cast<ConstantInt>
297             (ConstantExpr::getIntegerCast(CI, PtrTy, /*isSigned=*/false));
298       }
299   return 0;
300 }
301
302 /// GatherConstantCompares - Given a potentially 'or'd or 'and'd together
303 /// collection of icmp eq/ne instructions that compare a value against a
304 /// constant, return the value being compared, and stick the constant into the
305 /// Values vector.
306 static Value *
307 GatherConstantCompares(Value *V, std::vector<ConstantInt*> &Vals, Value *&Extra,
308                        const TargetData *TD, bool isEQ) {
309   Instruction *I = dyn_cast<Instruction>(V);
310   if (I == 0) return 0;
311   
312   // If this is an icmp against a constant, handle this as one of the cases.
313   if (ICmpInst *ICI = dyn_cast<ICmpInst>(I)) {
314     if (ICI->getPredicate() == (isEQ ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_NE))
315       if (ConstantInt *C = GetConstantInt(I->getOperand(1), TD)) {
316         Vals.push_back(C);
317         return I->getOperand(0);
318       }
319     return 0;
320   }
321   
322   // Otherwise, we can only handle an | or &, depending on isEQ.
323   if (I->getOpcode() != (isEQ ? Instruction::Or : Instruction::And))
324     return 0;
325   
326   unsigned NumValsBeforeLHS = Vals.size();
327   if (Value *LHS = GatherConstantCompares(I->getOperand(0), Vals, Extra, TD,
328                                           isEQ)) {
329     unsigned NumVals = Vals.size();
330     if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
331                                             isEQ)) {
332       if (LHS == RHS)
333         return LHS;
334     }
335     Vals.resize(NumVals);
336
337     // The RHS of the or/and can't be folded in and we haven't used "Extra" yet,
338     // set it and return success.
339     if (Extra == 0 || Extra == I->getOperand(1)) {
340       Extra = I->getOperand(1);
341       return LHS;
342     }
343     
344     Vals.resize(NumValsBeforeLHS);
345     return 0;
346   }
347   
348   // If the LHS can't be folded in, but Extra is available and RHS can, try to
349   // use LHS as Extra.
350   if (Extra == 0 || Extra == I->getOperand(0)) {
351     Extra = I->getOperand(0);
352     if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
353                                             isEQ))
354       return RHS;
355     Vals.resize(NumValsBeforeLHS);
356     Extra = 0;
357   }
358   
359   return 0;
360 }
361       
362 static void EraseTerminatorInstAndDCECond(TerminatorInst *TI) {
363   Instruction* Cond = 0;
364   if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
365     Cond = dyn_cast<Instruction>(SI->getCondition());
366   } else if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
367     if (BI->isConditional())
368       Cond = dyn_cast<Instruction>(BI->getCondition());
369   } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(TI)) {
370     Cond = dyn_cast<Instruction>(IBI->getAddress());
371   }
372
373   TI->eraseFromParent();
374   if (Cond) RecursivelyDeleteTriviallyDeadInstructions(Cond);
375 }
376
377 /// isValueEqualityComparison - Return true if the specified terminator checks
378 /// to see if a value is equal to constant integer value.
379 Value *SimplifyCFGOpt::isValueEqualityComparison(TerminatorInst *TI) {
380   Value *CV = 0;
381   if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
382     // Do not permit merging of large switch instructions into their
383     // predecessors unless there is only one predecessor.
384     if (SI->getNumSuccessors()*std::distance(pred_begin(SI->getParent()),
385                                              pred_end(SI->getParent())) <= 128)
386       CV = SI->getCondition();
387   } else if (BranchInst *BI = dyn_cast<BranchInst>(TI))
388     if (BI->isConditional() && BI->getCondition()->hasOneUse())
389       if (ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition()))
390         if ((ICI->getPredicate() == ICmpInst::ICMP_EQ ||
391              ICI->getPredicate() == ICmpInst::ICMP_NE) &&
392             GetConstantInt(ICI->getOperand(1), TD))
393           CV = ICI->getOperand(0);
394
395   // Unwrap any lossless ptrtoint cast.
396   if (TD && CV && CV->getType() == TD->getIntPtrType(CV->getContext()))
397     if (PtrToIntInst *PTII = dyn_cast<PtrToIntInst>(CV))
398       CV = PTII->getOperand(0);
399   return CV;
400 }
401
402 /// GetValueEqualityComparisonCases - Given a value comparison instruction,
403 /// decode all of the 'cases' that it represents and return the 'default' block.
404 BasicBlock *SimplifyCFGOpt::
405 GetValueEqualityComparisonCases(TerminatorInst *TI,
406                                 std::vector<std::pair<ConstantInt*,
407                                                       BasicBlock*> > &Cases) {
408   if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
409     Cases.reserve(SI->getNumCases());
410     for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
411       Cases.push_back(std::make_pair(SI->getCaseValue(i), SI->getSuccessor(i)));
412     return SI->getDefaultDest();
413   }
414
415   BranchInst *BI = cast<BranchInst>(TI);
416   ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
417   Cases.push_back(std::make_pair(GetConstantInt(ICI->getOperand(1), TD),
418                                  BI->getSuccessor(ICI->getPredicate() ==
419                                                   ICmpInst::ICMP_NE)));
420   return BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_EQ);
421 }
422
423
424 /// EliminateBlockCases - Given a vector of bb/value pairs, remove any entries
425 /// in the list that match the specified block.
426 static void EliminateBlockCases(BasicBlock *BB,
427                std::vector<std::pair<ConstantInt*, BasicBlock*> > &Cases) {
428   for (unsigned i = 0, e = Cases.size(); i != e; ++i)
429     if (Cases[i].second == BB) {
430       Cases.erase(Cases.begin()+i);
431       --i; --e;
432     }
433 }
434
435 /// ValuesOverlap - Return true if there are any keys in C1 that exist in C2 as
436 /// well.
437 static bool
438 ValuesOverlap(std::vector<std::pair<ConstantInt*, BasicBlock*> > &C1,
439               std::vector<std::pair<ConstantInt*, BasicBlock*> > &C2) {
440   std::vector<std::pair<ConstantInt*, BasicBlock*> > *V1 = &C1, *V2 = &C2;
441
442   // Make V1 be smaller than V2.
443   if (V1->size() > V2->size())
444     std::swap(V1, V2);
445
446   if (V1->size() == 0) return false;
447   if (V1->size() == 1) {
448     // Just scan V2.
449     ConstantInt *TheVal = (*V1)[0].first;
450     for (unsigned i = 0, e = V2->size(); i != e; ++i)
451       if (TheVal == (*V2)[i].first)
452         return true;
453   }
454
455   // Otherwise, just sort both lists and compare element by element.
456   array_pod_sort(V1->begin(), V1->end());
457   array_pod_sort(V2->begin(), V2->end());
458   unsigned i1 = 0, i2 = 0, e1 = V1->size(), e2 = V2->size();
459   while (i1 != e1 && i2 != e2) {
460     if ((*V1)[i1].first == (*V2)[i2].first)
461       return true;
462     if ((*V1)[i1].first < (*V2)[i2].first)
463       ++i1;
464     else
465       ++i2;
466   }
467   return false;
468 }
469
470 /// SimplifyEqualityComparisonWithOnlyPredecessor - If TI is known to be a
471 /// terminator instruction and its block is known to only have a single
472 /// predecessor block, check to see if that predecessor is also a value
473 /// comparison with the same value, and if that comparison determines the
474 /// outcome of this comparison.  If so, simplify TI.  This does a very limited
475 /// form of jump threading.
476 bool SimplifyCFGOpt::
477 SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
478                                               BasicBlock *Pred) {
479   Value *PredVal = isValueEqualityComparison(Pred->getTerminator());
480   if (!PredVal) return false;  // Not a value comparison in predecessor.
481
482   Value *ThisVal = isValueEqualityComparison(TI);
483   assert(ThisVal && "This isn't a value comparison!!");
484   if (ThisVal != PredVal) return false;  // Different predicates.
485
486   // Find out information about when control will move from Pred to TI's block.
487   std::vector<std::pair<ConstantInt*, BasicBlock*> > PredCases;
488   BasicBlock *PredDef = GetValueEqualityComparisonCases(Pred->getTerminator(),
489                                                         PredCases);
490   EliminateBlockCases(PredDef, PredCases);  // Remove default from cases.
491
492   // Find information about how control leaves this block.
493   std::vector<std::pair<ConstantInt*, BasicBlock*> > ThisCases;
494   BasicBlock *ThisDef = GetValueEqualityComparisonCases(TI, ThisCases);
495   EliminateBlockCases(ThisDef, ThisCases);  // Remove default from cases.
496
497   // If TI's block is the default block from Pred's comparison, potentially
498   // simplify TI based on this knowledge.
499   if (PredDef == TI->getParent()) {
500     // If we are here, we know that the value is none of those cases listed in
501     // PredCases.  If there are any cases in ThisCases that are in PredCases, we
502     // can simplify TI.
503     if (!ValuesOverlap(PredCases, ThisCases))
504       return false;
505     
506     if (isa<BranchInst>(TI)) {
507       // Okay, one of the successors of this condbr is dead.  Convert it to a
508       // uncond br.
509       assert(ThisCases.size() == 1 && "Branch can only have one case!");
510       // Insert the new branch.
511       Instruction *NI = BranchInst::Create(ThisDef, TI);
512       (void) NI;
513
514       // Remove PHI node entries for the dead edge.
515       ThisCases[0].second->removePredecessor(TI->getParent());
516
517       DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
518            << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
519
520       EraseTerminatorInstAndDCECond(TI);
521       return true;
522     }
523       
524     SwitchInst *SI = cast<SwitchInst>(TI);
525     // Okay, TI has cases that are statically dead, prune them away.
526     SmallPtrSet<Constant*, 16> DeadCases;
527     for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
528       DeadCases.insert(PredCases[i].first);
529
530     DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
531                  << "Through successor TI: " << *TI);
532
533     for (unsigned i = SI->getNumCases()-1; i != 0; --i)
534       if (DeadCases.count(SI->getCaseValue(i))) {
535         SI->getSuccessor(i)->removePredecessor(TI->getParent());
536         SI->removeCase(i);
537       }
538
539     DEBUG(dbgs() << "Leaving: " << *TI << "\n");
540     return true;
541   }
542   
543   // Otherwise, TI's block must correspond to some matched value.  Find out
544   // which value (or set of values) this is.
545   ConstantInt *TIV = 0;
546   BasicBlock *TIBB = TI->getParent();
547   for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
548     if (PredCases[i].second == TIBB) {
549       if (TIV != 0)
550         return false;  // Cannot handle multiple values coming to this block.
551       TIV = PredCases[i].first;
552     }
553   assert(TIV && "No edge from pred to succ?");
554
555   // Okay, we found the one constant that our value can be if we get into TI's
556   // BB.  Find out which successor will unconditionally be branched to.
557   BasicBlock *TheRealDest = 0;
558   for (unsigned i = 0, e = ThisCases.size(); i != e; ++i)
559     if (ThisCases[i].first == TIV) {
560       TheRealDest = ThisCases[i].second;
561       break;
562     }
563
564   // If not handled by any explicit cases, it is handled by the default case.
565   if (TheRealDest == 0) TheRealDest = ThisDef;
566
567   // Remove PHI node entries for dead edges.
568   BasicBlock *CheckEdge = TheRealDest;
569   for (succ_iterator SI = succ_begin(TIBB), e = succ_end(TIBB); SI != e; ++SI)
570     if (*SI != CheckEdge)
571       (*SI)->removePredecessor(TIBB);
572     else
573       CheckEdge = 0;
574
575   // Insert the new branch.
576   Instruction *NI = BranchInst::Create(TheRealDest, TI);
577   (void) NI;
578
579   DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
580             << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
581
582   EraseTerminatorInstAndDCECond(TI);
583   return true;
584 }
585
586 namespace {
587   /// ConstantIntOrdering - This class implements a stable ordering of constant
588   /// integers that does not depend on their address.  This is important for
589   /// applications that sort ConstantInt's to ensure uniqueness.
590   struct ConstantIntOrdering {
591     bool operator()(const ConstantInt *LHS, const ConstantInt *RHS) const {
592       return LHS->getValue().ult(RHS->getValue());
593     }
594   };
595 }
596
597 static int ConstantIntSortPredicate(const void *P1, const void *P2) {
598   const ConstantInt *LHS = *(const ConstantInt**)P1;
599   const ConstantInt *RHS = *(const ConstantInt**)P2;
600   return LHS->getValue().ult(RHS->getValue());
601 }
602
603 /// FoldValueComparisonIntoPredecessors - The specified terminator is a value
604 /// equality comparison instruction (either a switch or a branch on "X == c").
605 /// See if any of the predecessors of the terminator block are value comparisons
606 /// on the same value.  If so, and if safe to do so, fold them together.
607 bool SimplifyCFGOpt::FoldValueComparisonIntoPredecessors(TerminatorInst *TI) {
608   BasicBlock *BB = TI->getParent();
609   Value *CV = isValueEqualityComparison(TI);  // CondVal
610   assert(CV && "Not a comparison?");
611   bool Changed = false;
612
613   SmallVector<BasicBlock*, 16> Preds(pred_begin(BB), pred_end(BB));
614   while (!Preds.empty()) {
615     BasicBlock *Pred = Preds.pop_back_val();
616
617     // See if the predecessor is a comparison with the same value.
618     TerminatorInst *PTI = Pred->getTerminator();
619     Value *PCV = isValueEqualityComparison(PTI);  // PredCondVal
620
621     if (PCV == CV && SafeToMergeTerminators(TI, PTI)) {
622       // Figure out which 'cases' to copy from SI to PSI.
623       std::vector<std::pair<ConstantInt*, BasicBlock*> > BBCases;
624       BasicBlock *BBDefault = GetValueEqualityComparisonCases(TI, BBCases);
625
626       std::vector<std::pair<ConstantInt*, BasicBlock*> > PredCases;
627       BasicBlock *PredDefault = GetValueEqualityComparisonCases(PTI, PredCases);
628
629       // Based on whether the default edge from PTI goes to BB or not, fill in
630       // PredCases and PredDefault with the new switch cases we would like to
631       // build.
632       SmallVector<BasicBlock*, 8> NewSuccessors;
633
634       if (PredDefault == BB) {
635         // If this is the default destination from PTI, only the edges in TI
636         // that don't occur in PTI, or that branch to BB will be activated.
637         std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
638         for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
639           if (PredCases[i].second != BB)
640             PTIHandled.insert(PredCases[i].first);
641           else {
642             // The default destination is BB, we don't need explicit targets.
643             std::swap(PredCases[i], PredCases.back());
644             PredCases.pop_back();
645             --i; --e;
646           }
647
648         // Reconstruct the new switch statement we will be building.
649         if (PredDefault != BBDefault) {
650           PredDefault->removePredecessor(Pred);
651           PredDefault = BBDefault;
652           NewSuccessors.push_back(BBDefault);
653         }
654         for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
655           if (!PTIHandled.count(BBCases[i].first) &&
656               BBCases[i].second != BBDefault) {
657             PredCases.push_back(BBCases[i]);
658             NewSuccessors.push_back(BBCases[i].second);
659           }
660
661       } else {
662         // If this is not the default destination from PSI, only the edges
663         // in SI that occur in PSI with a destination of BB will be
664         // activated.
665         std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
666         for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
667           if (PredCases[i].second == BB) {
668             PTIHandled.insert(PredCases[i].first);
669             std::swap(PredCases[i], PredCases.back());
670             PredCases.pop_back();
671             --i; --e;
672           }
673
674         // Okay, now we know which constants were sent to BB from the
675         // predecessor.  Figure out where they will all go now.
676         for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
677           if (PTIHandled.count(BBCases[i].first)) {
678             // If this is one we are capable of getting...
679             PredCases.push_back(BBCases[i]);
680             NewSuccessors.push_back(BBCases[i].second);
681             PTIHandled.erase(BBCases[i].first);// This constant is taken care of
682           }
683
684         // If there are any constants vectored to BB that TI doesn't handle,
685         // they must go to the default destination of TI.
686         for (std::set<ConstantInt*, ConstantIntOrdering>::iterator I = 
687                                     PTIHandled.begin(),
688                E = PTIHandled.end(); I != E; ++I) {
689           PredCases.push_back(std::make_pair(*I, BBDefault));
690           NewSuccessors.push_back(BBDefault);
691         }
692       }
693
694       // Okay, at this point, we know which new successor Pred will get.  Make
695       // sure we update the number of entries in the PHI nodes for these
696       // successors.
697       for (unsigned i = 0, e = NewSuccessors.size(); i != e; ++i)
698         AddPredecessorToBlock(NewSuccessors[i], Pred, BB);
699
700       // Convert pointer to int before we switch.
701       if (CV->getType()->isPointerTy()) {
702         assert(TD && "Cannot switch on pointer without TargetData");
703         CV = new PtrToIntInst(CV, TD->getIntPtrType(CV->getContext()),
704                               "magicptr", PTI);
705       }
706
707       // Now that the successors are updated, create the new Switch instruction.
708       SwitchInst *NewSI = SwitchInst::Create(CV, PredDefault,
709                                              PredCases.size(), PTI);
710       for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
711         NewSI->addCase(PredCases[i].first, PredCases[i].second);
712
713       EraseTerminatorInstAndDCECond(PTI);
714
715       // Okay, last check.  If BB is still a successor of PSI, then we must
716       // have an infinite loop case.  If so, add an infinitely looping block
717       // to handle the case to preserve the behavior of the code.
718       BasicBlock *InfLoopBlock = 0;
719       for (unsigned i = 0, e = NewSI->getNumSuccessors(); i != e; ++i)
720         if (NewSI->getSuccessor(i) == BB) {
721           if (InfLoopBlock == 0) {
722             // Insert it at the end of the function, because it's either code,
723             // or it won't matter if it's hot. :)
724             InfLoopBlock = BasicBlock::Create(BB->getContext(),
725                                               "infloop", BB->getParent());
726             BranchInst::Create(InfLoopBlock, InfLoopBlock);
727           }
728           NewSI->setSuccessor(i, InfLoopBlock);
729         }
730
731       Changed = true;
732     }
733   }
734   return Changed;
735 }
736
737 // isSafeToHoistInvoke - If we would need to insert a select that uses the
738 // value of this invoke (comments in HoistThenElseCodeToIf explain why we
739 // would need to do this), we can't hoist the invoke, as there is nowhere
740 // to put the select in this case.
741 static bool isSafeToHoistInvoke(BasicBlock *BB1, BasicBlock *BB2,
742                                 Instruction *I1, Instruction *I2) {
743   for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
744     PHINode *PN;
745     for (BasicBlock::iterator BBI = SI->begin();
746          (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
747       Value *BB1V = PN->getIncomingValueForBlock(BB1);
748       Value *BB2V = PN->getIncomingValueForBlock(BB2);
749       if (BB1V != BB2V && (BB1V==I1 || BB2V==I2)) {
750         return false;
751       }
752     }
753   }
754   return true;
755 }
756
757 /// HoistThenElseCodeToIf - Given a conditional branch that goes to BB1 and
758 /// BB2, hoist any common code in the two blocks up into the branch block.  The
759 /// caller of this function guarantees that BI's block dominates BB1 and BB2.
760 static bool HoistThenElseCodeToIf(BranchInst *BI) {
761   // This does very trivial matching, with limited scanning, to find identical
762   // instructions in the two blocks.  In particular, we don't want to get into
763   // O(M*N) situations here where M and N are the sizes of BB1 and BB2.  As
764   // such, we currently just scan for obviously identical instructions in an
765   // identical order.
766   BasicBlock *BB1 = BI->getSuccessor(0);  // The true destination.
767   BasicBlock *BB2 = BI->getSuccessor(1);  // The false destination
768
769   BasicBlock::iterator BB1_Itr = BB1->begin();
770   BasicBlock::iterator BB2_Itr = BB2->begin();
771
772   Instruction *I1 = BB1_Itr++, *I2 = BB2_Itr++;
773   while (isa<DbgInfoIntrinsic>(I1))
774     I1 = BB1_Itr++;
775   while (isa<DbgInfoIntrinsic>(I2))
776     I2 = BB2_Itr++;
777   if (I1->getOpcode() != I2->getOpcode() || isa<PHINode>(I1) ||
778       !I1->isIdenticalToWhenDefined(I2) ||
779       (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2)))
780     return false;
781
782   // If we get here, we can hoist at least one instruction.
783   BasicBlock *BIParent = BI->getParent();
784
785   do {
786     // If we are hoisting the terminator instruction, don't move one (making a
787     // broken BB), instead clone it, and remove BI.
788     if (isa<TerminatorInst>(I1))
789       goto HoistTerminator;
790
791     // For a normal instruction, we just move one to right before the branch,
792     // then replace all uses of the other with the first.  Finally, we remove
793     // the now redundant second instruction.
794     BIParent->getInstList().splice(BI, BB1->getInstList(), I1);
795     if (!I2->use_empty())
796       I2->replaceAllUsesWith(I1);
797     I1->intersectOptionalDataWith(I2);
798     BB2->getInstList().erase(I2);
799
800     I1 = BB1_Itr++;
801     while (isa<DbgInfoIntrinsic>(I1))
802       I1 = BB1_Itr++;
803     I2 = BB2_Itr++;
804     while (isa<DbgInfoIntrinsic>(I2))
805       I2 = BB2_Itr++;
806   } while (I1->getOpcode() == I2->getOpcode() &&
807            I1->isIdenticalToWhenDefined(I2));
808
809   return true;
810
811 HoistTerminator:
812   // It may not be possible to hoist an invoke.
813   if (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2))
814     return true;
815
816   // Okay, it is safe to hoist the terminator.
817   Instruction *NT = I1->clone();
818   BIParent->getInstList().insert(BI, NT);
819   if (!NT->getType()->isVoidTy()) {
820     I1->replaceAllUsesWith(NT);
821     I2->replaceAllUsesWith(NT);
822     NT->takeName(I1);
823   }
824
825   // Hoisting one of the terminators from our successor is a great thing.
826   // Unfortunately, the successors of the if/else blocks may have PHI nodes in
827   // them.  If they do, all PHI entries for BB1/BB2 must agree for all PHI
828   // nodes, so we insert select instruction to compute the final result.
829   std::map<std::pair<Value*,Value*>, SelectInst*> InsertedSelects;
830   for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
831     PHINode *PN;
832     for (BasicBlock::iterator BBI = SI->begin();
833          (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
834       Value *BB1V = PN->getIncomingValueForBlock(BB1);
835       Value *BB2V = PN->getIncomingValueForBlock(BB2);
836       if (BB1V == BB2V) continue;
837       
838       // These values do not agree.  Insert a select instruction before NT
839       // that determines the right value.
840       SelectInst *&SI = InsertedSelects[std::make_pair(BB1V, BB2V)];
841       if (SI == 0)
842         SI = SelectInst::Create(BI->getCondition(), BB1V, BB2V,
843                                 BB1V->getName()+"."+BB2V->getName(), NT);
844       // Make the PHI node use the select for all incoming values for BB1/BB2
845       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
846         if (PN->getIncomingBlock(i) == BB1 || PN->getIncomingBlock(i) == BB2)
847           PN->setIncomingValue(i, SI);
848     }
849   }
850
851   // Update any PHI nodes in our new successors.
852   for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI)
853     AddPredecessorToBlock(*SI, BIParent, BB1);
854
855   EraseTerminatorInstAndDCECond(BI);
856   return true;
857 }
858
859 /// SpeculativelyExecuteBB - Given a conditional branch that goes to BB1
860 /// and an BB2 and the only successor of BB1 is BB2, hoist simple code
861 /// (for now, restricted to a single instruction that's side effect free) from
862 /// the BB1 into the branch block to speculatively execute it.
863 static bool SpeculativelyExecuteBB(BranchInst *BI, BasicBlock *BB1) {
864   // Only speculatively execution a single instruction (not counting the
865   // terminator) for now.
866   Instruction *HInst = NULL;
867   Instruction *Term = BB1->getTerminator();
868   for (BasicBlock::iterator BBI = BB1->begin(), BBE = BB1->end();
869        BBI != BBE; ++BBI) {
870     Instruction *I = BBI;
871     // Skip debug info.
872     if (isa<DbgInfoIntrinsic>(I)) continue;
873     if (I == Term) break;
874
875     if (HInst)
876       return false;
877     HInst = I;
878   }
879   if (!HInst)
880     return false;
881
882   // Be conservative for now. FP select instruction can often be expensive.
883   Value *BrCond = BI->getCondition();
884   if (isa<FCmpInst>(BrCond))
885     return false;
886
887   // If BB1 is actually on the false edge of the conditional branch, remember
888   // to swap the select operands later.
889   bool Invert = false;
890   if (BB1 != BI->getSuccessor(0)) {
891     assert(BB1 == BI->getSuccessor(1) && "No edge from 'if' block?");
892     Invert = true;
893   }
894
895   // Turn
896   // BB:
897   //     %t1 = icmp
898   //     br i1 %t1, label %BB1, label %BB2
899   // BB1:
900   //     %t3 = add %t2, c
901   //     br label BB2
902   // BB2:
903   // =>
904   // BB:
905   //     %t1 = icmp
906   //     %t4 = add %t2, c
907   //     %t3 = select i1 %t1, %t2, %t3
908   switch (HInst->getOpcode()) {
909   default: return false;  // Not safe / profitable to hoist.
910   case Instruction::Add:
911   case Instruction::Sub:
912     // Not worth doing for vector ops.
913     if (HInst->getType()->isVectorTy())
914       return false;
915     break;
916   case Instruction::And:
917   case Instruction::Or:
918   case Instruction::Xor:
919   case Instruction::Shl:
920   case Instruction::LShr:
921   case Instruction::AShr:
922     // Don't mess with vector operations.
923     if (HInst->getType()->isVectorTy())
924       return false;
925     break;   // These are all cheap and non-trapping instructions.
926   }
927   
928   // If the instruction is obviously dead, don't try to predicate it.
929   if (HInst->use_empty()) {
930     HInst->eraseFromParent();
931     return true;
932   }
933
934   // Can we speculatively execute the instruction? And what is the value 
935   // if the condition is false? Consider the phi uses, if the incoming value
936   // from the "if" block are all the same V, then V is the value of the
937   // select if the condition is false.
938   BasicBlock *BIParent = BI->getParent();
939   SmallVector<PHINode*, 4> PHIUses;
940   Value *FalseV = NULL;
941   
942   BasicBlock *BB2 = BB1->getTerminator()->getSuccessor(0);
943   for (Value::use_iterator UI = HInst->use_begin(), E = HInst->use_end();
944        UI != E; ++UI) {
945     // Ignore any user that is not a PHI node in BB2.  These can only occur in
946     // unreachable blocks, because they would not be dominated by the instr.
947     PHINode *PN = dyn_cast<PHINode>(*UI);
948     if (!PN || PN->getParent() != BB2)
949       return false;
950     PHIUses.push_back(PN);
951     
952     Value *PHIV = PN->getIncomingValueForBlock(BIParent);
953     if (!FalseV)
954       FalseV = PHIV;
955     else if (FalseV != PHIV)
956       return false;  // Inconsistent value when condition is false.
957   }
958   
959   assert(FalseV && "Must have at least one user, and it must be a PHI");
960
961   // Do not hoist the instruction if any of its operands are defined but not
962   // used in this BB. The transformation will prevent the operand from
963   // being sunk into the use block.
964   for (User::op_iterator i = HInst->op_begin(), e = HInst->op_end(); 
965        i != e; ++i) {
966     Instruction *OpI = dyn_cast<Instruction>(*i);
967     if (OpI && OpI->getParent() == BIParent &&
968         !OpI->isUsedInBasicBlock(BIParent))
969       return false;
970   }
971
972   // If we get here, we can hoist the instruction. Try to place it
973   // before the icmp instruction preceding the conditional branch.
974   BasicBlock::iterator InsertPos = BI;
975   if (InsertPos != BIParent->begin())
976     --InsertPos;
977   // Skip debug info between condition and branch.
978   while (InsertPos != BIParent->begin() && isa<DbgInfoIntrinsic>(InsertPos))
979     --InsertPos;
980   if (InsertPos == BrCond && !isa<PHINode>(BrCond)) {
981     SmallPtrSet<Instruction *, 4> BB1Insns;
982     for(BasicBlock::iterator BB1I = BB1->begin(), BB1E = BB1->end(); 
983         BB1I != BB1E; ++BB1I) 
984       BB1Insns.insert(BB1I);
985     for(Value::use_iterator UI = BrCond->use_begin(), UE = BrCond->use_end();
986         UI != UE; ++UI) {
987       Instruction *Use = cast<Instruction>(*UI);
988       if (!BB1Insns.count(Use)) continue;
989       
990       // If BrCond uses the instruction that place it just before
991       // branch instruction.
992       InsertPos = BI;
993       break;
994     }
995   } else
996     InsertPos = BI;
997   BIParent->getInstList().splice(InsertPos, BB1->getInstList(), HInst);
998
999   // Create a select whose true value is the speculatively executed value and
1000   // false value is the previously determined FalseV.
1001   SelectInst *SI;
1002   if (Invert)
1003     SI = SelectInst::Create(BrCond, FalseV, HInst,
1004                             FalseV->getName() + "." + HInst->getName(), BI);
1005   else
1006     SI = SelectInst::Create(BrCond, HInst, FalseV,
1007                             HInst->getName() + "." + FalseV->getName(), BI);
1008
1009   // Make the PHI node use the select for all incoming values for "then" and
1010   // "if" blocks.
1011   for (unsigned i = 0, e = PHIUses.size(); i != e; ++i) {
1012     PHINode *PN = PHIUses[i];
1013     for (unsigned j = 0, ee = PN->getNumIncomingValues(); j != ee; ++j)
1014       if (PN->getIncomingBlock(j) == BB1 || PN->getIncomingBlock(j) == BIParent)
1015         PN->setIncomingValue(j, SI);
1016   }
1017
1018   ++NumSpeculations;
1019   return true;
1020 }
1021
1022 /// BlockIsSimpleEnoughToThreadThrough - Return true if we can thread a branch
1023 /// across this block.
1024 static bool BlockIsSimpleEnoughToThreadThrough(BasicBlock *BB) {
1025   BranchInst *BI = cast<BranchInst>(BB->getTerminator());
1026   unsigned Size = 0;
1027   
1028   for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
1029     if (isa<DbgInfoIntrinsic>(BBI))
1030       continue;
1031     if (Size > 10) return false;  // Don't clone large BB's.
1032     ++Size;
1033     
1034     // We can only support instructions that do not define values that are
1035     // live outside of the current basic block.
1036     for (Value::use_iterator UI = BBI->use_begin(), E = BBI->use_end();
1037          UI != E; ++UI) {
1038       Instruction *U = cast<Instruction>(*UI);
1039       if (U->getParent() != BB || isa<PHINode>(U)) return false;
1040     }
1041     
1042     // Looks ok, continue checking.
1043   }
1044
1045   return true;
1046 }
1047
1048 /// FoldCondBranchOnPHI - If we have a conditional branch on a PHI node value
1049 /// that is defined in the same block as the branch and if any PHI entries are
1050 /// constants, thread edges corresponding to that entry to be branches to their
1051 /// ultimate destination.
1052 static bool FoldCondBranchOnPHI(BranchInst *BI) {
1053   BasicBlock *BB = BI->getParent();
1054   PHINode *PN = dyn_cast<PHINode>(BI->getCondition());
1055   // NOTE: we currently cannot transform this case if the PHI node is used
1056   // outside of the block.
1057   if (!PN || PN->getParent() != BB || !PN->hasOneUse())
1058     return false;
1059   
1060   // Degenerate case of a single entry PHI.
1061   if (PN->getNumIncomingValues() == 1) {
1062     FoldSingleEntryPHINodes(PN->getParent());
1063     return true;    
1064   }
1065
1066   // Now we know that this block has multiple preds and two succs.
1067   if (!BlockIsSimpleEnoughToThreadThrough(BB)) return false;
1068   
1069   // Okay, this is a simple enough basic block.  See if any phi values are
1070   // constants.
1071   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1072     ConstantInt *CB = dyn_cast<ConstantInt>(PN->getIncomingValue(i));
1073     if (CB == 0 || !CB->getType()->isIntegerTy(1)) continue;
1074     
1075     // Okay, we now know that all edges from PredBB should be revectored to
1076     // branch to RealDest.
1077     BasicBlock *PredBB = PN->getIncomingBlock(i);
1078     BasicBlock *RealDest = BI->getSuccessor(!CB->getZExtValue());
1079     
1080     if (RealDest == BB) continue;  // Skip self loops.
1081     
1082     // The dest block might have PHI nodes, other predecessors and other
1083     // difficult cases.  Instead of being smart about this, just insert a new
1084     // block that jumps to the destination block, effectively splitting
1085     // the edge we are about to create.
1086     BasicBlock *EdgeBB = BasicBlock::Create(BB->getContext(),
1087                                             RealDest->getName()+".critedge",
1088                                             RealDest->getParent(), RealDest);
1089     BranchInst::Create(RealDest, EdgeBB);
1090     PHINode *PN;
1091     for (BasicBlock::iterator BBI = RealDest->begin();
1092          (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1093       Value *V = PN->getIncomingValueForBlock(BB);
1094       PN->addIncoming(V, EdgeBB);
1095     }
1096
1097     // BB may have instructions that are being threaded over.  Clone these
1098     // instructions into EdgeBB.  We know that there will be no uses of the
1099     // cloned instructions outside of EdgeBB.
1100     BasicBlock::iterator InsertPt = EdgeBB->begin();
1101     DenseMap<Value*, Value*> TranslateMap;  // Track translated values.
1102     for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
1103       if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
1104         TranslateMap[PN] = PN->getIncomingValueForBlock(PredBB);
1105         continue;
1106       }
1107       // Clone the instruction.
1108       Instruction *N = BBI->clone();
1109       if (BBI->hasName()) N->setName(BBI->getName()+".c");
1110       
1111       // Update operands due to translation.
1112       for (User::op_iterator i = N->op_begin(), e = N->op_end();
1113            i != e; ++i) {
1114         DenseMap<Value*, Value*>::iterator PI = TranslateMap.find(*i);
1115         if (PI != TranslateMap.end())
1116           *i = PI->second;
1117       }
1118       
1119       // Check for trivial simplification.
1120       if (Constant *C = ConstantFoldInstruction(N)) {
1121         TranslateMap[BBI] = C;
1122         delete N;   // Constant folded away, don't need actual inst
1123       } else {
1124         // Insert the new instruction into its new home.
1125         EdgeBB->getInstList().insert(InsertPt, N);
1126         if (!BBI->use_empty())
1127           TranslateMap[BBI] = N;
1128       }
1129     }
1130
1131     // Loop over all of the edges from PredBB to BB, changing them to branch
1132     // to EdgeBB instead.
1133     TerminatorInst *PredBBTI = PredBB->getTerminator();
1134     for (unsigned i = 0, e = PredBBTI->getNumSuccessors(); i != e; ++i)
1135       if (PredBBTI->getSuccessor(i) == BB) {
1136         BB->removePredecessor(PredBB);
1137         PredBBTI->setSuccessor(i, EdgeBB);
1138       }
1139     
1140     // Recurse, simplifying any other constants.
1141     return FoldCondBranchOnPHI(BI) | true;
1142   }
1143
1144   return false;
1145 }
1146
1147 /// FoldTwoEntryPHINode - Given a BB that starts with the specified two-entry
1148 /// PHI node, see if we can eliminate it.
1149 static bool FoldTwoEntryPHINode(PHINode *PN) {
1150   // Ok, this is a two entry PHI node.  Check to see if this is a simple "if
1151   // statement", which has a very simple dominance structure.  Basically, we
1152   // are trying to find the condition that is being branched on, which
1153   // subsequently causes this merge to happen.  We really want control
1154   // dependence information for this check, but simplifycfg can't keep it up
1155   // to date, and this catches most of the cases we care about anyway.
1156   //
1157   BasicBlock *BB = PN->getParent();
1158   BasicBlock *IfTrue, *IfFalse;
1159   Value *IfCond = GetIfCondition(BB, IfTrue, IfFalse);
1160   if (!IfCond) return false;
1161   
1162   // Okay, we found that we can merge this two-entry phi node into a select.
1163   // Doing so would require us to fold *all* two entry phi nodes in this block.
1164   // At some point this becomes non-profitable (particularly if the target
1165   // doesn't support cmov's).  Only do this transformation if there are two or
1166   // fewer PHI nodes in this block.
1167   unsigned NumPhis = 0;
1168   for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++NumPhis, ++I)
1169     if (NumPhis > 2)
1170       return false;
1171   
1172   DEBUG(dbgs() << "FOUND IF CONDITION!  " << *IfCond << "  T: "
1173         << IfTrue->getName() << "  F: " << IfFalse->getName() << "\n");
1174   
1175   // Loop over the PHI's seeing if we can promote them all to select
1176   // instructions.  While we are at it, keep track of the instructions
1177   // that need to be moved to the dominating block.
1178   std::set<Instruction*> AggressiveInsts;
1179   
1180   BasicBlock::iterator AfterPHIIt = BB->begin();
1181   while (isa<PHINode>(AfterPHIIt)) {
1182     PHINode *PN = cast<PHINode>(AfterPHIIt++);
1183     if (PN->getIncomingValue(0) == PN->getIncomingValue(1)) {
1184       if (PN->getIncomingValue(0) != PN)
1185         PN->replaceAllUsesWith(PN->getIncomingValue(0));
1186       else
1187         PN->replaceAllUsesWith(UndefValue::get(PN->getType()));
1188     } else if (!DominatesMergePoint(PN->getIncomingValue(0), BB,
1189                                     &AggressiveInsts) ||
1190                !DominatesMergePoint(PN->getIncomingValue(1), BB,
1191                                     &AggressiveInsts)) {
1192       return false;
1193     }
1194   }
1195   
1196   // If we all PHI nodes are promotable, check to make sure that all
1197   // instructions in the predecessor blocks can be promoted as well.  If
1198   // not, we won't be able to get rid of the control flow, so it's not
1199   // worth promoting to select instructions.
1200   BasicBlock *DomBlock = 0, *IfBlock1 = 0, *IfBlock2 = 0;
1201   PN = cast<PHINode>(BB->begin());
1202   BasicBlock *Pred = PN->getIncomingBlock(0);
1203   if (cast<BranchInst>(Pred->getTerminator())->isUnconditional()) {
1204     IfBlock1 = Pred;
1205     DomBlock = *pred_begin(Pred);
1206     for (BasicBlock::iterator I = Pred->begin();
1207          !isa<TerminatorInst>(I); ++I)
1208       if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
1209         // This is not an aggressive instruction that we can promote.
1210         // Because of this, we won't be able to get rid of the control
1211         // flow, so the xform is not worth it.
1212         return false;
1213       }
1214   }
1215     
1216   Pred = PN->getIncomingBlock(1);
1217   if (cast<BranchInst>(Pred->getTerminator())->isUnconditional()) {
1218     IfBlock2 = Pred;
1219     DomBlock = *pred_begin(Pred);
1220     for (BasicBlock::iterator I = Pred->begin();
1221          !isa<TerminatorInst>(I); ++I)
1222       if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
1223         // This is not an aggressive instruction that we can promote.
1224         // Because of this, we won't be able to get rid of the control
1225         // flow, so the xform is not worth it.
1226         return false;
1227       }
1228   }
1229       
1230   // If we can still promote the PHI nodes after this gauntlet of tests,
1231   // do all of the PHI's now.
1232
1233   // Move all 'aggressive' instructions, which are defined in the
1234   // conditional parts of the if's up to the dominating block.
1235   if (IfBlock1)
1236     DomBlock->getInstList().splice(DomBlock->getTerminator(),
1237                                    IfBlock1->getInstList(), IfBlock1->begin(),
1238                                    IfBlock1->getTerminator());
1239   if (IfBlock2)
1240     DomBlock->getInstList().splice(DomBlock->getTerminator(),
1241                                    IfBlock2->getInstList(), IfBlock2->begin(),
1242                                    IfBlock2->getTerminator());
1243   
1244   while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
1245     // Change the PHI node into a select instruction.
1246     Value *TrueVal  = PN->getIncomingValue(PN->getIncomingBlock(0) == IfFalse);
1247     Value *FalseVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfTrue);
1248     
1249     Value *NV = SelectInst::Create(IfCond, TrueVal, FalseVal, "", AfterPHIIt);
1250     PN->replaceAllUsesWith(NV);
1251     NV->takeName(PN);
1252     
1253     BB->getInstList().erase(PN);
1254   }
1255   return true;
1256 }
1257
1258 /// SimplifyCondBranchToTwoReturns - If we found a conditional branch that goes
1259 /// to two returning blocks, try to merge them together into one return,
1260 /// introducing a select if the return values disagree.
1261 static bool SimplifyCondBranchToTwoReturns(BranchInst *BI) {
1262   assert(BI->isConditional() && "Must be a conditional branch");
1263   BasicBlock *TrueSucc = BI->getSuccessor(0);
1264   BasicBlock *FalseSucc = BI->getSuccessor(1);
1265   ReturnInst *TrueRet = cast<ReturnInst>(TrueSucc->getTerminator());
1266   ReturnInst *FalseRet = cast<ReturnInst>(FalseSucc->getTerminator());
1267   
1268   // Check to ensure both blocks are empty (just a return) or optionally empty
1269   // with PHI nodes.  If there are other instructions, merging would cause extra
1270   // computation on one path or the other.
1271   if (!TrueSucc->getFirstNonPHIOrDbg()->isTerminator())
1272     return false;
1273   if (!FalseSucc->getFirstNonPHIOrDbg()->isTerminator())
1274     return false;
1275
1276   // Okay, we found a branch that is going to two return nodes.  If
1277   // there is no return value for this function, just change the
1278   // branch into a return.
1279   if (FalseRet->getNumOperands() == 0) {
1280     TrueSucc->removePredecessor(BI->getParent());
1281     FalseSucc->removePredecessor(BI->getParent());
1282     ReturnInst::Create(BI->getContext(), 0, BI);
1283     EraseTerminatorInstAndDCECond(BI);
1284     return true;
1285   }
1286     
1287   // Otherwise, figure out what the true and false return values are
1288   // so we can insert a new select instruction.
1289   Value *TrueValue = TrueRet->getReturnValue();
1290   Value *FalseValue = FalseRet->getReturnValue();
1291   
1292   // Unwrap any PHI nodes in the return blocks.
1293   if (PHINode *TVPN = dyn_cast_or_null<PHINode>(TrueValue))
1294     if (TVPN->getParent() == TrueSucc)
1295       TrueValue = TVPN->getIncomingValueForBlock(BI->getParent());
1296   if (PHINode *FVPN = dyn_cast_or_null<PHINode>(FalseValue))
1297     if (FVPN->getParent() == FalseSucc)
1298       FalseValue = FVPN->getIncomingValueForBlock(BI->getParent());
1299   
1300   // In order for this transformation to be safe, we must be able to
1301   // unconditionally execute both operands to the return.  This is
1302   // normally the case, but we could have a potentially-trapping
1303   // constant expression that prevents this transformation from being
1304   // safe.
1305   if (ConstantExpr *TCV = dyn_cast_or_null<ConstantExpr>(TrueValue))
1306     if (TCV->canTrap())
1307       return false;
1308   if (ConstantExpr *FCV = dyn_cast_or_null<ConstantExpr>(FalseValue))
1309     if (FCV->canTrap())
1310       return false;
1311   
1312   // Okay, we collected all the mapped values and checked them for sanity, and
1313   // defined to really do this transformation.  First, update the CFG.
1314   TrueSucc->removePredecessor(BI->getParent());
1315   FalseSucc->removePredecessor(BI->getParent());
1316   
1317   // Insert select instructions where needed.
1318   Value *BrCond = BI->getCondition();
1319   if (TrueValue) {
1320     // Insert a select if the results differ.
1321     if (TrueValue == FalseValue || isa<UndefValue>(FalseValue)) {
1322     } else if (isa<UndefValue>(TrueValue)) {
1323       TrueValue = FalseValue;
1324     } else {
1325       TrueValue = SelectInst::Create(BrCond, TrueValue,
1326                                      FalseValue, "retval", BI);
1327     }
1328   }
1329
1330   Value *RI = !TrueValue ?
1331               ReturnInst::Create(BI->getContext(), BI) :
1332               ReturnInst::Create(BI->getContext(), TrueValue, BI);
1333   (void) RI;
1334       
1335   DEBUG(dbgs() << "\nCHANGING BRANCH TO TWO RETURNS INTO SELECT:"
1336                << "\n  " << *BI << "NewRet = " << *RI
1337                << "TRUEBLOCK: " << *TrueSucc << "FALSEBLOCK: "<< *FalseSucc);
1338       
1339   EraseTerminatorInstAndDCECond(BI);
1340
1341   return true;
1342 }
1343
1344 /// FoldBranchToCommonDest - If this basic block is ONLY a setcc and a branch,
1345 /// and if a predecessor branches to us and one of our successors, fold the
1346 /// setcc into the predecessor and use logical operations to pick the right
1347 /// destination.
1348 bool llvm::FoldBranchToCommonDest(BranchInst *BI) {
1349   BasicBlock *BB = BI->getParent();
1350   Instruction *Cond = dyn_cast<Instruction>(BI->getCondition());
1351   if (Cond == 0 || (!isa<CmpInst>(Cond) && !isa<BinaryOperator>(Cond)) ||
1352     Cond->getParent() != BB || !Cond->hasOneUse())
1353   return false;
1354   
1355   // Only allow this if the condition is a simple instruction that can be
1356   // executed unconditionally.  It must be in the same block as the branch, and
1357   // must be at the front of the block.
1358   BasicBlock::iterator FrontIt = BB->front();
1359   // Ignore dbg intrinsics.
1360   while (isa<DbgInfoIntrinsic>(FrontIt))
1361     ++FrontIt;
1362     
1363   // Allow a single instruction to be hoisted in addition to the compare
1364   // that feeds the branch.  We later ensure that any values that _it_ uses
1365   // were also live in the predecessor, so that we don't unnecessarily create
1366   // register pressure or inhibit out-of-order execution.
1367   Instruction *BonusInst = 0;
1368   if (&*FrontIt != Cond &&
1369       FrontIt->hasOneUse() && *FrontIt->use_begin() == Cond &&
1370       FrontIt->isSafeToSpeculativelyExecute()) {
1371     BonusInst = &*FrontIt;
1372     ++FrontIt;
1373   }
1374   
1375   // Only a single bonus inst is allowed.
1376   if (&*FrontIt != Cond)
1377     return false;
1378   
1379   // Make sure the instruction after the condition is the cond branch.
1380   BasicBlock::iterator CondIt = Cond; ++CondIt;
1381   // Ingore dbg intrinsics.
1382   while(isa<DbgInfoIntrinsic>(CondIt))
1383     ++CondIt;
1384   if (&*CondIt != BI) {
1385     assert (!isa<DbgInfoIntrinsic>(CondIt) && "Hey do not forget debug info!");
1386     return false;
1387   }
1388
1389   // Cond is known to be a compare or binary operator.  Check to make sure that
1390   // neither operand is a potentially-trapping constant expression.
1391   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(0)))
1392     if (CE->canTrap())
1393       return false;
1394   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(1)))
1395     if (CE->canTrap())
1396       return false;
1397   
1398   
1399   // Finally, don't infinitely unroll conditional loops.
1400   BasicBlock *TrueDest  = BI->getSuccessor(0);
1401   BasicBlock *FalseDest = BI->getSuccessor(1);
1402   if (TrueDest == BB || FalseDest == BB)
1403     return false;
1404   
1405   for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
1406     BasicBlock *PredBlock = *PI;
1407     BranchInst *PBI = dyn_cast<BranchInst>(PredBlock->getTerminator());
1408     
1409     // Check that we have two conditional branches.  If there is a PHI node in
1410     // the common successor, verify that the same value flows in from both
1411     // blocks.
1412     if (PBI == 0 || PBI->isUnconditional() ||
1413         !SafeToMergeTerminators(BI, PBI))
1414       continue;
1415     
1416     // Ensure that any values used in the bonus instruction are also used
1417     // by the terminator of the predecessor.  This means that those values
1418     // must already have been resolved, so we won't be inhibiting the 
1419     // out-of-order core by speculating them earlier.
1420     if (BonusInst) {
1421       // Collect the values used by the bonus inst
1422       SmallPtrSet<Value*, 4> UsedValues;
1423       for (Instruction::op_iterator OI = BonusInst->op_begin(),
1424            OE = BonusInst->op_end(); OI != OE; ++OI) {
1425         Value* V = *OI;
1426         if (!isa<Constant>(V))
1427           UsedValues.insert(V);
1428       }
1429
1430       SmallVector<std::pair<Value*, unsigned>, 4> Worklist;
1431       Worklist.push_back(std::make_pair(PBI->getOperand(0), 0));
1432       
1433       // Walk up to four levels back up the use-def chain of the predecessor's
1434       // terminator to see if all those values were used.  The choice of four
1435       // levels is arbitrary, to provide a compile-time-cost bound.
1436       while (!Worklist.empty()) {
1437         std::pair<Value*, unsigned> Pair = Worklist.back();
1438         Worklist.pop_back();
1439         
1440         if (Pair.second >= 4) continue;
1441         UsedValues.erase(Pair.first);
1442         if (UsedValues.empty()) break;
1443         
1444         if (Instruction *I = dyn_cast<Instruction>(Pair.first)) {
1445           for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
1446                OI != OE; ++OI)
1447             Worklist.push_back(std::make_pair(OI->get(), Pair.second+1));
1448         }       
1449       }
1450       
1451       if (!UsedValues.empty()) return false;
1452     }
1453     
1454     Instruction::BinaryOps Opc;
1455     bool InvertPredCond = false;
1456
1457     if (PBI->getSuccessor(0) == TrueDest)
1458       Opc = Instruction::Or;
1459     else if (PBI->getSuccessor(1) == FalseDest)
1460       Opc = Instruction::And;
1461     else if (PBI->getSuccessor(0) == FalseDest)
1462       Opc = Instruction::And, InvertPredCond = true;
1463     else if (PBI->getSuccessor(1) == TrueDest)
1464       Opc = Instruction::Or, InvertPredCond = true;
1465     else
1466       continue;
1467
1468     DEBUG(dbgs() << "FOLDING BRANCH TO COMMON DEST:\n" << *PBI << *BB);
1469     
1470     // If we need to invert the condition in the pred block to match, do so now.
1471     if (InvertPredCond) {
1472       Value *NewCond = PBI->getCondition();
1473       
1474       if (NewCond->hasOneUse() && isa<CmpInst>(NewCond)) {
1475         CmpInst *CI = cast<CmpInst>(NewCond);
1476         CI->setPredicate(CI->getInversePredicate());
1477       } else {
1478         NewCond = BinaryOperator::CreateNot(NewCond,
1479                                   PBI->getCondition()->getName()+".not", PBI);
1480       }
1481       
1482       PBI->setCondition(NewCond);
1483       BasicBlock *OldTrue = PBI->getSuccessor(0);
1484       BasicBlock *OldFalse = PBI->getSuccessor(1);
1485       PBI->setSuccessor(0, OldFalse);
1486       PBI->setSuccessor(1, OldTrue);
1487     }
1488     
1489     // If we have a bonus inst, clone it into the predecessor block.
1490     Instruction *NewBonus = 0;
1491     if (BonusInst) {
1492       NewBonus = BonusInst->clone();
1493       PredBlock->getInstList().insert(PBI, NewBonus);
1494       NewBonus->takeName(BonusInst);
1495       BonusInst->setName(BonusInst->getName()+".old");
1496     }
1497     
1498     // Clone Cond into the predecessor basic block, and or/and the
1499     // two conditions together.
1500     Instruction *New = Cond->clone();
1501     if (BonusInst) New->replaceUsesOfWith(BonusInst, NewBonus);
1502     PredBlock->getInstList().insert(PBI, New);
1503     New->takeName(Cond);
1504     Cond->setName(New->getName()+".old");
1505     
1506     Value *NewCond = BinaryOperator::Create(Opc, PBI->getCondition(),
1507                                             New, "or.cond", PBI);
1508     PBI->setCondition(NewCond);
1509     if (PBI->getSuccessor(0) == BB) {
1510       AddPredecessorToBlock(TrueDest, PredBlock, BB);
1511       PBI->setSuccessor(0, TrueDest);
1512     }
1513     if (PBI->getSuccessor(1) == BB) {
1514       AddPredecessorToBlock(FalseDest, PredBlock, BB);
1515       PBI->setSuccessor(1, FalseDest);
1516     }
1517     return SimplifyCFG(PBI->getParent()) | true;
1518   }
1519   return false;
1520 }
1521
1522 /// SimplifyCondBranchToCondBranch - If we have a conditional branch as a
1523 /// predecessor of another block, this function tries to simplify it.  We know
1524 /// that PBI and BI are both conditional branches, and BI is in one of the
1525 /// successor blocks of PBI - PBI branches to BI.
1526 static bool SimplifyCondBranchToCondBranch(BranchInst *PBI, BranchInst *BI) {
1527   assert(PBI->isConditional() && BI->isConditional());
1528   BasicBlock *BB = BI->getParent();
1529
1530   // If this block ends with a branch instruction, and if there is a
1531   // predecessor that ends on a branch of the same condition, make 
1532   // this conditional branch redundant.
1533   if (PBI->getCondition() == BI->getCondition() &&
1534       PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
1535     // Okay, the outcome of this conditional branch is statically
1536     // knowable.  If this block had a single pred, handle specially.
1537     if (BB->getSinglePredecessor()) {
1538       // Turn this into a branch on constant.
1539       bool CondIsTrue = PBI->getSuccessor(0) == BB;
1540       BI->setCondition(ConstantInt::get(Type::getInt1Ty(BB->getContext()), 
1541                                         CondIsTrue));
1542       return true;  // Nuke the branch on constant.
1543     }
1544     
1545     // Otherwise, if there are multiple predecessors, insert a PHI that merges
1546     // in the constant and simplify the block result.  Subsequent passes of
1547     // simplifycfg will thread the block.
1548     if (BlockIsSimpleEnoughToThreadThrough(BB)) {
1549       PHINode *NewPN = PHINode::Create(Type::getInt1Ty(BB->getContext()),
1550                                        BI->getCondition()->getName() + ".pr",
1551                                        BB->begin());
1552       // Okay, we're going to insert the PHI node.  Since PBI is not the only
1553       // predecessor, compute the PHI'd conditional value for all of the preds.
1554       // Any predecessor where the condition is not computable we keep symbolic.
1555       for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
1556         BasicBlock *P = *PI;
1557         if ((PBI = dyn_cast<BranchInst>(P->getTerminator())) &&
1558             PBI != BI && PBI->isConditional() &&
1559             PBI->getCondition() == BI->getCondition() &&
1560             PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
1561           bool CondIsTrue = PBI->getSuccessor(0) == BB;
1562           NewPN->addIncoming(ConstantInt::get(Type::getInt1Ty(BB->getContext()), 
1563                                               CondIsTrue), P);
1564         } else {
1565           NewPN->addIncoming(BI->getCondition(), P);
1566         }
1567       }
1568       
1569       BI->setCondition(NewPN);
1570       return true;
1571     }
1572   }
1573   
1574   // If this is a conditional branch in an empty block, and if any
1575   // predecessors is a conditional branch to one of our destinations,
1576   // fold the conditions into logical ops and one cond br.
1577   BasicBlock::iterator BBI = BB->begin();
1578   // Ignore dbg intrinsics.
1579   while (isa<DbgInfoIntrinsic>(BBI))
1580     ++BBI;
1581   if (&*BBI != BI)
1582     return false;
1583
1584   
1585   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(BI->getCondition()))
1586     if (CE->canTrap())
1587       return false;
1588   
1589   int PBIOp, BIOp;
1590   if (PBI->getSuccessor(0) == BI->getSuccessor(0))
1591     PBIOp = BIOp = 0;
1592   else if (PBI->getSuccessor(0) == BI->getSuccessor(1))
1593     PBIOp = 0, BIOp = 1;
1594   else if (PBI->getSuccessor(1) == BI->getSuccessor(0))
1595     PBIOp = 1, BIOp = 0;
1596   else if (PBI->getSuccessor(1) == BI->getSuccessor(1))
1597     PBIOp = BIOp = 1;
1598   else
1599     return false;
1600     
1601   // Check to make sure that the other destination of this branch
1602   // isn't BB itself.  If so, this is an infinite loop that will
1603   // keep getting unwound.
1604   if (PBI->getSuccessor(PBIOp) == BB)
1605     return false;
1606     
1607   // Do not perform this transformation if it would require 
1608   // insertion of a large number of select instructions. For targets
1609   // without predication/cmovs, this is a big pessimization.
1610   BasicBlock *CommonDest = PBI->getSuccessor(PBIOp);
1611       
1612   unsigned NumPhis = 0;
1613   for (BasicBlock::iterator II = CommonDest->begin();
1614        isa<PHINode>(II); ++II, ++NumPhis)
1615     if (NumPhis > 2) // Disable this xform.
1616       return false;
1617     
1618   // Finally, if everything is ok, fold the branches to logical ops.
1619   BasicBlock *OtherDest  = BI->getSuccessor(BIOp ^ 1);
1620   
1621   DEBUG(dbgs() << "FOLDING BRs:" << *PBI->getParent()
1622                << "AND: " << *BI->getParent());
1623   
1624   
1625   // If OtherDest *is* BB, then BB is a basic block with a single conditional
1626   // branch in it, where one edge (OtherDest) goes back to itself but the other
1627   // exits.  We don't *know* that the program avoids the infinite loop
1628   // (even though that seems likely).  If we do this xform naively, we'll end up
1629   // recursively unpeeling the loop.  Since we know that (after the xform is
1630   // done) that the block *is* infinite if reached, we just make it an obviously
1631   // infinite loop with no cond branch.
1632   if (OtherDest == BB) {
1633     // Insert it at the end of the function, because it's either code,
1634     // or it won't matter if it's hot. :)
1635     BasicBlock *InfLoopBlock = BasicBlock::Create(BB->getContext(),
1636                                                   "infloop", BB->getParent());
1637     BranchInst::Create(InfLoopBlock, InfLoopBlock);
1638     OtherDest = InfLoopBlock;
1639   }  
1640   
1641   DEBUG(dbgs() << *PBI->getParent()->getParent());
1642   
1643   // BI may have other predecessors.  Because of this, we leave
1644   // it alone, but modify PBI.
1645   
1646   // Make sure we get to CommonDest on True&True directions.
1647   Value *PBICond = PBI->getCondition();
1648   if (PBIOp)
1649     PBICond = BinaryOperator::CreateNot(PBICond,
1650                                         PBICond->getName()+".not",
1651                                         PBI);
1652   Value *BICond = BI->getCondition();
1653   if (BIOp)
1654     BICond = BinaryOperator::CreateNot(BICond,
1655                                        BICond->getName()+".not",
1656                                        PBI);
1657   // Merge the conditions.
1658   Value *Cond = BinaryOperator::CreateOr(PBICond, BICond, "brmerge", PBI);
1659   
1660   // Modify PBI to branch on the new condition to the new dests.
1661   PBI->setCondition(Cond);
1662   PBI->setSuccessor(0, CommonDest);
1663   PBI->setSuccessor(1, OtherDest);
1664   
1665   // OtherDest may have phi nodes.  If so, add an entry from PBI's
1666   // block that are identical to the entries for BI's block.
1667   PHINode *PN;
1668   for (BasicBlock::iterator II = OtherDest->begin();
1669        (PN = dyn_cast<PHINode>(II)); ++II) {
1670     Value *V = PN->getIncomingValueForBlock(BB);
1671     PN->addIncoming(V, PBI->getParent());
1672   }
1673   
1674   // We know that the CommonDest already had an edge from PBI to
1675   // it.  If it has PHIs though, the PHIs may have different
1676   // entries for BB and PBI's BB.  If so, insert a select to make
1677   // them agree.
1678   for (BasicBlock::iterator II = CommonDest->begin();
1679        (PN = dyn_cast<PHINode>(II)); ++II) {
1680     Value *BIV = PN->getIncomingValueForBlock(BB);
1681     unsigned PBBIdx = PN->getBasicBlockIndex(PBI->getParent());
1682     Value *PBIV = PN->getIncomingValue(PBBIdx);
1683     if (BIV != PBIV) {
1684       // Insert a select in PBI to pick the right value.
1685       Value *NV = SelectInst::Create(PBICond, PBIV, BIV,
1686                                      PBIV->getName()+".mux", PBI);
1687       PN->setIncomingValue(PBBIdx, NV);
1688     }
1689   }
1690   
1691   DEBUG(dbgs() << "INTO: " << *PBI->getParent());
1692   DEBUG(dbgs() << *PBI->getParent()->getParent());
1693   
1694   // This basic block is probably dead.  We know it has at least
1695   // one fewer predecessor.
1696   return true;
1697 }
1698
1699 // SimplifyIndirectBrOnSelect - Replaces
1700 //   (indirectbr (select cond, blockaddress(@fn, BlockA),
1701 //                             blockaddress(@fn, BlockB)))
1702 // with
1703 //   (br cond, BlockA, BlockB).
1704 static bool SimplifyIndirectBrOnSelect(IndirectBrInst *IBI, SelectInst *SI) {
1705   // Check that both operands of the select are block addresses.
1706   BlockAddress *TBA = dyn_cast<BlockAddress>(SI->getTrueValue());
1707   BlockAddress *FBA = dyn_cast<BlockAddress>(SI->getFalseValue());
1708   if (!TBA || !FBA)
1709     return false;
1710
1711   // Extract the actual blocks.
1712   BasicBlock *TrueBB = TBA->getBasicBlock();
1713   BasicBlock *FalseBB = FBA->getBasicBlock();
1714
1715   // Remove any superfluous successor edges from the CFG.
1716   // First, figure out which successors to preserve.
1717   // If TrueBB and FalseBB are equal, only try to preserve one copy of that
1718   // successor.
1719   BasicBlock *KeepEdge1 = TrueBB;
1720   BasicBlock *KeepEdge2 = TrueBB != FalseBB ? FalseBB : 0;
1721
1722   // Then remove the rest.
1723   for (unsigned I = 0, E = IBI->getNumSuccessors(); I != E; ++I) {
1724     BasicBlock *Succ = IBI->getSuccessor(I);
1725     // Make sure only to keep exactly one copy of each edge.
1726     if (Succ == KeepEdge1)
1727       KeepEdge1 = 0;
1728     else if (Succ == KeepEdge2)
1729       KeepEdge2 = 0;
1730     else
1731       Succ->removePredecessor(IBI->getParent());
1732   }
1733
1734   // Insert an appropriate new terminator.
1735   if ((KeepEdge1 == 0) && (KeepEdge2 == 0)) {
1736     if (TrueBB == FalseBB)
1737       // We were only looking for one successor, and it was present.
1738       // Create an unconditional branch to it.
1739       BranchInst::Create(TrueBB, IBI);
1740     else
1741       // We found both of the successors we were looking for.
1742       // Create a conditional branch sharing the condition of the select.
1743       BranchInst::Create(TrueBB, FalseBB, SI->getCondition(), IBI);
1744   } else if (KeepEdge1 && (KeepEdge2 || TrueBB == FalseBB)) {
1745     // Neither of the selected blocks were successors, so this
1746     // indirectbr must be unreachable.
1747     new UnreachableInst(IBI->getContext(), IBI);
1748   } else {
1749     // One of the selected values was a successor, but the other wasn't.
1750     // Insert an unconditional branch to the one that was found;
1751     // the edge to the one that wasn't must be unreachable.
1752     if (KeepEdge1 == 0)
1753       // Only TrueBB was found.
1754       BranchInst::Create(TrueBB, IBI);
1755     else
1756       // Only FalseBB was found.
1757       BranchInst::Create(FalseBB, IBI);
1758   }
1759
1760   EraseTerminatorInstAndDCECond(IBI);
1761   return true;
1762 }
1763
1764 /// TryToSimplifyUncondBranchWithICmpInIt - This is called when we find an icmp
1765 /// instruction (a seteq/setne with a constant) as the only instruction in a
1766 /// block that ends with an uncond branch.  We are looking for a very specific
1767 /// pattern that occurs when "A == 1 || A == 2 || A == 3" gets simplified.  In
1768 /// this case, we merge the first two "or's of icmp" into a switch, but then the
1769 /// default value goes to an uncond block with a seteq in it, we get something
1770 /// like:
1771 ///
1772 ///   switch i8 %A, label %DEFAULT [ i8 1, label %end    i8 2, label %end ]
1773 /// DEFAULT:
1774 ///   %tmp = icmp eq i8 %A, 92
1775 ///   br label %end
1776 /// end:
1777 ///   ... = phi i1 [ true, %entry ], [ %tmp, %DEFAULT ], [ true, %entry ]
1778 /// 
1779 /// We prefer to split the edge to 'end' so that there is a true/false entry to
1780 /// the PHI, merging the third icmp into the switch.
1781 static bool TryToSimplifyUncondBranchWithICmpInIt(ICmpInst *ICI) {
1782   BasicBlock *BB = ICI->getParent();
1783   // If the block has any PHIs in it or the icmp has multiple uses, it is too
1784   // complex.
1785   if (isa<PHINode>(BB->begin()) || !ICI->hasOneUse()) return false;
1786
1787   Value *V = ICI->getOperand(0);
1788   ConstantInt *Cst = cast<ConstantInt>(ICI->getOperand(1));
1789   
1790   // The pattern we're looking for is where our only predecessor is a switch on
1791   // 'V' and this block is the default case for the switch.  In this case we can
1792   // fold the compared value into the switch to simplify things.
1793   BasicBlock *Pred = BB->getSinglePredecessor();
1794   if (Pred == 0 || !isa<SwitchInst>(Pred->getTerminator())) return false;
1795   
1796   SwitchInst *SI = cast<SwitchInst>(Pred->getTerminator());
1797   if (SI->getCondition() != V)
1798     return false;
1799   
1800   // If BB is reachable on a non-default case, then we simply know the value of
1801   // V in this block.  Substitute it and constant fold the icmp instruction
1802   // away.
1803   if (SI->getDefaultDest() != BB) {
1804     ConstantInt *VVal = SI->findCaseDest(BB);
1805     assert(VVal && "Should have a unique destination value");
1806     ICI->setOperand(0, VVal);
1807     
1808     if (Constant *C = ConstantFoldInstruction(ICI)) {
1809       ICI->replaceAllUsesWith(C);
1810       ICI->eraseFromParent();
1811     }
1812     // BB is now empty, so it is likely to simplify away.
1813     return SimplifyCFG(BB) | true;
1814   }
1815   
1816   // Ok, the block is reachable from the default dest.  If the constant we're
1817   // comparing exists in one of the other edges, then we can constant fold ICI
1818   // and zap it.
1819   if (SI->findCaseValue(Cst) != 0) {
1820     Value *V;
1821     if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
1822       V = ConstantInt::getFalse(BB->getContext());
1823     else
1824       V = ConstantInt::getTrue(BB->getContext());
1825     
1826     ICI->replaceAllUsesWith(V);
1827     ICI->eraseFromParent();
1828     // BB is now empty, so it is likely to simplify away.
1829     return SimplifyCFG(BB) | true;
1830   }
1831   
1832   // The use of the icmp has to be in the 'end' block, by the only PHI node in
1833   // the block.
1834   BasicBlock *SuccBlock = BB->getTerminator()->getSuccessor(0);
1835   PHINode *PHIUse = dyn_cast<PHINode>(ICI->use_back());
1836   if (PHIUse == 0 || PHIUse != &SuccBlock->front() ||
1837       isa<PHINode>(++BasicBlock::iterator(PHIUse)))
1838     return false;
1839
1840   // If the icmp is a SETEQ, then the default dest gets false, the new edge gets
1841   // true in the PHI.
1842   Constant *DefaultCst = ConstantInt::getTrue(BB->getContext());
1843   Constant *NewCst     = ConstantInt::getFalse(BB->getContext());
1844
1845   if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
1846     std::swap(DefaultCst, NewCst);
1847
1848   // Replace ICI (which is used by the PHI for the default value) with true or
1849   // false depending on if it is EQ or NE.
1850   ICI->replaceAllUsesWith(DefaultCst);
1851   ICI->eraseFromParent();
1852
1853   // Okay, the switch goes to this block on a default value.  Add an edge from
1854   // the switch to the merge point on the compared value.
1855   BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), "switch.edge",
1856                                          BB->getParent(), BB);
1857   SI->addCase(Cst, NewBB);
1858   
1859   // NewBB branches to the phi block, add the uncond branch and the phi entry.
1860   BranchInst::Create(SuccBlock, NewBB);
1861   PHIUse->addIncoming(NewCst, NewBB);
1862   return true;
1863 }
1864
1865 /// SimplifyBranchOnICmpChain - The specified branch is a conditional branch.
1866 /// Check to see if it is branching on an or/and chain of icmp instructions, and
1867 /// fold it into a switch instruction if so.
1868 static bool SimplifyBranchOnICmpChain(BranchInst *BI, const TargetData *TD) {
1869   Instruction *Cond = dyn_cast<Instruction>(BI->getCondition());
1870   if (Cond == 0) return false;
1871   
1872   
1873   // Change br (X == 0 | X == 1), T, F into a switch instruction.
1874   // If this is a bunch of seteq's or'd together, or if it's a bunch of
1875   // 'setne's and'ed together, collect them.
1876   Value *CompVal = 0;
1877   std::vector<ConstantInt*> Values;
1878   bool TrueWhenEqual = true;
1879   Value *ExtraCase = 0;
1880   
1881   if (Cond->getOpcode() == Instruction::Or) {
1882     CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, true);
1883   } else if (Cond->getOpcode() == Instruction::And) {
1884     CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, false);
1885     TrueWhenEqual = false;
1886   }
1887   
1888   // If we didn't have a multiply compared value, fail.
1889   if (CompVal == 0) return false;
1890
1891   // There might be duplicate constants in the list, which the switch
1892   // instruction can't handle, remove them now.
1893   array_pod_sort(Values.begin(), Values.end(), ConstantIntSortPredicate);
1894   Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
1895   
1896   // If Extra was used, we require at least two switch values to do the
1897   // transformation.  A switch with one value is just an cond branch.
1898   if (ExtraCase && Values.size() < 2) return false;
1899   
1900   // Figure out which block is which destination.
1901   BasicBlock *DefaultBB = BI->getSuccessor(1);
1902   BasicBlock *EdgeBB    = BI->getSuccessor(0);
1903   if (!TrueWhenEqual) std::swap(DefaultBB, EdgeBB);
1904   
1905   BasicBlock *BB = BI->getParent();
1906   
1907   // If there are any extra values that couldn't be folded into the switch
1908   // then we evaluate them with an explicit branch first.  Split the block
1909   // right before the condbr to handle it.
1910   if (ExtraCase) {
1911     BasicBlock *NewBB = BB->splitBasicBlock(BI, "switch.early.test");
1912     // Remove the uncond branch added to the old block.
1913     TerminatorInst *OldTI = BB->getTerminator();
1914     
1915     BranchInst::Create(EdgeBB, NewBB, ExtraCase, OldTI);
1916     OldTI->eraseFromParent();
1917     
1918     // If there are PHI nodes in EdgeBB, then we need to add a new entry to them
1919     // for the edge we just added.
1920     for (BasicBlock::iterator I = EdgeBB->begin(); isa<PHINode>(I); ++I) {
1921       PHINode *PN = cast<PHINode>(I);
1922       PN->addIncoming(PN->getIncomingValueForBlock(NewBB), BB);
1923     }    
1924     BB = NewBB;
1925   }
1926   
1927   // Convert pointer to int before we switch.
1928   if (CompVal->getType()->isPointerTy()) {
1929     assert(TD && "Cannot switch on pointer without TargetData");
1930     CompVal = new PtrToIntInst(CompVal,
1931                                TD->getIntPtrType(CompVal->getContext()),
1932                                "magicptr", BI);
1933   }
1934   
1935   // Create the new switch instruction now.
1936   SwitchInst *New = SwitchInst::Create(CompVal, DefaultBB, Values.size(), BI);
1937   
1938   // Add all of the 'cases' to the switch instruction.
1939   for (unsigned i = 0, e = Values.size(); i != e; ++i)
1940     New->addCase(Values[i], EdgeBB);
1941   
1942   // We added edges from PI to the EdgeBB.  As such, if there were any
1943   // PHI nodes in EdgeBB, they need entries to be added corresponding to
1944   // the number of edges added.
1945   for (BasicBlock::iterator BBI = EdgeBB->begin();
1946        isa<PHINode>(BBI); ++BBI) {
1947     PHINode *PN = cast<PHINode>(BBI);
1948     Value *InVal = PN->getIncomingValueForBlock(BB);
1949     for (unsigned i = 0, e = Values.size()-1; i != e; ++i)
1950       PN->addIncoming(InVal, BB);
1951   }
1952   
1953   // Erase the old branch instruction.
1954   EraseTerminatorInstAndDCECond(BI);
1955   return true;
1956 }
1957
1958 bool SimplifyCFGOpt::SimplifyReturn(ReturnInst *RI) {
1959   BasicBlock *BB = RI->getParent();
1960   if (!BB->getFirstNonPHIOrDbg()->isTerminator()) return false;
1961   
1962   // Find predecessors that end with branches.
1963   SmallVector<BasicBlock*, 8> UncondBranchPreds;
1964   SmallVector<BranchInst*, 8> CondBranchPreds;
1965   for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
1966     BasicBlock *P = *PI;
1967     TerminatorInst *PTI = P->getTerminator();
1968     if (BranchInst *BI = dyn_cast<BranchInst>(PTI)) {
1969       if (BI->isUnconditional())
1970         UncondBranchPreds.push_back(P);
1971       else
1972         CondBranchPreds.push_back(BI);
1973     }
1974   }
1975   
1976   // If we found some, do the transformation!
1977   if (!UncondBranchPreds.empty()) {
1978     while (!UncondBranchPreds.empty()) {
1979       BasicBlock *Pred = UncondBranchPreds.pop_back_val();
1980       DEBUG(dbgs() << "FOLDING: " << *BB
1981             << "INTO UNCOND BRANCH PRED: " << *Pred);
1982       Instruction *UncondBranch = Pred->getTerminator();
1983       // Clone the return and add it to the end of the predecessor.
1984       Instruction *NewRet = RI->clone();
1985       Pred->getInstList().push_back(NewRet);
1986       
1987       // If the return instruction returns a value, and if the value was a
1988       // PHI node in "BB", propagate the right value into the return.
1989       for (User::op_iterator i = NewRet->op_begin(), e = NewRet->op_end();
1990            i != e; ++i)
1991         if (PHINode *PN = dyn_cast<PHINode>(*i))
1992           if (PN->getParent() == BB)
1993             *i = PN->getIncomingValueForBlock(Pred);
1994       
1995       // Update any PHI nodes in the returning block to realize that we no
1996       // longer branch to them.
1997       BB->removePredecessor(Pred);
1998       Pred->getInstList().erase(UncondBranch);
1999     }
2000     
2001     // If we eliminated all predecessors of the block, delete the block now.
2002     if (pred_begin(BB) == pred_end(BB))
2003       // We know there are no successors, so just nuke the block.
2004       BB->eraseFromParent();
2005     
2006     return true;
2007   }
2008   
2009   // Check out all of the conditional branches going to this return
2010   // instruction.  If any of them just select between returns, change the
2011   // branch itself into a select/return pair.
2012   while (!CondBranchPreds.empty()) {
2013     BranchInst *BI = CondBranchPreds.pop_back_val();
2014     
2015     // Check to see if the non-BB successor is also a return block.
2016     if (isa<ReturnInst>(BI->getSuccessor(0)->getTerminator()) &&
2017         isa<ReturnInst>(BI->getSuccessor(1)->getTerminator()) &&
2018         SimplifyCondBranchToTwoReturns(BI))
2019       return true;
2020   }
2021   return false;
2022 }
2023
2024 bool SimplifyCFGOpt::SimplifyUnwind(UnwindInst *UI) {
2025   // Check to see if the first instruction in this block is just an unwind.
2026   // If so, replace any invoke instructions which use this as an exception
2027   // destination with call instructions.
2028   BasicBlock *BB = UI->getParent();
2029   if (!BB->getFirstNonPHIOrDbg()->isTerminator()) return false;
2030
2031   bool Changed = false;
2032   SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
2033   while (!Preds.empty()) {
2034     BasicBlock *Pred = Preds.back();
2035     InvokeInst *II = dyn_cast<InvokeInst>(Pred->getTerminator());
2036     if (II && II->getUnwindDest() == BB) {
2037       // Insert a new branch instruction before the invoke, because this
2038       // is now a fall through.
2039       BranchInst *BI = BranchInst::Create(II->getNormalDest(), II);
2040       Pred->getInstList().remove(II);   // Take out of symbol table
2041       
2042       // Insert the call now.
2043       SmallVector<Value*,8> Args(II->op_begin(), II->op_end()-3);
2044       CallInst *CI = CallInst::Create(II->getCalledValue(),
2045                                       Args.begin(), Args.end(),
2046                                       II->getName(), BI);
2047       CI->setCallingConv(II->getCallingConv());
2048       CI->setAttributes(II->getAttributes());
2049       // If the invoke produced a value, the Call now does instead.
2050       II->replaceAllUsesWith(CI);
2051       delete II;
2052       Changed = true;
2053     }
2054     
2055     Preds.pop_back();
2056   }
2057   
2058   // If this block is now dead (and isn't the entry block), remove it.
2059   if (pred_begin(BB) == pred_end(BB) &&
2060       BB != &BB->getParent()->getEntryBlock()) {
2061     // We know there are no successors, so just nuke the block.
2062     BB->eraseFromParent();
2063     return true;
2064   }
2065   
2066   return Changed;  
2067 }
2068
2069 bool SimplifyCFGOpt::SimplifyUnreachable(UnreachableInst *UI) {
2070   BasicBlock *BB = UI->getParent();
2071   
2072   bool Changed = false;
2073   
2074   // If there are any instructions immediately before the unreachable that can
2075   // be removed, do so.
2076   while (UI != BB->begin()) {
2077     BasicBlock::iterator BBI = UI;
2078     --BBI;
2079     // Do not delete instructions that can have side effects, like calls
2080     // (which may never return) and volatile loads and stores.
2081     if (isa<CallInst>(BBI) && !isa<DbgInfoIntrinsic>(BBI)) break;
2082     
2083     if (StoreInst *SI = dyn_cast<StoreInst>(BBI))
2084       if (SI->isVolatile())
2085         break;
2086     
2087     if (LoadInst *LI = dyn_cast<LoadInst>(BBI))
2088       if (LI->isVolatile())
2089         break;
2090     
2091     // Delete this instruction
2092     BB->getInstList().erase(BBI);
2093     Changed = true;
2094   }
2095   
2096   // If the unreachable instruction is the first in the block, take a gander
2097   // at all of the predecessors of this instruction, and simplify them.
2098   if (&BB->front() != UI) return Changed;
2099   
2100   SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
2101   for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
2102     TerminatorInst *TI = Preds[i]->getTerminator();
2103     
2104     if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
2105       if (BI->isUnconditional()) {
2106         if (BI->getSuccessor(0) == BB) {
2107           new UnreachableInst(TI->getContext(), TI);
2108           TI->eraseFromParent();
2109           Changed = true;
2110         }
2111       } else {
2112         if (BI->getSuccessor(0) == BB) {
2113           BranchInst::Create(BI->getSuccessor(1), BI);
2114           EraseTerminatorInstAndDCECond(BI);
2115         } else if (BI->getSuccessor(1) == BB) {
2116           BranchInst::Create(BI->getSuccessor(0), BI);
2117           EraseTerminatorInstAndDCECond(BI);
2118           Changed = true;
2119         }
2120       }
2121     } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
2122       for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
2123         if (SI->getSuccessor(i) == BB) {
2124           BB->removePredecessor(SI->getParent());
2125           SI->removeCase(i);
2126           --i; --e;
2127           Changed = true;
2128         }
2129       // If the default value is unreachable, figure out the most popular
2130       // destination and make it the default.
2131       if (SI->getSuccessor(0) == BB) {
2132         std::map<BasicBlock*, unsigned> Popularity;
2133         for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
2134           Popularity[SI->getSuccessor(i)]++;
2135         
2136         // Find the most popular block.
2137         unsigned MaxPop = 0;
2138         BasicBlock *MaxBlock = 0;
2139         for (std::map<BasicBlock*, unsigned>::iterator
2140              I = Popularity.begin(), E = Popularity.end(); I != E; ++I) {
2141           if (I->second > MaxPop) {
2142             MaxPop = I->second;
2143             MaxBlock = I->first;
2144           }
2145         }
2146         if (MaxBlock) {
2147           // Make this the new default, allowing us to delete any explicit
2148           // edges to it.
2149           SI->setSuccessor(0, MaxBlock);
2150           Changed = true;
2151           
2152           // If MaxBlock has phinodes in it, remove MaxPop-1 entries from
2153           // it.
2154           if (isa<PHINode>(MaxBlock->begin()))
2155             for (unsigned i = 0; i != MaxPop-1; ++i)
2156               MaxBlock->removePredecessor(SI->getParent());
2157           
2158           for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
2159             if (SI->getSuccessor(i) == MaxBlock) {
2160               SI->removeCase(i);
2161               --i; --e;
2162             }
2163         }
2164       }
2165     } else if (InvokeInst *II = dyn_cast<InvokeInst>(TI)) {
2166       if (II->getUnwindDest() == BB) {
2167         // Convert the invoke to a call instruction.  This would be a good
2168         // place to note that the call does not throw though.
2169         BranchInst *BI = BranchInst::Create(II->getNormalDest(), II);
2170         II->removeFromParent();   // Take out of symbol table
2171         
2172         // Insert the call now...
2173         SmallVector<Value*, 8> Args(II->op_begin(), II->op_end()-3);
2174         CallInst *CI = CallInst::Create(II->getCalledValue(),
2175                                         Args.begin(), Args.end(),
2176                                         II->getName(), BI);
2177         CI->setCallingConv(II->getCallingConv());
2178         CI->setAttributes(II->getAttributes());
2179         // If the invoke produced a value, the call does now instead.
2180         II->replaceAllUsesWith(CI);
2181         delete II;
2182         Changed = true;
2183       }
2184     }
2185   }
2186   
2187   // If this block is now dead, remove it.
2188   if (pred_begin(BB) == pred_end(BB) &&
2189       BB != &BB->getParent()->getEntryBlock()) {
2190     // We know there are no successors, so just nuke the block.
2191     BB->eraseFromParent();
2192     return true;
2193   }
2194
2195   return Changed;
2196 }
2197
2198
2199 bool SimplifyCFGOpt::SimplifySwitch(SwitchInst *SI) {
2200   // If this switch is too complex to want to look at, ignore it.
2201   if (!isValueEqualityComparison(SI))
2202     return false;
2203
2204   BasicBlock *BB = SI->getParent();
2205
2206   // If we only have one predecessor, and if it is a branch on this value,
2207   // see if that predecessor totally determines the outcome of this switch.
2208   if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
2209     if (SimplifyEqualityComparisonWithOnlyPredecessor(SI, OnlyPred))
2210       return SimplifyCFG(BB) | true;
2211   
2212   // If the block only contains the switch, see if we can fold the block
2213   // away into any preds.
2214   BasicBlock::iterator BBI = BB->begin();
2215   // Ignore dbg intrinsics.
2216   while (isa<DbgInfoIntrinsic>(BBI))
2217     ++BBI;
2218   if (SI == &*BBI)
2219     if (FoldValueComparisonIntoPredecessors(SI))
2220       return SimplifyCFG(BB) | true;
2221   
2222   return false;
2223 }
2224
2225 bool SimplifyCFGOpt::SimplifyIndirectBr(IndirectBrInst *IBI) {
2226   BasicBlock *BB = IBI->getParent();
2227   bool Changed = false;
2228   
2229   // Eliminate redundant destinations.
2230   SmallPtrSet<Value *, 8> Succs;
2231   for (unsigned i = 0, e = IBI->getNumDestinations(); i != e; ++i) {
2232     BasicBlock *Dest = IBI->getDestination(i);
2233     if (!Dest->hasAddressTaken() || !Succs.insert(Dest)) {
2234       Dest->removePredecessor(BB);
2235       IBI->removeDestination(i);
2236       --i; --e;
2237       Changed = true;
2238     }
2239   } 
2240
2241   if (IBI->getNumDestinations() == 0) {
2242     // If the indirectbr has no successors, change it to unreachable.
2243     new UnreachableInst(IBI->getContext(), IBI);
2244     EraseTerminatorInstAndDCECond(IBI);
2245     return true;
2246   }
2247   
2248   if (IBI->getNumDestinations() == 1) {
2249     // If the indirectbr has one successor, change it to a direct branch.
2250     BranchInst::Create(IBI->getDestination(0), IBI);
2251     EraseTerminatorInstAndDCECond(IBI);
2252     return true;
2253   }
2254   
2255   if (SelectInst *SI = dyn_cast<SelectInst>(IBI->getAddress())) {
2256     if (SimplifyIndirectBrOnSelect(IBI, SI))
2257       return SimplifyCFG(BB) | true;
2258   }
2259   return Changed;
2260 }
2261
2262 bool SimplifyCFGOpt::SimplifyUncondBranch(BranchInst *BI) {
2263   BasicBlock *BB = BI->getParent();
2264   
2265   // If the Terminator is the only non-phi instruction, simplify the block.
2266   BasicBlock::iterator I = BB->getFirstNonPHIOrDbg();
2267   if (I->isTerminator() && BB != &BB->getParent()->getEntryBlock() &&
2268       TryToSimplifyUncondBranchFromEmptyBlock(BB))
2269     return true;
2270   
2271   // If the only instruction in the block is a seteq/setne comparison
2272   // against a constant, try to simplify the block.
2273   if (ICmpInst *ICI = dyn_cast<ICmpInst>(I))
2274     if (ICI->isEquality() && isa<ConstantInt>(ICI->getOperand(1))) {
2275       for (++I; isa<DbgInfoIntrinsic>(I); ++I)
2276         ;
2277       if (I->isTerminator() && TryToSimplifyUncondBranchWithICmpInIt(ICI))
2278         return true;
2279     }
2280   
2281   return false;
2282 }
2283
2284
2285 bool SimplifyCFGOpt::SimplifyCondBranch(BranchInst *BI) {
2286   BasicBlock *BB = BI->getParent();
2287   
2288   // Conditional branch
2289   if (isValueEqualityComparison(BI)) {
2290     // If we only have one predecessor, and if it is a branch on this value,
2291     // see if that predecessor totally determines the outcome of this
2292     // switch.
2293     if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
2294       if (SimplifyEqualityComparisonWithOnlyPredecessor(BI, OnlyPred))
2295         return SimplifyCFG(BB) | true;
2296     
2297     // This block must be empty, except for the setcond inst, if it exists.
2298     // Ignore dbg intrinsics.
2299     BasicBlock::iterator I = BB->begin();
2300     // Ignore dbg intrinsics.
2301     while (isa<DbgInfoIntrinsic>(I))
2302       ++I;
2303     if (&*I == BI) {
2304       if (FoldValueComparisonIntoPredecessors(BI))
2305         return SimplifyCFG(BB) | true;
2306     } else if (&*I == cast<Instruction>(BI->getCondition())){
2307       ++I;
2308       // Ignore dbg intrinsics.
2309       while (isa<DbgInfoIntrinsic>(I))
2310         ++I;
2311       if (&*I == BI && FoldValueComparisonIntoPredecessors(BI))
2312         return SimplifyCFG(BB) | true;
2313     }
2314   }
2315   
2316   // Try to turn "br (X == 0 | X == 1), T, F" into a switch instruction.
2317   if (SimplifyBranchOnICmpChain(BI, TD))
2318     return true;
2319   
2320   // We have a conditional branch to two blocks that are only reachable
2321   // from BI.  We know that the condbr dominates the two blocks, so see if
2322   // there is any identical code in the "then" and "else" blocks.  If so, we
2323   // can hoist it up to the branching block.
2324   if (BI->getSuccessor(0)->getSinglePredecessor() != 0) {
2325     if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
2326       if (HoistThenElseCodeToIf(BI))
2327         return SimplifyCFG(BB) | true;
2328     } else {
2329       // If Successor #1 has multiple preds, we may be able to conditionally
2330       // execute Successor #0 if it branches to successor #1.
2331       TerminatorInst *Succ0TI = BI->getSuccessor(0)->getTerminator();
2332       if (Succ0TI->getNumSuccessors() == 1 &&
2333           Succ0TI->getSuccessor(0) == BI->getSuccessor(1))
2334         if (SpeculativelyExecuteBB(BI, BI->getSuccessor(0)))
2335           return SimplifyCFG(BB) | true;
2336     }
2337   } else if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
2338     // If Successor #0 has multiple preds, we may be able to conditionally
2339     // execute Successor #1 if it branches to successor #0.
2340     TerminatorInst *Succ1TI = BI->getSuccessor(1)->getTerminator();
2341     if (Succ1TI->getNumSuccessors() == 1 &&
2342         Succ1TI->getSuccessor(0) == BI->getSuccessor(0))
2343       if (SpeculativelyExecuteBB(BI, BI->getSuccessor(1)))
2344         return SimplifyCFG(BB) | true;
2345   }
2346   
2347   // If this is a branch on a phi node in the current block, thread control
2348   // through this block if any PHI node entries are constants.
2349   if (PHINode *PN = dyn_cast<PHINode>(BI->getCondition()))
2350     if (PN->getParent() == BI->getParent())
2351       if (FoldCondBranchOnPHI(BI))
2352         return SimplifyCFG(BB) | true;
2353   
2354   // If this basic block is ONLY a setcc and a branch, and if a predecessor
2355   // branches to us and one of our successors, fold the setcc into the
2356   // predecessor and use logical operations to pick the right destination.
2357   if (FoldBranchToCommonDest(BI))
2358     return SimplifyCFG(BB) | true;
2359   
2360   // Scan predecessor blocks for conditional branches.
2361   for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
2362     if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
2363       if (PBI != BI && PBI->isConditional())
2364         if (SimplifyCondBranchToCondBranch(PBI, BI))
2365           return SimplifyCFG(BB) | true;
2366
2367   return false;
2368 }
2369
2370 bool SimplifyCFGOpt::run(BasicBlock *BB) {
2371   bool Changed = false;
2372   Function *Fn = BB->getParent();
2373
2374   assert(BB && Fn && "Block not embedded in function!");
2375   assert(BB->getTerminator() && "Degenerate basic block encountered!");
2376
2377   // Remove basic blocks that have no predecessors (except the entry block)...
2378   // or that just have themself as a predecessor.  These are unreachable.
2379   if ((pred_begin(BB) == pred_end(BB) && BB != &Fn->getEntryBlock()) ||
2380       BB->getSinglePredecessor() == BB) {
2381     DEBUG(dbgs() << "Removing BB: \n" << *BB);
2382     DeleteDeadBlock(BB);
2383     return true;
2384   }
2385
2386   // Check to see if we can constant propagate this terminator instruction
2387   // away...
2388   Changed |= ConstantFoldTerminator(BB);
2389
2390   // Check for and eliminate duplicate PHI nodes in this block.
2391   Changed |= EliminateDuplicatePHINodes(BB);
2392
2393   // Merge basic blocks into their predecessor if there is only one distinct
2394   // pred, and if there is only one distinct successor of the predecessor, and
2395   // if there are no PHI nodes.
2396   //
2397   if (MergeBlockIntoPredecessor(BB))
2398     return true;
2399   
2400   // If there is a trivial two-entry PHI node in this basic block, and we can
2401   // eliminate it, do so now.
2402   if (PHINode *PN = dyn_cast<PHINode>(BB->begin()))
2403     if (PN->getNumIncomingValues() == 2)
2404       Changed |= FoldTwoEntryPHINode(PN); 
2405
2406   if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
2407     if (BI->isUnconditional()) {
2408       if (SimplifyUncondBranch(BI)) return true;
2409     } else {
2410       if (SimplifyCondBranch(BI))
2411         return true;
2412     }
2413   } else if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
2414     if (SimplifyReturn(RI)) return true;
2415   } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
2416     if (SimplifySwitch(SI)) return true;
2417   } else if (UnreachableInst *UI =
2418                dyn_cast<UnreachableInst>(BB->getTerminator())) {
2419     if (SimplifyUnreachable(UI)) return true;
2420   } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
2421     if (SimplifyUnwind(UI)) return true;
2422   } else if (IndirectBrInst *IBI =
2423                dyn_cast<IndirectBrInst>(BB->getTerminator())) {
2424     if (SimplifyIndirectBr(IBI)) return true;
2425   }
2426
2427   return Changed;
2428 }
2429
2430 /// SimplifyCFG - This function is used to do simplification of a CFG.  For
2431 /// example, it adjusts branches to branches to eliminate the extra hop, it
2432 /// eliminates unreachable basic blocks, and does other "peephole" optimization
2433 /// of the CFG.  It returns true if a modification was made.
2434 ///
2435 bool llvm::SimplifyCFG(BasicBlock *BB, const TargetData *TD) {
2436   return SimplifyCFGOpt(TD).run(BB);
2437 }