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