lib/VMCore/BasicBlock.cpp

   1 //===-- BasicBlock.cpp - Implement BasicBlock related methods -------------===//
   2 //
   3 // This file implements the BasicBlock class for the VMCore library.
   4 //
   5 //===----------------------------------------------------------------------===//
   6
   7 #include "llvm/BasicBlock.h"
   8 #include "llvm/iTerminators.h"
   9 #include "llvm/Type.h"
  10 #include "llvm/Support/CFG.h"
  11 #include "llvm/Constant.h"
  12 #include "llvm/iPHINode.h"
  13 #include "llvm/SymbolTable.h"
  14 #include "Support/LeakDetector.h"
  15 #include "SymbolTableListTraitsImpl.h"
  16 #include <algorithm>
  17
  18 // DummyInst - An instance of this class is used to mark the end of the
  19 // instruction list.  This is not a real instruction.
  20 //
  21 struct DummyInst : public Instruction {
  22   DummyInst() : Instruction(Type::VoidTy, NumOtherOps) {
  23     // This should not be garbage monitored.
  24     LeakDetector::removeGarbageObject(this);
  25   }
  26
  27   virtual Instruction *clone() const {
  28     assert(0 && "Cannot clone EOL");abort();
  29     return 0;
  30   }
  31   virtual const char *getOpcodeName() const { return "*end-of-list-inst*"; }
  32
  33   // Methods for support type inquiry through isa, cast, and dyn_cast...
  34   static inline bool classof(const DummyInst *) { return true; }
  35   static inline bool classof(const Instruction *I) {
  36     return I->getOpcode() == NumOtherOps;
  37   }
  38   static inline bool classof(const Value *V) {
  39     return isa<Instruction>(V) && classof(cast<Instruction>(V));
  40   }
  41 };
  42
  43 Instruction *ilist_traits<Instruction>::createNode() {
  44   return new DummyInst();
  45 }
  46 iplist<Instruction> &ilist_traits<Instruction>::getList(BasicBlock *BB) {
  47   return BB->getInstList();
  48 }
  49
  50 // Explicit instantiation of SymbolTableListTraits since some of the methods
  51 // are not in the public header file...
  52 template SymbolTableListTraits<Instruction, BasicBlock, Function>;
  53
  54
  55 // BasicBlock ctor - If the function parameter is specified, the basic block is
  56 // automatically inserted at the end of the function.
  57 //
  58 BasicBlock::BasicBlock(const std::string &name, Function *Parent)
  59   : Value(Type::LabelTy, Value::BasicBlockVal, name) {
  60   // Initialize the instlist...
  61   InstList.setItemParent(this);
  62
  63   // Make sure that we get added to a function
  64   LeakDetector::addGarbageObject(this);
  65
  66   if (Parent)
  67     Parent->getBasicBlockList().push_back(this);
  68 }
  69
  70 BasicBlock::~BasicBlock() {
  71   dropAllReferences();
  72   InstList.clear();
  73 }
  74
  75 void BasicBlock::setParent(Function *parent) {
  76   if (getParent())
  77     LeakDetector::addGarbageObject(this);
  78
  79   InstList.setParent(parent);
  80
  81   if (getParent())
  82     LeakDetector::removeGarbageObject(this);
  83 }
  84
  85 // Specialize setName to take care of symbol table majik
  86 void BasicBlock::setName(const std::string &name, SymbolTable *ST) {
  87   Function *P;
  88   assert((ST == 0 || (!getParent() || ST == getParent()->getSymbolTable())) &&
  89          "Invalid symtab argument!");
  90   if ((P = getParent()) && hasName()) P->getSymbolTable()->remove(this);
  91   Value::setName(name);
  92   if (P && hasName()) P->getSymbolTable()->insert(this);
  93 }
  94
  95 TerminatorInst *BasicBlock::getTerminator() {
  96   if (InstList.empty()) return 0;
  97   return dyn_cast<TerminatorInst>(&InstList.back());
  98 }
  99
 100 const TerminatorInst *const BasicBlock::getTerminator() const {
 101   if (InstList.empty()) return 0;
 102   return dyn_cast<TerminatorInst>(&InstList.back());
 103 }
 104
 105 void BasicBlock::dropAllReferences() {
 106   for(iterator I = begin(), E = end(); I != E; ++I)
 107     I->dropAllReferences();
 108 }
 109
 110 // hasConstantReferences() - This predicate is true if there is a
 111 // reference to this basic block in the constant pool for this method.  For
 112 // example, if a block is reached through a switch table, that table resides
 113 // in the constant pool, and the basic block is reference from it.
 114 //
 115 bool BasicBlock::hasConstantReferences() const {
 116   for (use_const_iterator I = use_begin(), E = use_end(); I != E; ++I)
 117     if (::isa<Constant>((Value*)*I))
 118       return true;
 119
 120   return false;
 121 }
 122
 123 // removePredecessor - This method is used to notify a BasicBlock that the
 124 // specified Predecessor of the block is no longer able to reach it.  This is
 125 // actually not used to update the Predecessor list, but is actually used to
 126 // update the PHI nodes that reside in the block.  Note that this should be
 127 // called while the predecessor still refers to this block.
 128 //
 129 void BasicBlock::removePredecessor(BasicBlock *Pred) {
 130   assert(find(pred_begin(this), pred_end(this), Pred) != pred_end(this) &&
 131          "removePredecessor: BB is not a predecessor!");
 132   if (!isa<PHINode>(front())) return;   // Quick exit.
 133
 134   pred_iterator PI(pred_begin(this)), EI(pred_end(this));
 135   unsigned max_idx;
 136
 137   // Loop over the rest of the predecessors until we run out, or until we find
 138   // out that there are more than 2 predecessors.
 139   for (max_idx = 0; PI != EI && max_idx < 3; ++PI, ++max_idx) /*empty*/;
 140
 141   // If there are exactly two predecessors, then we want to nuke the PHI nodes
 142   // altogether.  We cannot do this, however if this in this case however:
 143   //
 144   //  Loop:
 145   //    %x = phi [X, Loop]
 146   //    %x2 = add %x, 1         ;; This would become %x2 = add %x2, 1
 147   //    br Loop                 ;; %x2 does not dominate all uses
 148   //
 149   // This is because the PHI node input is actually taken from the predecessor
 150   // basic block.  The only case this can happen is with a self loop, so we
 151   // check for this case explicitly now.
 152   //
 153   assert(max_idx != 0 && "PHI Node in block with 0 predecessors!?!?!");
 154   if (max_idx == 2) {
 155     PI = pred_begin(this);
 156     BasicBlock *Other = *PI == Pred ? *++PI : *PI;
 157
 158     // Disable PHI elimination!
 159     if (this == Other) max_idx = 3;
 160   }
 161
 162   if (max_idx <= 2) {                // <= Two predecessors BEFORE I remove one?
 163     // Yup, loop through and nuke the PHI nodes
 164     while (PHINode *PN = dyn_cast<PHINode>(&front())) {
 165       PN->removeIncomingValue(Pred); // Remove the predecessor first...
 166
 167       assert(PN->getNumIncomingValues() == max_idx-1 &&
 168              "PHI node shouldn't have this many values!!!");
 169
 170       // If the PHI _HAD_ two uses, replace PHI node with its now *single* value
 171       if (max_idx == 2)
 172         PN->replaceAllUsesWith(PN->getOperand(0));
 173       else // Otherwise there are no incoming values/edges, replace with dummy
 174         PN->replaceAllUsesWith(Constant::getNullValue(PN->getType()));
 175       getInstList().pop_front();    // Remove the PHI node
 176     }
 177   } else {
 178     // Okay, now we know that we need to remove predecessor #pred_idx from all
 179     // PHI nodes.  Iterate over each PHI node fixing them up
 180     for (iterator II = begin(); PHINode *PN = dyn_cast<PHINode>(&*II); ++II)
 181       PN->removeIncomingValue(Pred);
 182   }
 183 }
 184
 185
 186 // splitBasicBlock - This splits a basic block into two at the specified
 187 // instruction.  Note that all instructions BEFORE the specified iterator stay
 188 // as part of the original basic block, an unconditional branch is added to
 189 // the new BB, and the rest of the instructions in the BB are moved to the new
 190 // BB, including the old terminator.  This invalidates the iterator.
 191 //
 192 // Note that this only works on well formed basic blocks (must have a
 193 // terminator), and 'I' must not be the end of instruction list (which would
 194 // cause a degenerate basic block to be formed, having a terminator inside of
 195 // the basic block).
 196 //
 197 BasicBlock *BasicBlock::splitBasicBlock(iterator I) {
 198   assert(getTerminator() && "Can't use splitBasicBlock on degenerate BB!");
 199   assert(I != InstList.end() &&
 200          "Trying to get me to create degenerate basic block!");
 201
 202   BasicBlock *New = new BasicBlock("", getParent());
 203
 204   // Go from the end of the basic block through to the iterator pointer, moving
 205   // to the new basic block...
 206   Instruction *Inst = 0;
 207   do {
 208     iterator EndIt = end();
 209     Inst = InstList.remove(--EndIt);                  // Remove from end
 210     New->InstList.push_front(Inst);                   // Add to front
 211   } while (Inst != &*I);   // Loop until we move the specified instruction.
 212
 213   // Add a branch instruction to the newly formed basic block.
 214   InstList.push_back(new BranchInst(New));
 215
 216   // Now we must loop through all of the successors of the New block (which
 217   // _were_ the successors of the 'this' block), and update any PHI nodes in
 218   // successors.  If there were PHI nodes in the successors, then they need to
 219   // know that incoming branches will be from New, not from Old.
 220   //
 221   for (BasicBlock::succ_iterator I = succ_begin(New), E = succ_end(New);
 222        I != E; ++I) {
 223     // Loop over any phi nodes in the basic block, updating the BB field of
 224     // incoming values...
 225     BasicBlock *Successor = *I;
 226     for (BasicBlock::iterator II = Successor->begin();
 227          PHINode *PN = dyn_cast<PHINode>(&*II); ++II) {
 228       int IDX = PN->getBasicBlockIndex(this);
 229       while (IDX != -1) {
 230         PN->setIncomingBlock((unsigned)IDX, New);
 231         IDX = PN->getBasicBlockIndex(this);
 232       }
 233     }
 234   }
 235   return New;
 236 }