lib/Transforms/Utils/LCSSA.cpp

   1 //===-- LCSSA.cpp - Convert loops into loop-closed SSA form ---------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Owen Anderson and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This pass transforms loops by placing phi nodes at the end of the loops for
  11 // all values that are live across the loop boundary.  For example, it turns
  12 // the left into the right code:
  13 //
  14 // for (...)                for (...)
  15 //   if (c)                   if (c)
  16 //     X1 = ...                 X1 = ...
  17 //   else                     else
  18 //     X2 = ...                 X2 = ...
  19 //   X3 = phi(X1, X2)         X3 = phi(X1, X2)
  20 // ... = X3 + 4              X4 = phi(X3)
  21 //                           ... = X4 + 4
  22 //
  23 // This is still valid LLVM; the extra phi nodes are purely redundant, and will
  24 // be trivially eliminated by InstCombine.  The major benefit of this
  25 // transformation is that it makes many other loop optimizations, such as
  26 // LoopUnswitching, simpler.
  27 //
  28 //===----------------------------------------------------------------------===//
  29
  30 #define DEBUG_TYPE "lcssa"
  31 #include "llvm/Transforms/Scalar.h"
  32 #include "llvm/Constants.h"
  33 #include "llvm/Pass.h"
  34 #include "llvm/Function.h"
  35 #include "llvm/Instructions.h"
  36 #include "llvm/ADT/SetVector.h"
  37 #include "llvm/ADT/Statistic.h"
  38 #include "llvm/Analysis/Dominators.h"
  39 #include "llvm/Analysis/LoopPass.h"
  40 #include "llvm/Analysis/ScalarEvolution.h"
  41 #include "llvm/Support/CFG.h"
  42 #include "llvm/Support/Compiler.h"
  43 #include <algorithm>
  44 #include <map>
  45 using namespace llvm;
  46
  47 STATISTIC(NumLCSSA, "Number of live out of a loop variables");
  48
  49 namespace {
  50   struct VISIBILITY_HIDDEN LCSSA : public LoopPass {
  51     static char ID; // Pass identification, replacement for typeid
  52     LCSSA() : LoopPass((intptr_t)&ID) {}
  53
  54     // Cached analysis information for the current function.
  55     LoopInfo *LI;
  56     DominatorTree *DT;
  57     std::vector<BasicBlock*> LoopBlocks;
  58
  59     virtual bool runOnLoop(Loop *L, LPPassManager &LPM);
  60
  61     void ProcessInstruction(Instruction* Instr,
  62                             const std::vector<BasicBlock*>& exitBlocks);
  63
  64     /// This transformation requires natural loop information & requires that
  65     /// loop preheaders be inserted into the CFG.  It maintains both of these,
  66     /// as well as the CFG.  It also requires dominator information.
  67     ///
  68     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  69       AU.setPreservesCFG();
  70       AU.addRequiredID(LoopSimplifyID);
  71       AU.addPreservedID(LoopSimplifyID);
  72       AU.addRequired<LoopInfo>();
  73       AU.addPreserved<LoopInfo>();
  74       AU.addRequired<DominatorTree>();
  75       AU.addPreserved<ScalarEvolution>();
  76       AU.addPreserved<DominatorTree>();
  77
  78       // Request DominanceFrontier now, even though LCSSA does
  79       // not use it. This allows Pass Manager to schedule Dominance
  80       // Frontier early enough such that one LPPassManager can handle
  81       // multiple loop transformation passes.
  82       AU.addRequired<DominanceFrontier>();
  83       AU.addPreserved<DominanceFrontier>();
  84     }
  85   private:
  86     void getLoopValuesUsedOutsideLoop(Loop *L,
  87                                       SetVector<Instruction*> &AffectedValues);
  88
  89     Value *GetValueForBlock(DomTreeNode *BB, Instruction *OrigInst,
  90                             std::map<DomTreeNode*, Value*> &Phis);
  91
  92     /// inLoop - returns true if the given block is within the current loop
  93     const bool inLoop(BasicBlock* B) {
  94       return std::binary_search(LoopBlocks.begin(), LoopBlocks.end(), B);
  95     }
  96   };
  97
  98   char LCSSA::ID = 0;
  99   RegisterPass<LCSSA> X("lcssa", "Loop-Closed SSA Form Pass");
 100 }
 101
 102 LoopPass *llvm::createLCSSAPass() { return new LCSSA(); }
 103 const PassInfo *llvm::LCSSAID = X.getPassInfo();
 104
 105 /// runOnFunction - Process all loops in the function, inner-most out.
 106 bool LCSSA::runOnLoop(Loop *L, LPPassManager &LPM) {
 107
 108   LI = &LPM.getAnalysis<LoopInfo>();
 109   DT = &getAnalysis<DominatorTree>();
 110   DominanceFrontier *DF = getAnalysisToUpdate<DominanceFrontier>();
 111
 112   // Speed up queries by creating a sorted list of blocks
 113   LoopBlocks.clear();
 114   LoopBlocks.insert(LoopBlocks.end(), L->block_begin(), L->block_end());
 115   std::sort(LoopBlocks.begin(), LoopBlocks.end());
 116
 117   SetVector<Instruction*> AffectedValues;
 118   getLoopValuesUsedOutsideLoop(L, AffectedValues);
 119
 120   // If no values are affected, we can save a lot of work, since we know that
 121   // nothing will be changed.
 122   if (AffectedValues.empty())
 123     return false;
 124
 125   std::vector<BasicBlock*> exitBlocks;
 126   L->getExitBlocks(exitBlocks);
 127
 128
 129   // Iterate over all affected values for this loop and insert Phi nodes
 130   // for them in the appropriate exit blocks
 131
 132   for (SetVector<Instruction*>::iterator I = AffectedValues.begin(),
 133        E = AffectedValues.end(); I != E; ++I)
 134     ProcessInstruction(*I, exitBlocks);
 135
 136   assert(L->isLCSSAForm());
 137
 138   return true;
 139 }
 140
 141 /// processInstruction - Given a live-out instruction, insert LCSSA Phi nodes,
 142 /// eliminate all out-of-loop uses.
 143 void LCSSA::ProcessInstruction(Instruction *Instr,
 144                                const std::vector<BasicBlock*>& exitBlocks) {
 145   ++NumLCSSA; // We are applying the transformation
 146
 147   // Keep track of the blocks that have the value available already.
 148   std::map<DomTreeNode*, Value*> Phis;
 149
 150   DomTreeNode *InstrNode = DT->getNode(Instr->getParent());
 151
 152   // Insert the LCSSA phi's into the exit blocks (dominated by the value), and
 153   // add them to the Phi's map.
 154   for (std::vector<BasicBlock*>::const_iterator BBI = exitBlocks.begin(),
 155       BBE = exitBlocks.end(); BBI != BBE; ++BBI) {
 156     BasicBlock *BB = *BBI;
 157     DomTreeNode *ExitBBNode = DT->getNode(BB);
 158     Value *&Phi = Phis[ExitBBNode];
 159     if (!Phi && DT->dominates(InstrNode, ExitBBNode)) {
 160       PHINode *PN = new PHINode(Instr->getType(), Instr->getName()+".lcssa",
 161                                 BB->begin());
 162       PN->reserveOperandSpace(std::distance(pred_begin(BB), pred_end(BB)));
 163
 164       // Remember that this phi makes the value alive in this block.
 165       Phi = PN;
 166
 167       // Add inputs from inside the loop for this PHI.
 168       for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
 169         PN->addIncoming(Instr, *PI);
 170     }
 171   }
 172
 173
 174   // Record all uses of Instr outside the loop.  We need to rewrite these.  The
 175   // LCSSA phis won't be included because they use the value in the loop.
 176   for (Value::use_iterator UI = Instr->use_begin(), E = Instr->use_end();
 177        UI != E;) {
 178     BasicBlock *UserBB = cast<Instruction>(*UI)->getParent();
 179     if (PHINode *P = dyn_cast<PHINode>(*UI)) {
 180       unsigned OperandNo = UI.getOperandNo();
 181       UserBB = P->getIncomingBlock(OperandNo/2);
 182     }
 183
 184     // If the user is in the loop, don't rewrite it!
 185     if (UserBB == Instr->getParent() || inLoop(UserBB)) {
 186       ++UI;
 187       continue;
 188     }
 189
 190     // Otherwise, patch up uses of the value with the appropriate LCSSA Phi,
 191     // inserting PHI nodes into join points where needed.
 192     Value *Val = GetValueForBlock(DT->getNode(UserBB), Instr, Phis);
 193
 194     // Preincrement the iterator to avoid invalidating it when we change the
 195     // value.
 196     Use &U = UI.getUse();
 197     ++UI;
 198     U.set(Val);
 199   }
 200 }
 201
 202 /// getLoopValuesUsedOutsideLoop - Return any values defined in the loop that
 203 /// are used by instructions outside of it.
 204 void LCSSA::getLoopValuesUsedOutsideLoop(Loop *L,
 205                                       SetVector<Instruction*> &AffectedValues) {
 206   // FIXME: For large loops, we may be able to avoid a lot of use-scanning
 207   // by using dominance information.  In particular, if a block does not
 208   // dominate any of the loop exits, then none of the values defined in the
 209   // block could be used outside the loop.
 210   for (Loop::block_iterator BB = L->block_begin(), E = L->block_end();
 211        BB != E; ++BB) {
 212     for (BasicBlock::iterator I = (*BB)->begin(), E = (*BB)->end(); I != E; ++I)
 213       for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI != E;
 214            ++UI) {
 215         BasicBlock *UserBB = cast<Instruction>(*UI)->getParent();
 216         if (PHINode* p = dyn_cast<PHINode>(*UI)) {
 217           unsigned OperandNo = UI.getOperandNo();
 218           UserBB = p->getIncomingBlock(OperandNo/2);
 219         }
 220
 221         if (*BB != UserBB && !inLoop(UserBB)) {
 222           AffectedValues.insert(I);
 223           break;
 224         }
 225       }
 226   }
 227 }
 228
 229 /// GetValueForBlock - Get the value to use within the specified basic block.
 230 /// available values are in Phis.
 231 Value *LCSSA::GetValueForBlock(DomTreeNode *BB, Instruction *OrigInst,
 232                                std::map<DomTreeNode*, Value*> &Phis) {
 233   // If there is no dominator info for this BB, it is unreachable.
 234   if (BB == 0)
 235     return UndefValue::get(OrigInst->getType());
 236
 237   // If we have already computed this value, return the previously computed val.
 238   Value *&V = Phis[BB];
 239   if (V) return V;
 240
 241   DomTreeNode *IDom = BB->getIDom();
 242
 243   // Otherwise, there are two cases: we either have to insert a PHI node or we
 244   // don't.  We need to insert a PHI node if this block is not dominated by one
 245   // of the exit nodes from the loop (the loop could have multiple exits, and
 246   // though the value defined *inside* the loop dominated all its uses, each
 247   // exit by itself may not dominate all the uses).
 248   //
 249   // The simplest way to check for this condition is by checking to see if the
 250   // idom is in the loop.  If so, we *know* that none of the exit blocks
 251   // dominate this block.  Note that we *know* that the block defining the
 252   // original instruction is in the idom chain, because if it weren't, then the
 253   // original value didn't dominate this use.
 254   if (!inLoop(IDom->getBlock())) {
 255     // Idom is not in the loop, we must still be "below" the exit block and must
 256     // be fully dominated by the value live in the idom.
 257     return V = GetValueForBlock(IDom, OrigInst, Phis);
 258   }
 259
 260   BasicBlock *BBN = BB->getBlock();
 261
 262   // Otherwise, the idom is the loop, so we need to insert a PHI node.  Do so
 263   // now, then get values to fill in the incoming values for the PHI.
 264   PHINode *PN = new PHINode(OrigInst->getType(), OrigInst->getName()+".lcssa",
 265                             BBN->begin());
 266   PN->reserveOperandSpace(std::distance(pred_begin(BBN), pred_end(BBN)));
 267   V = PN;
 268
 269   // Fill in the incoming values for the block.
 270   for (pred_iterator PI = pred_begin(BBN), E = pred_end(BBN); PI != E; ++PI)
 271     PN->addIncoming(GetValueForBlock(DT->getNode(*PI), OrigInst, Phis), *PI);
 272   return PN;
 273 }
 274