blob: 9aaafafe052342a5b09a265b2cb8eeb72a8227b5 [file] [log] [blame]
Chris Lattner53e677a2004-04-02 20:23:17 +00001//===- ScalarEvolution.cpp - Scalar Evolution Analysis ----------*- C++ -*-===//
Misha Brukman2b37d7c2005-04-21 21:13:18 +00002//
Chris Lattner53e677a2004-04-02 20:23:17 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman2b37d7c2005-04-21 21:13:18 +00007//
Chris Lattner53e677a2004-04-02 20:23:17 +00008//===----------------------------------------------------------------------===//
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
Dan Gohmanbc3d77a2009-07-25 16:18:07 +000017// can handle. We only create one SCEV of a particular shape, so
18// pointer-comparisons for equality are legal.
Chris Lattner53e677a2004-04-02 20:23:17 +000019//
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.
Misha Brukman2b37d7c2005-04-21 21:13:18 +000030//
Chris Lattner53e677a2004-04-02 20:23:17 +000031// 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//
Chris Lattner53e677a2004-04-02 20:23:17 +000035// 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
Chris Lattner3b27d682006-12-19 22:30:33 +000061#define DEBUG_TYPE "scalar-evolution"
Chris Lattner0a7f98c2004-04-15 15:07:24 +000062#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Chris Lattner53e677a2004-04-02 20:23:17 +000063#include "llvm/Constants.h"
64#include "llvm/DerivedTypes.h"
Chris Lattner673e02b2004-10-12 01:49:27 +000065#include "llvm/GlobalVariable.h"
Dan Gohman26812322009-08-25 17:49:57 +000066#include "llvm/GlobalAlias.h"
Chris Lattner53e677a2004-04-02 20:23:17 +000067#include "llvm/Instructions.h"
Owen Anderson76f600b2009-07-06 22:37:39 +000068#include "llvm/LLVMContext.h"
Dan Gohmanca178902009-07-17 20:47:02 +000069#include "llvm/Operator.h"
John Criswella1156432005-10-27 15:54:34 +000070#include "llvm/Analysis/ConstantFolding.h"
Evan Cheng5a6c1a82009-02-17 00:13:06 +000071#include "llvm/Analysis/Dominators.h"
Chris Lattner53e677a2004-04-02 20:23:17 +000072#include "llvm/Analysis/LoopInfo.h"
Dan Gohman61ffa8e2009-06-16 19:52:01 +000073#include "llvm/Analysis/ValueTracking.h"
Chris Lattner53e677a2004-04-02 20:23:17 +000074#include "llvm/Assembly/Writer.h"
Dan Gohman2d1be872009-04-16 03:18:22 +000075#include "llvm/Target/TargetData.h"
Chris Lattner95255282006-06-28 23:17:24 +000076#include "llvm/Support/CommandLine.h"
Chris Lattner53e677a2004-04-02 20:23:17 +000077#include "llvm/Support/ConstantRange.h"
David Greene63c94632009-12-23 22:58:38 +000078#include "llvm/Support/Debug.h"
Torok Edwinc25e7582009-07-11 20:10:48 +000079#include "llvm/Support/ErrorHandling.h"
Dan Gohman2d1be872009-04-16 03:18:22 +000080#include "llvm/Support/GetElementPtrTypeIterator.h"
Chris Lattner53e677a2004-04-02 20:23:17 +000081#include "llvm/Support/InstIterator.h"
Chris Lattner75de5ab2006-12-19 01:16:02 +000082#include "llvm/Support/MathExtras.h"
Dan Gohmanb7ef7292009-04-21 00:47:46 +000083#include "llvm/Support/raw_ostream.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000084#include "llvm/ADT/Statistic.h"
Dan Gohman2d1be872009-04-16 03:18:22 +000085#include "llvm/ADT/STLExtras.h"
Dan Gohman59ae6b92009-07-08 19:23:34 +000086#include "llvm/ADT/SmallPtrSet.h"
Alkis Evlogimenos20aa4742004-09-03 18:19:51 +000087#include <algorithm>
Chris Lattner53e677a2004-04-02 20:23:17 +000088using namespace llvm;
89
Chris Lattner3b27d682006-12-19 22:30:33 +000090STATISTIC(NumArrayLenItCounts,
91 "Number of trip counts computed with array length");
92STATISTIC(NumTripCountsComputed,
93 "Number of loops with predictable loop counts");
94STATISTIC(NumTripCountsNotComputed,
95 "Number of loops without predictable loop counts");
96STATISTIC(NumBruteForceTripCountsComputed,
97 "Number of loops with trip counts computed by force");
98
Dan Gohman844731a2008-05-13 00:00:25 +000099static cl::opt<unsigned>
Chris Lattner3b27d682006-12-19 22:30:33 +0000100MaxBruteForceIterations("scalar-evolution-max-iterations", cl::ReallyHidden,
101 cl::desc("Maximum number of iterations SCEV will "
Dan Gohman64a845e2009-06-24 04:48:43 +0000102 "symbolically execute a constant "
103 "derived loop"),
Chris Lattner3b27d682006-12-19 22:30:33 +0000104 cl::init(100));
105
Owen Andersond13db2c2010-07-21 22:09:45 +0000106INITIALIZE_PASS(ScalarEvolution, "scalar-evolution",
107 "Scalar Evolution Analysis", false, true);
Devang Patel19974732007-05-03 01:11:54 +0000108char ScalarEvolution::ID = 0;
Chris Lattner53e677a2004-04-02 20:23:17 +0000109
110//===----------------------------------------------------------------------===//
111// SCEV class definitions
112//===----------------------------------------------------------------------===//
113
114//===----------------------------------------------------------------------===//
115// Implementation of the SCEV class.
116//
Dan Gohmanc39f44b2009-06-30 20:13:32 +0000117
Chris Lattner53e677a2004-04-02 20:23:17 +0000118SCEV::~SCEV() {}
Dan Gohmanc39f44b2009-06-30 20:13:32 +0000119
Chris Lattner53e677a2004-04-02 20:23:17 +0000120void SCEV::dump() const {
David Greene25e0e872009-12-23 22:18:14 +0000121 print(dbgs());
122 dbgs() << '\n';
Dan Gohmanb7ef7292009-04-21 00:47:46 +0000123}
124
Dan Gohmancfeb6a42008-06-18 16:23:07 +0000125bool SCEV::isZero() const {
126 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
127 return SC->getValue()->isZero();
128 return false;
129}
130
Dan Gohman70a1fe72009-05-18 15:22:39 +0000131bool SCEV::isOne() const {
132 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
133 return SC->getValue()->isOne();
134 return false;
135}
Chris Lattner53e677a2004-04-02 20:23:17 +0000136
Dan Gohman4d289bf2009-06-24 00:30:26 +0000137bool SCEV::isAllOnesValue() const {
138 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
139 return SC->getValue()->isAllOnesValue();
140 return false;
141}
142
Owen Anderson753ad612009-06-22 21:57:23 +0000143SCEVCouldNotCompute::SCEVCouldNotCompute() :
Dan Gohman3bf63762010-06-18 19:54:20 +0000144 SCEV(FoldingSetNodeIDRef(), scCouldNotCompute) {}
Dan Gohman1c343752009-06-27 21:21:31 +0000145
Chris Lattner53e677a2004-04-02 20:23:17 +0000146bool SCEVCouldNotCompute::isLoopInvariant(const Loop *L) const {
Torok Edwinc23197a2009-07-14 16:55:14 +0000147 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
Misha Brukmanbb2aff12004-04-05 19:00:46 +0000148 return false;
Chris Lattner53e677a2004-04-02 20:23:17 +0000149}
150
151const Type *SCEVCouldNotCompute::getType() const {
Torok Edwinc23197a2009-07-14 16:55:14 +0000152 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
Misha Brukmanbb2aff12004-04-05 19:00:46 +0000153 return 0;
Chris Lattner53e677a2004-04-02 20:23:17 +0000154}
155
156bool SCEVCouldNotCompute::hasComputableLoopEvolution(const Loop *L) const {
Torok Edwinc23197a2009-07-14 16:55:14 +0000157 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
Chris Lattner53e677a2004-04-02 20:23:17 +0000158 return false;
159}
160
Dan Gohmanfef8bb22009-07-25 01:13:03 +0000161bool SCEVCouldNotCompute::hasOperand(const SCEV *) const {
162 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
163 return false;
Chris Lattner4dc534c2005-02-13 04:37:18 +0000164}
165
Dan Gohmanb7ef7292009-04-21 00:47:46 +0000166void SCEVCouldNotCompute::print(raw_ostream &OS) const {
Chris Lattner53e677a2004-04-02 20:23:17 +0000167 OS << "***COULDNOTCOMPUTE***";
168}
169
170bool SCEVCouldNotCompute::classof(const SCEV *S) {
171 return S->getSCEVType() == scCouldNotCompute;
172}
173
Dan Gohman0bba49c2009-07-07 17:06:11 +0000174const SCEV *ScalarEvolution::getConstant(ConstantInt *V) {
Dan Gohman1c343752009-06-27 21:21:31 +0000175 FoldingSetNodeID ID;
176 ID.AddInteger(scConstant);
177 ID.AddPointer(V);
178 void *IP = 0;
179 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
Dan Gohman3bf63762010-06-18 19:54:20 +0000180 SCEV *S = new (SCEVAllocator) SCEVConstant(ID.Intern(SCEVAllocator), V);
Dan Gohman1c343752009-06-27 21:21:31 +0000181 UniqueSCEVs.InsertNode(S, IP);
182 return S;
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000183}
Chris Lattner53e677a2004-04-02 20:23:17 +0000184
Dan Gohman0bba49c2009-07-07 17:06:11 +0000185const SCEV *ScalarEvolution::getConstant(const APInt& Val) {
Owen Andersoneed707b2009-07-24 23:12:02 +0000186 return getConstant(ConstantInt::get(getContext(), Val));
Dan Gohman9a6ae962007-07-09 15:25:17 +0000187}
188
Dan Gohman0bba49c2009-07-07 17:06:11 +0000189const SCEV *
Dan Gohman6de29f82009-06-15 22:12:54 +0000190ScalarEvolution::getConstant(const Type *Ty, uint64_t V, bool isSigned) {
Dan Gohmana560fd22010-04-21 16:04:04 +0000191 const IntegerType *ITy = cast<IntegerType>(getEffectiveSCEVType(Ty));
192 return getConstant(ConstantInt::get(ITy, V, isSigned));
Dan Gohman6de29f82009-06-15 22:12:54 +0000193}
194
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000195const Type *SCEVConstant::getType() const { return V->getType(); }
Chris Lattner53e677a2004-04-02 20:23:17 +0000196
Dan Gohmanb7ef7292009-04-21 00:47:46 +0000197void SCEVConstant::print(raw_ostream &OS) const {
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000198 WriteAsOperand(OS, V, false);
199}
Chris Lattner53e677a2004-04-02 20:23:17 +0000200
Dan Gohman3bf63762010-06-18 19:54:20 +0000201SCEVCastExpr::SCEVCastExpr(const FoldingSetNodeIDRef ID,
Dan Gohmanc050fd92009-07-13 20:50:19 +0000202 unsigned SCEVTy, const SCEV *op, const Type *ty)
Dan Gohman3bf63762010-06-18 19:54:20 +0000203 : SCEV(ID, SCEVTy), Op(op), Ty(ty) {}
Dan Gohman1c343752009-06-27 21:21:31 +0000204
Dan Gohman84923602009-04-21 01:25:57 +0000205bool SCEVCastExpr::dominates(BasicBlock *BB, DominatorTree *DT) const {
206 return Op->dominates(BB, DT);
207}
208
Dan Gohman6e70e312009-09-27 15:26:03 +0000209bool SCEVCastExpr::properlyDominates(BasicBlock *BB, DominatorTree *DT) const {
210 return Op->properlyDominates(BB, DT);
211}
212
Dan Gohman3bf63762010-06-18 19:54:20 +0000213SCEVTruncateExpr::SCEVTruncateExpr(const FoldingSetNodeIDRef ID,
Dan Gohmanc050fd92009-07-13 20:50:19 +0000214 const SCEV *op, const Type *ty)
Dan Gohman3bf63762010-06-18 19:54:20 +0000215 : SCEVCastExpr(ID, scTruncate, op, ty) {
Duncan Sands1df98592010-02-16 11:11:14 +0000216 assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
217 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000218 "Cannot truncate non-integer value!");
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000219}
Chris Lattner53e677a2004-04-02 20:23:17 +0000220
Dan Gohmanb7ef7292009-04-21 00:47:46 +0000221void SCEVTruncateExpr::print(raw_ostream &OS) const {
Dan Gohman36b8e532009-04-29 20:27:52 +0000222 OS << "(trunc " << *Op->getType() << " " << *Op << " to " << *Ty << ")";
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000223}
224
Dan Gohman3bf63762010-06-18 19:54:20 +0000225SCEVZeroExtendExpr::SCEVZeroExtendExpr(const FoldingSetNodeIDRef ID,
Dan Gohmanc050fd92009-07-13 20:50:19 +0000226 const SCEV *op, const Type *ty)
Dan Gohman3bf63762010-06-18 19:54:20 +0000227 : SCEVCastExpr(ID, scZeroExtend, op, ty) {
Duncan Sands1df98592010-02-16 11:11:14 +0000228 assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
229 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000230 "Cannot zero extend non-integer value!");
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000231}
232
Dan Gohmanb7ef7292009-04-21 00:47:46 +0000233void SCEVZeroExtendExpr::print(raw_ostream &OS) const {
Dan Gohman36b8e532009-04-29 20:27:52 +0000234 OS << "(zext " << *Op->getType() << " " << *Op << " to " << *Ty << ")";
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000235}
236
Dan Gohman3bf63762010-06-18 19:54:20 +0000237SCEVSignExtendExpr::SCEVSignExtendExpr(const FoldingSetNodeIDRef ID,
Dan Gohmanc050fd92009-07-13 20:50:19 +0000238 const SCEV *op, const Type *ty)
Dan Gohman3bf63762010-06-18 19:54:20 +0000239 : SCEVCastExpr(ID, scSignExtend, op, ty) {
Duncan Sands1df98592010-02-16 11:11:14 +0000240 assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
241 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Dan Gohmand19534a2007-06-15 14:38:12 +0000242 "Cannot sign extend non-integer value!");
Dan Gohmand19534a2007-06-15 14:38:12 +0000243}
244
Dan Gohmanb7ef7292009-04-21 00:47:46 +0000245void SCEVSignExtendExpr::print(raw_ostream &OS) const {
Dan Gohman36b8e532009-04-29 20:27:52 +0000246 OS << "(sext " << *Op->getType() << " " << *Op << " to " << *Ty << ")";
Dan Gohmand19534a2007-06-15 14:38:12 +0000247}
248
Dan Gohmanb7ef7292009-04-21 00:47:46 +0000249void SCEVCommutativeExpr::print(raw_ostream &OS) const {
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000250 const char *OpStr = getOperationStr();
Dan Gohmana5145c82010-04-16 15:03:25 +0000251 OS << "(";
252 for (op_iterator I = op_begin(), E = op_end(); I != E; ++I) {
253 OS << **I;
Oscar Fuentesee56c422010-08-02 06:00:15 +0000254 if (llvm::next(I) != E)
Dan Gohmana5145c82010-04-16 15:03:25 +0000255 OS << OpStr;
256 }
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000257 OS << ")";
258}
259
Dan Gohmanecb403a2009-05-07 14:00:19 +0000260bool SCEVNAryExpr::dominates(BasicBlock *BB, DominatorTree *DT) const {
Evan Cheng5a6c1a82009-02-17 00:13:06 +0000261 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
262 if (!getOperand(i)->dominates(BB, DT))
263 return false;
264 }
265 return true;
266}
267
Dan Gohman6e70e312009-09-27 15:26:03 +0000268bool SCEVNAryExpr::properlyDominates(BasicBlock *BB, DominatorTree *DT) const {
269 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
270 if (!getOperand(i)->properlyDominates(BB, DT))
271 return false;
272 }
273 return true;
274}
275
Evan Cheng5a6c1a82009-02-17 00:13:06 +0000276bool SCEVUDivExpr::dominates(BasicBlock *BB, DominatorTree *DT) const {
277 return LHS->dominates(BB, DT) && RHS->dominates(BB, DT);
278}
279
Dan Gohman6e70e312009-09-27 15:26:03 +0000280bool SCEVUDivExpr::properlyDominates(BasicBlock *BB, DominatorTree *DT) const {
281 return LHS->properlyDominates(BB, DT) && RHS->properlyDominates(BB, DT);
282}
283
Dan Gohmanb7ef7292009-04-21 00:47:46 +0000284void SCEVUDivExpr::print(raw_ostream &OS) const {
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000285 OS << "(" << *LHS << " /u " << *RHS << ")";
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000286}
287
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000288const Type *SCEVUDivExpr::getType() const {
Dan Gohman91bb61a2009-05-26 17:44:05 +0000289 // In most cases the types of LHS and RHS will be the same, but in some
290 // crazy cases one or the other may be a pointer. ScalarEvolution doesn't
291 // depend on the type for correctness, but handling types carefully can
292 // avoid extra casts in the SCEVExpander. The LHS is more likely to be
293 // a pointer type than the RHS, so use the RHS' type here.
294 return RHS->getType();
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000295}
296
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000297bool SCEVAddRecExpr::isLoopInvariant(const Loop *QueryLoop) const {
Dan Gohmana3035a62009-05-20 01:01:24 +0000298 // Add recurrences are never invariant in the function-body (null loop).
Dan Gohmane890eea2009-06-26 22:17:21 +0000299 if (!QueryLoop)
300 return false;
301
302 // This recurrence is variant w.r.t. QueryLoop if QueryLoop contains L.
Dan Gohman92329c72009-12-18 01:24:09 +0000303 if (QueryLoop->contains(L))
Dan Gohmane890eea2009-06-26 22:17:21 +0000304 return false;
305
306 // This recurrence is variant w.r.t. QueryLoop if any of its operands
307 // are variant.
308 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
309 if (!getOperand(i)->isLoopInvariant(QueryLoop))
310 return false;
311
312 // Otherwise it's loop-invariant.
313 return true;
Chris Lattner53e677a2004-04-02 20:23:17 +0000314}
315
Dan Gohman39125d82010-02-13 00:19:39 +0000316bool
317SCEVAddRecExpr::dominates(BasicBlock *BB, DominatorTree *DT) const {
318 return DT->dominates(L->getHeader(), BB) &&
319 SCEVNAryExpr::dominates(BB, DT);
320}
321
322bool
323SCEVAddRecExpr::properlyDominates(BasicBlock *BB, DominatorTree *DT) const {
324 // This uses a "dominates" query instead of "properly dominates" query because
325 // the instruction which produces the addrec's value is a PHI, and a PHI
326 // effectively properly dominates its entire containing block.
327 return DT->dominates(L->getHeader(), BB) &&
328 SCEVNAryExpr::properlyDominates(BB, DT);
329}
330
Dan Gohmanb7ef7292009-04-21 00:47:46 +0000331void SCEVAddRecExpr::print(raw_ostream &OS) const {
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000332 OS << "{" << *Operands[0];
Dan Gohmanf9e64722010-03-18 01:17:13 +0000333 for (unsigned i = 1, e = NumOperands; i != e; ++i)
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000334 OS << ",+," << *Operands[i];
Dan Gohman30733292010-01-09 18:17:45 +0000335 OS << "}<";
336 WriteAsOperand(OS, L->getHeader(), /*PrintType=*/false);
337 OS << ">";
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000338}
Chris Lattner53e677a2004-04-02 20:23:17 +0000339
Dan Gohmanab37f502010-08-02 23:49:30 +0000340void SCEVUnknown::deleted() {
341 // Clear this SCEVUnknown from ValuesAtScopes.
342 SE->ValuesAtScopes.erase(this);
343
344 // Remove this SCEVUnknown from the uniquing map.
345 SE->UniqueSCEVs.RemoveNode(this);
346
347 // Release the value.
348 setValPtr(0);
349}
350
351void SCEVUnknown::allUsesReplacedWith(Value *New) {
352 // Clear this SCEVUnknown from ValuesAtScopes.
353 SE->ValuesAtScopes.erase(this);
354
355 // Remove this SCEVUnknown from the uniquing map.
356 SE->UniqueSCEVs.RemoveNode(this);
357
358 // Update this SCEVUnknown to point to the new value. This is needed
359 // because there may still be outstanding SCEVs which still point to
360 // this SCEVUnknown.
361 setValPtr(New);
362}
363
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000364bool SCEVUnknown::isLoopInvariant(const Loop *L) const {
365 // All non-instruction values are loop invariant. All instructions are loop
366 // invariant if they are not contained in the specified loop.
Dan Gohmana3035a62009-05-20 01:01:24 +0000367 // Instructions are never considered invariant in the function body
368 // (null loop) because they are defined within the "loop".
Dan Gohmanab37f502010-08-02 23:49:30 +0000369 if (Instruction *I = dyn_cast<Instruction>(getValue()))
Dan Gohman92329c72009-12-18 01:24:09 +0000370 return L && !L->contains(I);
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000371 return true;
372}
Chris Lattner53e677a2004-04-02 20:23:17 +0000373
Evan Cheng5a6c1a82009-02-17 00:13:06 +0000374bool SCEVUnknown::dominates(BasicBlock *BB, DominatorTree *DT) const {
375 if (Instruction *I = dyn_cast<Instruction>(getValue()))
376 return DT->dominates(I->getParent(), BB);
377 return true;
378}
379
Dan Gohman6e70e312009-09-27 15:26:03 +0000380bool SCEVUnknown::properlyDominates(BasicBlock *BB, DominatorTree *DT) const {
381 if (Instruction *I = dyn_cast<Instruction>(getValue()))
382 return DT->properlyDominates(I->getParent(), BB);
383 return true;
384}
385
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000386const Type *SCEVUnknown::getType() const {
Dan Gohmanab37f502010-08-02 23:49:30 +0000387 return getValue()->getType();
Chris Lattner0a7f98c2004-04-15 15:07:24 +0000388}
Chris Lattner53e677a2004-04-02 20:23:17 +0000389
Dan Gohman0f5efe52010-01-28 02:15:55 +0000390bool SCEVUnknown::isSizeOf(const Type *&AllocTy) const {
Dan Gohmanab37f502010-08-02 23:49:30 +0000391 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
Dan Gohman0f5efe52010-01-28 02:15:55 +0000392 if (VCE->getOpcode() == Instruction::PtrToInt)
393 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
Dan Gohman8db08df2010-02-02 01:38:49 +0000394 if (CE->getOpcode() == Instruction::GetElementPtr &&
395 CE->getOperand(0)->isNullValue() &&
396 CE->getNumOperands() == 2)
397 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(1)))
398 if (CI->isOne()) {
399 AllocTy = cast<PointerType>(CE->getOperand(0)->getType())
400 ->getElementType();
401 return true;
402 }
Dan Gohman0f5efe52010-01-28 02:15:55 +0000403
404 return false;
405}
406
407bool SCEVUnknown::isAlignOf(const Type *&AllocTy) const {
Dan Gohmanab37f502010-08-02 23:49:30 +0000408 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
Dan Gohman0f5efe52010-01-28 02:15:55 +0000409 if (VCE->getOpcode() == Instruction::PtrToInt)
410 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
Dan Gohman8db08df2010-02-02 01:38:49 +0000411 if (CE->getOpcode() == Instruction::GetElementPtr &&
412 CE->getOperand(0)->isNullValue()) {
413 const Type *Ty =
414 cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
415 if (const StructType *STy = dyn_cast<StructType>(Ty))
416 if (!STy->isPacked() &&
417 CE->getNumOperands() == 3 &&
418 CE->getOperand(1)->isNullValue()) {
419 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(2)))
420 if (CI->isOne() &&
421 STy->getNumElements() == 2 &&
Duncan Sandsb0bc6c32010-02-15 16:12:20 +0000422 STy->getElementType(0)->isIntegerTy(1)) {
Dan Gohman8db08df2010-02-02 01:38:49 +0000423 AllocTy = STy->getElementType(1);
424 return true;
425 }
426 }
427 }
Dan Gohman0f5efe52010-01-28 02:15:55 +0000428
429 return false;
430}
431
Dan Gohman4f8eea82010-02-01 18:27:38 +0000432bool SCEVUnknown::isOffsetOf(const Type *&CTy, Constant *&FieldNo) const {
Dan Gohmanab37f502010-08-02 23:49:30 +0000433 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
Dan Gohman4f8eea82010-02-01 18:27:38 +0000434 if (VCE->getOpcode() == Instruction::PtrToInt)
435 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
436 if (CE->getOpcode() == Instruction::GetElementPtr &&
437 CE->getNumOperands() == 3 &&
438 CE->getOperand(0)->isNullValue() &&
439 CE->getOperand(1)->isNullValue()) {
440 const Type *Ty =
441 cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
442 // Ignore vector types here so that ScalarEvolutionExpander doesn't
443 // emit getelementptrs that index into vectors.
Duncan Sands1df98592010-02-16 11:11:14 +0000444 if (Ty->isStructTy() || Ty->isArrayTy()) {
Dan Gohman4f8eea82010-02-01 18:27:38 +0000445 CTy = Ty;
446 FieldNo = CE->getOperand(2);
447 return true;
448 }
449 }
450
451 return false;
452}
453
Dan Gohmanb7ef7292009-04-21 00:47:46 +0000454void SCEVUnknown::print(raw_ostream &OS) const {
Dan Gohman0f5efe52010-01-28 02:15:55 +0000455 const Type *AllocTy;
456 if (isSizeOf(AllocTy)) {
457 OS << "sizeof(" << *AllocTy << ")";
458 return;
459 }
460 if (isAlignOf(AllocTy)) {
461 OS << "alignof(" << *AllocTy << ")";
462 return;
463 }
464
Dan Gohman4f8eea82010-02-01 18:27:38 +0000465 const Type *CTy;
Dan Gohman0f5efe52010-01-28 02:15:55 +0000466 Constant *FieldNo;
Dan Gohman4f8eea82010-02-01 18:27:38 +0000467 if (isOffsetOf(CTy, FieldNo)) {
468 OS << "offsetof(" << *CTy << ", ";
Dan Gohman0f5efe52010-01-28 02:15:55 +0000469 WriteAsOperand(OS, FieldNo, false);
470 OS << ")";
471 return;
472 }
473
474 // Otherwise just print it normally.
Dan Gohmanab37f502010-08-02 23:49:30 +0000475 WriteAsOperand(OS, getValue(), false);
Chris Lattner53e677a2004-04-02 20:23:17 +0000476}
477
Chris Lattner8d741b82004-06-20 06:23:15 +0000478//===----------------------------------------------------------------------===//
479// SCEV Utilities
480//===----------------------------------------------------------------------===//
481
Dan Gohmanc40f17b2009-08-18 16:46:41 +0000482static bool CompareTypes(const Type *A, const Type *B) {
483 if (A->getTypeID() != B->getTypeID())
484 return A->getTypeID() < B->getTypeID();
485 if (const IntegerType *AI = dyn_cast<IntegerType>(A)) {
486 const IntegerType *BI = cast<IntegerType>(B);
487 return AI->getBitWidth() < BI->getBitWidth();
488 }
489 if (const PointerType *AI = dyn_cast<PointerType>(A)) {
490 const PointerType *BI = cast<PointerType>(B);
491 return CompareTypes(AI->getElementType(), BI->getElementType());
492 }
493 if (const ArrayType *AI = dyn_cast<ArrayType>(A)) {
494 const ArrayType *BI = cast<ArrayType>(B);
495 if (AI->getNumElements() != BI->getNumElements())
496 return AI->getNumElements() < BI->getNumElements();
497 return CompareTypes(AI->getElementType(), BI->getElementType());
498 }
499 if (const VectorType *AI = dyn_cast<VectorType>(A)) {
500 const VectorType *BI = cast<VectorType>(B);
501 if (AI->getNumElements() != BI->getNumElements())
502 return AI->getNumElements() < BI->getNumElements();
503 return CompareTypes(AI->getElementType(), BI->getElementType());
504 }
505 if (const StructType *AI = dyn_cast<StructType>(A)) {
506 const StructType *BI = cast<StructType>(B);
507 if (AI->getNumElements() != BI->getNumElements())
508 return AI->getNumElements() < BI->getNumElements();
509 for (unsigned i = 0, e = AI->getNumElements(); i != e; ++i)
510 if (CompareTypes(AI->getElementType(i), BI->getElementType(i)) ||
511 CompareTypes(BI->getElementType(i), AI->getElementType(i)))
512 return CompareTypes(AI->getElementType(i), BI->getElementType(i));
513 }
514 return false;
515}
516
Chris Lattner8d741b82004-06-20 06:23:15 +0000517namespace {
518 /// SCEVComplexityCompare - Return true if the complexity of the LHS is less
519 /// than the complexity of the RHS. This comparator is used to canonicalize
520 /// expressions.
Nick Lewycky6726b6d2009-10-25 06:33:48 +0000521 class SCEVComplexityCompare {
Dan Gohmane72079a2010-07-23 21:18:55 +0000522 const LoopInfo *LI;
Dan Gohman72861302009-05-07 14:39:04 +0000523 public:
Dan Gohmane72079a2010-07-23 21:18:55 +0000524 explicit SCEVComplexityCompare(const LoopInfo *li) : LI(li) {}
Dan Gohman72861302009-05-07 14:39:04 +0000525
Dan Gohmanf7b37b22008-04-14 18:23:56 +0000526 bool operator()(const SCEV *LHS, const SCEV *RHS) const {
Dan Gohman42214892009-08-31 21:15:23 +0000527 // Fast-path: SCEVs are uniqued so we can do a quick equality check.
528 if (LHS == RHS)
529 return false;
530
Dan Gohman72861302009-05-07 14:39:04 +0000531 // Primarily, sort the SCEVs by their getSCEVType().
Dan Gohman304a7a62010-07-23 21:20:52 +0000532 unsigned LType = LHS->getSCEVType(), RType = RHS->getSCEVType();
533 if (LType != RType)
534 return LType < RType;
Dan Gohman72861302009-05-07 14:39:04 +0000535
Dan Gohman3bf63762010-06-18 19:54:20 +0000536 // Aside from the getSCEVType() ordering, the particular ordering
537 // isn't very important except that it's beneficial to be consistent,
538 // so that (a + b) and (b + a) don't end up as different expressions.
539
540 // Sort SCEVUnknown values with some loose heuristics. TODO: This is
541 // not as complete as it could be.
542 if (const SCEVUnknown *LU = dyn_cast<SCEVUnknown>(LHS)) {
543 const SCEVUnknown *RU = cast<SCEVUnknown>(RHS);
544
545 // Order pointer values after integer values. This helps SCEVExpander
546 // form GEPs.
Dan Gohman304a7a62010-07-23 21:20:52 +0000547 bool LIsPointer = LU->getType()->isPointerTy(),
548 RIsPointer = RU->getType()->isPointerTy();
549 if (LIsPointer != RIsPointer)
550 return RIsPointer;
Dan Gohman3bf63762010-06-18 19:54:20 +0000551
552 // Compare getValueID values.
Dan Gohman304a7a62010-07-23 21:20:52 +0000553 unsigned LID = LU->getValue()->getValueID(),
554 RID = RU->getValue()->getValueID();
555 if (LID != RID)
556 return LID < RID;
Dan Gohman3bf63762010-06-18 19:54:20 +0000557
558 // Sort arguments by their position.
559 if (const Argument *LA = dyn_cast<Argument>(LU->getValue())) {
560 const Argument *RA = cast<Argument>(RU->getValue());
561 return LA->getArgNo() < RA->getArgNo();
562 }
563
564 // For instructions, compare their loop depth, and their opcode.
565 // This is pretty loose.
Dan Gohman304a7a62010-07-23 21:20:52 +0000566 if (const Instruction *LV = dyn_cast<Instruction>(LU->getValue())) {
567 const Instruction *RV = cast<Instruction>(RU->getValue());
Dan Gohman3bf63762010-06-18 19:54:20 +0000568
569 // Compare loop depths.
Dan Gohman304a7a62010-07-23 21:20:52 +0000570 unsigned LDepth = LI->getLoopDepth(LV->getParent()),
571 RDepth = LI->getLoopDepth(RV->getParent());
572 if (LDepth != RDepth)
573 return LDepth < RDepth;
Dan Gohman3bf63762010-06-18 19:54:20 +0000574
575 // Compare the number of operands.
Dan Gohman304a7a62010-07-23 21:20:52 +0000576 unsigned LNumOps = LV->getNumOperands(),
577 RNumOps = RV->getNumOperands();
578 if (LNumOps != RNumOps)
579 return LNumOps < RNumOps;
Dan Gohman3bf63762010-06-18 19:54:20 +0000580 }
581
582 return false;
583 }
584
585 // Compare constant values.
586 if (const SCEVConstant *LC = dyn_cast<SCEVConstant>(LHS)) {
587 const SCEVConstant *RC = cast<SCEVConstant>(RHS);
Dan Gohman304a7a62010-07-23 21:20:52 +0000588 const ConstantInt *LCC = LC->getValue();
589 const ConstantInt *RCC = RC->getValue();
590 unsigned LBitWidth = LCC->getBitWidth(), RBitWidth = RCC->getBitWidth();
591 if (LBitWidth != RBitWidth)
592 return LBitWidth < RBitWidth;
593 return LCC->getValue().ult(RCC->getValue());
Dan Gohman3bf63762010-06-18 19:54:20 +0000594 }
595
596 // Compare addrec loop depths.
597 if (const SCEVAddRecExpr *LA = dyn_cast<SCEVAddRecExpr>(LHS)) {
598 const SCEVAddRecExpr *RA = cast<SCEVAddRecExpr>(RHS);
Dan Gohman304a7a62010-07-23 21:20:52 +0000599 unsigned LDepth = LA->getLoop()->getLoopDepth(),
600 RDepth = RA->getLoop()->getLoopDepth();
601 if (LDepth != RDepth)
602 return LDepth < RDepth;
Dan Gohman3bf63762010-06-18 19:54:20 +0000603 }
604
605 // Lexicographically compare n-ary expressions.
606 if (const SCEVNAryExpr *LC = dyn_cast<SCEVNAryExpr>(LHS)) {
607 const SCEVNAryExpr *RC = cast<SCEVNAryExpr>(RHS);
Dan Gohman304a7a62010-07-23 21:20:52 +0000608 unsigned LNumOps = LC->getNumOperands(), RNumOps = RC->getNumOperands();
609 for (unsigned i = 0; i != LNumOps; ++i) {
610 if (i >= RNumOps)
Dan Gohman3bf63762010-06-18 19:54:20 +0000611 return false;
Dan Gohman304a7a62010-07-23 21:20:52 +0000612 const SCEV *LOp = LC->getOperand(i), *ROp = RC->getOperand(i);
613 if (operator()(LOp, ROp))
Dan Gohman3bf63762010-06-18 19:54:20 +0000614 return true;
Dan Gohman304a7a62010-07-23 21:20:52 +0000615 if (operator()(ROp, LOp))
Dan Gohman3bf63762010-06-18 19:54:20 +0000616 return false;
617 }
Dan Gohman304a7a62010-07-23 21:20:52 +0000618 return LNumOps < RNumOps;
Dan Gohman3bf63762010-06-18 19:54:20 +0000619 }
620
621 // Lexicographically compare udiv expressions.
622 if (const SCEVUDivExpr *LC = dyn_cast<SCEVUDivExpr>(LHS)) {
623 const SCEVUDivExpr *RC = cast<SCEVUDivExpr>(RHS);
Dan Gohman304a7a62010-07-23 21:20:52 +0000624 const SCEV *LL = LC->getLHS(), *LR = LC->getRHS(),
625 *RL = RC->getLHS(), *RR = RC->getRHS();
626 if (operator()(LL, RL))
Dan Gohman3bf63762010-06-18 19:54:20 +0000627 return true;
Dan Gohman304a7a62010-07-23 21:20:52 +0000628 if (operator()(RL, LL))
Dan Gohman3bf63762010-06-18 19:54:20 +0000629 return false;
Dan Gohman304a7a62010-07-23 21:20:52 +0000630 if (operator()(LR, RR))
Dan Gohman3bf63762010-06-18 19:54:20 +0000631 return true;
Dan Gohman304a7a62010-07-23 21:20:52 +0000632 if (operator()(RR, LR))
Dan Gohman3bf63762010-06-18 19:54:20 +0000633 return false;
634 return false;
635 }
636
637 // Compare cast expressions by operand.
638 if (const SCEVCastExpr *LC = dyn_cast<SCEVCastExpr>(LHS)) {
639 const SCEVCastExpr *RC = cast<SCEVCastExpr>(RHS);
640 return operator()(LC->getOperand(), RC->getOperand());
641 }
642
643 llvm_unreachable("Unknown SCEV kind!");
644 return false;
Chris Lattner8d741b82004-06-20 06:23:15 +0000645 }
646 };
647}
648
649/// GroupByComplexity - Given a list of SCEV objects, order them by their
650/// complexity, and group objects of the same complexity together by value.
651/// When this routine is finished, we know that any duplicates in the vector are
652/// consecutive and that complexity is monotonically increasing.
653///
Dan Gohman3f46a3a2010-03-01 17:49:51 +0000654/// Note that we go take special precautions to ensure that we get deterministic
Chris Lattner8d741b82004-06-20 06:23:15 +0000655/// results from this routine. In other words, we don't want the results of
656/// this to depend on where the addresses of various SCEV objects happened to
657/// land in memory.
658///
Dan Gohman0bba49c2009-07-07 17:06:11 +0000659static void GroupByComplexity(SmallVectorImpl<const SCEV *> &Ops,
Dan Gohman72861302009-05-07 14:39:04 +0000660 LoopInfo *LI) {
Chris Lattner8d741b82004-06-20 06:23:15 +0000661 if (Ops.size() < 2) return; // Noop
662 if (Ops.size() == 2) {
663 // This is the common case, which also happens to be trivially simple.
664 // Special case it.
Dan Gohman3bf63762010-06-18 19:54:20 +0000665 if (SCEVComplexityCompare(LI)(Ops[1], Ops[0]))
Chris Lattner8d741b82004-06-20 06:23:15 +0000666 std::swap(Ops[0], Ops[1]);
667 return;
668 }
669
Dan Gohman3bf63762010-06-18 19:54:20 +0000670 // Do the rough sort by complexity.
671 std::stable_sort(Ops.begin(), Ops.end(), SCEVComplexityCompare(LI));
672
673 // Now that we are sorted by complexity, group elements of the same
674 // complexity. Note that this is, at worst, N^2, but the vector is likely to
675 // be extremely short in practice. Note that we take this approach because we
676 // do not want to depend on the addresses of the objects we are grouping.
677 for (unsigned i = 0, e = Ops.size(); i != e-2; ++i) {
678 const SCEV *S = Ops[i];
679 unsigned Complexity = S->getSCEVType();
680
681 // If there are any objects of the same complexity and same value as this
682 // one, group them.
683 for (unsigned j = i+1; j != e && Ops[j]->getSCEVType() == Complexity; ++j) {
684 if (Ops[j] == S) { // Found a duplicate.
685 // Move it to immediately after i'th element.
686 std::swap(Ops[i+1], Ops[j]);
687 ++i; // no need to rescan it.
688 if (i == e-2) return; // Done!
689 }
690 }
691 }
Chris Lattner8d741b82004-06-20 06:23:15 +0000692}
693
Chris Lattner53e677a2004-04-02 20:23:17 +0000694
Chris Lattner53e677a2004-04-02 20:23:17 +0000695
696//===----------------------------------------------------------------------===//
697// Simple SCEV method implementations
698//===----------------------------------------------------------------------===//
699
Eli Friedmanb42a6262008-08-04 23:49:06 +0000700/// BinomialCoefficient - Compute BC(It, K). The result has width W.
Dan Gohman6c0866c2009-05-24 23:45:28 +0000701/// Assume, K > 0.
Dan Gohman0bba49c2009-07-07 17:06:11 +0000702static const SCEV *BinomialCoefficient(const SCEV *It, unsigned K,
Dan Gohmanc2b015e2009-07-21 00:38:55 +0000703 ScalarEvolution &SE,
704 const Type* ResultTy) {
Eli Friedmanb42a6262008-08-04 23:49:06 +0000705 // Handle the simplest case efficiently.
706 if (K == 1)
707 return SE.getTruncateOrZeroExtend(It, ResultTy);
708
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000709 // We are using the following formula for BC(It, K):
710 //
711 // BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / K!
712 //
Eli Friedmanb42a6262008-08-04 23:49:06 +0000713 // Suppose, W is the bitwidth of the return value. We must be prepared for
714 // overflow. Hence, we must assure that the result of our computation is
715 // equal to the accurate one modulo 2^W. Unfortunately, division isn't
716 // safe in modular arithmetic.
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000717 //
Eli Friedmanb42a6262008-08-04 23:49:06 +0000718 // However, this code doesn't use exactly that formula; the formula it uses
Dan Gohman64a845e2009-06-24 04:48:43 +0000719 // is something like the following, where T is the number of factors of 2 in
Eli Friedmanb42a6262008-08-04 23:49:06 +0000720 // K! (i.e. trailing zeros in the binary representation of K!), and ^ is
721 // exponentiation:
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000722 //
Eli Friedmanb42a6262008-08-04 23:49:06 +0000723 // BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / 2^T / (K! / 2^T)
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000724 //
Eli Friedmanb42a6262008-08-04 23:49:06 +0000725 // This formula is trivially equivalent to the previous formula. However,
726 // this formula can be implemented much more efficiently. The trick is that
727 // K! / 2^T is odd, and exact division by an odd number *is* safe in modular
728 // arithmetic. To do exact division in modular arithmetic, all we have
729 // to do is multiply by the inverse. Therefore, this step can be done at
730 // width W.
Dan Gohman64a845e2009-06-24 04:48:43 +0000731 //
Eli Friedmanb42a6262008-08-04 23:49:06 +0000732 // The next issue is how to safely do the division by 2^T. The way this
733 // is done is by doing the multiplication step at a width of at least W + T
734 // bits. This way, the bottom W+T bits of the product are accurate. Then,
735 // when we perform the division by 2^T (which is equivalent to a right shift
736 // by T), the bottom W bits are accurate. Extra bits are okay; they'll get
737 // truncated out after the division by 2^T.
738 //
739 // In comparison to just directly using the first formula, this technique
740 // is much more efficient; using the first formula requires W * K bits,
741 // but this formula less than W + K bits. Also, the first formula requires
742 // a division step, whereas this formula only requires multiplies and shifts.
743 //
744 // It doesn't matter whether the subtraction step is done in the calculation
745 // width or the input iteration count's width; if the subtraction overflows,
746 // the result must be zero anyway. We prefer here to do it in the width of
747 // the induction variable because it helps a lot for certain cases; CodeGen
748 // isn't smart enough to ignore the overflow, which leads to much less
749 // efficient code if the width of the subtraction is wider than the native
750 // register width.
751 //
752 // (It's possible to not widen at all by pulling out factors of 2 before
753 // the multiplication; for example, K=2 can be calculated as
754 // It/2*(It+(It*INT_MIN/INT_MIN)+-1). However, it requires
755 // extra arithmetic, so it's not an obvious win, and it gets
756 // much more complicated for K > 3.)
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000757
Eli Friedmanb42a6262008-08-04 23:49:06 +0000758 // Protection from insane SCEVs; this bound is conservative,
759 // but it probably doesn't matter.
760 if (K > 1000)
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +0000761 return SE.getCouldNotCompute();
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000762
Dan Gohmanaf79fb52009-04-21 01:07:12 +0000763 unsigned W = SE.getTypeSizeInBits(ResultTy);
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000764
Eli Friedmanb42a6262008-08-04 23:49:06 +0000765 // Calculate K! / 2^T and T; we divide out the factors of two before
766 // multiplying for calculating K! / 2^T to avoid overflow.
767 // Other overflow doesn't matter because we only care about the bottom
768 // W bits of the result.
769 APInt OddFactorial(W, 1);
770 unsigned T = 1;
771 for (unsigned i = 3; i <= K; ++i) {
772 APInt Mult(W, i);
773 unsigned TwoFactors = Mult.countTrailingZeros();
774 T += TwoFactors;
775 Mult = Mult.lshr(TwoFactors);
776 OddFactorial *= Mult;
Chris Lattner53e677a2004-04-02 20:23:17 +0000777 }
Nick Lewycky6f8abf92008-06-13 04:38:55 +0000778
Eli Friedmanb42a6262008-08-04 23:49:06 +0000779 // We need at least W + T bits for the multiplication step
Nick Lewycky237d8732009-01-25 08:16:27 +0000780 unsigned CalculationBits = W + T;
Eli Friedmanb42a6262008-08-04 23:49:06 +0000781
Dan Gohman3f46a3a2010-03-01 17:49:51 +0000782 // Calculate 2^T, at width T+W.
Eli Friedmanb42a6262008-08-04 23:49:06 +0000783 APInt DivFactor = APInt(CalculationBits, 1).shl(T);
784
785 // Calculate the multiplicative inverse of K! / 2^T;
786 // this multiplication factor will perform the exact division by
787 // K! / 2^T.
788 APInt Mod = APInt::getSignedMinValue(W+1);
789 APInt MultiplyFactor = OddFactorial.zext(W+1);
790 MultiplyFactor = MultiplyFactor.multiplicativeInverse(Mod);
791 MultiplyFactor = MultiplyFactor.trunc(W);
792
793 // Calculate the product, at width T+W
Owen Anderson1d0be152009-08-13 21:58:54 +0000794 const IntegerType *CalculationTy = IntegerType::get(SE.getContext(),
795 CalculationBits);
Dan Gohman0bba49c2009-07-07 17:06:11 +0000796 const SCEV *Dividend = SE.getTruncateOrZeroExtend(It, CalculationTy);
Eli Friedmanb42a6262008-08-04 23:49:06 +0000797 for (unsigned i = 1; i != K; ++i) {
Dan Gohmandeff6212010-05-03 22:09:21 +0000798 const SCEV *S = SE.getMinusSCEV(It, SE.getConstant(It->getType(), i));
Eli Friedmanb42a6262008-08-04 23:49:06 +0000799 Dividend = SE.getMulExpr(Dividend,
800 SE.getTruncateOrZeroExtend(S, CalculationTy));
801 }
802
803 // Divide by 2^T
Dan Gohman0bba49c2009-07-07 17:06:11 +0000804 const SCEV *DivResult = SE.getUDivExpr(Dividend, SE.getConstant(DivFactor));
Eli Friedmanb42a6262008-08-04 23:49:06 +0000805
806 // Truncate the result, and divide by K! / 2^T.
807
808 return SE.getMulExpr(SE.getConstant(MultiplyFactor),
809 SE.getTruncateOrZeroExtend(DivResult, ResultTy));
Chris Lattner53e677a2004-04-02 20:23:17 +0000810}
811
Chris Lattner53e677a2004-04-02 20:23:17 +0000812/// evaluateAtIteration - Return the value of this chain of recurrences at
813/// the specified iteration number. We can evaluate this recurrence by
814/// multiplying each element in the chain by the binomial coefficient
815/// corresponding to it. In other words, we can evaluate {A,+,B,+,C,+,D} as:
816///
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000817/// A*BC(It, 0) + B*BC(It, 1) + C*BC(It, 2) + D*BC(It, 3)
Chris Lattner53e677a2004-04-02 20:23:17 +0000818///
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000819/// where BC(It, k) stands for binomial coefficient.
Chris Lattner53e677a2004-04-02 20:23:17 +0000820///
Dan Gohman0bba49c2009-07-07 17:06:11 +0000821const SCEV *SCEVAddRecExpr::evaluateAtIteration(const SCEV *It,
Dan Gohmanc2b015e2009-07-21 00:38:55 +0000822 ScalarEvolution &SE) const {
Dan Gohman0bba49c2009-07-07 17:06:11 +0000823 const SCEV *Result = getStart();
Chris Lattner53e677a2004-04-02 20:23:17 +0000824 for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
Wojciech Matyjewicze3320a12008-02-11 11:03:14 +0000825 // The computation is correct in the face of overflow provided that the
826 // multiplication is performed _after_ the evaluation of the binomial
827 // coefficient.
Dan Gohman0bba49c2009-07-07 17:06:11 +0000828 const SCEV *Coeff = BinomialCoefficient(It, i, SE, getType());
Nick Lewyckycb8f1b52008-10-13 03:58:02 +0000829 if (isa<SCEVCouldNotCompute>(Coeff))
830 return Coeff;
831
832 Result = SE.getAddExpr(Result, SE.getMulExpr(getOperand(i), Coeff));
Chris Lattner53e677a2004-04-02 20:23:17 +0000833 }
834 return Result;
835}
836
Chris Lattner53e677a2004-04-02 20:23:17 +0000837//===----------------------------------------------------------------------===//
838// SCEV Expression folder implementations
839//===----------------------------------------------------------------------===//
840
Dan Gohman0bba49c2009-07-07 17:06:11 +0000841const SCEV *ScalarEvolution::getTruncateExpr(const SCEV *Op,
Dan Gohmanf5074ec2009-07-13 22:05:32 +0000842 const Type *Ty) {
Dan Gohmanaf79fb52009-04-21 01:07:12 +0000843 assert(getTypeSizeInBits(Op->getType()) > getTypeSizeInBits(Ty) &&
Dan Gohmanfb17fd22009-04-21 00:55:22 +0000844 "This is not a truncating conversion!");
Dan Gohman10b94792009-05-01 16:44:18 +0000845 assert(isSCEVable(Ty) &&
846 "This is not a conversion to a SCEVable type!");
847 Ty = getEffectiveSCEVType(Ty);
Dan Gohmanfb17fd22009-04-21 00:55:22 +0000848
Dan Gohmanc050fd92009-07-13 20:50:19 +0000849 FoldingSetNodeID ID;
850 ID.AddInteger(scTruncate);
851 ID.AddPointer(Op);
852 ID.AddPointer(Ty);
853 void *IP = 0;
854 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
855
Dan Gohmanc39f44b2009-06-30 20:13:32 +0000856 // Fold if the operand is constant.
Dan Gohman622ed672009-05-04 22:02:23 +0000857 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
Dan Gohmanb8be8b72009-06-24 00:38:39 +0000858 return getConstant(
Dan Gohman1faa8822010-06-24 16:33:38 +0000859 cast<ConstantInt>(ConstantExpr::getTrunc(SC->getValue(),
860 getEffectiveSCEVType(Ty))));
Chris Lattner53e677a2004-04-02 20:23:17 +0000861
Dan Gohman20900ca2009-04-22 16:20:48 +0000862 // trunc(trunc(x)) --> trunc(x)
Dan Gohman622ed672009-05-04 22:02:23 +0000863 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op))
Dan Gohman20900ca2009-04-22 16:20:48 +0000864 return getTruncateExpr(ST->getOperand(), Ty);
865
Nick Lewycky5cd28fa2009-04-23 05:15:08 +0000866 // trunc(sext(x)) --> sext(x) if widening or trunc(x) if narrowing
Dan Gohman622ed672009-05-04 22:02:23 +0000867 if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
Nick Lewycky5cd28fa2009-04-23 05:15:08 +0000868 return getTruncateOrSignExtend(SS->getOperand(), Ty);
869
870 // trunc(zext(x)) --> zext(x) if widening or trunc(x) if narrowing
Dan Gohman622ed672009-05-04 22:02:23 +0000871 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
Nick Lewycky5cd28fa2009-04-23 05:15:08 +0000872 return getTruncateOrZeroExtend(SZ->getOperand(), Ty);
873
Dan Gohman6864db62009-06-18 16:24:47 +0000874 // If the input value is a chrec scev, truncate the chrec's operands.
Dan Gohman622ed672009-05-04 22:02:23 +0000875 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) {
Dan Gohman0bba49c2009-07-07 17:06:11 +0000876 SmallVector<const SCEV *, 4> Operands;
Chris Lattner53e677a2004-04-02 20:23:17 +0000877 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i)
Dan Gohman728c7f32009-05-08 21:03:19 +0000878 Operands.push_back(getTruncateExpr(AddRec->getOperand(i), Ty));
879 return getAddRecExpr(Operands, AddRec->getLoop());
Chris Lattner53e677a2004-04-02 20:23:17 +0000880 }
881
Dan Gohmanf53462d2010-07-15 20:02:11 +0000882 // As a special case, fold trunc(undef) to undef. We don't want to
883 // know too much about SCEVUnknowns, but this special case is handy
884 // and harmless.
885 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(Op))
886 if (isa<UndefValue>(U->getValue()))
887 return getSCEV(UndefValue::get(Ty));
888
Dan Gohman420ab912010-06-25 18:47:08 +0000889 // The cast wasn't folded; create an explicit cast node. We can reuse
890 // the existing insert position since if we get here, we won't have
891 // made any changes which would invalidate it.
Dan Gohman95531882010-03-18 18:49:47 +0000892 SCEV *S = new (SCEVAllocator) SCEVTruncateExpr(ID.Intern(SCEVAllocator),
893 Op, Ty);
Dan Gohman1c343752009-06-27 21:21:31 +0000894 UniqueSCEVs.InsertNode(S, IP);
895 return S;
Chris Lattner53e677a2004-04-02 20:23:17 +0000896}
897
Dan Gohman0bba49c2009-07-07 17:06:11 +0000898const SCEV *ScalarEvolution::getZeroExtendExpr(const SCEV *Op,
Dan Gohmanf5074ec2009-07-13 22:05:32 +0000899 const Type *Ty) {
Dan Gohmanaf79fb52009-04-21 01:07:12 +0000900 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
Dan Gohman8170a682009-04-16 19:25:55 +0000901 "This is not an extending conversion!");
Dan Gohman10b94792009-05-01 16:44:18 +0000902 assert(isSCEVable(Ty) &&
903 "This is not a conversion to a SCEVable type!");
904 Ty = getEffectiveSCEVType(Ty);
Dan Gohman8170a682009-04-16 19:25:55 +0000905
Dan Gohmanc39f44b2009-06-30 20:13:32 +0000906 // Fold if the operand is constant.
Dan Gohmaneaf6cf22010-06-24 16:47:03 +0000907 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
908 return getConstant(
909 cast<ConstantInt>(ConstantExpr::getZExt(SC->getValue(),
910 getEffectiveSCEVType(Ty))));
Chris Lattner53e677a2004-04-02 20:23:17 +0000911
Dan Gohman20900ca2009-04-22 16:20:48 +0000912 // zext(zext(x)) --> zext(x)
Dan Gohman622ed672009-05-04 22:02:23 +0000913 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
Dan Gohman20900ca2009-04-22 16:20:48 +0000914 return getZeroExtendExpr(SZ->getOperand(), Ty);
915
Dan Gohman69fbc7f2009-07-13 20:55:53 +0000916 // Before doing any expensive analysis, check to see if we've already
917 // computed a SCEV for this Op and Ty.
918 FoldingSetNodeID ID;
919 ID.AddInteger(scZeroExtend);
920 ID.AddPointer(Op);
921 ID.AddPointer(Ty);
922 void *IP = 0;
923 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
924
Dan Gohman01ecca22009-04-27 20:16:15 +0000925 // If the input value is a chrec scev, and we can prove that the value
Chris Lattner53e677a2004-04-02 20:23:17 +0000926 // did not overflow the old, smaller, value, we can zero extend all of the
Dan Gohman01ecca22009-04-27 20:16:15 +0000927 // operands (often constants). This allows analysis of something like
Chris Lattner53e677a2004-04-02 20:23:17 +0000928 // this: for (unsigned char X = 0; X < 100; ++X) { int Y = X; }
Dan Gohman622ed672009-05-04 22:02:23 +0000929 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
Dan Gohman01ecca22009-04-27 20:16:15 +0000930 if (AR->isAffine()) {
Dan Gohman85b05a22009-07-13 21:35:55 +0000931 const SCEV *Start = AR->getStart();
932 const SCEV *Step = AR->getStepRecurrence(*this);
933 unsigned BitWidth = getTypeSizeInBits(AR->getType());
934 const Loop *L = AR->getLoop();
935
Dan Gohmaneb490a72009-07-25 01:22:26 +0000936 // If we have special knowledge that this addrec won't overflow,
937 // we don't need to do any further analysis.
Dan Gohman5078f842009-08-20 17:11:38 +0000938 if (AR->hasNoUnsignedWrap())
Dan Gohmaneb490a72009-07-25 01:22:26 +0000939 return getAddRecExpr(getZeroExtendExpr(Start, Ty),
940 getZeroExtendExpr(Step, Ty),
941 L);
942
Dan Gohman01ecca22009-04-27 20:16:15 +0000943 // Check whether the backedge-taken count is SCEVCouldNotCompute.
944 // Note that this serves two purposes: It filters out loops that are
945 // simply not analyzable, and it covers the case where this code is
946 // being called from within backedge-taken count analysis, such that
947 // attempting to ask for the backedge-taken count would likely result
948 // in infinite recursion. In the later case, the analysis code will
949 // cope with a conservative value, and it will take care to purge
950 // that value once it has finished.
Dan Gohman85b05a22009-07-13 21:35:55 +0000951 const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
Dan Gohmana1af7572009-04-30 20:47:05 +0000952 if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
Dan Gohmanf0aa4852009-04-29 01:54:20 +0000953 // Manually compute the final value for AR, checking for
Dan Gohmanac70cea2009-04-29 22:28:28 +0000954 // overflow.
Dan Gohman01ecca22009-04-27 20:16:15 +0000955
956 // Check whether the backedge-taken count can be losslessly casted to
957 // the addrec's type. The count is always unsigned.
Dan Gohman0bba49c2009-07-07 17:06:11 +0000958 const SCEV *CastedMaxBECount =
Dan Gohmana1af7572009-04-30 20:47:05 +0000959 getTruncateOrZeroExtend(MaxBECount, Start->getType());
Dan Gohman0bba49c2009-07-07 17:06:11 +0000960 const SCEV *RecastedMaxBECount =
Dan Gohman5183cae2009-05-18 15:58:39 +0000961 getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
962 if (MaxBECount == RecastedMaxBECount) {
Owen Anderson1d0be152009-08-13 21:58:54 +0000963 const Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
Dan Gohmana1af7572009-04-30 20:47:05 +0000964 // Check whether Start+Step*MaxBECount has no unsigned overflow.
Dan Gohman8f767d92010-02-24 19:31:06 +0000965 const SCEV *ZMul = getMulExpr(CastedMaxBECount, Step);
Dan Gohman0bba49c2009-07-07 17:06:11 +0000966 const SCEV *Add = getAddExpr(Start, ZMul);
967 const SCEV *OperandExtendedAdd =
Dan Gohman5183cae2009-05-18 15:58:39 +0000968 getAddExpr(getZeroExtendExpr(Start, WideTy),
969 getMulExpr(getZeroExtendExpr(CastedMaxBECount, WideTy),
970 getZeroExtendExpr(Step, WideTy)));
971 if (getZeroExtendExpr(Add, WideTy) == OperandExtendedAdd)
Dan Gohmanac70cea2009-04-29 22:28:28 +0000972 // Return the expression with the addrec on the outside.
973 return getAddRecExpr(getZeroExtendExpr(Start, Ty),
974 getZeroExtendExpr(Step, Ty),
Dan Gohman85b05a22009-07-13 21:35:55 +0000975 L);
Dan Gohman01ecca22009-04-27 20:16:15 +0000976
977 // Similar to above, only this time treat the step value as signed.
978 // This covers loops that count down.
Dan Gohman8f767d92010-02-24 19:31:06 +0000979 const SCEV *SMul = getMulExpr(CastedMaxBECount, Step);
Dan Gohmanac70cea2009-04-29 22:28:28 +0000980 Add = getAddExpr(Start, SMul);
Dan Gohman5183cae2009-05-18 15:58:39 +0000981 OperandExtendedAdd =
982 getAddExpr(getZeroExtendExpr(Start, WideTy),
983 getMulExpr(getZeroExtendExpr(CastedMaxBECount, WideTy),
984 getSignExtendExpr(Step, WideTy)));
985 if (getZeroExtendExpr(Add, WideTy) == OperandExtendedAdd)
Dan Gohmanac70cea2009-04-29 22:28:28 +0000986 // Return the expression with the addrec on the outside.
987 return getAddRecExpr(getZeroExtendExpr(Start, Ty),
988 getSignExtendExpr(Step, Ty),
Dan Gohman85b05a22009-07-13 21:35:55 +0000989 L);
990 }
991
992 // If the backedge is guarded by a comparison with the pre-inc value
993 // the addrec is safe. Also, if the entry is guarded by a comparison
994 // with the start value and the backedge is guarded by a comparison
995 // with the post-inc value, the addrec is safe.
996 if (isKnownPositive(Step)) {
997 const SCEV *N = getConstant(APInt::getMinValue(BitWidth) -
998 getUnsignedRange(Step).getUnsignedMax());
999 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT, AR, N) ||
Dan Gohman3948d0b2010-04-11 19:27:13 +00001000 (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_ULT, Start, N) &&
Dan Gohman85b05a22009-07-13 21:35:55 +00001001 isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT,
1002 AR->getPostIncExpr(*this), N)))
1003 // Return the expression with the addrec on the outside.
1004 return getAddRecExpr(getZeroExtendExpr(Start, Ty),
1005 getZeroExtendExpr(Step, Ty),
1006 L);
1007 } else if (isKnownNegative(Step)) {
1008 const SCEV *N = getConstant(APInt::getMaxValue(BitWidth) -
1009 getSignedRange(Step).getSignedMin());
Dan Gohmanc0ed0092010-05-04 01:11:15 +00001010 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT, AR, N) ||
1011 (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_UGT, Start, N) &&
Dan Gohman85b05a22009-07-13 21:35:55 +00001012 isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT,
1013 AR->getPostIncExpr(*this), N)))
1014 // Return the expression with the addrec on the outside.
1015 return getAddRecExpr(getZeroExtendExpr(Start, Ty),
1016 getSignExtendExpr(Step, Ty),
1017 L);
Dan Gohman01ecca22009-04-27 20:16:15 +00001018 }
1019 }
1020 }
Chris Lattner53e677a2004-04-02 20:23:17 +00001021
Dan Gohman69fbc7f2009-07-13 20:55:53 +00001022 // The cast wasn't folded; create an explicit cast node.
1023 // Recompute the insert position, as it may have been invalidated.
Dan Gohman1c343752009-06-27 21:21:31 +00001024 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
Dan Gohman95531882010-03-18 18:49:47 +00001025 SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator),
1026 Op, Ty);
Dan Gohman1c343752009-06-27 21:21:31 +00001027 UniqueSCEVs.InsertNode(S, IP);
1028 return S;
Chris Lattner53e677a2004-04-02 20:23:17 +00001029}
1030
Dan Gohman0bba49c2009-07-07 17:06:11 +00001031const SCEV *ScalarEvolution::getSignExtendExpr(const SCEV *Op,
Dan Gohmanf5074ec2009-07-13 22:05:32 +00001032 const Type *Ty) {
Dan Gohmanaf79fb52009-04-21 01:07:12 +00001033 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
Dan Gohmanfb17fd22009-04-21 00:55:22 +00001034 "This is not an extending conversion!");
Dan Gohman10b94792009-05-01 16:44:18 +00001035 assert(isSCEVable(Ty) &&
1036 "This is not a conversion to a SCEVable type!");
1037 Ty = getEffectiveSCEVType(Ty);
Dan Gohmanfb17fd22009-04-21 00:55:22 +00001038
Dan Gohmanc39f44b2009-06-30 20:13:32 +00001039 // Fold if the operand is constant.
Dan Gohmaneaf6cf22010-06-24 16:47:03 +00001040 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1041 return getConstant(
1042 cast<ConstantInt>(ConstantExpr::getSExt(SC->getValue(),
1043 getEffectiveSCEVType(Ty))));
Dan Gohmand19534a2007-06-15 14:38:12 +00001044
Dan Gohman20900ca2009-04-22 16:20:48 +00001045 // sext(sext(x)) --> sext(x)
Dan Gohman622ed672009-05-04 22:02:23 +00001046 if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
Dan Gohman20900ca2009-04-22 16:20:48 +00001047 return getSignExtendExpr(SS->getOperand(), Ty);
1048
Dan Gohman69fbc7f2009-07-13 20:55:53 +00001049 // Before doing any expensive analysis, check to see if we've already
1050 // computed a SCEV for this Op and Ty.
1051 FoldingSetNodeID ID;
1052 ID.AddInteger(scSignExtend);
1053 ID.AddPointer(Op);
1054 ID.AddPointer(Ty);
1055 void *IP = 0;
1056 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1057
Dan Gohman01ecca22009-04-27 20:16:15 +00001058 // If the input value is a chrec scev, and we can prove that the value
Dan Gohmand19534a2007-06-15 14:38:12 +00001059 // did not overflow the old, smaller, value, we can sign extend all of the
Dan Gohman01ecca22009-04-27 20:16:15 +00001060 // operands (often constants). This allows analysis of something like
Dan Gohmand19534a2007-06-15 14:38:12 +00001061 // this: for (signed char X = 0; X < 100; ++X) { int Y = X; }
Dan Gohman622ed672009-05-04 22:02:23 +00001062 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
Dan Gohman01ecca22009-04-27 20:16:15 +00001063 if (AR->isAffine()) {
Dan Gohman85b05a22009-07-13 21:35:55 +00001064 const SCEV *Start = AR->getStart();
1065 const SCEV *Step = AR->getStepRecurrence(*this);
1066 unsigned BitWidth = getTypeSizeInBits(AR->getType());
1067 const Loop *L = AR->getLoop();
1068
Dan Gohmaneb490a72009-07-25 01:22:26 +00001069 // If we have special knowledge that this addrec won't overflow,
1070 // we don't need to do any further analysis.
Dan Gohman5078f842009-08-20 17:11:38 +00001071 if (AR->hasNoSignedWrap())
Dan Gohmaneb490a72009-07-25 01:22:26 +00001072 return getAddRecExpr(getSignExtendExpr(Start, Ty),
1073 getSignExtendExpr(Step, Ty),
1074 L);
1075
Dan Gohman01ecca22009-04-27 20:16:15 +00001076 // Check whether the backedge-taken count is SCEVCouldNotCompute.
1077 // Note that this serves two purposes: It filters out loops that are
1078 // simply not analyzable, and it covers the case where this code is
1079 // being called from within backedge-taken count analysis, such that
1080 // attempting to ask for the backedge-taken count would likely result
1081 // in infinite recursion. In the later case, the analysis code will
1082 // cope with a conservative value, and it will take care to purge
1083 // that value once it has finished.
Dan Gohman85b05a22009-07-13 21:35:55 +00001084 const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
Dan Gohmana1af7572009-04-30 20:47:05 +00001085 if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
Dan Gohmanf0aa4852009-04-29 01:54:20 +00001086 // Manually compute the final value for AR, checking for
Dan Gohmanac70cea2009-04-29 22:28:28 +00001087 // overflow.
Dan Gohman01ecca22009-04-27 20:16:15 +00001088
1089 // Check whether the backedge-taken count can be losslessly casted to
Dan Gohmanac70cea2009-04-29 22:28:28 +00001090 // the addrec's type. The count is always unsigned.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001091 const SCEV *CastedMaxBECount =
Dan Gohmana1af7572009-04-30 20:47:05 +00001092 getTruncateOrZeroExtend(MaxBECount, Start->getType());
Dan Gohman0bba49c2009-07-07 17:06:11 +00001093 const SCEV *RecastedMaxBECount =
Dan Gohman5183cae2009-05-18 15:58:39 +00001094 getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
1095 if (MaxBECount == RecastedMaxBECount) {
Owen Anderson1d0be152009-08-13 21:58:54 +00001096 const Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
Dan Gohmana1af7572009-04-30 20:47:05 +00001097 // Check whether Start+Step*MaxBECount has no signed overflow.
Dan Gohman8f767d92010-02-24 19:31:06 +00001098 const SCEV *SMul = getMulExpr(CastedMaxBECount, Step);
Dan Gohman0bba49c2009-07-07 17:06:11 +00001099 const SCEV *Add = getAddExpr(Start, SMul);
1100 const SCEV *OperandExtendedAdd =
Dan Gohman5183cae2009-05-18 15:58:39 +00001101 getAddExpr(getSignExtendExpr(Start, WideTy),
1102 getMulExpr(getZeroExtendExpr(CastedMaxBECount, WideTy),
1103 getSignExtendExpr(Step, WideTy)));
1104 if (getSignExtendExpr(Add, WideTy) == OperandExtendedAdd)
Dan Gohmanac70cea2009-04-29 22:28:28 +00001105 // Return the expression with the addrec on the outside.
1106 return getAddRecExpr(getSignExtendExpr(Start, Ty),
1107 getSignExtendExpr(Step, Ty),
Dan Gohman85b05a22009-07-13 21:35:55 +00001108 L);
Dan Gohman850f7912009-07-16 17:34:36 +00001109
1110 // Similar to above, only this time treat the step value as unsigned.
1111 // This covers loops that count up with an unsigned step.
Dan Gohman8f767d92010-02-24 19:31:06 +00001112 const SCEV *UMul = getMulExpr(CastedMaxBECount, Step);
Dan Gohman850f7912009-07-16 17:34:36 +00001113 Add = getAddExpr(Start, UMul);
1114 OperandExtendedAdd =
Dan Gohman19378d62009-07-25 16:03:30 +00001115 getAddExpr(getSignExtendExpr(Start, WideTy),
Dan Gohman850f7912009-07-16 17:34:36 +00001116 getMulExpr(getZeroExtendExpr(CastedMaxBECount, WideTy),
1117 getZeroExtendExpr(Step, WideTy)));
Dan Gohman19378d62009-07-25 16:03:30 +00001118 if (getSignExtendExpr(Add, WideTy) == OperandExtendedAdd)
Dan Gohman850f7912009-07-16 17:34:36 +00001119 // Return the expression with the addrec on the outside.
1120 return getAddRecExpr(getSignExtendExpr(Start, Ty),
1121 getZeroExtendExpr(Step, Ty),
1122 L);
Dan Gohman85b05a22009-07-13 21:35:55 +00001123 }
1124
1125 // If the backedge is guarded by a comparison with the pre-inc value
1126 // the addrec is safe. Also, if the entry is guarded by a comparison
1127 // with the start value and the backedge is guarded by a comparison
1128 // with the post-inc value, the addrec is safe.
1129 if (isKnownPositive(Step)) {
1130 const SCEV *N = getConstant(APInt::getSignedMinValue(BitWidth) -
1131 getSignedRange(Step).getSignedMax());
1132 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_SLT, AR, N) ||
Dan Gohman3948d0b2010-04-11 19:27:13 +00001133 (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_SLT, Start, N) &&
Dan Gohman85b05a22009-07-13 21:35:55 +00001134 isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_SLT,
1135 AR->getPostIncExpr(*this), N)))
1136 // Return the expression with the addrec on the outside.
1137 return getAddRecExpr(getSignExtendExpr(Start, Ty),
1138 getSignExtendExpr(Step, Ty),
1139 L);
1140 } else if (isKnownNegative(Step)) {
1141 const SCEV *N = getConstant(APInt::getSignedMaxValue(BitWidth) -
1142 getSignedRange(Step).getSignedMin());
1143 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_SGT, AR, N) ||
Dan Gohman3948d0b2010-04-11 19:27:13 +00001144 (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_SGT, Start, N) &&
Dan Gohman85b05a22009-07-13 21:35:55 +00001145 isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_SGT,
1146 AR->getPostIncExpr(*this), N)))
1147 // Return the expression with the addrec on the outside.
1148 return getAddRecExpr(getSignExtendExpr(Start, Ty),
1149 getSignExtendExpr(Step, Ty),
1150 L);
Dan Gohman01ecca22009-04-27 20:16:15 +00001151 }
1152 }
1153 }
Dan Gohmand19534a2007-06-15 14:38:12 +00001154
Dan Gohman69fbc7f2009-07-13 20:55:53 +00001155 // The cast wasn't folded; create an explicit cast node.
1156 // Recompute the insert position, as it may have been invalidated.
Dan Gohman1c343752009-06-27 21:21:31 +00001157 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
Dan Gohman95531882010-03-18 18:49:47 +00001158 SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator),
1159 Op, Ty);
Dan Gohman1c343752009-06-27 21:21:31 +00001160 UniqueSCEVs.InsertNode(S, IP);
1161 return S;
Dan Gohmand19534a2007-06-15 14:38:12 +00001162}
1163
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00001164/// getAnyExtendExpr - Return a SCEV for the given operand extended with
1165/// unspecified bits out to the given type.
1166///
Dan Gohman0bba49c2009-07-07 17:06:11 +00001167const SCEV *ScalarEvolution::getAnyExtendExpr(const SCEV *Op,
Dan Gohmanc40f17b2009-08-18 16:46:41 +00001168 const Type *Ty) {
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00001169 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1170 "This is not an extending conversion!");
1171 assert(isSCEVable(Ty) &&
1172 "This is not a conversion to a SCEVable type!");
1173 Ty = getEffectiveSCEVType(Ty);
1174
1175 // Sign-extend negative constants.
1176 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1177 if (SC->getValue()->getValue().isNegative())
1178 return getSignExtendExpr(Op, Ty);
1179
1180 // Peel off a truncate cast.
1181 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Op)) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00001182 const SCEV *NewOp = T->getOperand();
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00001183 if (getTypeSizeInBits(NewOp->getType()) < getTypeSizeInBits(Ty))
1184 return getAnyExtendExpr(NewOp, Ty);
1185 return getTruncateOrNoop(NewOp, Ty);
1186 }
1187
1188 // Next try a zext cast. If the cast is folded, use it.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001189 const SCEV *ZExt = getZeroExtendExpr(Op, Ty);
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00001190 if (!isa<SCEVZeroExtendExpr>(ZExt))
1191 return ZExt;
1192
1193 // Next try a sext cast. If the cast is folded, use it.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001194 const SCEV *SExt = getSignExtendExpr(Op, Ty);
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00001195 if (!isa<SCEVSignExtendExpr>(SExt))
1196 return SExt;
1197
Dan Gohmana10756e2010-01-21 02:09:26 +00001198 // Force the cast to be folded into the operands of an addrec.
1199 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) {
1200 SmallVector<const SCEV *, 4> Ops;
1201 for (SCEVAddRecExpr::op_iterator I = AR->op_begin(), E = AR->op_end();
1202 I != E; ++I)
1203 Ops.push_back(getAnyExtendExpr(*I, Ty));
1204 return getAddRecExpr(Ops, AR->getLoop());
1205 }
1206
Dan Gohmanf53462d2010-07-15 20:02:11 +00001207 // As a special case, fold anyext(undef) to undef. We don't want to
1208 // know too much about SCEVUnknowns, but this special case is handy
1209 // and harmless.
1210 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(Op))
1211 if (isa<UndefValue>(U->getValue()))
1212 return getSCEV(UndefValue::get(Ty));
1213
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00001214 // If the expression is obviously signed, use the sext cast value.
1215 if (isa<SCEVSMaxExpr>(Op))
1216 return SExt;
1217
1218 // Absent any other information, use the zext cast value.
1219 return ZExt;
1220}
1221
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001222/// CollectAddOperandsWithScales - Process the given Ops list, which is
1223/// a list of operands to be added under the given scale, update the given
1224/// map. This is a helper function for getAddRecExpr. As an example of
1225/// what it does, given a sequence of operands that would form an add
1226/// expression like this:
1227///
1228/// m + n + 13 + (A * (o + p + (B * q + m + 29))) + r + (-1 * r)
1229///
1230/// where A and B are constants, update the map with these values:
1231///
1232/// (m, 1+A*B), (n, 1), (o, A), (p, A), (q, A*B), (r, 0)
1233///
1234/// and add 13 + A*B*29 to AccumulatedConstant.
1235/// This will allow getAddRecExpr to produce this:
1236///
1237/// 13+A*B*29 + n + (m * (1+A*B)) + ((o + p) * A) + (q * A*B)
1238///
1239/// This form often exposes folding opportunities that are hidden in
1240/// the original operand list.
1241///
1242/// Return true iff it appears that any interesting folding opportunities
1243/// may be exposed. This helps getAddRecExpr short-circuit extra work in
1244/// the common case where no interesting opportunities are present, and
1245/// is also used as a check to avoid infinite recursion.
1246///
1247static bool
Dan Gohman0bba49c2009-07-07 17:06:11 +00001248CollectAddOperandsWithScales(DenseMap<const SCEV *, APInt> &M,
1249 SmallVector<const SCEV *, 8> &NewOps,
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001250 APInt &AccumulatedConstant,
Dan Gohmanf9e64722010-03-18 01:17:13 +00001251 const SCEV *const *Ops, size_t NumOperands,
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001252 const APInt &Scale,
1253 ScalarEvolution &SE) {
1254 bool Interesting = false;
1255
Dan Gohmane0f0c7b2010-06-18 19:12:32 +00001256 // Iterate over the add operands. They are sorted, with constants first.
1257 unsigned i = 0;
1258 while (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
1259 ++i;
1260 // Pull a buried constant out to the outside.
1261 if (Scale != 1 || AccumulatedConstant != 0 || C->getValue()->isZero())
1262 Interesting = true;
1263 AccumulatedConstant += Scale * C->getValue()->getValue();
1264 }
1265
1266 // Next comes everything else. We're especially interested in multiplies
1267 // here, but they're in the middle, so just visit the rest with one loop.
1268 for (; i != NumOperands; ++i) {
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001269 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[i]);
1270 if (Mul && isa<SCEVConstant>(Mul->getOperand(0))) {
1271 APInt NewScale =
1272 Scale * cast<SCEVConstant>(Mul->getOperand(0))->getValue()->getValue();
1273 if (Mul->getNumOperands() == 2 && isa<SCEVAddExpr>(Mul->getOperand(1))) {
1274 // A multiplication of a constant with another add; recurse.
Dan Gohmanf9e64722010-03-18 01:17:13 +00001275 const SCEVAddExpr *Add = cast<SCEVAddExpr>(Mul->getOperand(1));
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001276 Interesting |=
1277 CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
Dan Gohmanf9e64722010-03-18 01:17:13 +00001278 Add->op_begin(), Add->getNumOperands(),
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001279 NewScale, SE);
1280 } else {
1281 // A multiplication of a constant with some other value. Update
1282 // the map.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001283 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin()+1, Mul->op_end());
1284 const SCEV *Key = SE.getMulExpr(MulOps);
1285 std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair =
Dan Gohman23737e02009-06-29 18:25:52 +00001286 M.insert(std::make_pair(Key, NewScale));
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001287 if (Pair.second) {
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001288 NewOps.push_back(Pair.first->first);
1289 } else {
1290 Pair.first->second += NewScale;
1291 // The map already had an entry for this value, which may indicate
1292 // a folding opportunity.
1293 Interesting = true;
1294 }
1295 }
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001296 } else {
1297 // An ordinary operand. Update the map.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001298 std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair =
Dan Gohman23737e02009-06-29 18:25:52 +00001299 M.insert(std::make_pair(Ops[i], Scale));
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001300 if (Pair.second) {
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001301 NewOps.push_back(Pair.first->first);
1302 } else {
1303 Pair.first->second += Scale;
1304 // The map already had an entry for this value, which may indicate
1305 // a folding opportunity.
1306 Interesting = true;
1307 }
1308 }
1309 }
1310
1311 return Interesting;
1312}
1313
1314namespace {
1315 struct APIntCompare {
1316 bool operator()(const APInt &LHS, const APInt &RHS) const {
1317 return LHS.ult(RHS);
1318 }
1319 };
1320}
1321
Dan Gohman6c0866c2009-05-24 23:45:28 +00001322/// getAddExpr - Get a canonical add expression, or something simpler if
1323/// possible.
Dan Gohman3645b012009-10-09 00:10:36 +00001324const SCEV *ScalarEvolution::getAddExpr(SmallVectorImpl<const SCEV *> &Ops,
1325 bool HasNUW, bool HasNSW) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001326 assert(!Ops.empty() && "Cannot get empty add!");
Chris Lattner627018b2004-04-07 16:16:11 +00001327 if (Ops.size() == 1) return Ops[0];
Dan Gohmanf78a9782009-05-18 15:44:58 +00001328#ifndef NDEBUG
Dan Gohmanc72f0c82010-06-18 19:09:27 +00001329 const Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
Dan Gohmanf78a9782009-05-18 15:44:58 +00001330 for (unsigned i = 1, e = Ops.size(); i != e; ++i)
Dan Gohmanc72f0c82010-06-18 19:09:27 +00001331 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
Dan Gohmanf78a9782009-05-18 15:44:58 +00001332 "SCEVAddExpr operand types don't match!");
1333#endif
Chris Lattner53e677a2004-04-02 20:23:17 +00001334
Dan Gohmana10756e2010-01-21 02:09:26 +00001335 // If HasNSW is true and all the operands are non-negative, infer HasNUW.
1336 if (!HasNUW && HasNSW) {
1337 bool All = true;
1338 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1339 if (!isKnownNonNegative(Ops[i])) {
1340 All = false;
1341 break;
1342 }
1343 if (All) HasNUW = true;
1344 }
1345
Chris Lattner53e677a2004-04-02 20:23:17 +00001346 // Sort by complexity, this groups all similar expression types together.
Dan Gohman72861302009-05-07 14:39:04 +00001347 GroupByComplexity(Ops, LI);
Chris Lattner53e677a2004-04-02 20:23:17 +00001348
1349 // If there are any constants, fold them together.
1350 unsigned Idx = 0;
Dan Gohman622ed672009-05-04 22:02:23 +00001351 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001352 ++Idx;
Chris Lattner627018b2004-04-07 16:16:11 +00001353 assert(Idx < Ops.size());
Dan Gohman622ed672009-05-04 22:02:23 +00001354 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001355 // We found two constants, fold them together!
Dan Gohmana82752c2009-06-14 22:47:23 +00001356 Ops[0] = getConstant(LHSC->getValue()->getValue() +
1357 RHSC->getValue()->getValue());
Dan Gohman7f7c4362009-06-14 22:53:57 +00001358 if (Ops.size() == 2) return Ops[0];
Nick Lewycky3e630762008-02-20 06:48:22 +00001359 Ops.erase(Ops.begin()+1); // Erase the folded element
Nick Lewycky3e630762008-02-20 06:48:22 +00001360 LHSC = cast<SCEVConstant>(Ops[0]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001361 }
1362
1363 // If we are left with a constant zero being added, strip it off.
Dan Gohmanbca091d2010-04-12 23:08:18 +00001364 if (LHSC->getValue()->isZero()) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001365 Ops.erase(Ops.begin());
1366 --Idx;
1367 }
Chris Lattner53e677a2004-04-02 20:23:17 +00001368
Dan Gohmanbca091d2010-04-12 23:08:18 +00001369 if (Ops.size() == 1) return Ops[0];
1370 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00001371
Chris Lattner53e677a2004-04-02 20:23:17 +00001372 // Okay, check to see if the same value occurs in the operand list twice. If
1373 // so, merge them together into an multiply expression. Since we sorted the
1374 // list, these values are required to be adjacent.
1375 const Type *Ty = Ops[0]->getType();
1376 for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
1377 if (Ops[i] == Ops[i+1]) { // X + Y + Y --> X + Y*2
1378 // Found a match, merge the two values into a multiply, and add any
1379 // remaining values to the result.
Dan Gohmandeff6212010-05-03 22:09:21 +00001380 const SCEV *Two = getConstant(Ty, 2);
Dan Gohman0bba49c2009-07-07 17:06:11 +00001381 const SCEV *Mul = getMulExpr(Ops[i], Two);
Chris Lattner53e677a2004-04-02 20:23:17 +00001382 if (Ops.size() == 2)
1383 return Mul;
1384 Ops.erase(Ops.begin()+i, Ops.begin()+i+2);
1385 Ops.push_back(Mul);
Dan Gohman3645b012009-10-09 00:10:36 +00001386 return getAddExpr(Ops, HasNUW, HasNSW);
Chris Lattner53e677a2004-04-02 20:23:17 +00001387 }
1388
Dan Gohman728c7f32009-05-08 21:03:19 +00001389 // Check for truncates. If all the operands are truncated from the same
1390 // type, see if factoring out the truncate would permit the result to be
1391 // folded. eg., trunc(x) + m*trunc(n) --> trunc(x + trunc(m)*n)
1392 // if the contents of the resulting outer trunc fold to something simple.
1393 for (; Idx < Ops.size() && isa<SCEVTruncateExpr>(Ops[Idx]); ++Idx) {
1394 const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(Ops[Idx]);
1395 const Type *DstType = Trunc->getType();
1396 const Type *SrcType = Trunc->getOperand()->getType();
Dan Gohman0bba49c2009-07-07 17:06:11 +00001397 SmallVector<const SCEV *, 8> LargeOps;
Dan Gohman728c7f32009-05-08 21:03:19 +00001398 bool Ok = true;
1399 // Check all the operands to see if they can be represented in the
1400 // source type of the truncate.
1401 for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
1402 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Ops[i])) {
1403 if (T->getOperand()->getType() != SrcType) {
1404 Ok = false;
1405 break;
1406 }
1407 LargeOps.push_back(T->getOperand());
1408 } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
Dan Gohmanc6863982010-04-23 01:51:29 +00001409 LargeOps.push_back(getAnyExtendExpr(C, SrcType));
Dan Gohman728c7f32009-05-08 21:03:19 +00001410 } else if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Ops[i])) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00001411 SmallVector<const SCEV *, 8> LargeMulOps;
Dan Gohman728c7f32009-05-08 21:03:19 +00001412 for (unsigned j = 0, f = M->getNumOperands(); j != f && Ok; ++j) {
1413 if (const SCEVTruncateExpr *T =
1414 dyn_cast<SCEVTruncateExpr>(M->getOperand(j))) {
1415 if (T->getOperand()->getType() != SrcType) {
1416 Ok = false;
1417 break;
1418 }
1419 LargeMulOps.push_back(T->getOperand());
1420 } else if (const SCEVConstant *C =
1421 dyn_cast<SCEVConstant>(M->getOperand(j))) {
Dan Gohmanc6863982010-04-23 01:51:29 +00001422 LargeMulOps.push_back(getAnyExtendExpr(C, SrcType));
Dan Gohman728c7f32009-05-08 21:03:19 +00001423 } else {
1424 Ok = false;
1425 break;
1426 }
1427 }
1428 if (Ok)
1429 LargeOps.push_back(getMulExpr(LargeMulOps));
1430 } else {
1431 Ok = false;
1432 break;
1433 }
1434 }
1435 if (Ok) {
1436 // Evaluate the expression in the larger type.
Dan Gohman3645b012009-10-09 00:10:36 +00001437 const SCEV *Fold = getAddExpr(LargeOps, HasNUW, HasNSW);
Dan Gohman728c7f32009-05-08 21:03:19 +00001438 // If it folds to something simple, use it. Otherwise, don't.
1439 if (isa<SCEVConstant>(Fold) || isa<SCEVUnknown>(Fold))
1440 return getTruncateExpr(Fold, DstType);
1441 }
1442 }
1443
1444 // Skip past any other cast SCEVs.
Dan Gohmanf50cd742007-06-18 19:30:09 +00001445 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddExpr)
1446 ++Idx;
1447
1448 // If there are add operands they would be next.
Chris Lattner53e677a2004-04-02 20:23:17 +00001449 if (Idx < Ops.size()) {
1450 bool DeletedAdd = false;
Dan Gohman622ed672009-05-04 22:02:23 +00001451 while (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[Idx])) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001452 // If we have an add, expand the add operands onto the end of the operands
1453 // list.
Chris Lattner53e677a2004-04-02 20:23:17 +00001454 Ops.erase(Ops.begin()+Idx);
Dan Gohman403a8cd2010-06-21 19:47:52 +00001455 Ops.append(Add->op_begin(), Add->op_end());
Chris Lattner53e677a2004-04-02 20:23:17 +00001456 DeletedAdd = true;
1457 }
1458
1459 // If we deleted at least one add, we added operands to the end of the list,
1460 // and they are not necessarily sorted. Recurse to resort and resimplify
Dan Gohman3f46a3a2010-03-01 17:49:51 +00001461 // any operands we just acquired.
Chris Lattner53e677a2004-04-02 20:23:17 +00001462 if (DeletedAdd)
Dan Gohman246b2562007-10-22 18:31:58 +00001463 return getAddExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001464 }
1465
1466 // Skip over the add expression until we get to a multiply.
1467 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
1468 ++Idx;
1469
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001470 // Check to see if there are any folding opportunities present with
1471 // operands multiplied by constant values.
1472 if (Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx])) {
1473 uint64_t BitWidth = getTypeSizeInBits(Ty);
Dan Gohman0bba49c2009-07-07 17:06:11 +00001474 DenseMap<const SCEV *, APInt> M;
1475 SmallVector<const SCEV *, 8> NewOps;
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001476 APInt AccumulatedConstant(BitWidth, 0);
1477 if (CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
Dan Gohmanf9e64722010-03-18 01:17:13 +00001478 Ops.data(), Ops.size(),
1479 APInt(BitWidth, 1), *this)) {
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001480 // Some interesting folding opportunity is present, so its worthwhile to
1481 // re-generate the operands list. Group the operands by constant scale,
1482 // to avoid multiplying by the same constant scale multiple times.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001483 std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare> MulOpLists;
1484 for (SmallVector<const SCEV *, 8>::iterator I = NewOps.begin(),
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001485 E = NewOps.end(); I != E; ++I)
1486 MulOpLists[M.find(*I)->second].push_back(*I);
1487 // Re-generate the operands list.
1488 Ops.clear();
1489 if (AccumulatedConstant != 0)
1490 Ops.push_back(getConstant(AccumulatedConstant));
Dan Gohman64a845e2009-06-24 04:48:43 +00001491 for (std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare>::iterator
1492 I = MulOpLists.begin(), E = MulOpLists.end(); I != E; ++I)
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001493 if (I->first != 0)
Dan Gohman64a845e2009-06-24 04:48:43 +00001494 Ops.push_back(getMulExpr(getConstant(I->first),
1495 getAddExpr(I->second)));
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001496 if (Ops.empty())
Dan Gohmandeff6212010-05-03 22:09:21 +00001497 return getConstant(Ty, 0);
Dan Gohmanbd59d7b2009-06-14 22:58:51 +00001498 if (Ops.size() == 1)
1499 return Ops[0];
1500 return getAddExpr(Ops);
1501 }
1502 }
1503
Chris Lattner53e677a2004-04-02 20:23:17 +00001504 // If we are adding something to a multiply expression, make sure the
1505 // something is not already an operand of the multiply. If so, merge it into
1506 // the multiply.
1507 for (; Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx]); ++Idx) {
Dan Gohman35738ac2009-05-04 22:30:44 +00001508 const SCEVMulExpr *Mul = cast<SCEVMulExpr>(Ops[Idx]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001509 for (unsigned MulOp = 0, e = Mul->getNumOperands(); MulOp != e; ++MulOp) {
Dan Gohman35738ac2009-05-04 22:30:44 +00001510 const SCEV *MulOpSCEV = Mul->getOperand(MulOp);
Chris Lattner53e677a2004-04-02 20:23:17 +00001511 for (unsigned AddOp = 0, e = Ops.size(); AddOp != e; ++AddOp)
Dan Gohmana82752c2009-06-14 22:47:23 +00001512 if (MulOpSCEV == Ops[AddOp] && !isa<SCEVConstant>(Ops[AddOp])) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001513 // Fold W + X + (X * Y * Z) --> W + (X * ((Y*Z)+1))
Dan Gohman0bba49c2009-07-07 17:06:11 +00001514 const SCEV *InnerMul = Mul->getOperand(MulOp == 0);
Chris Lattner53e677a2004-04-02 20:23:17 +00001515 if (Mul->getNumOperands() != 2) {
1516 // If the multiply has more than two operands, we must get the
1517 // Y*Z term.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001518 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(), Mul->op_end());
Chris Lattner53e677a2004-04-02 20:23:17 +00001519 MulOps.erase(MulOps.begin()+MulOp);
Dan Gohman246b2562007-10-22 18:31:58 +00001520 InnerMul = getMulExpr(MulOps);
Chris Lattner53e677a2004-04-02 20:23:17 +00001521 }
Dan Gohmandeff6212010-05-03 22:09:21 +00001522 const SCEV *One = getConstant(Ty, 1);
Dan Gohman0bba49c2009-07-07 17:06:11 +00001523 const SCEV *AddOne = getAddExpr(InnerMul, One);
1524 const SCEV *OuterMul = getMulExpr(AddOne, Ops[AddOp]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001525 if (Ops.size() == 2) return OuterMul;
1526 if (AddOp < Idx) {
1527 Ops.erase(Ops.begin()+AddOp);
1528 Ops.erase(Ops.begin()+Idx-1);
1529 } else {
1530 Ops.erase(Ops.begin()+Idx);
1531 Ops.erase(Ops.begin()+AddOp-1);
1532 }
1533 Ops.push_back(OuterMul);
Dan Gohman246b2562007-10-22 18:31:58 +00001534 return getAddExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001535 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00001536
Chris Lattner53e677a2004-04-02 20:23:17 +00001537 // Check this multiply against other multiplies being added together.
1538 for (unsigned OtherMulIdx = Idx+1;
1539 OtherMulIdx < Ops.size() && isa<SCEVMulExpr>(Ops[OtherMulIdx]);
1540 ++OtherMulIdx) {
Dan Gohman35738ac2009-05-04 22:30:44 +00001541 const SCEVMulExpr *OtherMul = cast<SCEVMulExpr>(Ops[OtherMulIdx]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001542 // If MulOp occurs in OtherMul, we can fold the two multiplies
1543 // together.
1544 for (unsigned OMulOp = 0, e = OtherMul->getNumOperands();
1545 OMulOp != e; ++OMulOp)
1546 if (OtherMul->getOperand(OMulOp) == MulOpSCEV) {
1547 // Fold X + (A*B*C) + (A*D*E) --> X + (A*(B*C+D*E))
Dan Gohman0bba49c2009-07-07 17:06:11 +00001548 const SCEV *InnerMul1 = Mul->getOperand(MulOp == 0);
Chris Lattner53e677a2004-04-02 20:23:17 +00001549 if (Mul->getNumOperands() != 2) {
Dan Gohman64a845e2009-06-24 04:48:43 +00001550 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(),
1551 Mul->op_end());
Chris Lattner53e677a2004-04-02 20:23:17 +00001552 MulOps.erase(MulOps.begin()+MulOp);
Dan Gohman246b2562007-10-22 18:31:58 +00001553 InnerMul1 = getMulExpr(MulOps);
Chris Lattner53e677a2004-04-02 20:23:17 +00001554 }
Dan Gohman0bba49c2009-07-07 17:06:11 +00001555 const SCEV *InnerMul2 = OtherMul->getOperand(OMulOp == 0);
Chris Lattner53e677a2004-04-02 20:23:17 +00001556 if (OtherMul->getNumOperands() != 2) {
Dan Gohman64a845e2009-06-24 04:48:43 +00001557 SmallVector<const SCEV *, 4> MulOps(OtherMul->op_begin(),
1558 OtherMul->op_end());
Chris Lattner53e677a2004-04-02 20:23:17 +00001559 MulOps.erase(MulOps.begin()+OMulOp);
Dan Gohman246b2562007-10-22 18:31:58 +00001560 InnerMul2 = getMulExpr(MulOps);
Chris Lattner53e677a2004-04-02 20:23:17 +00001561 }
Dan Gohman0bba49c2009-07-07 17:06:11 +00001562 const SCEV *InnerMulSum = getAddExpr(InnerMul1,InnerMul2);
1563 const SCEV *OuterMul = getMulExpr(MulOpSCEV, InnerMulSum);
Chris Lattner53e677a2004-04-02 20:23:17 +00001564 if (Ops.size() == 2) return OuterMul;
1565 Ops.erase(Ops.begin()+Idx);
1566 Ops.erase(Ops.begin()+OtherMulIdx-1);
1567 Ops.push_back(OuterMul);
Dan Gohman246b2562007-10-22 18:31:58 +00001568 return getAddExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001569 }
1570 }
1571 }
1572 }
1573
1574 // If there are any add recurrences in the operands list, see if any other
1575 // added values are loop invariant. If so, we can fold them into the
1576 // recurrence.
1577 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
1578 ++Idx;
1579
1580 // Scan over all recurrences, trying to fold loop invariants into them.
1581 for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
1582 // Scan all of the other operands to this add and add them to the vector if
1583 // they are loop invariant w.r.t. the recurrence.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001584 SmallVector<const SCEV *, 8> LIOps;
Dan Gohman35738ac2009-05-04 22:30:44 +00001585 const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
Dan Gohmanbca091d2010-04-12 23:08:18 +00001586 const Loop *AddRecLoop = AddRec->getLoop();
Chris Lattner53e677a2004-04-02 20:23:17 +00001587 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
Dan Gohmanbca091d2010-04-12 23:08:18 +00001588 if (Ops[i]->isLoopInvariant(AddRecLoop)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001589 LIOps.push_back(Ops[i]);
1590 Ops.erase(Ops.begin()+i);
1591 --i; --e;
1592 }
1593
1594 // If we found some loop invariants, fold them into the recurrence.
1595 if (!LIOps.empty()) {
Dan Gohman8dae1382008-09-14 17:21:12 +00001596 // NLI + LI + {Start,+,Step} --> NLI + {LI+Start,+,Step}
Chris Lattner53e677a2004-04-02 20:23:17 +00001597 LIOps.push_back(AddRec->getStart());
1598
Dan Gohman0bba49c2009-07-07 17:06:11 +00001599 SmallVector<const SCEV *, 4> AddRecOps(AddRec->op_begin(),
Dan Gohman3a5d4092009-12-18 03:57:04 +00001600 AddRec->op_end());
Dan Gohman246b2562007-10-22 18:31:58 +00001601 AddRecOps[0] = getAddExpr(LIOps);
Chris Lattner53e677a2004-04-02 20:23:17 +00001602
Dan Gohmanb9f96512010-06-30 07:16:37 +00001603 // Build the new addrec. Propagate the NUW and NSW flags if both the
1604 // outer add and the inner addrec are guaranteed to have no overflow.
1605 const SCEV *NewRec = getAddRecExpr(AddRecOps, AddRecLoop,
1606 HasNUW && AddRec->hasNoUnsignedWrap(),
1607 HasNSW && AddRec->hasNoSignedWrap());
Dan Gohman59de33e2009-12-18 18:45:31 +00001608
Chris Lattner53e677a2004-04-02 20:23:17 +00001609 // If all of the other operands were loop invariant, we are done.
1610 if (Ops.size() == 1) return NewRec;
1611
1612 // Otherwise, add the folded AddRec by the non-liv parts.
1613 for (unsigned i = 0;; ++i)
1614 if (Ops[i] == AddRec) {
1615 Ops[i] = NewRec;
1616 break;
1617 }
Dan Gohman246b2562007-10-22 18:31:58 +00001618 return getAddExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001619 }
1620
1621 // Okay, if there weren't any loop invariants to be folded, check to see if
1622 // there are multiple AddRec's with the same loop induction variable being
1623 // added together. If so, we can fold them.
1624 for (unsigned OtherIdx = Idx+1;
1625 OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);++OtherIdx)
1626 if (OtherIdx != Idx) {
Dan Gohman35738ac2009-05-04 22:30:44 +00001627 const SCEVAddRecExpr *OtherAddRec = cast<SCEVAddRecExpr>(Ops[OtherIdx]);
Dan Gohmanbca091d2010-04-12 23:08:18 +00001628 if (AddRecLoop == OtherAddRec->getLoop()) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001629 // Other + {A,+,B} + {C,+,D} --> Other + {A+C,+,B+D}
Dan Gohman64a845e2009-06-24 04:48:43 +00001630 SmallVector<const SCEV *, 4> NewOps(AddRec->op_begin(),
1631 AddRec->op_end());
Chris Lattner53e677a2004-04-02 20:23:17 +00001632 for (unsigned i = 0, e = OtherAddRec->getNumOperands(); i != e; ++i) {
1633 if (i >= NewOps.size()) {
Dan Gohman403a8cd2010-06-21 19:47:52 +00001634 NewOps.append(OtherAddRec->op_begin()+i,
Chris Lattner53e677a2004-04-02 20:23:17 +00001635 OtherAddRec->op_end());
1636 break;
1637 }
Dan Gohman246b2562007-10-22 18:31:58 +00001638 NewOps[i] = getAddExpr(NewOps[i], OtherAddRec->getOperand(i));
Chris Lattner53e677a2004-04-02 20:23:17 +00001639 }
Dan Gohmanbca091d2010-04-12 23:08:18 +00001640 const SCEV *NewAddRec = getAddRecExpr(NewOps, AddRecLoop);
Chris Lattner53e677a2004-04-02 20:23:17 +00001641
1642 if (Ops.size() == 2) return NewAddRec;
1643
1644 Ops.erase(Ops.begin()+Idx);
1645 Ops.erase(Ops.begin()+OtherIdx-1);
1646 Ops.push_back(NewAddRec);
Dan Gohman246b2562007-10-22 18:31:58 +00001647 return getAddExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001648 }
1649 }
1650
1651 // Otherwise couldn't fold anything into this recurrence. Move onto the
1652 // next one.
1653 }
1654
1655 // Okay, it looks like we really DO need an add expr. Check to see if we
1656 // already have one, otherwise create a new one.
Dan Gohman1c343752009-06-27 21:21:31 +00001657 FoldingSetNodeID ID;
1658 ID.AddInteger(scAddExpr);
1659 ID.AddInteger(Ops.size());
1660 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1661 ID.AddPointer(Ops[i]);
1662 void *IP = 0;
Dan Gohmana10756e2010-01-21 02:09:26 +00001663 SCEVAddExpr *S =
1664 static_cast<SCEVAddExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
1665 if (!S) {
Dan Gohmanf9e64722010-03-18 01:17:13 +00001666 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
1667 std::uninitialized_copy(Ops.begin(), Ops.end(), O);
Dan Gohman95531882010-03-18 18:49:47 +00001668 S = new (SCEVAllocator) SCEVAddExpr(ID.Intern(SCEVAllocator),
1669 O, Ops.size());
Dan Gohmana10756e2010-01-21 02:09:26 +00001670 UniqueSCEVs.InsertNode(S, IP);
1671 }
Dan Gohman3645b012009-10-09 00:10:36 +00001672 if (HasNUW) S->setHasNoUnsignedWrap(true);
1673 if (HasNSW) S->setHasNoSignedWrap(true);
Dan Gohman1c343752009-06-27 21:21:31 +00001674 return S;
Chris Lattner53e677a2004-04-02 20:23:17 +00001675}
1676
Dan Gohman6c0866c2009-05-24 23:45:28 +00001677/// getMulExpr - Get a canonical multiply expression, or something simpler if
1678/// possible.
Dan Gohman3645b012009-10-09 00:10:36 +00001679const SCEV *ScalarEvolution::getMulExpr(SmallVectorImpl<const SCEV *> &Ops,
1680 bool HasNUW, bool HasNSW) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001681 assert(!Ops.empty() && "Cannot get empty mul!");
Dan Gohmana10756e2010-01-21 02:09:26 +00001682 if (Ops.size() == 1) return Ops[0];
Dan Gohmanf78a9782009-05-18 15:44:58 +00001683#ifndef NDEBUG
1684 for (unsigned i = 1, e = Ops.size(); i != e; ++i)
1685 assert(getEffectiveSCEVType(Ops[i]->getType()) ==
1686 getEffectiveSCEVType(Ops[0]->getType()) &&
1687 "SCEVMulExpr operand types don't match!");
1688#endif
Chris Lattner53e677a2004-04-02 20:23:17 +00001689
Dan Gohmana10756e2010-01-21 02:09:26 +00001690 // If HasNSW is true and all the operands are non-negative, infer HasNUW.
1691 if (!HasNUW && HasNSW) {
1692 bool All = true;
1693 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1694 if (!isKnownNonNegative(Ops[i])) {
1695 All = false;
1696 break;
1697 }
1698 if (All) HasNUW = true;
1699 }
1700
Chris Lattner53e677a2004-04-02 20:23:17 +00001701 // Sort by complexity, this groups all similar expression types together.
Dan Gohman72861302009-05-07 14:39:04 +00001702 GroupByComplexity(Ops, LI);
Chris Lattner53e677a2004-04-02 20:23:17 +00001703
1704 // If there are any constants, fold them together.
1705 unsigned Idx = 0;
Dan Gohman622ed672009-05-04 22:02:23 +00001706 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001707
1708 // C1*(C2+V) -> C1*C2 + C1*V
1709 if (Ops.size() == 2)
Dan Gohman622ed672009-05-04 22:02:23 +00001710 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1]))
Chris Lattner53e677a2004-04-02 20:23:17 +00001711 if (Add->getNumOperands() == 2 &&
1712 isa<SCEVConstant>(Add->getOperand(0)))
Dan Gohman246b2562007-10-22 18:31:58 +00001713 return getAddExpr(getMulExpr(LHSC, Add->getOperand(0)),
1714 getMulExpr(LHSC, Add->getOperand(1)));
Chris Lattner53e677a2004-04-02 20:23:17 +00001715
Chris Lattner53e677a2004-04-02 20:23:17 +00001716 ++Idx;
Dan Gohman622ed672009-05-04 22:02:23 +00001717 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001718 // We found two constants, fold them together!
Owen Andersoneed707b2009-07-24 23:12:02 +00001719 ConstantInt *Fold = ConstantInt::get(getContext(),
1720 LHSC->getValue()->getValue() *
Nick Lewycky3e630762008-02-20 06:48:22 +00001721 RHSC->getValue()->getValue());
1722 Ops[0] = getConstant(Fold);
1723 Ops.erase(Ops.begin()+1); // Erase the folded element
1724 if (Ops.size() == 1) return Ops[0];
1725 LHSC = cast<SCEVConstant>(Ops[0]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001726 }
1727
1728 // If we are left with a constant one being multiplied, strip it off.
1729 if (cast<SCEVConstant>(Ops[0])->getValue()->equalsInt(1)) {
1730 Ops.erase(Ops.begin());
1731 --Idx;
Reid Spencercae57542007-03-02 00:28:52 +00001732 } else if (cast<SCEVConstant>(Ops[0])->getValue()->isZero()) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001733 // If we have a multiply of zero, it will always be zero.
1734 return Ops[0];
Dan Gohmana10756e2010-01-21 02:09:26 +00001735 } else if (Ops[0]->isAllOnesValue()) {
1736 // If we have a mul by -1 of an add, try distributing the -1 among the
1737 // add operands.
1738 if (Ops.size() == 2)
1739 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1])) {
1740 SmallVector<const SCEV *, 4> NewOps;
1741 bool AnyFolded = false;
1742 for (SCEVAddRecExpr::op_iterator I = Add->op_begin(), E = Add->op_end();
1743 I != E; ++I) {
1744 const SCEV *Mul = getMulExpr(Ops[0], *I);
1745 if (!isa<SCEVMulExpr>(Mul)) AnyFolded = true;
1746 NewOps.push_back(Mul);
1747 }
1748 if (AnyFolded)
1749 return getAddExpr(NewOps);
1750 }
Chris Lattner53e677a2004-04-02 20:23:17 +00001751 }
Dan Gohman3ab13122010-04-13 16:49:23 +00001752
1753 if (Ops.size() == 1)
1754 return Ops[0];
Chris Lattner53e677a2004-04-02 20:23:17 +00001755 }
1756
1757 // Skip over the add expression until we get to a multiply.
1758 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
1759 ++Idx;
1760
Chris Lattner53e677a2004-04-02 20:23:17 +00001761 // If there are mul operands inline them all into this expression.
1762 if (Idx < Ops.size()) {
1763 bool DeletedMul = false;
Dan Gohman622ed672009-05-04 22:02:23 +00001764 while (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001765 // If we have an mul, expand the mul operands onto the end of the operands
1766 // list.
Chris Lattner53e677a2004-04-02 20:23:17 +00001767 Ops.erase(Ops.begin()+Idx);
Dan Gohman403a8cd2010-06-21 19:47:52 +00001768 Ops.append(Mul->op_begin(), Mul->op_end());
Chris Lattner53e677a2004-04-02 20:23:17 +00001769 DeletedMul = true;
1770 }
1771
1772 // If we deleted at least one mul, we added operands to the end of the list,
1773 // and they are not necessarily sorted. Recurse to resort and resimplify
Dan Gohman3f46a3a2010-03-01 17:49:51 +00001774 // any operands we just acquired.
Chris Lattner53e677a2004-04-02 20:23:17 +00001775 if (DeletedMul)
Dan Gohman246b2562007-10-22 18:31:58 +00001776 return getMulExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001777 }
1778
1779 // If there are any add recurrences in the operands list, see if any other
1780 // added values are loop invariant. If so, we can fold them into the
1781 // recurrence.
1782 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
1783 ++Idx;
1784
1785 // Scan over all recurrences, trying to fold loop invariants into them.
1786 for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
1787 // Scan all of the other operands to this mul and add them to the vector if
1788 // they are loop invariant w.r.t. the recurrence.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001789 SmallVector<const SCEV *, 8> LIOps;
Dan Gohman35738ac2009-05-04 22:30:44 +00001790 const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001791 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1792 if (Ops[i]->isLoopInvariant(AddRec->getLoop())) {
1793 LIOps.push_back(Ops[i]);
1794 Ops.erase(Ops.begin()+i);
1795 --i; --e;
1796 }
1797
1798 // If we found some loop invariants, fold them into the recurrence.
1799 if (!LIOps.empty()) {
Dan Gohman8dae1382008-09-14 17:21:12 +00001800 // NLI * LI * {Start,+,Step} --> NLI * {LI*Start,+,LI*Step}
Dan Gohman0bba49c2009-07-07 17:06:11 +00001801 SmallVector<const SCEV *, 4> NewOps;
Chris Lattner53e677a2004-04-02 20:23:17 +00001802 NewOps.reserve(AddRec->getNumOperands());
Dan Gohman27ed6a42010-06-17 23:34:09 +00001803 const SCEV *Scale = getMulExpr(LIOps);
1804 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i)
1805 NewOps.push_back(getMulExpr(Scale, AddRec->getOperand(i)));
Chris Lattner53e677a2004-04-02 20:23:17 +00001806
Dan Gohmanb9f96512010-06-30 07:16:37 +00001807 // Build the new addrec. Propagate the NUW and NSW flags if both the
1808 // outer mul and the inner addrec are guaranteed to have no overflow.
Dan Gohmana10756e2010-01-21 02:09:26 +00001809 const SCEV *NewRec = getAddRecExpr(NewOps, AddRec->getLoop(),
1810 HasNUW && AddRec->hasNoUnsignedWrap(),
Dan Gohmanb9f96512010-06-30 07:16:37 +00001811 HasNSW && AddRec->hasNoSignedWrap());
Chris Lattner53e677a2004-04-02 20:23:17 +00001812
1813 // If all of the other operands were loop invariant, we are done.
1814 if (Ops.size() == 1) return NewRec;
1815
1816 // Otherwise, multiply the folded AddRec by the non-liv parts.
1817 for (unsigned i = 0;; ++i)
1818 if (Ops[i] == AddRec) {
1819 Ops[i] = NewRec;
1820 break;
1821 }
Dan Gohman246b2562007-10-22 18:31:58 +00001822 return getMulExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001823 }
1824
1825 // Okay, if there weren't any loop invariants to be folded, check to see if
1826 // there are multiple AddRec's with the same loop induction variable being
1827 // multiplied together. If so, we can fold them.
1828 for (unsigned OtherIdx = Idx+1;
1829 OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);++OtherIdx)
1830 if (OtherIdx != Idx) {
Dan Gohman35738ac2009-05-04 22:30:44 +00001831 const SCEVAddRecExpr *OtherAddRec = cast<SCEVAddRecExpr>(Ops[OtherIdx]);
Chris Lattner53e677a2004-04-02 20:23:17 +00001832 if (AddRec->getLoop() == OtherAddRec->getLoop()) {
1833 // F * G --> {A,+,B} * {C,+,D} --> {A*C,+,F*D + G*B + B*D}
Dan Gohman35738ac2009-05-04 22:30:44 +00001834 const SCEVAddRecExpr *F = AddRec, *G = OtherAddRec;
Dan Gohman0bba49c2009-07-07 17:06:11 +00001835 const SCEV *NewStart = getMulExpr(F->getStart(),
Chris Lattner53e677a2004-04-02 20:23:17 +00001836 G->getStart());
Dan Gohman0bba49c2009-07-07 17:06:11 +00001837 const SCEV *B = F->getStepRecurrence(*this);
1838 const SCEV *D = G->getStepRecurrence(*this);
1839 const SCEV *NewStep = getAddExpr(getMulExpr(F, D),
Dan Gohman246b2562007-10-22 18:31:58 +00001840 getMulExpr(G, B),
1841 getMulExpr(B, D));
Dan Gohman0bba49c2009-07-07 17:06:11 +00001842 const SCEV *NewAddRec = getAddRecExpr(NewStart, NewStep,
Dan Gohman246b2562007-10-22 18:31:58 +00001843 F->getLoop());
Chris Lattner53e677a2004-04-02 20:23:17 +00001844 if (Ops.size() == 2) return NewAddRec;
1845
1846 Ops.erase(Ops.begin()+Idx);
1847 Ops.erase(Ops.begin()+OtherIdx-1);
1848 Ops.push_back(NewAddRec);
Dan Gohman246b2562007-10-22 18:31:58 +00001849 return getMulExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00001850 }
1851 }
1852
1853 // Otherwise couldn't fold anything into this recurrence. Move onto the
1854 // next one.
1855 }
1856
1857 // Okay, it looks like we really DO need an mul expr. Check to see if we
1858 // already have one, otherwise create a new one.
Dan Gohman1c343752009-06-27 21:21:31 +00001859 FoldingSetNodeID ID;
1860 ID.AddInteger(scMulExpr);
1861 ID.AddInteger(Ops.size());
1862 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1863 ID.AddPointer(Ops[i]);
1864 void *IP = 0;
Dan Gohmana10756e2010-01-21 02:09:26 +00001865 SCEVMulExpr *S =
1866 static_cast<SCEVMulExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
1867 if (!S) {
Dan Gohmanf9e64722010-03-18 01:17:13 +00001868 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
1869 std::uninitialized_copy(Ops.begin(), Ops.end(), O);
Dan Gohman95531882010-03-18 18:49:47 +00001870 S = new (SCEVAllocator) SCEVMulExpr(ID.Intern(SCEVAllocator),
1871 O, Ops.size());
Dan Gohmana10756e2010-01-21 02:09:26 +00001872 UniqueSCEVs.InsertNode(S, IP);
1873 }
Dan Gohman3645b012009-10-09 00:10:36 +00001874 if (HasNUW) S->setHasNoUnsignedWrap(true);
1875 if (HasNSW) S->setHasNoSignedWrap(true);
Dan Gohman1c343752009-06-27 21:21:31 +00001876 return S;
Chris Lattner53e677a2004-04-02 20:23:17 +00001877}
1878
Andreas Bolka8a11c982009-08-07 22:55:26 +00001879/// getUDivExpr - Get a canonical unsigned division expression, or something
1880/// simpler if possible.
Dan Gohman9311ef62009-06-24 14:49:00 +00001881const SCEV *ScalarEvolution::getUDivExpr(const SCEV *LHS,
1882 const SCEV *RHS) {
Dan Gohmanf78a9782009-05-18 15:44:58 +00001883 assert(getEffectiveSCEVType(LHS->getType()) ==
1884 getEffectiveSCEVType(RHS->getType()) &&
1885 "SCEVUDivExpr operand types don't match!");
1886
Dan Gohman622ed672009-05-04 22:02:23 +00001887 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00001888 if (RHSC->getValue()->equalsInt(1))
Dan Gohman4c0d5d52009-08-20 16:42:55 +00001889 return LHS; // X udiv 1 --> x
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00001890 // If the denominator is zero, the result of the udiv is undefined. Don't
1891 // try to analyze it, because the resolution chosen here may differ from
1892 // the resolution chosen in other parts of the compiler.
1893 if (!RHSC->getValue()->isZero()) {
1894 // Determine if the division can be folded into the operands of
1895 // its operands.
1896 // TODO: Generalize this to non-constants by using known-bits information.
1897 const Type *Ty = LHS->getType();
1898 unsigned LZ = RHSC->getValue()->getValue().countLeadingZeros();
Dan Gohmanddd3a882010-08-04 19:52:50 +00001899 unsigned MaxShiftAmt = getTypeSizeInBits(Ty) - LZ - 1;
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00001900 // For non-power-of-two values, effectively round the value up to the
1901 // nearest power of two.
1902 if (!RHSC->getValue()->getValue().isPowerOf2())
1903 ++MaxShiftAmt;
1904 const IntegerType *ExtTy =
1905 IntegerType::get(getContext(), getTypeSizeInBits(Ty) + MaxShiftAmt);
1906 // {X,+,N}/C --> {X/C,+,N/C} if safe and N/C can be folded.
1907 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS))
1908 if (const SCEVConstant *Step =
1909 dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this)))
1910 if (!Step->getValue()->getValue()
1911 .urem(RHSC->getValue()->getValue()) &&
1912 getZeroExtendExpr(AR, ExtTy) ==
1913 getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy),
1914 getZeroExtendExpr(Step, ExtTy),
1915 AR->getLoop())) {
1916 SmallVector<const SCEV *, 4> Operands;
1917 for (unsigned i = 0, e = AR->getNumOperands(); i != e; ++i)
1918 Operands.push_back(getUDivExpr(AR->getOperand(i), RHS));
1919 return getAddRecExpr(Operands, AR->getLoop());
Dan Gohman185cf032009-05-08 20:18:49 +00001920 }
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00001921 // (A*B)/C --> A*(B/C) if safe and B/C can be folded.
1922 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(LHS)) {
1923 SmallVector<const SCEV *, 4> Operands;
1924 for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i)
1925 Operands.push_back(getZeroExtendExpr(M->getOperand(i), ExtTy));
1926 if (getZeroExtendExpr(M, ExtTy) == getMulExpr(Operands))
1927 // Find an operand that's safely divisible.
1928 for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i) {
1929 const SCEV *Op = M->getOperand(i);
1930 const SCEV *Div = getUDivExpr(Op, RHSC);
1931 if (!isa<SCEVUDivExpr>(Div) && getMulExpr(Div, RHSC) == Op) {
1932 Operands = SmallVector<const SCEV *, 4>(M->op_begin(),
1933 M->op_end());
1934 Operands[i] = Div;
1935 return getMulExpr(Operands);
1936 }
1937 }
Dan Gohman185cf032009-05-08 20:18:49 +00001938 }
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00001939 // (A+B)/C --> (A/C + B/C) if safe and A/C and B/C can be folded.
1940 if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(LHS)) {
1941 SmallVector<const SCEV *, 4> Operands;
1942 for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i)
1943 Operands.push_back(getZeroExtendExpr(A->getOperand(i), ExtTy));
1944 if (getZeroExtendExpr(A, ExtTy) == getAddExpr(Operands)) {
1945 Operands.clear();
1946 for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i) {
1947 const SCEV *Op = getUDivExpr(A->getOperand(i), RHS);
1948 if (isa<SCEVUDivExpr>(Op) ||
1949 getMulExpr(Op, RHS) != A->getOperand(i))
1950 break;
1951 Operands.push_back(Op);
1952 }
1953 if (Operands.size() == A->getNumOperands())
1954 return getAddExpr(Operands);
1955 }
1956 }
Dan Gohman185cf032009-05-08 20:18:49 +00001957
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00001958 // Fold if both operands are constant.
1959 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
1960 Constant *LHSCV = LHSC->getValue();
1961 Constant *RHSCV = RHSC->getValue();
1962 return getConstant(cast<ConstantInt>(ConstantExpr::getUDiv(LHSCV,
1963 RHSCV)));
1964 }
Chris Lattner53e677a2004-04-02 20:23:17 +00001965 }
1966 }
1967
Dan Gohman1c343752009-06-27 21:21:31 +00001968 FoldingSetNodeID ID;
1969 ID.AddInteger(scUDivExpr);
1970 ID.AddPointer(LHS);
1971 ID.AddPointer(RHS);
1972 void *IP = 0;
1973 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
Dan Gohman95531882010-03-18 18:49:47 +00001974 SCEV *S = new (SCEVAllocator) SCEVUDivExpr(ID.Intern(SCEVAllocator),
1975 LHS, RHS);
Dan Gohman1c343752009-06-27 21:21:31 +00001976 UniqueSCEVs.InsertNode(S, IP);
1977 return S;
Chris Lattner53e677a2004-04-02 20:23:17 +00001978}
1979
1980
Dan Gohman6c0866c2009-05-24 23:45:28 +00001981/// getAddRecExpr - Get an add recurrence expression for the specified loop.
1982/// Simplify the expression as much as possible.
Dan Gohman0bba49c2009-07-07 17:06:11 +00001983const SCEV *ScalarEvolution::getAddRecExpr(const SCEV *Start,
Dan Gohman3645b012009-10-09 00:10:36 +00001984 const SCEV *Step, const Loop *L,
1985 bool HasNUW, bool HasNSW) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00001986 SmallVector<const SCEV *, 4> Operands;
Chris Lattner53e677a2004-04-02 20:23:17 +00001987 Operands.push_back(Start);
Dan Gohman622ed672009-05-04 22:02:23 +00001988 if (const SCEVAddRecExpr *StepChrec = dyn_cast<SCEVAddRecExpr>(Step))
Chris Lattner53e677a2004-04-02 20:23:17 +00001989 if (StepChrec->getLoop() == L) {
Dan Gohman403a8cd2010-06-21 19:47:52 +00001990 Operands.append(StepChrec->op_begin(), StepChrec->op_end());
Dan Gohman246b2562007-10-22 18:31:58 +00001991 return getAddRecExpr(Operands, L);
Chris Lattner53e677a2004-04-02 20:23:17 +00001992 }
1993
1994 Operands.push_back(Step);
Dan Gohman3645b012009-10-09 00:10:36 +00001995 return getAddRecExpr(Operands, L, HasNUW, HasNSW);
Chris Lattner53e677a2004-04-02 20:23:17 +00001996}
1997
Dan Gohman6c0866c2009-05-24 23:45:28 +00001998/// getAddRecExpr - Get an add recurrence expression for the specified loop.
1999/// Simplify the expression as much as possible.
Dan Gohman64a845e2009-06-24 04:48:43 +00002000const SCEV *
Dan Gohman0bba49c2009-07-07 17:06:11 +00002001ScalarEvolution::getAddRecExpr(SmallVectorImpl<const SCEV *> &Operands,
Dan Gohman3645b012009-10-09 00:10:36 +00002002 const Loop *L,
2003 bool HasNUW, bool HasNSW) {
Chris Lattner53e677a2004-04-02 20:23:17 +00002004 if (Operands.size() == 1) return Operands[0];
Dan Gohmanf78a9782009-05-18 15:44:58 +00002005#ifndef NDEBUG
2006 for (unsigned i = 1, e = Operands.size(); i != e; ++i)
2007 assert(getEffectiveSCEVType(Operands[i]->getType()) ==
2008 getEffectiveSCEVType(Operands[0]->getType()) &&
2009 "SCEVAddRecExpr operand types don't match!");
2010#endif
Chris Lattner53e677a2004-04-02 20:23:17 +00002011
Dan Gohmancfeb6a42008-06-18 16:23:07 +00002012 if (Operands.back()->isZero()) {
2013 Operands.pop_back();
Dan Gohman3645b012009-10-09 00:10:36 +00002014 return getAddRecExpr(Operands, L, HasNUW, HasNSW); // {X,+,0} --> X
Dan Gohmancfeb6a42008-06-18 16:23:07 +00002015 }
Chris Lattner53e677a2004-04-02 20:23:17 +00002016
Dan Gohmanbc028532010-02-19 18:49:22 +00002017 // It's tempting to want to call getMaxBackedgeTakenCount count here and
2018 // use that information to infer NUW and NSW flags. However, computing a
2019 // BE count requires calling getAddRecExpr, so we may not yet have a
2020 // meaningful BE count at this point (and if we don't, we'd be stuck
2021 // with a SCEVCouldNotCompute as the cached BE count).
2022
Dan Gohmana10756e2010-01-21 02:09:26 +00002023 // If HasNSW is true and all the operands are non-negative, infer HasNUW.
2024 if (!HasNUW && HasNSW) {
2025 bool All = true;
2026 for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2027 if (!isKnownNonNegative(Operands[i])) {
2028 All = false;
2029 break;
2030 }
2031 if (All) HasNUW = true;
2032 }
2033
Dan Gohmand9cc7492008-08-08 18:33:12 +00002034 // Canonicalize nested AddRecs in by nesting them in order of loop depth.
Dan Gohman622ed672009-05-04 22:02:23 +00002035 if (const SCEVAddRecExpr *NestedAR = dyn_cast<SCEVAddRecExpr>(Operands[0])) {
Dan Gohman5d984912009-12-18 01:14:11 +00002036 const Loop *NestedLoop = NestedAR->getLoop();
Dan Gohmana10756e2010-01-21 02:09:26 +00002037 if (L->contains(NestedLoop->getHeader()) ?
2038 (L->getLoopDepth() < NestedLoop->getLoopDepth()) :
2039 (!NestedLoop->contains(L->getHeader()) &&
2040 DT->dominates(L->getHeader(), NestedLoop->getHeader()))) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00002041 SmallVector<const SCEV *, 4> NestedOperands(NestedAR->op_begin(),
Dan Gohman5d984912009-12-18 01:14:11 +00002042 NestedAR->op_end());
Dan Gohmand9cc7492008-08-08 18:33:12 +00002043 Operands[0] = NestedAR->getStart();
Dan Gohman9a80b452009-06-26 22:36:20 +00002044 // AddRecs require their operands be loop-invariant with respect to their
2045 // loops. Don't perform this transformation if it would break this
2046 // requirement.
2047 bool AllInvariant = true;
2048 for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2049 if (!Operands[i]->isLoopInvariant(L)) {
2050 AllInvariant = false;
2051 break;
2052 }
2053 if (AllInvariant) {
2054 NestedOperands[0] = getAddRecExpr(Operands, L);
2055 AllInvariant = true;
2056 for (unsigned i = 0, e = NestedOperands.size(); i != e; ++i)
2057 if (!NestedOperands[i]->isLoopInvariant(NestedLoop)) {
2058 AllInvariant = false;
2059 break;
2060 }
2061 if (AllInvariant)
2062 // Ok, both add recurrences are valid after the transformation.
Dan Gohman3645b012009-10-09 00:10:36 +00002063 return getAddRecExpr(NestedOperands, NestedLoop, HasNUW, HasNSW);
Dan Gohman9a80b452009-06-26 22:36:20 +00002064 }
2065 // Reset Operands to its original state.
2066 Operands[0] = NestedAR;
Dan Gohmand9cc7492008-08-08 18:33:12 +00002067 }
2068 }
2069
Dan Gohman67847532010-01-19 22:27:22 +00002070 // Okay, it looks like we really DO need an addrec expr. Check to see if we
2071 // already have one, otherwise create a new one.
Dan Gohman1c343752009-06-27 21:21:31 +00002072 FoldingSetNodeID ID;
2073 ID.AddInteger(scAddRecExpr);
2074 ID.AddInteger(Operands.size());
2075 for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2076 ID.AddPointer(Operands[i]);
2077 ID.AddPointer(L);
2078 void *IP = 0;
Dan Gohmana10756e2010-01-21 02:09:26 +00002079 SCEVAddRecExpr *S =
2080 static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2081 if (!S) {
Dan Gohmanf9e64722010-03-18 01:17:13 +00002082 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Operands.size());
2083 std::uninitialized_copy(Operands.begin(), Operands.end(), O);
Dan Gohman95531882010-03-18 18:49:47 +00002084 S = new (SCEVAllocator) SCEVAddRecExpr(ID.Intern(SCEVAllocator),
2085 O, Operands.size(), L);
Dan Gohmana10756e2010-01-21 02:09:26 +00002086 UniqueSCEVs.InsertNode(S, IP);
2087 }
Dan Gohman3645b012009-10-09 00:10:36 +00002088 if (HasNUW) S->setHasNoUnsignedWrap(true);
2089 if (HasNSW) S->setHasNoSignedWrap(true);
Dan Gohman1c343752009-06-27 21:21:31 +00002090 return S;
Chris Lattner53e677a2004-04-02 20:23:17 +00002091}
2092
Dan Gohman9311ef62009-06-24 14:49:00 +00002093const SCEV *ScalarEvolution::getSMaxExpr(const SCEV *LHS,
2094 const SCEV *RHS) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00002095 SmallVector<const SCEV *, 2> Ops;
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002096 Ops.push_back(LHS);
2097 Ops.push_back(RHS);
2098 return getSMaxExpr(Ops);
2099}
2100
Dan Gohman0bba49c2009-07-07 17:06:11 +00002101const SCEV *
2102ScalarEvolution::getSMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002103 assert(!Ops.empty() && "Cannot get empty smax!");
2104 if (Ops.size() == 1) return Ops[0];
Dan Gohmanf78a9782009-05-18 15:44:58 +00002105#ifndef NDEBUG
2106 for (unsigned i = 1, e = Ops.size(); i != e; ++i)
2107 assert(getEffectiveSCEVType(Ops[i]->getType()) ==
2108 getEffectiveSCEVType(Ops[0]->getType()) &&
2109 "SCEVSMaxExpr operand types don't match!");
2110#endif
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002111
2112 // Sort by complexity, this groups all similar expression types together.
Dan Gohman72861302009-05-07 14:39:04 +00002113 GroupByComplexity(Ops, LI);
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002114
2115 // If there are any constants, fold them together.
2116 unsigned Idx = 0;
Dan Gohman622ed672009-05-04 22:02:23 +00002117 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002118 ++Idx;
2119 assert(Idx < Ops.size());
Dan Gohman622ed672009-05-04 22:02:23 +00002120 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002121 // We found two constants, fold them together!
Owen Andersoneed707b2009-07-24 23:12:02 +00002122 ConstantInt *Fold = ConstantInt::get(getContext(),
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002123 APIntOps::smax(LHSC->getValue()->getValue(),
2124 RHSC->getValue()->getValue()));
Nick Lewycky3e630762008-02-20 06:48:22 +00002125 Ops[0] = getConstant(Fold);
2126 Ops.erase(Ops.begin()+1); // Erase the folded element
2127 if (Ops.size() == 1) return Ops[0];
2128 LHSC = cast<SCEVConstant>(Ops[0]);
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002129 }
2130
Dan Gohmane5aceed2009-06-24 14:46:22 +00002131 // If we are left with a constant minimum-int, strip it off.
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002132 if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(true)) {
2133 Ops.erase(Ops.begin());
2134 --Idx;
Dan Gohmane5aceed2009-06-24 14:46:22 +00002135 } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(true)) {
2136 // If we have an smax with a constant maximum-int, it will always be
2137 // maximum-int.
2138 return Ops[0];
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002139 }
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002140
Dan Gohman3ab13122010-04-13 16:49:23 +00002141 if (Ops.size() == 1) return Ops[0];
2142 }
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002143
2144 // Find the first SMax
2145 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scSMaxExpr)
2146 ++Idx;
2147
2148 // Check to see if one of the operands is an SMax. If so, expand its operands
2149 // onto our operand list, and recurse to simplify.
2150 if (Idx < Ops.size()) {
2151 bool DeletedSMax = false;
Dan Gohman622ed672009-05-04 22:02:23 +00002152 while (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(Ops[Idx])) {
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002153 Ops.erase(Ops.begin()+Idx);
Dan Gohman403a8cd2010-06-21 19:47:52 +00002154 Ops.append(SMax->op_begin(), SMax->op_end());
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002155 DeletedSMax = true;
2156 }
2157
2158 if (DeletedSMax)
2159 return getSMaxExpr(Ops);
2160 }
2161
2162 // Okay, check to see if the same value occurs in the operand list twice. If
2163 // so, delete one. Since we sorted the list, these values are required to
2164 // be adjacent.
2165 for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
Dan Gohman28287792010-04-13 16:51:03 +00002166 // X smax Y smax Y --> X smax Y
2167 // X smax Y --> X, if X is always greater than Y
2168 if (Ops[i] == Ops[i+1] ||
2169 isKnownPredicate(ICmpInst::ICMP_SGE, Ops[i], Ops[i+1])) {
2170 Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
2171 --i; --e;
2172 } else if (isKnownPredicate(ICmpInst::ICMP_SLE, Ops[i], Ops[i+1])) {
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002173 Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
2174 --i; --e;
2175 }
2176
2177 if (Ops.size() == 1) return Ops[0];
2178
2179 assert(!Ops.empty() && "Reduced smax down to nothing!");
2180
Nick Lewycky3e630762008-02-20 06:48:22 +00002181 // Okay, it looks like we really DO need an smax expr. Check to see if we
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002182 // already have one, otherwise create a new one.
Dan Gohman1c343752009-06-27 21:21:31 +00002183 FoldingSetNodeID ID;
2184 ID.AddInteger(scSMaxExpr);
2185 ID.AddInteger(Ops.size());
2186 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2187 ID.AddPointer(Ops[i]);
2188 void *IP = 0;
2189 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
Dan Gohmanf9e64722010-03-18 01:17:13 +00002190 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2191 std::uninitialized_copy(Ops.begin(), Ops.end(), O);
Dan Gohman95531882010-03-18 18:49:47 +00002192 SCEV *S = new (SCEVAllocator) SCEVSMaxExpr(ID.Intern(SCEVAllocator),
2193 O, Ops.size());
Dan Gohman1c343752009-06-27 21:21:31 +00002194 UniqueSCEVs.InsertNode(S, IP);
2195 return S;
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002196}
2197
Dan Gohman9311ef62009-06-24 14:49:00 +00002198const SCEV *ScalarEvolution::getUMaxExpr(const SCEV *LHS,
2199 const SCEV *RHS) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00002200 SmallVector<const SCEV *, 2> Ops;
Nick Lewycky3e630762008-02-20 06:48:22 +00002201 Ops.push_back(LHS);
2202 Ops.push_back(RHS);
2203 return getUMaxExpr(Ops);
2204}
2205
Dan Gohman0bba49c2009-07-07 17:06:11 +00002206const SCEV *
2207ScalarEvolution::getUMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
Nick Lewycky3e630762008-02-20 06:48:22 +00002208 assert(!Ops.empty() && "Cannot get empty umax!");
2209 if (Ops.size() == 1) return Ops[0];
Dan Gohmanf78a9782009-05-18 15:44:58 +00002210#ifndef NDEBUG
2211 for (unsigned i = 1, e = Ops.size(); i != e; ++i)
2212 assert(getEffectiveSCEVType(Ops[i]->getType()) ==
2213 getEffectiveSCEVType(Ops[0]->getType()) &&
2214 "SCEVUMaxExpr operand types don't match!");
2215#endif
Nick Lewycky3e630762008-02-20 06:48:22 +00002216
2217 // Sort by complexity, this groups all similar expression types together.
Dan Gohman72861302009-05-07 14:39:04 +00002218 GroupByComplexity(Ops, LI);
Nick Lewycky3e630762008-02-20 06:48:22 +00002219
2220 // If there are any constants, fold them together.
2221 unsigned Idx = 0;
Dan Gohman622ed672009-05-04 22:02:23 +00002222 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
Nick Lewycky3e630762008-02-20 06:48:22 +00002223 ++Idx;
2224 assert(Idx < Ops.size());
Dan Gohman622ed672009-05-04 22:02:23 +00002225 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
Nick Lewycky3e630762008-02-20 06:48:22 +00002226 // We found two constants, fold them together!
Owen Andersoneed707b2009-07-24 23:12:02 +00002227 ConstantInt *Fold = ConstantInt::get(getContext(),
Nick Lewycky3e630762008-02-20 06:48:22 +00002228 APIntOps::umax(LHSC->getValue()->getValue(),
2229 RHSC->getValue()->getValue()));
2230 Ops[0] = getConstant(Fold);
2231 Ops.erase(Ops.begin()+1); // Erase the folded element
2232 if (Ops.size() == 1) return Ops[0];
2233 LHSC = cast<SCEVConstant>(Ops[0]);
2234 }
2235
Dan Gohmane5aceed2009-06-24 14:46:22 +00002236 // If we are left with a constant minimum-int, strip it off.
Nick Lewycky3e630762008-02-20 06:48:22 +00002237 if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(false)) {
2238 Ops.erase(Ops.begin());
2239 --Idx;
Dan Gohmane5aceed2009-06-24 14:46:22 +00002240 } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(false)) {
2241 // If we have an umax with a constant maximum-int, it will always be
2242 // maximum-int.
2243 return Ops[0];
Nick Lewycky3e630762008-02-20 06:48:22 +00002244 }
Nick Lewycky3e630762008-02-20 06:48:22 +00002245
Dan Gohman3ab13122010-04-13 16:49:23 +00002246 if (Ops.size() == 1) return Ops[0];
2247 }
Nick Lewycky3e630762008-02-20 06:48:22 +00002248
2249 // Find the first UMax
2250 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scUMaxExpr)
2251 ++Idx;
2252
2253 // Check to see if one of the operands is a UMax. If so, expand its operands
2254 // onto our operand list, and recurse to simplify.
2255 if (Idx < Ops.size()) {
2256 bool DeletedUMax = false;
Dan Gohman622ed672009-05-04 22:02:23 +00002257 while (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(Ops[Idx])) {
Nick Lewycky3e630762008-02-20 06:48:22 +00002258 Ops.erase(Ops.begin()+Idx);
Dan Gohman403a8cd2010-06-21 19:47:52 +00002259 Ops.append(UMax->op_begin(), UMax->op_end());
Nick Lewycky3e630762008-02-20 06:48:22 +00002260 DeletedUMax = true;
2261 }
2262
2263 if (DeletedUMax)
2264 return getUMaxExpr(Ops);
2265 }
2266
2267 // Okay, check to see if the same value occurs in the operand list twice. If
2268 // so, delete one. Since we sorted the list, these values are required to
2269 // be adjacent.
2270 for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
Dan Gohman28287792010-04-13 16:51:03 +00002271 // X umax Y umax Y --> X umax Y
2272 // X umax Y --> X, if X is always greater than Y
2273 if (Ops[i] == Ops[i+1] ||
2274 isKnownPredicate(ICmpInst::ICMP_UGE, Ops[i], Ops[i+1])) {
2275 Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
2276 --i; --e;
2277 } else if (isKnownPredicate(ICmpInst::ICMP_ULE, Ops[i], Ops[i+1])) {
Nick Lewycky3e630762008-02-20 06:48:22 +00002278 Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
2279 --i; --e;
2280 }
2281
2282 if (Ops.size() == 1) return Ops[0];
2283
2284 assert(!Ops.empty() && "Reduced umax down to nothing!");
2285
2286 // Okay, it looks like we really DO need a umax expr. Check to see if we
2287 // already have one, otherwise create a new one.
Dan Gohman1c343752009-06-27 21:21:31 +00002288 FoldingSetNodeID ID;
2289 ID.AddInteger(scUMaxExpr);
2290 ID.AddInteger(Ops.size());
2291 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2292 ID.AddPointer(Ops[i]);
2293 void *IP = 0;
2294 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
Dan Gohmanf9e64722010-03-18 01:17:13 +00002295 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2296 std::uninitialized_copy(Ops.begin(), Ops.end(), O);
Dan Gohman95531882010-03-18 18:49:47 +00002297 SCEV *S = new (SCEVAllocator) SCEVUMaxExpr(ID.Intern(SCEVAllocator),
2298 O, Ops.size());
Dan Gohman1c343752009-06-27 21:21:31 +00002299 UniqueSCEVs.InsertNode(S, IP);
2300 return S;
Nick Lewycky3e630762008-02-20 06:48:22 +00002301}
2302
Dan Gohman9311ef62009-06-24 14:49:00 +00002303const SCEV *ScalarEvolution::getSMinExpr(const SCEV *LHS,
2304 const SCEV *RHS) {
Dan Gohmanf9a9a992009-06-22 03:18:45 +00002305 // ~smax(~x, ~y) == smin(x, y).
2306 return getNotSCEV(getSMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
2307}
2308
Dan Gohman9311ef62009-06-24 14:49:00 +00002309const SCEV *ScalarEvolution::getUMinExpr(const SCEV *LHS,
2310 const SCEV *RHS) {
Dan Gohmanf9a9a992009-06-22 03:18:45 +00002311 // ~umax(~x, ~y) == umin(x, y)
2312 return getNotSCEV(getUMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
2313}
2314
Dan Gohman4f8eea82010-02-01 18:27:38 +00002315const SCEV *ScalarEvolution::getSizeOfExpr(const Type *AllocTy) {
Dan Gohman6ab10f62010-04-12 23:03:26 +00002316 // If we have TargetData, we can bypass creating a target-independent
2317 // constant expression and then folding it back into a ConstantInt.
2318 // This is just a compile-time optimization.
2319 if (TD)
2320 return getConstant(TD->getIntPtrType(getContext()),
2321 TD->getTypeAllocSize(AllocTy));
2322
Dan Gohman4f8eea82010-02-01 18:27:38 +00002323 Constant *C = ConstantExpr::getSizeOf(AllocTy);
2324 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
Dan Gohman70001222010-05-28 16:12:08 +00002325 if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
2326 C = Folded;
Dan Gohman4f8eea82010-02-01 18:27:38 +00002327 const Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(AllocTy));
2328 return getTruncateOrZeroExtend(getSCEV(C), Ty);
2329}
2330
2331const SCEV *ScalarEvolution::getAlignOfExpr(const Type *AllocTy) {
2332 Constant *C = ConstantExpr::getAlignOf(AllocTy);
2333 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
Dan Gohman70001222010-05-28 16:12:08 +00002334 if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
2335 C = Folded;
Dan Gohman4f8eea82010-02-01 18:27:38 +00002336 const Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(AllocTy));
2337 return getTruncateOrZeroExtend(getSCEV(C), Ty);
2338}
2339
2340const SCEV *ScalarEvolution::getOffsetOfExpr(const StructType *STy,
2341 unsigned FieldNo) {
Dan Gohman6ab10f62010-04-12 23:03:26 +00002342 // If we have TargetData, we can bypass creating a target-independent
2343 // constant expression and then folding it back into a ConstantInt.
2344 // This is just a compile-time optimization.
2345 if (TD)
2346 return getConstant(TD->getIntPtrType(getContext()),
2347 TD->getStructLayout(STy)->getElementOffset(FieldNo));
2348
Dan Gohman0f5efe52010-01-28 02:15:55 +00002349 Constant *C = ConstantExpr::getOffsetOf(STy, FieldNo);
2350 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
Dan Gohman70001222010-05-28 16:12:08 +00002351 if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
2352 C = Folded;
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002353 const Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(STy));
Dan Gohman0f5efe52010-01-28 02:15:55 +00002354 return getTruncateOrZeroExtend(getSCEV(C), Ty);
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002355}
2356
Dan Gohman4f8eea82010-02-01 18:27:38 +00002357const SCEV *ScalarEvolution::getOffsetOfExpr(const Type *CTy,
2358 Constant *FieldNo) {
2359 Constant *C = ConstantExpr::getOffsetOf(CTy, FieldNo);
Dan Gohman0f5efe52010-01-28 02:15:55 +00002360 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
Dan Gohman70001222010-05-28 16:12:08 +00002361 if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
2362 C = Folded;
Dan Gohman4f8eea82010-02-01 18:27:38 +00002363 const Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(CTy));
Dan Gohman0f5efe52010-01-28 02:15:55 +00002364 return getTruncateOrZeroExtend(getSCEV(C), Ty);
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002365}
2366
Dan Gohman0bba49c2009-07-07 17:06:11 +00002367const SCEV *ScalarEvolution::getUnknown(Value *V) {
Dan Gohman6bbcba12009-06-24 00:54:57 +00002368 // Don't attempt to do anything other than create a SCEVUnknown object
2369 // here. createSCEV only calls getUnknown after checking for all other
2370 // interesting possibilities, and any other code that calls getUnknown
2371 // is doing so in order to hide a value from SCEV canonicalization.
2372
Dan Gohman1c343752009-06-27 21:21:31 +00002373 FoldingSetNodeID ID;
2374 ID.AddInteger(scUnknown);
2375 ID.AddPointer(V);
2376 void *IP = 0;
Dan Gohmanab37f502010-08-02 23:49:30 +00002377 if (SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) {
2378 assert(cast<SCEVUnknown>(S)->getValue() == V &&
2379 "Stale SCEVUnknown in uniquing map!");
2380 return S;
2381 }
2382 SCEV *S = new (SCEVAllocator) SCEVUnknown(ID.Intern(SCEVAllocator), V, this,
2383 FirstUnknown);
2384 FirstUnknown = cast<SCEVUnknown>(S);
Dan Gohman1c343752009-06-27 21:21:31 +00002385 UniqueSCEVs.InsertNode(S, IP);
2386 return S;
Chris Lattner0a7f98c2004-04-15 15:07:24 +00002387}
2388
Chris Lattner53e677a2004-04-02 20:23:17 +00002389//===----------------------------------------------------------------------===//
Chris Lattner53e677a2004-04-02 20:23:17 +00002390// Basic SCEV Analysis and PHI Idiom Recognition Code
2391//
2392
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002393/// isSCEVable - Test if values of the given type are analyzable within
2394/// the SCEV framework. This primarily includes integer types, and it
2395/// can optionally include pointer types if the ScalarEvolution class
2396/// has access to target-specific information.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002397bool ScalarEvolution::isSCEVable(const Type *Ty) const {
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002398 // Integers and pointers are always SCEVable.
Duncan Sands1df98592010-02-16 11:11:14 +00002399 return Ty->isIntegerTy() || Ty->isPointerTy();
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002400}
2401
2402/// getTypeSizeInBits - Return the size in bits of the specified type,
2403/// for which isSCEVable must return true.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002404uint64_t ScalarEvolution::getTypeSizeInBits(const Type *Ty) const {
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002405 assert(isSCEVable(Ty) && "Type is not SCEVable!");
2406
2407 // If we have a TargetData, use it!
2408 if (TD)
2409 return TD->getTypeSizeInBits(Ty);
2410
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002411 // Integer types have fixed sizes.
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00002412 if (Ty->isIntegerTy())
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002413 return Ty->getPrimitiveSizeInBits();
2414
2415 // The only other support type is pointer. Without TargetData, conservatively
2416 // assume pointers are 64-bit.
Duncan Sands1df98592010-02-16 11:11:14 +00002417 assert(Ty->isPointerTy() && "isSCEVable permitted a non-SCEVable type!");
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002418 return 64;
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002419}
2420
2421/// getEffectiveSCEVType - Return a type with the same bitwidth as
2422/// the given type and which represents how SCEV will treat the given
2423/// type, for which isSCEVable must return true. For pointer types,
2424/// this is the pointer-sized integer type.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002425const Type *ScalarEvolution::getEffectiveSCEVType(const Type *Ty) const {
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002426 assert(isSCEVable(Ty) && "Type is not SCEVable!");
2427
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00002428 if (Ty->isIntegerTy())
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002429 return Ty;
2430
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002431 // The only other support type is pointer.
Duncan Sands1df98592010-02-16 11:11:14 +00002432 assert(Ty->isPointerTy() && "Unexpected non-pointer non-integer type!");
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002433 if (TD) return TD->getIntPtrType(getContext());
2434
2435 // Without TargetData, conservatively assume pointers are 64-bit.
2436 return Type::getInt64Ty(getContext());
Dan Gohman2d1be872009-04-16 03:18:22 +00002437}
Chris Lattner53e677a2004-04-02 20:23:17 +00002438
Dan Gohman0bba49c2009-07-07 17:06:11 +00002439const SCEV *ScalarEvolution::getCouldNotCompute() {
Dan Gohman1c343752009-06-27 21:21:31 +00002440 return &CouldNotCompute;
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00002441}
2442
Chris Lattner53e677a2004-04-02 20:23:17 +00002443/// getSCEV - Return an existing SCEV if it exists, otherwise analyze the
2444/// expression and create a new one.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002445const SCEV *ScalarEvolution::getSCEV(Value *V) {
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002446 assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
Chris Lattner53e677a2004-04-02 20:23:17 +00002447
Dan Gohman0bba49c2009-07-07 17:06:11 +00002448 std::map<SCEVCallbackVH, const SCEV *>::iterator I = Scalars.find(V);
Chris Lattner53e677a2004-04-02 20:23:17 +00002449 if (I != Scalars.end()) return I->second;
Dan Gohman0bba49c2009-07-07 17:06:11 +00002450 const SCEV *S = createSCEV(V);
Dan Gohman35738ac2009-05-04 22:30:44 +00002451 Scalars.insert(std::make_pair(SCEVCallbackVH(V, this), S));
Chris Lattner53e677a2004-04-02 20:23:17 +00002452 return S;
2453}
2454
Dan Gohman2d1be872009-04-16 03:18:22 +00002455/// getNegativeSCEV - Return a SCEV corresponding to -V = -1*V
2456///
Dan Gohman0bba49c2009-07-07 17:06:11 +00002457const SCEV *ScalarEvolution::getNegativeSCEV(const SCEV *V) {
Dan Gohman622ed672009-05-04 22:02:23 +00002458 if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
Owen Anderson0a5372e2009-07-13 04:09:18 +00002459 return getConstant(
Owen Andersonbaf3c402009-07-29 18:55:55 +00002460 cast<ConstantInt>(ConstantExpr::getNeg(VC->getValue())));
Dan Gohman2d1be872009-04-16 03:18:22 +00002461
2462 const Type *Ty = V->getType();
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002463 Ty = getEffectiveSCEVType(Ty);
Owen Anderson73c6b712009-07-13 20:58:05 +00002464 return getMulExpr(V,
Owen Andersona7235ea2009-07-31 20:28:14 +00002465 getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty))));
Dan Gohman2d1be872009-04-16 03:18:22 +00002466}
2467
2468/// getNotSCEV - Return a SCEV corresponding to ~V = -1-V
Dan Gohman0bba49c2009-07-07 17:06:11 +00002469const SCEV *ScalarEvolution::getNotSCEV(const SCEV *V) {
Dan Gohman622ed672009-05-04 22:02:23 +00002470 if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
Owen Anderson73c6b712009-07-13 20:58:05 +00002471 return getConstant(
Owen Andersonbaf3c402009-07-29 18:55:55 +00002472 cast<ConstantInt>(ConstantExpr::getNot(VC->getValue())));
Dan Gohman2d1be872009-04-16 03:18:22 +00002473
2474 const Type *Ty = V->getType();
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002475 Ty = getEffectiveSCEVType(Ty);
Owen Anderson73c6b712009-07-13 20:58:05 +00002476 const SCEV *AllOnes =
Owen Andersona7235ea2009-07-31 20:28:14 +00002477 getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty)));
Dan Gohman2d1be872009-04-16 03:18:22 +00002478 return getMinusSCEV(AllOnes, V);
2479}
2480
2481/// getMinusSCEV - Return a SCEV corresponding to LHS - RHS.
2482///
Dan Gohman9311ef62009-06-24 14:49:00 +00002483const SCEV *ScalarEvolution::getMinusSCEV(const SCEV *LHS,
2484 const SCEV *RHS) {
Dan Gohmaneb4152c2010-07-20 16:53:00 +00002485 // Fast path: X - X --> 0.
2486 if (LHS == RHS)
2487 return getConstant(LHS->getType(), 0);
2488
Dan Gohman2d1be872009-04-16 03:18:22 +00002489 // X - Y --> X + -Y
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002490 return getAddExpr(LHS, getNegativeSCEV(RHS));
Dan Gohman2d1be872009-04-16 03:18:22 +00002491}
2492
2493/// getTruncateOrZeroExtend - Return a SCEV corresponding to a conversion of the
2494/// input value to the specified type. If the type must be extended, it is zero
2495/// extended.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002496const SCEV *
2497ScalarEvolution::getTruncateOrZeroExtend(const SCEV *V,
Nick Lewycky5cd28fa2009-04-23 05:15:08 +00002498 const Type *Ty) {
Dan Gohman2d1be872009-04-16 03:18:22 +00002499 const Type *SrcTy = V->getType();
Duncan Sands1df98592010-02-16 11:11:14 +00002500 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2501 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Dan Gohman2d1be872009-04-16 03:18:22 +00002502 "Cannot truncate or zero extend with non-integer arguments!");
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002503 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
Dan Gohman2d1be872009-04-16 03:18:22 +00002504 return V; // No conversion
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002505 if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002506 return getTruncateExpr(V, Ty);
2507 return getZeroExtendExpr(V, Ty);
Dan Gohman2d1be872009-04-16 03:18:22 +00002508}
2509
2510/// getTruncateOrSignExtend - Return a SCEV corresponding to a conversion of the
2511/// input value to the specified type. If the type must be extended, it is sign
2512/// extended.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002513const SCEV *
2514ScalarEvolution::getTruncateOrSignExtend(const SCEV *V,
Nick Lewycky5cd28fa2009-04-23 05:15:08 +00002515 const Type *Ty) {
Dan Gohman2d1be872009-04-16 03:18:22 +00002516 const Type *SrcTy = V->getType();
Duncan Sands1df98592010-02-16 11:11:14 +00002517 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2518 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Dan Gohman2d1be872009-04-16 03:18:22 +00002519 "Cannot truncate or zero extend with non-integer arguments!");
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002520 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
Dan Gohman2d1be872009-04-16 03:18:22 +00002521 return V; // No conversion
Dan Gohmanaf79fb52009-04-21 01:07:12 +00002522 if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002523 return getTruncateExpr(V, Ty);
2524 return getSignExtendExpr(V, Ty);
Dan Gohman2d1be872009-04-16 03:18:22 +00002525}
2526
Dan Gohman467c4302009-05-13 03:46:30 +00002527/// getNoopOrZeroExtend - Return a SCEV corresponding to a conversion of the
2528/// input value to the specified type. If the type must be extended, it is zero
2529/// extended. The conversion must not be narrowing.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002530const SCEV *
2531ScalarEvolution::getNoopOrZeroExtend(const SCEV *V, const Type *Ty) {
Dan Gohman467c4302009-05-13 03:46:30 +00002532 const Type *SrcTy = V->getType();
Duncan Sands1df98592010-02-16 11:11:14 +00002533 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2534 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Dan Gohman467c4302009-05-13 03:46:30 +00002535 "Cannot noop or zero extend with non-integer arguments!");
2536 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2537 "getNoopOrZeroExtend cannot truncate!");
2538 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2539 return V; // No conversion
2540 return getZeroExtendExpr(V, Ty);
2541}
2542
2543/// getNoopOrSignExtend - Return a SCEV corresponding to a conversion of the
2544/// input value to the specified type. If the type must be extended, it is sign
2545/// extended. The conversion must not be narrowing.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002546const SCEV *
2547ScalarEvolution::getNoopOrSignExtend(const SCEV *V, const Type *Ty) {
Dan Gohman467c4302009-05-13 03:46:30 +00002548 const Type *SrcTy = V->getType();
Duncan Sands1df98592010-02-16 11:11:14 +00002549 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2550 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Dan Gohman467c4302009-05-13 03:46:30 +00002551 "Cannot noop or sign extend with non-integer arguments!");
2552 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2553 "getNoopOrSignExtend cannot truncate!");
2554 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2555 return V; // No conversion
2556 return getSignExtendExpr(V, Ty);
2557}
2558
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00002559/// getNoopOrAnyExtend - Return a SCEV corresponding to a conversion of
2560/// the input value to the specified type. If the type must be extended,
2561/// it is extended with unspecified bits. The conversion must not be
2562/// narrowing.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002563const SCEV *
2564ScalarEvolution::getNoopOrAnyExtend(const SCEV *V, const Type *Ty) {
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00002565 const Type *SrcTy = V->getType();
Duncan Sands1df98592010-02-16 11:11:14 +00002566 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2567 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Dan Gohman2ce84c8d2009-06-13 15:56:47 +00002568 "Cannot noop or any extend with non-integer arguments!");
2569 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2570 "getNoopOrAnyExtend cannot truncate!");
2571 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2572 return V; // No conversion
2573 return getAnyExtendExpr(V, Ty);
2574}
2575
Dan Gohman467c4302009-05-13 03:46:30 +00002576/// getTruncateOrNoop - Return a SCEV corresponding to a conversion of the
2577/// input value to the specified type. The conversion must not be widening.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002578const SCEV *
2579ScalarEvolution::getTruncateOrNoop(const SCEV *V, const Type *Ty) {
Dan Gohman467c4302009-05-13 03:46:30 +00002580 const Type *SrcTy = V->getType();
Duncan Sands1df98592010-02-16 11:11:14 +00002581 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2582 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
Dan Gohman467c4302009-05-13 03:46:30 +00002583 "Cannot truncate or noop with non-integer arguments!");
2584 assert(getTypeSizeInBits(SrcTy) >= getTypeSizeInBits(Ty) &&
2585 "getTruncateOrNoop cannot extend!");
2586 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2587 return V; // No conversion
2588 return getTruncateExpr(V, Ty);
2589}
2590
Dan Gohmana334aa72009-06-22 00:31:57 +00002591/// getUMaxFromMismatchedTypes - Promote the operands to the wider of
2592/// the types using zero-extension, and then perform a umax operation
2593/// with them.
Dan Gohman9311ef62009-06-24 14:49:00 +00002594const SCEV *ScalarEvolution::getUMaxFromMismatchedTypes(const SCEV *LHS,
2595 const SCEV *RHS) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00002596 const SCEV *PromotedLHS = LHS;
2597 const SCEV *PromotedRHS = RHS;
Dan Gohmana334aa72009-06-22 00:31:57 +00002598
2599 if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
2600 PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
2601 else
2602 PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
2603
2604 return getUMaxExpr(PromotedLHS, PromotedRHS);
2605}
2606
Dan Gohmanc9759e82009-06-22 15:03:27 +00002607/// getUMinFromMismatchedTypes - Promote the operands to the wider of
2608/// the types using zero-extension, and then perform a umin operation
2609/// with them.
Dan Gohman9311ef62009-06-24 14:49:00 +00002610const SCEV *ScalarEvolution::getUMinFromMismatchedTypes(const SCEV *LHS,
2611 const SCEV *RHS) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00002612 const SCEV *PromotedLHS = LHS;
2613 const SCEV *PromotedRHS = RHS;
Dan Gohmanc9759e82009-06-22 15:03:27 +00002614
2615 if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
2616 PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
2617 else
2618 PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
2619
2620 return getUMinExpr(PromotedLHS, PromotedRHS);
2621}
2622
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002623/// PushDefUseChildren - Push users of the given Instruction
2624/// onto the given Worklist.
2625static void
2626PushDefUseChildren(Instruction *I,
2627 SmallVectorImpl<Instruction *> &Worklist) {
2628 // Push the def-use children onto the Worklist stack.
2629 for (Value::use_iterator UI = I->use_begin(), UE = I->use_end();
2630 UI != UE; ++UI)
Gabor Greif96f1d8e2010-07-22 13:36:47 +00002631 Worklist.push_back(cast<Instruction>(*UI));
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002632}
2633
2634/// ForgetSymbolicValue - This looks up computed SCEV values for all
2635/// instructions that depend on the given instruction and removes them from
2636/// the Scalars map if they reference SymName. This is used during PHI
2637/// resolution.
Dan Gohman64a845e2009-06-24 04:48:43 +00002638void
Dan Gohman85669632010-02-25 06:57:05 +00002639ScalarEvolution::ForgetSymbolicName(Instruction *PN, const SCEV *SymName) {
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002640 SmallVector<Instruction *, 16> Worklist;
Dan Gohman85669632010-02-25 06:57:05 +00002641 PushDefUseChildren(PN, Worklist);
Chris Lattner53e677a2004-04-02 20:23:17 +00002642
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002643 SmallPtrSet<Instruction *, 8> Visited;
Dan Gohman85669632010-02-25 06:57:05 +00002644 Visited.insert(PN);
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002645 while (!Worklist.empty()) {
Dan Gohman85669632010-02-25 06:57:05 +00002646 Instruction *I = Worklist.pop_back_val();
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002647 if (!Visited.insert(I)) continue;
Chris Lattner4dc534c2005-02-13 04:37:18 +00002648
Dan Gohman5d984912009-12-18 01:14:11 +00002649 std::map<SCEVCallbackVH, const SCEV *>::iterator It =
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002650 Scalars.find(static_cast<Value *>(I));
2651 if (It != Scalars.end()) {
2652 // Short-circuit the def-use traversal if the symbolic name
2653 // ceases to appear in expressions.
Dan Gohman50922bb2010-02-15 10:28:37 +00002654 if (It->second != SymName && !It->second->hasOperand(SymName))
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002655 continue;
Chris Lattner4dc534c2005-02-13 04:37:18 +00002656
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002657 // SCEVUnknown for a PHI either means that it has an unrecognized
Dan Gohman85669632010-02-25 06:57:05 +00002658 // structure, it's a PHI that's in the progress of being computed
2659 // by createNodeForPHI, or it's a single-value PHI. In the first case,
2660 // additional loop trip count information isn't going to change anything.
2661 // In the second case, createNodeForPHI will perform the necessary
2662 // updates on its own when it gets to that point. In the third, we do
2663 // want to forget the SCEVUnknown.
2664 if (!isa<PHINode>(I) ||
2665 !isa<SCEVUnknown>(It->second) ||
2666 (I != PN && It->second == SymName)) {
Dan Gohman42214892009-08-31 21:15:23 +00002667 ValuesAtScopes.erase(It->second);
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002668 Scalars.erase(It);
Dan Gohman42214892009-08-31 21:15:23 +00002669 }
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002670 }
2671
2672 PushDefUseChildren(I, Worklist);
2673 }
Chris Lattner4dc534c2005-02-13 04:37:18 +00002674}
Chris Lattner53e677a2004-04-02 20:23:17 +00002675
2676/// createNodeForPHI - PHI nodes have two cases. Either the PHI node exists in
2677/// a loop header, making it a potential recurrence, or it doesn't.
2678///
Dan Gohman0bba49c2009-07-07 17:06:11 +00002679const SCEV *ScalarEvolution::createNodeForPHI(PHINode *PN) {
Dan Gohman27dead42010-04-12 07:49:36 +00002680 if (const Loop *L = LI->getLoopFor(PN->getParent()))
2681 if (L->getHeader() == PN->getParent()) {
2682 // The loop may have multiple entrances or multiple exits; we can analyze
2683 // this phi as an addrec if it has a unique entry value and a unique
2684 // backedge value.
2685 Value *BEValueV = 0, *StartValueV = 0;
2686 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
2687 Value *V = PN->getIncomingValue(i);
2688 if (L->contains(PN->getIncomingBlock(i))) {
2689 if (!BEValueV) {
2690 BEValueV = V;
2691 } else if (BEValueV != V) {
2692 BEValueV = 0;
2693 break;
2694 }
2695 } else if (!StartValueV) {
2696 StartValueV = V;
2697 } else if (StartValueV != V) {
2698 StartValueV = 0;
2699 break;
2700 }
2701 }
2702 if (BEValueV && StartValueV) {
Chris Lattner53e677a2004-04-02 20:23:17 +00002703 // While we are analyzing this PHI node, handle its value symbolically.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002704 const SCEV *SymbolicName = getUnknown(PN);
Chris Lattner53e677a2004-04-02 20:23:17 +00002705 assert(Scalars.find(PN) == Scalars.end() &&
2706 "PHI node already processed?");
Dan Gohman35738ac2009-05-04 22:30:44 +00002707 Scalars.insert(std::make_pair(SCEVCallbackVH(PN, this), SymbolicName));
Chris Lattner53e677a2004-04-02 20:23:17 +00002708
2709 // Using this symbolic name for the PHI, analyze the value coming around
2710 // the back-edge.
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002711 const SCEV *BEValue = getSCEV(BEValueV);
Chris Lattner53e677a2004-04-02 20:23:17 +00002712
2713 // NOTE: If BEValue is loop invariant, we know that the PHI node just
2714 // has a special value for the first iteration of the loop.
2715
2716 // If the value coming around the backedge is an add with the symbolic
2717 // value we just inserted, then we found a simple induction variable!
Dan Gohman622ed672009-05-04 22:02:23 +00002718 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(BEValue)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00002719 // If there is a single occurrence of the symbolic value, replace it
2720 // with a recurrence.
2721 unsigned FoundIndex = Add->getNumOperands();
2722 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
2723 if (Add->getOperand(i) == SymbolicName)
2724 if (FoundIndex == e) {
2725 FoundIndex = i;
2726 break;
2727 }
2728
2729 if (FoundIndex != Add->getNumOperands()) {
2730 // Create an add with everything but the specified operand.
Dan Gohman0bba49c2009-07-07 17:06:11 +00002731 SmallVector<const SCEV *, 8> Ops;
Chris Lattner53e677a2004-04-02 20:23:17 +00002732 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
2733 if (i != FoundIndex)
2734 Ops.push_back(Add->getOperand(i));
Dan Gohman0bba49c2009-07-07 17:06:11 +00002735 const SCEV *Accum = getAddExpr(Ops);
Chris Lattner53e677a2004-04-02 20:23:17 +00002736
2737 // This is not a valid addrec if the step amount is varying each
2738 // loop iteration, but is not itself an addrec in this loop.
2739 if (Accum->isLoopInvariant(L) ||
2740 (isa<SCEVAddRecExpr>(Accum) &&
2741 cast<SCEVAddRecExpr>(Accum)->getLoop() == L)) {
Dan Gohmana10756e2010-01-21 02:09:26 +00002742 bool HasNUW = false;
2743 bool HasNSW = false;
2744
2745 // If the increment doesn't overflow, then neither the addrec nor
2746 // the post-increment will overflow.
2747 if (const AddOperator *OBO = dyn_cast<AddOperator>(BEValueV)) {
2748 if (OBO->hasNoUnsignedWrap())
2749 HasNUW = true;
2750 if (OBO->hasNoSignedWrap())
2751 HasNSW = true;
2752 }
2753
Dan Gohman27dead42010-04-12 07:49:36 +00002754 const SCEV *StartVal = getSCEV(StartValueV);
Dan Gohmana10756e2010-01-21 02:09:26 +00002755 const SCEV *PHISCEV =
2756 getAddRecExpr(StartVal, Accum, L, HasNUW, HasNSW);
Dan Gohmaneb490a72009-07-25 01:22:26 +00002757
Dan Gohmana10756e2010-01-21 02:09:26 +00002758 // Since the no-wrap flags are on the increment, they apply to the
2759 // post-incremented value as well.
2760 if (Accum->isLoopInvariant(L))
2761 (void)getAddRecExpr(getAddExpr(StartVal, Accum),
2762 Accum, L, HasNUW, HasNSW);
Chris Lattner53e677a2004-04-02 20:23:17 +00002763
2764 // Okay, for the entire analysis of this edge we assumed the PHI
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002765 // to be symbolic. We now need to go back and purge all of the
2766 // entries for the scalars that use the symbolic expression.
2767 ForgetSymbolicName(PN, SymbolicName);
2768 Scalars[SCEVCallbackVH(PN, this)] = PHISCEV;
Chris Lattner53e677a2004-04-02 20:23:17 +00002769 return PHISCEV;
2770 }
2771 }
Dan Gohman622ed672009-05-04 22:02:23 +00002772 } else if (const SCEVAddRecExpr *AddRec =
2773 dyn_cast<SCEVAddRecExpr>(BEValue)) {
Chris Lattner97156e72006-04-26 18:34:07 +00002774 // Otherwise, this could be a loop like this:
2775 // i = 0; for (j = 1; ..; ++j) { .... i = j; }
2776 // In this case, j = {1,+,1} and BEValue is j.
2777 // Because the other in-value of i (0) fits the evolution of BEValue
2778 // i really is an addrec evolution.
2779 if (AddRec->getLoop() == L && AddRec->isAffine()) {
Dan Gohman27dead42010-04-12 07:49:36 +00002780 const SCEV *StartVal = getSCEV(StartValueV);
Chris Lattner97156e72006-04-26 18:34:07 +00002781
2782 // If StartVal = j.start - j.stride, we can use StartVal as the
2783 // initial step of the addrec evolution.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002784 if (StartVal == getMinusSCEV(AddRec->getOperand(0),
Dan Gohman5ee60f72010-04-11 23:44:58 +00002785 AddRec->getOperand(1))) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00002786 const SCEV *PHISCEV =
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002787 getAddRecExpr(StartVal, AddRec->getOperand(1), L);
Chris Lattner97156e72006-04-26 18:34:07 +00002788
2789 // Okay, for the entire analysis of this edge we assumed the PHI
Dan Gohmanfef8bb22009-07-25 01:13:03 +00002790 // to be symbolic. We now need to go back and purge all of the
2791 // entries for the scalars that use the symbolic expression.
2792 ForgetSymbolicName(PN, SymbolicName);
2793 Scalars[SCEVCallbackVH(PN, this)] = PHISCEV;
Chris Lattner97156e72006-04-26 18:34:07 +00002794 return PHISCEV;
2795 }
2796 }
Chris Lattner53e677a2004-04-02 20:23:17 +00002797 }
Chris Lattner53e677a2004-04-02 20:23:17 +00002798 }
Dan Gohman27dead42010-04-12 07:49:36 +00002799 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00002800
Dan Gohman85669632010-02-25 06:57:05 +00002801 // If the PHI has a single incoming value, follow that value, unless the
2802 // PHI's incoming blocks are in a different loop, in which case doing so
2803 // risks breaking LCSSA form. Instcombine would normally zap these, but
2804 // it doesn't have DominatorTree information, so it may miss cases.
2805 if (Value *V = PN->hasConstantValue(DT)) {
2806 bool AllSameLoop = true;
2807 Loop *PNLoop = LI->getLoopFor(PN->getParent());
2808 for (size_t i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2809 if (LI->getLoopFor(PN->getIncomingBlock(i)) != PNLoop) {
2810 AllSameLoop = false;
2811 break;
2812 }
2813 if (AllSameLoop)
2814 return getSCEV(V);
2815 }
Dan Gohmana653fc52009-07-14 14:06:25 +00002816
Chris Lattner53e677a2004-04-02 20:23:17 +00002817 // If it's not a loop phi, we can't handle it yet.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00002818 return getUnknown(PN);
Chris Lattner53e677a2004-04-02 20:23:17 +00002819}
2820
Dan Gohman26466c02009-05-08 20:26:55 +00002821/// createNodeForGEP - Expand GEP instructions into add and multiply
2822/// operations. This allows them to be analyzed by regular SCEV code.
2823///
Dan Gohmand281ed22009-12-18 02:09:29 +00002824const SCEV *ScalarEvolution::createNodeForGEP(GEPOperator *GEP) {
Dan Gohman26466c02009-05-08 20:26:55 +00002825
Dan Gohmanb9f96512010-06-30 07:16:37 +00002826 // Don't blindly transfer the inbounds flag from the GEP instruction to the
2827 // Add expression, because the Instruction may be guarded by control flow
2828 // and the no-overflow bits may not be valid for the expression in any
Dan Gohman70eff632010-06-30 17:27:11 +00002829 // context.
Dan Gohman7a642572010-06-29 01:41:41 +00002830
Dan Gohmanc40f17b2009-08-18 16:46:41 +00002831 const Type *IntPtrTy = getEffectiveSCEVType(GEP->getType());
Dan Gohmane810b0d2009-05-08 20:36:47 +00002832 Value *Base = GEP->getOperand(0);
Dan Gohmanc63a6272009-05-09 00:14:52 +00002833 // Don't attempt to analyze GEPs over unsized objects.
2834 if (!cast<PointerType>(Base->getType())->getElementType()->isSized())
2835 return getUnknown(GEP);
Dan Gohmandeff6212010-05-03 22:09:21 +00002836 const SCEV *TotalOffset = getConstant(IntPtrTy, 0);
Dan Gohmane810b0d2009-05-08 20:36:47 +00002837 gep_type_iterator GTI = gep_type_begin(GEP);
Oscar Fuentesee56c422010-08-02 06:00:15 +00002838 for (GetElementPtrInst::op_iterator I = llvm::next(GEP->op_begin()),
Dan Gohmane810b0d2009-05-08 20:36:47 +00002839 E = GEP->op_end();
Dan Gohman26466c02009-05-08 20:26:55 +00002840 I != E; ++I) {
2841 Value *Index = *I;
2842 // Compute the (potentially symbolic) offset in bytes for this index.
2843 if (const StructType *STy = dyn_cast<StructType>(*GTI++)) {
2844 // For a struct, add the member offset.
Dan Gohman26466c02009-05-08 20:26:55 +00002845 unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
Dan Gohmanb9f96512010-06-30 07:16:37 +00002846 const SCEV *FieldOffset = getOffsetOfExpr(STy, FieldNo);
2847
Dan Gohmanb9f96512010-06-30 07:16:37 +00002848 // Add the field offset to the running total offset.
Dan Gohman70eff632010-06-30 17:27:11 +00002849 TotalOffset = getAddExpr(TotalOffset, FieldOffset);
Dan Gohman26466c02009-05-08 20:26:55 +00002850 } else {
2851 // For an array, add the element offset, explicitly scaled.
Dan Gohmanb9f96512010-06-30 07:16:37 +00002852 const SCEV *ElementSize = getSizeOfExpr(*GTI);
2853 const SCEV *IndexS = getSCEV(Index);
Dan Gohman3f46a3a2010-03-01 17:49:51 +00002854 // Getelementptr indices are signed.
Dan Gohmanb9f96512010-06-30 07:16:37 +00002855 IndexS = getTruncateOrSignExtend(IndexS, IntPtrTy);
2856
Dan Gohmanb9f96512010-06-30 07:16:37 +00002857 // Multiply the index by the element size to compute the element offset.
Dan Gohman70eff632010-06-30 17:27:11 +00002858 const SCEV *LocalOffset = getMulExpr(IndexS, ElementSize);
Dan Gohmanb9f96512010-06-30 07:16:37 +00002859
2860 // Add the element offset to the running total offset.
Dan Gohman70eff632010-06-30 17:27:11 +00002861 TotalOffset = getAddExpr(TotalOffset, LocalOffset);
Dan Gohman26466c02009-05-08 20:26:55 +00002862 }
2863 }
Dan Gohmanb9f96512010-06-30 07:16:37 +00002864
2865 // Get the SCEV for the GEP base.
2866 const SCEV *BaseS = getSCEV(Base);
2867
Dan Gohmanb9f96512010-06-30 07:16:37 +00002868 // Add the total offset from all the GEP indices to the base.
Dan Gohman70eff632010-06-30 17:27:11 +00002869 return getAddExpr(BaseS, TotalOffset);
Dan Gohman26466c02009-05-08 20:26:55 +00002870}
2871
Nick Lewycky83bb0052007-11-22 07:59:40 +00002872/// GetMinTrailingZeros - Determine the minimum number of zero bits that S is
2873/// guaranteed to end in (at every loop iteration). It is, at the same time,
2874/// the minimum number of times S is divisible by 2. For example, given {4,+,8}
2875/// it returns 2. If S is guaranteed to be 0, it returns the bitwidth of S.
Dan Gohman2c364ad2009-06-19 23:29:04 +00002876uint32_t
Dan Gohman0bba49c2009-07-07 17:06:11 +00002877ScalarEvolution::GetMinTrailingZeros(const SCEV *S) {
Dan Gohman622ed672009-05-04 22:02:23 +00002878 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
Chris Lattner8314a0c2007-11-23 22:36:49 +00002879 return C->getValue()->getValue().countTrailingZeros();
Chris Lattnera17f0392006-12-12 02:26:09 +00002880
Dan Gohman622ed672009-05-04 22:02:23 +00002881 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(S))
Dan Gohman2c364ad2009-06-19 23:29:04 +00002882 return std::min(GetMinTrailingZeros(T->getOperand()),
2883 (uint32_t)getTypeSizeInBits(T->getType()));
Nick Lewycky83bb0052007-11-22 07:59:40 +00002884
Dan Gohman622ed672009-05-04 22:02:23 +00002885 if (const SCEVZeroExtendExpr *E = dyn_cast<SCEVZeroExtendExpr>(S)) {
Dan Gohman2c364ad2009-06-19 23:29:04 +00002886 uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
2887 return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
2888 getTypeSizeInBits(E->getType()) : OpRes;
Nick Lewycky83bb0052007-11-22 07:59:40 +00002889 }
2890
Dan Gohman622ed672009-05-04 22:02:23 +00002891 if (const SCEVSignExtendExpr *E = dyn_cast<SCEVSignExtendExpr>(S)) {
Dan Gohman2c364ad2009-06-19 23:29:04 +00002892 uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
2893 return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
2894 getTypeSizeInBits(E->getType()) : OpRes;
Nick Lewycky83bb0052007-11-22 07:59:40 +00002895 }
2896
Dan Gohman622ed672009-05-04 22:02:23 +00002897 if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) {
Nick Lewycky83bb0052007-11-22 07:59:40 +00002898 // The result is the min of all operands results.
Dan Gohman2c364ad2009-06-19 23:29:04 +00002899 uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
Nick Lewycky83bb0052007-11-22 07:59:40 +00002900 for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
Dan Gohman2c364ad2009-06-19 23:29:04 +00002901 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
Nick Lewycky83bb0052007-11-22 07:59:40 +00002902 return MinOpRes;
Chris Lattnera17f0392006-12-12 02:26:09 +00002903 }
2904
Dan Gohman622ed672009-05-04 22:02:23 +00002905 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) {
Nick Lewycky83bb0052007-11-22 07:59:40 +00002906 // The result is the sum of all operands results.
Dan Gohman2c364ad2009-06-19 23:29:04 +00002907 uint32_t SumOpRes = GetMinTrailingZeros(M->getOperand(0));
2908 uint32_t BitWidth = getTypeSizeInBits(M->getType());
Nick Lewycky83bb0052007-11-22 07:59:40 +00002909 for (unsigned i = 1, e = M->getNumOperands();
2910 SumOpRes != BitWidth && i != e; ++i)
Dan Gohman2c364ad2009-06-19 23:29:04 +00002911 SumOpRes = std::min(SumOpRes + GetMinTrailingZeros(M->getOperand(i)),
Nick Lewycky83bb0052007-11-22 07:59:40 +00002912 BitWidth);
2913 return SumOpRes;
Chris Lattnera17f0392006-12-12 02:26:09 +00002914 }
Nick Lewycky83bb0052007-11-22 07:59:40 +00002915
Dan Gohman622ed672009-05-04 22:02:23 +00002916 if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) {
Nick Lewycky83bb0052007-11-22 07:59:40 +00002917 // The result is the min of all operands results.
Dan Gohman2c364ad2009-06-19 23:29:04 +00002918 uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
Nick Lewycky83bb0052007-11-22 07:59:40 +00002919 for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
Dan Gohman2c364ad2009-06-19 23:29:04 +00002920 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
Nick Lewycky83bb0052007-11-22 07:59:40 +00002921 return MinOpRes;
Chris Lattnera17f0392006-12-12 02:26:09 +00002922 }
Nick Lewycky83bb0052007-11-22 07:59:40 +00002923
Dan Gohman622ed672009-05-04 22:02:23 +00002924 if (const SCEVSMaxExpr *M = dyn_cast<SCEVSMaxExpr>(S)) {
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002925 // The result is the min of all operands results.
Dan Gohman2c364ad2009-06-19 23:29:04 +00002926 uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002927 for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
Dan Gohman2c364ad2009-06-19 23:29:04 +00002928 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
Nick Lewyckyc54c5612007-11-25 22:41:31 +00002929 return MinOpRes;
2930 }
2931
Dan Gohman622ed672009-05-04 22:02:23 +00002932 if (const SCEVUMaxExpr *M = dyn_cast<SCEVUMaxExpr>(S)) {
Nick Lewycky3e630762008-02-20 06:48:22 +00002933 // The result is the min of all operands results.
Dan Gohman2c364ad2009-06-19 23:29:04 +00002934 uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
Nick Lewycky3e630762008-02-20 06:48:22 +00002935 for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
Dan Gohman2c364ad2009-06-19 23:29:04 +00002936 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
Nick Lewycky3e630762008-02-20 06:48:22 +00002937 return MinOpRes;
2938 }
2939
Dan Gohman2c364ad2009-06-19 23:29:04 +00002940 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
2941 // For a SCEVUnknown, ask ValueTracking.
2942 unsigned BitWidth = getTypeSizeInBits(U->getType());
2943 APInt Mask = APInt::getAllOnesValue(BitWidth);
2944 APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
2945 ComputeMaskedBits(U->getValue(), Mask, Zeros, Ones);
2946 return Zeros.countTrailingOnes();
2947 }
2948
2949 // SCEVUDivExpr
Nick Lewycky83bb0052007-11-22 07:59:40 +00002950 return 0;
Chris Lattnera17f0392006-12-12 02:26:09 +00002951}
Chris Lattner53e677a2004-04-02 20:23:17 +00002952
Dan Gohman85b05a22009-07-13 21:35:55 +00002953/// getUnsignedRange - Determine the unsigned range for a particular SCEV.
2954///
2955ConstantRange
2956ScalarEvolution::getUnsignedRange(const SCEV *S) {
Dan Gohman2c364ad2009-06-19 23:29:04 +00002957
2958 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
Dan Gohman85b05a22009-07-13 21:35:55 +00002959 return ConstantRange(C->getValue()->getValue());
Dan Gohman2c364ad2009-06-19 23:29:04 +00002960
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00002961 unsigned BitWidth = getTypeSizeInBits(S->getType());
2962 ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
2963
2964 // If the value has known zeros, the maximum unsigned value will have those
2965 // known zeros as well.
2966 uint32_t TZ = GetMinTrailingZeros(S);
2967 if (TZ != 0)
2968 ConservativeResult =
2969 ConstantRange(APInt::getMinValue(BitWidth),
2970 APInt::getMaxValue(BitWidth).lshr(TZ).shl(TZ) + 1);
2971
Dan Gohman85b05a22009-07-13 21:35:55 +00002972 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
2973 ConstantRange X = getUnsignedRange(Add->getOperand(0));
2974 for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
2975 X = X.add(getUnsignedRange(Add->getOperand(i)));
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00002976 return ConservativeResult.intersectWith(X);
Dan Gohman85b05a22009-07-13 21:35:55 +00002977 }
2978
2979 if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
2980 ConstantRange X = getUnsignedRange(Mul->getOperand(0));
2981 for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
2982 X = X.multiply(getUnsignedRange(Mul->getOperand(i)));
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00002983 return ConservativeResult.intersectWith(X);
Dan Gohman85b05a22009-07-13 21:35:55 +00002984 }
2985
2986 if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
2987 ConstantRange X = getUnsignedRange(SMax->getOperand(0));
2988 for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
2989 X = X.smax(getUnsignedRange(SMax->getOperand(i)));
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00002990 return ConservativeResult.intersectWith(X);
Dan Gohman85b05a22009-07-13 21:35:55 +00002991 }
2992
2993 if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
2994 ConstantRange X = getUnsignedRange(UMax->getOperand(0));
2995 for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
2996 X = X.umax(getUnsignedRange(UMax->getOperand(i)));
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00002997 return ConservativeResult.intersectWith(X);
Dan Gohman85b05a22009-07-13 21:35:55 +00002998 }
2999
3000 if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
3001 ConstantRange X = getUnsignedRange(UDiv->getLHS());
3002 ConstantRange Y = getUnsignedRange(UDiv->getRHS());
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003003 return ConservativeResult.intersectWith(X.udiv(Y));
Dan Gohman85b05a22009-07-13 21:35:55 +00003004 }
3005
3006 if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
3007 ConstantRange X = getUnsignedRange(ZExt->getOperand());
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003008 return ConservativeResult.intersectWith(X.zeroExtend(BitWidth));
Dan Gohman85b05a22009-07-13 21:35:55 +00003009 }
3010
3011 if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
3012 ConstantRange X = getUnsignedRange(SExt->getOperand());
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003013 return ConservativeResult.intersectWith(X.signExtend(BitWidth));
Dan Gohman85b05a22009-07-13 21:35:55 +00003014 }
3015
3016 if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
3017 ConstantRange X = getUnsignedRange(Trunc->getOperand());
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003018 return ConservativeResult.intersectWith(X.truncate(BitWidth));
Dan Gohman85b05a22009-07-13 21:35:55 +00003019 }
3020
Dan Gohman85b05a22009-07-13 21:35:55 +00003021 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
Dan Gohmana10756e2010-01-21 02:09:26 +00003022 // If there's no unsigned wrap, the value will never be less than its
3023 // initial value.
3024 if (AddRec->hasNoUnsignedWrap())
3025 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(AddRec->getStart()))
Dan Gohmanbca091d2010-04-12 23:08:18 +00003026 if (!C->getValue()->isZero())
Dan Gohmanbc7129f2010-04-11 22:12:18 +00003027 ConservativeResult =
Dan Gohman8a18d6b2010-06-30 06:58:35 +00003028 ConservativeResult.intersectWith(
3029 ConstantRange(C->getValue()->getValue(), APInt(BitWidth, 0)));
Dan Gohman85b05a22009-07-13 21:35:55 +00003030
3031 // TODO: non-affine addrec
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003032 if (AddRec->isAffine()) {
Dan Gohman85b05a22009-07-13 21:35:55 +00003033 const Type *Ty = AddRec->getType();
3034 const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003035 if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
3036 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
Dan Gohman85b05a22009-07-13 21:35:55 +00003037 MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
3038
3039 const SCEV *Start = AddRec->getStart();
Dan Gohman646e0472010-04-12 07:39:33 +00003040 const SCEV *Step = AddRec->getStepRecurrence(*this);
Dan Gohman85b05a22009-07-13 21:35:55 +00003041
3042 ConstantRange StartRange = getUnsignedRange(Start);
Dan Gohman646e0472010-04-12 07:39:33 +00003043 ConstantRange StepRange = getSignedRange(Step);
3044 ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
3045 ConstantRange EndRange =
3046 StartRange.add(MaxBECountRange.multiply(StepRange));
3047
3048 // Check for overflow. This must be done with ConstantRange arithmetic
3049 // because we could be called from within the ScalarEvolution overflow
3050 // checking code.
3051 ConstantRange ExtStartRange = StartRange.zextOrTrunc(BitWidth*2+1);
3052 ConstantRange ExtStepRange = StepRange.sextOrTrunc(BitWidth*2+1);
3053 ConstantRange ExtMaxBECountRange =
3054 MaxBECountRange.zextOrTrunc(BitWidth*2+1);
3055 ConstantRange ExtEndRange = EndRange.zextOrTrunc(BitWidth*2+1);
3056 if (ExtStartRange.add(ExtMaxBECountRange.multiply(ExtStepRange)) !=
3057 ExtEndRange)
3058 return ConservativeResult;
3059
Dan Gohman85b05a22009-07-13 21:35:55 +00003060 APInt Min = APIntOps::umin(StartRange.getUnsignedMin(),
3061 EndRange.getUnsignedMin());
3062 APInt Max = APIntOps::umax(StartRange.getUnsignedMax(),
3063 EndRange.getUnsignedMax());
3064 if (Min.isMinValue() && Max.isMaxValue())
Dan Gohmana10756e2010-01-21 02:09:26 +00003065 return ConservativeResult;
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003066 return ConservativeResult.intersectWith(ConstantRange(Min, Max+1));
Dan Gohman85b05a22009-07-13 21:35:55 +00003067 }
3068 }
Dan Gohmana10756e2010-01-21 02:09:26 +00003069
3070 return ConservativeResult;
Dan Gohman2c364ad2009-06-19 23:29:04 +00003071 }
3072
3073 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3074 // For a SCEVUnknown, ask ValueTracking.
Dan Gohman2c364ad2009-06-19 23:29:04 +00003075 APInt Mask = APInt::getAllOnesValue(BitWidth);
3076 APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
3077 ComputeMaskedBits(U->getValue(), Mask, Zeros, Ones, TD);
Dan Gohman746f3b12009-07-20 22:34:18 +00003078 if (Ones == ~Zeros + 1)
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003079 return ConservativeResult;
3080 return ConservativeResult.intersectWith(ConstantRange(Ones, ~Zeros + 1));
Dan Gohman2c364ad2009-06-19 23:29:04 +00003081 }
3082
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003083 return ConservativeResult;
Dan Gohman2c364ad2009-06-19 23:29:04 +00003084}
3085
Dan Gohman85b05a22009-07-13 21:35:55 +00003086/// getSignedRange - Determine the signed range for a particular SCEV.
3087///
3088ConstantRange
3089ScalarEvolution::getSignedRange(const SCEV *S) {
Dan Gohman2c364ad2009-06-19 23:29:04 +00003090
Dan Gohman85b05a22009-07-13 21:35:55 +00003091 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
3092 return ConstantRange(C->getValue()->getValue());
3093
Dan Gohman52fddd32010-01-26 04:40:18 +00003094 unsigned BitWidth = getTypeSizeInBits(S->getType());
3095 ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
3096
3097 // If the value has known zeros, the maximum signed value will have those
3098 // known zeros as well.
3099 uint32_t TZ = GetMinTrailingZeros(S);
3100 if (TZ != 0)
3101 ConservativeResult =
3102 ConstantRange(APInt::getSignedMinValue(BitWidth),
3103 APInt::getSignedMaxValue(BitWidth).ashr(TZ).shl(TZ) + 1);
3104
Dan Gohman85b05a22009-07-13 21:35:55 +00003105 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
3106 ConstantRange X = getSignedRange(Add->getOperand(0));
3107 for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
3108 X = X.add(getSignedRange(Add->getOperand(i)));
Dan Gohman52fddd32010-01-26 04:40:18 +00003109 return ConservativeResult.intersectWith(X);
Dan Gohman2c364ad2009-06-19 23:29:04 +00003110 }
3111
Dan Gohman85b05a22009-07-13 21:35:55 +00003112 if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
3113 ConstantRange X = getSignedRange(Mul->getOperand(0));
3114 for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
3115 X = X.multiply(getSignedRange(Mul->getOperand(i)));
Dan Gohman52fddd32010-01-26 04:40:18 +00003116 return ConservativeResult.intersectWith(X);
Dan Gohman2c364ad2009-06-19 23:29:04 +00003117 }
3118
Dan Gohman85b05a22009-07-13 21:35:55 +00003119 if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
3120 ConstantRange X = getSignedRange(SMax->getOperand(0));
3121 for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
3122 X = X.smax(getSignedRange(SMax->getOperand(i)));
Dan Gohman52fddd32010-01-26 04:40:18 +00003123 return ConservativeResult.intersectWith(X);
Dan Gohman85b05a22009-07-13 21:35:55 +00003124 }
Dan Gohman62849c02009-06-24 01:05:09 +00003125
Dan Gohman85b05a22009-07-13 21:35:55 +00003126 if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
3127 ConstantRange X = getSignedRange(UMax->getOperand(0));
3128 for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
3129 X = X.umax(getSignedRange(UMax->getOperand(i)));
Dan Gohman52fddd32010-01-26 04:40:18 +00003130 return ConservativeResult.intersectWith(X);
Dan Gohman85b05a22009-07-13 21:35:55 +00003131 }
Dan Gohman62849c02009-06-24 01:05:09 +00003132
Dan Gohman85b05a22009-07-13 21:35:55 +00003133 if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
3134 ConstantRange X = getSignedRange(UDiv->getLHS());
3135 ConstantRange Y = getSignedRange(UDiv->getRHS());
Dan Gohman52fddd32010-01-26 04:40:18 +00003136 return ConservativeResult.intersectWith(X.udiv(Y));
Dan Gohman85b05a22009-07-13 21:35:55 +00003137 }
Dan Gohman62849c02009-06-24 01:05:09 +00003138
Dan Gohman85b05a22009-07-13 21:35:55 +00003139 if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
3140 ConstantRange X = getSignedRange(ZExt->getOperand());
Dan Gohman52fddd32010-01-26 04:40:18 +00003141 return ConservativeResult.intersectWith(X.zeroExtend(BitWidth));
Dan Gohman85b05a22009-07-13 21:35:55 +00003142 }
3143
3144 if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
3145 ConstantRange X = getSignedRange(SExt->getOperand());
Dan Gohman52fddd32010-01-26 04:40:18 +00003146 return ConservativeResult.intersectWith(X.signExtend(BitWidth));
Dan Gohman85b05a22009-07-13 21:35:55 +00003147 }
3148
3149 if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
3150 ConstantRange X = getSignedRange(Trunc->getOperand());
Dan Gohman52fddd32010-01-26 04:40:18 +00003151 return ConservativeResult.intersectWith(X.truncate(BitWidth));
Dan Gohman85b05a22009-07-13 21:35:55 +00003152 }
3153
Dan Gohman85b05a22009-07-13 21:35:55 +00003154 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
Dan Gohmana10756e2010-01-21 02:09:26 +00003155 // If there's no signed wrap, and all the operands have the same sign or
3156 // zero, the value won't ever change sign.
3157 if (AddRec->hasNoSignedWrap()) {
3158 bool AllNonNeg = true;
3159 bool AllNonPos = true;
3160 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
3161 if (!isKnownNonNegative(AddRec->getOperand(i))) AllNonNeg = false;
3162 if (!isKnownNonPositive(AddRec->getOperand(i))) AllNonPos = false;
3163 }
Dan Gohmana10756e2010-01-21 02:09:26 +00003164 if (AllNonNeg)
Dan Gohman52fddd32010-01-26 04:40:18 +00003165 ConservativeResult = ConservativeResult.intersectWith(
3166 ConstantRange(APInt(BitWidth, 0),
3167 APInt::getSignedMinValue(BitWidth)));
Dan Gohmana10756e2010-01-21 02:09:26 +00003168 else if (AllNonPos)
Dan Gohman52fddd32010-01-26 04:40:18 +00003169 ConservativeResult = ConservativeResult.intersectWith(
3170 ConstantRange(APInt::getSignedMinValue(BitWidth),
3171 APInt(BitWidth, 1)));
Dan Gohmana10756e2010-01-21 02:09:26 +00003172 }
Dan Gohman85b05a22009-07-13 21:35:55 +00003173
3174 // TODO: non-affine addrec
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003175 if (AddRec->isAffine()) {
Dan Gohman85b05a22009-07-13 21:35:55 +00003176 const Type *Ty = AddRec->getType();
3177 const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
Dan Gohmanc9c36cb2010-01-26 19:19:05 +00003178 if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
3179 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
Dan Gohman85b05a22009-07-13 21:35:55 +00003180 MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
3181
3182 const SCEV *Start = AddRec->getStart();
Dan Gohman646e0472010-04-12 07:39:33 +00003183 const SCEV *Step = AddRec->getStepRecurrence(*this);
Dan Gohman85b05a22009-07-13 21:35:55 +00003184
3185 ConstantRange StartRange = getSignedRange(Start);
Dan Gohman646e0472010-04-12 07:39:33 +00003186 ConstantRange StepRange = getSignedRange(Step);
3187 ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
3188 ConstantRange EndRange =
3189 StartRange.add(MaxBECountRange.multiply(StepRange));
3190
3191 // Check for overflow. This must be done with ConstantRange arithmetic
3192 // because we could be called from within the ScalarEvolution overflow
3193 // checking code.
3194 ConstantRange ExtStartRange = StartRange.sextOrTrunc(BitWidth*2+1);
3195 ConstantRange ExtStepRange = StepRange.sextOrTrunc(BitWidth*2+1);
3196 ConstantRange ExtMaxBECountRange =
3197 MaxBECountRange.zextOrTrunc(BitWidth*2+1);
3198 ConstantRange ExtEndRange = EndRange.sextOrTrunc(BitWidth*2+1);
3199 if (ExtStartRange.add(ExtMaxBECountRange.multiply(ExtStepRange)) !=
3200 ExtEndRange)
3201 return ConservativeResult;
3202
Dan Gohman85b05a22009-07-13 21:35:55 +00003203 APInt Min = APIntOps::smin(StartRange.getSignedMin(),
3204 EndRange.getSignedMin());
3205 APInt Max = APIntOps::smax(StartRange.getSignedMax(),
3206 EndRange.getSignedMax());
3207 if (Min.isMinSignedValue() && Max.isMaxSignedValue())
Dan Gohmana10756e2010-01-21 02:09:26 +00003208 return ConservativeResult;
Dan Gohman52fddd32010-01-26 04:40:18 +00003209 return ConservativeResult.intersectWith(ConstantRange(Min, Max+1));
Dan Gohman62849c02009-06-24 01:05:09 +00003210 }
Dan Gohman62849c02009-06-24 01:05:09 +00003211 }
Dan Gohmana10756e2010-01-21 02:09:26 +00003212
3213 return ConservativeResult;
Dan Gohman62849c02009-06-24 01:05:09 +00003214 }
3215
Dan Gohman2c364ad2009-06-19 23:29:04 +00003216 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3217 // For a SCEVUnknown, ask ValueTracking.
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00003218 if (!U->getValue()->getType()->isIntegerTy() && !TD)
Dan Gohman52fddd32010-01-26 04:40:18 +00003219 return ConservativeResult;
Dan Gohman85b05a22009-07-13 21:35:55 +00003220 unsigned NS = ComputeNumSignBits(U->getValue(), TD);
3221 if (NS == 1)
Dan Gohman52fddd32010-01-26 04:40:18 +00003222 return ConservativeResult;
3223 return ConservativeResult.intersectWith(
Dan Gohman85b05a22009-07-13 21:35:55 +00003224 ConstantRange(APInt::getSignedMinValue(BitWidth).ashr(NS - 1),
Dan Gohman52fddd32010-01-26 04:40:18 +00003225 APInt::getSignedMaxValue(BitWidth).ashr(NS - 1)+1));
Dan Gohman2c364ad2009-06-19 23:29:04 +00003226 }
3227
Dan Gohman52fddd32010-01-26 04:40:18 +00003228 return ConservativeResult;
Dan Gohman2c364ad2009-06-19 23:29:04 +00003229}
3230
Chris Lattner53e677a2004-04-02 20:23:17 +00003231/// createSCEV - We know that there is no SCEV for the specified value.
3232/// Analyze the expression.
3233///
Dan Gohman0bba49c2009-07-07 17:06:11 +00003234const SCEV *ScalarEvolution::createSCEV(Value *V) {
Dan Gohmanaf79fb52009-04-21 01:07:12 +00003235 if (!isSCEVable(V->getType()))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003236 return getUnknown(V);
Dan Gohman2d1be872009-04-16 03:18:22 +00003237
Dan Gohman6c459a22008-06-22 19:56:46 +00003238 unsigned Opcode = Instruction::UserOp1;
Dan Gohman4ecbca52010-03-09 23:46:50 +00003239 if (Instruction *I = dyn_cast<Instruction>(V)) {
Dan Gohman6c459a22008-06-22 19:56:46 +00003240 Opcode = I->getOpcode();
Dan Gohman4ecbca52010-03-09 23:46:50 +00003241
3242 // Don't attempt to analyze instructions in blocks that aren't
3243 // reachable. Such instructions don't matter, and they aren't required
3244 // to obey basic rules for definitions dominating uses which this
3245 // analysis depends on.
3246 if (!DT->isReachableFromEntry(I->getParent()))
3247 return getUnknown(V);
3248 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
Dan Gohman6c459a22008-06-22 19:56:46 +00003249 Opcode = CE->getOpcode();
Dan Gohman6bbcba12009-06-24 00:54:57 +00003250 else if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
3251 return getConstant(CI);
3252 else if (isa<ConstantPointerNull>(V))
Dan Gohmandeff6212010-05-03 22:09:21 +00003253 return getConstant(V->getType(), 0);
Dan Gohman26812322009-08-25 17:49:57 +00003254 else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
3255 return GA->mayBeOverridden() ? getUnknown(V) : getSCEV(GA->getAliasee());
Dan Gohman6c459a22008-06-22 19:56:46 +00003256 else
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003257 return getUnknown(V);
Chris Lattner2811f2a2007-04-02 05:41:38 +00003258
Dan Gohmanca178902009-07-17 20:47:02 +00003259 Operator *U = cast<Operator>(V);
Dan Gohman6c459a22008-06-22 19:56:46 +00003260 switch (Opcode) {
Dan Gohman70eff632010-06-30 17:27:11 +00003261 case Instruction::Add:
3262 return getAddExpr(getSCEV(U->getOperand(0)),
3263 getSCEV(U->getOperand(1)));
3264 case Instruction::Mul:
3265 return getMulExpr(getSCEV(U->getOperand(0)),
3266 getSCEV(U->getOperand(1)));
Dan Gohman6c459a22008-06-22 19:56:46 +00003267 case Instruction::UDiv:
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003268 return getUDivExpr(getSCEV(U->getOperand(0)),
3269 getSCEV(U->getOperand(1)));
Dan Gohman6c459a22008-06-22 19:56:46 +00003270 case Instruction::Sub:
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003271 return getMinusSCEV(getSCEV(U->getOperand(0)),
3272 getSCEV(U->getOperand(1)));
Dan Gohman4ee29af2009-04-21 02:26:00 +00003273 case Instruction::And:
3274 // For an expression like x&255 that merely masks off the high bits,
3275 // use zext(trunc(x)) as the SCEV expression.
3276 if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
Dan Gohman2c73d5f2009-04-25 17:05:40 +00003277 if (CI->isNullValue())
3278 return getSCEV(U->getOperand(1));
Dan Gohmand6c32952009-04-27 01:41:10 +00003279 if (CI->isAllOnesValue())
3280 return getSCEV(U->getOperand(0));
Dan Gohman4ee29af2009-04-21 02:26:00 +00003281 const APInt &A = CI->getValue();
Dan Gohman61ffa8e2009-06-16 19:52:01 +00003282
3283 // Instcombine's ShrinkDemandedConstant may strip bits out of
3284 // constants, obscuring what would otherwise be a low-bits mask.
3285 // Use ComputeMaskedBits to compute what ShrinkDemandedConstant
3286 // knew about to reconstruct a low-bits mask value.
3287 unsigned LZ = A.countLeadingZeros();
3288 unsigned BitWidth = A.getBitWidth();
3289 APInt AllOnes = APInt::getAllOnesValue(BitWidth);
3290 APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
3291 ComputeMaskedBits(U->getOperand(0), AllOnes, KnownZero, KnownOne, TD);
3292
3293 APInt EffectiveMask = APInt::getLowBitsSet(BitWidth, BitWidth - LZ);
3294
Dan Gohmanfc3641b2009-06-17 23:54:37 +00003295 if (LZ != 0 && !((~A & ~KnownZero) & EffectiveMask))
Dan Gohman4ee29af2009-04-21 02:26:00 +00003296 return
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003297 getZeroExtendExpr(getTruncateExpr(getSCEV(U->getOperand(0)),
Owen Anderson1d0be152009-08-13 21:58:54 +00003298 IntegerType::get(getContext(), BitWidth - LZ)),
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003299 U->getType());
Dan Gohman4ee29af2009-04-21 02:26:00 +00003300 }
3301 break;
Dan Gohman61ffa8e2009-06-16 19:52:01 +00003302
Dan Gohman6c459a22008-06-22 19:56:46 +00003303 case Instruction::Or:
3304 // If the RHS of the Or is a constant, we may have something like:
3305 // X*4+1 which got turned into X*4|1. Handle this as an Add so loop
3306 // optimizations will transparently handle this case.
3307 //
3308 // In order for this transformation to be safe, the LHS must be of the
3309 // form X*(2^n) and the Or constant must be less than 2^n.
3310 if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00003311 const SCEV *LHS = getSCEV(U->getOperand(0));
Dan Gohman6c459a22008-06-22 19:56:46 +00003312 const APInt &CIVal = CI->getValue();
Dan Gohman2c364ad2009-06-19 23:29:04 +00003313 if (GetMinTrailingZeros(LHS) >=
Dan Gohman1f96e672009-09-17 18:05:20 +00003314 (CIVal.getBitWidth() - CIVal.countLeadingZeros())) {
3315 // Build a plain add SCEV.
3316 const SCEV *S = getAddExpr(LHS, getSCEV(CI));
3317 // If the LHS of the add was an addrec and it has no-wrap flags,
3318 // transfer the no-wrap flags, since an or won't introduce a wrap.
3319 if (const SCEVAddRecExpr *NewAR = dyn_cast<SCEVAddRecExpr>(S)) {
3320 const SCEVAddRecExpr *OldAR = cast<SCEVAddRecExpr>(LHS);
3321 if (OldAR->hasNoUnsignedWrap())
3322 const_cast<SCEVAddRecExpr *>(NewAR)->setHasNoUnsignedWrap(true);
3323 if (OldAR->hasNoSignedWrap())
3324 const_cast<SCEVAddRecExpr *>(NewAR)->setHasNoSignedWrap(true);
3325 }
3326 return S;
3327 }
Chris Lattner53e677a2004-04-02 20:23:17 +00003328 }
Dan Gohman6c459a22008-06-22 19:56:46 +00003329 break;
3330 case Instruction::Xor:
Dan Gohman6c459a22008-06-22 19:56:46 +00003331 if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
Nick Lewycky01eaf802008-07-07 06:15:49 +00003332 // If the RHS of the xor is a signbit, then this is just an add.
3333 // Instcombine turns add of signbit into xor as a strength reduction step.
Dan Gohman6c459a22008-06-22 19:56:46 +00003334 if (CI->getValue().isSignBit())
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003335 return getAddExpr(getSCEV(U->getOperand(0)),
3336 getSCEV(U->getOperand(1)));
Nick Lewycky01eaf802008-07-07 06:15:49 +00003337
3338 // If the RHS of xor is -1, then this is a not operation.
Dan Gohman0bac95e2009-05-18 16:17:44 +00003339 if (CI->isAllOnesValue())
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003340 return getNotSCEV(getSCEV(U->getOperand(0)));
Dan Gohman10978bd2009-05-18 16:29:04 +00003341
3342 // Model xor(and(x, C), C) as and(~x, C), if C is a low-bits mask.
3343 // This is a variant of the check for xor with -1, and it handles
3344 // the case where instcombine has trimmed non-demanded bits out
3345 // of an xor with -1.
3346 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U->getOperand(0)))
3347 if (ConstantInt *LCI = dyn_cast<ConstantInt>(BO->getOperand(1)))
3348 if (BO->getOpcode() == Instruction::And &&
3349 LCI->getValue() == CI->getValue())
3350 if (const SCEVZeroExtendExpr *Z =
Dan Gohman3034c102009-06-17 01:22:39 +00003351 dyn_cast<SCEVZeroExtendExpr>(getSCEV(U->getOperand(0)))) {
Dan Gohman82052832009-06-18 00:00:20 +00003352 const Type *UTy = U->getType();
Dan Gohman0bba49c2009-07-07 17:06:11 +00003353 const SCEV *Z0 = Z->getOperand();
Dan Gohman82052832009-06-18 00:00:20 +00003354 const Type *Z0Ty = Z0->getType();
3355 unsigned Z0TySize = getTypeSizeInBits(Z0Ty);
3356
Dan Gohman3f46a3a2010-03-01 17:49:51 +00003357 // If C is a low-bits mask, the zero extend is serving to
Dan Gohman82052832009-06-18 00:00:20 +00003358 // mask off the high bits. Complement the operand and
3359 // re-apply the zext.
3360 if (APIntOps::isMask(Z0TySize, CI->getValue()))
3361 return getZeroExtendExpr(getNotSCEV(Z0), UTy);
3362
3363 // If C is a single bit, it may be in the sign-bit position
3364 // before the zero-extend. In this case, represent the xor
3365 // using an add, which is equivalent, and re-apply the zext.
3366 APInt Trunc = APInt(CI->getValue()).trunc(Z0TySize);
3367 if (APInt(Trunc).zext(getTypeSizeInBits(UTy)) == CI->getValue() &&
3368 Trunc.isSignBit())
3369 return getZeroExtendExpr(getAddExpr(Z0, getConstant(Trunc)),
3370 UTy);
Dan Gohman3034c102009-06-17 01:22:39 +00003371 }
Dan Gohman6c459a22008-06-22 19:56:46 +00003372 }
3373 break;
3374
3375 case Instruction::Shl:
3376 // Turn shift left of a constant amount into a multiply.
3377 if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
Dan Gohman4f8eea82010-02-01 18:27:38 +00003378 uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003379
3380 // If the shift count is not less than the bitwidth, the result of
3381 // the shift is undefined. Don't try to analyze it, because the
3382 // resolution chosen here may differ from the resolution chosen in
3383 // other parts of the compiler.
3384 if (SA->getValue().uge(BitWidth))
3385 break;
3386
Owen Andersoneed707b2009-07-24 23:12:02 +00003387 Constant *X = ConstantInt::get(getContext(),
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003388 APInt(BitWidth, 1).shl(SA->getZExtValue()));
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003389 return getMulExpr(getSCEV(U->getOperand(0)), getSCEV(X));
Dan Gohman6c459a22008-06-22 19:56:46 +00003390 }
3391 break;
3392
Nick Lewycky01eaf802008-07-07 06:15:49 +00003393 case Instruction::LShr:
Nick Lewycky789558d2009-01-13 09:18:58 +00003394 // Turn logical shift right of a constant into a unsigned divide.
Nick Lewycky01eaf802008-07-07 06:15:49 +00003395 if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
Dan Gohman4f8eea82010-02-01 18:27:38 +00003396 uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003397
3398 // If the shift count is not less than the bitwidth, the result of
3399 // the shift is undefined. Don't try to analyze it, because the
3400 // resolution chosen here may differ from the resolution chosen in
3401 // other parts of the compiler.
3402 if (SA->getValue().uge(BitWidth))
3403 break;
3404
Owen Andersoneed707b2009-07-24 23:12:02 +00003405 Constant *X = ConstantInt::get(getContext(),
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003406 APInt(BitWidth, 1).shl(SA->getZExtValue()));
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003407 return getUDivExpr(getSCEV(U->getOperand(0)), getSCEV(X));
Nick Lewycky01eaf802008-07-07 06:15:49 +00003408 }
3409 break;
3410
Dan Gohman4ee29af2009-04-21 02:26:00 +00003411 case Instruction::AShr:
3412 // For a two-shift sext-inreg, use sext(trunc(x)) as the SCEV expression.
3413 if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1)))
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003414 if (Operator *L = dyn_cast<Operator>(U->getOperand(0)))
Dan Gohman4ee29af2009-04-21 02:26:00 +00003415 if (L->getOpcode() == Instruction::Shl &&
3416 L->getOperand(1) == U->getOperand(1)) {
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003417 uint64_t BitWidth = getTypeSizeInBits(U->getType());
3418
3419 // If the shift count is not less than the bitwidth, the result of
3420 // the shift is undefined. Don't try to analyze it, because the
3421 // resolution chosen here may differ from the resolution chosen in
3422 // other parts of the compiler.
3423 if (CI->getValue().uge(BitWidth))
3424 break;
3425
Dan Gohman2c73d5f2009-04-25 17:05:40 +00003426 uint64_t Amt = BitWidth - CI->getZExtValue();
3427 if (Amt == BitWidth)
3428 return getSCEV(L->getOperand(0)); // shift by zero --> noop
Dan Gohman4ee29af2009-04-21 02:26:00 +00003429 return
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003430 getSignExtendExpr(getTruncateExpr(getSCEV(L->getOperand(0)),
Dan Gohmanddb3eaf2010-04-22 01:35:11 +00003431 IntegerType::get(getContext(),
3432 Amt)),
3433 U->getType());
Dan Gohman4ee29af2009-04-21 02:26:00 +00003434 }
3435 break;
3436
Dan Gohman6c459a22008-06-22 19:56:46 +00003437 case Instruction::Trunc:
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003438 return getTruncateExpr(getSCEV(U->getOperand(0)), U->getType());
Dan Gohman6c459a22008-06-22 19:56:46 +00003439
3440 case Instruction::ZExt:
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003441 return getZeroExtendExpr(getSCEV(U->getOperand(0)), U->getType());
Dan Gohman6c459a22008-06-22 19:56:46 +00003442
3443 case Instruction::SExt:
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003444 return getSignExtendExpr(getSCEV(U->getOperand(0)), U->getType());
Dan Gohman6c459a22008-06-22 19:56:46 +00003445
3446 case Instruction::BitCast:
3447 // BitCasts are no-op casts so we just eliminate the cast.
Dan Gohmanaf79fb52009-04-21 01:07:12 +00003448 if (isSCEVable(U->getType()) && isSCEVable(U->getOperand(0)->getType()))
Dan Gohman6c459a22008-06-22 19:56:46 +00003449 return getSCEV(U->getOperand(0));
3450 break;
3451
Dan Gohman4f8eea82010-02-01 18:27:38 +00003452 // It's tempting to handle inttoptr and ptrtoint as no-ops, however this can
3453 // lead to pointer expressions which cannot safely be expanded to GEPs,
3454 // because ScalarEvolution doesn't respect the GEP aliasing rules when
3455 // simplifying integer expressions.
Dan Gohman2d1be872009-04-16 03:18:22 +00003456
Dan Gohman26466c02009-05-08 20:26:55 +00003457 case Instruction::GetElementPtr:
Dan Gohmand281ed22009-12-18 02:09:29 +00003458 return createNodeForGEP(cast<GEPOperator>(U));
Dan Gohman2d1be872009-04-16 03:18:22 +00003459
Dan Gohman6c459a22008-06-22 19:56:46 +00003460 case Instruction::PHI:
3461 return createNodeForPHI(cast<PHINode>(U));
3462
3463 case Instruction::Select:
3464 // This could be a smax or umax that was lowered earlier.
3465 // Try to recover it.
3466 if (ICmpInst *ICI = dyn_cast<ICmpInst>(U->getOperand(0))) {
3467 Value *LHS = ICI->getOperand(0);
3468 Value *RHS = ICI->getOperand(1);
3469 switch (ICI->getPredicate()) {
3470 case ICmpInst::ICMP_SLT:
3471 case ICmpInst::ICMP_SLE:
3472 std::swap(LHS, RHS);
3473 // fall through
3474 case ICmpInst::ICMP_SGT:
3475 case ICmpInst::ICMP_SGE:
Dan Gohman9f93d302010-04-24 03:09:42 +00003476 // a >s b ? a+x : b+x -> smax(a, b)+x
3477 // a >s b ? b+x : a+x -> smin(a, b)+x
3478 if (LHS->getType() == U->getType()) {
3479 const SCEV *LS = getSCEV(LHS);
3480 const SCEV *RS = getSCEV(RHS);
3481 const SCEV *LA = getSCEV(U->getOperand(1));
3482 const SCEV *RA = getSCEV(U->getOperand(2));
3483 const SCEV *LDiff = getMinusSCEV(LA, LS);
3484 const SCEV *RDiff = getMinusSCEV(RA, RS);
3485 if (LDiff == RDiff)
3486 return getAddExpr(getSMaxExpr(LS, RS), LDiff);
3487 LDiff = getMinusSCEV(LA, RS);
3488 RDiff = getMinusSCEV(RA, LS);
3489 if (LDiff == RDiff)
3490 return getAddExpr(getSMinExpr(LS, RS), LDiff);
3491 }
Dan Gohman6c459a22008-06-22 19:56:46 +00003492 break;
3493 case ICmpInst::ICMP_ULT:
3494 case ICmpInst::ICMP_ULE:
3495 std::swap(LHS, RHS);
3496 // fall through
3497 case ICmpInst::ICMP_UGT:
3498 case ICmpInst::ICMP_UGE:
Dan Gohman9f93d302010-04-24 03:09:42 +00003499 // a >u b ? a+x : b+x -> umax(a, b)+x
3500 // a >u b ? b+x : a+x -> umin(a, b)+x
3501 if (LHS->getType() == U->getType()) {
3502 const SCEV *LS = getSCEV(LHS);
3503 const SCEV *RS = getSCEV(RHS);
3504 const SCEV *LA = getSCEV(U->getOperand(1));
3505 const SCEV *RA = getSCEV(U->getOperand(2));
3506 const SCEV *LDiff = getMinusSCEV(LA, LS);
3507 const SCEV *RDiff = getMinusSCEV(RA, RS);
3508 if (LDiff == RDiff)
3509 return getAddExpr(getUMaxExpr(LS, RS), LDiff);
3510 LDiff = getMinusSCEV(LA, RS);
3511 RDiff = getMinusSCEV(RA, LS);
3512 if (LDiff == RDiff)
3513 return getAddExpr(getUMinExpr(LS, RS), LDiff);
3514 }
Dan Gohman6c459a22008-06-22 19:56:46 +00003515 break;
Dan Gohman30fb5122009-06-18 20:21:07 +00003516 case ICmpInst::ICMP_NE:
Dan Gohman9f93d302010-04-24 03:09:42 +00003517 // n != 0 ? n+x : 1+x -> umax(n, 1)+x
3518 if (LHS->getType() == U->getType() &&
Dan Gohman30fb5122009-06-18 20:21:07 +00003519 isa<ConstantInt>(RHS) &&
Dan Gohman9f93d302010-04-24 03:09:42 +00003520 cast<ConstantInt>(RHS)->isZero()) {
3521 const SCEV *One = getConstant(LHS->getType(), 1);
3522 const SCEV *LS = getSCEV(LHS);
3523 const SCEV *LA = getSCEV(U->getOperand(1));
3524 const SCEV *RA = getSCEV(U->getOperand(2));
3525 const SCEV *LDiff = getMinusSCEV(LA, LS);
3526 const SCEV *RDiff = getMinusSCEV(RA, One);
3527 if (LDiff == RDiff)
3528 return getAddExpr(getUMaxExpr(LS, One), LDiff);
3529 }
Dan Gohman30fb5122009-06-18 20:21:07 +00003530 break;
3531 case ICmpInst::ICMP_EQ:
Dan Gohman9f93d302010-04-24 03:09:42 +00003532 // n == 0 ? 1+x : n+x -> umax(n, 1)+x
3533 if (LHS->getType() == U->getType() &&
Dan Gohman30fb5122009-06-18 20:21:07 +00003534 isa<ConstantInt>(RHS) &&
Dan Gohman9f93d302010-04-24 03:09:42 +00003535 cast<ConstantInt>(RHS)->isZero()) {
3536 const SCEV *One = getConstant(LHS->getType(), 1);
3537 const SCEV *LS = getSCEV(LHS);
3538 const SCEV *LA = getSCEV(U->getOperand(1));
3539 const SCEV *RA = getSCEV(U->getOperand(2));
3540 const SCEV *LDiff = getMinusSCEV(LA, One);
3541 const SCEV *RDiff = getMinusSCEV(RA, LS);
3542 if (LDiff == RDiff)
3543 return getAddExpr(getUMaxExpr(LS, One), LDiff);
3544 }
Dan Gohman30fb5122009-06-18 20:21:07 +00003545 break;
Dan Gohman6c459a22008-06-22 19:56:46 +00003546 default:
3547 break;
3548 }
3549 }
3550
3551 default: // We cannot analyze this expression.
3552 break;
Chris Lattner53e677a2004-04-02 20:23:17 +00003553 }
3554
Dan Gohmanf8a8be82009-04-21 23:15:49 +00003555 return getUnknown(V);
Chris Lattner53e677a2004-04-02 20:23:17 +00003556}
3557
3558
3559
3560//===----------------------------------------------------------------------===//
3561// Iteration Count Computation Code
3562//
3563
Dan Gohman46bdfb02009-02-24 18:55:53 +00003564/// getBackedgeTakenCount - If the specified loop has a predictable
3565/// backedge-taken count, return it, otherwise return a SCEVCouldNotCompute
3566/// object. The backedge-taken count is the number of times the loop header
3567/// will be branched to from within the loop. This is one less than the
3568/// trip count of the loop, since it doesn't count the first iteration,
3569/// when the header is branched to from outside the loop.
3570///
3571/// Note that it is not valid to call this method on a loop without a
3572/// loop-invariant backedge-taken count (see
3573/// hasLoopInvariantBackedgeTakenCount).
3574///
Dan Gohman0bba49c2009-07-07 17:06:11 +00003575const SCEV *ScalarEvolution::getBackedgeTakenCount(const Loop *L) {
Dan Gohmana1af7572009-04-30 20:47:05 +00003576 return getBackedgeTakenInfo(L).Exact;
3577}
3578
3579/// getMaxBackedgeTakenCount - Similar to getBackedgeTakenCount, except
3580/// return the least SCEV value that is known never to be less than the
3581/// actual backedge taken count.
Dan Gohman0bba49c2009-07-07 17:06:11 +00003582const SCEV *ScalarEvolution::getMaxBackedgeTakenCount(const Loop *L) {
Dan Gohmana1af7572009-04-30 20:47:05 +00003583 return getBackedgeTakenInfo(L).Max;
3584}
3585
Dan Gohman59ae6b92009-07-08 19:23:34 +00003586/// PushLoopPHIs - Push PHI nodes in the header of the given loop
3587/// onto the given Worklist.
3588static void
3589PushLoopPHIs(const Loop *L, SmallVectorImpl<Instruction *> &Worklist) {
3590 BasicBlock *Header = L->getHeader();
3591
3592 // Push all Loop-header PHIs onto the Worklist stack.
3593 for (BasicBlock::iterator I = Header->begin();
3594 PHINode *PN = dyn_cast<PHINode>(I); ++I)
3595 Worklist.push_back(PN);
3596}
3597
Dan Gohmana1af7572009-04-30 20:47:05 +00003598const ScalarEvolution::BackedgeTakenInfo &
3599ScalarEvolution::getBackedgeTakenInfo(const Loop *L) {
Dan Gohman01ecca22009-04-27 20:16:15 +00003600 // Initially insert a CouldNotCompute for this loop. If the insertion
Dan Gohman3f46a3a2010-03-01 17:49:51 +00003601 // succeeds, proceed to actually compute a backedge-taken count and
Dan Gohman01ecca22009-04-27 20:16:15 +00003602 // update the value. The temporary CouldNotCompute value tells SCEV
3603 // code elsewhere that it shouldn't attempt to request a new
3604 // backedge-taken count, which could result in infinite recursion.
Dan Gohman5d984912009-12-18 01:14:11 +00003605 std::pair<std::map<const Loop *, BackedgeTakenInfo>::iterator, bool> Pair =
Dan Gohman01ecca22009-04-27 20:16:15 +00003606 BackedgeTakenCounts.insert(std::make_pair(L, getCouldNotCompute()));
3607 if (Pair.second) {
Dan Gohman93dacad2010-01-26 16:46:18 +00003608 BackedgeTakenInfo BECount = ComputeBackedgeTakenCount(L);
3609 if (BECount.Exact != getCouldNotCompute()) {
3610 assert(BECount.Exact->isLoopInvariant(L) &&
3611 BECount.Max->isLoopInvariant(L) &&
3612 "Computed backedge-taken count isn't loop invariant for loop!");
Chris Lattner53e677a2004-04-02 20:23:17 +00003613 ++NumTripCountsComputed;
Dan Gohman01ecca22009-04-27 20:16:15 +00003614
Dan Gohman01ecca22009-04-27 20:16:15 +00003615 // Update the value in the map.
Dan Gohman93dacad2010-01-26 16:46:18 +00003616 Pair.first->second = BECount;
Dan Gohmana334aa72009-06-22 00:31:57 +00003617 } else {
Dan Gohman93dacad2010-01-26 16:46:18 +00003618 if (BECount.Max != getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003619 // Update the value in the map.
Dan Gohman93dacad2010-01-26 16:46:18 +00003620 Pair.first->second = BECount;
Dan Gohmana334aa72009-06-22 00:31:57 +00003621 if (isa<PHINode>(L->getHeader()->begin()))
3622 // Only count loops that have phi nodes as not being computable.
3623 ++NumTripCountsNotComputed;
Chris Lattner53e677a2004-04-02 20:23:17 +00003624 }
Dan Gohmana1af7572009-04-30 20:47:05 +00003625
3626 // Now that we know more about the trip count for this loop, forget any
3627 // existing SCEV values for PHI nodes in this loop since they are only
Dan Gohman59ae6b92009-07-08 19:23:34 +00003628 // conservative estimates made without the benefit of trip count
Dan Gohman4c7279a2009-10-31 15:04:55 +00003629 // information. This is similar to the code in forgetLoop, except that
3630 // it handles SCEVUnknown PHI nodes specially.
Dan Gohman93dacad2010-01-26 16:46:18 +00003631 if (BECount.hasAnyInfo()) {
Dan Gohman59ae6b92009-07-08 19:23:34 +00003632 SmallVector<Instruction *, 16> Worklist;
3633 PushLoopPHIs(L, Worklist);
3634
3635 SmallPtrSet<Instruction *, 8> Visited;
3636 while (!Worklist.empty()) {
3637 Instruction *I = Worklist.pop_back_val();
3638 if (!Visited.insert(I)) continue;
3639
Dan Gohman5d984912009-12-18 01:14:11 +00003640 std::map<SCEVCallbackVH, const SCEV *>::iterator It =
Dan Gohman59ae6b92009-07-08 19:23:34 +00003641 Scalars.find(static_cast<Value *>(I));
3642 if (It != Scalars.end()) {
3643 // SCEVUnknown for a PHI either means that it has an unrecognized
3644 // structure, or it's a PHI that's in the progress of being computed
Dan Gohmanba701882009-07-13 22:04:06 +00003645 // by createNodeForPHI. In the former case, additional loop trip
3646 // count information isn't going to change anything. In the later
3647 // case, createNodeForPHI will perform the necessary updates on its
3648 // own when it gets to that point.
Dan Gohman42214892009-08-31 21:15:23 +00003649 if (!isa<PHINode>(I) || !isa<SCEVUnknown>(It->second)) {
3650 ValuesAtScopes.erase(It->second);
Dan Gohman59ae6b92009-07-08 19:23:34 +00003651 Scalars.erase(It);
Dan Gohman42214892009-08-31 21:15:23 +00003652 }
Dan Gohman59ae6b92009-07-08 19:23:34 +00003653 if (PHINode *PN = dyn_cast<PHINode>(I))
3654 ConstantEvolutionLoopExitValue.erase(PN);
3655 }
3656
3657 PushDefUseChildren(I, Worklist);
3658 }
3659 }
Chris Lattner53e677a2004-04-02 20:23:17 +00003660 }
Dan Gohman01ecca22009-04-27 20:16:15 +00003661 return Pair.first->second;
Chris Lattner53e677a2004-04-02 20:23:17 +00003662}
3663
Dan Gohman4c7279a2009-10-31 15:04:55 +00003664/// forgetLoop - This method should be called by the client when it has
3665/// changed a loop in a way that may effect ScalarEvolution's ability to
3666/// compute a trip count, or if the loop is deleted.
3667void ScalarEvolution::forgetLoop(const Loop *L) {
3668 // Drop any stored trip count value.
Dan Gohman46bdfb02009-02-24 18:55:53 +00003669 BackedgeTakenCounts.erase(L);
Dan Gohmanfb7d35f2009-05-02 17:43:35 +00003670
Dan Gohman4c7279a2009-10-31 15:04:55 +00003671 // Drop information about expressions based on loop-header PHIs.
Dan Gohman35738ac2009-05-04 22:30:44 +00003672 SmallVector<Instruction *, 16> Worklist;
Dan Gohman59ae6b92009-07-08 19:23:34 +00003673 PushLoopPHIs(L, Worklist);
Dan Gohman35738ac2009-05-04 22:30:44 +00003674
Dan Gohman59ae6b92009-07-08 19:23:34 +00003675 SmallPtrSet<Instruction *, 8> Visited;
Dan Gohman35738ac2009-05-04 22:30:44 +00003676 while (!Worklist.empty()) {
3677 Instruction *I = Worklist.pop_back_val();
Dan Gohman59ae6b92009-07-08 19:23:34 +00003678 if (!Visited.insert(I)) continue;
3679
Dan Gohman5d984912009-12-18 01:14:11 +00003680 std::map<SCEVCallbackVH, const SCEV *>::iterator It =
Dan Gohman59ae6b92009-07-08 19:23:34 +00003681 Scalars.find(static_cast<Value *>(I));
3682 if (It != Scalars.end()) {
Dan Gohman42214892009-08-31 21:15:23 +00003683 ValuesAtScopes.erase(It->second);
Dan Gohman59ae6b92009-07-08 19:23:34 +00003684 Scalars.erase(It);
Dan Gohman59ae6b92009-07-08 19:23:34 +00003685 if (PHINode *PN = dyn_cast<PHINode>(I))
3686 ConstantEvolutionLoopExitValue.erase(PN);
3687 }
3688
3689 PushDefUseChildren(I, Worklist);
Dan Gohman35738ac2009-05-04 22:30:44 +00003690 }
Dan Gohman60f8a632009-02-17 20:49:49 +00003691}
3692
Eric Christophere6cbfa62010-07-29 01:25:38 +00003693/// forgetValue - This method should be called by the client when it has
3694/// changed a value in a way that may effect its value, or which may
3695/// disconnect it from a def-use chain linking it to a loop.
3696void ScalarEvolution::forgetValue(Value *V) {
Dale Johannesen45a2d7d2010-02-19 07:14:22 +00003697 Instruction *I = dyn_cast<Instruction>(V);
3698 if (!I) return;
3699
3700 // Drop information about expressions based on loop-header PHIs.
3701 SmallVector<Instruction *, 16> Worklist;
3702 Worklist.push_back(I);
3703
3704 SmallPtrSet<Instruction *, 8> Visited;
3705 while (!Worklist.empty()) {
3706 I = Worklist.pop_back_val();
3707 if (!Visited.insert(I)) continue;
3708
3709 std::map<SCEVCallbackVH, const SCEV *>::iterator It =
3710 Scalars.find(static_cast<Value *>(I));
3711 if (It != Scalars.end()) {
3712 ValuesAtScopes.erase(It->second);
3713 Scalars.erase(It);
3714 if (PHINode *PN = dyn_cast<PHINode>(I))
3715 ConstantEvolutionLoopExitValue.erase(PN);
3716 }
3717
3718 PushDefUseChildren(I, Worklist);
3719 }
3720}
3721
Dan Gohman46bdfb02009-02-24 18:55:53 +00003722/// ComputeBackedgeTakenCount - Compute the number of times the backedge
3723/// of the specified loop will execute.
Dan Gohmana1af7572009-04-30 20:47:05 +00003724ScalarEvolution::BackedgeTakenInfo
3725ScalarEvolution::ComputeBackedgeTakenCount(const Loop *L) {
Dan Gohman5d984912009-12-18 01:14:11 +00003726 SmallVector<BasicBlock *, 8> ExitingBlocks;
Dan Gohmana334aa72009-06-22 00:31:57 +00003727 L->getExitingBlocks(ExitingBlocks);
Chris Lattner53e677a2004-04-02 20:23:17 +00003728
Dan Gohmana334aa72009-06-22 00:31:57 +00003729 // Examine all exits and pick the most conservative values.
Dan Gohman0bba49c2009-07-07 17:06:11 +00003730 const SCEV *BECount = getCouldNotCompute();
3731 const SCEV *MaxBECount = getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003732 bool CouldNotComputeBECount = false;
Dan Gohmana334aa72009-06-22 00:31:57 +00003733 for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) {
3734 BackedgeTakenInfo NewBTI =
3735 ComputeBackedgeTakenCountFromExit(L, ExitingBlocks[i]);
Chris Lattner53e677a2004-04-02 20:23:17 +00003736
Dan Gohman1c343752009-06-27 21:21:31 +00003737 if (NewBTI.Exact == getCouldNotCompute()) {
Dan Gohmana334aa72009-06-22 00:31:57 +00003738 // We couldn't compute an exact value for this exit, so
Dan Gohmand32f5bf2009-06-22 21:10:22 +00003739 // we won't be able to compute an exact value for the loop.
Dan Gohmana334aa72009-06-22 00:31:57 +00003740 CouldNotComputeBECount = true;
Dan Gohman1c343752009-06-27 21:21:31 +00003741 BECount = getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003742 } else if (!CouldNotComputeBECount) {
Dan Gohman1c343752009-06-27 21:21:31 +00003743 if (BECount == getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003744 BECount = NewBTI.Exact;
Dan Gohmana334aa72009-06-22 00:31:57 +00003745 else
Dan Gohman40a5a1b2009-06-24 01:18:18 +00003746 BECount = getUMinFromMismatchedTypes(BECount, NewBTI.Exact);
Dan Gohmana334aa72009-06-22 00:31:57 +00003747 }
Dan Gohman1c343752009-06-27 21:21:31 +00003748 if (MaxBECount == getCouldNotCompute())
Dan Gohman40a5a1b2009-06-24 01:18:18 +00003749 MaxBECount = NewBTI.Max;
Dan Gohman1c343752009-06-27 21:21:31 +00003750 else if (NewBTI.Max != getCouldNotCompute())
Dan Gohman40a5a1b2009-06-24 01:18:18 +00003751 MaxBECount = getUMinFromMismatchedTypes(MaxBECount, NewBTI.Max);
Dan Gohmana334aa72009-06-22 00:31:57 +00003752 }
3753
3754 return BackedgeTakenInfo(BECount, MaxBECount);
3755}
3756
3757/// ComputeBackedgeTakenCountFromExit - Compute the number of times the backedge
3758/// of the specified loop will execute if it exits via the specified block.
3759ScalarEvolution::BackedgeTakenInfo
3760ScalarEvolution::ComputeBackedgeTakenCountFromExit(const Loop *L,
3761 BasicBlock *ExitingBlock) {
3762
3763 // Okay, we've chosen an exiting block. See what condition causes us to
3764 // exit at this block.
Chris Lattner53e677a2004-04-02 20:23:17 +00003765 //
3766 // FIXME: we should be able to handle switch instructions (with a single exit)
Chris Lattner53e677a2004-04-02 20:23:17 +00003767 BranchInst *ExitBr = dyn_cast<BranchInst>(ExitingBlock->getTerminator());
Dan Gohman1c343752009-06-27 21:21:31 +00003768 if (ExitBr == 0) return getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00003769 assert(ExitBr->isConditional() && "If unconditional, it can't be in loop!");
Dan Gohman64a845e2009-06-24 04:48:43 +00003770
Chris Lattner8b0e3602007-01-07 02:24:26 +00003771 // At this point, we know we have a conditional branch that determines whether
3772 // the loop is exited. However, we don't know if the branch is executed each
3773 // time through the loop. If not, then the execution count of the branch will
3774 // not be equal to the trip count of the loop.
3775 //
3776 // Currently we check for this by checking to see if the Exit branch goes to
3777 // the loop header. If so, we know it will always execute the same number of
Chris Lattner192e4032007-01-14 01:24:47 +00003778 // times as the loop. We also handle the case where the exit block *is* the
Dan Gohmana334aa72009-06-22 00:31:57 +00003779 // loop header. This is common for un-rotated loops.
3780 //
3781 // If both of those tests fail, walk up the unique predecessor chain to the
3782 // header, stopping if there is an edge that doesn't exit the loop. If the
3783 // header is reached, the execution count of the branch will be equal to the
3784 // trip count of the loop.
3785 //
3786 // More extensive analysis could be done to handle more cases here.
3787 //
Chris Lattner8b0e3602007-01-07 02:24:26 +00003788 if (ExitBr->getSuccessor(0) != L->getHeader() &&
Chris Lattner192e4032007-01-14 01:24:47 +00003789 ExitBr->getSuccessor(1) != L->getHeader() &&
Dan Gohmana334aa72009-06-22 00:31:57 +00003790 ExitBr->getParent() != L->getHeader()) {
3791 // The simple checks failed, try climbing the unique predecessor chain
3792 // up to the header.
3793 bool Ok = false;
3794 for (BasicBlock *BB = ExitBr->getParent(); BB; ) {
3795 BasicBlock *Pred = BB->getUniquePredecessor();
3796 if (!Pred)
Dan Gohman1c343752009-06-27 21:21:31 +00003797 return getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003798 TerminatorInst *PredTerm = Pred->getTerminator();
3799 for (unsigned i = 0, e = PredTerm->getNumSuccessors(); i != e; ++i) {
3800 BasicBlock *PredSucc = PredTerm->getSuccessor(i);
3801 if (PredSucc == BB)
3802 continue;
3803 // If the predecessor has a successor that isn't BB and isn't
3804 // outside the loop, assume the worst.
3805 if (L->contains(PredSucc))
Dan Gohman1c343752009-06-27 21:21:31 +00003806 return getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003807 }
3808 if (Pred == L->getHeader()) {
3809 Ok = true;
3810 break;
3811 }
3812 BB = Pred;
3813 }
3814 if (!Ok)
Dan Gohman1c343752009-06-27 21:21:31 +00003815 return getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003816 }
3817
Dan Gohman3f46a3a2010-03-01 17:49:51 +00003818 // Proceed to the next level to examine the exit condition expression.
Dan Gohmana334aa72009-06-22 00:31:57 +00003819 return ComputeBackedgeTakenCountFromExitCond(L, ExitBr->getCondition(),
3820 ExitBr->getSuccessor(0),
3821 ExitBr->getSuccessor(1));
3822}
3823
3824/// ComputeBackedgeTakenCountFromExitCond - Compute the number of times the
3825/// backedge of the specified loop will execute if its exit condition
3826/// were a conditional branch of ExitCond, TBB, and FBB.
3827ScalarEvolution::BackedgeTakenInfo
3828ScalarEvolution::ComputeBackedgeTakenCountFromExitCond(const Loop *L,
3829 Value *ExitCond,
3830 BasicBlock *TBB,
3831 BasicBlock *FBB) {
Dan Gohman40a5a1b2009-06-24 01:18:18 +00003832 // Check if the controlling expression for this loop is an And or Or.
Dan Gohmana334aa72009-06-22 00:31:57 +00003833 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(ExitCond)) {
3834 if (BO->getOpcode() == Instruction::And) {
3835 // Recurse on the operands of the and.
3836 BackedgeTakenInfo BTI0 =
3837 ComputeBackedgeTakenCountFromExitCond(L, BO->getOperand(0), TBB, FBB);
3838 BackedgeTakenInfo BTI1 =
3839 ComputeBackedgeTakenCountFromExitCond(L, BO->getOperand(1), TBB, FBB);
Dan Gohman0bba49c2009-07-07 17:06:11 +00003840 const SCEV *BECount = getCouldNotCompute();
3841 const SCEV *MaxBECount = getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003842 if (L->contains(TBB)) {
3843 // Both conditions must be true for the loop to continue executing.
3844 // Choose the less conservative count.
Dan Gohman1c343752009-06-27 21:21:31 +00003845 if (BTI0.Exact == getCouldNotCompute() ||
3846 BTI1.Exact == getCouldNotCompute())
3847 BECount = getCouldNotCompute();
Dan Gohman60e9b072009-06-22 15:09:28 +00003848 else
3849 BECount = getUMinFromMismatchedTypes(BTI0.Exact, BTI1.Exact);
Dan Gohman1c343752009-06-27 21:21:31 +00003850 if (BTI0.Max == getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003851 MaxBECount = BTI1.Max;
Dan Gohman1c343752009-06-27 21:21:31 +00003852 else if (BTI1.Max == getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003853 MaxBECount = BTI0.Max;
Dan Gohman60e9b072009-06-22 15:09:28 +00003854 else
3855 MaxBECount = getUMinFromMismatchedTypes(BTI0.Max, BTI1.Max);
Dan Gohmana334aa72009-06-22 00:31:57 +00003856 } else {
3857 // Both conditions must be true for the loop to exit.
3858 assert(L->contains(FBB) && "Loop block has no successor in loop!");
Dan Gohman1c343752009-06-27 21:21:31 +00003859 if (BTI0.Exact != getCouldNotCompute() &&
3860 BTI1.Exact != getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003861 BECount = getUMaxFromMismatchedTypes(BTI0.Exact, BTI1.Exact);
Dan Gohman1c343752009-06-27 21:21:31 +00003862 if (BTI0.Max != getCouldNotCompute() &&
3863 BTI1.Max != getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003864 MaxBECount = getUMaxFromMismatchedTypes(BTI0.Max, BTI1.Max);
3865 }
3866
3867 return BackedgeTakenInfo(BECount, MaxBECount);
3868 }
3869 if (BO->getOpcode() == Instruction::Or) {
3870 // Recurse on the operands of the or.
3871 BackedgeTakenInfo BTI0 =
3872 ComputeBackedgeTakenCountFromExitCond(L, BO->getOperand(0), TBB, FBB);
3873 BackedgeTakenInfo BTI1 =
3874 ComputeBackedgeTakenCountFromExitCond(L, BO->getOperand(1), TBB, FBB);
Dan Gohman0bba49c2009-07-07 17:06:11 +00003875 const SCEV *BECount = getCouldNotCompute();
3876 const SCEV *MaxBECount = getCouldNotCompute();
Dan Gohmana334aa72009-06-22 00:31:57 +00003877 if (L->contains(FBB)) {
3878 // Both conditions must be false for the loop to continue executing.
3879 // Choose the less conservative count.
Dan Gohman1c343752009-06-27 21:21:31 +00003880 if (BTI0.Exact == getCouldNotCompute() ||
3881 BTI1.Exact == getCouldNotCompute())
3882 BECount = getCouldNotCompute();
Dan Gohman60e9b072009-06-22 15:09:28 +00003883 else
3884 BECount = getUMinFromMismatchedTypes(BTI0.Exact, BTI1.Exact);
Dan Gohman1c343752009-06-27 21:21:31 +00003885 if (BTI0.Max == getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003886 MaxBECount = BTI1.Max;
Dan Gohman1c343752009-06-27 21:21:31 +00003887 else if (BTI1.Max == getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003888 MaxBECount = BTI0.Max;
Dan Gohman60e9b072009-06-22 15:09:28 +00003889 else
3890 MaxBECount = getUMinFromMismatchedTypes(BTI0.Max, BTI1.Max);
Dan Gohmana334aa72009-06-22 00:31:57 +00003891 } else {
3892 // Both conditions must be false for the loop to exit.
3893 assert(L->contains(TBB) && "Loop block has no successor in loop!");
Dan Gohman1c343752009-06-27 21:21:31 +00003894 if (BTI0.Exact != getCouldNotCompute() &&
3895 BTI1.Exact != getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003896 BECount = getUMaxFromMismatchedTypes(BTI0.Exact, BTI1.Exact);
Dan Gohman1c343752009-06-27 21:21:31 +00003897 if (BTI0.Max != getCouldNotCompute() &&
3898 BTI1.Max != getCouldNotCompute())
Dan Gohmana334aa72009-06-22 00:31:57 +00003899 MaxBECount = getUMaxFromMismatchedTypes(BTI0.Max, BTI1.Max);
3900 }
3901
3902 return BackedgeTakenInfo(BECount, MaxBECount);
3903 }
3904 }
3905
3906 // With an icmp, it may be feasible to compute an exact backedge-taken count.
Dan Gohman3f46a3a2010-03-01 17:49:51 +00003907 // Proceed to the next level to examine the icmp.
Dan Gohmana334aa72009-06-22 00:31:57 +00003908 if (ICmpInst *ExitCondICmp = dyn_cast<ICmpInst>(ExitCond))
3909 return ComputeBackedgeTakenCountFromExitCondICmp(L, ExitCondICmp, TBB, FBB);
Reid Spencere4d87aa2006-12-23 06:05:41 +00003910
Dan Gohman00cb5b72010-02-19 18:12:07 +00003911 // Check for a constant condition. These are normally stripped out by
3912 // SimplifyCFG, but ScalarEvolution may be used by a pass which wishes to
3913 // preserve the CFG and is temporarily leaving constant conditions
3914 // in place.
3915 if (ConstantInt *CI = dyn_cast<ConstantInt>(ExitCond)) {
3916 if (L->contains(FBB) == !CI->getZExtValue())
3917 // The backedge is always taken.
3918 return getCouldNotCompute();
3919 else
3920 // The backedge is never taken.
Dan Gohmandeff6212010-05-03 22:09:21 +00003921 return getConstant(CI->getType(), 0);
Dan Gohman00cb5b72010-02-19 18:12:07 +00003922 }
3923
Eli Friedman361e54d2009-05-09 12:32:42 +00003924 // If it's not an integer or pointer comparison then compute it the hard way.
Dan Gohmana334aa72009-06-22 00:31:57 +00003925 return ComputeBackedgeTakenCountExhaustively(L, ExitCond, !L->contains(TBB));
3926}
3927
3928/// ComputeBackedgeTakenCountFromExitCondICmp - Compute the number of times the
3929/// backedge of the specified loop will execute if its exit condition
3930/// were a conditional branch of the ICmpInst ExitCond, TBB, and FBB.
3931ScalarEvolution::BackedgeTakenInfo
3932ScalarEvolution::ComputeBackedgeTakenCountFromExitCondICmp(const Loop *L,
3933 ICmpInst *ExitCond,
3934 BasicBlock *TBB,
3935 BasicBlock *FBB) {
Chris Lattner53e677a2004-04-02 20:23:17 +00003936
Reid Spencere4d87aa2006-12-23 06:05:41 +00003937 // If the condition was exit on true, convert the condition to exit on false
3938 ICmpInst::Predicate Cond;
Dan Gohmana334aa72009-06-22 00:31:57 +00003939 if (!L->contains(FBB))
Reid Spencere4d87aa2006-12-23 06:05:41 +00003940 Cond = ExitCond->getPredicate();
Chris Lattner673e02b2004-10-12 01:49:27 +00003941 else
Reid Spencere4d87aa2006-12-23 06:05:41 +00003942 Cond = ExitCond->getInversePredicate();
Chris Lattner673e02b2004-10-12 01:49:27 +00003943
3944 // Handle common loops like: for (X = "string"; *X; ++X)
3945 if (LoadInst *LI = dyn_cast<LoadInst>(ExitCond->getOperand(0)))
3946 if (Constant *RHS = dyn_cast<Constant>(ExitCond->getOperand(1))) {
Dan Gohmanf6d009f2010-02-24 17:31:30 +00003947 BackedgeTakenInfo ItCnt =
Dan Gohman46bdfb02009-02-24 18:55:53 +00003948 ComputeLoadConstantCompareBackedgeTakenCount(LI, RHS, L, Cond);
Dan Gohmanf6d009f2010-02-24 17:31:30 +00003949 if (ItCnt.hasAnyInfo())
3950 return ItCnt;
Chris Lattner673e02b2004-10-12 01:49:27 +00003951 }
3952
Dan Gohman0bba49c2009-07-07 17:06:11 +00003953 const SCEV *LHS = getSCEV(ExitCond->getOperand(0));
3954 const SCEV *RHS = getSCEV(ExitCond->getOperand(1));
Chris Lattner53e677a2004-04-02 20:23:17 +00003955
3956 // Try to evaluate any dependencies out of the loop.
Dan Gohmand594e6f2009-05-24 23:25:42 +00003957 LHS = getSCEVAtScope(LHS, L);
3958 RHS = getSCEVAtScope(RHS, L);
Chris Lattner53e677a2004-04-02 20:23:17 +00003959
Dan Gohman64a845e2009-06-24 04:48:43 +00003960 // At this point, we would like to compute how many iterations of the
Reid Spencere4d87aa2006-12-23 06:05:41 +00003961 // loop the predicate will return true for these inputs.
Dan Gohman70ff4cf2008-09-16 18:52:57 +00003962 if (LHS->isLoopInvariant(L) && !RHS->isLoopInvariant(L)) {
3963 // If there is a loop-invariant, force it into the RHS.
Chris Lattner53e677a2004-04-02 20:23:17 +00003964 std::swap(LHS, RHS);
Reid Spencere4d87aa2006-12-23 06:05:41 +00003965 Cond = ICmpInst::getSwappedPredicate(Cond);
Chris Lattner53e677a2004-04-02 20:23:17 +00003966 }
3967
Dan Gohman03557dc2010-05-03 16:35:17 +00003968 // Simplify the operands before analyzing them.
3969 (void)SimplifyICmpOperands(Cond, LHS, RHS);
3970
Chris Lattner53e677a2004-04-02 20:23:17 +00003971 // If we have a comparison of a chrec against a constant, try to use value
3972 // ranges to answer this query.
Dan Gohman622ed672009-05-04 22:02:23 +00003973 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS))
3974 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS))
Chris Lattner53e677a2004-04-02 20:23:17 +00003975 if (AddRec->getLoop() == L) {
Eli Friedman361e54d2009-05-09 12:32:42 +00003976 // Form the constant range.
3977 ConstantRange CompRange(
3978 ICmpInst::makeConstantRange(Cond, RHSC->getValue()->getValue()));
Misha Brukman2b37d7c2005-04-21 21:13:18 +00003979
Dan Gohman0bba49c2009-07-07 17:06:11 +00003980 const SCEV *Ret = AddRec->getNumIterationsInRange(CompRange, *this);
Eli Friedman361e54d2009-05-09 12:32:42 +00003981 if (!isa<SCEVCouldNotCompute>(Ret)) return Ret;
Chris Lattner53e677a2004-04-02 20:23:17 +00003982 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00003983
Chris Lattner53e677a2004-04-02 20:23:17 +00003984 switch (Cond) {
Reid Spencere4d87aa2006-12-23 06:05:41 +00003985 case ICmpInst::ICMP_NE: { // while (X != Y)
Chris Lattner53e677a2004-04-02 20:23:17 +00003986 // Convert to: while (X-Y != 0)
Dan Gohmanf6d009f2010-02-24 17:31:30 +00003987 BackedgeTakenInfo BTI = HowFarToZero(getMinusSCEV(LHS, RHS), L);
3988 if (BTI.hasAnyInfo()) return BTI;
Chris Lattner53e677a2004-04-02 20:23:17 +00003989 break;
Reid Spencere4d87aa2006-12-23 06:05:41 +00003990 }
Dan Gohman4c0d5d52009-08-20 16:42:55 +00003991 case ICmpInst::ICMP_EQ: { // while (X == Y)
3992 // Convert to: while (X-Y == 0)
Dan Gohmanf6d009f2010-02-24 17:31:30 +00003993 BackedgeTakenInfo BTI = HowFarToNonZero(getMinusSCEV(LHS, RHS), L);
3994 if (BTI.hasAnyInfo()) return BTI;
Chris Lattner53e677a2004-04-02 20:23:17 +00003995 break;
Reid Spencere4d87aa2006-12-23 06:05:41 +00003996 }
3997 case ICmpInst::ICMP_SLT: {
Dan Gohmana1af7572009-04-30 20:47:05 +00003998 BackedgeTakenInfo BTI = HowManyLessThans(LHS, RHS, L, true);
3999 if (BTI.hasAnyInfo()) return BTI;
Chris Lattnerdb25de42005-08-15 23:33:51 +00004000 break;
Reid Spencere4d87aa2006-12-23 06:05:41 +00004001 }
4002 case ICmpInst::ICMP_SGT: {
Dan Gohmana1af7572009-04-30 20:47:05 +00004003 BackedgeTakenInfo BTI = HowManyLessThans(getNotSCEV(LHS),
4004 getNotSCEV(RHS), L, true);
4005 if (BTI.hasAnyInfo()) return BTI;
Nick Lewyckyd6dac0e2007-08-06 19:21:00 +00004006 break;
4007 }
4008 case ICmpInst::ICMP_ULT: {
Dan Gohmana1af7572009-04-30 20:47:05 +00004009 BackedgeTakenInfo BTI = HowManyLessThans(LHS, RHS, L, false);
4010 if (BTI.hasAnyInfo()) return BTI;
Nick Lewyckyd6dac0e2007-08-06 19:21:00 +00004011 break;
4012 }
4013 case ICmpInst::ICMP_UGT: {
Dan Gohmana1af7572009-04-30 20:47:05 +00004014 BackedgeTakenInfo BTI = HowManyLessThans(getNotSCEV(LHS),
4015 getNotSCEV(RHS), L, false);
4016 if (BTI.hasAnyInfo()) return BTI;
Chris Lattnerdb25de42005-08-15 23:33:51 +00004017 break;
Reid Spencere4d87aa2006-12-23 06:05:41 +00004018 }
Chris Lattner53e677a2004-04-02 20:23:17 +00004019 default:
Chris Lattnerd18d9dc2004-04-02 20:26:46 +00004020#if 0
David Greene25e0e872009-12-23 22:18:14 +00004021 dbgs() << "ComputeBackedgeTakenCount ";
Chris Lattner53e677a2004-04-02 20:23:17 +00004022 if (ExitCond->getOperand(0)->getType()->isUnsigned())
David Greene25e0e872009-12-23 22:18:14 +00004023 dbgs() << "[unsigned] ";
4024 dbgs() << *LHS << " "
Dan Gohman64a845e2009-06-24 04:48:43 +00004025 << Instruction::getOpcodeName(Instruction::ICmp)
Reid Spencere4d87aa2006-12-23 06:05:41 +00004026 << " " << *RHS << "\n";
Chris Lattnerd18d9dc2004-04-02 20:26:46 +00004027#endif
Chris Lattnere34c0b42004-04-03 00:43:03 +00004028 break;
Chris Lattner53e677a2004-04-02 20:23:17 +00004029 }
Dan Gohman46bdfb02009-02-24 18:55:53 +00004030 return
Dan Gohmana334aa72009-06-22 00:31:57 +00004031 ComputeBackedgeTakenCountExhaustively(L, ExitCond, !L->contains(TBB));
Chris Lattner7980fb92004-04-17 18:36:24 +00004032}
4033
Chris Lattner673e02b2004-10-12 01:49:27 +00004034static ConstantInt *
Dan Gohman246b2562007-10-22 18:31:58 +00004035EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, ConstantInt *C,
4036 ScalarEvolution &SE) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00004037 const SCEV *InVal = SE.getConstant(C);
4038 const SCEV *Val = AddRec->evaluateAtIteration(InVal, SE);
Chris Lattner673e02b2004-10-12 01:49:27 +00004039 assert(isa<SCEVConstant>(Val) &&
4040 "Evaluation of SCEV at constant didn't fold correctly?");
4041 return cast<SCEVConstant>(Val)->getValue();
4042}
4043
4044/// GetAddressedElementFromGlobal - Given a global variable with an initializer
4045/// and a GEP expression (missing the pointer index) indexing into it, return
4046/// the addressed element of the initializer or null if the index expression is
4047/// invalid.
4048static Constant *
Nick Lewyckyc6501b12009-11-23 03:26:09 +00004049GetAddressedElementFromGlobal(GlobalVariable *GV,
Chris Lattner673e02b2004-10-12 01:49:27 +00004050 const std::vector<ConstantInt*> &Indices) {
4051 Constant *Init = GV->getInitializer();
4052 for (unsigned i = 0, e = Indices.size(); i != e; ++i) {
Reid Spencerb83eb642006-10-20 07:07:24 +00004053 uint64_t Idx = Indices[i]->getZExtValue();
Chris Lattner673e02b2004-10-12 01:49:27 +00004054 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Init)) {
4055 assert(Idx < CS->getNumOperands() && "Bad struct index!");
4056 Init = cast<Constant>(CS->getOperand(Idx));
4057 } else if (ConstantArray *CA = dyn_cast<ConstantArray>(Init)) {
4058 if (Idx >= CA->getNumOperands()) return 0; // Bogus program
4059 Init = cast<Constant>(CA->getOperand(Idx));
4060 } else if (isa<ConstantAggregateZero>(Init)) {
4061 if (const StructType *STy = dyn_cast<StructType>(Init->getType())) {
4062 assert(Idx < STy->getNumElements() && "Bad struct index!");
Owen Andersona7235ea2009-07-31 20:28:14 +00004063 Init = Constant::getNullValue(STy->getElementType(Idx));
Chris Lattner673e02b2004-10-12 01:49:27 +00004064 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Init->getType())) {
4065 if (Idx >= ATy->getNumElements()) return 0; // Bogus program
Owen Andersona7235ea2009-07-31 20:28:14 +00004066 Init = Constant::getNullValue(ATy->getElementType());
Chris Lattner673e02b2004-10-12 01:49:27 +00004067 } else {
Torok Edwinc23197a2009-07-14 16:55:14 +00004068 llvm_unreachable("Unknown constant aggregate type!");
Chris Lattner673e02b2004-10-12 01:49:27 +00004069 }
4070 return 0;
4071 } else {
4072 return 0; // Unknown initializer type
4073 }
4074 }
4075 return Init;
4076}
4077
Dan Gohman46bdfb02009-02-24 18:55:53 +00004078/// ComputeLoadConstantCompareBackedgeTakenCount - Given an exit condition of
4079/// 'icmp op load X, cst', try to see if we can compute the backedge
4080/// execution count.
Dan Gohmanf6d009f2010-02-24 17:31:30 +00004081ScalarEvolution::BackedgeTakenInfo
Dan Gohman64a845e2009-06-24 04:48:43 +00004082ScalarEvolution::ComputeLoadConstantCompareBackedgeTakenCount(
4083 LoadInst *LI,
4084 Constant *RHS,
4085 const Loop *L,
4086 ICmpInst::Predicate predicate) {
Dan Gohman1c343752009-06-27 21:21:31 +00004087 if (LI->isVolatile()) return getCouldNotCompute();
Chris Lattner673e02b2004-10-12 01:49:27 +00004088
4089 // Check to see if the loaded pointer is a getelementptr of a global.
Dan Gohmanf6d009f2010-02-24 17:31:30 +00004090 // TODO: Use SCEV instead of manually grubbing with GEPs.
Chris Lattner673e02b2004-10-12 01:49:27 +00004091 GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0));
Dan Gohman1c343752009-06-27 21:21:31 +00004092 if (!GEP) return getCouldNotCompute();
Chris Lattner673e02b2004-10-12 01:49:27 +00004093
4094 // Make sure that it is really a constant global we are gepping, with an
4095 // initializer, and make sure the first IDX is really 0.
4096 GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0));
Dan Gohman82555732009-08-19 18:20:44 +00004097 if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
Chris Lattner673e02b2004-10-12 01:49:27 +00004098 GEP->getNumOperands() < 3 || !isa<Constant>(GEP->getOperand(1)) ||
4099 !cast<Constant>(GEP->getOperand(1))->isNullValue())
Dan Gohman1c343752009-06-27 21:21:31 +00004100 return getCouldNotCompute();
Chris Lattner673e02b2004-10-12 01:49:27 +00004101
4102 // Okay, we allow one non-constant index into the GEP instruction.
4103 Value *VarIdx = 0;
4104 std::vector<ConstantInt*> Indexes;
4105 unsigned VarIdxNum = 0;
4106 for (unsigned i = 2, e = GEP->getNumOperands(); i != e; ++i)
4107 if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
4108 Indexes.push_back(CI);
4109 } else if (!isa<ConstantInt>(GEP->getOperand(i))) {
Dan Gohman1c343752009-06-27 21:21:31 +00004110 if (VarIdx) return getCouldNotCompute(); // Multiple non-constant idx's.
Chris Lattner673e02b2004-10-12 01:49:27 +00004111 VarIdx = GEP->getOperand(i);
4112 VarIdxNum = i-2;
4113 Indexes.push_back(0);
4114 }
4115
4116 // Okay, we know we have a (load (gep GV, 0, X)) comparison with a constant.
4117 // Check to see if X is a loop variant variable value now.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004118 const SCEV *Idx = getSCEV(VarIdx);
Dan Gohmand594e6f2009-05-24 23:25:42 +00004119 Idx = getSCEVAtScope(Idx, L);
Chris Lattner673e02b2004-10-12 01:49:27 +00004120
4121 // We can only recognize very limited forms of loop index expressions, in
4122 // particular, only affine AddRec's like {C1,+,C2}.
Dan Gohman35738ac2009-05-04 22:30:44 +00004123 const SCEVAddRecExpr *IdxExpr = dyn_cast<SCEVAddRecExpr>(Idx);
Chris Lattner673e02b2004-10-12 01:49:27 +00004124 if (!IdxExpr || !IdxExpr->isAffine() || IdxExpr->isLoopInvariant(L) ||
4125 !isa<SCEVConstant>(IdxExpr->getOperand(0)) ||
4126 !isa<SCEVConstant>(IdxExpr->getOperand(1)))
Dan Gohman1c343752009-06-27 21:21:31 +00004127 return getCouldNotCompute();
Chris Lattner673e02b2004-10-12 01:49:27 +00004128
4129 unsigned MaxSteps = MaxBruteForceIterations;
4130 for (unsigned IterationNum = 0; IterationNum != MaxSteps; ++IterationNum) {
Owen Andersoneed707b2009-07-24 23:12:02 +00004131 ConstantInt *ItCst = ConstantInt::get(
Owen Anderson9adc0ab2009-07-14 23:09:55 +00004132 cast<IntegerType>(IdxExpr->getType()), IterationNum);
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004133 ConstantInt *Val = EvaluateConstantChrecAtConstant(IdxExpr, ItCst, *this);
Chris Lattner673e02b2004-10-12 01:49:27 +00004134
4135 // Form the GEP offset.
4136 Indexes[VarIdxNum] = Val;
4137
Nick Lewyckyc6501b12009-11-23 03:26:09 +00004138 Constant *Result = GetAddressedElementFromGlobal(GV, Indexes);
Chris Lattner673e02b2004-10-12 01:49:27 +00004139 if (Result == 0) break; // Cannot compute!
4140
4141 // Evaluate the condition for this iteration.
Reid Spencere4d87aa2006-12-23 06:05:41 +00004142 Result = ConstantExpr::getICmp(predicate, Result, RHS);
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00004143 if (!isa<ConstantInt>(Result)) break; // Couldn't decide for sure
Reid Spencere8019bb2007-03-01 07:25:48 +00004144 if (cast<ConstantInt>(Result)->getValue().isMinValue()) {
Chris Lattner673e02b2004-10-12 01:49:27 +00004145#if 0
David Greene25e0e872009-12-23 22:18:14 +00004146 dbgs() << "\n***\n*** Computed loop count " << *ItCst
Dan Gohmanb7ef7292009-04-21 00:47:46 +00004147 << "\n*** From global " << *GV << "*** BB: " << *L->getHeader()
4148 << "***\n";
Chris Lattner673e02b2004-10-12 01:49:27 +00004149#endif
4150 ++NumArrayLenItCounts;
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004151 return getConstant(ItCst); // Found terminating iteration!
Chris Lattner673e02b2004-10-12 01:49:27 +00004152 }
4153 }
Dan Gohman1c343752009-06-27 21:21:31 +00004154 return getCouldNotCompute();
Chris Lattner673e02b2004-10-12 01:49:27 +00004155}
4156
4157
Chris Lattner3221ad02004-04-17 22:58:41 +00004158/// CanConstantFold - Return true if we can constant fold an instruction of the
4159/// specified type, assuming that all operands were constants.
4160static bool CanConstantFold(const Instruction *I) {
Reid Spencer832254e2007-02-02 02:16:23 +00004161 if (isa<BinaryOperator>(I) || isa<CmpInst>(I) ||
Chris Lattner3221ad02004-04-17 22:58:41 +00004162 isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I))
4163 return true;
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004164
Chris Lattner3221ad02004-04-17 22:58:41 +00004165 if (const CallInst *CI = dyn_cast<CallInst>(I))
4166 if (const Function *F = CI->getCalledFunction())
Dan Gohmanfa9b80e2008-01-31 01:05:10 +00004167 return canConstantFoldCallTo(F);
Chris Lattner3221ad02004-04-17 22:58:41 +00004168 return false;
Chris Lattner7980fb92004-04-17 18:36:24 +00004169}
4170
Chris Lattner3221ad02004-04-17 22:58:41 +00004171/// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node
4172/// in the loop that V is derived from. We allow arbitrary operations along the
4173/// way, but the operands of an operation must either be constants or a value
4174/// derived from a constant PHI. If this expression does not fit with these
4175/// constraints, return null.
4176static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) {
4177 // If this is not an instruction, or if this is an instruction outside of the
4178 // loop, it can't be derived from a loop PHI.
4179 Instruction *I = dyn_cast<Instruction>(V);
Dan Gohman92329c72009-12-18 01:24:09 +00004180 if (I == 0 || !L->contains(I)) return 0;
Chris Lattner3221ad02004-04-17 22:58:41 +00004181
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +00004182 if (PHINode *PN = dyn_cast<PHINode>(I)) {
Chris Lattner3221ad02004-04-17 22:58:41 +00004183 if (L->getHeader() == I->getParent())
4184 return PN;
4185 else
4186 // We don't currently keep track of the control flow needed to evaluate
4187 // PHIs, so we cannot handle PHIs inside of loops.
4188 return 0;
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +00004189 }
Chris Lattner3221ad02004-04-17 22:58:41 +00004190
4191 // If we won't be able to constant fold this expression even if the operands
4192 // are constants, return early.
4193 if (!CanConstantFold(I)) return 0;
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004194
Chris Lattner3221ad02004-04-17 22:58:41 +00004195 // Otherwise, we can evaluate this instruction if all of its operands are
4196 // constant or derived from a PHI node themselves.
4197 PHINode *PHI = 0;
4198 for (unsigned Op = 0, e = I->getNumOperands(); Op != e; ++Op)
Dan Gohman9d4588f2010-06-22 13:15:46 +00004199 if (!isa<Constant>(I->getOperand(Op))) {
Chris Lattner3221ad02004-04-17 22:58:41 +00004200 PHINode *P = getConstantEvolvingPHI(I->getOperand(Op), L);
4201 if (P == 0) return 0; // Not evolving from PHI
4202 if (PHI == 0)
4203 PHI = P;
4204 else if (PHI != P)
4205 return 0; // Evolving from multiple different PHIs.
4206 }
4207
4208 // This is a expression evolving from a constant PHI!
4209 return PHI;
4210}
4211
4212/// EvaluateExpression - Given an expression that passes the
4213/// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node
4214/// in the loop has the value PHIVal. If we can't fold this expression for some
4215/// reason, return null.
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004216static Constant *EvaluateExpression(Value *V, Constant *PHIVal,
4217 const TargetData *TD) {
Chris Lattner3221ad02004-04-17 22:58:41 +00004218 if (isa<PHINode>(V)) return PHIVal;
Reid Spencere8404342004-07-18 00:18:30 +00004219 if (Constant *C = dyn_cast<Constant>(V)) return C;
Chris Lattner3221ad02004-04-17 22:58:41 +00004220 Instruction *I = cast<Instruction>(V);
4221
Dan Gohman9d4588f2010-06-22 13:15:46 +00004222 std::vector<Constant*> Operands(I->getNumOperands());
Chris Lattner3221ad02004-04-17 22:58:41 +00004223
4224 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004225 Operands[i] = EvaluateExpression(I->getOperand(i), PHIVal, TD);
Chris Lattner3221ad02004-04-17 22:58:41 +00004226 if (Operands[i] == 0) return 0;
4227 }
4228
Chris Lattnerf286f6f2007-12-10 22:53:04 +00004229 if (const CmpInst *CI = dyn_cast<CmpInst>(I))
Chris Lattner8f73dea2009-11-09 23:06:58 +00004230 return ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004231 Operands[1], TD);
Chris Lattner8f73dea2009-11-09 23:06:58 +00004232 return ConstantFoldInstOperands(I->getOpcode(), I->getType(),
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004233 &Operands[0], Operands.size(), TD);
Chris Lattner3221ad02004-04-17 22:58:41 +00004234}
4235
4236/// getConstantEvolutionLoopExitValue - If we know that the specified Phi is
4237/// in the header of its containing loop, we know the loop executes a
4238/// constant number of times, and the PHI node is just a recurrence
4239/// involving constants, fold it.
Dan Gohman64a845e2009-06-24 04:48:43 +00004240Constant *
4241ScalarEvolution::getConstantEvolutionLoopExitValue(PHINode *PN,
Dan Gohman5d984912009-12-18 01:14:11 +00004242 const APInt &BEs,
Dan Gohman64a845e2009-06-24 04:48:43 +00004243 const Loop *L) {
Chris Lattner3221ad02004-04-17 22:58:41 +00004244 std::map<PHINode*, Constant*>::iterator I =
4245 ConstantEvolutionLoopExitValue.find(PN);
4246 if (I != ConstantEvolutionLoopExitValue.end())
4247 return I->second;
4248
Dan Gohmane0567812010-04-08 23:03:40 +00004249 if (BEs.ugt(MaxBruteForceIterations))
Chris Lattner3221ad02004-04-17 22:58:41 +00004250 return ConstantEvolutionLoopExitValue[PN] = 0; // Not going to evaluate it.
4251
4252 Constant *&RetVal = ConstantEvolutionLoopExitValue[PN];
4253
4254 // Since the loop is canonicalized, the PHI node must have two entries. One
4255 // entry must be a constant (coming in from outside of the loop), and the
4256 // second must be derived from the same PHI.
4257 bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
4258 Constant *StartCST =
4259 dyn_cast<Constant>(PN->getIncomingValue(!SecondIsBackedge));
4260 if (StartCST == 0)
4261 return RetVal = 0; // Must be a constant.
4262
4263 Value *BEValue = PN->getIncomingValue(SecondIsBackedge);
Dan Gohman9d4588f2010-06-22 13:15:46 +00004264 if (getConstantEvolvingPHI(BEValue, L) != PN &&
4265 !isa<Constant>(BEValue))
Chris Lattner3221ad02004-04-17 22:58:41 +00004266 return RetVal = 0; // Not derived from same PHI.
4267
4268 // Execute the loop symbolically to determine the exit value.
Dan Gohman46bdfb02009-02-24 18:55:53 +00004269 if (BEs.getActiveBits() >= 32)
Reid Spencere8019bb2007-03-01 07:25:48 +00004270 return RetVal = 0; // More than 2^32-1 iterations?? Not doing it!
Chris Lattner3221ad02004-04-17 22:58:41 +00004271
Dan Gohman46bdfb02009-02-24 18:55:53 +00004272 unsigned NumIterations = BEs.getZExtValue(); // must be in range
Reid Spencere8019bb2007-03-01 07:25:48 +00004273 unsigned IterationNum = 0;
Chris Lattner3221ad02004-04-17 22:58:41 +00004274 for (Constant *PHIVal = StartCST; ; ++IterationNum) {
4275 if (IterationNum == NumIterations)
4276 return RetVal = PHIVal; // Got exit value!
4277
4278 // Compute the value of the PHI node for the next iteration.
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004279 Constant *NextPHI = EvaluateExpression(BEValue, PHIVal, TD);
Chris Lattner3221ad02004-04-17 22:58:41 +00004280 if (NextPHI == PHIVal)
4281 return RetVal = NextPHI; // Stopped evolving!
4282 if (NextPHI == 0)
4283 return 0; // Couldn't evaluate!
4284 PHIVal = NextPHI;
4285 }
4286}
4287
Dan Gohman07ad19b2009-07-27 16:09:48 +00004288/// ComputeBackedgeTakenCountExhaustively - If the loop is known to execute a
Chris Lattner7980fb92004-04-17 18:36:24 +00004289/// constant number of times (the condition evolves only from constants),
4290/// try to evaluate a few iterations of the loop until we get the exit
4291/// condition gets a value of ExitWhen (true or false). If we cannot
Dan Gohman1c343752009-06-27 21:21:31 +00004292/// evaluate the trip count of the loop, return getCouldNotCompute().
Dan Gohman64a845e2009-06-24 04:48:43 +00004293const SCEV *
4294ScalarEvolution::ComputeBackedgeTakenCountExhaustively(const Loop *L,
4295 Value *Cond,
4296 bool ExitWhen) {
Chris Lattner7980fb92004-04-17 18:36:24 +00004297 PHINode *PN = getConstantEvolvingPHI(Cond, L);
Dan Gohman1c343752009-06-27 21:21:31 +00004298 if (PN == 0) return getCouldNotCompute();
Chris Lattner7980fb92004-04-17 18:36:24 +00004299
Dan Gohmanb92654d2010-06-19 14:17:24 +00004300 // If the loop is canonicalized, the PHI will have exactly two entries.
4301 // That's the only form we support here.
4302 if (PN->getNumIncomingValues() != 2) return getCouldNotCompute();
4303
4304 // One entry must be a constant (coming in from outside of the loop), and the
Chris Lattner7980fb92004-04-17 18:36:24 +00004305 // second must be derived from the same PHI.
4306 bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
4307 Constant *StartCST =
4308 dyn_cast<Constant>(PN->getIncomingValue(!SecondIsBackedge));
Dan Gohman1c343752009-06-27 21:21:31 +00004309 if (StartCST == 0) return getCouldNotCompute(); // Must be a constant.
Chris Lattner7980fb92004-04-17 18:36:24 +00004310
4311 Value *BEValue = PN->getIncomingValue(SecondIsBackedge);
Dan Gohman9d4588f2010-06-22 13:15:46 +00004312 if (getConstantEvolvingPHI(BEValue, L) != PN &&
4313 !isa<Constant>(BEValue))
4314 return getCouldNotCompute(); // Not derived from same PHI.
Chris Lattner7980fb92004-04-17 18:36:24 +00004315
4316 // Okay, we find a PHI node that defines the trip count of this loop. Execute
4317 // the loop symbolically to determine when the condition gets a value of
4318 // "ExitWhen".
4319 unsigned IterationNum = 0;
4320 unsigned MaxIterations = MaxBruteForceIterations; // Limit analysis.
4321 for (Constant *PHIVal = StartCST;
4322 IterationNum != MaxIterations; ++IterationNum) {
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00004323 ConstantInt *CondVal =
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004324 dyn_cast_or_null<ConstantInt>(EvaluateExpression(Cond, PHIVal, TD));
Chris Lattner3221ad02004-04-17 22:58:41 +00004325
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00004326 // Couldn't symbolically evaluate.
Dan Gohman1c343752009-06-27 21:21:31 +00004327 if (!CondVal) return getCouldNotCompute();
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00004328
Reid Spencere8019bb2007-03-01 07:25:48 +00004329 if (CondVal->getValue() == uint64_t(ExitWhen)) {
Chris Lattner7980fb92004-04-17 18:36:24 +00004330 ++NumBruteForceTripCountsComputed;
Owen Anderson1d0be152009-08-13 21:58:54 +00004331 return getConstant(Type::getInt32Ty(getContext()), IterationNum);
Chris Lattner7980fb92004-04-17 18:36:24 +00004332 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004333
Chris Lattner3221ad02004-04-17 22:58:41 +00004334 // Compute the value of the PHI node for the next iteration.
Dan Gohman1ba3b6c2009-11-09 23:34:17 +00004335 Constant *NextPHI = EvaluateExpression(BEValue, PHIVal, TD);
Chris Lattner3221ad02004-04-17 22:58:41 +00004336 if (NextPHI == 0 || NextPHI == PHIVal)
Dan Gohman1c343752009-06-27 21:21:31 +00004337 return getCouldNotCompute();// Couldn't evaluate or not making progress...
Chris Lattner3221ad02004-04-17 22:58:41 +00004338 PHIVal = NextPHI;
Chris Lattner7980fb92004-04-17 18:36:24 +00004339 }
4340
4341 // Too many iterations were needed to evaluate.
Dan Gohman1c343752009-06-27 21:21:31 +00004342 return getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00004343}
4344
Dan Gohmane7125f42009-09-03 15:00:26 +00004345/// getSCEVAtScope - Return a SCEV expression for the specified value
Dan Gohman66a7e852009-05-08 20:38:54 +00004346/// at the specified scope in the program. The L value specifies a loop
4347/// nest to evaluate the expression at, where null is the top-level or a
4348/// specified loop is immediately inside of the loop.
4349///
4350/// This method can be used to compute the exit value for a variable defined
4351/// in a loop by querying what the value will hold in the parent loop.
4352///
Dan Gohmand594e6f2009-05-24 23:25:42 +00004353/// In the case that a relevant loop exit value cannot be computed, the
4354/// original value V is returned.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004355const SCEV *ScalarEvolution::getSCEVAtScope(const SCEV *V, const Loop *L) {
Dan Gohman42214892009-08-31 21:15:23 +00004356 // Check to see if we've folded this expression at this loop before.
4357 std::map<const Loop *, const SCEV *> &Values = ValuesAtScopes[V];
4358 std::pair<std::map<const Loop *, const SCEV *>::iterator, bool> Pair =
4359 Values.insert(std::make_pair(L, static_cast<const SCEV *>(0)));
4360 if (!Pair.second)
4361 return Pair.first->second ? Pair.first->second : V;
Chris Lattner53e677a2004-04-02 20:23:17 +00004362
Dan Gohman42214892009-08-31 21:15:23 +00004363 // Otherwise compute it.
4364 const SCEV *C = computeSCEVAtScope(V, L);
Dan Gohmana5505cb2009-08-31 21:58:28 +00004365 ValuesAtScopes[V][L] = C;
Dan Gohman42214892009-08-31 21:15:23 +00004366 return C;
4367}
4368
4369const SCEV *ScalarEvolution::computeSCEVAtScope(const SCEV *V, const Loop *L) {
Chris Lattner3221ad02004-04-17 22:58:41 +00004370 if (isa<SCEVConstant>(V)) return V;
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004371
Nick Lewycky3e630762008-02-20 06:48:22 +00004372 // If this instruction is evolved from a constant-evolving PHI, compute the
Chris Lattner3221ad02004-04-17 22:58:41 +00004373 // exit value from the loop without using SCEVs.
Dan Gohman622ed672009-05-04 22:02:23 +00004374 if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) {
Chris Lattner3221ad02004-04-17 22:58:41 +00004375 if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) {
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004376 const Loop *LI = (*this->LI)[I->getParent()];
Chris Lattner3221ad02004-04-17 22:58:41 +00004377 if (LI && LI->getParentLoop() == L) // Looking for loop exit value.
4378 if (PHINode *PN = dyn_cast<PHINode>(I))
4379 if (PN->getParent() == LI->getHeader()) {
4380 // Okay, there is no closed form solution for the PHI node. Check
Dan Gohman46bdfb02009-02-24 18:55:53 +00004381 // to see if the loop that contains it has a known backedge-taken
4382 // count. If so, we may be able to force computation of the exit
4383 // value.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004384 const SCEV *BackedgeTakenCount = getBackedgeTakenCount(LI);
Dan Gohman622ed672009-05-04 22:02:23 +00004385 if (const SCEVConstant *BTCC =
Dan Gohman46bdfb02009-02-24 18:55:53 +00004386 dyn_cast<SCEVConstant>(BackedgeTakenCount)) {
Chris Lattner3221ad02004-04-17 22:58:41 +00004387 // Okay, we know how many times the containing loop executes. If
4388 // this is a constant evolving PHI node, get the final value at
4389 // the specified iteration number.
4390 Constant *RV = getConstantEvolutionLoopExitValue(PN,
Dan Gohman46bdfb02009-02-24 18:55:53 +00004391 BTCC->getValue()->getValue(),
Chris Lattner3221ad02004-04-17 22:58:41 +00004392 LI);
Dan Gohman09987962009-06-29 21:31:18 +00004393 if (RV) return getSCEV(RV);
Chris Lattner3221ad02004-04-17 22:58:41 +00004394 }
4395 }
4396
Reid Spencer09906f32006-12-04 21:33:23 +00004397 // Okay, this is an expression that we cannot symbolically evaluate
Chris Lattner3221ad02004-04-17 22:58:41 +00004398 // into a SCEV. Check to see if it's possible to symbolically evaluate
Reid Spencer09906f32006-12-04 21:33:23 +00004399 // the arguments into constants, and if so, try to constant propagate the
Chris Lattner3221ad02004-04-17 22:58:41 +00004400 // result. This is particularly useful for computing loop exit values.
4401 if (CanConstantFold(I)) {
Dan Gohman11046452010-06-29 23:43:06 +00004402 SmallVector<Constant *, 4> Operands;
4403 bool MadeImprovement = false;
Chris Lattner3221ad02004-04-17 22:58:41 +00004404 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
4405 Value *Op = I->getOperand(i);
4406 if (Constant *C = dyn_cast<Constant>(Op)) {
4407 Operands.push_back(C);
Dan Gohman11046452010-06-29 23:43:06 +00004408 continue;
Chris Lattner3221ad02004-04-17 22:58:41 +00004409 }
Dan Gohman11046452010-06-29 23:43:06 +00004410
4411 // If any of the operands is non-constant and if they are
4412 // non-integer and non-pointer, don't even try to analyze them
4413 // with scev techniques.
4414 if (!isSCEVable(Op->getType()))
4415 return V;
4416
4417 const SCEV *OrigV = getSCEV(Op);
4418 const SCEV *OpV = getSCEVAtScope(OrigV, L);
4419 MadeImprovement |= OrigV != OpV;
4420
4421 Constant *C = 0;
4422 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(OpV))
4423 C = SC->getValue();
4424 if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(OpV))
4425 C = dyn_cast<Constant>(SU->getValue());
4426 if (!C) return V;
4427 if (C->getType() != Op->getType())
4428 C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
4429 Op->getType(),
4430 false),
4431 C, Op->getType());
4432 Operands.push_back(C);
Chris Lattner3221ad02004-04-17 22:58:41 +00004433 }
Dan Gohman64a845e2009-06-24 04:48:43 +00004434
Dan Gohman11046452010-06-29 23:43:06 +00004435 // Check to see if getSCEVAtScope actually made an improvement.
4436 if (MadeImprovement) {
4437 Constant *C = 0;
4438 if (const CmpInst *CI = dyn_cast<CmpInst>(I))
4439 C = ConstantFoldCompareInstOperands(CI->getPredicate(),
4440 Operands[0], Operands[1], TD);
4441 else
4442 C = ConstantFoldInstOperands(I->getOpcode(), I->getType(),
4443 &Operands[0], Operands.size(), TD);
4444 if (!C) return V;
Dan Gohmane177c9a2010-02-24 19:31:47 +00004445 return getSCEV(C);
Dan Gohman11046452010-06-29 23:43:06 +00004446 }
Chris Lattner3221ad02004-04-17 22:58:41 +00004447 }
4448 }
4449
4450 // This is some other type of SCEVUnknown, just return it.
4451 return V;
4452 }
4453
Dan Gohman622ed672009-05-04 22:02:23 +00004454 if (const SCEVCommutativeExpr *Comm = dyn_cast<SCEVCommutativeExpr>(V)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004455 // Avoid performing the look-up in the common case where the specified
4456 // expression has no loop-variant portions.
4457 for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00004458 const SCEV *OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
Chris Lattner53e677a2004-04-02 20:23:17 +00004459 if (OpAtScope != Comm->getOperand(i)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004460 // Okay, at least one of these operands is loop variant but might be
4461 // foldable. Build a new instance of the folded commutative expression.
Dan Gohman64a845e2009-06-24 04:48:43 +00004462 SmallVector<const SCEV *, 8> NewOps(Comm->op_begin(),
4463 Comm->op_begin()+i);
Chris Lattner53e677a2004-04-02 20:23:17 +00004464 NewOps.push_back(OpAtScope);
4465
4466 for (++i; i != e; ++i) {
4467 OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
Chris Lattner53e677a2004-04-02 20:23:17 +00004468 NewOps.push_back(OpAtScope);
4469 }
4470 if (isa<SCEVAddExpr>(Comm))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004471 return getAddExpr(NewOps);
Nick Lewyckyc54c5612007-11-25 22:41:31 +00004472 if (isa<SCEVMulExpr>(Comm))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004473 return getMulExpr(NewOps);
Nick Lewyckyc54c5612007-11-25 22:41:31 +00004474 if (isa<SCEVSMaxExpr>(Comm))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004475 return getSMaxExpr(NewOps);
Nick Lewycky3e630762008-02-20 06:48:22 +00004476 if (isa<SCEVUMaxExpr>(Comm))
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004477 return getUMaxExpr(NewOps);
Torok Edwinc23197a2009-07-14 16:55:14 +00004478 llvm_unreachable("Unknown commutative SCEV type!");
Chris Lattner53e677a2004-04-02 20:23:17 +00004479 }
4480 }
4481 // If we got here, all operands are loop invariant.
4482 return Comm;
4483 }
4484
Dan Gohman622ed672009-05-04 22:02:23 +00004485 if (const SCEVUDivExpr *Div = dyn_cast<SCEVUDivExpr>(V)) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00004486 const SCEV *LHS = getSCEVAtScope(Div->getLHS(), L);
4487 const SCEV *RHS = getSCEVAtScope(Div->getRHS(), L);
Nick Lewycky789558d2009-01-13 09:18:58 +00004488 if (LHS == Div->getLHS() && RHS == Div->getRHS())
4489 return Div; // must be loop invariant
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004490 return getUDivExpr(LHS, RHS);
Chris Lattner53e677a2004-04-02 20:23:17 +00004491 }
4492
4493 // If this is a loop recurrence for a loop that does not contain L, then we
4494 // are dealing with the final value computed by the loop.
Dan Gohman622ed672009-05-04 22:02:23 +00004495 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) {
Dan Gohman11046452010-06-29 23:43:06 +00004496 // First, attempt to evaluate each operand.
4497 // Avoid performing the look-up in the common case where the specified
4498 // expression has no loop-variant portions.
4499 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
4500 const SCEV *OpAtScope = getSCEVAtScope(AddRec->getOperand(i), L);
4501 if (OpAtScope == AddRec->getOperand(i))
4502 continue;
4503
4504 // Okay, at least one of these operands is loop variant but might be
4505 // foldable. Build a new instance of the folded commutative expression.
4506 SmallVector<const SCEV *, 8> NewOps(AddRec->op_begin(),
4507 AddRec->op_begin()+i);
4508 NewOps.push_back(OpAtScope);
4509 for (++i; i != e; ++i)
4510 NewOps.push_back(getSCEVAtScope(AddRec->getOperand(i), L));
4511
4512 AddRec = cast<SCEVAddRecExpr>(getAddRecExpr(NewOps, AddRec->getLoop()));
4513 break;
4514 }
4515
4516 // If the scope is outside the addrec's loop, evaluate it by using the
4517 // loop exit value of the addrec.
4518 if (!AddRec->getLoop()->contains(L)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004519 // To evaluate this recurrence, we need to know how many times the AddRec
4520 // loop iterates. Compute this now.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004521 const SCEV *BackedgeTakenCount = getBackedgeTakenCount(AddRec->getLoop());
Dan Gohman1c343752009-06-27 21:21:31 +00004522 if (BackedgeTakenCount == getCouldNotCompute()) return AddRec;
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004523
Eli Friedmanb42a6262008-08-04 23:49:06 +00004524 // Then, evaluate the AddRec.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004525 return AddRec->evaluateAtIteration(BackedgeTakenCount, *this);
Chris Lattner53e677a2004-04-02 20:23:17 +00004526 }
Dan Gohman11046452010-06-29 23:43:06 +00004527
Dan Gohmand594e6f2009-05-24 23:25:42 +00004528 return AddRec;
Chris Lattner53e677a2004-04-02 20:23:17 +00004529 }
4530
Dan Gohman622ed672009-05-04 22:02:23 +00004531 if (const SCEVZeroExtendExpr *Cast = dyn_cast<SCEVZeroExtendExpr>(V)) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00004532 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
Dan Gohmaneb3948b2009-04-29 22:29:01 +00004533 if (Op == Cast->getOperand())
4534 return Cast; // must be loop invariant
4535 return getZeroExtendExpr(Op, Cast->getType());
4536 }
4537
Dan Gohman622ed672009-05-04 22:02:23 +00004538 if (const SCEVSignExtendExpr *Cast = dyn_cast<SCEVSignExtendExpr>(V)) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00004539 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
Dan Gohmaneb3948b2009-04-29 22:29:01 +00004540 if (Op == Cast->getOperand())
4541 return Cast; // must be loop invariant
4542 return getSignExtendExpr(Op, Cast->getType());
4543 }
4544
Dan Gohman622ed672009-05-04 22:02:23 +00004545 if (const SCEVTruncateExpr *Cast = dyn_cast<SCEVTruncateExpr>(V)) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00004546 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
Dan Gohmaneb3948b2009-04-29 22:29:01 +00004547 if (Op == Cast->getOperand())
4548 return Cast; // must be loop invariant
4549 return getTruncateExpr(Op, Cast->getType());
4550 }
4551
Torok Edwinc23197a2009-07-14 16:55:14 +00004552 llvm_unreachable("Unknown SCEV type!");
Daniel Dunbar8c562e22009-05-18 16:43:04 +00004553 return 0;
Chris Lattner53e677a2004-04-02 20:23:17 +00004554}
4555
Dan Gohman66a7e852009-05-08 20:38:54 +00004556/// getSCEVAtScope - This is a convenience function which does
4557/// getSCEVAtScope(getSCEV(V), L).
Dan Gohman0bba49c2009-07-07 17:06:11 +00004558const SCEV *ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) {
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004559 return getSCEVAtScope(getSCEV(V), L);
4560}
4561
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004562/// SolveLinEquationWithOverflow - Finds the minimum unsigned root of the
4563/// following equation:
4564///
4565/// A * X = B (mod N)
4566///
4567/// where N = 2^BW and BW is the common bit width of A and B. The signedness of
4568/// A and B isn't important.
4569///
4570/// If the equation does not have a solution, SCEVCouldNotCompute is returned.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004571static const SCEV *SolveLinEquationWithOverflow(const APInt &A, const APInt &B,
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004572 ScalarEvolution &SE) {
4573 uint32_t BW = A.getBitWidth();
4574 assert(BW == B.getBitWidth() && "Bit widths must be the same.");
4575 assert(A != 0 && "A must be non-zero.");
4576
4577 // 1. D = gcd(A, N)
4578 //
4579 // The gcd of A and N may have only one prime factor: 2. The number of
4580 // trailing zeros in A is its multiplicity
4581 uint32_t Mult2 = A.countTrailingZeros();
4582 // D = 2^Mult2
4583
4584 // 2. Check if B is divisible by D.
4585 //
4586 // B is divisible by D if and only if the multiplicity of prime factor 2 for B
4587 // is not less than multiplicity of this prime factor for D.
4588 if (B.countTrailingZeros() < Mult2)
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00004589 return SE.getCouldNotCompute();
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004590
4591 // 3. Compute I: the multiplicative inverse of (A / D) in arithmetic
4592 // modulo (N / D).
4593 //
4594 // (N / D) may need BW+1 bits in its representation. Hence, we'll use this
4595 // bit width during computations.
4596 APInt AD = A.lshr(Mult2).zext(BW + 1); // AD = A / D
4597 APInt Mod(BW + 1, 0);
4598 Mod.set(BW - Mult2); // Mod = N / D
4599 APInt I = AD.multiplicativeInverse(Mod);
4600
4601 // 4. Compute the minimum unsigned root of the equation:
4602 // I * (B / D) mod (N / D)
4603 APInt Result = (I * B.lshr(Mult2).zext(BW + 1)).urem(Mod);
4604
4605 // The result is guaranteed to be less than 2^BW so we may truncate it to BW
4606 // bits.
4607 return SE.getConstant(Result.trunc(BW));
4608}
Chris Lattner53e677a2004-04-02 20:23:17 +00004609
4610/// SolveQuadraticEquation - Find the roots of the quadratic equation for the
4611/// given quadratic chrec {L,+,M,+,N}. This returns either the two roots (which
4612/// might be the same) or two SCEVCouldNotCompute objects.
4613///
Dan Gohman0bba49c2009-07-07 17:06:11 +00004614static std::pair<const SCEV *,const SCEV *>
Dan Gohman246b2562007-10-22 18:31:58 +00004615SolveQuadraticEquation(const SCEVAddRecExpr *AddRec, ScalarEvolution &SE) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004616 assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!");
Dan Gohman35738ac2009-05-04 22:30:44 +00004617 const SCEVConstant *LC = dyn_cast<SCEVConstant>(AddRec->getOperand(0));
4618 const SCEVConstant *MC = dyn_cast<SCEVConstant>(AddRec->getOperand(1));
4619 const SCEVConstant *NC = dyn_cast<SCEVConstant>(AddRec->getOperand(2));
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004620
Chris Lattner53e677a2004-04-02 20:23:17 +00004621 // We currently can only solve this if the coefficients are constants.
Reid Spencere8019bb2007-03-01 07:25:48 +00004622 if (!LC || !MC || !NC) {
Dan Gohman35738ac2009-05-04 22:30:44 +00004623 const SCEV *CNC = SE.getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00004624 return std::make_pair(CNC, CNC);
4625 }
4626
Reid Spencere8019bb2007-03-01 07:25:48 +00004627 uint32_t BitWidth = LC->getValue()->getValue().getBitWidth();
Chris Lattnerfe560b82007-04-15 19:52:49 +00004628 const APInt &L = LC->getValue()->getValue();
4629 const APInt &M = MC->getValue()->getValue();
4630 const APInt &N = NC->getValue()->getValue();
Reid Spencere8019bb2007-03-01 07:25:48 +00004631 APInt Two(BitWidth, 2);
4632 APInt Four(BitWidth, 4);
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004633
Dan Gohman64a845e2009-06-24 04:48:43 +00004634 {
Reid Spencere8019bb2007-03-01 07:25:48 +00004635 using namespace APIntOps;
Zhou Sheng414de4d2007-04-07 17:48:27 +00004636 const APInt& C = L;
Reid Spencere8019bb2007-03-01 07:25:48 +00004637 // Convert from chrec coefficients to polynomial coefficients AX^2+BX+C
4638 // The B coefficient is M-N/2
4639 APInt B(M);
4640 B -= sdiv(N,Two);
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004641
Reid Spencere8019bb2007-03-01 07:25:48 +00004642 // The A coefficient is N/2
Zhou Sheng414de4d2007-04-07 17:48:27 +00004643 APInt A(N.sdiv(Two));
Chris Lattner53e677a2004-04-02 20:23:17 +00004644
Reid Spencere8019bb2007-03-01 07:25:48 +00004645 // Compute the B^2-4ac term.
4646 APInt SqrtTerm(B);
4647 SqrtTerm *= B;
4648 SqrtTerm -= Four * (A * C);
Chris Lattner53e677a2004-04-02 20:23:17 +00004649
Reid Spencere8019bb2007-03-01 07:25:48 +00004650 // Compute sqrt(B^2-4ac). This is guaranteed to be the nearest
4651 // integer value or else APInt::sqrt() will assert.
4652 APInt SqrtVal(SqrtTerm.sqrt());
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004653
Dan Gohman64a845e2009-06-24 04:48:43 +00004654 // Compute the two solutions for the quadratic formula.
Reid Spencere8019bb2007-03-01 07:25:48 +00004655 // The divisions must be performed as signed divisions.
4656 APInt NegB(-B);
Reid Spencer3e35c8d2007-04-16 02:24:41 +00004657 APInt TwoA( A << 1 );
Nick Lewycky8f4d5eb2008-11-03 02:43:49 +00004658 if (TwoA.isMinValue()) {
Dan Gohman35738ac2009-05-04 22:30:44 +00004659 const SCEV *CNC = SE.getCouldNotCompute();
Nick Lewycky8f4d5eb2008-11-03 02:43:49 +00004660 return std::make_pair(CNC, CNC);
4661 }
4662
Owen Andersone922c022009-07-22 00:24:57 +00004663 LLVMContext &Context = SE.getContext();
Owen Anderson76f600b2009-07-06 22:37:39 +00004664
4665 ConstantInt *Solution1 =
Owen Andersoneed707b2009-07-24 23:12:02 +00004666 ConstantInt::get(Context, (NegB + SqrtVal).sdiv(TwoA));
Owen Anderson76f600b2009-07-06 22:37:39 +00004667 ConstantInt *Solution2 =
Owen Andersoneed707b2009-07-24 23:12:02 +00004668 ConstantInt::get(Context, (NegB - SqrtVal).sdiv(TwoA));
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004669
Dan Gohman64a845e2009-06-24 04:48:43 +00004670 return std::make_pair(SE.getConstant(Solution1),
Dan Gohman246b2562007-10-22 18:31:58 +00004671 SE.getConstant(Solution2));
Reid Spencere8019bb2007-03-01 07:25:48 +00004672 } // end APIntOps namespace
Chris Lattner53e677a2004-04-02 20:23:17 +00004673}
4674
4675/// HowFarToZero - Return the number of times a backedge comparing the specified
Dan Gohman86fbf2f2009-06-06 14:37:11 +00004676/// value to zero will execute. If not computable, return CouldNotCompute.
Dan Gohmanf6d009f2010-02-24 17:31:30 +00004677ScalarEvolution::BackedgeTakenInfo
4678ScalarEvolution::HowFarToZero(const SCEV *V, const Loop *L) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004679 // If the value is a constant
Dan Gohman622ed672009-05-04 22:02:23 +00004680 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004681 // If the value is already zero, the branch will execute zero times.
Reid Spencercae57542007-03-02 00:28:52 +00004682 if (C->getValue()->isZero()) return C;
Dan Gohman1c343752009-06-27 21:21:31 +00004683 return getCouldNotCompute(); // Otherwise it will loop infinitely.
Chris Lattner53e677a2004-04-02 20:23:17 +00004684 }
4685
Dan Gohman35738ac2009-05-04 22:30:44 +00004686 const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V);
Chris Lattner53e677a2004-04-02 20:23:17 +00004687 if (!AddRec || AddRec->getLoop() != L)
Dan Gohman1c343752009-06-27 21:21:31 +00004688 return getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00004689
4690 if (AddRec->isAffine()) {
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004691 // If this is an affine expression, the execution count of this branch is
4692 // the minimum unsigned root of the following equation:
Chris Lattner53e677a2004-04-02 20:23:17 +00004693 //
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004694 // Start + Step*N = 0 (mod 2^BW)
Chris Lattner53e677a2004-04-02 20:23:17 +00004695 //
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004696 // equivalent to:
4697 //
4698 // Step*N = -Start (mod 2^BW)
4699 //
4700 // where BW is the common bit width of Start and Step.
4701
Chris Lattner53e677a2004-04-02 20:23:17 +00004702 // Get the initial value for the loop.
Dan Gohman64a845e2009-06-24 04:48:43 +00004703 const SCEV *Start = getSCEVAtScope(AddRec->getStart(),
4704 L->getParentLoop());
4705 const SCEV *Step = getSCEVAtScope(AddRec->getOperand(1),
4706 L->getParentLoop());
Chris Lattner53e677a2004-04-02 20:23:17 +00004707
Dan Gohman622ed672009-05-04 22:02:23 +00004708 if (const SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step)) {
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004709 // For now we handle only constant steps.
Chris Lattner53e677a2004-04-02 20:23:17 +00004710
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004711 // First, handle unitary steps.
4712 if (StepC->getValue()->equalsInt(1)) // 1*N = -Start (mod 2^BW), so:
Dan Gohman4c0d5d52009-08-20 16:42:55 +00004713 return getNegativeSCEV(Start); // N = -Start (as unsigned)
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004714 if (StepC->getValue()->isAllOnesValue()) // -1*N = -Start (mod 2^BW), so:
4715 return Start; // N = Start (as unsigned)
4716
4717 // Then, try to solve the above equation provided that Start is constant.
Dan Gohman622ed672009-05-04 22:02:23 +00004718 if (const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start))
Wojciech Matyjewiczde0f2382008-07-20 15:55:14 +00004719 return SolveLinEquationWithOverflow(StepC->getValue()->getValue(),
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004720 -StartC->getValue()->getValue(),
4721 *this);
Chris Lattner53e677a2004-04-02 20:23:17 +00004722 }
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00004723 } else if (AddRec->isQuadratic() && AddRec->getType()->isIntegerTy()) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004724 // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of
4725 // the quadratic equation to solve it.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004726 std::pair<const SCEV *,const SCEV *> Roots = SolveQuadraticEquation(AddRec,
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004727 *this);
Dan Gohman35738ac2009-05-04 22:30:44 +00004728 const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
4729 const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
Chris Lattner53e677a2004-04-02 20:23:17 +00004730 if (R1) {
Chris Lattnerd18d9dc2004-04-02 20:26:46 +00004731#if 0
David Greene25e0e872009-12-23 22:18:14 +00004732 dbgs() << "HFTZ: " << *V << " - sol#1: " << *R1
Dan Gohmanb7ef7292009-04-21 00:47:46 +00004733 << " sol#2: " << *R2 << "\n";
Chris Lattnerd18d9dc2004-04-02 20:26:46 +00004734#endif
Chris Lattner53e677a2004-04-02 20:23:17 +00004735 // Pick the smallest positive root value.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00004736 if (ConstantInt *CB =
Owen Andersonbaf3c402009-07-29 18:55:55 +00004737 dyn_cast<ConstantInt>(ConstantExpr::getICmp(ICmpInst::ICMP_ULT,
Reid Spencere4d87aa2006-12-23 06:05:41 +00004738 R1->getValue(), R2->getValue()))) {
Reid Spencer579dca12007-01-12 04:24:46 +00004739 if (CB->getZExtValue() == false)
Chris Lattner53e677a2004-04-02 20:23:17 +00004740 std::swap(R1, R2); // R1 is the minimum root now.
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004741
Chris Lattner53e677a2004-04-02 20:23:17 +00004742 // We can only use this value if the chrec ends up with an exact zero
4743 // value at this index. When solving for "X*X != 5", for example, we
4744 // should not accept a root of 2.
Dan Gohman0bba49c2009-07-07 17:06:11 +00004745 const SCEV *Val = AddRec->evaluateAtIteration(R1, *this);
Dan Gohmancfeb6a42008-06-18 16:23:07 +00004746 if (Val->isZero())
4747 return R1; // We found a quadratic root!
Chris Lattner53e677a2004-04-02 20:23:17 +00004748 }
4749 }
4750 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004751
Dan Gohman1c343752009-06-27 21:21:31 +00004752 return getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00004753}
4754
4755/// HowFarToNonZero - Return the number of times a backedge checking the
4756/// specified value for nonzero will execute. If not computable, return
Dan Gohman86fbf2f2009-06-06 14:37:11 +00004757/// CouldNotCompute
Dan Gohmanf6d009f2010-02-24 17:31:30 +00004758ScalarEvolution::BackedgeTakenInfo
4759ScalarEvolution::HowFarToNonZero(const SCEV *V, const Loop *L) {
Chris Lattner53e677a2004-04-02 20:23:17 +00004760 // Loops that look like: while (X == 0) are very strange indeed. We don't
4761 // handle them yet except for the trivial case. This could be expanded in the
4762 // future as needed.
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004763
Chris Lattner53e677a2004-04-02 20:23:17 +00004764 // If the value is a constant, check to see if it is known to be non-zero
4765 // already. If so, the backedge will execute zero times.
Dan Gohman622ed672009-05-04 22:02:23 +00004766 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
Nick Lewycky39442af2008-02-21 09:14:53 +00004767 if (!C->getValue()->isNullValue())
Dan Gohmandeff6212010-05-03 22:09:21 +00004768 return getConstant(C->getType(), 0);
Dan Gohman1c343752009-06-27 21:21:31 +00004769 return getCouldNotCompute(); // Otherwise it will loop infinitely.
Chris Lattner53e677a2004-04-02 20:23:17 +00004770 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00004771
Chris Lattner53e677a2004-04-02 20:23:17 +00004772 // We could implement others, but I really doubt anyone writes loops like
4773 // this, and if they did, they would already be constant folded.
Dan Gohman1c343752009-06-27 21:21:31 +00004774 return getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00004775}
4776
Dan Gohmanfd6edef2008-09-15 22:18:04 +00004777/// getPredecessorWithUniqueSuccessorForBB - Return a predecessor of BB
4778/// (which may not be an immediate predecessor) which has exactly one
4779/// successor from which BB is reachable, or null if no such block is
4780/// found.
4781///
Dan Gohman005752b2010-04-15 16:19:08 +00004782std::pair<BasicBlock *, BasicBlock *>
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004783ScalarEvolution::getPredecessorWithUniqueSuccessorForBB(BasicBlock *BB) {
Dan Gohman3d739fe2009-04-30 20:48:53 +00004784 // If the block has a unique predecessor, then there is no path from the
4785 // predecessor to the block that does not go through the direct edge
4786 // from the predecessor to the block.
Dan Gohmanfd6edef2008-09-15 22:18:04 +00004787 if (BasicBlock *Pred = BB->getSinglePredecessor())
Dan Gohman005752b2010-04-15 16:19:08 +00004788 return std::make_pair(Pred, BB);
Dan Gohmanfd6edef2008-09-15 22:18:04 +00004789
4790 // A loop's header is defined to be a block that dominates the loop.
Dan Gohman859b4822009-05-18 15:36:09 +00004791 // If the header has a unique predecessor outside the loop, it must be
4792 // a block that has exactly one successor that can reach the loop.
Dan Gohmanf8a8be82009-04-21 23:15:49 +00004793 if (Loop *L = LI->getLoopFor(BB))
Dan Gohman605c14f2010-06-22 23:43:28 +00004794 return std::make_pair(L->getLoopPredecessor(), L->getHeader());
Dan Gohmanfd6edef2008-09-15 22:18:04 +00004795
Dan Gohman005752b2010-04-15 16:19:08 +00004796 return std::pair<BasicBlock *, BasicBlock *>();
Dan Gohmanfd6edef2008-09-15 22:18:04 +00004797}
4798
Dan Gohman763bad12009-06-20 00:35:32 +00004799/// HasSameValue - SCEV structural equivalence is usually sufficient for
4800/// testing whether two expressions are equal, however for the purposes of
4801/// looking for a condition guarding a loop, it can be useful to be a little
4802/// more general, since a front-end may have replicated the controlling
4803/// expression.
4804///
Dan Gohman0bba49c2009-07-07 17:06:11 +00004805static bool HasSameValue(const SCEV *A, const SCEV *B) {
Dan Gohman763bad12009-06-20 00:35:32 +00004806 // Quick check to see if they are the same SCEV.
4807 if (A == B) return true;
4808
4809 // Otherwise, if they're both SCEVUnknown, it's possible that they hold
4810 // two different instructions with the same value. Check for this case.
4811 if (const SCEVUnknown *AU = dyn_cast<SCEVUnknown>(A))
4812 if (const SCEVUnknown *BU = dyn_cast<SCEVUnknown>(B))
4813 if (const Instruction *AI = dyn_cast<Instruction>(AU->getValue()))
4814 if (const Instruction *BI = dyn_cast<Instruction>(BU->getValue()))
Dan Gohman041de422009-08-25 17:56:57 +00004815 if (AI->isIdenticalTo(BI) && !AI->mayReadFromMemory())
Dan Gohman763bad12009-06-20 00:35:32 +00004816 return true;
4817
4818 // Otherwise assume they may have a different value.
4819 return false;
4820}
4821
Dan Gohmane9796502010-04-24 01:28:42 +00004822/// SimplifyICmpOperands - Simplify LHS and RHS in a comparison with
4823/// predicate Pred. Return true iff any changes were made.
4824///
4825bool ScalarEvolution::SimplifyICmpOperands(ICmpInst::Predicate &Pred,
4826 const SCEV *&LHS, const SCEV *&RHS) {
4827 bool Changed = false;
4828
4829 // Canonicalize a constant to the right side.
4830 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
4831 // Check for both operands constant.
4832 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
4833 if (ConstantExpr::getICmp(Pred,
4834 LHSC->getValue(),
4835 RHSC->getValue())->isNullValue())
4836 goto trivially_false;
4837 else
4838 goto trivially_true;
4839 }
4840 // Otherwise swap the operands to put the constant on the right.
4841 std::swap(LHS, RHS);
4842 Pred = ICmpInst::getSwappedPredicate(Pred);
4843 Changed = true;
4844 }
4845
4846 // If we're comparing an addrec with a value which is loop-invariant in the
Dan Gohman3abb69c2010-05-03 17:00:11 +00004847 // addrec's loop, put the addrec on the left. Also make a dominance check,
4848 // as both operands could be addrecs loop-invariant in each other's loop.
4849 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS)) {
4850 const Loop *L = AR->getLoop();
4851 if (LHS->isLoopInvariant(L) && LHS->properlyDominates(L->getHeader(), DT)) {
Dan Gohmane9796502010-04-24 01:28:42 +00004852 std::swap(LHS, RHS);
4853 Pred = ICmpInst::getSwappedPredicate(Pred);
4854 Changed = true;
4855 }
Dan Gohman3abb69c2010-05-03 17:00:11 +00004856 }
Dan Gohmane9796502010-04-24 01:28:42 +00004857
4858 // If there's a constant operand, canonicalize comparisons with boundary
4859 // cases, and canonicalize *-or-equal comparisons to regular comparisons.
4860 if (const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS)) {
4861 const APInt &RA = RC->getValue()->getValue();
4862 switch (Pred) {
4863 default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
4864 case ICmpInst::ICMP_EQ:
4865 case ICmpInst::ICMP_NE:
4866 break;
4867 case ICmpInst::ICMP_UGE:
4868 if ((RA - 1).isMinValue()) {
4869 Pred = ICmpInst::ICMP_NE;
4870 RHS = getConstant(RA - 1);
4871 Changed = true;
4872 break;
4873 }
4874 if (RA.isMaxValue()) {
4875 Pred = ICmpInst::ICMP_EQ;
4876 Changed = true;
4877 break;
4878 }
4879 if (RA.isMinValue()) goto trivially_true;
4880
4881 Pred = ICmpInst::ICMP_UGT;
4882 RHS = getConstant(RA - 1);
4883 Changed = true;
4884 break;
4885 case ICmpInst::ICMP_ULE:
4886 if ((RA + 1).isMaxValue()) {
4887 Pred = ICmpInst::ICMP_NE;
4888 RHS = getConstant(RA + 1);
4889 Changed = true;
4890 break;
4891 }
4892 if (RA.isMinValue()) {
4893 Pred = ICmpInst::ICMP_EQ;
4894 Changed = true;
4895 break;
4896 }
4897 if (RA.isMaxValue()) goto trivially_true;
4898
4899 Pred = ICmpInst::ICMP_ULT;
4900 RHS = getConstant(RA + 1);
4901 Changed = true;
4902 break;
4903 case ICmpInst::ICMP_SGE:
4904 if ((RA - 1).isMinSignedValue()) {
4905 Pred = ICmpInst::ICMP_NE;
4906 RHS = getConstant(RA - 1);
4907 Changed = true;
4908 break;
4909 }
4910 if (RA.isMaxSignedValue()) {
4911 Pred = ICmpInst::ICMP_EQ;
4912 Changed = true;
4913 break;
4914 }
4915 if (RA.isMinSignedValue()) goto trivially_true;
4916
4917 Pred = ICmpInst::ICMP_SGT;
4918 RHS = getConstant(RA - 1);
4919 Changed = true;
4920 break;
4921 case ICmpInst::ICMP_SLE:
4922 if ((RA + 1).isMaxSignedValue()) {
4923 Pred = ICmpInst::ICMP_NE;
4924 RHS = getConstant(RA + 1);
4925 Changed = true;
4926 break;
4927 }
4928 if (RA.isMinSignedValue()) {
4929 Pred = ICmpInst::ICMP_EQ;
4930 Changed = true;
4931 break;
4932 }
4933 if (RA.isMaxSignedValue()) goto trivially_true;
4934
4935 Pred = ICmpInst::ICMP_SLT;
4936 RHS = getConstant(RA + 1);
4937 Changed = true;
4938 break;
4939 case ICmpInst::ICMP_UGT:
4940 if (RA.isMinValue()) {
4941 Pred = ICmpInst::ICMP_NE;
4942 Changed = true;
4943 break;
4944 }
4945 if ((RA + 1).isMaxValue()) {
4946 Pred = ICmpInst::ICMP_EQ;
4947 RHS = getConstant(RA + 1);
4948 Changed = true;
4949 break;
4950 }
4951 if (RA.isMaxValue()) goto trivially_false;
4952 break;
4953 case ICmpInst::ICMP_ULT:
4954 if (RA.isMaxValue()) {
4955 Pred = ICmpInst::ICMP_NE;
4956 Changed = true;
4957 break;
4958 }
4959 if ((RA - 1).isMinValue()) {
4960 Pred = ICmpInst::ICMP_EQ;
4961 RHS = getConstant(RA - 1);
4962 Changed = true;
4963 break;
4964 }
4965 if (RA.isMinValue()) goto trivially_false;
4966 break;
4967 case ICmpInst::ICMP_SGT:
4968 if (RA.isMinSignedValue()) {
4969 Pred = ICmpInst::ICMP_NE;
4970 Changed = true;
4971 break;
4972 }
4973 if ((RA + 1).isMaxSignedValue()) {
4974 Pred = ICmpInst::ICMP_EQ;
4975 RHS = getConstant(RA + 1);
4976 Changed = true;
4977 break;
4978 }
4979 if (RA.isMaxSignedValue()) goto trivially_false;
4980 break;
4981 case ICmpInst::ICMP_SLT:
4982 if (RA.isMaxSignedValue()) {
4983 Pred = ICmpInst::ICMP_NE;
4984 Changed = true;
4985 break;
4986 }
4987 if ((RA - 1).isMinSignedValue()) {
4988 Pred = ICmpInst::ICMP_EQ;
4989 RHS = getConstant(RA - 1);
4990 Changed = true;
4991 break;
4992 }
4993 if (RA.isMinSignedValue()) goto trivially_false;
4994 break;
4995 }
4996 }
4997
4998 // Check for obvious equality.
4999 if (HasSameValue(LHS, RHS)) {
5000 if (ICmpInst::isTrueWhenEqual(Pred))
5001 goto trivially_true;
5002 if (ICmpInst::isFalseWhenEqual(Pred))
5003 goto trivially_false;
5004 }
5005
Dan Gohman03557dc2010-05-03 16:35:17 +00005006 // If possible, canonicalize GE/LE comparisons to GT/LT comparisons, by
5007 // adding or subtracting 1 from one of the operands.
5008 switch (Pred) {
5009 case ICmpInst::ICMP_SLE:
5010 if (!getSignedRange(RHS).getSignedMax().isMaxSignedValue()) {
5011 RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
5012 /*HasNUW=*/false, /*HasNSW=*/true);
5013 Pred = ICmpInst::ICMP_SLT;
5014 Changed = true;
5015 } else if (!getSignedRange(LHS).getSignedMin().isMinSignedValue()) {
Dan Gohmanf16c6802010-05-03 20:23:47 +00005016 LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
Dan Gohman03557dc2010-05-03 16:35:17 +00005017 /*HasNUW=*/false, /*HasNSW=*/true);
5018 Pred = ICmpInst::ICMP_SLT;
5019 Changed = true;
5020 }
5021 break;
5022 case ICmpInst::ICMP_SGE:
5023 if (!getSignedRange(RHS).getSignedMin().isMinSignedValue()) {
Dan Gohmanf16c6802010-05-03 20:23:47 +00005024 RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
Dan Gohman03557dc2010-05-03 16:35:17 +00005025 /*HasNUW=*/false, /*HasNSW=*/true);
5026 Pred = ICmpInst::ICMP_SGT;
5027 Changed = true;
5028 } else if (!getSignedRange(LHS).getSignedMax().isMaxSignedValue()) {
5029 LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
5030 /*HasNUW=*/false, /*HasNSW=*/true);
5031 Pred = ICmpInst::ICMP_SGT;
5032 Changed = true;
5033 }
5034 break;
5035 case ICmpInst::ICMP_ULE:
5036 if (!getUnsignedRange(RHS).getUnsignedMax().isMaxValue()) {
Dan Gohmanf16c6802010-05-03 20:23:47 +00005037 RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
Dan Gohman03557dc2010-05-03 16:35:17 +00005038 /*HasNUW=*/true, /*HasNSW=*/false);
5039 Pred = ICmpInst::ICMP_ULT;
5040 Changed = true;
5041 } else if (!getUnsignedRange(LHS).getUnsignedMin().isMinValue()) {
Dan Gohmanf16c6802010-05-03 20:23:47 +00005042 LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
Dan Gohman03557dc2010-05-03 16:35:17 +00005043 /*HasNUW=*/true, /*HasNSW=*/false);
5044 Pred = ICmpInst::ICMP_ULT;
5045 Changed = true;
5046 }
5047 break;
5048 case ICmpInst::ICMP_UGE:
5049 if (!getUnsignedRange(RHS).getUnsignedMin().isMinValue()) {
Dan Gohmanf16c6802010-05-03 20:23:47 +00005050 RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
Dan Gohman03557dc2010-05-03 16:35:17 +00005051 /*HasNUW=*/true, /*HasNSW=*/false);
5052 Pred = ICmpInst::ICMP_UGT;
5053 Changed = true;
5054 } else if (!getUnsignedRange(LHS).getUnsignedMax().isMaxValue()) {
Dan Gohmanf16c6802010-05-03 20:23:47 +00005055 LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
Dan Gohman03557dc2010-05-03 16:35:17 +00005056 /*HasNUW=*/true, /*HasNSW=*/false);
5057 Pred = ICmpInst::ICMP_UGT;
5058 Changed = true;
5059 }
5060 break;
5061 default:
5062 break;
5063 }
5064
Dan Gohmane9796502010-04-24 01:28:42 +00005065 // TODO: More simplifications are possible here.
5066
5067 return Changed;
5068
5069trivially_true:
5070 // Return 0 == 0.
5071 LHS = RHS = getConstant(Type::getInt1Ty(getContext()), 0);
5072 Pred = ICmpInst::ICMP_EQ;
5073 return true;
5074
5075trivially_false:
5076 // Return 0 != 0.
5077 LHS = RHS = getConstant(Type::getInt1Ty(getContext()), 0);
5078 Pred = ICmpInst::ICMP_NE;
5079 return true;
5080}
5081
Dan Gohman85b05a22009-07-13 21:35:55 +00005082bool ScalarEvolution::isKnownNegative(const SCEV *S) {
5083 return getSignedRange(S).getSignedMax().isNegative();
5084}
5085
5086bool ScalarEvolution::isKnownPositive(const SCEV *S) {
5087 return getSignedRange(S).getSignedMin().isStrictlyPositive();
5088}
5089
5090bool ScalarEvolution::isKnownNonNegative(const SCEV *S) {
5091 return !getSignedRange(S).getSignedMin().isNegative();
5092}
5093
5094bool ScalarEvolution::isKnownNonPositive(const SCEV *S) {
5095 return !getSignedRange(S).getSignedMax().isStrictlyPositive();
5096}
5097
5098bool ScalarEvolution::isKnownNonZero(const SCEV *S) {
5099 return isKnownNegative(S) || isKnownPositive(S);
5100}
5101
5102bool ScalarEvolution::isKnownPredicate(ICmpInst::Predicate Pred,
5103 const SCEV *LHS, const SCEV *RHS) {
Dan Gohmand19bba62010-04-24 01:38:36 +00005104 // Canonicalize the inputs first.
5105 (void)SimplifyICmpOperands(Pred, LHS, RHS);
5106
Dan Gohman53c66ea2010-04-11 22:16:48 +00005107 // If LHS or RHS is an addrec, check to see if the condition is true in
5108 // every iteration of the loop.
5109 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS))
5110 if (isLoopEntryGuardedByCond(
5111 AR->getLoop(), Pred, AR->getStart(), RHS) &&
5112 isLoopBackedgeGuardedByCond(
Dan Gohmanacd8cab2010-05-04 01:12:27 +00005113 AR->getLoop(), Pred, AR->getPostIncExpr(*this), RHS))
Dan Gohman53c66ea2010-04-11 22:16:48 +00005114 return true;
5115 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS))
5116 if (isLoopEntryGuardedByCond(
5117 AR->getLoop(), Pred, LHS, AR->getStart()) &&
5118 isLoopBackedgeGuardedByCond(
Dan Gohmanacd8cab2010-05-04 01:12:27 +00005119 AR->getLoop(), Pred, LHS, AR->getPostIncExpr(*this)))
Dan Gohman53c66ea2010-04-11 22:16:48 +00005120 return true;
Dan Gohman85b05a22009-07-13 21:35:55 +00005121
Dan Gohman53c66ea2010-04-11 22:16:48 +00005122 // Otherwise see what can be done with known constant ranges.
5123 return isKnownPredicateWithRanges(Pred, LHS, RHS);
5124}
5125
5126bool
5127ScalarEvolution::isKnownPredicateWithRanges(ICmpInst::Predicate Pred,
5128 const SCEV *LHS, const SCEV *RHS) {
Dan Gohman85b05a22009-07-13 21:35:55 +00005129 if (HasSameValue(LHS, RHS))
5130 return ICmpInst::isTrueWhenEqual(Pred);
5131
Dan Gohman53c66ea2010-04-11 22:16:48 +00005132 // This code is split out from isKnownPredicate because it is called from
5133 // within isLoopEntryGuardedByCond.
Dan Gohman85b05a22009-07-13 21:35:55 +00005134 switch (Pred) {
5135 default:
Dan Gohman850f7912009-07-16 17:34:36 +00005136 llvm_unreachable("Unexpected ICmpInst::Predicate value!");
Dan Gohman85b05a22009-07-13 21:35:55 +00005137 break;
5138 case ICmpInst::ICMP_SGT:
5139 Pred = ICmpInst::ICMP_SLT;
5140 std::swap(LHS, RHS);
5141 case ICmpInst::ICMP_SLT: {
5142 ConstantRange LHSRange = getSignedRange(LHS);
5143 ConstantRange RHSRange = getSignedRange(RHS);
5144 if (LHSRange.getSignedMax().slt(RHSRange.getSignedMin()))
5145 return true;
5146 if (LHSRange.getSignedMin().sge(RHSRange.getSignedMax()))
5147 return false;
Dan Gohman85b05a22009-07-13 21:35:55 +00005148 break;
5149 }
5150 case ICmpInst::ICMP_SGE:
5151 Pred = ICmpInst::ICMP_SLE;
5152 std::swap(LHS, RHS);
5153 case ICmpInst::ICMP_SLE: {
5154 ConstantRange LHSRange = getSignedRange(LHS);
5155 ConstantRange RHSRange = getSignedRange(RHS);
5156 if (LHSRange.getSignedMax().sle(RHSRange.getSignedMin()))
5157 return true;
5158 if (LHSRange.getSignedMin().sgt(RHSRange.getSignedMax()))
5159 return false;
Dan Gohman85b05a22009-07-13 21:35:55 +00005160 break;
5161 }
5162 case ICmpInst::ICMP_UGT:
5163 Pred = ICmpInst::ICMP_ULT;
5164 std::swap(LHS, RHS);
5165 case ICmpInst::ICMP_ULT: {
5166 ConstantRange LHSRange = getUnsignedRange(LHS);
5167 ConstantRange RHSRange = getUnsignedRange(RHS);
5168 if (LHSRange.getUnsignedMax().ult(RHSRange.getUnsignedMin()))
5169 return true;
5170 if (LHSRange.getUnsignedMin().uge(RHSRange.getUnsignedMax()))
5171 return false;
Dan Gohman85b05a22009-07-13 21:35:55 +00005172 break;
5173 }
5174 case ICmpInst::ICMP_UGE:
5175 Pred = ICmpInst::ICMP_ULE;
5176 std::swap(LHS, RHS);
5177 case ICmpInst::ICMP_ULE: {
5178 ConstantRange LHSRange = getUnsignedRange(LHS);
5179 ConstantRange RHSRange = getUnsignedRange(RHS);
5180 if (LHSRange.getUnsignedMax().ule(RHSRange.getUnsignedMin()))
5181 return true;
5182 if (LHSRange.getUnsignedMin().ugt(RHSRange.getUnsignedMax()))
5183 return false;
Dan Gohman85b05a22009-07-13 21:35:55 +00005184 break;
5185 }
5186 case ICmpInst::ICMP_NE: {
5187 if (getUnsignedRange(LHS).intersectWith(getUnsignedRange(RHS)).isEmptySet())
5188 return true;
5189 if (getSignedRange(LHS).intersectWith(getSignedRange(RHS)).isEmptySet())
5190 return true;
5191
5192 const SCEV *Diff = getMinusSCEV(LHS, RHS);
5193 if (isKnownNonZero(Diff))
5194 return true;
5195 break;
5196 }
5197 case ICmpInst::ICMP_EQ:
Dan Gohmanf117ed42009-07-20 23:54:43 +00005198 // The check at the top of the function catches the case where
5199 // the values are known to be equal.
Dan Gohman85b05a22009-07-13 21:35:55 +00005200 break;
5201 }
5202 return false;
5203}
5204
5205/// isLoopBackedgeGuardedByCond - Test whether the backedge of the loop is
5206/// protected by a conditional between LHS and RHS. This is used to
5207/// to eliminate casts.
5208bool
5209ScalarEvolution::isLoopBackedgeGuardedByCond(const Loop *L,
5210 ICmpInst::Predicate Pred,
5211 const SCEV *LHS, const SCEV *RHS) {
5212 // Interpret a null as meaning no loop, where there is obviously no guard
5213 // (interprocedural conditions notwithstanding).
5214 if (!L) return true;
5215
5216 BasicBlock *Latch = L->getLoopLatch();
5217 if (!Latch)
5218 return false;
5219
5220 BranchInst *LoopContinuePredicate =
5221 dyn_cast<BranchInst>(Latch->getTerminator());
5222 if (!LoopContinuePredicate ||
5223 LoopContinuePredicate->isUnconditional())
5224 return false;
5225
Dan Gohman0f4b2852009-07-21 23:03:19 +00005226 return isImpliedCond(LoopContinuePredicate->getCondition(), Pred, LHS, RHS,
5227 LoopContinuePredicate->getSuccessor(0) != L->getHeader());
Dan Gohman85b05a22009-07-13 21:35:55 +00005228}
5229
Dan Gohman3948d0b2010-04-11 19:27:13 +00005230/// isLoopEntryGuardedByCond - Test whether entry to the loop is protected
Dan Gohman85b05a22009-07-13 21:35:55 +00005231/// by a conditional between LHS and RHS. This is used to help avoid max
5232/// expressions in loop trip counts, and to eliminate casts.
5233bool
Dan Gohman3948d0b2010-04-11 19:27:13 +00005234ScalarEvolution::isLoopEntryGuardedByCond(const Loop *L,
5235 ICmpInst::Predicate Pred,
5236 const SCEV *LHS, const SCEV *RHS) {
Dan Gohman8ea94522009-05-18 16:03:58 +00005237 // Interpret a null as meaning no loop, where there is obviously no guard
5238 // (interprocedural conditions notwithstanding).
5239 if (!L) return false;
5240
Dan Gohman859b4822009-05-18 15:36:09 +00005241 // Starting at the loop predecessor, climb up the predecessor chain, as long
5242 // as there are predecessors that can be found that have unique successors
Dan Gohmanfd6edef2008-09-15 22:18:04 +00005243 // leading to the original header.
Dan Gohman005752b2010-04-15 16:19:08 +00005244 for (std::pair<BasicBlock *, BasicBlock *>
Dan Gohman605c14f2010-06-22 23:43:28 +00005245 Pair(L->getLoopPredecessor(), L->getHeader());
Dan Gohman005752b2010-04-15 16:19:08 +00005246 Pair.first;
5247 Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) {
Dan Gohman38372182008-08-12 20:17:31 +00005248
5249 BranchInst *LoopEntryPredicate =
Dan Gohman005752b2010-04-15 16:19:08 +00005250 dyn_cast<BranchInst>(Pair.first->getTerminator());
Dan Gohman38372182008-08-12 20:17:31 +00005251 if (!LoopEntryPredicate ||
5252 LoopEntryPredicate->isUnconditional())
5253 continue;
5254
Dan Gohman0f4b2852009-07-21 23:03:19 +00005255 if (isImpliedCond(LoopEntryPredicate->getCondition(), Pred, LHS, RHS,
Dan Gohman005752b2010-04-15 16:19:08 +00005256 LoopEntryPredicate->getSuccessor(0) != Pair.second))
Dan Gohman38372182008-08-12 20:17:31 +00005257 return true;
Nick Lewycky59cff122008-07-12 07:41:32 +00005258 }
5259
Dan Gohman38372182008-08-12 20:17:31 +00005260 return false;
Nick Lewycky59cff122008-07-12 07:41:32 +00005261}
5262
Dan Gohman0f4b2852009-07-21 23:03:19 +00005263/// isImpliedCond - Test whether the condition described by Pred, LHS,
5264/// and RHS is true whenever the given Cond value evaluates to true.
5265bool ScalarEvolution::isImpliedCond(Value *CondValue,
5266 ICmpInst::Predicate Pred,
5267 const SCEV *LHS, const SCEV *RHS,
5268 bool Inverse) {
Dan Gohman3f46a3a2010-03-01 17:49:51 +00005269 // Recursively handle And and Or conditions.
Dan Gohman40a5a1b2009-06-24 01:18:18 +00005270 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CondValue)) {
5271 if (BO->getOpcode() == Instruction::And) {
5272 if (!Inverse)
Dan Gohman0f4b2852009-07-21 23:03:19 +00005273 return isImpliedCond(BO->getOperand(0), Pred, LHS, RHS, Inverse) ||
5274 isImpliedCond(BO->getOperand(1), Pred, LHS, RHS, Inverse);
Dan Gohman40a5a1b2009-06-24 01:18:18 +00005275 } else if (BO->getOpcode() == Instruction::Or) {
5276 if (Inverse)
Dan Gohman0f4b2852009-07-21 23:03:19 +00005277 return isImpliedCond(BO->getOperand(0), Pred, LHS, RHS, Inverse) ||
5278 isImpliedCond(BO->getOperand(1), Pred, LHS, RHS, Inverse);
Dan Gohman40a5a1b2009-06-24 01:18:18 +00005279 }
5280 }
5281
5282 ICmpInst *ICI = dyn_cast<ICmpInst>(CondValue);
5283 if (!ICI) return false;
5284
Dan Gohman85b05a22009-07-13 21:35:55 +00005285 // Bail if the ICmp's operands' types are wider than the needed type
5286 // before attempting to call getSCEV on them. This avoids infinite
5287 // recursion, since the analysis of widening casts can require loop
5288 // exit condition information for overflow checking, which would
5289 // lead back here.
5290 if (getTypeSizeInBits(LHS->getType()) <
Dan Gohman0f4b2852009-07-21 23:03:19 +00005291 getTypeSizeInBits(ICI->getOperand(0)->getType()))
Dan Gohman85b05a22009-07-13 21:35:55 +00005292 return false;
5293
Dan Gohman0f4b2852009-07-21 23:03:19 +00005294 // Now that we found a conditional branch that dominates the loop, check to
5295 // see if it is the comparison we are looking for.
5296 ICmpInst::Predicate FoundPred;
5297 if (Inverse)
5298 FoundPred = ICI->getInversePredicate();
5299 else
5300 FoundPred = ICI->getPredicate();
5301
5302 const SCEV *FoundLHS = getSCEV(ICI->getOperand(0));
5303 const SCEV *FoundRHS = getSCEV(ICI->getOperand(1));
Dan Gohman85b05a22009-07-13 21:35:55 +00005304
5305 // Balance the types. The case where FoundLHS' type is wider than
5306 // LHS' type is checked for above.
5307 if (getTypeSizeInBits(LHS->getType()) >
5308 getTypeSizeInBits(FoundLHS->getType())) {
5309 if (CmpInst::isSigned(Pred)) {
5310 FoundLHS = getSignExtendExpr(FoundLHS, LHS->getType());
5311 FoundRHS = getSignExtendExpr(FoundRHS, LHS->getType());
5312 } else {
5313 FoundLHS = getZeroExtendExpr(FoundLHS, LHS->getType());
5314 FoundRHS = getZeroExtendExpr(FoundRHS, LHS->getType());
5315 }
5316 }
5317
Dan Gohman0f4b2852009-07-21 23:03:19 +00005318 // Canonicalize the query to match the way instcombine will have
5319 // canonicalized the comparison.
Dan Gohmand4da5af2010-04-24 01:34:53 +00005320 if (SimplifyICmpOperands(Pred, LHS, RHS))
5321 if (LHS == RHS)
Dan Gohman34c3e362010-05-03 18:00:24 +00005322 return CmpInst::isTrueWhenEqual(Pred);
Dan Gohmand4da5af2010-04-24 01:34:53 +00005323 if (SimplifyICmpOperands(FoundPred, FoundLHS, FoundRHS))
5324 if (FoundLHS == FoundRHS)
Dan Gohman34c3e362010-05-03 18:00:24 +00005325 return CmpInst::isFalseWhenEqual(Pred);
Dan Gohman0f4b2852009-07-21 23:03:19 +00005326
5327 // Check to see if we can make the LHS or RHS match.
5328 if (LHS == FoundRHS || RHS == FoundLHS) {
5329 if (isa<SCEVConstant>(RHS)) {
5330 std::swap(FoundLHS, FoundRHS);
5331 FoundPred = ICmpInst::getSwappedPredicate(FoundPred);
5332 } else {
5333 std::swap(LHS, RHS);
5334 Pred = ICmpInst::getSwappedPredicate(Pred);
5335 }
5336 }
5337
5338 // Check whether the found predicate is the same as the desired predicate.
5339 if (FoundPred == Pred)
5340 return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS);
5341
5342 // Check whether swapping the found predicate makes it the same as the
5343 // desired predicate.
5344 if (ICmpInst::getSwappedPredicate(FoundPred) == Pred) {
5345 if (isa<SCEVConstant>(RHS))
5346 return isImpliedCondOperands(Pred, LHS, RHS, FoundRHS, FoundLHS);
5347 else
5348 return isImpliedCondOperands(ICmpInst::getSwappedPredicate(Pred),
5349 RHS, LHS, FoundLHS, FoundRHS);
5350 }
5351
5352 // Check whether the actual condition is beyond sufficient.
5353 if (FoundPred == ICmpInst::ICMP_EQ)
5354 if (ICmpInst::isTrueWhenEqual(Pred))
5355 if (isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS))
5356 return true;
5357 if (Pred == ICmpInst::ICMP_NE)
5358 if (!ICmpInst::isTrueWhenEqual(FoundPred))
5359 if (isImpliedCondOperands(FoundPred, LHS, RHS, FoundLHS, FoundRHS))
5360 return true;
5361
5362 // Otherwise assume the worst.
5363 return false;
Dan Gohman85b05a22009-07-13 21:35:55 +00005364}
5365
Dan Gohman0f4b2852009-07-21 23:03:19 +00005366/// isImpliedCondOperands - Test whether the condition described by Pred,
Dan Gohman3f46a3a2010-03-01 17:49:51 +00005367/// LHS, and RHS is true whenever the condition described by Pred, FoundLHS,
Dan Gohman0f4b2852009-07-21 23:03:19 +00005368/// and FoundRHS is true.
5369bool ScalarEvolution::isImpliedCondOperands(ICmpInst::Predicate Pred,
5370 const SCEV *LHS, const SCEV *RHS,
5371 const SCEV *FoundLHS,
5372 const SCEV *FoundRHS) {
5373 return isImpliedCondOperandsHelper(Pred, LHS, RHS,
5374 FoundLHS, FoundRHS) ||
5375 // ~x < ~y --> x > y
5376 isImpliedCondOperandsHelper(Pred, LHS, RHS,
5377 getNotSCEV(FoundRHS),
5378 getNotSCEV(FoundLHS));
5379}
5380
5381/// isImpliedCondOperandsHelper - Test whether the condition described by
Dan Gohman3f46a3a2010-03-01 17:49:51 +00005382/// Pred, LHS, and RHS is true whenever the condition described by Pred,
Dan Gohman0f4b2852009-07-21 23:03:19 +00005383/// FoundLHS, and FoundRHS is true.
Dan Gohman85b05a22009-07-13 21:35:55 +00005384bool
Dan Gohman0f4b2852009-07-21 23:03:19 +00005385ScalarEvolution::isImpliedCondOperandsHelper(ICmpInst::Predicate Pred,
5386 const SCEV *LHS, const SCEV *RHS,
5387 const SCEV *FoundLHS,
5388 const SCEV *FoundRHS) {
Dan Gohman85b05a22009-07-13 21:35:55 +00005389 switch (Pred) {
Dan Gohman850f7912009-07-16 17:34:36 +00005390 default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
5391 case ICmpInst::ICMP_EQ:
5392 case ICmpInst::ICMP_NE:
5393 if (HasSameValue(LHS, FoundLHS) && HasSameValue(RHS, FoundRHS))
5394 return true;
5395 break;
Dan Gohman85b05a22009-07-13 21:35:55 +00005396 case ICmpInst::ICMP_SLT:
Dan Gohman850f7912009-07-16 17:34:36 +00005397 case ICmpInst::ICMP_SLE:
Dan Gohman53c66ea2010-04-11 22:16:48 +00005398 if (isKnownPredicateWithRanges(ICmpInst::ICMP_SLE, LHS, FoundLHS) &&
5399 isKnownPredicateWithRanges(ICmpInst::ICMP_SGE, RHS, FoundRHS))
Dan Gohman85b05a22009-07-13 21:35:55 +00005400 return true;
5401 break;
5402 case ICmpInst::ICMP_SGT:
Dan Gohman850f7912009-07-16 17:34:36 +00005403 case ICmpInst::ICMP_SGE:
Dan Gohman53c66ea2010-04-11 22:16:48 +00005404 if (isKnownPredicateWithRanges(ICmpInst::ICMP_SGE, LHS, FoundLHS) &&
5405 isKnownPredicateWithRanges(ICmpInst::ICMP_SLE, RHS, FoundRHS))
Dan Gohman85b05a22009-07-13 21:35:55 +00005406 return true;
5407 break;
5408 case ICmpInst::ICMP_ULT:
Dan Gohman850f7912009-07-16 17:34:36 +00005409 case ICmpInst::ICMP_ULE:
Dan Gohman53c66ea2010-04-11 22:16:48 +00005410 if (isKnownPredicateWithRanges(ICmpInst::ICMP_ULE, LHS, FoundLHS) &&
5411 isKnownPredicateWithRanges(ICmpInst::ICMP_UGE, RHS, FoundRHS))
Dan Gohman85b05a22009-07-13 21:35:55 +00005412 return true;
5413 break;
5414 case ICmpInst::ICMP_UGT:
Dan Gohman850f7912009-07-16 17:34:36 +00005415 case ICmpInst::ICMP_UGE:
Dan Gohman53c66ea2010-04-11 22:16:48 +00005416 if (isKnownPredicateWithRanges(ICmpInst::ICMP_UGE, LHS, FoundLHS) &&
5417 isKnownPredicateWithRanges(ICmpInst::ICMP_ULE, RHS, FoundRHS))
Dan Gohman85b05a22009-07-13 21:35:55 +00005418 return true;
5419 break;
5420 }
5421
5422 return false;
Dan Gohman40a5a1b2009-06-24 01:18:18 +00005423}
5424
Dan Gohman51f53b72009-06-21 23:46:38 +00005425/// getBECount - Subtract the end and start values and divide by the step,
5426/// rounding up, to get the number of times the backedge is executed. Return
5427/// CouldNotCompute if an intermediate computation overflows.
Dan Gohman0bba49c2009-07-07 17:06:11 +00005428const SCEV *ScalarEvolution::getBECount(const SCEV *Start,
Dan Gohmanf5074ec2009-07-13 22:05:32 +00005429 const SCEV *End,
Dan Gohman1f96e672009-09-17 18:05:20 +00005430 const SCEV *Step,
5431 bool NoWrap) {
Dan Gohman52fddd32010-01-26 04:40:18 +00005432 assert(!isKnownNegative(Step) &&
5433 "This code doesn't handle negative strides yet!");
5434
Dan Gohman51f53b72009-06-21 23:46:38 +00005435 const Type *Ty = Start->getType();
Dan Gohmandeff6212010-05-03 22:09:21 +00005436 const SCEV *NegOne = getConstant(Ty, (uint64_t)-1);
Dan Gohman0bba49c2009-07-07 17:06:11 +00005437 const SCEV *Diff = getMinusSCEV(End, Start);
5438 const SCEV *RoundUp = getAddExpr(Step, NegOne);
Dan Gohman51f53b72009-06-21 23:46:38 +00005439
5440 // Add an adjustment to the difference between End and Start so that
5441 // the division will effectively round up.
Dan Gohman0bba49c2009-07-07 17:06:11 +00005442 const SCEV *Add = getAddExpr(Diff, RoundUp);
Dan Gohman51f53b72009-06-21 23:46:38 +00005443
Dan Gohman1f96e672009-09-17 18:05:20 +00005444 if (!NoWrap) {
5445 // Check Add for unsigned overflow.
5446 // TODO: More sophisticated things could be done here.
5447 const Type *WideTy = IntegerType::get(getContext(),
5448 getTypeSizeInBits(Ty) + 1);
5449 const SCEV *EDiff = getZeroExtendExpr(Diff, WideTy);
5450 const SCEV *ERoundUp = getZeroExtendExpr(RoundUp, WideTy);
5451 const SCEV *OperandExtendedAdd = getAddExpr(EDiff, ERoundUp);
5452 if (getZeroExtendExpr(Add, WideTy) != OperandExtendedAdd)
5453 return getCouldNotCompute();
5454 }
Dan Gohman51f53b72009-06-21 23:46:38 +00005455
5456 return getUDivExpr(Add, Step);
5457}
5458
Chris Lattnerdb25de42005-08-15 23:33:51 +00005459/// HowManyLessThans - Return the number of times a backedge containing the
5460/// specified less-than comparison will execute. If not computable, return
Dan Gohman86fbf2f2009-06-06 14:37:11 +00005461/// CouldNotCompute.
Dan Gohman64a845e2009-06-24 04:48:43 +00005462ScalarEvolution::BackedgeTakenInfo
5463ScalarEvolution::HowManyLessThans(const SCEV *LHS, const SCEV *RHS,
5464 const Loop *L, bool isSigned) {
Chris Lattnerdb25de42005-08-15 23:33:51 +00005465 // Only handle: "ADDREC < LoopInvariant".
Dan Gohman1c343752009-06-27 21:21:31 +00005466 if (!RHS->isLoopInvariant(L)) return getCouldNotCompute();
Chris Lattnerdb25de42005-08-15 23:33:51 +00005467
Dan Gohman35738ac2009-05-04 22:30:44 +00005468 const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS);
Chris Lattnerdb25de42005-08-15 23:33:51 +00005469 if (!AddRec || AddRec->getLoop() != L)
Dan Gohman1c343752009-06-27 21:21:31 +00005470 return getCouldNotCompute();
Chris Lattnerdb25de42005-08-15 23:33:51 +00005471
Dan Gohman1f96e672009-09-17 18:05:20 +00005472 // Check to see if we have a flag which makes analysis easy.
5473 bool NoWrap = isSigned ? AddRec->hasNoSignedWrap() :
5474 AddRec->hasNoUnsignedWrap();
5475
Chris Lattnerdb25de42005-08-15 23:33:51 +00005476 if (AddRec->isAffine()) {
Dan Gohmana1af7572009-04-30 20:47:05 +00005477 unsigned BitWidth = getTypeSizeInBits(AddRec->getType());
Dan Gohman0bba49c2009-07-07 17:06:11 +00005478 const SCEV *Step = AddRec->getStepRecurrence(*this);
Dan Gohmana1af7572009-04-30 20:47:05 +00005479
Dan Gohman52fddd32010-01-26 04:40:18 +00005480 if (Step->isZero())
Dan Gohman1c343752009-06-27 21:21:31 +00005481 return getCouldNotCompute();
Dan Gohman52fddd32010-01-26 04:40:18 +00005482 if (Step->isOne()) {
Dan Gohmana1af7572009-04-30 20:47:05 +00005483 // With unit stride, the iteration never steps past the limit value.
Dan Gohman52fddd32010-01-26 04:40:18 +00005484 } else if (isKnownPositive(Step)) {
Dan Gohmanf451cb82010-02-10 16:03:48 +00005485 // Test whether a positive iteration can step past the limit
Dan Gohman52fddd32010-01-26 04:40:18 +00005486 // value and past the maximum value for its type in a single step.
5487 // Note that it's not sufficient to check NoWrap here, because even
5488 // though the value after a wrap is undefined, it's not undefined
5489 // behavior, so if wrap does occur, the loop could either terminate or
Dan Gohman155eec72010-01-26 18:32:54 +00005490 // loop infinitely, but in either case, the loop is guaranteed to
Dan Gohman52fddd32010-01-26 04:40:18 +00005491 // iterate at least until the iteration where the wrapping occurs.
Dan Gohmandeff6212010-05-03 22:09:21 +00005492 const SCEV *One = getConstant(Step->getType(), 1);
Dan Gohman52fddd32010-01-26 04:40:18 +00005493 if (isSigned) {
5494 APInt Max = APInt::getSignedMaxValue(BitWidth);
5495 if ((Max - getSignedRange(getMinusSCEV(Step, One)).getSignedMax())
5496 .slt(getSignedRange(RHS).getSignedMax()))
5497 return getCouldNotCompute();
5498 } else {
5499 APInt Max = APInt::getMaxValue(BitWidth);
5500 if ((Max - getUnsignedRange(getMinusSCEV(Step, One)).getUnsignedMax())
5501 .ult(getUnsignedRange(RHS).getUnsignedMax()))
5502 return getCouldNotCompute();
5503 }
Dan Gohmana1af7572009-04-30 20:47:05 +00005504 } else
Dan Gohman52fddd32010-01-26 04:40:18 +00005505 // TODO: Handle negative strides here and below.
Dan Gohman1c343752009-06-27 21:21:31 +00005506 return getCouldNotCompute();
Chris Lattnerdb25de42005-08-15 23:33:51 +00005507
Dan Gohmana1af7572009-04-30 20:47:05 +00005508 // We know the LHS is of the form {n,+,s} and the RHS is some loop-invariant
5509 // m. So, we count the number of iterations in which {n,+,s} < m is true.
5510 // Note that we cannot simply return max(m-n,0)/s because it's not safe to
Wojciech Matyjewicza65ee032008-02-13 12:21:32 +00005511 // treat m-n as signed nor unsigned due to overflow possibility.
Chris Lattnerdb25de42005-08-15 23:33:51 +00005512
Wojciech Matyjewicz3a4cbe22008-02-13 11:51:34 +00005513 // First, we get the value of the LHS in the first iteration: n
Dan Gohman0bba49c2009-07-07 17:06:11 +00005514 const SCEV *Start = AddRec->getOperand(0);
Wojciech Matyjewicz3a4cbe22008-02-13 11:51:34 +00005515
Dan Gohmana1af7572009-04-30 20:47:05 +00005516 // Determine the minimum constant start value.
Dan Gohman85b05a22009-07-13 21:35:55 +00005517 const SCEV *MinStart = getConstant(isSigned ?
5518 getSignedRange(Start).getSignedMin() :
5519 getUnsignedRange(Start).getUnsignedMin());
Wojciech Matyjewicz3a4cbe22008-02-13 11:51:34 +00005520
Dan Gohmana1af7572009-04-30 20:47:05 +00005521 // If we know that the condition is true in order to enter the loop,
5522 // then we know that it will run exactly (m-n)/s times. Otherwise, we
Dan Gohman6c0866c2009-05-24 23:45:28 +00005523 // only know that it will execute (max(m,n)-n)/s times. In both cases,
5524 // the division must round up.
Dan Gohman0bba49c2009-07-07 17:06:11 +00005525 const SCEV *End = RHS;
Dan Gohman3948d0b2010-04-11 19:27:13 +00005526 if (!isLoopEntryGuardedByCond(L,
5527 isSigned ? ICmpInst::ICMP_SLT :
5528 ICmpInst::ICMP_ULT,
5529 getMinusSCEV(Start, Step), RHS))
Dan Gohmana1af7572009-04-30 20:47:05 +00005530 End = isSigned ? getSMaxExpr(RHS, Start)
5531 : getUMaxExpr(RHS, Start);
5532
5533 // Determine the maximum constant end value.
Dan Gohman85b05a22009-07-13 21:35:55 +00005534 const SCEV *MaxEnd = getConstant(isSigned ?
5535 getSignedRange(End).getSignedMax() :
5536 getUnsignedRange(End).getUnsignedMax());
Dan Gohmana1af7572009-04-30 20:47:05 +00005537
Dan Gohman52fddd32010-01-26 04:40:18 +00005538 // If MaxEnd is within a step of the maximum integer value in its type,
5539 // adjust it down to the minimum value which would produce the same effect.
Dan Gohman3f46a3a2010-03-01 17:49:51 +00005540 // This allows the subsequent ceiling division of (N+(step-1))/step to
Dan Gohman52fddd32010-01-26 04:40:18 +00005541 // compute the correct value.
5542 const SCEV *StepMinusOne = getMinusSCEV(Step,
Dan Gohmandeff6212010-05-03 22:09:21 +00005543 getConstant(Step->getType(), 1));
Dan Gohman52fddd32010-01-26 04:40:18 +00005544 MaxEnd = isSigned ?
5545 getSMinExpr(MaxEnd,
5546 getMinusSCEV(getConstant(APInt::getSignedMaxValue(BitWidth)),
5547 StepMinusOne)) :
5548 getUMinExpr(MaxEnd,
5549 getMinusSCEV(getConstant(APInt::getMaxValue(BitWidth)),
5550 StepMinusOne));
5551
Dan Gohmana1af7572009-04-30 20:47:05 +00005552 // Finally, we subtract these two values and divide, rounding up, to get
5553 // the number of times the backedge is executed.
Dan Gohman1f96e672009-09-17 18:05:20 +00005554 const SCEV *BECount = getBECount(Start, End, Step, NoWrap);
Dan Gohmana1af7572009-04-30 20:47:05 +00005555
5556 // The maximum backedge count is similar, except using the minimum start
5557 // value and the maximum end value.
Dan Gohman1f96e672009-09-17 18:05:20 +00005558 const SCEV *MaxBECount = getBECount(MinStart, MaxEnd, Step, NoWrap);
Dan Gohmana1af7572009-04-30 20:47:05 +00005559
5560 return BackedgeTakenInfo(BECount, MaxBECount);
Chris Lattnerdb25de42005-08-15 23:33:51 +00005561 }
5562
Dan Gohman1c343752009-06-27 21:21:31 +00005563 return getCouldNotCompute();
Chris Lattnerdb25de42005-08-15 23:33:51 +00005564}
5565
Chris Lattner53e677a2004-04-02 20:23:17 +00005566/// getNumIterationsInRange - Return the number of iterations of this loop that
5567/// produce values in the specified constant range. Another way of looking at
5568/// this is that it returns the first iteration number where the value is not in
5569/// the condition, thus computing the exit count. If the iteration count can't
5570/// be computed, an instance of SCEVCouldNotCompute is returned.
Dan Gohman0bba49c2009-07-07 17:06:11 +00005571const SCEV *SCEVAddRecExpr::getNumIterationsInRange(ConstantRange Range,
Dan Gohman64a845e2009-06-24 04:48:43 +00005572 ScalarEvolution &SE) const {
Chris Lattner53e677a2004-04-02 20:23:17 +00005573 if (Range.isFullSet()) // Infinite loop.
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005574 return SE.getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00005575
5576 // If the start is a non-zero constant, shift the range to simplify things.
Dan Gohman622ed672009-05-04 22:02:23 +00005577 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart()))
Reid Spencercae57542007-03-02 00:28:52 +00005578 if (!SC->getValue()->isZero()) {
Dan Gohman0bba49c2009-07-07 17:06:11 +00005579 SmallVector<const SCEV *, 4> Operands(op_begin(), op_end());
Dan Gohmandeff6212010-05-03 22:09:21 +00005580 Operands[0] = SE.getConstant(SC->getType(), 0);
Dan Gohman0bba49c2009-07-07 17:06:11 +00005581 const SCEV *Shifted = SE.getAddRecExpr(Operands, getLoop());
Dan Gohman622ed672009-05-04 22:02:23 +00005582 if (const SCEVAddRecExpr *ShiftedAddRec =
5583 dyn_cast<SCEVAddRecExpr>(Shifted))
Chris Lattner53e677a2004-04-02 20:23:17 +00005584 return ShiftedAddRec->getNumIterationsInRange(
Dan Gohman246b2562007-10-22 18:31:58 +00005585 Range.subtract(SC->getValue()->getValue()), SE);
Chris Lattner53e677a2004-04-02 20:23:17 +00005586 // This is strange and shouldn't happen.
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005587 return SE.getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00005588 }
5589
5590 // The only time we can solve this is when we have all constant indices.
5591 // Otherwise, we cannot determine the overflow conditions.
5592 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
5593 if (!isa<SCEVConstant>(getOperand(i)))
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005594 return SE.getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00005595
5596
5597 // Okay at this point we know that all elements of the chrec are constants and
5598 // that the start element is zero.
5599
5600 // First check to see if the range contains zero. If not, the first
5601 // iteration exits.
Dan Gohmanaf79fb52009-04-21 01:07:12 +00005602 unsigned BitWidth = SE.getTypeSizeInBits(getType());
Dan Gohman2d1be872009-04-16 03:18:22 +00005603 if (!Range.contains(APInt(BitWidth, 0)))
Dan Gohmandeff6212010-05-03 22:09:21 +00005604 return SE.getConstant(getType(), 0);
Misha Brukman2b37d7c2005-04-21 21:13:18 +00005605
Chris Lattner53e677a2004-04-02 20:23:17 +00005606 if (isAffine()) {
5607 // If this is an affine expression then we have this situation:
5608 // Solve {0,+,A} in Range === Ax in Range
5609
Nick Lewyckyeefdebe2007-07-16 02:08:00 +00005610 // We know that zero is in the range. If A is positive then we know that
5611 // the upper value of the range must be the first possible exit value.
5612 // If A is negative then the lower of the range is the last possible loop
5613 // value. Also note that we already checked for a full range.
Dan Gohman2d1be872009-04-16 03:18:22 +00005614 APInt One(BitWidth,1);
Nick Lewyckyeefdebe2007-07-16 02:08:00 +00005615 APInt A = cast<SCEVConstant>(getOperand(1))->getValue()->getValue();
5616 APInt End = A.sge(One) ? (Range.getUpper() - One) : Range.getLower();
Chris Lattner53e677a2004-04-02 20:23:17 +00005617
Nick Lewyckyeefdebe2007-07-16 02:08:00 +00005618 // The exit value should be (End+A)/A.
Nick Lewycky9a2f9312007-09-27 14:12:54 +00005619 APInt ExitVal = (End + A).udiv(A);
Owen Andersoneed707b2009-07-24 23:12:02 +00005620 ConstantInt *ExitValue = ConstantInt::get(SE.getContext(), ExitVal);
Chris Lattner53e677a2004-04-02 20:23:17 +00005621
5622 // Evaluate at the exit value. If we really did fall out of the valid
5623 // range, then we computed our trip count, otherwise wrap around or other
5624 // things must have happened.
Dan Gohman246b2562007-10-22 18:31:58 +00005625 ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue, SE);
Reid Spencera6e8a952007-03-01 07:54:15 +00005626 if (Range.contains(Val->getValue()))
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005627 return SE.getCouldNotCompute(); // Something strange happened
Chris Lattner53e677a2004-04-02 20:23:17 +00005628
5629 // Ensure that the previous value is in the range. This is a sanity check.
Reid Spencer581b0d42007-02-28 19:57:34 +00005630 assert(Range.contains(
Dan Gohman64a845e2009-06-24 04:48:43 +00005631 EvaluateConstantChrecAtConstant(this,
Owen Andersoneed707b2009-07-24 23:12:02 +00005632 ConstantInt::get(SE.getContext(), ExitVal - One), SE)->getValue()) &&
Chris Lattner53e677a2004-04-02 20:23:17 +00005633 "Linear scev computation is off in a bad way!");
Dan Gohman246b2562007-10-22 18:31:58 +00005634 return SE.getConstant(ExitValue);
Chris Lattner53e677a2004-04-02 20:23:17 +00005635 } else if (isQuadratic()) {
5636 // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of the
5637 // quadratic equation to solve it. To do this, we must frame our problem in
5638 // terms of figuring out when zero is crossed, instead of when
5639 // Range.getUpper() is crossed.
Dan Gohman0bba49c2009-07-07 17:06:11 +00005640 SmallVector<const SCEV *, 4> NewOps(op_begin(), op_end());
Dan Gohman246b2562007-10-22 18:31:58 +00005641 NewOps[0] = SE.getNegativeSCEV(SE.getConstant(Range.getUpper()));
Dan Gohman0bba49c2009-07-07 17:06:11 +00005642 const SCEV *NewAddRec = SE.getAddRecExpr(NewOps, getLoop());
Chris Lattner53e677a2004-04-02 20:23:17 +00005643
5644 // Next, solve the constructed addrec
Dan Gohman0bba49c2009-07-07 17:06:11 +00005645 std::pair<const SCEV *,const SCEV *> Roots =
Dan Gohman246b2562007-10-22 18:31:58 +00005646 SolveQuadraticEquation(cast<SCEVAddRecExpr>(NewAddRec), SE);
Dan Gohman35738ac2009-05-04 22:30:44 +00005647 const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
5648 const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
Chris Lattner53e677a2004-04-02 20:23:17 +00005649 if (R1) {
5650 // Pick the smallest positive root value.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00005651 if (ConstantInt *CB =
Owen Andersonbaf3c402009-07-29 18:55:55 +00005652 dyn_cast<ConstantInt>(ConstantExpr::getICmp(ICmpInst::ICMP_ULT,
Owen Anderson76f600b2009-07-06 22:37:39 +00005653 R1->getValue(), R2->getValue()))) {
Reid Spencer579dca12007-01-12 04:24:46 +00005654 if (CB->getZExtValue() == false)
Chris Lattner53e677a2004-04-02 20:23:17 +00005655 std::swap(R1, R2); // R1 is the minimum root now.
Misha Brukman2b37d7c2005-04-21 21:13:18 +00005656
Chris Lattner53e677a2004-04-02 20:23:17 +00005657 // Make sure the root is not off by one. The returned iteration should
5658 // not be in the range, but the previous one should be. When solving
5659 // for "X*X < 5", for example, we should not return a root of 2.
5660 ConstantInt *R1Val = EvaluateConstantChrecAtConstant(this,
Dan Gohman246b2562007-10-22 18:31:58 +00005661 R1->getValue(),
5662 SE);
Reid Spencera6e8a952007-03-01 07:54:15 +00005663 if (Range.contains(R1Val->getValue())) {
Chris Lattner53e677a2004-04-02 20:23:17 +00005664 // The next iteration must be out of the range...
Owen Anderson76f600b2009-07-06 22:37:39 +00005665 ConstantInt *NextVal =
Owen Andersoneed707b2009-07-24 23:12:02 +00005666 ConstantInt::get(SE.getContext(), R1->getValue()->getValue()+1);
Misha Brukman2b37d7c2005-04-21 21:13:18 +00005667
Dan Gohman246b2562007-10-22 18:31:58 +00005668 R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
Reid Spencera6e8a952007-03-01 07:54:15 +00005669 if (!Range.contains(R1Val->getValue()))
Dan Gohman246b2562007-10-22 18:31:58 +00005670 return SE.getConstant(NextVal);
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005671 return SE.getCouldNotCompute(); // Something strange happened
Chris Lattner53e677a2004-04-02 20:23:17 +00005672 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +00005673
Chris Lattner53e677a2004-04-02 20:23:17 +00005674 // If R1 was not in the range, then it is a good return value. Make
5675 // sure that R1-1 WAS in the range though, just in case.
Owen Anderson76f600b2009-07-06 22:37:39 +00005676 ConstantInt *NextVal =
Owen Andersoneed707b2009-07-24 23:12:02 +00005677 ConstantInt::get(SE.getContext(), R1->getValue()->getValue()-1);
Dan Gohman246b2562007-10-22 18:31:58 +00005678 R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
Reid Spencera6e8a952007-03-01 07:54:15 +00005679 if (Range.contains(R1Val->getValue()))
Chris Lattner53e677a2004-04-02 20:23:17 +00005680 return R1;
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005681 return SE.getCouldNotCompute(); // Something strange happened
Chris Lattner53e677a2004-04-02 20:23:17 +00005682 }
5683 }
5684 }
5685
Dan Gohmanf4ccfcb2009-04-18 17:58:19 +00005686 return SE.getCouldNotCompute();
Chris Lattner53e677a2004-04-02 20:23:17 +00005687}
5688
5689
5690
5691//===----------------------------------------------------------------------===//
Dan Gohman35738ac2009-05-04 22:30:44 +00005692// SCEVCallbackVH Class Implementation
5693//===----------------------------------------------------------------------===//
5694
Dan Gohman1959b752009-05-19 19:22:47 +00005695void ScalarEvolution::SCEVCallbackVH::deleted() {
Dan Gohmanddf9f992009-07-13 22:20:53 +00005696 assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
Dan Gohman35738ac2009-05-04 22:30:44 +00005697 if (PHINode *PN = dyn_cast<PHINode>(getValPtr()))
5698 SE->ConstantEvolutionLoopExitValue.erase(PN);
5699 SE->Scalars.erase(getValPtr());
5700 // this now dangles!
5701}
5702
Dan Gohman81f91212010-07-28 01:09:07 +00005703void ScalarEvolution::SCEVCallbackVH::allUsesReplacedWith(Value *V) {
Dan Gohmanddf9f992009-07-13 22:20:53 +00005704 assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
Eric Christophere6cbfa62010-07-29 01:25:38 +00005705
Dan Gohman35738ac2009-05-04 22:30:44 +00005706 // Forget all the expressions associated with users of the old value,
5707 // so that future queries will recompute the expressions using the new
5708 // value.
Dan Gohmanab37f502010-08-02 23:49:30 +00005709 Value *Old = getValPtr();
Dan Gohman35738ac2009-05-04 22:30:44 +00005710 SmallVector<User *, 16> Worklist;
Dan Gohman69fcae92009-07-14 14:34:04 +00005711 SmallPtrSet<User *, 8> Visited;
Dan Gohman35738ac2009-05-04 22:30:44 +00005712 for (Value::use_iterator UI = Old->use_begin(), UE = Old->use_end();
5713 UI != UE; ++UI)
5714 Worklist.push_back(*UI);
5715 while (!Worklist.empty()) {
5716 User *U = Worklist.pop_back_val();
5717 // Deleting the Old value will cause this to dangle. Postpone
5718 // that until everything else is done.
Dan Gohman59846ac2010-07-28 00:28:25 +00005719 if (U == Old)
Dan Gohman35738ac2009-05-04 22:30:44 +00005720 continue;
Dan Gohman69fcae92009-07-14 14:34:04 +00005721 if (!Visited.insert(U))
5722 continue;
Dan Gohman35738ac2009-05-04 22:30:44 +00005723 if (PHINode *PN = dyn_cast<PHINode>(U))
5724 SE->ConstantEvolutionLoopExitValue.erase(PN);
Dan Gohman69fcae92009-07-14 14:34:04 +00005725 SE->Scalars.erase(U);
5726 for (Value::use_iterator UI = U->use_begin(), UE = U->use_end();
5727 UI != UE; ++UI)
5728 Worklist.push_back(*UI);
Dan Gohman35738ac2009-05-04 22:30:44 +00005729 }
Dan Gohman59846ac2010-07-28 00:28:25 +00005730 // Delete the Old value.
5731 if (PHINode *PN = dyn_cast<PHINode>(Old))
5732 SE->ConstantEvolutionLoopExitValue.erase(PN);
5733 SE->Scalars.erase(Old);
5734 // this now dangles!
Dan Gohman35738ac2009-05-04 22:30:44 +00005735}
5736
Dan Gohman1959b752009-05-19 19:22:47 +00005737ScalarEvolution::SCEVCallbackVH::SCEVCallbackVH(Value *V, ScalarEvolution *se)
Dan Gohman35738ac2009-05-04 22:30:44 +00005738 : CallbackVH(V), SE(se) {}
5739
5740//===----------------------------------------------------------------------===//
Chris Lattner53e677a2004-04-02 20:23:17 +00005741// ScalarEvolution Class Implementation
5742//===----------------------------------------------------------------------===//
5743
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005744ScalarEvolution::ScalarEvolution()
Owen Anderson1f745902010-08-06 00:23:35 +00005745 : FunctionPass(&ID), FirstUnknown(0) {
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005746}
5747
Chris Lattner53e677a2004-04-02 20:23:17 +00005748bool ScalarEvolution::runOnFunction(Function &F) {
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005749 this->F = &F;
5750 LI = &getAnalysis<LoopInfo>();
5751 TD = getAnalysisIfAvailable<TargetData>();
Dan Gohman454d26d2010-02-22 04:11:59 +00005752 DT = &getAnalysis<DominatorTree>();
Chris Lattner53e677a2004-04-02 20:23:17 +00005753 return false;
5754}
5755
5756void ScalarEvolution::releaseMemory() {
Dan Gohmanab37f502010-08-02 23:49:30 +00005757 // Iterate through all the SCEVUnknown instances and call their
5758 // destructors, so that they release their references to their values.
5759 for (SCEVUnknown *U = FirstUnknown; U; U = U->Next)
5760 U->~SCEVUnknown();
5761 FirstUnknown = 0;
5762
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005763 Scalars.clear();
5764 BackedgeTakenCounts.clear();
5765 ConstantEvolutionLoopExitValue.clear();
Dan Gohman6bce6432009-05-08 20:47:27 +00005766 ValuesAtScopes.clear();
Dan Gohman1c343752009-06-27 21:21:31 +00005767 UniqueSCEVs.clear();
5768 SCEVAllocator.Reset();
Chris Lattner53e677a2004-04-02 20:23:17 +00005769}
5770
5771void ScalarEvolution::getAnalysisUsage(AnalysisUsage &AU) const {
5772 AU.setPreservesAll();
Chris Lattner53e677a2004-04-02 20:23:17 +00005773 AU.addRequiredTransitive<LoopInfo>();
Dan Gohman1cd92752010-01-19 22:21:27 +00005774 AU.addRequiredTransitive<DominatorTree>();
Dan Gohman2d1be872009-04-16 03:18:22 +00005775}
5776
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005777bool ScalarEvolution::hasLoopInvariantBackedgeTakenCount(const Loop *L) {
Dan Gohman46bdfb02009-02-24 18:55:53 +00005778 return !isa<SCEVCouldNotCompute>(getBackedgeTakenCount(L));
Chris Lattner53e677a2004-04-02 20:23:17 +00005779}
5780
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005781static void PrintLoopInfo(raw_ostream &OS, ScalarEvolution *SE,
Chris Lattner53e677a2004-04-02 20:23:17 +00005782 const Loop *L) {
5783 // Print all inner loops first
5784 for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
5785 PrintLoopInfo(OS, SE, *I);
Misha Brukman2b37d7c2005-04-21 21:13:18 +00005786
Dan Gohman30733292010-01-09 18:17:45 +00005787 OS << "Loop ";
5788 WriteAsOperand(OS, L->getHeader(), /*PrintType=*/false);
5789 OS << ": ";
Chris Lattnerf1ab4b42004-04-18 22:14:10 +00005790
Dan Gohman5d984912009-12-18 01:14:11 +00005791 SmallVector<BasicBlock *, 8> ExitBlocks;
Chris Lattnerf1ab4b42004-04-18 22:14:10 +00005792 L->getExitBlocks(ExitBlocks);
5793 if (ExitBlocks.size() != 1)
Nick Lewyckyaeb5e5c2008-01-02 02:49:20 +00005794 OS << "<multiple exits> ";
Chris Lattner53e677a2004-04-02 20:23:17 +00005795
Dan Gohman46bdfb02009-02-24 18:55:53 +00005796 if (SE->hasLoopInvariantBackedgeTakenCount(L)) {
5797 OS << "backedge-taken count is " << *SE->getBackedgeTakenCount(L);
Chris Lattner53e677a2004-04-02 20:23:17 +00005798 } else {
Dan Gohman46bdfb02009-02-24 18:55:53 +00005799 OS << "Unpredictable backedge-taken count. ";
Chris Lattner53e677a2004-04-02 20:23:17 +00005800 }
5801
Dan Gohman30733292010-01-09 18:17:45 +00005802 OS << "\n"
5803 "Loop ";
5804 WriteAsOperand(OS, L->getHeader(), /*PrintType=*/false);
5805 OS << ": ";
Dan Gohmanaa551ae2009-06-24 00:33:16 +00005806
5807 if (!isa<SCEVCouldNotCompute>(SE->getMaxBackedgeTakenCount(L))) {
5808 OS << "max backedge-taken count is " << *SE->getMaxBackedgeTakenCount(L);
5809 } else {
5810 OS << "Unpredictable max backedge-taken count. ";
5811 }
5812
5813 OS << "\n";
Chris Lattner53e677a2004-04-02 20:23:17 +00005814}
5815
Dan Gohman5d984912009-12-18 01:14:11 +00005816void ScalarEvolution::print(raw_ostream &OS, const Module *) const {
Dan Gohman3f46a3a2010-03-01 17:49:51 +00005817 // ScalarEvolution's implementation of the print method is to print
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005818 // out SCEV values of all instructions that are interesting. Doing
5819 // this potentially causes it to create new SCEV objects though,
5820 // which technically conflicts with the const qualifier. This isn't
Dan Gohman1afdc5f2009-07-10 20:25:29 +00005821 // observable from outside the class though, so casting away the
5822 // const isn't dangerous.
Dan Gohman5d984912009-12-18 01:14:11 +00005823 ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
Chris Lattner53e677a2004-04-02 20:23:17 +00005824
Dan Gohman30733292010-01-09 18:17:45 +00005825 OS << "Classifying expressions for: ";
5826 WriteAsOperand(OS, F, /*PrintType=*/false);
5827 OS << "\n";
Chris Lattner53e677a2004-04-02 20:23:17 +00005828 for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
Dan Gohmana189bae2010-05-03 17:03:23 +00005829 if (isSCEVable(I->getType()) && !isa<CmpInst>(*I)) {
Dan Gohmanc902e132009-07-13 23:03:05 +00005830 OS << *I << '\n';
Dan Gohman8dae1382008-09-14 17:21:12 +00005831 OS << " --> ";
Dan Gohman0bba49c2009-07-07 17:06:11 +00005832 const SCEV *SV = SE.getSCEV(&*I);
Chris Lattner53e677a2004-04-02 20:23:17 +00005833 SV->print(OS);
Misha Brukman2b37d7c2005-04-21 21:13:18 +00005834
Dan Gohman0c689c52009-06-19 17:49:54 +00005835 const Loop *L = LI->getLoopFor((*I).getParent());
5836
Dan Gohman0bba49c2009-07-07 17:06:11 +00005837 const SCEV *AtUse = SE.getSCEVAtScope(SV, L);
Dan Gohman0c689c52009-06-19 17:49:54 +00005838 if (AtUse != SV) {
5839 OS << " --> ";
5840 AtUse->print(OS);
5841 }
5842
5843 if (L) {
Dan Gohman9e7d9882009-06-18 00:37:45 +00005844 OS << "\t\t" "Exits: ";
Dan Gohman0bba49c2009-07-07 17:06:11 +00005845 const SCEV *ExitValue = SE.getSCEVAtScope(SV, L->getParentLoop());
Dan Gohmand594e6f2009-05-24 23:25:42 +00005846 if (!ExitValue->isLoopInvariant(L)) {
Chris Lattner53e677a2004-04-02 20:23:17 +00005847 OS << "<<Unknown>>";
5848 } else {
5849 OS << *ExitValue;
5850 }
5851 }
5852
Chris Lattner53e677a2004-04-02 20:23:17 +00005853 OS << "\n";
5854 }
5855
Dan Gohman30733292010-01-09 18:17:45 +00005856 OS << "Determining loop execution counts for: ";
5857 WriteAsOperand(OS, F, /*PrintType=*/false);
5858 OS << "\n";
Dan Gohmanf8a8be82009-04-21 23:15:49 +00005859 for (LoopInfo::iterator I = LI->begin(), E = LI->end(); I != E; ++I)
5860 PrintLoopInfo(OS, &SE, *I);
Chris Lattner53e677a2004-04-02 20:23:17 +00005861}
Dan Gohmanb7ef7292009-04-21 00:47:46 +00005862