include/llvm/Analysis/ScalarEvolutionExpander.h

   1 //===---- llvm/Analysis/ScalarEvolutionExpander.h - SCEV Exprs --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the classes used to generate code from scalar expressions.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ANALYSIS_SCALAREVOLUTION_EXPANDER_H
  15 #define LLVM_ANALYSIS_SCALAREVOLUTION_EXPANDER_H
  16
  17 #include "llvm/BasicBlock.h"
  18 #include "llvm/Constants.h"
  19 #include "llvm/Instructions.h"
  20 #include "llvm/Type.h"
  21 #include "llvm/Analysis/ScalarEvolution.h"
  22 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
  23 #include "llvm/Support/CFG.h"
  24
  25 namespace llvm {
  26   /// SCEVExpander - This class uses information about analyze scalars to
  27   /// rewrite expressions in canonical form.
  28   ///
  29   /// Clients should create an instance of this class when rewriting is needed,
  30   /// and destroying it when finished to allow the release of the associated
  31   /// memory.
  32   struct SCEVExpander : public SCEVVisitor<SCEVExpander, Value*> {
  33     ScalarEvolution &SE;
  34     LoopInfo &LI;
  35     std::map<SCEVHandle, Value*> InsertedExpressions;
  36     std::set<Instruction*> InsertedInstructions;
  37
  38     Instruction *InsertPt;
  39
  40     friend struct SCEVVisitor<SCEVExpander, Value*>;
  41   public:
  42     SCEVExpander(ScalarEvolution &se, LoopInfo &li) : SE(se), LI(li) {}
  43
  44     LoopInfo &getLoopInfo() const { return LI; }
  45
  46     /// clear - Erase the contents of the InsertedExpressions map so that users
  47     /// trying to expand the same expression into multiple BasicBlocks or
  48     /// different places within the same BasicBlock can do so.
  49     void clear() { InsertedExpressions.clear(); }
  50
  51     /// isInsertedInstruction - Return true if the specified instruction was
  52     /// inserted by the code rewriter.  If so, the client should not modify the
  53     /// instruction.
  54     bool isInsertedInstruction(Instruction *I) const {
  55       return InsertedInstructions.count(I);
  56     }
  57
  58     /// getOrInsertCanonicalInductionVariable - This method returns the
  59     /// canonical induction variable of the specified type for the specified
  60     /// loop (inserting one if there is none).  A canonical induction variable
  61     /// starts at zero and steps by one on each iteration.
  62     Value *getOrInsertCanonicalInductionVariable(const Loop *L, const Type *Ty){
  63       assert((Ty->isInteger() || Ty->isFloatingPoint()) &&
  64              "Can only insert integer or floating point induction variables!");
  65       SCEVHandle H = SCEVAddRecExpr::get(SCEVUnknown::getIntegerSCEV(0, Ty),
  66                                          SCEVUnknown::getIntegerSCEV(1, Ty), L);
  67       return expand(H);
  68     }
  69
  70     /// addInsertedValue - Remember the specified instruction as being the
  71     /// canonical form for the specified SCEV.
  72     void addInsertedValue(Instruction *I, SCEV *S) {
  73       InsertedExpressions[S] = (Value*)I;
  74       InsertedInstructions.insert(I);
  75     }
  76
  77     /// expandCodeFor - Insert code to directly compute the specified SCEV
  78     /// expression into the program.  The inserted code is inserted into the
  79     /// specified block.
  80     ///
  81     /// If a particular value sign is required, a type may be specified for the
  82     /// result.
  83     Value *expandCodeFor(SCEVHandle SH, Instruction *IP, const Type *Ty = 0) {
  84       // Expand the code for this SCEV.
  85       this->InsertPt = IP;
  86       return expandInTy(SH, Ty);
  87     }
  88
  89     /// InsertCastOfTo - Insert a cast of V to the specified type, doing what
  90     /// we can to share the casts.
  91     static Value *InsertCastOfTo(Value *V, const Type *Ty);
  92
  93   protected:
  94     Value *expand(SCEV *S) {
  95       // Check to see if we already expanded this.
  96       std::map<SCEVHandle, Value*>::iterator I = InsertedExpressions.find(S);
  97       if (I != InsertedExpressions.end())
  98         return I->second;
  99
 100       Value *V = visit(S);
 101       InsertedExpressions[S] = V;
 102       return V;
 103     }
 104
 105     Value *expandInTy(SCEV *S, const Type *Ty) {
 106       Value *V = expand(S);
 107       if (Ty && V->getType() != Ty)
 108         return InsertCastOfTo(V, Ty);
 109       return V;
 110     }
 111
 112     Value *visitConstant(SCEVConstant *S) {
 113       return S->getValue();
 114     }
 115
 116     Value *visitTruncateExpr(SCEVTruncateExpr *S) {
 117       Value *V = expand(S->getOperand());
 118       return new CastInst(V, S->getType(), "tmp.", InsertPt);
 119     }
 120
 121     Value *visitZeroExtendExpr(SCEVZeroExtendExpr *S) {
 122       Value *V = expandInTy(S->getOperand(),S->getType()->getUnsignedVersion());
 123       return new CastInst(V, S->getType(), "tmp.", InsertPt);
 124     }
 125
 126     Value *visitAddExpr(SCEVAddExpr *S) {
 127       const Type *Ty = S->getType();
 128       Value *V = expandInTy(S->getOperand(S->getNumOperands()-1), Ty);
 129
 130       // Emit a bunch of add instructions
 131       for (int i = S->getNumOperands()-2; i >= 0; --i)
 132         V = BinaryOperator::createAdd(V, expandInTy(S->getOperand(i), Ty),
 133                                       "tmp.", InsertPt);
 134       return V;
 135     }
 136
 137     Value *visitMulExpr(SCEVMulExpr *S);
 138
 139     Value *visitUDivExpr(SCEVUDivExpr *S) {
 140       const Type *Ty = S->getType();
 141       Value *LHS = expandInTy(S->getLHS(), Ty);
 142       Value *RHS = expandInTy(S->getRHS(), Ty);
 143       return BinaryOperator::createDiv(LHS, RHS, "tmp.", InsertPt);
 144     }
 145
 146     Value *visitAddRecExpr(SCEVAddRecExpr *S);
 147
 148     Value *visitUnknown(SCEVUnknown *S) {
 149       return S->getValue();
 150     }
 151   };
 152 }
 153
 154 #endif
 155