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/Analysis/AliasAnalysis.h"
  17 #include "llvm/Analysis/CFG.h"
  18 #include "llvm/Analysis/LoopInfo.h"
  19 #include "llvm/Analysis/MemoryDependenceAnalysis.h"
  20 #include "llvm/IR/Constant.h"
  21 #include "llvm/IR/DataLayout.h"
  22 #include "llvm/IR/Dominators.h"
  23 #include "llvm/IR/Function.h"
  24 #include "llvm/IR/Instructions.h"
  25 #include "llvm/IR/IntrinsicInst.h"
  26 #include "llvm/IR/Type.h"
  27 #include "llvm/IR/ValueHandle.h"
  28 #include "llvm/Support/ErrorHandling.h"
  29 #include "llvm/Transforms/Scalar.h"
  30 #include "llvm/Transforms/Utils/Local.h"
  31 #include <algorithm>
  32 using namespace llvm;
  33
  34 /// DeleteDeadBlock - Delete the specified block, which must have no
  35 /// predecessors.
  36 void llvm::DeleteDeadBlock(BasicBlock *BB) {
  37   assert((pred_begin(BB) == pred_end(BB) ||
  38          // Can delete self loop.
  39          BB->getSinglePredecessor() == BB) && "Block is not dead!");
  40   TerminatorInst *BBTerm = BB->getTerminator();
  41
  42   // Loop through all of our successors and make sure they know that one
  43   // of their predecessors is going away.
  44   for (unsigned i = 0, e = BBTerm->getNumSuccessors(); i != e; ++i)
  45     BBTerm->getSuccessor(i)->removePredecessor(BB);
  46
  47   // Zap all the instructions in the block.
  48   while (!BB->empty()) {
  49     Instruction &I = BB->back();
  50     // If this instruction is used, replace uses with an arbitrary value.
  51     // Because control flow can't get here, we don't care what we replace the
  52     // value with.  Note that since this block is unreachable, and all values
  53     // contained within it must dominate their uses, that all uses will
  54     // eventually be removed (they are themselves dead).
  55     if (!I.use_empty())
  56       I.replaceAllUsesWith(UndefValue::get(I.getType()));
  57     BB->getInstList().pop_back();
  58   }
  59
  60   // Zap the block!
  61   BB->eraseFromParent();
  62 }
  63
  64 /// FoldSingleEntryPHINodes - We know that BB has one predecessor.  If there are
  65 /// any single-entry PHI nodes in it, fold them away.  This handles the case
  66 /// when all entries to the PHI nodes in a block are guaranteed equal, such as
  67 /// when the block has exactly one predecessor.
  68 void llvm::FoldSingleEntryPHINodes(BasicBlock *BB, AliasAnalysis *AA,
  69                                    MemoryDependenceAnalysis *MemDep) {
  70   if (!isa<PHINode>(BB->begin())) return;
  71
  72   while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
  73     if (PN->getIncomingValue(0) != PN)
  74       PN->replaceAllUsesWith(PN->getIncomingValue(0));
  75     else
  76       PN->replaceAllUsesWith(UndefValue::get(PN->getType()));
  77
  78     if (MemDep)
  79       MemDep->removeInstruction(PN);  // Memdep updates AA itself.
  80     else if (AA && isa<PointerType>(PN->getType()))
  81       AA->deleteValue(PN);
  82
  83     PN->eraseFromParent();
  84   }
  85 }
  86
  87
  88 /// DeleteDeadPHIs - Examine each PHI in the given block and delete it if it
  89 /// is dead. Also recursively delete any operands that become dead as
  90 /// a result. This includes tracing the def-use list from the PHI to see if
  91 /// it is ultimately unused or if it reaches an unused cycle.
  92 bool llvm::DeleteDeadPHIs(BasicBlock *BB, const TargetLibraryInfo *TLI) {
  93   // Recursively deleting a PHI may cause multiple PHIs to be deleted
  94   // or RAUW'd undef, so use an array of WeakVH for the PHIs to delete.
  95   SmallVector<WeakVH, 8> PHIs;
  96   for (BasicBlock::iterator I = BB->begin();
  97        PHINode *PN = dyn_cast<PHINode>(I); ++I)
  98     PHIs.push_back(PN);
  99
 100   bool Changed = false;
 101   for (unsigned i = 0, e = PHIs.size(); i != e; ++i)
 102     if (PHINode *PN = dyn_cast_or_null<PHINode>(PHIs[i].operator Value*()))
 103       Changed |= RecursivelyDeleteDeadPHINode(PN, TLI);
 104
 105   return Changed;
 106 }
 107
 108 /// MergeBlockIntoPredecessor - Attempts to merge a block into its predecessor,
 109 /// if possible.  The return value indicates success or failure.
 110 bool llvm::MergeBlockIntoPredecessor(BasicBlock *BB, DominatorTree *DT,
 111                                      LoopInfo *LI, AliasAnalysis *AA,
 112                                      MemoryDependenceAnalysis *MemDep) {
 113   // Don't merge away blocks who have their address taken.
 114   if (BB->hasAddressTaken()) return false;
 115
 116   // Can't merge if there are multiple predecessors, or no predecessors.
 117   BasicBlock *PredBB = BB->getUniquePredecessor();
 118   if (!PredBB) return false;
 119
 120   // Don't break self-loops.
 121   if (PredBB == BB) return false;
 122   // Don't break invokes.
 123   if (isa<InvokeInst>(PredBB->getTerminator())) return false;
 124
 125   succ_iterator SI(succ_begin(PredBB)), SE(succ_end(PredBB));
 126   BasicBlock *OnlySucc = BB;
 127   for (; SI != SE; ++SI)
 128     if (*SI != OnlySucc) {
 129       OnlySucc = nullptr;     // There are multiple distinct successors!
 130       break;
 131     }
 132
 133   // Can't merge if there are multiple successors.
 134   if (!OnlySucc) return false;
 135
 136   // Can't merge if there is PHI loop.
 137   for (BasicBlock::iterator BI = BB->begin(), BE = BB->end(); BI != BE; ++BI) {
 138     if (PHINode *PN = dyn_cast<PHINode>(BI)) {
 139       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 140         if (PN->getIncomingValue(i) == PN)
 141           return false;
 142     } else
 143       break;
 144   }
 145
 146   // Begin by getting rid of unneeded PHIs.
 147   if (isa<PHINode>(BB->front()))
 148     FoldSingleEntryPHINodes(BB, AA, MemDep);
 149
 150   // Delete the unconditional branch from the predecessor...
 151   PredBB->getInstList().pop_back();
 152
 153   // Make all PHI nodes that referred to BB now refer to Pred as their
 154   // source...
 155   BB->replaceAllUsesWith(PredBB);
 156
 157   // Move all definitions in the successor to the predecessor...
 158   PredBB->getInstList().splice(PredBB->end(), BB->getInstList());
 159
 160   // Inherit predecessors name if it exists.
 161   if (!PredBB->hasName())
 162     PredBB->takeName(BB);
 163
 164   // Finally, erase the old block and update dominator info.
 165   if (DT)
 166     if (DomTreeNode *DTN = DT->getNode(BB)) {
 167       DomTreeNode *PredDTN = DT->getNode(PredBB);
 168       SmallVector<DomTreeNode *, 8> Children(DTN->begin(), DTN->end());
 169       for (SmallVectorImpl<DomTreeNode *>::iterator DI = Children.begin(),
 170                                                     DE = Children.end();
 171            DI != DE; ++DI)
 172         DT->changeImmediateDominator(*DI, PredDTN);
 173
 174       DT->eraseNode(BB);
 175     }
 176
 177   if (LI)
 178     LI->removeBlock(BB);
 179
 180   if (MemDep)
 181     MemDep->invalidateCachedPredecessors();
 182
 183   BB->eraseFromParent();
 184   return true;
 185 }
 186
 187 /// ReplaceInstWithValue - Replace all uses of an instruction (specified by BI)
 188 /// with a value, then remove and delete the original instruction.
 189 ///
 190 void llvm::ReplaceInstWithValue(BasicBlock::InstListType &BIL,
 191                                 BasicBlock::iterator &BI, Value *V) {
 192   Instruction &I = *BI;
 193   // Replaces all of the uses of the instruction with uses of the value
 194   I.replaceAllUsesWith(V);
 195
 196   // Make sure to propagate a name if there is one already.
 197   if (I.hasName() && !V->hasName())
 198     V->takeName(&I);
 199
 200   // Delete the unnecessary instruction now...
 201   BI = BIL.erase(BI);
 202 }
 203
 204
 205 /// ReplaceInstWithInst - Replace the instruction specified by BI with the
 206 /// instruction specified by I.  The original instruction is deleted and BI is
 207 /// updated to point to the new instruction.
 208 ///
 209 void llvm::ReplaceInstWithInst(BasicBlock::InstListType &BIL,
 210                                BasicBlock::iterator &BI, Instruction *I) {
 211   assert(I->getParent() == nullptr &&
 212          "ReplaceInstWithInst: Instruction already inserted into basic block!");
 213
 214   // Insert the new instruction into the basic block...
 215   BasicBlock::iterator New = BIL.insert(BI, I);
 216
 217   // Replace all uses of the old instruction, and delete it.
 218   ReplaceInstWithValue(BIL, BI, I);
 219
 220   // Move BI back to point to the newly inserted instruction
 221   BI = New;
 222 }
 223
 224 /// ReplaceInstWithInst - Replace the instruction specified by From with the
 225 /// instruction specified by To.
 226 ///
 227 void llvm::ReplaceInstWithInst(Instruction *From, Instruction *To) {
 228   BasicBlock::iterator BI(From);
 229   ReplaceInstWithInst(From->getParent()->getInstList(), BI, To);
 230 }
 231
 232 /// SplitEdge -  Split the edge connecting specified block. Pass P must
 233 /// not be NULL.
 234 BasicBlock *llvm::SplitEdge(BasicBlock *BB, BasicBlock *Succ, Pass *P) {
 235   unsigned SuccNum = GetSuccessorNumber(BB, Succ);
 236
 237   // If this is a critical edge, let SplitCriticalEdge do it.
 238   TerminatorInst *LatchTerm = BB->getTerminator();
 239   if (SplitCriticalEdge(LatchTerm, SuccNum, P))
 240     return LatchTerm->getSuccessor(SuccNum);
 241
 242   // If the edge isn't critical, then BB has a single successor or Succ has a
 243   // single pred.  Split the block.
 244   if (BasicBlock *SP = Succ->getSinglePredecessor()) {
 245     // If the successor only has a single pred, split the top of the successor
 246     // block.
 247     assert(SP == BB && "CFG broken");
 248     SP = nullptr;
 249     return SplitBlock(Succ, Succ->begin(), P);
 250   }
 251
 252   // Otherwise, if BB has a single successor, split it at the bottom of the
 253   // block.
 254   assert(BB->getTerminator()->getNumSuccessors() == 1 &&
 255          "Should have a single succ!");
 256   return SplitBlock(BB, BB->getTerminator(), P);
 257 }
 258
 259 unsigned llvm::SplitAllCriticalEdges(Function &F, Pass *P) {
 260   unsigned NumBroken = 0;
 261   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
 262     TerminatorInst *TI = I->getTerminator();
 263     if (TI->getNumSuccessors() > 1 && !isa<IndirectBrInst>(TI))
 264       for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
 265         if (SplitCriticalEdge(TI, i, P))
 266           ++NumBroken;
 267   }
 268   return NumBroken;
 269 }
 270
 271 /// SplitBlock - Split the specified block at the specified instruction - every
 272 /// thing before SplitPt stays in Old and everything starting with SplitPt moves
 273 /// to a new block.  The two blocks are joined by an unconditional branch and
 274 /// the loop info is updated.
 275 ///
 276 BasicBlock *llvm::SplitBlock(BasicBlock *Old, Instruction *SplitPt, Pass *P) {
 277   BasicBlock::iterator SplitIt = SplitPt;
 278   while (isa<PHINode>(SplitIt) || isa<LandingPadInst>(SplitIt))
 279     ++SplitIt;
 280   BasicBlock *New = Old->splitBasicBlock(SplitIt, Old->getName()+".split");
 281
 282   // The new block lives in whichever loop the old one did. This preserves
 283   // LCSSA as well, because we force the split point to be after any PHI nodes.
 284   if (auto *LIWP = P->getAnalysisIfAvailable<LoopInfoWrapperPass>()) {
 285     LoopInfo &LI = LIWP->getLoopInfo();
 286     if (Loop *L = LI.getLoopFor(Old))
 287       L->addBasicBlockToLoop(New, LI);
 288   }
 289
 290   if (DominatorTreeWrapperPass *DTWP =
 291           P->getAnalysisIfAvailable<DominatorTreeWrapperPass>()) {
 292     DominatorTree &DT = DTWP->getDomTree();
 293     // Old dominates New. New node dominates all other nodes dominated by Old.
 294     if (DomTreeNode *OldNode = DT.getNode(Old)) {
 295       std::vector<DomTreeNode *> Children;
 296       for (DomTreeNode::iterator I = OldNode->begin(), E = OldNode->end();
 297            I != E; ++I)
 298         Children.push_back(*I);
 299
 300       DomTreeNode *NewNode = DT.addNewBlock(New, Old);
 301       for (std::vector<DomTreeNode *>::iterator I = Children.begin(),
 302              E = Children.end(); I != E; ++I)
 303         DT.changeImmediateDominator(*I, NewNode);
 304     }
 305   }
 306
 307   return New;
 308 }
 309
 310 /// UpdateAnalysisInformation - Update DominatorTree, LoopInfo, and LCCSA
 311 /// analysis information.
 312 static void UpdateAnalysisInformation(BasicBlock *OldBB, BasicBlock *NewBB,
 313                                       ArrayRef<BasicBlock *> Preds,
 314                                       Pass *P, bool &HasLoopExit) {
 315   if (!P) return;
 316
 317   auto *LIWP = P->getAnalysisIfAvailable<LoopInfoWrapperPass>();
 318   LoopInfo *LI = LIWP ? &LIWP->getLoopInfo() : nullptr;
 319   Loop *L = LI ? LI->getLoopFor(OldBB) : nullptr;
 320
 321   // If we need to preserve loop analyses, collect some information about how
 322   // this split will affect loops.
 323   bool IsLoopEntry = !!L;
 324   bool SplitMakesNewLoopHeader = false;
 325   if (LI) {
 326     bool PreserveLCSSA = P->mustPreserveAnalysisID(LCSSAID);
 327     for (ArrayRef<BasicBlock*>::iterator
 328            i = Preds.begin(), e = Preds.end(); i != e; ++i) {
 329       BasicBlock *Pred = *i;
 330
 331       // If we need to preserve LCSSA, determine if any of the preds is a loop
 332       // exit.
 333       if (PreserveLCSSA)
 334         if (Loop *PL = LI->getLoopFor(Pred))
 335           if (!PL->contains(OldBB))
 336             HasLoopExit = true;
 337
 338       // If we need to preserve LoopInfo, note whether any of the preds crosses
 339       // an interesting loop boundary.
 340       if (!L) continue;
 341       if (L->contains(Pred))
 342         IsLoopEntry = false;
 343       else
 344         SplitMakesNewLoopHeader = true;
 345     }
 346   }
 347
 348   // Update dominator tree if available.
 349   if (DominatorTreeWrapperPass *DTWP =
 350           P->getAnalysisIfAvailable<DominatorTreeWrapperPass>())
 351     DTWP->getDomTree().splitBlock(NewBB);
 352
 353   if (!L) return;
 354
 355   if (IsLoopEntry) {
 356     // Add the new block to the nearest enclosing loop (and not an adjacent
 357     // loop). To find this, examine each of the predecessors and determine which
 358     // loops enclose them, and select the most-nested loop which contains the
 359     // loop containing the block being split.
 360     Loop *InnermostPredLoop = nullptr;
 361     for (ArrayRef<BasicBlock*>::iterator
 362            i = Preds.begin(), e = Preds.end(); i != e; ++i) {
 363       BasicBlock *Pred = *i;
 364       if (Loop *PredLoop = LI->getLoopFor(Pred)) {
 365         // Seek a loop which actually contains the block being split (to avoid
 366         // adjacent loops).
 367         while (PredLoop && !PredLoop->contains(OldBB))
 368           PredLoop = PredLoop->getParentLoop();
 369
 370         // Select the most-nested of these loops which contains the block.
 371         if (PredLoop && PredLoop->contains(OldBB) &&
 372             (!InnermostPredLoop ||
 373              InnermostPredLoop->getLoopDepth() < PredLoop->getLoopDepth()))
 374           InnermostPredLoop = PredLoop;
 375       }
 376     }
 377
 378     if (InnermostPredLoop)
 379       InnermostPredLoop->addBasicBlockToLoop(NewBB, *LI);
 380   } else {
 381     L->addBasicBlockToLoop(NewBB, *LI);
 382     if (SplitMakesNewLoopHeader)
 383       L->moveToHeader(NewBB);
 384   }
 385 }
 386
 387 /// UpdatePHINodes - Update the PHI nodes in OrigBB to include the values coming
 388 /// from NewBB. This also updates AliasAnalysis, if available.
 389 static void UpdatePHINodes(BasicBlock *OrigBB, BasicBlock *NewBB,
 390                            ArrayRef<BasicBlock*> Preds, BranchInst *BI,
 391                            Pass *P, bool HasLoopExit) {
 392   // Otherwise, create a new PHI node in NewBB for each PHI node in OrigBB.
 393   AliasAnalysis *AA = P ? P->getAnalysisIfAvailable<AliasAnalysis>() : nullptr;
 394   SmallPtrSet<BasicBlock *, 16> PredSet(Preds.begin(), Preds.end());
 395   for (BasicBlock::iterator I = OrigBB->begin(); isa<PHINode>(I); ) {
 396     PHINode *PN = cast<PHINode>(I++);
 397
 398     // Check to see if all of the values coming in are the same.  If so, we
 399     // don't need to create a new PHI node, unless it's needed for LCSSA.
 400     Value *InVal = nullptr;
 401     if (!HasLoopExit) {
 402       InVal = PN->getIncomingValueForBlock(Preds[0]);
 403       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 404         if (!PredSet.count(PN->getIncomingBlock(i)))
 405           continue;
 406         if (!InVal)
 407           InVal = PN->getIncomingValue(i);
 408         else if (InVal != PN->getIncomingValue(i)) {
 409           InVal = nullptr;
 410           break;
 411         }
 412       }
 413     }
 414
 415     if (InVal) {
 416       // If all incoming values for the new PHI would be the same, just don't
 417       // make a new PHI.  Instead, just remove the incoming values from the old
 418       // PHI.
 419
 420       // NOTE! This loop walks backwards for a reason! First off, this minimizes
 421       // the cost of removal if we end up removing a large number of values, and
 422       // second off, this ensures that the indices for the incoming values
 423       // aren't invalidated when we remove one.
 424       for (int64_t i = PN->getNumIncomingValues() - 1; i >= 0; --i)
 425         if (PredSet.count(PN->getIncomingBlock(i)))
 426           PN->removeIncomingValue(i, false);
 427
 428       // Add an incoming value to the PHI node in the loop for the preheader
 429       // edge.
 430       PN->addIncoming(InVal, NewBB);
 431       continue;
 432     }
 433
 434     // If the values coming into the block are not the same, we need a new
 435     // PHI.
 436     // Create the new PHI node, insert it into NewBB at the end of the block
 437     PHINode *NewPHI =
 438         PHINode::Create(PN->getType(), Preds.size(), PN->getName() + ".ph", BI);
 439     if (AA)
 440       AA->copyValue(PN, NewPHI);
 441
 442     // NOTE! This loop walks backwards for a reason! First off, this minimizes
 443     // the cost of removal if we end up removing a large number of values, and
 444     // second off, this ensures that the indices for the incoming values aren't
 445     // invalidated when we remove one.
 446     for (int64_t i = PN->getNumIncomingValues() - 1; i >= 0; --i) {
 447       BasicBlock *IncomingBB = PN->getIncomingBlock(i);
 448       if (PredSet.count(IncomingBB)) {
 449         Value *V = PN->removeIncomingValue(i, false);
 450         NewPHI->addIncoming(V, IncomingBB);
 451       }
 452     }
 453
 454     PN->addIncoming(NewPHI, NewBB);
 455   }
 456 }
 457
 458 /// SplitBlockPredecessors - This method transforms BB by introducing a new
 459 /// basic block into the function, and moving some of the predecessors of BB to
 460 /// be predecessors of the new block.  The new predecessors are indicated by the
 461 /// Preds array, which has NumPreds elements in it.  The new block is given a
 462 /// suffix of 'Suffix'.
 463 ///
 464 /// This currently updates the LLVM IR, AliasAnalysis, DominatorTree,
 465 /// LoopInfo, and LCCSA but no other analyses. In particular, it does not
 466 /// preserve LoopSimplify (because it's complicated to handle the case where one
 467 /// of the edges being split is an exit of a loop with other exits).
 468 ///
 469 BasicBlock *llvm::SplitBlockPredecessors(BasicBlock *BB,
 470                                          ArrayRef<BasicBlock*> Preds,
 471                                          const char *Suffix, Pass *P) {
 472   // Create new basic block, insert right before the original block.
 473   BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), BB->getName()+Suffix,
 474                                          BB->getParent(), BB);
 475
 476   // The new block unconditionally branches to the old block.
 477   BranchInst *BI = BranchInst::Create(BB, NewBB);
 478
 479   // Move the edges from Preds to point to NewBB instead of BB.
 480   for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
 481     // This is slightly more strict than necessary; the minimum requirement
 482     // is that there be no more than one indirectbr branching to BB. And
 483     // all BlockAddress uses would need to be updated.
 484     assert(!isa<IndirectBrInst>(Preds[i]->getTerminator()) &&
 485            "Cannot split an edge from an IndirectBrInst");
 486     Preds[i]->getTerminator()->replaceUsesOfWith(BB, NewBB);
 487   }
 488
 489   // Insert a new PHI node into NewBB for every PHI node in BB and that new PHI
 490   // node becomes an incoming value for BB's phi node.  However, if the Preds
 491   // list is empty, we need to insert dummy entries into the PHI nodes in BB to
 492   // account for the newly created predecessor.
 493   if (Preds.size() == 0) {
 494     // Insert dummy values as the incoming value.
 495     for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++I)
 496       cast<PHINode>(I)->addIncoming(UndefValue::get(I->getType()), NewBB);
 497     return NewBB;
 498   }
 499
 500   // Update DominatorTree, LoopInfo, and LCCSA analysis information.
 501   bool HasLoopExit = false;
 502   UpdateAnalysisInformation(BB, NewBB, Preds, P, HasLoopExit);
 503
 504   // Update the PHI nodes in BB with the values coming from NewBB.
 505   UpdatePHINodes(BB, NewBB, Preds, BI, P, HasLoopExit);
 506   return NewBB;
 507 }
 508
 509 /// SplitLandingPadPredecessors - This method transforms the landing pad,
 510 /// OrigBB, by introducing two new basic blocks into the function. One of those
 511 /// new basic blocks gets the predecessors listed in Preds. The other basic
 512 /// block gets the remaining predecessors of OrigBB. The landingpad instruction
 513 /// OrigBB is clone into both of the new basic blocks. The new blocks are given
 514 /// the suffixes 'Suffix1' and 'Suffix2', and are returned in the NewBBs vector.
 515 ///
 516 /// This currently updates the LLVM IR, AliasAnalysis, DominatorTree,
 517 /// DominanceFrontier, LoopInfo, and LCCSA but no other analyses. In particular,
 518 /// it does not preserve LoopSimplify (because it's complicated to handle the
 519 /// case where one of the edges being split is an exit of a loop with other
 520 /// exits).
 521 ///
 522 void llvm::SplitLandingPadPredecessors(BasicBlock *OrigBB,
 523                                        ArrayRef<BasicBlock*> Preds,
 524                                        const char *Suffix1, const char *Suffix2,
 525                                        Pass *P,
 526                                        SmallVectorImpl<BasicBlock*> &NewBBs) {
 527   assert(OrigBB->isLandingPad() && "Trying to split a non-landing pad!");
 528
 529   // Create a new basic block for OrigBB's predecessors listed in Preds. Insert
 530   // it right before the original block.
 531   BasicBlock *NewBB1 = BasicBlock::Create(OrigBB->getContext(),
 532                                           OrigBB->getName() + Suffix1,
 533                                           OrigBB->getParent(), OrigBB);
 534   NewBBs.push_back(NewBB1);
 535
 536   // The new block unconditionally branches to the old block.
 537   BranchInst *BI1 = BranchInst::Create(OrigBB, NewBB1);
 538
 539   // Move the edges from Preds to point to NewBB1 instead of OrigBB.
 540   for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
 541     // This is slightly more strict than necessary; the minimum requirement
 542     // is that there be no more than one indirectbr branching to BB. And
 543     // all BlockAddress uses would need to be updated.
 544     assert(!isa<IndirectBrInst>(Preds[i]->getTerminator()) &&
 545            "Cannot split an edge from an IndirectBrInst");
 546     Preds[i]->getTerminator()->replaceUsesOfWith(OrigBB, NewBB1);
 547   }
 548
 549   // Update DominatorTree, LoopInfo, and LCCSA analysis information.
 550   bool HasLoopExit = false;
 551   UpdateAnalysisInformation(OrigBB, NewBB1, Preds, P, HasLoopExit);
 552
 553   // Update the PHI nodes in OrigBB with the values coming from NewBB1.
 554   UpdatePHINodes(OrigBB, NewBB1, Preds, BI1, P, HasLoopExit);
 555
 556   // Move the remaining edges from OrigBB to point to NewBB2.
 557   SmallVector<BasicBlock*, 8> NewBB2Preds;
 558   for (pred_iterator i = pred_begin(OrigBB), e = pred_end(OrigBB);
 559        i != e; ) {
 560     BasicBlock *Pred = *i++;
 561     if (Pred == NewBB1) continue;
 562     assert(!isa<IndirectBrInst>(Pred->getTerminator()) &&
 563            "Cannot split an edge from an IndirectBrInst");
 564     NewBB2Preds.push_back(Pred);
 565     e = pred_end(OrigBB);
 566   }
 567
 568   BasicBlock *NewBB2 = nullptr;
 569   if (!NewBB2Preds.empty()) {
 570     // Create another basic block for the rest of OrigBB's predecessors.
 571     NewBB2 = BasicBlock::Create(OrigBB->getContext(),
 572                                 OrigBB->getName() + Suffix2,
 573                                 OrigBB->getParent(), OrigBB);
 574     NewBBs.push_back(NewBB2);
 575
 576     // The new block unconditionally branches to the old block.
 577     BranchInst *BI2 = BranchInst::Create(OrigBB, NewBB2);
 578
 579     // Move the remaining edges from OrigBB to point to NewBB2.
 580     for (SmallVectorImpl<BasicBlock*>::iterator
 581            i = NewBB2Preds.begin(), e = NewBB2Preds.end(); i != e; ++i)
 582       (*i)->getTerminator()->replaceUsesOfWith(OrigBB, NewBB2);
 583
 584     // Update DominatorTree, LoopInfo, and LCCSA analysis information.
 585     HasLoopExit = false;
 586     UpdateAnalysisInformation(OrigBB, NewBB2, NewBB2Preds, P, HasLoopExit);
 587
 588     // Update the PHI nodes in OrigBB with the values coming from NewBB2.
 589     UpdatePHINodes(OrigBB, NewBB2, NewBB2Preds, BI2, P, HasLoopExit);
 590   }
 591
 592   LandingPadInst *LPad = OrigBB->getLandingPadInst();
 593   Instruction *Clone1 = LPad->clone();
 594   Clone1->setName(Twine("lpad") + Suffix1);
 595   NewBB1->getInstList().insert(NewBB1->getFirstInsertionPt(), Clone1);
 596
 597   if (NewBB2) {
 598     Instruction *Clone2 = LPad->clone();
 599     Clone2->setName(Twine("lpad") + Suffix2);
 600     NewBB2->getInstList().insert(NewBB2->getFirstInsertionPt(), Clone2);
 601
 602     // Create a PHI node for the two cloned landingpad instructions.
 603     PHINode *PN = PHINode::Create(LPad->getType(), 2, "lpad.phi", LPad);
 604     PN->addIncoming(Clone1, NewBB1);
 605     PN->addIncoming(Clone2, NewBB2);
 606     LPad->replaceAllUsesWith(PN);
 607     LPad->eraseFromParent();
 608   } else {
 609     // There is no second clone. Just replace the landing pad with the first
 610     // clone.
 611     LPad->replaceAllUsesWith(Clone1);
 612     LPad->eraseFromParent();
 613   }
 614 }
 615
 616 /// FoldReturnIntoUncondBranch - This method duplicates the specified return
 617 /// instruction into a predecessor which ends in an unconditional branch. If
 618 /// the return instruction returns a value defined by a PHI, propagate the
 619 /// right value into the return. It returns the new return instruction in the
 620 /// predecessor.
 621 ReturnInst *llvm::FoldReturnIntoUncondBranch(ReturnInst *RI, BasicBlock *BB,
 622                                              BasicBlock *Pred) {
 623   Instruction *UncondBranch = Pred->getTerminator();
 624   // Clone the return and add it to the end of the predecessor.
 625   Instruction *NewRet = RI->clone();
 626   Pred->getInstList().push_back(NewRet);
 627
 628   // If the return instruction returns a value, and if the value was a
 629   // PHI node in "BB", propagate the right value into the return.
 630   for (User::op_iterator i = NewRet->op_begin(), e = NewRet->op_end();
 631        i != e; ++i) {
 632     Value *V = *i;
 633     Instruction *NewBC = nullptr;
 634     if (BitCastInst *BCI = dyn_cast<BitCastInst>(V)) {
 635       // Return value might be bitcasted. Clone and insert it before the
 636       // return instruction.
 637       V = BCI->getOperand(0);
 638       NewBC = BCI->clone();
 639       Pred->getInstList().insert(NewRet, NewBC);
 640       *i = NewBC;
 641     }
 642     if (PHINode *PN = dyn_cast<PHINode>(V)) {
 643       if (PN->getParent() == BB) {
 644         if (NewBC)
 645           NewBC->setOperand(0, PN->getIncomingValueForBlock(Pred));
 646         else
 647           *i = PN->getIncomingValueForBlock(Pred);
 648       }
 649     }
 650   }
 651
 652   // Update any PHI nodes in the returning block to realize that we no
 653   // longer branch to them.
 654   BB->removePredecessor(Pred);
 655   UncondBranch->eraseFromParent();
 656   return cast<ReturnInst>(NewRet);
 657 }
 658
 659 /// SplitBlockAndInsertIfThen - Split the containing block at the
 660 /// specified instruction - everything before and including SplitBefore stays
 661 /// in the old basic block, and everything after SplitBefore is moved to a
 662 /// new block. The two blocks are connected by a conditional branch
 663 /// (with value of Cmp being the condition).
 664 /// Before:
 665 ///   Head
 666 ///   SplitBefore
 667 ///   Tail
 668 /// After:
 669 ///   Head
 670 ///   if (Cond)
 671 ///     ThenBlock
 672 ///   SplitBefore
 673 ///   Tail
 674 ///
 675 /// If Unreachable is true, then ThenBlock ends with
 676 /// UnreachableInst, otherwise it branches to Tail.
 677 /// Returns the NewBasicBlock's terminator.
 678
 679 TerminatorInst *llvm::SplitBlockAndInsertIfThen(Value *Cond,
 680                                                 Instruction *SplitBefore,
 681                                                 bool Unreachable,
 682                                                 MDNode *BranchWeights,
 683                                                 DominatorTree *DT) {
 684   BasicBlock *Head = SplitBefore->getParent();
 685   BasicBlock *Tail = Head->splitBasicBlock(SplitBefore);
 686   TerminatorInst *HeadOldTerm = Head->getTerminator();
 687   LLVMContext &C = Head->getContext();
 688   BasicBlock *ThenBlock = BasicBlock::Create(C, "", Head->getParent(), Tail);
 689   TerminatorInst *CheckTerm;
 690   if (Unreachable)
 691     CheckTerm = new UnreachableInst(C, ThenBlock);
 692   else
 693     CheckTerm = BranchInst::Create(Tail, ThenBlock);
 694   CheckTerm->setDebugLoc(SplitBefore->getDebugLoc());
 695   BranchInst *HeadNewTerm =
 696     BranchInst::Create(/*ifTrue*/ThenBlock, /*ifFalse*/Tail, Cond);
 697   HeadNewTerm->setDebugLoc(SplitBefore->getDebugLoc());
 698   HeadNewTerm->setMetadata(LLVMContext::MD_prof, BranchWeights);
 699   ReplaceInstWithInst(HeadOldTerm, HeadNewTerm);
 700
 701   if (DT) {
 702     if (DomTreeNode *OldNode = DT->getNode(Head)) {
 703       std::vector<DomTreeNode *> Children(OldNode->begin(), OldNode->end());
 704
 705       DomTreeNode *NewNode = DT->addNewBlock(Tail, Head);
 706       for (auto Child : Children)
 707         DT->changeImmediateDominator(Child, NewNode);
 708
 709       // Head dominates ThenBlock.
 710       DT->addNewBlock(ThenBlock, Head);
 711     }
 712   }
 713
 714   return CheckTerm;
 715 }
 716
 717 /// SplitBlockAndInsertIfThenElse is similar to SplitBlockAndInsertIfThen,
 718 /// but also creates the ElseBlock.
 719 /// Before:
 720 ///   Head
 721 ///   SplitBefore
 722 ///   Tail
 723 /// After:
 724 ///   Head
 725 ///   if (Cond)
 726 ///     ThenBlock
 727 ///   else
 728 ///     ElseBlock
 729 ///   SplitBefore
 730 ///   Tail
 731 void llvm::SplitBlockAndInsertIfThenElse(Value *Cond, Instruction *SplitBefore,
 732                                          TerminatorInst **ThenTerm,
 733                                          TerminatorInst **ElseTerm,
 734                                          MDNode *BranchWeights) {
 735   BasicBlock *Head = SplitBefore->getParent();
 736   BasicBlock *Tail = Head->splitBasicBlock(SplitBefore);
 737   TerminatorInst *HeadOldTerm = Head->getTerminator();
 738   LLVMContext &C = Head->getContext();
 739   BasicBlock *ThenBlock = BasicBlock::Create(C, "", Head->getParent(), Tail);
 740   BasicBlock *ElseBlock = BasicBlock::Create(C, "", Head->getParent(), Tail);
 741   *ThenTerm = BranchInst::Create(Tail, ThenBlock);
 742   (*ThenTerm)->setDebugLoc(SplitBefore->getDebugLoc());
 743   *ElseTerm = BranchInst::Create(Tail, ElseBlock);
 744   (*ElseTerm)->setDebugLoc(SplitBefore->getDebugLoc());
 745   BranchInst *HeadNewTerm =
 746     BranchInst::Create(/*ifTrue*/ThenBlock, /*ifFalse*/ElseBlock, Cond);
 747   HeadNewTerm->setDebugLoc(SplitBefore->getDebugLoc());
 748   HeadNewTerm->setMetadata(LLVMContext::MD_prof, BranchWeights);
 749   ReplaceInstWithInst(HeadOldTerm, HeadNewTerm);
 750 }
 751
 752
 753 /// GetIfCondition - Given a basic block (BB) with two predecessors,
 754 /// check to see if the merge at this block is due
 755 /// to an "if condition".  If so, return the boolean condition that determines
 756 /// which entry into BB will be taken.  Also, return by references the block
 757 /// that will be entered from if the condition is true, and the block that will
 758 /// be entered if the condition is false.
 759 ///
 760 /// This does no checking to see if the true/false blocks have large or unsavory
 761 /// instructions in them.
 762 Value *llvm::GetIfCondition(BasicBlock *BB, BasicBlock *&IfTrue,
 763                              BasicBlock *&IfFalse) {
 764   PHINode *SomePHI = dyn_cast<PHINode>(BB->begin());
 765   BasicBlock *Pred1 = nullptr;
 766   BasicBlock *Pred2 = nullptr;
 767
 768   if (SomePHI) {
 769     if (SomePHI->getNumIncomingValues() != 2)
 770       return nullptr;
 771     Pred1 = SomePHI->getIncomingBlock(0);
 772     Pred2 = SomePHI->getIncomingBlock(1);
 773   } else {
 774     pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
 775     if (PI == PE) // No predecessor
 776       return nullptr;
 777     Pred1 = *PI++;
 778     if (PI == PE) // Only one predecessor
 779       return nullptr;
 780     Pred2 = *PI++;
 781     if (PI != PE) // More than two predecessors
 782       return nullptr;
 783   }
 784
 785   // We can only handle branches.  Other control flow will be lowered to
 786   // branches if possible anyway.
 787   BranchInst *Pred1Br = dyn_cast<BranchInst>(Pred1->getTerminator());
 788   BranchInst *Pred2Br = dyn_cast<BranchInst>(Pred2->getTerminator());
 789   if (!Pred1Br || !Pred2Br)
 790     return nullptr;
 791
 792   // Eliminate code duplication by ensuring that Pred1Br is conditional if
 793   // either are.
 794   if (Pred2Br->isConditional()) {
 795     // If both branches are conditional, we don't have an "if statement".  In
 796     // reality, we could transform this case, but since the condition will be
 797     // required anyway, we stand no chance of eliminating it, so the xform is
 798     // probably not profitable.
 799     if (Pred1Br->isConditional())
 800       return nullptr;
 801
 802     std::swap(Pred1, Pred2);
 803     std::swap(Pred1Br, Pred2Br);
 804   }
 805
 806   if (Pred1Br->isConditional()) {
 807     // The only thing we have to watch out for here is to make sure that Pred2
 808     // doesn't have incoming edges from other blocks.  If it does, the condition
 809     // doesn't dominate BB.
 810     if (!Pred2->getSinglePredecessor())
 811       return nullptr;
 812
 813     // If we found a conditional branch predecessor, make sure that it branches
 814     // to BB and Pred2Br.  If it doesn't, this isn't an "if statement".
 815     if (Pred1Br->getSuccessor(0) == BB &&
 816         Pred1Br->getSuccessor(1) == Pred2) {
 817       IfTrue = Pred1;
 818       IfFalse = Pred2;
 819     } else if (Pred1Br->getSuccessor(0) == Pred2 &&
 820                Pred1Br->getSuccessor(1) == BB) {
 821       IfTrue = Pred2;
 822       IfFalse = Pred1;
 823     } else {
 824       // We know that one arm of the conditional goes to BB, so the other must
 825       // go somewhere unrelated, and this must not be an "if statement".
 826       return nullptr;
 827     }
 828
 829     return Pred1Br->getCondition();
 830   }
 831
 832   // Ok, if we got here, both predecessors end with an unconditional branch to
 833   // BB.  Don't panic!  If both blocks only have a single (identical)
 834   // predecessor, and THAT is a conditional branch, then we're all ok!
 835   BasicBlock *CommonPred = Pred1->getSinglePredecessor();
 836   if (CommonPred == nullptr || CommonPred != Pred2->getSinglePredecessor())
 837     return nullptr;
 838
 839   // Otherwise, if this is a conditional branch, then we can use it!
 840   BranchInst *BI = dyn_cast<BranchInst>(CommonPred->getTerminator());
 841   if (!BI) return nullptr;
 842
 843   assert(BI->isConditional() && "Two successors but not conditional?");
 844   if (BI->getSuccessor(0) == Pred1) {
 845     IfTrue = Pred1;
 846     IfFalse = Pred2;
 847   } else {
 848     IfTrue = Pred2;
 849     IfFalse = Pred1;
 850   }
 851   return BI->getCondition();
 852 }