lib/Transforms/Scalar/IndVarSimplify.cpp

   1 //===- IndVarSimplify.cpp - Induction Variable Elimination ----------------===//
   2 //
   3 // InductionVariableSimplify - Transform induction variables in a program
   4 //   to all use a single cannonical induction variable per loop.
   5 //
   6 //===----------------------------------------------------------------------===//
   7
   8 #include "llvm/Transforms/Scalar.h"
   9 #include "llvm/Analysis/InductionVariable.h"
  10 #include "llvm/Analysis/LoopInfo.h"
  11 #include "llvm/Analysis/Writer.h"
  12 #include "llvm/iPHINode.h"
  13 #include "llvm/iOther.h"
  14 #include "llvm/Type.h"
  15 #include "llvm/Constants.h"
  16 #include "llvm/Support/CFG.h"
  17 #include "Support/STLExtras.h"
  18 #include "Support/StatisticReporter.h"
  19
  20 static Statistic<> NumRemoved ("indvars\t\t- Number of aux indvars removed");
  21 static Statistic<> NumInserted("indvars\t\t- Number of cannonical indvars added");
  22
  23
  24 // InsertCast - Cast Val to Ty, setting a useful name on the cast if Val has a
  25 // name...
  26 //
  27 static Instruction *InsertCast(Instruction *Val, const Type *Ty,
  28                                BasicBlock::iterator It) {
  29   Instruction *Cast = new CastInst(Val, Ty);
  30   if (Val->hasName()) Cast->setName(Val->getName()+"-casted");
  31   Val->getParent()->getInstList().insert(It, Cast);
  32   return Cast;
  33 }
  34
  35 static bool TransformLoop(LoopInfo *Loops, Loop *Loop) {
  36   // Transform all subloops before this loop...
  37   bool Changed = reduce_apply_bool(Loop->getSubLoops().begin(),
  38                                    Loop->getSubLoops().end(),
  39                               std::bind1st(std::ptr_fun(TransformLoop), Loops));
  40   // Get the header node for this loop.  All of the phi nodes that could be
  41   // induction variables must live in this basic block.
  42   //
  43   BasicBlock *Header = Loop->getBlocks().front();
  44
  45   // Loop over all of the PHI nodes in the basic block, calculating the
  46   // induction variables that they represent... stuffing the induction variable
  47   // info into a vector...
  48   //
  49   std::vector<InductionVariable> IndVars;    // Induction variables for block
  50   BasicBlock::iterator AfterPHIIt = Header->begin();
  51   for (; PHINode *PN = dyn_cast<PHINode>(&*AfterPHIIt); ++AfterPHIIt)
  52     IndVars.push_back(InductionVariable(PN, Loops));
  53   // AfterPHIIt now points to first nonphi instruction...
  54
  55   // If there are no phi nodes in this basic block, there can't be indvars...
  56   if (IndVars.empty()) return Changed;
  57
  58   // Loop over the induction variables, looking for a cannonical induction
  59   // variable, and checking to make sure they are not all unknown induction
  60   // variables.
  61   //
  62   bool FoundIndVars = false;
  63   InductionVariable *Cannonical = 0;
  64   for (unsigned i = 0; i < IndVars.size(); ++i) {
  65     if (IndVars[i].InductionType == InductionVariable::Cannonical)
  66       Cannonical = &IndVars[i];
  67     if (IndVars[i].InductionType != InductionVariable::Unknown)
  68       FoundIndVars = true;
  69   }
  70
  71   // No induction variables, bail early... don't add a cannonnical indvar
  72   if (!FoundIndVars) return Changed;
  73
  74   // Okay, we want to convert other induction variables to use a cannonical
  75   // indvar.  If we don't have one, add one now...
  76   if (!Cannonical) {
  77     // Create the PHI node for the new induction variable
  78     PHINode *PN = new PHINode(Type::UIntTy, "cann-indvar");
  79
  80     // Insert the phi node at the end of the other phi nodes...
  81     AfterPHIIt = ++Header->getInstList().insert(AfterPHIIt, PN);
  82
  83     // Create the increment instruction to add one to the counter...
  84     Instruction *Add = BinaryOperator::create(Instruction::Add, PN,
  85                                               ConstantUInt::get(Type::UIntTy,1),
  86                                               "add1-indvar");
  87
  88     // Insert the add instruction after all of the PHI nodes...
  89     Header->getInstList().insert(AfterPHIIt, Add);
  90
  91     // Figure out which block is incoming and which is the backedge for the loop
  92     BasicBlock *Incoming, *BackEdgeBlock;
  93     pred_iterator PI = pred_begin(Header);
  94     assert(PI != pred_end(Header) && "Loop headers should have 2 preds!");
  95     if (Loop->contains(*PI)) {  // First pred is back edge...
  96       BackEdgeBlock = *PI++;
  97       Incoming      = *PI++;
  98     } else {
  99       Incoming      = *PI++;
 100       BackEdgeBlock = *PI++;
 101     }
 102     assert(PI == pred_end(Header) && "Loop headers should have 2 preds!");
 103
 104     // Add incoming values for the PHI node...
 105     PN->addIncoming(Constant::getNullValue(Type::UIntTy), Incoming);
 106     PN->addIncoming(Add, BackEdgeBlock);
 107
 108     // Analyze the new induction variable...
 109     IndVars.push_back(InductionVariable(PN, Loops));
 110     assert(IndVars.back().InductionType == InductionVariable::Cannonical &&
 111            "Just inserted cannonical indvar that is not cannonical!");
 112     Cannonical = &IndVars.back();
 113     ++NumInserted;
 114     Changed = true;
 115   }
 116
 117   DEBUG(std::cerr << "Induction variables:\n");
 118
 119   // Get the current loop iteration count, which is always the value of the
 120   // cannonical phi node...
 121   //
 122   PHINode *IterCount = Cannonical->Phi;
 123
 124   // Loop through and replace all of the auxillary induction variables with
 125   // references to the primary induction variable...
 126   //
 127   for (unsigned i = 0; i < IndVars.size(); ++i) {
 128     InductionVariable *IV = &IndVars[i];
 129
 130     DEBUG(std::cerr << IV);
 131
 132     // Don't modify the cannonical indvar or unrecognized indvars...
 133     if (IV != Cannonical && IV->InductionType != InductionVariable::Unknown) {
 134       Instruction *Val = IterCount;
 135       if (!isa<ConstantInt>(IV->Step) ||   // If the step != 1
 136           !cast<ConstantInt>(IV->Step)->equalsInt(1)) {
 137         std::string Name;   // Create a scale by the step value...
 138         if (IV->Phi->hasName()) Name = IV->Phi->getName()+"-scale";
 139
 140         // If the types are not compatible, insert a cast now...
 141         if (Val->getType() != IV->Step->getType())
 142           Val = InsertCast(Val, IV->Step->getType(), AfterPHIIt);
 143
 144         Val = BinaryOperator::create(Instruction::Mul, Val, IV->Step, Name);
 145         // Insert the phi node at the end of the other phi nodes...
 146         Header->getInstList().insert(AfterPHIIt, Val);
 147       }
 148
 149       if (!isa<Constant>(IV->Start) ||   // If the start != 0
 150           !cast<Constant>(IV->Start)->isNullValue()) {
 151         std::string Name;   // Create a offset by the start value...
 152         if (IV->Phi->hasName()) Name = IV->Phi->getName()+"-offset";
 153
 154         // If the types are not compatible, insert a cast now...
 155         if (Val->getType() != IV->Start->getType())
 156           Val = InsertCast(Val, IV->Start->getType(), AfterPHIIt);
 157
 158         Val = BinaryOperator::create(Instruction::Add, Val, IV->Start, Name);
 159         // Insert the phi node at the end of the other phi nodes...
 160         Header->getInstList().insert(AfterPHIIt, Val);
 161       }
 162
 163       // If the PHI node has a different type than val is, insert a cast now...
 164       if (Val->getType() != IV->Phi->getType())
 165         Val = InsertCast(Val, IV->Phi->getType(), AfterPHIIt);
 166
 167       // Replace all uses of the old PHI node with the new computed value...
 168       IV->Phi->replaceAllUsesWith(Val);
 169
 170       // Move the PHI name to it's new equivalent value...
 171       std::string OldName = IV->Phi->getName();
 172       IV->Phi->setName("");
 173       Val->setName(OldName);
 174
 175       // Delete the old, now unused, phi node...
 176       Header->getInstList().erase(IV->Phi);
 177       Changed = true;
 178       ++NumRemoved;
 179     }
 180   }
 181
 182   return Changed;
 183 }
 184
 185 namespace {
 186   struct InductionVariableSimplify : public FunctionPass {
 187     virtual bool runOnFunction(Function &) {
 188       LoopInfo &LI = getAnalysis<LoopInfo>();
 189
 190       // Induction Variables live in the header nodes of loops
 191       return reduce_apply_bool(LI.getTopLevelLoops().begin(),
 192                                LI.getTopLevelLoops().end(),
 193                                std::bind1st(std::ptr_fun(TransformLoop), &LI));
 194     }
 195
 196     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 197       AU.addRequired(LoopInfo::ID);
 198       AU.preservesCFG();
 199     }
 200   };
 201   RegisterOpt<InductionVariableSimplify> X("indvars",
 202                                            "Cannonicalize Induction Variables");
 203 }
 204
 205 Pass *createIndVarSimplifyPass() {
 206   return new InductionVariableSimplify();
 207 }