Revert r254592 (virtual dtor in SCEVPredicate).
[oota-llvm.git] / lib / Analysis / ScalarEvolution.cpp
1 //===- ScalarEvolution.cpp - Scalar Evolution Analysis --------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file 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. We only create one SCEV of a particular shape, so
18 // pointer-comparisons for equality are legal.
19 //
20 // One important aspect of the SCEV objects is that they are never cyclic, even
21 // if there is a cycle in the dataflow for an expression (ie, a PHI node).  If
22 // the PHI node is one of the idioms that we can represent (e.g., a polynomial
23 // recurrence) then we represent it directly as a recurrence node, otherwise we
24 // represent it as a SCEVUnknown node.
25 //
26 // In addition to being able to represent expressions of various types, we also
27 // have folders that are used to build the *canonical* representation for a
28 // particular expression.  These folders are capable of using a variety of
29 // rewrite rules to simplify the expressions.
30 //
31 // Once the folders are defined, we can implement the more interesting
32 // higher-level code, such as the code that recognizes PHI nodes of various
33 // types, computes the execution count of a loop, etc.
34 //
35 // TODO: We should use these routines and value representations to implement
36 // dependence analysis!
37 //
38 //===----------------------------------------------------------------------===//
39 //
40 // There are several good references for the techniques used in this analysis.
41 //
42 //  Chains of recurrences -- a method to expedite the evaluation
43 //  of closed-form functions
44 //  Olaf Bachmann, Paul S. Wang, Eugene V. Zima
45 //
46 //  On computational properties of chains of recurrences
47 //  Eugene V. Zima
48 //
49 //  Symbolic Evaluation of Chains of Recurrences for Loop Optimization
50 //  Robert A. van Engelen
51 //
52 //  Efficient Symbolic Analysis for Optimizing Compilers
53 //  Robert A. van Engelen
54 //
55 //  Using the chains of recurrences algebra for data dependence testing and
56 //  induction variable substitution
57 //  MS Thesis, Johnie Birch
58 //
59 //===----------------------------------------------------------------------===//
60
61 #include "llvm/Analysis/ScalarEvolution.h"
62 #include "llvm/ADT/Optional.h"
63 #include "llvm/ADT/STLExtras.h"
64 #include "llvm/ADT/SmallPtrSet.h"
65 #include "llvm/ADT/Statistic.h"
66 #include "llvm/Analysis/AssumptionCache.h"
67 #include "llvm/Analysis/ConstantFolding.h"
68 #include "llvm/Analysis/InstructionSimplify.h"
69 #include "llvm/Analysis/LoopInfo.h"
70 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
71 #include "llvm/Analysis/TargetLibraryInfo.h"
72 #include "llvm/Analysis/ValueTracking.h"
73 #include "llvm/IR/ConstantRange.h"
74 #include "llvm/IR/Constants.h"
75 #include "llvm/IR/DataLayout.h"
76 #include "llvm/IR/DerivedTypes.h"
77 #include "llvm/IR/Dominators.h"
78 #include "llvm/IR/GetElementPtrTypeIterator.h"
79 #include "llvm/IR/GlobalAlias.h"
80 #include "llvm/IR/GlobalVariable.h"
81 #include "llvm/IR/InstIterator.h"
82 #include "llvm/IR/Instructions.h"
83 #include "llvm/IR/LLVMContext.h"
84 #include "llvm/IR/Metadata.h"
85 #include "llvm/IR/Operator.h"
86 #include "llvm/IR/PatternMatch.h"
87 #include "llvm/Support/CommandLine.h"
88 #include "llvm/Support/Debug.h"
89 #include "llvm/Support/ErrorHandling.h"
90 #include "llvm/Support/MathExtras.h"
91 #include "llvm/Support/raw_ostream.h"
92 #include "llvm/Support/SaveAndRestore.h"
93 #include <algorithm>
94 using namespace llvm;
95
96 #define DEBUG_TYPE "scalar-evolution"
97
98 STATISTIC(NumArrayLenItCounts,
99           "Number of trip counts computed with array length");
100 STATISTIC(NumTripCountsComputed,
101           "Number of loops with predictable loop counts");
102 STATISTIC(NumTripCountsNotComputed,
103           "Number of loops without predictable loop counts");
104 STATISTIC(NumBruteForceTripCountsComputed,
105           "Number of loops with trip counts computed by force");
106
107 static cl::opt<unsigned>
108 MaxBruteForceIterations("scalar-evolution-max-iterations", cl::ReallyHidden,
109                         cl::desc("Maximum number of iterations SCEV will "
110                                  "symbolically execute a constant "
111                                  "derived loop"),
112                         cl::init(100));
113
114 // FIXME: Enable this with XDEBUG when the test suite is clean.
115 static cl::opt<bool>
116 VerifySCEV("verify-scev",
117            cl::desc("Verify ScalarEvolution's backedge taken counts (slow)"));
118
119 //===----------------------------------------------------------------------===//
120 //                           SCEV class definitions
121 //===----------------------------------------------------------------------===//
122
123 //===----------------------------------------------------------------------===//
124 // Implementation of the SCEV class.
125 //
126
127 LLVM_DUMP_METHOD
128 void SCEV::dump() const {
129   print(dbgs());
130   dbgs() << '\n';
131 }
132
133 void SCEV::print(raw_ostream &OS) const {
134   switch (static_cast<SCEVTypes>(getSCEVType())) {
135   case scConstant:
136     cast<SCEVConstant>(this)->getValue()->printAsOperand(OS, false);
137     return;
138   case scTruncate: {
139     const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(this);
140     const SCEV *Op = Trunc->getOperand();
141     OS << "(trunc " << *Op->getType() << " " << *Op << " to "
142        << *Trunc->getType() << ")";
143     return;
144   }
145   case scZeroExtend: {
146     const SCEVZeroExtendExpr *ZExt = cast<SCEVZeroExtendExpr>(this);
147     const SCEV *Op = ZExt->getOperand();
148     OS << "(zext " << *Op->getType() << " " << *Op << " to "
149        << *ZExt->getType() << ")";
150     return;
151   }
152   case scSignExtend: {
153     const SCEVSignExtendExpr *SExt = cast<SCEVSignExtendExpr>(this);
154     const SCEV *Op = SExt->getOperand();
155     OS << "(sext " << *Op->getType() << " " << *Op << " to "
156        << *SExt->getType() << ")";
157     return;
158   }
159   case scAddRecExpr: {
160     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(this);
161     OS << "{" << *AR->getOperand(0);
162     for (unsigned i = 1, e = AR->getNumOperands(); i != e; ++i)
163       OS << ",+," << *AR->getOperand(i);
164     OS << "}<";
165     if (AR->getNoWrapFlags(FlagNUW))
166       OS << "nuw><";
167     if (AR->getNoWrapFlags(FlagNSW))
168       OS << "nsw><";
169     if (AR->getNoWrapFlags(FlagNW) &&
170         !AR->getNoWrapFlags((NoWrapFlags)(FlagNUW | FlagNSW)))
171       OS << "nw><";
172     AR->getLoop()->getHeader()->printAsOperand(OS, /*PrintType=*/false);
173     OS << ">";
174     return;
175   }
176   case scAddExpr:
177   case scMulExpr:
178   case scUMaxExpr:
179   case scSMaxExpr: {
180     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(this);
181     const char *OpStr = nullptr;
182     switch (NAry->getSCEVType()) {
183     case scAddExpr: OpStr = " + "; break;
184     case scMulExpr: OpStr = " * "; break;
185     case scUMaxExpr: OpStr = " umax "; break;
186     case scSMaxExpr: OpStr = " smax "; break;
187     }
188     OS << "(";
189     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
190          I != E; ++I) {
191       OS << **I;
192       if (std::next(I) != E)
193         OS << OpStr;
194     }
195     OS << ")";
196     switch (NAry->getSCEVType()) {
197     case scAddExpr:
198     case scMulExpr:
199       if (NAry->getNoWrapFlags(FlagNUW))
200         OS << "<nuw>";
201       if (NAry->getNoWrapFlags(FlagNSW))
202         OS << "<nsw>";
203     }
204     return;
205   }
206   case scUDivExpr: {
207     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(this);
208     OS << "(" << *UDiv->getLHS() << " /u " << *UDiv->getRHS() << ")";
209     return;
210   }
211   case scUnknown: {
212     const SCEVUnknown *U = cast<SCEVUnknown>(this);
213     Type *AllocTy;
214     if (U->isSizeOf(AllocTy)) {
215       OS << "sizeof(" << *AllocTy << ")";
216       return;
217     }
218     if (U->isAlignOf(AllocTy)) {
219       OS << "alignof(" << *AllocTy << ")";
220       return;
221     }
222
223     Type *CTy;
224     Constant *FieldNo;
225     if (U->isOffsetOf(CTy, FieldNo)) {
226       OS << "offsetof(" << *CTy << ", ";
227       FieldNo->printAsOperand(OS, false);
228       OS << ")";
229       return;
230     }
231
232     // Otherwise just print it normally.
233     U->getValue()->printAsOperand(OS, false);
234     return;
235   }
236   case scCouldNotCompute:
237     OS << "***COULDNOTCOMPUTE***";
238     return;
239   }
240   llvm_unreachable("Unknown SCEV kind!");
241 }
242
243 Type *SCEV::getType() const {
244   switch (static_cast<SCEVTypes>(getSCEVType())) {
245   case scConstant:
246     return cast<SCEVConstant>(this)->getType();
247   case scTruncate:
248   case scZeroExtend:
249   case scSignExtend:
250     return cast<SCEVCastExpr>(this)->getType();
251   case scAddRecExpr:
252   case scMulExpr:
253   case scUMaxExpr:
254   case scSMaxExpr:
255     return cast<SCEVNAryExpr>(this)->getType();
256   case scAddExpr:
257     return cast<SCEVAddExpr>(this)->getType();
258   case scUDivExpr:
259     return cast<SCEVUDivExpr>(this)->getType();
260   case scUnknown:
261     return cast<SCEVUnknown>(this)->getType();
262   case scCouldNotCompute:
263     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
264   }
265   llvm_unreachable("Unknown SCEV kind!");
266 }
267
268 bool SCEV::isZero() const {
269   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
270     return SC->getValue()->isZero();
271   return false;
272 }
273
274 bool SCEV::isOne() const {
275   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
276     return SC->getValue()->isOne();
277   return false;
278 }
279
280 bool SCEV::isAllOnesValue() const {
281   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
282     return SC->getValue()->isAllOnesValue();
283   return false;
284 }
285
286 /// isNonConstantNegative - Return true if the specified scev is negated, but
287 /// not a constant.
288 bool SCEV::isNonConstantNegative() const {
289   const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(this);
290   if (!Mul) return false;
291
292   // If there is a constant factor, it will be first.
293   const SCEVConstant *SC = dyn_cast<SCEVConstant>(Mul->getOperand(0));
294   if (!SC) return false;
295
296   // Return true if the value is negative, this matches things like (-42 * V).
297   return SC->getValue()->getValue().isNegative();
298 }
299
300 SCEVCouldNotCompute::SCEVCouldNotCompute() :
301   SCEV(FoldingSetNodeIDRef(), scCouldNotCompute) {}
302
303 bool SCEVCouldNotCompute::classof(const SCEV *S) {
304   return S->getSCEVType() == scCouldNotCompute;
305 }
306
307 const SCEV *ScalarEvolution::getConstant(ConstantInt *V) {
308   FoldingSetNodeID ID;
309   ID.AddInteger(scConstant);
310   ID.AddPointer(V);
311   void *IP = nullptr;
312   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
313   SCEV *S = new (SCEVAllocator) SCEVConstant(ID.Intern(SCEVAllocator), V);
314   UniqueSCEVs.InsertNode(S, IP);
315   return S;
316 }
317
318 const SCEV *ScalarEvolution::getConstant(const APInt &Val) {
319   return getConstant(ConstantInt::get(getContext(), Val));
320 }
321
322 const SCEV *
323 ScalarEvolution::getConstant(Type *Ty, uint64_t V, bool isSigned) {
324   IntegerType *ITy = cast<IntegerType>(getEffectiveSCEVType(Ty));
325   return getConstant(ConstantInt::get(ITy, V, isSigned));
326 }
327
328 SCEVCastExpr::SCEVCastExpr(const FoldingSetNodeIDRef ID,
329                            unsigned SCEVTy, const SCEV *op, Type *ty)
330   : SCEV(ID, SCEVTy), Op(op), Ty(ty) {}
331
332 SCEVTruncateExpr::SCEVTruncateExpr(const FoldingSetNodeIDRef ID,
333                                    const SCEV *op, Type *ty)
334   : SCEVCastExpr(ID, scTruncate, op, ty) {
335   assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
336          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
337          "Cannot truncate non-integer value!");
338 }
339
340 SCEVZeroExtendExpr::SCEVZeroExtendExpr(const FoldingSetNodeIDRef ID,
341                                        const SCEV *op, Type *ty)
342   : SCEVCastExpr(ID, scZeroExtend, op, ty) {
343   assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
344          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
345          "Cannot zero extend non-integer value!");
346 }
347
348 SCEVSignExtendExpr::SCEVSignExtendExpr(const FoldingSetNodeIDRef ID,
349                                        const SCEV *op, Type *ty)
350   : SCEVCastExpr(ID, scSignExtend, op, ty) {
351   assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
352          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
353          "Cannot sign extend non-integer value!");
354 }
355
356 void SCEVUnknown::deleted() {
357   // Clear this SCEVUnknown from various maps.
358   SE->forgetMemoizedResults(this);
359
360   // Remove this SCEVUnknown from the uniquing map.
361   SE->UniqueSCEVs.RemoveNode(this);
362
363   // Release the value.
364   setValPtr(nullptr);
365 }
366
367 void SCEVUnknown::allUsesReplacedWith(Value *New) {
368   // Clear this SCEVUnknown from various maps.
369   SE->forgetMemoizedResults(this);
370
371   // Remove this SCEVUnknown from the uniquing map.
372   SE->UniqueSCEVs.RemoveNode(this);
373
374   // Update this SCEVUnknown to point to the new value. This is needed
375   // because there may still be outstanding SCEVs which still point to
376   // this SCEVUnknown.
377   setValPtr(New);
378 }
379
380 bool SCEVUnknown::isSizeOf(Type *&AllocTy) const {
381   if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
382     if (VCE->getOpcode() == Instruction::PtrToInt)
383       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
384         if (CE->getOpcode() == Instruction::GetElementPtr &&
385             CE->getOperand(0)->isNullValue() &&
386             CE->getNumOperands() == 2)
387           if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(1)))
388             if (CI->isOne()) {
389               AllocTy = cast<PointerType>(CE->getOperand(0)->getType())
390                                  ->getElementType();
391               return true;
392             }
393
394   return false;
395 }
396
397 bool SCEVUnknown::isAlignOf(Type *&AllocTy) const {
398   if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
399     if (VCE->getOpcode() == Instruction::PtrToInt)
400       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
401         if (CE->getOpcode() == Instruction::GetElementPtr &&
402             CE->getOperand(0)->isNullValue()) {
403           Type *Ty =
404             cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
405           if (StructType *STy = dyn_cast<StructType>(Ty))
406             if (!STy->isPacked() &&
407                 CE->getNumOperands() == 3 &&
408                 CE->getOperand(1)->isNullValue()) {
409               if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(2)))
410                 if (CI->isOne() &&
411                     STy->getNumElements() == 2 &&
412                     STy->getElementType(0)->isIntegerTy(1)) {
413                   AllocTy = STy->getElementType(1);
414                   return true;
415                 }
416             }
417         }
418
419   return false;
420 }
421
422 bool SCEVUnknown::isOffsetOf(Type *&CTy, Constant *&FieldNo) const {
423   if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
424     if (VCE->getOpcode() == Instruction::PtrToInt)
425       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
426         if (CE->getOpcode() == Instruction::GetElementPtr &&
427             CE->getNumOperands() == 3 &&
428             CE->getOperand(0)->isNullValue() &&
429             CE->getOperand(1)->isNullValue()) {
430           Type *Ty =
431             cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
432           // Ignore vector types here so that ScalarEvolutionExpander doesn't
433           // emit getelementptrs that index into vectors.
434           if (Ty->isStructTy() || Ty->isArrayTy()) {
435             CTy = Ty;
436             FieldNo = CE->getOperand(2);
437             return true;
438           }
439         }
440
441   return false;
442 }
443
444 //===----------------------------------------------------------------------===//
445 //                               SCEV Utilities
446 //===----------------------------------------------------------------------===//
447
448 namespace {
449 /// SCEVComplexityCompare - Return true if the complexity of the LHS is less
450 /// than the complexity of the RHS.  This comparator is used to canonicalize
451 /// expressions.
452 class SCEVComplexityCompare {
453   const LoopInfo *const LI;
454 public:
455   explicit SCEVComplexityCompare(const LoopInfo *li) : LI(li) {}
456
457   // Return true or false if LHS is less than, or at least RHS, respectively.
458   bool operator()(const SCEV *LHS, const SCEV *RHS) const {
459     return compare(LHS, RHS) < 0;
460   }
461
462   // Return negative, zero, or positive, if LHS is less than, equal to, or
463   // greater than RHS, respectively. A three-way result allows recursive
464   // comparisons to be more efficient.
465   int compare(const SCEV *LHS, const SCEV *RHS) const {
466     // Fast-path: SCEVs are uniqued so we can do a quick equality check.
467     if (LHS == RHS)
468       return 0;
469
470     // Primarily, sort the SCEVs by their getSCEVType().
471     unsigned LType = LHS->getSCEVType(), RType = RHS->getSCEVType();
472     if (LType != RType)
473       return (int)LType - (int)RType;
474
475     // Aside from the getSCEVType() ordering, the particular ordering
476     // isn't very important except that it's beneficial to be consistent,
477     // so that (a + b) and (b + a) don't end up as different expressions.
478     switch (static_cast<SCEVTypes>(LType)) {
479     case scUnknown: {
480       const SCEVUnknown *LU = cast<SCEVUnknown>(LHS);
481       const SCEVUnknown *RU = cast<SCEVUnknown>(RHS);
482
483       // Sort SCEVUnknown values with some loose heuristics. TODO: This is
484       // not as complete as it could be.
485       const Value *LV = LU->getValue(), *RV = RU->getValue();
486
487       // Order pointer values after integer values. This helps SCEVExpander
488       // form GEPs.
489       bool LIsPointer = LV->getType()->isPointerTy(),
490         RIsPointer = RV->getType()->isPointerTy();
491       if (LIsPointer != RIsPointer)
492         return (int)LIsPointer - (int)RIsPointer;
493
494       // Compare getValueID values.
495       unsigned LID = LV->getValueID(),
496         RID = RV->getValueID();
497       if (LID != RID)
498         return (int)LID - (int)RID;
499
500       // Sort arguments by their position.
501       if (const Argument *LA = dyn_cast<Argument>(LV)) {
502         const Argument *RA = cast<Argument>(RV);
503         unsigned LArgNo = LA->getArgNo(), RArgNo = RA->getArgNo();
504         return (int)LArgNo - (int)RArgNo;
505       }
506
507       // For instructions, compare their loop depth, and their operand
508       // count.  This is pretty loose.
509       if (const Instruction *LInst = dyn_cast<Instruction>(LV)) {
510         const Instruction *RInst = cast<Instruction>(RV);
511
512         // Compare loop depths.
513         const BasicBlock *LParent = LInst->getParent(),
514           *RParent = RInst->getParent();
515         if (LParent != RParent) {
516           unsigned LDepth = LI->getLoopDepth(LParent),
517             RDepth = LI->getLoopDepth(RParent);
518           if (LDepth != RDepth)
519             return (int)LDepth - (int)RDepth;
520         }
521
522         // Compare the number of operands.
523         unsigned LNumOps = LInst->getNumOperands(),
524           RNumOps = RInst->getNumOperands();
525         return (int)LNumOps - (int)RNumOps;
526       }
527
528       return 0;
529     }
530
531     case scConstant: {
532       const SCEVConstant *LC = cast<SCEVConstant>(LHS);
533       const SCEVConstant *RC = cast<SCEVConstant>(RHS);
534
535       // Compare constant values.
536       const APInt &LA = LC->getValue()->getValue();
537       const APInt &RA = RC->getValue()->getValue();
538       unsigned LBitWidth = LA.getBitWidth(), RBitWidth = RA.getBitWidth();
539       if (LBitWidth != RBitWidth)
540         return (int)LBitWidth - (int)RBitWidth;
541       return LA.ult(RA) ? -1 : 1;
542     }
543
544     case scAddRecExpr: {
545       const SCEVAddRecExpr *LA = cast<SCEVAddRecExpr>(LHS);
546       const SCEVAddRecExpr *RA = cast<SCEVAddRecExpr>(RHS);
547
548       // Compare addrec loop depths.
549       const Loop *LLoop = LA->getLoop(), *RLoop = RA->getLoop();
550       if (LLoop != RLoop) {
551         unsigned LDepth = LLoop->getLoopDepth(),
552           RDepth = RLoop->getLoopDepth();
553         if (LDepth != RDepth)
554           return (int)LDepth - (int)RDepth;
555       }
556
557       // Addrec complexity grows with operand count.
558       unsigned LNumOps = LA->getNumOperands(), RNumOps = RA->getNumOperands();
559       if (LNumOps != RNumOps)
560         return (int)LNumOps - (int)RNumOps;
561
562       // Lexicographically compare.
563       for (unsigned i = 0; i != LNumOps; ++i) {
564         long X = compare(LA->getOperand(i), RA->getOperand(i));
565         if (X != 0)
566           return X;
567       }
568
569       return 0;
570     }
571
572     case scAddExpr:
573     case scMulExpr:
574     case scSMaxExpr:
575     case scUMaxExpr: {
576       const SCEVNAryExpr *LC = cast<SCEVNAryExpr>(LHS);
577       const SCEVNAryExpr *RC = cast<SCEVNAryExpr>(RHS);
578
579       // Lexicographically compare n-ary expressions.
580       unsigned LNumOps = LC->getNumOperands(), RNumOps = RC->getNumOperands();
581       if (LNumOps != RNumOps)
582         return (int)LNumOps - (int)RNumOps;
583
584       for (unsigned i = 0; i != LNumOps; ++i) {
585         if (i >= RNumOps)
586           return 1;
587         long X = compare(LC->getOperand(i), RC->getOperand(i));
588         if (X != 0)
589           return X;
590       }
591       return (int)LNumOps - (int)RNumOps;
592     }
593
594     case scUDivExpr: {
595       const SCEVUDivExpr *LC = cast<SCEVUDivExpr>(LHS);
596       const SCEVUDivExpr *RC = cast<SCEVUDivExpr>(RHS);
597
598       // Lexicographically compare udiv expressions.
599       long X = compare(LC->getLHS(), RC->getLHS());
600       if (X != 0)
601         return X;
602       return compare(LC->getRHS(), RC->getRHS());
603     }
604
605     case scTruncate:
606     case scZeroExtend:
607     case scSignExtend: {
608       const SCEVCastExpr *LC = cast<SCEVCastExpr>(LHS);
609       const SCEVCastExpr *RC = cast<SCEVCastExpr>(RHS);
610
611       // Compare cast expressions by operand.
612       return compare(LC->getOperand(), RC->getOperand());
613     }
614
615     case scCouldNotCompute:
616       llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
617     }
618     llvm_unreachable("Unknown SCEV kind!");
619   }
620 };
621 }  // end anonymous namespace
622
623 /// GroupByComplexity - Given a list of SCEV objects, order them by their
624 /// complexity, and group objects of the same complexity together by value.
625 /// When this routine is finished, we know that any duplicates in the vector are
626 /// consecutive and that complexity is monotonically increasing.
627 ///
628 /// Note that we go take special precautions to ensure that we get deterministic
629 /// results from this routine.  In other words, we don't want the results of
630 /// this to depend on where the addresses of various SCEV objects happened to
631 /// land in memory.
632 ///
633 static void GroupByComplexity(SmallVectorImpl<const SCEV *> &Ops,
634                               LoopInfo *LI) {
635   if (Ops.size() < 2) return;  // Noop
636   if (Ops.size() == 2) {
637     // This is the common case, which also happens to be trivially simple.
638     // Special case it.
639     const SCEV *&LHS = Ops[0], *&RHS = Ops[1];
640     if (SCEVComplexityCompare(LI)(RHS, LHS))
641       std::swap(LHS, RHS);
642     return;
643   }
644
645   // Do the rough sort by complexity.
646   std::stable_sort(Ops.begin(), Ops.end(), SCEVComplexityCompare(LI));
647
648   // Now that we are sorted by complexity, group elements of the same
649   // complexity.  Note that this is, at worst, N^2, but the vector is likely to
650   // be extremely short in practice.  Note that we take this approach because we
651   // do not want to depend on the addresses of the objects we are grouping.
652   for (unsigned i = 0, e = Ops.size(); i != e-2; ++i) {
653     const SCEV *S = Ops[i];
654     unsigned Complexity = S->getSCEVType();
655
656     // If there are any objects of the same complexity and same value as this
657     // one, group them.
658     for (unsigned j = i+1; j != e && Ops[j]->getSCEVType() == Complexity; ++j) {
659       if (Ops[j] == S) { // Found a duplicate.
660         // Move it to immediately after i'th element.
661         std::swap(Ops[i+1], Ops[j]);
662         ++i;   // no need to rescan it.
663         if (i == e-2) return;  // Done!
664       }
665     }
666   }
667 }
668
669 // Returns the size of the SCEV S.
670 static inline int sizeOfSCEV(const SCEV *S) {
671   struct FindSCEVSize {
672     int Size;
673     FindSCEVSize() : Size(0) {}
674
675     bool follow(const SCEV *S) {
676       ++Size;
677       // Keep looking at all operands of S.
678       return true;
679     }
680     bool isDone() const {
681       return false;
682     }
683   };
684
685   FindSCEVSize F;
686   SCEVTraversal<FindSCEVSize> ST(F);
687   ST.visitAll(S);
688   return F.Size;
689 }
690
691 namespace {
692
693 struct SCEVDivision : public SCEVVisitor<SCEVDivision, void> {
694 public:
695   // Computes the Quotient and Remainder of the division of Numerator by
696   // Denominator.
697   static void divide(ScalarEvolution &SE, const SCEV *Numerator,
698                      const SCEV *Denominator, const SCEV **Quotient,
699                      const SCEV **Remainder) {
700     assert(Numerator && Denominator && "Uninitialized SCEV");
701
702     SCEVDivision D(SE, Numerator, Denominator);
703
704     // Check for the trivial case here to avoid having to check for it in the
705     // rest of the code.
706     if (Numerator == Denominator) {
707       *Quotient = D.One;
708       *Remainder = D.Zero;
709       return;
710     }
711
712     if (Numerator->isZero()) {
713       *Quotient = D.Zero;
714       *Remainder = D.Zero;
715       return;
716     }
717
718     // A simple case when N/1. The quotient is N.
719     if (Denominator->isOne()) {
720       *Quotient = Numerator;
721       *Remainder = D.Zero;
722       return;
723     }
724
725     // Split the Denominator when it is a product.
726     if (const SCEVMulExpr *T = dyn_cast<const SCEVMulExpr>(Denominator)) {
727       const SCEV *Q, *R;
728       *Quotient = Numerator;
729       for (const SCEV *Op : T->operands()) {
730         divide(SE, *Quotient, Op, &Q, &R);
731         *Quotient = Q;
732
733         // Bail out when the Numerator is not divisible by one of the terms of
734         // the Denominator.
735         if (!R->isZero()) {
736           *Quotient = D.Zero;
737           *Remainder = Numerator;
738           return;
739         }
740       }
741       *Remainder = D.Zero;
742       return;
743     }
744
745     D.visit(Numerator);
746     *Quotient = D.Quotient;
747     *Remainder = D.Remainder;
748   }
749
750   // Except in the trivial case described above, we do not know how to divide
751   // Expr by Denominator for the following functions with empty implementation.
752   void visitTruncateExpr(const SCEVTruncateExpr *Numerator) {}
753   void visitZeroExtendExpr(const SCEVZeroExtendExpr *Numerator) {}
754   void visitSignExtendExpr(const SCEVSignExtendExpr *Numerator) {}
755   void visitUDivExpr(const SCEVUDivExpr *Numerator) {}
756   void visitSMaxExpr(const SCEVSMaxExpr *Numerator) {}
757   void visitUMaxExpr(const SCEVUMaxExpr *Numerator) {}
758   void visitUnknown(const SCEVUnknown *Numerator) {}
759   void visitCouldNotCompute(const SCEVCouldNotCompute *Numerator) {}
760
761   void visitConstant(const SCEVConstant *Numerator) {
762     if (const SCEVConstant *D = dyn_cast<SCEVConstant>(Denominator)) {
763       APInt NumeratorVal = Numerator->getValue()->getValue();
764       APInt DenominatorVal = D->getValue()->getValue();
765       uint32_t NumeratorBW = NumeratorVal.getBitWidth();
766       uint32_t DenominatorBW = DenominatorVal.getBitWidth();
767
768       if (NumeratorBW > DenominatorBW)
769         DenominatorVal = DenominatorVal.sext(NumeratorBW);
770       else if (NumeratorBW < DenominatorBW)
771         NumeratorVal = NumeratorVal.sext(DenominatorBW);
772
773       APInt QuotientVal(NumeratorVal.getBitWidth(), 0);
774       APInt RemainderVal(NumeratorVal.getBitWidth(), 0);
775       APInt::sdivrem(NumeratorVal, DenominatorVal, QuotientVal, RemainderVal);
776       Quotient = SE.getConstant(QuotientVal);
777       Remainder = SE.getConstant(RemainderVal);
778       return;
779     }
780   }
781
782   void visitAddRecExpr(const SCEVAddRecExpr *Numerator) {
783     const SCEV *StartQ, *StartR, *StepQ, *StepR;
784     if (!Numerator->isAffine())
785       return cannotDivide(Numerator);
786     divide(SE, Numerator->getStart(), Denominator, &StartQ, &StartR);
787     divide(SE, Numerator->getStepRecurrence(SE), Denominator, &StepQ, &StepR);
788     // Bail out if the types do not match.
789     Type *Ty = Denominator->getType();
790     if (Ty != StartQ->getType() || Ty != StartR->getType() ||
791         Ty != StepQ->getType() || Ty != StepR->getType())
792       return cannotDivide(Numerator);
793     Quotient = SE.getAddRecExpr(StartQ, StepQ, Numerator->getLoop(),
794                                 Numerator->getNoWrapFlags());
795     Remainder = SE.getAddRecExpr(StartR, StepR, Numerator->getLoop(),
796                                  Numerator->getNoWrapFlags());
797   }
798
799   void visitAddExpr(const SCEVAddExpr *Numerator) {
800     SmallVector<const SCEV *, 2> Qs, Rs;
801     Type *Ty = Denominator->getType();
802
803     for (const SCEV *Op : Numerator->operands()) {
804       const SCEV *Q, *R;
805       divide(SE, Op, Denominator, &Q, &R);
806
807       // Bail out if types do not match.
808       if (Ty != Q->getType() || Ty != R->getType())
809         return cannotDivide(Numerator);
810
811       Qs.push_back(Q);
812       Rs.push_back(R);
813     }
814
815     if (Qs.size() == 1) {
816       Quotient = Qs[0];
817       Remainder = Rs[0];
818       return;
819     }
820
821     Quotient = SE.getAddExpr(Qs);
822     Remainder = SE.getAddExpr(Rs);
823   }
824
825   void visitMulExpr(const SCEVMulExpr *Numerator) {
826     SmallVector<const SCEV *, 2> Qs;
827     Type *Ty = Denominator->getType();
828
829     bool FoundDenominatorTerm = false;
830     for (const SCEV *Op : Numerator->operands()) {
831       // Bail out if types do not match.
832       if (Ty != Op->getType())
833         return cannotDivide(Numerator);
834
835       if (FoundDenominatorTerm) {
836         Qs.push_back(Op);
837         continue;
838       }
839
840       // Check whether Denominator divides one of the product operands.
841       const SCEV *Q, *R;
842       divide(SE, Op, Denominator, &Q, &R);
843       if (!R->isZero()) {
844         Qs.push_back(Op);
845         continue;
846       }
847
848       // Bail out if types do not match.
849       if (Ty != Q->getType())
850         return cannotDivide(Numerator);
851
852       FoundDenominatorTerm = true;
853       Qs.push_back(Q);
854     }
855
856     if (FoundDenominatorTerm) {
857       Remainder = Zero;
858       if (Qs.size() == 1)
859         Quotient = Qs[0];
860       else
861         Quotient = SE.getMulExpr(Qs);
862       return;
863     }
864
865     if (!isa<SCEVUnknown>(Denominator))
866       return cannotDivide(Numerator);
867
868     // The Remainder is obtained by replacing Denominator by 0 in Numerator.
869     ValueToValueMap RewriteMap;
870     RewriteMap[cast<SCEVUnknown>(Denominator)->getValue()] =
871         cast<SCEVConstant>(Zero)->getValue();
872     Remainder = SCEVParameterRewriter::rewrite(Numerator, SE, RewriteMap, true);
873
874     if (Remainder->isZero()) {
875       // The Quotient is obtained by replacing Denominator by 1 in Numerator.
876       RewriteMap[cast<SCEVUnknown>(Denominator)->getValue()] =
877           cast<SCEVConstant>(One)->getValue();
878       Quotient =
879           SCEVParameterRewriter::rewrite(Numerator, SE, RewriteMap, true);
880       return;
881     }
882
883     // Quotient is (Numerator - Remainder) divided by Denominator.
884     const SCEV *Q, *R;
885     const SCEV *Diff = SE.getMinusSCEV(Numerator, Remainder);
886     // This SCEV does not seem to simplify: fail the division here.
887     if (sizeOfSCEV(Diff) > sizeOfSCEV(Numerator))
888       return cannotDivide(Numerator);
889     divide(SE, Diff, Denominator, &Q, &R);
890     if (R != Zero)
891       return cannotDivide(Numerator);
892     Quotient = Q;
893   }
894
895 private:
896   SCEVDivision(ScalarEvolution &S, const SCEV *Numerator,
897                const SCEV *Denominator)
898       : SE(S), Denominator(Denominator) {
899     Zero = SE.getZero(Denominator->getType());
900     One = SE.getOne(Denominator->getType());
901
902     // We generally do not know how to divide Expr by Denominator. We
903     // initialize the division to a "cannot divide" state to simplify the rest
904     // of the code.
905     cannotDivide(Numerator);
906   }
907
908   // Convenience function for giving up on the division. We set the quotient to
909   // be equal to zero and the remainder to be equal to the numerator.
910   void cannotDivide(const SCEV *Numerator) {
911     Quotient = Zero;
912     Remainder = Numerator;
913   }
914
915   ScalarEvolution &SE;
916   const SCEV *Denominator, *Quotient, *Remainder, *Zero, *One;
917 };
918
919 }
920
921 //===----------------------------------------------------------------------===//
922 //                      Simple SCEV method implementations
923 //===----------------------------------------------------------------------===//
924
925 /// BinomialCoefficient - Compute BC(It, K).  The result has width W.
926 /// Assume, K > 0.
927 static const SCEV *BinomialCoefficient(const SCEV *It, unsigned K,
928                                        ScalarEvolution &SE,
929                                        Type *ResultTy) {
930   // Handle the simplest case efficiently.
931   if (K == 1)
932     return SE.getTruncateOrZeroExtend(It, ResultTy);
933
934   // We are using the following formula for BC(It, K):
935   //
936   //   BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / K!
937   //
938   // Suppose, W is the bitwidth of the return value.  We must be prepared for
939   // overflow.  Hence, we must assure that the result of our computation is
940   // equal to the accurate one modulo 2^W.  Unfortunately, division isn't
941   // safe in modular arithmetic.
942   //
943   // However, this code doesn't use exactly that formula; the formula it uses
944   // is something like the following, where T is the number of factors of 2 in
945   // K! (i.e. trailing zeros in the binary representation of K!), and ^ is
946   // exponentiation:
947   //
948   //   BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / 2^T / (K! / 2^T)
949   //
950   // This formula is trivially equivalent to the previous formula.  However,
951   // this formula can be implemented much more efficiently.  The trick is that
952   // K! / 2^T is odd, and exact division by an odd number *is* safe in modular
953   // arithmetic.  To do exact division in modular arithmetic, all we have
954   // to do is multiply by the inverse.  Therefore, this step can be done at
955   // width W.
956   //
957   // The next issue is how to safely do the division by 2^T.  The way this
958   // is done is by doing the multiplication step at a width of at least W + T
959   // bits.  This way, the bottom W+T bits of the product are accurate. Then,
960   // when we perform the division by 2^T (which is equivalent to a right shift
961   // by T), the bottom W bits are accurate.  Extra bits are okay; they'll get
962   // truncated out after the division by 2^T.
963   //
964   // In comparison to just directly using the first formula, this technique
965   // is much more efficient; using the first formula requires W * K bits,
966   // but this formula less than W + K bits. Also, the first formula requires
967   // a division step, whereas this formula only requires multiplies and shifts.
968   //
969   // It doesn't matter whether the subtraction step is done in the calculation
970   // width or the input iteration count's width; if the subtraction overflows,
971   // the result must be zero anyway.  We prefer here to do it in the width of
972   // the induction variable because it helps a lot for certain cases; CodeGen
973   // isn't smart enough to ignore the overflow, which leads to much less
974   // efficient code if the width of the subtraction is wider than the native
975   // register width.
976   //
977   // (It's possible to not widen at all by pulling out factors of 2 before
978   // the multiplication; for example, K=2 can be calculated as
979   // It/2*(It+(It*INT_MIN/INT_MIN)+-1). However, it requires
980   // extra arithmetic, so it's not an obvious win, and it gets
981   // much more complicated for K > 3.)
982
983   // Protection from insane SCEVs; this bound is conservative,
984   // but it probably doesn't matter.
985   if (K > 1000)
986     return SE.getCouldNotCompute();
987
988   unsigned W = SE.getTypeSizeInBits(ResultTy);
989
990   // Calculate K! / 2^T and T; we divide out the factors of two before
991   // multiplying for calculating K! / 2^T to avoid overflow.
992   // Other overflow doesn't matter because we only care about the bottom
993   // W bits of the result.
994   APInt OddFactorial(W, 1);
995   unsigned T = 1;
996   for (unsigned i = 3; i <= K; ++i) {
997     APInt Mult(W, i);
998     unsigned TwoFactors = Mult.countTrailingZeros();
999     T += TwoFactors;
1000     Mult = Mult.lshr(TwoFactors);
1001     OddFactorial *= Mult;
1002   }
1003
1004   // We need at least W + T bits for the multiplication step
1005   unsigned CalculationBits = W + T;
1006
1007   // Calculate 2^T, at width T+W.
1008   APInt DivFactor = APInt::getOneBitSet(CalculationBits, T);
1009
1010   // Calculate the multiplicative inverse of K! / 2^T;
1011   // this multiplication factor will perform the exact division by
1012   // K! / 2^T.
1013   APInt Mod = APInt::getSignedMinValue(W+1);
1014   APInt MultiplyFactor = OddFactorial.zext(W+1);
1015   MultiplyFactor = MultiplyFactor.multiplicativeInverse(Mod);
1016   MultiplyFactor = MultiplyFactor.trunc(W);
1017
1018   // Calculate the product, at width T+W
1019   IntegerType *CalculationTy = IntegerType::get(SE.getContext(),
1020                                                       CalculationBits);
1021   const SCEV *Dividend = SE.getTruncateOrZeroExtend(It, CalculationTy);
1022   for (unsigned i = 1; i != K; ++i) {
1023     const SCEV *S = SE.getMinusSCEV(It, SE.getConstant(It->getType(), i));
1024     Dividend = SE.getMulExpr(Dividend,
1025                              SE.getTruncateOrZeroExtend(S, CalculationTy));
1026   }
1027
1028   // Divide by 2^T
1029   const SCEV *DivResult = SE.getUDivExpr(Dividend, SE.getConstant(DivFactor));
1030
1031   // Truncate the result, and divide by K! / 2^T.
1032
1033   return SE.getMulExpr(SE.getConstant(MultiplyFactor),
1034                        SE.getTruncateOrZeroExtend(DivResult, ResultTy));
1035 }
1036
1037 /// evaluateAtIteration - Return the value of this chain of recurrences at
1038 /// the specified iteration number.  We can evaluate this recurrence by
1039 /// multiplying each element in the chain by the binomial coefficient
1040 /// corresponding to it.  In other words, we can evaluate {A,+,B,+,C,+,D} as:
1041 ///
1042 ///   A*BC(It, 0) + B*BC(It, 1) + C*BC(It, 2) + D*BC(It, 3)
1043 ///
1044 /// where BC(It, k) stands for binomial coefficient.
1045 ///
1046 const SCEV *SCEVAddRecExpr::evaluateAtIteration(const SCEV *It,
1047                                                 ScalarEvolution &SE) const {
1048   const SCEV *Result = getStart();
1049   for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1050     // The computation is correct in the face of overflow provided that the
1051     // multiplication is performed _after_ the evaluation of the binomial
1052     // coefficient.
1053     const SCEV *Coeff = BinomialCoefficient(It, i, SE, getType());
1054     if (isa<SCEVCouldNotCompute>(Coeff))
1055       return Coeff;
1056
1057     Result = SE.getAddExpr(Result, SE.getMulExpr(getOperand(i), Coeff));
1058   }
1059   return Result;
1060 }
1061
1062 //===----------------------------------------------------------------------===//
1063 //                    SCEV Expression folder implementations
1064 //===----------------------------------------------------------------------===//
1065
1066 const SCEV *ScalarEvolution::getTruncateExpr(const SCEV *Op,
1067                                              Type *Ty) {
1068   assert(getTypeSizeInBits(Op->getType()) > getTypeSizeInBits(Ty) &&
1069          "This is not a truncating conversion!");
1070   assert(isSCEVable(Ty) &&
1071          "This is not a conversion to a SCEVable type!");
1072   Ty = getEffectiveSCEVType(Ty);
1073
1074   FoldingSetNodeID ID;
1075   ID.AddInteger(scTruncate);
1076   ID.AddPointer(Op);
1077   ID.AddPointer(Ty);
1078   void *IP = nullptr;
1079   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1080
1081   // Fold if the operand is constant.
1082   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1083     return getConstant(
1084       cast<ConstantInt>(ConstantExpr::getTrunc(SC->getValue(), Ty)));
1085
1086   // trunc(trunc(x)) --> trunc(x)
1087   if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op))
1088     return getTruncateExpr(ST->getOperand(), Ty);
1089
1090   // trunc(sext(x)) --> sext(x) if widening or trunc(x) if narrowing
1091   if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
1092     return getTruncateOrSignExtend(SS->getOperand(), Ty);
1093
1094   // trunc(zext(x)) --> zext(x) if widening or trunc(x) if narrowing
1095   if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
1096     return getTruncateOrZeroExtend(SZ->getOperand(), Ty);
1097
1098   // trunc(x1+x2+...+xN) --> trunc(x1)+trunc(x2)+...+trunc(xN) if we can
1099   // eliminate all the truncates, or we replace other casts with truncates.
1100   if (const SCEVAddExpr *SA = dyn_cast<SCEVAddExpr>(Op)) {
1101     SmallVector<const SCEV *, 4> Operands;
1102     bool hasTrunc = false;
1103     for (unsigned i = 0, e = SA->getNumOperands(); i != e && !hasTrunc; ++i) {
1104       const SCEV *S = getTruncateExpr(SA->getOperand(i), Ty);
1105       if (!isa<SCEVCastExpr>(SA->getOperand(i)))
1106         hasTrunc = isa<SCEVTruncateExpr>(S);
1107       Operands.push_back(S);
1108     }
1109     if (!hasTrunc)
1110       return getAddExpr(Operands);
1111     UniqueSCEVs.FindNodeOrInsertPos(ID, IP);  // Mutates IP, returns NULL.
1112   }
1113
1114   // trunc(x1*x2*...*xN) --> trunc(x1)*trunc(x2)*...*trunc(xN) if we can
1115   // eliminate all the truncates, or we replace other casts with truncates.
1116   if (const SCEVMulExpr *SM = dyn_cast<SCEVMulExpr>(Op)) {
1117     SmallVector<const SCEV *, 4> Operands;
1118     bool hasTrunc = false;
1119     for (unsigned i = 0, e = SM->getNumOperands(); i != e && !hasTrunc; ++i) {
1120       const SCEV *S = getTruncateExpr(SM->getOperand(i), Ty);
1121       if (!isa<SCEVCastExpr>(SM->getOperand(i)))
1122         hasTrunc = isa<SCEVTruncateExpr>(S);
1123       Operands.push_back(S);
1124     }
1125     if (!hasTrunc)
1126       return getMulExpr(Operands);
1127     UniqueSCEVs.FindNodeOrInsertPos(ID, IP);  // Mutates IP, returns NULL.
1128   }
1129
1130   // If the input value is a chrec scev, truncate the chrec's operands.
1131   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) {
1132     SmallVector<const SCEV *, 4> Operands;
1133     for (const SCEV *Op : AddRec->operands())
1134       Operands.push_back(getTruncateExpr(Op, Ty));
1135     return getAddRecExpr(Operands, AddRec->getLoop(), SCEV::FlagAnyWrap);
1136   }
1137
1138   // The cast wasn't folded; create an explicit cast node. We can reuse
1139   // the existing insert position since if we get here, we won't have
1140   // made any changes which would invalidate it.
1141   SCEV *S = new (SCEVAllocator) SCEVTruncateExpr(ID.Intern(SCEVAllocator),
1142                                                  Op, Ty);
1143   UniqueSCEVs.InsertNode(S, IP);
1144   return S;
1145 }
1146
1147 // Get the limit of a recurrence such that incrementing by Step cannot cause
1148 // signed overflow as long as the value of the recurrence within the
1149 // loop does not exceed this limit before incrementing.
1150 static const SCEV *getSignedOverflowLimitForStep(const SCEV *Step,
1151                                                  ICmpInst::Predicate *Pred,
1152                                                  ScalarEvolution *SE) {
1153   unsigned BitWidth = SE->getTypeSizeInBits(Step->getType());
1154   if (SE->isKnownPositive(Step)) {
1155     *Pred = ICmpInst::ICMP_SLT;
1156     return SE->getConstant(APInt::getSignedMinValue(BitWidth) -
1157                            SE->getSignedRange(Step).getSignedMax());
1158   }
1159   if (SE->isKnownNegative(Step)) {
1160     *Pred = ICmpInst::ICMP_SGT;
1161     return SE->getConstant(APInt::getSignedMaxValue(BitWidth) -
1162                            SE->getSignedRange(Step).getSignedMin());
1163   }
1164   return nullptr;
1165 }
1166
1167 // Get the limit of a recurrence such that incrementing by Step cannot cause
1168 // unsigned overflow as long as the value of the recurrence within the loop does
1169 // not exceed this limit before incrementing.
1170 static const SCEV *getUnsignedOverflowLimitForStep(const SCEV *Step,
1171                                                    ICmpInst::Predicate *Pred,
1172                                                    ScalarEvolution *SE) {
1173   unsigned BitWidth = SE->getTypeSizeInBits(Step->getType());
1174   *Pred = ICmpInst::ICMP_ULT;
1175
1176   return SE->getConstant(APInt::getMinValue(BitWidth) -
1177                          SE->getUnsignedRange(Step).getUnsignedMax());
1178 }
1179
1180 namespace {
1181
1182 struct ExtendOpTraitsBase {
1183   typedef const SCEV *(ScalarEvolution::*GetExtendExprTy)(const SCEV *, Type *);
1184 };
1185
1186 // Used to make code generic over signed and unsigned overflow.
1187 template <typename ExtendOp> struct ExtendOpTraits {
1188   // Members present:
1189   //
1190   // static const SCEV::NoWrapFlags WrapType;
1191   //
1192   // static const ExtendOpTraitsBase::GetExtendExprTy GetExtendExpr;
1193   //
1194   // static const SCEV *getOverflowLimitForStep(const SCEV *Step,
1195   //                                           ICmpInst::Predicate *Pred,
1196   //                                           ScalarEvolution *SE);
1197 };
1198
1199 template <>
1200 struct ExtendOpTraits<SCEVSignExtendExpr> : public ExtendOpTraitsBase {
1201   static const SCEV::NoWrapFlags WrapType = SCEV::FlagNSW;
1202
1203   static const GetExtendExprTy GetExtendExpr;
1204
1205   static const SCEV *getOverflowLimitForStep(const SCEV *Step,
1206                                              ICmpInst::Predicate *Pred,
1207                                              ScalarEvolution *SE) {
1208     return getSignedOverflowLimitForStep(Step, Pred, SE);
1209   }
1210 };
1211
1212 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits<
1213     SCEVSignExtendExpr>::GetExtendExpr = &ScalarEvolution::getSignExtendExpr;
1214
1215 template <>
1216 struct ExtendOpTraits<SCEVZeroExtendExpr> : public ExtendOpTraitsBase {
1217   static const SCEV::NoWrapFlags WrapType = SCEV::FlagNUW;
1218
1219   static const GetExtendExprTy GetExtendExpr;
1220
1221   static const SCEV *getOverflowLimitForStep(const SCEV *Step,
1222                                              ICmpInst::Predicate *Pred,
1223                                              ScalarEvolution *SE) {
1224     return getUnsignedOverflowLimitForStep(Step, Pred, SE);
1225   }
1226 };
1227
1228 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits<
1229     SCEVZeroExtendExpr>::GetExtendExpr = &ScalarEvolution::getZeroExtendExpr;
1230 }
1231
1232 // The recurrence AR has been shown to have no signed/unsigned wrap or something
1233 // close to it. Typically, if we can prove NSW/NUW for AR, then we can just as
1234 // easily prove NSW/NUW for its preincrement or postincrement sibling. This
1235 // allows normalizing a sign/zero extended AddRec as such: {sext/zext(Step +
1236 // Start),+,Step} => {(Step + sext/zext(Start),+,Step} As a result, the
1237 // expression "Step + sext/zext(PreIncAR)" is congruent with
1238 // "sext/zext(PostIncAR)"
1239 template <typename ExtendOpTy>
1240 static const SCEV *getPreStartForExtend(const SCEVAddRecExpr *AR, Type *Ty,
1241                                         ScalarEvolution *SE) {
1242   auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType;
1243   auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr;
1244
1245   const Loop *L = AR->getLoop();
1246   const SCEV *Start = AR->getStart();
1247   const SCEV *Step = AR->getStepRecurrence(*SE);
1248
1249   // Check for a simple looking step prior to loop entry.
1250   const SCEVAddExpr *SA = dyn_cast<SCEVAddExpr>(Start);
1251   if (!SA)
1252     return nullptr;
1253
1254   // Create an AddExpr for "PreStart" after subtracting Step. Full SCEV
1255   // subtraction is expensive. For this purpose, perform a quick and dirty
1256   // difference, by checking for Step in the operand list.
1257   SmallVector<const SCEV *, 4> DiffOps;
1258   for (const SCEV *Op : SA->operands())
1259     if (Op != Step)
1260       DiffOps.push_back(Op);
1261
1262   if (DiffOps.size() == SA->getNumOperands())
1263     return nullptr;
1264
1265   // Try to prove `WrapType` (SCEV::FlagNSW or SCEV::FlagNUW) on `PreStart` +
1266   // `Step`:
1267
1268   // 1. NSW/NUW flags on the step increment.
1269   auto PreStartFlags =
1270     ScalarEvolution::maskFlags(SA->getNoWrapFlags(), SCEV::FlagNUW);
1271   const SCEV *PreStart = SE->getAddExpr(DiffOps, PreStartFlags);
1272   const SCEVAddRecExpr *PreAR = dyn_cast<SCEVAddRecExpr>(
1273       SE->getAddRecExpr(PreStart, Step, L, SCEV::FlagAnyWrap));
1274
1275   // "{S,+,X} is <nsw>/<nuw>" and "the backedge is taken at least once" implies
1276   // "S+X does not sign/unsign-overflow".
1277   //
1278
1279   const SCEV *BECount = SE->getBackedgeTakenCount(L);
1280   if (PreAR && PreAR->getNoWrapFlags(WrapType) &&
1281       !isa<SCEVCouldNotCompute>(BECount) && SE->isKnownPositive(BECount))
1282     return PreStart;
1283
1284   // 2. Direct overflow check on the step operation's expression.
1285   unsigned BitWidth = SE->getTypeSizeInBits(AR->getType());
1286   Type *WideTy = IntegerType::get(SE->getContext(), BitWidth * 2);
1287   const SCEV *OperandExtendedStart =
1288       SE->getAddExpr((SE->*GetExtendExpr)(PreStart, WideTy),
1289                      (SE->*GetExtendExpr)(Step, WideTy));
1290   if ((SE->*GetExtendExpr)(Start, WideTy) == OperandExtendedStart) {
1291     if (PreAR && AR->getNoWrapFlags(WrapType)) {
1292       // If we know `AR` == {`PreStart`+`Step`,+,`Step`} is `WrapType` (FlagNSW
1293       // or FlagNUW) and that `PreStart` + `Step` is `WrapType` too, then
1294       // `PreAR` == {`PreStart`,+,`Step`} is also `WrapType`.  Cache this fact.
1295       const_cast<SCEVAddRecExpr *>(PreAR)->setNoWrapFlags(WrapType);
1296     }
1297     return PreStart;
1298   }
1299
1300   // 3. Loop precondition.
1301   ICmpInst::Predicate Pred;
1302   const SCEV *OverflowLimit =
1303       ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep(Step, &Pred, SE);
1304
1305   if (OverflowLimit &&
1306       SE->isLoopEntryGuardedByCond(L, Pred, PreStart, OverflowLimit))
1307     return PreStart;
1308
1309   return nullptr;
1310 }
1311
1312 // Get the normalized zero or sign extended expression for this AddRec's Start.
1313 template <typename ExtendOpTy>
1314 static const SCEV *getExtendAddRecStart(const SCEVAddRecExpr *AR, Type *Ty,
1315                                         ScalarEvolution *SE) {
1316   auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr;
1317
1318   const SCEV *PreStart = getPreStartForExtend<ExtendOpTy>(AR, Ty, SE);
1319   if (!PreStart)
1320     return (SE->*GetExtendExpr)(AR->getStart(), Ty);
1321
1322   return SE->getAddExpr((SE->*GetExtendExpr)(AR->getStepRecurrence(*SE), Ty),
1323                         (SE->*GetExtendExpr)(PreStart, Ty));
1324 }
1325
1326 // Try to prove away overflow by looking at "nearby" add recurrences.  A
1327 // motivating example for this rule: if we know `{0,+,4}` is `ult` `-1` and it
1328 // does not itself wrap then we can conclude that `{1,+,4}` is `nuw`.
1329 //
1330 // Formally:
1331 //
1332 //     {S,+,X} == {S-T,+,X} + T
1333 //  => Ext({S,+,X}) == Ext({S-T,+,X} + T)
1334 //
1335 // If ({S-T,+,X} + T) does not overflow  ... (1)
1336 //
1337 //  RHS == Ext({S-T,+,X} + T) == Ext({S-T,+,X}) + Ext(T)
1338 //
1339 // If {S-T,+,X} does not overflow  ... (2)
1340 //
1341 //  RHS == Ext({S-T,+,X}) + Ext(T) == {Ext(S-T),+,Ext(X)} + Ext(T)
1342 //      == {Ext(S-T)+Ext(T),+,Ext(X)}
1343 //
1344 // If (S-T)+T does not overflow  ... (3)
1345 //
1346 //  RHS == {Ext(S-T)+Ext(T),+,Ext(X)} == {Ext(S-T+T),+,Ext(X)}
1347 //      == {Ext(S),+,Ext(X)} == LHS
1348 //
1349 // Thus, if (1), (2) and (3) are true for some T, then
1350 //   Ext({S,+,X}) == {Ext(S),+,Ext(X)}
1351 //
1352 // (3) is implied by (1) -- "(S-T)+T does not overflow" is simply "({S-T,+,X}+T)
1353 // does not overflow" restricted to the 0th iteration.  Therefore we only need
1354 // to check for (1) and (2).
1355 //
1356 // In the current context, S is `Start`, X is `Step`, Ext is `ExtendOpTy` and T
1357 // is `Delta` (defined below).
1358 //
1359 template <typename ExtendOpTy>
1360 bool ScalarEvolution::proveNoWrapByVaryingStart(const SCEV *Start,
1361                                                 const SCEV *Step,
1362                                                 const Loop *L) {
1363   auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType;
1364
1365   // We restrict `Start` to a constant to prevent SCEV from spending too much
1366   // time here.  It is correct (but more expensive) to continue with a
1367   // non-constant `Start` and do a general SCEV subtraction to compute
1368   // `PreStart` below.
1369   //
1370   const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start);
1371   if (!StartC)
1372     return false;
1373
1374   APInt StartAI = StartC->getValue()->getValue();
1375
1376   for (unsigned Delta : {-2, -1, 1, 2}) {
1377     const SCEV *PreStart = getConstant(StartAI - Delta);
1378
1379     FoldingSetNodeID ID;
1380     ID.AddInteger(scAddRecExpr);
1381     ID.AddPointer(PreStart);
1382     ID.AddPointer(Step);
1383     ID.AddPointer(L);
1384     void *IP = nullptr;
1385     const auto *PreAR =
1386       static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
1387
1388     // Give up if we don't already have the add recurrence we need because
1389     // actually constructing an add recurrence is relatively expensive.
1390     if (PreAR && PreAR->getNoWrapFlags(WrapType)) {  // proves (2)
1391       const SCEV *DeltaS = getConstant(StartC->getType(), Delta);
1392       ICmpInst::Predicate Pred = ICmpInst::BAD_ICMP_PREDICATE;
1393       const SCEV *Limit = ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep(
1394           DeltaS, &Pred, this);
1395       if (Limit && isKnownPredicate(Pred, PreAR, Limit))  // proves (1)
1396         return true;
1397     }
1398   }
1399
1400   return false;
1401 }
1402
1403 const SCEV *ScalarEvolution::getZeroExtendExpr(const SCEV *Op,
1404                                                Type *Ty) {
1405   assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1406          "This is not an extending conversion!");
1407   assert(isSCEVable(Ty) &&
1408          "This is not a conversion to a SCEVable type!");
1409   Ty = getEffectiveSCEVType(Ty);
1410
1411   // Fold if the operand is constant.
1412   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1413     return getConstant(
1414       cast<ConstantInt>(ConstantExpr::getZExt(SC->getValue(), Ty)));
1415
1416   // zext(zext(x)) --> zext(x)
1417   if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
1418     return getZeroExtendExpr(SZ->getOperand(), Ty);
1419
1420   // Before doing any expensive analysis, check to see if we've already
1421   // computed a SCEV for this Op and Ty.
1422   FoldingSetNodeID ID;
1423   ID.AddInteger(scZeroExtend);
1424   ID.AddPointer(Op);
1425   ID.AddPointer(Ty);
1426   void *IP = nullptr;
1427   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1428
1429   // zext(trunc(x)) --> zext(x) or x or trunc(x)
1430   if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) {
1431     // It's possible the bits taken off by the truncate were all zero bits. If
1432     // so, we should be able to simplify this further.
1433     const SCEV *X = ST->getOperand();
1434     ConstantRange CR = getUnsignedRange(X);
1435     unsigned TruncBits = getTypeSizeInBits(ST->getType());
1436     unsigned NewBits = getTypeSizeInBits(Ty);
1437     if (CR.truncate(TruncBits).zeroExtend(NewBits).contains(
1438             CR.zextOrTrunc(NewBits)))
1439       return getTruncateOrZeroExtend(X, Ty);
1440   }
1441
1442   // If the input value is a chrec scev, and we can prove that the value
1443   // did not overflow the old, smaller, value, we can zero extend all of the
1444   // operands (often constants).  This allows analysis of something like
1445   // this:  for (unsigned char X = 0; X < 100; ++X) { int Y = X; }
1446   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
1447     if (AR->isAffine()) {
1448       const SCEV *Start = AR->getStart();
1449       const SCEV *Step = AR->getStepRecurrence(*this);
1450       unsigned BitWidth = getTypeSizeInBits(AR->getType());
1451       const Loop *L = AR->getLoop();
1452
1453       // If we have special knowledge that this addrec won't overflow,
1454       // we don't need to do any further analysis.
1455       if (AR->getNoWrapFlags(SCEV::FlagNUW))
1456         return getAddRecExpr(
1457             getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1458             getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1459
1460       // Check whether the backedge-taken count is SCEVCouldNotCompute.
1461       // Note that this serves two purposes: It filters out loops that are
1462       // simply not analyzable, and it covers the case where this code is
1463       // being called from within backedge-taken count analysis, such that
1464       // attempting to ask for the backedge-taken count would likely result
1465       // in infinite recursion. In the later case, the analysis code will
1466       // cope with a conservative value, and it will take care to purge
1467       // that value once it has finished.
1468       const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
1469       if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
1470         // Manually compute the final value for AR, checking for
1471         // overflow.
1472
1473         // Check whether the backedge-taken count can be losslessly casted to
1474         // the addrec's type. The count is always unsigned.
1475         const SCEV *CastedMaxBECount =
1476           getTruncateOrZeroExtend(MaxBECount, Start->getType());
1477         const SCEV *RecastedMaxBECount =
1478           getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
1479         if (MaxBECount == RecastedMaxBECount) {
1480           Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
1481           // Check whether Start+Step*MaxBECount has no unsigned overflow.
1482           const SCEV *ZMul = getMulExpr(CastedMaxBECount, Step);
1483           const SCEV *ZAdd = getZeroExtendExpr(getAddExpr(Start, ZMul), WideTy);
1484           const SCEV *WideStart = getZeroExtendExpr(Start, WideTy);
1485           const SCEV *WideMaxBECount =
1486             getZeroExtendExpr(CastedMaxBECount, WideTy);
1487           const SCEV *OperandExtendedAdd =
1488             getAddExpr(WideStart,
1489                        getMulExpr(WideMaxBECount,
1490                                   getZeroExtendExpr(Step, WideTy)));
1491           if (ZAdd == OperandExtendedAdd) {
1492             // Cache knowledge of AR NUW, which is propagated to this AddRec.
1493             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNUW);
1494             // Return the expression with the addrec on the outside.
1495             return getAddRecExpr(
1496                 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1497                 getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1498           }
1499           // Similar to above, only this time treat the step value as signed.
1500           // This covers loops that count down.
1501           OperandExtendedAdd =
1502             getAddExpr(WideStart,
1503                        getMulExpr(WideMaxBECount,
1504                                   getSignExtendExpr(Step, WideTy)));
1505           if (ZAdd == OperandExtendedAdd) {
1506             // Cache knowledge of AR NW, which is propagated to this AddRec.
1507             // Negative step causes unsigned wrap, but it still can't self-wrap.
1508             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNW);
1509             // Return the expression with the addrec on the outside.
1510             return getAddRecExpr(
1511                 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1512                 getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1513           }
1514         }
1515
1516         // If the backedge is guarded by a comparison with the pre-inc value
1517         // the addrec is safe. Also, if the entry is guarded by a comparison
1518         // with the start value and the backedge is guarded by a comparison
1519         // with the post-inc value, the addrec is safe.
1520         if (isKnownPositive(Step)) {
1521           const SCEV *N = getConstant(APInt::getMinValue(BitWidth) -
1522                                       getUnsignedRange(Step).getUnsignedMax());
1523           if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT, AR, N) ||
1524               (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_ULT, Start, N) &&
1525                isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT,
1526                                            AR->getPostIncExpr(*this), N))) {
1527             // Cache knowledge of AR NUW, which is propagated to this AddRec.
1528             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNUW);
1529             // Return the expression with the addrec on the outside.
1530             return getAddRecExpr(
1531                 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1532                 getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1533           }
1534         } else if (isKnownNegative(Step)) {
1535           const SCEV *N = getConstant(APInt::getMaxValue(BitWidth) -
1536                                       getSignedRange(Step).getSignedMin());
1537           if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT, AR, N) ||
1538               (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_UGT, Start, N) &&
1539                isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT,
1540                                            AR->getPostIncExpr(*this), N))) {
1541             // Cache knowledge of AR NW, which is propagated to this AddRec.
1542             // Negative step causes unsigned wrap, but it still can't self-wrap.
1543             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNW);
1544             // Return the expression with the addrec on the outside.
1545             return getAddRecExpr(
1546                 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1547                 getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1548           }
1549         }
1550       }
1551
1552       if (proveNoWrapByVaryingStart<SCEVZeroExtendExpr>(Start, Step, L)) {
1553         const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNUW);
1554         return getAddRecExpr(
1555             getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1556             getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1557       }
1558     }
1559
1560   if (auto *SA = dyn_cast<SCEVAddExpr>(Op)) {
1561     // zext((A + B + ...)<nuw>) --> (zext(A) + zext(B) + ...)<nuw>
1562     if (SA->getNoWrapFlags(SCEV::FlagNUW)) {
1563       // If the addition does not unsign overflow then we can, by definition,
1564       // commute the zero extension with the addition operation.
1565       SmallVector<const SCEV *, 4> Ops;
1566       for (const auto *Op : SA->operands())
1567         Ops.push_back(getZeroExtendExpr(Op, Ty));
1568       return getAddExpr(Ops, SCEV::FlagNUW);
1569     }
1570   }
1571
1572   // The cast wasn't folded; create an explicit cast node.
1573   // Recompute the insert position, as it may have been invalidated.
1574   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1575   SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator),
1576                                                    Op, Ty);
1577   UniqueSCEVs.InsertNode(S, IP);
1578   return S;
1579 }
1580
1581 const SCEV *ScalarEvolution::getSignExtendExpr(const SCEV *Op,
1582                                                Type *Ty) {
1583   assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1584          "This is not an extending conversion!");
1585   assert(isSCEVable(Ty) &&
1586          "This is not a conversion to a SCEVable type!");
1587   Ty = getEffectiveSCEVType(Ty);
1588
1589   // Fold if the operand is constant.
1590   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1591     return getConstant(
1592       cast<ConstantInt>(ConstantExpr::getSExt(SC->getValue(), Ty)));
1593
1594   // sext(sext(x)) --> sext(x)
1595   if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
1596     return getSignExtendExpr(SS->getOperand(), Ty);
1597
1598   // sext(zext(x)) --> zext(x)
1599   if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
1600     return getZeroExtendExpr(SZ->getOperand(), Ty);
1601
1602   // Before doing any expensive analysis, check to see if we've already
1603   // computed a SCEV for this Op and Ty.
1604   FoldingSetNodeID ID;
1605   ID.AddInteger(scSignExtend);
1606   ID.AddPointer(Op);
1607   ID.AddPointer(Ty);
1608   void *IP = nullptr;
1609   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1610
1611   // If the input value is provably positive, build a zext instead.
1612   if (isKnownNonNegative(Op))
1613     return getZeroExtendExpr(Op, Ty);
1614
1615   // sext(trunc(x)) --> sext(x) or x or trunc(x)
1616   if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) {
1617     // It's possible the bits taken off by the truncate were all sign bits. If
1618     // so, we should be able to simplify this further.
1619     const SCEV *X = ST->getOperand();
1620     ConstantRange CR = getSignedRange(X);
1621     unsigned TruncBits = getTypeSizeInBits(ST->getType());
1622     unsigned NewBits = getTypeSizeInBits(Ty);
1623     if (CR.truncate(TruncBits).signExtend(NewBits).contains(
1624             CR.sextOrTrunc(NewBits)))
1625       return getTruncateOrSignExtend(X, Ty);
1626   }
1627
1628   // sext(C1 + (C2 * x)) --> C1 + sext(C2 * x) if C1 < C2
1629   if (auto *SA = dyn_cast<SCEVAddExpr>(Op)) {
1630     if (SA->getNumOperands() == 2) {
1631       auto *SC1 = dyn_cast<SCEVConstant>(SA->getOperand(0));
1632       auto *SMul = dyn_cast<SCEVMulExpr>(SA->getOperand(1));
1633       if (SMul && SC1) {
1634         if (auto *SC2 = dyn_cast<SCEVConstant>(SMul->getOperand(0))) {
1635           const APInt &C1 = SC1->getValue()->getValue();
1636           const APInt &C2 = SC2->getValue()->getValue();
1637           if (C1.isStrictlyPositive() && C2.isStrictlyPositive() &&
1638               C2.ugt(C1) && C2.isPowerOf2())
1639             return getAddExpr(getSignExtendExpr(SC1, Ty),
1640                               getSignExtendExpr(SMul, Ty));
1641         }
1642       }
1643     }
1644
1645     // sext((A + B + ...)<nsw>) --> (sext(A) + sext(B) + ...)<nsw>
1646     if (SA->getNoWrapFlags(SCEV::FlagNSW)) {
1647       // If the addition does not sign overflow then we can, by definition,
1648       // commute the sign extension with the addition operation.
1649       SmallVector<const SCEV *, 4> Ops;
1650       for (const auto *Op : SA->operands())
1651         Ops.push_back(getSignExtendExpr(Op, Ty));
1652       return getAddExpr(Ops, SCEV::FlagNSW);
1653     }
1654   }
1655   // If the input value is a chrec scev, and we can prove that the value
1656   // did not overflow the old, smaller, value, we can sign extend all of the
1657   // operands (often constants).  This allows analysis of something like
1658   // this:  for (signed char X = 0; X < 100; ++X) { int Y = X; }
1659   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
1660     if (AR->isAffine()) {
1661       const SCEV *Start = AR->getStart();
1662       const SCEV *Step = AR->getStepRecurrence(*this);
1663       unsigned BitWidth = getTypeSizeInBits(AR->getType());
1664       const Loop *L = AR->getLoop();
1665
1666       // If we have special knowledge that this addrec won't overflow,
1667       // we don't need to do any further analysis.
1668       if (AR->getNoWrapFlags(SCEV::FlagNSW))
1669         return getAddRecExpr(
1670             getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1671             getSignExtendExpr(Step, Ty), L, SCEV::FlagNSW);
1672
1673       // Check whether the backedge-taken count is SCEVCouldNotCompute.
1674       // Note that this serves two purposes: It filters out loops that are
1675       // simply not analyzable, and it covers the case where this code is
1676       // being called from within backedge-taken count analysis, such that
1677       // attempting to ask for the backedge-taken count would likely result
1678       // in infinite recursion. In the later case, the analysis code will
1679       // cope with a conservative value, and it will take care to purge
1680       // that value once it has finished.
1681       const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
1682       if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
1683         // Manually compute the final value for AR, checking for
1684         // overflow.
1685
1686         // Check whether the backedge-taken count can be losslessly casted to
1687         // the addrec's type. The count is always unsigned.
1688         const SCEV *CastedMaxBECount =
1689           getTruncateOrZeroExtend(MaxBECount, Start->getType());
1690         const SCEV *RecastedMaxBECount =
1691           getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
1692         if (MaxBECount == RecastedMaxBECount) {
1693           Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
1694           // Check whether Start+Step*MaxBECount has no signed overflow.
1695           const SCEV *SMul = getMulExpr(CastedMaxBECount, Step);
1696           const SCEV *SAdd = getSignExtendExpr(getAddExpr(Start, SMul), WideTy);
1697           const SCEV *WideStart = getSignExtendExpr(Start, WideTy);
1698           const SCEV *WideMaxBECount =
1699             getZeroExtendExpr(CastedMaxBECount, WideTy);
1700           const SCEV *OperandExtendedAdd =
1701             getAddExpr(WideStart,
1702                        getMulExpr(WideMaxBECount,
1703                                   getSignExtendExpr(Step, WideTy)));
1704           if (SAdd == OperandExtendedAdd) {
1705             // Cache knowledge of AR NSW, which is propagated to this AddRec.
1706             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNSW);
1707             // Return the expression with the addrec on the outside.
1708             return getAddRecExpr(
1709                 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1710                 getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1711           }
1712           // Similar to above, only this time treat the step value as unsigned.
1713           // This covers loops that count up with an unsigned step.
1714           OperandExtendedAdd =
1715             getAddExpr(WideStart,
1716                        getMulExpr(WideMaxBECount,
1717                                   getZeroExtendExpr(Step, WideTy)));
1718           if (SAdd == OperandExtendedAdd) {
1719             // If AR wraps around then
1720             //
1721             //    abs(Step) * MaxBECount > unsigned-max(AR->getType())
1722             // => SAdd != OperandExtendedAdd
1723             //
1724             // Thus (AR is not NW => SAdd != OperandExtendedAdd) <=>
1725             // (SAdd == OperandExtendedAdd => AR is NW)
1726
1727             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNW);
1728
1729             // Return the expression with the addrec on the outside.
1730             return getAddRecExpr(
1731                 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1732                 getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1733           }
1734         }
1735
1736         // If the backedge is guarded by a comparison with the pre-inc value
1737         // the addrec is safe. Also, if the entry is guarded by a comparison
1738         // with the start value and the backedge is guarded by a comparison
1739         // with the post-inc value, the addrec is safe.
1740         ICmpInst::Predicate Pred;
1741         const SCEV *OverflowLimit =
1742             getSignedOverflowLimitForStep(Step, &Pred, this);
1743         if (OverflowLimit &&
1744             (isLoopBackedgeGuardedByCond(L, Pred, AR, OverflowLimit) ||
1745              (isLoopEntryGuardedByCond(L, Pred, Start, OverflowLimit) &&
1746               isLoopBackedgeGuardedByCond(L, Pred, AR->getPostIncExpr(*this),
1747                                           OverflowLimit)))) {
1748           // Cache knowledge of AR NSW, then propagate NSW to the wide AddRec.
1749           const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNSW);
1750           return getAddRecExpr(
1751               getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1752               getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1753         }
1754       }
1755       // If Start and Step are constants, check if we can apply this
1756       // transformation:
1757       // sext{C1,+,C2} --> C1 + sext{0,+,C2} if C1 < C2
1758       auto *SC1 = dyn_cast<SCEVConstant>(Start);
1759       auto *SC2 = dyn_cast<SCEVConstant>(Step);
1760       if (SC1 && SC2) {
1761         const APInt &C1 = SC1->getValue()->getValue();
1762         const APInt &C2 = SC2->getValue()->getValue();
1763         if (C1.isStrictlyPositive() && C2.isStrictlyPositive() && C2.ugt(C1) &&
1764             C2.isPowerOf2()) {
1765           Start = getSignExtendExpr(Start, Ty);
1766           const SCEV *NewAR = getAddRecExpr(getZero(AR->getType()), Step, L,
1767                                             AR->getNoWrapFlags());
1768           return getAddExpr(Start, getSignExtendExpr(NewAR, Ty));
1769         }
1770       }
1771
1772       if (proveNoWrapByVaryingStart<SCEVSignExtendExpr>(Start, Step, L)) {
1773         const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNSW);
1774         return getAddRecExpr(
1775             getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1776             getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1777       }
1778     }
1779
1780   // The cast wasn't folded; create an explicit cast node.
1781   // Recompute the insert position, as it may have been invalidated.
1782   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1783   SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator),
1784                                                    Op, Ty);
1785   UniqueSCEVs.InsertNode(S, IP);
1786   return S;
1787 }
1788
1789 /// getAnyExtendExpr - Return a SCEV for the given operand extended with
1790 /// unspecified bits out to the given type.
1791 ///
1792 const SCEV *ScalarEvolution::getAnyExtendExpr(const SCEV *Op,
1793                                               Type *Ty) {
1794   assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1795          "This is not an extending conversion!");
1796   assert(isSCEVable(Ty) &&
1797          "This is not a conversion to a SCEVable type!");
1798   Ty = getEffectiveSCEVType(Ty);
1799
1800   // Sign-extend negative constants.
1801   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1802     if (SC->getValue()->getValue().isNegative())
1803       return getSignExtendExpr(Op, Ty);
1804
1805   // Peel off a truncate cast.
1806   if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Op)) {
1807     const SCEV *NewOp = T->getOperand();
1808     if (getTypeSizeInBits(NewOp->getType()) < getTypeSizeInBits(Ty))
1809       return getAnyExtendExpr(NewOp, Ty);
1810     return getTruncateOrNoop(NewOp, Ty);
1811   }
1812
1813   // Next try a zext cast. If the cast is folded, use it.
1814   const SCEV *ZExt = getZeroExtendExpr(Op, Ty);
1815   if (!isa<SCEVZeroExtendExpr>(ZExt))
1816     return ZExt;
1817
1818   // Next try a sext cast. If the cast is folded, use it.
1819   const SCEV *SExt = getSignExtendExpr(Op, Ty);
1820   if (!isa<SCEVSignExtendExpr>(SExt))
1821     return SExt;
1822
1823   // Force the cast to be folded into the operands of an addrec.
1824   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) {
1825     SmallVector<const SCEV *, 4> Ops;
1826     for (const SCEV *Op : AR->operands())
1827       Ops.push_back(getAnyExtendExpr(Op, Ty));
1828     return getAddRecExpr(Ops, AR->getLoop(), SCEV::FlagNW);
1829   }
1830
1831   // If the expression is obviously signed, use the sext cast value.
1832   if (isa<SCEVSMaxExpr>(Op))
1833     return SExt;
1834
1835   // Absent any other information, use the zext cast value.
1836   return ZExt;
1837 }
1838
1839 /// CollectAddOperandsWithScales - Process the given Ops list, which is
1840 /// a list of operands to be added under the given scale, update the given
1841 /// map. This is a helper function for getAddRecExpr. As an example of
1842 /// what it does, given a sequence of operands that would form an add
1843 /// expression like this:
1844 ///
1845 ///    m + n + 13 + (A * (o + p + (B * (q + m + 29)))) + r + (-1 * r)
1846 ///
1847 /// where A and B are constants, update the map with these values:
1848 ///
1849 ///    (m, 1+A*B), (n, 1), (o, A), (p, A), (q, A*B), (r, 0)
1850 ///
1851 /// and add 13 + A*B*29 to AccumulatedConstant.
1852 /// This will allow getAddRecExpr to produce this:
1853 ///
1854 ///    13+A*B*29 + n + (m * (1+A*B)) + ((o + p) * A) + (q * A*B)
1855 ///
1856 /// This form often exposes folding opportunities that are hidden in
1857 /// the original operand list.
1858 ///
1859 /// Return true iff it appears that any interesting folding opportunities
1860 /// may be exposed. This helps getAddRecExpr short-circuit extra work in
1861 /// the common case where no interesting opportunities are present, and
1862 /// is also used as a check to avoid infinite recursion.
1863 ///
1864 static bool
1865 CollectAddOperandsWithScales(DenseMap<const SCEV *, APInt> &M,
1866                              SmallVectorImpl<const SCEV *> &NewOps,
1867                              APInt &AccumulatedConstant,
1868                              const SCEV *const *Ops, size_t NumOperands,
1869                              const APInt &Scale,
1870                              ScalarEvolution &SE) {
1871   bool Interesting = false;
1872
1873   // Iterate over the add operands. They are sorted, with constants first.
1874   unsigned i = 0;
1875   while (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
1876     ++i;
1877     // Pull a buried constant out to the outside.
1878     if (Scale != 1 || AccumulatedConstant != 0 || C->getValue()->isZero())
1879       Interesting = true;
1880     AccumulatedConstant += Scale * C->getValue()->getValue();
1881   }
1882
1883   // Next comes everything else. We're especially interested in multiplies
1884   // here, but they're in the middle, so just visit the rest with one loop.
1885   for (; i != NumOperands; ++i) {
1886     const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[i]);
1887     if (Mul && isa<SCEVConstant>(Mul->getOperand(0))) {
1888       APInt NewScale =
1889         Scale * cast<SCEVConstant>(Mul->getOperand(0))->getValue()->getValue();
1890       if (Mul->getNumOperands() == 2 && isa<SCEVAddExpr>(Mul->getOperand(1))) {
1891         // A multiplication of a constant with another add; recurse.
1892         const SCEVAddExpr *Add = cast<SCEVAddExpr>(Mul->getOperand(1));
1893         Interesting |=
1894           CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
1895                                        Add->op_begin(), Add->getNumOperands(),
1896                                        NewScale, SE);
1897       } else {
1898         // A multiplication of a constant with some other value. Update
1899         // the map.
1900         SmallVector<const SCEV *, 4> MulOps(Mul->op_begin()+1, Mul->op_end());
1901         const SCEV *Key = SE.getMulExpr(MulOps);
1902         auto Pair = M.insert(std::make_pair(Key, NewScale));
1903         if (Pair.second) {
1904           NewOps.push_back(Pair.first->first);
1905         } else {
1906           Pair.first->second += NewScale;
1907           // The map already had an entry for this value, which may indicate
1908           // a folding opportunity.
1909           Interesting = true;
1910         }
1911       }
1912     } else {
1913       // An ordinary operand. Update the map.
1914       std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair =
1915         M.insert(std::make_pair(Ops[i], Scale));
1916       if (Pair.second) {
1917         NewOps.push_back(Pair.first->first);
1918       } else {
1919         Pair.first->second += Scale;
1920         // The map already had an entry for this value, which may indicate
1921         // a folding opportunity.
1922         Interesting = true;
1923       }
1924     }
1925   }
1926
1927   return Interesting;
1928 }
1929
1930 // We're trying to construct a SCEV of type `Type' with `Ops' as operands and
1931 // `OldFlags' as can't-wrap behavior.  Infer a more aggressive set of
1932 // can't-overflow flags for the operation if possible.
1933 static SCEV::NoWrapFlags
1934 StrengthenNoWrapFlags(ScalarEvolution *SE, SCEVTypes Type,
1935                       const SmallVectorImpl<const SCEV *> &Ops,
1936                       SCEV::NoWrapFlags Flags) {
1937   using namespace std::placeholders;
1938   typedef OverflowingBinaryOperator OBO;
1939
1940   bool CanAnalyze =
1941       Type == scAddExpr || Type == scAddRecExpr || Type == scMulExpr;
1942   (void)CanAnalyze;
1943   assert(CanAnalyze && "don't call from other places!");
1944
1945   int SignOrUnsignMask = SCEV::FlagNUW | SCEV::FlagNSW;
1946   SCEV::NoWrapFlags SignOrUnsignWrap =
1947       ScalarEvolution::maskFlags(Flags, SignOrUnsignMask);
1948
1949   // If FlagNSW is true and all the operands are non-negative, infer FlagNUW.
1950   auto IsKnownNonNegative = [&](const SCEV *S) {
1951     return SE->isKnownNonNegative(S);
1952   };
1953
1954   if (SignOrUnsignWrap == SCEV::FlagNSW && all_of(Ops, IsKnownNonNegative))
1955     Flags =
1956         ScalarEvolution::setFlags(Flags, (SCEV::NoWrapFlags)SignOrUnsignMask);
1957
1958   SignOrUnsignWrap = ScalarEvolution::maskFlags(Flags, SignOrUnsignMask);
1959
1960   if (SignOrUnsignWrap != SignOrUnsignMask && Type == scAddExpr &&
1961       Ops.size() == 2 && isa<SCEVConstant>(Ops[0])) {
1962
1963     // (A + C) --> (A + C)<nsw> if the addition does not sign overflow
1964     // (A + C) --> (A + C)<nuw> if the addition does not unsign overflow
1965
1966     const APInt &C = cast<SCEVConstant>(Ops[0])->getValue()->getValue();
1967     if (!(SignOrUnsignWrap & SCEV::FlagNSW)) {
1968       auto NSWRegion =
1969         ConstantRange::makeNoWrapRegion(Instruction::Add, C, OBO::NoSignedWrap);
1970       if (NSWRegion.contains(SE->getSignedRange(Ops[1])))
1971         Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW);
1972     }
1973     if (!(SignOrUnsignWrap & SCEV::FlagNUW)) {
1974       auto NUWRegion =
1975         ConstantRange::makeNoWrapRegion(Instruction::Add, C,
1976                                         OBO::NoUnsignedWrap);
1977       if (NUWRegion.contains(SE->getUnsignedRange(Ops[1])))
1978         Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW);
1979     }
1980   }
1981
1982   return Flags;
1983 }
1984
1985 /// getAddExpr - Get a canonical add expression, or something simpler if
1986 /// possible.
1987 const SCEV *ScalarEvolution::getAddExpr(SmallVectorImpl<const SCEV *> &Ops,
1988                                         SCEV::NoWrapFlags Flags) {
1989   assert(!(Flags & ~(SCEV::FlagNUW | SCEV::FlagNSW)) &&
1990          "only nuw or nsw allowed");
1991   assert(!Ops.empty() && "Cannot get empty add!");
1992   if (Ops.size() == 1) return Ops[0];
1993 #ifndef NDEBUG
1994   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
1995   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
1996     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
1997            "SCEVAddExpr operand types don't match!");
1998 #endif
1999
2000   // Sort by complexity, this groups all similar expression types together.
2001   GroupByComplexity(Ops, &LI);
2002
2003   Flags = StrengthenNoWrapFlags(this, scAddExpr, Ops, Flags);
2004
2005   // If there are any constants, fold them together.
2006   unsigned Idx = 0;
2007   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
2008     ++Idx;
2009     assert(Idx < Ops.size());
2010     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
2011       // We found two constants, fold them together!
2012       Ops[0] = getConstant(LHSC->getValue()->getValue() +
2013                            RHSC->getValue()->getValue());
2014       if (Ops.size() == 2) return Ops[0];
2015       Ops.erase(Ops.begin()+1);  // Erase the folded element
2016       LHSC = cast<SCEVConstant>(Ops[0]);
2017     }
2018
2019     // If we are left with a constant zero being added, strip it off.
2020     if (LHSC->getValue()->isZero()) {
2021       Ops.erase(Ops.begin());
2022       --Idx;
2023     }
2024
2025     if (Ops.size() == 1) return Ops[0];
2026   }
2027
2028   // Okay, check to see if the same value occurs in the operand list more than
2029   // once.  If so, merge them together into an multiply expression.  Since we
2030   // sorted the list, these values are required to be adjacent.
2031   Type *Ty = Ops[0]->getType();
2032   bool FoundMatch = false;
2033   for (unsigned i = 0, e = Ops.size(); i != e-1; ++i)
2034     if (Ops[i] == Ops[i+1]) {      //  X + Y + Y  -->  X + Y*2
2035       // Scan ahead to count how many equal operands there are.
2036       unsigned Count = 2;
2037       while (i+Count != e && Ops[i+Count] == Ops[i])
2038         ++Count;
2039       // Merge the values into a multiply.
2040       const SCEV *Scale = getConstant(Ty, Count);
2041       const SCEV *Mul = getMulExpr(Scale, Ops[i]);
2042       if (Ops.size() == Count)
2043         return Mul;
2044       Ops[i] = Mul;
2045       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+Count);
2046       --i; e -= Count - 1;
2047       FoundMatch = true;
2048     }
2049   if (FoundMatch)
2050     return getAddExpr(Ops, Flags);
2051
2052   // Check for truncates. If all the operands are truncated from the same
2053   // type, see if factoring out the truncate would permit the result to be
2054   // folded. eg., trunc(x) + m*trunc(n) --> trunc(x + trunc(m)*n)
2055   // if the contents of the resulting outer trunc fold to something simple.
2056   for (; Idx < Ops.size() && isa<SCEVTruncateExpr>(Ops[Idx]); ++Idx) {
2057     const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(Ops[Idx]);
2058     Type *DstType = Trunc->getType();
2059     Type *SrcType = Trunc->getOperand()->getType();
2060     SmallVector<const SCEV *, 8> LargeOps;
2061     bool Ok = true;
2062     // Check all the operands to see if they can be represented in the
2063     // source type of the truncate.
2064     for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
2065       if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Ops[i])) {
2066         if (T->getOperand()->getType() != SrcType) {
2067           Ok = false;
2068           break;
2069         }
2070         LargeOps.push_back(T->getOperand());
2071       } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
2072         LargeOps.push_back(getAnyExtendExpr(C, SrcType));
2073       } else if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Ops[i])) {
2074         SmallVector<const SCEV *, 8> LargeMulOps;
2075         for (unsigned j = 0, f = M->getNumOperands(); j != f && Ok; ++j) {
2076           if (const SCEVTruncateExpr *T =
2077                 dyn_cast<SCEVTruncateExpr>(M->getOperand(j))) {
2078             if (T->getOperand()->getType() != SrcType) {
2079               Ok = false;
2080               break;
2081             }
2082             LargeMulOps.push_back(T->getOperand());
2083           } else if (const auto *C = dyn_cast<SCEVConstant>(M->getOperand(j))) {
2084             LargeMulOps.push_back(getAnyExtendExpr(C, SrcType));
2085           } else {
2086             Ok = false;
2087             break;
2088           }
2089         }
2090         if (Ok)
2091           LargeOps.push_back(getMulExpr(LargeMulOps));
2092       } else {
2093         Ok = false;
2094         break;
2095       }
2096     }
2097     if (Ok) {
2098       // Evaluate the expression in the larger type.
2099       const SCEV *Fold = getAddExpr(LargeOps, Flags);
2100       // If it folds to something simple, use it. Otherwise, don't.
2101       if (isa<SCEVConstant>(Fold) || isa<SCEVUnknown>(Fold))
2102         return getTruncateExpr(Fold, DstType);
2103     }
2104   }
2105
2106   // Skip past any other cast SCEVs.
2107   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddExpr)
2108     ++Idx;
2109
2110   // If there are add operands they would be next.
2111   if (Idx < Ops.size()) {
2112     bool DeletedAdd = false;
2113     while (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[Idx])) {
2114       // If we have an add, expand the add operands onto the end of the operands
2115       // list.
2116       Ops.erase(Ops.begin()+Idx);
2117       Ops.append(Add->op_begin(), Add->op_end());
2118       DeletedAdd = true;
2119     }
2120
2121     // If we deleted at least one add, we added operands to the end of the list,
2122     // and they are not necessarily sorted.  Recurse to resort and resimplify
2123     // any operands we just acquired.
2124     if (DeletedAdd)
2125       return getAddExpr(Ops);
2126   }
2127
2128   // Skip over the add expression until we get to a multiply.
2129   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
2130     ++Idx;
2131
2132   // Check to see if there are any folding opportunities present with
2133   // operands multiplied by constant values.
2134   if (Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx])) {
2135     uint64_t BitWidth = getTypeSizeInBits(Ty);
2136     DenseMap<const SCEV *, APInt> M;
2137     SmallVector<const SCEV *, 8> NewOps;
2138     APInt AccumulatedConstant(BitWidth, 0);
2139     if (CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
2140                                      Ops.data(), Ops.size(),
2141                                      APInt(BitWidth, 1), *this)) {
2142       struct APIntCompare {
2143         bool operator()(const APInt &LHS, const APInt &RHS) const {
2144           return LHS.ult(RHS);
2145         }
2146       };
2147
2148       // Some interesting folding opportunity is present, so its worthwhile to
2149       // re-generate the operands list. Group the operands by constant scale,
2150       // to avoid multiplying by the same constant scale multiple times.
2151       std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare> MulOpLists;
2152       for (const SCEV *NewOp : NewOps)
2153         MulOpLists[M.find(NewOp)->second].push_back(NewOp);
2154       // Re-generate the operands list.
2155       Ops.clear();
2156       if (AccumulatedConstant != 0)
2157         Ops.push_back(getConstant(AccumulatedConstant));
2158       for (auto &MulOp : MulOpLists)
2159         if (MulOp.first != 0)
2160           Ops.push_back(getMulExpr(getConstant(MulOp.first),
2161                                    getAddExpr(MulOp.second)));
2162       if (Ops.empty())
2163         return getZero(Ty);
2164       if (Ops.size() == 1)
2165         return Ops[0];
2166       return getAddExpr(Ops);
2167     }
2168   }
2169
2170   // If we are adding something to a multiply expression, make sure the
2171   // something is not already an operand of the multiply.  If so, merge it into
2172   // the multiply.
2173   for (; Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx]); ++Idx) {
2174     const SCEVMulExpr *Mul = cast<SCEVMulExpr>(Ops[Idx]);
2175     for (unsigned MulOp = 0, e = Mul->getNumOperands(); MulOp != e; ++MulOp) {
2176       const SCEV *MulOpSCEV = Mul->getOperand(MulOp);
2177       if (isa<SCEVConstant>(MulOpSCEV))
2178         continue;
2179       for (unsigned AddOp = 0, e = Ops.size(); AddOp != e; ++AddOp)
2180         if (MulOpSCEV == Ops[AddOp]) {
2181           // Fold W + X + (X * Y * Z)  -->  W + (X * ((Y*Z)+1))
2182           const SCEV *InnerMul = Mul->getOperand(MulOp == 0);
2183           if (Mul->getNumOperands() != 2) {
2184             // If the multiply has more than two operands, we must get the
2185             // Y*Z term.
2186             SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(),
2187                                                 Mul->op_begin()+MulOp);
2188             MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end());
2189             InnerMul = getMulExpr(MulOps);
2190           }
2191           const SCEV *One = getOne(Ty);
2192           const SCEV *AddOne = getAddExpr(One, InnerMul);
2193           const SCEV *OuterMul = getMulExpr(AddOne, MulOpSCEV);
2194           if (Ops.size() == 2) return OuterMul;
2195           if (AddOp < Idx) {
2196             Ops.erase(Ops.begin()+AddOp);
2197             Ops.erase(Ops.begin()+Idx-1);
2198           } else {
2199             Ops.erase(Ops.begin()+Idx);
2200             Ops.erase(Ops.begin()+AddOp-1);
2201           }
2202           Ops.push_back(OuterMul);
2203           return getAddExpr(Ops);
2204         }
2205
2206       // Check this multiply against other multiplies being added together.
2207       for (unsigned OtherMulIdx = Idx+1;
2208            OtherMulIdx < Ops.size() && isa<SCEVMulExpr>(Ops[OtherMulIdx]);
2209            ++OtherMulIdx) {
2210         const SCEVMulExpr *OtherMul = cast<SCEVMulExpr>(Ops[OtherMulIdx]);
2211         // If MulOp occurs in OtherMul, we can fold the two multiplies
2212         // together.
2213         for (unsigned OMulOp = 0, e = OtherMul->getNumOperands();
2214              OMulOp != e; ++OMulOp)
2215           if (OtherMul->getOperand(OMulOp) == MulOpSCEV) {
2216             // Fold X + (A*B*C) + (A*D*E) --> X + (A*(B*C+D*E))
2217             const SCEV *InnerMul1 = Mul->getOperand(MulOp == 0);
2218             if (Mul->getNumOperands() != 2) {
2219               SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(),
2220                                                   Mul->op_begin()+MulOp);
2221               MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end());
2222               InnerMul1 = getMulExpr(MulOps);
2223             }
2224             const SCEV *InnerMul2 = OtherMul->getOperand(OMulOp == 0);
2225             if (OtherMul->getNumOperands() != 2) {
2226               SmallVector<const SCEV *, 4> MulOps(OtherMul->op_begin(),
2227                                                   OtherMul->op_begin()+OMulOp);
2228               MulOps.append(OtherMul->op_begin()+OMulOp+1, OtherMul->op_end());
2229               InnerMul2 = getMulExpr(MulOps);
2230             }
2231             const SCEV *InnerMulSum = getAddExpr(InnerMul1,InnerMul2);
2232             const SCEV *OuterMul = getMulExpr(MulOpSCEV, InnerMulSum);
2233             if (Ops.size() == 2) return OuterMul;
2234             Ops.erase(Ops.begin()+Idx);
2235             Ops.erase(Ops.begin()+OtherMulIdx-1);
2236             Ops.push_back(OuterMul);
2237             return getAddExpr(Ops);
2238           }
2239       }
2240     }
2241   }
2242
2243   // If there are any add recurrences in the operands list, see if any other
2244   // added values are loop invariant.  If so, we can fold them into the
2245   // recurrence.
2246   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
2247     ++Idx;
2248
2249   // Scan over all recurrences, trying to fold loop invariants into them.
2250   for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
2251     // Scan all of the other operands to this add and add them to the vector if
2252     // they are loop invariant w.r.t. the recurrence.
2253     SmallVector<const SCEV *, 8> LIOps;
2254     const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
2255     const Loop *AddRecLoop = AddRec->getLoop();
2256     for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2257       if (isLoopInvariant(Ops[i], AddRecLoop)) {
2258         LIOps.push_back(Ops[i]);
2259         Ops.erase(Ops.begin()+i);
2260         --i; --e;
2261       }
2262
2263     // If we found some loop invariants, fold them into the recurrence.
2264     if (!LIOps.empty()) {
2265       //  NLI + LI + {Start,+,Step}  -->  NLI + {LI+Start,+,Step}
2266       LIOps.push_back(AddRec->getStart());
2267
2268       SmallVector<const SCEV *, 4> AddRecOps(AddRec->op_begin(),
2269                                              AddRec->op_end());
2270       AddRecOps[0] = getAddExpr(LIOps);
2271
2272       // Build the new addrec. Propagate the NUW and NSW flags if both the
2273       // outer add and the inner addrec are guaranteed to have no overflow.
2274       // Always propagate NW.
2275       Flags = AddRec->getNoWrapFlags(setFlags(Flags, SCEV::FlagNW));
2276       const SCEV *NewRec = getAddRecExpr(AddRecOps, AddRecLoop, Flags);
2277
2278       // If all of the other operands were loop invariant, we are done.
2279       if (Ops.size() == 1) return NewRec;
2280
2281       // Otherwise, add the folded AddRec by the non-invariant parts.
2282       for (unsigned i = 0;; ++i)
2283         if (Ops[i] == AddRec) {
2284           Ops[i] = NewRec;
2285           break;
2286         }
2287       return getAddExpr(Ops);
2288     }
2289
2290     // Okay, if there weren't any loop invariants to be folded, check to see if
2291     // there are multiple AddRec's with the same loop induction variable being
2292     // added together.  If so, we can fold them.
2293     for (unsigned OtherIdx = Idx+1;
2294          OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
2295          ++OtherIdx)
2296       if (AddRecLoop == cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()) {
2297         // Other + {A,+,B}<L> + {C,+,D}<L>  -->  Other + {A+C,+,B+D}<L>
2298         SmallVector<const SCEV *, 4> AddRecOps(AddRec->op_begin(),
2299                                                AddRec->op_end());
2300         for (; OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
2301              ++OtherIdx)
2302           if (const auto *OtherAddRec = dyn_cast<SCEVAddRecExpr>(Ops[OtherIdx]))
2303             if (OtherAddRec->getLoop() == AddRecLoop) {
2304               for (unsigned i = 0, e = OtherAddRec->getNumOperands();
2305                    i != e; ++i) {
2306                 if (i >= AddRecOps.size()) {
2307                   AddRecOps.append(OtherAddRec->op_begin()+i,
2308                                    OtherAddRec->op_end());
2309                   break;
2310                 }
2311                 AddRecOps[i] = getAddExpr(AddRecOps[i],
2312                                           OtherAddRec->getOperand(i));
2313               }
2314               Ops.erase(Ops.begin() + OtherIdx); --OtherIdx;
2315             }
2316         // Step size has changed, so we cannot guarantee no self-wraparound.
2317         Ops[Idx] = getAddRecExpr(AddRecOps, AddRecLoop, SCEV::FlagAnyWrap);
2318         return getAddExpr(Ops);
2319       }
2320
2321     // Otherwise couldn't fold anything into this recurrence.  Move onto the
2322     // next one.
2323   }
2324
2325   // Okay, it looks like we really DO need an add expr.  Check to see if we
2326   // already have one, otherwise create a new one.
2327   FoldingSetNodeID ID;
2328   ID.AddInteger(scAddExpr);
2329   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2330     ID.AddPointer(Ops[i]);
2331   void *IP = nullptr;
2332   SCEVAddExpr *S =
2333     static_cast<SCEVAddExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2334   if (!S) {
2335     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2336     std::uninitialized_copy(Ops.begin(), Ops.end(), O);
2337     S = new (SCEVAllocator) SCEVAddExpr(ID.Intern(SCEVAllocator),
2338                                         O, Ops.size());
2339     UniqueSCEVs.InsertNode(S, IP);
2340   }
2341   S->setNoWrapFlags(Flags);
2342   return S;
2343 }
2344
2345 static uint64_t umul_ov(uint64_t i, uint64_t j, bool &Overflow) {
2346   uint64_t k = i*j;
2347   if (j > 1 && k / j != i) Overflow = true;
2348   return k;
2349 }
2350
2351 /// Compute the result of "n choose k", the binomial coefficient.  If an
2352 /// intermediate computation overflows, Overflow will be set and the return will
2353 /// be garbage. Overflow is not cleared on absence of overflow.
2354 static uint64_t Choose(uint64_t n, uint64_t k, bool &Overflow) {
2355   // We use the multiplicative formula:
2356   //     n(n-1)(n-2)...(n-(k-1)) / k(k-1)(k-2)...1 .
2357   // At each iteration, we take the n-th term of the numeral and divide by the
2358   // (k-n)th term of the denominator.  This division will always produce an
2359   // integral result, and helps reduce the chance of overflow in the
2360   // intermediate computations. However, we can still overflow even when the
2361   // final result would fit.
2362
2363   if (n == 0 || n == k) return 1;
2364   if (k > n) return 0;
2365
2366   if (k > n/2)
2367     k = n-k;
2368
2369   uint64_t r = 1;
2370   for (uint64_t i = 1; i <= k; ++i) {
2371     r = umul_ov(r, n-(i-1), Overflow);
2372     r /= i;
2373   }
2374   return r;
2375 }
2376
2377 /// Determine if any of the operands in this SCEV are a constant or if
2378 /// any of the add or multiply expressions in this SCEV contain a constant.
2379 static bool containsConstantSomewhere(const SCEV *StartExpr) {
2380   SmallVector<const SCEV *, 4> Ops;
2381   Ops.push_back(StartExpr);
2382   while (!Ops.empty()) {
2383     const SCEV *CurrentExpr = Ops.pop_back_val();
2384     if (isa<SCEVConstant>(*CurrentExpr))
2385       return true;
2386
2387     if (isa<SCEVAddExpr>(*CurrentExpr) || isa<SCEVMulExpr>(*CurrentExpr)) {
2388       const auto *CurrentNAry = cast<SCEVNAryExpr>(CurrentExpr);
2389       Ops.append(CurrentNAry->op_begin(), CurrentNAry->op_end());
2390     }
2391   }
2392   return false;
2393 }
2394
2395 /// getMulExpr - Get a canonical multiply expression, or something simpler if
2396 /// possible.
2397 const SCEV *ScalarEvolution::getMulExpr(SmallVectorImpl<const SCEV *> &Ops,
2398                                         SCEV::NoWrapFlags Flags) {
2399   assert(Flags == maskFlags(Flags, SCEV::FlagNUW | SCEV::FlagNSW) &&
2400          "only nuw or nsw allowed");
2401   assert(!Ops.empty() && "Cannot get empty mul!");
2402   if (Ops.size() == 1) return Ops[0];
2403 #ifndef NDEBUG
2404   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
2405   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
2406     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
2407            "SCEVMulExpr operand types don't match!");
2408 #endif
2409
2410   // Sort by complexity, this groups all similar expression types together.
2411   GroupByComplexity(Ops, &LI);
2412
2413   Flags = StrengthenNoWrapFlags(this, scMulExpr, Ops, Flags);
2414
2415   // If there are any constants, fold them together.
2416   unsigned Idx = 0;
2417   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
2418
2419     // C1*(C2+V) -> C1*C2 + C1*V
2420     if (Ops.size() == 2)
2421         if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1]))
2422           // If any of Add's ops are Adds or Muls with a constant,
2423           // apply this transformation as well.
2424           if (Add->getNumOperands() == 2)
2425             if (containsConstantSomewhere(Add))
2426               return getAddExpr(getMulExpr(LHSC, Add->getOperand(0)),
2427                                 getMulExpr(LHSC, Add->getOperand(1)));
2428
2429     ++Idx;
2430     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
2431       // We found two constants, fold them together!
2432       ConstantInt *Fold = ConstantInt::get(getContext(),
2433                                            LHSC->getValue()->getValue() *
2434                                            RHSC->getValue()->getValue());
2435       Ops[0] = getConstant(Fold);
2436       Ops.erase(Ops.begin()+1);  // Erase the folded element
2437       if (Ops.size() == 1) return Ops[0];
2438       LHSC = cast<SCEVConstant>(Ops[0]);
2439     }
2440
2441     // If we are left with a constant one being multiplied, strip it off.
2442     if (cast<SCEVConstant>(Ops[0])->getValue()->equalsInt(1)) {
2443       Ops.erase(Ops.begin());
2444       --Idx;
2445     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isZero()) {
2446       // If we have a multiply of zero, it will always be zero.
2447       return Ops[0];
2448     } else if (Ops[0]->isAllOnesValue()) {
2449       // If we have a mul by -1 of an add, try distributing the -1 among the
2450       // add operands.
2451       if (Ops.size() == 2) {
2452         if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1])) {
2453           SmallVector<const SCEV *, 4> NewOps;
2454           bool AnyFolded = false;
2455           for (const SCEV *AddOp : Add->operands()) {
2456             const SCEV *Mul = getMulExpr(Ops[0], AddOp);
2457             if (!isa<SCEVMulExpr>(Mul)) AnyFolded = true;
2458             NewOps.push_back(Mul);
2459           }
2460           if (AnyFolded)
2461             return getAddExpr(NewOps);
2462         } else if (const auto *AddRec = dyn_cast<SCEVAddRecExpr>(Ops[1])) {
2463           // Negation preserves a recurrence's no self-wrap property.
2464           SmallVector<const SCEV *, 4> Operands;
2465           for (const SCEV *AddRecOp : AddRec->operands())
2466             Operands.push_back(getMulExpr(Ops[0], AddRecOp));
2467
2468           return getAddRecExpr(Operands, AddRec->getLoop(),
2469                                AddRec->getNoWrapFlags(SCEV::FlagNW));
2470         }
2471       }
2472     }
2473
2474     if (Ops.size() == 1)
2475       return Ops[0];
2476   }
2477
2478   // Skip over the add expression until we get to a multiply.
2479   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
2480     ++Idx;
2481
2482   // If there are mul operands inline them all into this expression.
2483   if (Idx < Ops.size()) {
2484     bool DeletedMul = false;
2485     while (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) {
2486       // If we have an mul, expand the mul operands onto the end of the operands
2487       // list.
2488       Ops.erase(Ops.begin()+Idx);
2489       Ops.append(Mul->op_begin(), Mul->op_end());
2490       DeletedMul = true;
2491     }
2492
2493     // If we deleted at least one mul, we added operands to the end of the list,
2494     // and they are not necessarily sorted.  Recurse to resort and resimplify
2495     // any operands we just acquired.
2496     if (DeletedMul)
2497       return getMulExpr(Ops);
2498   }
2499
2500   // If there are any add recurrences in the operands list, see if any other
2501   // added values are loop invariant.  If so, we can fold them into the
2502   // recurrence.
2503   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
2504     ++Idx;
2505
2506   // Scan over all recurrences, trying to fold loop invariants into them.
2507   for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
2508     // Scan all of the other operands to this mul and add them to the vector if
2509     // they are loop invariant w.r.t. the recurrence.
2510     SmallVector<const SCEV *, 8> LIOps;
2511     const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
2512     const Loop *AddRecLoop = AddRec->getLoop();
2513     for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2514       if (isLoopInvariant(Ops[i], AddRecLoop)) {
2515         LIOps.push_back(Ops[i]);
2516         Ops.erase(Ops.begin()+i);
2517         --i; --e;
2518       }
2519
2520     // If we found some loop invariants, fold them into the recurrence.
2521     if (!LIOps.empty()) {
2522       //  NLI * LI * {Start,+,Step}  -->  NLI * {LI*Start,+,LI*Step}
2523       SmallVector<const SCEV *, 4> NewOps;
2524       NewOps.reserve(AddRec->getNumOperands());
2525       const SCEV *Scale = getMulExpr(LIOps);
2526       for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i)
2527         NewOps.push_back(getMulExpr(Scale, AddRec->getOperand(i)));
2528
2529       // Build the new addrec. Propagate the NUW and NSW flags if both the
2530       // outer mul and the inner addrec are guaranteed to have no overflow.
2531       //
2532       // No self-wrap cannot be guaranteed after changing the step size, but
2533       // will be inferred if either NUW or NSW is true.
2534       Flags = AddRec->getNoWrapFlags(clearFlags(Flags, SCEV::FlagNW));
2535       const SCEV *NewRec = getAddRecExpr(NewOps, AddRecLoop, Flags);
2536
2537       // If all of the other operands were loop invariant, we are done.
2538       if (Ops.size() == 1) return NewRec;
2539
2540       // Otherwise, multiply the folded AddRec by the non-invariant parts.
2541       for (unsigned i = 0;; ++i)
2542         if (Ops[i] == AddRec) {
2543           Ops[i] = NewRec;
2544           break;
2545         }
2546       return getMulExpr(Ops);
2547     }
2548
2549     // Okay, if there weren't any loop invariants to be folded, check to see if
2550     // there are multiple AddRec's with the same loop induction variable being
2551     // multiplied together.  If so, we can fold them.
2552
2553     // {A1,+,A2,+,...,+,An}<L> * {B1,+,B2,+,...,+,Bn}<L>
2554     // = {x=1 in [ sum y=x..2x [ sum z=max(y-x, y-n)..min(x,n) [
2555     //       choose(x, 2x)*choose(2x-y, x-z)*A_{y-z}*B_z
2556     //   ]]],+,...up to x=2n}.
2557     // Note that the arguments to choose() are always integers with values
2558     // known at compile time, never SCEV objects.
2559     //
2560     // The implementation avoids pointless extra computations when the two
2561     // addrec's are of different length (mathematically, it's equivalent to
2562     // an infinite stream of zeros on the right).
2563     bool OpsModified = false;
2564     for (unsigned OtherIdx = Idx+1;
2565          OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
2566          ++OtherIdx) {
2567       const SCEVAddRecExpr *OtherAddRec =
2568         dyn_cast<SCEVAddRecExpr>(Ops[OtherIdx]);
2569       if (!OtherAddRec || OtherAddRec->getLoop() != AddRecLoop)
2570         continue;
2571
2572       bool Overflow = false;
2573       Type *Ty = AddRec->getType();
2574       bool LargerThan64Bits = getTypeSizeInBits(Ty) > 64;
2575       SmallVector<const SCEV*, 7> AddRecOps;
2576       for (int x = 0, xe = AddRec->getNumOperands() +
2577              OtherAddRec->getNumOperands() - 1; x != xe && !Overflow; ++x) {
2578         const SCEV *Term = getZero(Ty);
2579         for (int y = x, ye = 2*x+1; y != ye && !Overflow; ++y) {
2580           uint64_t Coeff1 = Choose(x, 2*x - y, Overflow);
2581           for (int z = std::max(y-x, y-(int)AddRec->getNumOperands()+1),
2582                  ze = std::min(x+1, (int)OtherAddRec->getNumOperands());
2583                z < ze && !Overflow; ++z) {
2584             uint64_t Coeff2 = Choose(2*x - y, x-z, Overflow);
2585             uint64_t Coeff;
2586             if (LargerThan64Bits)
2587               Coeff = umul_ov(Coeff1, Coeff2, Overflow);
2588             else
2589               Coeff = Coeff1*Coeff2;
2590             const SCEV *CoeffTerm = getConstant(Ty, Coeff);
2591             const SCEV *Term1 = AddRec->getOperand(y-z);
2592             const SCEV *Term2 = OtherAddRec->getOperand(z);
2593             Term = getAddExpr(Term, getMulExpr(CoeffTerm, Term1,Term2));
2594           }
2595         }
2596         AddRecOps.push_back(Term);
2597       }
2598       if (!Overflow) {
2599         const SCEV *NewAddRec = getAddRecExpr(AddRecOps, AddRec->getLoop(),
2600                                               SCEV::FlagAnyWrap);
2601         if (Ops.size() == 2) return NewAddRec;
2602         Ops[Idx] = NewAddRec;
2603         Ops.erase(Ops.begin() + OtherIdx); --OtherIdx;
2604         OpsModified = true;
2605         AddRec = dyn_cast<SCEVAddRecExpr>(NewAddRec);
2606         if (!AddRec)
2607           break;
2608       }
2609     }
2610     if (OpsModified)
2611       return getMulExpr(Ops);
2612
2613     // Otherwise couldn't fold anything into this recurrence.  Move onto the
2614     // next one.
2615   }
2616
2617   // Okay, it looks like we really DO need an mul expr.  Check to see if we
2618   // already have one, otherwise create a new one.
2619   FoldingSetNodeID ID;
2620   ID.AddInteger(scMulExpr);
2621   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2622     ID.AddPointer(Ops[i]);
2623   void *IP = nullptr;
2624   SCEVMulExpr *S =
2625     static_cast<SCEVMulExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2626   if (!S) {
2627     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2628     std::uninitialized_copy(Ops.begin(), Ops.end(), O);
2629     S = new (SCEVAllocator) SCEVMulExpr(ID.Intern(SCEVAllocator),
2630                                         O, Ops.size());
2631     UniqueSCEVs.InsertNode(S, IP);
2632   }
2633   S->setNoWrapFlags(Flags);
2634   return S;
2635 }
2636
2637 /// getUDivExpr - Get a canonical unsigned division expression, or something
2638 /// simpler if possible.
2639 const SCEV *ScalarEvolution::getUDivExpr(const SCEV *LHS,
2640                                          const SCEV *RHS) {
2641   assert(getEffectiveSCEVType(LHS->getType()) ==
2642          getEffectiveSCEVType(RHS->getType()) &&
2643          "SCEVUDivExpr operand types don't match!");
2644
2645   if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
2646     if (RHSC->getValue()->equalsInt(1))
2647       return LHS;                               // X udiv 1 --> x
2648     // If the denominator is zero, the result of the udiv is undefined. Don't
2649     // try to analyze it, because the resolution chosen here may differ from
2650     // the resolution chosen in other parts of the compiler.
2651     if (!RHSC->getValue()->isZero()) {
2652       // Determine if the division can be folded into the operands of
2653       // its operands.
2654       // TODO: Generalize this to non-constants by using known-bits information.
2655       Type *Ty = LHS->getType();
2656       unsigned LZ = RHSC->getValue()->getValue().countLeadingZeros();
2657       unsigned MaxShiftAmt = getTypeSizeInBits(Ty) - LZ - 1;
2658       // For non-power-of-two values, effectively round the value up to the
2659       // nearest power of two.
2660       if (!RHSC->getValue()->getValue().isPowerOf2())
2661         ++MaxShiftAmt;
2662       IntegerType *ExtTy =
2663         IntegerType::get(getContext(), getTypeSizeInBits(Ty) + MaxShiftAmt);
2664       if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS))
2665         if (const SCEVConstant *Step =
2666             dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this))) {
2667           // {X,+,N}/C --> {X/C,+,N/C} if safe and N/C can be folded.
2668           const APInt &StepInt = Step->getValue()->getValue();
2669           const APInt &DivInt = RHSC->getValue()->getValue();
2670           if (!StepInt.urem(DivInt) &&
2671               getZeroExtendExpr(AR, ExtTy) ==
2672               getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy),
2673                             getZeroExtendExpr(Step, ExtTy),
2674                             AR->getLoop(), SCEV::FlagAnyWrap)) {
2675             SmallVector<const SCEV *, 4> Operands;
2676             for (const SCEV *Op : AR->operands())
2677               Operands.push_back(getUDivExpr(Op, RHS));
2678             return getAddRecExpr(Operands, AR->getLoop(), SCEV::FlagNW);
2679           }
2680           /// Get a canonical UDivExpr for a recurrence.
2681           /// {X,+,N}/C => {Y,+,N}/C where Y=X-(X%N). Safe when C%N=0.
2682           // We can currently only fold X%N if X is constant.
2683           const SCEVConstant *StartC = dyn_cast<SCEVConstant>(AR->getStart());
2684           if (StartC && !DivInt.urem(StepInt) &&
2685               getZeroExtendExpr(AR, ExtTy) ==
2686               getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy),
2687                             getZeroExtendExpr(Step, ExtTy),
2688                             AR->getLoop(), SCEV::FlagAnyWrap)) {
2689             const APInt &StartInt = StartC->getValue()->getValue();
2690             const APInt &StartRem = StartInt.urem(StepInt);
2691             if (StartRem != 0)
2692               LHS = getAddRecExpr(getConstant(StartInt - StartRem), Step,
2693                                   AR->getLoop(), SCEV::FlagNW);
2694           }
2695         }
2696       // (A*B)/C --> A*(B/C) if safe and B/C can be folded.
2697       if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(LHS)) {
2698         SmallVector<const SCEV *, 4> Operands;
2699         for (const SCEV *Op : M->operands())
2700           Operands.push_back(getZeroExtendExpr(Op, ExtTy));
2701         if (getZeroExtendExpr(M, ExtTy) == getMulExpr(Operands))
2702           // Find an operand that's safely divisible.
2703           for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i) {
2704             const SCEV *Op = M->getOperand(i);
2705             const SCEV *Div = getUDivExpr(Op, RHSC);
2706             if (!isa<SCEVUDivExpr>(Div) && getMulExpr(Div, RHSC) == Op) {
2707               Operands = SmallVector<const SCEV *, 4>(M->op_begin(),
2708                                                       M->op_end());
2709               Operands[i] = Div;
2710               return getMulExpr(Operands);
2711             }
2712           }
2713       }
2714       // (A+B)/C --> (A/C + B/C) if safe and A/C and B/C can be folded.
2715       if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(LHS)) {
2716         SmallVector<const SCEV *, 4> Operands;
2717         for (const SCEV *Op : A->operands())
2718           Operands.push_back(getZeroExtendExpr(Op, ExtTy));
2719         if (getZeroExtendExpr(A, ExtTy) == getAddExpr(Operands)) {
2720           Operands.clear();
2721           for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i) {
2722             const SCEV *Op = getUDivExpr(A->getOperand(i), RHS);
2723             if (isa<SCEVUDivExpr>(Op) ||
2724                 getMulExpr(Op, RHS) != A->getOperand(i))
2725               break;
2726             Operands.push_back(Op);
2727           }
2728           if (Operands.size() == A->getNumOperands())
2729             return getAddExpr(Operands);
2730         }
2731       }
2732
2733       // Fold if both operands are constant.
2734       if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
2735         Constant *LHSCV = LHSC->getValue();
2736         Constant *RHSCV = RHSC->getValue();
2737         return getConstant(cast<ConstantInt>(ConstantExpr::getUDiv(LHSCV,
2738                                                                    RHSCV)));
2739       }
2740     }
2741   }
2742
2743   FoldingSetNodeID ID;
2744   ID.AddInteger(scUDivExpr);
2745   ID.AddPointer(LHS);
2746   ID.AddPointer(RHS);
2747   void *IP = nullptr;
2748   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
2749   SCEV *S = new (SCEVAllocator) SCEVUDivExpr(ID.Intern(SCEVAllocator),
2750                                              LHS, RHS);
2751   UniqueSCEVs.InsertNode(S, IP);
2752   return S;
2753 }
2754
2755 static const APInt gcd(const SCEVConstant *C1, const SCEVConstant *C2) {
2756   APInt A = C1->getValue()->getValue().abs();
2757   APInt B = C2->getValue()->getValue().abs();
2758   uint32_t ABW = A.getBitWidth();
2759   uint32_t BBW = B.getBitWidth();
2760
2761   if (ABW > BBW)
2762     B = B.zext(ABW);
2763   else if (ABW < BBW)
2764     A = A.zext(BBW);
2765
2766   return APIntOps::GreatestCommonDivisor(A, B);
2767 }
2768
2769 /// getUDivExactExpr - Get a canonical unsigned division expression, or
2770 /// something simpler if possible. There is no representation for an exact udiv
2771 /// in SCEV IR, but we can attempt to remove factors from the LHS and RHS.
2772 /// We can't do this when it's not exact because the udiv may be clearing bits.
2773 const SCEV *ScalarEvolution::getUDivExactExpr(const SCEV *LHS,
2774                                               const SCEV *RHS) {
2775   // TODO: we could try to find factors in all sorts of things, but for now we
2776   // just deal with u/exact (multiply, constant). See SCEVDivision towards the
2777   // end of this file for inspiration.
2778
2779   const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(LHS);
2780   if (!Mul)
2781     return getUDivExpr(LHS, RHS);
2782
2783   if (const SCEVConstant *RHSCst = dyn_cast<SCEVConstant>(RHS)) {
2784     // If the mulexpr multiplies by a constant, then that constant must be the
2785     // first element of the mulexpr.
2786     if (const auto *LHSCst = dyn_cast<SCEVConstant>(Mul->getOperand(0))) {
2787       if (LHSCst == RHSCst) {
2788         SmallVector<const SCEV *, 2> Operands;
2789         Operands.append(Mul->op_begin() + 1, Mul->op_end());
2790         return getMulExpr(Operands);
2791       }
2792
2793       // We can't just assume that LHSCst divides RHSCst cleanly, it could be
2794       // that there's a factor provided by one of the other terms. We need to
2795       // check.
2796       APInt Factor = gcd(LHSCst, RHSCst);
2797       if (!Factor.isIntN(1)) {
2798         LHSCst = cast<SCEVConstant>(
2799             getConstant(LHSCst->getValue()->getValue().udiv(Factor)));
2800         RHSCst = cast<SCEVConstant>(
2801             getConstant(RHSCst->getValue()->getValue().udiv(Factor)));
2802         SmallVector<const SCEV *, 2> Operands;
2803         Operands.push_back(LHSCst);
2804         Operands.append(Mul->op_begin() + 1, Mul->op_end());
2805         LHS = getMulExpr(Operands);
2806         RHS = RHSCst;
2807         Mul = dyn_cast<SCEVMulExpr>(LHS);
2808         if (!Mul)
2809           return getUDivExactExpr(LHS, RHS);
2810       }
2811     }
2812   }
2813
2814   for (int i = 0, e = Mul->getNumOperands(); i != e; ++i) {
2815     if (Mul->getOperand(i) == RHS) {
2816       SmallVector<const SCEV *, 2> Operands;
2817       Operands.append(Mul->op_begin(), Mul->op_begin() + i);
2818       Operands.append(Mul->op_begin() + i + 1, Mul->op_end());
2819       return getMulExpr(Operands);
2820     }
2821   }
2822
2823   return getUDivExpr(LHS, RHS);
2824 }
2825
2826 /// getAddRecExpr - Get an add recurrence expression for the specified loop.
2827 /// Simplify the expression as much as possible.
2828 const SCEV *ScalarEvolution::getAddRecExpr(const SCEV *Start, const SCEV *Step,
2829                                            const Loop *L,
2830                                            SCEV::NoWrapFlags Flags) {
2831   SmallVector<const SCEV *, 4> Operands;
2832   Operands.push_back(Start);
2833   if (const SCEVAddRecExpr *StepChrec = dyn_cast<SCEVAddRecExpr>(Step))
2834     if (StepChrec->getLoop() == L) {
2835       Operands.append(StepChrec->op_begin(), StepChrec->op_end());
2836       return getAddRecExpr(Operands, L, maskFlags(Flags, SCEV::FlagNW));
2837     }
2838
2839   Operands.push_back(Step);
2840   return getAddRecExpr(Operands, L, Flags);
2841 }
2842
2843 /// getAddRecExpr - Get an add recurrence expression for the specified loop.
2844 /// Simplify the expression as much as possible.
2845 const SCEV *
2846 ScalarEvolution::getAddRecExpr(SmallVectorImpl<const SCEV *> &Operands,
2847                                const Loop *L, SCEV::NoWrapFlags Flags) {
2848   if (Operands.size() == 1) return Operands[0];
2849 #ifndef NDEBUG
2850   Type *ETy = getEffectiveSCEVType(Operands[0]->getType());
2851   for (unsigned i = 1, e = Operands.size(); i != e; ++i)
2852     assert(getEffectiveSCEVType(Operands[i]->getType()) == ETy &&
2853            "SCEVAddRecExpr operand types don't match!");
2854   for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2855     assert(isLoopInvariant(Operands[i], L) &&
2856            "SCEVAddRecExpr operand is not loop-invariant!");
2857 #endif
2858
2859   if (Operands.back()->isZero()) {
2860     Operands.pop_back();
2861     return getAddRecExpr(Operands, L, SCEV::FlagAnyWrap); // {X,+,0}  -->  X
2862   }
2863
2864   // It's tempting to want to call getMaxBackedgeTakenCount count here and
2865   // use that information to infer NUW and NSW flags. However, computing a
2866   // BE count requires calling getAddRecExpr, so we may not yet have a
2867   // meaningful BE count at this point (and if we don't, we'd be stuck
2868   // with a SCEVCouldNotCompute as the cached BE count).
2869
2870   Flags = StrengthenNoWrapFlags(this, scAddRecExpr, Operands, Flags);
2871
2872   // Canonicalize nested AddRecs in by nesting them in order of loop depth.
2873   if (const SCEVAddRecExpr *NestedAR = dyn_cast<SCEVAddRecExpr>(Operands[0])) {
2874     const Loop *NestedLoop = NestedAR->getLoop();
2875     if (L->contains(NestedLoop)
2876             ? (L->getLoopDepth() < NestedLoop->getLoopDepth())
2877             : (!NestedLoop->contains(L) &&
2878                DT.dominates(L->getHeader(), NestedLoop->getHeader()))) {
2879       SmallVector<const SCEV *, 4> NestedOperands(NestedAR->op_begin(),
2880                                                   NestedAR->op_end());
2881       Operands[0] = NestedAR->getStart();
2882       // AddRecs require their operands be loop-invariant with respect to their
2883       // loops. Don't perform this transformation if it would break this
2884       // requirement.
2885       bool AllInvariant = all_of(
2886           Operands, [&](const SCEV *Op) { return isLoopInvariant(Op, L); });
2887
2888       if (AllInvariant) {
2889         // Create a recurrence for the outer loop with the same step size.
2890         //
2891         // The outer recurrence keeps its NW flag but only keeps NUW/NSW if the
2892         // inner recurrence has the same property.
2893         SCEV::NoWrapFlags OuterFlags =
2894           maskFlags(Flags, SCEV::FlagNW | NestedAR->getNoWrapFlags());
2895
2896         NestedOperands[0] = getAddRecExpr(Operands, L, OuterFlags);
2897         AllInvariant = all_of(NestedOperands, [&](const SCEV *Op) {
2898           return isLoopInvariant(Op, NestedLoop);
2899         });
2900
2901         if (AllInvariant) {
2902           // Ok, both add recurrences are valid after the transformation.
2903           //
2904           // The inner recurrence keeps its NW flag but only keeps NUW/NSW if
2905           // the outer recurrence has the same property.
2906           SCEV::NoWrapFlags InnerFlags =
2907             maskFlags(NestedAR->getNoWrapFlags(), SCEV::FlagNW | Flags);
2908           return getAddRecExpr(NestedOperands, NestedLoop, InnerFlags);
2909         }
2910       }
2911       // Reset Operands to its original state.
2912       Operands[0] = NestedAR;
2913     }
2914   }
2915
2916   // Okay, it looks like we really DO need an addrec expr.  Check to see if we
2917   // already have one, otherwise create a new one.
2918   FoldingSetNodeID ID;
2919   ID.AddInteger(scAddRecExpr);
2920   for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2921     ID.AddPointer(Operands[i]);
2922   ID.AddPointer(L);
2923   void *IP = nullptr;
2924   SCEVAddRecExpr *S =
2925     static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2926   if (!S) {
2927     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Operands.size());
2928     std::uninitialized_copy(Operands.begin(), Operands.end(), O);
2929     S = new (SCEVAllocator) SCEVAddRecExpr(ID.Intern(SCEVAllocator),
2930                                            O, Operands.size(), L);
2931     UniqueSCEVs.InsertNode(S, IP);
2932   }
2933   S->setNoWrapFlags(Flags);
2934   return S;
2935 }
2936
2937 const SCEV *
2938 ScalarEvolution::getGEPExpr(Type *PointeeType, const SCEV *BaseExpr,
2939                             const SmallVectorImpl<const SCEV *> &IndexExprs,
2940                             bool InBounds) {
2941   // getSCEV(Base)->getType() has the same address space as Base->getType()
2942   // because SCEV::getType() preserves the address space.
2943   Type *IntPtrTy = getEffectiveSCEVType(BaseExpr->getType());
2944   // FIXME(PR23527): Don't blindly transfer the inbounds flag from the GEP
2945   // instruction to its SCEV, because the Instruction may be guarded by control
2946   // flow and the no-overflow bits may not be valid for the expression in any
2947   // context. This can be fixed similarly to how these flags are handled for
2948   // adds.
2949   SCEV::NoWrapFlags Wrap = InBounds ? SCEV::FlagNSW : SCEV::FlagAnyWrap;
2950
2951   const SCEV *TotalOffset = getZero(IntPtrTy);
2952   // The address space is unimportant. The first thing we do on CurTy is getting
2953   // its element type.
2954   Type *CurTy = PointerType::getUnqual(PointeeType);
2955   for (const SCEV *IndexExpr : IndexExprs) {
2956     // Compute the (potentially symbolic) offset in bytes for this index.
2957     if (StructType *STy = dyn_cast<StructType>(CurTy)) {
2958       // For a struct, add the member offset.
2959       ConstantInt *Index = cast<SCEVConstant>(IndexExpr)->getValue();
2960       unsigned FieldNo = Index->getZExtValue();
2961       const SCEV *FieldOffset = getOffsetOfExpr(IntPtrTy, STy, FieldNo);
2962
2963       // Add the field offset to the running total offset.
2964       TotalOffset = getAddExpr(TotalOffset, FieldOffset);
2965
2966       // Update CurTy to the type of the field at Index.
2967       CurTy = STy->getTypeAtIndex(Index);
2968     } else {
2969       // Update CurTy to its element type.
2970       CurTy = cast<SequentialType>(CurTy)->getElementType();
2971       // For an array, add the element offset, explicitly scaled.
2972       const SCEV *ElementSize = getSizeOfExpr(IntPtrTy, CurTy);
2973       // Getelementptr indices are signed.
2974       IndexExpr = getTruncateOrSignExtend(IndexExpr, IntPtrTy);
2975
2976       // Multiply the index by the element size to compute the element offset.
2977       const SCEV *LocalOffset = getMulExpr(IndexExpr, ElementSize, Wrap);
2978
2979       // Add the element offset to the running total offset.
2980       TotalOffset = getAddExpr(TotalOffset, LocalOffset);
2981     }
2982   }
2983
2984   // Add the total offset from all the GEP indices to the base.
2985   return getAddExpr(BaseExpr, TotalOffset, Wrap);
2986 }
2987
2988 const SCEV *ScalarEvolution::getSMaxExpr(const SCEV *LHS,
2989                                          const SCEV *RHS) {
2990   SmallVector<const SCEV *, 2> Ops;
2991   Ops.push_back(LHS);
2992   Ops.push_back(RHS);
2993   return getSMaxExpr(Ops);
2994 }
2995
2996 const SCEV *
2997 ScalarEvolution::getSMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
2998   assert(!Ops.empty() && "Cannot get empty smax!");
2999   if (Ops.size() == 1) return Ops[0];
3000 #ifndef NDEBUG
3001   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
3002   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
3003     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
3004            "SCEVSMaxExpr operand types don't match!");
3005 #endif
3006
3007   // Sort by complexity, this groups all similar expression types together.
3008   GroupByComplexity(Ops, &LI);
3009
3010   // If there are any constants, fold them together.
3011   unsigned Idx = 0;
3012   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
3013     ++Idx;
3014     assert(Idx < Ops.size());
3015     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
3016       // We found two constants, fold them together!
3017       ConstantInt *Fold = ConstantInt::get(getContext(),
3018                               APIntOps::smax(LHSC->getValue()->getValue(),
3019                                              RHSC->getValue()->getValue()));
3020       Ops[0] = getConstant(Fold);
3021       Ops.erase(Ops.begin()+1);  // Erase the folded element
3022       if (Ops.size() == 1) return Ops[0];
3023       LHSC = cast<SCEVConstant>(Ops[0]);
3024     }
3025
3026     // If we are left with a constant minimum-int, strip it off.
3027     if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(true)) {
3028       Ops.erase(Ops.begin());
3029       --Idx;
3030     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(true)) {
3031       // If we have an smax with a constant maximum-int, it will always be
3032       // maximum-int.
3033       return Ops[0];
3034     }
3035
3036     if (Ops.size() == 1) return Ops[0];
3037   }
3038
3039   // Find the first SMax
3040   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scSMaxExpr)
3041     ++Idx;
3042
3043   // Check to see if one of the operands is an SMax. If so, expand its operands
3044   // onto our operand list, and recurse to simplify.
3045   if (Idx < Ops.size()) {
3046     bool DeletedSMax = false;
3047     while (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(Ops[Idx])) {
3048       Ops.erase(Ops.begin()+Idx);
3049       Ops.append(SMax->op_begin(), SMax->op_end());
3050       DeletedSMax = true;
3051     }
3052
3053     if (DeletedSMax)
3054       return getSMaxExpr(Ops);
3055   }
3056
3057   // Okay, check to see if the same value occurs in the operand list twice.  If
3058   // so, delete one.  Since we sorted the list, these values are required to
3059   // be adjacent.
3060   for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
3061     //  X smax Y smax Y  -->  X smax Y
3062     //  X smax Y         -->  X, if X is always greater than Y
3063     if (Ops[i] == Ops[i+1] ||
3064         isKnownPredicate(ICmpInst::ICMP_SGE, Ops[i], Ops[i+1])) {
3065       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
3066       --i; --e;
3067     } else if (isKnownPredicate(ICmpInst::ICMP_SLE, Ops[i], Ops[i+1])) {
3068       Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
3069       --i; --e;
3070     }
3071
3072   if (Ops.size() == 1) return Ops[0];
3073
3074   assert(!Ops.empty() && "Reduced smax down to nothing!");
3075
3076   // Okay, it looks like we really DO need an smax expr.  Check to see if we
3077   // already have one, otherwise create a new one.
3078   FoldingSetNodeID ID;
3079   ID.AddInteger(scSMaxExpr);
3080   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3081     ID.AddPointer(Ops[i]);
3082   void *IP = nullptr;
3083   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
3084   const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
3085   std::uninitialized_copy(Ops.begin(), Ops.end(), O);
3086   SCEV *S = new (SCEVAllocator) SCEVSMaxExpr(ID.Intern(SCEVAllocator),
3087                                              O, Ops.size());
3088   UniqueSCEVs.InsertNode(S, IP);
3089   return S;
3090 }
3091
3092 const SCEV *ScalarEvolution::getUMaxExpr(const SCEV *LHS,
3093                                          const SCEV *RHS) {
3094   SmallVector<const SCEV *, 2> Ops;
3095   Ops.push_back(LHS);
3096   Ops.push_back(RHS);
3097   return getUMaxExpr(Ops);
3098 }
3099
3100 const SCEV *
3101 ScalarEvolution::getUMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
3102   assert(!Ops.empty() && "Cannot get empty umax!");
3103   if (Ops.size() == 1) return Ops[0];
3104 #ifndef NDEBUG
3105   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
3106   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
3107     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
3108            "SCEVUMaxExpr operand types don't match!");
3109 #endif
3110
3111   // Sort by complexity, this groups all similar expression types together.
3112   GroupByComplexity(Ops, &LI);
3113
3114   // If there are any constants, fold them together.
3115   unsigned Idx = 0;
3116   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
3117     ++Idx;
3118     assert(Idx < Ops.size());
3119     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
3120       // We found two constants, fold them together!
3121       ConstantInt *Fold = ConstantInt::get(getContext(),
3122                               APIntOps::umax(LHSC->getValue()->getValue(),
3123                                              RHSC->getValue()->getValue()));
3124       Ops[0] = getConstant(Fold);
3125       Ops.erase(Ops.begin()+1);  // Erase the folded element
3126       if (Ops.size() == 1) return Ops[0];
3127       LHSC = cast<SCEVConstant>(Ops[0]);
3128     }
3129
3130     // If we are left with a constant minimum-int, strip it off.
3131     if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(false)) {
3132       Ops.erase(Ops.begin());
3133       --Idx;
3134     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(false)) {
3135       // If we have an umax with a constant maximum-int, it will always be
3136       // maximum-int.
3137       return Ops[0];
3138     }
3139
3140     if (Ops.size() == 1) return Ops[0];
3141   }
3142
3143   // Find the first UMax
3144   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scUMaxExpr)
3145     ++Idx;
3146
3147   // Check to see if one of the operands is a UMax. If so, expand its operands
3148   // onto our operand list, and recurse to simplify.
3149   if (Idx < Ops.size()) {
3150     bool DeletedUMax = false;
3151     while (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(Ops[Idx])) {
3152       Ops.erase(Ops.begin()+Idx);
3153       Ops.append(UMax->op_begin(), UMax->op_end());
3154       DeletedUMax = true;
3155     }
3156
3157     if (DeletedUMax)
3158       return getUMaxExpr(Ops);
3159   }
3160
3161   // Okay, check to see if the same value occurs in the operand list twice.  If
3162   // so, delete one.  Since we sorted the list, these values are required to
3163   // be adjacent.
3164   for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
3165     //  X umax Y umax Y  -->  X umax Y
3166     //  X umax Y         -->  X, if X is always greater than Y
3167     if (Ops[i] == Ops[i+1] ||
3168         isKnownPredicate(ICmpInst::ICMP_UGE, Ops[i], Ops[i+1])) {
3169       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
3170       --i; --e;
3171     } else if (isKnownPredicate(ICmpInst::ICMP_ULE, Ops[i], Ops[i+1])) {
3172       Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
3173       --i; --e;
3174     }
3175
3176   if (Ops.size() == 1) return Ops[0];
3177
3178   assert(!Ops.empty() && "Reduced umax down to nothing!");
3179
3180   // Okay, it looks like we really DO need a umax expr.  Check to see if we
3181   // already have one, otherwise create a new one.
3182   FoldingSetNodeID ID;
3183   ID.AddInteger(scUMaxExpr);
3184   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3185     ID.AddPointer(Ops[i]);
3186   void *IP = nullptr;
3187   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
3188   const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
3189   std::uninitialized_copy(Ops.begin(), Ops.end(), O);
3190   SCEV *S = new (SCEVAllocator) SCEVUMaxExpr(ID.Intern(SCEVAllocator),
3191                                              O, Ops.size());
3192   UniqueSCEVs.InsertNode(S, IP);
3193   return S;
3194 }
3195
3196 const SCEV *ScalarEvolution::getSMinExpr(const SCEV *LHS,
3197                                          const SCEV *RHS) {
3198   // ~smax(~x, ~y) == smin(x, y).
3199   return getNotSCEV(getSMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
3200 }
3201
3202 const SCEV *ScalarEvolution::getUMinExpr(const SCEV *LHS,
3203                                          const SCEV *RHS) {
3204   // ~umax(~x, ~y) == umin(x, y)
3205   return getNotSCEV(getUMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
3206 }
3207
3208 const SCEV *ScalarEvolution::getSizeOfExpr(Type *IntTy, Type *AllocTy) {
3209   // We can bypass creating a target-independent
3210   // constant expression and then folding it back into a ConstantInt.
3211   // This is just a compile-time optimization.
3212   return getConstant(IntTy, getDataLayout().getTypeAllocSize(AllocTy));
3213 }
3214
3215 const SCEV *ScalarEvolution::getOffsetOfExpr(Type *IntTy,
3216                                              StructType *STy,
3217                                              unsigned FieldNo) {
3218   // We can bypass creating a target-independent
3219   // constant expression and then folding it back into a ConstantInt.
3220   // This is just a compile-time optimization.
3221   return getConstant(
3222       IntTy, getDataLayout().getStructLayout(STy)->getElementOffset(FieldNo));
3223 }
3224
3225 const SCEV *ScalarEvolution::getUnknown(Value *V) {
3226   // Don't attempt to do anything other than create a SCEVUnknown object
3227   // here.  createSCEV only calls getUnknown after checking for all other
3228   // interesting possibilities, and any other code that calls getUnknown
3229   // is doing so in order to hide a value from SCEV canonicalization.
3230
3231   FoldingSetNodeID ID;
3232   ID.AddInteger(scUnknown);
3233   ID.AddPointer(V);
3234   void *IP = nullptr;
3235   if (SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) {
3236     assert(cast<SCEVUnknown>(S)->getValue() == V &&
3237            "Stale SCEVUnknown in uniquing map!");
3238     return S;
3239   }
3240   SCEV *S = new (SCEVAllocator) SCEVUnknown(ID.Intern(SCEVAllocator), V, this,
3241                                             FirstUnknown);
3242   FirstUnknown = cast<SCEVUnknown>(S);
3243   UniqueSCEVs.InsertNode(S, IP);
3244   return S;
3245 }
3246
3247 //===----------------------------------------------------------------------===//
3248 //            Basic SCEV Analysis and PHI Idiom Recognition Code
3249 //
3250
3251 /// isSCEVable - Test if values of the given type are analyzable within
3252 /// the SCEV framework. This primarily includes integer types, and it
3253 /// can optionally include pointer types if the ScalarEvolution class
3254 /// has access to target-specific information.
3255 bool ScalarEvolution::isSCEVable(Type *Ty) const {
3256   // Integers and pointers are always SCEVable.
3257   return Ty->isIntegerTy() || Ty->isPointerTy();
3258 }
3259
3260 /// getTypeSizeInBits - Return the size in bits of the specified type,
3261 /// for which isSCEVable must return true.
3262 uint64_t ScalarEvolution::getTypeSizeInBits(Type *Ty) const {
3263   assert(isSCEVable(Ty) && "Type is not SCEVable!");
3264   return getDataLayout().getTypeSizeInBits(Ty);
3265 }
3266
3267 /// getEffectiveSCEVType - Return a type with the same bitwidth as
3268 /// the given type and which represents how SCEV will treat the given
3269 /// type, for which isSCEVable must return true. For pointer types,
3270 /// this is the pointer-sized integer type.
3271 Type *ScalarEvolution::getEffectiveSCEVType(Type *Ty) const {
3272   assert(isSCEVable(Ty) && "Type is not SCEVable!");
3273
3274   if (Ty->isIntegerTy())
3275     return Ty;
3276
3277   // The only other support type is pointer.
3278   assert(Ty->isPointerTy() && "Unexpected non-pointer non-integer type!");
3279   return getDataLayout().getIntPtrType(Ty);
3280 }
3281
3282 const SCEV *ScalarEvolution::getCouldNotCompute() {
3283   return CouldNotCompute.get();
3284 }
3285
3286
3287 bool ScalarEvolution::checkValidity(const SCEV *S) const {
3288   // Helper class working with SCEVTraversal to figure out if a SCEV contains
3289   // a SCEVUnknown with null value-pointer. FindInvalidSCEVUnknown::FindOne
3290   // is set iff if find such SCEVUnknown.
3291   //
3292   struct FindInvalidSCEVUnknown {
3293     bool FindOne;
3294     FindInvalidSCEVUnknown() { FindOne = false; }
3295     bool follow(const SCEV *S) {
3296       switch (static_cast<SCEVTypes>(S->getSCEVType())) {
3297       case scConstant:
3298         return false;
3299       case scUnknown:
3300         if (!cast<SCEVUnknown>(S)->getValue())
3301           FindOne = true;
3302         return false;
3303       default:
3304         return true;
3305       }
3306     }
3307     bool isDone() const { return FindOne; }
3308   };
3309
3310   FindInvalidSCEVUnknown F;
3311   SCEVTraversal<FindInvalidSCEVUnknown> ST(F);
3312   ST.visitAll(S);
3313
3314   return !F.FindOne;
3315 }
3316
3317 /// getSCEV - Return an existing SCEV if it exists, otherwise analyze the
3318 /// expression and create a new one.
3319 const SCEV *ScalarEvolution::getSCEV(Value *V) {
3320   assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
3321
3322   const SCEV *S = getExistingSCEV(V);
3323   if (S == nullptr) {
3324     S = createSCEV(V);
3325     ValueExprMap.insert(std::make_pair(SCEVCallbackVH(V, this), S));
3326   }
3327   return S;
3328 }
3329
3330 const SCEV *ScalarEvolution::getExistingSCEV(Value *V) {
3331   assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
3332
3333   ValueExprMapType::iterator I = ValueExprMap.find_as(V);
3334   if (I != ValueExprMap.end()) {
3335     const SCEV *S = I->second;
3336     if (checkValidity(S))
3337       return S;
3338     ValueExprMap.erase(I);
3339   }
3340   return nullptr;
3341 }
3342
3343 /// getNegativeSCEV - Return a SCEV corresponding to -V = -1*V
3344 ///
3345 const SCEV *ScalarEvolution::getNegativeSCEV(const SCEV *V,
3346                                              SCEV::NoWrapFlags Flags) {
3347   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
3348     return getConstant(
3349                cast<ConstantInt>(ConstantExpr::getNeg(VC->getValue())));
3350
3351   Type *Ty = V->getType();
3352   Ty = getEffectiveSCEVType(Ty);
3353   return getMulExpr(
3354       V, getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty))), Flags);
3355 }
3356
3357 /// getNotSCEV - Return a SCEV corresponding to ~V = -1-V
3358 const SCEV *ScalarEvolution::getNotSCEV(const SCEV *V) {
3359   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
3360     return getConstant(
3361                 cast<ConstantInt>(ConstantExpr: