lib/Transforms/Utils/BasicBlockUtils.cpp

   1 //===-- BasicBlockUtils.cpp - BasicBlock Utilities -------------------------==//
   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 family of functions perform manipulations on basic blocks, and
  11 // instructions contained within basic blocks.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  16 #include "llvm/Function.h"
  17 #include "llvm/Instructions.h"
  18 #include "llvm/IntrinsicInst.h"
  19 #include "llvm/Constant.h"
  20 #include "llvm/Type.h"
  21 #include "llvm/Analysis/AliasAnalysis.h"
  22 #include "llvm/Analysis/Dominators.h"
  23 #include "llvm/Analysis/LoopInfo.h"
  24 #include "llvm/Analysis/MemoryDependenceAnalysis.h"
  25 #include "llvm/Target/TargetData.h"
  26 #include "llvm/Transforms/Utils/Local.h"
  27 #include "llvm/Transforms/Scalar.h"
  28 #include "llvm/Support/ErrorHandling.h"
  29 #include "llvm/Support/ValueHandle.h"
  30 #include <algorithm>
  31 using namespace llvm;
  32
  33 /// DeleteDeadBlock - Delete the specified block, which must have no
  34 /// predecessors.
  35 void llvm::DeleteDeadBlock(BasicBlock *BB) {
  36   assert((pred_begin(BB) == pred_end(BB) ||
  37          // Can delete self loop.
  38          BB->getSinglePredecessor() == BB) && "Block is not dead!");
  39   TerminatorInst *BBTerm = BB->getTerminator();
  40
  41   // Loop through all of our successors and make sure they know that one
  42   // of their predecessors is going away.
  43   for (unsigned i = 0, e = BBTerm->getNumSuccessors(); i != e; ++i)
  44     BBTerm->getSuccessor(i)->removePredecessor(BB);
  45
  46   // Zap all the instructions in the block.
  47   while (!BB->empty()) {
  48     Instruction &I = BB->back();
  49     // If this instruction is used, replace uses with an arbitrary value.
  50     // Because control flow can't get here, we don't care what we replace the
  51     // value with.  Note that since this block is unreachable, and all values
  52     // contained within it must dominate their uses, that all uses will
  53     // eventually be removed (they are themselves dead).
  54     if (!I.use_empty())
  55       I.replaceAllUsesWith(UndefValue::get(I.getType()));
  56     BB->getInstList().pop_back();
  57   }
  58
  59   // Zap the block!
  60   BB->eraseFromParent();
  61 }
  62
  63 /// FoldSingleEntryPHINodes - We know that BB has one predecessor.  If there are
  64 /// any single-entry PHI nodes in it, fold them away.  This handles the case
  65 /// when all entries to the PHI nodes in a block are guaranteed equal, such as
  66 /// when the block has exactly one predecessor.
  67 void llvm::FoldSingleEntryPHINodes(BasicBlock *BB, Pass *P) {
  68   if (!isa<PHINode>(BB->begin())) return;
  69
  70   AliasAnalysis *AA = 0;
  71   MemoryDependenceAnalysis *MemDep = 0;
  72   if (P) {
  73     AA = P->getAnalysisIfAvailable<AliasAnalysis>();
  74     MemDep = P->getAnalysisIfAvailable<MemoryDependenceAnalysis>();
  75   }
  76
  77   while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
  78     if (PN->getIncomingValue(0) != PN)
  79       PN->replaceAllUsesWith(PN->getIncomingValue(0));
  80     else
  81       PN->replaceAllUsesWith(UndefValue::get(PN->getType()));
  82
  83     if (MemDep)
  84       MemDep->removeInstruction(PN);  // Memdep updates AA itself.
  85     else if (AA && isa<PointerType>(PN->getType()))
  86       AA->deleteValue(PN);
  87
  88     PN->eraseFromParent();
  89   }
  90 }
  91
  92
  93 /// DeleteDeadPHIs - Examine each PHI in the given block and delete it if it
  94 /// is dead. Also recursively delete any operands that become dead as
  95 /// a result. This includes tracing the def-use list from the PHI to see if
  96 /// it is ultimately unused or if it reaches an unused cycle.
  97 bool llvm::DeleteDeadPHIs(BasicBlock *BB) {
  98   // Recursively deleting a PHI may cause multiple PHIs to be deleted
  99   // or RAUW'd undef, so use an array of WeakVH for the PHIs to delete.
 100   SmallVector<WeakVH, 8> PHIs;
 101   for (BasicBlock::iterator I = BB->begin();
 102        PHINode *PN = dyn_cast<PHINode>(I); ++I)
 103     PHIs.push_back(PN);
 104
 105   bool Changed = false;
 106   for (unsigned i = 0, e = PHIs.size(); i != e; ++i)
 107     if (PHINode *PN = dyn_cast_or_null<PHINode>(PHIs[i].operator Value*()))
 108       Changed |= RecursivelyDeleteDeadPHINode(PN);
 109
 110   return Changed;
 111 }
 112
 113 /// MergeBlockIntoPredecessor - Attempts to merge a block into its predecessor,
 114 /// if possible.  The return value indicates success or failure.
 115 bool llvm::MergeBlockIntoPredecessor(BasicBlock *BB, Pass *P) {
 116   // Don't merge away blocks who have their address taken.
 117   if (BB->hasAddressTaken()) return false;
 118
 119   // Can't merge if there are multiple predecessors, or no predecessors.
 120   BasicBlock *PredBB = BB->getUniquePredecessor();
 121   if (!PredBB) return false;
 122
 123   // Don't break self-loops.
 124   if (PredBB == BB) return false;
 125   // Don't break invokes.
 126   if (isa<InvokeInst>(PredBB->getTerminator())) return false;
 127
 128   succ_iterator SI(succ_begin(PredBB)), SE(succ_end(PredBB));
 129   BasicBlock *OnlySucc = BB;
 130   for (; SI != SE; ++SI)
 131     if (*SI != OnlySucc) {
 132       OnlySucc = 0;     // There are multiple distinct successors!
 133       break;
 134     }
 135
 136   // Can't merge if there are multiple successors.
 137   if (!OnlySucc) return false;
 138
 139   // Can't merge if there is PHI loop.
 140   for (BasicBlock::iterator BI = BB->begin(), BE = BB->end(); BI != BE; ++BI) {
 141     if (PHINode *PN = dyn_cast<PHINode>(BI)) {
 142       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 143         if (PN->getIncomingValue(i) == PN)
 144           return false;
 145     } else
 146       break;
 147   }
 148
 149   // Begin by getting rid of unneeded PHIs.
 150   if (isa<PHINode>(BB->front()))
 151     FoldSingleEntryPHINodes(BB, P);
 152
 153   // Delete the unconditional branch from the predecessor...
 154   PredBB->getInstList().pop_back();
 155
 156   // Make all PHI nodes that referred to BB now refer to Pred as their
 157   // source...
 158   BB->replaceAllUsesWith(PredBB);
 159
 160   // Move all definitions in the successor to the predecessor...
 161   PredBB->getInstList().splice(PredBB->end(), BB->getInstList());
 162
 163   // Inherit predecessors name if it exists.
 164   if (!PredBB->hasName())
 165     PredBB->takeName(BB);
 166
 167   // Finally, erase the old block and update dominator info.
 168   if (P) {
 169     if (DominatorTree *DT = P->getAnalysisIfAvailable<DominatorTree>()) {
 170       if (DomTreeNode *DTN = DT->getNode(BB)) {
 171         DomTreeNode *PredDTN = DT->getNode(PredBB);
 172         SmallVector<DomTreeNode*, 8> Children(DTN->begin(), DTN->end());
 173         for (SmallVector<DomTreeNode*, 8>::iterator DI = Children.begin(),
 174              DE = Children.end(); DI != DE; ++DI)
 175           DT->changeImmediateDominator(*DI, PredDTN);
 176
 177         DT->eraseNode(BB);
 178       }
 179
 180       if (LoopInfo *LI = P->getAnalysisIfAvailable<LoopInfo>())
 181         LI->removeBlock(BB);
 182
 183       if (MemoryDependenceAnalysis *MD =
 184             P->getAnalysisIfAvailable<MemoryDependenceAnalysis>())
 185         MD->invalidateCachedPredecessors();
 186     }
 187   }
 188
 189   BB->eraseFromParent();
 190   return true;
 191 }
 192
 193 /// ReplaceInstWithValue - Replace all uses of an instruction (specified by BI)
 194 /// with a value, then remove and delete the original instruction.
 195 ///
 196 void llvm::ReplaceInstWithValue(BasicBlock::InstListType &BIL,
 197                                 BasicBlock::iterator &BI, Value *V) {
 198   Instruction &I = *BI;
 199   // Replaces all of the uses of the instruction with uses of the value
 200   I.replaceAllUsesWith(V);
 201
 202   // Make sure to propagate a name if there is one already.
 203   if (I.hasName() && !V->hasName())
 204     V->takeName(&I);
 205
 206   // Delete the unnecessary instruction now...
 207   BI = BIL.erase(BI);
 208 }
 209
 210
 211 /// ReplaceInstWithInst - Replace the instruction specified by BI with the
 212 /// instruction specified by I.  The original instruction is deleted and BI is
 213 /// updated to point to the new instruction.
 214 ///
 215 void llvm::ReplaceInstWithInst(BasicBlock::InstListType &BIL,
 216                                BasicBlock::iterator &BI, Instruction *I) {
 217   assert(I->getParent() == 0 &&
 218          "ReplaceInstWithInst: Instruction already inserted into basic block!");
 219
 220   // Insert the new instruction into the basic block...
 221   BasicBlock::iterator New = BIL.insert(BI, I);
 222
 223   // Replace all uses of the old instruction, and delete it.
 224   ReplaceInstWithValue(BIL, BI, I);
 225
 226   // Move BI back to point to the newly inserted instruction
 227   BI = New;
 228 }
 229
 230 /// ReplaceInstWithInst - Replace the instruction specified by From with the
 231 /// instruction specified by To.
 232 ///
 233 void llvm::ReplaceInstWithInst(Instruction *From, Instruction *To) {
 234   BasicBlock::iterator BI(From);
 235   ReplaceInstWithInst(From->getParent()->getInstList(), BI, To);
 236 }
 237
 238 /// GetSuccessorNumber - Search for the specified successor of basic block BB
 239 /// and return its position in the terminator instruction's list of
 240 /// successors.  It is an error to call this with a block that is not a
 241 /// successor.
 242 unsigned llvm::GetSuccessorNumber(BasicBlock *BB, BasicBlock *Succ) {
 243   TerminatorInst *Term = BB->getTerminator();
 244 #ifndef NDEBUG
 245   unsigned e = Term->getNumSuccessors();
 246 #endif
 247   for (unsigned i = 0; ; ++i) {
 248     assert(i != e && "Didn't find edge?");
 249     if (Term->getSuccessor(i) == Succ)
 250       return i;
 251   }
 252   return 0;
 253 }
 254
 255 /// SplitEdge -  Split the edge connecting specified block. Pass P must
 256 /// not be NULL.
 257 BasicBlock *llvm::SplitEdge(BasicBlock *BB, BasicBlock *Succ, Pass *P) {
 258   unsigned SuccNum = GetSuccessorNumber(BB, Succ);
 259
 260   // If this is a critical edge, let SplitCriticalEdge do it.
 261   TerminatorInst *LatchTerm = BB->getTerminator();
 262   if (SplitCriticalEdge(LatchTerm, SuccNum, P))
 263     return LatchTerm->getSuccessor(SuccNum);
 264
 265   // If the edge isn't critical, then BB has a single successor or Succ has a
 266   // single pred.  Split the block.
 267   BasicBlock::iterator SplitPoint;
 268   if (BasicBlock *SP = Succ->getSinglePredecessor()) {
 269     // If the successor only has a single pred, split the top of the successor
 270     // block.
 271     assert(SP == BB && "CFG broken");
 272     SP = NULL;
 273     return SplitBlock(Succ, Succ->begin(), P);
 274   }
 275
 276   // Otherwise, if BB has a single successor, split it at the bottom of the
 277   // block.
 278   assert(BB->getTerminator()->getNumSuccessors() == 1 &&
 279          "Should have a single succ!");
 280   return SplitBlock(BB, BB->getTerminator(), P);
 281 }
 282
 283 /// SplitBlock - Split the specified block at the specified instruction - every
 284 /// thing before SplitPt stays in Old and everything starting with SplitPt moves
 285 /// to a new block.  The two blocks are joined by an unconditional branch and
 286 /// the loop info is updated.
 287 ///
 288 BasicBlock *llvm::SplitBlock(BasicBlock *Old, Instruction *SplitPt, Pass *P) {
 289   BasicBlock::iterator SplitIt = SplitPt;
 290   while (isa<PHINode>(SplitIt) || isa<LandingPadInst>(SplitIt))
 291     ++SplitIt;
 292   BasicBlock *New = Old->splitBasicBlock(SplitIt, Old->getName()+".split");
 293
 294   // The new block lives in whichever loop the old one did. This preserves
 295   // LCSSA as well, because we force the split point to be after any PHI nodes.
 296   if (LoopInfo *LI = P->getAnalysisIfAvailable<LoopInfo>())
 297     if (Loop *L = LI->getLoopFor(Old))
 298       L->addBasicBlockToLoop(New, LI->getBase());
 299
 300   if (DominatorTree *DT = P->getAnalysisIfAvailable<DominatorTree>()) {
 301     // Old dominates New. New node dominates all other nodes dominated by Old.
 302     DomTreeNode *OldNode = DT->getNode(Old);
 303     std::vector<DomTreeNode *> Children;
 304     for (DomTreeNode::iterator I = OldNode->begin(), E = OldNode->end();
 305          I != E; ++I)
 306       Children.push_back(*I);
 307
 308       DomTreeNode *NewNode = DT->addNewBlock(New,Old);
 309       for (std::vector<DomTreeNode *>::iterator I = Children.begin(),
 310              E = Children.end(); I != E; ++I)
 311         DT->changeImmediateDominator(*I, NewNode);
 312   }
 313
 314   return New;
 315 }
 316
 317 /// UpdateAnalysisInformation - Update DominatorTree, LoopInfo, and LCCSA
 318 /// analysis information.
 319 static void UpdateAnalysisInformation(BasicBlock *OldBB, BasicBlock *NewBB,
 320                                       ArrayRef<BasicBlock *> Preds,
 321                                       Pass *P, bool &HasLoopExit) {
 322   if (!P) return;
 323
 324   LoopInfo *LI = P->getAnalysisIfAvailable<LoopInfo>();
 325   Loop *L = LI ? LI->getLoopFor(OldBB) : 0;
 326   bool PreserveLCSSA = P->mustPreserveAnalysisID(LCSSAID);
 327
 328   // If we need to preserve loop analyses, collect some information about how
 329   // this split will affect loops.
 330   bool IsLoopEntry = !!L;
 331   bool SplitMakesNewLoopHeader = false;
 332   if (LI) {
 333     for (ArrayRef<BasicBlock*>::iterator
 334            i = Preds.begin(), e = Preds.end(); i != e; ++i) {
 335       BasicBlock *Pred = *i;
 336       // If we need to preserve LCSSA, determine if any of the preds is a loop
 337       // exit.
 338       if (PreserveLCSSA)
 339         if (Loop *PL = LI->getLoopFor(Pred))
 340           if (!PL->contains(OldBB))
 341             HasLoopExit = true;
 342
 343       // If we need to preserve LoopInfo, note whether any of the preds crosses
 344       // an interesting loop boundary.
 345       if (!L) continue;
 346       if (L->contains(Pred))
 347         IsLoopEntry = false;
 348       else
 349         SplitMakesNewLoopHeader = true;
 350     }
 351   }
 352
 353   // Update dominator tree if available.
 354   DominatorTree *DT = P->getAnalysisIfAvailable<DominatorTree>();
 355   if (DT)
 356     DT->splitBlock(NewBB);
 357
 358   if (!L) return;
 359
 360   if (IsLoopEntry) {
 361     // Add the new block to the nearest enclosing loop (and not an adjacent
 362     // loop). To find this, examine each of the predecessors and determine which
 363     // loops enclose them, and select the most-nested loop which contains the
 364     // loop containing the block being split.
 365     Loop *InnermostPredLoop = 0;
 366     for (ArrayRef<BasicBlock*>::iterator
 367            i = Preds.begin(), e = Preds.end(); i != e; ++i) {
 368       BasicBlock *Pred = *i;
 369       if (Loop *PredLoop = LI->getLoopFor(Pred)) {
 370         // Seek a loop which actually contains the block being split (to avoid
 371         // adjacent loops).
 372         while (PredLoop && !PredLoop->contains(OldBB))
 373           PredLoop = PredLoop->getParentLoop();
 374
 375         // Select the most-nested of these loops which contains the block.
 376         if (PredLoop && PredLoop->contains(OldBB) &&
 377             (!InnermostPredLoop ||
 378              InnermostPredLoop->getLoopDepth() < PredLoop->getLoopDepth()))
 379           InnermostPredLoop = PredLoop;
 380       }
 381     }
 382
 383     if (InnermostPredLoop)
 384       InnermostPredLoop->addBasicBlockToLoop(NewBB, LI->getBase());
 385   } else {
 386     L->addBasicBlockToLoop(NewBB, LI->getBase());
 387     if (SplitMakesNewLoopHeader)
 388       L->moveToHeader(NewBB);
 389   }
 390 }
 391
 392 /// UpdatePHINodes - Update the PHI nodes in OrigBB to include the values coming
 393 /// from NewBB. This also updates AliasAnalysis, if available.
 394 static void UpdatePHINodes(BasicBlock *OrigBB, BasicBlock *NewBB,
 395                            ArrayRef<BasicBlock*> Preds, BranchInst *BI,
 396                            Pass *P, bool HasLoopExit) {
 397   // Otherwise, create a new PHI node in NewBB for each PHI node in OrigBB.
 398   AliasAnalysis *AA = P ? P->getAnalysisIfAvailable<AliasAnalysis>() : 0;
 399   for (BasicBlock::iterator I = OrigBB->begin(); isa<PHINode>(I); ) {
 400     PHINode *PN = cast<PHINode>(I++);
 401
 402     // Check to see if all of the values coming in are the same.  If so, we
 403     // don't need to create a new PHI node, unless it's needed for LCSSA.
 404     Value *InVal = 0;
 405     if (!HasLoopExit) {
 406       InVal = PN->getIncomingValueForBlock(Preds[0]);
 407       for (unsigned i = 1, e = Preds.size(); i != e; ++i)
 408         if (InVal != PN->getIncomingValueForBlock(Preds[i])) {
 409           InVal = 0;
 410           break;
 411         }
 412     }
 413
 414     if (InVal) {
 415       // If all incoming values for the new PHI would be the same, just don't
 416       // make a new PHI.  Instead, just remove the incoming values from the old
 417       // PHI.
 418       for (unsigned i = 0, e = Preds.size(); i != e; ++i)
 419         PN->removeIncomingValue(Preds[i], false);
 420     } else {
 421       // If the values coming into the block are not the same, we need a PHI.
 422       // Create the new PHI node, insert it into NewBB at the end of the block
 423       PHINode *NewPHI =
 424         PHINode::Create(PN->getType(), Preds.size(), PN->getName() + ".ph", BI);
 425       if (AA) AA->copyValue(PN, NewPHI);
 426
 427       // Move all of the PHI values for 'Preds' to the new PHI.
 428       for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
 429         Value *V = PN->removeIncomingValue(Preds[i], false);
 430         NewPHI->addIncoming(V, Preds[i]);
 431       }
 432
 433       InVal = NewPHI;
 434     }
 435
 436     // Add an incoming value to the PHI node in the loop for the preheader
 437     // edge.
 438     PN->addIncoming(InVal, NewBB);
 439   }
 440 }
 441
 442 /// SplitBlockPredecessors - This method transforms BB by introducing a new
 443 /// basic block into the function, and moving some of the predecessors of BB to
 444 /// be predecessors of the new block.  The new predecessors are indicated by the
 445 /// Preds array, which has NumPreds elements in it.  The new block is given a
 446 /// suffix of 'Suffix'.
 447 ///
 448 /// This currently updates the LLVM IR, AliasAnalysis, DominatorTree,
 449 /// LoopInfo, and LCCSA but no other analyses. In particular, it does not
 450 /// preserve LoopSimplify (because it's complicated to handle the case where one
 451 /// of the edges being split is an exit of a loop with other exits).
 452 ///
 453 BasicBlock *llvm::SplitBlockPredecessors(BasicBlock *BB,
 454                                          BasicBlock *const *Preds,
 455                                          unsigned NumPreds, const char *Suffix,
 456                                          Pass *P) {
 457   // Create new basic block, insert right before the original block.
 458   BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), BB->getName()+Suffix,
 459                                          BB->getParent(), BB);
 460
 461   // The new block unconditionally branches to the old block.
 462   BranchInst *BI = BranchInst::Create(BB, NewBB);
 463
 464   // Move the edges from Preds to point to NewBB instead of BB.
 465   for (unsigned i = 0; i != NumPreds; ++i) {
 466     // This is slightly more strict than necessary; the minimum requirement
 467     // is that there be no more than one indirectbr branching to BB. And
 468     // all BlockAddress uses would need to be updated.
 469     assert(!isa<IndirectBrInst>(Preds[i]->getTerminator()) &&
 470            "Cannot split an edge from an IndirectBrInst");
 471     Preds[i]->getTerminator()->replaceUsesOfWith(BB, NewBB);
 472   }
 473
 474   // Insert a new PHI node into NewBB for every PHI node in BB and that new PHI
 475   // node becomes an incoming value for BB's phi node.  However, if the Preds
 476   // list is empty, we need to insert dummy entries into the PHI nodes in BB to
 477   // account for the newly created predecessor.
 478   if (NumPreds == 0) {
 479     // Insert dummy values as the incoming value.
 480     for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++I)
 481       cast<PHINode>(I)->addIncoming(UndefValue::get(I->getType()), NewBB);
 482     return NewBB;
 483   }
 484
 485   // Update DominatorTree, LoopInfo, and LCCSA analysis information.
 486   bool HasLoopExit = false;
 487   UpdateAnalysisInformation(BB, NewBB, ArrayRef<BasicBlock*>(Preds, NumPreds),
 488                             P, HasLoopExit);
 489
 490   // Update the PHI nodes in BB with the values coming from NewBB.
 491   UpdatePHINodes(BB, NewBB, ArrayRef<BasicBlock*>(Preds, NumPreds), BI,
 492                  P, HasLoopExit);
 493   return NewBB;
 494 }
 495
 496 /// FindFunctionBackedges - Analyze the specified function to find all of the
 497 /// loop backedges in the function and return them.  This is a relatively cheap
 498 /// (compared to computing dominators and loop info) analysis.
 499 ///
 500 /// The output is added to Result, as pairs of <from,to> edge info.
 501 void llvm::FindFunctionBackedges(const Function &F,
 502      SmallVectorImpl<std::pair<const BasicBlock*,const BasicBlock*> > &Result) {
 503   const BasicBlock *BB = &F.getEntryBlock();
 504   if (succ_begin(BB) == succ_end(BB))
 505     return;
 506
 507   SmallPtrSet<const BasicBlock*, 8> Visited;
 508   SmallVector<std::pair<const BasicBlock*, succ_const_iterator>, 8> VisitStack;
 509   SmallPtrSet<const BasicBlock*, 8> InStack;
 510
 511   Visited.insert(BB);
 512   VisitStack.push_back(std::make_pair(BB, succ_begin(BB)));
 513   InStack.insert(BB);
 514   do {
 515     std::pair<const BasicBlock*, succ_const_iterator> &Top = VisitStack.back();
 516     const BasicBlock *ParentBB = Top.first;
 517     succ_const_iterator &I = Top.second;
 518
 519     bool FoundNew = false;
 520     while (I != succ_end(ParentBB)) {
 521       BB = *I++;
 522       if (Visited.insert(BB)) {
 523         FoundNew = true;
 524         break;
 525       }
 526       // Successor is in VisitStack, it's a back edge.
 527       if (InStack.count(BB))
 528         Result.push_back(std::make_pair(ParentBB, BB));
 529     }
 530
 531     if (FoundNew) {
 532       // Go down one level if there is a unvisited successor.
 533       InStack.insert(BB);
 534       VisitStack.push_back(std::make_pair(BB, succ_begin(BB)));
 535     } else {
 536       // Go up one level.
 537       InStack.erase(VisitStack.pop_back_val().first);
 538     }
 539   } while (!VisitStack.empty());
 540 }
 541
 542 /// FoldReturnIntoUncondBranch - This method duplicates the specified return
 543 /// instruction into a predecessor which ends in an unconditional branch. If
 544 /// the return instruction returns a value defined by a PHI, propagate the
 545 /// right value into the return. It returns the new return instruction in the
 546 /// predecessor.
 547 ReturnInst *llvm::FoldReturnIntoUncondBranch(ReturnInst *RI, BasicBlock *BB,
 548                                              BasicBlock *Pred) {
 549   Instruction *UncondBranch = Pred->getTerminator();
 550   // Clone the return and add it to the end of the predecessor.
 551   Instruction *NewRet = RI->clone();
 552   Pred->getInstList().push_back(NewRet);
 553
 554   // If the return instruction returns a value, and if the value was a
 555   // PHI node in "BB", propagate the right value into the return.
 556   for (User::op_iterator i = NewRet->op_begin(), e = NewRet->op_end();
 557        i != e; ++i)
 558     if (PHINode *PN = dyn_cast<PHINode>(*i))
 559       if (PN->getParent() == BB)
 560         *i = PN->getIncomingValueForBlock(Pred);
 561
 562   // Update any PHI nodes in the returning block to realize that we no
 563   // longer branch to them.
 564   BB->removePredecessor(Pred);
 565   UncondBranch->eraseFromParent();
 566   return cast<ReturnInst>(NewRet);
 567 }
 568
 569 /// GetFirstDebugLocInBasicBlock - Return first valid DebugLoc entry in a
 570 /// given basic block.
 571 DebugLoc llvm::GetFirstDebugLocInBasicBlock(const BasicBlock *BB) {
 572   if (const Instruction *I = BB->getFirstNonPHI())
 573     return I->getDebugLoc();
 574   // Scanning entire block may be too expensive, if the first instruction
 575   // does not have valid location info.
 576   return DebugLoc();
 577 }