lib/Transforms/Scalar/PiNodeInsertion.cpp

   1 //===- PiNodeInsertion.cpp - Insert Pi nodes into a program ---------------===//
   2 //
   3 // PiNodeInsertion - This pass inserts single entry Phi nodes into basic blocks
   4 // that are preceeded by a conditional branch, where the branch gives
   5 // information about the operands of the condition.  For example, this C code:
   6 //   if (x == 0) { ... = x + 4;
   7 // becomes:
   8 //   if (x == 0) {
   9 //     x2 = phi(x);    // Node that can hold data flow information about X
  10 //     ... = x2 + 4;
  11 //
  12 // Since the direction of the condition branch gives information about X itself
  13 // (whether or not it is zero), some passes (like value numbering or ABCD) can
  14 // use the inserted Phi/Pi nodes as a place to attach information, in this case
  15 // saying that X has a value of 0 in this scope.  The power of this analysis
  16 // information is that "in the scope" translates to "for all uses of x2".
  17 //
  18 // This special form of Phi node is refered to as a Pi node, following the
  19 // terminology defined in the "Array Bounds Checks on Demand" paper.
  20 //
  21 // As a really trivial example of what the Pi nodes are good for, this pass
  22 // replaces values compared for equality with direct constants with the constant
  23 // itself in the branch it's equal to the constant.  In the case above, it would
  24 // change the body to be "... = 0 + 4;"  Real value numbering can do much more.
  25 //
  26 //===----------------------------------------------------------------------===//
  27
  28 #include "llvm/Transforms/Scalar.h"
  29 #include "llvm/Analysis/Dominators.h"
  30 #include "llvm/Pass.h"
  31 #include "llvm/Function.h"
  32 #include "llvm/BasicBlock.h"
  33 #include "llvm/iTerminators.h"
  34 #include "llvm/iOperators.h"
  35 #include "llvm/iPHINode.h"
  36 #include "llvm/Support/CFG.h"
  37
  38 namespace {
  39   struct PiNodeInserter : public FunctionPass {
  40     const char *getPassName() const { return "Pi Node Insertion"; }
  41
  42     virtual bool runOnFunction(Function *F);
  43
  44     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  45       AU.preservesCFG();
  46       AU.addRequired(DominatorSet::ID);
  47     }
  48
  49     // insertPiNodeFor - Insert a Pi node for V in the successors of BB if our
  50     // conditions hold.  If Rep is not null, fill in a value of 'Rep' instead of
  51     // creating a new Pi node itself because we know that the value is a simple
  52     // constant.
  53     //
  54     bool insertPiNodeFor(Value *V, BasicBlock *BB, Value *Rep = 0);
  55   };
  56 }
  57
  58 Pass *createPiNodeInsertionPass() { return new PiNodeInserter(); }
  59
  60
  61 bool PiNodeInserter::runOnFunction(Function *F) {
  62   bool Changed = false;
  63   for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I) {
  64     BasicBlock *BB = *I;
  65     TerminatorInst *TI = BB->getTerminator();
  66
  67     // FIXME: Insert PI nodes for switch statements too
  68
  69     // Look for conditional branch instructions... that branch on a setcc test
  70     if (BranchInst *BI = dyn_cast<BranchInst>(TI))
  71       if (BI->isConditional())
  72         // TODO: we could in theory support logical operations here too...
  73         if (SetCondInst *SCI = dyn_cast<SetCondInst>(BI->getCondition())) {
  74           // Calculate replacement values if this is an obvious constant == or
  75           // != comparison...
  76           Value *TrueRep = 0, *FalseRep = 0;
  77
  78           // Make sure the the constant is the second operand if there is one...
  79           // This fits with our cannonicalization patterns used elsewhere in the
  80           // compiler, without depending on instcombine running before us.
  81           //
  82           if (isa<Constant>(SCI->getOperand(0)) &&
  83               !isa<Constant>(SCI->getOperand(1))) {
  84             SCI->swapOperands();
  85             Changed = true;
  86           }
  87
  88           if (isa<Constant>(SCI->getOperand(1))) {
  89             if (SCI->getOpcode() == Instruction::SetEQ)
  90               TrueRep = SCI->getOperand(1);
  91             else if (SCI->getOpcode() == Instruction::SetNE)
  92               FalseRep = SCI->getOperand(1);
  93           }
  94
  95           BasicBlock *TB = BI->getSuccessor(0);  // True block
  96           BasicBlock *FB = BI->getSuccessor(1);  // False block
  97
  98           // Insert the Pi nodes for the first operand to the comparison...
  99           Changed |= insertPiNodeFor(SCI->getOperand(0), TB, TrueRep);
 100           Changed |= insertPiNodeFor(SCI->getOperand(0), FB, FalseRep);
 101
 102           // Insert the Pi nodes for the second operand to the comparison...
 103           Changed |= insertPiNodeFor(SCI->getOperand(1), TB);
 104           Changed |= insertPiNodeFor(SCI->getOperand(1), FB);
 105         }
 106   }
 107
 108   return Changed;
 109 }
 110
 111
 112 // alreadyHasPiNodeFor - Return true if there is already a Pi node in BB for
 113 // V.
 114 static bool alreadyHasPiNodeFor(Value *V, BasicBlock *BB) {
 115   for (Value::use_iterator I = V->use_begin(), E = V->use_end(); I != E; ++I)
 116     if (PHINode *PN = dyn_cast<PHINode>(*I))
 117       if (PN->getParent() == BB)
 118         return true;
 119   return false;
 120 }
 121
 122
 123 // insertPiNodeFor - Insert a Pi node for V in the successors of BB if our
 124 // conditions hold.  If Rep is not null, fill in a value of 'Rep' instead of
 125 // creating a new Pi node itself because we know that the value is a simple
 126 // constant.
 127 //
 128 bool PiNodeInserter::insertPiNodeFor(Value *V, BasicBlock *Succ, Value *Rep) {
 129   // Do not insert Pi nodes for constants!
 130   if (isa<Constant>(V)) return false;
 131
 132   // Check to make sure that there is not already a PI node inserted...
 133   if (alreadyHasPiNodeFor(V, Succ) && Rep == 0)
 134     return false;
 135
 136   // Insert Pi nodes only into successors that the conditional branch dominates.
 137   // In this simple case, we know that BB dominates a successor as long there
 138   // are no other incoming edges to the successor.
 139   //
 140
 141   // Check to make sure that the successor only has a single predecessor...
 142   pred_iterator PI = pred_begin(Succ);
 143   BasicBlock *Pred = *PI;
 144   if (++PI != pred_end(Succ)) return false;   // Multiple predecessor?  Bail...
 145
 146   // It seems to be safe to insert the Pi node.  Do so now...
 147
 148   // Create the Pi node...
 149   Value *Pi = Rep;
 150   if (Rep == 0) {
 151     PHINode *Phi = new PHINode(V->getType(), V->getName() + ".pi");
 152
 153     // Insert the Pi node in the successor basic block...
 154     Succ->getInstList().push_front(Phi);
 155     Pi = Phi;
 156   }
 157
 158   // Loop over all of the uses of V, replacing ones that the Pi node
 159   // dominates with references to the Pi node itself.
 160   //
 161   DominatorSet &DS = getAnalysis<DominatorSet>();
 162   for (unsigned i = 0; i < V->use_size(); ) {
 163     if (Instruction *U = dyn_cast<Instruction>(*(V->use_begin()+i)))
 164       if (U->getParent()->getParent() == Succ->getParent() &&
 165           DS.dominates(Succ, U->getParent())) {
 166         // This instruction is dominated by the Pi node, replace reference to V
 167         // with a reference to the Pi node.
 168         //
 169         U->replaceUsesOfWith(V, Pi);
 170         continue;           // Do not skip the next use...
 171       }
 172
 173     // This use is not dominated by the Pi node, skip it...
 174     ++i;
 175   }
 176
 177   // Set up the incoming value for the Pi node... do this after uses have been
 178   // replaced, because we don't want the Pi node to refer to itself.
 179   //
 180   if (Rep == 0)
 181     cast<PHINode>(Pi)->addIncoming(V, Pred);
 182
 183   return true;
 184 }
 185