include/llvm/Analysis/ScalarEvolutionExpressions.h

   1 //===- llvm/Analysis/ScalarEvolutionExpressions.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 represent and build scalar expressions.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ANALYSIS_SCALAREVOLUTIONEXPRESSIONS_H
  15 #define LLVM_ANALYSIS_SCALAREVOLUTIONEXPRESSIONS_H
  16
  17 #include "llvm/ADT/iterator_range.h"
  18 #include "llvm/ADT/SmallPtrSet.h"
  19 #include "llvm/Analysis/ScalarEvolution.h"
  20 #include "llvm/Support/ErrorHandling.h"
  21
  22 namespace llvm {
  23   class ConstantInt;
  24   class ConstantRange;
  25   class DominatorTree;
  26
  27   enum SCEVTypes {
  28     // These should be ordered in terms of increasing complexity to make the
  29     // folders simpler.
  30     scConstant, scTruncate, scZeroExtend, scSignExtend, scAddExpr, scMulExpr,
  31     scUDivExpr, scAddRecExpr, scUMaxExpr, scSMaxExpr,
  32     scUnknown, scCouldNotCompute
  33   };
  34
  35   //===--------------------------------------------------------------------===//
  36   /// SCEVConstant - This class represents a constant integer value.
  37   ///
  38   class SCEVConstant : public SCEV {
  39     friend class ScalarEvolution;
  40
  41     ConstantInt *V;
  42     SCEVConstant(const FoldingSetNodeIDRef ID, ConstantInt *v) :
  43       SCEV(ID, scConstant), V(v) {}
  44   public:
  45     ConstantInt *getValue() const { return V; }
  46
  47     Type *getType() const { return V->getType(); }
  48
  49     /// Methods for support type inquiry through isa, cast, and dyn_cast:
  50     static inline bool classof(const SCEV *S) {
  51       return S->getSCEVType() == scConstant;
  52     }
  53   };
  54
  55   //===--------------------------------------------------------------------===//
  56   /// SCEVCastExpr - This is the base class for unary cast operator classes.
  57   ///
  58   class SCEVCastExpr : public SCEV {
  59   protected:
  60     const SCEV *Op;
  61     Type *Ty;
  62
  63     SCEVCastExpr(const FoldingSetNodeIDRef ID,
  64                  unsigned SCEVTy, const SCEV *op, Type *ty);
  65
  66   public:
  67     const SCEV *getOperand() const { return Op; }
  68     Type *getType() const { return Ty; }
  69
  70     /// Methods for support type inquiry through isa, cast, and dyn_cast:
  71     static inline bool classof(const SCEV *S) {
  72       return S->getSCEVType() == scTruncate ||
  73              S->getSCEVType() == scZeroExtend ||
  74              S->getSCEVType() == scSignExtend;
  75     }
  76   };
  77
  78   //===--------------------------------------------------------------------===//
  79   /// SCEVTruncateExpr - This class represents a truncation of an integer value
  80   /// to a smaller integer value.
  81   ///
  82   class SCEVTruncateExpr : public SCEVCastExpr {
  83     friend class ScalarEvolution;
  84
  85     SCEVTruncateExpr(const FoldingSetNodeIDRef ID,
  86                      const SCEV *op, Type *ty);
  87
  88   public:
  89     /// Methods for support type inquiry through isa, cast, and dyn_cast:
  90     static inline bool classof(const SCEV *S) {
  91       return S->getSCEVType() == scTruncate;
  92     }
  93   };
  94
  95   //===--------------------------------------------------------------------===//
  96   /// SCEVZeroExtendExpr - This class represents a zero extension of a small
  97   /// integer value to a larger integer value.
  98   ///
  99   class SCEVZeroExtendExpr : public SCEVCastExpr {
 100     friend class ScalarEvolution;
 101
 102     SCEVZeroExtendExpr(const FoldingSetNodeIDRef ID,
 103                        const SCEV *op, Type *ty);
 104
 105   public:
 106     /// Methods for support type inquiry through isa, cast, and dyn_cast:
 107     static inline bool classof(const SCEV *S) {
 108       return S->getSCEVType() == scZeroExtend;
 109     }
 110   };
 111
 112   //===--------------------------------------------------------------------===//
 113   /// SCEVSignExtendExpr - This class represents a sign extension of a small
 114   /// integer value to a larger integer value.
 115   ///
 116   class SCEVSignExtendExpr : public SCEVCastExpr {
 117     friend class ScalarEvolution;
 118
 119     SCEVSignExtendExpr(const FoldingSetNodeIDRef ID,
 120                        const SCEV *op, Type *ty);
 121
 122   public:
 123     /// Methods for support type inquiry through isa, cast, and dyn_cast:
 124     static inline bool classof(const SCEV *S) {
 125       return S->getSCEVType() == scSignExtend;
 126     }
 127   };
 128
 129
 130   //===--------------------------------------------------------------------===//
 131   /// SCEVNAryExpr - This node is a base class providing common
 132   /// functionality for n'ary operators.
 133   ///
 134   class SCEVNAryExpr : public SCEV {
 135   protected:
 136     // Since SCEVs are immutable, ScalarEvolution allocates operand
 137     // arrays with its SCEVAllocator, so this class just needs a simple
 138     // pointer rather than a more elaborate vector-like data structure.
 139     // This also avoids the need for a non-trivial destructor.
 140     const SCEV *const *Operands;
 141     size_t NumOperands;
 142
 143     SCEVNAryExpr(const FoldingSetNodeIDRef ID,
 144                  enum SCEVTypes T, const SCEV *const *O, size_t N)
 145       : SCEV(ID, T), Operands(O), NumOperands(N) {}
 146
 147   public:
 148     size_t getNumOperands() const { return NumOperands; }
 149     const SCEV *getOperand(unsigned i) const {
 150       assert(i < NumOperands && "Operand index out of range!");
 151       return Operands[i];
 152     }
 153
 154     typedef const SCEV *const *op_iterator;
 155     typedef iterator_range<op_iterator> op_range;
 156     op_iterator op_begin() const { return Operands; }
 157     op_iterator op_end() const { return Operands + NumOperands; }
 158     op_range operands() const {
 159       return make_range(op_begin(), op_end());
 160     }
 161
 162     Type *getType() const { return getOperand(0)->getType(); }
 163
 164     NoWrapFlags getNoWrapFlags(NoWrapFlags Mask = NoWrapMask) const {
 165       return (NoWrapFlags)(SubclassData & Mask);
 166     }
 167
 168     /// Methods for support type inquiry through isa, cast, and dyn_cast:
 169     static inline bool classof(const SCEV *S) {
 170       return S->getSCEVType() == scAddExpr ||
 171              S->getSCEVType() == scMulExpr ||
 172              S->getSCEVType() == scSMaxExpr ||
 173              S->getSCEVType() == scUMaxExpr ||
 174              S->getSCEVType() == scAddRecExpr;
 175     }
 176   };
 177
 178   //===--------------------------------------------------------------------===//
 179   /// SCEVCommutativeExpr - This node is the base class for n'ary commutative
 180   /// operators.
 181   ///
 182   class SCEVCommutativeExpr : public SCEVNAryExpr {
 183   protected:
 184     SCEVCommutativeExpr(const FoldingSetNodeIDRef ID,
 185                         enum SCEVTypes T, const SCEV *const *O, size_t N)
 186       : SCEVNAryExpr(ID, T, O, N) {}
 187
 188   public:
 189     /// Methods for support type inquiry through isa, cast, and dyn_cast:
 190     static inline bool classof(const SCEV *S) {
 191       return S->getSCEVType() == scAddExpr ||
 192              S->getSCEVType() == scMulExpr ||
 193              S->getSCEVType() == scSMaxExpr ||
 194              S->getSCEVType() == scUMaxExpr;
 195     }
 196
 197     /// Set flags for a non-recurrence without clearing previously set flags.
 198     void setNoWrapFlags(NoWrapFlags Flags) {
 199       SubclassData |= Flags;
 200     }
 201   };
 202
 203
 204   //===--------------------------------------------------------------------===//
 205   /// SCEVAddExpr - This node represents an addition of some number of SCEVs.
 206   ///
 207   class SCEVAddExpr : public SCEVCommutativeExpr {
 208     friend class ScalarEvolution;
 209
 210     SCEVAddExpr(const FoldingSetNodeIDRef ID,
 211                 const SCEV *const *O, size_t N)
 212       : SCEVCommutativeExpr(ID, scAddExpr, O, N) {
 213     }
 214
 215   public:
 216     Type *getType() const {
 217       // Use the type of the last operand, which is likely to be a pointer
 218       // type, if there is one. This doesn't usually matter, but it can help
 219       // reduce casts when the expressions are expanded.
 220       return getOperand(getNumOperands() - 1)->getType();
 221     }
 222
 223     /// Methods for support type inquiry through isa, cast, and dyn_cast:
 224     static inline bool classof(const SCEV *S) {
 225       return S->getSCEVType() == scAddExpr;
 226     }
 227   };
 228
 229   //===--------------------------------------------------------------------===//
 230   /// SCEVMulExpr - This node represents multiplication of some number of SCEVs.
 231   ///
 232   class SCEVMulExpr : public SCEVCommutativeExpr {
 233     friend class ScalarEvolution;
 234
 235     SCEVMulExpr(const FoldingSetNodeIDRef ID,
 236                 const SCEV *const *O, size_t N)
 237       : SCEVCommutativeExpr(ID, scMulExpr, O, N) {
 238     }
 239
 240   public:
 241     /// Methods for support type inquiry through isa, cast, and dyn_cast:
 242     static inline bool classof(const SCEV *S) {
 243       return S->getSCEVType() == scMulExpr;
 244     }
 245   };
 246
 247
 248   //===--------------------------------------------------------------------===//
 249   /// SCEVUDivExpr - This class represents a binary unsigned division operation.
 250   ///
 251   class SCEVUDivExpr : public SCEV {
 252     friend class ScalarEvolution;
 253
 254     const SCEV *LHS;
 255     const SCEV *RHS;
 256     SCEVUDivExpr(const FoldingSetNodeIDRef ID, const SCEV *lhs, const SCEV *rhs)
 257       : SCEV(ID, scUDivExpr), LHS(lhs), RHS(rhs) {}
 258
 259   public:
 260     const SCEV *getLHS() const { return LHS; }
 261     const SCEV *getRHS() const { return RHS; }
 262
 263     Type *getType() const {
 264       // In most cases the types of LHS and RHS will be the same, but in some
 265       // crazy cases one or the other may be a pointer. ScalarEvolution doesn't
 266       // depend on the type for correctness, but handling types carefully can
 267       // avoid extra casts in the SCEVExpander. The LHS is more likely to be
 268       // a pointer type than the RHS, so use the RHS' type here.
 269       return getRHS()->getType();
 270     }
 271
 272     /// Methods for support type inquiry through isa, cast, and dyn_cast:
 273     static inline bool classof(const SCEV *S) {
 274       return S->getSCEVType() == scUDivExpr;
 275     }
 276   };
 277
 278
 279   //===--------------------------------------------------------------------===//
 280   /// SCEVAddRecExpr - This node represents a polynomial recurrence on the trip
 281   /// count of the specified loop.  This is the primary focus of the
 282   /// ScalarEvolution framework; all the other SCEV subclasses are mostly just
 283   /// supporting infrastructure to allow SCEVAddRecExpr expressions to be
 284   /// created and analyzed.
 285   ///
 286   /// All operands of an AddRec are required to be loop invariant.
 287   ///
 288   class SCEVAddRecExpr : public SCEVNAryExpr {
 289     friend class ScalarEvolution;
 290
 291     const Loop *L;
 292
 293     SCEVAddRecExpr(const FoldingSetNodeIDRef ID,
 294                    const SCEV *const *O, size_t N, const Loop *l)
 295       : SCEVNAryExpr(ID, scAddRecExpr, O, N), L(l) {}
 296
 297   public:
 298     const SCEV *getStart() const { return Operands[0]; }
 299     const Loop *getLoop() const { return L; }
 300
 301     /// getStepRecurrence - This method constructs and returns the recurrence
 302     /// indicating how much this expression steps by.  If this is a polynomial
 303     /// of degree N, it returns a chrec of degree N-1.
 304     /// We cannot determine whether the step recurrence has self-wraparound.
 305     const SCEV *getStepRecurrence(ScalarEvolution &SE) const {
 306       if (isAffine()) return getOperand(1);
 307       return SE.getAddRecExpr(SmallVector<const SCEV *, 3>(op_begin()+1,
 308                                                            op_end()),
 309                               getLoop(), FlagAnyWrap);
 310     }
 311
 312     /// isAffine - Return true if this is an affine AddRec (i.e., it represents
 313     /// an expressions A+B*x where A and B are loop invariant values.
 314     bool isAffine() const {
 315       // We know that the start value is invariant.  This expression is thus
 316       // affine iff the step is also invariant.
 317       return getNumOperands() == 2;
 318     }
 319
 320     /// isQuadratic - Return true if this is an quadratic AddRec (i.e., it
 321     /// represents an expressions A+B*x+C*x^2 where A, B and C are loop
 322     /// invariant values.  This corresponds to an addrec of the form {L,+,M,+,N}
 323     bool isQuadratic() const {
 324       return getNumOperands() == 3;
 325     }
 326
 327     /// Set flags for a recurrence without clearing any previously set flags.
 328     /// For AddRec, either NUW or NSW implies NW. Keep track of this fact here
 329     /// to make it easier to propagate flags.
 330     void setNoWrapFlags(NoWrapFlags Flags) {
 331       if (Flags & (FlagNUW | FlagNSW))
 332         Flags = ScalarEvolution::setFlags(Flags, FlagNW);
 333       SubclassData |= Flags;
 334     }
 335
 336     /// evaluateAtIteration - Return the value of this chain of recurrences at
 337     /// the specified iteration number.
 338     const SCEV *evaluateAtIteration(const SCEV *It, ScalarEvolution &SE) const;
 339
 340     /// getNumIterationsInRange - Return the number of iterations of this loop
 341     /// that produce values in the specified constant range.  Another way of
 342     /// looking at this is that it returns the first iteration number where the
 343     /// value is not in the condition, thus computing the exit count.  If the
 344     /// iteration count can't be computed, an instance of SCEVCouldNotCompute is
 345     /// returned.
 346     const SCEV *getNumIterationsInRange(ConstantRange Range,
 347                                        ScalarEvolution &SE) const;
 348
 349     /// getPostIncExpr - Return an expression representing the value of
 350     /// this expression one iteration of the loop ahead.
 351     const SCEVAddRecExpr *getPostIncExpr(ScalarEvolution &SE) const {
 352       return cast<SCEVAddRecExpr>(SE.getAddExpr(this, getStepRecurrence(SE)));
 353     }
 354
 355     /// Methods for support type inquiry through isa, cast, and dyn_cast:
 356     static inline bool classof(const SCEV *S) {
 357       return S->getSCEVType() == scAddRecExpr;
 358     }
 359
 360     /// Splits the SCEV into two vectors of SCEVs representing the subscripts
 361     /// and sizes of an array access. Returns the remainder of the
 362     /// delinearization that is the offset start of the array.
 363     const SCEV *delinearize(ScalarEvolution &SE,
 364                             SmallVectorImpl<const SCEV *> &Subscripts,
 365                             SmallVectorImpl<const SCEV *> &Sizes) const;
 366   };
 367
 368   //===--------------------------------------------------------------------===//
 369   /// SCEVSMaxExpr - This class represents a signed maximum selection.
 370   ///
 371   class SCEVSMaxExpr : public SCEVCommutativeExpr {
 372     friend class ScalarEvolution;
 373
 374     SCEVSMaxExpr(const FoldingSetNodeIDRef ID,
 375                  const SCEV *const *O, size_t N)
 376       : SCEVCommutativeExpr(ID, scSMaxExpr, O, N) {
 377       // Max never overflows.
 378       setNoWrapFlags((NoWrapFlags)(FlagNUW | FlagNSW));
 379     }
 380
 381   public:
 382     /// Methods for support type inquiry through isa, cast, and dyn_cast:
 383     static inline bool classof(const SCEV *S) {
 384       return S->getSCEVType() == scSMaxExpr;
 385     }
 386   };
 387
 388
 389   //===--------------------------------------------------------------------===//
 390   /// SCEVUMaxExpr - This class represents an unsigned maximum selection.
 391   ///
 392   class SCEVUMaxExpr : public SCEVCommutativeExpr {
 393     friend class ScalarEvolution;
 394
 395     SCEVUMaxExpr(const FoldingSetNodeIDRef ID,
 396                  const SCEV *const *O, size_t N)
 397       : SCEVCommutativeExpr(ID, scUMaxExpr, O, N) {
 398       // Max never overflows.
 399       setNoWrapFlags((NoWrapFlags)(FlagNUW | FlagNSW));
 400     }
 401
 402   public:
 403     /// Methods for support type inquiry through isa, cast, and dyn_cast:
 404     static inline bool classof(const SCEV *S) {
 405       return S->getSCEVType() == scUMaxExpr;
 406     }
 407   };
 408
 409   //===--------------------------------------------------------------------===//
 410   /// SCEVUnknown - This means that we are dealing with an entirely unknown SCEV
 411   /// value, and only represent it as its LLVM Value.  This is the "bottom"
 412   /// value for the analysis.
 413   ///
 414   class SCEVUnknown : public SCEV, private CallbackVH {
 415     friend class ScalarEvolution;
 416
 417     // Implement CallbackVH.
 418     void deleted() override;
 419     void allUsesReplacedWith(Value *New) override;
 420
 421     /// SE - The parent ScalarEvolution value. This is used to update
 422     /// the parent's maps when the value associated with a SCEVUnknown
 423     /// is deleted or RAUW'd.
 424     ScalarEvolution *SE;
 425
 426     /// Next - The next pointer in the linked list of all
 427     /// SCEVUnknown instances owned by a ScalarEvolution.
 428     SCEVUnknown *Next;
 429
 430     SCEVUnknown(const FoldingSetNodeIDRef ID, Value *V,
 431                 ScalarEvolution *se, SCEVUnknown *next) :
 432       SCEV(ID, scUnknown), CallbackVH(V), SE(se), Next(next) {}
 433
 434   public:
 435     Value *getValue() const { return getValPtr(); }
 436
 437     /// isSizeOf, isAlignOf, isOffsetOf - Test whether this is a special
 438     /// constant representing a type size, alignment, or field offset in
 439     /// a target-independent manner, and hasn't happened to have been
 440     /// folded with other operations into something unrecognizable. This
 441     /// is mainly only useful for pretty-printing and other situations
 442     /// where it isn't absolutely required for these to succeed.
 443     bool isSizeOf(Type *&AllocTy) const;
 444     bool isAlignOf(Type *&AllocTy) const;
 445     bool isOffsetOf(Type *&STy, Constant *&FieldNo) const;
 446
 447     Type *getType() const { return getValPtr()->getType(); }
 448
 449     /// Methods for support type inquiry through isa, cast, and dyn_cast:
 450     static inline bool classof(const SCEV *S) {
 451       return S->getSCEVType() == scUnknown;
 452     }
 453   };
 454
 455   /// SCEVVisitor - This class defines a simple visitor class that may be used
 456   /// for various SCEV analysis purposes.
 457   template<typename SC, typename RetVal=void>
 458   struct SCEVVisitor {
 459     RetVal visit(const SCEV *S) {
 460       switch (S->getSCEVType()) {
 461       case scConstant:
 462         return ((SC*)this)->visitConstant((const SCEVConstant*)S);
 463       case scTruncate:
 464         return ((SC*)this)->visitTruncateExpr((const SCEVTruncateExpr*)S);
 465       case scZeroExtend:
 466         return ((SC*)this)->visitZeroExtendExpr((const SCEVZeroExtendExpr*)S);
 467       case scSignExtend:
 468         return ((SC*)this)->visitSignExtendExpr((const SCEVSignExtendExpr*)S);
 469       case scAddExpr:
 470         return ((SC*)this)->visitAddExpr((const SCEVAddExpr*)S);
 471       case scMulExpr:
 472         return ((SC*)this)->visitMulExpr((const SCEVMulExpr*)S);
 473       case scUDivExpr:
 474         return ((SC*)this)->visitUDivExpr((const SCEVUDivExpr*)S);
 475       case scAddRecExpr:
 476         return ((SC*)this)->visitAddRecExpr((const SCEVAddRecExpr*)S);
 477       case scSMaxExpr:
 478         return ((SC*)this)->visitSMaxExpr((const SCEVSMaxExpr*)S);
 479       case scUMaxExpr:
 480         return ((SC*)this)->visitUMaxExpr((const SCEVUMaxExpr*)S);
 481       case scUnknown:
 482         return ((SC*)this)->visitUnknown((const SCEVUnknown*)S);
 483       case scCouldNotCompute:
 484         return ((SC*)this)->visitCouldNotCompute((const SCEVCouldNotCompute*)S);
 485       default:
 486         llvm_unreachable("Unknown SCEV type!");
 487       }
 488     }
 489
 490     RetVal visitCouldNotCompute(const SCEVCouldNotCompute *S) {
 491       llvm_unreachable("Invalid use of SCEVCouldNotCompute!");
 492     }
 493   };
 494
 495   /// Visit all nodes in the expression tree using worklist traversal.
 496   ///
 497   /// Visitor implements:
 498   ///   // return true to follow this node.
 499   ///   bool follow(const SCEV *S);
 500   ///   // return true to terminate the search.
 501   ///   bool isDone();
 502   template<typename SV>
 503   class SCEVTraversal {
 504     SV &Visitor;
 505     SmallVector<const SCEV *, 8> Worklist;
 506     SmallPtrSet<const SCEV *, 8> Visited;
 507
 508     void push(const SCEV *S) {
 509       if (Visited.insert(S) && Visitor.follow(S))
 510         Worklist.push_back(S);
 511     }
 512   public:
 513     SCEVTraversal(SV& V): Visitor(V) {}
 514
 515     void visitAll(const SCEV *Root) {
 516       push(Root);
 517       while (!Worklist.empty() && !Visitor.isDone()) {
 518         const SCEV *S = Worklist.pop_back_val();
 519
 520         switch (S->getSCEVType()) {
 521         case scConstant:
 522         case scUnknown:
 523           break;
 524         case scTruncate:
 525         case scZeroExtend:
 526         case scSignExtend:
 527           push(cast<SCEVCastExpr>(S)->getOperand());
 528           break;
 529         case scAddExpr:
 530         case scMulExpr:
 531         case scSMaxExpr:
 532         case scUMaxExpr:
 533         case scAddRecExpr: {
 534           const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
 535           for (SCEVNAryExpr::op_iterator I = NAry->op_begin(),
 536                  E = NAry->op_end(); I != E; ++I) {
 537             push(*I);
 538           }
 539           break;
 540         }
 541         case scUDivExpr: {
 542           const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
 543           push(UDiv->getLHS());
 544           push(UDiv->getRHS());
 545           break;
 546         }
 547         case scCouldNotCompute:
 548           llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
 549         default:
 550           llvm_unreachable("Unknown SCEV kind!");
 551         }
 552       }
 553     }
 554   };
 555
 556   /// Use SCEVTraversal to visit all nodes in the givien expression tree.
 557   template<typename SV>
 558   void visitAll(const SCEV *Root, SV& Visitor) {
 559     SCEVTraversal<SV> T(Visitor);
 560     T.visitAll(Root);
 561   }
 562
 563   typedef DenseMap<const Value*, Value*> ValueToValueMap;
 564
 565   /// The SCEVParameterRewriter takes a scalar evolution expression and updates
 566   /// the SCEVUnknown components following the Map (Value -> Value).
 567   struct SCEVParameterRewriter
 568     : public SCEVVisitor<SCEVParameterRewriter, const SCEV*> {
 569   public:
 570     static const SCEV *rewrite(const SCEV *Scev, ScalarEvolution &SE,
 571                                ValueToValueMap &Map,
 572                                bool InterpretConsts = false) {
 573       SCEVParameterRewriter Rewriter(SE, Map, InterpretConsts);
 574       return Rewriter.visit(Scev);
 575     }
 576
 577     SCEVParameterRewriter(ScalarEvolution &S, ValueToValueMap &M, bool C)
 578       : SE(S), Map(M), InterpretConsts(C) {}
 579
 580     const SCEV *visitConstant(const SCEVConstant *Constant) {
 581       return Constant;
 582     }
 583
 584     const SCEV *visitTruncateExpr(const SCEVTruncateExpr *Expr) {
 585       const SCEV *Operand = visit(Expr->getOperand());
 586       return SE.getTruncateExpr(Operand, Expr->getType());
 587     }
 588
 589     const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) {
 590       const SCEV *Operand = visit(Expr->getOperand());
 591       return SE.getZeroExtendExpr(Operand, Expr->getType());
 592     }
 593
 594     const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *Expr) {
 595       const SCEV *Operand = visit(Expr->getOperand());
 596       return SE.getSignExtendExpr(Operand, Expr->getType());
 597     }
 598
 599     const SCEV *visitAddExpr(const SCEVAddExpr *Expr) {
 600       SmallVector<const SCEV *, 2> Operands;
 601       for (int i = 0, e = Expr->getNumOperands(); i < e; ++i)
 602         Operands.push_back(visit(Expr->getOperand(i)));
 603       return SE.getAddExpr(Operands);
 604     }
 605
 606     const SCEV *visitMulExpr(const SCEVMulExpr *Expr) {
 607       SmallVector<const SCEV *, 2> Operands;
 608       for (int i = 0, e = Expr->getNumOperands(); i < e; ++i)
 609         Operands.push_back(visit(Expr->getOperand(i)));
 610       return SE.getMulExpr(Operands);
 611     }
 612
 613     const SCEV *visitUDivExpr(const SCEVUDivExpr *Expr) {
 614       return SE.getUDivExpr(visit(Expr->getLHS()), visit(Expr->getRHS()));
 615     }
 616
 617     const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) {
 618       SmallVector<const SCEV *, 2> Operands;
 619       for (int i = 0, e = Expr->getNumOperands(); i < e; ++i)
 620         Operands.push_back(visit(Expr->getOperand(i)));
 621       return SE.getAddRecExpr(Operands, Expr->getLoop(),
 622                               Expr->getNoWrapFlags());
 623     }
 624
 625     const SCEV *visitSMaxExpr(const SCEVSMaxExpr *Expr) {
 626       SmallVector<const SCEV *, 2> Operands;
 627       for (int i = 0, e = Expr->getNumOperands(); i < e; ++i)
 628         Operands.push_back(visit(Expr->getOperand(i)));
 629       return SE.getSMaxExpr(Operands);
 630     }
 631
 632     const SCEV *visitUMaxExpr(const SCEVUMaxExpr *Expr) {
 633       SmallVector<const SCEV *, 2> Operands;
 634       for (int i = 0, e = Expr->getNumOperands(); i < e; ++i)
 635         Operands.push_back(visit(Expr->getOperand(i)));
 636       return SE.getUMaxExpr(Operands);
 637     }
 638
 639     const SCEV *visitUnknown(const SCEVUnknown *Expr) {
 640       Value *V = Expr->getValue();
 641       if (Map.count(V)) {
 642         Value *NV = Map[V];
 643         if (InterpretConsts && isa<ConstantInt>(NV))
 644           return SE.getConstant(cast<ConstantInt>(NV));
 645         return SE.getUnknown(NV);
 646       }
 647       return Expr;
 648     }
 649
 650     const SCEV *visitCouldNotCompute(const SCEVCouldNotCompute *Expr) {
 651       return Expr;
 652     }
 653
 654   private:
 655     ScalarEvolution &SE;
 656     ValueToValueMap &Map;
 657     bool InterpretConsts;
 658   };
 659
 660   typedef DenseMap<const Loop*, const SCEV*> LoopToScevMapT;
 661
 662   /// The SCEVApplyRewriter takes a scalar evolution expression and applies
 663   /// the Map (Loop -> SCEV) to all AddRecExprs.
 664   struct SCEVApplyRewriter
 665     : public SCEVVisitor<SCEVApplyRewriter, const SCEV*> {
 666   public:
 667     static const SCEV *rewrite(const SCEV *Scev, LoopToScevMapT &Map,
 668                                ScalarEvolution &SE) {
 669       SCEVApplyRewriter Rewriter(SE, Map);
 670       return Rewriter.visit(Scev);
 671     }
 672
 673     SCEVApplyRewriter(ScalarEvolution &S, LoopToScevMapT &M)
 674       : SE(S), Map(M) {}
 675
 676     const SCEV *visitConstant(const SCEVConstant *Constant) {
 677       return Constant;
 678     }
 679
 680     const SCEV *visitTruncateExpr(const SCEVTruncateExpr *Expr) {
 681       const SCEV *Operand = visit(Expr->getOperand());
 682       return SE.getTruncateExpr(Operand, Expr->getType());
 683     }
 684
 685     const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) {
 686       const SCEV *Operand = visit(Expr->getOperand());
 687       return SE.getZeroExtendExpr(Operand, Expr->getType());
 688     }
 689
 690     const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *Expr) {
 691       const SCEV *Operand = visit(Expr->getOperand());
 692       return SE.getSignExtendExpr(Operand, Expr->getType());
 693     }
 694
 695     const SCEV *visitAddExpr(const SCEVAddExpr *Expr) {
 696       SmallVector<const SCEV *, 2> Operands;
 697       for (int i = 0, e = Expr->getNumOperands(); i < e; ++i)
 698         Operands.push_back(visit(Expr->getOperand(i)));
 699       return SE.getAddExpr(Operands);
 700     }
 701
 702     const SCEV *visitMulExpr(const SCEVMulExpr *Expr) {
 703       SmallVector<const SCEV *, 2> Operands;
 704       for (int i = 0, e = Expr->getNumOperands(); i < e; ++i)
 705         Operands.push_back(visit(Expr->getOperand(i)));
 706       return SE.getMulExpr(Operands);
 707     }
 708
 709     const SCEV *visitUDivExpr(const SCEVUDivExpr *Expr) {
 710       return SE.getUDivExpr(visit(Expr->getLHS()), visit(Expr->getRHS()));
 711     }
 712
 713     const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) {
 714       SmallVector<const SCEV *, 2> Operands;
 715       for (int i = 0, e = Expr->getNumOperands(); i < e; ++i)
 716         Operands.push_back(visit(Expr->getOperand(i)));
 717
 718       const Loop *L = Expr->getLoop();
 719       const SCEV *Res = SE.getAddRecExpr(Operands, L, Expr->getNoWrapFlags());
 720
 721       if (0 == Map.count(L))
 722         return Res;
 723
 724       const SCEVAddRecExpr *Rec = (const SCEVAddRecExpr *) Res;
 725       return Rec->evaluateAtIteration(Map[L], SE);
 726     }
 727
 728     const SCEV *visitSMaxExpr(const SCEVSMaxExpr *Expr) {
 729       SmallVector<const SCEV *, 2> Operands;
 730       for (int i = 0, e = Expr->getNumOperands(); i < e; ++i)
 731         Operands.push_back(visit(Expr->getOperand(i)));
 732       return SE.getSMaxExpr(Operands);
 733     }
 734
 735     const SCEV *visitUMaxExpr(const SCEVUMaxExpr *Expr) {
 736       SmallVector<const SCEV *, 2> Operands;
 737       for (int i = 0, e = Expr->getNumOperands(); i < e; ++i)
 738         Operands.push_back(visit(Expr->getOperand(i)));
 739       return SE.getUMaxExpr(Operands);
 740     }
 741
 742     const SCEV *visitUnknown(const SCEVUnknown *Expr) {
 743       return Expr;
 744     }
 745
 746     const SCEV *visitCouldNotCompute(const SCEVCouldNotCompute *Expr) {
 747       return Expr;
 748     }
 749
 750   private:
 751     ScalarEvolution &SE;
 752     LoopToScevMapT &Map;
 753   };
 754
 755 /// Applies the Map (Loop -> SCEV) to the given Scev.
 756 static inline const SCEV *apply(const SCEV *Scev, LoopToScevMapT &Map,
 757                                 ScalarEvolution &SE) {
 758   return SCEVApplyRewriter::rewrite(Scev, Map, SE);
 759 }
 760
 761 }
 762
 763 #endif