lib/VMCore/BasicBlock.cpp

   1 //===-- BasicBlock.cpp - Implement BasicBlock related methods -------------===//
   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 BasicBlock class for the VMCore library.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/BasicBlock.h"
  15 #include "llvm/Constants.h"
  16 #include "llvm/Instructions.h"
  17 #include "llvm/Type.h"
  18 #include "llvm/ADT/STLExtras.h"
  19 #include "llvm/Support/CFG.h"
  20 #include "llvm/Support/LeakDetector.h"
  21 #include "llvm/Support/Compiler.h"
  22 #include "SymbolTableListTraitsImpl.h"
  23 #include <algorithm>
  24 using namespace llvm;
  25
  26 inline ValueSymbolTable *
  27 ilist_traits<Instruction>::getSymTab(BasicBlock *BB) {
  28   if (BB)
  29     if (Function *F = BB->getParent())
  30       return &F->getValueSymbolTable();
  31   return 0;
  32 }
  33
  34 iplist<Instruction> &ilist_traits<Instruction>::getList(BasicBlock *BB) {
  35   return BB->getInstList();
  36 }
  37
  38 // Explicit instantiation of SymbolTableListTraits since some of the methods
  39 // are not in the public header file...
  40 template class SymbolTableListTraits<Instruction, BasicBlock>;
  41
  42
  43 BasicBlock::BasicBlock(const std::string &Name, Function *NewParent,
  44                        BasicBlock *InsertBefore)
  45   : Value(Type::LabelTy, Value::BasicBlockVal), Parent(0) {
  46
  47   // Make sure that we get added to a function
  48   LeakDetector::addGarbageObject(this);
  49
  50   if (InsertBefore) {
  51     assert(NewParent &&
  52            "Cannot insert block before another block with no function!");
  53     NewParent->getBasicBlockList().insert(InsertBefore, this);
  54   } else if (NewParent) {
  55     NewParent->getBasicBlockList().push_back(this);
  56   }
  57
  58   setName(Name);
  59 }
  60
  61
  62 BasicBlock::~BasicBlock() {
  63   assert(getParent() == 0 && "BasicBlock still linked into the program!");
  64   dropAllReferences();
  65   InstList.clear();
  66 }
  67
  68 void BasicBlock::setParent(Function *parent) {
  69   if (getParent())
  70     LeakDetector::addGarbageObject(this);
  71
  72   // Set Parent=parent, updating instruction symtab entries as appropriate.
  73   InstList.setSymTabObject(&Parent, parent);
  74
  75   if (getParent())
  76     LeakDetector::removeGarbageObject(this);
  77 }
  78
  79 void BasicBlock::removeFromParent() {
  80   getParent()->getBasicBlockList().remove(this);
  81 }
  82
  83 void BasicBlock::eraseFromParent() {
  84   getParent()->getBasicBlockList().erase(this);
  85 }
  86
  87 /// moveBefore - Unlink this basic block from its current function and
  88 /// insert it into the function that MovePos lives in, right before MovePos.
  89 void BasicBlock::moveBefore(BasicBlock *MovePos) {
  90   MovePos->getParent()->getBasicBlockList().splice(MovePos,
  91                        getParent()->getBasicBlockList(), this);
  92 }
  93
  94 /// moveAfter - Unlink this basic block from its current function and
  95 /// insert it into the function that MovePos lives in, right after MovePos.
  96 void BasicBlock::moveAfter(BasicBlock *MovePos) {
  97   Function::iterator I = MovePos;
  98   MovePos->getParent()->getBasicBlockList().splice(++I,
  99                                        getParent()->getBasicBlockList(), this);
 100 }
 101
 102
 103 TerminatorInst *BasicBlock::getTerminator() {
 104   if (InstList.empty()) return 0;
 105   return dyn_cast<TerminatorInst>(&InstList.back());
 106 }
 107
 108 const TerminatorInst *BasicBlock::getTerminator() const {
 109   if (InstList.empty()) return 0;
 110   return dyn_cast<TerminatorInst>(&InstList.back());
 111 }
 112
 113 Instruction* BasicBlock::getFirstNonPHI() {
 114   BasicBlock::iterator i = begin();
 115   // All valid basic blocks should have a terminator,
 116   // which is not a PHINode. If we have an invalid basic
 117   // block we'll get an assertion failure when dereferencing
 118   // a past-the-end iterator.
 119   while (isa<PHINode>(i)) ++i;
 120   return &*i;
 121 }
 122
 123 void BasicBlock::dropAllReferences() {
 124   for(iterator I = begin(), E = end(); I != E; ++I)
 125     I->dropAllReferences();
 126 }
 127
 128 /// getSinglePredecessor - If this basic block has a single predecessor block,
 129 /// return the block, otherwise return a null pointer.
 130 BasicBlock *BasicBlock::getSinglePredecessor() {
 131   pred_iterator PI = pred_begin(this), E = pred_end(this);
 132   if (PI == E) return 0;         // No preds.
 133   BasicBlock *ThePred = *PI;
 134   ++PI;
 135   return (PI == E) ? ThePred : 0 /*multiple preds*/;
 136 }
 137
 138 /// getUniquePredecessor - If this basic block has a unique predecessor block,
 139 /// return the block, otherwise return a null pointer.
 140 /// Note that unique predecessor doesn't mean single edge, there can be
 141 /// multiple edges from the unique predecessor to this block (for example
 142 /// a switch statement with multiple cases having the same destination).
 143 BasicBlock *BasicBlock::getUniquePredecessor() {
 144   pred_iterator PI = pred_begin(this), E = pred_end(this);
 145   if (PI == E) return 0; // No preds.
 146   BasicBlock *PredBB = *PI;
 147   ++PI;
 148   for (;PI != E; ++PI) {
 149     if (*PI != PredBB)
 150       return 0;
 151     // The same predecessor appears multiple times in the predecessor list.
 152     // This is OK.
 153   }
 154   return PredBB;
 155 }
 156
 157 /// removePredecessor - This method is used to notify a BasicBlock that the
 158 /// specified Predecessor of the block is no longer able to reach it.  This is
 159 /// actually not used to update the Predecessor list, but is actually used to
 160 /// update the PHI nodes that reside in the block.  Note that this should be
 161 /// called while the predecessor still refers to this block.
 162 ///
 163 void BasicBlock::removePredecessor(BasicBlock *Pred,
 164                                    bool DontDeleteUselessPHIs) {
 165   assert((hasNUsesOrMore(16)||// Reduce cost of this assertion for complex CFGs.
 166           find(pred_begin(this), pred_end(this), Pred) != pred_end(this)) &&
 167          "removePredecessor: BB is not a predecessor!");
 168
 169   if (InstList.empty()) return;
 170   PHINode *APN = dyn_cast<PHINode>(&front());
 171   if (!APN) return;   // Quick exit.
 172
 173   // If there are exactly two predecessors, then we want to nuke the PHI nodes
 174   // altogether.  However, we cannot do this, if this in this case:
 175   //
 176   //  Loop:
 177   //    %x = phi [X, Loop]
 178   //    %x2 = add %x, 1         ;; This would become %x2 = add %x2, 1
 179   //    br Loop                 ;; %x2 does not dominate all uses
 180   //
 181   // This is because the PHI node input is actually taken from the predecessor
 182   // basic block.  The only case this can happen is with a self loop, so we
 183   // check for this case explicitly now.
 184   //
 185   unsigned max_idx = APN->getNumIncomingValues();
 186   assert(max_idx != 0 && "PHI Node in block with 0 predecessors!?!?!");
 187   if (max_idx == 2) {
 188     BasicBlock *Other = APN->getIncomingBlock(APN->getIncomingBlock(0) == Pred);
 189
 190     // Disable PHI elimination!
 191     if (this == Other) max_idx = 3;
 192   }
 193
 194   // <= Two predecessors BEFORE I remove one?
 195   if (max_idx <= 2 && !DontDeleteUselessPHIs) {
 196     // Yup, loop through and nuke the PHI nodes
 197     while (PHINode *PN = dyn_cast<PHINode>(&front())) {
 198       // Remove the predecessor first.
 199       PN->removeIncomingValue(Pred, !DontDeleteUselessPHIs);
 200
 201       // If the PHI _HAD_ two uses, replace PHI node with its now *single* value
 202       if (max_idx == 2) {
 203         if (PN->getOperand(0) != PN)
 204           PN->replaceAllUsesWith(PN->getOperand(0));
 205         else
 206           // We are left with an infinite loop with no entries: kill the PHI.
 207           PN->replaceAllUsesWith(UndefValue::get(PN->getType()));
 208         getInstList().pop_front();    // Remove the PHI node
 209       }
 210
 211       // If the PHI node already only had one entry, it got deleted by
 212       // removeIncomingValue.
 213     }
 214   } else {
 215     // Okay, now we know that we need to remove predecessor #pred_idx from all
 216     // PHI nodes.  Iterate over each PHI node fixing them up
 217     PHINode *PN;
 218     for (iterator II = begin(); (PN = dyn_cast<PHINode>(II)); ) {
 219       ++II;
 220       PN->removeIncomingValue(Pred, false);
 221       // If all incoming values to the Phi are the same, we can replace the Phi
 222       // with that value.
 223       Value* PNV = 0;
 224       if (!DontDeleteUselessPHIs && (PNV = PN->hasConstantValue())) {
 225         PN->replaceAllUsesWith(PNV);
 226         PN->eraseFromParent();
 227       }
 228     }
 229   }
 230 }
 231
 232
 233 /// splitBasicBlock - This splits a basic block into two at the specified
 234 /// instruction.  Note that all instructions BEFORE the specified iterator stay
 235 /// as part of the original basic block, an unconditional branch is added to
 236 /// the new BB, and the rest of the instructions in the BB are moved to the new
 237 /// BB, including the old terminator.  This invalidates the iterator.
 238 ///
 239 /// Note that this only works on well formed basic blocks (must have a
 240 /// terminator), and 'I' must not be the end of instruction list (which would
 241 /// cause a degenerate basic block to be formed, having a terminator inside of
 242 /// the basic block).
 243 ///
 244 BasicBlock *BasicBlock::splitBasicBlock(iterator I, const std::string &BBName) {
 245   assert(getTerminator() && "Can't use splitBasicBlock on degenerate BB!");
 246   assert(I != InstList.end() &&
 247          "Trying to get me to create degenerate basic block!");
 248
 249   BasicBlock *InsertBefore = next(Function::iterator(this))
 250                                .getNodePtrUnchecked();
 251   BasicBlock *New = BasicBlock::Create(BBName, getParent(), InsertBefore);
 252
 253   // Move all of the specified instructions from the original basic block into
 254   // the new basic block.
 255   New->getInstList().splice(New->end(), this->getInstList(), I, end());
 256
 257   // Add a branch instruction to the newly formed basic block.
 258   BranchInst::Create(New, this);
 259
 260   // Now we must loop through all of the successors of the New block (which
 261   // _were_ the successors of the 'this' block), and update any PHI nodes in
 262   // successors.  If there were PHI nodes in the successors, then they need to
 263   // know that incoming branches will be from New, not from Old.
 264   //
 265   for (succ_iterator I = succ_begin(New), E = succ_end(New); I != E; ++I) {
 266     // Loop over any phi nodes in the basic block, updating the BB field of
 267     // incoming values...
 268     BasicBlock *Successor = *I;
 269     PHINode *PN;
 270     for (BasicBlock::iterator II = Successor->begin();
 271          (PN = dyn_cast<PHINode>(II)); ++II) {
 272       int IDX = PN->getBasicBlockIndex(this);
 273       while (IDX != -1) {
 274         PN->setIncomingBlock((unsigned)IDX, New);
 275         IDX = PN->getBasicBlockIndex(this);
 276       }
 277     }
 278   }
 279   return New;
 280 }