lib/Transforms/Utils/SimplifyCFG.cpp

   1 //===- SimplifyCFG.cpp - Code to perform CFG simplification ---------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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/Support/CFG.h"
  20 #include "llvm/Support/Debug.h"
  21 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  22 #include <algorithm>
  23 #include <functional>
  24 #include <set>
  25 #include <map>
  26 using namespace llvm;
  27
  28 /// SafeToMergeTerminators - Return true if it is safe to merge these two
  29 /// terminator instructions together.
  30 ///
  31 static bool SafeToMergeTerminators(TerminatorInst *SI1, TerminatorInst *SI2) {
  32   if (SI1 == SI2) return false;  // Can't merge with self!
  33
  34   // It is not safe to merge these two switch instructions if they have a common
  35   // successor, and if that successor has a PHI node, and if *that* PHI node has
  36   // conflicting incoming values from the two switch blocks.
  37   BasicBlock *SI1BB = SI1->getParent();
  38   BasicBlock *SI2BB = SI2->getParent();
  39   std::set<BasicBlock*> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
  40
  41   for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
  42     if (SI1Succs.count(*I))
  43       for (BasicBlock::iterator BBI = (*I)->begin();
  44            isa<PHINode>(BBI); ++BBI) {
  45         PHINode *PN = cast<PHINode>(BBI);
  46         if (PN->getIncomingValueForBlock(SI1BB) !=
  47             PN->getIncomingValueForBlock(SI2BB))
  48           return false;
  49       }
  50
  51   return true;
  52 }
  53
  54 /// AddPredecessorToBlock - Update PHI nodes in Succ to indicate that there will
  55 /// now be entries in it from the 'NewPred' block.  The values that will be
  56 /// flowing into the PHI nodes will be the same as those coming in from
  57 /// ExistPred, an existing predecessor of Succ.
  58 static void AddPredecessorToBlock(BasicBlock *Succ, BasicBlock *NewPred,
  59                                   BasicBlock *ExistPred) {
  60   assert(std::find(succ_begin(ExistPred), succ_end(ExistPred), Succ) !=
  61          succ_end(ExistPred) && "ExistPred is not a predecessor of Succ!");
  62   if (!isa<PHINode>(Succ->begin())) return; // Quick exit if nothing to do
  63
  64   for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
  65     PHINode *PN = cast<PHINode>(I);
  66     Value *V = PN->getIncomingValueForBlock(ExistPred);
  67     PN->addIncoming(V, NewPred);
  68   }
  69 }
  70
  71 // CanPropagatePredecessorsForPHIs - Return true if we can fold BB, an
  72 // almost-empty BB ending in an unconditional branch to Succ, into succ.
  73 //
  74 // Assumption: Succ is the single successor for BB.
  75 //
  76 static bool CanPropagatePredecessorsForPHIs(BasicBlock *BB, BasicBlock *Succ) {
  77   assert(*succ_begin(BB) == Succ && "Succ is not successor of BB!");
  78
  79   // Check to see if one of the predecessors of BB is already a predecessor of
  80   // Succ.  If so, we cannot do the transformation if there are any PHI nodes
  81   // with incompatible values coming in from the two edges!
  82   //
  83   if (isa<PHINode>(Succ->front())) {
  84     std::set<BasicBlock*> BBPreds(pred_begin(BB), pred_end(BB));
  85     for (pred_iterator PI = pred_begin(Succ), PE = pred_end(Succ);\
  86          PI != PE; ++PI)
  87       if (std::find(BBPreds.begin(), BBPreds.end(), *PI) != BBPreds.end()) {
  88         // Loop over all of the PHI nodes checking to see if there are
  89         // incompatible values coming in.
  90         for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
  91           PHINode *PN = cast<PHINode>(I);
  92           // Loop up the entries in the PHI node for BB and for *PI if the
  93           // values coming in are non-equal, we cannot merge these two blocks
  94           // (instead we should insert a conditional move or something, then
  95           // merge the blocks).
  96           if (PN->getIncomingValueForBlock(BB) !=
  97               PN->getIncomingValueForBlock(*PI))
  98             return false;  // Values are not equal...
  99         }
 100       }
 101   }
 102
 103   // Finally, if BB has PHI nodes that are used by things other than the PHIs in
 104   // Succ and Succ has predecessors that are not Succ and not Pred, we cannot
 105   // fold these blocks, as we don't know whether BB dominates Succ or not to
 106   // update the PHI nodes correctly.
 107   if (!isa<PHINode>(BB->begin()) || Succ->getSinglePredecessor()) return true;
 108
 109   // If the predecessors of Succ are only BB and Succ itself, we can handle this.
 110   bool IsSafe = true;
 111   for (pred_iterator PI = pred_begin(Succ), E = pred_end(Succ); PI != E; ++PI)
 112     if (*PI != Succ && *PI != BB) {
 113       IsSafe = false;
 114       break;
 115     }
 116   if (IsSafe) return true;
 117
 118   // If the PHI nodes in BB are only used by instructions in Succ, we are ok.
 119   IsSafe = true;
 120   for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I) && IsSafe; ++I) {
 121     PHINode *PN = cast<PHINode>(I);
 122     for (Value::use_iterator UI = PN->use_begin(), E = PN->use_end(); UI != E;
 123          ++UI)
 124       if (cast<Instruction>(*UI)->getParent() != Succ) {
 125         IsSafe = false;
 126         break;
 127       }
 128   }
 129
 130   return IsSafe;
 131 }
 132
 133 /// TryToSimplifyUncondBranchFromEmptyBlock - BB contains an unconditional
 134 /// branch to Succ, and contains no instructions other than PHI nodes and the
 135 /// branch.  If possible, eliminate BB.
 136 static bool TryToSimplifyUncondBranchFromEmptyBlock(BasicBlock *BB,
 137                                                     BasicBlock *Succ) {
 138   // If our successor has PHI nodes, then we need to update them to include
 139   // entries for BB's predecessors, not for BB itself.  Be careful though,
 140   // if this transformation fails (returns true) then we cannot do this
 141   // transformation!
 142   //
 143   if (!CanPropagatePredecessorsForPHIs(BB, Succ)) return false;
 144
 145   DEBUG(std::cerr << "Killing Trivial BB: \n" << *BB);
 146
 147   if (isa<PHINode>(Succ->begin())) {
 148     // If there is more than one pred of succ, and there are PHI nodes in
 149     // the successor, then we need to add incoming edges for the PHI nodes
 150     //
 151     const std::vector<BasicBlock*> BBPreds(pred_begin(BB), pred_end(BB));
 152
 153     // Loop over all of the PHI nodes in the successor of BB.
 154     for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
 155       PHINode *PN = cast<PHINode>(I);
 156       Value *OldVal = PN->removeIncomingValue(BB, false);
 157       assert(OldVal && "No entry in PHI for Pred BB!");
 158
 159       // If this incoming value is one of the PHI nodes in BB, the new entries
 160       // in the PHI node are the entries from the old PHI.
 161       if (isa<PHINode>(OldVal) && cast<PHINode>(OldVal)->getParent() == BB) {
 162         PHINode *OldValPN = cast<PHINode>(OldVal);
 163         for (unsigned i = 0, e = OldValPN->getNumIncomingValues(); i != e; ++i)
 164           PN->addIncoming(OldValPN->getIncomingValue(i),
 165                           OldValPN->getIncomingBlock(i));
 166       } else {
 167         for (std::vector<BasicBlock*>::const_iterator PredI = BBPreds.begin(),
 168              End = BBPreds.end(); PredI != End; ++PredI) {
 169           // Add an incoming value for each of the new incoming values...
 170           PN->addIncoming(OldVal, *PredI);
 171         }
 172       }
 173     }
 174   }
 175
 176   if (isa<PHINode>(&BB->front())) {
 177     std::vector<BasicBlock*>
 178     OldSuccPreds(pred_begin(Succ), pred_end(Succ));
 179
 180     // Move all PHI nodes in BB to Succ if they are alive, otherwise
 181     // delete them.
 182     while (PHINode *PN = dyn_cast<PHINode>(&BB->front()))
 183       if (PN->use_empty()) {
 184         // Just remove the dead phi.  This happens if Succ's PHIs were the only
 185         // users of the PHI nodes.
 186         PN->eraseFromParent();
 187       } else {
 188         // The instruction is alive, so this means that Succ must have
 189         // *ONLY* had BB as a predecessor, and the PHI node is still valid
 190         // now.  Simply move it into Succ, because we know that BB
 191         // strictly dominated Succ.
 192         Succ->getInstList().splice(Succ->begin(),
 193                                    BB->getInstList(), BB->begin());
 194
 195         // We need to add new entries for the PHI node to account for
 196         // predecessors of Succ that the PHI node does not take into
 197         // account.  At this point, since we know that BB dominated succ,
 198         // this means that we should any newly added incoming edges should
 199         // use the PHI node as the value for these edges, because they are
 200         // loop back edges.
 201         for (unsigned i = 0, e = OldSuccPreds.size(); i != e; ++i)
 202           if (OldSuccPreds[i] != BB)
 203             PN->addIncoming(PN, OldSuccPreds[i]);
 204       }
 205   }
 206
 207   // Everything that jumped to BB now goes to Succ.
 208   std::string OldName = BB->getName();
 209   BB->replaceAllUsesWith(Succ);
 210   BB->eraseFromParent();              // Delete the old basic block.
 211
 212   if (!OldName.empty() && !Succ->hasName())  // Transfer name if we can
 213     Succ->setName(OldName);
 214   return true;
 215 }
 216
 217 /// GetIfCondition - Given a basic block (BB) with two predecessors (and
 218 /// presumably PHI nodes in it), check to see if the merge at this block is due
 219 /// to an "if condition".  If so, return the boolean condition that determines
 220 /// which entry into BB will be taken.  Also, return by references the block
 221 /// that will be entered from if the condition is true, and the block that will
 222 /// be entered if the condition is false.
 223 ///
 224 ///
 225 static Value *GetIfCondition(BasicBlock *BB,
 226                              BasicBlock *&IfTrue, BasicBlock *&IfFalse) {
 227   assert(std::distance(pred_begin(BB), pred_end(BB)) == 2 &&
 228          "Function can only handle blocks with 2 predecessors!");
 229   BasicBlock *Pred1 = *pred_begin(BB);
 230   BasicBlock *Pred2 = *++pred_begin(BB);
 231
 232   // We can only handle branches.  Other control flow will be lowered to
 233   // branches if possible anyway.
 234   if (!isa<BranchInst>(Pred1->getTerminator()) ||
 235       !isa<BranchInst>(Pred2->getTerminator()))
 236     return 0;
 237   BranchInst *Pred1Br = cast<BranchInst>(Pred1->getTerminator());
 238   BranchInst *Pred2Br = cast<BranchInst>(Pred2->getTerminator());
 239
 240   // Eliminate code duplication by ensuring that Pred1Br is conditional if
 241   // either are.
 242   if (Pred2Br->isConditional()) {
 243     // If both branches are conditional, we don't have an "if statement".  In
 244     // reality, we could transform this case, but since the condition will be
 245     // required anyway, we stand no chance of eliminating it, so the xform is
 246     // probably not profitable.
 247     if (Pred1Br->isConditional())
 248       return 0;
 249
 250     std::swap(Pred1, Pred2);
 251     std::swap(Pred1Br, Pred2Br);
 252   }
 253
 254   if (Pred1Br->isConditional()) {
 255     // If we found a conditional branch predecessor, make sure that it branches
 256     // to BB and Pred2Br.  If it doesn't, this isn't an "if statement".
 257     if (Pred1Br->getSuccessor(0) == BB &&
 258         Pred1Br->getSuccessor(1) == Pred2) {
 259       IfTrue = Pred1;
 260       IfFalse = Pred2;
 261     } else if (Pred1Br->getSuccessor(0) == Pred2 &&
 262                Pred1Br->getSuccessor(1) == BB) {
 263       IfTrue = Pred2;
 264       IfFalse = Pred1;
 265     } else {
 266       // We know that one arm of the conditional goes to BB, so the other must
 267       // go somewhere unrelated, and this must not be an "if statement".
 268       return 0;
 269     }
 270
 271     // The only thing we have to watch out for here is to make sure that Pred2
 272     // doesn't have incoming edges from other blocks.  If it does, the condition
 273     // doesn't dominate BB.
 274     if (++pred_begin(Pred2) != pred_end(Pred2))
 275       return 0;
 276
 277     return Pred1Br->getCondition();
 278   }
 279
 280   // Ok, if we got here, both predecessors end with an unconditional branch to
 281   // BB.  Don't panic!  If both blocks only have a single (identical)
 282   // predecessor, and THAT is a conditional branch, then we're all ok!
 283   if (pred_begin(Pred1) == pred_end(Pred1) ||
 284       ++pred_begin(Pred1) != pred_end(Pred1) ||
 285       pred_begin(Pred2) == pred_end(Pred2) ||
 286       ++pred_begin(Pred2) != pred_end(Pred2) ||
 287       *pred_begin(Pred1) != *pred_begin(Pred2))
 288     return 0;
 289
 290   // Otherwise, if this is a conditional branch, then we can use it!
 291   BasicBlock *CommonPred = *pred_begin(Pred1);
 292   if (BranchInst *BI = dyn_cast<BranchInst>(CommonPred->getTerminator())) {
 293     assert(BI->isConditional() && "Two successors but not conditional?");
 294     if (BI->getSuccessor(0) == Pred1) {
 295       IfTrue = Pred1;
 296       IfFalse = Pred2;
 297     } else {
 298       IfTrue = Pred2;
 299       IfFalse = Pred1;
 300     }
 301     return BI->getCondition();
 302   }
 303   return 0;
 304 }
 305
 306
 307 // If we have a merge point of an "if condition" as accepted above, return true
 308 // if the specified value dominates the block.  We don't handle the true
 309 // generality of domination here, just a special case which works well enough
 310 // for us.
 311 //
 312 // If AggressiveInsts is non-null, and if V does not dominate BB, we check to
 313 // see if V (which must be an instruction) is cheap to compute and is
 314 // non-trapping.  If both are true, the instruction is inserted into the set and
 315 // true is returned.
 316 static bool DominatesMergePoint(Value *V, BasicBlock *BB,
 317                                 std::set<Instruction*> *AggressiveInsts) {
 318   Instruction *I = dyn_cast<Instruction>(V);
 319   if (!I) return true;    // Non-instructions all dominate instructions.
 320   BasicBlock *PBB = I->getParent();
 321
 322   // We don't want to allow weird loops that might have the "if condition" in
 323   // the bottom of this block.
 324   if (PBB == BB) return false;
 325
 326   // If this instruction is defined in a block that contains an unconditional
 327   // branch to BB, then it must be in the 'conditional' part of the "if
 328   // statement".
 329   if (BranchInst *BI = dyn_cast<BranchInst>(PBB->getTerminator()))
 330     if (BI->isUnconditional() && BI->getSuccessor(0) == BB) {
 331       if (!AggressiveInsts) return false;
 332       // Okay, it looks like the instruction IS in the "condition".  Check to
 333       // see if its a cheap instruction to unconditionally compute, and if it
 334       // only uses stuff defined outside of the condition.  If so, hoist it out.
 335       switch (I->getOpcode()) {
 336       default: return false;  // Cannot hoist this out safely.
 337       case Instruction::Load:
 338         // We can hoist loads that are non-volatile and obviously cannot trap.
 339         if (cast<LoadInst>(I)->isVolatile())
 340           return false;
 341         if (!isa<AllocaInst>(I->getOperand(0)) &&
 342             !isa<Constant>(I->getOperand(0)))
 343           return false;
 344
 345         // Finally, we have to check to make sure there are no instructions
 346         // before the load in its basic block, as we are going to hoist the loop
 347         // out to its predecessor.
 348         if (PBB->begin() != BasicBlock::iterator(I))
 349           return false;
 350         break;
 351       case Instruction::Add:
 352       case Instruction::Sub:
 353       case Instruction::And:
 354       case Instruction::Or:
 355       case Instruction::Xor:
 356       case Instruction::Shl:
 357       case Instruction::Shr:
 358       case Instruction::SetEQ:
 359       case Instruction::SetNE:
 360       case Instruction::SetLT:
 361       case Instruction::SetGT:
 362       case Instruction::SetLE:
 363       case Instruction::SetGE:
 364         break;   // These are all cheap and non-trapping instructions.
 365       }
 366
 367       // Okay, we can only really hoist these out if their operands are not
 368       // defined in the conditional region.
 369       for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
 370         if (!DominatesMergePoint(I->getOperand(i), BB, 0))
 371           return false;
 372       // Okay, it's safe to do this!  Remember this instruction.
 373       AggressiveInsts->insert(I);
 374     }
 375
 376   return true;
 377 }
 378
 379 // GatherConstantSetEQs - Given a potentially 'or'd together collection of seteq
 380 // instructions that compare a value against a constant, return the value being
 381 // compared, and stick the constant into the Values vector.
 382 static Value *GatherConstantSetEQs(Value *V, std::vector<ConstantInt*> &Values){
 383   if (Instruction *Inst = dyn_cast<Instruction>(V))
 384     if (Inst->getOpcode() == Instruction::SetEQ) {
 385       if (ConstantInt *C = dyn_cast<ConstantInt>(Inst->getOperand(1))) {
 386         Values.push_back(C);
 387         return Inst->getOperand(0);
 388       } else if (ConstantInt *C = dyn_cast<ConstantInt>(Inst->getOperand(0))) {
 389         Values.push_back(C);
 390         return Inst->getOperand(1);
 391       }
 392     } else if (Inst->getOpcode() == Instruction::Or) {
 393       if (Value *LHS = GatherConstantSetEQs(Inst->getOperand(0), Values))
 394         if (Value *RHS = GatherConstantSetEQs(Inst->getOperand(1), Values))
 395           if (LHS == RHS)
 396             return LHS;
 397     }
 398   return 0;
 399 }
 400
 401 // GatherConstantSetNEs - Given a potentially 'and'd together collection of
 402 // setne instructions that compare a value against a constant, return the value
 403 // being compared, and stick the constant into the Values vector.
 404 static Value *GatherConstantSetNEs(Value *V, std::vector<ConstantInt*> &Values){
 405   if (Instruction *Inst = dyn_cast<Instruction>(V))
 406     if (Inst->getOpcode() == Instruction::SetNE) {
 407       if (ConstantInt *C = dyn_cast<ConstantInt>(Inst->getOperand(1))) {
 408         Values.push_back(C);
 409         return Inst->getOperand(0);
 410       } else if (ConstantInt *C = dyn_cast<ConstantInt>(Inst->getOperand(0))) {
 411         Values.push_back(C);
 412         return Inst->getOperand(1);
 413       }
 414     } else if (Inst->getOpcode() == Instruction::Cast) {
 415       // Cast of X to bool is really a comparison against zero.
 416       assert(Inst->getType() == Type::BoolTy && "Can only handle bool values!");
 417       Values.push_back(ConstantInt::get(Inst->getOperand(0)->getType(), 0));
 418       return Inst->getOperand(0);
 419     } else if (Inst->getOpcode() == Instruction::And) {
 420       if (Value *LHS = GatherConstantSetNEs(Inst->getOperand(0), Values))
 421         if (Value *RHS = GatherConstantSetNEs(Inst->getOperand(1), Values))
 422           if (LHS == RHS)
 423             return LHS;
 424     }
 425   return 0;
 426 }
 427
 428
 429
 430 /// GatherValueComparisons - If the specified Cond is an 'and' or 'or' of a
 431 /// bunch of comparisons of one value against constants, return the value and
 432 /// the constants being compared.
 433 static bool GatherValueComparisons(Instruction *Cond, Value *&CompVal,
 434                                    std::vector<ConstantInt*> &Values) {
 435   if (Cond->getOpcode() == Instruction::Or) {
 436     CompVal = GatherConstantSetEQs(Cond, Values);
 437
 438     // Return true to indicate that the condition is true if the CompVal is
 439     // equal to one of the constants.
 440     return true;
 441   } else if (Cond->getOpcode() == Instruction::And) {
 442     CompVal = GatherConstantSetNEs(Cond, Values);
 443
 444     // Return false to indicate that the condition is false if the CompVal is
 445     // equal to one of the constants.
 446     return false;
 447   }
 448   return false;
 449 }
 450
 451 /// ErasePossiblyDeadInstructionTree - If the specified instruction is dead and
 452 /// has no side effects, nuke it.  If it uses any instructions that become dead
 453 /// because the instruction is now gone, nuke them too.
 454 static void ErasePossiblyDeadInstructionTree(Instruction *I) {
 455   if (isInstructionTriviallyDead(I)) {
 456     std::vector<Value*> Operands(I->op_begin(), I->op_end());
 457     I->getParent()->getInstList().erase(I);
 458     for (unsigned i = 0, e = Operands.size(); i != e; ++i)
 459       if (Instruction *OpI = dyn_cast<Instruction>(Operands[i]))
 460         ErasePossiblyDeadInstructionTree(OpI);
 461   }
 462 }
 463
 464 // isValueEqualityComparison - Return true if the specified terminator checks to
 465 // see if a value is equal to constant integer value.
 466 static Value *isValueEqualityComparison(TerminatorInst *TI) {
 467   if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
 468     // Do not permit merging of large switch instructions into their
 469     // predecessors unless there is only one predecessor.
 470     if (SI->getNumSuccessors() * std::distance(pred_begin(SI->getParent()),
 471                                                pred_end(SI->getParent())) > 128)
 472       return 0;
 473
 474     return SI->getCondition();
 475   }
 476   if (BranchInst *BI = dyn_cast<BranchInst>(TI))
 477     if (BI->isConditional() && BI->getCondition()->hasOneUse())
 478       if (SetCondInst *SCI = dyn_cast<SetCondInst>(BI->getCondition()))
 479         if ((SCI->getOpcode() == Instruction::SetEQ ||
 480              SCI->getOpcode() == Instruction::SetNE) &&
 481             isa<ConstantInt>(SCI->getOperand(1)))
 482           return SCI->getOperand(0);
 483   return 0;
 484 }
 485
 486 // Given a value comparison instruction, decode all of the 'cases' that it
 487 // represents and return the 'default' block.
 488 static BasicBlock *
 489 GetValueEqualityComparisonCases(TerminatorInst *TI,
 490                                 std::vector<std::pair<ConstantInt*,
 491                                                       BasicBlock*> > &Cases) {
 492   if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
 493     Cases.reserve(SI->getNumCases());
 494     for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
 495       Cases.push_back(std::make_pair(SI->getCaseValue(i), SI->getSuccessor(i)));
 496     return SI->getDefaultDest();
 497   }
 498
 499   BranchInst *BI = cast<BranchInst>(TI);
 500   SetCondInst *SCI = cast<SetCondInst>(BI->getCondition());
 501   Cases.push_back(std::make_pair(cast<ConstantInt>(SCI->getOperand(1)),
 502                                  BI->getSuccessor(SCI->getOpcode() ==
 503                                                         Instruction::SetNE)));
 504   return BI->getSuccessor(SCI->getOpcode() == Instruction::SetEQ);
 505 }
 506
 507
 508 // EliminateBlockCases - Given an vector of bb/value pairs, remove any entries
 509 // in the list that match the specified block.
 510 static void EliminateBlockCases(BasicBlock *BB,
 511                std::vector<std::pair<ConstantInt*, BasicBlock*> > &Cases) {
 512   for (unsigned i = 0, e = Cases.size(); i != e; ++i)
 513     if (Cases[i].second == BB) {
 514       Cases.erase(Cases.begin()+i);
 515       --i; --e;
 516     }
 517 }
 518
 519 // ValuesOverlap - Return true if there are any keys in C1 that exist in C2 as
 520 // well.
 521 static bool
 522 ValuesOverlap(std::vector<std::pair<ConstantInt*, BasicBlock*> > &C1,
 523               std::vector<std::pair<ConstantInt*, BasicBlock*> > &C2) {
 524   std::vector<std::pair<ConstantInt*, BasicBlock*> > *V1 = &C1, *V2 = &C2;
 525
 526   // Make V1 be smaller than V2.
 527   if (V1->size() > V2->size())
 528     std::swap(V1, V2);
 529
 530   if (V1->size() == 0) return false;
 531   if (V1->size() == 1) {
 532     // Just scan V2.
 533     ConstantInt *TheVal = (*V1)[0].first;
 534     for (unsigned i = 0, e = V2->size(); i != e; ++i)
 535       if (TheVal == (*V2)[i].first)
 536         return true;
 537   }
 538
 539   // Otherwise, just sort both lists and compare element by element.
 540   std::sort(V1->begin(), V1->end());
 541   std::sort(V2->begin(), V2->end());
 542   unsigned i1 = 0, i2 = 0, e1 = V1->size(), e2 = V2->size();
 543   while (i1 != e1 && i2 != e2) {
 544     if ((*V1)[i1].first == (*V2)[i2].first)
 545       return true;
 546     if ((*V1)[i1].first < (*V2)[i2].first)
 547       ++i1;
 548     else
 549       ++i2;
 550   }
 551   return false;
 552 }
 553
 554 // SimplifyEqualityComparisonWithOnlyPredecessor - If TI is known to be a
 555 // terminator instruction and its block is known to only have a single
 556 // predecessor block, check to see if that predecessor is also a value
 557 // comparison with the same value, and if that comparison determines the outcome
 558 // of this comparison.  If so, simplify TI.  This does a very limited form of
 559 // jump threading.
 560 static bool SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
 561                                                           BasicBlock *Pred) {
 562   Value *PredVal = isValueEqualityComparison(Pred->getTerminator());
 563   if (!PredVal) return false;  // Not a value comparison in predecessor.
 564
 565   Value *ThisVal = isValueEqualityComparison(TI);
 566   assert(ThisVal && "This isn't a value comparison!!");
 567   if (ThisVal != PredVal) return false;  // Different predicates.
 568
 569   // Find out information about when control will move from Pred to TI's block.
 570   std::vector<std::pair<ConstantInt*, BasicBlock*> > PredCases;
 571   BasicBlock *PredDef = GetValueEqualityComparisonCases(Pred->getTerminator(),
 572                                                         PredCases);
 573   EliminateBlockCases(PredDef, PredCases);  // Remove default from cases.
 574
 575   // Find information about how control leaves this block.
 576   std::vector<std::pair<ConstantInt*, BasicBlock*> > ThisCases;
 577   BasicBlock *ThisDef = GetValueEqualityComparisonCases(TI, ThisCases);
 578   EliminateBlockCases(ThisDef, ThisCases);  // Remove default from cases.
 579
 580   // If TI's block is the default block from Pred's comparison, potentially
 581   // simplify TI based on this knowledge.
 582   if (PredDef == TI->getParent()) {
 583     // If we are here, we know that the value is none of those cases listed in
 584     // PredCases.  If there are any cases in ThisCases that are in PredCases, we
 585     // can simplify TI.
 586     if (ValuesOverlap(PredCases, ThisCases)) {
 587       if (BranchInst *BTI = dyn_cast<BranchInst>(TI)) {
 588         // Okay, one of the successors of this condbr is dead.  Convert it to a
 589         // uncond br.
 590         assert(ThisCases.size() == 1 && "Branch can only have one case!");
 591         Value *Cond = BTI->getCondition();
 592         // Insert the new branch.
 593         Instruction *NI = new BranchInst(ThisDef, TI);
 594
 595         // Remove PHI node entries for the dead edge.
 596         ThisCases[0].second->removePredecessor(TI->getParent());
 597
 598         DEBUG(std::cerr << "Threading pred instr: " << *Pred->getTerminator()
 599               << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
 600
 601         TI->eraseFromParent();   // Nuke the old one.
 602         // If condition is now dead, nuke it.
 603         if (Instruction *CondI = dyn_cast<Instruction>(Cond))
 604           ErasePossiblyDeadInstructionTree(CondI);
 605         return true;
 606
 607       } else {
 608         SwitchInst *SI = cast<SwitchInst>(TI);
 609         // Okay, TI has cases that are statically dead, prune them away.
 610         std::set<Constant*> DeadCases;
 611         for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
 612           DeadCases.insert(PredCases[i].first);
 613
 614         DEBUG(std::cerr << "Threading pred instr: " << *Pred->getTerminator()
 615                   << "Through successor TI: " << *TI);
 616
 617         for (unsigned i = SI->getNumCases()-1; i != 0; --i)
 618           if (DeadCases.count(SI->getCaseValue(i))) {
 619             SI->getSuccessor(i)->removePredecessor(TI->getParent());
 620             SI->removeCase(i);
 621           }
 622
 623         DEBUG(std::cerr << "Leaving: " << *TI << "\n");
 624         return true;
 625       }
 626     }
 627
 628   } else {
 629     // Otherwise, TI's block must correspond to some matched value.  Find out
 630     // which value (or set of values) this is.
 631     ConstantInt *TIV = 0;
 632     BasicBlock *TIBB = TI->getParent();
 633     for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
 634       if (PredCases[i].second == TIBB)
 635         if (TIV == 0)
 636           TIV = PredCases[i].first;
 637         else
 638           return false;  // Cannot handle multiple values coming to this block.
 639     assert(TIV && "No edge from pred to succ?");
 640
 641     // Okay, we found the one constant that our value can be if we get into TI's
 642     // BB.  Find out which successor will unconditionally be branched to.
 643     BasicBlock *TheRealDest = 0;
 644     for (unsigned i = 0, e = ThisCases.size(); i != e; ++i)
 645       if (ThisCases[i].first == TIV) {
 646         TheRealDest = ThisCases[i].second;
 647         break;
 648       }
 649
 650     // If not handled by any explicit cases, it is handled by the default case.
 651     if (TheRealDest == 0) TheRealDest = ThisDef;
 652
 653     // Remove PHI node entries for dead edges.
 654     BasicBlock *CheckEdge = TheRealDest;
 655     for (succ_iterator SI = succ_begin(TIBB), e = succ_end(TIBB); SI != e; ++SI)
 656       if (*SI != CheckEdge)
 657         (*SI)->removePredecessor(TIBB);
 658       else
 659         CheckEdge = 0;
 660
 661     // Insert the new branch.
 662     Instruction *NI = new BranchInst(TheRealDest, TI);
 663
 664     DEBUG(std::cerr << "Threading pred instr: " << *Pred->getTerminator()
 665           << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
 666     Instruction *Cond = 0;
 667     if (BranchInst *BI = dyn_cast<BranchInst>(TI))
 668       Cond = dyn_cast<Instruction>(BI->getCondition());
 669     TI->eraseFromParent();   // Nuke the old one.
 670
 671     if (Cond) ErasePossiblyDeadInstructionTree(Cond);
 672     return true;
 673   }
 674   return false;
 675 }
 676
 677 // FoldValueComparisonIntoPredecessors - The specified terminator is a value
 678 // equality comparison instruction (either a switch or a branch on "X == c").
 679 // See if any of the predecessors of the terminator block are value comparisons
 680 // on the same value.  If so, and if safe to do so, fold them together.
 681 static bool FoldValueComparisonIntoPredecessors(TerminatorInst *TI) {
 682   BasicBlock *BB = TI->getParent();
 683   Value *CV = isValueEqualityComparison(TI);  // CondVal
 684   assert(CV && "Not a comparison?");
 685   bool Changed = false;
 686
 687   std::vector<BasicBlock*> Preds(pred_begin(BB), pred_end(BB));
 688   while (!Preds.empty()) {
 689     BasicBlock *Pred = Preds.back();
 690     Preds.pop_back();
 691
 692     // See if the predecessor is a comparison with the same value.
 693     TerminatorInst *PTI = Pred->getTerminator();
 694     Value *PCV = isValueEqualityComparison(PTI);  // PredCondVal
 695
 696     if (PCV == CV && SafeToMergeTerminators(TI, PTI)) {
 697       // Figure out which 'cases' to copy from SI to PSI.
 698       std::vector<std::pair<ConstantInt*, BasicBlock*> > BBCases;
 699       BasicBlock *BBDefault = GetValueEqualityComparisonCases(TI, BBCases);
 700
 701       std::vector<std::pair<ConstantInt*, BasicBlock*> > PredCases;
 702       BasicBlock *PredDefault = GetValueEqualityComparisonCases(PTI, PredCases);
 703
 704       // Based on whether the default edge from PTI goes to BB or not, fill in
 705       // PredCases and PredDefault with the new switch cases we would like to
 706       // build.
 707       std::vector<BasicBlock*> NewSuccessors;
 708
 709       if (PredDefault == BB) {
 710         // If this is the default destination from PTI, only the edges in TI
 711         // that don't occur in PTI, or that branch to BB will be activated.
 712         std::set<ConstantInt*> PTIHandled;
 713         for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
 714           if (PredCases[i].second != BB)
 715             PTIHandled.insert(PredCases[i].first);
 716           else {
 717             // The default destination is BB, we don't need explicit targets.
 718             std::swap(PredCases[i], PredCases.back());
 719             PredCases.pop_back();
 720             --i; --e;
 721           }
 722
 723         // Reconstruct the new switch statement we will be building.
 724         if (PredDefault != BBDefault) {
 725           PredDefault->removePredecessor(Pred);
 726           PredDefault = BBDefault;
 727           NewSuccessors.push_back(BBDefault);
 728         }
 729         for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
 730           if (!PTIHandled.count(BBCases[i].first) &&
 731               BBCases[i].second != BBDefault) {
 732             PredCases.push_back(BBCases[i]);
 733             NewSuccessors.push_back(BBCases[i].second);
 734           }
 735
 736       } else {
 737         // If this is not the default destination from PSI, only the edges
 738         // in SI that occur in PSI with a destination of BB will be
 739         // activated.
 740         std::set<ConstantInt*> PTIHandled;
 741         for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
 742           if (PredCases[i].second == BB) {
 743             PTIHandled.insert(PredCases[i].first);
 744             std::swap(PredCases[i], PredCases.back());
 745             PredCases.pop_back();
 746             --i; --e;
 747           }
 748
 749         // Okay, now we know which constants were sent to BB from the
 750         // predecessor.  Figure out where they will all go now.
 751         for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
 752           if (PTIHandled.count(BBCases[i].first)) {
 753             // If this is one we are capable of getting...
 754             PredCases.push_back(BBCases[i]);
 755             NewSuccessors.push_back(BBCases[i].second);
 756             PTIHandled.erase(BBCases[i].first);// This constant is taken care of
 757           }
 758
 759         // If there are any constants vectored to BB that TI doesn't handle,
 760         // they must go to the default destination of TI.
 761         for (std::set<ConstantInt*>::iterator I = PTIHandled.begin(),
 762                E = PTIHandled.end(); I != E; ++I) {
 763           PredCases.push_back(std::make_pair(*I, BBDefault));
 764           NewSuccessors.push_back(BBDefault);
 765         }
 766       }
 767
 768       // Okay, at this point, we know which new successor Pred will get.  Make
 769       // sure we update the number of entries in the PHI nodes for these
 770       // successors.
 771       for (unsigned i = 0, e = NewSuccessors.size(); i != e; ++i)
 772         AddPredecessorToBlock(NewSuccessors[i], Pred, BB);
 773
 774       // Now that the successors are updated, create the new Switch instruction.
 775       SwitchInst *NewSI = new SwitchInst(CV, PredDefault, PredCases.size(),PTI);
 776       for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
 777         NewSI->addCase(PredCases[i].first, PredCases[i].second);
 778
 779       Instruction *DeadCond = 0;
 780       if (BranchInst *BI = dyn_cast<BranchInst>(PTI))
 781         // If PTI is a branch, remember the condition.
 782         DeadCond = dyn_cast<Instruction>(BI->getCondition());
 783       Pred->getInstList().erase(PTI);
 784
 785       // If the condition is dead now, remove the instruction tree.
 786       if (DeadCond) ErasePossiblyDeadInstructionTree(DeadCond);
 787
 788       // Okay, last check.  If BB is still a successor of PSI, then we must
 789       // have an infinite loop case.  If so, add an infinitely looping block
 790       // to handle the case to preserve the behavior of the code.
 791       BasicBlock *InfLoopBlock = 0;
 792       for (unsigned i = 0, e = NewSI->getNumSuccessors(); i != e; ++i)
 793         if (NewSI->getSuccessor(i) == BB) {
 794           if (InfLoopBlock == 0) {
 795             // Insert it at the end of the loop, because it's either code,
 796             // or it won't matter if it's hot. :)
 797             InfLoopBlock = new BasicBlock("infloop", BB->getParent());
 798             new BranchInst(InfLoopBlock, InfLoopBlock);
 799           }
 800           NewSI->setSuccessor(i, InfLoopBlock);
 801         }
 802
 803       Changed = true;
 804     }
 805   }
 806   return Changed;
 807 }
 808
 809 /// HoistThenElseCodeToIf - Given a conditional branch that goes to BB1 and
 810 /// BB2, hoist any common code in the two blocks up into the branch block.  The
 811 /// caller of this function guarantees that BI's block dominates BB1 and BB2.
 812 static bool HoistThenElseCodeToIf(BranchInst *BI) {
 813   // This does very trivial matching, with limited scanning, to find identical
 814   // instructions in the two blocks.  In particular, we don't want to get into
 815   // O(M*N) situations here where M and N are the sizes of BB1 and BB2.  As
 816   // such, we currently just scan for obviously identical instructions in an
 817   // identical order.
 818   BasicBlock *BB1 = BI->getSuccessor(0);  // The true destination.
 819   BasicBlock *BB2 = BI->getSuccessor(1);  // The false destination
 820
 821   Instruction *I1 = BB1->begin(), *I2 = BB2->begin();
 822   if (I1->getOpcode() != I2->getOpcode() || !I1->isIdenticalTo(I2) ||
 823       isa<PHINode>(I1))
 824     return false;
 825
 826   // If we get here, we can hoist at least one instruction.
 827   BasicBlock *BIParent = BI->getParent();
 828
 829   do {
 830     // If we are hoisting the terminator instruction, don't move one (making a
 831     // broken BB), instead clone it, and remove BI.
 832     if (isa<TerminatorInst>(I1))
 833       goto HoistTerminator;
 834
 835     // For a normal instruction, we just move one to right before the branch,
 836     // then replace all uses of the other with the first.  Finally, we remove
 837     // the now redundant second instruction.
 838     BIParent->getInstList().splice(BI, BB1->getInstList(), I1);
 839     if (!I2->use_empty())
 840       I2->replaceAllUsesWith(I1);
 841     BB2->getInstList().erase(I2);
 842
 843     I1 = BB1->begin();
 844     I2 = BB2->begin();
 845   } while (I1->getOpcode() == I2->getOpcode() && I1->isIdenticalTo(I2));
 846
 847   return true;
 848
 849 HoistTerminator:
 850   // Okay, it is safe to hoist the terminator.
 851   Instruction *NT = I1->clone();
 852   BIParent->getInstList().insert(BI, NT);
 853   if (NT->getType() != Type::VoidTy) {
 854     I1->replaceAllUsesWith(NT);
 855     I2->replaceAllUsesWith(NT);
 856     NT->setName(I1->getName());
 857   }
 858
 859   // Hoisting one of the terminators from our successor is a great thing.
 860   // Unfortunately, the successors of the if/else blocks may have PHI nodes in
 861   // them.  If they do, all PHI entries for BB1/BB2 must agree for all PHI
 862   // nodes, so we insert select instruction to compute the final result.
 863   std::map<std::pair<Value*,Value*>, SelectInst*> InsertedSelects;
 864   for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
 865     PHINode *PN;
 866     for (BasicBlock::iterator BBI = SI->begin();
 867          (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
 868       Value *BB1V = PN->getIncomingValueForBlock(BB1);
 869       Value *BB2V = PN->getIncomingValueForBlock(BB2);
 870       if (BB1V != BB2V) {
 871         // These values do not agree.  Insert a select instruction before NT
 872         // that determines the right value.
 873         SelectInst *&SI = InsertedSelects[std::make_pair(BB1V, BB2V)];
 874         if (SI == 0)
 875           SI = new SelectInst(BI->getCondition(), BB1V, BB2V,
 876                               BB1V->getName()+"."+BB2V->getName(), NT);
 877         // Make the PHI node use the select for all incoming values for BB1/BB2
 878         for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 879           if (PN->getIncomingBlock(i) == BB1 || PN->getIncomingBlock(i) == BB2)
 880             PN->setIncomingValue(i, SI);
 881       }
 882     }
 883   }
 884
 885   // Update any PHI nodes in our new successors.
 886   for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI)
 887     AddPredecessorToBlock(*SI, BIParent, BB1);
 888
 889   BI->eraseFromParent();
 890   return true;
 891 }
 892
 893 /// BlockIsSimpleEnoughToThreadThrough - Return true if we can thread a branch
 894 /// across this block.
 895 static bool BlockIsSimpleEnoughToThreadThrough(BasicBlock *BB) {
 896   BranchInst *BI = cast<BranchInst>(BB->getTerminator());
 897   Value *Cond = BI->getCondition();
 898
 899   unsigned Size = 0;
 900
 901   // If this basic block contains anything other than a PHI (which controls the
 902   // branch) and branch itself, bail out.  FIXME: improve this in the future.
 903   for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI, ++Size) {
 904     if (Size > 10) return false;  // Don't clone large BB's.
 905
 906     // We can only support instructions that are do not define values that are
 907     // live outside of the current basic block.
 908     for (Value::use_iterator UI = BBI->use_begin(), E = BBI->use_end();
 909          UI != E; ++UI) {
 910       Instruction *U = cast<Instruction>(*UI);
 911       if (U->getParent() != BB || isa<PHINode>(U)) return false;
 912     }
 913
 914     // Looks ok, continue checking.
 915   }
 916
 917   return true;
 918 }
 919
 920 /// FoldCondBranchOnPHI - If we have a conditional branch on a PHI node value
 921 /// that is defined in the same block as the branch and if any PHI entries are
 922 /// constants, thread edges corresponding to that entry to be branches to their
 923 /// ultimate destination.
 924 static bool FoldCondBranchOnPHI(BranchInst *BI) {
 925   BasicBlock *BB = BI->getParent();
 926   PHINode *PN = dyn_cast<PHINode>(BI->getCondition());
 927   // NOTE: we currently cannot transform this case if the PHI node is used
 928   // outside of the block.
 929   if (!PN || PN->getParent() != BB || !PN->hasOneUse())
 930     return false;
 931
 932   // Degenerate case of a single entry PHI.
 933   if (PN->getNumIncomingValues() == 1) {
 934     if (PN->getIncomingValue(0) != PN)
 935       PN->replaceAllUsesWith(PN->getIncomingValue(0));
 936     else
 937       PN->replaceAllUsesWith(UndefValue::get(PN->getType()));
 938     PN->eraseFromParent();
 939     return true;
 940   }
 941
 942   // Now we know that this block has multiple preds and two succs.
 943   if (!BlockIsSimpleEnoughToThreadThrough(BB)) return false;
 944
 945   // Okay, this is a simple enough basic block.  See if any phi values are
 946   // constants.
 947   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 948     if (ConstantBool *CB = dyn_cast<ConstantBool>(PN->getIncomingValue(i))) {
 949       // Okay, we now know that all edges from PredBB should be revectored to
 950       // branch to RealDest.
 951       BasicBlock *PredBB = PN->getIncomingBlock(i);
 952       BasicBlock *RealDest = BI->getSuccessor(!CB->getValue());
 953
 954       if (RealDest == BB) continue;  // Skip self loops.
 955
 956       // The dest block might have PHI nodes, other predecessors and other
 957       // difficult cases.  Instead of being smart about this, just insert a new
 958       // block that jumps to the destination block, effectively splitting
 959       // the edge we are about to create.
 960       BasicBlock *EdgeBB = new BasicBlock(RealDest->getName()+".critedge",
 961                                           RealDest->getParent(), RealDest);
 962       new BranchInst(RealDest, EdgeBB);
 963       PHINode *PN;
 964       for (BasicBlock::iterator BBI = RealDest->begin();
 965            (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
 966         Value *V = PN->getIncomingValueForBlock(BB);
 967         PN->addIncoming(V, EdgeBB);
 968       }
 969
 970       // BB may have instructions that are being threaded over.  Clone these
 971       // instructions into EdgeBB.  We know that there will be no uses of the
 972       // cloned instructions outside of EdgeBB.
 973       BasicBlock::iterator InsertPt = EdgeBB->begin();
 974       std::map<Value*, Value*> TranslateMap;  // Track translated values.
 975       for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
 976         if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
 977           TranslateMap[PN] = PN->getIncomingValueForBlock(PredBB);
 978         } else {
 979           // Clone the instruction.
 980           Instruction *N = BBI->clone();
 981           if (BBI->hasName()) N->setName(BBI->getName()+".c");
 982
 983           // Update operands due to translation.
 984           for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
 985             std::map<Value*, Value*>::iterator PI =
 986               TranslateMap.find(N->getOperand(i));
 987             if (PI != TranslateMap.end())
 988               N->setOperand(i, PI->second);
 989           }
 990
 991           // Check for trivial simplification.
 992           if (Constant *C = ConstantFoldInstruction(N)) {
 993             std::cerr << "FOLDED: " << *N;
 994             TranslateMap[BBI] = C;
 995             delete N;   // Constant folded away, don't need actual inst
 996           } else {
 997             // Insert the new instruction into its new home.
 998             EdgeBB->getInstList().insert(InsertPt, N);
 999             if (!BBI->use_empty())
1000               TranslateMap[BBI] = N;
1001           }
1002         }
1003       }
1004
1005       // Loop over all of the edges from PredBB to BB, changing them to branch
1006       // to EdgeBB instead.
1007       TerminatorInst *PredBBTI = PredBB->getTerminator();
1008       for (unsigned i = 0, e = PredBBTI->getNumSuccessors(); i != e; ++i)
1009         if (PredBBTI->getSuccessor(i) == BB) {
1010           BB->removePredecessor(PredBB);
1011           PredBBTI->setSuccessor(i, EdgeBB);
1012         }
1013
1014       // Recurse, simplifying any other constants.
1015       return FoldCondBranchOnPHI(BI) | true;
1016     }
1017
1018   return false;
1019 }
1020
1021
1022 namespace {
1023   /// ConstantIntOrdering - This class implements a stable ordering of constant
1024   /// integers that does not depend on their address.  This is important for
1025   /// applications that sort ConstantInt's to ensure uniqueness.
1026   struct ConstantIntOrdering {
1027     bool operator()(const ConstantInt *LHS, const ConstantInt *RHS) const {
1028       return LHS->getRawValue() < RHS->getRawValue();
1029     }
1030   };
1031 }
1032
1033 // SimplifyCFG - This function is used to do simplification of a CFG.  For
1034 // example, it adjusts branches to branches to eliminate the extra hop, it
1035 // eliminates unreachable basic blocks, and does other "peephole" optimization
1036 // of the CFG.  It returns true if a modification was made.
1037 //
1038 // WARNING:  The entry node of a function may not be simplified.
1039 //
1040 bool llvm::SimplifyCFG(BasicBlock *BB) {
1041   bool Changed = false;
1042   Function *M = BB->getParent();
1043
1044   assert(BB && BB->getParent() && "Block not embedded in function!");
1045   assert(BB->getTerminator() && "Degenerate basic block encountered!");
1046   assert(&BB->getParent()->front() != BB && "Can't Simplify entry block!");
1047
1048   // Remove basic blocks that have no predecessors... which are unreachable.
1049   if (pred_begin(BB) == pred_end(BB) ||
1050       *pred_begin(BB) == BB && ++pred_begin(BB) == pred_end(BB)) {
1051     DEBUG(std::cerr << "Removing BB: \n" << *BB);
1052
1053     // Loop through all of our successors and make sure they know that one
1054     // of their predecessors is going away.
1055     for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI)
1056       SI->removePredecessor(BB);
1057
1058     while (!BB->empty()) {
1059       Instruction &I = BB->back();
1060       // If this instruction is used, replace uses with an arbitrary
1061       // value.  Because control flow can't get here, we don't care
1062       // what we replace the value with.  Note that since this block is
1063       // unreachable, and all values contained within it must dominate their
1064       // uses, that all uses will eventually be removed.
1065       if (!I.use_empty())
1066         // Make all users of this instruction use undef instead
1067         I.replaceAllUsesWith(UndefValue::get(I.getType()));
1068
1069       // Remove the instruction from the basic block
1070       BB->getInstList().pop_back();
1071     }
1072     M->getBasicBlockList().erase(BB);
1073     return true;
1074   }
1075
1076   // Check to see if we can constant propagate this terminator instruction
1077   // away...
1078   Changed |= ConstantFoldTerminator(BB);
1079
1080   // If this is a returning block with only PHI nodes in it, fold the return
1081   // instruction into any unconditional branch predecessors.
1082   //
1083   // If any predecessor is a conditional branch that just selects among
1084   // different return values, fold the replace the branch/return with a select
1085   // and return.
1086   if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
1087     BasicBlock::iterator BBI = BB->getTerminator();
1088     if (BBI == BB->begin() || isa<PHINode>(--BBI)) {
1089       // Find predecessors that end with branches.
1090       std::vector<BasicBlock*> UncondBranchPreds;
1091       std::vector<BranchInst*> CondBranchPreds;
1092       for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
1093         TerminatorInst *PTI = (*PI)->getTerminator();
1094         if (BranchInst *BI = dyn_cast<BranchInst>(PTI))
1095           if (BI->isUnconditional())
1096             UncondBranchPreds.push_back(*PI);
1097           else
1098             CondBranchPreds.push_back(BI);
1099       }
1100
1101       // If we found some, do the transformation!
1102       if (!UncondBranchPreds.empty()) {
1103         while (!UncondBranchPreds.empty()) {
1104           BasicBlock *Pred = UncondBranchPreds.back();
1105           UncondBranchPreds.pop_back();
1106           Instruction *UncondBranch = Pred->getTerminator();
1107           // Clone the return and add it to the end of the predecessor.
1108           Instruction *NewRet = RI->clone();
1109           Pred->getInstList().push_back(NewRet);
1110
1111           // If the return instruction returns a value, and if the value was a
1112           // PHI node in "BB", propagate the right value into the return.
1113           if (NewRet->getNumOperands() == 1)
1114             if (PHINode *PN = dyn_cast<PHINode>(NewRet->getOperand(0)))
1115               if (PN->getParent() == BB)
1116                 NewRet->setOperand(0, PN->getIncomingValueForBlock(Pred));
1117           // Update any PHI nodes in the returning block to realize that we no
1118           // longer branch to them.
1119           BB->removePredecessor(Pred);
1120           Pred->getInstList().erase(UncondBranch);
1121         }
1122
1123         // If we eliminated all predecessors of the block, delete the block now.
1124         if (pred_begin(BB) == pred_end(BB))
1125           // We know there are no successors, so just nuke the block.
1126           M->getBasicBlockList().erase(BB);
1127
1128         return true;
1129       }
1130
1131       // Check out all of the conditional branches going to this return
1132       // instruction.  If any of them just select between returns, change the
1133       // branch itself into a select/return pair.
1134       while (!CondBranchPreds.empty()) {
1135         BranchInst *BI = CondBranchPreds.back();
1136         CondBranchPreds.pop_back();
1137         BasicBlock *TrueSucc = BI->getSuccessor(0);
1138         BasicBlock *FalseSucc = BI->getSuccessor(1);
1139         BasicBlock *OtherSucc = TrueSucc == BB ? FalseSucc : TrueSucc;
1140
1141         // Check to see if the non-BB successor is also a return block.
1142         if (isa<ReturnInst>(OtherSucc->getTerminator())) {
1143           // Check to see if there are only PHI instructions in this block.
1144           BasicBlock::iterator OSI = OtherSucc->getTerminator();
1145           if (OSI == OtherSucc->begin() || isa<PHINode>(--OSI)) {
1146             // Okay, we found a branch that is going to two return nodes.  If
1147             // there is no return value for this function, just change the
1148             // branch into a return.
1149             if (RI->getNumOperands() == 0) {
1150               TrueSucc->removePredecessor(BI->getParent());
1151               FalseSucc->removePredecessor(BI->getParent());
1152               new ReturnInst(0, BI);
1153               BI->getParent()->getInstList().erase(BI);
1154               return true;
1155             }
1156
1157             // Otherwise, figure out what the true and false return values are
1158             // so we can insert a new select instruction.
1159             Value *TrueValue = TrueSucc->getTerminator()->getOperand(0);
1160             Value *FalseValue = FalseSucc->getTerminator()->getOperand(0);
1161
1162             // Unwrap any PHI nodes in the return blocks.
1163             if (PHINode *TVPN = dyn_cast<PHINode>(TrueValue))
1164               if (TVPN->getParent() == TrueSucc)
1165                 TrueValue = TVPN->getIncomingValueForBlock(BI->getParent());
1166             if (PHINode *FVPN = dyn_cast<PHINode>(FalseValue))
1167               if (FVPN->getParent() == FalseSucc)
1168                 FalseValue = FVPN->getIncomingValueForBlock(BI->getParent());
1169
1170             TrueSucc->removePredecessor(BI->getParent());
1171             FalseSucc->removePredecessor(BI->getParent());
1172
1173             // Insert a new select instruction.
1174             Value *NewRetVal;
1175             Value *BrCond = BI->getCondition();
1176             if (TrueValue != FalseValue)
1177               NewRetVal = new SelectInst(BrCond, TrueValue,
1178                                          FalseValue, "retval", BI);
1179             else
1180               NewRetVal = TrueValue;
1181
1182             new ReturnInst(NewRetVal, BI);
1183             BI->getParent()->getInstList().erase(BI);
1184             if (BrCond->use_empty())
1185               if (Instruction *BrCondI = dyn_cast<Instruction>(BrCond))
1186                 BrCondI->getParent()->getInstList().erase(BrCondI);
1187             return true;
1188           }
1189         }
1190       }
1191     }
1192   } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->begin())) {
1193     // Check to see if the first instruction in this block is just an unwind.
1194     // If so, replace any invoke instructions which use this as an exception
1195     // destination with call instructions, and any unconditional branch
1196     // predecessor with an unwind.
1197     //
1198     std::vector<BasicBlock*> Preds(pred_begin(BB), pred_end(BB));
1199     while (!Preds.empty()) {
1200       BasicBlock *Pred = Preds.back();
1201       if (BranchInst *BI = dyn_cast<BranchInst>(Pred->getTerminator())) {
1202         if (BI->isUnconditional()) {
1203           Pred->getInstList().pop_back();  // nuke uncond branch
1204           new UnwindInst(Pred);            // Use unwind.
1205           Changed = true;
1206         }
1207       } else if (InvokeInst *II = dyn_cast<InvokeInst>(Pred->getTerminator()))
1208         if (II->getUnwindDest() == BB) {
1209           // Insert a new branch instruction before the invoke, because this
1210           // is now a fall through...
1211           BranchInst *BI = new BranchInst(II->getNormalDest(), II);
1212           Pred->getInstList().remove(II);   // Take out of symbol table
1213
1214           // Insert the call now...
1215           std::vector<Value*> Args(II->op_begin()+3, II->op_end());
1216           CallInst *CI = new CallInst(II->getCalledValue(), Args,
1217                                       II->getName(), BI);
1218           CI->setCallingConv(II->getCallingConv());
1219           // If the invoke produced a value, the Call now does instead
1220           II->replaceAllUsesWith(CI);
1221           delete II;
1222           Changed = true;
1223         }
1224
1225       Preds.pop_back();
1226     }
1227
1228     // If this block is now dead, remove it.
1229     if (pred_begin(BB) == pred_end(BB)) {
1230       // We know there are no successors, so just nuke the block.
1231       M->getBasicBlockList().erase(BB);
1232       return true;
1233     }
1234
1235   } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
1236     if (isValueEqualityComparison(SI)) {
1237       // If we only have one predecessor, and if it is a branch on this value,
1238       // see if that predecessor totally determines the outcome of this switch.
1239       if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
1240         if (SimplifyEqualityComparisonWithOnlyPredecessor(SI, OnlyPred))
1241           return SimplifyCFG(BB) || 1;
1242
1243       // If the block only contains the switch, see if we can fold the block
1244       // away into any preds.
1245       if (SI == &BB->front())
1246         if (FoldValueComparisonIntoPredecessors(SI))
1247           return SimplifyCFG(BB) || 1;
1248     }
1249   } else if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
1250     if (BI->isUnconditional()) {
1251       BasicBlock::iterator BBI = BB->begin();  // Skip over phi nodes...
1252       while (isa<PHINode>(*BBI)) ++BBI;
1253
1254       BasicBlock *Succ = BI->getSuccessor(0);
1255       if (BBI->isTerminator() &&  // Terminator is the only non-phi instruction!
1256           Succ != BB)             // Don't hurt infinite loops!
1257         if (TryToSimplifyUncondBranchFromEmptyBlock(BB, Succ))
1258           return 1;
1259
1260     } else {  // Conditional branch
1261       if (Value *CompVal = isValueEqualityComparison(BI)) {
1262         // If we only have one predecessor, and if it is a branch on this value,
1263         // see if that predecessor totally determines the outcome of this
1264         // switch.
1265         if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
1266           if (SimplifyEqualityComparisonWithOnlyPredecessor(BI, OnlyPred))
1267             return SimplifyCFG(BB) || 1;
1268
1269         // This block must be empty, except for the setcond inst, if it exists.
1270         BasicBlock::iterator I = BB->begin();
1271         if (&*I == BI ||
1272             (&*I == cast<Instruction>(BI->getCondition()) &&
1273              &*++I == BI))
1274           if (FoldValueComparisonIntoPredecessors(BI))
1275             return SimplifyCFG(BB) | true;
1276       }
1277
1278       // If this is a branch on a phi node in the current block, thread control
1279       // through this block if any PHI node entries are constants.
1280       if (PHINode *PN = dyn_cast<PHINode>(BI->getCondition()))
1281         if (PN->getParent() == BI->getParent())
1282           if (FoldCondBranchOnPHI(BI))
1283             return SimplifyCFG(BB) | true;
1284
1285
1286       // If this basic block is ONLY a setcc and a branch, and if a predecessor
1287       // branches to us and one of our successors, fold the setcc into the
1288       // predecessor and use logical operations to pick the right destination.
1289       BasicBlock *TrueDest  = BI->getSuccessor(0);
1290       BasicBlock *FalseDest = BI->getSuccessor(1);
1291       if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(BI->getCondition()))
1292         if (Cond->getParent() == BB && &BB->front() == Cond &&
1293             Cond->getNext() == BI && Cond->hasOneUse() &&
1294             TrueDest != BB && FalseDest != BB)
1295           for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI!=E; ++PI)
1296             if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
1297               if (PBI->isConditional() && SafeToMergeTerminators(BI, PBI)) {
1298                 BasicBlock *PredBlock = *PI;
1299                 if (PBI->getSuccessor(0) == FalseDest ||
1300                     PBI->getSuccessor(1) == TrueDest) {
1301                   // Invert the predecessors condition test (xor it with true),
1302                   // which allows us to write this code once.
1303                   Value *NewCond =
1304                     BinaryOperator::createNot(PBI->getCondition(),
1305                                     PBI->getCondition()->getName()+".not", PBI);
1306                   PBI->setCondition(NewCond);
1307                   BasicBlock *OldTrue = PBI->getSuccessor(0);
1308                   BasicBlock *OldFalse = PBI->getSuccessor(1);
1309                   PBI->setSuccessor(0, OldFalse);
1310                   PBI->setSuccessor(1, OldTrue);
1311                 }
1312
1313                 if (PBI->getSuccessor(0) == TrueDest ||
1314                     PBI->getSuccessor(1) == FalseDest) {
1315                   // Clone Cond into the predecessor basic block, and or/and the
1316                   // two conditions together.
1317                   Instruction *New = Cond->clone();
1318                   New->setName(Cond->getName());
1319                   Cond->setName(Cond->getName()+".old");
1320                   PredBlock->getInstList().insert(PBI, New);
1321                   Instruction::BinaryOps Opcode =
1322                     PBI->getSuccessor(0) == TrueDest ?
1323                     Instruction::Or : Instruction::And;
1324                   Value *NewCond =
1325                     BinaryOperator::create(Opcode, PBI->getCondition(),
1326                                            New, "bothcond", PBI);
1327                   PBI->setCondition(NewCond);
1328                   if (PBI->getSuccessor(0) == BB) {
1329                     AddPredecessorToBlock(TrueDest, PredBlock, BB);
1330                     PBI->setSuccessor(0, TrueDest);
1331                   }
1332                   if (PBI->getSuccessor(1) == BB) {
1333                     AddPredecessorToBlock(FalseDest, PredBlock, BB);
1334                     PBI->setSuccessor(1, FalseDest);
1335                   }
1336                   return SimplifyCFG(BB) | 1;
1337                 }
1338               }
1339
1340       // If this block ends with a branch instruction, and if there is a
1341       // predecessor that ends on a branch of the same condition, make this
1342       // conditional branch redundant.
1343       for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
1344         if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
1345           if (PBI != BI && PBI->isConditional() &&
1346               PBI->getCondition() == BI->getCondition() &&
1347               PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
1348             // Okay, the outcome of this conditional branch is statically
1349             // knowable.  If this block had a single pred, handle specially.
1350             if (BB->getSinglePredecessor()) {
1351               // Turn this into a branch on constant.
1352               bool CondIsTrue = PBI->getSuccessor(0) == BB;
1353               BI->setCondition(ConstantBool::get(CondIsTrue));
1354               return SimplifyCFG(BB);  // Nuke the branch on constant.
1355             }
1356
1357             // Otherwise, if there are multiple predecessors, insert a PHI that
1358             // merges in the constant and simplify the block result.
1359             if (BlockIsSimpleEnoughToThreadThrough(BB)) {
1360               PHINode *NewPN = new PHINode(Type::BoolTy,
1361                                            BI->getCondition()->getName()+".pr",
1362                                            BB->begin());
1363               for (PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
1364                 if ((PBI = dyn_cast<BranchInst>((*PI)->getTerminator())) &&
1365                     PBI != BI && PBI->isConditional() &&
1366                     PBI->getCondition() == BI->getCondition() &&
1367                     PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
1368                   bool CondIsTrue = PBI->getSuccessor(0) == BB;
1369                   NewPN->addIncoming(ConstantBool::get(CondIsTrue), *PI);
1370                 } else {
1371                   NewPN->addIncoming(BI->getCondition(), *PI);
1372                 }
1373
1374               BI->setCondition(NewPN);
1375               // This will thread the branch.
1376               return SimplifyCFG(BB) | true;
1377             }
1378           }
1379     }
1380   } else if (isa<UnreachableInst>(BB->getTerminator())) {
1381     // If there are any instructions immediately before the unreachable that can
1382     // be removed, do so.
1383     Instruction *Unreachable = BB->getTerminator();
1384     while (Unreachable != BB->begin()) {
1385       BasicBlock::iterator BBI = Unreachable;
1386       --BBI;
1387       if (isa<CallInst>(BBI)) break;
1388       // Delete this instruction
1389       BB->getInstList().erase(BBI);
1390       Changed = true;
1391     }
1392
1393     // If the unreachable instruction is the first in the block, take a gander
1394     // at all of the predecessors of this instruction, and simplify them.
1395     if (&BB->front() == Unreachable) {
1396       std::vector<BasicBlock*> Preds(pred_begin(BB), pred_end(BB));
1397       for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
1398         TerminatorInst *TI = Preds[i]->getTerminator();
1399
1400         if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
1401           if (BI->isUnconditional()) {
1402             if (BI->getSuccessor(0) == BB) {
1403               new UnreachableInst(TI);
1404               TI->eraseFromParent();
1405               Changed = true;
1406             }
1407           } else {
1408             if (BI->getSuccessor(0) == BB) {
1409               new BranchInst(BI->getSuccessor(1), BI);
1410               BI->eraseFromParent();
1411             } else if (BI->getSuccessor(1) == BB) {
1412               new BranchInst(BI->getSuccessor(0), BI);
1413               BI->eraseFromParent();
1414               Changed = true;
1415             }
1416           }
1417         } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
1418           for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
1419             if (SI->getSuccessor(i) == BB) {
1420               BB->removePredecessor(SI->getParent());
1421               SI->removeCase(i);
1422               --i; --e;
1423               Changed = true;
1424             }
1425           // If the default value is unreachable, figure out the most popular
1426           // destination and make it the default.
1427           if (SI->getSuccessor(0) == BB) {
1428             std::map<BasicBlock*, unsigned> Popularity;
1429             for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
1430               Popularity[SI->getSuccessor(i)]++;
1431
1432             // Find the most popular block.
1433             unsigned MaxPop = 0;
1434             BasicBlock *MaxBlock = 0;
1435             for (std::map<BasicBlock*, unsigned>::iterator
1436                    I = Popularity.begin(), E = Popularity.end(); I != E; ++I) {
1437               if (I->second > MaxPop) {
1438                 MaxPop = I->second;
1439                 MaxBlock = I->first;
1440               }
1441             }
1442             if (MaxBlock) {
1443               // Make this the new default, allowing us to delete any explicit
1444               // edges to it.
1445               SI->setSuccessor(0, MaxBlock);
1446               Changed = true;
1447
1448               // If MaxBlock has phinodes in it, remove MaxPop-1 entries from
1449               // it.
1450               if (isa<PHINode>(MaxBlock->begin()))
1451                 for (unsigned i = 0; i != MaxPop-1; ++i)
1452                   MaxBlock->removePredecessor(SI->getParent());
1453
1454               for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
1455                 if (SI->getSuccessor(i) == MaxBlock) {
1456                   SI->removeCase(i);
1457                   --i; --e;
1458                 }
1459             }
1460           }
1461         } else if (InvokeInst *II = dyn_cast<InvokeInst>(TI)) {
1462           if (II->getUnwindDest() == BB) {
1463             // Convert the invoke to a call instruction.  This would be a good
1464             // place to note that the call does not throw though.
1465             BranchInst *BI = new BranchInst(II->getNormalDest(), II);
1466             II->removeFromParent();   // Take out of symbol table
1467
1468             // Insert the call now...
1469             std::vector<Value*> Args(II->op_begin()+3, II->op_end());
1470             CallInst *CI = new CallInst(II->getCalledValue(), Args,
1471                                         II->getName(), BI);
1472             CI->setCallingConv(II->getCallingConv());
1473             // If the invoke produced a value, the Call does now instead.
1474             II->replaceAllUsesWith(CI);
1475             delete II;
1476             Changed = true;
1477           }
1478         }
1479       }
1480
1481       // If this block is now dead, remove it.
1482       if (pred_begin(BB) == pred_end(BB)) {
1483         // We know there are no successors, so just nuke the block.
1484         M->getBasicBlockList().erase(BB);
1485         return true;
1486       }
1487     }
1488   }
1489
1490   // Merge basic blocks into their predecessor if there is only one distinct
1491   // pred, and if there is only one distinct successor of the predecessor, and
1492   // if there are no PHI nodes.
1493   //
1494   pred_iterator PI(pred_begin(BB)), PE(pred_end(BB));
1495   BasicBlock *OnlyPred = *PI++;
1496   for (; PI != PE; ++PI)  // Search all predecessors, see if they are all same
1497     if (*PI != OnlyPred) {
1498       OnlyPred = 0;       // There are multiple different predecessors...
1499       break;
1500     }
1501
1502   BasicBlock *OnlySucc = 0;
1503   if (OnlyPred && OnlyPred != BB &&    // Don't break self loops
1504       OnlyPred->getTerminator()->getOpcode() != Instruction::Invoke) {
1505     // Check to see if there is only one distinct successor...
1506     succ_iterator SI(succ_begin(OnlyPred)), SE(succ_end(OnlyPred));
1507     OnlySucc = BB;
1508     for (; SI != SE; ++SI)
1509       if (*SI != OnlySucc) {
1510         OnlySucc = 0;     // There are multiple distinct successors!
1511         break;
1512       }
1513   }
1514
1515   if (OnlySucc) {
1516     DEBUG(std::cerr << "Merging: " << *BB << "into: " << *OnlyPred);
1517     TerminatorInst *Term = OnlyPred->getTerminator();
1518
1519     // Resolve any PHI nodes at the start of the block.  They are all
1520     // guaranteed to have exactly one entry if they exist, unless there are
1521     // multiple duplicate (but guaranteed to be equal) entries for the
1522     // incoming edges.  This occurs when there are multiple edges from
1523     // OnlyPred to OnlySucc.
1524     //
1525     while (PHINode *PN = dyn_cast<PHINode>(&BB->front())) {
1526       PN->replaceAllUsesWith(PN->getIncomingValue(0));
1527       BB->getInstList().pop_front();  // Delete the phi node...
1528     }
1529
1530     // Delete the unconditional branch from the predecessor...
1531     OnlyPred->getInstList().pop_back();
1532
1533     // Move all definitions in the successor to the predecessor...
1534     OnlyPred->getInstList().splice(OnlyPred->end(), BB->getInstList());
1535
1536     // Make all PHI nodes that referred to BB now refer to Pred as their
1537     // source...
1538     BB->replaceAllUsesWith(OnlyPred);
1539
1540     std::string OldName = BB->getName();
1541
1542     // Erase basic block from the function...
1543     M->getBasicBlockList().erase(BB);
1544
1545     // Inherit predecessors name if it exists...
1546     if (!OldName.empty() && !OnlyPred->hasName())
1547       OnlyPred->setName(OldName);
1548
1549     return true;
1550   }
1551
1552   // Otherwise, if this block only has a single predecessor, and if that block
1553   // is a conditional branch, see if we can hoist any code from this block up
1554   // into our predecessor.
1555   if (OnlyPred)
1556     if (BranchInst *BI = dyn_cast<BranchInst>(OnlyPred->getTerminator()))
1557       if (BI->isConditional()) {
1558         // Get the other block.
1559         BasicBlock *OtherBB = BI->getSuccessor(BI->getSuccessor(0) == BB);
1560         PI = pred_begin(OtherBB);
1561         ++PI;
1562         if (PI == pred_end(OtherBB)) {
1563           // We have a conditional branch to two blocks that are only reachable
1564           // from the condbr.  We know that the condbr dominates the two blocks,
1565           // so see if there is any identical code in the "then" and "else"
1566           // blocks.  If so, we can hoist it up to the branching block.
1567           Changed |= HoistThenElseCodeToIf(BI);
1568         }
1569       }
1570
1571   for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
1572     if (BranchInst *BI = dyn_cast<BranchInst>((*PI)->getTerminator()))
1573       // Change br (X == 0 | X == 1), T, F into a switch instruction.
1574       if (BI->isConditional() && isa<Instruction>(BI->getCondition())) {
1575         Instruction *Cond = cast<Instruction>(BI->getCondition());
1576         // If this is a bunch of seteq's or'd together, or if it's a bunch of
1577         // 'setne's and'ed together, collect them.
1578         Value *CompVal = 0;
1579         std::vector<ConstantInt*> Values;
1580         bool TrueWhenEqual = GatherValueComparisons(Cond, CompVal, Values);
1581         if (CompVal && CompVal->getType()->isInteger()) {
1582           // There might be duplicate constants in the list, which the switch
1583           // instruction can't handle, remove them now.
1584           std::sort(Values.begin(), Values.end(), ConstantIntOrdering());
1585           Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
1586
1587           // Figure out which block is which destination.
1588           BasicBlock *DefaultBB = BI->getSuccessor(1);
1589           BasicBlock *EdgeBB    = BI->getSuccessor(0);
1590           if (!TrueWhenEqual) std::swap(DefaultBB, EdgeBB);
1591
1592           // Create the new switch instruction now.
1593           SwitchInst *New = new SwitchInst(CompVal, DefaultBB,Values.size(),BI);
1594
1595           // Add all of the 'cases' to the switch instruction.
1596           for (unsigned i = 0, e = Values.size(); i != e; ++i)
1597             New->addCase(Values[i], EdgeBB);
1598
1599           // We added edges from PI to the EdgeBB.  As such, if there were any
1600           // PHI nodes in EdgeBB, they need entries to be added corresponding to
1601           // the number of edges added.
1602           for (BasicBlock::iterator BBI = EdgeBB->begin();
1603                isa<PHINode>(BBI); ++BBI) {
1604             PHINode *PN = cast<PHINode>(BBI);
1605             Value *InVal = PN->getIncomingValueForBlock(*PI);
1606             for (unsigned i = 0, e = Values.size()-1; i != e; ++i)
1607               PN->addIncoming(InVal, *PI);
1608           }
1609
1610           // Erase the old branch instruction.
1611           (*PI)->getInstList().erase(BI);
1612
1613           // Erase the potentially condition tree that was used to computed the
1614           // branch condition.
1615           ErasePossiblyDeadInstructionTree(Cond);
1616           return true;
1617         }
1618       }
1619
1620   // If there is a trivial two-entry PHI node in this basic block, and we can
1621   // eliminate it, do so now.
1622   if (PHINode *PN = dyn_cast<PHINode>(BB->begin()))
1623     if (PN->getNumIncomingValues() == 2) {
1624       // Ok, this is a two entry PHI node.  Check to see if this is a simple "if
1625       // statement", which has a very simple dominance structure.  Basically, we
1626       // are trying to find the condition that is being branched on, which
1627       // subsequently causes this merge to happen.  We really want control
1628       // dependence information for this check, but simplifycfg can't keep it up
1629       // to date, and this catches most of the cases we care about anyway.
1630       //
1631       BasicBlock *IfTrue, *IfFalse;
1632       if (Value *IfCond = GetIfCondition(BB, IfTrue, IfFalse)) {
1633         DEBUG(std::cerr << "FOUND IF CONDITION!  " << *IfCond << "  T: "
1634               << IfTrue->getName() << "  F: " << IfFalse->getName() << "\n");
1635
1636         // Loop over the PHI's seeing if we can promote them all to select
1637         // instructions.  While we are at it, keep track of the instructions
1638         // that need to be moved to the dominating block.
1639         std::set<Instruction*> AggressiveInsts;
1640         bool CanPromote = true;
1641
1642         BasicBlock::iterator AfterPHIIt = BB->begin();
1643         while (isa<PHINode>(AfterPHIIt)) {
1644           PHINode *PN = cast<PHINode>(AfterPHIIt++);
1645           if (PN->getIncomingValue(0) == PN->getIncomingValue(1)) {
1646             if (PN->getIncomingValue(0) != PN)
1647               PN->replaceAllUsesWith(PN->getIncomingValue(0));
1648             else
1649               PN->replaceAllUsesWith(UndefValue::get(PN->getType()));
1650           } else if (!DominatesMergePoint(PN->getIncomingValue(0), BB,
1651                                           &AggressiveInsts) ||
1652                      !DominatesMergePoint(PN->getIncomingValue(1), BB,
1653                                           &AggressiveInsts)) {
1654             CanPromote = false;
1655             break;
1656           }
1657         }
1658
1659         // Did we eliminate all PHI's?
1660         CanPromote |= AfterPHIIt == BB->begin();
1661
1662         // If we all PHI nodes are promotable, check to make sure that all
1663         // instructions in the predecessor blocks can be promoted as well.  If
1664         // not, we won't be able to get rid of the control flow, so it's not
1665         // worth promoting to select instructions.
1666         BasicBlock *DomBlock = 0, *IfBlock1 = 0, *IfBlock2 = 0;
1667         if (CanPromote) {
1668           PN = cast<PHINode>(BB->begin());
1669           BasicBlock *Pred = PN->getIncomingBlock(0);
1670           if (cast<BranchInst>(Pred->getTerminator())->isUnconditional()) {
1671             IfBlock1 = Pred;
1672             DomBlock = *pred_begin(Pred);
1673             for (BasicBlock::iterator I = Pred->begin();
1674                  !isa<TerminatorInst>(I); ++I)
1675               if (!AggressiveInsts.count(I)) {
1676                 // This is not an aggressive instruction that we can promote.
1677                 // Because of this, we won't be able to get rid of the control
1678                 // flow, so the xform is not worth it.
1679                 CanPromote = false;
1680                 break;
1681               }
1682           }
1683
1684           Pred = PN->getIncomingBlock(1);
1685           if (CanPromote &&
1686               cast<BranchInst>(Pred->getTerminator())->isUnconditional()) {
1687             IfBlock2 = Pred;
1688             DomBlock = *pred_begin(Pred);
1689             for (BasicBlock::iterator I = Pred->begin();
1690                  !isa<TerminatorInst>(I); ++I)
1691               if (!AggressiveInsts.count(I)) {
1692                 // This is not an aggressive instruction that we can promote.
1693                 // Because of this, we won't be able to get rid of the control
1694                 // flow, so the xform is not worth it.
1695                 CanPromote = false;
1696                 break;
1697               }
1698           }
1699         }
1700
1701         // If we can still promote the PHI nodes after this gauntlet of tests,
1702         // do all of the PHI's now.
1703         if (CanPromote) {
1704           // Move all 'aggressive' instructions, which are defined in the
1705           // conditional parts of the if's up to the dominating block.
1706           if (IfBlock1) {
1707             DomBlock->getInstList().splice(DomBlock->getTerminator(),
1708                                            IfBlock1->getInstList(),
1709                                            IfBlock1->begin(),
1710                                            IfBlock1->getTerminator());
1711           }
1712           if (IfBlock2) {
1713             DomBlock->getInstList().splice(DomBlock->getTerminator(),
1714                                            IfBlock2->getInstList(),
1715                                            IfBlock2->begin(),
1716                                            IfBlock2->getTerminator());
1717           }
1718
1719           while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
1720             // Change the PHI node into a select instruction.
1721             Value *TrueVal =
1722               PN->getIncomingValue(PN->getIncomingBlock(0) == IfFalse);
1723             Value *FalseVal =
1724               PN->getIncomingValue(PN->getIncomingBlock(0) == IfTrue);
1725
1726             std::string Name = PN->getName(); PN->setName("");
1727             PN->replaceAllUsesWith(new SelectInst(IfCond, TrueVal, FalseVal,
1728                                                   Name, AfterPHIIt));
1729             BB->getInstList().erase(PN);
1730           }
1731           Changed = true;
1732         }
1733       }
1734     }
1735
1736   return Changed;
1737 }