include/llvm/Analysis/ScalarEvolution.h

   1 //===- llvm/Analysis/ScalarEvolution.h - Scalar Evolution -------*- 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 // The ScalarEvolution class is an LLVM pass which can be used to analyze and
  11 // catagorize scalar expressions in loops.  It specializes in recognizing
  12 // general induction variables, representing them with the abstract and opaque
  13 // SCEV class.  Given this analysis, trip counts of loops and other important
  14 // properties can be obtained.
  15 //
  16 // This analysis is primarily useful for induction variable substitution and
  17 // strength reduction.
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #ifndef LLVM_ANALYSIS_SCALAREVOLUTION_H
  22 #define LLVM_ANALYSIS_SCALAREVOLUTION_H
  23
  24 #include "llvm/Pass.h"
  25 #include "llvm/Support/Streams.h"
  26 #include <set>
  27
  28 namespace llvm {
  29   class Instruction;
  30   class Type;
  31   class ConstantRange;
  32   class Loop;
  33   class LoopInfo;
  34   class SCEVHandle;
  35
  36   /// SCEV - This class represent an analyzed expression in the program.  These
  37   /// are reference counted opaque objects that the client is not allowed to
  38   /// do much with directly.
  39   ///
  40   class SCEV {
  41     const unsigned SCEVType;      // The SCEV baseclass this node corresponds to
  42     mutable unsigned RefCount;
  43
  44     friend class SCEVHandle;
  45     void addRef() const { ++RefCount; }
  46     void dropRef() const {
  47       if (--RefCount == 0)
  48         delete this;
  49     }
  50
  51     SCEV(const SCEV &);            // DO NOT IMPLEMENT
  52     void operator=(const SCEV &);  // DO NOT IMPLEMENT
  53   protected:
  54     virtual ~SCEV();
  55   public:
  56     SCEV(unsigned SCEVTy) : SCEVType(SCEVTy), RefCount(0) {}
  57
  58     /// getNegativeSCEV - Return the SCEV object corresponding to -V.
  59     ///
  60     static SCEVHandle getNegativeSCEV(const SCEVHandle &V);
  61
  62     /// getMinusSCEV - Return LHS-RHS.
  63     ///
  64     static SCEVHandle getMinusSCEV(const SCEVHandle &LHS,
  65                                    const SCEVHandle &RHS);
  66
  67
  68     unsigned getSCEVType() const { return SCEVType; }
  69
  70     /// getValueRange - Return the tightest constant bounds that this value is
  71     /// known to have.  This method is only valid on integer SCEV objects.
  72     virtual ConstantRange getValueRange() const;
  73
  74     /// isLoopInvariant - Return true if the value of this SCEV is unchanging in
  75     /// the specified loop.
  76     virtual bool isLoopInvariant(const Loop *L) const = 0;
  77
  78     /// hasComputableLoopEvolution - Return true if this SCEV changes value in a
  79     /// known way in the specified loop.  This property being true implies that
  80     /// the value is variant in the loop AND that we can emit an expression to
  81     /// compute the value of the expression at any particular loop iteration.
  82     virtual bool hasComputableLoopEvolution(const Loop *L) const = 0;
  83
  84     /// getType - Return the LLVM type of this SCEV expression.
  85     ///
  86     virtual const Type *getType() const = 0;
  87
  88     /// replaceSymbolicValuesWithConcrete - If this SCEV internally references
  89     /// the symbolic value "Sym", construct and return a new SCEV that produces
  90     /// the same value, but which uses the concrete value Conc instead of the
  91     /// symbolic value.  If this SCEV does not use the symbolic value, it
  92     /// returns itself.
  93     virtual SCEVHandle
  94     replaceSymbolicValuesWithConcrete(const SCEVHandle &Sym,
  95                                       const SCEVHandle &Conc) const = 0;
  96
  97     /// print - Print out the internal representation of this scalar to the
  98     /// specified stream.  This should really only be used for debugging
  99     /// purposes.
 100     virtual void print(std::ostream &OS) const = 0;
 101     void print(std::ostream *OS) const { if (OS) print(*OS); }
 102
 103     /// dump - This method is used for debugging.
 104     ///
 105     void dump() const;
 106   };
 107
 108   inline std::ostream &operator<<(std::ostream &OS, const SCEV &S) {
 109     S.print(OS);
 110     return OS;
 111   }
 112
 113   /// SCEVCouldNotCompute - An object of this class is returned by queries that
 114   /// could not be answered.  For example, if you ask for the number of
 115   /// iterations of a linked-list traversal loop, you will get one of these.
 116   /// None of the standard SCEV operations are valid on this class, it is just a
 117   /// marker.
 118   struct SCEVCouldNotCompute : public SCEV {
 119     SCEVCouldNotCompute();
 120
 121     // None of these methods are valid for this object.
 122     virtual bool isLoopInvariant(const Loop *L) const;
 123     virtual const Type *getType() const;
 124     virtual bool hasComputableLoopEvolution(const Loop *L) const;
 125     virtual void print(std::ostream &OS) const;
 126     void print(std::ostream *OS) const { if (OS) print(*OS); }
 127     virtual SCEVHandle
 128     replaceSymbolicValuesWithConcrete(const SCEVHandle &Sym,
 129                                       const SCEVHandle &Conc) const;
 130
 131     /// Methods for support type inquiry through isa, cast, and dyn_cast:
 132     static inline bool classof(const SCEVCouldNotCompute *S) { return true; }
 133     static bool classof(const SCEV *S);
 134   };
 135
 136   /// SCEVHandle - This class is used to maintain the SCEV object's refcounts,
 137   /// freeing the objects when the last reference is dropped.
 138   class SCEVHandle {
 139     SCEV *S;
 140     SCEVHandle();  // DO NOT IMPLEMENT
 141   public:
 142     SCEVHandle(const SCEV *s) : S(const_cast<SCEV*>(s)) {
 143       assert(S && "Cannot create a handle to a null SCEV!");
 144       S->addRef();
 145     }
 146     SCEVHandle(const SCEVHandle &RHS) : S(RHS.S) {
 147       S->addRef();
 148     }
 149     ~SCEVHandle() { S->dropRef(); }
 150
 151     operator SCEV*() const { return S; }
 152
 153     SCEV &operator*() const { return *S; }
 154     SCEV *operator->() const { return S; }
 155
 156     bool operator==(SCEV *RHS) const { return S == RHS; }
 157     bool operator!=(SCEV *RHS) const { return S != RHS; }
 158
 159     const SCEVHandle &operator=(SCEV *RHS) {
 160       if (S != RHS) {
 161         S->dropRef();
 162         S = RHS;
 163         S->addRef();
 164       }
 165       return *this;
 166     }
 167
 168     const SCEVHandle &operator=(const SCEVHandle &RHS) {
 169       if (S != RHS.S) {
 170         S->dropRef();
 171         S = RHS.S;
 172         S->addRef();
 173       }
 174       return *this;
 175     }
 176   };
 177
 178   template<typename From> struct simplify_type;
 179   template<> struct simplify_type<const SCEVHandle> {
 180     typedef SCEV* SimpleType;
 181     static SimpleType getSimplifiedValue(const SCEVHandle &Node) {
 182       return Node;
 183     }
 184   };
 185   template<> struct simplify_type<SCEVHandle>
 186     : public simplify_type<const SCEVHandle> {};
 187
 188   /// ScalarEvolution - This class is the main scalar evolution driver.  Because
 189   /// client code (intentionally) can't do much with the SCEV objects directly,
 190   /// they must ask this class for services.
 191   ///
 192   class ScalarEvolution : public FunctionPass {
 193     void *Impl;    // ScalarEvolution uses the pimpl pattern
 194   public:
 195     ScalarEvolution() : Impl(0) {}
 196
 197     /// getSCEV - Return a SCEV expression handle for the full generality of the
 198     /// specified expression.
 199     SCEVHandle getSCEV(Value *V) const;
 200
 201     /// hasSCEV - Return true if the SCEV for this value has already been
 202     /// computed.
 203     bool hasSCEV(Value *V) const;
 204
 205     /// setSCEV - Insert the specified SCEV into the map of current SCEVs for
 206     /// the specified value.
 207     void setSCEV(Value *V, const SCEVHandle &H);
 208
 209     /// getSCEVAtScope - Return a SCEV expression handle for the specified value
 210     /// at the specified scope in the program.  The L value specifies a loop
 211     /// nest to evaluate the expression at, where null is the top-level or a
 212     /// specified loop is immediately inside of the loop.
 213     ///
 214     /// This method can be used to compute the exit value for a variable defined
 215     /// in a loop by querying what the value will hold in the parent loop.
 216     ///
 217     /// If this value is not computable at this scope, a SCEVCouldNotCompute
 218     /// object is returned.
 219     SCEVHandle getSCEVAtScope(Value *V, const Loop *L) const;
 220
 221     /// getIterationCount - If the specified loop has a predictable iteration
 222     /// count, return it, otherwise return a SCEVCouldNotCompute object.
 223     SCEVHandle getIterationCount(const Loop *L) const;
 224
 225     /// hasLoopInvariantIterationCount - Return true if the specified loop has
 226     /// an analyzable loop-invariant iteration count.
 227     bool hasLoopInvariantIterationCount(const Loop *L) const;
 228
 229     /// deleteInstructionFromRecords - This method should be called by the
 230     /// client before it removes an instruction from the program, to make sure
 231     /// that no dangling references are left around.
 232     void deleteInstructionFromRecords(Instruction *I) const;
 233
 234     virtual bool runOnFunction(Function &F);
 235     virtual void releaseMemory();
 236     virtual void getAnalysisUsage(AnalysisUsage &AU) const;
 237     virtual void print(std::ostream &OS, const Module* = 0) const;
 238     void print(std::ostream *OS, const Module* M = 0) const {
 239       if (OS) print(*OS, M);
 240     }
 241   };
 242 }
 243
 244 #endif