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