Implement Transforms/IndVarsSimplify/complex-scev.ll, a case where we didn't
[oota-llvm.git] / lib / Analysis / ScalarEvolution.cpp
1 //===- ScalarEvolution.cpp - Scalar Evolution Analysis ----------*- 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 contains the implementation of the scalar evolution analysis
11 // engine, which is used primarily to analyze expressions involving induction
12 // variables in loops.
13 //
14 // There are several aspects to this library.  First is the representation of
15 // scalar expressions, which are represented as subclasses of the SCEV class.
16 // These classes are used to represent certain types of subexpressions that we
17 // can handle.  These classes are reference counted, managed by the SCEVHandle
18 // class.  We only create one SCEV of a particular shape, so pointer-comparisons
19 // for equality are legal.
20 //
21 // One important aspect of the SCEV objects is that they are never cyclic, even
22 // if there is a cycle in the dataflow for an expression (ie, a PHI node).  If
23 // the PHI node is one of the idioms that we can represent (e.g., a polynomial
24 // recurrence) then we represent it directly as a recurrence node, otherwise we
25 // represent it as a SCEVUnknown node.
26 //
27 // In addition to being able to represent expressions of various types, we also
28 // have folders that are used to build the *canonical* representation for a
29 // particular expression.  These folders are capable of using a variety of
30 // rewrite rules to simplify the expressions.
31 //
32 // Once the folders are defined, we can implement the more interesting
33 // higher-level code, such as the code that recognizes PHI nodes of various
34 // types, computes the execution count of a loop, etc.
35 //
36 // TODO: We should use these routines and value representations to implement
37 // dependence analysis!
38 //
39 //===----------------------------------------------------------------------===//
40 //
41 // There are several good references for the techniques used in this analysis.
42 //
43 //  Chains of recurrences -- a method to expedite the evaluation
44 //  of closed-form functions
45 //  Olaf Bachmann, Paul S. Wang, Eugene V. Zima
46 //
47 //  On computational properties of chains of recurrences
48 //  Eugene V. Zima
49 //
50 //  Symbolic Evaluation of Chains of Recurrences for Loop Optimization
51 //  Robert A. van Engelen
52 //
53 //  Efficient Symbolic Analysis for Optimizing Compilers
54 //  Robert A. van Engelen
55 //
56 //  Using the chains of recurrences algebra for data dependence testing and
57 //  induction variable substitution
58 //  MS Thesis, Johnie Birch
59 //
60 //===----------------------------------------------------------------------===//
61
62 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
63 #include "llvm/Constants.h"
64 #include "llvm/DerivedTypes.h"
65 #include "llvm/GlobalVariable.h"
66 #include "llvm/Instructions.h"
67 #include "llvm/Analysis/ConstantFolding.h"
68 #include "llvm/Analysis/LoopInfo.h"
69 #include "llvm/Assembly/Writer.h"
70 #include "llvm/Transforms/Scalar.h"
71 #include "llvm/Support/CFG.h"
72 #include "llvm/Support/ConstantRange.h"
73 #include "llvm/Support/InstIterator.h"
74 #include "llvm/Support/CommandLine.h"
75 #include "llvm/ADT/Statistic.h"
76 #include <cmath>
77 #include <iostream>
78 #include <algorithm>
79 using namespace llvm;
80
81 namespace {
82   RegisterAnalysis<ScalarEvolution>
83   R("scalar-evolution", "Scalar Evolution Analysis");
84
85   Statistic<>
86   NumBruteForceEvaluations("scalar-evolution",
87                            "Number of brute force evaluations needed to "
88                            "calculate high-order polynomial exit values");
89   Statistic<>
90   NumArrayLenItCounts("scalar-evolution",
91                       "Number of trip counts computed with array length");
92   Statistic<>
93   NumTripCountsComputed("scalar-evolution",
94                         "Number of loops with predictable loop counts");
95   Statistic<>
96   NumTripCountsNotComputed("scalar-evolution",
97                            "Number of loops without predictable loop counts");
98   Statistic<>
99   NumBruteForceTripCountsComputed("scalar-evolution",
100                         "Number of loops with trip counts computed by force");
101
102   cl::opt<unsigned>
103   MaxBruteForceIterations("scalar-evolution-max-iterations", cl::ReallyHidden,
104                           cl::desc("Maximum number of iterations SCEV will "
105                               "symbolically execute a constant derived loop"),
106                           cl::init(100));
107 }
108
109 //===----------------------------------------------------------------------===//
110 //                           SCEV class definitions
111 //===----------------------------------------------------------------------===//
112
113 //===----------------------------------------------------------------------===//
114 // Implementation of the SCEV class.
115 //
116 SCEV::~SCEV() {}
117 void SCEV::dump() const {
118   print(std::cerr);
119 }
120
121 /// getValueRange - Return the tightest constant bounds that this value is
122 /// known to have.  This method is only valid on integer SCEV objects.
123 ConstantRange SCEV::getValueRange() const {
124   const Type *Ty = getType();
125   assert(Ty->isInteger() && "Can't get range for a non-integer SCEV!");
126   Ty = Ty->getUnsignedVersion();
127   // Default to a full range if no better information is available.
128   return ConstantRange(getType());
129 }
130
131
132 SCEVCouldNotCompute::SCEVCouldNotCompute() : SCEV(scCouldNotCompute) {}
133
134 bool SCEVCouldNotCompute::isLoopInvariant(const Loop *L) const {
135   assert(0 && "Attempt to use a SCEVCouldNotCompute object!");
136   return false;
137 }
138
139 const Type *SCEVCouldNotCompute::getType() const {
140   assert(0 && "Attempt to use a SCEVCouldNotCompute object!");
141   return 0;
142 }
143
144 bool SCEVCouldNotCompute::hasComputableLoopEvolution(const Loop *L) const {
145   assert(0 && "Attempt to use a SCEVCouldNotCompute object!");
146   return false;
147 }
148
149 SCEVHandle SCEVCouldNotCompute::
150 replaceSymbolicValuesWithConcrete(const SCEVHandle &Sym,
151                                   const SCEVHandle &Conc) const {
152   return this;
153 }
154
155 void SCEVCouldNotCompute::print(std::ostream &OS) const {
156   OS << "***COULDNOTCOMPUTE***";
157 }
158
159 bool SCEVCouldNotCompute::classof(const SCEV *S) {
160   return S->getSCEVType() == scCouldNotCompute;
161 }
162
163
164 // SCEVConstants - Only allow the creation of one SCEVConstant for any
165 // particular value.  Don't use a SCEVHandle here, or else the object will
166 // never be deleted!
167 static std::map<ConstantInt*, SCEVConstant*> SCEVConstants;
168
169
170 SCEVConstant::~SCEVConstant() {
171   SCEVConstants.erase(V);
172 }
173
174 SCEVHandle SCEVConstant::get(ConstantInt *V) {
175   // Make sure that SCEVConstant instances are all unsigned.
176   if (V->getType()->isSigned()) {
177     const Type *NewTy = V->getType()->getUnsignedVersion();
178     V = cast<ConstantUInt>(ConstantExpr::getCast(V, NewTy));
179   }
180
181   SCEVConstant *&R = SCEVConstants[V];
182   if (R == 0) R = new SCEVConstant(V);
183   return R;
184 }
185
186 ConstantRange SCEVConstant::getValueRange() const {
187   return ConstantRange(V);
188 }
189
190 const Type *SCEVConstant::getType() const { return V->getType(); }
191
192 void SCEVConstant::print(std::ostream &OS) const {
193   WriteAsOperand(OS, V, false);
194 }
195
196 // SCEVTruncates - Only allow the creation of one SCEVTruncateExpr for any
197 // particular input.  Don't use a SCEVHandle here, or else the object will
198 // never be deleted!
199 static std::map<std::pair<SCEV*, const Type*>, SCEVTruncateExpr*> SCEVTruncates;
200
201 SCEVTruncateExpr::SCEVTruncateExpr(const SCEVHandle &op, const Type *ty)
202   : SCEV(scTruncate), Op(op), Ty(ty) {
203   assert(Op->getType()->isInteger() && Ty->isInteger() &&
204          Ty->isUnsigned() &&
205          "Cannot truncate non-integer value!");
206   assert(Op->getType()->getPrimitiveSize() > Ty->getPrimitiveSize() &&
207          "This is not a truncating conversion!");
208 }
209
210 SCEVTruncateExpr::~SCEVTruncateExpr() {
211   SCEVTruncates.erase(std::make_pair(Op, Ty));
212 }
213
214 ConstantRange SCEVTruncateExpr::getValueRange() const {
215   return getOperand()->getValueRange().truncate(getType());
216 }
217
218 void SCEVTruncateExpr::print(std::ostream &OS) const {
219   OS << "(truncate " << *Op << " to " << *Ty << ")";
220 }
221
222 // SCEVZeroExtends - Only allow the creation of one SCEVZeroExtendExpr for any
223 // particular input.  Don't use a SCEVHandle here, or else the object will never
224 // be deleted!
225 static std::map<std::pair<SCEV*, const Type*>,
226                 SCEVZeroExtendExpr*> SCEVZeroExtends;
227
228 SCEVZeroExtendExpr::SCEVZeroExtendExpr(const SCEVHandle &op, const Type *ty)
229   : SCEV(scTruncate), Op(op), Ty(ty) {
230   assert(Op->getType()->isInteger() && Ty->isInteger() &&
231          Ty->isUnsigned() &&
232          "Cannot zero extend non-integer value!");
233   assert(Op->getType()->getPrimitiveSize() < Ty->getPrimitiveSize() &&
234          "This is not an extending conversion!");
235 }
236
237 SCEVZeroExtendExpr::~SCEVZeroExtendExpr() {
238   SCEVZeroExtends.erase(std::make_pair(Op, Ty));
239 }
240
241 ConstantRange SCEVZeroExtendExpr::getValueRange() const {
242   return getOperand()->getValueRange().zeroExtend(getType());
243 }
244
245 void SCEVZeroExtendExpr::print(std::ostream &OS) const {
246   OS << "(zeroextend " << *Op << " to " << *Ty << ")";
247 }
248
249 // SCEVCommExprs - Only allow the creation of one SCEVCommutativeExpr for any
250 // particular input.  Don't use a SCEVHandle here, or else the object will never
251 // be deleted!
252 static std::map<std::pair<unsigned, std::vector<SCEV*> >,
253                 SCEVCommutativeExpr*> SCEVCommExprs;
254
255 SCEVCommutativeExpr::~SCEVCommutativeExpr() {
256   SCEVCommExprs.erase(std::make_pair(getSCEVType(),
257                                      std::vector<SCEV*>(Operands.begin(),
258                                                         Operands.end())));
259 }
260
261 void SCEVCommutativeExpr::print(std::ostream &OS) const {
262   assert(Operands.size() > 1 && "This plus expr shouldn't exist!");
263   const char *OpStr = getOperationStr();
264   OS << "(" << *Operands[0];
265   for (unsigned i = 1, e = Operands.size(); i != e; ++i)
266     OS << OpStr << *Operands[i];
267   OS << ")";
268 }
269
270 SCEVHandle SCEVCommutativeExpr::
271 replaceSymbolicValuesWithConcrete(const SCEVHandle &Sym,
272                                   const SCEVHandle &Conc) const {
273   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
274     SCEVHandle H = getOperand(i)->replaceSymbolicValuesWithConcrete(Sym, Conc);
275     if (H != getOperand(i)) {
276       std::vector<SCEVHandle> NewOps;
277       NewOps.reserve(getNumOperands());
278       for (unsigned j = 0; j != i; ++j)
279         NewOps.push_back(getOperand(j));
280       NewOps.push_back(H);
281       for (++i; i != e; ++i)
282         NewOps.push_back(getOperand(i)->
283                          replaceSymbolicValuesWithConcrete(Sym, Conc));
284
285       if (isa<SCEVAddExpr>(this))
286         return SCEVAddExpr::get(NewOps);
287       else if (isa<SCEVMulExpr>(this))
288         return SCEVMulExpr::get(NewOps);
289       else
290         assert(0 && "Unknown commutative expr!");
291     }
292   }
293   return this;
294 }
295
296
297 // SCEVSDivs - Only allow the creation of one SCEVSDivExpr for any particular
298 // input.  Don't use a SCEVHandle here, or else the object will never be
299 // deleted!
300 static std::map<std::pair<SCEV*, SCEV*>, SCEVSDivExpr*> SCEVSDivs;
301
302 SCEVSDivExpr::~SCEVSDivExpr() {
303   SCEVSDivs.erase(std::make_pair(LHS, RHS));
304 }
305
306 void SCEVSDivExpr::print(std::ostream &OS) const {
307   OS << "(" << *LHS << " /s " << *RHS << ")";
308 }
309
310 const Type *SCEVSDivExpr::getType() const {
311   const Type *Ty = LHS->getType();
312   if (Ty->isUnsigned()) Ty = Ty->getSignedVersion();
313   return Ty;
314 }
315
316 // SCEVAddRecExprs - Only allow the creation of one SCEVAddRecExpr for any
317 // particular input.  Don't use a SCEVHandle here, or else the object will never
318 // be deleted!
319 static std::map<std::pair<const Loop *, std::vector<SCEV*> >,
320                 SCEVAddRecExpr*> SCEVAddRecExprs;
321
322 SCEVAddRecExpr::~SCEVAddRecExpr() {
323   SCEVAddRecExprs.erase(std::make_pair(L,
324                                        std::vector<SCEV*>(Operands.begin(),
325                                                           Operands.end())));
326 }
327
328 SCEVHandle SCEVAddRecExpr::
329 replaceSymbolicValuesWithConcrete(const SCEVHandle &Sym,
330                                   const SCEVHandle &Conc) const {
331   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
332     SCEVHandle H = getOperand(i)->replaceSymbolicValuesWithConcrete(Sym, Conc);
333     if (H != getOperand(i)) {
334       std::vector<SCEVHandle> NewOps;
335       NewOps.reserve(getNumOperands());
336       for (unsigned j = 0; j != i; ++j)
337         NewOps.push_back(getOperand(j));
338       NewOps.push_back(H);
339       for (++i; i != e; ++i)
340         NewOps.push_back(getOperand(i)->
341                          replaceSymbolicValuesWithConcrete(Sym, Conc));
342
343       return get(NewOps, L);
344     }
345   }
346   return this;
347 }
348
349
350 bool SCEVAddRecExpr::isLoopInvariant(const Loop *QueryLoop) const {
351   // This recurrence is invariant w.r.t to QueryLoop iff QueryLoop doesn't
352   // contain L and if the start is invariant.
353   return !QueryLoop->contains(L->getHeader()) &&
354          getOperand(0)->isLoopInvariant(QueryLoop);
355 }
356
357
358 void SCEVAddRecExpr::print(std::ostream &OS) const {
359   OS << "{" << *Operands[0];
360   for (unsigned i = 1, e = Operands.size(); i != e; ++i)
361     OS << ",+," << *Operands[i];
362   OS << "}<" << L->getHeader()->getName() + ">";
363 }
364
365 // SCEVUnknowns - Only allow the creation of one SCEVUnknown for any particular
366 // value.  Don't use a SCEVHandle here, or else the object will never be
367 // deleted!
368 static std::map<Value*, SCEVUnknown*> SCEVUnknowns;
369
370 SCEVUnknown::~SCEVUnknown() { SCEVUnknowns.erase(V); }
371
372 bool SCEVUnknown::isLoopInvariant(const Loop *L) const {
373   // All non-instruction values are loop invariant.  All instructions are loop
374   // invariant if they are not contained in the specified loop.
375   if (Instruction *I = dyn_cast<Instruction>(V))
376     return !L->contains(I->getParent());
377   return true;
378 }
379
380 const Type *SCEVUnknown::getType() const {
381   return V->getType();
382 }
383
384 void SCEVUnknown::print(std::ostream &OS) const {
385   WriteAsOperand(OS, V, false);
386 }
387
388 //===----------------------------------------------------------------------===//
389 //                               SCEV Utilities
390 //===----------------------------------------------------------------------===//
391
392 namespace {
393   /// SCEVComplexityCompare - Return true if the complexity of the LHS is less
394   /// than the complexity of the RHS.  This comparator is used to canonicalize
395   /// expressions.
396   struct SCEVComplexityCompare {
397     bool operator()(SCEV *LHS, SCEV *RHS) {
398       return LHS->getSCEVType() < RHS->getSCEVType();
399     }
400   };
401 }
402
403 /// GroupByComplexity - Given a list of SCEV objects, order them by their
404 /// complexity, and group objects of the same complexity together by value.
405 /// When this routine is finished, we know that any duplicates in the vector are
406 /// consecutive and that complexity is monotonically increasing.
407 ///
408 /// Note that we go take special precautions to ensure that we get determinstic
409 /// results from this routine.  In other words, we don't want the results of
410 /// this to depend on where the addresses of various SCEV objects happened to
411 /// land in memory.
412 ///
413 static void GroupByComplexity(std::vector<SCEVHandle> &Ops) {
414   if (Ops.size() < 2) return;  // Noop
415   if (Ops.size() == 2) {
416     // This is the common case, which also happens to be trivially simple.
417     // Special case it.
418     if (Ops[0]->getSCEVType() > Ops[1]->getSCEVType())
419       std::swap(Ops[0], Ops[1]);
420     return;
421   }
422
423   // Do the rough sort by complexity.
424   std::sort(Ops.begin(), Ops.end(), SCEVComplexityCompare());
425
426   // Now that we are sorted by complexity, group elements of the same
427   // complexity.  Note that this is, at worst, N^2, but the vector is likely to
428   // be extremely short in practice.  Note that we take this approach because we
429   // do not want to depend on the addresses of the objects we are grouping.
430   for (unsigned i = 0, e = Ops.size(); i != e-2; ++i) {
431     SCEV *S = Ops[i];
432     unsigned Complexity = S->getSCEVType();
433
434     // If there are any objects of the same complexity and same value as this
435     // one, group them.
436     for (unsigned j = i+1; j != e && Ops[j]->getSCEVType() == Complexity; ++j) {
437       if (Ops[j] == S) { // Found a duplicate.
438         // Move it to immediately after i'th element.
439         std::swap(Ops[i+1], Ops[j]);
440         ++i;   // no need to rescan it.
441         if (i == e-2) return;  // Done!
442       }
443     }
444   }
445 }
446
447
448
449 //===----------------------------------------------------------------------===//
450 //                      Simple SCEV method implementations
451 //===----------------------------------------------------------------------===//
452
453 /// getIntegerSCEV - Given an integer or FP type, create a constant for the
454 /// specified signed integer value and return a SCEV for the constant.
455 SCEVHandle SCEVUnknown::getIntegerSCEV(int Val, const Type *Ty) {
456   Constant *C;
457   if (Val == 0)
458     C = Constant::getNullValue(Ty);
459   else if (Ty->isFloatingPoint())
460     C = ConstantFP::get(Ty, Val);
461   else if (Ty->isSigned())
462     C = ConstantSInt::get(Ty, Val);
463   else {
464     C = ConstantSInt::get(Ty->getSignedVersion(), Val);
465     C = ConstantExpr::getCast(C, Ty);
466   }
467   return SCEVUnknown::get(C);
468 }
469
470 /// getTruncateOrZeroExtend - Return a SCEV corresponding to a conversion of the
471 /// input value to the specified type.  If the type must be extended, it is zero
472 /// extended.
473 static SCEVHandle getTruncateOrZeroExtend(const SCEVHandle &V, const Type *Ty) {
474   const Type *SrcTy = V->getType();
475   assert(SrcTy->isInteger() && Ty->isInteger() &&
476          "Cannot truncate or zero extend with non-integer arguments!");
477   if (SrcTy->getPrimitiveSize() == Ty->getPrimitiveSize())
478     return V;  // No conversion
479   if (SrcTy->getPrimitiveSize() > Ty->getPrimitiveSize())
480     return SCEVTruncateExpr::get(V, Ty);
481   return SCEVZeroExtendExpr::get(V, Ty);
482 }
483
484 /// getNegativeSCEV - Return a SCEV corresponding to -V = -1*V
485 ///
486 SCEVHandle SCEV::getNegativeSCEV(const SCEVHandle &V) {
487   if (SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
488     return SCEVUnknown::get(ConstantExpr::getNeg(VC->getValue()));
489
490   return SCEVMulExpr::get(V, SCEVUnknown::getIntegerSCEV(-1, V->getType()));
491 }
492
493 /// getMinusSCEV - Return a SCEV corresponding to LHS - RHS.
494 ///
495 SCEVHandle SCEV::getMinusSCEV(const SCEVHandle &LHS, const SCEVHandle &RHS) {
496   // X - Y --> X + -Y
497   return SCEVAddExpr::get(LHS, SCEV::getNegativeSCEV(RHS));
498 }
499
500
501 /// PartialFact - Compute V!/(V-NumSteps)!
502 static SCEVHandle PartialFact(SCEVHandle V, unsigned NumSteps) {
503   // Handle this case efficiently, it is common to have constant iteration
504   // counts while computing loop exit values.
505   if (SCEVConstant *SC = dyn_cast<SCEVConstant>(V)) {
506     uint64_t Val = SC->getValue()->getRawValue();
507     uint64_t Result = 1;
508     for (; NumSteps; --NumSteps)
509       Result *= Val-(NumSteps-1);
510     Constant *Res = ConstantUInt::get(Type::ULongTy, Result);
511     return SCEVUnknown::get(ConstantExpr::getCast(Res, V->getType()));
512   }
513
514   const Type *Ty = V->getType();
515   if (NumSteps == 0)
516     return SCEVUnknown::getIntegerSCEV(1, Ty);
517
518   SCEVHandle Result = V;
519   for (unsigned i = 1; i != NumSteps; ++i)
520     Result = SCEVMulExpr::get(Result, SCEV::getMinusSCEV(V,
521                                           SCEVUnknown::getIntegerSCEV(i, Ty)));
522   return Result;
523 }
524
525
526 /// evaluateAtIteration - Return the value of this chain of recurrences at
527 /// the specified iteration number.  We can evaluate this recurrence by
528 /// multiplying each element in the chain by the binomial coefficient
529 /// corresponding to it.  In other words, we can evaluate {A,+,B,+,C,+,D} as:
530 ///
531 ///   A*choose(It, 0) + B*choose(It, 1) + C*choose(It, 2) + D*choose(It, 3)
532 ///
533 /// FIXME/VERIFY: I don't trust that this is correct in the face of overflow.
534 /// Is the binomial equation safe using modular arithmetic??
535 ///
536 SCEVHandle SCEVAddRecExpr::evaluateAtIteration(SCEVHandle It) const {
537   SCEVHandle Result = getStart();
538   int Divisor = 1;
539   const Type *Ty = It->getType();
540   for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
541     SCEVHandle BC = PartialFact(It, i);
542     Divisor *= i;
543     SCEVHandle Val = SCEVSDivExpr::get(SCEVMulExpr::get(BC, getOperand(i)),
544                                        SCEVUnknown::getIntegerSCEV(Divisor,Ty));
545     Result = SCEVAddExpr::get(Result, Val);
546   }
547   return Result;
548 }
549
550
551 //===----------------------------------------------------------------------===//
552 //                    SCEV Expression folder implementations
553 //===----------------------------------------------------------------------===//
554
555 SCEVHandle SCEVTruncateExpr::get(const SCEVHandle &Op, const Type *Ty) {
556   if (SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
557     return SCEVUnknown::get(ConstantExpr::getCast(SC->getValue(), Ty));
558
559   // If the input value is a chrec scev made out of constants, truncate
560   // all of the constants.
561   if (SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) {
562     std::vector<SCEVHandle> Operands;
563     for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i)
564       // FIXME: This should allow truncation of other expression types!
565       if (isa<SCEVConstant>(AddRec->getOperand(i)))
566         Operands.push_back(get(AddRec->getOperand(i), Ty));
567       else
568         break;
569     if (Operands.size() == AddRec->getNumOperands())
570       return SCEVAddRecExpr::get(Operands, AddRec->getLoop());
571   }
572
573   SCEVTruncateExpr *&Result = SCEVTruncates[std::make_pair(Op, Ty)];
574   if (Result == 0) Result = new SCEVTruncateExpr(Op, Ty);
575   return Result;
576 }
577
578 SCEVHandle SCEVZeroExtendExpr::get(const SCEVHandle &Op, const Type *Ty) {
579   if (SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
580     return SCEVUnknown::get(ConstantExpr::getCast(SC->getValue(), Ty));
581
582   // FIXME: If the input value is a chrec scev, and we can prove that the value
583   // did not overflow the old, smaller, value, we can zero extend all of the
584   // operands (often constants).  This would allow analysis of something like
585   // this:  for (unsigned char X = 0; X < 100; ++X) { int Y = X; }
586
587   SCEVZeroExtendExpr *&Result = SCEVZeroExtends[std::make_pair(Op, Ty)];
588   if (Result == 0) Result = new SCEVZeroExtendExpr(Op, Ty);
589   return Result;
590 }
591
592 // get - Get a canonical add expression, or something simpler if possible.
593 SCEVHandle SCEVAddExpr::get(std::vector<SCEVHandle> &Ops) {
594   assert(!Ops.empty() && "Cannot get empty add!");
595   if (Ops.size() == 1) return Ops[0];
596
597   // Sort by complexity, this groups all similar expression types together.
598   GroupByComplexity(Ops);
599
600   // If there are any constants, fold them together.
601   unsigned Idx = 0;
602   if (SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
603     ++Idx;
604     assert(Idx < Ops.size());
605     while (SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
606       // We found two constants, fold them together!
607       Constant *Fold = ConstantExpr::getAdd(LHSC->getValue(), RHSC->getValue());
608       if (ConstantInt *CI = dyn_cast<ConstantInt>(Fold)) {
609         Ops[0] = SCEVConstant::get(CI);
610         Ops.erase(Ops.begin()+1);  // Erase the folded element
611         if (Ops.size() == 1) return Ops[0];
612         LHSC = cast<SCEVConstant>(Ops[0]);
613       } else {
614         // If we couldn't fold the expression, move to the next constant.  Note
615         // that this is impossible to happen in practice because we always
616         // constant fold constant ints to constant ints.
617         ++Idx;
618       }
619     }
620
621     // If we are left with a constant zero being added, strip it off.
622     if (cast<SCEVConstant>(Ops[0])->getValue()->isNullValue()) {
623       Ops.erase(Ops.begin());
624       --Idx;
625     }
626   }
627
628   if (Ops.size() == 1) return Ops[0];
629
630   // Okay, check to see if the same value occurs in the operand list twice.  If
631   // so, merge them together into an multiply expression.  Since we sorted the
632   // list, these values are required to be adjacent.
633   const Type *Ty = Ops[0]->getType();
634   for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
635     if (Ops[i] == Ops[i+1]) {      //  X + Y + Y  -->  X + Y*2
636       // Found a match, merge the two values into a multiply, and add any
637       // remaining values to the result.
638       SCEVHandle Two = SCEVUnknown::getIntegerSCEV(2, Ty);
639       SCEVHandle Mul = SCEVMulExpr::get(Ops[i], Two);
640       if (Ops.size() == 2)
641         return Mul;
642       Ops.erase(Ops.begin()+i, Ops.begin()+i+2);
643       Ops.push_back(Mul);
644       return SCEVAddExpr::get(Ops);
645     }
646
647   // Okay, now we know the first non-constant operand.  If there are add
648   // operands they would be next.
649   if (Idx < Ops.size()) {
650     bool DeletedAdd = false;
651     while (SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[Idx])) {
652       // If we have an add, expand the add operands onto the end of the operands
653       // list.
654       Ops.insert(Ops.end(), Add->op_begin(), Add->op_end());
655       Ops.erase(Ops.begin()+Idx);
656       DeletedAdd = true;
657     }
658
659     // If we deleted at least one add, we added operands to the end of the list,
660     // and they are not necessarily sorted.  Recurse to resort and resimplify
661     // any operands we just aquired.
662     if (DeletedAdd)
663       return get(Ops);
664   }
665
666   // Skip over the add expression until we get to a multiply.
667   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
668     ++Idx;
669
670   // If we are adding something to a multiply expression, make sure the
671   // something is not already an operand of the multiply.  If so, merge it into
672   // the multiply.
673   for (; Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx]); ++Idx) {
674     SCEVMulExpr *Mul = cast<SCEVMulExpr>(Ops[Idx]);
675     for (unsigned MulOp = 0, e = Mul->getNumOperands(); MulOp != e; ++MulOp) {
676       SCEV *MulOpSCEV = Mul->getOperand(MulOp);
677       for (unsigned AddOp = 0, e = Ops.size(); AddOp != e; ++AddOp)
678         if (MulOpSCEV == Ops[AddOp] && !isa<SCEVConstant>(MulOpSCEV)) {
679           // Fold W + X + (X * Y * Z)  -->  W + (X * ((Y*Z)+1))
680           SCEVHandle InnerMul = Mul->getOperand(MulOp == 0);
681           if (Mul->getNumOperands() != 2) {
682             // If the multiply has more than two operands, we must get the
683             // Y*Z term.
684             std::vector<SCEVHandle> MulOps(Mul->op_begin(), Mul->op_end());
685             MulOps.erase(MulOps.begin()+MulOp);
686             InnerMul = SCEVMulExpr::get(MulOps);
687           }
688           SCEVHandle One = SCEVUnknown::getIntegerSCEV(1, Ty);
689           SCEVHandle AddOne = SCEVAddExpr::get(InnerMul, One);
690           SCEVHandle OuterMul = SCEVMulExpr::get(AddOne, Ops[AddOp]);
691           if (Ops.size() == 2) return OuterMul;
692           if (AddOp < Idx) {
693             Ops.erase(Ops.begin()+AddOp);
694             Ops.erase(Ops.begin()+Idx-1);
695           } else {
696             Ops.erase(Ops.begin()+Idx);
697             Ops.erase(Ops.begin()+AddOp-1);
698           }
699           Ops.push_back(OuterMul);
700           return SCEVAddExpr::get(Ops);
701         }
702
703       // Check this multiply against other multiplies being added together.
704       for (unsigned OtherMulIdx = Idx+1;
705            OtherMulIdx < Ops.size() && isa<SCEVMulExpr>(Ops[OtherMulIdx]);
706            ++OtherMulIdx) {
707         SCEVMulExpr *OtherMul = cast<SCEVMulExpr>(Ops[OtherMulIdx]);
708         // If MulOp occurs in OtherMul, we can fold the two multiplies
709         // together.
710         for (unsigned OMulOp = 0, e = OtherMul->getNumOperands();
711              OMulOp != e; ++OMulOp)
712           if (OtherMul->getOperand(OMulOp) == MulOpSCEV) {
713             // Fold X + (A*B*C) + (A*D*E) --> X + (A*(B*C+D*E))
714             SCEVHandle InnerMul1 = Mul->getOperand(MulOp == 0);
715             if (Mul->getNumOperands() != 2) {
716               std::vector<SCEVHandle> MulOps(Mul->op_begin(), Mul->op_end());
717               MulOps.erase(MulOps.begin()+MulOp);
718               InnerMul1 = SCEVMulExpr::get(MulOps);
719             }
720             SCEVHandle InnerMul2 = OtherMul->getOperand(OMulOp == 0);
721             if (OtherMul->getNumOperands() != 2) {
722               std::vector<SCEVHandle> MulOps(OtherMul->op_begin(),
723                                              OtherMul->op_end());
724               MulOps.erase(MulOps.begin()+OMulOp);
725               InnerMul2 = SCEVMulExpr::get(MulOps);
726             }
727             SCEVHandle InnerMulSum = SCEVAddExpr::get(InnerMul1,InnerMul2);
728             SCEVHandle OuterMul = SCEVMulExpr::get(MulOpSCEV, InnerMulSum);
729             if (Ops.size() == 2) return OuterMul;
730             Ops.erase(Ops.begin()+Idx);
731             Ops.erase(Ops.begin()+OtherMulIdx-1);
732             Ops.push_back(OuterMul);
733             return SCEVAddExpr::get(Ops);
734           }
735       }
736     }
737   }
738
739   // If there are any add recurrences in the operands list, see if any other
740   // added values are loop invariant.  If so, we can fold them into the
741   // recurrence.
742   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
743     ++Idx;
744
745   // Scan over all recurrences, trying to fold loop invariants into them.
746   for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
747     // Scan all of the other operands to this add and add them to the vector if
748     // they are loop invariant w.r.t. the recurrence.
749     std::vector<SCEVHandle> LIOps;
750     SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
751     for (unsigned i = 0, e = Ops.size(); i != e; ++i)
752       if (Ops[i]->isLoopInvariant(AddRec->getLoop())) {
753         LIOps.push_back(Ops[i]);
754         Ops.erase(Ops.begin()+i);
755         --i; --e;
756       }
757
758     // If we found some loop invariants, fold them into the recurrence.
759     if (!LIOps.empty()) {
760       //  NLI + LI + { Start,+,Step}  -->  NLI + { LI+Start,+,Step }
761       LIOps.push_back(AddRec->getStart());
762
763       std::vector<SCEVHandle> AddRecOps(AddRec->op_begin(), AddRec->op_end());
764       AddRecOps[0] = SCEVAddExpr::get(LIOps);
765
766       SCEVHandle NewRec = SCEVAddRecExpr::get(AddRecOps, AddRec->getLoop());
767       // If all of the other operands were loop invariant, we are done.
768       if (Ops.size() == 1) return NewRec;
769
770       // Otherwise, add the folded AddRec by the non-liv parts.
771       for (unsigned i = 0;; ++i)
772         if (Ops[i] == AddRec) {
773           Ops[i] = NewRec;
774           break;
775         }
776       return SCEVAddExpr::get(Ops);
777     }
778
779     // Okay, if there weren't any loop invariants to be folded, check to see if
780     // there are multiple AddRec's with the same loop induction variable being
781     // added together.  If so, we can fold them.
782     for (unsigned OtherIdx = Idx+1;
783          OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);++OtherIdx)
784       if (OtherIdx != Idx) {
785         SCEVAddRecExpr *OtherAddRec = cast<SCEVAddRecExpr>(Ops[OtherIdx]);
786         if (AddRec->getLoop() == OtherAddRec->getLoop()) {
787           // Other + {A,+,B} + {C,+,D}  -->  Other + {A+C,+,B+D}
788           std::vector<SCEVHandle> NewOps(AddRec->op_begin(), AddRec->op_end());
789           for (unsigned i = 0, e = OtherAddRec->getNumOperands(); i != e; ++i) {
790             if (i >= NewOps.size()) {
791               NewOps.insert(NewOps.end(), OtherAddRec->op_begin()+i,
792                             OtherAddRec->op_end());
793               break;
794             }
795             NewOps[i] = SCEVAddExpr::get(NewOps[i], OtherAddRec->getOperand(i));
796           }
797           SCEVHandle NewAddRec = SCEVAddRecExpr::get(NewOps, AddRec->getLoop());
798
799           if (Ops.size() == 2) return NewAddRec;
800
801           Ops.erase(Ops.begin()+Idx);
802           Ops.erase(Ops.begin()+OtherIdx-1);
803           Ops.push_back(NewAddRec);
804           return SCEVAddExpr::get(Ops);
805         }
806       }
807
808     // Otherwise couldn't fold anything into this recurrence.  Move onto the
809     // next one.
810   }
811
812   // Okay, it looks like we really DO need an add expr.  Check to see if we
813   // already have one, otherwise create a new one.
814   std::vector<SCEV*> SCEVOps(Ops.begin(), Ops.end());
815   SCEVCommutativeExpr *&Result = SCEVCommExprs[std::make_pair(scAddExpr,
816                                                               SCEVOps)];
817   if (Result == 0) Result = new SCEVAddExpr(Ops);
818   return Result;
819 }
820
821
822 SCEVHandle SCEVMulExpr::get(std::vector<SCEVHandle> &Ops) {
823   assert(!Ops.empty() && "Cannot get empty mul!");
824
825   // Sort by complexity, this groups all similar expression types together.
826   GroupByComplexity(Ops);
827
828   // If there are any constants, fold them together.
829   unsigned Idx = 0;
830   if (SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
831
832     // C1*(C2+V) -> C1*C2 + C1*V
833     if (Ops.size() == 2)
834       if (SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1]))
835         if (Add->getNumOperands() == 2 &&
836             isa<SCEVConstant>(Add->getOperand(0)))
837           return SCEVAddExpr::get(SCEVMulExpr::get(LHSC, Add->getOperand(0)),
838                                   SCEVMulExpr::get(LHSC, Add->getOperand(1)));
839
840
841     ++Idx;
842     while (SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
843       // We found two constants, fold them together!
844       Constant *Fold = ConstantExpr::getMul(LHSC->getValue(), RHSC->getValue());
845       if (ConstantInt *CI = dyn_cast<ConstantInt>(Fold)) {
846         Ops[0] = SCEVConstant::get(CI);
847         Ops.erase(Ops.begin()+1);  // Erase the folded element
848         if (Ops.size() == 1) return Ops[0];
849         LHSC = cast<SCEVConstant>(Ops[0]);
850       } else {
851         // If we couldn't fold the expression, move to the next constant.  Note
852         // that this is impossible to happen in practice because we always
853         // constant fold constant ints to constant ints.
854         ++Idx;
855       }
856     }
857
858     // If we are left with a constant one being multiplied, strip it off.
859     if (cast<SCEVConstant>(Ops[0])->getValue()->equalsInt(1)) {
860       Ops.erase(Ops.begin());
861       --Idx;
862     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isNullValue()) {
863       // If we have a multiply of zero, it will always be zero.
864       return Ops[0];
865     }
866   }
867
868   // Skip over the add expression until we get to a multiply.
869   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
870     ++Idx;
871
872   if (Ops.size() == 1)
873     return Ops[0];
874
875   // If there are mul operands inline them all into this expression.
876   if (Idx < Ops.size()) {
877     bool DeletedMul = false;
878     while (SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) {
879       // If we have an mul, expand the mul operands onto the end of the operands
880       // list.
881       Ops.insert(Ops.end(), Mul->op_begin(), Mul->op_end());
882       Ops.erase(Ops.begin()+Idx);
883       DeletedMul = true;
884     }
885
886     // If we deleted at least one mul, we added operands to the end of the list,
887     // and they are not necessarily sorted.  Recurse to resort and resimplify
888     // any operands we just aquired.
889     if (DeletedMul)
890       return get(Ops);
891   }
892
893   // If there are any add recurrences in the operands list, see if any other
894   // added values are loop invariant.  If so, we can fold them into the
895   // recurrence.
896   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
897     ++Idx;
898
899   // Scan over all recurrences, trying to fold loop invariants into them.
900   for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
901     // Scan all of the other operands to this mul and add them to the vector if
902     // they are loop invariant w.r.t. the recurrence.
903     std::vector<SCEVHandle> LIOps;
904     SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
905     for (unsigned i = 0, e = Ops.size(); i != e; ++i)
906       if (Ops[i]->isLoopInvariant(AddRec->getLoop())) {
907         LIOps.push_back(Ops[i]);
908         Ops.erase(Ops.begin()+i);
909         --i; --e;
910       }
911
912     // If we found some loop invariants, fold them into the recurrence.
913     if (!LIOps.empty()) {
914       //  NLI * LI * { Start,+,Step}  -->  NLI * { LI*Start,+,LI*Step }
915       std::vector<SCEVHandle> NewOps;
916       NewOps.reserve(AddRec->getNumOperands());
917       if (LIOps.size() == 1) {
918         SCEV *Scale = LIOps[0];
919         for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i)
920           NewOps.push_back(SCEVMulExpr::get(Scale, AddRec->getOperand(i)));
921       } else {
922         for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
923           std::vector<SCEVHandle> MulOps(LIOps);
924           MulOps.push_back(AddRec->getOperand(i));
925           NewOps.push_back(SCEVMulExpr::get(MulOps));
926         }
927       }
928
929       SCEVHandle NewRec = SCEVAddRecExpr::get(NewOps, AddRec->getLoop());
930
931       // If all of the other operands were loop invariant, we are done.
932       if (Ops.size() == 1) return NewRec;
933
934       // Otherwise, multiply the folded AddRec by the non-liv parts.
935       for (unsigned i = 0;; ++i)
936         if (Ops[i] == AddRec) {
937           Ops[i] = NewRec;
938           break;
939         }
940       return SCEVMulExpr::get(Ops);
941     }
942
943     // Okay, if there weren't any loop invariants to be folded, check to see if
944     // there are multiple AddRec's with the same loop induction variable being
945     // multiplied together.  If so, we can fold them.
946     for (unsigned OtherIdx = Idx+1;
947          OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);++OtherIdx)
948       if (OtherIdx != Idx) {
949         SCEVAddRecExpr *OtherAddRec = cast<SCEVAddRecExpr>(Ops[OtherIdx]);
950         if (AddRec->getLoop() == OtherAddRec->getLoop()) {
951           // F * G  -->  {A,+,B} * {C,+,D}  -->  {A*C,+,F*D + G*B + B*D}
952           SCEVAddRecExpr *F = AddRec, *G = OtherAddRec;
953           SCEVHandle NewStart = SCEVMulExpr::get(F->getStart(),
954                                                  G->getStart());
955           SCEVHandle B = F->getStepRecurrence();
956           SCEVHandle D = G->getStepRecurrence();
957           SCEVHandle NewStep = SCEVAddExpr::get(SCEVMulExpr::get(F, D),
958                                                 SCEVMulExpr::get(G, B),
959                                                 SCEVMulExpr::get(B, D));
960           SCEVHandle NewAddRec = SCEVAddRecExpr::get(NewStart, NewStep,
961                                                      F->getLoop());
962           if (Ops.size() == 2) return NewAddRec;
963
964           Ops.erase(Ops.begin()+Idx);
965           Ops.erase(Ops.begin()+OtherIdx-1);
966           Ops.push_back(NewAddRec);
967           return SCEVMulExpr::get(Ops);
968         }
969       }
970
971     // Otherwise couldn't fold anything into this recurrence.  Move onto the
972     // next one.
973   }
974
975   // Okay, it looks like we really DO need an mul expr.  Check to see if we
976   // already have one, otherwise create a new one.
977   std::vector<SCEV*> SCEVOps(Ops.begin(), Ops.end());
978   SCEVCommutativeExpr *&Result = SCEVCommExprs[std::make_pair(scMulExpr,
979                                                               SCEVOps)];
980   if (Result == 0)
981     Result = new SCEVMulExpr(Ops);
982   return Result;
983 }
984
985 SCEVHandle SCEVSDivExpr::get(const SCEVHandle &LHS, const SCEVHandle &RHS) {
986   if (SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
987     if (RHSC->getValue()->equalsInt(1))
988       return LHS;                            // X /s 1 --> x
989     if (RHSC->getValue()->isAllOnesValue())
990       return SCEV::getNegativeSCEV(LHS);           // X /s -1  -->  -x
991
992     if (SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
993       Constant *LHSCV = LHSC->getValue();
994       Constant *RHSCV = RHSC->getValue();
995       if (LHSCV->getType()->isUnsigned())
996         LHSCV = ConstantExpr::getCast(LHSCV,
997                                       LHSCV->getType()->getSignedVersion());
998       if (RHSCV->getType()->isUnsigned())
999         RHSCV = ConstantExpr::getCast(RHSCV, LHSCV->getType());
1000       return SCEVUnknown::get(ConstantExpr::getDiv(LHSCV, RHSCV));
1001     }
1002   }
1003
1004   // FIXME: implement folding of (X*4)/4 when we know X*4 doesn't overflow.
1005
1006   SCEVSDivExpr *&Result = SCEVSDivs[std::make_pair(LHS, RHS)];
1007   if (Result == 0) Result = new SCEVSDivExpr(LHS, RHS);
1008   return Result;
1009 }
1010
1011
1012 /// SCEVAddRecExpr::get - Get a add recurrence expression for the
1013 /// specified loop.  Simplify the expression as much as possible.
1014 SCEVHandle SCEVAddRecExpr::get(const SCEVHandle &Start,
1015                                const SCEVHandle &Step, const Loop *L) {
1016   std::vector<SCEVHandle> Operands;
1017   Operands.push_back(Start);
1018   if (SCEVAddRecExpr *StepChrec = dyn_cast<SCEVAddRecExpr>(Step))
1019     if (StepChrec->getLoop() == L) {
1020       Operands.insert(Operands.end(), StepChrec->op_begin(),
1021                       StepChrec->op_end());
1022       return get(Operands, L);
1023     }
1024
1025   Operands.push_back(Step);
1026   return get(Operands, L);
1027 }
1028
1029 /// SCEVAddRecExpr::get - Get a add recurrence expression for the
1030 /// specified loop.  Simplify the expression as much as possible.
1031 SCEVHandle SCEVAddRecExpr::get(std::vector<SCEVHandle> &Operands,
1032                                const Loop *L) {
1033   if (Operands.size() == 1) return Operands[0];
1034
1035   if (SCEVConstant *StepC = dyn_cast<SCEVConstant>(Operands.back()))
1036     if (StepC->getValue()->isNullValue()) {
1037       Operands.pop_back();
1038       return get(Operands, L);             // { X,+,0 }  -->  X
1039     }
1040
1041   SCEVAddRecExpr *&Result =
1042     SCEVAddRecExprs[std::make_pair(L, std::vector<SCEV*>(Operands.begin(),
1043                                                          Operands.end()))];
1044   if (Result == 0) Result = new SCEVAddRecExpr(Operands, L);
1045   return Result;
1046 }
1047
1048 SCEVHandle SCEVUnknown::get(Value *V) {
1049   if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
1050     return SCEVConstant::get(CI);
1051   SCEVUnknown *&Result = SCEVUnknowns[V];
1052   if (Result == 0) Result = new SCEVUnknown(V);
1053   return Result;
1054 }
1055
1056
1057 //===----------------------------------------------------------------------===//
1058 //             ScalarEvolutionsImpl Definition and Implementation
1059 //===----------------------------------------------------------------------===//
1060 //
1061 /// ScalarEvolutionsImpl - This class implements the main driver for the scalar
1062 /// evolution code.
1063 ///
1064 namespace {
1065   struct ScalarEvolutionsImpl {
1066     /// F - The function we are analyzing.
1067     ///
1068     Function &F;
1069
1070     /// LI - The loop information for the function we are currently analyzing.
1071     ///
1072     LoopInfo &LI;
1073
1074     /// UnknownValue - This SCEV is used to represent unknown trip counts and
1075     /// things.
1076     SCEVHandle UnknownValue;
1077
1078     /// Scalars - This is a cache of the scalars we have analyzed so far.
1079     ///
1080     std::map<Value*, SCEVHandle> Scalars;
1081
1082     /// IterationCounts - Cache the iteration count of the loops for this
1083     /// function as they are computed.
1084     std::map<const Loop*, SCEVHandle> IterationCounts;
1085
1086     /// ConstantEvolutionLoopExitValue - This map contains entries for all of
1087     /// the PHI instructions that we attempt to compute constant evolutions for.
1088     /// This allows us to avoid potentially expensive recomputation of these
1089     /// properties.  An instruction maps to null if we are unable to compute its
1090     /// exit value.
1091     std::map<PHINode*, Constant*> ConstantEvolutionLoopExitValue;
1092
1093   public:
1094     ScalarEvolutionsImpl(Function &f, LoopInfo &li)
1095       : F(f), LI(li), UnknownValue(new SCEVCouldNotCompute()) {}
1096
1097     /// getSCEV - Return an existing SCEV if it exists, otherwise analyze the
1098     /// expression and create a new one.
1099     SCEVHandle getSCEV(Value *V);
1100
1101     /// hasSCEV - Return true if the SCEV for this value has already been
1102     /// computed.
1103     bool hasSCEV(Value *V) const {
1104       return Scalars.count(V);
1105     }
1106
1107     /// setSCEV - Insert the specified SCEV into the map of current SCEVs for
1108     /// the specified value.
1109     void setSCEV(Value *V, const SCEVHandle &H) {
1110       bool isNew = Scalars.insert(std::make_pair(V, H)).second;
1111       assert(isNew && "This entry already existed!");
1112     }
1113
1114
1115     /// getSCEVAtScope - Compute the value of the specified expression within
1116     /// the indicated loop (which may be null to indicate in no loop).  If the
1117     /// expression cannot be evaluated, return UnknownValue itself.
1118     SCEVHandle getSCEVAtScope(SCEV *V, const Loop *L);
1119
1120
1121     /// hasLoopInvariantIterationCount - Return true if the specified loop has
1122     /// an analyzable loop-invariant iteration count.
1123     bool hasLoopInvariantIterationCount(const Loop *L);
1124
1125     /// getIterationCount - If the specified loop has a predictable iteration
1126     /// count, return it.  Note that it is not valid to call this method on a
1127     /// loop without a loop-invariant iteration count.
1128     SCEVHandle getIterationCount(const Loop *L);
1129
1130     /// deleteInstructionFromRecords - This method should be called by the
1131     /// client before it removes an instruction from the program, to make sure
1132     /// that no dangling references are left around.
1133     void deleteInstructionFromRecords(Instruction *I);
1134
1135   private:
1136     /// createSCEV - We know that there is no SCEV for the specified value.
1137     /// Analyze the expression.
1138     SCEVHandle createSCEV(Value *V);
1139     SCEVHandle createNodeForCast(CastInst *CI);
1140
1141     /// createNodeForPHI - Provide the special handling we need to analyze PHI
1142     /// SCEVs.
1143     SCEVHandle createNodeForPHI(PHINode *PN);
1144
1145     /// ReplaceSymbolicValueWithConcrete - This looks up the computed SCEV value
1146     /// for the specified instruction and replaces any references to the
1147     /// symbolic value SymName with the specified value.  This is used during
1148     /// PHI resolution.
1149     void ReplaceSymbolicValueWithConcrete(Instruction *I,
1150                                           const SCEVHandle &SymName,
1151                                           const SCEVHandle &NewVal);
1152
1153     /// ComputeIterationCount - Compute the number of times the specified loop
1154     /// will iterate.
1155     SCEVHandle ComputeIterationCount(const Loop *L);
1156
1157     /// ComputeLoadConstantCompareIterationCount - Given an exit condition of
1158     /// 'setcc load X, cst', try to se if we can compute the trip count.
1159     SCEVHandle ComputeLoadConstantCompareIterationCount(LoadInst *LI,
1160                                                         Constant *RHS,
1161                                                         const Loop *L,
1162                                                         unsigned SetCCOpcode);
1163
1164     /// ComputeIterationCountExhaustively - If the trip is known to execute a
1165     /// constant number of times (the condition evolves only from constants),
1166     /// try to evaluate a few iterations of the loop until we get the exit
1167     /// condition gets a value of ExitWhen (true or false).  If we cannot
1168     /// evaluate the trip count of the loop, return UnknownValue.
1169     SCEVHandle ComputeIterationCountExhaustively(const Loop *L, Value *Cond,
1170                                                  bool ExitWhen);
1171
1172     /// HowFarToZero - Return the number of times a backedge comparing the
1173     /// specified value to zero will execute.  If not computable, return
1174     /// UnknownValue.
1175     SCEVHandle HowFarToZero(SCEV *V, const Loop *L);
1176
1177     /// HowFarToNonZero - Return the number of times a backedge checking the
1178     /// specified value for nonzero will execute.  If not computable, return
1179     /// UnknownValue.
1180     SCEVHandle HowFarToNonZero(SCEV *V, const Loop *L);
1181
1182     /// HowManyLessThans - Return the number of times a backedge containing the
1183     /// specified less-than comparison will execute.  If not computable, return
1184     /// UnknownValue.
1185     SCEVHandle HowManyLessThans(SCEV *LHS, SCEV *RHS, const Loop *L);
1186
1187     /// getConstantEvolutionLoopExitValue - If we know that the specified Phi is
1188     /// in the header of its containing loop, we know the loop executes a
1189     /// constant number of times, and the PHI node is just a recurrence
1190     /// involving constants, fold it.
1191     Constant *getConstantEvolutionLoopExitValue(PHINode *PN, uint64_t Its,
1192                                                 const Loop *L);
1193   };
1194 }
1195
1196 //===----------------------------------------------------------------------===//
1197 //            Basic SCEV Analysis and PHI Idiom Recognition Code
1198 //
1199
1200 /// deleteInstructionFromRecords - This method should be called by the
1201 /// client before it removes an instruction from the program, to make sure
1202 /// that no dangling references are left around.
1203 void ScalarEvolutionsImpl::deleteInstructionFromRecords(Instruction *I) {
1204   Scalars.erase(I);
1205   if (PHINode *PN = dyn_cast<PHINode>(I))
1206     ConstantEvolutionLoopExitValue.erase(PN);
1207 }
1208
1209
1210 /// getSCEV - Return an existing SCEV if it exists, otherwise analyze the
1211 /// expression and create a new one.
1212 SCEVHandle ScalarEvolutionsImpl::getSCEV(Value *V) {
1213   assert(V->getType() != Type::VoidTy && "Can't analyze void expressions!");
1214
1215   std::map<Value*, SCEVHandle>::iterator I = Scalars.find(V);
1216   if (I != Scalars.end()) return I->second;
1217   SCEVHandle S = createSCEV(V);
1218   Scalars.insert(std::make_pair(V, S));
1219   return S;
1220 }
1221
1222 /// ReplaceSymbolicValueWithConcrete - This looks up the computed SCEV value for
1223 /// the specified instruction and replaces any references to the symbolic value
1224 /// SymName with the specified value.  This is used during PHI resolution.
1225 void ScalarEvolutionsImpl::
1226 ReplaceSymbolicValueWithConcrete(Instruction *I, const SCEVHandle &SymName,
1227                                  const SCEVHandle &NewVal) {
1228   std::map<Value*, SCEVHandle>::iterator SI = Scalars.find(I);
1229   if (SI == Scalars.end()) return;
1230
1231   SCEVHandle NV =
1232     SI->second->replaceSymbolicValuesWithConcrete(SymName, NewVal);
1233   if (NV == SI->second) return;  // No change.
1234
1235   SI->second = NV;       // Update the scalars map!
1236
1237   // Any instruction values that use this instruction might also need to be
1238   // updated!
1239   for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
1240        UI != E; ++UI)
1241     ReplaceSymbolicValueWithConcrete(cast<Instruction>(*UI), SymName, NewVal);
1242 }
1243
1244 /// createNodeForPHI - PHI nodes have two cases.  Either the PHI node exists in
1245 /// a loop header, making it a potential recurrence, or it doesn't.
1246 ///
1247 SCEVHandle ScalarEvolutionsImpl::createNodeForPHI(PHINode *PN) {
1248   if (PN->getNumIncomingValues() == 2)  // The loops have been canonicalized.
1249     if (const Loop *L = LI.getLoopFor(PN->getParent()))
1250       if (L->getHeader() == PN->getParent()) {
1251         // If it lives in the loop header, it has two incoming values, one
1252         // from outside the loop, and one from inside.
1253         unsigned IncomingEdge = L->contains(PN->getIncomingBlock(0));
1254         unsigned BackEdge     = IncomingEdge^1;
1255
1256         // While we are analyzing this PHI node, handle its value symbolically.
1257         SCEVHandle SymbolicName = SCEVUnknown::get(PN);
1258         assert(Scalars.find(PN) == Scalars.end() &&
1259                "PHI node already processed?");
1260         Scalars.insert(std::make_pair(PN, SymbolicName));
1261
1262         // Using this symbolic name for the PHI, analyze the value coming around
1263         // the back-edge.
1264         SCEVHandle BEValue = getSCEV(PN->getIncomingValue(BackEdge));
1265
1266         // NOTE: If BEValue is loop invariant, we know that the PHI node just
1267         // has a special value for the first iteration of the loop.
1268
1269         // If the value coming around the backedge is an add with the symbolic
1270         // value we just inserted, then we found a simple induction variable!
1271         if (SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(BEValue)) {
1272           // If there is a single occurrence of the symbolic value, replace it
1273           // with a recurrence.
1274           unsigned FoundIndex = Add->getNumOperands();
1275           for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
1276             if (Add->getOperand(i) == SymbolicName)
1277               if (FoundIndex == e) {
1278                 FoundIndex = i;
1279                 break;
1280               }
1281
1282           if (FoundIndex != Add->getNumOperands()) {
1283             // Create an add with everything but the specified operand.
1284             std::vector<SCEVHandle> Ops;
1285             for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
1286               if (i != FoundIndex)
1287                 Ops.push_back(Add->getOperand(i));
1288             SCEVHandle Accum = SCEVAddExpr::get(Ops);
1289
1290             // This is not a valid addrec if the step amount is varying each
1291             // loop iteration, but is not itself an addrec in this loop.
1292             if (Accum->isLoopInvariant(L) ||
1293                 (isa<SCEVAddRecExpr>(Accum) &&
1294                  cast<SCEVAddRecExpr>(Accum)->getLoop() == L)) {
1295               SCEVHandle StartVal = getSCEV(PN->getIncomingValue(IncomingEdge));
1296               SCEVHandle PHISCEV  = SCEVAddRecExpr::get(StartVal, Accum, L);
1297
1298               // Okay, for the entire analysis of this edge we assumed the PHI
1299               // to be symbolic.  We now need to go back and update all of the
1300               // entries for the scalars that use the PHI (except for the PHI
1301               // itself) to use the new analyzed value instead of the "symbolic"
1302               // value.
1303               ReplaceSymbolicValueWithConcrete(PN, SymbolicName, PHISCEV);
1304               return PHISCEV;
1305             }
1306           }
1307         } else if (SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(BEValue)) {
1308           // Otherwise, this could be a loop like this:
1309           //     i = 0;  for (j = 1; ..; ++j) { ....  i = j; }
1310           // In this case, j = {1,+,1}  and BEValue is j.
1311           // Because the other in-value of i (0) fits the evolution of BEValue
1312           // i really is an addrec evolution.
1313           if (AddRec->getLoop() == L && AddRec->isAffine()) {
1314             SCEVHandle StartVal = getSCEV(PN->getIncomingValue(IncomingEdge));
1315
1316             // If StartVal = j.start - j.stride, we can use StartVal as the
1317             // initial step of the addrec evolution.
1318             if (StartVal == SCEV::getMinusSCEV(AddRec->getOperand(0),
1319                                                AddRec->getOperand(1))) {
1320               SCEVHandle PHISCEV = 
1321                  SCEVAddRecExpr::get(StartVal, AddRec->getOperand(1), L);
1322
1323               // Okay, for the entire analysis of this edge we assumed the PHI
1324               // to be symbolic.  We now need to go back and update all of the
1325               // entries for the scalars that use the PHI (except for the PHI
1326               // itself) to use the new analyzed value instead of the "symbolic"
1327               // value.
1328               ReplaceSymbolicValueWithConcrete(PN, SymbolicName, PHISCEV);
1329               return PHISCEV;
1330             }
1331           }
1332         }
1333
1334         return SymbolicName;
1335       }
1336
1337   // If it's not a loop phi, we can't handle it yet.
1338   return SCEVUnknown::get(PN);
1339 }
1340
1341 /// createNodeForCast - Handle the various forms of casts that we support.
1342 ///
1343 SCEVHandle ScalarEvolutionsImpl::createNodeForCast(CastInst *CI) {
1344   const Type *SrcTy = CI->getOperand(0)->getType();
1345   const Type *DestTy = CI->getType();
1346
1347   // If this is a noop cast (ie, conversion from int to uint), ignore it.
1348   if (SrcTy->isLosslesslyConvertibleTo(DestTy))
1349     return getSCEV(CI->getOperand(0));
1350
1351   if (SrcTy->isInteger() && DestTy->isInteger()) {
1352     // Otherwise, if this is a truncating integer cast, we can represent this
1353     // cast.
1354     if (SrcTy->getPrimitiveSize() > DestTy->getPrimitiveSize())
1355       return SCEVTruncateExpr::get(getSCEV(CI->getOperand(0)),
1356                                    CI->getType()->getUnsignedVersion());
1357     if (SrcTy->isUnsigned() &&
1358         SrcTy->getPrimitiveSize() > DestTy->getPrimitiveSize())
1359       return SCEVZeroExtendExpr::get(getSCEV(CI->getOperand(0)),
1360                                      CI->getType()->getUnsignedVersion());
1361   }
1362
1363   // If this is an sign or zero extending cast and we can prove that the value
1364   // will never overflow, we could do similar transformations.
1365
1366   // Otherwise, we can't handle this cast!
1367   return SCEVUnknown::get(CI);
1368 }
1369
1370
1371 /// createSCEV - We know that there is no SCEV for the specified value.
1372 /// Analyze the expression.
1373 ///
1374 SCEVHandle ScalarEvolutionsImpl::createSCEV(Value *V) {
1375   if (Instruction *I = dyn_cast<Instruction>(V)) {
1376     switch (I->getOpcode()) {
1377     case Instruction::Add:
1378       return SCEVAddExpr::get(getSCEV(I->getOperand(0)),
1379                               getSCEV(I->getOperand(1)));
1380     case Instruction::Mul:
1381       return SCEVMulExpr::get(getSCEV(I->getOperand(0)),
1382                               getSCEV(I->getOperand(1)));
1383     case Instruction::Div:
1384       if (V->getType()->isInteger() && V->getType()->isSigned())
1385         return SCEVSDivExpr::get(getSCEV(I->getOperand(0)),
1386                                  getSCEV(I->getOperand(1)));
1387       break;
1388
1389     case Instruction::Sub:
1390       return SCEV::getMinusSCEV(getSCEV(I->getOperand(0)),
1391                                 getSCEV(I->getOperand(1)));
1392
1393     case Instruction::Shl:
1394       // Turn shift left of a constant amount into a multiply.
1395       if (ConstantInt *SA = dyn_cast<ConstantInt>(I->getOperand(1))) {
1396         Constant *X = ConstantInt::get(V->getType(), 1);
1397         X = ConstantExpr::getShl(X, SA);
1398         return SCEVMulExpr::get(getSCEV(I->getOperand(0)), getSCEV(X));
1399       }
1400       break;
1401
1402     case Instruction::Cast:
1403       return createNodeForCast(cast<CastInst>(I));
1404
1405     case Instruction::PHI:
1406       return createNodeForPHI(cast<PHINode>(I));
1407
1408     default: // We cannot analyze this expression.
1409       break;
1410     }
1411   }
1412
1413   return SCEVUnknown::get(V);
1414 }
1415
1416
1417
1418 //===----------------------------------------------------------------------===//
1419 //                   Iteration Count Computation Code
1420 //
1421
1422 /// getIterationCount - If the specified loop has a predictable iteration
1423 /// count, return it.  Note that it is not valid to call this method on a
1424 /// loop without a loop-invariant iteration count.
1425 SCEVHandle ScalarEvolutionsImpl::getIterationCount(const Loop *L) {
1426   std::map<const Loop*, SCEVHandle>::iterator I = IterationCounts.find(L);
1427   if (I == IterationCounts.end()) {
1428     SCEVHandle ItCount = ComputeIterationCount(L);
1429     I = IterationCounts.insert(std::make_pair(L, ItCount)).first;
1430     if (ItCount != UnknownValue) {
1431       assert(ItCount->isLoopInvariant(L) &&
1432              "Computed trip count isn't loop invariant for loop!");
1433       ++NumTripCountsComputed;
1434     } else if (isa<PHINode>(L->getHeader()->begin())) {
1435       // Only count loops that have phi nodes as not being computable.
1436       ++NumTripCountsNotComputed;
1437     }
1438   }
1439   return I->second;
1440 }
1441
1442 /// ComputeIterationCount - Compute the number of times the specified loop
1443 /// will iterate.
1444 SCEVHandle ScalarEvolutionsImpl::ComputeIterationCount(const Loop *L) {
1445   // If the loop has a non-one exit block count, we can't analyze it.
1446   std::vector<BasicBlock*> ExitBlocks;
1447   L->getExitBlocks(ExitBlocks);
1448   if (ExitBlocks.size() != 1) return UnknownValue;
1449
1450   // Okay, there is one exit block.  Try to find the condition that causes the
1451   // loop to be exited.
1452   BasicBlock *ExitBlock = ExitBlocks[0];
1453
1454   BasicBlock *ExitingBlock = 0;
1455   for (pred_iterator PI = pred_begin(ExitBlock), E = pred_end(ExitBlock);
1456        PI != E; ++PI)
1457     if (L->contains(*PI)) {
1458       if (ExitingBlock == 0)
1459         ExitingBlock = *PI;
1460       else
1461         return UnknownValue;   // More than one block exiting!
1462     }
1463   assert(ExitingBlock && "No exits from loop, something is broken!");
1464
1465   // Okay, we've computed the exiting block.  See what condition causes us to
1466   // exit.
1467   //
1468   // FIXME: we should be able to handle switch instructions (with a single exit)
1469   // FIXME: We should handle cast of int to bool as well
1470   BranchInst *ExitBr = dyn_cast<BranchInst>(ExitingBlock->getTerminator());
1471   if (ExitBr == 0) return UnknownValue;
1472   assert(ExitBr->isConditional() && "If unconditional, it can't be in loop!");
1473   SetCondInst *ExitCond = dyn_cast<SetCondInst>(ExitBr->getCondition());
1474   if (ExitCond == 0)  // Not a setcc
1475     return ComputeIterationCountExhaustively(L, ExitBr->getCondition(),
1476                                           ExitBr->getSuccessor(0) == ExitBlock);
1477
1478   // If the condition was exit on true, convert the condition to exit on false.
1479   Instruction::BinaryOps Cond;
1480   if (ExitBr->getSuccessor(1) == ExitBlock)
1481     Cond = ExitCond->getOpcode();
1482   else
1483     Cond = ExitCond->getInverseCondition();
1484
1485   // Handle common loops like: for (X = "string"; *X; ++X)
1486   if (LoadInst *LI = dyn_cast<LoadInst>(ExitCond->getOperand(0)))
1487     if (Constant *RHS = dyn_cast<Constant>(ExitCond->getOperand(1))) {
1488       SCEVHandle ItCnt =
1489         ComputeLoadConstantCompareIterationCount(LI, RHS, L, Cond);
1490       if (!isa<SCEVCouldNotCompute>(ItCnt)) return ItCnt;
1491     }
1492
1493   SCEVHandle LHS = getSCEV(ExitCond->getOperand(0));
1494   SCEVHandle RHS = getSCEV(ExitCond->getOperand(1));
1495
1496   // Try to evaluate any dependencies out of the loop.
1497   SCEVHandle Tmp = getSCEVAtScope(LHS, L);
1498   if (!isa<SCEVCouldNotCompute>(Tmp)) LHS = Tmp;
1499   Tmp = getSCEVAtScope(RHS, L);
1500   if (!isa<SCEVCouldNotCompute>(Tmp)) RHS = Tmp;
1501
1502   // At this point, we would like to compute how many iterations of the loop the
1503   // predicate will return true for these inputs.
1504   if (isa<SCEVConstant>(LHS) && !isa<SCEVConstant>(RHS)) {
1505     // If there is a constant, force it into the RHS.
1506     std::swap(LHS, RHS);
1507     Cond = SetCondInst::getSwappedCondition(Cond);
1508   }
1509
1510   // FIXME: think about handling pointer comparisons!  i.e.:
1511   // while (P != P+100) ++P;
1512
1513   // If we have a comparison of a chrec against a constant, try to use value
1514   // ranges to answer this query.
1515   if (SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS))
1516     if (SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS))
1517       if (AddRec->getLoop() == L) {
1518         // Form the comparison range using the constant of the correct type so
1519         // that the ConstantRange class knows to do a signed or unsigned
1520         // comparison.
1521         ConstantInt *CompVal = RHSC->getValue();
1522         const Type *RealTy = ExitCond->getOperand(0)->getType();
1523         CompVal = dyn_cast<ConstantInt>(ConstantExpr::getCast(CompVal, RealTy));
1524         if (CompVal) {
1525           // Form the constant range.
1526           ConstantRange CompRange(Cond, CompVal);
1527
1528           // Now that we have it, if it's signed, convert it to an unsigned
1529           // range.
1530           if (CompRange.getLower()->getType()->isSigned()) {
1531             const Type *NewTy = RHSC->getValue()->getType();
1532             Constant *NewL = ConstantExpr::getCast(CompRange.getLower(), NewTy);
1533             Constant *NewU = ConstantExpr::getCast(CompRange.getUpper(), NewTy);
1534             CompRange = ConstantRange(NewL, NewU);
1535           }
1536
1537           SCEVHandle Ret = AddRec->getNumIterationsInRange(CompRange);
1538           if (!isa<SCEVCouldNotCompute>(Ret)) return Ret;
1539         }
1540       }
1541
1542   switch (Cond) {
1543   case Instruction::SetNE:                     // while (X != Y)
1544     // Convert to: while (X-Y != 0)
1545     if (LHS->getType()->isInteger()) {
1546       SCEVHandle TC = HowFarToZero(SCEV::getMinusSCEV(LHS, RHS), L);
1547       if (!isa<SCEVCouldNotCompute>(TC)) return TC;
1548     }
1549     break;
1550   case Instruction::SetEQ:
1551     // Convert to: while (X-Y == 0)           // while (X == Y)
1552     if (LHS->getType()->isInteger()) {
1553       SCEVHandle TC = HowFarToNonZero(SCEV::getMinusSCEV(LHS, RHS), L);
1554       if (!isa<SCEVCouldNotCompute>(TC)) return TC;
1555     }
1556     break;
1557   case Instruction::SetLT:
1558     if (LHS->getType()->isInteger() && 
1559         ExitCond->getOperand(0)->getType()->isSigned()) {
1560       SCEVHandle TC = HowManyLessThans(LHS, RHS, L);
1561       if (!isa<SCEVCouldNotCompute>(TC)) return TC;
1562     }
1563     break;
1564   case Instruction::SetGT:
1565     if (LHS->getType()->isInteger() &&
1566         ExitCond->getOperand(0)->getType()->isSigned()) {
1567       SCEVHandle TC = HowManyLessThans(RHS, LHS, L);
1568       if (!isa<SCEVCouldNotCompute>(TC)) return TC;
1569     }
1570     break;
1571   default:
1572 #if 0
1573     std::cerr << "ComputeIterationCount ";
1574     if (ExitCond->getOperand(0)->getType()->isUnsigned())
1575       std::cerr << "[unsigned] ";
1576     std::cerr << *LHS << "   "
1577               << Instruction::getOpcodeName(Cond) << "   " << *RHS << "\n";
1578 #endif
1579     break;
1580   }
1581
1582   return ComputeIterationCountExhaustively(L, ExitCond,
1583                                          ExitBr->getSuccessor(0) == ExitBlock);
1584 }
1585
1586 static ConstantInt *
1587 EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, Constant *C) {
1588   SCEVHandle InVal = SCEVConstant::get(cast<ConstantInt>(C));
1589   SCEVHandle Val = AddRec->evaluateAtIteration(InVal);
1590   assert(isa<SCEVConstant>(Val) &&
1591          "Evaluation of SCEV at constant didn't fold correctly?");
1592   return cast<SCEVConstant>(Val)->getValue();
1593 }
1594
1595 /// GetAddressedElementFromGlobal - Given a global variable with an initializer
1596 /// and a GEP expression (missing the pointer index) indexing into it, return
1597 /// the addressed element of the initializer or null if the index expression is
1598 /// invalid.
1599 static Constant *
1600 GetAddressedElementFromGlobal(GlobalVariable *GV,
1601                               const std::vector<ConstantInt*> &Indices) {
1602   Constant *Init = GV->getInitializer();
1603   for (unsigned i = 0, e = Indices.size(); i != e; ++i) {
1604     uint64_t Idx = Indices[i]->getRawValue();
1605     if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Init)) {
1606       assert(Idx < CS->getNumOperands() && "Bad struct index!");
1607       Init = cast<Constant>(CS->getOperand(Idx));
1608     } else if (ConstantArray *CA = dyn_cast<ConstantArray>(Init)) {
1609       if (Idx >= CA->getNumOperands()) return 0;  // Bogus program
1610       Init = cast<Constant>(CA->getOperand(Idx));
1611     } else if (isa<ConstantAggregateZero>(Init)) {
1612       if (const StructType *STy = dyn_cast<StructType>(Init->getType())) {
1613         assert(Idx < STy->getNumElements() && "Bad struct index!");
1614         Init = Constant::getNullValue(STy->getElementType(Idx));
1615       } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Init->getType())) {
1616         if (Idx >= ATy->getNumElements()) return 0;  // Bogus program
1617         Init = Constant::getNullValue(ATy->getElementType());
1618       } else {
1619         assert(0 && "Unknown constant aggregate type!");
1620       }
1621       return 0;
1622     } else {
1623       return 0; // Unknown initializer type
1624     }
1625   }
1626   return Init;
1627 }
1628
1629 /// ComputeLoadConstantCompareIterationCount - Given an exit condition of
1630 /// 'setcc load X, cst', try to se if we can compute the trip count.
1631 SCEVHandle ScalarEvolutionsImpl::
1632 ComputeLoadConstantCompareIterationCount(LoadInst *LI, Constant *RHS,
1633                                          const Loop *L, unsigned SetCCOpcode) {
1634   if (LI->isVolatile()) return UnknownValue;
1635
1636   // Check to see if the loaded pointer is a getelementptr of a global.
1637   GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0));
1638   if (!GEP) return UnknownValue;
1639
1640   // Make sure that it is really a constant global we are gepping, with an
1641   // initializer, and make sure the first IDX is really 0.
1642   GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0));
1643   if (!GV || !GV->isConstant() || !GV->hasInitializer() ||
1644       GEP->getNumOperands() < 3 || !isa<Constant>(GEP->getOperand(1)) ||
1645       !cast<Constant>(GEP->getOperand(1))->isNullValue())
1646     return UnknownValue;
1647
1648   // Okay, we allow one non-constant index into the GEP instruction.
1649   Value *VarIdx = 0;
1650   std::vector<ConstantInt*> Indexes;
1651   unsigned VarIdxNum = 0;
1652   for (unsigned i = 2, e = GEP->getNumOperands(); i != e; ++i)
1653     if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
1654       Indexes.push_back(CI);
1655     } else if (!isa<ConstantInt>(GEP->getOperand(i))) {
1656       if (VarIdx) return UnknownValue;  // Multiple non-constant idx's.
1657       VarIdx = GEP->getOperand(i);
1658       VarIdxNum = i-2;
1659       Indexes.push_back(0);
1660     }
1661
1662   // Okay, we know we have a (load (gep GV, 0, X)) comparison with a constant.
1663   // Check to see if X is a loop variant variable value now.
1664   SCEVHandle Idx = getSCEV(VarIdx);
1665   SCEVHandle Tmp = getSCEVAtScope(Idx, L);
1666   if (!isa<SCEVCouldNotCompute>(Tmp)) Idx = Tmp;
1667
1668   // We can only recognize very limited forms of loop index expressions, in
1669   // particular, only affine AddRec's like {C1,+,C2}.
1670   SCEVAddRecExpr *IdxExpr = dyn_cast<SCEVAddRecExpr>(Idx);
1671   if (!IdxExpr || !IdxExpr->isAffine() || IdxExpr->isLoopInvariant(L) ||
1672       !isa<SCEVConstant>(IdxExpr->getOperand(0)) ||
1673       !isa<SCEVConstant>(IdxExpr->getOperand(1)))
1674     return UnknownValue;
1675
1676   unsigned MaxSteps = MaxBruteForceIterations;
1677   for (unsigned IterationNum = 0; IterationNum != MaxSteps; ++IterationNum) {
1678     ConstantUInt *ItCst =
1679       ConstantUInt::get(IdxExpr->getType()->getUnsignedVersion(), IterationNum);
1680     ConstantInt *Val = EvaluateConstantChrecAtConstant(IdxExpr, ItCst);
1681
1682     // Form the GEP offset.
1683     Indexes[VarIdxNum] = Val;
1684
1685     Constant *Result = GetAddressedElementFromGlobal(GV, Indexes);
1686     if (Result == 0) break;  // Cannot compute!
1687
1688     // Evaluate the condition for this iteration.
1689     Result = ConstantExpr::get(SetCCOpcode, Result, RHS);
1690     if (!isa<ConstantBool>(Result)) break;  // Couldn't decide for sure
1691     if (Result == ConstantBool::False) {
1692 #if 0
1693       std::cerr << "\n***\n*** Computed loop count " << *ItCst
1694                 << "\n*** From global " << *GV << "*** BB: " << *L->getHeader()
1695                 << "***\n";
1696 #endif
1697       ++NumArrayLenItCounts;
1698       return SCEVConstant::get(ItCst);   // Found terminating iteration!
1699     }
1700   }
1701   return UnknownValue;
1702 }
1703
1704
1705 /// CanConstantFold - Return true if we can constant fold an instruction of the
1706 /// specified type, assuming that all operands were constants.
1707 static bool CanConstantFold(const Instruction *I) {
1708   if (isa<BinaryOperator>(I) || isa<ShiftInst>(I) ||
1709       isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I))
1710     return true;
1711
1712   if (const CallInst *CI = dyn_cast<CallInst>(I))
1713     if (const Function *F = CI->getCalledFunction())
1714       return canConstantFoldCallTo((Function*)F);  // FIXME: elim cast
1715   return false;
1716 }
1717
1718 /// ConstantFold - Constant fold an instruction of the specified type with the
1719 /// specified constant operands.  This function may modify the operands vector.
1720 static Constant *ConstantFold(const Instruction *I,
1721                               std::vector<Constant*> &Operands) {
1722   if (isa<BinaryOperator>(I) || isa<ShiftInst>(I))
1723     return ConstantExpr::get(I->getOpcode(), Operands[0], Operands[1]);
1724
1725   switch (I->getOpcode()) {
1726   case Instruction::Cast:
1727     return ConstantExpr::getCast(Operands[0], I->getType());
1728   case Instruction::Select:
1729     return ConstantExpr::getSelect(Operands[0], Operands[1], Operands[2]);
1730   case Instruction::Call:
1731     if (Function *GV = dyn_cast<Function>(Operands[0])) {
1732       Operands.erase(Operands.begin());
1733       return ConstantFoldCall(cast<Function>(GV), Operands);
1734     }
1735
1736     return 0;
1737   case Instruction::GetElementPtr:
1738     Constant *Base = Operands[0];
1739     Operands.erase(Operands.begin());
1740     return ConstantExpr::getGetElementPtr(Base, Operands);
1741   }
1742   return 0;
1743 }
1744
1745
1746 /// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node
1747 /// in the loop that V is derived from.  We allow arbitrary operations along the
1748 /// way, but the operands of an operation must either be constants or a value
1749 /// derived from a constant PHI.  If this expression does not fit with these
1750 /// constraints, return null.
1751 static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) {
1752   // If this is not an instruction, or if this is an instruction outside of the
1753   // loop, it can't be derived from a loop PHI.
1754   Instruction *I = dyn_cast<Instruction>(V);
1755   if (I == 0 || !L->contains(I->getParent())) return 0;
1756
1757   if (PHINode *PN = dyn_cast<PHINode>(I))
1758     if (L->getHeader() == I->getParent())
1759       return PN;
1760     else
1761       // We don't currently keep track of the control flow needed to evaluate
1762       // PHIs, so we cannot handle PHIs inside of loops.
1763       return 0;
1764
1765   // If we won't be able to constant fold this expression even if the operands
1766   // are constants, return early.
1767   if (!CanConstantFold(I)) return 0;
1768
1769   // Otherwise, we can evaluate this instruction if all of its operands are
1770   // constant or derived from a PHI node themselves.
1771   PHINode *PHI = 0;
1772   for (unsigned Op = 0, e = I->getNumOperands(); Op != e; ++Op)
1773     if (!(isa<Constant>(I->getOperand(Op)) ||
1774           isa<GlobalValue>(I->getOperand(Op)))) {
1775       PHINode *P = getConstantEvolvingPHI(I->getOperand(Op), L);
1776       if (P == 0) return 0;  // Not evolving from PHI
1777       if (PHI == 0)
1778         PHI = P;
1779       else if (PHI != P)
1780         return 0;  // Evolving from multiple different PHIs.
1781     }
1782
1783   // This is a expression evolving from a constant PHI!
1784   return PHI;
1785 }
1786
1787 /// EvaluateExpression - Given an expression that passes the
1788 /// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node
1789 /// in the loop has the value PHIVal.  If we can't fold this expression for some
1790 /// reason, return null.
1791 static Constant *EvaluateExpression(Value *V, Constant *PHIVal) {
1792   if (isa<PHINode>(V)) return PHIVal;
1793   if (GlobalValue *GV = dyn_cast<GlobalValue>(V))
1794     return GV;
1795   if (Constant *C = dyn_cast<Constant>(V)) return C;
1796   Instruction *I = cast<Instruction>(V);
1797
1798   std::vector<Constant*> Operands;
1799   Operands.resize(I->getNumOperands());
1800
1801   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
1802     Operands[i] = EvaluateExpression(I->getOperand(i), PHIVal);
1803     if (Operands[i] == 0) return 0;
1804   }
1805
1806   return ConstantFold(I, Operands);
1807 }
1808
1809 /// getConstantEvolutionLoopExitValue - If we know that the specified Phi is
1810 /// in the header of its containing loop, we know the loop executes a
1811 /// constant number of times, and the PHI node is just a recurrence
1812 /// involving constants, fold it.
1813 Constant *ScalarEvolutionsImpl::
1814 getConstantEvolutionLoopExitValue(PHINode *PN, uint64_t Its, const Loop *L) {
1815   std::map<PHINode*, Constant*>::iterator I =
1816     ConstantEvolutionLoopExitValue.find(PN);
1817   if (I != ConstantEvolutionLoopExitValue.end())
1818     return I->second;
1819
1820   if (Its > MaxBruteForceIterations)
1821     return ConstantEvolutionLoopExitValue[PN] = 0;  // Not going to evaluate it.
1822
1823   Constant *&RetVal = ConstantEvolutionLoopExitValue[PN];
1824
1825   // Since the loop is canonicalized, the PHI node must have two entries.  One
1826   // entry must be a constant (coming in from outside of the loop), and the
1827   // second must be derived from the same PHI.
1828   bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
1829   Constant *StartCST =
1830     dyn_cast<Constant>(PN->getIncomingValue(!SecondIsBackedge));
1831   if (StartCST == 0)
1832     return RetVal = 0;  // Must be a constant.
1833
1834   Value *BEValue = PN->getIncomingValue(SecondIsBackedge);
1835   PHINode *PN2 = getConstantEvolvingPHI(BEValue, L);
1836   if (PN2 != PN)
1837     return RetVal = 0;  // Not derived from same PHI.
1838
1839   // Execute the loop symbolically to determine the exit value.
1840   unsigned IterationNum = 0;
1841   unsigned NumIterations = Its;
1842   if (NumIterations != Its)
1843     return RetVal = 0;  // More than 2^32 iterations??
1844
1845   for (Constant *PHIVal = StartCST; ; ++IterationNum) {
1846     if (IterationNum == NumIterations)
1847       return RetVal = PHIVal;  // Got exit value!
1848
1849     // Compute the value of the PHI node for the next iteration.
1850     Constant *NextPHI = EvaluateExpression(BEValue, PHIVal);
1851     if (NextPHI == PHIVal)
1852       return RetVal = NextPHI;  // Stopped evolving!
1853     if (NextPHI == 0)
1854       return 0;        // Couldn't evaluate!
1855     PHIVal = NextPHI;
1856   }
1857 }
1858
1859 /// ComputeIterationCountExhaustively - If the trip is known to execute a
1860 /// constant number of times (the condition evolves only from constants),
1861 /// try to evaluate a few iterations of the loop until we get the exit
1862 /// condition gets a value of ExitWhen (true or false).  If we cannot
1863 /// evaluate the trip count of the loop, return UnknownValue.
1864 SCEVHandle ScalarEvolutionsImpl::
1865 ComputeIterationCountExhaustively(const Loop *L, Value *Cond, bool ExitWhen) {
1866   PHINode *PN = getConstantEvolvingPHI(Cond, L);
1867   if (PN == 0) return UnknownValue;
1868
1869   // Since the loop is canonicalized, the PHI node must have two entries.  One
1870   // entry must be a constant (coming in from outside of the loop), and the
1871   // second must be derived from the same PHI.
1872   bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
1873   Constant *StartCST =
1874     dyn_cast<Constant>(PN->getIncomingValue(!SecondIsBackedge));
1875   if (StartCST == 0) return UnknownValue;  // Must be a constant.
1876
1877   Value *BEValue = PN->getIncomingValue(SecondIsBackedge);
1878   PHINode *PN2 = getConstantEvolvingPHI(BEValue, L);
1879   if (PN2 != PN) return UnknownValue;  // Not derived from same PHI.
1880
1881   // Okay, we find a PHI node that defines the trip count of this loop.  Execute
1882   // the loop symbolically to determine when the condition gets a value of
1883   // "ExitWhen".
1884   unsigned IterationNum = 0;
1885   unsigned MaxIterations = MaxBruteForceIterations;   // Limit analysis.
1886   for (Constant *PHIVal = StartCST;
1887        IterationNum != MaxIterations; ++IterationNum) {
1888     ConstantBool *CondVal =
1889       dyn_cast_or_null<ConstantBool>(EvaluateExpression(Cond, PHIVal));
1890     if (!CondVal) return UnknownValue;     // Couldn't symbolically evaluate.
1891
1892     if (CondVal->getValue() == ExitWhen) {
1893       ConstantEvolutionLoopExitValue[PN] = PHIVal;
1894       ++NumBruteForceTripCountsComputed;
1895       return SCEVConstant::get(ConstantUInt::get(Type::UIntTy, IterationNum));
1896     }
1897
1898     // Compute the value of the PHI node for the next iteration.
1899     Constant *NextPHI = EvaluateExpression(BEValue, PHIVal);
1900     if (NextPHI == 0 || NextPHI == PHIVal)
1901       return UnknownValue;  // Couldn't evaluate or not making progress...
1902     PHIVal = NextPHI;
1903   }
1904
1905   // Too many iterations were needed to evaluate.
1906   return UnknownValue;
1907 }
1908
1909 /// getSCEVAtScope - Compute the value of the specified expression within the
1910 /// indicated loop (which may be null to indicate in no loop).  If the
1911 /// expression cannot be evaluated, return UnknownValue.
1912 SCEVHandle ScalarEvolutionsImpl::getSCEVAtScope(SCEV *V, const Loop *L) {
1913   // FIXME: this should be turned into a virtual method on SCEV!
1914
1915   if (isa<SCEVConstant>(V)) return V;
1916
1917   // If this instruction is evolves from a constant-evolving PHI, compute the
1918   // exit value from the loop without using SCEVs.
1919   if (SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) {
1920     if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) {
1921       const Loop *LI = this->LI[I->getParent()];
1922       if (LI && LI->getParentLoop() == L)  // Looking for loop exit value.
1923         if (PHINode *PN = dyn_cast<PHINode>(I))
1924           if (PN->getParent() == LI->getHeader()) {
1925             // Okay, there is no closed form solution for the PHI node.  Check
1926             // to see if the loop that contains it has a known iteration count.
1927             // If so, we may be able to force computation of the exit value.
1928             SCEVHandle IterationCount = getIterationCount(LI);
1929             if (SCEVConstant *ICC = dyn_cast<SCEVConstant>(IterationCount)) {
1930               // Okay, we know how many times the containing loop executes.  If
1931               // this is a constant evolving PHI node, get the final value at
1932               // the specified iteration number.
1933               Constant *RV = getConstantEvolutionLoopExitValue(PN,
1934                                                ICC->getValue()->getRawValue(),
1935                                                                LI);
1936               if (RV) return SCEVUnknown::get(RV);
1937             }
1938           }
1939
1940       // Okay, this is a some expression that we cannot symbolically evaluate
1941       // into a SCEV.  Check to see if it's possible to symbolically evaluate
1942       // the arguments into constants, and if see, try to constant propagate the
1943       // result.  This is particularly useful for computing loop exit values.
1944       if (CanConstantFold(I)) {
1945         std::vector<Constant*> Operands;
1946         Operands.reserve(I->getNumOperands());
1947         for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
1948           Value *Op = I->getOperand(i);
1949           if (Constant *C = dyn_cast<Constant>(Op)) {
1950             Operands.push_back(C);
1951           } else {
1952             SCEVHandle OpV = getSCEVAtScope(getSCEV(Op), L);
1953             if (SCEVConstant *SC = dyn_cast<SCEVConstant>(OpV))
1954               Operands.push_back(ConstantExpr::getCast(SC->getValue(),
1955                                                        Op->getType()));
1956             else if (SCEVUnknown *SU = dyn_cast<SCEVUnknown>(OpV)) {
1957               if (Constant *C = dyn_cast<Constant>(SU->getValue()))
1958                 Operands.push_back(ConstantExpr::getCast(C, Op->getType()));
1959               else
1960                 return V;
1961             } else {
1962               return V;
1963             }
1964           }
1965         }
1966         return SCEVUnknown::get(ConstantFold(I, Operands));
1967       }
1968     }
1969
1970     // This is some other type of SCEVUnknown, just return it.
1971     return V;
1972   }
1973
1974   if (SCEVCommutativeExpr *Comm = dyn_cast<SCEVCommutativeExpr>(V)) {
1975     // Avoid performing the look-up in the common case where the specified
1976     // expression has no loop-variant portions.
1977     for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) {
1978       SCEVHandle OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
1979       if (OpAtScope != Comm->getOperand(i)) {
1980         if (OpAtScope == UnknownValue) return UnknownValue;
1981         // Okay, at least one of these operands is loop variant but might be
1982         // foldable.  Build a new instance of the folded commutative expression.
1983         std::vector<SCEVHandle> NewOps(Comm->op_begin(), Comm->op_begin()+i);
1984         NewOps.push_back(OpAtScope);
1985
1986         for (++i; i != e; ++i) {
1987           OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
1988           if (OpAtScope == UnknownValue) return UnknownValue;
1989           NewOps.push_back(OpAtScope);
1990         }
1991         if (isa<SCEVAddExpr>(Comm))
1992           return SCEVAddExpr::get(NewOps);
1993         assert(isa<SCEVMulExpr>(Comm) && "Only know about add and mul!");
1994         return SCEVMulExpr::get(NewOps);
1995       }
1996     }
1997     // If we got here, all operands are loop invariant.
1998     return Comm;
1999   }
2000
2001   if (SCEVSDivExpr *Div = dyn_cast<SCEVSDivExpr>(V)) {
2002     SCEVHandle LHS = getSCEVAtScope(Div->getLHS(), L);
2003     if (LHS == UnknownValue) return LHS;
2004     SCEVHandle RHS = getSCEVAtScope(Div->getRHS(), L);
2005     if (RHS == UnknownValue) return RHS;
2006     if (LHS == Div->getLHS() && RHS == Div->getRHS())
2007       return Div;   // must be loop invariant
2008     return SCEVSDivExpr::get(LHS, RHS);
2009   }
2010
2011   // If this is a loop recurrence for a loop that does not contain L, then we
2012   // are dealing with the final value computed by the loop.
2013   if (SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) {
2014     if (!L || !AddRec->getLoop()->contains(L->getHeader())) {
2015       // To evaluate this recurrence, we need to know how many times the AddRec
2016       // loop iterates.  Compute this now.
2017       SCEVHandle IterationCount = getIterationCount(AddRec->getLoop());
2018       if (IterationCount == UnknownValue) return UnknownValue;
2019       IterationCount = getTruncateOrZeroExtend(IterationCount,
2020                                                AddRec->getType());
2021
2022       // If the value is affine, simplify the expression evaluation to just
2023       // Start + Step*IterationCount.
2024       if (AddRec->isAffine())
2025         return SCEVAddExpr::get(AddRec->getStart(),
2026                                 SCEVMulExpr::get(IterationCount,
2027                                                  AddRec->getOperand(1)));
2028
2029       // Otherwise, evaluate it the hard way.
2030       return AddRec->evaluateAtIteration(IterationCount);
2031     }
2032     return UnknownValue;
2033   }
2034
2035   //assert(0 && "Unknown SCEV type!");
2036   return UnknownValue;
2037 }
2038
2039
2040 /// SolveQuadraticEquation - Find the roots of the quadratic equation for the
2041 /// given quadratic chrec {L,+,M,+,N}.  This returns either the two roots (which
2042 /// might be the same) or two SCEVCouldNotCompute objects.
2043 ///
2044 static std::pair<SCEVHandle,SCEVHandle>
2045 SolveQuadraticEquation(const SCEVAddRecExpr *AddRec) {
2046   assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!");
2047   SCEVConstant *L = dyn_cast<SCEVConstant>(AddRec->getOperand(0));
2048   SCEVConstant *M = dyn_cast<SCEVConstant>(AddRec->getOperand(1));
2049   SCEVConstant *N = dyn_cast<SCEVConstant>(AddRec->getOperand(2));
2050
2051   // We currently can only solve this if the coefficients are constants.
2052   if (!L || !M || !N) {
2053     SCEV *CNC = new SCEVCouldNotCompute();
2054     return std::make_pair(CNC, CNC);
2055   }
2056
2057   Constant *Two = ConstantInt::get(L->getValue()->getType(), 2);
2058
2059   // Convert from chrec coefficients to polynomial coefficients AX^2+BX+C
2060   Constant *C = L->getValue();
2061   // The B coefficient is M-N/2
2062   Constant *B = ConstantExpr::getSub(M->getValue(),
2063                                      ConstantExpr::getDiv(N->getValue(),
2064                                                           Two));
2065   // The A coefficient is N/2
2066   Constant *A = ConstantExpr::getDiv(N->getValue(), Two);
2067
2068   // Compute the B^2-4ac term.
2069   Constant *SqrtTerm =
2070     ConstantExpr::getMul(ConstantInt::get(C->getType(), 4),
2071                          ConstantExpr::getMul(A, C));
2072   SqrtTerm = ConstantExpr::getSub(ConstantExpr::getMul(B, B), SqrtTerm);
2073
2074   // Compute floor(sqrt(B^2-4ac))
2075   ConstantUInt *SqrtVal =
2076     cast<ConstantUInt>(ConstantExpr::getCast(SqrtTerm,
2077                                    SqrtTerm->getType()->getUnsignedVersion()));
2078   uint64_t SqrtValV = SqrtVal->getValue();
2079   uint64_t SqrtValV2 = (uint64_t)sqrt((double)SqrtValV);
2080   // The square root might not be precise for arbitrary 64-bit integer
2081   // values.  Do some sanity checks to ensure it's correct.
2082   if (SqrtValV2*SqrtValV2 > SqrtValV ||
2083       (SqrtValV2+1)*(SqrtValV2+1) <= SqrtValV) {
2084     SCEV *CNC = new SCEVCouldNotCompute();
2085     return std::make_pair(CNC, CNC);
2086   }
2087
2088   SqrtVal = ConstantUInt::get(Type::ULongTy, SqrtValV2);
2089   SqrtTerm = ConstantExpr::getCast(SqrtVal, SqrtTerm->getType());
2090
2091   Constant *NegB = ConstantExpr::getNeg(B);
2092   Constant *TwoA = ConstantExpr::getMul(A, Two);
2093
2094   // The divisions must be performed as signed divisions.
2095   const Type *SignedTy = NegB->getType()->getSignedVersion();
2096   NegB = ConstantExpr::getCast(NegB, SignedTy);
2097   TwoA = ConstantExpr::getCast(TwoA, SignedTy);
2098   SqrtTerm = ConstantExpr::getCast(SqrtTerm, SignedTy);
2099
2100   Constant *Solution1 =
2101     ConstantExpr::getDiv(ConstantExpr::getAdd(NegB, SqrtTerm), TwoA);
2102   Constant *Solution2 =
2103     ConstantExpr::getDiv(ConstantExpr::getSub(NegB, SqrtTerm), TwoA);
2104   return std::make_pair(SCEVUnknown::get(Solution1),
2105                         SCEVUnknown::get(Solution2));
2106 }
2107
2108 /// HowFarToZero - Return the number of times a backedge comparing the specified
2109 /// value to zero will execute.  If not computable, return UnknownValue
2110 SCEVHandle ScalarEvolutionsImpl::HowFarToZero(SCEV *V, const Loop *L) {
2111   // If the value is a constant
2112   if (SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
2113     // If the value is already zero, the branch will execute zero times.
2114     if (C->getValue()->isNullValue()) return C;
2115     return UnknownValue;  // Otherwise it will loop infinitely.
2116   }
2117
2118   SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V);
2119   if (!AddRec || AddRec->getLoop() != L)
2120     return UnknownValue;
2121
2122   if (AddRec->isAffine()) {
2123     // If this is an affine expression the execution count of this branch is
2124     // equal to:
2125     //
2126     //     (0 - Start/Step)    iff   Start % Step == 0
2127     //
2128     // Get the initial value for the loop.
2129     SCEVHandle Start = getSCEVAtScope(AddRec->getStart(), L->getParentLoop());
2130     if (isa<SCEVCouldNotCompute>(Start)) return UnknownValue;
2131     SCEVHandle Step = AddRec->getOperand(1);
2132
2133     Step = getSCEVAtScope(Step, L->getParentLoop());
2134
2135     // Figure out if Start % Step == 0.
2136     // FIXME: We should add DivExpr and RemExpr operations to our AST.
2137     if (SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step)) {
2138       if (StepC->getValue()->equalsInt(1))      // N % 1 == 0
2139         return SCEV::getNegativeSCEV(Start);  // 0 - Start/1 == -Start
2140       if (StepC->getValue()->isAllOnesValue())  // N % -1 == 0
2141         return Start;                   // 0 - Start/-1 == Start
2142
2143       // Check to see if Start is divisible by SC with no remainder.
2144       if (SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start)) {
2145         ConstantInt *StartCC = StartC->getValue();
2146         Constant *StartNegC = ConstantExpr::getNeg(StartCC);
2147         Constant *Rem = ConstantExpr::getRem(StartNegC, StepC->getValue());
2148         if (Rem->isNullValue()) {
2149           Constant *Result =ConstantExpr::getDiv(StartNegC,StepC->getValue());
2150           return SCEVUnknown::get(Result);
2151         }
2152       }
2153     }
2154   } else if (AddRec->isQuadratic() && AddRec->getType()->isInteger()) {
2155     // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of
2156     // the quadratic equation to solve it.
2157     std::pair<SCEVHandle,SCEVHandle> Roots = SolveQuadraticEquation(AddRec);
2158     SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
2159     SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
2160     if (R1) {
2161 #if 0
2162       std::cerr << "HFTZ: " << *V << " - sol#1: " << *R1
2163                 << "  sol#2: " << *R2 << "\n";
2164 #endif
2165       // Pick the smallest positive root value.
2166       assert(R1->getType()->isUnsigned()&&"Didn't canonicalize to unsigned?");
2167       if (ConstantBool *CB =
2168           dyn_cast<ConstantBool>(ConstantExpr::getSetLT(R1->getValue(),
2169                                                         R2->getValue()))) {
2170         if (CB != ConstantBool::True)
2171           std::swap(R1, R2);   // R1 is the minimum root now.
2172
2173         // We can only use this value if the chrec ends up with an exact zero
2174         // value at this index.  When solving for "X*X != 5", for example, we
2175         // should not accept a root of 2.
2176         SCEVHandle Val = AddRec->evaluateAtIteration(R1);
2177         if (SCEVConstant *EvalVal = dyn_cast<SCEVConstant>(Val))
2178           if (EvalVal->getValue()->isNullValue())
2179             return R1;  // We found a quadratic root!
2180       }
2181     }
2182   }
2183
2184   return UnknownValue;
2185 }
2186
2187 /// HowFarToNonZero - Return the number of times a backedge checking the
2188 /// specified value for nonzero will execute.  If not computable, return
2189 /// UnknownValue
2190 SCEVHandle ScalarEvolutionsImpl::HowFarToNonZero(SCEV *V, const Loop *L) {
2191   // Loops that look like: while (X == 0) are very strange indeed.  We don't
2192   // handle them yet except for the trivial case.  This could be expanded in the
2193   // future as needed.
2194
2195   // If the value is a constant, check to see if it is known to be non-zero
2196   // already.  If so, the backedge will execute zero times.
2197   if (SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
2198     Constant *Zero = Constant::getNullValue(C->getValue()->getType());
2199     Constant *NonZero = ConstantExpr::getSetNE(C->getValue(), Zero);
2200     if (NonZero == ConstantBool::True)
2201       return getSCEV(Zero);
2202     return UnknownValue;  // Otherwise it will loop infinitely.
2203   }
2204
2205   // We could implement others, but I really doubt anyone writes loops like
2206   // this, and if they did, they would already be constant folded.
2207   return UnknownValue;
2208 }
2209
2210 /// HowManyLessThans - Return the number of times a backedge containing the
2211 /// specified less-than comparison will execute.  If not computable, return
2212 /// UnknownValue.
2213 SCEVHandle ScalarEvolutionsImpl::
2214 HowManyLessThans(SCEV *LHS, SCEV *RHS, const Loop *L) {
2215   // Only handle:  "ADDREC < LoopInvariant".
2216   if (!RHS->isLoopInvariant(L)) return UnknownValue;
2217
2218   SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS);
2219   if (!AddRec || AddRec->getLoop() != L)
2220     return UnknownValue;
2221
2222   if (AddRec->isAffine()) {
2223     // FORNOW: We only support unit strides.
2224     SCEVHandle One = SCEVUnknown::getIntegerSCEV(1, RHS->getType());
2225     if (AddRec->getOperand(1) != One)
2226       return UnknownValue;
2227
2228     // The number of iterations for "[n,+,1] < m", is m-n.  However, we don't
2229     // know that m is >= n on input to the loop.  If it is, the condition return
2230     // true zero times.  What we really should return, for full generality, is
2231     // SMAX(0, m-n).  Since we cannot check this, we will instead check for a
2232     // canonical loop form: most do-loops will have a check that dominates the
2233     // loop, that only enters the loop if [n-1]<m.  If we can find this check,
2234     // we know that the SMAX will evaluate to m-n, because we know that m >= n.
2235
2236     // Search for the check.
2237     BasicBlock *Preheader = L->getLoopPreheader();
2238     BasicBlock *PreheaderDest = L->getHeader();
2239     if (Preheader == 0) return UnknownValue;
2240
2241     BranchInst *LoopEntryPredicate =
2242       dyn_cast<BranchInst>(Preheader->getTerminator());
2243     if (!LoopEntryPredicate) return UnknownValue;
2244
2245     // This might be a critical edge broken out.  If the loop preheader ends in
2246     // an unconditional branch to the loop, check to see if the preheader has a
2247     // single predecessor, and if so, look for its terminator.
2248     while (LoopEntryPredicate->isUnconditional()) {
2249       PreheaderDest = Preheader;
2250       Preheader = Preheader->getSinglePredecessor();
2251       if (!Preheader) return UnknownValue;  // Multiple preds.
2252       
2253       LoopEntryPredicate =
2254         dyn_cast<BranchInst>(Preheader->getTerminator());
2255       if (!LoopEntryPredicate) return UnknownValue;
2256     }
2257
2258     // Now that we found a conditional branch that dominates the loop, check to
2259     // see if it is the comparison we are looking for.
2260     SetCondInst *SCI =dyn_cast<SetCondInst>(LoopEntryPredicate->getCondition());
2261     if (!SCI) return UnknownValue;
2262     Value *PreCondLHS = SCI->getOperand(0);
2263     Value *PreCondRHS = SCI->getOperand(1);
2264     Instruction::BinaryOps Cond;
2265     if (LoopEntryPredicate->getSuccessor(0) == PreheaderDest)
2266       Cond = SCI->getOpcode();
2267     else
2268       Cond = SCI->getInverseCondition();
2269     
2270     switch (Cond) {
2271     case Instruction::SetGT:
2272       std::swap(PreCondLHS, PreCondRHS);
2273       Cond = Instruction::SetLT;
2274       // Fall Through.
2275     case Instruction::SetLT:
2276       if (PreCondLHS->getType()->isInteger() &&
2277           PreCondLHS->getType()->isSigned()) { 
2278         if (RHS != getSCEV(PreCondRHS))
2279           return UnknownValue;  // Not a comparison against 'm'.
2280
2281         if (SCEV::getMinusSCEV(AddRec->getOperand(0), One)
2282                     != getSCEV(PreCondLHS))
2283           return UnknownValue;  // Not a comparison against 'n-1'.
2284         break;
2285       } else {
2286         return UnknownValue;
2287       }
2288     default: break;
2289     }
2290
2291     //std::cerr << "Computed Loop Trip Count as: " <<
2292     //  *SCEV::getMinusSCEV(RHS, AddRec->getOperand(0)) << "\n";
2293     return SCEV::getMinusSCEV(RHS, AddRec->getOperand(0));
2294   }
2295
2296   return UnknownValue;
2297 }
2298
2299 /// getNumIterationsInRange - Return the number of iterations of this loop that
2300 /// produce values in the specified constant range.  Another way of looking at
2301 /// this is that it returns the first iteration number where the value is not in
2302 /// the condition, thus computing the exit count. If the iteration count can't
2303 /// be computed, an instance of SCEVCouldNotCompute is returned.
2304 SCEVHandle SCEVAddRecExpr::getNumIterationsInRange(ConstantRange Range) const {
2305   if (Range.isFullSet())  // Infinite loop.
2306     return new SCEVCouldNotCompute();
2307
2308   // If the start is a non-zero constant, shift the range to simplify things.
2309   if (SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart()))
2310     if (!SC->getValue()->isNullValue()) {
2311       std::vector<SCEVHandle> Operands(op_begin(), op_end());
2312       Operands[0] = SCEVUnknown::getIntegerSCEV(0, SC->getType());
2313       SCEVHandle Shifted = SCEVAddRecExpr::get(Operands, getLoop());
2314       if (SCEVAddRecExpr *ShiftedAddRec = dyn_cast<SCEVAddRecExpr>(Shifted))
2315         return ShiftedAddRec->getNumIterationsInRange(
2316                                               Range.subtract(SC->getValue()));
2317       // This is strange and shouldn't happen.
2318       return new SCEVCouldNotCompute();
2319     }
2320
2321   // The only time we can solve this is when we have all constant indices.
2322   // Otherwise, we cannot determine the overflow conditions.
2323   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2324     if (!isa<SCEVConstant>(getOperand(i)))
2325       return new SCEVCouldNotCompute();
2326
2327
2328   // Okay at this point we know that all elements of the chrec are constants and
2329   // that the start element is zero.
2330
2331   // First check to see if the range contains zero.  If not, the first
2332   // iteration exits.
2333   ConstantInt *Zero = ConstantInt::get(getType(), 0);
2334   if (!Range.contains(Zero)) return SCEVConstant::get(Zero);
2335
2336   if (isAffine()) {
2337     // If this is an affine expression then we have this situation:
2338     //   Solve {0,+,A} in Range  ===  Ax in Range
2339
2340     // Since we know that zero is in the range, we know that the upper value of
2341     // the range must be the first possible exit value.  Also note that we
2342     // already checked for a full range.
2343     ConstantInt *Upper = cast<ConstantInt>(Range.getUpper());
2344     ConstantInt *A     = cast<SCEVConstant>(getOperand(1))->getValue();
2345     ConstantInt *One   = ConstantInt::get(getType(), 1);
2346
2347     // The exit value should be (Upper+A-1)/A.
2348     Constant *ExitValue = Upper;
2349     if (A != One) {
2350       ExitValue = ConstantExpr::getSub(ConstantExpr::getAdd(Upper, A), One);
2351       ExitValue = ConstantExpr::getDiv(ExitValue, A);
2352     }
2353     assert(isa<ConstantInt>(ExitValue) &&
2354            "Constant folding of integers not implemented?");
2355
2356     // Evaluate at the exit value.  If we really did fall out of the valid
2357     // range, then we computed our trip count, otherwise wrap around or other
2358     // things must have happened.
2359     ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue);
2360     if (Range.contains(Val))
2361       return new SCEVCouldNotCompute();  // Something strange happened
2362
2363     // Ensure that the previous value is in the range.  This is a sanity check.
2364     assert(Range.contains(EvaluateConstantChrecAtConstant(this,
2365                               ConstantExpr::getSub(ExitValue, One))) &&
2366            "Linear scev computation is off in a bad way!");
2367     return SCEVConstant::get(cast<ConstantInt>(ExitValue));
2368   } else if (isQuadratic()) {
2369     // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of the
2370     // quadratic equation to solve it.  To do this, we must frame our problem in
2371     // terms of figuring out when zero is crossed, instead of when
2372     // Range.getUpper() is crossed.
2373     std::vector<SCEVHandle> NewOps(op_begin(), op_end());
2374     NewOps[0] = SCEV::getNegativeSCEV(SCEVUnknown::get(Range.getUpper()));
2375     SCEVHandle NewAddRec = SCEVAddRecExpr::get(NewOps, getLoop());
2376
2377     // Next, solve the constructed addrec
2378     std::pair<SCEVHandle,SCEVHandle> Roots =
2379       SolveQuadraticEquation(cast<SCEVAddRecExpr>(NewAddRec));
2380     SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
2381     SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
2382     if (R1) {
2383       // Pick the smallest positive root value.
2384       assert(R1->getType()->isUnsigned() && "Didn't canonicalize to unsigned?");
2385       if (ConstantBool *CB =
2386           dyn_cast<ConstantBool>(ConstantExpr::getSetLT(R1->getValue(),
2387                                                         R2->getValue()))) {
2388         if (CB != ConstantBool::True)
2389           std::swap(R1, R2);   // R1 is the minimum root now.
2390
2391         // Make sure the root is not off by one.  The returned iteration should
2392         // not be in the range, but the previous one should be.  When solving
2393         // for "X*X < 5", for example, we should not return a root of 2.
2394         ConstantInt *R1Val = EvaluateConstantChrecAtConstant(this,
2395                                                              R1->getValue());
2396         if (Range.contains(R1Val)) {
2397           // The next iteration must be out of the range...
2398           Constant *NextVal =
2399             ConstantExpr::getAdd(R1->getValue(),
2400                                  ConstantInt::get(R1->getType(), 1));
2401
2402           R1Val = EvaluateConstantChrecAtConstant(this, NextVal);
2403           if (!Range.contains(R1Val))
2404             return SCEVUnknown::get(NextVal);
2405           return new SCEVCouldNotCompute();  // Something strange happened
2406         }
2407
2408         // If R1 was not in the range, then it is a good return value.  Make
2409         // sure that R1-1 WAS in the range though, just in case.
2410         Constant *NextVal =
2411           ConstantExpr::getSub(R1->getValue(),
2412                                ConstantInt::get(R1->getType(), 1));
2413         R1Val = EvaluateConstantChrecAtConstant(this, NextVal);
2414         if (Range.contains(R1Val))
2415           return R1;
2416         return new SCEVCouldNotCompute();  // Something strange happened
2417       }
2418     }
2419   }
2420
2421   // Fallback, if this is a general polynomial, figure out the progression
2422   // through brute force: evaluate until we find an iteration that fails the
2423   // test.  This is likely to be slow, but getting an accurate trip count is
2424   // incredibly important, we will be able to simplify the exit test a lot, and
2425   // we are almost guaranteed to get a trip count in this case.
2426   ConstantInt *TestVal = ConstantInt::get(getType(), 0);
2427   ConstantInt *One     = ConstantInt::get(getType(), 1);
2428   ConstantInt *EndVal  = TestVal;  // Stop when we wrap around.
2429   do {
2430     ++NumBruteForceEvaluations;
2431     SCEVHandle Val = evaluateAtIteration(SCEVConstant::get(TestVal));
2432     if (!isa<SCEVConstant>(Val))  // This shouldn't happen.
2433       return new SCEVCouldNotCompute();
2434
2435     // Check to see if we found the value!
2436     if (!Range.contains(cast<SCEVConstant>(Val)->getValue()))
2437       return SCEVConstant::get(TestVal);
2438
2439     // Increment to test the next index.
2440     TestVal = cast<ConstantInt>(ConstantExpr::getAdd(TestVal, One));
2441   } while (TestVal != EndVal);
2442
2443   return new SCEVCouldNotCompute();
2444 }
2445
2446
2447
2448 //===----------------------------------------------------------------------===//
2449 //                   ScalarEvolution Class Implementation
2450 //===----------------------------------------------------------------------===//
2451
2452 bool ScalarEvolution::runOnFunction(Function &F) {
2453   Impl = new ScalarEvolutionsImpl(F, getAnalysis<LoopInfo>());
2454   return false;
2455 }
2456
2457 void ScalarEvolution::releaseMemory() {
2458   delete (ScalarEvolutionsImpl*)Impl;
2459   Impl = 0;
2460 }
2461
2462 void ScalarEvolution::getAnalysisUsage(AnalysisUsage &AU) const {
2463   AU.setPreservesAll();
2464   AU.addRequiredTransitive<LoopInfo>();
2465 }
2466
2467 SCEVHandle ScalarEvolution::getSCEV(Value *V) const {
2468   return ((ScalarEvolutionsImpl*)Impl)->getSCEV(V);
2469 }
2470
2471 /// hasSCEV - Return true if the SCEV for this value has already been
2472 /// computed.
2473 bool ScalarEvolution::hasSCEV(Value *V) const {
2474   return ((ScalarEvolutionsImpl*)Impl)->hasSCEV(V);
2475 }
2476
2477
2478 /// setSCEV - Insert the specified SCEV into the map of current SCEVs for
2479 /// the specified value.
2480 void ScalarEvolution::setSCEV(Value *V, const SCEVHandle &H) {
2481   ((ScalarEvolutionsImpl*)Impl)->setSCEV(V, H);
2482 }
2483
2484
2485 SCEVHandle ScalarEvolution::getIterationCount(const Loop *L) const {
2486   return ((ScalarEvolutionsImpl*)Impl)->getIterationCount(L);
2487 }
2488
2489 bool ScalarEvolution::hasLoopInvariantIterationCount(const Loop *L) const {
2490   return !isa<SCEVCouldNotCompute>(getIterationCount(L));
2491 }
2492
2493 SCEVHandle ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) const {
2494   return ((ScalarEvolutionsImpl*)Impl)->getSCEVAtScope(getSCEV(V), L);
2495 }
2496
2497 void ScalarEvolution::deleteInstructionFromRecords(Instruction *I) const {
2498   return ((ScalarEvolutionsImpl*)Impl)->deleteInstructionFromRecords(I);
2499 }
2500
2501 static void PrintLoopInfo(std::ostream &OS, const ScalarEvolution *SE,
2502                           const Loop *L) {
2503   // Print all inner loops first
2504   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
2505     PrintLoopInfo(OS, SE, *I);
2506
2507   std::cerr << "Loop " << L->getHeader()->getName() << ": ";
2508
2509   std::vector<BasicBlock*> ExitBlocks;
2510   L->getExitBlocks(ExitBlocks);
2511   if (ExitBlocks.size() != 1)
2512     std::cerr << "<multiple exits> ";
2513
2514   if (SE->hasLoopInvariantIterationCount(L)) {
2515     std::cerr << *SE->getIterationCount(L) << " iterations! ";
2516   } else {
2517     std::cerr << "Unpredictable iteration count. ";
2518   }
2519
2520   std::cerr << "\n";
2521 }
2522
2523 void ScalarEvolution::print(std::ostream &OS, const Module* ) const {
2524   Function &F = ((ScalarEvolutionsImpl*)Impl)->F;
2525   LoopInfo &LI = ((ScalarEvolutionsImpl*)Impl)->LI;
2526
2527   OS << "Classifying expressions for: " << F.getName() << "\n";
2528   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
2529     if (I->getType()->isInteger()) {
2530       OS << *I;
2531       OS << "  --> ";
2532       SCEVHandle SV = getSCEV(&*I);
2533       SV->print(OS);
2534       OS << "\t\t";
2535
2536       if ((*I).getType()->isIntegral()) {
2537         ConstantRange Bounds = SV->getValueRange();
2538         if (!Bounds.isFullSet())
2539           OS << "Bounds: " << Bounds << " ";
2540       }
2541
2542       if (const Loop *L = LI.getLoopFor((*I).getParent())) {
2543         OS << "Exits: ";
2544         SCEVHandle ExitValue = getSCEVAtScope(&*I, L->getParentLoop());
2545         if (isa<SCEVCouldNotCompute>(ExitValue)) {
2546           OS << "<<Unknown>>";
2547         } else {
2548           OS << *ExitValue;
2549         }
2550       }
2551
2552
2553       OS << "\n";
2554     }
2555
2556   OS << "Determining loop execution counts for: " << F.getName() << "\n";
2557   for (LoopInfo::iterator I = LI.begin(), E = LI.end(); I != E; ++I)
2558     PrintLoopInfo(OS, this, *I);
2559 }
2560