Unbreak build with gcc 4.3: provide missed includes and silence most annoying warnings.
[oota-llvm.git] / include / llvm / Analysis / ScalarEvolutionExpressions.h
index ba1b6d4fecb06218eb07bcbd4b39bb0801c3dcb0..39b083d5fac3fa22b07f0801c77c24d479c9a8b4 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 namespace llvm {
   class ConstantInt;
   class ConstantRange;
+  class APInt;
 
   enum SCEVTypes {
     // These should be ordered in terms of increasing complexity to make the
     // folders simpler.
-    scConstant, scTruncate, scZeroExtend, scAddExpr, scMulExpr, scSDivExpr,
-    scAddRecExpr, scUnknown, scCouldNotCompute
+    scConstant, scTruncate, scZeroExtend, scSignExtend, scAddExpr, scMulExpr,
+    scUDivExpr, scAddRecExpr, scUMaxExpr, scSMaxExpr, scUnknown,
+    scCouldNotCompute
   };
 
   //===--------------------------------------------------------------------===//
   /// SCEVConstant - This class represents a constant integer value.
   ///
   class SCEVConstant : public SCEV {
+    friend class ScalarEvolution;
+
     ConstantInt *V;
-    SCEVConstant(ConstantInt *v) : SCEV(scConstant), V(v) {}
+    explicit SCEVConstant(ConstantInt *v) : SCEV(scConstant), V(v) {}
 
     virtual ~SCEVConstant();
   public:
-    /// get method - This just gets and returns a new SCEVConstant object.
-    ///
-    static SCEVHandle get(ConstantInt *V);
-
     ConstantInt *getValue() const { return V; }
 
     /// getValueRange - Return the tightest constant bounds that this value is
@@ -57,11 +57,13 @@ namespace llvm {
     virtual const Type *getType() const;
 
     SCEVHandle replaceSymbolicValuesWithConcrete(const SCEVHandle &Sym,
-                                                 const SCEVHandle &Conc) const {
+                                                 const SCEVHandle &Conc,
+                                                 ScalarEvolution &SE) const {
       return this;
     }
 
     virtual void print(std::ostream &OS) const;
+    void print(std::ostream *OS) const { if (OS) print(*OS); }
 
     /// Methods for support type inquiry through isa, cast, and dyn_cast:
     static inline bool classof(const SCEVConstant *S) { return true; }
@@ -75,15 +77,13 @@ namespace llvm {
   /// to a smaller integer value.
   ///
   class SCEVTruncateExpr : public SCEV {
+    friend class ScalarEvolution;
+
     SCEVHandle Op;
     const Type *Ty;
     SCEVTruncateExpr(const SCEVHandle &op, const Type *ty);
     virtual ~SCEVTruncateExpr();
   public:
-    /// get method - This just gets and returns a new SCEVTruncate object
-    ///
-    static SCEVHandle get(const SCEVHandle &Op, const Type *Ty);
-
     const SCEVHandle &getOperand() const { return Op; }
     virtual const Type *getType() const { return Ty; }
 
@@ -96,11 +96,12 @@ namespace llvm {
     }
 
     SCEVHandle replaceSymbolicValuesWithConcrete(const SCEVHandle &Sym,
-                                                 const SCEVHandle &Conc) const {
-      SCEVHandle H = Op->replaceSymbolicValuesWithConcrete(Sym, Conc);
+                                                 const SCEVHandle &Conc,
+                                                 ScalarEvolution &SE) const {
+      SCEVHandle H = Op->replaceSymbolicValuesWithConcrete(Sym, Conc, SE);
       if (H == Op)
         return this;
-      return get(H, Ty);
+      return SE.getTruncateExpr(H, Ty);
     }
 
     /// getValueRange - Return the tightest constant bounds that this value is
@@ -108,6 +109,7 @@ namespace llvm {
     virtual ConstantRange getValueRange() const;
 
     virtual void print(std::ostream &OS) const;
+    void print(std::ostream *OS) const { if (OS) print(*OS); }
 
     /// Methods for support type inquiry through isa, cast, and dyn_cast:
     static inline bool classof(const SCEVTruncateExpr *S) { return true; }
@@ -121,15 +123,13 @@ namespace llvm {
   /// integer value to a larger integer value.
   ///
   class SCEVZeroExtendExpr : public SCEV {
+    friend class ScalarEvolution;
+
     SCEVHandle Op;
     const Type *Ty;
     SCEVZeroExtendExpr(const SCEVHandle &op, const Type *ty);
     virtual ~SCEVZeroExtendExpr();
   public:
-    /// get method - This just gets and returns a new SCEVZeroExtend object
-    ///
-    static SCEVHandle get(const SCEVHandle &Op, const Type *Ty);
-
     const SCEVHandle &getOperand() const { return Op; }
     virtual const Type *getType() const { return Ty; }
 
@@ -146,14 +146,16 @@ namespace llvm {
     virtual ConstantRange getValueRange() const;
 
     SCEVHandle replaceSymbolicValuesWithConcrete(const SCEVHandle &Sym,
-                                                 const SCEVHandle &Conc) const {
-      SCEVHandle H = Op->replaceSymbolicValuesWithConcrete(Sym, Conc);
+                                                 const SCEVHandle &Conc,
+                                                 ScalarEvolution &SE) const {
+      SCEVHandle H = Op->replaceSymbolicValuesWithConcrete(Sym, Conc, SE);
       if (H == Op)
         return this;
-      return get(H, Ty);
+      return SE.getZeroExtendExpr(H, Ty);
     }
 
     virtual void print(std::ostream &OS) const;
+    void print(std::ostream *OS) const { if (OS) print(*OS); }
 
     /// Methods for support type inquiry through isa, cast, and dyn_cast:
     static inline bool classof(const SCEVZeroExtendExpr *S) { return true; }
@@ -162,12 +164,60 @@ namespace llvm {
     }
   };
 
+  //===--------------------------------------------------------------------===//
+  /// SCEVSignExtendExpr - This class represents a sign extension of a small
+  /// integer value to a larger integer value.
+  ///
+  class SCEVSignExtendExpr : public SCEV {
+    friend class ScalarEvolution;
+
+    SCEVHandle Op;
+    const Type *Ty;
+    SCEVSignExtendExpr(const SCEVHandle &op, const Type *ty);
+    virtual ~SCEVSignExtendExpr();
+  public:
+    const SCEVHandle &getOperand() const { return Op; }
+    virtual const Type *getType() const { return Ty; }
+
+    virtual bool isLoopInvariant(const Loop *L) const {
+      return Op->isLoopInvariant(L);
+    }
+
+    virtual bool hasComputableLoopEvolution(const Loop *L) const {
+      return Op->hasComputableLoopEvolution(L);
+    }
+
+    /// getValueRange - Return the tightest constant bounds that this value is
+    /// known to have.  This method is only valid on integer SCEV objects.
+    virtual ConstantRange getValueRange() const;
+
+    SCEVHandle replaceSymbolicValuesWithConcrete(const SCEVHandle &Sym,
+                                                 const SCEVHandle &Conc,
+                                                 ScalarEvolution &SE) const {
+      SCEVHandle H = Op->replaceSymbolicValuesWithConcrete(Sym, Conc, SE);
+      if (H == Op)
+        return this;
+      return SE.getSignExtendExpr(H, Ty);
+    }
+
+    virtual void print(std::ostream &OS) const;
+    void print(std::ostream *OS) const { if (OS) print(*OS); }
+
+    /// Methods for support type inquiry through isa, cast, and dyn_cast:
+    static inline bool classof(const SCEVSignExtendExpr *S) { return true; }
+    static inline bool classof(const SCEV *S) {
+      return S->getSCEVType() == scSignExtend;
+    }
+  };
+
 
   //===--------------------------------------------------------------------===//
   /// SCEVCommutativeExpr - This node is the base class for n'ary commutative
   /// operators.
   ///
   class SCEVCommutativeExpr : public SCEV {
+    friend class ScalarEvolution;
+
     std::vector<SCEVHandle> Operands;
 
   protected:
@@ -203,27 +253,32 @@ namespace llvm {
     virtual bool hasComputableLoopEvolution(const Loop *L) const {
       bool HasVarying = false;
       for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
-        if (!getOperand(i)->isLoopInvariant(L))
+        if (!getOperand(i)->isLoopInvariant(L)) {
           if (getOperand(i)->hasComputableLoopEvolution(L))
             HasVarying = true;
           else
             return false;
+        }
       return HasVarying;
     }
 
     SCEVHandle replaceSymbolicValuesWithConcrete(const SCEVHandle &Sym,
-                                                 const SCEVHandle &Conc) const;
+                                                 const SCEVHandle &Conc,
+                                                 ScalarEvolution &SE) const;
 
     virtual const char *getOperationStr() const = 0;
 
     virtual const Type *getType() const { return getOperand(0)->getType(); }
     virtual void print(std::ostream &OS) const;
+    void print(std::ostream *OS) const { if (OS) print(*OS); }
 
     /// Methods for support type inquiry through isa, cast, and dyn_cast:
     static inline bool classof(const SCEVCommutativeExpr *S) { return true; }
     static inline bool classof(const SCEV *S) {
       return S->getSCEVType() == scAddExpr ||
-             S->getSCEVType() == scMulExpr;
+             S->getSCEVType() == scMulExpr ||
+             S->getSCEVType() == scSMaxExpr ||
+             S->getSCEVType() == scUMaxExpr;
     }
   };
 
@@ -232,29 +287,13 @@ namespace llvm {
   /// SCEVAddExpr - This node represents an addition of some number of SCEVs.
   ///
   class SCEVAddExpr : public SCEVCommutativeExpr {
-    SCEVAddExpr(const std::vector<SCEVHandle> &ops)
+    friend class ScalarEvolution;
+
+    explicit SCEVAddExpr(const std::vector<SCEVHandle> &ops)
       : SCEVCommutativeExpr(scAddExpr, ops) {
     }
 
   public:
-    static SCEVHandle get(std::vector<SCEVHandle> &Ops);
-
-    static SCEVHandle get(const SCEVHandle &LHS, const SCEVHandle &RHS) {
-      std::vector<SCEVHandle> Ops;
-      Ops.push_back(LHS);
-      Ops.push_back(RHS);
-      return get(Ops);
-    }
-
-    static SCEVHandle get(const SCEVHandle &Op0, const SCEVHandle &Op1,
-                          const SCEVHandle &Op2) {
-      std::vector<SCEVHandle> Ops;
-      Ops.push_back(Op0);
-      Ops.push_back(Op1);
-      Ops.push_back(Op2);
-      return get(Ops);
-    }
-
     virtual const char *getOperationStr() const { return " + "; }
 
     /// Methods for support type inquiry through isa, cast, and dyn_cast:
@@ -268,20 +307,13 @@ namespace llvm {
   /// SCEVMulExpr - This node represents multiplication of some number of SCEVs.
   ///
   class SCEVMulExpr : public SCEVCommutativeExpr {
-    SCEVMulExpr(const std::vector<SCEVHandle> &ops)
+    friend class ScalarEvolution;
+
+    explicit SCEVMulExpr(const std::vector<SCEVHandle> &ops)
       : SCEVCommutativeExpr(scMulExpr, ops) {
     }
 
   public:
-    static SCEVHandle get(std::vector<SCEVHandle> &Ops);
-
-    static SCEVHandle get(const SCEVHandle &LHS, const SCEVHandle &RHS) {
-      std::vector<SCEVHandle> Ops;
-      Ops.push_back(LHS);
-      Ops.push_back(RHS);
-      return get(Ops);
-    }
-
     virtual const char *getOperationStr() const { return " * "; }
 
     /// Methods for support type inquiry through isa, cast, and dyn_cast:
@@ -293,19 +325,17 @@ namespace llvm {
 
 
   //===--------------------------------------------------------------------===//
-  /// SCEVSDivExpr - This class represents a binary signed division operation.
+  /// SCEVUDivExpr - This class represents a binary unsigned division operation.
   ///
-  class SCEVSDivExpr : public SCEV {
+  class SCEVUDivExpr : public SCEV {
+    friend class ScalarEvolution;
+
     SCEVHandle LHS, RHS;
-    SCEVSDivExpr(const SCEVHandle &lhs, const SCEVHandle &rhs)
-      : SCEV(scSDivExpr), LHS(lhs), RHS(rhs) {}
+    SCEVUDivExpr(const SCEVHandle &lhs, const SCEVHandle &rhs)
+      : SCEV(scUDivExpr), LHS(lhs), RHS(rhs) {}
 
-    virtual ~SCEVSDivExpr();
+    virtual ~SCEVUDivExpr();
   public:
-    /// get method - This just gets and returns a new SCEVSDiv object.
-    ///
-    static SCEVHandle get(const SCEVHandle &LHS, const SCEVHandle &RHS);
-
     const SCEVHandle &getLHS() const { return LHS; }
     const SCEVHandle &getRHS() const { return RHS; }
 
@@ -319,24 +349,26 @@ namespace llvm {
     }
 
     SCEVHandle replaceSymbolicValuesWithConcrete(const SCEVHandle &Sym,
-                                                 const SCEVHandle &Conc) const {
-      SCEVHandle L = LHS->replaceSymbolicValuesWithConcrete(Sym, Conc);
-      SCEVHandle R = RHS->replaceSymbolicValuesWithConcrete(Sym, Conc);
+                                                 const SCEVHandle &Conc,
+                                                 ScalarEvolution &SE) const {
+      SCEVHandle L = LHS->replaceSymbolicValuesWithConcrete(Sym, Conc, SE);
+      SCEVHandle R = RHS->replaceSymbolicValuesWithConcrete(Sym, Conc, SE);
       if (L == LHS && R == RHS)
         return this;
       else
-        return get(L, R);
+        return SE.getUDivExpr(L, R);
     }
 
 
     virtual const Type *getType() const;
 
     void print(std::ostream &OS) const;
+    void print(std::ostream *OS) const { if (OS) print(*OS); }
 
     /// Methods for support type inquiry through isa, cast, and dyn_cast:
-    static inline bool classof(const SCEVSDivExpr *S) { return true; }
+    static inline bool classof(const SCEVUDivExpr *S) { return true; }
     static inline bool classof(const SCEV *S) {
-      return S->getSCEVType() == scSDivExpr;
+      return S->getSCEVType() == scUDivExpr;
     }
   };
 
@@ -348,6 +380,8 @@ namespace llvm {
   /// All operands of an AddRec are required to be loop invariant.
   ///
   class SCEVAddRecExpr : public SCEV {
+    friend class ScalarEvolution;
+
     std::vector<SCEVHandle> Operands;
     const Loop *L;
 
@@ -359,16 +393,6 @@ namespace llvm {
     }
     ~SCEVAddRecExpr();
   public:
-    static SCEVHandle get(const SCEVHandle &Start, const SCEVHandle &Step,
-                          const Loop *);
-    static SCEVHandle get(std::vector<SCEVHandle> &Operands,
-                          const Loop *);
-    static SCEVHandle get(const std::vector<SCEVHandle> &Operands,
-                          const Loop *L) {
-      std::vector<SCEVHandle> NewOp(Operands);
-      return get(NewOp, L);
-    }
-
     typedef std::vector<SCEVHandle>::const_iterator op_iterator;
     op_iterator op_begin() const { return Operands.begin(); }
     op_iterator op_end() const { return Operands.end(); }
@@ -382,10 +406,10 @@ namespace llvm {
     /// getStepRecurrence - This method constructs and returns the recurrence
     /// indicating how much this expression steps by.  If this is a polynomial
     /// of degree N, it returns a chrec of degree N-1.
-    SCEVHandle getStepRecurrence() const {
+    SCEVHandle getStepRecurrence(ScalarEvolution &SE) const {
       if (getNumOperands() == 2) return getOperand(1);
-      return SCEVAddRecExpr::get(std::vector<SCEVHandle>(op_begin()+1,op_end()),
-                                 getLoop());
+      return SE.getAddRecExpr(std::vector<SCEVHandle>(op_begin()+1,op_end()),
+                              getLoop());
     }
 
     virtual bool hasComputableLoopEvolution(const Loop *QL) const {
@@ -414,7 +438,7 @@ namespace llvm {
 
     /// evaluateAtIteration - Return the value of this chain of recurrences at
     /// the specified iteration number.
-    SCEVHandle evaluateAtIteration(SCEVHandle It) const;
+    SCEVHandle evaluateAtIteration(SCEVHandle It, ScalarEvolution &SE) const;
 
     /// getNumIterationsInRange - Return the number of iterations of this loop
     /// that produce values in the specified constant range.  Another way of
@@ -422,12 +446,15 @@ namespace llvm {
     /// value is not in the condition, thus computing the exit count.  If the
     /// iteration count can't be computed, an instance of SCEVCouldNotCompute is
     /// returned.
-    SCEVHandle getNumIterationsInRange(ConstantRange Range) const;
+    SCEVHandle getNumIterationsInRange(ConstantRange Range,
+                                       ScalarEvolution &SE) const;
 
     SCEVHandle replaceSymbolicValuesWithConcrete(const SCEVHandle &Sym,
-                                                 const SCEVHandle &Conc) const;
+                                                 const SCEVHandle &Conc,
+                                                 ScalarEvolution &SE) const;
 
     virtual void print(std::ostream &OS) const;
+    void print(std::ostream *OS) const { if (OS) print(*OS); }
 
     /// Methods for support type inquiry through isa, cast, and dyn_cast:
     static inline bool classof(const SCEVAddRecExpr *S) { return true; }
@@ -436,26 +463,63 @@ namespace llvm {
     }
   };
 
+
+  //===--------------------------------------------------------------------===//
+  /// SCEVSMaxExpr - This class represents a signed maximum selection.
+  ///
+  class SCEVSMaxExpr : public SCEVCommutativeExpr {
+    friend class ScalarEvolution;
+
+    explicit SCEVSMaxExpr(const std::vector<SCEVHandle> &ops)
+      : SCEVCommutativeExpr(scSMaxExpr, ops) {
+    }
+
+  public:
+    virtual const char *getOperationStr() const { return " smax "; }
+
+    /// Methods for support type inquiry through isa, cast, and dyn_cast:
+    static inline bool classof(const SCEVSMaxExpr *S) { return true; }
+    static inline bool classof(const SCEV *S) {
+      return S->getSCEVType() == scSMaxExpr;
+    }
+  };
+
+
+  //===--------------------------------------------------------------------===//
+  /// SCEVUMaxExpr - This class represents an unsigned maximum selection.
+  ///
+  class SCEVUMaxExpr : public SCEVCommutativeExpr {
+    friend class ScalarEvolution;
+
+    explicit SCEVUMaxExpr(const std::vector<SCEVHandle> &ops)
+      : SCEVCommutativeExpr(scUMaxExpr, ops) {
+    }
+
+  public:
+    virtual const char *getOperationStr() const { return " umax "; }
+
+    /// Methods for support type inquiry through isa, cast, and dyn_cast:
+    static inline bool classof(const SCEVUMaxExpr *S) { return true; }
+    static inline bool classof(const SCEV *S) {
+      return S->getSCEVType() == scUMaxExpr;
+    }
+  };
+
+
   //===--------------------------------------------------------------------===//
   /// SCEVUnknown - This means that we are dealing with an entirely unknown SCEV
   /// value, and only represent it as it's LLVM Value.  This is the "bottom"
   /// value for the analysis.
   ///
   class SCEVUnknown : public SCEV {
+    friend class ScalarEvolution;
+
     Value *V;
-    SCEVUnknown(Value *v) : SCEV(scUnknown), V(v) {}
+    explicit SCEVUnknown(Value *v) : SCEV(scUnknown), V(v) {}
 
   protected:
     ~SCEVUnknown();
   public:
-    /// get method - For SCEVUnknown, this just gets and returns a new
-    /// SCEVUnknown.
-    static SCEVHandle get(Value *V);
-
-    /// getIntegerSCEV - Given an integer or FP type, create a constant for the
-    /// specified signed integer value and return a SCEV for the constant.
-    static SCEVHandle getIntegerSCEV(int Val, const Type *Ty);
-
     Value *getValue() const { return V; }
 
     virtual bool isLoopInvariant(const Loop *L) const;
@@ -464,7 +528,8 @@ namespace llvm {
     }
 
     SCEVHandle replaceSymbolicValuesWithConcrete(const SCEVHandle &Sym,
-                                                 const SCEVHandle &Conc) const {
+                                                 const SCEVHandle &Conc,
+                                                 ScalarEvolution &SE) const {
       if (&*Sym == this) return Conc;
       return this;
     }
@@ -472,6 +537,7 @@ namespace llvm {
     virtual const Type *getType() const;
 
     virtual void print(std::ostream &OS) const;
+    void print(std::ostream *OS) const { if (OS) print(*OS); }
 
     /// Methods for support type inquiry through isa, cast, and dyn_cast:
     static inline bool classof(const SCEVUnknown *S) { return true; }
@@ -492,14 +558,20 @@ namespace llvm {
         return ((SC*)this)->visitTruncateExpr((SCEVTruncateExpr*)S);
       case scZeroExtend:
         return ((SC*)this)->visitZeroExtendExpr((SCEVZeroExtendExpr*)S);
+      case scSignExtend:
+        return ((SC*)this)->visitSignExtendExpr((SCEVSignExtendExpr*)S);
       case scAddExpr:
         return ((SC*)this)->visitAddExpr((SCEVAddExpr*)S);
       case scMulExpr:
         return ((SC*)this)->visitMulExpr((SCEVMulExpr*)S);
-      case scSDivExpr:
-        return ((SC*)this)->visitSDivExpr((SCEVSDivExpr*)S);
+      case scUDivExpr:
+        return ((SC*)this)->visitUDivExpr((SCEVUDivExpr*)S);
       case scAddRecExpr:
         return ((SC*)this)->visitAddRecExpr((SCEVAddRecExpr*)S);
+      case scSMaxExpr:
+        return ((SC*)this)->visitSMaxExpr((SCEVSMaxExpr*)S);
+      case scUMaxExpr:
+        return ((SC*)this)->visitUMaxExpr((SCEVUMaxExpr*)S);
       case scUnknown:
         return ((SC*)this)->visitUnknown((SCEVUnknown*)S);
       case scCouldNotCompute:
@@ -519,4 +591,3 @@ namespace llvm {
 }
 
 #endif
-