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