lib/Transforms/Scalar/JumpThreading.cpp

   1 //===- JumpThreading.cpp - Thread control through conditional blocks ------===//
   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 // This file implements the Jump Threading pass.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "jump-threading"
  15 #include "llvm/Transforms/Scalar.h"
  16 #include "llvm/IntrinsicInst.h"
  17 #include "llvm/Pass.h"
  18 #include "llvm/ADT/DenseMap.h"
  19 #include "llvm/ADT/Statistic.h"
  20 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  21 #include "llvm/Transforms/Utils/Local.h"
  22 #include "llvm/Support/CommandLine.h"
  23 #include "llvm/Support/Compiler.h"
  24 #include "llvm/Support/Debug.h"
  25 #include "llvm/ADT/SmallPtrSet.h"
  26 using namespace llvm;
  27
  28 STATISTIC(NumThreads, "Number of jumps threaded");
  29 STATISTIC(NumFolds,   "Number of terminators folded");
  30
  31 static cl::opt<unsigned>
  32 Threshold("jump-threading-threshold",
  33           cl::desc("Max block size to duplicate for jump threading"),
  34           cl::init(6), cl::Hidden);
  35
  36 namespace {
  37   /// This pass performs 'jump threading', which looks at blocks that have
  38   /// multiple predecessors and multiple successors.  If one or more of the
  39   /// predecessors of the block can be proven to always jump to one of the
  40   /// successors, we forward the edge from the predecessor to the successor by
  41   /// duplicating the contents of this block.
  42   ///
  43   /// An example of when this can occur is code like this:
  44   ///
  45   ///   if () { ...
  46   ///     X = 4;
  47   ///   }
  48   ///   if (X < 3) {
  49   ///
  50   /// In this case, the unconditional branch at the end of the first if can be
  51   /// revectored to the false side of the second if.
  52   ///
  53   class VISIBILITY_HIDDEN JumpThreading : public FunctionPass {
  54   public:
  55     static char ID; // Pass identification
  56     JumpThreading() : FunctionPass(&ID) {}
  57
  58     bool runOnFunction(Function &F);
  59     bool ProcessBlock(BasicBlock *BB);
  60     void ThreadEdge(BasicBlock *BB, BasicBlock *PredBB, BasicBlock *SuccBB);
  61     BasicBlock *FactorCommonPHIPreds(PHINode *PN, Constant *CstVal);
  62
  63     bool ProcessJumpOnPHI(PHINode *PN);
  64     bool ProcessBranchOnLogical(Value *V, BasicBlock *BB, bool isAnd);
  65     bool ProcessBranchOnCompare(CmpInst *Cmp, BasicBlock *BB);
  66
  67     bool SimplifyPartiallyRedundantLoad(LoadInst *LI);
  68   };
  69 }
  70
  71 char JumpThreading::ID = 0;
  72 static RegisterPass<JumpThreading>
  73 X("jump-threading", "Jump Threading");
  74
  75 // Public interface to the Jump Threading pass
  76 FunctionPass *llvm::createJumpThreadingPass() { return new JumpThreading(); }
  77
  78 /// runOnFunction - Top level algorithm.
  79 ///
  80 bool JumpThreading::runOnFunction(Function &F) {
  81   DOUT << "Jump threading on function '" << F.getNameStart() << "'\n";
  82
  83   bool AnotherIteration = true, EverChanged = false;
  84   while (AnotherIteration) {
  85     AnotherIteration = false;
  86     bool Changed = false;
  87     for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
  88       while (ProcessBlock(I))
  89         Changed = true;
  90     AnotherIteration = Changed;
  91     EverChanged |= Changed;
  92   }
  93   return EverChanged;
  94 }
  95
  96 /// FactorCommonPHIPreds - If there are multiple preds with the same incoming
  97 /// value for the PHI, factor them together so we get one block to thread for
  98 /// the whole group.
  99 /// This is important for things like "phi i1 [true, true, false, true, x]"
 100 /// where we only need to clone the block for the true blocks once.
 101 ///
 102 BasicBlock *JumpThreading::FactorCommonPHIPreds(PHINode *PN, Constant *CstVal) {
 103   SmallVector<BasicBlock*, 16> CommonPreds;
 104   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 105     if (PN->getIncomingValue(i) == CstVal)
 106       CommonPreds.push_back(PN->getIncomingBlock(i));
 107
 108   if (CommonPreds.size() == 1)
 109     return CommonPreds[0];
 110
 111   DOUT << "  Factoring out " << CommonPreds.size()
 112        << " common predecessors.\n";
 113   return SplitBlockPredecessors(PN->getParent(),
 114                                 &CommonPreds[0], CommonPreds.size(),
 115                                 ".thr_comm", this);
 116 }
 117
 118
 119 /// getJumpThreadDuplicationCost - Return the cost of duplicating this block to
 120 /// thread across it.
 121 static unsigned getJumpThreadDuplicationCost(const BasicBlock *BB) {
 122   /// Ignore PHI nodes, these will be flattened when duplication happens.
 123   BasicBlock::const_iterator I = BB->getFirstNonPHI();
 124
 125   // Sum up the cost of each instruction until we get to the terminator.  Don't
 126   // include the terminator because the copy won't include it.
 127   unsigned Size = 0;
 128   for (; !isa<TerminatorInst>(I); ++I) {
 129     // Debugger intrinsics don't incur code size.
 130     if (isa<DbgInfoIntrinsic>(I)) continue;
 131
 132     // If this is a pointer->pointer bitcast, it is free.
 133     if (isa<BitCastInst>(I) && isa<PointerType>(I->getType()))
 134       continue;
 135
 136     // All other instructions count for at least one unit.
 137     ++Size;
 138
 139     // Calls are more expensive.  If they are non-intrinsic calls, we model them
 140     // as having cost of 4.  If they are a non-vector intrinsic, we model them
 141     // as having cost of 2 total, and if they are a vector intrinsic, we model
 142     // them as having cost 1.
 143     if (const CallInst *CI = dyn_cast<CallInst>(I)) {
 144       if (!isa<IntrinsicInst>(CI))
 145         Size += 3;
 146       else if (isa<VectorType>(CI->getType()))
 147         Size += 1;
 148     }
 149   }
 150
 151   // Threading through a switch statement is particularly profitable.  If this
 152   // block ends in a switch, decrease its cost to make it more likely to happen.
 153   if (isa<SwitchInst>(I))
 154     Size = Size > 6 ? Size-6 : 0;
 155
 156   return Size;
 157 }
 158
 159 /// ProcessBlock - If there are any predecessors whose control can be threaded
 160 /// through to a successor, transform them now.
 161 bool JumpThreading::ProcessBlock(BasicBlock *BB) {
 162   // If this block has a single predecessor, and if that pred has a single
 163   // successor, merge the blocks.  This encourages recursive jump threading
 164   // because now the condition in this block can be threaded through
 165   // predecessors of our predecessor block.
 166   if (BasicBlock *SinglePred = BB->getSinglePredecessor())
 167     if (SinglePred->getTerminator()->getNumSuccessors() == 1) {
 168       // Remember if SinglePred was the entry block of the function.  If so, we
 169       // will need to move BB back to the entry position.
 170       bool isEntry = SinglePred == &SinglePred->getParent()->getEntryBlock();
 171       MergeBasicBlockIntoOnlyPred(BB);
 172
 173       if (isEntry && BB != &BB->getParent()->getEntryBlock())
 174         BB->moveBefore(&BB->getParent()->getEntryBlock());
 175       return true;
 176     }
 177
 178   // See if this block ends with a branch or switch.  If so, see if the
 179   // condition is a phi node.  If so, and if an entry of the phi node is a
 180   // constant, we can thread the block.
 181   Value *Condition;
 182   if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
 183     // Can't thread an unconditional jump.
 184     if (BI->isUnconditional()) return false;
 185     Condition = BI->getCondition();
 186   } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator()))
 187     Condition = SI->getCondition();
 188   else
 189     return false; // Must be an invoke.
 190
 191   // If the terminator of this block is branching on a constant, simplify the
 192   // terminator to an unconditional branch.  This can occur due to threading in
 193   // other blocks.
 194   if (isa<ConstantInt>(Condition)) {
 195     DOUT << "  In block '" << BB->getNameStart()
 196          << "' folding terminator: " << *BB->getTerminator();
 197     ++NumFolds;
 198     ConstantFoldTerminator(BB);
 199     return true;
 200   }
 201
 202   // If there is only a single predecessor of this block, nothing to fold.
 203   if (BB->getSinglePredecessor())
 204     return false;
 205
 206   // See if this is a phi node in the current block.
 207   PHINode *PN = dyn_cast<PHINode>(Condition);
 208   if (PN && PN->getParent() == BB)
 209     return ProcessJumpOnPHI(PN);
 210
 211   // If this is a conditional branch whose condition is and/or of a phi, try to
 212   // simplify it.
 213   if (BinaryOperator *CondI = dyn_cast<BinaryOperator>(Condition)) {
 214     if ((CondI->getOpcode() == Instruction::And ||
 215          CondI->getOpcode() == Instruction::Or) &&
 216         isa<BranchInst>(BB->getTerminator()) &&
 217         ProcessBranchOnLogical(CondI, BB,
 218                                CondI->getOpcode() == Instruction::And))
 219       return true;
 220   }
 221
 222   // If we have "br (phi != 42)" and the phi node has any constant values as
 223   // operands, we can thread through this block.
 224   if (CmpInst *CondCmp = dyn_cast<CmpInst>(Condition))
 225     if (isa<PHINode>(CondCmp->getOperand(0)) &&
 226         isa<Constant>(CondCmp->getOperand(1)) &&
 227         ProcessBranchOnCompare(CondCmp, BB))
 228       return true;
 229
 230   // Check for some cases that are worth simplifying.  Right now we want to look
 231   // for loads that are used by a switch or by the condition for the branch.  If
 232   // we see one, check to see if it's partially redundant.  If so, insert a PHI
 233   // which can then be used to thread the values.
 234   //
 235   // This is particularly important because reg2mem inserts loads and stores all
 236   // over the place, and this blocks jump threading if we don't zap them.
 237   Value *SimplifyValue = Condition;
 238   if (CmpInst *CondCmp = dyn_cast<CmpInst>(SimplifyValue))
 239     if (isa<Constant>(CondCmp->getOperand(1)))
 240       SimplifyValue = CondCmp->getOperand(0);
 241
 242   if (LoadInst *LI = dyn_cast<LoadInst>(SimplifyValue))
 243     if (SimplifyPartiallyRedundantLoad(LI))
 244       return true;
 245
 246   // TODO: If we have: "br (X > 0)"  and we have a predecessor where we know
 247   // "(X == 4)" thread through this block.
 248
 249   return false;
 250 }
 251
 252 /// SimplifyPartiallyRedundantLoad - If LI is an obviously partially redundant
 253 /// load instruction, eliminate it by replacing it with a PHI node.  This is an
 254 /// important optimization that encourages jump threading, and needs to be run
 255 /// interlaced with other jump threading tasks.
 256 bool JumpThreading::SimplifyPartiallyRedundantLoad(LoadInst *LI) {
 257   // Don't hack volatile loads.
 258   if (LI->isVolatile()) return false;
 259
 260   // If the load is defined in a block with exactly one predecessor, it can't be
 261   // partially redundant.
 262   BasicBlock *LoadBB = LI->getParent();
 263   if (LoadBB->getSinglePredecessor())
 264     return false;
 265
 266   Value *LoadedPtr = LI->getOperand(0);
 267
 268   // If the loaded operand is defined in the LoadBB, it can't be available.
 269   // FIXME: Could do PHI translation, that would be fun :)
 270   if (Instruction *PtrOp = dyn_cast<Instruction>(LoadedPtr))
 271     if (PtrOp->getParent() == LoadBB)
 272       return false;
 273
 274   // Scan a few instructions up from the load, to see if it is obviously live at
 275   // the entry to its block.
 276   BasicBlock::iterator BBIt = LI;
 277
 278   if (Value *AvailableVal = FindAvailableLoadedValue(LoadedPtr, LoadBB,
 279                                                      BBIt, 6)) {
 280     // If the value if the load is locally available within the block, just use
 281     // it.  This frequently occurs for reg2mem'd allocas.
 282     //cerr << "LOAD ELIMINATED:\n" << *BBIt << *LI << "\n";
 283     LI->replaceAllUsesWith(AvailableVal);
 284     LI->eraseFromParent();
 285     return true;
 286   }
 287
 288   // Otherwise, if we scanned the whole block and got to the top of the block,
 289   // we know the block is locally transparent to the load.  If not, something
 290   // might clobber its value.
 291   if (BBIt != LoadBB->begin())
 292     return false;
 293
 294
 295   SmallPtrSet<BasicBlock*, 8> PredsScanned;
 296   typedef SmallVector<std::pair<BasicBlock*, Value*>, 8> AvailablePredsTy;
 297   AvailablePredsTy AvailablePreds;
 298   BasicBlock *OneUnavailablePred = 0;
 299
 300   // If we got here, the loaded value is transparent through to the start of the
 301   // block.  Check to see if it is available in any of the predecessor blocks.
 302   for (pred_iterator PI = pred_begin(LoadBB), PE = pred_end(LoadBB);
 303        PI != PE; ++PI) {
 304     BasicBlock *PredBB = *PI;
 305
 306     // If we already scanned this predecessor, skip it.
 307     if (!PredsScanned.insert(PredBB))
 308       continue;
 309
 310     // Scan the predecessor to see if the value is available in the pred.
 311     BBIt = PredBB->end();
 312     Value *PredAvailable = FindAvailableLoadedValue(LoadedPtr, PredBB, BBIt, 6);
 313     if (!PredAvailable) {
 314       OneUnavailablePred = PredBB;
 315       continue;
 316     }
 317
 318     // If so, this load is partially redundant.  Remember this info so that we
 319     // can create a PHI node.
 320     AvailablePreds.push_back(std::make_pair(PredBB, PredAvailable));
 321   }
 322
 323   // If the loaded value isn't available in any predecessor, it isn't partially
 324   // redundant.
 325   if (AvailablePreds.empty()) return false;
 326
 327   // Okay, the loaded value is available in at least one (and maybe all!)
 328   // predecessors.  If the value is unavailable in more than one unique
 329   // predecessor, we want to insert a merge block for those common predecessors.
 330   // This ensures that we only have to insert one reload, thus not increasing
 331   // code size.
 332   BasicBlock *UnavailablePred = 0;
 333
 334   // If there is exactly one predecessor where the value is unavailable, the
 335   // already computed 'OneUnavailablePred' block is it.  If it ends in an
 336   // unconditional branch, we know that it isn't a critical edge.
 337   if (PredsScanned.size() == AvailablePreds.size()+1 &&
 338       OneUnavailablePred->getTerminator()->getNumSuccessors() == 1) {
 339     UnavailablePred = OneUnavailablePred;
 340   } else if (PredsScanned.size() != AvailablePreds.size()) {
 341     // Otherwise, we had multiple unavailable predecessors or we had a critical
 342     // edge from the one.
 343     SmallVector<BasicBlock*, 8> PredsToSplit;
 344     SmallPtrSet<BasicBlock*, 8> AvailablePredSet;
 345
 346     for (unsigned i = 0, e = AvailablePreds.size(); i != e; ++i)
 347       AvailablePredSet.insert(AvailablePreds[i].first);
 348
 349     // Add all the unavailable predecessors to the PredsToSplit list.
 350     for (pred_iterator PI = pred_begin(LoadBB), PE = pred_end(LoadBB);
 351          PI != PE; ++PI)
 352       if (!AvailablePredSet.count(*PI))
 353         PredsToSplit.push_back(*PI);
 354
 355     // Split them out to their own block.
 356     UnavailablePred =
 357       SplitBlockPredecessors(LoadBB, &PredsToSplit[0], PredsToSplit.size(),
 358                              "thread-split", this);
 359   }
 360
 361   // If the value isn't available in all predecessors, then there will be
 362   // exactly one where it isn't available.  Insert a load on that edge and add
 363   // it to the AvailablePreds list.
 364   if (UnavailablePred) {
 365     assert(UnavailablePred->getTerminator()->getNumSuccessors() == 1 &&
 366            "Can't handle critical edge here!");
 367     Value *NewVal = new LoadInst(LoadedPtr, LI->getName()+".pr",
 368                                  UnavailablePred->getTerminator());
 369     AvailablePreds.push_back(std::make_pair(UnavailablePred, NewVal));
 370   }
 371
 372   // Now we know that each predecessor of this block has a value in
 373   // AvailablePreds, sort them for efficient access as we're walking the preds.
 374   std::sort(AvailablePreds.begin(), AvailablePreds.end());
 375
 376   // Create a PHI node at the start of the block for the PRE'd load value.
 377   PHINode *PN = PHINode::Create(LI->getType(), "", LoadBB->begin());
 378   PN->takeName(LI);
 379
 380   // Insert new entries into the PHI for each predecessor.  A single block may
 381   // have multiple entries here.
 382   for (pred_iterator PI = pred_begin(LoadBB), E = pred_end(LoadBB); PI != E;
 383        ++PI) {
 384     AvailablePredsTy::iterator I =
 385       std::lower_bound(AvailablePreds.begin(), AvailablePreds.end(),
 386                        std::make_pair(*PI, (Value*)0));
 387
 388     assert(I != AvailablePreds.end() && I->first == *PI &&
 389            "Didn't find entry for predecessor!");
 390
 391     PN->addIncoming(I->second, I->first);
 392   }
 393
 394   //cerr << "PRE: " << *LI << *PN << "\n";
 395
 396   LI->replaceAllUsesWith(PN);
 397   LI->eraseFromParent();
 398
 399   return true;
 400 }
 401
 402
 403 /// ProcessJumpOnPHI - We have a conditional branch of switch on a PHI node in
 404 /// the current block.  See if there are any simplifications we can do based on
 405 /// inputs to the phi node.
 406 ///
 407 bool JumpThreading::ProcessJumpOnPHI(PHINode *PN) {
 408   // See if the phi node has any constant values.  If so, we can determine where
 409   // the corresponding predecessor will branch.
 410   ConstantInt *PredCst = 0;
 411   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 412     if ((PredCst = dyn_cast<ConstantInt>(PN->getIncomingValue(i))))
 413       break;
 414
 415   // If no incoming value has a constant, we don't know the destination of any
 416   // predecessors.
 417   if (PredCst == 0)
 418     return false;
 419
 420   // See if the cost of duplicating this block is low enough.
 421   BasicBlock *BB = PN->getParent();
 422   unsigned JumpThreadCost = getJumpThreadDuplicationCost(BB);
 423   if (JumpThreadCost > Threshold) {
 424     DOUT << "  Not threading BB '" << BB->getNameStart()
 425          << "' - Cost is too high: " << JumpThreadCost << "\n";
 426     return false;
 427   }
 428
 429   // If so, we can actually do this threading.  Merge any common predecessors
 430   // that will act the same.
 431   BasicBlock *PredBB = FactorCommonPHIPreds(PN, PredCst);
 432
 433   // Next, figure out which successor we are threading to.
 434   BasicBlock *SuccBB;
 435   if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator()))
 436     SuccBB = BI->getSuccessor(PredCst == ConstantInt::getFalse());
 437   else {
 438     SwitchInst *SI = cast<SwitchInst>(BB->getTerminator());
 439     SuccBB = SI->getSuccessor(SI->findCaseValue(PredCst));
 440   }
 441
 442   // If threading to the same block as we come from, we would infinite loop.
 443   if (SuccBB == BB) {
 444     DOUT << "  Not threading BB '" << BB->getNameStart()
 445          << "' - would thread to self!\n";
 446     return false;
 447   }
 448
 449   // And finally, do it!
 450   DOUT << "  Threading edge from '" << PredBB->getNameStart() << "' to '"
 451        << SuccBB->getNameStart() << "' with cost: " << JumpThreadCost
 452        << ", across block:\n    "
 453        << *BB << "\n";
 454
 455   ThreadEdge(BB, PredBB, SuccBB);
 456   ++NumThreads;
 457   return true;
 458 }
 459
 460 /// ProcessJumpOnLogicalPHI - PN's basic block contains a conditional branch
 461 /// whose condition is an AND/OR where one side is PN.  If PN has constant
 462 /// operands that permit us to evaluate the condition for some operand, thread
 463 /// through the block.  For example with:
 464 ///   br (and X, phi(Y, Z, false))
 465 /// the predecessor corresponding to the 'false' will always jump to the false
 466 /// destination of the branch.
 467 ///
 468 bool JumpThreading::ProcessBranchOnLogical(Value *V, BasicBlock *BB,
 469                                            bool isAnd) {
 470   // If this is a binary operator tree of the same AND/OR opcode, check the
 471   // LHS/RHS.
 472   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(V))
 473     if ((isAnd && BO->getOpcode() == Instruction::And) ||
 474         (!isAnd && BO->getOpcode() == Instruction::Or)) {
 475       if (ProcessBranchOnLogical(BO->getOperand(0), BB, isAnd))
 476         return true;
 477       if (ProcessBranchOnLogical(BO->getOperand(1), BB, isAnd))
 478         return true;
 479     }
 480
 481   // If this isn't a PHI node, we can't handle it.
 482   PHINode *PN = dyn_cast<PHINode>(V);
 483   if (!PN || PN->getParent() != BB) return false;
 484
 485   // We can only do the simplification for phi nodes of 'false' with AND or
 486   // 'true' with OR.  See if we have any entries in the phi for this.
 487   unsigned PredNo = ~0U;
 488   ConstantInt *PredCst = ConstantInt::get(Type::Int1Ty, !isAnd);
 489   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 490     if (PN->getIncomingValue(i) == PredCst) {
 491       PredNo = i;
 492       break;
 493     }
 494   }
 495
 496   // If no match, bail out.
 497   if (PredNo == ~0U)
 498     return false;
 499
 500   // See if the cost of duplicating this block is low enough.
 501   unsigned JumpThreadCost = getJumpThreadDuplicationCost(BB);
 502   if (JumpThreadCost > Threshold) {
 503     DOUT << "  Not threading BB '" << BB->getNameStart()
 504          << "' - Cost is too high: " << JumpThreadCost << "\n";
 505     return false;
 506   }
 507
 508   // If so, we can actually do this threading.  Merge any common predecessors
 509   // that will act the same.
 510   BasicBlock *PredBB = FactorCommonPHIPreds(PN, PredCst);
 511
 512   // Next, figure out which successor we are threading to.  If this was an AND,
 513   // the constant must be FALSE, and we must be targeting the 'false' block.
 514   // If this is an OR, the constant must be TRUE, and we must be targeting the
 515   // 'true' block.
 516   BasicBlock *SuccBB = BB->getTerminator()->getSuccessor(isAnd);
 517
 518   // If threading to the same block as we come from, we would infinite loop.
 519   if (SuccBB == BB) {
 520     DOUT << "  Not threading BB '" << BB->getNameStart()
 521     << "' - would thread to self!\n";
 522     return false;
 523   }
 524
 525   // And finally, do it!
 526   DOUT << "  Threading edge through bool from '" << PredBB->getNameStart()
 527        << "' to '" << SuccBB->getNameStart() << "' with cost: "
 528        << JumpThreadCost << ", across block:\n    "
 529        << *BB << "\n";
 530
 531   ThreadEdge(BB, PredBB, SuccBB);
 532   ++NumThreads;
 533   return true;
 534 }
 535
 536 /// ProcessBranchOnCompare - We found a branch on a comparison between a phi
 537 /// node and a constant.  If the PHI node contains any constants as inputs, we
 538 /// can fold the compare for that edge and thread through it.
 539 bool JumpThreading::ProcessBranchOnCompare(CmpInst *Cmp, BasicBlock *BB) {
 540   PHINode *PN = cast<PHINode>(Cmp->getOperand(0));
 541   Constant *RHS = cast<Constant>(Cmp->getOperand(1));
 542
 543   // If the phi isn't in the current block, an incoming edge to this block
 544   // doesn't control the destination.
 545   if (PN->getParent() != BB)
 546     return false;
 547
 548   // We can do this simplification if any comparisons fold to true or false.
 549   // See if any do.
 550   Constant *PredCst = 0;
 551   bool TrueDirection = false;
 552   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 553     PredCst = dyn_cast<Constant>(PN->getIncomingValue(i));
 554     if (PredCst == 0) continue;
 555
 556     Constant *Res;
 557     if (ICmpInst *ICI = dyn_cast<ICmpInst>(Cmp))
 558       Res = ConstantExpr::getICmp(ICI->getPredicate(), PredCst, RHS);
 559     else
 560       Res = ConstantExpr::getFCmp(cast<FCmpInst>(Cmp)->getPredicate(),
 561                                   PredCst, RHS);
 562     // If this folded to a constant expr, we can't do anything.
 563     if (ConstantInt *ResC = dyn_cast<ConstantInt>(Res)) {
 564       TrueDirection = ResC->getZExtValue();
 565       break;
 566     }
 567     // If this folded to undef, just go the false way.
 568     if (isa<UndefValue>(Res)) {
 569       TrueDirection = false;
 570       break;
 571     }
 572
 573     // Otherwise, we can't fold this input.
 574     PredCst = 0;
 575   }
 576
 577   // If no match, bail out.
 578   if (PredCst == 0)
 579     return false;
 580
 581   // See if the cost of duplicating this block is low enough.
 582   unsigned JumpThreadCost = getJumpThreadDuplicationCost(BB);
 583   if (JumpThreadCost > Threshold) {
 584     DOUT << "  Not threading BB '" << BB->getNameStart()
 585          << "' - Cost is too high: " << JumpThreadCost << "\n";
 586     return false;
 587   }
 588
 589   // If so, we can actually do this threading.  Merge any common predecessors
 590   // that will act the same.
 591   BasicBlock *PredBB = FactorCommonPHIPreds(PN, PredCst);
 592
 593   // Next, get our successor.
 594   BasicBlock *SuccBB = BB->getTerminator()->getSuccessor(!TrueDirection);
 595
 596   // If threading to the same block as we come from, we would infinite loop.
 597   if (SuccBB == BB) {
 598     DOUT << "  Not threading BB '" << BB->getNameStart()
 599     << "' - would thread to self!\n";
 600     return false;
 601   }
 602
 603
 604   // And finally, do it!
 605   DOUT << "  Threading edge through bool from '" << PredBB->getNameStart()
 606        << "' to '" << SuccBB->getNameStart() << "' with cost: "
 607        << JumpThreadCost << ", across block:\n    "
 608        << *BB << "\n";
 609
 610   ThreadEdge(BB, PredBB, SuccBB);
 611   ++NumThreads;
 612   return true;
 613 }
 614
 615
 616 /// ThreadEdge - We have decided that it is safe and profitable to thread an
 617 /// edge from PredBB to SuccBB across BB.  Transform the IR to reflect this
 618 /// change.
 619 void JumpThreading::ThreadEdge(BasicBlock *BB, BasicBlock *PredBB,
 620                                BasicBlock *SuccBB) {
 621
 622   // Jump Threading can not update SSA properties correctly if the values
 623   // defined in the duplicated block are used outside of the block itself.  For
 624   // this reason, we spill all values that are used outside of BB to the stack.
 625   for (BasicBlock::iterator I = BB->begin(); I != BB->end(); ++I) {
 626     if (!I->isUsedOutsideOfBlock(BB))
 627       continue;
 628
 629     // We found a use of I outside of BB.  Create a new stack slot to
 630     // break this inter-block usage pattern.
 631     DemoteRegToStack(*I);
 632   }
 633
 634   // We are going to have to map operands from the original BB block to the new
 635   // copy of the block 'NewBB'.  If there are PHI nodes in BB, evaluate them to
 636   // account for entry from PredBB.
 637   DenseMap<Instruction*, Value*> ValueMapping;
 638
 639   BasicBlock *NewBB =
 640     BasicBlock::Create(BB->getName()+".thread", BB->getParent(), BB);
 641   NewBB->moveAfter(PredBB);
 642
 643   BasicBlock::iterator BI = BB->begin();
 644   for (; PHINode *PN = dyn_cast<PHINode>(BI); ++BI)
 645     ValueMapping[PN] = PN->getIncomingValueForBlock(PredBB);
 646
 647   // Clone the non-phi instructions of BB into NewBB, keeping track of the
 648   // mapping and using it to remap operands in the cloned instructions.
 649   for (; !isa<TerminatorInst>(BI); ++BI) {
 650     Instruction *New = BI->clone();
 651     New->setName(BI->getNameStart());
 652     NewBB->getInstList().push_back(New);
 653     ValueMapping[BI] = New;
 654
 655     // Remap operands to patch up intra-block references.
 656     for (unsigned i = 0, e = New->getNumOperands(); i != e; ++i)
 657       if (Instruction *Inst = dyn_cast<Instruction>(New->getOperand(i)))
 658         if (Value *Remapped = ValueMapping[Inst])
 659           New->setOperand(i, Remapped);
 660   }
 661
 662   // We didn't copy the terminator from BB over to NewBB, because there is now
 663   // an unconditional jump to SuccBB.  Insert the unconditional jump.
 664   BranchInst::Create(SuccBB, NewBB);
 665
 666   // Check to see if SuccBB has PHI nodes. If so, we need to add entries to the
 667   // PHI nodes for NewBB now.
 668   for (BasicBlock::iterator PNI = SuccBB->begin(); isa<PHINode>(PNI); ++PNI) {
 669     PHINode *PN = cast<PHINode>(PNI);
 670     // Ok, we have a PHI node.  Figure out what the incoming value was for the
 671     // DestBlock.
 672     Value *IV = PN->getIncomingValueForBlock(BB);
 673
 674     // Remap the value if necessary.
 675     if (Instruction *Inst = dyn_cast<Instruction>(IV))
 676       if (Value *MappedIV = ValueMapping[Inst])
 677         IV = MappedIV;
 678     PN->addIncoming(IV, NewBB);
 679   }
 680
 681   // Finally, NewBB is good to go.  Update the terminator of PredBB to jump to
 682   // NewBB instead of BB.  This eliminates predecessors from BB, which requires
 683   // us to simplify any PHI nodes in BB.
 684   TerminatorInst *PredTerm = PredBB->getTerminator();
 685   for (unsigned i = 0, e = PredTerm->getNumSuccessors(); i != e; ++i)
 686     if (PredTerm->getSuccessor(i) == BB) {
 687       BB->removePredecessor(PredBB);
 688       PredTerm->setSuccessor(i, NewBB);
 689     }
 690 }