include/llvm/Analysis/ScalarEvolutionExpander.h

   1 //===---- llvm/Analysis/ScalarEvolutionExpander.h - SCEV Exprs --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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/Analysis/ScalarEvolutionExpressions.h"
  18 #include "llvm/Analysis/ScalarEvolutionNormalization.h"
  19 #include "llvm/Support/IRBuilder.h"
  20 #include "llvm/Support/TargetFolder.h"
  21 #include "llvm/Support/ValueHandle.h"
  22 #include <set>
  23
  24 namespace llvm {
  25   class TargetLowering;
  26
  27   /// SCEVExpander - This class uses information about analyze scalars to
  28   /// rewrite expressions in canonical form.
  29   ///
  30   /// Clients should create an instance of this class when rewriting is needed,
  31   /// and destroy it when finished to allow the release of the associated
  32   /// memory.
  33   class SCEVExpander : public SCEVVisitor<SCEVExpander, Value*> {
  34     ScalarEvolution &SE;
  35
  36     // New instructions receive a name to identifies them with the current pass.
  37     const char* IVName;
  38
  39     std::map<std::pair<const SCEV *, Instruction *>, AssertingVH<Value> >
  40       InsertedExpressions;
  41     std::set<AssertingVH<Value> > InsertedValues;
  42     std::set<AssertingVH<Value> > InsertedPostIncValues;
  43
  44     /// RelevantLoops - A memoization of the "relevant" loop for a given SCEV.
  45     DenseMap<const SCEV *, const Loop *> RelevantLoops;
  46
  47     /// PostIncLoops - Addrecs referring to any of the given loops are expanded
  48     /// in post-inc mode. For example, expanding {1,+,1}<L> in post-inc mode
  49     /// returns the add instruction that adds one to the phi for {0,+,1}<L>,
  50     /// as opposed to a new phi starting at 1. This is only supported in
  51     /// non-canonical mode.
  52     PostIncLoopSet PostIncLoops;
  53
  54     /// IVIncInsertPos - When this is non-null, addrecs expanded in the
  55     /// loop it indicates should be inserted with increments at
  56     /// IVIncInsertPos.
  57     const Loop *IVIncInsertLoop;
  58
  59     /// IVIncInsertPos - When expanding addrecs in the IVIncInsertLoop loop,
  60     /// insert the IV increment at this position.
  61     Instruction *IVIncInsertPos;
  62
  63     /// CanonicalMode - When true, expressions are expanded in "canonical"
  64     /// form. In particular, addrecs are expanded as arithmetic based on
  65     /// a canonical induction variable. When false, expression are expanded
  66     /// in a more literal form.
  67     bool CanonicalMode;
  68
  69     /// When invoked from LSR, the expander is in "strength reduction" mode. The
  70     /// only difference is that phi's are only reused if they are already in
  71     /// "expanded" form.
  72     bool LSRMode;
  73
  74     typedef IRBuilder<true, TargetFolder> BuilderType;
  75     BuilderType Builder;
  76
  77 #ifndef NDEBUG
  78     const char *DebugType;
  79 #endif
  80
  81     friend struct SCEVVisitor<SCEVExpander, Value*>;
  82
  83   public:
  84     /// SCEVExpander - Construct a SCEVExpander in "canonical" mode.
  85     explicit SCEVExpander(ScalarEvolution &se, const char *name)
  86       : SE(se), IVName(name), IVIncInsertLoop(0), IVIncInsertPos(0),
  87         CanonicalMode(true), LSRMode(false),
  88         Builder(se.getContext(), TargetFolder(se.TD)) {
  89 #ifndef NDEBUG
  90       DebugType = "";
  91 #endif
  92     }
  93
  94 #ifndef NDEBUG
  95     void setDebugType(const char* s) { DebugType = s; }
  96 #endif
  97
  98     /// clear - Erase the contents of the InsertedExpressions map so that users
  99     /// trying to expand the same expression into multiple BasicBlocks or
 100     /// different places within the same BasicBlock can do so.
 101     void clear() {
 102       InsertedExpressions.clear();
 103       InsertedValues.clear();
 104       InsertedPostIncValues.clear();
 105     }
 106
 107     /// getOrInsertCanonicalInductionVariable - This method returns the
 108     /// canonical induction variable of the specified type for the specified
 109     /// loop (inserting one if there is none).  A canonical induction variable
 110     /// starts at zero and steps by one on each iteration.
 111     PHINode *getOrInsertCanonicalInductionVariable(const Loop *L, Type *Ty);
 112
 113     /// hoistStep - Utility for hoisting an IV increment.
 114     static bool hoistStep(Instruction *IncV, Instruction *InsertPos,
 115                           const DominatorTree *DT);
 116
 117     /// replaceCongruentIVs - replace congruent phis with their most canonical
 118     /// representative. Return the number of phis eliminated.
 119     unsigned replaceCongruentIVs(Loop *L, const DominatorTree *DT,
 120                                  SmallVectorImpl<WeakVH> &DeadInsts,
 121                                  const TargetLowering *TLI = NULL);
 122
 123     /// expandCodeFor - Insert code to directly compute the specified SCEV
 124     /// expression into the program.  The inserted code is inserted into the
 125     /// specified block.
 126     Value *expandCodeFor(const SCEV *SH, Type *Ty, Instruction *I);
 127
 128     /// setIVIncInsertPos - Set the current IV increment loop and position.
 129     void setIVIncInsertPos(const Loop *L, Instruction *Pos) {
 130       assert(!CanonicalMode &&
 131              "IV increment positions are not supported in CanonicalMode");
 132       IVIncInsertLoop = L;
 133       IVIncInsertPos = Pos;
 134     }
 135
 136     /// setPostInc - Enable post-inc expansion for addrecs referring to the
 137     /// given loops. Post-inc expansion is only supported in non-canonical
 138     /// mode.
 139     void setPostInc(const PostIncLoopSet &L) {
 140       assert(!CanonicalMode &&
 141              "Post-inc expansion is not supported in CanonicalMode");
 142       PostIncLoops = L;
 143     }
 144
 145     /// clearPostInc - Disable all post-inc expansion.
 146     void clearPostInc() {
 147       PostIncLoops.clear();
 148
 149       // When we change the post-inc loop set, cached expansions may no
 150       // longer be valid.
 151       InsertedPostIncValues.clear();
 152     }
 153
 154     /// disableCanonicalMode - Disable the behavior of expanding expressions in
 155     /// canonical form rather than in a more literal form. Non-canonical mode
 156     /// is useful for late optimization passes.
 157     void disableCanonicalMode() { CanonicalMode = false; }
 158
 159     void enableLSRMode() { LSRMode = true; }
 160
 161     /// clearInsertPoint - Clear the current insertion point. This is useful
 162     /// if the instruction that had been serving as the insertion point may
 163     /// have been deleted.
 164     void clearInsertPoint() {
 165       Builder.ClearInsertionPoint();
 166     }
 167   private:
 168     LLVMContext &getContext() const { return SE.getContext(); }
 169
 170     /// InsertBinop - Insert the specified binary operator, doing a small amount
 171     /// of work to avoid inserting an obviously redundant operation.
 172     Value *InsertBinop(Instruction::BinaryOps Opcode, Value *LHS, Value *RHS);
 173
 174     /// ReuseOrCreateCast - Arange for there to be a cast of V to Ty at IP,
 175     /// reusing an existing cast if a suitable one exists, moving an existing
 176     /// cast if a suitable one exists but isn't in the right place, or
 177     /// or creating a new one.
 178     Value *ReuseOrCreateCast(Value *V, Type *Ty,
 179                              Instruction::CastOps Op,
 180                              BasicBlock::iterator IP);
 181
 182     /// InsertNoopCastOfTo - Insert a cast of V to the specified type,
 183     /// which must be possible with a noop cast, doing what we can to
 184     /// share the casts.
 185     Value *InsertNoopCastOfTo(Value *V, Type *Ty);
 186
 187     /// expandAddToGEP - Expand a SCEVAddExpr with a pointer type into a GEP
 188     /// instead of using ptrtoint+arithmetic+inttoptr.
 189     Value *expandAddToGEP(const SCEV *const *op_begin,
 190                           const SCEV *const *op_end,
 191                           PointerType *PTy, Type *Ty, Value *V);
 192
 193     Value *expand(const SCEV *S);
 194
 195     /// expandCodeFor - Insert code to directly compute the specified SCEV
 196     /// expression into the program.  The inserted code is inserted into the
 197     /// SCEVExpander's current insertion point. If a type is specified, the
 198     /// result will be expanded to have that type, with a cast if necessary.
 199     Value *expandCodeFor(const SCEV *SH, Type *Ty = 0);
 200
 201     /// isInsertedInstruction - Return true if the specified instruction was
 202     /// inserted by the code rewriter.  If so, the client should not modify the
 203     /// instruction.
 204     bool isInsertedInstruction(Instruction *I) const {
 205       return InsertedValues.count(I) || InsertedPostIncValues.count(I);
 206     }
 207
 208     /// getRelevantLoop - Determine the most "relevant" loop for the given SCEV.
 209     const Loop *getRelevantLoop(const SCEV *);
 210
 211     Value *visitConstant(const SCEVConstant *S) {
 212       return S->getValue();
 213     }
 214
 215     Value *visitTruncateExpr(const SCEVTruncateExpr *S);
 216
 217     Value *visitZeroExtendExpr(const SCEVZeroExtendExpr *S);
 218
 219     Value *visitSignExtendExpr(const SCEVSignExtendExpr *S);
 220
 221     Value *visitAddExpr(const SCEVAddExpr *S);
 222
 223     Value *visitMulExpr(const SCEVMulExpr *S);
 224
 225     Value *visitUDivExpr(const SCEVUDivExpr *S);
 226
 227     Value *visitAddRecExpr(const SCEVAddRecExpr *S);
 228
 229     Value *visitSMaxExpr(const SCEVSMaxExpr *S);
 230
 231     Value *visitUMaxExpr(const SCEVUMaxExpr *S);
 232
 233     Value *visitUnknown(const SCEVUnknown *S) {
 234       return S->getValue();
 235     }
 236
 237     void rememberInstruction(Value *I);
 238
 239     void restoreInsertPoint(BasicBlock *BB, BasicBlock::iterator I);
 240
 241     bool isNormalAddRecExprPHI(PHINode *PN, Instruction *IncV, const Loop *L);
 242
 243     bool isExpandedAddRecExprPHI(PHINode *PN, Instruction *IncV, const Loop *L);
 244
 245     Value *expandAddRecExprLiterally(const SCEVAddRecExpr *);
 246     PHINode *getAddRecExprPHILiterally(const SCEVAddRecExpr *Normalized,
 247                                        const Loop *L,
 248                                        Type *ExpandTy,
 249                                        Type *IntTy);
 250     Value *expandIVInc(PHINode *PN, Value *StepV, const Loop *L,
 251                        Type *ExpandTy, Type *IntTy, bool useSubtract);
 252   };
 253 }
 254
 255 #endif